@vouchfor/embeds 0.0.0-experiment.1f98c5e → 0.0.0-experiment.20e29ac

package/src/components/{Embed → PlayerEmbed}/index.ts

@@ -5,7 +5,7 @@ import { createRef, ref } from 'lit/directives/ref.js';
 
 import type { Scene, Scenes, TemplateInstance } from '@vouchfor/canvas-video';
 import type { MediaPlayer, MediaPlayerProps } from '@vouchfor/media-player';
-import type { Ref } from 'lit/directives/ref.js';
+import type { PropertyValueMap } from 'lit';
 import type { Environment } from '~/utils/env';
 
 import { EventForwardController } from './controllers/event-forwarder';
@@ -14,7 +14,10 @@ import { TrackingController } from './controllers/tracking';
 
 import '@vouchfor/media-player';
 
-type EmbedProps = Pick<MediaPlayerProps, 'data' | 'aspectRatio' | 'preload' | 'autoplay' | 'controls'> & {
+type PlayerEmbedProps = Pick<
+  MediaPlayerProps,
+  'data' | 'aspectRatio' | 'language' | 'preload' | 'autoplay' | 'controls'
+> & {
   env: Environment;
   apiKey: string;
   disableTracking?: boolean;
@@ -25,8 +28,8 @@ type EmbedProps = Pick<MediaPlayerProps, 'data' | 'aspectRatio' | 'preload' | 'a
   questions?: number[];
 };
 
-@customElement('vouch-embed')
-class Embed extends LitElement {
+@customElement('vouch-embed-player')
+class PlayerEmbed extends LitElement {
   static styles = [
     css`
       :host {
@@ -35,22 +38,21 @@ class Embed extends LitElement {
     `
   ];
 
-  private _mediaPlayerRef: Ref<MediaPlayer> = createRef();
+  @property({ type: Object }) data: PlayerEmbedProps['data'];
+  @property({ type: String }) vouchId: PlayerEmbedProps['vouchId'];
+  @property({ type: String }) templateId: PlayerEmbedProps['templateId'];
+  @property({ type: Array }) questions: PlayerEmbedProps['questions'];
 
-  @property({ type: Object }) data: EmbedProps['data'];
-  @property({ type: String }) vouchId: EmbedProps['vouchId'];
-  @property({ type: String }) templateId: EmbedProps['templateId'];
-  @property({ type: Array }) questions: EmbedProps['questions'];
+  @property({ type: String }) env: PlayerEmbedProps['env'] = 'prod';
+  @property({ type: String }) apiKey: PlayerEmbedProps['apiKey'] = '';
+  @property({ type: Boolean }) disableTracking: PlayerEmbedProps['disableTracking'] = false;
+  @property({ type: String }) trackingSource: PlayerEmbedProps['trackingSource'] = 'embedded_player';
 
-  @property({ type: String }) env: EmbedProps['env'] = 'prod';
-  @property({ type: String }) apiKey: EmbedProps['apiKey'] = '';
-  @property({ type: Boolean }) disableTracking: EmbedProps['disableTracking'] = false;
-  @property({ type: String }) trackingSource: EmbedProps['trackingSource'] = 'embedded_player';
-
-  @property({ type: Array }) controls: EmbedProps['controls'];
-  @property({ type: String }) preload: EmbedProps['preload'] = 'auto';
-  @property({ type: Boolean }) autoplay: EmbedProps['autoplay'] = false;
-  @property({ type: Number }) aspectRatio: EmbedProps['aspectRatio'] = 0;
+  @property({ type: Array }) controls: PlayerEmbedProps['controls'];
+  @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',
@@ -63,10 +65,12 @@ class Embed extends LitElement {
     'playing',
     'ratechange',
     'scenechange',
+    'scenesupdate',
     'seeking',
     'seeked',
     'timeupdate',
     'volumechange',
+    'processing',
     'waiting',
 
     'video:loadeddata',
@@ -85,17 +89,23 @@ class Embed extends LitElement {
   // @ts-ignore
   private _trackingController = new TrackingController(this);
 
-  @state() vouch: EmbedProps['data'];
+  @state() vouch: PlayerEmbedProps['data'];
   @state() template: TemplateInstance | undefined;
 
   get fetching() {
     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;
   }
@@ -180,12 +190,49 @@ class Embed extends LitElement {
     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`
+        <style>
+          :host {
+            width: 100%;
+            height: 100%;
+          }
+        </style>
+      `;
+    }
+
+    if (typeof this.aspectRatio === 'number') {
+      return html`
+        <style>
+          :host {
+            aspect-ratio: ${this.aspectRatio};
+          }
+        </style>
+      `;
+    }
+
+    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()}
       <vmp-media-player
         ${ref(this._mediaPlayerRef)}
         ${this.eventController.register()}
@@ -195,6 +242,7 @@ class Embed extends LitElement {
         .template=${this.template}
         aspectRatio=${ifDefined(this.aspectRatio)}
         preload=${ifDefined(this.preload)}
+        language=${ifDefined(this.language)}
         .controls=${this.controls}
       ></vmp-media-player>
     `;
@@ -203,15 +251,15 @@ class Embed extends LitElement {
 
 declare global {
   interface HTMLElementTagNameMap {
-    'vouch-embed': Embed;
+    'vouch-embed-player': PlayerEmbed;
   }
 
   namespace JSX {
     interface IntrinsicElements {
-      'vouch-embed': Embed;
+      'vouch-embed-player': PlayerEmbed;
     }
   }
 }
 
-export { Embed };
-export type { EmbedProps };
+export { PlayerEmbed };
+export type { PlayerEmbedProps };

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

@@ -0,0 +1,87 @@
+/* eslint-disable @typescript-eslint/ban-ts-comment */
+import { expect, fixture, waitUntil } from '@open-wc/testing';
+import { html } from 'lit';
+import sinon from 'sinon';
+
+import type { PlayerEmbed } from '../index.js';
+import type { VideoMap } from '@vouchfor/media-player';
+
+import { data } from './data.js';
+
+// Can't use typescript aliases with esbuild file transforms apparently
+// No idea what a good way to actually build before testing is, the examples give nothing
+// https://modern-web.dev/guides/test-runner/typescript/
+import '../../../test/lib/embeds.js';
+
+function getVideo(videos: VideoMap) {
+  return Object.values(videos)[0];
+}
+
+function playerLoaded(player: PlayerEmbed) {
+  return waitUntil(
+    () => {
+      return player.mediaPlayer?.initialised;
+    },
+    'Player has not loaded video',
+    { timeout: 20000 }
+  );
+}
+
+describe('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>`
+    );
+    // @ts-ignore - accessing private property
+    const sendTrackingSpy = sinon.spy(player._trackingController, '_sendTrackingEvent');
+    // @ts-ignore - accessing private property
+    const createTrackingSpy = sinon.spy(player._trackingController, '_createTrackingEvent');
+
+    await playerLoaded(player);
+    // Have to mute the player because we can't programmatically play videos with sound
+    player.muted = true;
+    player.play();
+    expect(player.paused).eq(false);
+    await waitUntil(
+      () => {
+        // Video plays for 3 seconds
+        return (getVideo(player.mediaPlayer!.videos)?.node?.currentTime ?? 0) > 3;
+      },
+      'Video did not play for 3 seconds',
+      { timeout: 20000 }
+    );
+    expect(getVideo(player.mediaPlayer!.videos)?.node?.paused).eq(false);
+    player.pause();
+    expect(getVideo(player.mediaPlayer!.videos)?.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',
+      {
+        streamStart: 0
+      }
+    ]);
+    expect(createTrackingSpy.args[1]).to.eql([
+      'VOUCH_RESPONSE_VIEWED',
+      {
+        answerId: '5c66bb3a-ed68-41a0-a601-a49865104418'
+      }
+    ]);
+    expect(createTrackingSpy.args[2][0]).to.eq('VIDEO_STREAMED');
+    // Remove streamStart and streamEnd as these are non-deterministic
+    expect({ ...createTrackingSpy.args[2][1], streamStart: undefined, streamEnd: undefined }).to.eql({
+      answerId: '5c66bb3a-ed68-41a0-a601-a49865104418',
+      streamStart: undefined,
+      streamEnd: undefined
+    });
+  });
+});

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

