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

Comparing version 8.11.0 to 8.11.1

build/core.d.ts

 import * as t from 'io-ts';
-/** Potentially applicable data privacy legal regimes */
-export declare const PrivacyRegime: t.KeyofC<{
-    Unknown: unknown;
-    CPRA: unknown;
-    GDPR: unknown;
-    LGPD: unknown;
-    CDPA: unknown;
-    CPA: unknown;
-}>;
-/** type overload */
-export declare type PrivacyRegime = t.TypeOf<typeof PrivacyRegime>;
 /** Transcend logger items */
@@ -105,2 +94,25 @@ export declare type LogItem = {
 export declare type BooleanString = t.TypeOf<typeof BooleanString>;
+/** Potentially applicable data privacy legal regimes */
+export declare const PrivacyRegime: t.KeyofC<{
+    Unknown: unknown;
+    CPRA: unknown;
+    GDPR: unknown;
+    LGPD: unknown;
+    CDPA: unknown;
+    CPA: unknown;
+    UCPA: unknown;
+    "Nevada SB220": unknown;
+}>;
+/** type overload */
+export declare type PrivacyRegime = t.TypeOf<typeof PrivacyRegime>;
+export interface GetPurposeTypesOptions {
+    /** Regimes to include */
+    regimes?: PrivacyRegime[];
+    /** Privacy signals to include */
+    signals?: UserPrivacySignal[];
+}
+/**
+ * Regime to purpose scope map
+ */
+export declare type RegimeToPurposeScopes = [PrivacyRegime[], TrackingPurpose[]][];
 /** airgap.js API */
@@ -136,2 +148,4 @@ export declare type AirgapAPI = Readonly<{
     isOptedOut(): boolean;
+    /** Resolve regime tracking purposes. If no regimes are provided, then the user's detected regimes are used */
+    getRegimePurposes(regimes?: PrivacyRegime[]): Set<TrackingPurpose>;
     /** Get initialized tracking purposes config */
@@ -238,28 +252,7 @@ getPurposeTypes(): TrackingPurposesTypes;
     }>;
-    /** Scoped privacy regimes. All privacy regimes are in scope if undefined */
-    regimes: t.ArrayC<t.KeyofC<{
-        Unknown: unknown;
-        CPRA: unknown;
-        GDPR: unknown;
-        LGPD: unknown;
-        CDPA: unknown;
-        CPA: unknown;
-    }>>;
 }>]>;
 /** Type override */
 export declare type TrackingPurposeDetails = t.TypeOf<typeof TrackingPurposeDetails>;
-/** Tracking purpose */
-export declare const TrackingPurpose: t.UnionC<[t.KeyofC<{
-    Unknown: "Unknown";
-    Essential: "Essential";
-}>, t.StringC]>;
-/** Type override */
-export declare type TrackingPurpose = t.TypeOf<typeof TrackingPurpose>;
-/** Tracking purposes */
-export declare type TrackingPurposes = Set<TrackingPurpose>;
 /** Tracking purposes types configuration */
