@vouchfor/embeds 1.2.1 → 1.2.3

package/dist/iife/player-embed/src/components/DialogEmbed/index.d.ts

@@ -16,6 +16,7 @@ declare class DialogEmbed extends LitElement {
     preload: DialogEmbedProps['preload'];
     disableAutoplay: DialogEmbedProps['disableAutoplay'];
     aspectRatio: DialogEmbedProps['aspectRatio'];
+    private _id;
     private _handleRootClick;
     connectedCallback(): void;
     disconnectedCallback(): void;

package/dist/iife/player-embed/src/components/PlayerEmbed/index.d.ts

@@ -0,0 +1,73 @@
+import { LitElement } from 'lit';
+import type { Scene, Scenes, TemplateInstance } from '@vouchfor/canvas-video';
+import type { MediaPlayer, MediaPlayerProps } from '@vouchfor/media-player';
+import type { Environment } from '../../utils/env';
+type PlayerEmbedProps = Pick<MediaPlayerProps, 'data' | 'aspectRatio' | 'preload' | 'autoplay' | 'controls'> & {
+    env: Environment;
+    apiKey: string;
+    disableTracking?: boolean;
+    trackingSource?: string;
+    vouchId?: string;
+    templateId?: string;
+    questions?: number[];
+};
+declare class PlayerEmbed extends LitElement {
+    static styles: import("lit").CSSResult[];
+    data: PlayerEmbedProps['data'];
+    vouchId: PlayerEmbedProps['vouchId'];
+    templateId: PlayerEmbedProps['templateId'];
+    questions: PlayerEmbedProps['questions'];
+    env: PlayerEmbedProps['env'];
+    apiKey: PlayerEmbedProps['apiKey'];
+    disableTracking: PlayerEmbedProps['disableTracking'];
+    trackingSource: PlayerEmbedProps['trackingSource'];
+    controls: PlayerEmbedProps['controls'];
+    preload: PlayerEmbedProps['preload'];
+    autoplay: PlayerEmbedProps['autoplay'];
+    aspectRatio: PlayerEmbedProps['aspectRatio'];
+    private eventController;
+    private _fetcherController;
+    private _trackingController;
+    vouch: PlayerEmbedProps['data'];
+    template: TemplateInstance | undefined;
+    get fetching(): boolean;
+    private _mediaPlayerRef;
+    get waiting(): boolean | undefined;
+    get initialised(): Promise<boolean> | undefined;
+    get seeking(): boolean | undefined;
+    get paused(): boolean | undefined;
+    get captions(): boolean | undefined;
+    get fullscreen(): boolean | undefined;
+    get duration(): number | undefined;
+    set currentTime(value: number);
+    get currentTime(): number;
+    set playbackRate(value: number);
+    get playbackRate(): number;
+    set volume(value: number);
+    get volume(): number;
+    set muted(value: boolean);
+    get muted(): boolean;
+    get scene(): Scene | null;
+    get scenes(): Scene[];
+    get sceneConfig(): Scenes | null;
+    get videoState(): import("@vouchfor/media-player/dist/src/components/MediaPlayer/controllers/scenes").VideoStateMap | undefined;
+    get mediaPlayer(): MediaPlayer | undefined;
+    play(): void;
+    pause(): void;
+    reset(time?: number, play?: boolean): void;
+    setScene(index: number): void;
+    private _renderStyles;
+    render(): import("lit").TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'vouch-embed-player': PlayerEmbed;
+    }
+    namespace JSX {
+        interface IntrinsicElements {
+            'vouch-embed-player': PlayerEmbed;
+        }
+    }
+}
+export { PlayerEmbed };
+export type { PlayerEmbedProps };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vouchfor/embeds",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "license": "MIT",
   "author": "Aaron Williams",
   "main": "dist/es/embeds.js",
@@ -42,7 +42,7 @@
   "dependencies": {
     "@a11y/focus-trap": "^1.0.5",
     "@lit/task": "^1.0.0",
-    "@vouchfor/media-player": "^2.1.0",
+    "@vouchfor/media-player": "^2.1.2",
     "uuid": "^9.0.1"
   },
   "peerDependencies": {

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/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/index.ts

@@ -1,16 +1,15 @@
 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 { Scene, Scenes, TemplateInstance } from '@vouchfor/canvas-video';
+import type { MediaPlayer, MediaPlayerProps } from '@vouchfor/media-player';
 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';
 
@@ -26,7 +25,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 {
@@ -90,6 +89,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`