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

Comparing version 9.0.2 to 9.1.0

build/core.d.ts

 import * as t from 'io-ts';
-import { ViewState } from './enums';
 /** Transcend logger items */
@@ -375,6 +374,5 @@ export declare type LogItem = {
 };
-/** Tracking purpose consent config with timestamp & auth metadata */
-export declare type TrackingConsentDetails = {
+export declare const TrackingConsentDetails: t.IntersectionC<[t.TypeC<{
     /** Tracking consent config */
-    purposes: TrackingConsent;
+    purposes: t.RecordC<t.StringC, t.BooleanC>;
     /**
@@ -384,24 +382,111 @@ * Was tracking consent confirmed by the user?
      */
-    confirmed: boolean;
+    confirmed: t.BooleanC;
     /** Consent resolution/last-modified timestamp (ISO 8601) */
-    timestamp: string;
+    timestamp: t.StringC;
+}>, t.PartialC<{
     /** Has the consent been updated (including no-change confirmation) since default resolution */
-    updated?: boolean;
+    updated: t.BooleanC;
     /** Whether or not the UI has been shown to the end-user (undefined in older versions of airgap.js) */
-    prompted?: boolean;
+    prompted: t.BooleanC;
     /** Transparency Consent (TCF) String */
-    tcf?: string;
+    tcf: t.StringC;
     /** US Privacy (USP) String */
-    usp?: string;
+    usp: t.StringC;
     /** Global Privacy Platform (GPP) String */
-    gpp?: string;
+    gpp: t.StringC;
     /** Consent Manager View State */
-    viewState?: ViewState;
+    viewState: t.KeyofC<{
+        QuickOptions: unknown;
+        QuickOptions3: unknown;
+        AcceptAll: unknown;
+        AcceptAllOrMoreChoices: unknown;
+        AcceptOrRejectAll: unknown;
+        AcceptOrRejectAllOrMoreChoices: unknown;
+        AcceptOrRejectAnalytics: unknown;
+        NoticeAndDoNotSell: unknown;
+        DoNotSellExplainer: unknown;
+        PrivacyPolicyNotice: unknown;
+        CompleteOptions: unknown;
+        CompleteOptionsInverted: unknown;
+        Hidden: unknown;
+        DoNotSellDisclosure: unknown;
+        OptOutDisclosure: unknown;
+        LanguageOptions: unknown;
+        Collapsed: unknown;
+        Closed: unknown;
+    }>;
     /** Airgap Version */
-    airgapVersion?: string;
+    airgapVersion: t.StringC;
     /** Arbitrary metadata that customers want to be associated with consent state */
-    metadata?: unknown;
+    metadata: t.UnknownC;
     /** When the metadata was last updated */
-    metadataTimestamp?: string;
-};
+    metadataTimestamp: t.StringC;
+}>]>;
+/** Override types. */
+export declare type TrackingConsentDetails = t.TypeOf<typeof TrackingConsentDetails>;
+export declare const ConsentPreferencesBody: t.TypeC<{
+    /** token containing encrypted identifier */
+    token: t.StringC;
+    /** consent partition (defaults to bundle id) */
+    partition: t.StringC;
+    /** user consent */
+    consent: t.IntersectionC<[t.TypeC<{
+        /** Tracking consent config */
+        purposes: t.RecordC<t.StringC, t.BooleanC>;
+        /**
+         * Was tracking consent confirmed by the user?
+         * If this is false, the consent was resolved from defaults & is not yet confirmed
+         */
+        confirmed: t.BooleanC;
+        /** Consent resolution/last-modified timestamp (ISO 8601) */
+        timestamp: t.StringC;
+    }>, t.PartialC<{
+        /** Has the consent been updated (including no-change confirmation) since default resolution */
+        updated: t.BooleanC;
+        /** Whether or not the UI has been shown to the end-user (undefined in older versions of airgap.js) */
+        prompted: t.BooleanC;
+        /** Transparency Consent (TCF) String */
+        tcf: t.StringC;
+        /** US Privacy (USP) String */
+        usp: t.StringC;
+        /** Global Privacy Platform (GPP) String */
+        gpp: t.StringC;
+        /** Consent Manager View State */
+        viewState: t.KeyofC<{
+            QuickOptions: unknown;
+            QuickOptions3: unknown;
+            AcceptAll: unknown;
+            AcceptAllOrMoreChoices: unknown;
+            AcceptOrRejectAll: unknown;
+            AcceptOrRejectAllOrMoreChoices: unknown;
+            AcceptOrRejectAnalytics: unknown;
+            NoticeAndDoNotSell: unknown;
+            DoNotSellExplainer: unknown;
+            PrivacyPolicyNotice: unknown;
+            CompleteOptions: unknown;
+            CompleteOptionsInverted: unknown;
+            Hidden: unknown;
+            DoNotSellDisclosure: unknown;
+            OptOutDisclosure: unknown;
+            LanguageOptions: unknown;
+            Collapsed: unknown;
+            Closed: unknown;
+        }>;
+        /** Airgap Version */
+        airgapVersion: t.StringC;
+        /** Arbitrary metadata that customers want to be associated with consent state */
+        metadata: t.UnknownC;
+        /** When the metadata was last updated */
+        metadataTimestamp: t.StringC;
+    }>]>;
+}>;
+/** Override types. */
+export declare type ConsentPreferencesBody = t.TypeOf<typeof ConsentPreferencesBody>;
+export declare const ConsentTokenPayload: t.IntersectionC<[t.TypeC<{
+    encryptedIdentifier: t.StringC;
+}>, t.PartialC<{
+    deprecatedEncryptedIdentifiers: t.ArrayC<t.StringC>;
+}>]>;
+/** Type override */
+export declare type ConsentTokenPayload = t.TypeOf<typeof ConsentTokenPayload>;
 /** Tracking purpose */
