@amplitude/analytics-browser 2.48.2-codexsemantic-review-integration.0 → 2.49.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/README.md +1 -1
- package/lib/cjs/browser-client.d.ts.map +1 -1
- package/lib/cjs/browser-client.js +43 -35
- package/lib/cjs/browser-client.js.map +1 -1
- package/lib/cjs/config.d.ts +9 -2
- package/lib/cjs/config.d.ts.map +1 -1
- package/lib/cjs/config.js +28 -3
- package/lib/cjs/config.js.map +1 -1
- package/lib/cjs/constants.d.ts +2 -0
- package/lib/cjs/constants.d.ts.map +1 -1
- package/lib/cjs/constants.js +3 -1
- package/lib/cjs/constants.js.map +1 -1
- package/lib/cjs/default-tracking.d.ts.map +1 -1
- package/lib/cjs/default-tracking.js +6 -6
- package/lib/cjs/default-tracking.js.map +1 -1
- package/lib/cjs/types.d.ts +1 -1
- package/lib/cjs/types.d.ts.map +1 -1
- package/lib/cjs/types.js.map +1 -1
- package/lib/cjs/version.d.ts +1 -1
- package/lib/cjs/version.d.ts.map +1 -1
- package/lib/cjs/version.js +1 -1
- package/lib/cjs/version.js.map +1 -1
- package/lib/cjs/video-capture/video-capture.d.ts +48 -11
- package/lib/cjs/video-capture/video-capture.d.ts.map +1 -1
- package/lib/cjs/video-capture/video-capture.js +194 -16
- package/lib/cjs/video-capture/video-capture.js.map +1 -1
- package/lib/esm/browser-client.d.ts.map +1 -1
- package/lib/esm/browser-client.js +43 -35
- package/lib/esm/browser-client.js.map +1 -1
- package/lib/esm/config.d.ts +9 -2
- package/lib/esm/config.d.ts.map +1 -1
- package/lib/esm/config.js +26 -2
- package/lib/esm/config.js.map +1 -1
- package/lib/esm/constants.d.ts +2 -0
- package/lib/esm/constants.d.ts.map +1 -1
- package/lib/esm/constants.js +2 -0
- package/lib/esm/constants.js.map +1 -1
- package/lib/esm/default-tracking.d.ts.map +1 -1
- package/lib/esm/default-tracking.js +6 -6
- package/lib/esm/default-tracking.js.map +1 -1
- package/lib/esm/types.d.ts +1 -1
- package/lib/esm/types.d.ts.map +1 -1
- package/lib/esm/types.js.map +1 -1
- package/lib/esm/version.d.ts +1 -1
- package/lib/esm/version.d.ts.map +1 -1
- package/lib/esm/version.js +1 -1
- package/lib/esm/version.js.map +1 -1
- package/lib/esm/video-capture/video-capture.d.ts +48 -11
- package/lib/esm/video-capture/video-capture.d.ts.map +1 -1
- package/lib/esm/video-capture/video-capture.js +196 -18
- package/lib/esm/video-capture/video-capture.js.map +1 -1
- package/lib/scripts/amplitude-bookmarklet-snippet-min.js +1 -1
- package/lib/scripts/amplitude-bookmarklet.html +1 -1
- package/lib/scripts/amplitude-gtm-min.js +1 -1
- package/lib/scripts/amplitude-gtm-min.js.gz +0 -0
- package/lib/scripts/amplitude-gtm-min.js.map +1 -1
- package/lib/scripts/amplitude-gtm-snippet-min.js +1 -1
- package/lib/scripts/amplitude-min.js +1 -1
- package/lib/scripts/amplitude-min.js.gz +0 -0
- package/lib/scripts/amplitude-min.js.map +1 -1
- package/lib/scripts/amplitude-min.umd.js +1 -1
- package/lib/scripts/amplitude-min.umd.js.gz +0 -0
- package/lib/scripts/amplitude-snippet-instructions.html +1 -1
- package/lib/scripts/amplitude-snippet-min.js +1 -1
- package/lib/scripts/browser-client.d.ts.map +1 -1
- package/lib/scripts/config.d.ts +9 -2
- package/lib/scripts/config.d.ts.map +1 -1
- package/lib/scripts/constants.d.ts +2 -0
- package/lib/scripts/constants.d.ts.map +1 -1
- package/lib/scripts/default-tracking.d.ts.map +1 -1
- package/lib/scripts/types.d.ts +1 -1
- package/lib/scripts/types.d.ts.map +1 -1
- package/lib/scripts/version.d.ts +1 -1
- package/lib/scripts/version.d.ts.map +1 -1
- package/lib/scripts/video-capture/video-capture.d.ts +48 -11
- package/lib/scripts/video-capture/video-capture.d.ts.map +1 -1
- package/package.json +9 -9
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"default-tracking.js","sourceRoot":"","sources":["../../src/default-tracking.ts"],"names":[],"mappings":";AAAA,OAAO,EAcL,iBAAiB,EACjB,4BAA4B,GAC7B,MAAM,2BAA2B,CAAC;AAWnC;;;GAGG;AACH,IAAM,iBAAiB,GAAG,UACxB,WAAqE,EACrE,KAA+C;IAE/C,IAAI,OAAO,WAAW,KAAK,SAAS,EAAE;QACpC,OAAO,WAAW,CAAC;KACpB;IAED,IAAI,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAG,KAAK,CAAC,MAAK,KAAK,EAAE;QAClC,OAAO,KAAK,CAAC;KACd;IAED,IAAI,iBAAiB,EAAE,EAAE;QACvB,OAAO,CAAC,CAAC,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAG,KAAK,CAAC,CAAA,CAAC;KAC/B;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,4BAA4B,GAAG,UAAC,WAAqD;IAChG,OAAA,iBAAiB,CAAC,WAAW,EAAE,aAAa,CAAC;AAA7C,CAA6C,CAAC;AAEhD,MAAM,CAAC,IAAM,6BAA6B,GAAG,UAAC,WAAqD;IACjG,OAAA,iBAAiB,CAAC,WAAW,EAAE,eAAe,CAAC;AAA/C,CAA+C,CAAC;AAElD,MAAM,CAAC,IAAM,gCAAgC,GAAG,UAAC,WAAqD;IACpG,OAAA,iBAAiB,CAAC,WAAW,EAAE,kBAAkB,CAAC;AAAlD,CAAkD,CAAC;AAErD,MAAM,CAAC,IAAM,yBAAyB,GAAG,UAAC,WAAqD;IAC7F,OAAA,iBAAiB,CAAC,WAAW,EAAE,WAAW,CAAC;AAA3C,CAA2C,CAAC;AAE9C,MAAM,CAAC,IAAM,wBAAwB,GAAG,UAAC,WAAqD;IAC5F,OAAA,iBAAiB,CAAC,WAAW,EAAE,UAAU,CAAC;AAA1C,CAA0C,CAAC;AAE7C,MAAM,CAAC,IAAM,0BAA0B,GAAG,UAAC,WAAqD;IAC9F,OAAA,iBAAiB,CAAC,WAAW,EAAE,mBAAmB,CAAC;AAAnD,CAAmD,CAAC;AAEtD;;;;;GAKG;AACH,MAAM,CAAC,IAAM,wBAAwB,GAAG,UAAC,WAAqD;IAC5F,IAAI,OAAO,WAAW,KAAK,SAAS,EAAE;QACpC,OAAO,WAAW,CAAC;KACpB;IAED,IACE,OAAO,WAAW,KAAK,QAAQ;QAC/B,CAAC,WAAW,CAAC,eAAe,KAAK,IAAI,IAAI,OAAO,WAAW,CAAC,eAAe,KAAK,QAAQ,CAAC,EACzF;QACA,OAAO,IAAI,CAAC;KACb;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,IAAM,4BAA4B,GAAG,UAAC,WAAqD;IAChG,IAAI,OAAO,WAAW,KAAK,SAAS,EAAE;QACpC,OAAO,WAAW,CAAC;KACpB;IAED,IACE,OAAO,WAAW,KAAK,QAAQ;QAC/B,CAAC,WAAW,CAAC,mBAAmB,KAAK,IAAI,IAAI,OAAO,WAAW,CAAC,mBAAmB,KAAK,QAAQ,CAAC,EACjG;QACA,OAAO,IAAI,CAAC;KACb;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,IAAM,kBAAkB,GAAG,UAAC,WAAqD;IACtF,IAAI,OAAO,WAAW,KAAK,SAAS,EAAE;QACpC,OAAO,WAAW,CAAC;KACpB;IAED,IACE,OAAO,WAAW,KAAK,QAAQ;QAC/B,CAAC,WAAW,CAAC,SAAS,KAAK,IAAI,IAAI,CAAC,OAAO,WAAW,CAAC,SAAS,KAAK,QAAQ,IAAI,WAAW,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC,EACjH;QACA,OAAO,IAAI,CAAC;KACb;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,IAAM,kBAAkB,GAAG,UAAC,MAAsB;IACvD,IAAI,OAAO,MAAM,CAAC,WAAW,KAAK,QAAQ,EAAE;QAC1C,OAAO,SAAS,CAAC;KAClB;IAED,IAAM,SAAS,GAAG,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC;IAE/C,IAAI,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,IAAI,EAAE;QACvD,OAAO,SAAS,CAAC;KAClB;IAED,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,gCAAgC,GAAG,UAAC,WAAqD;IACpG,IAAI,OAAO,WAAW,KAAK,SAAS,EAAE;QACpC,OAAO,WAAW,CAAC;KACpB;IAED,IACE,OAAO,WAAW,KAAK,QAAQ;QAC/B,CAAC,WAAW,CAAC,uBAAuB,KAAK,IAAI,IAAI,OAAO,WAAW,CAAC,uBAAuB,KAAK,QAAQ,CAAC,EACzG;QACA,OAAO,IAAI,CAAC;KACb;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,4BAA4B,GAAG,UAAC,WAAqD;IAChG,IACE,OAAO,WAAW,KAAK,QAAQ;QAC/B,CAAC,WAAW,CAAC,mBAAmB,KAAK,IAAI,IAAI,OAAO,WAAW,CAAC,mBAAmB,KAAK,QAAQ,CAAC,EACjG;QACA,OAAO,IAAI,CAAC;KACb;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,4BAA4B,GAAG,UAAC,MAAsB;IACjE,IAAI,OAAO,MAAM,CAAC,WAAW,KAAK,QAAQ,EAAE;QAC1C,OAAO,SAAS,CAAC;KAClB;IAED,IAAM,mBAAmB,GAAG,MAAM,CAAC,WAAW,CAAC,mBAAmB,CAAC;IAEnE,IAAI,mBAAmB,KAAK,IAAI,EAAE;QAChC,OAAO,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC;KAClC;IAED,IAAI,OAAO,mBAAmB,KAAK,QAAQ,IAAI,mBAAmB,KAAK,IAAI,EAAE;QAC3E,OAAO,mBAAmB,CAAC;KAC5B;IAED,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,yBAAyB,GAAG,UAAC,gBAA+D;IACvG,IAAI,OAAO,gBAAgB,KAAK,SAAS,EAAE;QACzC,OAAO,gBAAgB,CAAC;KACzB;IAED,IAAI,OAAO,gBAAgB,KAAK,QAAQ,IAAI,gBAAgB,KAAK,IAAI,IAAI,gBAAgB,CAAC,OAAO,KAAK,KAAK,EAAE;QAC3G,OAAO,IAAI,CAAC;KACb;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,4BAA4B,GAAG,UAAC,MAAsB;IACjE,IACE,4BAA4B,CAAC,MAAM,CAAC,WAAW,CAAC;QAChD,OAAO,MAAM,CAAC,WAAW,KAAK,QAAQ;QACtC,OAAO,MAAM,CAAC,WAAW,CAAC,mBAAmB,KAAK,QAAQ,EAC1D;QACA,OAAO,MAAM,CAAC,WAAW,CAAC,mBAAmB,CAAC;KAC/C;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,gCAAgC,GAAG,UAC9C,MAAsB;IAEtB,IACE,gCAAgC,CAAC,MAAM,CAAC,WAAW,CAAC;QACpD,OAAO,MAAM,CAAC,WAAW,KAAK,QAAQ;QACtC,OAAO,MAAM,CAAC,WAAW,CAAC,uBAAuB,KAAK,QAAQ,EAC9D;QACA,OAAO,MAAM,CAAC,WAAW,CAAC,uBAAuB,CAAC;KACnD;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,wBAAwB,GAAG,UAAC,MAAsB;IAC7D,IAAI,wBAAwB,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE;QAChD,IAAI,qBAAqB,SAAA,CAAC;QAC1B,IAAI,OAAO,MAAM,CAAC,WAAW,KAAK,QAAQ,IAAI,OAAO,MAAM,CAAC,WAAW,CAAC,eAAe,KAAK,QAAQ,EAAE;YACpG,qBAAqB,GAAG,MAAM,CAAC,WAAW,CAAC,eAAe,CAAC;SAC5D;aAAM,IAAI,MAAM,CAAC,sBAAsB,EAAE;YACxC,qBAAqB,GAAG,MAAM,CAAC,sBAAsB,CAAC;SACvD;QACD,6BACK,qBAAqB,KACxB,YAAY,EAAE,4BAA4B,CAAC,qBAAqB,aAArB,qBAAqB,uBAArB,qBAAqB,CAAE,YAAY,EAAE,MAAM,CAAC,cAAc,CAAC,IACtG;KACH;IACD,OAAO;AACT,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,yBAAyB,GAAG,UAAC,MAAsB;IAC9D,IAAI,OAAO,GAAoC,cAAM,OAAA,KAAK,EAAL,CAAK,CAAC;IAC3D,IAAI,mBAAmB,GAA2C,SAAS,CAAC;IAC5E,IAAI,SAA6B,CAAC;IAClC,IAAM,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;IAEvC,IAAM,gCAAgC,GAAG,yBAAyB,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IAC3F,IAAI,gCAAgC,EAAE;QACpC,OAAO,GAAG,SAAS,CAAC;QACpB,SAAS,GAAG,SAAS,CAAC;QAEtB,IACE,MAAM,CAAC,eAAe;YACtB,OAAO,MAAM,CAAC,eAAe,KAAK,QAAQ;YAC1C,MAAM,CAAC,eAAe,CAAC,SAAS;YAChC,OAAO,MAAM,CAAC,eAAe,CAAC,SAAS,KAAK,QAAQ,EACpD;YACA,IAAI,SAAS,IAAI,MAAM,CAAC,eAAe,CAAC,SAAS,EAAE;gBACjD,OAAO,GAAG,MAAM,CAAC,eAAe,CAAC,SAAS,CAAC,OAAO,CAAC;aACpD;YAED,IAAI,qBAAqB,IAAI,MAAM,CAAC,eAAe,CAAC,SAAS,EAAE;gBAC7D,mBAAmB,GAAG,MAAM,CAAC,eAAe,CAAC,SAAS,CAAC,mBAAmB,CAAC;aAC5E;YAED,IAAI,WAAW,IAAI,MAAM,CAAC,eAAe,CAAC,SAAS,IAAI,MAAM,CAAC,eAAe,CAAC,SAAS,CAAC,SAAS,EAAE;gBACjG,SAAS,GAAG,MAAM,CAAC,eAAe,CAAC,SAAS,CAAC,SAAS,CAAC;aACxD;SACF;KACF;IAED,OAAO;QACL,OAAO,SAAA;QACP,mBAAmB,qBAAA;QACnB,SAAS,WAAA;QACT,WAAW,aAAA;KACZ,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,4BAA4B,GAAG,UAAC,MAAsB;IACjE,IACE,4BAA4B,CAAC,MAAM,CAAC,eAAe,CAAC;QACpD,MAAM,CAAC,eAAe;QACtB,OAAO,MAAM,CAAC,eAAe,KAAK,QAAQ;QAC1C,MAAM,CAAC,eAAe,CAAC,WAAW;QAClC,OAAO,MAAM,CAAC,eAAe,CAAC,WAAW,KAAK,QAAQ,EACtD;QACA,oBACK,MAAM,CAAC,eAAe,CAAC,WAAW,EACrC;KACH;IAED,OAAO,EAAE,CAAC;AACZ,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,yBAAyB,GAAG,UAAC,MAAsB;IAC9D,IACE,gCAAgC,CAAC,MAAM,CAAC,eAAe,CAAC;QACxD,MAAM,CAAC,eAAe;QACtB,OAAO,MAAM,CAAC,eAAe,KAAK,QAAQ;QAC1C,OAAO,MAAM,CAAC,eAAe,CAAC,gBAAgB,KAAK,QAAQ,EAC3D;QACA,OAAO,MAAM,CAAC,eAAe,CAAC,gBAAgB,CAAC;KAChD;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC","sourcesContent":["import {\n PageTrackingHistoryChanges,\n PageTrackingOptions,\n PageTrackingTrackOn,\n ElementInteractionsOptions,\n FormInteractionsOptions,\n BrowserOptions,\n AutocaptureOptions,\n AttributionOptions,\n NetworkTrackingOptions,\n FrustrationInteractionsOptions,\n CustomEnrichmentOptions,\n PerformanceTrackingOptions,\n WebVitalsOptions,\n isChromeExtension,\n normalizeNetworkCaptureRules,\n} from '@amplitude/analytics-core';\n\n/**\n * A subset of AutocaptureOptions that includes the autocapture features that\n * are made available to users by default (even if \"config.autocapture === undefined\")\n */\ntype AutocaptureOptionsDefaultAvailable = Pick<\n AutocaptureOptions,\n 'pageViews' | 'sessions' | 'fileDownloads' | 'formInteractions' | 'attribution' | 'pageUrlEnrichment'\n>;\n\n/**\n * Returns false if autocapture === false or if autocapture[event],\n * otherwise returns true (even if \"config.autocapture === undefined\")\n */\nconst isTrackingEnabled = (\n autocapture: AutocaptureOptionsDefaultAvailable | boolean | undefined,\n event: keyof AutocaptureOptionsDefaultAvailable,\n) => {\n if (typeof autocapture === 'boolean') {\n return autocapture;\n }\n\n if (autocapture?.[event] === false) {\n return false;\n }\n\n if (isChromeExtension()) {\n return !!autocapture?.[event];\n }\n\n return true;\n};\n\nexport const isAttributionTrackingEnabled = (autocapture: AutocaptureOptions | boolean | undefined) =>\n isTrackingEnabled(autocapture, 'attribution');\n\nexport const isFileDownloadTrackingEnabled = (autocapture: AutocaptureOptions | boolean | undefined) =>\n isTrackingEnabled(autocapture, 'fileDownloads');\n\nexport const isFormInteractionTrackingEnabled = (autocapture: AutocaptureOptions | boolean | undefined) =>\n isTrackingEnabled(autocapture, 'formInteractions');\n\nexport const isPageViewTrackingEnabled = (autocapture: AutocaptureOptions | boolean | undefined) =>\n isTrackingEnabled(autocapture, 'pageViews');\n\nexport const isSessionTrackingEnabled = (autocapture: AutocaptureOptions | boolean | undefined) =>\n isTrackingEnabled(autocapture, 'sessions');\n\nexport const isPageUrlEnrichmentEnabled = (autocapture: AutocaptureOptions | boolean | undefined) =>\n isTrackingEnabled(autocapture, 'pageUrlEnrichment');\n\n/**\n * Returns true if\n * 1. if autocapture.networkTracking === true\n * 2. if autocapture.networkTracking === object\n * otherwise returns false\n */\nexport const isNetworkTrackingEnabled = (autocapture: AutocaptureOptions | boolean | undefined) => {\n if (typeof autocapture === 'boolean') {\n return autocapture;\n }\n\n if (\n typeof autocapture === 'object' &&\n (autocapture.networkTracking === true || typeof autocapture.networkTracking === 'object')\n ) {\n return true;\n }\n\n return false;\n};\n\n/**\n * Returns true if\n * 1. autocapture === true\n * 2. if autocapture.elementInteractions === true\n * 3. if autocapture.elementInteractions === object\n * otherwise returns false\n */\nexport const isElementInteractionsEnabled = (autocapture: AutocaptureOptions | boolean | undefined): boolean => {\n if (typeof autocapture === 'boolean') {\n return autocapture;\n }\n\n if (\n typeof autocapture === 'object' &&\n (autocapture.elementInteractions === true || typeof autocapture.elementInteractions === 'object')\n ) {\n return true;\n }\n\n return false;\n};\n\n/**\n * Returns true if\n * 1. autocapture === true\n * 2. if autocapture.webVitals === true or is an options object\n * otherwise returns false\n */\nexport const isWebVitalsEnabled = (autocapture: AutocaptureOptions | boolean | undefined): boolean => {\n if (typeof autocapture === 'boolean') {\n return autocapture;\n }\n\n if (\n typeof autocapture === 'object' &&\n (autocapture.webVitals === true || (typeof autocapture.webVitals === 'object' && autocapture.webVitals !== null))\n ) {\n return true;\n }\n\n return false;\n};\n\n/**\n * Returns the web vitals options when autocapture.webVitals is configured with an options object,\n * otherwise returns undefined so the plugin falls back to its defaults.\n */\nexport const getWebVitalsConfig = (config: BrowserOptions): WebVitalsOptions | undefined => {\n if (typeof config.autocapture !== 'object') {\n return undefined;\n }\n\n const webVitals = config.autocapture.webVitals;\n\n if (typeof webVitals === 'object' && webVitals !== null) {\n return webVitals;\n }\n\n return undefined;\n};\n\nexport const isFrustrationInteractionsEnabled = (autocapture: AutocaptureOptions | boolean | undefined): boolean => {\n if (typeof autocapture === 'boolean') {\n return autocapture;\n }\n\n if (\n typeof autocapture === 'object' &&\n (autocapture.frustrationInteractions === true || typeof autocapture.frustrationInteractions === 'object')\n ) {\n return true;\n }\n\n return false;\n};\n\nexport const isPerformanceTrackingEnabled = (autocapture: AutocaptureOptions | boolean | undefined): boolean => {\n if (\n typeof autocapture === 'object' &&\n (autocapture.performanceTracking === true || typeof autocapture.performanceTracking === 'object')\n ) {\n return true;\n }\n\n return false;\n};\n\nexport const getPerformanceTrackingConfig = (config: BrowserOptions): PerformanceTrackingOptions | undefined => {\n if (typeof config.autocapture !== 'object') {\n return undefined;\n }\n\n const performanceTracking = config.autocapture.performanceTracking;\n\n if (performanceTracking === true) {\n return { mainThreadBlock: true };\n }\n\n if (typeof performanceTracking === 'object' && performanceTracking !== null) {\n return performanceTracking;\n }\n\n return undefined;\n};\n\nexport const isCustomEnrichmentEnabled = (customEnrichment: boolean | CustomEnrichmentOptions | undefined) => {\n if (typeof customEnrichment === 'boolean') {\n return customEnrichment;\n }\n\n if (typeof customEnrichment === 'object' && customEnrichment !== null && customEnrichment.enabled !== false) {\n return true;\n }\n\n return false;\n};\n\nexport const getElementInteractionsConfig = (config: BrowserOptions): ElementInteractionsOptions | undefined => {\n if (\n isElementInteractionsEnabled(config.autocapture) &&\n typeof config.autocapture === 'object' &&\n typeof config.autocapture.elementInteractions === 'object'\n ) {\n return config.autocapture.elementInteractions;\n }\n return undefined;\n};\n\nexport const getFrustrationInteractionsConfig = (\n config: BrowserOptions,\n): FrustrationInteractionsOptions | undefined => {\n if (\n isFrustrationInteractionsEnabled(config.autocapture) &&\n typeof config.autocapture === 'object' &&\n typeof config.autocapture.frustrationInteractions === 'object'\n ) {\n return config.autocapture.frustrationInteractions;\n }\n return undefined;\n};\n\nexport const getNetworkTrackingConfig = (config: BrowserOptions): NetworkTrackingOptions | undefined => {\n if (isNetworkTrackingEnabled(config.autocapture)) {\n let networkTrackingConfig;\n if (typeof config.autocapture === 'object' && typeof config.autocapture.networkTracking === 'object') {\n networkTrackingConfig = config.autocapture.networkTracking;\n } else if (config.networkTrackingOptions) {\n networkTrackingConfig = config.networkTrackingOptions;\n }\n return {\n ...networkTrackingConfig,\n captureRules: normalizeNetworkCaptureRules(networkTrackingConfig?.captureRules, config.loggerProvider),\n };\n }\n return;\n};\n\nexport const getPageViewTrackingConfig = (config: BrowserOptions): PageTrackingOptions => {\n let trackOn: PageTrackingTrackOn | undefined = () => false;\n let trackHistoryChanges: PageTrackingHistoryChanges | undefined = undefined;\n let eventType: string | undefined;\n const pageCounter = config.pageCounter;\n\n const isDefaultPageViewTrackingEnabled = isPageViewTrackingEnabled(config.defaultTracking);\n if (isDefaultPageViewTrackingEnabled) {\n trackOn = undefined;\n eventType = undefined;\n\n if (\n config.defaultTracking &&\n typeof config.defaultTracking === 'object' &&\n config.defaultTracking.pageViews &&\n typeof config.defaultTracking.pageViews === 'object'\n ) {\n if ('trackOn' in config.defaultTracking.pageViews) {\n trackOn = config.defaultTracking.pageViews.trackOn;\n }\n\n if ('trackHistoryChanges' in config.defaultTracking.pageViews) {\n trackHistoryChanges = config.defaultTracking.pageViews.trackHistoryChanges;\n }\n\n if ('eventType' in config.defaultTracking.pageViews && config.defaultTracking.pageViews.eventType) {\n eventType = config.defaultTracking.pageViews.eventType;\n }\n }\n }\n\n return {\n trackOn,\n trackHistoryChanges,\n eventType,\n pageCounter,\n };\n};\n\nexport const getAttributionTrackingConfig = (config: BrowserOptions): AttributionOptions => {\n if (\n isAttributionTrackingEnabled(config.defaultTracking) &&\n config.defaultTracking &&\n typeof config.defaultTracking === 'object' &&\n config.defaultTracking.attribution &&\n typeof config.defaultTracking.attribution === 'object'\n ) {\n return {\n ...config.defaultTracking.attribution,\n };\n }\n\n return {};\n};\n\nexport const getFormInteractionsConfig = (config: BrowserOptions): FormInteractionsOptions | undefined => {\n if (\n isFormInteractionTrackingEnabled(config.defaultTracking) &&\n config.defaultTracking &&\n typeof config.defaultTracking === 'object' &&\n typeof config.defaultTracking.formInteractions === 'object'\n ) {\n return config.defaultTracking.formInteractions;\n }\n return undefined;\n};\n"]}
|
|
1
|
+
{"version":3,"file":"default-tracking.js","sourceRoot":"","sources":["../../src/default-tracking.ts"],"names":[],"mappings":";AAAA,OAAO,EAcL,iBAAiB,EACjB,4BAA4B,GAC7B,MAAM,2BAA2B,CAAC;AAWnC;;;GAGG;AACH,IAAM,iBAAiB,GAAG,UACxB,WAAqE,EACrE,KAA+C;IAE/C,IAAI,OAAO,WAAW,KAAK,SAAS,EAAE;QACpC,OAAO,WAAW,CAAC;KACpB;IAED,IAAI,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAG,KAAK,CAAC,MAAK,KAAK,EAAE;QAClC,OAAO,KAAK,CAAC;KACd;IAED,IAAI,iBAAiB,EAAE,EAAE;QACvB,OAAO,CAAC,CAAC,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAG,KAAK,CAAC,CAAA,CAAC;KAC/B;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,4BAA4B,GAAG,UAAC,WAAqD;IAChG,OAAA,iBAAiB,CAAC,WAAW,EAAE,aAAa,CAAC;AAA7C,CAA6C,CAAC;AAEhD,MAAM,CAAC,IAAM,6BAA6B,GAAG,UAAC,WAAqD;IACjG,OAAA,iBAAiB,CAAC,WAAW,EAAE,eAAe,CAAC;AAA/C,CAA+C,CAAC;AAElD,MAAM,CAAC,IAAM,gCAAgC,GAAG,UAAC,WAAqD;IACpG,OAAA,iBAAiB,CAAC,WAAW,EAAE,kBAAkB,CAAC;AAAlD,CAAkD,CAAC;AAErD,MAAM,CAAC,IAAM,yBAAyB,GAAG,UAAC,WAAqD;IAC7F,OAAA,iBAAiB,CAAC,WAAW,EAAE,WAAW,CAAC;AAA3C,CAA2C,CAAC;AAE9C,MAAM,CAAC,IAAM,wBAAwB,GAAG,UAAC,WAAqD;IAC5F,OAAA,iBAAiB,CAAC,WAAW,EAAE,UAAU,CAAC;AAA1C,CAA0C,CAAC;AAE7C,MAAM,CAAC,IAAM,0BAA0B,GAAG,UAAC,WAAqD;IAC9F,OAAA,iBAAiB,CAAC,WAAW,EAAE,mBAAmB,CAAC;AAAnD,CAAmD,CAAC;AAEtD;;;;;GAKG;AACH,MAAM,CAAC,IAAM,wBAAwB,GAAG,UAAC,WAAqD;IAC5F,IAAI,OAAO,WAAW,KAAK,SAAS,EAAE;QACpC,OAAO,WAAW,CAAC;KACpB;IAED,IACE,OAAO,WAAW,KAAK,QAAQ;QAC/B,CAAC,WAAW,CAAC,eAAe,KAAK,IAAI,IAAI,OAAO,WAAW,CAAC,eAAe,KAAK,QAAQ,CAAC,EACzF;QACA,OAAO,IAAI,CAAC;KACb;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,IAAM,4BAA4B,GAAG,UAAC,WAAqD;IAChG,IAAI,OAAO,WAAW,KAAK,SAAS,EAAE;QACpC,OAAO,WAAW,CAAC;KACpB;IAED,IACE,OAAO,WAAW,KAAK,QAAQ;QAC/B,CAAC,WAAW,CAAC,mBAAmB,KAAK,IAAI,IAAI,OAAO,WAAW,CAAC,mBAAmB,KAAK,QAAQ,CAAC,EACjG;QACA,OAAO,IAAI,CAAC;KACb;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,IAAM,kBAAkB,GAAG,UAAC,WAAqD;IACtF,IAAI,OAAO,WAAW,KAAK,SAAS,EAAE;QACpC,OAAO,WAAW,CAAC;KACpB;IAED,IACE,OAAO,WAAW,KAAK,QAAQ;QAC/B,CAAC,WAAW,CAAC,SAAS,KAAK,IAAI,IAAI,CAAC,OAAO,WAAW,CAAC,SAAS,KAAK,QAAQ,IAAI,WAAW,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC,EACjH;QACA,OAAO,IAAI,CAAC;KACb;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,IAAM,kBAAkB,GAAG,UAAC,MAAsB;IACvD,IAAI,OAAO,MAAM,CAAC,WAAW,KAAK,QAAQ,EAAE;QAC1C,OAAO,SAAS,CAAC;KAClB;IAED,IAAM,SAAS,GAAG,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC;IAE/C,IAAI,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,IAAI,EAAE;QACvD,OAAO,SAAS,CAAC;KAClB;IAED,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,gCAAgC,GAAG,UAAC,WAAqD;IACpG,IAAI,OAAO,WAAW,KAAK,SAAS,EAAE;QACpC,OAAO,WAAW,CAAC;KACpB;IAED,IACE,OAAO,WAAW,KAAK,QAAQ;QAC/B,CAAC,WAAW,CAAC,uBAAuB,KAAK,IAAI,IAAI,OAAO,WAAW,CAAC,uBAAuB,KAAK,QAAQ,CAAC,EACzG;QACA,OAAO,IAAI,CAAC;KACb;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,4BAA4B,GAAG,UAAC,WAAqD;IAChG,IACE,OAAO,WAAW,KAAK,QAAQ;QAC/B,CAAC,WAAW,CAAC,mBAAmB,KAAK,IAAI,IAAI,OAAO,WAAW,CAAC,mBAAmB,KAAK,QAAQ,CAAC,EACjG;QACA,OAAO,IAAI,CAAC;KACb;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,4BAA4B,GAAG,UAAC,MAAsB;IACjE,IAAI,OAAO,MAAM,CAAC,WAAW,KAAK,QAAQ,EAAE;QAC1C,OAAO,SAAS,CAAC;KAClB;IAED,IAAM,mBAAmB,GAAG,MAAM,CAAC,WAAW,CAAC,mBAAmB,CAAC;IAEnE,IAAI,mBAAmB,KAAK,IAAI,EAAE;QAChC,OAAO,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC;KAClC;IAED,IAAI,OAAO,mBAAmB,KAAK,QAAQ,IAAI,mBAAmB,KAAK,IAAI,EAAE;QAC3E,OAAO,mBAAmB,CAAC;KAC5B;IAED,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,yBAAyB,GAAG,UAAC,gBAA+D;IACvG,IAAI,OAAO,gBAAgB,KAAK,SAAS,EAAE;QACzC,OAAO,gBAAgB,CAAC;KACzB;IAED,IAAI,OAAO,gBAAgB,KAAK,QAAQ,IAAI,gBAAgB,KAAK,IAAI,IAAI,gBAAgB,CAAC,OAAO,KAAK,KAAK,EAAE;QAC3G,OAAO,IAAI,CAAC;KACb;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,4BAA4B,GAAG,UAAC,MAAsB;IACjE,IACE,4BAA4B,CAAC,MAAM,CAAC,WAAW,CAAC;QAChD,OAAO,MAAM,CAAC,WAAW,KAAK,QAAQ;QACtC,OAAO,MAAM,CAAC,WAAW,CAAC,mBAAmB,KAAK,QAAQ,EAC1D;QACA,OAAO,MAAM,CAAC,WAAW,CAAC,mBAAmB,CAAC;KAC/C;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,gCAAgC,GAAG,UAC9C,MAAsB;IAEtB,IACE,gCAAgC,CAAC,MAAM,CAAC,WAAW,CAAC;QACpD,OAAO,MAAM,CAAC,WAAW,KAAK,QAAQ;QACtC,OAAO,MAAM,CAAC,WAAW,CAAC,uBAAuB,KAAK,QAAQ,EAC9D;QACA,OAAO,MAAM,CAAC,WAAW,CAAC,uBAAuB,CAAC;KACnD;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,wBAAwB,GAAG,UAAC,MAAsB;IAC7D,IAAI,wBAAwB,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE;QAChD,IAAI,qBAAqB,SAAA,CAAC;QAC1B,IAAI,OAAO,MAAM,CAAC,WAAW,KAAK,QAAQ,IAAI,OAAO,MAAM,CAAC,WAAW,CAAC,eAAe,KAAK,QAAQ,EAAE;YACpG,qBAAqB,GAAG,MAAM,CAAC,WAAW,CAAC,eAAe,CAAC;SAC5D;aAAM,IAAI,MAAM,CAAC,sBAAsB,EAAE;YACxC,qBAAqB,GAAG,MAAM,CAAC,sBAAsB,CAAC;SACvD;QACD,6BACK,qBAAqB,KACxB,YAAY,EAAE,4BAA4B,CAAC,qBAAqB,aAArB,qBAAqB,uBAArB,qBAAqB,CAAE,YAAY,EAAE,MAAM,CAAC,cAAc,CAAC,IACtG;KACH;IACD,OAAO;AACT,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,yBAAyB,GAAG,UAAC,MAAsB;IAC9D,IAAI,OAAO,GAAoC,cAAM,OAAA,KAAK,EAAL,CAAK,CAAC;IAC3D,IAAI,mBAAmB,GAA2C,SAAS,CAAC;IAC5E,IAAI,SAA6B,CAAC;IAClC,IAAI,iBAAiB,GAAwB,EAAE,CAAC;IAChD,IAAM,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;IAEvC,IAAM,gCAAgC,GAAG,yBAAyB,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IAC3F,IAAI,gCAAgC,EAAE;QACpC,OAAO,GAAG,SAAS,CAAC;QACpB,SAAS,GAAG,SAAS,CAAC;QAEtB,IACE,MAAM,CAAC,eAAe;YACtB,OAAO,MAAM,CAAC,eAAe,KAAK,QAAQ;YAC1C,MAAM,CAAC,eAAe,CAAC,SAAS;YAChC,OAAO,MAAM,CAAC,eAAe,CAAC,SAAS,KAAK,QAAQ,EACpD;YACA,IAAI,SAAS,IAAI,MAAM,CAAC,eAAe,CAAC,SAAS,EAAE;gBACjD,OAAO,GAAG,MAAM,CAAC,eAAe,CAAC,SAAS,CAAC,OAAO,CAAC;aACpD;YAED,IAAI,qBAAqB,IAAI,MAAM,CAAC,eAAe,CAAC,SAAS,EAAE;gBAC7D,mBAAmB,GAAG,MAAM,CAAC,eAAe,CAAC,SAAS,CAAC,mBAAmB,CAAC;aAC5E;YAED,IAAI,WAAW,IAAI,MAAM,CAAC,eAAe,CAAC,SAAS,IAAI,MAAM,CAAC,eAAe,CAAC,SAAS,CAAC,SAAS,EAAE;gBACjG,SAAS,GAAG,MAAM,CAAC,eAAe,CAAC,SAAS,CAAC,SAAS,CAAC;aACxD;YACD,IAAM,SAAS,GAAG,MAAM,CAAC,eAAe,CAAC,SAAS,CAAC;YACnD,IAAI,kBAAkB,IAAI,SAAS,EAAE;gBACnC,iBAAiB,GAAG,EAAE,gBAAgB,EAAE,SAAS,CAAC,gBAAgB,EAAE,CAAC;aACtE;SACF;KACF;IAED,kBACE,OAAO,SAAA,EACP,mBAAmB,qBAAA,EACnB,SAAS,WAAA,EACT,WAAW,aAAA,IACR,iBAAiB,EACpB;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,4BAA4B,GAAG,UAAC,MAAsB;IACjE,IACE,4BAA4B,CAAC,MAAM,CAAC,eAAe,CAAC;QACpD,MAAM,CAAC,eAAe;QACtB,OAAO,MAAM,CAAC,eAAe,KAAK,QAAQ;QAC1C,MAAM,CAAC,eAAe,CAAC,WAAW;QAClC,OAAO,MAAM,CAAC,eAAe,CAAC,WAAW,KAAK,QAAQ,EACtD;QACA,oBACK,MAAM,CAAC,eAAe,CAAC,WAAW,EACrC;KACH;IAED,OAAO,EAAE,CAAC;AACZ,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,yBAAyB,GAAG,UAAC,MAAsB;IAC9D,IACE,gCAAgC,CAAC,MAAM,CAAC,eAAe,CAAC;QACxD,MAAM,CAAC,eAAe;QACtB,OAAO,MAAM,CAAC,eAAe,KAAK,QAAQ;QAC1C,OAAO,MAAM,CAAC,eAAe,CAAC,gBAAgB,KAAK,QAAQ,EAC3D;QACA,OAAO,MAAM,CAAC,eAAe,CAAC,gBAAgB,CAAC;KAChD;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC","sourcesContent":["import {\n PageTrackingHistoryChanges,\n PageTrackingOptions,\n PageTrackingTrackOn,\n ElementInteractionsOptions,\n FormInteractionsOptions,\n BrowserOptions,\n AutocaptureOptions,\n AttributionOptions,\n NetworkTrackingOptions,\n FrustrationInteractionsOptions,\n CustomEnrichmentOptions,\n PerformanceTrackingOptions,\n WebVitalsOptions,\n isChromeExtension,\n normalizeNetworkCaptureRules,\n} from '@amplitude/analytics-core';\n\n/**\n * A subset of AutocaptureOptions that includes the autocapture features that\n * are made available to users by default (even if \"config.autocapture === undefined\")\n */\ntype AutocaptureOptionsDefaultAvailable = Pick<\n AutocaptureOptions,\n 'pageViews' | 'sessions' | 'fileDownloads' | 'formInteractions' | 'attribution' | 'pageUrlEnrichment'\n>;\n\n/**\n * Returns false if autocapture === false or if autocapture[event],\n * otherwise returns true (even if \"config.autocapture === undefined\")\n */\nconst isTrackingEnabled = (\n autocapture: AutocaptureOptionsDefaultAvailable | boolean | undefined,\n event: keyof AutocaptureOptionsDefaultAvailable,\n) => {\n if (typeof autocapture === 'boolean') {\n return autocapture;\n }\n\n if (autocapture?.[event] === false) {\n return false;\n }\n\n if (isChromeExtension()) {\n return !!autocapture?.[event];\n }\n\n return true;\n};\n\nexport const isAttributionTrackingEnabled = (autocapture: AutocaptureOptions | boolean | undefined) =>\n isTrackingEnabled(autocapture, 'attribution');\n\nexport const isFileDownloadTrackingEnabled = (autocapture: AutocaptureOptions | boolean | undefined) =>\n isTrackingEnabled(autocapture, 'fileDownloads');\n\nexport const isFormInteractionTrackingEnabled = (autocapture: AutocaptureOptions | boolean | undefined) =>\n isTrackingEnabled(autocapture, 'formInteractions');\n\nexport const isPageViewTrackingEnabled = (autocapture: AutocaptureOptions | boolean | undefined) =>\n isTrackingEnabled(autocapture, 'pageViews');\n\nexport const isSessionTrackingEnabled = (autocapture: AutocaptureOptions | boolean | undefined) =>\n isTrackingEnabled(autocapture, 'sessions');\n\nexport const isPageUrlEnrichmentEnabled = (autocapture: AutocaptureOptions | boolean | undefined) =>\n isTrackingEnabled(autocapture, 'pageUrlEnrichment');\n\n/**\n * Returns true if\n * 1. if autocapture.networkTracking === true\n * 2. if autocapture.networkTracking === object\n * otherwise returns false\n */\nexport const isNetworkTrackingEnabled = (autocapture: AutocaptureOptions | boolean | undefined) => {\n if (typeof autocapture === 'boolean') {\n return autocapture;\n }\n\n if (\n typeof autocapture === 'object' &&\n (autocapture.networkTracking === true || typeof autocapture.networkTracking === 'object')\n ) {\n return true;\n }\n\n return false;\n};\n\n/**\n * Returns true if\n * 1. autocapture === true\n * 2. if autocapture.elementInteractions === true\n * 3. if autocapture.elementInteractions === object\n * otherwise returns false\n */\nexport const isElementInteractionsEnabled = (autocapture: AutocaptureOptions | boolean | undefined): boolean => {\n if (typeof autocapture === 'boolean') {\n return autocapture;\n }\n\n if (\n typeof autocapture === 'object' &&\n (autocapture.elementInteractions === true || typeof autocapture.elementInteractions === 'object')\n ) {\n return true;\n }\n\n return false;\n};\n\n/**\n * Returns true if\n * 1. autocapture === true\n * 2. if autocapture.webVitals === true or is an options object\n * otherwise returns false\n */\nexport const isWebVitalsEnabled = (autocapture: AutocaptureOptions | boolean | undefined): boolean => {\n if (typeof autocapture === 'boolean') {\n return autocapture;\n }\n\n if (\n typeof autocapture === 'object' &&\n (autocapture.webVitals === true || (typeof autocapture.webVitals === 'object' && autocapture.webVitals !== null))\n ) {\n return true;\n }\n\n return false;\n};\n\n/**\n * Returns the web vitals options when autocapture.webVitals is configured with an options object,\n * otherwise returns undefined so the plugin falls back to its defaults.\n */\nexport const getWebVitalsConfig = (config: BrowserOptions): WebVitalsOptions | undefined => {\n if (typeof config.autocapture !== 'object') {\n return undefined;\n }\n\n const webVitals = config.autocapture.webVitals;\n\n if (typeof webVitals === 'object' && webVitals !== null) {\n return webVitals;\n }\n\n return undefined;\n};\n\nexport const isFrustrationInteractionsEnabled = (autocapture: AutocaptureOptions | boolean | undefined): boolean => {\n if (typeof autocapture === 'boolean') {\n return autocapture;\n }\n\n if (\n typeof autocapture === 'object' &&\n (autocapture.frustrationInteractions === true || typeof autocapture.frustrationInteractions === 'object')\n ) {\n return true;\n }\n\n return false;\n};\n\nexport const isPerformanceTrackingEnabled = (autocapture: AutocaptureOptions | boolean | undefined): boolean => {\n if (\n typeof autocapture === 'object' &&\n (autocapture.performanceTracking === true || typeof autocapture.performanceTracking === 'object')\n ) {\n return true;\n }\n\n return false;\n};\n\nexport const getPerformanceTrackingConfig = (config: BrowserOptions): PerformanceTrackingOptions | undefined => {\n if (typeof config.autocapture !== 'object') {\n return undefined;\n }\n\n const performanceTracking = config.autocapture.performanceTracking;\n\n if (performanceTracking === true) {\n return { mainThreadBlock: true };\n }\n\n if (typeof performanceTracking === 'object' && performanceTracking !== null) {\n return performanceTracking;\n }\n\n return undefined;\n};\n\nexport const isCustomEnrichmentEnabled = (customEnrichment: boolean | CustomEnrichmentOptions | undefined) => {\n if (typeof customEnrichment === 'boolean') {\n return customEnrichment;\n }\n\n if (typeof customEnrichment === 'object' && customEnrichment !== null && customEnrichment.enabled !== false) {\n return true;\n }\n\n return false;\n};\n\nexport const getElementInteractionsConfig = (config: BrowserOptions): ElementInteractionsOptions | undefined => {\n if (\n isElementInteractionsEnabled(config.autocapture) &&\n typeof config.autocapture === 'object' &&\n typeof config.autocapture.elementInteractions === 'object'\n ) {\n return config.autocapture.elementInteractions;\n }\n return undefined;\n};\n\nexport const getFrustrationInteractionsConfig = (\n config: BrowserOptions,\n): FrustrationInteractionsOptions | undefined => {\n if (\n isFrustrationInteractionsEnabled(config.autocapture) &&\n typeof config.autocapture === 'object' &&\n typeof config.autocapture.frustrationInteractions === 'object'\n ) {\n return config.autocapture.frustrationInteractions;\n }\n return undefined;\n};\n\nexport const getNetworkTrackingConfig = (config: BrowserOptions): NetworkTrackingOptions | undefined => {\n if (isNetworkTrackingEnabled(config.autocapture)) {\n let networkTrackingConfig;\n if (typeof config.autocapture === 'object' && typeof config.autocapture.networkTracking === 'object') {\n networkTrackingConfig = config.autocapture.networkTracking;\n } else if (config.networkTrackingOptions) {\n networkTrackingConfig = config.networkTrackingOptions;\n }\n return {\n ...networkTrackingConfig,\n captureRules: normalizeNetworkCaptureRules(networkTrackingConfig?.captureRules, config.loggerProvider),\n };\n }\n return;\n};\n\nexport const getPageViewTrackingConfig = (config: BrowserOptions): PageTrackingOptions => {\n let trackOn: PageTrackingTrackOn | undefined = () => false;\n let trackHistoryChanges: PageTrackingHistoryChanges | undefined = undefined;\n let eventType: string | undefined;\n let engagementOptions: PageTrackingOptions = {};\n const pageCounter = config.pageCounter;\n\n const isDefaultPageViewTrackingEnabled = isPageViewTrackingEnabled(config.defaultTracking);\n if (isDefaultPageViewTrackingEnabled) {\n trackOn = undefined;\n eventType = undefined;\n\n if (\n config.defaultTracking &&\n typeof config.defaultTracking === 'object' &&\n config.defaultTracking.pageViews &&\n typeof config.defaultTracking.pageViews === 'object'\n ) {\n if ('trackOn' in config.defaultTracking.pageViews) {\n trackOn = config.defaultTracking.pageViews.trackOn;\n }\n\n if ('trackHistoryChanges' in config.defaultTracking.pageViews) {\n trackHistoryChanges = config.defaultTracking.pageViews.trackHistoryChanges;\n }\n\n if ('eventType' in config.defaultTracking.pageViews && config.defaultTracking.pageViews.eventType) {\n eventType = config.defaultTracking.pageViews.eventType;\n }\n const pageViews = config.defaultTracking.pageViews;\n if ('trackEngagedTime' in pageViews) {\n engagementOptions = { trackEngagedTime: pageViews.trackEngagedTime };\n }\n }\n }\n\n return {\n trackOn,\n trackHistoryChanges,\n eventType,\n pageCounter,\n ...engagementOptions,\n };\n};\n\nexport const getAttributionTrackingConfig = (config: BrowserOptions): AttributionOptions => {\n if (\n isAttributionTrackingEnabled(config.defaultTracking) &&\n config.defaultTracking &&\n typeof config.defaultTracking === 'object' &&\n config.defaultTracking.attribution &&\n typeof config.defaultTracking.attribution === 'object'\n ) {\n return {\n ...config.defaultTracking.attribution,\n };\n }\n\n return {};\n};\n\nexport const getFormInteractionsConfig = (config: BrowserOptions): FormInteractionsOptions | undefined => {\n if (\n isFormInteractionTrackingEnabled(config.defaultTracking) &&\n config.defaultTracking &&\n typeof config.defaultTracking === 'object' &&\n typeof config.defaultTracking.formInteractions === 'object'\n ) {\n return config.defaultTracking.formInteractions;\n }\n return undefined;\n};\n"]}
|
package/lib/esm/types.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export { AmplitudeReturn, BaseEvent, EventOptions, BrowserClient, AttributionOptions, AutocaptureOptions, BrowserOptions, BrowserConfig, IConfig, Event, IdentifyEvent, GroupIdentifyEvent, IdentifyOperation, SpecialEventType, IIdentify, IRevenue, RevenueProperty, ILogger, LogLevel, Plugin, BeforePlugin, EnrichmentPlugin, DestinationPlugin, Result, ServerZoneType, ServerZone, IdentityStorageType, Storage, TransportType, OfflineDisabled, Messenger, ElementInteractionsOptions, ActionType, DEFAULT_CSS_SELECTOR_ALLOWLIST, DEFAULT_DATA_ATTRIBUTE_PREFIX, DEFAULT_ACTION_CLICK_ALLOWLIST, Campaign, ClickIdParameters, ReferrerParameters, UTMParameters, ValidPropertyType, ExcludeInternalReferrersOptions, EXCLUDE_INTERNAL_REFERRERS_CONDITIONS, } from '@amplitude/analytics-core';
|
|
1
|
+
export { AmplitudeReturn, BaseEvent, EventOptions, BrowserClient, AttributionOptions, AutocaptureOptions, EngagedTimeOptions, BrowserOptions, BrowserConfig, IConfig, Event, IdentifyEvent, GroupIdentifyEvent, IdentifyOperation, SpecialEventType, IIdentify, IRevenue, RevenueProperty, ILogger, LogLevel, Plugin, BeforePlugin, EnrichmentPlugin, DestinationPlugin, Result, ServerZoneType, ServerZone, IdentityStorageType, Storage, TransportType, OfflineDisabled, Messenger, ElementInteractionsOptions, ActionType, DEFAULT_CSS_SELECTOR_ALLOWLIST, DEFAULT_DATA_ATTRIBUTE_PREFIX, DEFAULT_ACTION_CLICK_ALLOWLIST, Campaign, ClickIdParameters, ReferrerParameters, UTMParameters, ValidPropertyType, ExcludeInternalReferrersOptions, EXCLUDE_INTERNAL_REFERRERS_CONDITIONS, } from '@amplitude/analytics-core';
|
|
2
2
|
//# sourceMappingURL=types.d.ts.map
|
package/lib/esm/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AACA,OAAO,EACL,eAAe,EACf,SAAS,EACT,YAAY,EACZ,aAAa,EACb,kBAAkB,EAClB,kBAAkB,EAClB,cAAc,EACd,aAAa,EACb,OAAO,EACP,KAAK,EACL,aAAa,EACb,kBAAkB,EAClB,iBAAiB,EACjB,gBAAgB,EAChB,SAAS,EACT,QAAQ,EACR,eAAe,EACf,OAAO,EACP,QAAQ,EACR,MAAM,EACN,YAAY,EACZ,gBAAgB,EAChB,iBAAiB,EACjB,MAAM,EACN,cAAc,EACd,UAAU,EACV,mBAAmB,EACnB,OAAO,EACP,aAAa,EACb,eAAe,EACf,SAAS,EACT,0BAA0B,EAC1B,UAAU,EACV,8BAA8B,EAC9B,6BAA6B,EAC7B,8BAA8B,EAC9B,QAAQ,EACR,iBAAiB,EACjB,kBAAkB,EAClB,aAAa,EACb,iBAAiB,EACjB,+BAA+B,EAC/B,qCAAqC,GACtC,MAAM,2BAA2B,CAAC"}
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AACA,OAAO,EACL,eAAe,EACf,SAAS,EACT,YAAY,EACZ,aAAa,EACb,kBAAkB,EAClB,kBAAkB,EAClB,kBAAkB,EAClB,cAAc,EACd,aAAa,EACb,OAAO,EACP,KAAK,EACL,aAAa,EACb,kBAAkB,EAClB,iBAAiB,EACjB,gBAAgB,EAChB,SAAS,EACT,QAAQ,EACR,eAAe,EACf,OAAO,EACP,QAAQ,EACR,MAAM,EACN,YAAY,EACZ,gBAAgB,EAChB,iBAAiB,EACjB,MAAM,EACN,cAAc,EACd,UAAU,EACV,mBAAmB,EACnB,OAAO,EACP,aAAa,EACb,eAAe,EACf,SAAS,EACT,0BAA0B,EAC1B,UAAU,EACV,8BAA8B,EAC9B,6BAA6B,EAC7B,8BAA8B,EAC9B,QAAQ,EACR,iBAAiB,EACjB,kBAAkB,EAClB,aAAa,EACb,iBAAiB,EACjB,+BAA+B,EAC/B,qCAAqC,GACtC,MAAM,2BAA2B,CAAC"}
|
package/lib/esm/types.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,OAAO,
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,OAAO,EAcL,iBAAiB,EACjB,gBAAgB,EAGhB,eAAe,EAEf,QAAQ,EAOR,UAAU,EAIV,eAAe,EAIf,8BAA8B,EAC9B,6BAA6B,EAC7B,8BAA8B,EAO9B,qCAAqC,GACtC,MAAM,2BAA2B,CAAC","sourcesContent":["/* eslint-disable @typescript-eslint/unbound-method */\nexport {\n AmplitudeReturn,\n BaseEvent,\n EventOptions,\n BrowserClient,\n AttributionOptions,\n AutocaptureOptions,\n EngagedTimeOptions,\n BrowserOptions,\n BrowserConfig,\n IConfig,\n Event,\n IdentifyEvent,\n GroupIdentifyEvent,\n IdentifyOperation,\n SpecialEventType,\n IIdentify,\n IRevenue,\n RevenueProperty,\n ILogger,\n LogLevel,\n Plugin,\n BeforePlugin,\n EnrichmentPlugin,\n DestinationPlugin,\n Result,\n ServerZoneType,\n ServerZone,\n IdentityStorageType,\n Storage,\n TransportType,\n OfflineDisabled,\n Messenger,\n ElementInteractionsOptions,\n ActionType,\n DEFAULT_CSS_SELECTOR_ALLOWLIST,\n DEFAULT_DATA_ATTRIBUTE_PREFIX,\n DEFAULT_ACTION_CLICK_ALLOWLIST,\n Campaign,\n ClickIdParameters,\n ReferrerParameters,\n UTMParameters,\n ValidPropertyType,\n ExcludeInternalReferrersOptions,\n EXCLUDE_INTERNAL_REFERRERS_CONDITIONS,\n} from '@amplitude/analytics-core';\n"]}
|
package/lib/esm/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "2.
|
|
1
|
+
export declare const VERSION = "2.49.0-video-analytics-8.0";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/lib/esm/version.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,
|
|
1
|
+
{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,+BAA+B,CAAC"}
|
package/lib/esm/version.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export var VERSION = '2.
|
|
1
|
+
export var VERSION = '2.49.0-video-analytics-8.0';
|
|
2
2
|
//# sourceMappingURL=version.js.map
|
package/lib/esm/version.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,IAAM,OAAO,GAAG,
|
|
1
|
+
{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,IAAM,OAAO,GAAG,4BAA4B,CAAC","sourcesContent":["export const VERSION = '2.49.0-video-analytics-8.0';\n"]}
|
|
@@ -1,20 +1,36 @@
|
|
|
1
|
-
import { BrowserClient, EmbeddedVideoPlayer, VideoVendor } from '@amplitude/analytics-core';
|
|
1
|
+
import { VideoState, BrowserClient, EmbeddedVideoPlayer, VideoVendor } from '@amplitude/analytics-core';
|
|
2
|
+
export type StreamingMediaType = 'video' | 'audio';
|
|
3
|
+
export type StreamingDeliveryMode = 'live' | 'on_demand';
|
|
2
4
|
export declare class VideoCapture {
|
|
3
5
|
private readonly amplitude;
|
|
4
6
|
private videoEl;
|
|
7
|
+
private heartbeat;
|
|
5
8
|
private embeddedVideoPlayer;
|
|
6
9
|
private vendor?;
|
|
7
10
|
private extraEventProperties;
|
|
11
|
+
private stopEvent;
|
|
8
12
|
private listeners;
|
|
9
13
|
private onRemoveListeners;
|
|
14
|
+
private playId;
|
|
15
|
+
private playStartPosition;
|
|
16
|
+
/**
|
|
17
|
+
* Observer `watchTime` already accumulated when the current `play_id` began.
|
|
18
|
+
* `play_time` is the watch time since this baseline.
|
|
19
|
+
*/
|
|
20
|
+
private playTimeBaseline;
|
|
21
|
+
/**
|
|
22
|
+
* Observer `watchTime` already accumulated when the current `stream_session_id` began.
|
|
23
|
+
* `play_time_total` is the watch time since this baseline.
|
|
24
|
+
*/
|
|
25
|
+
private sessionTimeBaseline;
|
|
10
26
|
constructor(amplitude: BrowserClient);
|
|
11
27
|
/**
|
|
12
|
-
* Specify a video element to capture events from
|
|
28
|
+
* Specify a video or audio element to capture events from
|
|
13
29
|
*
|
|
14
|
-
* @param videoEl - The HTML video element to capture events from.
|
|
30
|
+
* @param videoEl - The HTML video or audio element to capture events from.
|
|
15
31
|
* @returns The VideoCapture instance.
|
|
16
32
|
*/
|
|
17
|
-
withVideoElement(videoEl:
|
|
33
|
+
withVideoElement(videoEl: HTMLMediaElement): VideoCapture;
|
|
18
34
|
/**
|
|
19
35
|
* Specify an embedded video player.js instance to capture events from
|
|
20
36
|
* @param player - The embedded video player.js instance to capture events from.
|
|
@@ -35,23 +51,44 @@ export declare class VideoCapture {
|
|
|
35
51
|
* @returns The VideoCapture instance.
|
|
36
52
|
*/
|
|
37
53
|
withExtraEventProperties(properties: Record<string, string | number | boolean>): VideoCapture;
|
|
54
|
+
toAnalyticsEventProperties(eventProperties: Record<string, string | number | boolean> | undefined): Record<string, string | number | boolean>;
|
|
38
55
|
/**
|
|
39
|
-
* Track a "
|
|
56
|
+
* Track a "[Streaming] Stream Started" event every time the video starts playing
|
|
40
57
|
* @returns The VideoCapture instance.
|
|
41
58
|
*/
|
|
42
59
|
captureVideoStarted(): VideoCapture;
|
|
43
60
|
/**
|
|
44
|
-
* Track a "
|
|
61
|
+
* Track a "[Streaming] Stream Stopped" event every time the video stops playing
|
|
45
62
|
* @returns The VideoCapture instance.
|
|
46
63
|
*/
|
|
47
64
|
captureVideoStopped(): VideoCapture;
|
|
65
|
+
/**
|
|
66
|
+
* End the current play session by ingesting its queued delayed stop event immediately.
|
|
67
|
+
*
|
|
68
|
+
* The heartbeat is shared by every capture on the same Amplitude client, so the event is
|
|
69
|
+
* flushed rather than the heartbeat stopped, which would discard other captures' events.
|
|
70
|
+
* Flushing also drops the event from the heartbeat queue once ingested, so the interval
|
|
71
|
+
* winds down on its own. No-op when no play session is in progress.
|
|
72
|
+
*/
|
|
73
|
+
private flushStopEvent;
|
|
48
74
|
/**
|
|
49
75
|
* Start capturing analytics events for the video element
|
|
50
76
|
* @returns The VideoCapture instance.
|
|
51
77
|
* @throws An error if the video element is not specified.
|
|
52
78
|
*/
|
|
53
79
|
start(): VideoCapture;
|
|
54
|
-
|
|
80
|
+
/**
|
|
81
|
+
* Stop capturing analytics events for the video element.
|
|
82
|
+
*
|
|
83
|
+
* Observers are detached first so no playback state change can race with the final
|
|
84
|
+
* event, then any in-progress play session is closed out.
|
|
85
|
+
*/
|
|
86
|
+
stop(stopReason?: string): void;
|
|
87
|
+
parseStartEventProperties(nextState: VideoState): Record<string, string | number | boolean | undefined>;
|
|
88
|
+
private getMediaType;
|
|
89
|
+
parseStopEventProperties(nextState: VideoState): Record<string, string | number | boolean>;
|
|
90
|
+
/** Watch time elapsed since `baseline`. Missing or rewound watch time reports as 0. */
|
|
91
|
+
private watchedSince;
|
|
55
92
|
}
|
|
56
93
|
export type VideoCaptureOptions = {
|
|
57
94
|
vendor?: VideoVendor;
|
|
@@ -60,16 +97,16 @@ export type VideoCaptureOptions = {
|
|
|
60
97
|
type UntrackVideoResult = () => void;
|
|
61
98
|
export type TrackVideoResult = UntrackVideoResult | Error;
|
|
62
99
|
/**
|
|
63
|
-
* Track video analytics events for an HTML video element or embedded video player.js instance.
|
|
100
|
+
* Track video analytics events for an HTML video or audio element or embedded video player.js instance.
|
|
64
101
|
*
|
|
65
|
-
* Captures
|
|
102
|
+
* Captures [Streaming] Stream Started and [Streaming] Stream Stopped events.
|
|
66
103
|
*
|
|
67
104
|
* @experimental This function is experimental and may not be stable.
|
|
68
105
|
* @param amplitude - The Amplitude client instance.
|
|
69
|
-
* @param videoEl - The HTML video element or embedded video player.js instance to capture events from.
|
|
106
|
+
* @param videoEl - The HTML video or audio element or embedded video player.js instance to capture events from.
|
|
70
107
|
* @param options - The options for the video capture.
|
|
71
108
|
* @returns A function to stop the video capture.
|
|
72
109
|
*/
|
|
73
|
-
export declare function trackVideo(amplitude: BrowserClient, videoEl:
|
|
110
|
+
export declare function trackVideo(amplitude: BrowserClient, videoEl: HTMLMediaElement | EmbeddedVideoPlayer, options?: VideoCaptureOptions): TrackVideoResult;
|
|
74
111
|
export {};
|
|
75
112
|
//# sourceMappingURL=video-capture.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"video-capture.d.ts","sourceRoot":"","sources":["../../../src/video-capture/video-capture.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"video-capture.d.ts","sourceRoot":"","sources":["../../../src/video-capture/video-capture.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EAEV,aAAa,EACb,mBAAmB,EACnB,WAAW,EAMZ,MAAM,2BAA2B,CAAC;AAMnC,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG,OAAO,CAAC;AAEnD,MAAM,MAAM,qBAAqB,GAAG,MAAM,GAAG,WAAW,CAAC;AA0EzD,qBAAa,YAAY;IAsBX,OAAO,CAAC,QAAQ,CAAC,SAAS;IArBtC,OAAO,CAAC,OAAO,CAAiC;IAChD,OAAO,CAAC,SAAS,CAA0C;IAC3D,OAAO,CAAC,mBAAmB,CAAoC;IAC/D,OAAO,CAAC,MAAM,CAAC,CAAc;IAC7B,OAAO,CAAC,oBAAoB,CAAiD;IAC7E,OAAO,CAAC,SAAS,CAA0B;IAC3C,OAAO,CAAC,SAAS,CAAsE;IACvF,OAAO,CAAC,iBAAiB,CAAsB;IAC/C,OAAO,CAAC,MAAM,CAAuB;IACrC,OAAO,CAAC,iBAAiB,CAAuB;IAChD;;;OAGG;IACH,OAAO,CAAC,gBAAgB,CAAK;IAC7B;;;OAGG;IACH,OAAO,CAAC,mBAAmB,CAAK;gBAEH,SAAS,EAAE,aAAa;IAIrD;;;;;OAKG;IACH,gBAAgB,CAAC,OAAO,EAAE,gBAAgB,GAAG,YAAY;IAKzD;;;;OAIG;IACH,kBAAkB,CAAC,MAAM,EAAE,mBAAmB,GAAG,YAAY;IAK7D;;;;;OAKG;IACH,UAAU,CAAC,MAAM,EAAE,WAAW,GAAG,YAAY;IAK7C;;;;;OAKG;IACH,wBAAwB,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,GAAG,YAAY;IAK7F,0BAA0B,CACxB,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,GAAG,SAAS,GACrE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IAY5C;;;OAGG;IACH,mBAAmB,IAAI,YAAY;IAiDnC;;;OAGG;IACH,mBAAmB,IAAI,YAAY;IAuBnC;;;;;;;OAOG;IACH,OAAO,CAAC,cAAc;IAwBtB;;;;OAIG;IACH,KAAK,IAAI,YAAY;IAqCrB;;;;;OAKG;IACH,IAAI,CAAC,UAAU,SAAc;IAM7B,yBAAyB,CAAC,SAAS,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;IAUvG,OAAO,CAAC,YAAY;IAIpB,wBAAwB,CAAC,SAAS,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IAW1F,uFAAuF;IACvF,OAAO,CAAC,YAAY;CAIrB;AASD,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;CAClE,CAAC;AAEF,KAAK,kBAAkB,GAAG,MAAM,IAAI,CAAC;AAErC,MAAM,MAAM,gBAAgB,GAAG,kBAAkB,GAAG,KAAK,CAAC;AAE1D;;;;;;;;;;GAUG;AACH,wBAAgB,UAAU,CACxB,SAAS,EAAE,aAAa,EACxB,OAAO,EAAE,gBAAgB,GAAG,mBAAmB,EAC/C,OAAO,GAAE,mBAAwB,GAChC,gBAAgB,CA0BlB"}
|
|
@@ -1,18 +1,84 @@
|
|
|
1
|
-
import { __assign } from "tslib";
|
|
2
|
-
import { VideoObserver, UUID, } from '@amplitude/analytics-core';
|
|
1
|
+
import { __assign, __read, __values } from "tslib";
|
|
2
|
+
import { VideoObserver, UUID, getHeartbeatInstance, getGlobalScope, } from '@amplitude/analytics-core';
|
|
3
|
+
import { DEFAULT_STREAM_STARTED_EVENT, DEFAULT_STREAM_STOPPED_EVENT } from '../constants';
|
|
4
|
+
/** Playback states where a view session is still in progress (e.g. buffering). */
|
|
5
|
+
var ACTIVE_PLAYBACK_STATES = new Set(['playing', 'waiting']);
|
|
6
|
+
var eventPropNames = {
|
|
7
|
+
// shared events
|
|
8
|
+
content_id: '[Streaming] Content ID',
|
|
9
|
+
title: '[Streaming] Title',
|
|
10
|
+
media_type: '[Streaming] Media Type',
|
|
11
|
+
delivery_mode: '[Streaming] Delivery Mode',
|
|
12
|
+
stream_session_id: '[Streaming] Stream Session ID',
|
|
13
|
+
play_id: '[Streaming] Play ID',
|
|
14
|
+
start_position: '[Streaming] Start Position Sec',
|
|
15
|
+
position: '[Streaming] Position Sec',
|
|
16
|
+
duration: '[Streaming] Duration Sec',
|
|
17
|
+
// stop events
|
|
18
|
+
play_time: '[Streaming] Play Time Sec',
|
|
19
|
+
play_time_total: '[Streaming] Play Time Total Sec',
|
|
20
|
+
percent_completed: '[Streaming] Percent Completed',
|
|
21
|
+
stop_reason: '[Streaming] Stop Reason',
|
|
22
|
+
error_message: '[Streaming] Error Message',
|
|
23
|
+
};
|
|
24
|
+
/**
|
|
25
|
+
* Observer fields that never reach event properties from `lastEvent`: `position` is taken from
|
|
26
|
+
* observer state instead, and `percent_completed`/`stop_reason` describe the player event rather
|
|
27
|
+
* than the play session, which tracks its own values.
|
|
28
|
+
*/
|
|
29
|
+
var OMITTED_VIDEO_EVENT_PROPERTIES = new Set(['position', 'percent_completed', 'stop_reason']);
|
|
30
|
+
/**
|
|
31
|
+
* Copy remaining player-event fields (vendor metadata such as `mux_playback_id`, ids, titles)
|
|
32
|
+
* onto the Amplitude event, dropping empty values so absent metadata is omitted.
|
|
33
|
+
*/
|
|
34
|
+
function parseVideoEventProperties(lastEvent) {
|
|
35
|
+
var e_1, _a;
|
|
36
|
+
var properties = {};
|
|
37
|
+
try {
|
|
38
|
+
for (var _b = __values(Object.entries(lastEvent !== null && lastEvent !== void 0 ? lastEvent : {})), _c = _b.next(); !_c.done; _c = _b.next()) {
|
|
39
|
+
var _d = __read(_c.value, 2), key = _d[0], value = _d[1];
|
|
40
|
+
if (OMITTED_VIDEO_EVENT_PROPERTIES.has(key) || value === null || value === undefined) {
|
|
41
|
+
continue;
|
|
42
|
+
}
|
|
43
|
+
properties[key] = value;
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
catch (e_1_1) { e_1 = { error: e_1_1 }; }
|
|
47
|
+
finally {
|
|
48
|
+
try {
|
|
49
|
+
if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
|
|
50
|
+
}
|
|
51
|
+
finally { if (e_1) throw e_1.error; }
|
|
52
|
+
}
|
|
53
|
+
return properties;
|
|
54
|
+
}
|
|
3
55
|
var VideoCapture = /** @class */ (function () {
|
|
4
56
|
function VideoCapture(amplitude) {
|
|
5
57
|
this.amplitude = amplitude;
|
|
6
58
|
this.videoEl = null;
|
|
7
59
|
this.embeddedVideoPlayer = null;
|
|
8
60
|
this.extraEventProperties = {};
|
|
61
|
+
this.stopEvent = null;
|
|
9
62
|
this.listeners = [];
|
|
10
63
|
this.onRemoveListeners = [];
|
|
64
|
+
this.playId = null;
|
|
65
|
+
this.playStartPosition = null;
|
|
66
|
+
/**
|
|
67
|
+
* Observer `watchTime` already accumulated when the current `play_id` began.
|
|
68
|
+
* `play_time` is the watch time since this baseline.
|
|
69
|
+
*/
|
|
70
|
+
this.playTimeBaseline = 0;
|
|
71
|
+
/**
|
|
72
|
+
* Observer `watchTime` already accumulated when the current `stream_session_id` began.
|
|
73
|
+
* `play_time_total` is the watch time since this baseline.
|
|
74
|
+
*/
|
|
75
|
+
this.sessionTimeBaseline = 0;
|
|
76
|
+
this.heartbeat = getHeartbeatInstance(this.amplitude);
|
|
11
77
|
}
|
|
12
78
|
/**
|
|
13
|
-
* Specify a video element to capture events from
|
|
79
|
+
* Specify a video or audio element to capture events from
|
|
14
80
|
*
|
|
15
|
-
* @param videoEl - The HTML video element to capture events from.
|
|
81
|
+
* @param videoEl - The HTML video or audio element to capture events from.
|
|
16
82
|
* @returns The VideoCapture instance.
|
|
17
83
|
*/
|
|
18
84
|
VideoCapture.prototype.withVideoElement = function (videoEl) {
|
|
@@ -48,34 +114,108 @@ var VideoCapture = /** @class */ (function () {
|
|
|
48
114
|
this.extraEventProperties = properties;
|
|
49
115
|
return this;
|
|
50
116
|
};
|
|
117
|
+
VideoCapture.prototype.toAnalyticsEventProperties = function (eventProperties) {
|
|
118
|
+
var e_2, _a;
|
|
119
|
+
var _b;
|
|
120
|
+
if (!eventProperties) {
|
|
121
|
+
return {};
|
|
122
|
+
}
|
|
123
|
+
var analyticsEventProperties = {};
|
|
124
|
+
try {
|
|
125
|
+
for (var _c = __values(Object.entries(eventProperties)), _d = _c.next(); !_d.done; _d = _c.next()) {
|
|
126
|
+
var _e = __read(_d.value, 2), key = _e[0], value = _e[1];
|
|
127
|
+
var analyticsKey = (_b = eventPropNames[key]) !== null && _b !== void 0 ? _b : key;
|
|
128
|
+
analyticsEventProperties[analyticsKey] = value;
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
catch (e_2_1) { e_2 = { error: e_2_1 }; }
|
|
132
|
+
finally {
|
|
133
|
+
try {
|
|
134
|
+
if (_d && !_d.done && (_a = _c.return)) _a.call(_c);
|
|
135
|
+
}
|
|
136
|
+
finally { if (e_2) throw e_2.error; }
|
|
137
|
+
}
|
|
138
|
+
return analyticsEventProperties;
|
|
139
|
+
};
|
|
51
140
|
/**
|
|
52
|
-
* Track a "
|
|
141
|
+
* Track a "[Streaming] Stream Started" event every time the video starts playing
|
|
53
142
|
* @returns The VideoCapture instance.
|
|
54
143
|
*/
|
|
55
144
|
VideoCapture.prototype.captureVideoStarted = function () {
|
|
56
145
|
var _this = this;
|
|
57
146
|
this.listeners.push(function (previousState, nextState) {
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
147
|
+
var _a, _b, _c, _d, _e;
|
|
148
|
+
var prevPlayback = previousState.playbackState;
|
|
149
|
+
var nextPlayback = nextState.playbackState;
|
|
150
|
+
if (prevPlayback === 'ended') {
|
|
151
|
+
_this.extraEventProperties.stream_session_id = UUID();
|
|
152
|
+
// the ended state's watch time belongs to the session that just finished
|
|
153
|
+
_this.sessionTimeBaseline = (_a = previousState.watchTime) !== null && _a !== void 0 ? _a : 0;
|
|
154
|
+
}
|
|
155
|
+
if (!ACTIVE_PLAYBACK_STATES.has(prevPlayback) && nextPlayback === 'playing') {
|
|
156
|
+
_this.playId = UUID();
|
|
157
|
+
_this.playStartPosition = (_d = (_b = nextState.position) !== null && _b !== void 0 ? _b : (_c = nextState.lastEvent) === null || _c === void 0 ? void 0 : _c.position) !== null && _d !== void 0 ? _d : 0;
|
|
158
|
+
_this.playTimeBaseline = (_e = previousState.watchTime) !== null && _e !== void 0 ? _e : 0;
|
|
159
|
+
var now = new Date().getTime();
|
|
160
|
+
var startEvent = {
|
|
161
|
+
insert_id: UUID(),
|
|
162
|
+
event_type: DEFAULT_STREAM_STARTED_EVENT,
|
|
163
|
+
time: now,
|
|
164
|
+
event_properties: __assign(__assign(__assign({}, _this.parseStartEventProperties(nextState)), _this.extraEventProperties), { play_id: _this.playId }),
|
|
165
|
+
};
|
|
166
|
+
_this.stopEvent = __assign(__assign({}, startEvent), { insert_id: UUID(), event_type: DEFAULT_STREAM_STOPPED_EVENT, time: now + 1, event_properties: _this.toAnalyticsEventProperties(__assign(__assign({ stop_reason: 'timeout', play_id: _this.playId }, _this.parseStopEventProperties(nextState)), _this.extraEventProperties)) });
|
|
167
|
+
_this.heartbeat
|
|
168
|
+
.trackNoDelay(__assign(__assign({}, startEvent), { event_properties: _this.toAnalyticsEventProperties(startEvent.event_properties) }))
|
|
169
|
+
.catch(function () { return _this.stop(); });
|
|
170
|
+
_this.heartbeat.track(_this.stopEvent).catch(function () { return _this.stop(); });
|
|
61
171
|
}
|
|
62
172
|
});
|
|
63
173
|
return this;
|
|
64
174
|
};
|
|
65
175
|
/**
|
|
66
|
-
* Track a "
|
|
176
|
+
* Track a "[Streaming] Stream Stopped" event every time the video stops playing
|
|
67
177
|
* @returns The VideoCapture instance.
|
|
68
178
|
*/
|
|
69
179
|
VideoCapture.prototype.captureVideoStopped = function () {
|
|
70
180
|
var _this = this;
|
|
71
181
|
this.listeners.push(function (previousState, nextState) {
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
182
|
+
var _a;
|
|
183
|
+
// update the delayed event properties to have
|
|
184
|
+
// the most up-to-date values
|
|
185
|
+
if (_this.stopEvent) {
|
|
186
|
+
_this.stopEvent.event_properties = _this.toAnalyticsEventProperties(__assign(__assign(__assign({}, _this.stopEvent.event_properties), _this.parseStopEventProperties(nextState)), _this.extraEventProperties));
|
|
187
|
+
_this.stopEvent.time = new Date().getTime();
|
|
188
|
+
void _this.heartbeat.update(_this.stopEvent);
|
|
189
|
+
}
|
|
190
|
+
if (ACTIVE_PLAYBACK_STATES.has(previousState.playbackState) &&
|
|
191
|
+
!ACTIVE_PLAYBACK_STATES.has(nextState.playbackState)) {
|
|
192
|
+
_this.flushStopEvent((_a = nextState.cause) !== null && _a !== void 0 ? _a : nextState.playbackState);
|
|
75
193
|
}
|
|
76
194
|
});
|
|
77
195
|
return this;
|
|
78
196
|
};
|
|
197
|
+
/**
|
|
198
|
+
* End the current play session by ingesting its queued delayed stop event immediately.
|
|
199
|
+
*
|
|
200
|
+
* The heartbeat is shared by every capture on the same Amplitude client, so the event is
|
|
201
|
+
* flushed rather than the heartbeat stopped, which would discard other captures' events.
|
|
202
|
+
* Flushing also drops the event from the heartbeat queue once ingested, so the interval
|
|
203
|
+
* winds down on its own. No-op when no play session is in progress.
|
|
204
|
+
*/
|
|
205
|
+
VideoCapture.prototype.flushStopEvent = function (stopReason) {
|
|
206
|
+
var _this = this;
|
|
207
|
+
var stopEvent = this.stopEvent;
|
|
208
|
+
if (!stopEvent) {
|
|
209
|
+
return;
|
|
210
|
+
}
|
|
211
|
+
// the next play queues a fresh delayed stop event
|
|
212
|
+
this.stopEvent = null;
|
|
213
|
+
this.playStartPosition = null;
|
|
214
|
+
stopEvent.event_properties = __assign(__assign({}, stopEvent.event_properties), { stop_reason: stopReason });
|
|
215
|
+
this.heartbeat
|
|
216
|
+
.trackNoDelay(__assign(__assign({}, stopEvent), { event_properties: this.toAnalyticsEventProperties(stopEvent.event_properties) }))
|
|
217
|
+
.catch(function () { return _this.stop(); });
|
|
218
|
+
};
|
|
79
219
|
// Placeholder: may need a generic state change listener to capture unusual events or to have
|
|
80
220
|
// more control over the event tracking.
|
|
81
221
|
// withStateChangeListener(listener: (previousState: VideoState, nextState: VideoState) => void): VideoCapture {
|
|
@@ -105,23 +245,61 @@ var VideoCapture = /** @class */ (function () {
|
|
|
105
245
|
this.onRemoveListeners.push(function () {
|
|
106
246
|
videoObserver.destroy();
|
|
107
247
|
});
|
|
248
|
+
if (getGlobalScope()) {
|
|
249
|
+
this.onRemoveListeners.push(this.heartbeat.beforePageHide(function () {
|
|
250
|
+
// if the page is exited, emit a final 'ended' stop event
|
|
251
|
+
_this.stop('ended');
|
|
252
|
+
}));
|
|
253
|
+
}
|
|
108
254
|
return this;
|
|
109
255
|
};
|
|
110
|
-
|
|
256
|
+
/**
|
|
257
|
+
* Stop capturing analytics events for the video element.
|
|
258
|
+
*
|
|
259
|
+
* Observers are detached first so no playback state change can race with the final
|
|
260
|
+
* event, then any in-progress play session is closed out.
|
|
261
|
+
*/
|
|
262
|
+
VideoCapture.prototype.stop = function (stopReason) {
|
|
263
|
+
if (stopReason === void 0) { stopReason = 'untracked'; }
|
|
111
264
|
this.onRemoveListeners.forEach(function (listener) { return listener(); });
|
|
112
265
|
this.onRemoveListeners = [];
|
|
266
|
+
this.flushStopEvent(stopReason);
|
|
267
|
+
};
|
|
268
|
+
VideoCapture.prototype.parseStartEventProperties = function (nextState) {
|
|
269
|
+
var _a, _b, _c, _d, _e;
|
|
270
|
+
return __assign(__assign({}, parseVideoEventProperties(nextState.lastEvent)), { duration: (_b = (_a = nextState.lastEvent) === null || _a === void 0 ? void 0 : _a.duration) !== null && _b !== void 0 ? _b : undefined, start_position: (_d = (_c = this.playStartPosition) !== null && _c !== void 0 ? _c : nextState.position) !== null && _d !== void 0 ? _d : 0, position: (_e = nextState.position) !== null && _e !== void 0 ? _e : 0, media_type: this.getMediaType() });
|
|
271
|
+
};
|
|
272
|
+
VideoCapture.prototype.getMediaType = function () {
|
|
273
|
+
return this.videoEl instanceof HTMLAudioElement ? 'audio' : 'video';
|
|
274
|
+
};
|
|
275
|
+
VideoCapture.prototype.parseStopEventProperties = function (nextState) {
|
|
276
|
+
var _a, _b, _c;
|
|
277
|
+
return __assign(__assign(__assign({}, this.parseStartEventProperties(nextState)), {
|
|
278
|
+
// watchTime accumulates for the whole element. Each play_id and stream session keeps its own slice.
|
|
279
|
+
play_time: this.watchedSince(nextState.watchTime, this.playTimeBaseline), play_time_total: this.watchedSince(nextState.watchTime, this.sessionTimeBaseline), percent_completed: calculatePercentCompleted((_a = nextState.position) !== null && _a !== void 0 ? _a : 0, (_c = (_b = nextState.lastEvent) === null || _b === void 0 ? void 0 : _b.duration) !== null && _c !== void 0 ? _c : 0) }), (nextState.errorMessage ? { error_message: nextState.errorMessage } : {}));
|
|
280
|
+
};
|
|
281
|
+
/** Watch time elapsed since `baseline`. Missing or rewound watch time reports as 0. */
|
|
282
|
+
VideoCapture.prototype.watchedSince = function (watchTime, baseline) {
|
|
283
|
+
var elapsed = (watchTime !== null && watchTime !== void 0 ? watchTime : 0) - baseline;
|
|
284
|
+
return elapsed > 0 ? elapsed : 0;
|
|
113
285
|
};
|
|
114
286
|
return VideoCapture;
|
|
115
287
|
}());
|
|
116
288
|
export { VideoCapture };
|
|
289
|
+
function calculatePercentCompleted(currentTime, duration) {
|
|
290
|
+
if (!Number.isFinite(currentTime) || !Number.isFinite(duration) || duration <= 0) {
|
|
291
|
+
return 0;
|
|
292
|
+
}
|
|
293
|
+
return Math.min(100, Math.max(0, (currentTime / duration) * 100));
|
|
294
|
+
}
|
|
117
295
|
/**
|
|
118
|
-
* Track video analytics events for an HTML video element or embedded video player.js instance.
|
|
296
|
+
* Track video analytics events for an HTML video or audio element or embedded video player.js instance.
|
|
119
297
|
*
|
|
120
|
-
* Captures
|
|
298
|
+
* Captures [Streaming] Stream Started and [Streaming] Stream Stopped events.
|
|
121
299
|
*
|
|
122
300
|
* @experimental This function is experimental and may not be stable.
|
|
123
301
|
* @param amplitude - The Amplitude client instance.
|
|
124
|
-
* @param videoEl - The HTML video element or embedded video player.js instance to capture events from.
|
|
302
|
+
* @param videoEl - The HTML video or audio element or embedded video player.js instance to capture events from.
|
|
125
303
|
* @param options - The options for the video capture.
|
|
126
304
|
* @returns A function to stop the video capture.
|
|
127
305
|
*/
|
|
@@ -129,7 +307,7 @@ export function trackVideo(amplitude, videoEl, options) {
|
|
|
129
307
|
var _a;
|
|
130
308
|
if (options === void 0) { options = {}; }
|
|
131
309
|
var videoCapture = new VideoCapture(amplitude);
|
|
132
|
-
if (videoEl instanceof
|
|
310
|
+
if (videoEl instanceof HTMLMediaElement) {
|
|
133
311
|
videoCapture.withVideoElement(videoEl);
|
|
134
312
|
}
|
|
135
313
|
else {
|
|
@@ -141,7 +319,7 @@ export function trackVideo(amplitude, videoEl, options) {
|
|
|
141
319
|
var extraEventProperties = (_a = options.extraEventProperties) !== null && _a !== void 0 ? _a : {};
|
|
142
320
|
try {
|
|
143
321
|
videoCapture
|
|
144
|
-
.withExtraEventProperties(__assign({
|
|
322
|
+
.withExtraEventProperties(__assign(__assign({}, extraEventProperties), { stream_session_id: UUID() }))
|
|
145
323
|
.captureVideoStarted()
|
|
146
324
|
.captureVideoStopped()
|
|
147
325
|
.start();
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"video-capture.js","sourceRoot":"","sources":["../../../src/video-capture/video-capture.ts"],"names":[],"mappings":";AAAA,OAAO,EAEL,aAAa,EAIb,IAAI,GACL,MAAM,2BAA2B,CAAC;AAEnC;IASE,sBAA6B,SAAwB;QAAxB,cAAS,GAAT,SAAS,CAAe;QAR7C,YAAO,GAA4B,IAAI,CAAC;QACxC,wBAAmB,GAA+B,IAAI,CAAC;QAEvD,yBAAoB,GAA8C,EAAE,CAAC;QAErE,cAAS,GAAmE,EAAE,CAAC;QAC/E,sBAAiB,GAAmB,EAAE,CAAC;IAES,CAAC;IAEzD;;;;;OAKG;IACH,uCAAgB,GAAhB,UAAiB,OAAyB;QACxC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,yCAAkB,GAAlB,UAAmB,MAA2B;QAC5C,IAAI,CAAC,mBAAmB,GAAG,MAAM,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,iCAAU,GAAV,UAAW,MAAmB;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,+CAAwB,GAAxB,UAAyB,UAAqD;QAC5E,IAAI,CAAC,oBAAoB,GAAG,UAAU,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,0CAAmB,GAAnB;QAAA,iBAWC;QAVC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAC,aAAa,EAAE,SAAS;YAC3C,IAAI,aAAa,CAAC,aAAa,KAAK,SAAS,IAAI,SAAS,CAAC,aAAa,KAAK,SAAS,EAAE;gBACtF,8CAA8C;gBAC9C,KAAI,CAAC,SAAS,CAAC,KAAK,CAAC,uBAAuB,wBACvC,SAAS,CAAC,SAAS,GACnB,KAAI,CAAC,oBAAoB,EAC5B,CAAC;aACJ;QACH,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,0CAAmB,GAAnB;QAAA,iBAYC;QAXC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAC,aAAa,EAAE,SAAS;YAC3C,IAAI,aAAa,CAAC,aAAa,KAAK,SAAS,IAAI,SAAS,CAAC,aAAa,KAAK,SAAS,EAAE;gBACtF,uCAAuC;gBACvC,KAAI,CAAC,SAAS,CAAC,KAAK,CAAC,uBAAuB,iCACvC,SAAS,CAAC,SAAS,KACtB,cAAc,EAAE,SAAS,CAAC,SAAS,KAChC,KAAI,CAAC,oBAAoB,EAC5B,CAAC;aACJ;QACH,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED,6FAA6F;IAC7F,wCAAwC;IACxC,gHAAgH;IAEhH;;;;OAIG;IACH,4BAAK,GAAL;QAAA,iBAyBC;;QAxBC,IAAM,OAAO,GAAG,MAAA,IAAI,CAAC,OAAO,mCAAI,IAAI,CAAC,mBAAmB,CAAC;QACzD,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,IAAI,KAAK,CACb,2GAA2G,CAC5G,CAAC;SACH;QACD,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,mBAAmB,EAAE;YAC5C,MAAM,IAAI,KAAK,CACb,kJAAkJ,CACnJ,CAAC;SACH;QACD,IAAM,aAAa,GAAG,IAAI,aAAa,CAAC;YACtC,OAAO,SAAA;YACP,aAAa,EAAE,UAAC,aAAa,EAAE,SAAS;gBACtC,KAAI,CAAC,SAAS,CAAC,OAAO,CAAC,UAAC,QAAQ,IAAK,OAAA,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,EAAlC,CAAkC,CAAC,CAAC;YAC3E,CAAC;YACD,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,mBAAmB;SACvC,CAAC,CAAC;QAEH,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC;YAC1B,aAAa,CAAC,OAAO,EAAE,CAAC;QAC1B,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED,2BAAI,GAAJ;QACE,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,UAAC,QAAQ,IAAK,OAAA,QAAQ,EAAE,EAAV,CAAU,CAAC,CAAC;QACzD,IAAI,CAAC,iBAAiB,GAAG,EAAE,CAAC;IAC9B,CAAC;IACH,mBAAC;AAAD,CAAC,AAjID,IAiIC;;AAWD;;;;;;;;;;GAUG;AACH,MAAM,UAAU,UAAU,CACxB,SAAwB,EACxB,OAA+C,EAC/C,OAAiC;;IAAjC,wBAAA,EAAA,YAAiC;IAEjC,IAAM,YAAY,GAAG,IAAI,YAAY,CAAC,SAAS,CAAC,CAAC;IACjD,IAAI,OAAO,YAAY,gBAAgB,EAAE;QACvC,YAAY,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;KACxC;SAAM;QACL,YAAY,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;KAC1C;IACD,IAAI,OAAO,CAAC,MAAM,EAAE;QAClB,YAAY,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;KACzC;IACD,IAAM,oBAAoB,GAAG,MAAA,OAAO,CAAC,oBAAoB,mCAAI,EAAE,CAAC;IAEhE,IAAI;QACF,YAAY;aACT,wBAAwB,YACvB,eAAe,EAAE,IAAI,EAAE,IACpB,oBAAoB,EACvB;aACD,mBAAmB,EAAE;aACrB,mBAAmB,EAAE;aACrB,KAAK,EAAE,CAAC;KACZ;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,KAAc,CAAC;KACvB;IAED,OAAO,cAAM,OAAA,YAAY,CAAC,IAAI,EAAE,EAAnB,CAAmB,CAAC;AACnC,CAAC","sourcesContent":["import {\n VideoState,\n VideoObserver,\n BrowserClient,\n EmbeddedVideoPlayer,\n VideoVendor,\n UUID,\n} from '@amplitude/analytics-core';\n\nexport class VideoCapture {\n private videoEl: HTMLVideoElement | null = null;\n private embeddedVideoPlayer: EmbeddedVideoPlayer | null = null;\n private vendor?: VideoVendor;\n private extraEventProperties: Record<string, string | number | boolean> = {};\n\n private listeners: ((previousState: VideoState, nextState: VideoState) => void)[] = [];\n private onRemoveListeners: (() => void)[] = [];\n\n constructor(private readonly amplitude: BrowserClient) {}\n\n /**\n * Specify a video element to capture events from\n *\n * @param videoEl - The HTML video element to capture events from.\n * @returns The VideoCapture instance.\n */\n withVideoElement(videoEl: HTMLVideoElement): VideoCapture {\n this.videoEl = videoEl;\n return this;\n }\n\n /**\n * Specify an embedded video player.js instance to capture events from\n * @param player - The embedded video player.js instance to capture events from.\n * @returns The VideoCapture instance.\n */\n withEmbeddedPlayer(player: EmbeddedVideoPlayer): VideoCapture {\n this.embeddedVideoPlayer = player;\n return this;\n }\n\n /**\n * Specify a vendor to capture extra vendor-specific event properties\n *\n * @param vendor - The vendor of the video player. Currently only \"mux\" is supported.\n * @returns The VideoCapture instance.\n */\n withVendor(vendor: VideoVendor): VideoCapture {\n this.vendor = vendor;\n return this;\n }\n\n /**\n * Specify extra event properties to include in all captured events\n *\n * @param properties - The extra event properties to include in the Amplitude event.\n * @returns The VideoCapture instance.\n */\n withExtraEventProperties(properties: Record<string, string | number | boolean>): VideoCapture {\n this.extraEventProperties = properties;\n return this;\n }\n\n /**\n * Track a \"Video Content Started\" event every time the video starts playing\n * @returns The VideoCapture instance.\n */\n captureVideoStarted(): VideoCapture {\n this.listeners.push((previousState, nextState) => {\n if (previousState.playbackState !== 'playing' && nextState.playbackState === 'playing') {\n // TODO: placeholder for Heartbeat Start Event\n this.amplitude.track('Video Content Started', {\n ...nextState.lastEvent,\n ...this.extraEventProperties,\n });\n }\n });\n return this;\n }\n\n /**\n * Track a \"Video Content Stopped\" event every time the video stops playing\n * @returns The VideoCapture instance.\n */\n captureVideoStopped(): VideoCapture {\n this.listeners.push((previousState, nextState) => {\n if (previousState.playbackState === 'playing' && nextState.playbackState !== 'playing') {\n // placeholder for Heartbeat Stop Event\n this.amplitude.track('Video Content Stopped', {\n ...nextState.lastEvent,\n watch_duration: nextState.watchTime,\n ...this.extraEventProperties,\n });\n }\n });\n return this;\n }\n\n // Placeholder: may need a generic state change listener to capture unusual events or to have\n // more control over the event tracking.\n // withStateChangeListener(listener: (previousState: VideoState, nextState: VideoState) => void): VideoCapture {\n\n /**\n * Start capturing analytics events for the video element\n * @returns The VideoCapture instance.\n * @throws An error if the video element is not specified.\n */\n start(): VideoCapture {\n const videoEl = this.videoEl ?? this.embeddedVideoPlayer;\n if (!videoEl) {\n throw new Error(\n 'Video element not specified. Use withVideoElement() or withEmbeddedPlayer() to specify the video element.',\n );\n }\n if (this.videoEl && this.embeddedVideoPlayer) {\n throw new Error(\n 'Both video element and embedded video player specified. Use only one of withVideoElement() or withEmbeddedPlayer() to specify the video element.',\n );\n }\n const videoObserver = new VideoObserver({\n videoEl,\n onStateChange: (previousState, nextState) => {\n this.listeners.forEach((listener) => listener(previousState, nextState));\n },\n vendor: this.vendor,\n isEmbedded: !!this.embeddedVideoPlayer,\n });\n\n this.onRemoveListeners.push(() => {\n videoObserver.destroy();\n });\n return this;\n }\n\n stop() {\n this.onRemoveListeners.forEach((listener) => listener());\n this.onRemoveListeners = [];\n }\n}\n\nexport type VideoCaptureOptions = {\n vendor?: VideoVendor;\n extraEventProperties?: Record<string, string | number | boolean>;\n};\n\ntype UntrackVideoResult = () => void;\n\nexport type TrackVideoResult = UntrackVideoResult | Error;\n\n/**\n * Track video analytics events for an HTML video element or embedded video player.js instance.\n *\n * Captures Video Started and Video Stopped events.\n *\n * @experimental This function is experimental and may not be stable.\n * @param amplitude - The Amplitude client instance.\n * @param videoEl - The HTML video element or embedded video player.js instance to capture events from.\n * @param options - The options for the video capture.\n * @returns A function to stop the video capture.\n */\nexport function trackVideo(\n amplitude: BrowserClient,\n videoEl: HTMLVideoElement | EmbeddedVideoPlayer,\n options: VideoCaptureOptions = {},\n): TrackVideoResult {\n const videoCapture = new VideoCapture(amplitude);\n if (videoEl instanceof HTMLVideoElement) {\n videoCapture.withVideoElement(videoEl);\n } else {\n videoCapture.withEmbeddedPlayer(videoEl);\n }\n if (options.vendor) {\n videoCapture.withVendor(options.vendor);\n }\n const extraEventProperties = options.extraEventProperties ?? {};\n\n try {\n videoCapture\n .withExtraEventProperties({\n view_session_id: UUID(),\n ...extraEventProperties,\n })\n .captureVideoStarted()\n .captureVideoStopped()\n .start();\n } catch (error) {\n return error as Error;\n }\n\n return () => videoCapture.stop();\n}\n"]}
|
|
1
|
+
{"version":3,"file":"video-capture.js","sourceRoot":"","sources":["../../../src/video-capture/video-capture.ts"],"names":[],"mappings":";AAAA,OAAO,EAEL,aAAa,EAKb,IAAI,EAEJ,oBAAoB,EACpB,cAAc,GACf,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,4BAA4B,EAAE,4BAA4B,EAAE,MAAM,cAAc,CAAC;AAE1F,kFAAkF;AAClF,IAAM,sBAAsB,GAAG,IAAI,GAAG,CAA8B,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;AAqC5F,IAAM,cAAc,GAA4F;IAC9G,gBAAgB;IAChB,UAAU,EAAE,wBAAwB;IACpC,KAAK,EAAE,mBAAmB;IAC1B,UAAU,EAAE,wBAAwB;IACpC,aAAa,EAAE,2BAA2B;IAC1C,iBAAiB,EAAE,+BAA+B;IAClD,OAAO,EAAE,qBAAqB;IAC9B,cAAc,EAAE,gCAAgC;IAChD,QAAQ,EAAE,0BAA0B;IACpC,QAAQ,EAAE,0BAA0B;IACpC,cAAc;IACd,SAAS,EAAE,2BAA2B;IACtC,eAAe,EAAE,iCAAiC;IAClD,iBAAiB,EAAE,+BAA+B;IAClD,WAAW,EAAE,yBAAyB;IACtC,aAAa,EAAE,2BAA2B;CAC3C,CAAC;AAEF;;;;GAIG;AACH,IAAM,8BAA8B,GAAG,IAAI,GAAG,CAAC,CAAC,UAAU,EAAE,mBAAmB,EAAE,aAAa,CAAC,CAAC,CAAC;AAEjG;;;GAGG;AACH,SAAS,yBAAyB,CAAC,SAAkC;;IACnE,IAAM,UAAU,GAA8C,EAAE,CAAC;;QACjE,KAA2B,IAAA,KAAA,SAAA,MAAM,CAAC,OAAO,CAAC,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,EAAE,CAAC,CAAA,gBAAA,4BAAE;YAAjD,IAAA,KAAA,mBAAY,EAAX,GAAG,QAAA,EAAE,KAAK,QAAA;YACpB,IAAI,8BAA8B,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE;gBACpF,SAAS;aACV;YACD,UAAU,CAAC,GAAG,CAAC,GAAG,KAAkC,CAAC;SACtD;;;;;;;;;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;IAsBE,sBAA6B,SAAwB;QAAxB,cAAS,GAAT,SAAS,CAAe;QArB7C,YAAO,GAA4B,IAAI,CAAC;QAExC,wBAAmB,GAA+B,IAAI,CAAC;QAEvD,yBAAoB,GAA8C,EAAE,CAAC;QACrE,cAAS,GAAqB,IAAI,CAAC;QACnC,cAAS,GAAmE,EAAE,CAAC;QAC/E,sBAAiB,GAAmB,EAAE,CAAC;QACvC,WAAM,GAAkB,IAAI,CAAC;QAC7B,sBAAiB,GAAkB,IAAI,CAAC;QAChD;;;WAGG;QACK,qBAAgB,GAAG,CAAC,CAAC;QAC7B;;;WAGG;QACK,wBAAmB,GAAG,CAAC,CAAC;QAG9B,IAAI,CAAC,SAAS,GAAG,oBAAoB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACH,uCAAgB,GAAhB,UAAiB,OAAyB;QACxC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,yCAAkB,GAAlB,UAAmB,MAA2B;QAC5C,IAAI,CAAC,mBAAmB,GAAG,MAAM,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,iCAAU,GAAV,UAAW,MAAmB;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,+CAAwB,GAAxB,UAAyB,UAAqD;QAC5E,IAAI,CAAC,oBAAoB,GAAG,UAAU,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,iDAA0B,GAA1B,UACE,eAAsE;;;QAEtE,IAAI,CAAC,eAAe,EAAE;YACpB,OAAO,EAAE,CAAC;SACX;QACD,IAAM,wBAAwB,GAA8C,EAAE,CAAC;;YAC/E,KAA2B,IAAA,KAAA,SAAA,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAA,gBAAA,4BAAE;gBAAjD,IAAA,KAAA,mBAAY,EAAX,GAAG,QAAA,EAAE,KAAK,QAAA;gBACpB,IAAM,YAAY,GAAG,MAAA,cAAc,CAAC,GAAG,CAAC,mCAAI,GAAG,CAAC;gBAChD,wBAAwB,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC;aAChD;;;;;;;;;QACD,OAAO,wBAAwB,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,0CAAmB,GAAnB;QAAA,iBA+CC;QA9CC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAC,aAAa,EAAE,SAAS;;YAC3C,IAAM,YAAY,GAAG,aAAa,CAAC,aAAa,CAAC;YACjD,IAAM,YAAY,GAAG,SAAS,CAAC,aAAa,CAAC;YAC7C,IAAI,YAAY,KAAK,OAAO,EAAE;gBAC5B,KAAI,CAAC,oBAAoB,CAAC,iBAAiB,GAAG,IAAI,EAAE,CAAC;gBACrD,yEAAyE;gBACzE,KAAI,CAAC,mBAAmB,GAAG,MAAA,aAAa,CAAC,SAAS,mCAAI,CAAC,CAAC;aACzD;YACD,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,YAAY,KAAK,SAAS,EAAE;gBAC3E,KAAI,CAAC,MAAM,GAAG,IAAI,EAAE,CAAC;gBACrB,KAAI,CAAC,iBAAiB,GAAG,MAAA,MAAA,SAAS,CAAC,QAAQ,mCAAI,MAAA,SAAS,CAAC,SAAS,0CAAE,QAAQ,mCAAI,CAAC,CAAC;gBAClF,KAAI,CAAC,gBAAgB,GAAG,MAAA,aAAa,CAAC,SAAS,mCAAI,CAAC,CAAC;gBACrD,IAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;gBACjC,IAAM,UAAU,GAAc;oBAC5B,SAAS,EAAE,IAAI,EAAE;oBACjB,UAAU,EAAE,4BAA4B;oBACxC,IAAI,EAAE,GAAG;oBACT,gBAAgB,iCACX,KAAI,CAAC,yBAAyB,CAAC,SAAS,CAAC,GACzC,KAAI,CAAC,oBAAoB,KAC5B,OAAO,EAAE,KAAI,CAAC,MAAM,GACrB;iBACF,CAAC;gBACF,KAAI,CAAC,SAAS,yBACT,UAAU,KACb,SAAS,EAAE,IAAI,EAAE,EACjB,UAAU,EAAE,4BAA4B,EACxC,IAAI,EAAE,GAAG,GAAG,CAAC,EACb,gBAAgB,EAAE,KAAI,CAAC,0BAA0B,qBAC/C,WAAW,EAAE,SAAS,EACtB,OAAO,EAAE,KAAI,CAAC,MAAM,IACjB,KAAI,CAAC,wBAAwB,CAAC,SAAS,CAAC,GACxC,KAAI,CAAC,oBAAoB,EAC5B,GACH,CAAC;gBACF,KAAI,CAAC,SAAS;qBACX,YAAY,uBACR,UAAU,KACb,gBAAgB,EAAE,KAAI,CAAC,0BAA0B,CAAC,UAAU,CAAC,gBAAgB,CAAC,IAC9E;qBACD,KAAK,CAAC,cAAM,OAAA,KAAI,CAAC,IAAI,EAAE,EAAX,CAAW,CAAC,CAAC;gBAC5B,KAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAI,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,cAAM,OAAA,KAAI,CAAC,IAAI,EAAE,EAAX,CAAW,CAAC,CAAC;aAC/D;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,0CAAmB,GAAnB;QAAA,iBAqBC;QApBC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAC,aAAa,EAAE,SAAS;;YAC3C,8CAA8C;YAC9C,6BAA6B;YAC7B,IAAI,KAAI,CAAC,SAAS,EAAE;gBAClB,KAAI,CAAC,SAAS,CAAC,gBAAgB,GAAG,KAAI,CAAC,0BAA0B,gCAC5D,KAAI,CAAC,SAAS,CAAC,gBAAgB,GAC/B,KAAI,CAAC,wBAAwB,CAAC,SAAS,CAAC,GACxC,KAAI,CAAC,oBAAoB,EAC5B,CAAC;gBACH,KAAI,CAAC,SAAS,CAAC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;gBAC3C,KAAK,KAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAI,CAAC,SAAS,CAAC,CAAC;aAC5C;YACD,IACE,sBAAsB,CAAC,GAAG,CAAC,aAAa,CAAC,aAAa,CAAC;gBACvD,CAAC,sBAAsB,CAAC,GAAG,CAAC,SAAS,CAAC,aAAa,CAAC,EACpD;gBACA,KAAI,CAAC,cAAc,CAAC,MAAA,SAAS,CAAC,KAAK,mCAAI,SAAS,CAAC,aAAa,CAAC,CAAC;aACjE;QACH,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACK,qCAAc,GAAtB,UAAuB,UAAkB;QAAzC,iBAkBC;QAjBC,IAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,SAAS,EAAE;YACd,OAAO;SACR;QACD,kDAAkD;QAClD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;QAC9B,SAAS,CAAC,gBAAgB,yBACrB,SAAS,CAAC,gBAAgB,KAC7B,WAAW,EAAE,UAAU,GACxB,CAAC;QACF,IAAI,CAAC,SAAS;aACX,YAAY,uBACR,SAAS,KACZ,gBAAgB,EAAE,IAAI,CAAC,0BAA0B,CAAC,SAAS,CAAC,gBAAgB,CAAC,IAC7E;aACD,KAAK,CAAC,cAAM,OAAA,KAAI,CAAC,IAAI,EAAE,EAAX,CAAW,CAAC,CAAC;IAC9B,CAAC;IAED,6FAA6F;IAC7F,wCAAwC;IACxC,gHAAgH;IAEhH;;;;OAIG;IACH,4BAAK,GAAL;QAAA,iBAmCC;;QAlCC,IAAM,OAAO,GAAG,MAAA,IAAI,CAAC,OAAO,mCAAI,IAAI,CAAC,mBAAmB,CAAC;QACzD,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,IAAI,KAAK,CACb,2GAA2G,CAC5G,CAAC;SACH;QACD,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,mBAAmB,EAAE;YAC5C,MAAM,IAAI,KAAK,CACb,kJAAkJ,CACnJ,CAAC;SACH;QACD,IAAM,aAAa,GAAG,IAAI,aAAa,CAAC;YACtC,OAAO,SAAA;YACP,aAAa,EAAE,UAAC,aAAa,EAAE,SAAS;gBACtC,KAAI,CAAC,SAAS,CAAC,OAAO,CAAC,UAAC,QAAQ,IAAK,OAAA,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,EAAlC,CAAkC,CAAC,CAAC;YAC3E,CAAC;YACD,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,mBAAmB;SACvC,CAAC,CAAC;QAEH,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC;YAC1B,aAAa,CAAC,OAAO,EAAE,CAAC;QAC1B,CAAC,CAAC,CAAC;QAEH,IAAI,cAAc,EAAE,EAAE;YACpB,IAAI,CAAC,iBAAiB,CAAC,IAAI,CACzB,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC;gBAC5B,yDAAyD;gBACzD,KAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACrB,CAAC,CAAC,CACH,CAAC;SACH;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,2BAAI,GAAJ,UAAK,UAAwB;QAAxB,2BAAA,EAAA,wBAAwB;QAC3B,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,UAAC,QAAQ,IAAK,OAAA,QAAQ,EAAE,EAAV,CAAU,CAAC,CAAC;QACzD,IAAI,CAAC,iBAAiB,GAAG,EAAE,CAAC;QAC5B,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAClC,CAAC;IAED,gDAAyB,GAAzB,UAA0B,SAAqB;;QAC7C,6BACK,yBAAyB,CAAC,SAAS,CAAC,SAAS,CAAC,KACjD,QAAQ,EAAE,MAAA,MAAA,SAAS,CAAC,SAAS,0CAAE,QAAQ,mCAAI,SAAS,EACpD,cAAc,EAAE,MAAA,MAAA,IAAI,CAAC,iBAAiB,mCAAI,SAAS,CAAC,QAAQ,mCAAI,CAAC,EACjE,QAAQ,EAAE,MAAA,SAAS,CAAC,QAAQ,mCAAI,CAAC,EACjC,UAAU,EAAE,IAAI,CAAC,YAAY,EAAE,IAC/B;IACJ,CAAC;IAEO,mCAAY,GAApB;QACE,OAAO,IAAI,CAAC,OAAO,YAAY,gBAAgB,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC;IACtE,CAAC;IAED,+CAAwB,GAAxB,UAAyB,SAAqB;;QAC5C,sCACK,IAAI,CAAC,yBAAyB,CAAC,SAAS,CAAC;YAC5C,oGAAoG;YACpG,SAAS,EAAE,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,gBAAgB,CAAC,EACxE,eAAe,EAAE,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,mBAAmB,CAAC,EACjF,iBAAiB,EAAE,yBAAyB,CAAC,MAAA,SAAS,CAAC,QAAQ,mCAAI,CAAC,EAAE,MAAA,MAAA,SAAS,CAAC,SAAS,0CAAE,QAAQ,mCAAI,CAAC,CAAC,KACtG,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,SAAS,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAC5E;IACJ,CAAC;IAED,uFAAuF;IAC/E,mCAAY,GAApB,UAAqB,SAA6B,EAAE,QAAgB;QAClE,IAAM,OAAO,GAAG,CAAC,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,CAAC,CAAC,GAAG,QAAQ,CAAC;QAC5C,OAAO,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IACnC,CAAC;IACH,mBAAC;AAAD,CAAC,AAvRD,IAuRC;;AAED,SAAS,yBAAyB,CAAC,WAAmB,EAAE,QAAgB;IACtE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,QAAQ,IAAI,CAAC,EAAE;QAChF,OAAO,CAAC,CAAC;KACV;IACD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,WAAW,GAAG,QAAQ,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;AACpE,CAAC;AAWD;;;;;;;;;;GAUG;AACH,MAAM,UAAU,UAAU,CACxB,SAAwB,EACxB,OAA+C,EAC/C,OAAiC;;IAAjC,wBAAA,EAAA,YAAiC;IAEjC,IAAM,YAAY,GAAG,IAAI,YAAY,CAAC,SAAS,CAAC,CAAC;IACjD,IAAI,OAAO,YAAY,gBAAgB,EAAE;QACvC,YAAY,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;KACxC;SAAM;QACL,YAAY,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;KAC1C;IACD,IAAI,OAAO,CAAC,MAAM,EAAE;QAClB,YAAY,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;KACzC;IACD,IAAM,oBAAoB,GAAG,MAAA,OAAO,CAAC,oBAAoB,mCAAI,EAAE,CAAC;IAEhE,IAAI;QACF,YAAY;aACT,wBAAwB,uBACpB,oBAAoB,KACvB,iBAAiB,EAAE,IAAI,EAAE,IACzB;aACD,mBAAmB,EAAE;aACrB,mBAAmB,EAAE;aACrB,KAAK,EAAE,CAAC;KACZ;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,KAAc,CAAC;KACvB;IAED,OAAO,cAAM,OAAA,YAAY,CAAC,IAAI,EAAE,EAAnB,CAAmB,CAAC;AACnC,CAAC","sourcesContent":["import {\n VideoState,\n VideoObserver,\n BrowserClient,\n EmbeddedVideoPlayer,\n VideoVendor,\n VideoStopCause,\n UUID,\n BaseEvent,\n getHeartbeatInstance,\n getGlobalScope,\n} from '@amplitude/analytics-core';\nimport { DEFAULT_STREAM_STARTED_EVENT, DEFAULT_STREAM_STOPPED_EVENT } from '../constants';\n\n/** Playback states where a view session is still in progress (e.g. buffering). */\nconst ACTIVE_PLAYBACK_STATES = new Set<VideoState['playbackState']>(['playing', 'waiting']);\n\nexport type StreamingMediaType = 'video' | 'audio';\n\nexport type StreamingDeliveryMode = 'live' | 'on_demand';\n\ntype StreamingEventProperties = {\n /** Omitted when not set. */\n '[Streaming] Content ID'?: string;\n /** Omitted when not set. */\n '[Streaming] Title'?: string;\n '[Streaming] Media Type': StreamingMediaType;\n /** `on_demand` when duration is known, `live` when it is not, unless the app sets it. */\n '[Streaming] Delivery Mode': StreamingDeliveryMode;\n '[Streaming] Stream Session ID': string;\n '[Streaming] Play ID': string;\n /** Playhead seconds where this play started. */\n '[Streaming] Start Position Sec': number;\n /** Playhead seconds when the event was recorded. */\n '[Streaming] Position Sec': number;\n /** Omitted when unknown, including live streams. */\n '[Streaming] Duration Sec'?: number;\n};\n\ntype StreamStartedEventProperties = StreamingEventProperties;\n\ntype StreamStoppedEventProperties = StreamingEventProperties & {\n /** Seconds the playhead advanced while playing for this Play ID. Resets on pause. */\n '[Streaming] Play Time Sec': number;\n /** Running total of Play Time Sec for this Stream Session ID. Latest event carries the total. */\n '[Streaming] Play Time Total Sec': number;\n /** Position Sec as a percentage of Duration Sec (0–100). Omitted when Duration Sec is unknown. */\n '[Streaming] Percent Completed'?: number;\n '[Streaming] Stop Reason': VideoStopCause;\n '[Streaming] Error Message'?: string;\n};\n\nconst eventPropNames: Record<string, keyof StreamStartedEventProperties | keyof StreamStoppedEventProperties> = {\n // shared events\n content_id: '[Streaming] Content ID',\n title: '[Streaming] Title',\n media_type: '[Streaming] Media Type',\n delivery_mode: '[Streaming] Delivery Mode',\n stream_session_id: '[Streaming] Stream Session ID',\n play_id: '[Streaming] Play ID',\n start_position: '[Streaming] Start Position Sec',\n position: '[Streaming] Position Sec',\n duration: '[Streaming] Duration Sec',\n // stop events\n play_time: '[Streaming] Play Time Sec',\n play_time_total: '[Streaming] Play Time Total Sec',\n percent_completed: '[Streaming] Percent Completed',\n stop_reason: '[Streaming] Stop Reason',\n error_message: '[Streaming] Error Message',\n};\n\n/**\n * Observer fields that never reach event properties from `lastEvent`: `position` is taken from\n * observer state instead, and `percent_completed`/`stop_reason` describe the player event rather\n * than the play session, which tracks its own values.\n */\nconst OMITTED_VIDEO_EVENT_PROPERTIES = new Set(['position', 'percent_completed', 'stop_reason']);\n\n/**\n * Copy remaining player-event fields (vendor metadata such as `mux_playback_id`, ids, titles)\n * onto the Amplitude event, dropping empty values so absent metadata is omitted.\n */\nfunction parseVideoEventProperties(lastEvent: VideoState['lastEvent']): Record<string, string | number | boolean> {\n const properties: Record<string, string | number | boolean> = {};\n for (const [key, value] of Object.entries(lastEvent ?? {})) {\n if (OMITTED_VIDEO_EVENT_PROPERTIES.has(key) || value === null || value === undefined) {\n continue;\n }\n properties[key] = value as string | number | boolean;\n }\n return properties;\n}\n\nexport class VideoCapture {\n private videoEl: HTMLMediaElement | null = null;\n private heartbeat: ReturnType<typeof getHeartbeatInstance>;\n private embeddedVideoPlayer: EmbeddedVideoPlayer | null = null;\n private vendor?: VideoVendor;\n private extraEventProperties: Record<string, string | number | boolean> = {};\n private stopEvent: BaseEvent | null = null;\n private listeners: ((previousState: VideoState, nextState: VideoState) => void)[] = [];\n private onRemoveListeners: (() => void)[] = [];\n private playId: string | null = null;\n private playStartPosition: number | null = null;\n /**\n * Observer `watchTime` already accumulated when the current `play_id` began.\n * `play_time` is the watch time since this baseline.\n */\n private playTimeBaseline = 0;\n /**\n * Observer `watchTime` already accumulated when the current `stream_session_id` began.\n * `play_time_total` is the watch time since this baseline.\n */\n private sessionTimeBaseline = 0;\n\n constructor(private readonly amplitude: BrowserClient) {\n this.heartbeat = getHeartbeatInstance(this.amplitude);\n }\n\n /**\n * Specify a video or audio element to capture events from\n *\n * @param videoEl - The HTML video or audio element to capture events from.\n * @returns The VideoCapture instance.\n */\n withVideoElement(videoEl: HTMLMediaElement): VideoCapture {\n this.videoEl = videoEl;\n return this;\n }\n\n /**\n * Specify an embedded video player.js instance to capture events from\n * @param player - The embedded video player.js instance to capture events from.\n * @returns The VideoCapture instance.\n */\n withEmbeddedPlayer(player: EmbeddedVideoPlayer): VideoCapture {\n this.embeddedVideoPlayer = player;\n return this;\n }\n\n /**\n * Specify a vendor to capture extra vendor-specific event properties\n *\n * @param vendor - The vendor of the video player. Currently only \"mux\" is supported.\n * @returns The VideoCapture instance.\n */\n withVendor(vendor: VideoVendor): VideoCapture {\n this.vendor = vendor;\n return this;\n }\n\n /**\n * Specify extra event properties to include in all captured events\n *\n * @param properties - The extra event properties to include in the Amplitude event.\n * @returns The VideoCapture instance.\n */\n withExtraEventProperties(properties: Record<string, string | number | boolean>): VideoCapture {\n this.extraEventProperties = properties;\n return this;\n }\n\n toAnalyticsEventProperties(\n eventProperties: Record<string, string | number | boolean> | undefined,\n ): Record<string, string | number | boolean> {\n if (!eventProperties) {\n return {};\n }\n const analyticsEventProperties: Record<string, string | number | boolean> = {};\n for (const [key, value] of Object.entries(eventProperties)) {\n const analyticsKey = eventPropNames[key] ?? key;\n analyticsEventProperties[analyticsKey] = value;\n }\n return analyticsEventProperties;\n }\n\n /**\n * Track a \"[Streaming] Stream Started\" event every time the video starts playing\n * @returns The VideoCapture instance.\n */\n captureVideoStarted(): VideoCapture {\n this.listeners.push((previousState, nextState) => {\n const prevPlayback = previousState.playbackState;\n const nextPlayback = nextState.playbackState;\n if (prevPlayback === 'ended') {\n this.extraEventProperties.stream_session_id = UUID();\n // the ended state's watch time belongs to the session that just finished\n this.sessionTimeBaseline = previousState.watchTime ?? 0;\n }\n if (!ACTIVE_PLAYBACK_STATES.has(prevPlayback) && nextPlayback === 'playing') {\n this.playId = UUID();\n this.playStartPosition = nextState.position ?? nextState.lastEvent?.position ?? 0;\n this.playTimeBaseline = previousState.watchTime ?? 0;\n const now = new Date().getTime();\n const startEvent: BaseEvent = {\n insert_id: UUID(),\n event_type: DEFAULT_STREAM_STARTED_EVENT,\n time: now,\n event_properties: {\n ...this.parseStartEventProperties(nextState),\n ...this.extraEventProperties,\n play_id: this.playId,\n },\n };\n this.stopEvent = {\n ...startEvent,\n insert_id: UUID(),\n event_type: DEFAULT_STREAM_STOPPED_EVENT,\n time: now + 1,\n event_properties: this.toAnalyticsEventProperties({\n stop_reason: 'timeout',\n play_id: this.playId,\n ...this.parseStopEventProperties(nextState),\n ...this.extraEventProperties,\n }),\n };\n this.heartbeat\n .trackNoDelay({\n ...startEvent,\n event_properties: this.toAnalyticsEventProperties(startEvent.event_properties),\n })\n .catch(() => this.stop());\n this.heartbeat.track(this.stopEvent).catch(() => this.stop());\n }\n });\n\n return this;\n }\n\n /**\n * Track a \"[Streaming] Stream Stopped\" event every time the video stops playing\n * @returns The VideoCapture instance.\n */\n captureVideoStopped(): VideoCapture {\n this.listeners.push((previousState, nextState) => {\n // update the delayed event properties to have\n // the most up-to-date values\n if (this.stopEvent) {\n this.stopEvent.event_properties = this.toAnalyticsEventProperties({\n ...this.stopEvent.event_properties,\n ...this.parseStopEventProperties(nextState),\n ...this.extraEventProperties,\n });\n this.stopEvent.time = new Date().getTime();\n void this.heartbeat.update(this.stopEvent);\n }\n if (\n ACTIVE_PLAYBACK_STATES.has(previousState.playbackState) &&\n !ACTIVE_PLAYBACK_STATES.has(nextState.playbackState)\n ) {\n this.flushStopEvent(nextState.cause ?? nextState.playbackState);\n }\n });\n return this;\n }\n\n /**\n * End the current play session by ingesting its queued delayed stop event immediately.\n *\n * The heartbeat is shared by every capture on the same Amplitude client, so the event is\n * flushed rather than the heartbeat stopped, which would discard other captures' events.\n * Flushing also drops the event from the heartbeat queue once ingested, so the interval\n * winds down on its own. No-op when no play session is in progress.\n */\n private flushStopEvent(stopReason: string) {\n const stopEvent = this.stopEvent;\n if (!stopEvent) {\n return;\n }\n // the next play queues a fresh delayed stop event\n this.stopEvent = null;\n this.playStartPosition = null;\n stopEvent.event_properties = {\n ...stopEvent.event_properties,\n stop_reason: stopReason,\n };\n this.heartbeat\n .trackNoDelay({\n ...stopEvent,\n event_properties: this.toAnalyticsEventProperties(stopEvent.event_properties),\n })\n .catch(() => this.stop());\n }\n\n // Placeholder: may need a generic state change listener to capture unusual events or to have\n // more control over the event tracking.\n // withStateChangeListener(listener: (previousState: VideoState, nextState: VideoState) => void): VideoCapture {\n\n /**\n * Start capturing analytics events for the video element\n * @returns The VideoCapture instance.\n * @throws An error if the video element is not specified.\n */\n start(): VideoCapture {\n const videoEl = this.videoEl ?? this.embeddedVideoPlayer;\n if (!videoEl) {\n throw new Error(\n 'Video element not specified. Use withVideoElement() or withEmbeddedPlayer() to specify the video element.',\n );\n }\n if (this.videoEl && this.embeddedVideoPlayer) {\n throw new Error(\n 'Both video element and embedded video player specified. Use only one of withVideoElement() or withEmbeddedPlayer() to specify the video element.',\n );\n }\n const videoObserver = new VideoObserver({\n videoEl,\n onStateChange: (previousState, nextState) => {\n this.listeners.forEach((listener) => listener(previousState, nextState));\n },\n vendor: this.vendor,\n isEmbedded: !!this.embeddedVideoPlayer,\n });\n\n this.onRemoveListeners.push(() => {\n videoObserver.destroy();\n });\n\n if (getGlobalScope()) {\n this.onRemoveListeners.push(\n this.heartbeat.beforePageHide(() => {\n // if the page is exited, emit a final 'ended' stop event\n this.stop('ended');\n }),\n );\n }\n\n return this;\n }\n\n /**\n * Stop capturing analytics events for the video element.\n *\n * Observers are detached first so no playback state change can race with the final\n * event, then any in-progress play session is closed out.\n */\n stop(stopReason = 'untracked') {\n this.onRemoveListeners.forEach((listener) => listener());\n this.onRemoveListeners = [];\n this.flushStopEvent(stopReason);\n }\n\n parseStartEventProperties(nextState: VideoState): Record<string, string | number | boolean | undefined> {\n return {\n ...parseVideoEventProperties(nextState.lastEvent),\n duration: nextState.lastEvent?.duration ?? undefined,\n start_position: this.playStartPosition ?? nextState.position ?? 0,\n position: nextState.position ?? 0,\n media_type: this.getMediaType(),\n };\n }\n\n private getMediaType(): 'video' | 'audio' {\n return this.videoEl instanceof HTMLAudioElement ? 'audio' : 'video';\n }\n\n parseStopEventProperties(nextState: VideoState): Record<string, string | number | boolean> {\n return {\n ...this.parseStartEventProperties(nextState),\n // watchTime accumulates for the whole element. Each play_id and stream session keeps its own slice.\n play_time: this.watchedSince(nextState.watchTime, this.playTimeBaseline),\n play_time_total: this.watchedSince(nextState.watchTime, this.sessionTimeBaseline),\n percent_completed: calculatePercentCompleted(nextState.position ?? 0, nextState.lastEvent?.duration ?? 0),\n ...(nextState.errorMessage ? { error_message: nextState.errorMessage } : {}),\n };\n }\n\n /** Watch time elapsed since `baseline`. Missing or rewound watch time reports as 0. */\n private watchedSince(watchTime: number | undefined, baseline: number) {\n const elapsed = (watchTime ?? 0) - baseline;\n return elapsed > 0 ? elapsed : 0;\n }\n}\n\nfunction calculatePercentCompleted(currentTime: number, duration: number) {\n if (!Number.isFinite(currentTime) || !Number.isFinite(duration) || duration <= 0) {\n return 0;\n }\n return Math.min(100, Math.max(0, (currentTime / duration) * 100));\n}\n\nexport type VideoCaptureOptions = {\n vendor?: VideoVendor;\n extraEventProperties?: Record<string, string | number | boolean>;\n};\n\ntype UntrackVideoResult = () => void;\n\nexport type TrackVideoResult = UntrackVideoResult | Error;\n\n/**\n * Track video analytics events for an HTML video or audio element or embedded video player.js instance.\n *\n * Captures [Streaming] Stream Started and [Streaming] Stream Stopped events.\n *\n * @experimental This function is experimental and may not be stable.\n * @param amplitude - The Amplitude client instance.\n * @param videoEl - The HTML video or audio element or embedded video player.js instance to capture events from.\n * @param options - The options for the video capture.\n * @returns A function to stop the video capture.\n */\nexport function trackVideo(\n amplitude: BrowserClient,\n videoEl: HTMLMediaElement | EmbeddedVideoPlayer,\n options: VideoCaptureOptions = {},\n): TrackVideoResult {\n const videoCapture = new VideoCapture(amplitude);\n if (videoEl instanceof HTMLMediaElement) {\n videoCapture.withVideoElement(videoEl);\n } else {\n videoCapture.withEmbeddedPlayer(videoEl);\n }\n if (options.vendor) {\n videoCapture.withVendor(options.vendor);\n }\n const extraEventProperties = options.extraEventProperties ?? {};\n\n try {\n videoCapture\n .withExtraEventProperties({\n ...extraEventProperties,\n stream_session_id: UUID(),\n })\n .captureVideoStarted()\n .captureVideoStopped()\n .start();\n } catch (error) {\n return error as Error;\n }\n\n return () => videoCapture.stop();\n}\n"]}
|