@vouchfor/embeds 0.0.0-experiment.25d0b5c → 0.0.0-experiment.263b5c9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vouchfor/embeds",
-  "version": "0.0.0-experiment.25d0b5c",
+  "version": "0.0.0-experiment.263b5c9",
   "license": "MIT",
   "author": "Aaron Williams",
   "main": "dist/es/embeds.js",
@@ -15,6 +15,9 @@
     "tag": "experiment",
     "access": "public"
   },
+  "engines": {
+    "node": ">=18.18.0"
+  },
   "scripts": {
     "build": "rm -rf dist && tsc && yarn build:self",
     "build:deps": "yarn --cwd ../media-player build",
@@ -30,7 +33,8 @@
     "storybook": "yarn prebuild && storybook dev -p 6007",
     "prebuild": "yarn build:deps && 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"
   },
   "lint-staged": {
     "**/*.{ts,tsx,js}": "eslint --fix --quiet",
@@ -39,45 +43,46 @@
   "dependencies": {
     "@a11y/focus-trap": "^1.0.5",
     "@lit/task": "^1.0.0",
-    "@vouchfor/media-player": "0.0.0-experiment.25d0b5c",
+    "@vouchfor/canvas-video": "0.0.0-experiment.263b5c9",
+    "@vouchfor/media-player": "0.0.0-experiment.263b5c9",
     "uuid": "^9.0.1"
   },
   "peerDependencies": {
-    "lit": "^3.1.0"
+    "lit": "^3.1.2"
   },
   "devDependencies": {
     "@esm-bundle/chai": "^4.3.4-fix.0",
-    "@open-wc/testing": "^3.2.0",
-    "@storybook/addon-essentials": "^7.4.5",
-    "@storybook/addon-links": "^7.4.5",
-    "@storybook/blocks": "^7.4.5",
-    "@storybook/web-components": "^7.4.5",
-    "@storybook/web-components-vite": "^7.4.5",
-    "@types/mocha": "^10.0.1",
-    "@vouchfor/eslint-config": "^1.0.0",
-    "@vouchfor/prettier-config": "^1.0.0",
-    "@web/dev-server-esbuild": "^0.4.1",
-    "@web/test-runner": "^0.17.1",
-    "@web/test-runner-browserstack": "^0.6.1",
-    "@web/test-runner-mocha": "^0.8.1",
-    "@web/test-runner-playwright": "^0.10.1",
-    "dotenv": "^16.3.1",
-    "eslint": "^8.50.0",
-    "eslint-plugin-import": "^2.28.1",
+    "@open-wc/testing": "^4.0.0",
+    "@storybook/addon-essentials": "^8.0.4",
+    "@storybook/addon-links": "^8.0.4",
+    "@storybook/blocks": "^8.0.4",
+    "@storybook/web-components": "^8.0.4",
+    "@storybook/web-components-vite": "^8.0.4",
+    "@svgr/core": "^8.1.0",
+    "@types/flat": "^5.0.5",
+    "@types/mocha": "^10.0.6",
+    "@vouchfor/eslint-config": "^1.0.1",
+    "@vouchfor/prettier-config": "^1.0.1",
+    "@vouchfor/video-utils": "0.0.0-experiment.263b5c9",
+    "@web/dev-server-esbuild": "^1.0.2",
+    "@web/test-runner": "^0.18.1",
+    "@web/test-runner-browserstack": "^0.7.1",
+    "@web/test-runner-mocha": "^0.9.0",
+    "@web/test-runner-playwright": "^0.11.0",
     "glob": "^10.3.10",
-    "lint-staged": "^14.0.1",
-    "lit": "^3.1.0",
+    "lint-staged": "^15.2.2",
+    "lit": "^3.1.2",
     "lodash": "^4.17.21",
-    "prettier": "^3.0.3",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "rollup-plugin-internal": "^1.0.4",
+    "rollup-plugin-tla": "^0.0.2",
     "sinon": "^17.0.1",
-    "storybook": "^7.4.5",
-    "typescript": "^5.1.3",
-    "vite": "^4.4.9",
-    "vite-plugin-commonjs": "^0.10.0",
-    "vite-plugin-dts": "^3.6.0",
-    "web-component-analyzer": "^1.1.7"
+    "storybook": "^8.0.4",
+    "svgson": "^5.3.1",
+    "typescript": "^5.4.3",
+    "vite": "^5.2.2",
+    "vite-plugin-commonjs": "^0.10.1",
+    "vite-plugin-dts": "^3.7.3",
+    "web-component-analyzer": "^2.0.0"
   }
 }

package/src/components/DialogEmbed/Dialog.stories.ts