@@ -0,0 +1,227 @@
+import type { Vouch } from '@vouchfor/video-utils';
+
+import { VIDEOA, VIDEOB, VIDEOC } from './media-data';
+
+/* eslint-disable max-lines */
+const data: Vouch = {
+  id: '85a7f7fb-897c-41a4-be7b-2636cf991f2c',
+  hashId: '6JQEIPeStt',
+  settings: {
+    branding: {
+      base: {
+        primary: {
+          color: '#48aff7',
+          text: '#def2ff'
+        },
+        secondary: {
+          color: '#fdbdfa',
+          text: '#8b26bf'
+        },
+        radius: '8px'
+      }
+    }
+  },
+  questions: {
+    items: [
+      {
+        id: '5c66bb3a-ed68-41a0-a601-a49865104418',
+        title: "What is the business problem you're trying to solve?",
+        answer: {
+          id: '5c66bb3a-ed68-41a0-a601-a49865104418',
+          label: null,
+          metadata: {
+            duration: VIDEOA.duration
+          },
+          settings: {
+            endOffset: 0,
+            startOffset: 0
+          },
+          media: {
+            input: VIDEOA.mp4,
+            video: VIDEOA.mp4,
+            playlist: VIDEOA.m3u8,
+            thumbnail: VIDEOA.jpg,
+            videos: {
+              xs: VIDEOA.mp4
+            }
+          },
+          contact: {
+            id: 'b62f62a3-0cd4-4512-9b52-121cb2f3e72f',
+            name: 'Aaron Williams',
+            roleTitle: 'Software Engineer',
+            client: {
+              id: '03540d70-1c75-4867-a235-bac842ed6ce4',
+              name: 'Not Supplied',
+              logoSrc: 'https://vouch-clients.s3.ap-southeast-2.amazonaws.com/vouch/logos/vouch-logotype-teal.png'
+            }
+          },
+          captions: {
+            current:
+              "WEBVTT\r\n\r\n1\r\n00:00:01.710 --> 00:00:05.250\r\nwe are trying to solve, uh, world hunger.\r\n\r\n2\r\n00:00:05.420 --> 00:00:08.369\r\nI think it's an important goal. Uh, we\r\n\r\n3\r\n00:00:08.380 --> 00:00:09.489\r\nalso would like to get rid of\r\n\r\n4\r\n00:00:09.500 --> 00:00:12.050\r\ntuberculosis. Um, in general. And\r\n\r\n5\r\n00:00:12.060 --> 00:00:15.329\r\nprobably malaria, too. Uh, it's gonna be\r\n\r\n6\r\n00:00:15.340 --> 00:00:17.180\r\na couple of weeks, but I think we can do\r\n\r\n7\r\n00:00:17.190 --> 00:00:17.319\r\nit.\r\n",
+            translation:
+              'WEBVTT\n\n1\n00:00:01.549 --> 00:00:05.920\n🇯🇵 🙏 こんにちは 藤森 章 です 。 え ？ 今 日本 の え ？ 東京 に 住ん で\n\n2\n00:00:05.929 --> 00:00:11.359\nいる 高校 三 年 生 です 。 えっと 父親 が 日本 人 で 母親 が は\n\n3\n00:00:11.619 --> 00:00:13.130\nえー 中国 人 な ん です けれど も 。\n\n4\n00:00:13.939 --> 00:00:17.889\nえ ？ 上海 に 行っ た 時 に 国際 学校 に 通っ て い た の で 。\n\n5\n00:00:17.899 --> 00:00:20.389\nえー 英語 を 日本 語 、 中国 語 、 三 語 を しゃ ます\n\n6\n00:00:21.030 --> 00:00:23.549\nえー で 、 その 中 で 経験 し た こと な ん です けれど も 、\n\n7\n00:00:24.040 --> 00:00:26.700\n日本 語 の 素晴らしい ところ って いう の は 、\n\n8\n00:00:27.260 --> 00:00:27.809\nやっぱり\n\n9\n00:00:28.489 --> 00:00:31.540\n和歌 に も 見 られる よう な 多彩 な 表現 力 と\n\n10\n00:00:32.349 --> 00:00:33.819\nえ 奥深い\n\n11\n00:00:34.770 --> 00:00:38.520\nえー 、 感情 表現 など に ある と 思い ます 。 えー これ を 見 て\n\n12\n00:00:38.759 --> 00:00:41.599\n日本 語 に 興味 を 持っ た 方 は 、 是非 その\n\n13\n00:00:43.180 --> 00:00:43.770\n奥深い\n\n14\n00:00:44.299 --> 00:00:45.630\n表現 など を え 、\n\n15\n00:00:46.299 --> 00:00:49.209\n見 て 、 感じ て えー 、 触れ て み て ください 。 ありがとう\n\n16\n00:00:49.220 --> 00:00:49.599\nござい まし た 。\n'
+          },
+          transcription: {
+            language: 'en',
+            translation: {
+              language: 'ja'
+            },
+            items: []
+          }
+        }
+      },
+      {
+        id: '5c66bb3a-ed68-41a0-a601-a49865104418',
+        title: "What is the business problem you're trying to solve?",
+        answer: {
+          id: '5c66bb3a-ed68-41a0-a601-a49865104418',
+          label: null,
+          metadata: {
+            duration: VIDEOA.duration
+          },
+          settings: {
+            endOffset: 0.385945945945946,
+            startOffset: 0.3037837837837838,
+            crop: {
+              x: 0.4,
+              y: 0.4,
+              width: 0.4,
+              height: 0.4
+            }
+          },
+          media: {
+            input: VIDEOA.mp4,
+            video: VIDEOA.mp4,
+            playlist: VIDEOA.m3u8,
+            thumbnail: VIDEOA.jpg,
+            videos: {
+              xs: VIDEOA.mp4
+            }
+          },
+          contact: {
+            id: 'b62f62a3-0cd4-4512-9b52-121cb2f3e72f',
+            name: 'Aaron Williams',
+            roleTitle: 'Software Engineer',
+            client: {
+              id: '03540d70-1c75-4867-a235-bac842ed6ce4',
+              logoSrc: 'https://vouch-clients.s3.ap-southeast-2.amazonaws.com/vouch/logos/vouch-logotype-teal.png'
+            }
+          },
+          captions: {
+            current:
+              "WEBVTT\r\n\r\n1\r\n00:00:01.710 --> 00:00:05.250\r\nwe are trying to solve, uh, world hunger.\r\n\r\n2\r\n00:00:05.420 --> 00:00:08.369\r\nI think it's an important goal. Uh, we\r\n\r\n3\r\n00:00:08.380 --> 00:00:09.489\r\nalso would like to get rid of\r\n\r\n4\r\n00:00:09.500 --> 00:00:12.050\r\ntuberculosis. Um, in general. And\r\n\r\n5\r\n00:00:12.060 --> 00:00:15.329\r\nprobably malaria, too. Uh, it's gonna be\r\n\r\n6\r\n00:00:15.340 --> 00:00:17.180\r\na couple of weeks, but I think we can do\r\n\r\n7\r\n00:00:17.190 --> 00:00:17.319\r\nit.\r\n"
+          },
+          transcription: {
+            language: 'en',
+            translation: {
+              language: 'fr'
+            },
+            items: []
+          }
+        }
+      },
+      {
+        id: 'e77c81a7-f6ef-4eae-91fc-b620d092d8d6',
+        title: 'What are the priorities for your business/team this quarter?',
+        answer: {
+          id: 'e77c81a7-f6ef-4eae-91fc-b620d092d8d6',
+          label: 'Hello this label is overridden',
+          metadata: {
+            duration: VIDEOB.duration
+          },
+          settings: {
+            endOffset: 0,
+            startOffset: 0
+          },
+          media: {
+            input: VIDEOB.mp4,
+            video: VIDEOB.mp4,
+            playlist: VIDEOB.m3u8,
+            thumbnail: VIDEOB.jpg,
+            videos: {
+              xs: VIDEOB.mp4
+            }
+          },
+          contact: {
+            id: 'b62f62a3-0cd4-4512-9b52-121cb2f3e72f',
+            name: 'Aaron Williams',
+            roleTitle: 'Software Engineer',
+            client: {
+              id: '03540d70-1c75-4867-a235-bac842ed6ce4',
+              name: 'Vouch',
+              logoSrc: 'https://vouch-clients.s3.ap-southeast-2.amazonaws.com/vouch/logos/vouch-logotype-teal.png'
+            }
+          },
+          captions: {
+            current:
+              'WEBVTT\r\n\r\n1\r\n00:00:00.709 --> 00:00:03.059\r\npriorities for this business. Uh, for\r\n\r\n2\r\n00:00:03.069 --> 00:00:06.010\r\nthis quarter, uh, to make more money,\r\n\r\n3\r\n00:00:06.019 --> 00:00:09.050\r\nmore profits, Uh, get everything, uh,\r\n\r\n4\r\n00:00:09.069 --> 00:00:13.439\r\nswept away. All our heuristics should be\r\n\r\n5\r\n00:00:13.529 --> 00:00:15.119\r\ntop of the line.\r\n'
+          },
+          transcription: {
+            language: 'en',
+            translation: {
+              language: 'de'
+            },
+            items: []
+          }
+        }
+      },
+      {
+        id: '39fd188d-a4dc-43b9-bac8-32fd71bfbc90',
+        title: `"Emoji": 🇯🇵 🙏
+          \t\t'Arabic': خَرَجَ الوَلَدُ.
+          Chinese: 简化字不讲理\f
+          Hebrew: עִבְרִית\r\r
+          Japanese Kanji: 漢字\n
+          \\\\\\///
+          Japanese Hiragana: 平仮名
+          Japanese Katakana: 片仮名
+          Devangari Hindi: ॳॴॶॷऎऒऔ
+          Korean Hangul: 정음/正音
+          Cyrillic: АБВГДЕЖЗИКЛМН
+          Greek: αβγδ`,
+        answer: {
+          id: '39fd188d-a4dc-43b9-bac8-32fd71bfbc90',
+          label: null,
+          metadata: {
+            duration: VIDEOC.duration
+          },
+          settings: {
+            endOffset: 0,
+            startOffset: 0
+          },
+          media: {
+            input: VIDEOC.mp4,
+            video: VIDEOC.mp4,
+            playlist: VIDEOC.m3u8,
+            thumbnail: VIDEOC.jpg,
+            videos: {
+              xs: VIDEOC.mp4
+            }
+          },
+          contact: {
+            id: 'b62f62a3-0cd4-4512-9b52-121cb2f3e72f',
+            name: 'Aaron Williams',
+            client: {
+              id: '03540d70-1c75-4867-a235-bac842ed6ce4',
+              name: 'Vouch',
+              logoSrc: 'https://vouch-clients.s3.ap-southeast-2.amazonaws.com/vouch/logos/vouch-logotype-teal.png'
+            }
+          },
+          captions: {
+            current:
+              "WEBVTT\r\n\r\n1\r\n00:00:00.790 --> 00:00:03.269\r\nuh, the biggest pain points this this\r\n\r\n2\r\n00:00:03.279 --> 00:00:07.170\r\nquarter. Um, Jerry has been doing the\r\n\r\n3\r\n00:00:07.179 --> 00:00:09.180\r\nworst work that he's ever been doing.\r\n\r\n4\r\n00:00:09.390 --> 00:00:11.680\r\nAnd we must fire him, Jerry. Goodbye,\r\n\r\n5\r\n00:00:11.689 --> 00:00:12.149\r\nJerry.\r\n"
+          }
+        }
+      }
+    ]
+  }
+};
+
+const withNullAnswer = {
+  ...data,
+  questions: {
+    items: [...data.questions.items, { id: 'null', answer: null }]
+  }
+} as Vouch;
+
+export { data, withNullAnswer };

