@transcend-io/airgap.js-types 14.0.1 → 14.1.2

package/dist/enums/viewState.d.mts

@@ -0,0 +1,139 @@
+//#region src/enums/viewState.d.ts
+/**
+ * Consent Manager view state for the Interactive Advertising Bureau
+ */
+declare const IABViewState: {
+  /** Transparency and Consent Framework for Europe */TCF_EU: "TCF_EU";
+};
+/**
+ * View States for Transcend's Consent Manager UI
+ */
+declare const InitialTranscendViewState: {
+  /** expanded and showing quick select options */QuickOptions: "QuickOptions"; /** three option UI: essential, functional/analytics, advertising */
+  QuickOptions3: "QuickOptions3"; /** accept all button call to action, with more options in the banner footer */
+  AcceptAll: "AcceptAll"; /** toggle button that toggles on or off all active purposes in the current regime */
+  AcceptAllRejectAllToggle: "AcceptAllRejectAllToggle"; /** accept all or more options, both as calls to action */
+  AcceptAllOrMoreChoices: "AcceptAllOrMoreChoices"; /** accept all or reject all */
+  AcceptOrRejectAll: "AcceptOrRejectAll"; /** accept all or reject all or more options */
+  AcceptOrRejectAllOrMoreChoices: "AcceptOrRejectAllOrMoreChoices"; /** accept or reject the Analytics script tag */
+  AcceptOrRejectAnalytics: "AcceptOrRejectAnalytics"; /** accept or reject the Advertising script tag */
+  AcceptOrRejectAdvertising: "AcceptOrRejectAdvertising"; /** data collection notice with do not sell */
+  NoticeAndDoNotSell: "NoticeAndDoNotSell"; /** open a modal that allows for an explanation of do not sell/share, before opting out */
+  DoNotSellExplainer: "DoNotSellExplainer"; /** open a modal that allows for complete options toggling */
+  CompleteOptionsToggles: "CompleteOptionsToggles"; /** open a modal that shows a notice that the privacy policy has changed, without any prompt to change consent */
+  PrivacyPolicyNotice: "PrivacyPolicyNotice";
+  /**
+   * open a modal that shows a notice that the privacy policy has changed, without any prompt to change consent
+   * and no button to close the modal. instead there is an X in the top right corner of the modal
+   */
+  PrivacyPolicyNoticeWithCloseButton: "PrivacyPolicyNoticeWithCloseButton"; /** expanded and showing full checkbox options */
+  CompleteOptions: "CompleteOptions"; /** complete options, but selecting a checkbox means the user is opted out */
+  CompleteOptionsInverted: "CompleteOptionsInverted"; /** hidden */
+  Hidden: "Hidden";
+};
+/**
+ * Type override
+ */
+type InitialTranscendViewState = (typeof InitialTranscendViewState)[keyof typeof InitialTranscendViewState];
+/**
+ * Consent Manager view states that can be used at launch
+ */
+declare const InitialViewState: {
+  /** Transparency and Consent Framework for Europe */TCF_EU: "TCF_EU"; /** expanded and showing quick select options */
+  QuickOptions: "QuickOptions"; /** three option UI: essential, functional/analytics, advertising */
+  QuickOptions3: "QuickOptions3"; /** accept all button call to action, with more options in the banner footer */
+  AcceptAll: "AcceptAll"; /** toggle button that toggles on or off all active purposes in the current regime */
+  AcceptAllRejectAllToggle: "AcceptAllRejectAllToggle"; /** accept all or more options, both as calls to action */
+  AcceptAllOrMoreChoices: "AcceptAllOrMoreChoices"; /** accept all or reject all */
+  AcceptOrRejectAll: "AcceptOrRejectAll"; /** accept all or reject all or more options */
+  AcceptOrRejectAllOrMoreChoices: "AcceptOrRejectAllOrMoreChoices"; /** accept or reject the Analytics script tag */
+  AcceptOrRejectAnalytics: "AcceptOrRejectAnalytics"; /** accept or reject the Advertising script tag */
+  AcceptOrRejectAdvertising: "AcceptOrRejectAdvertising"; /** data collection notice with do not sell */
+  NoticeAndDoNotSell: "NoticeAndDoNotSell"; /** open a modal that allows for an explanation of do not sell/share, before opting out */
+  DoNotSellExplainer: "DoNotSellExplainer"; /** open a modal that allows for complete options toggling */
+  CompleteOptionsToggles: "CompleteOptionsToggles"; /** open a modal that shows a notice that the privacy policy has changed, without any prompt to change consent */
+  PrivacyPolicyNotice: "PrivacyPolicyNotice";
+  /**
+   * open a modal that shows a notice that the privacy policy has changed, without any prompt to change consent
+   * and no button to close the modal. instead there is an X in the top right corner of the modal
+   */
+  PrivacyPolicyNoticeWithCloseButton: "PrivacyPolicyNoticeWithCloseButton"; /** expanded and showing full checkbox options */
+  CompleteOptions: "CompleteOptions"; /** complete options, but selecting a checkbox means the user is opted out */
+  CompleteOptionsInverted: "CompleteOptionsInverted"; /** hidden */
+  Hidden: "Hidden";
+};
+/**
+ * Type override
+ */
+type InitialViewState = (typeof InitialViewState)[keyof typeof InitialViewState];
+/**
+ * View states that are displayed in response to a user request (e.g. transcend.doNotSell() or )
+ */
+declare const ResponseViewState: {
+  /** notice that do not sell has been acknowledged properly */DoNotSellDisclosure: "DoNotSellDisclosure"; /** notice of a 1 click opt out for multiple consent purposes */
+  OptOutDisclosure: "OptOutDisclosure";
+};
+/**
+ * Type override
+ */
+type ResponseViewState = (typeof ResponseViewState)[keyof typeof ResponseViewState];
+/**
+ * Consent Manager view states that can be navigated to after initial view state
+ */
+declare const DeepViewState: {
+  /** language options */LanguageOptions: "LanguageOptions";
+};
+/**
+ * Type override
+ */
+type DeepViewState = (typeof DeepViewState)[keyof typeof DeepViewState];
+/**
+ * Consent Manager view states after it's been dismissed
+ */
+declare const DismissedViewState: {
+  /** showing and collapsed */Collapsed: "Collapsed"; /** closed */
+  Closed: "Closed";
+};
+/**
+ * Type override
+ */
+type DismissedViewState = (typeof DismissedViewState)[keyof typeof DismissedViewState];
+/**
+ * All possible view states of the Consent Manager
+ */
+declare const ViewState: {
+  /** showing and collapsed */Collapsed: "Collapsed"; /** closed */
+  Closed: "Closed"; /** language options */
+  LanguageOptions: "LanguageOptions"; /** notice that do not sell has been acknowledged properly */
+  DoNotSellDisclosure: "DoNotSellDisclosure"; /** notice of a 1 click opt out for multiple consent purposes */
+  OptOutDisclosure: "OptOutDisclosure"; /** Transparency and Consent Framework for Europe */
+  TCF_EU: "TCF_EU"; /** expanded and showing quick select options */
+  QuickOptions: "QuickOptions"; /** three option UI: essential, functional/analytics, advertising */
+  QuickOptions3: "QuickOptions3"; /** accept all button call to action, with more options in the banner footer */
+  AcceptAll: "AcceptAll"; /** toggle button that toggles on or off all active purposes in the current regime */
+  AcceptAllRejectAllToggle: "AcceptAllRejectAllToggle"; /** accept all or more options, both as calls to action */
+  AcceptAllOrMoreChoices: "AcceptAllOrMoreChoices"; /** accept all or reject all */
+  AcceptOrRejectAll: "AcceptOrRejectAll"; /** accept all or reject all or more options */
+  AcceptOrRejectAllOrMoreChoices: "AcceptOrRejectAllOrMoreChoices"; /** accept or reject the Analytics script tag */
+  AcceptOrRejectAnalytics: "AcceptOrRejectAnalytics"; /** accept or reject the Advertising script tag */
+  AcceptOrRejectAdvertising: "AcceptOrRejectAdvertising"; /** data collection notice with do not sell */
+  NoticeAndDoNotSell: "NoticeAndDoNotSell"; /** open a modal that allows for an explanation of do not sell/share, before opting out */
+  DoNotSellExplainer: "DoNotSellExplainer"; /** open a modal that allows for complete options toggling */
+  CompleteOptionsToggles: "CompleteOptionsToggles"; /** open a modal that shows a notice that the privacy policy has changed, without any prompt to change consent */
+  PrivacyPolicyNotice: "PrivacyPolicyNotice";
+  /**
+   * open a modal that shows a notice that the privacy policy has changed, without any prompt to change consent
+   * and no button to close the modal. instead there is an X in the top right corner of the modal
+   */
+  PrivacyPolicyNoticeWithCloseButton: "PrivacyPolicyNoticeWithCloseButton"; /** expanded and showing full checkbox options */
+  CompleteOptions: "CompleteOptions"; /** complete options, but selecting a checkbox means the user is opted out */
+  CompleteOptionsInverted: "CompleteOptionsInverted"; /** hidden */
+  Hidden: "Hidden";
+};
+/**
+ * Type override
+ */
+type ViewState = (typeof ViewState)[keyof typeof ViewState];
+//#endregion
+export { DeepViewState, DismissedViewState, IABViewState, InitialTranscendViewState, InitialViewState, ResponseViewState, ViewState };
+//# sourceMappingURL=viewState.d.mts.map

