@optable/web-sdk 0.21.4 → 0.22.0

package/lib/dist/core/regs/gpp/usde.d.ts

@@ -0,0 +1,19 @@
+type CoreSubsection = {
+    Version: number;
+    ProcessingNotice: number;
+    SaleOptOutNotice: number;
+    TargetedAdvertisingOptOutNotice: number;
+    SaleOptOut: number;
+    TargetedAdvertisingOptOut: number;
+    SensitiveDataProcessing: number[];
+    KnownChildSensitiveDataConsents: number;
+    AdditionalDataProcessingConsent: number;
+    MspaCoveredTransaction: number;
+    MspaOptOutOptionMode: number;
+    MspaServiceProviderMode: number;
+};
+type Section = Array<CoreSubsection>;
+declare const SectionID = 17;
+declare const APIPrefix = "usde";
+export type { Section };
+export { SectionID, APIPrefix };

package/lib/dist/core/regs/gpp/usde.js

@@ -0,0 +1,3 @@
+const SectionID = 17;
+const APIPrefix = "usde";
+export { SectionID, APIPrefix };

package/lib/dist/core/regs/gpp/usfl.d.ts

@@ -0,0 +1,19 @@
+type CoreSubsection = {
+    Version: number;
+    ProcessingNotice: number;
+    SaleOptOutNotice: number;
+    TargetedAdvertisingOptOutNotice: number;
+    SaleOptOut: number;
+    TargetedAdvertisingOptOut: number;
+    SensitiveDataProcessing: number[];
+    KnownChildSensitiveDataConsents: number;
+    AdditionalDataProcessingConsent: number;
+    MspaCoveredTransaction: number;
+    MspaOptOutOptionMode: number;
+    MspaServiceProviderMode: number;
+};
+type Section = Array<CoreSubsection>;
+declare const SectionID = 13;
+declare const APIPrefix = "usfl";
+export type { Section };
+export { SectionID, APIPrefix };

package/lib/dist/core/regs/gpp/usfl.js

@@ -0,0 +1,3 @@
+const SectionID = 13;
+const APIPrefix = "usfl";
+export { SectionID, APIPrefix };

package/lib/dist/core/regs/gpp/usia.d.ts

@@ -0,0 +1,19 @@
+type CoreSubsection = {
+    Version: number;
+    ProcessingNotice: number;
+    SaleOptOutNotice: number;
+    TargetedAdvertisingOptOutNotice: number;
+    SensitiveDataOptOutNotice: number;
+    SaleOptOut: number;
+    TargetedAdvertisingOptOut: number;
+    SensitiveDataProcessing: number[];
+    KnownChildSensitiveDataConsents: number;
+    MspaCoveredTransaction: number;
+    MspaOptOutOptionMode: number;
+    MspaServiceProviderMode: number;
+};
+type Section = Array<CoreSubsection>;
+declare const SectionID = 18;
+declare const APIPrefix = "usia";
+export type { Section };
+export { SectionID, APIPrefix };

package/lib/dist/core/regs/gpp/usia.js

@@ -0,0 +1,3 @@
+const SectionID = 18;
+const APIPrefix = "usia";
+export { SectionID, APIPrefix };

package/lib/dist/core/regs/gpp/usmt.d.ts

@@ -0,0 +1,19 @@
+type CoreSubsection = {
+    Version: number;
+    SharingNotice: number;
+    SaleOptOutNotice: number;
+    TargetedAdvertisingOptOutNotice: number;
+    SaleOptOut: number;
+    TargetedAdvertisingOptOut: number;
+    SensitiveDataProcessing: number[];
+    KnownChildSensitiveDataConsents: number;
+    AdditionalDataProcessingConsent: number;
+    MspaCoveredTransaction: number;
+    MspaOptOutOptionMode: number;
+    MspaServiceProviderMode: number;
+};
+type Section = Array<CoreSubsection>;
+declare const SectionID = 14;
+declare const APIPrefix = "usmt";
+export type { Section };
+export { SectionID, APIPrefix };

package/lib/dist/core/regs/gpp/usmt.js

@@ -0,0 +1,3 @@
+const SectionID = 14;
+const APIPrefix = "usmt";
+export { SectionID, APIPrefix };

package/lib/dist/core/regs/gpp/usnat.d.ts

