@walkeros/web-source-cmp-usercentrics 0.1.0

package/dist/examples/index.js

@@ -0,0 +1,178 @@
+"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, {
+  createMockElbFn: () => createMockElbFn,
+  fullConsent: () => fullConsent,
+  fullConsentCustomMapped: () => fullConsentCustomMapped,
+  fullConsentMapped: () => fullConsentMapped,
+  fullConsentUpperCase: () => fullConsentUpperCase,
+  implicitConsent: () => implicitConsent,
+  minimalConsent: () => minimalConsent,
+  minimalConsentMapped: () => minimalConsentMapped,
+  nonConsentEvent: () => nonConsentEvent,
+  noopLogger: () => noopLogger,
+  partialConsent: () => partialConsent,
+  partialConsentMapped: () => partialConsentMapped,
+  serviceLevelConsent: () => serviceLevelConsent,
+  serviceLevelMapped: () => serviceLevelMapped
+});
+module.exports = __toCommonJS(examples_exports);
+
+// src/examples/inputs.ts
+var fullConsent = {
+  event: "consent_status",
+  type: "explicit",
+  action: "onAcceptAllServices",
+  ucCategory: {
+    essential: true,
+    functional: true,
+    marketing: true
+  },
+  "Google Analytics": true,
+  "Google Ads Remarketing": true
+};
+var partialConsent = {
+  event: "consent_status",
+  type: "explicit",
+  action: "onUpdateServices",
+  ucCategory: {
+    essential: true,
+    functional: true,
+    marketing: false
+  },
+  "Google Analytics": true,
+  "Google Ads Remarketing": false
+};
+var minimalConsent = {
+  event: "consent_status",
+  type: "explicit",
+  action: "onDenyAllServices",
+  ucCategory: {
+    essential: true,
+    functional: false,
+    marketing: false
+  },
+  "Google Analytics": false,
+  "Google Ads Remarketing": false
+};
+var implicitConsent = {
+  event: "consent_status",
+  type: "implicit",
+  ucCategory: {
+    essential: true,
+    functional: false,
+    marketing: false
+  },
+  "Google Analytics": false,
+  "Google Ads Remarketing": false
+};
+var fullConsentUpperCase = {
+  event: "consent_status",
+  type: "EXPLICIT",
+  action: "onAcceptAllServices",
+  ucCategory: {
+    essential: true,
+    functional: true,
+    marketing: true
+  }
+};
+var serviceLevelConsent = {
+  event: "consent_status",
+  type: "explicit",
+  action: "onUpdateServices",
+  ucCategory: {
+    essential: true,
+    functional: "partial",
+    // Non-boolean indicates mixed service choices
+    marketing: "partial"
+  },
+  "Google Analytics": true,
+  "Google Ads Remarketing": false,
+  Hotjar: true
+};
+var nonConsentEvent = {
+  event: "other_event",
+  type: "explicit"
+};
+
+// src/examples/outputs.ts
+var fullConsentMapped = {
+  essential: true,
+  functional: true,
+  marketing: true
+};
+var partialConsentMapped = {
+  essential: true,
+  functional: true,
+  marketing: false
+};
+var minimalConsentMapped = {
+  essential: true,
+  functional: false,
+  marketing: false
+};
+var fullConsentCustomMapped = {
+  functional: true,
+  marketing: true
+};
+var serviceLevelMapped = {
+  essential: true,
+  google_analytics: true,
+  google_ads_remarketing: false,
+  hotjar: 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
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createMockElbFn,
+  fullConsent,
+  fullConsentCustomMapped,
+  fullConsentMapped,
+  fullConsentUpperCase,
+  implicitConsent,
+  minimalConsent,
+  minimalConsentMapped,
+  nonConsentEvent,
+  noopLogger,
+  partialConsent,
+  partialConsentMapped,
+  serviceLevelConsent,
+  serviceLevelMapped
+});

package/dist/examples/index.mjs