-export declare const TrackingPurposesTypes: t.RecordC<t.UnionC<[t.KeyofC<{
-    Unknown: "Unknown";
-    Essential: "Essential";
-}>, t.StringC]>, t.IntersectionC<[t.TypeC<{
+export declare const TrackingPurposesTypes: t.RecordC<t.StringC, t.IntersectionC<[t.TypeC<{
     /** Tracking purpose name */
@@ -297,11 +290,2 @@ name: t.StringC;
     }>;
-    /** Scoped privacy regimes. All privacy regimes are in scope if undefined */
-    regimes: t.ArrayC<t.KeyofC<{
-        Unknown: unknown;
-        CPRA: unknown;
-        GDPR: unknown;
-        LGPD: unknown;
-        CDPA: unknown;
-        CPA: unknown;
-    }>>;
 }>]>>;
@@ -321,6 +305,3 @@ /** Type override */
     useDefault: t.BooleanC;
-    types: t.RecordC<t.UnionC<[t.KeyofC<{
-        Unknown: "Unknown";
-        Essential: "Essential";
-    }>, t.StringC]>, t.IntersectionC<[t.TypeC<{
+    types: t.RecordC<t.StringC, t.IntersectionC<[t.TypeC<{
         /** Tracking purpose name */
@@ -358,11 +339,2 @@ name: t.StringC;
         }>;
-        /** Scoped privacy regimes. All privacy regimes are in scope if undefined */
-        regimes: t.ArrayC<t.KeyofC<{
-            Unknown: unknown;
-            CPRA: unknown;
-            GDPR: unknown;
-            LGPD: unknown;
-            CDPA: unknown;
-            CPA: unknown;
-        }>>;
     }>]>>;
@@ -408,2 +380,11 @@ }>, t.PartialC<{
 };
+/** Tracking purpose */
+export declare const TrackingPurpose: t.UnionC<[t.KeyofC<{
+    Unknown: "Unknown";
+    Essential: "Essential";
+}>, t.StringC]>;
+/** Type override */
+export declare type TrackingPurpose = t.TypeOf<typeof TrackingPurpose>;
+/** Tracking purposes */
+export declare type TrackingPurposes = Set<TrackingPurpose>;
 /** User-configurable user agent privacy signal */
@@ -410,0 +391,0 @@ export declare const UserPrivacySignal: t.UnionC<[t.LiteralC<"GPC">, t.LiteralC<"DNT">]>;

build/core.js

@@ -22,3 +22,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConsentChange = exports.UserPrivacySignal = exports.TrackingPurposesConfig = exports.DefaultConsentConfig = exports.TrackingPurposesTypes = exports.TrackingPurpose = exports.TrackingPurposeDetails = exports.DefaultConsentConfigValue = exports.AutoOptOutForGPC = exports.AutoOptOutForDNT = exports.AutoOptOutForGDPR = exports.AutoOptOut = exports.BooleanString = exports.LogLevel = exports.ConsoleSafeLogLevel = exports.PrivacyRegime = void 0;
+exports.ConsentChange = exports.UserPrivacySignal = exports.TrackingPurpose = exports.TrackingPurposesConfig = exports.DefaultConsentConfig = exports.TrackingPurposesTypes = exports.TrackingPurposeDetails = exports.DefaultConsentConfigValue = exports.AutoOptOutForGPC = exports.AutoOptOutForDNT = exports.AutoOptOutForGDPR = exports.AutoOptOut = exports.PrivacyRegime = exports.BooleanString = exports.LogLevel = exports.ConsoleSafeLogLevel = void 0;
 // external
@@ -30,5 +30,2 @@ const t = __importStar(require("io-ts"));
 const enums_1 = require("./enums");
-/* eslint-disable max-lines */
-/** Potentially applicable data privacy legal regimes */
-exports.PrivacyRegime = (0, type_utils_1.valuesOf)(enums_1.PrivacyRegimeEnum);
 /** Console-safe log levels */
@@ -54,2 +51,4 @@ exports.ConsoleSafeLogLevel = t.keyof({
 });
+/** Potentially applicable data privacy legal regimes */
+exports.PrivacyRegime = (0, type_utils_1.valuesOf)(enums_1.PrivacyRegimeEnum);
 /** Special `defaultConsent` automatic opt-out value for any potential reason */
@@ -105,13 +104,6 @@ exports.AutoOptOut = t.literal('Auto');
         trackingType: (0, type_utils_1.valuesOf)(enums_1.ConfigurablePurpose),
-        /** Scoped privacy regimes. All privacy regimes are in scope if undefined */
-        regimes: t.array(exports.PrivacyRegime),
     }),
 ]);
-/** Tracking purpose */
-exports.TrackingPurpose = t.union([
-    t.keyof(enums_1.SpecialTrackingPurpose),
-    t.string,
-]);
 /** Tracking purposes types configuration */
-exports.TrackingPurposesTypes = t.record(exports.TrackingPurpose, exports.TrackingPurposeDetails);
+exports.TrackingPurposesTypes = t.record(t.string, exports.TrackingPurposeDetails);
 /** Fully-resolved `defaultConsent` config */
