@vouchfor/embeds 0.0.0-experiment.2da2c49 → 0.0.0-experiment.2dc922f

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vouchfor/embeds",
-  "version": "0.0.0-experiment.2da2c49",
+  "version": "0.0.0-experiment.2dc922f",
   "license": "MIT",
   "author": "Aaron Williams",
   "main": "dist/es/embeds.js",
@@ -15,12 +15,15 @@
     "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",
     "build:self": "vite build --mode iife && vite build --mode es && node scripts/build.cjs",
     "build:package": "yarn build",
-    "build:storybook": "yarn prebuild && storybook build",
+    "build:storybook": "turbo run build:package --filter=@vouchfor/embeds^... && yarn prebuild && storybook build",
     "generate:manifest": "wca src --outFile custom-elements.json",
     "lint": "eslint . --quiet",
     "lint:fix": "eslint . --fix",
@@ -28,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",
@@ -38,46 +43,47 @@
   },
   "dependencies": {
     "@a11y/focus-trap": "^1.0.5",
-    "@lit/task": "^1.0.0",
-    "@vouchfor/media-player": "0.0.0-experiment.2da2c49",
+    "@lit/task": "^1.0.2",
+    "@vouchfor/canvas-video": "0.0.0-experiment.2dc922f",
+    "@vouchfor/media-player": "0.0.0-experiment.2dc922f",
     "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",
-    "glob": "^10.3.10",
-    "lint-staged": "^14.0.1",
-    "lit": "^3.1.0",
+    "@esm-bundle/chai": "^4.3.4",
+    "@open-wc/testing": "^4.0.0",
+    "@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.10",
+    "@vouchfor/eslint-config": "^1.0.5",
+    "@vouchfor/prettier-config": "^1.0.1",
+    "@vouchfor/video-utils": "0.0.0-experiment.2dc922f",
+    "@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.4.5",
+    "lint-staged": "^15.5.1",
+    "lit": "^3.3.0",
     "lodash": "^4.17.21",
-    "prettier": "^3.0.3",
-    "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": "^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.6.12",
+    "svgson": "^5.3.1",
+    "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/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

@@ -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/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';