@@ -408,0 +493,0 @@ export declare const TrackingPurpose: t.UnionC<[t.KeyofC<{

build/core.js

@@ -22,3 +22,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RegimePurposeScopesConfig = exports.ConsentChange = exports.TrackingPurpose = exports.TrackingPurposesConfig = exports.DefaultConsentConfig = exports.TrackingPurposesTypes = exports.TrackingPurposeDetails = exports.UserPrivacySignal = exports.DefaultConsentConfigValue = exports.AutoOptOutForGPC = exports.AutoOptOutForDNT = exports.AutoOptOutForGDPR = exports.AutoOptOut = exports.BooleanString = exports.LogLevel = exports.ConsoleSafeLogLevel = void 0;
+exports.RegimePurposeScopesConfig = exports.ConsentChange = exports.TrackingPurpose = exports.ConsentTokenPayload = exports.ConsentPreferencesBody = exports.TrackingConsentDetails = exports.TrackingPurposesConfig = exports.DefaultConsentConfig = exports.TrackingPurposesTypes = exports.TrackingPurposeDetails = exports.UserPrivacySignal = exports.DefaultConsentConfigValue = exports.AutoOptOutForGPC = exports.AutoOptOutForDNT = exports.AutoOptOutForGDPR = exports.AutoOptOut = exports.BooleanString = exports.LogLevel = exports.ConsoleSafeLogLevel = void 0;
 // external
@@ -126,2 +126,51 @@ const t = __importStar(require("io-ts"));
 ]);
+exports.TrackingConsentDetails = t.intersection([
+    t.type({
+        /** Tracking consent config */
+        purposes: t.record(t.string, t.boolean),
+        /**
+         * Was tracking consent confirmed by the user?
+         * If this is false, the consent was resolved from defaults & is not yet confirmed
+         */
+        confirmed: t.boolean,
+        /** Consent resolution/last-modified timestamp (ISO 8601) */
+        timestamp: t.string,
+    }),
+    t.partial({
+        /** Has the consent been updated (including no-change confirmation) since default resolution */
+        updated: t.boolean,
+        /** Whether or not the UI has been shown to the end-user (undefined in older versions of airgap.js) */
+        prompted: t.boolean,
+        /** Transparency Consent (TCF) String */
+        tcf: t.string,
+        /** US Privacy (USP) String */
+        usp: t.string,
+        /** Global Privacy Platform (GPP) String */
+        gpp: t.string,
+        /** Consent Manager View State */
+        viewState: (0, type_utils_1.valuesOf)(enums_1.ViewState),
+        /** Airgap Version */
+        airgapVersion: t.string,
+        /** Arbitrary metadata that customers want to be associated with consent state */
+        metadata: t.unknown,
+        /** When the metadata was last updated */
+        metadataTimestamp: t.string,
+    }),
+]);
+exports.ConsentPreferencesBody = t.type({
+    /** token containing encrypted identifier */
+    token: t.string,
+    /** consent partition (defaults to bundle id) */
+    partition: t.string,
+    /** user consent */
+    consent: exports.TrackingConsentDetails,
+});
+exports.ConsentTokenPayload = t.intersection([
+    t.type({
+        encryptedIdentifier: t.string,
+    }),
+    t.partial({
+        deprecatedEncryptedIdentifiers: t.array(t.string),
+    }),
+]);
 /** Tracking purpose */
@@ -128,0 +177,0 @@ exports.TrackingPurpose = t.union([

package.json

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

No alert changes

Improved metrics

Total package byte prevSize

184149

increased by3.67%

Lines of code

2444

increased by5.85%

No dependency changes