@walkeros/web-source-cmp-cookiepro 0.1.0

package/dist/examples/index.d.ts

@@ -0,0 +1,129 @@
+import { WalkerOS, Elb, Logger } from '@walkeros/core';
+
+/**
+ * Example CookiePro OptanonActiveGroups strings.
+ *
+ * These represent real consent states from CookiePro/OneTrust CMP.
+ * Format: comma-separated active category IDs with leading/trailing commas.
+ * Only active groups are listed. Absence means denied.
+ */
+/**
+ * Full consent - user accepted all categories
+ */
+declare const fullConsent = ",C0001,C0002,C0003,C0004,C0005,";
+/**
+ * Partial consent - necessary + functional only
+ */
+declare const partialConsent = ",C0001,C0003,";
+/**
+ * Minimal consent - only strictly necessary (always active)
+ */
+declare const minimalConsent = ",C0001,";
+/**
+ * Analytics only - necessary + performance
+ */
+declare const analyticsOnlyConsent = ",C0001,C0002,";
+/**
+ * Marketing only - necessary + targeting
+ */
+declare const marketingOnlyConsent = ",C0001,C0004,";
+/**
+ * Empty string - no consent yet or cleared
+ */
+declare const emptyConsent = "";
+/**
+ * Custom category IDs - some installations use custom IDs
+ */
+declare const customCategoryConsent = ",C0001,CUSTOM01,CUSTOM02,";
+
+/**
+ * Expected walkerOS consent outputs.
+ *
+ * These represent the consent state after parsing OptanonActiveGroups
+ * and mapping through the default categoryMap.
+ *
+ * Default map:
+ * - C0001 -> functional
+ * - C0002 -> analytics
+ * - C0003 -> functional
+ * - C0004 -> marketing
+ * - C0005 -> marketing
+ *
+ * All mapped walkerOS groups get explicit true/false values.
+ * Active groups -> true, absent groups -> false.
+ */
+/**
+ * Full consent mapped to walkerOS groups
+ */
+declare const fullConsentMapped: WalkerOS.Consent;
+/**
+ * Partial consent - necessary + functional mapped
+ * C0001 -> functional (true), C0003 -> functional (true)
+ * analytics and marketing absent -> false
+ */
+declare const partialConsentMapped: WalkerOS.Consent;
+/**
+ * Minimal consent - only strictly necessary
+ * C0001 -> functional (true)
+ * analytics and marketing absent -> false
+ */
+declare const minimalConsentMapped: WalkerOS.Consent;
+/**
+ * Analytics only - necessary + performance
+ * C0001 -> functional (true), C0002 -> analytics (true)
+ * marketing absent -> false
+ */
+declare const analyticsOnlyMapped: WalkerOS.Consent;
+/**
+ * Marketing only - necessary + targeting
+ * C0001 -> functional (true), C0004 -> marketing (true)
+ * analytics absent -> false
+ */
+declare const marketingOnlyMapped: WalkerOS.Consent;
+
+/**
+ * OneTrust global API interface.
+ *
+ * Represents the subset of the OneTrust SDK we interact with.
+ * The full SDK is much larger, but we only need consent-related methods.
+ */
+interface OneTrustAPI {
+    /** Returns true if user has made an explicit consent choice */
+    IsAlertBoxClosed: () => boolean;
+    /** Register a callback for consent changes (callback receives event with detail: string[]) */
+    OnConsentChanged?: (fn: (event: {
+        detail: string[];
+    }) => void) => void;
+}
+declare global {
+    interface Window {
+        /** OneTrust SDK global object */
+        OneTrust?: OneTrustAPI;
+        /** Comma-separated string of active consent category IDs (e.g. ",C0001,C0003,") */
+        OptanonActiveGroups?: string;
+        /** OneTrust callback function, called on SDK load and consent changes */
+        OptanonWrapper?: () => void;
+        /** CookiePro legacy alias for OneTrust */
+        Optanon?: unknown;
+        [key: string]: OneTrustAPI | unknown;
+    }
+    interface WindowEventMap {
+        /** event.detail is an array of active group ID strings (e.g. ["C0001", "C0002"]) */
+        OneTrustGroupsUpdated: CustomEvent<string[]>;
+    }
+}
+
+/**
+ * Create a properly typed elb/push function mock
+ */
+declare const createMockElbFn: () => Elb.Fn;
+/**
+ * Simple no-op logger for demo purposes
+ */
+declare const noopLogger: Logger.Instance;
+/**
+ * Create a mock OneTrust API object
+ */
+declare const createMockOneTrustAPI: (isAlertBoxClosed?: boolean) => OneTrustAPI;
+
+export { analyticsOnlyConsent, analyticsOnlyMapped, createMockElbFn, createMockOneTrustAPI, customCategoryConsent, emptyConsent, fullConsent, fullConsentMapped, marketingOnlyConsent, marketingOnlyMapped, minimalConsent, minimalConsentMapped, noopLogger, partialConsent, partialConsentMapped };