@@ -0,0 +1,23 @@
+type CoreSegment = {
+    Version: number;
+    SharingNotice: number;
+    SaleOptOutNotice: number;
+    SharingOptOutNotice: number;
+    TargetedAdvertisingOptOutNotice: number;
+    SensitiveDataProcessingOptOutNotice: number;
+    SensitiveDataLimitUseNotice: number;
+    SaleOptOut: number;
+    SharingOptOut: number;
+    TargetedAdvertisingOptOut: number;
+    SensitiveDataProcessing: number[];
+    KnownChildSensitiveDataConsents: number[];
+    PersonalDataConsents: number;
+    MspaCoveredTransaction: number;
+    MspaOptOutOptionMode: number;
+    MspaServiceProviderMode: number;
+};
+declare const SectionID = 7;
+declare const APIPrefix = "usnat";
+type Section = Array<CoreSegment>;
+export type { Section };
+export { SectionID, APIPrefix };

package/lib/dist/core/regs/gpp/usnat.js

@@ -0,0 +1,3 @@
+const SectionID = 7;
+const APIPrefix = "usnat";
+export { SectionID, APIPrefix };

package/lib/dist/core/regs/gpp/usne.d.ts

@@ -0,0 +1,19 @@
+type CoreSubsection = {
+    Version: number;
+    ProcessingNotice: number;
+    SaleOptOutNotice: number;
+    TargetedAdvertisingOptOutNotice: number;
+    SaleOptOut: number;
+    TargetedAdvertisingOptOut: number;
+    SensitiveDataProcessing: number[];
+    KnownChildSensitiveDataConsents: number;
+    AdditionalDataProcessingConsent: number;
+    MspaCoveredTransaction: number;
+    MspaOptOutOptionMode: number;
+    MspaServiceProviderMode: number;
+};
+type Section = Array<CoreSubsection>;
+declare const SectionID = 19;
+declare const APIPrefix = "usne";
+export type { Section };
+export { SectionID, APIPrefix };

package/lib/dist/core/regs/gpp/usne.js

@@ -0,0 +1,3 @@
+const SectionID = 19;
+const APIPrefix = "usne";
+export { SectionID, APIPrefix };

package/lib/dist/core/regs/gpp/usnh.d.ts

@@ -0,0 +1,19 @@
+type CoreSubsection = {
+    Version: number;
+    ProcessingNotice: number;
+    SaleOptOutNotice: number;
+    TargetedAdvertisingOptOutNotice: number;
+    SaleOptOut: number;
+    TargetedAdvertisingOptOut: number;
+    SensitiveDataProcessing: number[];
+    KnownChildSensitiveDataConsents: number;
+    AdditionalDataProcessingConsent: number;
+    MspaCoveredTransaction: number;
+    MspaOptOutOptionMode: number;
+    MspaServiceProviderMode: number;
+};
+type Section = Array<CoreSubsection>;
+declare const SectionID = 20;
+declare const APIPrefix = "usnh";
+export type { Section };
+export { SectionID, APIPrefix };

package/lib/dist/core/regs/gpp/usnh.js

@@ -0,0 +1,3 @@
+const SectionID = 20;
+const APIPrefix = "usnh";
+export { SectionID, APIPrefix };

package/lib/dist/core/regs/gpp/usnj.d.ts

@@ -0,0 +1,19 @@
+type CoreSubsection = {
+    Version: number;
+    ProcessingNotice: number;
+    SaleOptOutNotice: number;
+    TargetedAdvertisingOptOutNotice: number;
+    SaleOptOut: number;
+    TargetedAdvertisingOptOut: number;
+    SensitiveDataProcessing: number[];
+    KnownChildSensitiveDataConsents: number;
+    AdditionalDataProcessingConsent: number;
+    MspaCoveredTransaction: number;
+    MspaOptOutOptionMode: number;
+    MspaServiceProviderMode: number;
+};
+type Section = Array<CoreSubsection>;
+declare const SectionID = 21;
+declare const APIPrefix = "usnj";
+export type { Section };
+export { SectionID, APIPrefix };

package/lib/dist/core/regs/gpp/usnj.js

@@ -0,0 +1,3 @@
+const SectionID = 21;
+const APIPrefix = "usnj";
+export { SectionID, APIPrefix };