@@ -0,0 +1,138 @@
+// src/examples/inputs.ts
+var fullConsent = {
+  event: "consent_status",
+  type: "explicit",
+  action: "onAcceptAllServices",
+  ucCategory: {
+    essential: true,
+    functional: true,
+    marketing: true
+  },
+  "Google Analytics": true,
+  "Google Ads Remarketing": true
+};
+var partialConsent = {
+  event: "consent_status",
+  type: "explicit",
+  action: "onUpdateServices",
+  ucCategory: {
+    essential: true,
+    functional: true,
+    marketing: false
+  },
+  "Google Analytics": true,
+  "Google Ads Remarketing": false
+};
+var minimalConsent = {
+  event: "consent_status",
+  type: "explicit",
+  action: "onDenyAllServices",
+  ucCategory: {
+    essential: true,
+    functional: false,
+    marketing: false
+  },
+  "Google Analytics": false,
+  "Google Ads Remarketing": false
+};
+var implicitConsent = {
+  event: "consent_status",
+  type: "implicit",
+  ucCategory: {
+    essential: true,
+    functional: false,
+    marketing: false
+  },
+  "Google Analytics": false,
+  "Google Ads Remarketing": false
+};
+var fullConsentUpperCase = {
+  event: "consent_status",
+  type: "EXPLICIT",
+  action: "onAcceptAllServices",
+  ucCategory: {
+    essential: true,
+    functional: true,
+    marketing: true
+  }
+};
+var serviceLevelConsent = {
+  event: "consent_status",
+  type: "explicit",
+  action: "onUpdateServices",
+  ucCategory: {
+    essential: true,
+    functional: "partial",
+    // Non-boolean indicates mixed service choices
+    marketing: "partial"
+  },
+  "Google Analytics": true,
+  "Google Ads Remarketing": false,
+  Hotjar: true
+};
+var nonConsentEvent = {
+  event: "other_event",
+  type: "explicit"
+};
+
+// src/examples/outputs.ts
+var fullConsentMapped = {
+  essential: true,
+  functional: true,
+  marketing: true
+};
+var partialConsentMapped = {
+  essential: true,
+  functional: true,
+  marketing: false
+};
+var minimalConsentMapped = {
+  essential: true,
+  functional: false,
+  marketing: false
+};
+var fullConsentCustomMapped = {
+  functional: true,
+  marketing: true
+};
+var serviceLevelMapped = {
+  essential: true,
+  google_analytics: true,
+  google_ads_remarketing: false,
+  hotjar: 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
+};
+export {
+  createMockElbFn,
+  fullConsent,
+  fullConsentCustomMapped,
+  fullConsentMapped,
+  fullConsentUpperCase,
+  implicitConsent,
+  minimalConsent,
+  minimalConsentMapped,
+  nonConsentEvent,
+  noopLogger,
+  partialConsent,
+  partialConsentMapped,
+  serviceLevelConsent,
+  serviceLevelMapped
+};

package/dist/index.browser.js

