@vouchfor/embeds 0.0.0-experiment.8cafed9 → 0.0.0-experiment.8d72879

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vouchfor/embeds",
-  "version": "0.0.0-experiment.8cafed9",
+  "version": "0.0.0-experiment.8d72879",
   "license": "MIT",
   "author": "Aaron Williams",
   "main": "dist/es/embeds.js",
@@ -31,9 +31,11 @@
     "prepublishOnly": "yarn build",
     "size": "size-limit",
     "storybook": "yarn prebuild && storybook dev -p 6007",
-    "prebuild": "yarn build:deps && yarn generate:manifest",
+    "prebuild": "yarn generate:manifest",
     "test": "rm -rf test/lib && yarn prebuild && vite build --mode test && web-test-runner",
-    "test:ci": "yarn test --config web-test-runner.ci.config.js"
+    "test:ci": "yarn test --config web-test-runner.ci.config.js",
+    "test:watch": "yarn test --watch",
+    "typecheck": "tsc --noEmit"
   },
   "lint-staged": {
     "**/*.{ts,tsx,js}": "eslint --fix --quiet",
@@ -41,47 +43,47 @@
   },
   "dependencies": {
     "@a11y/focus-trap": "^1.0.5",
-    "@lit/task": "^1.0.0",
-    "@vouchfor/media-player": "0.0.0-experiment.8cafed9",
+    "@lit/task": "^1.0.2",
+    "@vouchfor/canvas-video": "0.0.0-experiment.8d72879",
+    "@vouchfor/media-player": "0.0.0-experiment.8d72879",
     "uuid": "^9.0.1"
   },
   "peerDependencies": {
     "lit": "^3.1.2"
   },
   "devDependencies": {
-    "@esm-bundle/chai": "^4.3.4-fix.0",
+    "@esm-bundle/chai": "^4.3.4",
     "@open-wc/testing": "^4.0.0",
-    "@storybook/addon-essentials": "^8.0.2",
-    "@storybook/addon-links": "^8.0.2",
-    "@storybook/blocks": "^8.0.2",
-    "@storybook/web-components": "^8.0.2",
-    "@storybook/web-components-vite": "^8.0.2",
+    "@storybook/addon-essentials": "^8.6.12",
+    "@storybook/addon-links": "^8.6.12",
+    "@storybook/blocks": "^8.6.12",
+    "@storybook/web-components": "^8.6.12",
+    "@storybook/web-components-vite": "^8.6.12",
     "@svgr/core": "^8.1.0",
     "@types/flat": "^5.0.5",
-    "@types/mocha": "^10.0.6",
-    "@vouchfor/eslint-config": "^1.0.1",
+    "@types/mocha": "^10.0.10",
+    "@vouchfor/eslint-config": "^1.0.5",
     "@vouchfor/prettier-config": "^1.0.1",
-    "@vouchfor/video-utils": "0.0.0-experiment.8cafed9",
-    "@web/dev-server-esbuild": "^1.0.2",
-    "@web/test-runner": "^0.18.1",
-    "@web/test-runner-browserstack": "^0.7.1",
+    "@vouchfor/video-utils": "0.0.0-experiment.8d72879",
+    "@web/dev-server-esbuild": "^1.0.4",
+    "@web/test-runner": "^0.20.1",
+    "@web/test-runner-browserstack": "^0.8.0",
     "@web/test-runner-mocha": "^0.9.0",
     "@web/test-runner-playwright": "^0.11.0",
-    "glob": "^10.3.10",
-    "lint-staged": "^15.2.2",
-    "lit": "^3.1.2",
+    "glob": "^10.4.5",
+    "lint-staged": "^15.5.1",
+    "lit": "^3.3.0",
     "lodash": "^4.17.21",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
-    "rollup-plugin-internal": "^1.0.4",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
     "rollup-plugin-tla": "^0.0.2",
     "sinon": "^17.0.1",
-    "storybook": "^8.0.2",
+    "storybook": "^8.6.12",
     "svgson": "^5.3.1",
-    "typescript": "^5.4.3",
-    "vite": "^5.2.2",
-    "vite-plugin-commonjs": "^0.10.1",
-    "vite-plugin-dts": "^3.7.3",
+    "typescript": "^5.8.3",
+    "vite": "^5.4.18",
+    "vite-plugin-commonjs": "^0.10.4",
+    "vite-plugin-dts": "^3.9.1",
     "web-component-analyzer": "^2.0.0"
   }
 }

