setConsent and on to utils

alexanderkirtzel · alexanderkirtzel · commit c834989877ea · 2025-03-21T18:37:20.000+01:00
diff --git a/packages/sources/node/src/lib/consent.ts b/packages/sources/node/src/lib/consent.ts
diff --git a/packages/sources/node/src/lib/handle.ts b/packages/sources/node/src/lib/handle.ts
@@ -6,12 +6,12 @@ import {
   isObject,
   isSameType,
   pushToDestinations,
+  setConsent,
 } from '@elbwalker/utils';
 import { addDestination } from './destination';
 import { createResult } from './helper';
 import { run } from './run';
 import { getState } from './state';
-import { setConsent } from './consent';
 
 export const handleCommand: SourceNode.HandleCommand = async (
   instance,
diff --git a/packages/sources/node/src/lib/push.ts b/packages/sources/node/src/lib/push.ts
@@ -111,7 +111,7 @@ function createEventOrCommand(
     timing = Math.round((Date.now() - instance.timing) / 10) / 100,
     version = {
       source: instance.version,
-      tagging: instance.config.tagging,
+      tagging: instance.config.tagging || 0,
     },
     source = { type: 'node', id: '', previous_id: '' },
   } = partialEvent;
diff --git a/packages/sources/node/src/types/index.ts b/packages/sources/node/src/types/index.ts
@@ -1,4 +1,3 @@
 export * as DestinationNode from './destination';
 export * as Elb from './elb';
-export * as On from './on';
 export * as SourceNode from './source';
diff --git a/packages/sources/node/src/types/on.ts b/packages/sources/node/src/types/on.ts
diff --git a/packages/sources/walkerjs/src/index.ts b/packages/sources/walkerjs/src/index.ts
@@ -1,7 +1,7 @@
 import type { Elb, SourceWalkerjs } from './types';
+import { onApply } from '@elbwalker/utils';
 import { sessionStart } from '@elbwalker/utils/web';
 import { addDestination } from './lib/destination';
-import { onApply } from './lib/on';
 import { createPush, elbLayerInit } from './lib/push';
 import { run } from './lib/run';
 import { createSessionStart } from './lib/session';
diff --git a/packages/sources/walkerjs/src/lib/consent.ts b/packages/sources/walkerjs/src/lib/consent.ts
diff --git a/packages/sources/walkerjs/src/lib/handle.ts b/packages/sources/walkerjs/src/lib/handle.ts
@@ -1,22 +1,22 @@
-import type { Hooks, WalkerOS } from '@elbwalker/types';
-import type { On, SourceWalkerjs, DestinationWeb, Elb } from '../types';
+import type { Hooks, On, WalkerOS } from '@elbwalker/types';
+import type { SourceWalkerjs, DestinationWeb, Elb } from '../types';
 import {
   Const,
   assign,
   isArray,
   isObject,
   isSameType,
+  on,
   pushToDestinations,
+  setConsent,
   tryCatchAsync,
 } from '@elbwalker/utils';
 import { isElementOrDocument } from './helper';
 import { initScopeTrigger, ready } from './trigger';
 import { getState } from './state';
 import { addDestination } from './destination';
-import { on } from './on';
 import { run } from './run';
 import { addHook } from './hooks';
-import { setConsent } from './consent';
 
 export async function handleCommand(
   instance: SourceWalkerjs.Instance,
diff --git a/packages/sources/walkerjs/src/lib/push.ts b/packages/sources/walkerjs/src/lib/push.ts
@@ -183,7 +183,10 @@ function createEventOrCommand(
     timestamp = Date.now(),
     group = instance.group,
     count = instance.count,
-    version = { source: instance.version, tagging: instance.config.tagging },
+    version = {
+      source: instance.version,
+      tagging: instance.config.tagging || 0,
+    },
     source = {
       type: 'web',
       id: window.location.href,
diff --git a/packages/sources/walkerjs/src/lib/run.ts b/packages/sources/walkerjs/src/lib/run.ts
@@ -1,7 +1,6 @@
 import type { SourceWalkerjs } from '../types';
-import { assign, getId, tryCatch } from '@elbwalker/utils';
+import { assign, getId, onApply, tryCatch } from '@elbwalker/utils';
 import { getGlobals } from './walker';
-import { onApply } from './on';
 import { pushPredefined } from './push';
 import { load } from './trigger';
 import { sessionStart } from './session';
diff --git a/packages/sources/walkerjs/src/lib/session.ts b/packages/sources/walkerjs/src/lib/session.ts
@@ -1,10 +1,9 @@
 import type { WalkerOS } from '@elbwalker/types';
 import type { SessionCallback } from '@elbwalker/utils/web';
-import { assign, isSameType, useHooks } from '@elbwalker/utils';
+import { assign, isSameType, onApply, useHooks } from '@elbwalker/utils';
 import { sessionStart as sessionStartOrg } from '@elbwalker/utils/web';
 import { SourceWalkerjs } from '../types';
 import { SessionStartOptions } from '../types/source';
-import { onApply } from './on';
 
 export function createSessionStart(instance: SourceWalkerjs.Instance) {
   return function (
diff --git a/packages/sources/walkerjs/src/lib/trigger.ts b/packages/sources/walkerjs/src/lib/trigger.ts
@@ -1,7 +1,6 @@
-import { Const, throttle, tryCatch, tryCatchAsync } from '@elbwalker/utils';
+import { Const, onApply, throttle, tryCatch } from '@elbwalker/utils';
 import { elb as elbOrg, getAttribute, isVisible } from '@elbwalker/utils/web';
 import { Walker, SourceWalkerjs, Elb } from '../types';
-import { onApply } from './on';
 import {
   getElbAttributeName,
   getEvents,
diff --git a/packages/sources/walkerjs/src/types/destination.ts b/packages/sources/walkerjs/src/types/destination.ts
@@ -2,7 +2,6 @@ import type {
   Destination as WalkerOSDestination,
   Mapping as WalkerOSMapping,
 } from '@elbwalker/types';
-import type { Config as OnConfig } from './on';
 
 export interface Destination<Custom = unknown, CustomEvent = unknown>
   extends WalkerOSDestination.Destination<Custom, CustomEvent> {
@@ -23,9 +22,7 @@ export type PushBatchFn<Custom, CustomEvent> = (
 ) => void;
 
 export interface Config<Custom = unknown, CustomEvent = unknown>
-  extends WalkerOSDestination.Config<Custom, CustomEvent> {
-  on?: OnConfig; // On events listener rules
-}
+  extends WalkerOSDestination.Config<Custom, CustomEvent> {}
 
 export interface Mapping<CustomEvent = unknown>
   extends WalkerOSMapping.Config<CustomEvent> {}
diff --git a/packages/sources/walkerjs/src/types/elb.ts b/packages/sources/walkerjs/src/types/elb.ts
@@ -1,6 +1,6 @@
-import type { Elb, WalkerOS } from '@elbwalker/types';
+import type { Elb, On, WalkerOS } from '@elbwalker/types';
 import type { Destination, DestinationInit, Config } from './destination';
-import type { ConsentConfig, Options } from './on';
+
 import type { State } from './source';
 import type { Trigger } from './walker';
 
@@ -30,7 +30,7 @@ export type CommandRun<R = void> = (
 export type CommandOn<R = void> = (
   event: 'walker on',
   type: 'consent',
-  rules: WalkerOS.SingleOrArray<ConsentConfig>,
+  rules: WalkerOS.SingleOrArray<On.ConsentConfig>,
 ) => R;
 
 export type Layer = Elb.Layer;
@@ -45,7 +45,7 @@ export type PushData =
 export type PushOptions =
   | Elb.PushOptions
   | Trigger
-  | WalkerOS.SingleOrArray<Options>
+  | WalkerOS.SingleOrArray<On.Options>
   | Config;
 
 export type PushContext = Elb.PushContext | Element;
diff --git a/packages/sources/walkerjs/src/types/index.ts b/packages/sources/walkerjs/src/types/index.ts
@@ -1,5 +1,4 @@
 export * as DestinationWeb from './destination';
 export * as Elb from './elb';
-export * as On from './on';
 export * as SourceWalkerjs from './source';
 export * as Walker from './walker';
diff --git a/packages/types/src/destination.ts b/packages/types/src/destination.ts
@@ -1,4 +1,4 @@
-import type { Handler, Mapping, WalkerOS } from '.';
+import type { Handler, Mapping, On, WalkerOS } from '.';
 
 export interface Destination<Custom = unknown, CustomEvent = unknown> {
   config: Config<Custom, CustomEvent>; // Configuration settings for the destination
@@ -17,6 +17,7 @@ export interface Config<Custom = unknown, CustomEvent = unknown> {
   init?: boolean; // If the destination has been initialized by calling the init method
   loadScript?: boolean; // If an additional script to work should be loaded
   mapping?: Mapping.Config<CustomEvent>; // A map to handle events individually
+  on?: On.Config; // On events listener rules
   policy?: Policy; // Rules for processing events
   queue?: boolean; // Disable processing of previously pushed events
   verbose?: boolean; // Enable verbose logging
diff --git a/packages/types/src/index.ts b/packages/types/src/index.ts
@@ -4,6 +4,7 @@ export * as Elb from './elb';
 export * as Handler from './handler';
 export * as Hooks from './hooks';
 export * as Mapping from './mapping';
+export * as On from './on';
 export * as Request from './request';
 export * as Schema from './schema';
 export * as WalkerOS from './walkeros';
diff --git a/packages/types/src/on.ts b/packages/types/src/on.ts
diff --git a/packages/types/src/walkeros.ts b/packages/types/src/walkeros.ts
@@ -27,7 +27,8 @@ export interface State {
 }
 
 export interface Config {
-  tagging: number;
+  tagging?: number;
+  session?: false | unknown;
   default?: boolean;
   verbose?: boolean; // Enable verbose logging
   onError?: Handler.Error;
diff --git a/packages/utils/src/core/consent.ts b/packages/utils/src/core/consent.ts
@@ -1,4 +1,7 @@
 import type { WalkerOS } from '@elbwalker/types';
+import { assign } from './assign';
+import { pushToDestinations } from './destination';
+import { onApply } from './on';
 
 export function getGrantedConsent(
   required: WalkerOS.Consent | undefined,
@@ -23,3 +26,30 @@ export function getGrantedConsent(
 
   return hasRequiredConsent ? grantedStates : false;
 }
+
+export function setConsent(
+  instance: WalkerOS.Instance,
+  data: WalkerOS.Consent,
+) {
+  const { consent, destinations } = instance;
+
+  let runQueue = false;
+  const update: WalkerOS.Consent = {};
+  Object.entries(data).forEach(([name, granted]) => {
+    const state = !!granted;
+
+    update[name] = state;
+
+    // Only run queue if state was set to true
+    runQueue = runQueue || state;
+  });
+
+  // Update consent state
+  instance.consent = assign(consent, update);
+
+  // Run on consent events
+  onApply(instance, 'consent', undefined, update);
+
+  // Process previous events if not disabled
+  if (runQueue) return pushToDestinations(instance, destinations);
+}
diff --git a/packages/utils/src/core/index.ts b/packages/utils/src/core/index.ts
@@ -12,6 +12,7 @@ export * from './getMarketingParameters';
 export * from './invocations';
 export * from './is';
 export * from './mapping';
+export * from './on';
 export * from './onLog';
 export * from './property';
 export * from './request';
diff --git a/packages/utils/src/core/on.ts b/packages/utils/src/core/on.ts
@@ -1,9 +1,10 @@
-import type { WalkerOS } from '@elbwalker/types';
-import type { On, SourceWalkerjs } from '../';
-import { Const, isArray, tryCatch } from '@elbwalker/utils';
+import type { On, WalkerOS } from '@elbwalker/types';
+import { isArray } from './is';
+import { Const } from './constants';
+import { tryCatch } from './tryCatch';
 
 export function on(
-  instance: SourceWalkerjs.Instance,
+  instance: WalkerOS.Instance,
   type: On.Types,
   option: WalkerOS.SingleOrArray<On.Options>,
 ) {
@@ -23,7 +24,7 @@ export function on(
 }
 
 export function onApply(
-  instance: SourceWalkerjs.Instance,
+  instance: WalkerOS.Instance,
   type: On.Types,
   options?: Array<On.Options>,
   config?: WalkerOS.Consent,
@@ -63,7 +64,7 @@ export function onApply(
 }
 
 function onConsent(
-  instance: SourceWalkerjs.Instance,
+  instance: WalkerOS.Instance,
   onConfig: Array<On.ConsentConfig>,
   currentConsent?: WalkerOS.Consent,
 ): void {
@@ -82,7 +83,7 @@ function onConsent(
 }
 
 function onReady(
-  instance: SourceWalkerjs.Instance,
+  instance: WalkerOS.Instance,
   onConfig: Array<On.ReadyConfig>,
 ): void {
   if (instance.allowed)
@@ -92,7 +93,7 @@ function onReady(
 }
 
 function onRun(
-  instance: SourceWalkerjs.Instance,
+  instance: WalkerOS.Instance,
   onConfig: Array<On.RunConfig>,
 ): void {
   if (instance.allowed)
@@ -102,7 +103,7 @@ function onRun(
 }
 
 function onSession(
-  instance: SourceWalkerjs.Instance,
+  instance: WalkerOS.Instance,
   onConfig: Array<On.SessionConfig>,
 ): void {
   if (!instance.config.session) return; // Session handling is disabled
