@vouchfor/embeds 0.0.0-experiment.68e2df9 → 0.0.0-experiment.6cd6e07

package/src/components/{Embed → PlayerEmbed}/controllers/fetcher.ts

@@ -1,29 +1,29 @@
 import { Task } from '@lit/task';
 import { v4 as uuidv4 } from 'uuid';
 
-import type { Embed, EmbedProps } from '..';
+import type { PlayerEmbed, PlayerEmbedProps } from '..';
 import type { ReactiveControllerHost } from 'lit';
 import type { Environment } from '~/utils/env';
 
 import { getEnvUrls } from '~/utils/env';
 
-type EmbedHost = ReactiveControllerHost & Embed;
+type PlayerEmbedHost = ReactiveControllerHost & PlayerEmbed;
 
 type FetchTaskDeps = [
-  EmbedProps['env'],
-  EmbedProps['apiKey'],
-  EmbedProps['data'],
-  EmbedProps['vouchId'],
-  EmbedProps['templateId']
+  PlayerEmbedProps['env'],
+  PlayerEmbedProps['apiKey'],
+  PlayerEmbedProps['data'],
+  PlayerEmbedProps['vouchId'],
+  PlayerEmbedProps['templateId']
 ];
 
-type FilterTaskDeps = [EmbedProps['data'], EmbedProps['questions']];
+type FilterTaskDeps = [PlayerEmbedProps['data'], PlayerEmbedProps['questions']];
 
 class FetcherController {
-  host: EmbedHost;
+  host: PlayerEmbedHost;
 
   private _fetching = false;
-  private _vouch: EmbedProps['data'];
+  private _vouch: PlayerEmbedProps['data'];
 
   set fetching(value) {
     if (this._fetching !== value) {
@@ -97,7 +97,7 @@ class FetcherController {
     return template;
   };
 
-  constructor(host: EmbedHost) {
+  constructor(host: PlayerEmbedHost) {
     this.host = host;
     new Task<FetchTaskDeps, void>(
       this.host,

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

@@ -1,4 +1,4 @@
-import type { Embed } from '../..';
+import type { PlayerEmbed } from '../..';
 import type { VideoEventDetail } from '@vouchfor/media-player';
 import type { ReactiveController, ReactiveControllerHost } from 'lit';
 
@@ -7,7 +7,7 @@ import { getEnvUrls } from '~/utils/env';
 
 const MINIMUM_SEND_THRESHOLD = 1;
 
-type EmbedHost = ReactiveControllerHost & Embed;
+type PlayerEmbedHost = ReactiveControllerHost & PlayerEmbed;
 
 type TrackingEvent = 'VOUCH_LOADED' | 'VOUCH_RESPONSE_VIEWED' | 'VIDEO_PLAYED' | 'VIDEO_STREAMED';
 type TrackingPayload = {
@@ -33,7 +33,7 @@ type BooleanMap = {
 };
 
 class TrackingController implements ReactiveController {
-  host: EmbedHost;
+  host: PlayerEmbedHost;
 
   private _batchedEvents: BatchEvent[] = [];
   private _hasPlayed = false;
@@ -43,7 +43,7 @@ class TrackingController implements ReactiveController {
   private _streamLatestTime: TimeMap = {};
   private _currentlyPlayingVideo: VideoEventDetail | null = null;
 
-  constructor(host: EmbedHost) {
+  constructor(host: PlayerEmbedHost) {
     this.host = host;
     host.addController(this);
   }

package/src/components/{Embed → PlayerEmbed}/controllers/tracking/utils.ts

@@ -2,10 +2,10 @@ 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';
+import packageJson from '~/../package.json';
 import { getEnvUrls } from '~/utils/env';
 
 function createVisitor(env: Environment) {

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

@@ -5,7 +5,6 @@ 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 { Environment } from '~/utils/env';
 
 import { EventForwardController } from './controllers/event-forwarder';
@@ -14,7 +13,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 +27,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 +37,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,6 +64,7 @@ class Embed extends LitElement {
     'playing',
     'ratechange',
     'scenechange',
+    'scenesupdate',
     'seeking',
     'seeked',
     'timeupdate',
@@ -85,17 +87,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,6 +188,10 @@ 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);
   }
@@ -221,6 +233,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>
     `;
@@ -229,15 +242,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/{Embed/tests/Embed.spec.ts → PlayerEmbed/tests/PlayerEmbed.spec.ts}

@@ -3,7 +3,7 @@ import { expect, fixture, waitUntil } from '@open-wc/testing';
 import { html } from 'lit';
 import sinon from 'sinon';
 
-import type { Embed } from '../index.js';
+import type { PlayerEmbed } from '../index.js';
 import type { VideoMap } from '@vouchfor/media-player';
 
 import { data } from './data.js';
@@ -17,7 +17,7 @@ function getVideo(videos: VideoMap) {
   return Object.values(videos)[0];
 }
 
-function playerLoaded(player: Embed) {
+function playerLoaded(player: PlayerEmbed) {
   return waitUntil(
     () => {
       return player.mediaPlayer?.initialised;
@@ -29,7 +29,9 @@ function playerLoaded(player: Embed) {
 
 describe('Embeds', () => {
   it('passes', async () => {
-    const player = await fixture<Embed>(html`<vouch-embed env="dev" .data=${data} aspectratio=${1}></vouch-embed>`);
+    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

package/src/components/{Embed → PlayerEmbed}/tests/data.ts

@@ -1,4 +1,4 @@
-import type { Vouch } from '@vouchfor/media-player';
+import type { Vouch } from '@vouchfor/video-utils';
 
 /* eslint-disable max-lines */
 const data = {
@@ -39,14 +39,14 @@ const data = {
             thumbnail:
               'https://d2rxhdlm2q91uk.cloudfront.net/TVik9uTMgE/6JQEIPeStt/5c66bb3a-ed68-41a0-a601-a49865104418/5c66bb3a-ed68-41a0-a601-a49865104418_poster.0000001.jpg?Policy=eyJTdGF0ZW1lbnQiOlt7IlJlc291cmNlIjoiaHR0cHM6Ly9kMnJ4aGRsbTJxOTF1ay5jbG91ZGZyb250Lm5ldC9UVmlrOXVUTWdFLyoiLCJDb25kaXRpb24iOnsiRGF0ZUxlc3NUaGFuIjp7IkFXUzpFcG9jaFRpbWUiOjIwMTYzMjM0Mjl9fX1dfQ__&Key-Pair-Id=K2SWKOH0FA5F6M&Signature=SGA54MFpy4jaqKJHKEuxRfjk-~NBFAh1tdW9Y6uYJwc0LFjDDgX1sraerSyohmVhj~-QVIrglY5BvglDIhrFcLJWGTkgj4vhyLprk1a7EDckv0HBgp-k1ZKvoDtt3wBOzrL4GicfXBkuMpIu5jv5MY3xemlJj2a6V~h65XJuLO4u-xS~McH6rS3mRxoNl4GcYUVm4upre1DGQx-5Suy6Ateoxl6xxoF8kg5EL02KxkIGiRpwXJTvVmUuVF0rpBj-IE40MfmhLBQ1NNSXiqb3-HjpkKwhYPvB5APVh23mzGmqJ0P3jbr2F1cU4Jvlqsjb6GVP61wGOz9ITeWPZkOy8A__'
           },
-          client: {
-            id: '03540d70-1c75-4867-a235-bac842ed6ce4',
-            name: 'Not Supplied',
-            logoSrc: 'https://logo.clearbit.com/vouchfor.com?size=260'
-          },
           contact: {
             id: 'b62f62a3-0cd4-4512-9b52-121cb2f3e72f',
-            name: 'Aaron Williams'
+            name: 'Aaron Williams',
+            client: {
+              id: '03540d70-1c75-4867-a235-bac842ed6ce4',
+              name: 'Not Supplied',
+              logoSrc: 'https://logo.clearbit.com/vouchfor.com?size=260'
+            }
           },
           captions: {
             current:
@@ -83,14 +83,14 @@ const data = {
             thumbnail:
               'https://d2rxhdlm2q91uk.cloudfront.net/TVik9uTMgE/6JQEIPeStt/5c66bb3a-ed68-41a0-a601-a49865104418/5c66bb3a-ed68-41a0-a601-a49865104418_poster.0000001.jpg?Policy=eyJTdGF0ZW1lbnQiOlt7IlJlc291cmNlIjoiaHR0cHM6Ly9kMnJ4aGRsbTJxOTF1ay5jbG91ZGZyb250Lm5ldC9UVmlrOXVUTWdFLyoiLCJDb25kaXRpb24iOnsiRGF0ZUxlc3NUaGFuIjp7IkFXUzpFcG9jaFRpbWUiOjIwMTYzMjM0Mjl9fX1dfQ__&Key-Pair-Id=K2SWKOH0FA5F6M&Signature=SGA54MFpy4jaqKJHKEuxRfjk-~NBFAh1tdW9Y6uYJwc0LFjDDgX1sraerSyohmVhj~-QVIrglY5BvglDIhrFcLJWGTkgj4vhyLprk1a7EDckv0HBgp-k1ZKvoDtt3wBOzrL4GicfXBkuMpIu5jv5MY3xemlJj2a6V~h65XJuLO4u-xS~McH6rS3mRxoNl4GcYUVm4upre1DGQx-5Suy6Ateoxl6xxoF8kg5EL02KxkIGiRpwXJTvVmUuVF0rpBj-IE40MfmhLBQ1NNSXiqb3-HjpkKwhYPvB5APVh23mzGmqJ0P3jbr2F1cU4Jvlqsjb6GVP61wGOz9ITeWPZkOy8A__'
           },
-          client: {
-            id: '03540d70-1c75-4867-a235-bac842ed6ce4',
-            logoSrc: 'https://logo.clearbit.com/vouchfor.com?size=260'
-          },
           contact: {
             id: 'b62f62a3-0cd4-4512-9b52-121cb2f3e72f',
             name: 'Aaron Williams',
-            roleTitle: 'Software Engineer'
+            roleTitle: 'Software Engineer',
+            client: {
+              id: '03540d70-1c75-4867-a235-bac842ed6ce4',
+              logoSrc: 'https://logo.clearbit.com/vouchfor.com?size=260'
+            }
           },
           captions: {
             current:
@@ -121,15 +121,15 @@ const data = {
             thumbnail:
               'https://d2rxhdlm2q91uk.cloudfront.net/TVik9uTMgE/6JQEIPeStt/e77c81a7-f6ef-4eae-91fc-b620d092d8d6/e77c81a7-f6ef-4eae-91fc-b620d092d8d6_poster.0000001.jpg?Policy=eyJTdGF0ZW1lbnQiOlt7IlJlc291cmNlIjoiaHR0cHM6Ly9kMnJ4aGRsbTJxOTF1ay5jbG91ZGZyb250Lm5ldC9UVmlrOXVUTWdFLyoiLCJDb25kaXRpb24iOnsiRGF0ZUxlc3NUaGFuIjp7IkFXUzpFcG9jaFRpbWUiOjIwMTYzMjM0Mjl9fX1dfQ__&Key-Pair-Id=K2SWKOH0FA5F6M&Signature=SGA54MFpy4jaqKJHKEuxRfjk-~NBFAh1tdW9Y6uYJwc0LFjDDgX1sraerSyohmVhj~-QVIrglY5BvglDIhrFcLJWGTkgj4vhyLprk1a7EDckv0HBgp-k1ZKvoDtt3wBOzrL4GicfXBkuMpIu5jv5MY3xemlJj2a6V~h65XJuLO4u-xS~McH6rS3mRxoNl4GcYUVm4upre1DGQx-5Suy6Ateoxl6xxoF8kg5EL02KxkIGiRpwXJTvVmUuVF0rpBj-IE40MfmhLBQ1NNSXiqb3-HjpkKwhYPvB5APVh23mzGmqJ0P3jbr2F1cU4Jvlqsjb6GVP61wGOz9ITeWPZkOy8A__'
           },
-          client: {
-            id: '03540d70-1c75-4867-a235-bac842ed6ce4',
-            name: 'Vouch',
-            logoSrc: 'https://logo.clearbit.com/vouchfor.com?size=260'
-          },
           contact: {
             id: 'b62f62a3-0cd4-4512-9b52-121cb2f3e72f',
             name: 'Aaron Williams',
-            roleTitle: 'Software Engineer'
+            roleTitle: 'Software Engineer',
+            client: {
+              id: '03540d70-1c75-4867-a235-bac842ed6ce4',
+              name: 'Vouch',
+              logoSrc: 'https://logo.clearbit.com/vouchfor.com?size=260'
+            }
           },
           captions: {
             current:
@@ -160,15 +160,15 @@ const data = {
             thumbnail:
               'https://d2rxhdlm2q91uk.cloudfront.net/TVik9uTMgE/6JQEIPeStt/39fd188d-a4dc-43b9-bac8-32fd71bfbc90/39fd188d-a4dc-43b9-bac8-32fd71bfbc90_poster.0000001.jpg?Policy=eyJTdGF0ZW1lbnQiOlt7IlJlc291cmNlIjoiaHR0cHM6Ly9kMnJ4aGRsbTJxOTF1ay5jbG91ZGZyb250Lm5ldC9UVmlrOXVUTWdFLyoiLCJDb25kaXRpb24iOnsiRGF0ZUxlc3NUaGFuIjp7IkFXUzpFcG9jaFRpbWUiOjIwMTYzMjM0Mjl9fX1dfQ__&Key-Pair-Id=K2SWKOH0FA5F6M&Signature=SGA54MFpy4jaqKJHKEuxRfjk-~NBFAh1tdW9Y6uYJwc0LFjDDgX1sraerSyohmVhj~-QVIrglY5BvglDIhrFcLJWGTkgj4vhyLprk1a7EDckv0HBgp-k1ZKvoDtt3wBOzrL4GicfXBkuMpIu5jv5MY3xemlJj2a6V~h65XJuLO4u-xS~McH6rS3mRxoNl4GcYUVm4upre1DGQx-5Suy6Ateoxl6xxoF8kg5EL02KxkIGiRpwXJTvVmUuVF0rpBj-IE40MfmhLBQ1NNSXiqb3-HjpkKwhYPvB5APVh23mzGmqJ0P3jbr2F1cU4Jvlqsjb6GVP61wGOz9ITeWPZkOy8A__'
           },
-          client: {
-            id: '03540d70-1c75-4867-a235-bac842ed6ce4',
-            name: 'Vouch',
-            logoSrc: 'https://logo.clearbit.com/vouchfor.com?size=260'
-          },
           contact: {
             id: 'b62f62a3-0cd4-4512-9b52-121cb2f3e72f',
             name: 'Aaron Williams',
-            roleTitle: 'Software Engineer'
+            roleTitle: 'Software Engineer',
+            client: {
+              id: '03540d70-1c75-4867-a235-bac842ed6ce4',
+              name: 'Vouch',
+              logoSrc: 'https://logo.clearbit.com/vouchfor.com?size=260'
+            }
           },
           captions: {
             current:

package/src/index.ts

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