package/dist/enums/viewState.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"viewState.d.mts","names":[],"sources":["../../src/enums/viewState.ts"],"mappings":";;AAMA;;cAAa,YAAA;EAGX,oDAAA,MAAA;AAAA;;;;cAKW,yBAAA;;;;;;;;;0DA2CD;;4CAC+D;oDAUzE;;EAAA;;;;;;;;;;;;KAXU,yBAAA,WACF,yBAAA,eAAwC,yBAAA;;;;cAKrC,gBAAA;wEAUe;gCAAW;kCAK1B;;;oDAUgB;0CAAW;oEAK3B;;;4CAQY;4CAAW;oDAKvB;;;;;AAUb;;sCAA4F;sDAU1F;;;;;;KArDU,gBAAA,WAA2B,gBAAA,eAA+B,gBAAA;;;;cAKzD,iBAAA;+DAKX,mBAAA;EAAA,gBAAA;AAAA;;;;KAKU,iBAAA,WAA4B,iBAAA,eAAgC,iBAAA;;;;cAK3D,aAAA;yBAGX,eAAA;AAAA;;AAmCF;;KA9BY,aAAA,WAAwB,aAAA,eAA4B,aAAA;;;;cAKnD,kBAAA;8BAKX,SAAA;EAAA,MAAA;AAAA;;;;KAKU,kBAAA,WAA6B,kBAAA,eAAiC,kBAAA;;;;cAK7D,SAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAUD,SAAA,WAAoB,SAAA,eAAwB,SAAA"}

package/dist/enums/viewState.mjs

