@walkeros/web-destination-heap 3.4.0 → 3.4.1

package/dist/examples/index.js

@@ -100,7 +100,7 @@ function L(e2, t = {}, n = {}) {
 }
 function fe(e2 = {}) {
   var _a;
-  const t = e2.timestamp || (/* @__PURE__ */ new Date()).setHours(0, 13, 37, 0), n = e2.group || "gr0up", o = e2.count || 1, r = L({ name: "entity action", data: { string: "foo", number: 1, boolean: true, array: [0, "text", false], not: void 0 }, context: { dev: ["test", 1] }, globals: { lang: "elb" }, custom: { completely: "random" }, user: { id: "us3r", device: "c00k13", session: "s3ss10n" }, nested: [{ entity: "child", data: { is: "subordinated" }, nested: [], context: { element: ["child", 0] } }], consent: { functional: true }, id: `${t}-${n}-${o}`, trigger: "test", entity: "entity", action: "action", timestamp: t, timing: 3.14, group: n, count: o, version: { source: "3.4.0", tagging: 1 }, source: { type: "web", id: "https://localhost:80", previous_id: "http://remotehost:9001" } }, e2, { merge: false });
+  const t = e2.timestamp || (/* @__PURE__ */ new Date()).setHours(0, 13, 37, 0), n = e2.group || "gr0up", o = e2.count || 1, r = L({ name: "entity action", data: { string: "foo", number: 1, boolean: true, array: [0, "text", false], not: void 0 }, context: { dev: ["test", 1] }, globals: { lang: "elb" }, custom: { completely: "random" }, user: { id: "us3r", device: "c00k13", session: "s3ss10n" }, nested: [{ entity: "child", data: { is: "subordinated" }, nested: [], context: { element: ["child", 0] } }], consent: { functional: true }, id: `${t}-${n}-${o}`, trigger: "test", entity: "entity", action: "action", timestamp: t, timing: 3.14, group: n, count: o, version: { source: "3.4.1", tagging: 1 }, source: { type: "web", id: "https://localhost:80", previous_id: "http://remotehost:9001" } }, e2, { merge: false });
   if (e2.name) {
     const [t2, n2] = (_a = e2.name.split(" ")) != null ? _a : [];
     t2 && n2 && (r.entity = t2, r.action = n2);
@@ -114,10 +114,14 @@ function le(e2 = "entity action", t = {}) {
 
 // src/examples/step.ts
 var defaultEventForwarding = {
+  title: "Default track",
+  description: "A walker event becomes a Heap track call with the event name and empty properties.",
   in: le("product view", { timestamp: 1700000100 }),
   out: [["heap.track", "product view", {}]]
 };
 var destinationLevelInclude = {
+  title: "Renamed purchase",
+  description: "An order complete is renamed to purchase and mapped to Heap track properties such as order_id, total, and currency.",
   in: le("order complete", { timestamp: 1700000101 }),
   mapping: {
     name: "purchase",
@@ -138,6 +142,8 @@ var destinationLevelInclude = {
   ]
 };
 var destinationLevelIdentify = {
+  title: "Destination identify",
+  description: "Destination-level identify calls heap.identify with the user id before firing the default track.",
   in: le("page view", { timestamp: 1700000102 }),
   settings: {
     identify: "user.id"
@@ -148,6 +154,8 @@ var destinationLevelIdentify = {
   ]
 };
 var userLoginIdentify = {
+  title: "User login identify",
+  description: "A user login identifies the Heap user by email and adds user properties while skipping the track.",
   in: le("user login", {
     timestamp: 1700000103,
     data: {
@@ -174,6 +182,8 @@ var userLoginIdentify = {
   ]
 };
 var userLogoutReset = {
+  title: "User logout reset",
+  description: "A user logout calls heap.resetIdentity to clear the identified user from the Heap client.",
   in: le("user logout", { timestamp: 1700000104 }),
   mapping: {
     skip: true,
@@ -184,6 +194,8 @@ var userLogoutReset = {
   out: [["heap.resetIdentity"]]
 };
 var eventWithUserProperties = {
+  title: "User properties on event",
+  description: "An order fires Heap addUserProperties with last-order fields and then tracks the event.",
   in: le("order complete", {
     timestamp: 1700000105,
     data: {
@@ -211,6 +223,8 @@ var eventWithUserProperties = {
   ]
 };
 var globalEventProperties = {
+  title: "Global event properties",
+  description: "A page view sets persistent Heap event properties so all subsequent events include the page category.",
   in: le("page view", {
     timestamp: 1700000106,
     data: { category: "docs" }
@@ -228,11 +242,15 @@ var globalEventProperties = {
   out: [["heap.addEventProperties", { page_category: "docs" }]]
 };
 var consentRevokeStopTracking = {
+  title: "Consent revoked",
+  description: "A walker consent revoke for analytics calls heap.stopTracking to pause event capture.",
   command: "consent",
   in: { analytics: false },
   out: [["heap.stopTracking"]]
 };
 var consentGrantStartTracking = {
+  title: "Consent granted",
+  description: "A walker consent grant for analytics calls heap.startTracking to resume event capture.",
   command: "consent",
   in: { analytics: true },
   out: [["heap.startTracking"]]

package/dist/examples/index.mjs

@@ -79,7 +79,7 @@ function L(e2, t = {}, n = {}) {
 }
 function fe(e2 = {}) {
   var _a;
-  const t = e2.timestamp || (/* @__PURE__ */ new Date()).setHours(0, 13, 37, 0), n = e2.group || "gr0up", o = e2.count || 1, r = L({ name: "entity action", data: { string: "foo", number: 1, boolean: true, array: [0, "text", false], not: void 0 }, context: { dev: ["test", 1] }, globals: { lang: "elb" }, custom: { completely: "random" }, user: { id: "us3r", device: "c00k13", session: "s3ss10n" }, nested: [{ entity: "child", data: { is: "subordinated" }, nested: [], context: { element: ["child", 0] } }], consent: { functional: true }, id: `${t}-${n}-${o}`, trigger: "test", entity: "entity", action: "action", timestamp: t, timing: 3.14, group: n, count: o, version: { source: "3.4.0", tagging: 1 }, source: { type: "web", id: "https://localhost:80", previous_id: "http://remotehost:9001" } }, e2, { merge: false });
+  const t = e2.timestamp || (/* @__PURE__ */ new Date()).setHours(0, 13, 37, 0), n = e2.group || "gr0up", o = e2.count || 1, r = L({ name: "entity action", data: { string: "foo", number: 1, boolean: true, array: [0, "text", false], not: void 0 }, context: { dev: ["test", 1] }, globals: { lang: "elb" }, custom: { completely: "random" }, user: { id: "us3r", device: "c00k13", session: "s3ss10n" }, nested: [{ entity: "child", data: { is: "subordinated" }, nested: [], context: { element: ["child", 0] } }], consent: { functional: true }, id: `${t}-${n}-${o}`, trigger: "test", entity: "entity", action: "action", timestamp: t, timing: 3.14, group: n, count: o, version: { source: "3.4.1", tagging: 1 }, source: { type: "web", id: "https://localhost:80", previous_id: "http://remotehost:9001" } }, e2, { merge: false });
   if (e2.name) {
     const [t2, n2] = (_a = e2.name.split(" ")) != null ? _a : [];
     t2 && n2 && (r.entity = t2, r.action = n2);
@@ -93,10 +93,14 @@ function le(e2 = "entity action", t = {}) {
 
 // src/examples/step.ts
 var defaultEventForwarding = {
+  title: "Default track",
+  description: "A walker event becomes a Heap track call with the event name and empty properties.",
   in: le("product view", { timestamp: 1700000100 }),
   out: [["heap.track", "product view", {}]]
 };
 var destinationLevelInclude = {
+  title: "Renamed purchase",
+  description: "An order complete is renamed to purchase and mapped to Heap track properties such as order_id, total, and currency.",
   in: le("order complete", { timestamp: 1700000101 }),
   mapping: {
     name: "purchase",
@@ -117,6 +121,8 @@ var destinationLevelInclude = {
   ]
 };
 var destinationLevelIdentify = {
+  title: "Destination identify",
+  description: "Destination-level identify calls heap.identify with the user id before firing the default track.",
   in: le("page view", { timestamp: 1700000102 }),
   settings: {
     identify: "user.id"
@@ -127,6 +133,8 @@ var destinationLevelIdentify = {
   ]
 };
 var userLoginIdentify = {
+  title: "User login identify",
+  description: "A user login identifies the Heap user by email and adds user properties while skipping the track.",
   in: le("user login", {
     timestamp: 1700000103,
     data: {
@@ -153,6 +161,8 @@ var userLoginIdentify = {
   ]
 };
 var userLogoutReset = {
+  title: "User logout reset",
+  description: "A user logout calls heap.resetIdentity to clear the identified user from the Heap client.",
   in: le("user logout", { timestamp: 1700000104 }),
   mapping: {
     skip: true,
@@ -163,6 +173,8 @@ var userLogoutReset = {
   out: [["heap.resetIdentity"]]
 };
 var eventWithUserProperties = {
+  title: "User properties on event",
+  description: "An order fires Heap addUserProperties with last-order fields and then tracks the event.",
   in: le("order complete", {
     timestamp: 1700000105,
     data: {
@@ -190,6 +202,8 @@ var eventWithUserProperties = {
   ]
 };
 var globalEventProperties = {
+  title: "Global event properties",
+  description: "A page view sets persistent Heap event properties so all subsequent events include the page category.",
   in: le("page view", {
     timestamp: 1700000106,
     data: { category: "docs" }
@@ -207,11 +221,15 @@ var globalEventProperties = {
   out: [["heap.addEventProperties", { page_category: "docs" }]]
 };
 var consentRevokeStopTracking = {
+  title: "Consent revoked",
+  description: "A walker consent revoke for analytics calls heap.stopTracking to pause event capture.",
   command: "consent",
   in: { analytics: false },
   out: [["heap.stopTracking"]]
 };
 var consentGrantStartTracking = {
+  title: "Consent granted",
+  description: "A walker consent grant for analytics calls heap.startTracking to resume event capture.",
   command: "consent",
   in: { analytics: true },
   out: [["heap.startTracking"]]

package/dist/walkerOS.json

@@ -1,7 +1,7 @@
 {
   "$meta": {
     "package": "@walkeros/web-destination-heap",
-    "version": "3.4.0",
+    "version": "3.4.1",
     "type": "destination",
     "platform": [
       "web"
@@ -156,6 +156,8 @@
     },
     "step": {
       "consentGrantStartTracking": {
+        "title": "Consent granted",
+        "description": "A walker consent grant for analytics calls heap.startTracking to resume event capture.",
         "command": "consent",
         "in": {
           "analytics": true
@@ -167,6 +169,8 @@
         ]
       },
       "consentRevokeStopTracking": {
+        "title": "Consent revoked",
+        "description": "A walker consent revoke for analytics calls heap.stopTracking to pause event capture.",
         "command": "consent",
         "in": {
           "analytics": false
@@ -178,6 +182,8 @@
         ]
       },
       "defaultEventForwarding": {
+        "title": "Default track",
+        "description": "A walker event becomes a Heap track call with the event name and empty properties.",
         "in": {
           "name": "product view",
           "data": {
@@ -217,7 +223,7 @@
           "group": "gr0up",
           "count": 1,
           "version": {
-            "source": "3.4.0",
+            "source": "3.4.1",
             "tagging": 1
           },
           "source": {
@@ -235,6 +241,8 @@
         ]
       },
       "destinationLevelIdentify": {
+        "title": "Destination identify",
+        "description": "Destination-level identify calls heap.identify with the user id before firing the default track.",
         "in": {
           "name": "page view",
           "data": {
@@ -289,7 +297,7 @@
           "group": "gr0up",
           "count": 1,
           "version": {
-            "source": "3.4.0",
+            "source": "3.4.1",
             "tagging": 1
           },
           "source": {
@@ -314,6 +322,8 @@
         ]
       },
       "destinationLevelInclude": {
+        "title": "Renamed purchase",
+        "description": "An order complete is renamed to purchase and mapped to Heap track properties such as order_id, total, and currency.",
         "in": {
           "name": "order complete",
           "data": {
@@ -400,7 +410,7 @@
           "group": "gr0up",
           "count": 1,
           "version": {
-            "source": "3.4.0",
+            "source": "3.4.1",
             "tagging": 1
           },
           "source": {
@@ -435,6 +445,8 @@
         ]
       },
       "eventWithUserProperties": {
+        "title": "User properties on event",
+        "description": "An order fires Heap addUserProperties with last-order fields and then tracks the event.",
         "in": {
           "name": "order complete",
           "data": {
@@ -519,7 +531,7 @@
           "group": "gr0up",
           "count": 1,
           "version": {
-            "source": "3.4.0",
+            "source": "3.4.1",
             "tagging": 1
           },
           "source": {
@@ -554,6 +566,8 @@
         ]
       },
       "globalEventProperties": {
+        "title": "Global event properties",
+        "description": "A page view sets persistent Heap event properties so all subsequent events include the page category.",
         "in": {
           "name": "page view",
           "data": {
@@ -603,7 +617,7 @@
           "group": "gr0up",
           "count": 1,
           "version": {
-            "source": "3.4.0",
+            "source": "3.4.1",
             "tagging": 1
           },
           "source": {
@@ -632,6 +646,8 @@
         ]
       },
       "userLoginIdentify": {
+        "title": "User login identify",
+        "description": "A user login identifies the Heap user by email and adds user properties while skipping the track.",
         "in": {
           "name": "user login",
           "data": {
@@ -683,7 +699,7 @@
           "group": "gr0up",
           "count": 1,
           "version": {
-            "source": "3.4.0",
+            "source": "3.4.1",
             "tagging": 1
           },
           "source": {
@@ -719,6 +735,8 @@
         ]
       },
       "userLogoutReset": {
+        "title": "User logout reset",
+        "description": "A user logout calls heap.resetIdentity to clear the identified user from the Heap client.",
         "in": {
           "name": "user logout",
           "data": {
@@ -775,7 +793,7 @@
           "group": "gr0up",
           "count": 1,
           "version": {
-            "source": "3.4.0",
+            "source": "3.4.1",
             "tagging": 1
           },
           "source": {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@walkeros/web-destination-heap",
   "description": "Heap web destination for walkerOS (product analytics, auto-capture)",
-  "version": "3.4.0",
+  "version": "3.4.1",
   "license": "MIT",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -37,10 +37,10 @@
     "update": "npx npm-check-updates -u && npm update"
   },
   "dependencies": {
-    "@walkeros/web-core": "3.4.0"
+    "@walkeros/web-core": "3.4.1"
   },
   "devDependencies": {
-    "@walkeros/collector": "3.4.0"
+    "@walkeros/collector": "3.4.1"
   },
   "repository": {
     "url": "git+https://github.com/elbwalker/walkerOS.git",