@@ -130,2 +122,7 @@ exports.DefaultConsentConfig = t.record(t.string, exports.DefaultConsentConfigValue);
 ]);
+/** Tracking purpose */
+exports.TrackingPurpose = t.union([
+    t.keyof(enums_1.SpecialTrackingPurpose),
+    t.string,
+]);
 /** User-configurable user agent privacy signal */
@@ -132,0 +129,0 @@ exports.UserPrivacySignal = t.union([

build/enums/privacyRegime.d.ts

@@ -14,4 +14,8 @@ /** Potentially applicable data privacy legal regimes */
     /** Colorado Privacy Act */
-    CPA = "CPA"
+    CPA = "CPA",
+    /** Utah Consumer Privacy Act */
+    UCPA = "UCPA",
+    /** Nevada Privacy Law (SB220) */
+    'Nevada SB220' = "Nevada SB220"
 }
 //# sourceMappingURL=privacyRegime.d.ts.map

build/enums/privacyRegime.js

@@ -19,3 +19,7 @@ "use strict";
     PrivacyRegimeEnum["CPA"] = "CPA";
+    /** Utah Consumer Privacy Act */
+    PrivacyRegimeEnum["UCPA"] = "UCPA";
+    /** Nevada Privacy Law (SB220) */
+    PrivacyRegimeEnum["Nevada SB220"] = "Nevada SB220";
 })(PrivacyRegimeEnum = exports.PrivacyRegimeEnum || (exports.PrivacyRegimeEnum = {}));
 //# sourceMappingURL=privacyRegime.js.map

build/enums/viewState.d.ts

@@ -7,3 +7,6 @@ /**
     AcceptAll: "AcceptAll";
+    AcceptOrRejectAll: "AcceptOrRejectAll";
     NoticeAndDoNotSell: "NoticeAndDoNotSell";
+    DoNotSellDisclosure: "DoNotSellDisclosure";
+    CompleteOptions: "CompleteOptions";
     Hidden: "Hidden";
@@ -19,3 +22,2 @@ };
 export declare const DeepViewState: {
-    CompleteOptions: "CompleteOptions";
     LanguageOptions: "LanguageOptions";
@@ -44,7 +46,9 @@ };
     Closed: "Closed";
-    CompleteOptions: "CompleteOptions";
     LanguageOptions: "LanguageOptions";
     QuickOptions: "QuickOptions";
     AcceptAll: "AcceptAll";
+    AcceptOrRejectAll: "AcceptOrRejectAll";
     NoticeAndDoNotSell: "NoticeAndDoNotSell";
+    DoNotSellDisclosure: "DoNotSellDisclosure";
+    CompleteOptions: "CompleteOptions";
     Hidden: "Hidden";
@@ -55,3 +59,3 @@ };
  */
-export declare type ViewState = InitialViewState | DeepViewState | DismissedViewState;
+export declare type ViewState = typeof ViewState[keyof typeof ViewState];
 //# sourceMappingURL=viewState.d.ts.map

build/enums/viewState.js

@@ -14,4 +14,10 @@ "use strict";
     AcceptAll: 'AcceptAll',
+    /* accept all or reject all */
+    AcceptOrRejectAll: 'AcceptOrRejectAll',
     /* data collection notice with do not sell */
     NoticeAndDoNotSell: 'NoticeAndDoNotSell',
+    /* notice that do not sell has been acknowledged properly */
+    DoNotSellDisclosure: 'DoNotSellDisclosure',
+    /* expanded and showing full checkbox options */
+    CompleteOptions: 'CompleteOptions',
     /* hidden */