@@ -0,0 +1 @@
+"use strict";var SourceUsercentrics=(()=>{var e=Object.defineProperty,t=Object.getOwnPropertyDescriptor,n=Object.getOwnPropertyNames,o=Object.prototype.hasOwnProperty,a={};((t,n)=>{for(var o in n)e(t,o,{get:n[o],enumerable:!0})})(a,{SourceUsercentrics:()=>l,createMockElbFn:()=>k,default:()=>_,fullConsent:()=>r,fullConsentCustomMapped:()=>m,fullConsentMapped:()=>y,fullConsentUpperCase:()=>g,implicitConsent:()=>u,minimalConsent:()=>c,minimalConsentMapped:()=>d,nonConsentEvent:()=>v,noopLogger:()=>w,partialConsent:()=>s,partialConsentMapped:()=>f,serviceLevelConsent:()=>p,serviceLevelMapped:()=>C,sourceUsercentrics:()=>O});var i,l={},r={event:"consent_status",type:"explicit",action:"onAcceptAllServices",ucCategory:{essential:!0,functional:!0,marketing:!0},"Google Analytics":!0,"Google Ads Remarketing":!0},s={event:"consent_status",type:"explicit",action:"onUpdateServices",ucCategory:{essential:!0,functional:!0,marketing:!1},"Google Analytics":!0,"Google Ads Remarketing":!1},c={event:"consent_status",type:"explicit",action:"onDenyAllServices",ucCategory:{essential:!0,functional:!1,marketing:!1},"Google Analytics":!1,"Google Ads Remarketing":!1},u={event:"consent_status",type:"implicit",ucCategory:{essential:!0,functional:!1,marketing:!1},"Google Analytics":!1,"Google Ads Remarketing":!1},g={event:"consent_status",type:"EXPLICIT",action:"onAcceptAllServices",ucCategory:{essential:!0,functional:!0,marketing:!0}},p={event:"consent_status",type:"explicit",action:"onUpdateServices",ucCategory:{essential:!0,functional:"partial",marketing:"partial"},"Google Analytics":!0,"Google Ads Remarketing":!1,Hotjar:!0},v={event:"other_event",type:"explicit"},y={essential:!0,functional:!0,marketing:!0},f={essential:!0,functional:!0,marketing:!1},d={essential:!0,functional:!1,marketing:!1},m={functional:!0,marketing:!0},C={essential:!0,google_analytics:!0,google_ads_remarketing:!1,hotjar:!0},b=()=>{},k=()=>()=>Promise.resolve({ok:!0}),w={error:b,info:b,debug:b,throw:e=>{throw"string"==typeof e?new Error(e):e},scope:()=>w},A=["action","event","type","ucCategory"],O=async e=>{var t,n,o,a,i,l,r,s;const{config:c,env:u}=e,{elb:g}=u,p=null!=(t=u.window)?t:void 0!==globalThis.window?globalThis.window:void 0,v={eventName:null!=(o=null==(n=null==c?void 0:c.settings)?void 0:n.eventName)?o:"ucEvent",categoryMap:null!=(i=null==(a=null==c?void 0:c.settings)?void 0:a.categoryMap)?i:{},explicitOnly:null==(r=null==(l=null==c?void 0:c.settings)?void 0:l.explicitOnly)||r},y={settings:v};let f;if(p){const e=e=>Object.values(e).every(e=>"boolean"==typeof e),t=t=>{const n={};return t.ucCategory&&e(t.ucCategory)?Object.entries(t.ucCategory).forEach(([e,t])=>{var o,a;if("boolean"!=typeof t)return;const i=null!=(a=null==(o=v.categoryMap)?void 0:o[e])?a:e;n[i]=n[i]||t}):(t.ucCategory&&Object.entries(t.ucCategory).forEach(([e,t])=>{var o,a;if("boolean"==typeof t){const i=null!=(a=null==(o=v.categoryMap)?void 0:o[e])?a:e;n[i]=n[i]||t}}),Object.entries(t).forEach(([e,t])=>{if(A.includes(e))return;if("boolean"!=typeof t)return;const o=e.toLowerCase().replace(/ /g,"_");n[o]=t})),n},n=e=>{var n;if("consent_status"!==e.event)return;if(v.explicitOnly&&"explicit"!==(null==(n=e.type)?void 0:n.toLowerCase()))return;const o=t(e);Object.keys(o).length>0&&g("walker consent",o)},o=null!=(s=v.eventName)?s:"ucEvent";f=e=>{const t=e;t.detail&&n(t.detail)},p.addEventListener(o,f)}return{type:"usercentrics",config:y,push:g,destroy:async()=>{var e;if(p&&f){const t=null!=(e=v.eventName)?e:"ucEvent";p.removeEventListener(t,f)}}}},_=O;return i=a,((a,i,l,r)=>{if(i&&"object"==typeof i||"function"==typeof i)for(let s of n(i))o.call(a,s)||s===l||e(a,s,{get:()=>i[s],enumerable:!(r=t(i,s))||r.enumerable});return a})(e({},"__esModule",{value:!0}),i)})();

package/dist/index.d.mts

