@walkeros/web-source-datalayer 0.0.0-next-20251219153324

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 elbWalker GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,56 @@
+<p align="left">
+  <a href="https://www.walkeros.io">
+    <img title="elbwalker" src="https://www.walkeros.io/img/elbwalker_logo.png" width="256px"/>
+  </a>
+</p>
+
+# DataLayer Source for walkerOS
+
+[Source Code](https://github.com/elbwalker/walkerOS/tree/main/packages/web/sources/dataLayer)
+&bull;
+[NPM Package](https://www.npmjs.com/package/@walkeros/web-source-datalayer)
+
+This package provides a dataLayer source for walkerOS. It allows you to process
+events from a dataLayer and send them to the walkerOS collector.
+
+walkerOS follows a **source → collector → destination** architecture. This
+dataLayer source monitors the browser's dataLayer (commonly used with Google Tag
+Manager) and transforms existing gtag() calls and dataLayer.push() events into
+standardized walkerOS events, enabling seamless migration from traditional
+dataLayer implementations.
+
+## Installation
+
+```sh
+npm install @walkeros/web-source-datalayer
+```
+
+## Usage
+
+Here's a basic example of how to use the dataLayer source:
+
+```typescript
+import { elb } from '@walkeros/collector';
+import { sourceDataLayer } from '@walkeros/web-source-datalayer';
+
+sourceDataLayer({ elb });
+```
+
+## Configuration
+
+| Name     | Type                                                   | Description                                                   | Required | Example                                         |
+| -------- | ------------------------------------------------------ | ------------------------------------------------------------- | -------- | ----------------------------------------------- |
+| `name`   | `string`                                               | DataLayer variable name (default: "dataLayer")                | No       | `'dataLayer'`                                   |
+| `prefix` | `string`                                               | Event prefix for filtering dataLayer events (default: "gtag") | No       | `'gtag'`                                        |
+| `filter` | `(event: unknown) => WalkerOS.PromiseOrValue<boolean>` | Function to filter which dataLayer events to process          | No       | `(event) => event && typeof event === "object"` |
+
+## Contribute
+
+Feel free to contribute by submitting an
+[issue](https://github.com/elbwalker/walkerOS/issues), starting a
+[discussion](https://github.com/elbwalker/walkerOS/discussions), or getting in
+[contact](https://calendly.com/elb-alexander/30min).
+
+## License
+
+This project is licensed under the MIT License.

package/dist/dev.d.mts

@@ -0,0 +1,36 @@
+import * as _walkeros_core_dev from '@walkeros/core/dev';
+import { z } from '@walkeros/core/dev';
+
+/**
+ * JavaScript variable name
+ * Used for dataLayer variable naming
+ */
+declare const JavaScriptVarName: z.ZodString;
+/**
+ * Event prefix
+ * Used for filtering dataLayer events
+ */
+declare const EventPrefix: z.ZodString;
+
+/**
+ * DataLayer source settings schema
+ */
+declare const SettingsSchema: z.ZodObject<{
+    name: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+    prefix: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+    filter: z.ZodOptional<z.ZodAny>;
+}, z.core.$strip>;
+type Settings = z.infer<typeof SettingsSchema>;
+
+declare const settings: _walkeros_core_dev.JSONSchema;
+
+declare const index_EventPrefix: typeof EventPrefix;
+declare const index_JavaScriptVarName: typeof JavaScriptVarName;
+type index_Settings = Settings;
+declare const index_SettingsSchema: typeof SettingsSchema;
+declare const index_settings: typeof settings;
+declare namespace index {
+  export { index_EventPrefix as EventPrefix, index_JavaScriptVarName as JavaScriptVarName, type index_Settings as Settings, index_SettingsSchema as SettingsSchema, index_settings as settings };
+}
+
+export { index as schemas };

package/dist/dev.d.ts

@@ -0,0 +1,36 @@
+import * as _walkeros_core_dev from '@walkeros/core/dev';
+import { z } from '@walkeros/core/dev';
+
+/**
+ * JavaScript variable name
+ * Used for dataLayer variable naming
+ */
+declare const JavaScriptVarName: z.ZodString;
+/**
+ * Event prefix
+ * Used for filtering dataLayer events
+ */
+declare const EventPrefix: z.ZodString;
+
+/**
+ * DataLayer source settings schema
+ */
+declare const SettingsSchema: z.ZodObject<{
+    name: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+    prefix: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+    filter: z.ZodOptional<z.ZodAny>;
+}, z.core.$strip>;
+type Settings = z.infer<typeof SettingsSchema>;
+
+declare const settings: _walkeros_core_dev.JSONSchema;
+
+declare const index_EventPrefix: typeof EventPrefix;
+declare const index_JavaScriptVarName: typeof JavaScriptVarName;
+type index_Settings = Settings;
+declare const index_SettingsSchema: typeof SettingsSchema;
+declare const index_settings: typeof settings;
+declare namespace index {
+  export { index_EventPrefix as EventPrefix, index_JavaScriptVarName as JavaScriptVarName, type index_Settings as Settings, index_SettingsSchema as SettingsSchema, index_settings as settings };
+}
+
+export { index as schemas };

package/dist/dev.js

@@ -0,0 +1 @@
+"use strict";var e,r=Object.defineProperty,a=Object.getOwnPropertyDescriptor,t=Object.getOwnPropertyNames,i=Object.prototype.hasOwnProperty,o=(e,a)=>{for(var t in a)r(e,t,{get:a[t],enumerable:!0})},n={};o(n,{schemas:()=>s}),module.exports=(e=n,((e,o,n,s)=>{if(o&&"object"==typeof o||"function"==typeof o)for(let c of t(o))i.call(e,c)||c===n||r(e,c,{get:()=>o[c],enumerable:!(s=a(o,c))||s.enumerable});return e})(r({},"__esModule",{value:!0}),e));var s={};o(s,{EventPrefix:()=>b,JavaScriptVarName:()=>d,SettingsSchema:()=>p,settings:()=>u});var c=require("@walkeros/core/dev"),l=require("@walkeros/core/dev"),f=require("@walkeros/core/dev"),d=f.z.string().min(1).regex(/^[a-zA-Z_$][a-zA-Z0-9_$]*$/,"Must be a valid JavaScript identifier").describe("JavaScript variable name"),b=f.z.string().min(1).describe("Prefix for filtering dataLayer events"),p=l.z.object({name:d.default("dataLayer").describe("DataLayer variable name (default: dataLayer)").optional(),prefix:b.default("dataLayer").describe("Event prefix for filtering which events to process").optional(),filter:l.z.any().describe("Custom filter function: (event: unknown) => boolean | Promise<boolean>").optional()}),u=(0,c.zodToSchema)(p);//# sourceMappingURL=dev.js.map

package/dist/dev.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/dev.ts","../src/schemas/index.ts","../src/schemas/settings.ts","../src/schemas/primitives.ts"],"sourcesContent":["export * as schemas from './schemas';\n","import { zodToSchema } from '@walkeros/core/dev';\nimport { SettingsSchema } from './settings';\n\n// Export primitives\nexport * from './primitives';\n\n// Export Zod schemas and types\nexport { SettingsSchema, type Settings } from './settings';\n\n// JSON Schema exports (for website PropertyTable and documentation tools)\nexport const settings = zodToSchema(SettingsSchema);\n","import { z } from '@walkeros/core/dev';\nimport { JavaScriptVarName, EventPrefix } from './primitives';\n\n/**\n * DataLayer source settings schema\n */\nexport const SettingsSchema = z.object({\n  name: JavaScriptVarName.default('dataLayer')\n    .describe('DataLayer variable name (default: dataLayer)')\n    .optional(),\n\n  prefix: EventPrefix.default('dataLayer')\n    .describe('Event prefix for filtering which events to process')\n    .optional(),\n\n  filter: z\n    .any()\n    .describe(\n      'Custom filter function: (event: unknown) => boolean | Promise<boolean>',\n    )\n    .optional(),\n});\n\nexport type Settings = z.infer<typeof SettingsSchema>;\n","import { z } from '@walkeros/core/dev';\n\n/**\n * JavaScript variable name\n * Used for dataLayer variable naming\n */\nexport const JavaScriptVarName = z\n  .string()\n  .min(1)\n  .regex(/^[a-zA-Z_$][a-zA-Z0-9_$]*$/, 'Must be a valid JavaScript identifier')\n  .describe('JavaScript variable name');\n\n/**\n * Event prefix\n * Used for filtering dataLayer events\n */\nexport const EventPrefix = z\n  .string()\n  .min(1)\n  .describe('Prefix for filtering dataLayer events');\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAAAA,cAA4B;;;ACA5B,IAAAC,cAAkB;;;ACAlB,iBAAkB;AAMX,IAAM,oBAAoB,aAC9B,OAAO,EACP,IAAI,CAAC,EACL,MAAM,8BAA8B,uCAAuC,EAC3E,SAAS,0BAA0B;AAM/B,IAAM,cAAc,aACxB,OAAO,EACP,IAAI,CAAC,EACL,SAAS,uCAAuC;;;ADb5C,IAAM,iBAAiB,cAAE,OAAO;AAAA,EACrC,MAAM,kBAAkB,QAAQ,WAAW,EACxC,SAAS,8CAA8C,EACvD,SAAS;AAAA,EAEZ,QAAQ,YAAY,QAAQ,WAAW,EACpC,SAAS,oDAAoD,EAC7D,SAAS;AAAA,EAEZ,QAAQ,cACL,IAAI,EACJ;AAAA,IACC;AAAA,EACF,EACC,SAAS;AACd,CAAC;;;ADXM,IAAM,eAAW,yBAAY,cAAc;","names":["import_dev","import_dev"]}

package/dist/dev.mjs

@@ -0,0 +1 @@
+var e=Object.defineProperty,a={};((a,r)=>{for(var t in r)e(a,t,{get:r[t],enumerable:!0})})(a,{EventPrefix:()=>n,JavaScriptVarName:()=>o,SettingsSchema:()=>s,settings:()=>f});import{zodToSchema as r}from"@walkeros/core/dev";import{z as t}from"@walkeros/core/dev";import{z as i}from"@walkeros/core/dev";var o=i.string().min(1).regex(/^[a-zA-Z_$][a-zA-Z0-9_$]*$/,"Must be a valid JavaScript identifier").describe("JavaScript variable name"),n=i.string().min(1).describe("Prefix for filtering dataLayer events"),s=t.object({name:o.default("dataLayer").describe("DataLayer variable name (default: dataLayer)").optional(),prefix:n.default("dataLayer").describe("Event prefix for filtering which events to process").optional(),filter:t.any().describe("Custom filter function: (event: unknown) => boolean | Promise<boolean>").optional()}),f=r(s);export{a as schemas};//# sourceMappingURL=dev.mjs.map

package/dist/dev.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/schemas/index.ts","../src/schemas/settings.ts","../src/schemas/primitives.ts"],"sourcesContent":["import { zodToSchema } from '@walkeros/core/dev';\nimport { SettingsSchema } from './settings';\n\n// Export primitives\nexport * from './primitives';\n\n// Export Zod schemas and types\nexport { SettingsSchema, type Settings } from './settings';\n\n// JSON Schema exports (for website PropertyTable and documentation tools)\nexport const settings = zodToSchema(SettingsSchema);\n","import { z } from '@walkeros/core/dev';\nimport { JavaScriptVarName, EventPrefix } from './primitives';\n\n/**\n * DataLayer source settings schema\n */\nexport const SettingsSchema = z.object({\n  name: JavaScriptVarName.default('dataLayer')\n    .describe('DataLayer variable name (default: dataLayer)')\n    .optional(),\n\n  prefix: EventPrefix.default('dataLayer')\n    .describe('Event prefix for filtering which events to process')\n    .optional(),\n\n  filter: z\n    .any()\n    .describe(\n      'Custom filter function: (event: unknown) => boolean | Promise<boolean>',\n    )\n    .optional(),\n});\n\nexport type Settings = z.infer<typeof SettingsSchema>;\n","import { z } from '@walkeros/core/dev';\n\n/**\n * JavaScript variable name\n * Used for dataLayer variable naming\n */\nexport const JavaScriptVarName = z\n  .string()\n  .min(1)\n  .regex(/^[a-zA-Z_$][a-zA-Z0-9_$]*$/, 'Must be a valid JavaScript identifier')\n  .describe('JavaScript variable name');\n\n/**\n * Event prefix\n * Used for filtering dataLayer events\n */\nexport const EventPrefix = z\n  .string()\n  .min(1)\n  .describe('Prefix for filtering dataLayer events');\n"],"mappings":";;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,SAAS,mBAAmB;;;ACA5B,SAAS,KAAAA,UAAS;;;ACAlB,SAAS,SAAS;AAMX,IAAM,oBAAoB,EAC9B,OAAO,EACP,IAAI,CAAC,EACL,MAAM,8BAA8B,uCAAuC,EAC3E,SAAS,0BAA0B;AAM/B,IAAM,cAAc,EACxB,OAAO,EACP,IAAI,CAAC,EACL,SAAS,uCAAuC;;;ADb5C,IAAM,iBAAiBC,GAAE,OAAO;AAAA,EACrC,MAAM,kBAAkB,QAAQ,WAAW,EACxC,SAAS,8CAA8C,EACvD,SAAS;AAAA,EAEZ,QAAQ,YAAY,QAAQ,WAAW,EACpC,SAAS,oDAAoD,EAC7D,SAAS;AAAA,EAEZ,QAAQA,GACL,IAAI,EACJ;AAAA,IACC;AAAA,EACF,EACC,SAAS;AACd,CAAC;;;ADXM,IAAM,WAAW,YAAY,cAAc;","names":["z","z"]}

package/dist/examples/index.d.mts

@@ -0,0 +1,101 @@
+import { Source, Mapping } from '@walkeros/core';
+
+/**
+ * Environment interface for dataLayer source
+ */
+interface DataLayerEnv extends Source.BaseEnv {
+    window?: typeof window;
+}
+/**
+ * Standard mock environment for testing dataLayer source
+ *
+ * Use this for testing dataLayer.push interception and event transformation
+ * without requiring a real browser environment.
+ */
+declare const push: DataLayerEnv;
+
+declare const env_push: typeof push;
+declare namespace env {
+  export { env_push as push };
+}
+
+/**
+ * Sample gtag events that would be pushed to dataLayer
+ * These represent real-world gtag calls that the dataLayer source should transform to WalkerOS events
+ */
+/**
+ * Consent Mode Events - Primary use case
+ */
+declare function consentUpdate$1(): unknown[];
+declare function consentDefault(): unknown[];
+/**
+ * E-commerce Events
+ */
+declare function purchase$1(): unknown[];
+declare function add_to_cart$1(): unknown[];
+declare function view_item$1(): unknown[];
+/**
+ * Config Events
+ */
+declare function config$1(): unknown[];
+/**
+ * Set Events
+ */
+declare function setCustom(): unknown[];
+/**
+ * Direct dataLayer object pushes (not gtag)
+ */
+declare function directDataLayerEvent(): Record<string, unknown>;
+
+declare const events_consentDefault: typeof consentDefault;
+declare const events_directDataLayerEvent: typeof directDataLayerEvent;
+declare const events_setCustom: typeof setCustom;
+declare namespace events {
+  export { add_to_cart$1 as add_to_cart, config$1 as config, events_consentDefault as consentDefault, consentUpdate$1 as consentUpdate, events_directDataLayerEvent as directDataLayerEvent, purchase$1 as purchase, events_setCustom as setCustom, view_item$1 as view_item };
+}
+
+/**
+ * Consent Mode Mapping - Primary use case
+ * Maps gtag consent events to walker consent commands
+ */
+declare const consentUpdate: Mapping.Rule;
+/**
+ * E-commerce Event Mappings
+ * Transform GA4 ecommerce events to WalkerOS events
+ */
+declare const purchase: Mapping.Rule;
+declare const add_to_cart: Mapping.Rule;
+declare const view_item: Mapping.Rule;
+/**
+ * Config Event Mapping
+ * Transform GA4 config events to WalkerOS page events
+ */
+declare const configGA4: Mapping.Rule;
+/**
+ * Custom Event Mapping
+ * Handle direct dataLayer pushes
+ */
+declare const customEvent: Mapping.Rule;
+/**
+ * Complete mapping configuration
+ * Following the same pattern as destination mappings
+ */
+declare const config: Mapping.Rules;
+/**
+ * Minimal consent-only mapping for focused use cases
+ */
+declare const consentOnlyMapping: Mapping.Rules;
+
+declare const mapping_add_to_cart: typeof add_to_cart;
+declare const mapping_config: typeof config;
+declare const mapping_configGA4: typeof configGA4;
+declare const mapping_consentOnlyMapping: typeof consentOnlyMapping;
+declare const mapping_consentUpdate: typeof consentUpdate;
+declare const mapping_customEvent: typeof customEvent;
+declare const mapping_purchase: typeof purchase;
+declare const mapping_view_item: typeof view_item;
+declare namespace mapping {
+  export { mapping_add_to_cart as add_to_cart, mapping_config as config, mapping_configGA4 as configGA4, mapping_consentOnlyMapping as consentOnlyMapping, mapping_consentUpdate as consentUpdate, mapping_customEvent as customEvent, mapping_purchase as purchase, mapping_view_item as view_item };
+}
+
+export { events as Events, mapping as Mapping, consentOnlyMapping, consentUpdate$1 as consentUpdateEvent, config as dataLayerExamples, env };

package/dist/examples/index.d.ts

@@ -0,0 +1,101 @@
+import { Source, Mapping } from '@walkeros/core';
+
+/**
+ * Environment interface for dataLayer source
+ */
+interface DataLayerEnv extends Source.BaseEnv {
+    window?: typeof window;
+}
+/**
+ * Standard mock environment for testing dataLayer source
+ *
+ * Use this for testing dataLayer.push interception and event transformation
+ * without requiring a real browser environment.
+ */
+declare const push: DataLayerEnv;
+
+declare const env_push: typeof push;
+declare namespace env {
+  export { env_push as push };
+}
+
+/**
+ * Sample gtag events that would be pushed to dataLayer
+ * These represent real-world gtag calls that the dataLayer source should transform to WalkerOS events
+ */
+/**
+ * Consent Mode Events - Primary use case
+ */
+declare function consentUpdate$1(): unknown[];
+declare function consentDefault(): unknown[];
+/**
+ * E-commerce Events
+ */
+declare function purchase$1(): unknown[];
+declare function add_to_cart$1(): unknown[];
+declare function view_item$1(): unknown[];
+/**
+ * Config Events
+ */
+declare function config$1(): unknown[];
+/**
+ * Set Events
+ */
+declare function setCustom(): unknown[];
+/**
+ * Direct dataLayer object pushes (not gtag)
+ */
+declare function directDataLayerEvent(): Record<string, unknown>;
+
+declare const events_consentDefault: typeof consentDefault;
+declare const events_directDataLayerEvent: typeof directDataLayerEvent;
+declare const events_setCustom: typeof setCustom;
+declare namespace events {
+  export { add_to_cart$1 as add_to_cart, config$1 as config, events_consentDefault as consentDefault, consentUpdate$1 as consentUpdate, events_directDataLayerEvent as directDataLayerEvent, purchase$1 as purchase, events_setCustom as setCustom, view_item$1 as view_item };
+}
+
+/**
+ * Consent Mode Mapping - Primary use case
+ * Maps gtag consent events to walker consent commands
+ */
+declare const consentUpdate: Mapping.Rule;
+/**
+ * E-commerce Event Mappings
+ * Transform GA4 ecommerce events to WalkerOS events
+ */
+declare const purchase: Mapping.Rule;
+declare const add_to_cart: Mapping.Rule;
+declare const view_item: Mapping.Rule;
+/**
+ * Config Event Mapping
+ * Transform GA4 config events to WalkerOS page events
+ */
+declare const configGA4: Mapping.Rule;
+/**
+ * Custom Event Mapping
+ * Handle direct dataLayer pushes
+ */
+declare const customEvent: Mapping.Rule;
+/**
+ * Complete mapping configuration
+ * Following the same pattern as destination mappings
+ */
+declare const config: Mapping.Rules;
+/**
+ * Minimal consent-only mapping for focused use cases
+ */
+declare const consentOnlyMapping: Mapping.Rules;
+
+declare const mapping_add_to_cart: typeof add_to_cart;
+declare const mapping_config: typeof config;
+declare const mapping_configGA4: typeof configGA4;
+declare const mapping_consentOnlyMapping: typeof consentOnlyMapping;
+declare const mapping_consentUpdate: typeof consentUpdate;
+declare const mapping_customEvent: typeof customEvent;
+declare const mapping_purchase: typeof purchase;
+declare const mapping_view_item: typeof view_item;
+declare namespace mapping {
+  export { mapping_add_to_cart as add_to_cart, mapping_config as config, mapping_configGA4 as configGA4, mapping_consentOnlyMapping as consentOnlyMapping, mapping_consentUpdate as consentUpdate, mapping_customEvent as customEvent, mapping_purchase as purchase, mapping_view_item as view_item };
+}
+
+export { events as Events, mapping as Mapping, consentOnlyMapping, consentUpdate$1 as consentUpdateEvent, config as dataLayerExamples, env };