package/lib/dist/core/regs/gpp/usor.d.ts

@@ -0,0 +1,19 @@
+type CoreSubsection = {
+    Version: number;
+    ProcessingNotice: number;
+    SaleOptOutNotice: number;
+    TargetedAdvertisingOptOutNotice: number;
+    SaleOptOut: number;
+    TargetedAdvertisingOptOut: number;
+    SensitiveDataProcessing: number[];
+    KnownChildSensitiveDataConsents: number;
+    AdditionalDataProcessingConsent: number;
+    MspaCoveredTransaction: number;
+    MspaOptOutOptionMode: number;
+    MspaServiceProviderMode: number;
+};
+type Section = Array<CoreSubsection>;
+declare const SectionID = 15;
+declare const APIPrefix = "usor";
+export type { Section };
+export { SectionID, APIPrefix };

package/lib/dist/core/regs/gpp/usor.js

@@ -0,0 +1,3 @@
+const SectionID = 15;
+const APIPrefix = "usor";
+export { SectionID, APIPrefix };

package/lib/dist/core/regs/gpp/ustn.d.ts

@@ -0,0 +1,19 @@
+type CoreSubsection = {
+    Version: number;
+    ProcessingNotice: number;
+    SaleOptOutNotice: number;
+    TargetedAdvertisingOptOutNotice: number;
+    SaleOptOut: number;
+    TargetedAdvertisingOptOut: number;
+    SensitiveDataProcessing: number[];
+    KnownChildSensitiveDataConsents: number;
+    AdditionalDataProcessingConsent: number;
+    MspaCoveredTransaction: number;
+    MspaOptOutOptionMode: number;
+    MspaServiceProviderMode: number;
+};
+type Section = Array<CoreSubsection>;
+declare const SectionID = 22;
+declare const APIPrefix = "ustn";
+export type { Section };
+export { SectionID, APIPrefix };

package/lib/dist/core/regs/gpp/ustn.js

@@ -0,0 +1,3 @@
+const SectionID = 22;
+const APIPrefix = "ustn";
+export { SectionID, APIPrefix };

package/lib/dist/core/regs/gpp/ustx.d.ts

@@ -0,0 +1,19 @@
+type CoreSubsection = {
+    Version: number;
+    ProcessingNotice: number;
+    SaleOptOutNotice: number;
+    TargetedAdvertisingOptOutNotice: number;
+    SaleOptOut: number;
+    TargetedAdvertisingOptOut: number;
+    SensitiveDataProcessing: number[];
+    KnownChildSensitiveDataConsents: number;
+    AdditionalDataProcessingConsent: number;
+    MspaCoveredTransaction: number;
+    MspaOptOutOptionMode: number;
+    MspaServiceProviderMode: number;
+};
+type Section = Array<CoreSubsection>;
+declare const SectionID = 16;
+declare const APIPrefix = "ustx";
+export type { Section };
+export { SectionID, APIPrefix };

package/lib/dist/core/regs/gpp/ustx.js

@@ -0,0 +1,3 @@
+const SectionID = 16;
+const APIPrefix = "ustx";
+export { SectionID, APIPrefix };

package/lib/dist/core/regs/gpp/usut.d.ts

@@ -0,0 +1,18 @@
+type CoreSubsection = {
+    Version: number;
+    SharingNotice: number;
+    SaleOptOutNotice: number;
+    TargetedAdvertisingOptOutNotice: number;
+    SaleOptOut: number;
+    TargetedAdvertisingOptOut: number;
+    SensitiveDataProcessing: number[];
+    KnownChildSensitiveDataConsents: number;
+    MspaCoveredTransaction: number;
+    MspaOptOutOptionMode: number;
+    MspaServiceProviderMode: number;
+};
+type Section = Array<CoreSubsection>;
+declare const SectionID = 11;
+declare const APIPrefix = "usut";
+export type { Section };
+export { SectionID, APIPrefix };

package/lib/dist/core/regs/gpp/usut.js

@@ -0,0 +1,3 @@
+const SectionID = 11;
+const APIPrefix = "usut";
+export { SectionID, APIPrefix };

package/lib/dist/core/regs/gpp/usva.d.ts

