@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.
@@ -1,16 +1,11 @@
1
1
  import { AppMode } from '@searchspring/snap-toolbox';
2
2
  import { BeaconEvent } from './BeaconEvent';
3
- export type CurrencyContext = {
4
- code: string;
5
- };
3
+ import type { ContextCurrency } from '@searchspring/beacon';
6
4
  export type TrackerGlobals = {
7
5
  siteId: string;
8
- currency?: CurrencyContext;
9
- };
10
- export type DoNotTrackEntry = {
11
- type: BeaconType;
12
- category: BeaconCategory;
6
+ currency?: ContextCurrency;
13
7
  };
8
+ export type TrackerEvents = 'error' | 'shopper.login' | 'product.view' | 'product.click' | 'cart.view' | 'order.transaction';
14
9
  export type TrackerConfig = {
15
10
  id?: string;
16
11
  framework?: string;
@@ -23,7 +18,7 @@ export type TrackerConfig = {
23
18
  origin?: string;
24
19
  };
25
20
  };
26
- doNotTrack?: DoNotTrackEntry[];
21
+ doNotTrack?: TrackerEvents[];
27
22
  };
28
23
  export type BeaconPayload = {
29
24
  type: BeaconType;
@@ -35,34 +30,10 @@ export type BeaconPayload = {
35
30
  pid?: string | null;
36
31
  };
37
32
  export declare enum BeaconType {
38
- PRODUCT = "product",
39
- CART = "cart",
40
- ORDER = "transaction",
41
- LOGIN = "login",
42
- CLICK = "click",
43
- ERROR = "error",
44
- CUSTOM = "custom",
45
- /** For Profiles Recommendations */
46
- PROFILE_RENDER = "profile.render",// A profile is loaded onto the page.
47
- PROFILE_IMPRESSION = "profile.impression",// A profile is visible to the shopper (within viewport, not hidden). If determining visibility is not possible, this can be sent at the same time as a profile.render event.
48
- PROFILE_CLICK = "profile.click",// Any area of the profile is clicked.
49
- PROFILE_ADDBUNDLE = "profile.addBundle",
50
- /** For Recommended Products within a Profile */
51
- PROFILE_PRODUCT_RENDER = "profile.product.render",// A recommended product is loaded onto the page.
52
- PROFILE_PRODUCT_IMPRESSION = "profile.product.impression",// A recommended product is visible to the shopper (within viewport, not hidden). If determining visibility is not possible, this can be sent at the same time as a profile.product.render event.
53
- PROFILE_PRODUCT_CLICK = "profile.product.click",// A recommended product is clicked.
54
- PROFILE_PRODUCT_ADDEDTOBUNDLE = "profile.product.addedToBundle",
55
- PROFILE_PRODUCT_REMOVEDFROMBUNDLE = "profile.product.removedFromBundle"
33
+ CLICK = "click"
56
34
  }
57
35
  export declare enum BeaconCategory {
58
- PAGEVIEW = "searchspring.page.view",
59
- CARTVIEW = "searchspring.shop.cart",
60
- ORDERVIEW = "searchspring.shop.transaction",
61
- PERSONALIZATION = "searchspring.personalization",
62
- RECOMMENDATIONS = "searchspring.recommendations.user-interactions",
63
- INTERACTION = "searchspring.user-interactions",
64
- RUNTIME = "searchspring.js.runtime",
65
- CUSTOM = "custom"
36
+ INTERACTION = "searchspring.user-interactions"
66
37
  }
67
38
  export declare enum ProfilePlacement {
68
39
  BASKETPAGE = "basket-page",
@@ -84,7 +55,7 @@ export interface BeaconContext {
84
55
  type?: string;
85
56
  id?: string;
86
57
  };
87
- currency?: CurrencyContext;
58
+ currency?: ContextCurrency;
88
59
  }
89
60
  export interface BeaconMeta {
90
61
  initiator: {
@@ -189,20 +160,19 @@ export type PreflightRequestModel = {
189
160
  lastViewed?: string[];
190
161
  };
191
162
  export interface TrackMethods {
192
- event: (payload: BeaconPayload) => BeaconEvent | undefined;
193
- error: (data: TrackErrorEvent) => BeaconEvent | undefined;
163
+ error: (data: TrackErrorEvent) => undefined;
194
164
  shopper: {
195
- login: (data: ShopperLoginEvent, siteId?: string) => BeaconEvent | undefined;
165
+ login: (data: ShopperLoginEvent, siteId?: string) => undefined;
196
166
  };
197
167
  product: {
198
- view: (data: ProductViewEvent, siteId?: string) => BeaconEvent | undefined;
168
+ view: (data: ProductViewEvent, siteId?: string) => undefined;
199
169
  click: (data: ProductClickEvent, siteId?: string) => BeaconEvent | undefined;
200
170
  };
201
171
  cart: {
202
- view: (data: CartViewEvent, siteId?: string) => BeaconEvent | undefined;
172
+ view: (data: CartViewEvent, siteId?: string) => undefined;
203
173
  };
204
174
  order: {
205
- transaction: (data: OrderTransactionData, siteId?: string) => BeaconEvent | undefined;
175
+ transaction: (data: OrderTransactionData, siteId?: string) => undefined;
206
176
  };
207
177
  }
208
178
  declare global {
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,MAAM,eAAe,GAAG;IAC7B,IAAI,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,eAAe,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC7B,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE,cAAc,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC3B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,OAAO,OAAO,GAAG,OAAO,CAAC;IACtC,UAAU,CAAC,EAAE;QACZ,eAAe,CAAC,EAAE;YACjB,MAAM,EAAE,MAAM,CAAC;SACf,CAAC;QACF,MAAM,CAAC,EAAE;YACR,MAAM,CAAC,EAAE,MAAM,CAAC;SAChB,CAAC;KACF,CAAC;IACF,UAAU,CAAC,EAAE,eAAe,EAAE,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC3B,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE,cAAc,CAAC;IACzB,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,KAAK,EACF,gBAAgB,GAChB,aAAa,GACb,qBAAqB,GACrB,oBAAoB,GACpB,iBAAiB,GACjB,iBAAiB,GACjB,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACzB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpB,CAAC;AAEF,oBAAY,UAAU;IACrB,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,KAAK,gBAAgB;IACrB,KAAK,UAAU;IACf,KAAK,UAAU;IACf,KAAK,UAAU;IACf,MAAM,WAAW;IAEjB,mCAAmC;IACnC,cAAc,mBAAmB,CAAE,qCAAqC;IACxE,kBAAkB,uBAAuB,CAAE,6KAA6K;IACxN,aAAa,kBAAkB,CAAE,sCAAsC;IACvE,iBAAiB,sBAAsB;IAEvC,gDAAgD;IAChD,sBAAsB,2BAA2B,CAAE,iDAAiD;IACpG,0BAA0B,+BAA+B,CAAE,iMAAiM;IAC5P,qBAAqB,0BAA0B,CAAE,oCAAoC;IACrF,6BAA6B,kCAAkC;IAC/D,iCAAiC,sCAAsC;CACvE;AAED,oBAAY,cAAc;IACzB,QAAQ,2BAA2B;IACnC,QAAQ,2BAA2B;IACnC,SAAS,kCAAkC;IAC3C,eAAe,iCAAiC;IAChD,eAAe,mDAAmD;IAClE,WAAW,mCAAmC;IAC9C,OAAO,4BAA4B;IACnC,MAAM,WAAW;CACjB;AAED,oBAAY,gBAAgB;IAC3B,UAAU,gBAAgB;IAC1B,gBAAgB,sBAAsB;IACtC,WAAW,iBAAiB;IAC5B,aAAa,oBAAoB;IACjC,QAAQ,cAAc;IACtB,KAAK,UAAU;CACf;AAED,MAAM,WAAW,aAAa;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE;QACR,YAAY,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,WAAW,CAAC,EAAE;QACb,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,EAAE,CAAC,EAAE,MAAM,CAAC;KACZ,CAAC;IACF,QAAQ,CAAC,EAAE,eAAe,CAAC;CAC3B;AAED,MAAM,WAAW,UAAU;IAC1B,SAAS,EAAE;QACV,GAAG,EAAE,MAAM,CAAC;QACZ,aAAa,EAAE,MAAM,CAAC;QACtB,eAAe,EAAE,MAAM,CAAC;KACxB,CAAC;CACF;AAED,MAAM,WAAW,iBAAiB;IACjC,EAAE,EAAE,MAAM,CAAC;CACX;AACD,MAAM,WAAW,eAAe;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,OAAO,CAAC,EAAE;QACT,UAAU,CAAC,EAAE;YACZ,IAAI,EAAE,MAAM,CAAC;YACb,EAAE,EAAE,MAAM,CAAC;SACX,CAAC;KACF,CAAC;IACF,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACrC;AACD,MAAM,WAAW,gBAAgB;IAChC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB;AACD,MAAM,WAAW,aAAa;IAC7B,KAAK,EAAE,WAAW,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,WAAY,SAAQ,gBAAgB;IACpD,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,qBAAqB;IACrC,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,gBAAgB,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACnC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,WAAW,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACpC,KAAK,CAAC,EAAE;QACP,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QACrB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QACxB,gBAAgB,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QACnC,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,KAAK,EAAE,WAAW,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACpC,OAAO,CAAC,EAAE;QACT,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,SAAS,CAAC,EAAE,gBAAgB,CAAC;QAC7B,IAAI,CAAC,EAAE,gBAAgB,EAAE,CAAC;KAC1B,CAAC;IACF,OAAO,CAAC,EAAE;QACT,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,QAAQ,CAAC,EAAE;YACV,IAAI,CAAC,EAAE;gBACN,GAAG,CAAC,EAAE,MAAM,CAAC;gBACb,IAAI,CAAC,EAAE,MAAM,CAAC;gBACd,GAAG,CAAC,EAAE,MAAM,CAAC;gBACb,iBAAiB,CAAC,EAAE,MAAM,CAAC;gBAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;gBACf,IAAI,CAAC,EAAE,MAAM,CAAC;aACd,CAAC;SACF,CAAC;QACF,IAAI,CAAC,EAAE,gBAAgB,EAAE,CAAC;KAC1B,CAAC;IACF,OAAO,CAAC,EAAE;QACT,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,SAAS,CAAC,EAAE,gBAAgB,CAAC;KAC7B,CAAC;CACF;AACD,MAAM,WAAW,iBAAiB;IACjC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,uBAAuB,EAAE,MAAM,CAAC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,iBAAiB;IACjC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACnB;AAED,MAAM,MAAM,qBAAqB,GAAG;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB,CAAC;AAEF,MAAM,WAAW,YAAY;IAC5B,KAAK,EAAE,CAAC,OAAO,EAAE,aAAa,KAAK,WAAW,GAAG,SAAS,CAAC;IAC3D,KAAK,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,WAAW,GAAG,SAAS,CAAC;IAC1D,OAAO,EAAE;QACR,KAAK,EAAE,CAAC,IAAI,EAAE,iBAAiB,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,WAAW,GAAG,SAAS,CAAC;KAC7E,CAAC;IACF,OAAO,EAAE;QACR,IAAI,EAAE,CAAC,IAAI,EAAE,gBAAgB,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,WAAW,GAAG,SAAS,CAAC;QAC3E,KAAK,EAAE,CAAC,IAAI,EAAE,iBAAiB,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,WAAW,GAAG,SAAS,CAAC;KAC7E,CAAC;IACF,IAAI,EAAE;QACL,IAAI,EAAE,CAAC,IAAI,EAAE,aAAa,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,WAAW,GAAG,SAAS,CAAC;KACxE,CAAC;IACF,KAAK,EAAE;QACN,WAAW,EAAE,CAAC,IAAI,EAAE,oBAAoB,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,WAAW,GAAG,SAAS,CAAC;KACtF,CAAC;CACF;AAED,OAAO,CAAC,MAAM,CAAC;IACd,UAAU,MAAM;QACf,YAAY,CAAC,EAAE,GAAG,CAAC;KACnB;CACD"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAE5D,MAAM,MAAM,cAAc,GAAG;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,eAAe,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,eAAe,GAAG,cAAc,GAAG,eAAe,GAAG,WAAW,GAAG,mBAAmB,CAAC;AAE7H,MAAM,MAAM,aAAa,GAAG;IAC3B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,OAAO,OAAO,GAAG,OAAO,CAAC;IACtC,UAAU,CAAC,EAAE;QACZ,eAAe,CAAC,EAAE;YACjB,MAAM,EAAE,MAAM,CAAC;SACf,CAAC;QACF,MAAM,CAAC,EAAE;YACR,MAAM,CAAC,EAAE,MAAM,CAAC;SAChB,CAAC;KACF,CAAC;IACF,UAAU,CAAC,EAAE,aAAa,EAAE,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC3B,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE,cAAc,CAAC;IACzB,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,KAAK,EACF,gBAAgB,GAChB,aAAa,GACb,qBAAqB,GACrB,oBAAoB,GACpB,iBAAiB,GACjB,iBAAiB,GACjB,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACzB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpB,CAAC;AAGF,oBAAY,UAAU;IACrB,KAAK,UAAU;CACf;AAED,oBAAY,cAAc;IACzB,WAAW,mCAAmC;CAC9C;AAED,oBAAY,gBAAgB;IAC3B,UAAU,gBAAgB;IAC1B,gBAAgB,sBAAsB;IACtC,WAAW,iBAAiB;IAC5B,aAAa,oBAAoB;IACjC,QAAQ,cAAc;IACtB,KAAK,UAAU;CACf;AAED,MAAM,WAAW,aAAa;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE;QACR,YAAY,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,WAAW,CAAC,EAAE;QACb,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,EAAE,CAAC,EAAE,MAAM,CAAC;KACZ,CAAC;IACF,QAAQ,CAAC,EAAE,eAAe,CAAC;CAC3B;AAED,MAAM,WAAW,UAAU;IAC1B,SAAS,EAAE;QACV,GAAG,EAAE,MAAM,CAAC;QACZ,aAAa,EAAE,MAAM,CAAC;QACtB,eAAe,EAAE,MAAM,CAAC;KACxB,CAAC;CACF;AAED,MAAM,WAAW,iBAAiB;IACjC,EAAE,EAAE,MAAM,CAAC;CACX;AACD,MAAM,WAAW,eAAe;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,OAAO,CAAC,EAAE;QACT,UAAU,CAAC,EAAE;YACZ,IAAI,EAAE,MAAM,CAAC;YACb,EAAE,EAAE,MAAM,CAAC;SACX,CAAC;KACF,CAAC;IACF,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACrC;AACD,MAAM,WAAW,gBAAgB;IAChC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB;AACD,MAAM,WAAW,aAAa;IAC7B,KAAK,EAAE,WAAW,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,WAAY,SAAQ,gBAAgB;IACpD,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,qBAAqB;IACrC,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,gBAAgB,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACnC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,WAAW,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACpC,KAAK,CAAC,EAAE;QACP,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QACrB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QACxB,gBAAgB,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QACnC,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,KAAK,EAAE,WAAW,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACpC,OAAO,CAAC,EAAE;QACT,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,SAAS,CAAC,EAAE,gBAAgB,CAAC;QAC7B,IAAI,CAAC,EAAE,gBAAgB,EAAE,CAAC;KAC1B,CAAC;IACF,OAAO,CAAC,EAAE;QACT,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,QAAQ,CAAC,EAAE;YACV,IAAI,CAAC,EAAE;gBACN,GAAG,CAAC,EAAE,MAAM,CAAC;gBACb,IAAI,CAAC,EAAE,MAAM,CAAC;gBACd,GAAG,CAAC,EAAE,MAAM,CAAC;gBACb,iBAAiB,CAAC,EAAE,MAAM,CAAC;gBAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;gBACf,IAAI,CAAC,EAAE,MAAM,CAAC;aACd,CAAC;SACF,CAAC;QACF,IAAI,CAAC,EAAE,gBAAgB,EAAE,CAAC;KAC1B,CAAC;IACF,OAAO,CAAC,EAAE;QACT,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,SAAS,CAAC,EAAE,gBAAgB,CAAC;KAC7B,CAAC;CACF;AACD,MAAM,WAAW,iBAAiB;IACjC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,uBAAuB,EAAE,MAAM,CAAC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,iBAAiB;IACjC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACnB;AAED,MAAM,MAAM,qBAAqB,GAAG;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB,CAAC;AAEF,MAAM,WAAW,YAAY;IAC5B,KAAK,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,SAAS,CAAC;IAC5C,OAAO,EAAE;QACR,KAAK,EAAE,CAAC,IAAI,EAAE,iBAAiB,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,SAAS,CAAC;KAC/D,CAAC;IACF,OAAO,EAAE;QACR,IAAI,EAAE,CAAC,IAAI,EAAE,gBAAgB,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,SAAS,CAAC;QAC7D,KAAK,EAAE,CAAC,IAAI,EAAE,iBAAiB,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,WAAW,GAAG,SAAS,CAAC;KAC7E,CAAC;IACF,IAAI,EAAE;QACL,IAAI,EAAE,CAAC,IAAI,EAAE,aAAa,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,SAAS,CAAC;KAC1D,CAAC;IACF,KAAK,EAAE;QACN,WAAW,EAAE,CAAC,IAAI,EAAE,oBAAoB,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,SAAS,CAAC;KACxE,CAAC;CACF;AAED,OAAO,CAAC,MAAM,CAAC;IACd,UAAU,MAAM;QACf,YAAY,CAAC,EAAE,GAAG,CAAC;KACnB;CACD"}
package/dist/cjs/types.js CHANGED
@@ -1,37 +1,15 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.ProfilePlacement = exports.BeaconCategory = exports.BeaconType = void 0;
4
+ // TODO: remove when 1.0 is sunset
4
5
  var BeaconType;
5
6
  (function (BeaconType) {
6
- BeaconType["PRODUCT"] = "product";
7
- BeaconType["CART"] = "cart";
8
- BeaconType["ORDER"] = "transaction";
9
- BeaconType["LOGIN"] = "login";
10
7
  BeaconType["CLICK"] = "click";
11
- BeaconType["ERROR"] = "error";
12
- BeaconType["CUSTOM"] = "custom";
13
- /** For Profiles Recommendations */
14
- BeaconType["PROFILE_RENDER"] = "profile.render";
15
- BeaconType["PROFILE_IMPRESSION"] = "profile.impression";
16
- BeaconType["PROFILE_CLICK"] = "profile.click";
17
- BeaconType["PROFILE_ADDBUNDLE"] = "profile.addBundle";
18
- /** For Recommended Products within a Profile */
19
- BeaconType["PROFILE_PRODUCT_RENDER"] = "profile.product.render";
20
- BeaconType["PROFILE_PRODUCT_IMPRESSION"] = "profile.product.impression";
21
- BeaconType["PROFILE_PRODUCT_CLICK"] = "profile.product.click";
22
- BeaconType["PROFILE_PRODUCT_ADDEDTOBUNDLE"] = "profile.product.addedToBundle";
23
- BeaconType["PROFILE_PRODUCT_REMOVEDFROMBUNDLE"] = "profile.product.removedFromBundle";
24
8
  })(BeaconType || (exports.BeaconType = BeaconType = {}));
9
+ // TODO: remove when 1.0 is sunset
25
10
  var BeaconCategory;
26
11
  (function (BeaconCategory) {
27
- BeaconCategory["PAGEVIEW"] = "searchspring.page.view";
28
- BeaconCategory["CARTVIEW"] = "searchspring.shop.cart";
29
- BeaconCategory["ORDERVIEW"] = "searchspring.shop.transaction";
30
- BeaconCategory["PERSONALIZATION"] = "searchspring.personalization";
31
- BeaconCategory["RECOMMENDATIONS"] = "searchspring.recommendations.user-interactions";
32
12
  BeaconCategory["INTERACTION"] = "searchspring.user-interactions";
33
- BeaconCategory["RUNTIME"] = "searchspring.js.runtime";
34
- BeaconCategory["CUSTOM"] = "custom";
35
13
  })(BeaconCategory || (exports.BeaconCategory = BeaconCategory = {}));
36
14
  var ProfilePlacement;
37
15
  (function (ProfilePlacement) {
@@ -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;gBAER,OAAO,EAAE,KAAK,CAAC,aAAa,EAAE,MAAM,EAAE,KAAK,CAAC,aAAa;CAkBrE"}
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"}
@@ -9,6 +9,7 @@ export class BeaconEvent {
9
9
  this.event = payload.event;
10
10
  this.id = payload.id;
11
11
  this.pid = payload.pid;
12
+ this.origin = config.requesters?.beacon?.origin || 'https://beacon.searchspring.io';
12
13
  this.meta = {
13
14
  initiator: {
14
15
  lib: 'searchspring/snap',
@@ -18,4 +19,20 @@ export class BeaconEvent {
18
19
  };
19
20
  this.id = uuidv4();
20
21
  }
22
+ send() {
23
+ const data = { ...this };
24
+ const origin = data.origin;
25
+ delete data.origin;
26
+ if (typeof fetch !== 'undefined') {
27
+ fetch(`${origin}/beacon`, {
28
+ method: 'POST',
29
+ headers: {
30
+ 'Content-Type': 'application/json',
31
+ },
32
+ body: JSON.stringify(data),
33
+ keepalive: true,
34
+ });
35
+ }
36
+ return data;
37
+ }
21
38
  }
@@ -1,27 +1,15 @@
1
- import { BeaconEvent } from './BeaconEvent';
2
- import { TrackerGlobals, TrackMethods, BeaconContext, TrackerConfig, CurrencyContext } from './types';
3
- export declare const BATCH_TIMEOUT = 200;
4
- export declare const MAX_VIEWED_COUNT = 20;
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
- private config;
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":"AASA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EACN,cAAc,EACd,YAAY,EAIZ,aAAa,EAQb,aAAa,EAGb,eAAe,EACf,MAAM,SAAS,CAAC;AAEjB,eAAO,MAAM,aAAa,MAAM,CAAC;AAajC,eAAO,MAAM,gBAAgB,KAAK,CAAC;AASnC,qBAAa,OAAO;IACnB,OAAO,CAAC,IAAI,CAAsB;IAClC,OAAO,CAAC,OAAO,CAAiB;IAChC,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,OAAO,CAAgB;IAC/B,OAAO,CAAC,SAAS,CAAqB;IACtC,OAAO,CAAC,UAAU,CAAoB;IAEtC,OAAO,CAAC,MAAM,CAAgB;IAC9B,OAAO,CAAC,SAAS,CAAqB;gBAE1B,OAAO,EAAE,cAAc,EAAE,MAAM,CAAC,EAAE,aAAa;IAuJpD,UAAU,IAAI,cAAc;IAI5B,UAAU,IAAI,aAAa;IAI3B,QAAQ,IAAI,IAAI;IAMvB,KAAK,EAAE,YAAY,CAsVjB;IAEF,aAAa,QAAS,MAAM,aAAa,SAAS,GAAG,UAInD;IAEF,WAAW,aAAc,eAAe,KAAG,IAAI,CAK7C;IAEF,SAAS,QAAO,MAAM,GAAG,SAAS,GAAG,IAAI,CAmBvC;IAEF,YAAY,QAAO,MAAM,GAAG,SAAS,CAoBnC;IAEF,YAAY,QAAO,MAAM,GAAG,SAAS,CAOnC;IAEF,aAAa,QAAO,IAAI,CAwCtB;IAEF,OAAO;;uBAEI,MAAM,EAAE;yBAOJ,MAAM,EAAE,KAAG,IAAI;yBAYf,MAAM,EAAE,KAAG,IAAI;4BAaZ,MAAM,EAAE,KAAG,IAAI;;;;uBAqBtB,MAAM,EAAE;;MAQjB;IAEF,UAAU,kBAAmB,WAAW,EAAE,KAAG,IAAI,CA0C/C;CACF"}
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"}