@@ -0,0 +1,66 @@
+import { makeEnum } from "@transcend-io/type-utils";
+//#region src/enums/viewState.ts
+/**
+* Consent Manager view state for the Interactive Advertising Bureau
+*/
+const IABViewState = makeEnum({ TCF_EU: "TCF_EU" });
+/**
+* View States for Transcend's Consent Manager UI
+*/
+const InitialTranscendViewState = makeEnum({
+	QuickOptions: "QuickOptions",
+	QuickOptions3: "QuickOptions3",
+	AcceptAll: "AcceptAll",
+	AcceptAllRejectAllToggle: "AcceptAllRejectAllToggle",
+	AcceptAllOrMoreChoices: "AcceptAllOrMoreChoices",
+	AcceptOrRejectAll: "AcceptOrRejectAll",
+	AcceptOrRejectAllOrMoreChoices: "AcceptOrRejectAllOrMoreChoices",
+	AcceptOrRejectAnalytics: "AcceptOrRejectAnalytics",
+	AcceptOrRejectAdvertising: "AcceptOrRejectAdvertising",
+	NoticeAndDoNotSell: "NoticeAndDoNotSell",
+	DoNotSellExplainer: "DoNotSellExplainer",
+	CompleteOptionsToggles: "CompleteOptionsToggles",
+	PrivacyPolicyNotice: "PrivacyPolicyNotice",
+	PrivacyPolicyNoticeWithCloseButton: "PrivacyPolicyNoticeWithCloseButton",
+	CompleteOptions: "CompleteOptions",
+	CompleteOptionsInverted: "CompleteOptionsInverted",
+	Hidden: "Hidden"
+});
+/**
+* Consent Manager view states that can be used at launch
+*/
+const InitialViewState = makeEnum({
+	...InitialTranscendViewState,
+	...IABViewState
+});
+/**
+* View states that are displayed in response to a user request (e.g. transcend.doNotSell() or )
+*/
+const ResponseViewState = makeEnum({
+	DoNotSellDisclosure: "DoNotSellDisclosure",
+	OptOutDisclosure: "OptOutDisclosure"
+});
+/**
+* Consent Manager view states that can be navigated to after initial view state
+*/
+const DeepViewState = makeEnum({ LanguageOptions: "LanguageOptions" });
+/**
+* Consent Manager view states after it's been dismissed
+*/
+const DismissedViewState = makeEnum({
+	Collapsed: "Collapsed",
+	Closed: "Closed"
+});
+/**
+* All possible view states of the Consent Manager
+*/
+const ViewState = makeEnum({
+	...InitialViewState,
+	...ResponseViewState,
+	...DeepViewState,
+	...DismissedViewState
+});
+//#endregion
+export { DeepViewState, DismissedViewState, IABViewState, InitialTranscendViewState, InitialViewState, ResponseViewState, ViewState };
+
+//# sourceMappingURL=viewState.mjs.map

package/dist/enums/viewState.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"viewState.mjs","names":[],"sources":["../../src/enums/viewState.ts"],"sourcesContent":["// main\nimport { makeEnum } from '@transcend-io/type-utils';\n\n/**\n * Consent Manager view state for the Interactive Advertising Bureau\n */\nexport const IABViewState = makeEnum({\n  /** Transparency and Consent Framework for Europe */\n  TCF_EU: 'TCF_EU',\n});\n\n/**\n * View States for Transcend's Consent Manager UI\n */\nexport const InitialTranscendViewState = makeEnum({\n  /** expanded and showing quick select options */\n  QuickOptions: 'QuickOptions',\n  /** three option UI: essential, functional/analytics, advertising */\n  QuickOptions3: 'QuickOptions3',\n  /** accept all button call to action, with more options in the banner footer */\n  AcceptAll: 'AcceptAll',\n  /** toggle button that toggles on or off all active purposes in the current regime */\n  AcceptAllRejectAllToggle: 'AcceptAllRejectAllToggle',\n  /** accept all or more options, both as calls to action */\n  AcceptAllOrMoreChoices: 'AcceptAllOrMoreChoices',\n  /** accept all or reject all */\n  AcceptOrRejectAll: 'AcceptOrRejectAll',\n  /** accept all or reject all or more options */\n  AcceptOrRejectAllOrMoreChoices: 'AcceptOrRejectAllOrMoreChoices',\n  /** accept or reject the Analytics script tag */\n  AcceptOrRejectAnalytics: 'AcceptOrRejectAnalytics',\n  /** accept or reject the Advertising script tag */\n  AcceptOrRejectAdvertising: 'AcceptOrRejectAdvertising',\n  /** data collection notice with do not sell */\n  NoticeAndDoNotSell: 'NoticeAndDoNotSell',\n  /** open a modal that allows for an explanation of do not sell/share, before opting out */\n  DoNotSellExplainer: 'DoNotSellExplainer',\n  /** open a modal that allows for complete options toggling */\n  CompleteOptionsToggles: 'CompleteOptionsToggles',\n  /** open a modal that shows a notice that the privacy policy has changed, without any prompt to change consent */\n  PrivacyPolicyNotice: 'PrivacyPolicyNotice',\n  /**\n   * open a modal that shows a notice that the privacy policy has changed, without any prompt to change consent\n   * and no button to close the modal. instead there is an X in the top right corner of the modal\n   */\n  PrivacyPolicyNoticeWithCloseButton: 'PrivacyPolicyNoticeWithCloseButton',\n  /** expanded and showing full checkbox options */\n  CompleteOptions: 'CompleteOptions',\n  /** complete options, but selecting a checkbox means the user is opted out */\n  CompleteOptionsInverted: 'CompleteOptionsInverted',\n  /** hidden */\n  Hidden: 'Hidden',\n});\n\n/**\n * Type override\n */\nexport type InitialTranscendViewState =\n  (typeof InitialTranscendViewState)[keyof typeof InitialTranscendViewState];\n\n/**\n * Consent Manager view states that can be used at launch\n */\nexport const InitialViewState = makeEnum({\n  /** View States for Transcend's Consent Manager UI */\n  ...InitialTranscendViewState,\n  /** View States for IAB Frameworks */\n  ...IABViewState,\n});\n\n/**\n * Type override\n */\nexport type InitialViewState = (typeof InitialViewState)[keyof typeof InitialViewState];\n\n/**\n * View states that are displayed in response to a user request (e.g. transcend.doNotSell() or )\n */\nexport const ResponseViewState = makeEnum({\n  /** notice that do not sell has been acknowledged properly */\n  DoNotSellDisclosure: 'DoNotSellDisclosure',\n  /** notice of a 1 click opt out for multiple consent purposes */\n  OptOutDisclosure: 'OptOutDisclosure',\n});\n\n/**\n * Type override\n */\nexport type ResponseViewState = (typeof ResponseViewState)[keyof typeof ResponseViewState];\n\n/**\n * Consent Manager view states that can be navigated to after initial view state\n */\nexport const DeepViewState = makeEnum({\n  /** language options */\n  LanguageOptions: 'LanguageOptions',\n});\n\n/**\n * Type override\n */\nexport type DeepViewState = (typeof DeepViewState)[keyof typeof DeepViewState];\n\n/**\n * Consent Manager view states after it's been dismissed\n */\nexport const DismissedViewState = makeEnum({\n  /** showing and collapsed */\n  Collapsed: 'Collapsed',\n  /** closed */\n  Closed: 'Closed',\n});\n\n/**\n * Type override\n */\nexport type DismissedViewState = (typeof DismissedViewState)[keyof typeof DismissedViewState];\n\n/**\n * All possible view states of the Consent Manager\n */\nexport const ViewState = makeEnum({\n  ...InitialViewState,\n  ...ResponseViewState,\n  ...DeepViewState,\n  ...DismissedViewState,\n});\n\n/**\n * Type override\n */\nexport type ViewState = (typeof ViewState)[keyof typeof ViewState];\n"],"mappings":";;;;;AAMA,MAAa,eAAe,SAAS,EAEnC,QAAQ,UACT,CAAC;;;;AAKF,MAAa,4BAA4B,SAAS;CAEhD,cAAc;CAEd,eAAe;CAEf,WAAW;CAEX,0BAA0B;CAE1B,wBAAwB;CAExB,mBAAmB;CAEnB,gCAAgC;CAEhC,yBAAyB;CAEzB,2BAA2B;CAE3B,oBAAoB;CAEpB,oBAAoB;CAEpB,wBAAwB;CAExB,qBAAqB;CAKrB,oCAAoC;CAEpC,iBAAiB;CAEjB,yBAAyB;CAEzB,QAAQ;CACT,CAAC;;;;AAWF,MAAa,mBAAmB,SAAS;CAEvC,GAAG;CAEH,GAAG;CACJ,CAAC;;;;AAUF,MAAa,oBAAoB,SAAS;CAExC,qBAAqB;CAErB,kBAAkB;CACnB,CAAC;;;;AAUF,MAAa,gBAAgB,SAAS,EAEpC,iBAAiB,mBAClB,CAAC;;;;AAUF,MAAa,qBAAqB,SAAS;CAEzC,WAAW;CAEX,QAAQ;CACT,CAAC;;;;AAUF,MAAa,YAAY,SAAS;CAChC,GAAG;CACH,GAAG;CACH,GAAG;CACH,GAAG;CACJ,CAAC"}