package/dist/examples/index.js

@@ -0,0 +1,115 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/examples/index.ts
+var examples_exports = {};
+__export(examples_exports, {
+  analyticsOnlyConsent: () => analyticsOnlyConsent,
+  analyticsOnlyMapped: () => analyticsOnlyMapped,
+  createMockElbFn: () => createMockElbFn,
+  createMockOneTrustAPI: () => createMockOneTrustAPI,
+  customCategoryConsent: () => customCategoryConsent,
+  emptyConsent: () => emptyConsent,
+  fullConsent: () => fullConsent,
+  fullConsentMapped: () => fullConsentMapped,
+  marketingOnlyConsent: () => marketingOnlyConsent,
+  marketingOnlyMapped: () => marketingOnlyMapped,
+  minimalConsent: () => minimalConsent,
+  minimalConsentMapped: () => minimalConsentMapped,
+  noopLogger: () => noopLogger,
+  partialConsent: () => partialConsent,
+  partialConsentMapped: () => partialConsentMapped
+});
+module.exports = __toCommonJS(examples_exports);
+
+// src/examples/inputs.ts
+var fullConsent = ",C0001,C0002,C0003,C0004,C0005,";
+var partialConsent = ",C0001,C0003,";
+var minimalConsent = ",C0001,";
+var analyticsOnlyConsent = ",C0001,C0002,";
+var marketingOnlyConsent = ",C0001,C0004,";
+var emptyConsent = "";
+var customCategoryConsent = ",C0001,CUSTOM01,CUSTOM02,";
+
+// src/examples/outputs.ts
+var fullConsentMapped = {
+  functional: true,
+  analytics: true,
+  marketing: true
+};
+var partialConsentMapped = {
+  functional: true,
+  analytics: false,
+  marketing: false
+};
+var minimalConsentMapped = {
+  functional: true,
+  analytics: false,
+  marketing: false
+};
+var analyticsOnlyMapped = {
+  functional: true,
+  analytics: true,
+  marketing: false
+};
+var marketingOnlyMapped = {
+  functional: true,
+  analytics: false,
+  marketing: true
+};
+
+// src/examples/env.ts
+var noop = () => {
+};
+var createMockElbFn = () => {
+  const fn = (() => Promise.resolve({
+    ok: true
+  }));
+  return fn;
+};
+var noopLogger = {
+  error: noop,
+  info: noop,
+  debug: noop,
+  throw: (message) => {
+    throw typeof message === "string" ? new Error(message) : message;
+  },
+  scope: () => noopLogger
+};
+var createMockOneTrustAPI = (isAlertBoxClosed = false) => ({
+  IsAlertBoxClosed: () => isAlertBoxClosed
+});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  analyticsOnlyConsent,
+  analyticsOnlyMapped,
+  createMockElbFn,
+  createMockOneTrustAPI,
+  customCategoryConsent,
+  emptyConsent,
+  fullConsent,
+  fullConsentMapped,
+  marketingOnlyConsent,
+  marketingOnlyMapped,
+  minimalConsent,
+  minimalConsentMapped,
+  noopLogger,
+  partialConsent,
+  partialConsentMapped
+});

