@amplitude/analytics-core 2.62.0-codexsemantic-review-integration.0 → 2.62.0-video-analytics-8.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/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/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/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 +181 -26
- 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/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
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"track-video.js","sourceRoot":"","sources":["../../../src/video-analytics/track-video.ts"],"names":[],"mappings":";;;;AAUA,SAAS,yBAAyB,CAAC,WAAmB,EAAE,QAAgB;IACtE,IAAI,gBAAgB,GAAG,CAAC,CAAC;IACzB,IAAI,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,QAAQ,GAAG,CAAC,EAAE;QAC7E,IAAM,UAAU,GAAG,CAAC,WAAW,GAAG,QAAQ,CAAC,GAAG,GAAG,CAAC;QAClD,gBAAgB,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC;KAC3D;IACD,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAED,SAAS,YAAY,CAAC,OAAsC,EAAE,UAA4B;IACxF,IAAM,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;IACxC,IAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAClC,0BACE,QAAQ,UAAA,EACR,UAAU,EAAE,WAAW,EACvB,aAAa,EAAE,WAAW,EAC1B,iBAAiB,EAAE,yBAAyB,CAAC,WAAW,EAAE,QAAQ,CAAC,IAChE,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAChE;AACJ,CAAC;AAED,SAAS,cAAc,CAAC,OAAmB;IACzC,OAAO;QACL,eAAe,EAAE,OAAO,CAAC,YAAY,CAAC,aAAa,CAAC;QACpD,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC,mBAAmB,CAAC;QACvD,eAAe,EAAE,OAAO,CAAC,YAAY,CAAC,sBAAsB,CAAC;KAC9D,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,cAAc,CAAC,OAAsC,EAAE,QAAsB,EAAE,MAAe;IAC5G,IAAM,WAAW,GAAG;QAClB,IAAM,UAAU,yCACX,YAAY,CAAC,OAAO,CAAC,GACrB,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CACrD,CAAC;QACF,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAC9B,CAAC,CAAC;IACF,OAAO,CAAC,gBAAgB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAE9C,IAAM,YAAY,GAAG;QACnB,IAAM,UAAU,yCACX,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC,GAC/B,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CACrD,CAAC;QACF,QAAQ,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC/B,CAAC,CAAC;IACF,OAAO,CAAC,gBAAgB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAEhD,IAAM,YAAY,GAAG;QACnB,IAAM,UAAU,yCACX,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,GAC9B,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CACrD,CAAC;QACF,QAAQ,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC/B,CAAC,CAAC;IACF,OAAO,CAAC,gBAAgB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAEhD,IAAM,cAAc,GAAG;QACrB,IAAM,YAAY,yCACb,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,GAChC,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CACrD,CAAC;QACF,QAAQ,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;IACnC,CAAC,CAAC;IACF,OAAO,CAAC,gBAAgB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;IAEpD,IAAM,aAAa,GAAG;QACpB,IAAM,WAAW,yCACZ,YAAY,CAAC,OAAO,CAAC,GACrB,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CACrD,CAAC;QACF,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IACjC,CAAC,CAAC;IACF,OAAO,CAAC,gBAAgB,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;IAElD,IAAM,iBAAiB,GAAG;QACxB,IAAM,KAAK,GAAG,OAA2B,CAAC;QAC1C,IAAM,eAAe,GAAoB;YACvC,QAAQ,EAAE,OAAO,CAAC,WAAW;YAC7B,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO;SAC3B,CAAC;QACF,QAAQ,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;IACzC,CAAC,CAAC;IACF,OAAO,CAAC,gBAAgB,CAAC,YAAY,EAAE,iBAAiB,CAAC,CAAC;IAE1D,OAAO;QACL,OAAO,CAAC,mBAAmB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;QACjD,OAAO,CAAC,mBAAmB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QACnD,OAAO,CAAC,mBAAmB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QACnD,OAAO,CAAC,mBAAmB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;QACvD,OAAO,CAAC,mBAAmB,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;QACrD,OAAO,CAAC,mBAAmB,CAAC,YAAY,EAAE,iBAAiB,CAAC,CAAC;IAC/D,CAAC,CAAC;AACJ,CAAC;AAhED,wCAgEC;AAED,SAAe,iBAAiB,CAAC,MAA2B;;;;;wBACtC,qBAAM,IAAI,OAAO,CAAS,UAAC,OAAO,IAAK,OAAA,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,EAA9B,CAA8B,CAAC,EAAA;;oBAApF,WAAW,GAAG,SAAsE;oBAC1F,sBAAO,EAAE,WAAW,aAAA,EAAE,EAAC;;;;CACxB;AAED,SAAe,iBAAiB,CAC9B,MAA2B,EAC3B,IAAuB,EACvB,MAAqB,EACrB,UAA4B;;;;;wBAEI,qBAAM,OAAO,CAAC,GAAG,CAAC;wBAChD,IAAI,OAAO,CAAS,UAAC,OAAO,IAAK,OAAA,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,EAA3B,CAA2B,CAAC;wBAC7D,IAAI,OAAO,CAAS,UAAC,OAAO,IAAK,OAAA,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,EAA9B,CAA8B,CAAC;qBACjE,CAAC,EAAA;;oBAHI,KAAA,8BAA0B,SAG9B,KAAA,EAHK,QAAQ,QAAA,EAAE,WAAW,QAAA;oBAKtB,cAAc,GAA8C,EAAE,CAAC;oBACrE,IAAI,MAAM,KAAK,KAAK,EAAE;wBAChB,GAAG,SAAA,CAAC;wBACR,IAAI;4BACF,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAW,CAAC,CAAC;4BAClD,cAAc,CAAC,eAAe,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;4BAC9E,cAAc,CAAC,YAAY,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;4BACxE,cAAc,CAAC,eAAe,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;yBAChE;wBAAC,OAAO,KAAK,EAAE;4BACd,kDAAkD;yBACnD;qBACF;oBACD,0DACE,QAAQ,UAAA,EACR,UAAU,EAAE,WAAW,EACvB,aAAa,EAAE,WAAW,EAC1B,iBAAiB,EAAE,yBAAyB,CAAC,WAAW,EAAE,QAAQ,CAAC,IAChE,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,GAC7D,cAAc,GACjB;;;;CACH;AAED,SAAgB,kBAAkB,CAAC,MAA2B,EAAE,QAAsB,EAAE,MAA4B;IAA5B,uBAAA,EAAA,aAA4B;IAClH,IAAM,aAAa,GAAmB,EAAE,CAAC;IACzC,IAAM,YAAY,GAAG;QACX,IAAA,IAAI,GAAK,MAAM,KAAX,CAAY;QACxB,IAAI,SAAS,GAAG,KAAK,CAAC;QAEtB,IAAM,WAAW,GAAG;YAClB,iBAAiB,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC;iBACpC,IAAI,CAAC,UAAC,WAAW;gBAChB,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;YAC/B,CAAC,CAAC;iBACD,KAAK,CAAC,UAAC,KAAK;gBACX,QAAQ,CAAC,OAAO,CAAC,6DAAsD,KAAe,CAAE,CAAC,CAAC;YAC5F,CAAC,CAAC,CAAC;QACP,CAAC,CAAC;QACF,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;QAC/B,aAAa,CAAC,IAAI,CAAC,cAAM,OAAA,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,EAA/B,CAA+B,CAAC,CAAC;QAE1D,IAAM,YAAY,GAAG;YACnB,iBAAiB,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC;iBAC9C,IAAI,CAAC,UAAC,WAAW;gBAChB,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YAChC,CAAC,CAAC;iBACD,KAAK,CAAC,UAAC,KAAK;gBACX,QAAQ,CAAC,OAAO,CAAC,8DAAuD,KAAe,CAAE,CAAC,CAAC;YAC7F,CAAC,CAAC,CAAC;QACP,CAAC,CAAC;QACF,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QACjC,aAAa,CAAC,IAAI,CAAC,cAAM,OAAA,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,YAAY,CAAC,EAAjC,CAAiC,CAAC,CAAC;QAE5D,IAAM,YAAY,GAAG;YACnB,iBAAiB,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC;iBAC7C,IAAI,CAAC,UAAC,WAAW;gBAChB,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YAChC,CAAC,CAAC;iBACD,KAAK,CAAC,UAAC,KAAK;gBACX,QAAQ,CAAC,OAAO,CAAC,8DAAuD,KAAe,CAAE,CAAC,CAAC;YAC7F,CAAC,CAAC,CAAC;QACP,CAAC,CAAC;QACF,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QACjC,aAAa,CAAC,IAAI,CAAC,cAAM,OAAA,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,YAAY,CAAC,EAAjC,CAAiC,CAAC,CAAC;QAE5D,IAAM,cAAc,GAAG;YACrB,SAAS,GAAG,IAAI,CAAC;YACjB,iBAAiB,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC;iBAC/C,IAAI,CAAC,UAAC,WAAW;gBAChB,QAAQ,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;YAClC,CAAC,CAAC;iBACD,KAAK,CAAC,UAAC,KAAK;gBACX,QAAQ,CAAC,OAAO,CAAC,gEAAyD,KAAe,CAAE,CAAC,CAAC;YAC/F,CAAC,CAAC,CAAC;QACP,CAAC,CAAC;QACF,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;QACrC,aAAa,CAAC,IAAI,CAAC,cAAM,OAAA,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,cAAc,CAAC,EAArC,CAAqC,CAAC,CAAC;QAEhE,IAAM,aAAa,GAAG;YACpB,SAAS,GAAG,KAAK,CAAC;YAClB,iBAAiB,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC;iBACpC,IAAI,CAAC,UAAC,WAAW;gBAChB,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;YACjC,CAAC,CAAC;iBACD,KAAK,CAAC,UAAC,KAAK;gBACX,QAAQ,CAAC,OAAO,CAAC,+DAAwD,KAAe,CAAE,CAAC,CAAC;YAC9F,CAAC,CAAC,CAAC;QACP,CAAC,CAAC;QACF,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;QACnC,aAAa,CAAC,IAAI,CAAC,cAAM,OAAA,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,aAAa,CAAC,EAAnC,CAAmC,CAAC,CAAC;QAE9D,IAAM,iBAAiB,GAAG;YACxB,iBAAiB,CAAC,MAAM,CAAC;iBACtB,IAAI,CAAC,UAAC,EAAe;oBAAb,WAAW,iBAAA;gBAClB,IAAM,eAAe,GAAoB;oBACvC,QAAQ,EAAE,WAAW;oBACrB,SAAS,EAAE,SAAS;iBACrB,CAAC;gBACF,QAAQ,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;YACzC,CAAC,CAAC;iBACD,KAAK,CAAC,UAAC,KAAK;gBACX,QAAQ,CAAC,OAAO,CAAC,mEAA4D,KAAe,CAAE,CAAC,CAAC;YAClG,CAAC,CAAC,CAAC;QACP,CAAC,CAAC;QACF,MAAM,CAAC,EAAE,CAAC,YAAY,EAAE,iBAAiB,CAAC,CAAC;QAC3C,aAAa,CAAC,IAAI,CAAC,cAAM,OAAA,MAAM,CAAC,GAAG,CAAC,YAAY,EAAE,iBAAiB,CAAC,EAA3C,CAA2C,CAAC,CAAC;IACxE,CAAC,CAAC;IACF,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAEjC,OAAO;QACL,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QAClC,aAAa,CAAC,OAAO,CAAC,UAAC,WAAW,IAAK,OAAA,WAAW,EAAE,EAAb,CAAa,CAAC,CAAC;IACxD,CAAC,CAAC;AACJ,CAAC;AA1FD,gDA0FC","sourcesContent":["import {\n VideoHandler,\n VideoEvent,\n EmbeddedVideoPlayer,\n MuxElement,\n Vendor,\n VideoStopReason,\n TimeUpdateEvent,\n} from './types';\n\nfunction calculatePercentCompleted(currentTime: number, duration: number) {\n let percentCompleted = 0;\n if (Number.isFinite(currentTime) && Number.isFinite(duration) && duration > 0) {\n const rawPercent = (currentTime / duration) * 100;\n percentCompleted = Math.min(100, Math.max(0, rawPercent));\n }\n return percentCompleted;\n}\n\nfunction getVideoData(videoEl: HTMLVideoElement | MuxElement, stopReason?: VideoStopReason) {\n const currentTime = videoEl.currentTime;\n const duration = videoEl.duration;\n return {\n duration,\n start_time: currentTime,\n last_position: currentTime,\n percent_completed: calculatePercentCompleted(currentTime, duration),\n ...(stopReason !== undefined ? { stop_reason: stopReason } : {}),\n };\n}\n\nfunction getMuxMetadata(videoEl: MuxElement) {\n return {\n mux_playback_id: videoEl.getAttribute('playback-id'),\n mux_video_id: videoEl.getAttribute('metadata-video-id'),\n mux_video_title: videoEl.getAttribute('metadata-video-title'),\n };\n}\n\n/**\n * Track a standard HTML video element.\n *\n * @param videoEl - The HTML video element to track.\n * @param handlers - The video handlers to call when on video lifecycle events.\n * @returns A function to untrack the video.\n */\nexport function trackHtmlVideo(videoEl: HTMLVideoElement | MuxElement, handlers: VideoHandler, vendor?: Vendor) {\n const playHandler = () => {\n const startEvent: VideoEvent = {\n ...getVideoData(videoEl),\n ...(vendor === 'mux' ? getMuxMetadata(videoEl) : {}),\n };\n handlers.onPlay(startEvent);\n };\n videoEl.addEventListener('play', playHandler);\n\n const pauseHandler = () => {\n const pauseEvent: VideoEvent = {\n ...getVideoData(videoEl, 'paused'),\n ...(vendor === 'mux' ? getMuxMetadata(videoEl) : {}),\n };\n handlers.onPause(pauseEvent);\n };\n videoEl.addEventListener('pause', pauseHandler);\n\n const endedHandler = () => {\n const endedEvent: VideoEvent = {\n ...getVideoData(videoEl, 'ended'),\n ...(vendor === 'mux' ? getMuxMetadata(videoEl) : {}),\n };\n handlers.onEnded(endedEvent);\n };\n videoEl.addEventListener('ended', endedHandler);\n\n const seekingHandler = () => {\n const seekingEvent: VideoEvent = {\n ...getVideoData(videoEl, 'seeking'),\n ...(vendor === 'mux' ? getMuxMetadata(videoEl) : {}),\n };\n handlers.onSeeking(seekingEvent);\n };\n videoEl.addEventListener('seeking', seekingHandler);\n\n const seekedHandler = () => {\n const seekedEvent: VideoEvent = {\n ...getVideoData(videoEl),\n ...(vendor === 'mux' ? getMuxMetadata(videoEl) : {}),\n };\n handlers.onSeeked(seekedEvent);\n };\n videoEl.addEventListener('seeked', seekedHandler);\n\n const timeupdateHandler = () => {\n const media = videoEl as HTMLVideoElement;\n const timeupdateEvent: TimeUpdateEvent = {\n position: videoEl.currentTime,\n isSeeking: !!media.seeking,\n };\n handlers.onTimeUpdate(timeupdateEvent);\n };\n videoEl.addEventListener('timeupdate', timeupdateHandler);\n\n return () => {\n videoEl.removeEventListener('play', playHandler);\n videoEl.removeEventListener('pause', pauseHandler);\n videoEl.removeEventListener('ended', endedHandler);\n videoEl.removeEventListener('seeking', seekingHandler);\n videoEl.removeEventListener('seeked', seekedHandler);\n videoEl.removeEventListener('timeupdate', timeupdateHandler);\n };\n}\n\nasync function getTimeUpdateInfo(player: EmbeddedVideoPlayer) {\n const currentTime = await new Promise<number>((resolve) => player.getCurrentTime(resolve));\n return { currentTime };\n}\n\nasync function getIframeMetadata(\n player: EmbeddedVideoPlayer,\n elem: HTMLIFrameElement,\n vendor: Vendor | null,\n stopReason?: VideoStopReason,\n) {\n const [duration, currentTime] = await Promise.all([\n new Promise<number>((resolve) => player.getDuration(resolve)),\n new Promise<number>((resolve) => player.getCurrentTime(resolve)),\n ]);\n\n const vendorMetadata: Record<string, string | null | undefined> = {};\n if (vendor === 'mux') {\n let url;\n try {\n url = new URL(elem.getAttribute('src') as string);\n vendorMetadata.mux_video_title = url.searchParams.get('metadata-video-title');\n vendorMetadata.mux_video_id = url.searchParams.get('metadata-video-id');\n vendorMetadata.mux_playback_id = url.pathname.split('/').pop();\n } catch (error) {\n // invalid or no src url, skip the header metadata\n }\n }\n return {\n duration,\n start_time: currentTime,\n last_position: currentTime,\n percent_completed: calculatePercentCompleted(currentTime, duration),\n ...(stopReason !== undefined ? { stop_reason: stopReason } : {}),\n ...vendorMetadata,\n };\n}\n\nexport function trackEmbeddedVideo(player: EmbeddedVideoPlayer, handlers: VideoHandler, vendor: Vendor | null = null) {\n const onUnsubscribe: (() => void)[] = [];\n const readyHandler = () => {\n const { elem } = player;\n let isSeeking = false;\n\n const playHandler = () => {\n getIframeMetadata(player, elem, vendor)\n .then((playerState) => {\n handlers.onPlay(playerState);\n })\n .catch((error) => {\n handlers.onError(`Error getting iframe metadata from 'play' handler: ${error as string}`);\n });\n };\n player.on('play', playHandler);\n onUnsubscribe.push(() => player.off('play', playHandler));\n\n const pauseHandler = () => {\n getIframeMetadata(player, elem, vendor, 'paused')\n .then((playerState) => {\n handlers.onPause(playerState);\n })\n .catch((error) => {\n handlers.onError(`Error getting iframe metadata from 'pause' handler: ${error as string}`);\n });\n };\n player.on('pause', pauseHandler);\n onUnsubscribe.push(() => player.off('pause', pauseHandler));\n\n const endedHandler = () => {\n getIframeMetadata(player, elem, vendor, 'ended')\n .then((playerState) => {\n handlers.onEnded(playerState);\n })\n .catch((error) => {\n handlers.onError(`Error getting iframe metadata from 'ended' handler: ${error as string}`);\n });\n };\n player.on('ended', endedHandler);\n onUnsubscribe.push(() => player.off('ended', endedHandler));\n\n const seekingHandler = () => {\n isSeeking = true;\n getIframeMetadata(player, elem, vendor, 'seeking')\n .then((playerState) => {\n handlers.onSeeking(playerState);\n })\n .catch((error) => {\n handlers.onError(`Error getting iframe metadata from 'seeking' handler: ${error as string}`);\n });\n };\n player.on('seeking', seekingHandler);\n onUnsubscribe.push(() => player.off('seeking', seekingHandler));\n\n const seekedHandler = () => {\n isSeeking = false;\n getIframeMetadata(player, elem, vendor)\n .then((playerState) => {\n handlers.onSeeked(playerState);\n })\n .catch((error) => {\n handlers.onError(`Error getting iframe metadata from 'seeked' handler: ${error as string}`);\n });\n };\n player.on('seeked', seekedHandler);\n onUnsubscribe.push(() => player.off('seeked', seekedHandler));\n\n const timeupdateHandler = () => {\n getTimeUpdateInfo(player)\n .then(({ currentTime }) => {\n const timeupdateEvent: TimeUpdateEvent = {\n position: currentTime,\n isSeeking: isSeeking,\n };\n handlers.onTimeUpdate(timeupdateEvent);\n })\n .catch((error) => {\n handlers.onError(`Error getting iframe metadata from 'timeupdate' handler: ${error as string}`);\n });\n };\n player.on('timeupdate', timeupdateHandler);\n onUnsubscribe.push(() => player.off('timeupdate', timeupdateHandler));\n };\n player.on('ready', readyHandler);\n\n return () => {\n player.off('ready', readyHandler);\n onUnsubscribe.forEach((unsubscribe) => unsubscribe());\n };\n}\n"]}
|
|
1
|
+
{"version":3,"file":"track-video.js","sourceRoot":"","sources":["../../../src/video-analytics/track-video.ts"],"names":[],"mappings":";;;;AAWA,SAAS,yBAAyB,CAAC,WAAmB,EAAE,QAAgB;IACtE,IAAI,gBAAgB,GAAG,CAAC,CAAC;IACzB,IAAI,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,QAAQ,GAAG,CAAC,EAAE;QAC7E,IAAM,UAAU,GAAG,CAAC,WAAW,GAAG,QAAQ,CAAC,GAAG,GAAG,CAAC;QAClD,gBAAgB,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC;KAC3D;IACD,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAED,SAAS,YAAY,CAAC,OAAsC,EAAE,UAA4B;IACxF,IAAM,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;IACxC,IAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAClC,0BACE,QAAQ,UAAA,EACR,QAAQ,EAAE,WAAW,EACrB,iBAAiB,EAAE,yBAAyB,CAAC,WAAW,EAAE,QAAQ,CAAC,IAChE,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAChE;AACJ,CAAC;AAED,SAAS,oBAAoB,CAAC,KAAoC;IAChE,IAAI,CAAC,KAAK,EAAE;QACV,OAAO,qBAAqB,CAAC;KAC9B;IACD,OAAO,oCAA6B,KAAK,CAAC,IAAI,cAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,YAAK,KAAK,CAAC,OAAO,CAAE,CAAC,CAAC,CAAC,EAAE,CAAE,CAAC;AAChG,CAAC;AAED,SAAS,kBAAkB,CAAC,OAAsC;IAChE,IAAM,KAAK,GAAG,OAAoC,CAAC;IACnD,OAAO,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,GAAG,IAAI,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;AACzF,CAAC;AAED,SAAS,cAAc,CAAC,OAAmB;IACzC,OAAO;QACL,eAAe,EAAE,OAAO,CAAC,YAAY,CAAC,aAAa,CAAC;QACpD,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC,mBAAmB,CAAC;QACvD,eAAe,EAAE,OAAO,CAAC,YAAY,CAAC,sBAAsB,CAAC;KAC9D,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,cAAc,CAAC,OAAsC,EAAE,QAAsB,EAAE,MAAe;IAC5G,uFAAuF;IACvF,4BAA4B;IAC5B,IAAI,gBAAgB,GAAG,KAAK,CAAC;IAE7B,IAAM,WAAW,GAAG;QAClB,gBAAgB,GAAG,KAAK,CAAC;QACzB,IAAM,UAAU,yCACX,YAAY,CAAC,OAAO,CAAC,GACrB,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CACrD,CAAC;QACF,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAC9B,CAAC,CAAC;IACF,OAAO,CAAC,gBAAgB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAE9C,IAAM,YAAY,GAAG;QACnB,IAAI,gBAAgB,EAAE;YACpB,OAAO;SACR;QACD,gBAAgB,GAAG,IAAI,CAAC;QACxB,IAAM,UAAU,yCACX,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,GAC9B,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CACrD,CAAC;QACF,QAAQ,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC/B,CAAC,CAAC;IACF,OAAO,CAAC,gBAAgB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAEhD,IAAM,YAAY,GAAG;QACnB,IAAK,OAA4B,CAAC,KAAK,KAAK,IAAI,EAAE;YAChD,YAAY,EAAE,CAAC;YACf,OAAO;SACR;QACD,IAAM,UAAU,yCACX,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC,GAC/B,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CACrD,CAAC;QACF,QAAQ,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC/B,CAAC,CAAC;IACF,OAAO,CAAC,gBAAgB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAEhD,IAAM,cAAc,GAAG;QACrB,IAAM,YAAY,yCACb,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,GAChC,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CACrD,CAAC;QACF,QAAQ,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;IACnC,CAAC,CAAC;IACF,OAAO,CAAC,gBAAgB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;IAEpD,IAAM,aAAa,GAAG;QACpB,IAAM,WAAW,yCACZ,YAAY,CAAC,OAAO,CAAC,GACrB,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CACrD,CAAC;QACF,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IACjC,CAAC,CAAC;IACF,OAAO,CAAC,gBAAgB,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;IAElD,IAAM,YAAY,GAAG;QACnB,QAAQ,CAAC,OAAO,CAAC,oBAAoB,CAAE,OAA4B,CAAC,KAAK,CAAC,CAAC,CAAC;IAC9E,CAAC,CAAC;IACF,OAAO,CAAC,gBAAgB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAEhD,IAAI,SAAS,GAAsB,IAAI,CAAC;IACxC,IAAM,iBAAiB,GAAG;QACxB,IAAM,KAAK,GAAG,OAA2B,CAAC;QAE1C,8EAA8E;QAC9E,IAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QAClC,IAAM,cAAc,GAAG,OAAO,QAAQ,KAAK,QAAQ,IAAI,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC9E,IAAM,gBAAgB,GAAG,CAAC,cAAc,IAAI,KAAK,CAAC,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,MAAM,KAAK,KAAK,CAAC;QAC3F,IAAI,gBAAgB,IAAI,SAAS,KAAK,IAAI,IAAI,gBAAgB,EAAE;YAC9D,WAAW,EAAE,CAAC;SACf;QAED,IAAM,eAAe,GAAoB;YACvC,QAAQ,EAAE,OAAO,CAAC,WAAW;YAC7B,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO;SAC3B,CAAC;QACF,QAAQ,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;QAEvC,IAAI,gBAAgB,IAAI,cAAc,EAAE;YACtC,OAAO;SACR;QACD,8EAA8E;QAC9E,IAAI,gBAAgB,IAAI,SAAS,KAAK,IAAI,IAAI,KAAK,CAAC,KAAK,KAAK,IAAI,EAAE;YAClE,gBAAgB,GAAG,KAAK,CAAC;SAC1B;QAED,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;QAClC,IAAI,MAAM,KAAK,KAAK,EAAE;YACpB,SAAS,yCAAQ,SAAS,GAAK,cAAc,CAAC,OAAO,CAAC,CAAE,CAAC;SAC1D;IACH,CAAC,CAAC;IACF,OAAO,CAAC,gBAAgB,CAAC,YAAY,EAAE,iBAAiB,CAAC,CAAC;IAE1D,mFAAmF;IACnF,qFAAqF;IACrF,IAAM,eAAe,GAAG,UAAC,KAAsB;QAC7C,IAAI,SAAS,IAAI,CAAC,gBAAgB,EAAE;YAClC,gBAAgB,GAAG,IAAI,CAAC;YACxB,QAAQ,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;SACpC;QACD,SAAS,GAAG,IAAI,CAAC;IACnB,CAAC,CAAC;IAEF,IAAI,aAAa,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;IAChD,IAAM,gBAAgB,GAAG;QACvB,IAAM,UAAU,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAC/C,IAAI,UAAU,KAAK,aAAa,EAAE;YAChC,aAAa,GAAG,UAAU,CAAC;YAC3B,eAAe,CAAC,iBAAiB,CAAC,CAAC;SACpC;IACH,CAAC,CAAC;IACF,OAAO,CAAC,gBAAgB,CAAC,WAAW,EAAE,gBAAgB,CAAC,CAAC;IAExD,4FAA4F;IAC5F,wFAAwF;IACxF,IAAM,cAAc,GAAG,cAAM,OAAA,eAAe,CAAC,iBAAiB,CAAC,EAAlC,CAAkC,CAAC;IAChE,OAAO,CAAC,gBAAgB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;IACpD,IAAM,KAAK,GAAG,OAA2B,CAAC;IAE1C,0EAA0E;IAC1E,IAAI,KAAK,CAAC,MAAM,KAAK,KAAK,IAAI,KAAK,CAAC,KAAK,KAAK,IAAI,EAAE;QAClD,WAAW,EAAE,CAAC;KACf;IAED,OAAO;QACL,OAAO,CAAC,mBAAmB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;QACjD,OAAO,CAAC,mBAAmB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QACnD,OAAO,CAAC,mBAAmB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QACnD,OAAO,CAAC,mBAAmB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;QACvD,OAAO,CAAC,mBAAmB,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;QACrD,OAAO,CAAC,mBAAmB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QACnD,OAAO,CAAC,mBAAmB,CAAC,YAAY,EAAE,iBAAiB,CAAC,CAAC;QAC7D,OAAO,CAAC,mBAAmB,CAAC,WAAW,EAAE,gBAAgB,CAAC,CAAC;QAC3D,OAAO,CAAC,mBAAmB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;IACzD,CAAC,CAAC;AACJ,CAAC;AA3ID,wCA2IC;AAED,SAAe,iBAAiB,CAAC,MAA2B;;;;;wBACtC,qBAAM,IAAI,OAAO,CAAS,UAAC,OAAO,IAAK,OAAA,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,EAA9B,CAA8B,CAAC,EAAA;;oBAApF,WAAW,GAAG,SAAsE;oBAC1F,sBAAO,EAAE,WAAW,aAAA,EAAE,EAAC;;;;CACxB;AAED,SAAe,iBAAiB,CAC9B,MAA2B,EAC3B,IAAuB,EACvB,MAAqB,EACrB,UAA4B;;;;;wBAEI,qBAAM,OAAO,CAAC,GAAG,CAAC;wBAChD,IAAI,OAAO,CAAS,UAAC,OAAO,IAAK,OAAA,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,EAA3B,CAA2B,CAAC;wBAC7D,IAAI,OAAO,CAAS,UAAC,OAAO,IAAK,OAAA,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,EAA9B,CAA8B,CAAC;qBACjE,CAAC,EAAA;;oBAHI,KAAA,8BAA0B,SAG9B,KAAA,EAHK,QAAQ,QAAA,EAAE,WAAW,QAAA;oBAKtB,cAAc,GAA8C,EAAE,CAAC;oBACrE,IAAI,MAAM,KAAK,KAAK,EAAE;wBAChB,GAAG,SAAA,CAAC;wBACR,IAAI;4BACF,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAW,CAAC,CAAC;4BAClD,cAAc,CAAC,eAAe,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;4BAC9E,cAAc,CAAC,YAAY,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;4BACxE,cAAc,CAAC,eAAe,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;yBAChE;wBAAC,OAAO,KAAK,EAAE;4BACd,kDAAkD;yBACnD;qBACF;oBACD,0DACE,QAAQ,UAAA,EACR,QAAQ,EAAE,WAAW,EACrB,iBAAiB,EAAE,yBAAyB,CAAC,WAAW,EAAE,QAAQ,CAAC,IAChE,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,GAC7D,cAAc,GACjB;;;;CACH;AAED,SAAgB,kBAAkB,CAAC,MAA2B,EAAE,QAAsB,EAAE,MAA4B;IAA5B,uBAAA,EAAA,aAA4B;IAClH,IAAM,aAAa,GAAmB,EAAE,CAAC;IACzC,IAAM,YAAY,GAAG;QACX,IAAA,IAAI,GAAK,MAAM,KAAX,CAAY;QACxB,IAAI,SAAS,GAAG,KAAK,CAAC;QAEtB,IAAM,WAAW,GAAG;YAClB,iBAAiB,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC;iBACpC,IAAI,CAAC,UAAC,WAAW;gBAChB,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;YAC/B,CAAC,CAAC;iBACD,KAAK,CAAC,UAAC,KAAK;gBACX,QAAQ,CAAC,OAAO,CAAC,6DAAsD,KAAe,CAAE,CAAC,CAAC;YAC5F,CAAC,CAAC,CAAC;QACP,CAAC,CAAC;QACF,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;QAC/B,aAAa,CAAC,IAAI,CAAC,cAAM,OAAA,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,EAA/B,CAA+B,CAAC,CAAC;QAE1D,IAAM,YAAY,GAAG;YACnB,iBAAiB,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC;iBAC7C,IAAI,CAAC,UAAC,WAAW;gBAChB,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YAChC,CAAC,CAAC;iBACD,KAAK,CAAC,UAAC,KAAK;gBACX,QAAQ,CAAC,OAAO,CAAC,8DAAuD,KAAe,CAAE,CAAC,CAAC;YAC7F,CAAC,CAAC,CAAC;QACP,CAAC,CAAC;QACF,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QACjC,aAAa,CAAC,IAAI,CAAC,cAAM,OAAA,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,YAAY,CAAC,EAAjC,CAAiC,CAAC,CAAC;QAE5D,IAAM,YAAY,GAAG;YACnB,iBAAiB,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC;iBAC9C,IAAI,CAAC,UAAC,WAAW;gBAChB,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YAChC,CAAC,CAAC;iBACD,KAAK,CAAC,UAAC,KAAK;gBACX,QAAQ,CAAC,OAAO,CAAC,8DAAuD,KAAe,CAAE,CAAC,CAAC;YAC7F,CAAC,CAAC,CAAC;QACP,CAAC,CAAC;QACF,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QACjC,aAAa,CAAC,IAAI,CAAC,cAAM,OAAA,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,YAAY,CAAC,EAAjC,CAAiC,CAAC,CAAC;QAE5D,IAAM,cAAc,GAAG;YACrB,SAAS,GAAG,IAAI,CAAC;YACjB,iBAAiB,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC;iBAC/C,IAAI,CAAC,UAAC,WAAW;gBAChB,QAAQ,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;YAClC,CAAC,CAAC;iBACD,KAAK,CAAC,UAAC,KAAK;gBACX,QAAQ,CAAC,OAAO,CAAC,gEAAyD,KAAe,CAAE,CAAC,CAAC;YAC/F,CAAC,CAAC,CAAC;QACP,CAAC,CAAC;QACF,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;QACrC,aAAa,CAAC,IAAI,CAAC,cAAM,OAAA,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,cAAc,CAAC,EAArC,CAAqC,CAAC,CAAC;QAEhE,IAAM,aAAa,GAAG;YACpB,SAAS,GAAG,KAAK,CAAC;YAClB,iBAAiB,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC;iBACpC,IAAI,CAAC,UAAC,WAAW;gBAChB,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;YACjC,CAAC,CAAC;iBACD,KAAK,CAAC,UAAC,KAAK;gBACX,QAAQ,CAAC,OAAO,CAAC,+DAAwD,KAAe,CAAE,CAAC,CAAC;YAC9F,CAAC,CAAC,CAAC;QACP,CAAC,CAAC;QACF,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;QACnC,aAAa,CAAC,IAAI,CAAC,cAAM,OAAA,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,aAAa,CAAC,EAAnC,CAAmC,CAAC,CAAC;QAE9D,IAAM,iBAAiB,GAAG;YACxB,iBAAiB,CAAC,MAAM,CAAC;iBACtB,IAAI,CAAC,UAAC,EAAe;oBAAb,WAAW,iBAAA;gBAClB,IAAM,eAAe,GAAoB;oBACvC,QAAQ,EAAE,WAAW;oBACrB,SAAS,EAAE,SAAS;iBACrB,CAAC;gBACF,QAAQ,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;YACzC,CAAC,CAAC;iBACD,KAAK,CAAC,UAAC,KAAK;gBACX,QAAQ,CAAC,OAAO,CAAC,mEAA4D,KAAe,CAAE,CAAC,CAAC;YAClG,CAAC,CAAC,CAAC;QACP,CAAC,CAAC;QACF,MAAM,CAAC,EAAE,CAAC,YAAY,EAAE,iBAAiB,CAAC,CAAC;QAC3C,aAAa,CAAC,IAAI,CAAC,cAAM,OAAA,MAAM,CAAC,GAAG,CAAC,YAAY,EAAE,iBAAiB,CAAC,EAA3C,CAA2C,CAAC,CAAC;QAEtE,2EAA2E;QAC3E,IAAI,MAAM,CAAC,SAAS,EAAE;YACpB,IAAI;gBACF,MAAM,CAAC,SAAS,CAAC,UAAC,MAAM;oBACtB,IAAI,MAAM,KAAK,KAAK,EAAE;wBACpB,WAAW,EAAE,CAAC;qBACf;gBACH,CAAC,CAAC,CAAC;aACJ;YAAC,OAAO,KAAK,EAAE;gBACd,QAAQ,CAAC,OAAO,CAAC,2DAAoD,KAAe,CAAE,CAAC,CAAC;aACzF;SACF;IACH,CAAC,CAAC;IACF,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAEjC,OAAO;QACL,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QAClC,aAAa,CAAC,OAAO,CAAC,UAAC,WAAW,IAAK,OAAA,WAAW,EAAE,EAAb,CAAa,CAAC,CAAC;IACxD,CAAC,CAAC;AACJ,CAAC;AAvGD,gDAuGC","sourcesContent":["import {\n VideoHandler,\n VideoEvent,\n EmbeddedVideoPlayer,\n MuxElement,\n Vendor,\n VideoStopReason,\n TimeUpdateEvent,\n VideoStopCause,\n} from './types';\n\nfunction calculatePercentCompleted(currentTime: number, duration: number) {\n let percentCompleted = 0;\n if (Number.isFinite(currentTime) && Number.isFinite(duration) && duration > 0) {\n const rawPercent = (currentTime / duration) * 100;\n percentCompleted = Math.min(100, Math.max(0, rawPercent));\n }\n return percentCompleted;\n}\n\nfunction getVideoData(videoEl: HTMLMediaElement | MuxElement, stopReason?: VideoStopReason) {\n const currentTime = videoEl.currentTime;\n const duration = videoEl.duration;\n return {\n duration,\n position: currentTime,\n percent_completed: calculatePercentCompleted(currentTime, duration),\n ...(stopReason !== undefined ? { stop_reason: stopReason } : {}),\n };\n}\n\nfunction getMediaErrorMessage(error: MediaError | null | undefined) {\n if (!error) {\n return 'Media element error';\n }\n return `Media element error (code ${error.code})${error.message ? `: ${error.message}` : ''}`;\n}\n\nfunction getEffectiveSource(videoEl: HTMLMediaElement | MuxElement): MediaProvider | string | null {\n const media = videoEl as Partial<HTMLMediaElement>;\n return media.srcObject || media.currentSrc || media.src || videoEl.getAttribute('src');\n}\n\nfunction getMuxMetadata(videoEl: MuxElement) {\n return {\n mux_playback_id: videoEl.getAttribute('playback-id'),\n mux_video_id: videoEl.getAttribute('metadata-video-id'),\n mux_video_title: videoEl.getAttribute('metadata-video-title'),\n };\n}\n\n/**\n * Track a standard HTML video element.\n *\n * @param videoEl - The HTML video element to track.\n * @param handlers - The video handlers to call when on video lifecycle events.\n * @returns A function to untrack the video.\n */\nexport function trackHtmlVideo(videoEl: HTMLMediaElement | MuxElement, handlers: VideoHandler, vendor?: Vendor) {\n // reaching the end of the media fires `pause` right before `ended`, so end of media is\n // reported once, as `ended`\n let hasReportedEnded = false;\n\n const playHandler = () => {\n hasReportedEnded = false;\n const startEvent: VideoEvent = {\n ...getVideoData(videoEl),\n ...(vendor === 'mux' ? getMuxMetadata(videoEl) : {}),\n };\n handlers.onPlay(startEvent);\n };\n videoEl.addEventListener('play', playHandler);\n\n const endedHandler = () => {\n if (hasReportedEnded) {\n return;\n }\n hasReportedEnded = true;\n const endedEvent: VideoEvent = {\n ...getVideoData(videoEl, 'ended'),\n ...(vendor === 'mux' ? getMuxMetadata(videoEl) : {}),\n };\n handlers.onEnded(endedEvent);\n };\n videoEl.addEventListener('ended', endedHandler);\n\n const pauseHandler = () => {\n if ((videoEl as HTMLMediaElement).ended === true) {\n endedHandler();\n return;\n }\n const pauseEvent: VideoEvent = {\n ...getVideoData(videoEl, 'paused'),\n ...(vendor === 'mux' ? getMuxMetadata(videoEl) : {}),\n };\n handlers.onPause(pauseEvent);\n };\n videoEl.addEventListener('pause', pauseHandler);\n\n const seekingHandler = () => {\n const seekingEvent: VideoEvent = {\n ...getVideoData(videoEl, 'seeking'),\n ...(vendor === 'mux' ? getMuxMetadata(videoEl) : {}),\n };\n handlers.onSeeking(seekingEvent);\n };\n videoEl.addEventListener('seeking', seekingHandler);\n\n const seekedHandler = () => {\n const seekedEvent: VideoEvent = {\n ...getVideoData(videoEl),\n ...(vendor === 'mux' ? getMuxMetadata(videoEl) : {}),\n };\n handlers.onSeeked(seekedEvent);\n };\n videoEl.addEventListener('seeked', seekedHandler);\n\n const errorHandler = () => {\n handlers.onError(getMediaErrorMessage((videoEl as HTMLMediaElement).error));\n };\n videoEl.addEventListener('error', errorHandler);\n\n let videoData: VideoEvent | null = null;\n const timeupdateHandler = () => {\n const media = videoEl as HTMLMediaElement;\n\n // if the video is playing again after being previously ended, resume playback\n const duration = videoEl.duration;\n const isUnloadedTick = typeof duration !== 'number' || Number.isNaN(duration);\n const isPlayheadMoving = !isUnloadedTick && media.ended !== true && media.paused === false;\n if (hasReportedEnded && videoData === null && isPlayheadMoving) {\n playHandler();\n }\n\n const timeupdateEvent: TimeUpdateEvent = {\n position: videoEl.currentTime,\n isSeeking: !!media.seeking,\n };\n handlers.onTimeUpdate(timeupdateEvent);\n\n if (hasReportedEnded && isUnloadedTick) {\n return;\n }\n // if a new video is loaded in place of the previous one, reset the ended flag\n if (hasReportedEnded && videoData === null && media.ended !== true) {\n hasReportedEnded = false;\n }\n\n videoData = getVideoData(videoEl);\n if (vendor === 'mux') {\n videoData = { ...videoData, ...getMuxMetadata(videoEl) };\n }\n };\n videoEl.addEventListener('timeupdate', timeupdateHandler);\n\n // report the media that was playing before a source change as over, using the last\n // timeupdate because the element has already been reset by the time we hear about it\n const endCurrentMedia = (cause?: VideoStopCause) => {\n if (videoData && !hasReportedEnded) {\n hasReportedEnded = true;\n handlers.onEnded(videoData, cause);\n }\n videoData = null;\n };\n\n let currentSource = getEffectiveSource(videoEl);\n const loadStartHandler = () => {\n const nextSource = getEffectiveSource(videoEl);\n if (nextSource !== currentSource) {\n currentSource = nextSource;\n endCurrentMedia('content_changed');\n }\n };\n videoEl.addEventListener('loadstart', loadStartHandler);\n\n // `emptied` fires whenever loaded media is torn down, which also covers swaps that keep the\n // same URL (e.g. hls.js re-attaching a MediaSource), `srcObject` and `<source>` changes\n const emptiedHandler = () => endCurrentMedia('content_changed');\n videoEl.addEventListener('emptied', emptiedHandler);\n const media = videoEl as HTMLMediaElement;\n\n // if the media is already playing when tracking begins, emit a play event\n if (media.paused === false && media.ended !== true) {\n playHandler();\n }\n\n return () => {\n videoEl.removeEventListener('play', playHandler);\n videoEl.removeEventListener('ended', endedHandler);\n videoEl.removeEventListener('pause', pauseHandler);\n videoEl.removeEventListener('seeking', seekingHandler);\n videoEl.removeEventListener('seeked', seekedHandler);\n videoEl.removeEventListener('error', errorHandler);\n videoEl.removeEventListener('timeupdate', timeupdateHandler);\n videoEl.removeEventListener('loadstart', loadStartHandler);\n videoEl.removeEventListener('emptied', emptiedHandler);\n };\n}\n\nasync function getTimeUpdateInfo(player: EmbeddedVideoPlayer) {\n const currentTime = await new Promise<number>((resolve) => player.getCurrentTime(resolve));\n return { currentTime };\n}\n\nasync function getIframeMetadata(\n player: EmbeddedVideoPlayer,\n elem: HTMLIFrameElement,\n vendor: Vendor | null,\n stopReason?: VideoStopReason,\n) {\n const [duration, currentTime] = await Promise.all([\n new Promise<number>((resolve) => player.getDuration(resolve)),\n new Promise<number>((resolve) => player.getCurrentTime(resolve)),\n ]);\n\n const vendorMetadata: Record<string, string | null | undefined> = {};\n if (vendor === 'mux') {\n let url;\n try {\n url = new URL(elem.getAttribute('src') as string);\n vendorMetadata.mux_video_title = url.searchParams.get('metadata-video-title');\n vendorMetadata.mux_video_id = url.searchParams.get('metadata-video-id');\n vendorMetadata.mux_playback_id = url.pathname.split('/').pop();\n } catch (error) {\n // invalid or no src url, skip the header metadata\n }\n }\n return {\n duration,\n position: currentTime,\n percent_completed: calculatePercentCompleted(currentTime, duration),\n ...(stopReason !== undefined ? { stop_reason: stopReason } : {}),\n ...vendorMetadata,\n };\n}\n\nexport function trackEmbeddedVideo(player: EmbeddedVideoPlayer, handlers: VideoHandler, vendor: Vendor | null = null) {\n const onUnsubscribe: (() => void)[] = [];\n const readyHandler = () => {\n const { elem } = player;\n let isSeeking = false;\n\n const playHandler = () => {\n getIframeMetadata(player, elem, vendor)\n .then((playerState) => {\n handlers.onPlay(playerState);\n })\n .catch((error) => {\n handlers.onError(`Error getting iframe metadata from 'play' handler: ${error as string}`);\n });\n };\n player.on('play', playHandler);\n onUnsubscribe.push(() => player.off('play', playHandler));\n\n const endedHandler = () => {\n getIframeMetadata(player, elem, vendor, 'ended')\n .then((playerState) => {\n handlers.onEnded(playerState);\n })\n .catch((error) => {\n handlers.onError(`Error getting iframe metadata from 'ended' handler: ${error as string}`);\n });\n };\n player.on('ended', endedHandler);\n onUnsubscribe.push(() => player.off('ended', endedHandler));\n\n const pauseHandler = () => {\n getIframeMetadata(player, elem, vendor, 'paused')\n .then((playerState) => {\n handlers.onPause(playerState);\n })\n .catch((error) => {\n handlers.onError(`Error getting iframe metadata from 'pause' handler: ${error as string}`);\n });\n };\n player.on('pause', pauseHandler);\n onUnsubscribe.push(() => player.off('pause', pauseHandler));\n\n const seekingHandler = () => {\n isSeeking = true;\n getIframeMetadata(player, elem, vendor, 'seeking')\n .then((playerState) => {\n handlers.onSeeking(playerState);\n })\n .catch((error) => {\n handlers.onError(`Error getting iframe metadata from 'seeking' handler: ${error as string}`);\n });\n };\n player.on('seeking', seekingHandler);\n onUnsubscribe.push(() => player.off('seeking', seekingHandler));\n\n const seekedHandler = () => {\n isSeeking = false;\n getIframeMetadata(player, elem, vendor)\n .then((playerState) => {\n handlers.onSeeked(playerState);\n })\n .catch((error) => {\n handlers.onError(`Error getting iframe metadata from 'seeked' handler: ${error as string}`);\n });\n };\n player.on('seeked', seekedHandler);\n onUnsubscribe.push(() => player.off('seeked', seekedHandler));\n\n const timeupdateHandler = () => {\n getTimeUpdateInfo(player)\n .then(({ currentTime }) => {\n const timeupdateEvent: TimeUpdateEvent = {\n position: currentTime,\n isSeeking: isSeeking,\n };\n handlers.onTimeUpdate(timeupdateEvent);\n })\n .catch((error) => {\n handlers.onError(`Error getting iframe metadata from 'timeupdate' handler: ${error as string}`);\n });\n };\n player.on('timeupdate', timeupdateHandler);\n onUnsubscribe.push(() => player.off('timeupdate', timeupdateHandler));\n\n // if the player is already playing when tracking begins, emit a play event\n if (player.getPaused) {\n try {\n player.getPaused((paused) => {\n if (paused === false) {\n playHandler();\n }\n });\n } catch (error) {\n handlers.onError(`Error getting paused state from 'ready' handler: ${error as string}`);\n }\n }\n };\n player.on('ready', readyHandler);\n\n return () => {\n player.off('ready', readyHandler);\n onUnsubscribe.forEach((unsubscribe) => unsubscribe());\n };\n}\n"]}
|
|
@@ -1,28 +1,28 @@
|
|
|
1
1
|
export type Vendor = 'mux';
|
|
2
2
|
export type VideoStopReason = 'paused' | 'ended' | 'seeking';
|
|
3
|
+
export type VideoStopCause = 'timeout' | 'paused' | 'ended' | 'error' | 'untracked' | 'content_changed';
|
|
3
4
|
export type VideoHandler = {
|
|
4
5
|
onPlay: (startEvent: VideoEvent) => void;
|
|
5
6
|
onPause: (pauseEvent: VideoEvent) => void;
|
|
6
|
-
onEnded: (endedEvent: VideoEvent) => void;
|
|
7
|
+
onEnded: (endedEvent: VideoEvent, cause?: VideoStopCause) => void;
|
|
7
8
|
onSeeking: (seekingEvent: VideoEvent) => void;
|
|
8
9
|
onSeeked: (seekedEvent: VideoEvent) => void;
|
|
9
10
|
onError: (error: string) => void;
|
|
10
11
|
onTimeUpdate: (timeUpdateEvent: TimeUpdateEvent) => void;
|
|
11
12
|
};
|
|
12
13
|
export type VideoEvent = {
|
|
13
|
-
duration: number;
|
|
14
|
-
start_time?: number;
|
|
14
|
+
duration: number | undefined;
|
|
15
15
|
playback_id?: string | undefined;
|
|
16
16
|
video_id?: string | undefined;
|
|
17
17
|
video_title?: string | undefined;
|
|
18
18
|
content_id?: string | undefined;
|
|
19
|
-
|
|
19
|
+
media_type?: string | undefined;
|
|
20
20
|
session_id?: string | undefined;
|
|
21
21
|
mux_playback_id?: string | undefined | null;
|
|
22
22
|
mux_video_id?: string | undefined | null;
|
|
23
23
|
mux_video_title?: string | undefined | null;
|
|
24
24
|
mux_session_id?: string | undefined | null;
|
|
25
|
-
|
|
25
|
+
position: number | undefined | null;
|
|
26
26
|
percent_completed?: number;
|
|
27
27
|
stop_reason?: VideoStopReason;
|
|
28
28
|
};
|
|
@@ -33,6 +33,7 @@ export type TimeUpdateEvent = {
|
|
|
33
33
|
type EmbeddedVideoPlayer = {
|
|
34
34
|
getCurrentTime: (cb: (time: number) => void) => void;
|
|
35
35
|
getDuration: (cb: (duration: number) => void) => void;
|
|
36
|
+
getPaused?: (cb: (paused: boolean) => void) => void;
|
|
36
37
|
on: (event: string, callback: () => void) => void;
|
|
37
38
|
off: (event: string, callback: () => void) => void;
|
|
38
39
|
elem: HTMLIFrameElement;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/video-analytics/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,MAAM,GAAG,KAAK,CAAC;AAE3B,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAC;AAE7D,MAAM,MAAM,YAAY,GAAG;IACzB,MAAM,EAAE,CAAC,UAAU,EAAE,UAAU,KAAK,IAAI,CAAC;IACzC,OAAO,EAAE,CAAC,UAAU,EAAE,UAAU,KAAK,IAAI,CAAC;IAC1C,OAAO,EAAE,CAAC,UAAU,EAAE,UAAU,KAAK,IAAI,CAAC;
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/video-analytics/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,MAAM,GAAG,KAAK,CAAC;AAE3B,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAC;AAE7D,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,WAAW,GAAG,iBAAiB,CAAC;AAExG,MAAM,MAAM,YAAY,GAAG;IACzB,MAAM,EAAE,CAAC,UAAU,EAAE,UAAU,KAAK,IAAI,CAAC;IACzC,OAAO,EAAE,CAAC,UAAU,EAAE,UAAU,KAAK,IAAI,CAAC;IAC1C,OAAO,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,KAAK,CAAC,EAAE,cAAc,KAAK,IAAI,CAAC;IAClE,SAAS,EAAE,CAAC,YAAY,EAAE,UAAU,KAAK,IAAI,CAAC;IAC9C,QAAQ,EAAE,CAAC,WAAW,EAAE,UAAU,KAAK,IAAI,CAAC;IAC5C,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACjC,YAAY,EAAE,CAAC,eAAe,EAAE,eAAe,KAAK,IAAI,CAAC;CAC1D,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;IAC5C,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;IACzC,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;IAC5C,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;IAC3C,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;IACpC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,KAAK,mBAAmB,GAAG;IACzB,cAAc,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,KAAK,IAAI,CAAC;IACrD,WAAW,EAAE,CAAC,EAAE,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,KAAK,IAAI,CAAC;IACtD,SAAS,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,KAAK,IAAI,CAAC;IACpD,EAAE,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,IAAI,KAAK,IAAI,CAAC;IAClD,GAAG,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,IAAI,KAAK,IAAI,CAAC;IACnD,IAAI,EAAE,iBAAiB,CAAC;CACzB,CAAC;AAEF,KAAK,UAAU,GAAG,WAAW,GAC3B,OAAO,GAAG;IACR,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;IAC9B,KAAK,CAAC,EAAE,MAAM,IAAI,CAAC;CACpB,CAAC;AAEJ,OAAO,EAAE,UAAU,EAAE,mBAAmB,EAAE,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/video-analytics/types.ts"],"names":[],"mappings":"","sourcesContent":["export type Vendor = 'mux'; // | 'vimeo' | 'youtube' | 'other'\n\nexport type VideoStopReason = 'paused' | 'ended' | 'seeking';\n\nexport type VideoHandler = {\n onPlay: (startEvent: VideoEvent) => void;\n onPause: (pauseEvent: VideoEvent) => void;\n onEnded: (endedEvent: VideoEvent) => void;\n onSeeking: (seekingEvent: VideoEvent) => void;\n onSeeked: (seekedEvent: VideoEvent) => void;\n onError: (error: string) => void;\n onTimeUpdate: (timeUpdateEvent: TimeUpdateEvent) => void;\n};\n\nexport type VideoEvent = {\n duration: number
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/video-analytics/types.ts"],"names":[],"mappings":"","sourcesContent":["export type Vendor = 'mux'; // | 'vimeo' | 'youtube' | 'other'\n\nexport type VideoStopReason = 'paused' | 'ended' | 'seeking';\n\nexport type VideoStopCause = 'timeout' | 'paused' | 'ended' | 'error' | 'untracked' | 'content_changed';\n\nexport type VideoHandler = {\n onPlay: (startEvent: VideoEvent) => void;\n onPause: (pauseEvent: VideoEvent) => void;\n onEnded: (endedEvent: VideoEvent, cause?: VideoStopCause) => void;\n onSeeking: (seekingEvent: VideoEvent) => void;\n onSeeked: (seekedEvent: VideoEvent) => void;\n onError: (error: string) => void;\n onTimeUpdate: (timeUpdateEvent: TimeUpdateEvent) => void;\n};\n\nexport type VideoEvent = {\n duration: number | undefined;\n playback_id?: string | undefined;\n video_id?: string | undefined;\n video_title?: string | undefined;\n content_id?: string | undefined;\n media_type?: string | undefined;\n session_id?: string | undefined;\n mux_playback_id?: string | undefined | null;\n mux_video_id?: string | undefined | null;\n mux_video_title?: string | undefined | null;\n mux_session_id?: string | undefined | null;\n position: number | undefined | null;\n percent_completed?: number;\n stop_reason?: VideoStopReason;\n};\n\nexport type TimeUpdateEvent = {\n position: number;\n isSeeking: boolean;\n};\n\ntype EmbeddedVideoPlayer = {\n getCurrentTime: (cb: (time: number) => void) => void;\n getDuration: (cb: (duration: number) => void) => void;\n getPaused?: (cb: (paused: boolean) => void) => void;\n on: (event: string, callback: () => void) => void;\n off: (event: string, callback: () => void) => void;\n elem: HTMLIFrameElement;\n};\n\ntype MuxElement = EventTarget &\n Element & {\n seeking: boolean;\n duration: number;\n currentTime: number;\n play?: () => Promise<unknown>;\n pause?: () => void;\n };\n\nexport { MuxElement, EmbeddedVideoPlayer };\n"]}
|
package/lib/esm/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/esm/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/esm/config.js
CHANGED
|
@@ -33,6 +33,7 @@ var Config = /** @class */ (function () {
|
|
|
33
33
|
this.offline = options.offline !== undefined ? options.offline : defaultConfig.offline;
|
|
34
34
|
this.optOut = (_c = options.optOut) !== null && _c !== void 0 ? _c : defaultConfig.optOut;
|
|
35
35
|
this.serverUrl = options.serverUrl;
|
|
36
|
+
this.delayedEventsServerUrl = options.delayedEventsServerUrl;
|
|
36
37
|
this.serverZone = options.serverZone || defaultConfig.serverZone;
|
|
37
38
|
this.storageProvider = options.storageProvider;
|
|
38
39
|
this.transportProvider = options.transportProvider;
|
package/lib/esm/config.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":"AAOA,OAAO,EACL,oBAAoB,EACpB,0BAA0B,EAC1B,uBAAuB,EACvB,6BAA6B,EAC7B,qBAAqB,GACtB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,MAAM,EAAW,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAE9D,MAAM,CAAC,IAAM,gBAAgB,GAAG,cAAM,OAAA,CAAC;IACrC,eAAe,EAAE,EAAE;IACnB,cAAc,EAAE,GAAG;IACnB,mBAAmB,EAAE,KAAK;IAC1B,YAAY,EAAE,qBAAqB;IACnC,QAAQ,EAAE,QAAQ,CAAC,IAAI;IACvB,cAAc,EAAE,IAAI,MAAM,EAAE;IAC5B,OAAO,EAAE,KAAK;IACd,MAAM,EAAE,KAAK;IACb,SAAS,EAAE,oBAAoB;IAC/B,UAAU,EAAE,IAAsB;IAClC,QAAQ,EAAE,KAAK;CAChB,CAAC,EAZoC,CAYpC,CAAC;AACH;
|
|
1
|
+
{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":"AAOA,OAAO,EACL,oBAAoB,EACpB,0BAA0B,EAC1B,uBAAuB,EACvB,6BAA6B,EAC7B,qBAAqB,GACtB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,MAAM,EAAW,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAE9D,MAAM,CAAC,IAAM,gBAAgB,GAAG,cAAM,OAAA,CAAC;IACrC,eAAe,EAAE,EAAE;IACnB,cAAc,EAAE,GAAG;IACnB,mBAAmB,EAAE,KAAK;IAC1B,YAAY,EAAE,qBAAqB;IACnC,QAAQ,EAAE,QAAQ,CAAC,IAAI;IACvB,cAAc,EAAE,IAAI,MAAM,EAAE;IAC5B,OAAO,EAAE,KAAK;IACd,MAAM,EAAE,KAAK;IACb,SAAS,EAAE,oBAAoB;IAC/B,UAAU,EAAE,IAAsB;IAClC,QAAQ,EAAE,KAAK;CAChB,CAAC,EAZoC,CAYpC,CAAC;AACH;IA4BE,gBAAY,OAAsB;;QARxB,YAAO,GAAG,KAAK,CAAC;QASxB,IAAM,aAAa,GAAG,gBAAgB,EAAE,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,qBAAqB,CAAC,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,kBAAkB,CAAC,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;;AAED,MAAM,CAAC,IAAM,YAAY,GAAG,UAAC,UAA0B,EAAE,QAAiB;IACxE,IAAI,UAAU,KAAK,IAAI,EAAE;QACvB,OAAO,QAAQ,CAAC,CAAC,CAAC,6BAA6B,CAAC,CAAC,CAAC,uBAAuB,CAAC;KAC3E;IACD,OAAO,QAAQ,CAAC,CAAC,CAAC,0BAA0B,CAAC,CAAC,CAAC,oBAAoB,CAAC;AACtE,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,kBAAkB,GAAG,UAChC,SAAc,EACd,UAA0D,EAC1D,QAA+C;IAF/C,0BAAA,EAAA,cAAc;IACd,2BAAA,EAAA,aAA6B,gBAAgB,EAAE,CAAC,UAAU;IAC1D,yBAAA,EAAA,WAAoB,gBAAgB,EAAE,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,gBAAgB,EAAE,CAAC,UAAU,CAAC;IACnG,OAAO;QACL,UAAU,EAAE,WAAW;QACvB,SAAS,EAAE,YAAY,CAAC,WAAW,EAAE,QAAQ,CAAC;KAC/C,CAAC;AACJ,CAAC,CAAC;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;;AAED;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"]}
|
package/lib/esm/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/esm/heartbeat.js
CHANGED
|
@@ -1,25 +1,33 @@
|
|
|
1
1
|
import { __assign, __awaiter, __generator, __read, __rest, __spreadArray, __values } from "tslib";
|
|
2
|
+
import { getGlobalScope } from './global-scope';
|
|
2
3
|
import { UUID } from './utils/uuid';
|
|
3
4
|
var EVENTS_SIZE_LIMIT = 4 * 10000; // 4KB
|
|
4
5
|
var Heartbeat = /** @class */ (function () {
|
|
5
|
-
function Heartbeat(client, pulse, delayTimeout, logger) {
|
|
6
|
+
function Heartbeat(client, pulse, delayTimeout, logger, options) {
|
|
7
|
+
if (options === void 0) { options = {}; }
|
|
6
8
|
this.client = client;
|
|
7
9
|
this.pulse = pulse;
|
|
8
10
|
this.delayTimeout = delayTimeout;
|
|
9
11
|
this.logger = logger;
|
|
12
|
+
this.options = options;
|
|
10
13
|
this.interval = null;
|
|
11
14
|
this.resetPromise = null;
|
|
15
|
+
this.unsubscribeFunctions = [];
|
|
16
|
+
this.pageHidePreparers = [];
|
|
12
17
|
this.events = new Map();
|
|
13
18
|
this.delayId = UUID();
|
|
14
19
|
}
|
|
15
|
-
Heartbeat.prototype.heartbeat = function () {
|
|
20
|
+
Heartbeat.prototype.heartbeat = function (flushClient) {
|
|
21
|
+
var _a, _b;
|
|
22
|
+
if (flushClient === void 0) { flushClient = false; }
|
|
16
23
|
return __awaiter(this, void 0, void 0, function () {
|
|
17
|
-
var trackedEvents, _loop_1, this_1,
|
|
18
|
-
var e_1,
|
|
24
|
+
var trackedEvents, _loop_1, this_1, _c, _d, event_1, res;
|
|
25
|
+
var e_1, _e;
|
|
19
26
|
var _this = this;
|
|
20
|
-
return __generator(this, function (
|
|
21
|
-
switch (
|
|
27
|
+
return __generator(this, function (_f) {
|
|
28
|
+
switch (_f.label) {
|
|
22
29
|
case 0:
|
|
30
|
+
(_b = (_a = this.options).beforeHeartbeat) === null || _b === void 0 ? void 0 : _b.call(_a);
|
|
23
31
|
// stop sending heartbeats if no events are queued
|
|
24
32
|
if (this.events.size === 0) {
|
|
25
33
|
this.stop();
|
|
@@ -39,26 +47,32 @@ var Heartbeat = /** @class */ (function () {
|
|
|
39
47
|
};
|
|
40
48
|
this_1 = this;
|
|
41
49
|
try {
|
|
42
|
-
for (
|
|
43
|
-
event_1 =
|
|
50
|
+
for (_c = __values(this.events.values()), _d = _c.next(); !_d.done; _d = _c.next()) {
|
|
51
|
+
event_1 = _d.value;
|
|
44
52
|
_loop_1(event_1);
|
|
45
53
|
}
|
|
46
54
|
}
|
|
47
55
|
catch (e_1_1) { e_1 = { error: e_1_1 }; }
|
|
48
56
|
finally {
|
|
49
57
|
try {
|
|
50
|
-
if (
|
|
58
|
+
if (_d && !_d.done && (_e = _c.return)) _e.call(_c);
|
|
51
59
|
}
|
|
52
60
|
finally { if (e_1) throw e_1.error; }
|
|
53
61
|
}
|
|
54
62
|
return [4 /*yield*/, Promise.all(trackedEvents)];
|
|
55
|
-
case 1:
|
|
63
|
+
case 1:
|
|
64
|
+
res = _f.sent();
|
|
65
|
+
if (flushClient) {
|
|
66
|
+
this.client.flush();
|
|
67
|
+
}
|
|
68
|
+
return [2 /*return*/, res];
|
|
56
69
|
}
|
|
57
70
|
});
|
|
58
71
|
});
|
|
59
72
|
};
|
|
60
73
|
Heartbeat.prototype.resetHeartbeat = function () {
|
|
61
74
|
return __awaiter(this, void 0, void 0, function () {
|
|
75
|
+
var resetPromise;
|
|
62
76
|
var _this = this;
|
|
63
77
|
return __generator(this, function (_a) {
|
|
64
78
|
switch (_a.label) {
|
|
@@ -67,23 +81,70 @@ var Heartbeat = /** @class */ (function () {
|
|
|
67
81
|
return [4 /*yield*/, this.resetPromise];
|
|
68
82
|
case 1: return [2 /*return*/, _a.sent()];
|
|
69
83
|
case 2:
|
|
84
|
+
if (this.options.sendOnPageLifecycle !== false)
|
|
85
|
+
this.setupPageLifecycleListeners();
|
|
70
86
|
// reset the heartbeat interval
|
|
71
87
|
if (this.interval)
|
|
72
88
|
clearInterval(this.interval);
|
|
73
89
|
this.interval = setInterval(function () { return void _this.heartbeat(); }, this.pulse);
|
|
74
|
-
|
|
75
|
-
this.resetPromise = new Promise(function (resolve) {
|
|
90
|
+
resetPromise = new Promise(function (resolve) {
|
|
76
91
|
setTimeout(function () {
|
|
92
|
+
_this.resetPromise = null;
|
|
77
93
|
resolve(_this.heartbeat());
|
|
78
94
|
}, 0);
|
|
79
95
|
});
|
|
80
|
-
this.resetPromise
|
|
81
|
-
return [4 /*yield*/,
|
|
96
|
+
this.resetPromise = resetPromise;
|
|
97
|
+
return [4 /*yield*/, resetPromise];
|
|
82
98
|
case 3: return [2 /*return*/, _a.sent()];
|
|
83
99
|
}
|
|
84
100
|
});
|
|
85
101
|
});
|
|
86
102
|
};
|
|
103
|
+
Heartbeat.prototype.setupPageLifecycleListeners = function () {
|
|
104
|
+
var _this = this;
|
|
105
|
+
if (this.unsubscribeFunctions.length > 0) {
|
|
106
|
+
return;
|
|
107
|
+
}
|
|
108
|
+
// only browser-like environments expose page lifecycle events
|
|
109
|
+
var win = getGlobalScope();
|
|
110
|
+
if (!win || typeof win.addEventListener !== 'function' || !win.document) {
|
|
111
|
+
return;
|
|
112
|
+
}
|
|
113
|
+
var doc = win.document;
|
|
114
|
+
// When the user leaves the page, send the latest events and flush them immediately.
|
|
115
|
+
// Preparers update queued events (for example stop_reason) before this snapshot.
|
|
116
|
+
var onPageHide = function (evt) {
|
|
117
|
+
var e_2, _a;
|
|
118
|
+
if (!evt.persisted) {
|
|
119
|
+
try {
|
|
120
|
+
for (var _b = __values(__spreadArray([], __read(_this.pageHidePreparers), false)), _c = _b.next(); !_c.done; _c = _b.next()) {
|
|
121
|
+
var prepare = _c.value;
|
|
122
|
+
prepare();
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
catch (e_2_1) { e_2 = { error: e_2_1 }; }
|
|
126
|
+
finally {
|
|
127
|
+
try {
|
|
128
|
+
if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
|
|
129
|
+
}
|
|
130
|
+
finally { if (e_2) throw e_2.error; }
|
|
131
|
+
}
|
|
132
|
+
void _this.heartbeat(true);
|
|
133
|
+
}
|
|
134
|
+
};
|
|
135
|
+
// when the tab becomes hidden, reset the heartbeat so the latest events are sent
|
|
136
|
+
var onVisibilityChange = function () {
|
|
137
|
+
if (doc.visibilityState === 'hidden') {
|
|
138
|
+
void _this.resetHeartbeat();
|
|
139
|
+
}
|
|
140
|
+
};
|
|
141
|
+
win.addEventListener('pagehide', onPageHide);
|
|
142
|
+
doc.addEventListener('visibilitychange', onVisibilityChange);
|
|
143
|
+
this.unsubscribeFunctions.push(function () {
|
|
144
|
+
win.removeEventListener('pagehide', onPageHide);
|
|
145
|
+
doc.removeEventListener('visibilitychange', onVisibilityChange);
|
|
146
|
+
});
|
|
147
|
+
};
|
|
87
148
|
/**
|
|
88
149
|
* An instant event is one that has no delay and gets ingested immediately
|
|
89
150
|
* @param event
|
|
@@ -104,6 +165,13 @@ var Heartbeat = /** @class */ (function () {
|
|
|
104
165
|
}
|
|
105
166
|
return true;
|
|
106
167
|
};
|
|
168
|
+
/** Admit an event synchronously without starting timers or waiting for delivery. */
|
|
169
|
+
Heartbeat.prototype.enqueue = function (event) {
|
|
170
|
+
if (!event.insert_id)
|
|
171
|
+
return false;
|
|
172
|
+
this.events.set(event.insert_id, __assign(__assign({}, event), { delay: event.delay || { id: this.delayId, timeout: this.delayTimeout } }));
|
|
173
|
+
return this.checkEventSizeLimit(event);
|
|
174
|
+
};
|
|
107
175
|
Heartbeat.prototype.track = function (event) {
|
|
108
176
|
return __awaiter(this, void 0, void 0, function () {
|
|
109
177
|
var heartbeatResult;
|
|
@@ -113,8 +181,7 @@ var Heartbeat = /** @class */ (function () {
|
|
|
113
181
|
if (!event.insert_id) {
|
|
114
182
|
return [2 /*return*/, new Error('insert_id is required on events tracked with heartbeat')];
|
|
115
183
|
}
|
|
116
|
-
this.
|
|
117
|
-
if (!this.checkEventSizeLimit(event)) {
|
|
184
|
+
if (!this.enqueue(event)) {
|
|
118
185
|
return [2 /*return*/];
|
|
119
186
|
}
|
|
120
187
|
return [4 /*yield*/, this.resetHeartbeat()];
|
|
@@ -151,7 +218,9 @@ var Heartbeat = /** @class */ (function () {
|
|
|
151
218
|
return __generator(this, function (_a) {
|
|
152
219
|
if (event.insert_id && this.events.has(event.insert_id)) {
|
|
153
220
|
backupEvent = this.events.get(event.insert_id);
|
|
154
|
-
this.events.set(event.insert_id, __assign(__assign({}, event), {
|
|
221
|
+
this.events.set(event.insert_id, __assign(__assign({}, event), {
|
|
222
|
+
// Page engagement supplies its delay group and removes timeout to finalize it.
|
|
223
|
+
delay: event.delay || { id: this.delayId, timeout: this.delayTimeout } }));
|
|
155
224
|
if (!this.checkEventSizeLimit(event) && backupEvent) {
|
|
156
225
|
this.events.set(event.insert_id, backupEvent);
|
|
157
226
|
return [2 /*return*/];
|
|
@@ -161,10 +230,31 @@ var Heartbeat = /** @class */ (function () {
|
|
|
161
230
|
});
|
|
162
231
|
});
|
|
163
232
|
};
|
|
164
|
-
|
|
233
|
+
// run handlers before 'pagehide' event
|
|
234
|
+
Heartbeat.prototype.beforePageHide = function (prepare) {
|
|
235
|
+
var _this = this;
|
|
236
|
+
this.pageHidePreparers.push(prepare);
|
|
237
|
+
return function () {
|
|
238
|
+
var index = _this.pageHidePreparers.indexOf(prepare);
|
|
239
|
+
if (index !== -1) {
|
|
240
|
+
_this.pageHidePreparers.splice(index, 1);
|
|
241
|
+
}
|
|
242
|
+
};
|
|
243
|
+
};
|
|
244
|
+
/** Stop the pulse without discarding the latest snapshot. */
|
|
245
|
+
Heartbeat.prototype.pause = function () {
|
|
165
246
|
this.interval && clearInterval(this.interval);
|
|
166
247
|
this.interval = null;
|
|
248
|
+
};
|
|
249
|
+
Heartbeat.prototype.stop = function (flush) {
|
|
250
|
+
if (flush === void 0) { flush = false; }
|
|
251
|
+
this.pause();
|
|
167
252
|
this.events.clear();
|
|
253
|
+
this.unsubscribeFunctions.forEach(function (removeListener) { return removeListener(); });
|
|
254
|
+
this.unsubscribeFunctions = [];
|
|
255
|
+
if (flush) {
|
|
256
|
+
this.client.flush();
|
|
257
|
+
}
|
|
168
258
|
};
|
|
169
259
|
return Heartbeat;
|
|
170
260
|
}());
|
package/lib/esm/heartbeat.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"heartbeat.js","sourceRoot":"","sources":["../../src/heartbeat.ts"],"names":[],"mappings":";AAIA,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;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,IAAI,EAAE,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,UAAK,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,SAAA,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,0BAAK,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,wBAC1B,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,wBAC1B,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;;AAED,IAAM,0BAA0B,GAAG,KAAM,CAAC;AAC1C,uEAAuE;AACvE,IAAM,+BAA+B,GAAG,OAAS,CAAC;AAIlD,IAAM,YAAY,GAAiB,IAAI,GAAG,EAAyB,CAAC;AAEpE,MAAM,UAAU,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","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,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;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,IAAI,EAAE,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,UAAK,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,SAAA,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,cAAc,EAAE,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,kCAAI,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,0BAAK,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,wBAC1B,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,wBAC1B,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;;AAED,IAAM,0BAA0B,GAAG,KAAM,CAAC;AAC1C,uEAAuE;AACvE,IAAM,+BAA+B,GAAG,OAAS,CAAC;AAIlD,IAAM,YAAY,GAAiB,IAAI,GAAG,EAAyB,CAAC;AAEpE,MAAM,UAAU,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","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/esm/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
|
//# sourceMappingURL=index.d.ts.map
|