@walkeros/web-destination-clarity 3.4.0 → 3.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -98,7 +98,7 @@ function L(e2, t = {}, n = {}) {
98
98
  }
99
99
  function fe(e2 = {}) {
100
100
  var _a;
101
- 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 });
101
+ 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 });
102
102
  if (e2.name) {
103
103
  const [t2, n2] = (_a = e2.name.split(" ")) != null ? _a : [];
104
104
  t2 && n2 && (r.entity = t2, r.action = n2);
@@ -112,15 +112,20 @@ function le(e2 = "entity action", t = {}) {
112
112
 
113
113
  // src/examples/step.ts
114
114
  var defaultEventForwarding = {
115
+ title: "Default event",
116
+ description: "A walker event becomes a Clarity.event call with the event name as the Clarity custom event.",
115
117
  in: le("product view", { timestamp: 1700000100 }),
116
118
  out: [["clarity.event", "product view"]]
117
119
  };
118
120
  var wildcardIgnored = {
121
+ public: false,
119
122
  in: le("debug noise", { timestamp: 1700000101 }),
120
123
  mapping: { ignore: true },
121
124
  out: []
122
125
  };
123
126
  var userLoginIdentify = {
127
+ title: "User login identify",
128
+ description: "A user login fires Clarity.identify with custom id, session id, page id, and friendly name then tracks the event.",
124
129
  in: le("user login", {
125
130
  timestamp: 1700000102,
126
131
  data: { id: "u-123", name: "Jane Doe" },
@@ -144,6 +149,8 @@ var userLoginIdentify = {
144
149
  ]
145
150
  };
146
151
  var destinationLevelIdentify = {
152
+ title: "Destination identify",
153
+ description: "Destination-level identify calls Clarity.identify with the user id on every push as Clarity recommends.",
147
154
  in: le("page view", { timestamp: 1700000103 }),
148
155
  settings: {
149
156
  identify: {
@@ -158,6 +165,8 @@ var destinationLevelIdentify = {
158
165
  ]
159
166
  };
160
167
  var productViewWithTags = {
168
+ title: "Custom tags",
169
+ description: "A product view sets Clarity session tags such as product color and id before firing the event.",
161
170
  in: le("product view", { timestamp: 1700000104 }),
162
171
  mapping: {
163
172
  settings: {
@@ -176,6 +185,8 @@ var productViewWithTags = {
176
185
  ]
177
186
  };
178
187
  var arrayTagValue = {
188
+ title: "Array tag values",
189
+ description: "Array values such as product tags are passed through to Clarity.setTag preserving the array shape.",
179
190
  in: le("product view", {
180
191
  timestamp: 1700000105,
181
192
  data: {
@@ -202,6 +213,8 @@ var arrayTagValue = {
202
213
  ]
203
214
  };
204
215
  var orderCompleteUpgrade = {
216
+ title: "Upgrade session",
217
+ description: "A completed order upgrades the Clarity session priority so it is retained beyond the sampling cap.",
205
218
  in: le("order complete", { timestamp: 1700000106 }),
206
219
  mapping: {
207
220
  name: "Purchase",
@@ -215,6 +228,8 @@ var orderCompleteUpgrade = {
215
228
  ]
216
229
  };
217
230
  var orderCompleteInclude = {
231
+ title: "Include data as tags",
232
+ description: "A mapping include flattens the event data section into Clarity.setTag calls before the event fires.",
218
233
  in: le("order complete", { timestamp: 1700000107 }),
219
234
  mapping: {
220
235
  include: ["data"]
@@ -229,6 +244,8 @@ var orderCompleteInclude = {
229
244
  ]
230
245
  };
231
246
  var combinedFeatures = {
247
+ title: "Combined features",
248
+ description: "A purchase identifies the user, sets an order tag, upgrades the session, and fires the Clarity event in order.",
232
249
  in: le("order complete", { timestamp: 1700000108 }),
233
250
  mapping: {
234
251
  name: "Purchase",
@@ -246,6 +263,8 @@ var combinedFeatures = {
246
263
  ]
247
264
  };
248
265
  var pageViewSkip = {
266
+ title: "Tags without event",
267
+ description: "A page view sets Clarity tags while skip suppresses the event, letting Clarity handle page tracking itself.",
249
268
  in: le("page view", { timestamp: 1700000109 }),
250
269
  mapping: {
251
270
  skip: true,
@@ -260,6 +279,8 @@ var pageViewSkip = {
260
279
  out: [["clarity.setTag", "page_id", "/docs/"]]
261
280
  };
262
281
  var consentGrantBoth = {
282
+ title: "Consent granted",
283
+ description: "A walker consent command translates analytics and marketing grants into a Clarity.consentV2 call.",
263
284
  command: "consent",
264
285
  in: { analytics: true, marketing: true },
265
286
  settings: {
@@ -276,6 +297,8 @@ var consentGrantBoth = {
276
297
  ]
277
298
  };
278
299
  var consentRevoke = {
300
+ title: "Consent revoked",
301
+ description: "A walker consent command with analytics and marketing denied calls Clarity.consentV2 with denied flags.",
279
302
  command: "consent",
280
303
  in: { analytics: false, marketing: false },
281
304
  settings: {
@@ -77,7 +77,7 @@ function L(e2, t = {}, n = {}) {
77
77
  }
78
78
  function fe(e2 = {}) {
79
79
  var _a;
80
- 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 });
80
+ 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 });
81
81
  if (e2.name) {
82
82
  const [t2, n2] = (_a = e2.name.split(" ")) != null ? _a : [];
83
83
  t2 && n2 && (r.entity = t2, r.action = n2);
@@ -91,15 +91,20 @@ function le(e2 = "entity action", t = {}) {
91
91
 
92
92
  // src/examples/step.ts
93
93
  var defaultEventForwarding = {
94
+ title: "Default event",
95
+ description: "A walker event becomes a Clarity.event call with the event name as the Clarity custom event.",
94
96
  in: le("product view", { timestamp: 1700000100 }),
95
97
  out: [["clarity.event", "product view"]]
96
98
  };
97
99
  var wildcardIgnored = {
100
+ public: false,
98
101
  in: le("debug noise", { timestamp: 1700000101 }),
99
102
  mapping: { ignore: true },
100
103
  out: []
101
104
  };
102
105
  var userLoginIdentify = {
106
+ title: "User login identify",
107
+ description: "A user login fires Clarity.identify with custom id, session id, page id, and friendly name then tracks the event.",
103
108
  in: le("user login", {
104
109
  timestamp: 1700000102,
105
110
  data: { id: "u-123", name: "Jane Doe" },
@@ -123,6 +128,8 @@ var userLoginIdentify = {
123
128
  ]
124
129
  };
125
130
  var destinationLevelIdentify = {
131
+ title: "Destination identify",
132
+ description: "Destination-level identify calls Clarity.identify with the user id on every push as Clarity recommends.",
126
133
  in: le("page view", { timestamp: 1700000103 }),
127
134
  settings: {
128
135
  identify: {
@@ -137,6 +144,8 @@ var destinationLevelIdentify = {
137
144
  ]
138
145
  };
139
146
  var productViewWithTags = {
147
+ title: "Custom tags",
148
+ description: "A product view sets Clarity session tags such as product color and id before firing the event.",
140
149
  in: le("product view", { timestamp: 1700000104 }),
141
150
  mapping: {
142
151
  settings: {
@@ -155,6 +164,8 @@ var productViewWithTags = {
155
164
  ]
156
165
  };
157
166
  var arrayTagValue = {
167
+ title: "Array tag values",
168
+ description: "Array values such as product tags are passed through to Clarity.setTag preserving the array shape.",
158
169
  in: le("product view", {
159
170
  timestamp: 1700000105,
160
171
  data: {
@@ -181,6 +192,8 @@ var arrayTagValue = {
181
192
  ]
182
193
  };
183
194
  var orderCompleteUpgrade = {
195
+ title: "Upgrade session",
196
+ description: "A completed order upgrades the Clarity session priority so it is retained beyond the sampling cap.",
184
197
  in: le("order complete", { timestamp: 1700000106 }),
185
198
  mapping: {
186
199
  name: "Purchase",
@@ -194,6 +207,8 @@ var orderCompleteUpgrade = {
194
207
  ]
195
208
  };
196
209
  var orderCompleteInclude = {
210
+ title: "Include data as tags",
211
+ description: "A mapping include flattens the event data section into Clarity.setTag calls before the event fires.",
197
212
  in: le("order complete", { timestamp: 1700000107 }),
198
213
  mapping: {
199
214
  include: ["data"]
@@ -208,6 +223,8 @@ var orderCompleteInclude = {
208
223
  ]
209
224
  };
210
225
  var combinedFeatures = {
226
+ title: "Combined features",
227
+ description: "A purchase identifies the user, sets an order tag, upgrades the session, and fires the Clarity event in order.",
211
228
  in: le("order complete", { timestamp: 1700000108 }),
212
229
  mapping: {
213
230
  name: "Purchase",
@@ -225,6 +242,8 @@ var combinedFeatures = {
225
242
  ]
226
243
  };
227
244
  var pageViewSkip = {
245
+ title: "Tags without event",
246
+ description: "A page view sets Clarity tags while skip suppresses the event, letting Clarity handle page tracking itself.",
228
247
  in: le("page view", { timestamp: 1700000109 }),
229
248
  mapping: {
230
249
  skip: true,
@@ -239,6 +258,8 @@ var pageViewSkip = {
239
258
  out: [["clarity.setTag", "page_id", "/docs/"]]
240
259
  };
241
260
  var consentGrantBoth = {
261
+ title: "Consent granted",
262
+ description: "A walker consent command translates analytics and marketing grants into a Clarity.consentV2 call.",
242
263
  command: "consent",
243
264
  in: { analytics: true, marketing: true },
244
265
  settings: {
@@ -255,6 +276,8 @@ var consentGrantBoth = {
255
276
  ]
256
277
  };
257
278
  var consentRevoke = {
279
+ title: "Consent revoked",
280
+ description: "A walker consent command with analytics and marketing denied calls Clarity.consentV2 with denied flags.",
258
281
  command: "consent",
259
282
  in: { analytics: false, marketing: false },
260
283
  settings: {
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$meta": {
3
3
  "package": "@walkeros/web-destination-clarity",
4
- "version": "3.4.0",
4
+ "version": "3.4.1",
5
5
  "type": "destination",
6
6
  "platform": [
7
7
  "web"
@@ -116,6 +116,8 @@
116
116
  },
117
117
  "step": {
118
118
  "arrayTagValue": {
119
+ "title": "Array tag values",
120
+ "description": "Array values such as product tags are passed through to Clarity.setTag preserving the array shape.",
119
121
  "in": {
120
122
  "name": "product view",
121
123
  "data": {
@@ -159,7 +161,7 @@
159
161
  "group": "gr0up",
160
162
  "count": 1,
161
163
  "version": {
162
- "source": "3.4.0",
164
+ "source": "3.4.1",
163
165
  "tagging": 1
164
166
  },
165
167
  "source": {
@@ -193,6 +195,8 @@
193
195
  ]
194
196
  },
195
197
  "combinedFeatures": {
198
+ "title": "Combined features",
199
+ "description": "A purchase identifies the user, sets an order tag, upgrades the session, and fires the Clarity event in order.",
196
200
  "in": {
197
201
  "name": "order complete",
198
202
  "data": {
@@ -279,7 +283,7 @@
279
283
  "group": "gr0up",
280
284
  "count": 1,
281
285
  "version": {
282
- "source": "3.4.0",
286
+ "source": "3.4.1",
283
287
  "tagging": 1
284
288
  },
285
289
  "source": {
@@ -327,6 +331,8 @@
327
331
  ]
328
332
  },
329
333
  "consentGrantBoth": {
334
+ "title": "Consent granted",
335
+ "description": "A walker consent command translates analytics and marketing grants into a Clarity.consentV2 call.",
330
336
  "command": "consent",
331
337
  "in": {
332
338
  "analytics": true,
@@ -349,6 +355,8 @@
349
355
  ]
350
356
  },
351
357
  "consentRevoke": {
358
+ "title": "Consent revoked",
359
+ "description": "A walker consent command with analytics and marketing denied calls Clarity.consentV2 with denied flags.",
352
360
  "command": "consent",
353
361
  "in": {
354
362
  "analytics": false,
@@ -371,6 +379,8 @@
371
379
  ]
372
380
  },
373
381
  "defaultEventForwarding": {
382
+ "title": "Default event",
383
+ "description": "A walker event becomes a Clarity.event call with the event name as the Clarity custom event.",
374
384
  "in": {
375
385
  "name": "product view",
376
386
  "data": {
@@ -410,7 +420,7 @@
410
420
  "group": "gr0up",
411
421
  "count": 1,
412
422
  "version": {
413
- "source": "3.4.0",
423
+ "source": "3.4.1",
414
424
  "tagging": 1
415
425
  },
416
426
  "source": {
@@ -427,6 +437,8 @@
427
437
  ]
428
438
  },
429
439
  "destinationLevelIdentify": {
440
+ "title": "Destination identify",
441
+ "description": "Destination-level identify calls Clarity.identify with the user id on every push as Clarity recommends.",
430
442
  "in": {
431
443
  "name": "page view",
432
444
  "data": {
@@ -481,7 +493,7 @@
481
493
  "group": "gr0up",
482
494
  "count": 1,
483
495
  "version": {
484
- "source": "3.4.0",
496
+ "source": "3.4.1",
485
497
  "tagging": 1
486
498
  },
487
499
  "source": {
@@ -509,6 +521,8 @@
509
521
  ]
510
522
  },
511
523
  "orderCompleteInclude": {
524
+ "title": "Include data as tags",
525
+ "description": "A mapping include flattens the event data section into Clarity.setTag calls before the event fires.",
512
526
  "in": {
513
527
  "name": "order complete",
514
528
  "data": {
@@ -595,7 +609,7 @@
595
609
  "group": "gr0up",
596
610
  "count": 1,
597
611
  "version": {
598
- "source": "3.4.0",
612
+ "source": "3.4.1",
599
613
  "tagging": 1
600
614
  },
601
615
  "source": {
@@ -642,6 +656,8 @@
642
656
  ]
643
657
  },
644
658
  "orderCompleteUpgrade": {
659
+ "title": "Upgrade session",
660
+ "description": "A completed order upgrades the Clarity session priority so it is retained beyond the sampling cap.",
645
661
  "in": {
646
662
  "name": "order complete",
647
663
  "data": {
@@ -728,7 +744,7 @@
728
744
  "group": "gr0up",
729
745
  "count": 1,
730
746
  "version": {
731
- "source": "3.4.0",
747
+ "source": "3.4.1",
732
748
  "tagging": 1
733
749
  },
734
750
  "source": {
@@ -757,6 +773,8 @@
757
773
  ]
758
774
  },
759
775
  "pageViewSkip": {
776
+ "title": "Tags without event",
777
+ "description": "A page view sets Clarity tags while skip suppresses the event, letting Clarity handle page tracking itself.",
760
778
  "in": {
761
779
  "name": "page view",
762
780
  "data": {
@@ -811,7 +829,7 @@
811
829
  "group": "gr0up",
812
830
  "count": 1,
813
831
  "version": {
814
- "source": "3.4.0",
832
+ "source": "3.4.1",
815
833
  "tagging": 1
816
834
  },
817
835
  "source": {
@@ -839,6 +857,8 @@
839
857
  ]
840
858
  },
841
859
  "productViewWithTags": {
860
+ "title": "Custom tags",
861
+ "description": "A product view sets Clarity session tags such as product color and id before firing the event.",
842
862
  "in": {
843
863
  "name": "product view",
844
864
  "data": {
@@ -878,7 +898,7 @@
878
898
  "group": "gr0up",
879
899
  "count": 1,
880
900
  "version": {
881
- "source": "3.4.0",
901
+ "source": "3.4.1",
882
902
  "tagging": 1
883
903
  },
884
904
  "source": {
@@ -915,6 +935,8 @@
915
935
  ]
916
936
  },
917
937
  "userLoginIdentify": {
938
+ "title": "User login identify",
939
+ "description": "A user login fires Clarity.identify with custom id, session id, page id, and friendly name then tracks the event.",
918
940
  "in": {
919
941
  "name": "user login",
920
942
  "data": {
@@ -966,7 +988,7 @@
966
988
  "group": "gr0up",
967
989
  "count": 1,
968
990
  "version": {
969
- "source": "3.4.0",
991
+ "source": "3.4.1",
970
992
  "tagging": 1
971
993
  },
972
994
  "source": {
@@ -1002,6 +1024,7 @@
1002
1024
  ]
1003
1025
  },
1004
1026
  "wildcardIgnored": {
1027
+ "public": false,
1005
1028
  "in": {
1006
1029
  "name": "debug noise",
1007
1030
  "data": {
@@ -1058,7 +1081,7 @@
1058
1081
  "group": "gr0up",
1059
1082
  "count": 1,
1060
1083
  "version": {
1061
- "source": "3.4.0",
1084
+ "source": "3.4.1",
1062
1085
  "tagging": 1
1063
1086
  },
1064
1087
  "source": {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@walkeros/web-destination-clarity",
3
3
  "description": "Microsoft Clarity web destination for walkerOS (session replay, heatmaps, smart events)",
4
- "version": "3.4.0",
4
+ "version": "3.4.1",
5
5
  "license": "MIT",
6
6
  "main": "./dist/index.js",
7
7
  "module": "./dist/index.mjs",
@@ -38,10 +38,10 @@
38
38
  },
39
39
  "dependencies": {
40
40
  "@microsoft/clarity": "^1.0.2",
41
- "@walkeros/web-core": "3.4.0"
41
+ "@walkeros/web-core": "3.4.1"
42
42
  },
43
43
  "devDependencies": {
44
- "@walkeros/collector": "3.4.0"
44
+ "@walkeros/collector": "3.4.1"
45
45
  },
46
46
  "repository": {
47
47
  "url": "git+https://github.com/elbwalker/walkerOS.git",