package/dist/examples/index.mjs

@@ -0,0 +1,74 @@
+// src/examples/inputs.ts
+var fullConsent = ",C0001,C0002,C0003,C0004,C0005,";
+var partialConsent = ",C0001,C0003,";
+var minimalConsent = ",C0001,";
+var analyticsOnlyConsent = ",C0001,C0002,";
+var marketingOnlyConsent = ",C0001,C0004,";
+var emptyConsent = "";
+var customCategoryConsent = ",C0001,CUSTOM01,CUSTOM02,";
+
+// src/examples/outputs.ts
+var fullConsentMapped = {
+  functional: true,
+  analytics: true,
+  marketing: true
+};
+var partialConsentMapped = {
+  functional: true,
+  analytics: false,
+  marketing: false
+};
+var minimalConsentMapped = {
+  functional: true,
+  analytics: false,
+  marketing: false
+};
+var analyticsOnlyMapped = {
+  functional: true,
+  analytics: true,
+  marketing: false
+};
+var marketingOnlyMapped = {
+  functional: true,
+  analytics: false,
+  marketing: true
+};
+
+// src/examples/env.ts
+var noop = () => {
+};
+var createMockElbFn = () => {
+  const fn = (() => Promise.resolve({
+    ok: true
+  }));
+  return fn;
+};
+var noopLogger = {
+  error: noop,
+  info: noop,
+  debug: noop,
+  throw: (message) => {
+    throw typeof message === "string" ? new Error(message) : message;
+  },
+  scope: () => noopLogger
+};
+var createMockOneTrustAPI = (isAlertBoxClosed = false) => ({
+  IsAlertBoxClosed: () => isAlertBoxClosed
+});
+export {
+  analyticsOnlyConsent,
+  analyticsOnlyMapped,
+  createMockElbFn,
+  createMockOneTrustAPI,
+  customCategoryConsent,
+  emptyConsent,
+  fullConsent,
+  fullConsentMapped,
+  marketingOnlyConsent,
+  marketingOnlyMapped,
+  minimalConsent,
+  minimalConsentMapped,
+  noopLogger,
+  partialConsent,
+  partialConsentMapped
+};

package/dist/index.browser.js