@@ -0,0 +1,18 @@
+type CoreSubsection = {
+    Version: number;
+    SharingNotice: number;
+    SaleOptOutNotice: number;
+    TargetedAdvertisingOptOutNotice: number;
+    SaleOptOut: number;
+    TargetedAdvertisingOptOut: number;
+    SensitiveDataProcessing: number[];
+    KnownChildSensitiveDataConsents: number;
+    MspaCoveredTransaction: number;
+    MspaOptOutOptionMode: number;
+    MspaServiceProviderMode: number;
+};
+type Section = Array<CoreSubsection>;
+declare const SectionID = 9;
+declare const APIPrefix = "usva";
+export type { Section };
+export { SectionID, APIPrefix };

package/lib/dist/core/regs/gpp/usva.js

@@ -0,0 +1,3 @@
+const SectionID = 9;
+const APIPrefix = "usva";
+export { SectionID, APIPrefix };

package/lib/dist/core/regs/regulations.d.ts

@@ -0,0 +1,4 @@
+type Regulation = "gdpr" | "us" | "can";
+declare function inferRegulation(): Regulation | null;
+export { inferRegulation };
+export type { Regulation };

package/lib/dist/core/regs/regulations.js

@@ -0,0 +1,67 @@
+const zones = {
+    // EU
+    "Europe/Amsterdam": "gdpr",
+    "Europe/Athens": "gdpr",
+    "Europe/Berlin": "gdpr",
+    "Europe/Brussels": "gdpr",
+    "Europe/Bucharest": "gdpr",
+    "Europe/Budapest": "gdpr",
+    "Europe/Copenhagen": "gdpr",
+    "Europe/Dublin": "gdpr",
+    "Europe/Helsinki": "gdpr",
+    "Europe/Lisbon": "gdpr",
+    "Europe/London": "gdpr",
+    "Europe/Madrid": "gdpr",
+    "Europe/Oslo": "gdpr",
+    "Europe/Paris": "gdpr",
+    "Europe/Prague": "gdpr",
+    "Europe/Rome": "gdpr",
+    "Europe/Sofia": "gdpr",
+    "Europe/Stockholm": "gdpr",
+    "Europe/Vienna": "gdpr",
+    "Europe/Warsaw": "gdpr",
+    "Europe/Zurich": "gdpr",
+    // CA (QC only)
+    "America/Toronto": "can",
+    // US
+    "America/New_York": "us",
+    "America/Detroit": "us",
+    "America/Kentucky/Louisville": "us",
+    "America/Kentucky/Monticello": "us",
+    "America/Indiana/Indianapolis": "us",
+    "America/Indiana/Vincennes": "us",
+    "America/Indiana/Winamac": "us",
+    "America/Indiana/Marengo": "us",
+    "America/Indiana/Petersburg": "us",
+    "America/Indiana/Vevay": "us",
+    "America/Chicago": "us",
+    "America/Indiana/Tell_City": "us",
+    "America/Indiana/Knox": "us",
+    "America/Menominee": "us",
+    "America/North_Dakota/Center": "us",
+    "America/North_Dakota/New_Salem": "us",
+    "America/North_Dakota/Beulah": "us",
+    "America/Denver": "us",
+    "America/Boise": "us",
+    "America/Phoenix": "us",
+    "America/Los_Angeles": "us",
+    "America/Anchorage": "us",
+    "America/Juneau": "us",
+    "America/Sitka": "us",
+    "America/Metlakatla": "us",
+    "America/Yakutat": "us",
+    "America/Nome": "us",
+    "America/Adak": "us",
+    "Pacific/Honolulu": "us",
+};
+function inferRegulation() {
+    const timeZone = Intl.DateTimeFormat().resolvedOptions().timeZone;
+    const regulation = zones[timeZone];
+    // Special handling, can currently only applies to quebec
+    if (regulation === "can") {
+        const inQC = ["fr", "fr-CA"].some((l) => navigator.languages.includes(l));
+        return inQC ? "can" : null;
+    }
+    return regulation !== null && regulation !== void 0 ? regulation : null;
+}
+export { inferRegulation };

package/lib/dist/core/regs/storage.d.ts

@@ -0,0 +1,9 @@
+import { Consent } from "./consent";
+declare class LocalStorageProxy {
+    private consent;
+    constructor(consent: Consent);
+    getItem(key: string): string | null;
+    setItem(key: string, value: string): void;
+    removeItem(key: string): void;
+}
+export { LocalStorageProxy };

