@walkeros/web-destination-d8a 4.1.0

package/dist/walkerOS.json

@@ -0,0 +1,633 @@
+{
+  "$meta": {
+    "package": "@walkeros/web-destination-d8a",
+    "version": "4.1.0",
+    "type": "destination",
+    "platform": [
+      "web"
+    ],
+    "docs": "https://www.walkeros.io/docs/destinations/web/d8a",
+    "source": "https://github.com/elbwalker/walkerOS/tree/main/packages/web/destinations/d8a/src"
+  },
+  "schemas": {
+    "mapping": {
+      "$schema": "http://json-schema.org/draft-07/schema#",
+      "type": "object",
+      "properties": {},
+      "additionalProperties": false
+    },
+    "settings": {
+      "$schema": "http://json-schema.org/draft-07/schema#",
+      "type": "object",
+      "properties": {
+        "property_id": {
+          "type": "string",
+          "description": "d8a property ID"
+        },
+        "server_container_url": {
+          "type": "string",
+          "format": "uri",
+          "description": "d8a collector URL for the property"
+        },
+        "como": {
+          "anyOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "object",
+              "propertyNames": {
+                "type": "string"
+              },
+              "additionalProperties": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
+                  }
+                ]
+              }
+            }
+          ],
+          "description": "Consent mode configuration: false (disabled), true (use defaults), or custom mapping"
+        },
+        "data": {
+          "description": "Custom data mapping configuration"
+        },
+        "dataLayerName": {
+          "type": "string",
+          "description": "Name of the d8a command queue (default: d8aLayer)"
+        },
+        "globalName": {
+          "type": "string",
+          "description": "Name of the global d8a function (default: d8a)"
+        },
+        "send_page_view": {
+          "type": "boolean",
+          "description": "Enable automatic pageview tracking"
+        },
+        "snakeCase": {
+          "type": "boolean",
+          "description": "Convert event names to snake_case (like true)"
+        },
+        "debug_mode": {
+          "type": "boolean",
+          "description": "Enable debug mode"
+        },
+        "cookie_domain": {
+          "type": "string",
+          "description": "Cookie domain strategy: auto, none, or a specific domain"
+        },
+        "cookie_path": {
+          "type": "string",
+          "description": "Cookie path"
+        },
+        "cookie_expires": {
+          "type": "number",
+          "description": "Cookie lifetime in seconds"
+        },
+        "cookie_flags": {
+          "type": "string",
+          "description": "Raw cookie flags"
+        },
+        "cookie_prefix": {
+          "type": "string",
+          "description": "Cookie name prefix"
+        },
+        "cookie_update": {
+          "type": "boolean",
+          "description": "Refresh cookie expirations on activity"
+        },
+        "session_timeout_ms": {
+          "type": "number",
+          "description": "Session timeout window in milliseconds"
+        },
+        "session_engagement_time_sec": {
+          "type": "number",
+          "description": "Minimum engaged time in seconds"
+        },
+        "flush_interval_ms": {
+          "type": "number",
+          "description": "Flush interval in milliseconds"
+        },
+        "max_batch_size": {
+          "type": "number",
+          "description": "Maximum batch size"
+        },
+        "user_id": {
+          "type": "string",
+          "description": "GA4-style user ID"
+        },
+        "client_id": {
+          "type": "string",
+          "description": "Client ID override"
+        },
+        "campaign_id": {
+          "type": "string"
+        },
+        "campaign_source": {
+          "type": "string"
+        },
+        "campaign_medium": {
+          "type": "string"
+        },
+        "campaign_name": {
+          "type": "string"
+        },
+        "campaign_term": {
+          "type": "string"
+        },
+        "campaign_content": {
+          "type": "string"
+        },
+        "page_location": {
+          "type": "string"
+        },
+        "page_title": {
+          "type": "string"
+        },
+        "page_referrer": {
+          "type": "string"
+        },
+        "content_group": {
+          "type": "string"
+        },
+        "language": {
+          "type": "string"
+        },
+        "screen_resolution": {
+          "type": "string"
+        },
+        "ignore_referrer": {
+          "type": "boolean"
+        },
+        "site_search_enabled": {
+          "type": "boolean"
+        },
+        "site_search_query_params": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          ]
+        },
+        "outbound_clicks_enabled": {
+          "type": "boolean"
+        },
+        "outbound_exclude_domains": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          ]
+        },
+        "file_downloads_enabled": {
+          "type": "boolean"
+        },
+        "file_download_extensions": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          ]
+        }
+      },
+      "required": [
+        "property_id",
+        "server_container_url"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "examples": {
+    "env": {
+      "init": {
+        "installD8a": {
+          "$code": "e=>{const a=null==e?void 0:e.windowRef,t=(null==e?void 0:e.globalName)||\"d8a\",i=(null==e?void 0:e.dataLayerName)||\"d8aLayer\";return a&&(a[i]=a[i]||[],a[t]=a[t]||g()),{dataLayerName:i,globalName:t,consumer:{start:()=>{},stop:()=>{},getState:()=>({}),setOnEvent:()=>{},setOnConfig:()=>{}},dispatcher:{enqueueEvent:()=>{},flush:async()=>({sent:0}),flushNow:async()=>({sent:0}),attachLifecycleFlush:()=>{}}}}"
+        },
+        "window": {}
+      },
+      "push": {
+        "installD8a": {
+          "$code": "e=>{const a=null==e?void 0:e.windowRef,t=(null==e?void 0:e.globalName)||\"d8a\",i=(null==e?void 0:e.dataLayerName)||\"d8aLayer\";return a&&(a[i]=a[i]||[],a[t]=a[t]||g()),{dataLayerName:i,globalName:t,consumer:{start:()=>{},stop:()=>{},getState:()=>({}),setOnEvent:()=>{},setOnConfig:()=>{}},dispatcher:{enqueueEvent:()=>{},flush:async()=>({sent:0}),flushNow:async()=>({sent:0}),attachLifecycleFlush:()=>{}}}}"
+        },
+        "window": {
+          "d8a": {
+            "$code": "()=>{}"
+          },
+          "d8aLayer": []
+        }
+      },
+      "simulation": [
+        "call:window.d8a"
+      ]
+    },
+    "step": {
+      "addToCart": {
+        "title": "Add to cart",
+        "description": "A product add event is mapped to the d8a add_to_cart event with item details and value.",
+        "in": {
+          "name": "product add",
+          "data": {
+            "id": "ers",
+            "name": "Everyday Ruck Snack",
+            "color": "black",
+            "size": "l",
+            "price": 420
+          },
+          "context": {
+            "shopping": [
+              "intent",
+              0
+            ]
+          },
+          "globals": {
+            "pagegroup": "shop"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "id": "us3r",
+            "device": "c00k13",
+            "session": "s3ss10n"
+          },
+          "nested": [],
+          "consent": {
+            "functional": true
+          },
+          "id": "23516757b8604dac",
+          "trigger": "click",
+          "entity": "product",
+          "action": "add",
+          "timestamp": 1700000301,
+          "timing": 3.14,
+          "source": {
+            "type": "collector",
+            "schema": "4"
+          }
+        },
+        "mapping": {
+          "name": "add_to_cart",
+          "include": [
+            "data"
+          ],
+          "data": {
+            "map": {
+              "currency": {
+                "value": "EUR",
+                "key": "data.currency"
+              },
+              "value": "data.price",
+              "items": {
+                "loop": [
+                  "this",
+                  {
+                    "map": {
+                      "item_id": "data.id",
+                      "item_variant": "data.color",
+                      "quantity": {
+                        "value": 1,
+                        "key": "data.quantity"
+                      }
+                    }
+                  }
+                ]
+              }
+            }
+          }
+        },
+        "out": [
+          [
+            "d8a",
+            "event",
+            "add_to_cart",
+            {
+              "currency": "EUR",
+              "value": 420,
+              "items": [
+                {
+                  "item_id": "ers",
+                  "item_variant": "black",
+                  "quantity": 1
+                }
+              ],
+              "data_id": "ers",
+              "data_name": "Everyday Ruck Snack",
+              "data_color": "black",
+              "data_size": "l",
+              "data_price": 420,
+              "send_to": "80e1d6d0-560d-419f-ac2a-fe9281e93386"
+            }
+          ]
+        ]
+      },
+      "consentMode": {
+        "title": "Consent mode",
+        "description": "A walker consent command updates d8a using gtag consent mode parameters.",
+        "command": "consent",
+        "in": {
+          "marketing": true,
+          "functional": true
+        },
+        "out": [
+          [
+            "d8a",
+            "consent",
+            "default",
+            {
+              "ad_storage": "denied",
+              "ad_user_data": "denied",
+              "ad_personalization": "denied",
+              "analytics_storage": "denied"
+            }
+          ],
+          [
+            "d8a",
+            "consent",
+            "update",
+            {
+              "ad_storage": "granted",
+              "ad_user_data": "granted",
+              "ad_personalization": "granted",
+              "analytics_storage": "granted"
+            }
+          ]
+        ]
+      },
+      "init": {
+        "title": "Initialization",
+        "description": "The destination installs d8a and configures a property with its server container URL.",
+        "in": {
+          "settings": {
+            "property_id": "80e1d6d0-560d-419f-ac2a-fe9281e93386",
+            "server_container_url": "https://global.t.d8a.tech/80e1d6d0-560d-419f-ac2a-fe9281e93386/d/c"
+          }
+        },
+        "out": [
+          [
+            "d8a",
+            "js",
+            {}
+          ],
+          [
+            "d8a",
+            "config",
+            "80e1d6d0-560d-419f-ac2a-fe9281e93386",
+            {
+              "server_container_url": "https://global.t.d8a.tech/80e1d6d0-560d-419f-ac2a-fe9281e93386/d/c"
+            }
+          ]
+        ]
+      },
+      "pageView": {
+        "title": "Page view",
+        "description": "A page view event is forwarded as a d8a page_view event.",
+        "in": {
+          "name": "page view",
+          "data": {
+            "domain": "www.example.com",
+            "title": "walkerOS documentation",
+            "referrer": "https://www.walkeros.io/",
+            "search": "?foo=bar",
+            "hash": "#hash",
+            "id": "/docs/"
+          },
+          "context": {
+            "dev": [
+              "test",
+              1
+            ]
+          },
+          "globals": {
+            "pagegroup": "docs"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "id": "us3r",
+            "device": "c00k13",
+            "session": "s3ss10n"
+          },
+          "nested": [
+            {
+              "entity": "child",
+              "data": {
+                "is": "subordinated"
+              }
+            }
+          ],
+          "consent": {
+            "functional": true
+          },
+          "id": "757ae8d849eca468",
+          "trigger": "load",
+          "entity": "page",
+          "action": "view",
+          "timestamp": 1700000300,
+          "timing": 3.14,
+          "source": {
+            "type": "collector",
+            "schema": "4"
+          }
+        },
+        "out": [
+          [
+            "d8a",
+            "event",
+            "page_view",
+            {
+              "send_to": "80e1d6d0-560d-419f-ac2a-fe9281e93386"
+            }
+          ]
+        ]
+      },
+      "purchase": {
+        "title": "Purchase",
+        "description": "An order complete event is mapped to the d8a purchase event with transaction details and nested product items.",
+        "in": {
+          "name": "order complete",
+          "data": {
+            "id": "0rd3r1d",
+            "currency": "EUR",
+            "shipping": 5.22,
+            "taxes": 73.76,
+            "total": 555
+          },
+          "context": {
+            "shopping": [
+              "complete",
+              0
+            ]
+          },
+          "globals": {
+            "pagegroup": "shop"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "id": "us3r",
+            "device": "c00k13",
+            "session": "s3ss10n"
+          },
+          "nested": [
+            {
+              "entity": "product",
+              "data": {
+                "id": "ers",
+                "name": "Everyday Ruck Snack",
+                "color": "black",
+                "size": "l",
+                "price": 420
+              },
+              "context": {
+                "shopping": [
+                  "complete",
+                  0
+                ]
+              },
+              "nested": []
+            },
+            {
+              "entity": "product",
+              "data": {
+                "id": "cc",
+                "name": "Cool Cap",
+                "size": "one size",
+                "price": 42
+              },
+              "context": {
+                "shopping": [
+                  "complete",
+                  0
+                ]
+              },
+              "nested": []
+            },
+            {
+              "entity": "gift",
+              "data": {
+                "name": "Surprise"
+              },
+              "context": {
+                "shopping": [
+                  "complete",
+                  0
+                ]
+              },
+              "nested": []
+            }
+          ],
+          "consent": {
+            "functional": true
+          },
+          "id": "68b32eb145e4fcbd",
+          "trigger": "load",
+          "entity": "order",
+          "action": "complete",
+          "timestamp": 1700000302,
+          "timing": 3.14,
+          "source": {
+            "type": "collector",
+            "schema": "4"
+          }
+        },
+        "mapping": {
+          "name": "purchase",
+          "include": [
+            "data",
+            "context"
+          ],
+          "data": {
+            "map": {
+              "transaction_id": "data.id",
+              "value": "data.total",
+              "tax": "data.taxes",
+              "shipping": "data.shipping",
+              "currency": {
+                "key": "data.currency",
+                "value": "EUR"
+              },
+              "items": {
+                "loop": [
+                  "nested",
+                  {
+                    "condition": {
+                      "$code": "e=>{const a=e;return k(e)&&\"product\"===a.entity}"
+                    },
+                    "map": {
+                      "item_id": "data.id",
+                      "item_name": "data.name",
+                      "quantity": {
+                        "key": "data.quantity",
+                        "value": 1
+                      }
+                    }
+                  }
+                ]
+              }
+            }
+          }
+        },
+        "out": [
+          [
+            "d8a",
+            "event",
+            "purchase",
+            {
+              "transaction_id": "0rd3r1d",
+              "value": 555,
+              "tax": 73.76,
+              "shipping": 5.22,
+              "currency": "EUR",
+              "items": [
+                {
+                  "item_id": "ers",
+                  "item_name": "Everyday Ruck Snack",
+                  "quantity": 1
+                },
+                {
+                  "item_id": "cc",
+                  "item_name": "Cool Cap",
+                  "quantity": 1
+                }
+              ],
+              "data_id": "0rd3r1d",
+              "data_currency": "EUR",
+              "data_shipping": 5.22,
+              "data_taxes": 73.76,
+              "data_total": 555,
+              "context_shopping": "complete",
+              "send_to": "80e1d6d0-560d-419f-ac2a-fe9281e93386"
+            }
+          ]
+        ]
+      }
+    }
+  }
+}

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "@walkeros/web-destination-d8a",
+  "description": "d8a web destination for walkerOS",
+  "version": "4.1.0",
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./examples": {
+      "types": "./dist/examples/index.d.ts",
+      "import": "./dist/examples/index.mjs",
+      "require": "./dist/examples/index.js"
+    },
+    "./dev": {
+      "types": "./dist/dev.d.ts",
+      "import": "./dist/dev.mjs",
+      "require": "./dist/dev.js"
+    },
+    "./walkerOS.json": "./dist/walkerOS.json"
+  },
+  "files": [
+    "dist/**"
+  ],
+  "scripts": {
+    "build": "tsup --silent",
+    "clean": "rm -rf .turbo && rm -rf dist",
+    "dev": "jest --watchAll --colors",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint \"**/*.ts*\"",
+    "test": "jest",
+    "update": "npx npm-check-updates -u && npm update"
+  },
+  "dependencies": {
+    "@d8a-tech/wt": "^1.2.1",
+    "@walkeros/core": "4.1.0",
+    "@walkeros/web-core": "4.1.0"
+  },
+  "devDependencies": {
+    "@walkeros/collector": "4.1.0"
+  },
+  "repository": {
+    "url": "git+https://github.com/elbwalker/walkerOS.git",
+    "directory": "packages/web/destinations/d8a"
+  },
+  "author": "elbwalker <hello@elbwalker.com>",
+  "homepage": "https://github.com/elbwalker/walkerOS#readme",
+  "bugs": {
+    "url": "https://github.com/elbwalker/walkerOS/issues"
+  },
+  "walkerOS": {
+    "type": "destination",
+    "platform": [
+      "web"
+    ],
+    "docs": "https://www.walkeros.io/docs/destinations/web/d8a"
+  },
+  "keywords": [
+    "walkerOS",
+    "walkerOS-destination",
+    "destination",
+    "web",
+    "d8a",
+    "analytics"
+  ],
+  "funding": [
+    {
+      "type": "GitHub Sponsors",
+      "url": "https://github.com/sponsors/elbwalker"
+    }
+  ]
+}