@transcend-io/airgap.js-types - npm Package Compare versions

Comparing version 11.0.0 to 12.0.0

build-esm/core.d.ts

@@ -190,2 +190,4 @@ import * as t from 'io-ts';
 export type CookieWatcher = (event: IPendingCookieMutation) => void;
+/** Event types (for purpose resolution) */
+export type TrackingEventType = 'request' | 'cookie';
 /** airgap.js API */
@@ -210,2 +212,11 @@ export type AirgapAPI = Readonly<{
     resolve(url: Stringifiable, resolveOverrides?: boolean): Stringifiable;
+    /**
+     * Resolve consent status for given tracking purposes. Essential purposes override opted out unessential purposes.
+     *
+     * If `use` is not provided, consent is resolved for both request and cookie tracking event types.
+     * @param trackingPurposes - Tracking purposes to resolve
+     * @param use - Optional event type to use for tracking purpose resolution
+     * @returns `true` if the applicable tracking purposes are consented.
+     */
+    isConsented(trackingPurposes: TrackingPurposes, use?: TrackingEventType): boolean;
     /** Get tracking consent */
@@ -212,0 +223,0 @@ getConsent(): TrackingConsentDetails;

build/core.d.ts

@@ -190,2 +190,4 @@ import * as t from 'io-ts';
 export type CookieWatcher = (event: IPendingCookieMutation) => void;
+/** Event types (for purpose resolution) */
+export type TrackingEventType = 'request' | 'cookie';
 /** airgap.js API */
@@ -210,2 +212,11 @@ export type AirgapAPI = Readonly<{
     resolve(url: Stringifiable, resolveOverrides?: boolean): Stringifiable;
+    /**
+     * Resolve consent status for given tracking purposes. Essential purposes override opted out unessential purposes.
+     *
+     * If `use` is not provided, consent is resolved for both request and cookie tracking event types.
+     * @param trackingPurposes - Tracking purposes to resolve
+     * @param use - Optional event type to use for tracking purpose resolution
+     * @returns `true` if the applicable tracking purposes are consented.
+     */
+    isConsented(trackingPurposes: TrackingPurposes, use?: TrackingEventType): boolean;
     /** Get tracking consent */
@@ -212,0 +223,0 @@ getConsent(): TrackingConsentDetails;

package.json

@@ -5,3 +5,3 @@ {
   "description": "TypeScript types for airgap.js interoperability with custom consent UIs",
-  "version": "11.0.0",
+  "version": "12.0.0",
   "homepage": "https://github.com/transcend-io/airgap.js-types",
@@ -8,0 +8,0 @@ "repository": {

No alert changes

Improved metrics

Total package byte prevSize

445076

increased by0.36%

Lines of code

7624

increased by0.29%

No dependency changes