package/dist/experience.d.mts

@@ -0,0 +1,68 @@
+import { PrivacyRegime } from "./core.mjs";
+import { Purpose } from "./enums/purpose.mjs";
+import { InitialViewState } from "./enums/viewState.mjs";
+import { RegionsOperator } from "./enums/experience.mjs";
+import { OnConsentExpiry } from "./enums/consentExpiry.mjs";
+import { IsoCountryCode } from "@transcend-io/privacy-types";
+
+//#region src/experience.d.ts
+interface Region {
+  /** A country's ISO code */
+  country: IsoCountryCode;
+  /** A country subdivision ISO code */
+  countrySubDivision?: string;
+}
+interface ExperiencePurposeInput {
+  /** name of the purpose */
+  purpose: Purpose;
+  /** opt out by default */
+  defaultOptOut: boolean;
+}
+interface ExperienceInput {
+  /** The regime determining the default experience */
+  name: PrivacyRegime;
+  /** The display name of the experience */
+  displayName: string;
+  /** A list of regions to be included/not included in this experience */
+  regions: Region[];
+  /** A list of browser languages that this experience applies to */
+  browserLanguages: string[];
+  /** A list of browser time zones that this experience applies to */
+  browserTimeZones: string[];
+  /** Whether the listed regions are included or excluded from the experience */
+  operator: RegionsOperator;
+  /** If data subject linked to multiple experiences, display priority for experiences. Lower number, higher priority. */
+  displayPriority: number;
+  /** The view state to display on transcend.showConsentManager() */
+  viewState: InitialViewState;
+  /** experience purposes to be added */
+  experiencePurposeInputs: ExperiencePurposeInput[];
+  /** Time in months after which a user's opt-in consent should expire */
+  consentExpiry: number;
+  /** Behavior to exhibit when the user's consent has expired */
+  onConsentExpiry: OnConsentExpiry;
+}
+declare const REGIME_REGIONS: Record<PrivacyRegime, Region[]>;
+declare const REGIME_LANGUAGES: Record<PrivacyRegime, string[]>;
+declare const REGIME_CONSENT_EXPIRY: Record<PrivacyRegime, number>;
+declare const REGIME_ON_CONSENT_EXPIRY: Record<PrivacyRegime, OnConsentExpiry>;
+/**
+ * construct default experience for regime
+ * @param regime - regime
+ * @returns ExperienceInput
+ */
+declare function defaultExperience(regime: PrivacyRegime): ExperienceInput;
+declare const DEFAULT_EXPERIENCES: {
+  Unknown: ExperienceInput;
+  CPRA: ExperienceInput;
+  GDPR: ExperienceInput;
+  LGPD: ExperienceInput;
+  CDPA: ExperienceInput;
+  CPA: ExperienceInput;
+  NEVADA_SB220: ExperienceInput;
+  nFADP: ExperienceInput;
+  US_DNSS: ExperienceInput;
+};
+//#endregion
+export { DEFAULT_EXPERIENCES, ExperienceInput, ExperiencePurposeInput, REGIME_CONSENT_EXPIRY, REGIME_LANGUAGES, REGIME_ON_CONSENT_EXPIRY, REGIME_REGIONS, Region, defaultExperience };
+//# sourceMappingURL=experience.d.mts.map

