@walkeros/web-destination-heap 3.4.0-next-1776749829492

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.
@@ -0,0 +1,801 @@
1
+ {
2
+ "$meta": {
3
+ "package": "@walkeros/web-destination-heap",
4
+ "version": "3.4.0-next-1776749829492",
5
+ "type": "destination",
6
+ "platform": [
7
+ "web"
8
+ ],
9
+ "docs": "https://www.walkeros.io/docs/destinations/web/heap",
10
+ "source": "https://github.com/elbwalker/walkerOS/tree/main/packages/web/destinations/heap/src"
11
+ },
12
+ "schemas": {
13
+ "mapping": {
14
+ "$schema": "http://json-schema.org/draft-07/schema#",
15
+ "type": "object",
16
+ "properties": {
17
+ "identify": {
18
+ "description": "Per-event identity. Resolves to a string for heap.identify(). Example: { \"key\": \"data.email\" }."
19
+ },
20
+ "reset": {
21
+ "description": "Reset Heap identity on this event. Set to true to call heap.resetIdentity()."
22
+ },
23
+ "userProperties": {
24
+ "description": "Per-event user properties. Resolves to object for heap.addUserProperties()."
25
+ },
26
+ "eventProperties": {
27
+ "description": "Per-event persistent event properties. Resolves to object for heap.addEventProperties() (persisted across page loads)."
28
+ },
29
+ "clearEventProperties": {
30
+ "description": "Clear all persistent event properties. Set to true to call heap.clearEventProperties()."
31
+ }
32
+ },
33
+ "additionalProperties": false
34
+ },
35
+ "settings": {
36
+ "$schema": "http://json-schema.org/draft-07/schema#",
37
+ "type": "object",
38
+ "properties": {
39
+ "appId": {
40
+ "type": "string",
41
+ "minLength": 1,
42
+ "description": "Heap App ID. Find it in your Heap project under Settings > App ID."
43
+ },
44
+ "disableTextCapture": {
45
+ "type": "boolean",
46
+ "description": "Disable Heap auto text capture. Default: true."
47
+ },
48
+ "disablePageviewAutocapture": {
49
+ "type": "boolean",
50
+ "description": "Disable Heap automatic pageview tracking. Default: true (walkerOS sources handle pageviews)."
51
+ },
52
+ "disableSessionReplay": {
53
+ "type": "boolean",
54
+ "description": "Disable Heap session replay."
55
+ },
56
+ "secureCookie": {
57
+ "type": "boolean",
58
+ "description": "SSL-only cookies."
59
+ },
60
+ "ingestServer": {
61
+ "type": "string",
62
+ "format": "uri",
63
+ "description": "Custom server endpoint for proxying Heap data."
64
+ },
65
+ "identify": {
66
+ "description": "Destination-level identity mapping. Resolves to a string for heap.identify(). Example: { \"key\": \"user.id\" }."
67
+ },
68
+ "userProperties": {
69
+ "description": "Destination-level user properties mapping. Resolves to object for heap.addUserProperties(). Example: { \"map\": { \"plan\": \"data.plan\" } }."
70
+ }
71
+ },
72
+ "required": [
73
+ "appId"
74
+ ],
75
+ "additionalProperties": false
76
+ }
77
+ },
78
+ "examples": {
79
+ "env": {
80
+ "init": {
81
+ "window": {
82
+ "heap": {
83
+ "load": {
84
+ "$code": "()=>{}"
85
+ },
86
+ "track": {
87
+ "$code": "()=>{}"
88
+ },
89
+ "identify": {
90
+ "$code": "()=>{}"
91
+ },
92
+ "resetIdentity": {
93
+ "$code": "()=>{}"
94
+ },
95
+ "addUserProperties": {
96
+ "$code": "()=>{}"
97
+ },
98
+ "addEventProperties": {
99
+ "$code": "()=>{}"
100
+ },
101
+ "clearEventProperties": {
102
+ "$code": "()=>{}"
103
+ },
104
+ "startTracking": {
105
+ "$code": "()=>{}"
106
+ },
107
+ "stopTracking": {
108
+ "$code": "()=>{}"
109
+ }
110
+ }
111
+ }
112
+ },
113
+ "push": {
114
+ "window": {
115
+ "heap": {
116
+ "load": {
117
+ "$code": "()=>{}"
118
+ },
119
+ "track": {
120
+ "$code": "()=>{}"
121
+ },
122
+ "identify": {
123
+ "$code": "()=>{}"
124
+ },
125
+ "resetIdentity": {
126
+ "$code": "()=>{}"
127
+ },
128
+ "addUserProperties": {
129
+ "$code": "()=>{}"
130
+ },
131
+ "addEventProperties": {
132
+ "$code": "()=>{}"
133
+ },
134
+ "clearEventProperties": {
135
+ "$code": "()=>{}"
136
+ },
137
+ "startTracking": {
138
+ "$code": "()=>{}"
139
+ },
140
+ "stopTracking": {
141
+ "$code": "()=>{}"
142
+ }
143
+ }
144
+ }
145
+ },
146
+ "simulation": [
147
+ "call:window.heap.track",
148
+ "call:window.heap.identify",
149
+ "call:window.heap.resetIdentity",
150
+ "call:window.heap.addUserProperties",
151
+ "call:window.heap.addEventProperties",
152
+ "call:window.heap.clearEventProperties",
153
+ "call:window.heap.startTracking",
154
+ "call:window.heap.stopTracking"
155
+ ]
156
+ },
157
+ "step": {
158
+ "consentGrantStartTracking": {
159
+ "command": "consent",
160
+ "in": {
161
+ "analytics": true
162
+ },
163
+ "out": [
164
+ [
165
+ "heap.startTracking"
166
+ ]
167
+ ]
168
+ },
169
+ "consentRevokeStopTracking": {
170
+ "command": "consent",
171
+ "in": {
172
+ "analytics": false
173
+ },
174
+ "out": [
175
+ [
176
+ "heap.stopTracking"
177
+ ]
178
+ ]
179
+ },
180
+ "defaultEventForwarding": {
181
+ "in": {
182
+ "name": "product view",
183
+ "data": {
184
+ "id": "ers",
185
+ "name": "Everyday Ruck Snack",
186
+ "color": "black",
187
+ "size": "l",
188
+ "price": 420
189
+ },
190
+ "context": {
191
+ "shopping": [
192
+ "detail",
193
+ 0
194
+ ]
195
+ },
196
+ "globals": {
197
+ "pagegroup": "shop"
198
+ },
199
+ "custom": {
200
+ "completely": "random"
201
+ },
202
+ "user": {
203
+ "id": "us3r",
204
+ "device": "c00k13",
205
+ "session": "s3ss10n"
206
+ },
207
+ "nested": [],
208
+ "consent": {
209
+ "functional": true
210
+ },
211
+ "id": "1700000100-gr0up-1",
212
+ "trigger": "load",
213
+ "entity": "product",
214
+ "action": "view",
215
+ "timestamp": 1700000100,
216
+ "timing": 3.14,
217
+ "group": "gr0up",
218
+ "count": 1,
219
+ "version": {
220
+ "source": "3.4.0-next-1776749829492",
221
+ "tagging": 1
222
+ },
223
+ "source": {
224
+ "type": "web",
225
+ "id": "https://localhost:80",
226
+ "previous_id": "http://remotehost:9001"
227
+ }
228
+ },
229
+ "out": [
230
+ [
231
+ "heap.track",
232
+ "product view",
233
+ {}
234
+ ]
235
+ ]
236
+ },
237
+ "destinationLevelIdentify": {
238
+ "in": {
239
+ "name": "page view",
240
+ "data": {
241
+ "domain": "www.example.com",
242
+ "title": "walkerOS documentation",
243
+ "referrer": "https://www.walkeros.io/",
244
+ "search": "?foo=bar",
245
+ "hash": "#hash",
246
+ "id": "/docs/"
247
+ },
248
+ "context": {
249
+ "dev": [
250
+ "test",
251
+ 1
252
+ ]
253
+ },
254
+ "globals": {
255
+ "pagegroup": "docs"
256
+ },
257
+ "custom": {
258
+ "completely": "random"
259
+ },
260
+ "user": {
261
+ "id": "us3r",
262
+ "device": "c00k13",
263
+ "session": "s3ss10n"
264
+ },
265
+ "nested": [
266
+ {
267
+ "entity": "child",
268
+ "data": {
269
+ "is": "subordinated"
270
+ },
271
+ "nested": [],
272
+ "context": {
273
+ "element": [
274
+ "child",
275
+ 0
276
+ ]
277
+ }
278
+ }
279
+ ],
280
+ "consent": {
281
+ "functional": true
282
+ },
283
+ "id": "1700000102-gr0up-1",
284
+ "trigger": "load",
285
+ "entity": "page",
286
+ "action": "view",
287
+ "timestamp": 1700000102,
288
+ "timing": 3.14,
289
+ "group": "gr0up",
290
+ "count": 1,
291
+ "version": {
292
+ "source": "3.4.0-next-1776749829492",
293
+ "tagging": 1
294
+ },
295
+ "source": {
296
+ "type": "web",
297
+ "id": "https://localhost:80",
298
+ "previous_id": "http://remotehost:9001"
299
+ }
300
+ },
301
+ "settings": {
302
+ "identify": "user.id"
303
+ },
304
+ "out": [
305
+ [
306
+ "heap.identify",
307
+ "us3r"
308
+ ],
309
+ [
310
+ "heap.track",
311
+ "page view",
312
+ {}
313
+ ]
314
+ ]
315
+ },
316
+ "destinationLevelInclude": {
317
+ "in": {
318
+ "name": "order complete",
319
+ "data": {
320
+ "id": "0rd3r1d",
321
+ "currency": "EUR",
322
+ "shipping": 5.22,
323
+ "taxes": 73.76,
324
+ "total": 555
325
+ },
326
+ "context": {
327
+ "shopping": [
328
+ "complete",
329
+ 0
330
+ ]
331
+ },
332
+ "globals": {
333
+ "pagegroup": "shop"
334
+ },
335
+ "custom": {
336
+ "completely": "random"
337
+ },
338
+ "user": {
339
+ "id": "us3r",
340
+ "device": "c00k13",
341
+ "session": "s3ss10n"
342
+ },
343
+ "nested": [
344
+ {
345
+ "entity": "product",
346
+ "data": {
347
+ "id": "ers",
348
+ "name": "Everyday Ruck Snack",
349
+ "color": "black",
350
+ "size": "l",
351
+ "price": 420
352
+ },
353
+ "context": {
354
+ "shopping": [
355
+ "complete",
356
+ 0
357
+ ]
358
+ },
359
+ "nested": []
360
+ },
361
+ {
362
+ "entity": "product",
363
+ "data": {
364
+ "id": "cc",
365
+ "name": "Cool Cap",
366
+ "size": "one size",
367
+ "price": 42
368
+ },
369
+ "context": {
370
+ "shopping": [
371
+ "complete",
372
+ 0
373
+ ]
374
+ },
375
+ "nested": []
376
+ },
377
+ {
378
+ "entity": "gift",
379
+ "data": {
380
+ "name": "Surprise"
381
+ },
382
+ "context": {
383
+ "shopping": [
384
+ "complete",
385
+ 0
386
+ ]
387
+ },
388
+ "nested": []
389
+ }
390
+ ],
391
+ "consent": {
392
+ "functional": true
393
+ },
394
+ "id": "1700000101-gr0up-1",
395
+ "trigger": "load",
396
+ "entity": "order",
397
+ "action": "complete",
398
+ "timestamp": 1700000101,
399
+ "timing": 3.14,
400
+ "group": "gr0up",
401
+ "count": 1,
402
+ "version": {
403
+ "source": "3.4.0-next-1776749829492",
404
+ "tagging": 1
405
+ },
406
+ "source": {
407
+ "type": "web",
408
+ "id": "https://localhost:80",
409
+ "previous_id": "http://remotehost:9001"
410
+ }
411
+ },
412
+ "mapping": {
413
+ "name": "purchase",
414
+ "data": {
415
+ "map": {
416
+ "order_id": "data.id",
417
+ "total": "data.total",
418
+ "currency": {
419
+ "key": "data.currency",
420
+ "value": "EUR"
421
+ }
422
+ }
423
+ }
424
+ },
425
+ "out": [
426
+ [
427
+ "heap.track",
428
+ "purchase",
429
+ {
430
+ "order_id": "0rd3r1d",
431
+ "total": 555,
432
+ "currency": "EUR"
433
+ }
434
+ ]
435
+ ]
436
+ },
437
+ "eventWithUserProperties": {
438
+ "in": {
439
+ "name": "order complete",
440
+ "data": {
441
+ "id": "0rd3r1d",
442
+ "total": 555,
443
+ "currency": "EUR"
444
+ },
445
+ "context": {
446
+ "shopping": [
447
+ "complete",
448
+ 0
449
+ ]
450
+ },
451
+ "globals": {
452
+ "pagegroup": "shop"
453
+ },
454
+ "custom": {
455
+ "completely": "random"
456
+ },
457
+ "user": {
458
+ "id": "us3r",
459
+ "device": "c00k13",
460
+ "session": "s3ss10n"
461
+ },
462
+ "nested": [
463
+ {
464
+ "entity": "product",
465
+ "data": {
466
+ "id": "ers",
467
+ "name": "Everyday Ruck Snack",
468
+ "color": "black",
469
+ "size": "l",
470
+ "price": 420
471
+ },
472
+ "context": {
473
+ "shopping": [
474
+ "complete",
475
+ 0
476
+ ]
477
+ },
478
+ "nested": []
479
+ },
480
+ {
481
+ "entity": "product",
482
+ "data": {
483
+ "id": "cc",
484
+ "name": "Cool Cap",
485
+ "size": "one size",
486
+ "price": 42
487
+ },
488
+ "context": {
489
+ "shopping": [
490
+ "complete",
491
+ 0
492
+ ]
493
+ },
494
+ "nested": []
495
+ },
496
+ {
497
+ "entity": "gift",
498
+ "data": {
499
+ "name": "Surprise"
500
+ },
501
+ "context": {
502
+ "shopping": [
503
+ "complete",
504
+ 0
505
+ ]
506
+ },
507
+ "nested": []
508
+ }
509
+ ],
510
+ "consent": {
511
+ "functional": true
512
+ },
513
+ "id": "1700000105-gr0up-1",
514
+ "trigger": "load",
515
+ "entity": "order",
516
+ "action": "complete",
517
+ "timestamp": 1700000105,
518
+ "timing": 3.14,
519
+ "group": "gr0up",
520
+ "count": 1,
521
+ "version": {
522
+ "source": "3.4.0-next-1776749829492",
523
+ "tagging": 1
524
+ },
525
+ "source": {
526
+ "type": "web",
527
+ "id": "https://localhost:80",
528
+ "previous_id": "http://remotehost:9001"
529
+ }
530
+ },
531
+ "mapping": {
532
+ "settings": {
533
+ "userProperties": {
534
+ "map": {
535
+ "last_order_value": "data.total",
536
+ "last_order_currency": "data.currency"
537
+ }
538
+ }
539
+ }
540
+ },
541
+ "out": [
542
+ [
543
+ "heap.addUserProperties",
544
+ {
545
+ "last_order_value": 555,
546
+ "last_order_currency": "EUR"
547
+ }
548
+ ],
549
+ [
550
+ "heap.track",
551
+ "order complete",
552
+ {}
553
+ ]
554
+ ]
555
+ },
556
+ "globalEventProperties": {
557
+ "in": {
558
+ "name": "page view",
559
+ "data": {
560
+ "category": "docs"
561
+ },
562
+ "context": {
563
+ "dev": [
564
+ "test",
565
+ 1
566
+ ]
567
+ },
568
+ "globals": {
569
+ "pagegroup": "docs"
570
+ },
571
+ "custom": {
572
+ "completely": "random"
573
+ },
574
+ "user": {
575
+ "id": "us3r",
576
+ "device": "c00k13",
577
+ "session": "s3ss10n"
578
+ },
579
+ "nested": [
580
+ {
581
+ "entity": "child",
582
+ "data": {
583
+ "is": "subordinated"
584
+ },
585
+ "nested": [],
586
+ "context": {
587
+ "element": [
588
+ "child",
589
+ 0
590
+ ]
591
+ }
592
+ }
593
+ ],
594
+ "consent": {
595
+ "functional": true
596
+ },
597
+ "id": "1700000106-gr0up-1",
598
+ "trigger": "load",
599
+ "entity": "page",
600
+ "action": "view",
601
+ "timestamp": 1700000106,
602
+ "timing": 3.14,
603
+ "group": "gr0up",
604
+ "count": 1,
605
+ "version": {
606
+ "source": "3.4.0-next-1776749829492",
607
+ "tagging": 1
608
+ },
609
+ "source": {
610
+ "type": "web",
611
+ "id": "https://localhost:80",
612
+ "previous_id": "http://remotehost:9001"
613
+ }
614
+ },
615
+ "mapping": {
616
+ "skip": true,
617
+ "settings": {
618
+ "eventProperties": {
619
+ "map": {
620
+ "page_category": "data.category"
621
+ }
622
+ }
623
+ }
624
+ },
625
+ "out": [
626
+ [
627
+ "heap.addEventProperties",
628
+ {
629
+ "page_category": "docs"
630
+ }
631
+ ]
632
+ ]
633
+ },
634
+ "userLoginIdentify": {
635
+ "in": {
636
+ "name": "user login",
637
+ "data": {
638
+ "email": "user@example.com",
639
+ "plan": "premium",
640
+ "company": "Acme"
641
+ },
642
+ "context": {
643
+ "dev": [
644
+ "test",
645
+ 1
646
+ ]
647
+ },
648
+ "globals": {
649
+ "lang": "elb"
650
+ },
651
+ "custom": {
652
+ "completely": "random"
653
+ },
654
+ "user": {
655
+ "id": "us3r",
656
+ "device": "c00k13",
657
+ "session": "s3ss10n"
658
+ },
659
+ "nested": [
660
+ {
661
+ "entity": "child",
662
+ "data": {
663
+ "is": "subordinated"
664
+ },
665
+ "nested": [],
666
+ "context": {
667
+ "element": [
668
+ "child",
669
+ 0
670
+ ]
671
+ }
672
+ }
673
+ ],
674
+ "consent": {
675
+ "functional": true
676
+ },
677
+ "id": "1700000103-gr0up-1",
678
+ "trigger": "test",
679
+ "entity": "user",
680
+ "action": "login",
681
+ "timestamp": 1700000103,
682
+ "timing": 3.14,
683
+ "group": "gr0up",
684
+ "count": 1,
685
+ "version": {
686
+ "source": "3.4.0-next-1776749829492",
687
+ "tagging": 1
688
+ },
689
+ "source": {
690
+ "type": "web",
691
+ "id": "https://localhost:80",
692
+ "previous_id": "http://remotehost:9001"
693
+ }
694
+ },
695
+ "mapping": {
696
+ "skip": true,
697
+ "settings": {
698
+ "identify": "data.email",
699
+ "userProperties": {
700
+ "map": {
701
+ "plan": "data.plan",
702
+ "company": "data.company"
703
+ }
704
+ }
705
+ }
706
+ },
707
+ "out": [
708
+ [
709
+ "heap.identify",
710
+ "user@example.com"
711
+ ],
712
+ [
713
+ "heap.addUserProperties",
714
+ {
715
+ "plan": "premium",
716
+ "company": "Acme"
717
+ }
718
+ ]
719
+ ]
720
+ },
721
+ "userLogoutReset": {
722
+ "in": {
723
+ "name": "user logout",
724
+ "data": {
725
+ "string": "foo",
726
+ "number": 1,
727
+ "boolean": true,
728
+ "array": [
729
+ 0,
730
+ "text",
731
+ false
732
+ ]
733
+ },
734
+ "context": {
735
+ "dev": [
736
+ "test",
737
+ 1
738
+ ]
739
+ },
740
+ "globals": {
741
+ "lang": "elb"
742
+ },
743
+ "custom": {
744
+ "completely": "random"
745
+ },
746
+ "user": {
747
+ "id": "us3r",
748
+ "device": "c00k13",
749
+ "session": "s3ss10n"
750
+ },
751
+ "nested": [
752
+ {
753
+ "entity": "child",
754
+ "data": {
755
+ "is": "subordinated"
756
+ },
757
+ "nested": [],
758
+ "context": {
759
+ "element": [
760
+ "child",
761
+ 0
762
+ ]
763
+ }
764
+ }
765
+ ],
766
+ "consent": {
767
+ "functional": true
768
+ },
769
+ "id": "1700000104-gr0up-1",
770
+ "trigger": "test",
771
+ "entity": "user",
772
+ "action": "logout",
773
+ "timestamp": 1700000104,
774
+ "timing": 3.14,
775
+ "group": "gr0up",
776
+ "count": 1,
777
+ "version": {
778
+ "source": "3.4.0-next-1776749829492",
779
+ "tagging": 1
780
+ },
781
+ "source": {
782
+ "type": "web",
783
+ "id": "https://localhost:80",
784
+ "previous_id": "http://remotehost:9001"
785
+ }
786
+ },
787
+ "mapping": {
788
+ "skip": true,
789
+ "settings": {
790
+ "reset": true
791
+ }
792
+ },
793
+ "out": [
794
+ [
795
+ "heap.resetIdentity"
796
+ ]
797
+ ]
798
+ }
799
+ }
800
+ }
801
+ }