@searchspring/snap-tracker 0.64.0 → 0.65.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.
- package/README.md +1 -12
- package/dist/cjs/BeaconEvent.d.ts +2 -0
- package/dist/cjs/BeaconEvent.d.ts.map +1 -1
- package/dist/cjs/BeaconEvent.js +29 -0
- package/dist/cjs/Tracker.d.ts +6 -19
- package/dist/cjs/Tracker.d.ts.map +1 -1
- package/dist/cjs/Tracker.js +158 -485
- package/dist/cjs/types.d.ts +12 -42
- package/dist/cjs/types.d.ts.map +1 -1
- package/dist/cjs/types.js +2 -24
- package/dist/esm/BeaconEvent.d.ts +2 -0
- package/dist/esm/BeaconEvent.d.ts.map +1 -1
- package/dist/esm/BeaconEvent.js +17 -0
- package/dist/esm/Tracker.d.ts +6 -19
- package/dist/esm/Tracker.d.ts.map +1 -1
- package/dist/esm/Tracker.js +134 -462
- package/dist/esm/types.d.ts +12 -42
- package/dist/esm/types.d.ts.map +1 -1
- package/dist/esm/types.js +2 -24
- package/package.json +7 -6
- package/dist/cjs/PixelEvent.d.ts +0 -9
- package/dist/cjs/PixelEvent.d.ts.map +0 -1
- package/dist/cjs/PixelEvent.js +0 -69
- package/dist/cjs/TrackEvent.d.ts +0 -11
- package/dist/cjs/TrackEvent.d.ts.map +0 -1
- package/dist/cjs/TrackEvent.js +0 -31
- package/dist/esm/PixelEvent.d.ts +0 -9
- package/dist/esm/PixelEvent.d.ts.map +0 -1
- package/dist/esm/PixelEvent.js +0 -62
- package/dist/esm/TrackEvent.d.ts +0 -11
- package/dist/esm/TrackEvent.d.ts.map +0 -1
- package/dist/esm/TrackEvent.js +0 -25
package/README.md
CHANGED
|
@@ -26,7 +26,7 @@ import { Tracker } from '@searchspring/snap-tracker';
|
|
|
26
26
|
| id | unique identifier for the tracker | track | |
|
|
27
27
|
| framework | unique identifier for the framework utilizing the tracker | snap | |
|
|
28
28
|
| mode | application mode (production, development) | production | |
|
|
29
|
-
| doNotTrack | array of
|
|
29
|
+
| doNotTrack | array of TrackerEvents, used to block specific types of tracking | ➖ | |
|
|
30
30
|
|
|
31
31
|
|
|
32
32
|
## Controller usage
|
|
@@ -547,14 +547,3 @@ const tracker = new Tracker();
|
|
|
547
547
|
console.log(tracker.cookies.viewed.get());
|
|
548
548
|
// ['sku1', 'sku2']
|
|
549
549
|
```
|
|
550
|
-
|
|
551
|
-
### `sendEvents` method
|
|
552
|
-
Sends event(s) to beacon (and various legacy) endpoint(s).
|
|
553
|
-
|
|
554
|
-
```typescript
|
|
555
|
-
const tracker = new Tracker();
|
|
556
|
-
const event1 = new BeaconEvent();
|
|
557
|
-
const event2 = new BeaconEvent();
|
|
558
|
-
tracker.sendEvents([event1, event2])
|
|
559
|
-
```
|
|
560
|
-
|
|
@@ -7,6 +7,8 @@ export declare class BeaconEvent {
|
|
|
7
7
|
event?: Types.ProductViewEvent | Types.CartViewEvent | Types.OrderTransactionEvent | Types.RecommendationsEvent | Types.ProductClickEvent | Types.CustomBeaconEvent | Record<string, never>;
|
|
8
8
|
id?: string;
|
|
9
9
|
pid?: string | null;
|
|
10
|
+
private origin?;
|
|
10
11
|
constructor(payload: Types.BeaconPayload, config: Types.TrackerConfig);
|
|
12
|
+
send(): BeaconEvent;
|
|
11
13
|
}
|
|
12
14
|
//# sourceMappingURL=BeaconEvent.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"BeaconEvent.d.ts","sourceRoot":"","sources":["../../src/BeaconEvent.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AAEjC,qBAAa,WAAW;IACvB,IAAI,EAAE,KAAK,CAAC,UAAU,CAAC;IACvB,QAAQ,EAAE,KAAK,CAAC,cAAc,CAAC;IAC/B,OAAO,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;IAC9B,IAAI,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC;IACxB,KAAK,CAAC,EACH,KAAK,CAAC,gBAAgB,GACtB,KAAK,CAAC,aAAa,GACnB,KAAK,CAAC,qBAAqB,GAC3B,KAAK,CAAC,oBAAoB,GAC1B,KAAK,CAAC,iBAAiB,GACvB,KAAK,CAAC,iBAAiB,GACvB,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACzB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;
|
|
1
|
+
{"version":3,"file":"BeaconEvent.d.ts","sourceRoot":"","sources":["../../src/BeaconEvent.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AAEjC,qBAAa,WAAW;IACvB,IAAI,EAAE,KAAK,CAAC,UAAU,CAAC;IACvB,QAAQ,EAAE,KAAK,CAAC,cAAc,CAAC;IAC/B,OAAO,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;IAC9B,IAAI,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC;IACxB,KAAK,CAAC,EACH,KAAK,CAAC,gBAAgB,GACtB,KAAK,CAAC,aAAa,GACnB,KAAK,CAAC,qBAAqB,GAC3B,KAAK,CAAC,oBAAoB,GAC1B,KAAK,CAAC,iBAAiB,GACvB,KAAK,CAAC,iBAAiB,GACvB,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACzB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,OAAO,CAAC,MAAM,CAAC,CAAS;gBAEZ,OAAO,EAAE,KAAK,CAAC,aAAa,EAAE,MAAM,EAAE,KAAK,CAAC,aAAa;IAoBrE,IAAI,IAAI,WAAW;CAiBnB"}
|
package/dist/cjs/BeaconEvent.js
CHANGED
|
@@ -1,10 +1,22 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
+
var __assign = (this && this.__assign) || function () {
|
|
3
|
+
__assign = Object.assign || function(t) {
|
|
4
|
+
for (var s, i = 1, n = arguments.length; i < n; i++) {
|
|
5
|
+
s = arguments[i];
|
|
6
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
|
|
7
|
+
t[p] = s[p];
|
|
8
|
+
}
|
|
9
|
+
return t;
|
|
10
|
+
};
|
|
11
|
+
return __assign.apply(this, arguments);
|
|
12
|
+
};
|
|
2
13
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
14
|
exports.BeaconEvent = void 0;
|
|
4
15
|
var uuid_1 = require("uuid");
|
|
5
16
|
var snap_toolbox_1 = require("@searchspring/snap-toolbox");
|
|
6
17
|
var BeaconEvent = /** @class */ (function () {
|
|
7
18
|
function BeaconEvent(payload, config) {
|
|
19
|
+
var _a, _b;
|
|
8
20
|
this.type = payload.type;
|
|
9
21
|
this.category = payload.category;
|
|
10
22
|
this.context = payload.context;
|
|
@@ -12,6 +24,7 @@ var BeaconEvent = /** @class */ (function () {
|
|
|
12
24
|
this.event = payload.event;
|
|
13
25
|
this.id = payload.id;
|
|
14
26
|
this.pid = payload.pid;
|
|
27
|
+
this.origin = ((_b = (_a = config.requesters) === null || _a === void 0 ? void 0 : _a.beacon) === null || _b === void 0 ? void 0 : _b.origin) || 'https://beacon.searchspring.io';
|
|
15
28
|
this.meta = {
|
|
16
29
|
initiator: {
|
|
17
30
|
lib: 'searchspring/snap',
|
|
@@ -21,6 +34,22 @@ var BeaconEvent = /** @class */ (function () {
|
|
|
21
34
|
};
|
|
22
35
|
this.id = (0, uuid_1.v4)();
|
|
23
36
|
}
|
|
37
|
+
BeaconEvent.prototype.send = function () {
|
|
38
|
+
var data = __assign({}, this);
|
|
39
|
+
var origin = data.origin;
|
|
40
|
+
delete data.origin;
|
|
41
|
+
if (typeof fetch !== 'undefined') {
|
|
42
|
+
fetch("".concat(origin, "/beacon"), {
|
|
43
|
+
method: 'POST',
|
|
44
|
+
headers: {
|
|
45
|
+
'Content-Type': 'application/json',
|
|
46
|
+
},
|
|
47
|
+
body: JSON.stringify(data),
|
|
48
|
+
keepalive: true,
|
|
49
|
+
});
|
|
50
|
+
}
|
|
51
|
+
return data;
|
|
52
|
+
};
|
|
24
53
|
return BeaconEvent;
|
|
25
54
|
}());
|
|
26
55
|
exports.BeaconEvent = BeaconEvent;
|
package/dist/cjs/Tracker.d.ts
CHANGED
|
@@ -1,27 +1,15 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
|
|
4
|
-
export declare
|
|
5
|
-
export declare class Tracker {
|
|
6
|
-
private mode;
|
|
7
|
-
private globals;
|
|
1
|
+
import { Beacon } from '@searchspring/beacon';
|
|
2
|
+
import type { BeaconConfig } from '@searchspring/beacon';
|
|
3
|
+
import { TrackerGlobals, TrackMethods, TrackerConfig } from './types';
|
|
4
|
+
export declare class Tracker extends Beacon {
|
|
8
5
|
private localStorage;
|
|
9
|
-
private context;
|
|
10
|
-
private isSending;
|
|
11
6
|
private doNotTrack;
|
|
12
|
-
|
|
7
|
+
config: TrackerConfig & BeaconConfig;
|
|
13
8
|
private targeters;
|
|
14
|
-
constructor(globals: TrackerGlobals, config?: TrackerConfig);
|
|
9
|
+
constructor(globals: TrackerGlobals, config?: TrackerConfig & BeaconConfig);
|
|
15
10
|
getGlobals(): TrackerGlobals;
|
|
16
|
-
getContext(): BeaconContext;
|
|
17
11
|
retarget(): void;
|
|
18
12
|
track: TrackMethods;
|
|
19
|
-
updateContext: (key: keyof BeaconContext, value: any) => void;
|
|
20
|
-
setCurrency: (currency: CurrencyContext) => void;
|
|
21
|
-
getUserId: () => string | undefined | null;
|
|
22
|
-
getSessionId: () => string | undefined;
|
|
23
|
-
getShopperId: () => string | undefined;
|
|
24
|
-
sendPreflight: () => void;
|
|
25
13
|
cookies: {
|
|
26
14
|
cart: {
|
|
27
15
|
get: () => string[];
|
|
@@ -34,6 +22,5 @@ export declare class Tracker {
|
|
|
34
22
|
get: () => string[];
|
|
35
23
|
};
|
|
36
24
|
};
|
|
37
|
-
sendEvents: (eventsToSend?: BeaconEvent[]) => void;
|
|
38
25
|
}
|
|
39
26
|
//# sourceMappingURL=Tracker.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Tracker.d.ts","sourceRoot":"","sources":["../../src/Tracker.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"Tracker.d.ts","sourceRoot":"","sources":["../../src/Tracker.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,KAAK,EAAsD,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAG7G,OAAO,EACN,cAAc,EACd,YAAY,EAWZ,aAAa,EAEb,MAAM,SAAS,CAAC;AAUjB,qBAAa,OAAQ,SAAQ,MAAM;IAClC,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,UAAU,CAAkB;IAE7B,MAAM,EAAE,aAAa,GAAG,YAAY,CAAC;IAC5C,OAAO,CAAC,SAAS,CAAqB;gBAE1B,OAAO,EAAE,cAAc,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,YAAY;IA0InE,UAAU,IAAI,cAAc;IAI5B,QAAQ,IAAI,IAAI;IAMvB,KAAK,EAAE,YAAY,CAoJjB;IAEF,OAAO;;uBAEI,MAAM,EAAE;yBAIJ,MAAM,EAAE,KAAG,IAAI;yBAKf,MAAM,EAAE,KAAG,IAAI;4BAMZ,MAAM,EAAE,KAAG,IAAI;;;;uBAWtB,MAAM,EAAE;;MAKjB;CACF"}
|