@@ -35,6 +35,18 @@ const _DialogEmbed = ({
         aspectRatio=${ifDefined(aspectRatio)}
         @error=${console.log}
       ></vouch-embed-dialog>
+      <vouch-embed-dialog
+        env=${ifDefined(env)}
+        apiKey=${ifDefined(apiKey)}
+        vouchId=${ifDefined(vouchId)}
+        templateId=${ifDefined(templateId)}
+        .questions=${questions}
+        .controls=${controls}
+        ?autoplay=${autoplay}
+        preload=${ifDefined(preload)}
+        aspectRatio=${ifDefined(aspectRatio)}
+        @error=${console.log}
+      ></vouch-embed-dialog>
     </div>
   `;
 };

package/src/components/DialogEmbed/DialogOverlay.ts

@@ -21,10 +21,11 @@ class DialogOverlay extends LitElement {
       }
 
       .container {
-        position: absolute;
+        position: fixed;
         display: flex;
         inset: 0;
         opacity: 1;
+        z-index: 2147483647;
         align-items: center;
         justify-content: center;
         transition: opacity 100ms ease-in;

package/src/components/DialogEmbed/DialogPortal.ts

@@ -29,19 +29,25 @@ class DialogPortal extends LitElement {
 
   @state() open = false;
 
-  private _handleToggle = () => {
-    this.open = !this.open;
-
-    if (this.open) {
-      if (!this.disableAutoplay && this._mediaPlayerRef?.value) {
-        this._mediaPlayerRef.value.muted = false;
-        this._mediaPlayerRef.value.play();
+  private _handleToggle = ({ detail }: CustomEvent<string>) => {
+    // Because we have to attach this listener to the document since this element is portalled outside of the button,
+    // we also have to make sure that this player is actually the one we want to open and play by passing in an ID
+    // from the button wrapper parent and checking against that same ID we pass as the event detail
+    if (this.id === detail) {
+      this.open = !this.open;
+
+      if (this.open) {
+        if (!this.disableAutoplay && this._mediaPlayerRef?.value) {
+          this._mediaPlayerRef.value.muted = false;
+          this._mediaPlayerRef.value.play();
+        }
+      } else {
+        this._mediaPlayerRef?.value?.pause();
       }
-    } else {
-      this._mediaPlayerRef?.value?.pause();
     }
   };
 
+  // We could do the same thing on close and check for the correct ID but it doesn't really matter
   private _handleClose = () => {
     this.open = false;
     this._mediaPlayerRef?.value?.pause();
@@ -70,7 +76,13 @@ class DialogPortal extends LitElement {
   }
 
   protected createRenderRoot(): HTMLElement | DocumentFragment {
-    return document.body;
+    // We must create a new node here because portalling into the same node (document.body) causes the second
+    // element to overwrite the first for some reason (not behaviour really stated in the docs)
+    // I am fairly certain this function is only run once as the default behaviour creates the open shadow root
+    // and returns that shadow root in this function: https://lit.dev/docs/components/shadow-dom/#implementing-createrenderroot
+    const newNode = document.createElement('div');
+    document.body.appendChild(newNode);
+    return newNode;
   }
 
   render() {

package/src/components/DialogEmbed/index.ts

@@ -1,6 +1,7 @@
 import { css, html, LitElement } from 'lit';
 import { customElement, property } from 'lit/decorators.js';
 import { ifDefined } from 'lit/directives/if-defined.js';
+import { v4 as uuidv4 } from 'uuid';
 
 import type { PlayerEmbedProps } from '../PlayerEmbed';
 
@@ -41,8 +42,10 @@ class DialogEmbed extends LitElement {
   @property({ type: Boolean }) disableAutoplay: DialogEmbedProps['disableAutoplay'] = false;
   @property({ type: Number }) aspectRatio: DialogEmbedProps['aspectRatio'] = 0;
 
+  private _id = uuidv4();
+
   private _handleRootClick = () => {
-    this.dispatchEvent(new CustomEvent('dialogembed:click', { bubbles: true, composed: true }));
+    this.dispatchEvent(new CustomEvent('dialogembed:click', { detail: this._id, bubbles: true, composed: true }));
   };
 
   connectedCallback(): void {
@@ -61,6 +64,7 @@ class DialogEmbed extends LitElement {
         <vmp-button size="large">Play</vmp-button>
       </slot>
       <vouch-embed-dialog-portal
+        id=${this._id}
         ?autoplay=${false}
         vouchId=${ifDefined(this.vouchId)}
         templateId=${ifDefined(this.templateId)}

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

@@ -58,7 +58,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

@@ -147,9 +147,9 @@ class TrackingController implements ReactiveController {
   private _handleVideoTimeUpdate = ({ detail: { id, key, node } }: CustomEvent<VideoEventDetail>) => {
     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;

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

@@ -2,7 +2,7 @@ import { TEMPLATE_VERSION } from '@vouchfor/canvas-video';
 import { v4 as uuidv4 } from 'uuid';
 
 import type { TrackingPayload } from '.';
-import type { Vouch } from '@vouchfor/media-player';
+import type { Vouch } from '@vouchfor/video-utils';
 import type { Environment } from '~/utils/env';
 
 import packageJson from '~/../package.json';

package/src/components/PlayerEmbed/index.ts

@@ -1,20 +1,22 @@
 import { css, html, LitElement } from 'lit';
 import { customElement, property, state } from 'lit/decorators.js';
 import { ifDefined } from 'lit/directives/if-defined.js';
-import { ref } from 'lit/directives/ref.js';
+import { createRef, ref } from 'lit/directives/ref.js';
 
 import type { TemplateInstance } from '@vouchfor/canvas-video';
-import type { MediaPlayerProps } from '@vouchfor/media-player';
+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';
 import { FetcherController } from './controllers/fetcher';
 import { TrackingController } from './controllers/tracking';
-import { MediaPlayerProxy } from '~/mixins/media-player-proxy';
 
 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;
@@ -26,7 +28,7 @@ type PlayerEmbedProps = Pick<MediaPlayerProps, 'data' | 'aspectRatio' | 'preload
 };
 
 @customElement('vouch-embed-player')
-class PlayerEmbed extends MediaPlayerProxy(LitElement) {
+class PlayerEmbed extends LitElement {
   static styles = [
     css`
       :host {
@@ -49,6 +51,7 @@ class PlayerEmbed extends MediaPlayerProxy(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'];
 
   private eventController = new EventForwardController(this, [
     'durationchange',
@@ -61,10 +64,12 @@ class PlayerEmbed extends MediaPlayerProxy(LitElement) {
     'playing',
     'ratechange',
     'scenechange',
+    'scenesupdate',
     'seeking',
     'seeked',
     'timeupdate',
     'volumechange',
+    'processing',
     'waiting',
 
     'video:loadeddata',
@@ -90,6 +95,108 @@ class PlayerEmbed extends MediaPlayerProxy(LitElement) {
     return this._fetcherController.fetching;
   }
 
+  private _mediaPlayerRef = createRef<MediaPlayer>();
+
+  get waiting() {
+    return this._mediaPlayerRef.value?.waiting;
+  }
+
+  get initialised() {
+    return this._mediaPlayerRef.value?.initialised;
+  }
+
+  get seeking() {
+    return this._mediaPlayerRef.value?.seeking;
+  }
+
+  get paused() {
+    return this._mediaPlayerRef.value?.paused;
+  }
+
+  get captions() {
+    return this._mediaPlayerRef.value?.captions;
+  }
+
+  get fullscreen() {
+    return this._mediaPlayerRef.value?.fullscreen;
+  }
+
+  get duration() {
+    return this._mediaPlayerRef.value?.duration;
+  }
+
+  set currentTime(value: number) {
+    if (this._mediaPlayerRef.value) {
+      this._mediaPlayerRef.value.currentTime = value;
+    }
+  }
+  get currentTime() {
+    return this._mediaPlayerRef.value?.currentTime ?? 0;
+  }
+
+  set playbackRate(value: number) {
+    if (this._mediaPlayerRef.value) {
+      this._mediaPlayerRef.value.playbackRate = value;
+    }
+  }
+  get playbackRate() {
+    return this._mediaPlayerRef.value?.playbackRate ?? 1;
+  }
+
+  set volume(value: number) {
+    if (this._mediaPlayerRef.value) {
+      this._mediaPlayerRef.value.volume = value;
+    }
+  }
+  get volume() {
+    return this._mediaPlayerRef.value?.volume ?? 1;
+  }
+
+  set muted(value: boolean) {
+    if (this._mediaPlayerRef.value) {
+      this._mediaPlayerRef.value.muted = value;
+    }
+  }
+  get muted() {
+    return this._mediaPlayerRef.value?.muted ?? false;
+  }
+
+  // get scene(): Scene | null {
+  //   return this._mediaPlayerRef.value?.scene ?? null;
+  // }
+
+  // get scenes(): Scene[] {
+  //   return this._mediaPlayerRef.value?.scenes ?? [];
+  // }
+
+  // get sceneConfig(): Scenes | null {
+  //   return this._mediaPlayerRef.value?.sceneConfig ?? null;
+  // }
+
+  get videoState() {
+    return this._mediaPlayerRef.value?.videoState;
+  }
+
+  get mediaPlayer() {
+    return this._mediaPlayerRef.value;
+  }
+
+  play() {
+    this._mediaPlayerRef.value?.play();
+  }
+
+  pause() {
+    this._mediaPlayerRef.value?.pause();
+  }
+
+  reset(time = 0, play = false) {
+    this._mediaPlayerRef.value?.reset(time, play);
+  }
+
+  // setScene(index: number) {
+  //   this._mediaPlayerRef.value?.setScene(index);
+  // }
+
   private _renderStyles() {
     if (!this.aspectRatio) {
       return html`
@@ -115,6 +222,13 @@ class PlayerEmbed extends MediaPlayerProxy(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()}
@@ -123,10 +237,9 @@ class PlayerEmbed extends MediaPlayerProxy(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

@@ -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>`
     );
@@ -56,6 +56,13 @@ describe('Embeds', () => {
     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',