@amplitude/analytics-core 2.62.1 → 2.63.0-claudeconfident-mccarthy-373nfy.0
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/lib/cjs/config.d.ts +1 -0
- package/lib/cjs/config.d.ts.map +1 -1
- package/lib/cjs/config.js +1 -0
- package/lib/cjs/config.js.map +1 -1
- package/lib/cjs/core-client.d.ts.map +1 -1
- package/lib/cjs/core-client.js +4 -0
- package/lib/cjs/core-client.js.map +1 -1
- package/lib/cjs/heartbeat.d.ts +23 -4
- package/lib/cjs/heartbeat.d.ts.map +1 -1
- package/lib/cjs/heartbeat.js +108 -18
- package/lib/cjs/heartbeat.js.map +1 -1
- package/lib/cjs/index.d.ts +3 -3
- package/lib/cjs/index.d.ts.map +1 -1
- package/lib/cjs/index.js +4 -3
- package/lib/cjs/index.js.map +1 -1
- package/lib/cjs/observers/video.d.ts +6 -3
- package/lib/cjs/observers/video.d.ts.map +1 -1
- package/lib/cjs/observers/video.js +41 -8
- package/lib/cjs/observers/video.js.map +1 -1
- package/lib/cjs/page-view-id.d.ts +3 -1
- package/lib/cjs/page-view-id.d.ts.map +1 -1
- package/lib/cjs/page-view-id.js +4 -2
- package/lib/cjs/page-view-id.js.map +1 -1
- package/lib/cjs/plugins/destination.d.ts +21 -1
- package/lib/cjs/plugins/destination.d.ts.map +1 -1
- package/lib/cjs/plugins/destination.js +180 -25
- package/lib/cjs/plugins/destination.js.map +1 -1
- package/lib/cjs/types/config/core-config.d.ts +5 -0
- package/lib/cjs/types/config/core-config.d.ts.map +1 -1
- package/lib/cjs/types/config/core-config.js.map +1 -1
- package/lib/cjs/types/event/base-event.d.ts +1 -0
- package/lib/cjs/types/event/base-event.d.ts.map +1 -1
- package/lib/cjs/types/event/base-event.js.map +1 -1
- package/lib/cjs/types/event/event.d.ts +4 -1
- package/lib/cjs/types/event/event.d.ts.map +1 -1
- package/lib/cjs/types/event/event.js.map +1 -1
- package/lib/cjs/types/messages.d.ts +1 -0
- package/lib/cjs/types/messages.d.ts.map +1 -1
- package/lib/cjs/types/messages.js +2 -1
- package/lib/cjs/types/messages.js.map +1 -1
- package/lib/cjs/types/page-view-tracking.d.ts +24 -0
- package/lib/cjs/types/page-view-tracking.d.ts.map +1 -1
- package/lib/cjs/types/page-view-tracking.js.map +1 -1
- package/lib/cjs/types/payload.d.ts +5 -0
- package/lib/cjs/types/payload.d.ts.map +1 -1
- package/lib/cjs/types/payload.js.map +1 -1
- package/lib/cjs/video-analytics/track-video.d.ts +1 -1
- package/lib/cjs/video-analytics/track-video.d.ts.map +1 -1
- package/lib/cjs/video-analytics/track-video.js +107 -19
- package/lib/cjs/video-analytics/track-video.js.map +1 -1
- package/lib/cjs/video-analytics/types.d.ts +6 -5
- package/lib/cjs/video-analytics/types.d.ts.map +1 -1
- package/lib/cjs/video-analytics/types.js.map +1 -1
- package/lib/esm/config.d.ts +1 -0
- package/lib/esm/config.d.ts.map +1 -1
- package/lib/esm/config.js +1 -0
- package/lib/esm/config.js.map +1 -1
- package/lib/esm/core-client.d.ts.map +1 -1
- package/lib/esm/core-client.js +5 -1
- package/lib/esm/core-client.js.map +1 -1
- package/lib/esm/heartbeat.d.ts +23 -4
- package/lib/esm/heartbeat.d.ts.map +1 -1
- package/lib/esm/heartbeat.js +108 -18
- package/lib/esm/heartbeat.js.map +1 -1
- package/lib/esm/index.d.ts +3 -3
- package/lib/esm/index.d.ts.map +1 -1
- package/lib/esm/index.js +1 -1
- package/lib/esm/index.js.map +1 -1
- package/lib/esm/observers/video.d.ts +6 -3
- package/lib/esm/observers/video.d.ts.map +1 -1
- package/lib/esm/observers/video.js +41 -8
- package/lib/esm/observers/video.js.map +1 -1
- package/lib/esm/page-view-id.d.ts +3 -1
- package/lib/esm/page-view-id.d.ts.map +1 -1
- package/lib/esm/page-view-id.js +4 -2
- package/lib/esm/page-view-id.js.map +1 -1
- package/lib/esm/plugins/destination.d.ts +21 -1
- package/lib/esm/plugins/destination.d.ts.map +1 -1
- package/lib/esm/plugins/destination.js +182 -27
- package/lib/esm/plugins/destination.js.map +1 -1
- package/lib/esm/types/config/core-config.d.ts +5 -0
- package/lib/esm/types/config/core-config.d.ts.map +1 -1
- package/lib/esm/types/config/core-config.js.map +1 -1
- package/lib/esm/types/event/base-event.d.ts +1 -0
- package/lib/esm/types/event/base-event.d.ts.map +1 -1
- package/lib/esm/types/event/base-event.js.map +1 -1
- package/lib/esm/types/event/event.d.ts +4 -1
- package/lib/esm/types/event/event.d.ts.map +1 -1
- package/lib/esm/types/event/event.js.map +1 -1
- package/lib/esm/types/messages.d.ts +1 -0
- package/lib/esm/types/messages.d.ts.map +1 -1
- package/lib/esm/types/messages.js +1 -0
- package/lib/esm/types/messages.js.map +1 -1
- package/lib/esm/types/page-view-tracking.d.ts +24 -0
- package/lib/esm/types/page-view-tracking.d.ts.map +1 -1
- package/lib/esm/types/page-view-tracking.js.map +1 -1
- package/lib/esm/types/payload.d.ts +5 -0
- package/lib/esm/types/payload.d.ts.map +1 -1
- package/lib/esm/types/payload.js.map +1 -1
- package/lib/esm/video-analytics/track-video.d.ts +1 -1
- package/lib/esm/video-analytics/track-video.d.ts.map +1 -1
- package/lib/esm/video-analytics/track-video.js +107 -19
- package/lib/esm/video-analytics/track-video.js.map +1 -1
- package/lib/esm/video-analytics/types.d.ts +6 -5
- package/lib/esm/video-analytics/types.d.ts.map +1 -1
- package/lib/esm/video-analytics/types.js.map +1 -1
- package/package.json +1 -1
package/lib/cjs/config.d.ts
CHANGED
|
@@ -34,6 +34,7 @@ export declare class Config implements IConfig {
|
|
|
34
34
|
plan?: Plan;
|
|
35
35
|
ingestionMetadata?: IngestionMetadata;
|
|
36
36
|
serverUrl: string | undefined;
|
|
37
|
+
delayedEventsServerUrl?: string;
|
|
37
38
|
serverZone?: ServerZoneType;
|
|
38
39
|
transportProvider: Transport;
|
|
39
40
|
storageProvider?: Storage<Event[]>;
|
package/lib/cjs/config.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAC5C,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAC1C,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAS1C,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AAGvH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;CAY3B,CAAC;AACH,qBAAa,MAAO,YAAW,OAAO;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,mBAAmB,EAAE,MAAM,CAAC;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,OAAO,CAAC;IACxB,QAAQ,EAAE,QAAQ,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,eAAe,CAAC;IAC3C,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IACtC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,UAAU,CAAC,EAAE,cAAc,CAAC;IAC5B,iBAAiB,EAAE,SAAS,CAAC;IAC7B,eAAe,CAAC,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;IACnC,QAAQ,EAAE,OAAO,CAAC;IAClB,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC,SAAS,CAAC,OAAO,UAAS;IAC1B,IAAI,MAAM,IAGS,OAAO,CADzB;IACD,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,EAEzB;gBAEW,OAAO,EAAE,aAAa;
|
|
1
|
+
{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAC5C,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAC1C,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAS1C,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AAGvH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;CAY3B,CAAC;AACH,qBAAa,MAAO,YAAW,OAAO;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,mBAAmB,EAAE,MAAM,CAAC;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,OAAO,CAAC;IACxB,QAAQ,EAAE,QAAQ,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,eAAe,CAAC;IAC3C,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IACtC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,UAAU,CAAC,EAAE,cAAc,CAAC;IAC5B,iBAAiB,EAAE,SAAS,CAAC;IAC7B,eAAe,CAAC,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;IACnC,QAAQ,EAAE,OAAO,CAAC;IAClB,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC,SAAS,CAAC,OAAO,UAAS;IAC1B,IAAI,MAAM,IAGS,OAAO,CADzB;IACD,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,EAEzB;gBAEW,OAAO,EAAE,aAAa;CA0BnC;AAED,eAAO,MAAM,YAAY,eAAgB,cAAc,YAAY,OAAO,kKAKzE,CAAC;AAEF,eAAO,MAAM,kBAAkB,oCAEjB,cAAc,aAChB,OAAO;;;;;;CAUlB,CAAC;AAEF,qBAAa,eAAgB,YAAW,gBAAgB;IACtD,GAAG,EAAE;QACH,OAAO,EAAE;YACP,SAAS,EAAE,gBAAgB,CAAC;SAC7B,CAAC;KACH,CAAC;;IAUF,eAAe,CAAC,CAAC,SAAS,YAAY,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,gBAAgB,CAAC,CAAC,CAAC;CAG3E;AAED,cAAM,gBAAiB,YAAW,iBAAiB;IACjD,4BAA4B,CAAC,EAAE,MAAM,CAAC;IACtC,oCAAoC,CAAC,EAAE,MAAM,CAAC;IAC9C,iCAAiC,CAAC,EAAE,MAAM,CAAC;CAC5C"}
|
package/lib/cjs/config.js
CHANGED
|
@@ -37,6 +37,7 @@ var Config = /** @class */ (function () {
|
|
|
37
37
|
this.offline = options.offline !== undefined ? options.offline : defaultConfig.offline;
|
|
38
38
|
this.optOut = (_c = options.optOut) !== null && _c !== void 0 ? _c : defaultConfig.optOut;
|
|
39
39
|
this.serverUrl = options.serverUrl;
|
|
40
|
+
this.delayedEventsServerUrl = options.delayedEventsServerUrl;
|
|
40
41
|
this.serverZone = options.serverZone || defaultConfig.serverZone;
|
|
41
42
|
this.storageProvider = options.storageProvider;
|
|
42
43
|
this.transportProvider = options.transportProvider;
|
package/lib/cjs/config.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":";;;AAOA,+CAM2B;AAE3B,mCAA2C;AAC3C,6CAA4C;AAE5C,uDAA8D;AAEvD,IAAM,gBAAgB,GAAG,cAAM,OAAA,CAAC;IACrC,eAAe,EAAE,EAAE;IACnB,cAAc,EAAE,GAAG;IACnB,mBAAmB,EAAE,KAAK;IAC1B,YAAY,EAAE,iCAAqB;IACnC,QAAQ,EAAE,mBAAQ,CAAC,IAAI;IACvB,cAAc,EAAE,IAAI,eAAM,EAAE;IAC5B,OAAO,EAAE,KAAK;IACd,MAAM,EAAE,KAAK;IACb,SAAS,EAAE,gCAAoB;IAC/B,UAAU,EAAE,IAAsB;IAClC,QAAQ,EAAE,KAAK;CAChB,CAAC,EAZoC,CAYpC,CAAC;AAZU,QAAA,gBAAgB,oBAY1B;AACH;
|
|
1
|
+
{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":";;;AAOA,+CAM2B;AAE3B,mCAA2C;AAC3C,6CAA4C;AAE5C,uDAA8D;AAEvD,IAAM,gBAAgB,GAAG,cAAM,OAAA,CAAC;IACrC,eAAe,EAAE,EAAE;IACnB,cAAc,EAAE,GAAG;IACnB,mBAAmB,EAAE,KAAK;IAC1B,YAAY,EAAE,iCAAqB;IACnC,QAAQ,EAAE,mBAAQ,CAAC,IAAI;IACvB,cAAc,EAAE,IAAI,eAAM,EAAE;IAC5B,OAAO,EAAE,KAAK;IACd,MAAM,EAAE,KAAK;IACb,SAAS,EAAE,gCAAoB;IAC/B,UAAU,EAAE,IAAsB;IAClC,QAAQ,EAAE,KAAK;CAChB,CAAC,EAZoC,CAYpC,CAAC;AAZU,QAAA,gBAAgB,oBAY1B;AACH;IA4BE,gBAAY,OAAsB;;QARxB,YAAO,GAAG,KAAK,CAAC;QASxB,IAAM,aAAa,GAAG,IAAA,wBAAgB,GAAE,CAAC;QACzC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,mBAAmB,GAAG,MAAA,OAAO,CAAC,mBAAmB,mCAAI,aAAa,CAAC,mBAAmB,CAAC;QAC5F,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,IAAI,aAAa,CAAC,eAAe,CAAC;QAChF,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,IAAI,aAAa,CAAC,cAAc,CAAC;QAC7E,IAAI,CAAC,YAAY,GAAG,IAAA,qCAAqB,EAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAChE,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,IAAI,aAAa,CAAC,cAAc,CAAC;QAC7E,IAAI,CAAC,QAAQ,GAAG,MAAA,OAAO,CAAC,QAAQ,mCAAI,aAAa,CAAC,QAAQ,CAAC;QAC3D,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC;QACnD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC;QACvF,IAAI,CAAC,MAAM,GAAG,MAAA,OAAO,CAAC,MAAM,mCAAI,aAAa,CAAC,MAAM,CAAC;QACrD,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,sBAAsB,GAAG,OAAO,CAAC,sBAAsB,CAAC;QAC7D,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,aAAa,CAAC,UAAU,CAAC;QACjE,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;QAC/C,IAAI,CAAC,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC;QACnD,IAAI,CAAC,QAAQ,GAAG,MAAA,OAAO,CAAC,QAAQ,mCAAI,aAAa,CAAC,QAAQ,CAAC;QAC3D,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAE1C,IAAM,YAAY,GAAG,IAAA,0BAAkB,EAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;QACjG,IAAI,CAAC,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC;QAC1C,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC,SAAS,CAAC;IAC1C,CAAC;IAhCD,sBAAI,0BAAM;aAAV;YACE,OAAO,IAAI,CAAC,OAAO,CAAC;QACtB,CAAC;aACD,UAAW,MAAe;YACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACxB,CAAC;;;OAHA;IA+BH,aAAC;AAAD,CAAC,AAtDD,IAsDC;AAtDY,wBAAM;AAwDZ,IAAM,YAAY,GAAG,UAAC,UAA0B,EAAE,QAAiB;IACxE,IAAI,UAAU,KAAK,IAAI,EAAE;QACvB,OAAO,QAAQ,CAAC,CAAC,CAAC,yCAA6B,CAAC,CAAC,CAAC,mCAAuB,CAAC;KAC3E;IACD,OAAO,QAAQ,CAAC,CAAC,CAAC,sCAA0B,CAAC,CAAC,CAAC,gCAAoB,CAAC;AACtE,CAAC,CAAC;AALW,QAAA,YAAY,gBAKvB;AAEK,IAAM,kBAAkB,GAAG,UAChC,SAAc,EACd,UAA0D,EAC1D,QAA+C;IAF/C,0BAAA,EAAA,cAAc;IACd,2BAAA,EAAA,aAA6B,IAAA,wBAAgB,GAAE,CAAC,UAAU;IAC1D,yBAAA,EAAA,WAAoB,IAAA,wBAAgB,GAAE,CAAC,QAAQ;IAE/C,IAAI,SAAS,EAAE;QACb,OAAO,EAAE,SAAS,WAAA,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;KAC7C;IACD,IAAM,WAAW,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,IAAA,wBAAgB,GAAE,CAAC,UAAU,CAAC;IACnG,OAAO;QACL,UAAU,EAAE,WAAW;QACvB,SAAS,EAAE,IAAA,oBAAY,EAAC,WAAW,EAAE,QAAQ,CAAC;KAC/C,CAAC;AACJ,CAAC,CAAC;AAbW,QAAA,kBAAkB,sBAa7B;AAEF;IAOE;QACE,IAAI,CAAC,GAAG,GAAG;YACT,OAAO,EAAE;gBACP,SAAS,EAAE,EAAE;aACd;SACF,CAAC;IACJ,CAAC;IAED,yCAAe,GAAf,UAAwC,GAAM,EAAE,KAA0B;QACxE,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IAC1C,CAAC;IACH,sBAAC;AAAD,CAAC,AAlBD,IAkBC;AAlBY,0CAAe;AAoB5B;IAAA;IAIA,CAAC;IAAD,uBAAC;AAAD,CAAC,AAJD,IAIC","sourcesContent":["import { OfflineDisabled } from './types/offline';\nimport { ServerZoneType } from './types/server-zone';\nimport { Transport } from './types/transport';\nimport { Event } from './types/event/event';\nimport { Plan } from './types/event/plan';\nimport { IngestionMetadata } from './types/event/ingestion-metadata';\nimport { Storage } from './types/storage';\nimport {\n AMPLITUDE_SERVER_URL,\n AMPLITUDE_BATCH_SERVER_URL,\n EU_AMPLITUDE_SERVER_URL,\n EU_AMPLITUDE_BATCH_SERVER_URL,\n DEFAULT_INSTANCE_NAME,\n} from './types/constants';\n\nimport { Logger, ILogger } from './logger';\nimport { LogLevel } from './types/loglevel';\nimport { ConfigOptions, IRequestMetadata, IHistogramOptions, HistogramKey, IConfig } from './types/config/core-config';\nimport { normalizeInstanceName } from './utils/instance-name';\n\nexport const getDefaultConfig = () => ({\n flushMaxRetries: 12,\n flushQueueSize: 200,\n flushIntervalMillis: 10000,\n instanceName: DEFAULT_INSTANCE_NAME,\n logLevel: LogLevel.Warn,\n loggerProvider: new Logger(),\n offline: false,\n optOut: false,\n serverUrl: AMPLITUDE_SERVER_URL,\n serverZone: 'US' as ServerZoneType,\n useBatch: false,\n});\nexport class Config implements IConfig {\n apiKey: string;\n flushIntervalMillis: number;\n flushMaxRetries: number;\n flushQueueSize: number;\n instanceName?: string;\n loggerProvider: ILogger;\n logLevel: LogLevel;\n minIdLength?: number;\n offline?: boolean | typeof OfflineDisabled;\n plan?: Plan;\n ingestionMetadata?: IngestionMetadata;\n serverUrl: string | undefined;\n delayedEventsServerUrl?: string;\n serverZone?: ServerZoneType;\n transportProvider: Transport;\n storageProvider?: Storage<Event[]>;\n useBatch: boolean;\n requestMetadata?: RequestMetadata;\n\n protected _optOut = false;\n get optOut() {\n return this._optOut;\n }\n set optOut(optOut: boolean) {\n this._optOut = optOut;\n }\n\n constructor(options: ConfigOptions) {\n const defaultConfig = getDefaultConfig();\n this.apiKey = options.apiKey;\n this.flushIntervalMillis = options.flushIntervalMillis ?? defaultConfig.flushIntervalMillis;\n this.flushMaxRetries = options.flushMaxRetries || defaultConfig.flushMaxRetries;\n this.flushQueueSize = options.flushQueueSize || defaultConfig.flushQueueSize;\n this.instanceName = normalizeInstanceName(options.instanceName);\n this.loggerProvider = options.loggerProvider || defaultConfig.loggerProvider;\n this.logLevel = options.logLevel ?? defaultConfig.logLevel;\n this.minIdLength = options.minIdLength;\n this.plan = options.plan;\n this.ingestionMetadata = options.ingestionMetadata;\n this.offline = options.offline !== undefined ? options.offline : defaultConfig.offline;\n this.optOut = options.optOut ?? defaultConfig.optOut;\n this.serverUrl = options.serverUrl;\n this.delayedEventsServerUrl = options.delayedEventsServerUrl;\n this.serverZone = options.serverZone || defaultConfig.serverZone;\n this.storageProvider = options.storageProvider;\n this.transportProvider = options.transportProvider;\n this.useBatch = options.useBatch ?? defaultConfig.useBatch;\n this.loggerProvider.enable(this.logLevel);\n\n const serverConfig = createServerConfig(options.serverUrl, options.serverZone, options.useBatch);\n this.serverZone = serverConfig.serverZone;\n this.serverUrl = serverConfig.serverUrl;\n }\n}\n\nexport const getServerUrl = (serverZone: ServerZoneType, useBatch: boolean) => {\n if (serverZone === 'EU') {\n return useBatch ? EU_AMPLITUDE_BATCH_SERVER_URL : EU_AMPLITUDE_SERVER_URL;\n }\n return useBatch ? AMPLITUDE_BATCH_SERVER_URL : AMPLITUDE_SERVER_URL;\n};\n\nexport const createServerConfig = (\n serverUrl = '',\n serverZone: ServerZoneType = getDefaultConfig().serverZone,\n useBatch: boolean = getDefaultConfig().useBatch,\n) => {\n if (serverUrl) {\n return { serverUrl, serverZone: undefined };\n }\n const _serverZone = ['US', 'EU'].includes(serverZone) ? serverZone : getDefaultConfig().serverZone;\n return {\n serverZone: _serverZone,\n serverUrl: getServerUrl(_serverZone, useBatch),\n };\n};\n\nexport class RequestMetadata implements IRequestMetadata {\n sdk: {\n metrics: {\n histogram: HistogramOptions;\n };\n };\n\n constructor() {\n this.sdk = {\n metrics: {\n histogram: {},\n },\n };\n }\n\n recordHistogram<T extends HistogramKey>(key: T, value: HistogramOptions[T]) {\n this.sdk.metrics.histogram[key] = value;\n }\n}\n\nclass HistogramOptions implements IHistogramOptions {\n remote_config_fetch_time_IDB?: number;\n remote_config_fetch_time_API_success?: number;\n remote_config_fetch_time_API_fail?: number;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"core-client.d.ts","sourceRoot":"","sources":["../../src/core-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACxC,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AACrD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACnE,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACxC,OAAO,EACL,KAAK,EAIL,cAAc,EACf,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,SAAS,EAA6B,MAAM,YAAY,CAAC;AAClE,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;
|
|
1
|
+
{"version":3,"file":"core-client.d.ts","sourceRoot":"","sources":["../../src/core-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACxC,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AACrD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACnE,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACxC,OAAO,EACL,KAAK,EAIL,cAAc,EACf,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,SAAS,EAA6B,MAAM,YAAY,CAAC;AAClE,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAOrC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAStC,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AACpE,qBAAa,aAAc,YAAW,UAAU,EAAE,UAAU;IAC1D,SAAS,CAAC,YAAY,UAAS;IAC/B,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC;IAGvB,MAAM,EAAE,OAAO,CAAC;IAGhB,QAAQ,EAAE,QAAQ,CAAC;IACnB,OAAO,UAAS;IAChB,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,gBAAgB,GAAG,OAAO,aAAa,CAAC,CAAM;IACjE,SAAS,CAAC,SAAS,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAM;IAElD;;;OAGG;IACH,cAAc,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,SAAS,CAAC;gBAEvC,IAAI,SAAa;cAKb,KAAK,CAAC,MAAM,EAAE,OAAO;IAO/B,kBAAkB,CAAC,SAAS,EAAE,GAAG,GAAG,WAAW,EAAE,YAAY,CAAC,EAAE,MAAM,IAAI;IAuBhF,KAAK,CAAC,UAAU,EAAE,SAAS,GAAG,MAAM,EAAE,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,YAAY,CAAC,EAAE,YAAY;IAOxG,QAAQ,eAPU,SAAS,GAAG,MAAM,oBAAoB,OAAO,MAAM,EAAE,GAAG,CAAC,iBAAiB,YAAY,8DAOvE;IAEjC,QAAQ,CAAC,QAAQ,EAAE,SAAS,EAAE,YAAY,CAAC,EAAE,YAAY;IAOzD,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,YAAY,CAAC,EAAE,YAAY;IAK/G,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,YAAY,CAAC,EAAE,YAAY;IAOrF,OAAO,CAAC,OAAO,EAAE,QAAQ,EAAE,YAAY,CAAC,EAAE,YAAY;IAKtD,GAAG,CAAC,MAAM,EAAE,MAAM;IAQlB,UAAU,CAAC,MAAM,EAAE,MAAM;IAIzB,MAAM,CAAC,UAAU,EAAE,MAAM;IAQzB,aAAa,CAAC,UAAU,EAAE,MAAM;IAIhC,oBAAoB,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;IAOtE,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC;IAU7C;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,iCAAiC,CAAC,cAAc,EAAE,cAAc,GAAG,SAAS,GAAG;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE;IAuD/F,OAAO,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC;IA4C5C,SAAS,CAAC,MAAM,EAAE,OAAO;IAQzB,UAAU,CAAC,MAAM,EAAE,OAAO;IAO1B,KAAK;IAIL,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAUxC,OAAO,CAAC,CAAC,SAAS,MAAM,EAAE,WAAW,EAAE;QAAE,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;KAAE,GAAG,CAAC,EAAE;CAGzE"}
|
package/lib/cjs/core-client.js
CHANGED
|
@@ -254,6 +254,10 @@ var AmplitudeCore = /** @class */ (function () {
|
|
|
254
254
|
return [4 /*yield*/, this.timeline.push(event)];
|
|
255
255
|
case 1:
|
|
256
256
|
result = _a.sent();
|
|
257
|
+
// Replacing a stale delayed event is expected and should not produce console output.
|
|
258
|
+
if (result.code === 0 && result.message === messages_1.STALE_EVENT_OVERWRITTEN_MESSAGE) {
|
|
259
|
+
return [2 /*return*/, result];
|
|
260
|
+
}
|
|
257
261
|
result.code === 200
|
|
258
262
|
? this.config.loggerProvider.log(result.message)
|
|
259
263
|
: result.code === 100
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"core-client.js","sourceRoot":"","sources":["../../src/core-client.ts"],"names":[],"mappings":";;;;AAIA,6CAM6B;AAC7B,uCAAkE;AAElE,6CAAqG;AACrG,uCAAsC;AACtC,uDAM+B;AAC/B,yDAAqD;AACrD,yDAAuD;AAEvD;IAmBE,uBAAY,IAAiB;QAAjB,qBAAA,EAAA,iBAAiB;QAlBnB,iBAAY,GAAG,KAAK,CAAC;QAQ/B,YAAO,GAAG,KAAK,CAAC;QACN,MAAC,GAAmD,EAAE,CAAC;QACvD,cAAS,GAA4B,EAAE,CAAC;QAkDlD,aAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAzC/B,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAEe,6BAAK,GAArB,UAAsB,MAAe;;;;;;wBACnC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;wBACrB,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;wBAC1B,IAAI,CAAC,QAAQ,CAAC,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;wBAC1D,qBAAM,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,cAAM,OAAA,CAAC,KAAI,CAAC,OAAO,GAAG,IAAI,CAAC,EAArB,CAAqB,CAAC,EAAA;;wBAA/D,SAA+D,CAAC;;;;;KACjE;IAEK,0CAAkB,GAAxB,UAAyB,SAA4B,EAAE,YAAyB;;;;;;;wBACxE,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;wBACxC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC;;;;wBACQ,oBAAA,iBAAA,eAAe,CAAA;;;;wBAAjC,cAAc;wBAIjB,GAAG,GAAoD,cAAc,EAAE,CAAC;6BAC1E,CAAA,GAAG,IAAI,SAAS,IAAI,GAAG,CAAA,EAAvB,wBAAuB;wBACzB,qBAAM,GAAG,CAAC,OAAO,EAAA;;wBAAjB,SAAiB,CAAC;;4BAElB,qBAAM,GAAG,EAAA;;wBAAT,SAAS,CAAC;;;;;;;;;;;;;;;;;6BAKV,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,EAAtB,yBAAsB;wBACxB,qBAAM,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,YAAY,CAAC,EAAA;;wBAAtD,SAAsD,CAAC;;;wBAEvD,YAAY,aAAZ,YAAY,uBAAZ,YAAY,EAAI,CAAC;;;;;;KAEpB;IAED,6BAAK,GAAL,UAAM,UAA8B,EAAE,eAAqC,EAAE,YAA2B;QACtG,IAAM,KAAK,GAAG,IAAA,gCAAgB,EAAC,UAAU,EAAE,eAAe,EAAE,YAAY,CAAC,CAAC;QAC1E,8DAA8D;QAC9D,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,iCAAiC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QACpF,OAAO,IAAA,8BAAa,EAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7C,CAAC;IAID,gCAAQ,GAAR,UAAS,QAAmB,EAAE,YAA2B;QACvD,IAAM,KAAK,GAAG,IAAA,mCAAmB,EAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QAC1D,8DAA8D;QAC9D,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,iCAAiC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QACpF,OAAO,IAAA,8BAAa,EAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED,qCAAa,GAAb,UAAc,SAAiB,EAAE,SAA4B,EAAE,QAAmB,EAAE,YAA2B;QAC7G,IAAM,KAAK,GAAG,IAAA,wCAAwB,EAAC,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;QACrF,OAAO,IAAA,8BAAa,EAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED,gCAAQ,GAAR,UAAS,SAAiB,EAAE,SAA4B,EAAE,YAA2B;QACnF,IAAM,KAAK,GAAG,IAAA,gCAAgB,EAAC,SAAS,EAAE,SAAS,EAAE,YAAY,CAAC,CAAC;QACnE,8DAA8D;QAC9D,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,iCAAiC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QACpF,OAAO,IAAA,8BAAa,EAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED,+BAAO,GAAP,UAAQ,OAAiB,EAAE,YAA2B;QACpD,IAAM,KAAK,GAAG,IAAA,kCAAkB,EAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QACxD,OAAO,IAAA,8BAAa,EAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED,2BAAG,GAAH,UAAI,MAAc;QAChB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;YAChD,OAAO,IAAA,8BAAa,GAAE,CAAC;SACxB;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAED,kCAAU,GAAV,UAAW,MAAc;QACvB,OAAO,IAAA,8BAAa,EAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IACpE,CAAC;IAED,8BAAM,GAAN,UAAO,UAAkB;QACvB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;YACvD,OAAO,IAAA,8BAAa,GAAE,CAAC;SACxB;QACD,OAAO,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IACxC,CAAC;IAED,qCAAa,GAAb,UAAc,UAAkB;QAC9B,OAAO,IAAA,8BAAa,EAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAC1E,CAAC;IAED,4CAAoB,GAApB,UAAqB,KAAY,EAAE,QAAkC;QACnE,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,OAAO,QAAQ,CAAC,IAAA,4BAAW,EAAC,KAAK,EAAE,CAAC,EAAE,iCAAsB,CAAC,CAAC,CAAC;SAChE;QACD,KAAK,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC1C,CAAC;IAEK,gCAAQ,GAAd,UAAe,KAAY;;;;gBACzB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;oBACjB,sBAAO,IAAI,OAAO,CAAS,UAAC,OAAO;4BACjC,KAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,KAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;wBAC5E,CAAC,CAAC,EAAC;iBACJ;gBAED,sBAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAC;;;KAC5B;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,yDAAiC,GAAjC,UAAkC,cAA0C;;QAC1E,IAAM,IAAI,GAAG,MAAA,IAAI,CAAC,cAAc,mCAAI,EAAE,CAAC;QACvC,IAAM,iBAAiB,wBAAgC,IAAI,CAAE,CAAC;QAE9D,IAAI,cAAc,KAAK,SAAS,EAAE;YAChC,OAAO,iBAAiB,CAAC;SAC1B;QAED,0CAA0C;QAC1C,IAAM,eAAe,GAEjB,EAAE,CAAC;QACP,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,UAAC,GAAG;YACtC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,yBAAiB,CAAC,CAAC,QAAQ,CAAC,GAAwB,CAAC,EAAE;gBACxE,6DAA6D;gBAC7D,aAAa;gBACb,mEAAmE;gBACnE,eAAe,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;aAC5C;QACH,CAAC,CAAC,CAAC;QAEH,oCAAyB,CAAC,OAAO,CAAC,UAAC,SAAS;YAC1C,iCAAiC;YACjC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC;gBAAE,OAAO;YAE7D,mEAAmE;YACnE,IAAM,YAAY,GAA2B,cAAc,CAAC,SAAS,CAAC,CAAC;YAEvE,QAAQ,SAAS,EAAE;gBACjB,KAAK,yBAAiB,CAAC,SAAS;oBAC9B,iEAAiE;oBACjE,0BAA0B;oBAC1B,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,OAAO,CAAC,UAAC,IAAI;wBAC1C,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAC;oBACjC,CAAC,CAAC,CAAC;oBACH,MAAM;gBACR,KAAK,yBAAiB,CAAC,KAAK;oBAC1B,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,UAAC,IAAI;wBACrC,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAC;oBACjC,CAAC,CAAC,CAAC;oBACH,MAAM;gBACR,KAAK,yBAAiB,CAAC,GAAG;oBACxB,MAAM,CAAC,MAAM,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;oBAC/C,MAAM;aACT;QACH,CAAC,CAAC,CAAC;QAEH,kCAAkC;QAClC,0DAA0D;QAC1D,wKAAwK;QACxK,MAAM,CAAC,MAAM,CAAC,iBAAiB,EAAE,eAAe,CAAC,CAAC;QAElD,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAEK,+BAAO,GAAb,UAAc,KAAY;;;;;;;wBAEtB,mCAAmC;wBACnC,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;4BACtB,sBAAO,IAAA,4BAAW,EAAC,KAAK,EAAE,CAAC,EAAE,0BAAe,CAAC,EAAC;yBAC/C;wBAIK,SAAS,GAAY,KAAK,CAAC,UAAU,CAAC;wBAC5C,IAAI,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE;4BAClE,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,mCAAwB,CAAC,CAAC;4BAC3D,sBAAO,IAAA,4BAAW,EAAC,KAAK,EAAE,CAAC,EAAE,mCAAwB,CAAC,EAAC;yBACxD;wBAED,IAAI,KAAK,CAAC,UAAU,KAAK,wBAAgB,CAAC,QAAQ,EAAE;4BAClD,0CAA0C;4BAC1C,8DAA8D;4BAC9D,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,cAAc,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC;yBAC1E;wBAEc,qBAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,EAAA;;wBAAxC,MAAM,GAAG,SAA+B;wBAE9C,MAAM,CAAC,IAAI,KAAK,GAAG;4BACjB,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC;4BAChD,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,GAAG;gCACrB,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;gCACjD,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;wBAErD,sBAAO,MAAM,EAAC;;;wBAER,OAAO,GAAG,MAAM,CAAC,GAAC,CAAC,CAAC;wBAC1B,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;wBACpC,MAAM,GAAG,IAAA,4BAAW,EAAC,KAAK,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;wBAE9C,sBAAO,MAAM,EAAC;;;;;KAEjB;IAED,iCAAS,GAAT,UAAU,MAAe;QACvB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YACzD,OAAO;SACR;QACD,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAC1B,CAAC;IAED,kCAAU,GAAV,UAAW,MAAe;QACxB,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,MAAM,EAAE;YACjC,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;YACrC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;SACvC;IACH,CAAC;IAED,6BAAK,GAAL;QACE,OAAO,IAAA,8BAAa,EAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED,8BAAM,GAAN,UAAO,IAAY;QACjB,IAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,UAAC,MAAM,IAAK,OAAA,MAAM,CAAC,IAAI,KAAK,IAAI,EAApB,CAAoB,CAAC,CAAC;QAC5E,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,uCAAgC,IAAI,CAAE,CAAC,CAAC;YACzE,OAAO,SAAS,CAAC;SAClB;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,+BAAO,GAAP,UAA0B,WAAwC;QAChE,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,UAAC,MAAM,IAAK,OAAA,MAAM,YAAY,WAAW,EAA7B,CAA6B,CAAQ,CAAC;IACxF,CAAC;IACH,oBAAC;AAAD,CAAC,AAxRD,IAwRC;AAxRY,sCAAa","sourcesContent":["import { Plugin } from './types/plugin';\nimport { IConfig } from './types/config/core-config';\nimport { BaseEvent, EventOptions } from './types/event/base-event';\nimport { Result } from './types/result';\nimport {\n Event,\n IdentifyOperation,\n IdentifyUserProperties,\n SpecialEventType,\n UserProperties,\n} from './types/event/event';\nimport { IIdentify, OrderedIdentifyOperations } from './identify';\nimport { IRevenue } from './revenue';\nimport { CLIENT_NOT_INITIALIZED, EMPTY_EVENT_TYPE_MESSAGE, OPT_OUT_MESSAGE } from './types/messages';\nimport { Timeline } from './timeline';\nimport {\n createGroupEvent,\n createGroupIdentifyEvent,\n createIdentifyEvent,\n createRevenueEvent,\n createTrackEvent,\n} from './utils/event-builder';\nimport { buildResult } from './utils/result-builder';\nimport { returnWrapper } from './utils/return-wrapper';\nimport { CoreClient, PluginHost } from './types/client/core-client';\nexport class AmplitudeCore implements CoreClient, PluginHost {\n protected initializing = false;\n protected name: string;\n // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n // @ts-ignore\n config: IConfig;\n // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n // @ts-ignore\n timeline: Timeline;\n isReady = false;\n protected q: Array<CallableFunction | typeof returnWrapper> = [];\n protected dispatchQ: Array<CallableFunction> = [];\n\n /**\n * Current user properties (operation-applied, flat key-value).\n * Only used by client-side SDKs; server SDKs may leave this undefined.\n */\n userProperties: { [key: string]: any } | undefined;\n\n constructor(name = '$default') {\n this.timeline = new Timeline(this);\n this.name = name;\n }\n\n protected async _init(config: IConfig) {\n this.config = config;\n this.timeline.reset(this);\n this.timeline.loggerProvider = this.config.loggerProvider;\n await this.runQueuedFunctions('q', () => (this.isReady = true));\n }\n\n async runQueuedFunctions(queueName: 'q' | 'dispatchQ', onQueueEmpty?: () => void) {\n const queuedFunctions = this[queueName];\n this[queueName] = [];\n for (const queuedFunction of queuedFunctions) {\n // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n // @ts-ignore\n // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n const val: ReturnType<typeof returnWrapper> | Promise<any> = queuedFunction();\n if (val && 'promise' in val) {\n await val.promise;\n } else {\n await val;\n }\n }\n\n // Rerun queued functions if the queue has accrued more while awaiting promises\n if (this[queueName].length) {\n await this.runQueuedFunctions(queueName, onQueueEmpty);\n } else {\n onQueueEmpty?.();\n }\n }\n\n track(eventInput: BaseEvent | string, eventProperties?: Record<string, any>, eventOptions?: EventOptions) {\n const event = createTrackEvent(eventInput, eventProperties, eventOptions);\n // Update client user properties immediately and synchronously\n this.userProperties = this.getOperationAppliedUserProperties(event.user_properties);\n return returnWrapper(this.dispatch(event));\n }\n\n logEvent = this.track.bind(this);\n\n identify(identify: IIdentify, eventOptions?: EventOptions) {\n const event = createIdentifyEvent(identify, eventOptions);\n // Update client user properties immediately and synchronously\n this.userProperties = this.getOperationAppliedUserProperties(event.user_properties);\n return returnWrapper(this.dispatch(event));\n }\n\n groupIdentify(groupType: string, groupName: string | string[], identify: IIdentify, eventOptions?: EventOptions) {\n const event = createGroupIdentifyEvent(groupType, groupName, identify, eventOptions);\n return returnWrapper(this.dispatch(event));\n }\n\n setGroup(groupType: string, groupName: string | string[], eventOptions?: EventOptions) {\n const event = createGroupEvent(groupType, groupName, eventOptions);\n // Update client user properties immediately and synchronously\n this.userProperties = this.getOperationAppliedUserProperties(event.user_properties);\n return returnWrapper(this.dispatch(event));\n }\n\n revenue(revenue: IRevenue, eventOptions?: EventOptions) {\n const event = createRevenueEvent(revenue, eventOptions);\n return returnWrapper(this.dispatch(event));\n }\n\n add(plugin: Plugin) {\n if (!this.isReady) {\n this.q.push(this._addPlugin.bind(this, plugin));\n return returnWrapper();\n }\n return this._addPlugin(plugin);\n }\n\n _addPlugin(plugin: Plugin) {\n return returnWrapper(this.timeline.register(plugin, this.config));\n }\n\n remove(pluginName: string) {\n if (!this.isReady) {\n this.q.push(this._removePlugin.bind(this, pluginName));\n return returnWrapper();\n }\n return this._removePlugin(pluginName);\n }\n\n _removePlugin(pluginName: string) {\n return returnWrapper(this.timeline.deregister(pluginName, this.config));\n }\n\n dispatchWithCallback(event: Event, callback: (result: Result) => void): void {\n if (!this.isReady) {\n return callback(buildResult(event, 0, CLIENT_NOT_INITIALIZED));\n }\n void this.process(event).then(callback);\n }\n\n async dispatch(event: Event): Promise<Result> {\n if (!this.isReady) {\n return new Promise<Result>((resolve) => {\n this.dispatchQ.push(this.dispatchWithCallback.bind(this, event, resolve));\n });\n }\n\n return this.process(event);\n }\n\n /**\n *\n * This method applies identify operations to user properties and\n * returns a single object representing the final user property state.\n *\n * This is a best-effort api that only supports $set, $clearAll, and $unset.\n * Other operations are not supported and are ignored.\n *\n * Operations are applied on top of current client state (this.userProperties).\n *\n * @param userProperties The new user properties object from identify() or setIdentity().\n * @returns A key-value object user properties without operations.\n *\n * @example\n * Input:\n * {\n * $set: { plan: 'premium' },\n * custom_flag: true\n * }\n *\n * Output:\n * {\n * plan: 'premium',\n * custom_flag: true\n * }\n */\n getOperationAppliedUserProperties(userProperties: UserProperties | undefined): { [key: string]: any } {\n const base = this.userProperties ?? {};\n const updatedProperties: { [key: string]: any } = { ...base };\n\n if (userProperties === undefined) {\n return updatedProperties;\n }\n\n // Keep non-operation keys for later merge\n const nonOpProperties: {\n [key in Exclude<string, IdentifyOperation>]: any;\n } = {};\n Object.keys(userProperties).forEach((key) => {\n if (!Object.values(IdentifyOperation).includes(key as IdentifyOperation)) {\n // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n // @ts-ignore\n // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n nonOpProperties[key] = userProperties[key];\n }\n });\n\n OrderedIdentifyOperations.forEach((operation) => {\n // Skip when key is an operation.\n if (!Object.keys(userProperties).includes(operation)) return;\n\n // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n const opProperties: IdentifyUserProperties = userProperties[operation];\n\n switch (operation) {\n case IdentifyOperation.CLEAR_ALL:\n // Due to operation order, the following line will never execute.\n /* istanbul ignore next */\n Object.keys(updatedProperties).forEach((prop) => {\n delete updatedProperties[prop];\n });\n break;\n case IdentifyOperation.UNSET:\n Object.keys(opProperties).forEach((prop) => {\n delete updatedProperties[prop];\n });\n break;\n case IdentifyOperation.SET:\n Object.assign(updatedProperties, opProperties);\n break;\n }\n });\n\n // Merge non-operation properties.\n // Custom properties should not be affected by operations.\n // https://github.com/amplitude/nova/blob/343f678ded83c032e83b189796b3c2be161b48f5/src/main/java/com/amplitude/userproperty/model/ModifyUserPropertiesIdent.java#L79-L83\n Object.assign(updatedProperties, nonOpProperties);\n\n return updatedProperties;\n }\n\n async process(event: Event): Promise<Result> {\n try {\n // skip event processing if opt out\n if (this.config.optOut) {\n return buildResult(event, 0, OPT_OUT_MESSAGE);\n }\n\n // The event server 400s a blank event type, which also forces the rest of its\n // upload batch to be retried, so drop it before it ever reaches a destination.\n const eventType: unknown = event.event_type;\n if (typeof eventType !== 'string' || eventType.trim().length === 0) {\n this.config.loggerProvider.error(EMPTY_EVENT_TYPE_MESSAGE);\n return buildResult(event, 0, EMPTY_EVENT_TYPE_MESSAGE);\n }\n\n if (event.event_type === SpecialEventType.IDENTIFY) {\n // Do not update this.userProperties here.\n // It is only set synchronously in identify() or setIdentity()\n this.timeline.onIdentityChanged({ userProperties: this.userProperties });\n }\n\n const result = await this.timeline.push(event);\n\n result.code === 200\n ? this.config.loggerProvider.log(result.message)\n : result.code === 100\n ? this.config.loggerProvider.warn(result.message)\n : this.config.loggerProvider.error(result.message);\n\n return result;\n } catch (e) {\n const message = String(e);\n this.config.loggerProvider.error(message);\n const result = buildResult(event, 0, message);\n\n return result;\n }\n }\n\n setOptOut(optOut: boolean) {\n if (!this.isReady) {\n this.q.push(this._setOptOut.bind(this, Boolean(optOut)));\n return;\n }\n this._setOptOut(optOut);\n }\n\n _setOptOut(optOut: boolean) {\n if (this.config.optOut !== optOut) {\n this.config.optOut = Boolean(optOut);\n this.timeline.onOptOutChanged(optOut);\n }\n }\n\n flush() {\n return returnWrapper(this.timeline.flush());\n }\n\n plugin(name: string): Plugin | undefined {\n const plugin = this.timeline.plugins.find((plugin) => plugin.name === name);\n if (plugin === undefined) {\n this.config.loggerProvider.debug(`Cannot find plugin with name ${name}`);\n return undefined;\n }\n\n return plugin;\n }\n\n plugins<T extends Plugin>(pluginClass: { new (...args: any[]): T }): T[] {\n return this.timeline.plugins.filter((plugin) => plugin instanceof pluginClass) as T[];\n }\n}\n"]}
|
|
1
|
+
{"version":3,"file":"core-client.js","sourceRoot":"","sources":["../../src/core-client.ts"],"names":[],"mappings":";;;;AAIA,6CAM6B;AAC7B,uCAAkE;AAElE,6CAK0B;AAC1B,uCAAsC;AACtC,uDAM+B;AAC/B,yDAAqD;AACrD,yDAAuD;AAEvD;IAmBE,uBAAY,IAAiB;QAAjB,qBAAA,EAAA,iBAAiB;QAlBnB,iBAAY,GAAG,KAAK,CAAC;QAQ/B,YAAO,GAAG,KAAK,CAAC;QACN,MAAC,GAAmD,EAAE,CAAC;QACvD,cAAS,GAA4B,EAAE,CAAC;QAkDlD,aAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAzC/B,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAEe,6BAAK,GAArB,UAAsB,MAAe;;;;;;wBACnC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;wBACrB,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;wBAC1B,IAAI,CAAC,QAAQ,CAAC,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;wBAC1D,qBAAM,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,cAAM,OAAA,CAAC,KAAI,CAAC,OAAO,GAAG,IAAI,CAAC,EAArB,CAAqB,CAAC,EAAA;;wBAA/D,SAA+D,CAAC;;;;;KACjE;IAEK,0CAAkB,GAAxB,UAAyB,SAA4B,EAAE,YAAyB;;;;;;;wBACxE,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;wBACxC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC;;;;wBACQ,oBAAA,iBAAA,eAAe,CAAA;;;;wBAAjC,cAAc;wBAIjB,GAAG,GAAoD,cAAc,EAAE,CAAC;6BAC1E,CAAA,GAAG,IAAI,SAAS,IAAI,GAAG,CAAA,EAAvB,wBAAuB;wBACzB,qBAAM,GAAG,CAAC,OAAO,EAAA;;wBAAjB,SAAiB,CAAC;;4BAElB,qBAAM,GAAG,EAAA;;wBAAT,SAAS,CAAC;;;;;;;;;;;;;;;;;6BAKV,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,EAAtB,yBAAsB;wBACxB,qBAAM,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,YAAY,CAAC,EAAA;;wBAAtD,SAAsD,CAAC;;;wBAEvD,YAAY,aAAZ,YAAY,uBAAZ,YAAY,EAAI,CAAC;;;;;;KAEpB;IAED,6BAAK,GAAL,UAAM,UAA8B,EAAE,eAAqC,EAAE,YAA2B;QACtG,IAAM,KAAK,GAAG,IAAA,gCAAgB,EAAC,UAAU,EAAE,eAAe,EAAE,YAAY,CAAC,CAAC;QAC1E,8DAA8D;QAC9D,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,iCAAiC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QACpF,OAAO,IAAA,8BAAa,EAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7C,CAAC;IAID,gCAAQ,GAAR,UAAS,QAAmB,EAAE,YAA2B;QACvD,IAAM,KAAK,GAAG,IAAA,mCAAmB,EAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QAC1D,8DAA8D;QAC9D,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,iCAAiC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QACpF,OAAO,IAAA,8BAAa,EAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED,qCAAa,GAAb,UAAc,SAAiB,EAAE,SAA4B,EAAE,QAAmB,EAAE,YAA2B;QAC7G,IAAM,KAAK,GAAG,IAAA,wCAAwB,EAAC,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;QACrF,OAAO,IAAA,8BAAa,EAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED,gCAAQ,GAAR,UAAS,SAAiB,EAAE,SAA4B,EAAE,YAA2B;QACnF,IAAM,KAAK,GAAG,IAAA,gCAAgB,EAAC,SAAS,EAAE,SAAS,EAAE,YAAY,CAAC,CAAC;QACnE,8DAA8D;QAC9D,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,iCAAiC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QACpF,OAAO,IAAA,8BAAa,EAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED,+BAAO,GAAP,UAAQ,OAAiB,EAAE,YAA2B;QACpD,IAAM,KAAK,GAAG,IAAA,kCAAkB,EAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QACxD,OAAO,IAAA,8BAAa,EAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED,2BAAG,GAAH,UAAI,MAAc;QAChB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;YAChD,OAAO,IAAA,8BAAa,GAAE,CAAC;SACxB;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAED,kCAAU,GAAV,UAAW,MAAc;QACvB,OAAO,IAAA,8BAAa,EAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IACpE,CAAC;IAED,8BAAM,GAAN,UAAO,UAAkB;QACvB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;YACvD,OAAO,IAAA,8BAAa,GAAE,CAAC;SACxB;QACD,OAAO,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IACxC,CAAC;IAED,qCAAa,GAAb,UAAc,UAAkB;QAC9B,OAAO,IAAA,8BAAa,EAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAC1E,CAAC;IAED,4CAAoB,GAApB,UAAqB,KAAY,EAAE,QAAkC;QACnE,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,OAAO,QAAQ,CAAC,IAAA,4BAAW,EAAC,KAAK,EAAE,CAAC,EAAE,iCAAsB,CAAC,CAAC,CAAC;SAChE;QACD,KAAK,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC1C,CAAC;IAEK,gCAAQ,GAAd,UAAe,KAAY;;;;gBACzB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;oBACjB,sBAAO,IAAI,OAAO,CAAS,UAAC,OAAO;4BACjC,KAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,KAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;wBAC5E,CAAC,CAAC,EAAC;iBACJ;gBAED,sBAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAC;;;KAC5B;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,yDAAiC,GAAjC,UAAkC,cAA0C;;QAC1E,IAAM,IAAI,GAAG,MAAA,IAAI,CAAC,cAAc,mCAAI,EAAE,CAAC;QACvC,IAAM,iBAAiB,wBAAgC,IAAI,CAAE,CAAC;QAE9D,IAAI,cAAc,KAAK,SAAS,EAAE;YAChC,OAAO,iBAAiB,CAAC;SAC1B;QAED,0CAA0C;QAC1C,IAAM,eAAe,GAEjB,EAAE,CAAC;QACP,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,UAAC,GAAG;YACtC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,yBAAiB,CAAC,CAAC,QAAQ,CAAC,GAAwB,CAAC,EAAE;gBACxE,6DAA6D;gBAC7D,aAAa;gBACb,mEAAmE;gBACnE,eAAe,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;aAC5C;QACH,CAAC,CAAC,CAAC;QAEH,oCAAyB,CAAC,OAAO,CAAC,UAAC,SAAS;YAC1C,iCAAiC;YACjC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC;gBAAE,OAAO;YAE7D,mEAAmE;YACnE,IAAM,YAAY,GAA2B,cAAc,CAAC,SAAS,CAAC,CAAC;YAEvE,QAAQ,SAAS,EAAE;gBACjB,KAAK,yBAAiB,CAAC,SAAS;oBAC9B,iEAAiE;oBACjE,0BAA0B;oBAC1B,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,OAAO,CAAC,UAAC,IAAI;wBAC1C,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAC;oBACjC,CAAC,CAAC,CAAC;oBACH,MAAM;gBACR,KAAK,yBAAiB,CAAC,KAAK;oBAC1B,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,UAAC,IAAI;wBACrC,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAC;oBACjC,CAAC,CAAC,CAAC;oBACH,MAAM;gBACR,KAAK,yBAAiB,CAAC,GAAG;oBACxB,MAAM,CAAC,MAAM,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;oBAC/C,MAAM;aACT;QACH,CAAC,CAAC,CAAC;QAEH,kCAAkC;QAClC,0DAA0D;QAC1D,wKAAwK;QACxK,MAAM,CAAC,MAAM,CAAC,iBAAiB,EAAE,eAAe,CAAC,CAAC;QAElD,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAEK,+BAAO,GAAb,UAAc,KAAY;;;;;;;wBAEtB,mCAAmC;wBACnC,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;4BACtB,sBAAO,IAAA,4BAAW,EAAC,KAAK,EAAE,CAAC,EAAE,0BAAe,CAAC,EAAC;yBAC/C;wBAIK,SAAS,GAAY,KAAK,CAAC,UAAU,CAAC;wBAC5C,IAAI,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE;4BAClE,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,mCAAwB,CAAC,CAAC;4BAC3D,sBAAO,IAAA,4BAAW,EAAC,KAAK,EAAE,CAAC,EAAE,mCAAwB,CAAC,EAAC;yBACxD;wBAED,IAAI,KAAK,CAAC,UAAU,KAAK,wBAAgB,CAAC,QAAQ,EAAE;4BAClD,0CAA0C;4BAC1C,8DAA8D;4BAC9D,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,cAAc,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC;yBAC1E;wBAEc,qBAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,EAAA;;wBAAxC,MAAM,GAAG,SAA+B;wBAE9C,qFAAqF;wBACrF,IAAI,MAAM,CAAC,IAAI,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,KAAK,0CAA+B,EAAE;4BAC3E,sBAAO,MAAM,EAAC;yBACf;wBAED,MAAM,CAAC,IAAI,KAAK,GAAG;4BACjB,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC;4BAChD,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,GAAG;gCACrB,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;gCACjD,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;wBAErD,sBAAO,MAAM,EAAC;;;wBAER,OAAO,GAAG,MAAM,CAAC,GAAC,CAAC,CAAC;wBAC1B,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;wBACpC,MAAM,GAAG,IAAA,4BAAW,EAAC,KAAK,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;wBAE9C,sBAAO,MAAM,EAAC;;;;;KAEjB;IAED,iCAAS,GAAT,UAAU,MAAe;QACvB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YACzD,OAAO;SACR;QACD,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAC1B,CAAC;IAED,kCAAU,GAAV,UAAW,MAAe;QACxB,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,MAAM,EAAE;YACjC,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;YACrC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;SACvC;IACH,CAAC;IAED,6BAAK,GAAL;QACE,OAAO,IAAA,8BAAa,EAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED,8BAAM,GAAN,UAAO,IAAY;QACjB,IAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,UAAC,MAAM,IAAK,OAAA,MAAM,CAAC,IAAI,KAAK,IAAI,EAApB,CAAoB,CAAC,CAAC;QAC5E,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,uCAAgC,IAAI,CAAE,CAAC,CAAC;YACzE,OAAO,SAAS,CAAC;SAClB;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,+BAAO,GAAP,UAA0B,WAAwC;QAChE,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,UAAC,MAAM,IAAK,OAAA,MAAM,YAAY,WAAW,EAA7B,CAA6B,CAAQ,CAAC;IACxF,CAAC;IACH,oBAAC;AAAD,CAAC,AA7RD,IA6RC;AA7RY,sCAAa","sourcesContent":["import { Plugin } from './types/plugin';\nimport { IConfig } from './types/config/core-config';\nimport { BaseEvent, EventOptions } from './types/event/base-event';\nimport { Result } from './types/result';\nimport {\n Event,\n IdentifyOperation,\n IdentifyUserProperties,\n SpecialEventType,\n UserProperties,\n} from './types/event/event';\nimport { IIdentify, OrderedIdentifyOperations } from './identify';\nimport { IRevenue } from './revenue';\nimport {\n CLIENT_NOT_INITIALIZED,\n EMPTY_EVENT_TYPE_MESSAGE,\n OPT_OUT_MESSAGE,\n STALE_EVENT_OVERWRITTEN_MESSAGE,\n} from './types/messages';\nimport { Timeline } from './timeline';\nimport {\n createGroupEvent,\n createGroupIdentifyEvent,\n createIdentifyEvent,\n createRevenueEvent,\n createTrackEvent,\n} from './utils/event-builder';\nimport { buildResult } from './utils/result-builder';\nimport { returnWrapper } from './utils/return-wrapper';\nimport { CoreClient, PluginHost } from './types/client/core-client';\nexport class AmplitudeCore implements CoreClient, PluginHost {\n protected initializing = false;\n protected name: string;\n // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n // @ts-ignore\n config: IConfig;\n // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n // @ts-ignore\n timeline: Timeline;\n isReady = false;\n protected q: Array<CallableFunction | typeof returnWrapper> = [];\n protected dispatchQ: Array<CallableFunction> = [];\n\n /**\n * Current user properties (operation-applied, flat key-value).\n * Only used by client-side SDKs; server SDKs may leave this undefined.\n */\n userProperties: { [key: string]: any } | undefined;\n\n constructor(name = '$default') {\n this.timeline = new Timeline(this);\n this.name = name;\n }\n\n protected async _init(config: IConfig) {\n this.config = config;\n this.timeline.reset(this);\n this.timeline.loggerProvider = this.config.loggerProvider;\n await this.runQueuedFunctions('q', () => (this.isReady = true));\n }\n\n async runQueuedFunctions(queueName: 'q' | 'dispatchQ', onQueueEmpty?: () => void) {\n const queuedFunctions = this[queueName];\n this[queueName] = [];\n for (const queuedFunction of queuedFunctions) {\n // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n // @ts-ignore\n // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n const val: ReturnType<typeof returnWrapper> | Promise<any> = queuedFunction();\n if (val && 'promise' in val) {\n await val.promise;\n } else {\n await val;\n }\n }\n\n // Rerun queued functions if the queue has accrued more while awaiting promises\n if (this[queueName].length) {\n await this.runQueuedFunctions(queueName, onQueueEmpty);\n } else {\n onQueueEmpty?.();\n }\n }\n\n track(eventInput: BaseEvent | string, eventProperties?: Record<string, any>, eventOptions?: EventOptions) {\n const event = createTrackEvent(eventInput, eventProperties, eventOptions);\n // Update client user properties immediately and synchronously\n this.userProperties = this.getOperationAppliedUserProperties(event.user_properties);\n return returnWrapper(this.dispatch(event));\n }\n\n logEvent = this.track.bind(this);\n\n identify(identify: IIdentify, eventOptions?: EventOptions) {\n const event = createIdentifyEvent(identify, eventOptions);\n // Update client user properties immediately and synchronously\n this.userProperties = this.getOperationAppliedUserProperties(event.user_properties);\n return returnWrapper(this.dispatch(event));\n }\n\n groupIdentify(groupType: string, groupName: string | string[], identify: IIdentify, eventOptions?: EventOptions) {\n const event = createGroupIdentifyEvent(groupType, groupName, identify, eventOptions);\n return returnWrapper(this.dispatch(event));\n }\n\n setGroup(groupType: string, groupName: string | string[], eventOptions?: EventOptions) {\n const event = createGroupEvent(groupType, groupName, eventOptions);\n // Update client user properties immediately and synchronously\n this.userProperties = this.getOperationAppliedUserProperties(event.user_properties);\n return returnWrapper(this.dispatch(event));\n }\n\n revenue(revenue: IRevenue, eventOptions?: EventOptions) {\n const event = createRevenueEvent(revenue, eventOptions);\n return returnWrapper(this.dispatch(event));\n }\n\n add(plugin: Plugin) {\n if (!this.isReady) {\n this.q.push(this._addPlugin.bind(this, plugin));\n return returnWrapper();\n }\n return this._addPlugin(plugin);\n }\n\n _addPlugin(plugin: Plugin) {\n return returnWrapper(this.timeline.register(plugin, this.config));\n }\n\n remove(pluginName: string) {\n if (!this.isReady) {\n this.q.push(this._removePlugin.bind(this, pluginName));\n return returnWrapper();\n }\n return this._removePlugin(pluginName);\n }\n\n _removePlugin(pluginName: string) {\n return returnWrapper(this.timeline.deregister(pluginName, this.config));\n }\n\n dispatchWithCallback(event: Event, callback: (result: Result) => void): void {\n if (!this.isReady) {\n return callback(buildResult(event, 0, CLIENT_NOT_INITIALIZED));\n }\n void this.process(event).then(callback);\n }\n\n async dispatch(event: Event): Promise<Result> {\n if (!this.isReady) {\n return new Promise<Result>((resolve) => {\n this.dispatchQ.push(this.dispatchWithCallback.bind(this, event, resolve));\n });\n }\n\n return this.process(event);\n }\n\n /**\n *\n * This method applies identify operations to user properties and\n * returns a single object representing the final user property state.\n *\n * This is a best-effort api that only supports $set, $clearAll, and $unset.\n * Other operations are not supported and are ignored.\n *\n * Operations are applied on top of current client state (this.userProperties).\n *\n * @param userProperties The new user properties object from identify() or setIdentity().\n * @returns A key-value object user properties without operations.\n *\n * @example\n * Input:\n * {\n * $set: { plan: 'premium' },\n * custom_flag: true\n * }\n *\n * Output:\n * {\n * plan: 'premium',\n * custom_flag: true\n * }\n */\n getOperationAppliedUserProperties(userProperties: UserProperties | undefined): { [key: string]: any } {\n const base = this.userProperties ?? {};\n const updatedProperties: { [key: string]: any } = { ...base };\n\n if (userProperties === undefined) {\n return updatedProperties;\n }\n\n // Keep non-operation keys for later merge\n const nonOpProperties: {\n [key in Exclude<string, IdentifyOperation>]: any;\n } = {};\n Object.keys(userProperties).forEach((key) => {\n if (!Object.values(IdentifyOperation).includes(key as IdentifyOperation)) {\n // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n // @ts-ignore\n // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n nonOpProperties[key] = userProperties[key];\n }\n });\n\n OrderedIdentifyOperations.forEach((operation) => {\n // Skip when key is an operation.\n if (!Object.keys(userProperties).includes(operation)) return;\n\n // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n const opProperties: IdentifyUserProperties = userProperties[operation];\n\n switch (operation) {\n case IdentifyOperation.CLEAR_ALL:\n // Due to operation order, the following line will never execute.\n /* istanbul ignore next */\n Object.keys(updatedProperties).forEach((prop) => {\n delete updatedProperties[prop];\n });\n break;\n case IdentifyOperation.UNSET:\n Object.keys(opProperties).forEach((prop) => {\n delete updatedProperties[prop];\n });\n break;\n case IdentifyOperation.SET:\n Object.assign(updatedProperties, opProperties);\n break;\n }\n });\n\n // Merge non-operation properties.\n // Custom properties should not be affected by operations.\n // https://github.com/amplitude/nova/blob/343f678ded83c032e83b189796b3c2be161b48f5/src/main/java/com/amplitude/userproperty/model/ModifyUserPropertiesIdent.java#L79-L83\n Object.assign(updatedProperties, nonOpProperties);\n\n return updatedProperties;\n }\n\n async process(event: Event): Promise<Result> {\n try {\n // skip event processing if opt out\n if (this.config.optOut) {\n return buildResult(event, 0, OPT_OUT_MESSAGE);\n }\n\n // The event server 400s a blank event type, which also forces the rest of its\n // upload batch to be retried, so drop it before it ever reaches a destination.\n const eventType: unknown = event.event_type;\n if (typeof eventType !== 'string' || eventType.trim().length === 0) {\n this.config.loggerProvider.error(EMPTY_EVENT_TYPE_MESSAGE);\n return buildResult(event, 0, EMPTY_EVENT_TYPE_MESSAGE);\n }\n\n if (event.event_type === SpecialEventType.IDENTIFY) {\n // Do not update this.userProperties here.\n // It is only set synchronously in identify() or setIdentity()\n this.timeline.onIdentityChanged({ userProperties: this.userProperties });\n }\n\n const result = await this.timeline.push(event);\n\n // Replacing a stale delayed event is expected and should not produce console output.\n if (result.code === 0 && result.message === STALE_EVENT_OVERWRITTEN_MESSAGE) {\n return result;\n }\n\n result.code === 200\n ? this.config.loggerProvider.log(result.message)\n : result.code === 100\n ? this.config.loggerProvider.warn(result.message)\n : this.config.loggerProvider.error(result.message);\n\n return result;\n } catch (e) {\n const message = String(e);\n this.config.loggerProvider.error(message);\n const result = buildResult(event, 0, message);\n\n return result;\n }\n }\n\n setOptOut(optOut: boolean) {\n if (!this.isReady) {\n this.q.push(this._setOptOut.bind(this, Boolean(optOut)));\n return;\n }\n this._setOptOut(optOut);\n }\n\n _setOptOut(optOut: boolean) {\n if (this.config.optOut !== optOut) {\n this.config.optOut = Boolean(optOut);\n this.timeline.onOptOutChanged(optOut);\n }\n }\n\n flush() {\n return returnWrapper(this.timeline.flush());\n }\n\n plugin(name: string): Plugin | undefined {\n const plugin = this.timeline.plugins.find((plugin) => plugin.name === name);\n if (plugin === undefined) {\n this.config.loggerProvider.debug(`Cannot find plugin with name ${name}`);\n return undefined;\n }\n\n return plugin;\n }\n\n plugins<T extends Plugin>(pluginClass: { new (...args: any[]): T }): T[] {\n return this.timeline.plugins.filter((plugin) => plugin instanceof pluginClass) as T[];\n }\n}\n"]}
|
package/lib/cjs/heartbeat.d.ts
CHANGED
|
@@ -2,18 +2,31 @@ import { ILogger } from './logger';
|
|
|
2
2
|
import { CoreClient } from './types/client/core-client';
|
|
3
3
|
import { BaseEvent } from './types/event/base-event';
|
|
4
4
|
import { Result } from './types/result';
|
|
5
|
+
interface HeartbeatOptions {
|
|
6
|
+
/** Refresh queued snapshots immediately before each send. */
|
|
7
|
+
beforeHeartbeat?: () => void;
|
|
8
|
+
/**
|
|
9
|
+
* Send queued events when the page becomes hidden or exits. Defaults to true.
|
|
10
|
+
* Disable when the caller owns page lifecycle handling and sends snapshots itself.
|
|
11
|
+
*/
|
|
12
|
+
sendOnPageLifecycle?: boolean;
|
|
13
|
+
}
|
|
5
14
|
export declare class Heartbeat {
|
|
6
15
|
private client;
|
|
7
16
|
private pulse;
|
|
8
17
|
private delayTimeout;
|
|
9
18
|
private logger?;
|
|
19
|
+
private options;
|
|
10
20
|
private events;
|
|
11
21
|
private delayId;
|
|
12
22
|
private interval;
|
|
13
23
|
private resetPromise;
|
|
14
|
-
|
|
15
|
-
private
|
|
16
|
-
|
|
24
|
+
private unsubscribeFunctions;
|
|
25
|
+
private pageHidePreparers;
|
|
26
|
+
constructor(client: CoreClient, pulse: number, delayTimeout: number, logger?: ILogger | undefined, options?: HeartbeatOptions);
|
|
27
|
+
heartbeat(flushClient?: boolean): Promise<Result[]>;
|
|
28
|
+
resetHeartbeat(): Promise<Result[]>;
|
|
29
|
+
private setupPageLifecycleListeners;
|
|
17
30
|
/**
|
|
18
31
|
* An instant event is one that has no delay and gets ingested immediately
|
|
19
32
|
* @param event
|
|
@@ -21,6 +34,8 @@ export declare class Heartbeat {
|
|
|
21
34
|
*/
|
|
22
35
|
private isInstantEvent;
|
|
23
36
|
private checkEventSizeLimit;
|
|
37
|
+
/** Admit an event synchronously without starting timers or waiting for delivery. */
|
|
38
|
+
enqueue(event: BaseEvent): boolean;
|
|
24
39
|
track(event: BaseEvent): Promise<Result | Error | undefined>;
|
|
25
40
|
/**
|
|
26
41
|
* Ingest an event with no delay
|
|
@@ -36,7 +51,11 @@ export declare class Heartbeat {
|
|
|
36
51
|
* @param event
|
|
37
52
|
*/
|
|
38
53
|
update(event: BaseEvent): Promise<void>;
|
|
39
|
-
|
|
54
|
+
beforePageHide(prepare: () => void): () => void;
|
|
55
|
+
/** Stop the pulse without discarding the latest snapshot. */
|
|
56
|
+
pause(): void;
|
|
57
|
+
stop(flush?: boolean): void;
|
|
40
58
|
}
|
|
41
59
|
export declare function getHeartbeatInstance(client: CoreClient, logger?: ILogger): Heartbeat;
|
|
60
|
+
export {};
|
|
42
61
|
//# sourceMappingURL=heartbeat.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"heartbeat.d.ts","sourceRoot":"","sources":["../../src/heartbeat.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACnC,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AACxD,OAAO,EAAE,SAAS,EAAS,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;
|
|
1
|
+
{"version":3,"file":"heartbeat.d.ts","sourceRoot":"","sources":["../../src/heartbeat.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACnC,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AACxD,OAAO,EAAE,SAAS,EAAS,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAUxC,UAAU,gBAAgB;IACxB,6DAA6D;IAC7D,eAAe,CAAC,EAAE,MAAM,IAAI,CAAC;IAC7B;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED,qBAAa,SAAS;IASlB,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,KAAK;IACb,OAAO,CAAC,YAAY;IACpB,OAAO,CAAC,MAAM,CAAC;IACf,OAAO,CAAC,OAAO;IAZjB,OAAO,CAAC,MAAM,CAA4B;IAC1C,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,QAAQ,CAA+C;IAC/D,OAAO,CAAC,YAAY,CAAkC;IACtD,OAAO,CAAC,oBAAoB,CAAsB;IAClD,OAAO,CAAC,iBAAiB,CAAsB;gBAGrC,MAAM,EAAE,UAAU,EAClB,KAAK,EAAE,MAAM,EACb,YAAY,EAAE,MAAM,EACpB,MAAM,CAAC,qBAAS,EAChB,OAAO,GAAE,gBAAqB;IAMlC,SAAS,CAAC,WAAW,UAAQ,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IA6BjD,cAAc;IAwBpB,OAAO,CAAC,2BAA2B;IAsCnC;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,mBAAmB;IAY3B,oFAAoF;IACpF,OAAO,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO;IAS5B,KAAK,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CAAC,MAAM,GAAG,KAAK,GAAG,SAAS,CAAC;IAalE;;;;;;;OAOG;IACG,YAAY,CAAC,KAAK,EAAE,SAAS;IAKnC;;;OAGG;IACG,MAAM,CAAC,KAAK,EAAE,SAAS;IAgB7B,cAAc,CAAC,OAAO,EAAE,MAAM,IAAI,GAAG,MAAM,IAAI;IAU/C,6DAA6D;IAC7D,KAAK;IAKL,IAAI,CAAC,KAAK,UAAQ;CASnB;AAUD,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAQpF"}
|
package/lib/cjs/heartbeat.js
CHANGED
|
@@ -2,27 +2,35 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.getHeartbeatInstance = exports.Heartbeat = void 0;
|
|
4
4
|
var tslib_1 = require("tslib");
|
|
5
|
+
var global_scope_1 = require("./global-scope");
|
|
5
6
|
var uuid_1 = require("./utils/uuid");
|
|
6
7
|
var EVENTS_SIZE_LIMIT = 4 * 10000; // 4KB
|
|
7
8
|
var Heartbeat = /** @class */ (function () {
|
|
8
|
-
function Heartbeat(client, pulse, delayTimeout, logger) {
|
|
9
|
+
function Heartbeat(client, pulse, delayTimeout, logger, options) {
|
|
10
|
+
if (options === void 0) { options = {}; }
|
|
9
11
|
this.client = client;
|
|
10
12
|
this.pulse = pulse;
|
|
11
13
|
this.delayTimeout = delayTimeout;
|
|
12
14
|
this.logger = logger;
|
|
15
|
+
this.options = options;
|
|
13
16
|
this.interval = null;
|
|
14
17
|
this.resetPromise = null;
|
|
18
|
+
this.unsubscribeFunctions = [];
|
|
19
|
+
this.pageHidePreparers = [];
|
|
15
20
|
this.events = new Map();
|
|
16
21
|
this.delayId = (0, uuid_1.UUID)();
|
|
17
22
|
}
|
|
18
|
-
Heartbeat.prototype.heartbeat = function () {
|
|
23
|
+
Heartbeat.prototype.heartbeat = function (flushClient) {
|
|
24
|
+
var _a, _b;
|
|
25
|
+
if (flushClient === void 0) { flushClient = false; }
|
|
19
26
|
return tslib_1.__awaiter(this, void 0, void 0, function () {
|
|
20
|
-
var trackedEvents, _loop_1, this_1,
|
|
21
|
-
var e_1,
|
|
27
|
+
var trackedEvents, _loop_1, this_1, _c, _d, event_1, res;
|
|
28
|
+
var e_1, _e;
|
|
22
29
|
var _this = this;
|
|
23
|
-
return tslib_1.__generator(this, function (
|
|
24
|
-
switch (
|
|
30
|
+
return tslib_1.__generator(this, function (_f) {
|
|
31
|
+
switch (_f.label) {
|
|
25
32
|
case 0:
|
|
33
|
+
(_b = (_a = this.options).beforeHeartbeat) === null || _b === void 0 ? void 0 : _b.call(_a);
|
|
26
34
|
// stop sending heartbeats if no events are queued
|
|
27
35
|
if (this.events.size === 0) {
|
|
28
36
|
this.stop();
|
|
@@ -42,26 +50,32 @@ var Heartbeat = /** @class */ (function () {
|
|
|
42
50
|
};
|
|
43
51
|
this_1 = this;
|
|
44
52
|
try {
|
|
45
|
-
for (
|
|
46
|
-
event_1 =
|
|
53
|
+
for (_c = tslib_1.__values(this.events.values()), _d = _c.next(); !_d.done; _d = _c.next()) {
|
|
54
|
+
event_1 = _d.value;
|
|
47
55
|
_loop_1(event_1);
|
|
48
56
|
}
|
|
49
57
|
}
|
|
50
58
|
catch (e_1_1) { e_1 = { error: e_1_1 }; }
|
|
51
59
|
finally {
|
|
52
60
|
try {
|
|
53
|
-
if (
|
|
61
|
+
if (_d && !_d.done && (_e = _c.return)) _e.call(_c);
|
|
54
62
|
}
|
|
55
63
|
finally { if (e_1) throw e_1.error; }
|
|
56
64
|
}
|
|
57
65
|
return [4 /*yield*/, Promise.all(trackedEvents)];
|
|
58
|
-
case 1:
|
|
66
|
+
case 1:
|
|
67
|
+
res = _f.sent();
|
|
68
|
+
if (flushClient) {
|
|
69
|
+
this.client.flush();
|
|
70
|
+
}
|
|
71
|
+
return [2 /*return*/, res];
|
|
59
72
|
}
|
|
60
73
|
});
|
|
61
74
|
});
|
|
62
75
|
};
|
|
63
76
|
Heartbeat.prototype.resetHeartbeat = function () {
|
|
64
77
|
return tslib_1.__awaiter(this, void 0, void 0, function () {
|
|
78
|
+
var resetPromise;
|
|
65
79
|
var _this = this;
|
|
66
80
|
return tslib_1.__generator(this, function (_a) {
|
|
67
81
|
switch (_a.label) {
|
|
@@ -70,23 +84,70 @@ var Heartbeat = /** @class */ (function () {
|
|
|
70
84
|
return [4 /*yield*/, this.resetPromise];
|
|
71
85
|
case 1: return [2 /*return*/, _a.sent()];
|
|
72
86
|
case 2:
|
|
87
|
+
if (this.options.sendOnPageLifecycle !== false)
|
|
88
|
+
this.setupPageLifecycleListeners();
|
|
73
89
|
// reset the heartbeat interval
|
|
74
90
|
if (this.interval)
|
|
75
91
|
clearInterval(this.interval);
|
|
76
92
|
this.interval = setInterval(function () { return void _this.heartbeat(); }, this.pulse);
|
|
77
|
-
|
|
78
|
-
this.resetPromise = new Promise(function (resolve) {
|
|
93
|
+
resetPromise = new Promise(function (resolve) {
|
|
79
94
|
setTimeout(function () {
|
|
95
|
+
_this.resetPromise = null;
|
|
80
96
|
resolve(_this.heartbeat());
|
|
81
97
|
}, 0);
|
|
82
98
|
});
|
|
83
|
-
this.resetPromise
|
|
84
|
-
return [4 /*yield*/,
|
|
99
|
+
this.resetPromise = resetPromise;
|
|
100
|
+
return [4 /*yield*/, resetPromise];
|
|
85
101
|
case 3: return [2 /*return*/, _a.sent()];
|
|
86
102
|
}
|
|
87
103
|
});
|
|
88
104
|
});
|
|
89
105
|
};
|
|
106
|
+
Heartbeat.prototype.setupPageLifecycleListeners = function () {
|
|
107
|
+
var _this = this;
|
|
108
|
+
if (this.unsubscribeFunctions.length > 0) {
|
|
109
|
+
return;
|
|
110
|
+
}
|
|
111
|
+
// only browser-like environments expose page lifecycle events
|
|
112
|
+
var win = (0, global_scope_1.getGlobalScope)();
|
|
113
|
+
if (!win || typeof win.addEventListener !== 'function' || !win.document) {
|
|
114
|
+
return;
|
|
115
|
+
}
|
|
116
|
+
var doc = win.document;
|
|
117
|
+
// When the user leaves the page, send the latest events and flush them immediately.
|
|
118
|
+
// Preparers update queued events (for example stop_reason) before this snapshot.
|
|
119
|
+
var onPageHide = function (evt) {
|
|
120
|
+
var e_2, _a;
|
|
121
|
+
if (!evt.persisted) {
|
|
122
|
+
try {
|
|
123
|
+
for (var _b = tslib_1.__values(tslib_1.__spreadArray([], tslib_1.__read(_this.pageHidePreparers), false)), _c = _b.next(); !_c.done; _c = _b.next()) {
|
|
124
|
+
var prepare = _c.value;
|
|
125
|
+
prepare();
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
catch (e_2_1) { e_2 = { error: e_2_1 }; }
|
|
129
|
+
finally {
|
|
130
|
+
try {
|
|
131
|
+
if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
|
|
132
|
+
}
|
|
133
|
+
finally { if (e_2) throw e_2.error; }
|
|
134
|
+
}
|
|
135
|
+
void _this.heartbeat(true);
|
|
136
|
+
}
|
|
137
|
+
};
|
|
138
|
+
// when the tab becomes hidden, reset the heartbeat so the latest events are sent
|
|
139
|
+
var onVisibilityChange = function () {
|
|
140
|
+
if (doc.visibilityState === 'hidden') {
|
|
141
|
+
void _this.resetHeartbeat();
|
|
142
|
+
}
|
|
143
|
+
};
|
|
144
|
+
win.addEventListener('pagehide', onPageHide);
|
|
145
|
+
doc.addEventListener('visibilitychange', onVisibilityChange);
|
|
146
|
+
this.unsubscribeFunctions.push(function () {
|
|
147
|
+
win.removeEventListener('pagehide', onPageHide);
|
|
148
|
+
doc.removeEventListener('visibilitychange', onVisibilityChange);
|
|
149
|
+
});
|
|
150
|
+
};
|
|
90
151
|
/**
|
|
91
152
|
* An instant event is one that has no delay and gets ingested immediately
|
|
92
153
|
* @param event
|
|
@@ -107,6 +168,13 @@ var Heartbeat = /** @class */ (function () {
|
|
|
107
168
|
}
|
|
108
169
|
return true;
|
|
109
170
|
};
|
|
171
|
+
/** Admit an event synchronously without starting timers or waiting for delivery. */
|
|
172
|
+
Heartbeat.prototype.enqueue = function (event) {
|
|
173
|
+
if (!event.insert_id)
|
|
174
|
+
return false;
|
|
175
|
+
this.events.set(event.insert_id, tslib_1.__assign(tslib_1.__assign({}, event), { delay: event.delay || { id: this.delayId, timeout: this.delayTimeout } }));
|
|
176
|
+
return this.checkEventSizeLimit(event);
|
|
177
|
+
};
|
|
110
178
|
Heartbeat.prototype.track = function (event) {
|
|
111
179
|
return tslib_1.__awaiter(this, void 0, void 0, function () {
|
|
112
180
|
var heartbeatResult;
|
|
@@ -116,8 +184,7 @@ var Heartbeat = /** @class */ (function () {
|
|
|
116
184
|
if (!event.insert_id) {
|
|
117
185
|
return [2 /*return*/, new Error('insert_id is required on events tracked with heartbeat')];
|
|
118
186
|
}
|
|
119
|
-
|
|
120
|
-
if (!this.checkEventSizeLimit(event)) {
|
|
187
|
+
if (!this.enqueue(event)) {
|
|
121
188
|
return [2 /*return*/];
|
|
122
189
|
}
|
|
123
190
|
return [4 /*yield*/, this.resetHeartbeat()];
|
|
@@ -154,7 +221,9 @@ var Heartbeat = /** @class */ (function () {
|
|
|
154
221
|
return tslib_1.__generator(this, function (_a) {
|
|
155
222
|
if (event.insert_id && this.events.has(event.insert_id)) {
|
|
156
223
|
backupEvent = this.events.get(event.insert_id);
|
|
157
|
-
this.events.set(event.insert_id, tslib_1.__assign(tslib_1.__assign({}, event), {
|
|
224
|
+
this.events.set(event.insert_id, tslib_1.__assign(tslib_1.__assign({}, event), {
|
|
225
|
+
// Page engagement supplies its delay group and removes timeout to finalize it.
|
|
226
|
+
delay: event.delay || { id: this.delayId, timeout: this.delayTimeout } }));
|
|
158
227
|
if (!this.checkEventSizeLimit(event) && backupEvent) {
|
|
159
228
|
this.events.set(event.insert_id, backupEvent);
|
|
160
229
|
return [2 /*return*/];
|
|
@@ -164,10 +233,31 @@ var Heartbeat = /** @class */ (function () {
|
|
|
164
233
|
});
|
|
165
234
|
});
|
|
166
235
|
};
|
|
167
|
-
|
|
236
|
+
// run handlers before 'pagehide' event
|
|
237
|
+
Heartbeat.prototype.beforePageHide = function (prepare) {
|
|
238
|
+
var _this = this;
|
|
239
|
+
this.pageHidePreparers.push(prepare);
|
|
240
|
+
return function () {
|
|
241
|
+
var index = _this.pageHidePreparers.indexOf(prepare);
|
|
242
|
+
if (index !== -1) {
|
|
243
|
+
_this.pageHidePreparers.splice(index, 1);
|
|
244
|
+
}
|
|
245
|
+
};
|
|
246
|
+
};
|
|
247
|
+
/** Stop the pulse without discarding the latest snapshot. */
|
|
248
|
+
Heartbeat.prototype.pause = function () {
|
|
168
249
|
this.interval && clearInterval(this.interval);
|
|
169
250
|
this.interval = null;
|
|
251
|
+
};
|
|
252
|
+
Heartbeat.prototype.stop = function (flush) {
|
|
253
|
+
if (flush === void 0) { flush = false; }
|
|
254
|
+
this.pause();
|
|
170
255
|
this.events.clear();
|
|
256
|
+
this.unsubscribeFunctions.forEach(function (removeListener) { return removeListener(); });
|
|
257
|
+
this.unsubscribeFunctions = [];
|
|
258
|
+
if (flush) {
|
|
259
|
+
this.client.flush();
|
|
260
|
+
}
|
|
171
261
|
};
|
|
172
262
|
return Heartbeat;
|
|
173
263
|
}());
|
package/lib/cjs/heartbeat.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"heartbeat.js","sourceRoot":"","sources":["../../src/heartbeat.ts"],"names":[],"mappings":";;;;AAIA,qCAAoC;AAMpC,IAAM,iBAAiB,GAAG,CAAC,GAAG,KAAM,CAAC,CAAC,MAAM;AAE5C;IAME,mBACU,MAAkB,EAClB,KAAa,EACb,YAAoB,EACpB,MAAgB;QAHhB,WAAM,GAAN,MAAM,CAAY;QAClB,UAAK,GAAL,KAAK,CAAQ;QACb,iBAAY,GAAZ,YAAY,CAAQ;QACpB,WAAM,GAAN,MAAM,CAAU;QAPlB,aAAQ,GAA0B,IAAI,CAAC;QACvC,iBAAY,GAA6B,IAAI,CAAC;QAQpD,IAAI,CAAC,MAAM,GAAG,IAAI,GAAG,EAAwB,CAAC;QAC9C,IAAI,CAAC,OAAO,GAAG,IAAA,WAAI,GAAE,CAAC;IACxB,CAAC;IAEa,6BAAS,GAAvB;;;;;;;;wBACE,kDAAkD;wBAClD,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,EAAE;4BAC1B,IAAI,CAAC,IAAI,EAAE,CAAC;4BACZ,sBAAO,EAAE,EAAC;yBACX;wBAGK,aAAa,GAAG,EAAE,CAAC;4CACd,OAAK;4BACN,IAAA,UAAU,GAAwC,OAAK,WAA7C,EAAE,gBAAgB,GAAsB,OAAK,iBAA3B,EAAK,YAAY,kBAAK,OAAK,EAAzD,kCAAiD,CAAF,CAAW;4BAChE,IAAM,YAAY,GAAG,OAAK,MAAM,CAAC,KAAK,CAAC,UAAU,EAAE,gBAAgB,EAAE,YAAY,CAAC,CAAC,OAAO,CAAC;4BAE3F,qEAAqE;4BACrE,kCAAkC;4BAClC,IAAI,OAAK,cAAc,CAAC,OAAK,CAAC,EAAE;gCAC9B,IAAM,UAAQ,GAAG,OAAK,CAAC,SAAS,CAAC;gCACjC,KAAK,YAAY,CAAC,OAAO,CAAC,cAAM,OAAA,KAAI,CAAC,MAAM,CAAC,MAAM,CAAC,UAAQ,CAAC,EAA5B,CAA4B,CAAC,CAAC;6BAC/D;4BACD,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;;;;4BAVnC,KAAoB,KAAA,iBAAA,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAA;gCAAnC;wCAAM,OAAK;6BAWf;;;;;;;;;wBACM,qBAAM,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,EAAA;4BAAvC,sBAAO,SAAgC,EAAC;;;;KACzC;IAEa,kCAAc,GAA5B;;;;;;6BAEM,IAAI,CAAC,YAAY,EAAjB,wBAAiB;wBAAS,qBAAM,IAAI,CAAC,YAAY,EAAA;4BAA9B,sBAAO,SAAuB,EAAC;;wBAEtD,+BAA+B;wBAC/B,IAAI,IAAI,CAAC,QAAQ;4BAAE,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;wBAChD,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAC,cAAM,OAAA,KAAK,KAAI,CAAC,SAAS,EAAE,EAArB,CAAqB,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;wBAErE,8CAA8C;wBAC9C,IAAI,CAAC,YAAY,GAAG,IAAI,OAAO,CAAC,UAAC,OAAO;4BACtC,UAAU,CAAC;gCACT,OAAO,CAAC,KAAI,CAAC,SAAS,EAAE,CAAC,CAAC;4BAC5B,CAAC,EAAE,CAAC,CAAC,CAAC;wBACR,CAAC,CAAC,CAAC;wBACH,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,cAAM,OAAA,CAAC,KAAI,CAAC,YAAY,GAAG,IAAI,CAAC,EAA1B,CAA0B,CAAC,CAAC;wBAErD,qBAAM,IAAI,CAAC,YAAY,EAAA;4BAA9B,sBAAO,SAAuB,EAAC;;;;KAChC;IAED;;;;OAIG;IACK,kCAAc,GAAtB,UAAuB,KAAmB;QACxC,OAAO,OAAO,CAAC,KAAK,CAAC,SAAS,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC1D,CAAC;IAEO,uCAAmB,GAA3B,UAA4B,KAAgB;;QAC1C,IAAI,IAAI,CAAC,SAAS,0CAAK,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,UAAE,CAAC,MAAM,GAAG,iBAAiB,EAAE;YACxE,0BAA0B;YAC1B,MAAA,IAAI,CAAC,MAAM,0CAAE,IAAI,CAAC,wEAAiE,KAAK,CAAC,SAAU,CAAE,CAAC,CAAC;YACvG,IAAI,KAAK,CAAC,SAAS,EAAE;gBACnB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;aACrC;YACD,OAAO,KAAK,CAAC;SACd;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEK,yBAAK,GAAX,UAAY,KAAgB;;;;;;wBAC1B,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE;4BACpB,sBAAO,IAAI,KAAK,CAAC,wDAAwD,CAAC,EAAC;yBAC5E;wBACD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,wCAC1B,KAAK,KACR,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,YAAY,EAAE,IACtE,CAAC;wBACH,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,EAAE;4BACpC,sBAAO;yBACR;wBAGuB,qBAAM,IAAI,CAAC,cAAc,EAAE,EAAA;;wBAA7C,eAAe,GAAG,SAA2B;wBACnD,sBAAO,eAAe,CAAC,IAAI,CAAC,UAAC,MAAM,IAAK,OAAA,MAAM,CAAC,KAAK,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS,EAA1C,CAA0C,CAAC,EAAC;;;;KACrF;IAED;;;;;;;OAOG;IACG,gCAAY,GAAlB,UAAmB,KAAgB;;;gBACjC,KAAK,CAAC,KAAK,GAAG,EAAE,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC;gBACnC,sBAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EAAC;;;KAC1B;IAED;;;OAGG;IACG,0BAAM,GAAZ,UAAa,KAAgB;;;;gBAC3B,IAAI,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE;oBACjD,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;oBACrD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,wCAC1B,KAAK,KACR,KAAK,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,YAAY,EAAE,IACvD,CAAC;oBACH,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,IAAI,WAAW,EAAE;wBACnD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;wBAC9C,sBAAO;qBACR;iBACF;;;;KACF;IAED,wBAAI,GAAJ;QACE,IAAI,CAAC,QAAQ,IAAI,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC9C,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;IACtB,CAAC;IACH,gBAAC;AAAD,CAAC,AArID,IAqIC;AArIY,8BAAS;AAuItB,IAAM,0BAA0B,GAAG,KAAM,CAAC;AAC1C,uEAAuE;AACvE,IAAM,+BAA+B,GAAG,OAAS,CAAC;AAIlD,IAAM,YAAY,GAAiB,IAAI,GAAG,EAAyB,CAAC;AAEpE,SAAgB,oBAAoB,CAAC,MAAkB,EAAE,MAAgB;IACvE,IAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC1C,IAAI,QAAQ,EAAE;QACZ,OAAO,QAAQ,CAAC;KACjB;IACD,IAAM,SAAS,GAAG,IAAI,SAAS,CAAC,MAAM,EAAE,0BAA0B,EAAE,+BAA+B,EAAE,MAAM,CAAC,CAAC;IAC7G,YAAY,CAAC,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACpC,OAAO,SAAS,CAAC;AACnB,CAAC;AARD,oDAQC","sourcesContent":["import { ILogger } from './logger';\nimport { CoreClient } from './types/client/core-client';\nimport { BaseEvent, Delay } from './types/event/base-event';\nimport { Result } from './types/result';\nimport { UUID } from './utils/uuid';\n\ntype DelayedEvent = BaseEvent & {\n delay: Delay;\n};\n\nconst EVENTS_SIZE_LIMIT = 4 * 10_000; // 4KB\n\nexport class Heartbeat {\n private events: Map<string, DelayedEvent>;\n private delayId: string;\n private interval: NodeJS.Timeout | null = null;\n private resetPromise: Promise<Result[]> | null = null;\n\n constructor(\n private client: CoreClient,\n private pulse: number,\n private delayTimeout: number,\n private logger?: ILogger,\n ) {\n this.events = new Map<string, DelayedEvent>();\n this.delayId = UUID();\n }\n\n private async heartbeat(): Promise<Result[]> {\n // stop sending heartbeats if no events are queued\n if (this.events.size === 0) {\n this.stop();\n return [];\n }\n\n // track all of the delayed events\n const trackedEvents = [];\n for (const event of this.events.values()) {\n const { event_type, event_properties, ...eventOptions } = event;\n const eventPromise = this.client.track(event_type, event_properties, eventOptions).promise;\n\n // if the event has no timeout, then it's instant ingested and we can\n // delete it after it was ingested\n if (this.isInstantEvent(event)) {\n const insertId = event.insert_id;\n void eventPromise.finally(() => this.events.delete(insertId));\n }\n trackedEvents.push(eventPromise);\n }\n return await Promise.all(trackedEvents);\n }\n\n private async resetHeartbeat() {\n // if a reset is already in progress, return the existing promise\n if (this.resetPromise) return await this.resetPromise;\n\n // reset the heartbeat interval\n if (this.interval) clearInterval(this.interval);\n this.interval = setInterval(() => void this.heartbeat(), this.pulse);\n\n // invoke heartbeat on the next macrotask tick\n this.resetPromise = new Promise((resolve) => {\n setTimeout(() => {\n resolve(this.heartbeat());\n }, 0);\n });\n this.resetPromise.finally(() => (this.resetPromise = null));\n\n return await this.resetPromise;\n }\n\n /**\n * An instant event is one that has no delay and gets ingested immediately\n * @param event\n * @returns\n */\n private isInstantEvent(event: DelayedEvent): event is DelayedEvent & { insert_id: string } {\n return Boolean(event.insert_id && !event.delay.timeout);\n }\n\n private checkEventSizeLimit(event: BaseEvent) {\n if (JSON.stringify([...this.events.values()]).length > EVENTS_SIZE_LIMIT) {\n /* istanbul ignore next */\n this.logger?.warn(`Heartbeat: events size limit reached, rejecting event with id=${event.insert_id!}`);\n if (event.insert_id) {\n this.events.delete(event.insert_id);\n }\n return false;\n }\n return true;\n }\n\n async track(event: BaseEvent): Promise<Result | Error | undefined> {\n if (!event.insert_id) {\n return new Error('insert_id is required on events tracked with heartbeat');\n }\n this.events.set(event.insert_id, {\n ...event,\n delay: event.delay || { id: this.delayId, timeout: this.delayTimeout },\n });\n if (!this.checkEventSizeLimit(event)) {\n return;\n }\n\n // emit a heartbeat, restart interval and return the result\n const heartbeatResult = await this.resetHeartbeat();\n return heartbeatResult.find((result) => result.event.insert_id === event.insert_id);\n }\n\n /**\n * Ingest an event with no delay\n *\n * (This is different from normal \"track\". It sends the events to the \"/delayed\" endpoint\n * so that it can be tracked in the same payload as other events, for atomicity)\n * @param event\n * @returns\n */\n async trackNoDelay(event: BaseEvent) {\n event.delay = { id: this.delayId };\n return this.track(event);\n }\n\n /**\n * Update an existing event\n * @param event\n */\n async update(event: BaseEvent) {\n if (event.insert_id && this.events.has(event.insert_id)) {\n const backupEvent = this.events.get(event.insert_id);\n this.events.set(event.insert_id, {\n ...event,\n delay: { id: this.delayId, timeout: this.delayTimeout },\n });\n if (!this.checkEventSizeLimit(event) && backupEvent) {\n this.events.set(event.insert_id, backupEvent);\n return;\n }\n }\n }\n\n stop() {\n this.interval && clearInterval(this.interval);\n this.interval = null;\n this.events.clear();\n }\n}\n\nconst DEFAULT_HEARTBEAT_INTERVAL = 60_000;\n// const DEFAULT_HEARTBEAT_INTERVAL = 2_000; // TODO: DO NOT MERGE THIS\nconst DEFAULT_HEARTBEAT_DELAY_TIMEOUT = 3_600_000;\n\ntype HeartbeatMap = Map<CoreClient, Heartbeat>;\n\nconst heartbeatMap: HeartbeatMap = new Map<CoreClient, Heartbeat>();\n\nexport function getHeartbeatInstance(client: CoreClient, logger?: ILogger): Heartbeat {\n const existing = heartbeatMap.get(client);\n if (existing) {\n return existing;\n }\n const heartbeat = new Heartbeat(client, DEFAULT_HEARTBEAT_INTERVAL, DEFAULT_HEARTBEAT_DELAY_TIMEOUT, logger);\n heartbeatMap.set(client, heartbeat);\n return heartbeat;\n}\n"]}
|
|
1
|
+
{"version":3,"file":"heartbeat.js","sourceRoot":"","sources":["../../src/heartbeat.ts"],"names":[],"mappings":";;;;AAIA,+CAAgD;AAChD,qCAAoC;AAMpC,IAAM,iBAAiB,GAAG,CAAC,GAAG,KAAM,CAAC,CAAC,MAAM;AAY5C;IAQE,mBACU,MAAkB,EAClB,KAAa,EACb,YAAoB,EACpB,MAAgB,EAChB,OAA8B;QAA9B,wBAAA,EAAA,YAA8B;QAJ9B,WAAM,GAAN,MAAM,CAAY;QAClB,UAAK,GAAL,KAAK,CAAQ;QACb,iBAAY,GAAZ,YAAY,CAAQ;QACpB,WAAM,GAAN,MAAM,CAAU;QAChB,YAAO,GAAP,OAAO,CAAuB;QAVhC,aAAQ,GAA0C,IAAI,CAAC;QACvD,iBAAY,GAA6B,IAAI,CAAC;QAC9C,yBAAoB,GAAmB,EAAE,CAAC;QAC1C,sBAAiB,GAAmB,EAAE,CAAC;QAS7C,IAAI,CAAC,MAAM,GAAG,IAAI,GAAG,EAAwB,CAAC;QAC9C,IAAI,CAAC,OAAO,GAAG,IAAA,WAAI,GAAE,CAAC;IACxB,CAAC;IAEK,6BAAS,GAAf,UAAgB,WAAmB;;QAAnB,4BAAA,EAAA,mBAAmB;;;;;;;;wBACjC,MAAA,MAAA,IAAI,CAAC,OAAO,EAAC,eAAe,kDAAI,CAAC;wBACjC,kDAAkD;wBAClD,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,EAAE;4BAC1B,IAAI,CAAC,IAAI,EAAE,CAAC;4BACZ,sBAAO,EAAE,EAAC;yBACX;wBAGK,aAAa,GAAG,EAAE,CAAC;4CACd,OAAK;4BACN,IAAA,UAAU,GAAwC,OAAK,WAA7C,EAAE,gBAAgB,GAAsB,OAAK,iBAA3B,EAAK,YAAY,kBAAK,OAAK,EAAzD,kCAAiD,CAAF,CAAW;4BAChE,IAAM,YAAY,GAAG,OAAK,MAAM,CAAC,KAAK,CAAC,UAAU,EAAE,gBAAgB,EAAE,YAAY,CAAC,CAAC,OAAO,CAAC;4BAE3F,qEAAqE;4BACrE,kCAAkC;4BAClC,IAAI,OAAK,cAAc,CAAC,OAAK,CAAC,EAAE;gCAC9B,IAAM,UAAQ,GAAG,OAAK,CAAC,SAAS,CAAC;gCACjC,KAAK,YAAY,CAAC,OAAO,CAAC,cAAM,OAAA,KAAI,CAAC,MAAM,CAAC,MAAM,CAAC,UAAQ,CAAC,EAA5B,CAA4B,CAAC,CAAC;6BAC/D;4BACD,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;;;;4BAVnC,KAAoB,KAAA,iBAAA,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAA;gCAAnC;wCAAM,OAAK;6BAWf;;;;;;;;;wBACW,qBAAM,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,EAAA;;wBAAtC,GAAG,GAAG,SAAgC;wBAC5C,IAAI,WAAW,EAAE;4BACf,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;yBACrB;wBACD,sBAAO,GAAG,EAAC;;;;KACZ;IAEK,kCAAc,GAApB;;;;;;;6BAGM,IAAI,CAAC,YAAY,EAAjB,wBAAiB;wBAAS,qBAAM,IAAI,CAAC,YAAY,EAAA;4BAA9B,sBAAO,SAAuB,EAAC;;wBAEtD,IAAI,IAAI,CAAC,OAAO,CAAC,mBAAmB,KAAK,KAAK;4BAAE,IAAI,CAAC,2BAA2B,EAAE,CAAC;wBAEnF,+BAA+B;wBAC/B,IAAI,IAAI,CAAC,QAAQ;4BAAE,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;wBAChD,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAC,cAAM,OAAA,KAAK,KAAI,CAAC,SAAS,EAAE,EAArB,CAAqB,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;wBAI/D,YAAY,GAAG,IAAI,OAAO,CAAW,UAAC,OAAO;4BACjD,UAAU,CAAC;gCACT,KAAI,CAAC,YAAY,GAAG,IAAI,CAAC;gCACzB,OAAO,CAAC,KAAI,CAAC,SAAS,EAAE,CAAC,CAAC;4BAC5B,CAAC,EAAE,CAAC,CAAC,CAAC;wBACR,CAAC,CAAC,CAAC;wBACH,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;wBAE1B,qBAAM,YAAY,EAAA;4BAAzB,sBAAO,SAAkB,EAAC;;;;KAC3B;IAEO,+CAA2B,GAAnC;QAAA,iBAoCC;QAnCC,IAAI,IAAI,CAAC,oBAAoB,CAAC,MAAM,GAAG,CAAC,EAAE;YACxC,OAAO;SACR;QAED,8DAA8D;QAC9D,IAAM,GAAG,GAAG,IAAA,6BAAc,GAAE,CAAC;QAC7B,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,CAAC,gBAAgB,KAAK,UAAU,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE;YACvE,OAAO;SACR;QACD,IAAM,GAAG,GAAG,GAAG,CAAC,QAAQ,CAAC;QAEzB,oFAAoF;QACpF,iFAAiF;QACjF,IAAM,UAAU,GAAG,UAAC,GAAwB;;YAC1C,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE;;oBAClB,KAAsB,IAAA,KAAA,0DAAI,KAAI,CAAC,iBAAiB,UAAC,gBAAA,4BAAE;wBAA9C,IAAM,OAAO,WAAA;wBAChB,OAAO,EAAE,CAAC;qBACX;;;;;;;;;gBACD,KAAK,KAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;aAC3B;QACH,CAAC,CAAC;QAEF,iFAAiF;QACjF,IAAM,kBAAkB,GAAG;YACzB,IAAI,GAAG,CAAC,eAAe,KAAK,QAAQ,EAAE;gBACpC,KAAK,KAAI,CAAC,cAAc,EAAE,CAAC;aAC5B;QACH,CAAC,CAAC;QAEF,GAAG,CAAC,gBAAgB,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QAC7C,GAAG,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;QAC7D,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC;YAC7B,GAAG,CAAC,mBAAmB,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;YAChD,GAAG,CAAC,mBAAmB,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;QAClE,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACK,kCAAc,GAAtB,UAAuB,KAAmB;QACxC,OAAO,OAAO,CAAC,KAAK,CAAC,SAAS,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC1D,CAAC;IAEO,uCAAmB,GAA3B,UAA4B,KAAgB;;QAC1C,IAAI,IAAI,CAAC,SAAS,0CAAK,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,UAAE,CAAC,MAAM,GAAG,iBAAiB,EAAE;YACxE,0BAA0B;YAC1B,MAAA,IAAI,CAAC,MAAM,0CAAE,IAAI,CAAC,wEAAiE,KAAK,CAAC,SAAU,CAAE,CAAC,CAAC;YACvG,IAAI,KAAK,CAAC,SAAS,EAAE;gBACnB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;aACrC;YACD,OAAO,KAAK,CAAC;SACd;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,oFAAoF;IACpF,2BAAO,GAAP,UAAQ,KAAgB;QACtB,IAAI,CAAC,KAAK,CAAC,SAAS;YAAE,OAAO,KAAK,CAAC;QACnC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,wCAC1B,KAAK,KACR,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,YAAY,EAAE,IACtE,CAAC;QACH,OAAO,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IAEK,yBAAK,GAAX,UAAY,KAAgB;;;;;;wBAC1B,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE;4BACpB,sBAAO,IAAI,KAAK,CAAC,wDAAwD,CAAC,EAAC;yBAC5E;wBACD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;4BACxB,sBAAO;yBACR;wBAGuB,qBAAM,IAAI,CAAC,cAAc,EAAE,EAAA;;wBAA7C,eAAe,GAAG,SAA2B;wBACnD,sBAAO,eAAe,CAAC,IAAI,CAAC,UAAC,MAAM,IAAK,OAAA,MAAM,CAAC,KAAK,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS,EAA1C,CAA0C,CAAC,EAAC;;;;KACrF;IAED;;;;;;;OAOG;IACG,gCAAY,GAAlB,UAAmB,KAAgB;;;gBACjC,KAAK,CAAC,KAAK,GAAG,EAAE,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC;gBACnC,sBAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EAAC;;;KAC1B;IAED;;;OAGG;IACG,0BAAM,GAAZ,UAAa,KAAgB;;;;gBAC3B,IAAI,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE;oBACjD,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;oBACrD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,wCAC1B,KAAK;wBACR,+EAA+E;wBAC/E,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,YAAY,EAAE,IACtE,CAAC;oBACH,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,IAAI,WAAW,EAAE;wBACnD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;wBAC9C,sBAAO;qBACR;iBACF;;;;KACF;IAED,uCAAuC;IACvC,kCAAc,GAAd,UAAe,OAAmB;QAAlC,iBAQC;QAPC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACrC,OAAO;YACL,IAAM,KAAK,GAAG,KAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACtD,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;gBAChB,KAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;aACzC;QACH,CAAC,CAAC;IACJ,CAAC;IAED,6DAA6D;IAC7D,yBAAK,GAAL;QACE,IAAI,CAAC,QAAQ,IAAI,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC9C,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACvB,CAAC;IAED,wBAAI,GAAJ,UAAK,KAAa;QAAb,sBAAA,EAAA,aAAa;QAChB,IAAI,CAAC,KAAK,EAAE,CAAC;QACb,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QACpB,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,UAAC,cAAc,IAAK,OAAA,cAAc,EAAE,EAAhB,CAAgB,CAAC,CAAC;QACxE,IAAI,CAAC,oBAAoB,GAAG,EAAE,CAAC;QAC/B,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;SACrB;IACH,CAAC;IACH,gBAAC;AAAD,CAAC,AApND,IAoNC;AApNY,8BAAS;AAsNtB,IAAM,0BAA0B,GAAG,KAAM,CAAC;AAC1C,uEAAuE;AACvE,IAAM,+BAA+B,GAAG,OAAS,CAAC;AAIlD,IAAM,YAAY,GAAiB,IAAI,GAAG,EAAyB,CAAC;AAEpE,SAAgB,oBAAoB,CAAC,MAAkB,EAAE,MAAgB;IACvE,IAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC1C,IAAI,QAAQ,EAAE;QACZ,OAAO,QAAQ,CAAC;KACjB;IACD,IAAM,SAAS,GAAG,IAAI,SAAS,CAAC,MAAM,EAAE,0BAA0B,EAAE,+BAA+B,EAAE,MAAM,CAAC,CAAC;IAC7G,YAAY,CAAC,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACpC,OAAO,SAAS,CAAC;AACnB,CAAC;AARD,oDAQC","sourcesContent":["import { ILogger } from './logger';\nimport { CoreClient } from './types/client/core-client';\nimport { BaseEvent, Delay } from './types/event/base-event';\nimport { Result } from './types/result';\nimport { getGlobalScope } from './global-scope';\nimport { UUID } from './utils/uuid';\n\ntype DelayedEvent = BaseEvent & {\n delay: Delay;\n};\n\nconst EVENTS_SIZE_LIMIT = 4 * 10_000; // 4KB\n\ninterface HeartbeatOptions {\n /** Refresh queued snapshots immediately before each send. */\n beforeHeartbeat?: () => void;\n /**\n * Send queued events when the page becomes hidden or exits. Defaults to true.\n * Disable when the caller owns page lifecycle handling and sends snapshots itself.\n */\n sendOnPageLifecycle?: boolean;\n}\n\nexport class Heartbeat {\n private events: Map<string, DelayedEvent>;\n private delayId: string;\n private interval: ReturnType<typeof setInterval> | null = null;\n private resetPromise: Promise<Result[]> | null = null;\n private unsubscribeFunctions: (() => void)[] = [];\n private pageHidePreparers: (() => void)[] = [];\n\n constructor(\n private client: CoreClient,\n private pulse: number,\n private delayTimeout: number,\n private logger?: ILogger,\n private options: HeartbeatOptions = {},\n ) {\n this.events = new Map<string, DelayedEvent>();\n this.delayId = UUID();\n }\n\n async heartbeat(flushClient = false): Promise<Result[]> {\n this.options.beforeHeartbeat?.();\n // stop sending heartbeats if no events are queued\n if (this.events.size === 0) {\n this.stop();\n return [];\n }\n\n // track all of the delayed events\n const trackedEvents = [];\n for (const event of this.events.values()) {\n const { event_type, event_properties, ...eventOptions } = event;\n const eventPromise = this.client.track(event_type, event_properties, eventOptions).promise;\n\n // if the event has no timeout, then it's instant ingested and we can\n // delete it after it was ingested\n if (this.isInstantEvent(event)) {\n const insertId = event.insert_id;\n void eventPromise.finally(() => this.events.delete(insertId));\n }\n trackedEvents.push(eventPromise);\n }\n const res = await Promise.all(trackedEvents);\n if (flushClient) {\n this.client.flush();\n }\n return res;\n }\n\n async resetHeartbeat() {\n // if a reset is scheduled but hasn't fired yet, the pending heartbeat will\n // include any newly tracked events, so share its result\n if (this.resetPromise) return await this.resetPromise;\n\n if (this.options.sendOnPageLifecycle !== false) this.setupPageLifecycleListeners();\n\n // reset the heartbeat interval\n if (this.interval) clearInterval(this.interval);\n this.interval = setInterval(() => void this.heartbeat(), this.pulse);\n\n // invoke heartbeat on the next macrotask tick. Clear resetPromise as soon as the\n // heartbeat starts so that events tracked while it's in flight trigger a new heartbeat\n const resetPromise = new Promise<Result[]>((resolve) => {\n setTimeout(() => {\n this.resetPromise = null;\n resolve(this.heartbeat());\n }, 0);\n });\n this.resetPromise = resetPromise;\n\n return await resetPromise;\n }\n\n private setupPageLifecycleListeners() {\n if (this.unsubscribeFunctions.length > 0) {\n return;\n }\n\n // only browser-like environments expose page lifecycle events\n const win = getGlobalScope();\n if (!win || typeof win.addEventListener !== 'function' || !win.document) {\n return;\n }\n const doc = win.document;\n\n // When the user leaves the page, send the latest events and flush them immediately.\n // Preparers update queued events (for example stop_reason) before this snapshot.\n const onPageHide = (evt: PageTransitionEvent) => {\n if (!evt.persisted) {\n for (const prepare of [...this.pageHidePreparers]) {\n prepare();\n }\n void this.heartbeat(true);\n }\n };\n\n // when the tab becomes hidden, reset the heartbeat so the latest events are sent\n const onVisibilityChange = () => {\n if (doc.visibilityState === 'hidden') {\n void this.resetHeartbeat();\n }\n };\n\n win.addEventListener('pagehide', onPageHide);\n doc.addEventListener('visibilitychange', onVisibilityChange);\n this.unsubscribeFunctions.push(() => {\n win.removeEventListener('pagehide', onPageHide);\n doc.removeEventListener('visibilitychange', onVisibilityChange);\n });\n }\n\n /**\n * An instant event is one that has no delay and gets ingested immediately\n * @param event\n * @returns\n */\n private isInstantEvent(event: DelayedEvent): event is DelayedEvent & { insert_id: string } {\n return Boolean(event.insert_id && !event.delay.timeout);\n }\n\n private checkEventSizeLimit(event: BaseEvent) {\n if (JSON.stringify([...this.events.values()]).length > EVENTS_SIZE_LIMIT) {\n /* istanbul ignore next */\n this.logger?.warn(`Heartbeat: events size limit reached, rejecting event with id=${event.insert_id!}`);\n if (event.insert_id) {\n this.events.delete(event.insert_id);\n }\n return false;\n }\n return true;\n }\n\n /** Admit an event synchronously without starting timers or waiting for delivery. */\n enqueue(event: BaseEvent): boolean {\n if (!event.insert_id) return false;\n this.events.set(event.insert_id, {\n ...event,\n delay: event.delay || { id: this.delayId, timeout: this.delayTimeout },\n });\n return this.checkEventSizeLimit(event);\n }\n\n async track(event: BaseEvent): Promise<Result | Error | undefined> {\n if (!event.insert_id) {\n return new Error('insert_id is required on events tracked with heartbeat');\n }\n if (!this.enqueue(event)) {\n return;\n }\n\n // emit a heartbeat, restart interval and return the result\n const heartbeatResult = await this.resetHeartbeat();\n return heartbeatResult.find((result) => result.event.insert_id === event.insert_id);\n }\n\n /**\n * Ingest an event with no delay\n *\n * (This is different from normal \"track\". It sends the events to the \"/delayed\" endpoint\n * so that it can be tracked in the same payload as other events, for atomicity)\n * @param event\n * @returns\n */\n async trackNoDelay(event: BaseEvent) {\n event.delay = { id: this.delayId };\n return this.track(event);\n }\n\n /**\n * Update an existing event\n * @param event\n */\n async update(event: BaseEvent) {\n if (event.insert_id && this.events.has(event.insert_id)) {\n const backupEvent = this.events.get(event.insert_id);\n this.events.set(event.insert_id, {\n ...event,\n // Page engagement supplies its delay group and removes timeout to finalize it.\n delay: event.delay || { id: this.delayId, timeout: this.delayTimeout },\n });\n if (!this.checkEventSizeLimit(event) && backupEvent) {\n this.events.set(event.insert_id, backupEvent);\n return;\n }\n }\n }\n\n // run handlers before 'pagehide' event\n beforePageHide(prepare: () => void): () => void {\n this.pageHidePreparers.push(prepare);\n return () => {\n const index = this.pageHidePreparers.indexOf(prepare);\n if (index !== -1) {\n this.pageHidePreparers.splice(index, 1);\n }\n };\n }\n\n /** Stop the pulse without discarding the latest snapshot. */\n pause() {\n this.interval && clearInterval(this.interval);\n this.interval = null;\n }\n\n stop(flush = false) {\n this.pause();\n this.events.clear();\n this.unsubscribeFunctions.forEach((removeListener) => removeListener());\n this.unsubscribeFunctions = [];\n if (flush) {\n this.client.flush();\n }\n }\n}\n\nconst DEFAULT_HEARTBEAT_INTERVAL = 60_000;\n// const DEFAULT_HEARTBEAT_INTERVAL = 2_000; // TODO: DO NOT MERGE THIS\nconst DEFAULT_HEARTBEAT_DELAY_TIMEOUT = 3_600_000;\n\ntype HeartbeatMap = Map<CoreClient, Heartbeat>;\n\nconst heartbeatMap: HeartbeatMap = new Map<CoreClient, Heartbeat>();\n\nexport function getHeartbeatInstance(client: CoreClient, logger?: ILogger): Heartbeat {\n const existing = heartbeatMap.get(client);\n if (existing) {\n return existing;\n }\n const heartbeat = new Heartbeat(client, DEFAULT_HEARTBEAT_INTERVAL, DEFAULT_HEARTBEAT_DELAY_TIMEOUT, logger);\n heartbeatMap.set(client, heartbeat);\n return heartbeat;\n}\n"]}
|
package/lib/cjs/index.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ export { AmplitudeContext } from './types/amplitude-context';
|
|
|
5
5
|
export { Identify, IIdentify, ValidPropertyType } from './identify';
|
|
6
6
|
export { Revenue, IRevenue, RevenueProperty } from './revenue';
|
|
7
7
|
export { Destination } from './plugins/destination';
|
|
8
|
-
export { getHeartbeatInstance } from './heartbeat';
|
|
8
|
+
export { Heartbeat, getHeartbeatInstance } from './heartbeat';
|
|
9
9
|
export { IdentityEventSender } from './plugins/identity';
|
|
10
10
|
export { Config, RequestMetadata } from './config';
|
|
11
11
|
export { IConfig } from './types/config/core-config';
|
|
@@ -55,7 +55,7 @@ export { Plugin, BeforePlugin, DestinationPlugin, EnrichmentPlugin, PluginType,
|
|
|
55
55
|
export { Result } from './types/result';
|
|
56
56
|
export { ElementInteractionsOptions, Messenger, ActionType, DEFAULT_CSS_SELECTOR_ALLOWLIST, DEFAULT_DATA_ATTRIBUTE_PREFIX, DEFAULT_ACTION_CLICK_ALLOWLIST, DEFAULT_EXPOSURE_DURATION, LabeledEvent, Trigger, DataSource, } from './types/element-interactions';
|
|
57
57
|
export { FrustrationInteractionsOptions, DEFAULT_DEAD_CLICK_ALLOWLIST, DEFAULT_RAGE_CLICK_ALLOWLIST, DEFAULT_ERROR_CLICK_ALLOWLIST, DEFAULT_RAGE_CLICK_THRESHOLD, DEFAULT_RAGE_CLICK_WINDOW_MS, DEFAULT_RAGE_CLICK_OUT_OF_BOUNDS_THRESHOLD, DEFAULT_DEAD_CLICK_WINDOW_MS, } from './types/frustration-interactions';
|
|
58
|
-
export { PageTrackingOptions, PageTrackingTrackOn, PageTrackingHistoryChanges } from './types/page-view-tracking';
|
|
58
|
+
export { EngagedTimeOptions, PageTrackingOptions, PageTrackingTrackOn, PageTrackingHistoryChanges, } from './types/page-view-tracking';
|
|
59
59
|
export { FormInteractionsOptions } from './types/form-interactions';
|
|
60
60
|
export { Status } from './types/status';
|
|
61
61
|
export { NetworkEventCallback, networkObserver } from './observers/network';
|
|
@@ -89,7 +89,7 @@ export { parseBackgroundCaptureDeviceMode } from './messenger/background-capture
|
|
|
89
89
|
export { AMPLITUDE_ORIGIN, AMPLITUDE_ORIGIN_EU, AMPLITUDE_ORIGIN_STAGING, AMPLITUDE_ORIGINS_MAP, AMPLITUDE_BACKGROUND_CAPTURE_SCRIPT_URL, } from './messenger/constants';
|
|
90
90
|
export { ExcludeInternalReferrersOptions, EXCLUDE_INTERNAL_REFERRERS_CONDITIONS } from './types/config/browser-config';
|
|
91
91
|
export { VideoObserver, State as VideoState, type VideoObserverParams } from './observers/video';
|
|
92
|
-
export { EmbeddedVideoPlayer, type Vendor as VideoVendor } from './video-analytics/types';
|
|
92
|
+
export { EmbeddedVideoPlayer, type Vendor as VideoVendor, VideoStopCause, VideoStopReason, } from './video-analytics/types';
|
|
93
93
|
export { isChromeExtension, isReactNative } from './utils/environment';
|
|
94
94
|
export { translateRemoteConfigToLocal, mergeUrls, transformNetworkTrackingRemoteConfig, NetworkCaptureRuleRemoteConfig, NetworkTrackingOptionsRemoteConfig, } from './config/joined-config';
|
|
95
95
|
export { createNetworkRequestEvent, formatNetworkRequestEvent } from './utils/network-request-event';
|
package/lib/cjs/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AACpE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AACpE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AACxG,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAEhD,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACxE,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAClF,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AACpC,OAAO,EACL,6BAA6B,EAC7B,qBAAqB,EACrB,oBAAoB,EACpB,kBAAkB,GACnB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,8CAA8C,EAC9C,0BAA0B,EAC1B,4BAA4B,GAC7B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtE,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACzE,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAEvD,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACnF,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAE3D,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AACzG,OAAO,EACL,mBAAmB,EACnB,SAAS,EACT,aAAa,EACb,eAAe,EACf,WAAW,GACZ,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAE,yBAAyB,EAAE,MAAM,mCAAmC,CAAC;AAE9E,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EACL,yBAAyB,EACzB,4BAA4B,EAC5B,+BAA+B,GAChC,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EACL,kBAAkB,EAClB,mBAAmB,EACnB,YAAY,EACZ,iBAAiB,EACjB,gBAAgB,EAChB,mBAAmB,EACnB,MAAM,EACN,wBAAwB,EACxB,uBAAuB,GACxB,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACjG,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EACL,KAAK,EACL,iBAAiB,EACjB,gBAAgB,EAChB,aAAa,EACb,kBAAkB,EAClB,sBAAsB,GACvB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACnE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AACvG,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EACL,MAAM,EACN,YAAY,EACZ,iBAAiB,EACjB,gBAAgB,EAChB,UAAU,EACV,iBAAiB,GAClB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACxC,OAAO,EACL,0BAA0B,EAC1B,SAAS,EACT,UAAU,EACV,8BAA8B,EAC9B,6BAA6B,EAC7B,8BAA8B,EAC9B,yBAAyB,EACzB,YAAY,EACZ,OAAO,EACP,UAAU,GACX,MAAM,8BAA8B,CAAC;AAEtC,OAAO,EACL,8BAA8B,EAC9B,4BAA4B,EAC5B,4BAA4B,EAC5B,6BAA6B,EAC7B,4BAA4B,EAC5B,4BAA4B,EAC5B,0CAA0C,EAC1C,4BAA4B,GAC7B,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACL,kBAAkB,EAClB,mBAAmB,EACnB,mBAAmB,EACnB,0BAA0B,GAC3B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC,OAAO,EAAE,oBAAoB,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC5E,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACjH,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AACvG,OAAO,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAEpE,OAAO,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAC;AACvE,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,EAAE,0BAA0B,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AAClG,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAGtD,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACnH,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EACL,YAAY,EACZ,mBAAmB,EACnB,iBAAiB,EACjB,sBAAsB,EACtB,QAAQ,EACR,SAAS,EACT,WAAW,GACZ,MAAM,mBAAmB,CAAC;AAG3B,OAAO,EACL,aAAa,EACb,cAAc,EACd,sBAAsB,EACtB,eAAe,EACf,cAAc,EACd,kBAAkB,EAClB,aAAa,EACb,kBAAkB,EAClB,mBAAmB,GACpB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAG9D,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAGrE,OAAO,EACL,iBAAiB,EACjB,6BAA6B,EAC7B,yCAAyC,EACzC,0BAA0B,EAC1B,kBAAkB,EAClB,6BAA6B,EAC7B,sBAAsB,GACvB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AAExF,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAE5F,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAG/C,YAAY,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAC5F,OAAO,EAAE,0BAA0B,EAAE,MAAM,mCAAmC,CAAC;AAC/E,OAAO,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AACzE,YAAY,EACV,2BAA2B,EAC3B,+BAA+B,GAChC,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,gCAAgC,EAAE,MAAM,sCAAsC,CAAC;AACxF,OAAO,EACL,gBAAgB,EAChB,mBAAmB,EACnB,wBAAwB,EACxB,qBAAqB,EACrB,uCAAuC,GACxC,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAE,+BAA+B,EAAE,qCAAqC,EAAE,MAAM,+BAA+B,CAAC;AAEvH,OAAO,EAAE,aAAa,EAAE,KAAK,IAAI,UAAU,EAAE,KAAK,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACjG,OAAO,EACL,mBAAmB,EACnB,KAAK,MAAM,IAAI,WAAW,EAC1B,cAAc,EACd,eAAe,GAChB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,EACL,4BAA4B,EAC5B,SAAS,EACT,oCAAoC,EACpC,8BAA8B,EAC9B,kCAAkC,GACnC,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAE,yBAAyB,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AACrG,OAAO,EAAE,6BAA6B,EAAE,MAAM,qCAAqC,CAAC;AACpF,OAAO,EAAE,sBAAsB,EAAE,gCAAgC,EAAE,MAAM,6BAA6B,CAAC"}
|