@walkeros/web-source-cmp-cookiefirst 1.1.0-next-1771252576264

package/dist/examples/index.d.ts

@@ -0,0 +1,125 @@
+import { WalkerOS, Elb, Logger, Source } from '@walkeros/core';
+
+/**
+ * CookieFirst consent object structure
+ */
+interface CookieFirstConsent {
+    necessary?: boolean;
+    functional?: boolean;
+    performance?: boolean;
+    advertising?: boolean;
+    [category: string]: boolean | undefined;
+}
+/**
+ * CookieFirst global API interface
+ */
+interface CookieFirstAPI {
+    consent: CookieFirstConsent | null;
+}
+declare global {
+    interface Window {
+        CookieFirst?: CookieFirstAPI;
+        [key: string]: CookieFirstAPI | unknown;
+    }
+    interface WindowEventMap {
+        cf_init: Event;
+        cf_consent: CustomEvent<CookieFirstConsent>;
+    }
+}
+
+/**
+ * Example CookieFirst consent inputs.
+ *
+ * These represent real consent states from CookieFirst CMP.
+ */
+/**
+ * Full consent - user accepted all categories
+ */
+declare const fullConsent: CookieFirstConsent;
+/**
+ * Partial consent - user accepted only necessary and functional
+ */
+declare const partialConsent: CookieFirstConsent;
+/**
+ * Minimal consent - user accepted only necessary (required)
+ */
+declare const minimalConsent: CookieFirstConsent;
+/**
+ * No consent - user hasn't made a choice yet
+ * CookieFirst returns null when no explicit choice has been made
+ */
+declare const noConsent: CookieFirstConsent | null;
+/**
+ * Analytics only - user accepted performance tracking
+ */
+declare const analyticsOnlyConsent: CookieFirstConsent;
+/**
+ * Marketing only - user accepted advertising
+ */
+declare const marketingOnlyConsent: CookieFirstConsent;
+
+/**
+ * Expected walkerOS consent outputs.
+ *
+ * These represent the consent state after mapping CookieFirst categories
+ * to walkerOS consent groups using the default category map.
+ */
+/**
+ * Full consent mapped to walkerOS groups
+ * (necessary + functional → functional, performance → analytics, advertising → marketing)
+ */
+declare const fullConsentMapped: WalkerOS.Consent;
+/**
+ * Partial consent mapped to walkerOS groups
+ */
+declare const partialConsentMapped: WalkerOS.Consent;
+/**
+ * Minimal consent mapped to walkerOS groups
+ */
+declare const minimalConsentMapped: WalkerOS.Consent;
+/**
+ * Analytics only consent mapped to walkerOS groups
+ * Note: functional is true because necessary=true maps to functional
+ * (OR logic: if ANY source category is true, target group is true)
+ */
+declare const analyticsOnlyMapped: WalkerOS.Consent;
+/**
+ * Marketing only consent mapped to walkerOS groups
+ * Note: functional is true because necessary=true maps to functional
+ * (OR logic: if ANY source category is true, target group is true)
+ */
+declare const marketingOnlyMapped: WalkerOS.Consent;
+
+/**
+ * Create a properly typed elb/push function mock that returns a promise with PushResult
+ */
+declare const createMockElbFn: () => Elb.Fn;
+/**
+ * Simple no-op logger for demo purposes
+ */
+declare const noopLogger: Logger.Instance;
+/**
+ * Environment interface for CookieFirst source
+ */
+interface CookieFirstEnv extends Source.BaseEnv {
+    window?: typeof window;
+}
+/**
+ * Create a mock CookieFirst API object
+ */
+declare const createMockCookieFirstAPI: (consent?: CookieFirstConsent | null) => CookieFirstAPI;
+/**
+ * Create a mock window object with CookieFirst
+ */
+declare const createMockWindow: (consent?: CookieFirstConsent | null) => Partial<Window> & {
+    CookieFirst: CookieFirstAPI;
+};
+/**
+ * Standard mock environment for testing CookieFirst source
+ *
+ * Use this for testing consent handling without requiring
+ * a real browser environment.
+ */
+declare const mockEnv: CookieFirstEnv;
+
+export { analyticsOnlyConsent, analyticsOnlyMapped, createMockCookieFirstAPI, createMockElbFn, createMockWindow, fullConsent, fullConsentMapped, marketingOnlyConsent, marketingOnlyMapped, minimalConsent, minimalConsentMapped, mockEnv, noConsent, noopLogger, partialConsent, partialConsentMapped };