@@ -24,4 +30,2 @@ Hidden: 'Hidden',
 exports.DeepViewState = (0, type_utils_1.makeEnum)({
-    /* expanded and showing full checkbox options */
-    CompleteOptions: 'CompleteOptions',
     /* language options */
@@ -42,7 +46,7 @@ LanguageOptions: 'LanguageOptions',
  */
-exports.ViewState = {
+exports.ViewState = (0, type_utils_1.makeEnum)({
     ...exports.InitialViewState,
     ...exports.DeepViewState,
     ...exports.DismissedViewState,
-};
+});
 //# sourceMappingURL=viewState.js.map

build/ui.d.ts

 import * as t from 'io-ts';
+import type { ConsentManagerLanguageKey } from '@transcend-io/internationalization';
+import { ViewState } from './enums';
+import { AirgapAuth } from './core';
 /** Transcend Smart Quarantine API (window.transcend) */
@@ -9,2 +12,9 @@ export declare type PreInitTranscendAPI = {
 };
+/** showConsentManager() */
+export interface ShowConsentManagerOptions {
+    /** View state */
+    viewState?: ViewState;
+    /** The selected language (otherwise falls back to default) */
+    locale?: ConsentManagerLanguageKey;
+}
 /**
@@ -14,13 +24,138 @@ * Transcend Consent Manager external methods
 export declare type ConsentManagerAPI = {
+    /** Possible ViewState values */
+    viewStates: Set<ViewState>;
     /** Show consent manager unless recently dismissed */
-    autoShowConsentManager(): Promise<void>;
+    autoShowConsentManager(options?: ShowConsentManagerOptions): Promise<void>;
     /** Show consent manager */
-    showConsentManager(): Promise<void>;
+    showConsentManager(options?: ShowConsentManagerOptions): Promise<void>;
+    /** Set the current active language */
+    setActiveLocale(locale: ConsentManagerLanguageKey): Promise<void>;
+    /** Toggle consent manager */
+    toggleConsentManager(options?: ShowConsentManagerOptions): Promise<void>;
     /** Hide consent manager */
     hideConsentManager(): Promise<void>;
-    /** Toggle consent manager */
-    toggleConsentManager(): Promise<void>;
+    /** Opt out of the sale of personal info & show a disclosure */
+    doNotSell(auth: AirgapAuth, options?: ShowConsentManagerOptions): Promise<void>;
 };
 /** Transcend Smart Quarantine API (window.transcend) */
 export declare type TranscendAPI = PreInitTranscendAPI & ConsentManagerAPI;
+/**
+ * Customer theming
+ */
+export declare const ConsentManagerTheme: t.TypeC<{
+    /** Primary color */
+    primaryColor: t.StringC;
+    /** Font color */
+    fontColor: t.StringC;
+}>;
+/** Type override */
+export declare type ConsentManagerTheme = t.TypeOf<typeof ConsentManagerTheme>;
+/**
+ * Mobile-first responsive breakpoints
+ * No media query for mobile, which is the default
+ */
+export declare const ConsentManagerBreakpoints: t.TypeC<{
+    /** In px, at or above this width is tablet */
+    tablet: t.StringC;
+    /** In px, at or above this width is desktop */
+    desktop: t.StringC;
+}>;
+/** Type override */
+export declare type ConsentManagerBreakpoints = t.TypeOf<typeof ConsentManagerBreakpoints>;
+export declare const PrivacyRegimeToInitialViewStateInput: t.PartialC<{
+    Unknown: t.KeyofC<{
+        QuickOptions: unknown;
+        AcceptAll: unknown;
+        AcceptOrRejectAll: unknown;
+        NoticeAndDoNotSell: unknown;
+        DoNotSellDisclosure: unknown;
+        CompleteOptions: unknown;
+        Hidden: unknown;
+    }>;
+    CPRA: t.KeyofC<{
+        QuickOptions: unknown;
+        AcceptAll: unknown;
+        AcceptOrRejectAll: unknown;
+        NoticeAndDoNotSell: unknown;
+        DoNotSellDisclosure: unknown;
+        CompleteOptions: unknown;
+        Hidden: unknown;
+    }>;
+    GDPR: t.KeyofC<{
+        QuickOptions: unknown;
+        AcceptAll: unknown;
+        AcceptOrRejectAll: unknown;
+        NoticeAndDoNotSell: unknown;
+        DoNotSellDisclosure: unknown;
+        CompleteOptions: unknown;
+        Hidden: unknown;
+    }>;
+    LGPD: t.KeyofC<{
+        QuickOptions: unknown;
+        AcceptAll: unknown;
+        AcceptOrRejectAll: unknown;
+        NoticeAndDoNotSell: unknown;
+        DoNotSellDisclosure: unknown;
+        CompleteOptions: unknown;
+        Hidden: unknown;
+    }>;
+    CDPA: t.KeyofC<{
+        QuickOptions: unknown;
+        AcceptAll: unknown;
+        AcceptOrRejectAll: unknown;
+        NoticeAndDoNotSell: unknown;
+        DoNotSellDisclosure: unknown;
+        CompleteOptions: unknown;
+        Hidden: unknown;
+    }>;
+    CPA: t.KeyofC<{
+        QuickOptions: unknown;
+        AcceptAll: unknown;
+        AcceptOrRejectAll: unknown;
+        NoticeAndDoNotSell: unknown;
+        DoNotSellDisclosure: unknown;
+        CompleteOptions: unknown;
+        Hidden: unknown;
+    }>;
+    UCPA: t.KeyofC<{
+        QuickOptions: unknown;
+        AcceptAll: unknown;
+        AcceptOrRejectAll: unknown;
+        NoticeAndDoNotSell: unknown;
+        DoNotSellDisclosure: unknown;
+        CompleteOptions: unknown;
+        Hidden: unknown;
+    }>;
+    "Nevada SB220": t.KeyofC<{
+        QuickOptions: unknown;
+        AcceptAll: unknown;
+        AcceptOrRejectAll: unknown;
+        NoticeAndDoNotSell: unknown;
+        DoNotSellDisclosure: unknown;
+        CompleteOptions: unknown;
+        Hidden: unknown;
+    }>;
+}>;
+/** type overload */
+export declare type PrivacyRegimeToInitialViewStateInput = t.TypeOf<typeof PrivacyRegimeToInitialViewStateInput>;
+export declare const PrivacyRegimeToInitialViewState: t.RecordC<t.KeyofC<{
+    Unknown: unknown;
+    CPRA: unknown;
+    GDPR: unknown;
+    LGPD: unknown;
+    CDPA: unknown;
+    CPA: unknown;
+    UCPA: unknown;
+    "Nevada SB220": unknown;
+}>, t.KeyofC<{
+    QuickOptions: unknown;
+    AcceptAll: unknown;
+    AcceptOrRejectAll: unknown;
+    NoticeAndDoNotSell: unknown;
+    DoNotSellDisclosure: unknown;
+    CompleteOptions: unknown;
+    Hidden: unknown;
+}>>;
+/** type overload */
+export declare type PrivacyRegimeToInitialViewState = t.TypeOf<typeof PrivacyRegimeToInitialViewState>;
 /** Consent manager UI configuration */
@@ -44,2 +179,6 @@ export declare const ConsentManagerConfig: t.TypeC<{
     privacyPolicy: t.StringC;
+    /** Custom CSS stylesheet */
+    css: t.StringC;
+    /** Path to localizations directory */
+    messages: t.StringC;
     /** What state the consent manager should launch in */
@@ -53,6 +192,11 @@ initialViewStateByPrivacyRegime: t.RecordC<t.KeyofC<{
         CPA: unknown;
+        UCPA: unknown;
+        "Nevada SB220": unknown;
     }>, t.KeyofC<{
         QuickOptions: unknown;
         AcceptAll: unknown;
+        AcceptOrRejectAll: unknown;
         NoticeAndDoNotSell: unknown;
+        DoNotSellDisclosure: unknown;
+        CompleteOptions: unknown;
         Hidden: unknown;
@@ -86,2 +230,6 @@ }>>;
     privacyPolicy: t.StringC;
+    /** Custom CSS stylesheet */
+    css: t.StringC;
+    /** Path to localizations directory */
+    messages: t.StringC;
     /** What state the consent manager should launch in */
@@ -95,6 +243,11 @@ initialViewStateByPrivacyRegime: t.RecordC<t.KeyofC<{
         CPA: unknown;
+        UCPA: unknown;
+        "Nevada SB220": unknown;
     }>, t.KeyofC<{
         QuickOptions: unknown;
         AcceptAll: unknown;
+        AcceptOrRejectAll: unknown;
         NoticeAndDoNotSell: unknown;
+        DoNotSellDisclosure: unknown;
+        CompleteOptions: unknown;
         Hidden: unknown;
@@ -117,2 +270,3 @@ }>>;
 };
+export declare const DEFAULT_VIEW_STATE_BY_PRIVACY_REGIME: PrivacyRegimeToInitialViewState;
 //# sourceMappingURL=ui.d.ts.map

build/ui.js

@@ -22,3 +22,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConsentManagerConfigInput = exports.ConsentManagerConfig = void 0;
+exports.DEFAULT_VIEW_STATE_BY_PRIVACY_REGIME = exports.ConsentManagerConfigInput = exports.ConsentManagerConfig = exports.PrivacyRegimeToInitialViewState = exports.PrivacyRegimeToInitialViewStateInput = exports.ConsentManagerBreakpoints = exports.ConsentManagerTheme = void 0;
 // external
@@ -33,3 +33,3 @@ const t = __importStar(require("io-ts"));
  */
-const Theme = t.type({
+exports.ConsentManagerTheme = t.type({
     /** Primary color */
@@ -44,3 +44,3 @@ primaryColor: t.string,
  */
-const Breakpoints = t.type({
+exports.ConsentManagerBreakpoints = t.type({
     /** In px, at or above this width is tablet */
@@ -51,12 +51,18 @@ tablet: t.string,
 });
+exports.PrivacyRegimeToInitialViewStateInput = t.partial((0, type_utils_1.applyEnum)(enums_1.PrivacyRegimeEnum, () => (0, type_utils_1.valuesOf)(enums_1.InitialViewState)));
+exports.PrivacyRegimeToInitialViewState = t.record((0, type_utils_1.valuesOf)(enums_1.PrivacyRegimeEnum), (0, type_utils_1.valuesOf)(enums_1.InitialViewState));
 /** Consent manager UI configuration */
 exports.ConsentManagerConfig = t.type({
     /** Customer theming */
-    theme: Theme,
+    theme: exports.ConsentManagerTheme,
     /** A set of responsive breakpoints */
-    breakpoints: Breakpoints,
+    breakpoints: exports.ConsentManagerBreakpoints,
     /** The privacy policy URL to redirect to */
     privacyPolicy: t.string,
+    /** Custom CSS stylesheet */
+    css: t.string,
+    /** Path to localizations directory */
+    messages: t.string,
     /** What state the consent manager should launch in */
-    initialViewStateByPrivacyRegime: t.record((0, type_utils_1.valuesOf)(enums_1.PrivacyRegimeEnum), (0, type_utils_1.valuesOf)(enums_1.InitialViewState)),
+    initialViewStateByPrivacyRegime: exports.PrivacyRegimeToInitialViewState,
     /** What state the consent manager should go to when dismissed */
@@ -67,2 +73,21 @@ dismissedViewState: (0, type_utils_1.valuesOf)(enums_1.DismissedViewState),
 exports.ConsentManagerConfigInput = t.partial(exports.ConsentManagerConfig.props);
+exports.DEFAULT_VIEW_STATE_BY_PRIVACY_REGIME = {
+    // California
+    // TODO: https://transcend.height.app/T-17251 - migrate to DoNotSellDisclosure
+    CPRA: enums_1.InitialViewState.NoticeAndDoNotSell,
+    // EU
+    GDPR: enums_1.InitialViewState.QuickOptions,
+    // Brazil
+    LGPD: enums_1.InitialViewState.QuickOptions,
+    // Virginia
+    CDPA: enums_1.InitialViewState.NoticeAndDoNotSell,
+    // Colorado
+    CPA: enums_1.InitialViewState.NoticeAndDoNotSell,
+    // Nevada
+    'Nevada SB220': enums_1.InitialViewState.NoticeAndDoNotSell,
+    // Utah (law not yet in effect)
+    UCPA: enums_1.InitialViewState.Hidden,
+    // Other
+    Unknown: enums_1.InitialViewState.Hidden,
+};
 //# sourceMappingURL=ui.js.map

package.json

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

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

116089

increased by9.84%

Lines of code

1165

increased by17.56%

No dependency changes