package/src/components/PlayerEmbed/MultiEmbed.stories.ts

@@ -0,0 +1,135 @@
+import { html } from 'lit';
+import { ifDefined } from 'lit/directives/if-defined.js';
+
+import type { PlayerEmbedProps } from '.';
+import type { Meta, StoryObj } from '@storybook/web-components';
+
+import '.';
+
+type MultiEmbedArgs = PlayerEmbedProps & {
+  apiKey1?: string;
+  apiKey2?: string;
+  apiKey3?: string;
+  vouchId1?: string;
+  vouchId2?: string;
+  vouchId3?: string;
+  showVouch?: boolean;
+};
+
+const _MultiEmbed = ({
+  vouchId1,
+  vouchId2,
+  vouchId3,
+  templateId,
+  questions,
+  preload,
+  autoplay,
+  env,
+  apiKey1,
+  apiKey2,
+  apiKey3,
+  controls,
+  aspectRatio
+}: MultiEmbedArgs) => {
+  return html`
+    <div style="height: 33vh">
+      <vouch-embed-player
+        env=${ifDefined(env)}
+        apiKey=${ifDefined(apiKey1)}
+        vouchId=${ifDefined(vouchId1)}
+        templateId=${ifDefined(templateId)}
+        .questions=${questions}
+        .controls=${controls}
+        ?autoplay=${autoplay}
+        preload=${ifDefined(preload)}
+        aspectRatio=${ifDefined(aspectRatio)}
+        @error=${console.log}
+      ></vouch-embed-player>
+    </div>
+    <div style="height: 33vh">
+      <vouch-embed-player
+        env=${ifDefined(env)}
+        apiKey=${ifDefined(apiKey2)}
+        vouchId=${ifDefined(vouchId2)}
+        templateId=${ifDefined(templateId)}
+        .questions=${questions}
+        .controls=${controls}
+        ?autoplay=${autoplay}
+        preload=${ifDefined(preload)}
+        aspectRatio=${ifDefined(aspectRatio)}
+        @error=${console.log}
+      ></vouch-embed-player>
+    </div>
+    <div style="height: 33vh">
+      <vouch-embed-player
+        env=${ifDefined(env)}
+        apiKey=${ifDefined(apiKey3)}
+        vouchId=${ifDefined(vouchId3)}
+        templateId=${ifDefined(templateId)}
+        .questions=${questions}
+        .controls=${controls}
+        ?autoplay=${autoplay}
+        preload=${ifDefined(preload)}
+        aspectRatio=${ifDefined(aspectRatio)}
+        @error=${console.log}
+      ></vouch-embed-player>
+    </div>
+  `;
+};
+
+// More on how to set up stories at: https://storybook.js.org/docs/web-components/writing-stories/introduction
+const meta = {
+  title: 'Embeds',
+  tags: ['autodocs'],
+  render: (args) => _MultiEmbed(args),
+  component: 'vouch-embed-player'
+} satisfies Meta<PlayerEmbedProps>;
+
+type Story = StoryObj<MultiEmbedArgs>;
+
+const MultiPlayer: Story = {
+  args: {
+    env: 'dev',
+    apiKey1: 'TVik9uTMgE-PD25UTHIS6gyl0hMBWC7AT4dkpdlLBT4VIfDWZJrQiCk6Ak7m1',
+    vouchId1: '6JQEIPeStt',
+    apiKey2: 'TVik9uTMgE-PD25UTHIS6gyl0hMBWC7AT4dkpdlLBT4VIfDWZJrQiCk6Ak7m1',
+    vouchId2: '6JQEIPeStt',
+    apiKey3: 'TVik9uTMgE-PD25UTHIS6gyl0hMBWC7AT4dkpdlLBT4VIfDWZJrQiCk6Ak7m1',
+    vouchId3: '6JQEIPeStt',
+    templateId: '357fc118-e179-4171-9446-ff2b8e9d1b29',
+    questions: [],
+    aspectRatio: 0,
+    preload: 'none',
+    autoplay: false,
+    controls: [
+      'progress',
+      'play-large',
+      'navigation',
+      'play',
+      'volume',
+      'current-time',
+      'duration',
+      'speed',
+      'captions',
+      'fullscreen',
+      'preview',
+      'languages'
+    ]
+  },
+  argTypes: {
+    env: {
+      control: 'radio',
+      options: ['local', 'dev', 'staging', 'prod']
+    },
+    preload: {
+      control: 'radio',
+      options: ['auto', 'none']
+    }
+  },
+  parameters: {
+    layout: 'fullscreen'
+  }
+};
+
+export default meta;
+export { MultiPlayer };