package/dist/examples/index.js

@@ -0,0 +1,161 @@
+"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,
+  createMockCookieFirstAPI: () => createMockCookieFirstAPI,
+  createMockElbFn: () => createMockElbFn,
+  createMockWindow: () => createMockWindow,
+  fullConsent: () => fullConsent,
+  fullConsentMapped: () => fullConsentMapped,
+  marketingOnlyConsent: () => marketingOnlyConsent,
+  marketingOnlyMapped: () => marketingOnlyMapped,
+  minimalConsent: () => minimalConsent,
+  minimalConsentMapped: () => minimalConsentMapped,
+  mockEnv: () => mockEnv,
+  noConsent: () => noConsent,
+  noopLogger: () => noopLogger,
+  partialConsent: () => partialConsent,
+  partialConsentMapped: () => partialConsentMapped
+});
+module.exports = __toCommonJS(examples_exports);
+
+// src/examples/inputs.ts
+var fullConsent = {
+  necessary: true,
+  functional: true,
+  performance: true,
+  advertising: true
+};
+var partialConsent = {
+  necessary: true,
+  functional: true,
+  performance: false,
+  advertising: false
+};
+var minimalConsent = {
+  necessary: true,
+  functional: false,
+  performance: false,
+  advertising: false
+};
+var noConsent = null;
+var analyticsOnlyConsent = {
+  necessary: true,
+  functional: false,
+  performance: true,
+  advertising: false
+};
+var marketingOnlyConsent = {
+  necessary: true,
+  functional: false,
+  performance: false,
+  advertising: true
+};
+
+// 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 createMockCookieFirstAPI = (consent = null) => ({
+  consent
+});
+var createMockWindow = (consent = null) => ({
+  CookieFirst: createMockCookieFirstAPI(consent),
+  addEventListener: noop,
+  removeEventListener: noop
+});
+var mockEnv = {
+  get push() {
+    return createMockElbFn();
+  },
+  get command() {
+    return createMockElbFn();
+  },
+  get elb() {
+    return createMockElbFn();
+  },
+  get window() {
+    return createMockWindow();
+  },
+  logger: noopLogger
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  analyticsOnlyConsent,
+  analyticsOnlyMapped,
+  createMockCookieFirstAPI,
+  createMockElbFn,
+  createMockWindow,
+  fullConsent,
+  fullConsentMapped,
+  marketingOnlyConsent,
+  marketingOnlyMapped,
+  minimalConsent,
+  minimalConsentMapped,
+  mockEnv,
+  noConsent,
+  noopLogger,
+  partialConsent,
+  partialConsentMapped
+});

package/dist/examples/index.mjs

@@ -0,0 +1,119 @@
+// src/examples/inputs.ts
+var fullConsent = {
+  necessary: true,
+  functional: true,
+  performance: true,
+  advertising: true
+};
+var partialConsent = {
+  necessary: true,
+  functional: true,
+  performance: false,
+  advertising: false
+};
+var minimalConsent = {
+  necessary: true,
+  functional: false,
+  performance: false,
+  advertising: false
+};
+var noConsent = null;
+var analyticsOnlyConsent = {
+  necessary: true,
+  functional: false,
+  performance: true,
+  advertising: false
+};
+var marketingOnlyConsent = {
+  necessary: true,
+  functional: false,
+  performance: false,
+  advertising: true
+};
+
+// 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 createMockCookieFirstAPI = (consent = null) => ({
+  consent
+});
+var createMockWindow = (consent = null) => ({
+  CookieFirst: createMockCookieFirstAPI(consent),
+  addEventListener: noop,
+  removeEventListener: noop
+});
+var mockEnv = {
+  get push() {
+    return createMockElbFn();
+  },
+  get command() {
+    return createMockElbFn();
+  },
+  get elb() {
+    return createMockElbFn();
+  },
+  get window() {
+    return createMockWindow();
+  },
+  logger: noopLogger
+};
+export {
+  analyticsOnlyConsent,
+  analyticsOnlyMapped,
+  createMockCookieFirstAPI,
+  createMockElbFn,
+  createMockWindow,
+  fullConsent,
+  fullConsentMapped,
+  marketingOnlyConsent,
+  marketingOnlyMapped,
+  minimalConsent,
+  minimalConsentMapped,
+  mockEnv,
+  noConsent,
+  noopLogger,
+  partialConsent,
+  partialConsentMapped
+};

