@amplitude/analytics-browser 2.46.0-video-analytics.0 → 2.46.0-video-analytics-4.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.
Files changed (96) hide show
  1. package/README.md +1 -1
  2. package/lib/cjs/browser-client.d.ts.map +1 -1
  3. package/lib/cjs/browser-client.js +4 -1
  4. package/lib/cjs/browser-client.js.map +1 -1
  5. package/lib/cjs/config.d.ts +9 -4
  6. package/lib/cjs/config.d.ts.map +1 -1
  7. package/lib/cjs/config.js +30 -7
  8. package/lib/cjs/config.js.map +1 -1
  9. package/lib/cjs/constants.d.ts +2 -0
  10. package/lib/cjs/constants.d.ts.map +1 -1
  11. package/lib/cjs/constants.js +3 -1
  12. package/lib/cjs/constants.js.map +1 -1
  13. package/lib/cjs/plugins/context.d.ts +1 -0
  14. package/lib/cjs/plugins/context.d.ts.map +1 -1
  15. package/lib/cjs/plugins/context.js +3 -3
  16. package/lib/cjs/plugins/context.js.map +1 -1
  17. package/lib/cjs/plugins/file-download-tracking.d.ts.map +1 -1
  18. package/lib/cjs/plugins/file-download-tracking.js +15 -4
  19. package/lib/cjs/plugins/file-download-tracking.js.map +1 -1
  20. package/lib/cjs/plugins/form-interaction-tracking.d.ts.map +1 -1
  21. package/lib/cjs/plugins/form-interaction-tracking.js +16 -5
  22. package/lib/cjs/plugins/form-interaction-tracking.js.map +1 -1
  23. package/lib/cjs/utils/environment.d.ts +9 -0
  24. package/lib/cjs/utils/environment.d.ts.map +1 -0
  25. package/lib/cjs/utils/environment.js +64 -0
  26. package/lib/cjs/utils/environment.js.map +1 -0
  27. package/lib/cjs/version.d.ts +1 -1
  28. package/lib/cjs/version.d.ts.map +1 -1
  29. package/lib/cjs/version.js +1 -1
  30. package/lib/cjs/version.js.map +1 -1
  31. package/lib/cjs/video-capture/video-capture.d.ts +11 -9
  32. package/lib/cjs/video-capture/video-capture.d.ts.map +1 -1
  33. package/lib/cjs/video-capture/video-capture.js +63 -19
  34. package/lib/cjs/video-capture/video-capture.js.map +1 -1
  35. package/lib/esm/browser-client.d.ts.map +1 -1
  36. package/lib/esm/browser-client.js +5 -2
  37. package/lib/esm/browser-client.js.map +1 -1
  38. package/lib/esm/config.d.ts +9 -4
  39. package/lib/esm/config.d.ts.map +1 -1
  40. package/lib/esm/config.js +28 -6
  41. package/lib/esm/config.js.map +1 -1
  42. package/lib/esm/constants.d.ts +2 -0
  43. package/lib/esm/constants.d.ts.map +1 -1
  44. package/lib/esm/constants.js +2 -0
  45. package/lib/esm/constants.js.map +1 -1
  46. package/lib/esm/plugins/context.d.ts +1 -0
  47. package/lib/esm/plugins/context.d.ts.map +1 -1
  48. package/lib/esm/plugins/context.js +1 -1
  49. package/lib/esm/plugins/context.js.map +1 -1
  50. package/lib/esm/plugins/file-download-tracking.d.ts.map +1 -1
  51. package/lib/esm/plugins/file-download-tracking.js +15 -4
  52. package/lib/esm/plugins/file-download-tracking.js.map +1 -1
  53. package/lib/esm/plugins/form-interaction-tracking.d.ts.map +1 -1
  54. package/lib/esm/plugins/form-interaction-tracking.js +16 -5
  55. package/lib/esm/plugins/form-interaction-tracking.js.map +1 -1
  56. package/lib/esm/utils/environment.d.ts +9 -0
  57. package/lib/esm/utils/environment.d.ts.map +1 -0
  58. package/lib/esm/utils/environment.js +60 -0
  59. package/lib/esm/utils/environment.js.map +1 -0
  60. package/lib/esm/version.d.ts +1 -1
  61. package/lib/esm/version.d.ts.map +1 -1
  62. package/lib/esm/version.js +1 -1
  63. package/lib/esm/version.js.map +1 -1
  64. package/lib/esm/video-capture/video-capture.d.ts +11 -9
  65. package/lib/esm/video-capture/video-capture.d.ts.map +1 -1
  66. package/lib/esm/video-capture/video-capture.js +64 -20
  67. package/lib/esm/video-capture/video-capture.js.map +1 -1
  68. package/lib/scripts/amplitude-bookmarklet-snippet-min.js +1 -1
  69. package/lib/scripts/amplitude-bookmarklet.html +1 -1
  70. package/lib/scripts/amplitude-gtm-min.js +1 -1
  71. package/lib/scripts/amplitude-gtm-min.js.gz +0 -0
  72. package/lib/scripts/amplitude-gtm-min.js.map +1 -1
  73. package/lib/scripts/amplitude-gtm-snippet-min.js +1 -1
  74. package/lib/scripts/amplitude-min.js +1 -1
  75. package/lib/scripts/amplitude-min.js.gz +0 -0
  76. package/lib/scripts/amplitude-min.js.map +1 -1
  77. package/lib/scripts/amplitude-min.umd.js +1 -1
  78. package/lib/scripts/amplitude-min.umd.js.gz +0 -0
  79. package/lib/scripts/amplitude-snippet-instructions.html +1 -1
  80. package/lib/scripts/amplitude-snippet-min.js +1 -1
  81. package/lib/scripts/browser-client.d.ts.map +1 -1
  82. package/lib/scripts/config.d.ts +9 -4
  83. package/lib/scripts/config.d.ts.map +1 -1
  84. package/lib/scripts/constants.d.ts +2 -0
  85. package/lib/scripts/constants.d.ts.map +1 -1
  86. package/lib/scripts/plugins/context.d.ts +1 -0
  87. package/lib/scripts/plugins/context.d.ts.map +1 -1
  88. package/lib/scripts/plugins/file-download-tracking.d.ts.map +1 -1
  89. package/lib/scripts/plugins/form-interaction-tracking.d.ts.map +1 -1
  90. package/lib/scripts/utils/environment.d.ts +9 -0
  91. package/lib/scripts/utils/environment.d.ts.map +1 -0
  92. package/lib/scripts/version.d.ts +1 -1
  93. package/lib/scripts/version.d.ts.map +1 -1
  94. package/lib/scripts/video-capture/video-capture.d.ts +11 -9
  95. package/lib/scripts/video-capture/video-capture.d.ts.map +1 -1
  96. package/package.json +10 -12