package/dist/experience.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"experience.d.mts","names":[],"sources":["../src/experience.ts"],"mappings":";;;;;;;;UAkBiB,MAAA;;EAEf,OAAA,EAAS,cAAA;EAFM;EAIf,kBAAA;AAAA;AAAA,UAGe,sBAAA;EALf;EAOA,OAAA,EAAS,OAAA;EALT;EAOA,aAAA;AAAA;AAAA,UAGe,eAAA;EAPsB;EASrC,IAAA,EAAM,aAAA;EAPU;EAShB,WAAA;EATS;EAWT,OAAA,EAAS,MAAA;EATI;EAWb,gBAAA;EARe;EAUf,gBAAA;;EAEA,QAAA,EAAU,eAAA;EAND;EAQT,eAAA;EAEW;EAAX,SAAA,EAAW,gBAAA;EAMM;EAJjB,uBAAA,EAAyB,sBAAA;EAIO;EAFhC,aAAA;EAlBM;EAoBN,eAAA,EAAiB,eAAA;AAAA;AAAA,cAKN,cAAA,EAAgB,MAAA,CAAO,aAAA,EAAe,MAAA;AAAA,cAmCtC,gBAAA,EAAkB,MAAA,CAAO,aAAA;AAAA,cAmDzB,qBAAA,EAAuB,MAAA,CAAO,aAAA;AAAA,cAK9B,wBAAA,EAA0B,MAAA,CAAO,aAAA,EAAe,eAAA;;;;;;iBAS7C,iBAAA,CAAkB,MAAA,EAAQ,aAAA,GAAgB,eAAA;AAAA,cAqB7C,mBAAA"}

package/dist/experience.mjs