@@ -0,0 +1,206 @@
+import { Source, Elb, WalkerOS, Logger } from '@walkeros/core';
+
+/**
+ * Usercentrics consent event detail structure.
+ *
+ * Fired as event.detail on the configured window event (e.g. 'ucEvent').
+ * Contains both category-level (ucCategory) and service-level consent.
+ */
+interface UsercentricsEventDetail {
+    /** Always 'consent_status' for consent events */
+    event: string;
+    /** 'explicit' when user actively chose, 'implicit' for page-load defaults (casing may vary) */
+    type: string;
+    /** Action taken: 'onAcceptAllServices', 'onDenyAllServices', 'onUpdateServices' */
+    action?: string;
+    /** Category-level consent booleans (e.g. { marketing: true, functional: false }) */
+    ucCategory?: Record<string, boolean | unknown>;
+    /** Service-level consent as top-level keys (e.g. 'Google Analytics': true) */
+    [service: string]: unknown;
+}
+declare global {
+    interface WindowEventMap {
+        ucEvent: CustomEvent<UsercentricsEventDetail>;
+    }
+}
+/**
+ * Settings for Usercentrics source
+ */
+interface Settings {
+    /**
+     * Window event name to listen for.
+     * Configured in Usercentrics admin under Implementation > Data Layer & Events.
+     * Can also be set to 'UC_SDK_EVENT' for the built-in Browser SDK event.
+     *
+     * Default: 'ucEvent'
+     */
+    eventName?: string;
+    /**
+     * Map Usercentrics categories to walkerOS consent groups.
+     * Keys: Usercentrics category names (from ucCategory)
+     * Values: walkerOS consent group names
+     *
+     * Applied in both group-level and service-level consent modes.
+     * When multiple source categories map to the same group, OR logic applies:
+     * if ANY source category is true, the target group is true.
+     *
+     * Default: {} (pass through category names as-is)
+     */
+    categoryMap?: Record<string, string>;
+    /**
+     * Only process explicit consent (user made a choice).
+     * When true: Ignores events where type !== 'explicit'
+     * When false: Processes any consent_status event including implicit/defaults
+     *
+     * Default: true
+     */
+    explicitOnly?: boolean;
+}
+/**
+ * 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 Usercentrics source
+ */
+interface Env extends Source.BaseEnv {
+    window?: Window & typeof globalThis;
+}
+/**
+ * Types bundle for Usercentrics 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_Push = Push;
+type index_Settings = Settings;
+type index_Types = Types;
+type index_UsercentricsEventDetail = UsercentricsEventDetail;
+declare namespace index {
+  export type { index_Config as Config, index_Env as Env, index_InitSettings as InitSettings, index_Mapping as Mapping, index_Push as Push, index_Settings as Settings, index_Types as Types, index_UsercentricsEventDetail as UsercentricsEventDetail };
+}
+
+/**
+ * Example Usercentrics consent event detail inputs.
+ *
+ * These represent real event.detail payloads from Usercentrics CMP.
+ */
+/**
+ * Full consent - user accepted all categories (explicit)
+ */
+declare const fullConsent: UsercentricsEventDetail;
+/**
+ * Partial consent - user accepted only essential and functional (explicit)
+ */
+declare const partialConsent: UsercentricsEventDetail;
+/**
+ * Minimal consent - user denied everything except essential (explicit)
+ */
+declare const minimalConsent: UsercentricsEventDetail;
+/**
+ * Implicit consent - page load with default consent state
+ * (not an explicit user choice)
+ */
+declare const implicitConsent: UsercentricsEventDetail;
+/**
+ * Explicit consent with uppercase type field (Usercentrics docs are
+ * inconsistent about casing - some show 'EXPLICIT', others 'explicit')
+ */
+declare const fullConsentUpperCase: UsercentricsEventDetail;
+/**
+ * Service-level consent - ucCategory has mixed types (non-boolean values
+ * indicate individual service-level choice rather than group-level)
+ */
+declare const serviceLevelConsent: UsercentricsEventDetail;
+/**
+ * Non-consent event (should be ignored)
+ */
+declare const nonConsentEvent: UsercentricsEventDetail;
+
+/**
+ * Expected walkerOS consent outputs.
+ *
+ * These represent the consent state after parsing Usercentrics event details
+ * with no category mapping configured (pass-through).
+ */
+/**
+ * Full consent - all categories true (group-level)
+ */
+declare const fullConsentMapped: WalkerOS.Consent;
+/**
+ * Partial consent - essential and functional true, marketing false
+ */
+declare const partialConsentMapped: WalkerOS.Consent;
+/**
+ * Minimal consent - only essential true
+ */
+declare const minimalConsentMapped: WalkerOS.Consent;
+/**
+ * Full consent with custom category mapping applied
+ * (essential->functional, functional->functional, marketing->marketing)
+ */
+declare const fullConsentCustomMapped: WalkerOS.Consent;
+/**
+ * Service-level consent - individual service booleans + boolean ucCategory entries
+ * (services normalized: lowercase, spaces to underscores)
+ * (ucCategory boolean entries mapped through categoryMap)
+ */
+declare const serviceLevelMapped: 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;
+
+/**
+ * Usercentrics consent management source for walkerOS.
+ *
+ * This source listens to Usercentrics CMP events and translates
+ * consent states to walkerOS consent commands.
+ *
+ * @example
+ * ```typescript
+ * import { sourceUsercentrics } from '@walkeros/web-source-cmp-usercentrics';
+ *
+ * await startFlow({
+ *   sources: {
+ *     consent: {
+ *       code: sourceUsercentrics,
+ *       config: {
+ *         settings: {
+ *           eventName: 'ucEvent',
+ *           categoryMap: {
+ *             essential: 'functional',
+ *             functional: 'functional',
+ *             marketing: 'marketing',
+ *           },
+ *         },
+ *       },
+ *     },
+ *   },
+ * });
+ * ```
+ */
+declare const sourceUsercentrics: Source.Init<Types>;
+
+export { index as SourceUsercentrics, createMockElbFn, sourceUsercentrics as default, fullConsent, fullConsentCustomMapped, fullConsentMapped, fullConsentUpperCase, implicitConsent, minimalConsent, minimalConsentMapped, nonConsentEvent, noopLogger, partialConsent, partialConsentMapped, serviceLevelConsent, serviceLevelMapped, sourceUsercentrics };