package/dist/index.browser.js

@@ -0,0 +1 @@
+"use strict";var SourceCookieFirst=(()=>{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:()=>E,SourceCookieFirst:()=>a,analyticsOnlyConsent:()=>f,analyticsOnlyMapped:()=>v,createMockCookieFirstAPI:()=>O,createMockElbFn:()=>b,createMockWindow:()=>w,default:()=>F,fullConsent:()=>l,fullConsentMapped:()=>d,marketingOnlyConsent:()=>g,marketingOnlyMapped:()=>m,minimalConsent:()=>c,minimalConsentMapped:()=>y,mockEnv:()=>M,noConsent:()=>u,noopLogger:()=>C,partialConsent:()=>s,partialConsentMapped:()=>p,sourceCookieFirst:()=>h});var i,a={},l={necessary:!0,functional:!0,performance:!0,advertising:!0},s={necessary:!0,functional:!0,performance:!1,advertising:!1},c={necessary:!0,functional:!1,performance:!1,advertising:!1},u=null,f={necessary:!0,functional:!1,performance:!0,advertising:!1},g={necessary:!0,functional:!1,performance:!1,advertising:!0},d={functional:!0,analytics:!0,marketing:!0},p={functional:!0,analytics:!1,marketing:!1},y={functional:!0,analytics:!1,marketing:!1},v={functional:!0,analytics:!0,marketing:!1},m={functional:!0,analytics:!1,marketing:!0},k=()=>{},b=()=>()=>Promise.resolve({ok:!0}),C={error:k,info:k,debug:k,throw:e=>{throw"string"==typeof e?new Error(e):e},scope:()=>C},O=(e=null)=>({consent:e}),w=(e=null)=>({CookieFirst:O(e),addEventListener:k,removeEventListener:k}),M={get push(){return b()},get command(){return b()},get elb(){return b()},get window(){return w()},logger:C},E={necessary:"functional",functional:"functional",performance:"analytics",advertising:"marketing"},h=async e=>{var n,t,o,r,i,a,l;const{config:s,env:c}=e,{elb:u}=c,f=null!=(n=c.window)?n:void 0!==globalThis.window?globalThis.window:void 0,g={categoryMap:{...E,...null==(t=null==s?void 0:s.settings)?void 0:t.categoryMap},explicitOnly:null==(r=null==(o=null==s?void 0:s.settings)?void 0:o.explicitOnly)||r,globalName:null!=(a=null==(i=null==s?void 0:s.settings)?void 0:i.globalName)?a:"CookieFirst"},d={settings:g};let p,y;if(f){const e=e=>{if(g.explicitOnly&&!e)return;if(!e)return;const n={};Object.entries(e).forEach(([e,t])=>{var o,r;if("boolean"!=typeof t)return;const i=null!=(r=null==(o=g.categoryMap)?void 0:o[e])?r:e;n[i]=n[i]||t}),Object.keys(n).length>0&&u("walker consent",n)},n=null!=(l=g.globalName)?l:"CookieFirst",t=f[n];(null==t?void 0:t.consent)&&e(t.consent),p=()=>{var t;const o=f[n];e(null!=(t=null==o?void 0:o.consent)?t:null)},f.addEventListener("cf_init",p),y=n=>{e(n.detail)},f.addEventListener("cf_consent",y)}return{type:"cookiefirst",config:d,push:u,destroy:async()=>{f&&p&&f.removeEventListener("cf_init",p),f&&y&&f.removeEventListener("cf_consent",y)}}},F=h;return i=r,((r,i,a,l)=>{if(i&&"object"==typeof i||"function"==typeof i)for(let s of t(i))o.call(r,s)||s===a||e(r,s,{get:()=>i[s],enumerable:!(l=n(i,s))||l.enumerable});return r})(e({},"__esModule",{value:!0}),i)})();