@@ -0,0 +1,180 @@
+import { PrivacyRegimeEnum } from "./enums/privacyRegime.mjs";
+import { InitialViewState } from "./enums/viewState.mjs";
+import { BrowserLanguage } from "./enums/browserLanguage.mjs";
+import { RegionsOperator } from "./enums/experience.mjs";
+import { OnConsentExpiry } from "./enums/consentExpiry.mjs";
+import { DEFAULT_VIEW_STATE_BY_PRIVACY_REGIME } from "./ui.mjs";
+import { DEFAULT_EXPERIENCE_PURPOSE_OPT_OUTS, DEFAULT_EXPERIENCE_PURPOSE_SCOPES, REGIME_DISPLAY_PRIORITY, REGIME_TIMEZONES } from "./constants.mjs";
+import { applyEnum } from "@transcend-io/type-utils";
+import "@transcend-io/privacy-types";
+//#region src/experience.ts
+const REGIME_REGIONS = {
+	CPRA: [{
+		country: "US",
+		countrySubDivision: "US-CA"
+	}],
+	GDPR: [
+		{ country: "EU" },
+		{ country: "GB" },
+		{ country: "NO" },
+		{ country: "IS" },
+		{ country: "LI" }
+	],
+	LGPD: [{ country: "BR" }],
+	CDPA: [{
+		country: "US",
+		countrySubDivision: "US-VA"
+	}],
+	CPA: [{
+		country: "US",
+		countrySubDivision: "US-CO"
+	}],
+	UCPA: [{
+		country: "US",
+		countrySubDivision: "US-UT"
+	}],
+	NEVADA_SB220: [{
+		country: "US",
+		countrySubDivision: "US-NV"
+	}],
+	nFADP: [{ country: "CH" }],
+	US_DNSS: [
+		{
+			country: "US",
+			countrySubDivision: "US-CA"
+		},
+		{
+			country: "US",
+			countrySubDivision: "US-VA"
+		},
+		{
+			country: "US",
+			countrySubDivision: "US-CO"
+		},
+		{
+			country: "US",
+			countrySubDivision: "US-NV"
+		},
+		{
+			country: "US",
+			countrySubDivision: "US-TX"
+		},
+		{
+			country: "US",
+			countrySubDivision: "US-CT"
+		},
+		{
+			country: "US",
+			countrySubDivision: "US-OR"
+		},
+		{
+			country: "US",
+			countrySubDivision: "US-MT"
+		},
+		{
+			country: "US",
+			countrySubDivision: "US-UT"
+		},
+		{
+			country: "US",
+			countrySubDivision: "US-IA"
+		},
+		{
+			country: "US",
+			countrySubDivision: "US-DE"
+		},
+		{
+			country: "US",
+			countrySubDivision: "US-NH"
+		},
+		{
+			country: "US",
+			countrySubDivision: "US-NE"
+		},
+		{
+			country: "US",
+			countrySubDivision: "US-NJ"
+		}
+	]
+};
+const REGIME_LANGUAGES = {
+	GDPR: [
+		BrowserLanguage["Bulgarian (Bulgaria)"],
+		BrowserLanguage["Croatian (Croatia)"],
+		BrowserLanguage["Czech (Czech Republic)"],
+		BrowserLanguage["Danish (Denmark)"],
+		BrowserLanguage["Dutch (Belgium)"],
+		BrowserLanguage["Dutch (Netherlands)"],
+		BrowserLanguage["English (Ireland)"],
+		BrowserLanguage["Estonian (Estonia)"],
+		BrowserLanguage["Finnish (Finland)"],
+		BrowserLanguage["French (Belgium)"],
+		BrowserLanguage["French (France)"],
+		BrowserLanguage["French (Luxembourg)"],
+		BrowserLanguage["German (Austria)"],
+		BrowserLanguage["German (Germany)"],
+		BrowserLanguage["German (Liechtenstein)"],
+		BrowserLanguage["German (Luxembourg)"],
+		BrowserLanguage["Greek (Greece)"],
+		BrowserLanguage["Hungarian (Hungary)"],
+		BrowserLanguage["Icelandic (Iceland)"],
+		BrowserLanguage["Irish (Ireland)"],
+		BrowserLanguage["Italian (Italy)"],
+		BrowserLanguage["Latvian (Latvia)"],
+		BrowserLanguage["Lithuanian (Lithuania)"],
+		BrowserLanguage["Maltese (Malta)"],
+		BrowserLanguage["Norwegian (Norway)"],
+		BrowserLanguage["Norwegian Bokmål (Norway)"],
+		BrowserLanguage["Norwegian Nynorsk (Norway)"],
+		BrowserLanguage["Polish (Poland)"],
+		BrowserLanguage["Portuguese (Portugal)"],
+		BrowserLanguage["Romanian (Romania)"],
+		BrowserLanguage["Slovak (Slovakia)"],
+		BrowserLanguage["Slovenian (Slovenia)"],
+		BrowserLanguage["Spanish (España)"],
+		BrowserLanguage["Swedish (Finland)"],
+		BrowserLanguage["Swedish (Finland)"],
+		BrowserLanguage["Swedish (Sweden)"]
+	],
+	LGPD: [BrowserLanguage["Portuguese (Brazil)"]],
+	nFADP: [
+		BrowserLanguage["German (Switzerland)"],
+		BrowserLanguage["French (Switzerland)"],
+		BrowserLanguage["Italian (Switzerland)"],
+		BrowserLanguage["English (Switzerland)"],
+		BrowserLanguage["Portuguese (Switzerland)"],
+		BrowserLanguage["Swiss German (Switzerland)"]
+	]
+};
+const REGIME_CONSENT_EXPIRY = { GDPR: 12 };
+const REGIME_ON_CONSENT_EXPIRY = { GDPR: OnConsentExpiry.ResetOptIns };
+/**
+* construct default experience for regime
+* @param regime - regime
+* @returns ExperienceInput
+*/
+function defaultExperience(regime) {
+	const isUnknown = regime === "Unknown";
+	const regimeEnum = PrivacyRegimeEnum[regime];
+	return {
+		name: regime,
+		displayName: regime,
+		regions: REGIME_REGIONS[regime] ?? [],
+		operator: isUnknown ? RegionsOperator.NotIn : RegionsOperator.In,
+		displayPriority: REGIME_DISPLAY_PRIORITY[regime] ?? 20,
+		viewState: DEFAULT_VIEW_STATE_BY_PRIVACY_REGIME[regimeEnum] ?? InitialViewState.Hidden,
+		browserLanguages: REGIME_LANGUAGES[regime] ?? [],
+		browserTimeZones: REGIME_TIMEZONES[regime] ?? [],
+		experiencePurposeInputs: DEFAULT_EXPERIENCE_PURPOSE_SCOPES[regime].map((purpose) => ({
+			purpose,
+			defaultOptOut: DEFAULT_EXPERIENCE_PURPOSE_OPT_OUTS[regime]?.includes(purpose) ?? false
+		})),
+		consentExpiry: REGIME_CONSENT_EXPIRY[regime] ?? 0,
+		onConsentExpiry: REGIME_ON_CONSENT_EXPIRY[regime] ?? OnConsentExpiry.Prompt
+	};
+}
+const DEFAULT_EXPERIENCES = applyEnum(PrivacyRegimeEnum, defaultExperience);
+//#endregion
+export { DEFAULT_EXPERIENCES, REGIME_CONSENT_EXPIRY, REGIME_LANGUAGES, REGIME_ON_CONSENT_EXPIRY, REGIME_REGIONS, defaultExperience };
+
+//# sourceMappingURL=experience.mjs.map