@@ -0,0 +1 @@
+"use strict";var SourceCookiePro=(()=>{var e=Object.defineProperty,n=Object.getOwnPropertyDescriptor,t=Object.getOwnPropertyNames,o=Object.prototype.hasOwnProperty,r={};((n,t)=>{for(var o in t)e(n,o,{get:t[o],enumerable:!0})})(r,{DEFAULT_CATEGORY_MAP:()=>M,SourceCookiePro:()=>a,analyticsOnlyConsent:()=>p,analyticsOnlyMapped:()=>f,createMockElbFn:()=>b,createMockOneTrustAPI:()=>w,customCategoryConsent:()=>g,default:()=>T,emptyConsent:()=>C,fullConsent:()=>i,fullConsentMapped:()=>d,marketingOnlyConsent:()=>u,marketingOnlyMapped:()=>m,minimalConsent:()=>c,minimalConsentMapped:()=>O,noopLogger:()=>k,partialConsent:()=>s,partialConsentMapped:()=>y,sourceCookiePro:()=>h});var l,a={},i=",C0001,C0002,C0003,C0004,C0005,",s=",C0001,C0003,",c=",C0001,",p=",C0001,C0002,",u=",C0001,C0004,",C="",g=",C0001,CUSTOM01,CUSTOM02,",d={functional:!0,analytics:!0,marketing:!0},y={functional:!0,analytics:!1,marketing:!1},O={functional:!0,analytics:!1,marketing:!1},f={functional:!0,analytics:!0,marketing:!1},m={functional:!0,analytics:!1,marketing:!0},v=()=>{},b=()=>()=>Promise.resolve({ok:!0}),k={error:v,info:v,debug:v,throw:e=>{throw"string"==typeof e?new Error(e):e},scope:()=>k},w=(e=!1)=>({IsAlertBoxClosed:()=>e}),M={C0001:"functional",C0002:"analytics",C0003:"functional",C0004:"marketing",C0005:"marketing"},h=async e=>{var n,t,o,r,l,a,i,s;const{config:c,env:p}=e,{elb:u}=p,C=null!=(n=p.window)?n:void 0!==globalThis.window?globalThis.window:void 0,g={...M,...null!=(o=null==(t=null==c?void 0:c.settings)?void 0:t.categoryMap)?o:{}},d={};Object.entries(g).forEach(([e,n])=>{d[e.toLowerCase()]=n});const y={categoryMap:g,explicitOnly:null==(l=null==(r=null==c?void 0:c.settings)?void 0:r.explicitOnly)||l,globalName:null!=(i=null==(a=null==c?void 0:c.settings)?void 0:a.globalName)?i:"OneTrust"},O={settings:y};let f,m,v=!1;if(C){const e=null!=(s=y.globalName)?s:"OneTrust",n=new Set(Object.values(d)),t=e=>{const t={};return n.forEach(e=>{t[e]=!1}),e.split(",").filter(e=>e.length>0).forEach(e=>{const n=d[e.toLowerCase()];n&&(t[n]=!0)}),t},o=()=>{const n=C.OptanonActiveGroups;if(null==n)return;if(y.explicitOnly){const n=C[e];if((null==n?void 0:n.IsAlertBoxClosed)&&!n.IsAlertBoxClosed())return}const o=t(n);Object.keys(o).length>0&&u("walker consent",o)},r=C[e];r&&void 0!==C.OptanonActiveGroups&&o(),r||(m=C.OptanonWrapper,v=!0,C.OptanonWrapper=()=>{m&&m(),o(),C.OptanonWrapper=m,v=!1}),f=()=>{o()},C.addEventListener("OneTrustGroupsUpdated",f)}return{type:"cookiepro",config:O,push:u,destroy:async()=>{C&&f&&C.removeEventListener("OneTrustGroupsUpdated",f),C&&v&&(C.OptanonWrapper=m)}}},T=h;return l=r,((r,l,a,i)=>{if(l&&"object"==typeof l||"function"==typeof l)for(let s of t(l))o.call(r,s)||s===a||e(r,s,{get:()=>l[s],enumerable:!(i=n(l,s))||i.enumerable});return r})(e({},"__esModule",{value:!0}),l)})();

package/dist/index.d.mts