package/lib/dist/core/regs/storage.js

@@ -0,0 +1,24 @@
+class LocalStorageProxy {
+    constructor(consent) {
+        this.consent = consent;
+    }
+    getItem(key) {
+        if (!this.consent.deviceAccess) {
+            return null;
+        }
+        return window.localStorage.getItem(key);
+    }
+    setItem(key, value) {
+        if (!this.consent.deviceAccess) {
+            return;
+        }
+        window.localStorage.setItem(key, value);
+    }
+    removeItem(key) {
+        if (!this.consent.deviceAccess) {
+            return;
+        }
+        window.localStorage.removeItem(key);
+    }
+}
+export { LocalStorageProxy };

package/lib/dist/core/regs/tcf/cmpapi.d.ts

@@ -0,0 +1,61 @@
+declare global {
+    interface Window {
+        __tcfapi?(command: "addEventListener", version: number, cb: AddEventListenerCallback): void;
+    }
+}
+type TCData = {
+    tcString: string;
+    tcfPolicyVersion: number;
+    cmpId: number;
+    cmpVersion: number;
+    gdprApplies?: boolean;
+    eventStatus: "tcloaded" | "cmpuishown" | "useractioncomplete";
+    cmpStatus: "stub" | "loading" | "loaded" | "error";
+    listenerId?: number;
+    isServiceSpecific: boolean;
+    useNonStandardStacks: boolean;
+    publisherCC: string;
+    purposeOneTreatment: boolean;
+    purpose: {
+        consents: {
+            [purposeID: string]: boolean;
+        };
+        legitimateInterests: {
+            [purposeID: string]: boolean;
+        };
+    };
+    vendor: {
+        consents: {
+            [vendorID: string]: boolean;
+        };
+        legitimateInterests: {
+            [vendorID: string]: boolean;
+        };
+    };
+    specialFeatureOptins: {
+        [featureID: string]: boolean;
+    };
+    publisher: {
+        consents: {
+            [purposeID: string]: boolean;
+        };
+        legitimateInterests: {
+            [purposeID: string]: boolean;
+        };
+        customPurpose: {
+            consents: {
+                [purposeID: string]: boolean;
+            };
+            legitimateInterests: {
+                [purposeID: string]: boolean;
+            };
+        };
+        restrictions: {
+            [purposeID: string]: {
+                [vendorID: string]: 0 | 1 | 2;
+            };
+        };
+    };
+};
+type AddEventListenerCallback = (data: TCData, success: boolean) => void;
+export { TCData };

package/lib/dist/core/regs/tcf/cmpapi.js

@@ -0,0 +1 @@
+export {};

package/lib/dist/core/regs/tcf/index.d.ts

@@ -0,0 +1 @@
+export * as cmpapi from "./cmpapi";

package/lib/dist/core/regs/tcf/index.js

@@ -0,0 +1 @@
+export * as cmpapi from "./cmpapi";

package/lib/dist/core/storage.d.ts

@@ -1,13 +1,14 @@
 import { SiteResponse } from "../edge/site";