package/src/components/PlayerEmbed/PlayerEmbed.stories.ts

@@ -19,7 +19,8 @@ const _PlayerEmbed = ({
   env,
   apiKey,
   controls,
-  aspectRatio
+  aspectRatio,
+  senderId
 }: PlayerEmbedArgs) => {
   return html`
     <div style="height: 100vh">
@@ -33,6 +34,7 @@ const _PlayerEmbed = ({
         ?autoplay=${autoplay}
         preload=${ifDefined(preload)}
         aspectRatio=${ifDefined(aspectRatio)}
+        senderId=${ifDefined(senderId)}
         @error=${console.log}
       ></vouch-embed-player>
     </div>
@@ -58,7 +60,21 @@ const Player: Story = {
     questions: [],
     aspectRatio: 0,
     preload: 'none',
-    autoplay: false
+    autoplay: false,
+    controls: [
+      'progress',
+      'play-large',
+      'navigation',
+      'play',
+      'volume',
+      'current-time',
+      'duration',
+      'speed',
+      'captions',
+      'fullscreen',
+      'preview',
+      'languages'
+    ]
   },
   argTypes: {
     env: {

package/src/components/PlayerEmbed/controllers/tracking/index.ts

@@ -1,5 +1,5 @@
 import type { PlayerEmbed } from '../..';
-import type { VideoEventDetail } from '@vouchfor/media-player';
+import type { MediaEventDetail } from '@vouchfor/media-player';
 import type { ReactiveController, ReactiveControllerHost } from 'lit';
 
 import { findVouchId, getReportingMetadata, getUids } from './utils';
@@ -15,6 +15,7 @@ type TrackingPayload = {
   answerId?: string;
   streamStart?: number;
   streamEnd?: number;
+  senderId?: string;
 };
 
 type BatchEvent = {
@@ -41,7 +42,7 @@ class TrackingController implements ReactiveController {
   private _answersViewed: BooleanMap = {};
   private _streamStartTime: TimeMap = {};
   private _streamLatestTime: TimeMap = {};
-  private _currentlyPlayingVideo: VideoEventDetail | null = null;
+  private _currentlyPlayingVideo: MediaEventDetail | null = null;
 
   constructor(host: PlayerEmbedHost) {
     this.host = host;
@@ -59,6 +60,7 @@ class TrackingController implements ReactiveController {
       event,
       payload: {
         ...payload,
+        senderId: this.host.senderId,
         vouchId,
         time: new Date().toISOString()
       }
@@ -127,14 +129,12 @@ class TrackingController implements ReactiveController {
   private _handlePlay = () => {
     // Only send the video played event once per session
     if (!this._hasPlayed) {
-      this._createTrackingEvent('VIDEO_PLAYED', {
-        streamStart: this.host.currentTime
-      });
+      this._createTrackingEvent('VIDEO_PLAYED', { streamStart: this.host.currentTime });
       this._hasPlayed = true;
     }
   };
 
-  private _handleVideoPlay = ({ detail: { id, key } }: CustomEvent<VideoEventDetail>) => {
+  private _handleVideoPlay = ({ detail: { id, key } }: CustomEvent<MediaEventDetail>) => {
     // Only increment play count once per session
     if (!this._answersViewed[key]) {
       this._createTrackingEvent('VOUCH_RESPONSE_VIEWED', {
@@ -144,12 +144,12 @@ class TrackingController implements ReactiveController {
     }
   };
 
-  private _handleVideoTimeUpdate = ({ detail: { id, key, node } }: CustomEvent<VideoEventDetail>) => {
+  private _handleVideoTimeUpdate = ({ detail: { id, key, node } }: CustomEvent<MediaEventDetail>) => {
     if (
       // We only want to count any time that the video is actually playing
-      !this.host.paused &&
+      !this.host.paused
       // Only update the latest time if this event fires for the currently active video
-      id === this.host.scene?.video?.id
+      // id === this.host.scene?.video?.id
     ) {
       this._currentlyPlayingVideo = { id, key, node };
       this._streamLatestTime[key] = node.currentTime;
@@ -161,7 +161,7 @@ class TrackingController implements ReactiveController {
     }
   };
 
-  private _handleVideoPause = ({ detail: { id, key } }: CustomEvent<VideoEventDetail>) => {
+  private _handleVideoPause = ({ detail: { id, key } }: CustomEvent<MediaEventDetail>) => {
     if (this._streamLatestTime[key] > this._streamStartTime[key] + MINIMUM_SEND_THRESHOLD) {
       this._createTrackingEvent('VIDEO_STREAMED', {
         answerId: id,

package/src/components/PlayerEmbed/index.ts

@@ -3,8 +3,10 @@ import { customElement, property, state } from 'lit/decorators.js';
 import { ifDefined } from 'lit/directives/if-defined.js';
 import { createRef, ref } from 'lit/directives/ref.js';
 
-import type { Scene, Scenes, TemplateInstance } from '@vouchfor/canvas-video';
+import type { TemplateInstance } from '@vouchfor/canvas-video';
 import type { MediaPlayer, MediaPlayerProps } from '@vouchfor/media-player';
+import type { Vouch } from '@vouchfor/video-utils';
+import type { PropertyValueMap } from 'lit';
 import type { Environment } from '~/utils/env';
 
 import { EventForwardController } from './controllers/event-forwarder';
@@ -13,7 +15,8 @@ import { TrackingController } from './controllers/tracking';
 
 import '@vouchfor/media-player';
 
-type PlayerEmbedProps = Pick<MediaPlayerProps, 'data' | 'aspectRatio' | 'preload' | 'autoplay' | 'controls'> & {
+type PlayerEmbedProps = Pick<MediaPlayerProps, 'aspectRatio' | 'language' | 'preload' | 'autoplay' | 'controls'> & {
+  data?: Vouch;
   env: Environment;
   apiKey: string;
   disableTracking?: boolean;
@@ -22,6 +25,7 @@ type PlayerEmbedProps = Pick<MediaPlayerProps, 'data' | 'aspectRatio' | 'preload
   templateId?: string;
   // Index of the questions to include starting from 1
   questions?: number[];
+  senderId?: string;
 };
 
 @customElement('vouch-embed-player')
@@ -48,6 +52,8 @@ class PlayerEmbed extends LitElement {
   @property({ type: String }) preload: PlayerEmbedProps['preload'] = 'auto';
   @property({ type: Boolean }) autoplay: PlayerEmbedProps['autoplay'] = false;
   @property({ type: Number }) aspectRatio: PlayerEmbedProps['aspectRatio'] = 0;
+  @property({ type: String }) language?: MediaPlayerProps['language'];
+  @property({ type: String }) senderId?: PlayerEmbedProps['senderId'];
 
   private eventController = new EventForwardController(this, [
     'durationchange',
@@ -60,10 +66,12 @@ class PlayerEmbed extends LitElement {
     'playing',
     'ratechange',
     'scenechange',
+    'scenesupdate',
     'seeking',
     'seeked',
     'timeupdate',
     'volumechange',
+    'processing',
     'waiting',
 
     'video:loadeddata',
@@ -72,6 +80,7 @@ class PlayerEmbed extends LitElement {
     'video:play',
     'video:playing',
     'video:pause',
+    'video:waiting',
     'video:stalled',
     'video:timeupdate',
     'video:ended',
@@ -155,20 +164,20 @@ class PlayerEmbed extends LitElement {
     return this._mediaPlayerRef.value?.muted ?? false;
   }
 
-  get scene(): Scene | null {
-    return this._mediaPlayerRef.value?.scene ?? null;
-  }
+  // get scene(): Scene | null {
+  //   return this._mediaPlayerRef.value?.scene ?? null;
+  // }
 
-  get scenes(): Scene[] {
-    return this._mediaPlayerRef.value?.scenes ?? [];
-  }
+  // get scenes(): Scene[] {
+  //   return this._mediaPlayerRef.value?.scenes ?? [];
+  // }
 
-  get sceneConfig(): Scenes | null {
-    return this._mediaPlayerRef.value?.sceneConfig ?? null;
-  }
+  // get sceneConfig(): Scenes | null {
+  //   return this._mediaPlayerRef.value?.sceneConfig ?? null;
+  // }
 
-  get videoState() {
-    return this._mediaPlayerRef.value?.videoState;
+  get mediaState() {
+    return this._mediaPlayerRef.value?.mediaState;
   }
 
   get mediaPlayer() {
@@ -187,9 +196,9 @@ class PlayerEmbed extends LitElement {
     this._mediaPlayerRef.value?.reset(time, play);
   }
 
-  setScene(index: number) {
-    this._mediaPlayerRef.value?.setScene(index);
-  }
+  // setScene(index: number) {
+  //   this._mediaPlayerRef.value?.setScene(index);
+  // }
 
   private _renderStyles() {
     if (!this.aspectRatio) {
@@ -216,6 +225,13 @@ class PlayerEmbed extends LitElement {
     return null;
   }
 
+  protected willUpdate(changedProperties: PropertyValueMap<PlayerEmbedProps>) {
+    // If the vouch this embed is pointing to changes then reset the player
+    if (changedProperties.has('vouchId') && this.vouchId !== changedProperties.get('vouchId')) {
+      this.reset(0, false);
+    }
+  }
+
   render() {
     return html`
       ${this._renderStyles()}
@@ -224,10 +240,9 @@ class PlayerEmbed extends LitElement {
         ${this.eventController.register()}
         ?autoplay=${this.autoplay}
         ?loading=${this.fetching}
-        .data=${this.vouch}
-        .template=${this.template}
         aspectRatio=${ifDefined(this.aspectRatio)}
         preload=${ifDefined(this.preload)}
+        language=${ifDefined(this.language)}
         .controls=${this.controls}
       ></vmp-media-player>
     `;

package/src/components/PlayerEmbed/tests/PlayerEmbed.spec.ts

@@ -4,7 +4,7 @@ import { html } from 'lit';
 import sinon from 'sinon';
 
 import type { PlayerEmbed } from '../index.js';
-import type { VideoMap } from '@vouchfor/media-player';
+import type { MediaMap } from '@vouchfor/media-player';
 
 import { data } from './data.js';
 
@@ -13,7 +13,7 @@ import { data } from './data.js';
 // https://modern-web.dev/guides/test-runner/typescript/
 import '../../../test/lib/embeds.js';
 
-function getVideo(videos: VideoMap) {
+function getVideo(videos: MediaMap) {
   return Object.values(videos)[0];
 }
 
@@ -27,8 +27,8 @@ function playerLoaded(player: PlayerEmbed) {
   );
 }
 
-describe('Embeds', () => {
-  it('passes', async () => {
+describe.skip('Embeds', () => {
+  it('Sends correct tracking events', async () => {
     const player = await fixture<PlayerEmbed>(
       html`<vouch-embed-player env="dev" .data=${data} aspectratio=${1}></vouch-embed-player>`
     );
@@ -45,17 +45,24 @@ describe('Embeds', () => {
     await waitUntil(
       () => {
         // Video plays for 3 seconds
-        return (getVideo(player.mediaPlayer!.videos)?.node?.currentTime ?? 0) > 3;
+        return (getVideo(player.mediaPlayer!.media)?.node?.currentTime ?? 0) > 3;
       },
       'Video did not play for 3 seconds',
       { timeout: 20000 }
     );
-    expect(getVideo(player.mediaPlayer!.videos)?.node?.paused).eq(false);
+    expect(getVideo(player.mediaPlayer!.media)?.node?.paused).eq(false);
     player.pause();
-    expect(getVideo(player.mediaPlayer!.videos)?.node?.paused).eq(true);
+    expect(getVideo(player.mediaPlayer!.media)?.node?.paused).eq(true);
     expect(sendTrackingSpy.callCount).to.be.eq(0);
     // Destroy node because events are sent when node is removed from the document
     player.remove();
+    await waitUntil(
+      () => {
+        return createTrackingSpy.args[2];
+      },
+      'Cleanup event has not fired',
+      { timeout: 5000 }
+    );
     expect(sendTrackingSpy.callCount).to.be.eq(1);
     expect(createTrackingSpy.args[0]).to.eql([
       'VIDEO_PLAYED',