@@ -1 +1 @@
1
- {"version":3,"file":"form-interaction-tracking.js","sourceRoot":"","sources":["../../../src/plugins/form-interaction-tracking.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,wBAAwB,EACxB,yBAAyB,EACzB,OAAO,EACP,SAAS,EACT,gBAAgB,GACjB,MAAM,cAAc,CAAC;AAEtB,OAAO,EACL,cAAc,GAKf,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAQhE,MAAM,CAAC,IAAM,uBAAuB,GAAG;IACrC,IAAI,QAAsC,CAAC;IAC3C,IAAI,cAAc,GAAoB,EAAE,CAAC;IAEzC,IAAM,gBAAgB,GAAG,UAAC,OAAgB,EAAE,IAAyB,EAAE,OAA+B;QACpG,OAAO,CAAC,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACxC,cAAc,CAAC,IAAI,CAAC;YAClB,OAAO,SAAA;YACP,IAAI,MAAA;YACJ,OAAO,SAAA;SACR,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,IAAM,oBAAoB,GAAG;QAC3B,cAAc,CAAC,OAAO,CAAC,UAAC,EAA0B;gBAAxB,OAAO,aAAA,EAAE,IAAI,UAAA,EAAE,OAAO,aAAA;YAC9C,0BAA0B;YAC1B,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,mBAAmB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;QACH,cAAc,GAAG,EAAE,CAAC;IACtB,CAAC,CAAC;IAEF,IAAI,sBAA2D,CAAC;IAEhE,IAAM,IAAI,GAAG,qDAAqD,CAAC;IACnE,IAAM,IAAI,GAAG,YAAY,CAAC;IAC1B,IAAM,KAAK,GAAG,UAAO,MAAqB,EAAE,SAAwB;;;YAClE,sBAAsB,GAAG,yBAAyB,CAAC,MAAM,CAAC,CAAC;YAErD,sBAAsB,GAAG;gBAC7B,wBAAwB;gBACxB,IAAI,CAAC,SAAS,EAAE;oBACd,qEAAqE;oBACrE,MAAM,CAAC,cAAc,CAAC,IAAI,CACxB,8HAA8H,CAC/H,CAAC;oBACF,OAAO;iBACR;gBAED,wBAAwB;gBACxB,IAAI,OAAO,QAAQ,KAAK,WAAW,EAAE;oBACnC,OAAO;iBACR;gBAED,IAAM,cAAc,GAAG,IAAI,OAAO,EAAQ,CAAC;gBAC3C,IAAM,0BAA0B,GAAG,UAAC,IAAqB;oBACvD,IAAI,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;wBAC5B,OAAO;qBACR;oBACD,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;oBAEzB,IAAI,cAAc,GAAG,KAAK,CAAC;oBAE3B,gBAAgB,CAAC,IAAI,EAAE,QAAQ,EAAE;;wBAC/B,IAAM,eAAe,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBAChD,IAAI,CAAC,cAAc,EAAE;4BACnB,SAAS,CAAC,KAAK,CAAC,wBAAwB;gCACtC,GAAC,OAAO,IAAG,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC;gCACrC,GAAC,SAAS,IAAG,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC;gCACzC,GAAC,gBAAgB,IAAG,eAAe;oCACnC,CAAC;yBACJ;wBACD,cAAc,GAAG,IAAI,CAAC;oBACxB,CAAC,CAAC,CAAC;oBAEH,gBAAgB,CAAC,IAAI,EAAE,QAAQ,EAAE,UAAC,KAAY;;wBAC5C,IAAM,eAAe,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBAChD,IAAI,CAAC,cAAc,EAAE;4BACnB,SAAS,CAAC,KAAK,CAAC,wBAAwB;gCACtC,GAAC,OAAO,IAAG,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC;gCACrC,GAAC,SAAS,IAAG,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC;gCACzC,GAAC,gBAAgB,IAAG,eAAe;oCACnC,CAAC;yBACJ;wBACD,cAAc,GAAG,IAAI,CAAC;wBAEtB,uGAAuG;wBACvG,IAAI,CAAA,sBAAsB,aAAtB,sBAAsB,uBAAtB,sBAAsB,CAAE,iBAAiB,MAAK,SAAS,EAAE;4BAC3D,IACE,OAAO,sBAAsB,CAAC,iBAAiB,KAAK,UAAU;gCAC9D,OAAO,WAAW,KAAK,WAAW;gCAClC,KAAK,YAAY,WAAW,EAC5B;gCACA,IAAI;oCACF,IAAM,WAAW,GAAG,sBAAsB,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;oCACpE,IAAI,CAAC,WAAW,EAAE;wCAChB,OAAO;qCACR;iCACF;gCAAC,OAAO,CAAC,EAAE;oCACV,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,sEAAsE,CAAC,CAAC;iCACpG;6BACF;iCAAM;gCACL,MAAM,CAAC,cAAc,CAAC,IAAI,CACxB,0FAA0F,CAC3F,CAAC;6BACH;yBACF;wBAED,SAAS,CAAC,KAAK,CAAC,yBAAyB;4BACvC,GAAC,OAAO,IAAG,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC;4BACrC,GAAC,SAAS,IAAG,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC;4BACzC,GAAC,gBAAgB,IAAG,eAAe;gCACnC,CAAC;wBACH,cAAc,GAAG,KAAK,CAAC;oBACzB,CAAC,CAAC,CAAC;gBACL,CAAC,CAAC;gBAEF,wCAAwC;gBACxC,IAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC;gBAChE,KAAK,CAAC,OAAO,CAAC,0BAA0B,CAAC,CAAC;gBAE1C,wDAAwD;gBACxD,0BAA0B;gBAC1B,IAAI,OAAO,gBAAgB,KAAK,WAAW,EAAE;oBAC3C,QAAQ,GAAG,IAAI,gBAAgB,CAAC,UAAC,SAAS;wBACxC,SAAS,CAAC,OAAO,CAAC,UAAC,QAAQ;4BACzB,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,UAAC,IAAI;gCAC/B,IAAI,IAAI,CAAC,QAAQ,KAAK,MAAM,EAAE;oCAC5B,0BAA0B,CAAC,IAAuB,CAAC,CAAC;iCACrD;gCACD,IAAI,kBAAkB,IAAI,IAAI,IAAI,OAAO,IAAI,CAAC,gBAAgB,KAAK,UAAU,EAAE;oCAC7E,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAsB,CAAC,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;iCAChG;4BACH,CAAC,CAAC,CAAC;wBACL,CAAC,CAAC,CAAC;oBACL,CAAC,CAAC,CAAC;oBAEH,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE;wBAC9B,OAAO,EAAE,IAAI;wBACb,SAAS,EAAE,IAAI;qBAChB,CAAC,CAAC;iBACJ;YACH,CAAC,CAAC;YAEF,6DAA6D;YAC7D,IAAI,QAAQ,CAAC,UAAU,KAAK,UAAU,EAAE;gBACtC,sBAAsB,EAAE,CAAC;aAC1B;iBAAM;gBAKC,WAAS,cAAc,EAAE,CAAC;gBAChC,yBAAyB;gBACzB,IAAI,QAAM,EAAE;oBACV,QAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;iBACzD;qBAAM;oBACL,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,yEAAyE,CAAC,CAAC;iBACxG;aACF;;;SACF,CAAC;IACF,IAAM,OAAO,GAAG,UAAO,KAAqB;QAAK,sBAAA,KAAK,EAAA;aAAA,CAAC;IACvD,IAAM,QAAQ,GAAG;;YACf,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,UAAU,EAAE,CAAC;YACvB,oBAAoB,EAAE,CAAC;;;SACxB,CAAC;IAEF,OAAO;QACL,IAAI,MAAA;QACJ,IAAI,MAAA;QACJ,KAAK,OAAA;QACL,OAAO,SAAA;QACP,QAAQ,UAAA;KACT,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,iBAAiB,GAAG,UAAI,IAAO;IAC1C,wBAAwB;IACxB,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QAC5B,+EAA+E;QAC/E,uGAAuG;QACvG,2DAA2D;QAC3D,OAAO,SAAkD,CAAC;KAC3D;IAED,OAAO,IAA6C,CAAC;AACvD,CAAC,CAAC;AAEF,oJAAoJ;AACpJ,MAAM,CAAC,IAAM,iBAAiB,GAAG,UAAC,IAAqB;IACrD,IAAI,eAAe,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IAClD,IAAI;QACF,iDAAiD;QACjD,eAAe,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,eAAe,aAAf,eAAe,cAAf,eAAe,GAAI,EAAE,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC;KACxF;IAAC,WAAM;QACN,EAAE;KACH;IACD,OAAO,eAAe,CAAC;AACzB,CAAC,CAAC","sourcesContent":["import {\n DEFAULT_FORM_START_EVENT,\n DEFAULT_FORM_SUBMIT_EVENT,\n FORM_ID,\n FORM_NAME,\n FORM_DESTINATION,\n} from '../constants';\nimport { BrowserConfig } from '../config';\nimport {\n getGlobalScope,\n Event as AmplitudeEvent,\n EnrichmentPlugin,\n BrowserClient,\n FormInteractionsOptions,\n} from '@amplitude/analytics-core';\nimport { getFormInteractionsConfig } from '../default-tracking';\n\ninterface EventListener {\n element: Element;\n type: 'change' | 'submit';\n handler: (event: Event) => void;\n}\n\nexport const formInteractionTracking = (): EnrichmentPlugin => {\n let observer: MutationObserver | undefined;\n let eventListeners: EventListener[] = [];\n\n const addEventListener = (element: Element, type: 'change' | 'submit', handler: (event: Event) => void) => {\n element.addEventListener(type, handler);\n eventListeners.push({\n element,\n type,\n handler,\n });\n };\n\n const removeClickListeners = () => {\n eventListeners.forEach(({ element, type, handler }) => {\n /* istanbul ignore next */\n element?.removeEventListener(type, handler);\n });\n eventListeners = [];\n };\n\n let formInteractionsConfig: FormInteractionsOptions | undefined;\n\n const name = '@amplitude/plugin-form-interaction-tracking-browser';\n const type = 'enrichment';\n const setup = async (config: BrowserConfig, amplitude: BrowserClient) => {\n formInteractionsConfig = getFormInteractionsConfig(config);\n\n const initializeFormTracking = () => {\n /* istanbul ignore if */\n if (!amplitude) {\n // TODO: Add required minimum version of @amplitude/analytics-browser\n config.loggerProvider.warn(\n 'Form interaction tracking requires a later version of @amplitude/analytics-browser. Form interaction events are not tracked.',\n );\n return;\n }\n\n /* istanbul ignore if */\n if (typeof document === 'undefined') {\n return;\n }\n\n const addedFormNodes = new WeakSet<Node>();\n const addFormInteractionListener = (form: HTMLFormElement) => {\n if (addedFormNodes.has(form)) {\n return;\n }\n addedFormNodes.add(form);\n\n let hasFormChanged = false;\n\n addEventListener(form, 'change', () => {\n const formDestination = extractFormAction(form);\n if (!hasFormChanged) {\n amplitude.track(DEFAULT_FORM_START_EVENT, {\n [FORM_ID]: stringOrUndefined(form.id),\n [FORM_NAME]: stringOrUndefined(form.name),\n [FORM_DESTINATION]: formDestination,\n });\n }\n hasFormChanged = true;\n });\n\n addEventListener(form, 'submit', (event: Event) => {\n const formDestination = extractFormAction(form);\n if (!hasFormChanged) {\n amplitude.track(DEFAULT_FORM_START_EVENT, {\n [FORM_ID]: stringOrUndefined(form.id),\n [FORM_NAME]: stringOrUndefined(form.name),\n [FORM_DESTINATION]: formDestination,\n });\n }\n hasFormChanged = true;\n\n // Check if shouldTrackSubmit callback is provided and use it to determine whether to track form_submit\n if (formInteractionsConfig?.shouldTrackSubmit !== undefined) {\n if (\n typeof formInteractionsConfig.shouldTrackSubmit === 'function' &&\n typeof SubmitEvent !== 'undefined' &&\n event instanceof SubmitEvent\n ) {\n try {\n const shouldTrack = formInteractionsConfig.shouldTrackSubmit(event);\n if (!shouldTrack) {\n return;\n }\n } catch (e) {\n config.loggerProvider.warn('shouldTrackSubmit callback threw an error, proceeding with tracking.');\n }\n } else {\n config.loggerProvider.warn(\n 'shouldTrackSubmit is ignored because it is not a function or event is not a SubmitEvent.',\n );\n }\n }\n\n amplitude.track(DEFAULT_FORM_SUBMIT_EVENT, {\n [FORM_ID]: stringOrUndefined(form.id),\n [FORM_NAME]: stringOrUndefined(form.name),\n [FORM_DESTINATION]: formDestination,\n });\n hasFormChanged = false;\n });\n };\n\n // Adds listener to existing anchor tags\n const forms = Array.from(document.getElementsByTagName('form'));\n forms.forEach(addFormInteractionListener);\n\n // Adds listener to anchor tags added after initial load\n /* istanbul ignore else */\n if (typeof MutationObserver !== 'undefined') {\n observer = new MutationObserver((mutations) => {\n mutations.forEach((mutation) => {\n mutation.addedNodes.forEach((node) => {\n if (node.nodeName === 'FORM') {\n addFormInteractionListener(node as HTMLFormElement);\n }\n if ('querySelectorAll' in node && typeof node.querySelectorAll === 'function') {\n Array.from(node.querySelectorAll('form') as HTMLFormElement[]).map(addFormInteractionListener);\n }\n });\n });\n });\n\n observer.observe(document.body, {\n subtree: true,\n childList: true,\n });\n }\n };\n\n // If the document is already loaded, initialize immediately.\n if (document.readyState === 'complete') {\n initializeFormTracking();\n } else {\n // Otherwise, wait for the load event.\n // The form interaction plugin observes changes in the dom. For this to work correctly, the observer can only be setup\n // after the body is built. When Amplitude gets initialized in a script tag, the body tag is still unavailable. So register this\n // only after the window is loaded\n const window = getGlobalScope();\n /* istanbul ignore else*/\n if (window) {\n window.addEventListener('load', initializeFormTracking);\n } else {\n config.loggerProvider.debug('Form interaction tracking is not installed because global is undefined.');\n }\n }\n };\n const execute = async (event: AmplitudeEvent) => event;\n const teardown = async () => {\n observer?.disconnect();\n removeClickListeners();\n };\n\n return {\n name,\n type,\n setup,\n execute,\n teardown,\n };\n};\n\nexport const stringOrUndefined = <T>(name: T): T extends string ? string : undefined => {\n /* istanbul ignore if */\n if (typeof name !== 'string') {\n // We found instances where the value of `name` is an Element and not a string.\n // Elements may have circular references and would throw an error when passed to `JSON.stringify(...)`.\n // If a non-string value is seen, assume there is no value.\n return undefined as T extends string ? string : undefined;\n }\n\n return name as T extends string ? string : undefined;\n};\n\n// Extracts the form action attribute, and normalizes it to a valid URL to preserve the previous behavior of accessing the action property directly.\nexport const extractFormAction = (form: HTMLFormElement): string | null => {\n let formDestination = form.getAttribute('action');\n try {\n // eslint-disable-next-line no-restricted-globals\n formDestination = new URL(encodeURI(formDestination ?? ''), window.location.href).href;\n } catch {\n //\n }\n return formDestination;\n};\n"]}
1
+ {"version":3,"file":"form-interaction-tracking.js","sourceRoot":"","sources":["../../../src/plugins/form-interaction-tracking.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,wBAAwB,EACxB,yBAAyB,EACzB,OAAO,EACP,SAAS,EACT,gBAAgB,GACjB,MAAM,cAAc,CAAC;AAEtB,OAAO,EACL,cAAc,GAKf,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAQhE,MAAM,CAAC,IAAM,uBAAuB,GAAG;IACrC,IAAI,QAAsC,CAAC;IAC3C,IAAI,cAAc,GAAoB,EAAE,CAAC;IAEzC,IAAM,gBAAgB,GAAG,UAAC,OAAgB,EAAE,IAAyB,EAAE,OAA+B;QACpG,OAAO,CAAC,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACxC,cAAc,CAAC,IAAI,CAAC;YAClB,OAAO,SAAA;YACP,IAAI,MAAA;YACJ,OAAO,SAAA;SACR,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,IAAM,oBAAoB,GAAG;QAC3B,cAAc,CAAC,OAAO,CAAC,UAAC,EAA0B;gBAAxB,OAAO,aAAA,EAAE,IAAI,UAAA,EAAE,OAAO,aAAA;YAC9C,0BAA0B;YAC1B,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,mBAAmB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;QACH,cAAc,GAAG,EAAE,CAAC;IACtB,CAAC,CAAC;IAEF,IAAI,sBAA2D,CAAC;IAEhE,IAAM,IAAI,GAAG,qDAAqD,CAAC;IACnE,IAAM,IAAI,GAAG,YAAY,CAAC;IAC1B,IAAM,KAAK,GAAG,UAAO,MAAqB,EAAE,SAAwB;;;YAClE,sBAAsB,GAAG,yBAAyB,CAAC,MAAM,CAAC,CAAC;YAErD,sBAAsB,GAAG;gBAC7B,wBAAwB;gBACxB,IAAI,CAAC,SAAS,EAAE;oBACd,qEAAqE;oBACrE,MAAM,CAAC,cAAc,CAAC,IAAI,CACxB,8HAA8H,CAC/H,CAAC;oBACF,OAAO;iBACR;gBAED,wBAAwB;gBACxB,IAAI,OAAO,QAAQ,KAAK,WAAW,EAAE;oBACnC,OAAO;iBACR;gBAED,IAAM,cAAc,GAAG,IAAI,OAAO,EAAQ,CAAC;gBAC3C,IAAM,0BAA0B,GAAG,UAAC,IAAqB;oBACvD,IAAI,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;wBAC5B,OAAO;qBACR;oBACD,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;oBAEzB,IAAI,cAAc,GAAG,KAAK,CAAC;oBAE3B,gBAAgB,CAAC,IAAI,EAAE,QAAQ,EAAE;;wBAC/B,IAAM,eAAe,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBAChD,IAAI,CAAC,cAAc,EAAE;4BACnB,SAAS,CAAC,KAAK,CAAC,wBAAwB;gCACtC,GAAC,OAAO,IAAG,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC;gCACrC,GAAC,SAAS,IAAG,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC;gCACzC,GAAC,gBAAgB,IAAG,eAAe;oCACnC,CAAC;yBACJ;wBACD,cAAc,GAAG,IAAI,CAAC;oBACxB,CAAC,CAAC,CAAC;oBAEH,gBAAgB,CAAC,IAAI,EAAE,QAAQ,EAAE,UAAC,KAAY;;wBAC5C,IAAM,eAAe,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBAChD,IAAI,CAAC,cAAc,EAAE;4BACnB,SAAS,CAAC,KAAK,CAAC,wBAAwB;gCACtC,GAAC,OAAO,IAAG,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC;gCACrC,GAAC,SAAS,IAAG,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC;gCACzC,GAAC,gBAAgB,IAAG,eAAe;oCACnC,CAAC;yBACJ;wBACD,cAAc,GAAG,IAAI,CAAC;wBAEtB,uGAAuG;wBACvG,IAAI,CAAA,sBAAsB,aAAtB,sBAAsB,uBAAtB,sBAAsB,CAAE,iBAAiB,MAAK,SAAS,EAAE;4BAC3D,IACE,OAAO,sBAAsB,CAAC,iBAAiB,KAAK,UAAU;gCAC9D,OAAO,WAAW,KAAK,WAAW;gCAClC,KAAK,YAAY,WAAW,EAC5B;gCACA,IAAI;oCACF,IAAM,WAAW,GAAG,sBAAsB,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;oCACpE,IAAI,CAAC,WAAW,EAAE;wCAChB,OAAO;qCACR;iCACF;gCAAC,OAAO,CAAC,EAAE;oCACV,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,sEAAsE,CAAC,CAAC;iCACpG;6BACF;iCAAM;gCACL,MAAM,CAAC,cAAc,CAAC,IAAI,CACxB,0FAA0F,CAC3F,CAAC;6BACH;yBACF;wBAED,SAAS,CAAC,KAAK,CAAC,yBAAyB;4BACvC,GAAC,OAAO,IAAG,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC;4BACrC,GAAC,SAAS,IAAG,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC;4BACzC,GAAC,gBAAgB,IAAG,eAAe;gCACnC,CAAC;wBACH,cAAc,GAAG,KAAK,CAAC;oBACzB,CAAC,CAAC,CAAC;gBACL,CAAC,CAAC;gBAEF,wCAAwC;gBACxC,IAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC;gBAChE,KAAK,CAAC,OAAO,CAAC,0BAA0B,CAAC,CAAC;gBAE1C,sDAAsD;gBACtD,0BAA0B;gBAC1B,IAAI,OAAO,gBAAgB,KAAK,WAAW,EAAE;oBAC3C,QAAQ,GAAG,IAAI,gBAAgB,CAAC,UAAC,SAAS;wBACxC,SAAS,CAAC,OAAO,CAAC,UAAC,QAAQ;4BACzB,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,UAAC,IAAI;gCAC/B,2FAA2F;gCAC3F,oEAAoE;gCACpE,IAAI;oCACF,IAAI,IAAI,CAAC,QAAQ,KAAK,MAAM,EAAE;wCAC5B,0BAA0B,CAAC,IAAuB,CAAC,CAAC;qCACrD;oCACD,IAAI,kBAAkB,IAAI,IAAI,IAAI,OAAO,IAAI,CAAC,gBAAgB,KAAK,UAAU,EAAE;wCAC7E,yFAAyF;wCACzF,6DAA6D;wCAC7D,IAAM,aAAa,GAAG,IAAe,CAAC;wCACtC,IAAM,OAAK,GAAmD,aAAa,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;wCACrG,OAAK,aAAL,OAAK,uBAAL,OAAK,CAAE,OAAO,CAAC,0BAA0B,CAAC,CAAC;qCAC5C;iCACF;gCAAC,OAAO,KAAK,EAAE;oCACd,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,+DAAwD,MAAM,CAAC,KAAK,CAAC,CAAE,CAAC,CAAC;iCACrG;4BACH,CAAC,CAAC,CAAC;wBACL,CAAC,CAAC,CAAC;oBACL,CAAC,CAAC,CAAC;oBAEH,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE;wBAC9B,OAAO,EAAE,IAAI;wBACb,SAAS,EAAE,IAAI;qBAChB,CAAC,CAAC;iBACJ;YACH,CAAC,CAAC;YAEF,6DAA6D;YAC7D,IAAI,QAAQ,CAAC,UAAU,KAAK,UAAU,EAAE;gBACtC,sBAAsB,EAAE,CAAC;aAC1B;iBAAM;gBAKC,WAAS,cAAc,EAAE,CAAC;gBAChC,yBAAyB;gBACzB,IAAI,QAAM,EAAE;oBACV,QAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;iBACzD;qBAAM;oBACL,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,yEAAyE,CAAC,CAAC;iBACxG;aACF;;;SACF,CAAC;IACF,IAAM,OAAO,GAAG,UAAO,KAAqB;QAAK,sBAAA,KAAK,EAAA;aAAA,CAAC;IACvD,IAAM,QAAQ,GAAG;;YACf,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,UAAU,EAAE,CAAC;YACvB,oBAAoB,EAAE,CAAC;;;SACxB,CAAC;IAEF,OAAO;QACL,IAAI,MAAA;QACJ,IAAI,MAAA;QACJ,KAAK,OAAA;QACL,OAAO,SAAA;QACP,QAAQ,UAAA;KACT,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,iBAAiB,GAAG,UAAI,IAAO;IAC1C,wBAAwB;IACxB,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QAC5B,+EAA+E;QAC/E,uGAAuG;QACvG,2DAA2D;QAC3D,OAAO,SAAkD,CAAC;KAC3D;IAED,OAAO,IAA6C,CAAC;AACvD,CAAC,CAAC;AAEF,oJAAoJ;AACpJ,MAAM,CAAC,IAAM,iBAAiB,GAAG,UAAC,IAAqB;IACrD,IAAI,eAAe,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IAClD,IAAI;QACF,iDAAiD;QACjD,eAAe,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,eAAe,aAAf,eAAe,cAAf,eAAe,GAAI,EAAE,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC;KACxF;IAAC,WAAM;QACN,EAAE;KACH;IACD,OAAO,eAAe,CAAC;AACzB,CAAC,CAAC","sourcesContent":["import {\n DEFAULT_FORM_START_EVENT,\n DEFAULT_FORM_SUBMIT_EVENT,\n FORM_ID,\n FORM_NAME,\n FORM_DESTINATION,\n} from '../constants';\nimport { BrowserConfig } from '../config';\nimport {\n getGlobalScope,\n Event as AmplitudeEvent,\n EnrichmentPlugin,\n BrowserClient,\n FormInteractionsOptions,\n} from '@amplitude/analytics-core';\nimport { getFormInteractionsConfig } from '../default-tracking';\n\ninterface EventListener {\n element: Element;\n type: 'change' | 'submit';\n handler: (event: Event) => void;\n}\n\nexport const formInteractionTracking = (): EnrichmentPlugin => {\n let observer: MutationObserver | undefined;\n let eventListeners: EventListener[] = [];\n\n const addEventListener = (element: Element, type: 'change' | 'submit', handler: (event: Event) => void) => {\n element.addEventListener(type, handler);\n eventListeners.push({\n element,\n type,\n handler,\n });\n };\n\n const removeClickListeners = () => {\n eventListeners.forEach(({ element, type, handler }) => {\n /* istanbul ignore next */\n element?.removeEventListener(type, handler);\n });\n eventListeners = [];\n };\n\n let formInteractionsConfig: FormInteractionsOptions | undefined;\n\n const name = '@amplitude/plugin-form-interaction-tracking-browser';\n const type = 'enrichment';\n const setup = async (config: BrowserConfig, amplitude: BrowserClient) => {\n formInteractionsConfig = getFormInteractionsConfig(config);\n\n const initializeFormTracking = () => {\n /* istanbul ignore if */\n if (!amplitude) {\n // TODO: Add required minimum version of @amplitude/analytics-browser\n config.loggerProvider.warn(\n 'Form interaction tracking requires a later version of @amplitude/analytics-browser. Form interaction events are not tracked.',\n );\n return;\n }\n\n /* istanbul ignore if */\n if (typeof document === 'undefined') {\n return;\n }\n\n const addedFormNodes = new WeakSet<Node>();\n const addFormInteractionListener = (form: HTMLFormElement) => {\n if (addedFormNodes.has(form)) {\n return;\n }\n addedFormNodes.add(form);\n\n let hasFormChanged = false;\n\n addEventListener(form, 'change', () => {\n const formDestination = extractFormAction(form);\n if (!hasFormChanged) {\n amplitude.track(DEFAULT_FORM_START_EVENT, {\n [FORM_ID]: stringOrUndefined(form.id),\n [FORM_NAME]: stringOrUndefined(form.name),\n [FORM_DESTINATION]: formDestination,\n });\n }\n hasFormChanged = true;\n });\n\n addEventListener(form, 'submit', (event: Event) => {\n const formDestination = extractFormAction(form);\n if (!hasFormChanged) {\n amplitude.track(DEFAULT_FORM_START_EVENT, {\n [FORM_ID]: stringOrUndefined(form.id),\n [FORM_NAME]: stringOrUndefined(form.name),\n [FORM_DESTINATION]: formDestination,\n });\n }\n hasFormChanged = true;\n\n // Check if shouldTrackSubmit callback is provided and use it to determine whether to track form_submit\n if (formInteractionsConfig?.shouldTrackSubmit !== undefined) {\n if (\n typeof formInteractionsConfig.shouldTrackSubmit === 'function' &&\n typeof SubmitEvent !== 'undefined' &&\n event instanceof SubmitEvent\n ) {\n try {\n const shouldTrack = formInteractionsConfig.shouldTrackSubmit(event);\n if (!shouldTrack) {\n return;\n }\n } catch (e) {\n config.loggerProvider.warn('shouldTrackSubmit callback threw an error, proceeding with tracking.');\n }\n } else {\n config.loggerProvider.warn(\n 'shouldTrackSubmit is ignored because it is not a function or event is not a SubmitEvent.',\n );\n }\n }\n\n amplitude.track(DEFAULT_FORM_SUBMIT_EVENT, {\n [FORM_ID]: stringOrUndefined(form.id),\n [FORM_NAME]: stringOrUndefined(form.name),\n [FORM_DESTINATION]: formDestination,\n });\n hasFormChanged = false;\n });\n };\n\n // Adds listener to existing anchor tags\n const forms = Array.from(document.getElementsByTagName('form'));\n forms.forEach(addFormInteractionListener);\n\n // Adds listener to form tags added after initial load\n /* istanbul ignore else */\n if (typeof MutationObserver !== 'undefined') {\n observer = new MutationObserver((mutations) => {\n mutations.forEach((mutation) => {\n mutation.addedNodes.forEach((node) => {\n // Registration of one node must not abort registration of the rest of the batch, otherwise\n // forms appended after a malformed node are silently never tracked.\n try {\n if (node.nodeName === 'FORM') {\n addFormInteractionListener(node as HTMLFormElement);\n }\n if ('querySelectorAll' in node && typeof node.querySelectorAll === 'function') {\n // Some environments patch querySelectorAll to return a nullish value, so the return type\n // is widened to reflect what may actually arrive at runtime.\n const queryableNode = node as Element;\n const forms: NodeListOf<HTMLFormElement> | null | undefined = queryableNode.querySelectorAll('form');\n forms?.forEach(addFormInteractionListener);\n }\n } catch (error) {\n config.loggerProvider.warn(`Failed to track form interactions for an added node: ${String(error)}`);\n }\n });\n });\n });\n\n observer.observe(document.body, {\n subtree: true,\n childList: true,\n });\n }\n };\n\n // If the document is already loaded, initialize immediately.\n if (document.readyState === 'complete') {\n initializeFormTracking();\n } else {\n // Otherwise, wait for the load event.\n // The form interaction plugin observes changes in the dom. For this to work correctly, the observer can only be setup\n // after the body is built. When Amplitude gets initialized in a script tag, the body tag is still unavailable. So register this\n // only after the window is loaded\n const window = getGlobalScope();\n /* istanbul ignore else*/\n if (window) {\n window.addEventListener('load', initializeFormTracking);\n } else {\n config.loggerProvider.debug('Form interaction tracking is not installed because global is undefined.');\n }\n }\n };\n const execute = async (event: AmplitudeEvent) => event;\n const teardown = async () => {\n observer?.disconnect();\n removeClickListeners();\n };\n\n return {\n name,\n type,\n setup,\n execute,\n teardown,\n };\n};\n\nexport const stringOrUndefined = <T>(name: T): T extends string ? string : undefined => {\n /* istanbul ignore if */\n if (typeof name !== 'string') {\n // We found instances where the value of `name` is an Element and not a string.\n // Elements may have circular references and would throw an error when passed to `JSON.stringify(...)`.\n // If a non-string value is seen, assume there is no value.\n return undefined as T extends string ? string : undefined;\n }\n\n return name as T extends string ? string : undefined;\n};\n\n// Extracts the form action attribute, and normalizes it to a valid URL to preserve the previous behavior of accessing the action property directly.\nexport const extractFormAction = (form: HTMLFormElement): string | null => {\n let formDestination = form.getAttribute('action');\n try {\n // eslint-disable-next-line no-restricted-globals\n formDestination = new URL(encodeURI(formDestination ?? ''), window.location.href).href;\n } catch {\n //\n }\n return formDestination;\n};\n"]}
@@ -0,0 +1,9 @@
1
+ export type RuntimeEnvironment = 'browser' | 'web_worker' | 'service_worker' | 'chrome_extension' | 'chrome_extension_service_worker' | 'node' | 'unknown';
2
+ /**
3
+ * Classifies the JS runtime for diagnostics. The check order is load-bearing:
4
+ * - service worker before web worker: ServiceWorkerGlobalScope inherits from WorkerGlobalScope
5
+ * - browser after the extension split: extension pages and content scripts have a `document`
6
+ * - browser before node: jsdom exposes both `document` and `process.versions.node`
7
+ */
8
+ export declare function getRuntimeEnvironment(): RuntimeEnvironment;
9
+ //# sourceMappingURL=environment.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"environment.d.ts","sourceRoot":"","sources":["../../../src/utils/environment.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,kBAAkB,GAC1B,SAAS,GACT,YAAY,GACZ,gBAAgB,GAChB,kBAAkB,GAClB,iCAAiC,GACjC,MAAM,GACN,SAAS,CAAC;AAwCd;;;;;GAKG;AACH,wBAAgB,qBAAqB,IAAI,kBAAkB,CAmB1D"}
@@ -0,0 +1,60 @@
1
+ import { getGlobalScope } from '@amplitude/analytics-core';
2
+ // All predicates take the already-resolved global scope so the whole classification
3
+ // reads one consistent object.
4
+ // Same check as core's isChromeExtension, on the resolved scope: extension pages,
5
+ // content scripts, and MV3 background workers all expose chrome.runtime.id.
6
+ var isChromeExtension = function (scope) {
7
+ var _a, _b;
8
+ return typeof ((_b = (_a = scope.chrome) === null || _a === void 0 ? void 0 : _a.runtime) === null || _b === void 0 ? void 0 : _b.id) === 'string';
9
+ };
10
+ // A service worker global, including an MV3 extension background worker.
11
+ // ServiceWorkerGlobalScope inherits from WorkerGlobalScope, so isWebWorker also matches
12
+ // here — getRuntimeEnvironment checks this one first.
13
+ var isServiceWorker = function (scope) {
14
+ var ctor = scope.ServiceWorkerGlobalScope;
15
+ return typeof ctor === 'function' && scope instanceof ctor;
16
+ };
17
+ // Dedicated / shared / service worker. `WorkerGlobalScope` is only exposed on worker
18
+ // globals, so its presence is already worker-specific; the instanceof check additionally
19
+ // rules out non-browser runtimes that expose web constructors on a server global.
20
+ var isWebWorker = function (scope) {
21
+ var ctor = scope.WorkerGlobalScope;
22
+ return typeof ctor === 'function' && scope instanceof ctor;
23
+ };
24
+ // Main-thread only: workers have no document.
25
+ var isBrowser = function (scope) {
26
+ return typeof scope.document !== 'undefined';
27
+ };
28
+ // Checks process.versions.node rather than bare process: bundlers commonly inject a
29
+ // process.env shim into browser builds, but not versions.node.
30
+ var isNode = function (scope) {
31
+ var _a, _b;
32
+ return typeof ((_b = (_a = scope.process) === null || _a === void 0 ? void 0 : _a.versions) === null || _b === void 0 ? void 0 : _b.node) === 'string';
33
+ };
34
+ /**
35
+ * Classifies the JS runtime for diagnostics. The check order is load-bearing:
36
+ * - service worker before web worker: ServiceWorkerGlobalScope inherits from WorkerGlobalScope
37
+ * - browser after the extension split: extension pages and content scripts have a `document`
38
+ * - browser before node: jsdom exposes both `document` and `process.versions.node`
39
+ */
40
+ export function getRuntimeEnvironment() {
41
+ var scope = getGlobalScope();
42
+ if (!scope) {
43
+ return 'unknown';
44
+ }
45
+ var isExtension = isChromeExtension(scope);
46
+ if (isServiceWorker(scope)) {
47
+ return isExtension ? 'chrome_extension_service_worker' : 'service_worker';
48
+ }
49
+ if (isWebWorker(scope)) {
50
+ return 'web_worker';
51
+ }
52
+ if (isBrowser(scope)) {
53
+ return isExtension ? 'chrome_extension' : 'browser';
54
+ }
55
+ if (isNode(scope)) {
56
+ return 'node';
57
+ }
58
+ return 'unknown';
59
+ }
60
+ //# sourceMappingURL=environment.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"environment.js","sourceRoot":"","sources":["../../../src/utils/environment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAa3D,oFAAoF;AACpF,+BAA+B;AAE/B,kFAAkF;AAClF,4EAA4E;AAC5E,IAAM,iBAAiB,GAAG,UAAC,KAAY;;IACrC,OAAO,OAAO,CAAA,MAAA,MAAC,KAAqD,CAAC,MAAM,0CAAE,OAAO,0CAAE,EAAE,CAAA,KAAK,QAAQ,CAAC;AACxG,CAAC,CAAC;AAEF,yEAAyE;AACzE,wFAAwF;AACxF,sDAAsD;AACtD,IAAM,eAAe,GAAG,UAAC,KAAY;IACnC,IAAM,IAAI,GAAI,KAA0D,CAAC,wBAAwB,CAAC;IAClG,OAAO,OAAO,IAAI,KAAK,UAAU,IAAI,KAAK,YAAY,IAAI,CAAC;AAC7D,CAAC,CAAC;AAEF,qFAAqF;AACrF,yFAAyF;AACzF,kFAAkF;AAClF,IAAM,WAAW,GAAG,UAAC,KAAY;IAC/B,IAAM,IAAI,GAAI,KAAmD,CAAC,iBAAiB,CAAC;IACpF,OAAO,OAAO,IAAI,KAAK,UAAU,IAAI,KAAK,YAAY,IAAI,CAAC;AAC7D,CAAC,CAAC;AAEF,8CAA8C;AAC9C,IAAM,SAAS,GAAG,UAAC,KAAY;IAC7B,OAAO,OAAQ,KAAgC,CAAC,QAAQ,KAAK,WAAW,CAAC;AAC3E,CAAC,CAAC;AAEF,oFAAoF;AACpF,+DAA+D;AAC/D,IAAM,MAAM,GAAG,UAAC,KAAY;;IAC1B,OAAO,OAAO,CAAA,MAAA,MAAC,KAAyD,CAAC,OAAO,0CAAE,QAAQ,0CAAE,IAAI,CAAA,KAAK,QAAQ,CAAC;AAChH,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB;IACnC,IAAM,KAAK,GAAG,cAAc,EAAE,CAAC;IAC/B,IAAI,CAAC,KAAK,EAAE;QACV,OAAO,SAAS,CAAC;KAClB;IACD,IAAM,WAAW,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAC7C,IAAI,eAAe,CAAC,KAAK,CAAC,EAAE;QAC1B,OAAO,WAAW,CAAC,CAAC,CAAC,iCAAiC,CAAC,CAAC,CAAC,gBAAgB,CAAC;KAC3E;IACD,IAAI,WAAW,CAAC,KAAK,CAAC,EAAE;QACtB,OAAO,YAAY,CAAC;KACrB;IACD,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE;QACpB,OAAO,WAAW,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAC;KACrD;IACD,IAAI,MAAM,CAAC,KAAK,CAAC,EAAE;QACjB,OAAO,MAAM,CAAC;KACf;IACD,OAAO,SAAS,CAAC;AACnB,CAAC","sourcesContent":["import { getGlobalScope } from '@amplitude/analytics-core';\n\nexport type RuntimeEnvironment =\n | 'browser'\n | 'web_worker'\n | 'service_worker'\n | 'chrome_extension'\n | 'chrome_extension_service_worker'\n | 'node'\n | 'unknown';\n\ntype Scope = NonNullable<ReturnType<typeof getGlobalScope>>;\n\n// All predicates take the already-resolved global scope so the whole classification\n// reads one consistent object.\n\n// Same check as core's isChromeExtension, on the resolved scope: extension pages,\n// content scripts, and MV3 background workers all expose chrome.runtime.id.\nconst isChromeExtension = (scope: Scope): boolean => {\n return typeof (scope as { chrome?: { runtime?: { id?: unknown } } }).chrome?.runtime?.id === 'string';\n};\n\n// A service worker global, including an MV3 extension background worker.\n// ServiceWorkerGlobalScope inherits from WorkerGlobalScope, so isWebWorker also matches\n// here — getRuntimeEnvironment checks this one first.\nconst isServiceWorker = (scope: Scope): boolean => {\n const ctor = (scope as { ServiceWorkerGlobalScope?: new () => unknown }).ServiceWorkerGlobalScope;\n return typeof ctor === 'function' && scope instanceof ctor;\n};\n\n// Dedicated / shared / service worker. `WorkerGlobalScope` is only exposed on worker\n// globals, so its presence is already worker-specific; the instanceof check additionally\n// rules out non-browser runtimes that expose web constructors on a server global.\nconst isWebWorker = (scope: Scope): boolean => {\n const ctor = (scope as { WorkerGlobalScope?: new () => unknown }).WorkerGlobalScope;\n return typeof ctor === 'function' && scope instanceof ctor;\n};\n\n// Main-thread only: workers have no document.\nconst isBrowser = (scope: Scope): boolean => {\n return typeof (scope as { document?: unknown }).document !== 'undefined';\n};\n\n// Checks process.versions.node rather than bare process: bundlers commonly inject a\n// process.env shim into browser builds, but not versions.node.\nconst isNode = (scope: Scope): boolean => {\n return typeof (scope as { process?: { versions?: { node?: unknown } } }).process?.versions?.node === 'string';\n};\n\n/**\n * Classifies the JS runtime for diagnostics. The check order is load-bearing:\n * - service worker before web worker: ServiceWorkerGlobalScope inherits from WorkerGlobalScope\n * - browser after the extension split: extension pages and content scripts have a `document`\n * - browser before node: jsdom exposes both `document` and `process.versions.node`\n */\nexport function getRuntimeEnvironment(): RuntimeEnvironment {\n const scope = getGlobalScope();\n if (!scope) {\n return 'unknown';\n }\n const isExtension = isChromeExtension(scope);\n if (isServiceWorker(scope)) {\n return isExtension ? 'chrome_extension_service_worker' : 'service_worker';\n }\n if (isWebWorker(scope)) {\n return 'web_worker';\n }\n if (isBrowser(scope)) {\n return isExtension ? 'chrome_extension' : 'browser';\n }\n if (isNode(scope)) {\n return 'node';\n }\n return 'unknown';\n}\n"]}
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "2.46.0-video-analytics.0";
1
+ export declare const VERSION = "2.46.0-video-analytics-4.0";
2
2
  //# sourceMappingURL=version.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,6BAA6B,CAAC"}
1
+ {"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,+BAA+B,CAAC"}
@@ -1,2 +1,2 @@
1
- export var VERSION = '2.46.0-video-analytics.0';
1
+ export var VERSION = '2.46.0-video-analytics-4.0';
2
2
  //# sourceMappingURL=version.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,IAAM,OAAO,GAAG,0BAA0B,CAAC","sourcesContent":["export const VERSION = '2.46.0-video-analytics.0';\n"]}
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.46.0-video-analytics-4.0';\n"]}
@@ -10,14 +10,15 @@ export declare class VideoCapture {
10
10
  private listeners;
11
11
  private onRemoveListeners;
12
12
  private playId;
13
+ private playStartTime;
13
14
  constructor(amplitude: BrowserClient);
14
15
  /**
15
- * Specify a video element to capture events from
16
+ * Specify a video or audio element to capture events from
16
17
  *
17
- * @param videoEl - The HTML video element to capture events from.
18
+ * @param videoEl - The HTML video or audio element to capture events from.
18
19
  * @returns The VideoCapture instance.
19
20
  */
20
- withVideoElement(videoEl: HTMLVideoElement): VideoCapture;
21
+ withVideoElement(videoEl: HTMLMediaElement): VideoCapture;
21
22
  /**
22
23
  * Specify an embedded video player.js instance to capture events from
23
24
  * @param player - The embedded video player.js instance to capture events from.
@@ -39,12 +40,12 @@ export declare class VideoCapture {
39
40
  */
40
41
  withExtraEventProperties(properties: Record<string, string | number | boolean>): VideoCapture;
41
42
  /**
42
- * Track a "Video Content Started" event every time the video starts playing
43
+ * Track a "[Amplitude] Content Started" event every time the video starts playing
43
44
  * @returns The VideoCapture instance.
44
45
  */
45
46
  captureVideoStarted(): VideoCapture;
46
47
  /**
47
- * Track a "Video Content Stopped" event every time the video stops playing
48
+ * Track a "[Amplitude] Content Stopped" event every time the video stops playing
48
49
  * @returns The VideoCapture instance.
49
50
  */
50
51
  captureVideoStopped(): VideoCapture;
@@ -71,6 +72,7 @@ export declare class VideoCapture {
71
72
  */
72
73
  stop(): void;
73
74
  parseStartEventProperties(nextState: VideoState): Record<string, string | number | boolean>;
75
+ private getDeliveryMode;
74
76
  parseStopEventProperties(nextState: VideoState): Record<string, string | number | boolean>;
75
77
  }
76
78
  export type VideoCaptureOptions = {
@@ -80,16 +82,16 @@ export type VideoCaptureOptions = {
80
82
  type UntrackVideoResult = () => void;
81
83
  export type TrackVideoResult = UntrackVideoResult | Error;
82
84
  /**
83
- * Track video analytics events for an HTML video element or embedded video player.js instance.
85
+ * Track video analytics events for an HTML video or audio element or embedded video player.js instance.
84
86
  *
85
- * Captures Video Started and Video Stopped events.
87
+ * Captures [Amplitude] Content Started and [Amplitude] Content Stopped events.
86
88
  *
87
89
  * @experimental This function is experimental and may not be stable.
88
90
  * @param amplitude - The Amplitude client instance.
89
- * @param videoEl - The HTML video element or embedded video player.js instance to capture events from.
91
+ * @param videoEl - The HTML video or audio element or embedded video player.js instance to capture events from.
90
92
  * @param options - The options for the video capture.
91
93
  * @returns A function to stop the video capture.
92
94
  */
93
- export declare function trackVideo(amplitude: BrowserClient, videoEl: HTMLVideoElement | EmbeddedVideoPlayer, options?: VideoCaptureOptions): TrackVideoResult;
95
+ export declare function trackVideo(amplitude: BrowserClient, videoEl: HTMLMediaElement | EmbeddedVideoPlayer, options?: VideoCaptureOptions): TrackVideoResult;
94
96
  export {};
95
97
  //# 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,EACL,UAAU,EAEV,aAAa,EACb,mBAAmB,EACnB,WAAW,EAIZ,MAAM,2BAA2B,CAAC;AAKnC,qBAAa,YAAY;IAWX,OAAO,CAAC,QAAQ,CAAC,SAAS;IAVtC,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;gBAER,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;;;OAGG;IACH,mBAAmB,IAAI,YAAY;IAoCnC;;;OAGG;IACH,mBAAmB,IAAI,YAAY;IAuBnC;;;;;;;OAOG;IACH,OAAO,CAAC,cAAc;IAkBtB;;;;OAIG;IACH,KAAK,IAAI,YAAY;IA2BrB;;;;;OAKG;IACH,IAAI;IAMJ,yBAAyB,CAAC,SAAS,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IAQ3F,wBAAwB,CAAC,SAAS,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;CAQ3F;AAED,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
+ {"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,EAIZ,MAAM,2BAA2B,CAAC;AA4BnC,qBAAa,YAAY;IAYX,OAAO,CAAC,QAAQ,CAAC,SAAS;IAXtC,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,aAAa,CAAuB;gBAEf,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;;;OAGG;IACH,mBAAmB,IAAI,YAAY;IAoCnC;;;OAGG;IACH,mBAAmB,IAAI,YAAY;IAuBnC;;;;;;;OAOG;IACH,OAAO,CAAC,cAAc;IAmBtB;;;;OAIG;IACH,KAAK,IAAI,YAAY;IA2BrB;;;;;OAKG;IACH,IAAI;IAMJ,yBAAyB,CAAC,SAAS,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IAU3F,OAAO,CAAC,eAAe;IAIvB,wBAAwB,CAAC,SAAS,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;CAW3F;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,7 +1,39 @@
1
- import { __assign } from "tslib";
1
+ import { __assign, __read, __values } from "tslib";
2
2
  import { VideoObserver, UUID, getHeartbeatInstance, } from '@amplitude/analytics-core';
3
+ import { DEFAULT_CONTENT_STARTED_EVENT, DEFAULT_CONTENT_STOPPED_EVENT } from '../constants';
3
4
  /** Playback states where a view session is still in progress (e.g. buffering). */
4
5
  var ACTIVE_PLAYBACK_STATES = new Set(['playing', 'waiting']);
6
+ /**
7
+ * Observer fields that never reach event properties: `last_position` is an observer internal,
8
+ * and `percent_completed`/`stop_reason` describe the player event rather than the play session,
9
+ * which tracks its own values.
10
+ */
11
+ var OMITTED_VIDEO_EVENT_PROPERTIES = new Set(['last_position', 'percent_completed', 'stop_reason']);
12
+ /**
13
+ * Copy remaining player-event fields (vendor metadata such as `mux_playback_id`, ids, titles)
14
+ * onto the Amplitude event, dropping empty values so absent metadata is omitted.
15
+ */
16
+ function parseVideoEventProperties(lastEvent) {
17
+ var e_1, _a;
18
+ var properties = {};
19
+ try {
20
+ for (var _b = __values(Object.entries(lastEvent !== null && lastEvent !== void 0 ? lastEvent : {})), _c = _b.next(); !_c.done; _c = _b.next()) {
21
+ var _d = __read(_c.value, 2), key = _d[0], value = _d[1];
22
+ if (OMITTED_VIDEO_EVENT_PROPERTIES.has(key) || value === null || value === undefined) {
23
+ continue;
24
+ }
25
+ properties[key] = value;
26
+ }
27
+ }
28
+ catch (e_1_1) { e_1 = { error: e_1_1 }; }
29
+ finally {
30
+ try {
31
+ if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
32
+ }
33
+ finally { if (e_1) throw e_1.error; }
34
+ }
35
+ return properties;
36
+ }
5
37
  var VideoCapture = /** @class */ (function () {
6
38
  function VideoCapture(amplitude) {
7
39
  this.amplitude = amplitude;
@@ -12,12 +44,13 @@ var VideoCapture = /** @class */ (function () {
12
44
  this.listeners = [];
13
45
  this.onRemoveListeners = [];
14
46
  this.playId = null;
47
+ this.playStartTime = null;
15
48
  this.heartbeat = getHeartbeatInstance(this.amplitude);
16
49
  }
17
50
  /**
18
- * Specify a video element to capture events from
51
+ * Specify a video or audio element to capture events from
19
52
  *
20
- * @param videoEl - The HTML video element to capture events from.
53
+ * @param videoEl - The HTML video or audio element to capture events from.
21
54
  * @returns The VideoCapture instance.
22
55
  */
23
56
  VideoCapture.prototype.withVideoElement = function (videoEl) {
@@ -54,22 +87,25 @@ var VideoCapture = /** @class */ (function () {
54
87
  return this;
55
88
  };
56
89
  /**
57
- * Track a "Video Content Started" event every time the video starts playing
90
+ * Track a "[Amplitude] Content Started" event every time the video starts playing
58
91
  * @returns The VideoCapture instance.
59
92
  */
60
93
  VideoCapture.prototype.captureVideoStarted = function () {
61
94
  var _this = this;
62
95
  this.listeners.push(function (previousState, nextState) {
96
+ var _a, _b;
63
97
  if (!ACTIVE_PLAYBACK_STATES.has(previousState.playbackState) && nextState.playbackState === 'playing') {
64
98
  _this.playId = UUID();
99
+ /* istanbul ignore next */
100
+ _this.playStartTime = (_b = (_a = nextState.lastEvent) === null || _a === void 0 ? void 0 : _a.start_time) !== null && _b !== void 0 ? _b : 0;
65
101
  var now = new Date().getTime();
66
102
  var startEvent = {
67
103
  insert_id: UUID(),
68
- event_type: 'Video Content Started',
104
+ event_type: DEFAULT_CONTENT_STARTED_EVENT,
69
105
  time: now,
70
- event_properties: __assign(__assign(__assign(__assign({}, nextState.lastEvent), _this.parseStartEventProperties(nextState)), _this.extraEventProperties), { play_id: _this.playId }),
106
+ event_properties: __assign(__assign(__assign({}, _this.parseStartEventProperties(nextState)), _this.extraEventProperties), { play_id: _this.playId }),
71
107
  };
72
- _this.stopEvent = __assign(__assign({}, startEvent), { insert_id: UUID(), event_type: 'Video Content Stopped', time: now + 1, event_properties: __assign(__assign(__assign(__assign({}, nextState.lastEvent), _this.parseStopEventProperties(nextState)), _this.extraEventProperties), { stop_reason: 'timeout', play_id: _this.playId }) });
108
+ _this.stopEvent = __assign(__assign({}, startEvent), { insert_id: UUID(), event_type: DEFAULT_CONTENT_STOPPED_EVENT, time: now + 1, event_properties: __assign(__assign(__assign({}, _this.parseStopEventProperties(nextState)), _this.extraEventProperties), { stop_reason: 'timeout', play_id: _this.playId }) });
73
109
  _this.heartbeat.trackNoDelay(startEvent).catch(_this.stop.bind(_this));
74
110
  _this.heartbeat.track(_this.stopEvent).catch(_this.stop.bind(_this));
75
111
  }
@@ -77,7 +113,7 @@ var VideoCapture = /** @class */ (function () {
77
113
  return this;
78
114
  };
79
115
  /**
80
- * Track a "Video Content Stopped" event every time the video stops playing
116
+ * Track a "[Amplitude] Content Stopped" event every time the video stops playing
81
117
  * @returns The VideoCapture instance.
82
118
  */
83
119
  VideoCapture.prototype.captureVideoStopped = function () {
@@ -112,6 +148,7 @@ var VideoCapture = /** @class */ (function () {
112
148
  }
113
149
  // the next play queues a fresh delayed stop event
114
150
  this.stopEvent = null;
151
+ this.playStartTime = null;
115
152
  stopEvent.event_properties = __assign(__assign({}, stopEvent.event_properties), { stop_reason: stopReason });
116
153
  this.heartbeat.trackNoDelay(stopEvent).catch(this.stop.bind(this));
117
154
  };
@@ -159,28 +196,35 @@ var VideoCapture = /** @class */ (function () {
159
196
  };
160
197
  VideoCapture.prototype.parseStartEventProperties = function (nextState) {
161
198
  var _a, _b, _c, _d, _e;
162
- return {
163
- duration: (_b = (_a = nextState.lastEvent) === null || _a === void 0 ? void 0 : _a.duration) !== null && _b !== void 0 ? _b : 0,
164
- start_time: (_d = (_c = nextState.lastEvent) === null || _c === void 0 ? void 0 : _c.start_time) !== null && _d !== void 0 ? _d : 0,
165
- position: (_e = nextState.position) !== null && _e !== void 0 ? _e : 0,
166
- };
199
+ return __assign(__assign({}, parseVideoEventProperties(nextState.lastEvent)), { duration: (_b = (_a = nextState.lastEvent) === null || _a === void 0 ? void 0 : _a.duration) !== null && _b !== void 0 ? _b : 0, start_time: (_d = (_c = nextState.lastEvent) === null || _c === void 0 ? void 0 : _c.start_time) !== null && _d !== void 0 ? _d : 0, position: (_e = nextState.position) !== null && _e !== void 0 ? _e : 0, delivery_mode: this.getDeliveryMode() });
200
+ };
201
+ VideoCapture.prototype.getDeliveryMode = function () {
202
+ return this.videoEl instanceof HTMLAudioElement ? 'audio' : 'video';
167
203
  };
168
204
  VideoCapture.prototype.parseStopEventProperties = function (nextState) {
169
- var _a, _b, _c, _d;
170
- var percentCompleted = (((_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)) * 100;
171
- return __assign(__assign({}, this.parseStartEventProperties(nextState)), { watch_duration: (_d = nextState.watchTime) !== null && _d !== void 0 ? _d : 0, percent_completed: percentCompleted || 0 });
205
+ var _a, _b, _c, _d, _e, _f, _g;
206
+ return __assign(__assign(__assign({}, this.parseStartEventProperties(nextState)), {
207
+ // lastEvent.start_time is the playhead at the time of the event, which for a stop event is
208
+ // where playback ended, so the position captured when the play session began is preferred.
209
+ start_time: (_c = (_a = this.playStartTime) !== null && _a !== void 0 ? _a : (_b = nextState.lastEvent) === null || _b === void 0 ? void 0 : _b.start_time) !== null && _c !== void 0 ? _c : 0, watch_duration: (_d = nextState.watchTime) !== null && _d !== void 0 ? _d : 0, percent_completed: calculatePercentCompleted((_e = nextState.position) !== null && _e !== void 0 ? _e : 0, (_g = (_f = nextState.lastEvent) === null || _f === void 0 ? void 0 : _f.duration) !== null && _g !== void 0 ? _g : 0) }), (nextState.errorMessage ? { error_message: nextState.errorMessage } : {}));
172
210
  };
173
211
  return VideoCapture;
174
212
  }());
175
213
  export { VideoCapture };
214
+ function calculatePercentCompleted(currentTime, duration) {
215
+ if (!Number.isFinite(currentTime) || !Number.isFinite(duration) || duration <= 0) {
216
+ return 0;
217
+ }
218
+ return Math.min(100, Math.max(0, (currentTime / duration) * 100));
219
+ }
176
220
  /**
177
- * Track video analytics events for an HTML video element or embedded video player.js instance.
221
+ * Track video analytics events for an HTML video or audio element or embedded video player.js instance.
178
222
  *
179
- * Captures Video Started and Video Stopped events.
223
+ * Captures [Amplitude] Content Started and [Amplitude] Content Stopped events.
180
224
  *
181
225
  * @experimental This function is experimental and may not be stable.
182
226
  * @param amplitude - The Amplitude client instance.
183
- * @param videoEl - The HTML video element or embedded video player.js instance to capture events from.
227
+ * @param videoEl - The HTML video or audio element or embedded video player.js instance to capture events from.
184
228
  * @param options - The options for the video capture.
185
229
  * @returns A function to stop the video capture.
186
230
  */
@@ -188,7 +232,7 @@ export function trackVideo(amplitude, videoEl, options) {
188
232
  var _a;
189
233
  if (options === void 0) { options = {}; }
190
234
  var videoCapture = new VideoCapture(amplitude);
191
- if (videoEl instanceof HTMLVideoElement) {
235
+ if (videoEl instanceof HTMLMediaElement) {
192
236
  videoCapture.withVideoElement(videoEl);
193
237
  }
194
238
  else {
@@ -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,EAEJ,oBAAoB,GACrB,MAAM,2BAA2B,CAAC;AAEnC,kFAAkF;AAClF,IAAM,sBAAsB,GAAG,IAAI,GAAG,CAA8B,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;AAE5F;IAWE,sBAA6B,SAAwB;QAAxB,cAAS,GAAT,SAAS,CAAe;QAV7C,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;QAGnC,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;;;OAGG;IACH,0CAAmB,GAAnB;QAAA,iBAkCC;QAjCC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAC,aAAa,EAAE,SAAS;YAC3C,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,SAAS,CAAC,aAAa,KAAK,SAAS,EAAE;gBACrG,KAAI,CAAC,MAAM,GAAG,IAAI,EAAE,CAAC;gBACrB,IAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;gBACjC,IAAM,UAAU,GAAc;oBAC5B,SAAS,EAAE,IAAI,EAAE;oBACjB,UAAU,EAAE,uBAAuB;oBACnC,IAAI,EAAE,GAAG;oBACT,gBAAgB,0CACX,SAAS,CAAC,SAAS,GACnB,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,uBAAuB,EACnC,IAAI,EAAE,GAAG,GAAG,CAAC,EACb,gBAAgB,0CACX,SAAS,CAAC,SAAS,GACnB,KAAI,CAAC,wBAAwB,CAAC,SAAS,CAAC,GACxC,KAAI,CAAC,oBAAoB,KAC5B,WAAW,EAAE,SAAS,EACtB,OAAO,EAAE,KAAI,CAAC,MAAM,MAEvB,CAAC;gBACF,KAAI,CAAC,SAAS,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,KAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAI,CAAC,CAAC,CAAC;gBACpE,KAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAI,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,KAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAI,CAAC,CAAC,CAAC;aAClE;QACH,CAAC,CAAC,CAAC;QACH,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,kCAC1B,KAAI,CAAC,SAAS,CAAC,gBAAgB,GAC/B,KAAI,CAAC,wBAAwB,CAAC,SAAS,CAAC,GACxC,KAAI,CAAC,oBAAoB,CAC7B,CAAC;gBACF,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,SAAS,CAAC,aAAa,CAAC,CAAC;aAC9C;QACH,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACK,qCAAc,GAAtB,UAAuB,UAAkB;QACvC,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,SAAS,CAAC,gBAAgB,yBACrB,SAAS,CAAC,gBAAgB,KAC7B,WAAW,EAAE,UAAU,GACxB,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACrE,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;;;;;OAKG;IACH,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;QAC5B,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IACnC,CAAC;IAED,gDAAyB,GAAzB,UAA0B,SAAqB;;QAC7C,OAAO;YACL,QAAQ,EAAE,MAAA,MAAA,SAAS,CAAC,SAAS,0CAAE,QAAQ,mCAAI,CAAC;YAC5C,UAAU,EAAE,MAAA,MAAA,SAAS,CAAC,SAAS,0CAAE,UAAU,mCAAI,CAAC;YAChD,QAAQ,EAAE,MAAA,SAAS,CAAC,QAAQ,mCAAI,CAAC;SAClC,CAAC;IACJ,CAAC;IAED,+CAAwB,GAAxB,UAAyB,SAAqB;;QAC5C,IAAM,gBAAgB,GAAG,CAAC,CAAC,MAAA,SAAS,CAAC,QAAQ,mCAAI,CAAC,CAAC,GAAG,CAAC,MAAA,MAAA,SAAS,CAAC,SAAS,0CAAE,QAAQ,mCAAI,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC;QAClG,6BACK,IAAI,CAAC,yBAAyB,CAAC,SAAS,CAAC,KAC5C,cAAc,EAAE,MAAA,SAAS,CAAC,SAAS,mCAAI,CAAC,EACxC,iBAAiB,EAAE,gBAAgB,IAAI,CAAC,IACxC;IACJ,CAAC;IACH,mBAAC;AAAD,CAAC,AAnND,IAmNC;;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 BaseEvent,\n getHeartbeatInstance,\n} from '@amplitude/analytics-core';\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 class VideoCapture {\n private videoEl: HTMLVideoElement | 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\n constructor(private readonly amplitude: BrowserClient) {\n this.heartbeat = getHeartbeatInstance(this.amplitude);\n }\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 (!ACTIVE_PLAYBACK_STATES.has(previousState.playbackState) && nextState.playbackState === 'playing') {\n this.playId = UUID();\n const now = new Date().getTime();\n const startEvent: BaseEvent = {\n insert_id: UUID(),\n event_type: 'Video Content Started',\n time: now,\n event_properties: {\n ...nextState.lastEvent,\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: 'Video Content Stopped',\n time: now + 1,\n event_properties: {\n ...nextState.lastEvent,\n ...this.parseStopEventProperties(nextState),\n ...this.extraEventProperties,\n stop_reason: 'timeout',\n play_id: this.playId,\n },\n };\n this.heartbeat.trackNoDelay(startEvent).catch(this.stop.bind(this));\n this.heartbeat.track(this.stopEvent).catch(this.stop.bind(this));\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 // update the delayed event properties to have\n // the most up-to-date values\n if (this.stopEvent) {\n this.stopEvent.event_properties = {\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.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 stopEvent.event_properties = {\n ...stopEvent.event_properties,\n stop_reason: stopReason,\n };\n this.heartbeat.trackNoDelay(stopEvent).catch(this.stop.bind(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 /**\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() {\n this.onRemoveListeners.forEach((listener) => listener());\n this.onRemoveListeners = [];\n this.flushStopEvent('untracked');\n }\n\n parseStartEventProperties(nextState: VideoState): Record<string, string | number | boolean> {\n return {\n duration: nextState.lastEvent?.duration ?? 0,\n start_time: nextState.lastEvent?.start_time ?? 0,\n position: nextState.position ?? 0,\n };\n }\n\n parseStopEventProperties(nextState: VideoState): Record<string, string | number | boolean> {\n const percentCompleted = ((nextState.position ?? 0) / (nextState.lastEvent?.duration ?? 0)) * 100;\n return {\n ...this.parseStartEventProperties(nextState),\n watch_duration: nextState.watchTime ?? 0,\n percent_completed: percentCompleted || 0,\n };\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,EAIb,IAAI,EAEJ,oBAAoB,GACrB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,6BAA6B,EAAE,6BAA6B,EAAE,MAAM,cAAc,CAAC;AAE5F,kFAAkF;AAClF,IAAM,sBAAsB,GAAG,IAAI,GAAG,CAA8B,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;AAE5F;;;;GAIG;AACH,IAAM,8BAA8B,GAAG,IAAI,GAAG,CAAC,CAAC,eAAe,EAAE,mBAAmB,EAAE,aAAa,CAAC,CAAC,CAAC;AAEtG;;;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;IAYE,sBAA6B,SAAwB;QAAxB,cAAS,GAAT,SAAS,CAAe;QAX7C,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,kBAAa,GAAkB,IAAI,CAAC;QAG1C,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;;;OAGG;IACH,0CAAmB,GAAnB;QAAA,iBAkCC;QAjCC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAC,aAAa,EAAE,SAAS;;YAC3C,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,SAAS,CAAC,aAAa,KAAK,SAAS,EAAE;gBACrG,KAAI,CAAC,MAAM,GAAG,IAAI,EAAE,CAAC;gBACrB,0BAA0B;gBAC1B,KAAI,CAAC,aAAa,GAAG,MAAA,MAAA,SAAS,CAAC,SAAS,0CAAE,UAAU,mCAAI,CAAC,CAAC;gBAC1D,IAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;gBACjC,IAAM,UAAU,GAAc;oBAC5B,SAAS,EAAE,IAAI,EAAE;oBACjB,UAAU,EAAE,6BAA6B;oBACzC,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,6BAA6B,EACzC,IAAI,EAAE,GAAG,GAAG,CAAC,EACb,gBAAgB,iCACX,KAAI,CAAC,wBAAwB,CAAC,SAAS,CAAC,GACxC,KAAI,CAAC,oBAAoB,KAC5B,WAAW,EAAE,SAAS,EACtB,OAAO,EAAE,KAAI,CAAC,MAAM,MAEvB,CAAC;gBACF,KAAI,CAAC,SAAS,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,KAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAI,CAAC,CAAC,CAAC;gBACpE,KAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAI,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,KAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAI,CAAC,CAAC,CAAC;aAClE;QACH,CAAC,CAAC,CAAC;QACH,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,kCAC1B,KAAI,CAAC,SAAS,CAAC,gBAAgB,GAC/B,KAAI,CAAC,wBAAwB,CAAC,SAAS,CAAC,GACxC,KAAI,CAAC,oBAAoB,CAC7B,CAAC;gBACF,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,SAAS,CAAC,aAAa,CAAC,CAAC;aAC9C;QACH,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACK,qCAAc,GAAtB,UAAuB,UAAkB;QACvC,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,aAAa,GAAG,IAAI,CAAC;QAC1B,SAAS,CAAC,gBAAgB,yBACrB,SAAS,CAAC,gBAAgB,KAC7B,WAAW,EAAE,UAAU,GACxB,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACrE,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;;;;;OAKG;IACH,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;QAC5B,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IACnC,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,CAAC,EAC5C,UAAU,EAAE,MAAA,MAAA,SAAS,CAAC,SAAS,0CAAE,UAAU,mCAAI,CAAC,EAChD,QAAQ,EAAE,MAAA,SAAS,CAAC,QAAQ,mCAAI,CAAC,EACjC,aAAa,EAAE,IAAI,CAAC,eAAe,EAAE,IACrC;IACJ,CAAC;IAEO,sCAAe,GAAvB;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,2FAA2F;YAC3F,2FAA2F;YAC3F,UAAU,EAAE,MAAA,MAAA,IAAI,CAAC,aAAa,mCAAI,MAAA,SAAS,CAAC,SAAS,0CAAE,UAAU,mCAAI,CAAC,EACtE,cAAc,EAAE,MAAA,SAAS,CAAC,SAAS,mCAAI,CAAC,EACxC,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;IACH,mBAAC;AAAD,CAAC,AA9ND,IA8NC;;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,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 BaseEvent,\n getHeartbeatInstance,\n} from '@amplitude/analytics-core';\nimport { DEFAULT_CONTENT_STARTED_EVENT, DEFAULT_CONTENT_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\n/**\n * Observer fields that never reach event properties: `last_position` is an observer internal,\n * and `percent_completed`/`stop_reason` describe the player event rather than the play session,\n * which tracks its own values.\n */\nconst OMITTED_VIDEO_EVENT_PROPERTIES = new Set(['last_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 playStartTime: number | null = null;\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 /**\n * Track a \"[Amplitude] 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 (!ACTIVE_PLAYBACK_STATES.has(previousState.playbackState) && nextState.playbackState === 'playing') {\n this.playId = UUID();\n /* istanbul ignore next */\n this.playStartTime = nextState.lastEvent?.start_time ?? 0;\n const now = new Date().getTime();\n const startEvent: BaseEvent = {\n insert_id: UUID(),\n event_type: DEFAULT_CONTENT_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_CONTENT_STOPPED_EVENT,\n time: now + 1,\n event_properties: {\n ...this.parseStopEventProperties(nextState),\n ...this.extraEventProperties,\n stop_reason: 'timeout',\n play_id: this.playId,\n },\n };\n this.heartbeat.trackNoDelay(startEvent).catch(this.stop.bind(this));\n this.heartbeat.track(this.stopEvent).catch(this.stop.bind(this));\n }\n });\n return this;\n }\n\n /**\n * Track a \"[Amplitude] 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 // update the delayed event properties to have\n // the most up-to-date values\n if (this.stopEvent) {\n this.stopEvent.event_properties = {\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.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.playStartTime = null;\n stopEvent.event_properties = {\n ...stopEvent.event_properties,\n stop_reason: stopReason,\n };\n this.heartbeat.trackNoDelay(stopEvent).catch(this.stop.bind(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 /**\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() {\n this.onRemoveListeners.forEach((listener) => listener());\n this.onRemoveListeners = [];\n this.flushStopEvent('untracked');\n }\n\n parseStartEventProperties(nextState: VideoState): Record<string, string | number | boolean> {\n return {\n ...parseVideoEventProperties(nextState.lastEvent),\n duration: nextState.lastEvent?.duration ?? 0,\n start_time: nextState.lastEvent?.start_time ?? 0,\n position: nextState.position ?? 0,\n delivery_mode: this.getDeliveryMode(),\n };\n }\n\n private getDeliveryMode(): '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 // lastEvent.start_time is the playhead at the time of the event, which for a stop event is\n // where playback ended, so the position captured when the play session began is preferred.\n start_time: this.playStartTime ?? nextState.lastEvent?.start_time ?? 0,\n watch_duration: nextState.watchTime ?? 0,\n percent_completed: calculatePercentCompleted(nextState.position ?? 0, nextState.lastEvent?.duration ?? 0),\n ...(nextState.errorMessage ? { error_message: nextState.errorMessage } : {}),\n };\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 [Amplitude] Content Started and [Amplitude] Content 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 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 +1 @@
1
- !function(){"use strict";!function(e,t){var n=e.amplitude||{_q:[],_iq:{}};if(n.invoked)e.console&&console.error&&console.error("Amplitude snippet has been loaded.");else{var r=function(e,t){e.prototype[t]=function(){return this._q.push({name:t,args:Array.prototype.slice.call(arguments,0)}),this}},i=function(e,t,n){return function(r){e._q.push({name:t,args:Array.prototype.slice.call(n,0),resolve:r})}},o=function(e,t,n){e[t]=function(){if(n)return{promise:new Promise(i(e,t,Array.prototype.slice.call(arguments)))}}},s=function(e){for(var t=0;t<f.length;t++)o(e,f[t],!1);for(var n=0;n<y.length;n++)o(e,y[n],!0)};n.invoked=!0;var u=t.getElementsByTagName("script")[0],a=t.createElement("script");a.src="https://cdn.amplitude.com/libs/plugin-autocapture-browser-0.9.0-min.js.gz",a.async=!1,u.parentNode.insertBefore(a,u);var c=t.createElement("script");c.type="text/javascript",c.integrity="sha384-QnKJEdX4u5cVKgbQCNgl5Za2eRKhAEg5YkvexghpNARe7Q4Rl/VAzxFQCnuiTLqb",c.crossOrigin="anonymous",c.async=!1,c.src="https://cdn.amplitude.com/libs/analytics-browser-2.46.0-video-analytics.0-min.js.gz",c.onload=function(){e.amplitude.runQueuedFunctions||console.log("[Amplitude] Error: could not load SDK"),e.amplitude.init("YOUR_API_KEY","YOUR_USER_ID",{instanceName:"amplitude-bookmarklet",serverZone:"YOUR_SERVER_ZONE",ingestionMetadata:{sourceName:"browser-typescript-bookmarklet",sourceVersion:"1.0.0"},optOut:!1}),amplitudeAutocapturePlugin&&amplitudeAutocapturePlugin.autocapturePlugin&&"function"==typeof amplitudeAutocapturePlugin.autocapturePlugin&&e.amplitude.add(amplitudeAutocapturePlugin.autocapturePlugin()),alert("Amplitude is now tracking events!")},u.parentNode.insertBefore(c,u);for(var p=function(){return this._q=[],this},l=["add","append","clearAll","prepend","set","setOnce","unset","preInsert","postInsert","remove","getUserProperties"],d=0;d<l.length;d++)r(p,l[d]);n.Identify=p;for(var g=function(){return this._q=[],this},m=["getEventProperties","setProductId","setQuantity","setPrice","setRevenue","setRevenueType","setReceipt","setReceiptSig","setCurrency","setEventProperties"],v=0;v<m.length;v++)r(g,m[v]);n.Revenue=g;var f=["getDeviceId","setDeviceId","getSessionId","setSessionId","getUserId","setUserId","setOptOut","setTransport","reset","extendSession"],y=["init","add","remove","track","logEvent","identify","groupIdentify","setGroup","revenue","flush"];s(n),n.createInstance=function(e){return n._iq[e]={_q:[]},s(n._iq[e]),n._iq[e]},e.amplitude=n}}(window,document)}();
1
+ !function(){"use strict";!function(e,t){var n=e.amplitude||{_q:[],_iq:{}};if(n.invoked)e.console&&console.error&&console.error("Amplitude snippet has been loaded.");else{var r=function(e,t){e.prototype[t]=function(){return this._q.push({name:t,args:Array.prototype.slice.call(arguments,0)}),this}},i=function(e,t,n){return function(r){e._q.push({name:t,args:Array.prototype.slice.call(n,0),resolve:r})}},o=function(e,t,n){e[t]=function(){if(n)return{promise:new Promise(i(e,t,Array.prototype.slice.call(arguments)))}}},s=function(e){for(var t=0;t<v.length;t++)o(e,v[t],!1);for(var n=0;n<y.length;n++)o(e,y[n],!0)};n.invoked=!0;var u=t.getElementsByTagName("script")[0],a=t.createElement("script");a.src="https://cdn.amplitude.com/libs/plugin-autocapture-browser-0.9.0-min.js.gz",a.async=!1,u.parentNode.insertBefore(a,u);var c=t.createElement("script");c.type="text/javascript",c.integrity="sha384-Iv/3hfl4wm5kzRLNGFYnn9ujyjH+Iw51ByCb+GRzsHlIH1tJ1x1LDjMaKxwZTmz5",c.crossOrigin="anonymous",c.async=!1,c.src="https://cdn.amplitude.com/libs/analytics-browser-2.46.0-video-analytics-4.0-min.js.gz",c.onload=function(){e.amplitude.runQueuedFunctions||console.log("[Amplitude] Error: could not load SDK"),e.amplitude.init("YOUR_API_KEY","YOUR_USER_ID",{instanceName:"amplitude-bookmarklet",serverZone:"YOUR_SERVER_ZONE",ingestionMetadata:{sourceName:"browser-typescript-bookmarklet",sourceVersion:"1.0.0"},optOut:!1}),amplitudeAutocapturePlugin&&amplitudeAutocapturePlugin.autocapturePlugin&&"function"==typeof amplitudeAutocapturePlugin.autocapturePlugin&&e.amplitude.add(amplitudeAutocapturePlugin.autocapturePlugin()),alert("Amplitude is now tracking events!")},u.parentNode.insertBefore(c,u);for(var p=function(){return this._q=[],this},l=["add","append","clearAll","prepend","set","setOnce","unset","preInsert","postInsert","remove","getUserProperties"],d=0;d<l.length;d++)r(p,l[d]);n.Identify=p;for(var m=function(){return this._q=[],this},g=["getEventProperties","setProductId","setQuantity","setPrice","setRevenue","setRevenueType","setReceipt","setReceiptSig","setCurrency","setEventProperties"],f=0;f<g.length;f++)r(m,g[f]);n.Revenue=m;var v=["getDeviceId","setDeviceId","getSessionId","setSessionId","getUserId","setUserId","setOptOut","setTransport","reset","extendSession"],y=["init","add","remove","track","logEvent","identify","groupIdentify","setGroup","revenue","flush"];s(n),n.createInstance=function(e){return n._iq[e]={_q:[]},s(n._iq[e]),n._iq[e]},e.amplitude=n}}(window,document)}();
@@ -1 +1 @@
1
- javascript:!function()%7B%22use%20strict%22%3B!function(e%2Ct)%7Bvar%20n%3De.amplitude%7C%7C%7B_q%3A%5B%5D%2C_iq%3A%7B%7D%7D%3Bif(n.invoked)e.console%26%26console.error%26%26console.error(%22Amplitude%20snippet%20has%20been%20loaded.%22)%3Belse%7Bvar%20r%3Dfunction(e%2Ct)%7Be.prototype%5Bt%5D%3Dfunction()%7Breturn%20this._q.push(%7Bname%3At%2Cargs%3AArray.prototype.slice.call(arguments%2C0)%7D)%2Cthis%7D%7D%2Ci%3Dfunction(e%2Ct%2Cn)%7Breturn%20function(r)%7Be._q.push(%7Bname%3At%2Cargs%3AArray.prototype.slice.call(n%2C0)%2Cresolve%3Ar%7D)%7D%7D%2Co%3Dfunction(e%2Ct%2Cn)%7Be%5Bt%5D%3Dfunction()%7Bif(n)return%7Bpromise%3Anew%20Promise(i(e%2Ct%2CArray.prototype.slice.call(arguments)))%7D%7D%7D%2Cs%3Dfunction(e)%7Bfor(var%20t%3D0%3Bt%3Cf.length%3Bt%2B%2B)o(e%2Cf%5Bt%5D%2C!1)%3Bfor(var%20n%3D0%3Bn%3Cy.length%3Bn%2B%2B)o(e%2Cy%5Bn%5D%2C!0)%7D%3Bn.invoked%3D!0%3Bvar%20u%3Dt.getElementsByTagName(%22script%22)%5B0%5D%2Ca%3Dt.createElement(%22script%22)%3Ba.src%3D%22https%3A%2F%2Fcdn.amplitude.com%2Flibs%2Fplugin-autocapture-browser-0.9.0-min.js.gz%22%2Ca.async%3D!1%2Cu.parentNode.insertBefore(a%2Cu)%3Bvar%20c%3Dt.createElement(%22script%22)%3Bc.type%3D%22text%2Fjavascript%22%2Cc.integrity%3D%22sha384-QnKJEdX4u5cVKgbQCNgl5Za2eRKhAEg5YkvexghpNARe7Q4Rl%2FVAzxFQCnuiTLqb%22%2Cc.crossOrigin%3D%22anonymous%22%2Cc.async%3D!1%2Cc.src%3D%22https%3A%2F%2Fcdn.amplitude.com%2Flibs%2Fanalytics-browser-2.46.0-video-analytics.0-min.js.gz%22%2Cc.onload%3Dfunction()%7Be.amplitude.runQueuedFunctions%7C%7Cconsole.log(%22%5BAmplitude%5D%20Error%3A%20could%20not%20load%20SDK%22)%2Ce.amplitude.init(%22YOUR_API_KEY%22%2C%22YOUR_USER_ID%22%2C%7BinstanceName%3A%22amplitude-bookmarklet%22%2CserverZone%3A%22YOUR_SERVER_ZONE%22%2CingestionMetadata%3A%7BsourceName%3A%22browser-typescript-bookmarklet%22%2CsourceVersion%3A%221.0.0%22%7D%2CoptOut%3A!1%7D)%2CamplitudeAutocapturePlugin%26%26amplitudeAutocapturePlugin.autocapturePlugin%26%26%22function%22%3D%3Dtypeof%20amplitudeAutocapturePlugin.autocapturePlugin%26%26e.amplitude.add(amplitudeAutocapturePlugin.autocapturePlugin())%2Calert(%22Amplitude%20is%20now%20tracking%20events!%22)%7D%2Cu.parentNode.insertBefore(c%2Cu)%3Bfor(var%20p%3Dfunction()%7Breturn%20this._q%3D%5B%5D%2Cthis%7D%2Cl%3D%5B%22add%22%2C%22append%22%2C%22clearAll%22%2C%22prepend%22%2C%22set%22%2C%22setOnce%22%2C%22unset%22%2C%22preInsert%22%2C%22postInsert%22%2C%22remove%22%2C%22getUserProperties%22%5D%2Cd%3D0%3Bd%3Cl.length%3Bd%2B%2B)r(p%2Cl%5Bd%5D)%3Bn.Identify%3Dp%3Bfor(var%20g%3Dfunction()%7Breturn%20this._q%3D%5B%5D%2Cthis%7D%2Cm%3D%5B%22getEventProperties%22%2C%22setProductId%22%2C%22setQuantity%22%2C%22setPrice%22%2C%22setRevenue%22%2C%22setRevenueType%22%2C%22setReceipt%22%2C%22setReceiptSig%22%2C%22setCurrency%22%2C%22setEventProperties%22%5D%2Cv%3D0%3Bv%3Cm.length%3Bv%2B%2B)r(g%2Cm%5Bv%5D)%3Bn.Revenue%3Dg%3Bvar%20f%3D%5B%22getDeviceId%22%2C%22setDeviceId%22%2C%22getSessionId%22%2C%22setSessionId%22%2C%22getUserId%22%2C%22setUserId%22%2C%22setOptOut%22%2C%22setTransport%22%2C%22reset%22%2C%22extendSession%22%5D%2Cy%3D%5B%22init%22%2C%22add%22%2C%22remove%22%2C%22track%22%2C%22logEvent%22%2C%22identify%22%2C%22groupIdentify%22%2C%22setGroup%22%2C%22revenue%22%2C%22flush%22%5D%3Bs(n)%2Cn.createInstance%3Dfunction(e)%7Breturn%20n._iq%5Be%5D%3D%7B_q%3A%5B%5D%7D%2Cs(n._iq%5Be%5D)%2Cn._iq%5Be%5D%7D%2Ce.amplitude%3Dn%7D%7D(window%2Cdocument)%7D()%3B%0A
1
+ javascript:!function()%7B%22use%20strict%22%3B!function(e%2Ct)%7Bvar%20n%3De.amplitude%7C%7C%7B_q%3A%5B%5D%2C_iq%3A%7B%7D%7D%3Bif(n.invoked)e.console%26%26console.error%26%26console.error(%22Amplitude%20snippet%20has%20been%20loaded.%22)%3Belse%7Bvar%20r%3Dfunction(e%2Ct)%7Be.prototype%5Bt%5D%3Dfunction()%7Breturn%20this._q.push(%7Bname%3At%2Cargs%3AArray.prototype.slice.call(arguments%2C0)%7D)%2Cthis%7D%7D%2Ci%3Dfunction(e%2Ct%2Cn)%7Breturn%20function(r)%7Be._q.push(%7Bname%3At%2Cargs%3AArray.prototype.slice.call(n%2C0)%2Cresolve%3Ar%7D)%7D%7D%2Co%3Dfunction(e%2Ct%2Cn)%7Be%5Bt%5D%3Dfunction()%7Bif(n)return%7Bpromise%3Anew%20Promise(i(e%2Ct%2CArray.prototype.slice.call(arguments)))%7D%7D%7D%2Cs%3Dfunction(e)%7Bfor(var%20t%3D0%3Bt%3Cv.length%3Bt%2B%2B)o(e%2Cv%5Bt%5D%2C!1)%3Bfor(var%20n%3D0%3Bn%3Cy.length%3Bn%2B%2B)o(e%2Cy%5Bn%5D%2C!0)%7D%3Bn.invoked%3D!0%3Bvar%20u%3Dt.getElementsByTagName(%22script%22)%5B0%5D%2Ca%3Dt.createElement(%22script%22)%3Ba.src%3D%22https%3A%2F%2Fcdn.amplitude.com%2Flibs%2Fplugin-autocapture-browser-0.9.0-min.js.gz%22%2Ca.async%3D!1%2Cu.parentNode.insertBefore(a%2Cu)%3Bvar%20c%3Dt.createElement(%22script%22)%3Bc.type%3D%22text%2Fjavascript%22%2Cc.integrity%3D%22sha384-Iv%2F3hfl4wm5kzRLNGFYnn9ujyjH%2BIw51ByCb%2BGRzsHlIH1tJ1x1LDjMaKxwZTmz5%22%2Cc.crossOrigin%3D%22anonymous%22%2Cc.async%3D!1%2Cc.src%3D%22https%3A%2F%2Fcdn.amplitude.com%2Flibs%2Fanalytics-browser-2.46.0-video-analytics-4.0-min.js.gz%22%2Cc.onload%3Dfunction()%7Be.amplitude.runQueuedFunctions%7C%7Cconsole.log(%22%5BAmplitude%5D%20Error%3A%20could%20not%20load%20SDK%22)%2Ce.amplitude.init(%22YOUR_API_KEY%22%2C%22YOUR_USER_ID%22%2C%7BinstanceName%3A%22amplitude-bookmarklet%22%2CserverZone%3A%22YOUR_SERVER_ZONE%22%2CingestionMetadata%3A%7BsourceName%3A%22browser-typescript-bookmarklet%22%2CsourceVersion%3A%221.0.0%22%7D%2CoptOut%3A!1%7D)%2CamplitudeAutocapturePlugin%26%26amplitudeAutocapturePlugin.autocapturePlugin%26%26%22function%22%3D%3Dtypeof%20amplitudeAutocapturePlugin.autocapturePlugin%26%26e.amplitude.add(amplitudeAutocapturePlugin.autocapturePlugin())%2Calert(%22Amplitude%20is%20now%20tracking%20events!%22)%7D%2Cu.parentNode.insertBefore(c%2Cu)%3Bfor(var%20p%3Dfunction()%7Breturn%20this._q%3D%5B%5D%2Cthis%7D%2Cl%3D%5B%22add%22%2C%22append%22%2C%22clearAll%22%2C%22prepend%22%2C%22set%22%2C%22setOnce%22%2C%22unset%22%2C%22preInsert%22%2C%22postInsert%22%2C%22remove%22%2C%22getUserProperties%22%5D%2Cd%3D0%3Bd%3Cl.length%3Bd%2B%2B)r(p%2Cl%5Bd%5D)%3Bn.Identify%3Dp%3Bfor(var%20m%3Dfunction()%7Breturn%20this._q%3D%5B%5D%2Cthis%7D%2Cg%3D%5B%22getEventProperties%22%2C%22setProductId%22%2C%22setQuantity%22%2C%22setPrice%22%2C%22setRevenue%22%2C%22setRevenueType%22%2C%22setReceipt%22%2C%22setReceiptSig%22%2C%22setCurrency%22%2C%22setEventProperties%22%5D%2Cf%3D0%3Bf%3Cg.length%3Bf%2B%2B)r(m%2Cg%5Bf%5D)%3Bn.Revenue%3Dm%3Bvar%20v%3D%5B%22getDeviceId%22%2C%22setDeviceId%22%2C%22getSessionId%22%2C%22setSessionId%22%2C%22getUserId%22%2C%22setUserId%22%2C%22setOptOut%22%2C%22setTransport%22%2C%22reset%22%2C%22extendSession%22%5D%2Cy%3D%5B%22init%22%2C%22add%22%2C%22remove%22%2C%22track%22%2C%22logEvent%22%2C%22identify%22%2C%22groupIdentify%22%2C%22setGroup%22%2C%22revenue%22%2C%22flush%22%5D%3Bs(n)%2Cn.createInstance%3Dfunction(e)%7Breturn%20n._iq%5Be%5D%3D%7B_q%3A%5B%5D%7D%2Cs(n._iq%5Be%5D)%2Cn._iq%5Be%5D%7D%2Ce.amplitude%3Dn%7D%7D(window%2Cdocument)%7D()%3B%0A