-import type { OptableConfig } from "../config";
+import type { ResolvedConfig } from "../config";
 import type { TargetingResponse } from "../edge/targeting";
 declare class LocalStorage {
-    private Config;
+    private config;
     private passportKey;
     private targetingV1Key;
     private targetingKey;
     private siteKey;
-    constructor(Config: OptableConfig);
+    private storage;
+    constructor(config: ResolvedConfig);
     getPassport(): string | null;
     getV1Targeting(): TargetingResponse | null;
     getTargeting(): TargetingResponse | null;

package/lib/dist/core/storage.js

@@ -1,3 +1,4 @@
+import { LocalStorageProxy } from "./regs/storage";
 function toBinary(str) {
     const codeUnits = new Uint16Array(str.length);
     for (let i = 0; i < codeUnits.length; i++) {
@@ -6,20 +7,21 @@ function toBinary(str) {
     return String.fromCharCode(...new Uint8Array(codeUnits.buffer));
 }
 class LocalStorage {
-    constructor(Config) {
-        this.Config = Config;
-        const sfx = btoa(toBinary(`${this.Config.host}/${this.Config.site}`));
+    constructor(config) {
+        this.config = config;
+        const sfx = btoa(toBinary(`${this.config.host}/${this.config.site}`));
         // Legacy targeting key
         this.targetingV1Key = "OPTABLE_TGT_" + sfx;
         this.passportKey = "OPTABLE_PASS_" + sfx;
         this.targetingKey = "OPTABLE_V2_TGT_" + sfx;
         this.siteKey = "OPTABLE_SITE_" + sfx;
+        this.storage = new LocalStorageProxy(this.config.consent);
     }
     getPassport() {
-        return window.localStorage.getItem(this.passportKey);
+        return this.storage.getItem(this.passportKey);
     }
     getV1Targeting() {
-        const raw = window.localStorage.getItem(this.targetingV1Key);
+        const raw = this.storage.getItem(this.targetingV1Key);
         const parsed = raw ? JSON.parse(raw) : null;
         if (!parsed) {
             return null;
@@ -42,40 +44,40 @@ class LocalStorage {
         };
     }
     getTargeting() {
-        const raw = window.localStorage.getItem(this.targetingKey);
+        const raw = this.storage.getItem(this.targetingKey);
         const parsed = raw ? JSON.parse(raw) : null;
         return parsed ? parsed : this.getV1Targeting();
     }
     setPassport(passport) {
         if (passport && passport.length > 0) {
-            window.localStorage.setItem(this.passportKey, passport);
+            this.storage.setItem(this.passportKey, passport);
         }
     }
     setTargeting(targeting) {
         if (!targeting) {
             return;
         }
-        window.localStorage.setItem(this.targetingKey, JSON.stringify(targeting));
+        this.storage.setItem(this.targetingKey, JSON.stringify(targeting));
     }
     setSite(site) {
         if (!site) {
             return;
         }
-        window.localStorage.setItem(this.siteKey, JSON.stringify(site));
+        this.storage.setItem(this.siteKey, JSON.stringify(site));
     }
     getSite() {
-        const raw = window.localStorage.getItem(this.siteKey);
+        const raw = this.storage.getItem(this.siteKey);
         const parsed = raw ? JSON.parse(raw) : null;
         return parsed;
     }
     clearPassport() {
-        window.localStorage.removeItem(this.passportKey);
+        this.storage.removeItem(this.passportKey);
     }
     clearTargeting() {
-        window.localStorage.removeItem(this.targetingKey);
+        this.storage.removeItem(this.targetingKey);
     }
     clearSite() {
-        window.localStorage.removeItem(this.siteKey);
+        this.storage.removeItem(this.siteKey);
     }
 }
 export { LocalStorage };

package/lib/dist/edge/identify.d.ts

@@ -1,4 +1,4 @@
-import type { OptableConfig } from "../config";
-declare function Identify(config: Required<OptableConfig>, ids: string[]): Promise<void>;
+import type { ResolvedConfig } from "../config";
+declare function Identify(config: ResolvedConfig, ids: string[]): Promise<void>;
 export { Identify };
 export default Identify;

package/lib/dist/edge/profile.d.ts

@@ -1,7 +1,7 @@
-import type { OptableConfig } from "../config";
+import type { ResolvedConfig } from "../config";
 type ProfileTraits = {
     [key: string]: string | number | boolean;
 };
-declare function Profile(config: Required<OptableConfig>, traits: ProfileTraits): Promise<void>;
+declare function Profile(config: ResolvedConfig, traits: ProfileTraits): Promise<void>;
 export { Profile, ProfileTraits };
 export default Profile;

package/lib/dist/edge/site.d.ts

@@ -1,4 +1,4 @@
-import type { OptableConfig } from "../config";
+import type { ResolvedConfig } from "../config";
 type Size = {
     width: string;
     height: string;
@@ -16,7 +16,7 @@ type SiteResponse = {
     auctionConfig?: AuctionConfig | null;
     getTopicsURL: string;
 };
-declare function Site(config: Required<OptableConfig>): Promise<SiteResponse>;
-declare function SiteFromCache(config: Required<OptableConfig>): SiteResponse | null;
+declare function Site(config: ResolvedConfig): Promise<SiteResponse>;
+declare function SiteFromCache(config: ResolvedConfig): SiteResponse | null;
 export { Site, SiteResponse, SiteFromCache, Size, AuctionConfig };
 export default Site;