package/dist/experience.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"experience.mjs","names":[],"sources":["../src/experience.ts"],"sourcesContent":["import { IsoCountryCode } from '@transcend-io/privacy-types';\n// main\nimport { applyEnum } from '@transcend-io/type-utils';\n\nimport {\n  DEFAULT_EXPERIENCE_PURPOSE_SCOPES,\n  DEFAULT_EXPERIENCE_PURPOSE_OPT_OUTS,\n  REGIME_DISPLAY_PRIORITY,\n  REGIME_TIMEZONES,\n} from './constants.js';\nimport type { PrivacyRegime } from './core.js';\nimport { BrowserLanguage, OnConsentExpiry, RegionsOperator } from './enums/index.js';\n// local\nimport { PrivacyRegimeEnum } from './enums/privacyRegime.js';\nimport { Purpose } from './enums/purpose.js';\nimport { InitialViewState } from './enums/viewState.js';\nimport { DEFAULT_VIEW_STATE_BY_PRIVACY_REGIME } from './ui.js';\n\nexport interface Region {\n  /** A country's ISO code */\n  country: IsoCountryCode;\n  /** A country subdivision ISO code */\n  countrySubDivision?: string;\n}\n\nexport interface ExperiencePurposeInput {\n  /** name of the purpose */\n  purpose: Purpose;\n  /** opt out by default */\n  defaultOptOut: boolean;\n}\n\nexport interface ExperienceInput {\n  /** The regime determining the default experience */\n  name: PrivacyRegime;\n  /** The display name of the experience */\n  displayName: string;\n  /** A list of regions to be included/not included in this experience */\n  regions: Region[];\n  /** A list of browser languages that this experience applies to */\n  browserLanguages: string[];\n  /** A list of browser time zones that this experience applies to */\n  browserTimeZones: string[];\n  /** Whether the listed regions are included or excluded from the experience */\n  operator: RegionsOperator;\n  /** If data subject linked to multiple experiences, display priority for experiences. Lower number, higher priority. */\n  displayPriority: number;\n  /** The view state to display on transcend.showConsentManager() */\n  viewState: InitialViewState;\n  /** experience purposes to be added */\n  experiencePurposeInputs: ExperiencePurposeInput[];\n  /** Time in months after which a user's opt-in consent should expire */\n  consentExpiry: number;\n  /** Behavior to exhibit when the user's consent has expired */\n  onConsentExpiry: OnConsentExpiry;\n}\n\n// default to []\n// Don't put this into constants or you will regret it (per the constants.ts warning)\nexport const REGIME_REGIONS: Record<PrivacyRegime, Region[]> = {\n  CPRA: [{ country: 'US', countrySubDivision: 'US-CA' }],\n  GDPR: [\n    { country: 'EU' },\n    { country: 'GB' },\n    { country: 'NO' },\n    { country: 'IS' },\n    { country: 'LI' },\n  ],\n  LGPD: [{ country: 'BR' }],\n  CDPA: [{ country: 'US', countrySubDivision: 'US-VA' }],\n  CPA: [{ country: 'US', countrySubDivision: 'US-CO' }],\n  UCPA: [{ country: 'US', countrySubDivision: 'US-UT' }],\n  NEVADA_SB220: [{ country: 'US', countrySubDivision: 'US-NV' }],\n  nFADP: [{ country: 'CH' }],\n  US_DNSS: [\n    { country: 'US', countrySubDivision: 'US-CA' },\n    { country: 'US', countrySubDivision: 'US-VA' },\n    { country: 'US', countrySubDivision: 'US-CO' },\n    { country: 'US', countrySubDivision: 'US-NV' },\n    { country: 'US', countrySubDivision: 'US-TX' },\n    { country: 'US', countrySubDivision: 'US-CT' },\n    { country: 'US', countrySubDivision: 'US-OR' },\n    { country: 'US', countrySubDivision: 'US-MT' },\n    { country: 'US', countrySubDivision: 'US-UT' },\n    { country: 'US', countrySubDivision: 'US-IA' },\n    { country: 'US', countrySubDivision: 'US-DE' },\n    { country: 'US', countrySubDivision: 'US-NH' },\n    { country: 'US', countrySubDivision: 'US-NE' },\n    { country: 'US', countrySubDivision: 'US-NJ' },\n  ],\n};\n\n// default to []\n// Don't put this into constants or you will regret it (per the constants.ts warning)\nexport const REGIME_LANGUAGES: Record<PrivacyRegime, string[]> = {\n  GDPR: [\n    BrowserLanguage['Bulgarian (Bulgaria)'],\n    BrowserLanguage['Croatian (Croatia)'],\n    BrowserLanguage['Czech (Czech Republic)'],\n    BrowserLanguage['Danish (Denmark)'],\n    BrowserLanguage['Dutch (Belgium)'],\n    BrowserLanguage['Dutch (Netherlands)'],\n    BrowserLanguage['English (Ireland)'],\n    BrowserLanguage['Estonian (Estonia)'],\n    BrowserLanguage['Finnish (Finland)'],\n    BrowserLanguage['French (Belgium)'],\n    BrowserLanguage['French (France)'],\n    BrowserLanguage['French (Luxembourg)'],\n    BrowserLanguage['German (Austria)'],\n    BrowserLanguage['German (Germany)'],\n    BrowserLanguage['German (Liechtenstein)'],\n    BrowserLanguage['German (Luxembourg)'],\n    BrowserLanguage['Greek (Greece)'],\n    BrowserLanguage['Hungarian (Hungary)'],\n    BrowserLanguage['Icelandic (Iceland)'],\n    BrowserLanguage['Irish (Ireland)'],\n    BrowserLanguage['Italian (Italy)'],\n    BrowserLanguage['Latvian (Latvia)'],\n    BrowserLanguage['Lithuanian (Lithuania)'],\n    BrowserLanguage['Maltese (Malta)'],\n    BrowserLanguage['Norwegian (Norway)'],\n    BrowserLanguage['Norwegian Bokmål (Norway)'],\n    BrowserLanguage['Norwegian Nynorsk (Norway)'],\n    BrowserLanguage['Polish (Poland)'],\n    BrowserLanguage['Portuguese (Portugal)'],\n    BrowserLanguage['Romanian (Romania)'],\n    BrowserLanguage['Slovak (Slovakia)'],\n    BrowserLanguage['Slovenian (Slovenia)'],\n    BrowserLanguage['Spanish (Espa\\u00f1a)'],\n    BrowserLanguage['Swedish (Finland)'],\n    BrowserLanguage['Swedish (Finland)'],\n    BrowserLanguage['Swedish (Sweden)'],\n  ],\n  LGPD: [BrowserLanguage['Portuguese (Brazil)']],\n  nFADP: [\n    BrowserLanguage['German (Switzerland)'],\n    BrowserLanguage['French (Switzerland)'],\n    BrowserLanguage['Italian (Switzerland)'],\n    BrowserLanguage['English (Switzerland)'],\n    BrowserLanguage['Portuguese (Switzerland)'],\n    BrowserLanguage['Swiss German (Switzerland)'],\n  ],\n};\n\n// default to 0\nexport const REGIME_CONSENT_EXPIRY: Record<PrivacyRegime, number> = {\n  GDPR: 12,\n};\n\n// default to prompt\nexport const REGIME_ON_CONSENT_EXPIRY: Record<PrivacyRegime, OnConsentExpiry> = {\n  GDPR: OnConsentExpiry.ResetOptIns,\n};\n\n/**\n * construct default experience for regime\n * @param regime - regime\n * @returns ExperienceInput\n */\nexport function defaultExperience(regime: PrivacyRegime): ExperienceInput {\n  const isUnknown = regime === 'Unknown';\n  const regimeEnum = PrivacyRegimeEnum[regime as keyof typeof PrivacyRegimeEnum];\n  return {\n    name: regime,\n    displayName: regime,\n    regions: REGIME_REGIONS[regime] ?? [],\n    operator: isUnknown ? RegionsOperator.NotIn : RegionsOperator.In,\n    displayPriority: REGIME_DISPLAY_PRIORITY[regime] ?? 20,\n    viewState: DEFAULT_VIEW_STATE_BY_PRIVACY_REGIME[regimeEnum] ?? InitialViewState.Hidden,\n    browserLanguages: REGIME_LANGUAGES[regime] ?? [],\n    browserTimeZones: REGIME_TIMEZONES[regime] ?? [],\n    experiencePurposeInputs: DEFAULT_EXPERIENCE_PURPOSE_SCOPES[regime].map((purpose: Purpose) => ({\n      purpose,\n      defaultOptOut: DEFAULT_EXPERIENCE_PURPOSE_OPT_OUTS[regime]?.includes(purpose) ?? false,\n    })),\n    consentExpiry: REGIME_CONSENT_EXPIRY[regime] ?? 0,\n    onConsentExpiry: REGIME_ON_CONSENT_EXPIRY[regime] ?? OnConsentExpiry.Prompt,\n  };\n}\n\nexport const DEFAULT_EXPERIENCES = applyEnum(PrivacyRegimeEnum, defaultExperience);\n"],"mappings":";;;;;;;;;;AA2DA,MAAa,iBAAkD;CAC7D,MAAM,CAAC;EAAE,SAAS;EAAM,oBAAoB;EAAS,CAAC;CACtD,MAAM;EACJ,EAAE,SAAS,MAAM;EACjB,EAAE,SAAS,MAAM;EACjB,EAAE,SAAS,MAAM;EACjB,EAAE,SAAS,MAAM;EACjB,EAAE,SAAS,MAAM;EAClB;CACD,MAAM,CAAC,EAAE,SAAS,MAAM,CAAC;CACzB,MAAM,CAAC;EAAE,SAAS;EAAM,oBAAoB;EAAS,CAAC;CACtD,KAAK,CAAC;EAAE,SAAS;EAAM,oBAAoB;EAAS,CAAC;CACrD,MAAM,CAAC;EAAE,SAAS;EAAM,oBAAoB;EAAS,CAAC;CACtD,cAAc,CAAC;EAAE,SAAS;EAAM,oBAAoB;EAAS,CAAC;CAC9D,OAAO,CAAC,EAAE,SAAS,MAAM,CAAC;CAC1B,SAAS;EACP;GAAE,SAAS;GAAM,oBAAoB;GAAS;EAC9C;GAAE,SAAS;GAAM,oBAAoB;GAAS;EAC9C;GAAE,SAAS;GAAM,oBAAoB;GAAS;EAC9C;GAAE,SAAS;GAAM,oBAAoB;GAAS;EAC9C;GAAE,SAAS;GAAM,oBAAoB;GAAS;EAC9C;GAAE,SAAS;GAAM,oBAAoB;GAAS;EAC9C;GAAE,SAAS;GAAM,oBAAoB;GAAS;EAC9C;GAAE,SAAS;GAAM,oBAAoB;GAAS;EAC9C;GAAE,SAAS;GAAM,oBAAoB;GAAS;EAC9C;GAAE,SAAS;GAAM,oBAAoB;GAAS;EAC9C;GAAE,SAAS;GAAM,oBAAoB;GAAS;EAC9C;GAAE,SAAS;GAAM,oBAAoB;GAAS;EAC9C;GAAE,SAAS;GAAM,oBAAoB;GAAS;EAC9C;GAAE,SAAS;GAAM,oBAAoB;GAAS;EAC/C;CACF;AAID,MAAa,mBAAoD;CAC/D,MAAM;EACJ,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EACjB;CACD,MAAM,CAAC,gBAAgB,uBAAuB;CAC9C,OAAO;EACL,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EAChB,gBAAgB;EACjB;CACF;AAGD,MAAa,wBAAuD,EAClE,MAAM,IACP;AAGD,MAAa,2BAAmE,EAC9E,MAAM,gBAAgB,aACvB;;;;;;AAOD,SAAgB,kBAAkB,QAAwC;CACxE,MAAM,YAAY,WAAW;CAC7B,MAAM,aAAa,kBAAkB;AACrC,QAAO;EACL,MAAM;EACN,aAAa;EACb,SAAS,eAAe,WAAW,EAAE;EACrC,UAAU,YAAY,gBAAgB,QAAQ,gBAAgB;EAC9D,iBAAiB,wBAAwB,WAAW;EACpD,WAAW,qCAAqC,eAAe,iBAAiB;EAChF,kBAAkB,iBAAiB,WAAW,EAAE;EAChD,kBAAkB,iBAAiB,WAAW,EAAE;EAChD,yBAAyB,kCAAkC,QAAQ,KAAK,aAAsB;GAC5F;GACA,eAAe,oCAAoC,SAAS,SAAS,QAAQ,IAAI;GAClF,EAAE;EACH,eAAe,sBAAsB,WAAW;EAChD,iBAAiB,yBAAyB,WAAW,gBAAgB;EACtE;;AAGH,MAAa,sBAAsB,UAAU,mBAAmB,kBAAkB"}