package/dist/index.d.mts

@@ -0,0 +1,234 @@
+import { Source, Elb, WalkerOS, Logger } from '@walkeros/core';
+
+/**
+ * CookieFirst consent object structure
+ */
+interface CookieFirstConsent {
+    necessary?: boolean;
+    functional?: boolean;
+    performance?: boolean;
+    advertising?: boolean;
+    [category: string]: boolean | undefined;
+}
+/**
+ * CookieFirst global API interface
+ */
+interface CookieFirstAPI {
+    consent: CookieFirstConsent | null;
+}
+declare global {
+    interface Window {
+        CookieFirst?: CookieFirstAPI;
+        [key: string]: CookieFirstAPI | unknown;
+    }
+    interface WindowEventMap {
+        cf_init: Event;
+        cf_consent: CustomEvent<CookieFirstConsent>;
+    }
+}
+/**
+ * Settings for CookieFirst source
+ */
+interface Settings {
+    /**
+     * Map CookieFirst categories to walkerOS consent groups.
+     * Keys: CookieFirst category names
+     * Values: walkerOS consent group names
+     *
+     * Default maps to standard walkerOS groups:
+     * - necessary → functional
+     * - functional → functional
+     * - performance → analytics
+     * - advertising → marketing
+     */
+    categoryMap?: Record<string, string>;
+    /**
+     * Only process explicit consent (user made a choice).
+     * When true: Ignores consent if CookieFirst.consent is null
+     * When false: Processes any consent state including defaults
+     *
+     * Default: true
+     */
+    explicitOnly?: boolean;
+    /**
+     * Custom name for window.CookieFirst object.
+     * Some implementations use a different global name.
+     *
+     * Default: 'CookieFirst'
+     */
+    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 CookieFirst source
+ */
+interface Env extends Source.BaseEnv {
+    window?: Window & typeof globalThis;
+}
+/**
+ * Types bundle for CookieFirst source
+ */
+type Types = Source.Types<Settings, Mapping, Push, Env, InitSettings>;
+/**
+ * Config type alias
+ */
+type Config = Source.Config<Types>;
+
+type index_Config = Config;
+type index_CookieFirstAPI = CookieFirstAPI;
+type index_CookieFirstConsent = CookieFirstConsent;
+type index_Env = Env;
+type index_InitSettings = InitSettings;
+type index_Mapping = Mapping;
+type index_Push = Push;
+type index_Settings = Settings;
+type index_Types = Types;
+declare namespace index {
+  export type { index_Config as Config, index_CookieFirstAPI as CookieFirstAPI, index_CookieFirstConsent as CookieFirstConsent, index_Env as Env, index_InitSettings as InitSettings, index_Mapping as Mapping, index_Push as Push, index_Settings as Settings, index_Types as Types };
+}
+
+/**
+ * Example CookieFirst consent inputs.
+ *
+ * These represent real consent states from CookieFirst CMP.
+ */
+/**
+ * Full consent - user accepted all categories
+ */
+declare const fullConsent: CookieFirstConsent;
+/**
+ * Partial consent - user accepted only necessary and functional
+ */
+declare const partialConsent: CookieFirstConsent;
+/**
+ * Minimal consent - user accepted only necessary (required)
+ */
+declare const minimalConsent: CookieFirstConsent;
+/**
+ * No consent - user hasn't made a choice yet
+ * CookieFirst returns null when no explicit choice has been made
+ */
+declare const noConsent: CookieFirstConsent | null;
+/**
+ * Analytics only - user accepted performance tracking
+ */
+declare const analyticsOnlyConsent: CookieFirstConsent;
+/**
+ * Marketing only - user accepted advertising
+ */
+declare const marketingOnlyConsent: CookieFirstConsent;
+
+/**
+ * Expected walkerOS consent outputs.
+ *
+ * These represent the consent state after mapping CookieFirst categories
+ * to walkerOS consent groups using the default category map.
+ */
+/**
+ * Full consent mapped to walkerOS groups
+ * (necessary + functional → functional, performance → analytics, advertising → marketing)
+ */
+declare const fullConsentMapped: WalkerOS.Consent;
+/**
+ * Partial consent mapped to walkerOS groups
+ */
+declare const partialConsentMapped: WalkerOS.Consent;
+/**
+ * Minimal consent mapped to walkerOS groups
+ */
+declare const minimalConsentMapped: WalkerOS.Consent;
+/**
+ * Analytics only consent mapped to walkerOS groups
+ * Note: functional is true because necessary=true maps to functional
+ * (OR logic: if ANY source category is true, target group is true)
+ */
+declare const analyticsOnlyMapped: WalkerOS.Consent;
+/**
+ * Marketing only consent mapped to walkerOS groups
+ * Note: functional is true because necessary=true maps to functional
+ * (OR logic: if ANY source category is true, target group is true)
+ */
+declare const marketingOnlyMapped: WalkerOS.Consent;
+
+/**
+ * Create a properly typed elb/push function mock that returns a promise with PushResult
+ */
+declare const createMockElbFn: () => Elb.Fn;
+/**
+ * Simple no-op logger for demo purposes
+ */
+declare const noopLogger: Logger.Instance;
+/**
+ * Environment interface for CookieFirst source
+ */
+interface CookieFirstEnv extends Source.BaseEnv {
+    window?: typeof window;
+}
+/**
+ * Create a mock CookieFirst API object
+ */
+declare const createMockCookieFirstAPI: (consent?: CookieFirstConsent | null) => CookieFirstAPI;
+/**
+ * Create a mock window object with CookieFirst
+ */
+declare const createMockWindow: (consent?: CookieFirstConsent | null) => Partial<Window> & {
+    CookieFirst: CookieFirstAPI;
+};
+/**
+ * Standard mock environment for testing CookieFirst source
+ *
+ * Use this for testing consent handling without requiring
+ * a real browser environment.
+ */
+declare const mockEnv: CookieFirstEnv;
+
+/**
+ * Default category mapping from CookieFirst to walkerOS consent groups.
+ *
+ * Maps CookieFirst's standard categories to walkerOS convention:
+ * - necessary/functional → functional (essential)
+ * - performance → analytics (measurement)
+ * - advertising → marketing (ads)
+ */
+declare const DEFAULT_CATEGORY_MAP: Record<string, string>;
+/**
+ * CookieFirst consent management source for walkerOS.
+ *
+ * This source listens to CookieFirst CMP events and translates
+ * consent states to walkerOS consent commands.
+ *
+ * @example
+ * ```typescript
+ * import { sourceCookieFirst } from '@walkeros/web-source-cmp-cookiefirst';
+ *
+ * await startFlow({
+ *   sources: {
+ *     consent: {
+ *       code: sourceCookieFirst,
+ *       config: {
+ *         settings: {
+ *           categoryMap: {
+ *             performance: 'statistics', // Custom mapping
+ *           },
+ *         },
+ *       },
+ *     },
+ *   },
+ * });
+ * ```
+ */
+declare const sourceCookieFirst: Source.Init<Types>;
+
+export { DEFAULT_CATEGORY_MAP, index as SourceCookieFirst, analyticsOnlyConsent, analyticsOnlyMapped, createMockCookieFirstAPI, createMockElbFn, createMockWindow, sourceCookieFirst as default, fullConsent, fullConsentMapped, marketingOnlyConsent, marketingOnlyMapped, minimalConsent, minimalConsentMapped, mockEnv, noConsent, noopLogger, partialConsent, partialConsentMapped, sourceCookieFirst };