package/src/components/PlayerEmbed/tests/media-data.ts

@@ -0,0 +1,22 @@
+const VIDEOA = {
+  mp4: 'https://media-player-test-videos.s3.ap-southeast-2.amazonaws.com/01/output.mp4',
+  m3u8: 'https://media-player-test-videos.s3.ap-southeast-2.amazonaws.com/01/master.m3u8',
+  jpg: 'https://media-player-test-videos.s3.ap-southeast-2.amazonaws.com/01/output.jpg',
+  duration: 7.29
+};
+
+const VIDEOB = {
+  mp4: 'https://media-player-test-videos.s3.ap-southeast-2.amazonaws.com/02/output.mp4',
+  m3u8: 'https://media-player-test-videos.s3.ap-southeast-2.amazonaws.com/02/master.m3u8',
+  jpg: 'https://media-player-test-videos.s3.ap-southeast-2.amazonaws.com/02/output.jpg',
+  duration: 40.4
+};
+
+const VIDEOC = {
+  mp4: 'https://media-player-test-videos.s3.ap-southeast-2.amazonaws.com/03/output.mp4',
+  m3u8: 'https://media-player-test-videos.s3.ap-southeast-2.amazonaws.com/03/master.m3u8',
+  jpg: 'https://media-player-test-videos.s3.ap-southeast-2.amazonaws.com/03/output.jpg',
+  duration: 30.33
+};
+
+export { VIDEOA, VIDEOB, VIDEOC };

package/src/index.ts

@@ -1 +1,2 @@
-export { Embed } from '~/components/Embed';
+export { PlayerEmbed } from '~/components/PlayerEmbed';
+export { DialogEmbed } from '~/components/DialogEmbed';