@@ -0,0 +1,251 @@
+import { Source, Elb, WalkerOS, Logger } from '@walkeros/core';
+
+/**
+ * OneTrust global API interface.
+ *
+ * Represents the subset of the OneTrust SDK we interact with.
+ * The full SDK is much larger, but we only need consent-related methods.
+ */
+interface OneTrustAPI {
+    /** Returns true if user has made an explicit consent choice */
+    IsAlertBoxClosed: () => boolean;
+    /** Register a callback for consent changes (callback receives event with detail: string[]) */
+    OnConsentChanged?: (fn: (event: {
+        detail: string[];
+    }) => void) => void;
+}
+declare global {
+    interface Window {
+        /** OneTrust SDK global object */
+        OneTrust?: OneTrustAPI;
+        /** Comma-separated string of active consent category IDs (e.g. ",C0001,C0003,") */
+        OptanonActiveGroups?: string;
+        /** OneTrust callback function, called on SDK load and consent changes */
+        OptanonWrapper?: () => void;
+        /** CookiePro legacy alias for OneTrust */
+        Optanon?: unknown;
+        [key: string]: OneTrustAPI | unknown;
+    }
+    interface WindowEventMap {
+        /** event.detail is an array of active group ID strings (e.g. ["C0001", "C0002"]) */
+        OneTrustGroupsUpdated: CustomEvent<string[]>;
+    }
+}
+/**
+ * Settings for CookiePro/OneTrust source
+ */
+interface Settings {
+    /**
+     * Map CookiePro category IDs to walkerOS consent groups.
+     * Keys: CookiePro category IDs (e.g. 'C0001', 'C0002')
+     * Values: walkerOS consent group names
+     *
+     * Comparison is case-insensitive (keys are normalized to lowercase during init).
+     *
+     * Default provides sensible mapping for standard OneTrust categories:
+     * - C0001 (Strictly Necessary) -> functional
+     * - C0002 (Performance) -> analytics
+     * - C0003 (Functional) -> functional
+     * - C0004 (Targeting) -> marketing
+     * - C0005 (Social Media) -> marketing
+     */
+    categoryMap?: Record<string, string>;
+    /**
+     * Only process explicit consent (user made a choice).
+     * When true: Checks OneTrust.IsAlertBoxClosed() -- only processes
+     * consent if user has actively interacted with the banner.
+     * When false: Processes any consent state including defaults.
+     *
+     * Default: true
+     */
+    explicitOnly?: boolean;
+    /**
+     * Custom name for window.OneTrust object.
+     * Some implementations use a different global name.
+     *
+     * Default: 'OneTrust'
+     */
+    globalName?: string;
+}
+/**
+ * User input settings (all optional)
+ */
+type InitSettings = Partial<Settings>;
+/**
+ * No mapping configuration for this source
+ */
+interface Mapping {
+}
+/**
+ * Push function type - uses elb for consent commands
+ */
+type Push = Elb.Fn;
+/**
+ * Environment interface for CookiePro source
+ */
+interface Env extends Source.BaseEnv {
+    window?: Window & typeof globalThis;
+}
+/**
+ * Types bundle for CookiePro source
+ */
+type Types = Source.Types<Settings, Mapping, Push, Env, InitSettings>;
+/**
+ * Config type alias
+ */
+type Config = Source.Config<Types>;
+
+type index_Config = Config;
+type index_Env = Env;
+type index_InitSettings = InitSettings;
+type index_Mapping = Mapping;
+type index_OneTrustAPI = OneTrustAPI;
+type index_Push = Push;
+type index_Settings = Settings;
+type index_Types = Types;
+declare namespace index {
+  export type { index_Config as Config, index_Env as Env, index_InitSettings as InitSettings, index_Mapping as Mapping, index_OneTrustAPI as OneTrustAPI, index_Push as Push, index_Settings as Settings, index_Types as Types };
+}
+
+/**
+ * Example CookiePro OptanonActiveGroups strings.
+ *
+ * These represent real consent states from CookiePro/OneTrust CMP.
+ * Format: comma-separated active category IDs with leading/trailing commas.
+ * Only active groups are listed. Absence means denied.
+ */
+/**
+ * Full consent - user accepted all categories
+ */
+declare const fullConsent = ",C0001,C0002,C0003,C0004,C0005,";
+/**
+ * Partial consent - necessary + functional only
+ */
+declare const partialConsent = ",C0001,C0003,";
+/**
+ * Minimal consent - only strictly necessary (always active)
+ */
+declare const minimalConsent = ",C0001,";
+/**
+ * Analytics only - necessary + performance
+ */
+declare const analyticsOnlyConsent = ",C0001,C0002,";
+/**
+ * Marketing only - necessary + targeting
+ */
+declare const marketingOnlyConsent = ",C0001,C0004,";
+/**
+ * Empty string - no consent yet or cleared
+ */
+declare const emptyConsent = "";
+/**
+ * Custom category IDs - some installations use custom IDs
+ */
+declare const customCategoryConsent = ",C0001,CUSTOM01,CUSTOM02,";
+
+/**
+ * Expected walkerOS consent outputs.
+ *
+ * These represent the consent state after parsing OptanonActiveGroups
+ * and mapping through the default categoryMap.
+ *
+ * Default map:
+ * - C0001 -> functional
+ * - C0002 -> analytics
+ * - C0003 -> functional
+ * - C0004 -> marketing
+ * - C0005 -> marketing
+ *
+ * All mapped walkerOS groups get explicit true/false values.
+ * Active groups -> true, absent groups -> false.
+ */
+/**
+ * Full consent mapped to walkerOS groups
+ */
+declare const fullConsentMapped: WalkerOS.Consent;
+/**
+ * Partial consent - necessary + functional mapped
+ * C0001 -> functional (true), C0003 -> functional (true)
+ * analytics and marketing absent -> false
+ */
+declare const partialConsentMapped: WalkerOS.Consent;
+/**
+ * Minimal consent - only strictly necessary
+ * C0001 -> functional (true)
+ * analytics and marketing absent -> false
+ */
+declare const minimalConsentMapped: WalkerOS.Consent;
+/**
+ * Analytics only - necessary + performance
+ * C0001 -> functional (true), C0002 -> analytics (true)
+ * marketing absent -> false
+ */
+declare const analyticsOnlyMapped: WalkerOS.Consent;
+/**
+ * Marketing only - necessary + targeting
+ * C0001 -> functional (true), C0004 -> marketing (true)
+ * analytics absent -> false
+ */
+declare const marketingOnlyMapped: WalkerOS.Consent;
+
+/**
+ * Create a properly typed elb/push function mock
+ */
+declare const createMockElbFn: () => Elb.Fn;
+/**
+ * Simple no-op logger for demo purposes
+ */
+declare const noopLogger: Logger.Instance;
+/**
+ * Create a mock OneTrust API object
+ */
+declare const createMockOneTrustAPI: (isAlertBoxClosed?: boolean) => OneTrustAPI;
+
+/**
+ * Default category mapping from CookiePro/OneTrust to walkerOS consent groups.
+ *
+ * Keys use OneTrust's standard uppercase IDs (as shown in CookiePro dashboard).
+ * Lookups are case-insensitive (normalized during init).
+ *
+ * Maps OneTrust's standard category IDs to walkerOS convention:
+ * - C0001 (Strictly Necessary) -> functional
+ * - C0002 (Performance) -> analytics
+ * - C0003 (Functional) -> functional
+ * - C0004 (Targeting) -> marketing
+ * - C0005 (Social Media) -> marketing
+ */
+declare const DEFAULT_CATEGORY_MAP: Record<string, string>;
+/**
+ * CookiePro/OneTrust consent management source for walkerOS.
+ *
+ * This source listens to CookiePro/OneTrust CMP events and translates
+ * consent states to walkerOS consent commands.
+ *
+ * Three detection paths:
+ * 1. Already loaded: window.OneTrust + window.OptanonActiveGroups
+ * 2. Init: Wraps OptanonWrapper (preserves existing)
+ * 3. Change: OneTrustGroupsUpdated window event
+ *
+ * @example
+ * ```typescript
+ * import { sourceCookiePro } from '@walkeros/web-source-cmp-cookiepro';
+ *
+ * await startFlow({
+ *   sources: {
+ *     consent: {
+ *       code: sourceCookiePro,
+ *       config: {
+ *         settings: {
+ *           categoryMap: {
+ *             C0002: 'statistics', // Custom mapping
+ *           },
+ *         },
+ *       },
+ *     },
+ *   },
+ * });
+ * ```
+ */
+declare const sourceCookiePro: Source.Init<Types>;
+
+export { DEFAULT_CATEGORY_MAP, index as SourceCookiePro, analyticsOnlyConsent, analyticsOnlyMapped, createMockElbFn, createMockOneTrustAPI, customCategoryConsent, sourceCookiePro as default, emptyConsent, fullConsent, fullConsentMapped, marketingOnlyConsent, marketingOnlyMapped, minimalConsent, minimalConsentMapped, noopLogger, partialConsent, partialConsentMapped, sourceCookiePro };