@vouchfor/embeds 0.0.0-experiment.9821b79 → 0.0.0-experiment.9b9100e
Sign up to get free protection for your applications and to get access to all the features.
- package/dist/es/embeds.js +1143 -7
- package/dist/es/embeds.js.map +1 -1
- package/dist/es/src/components/DialogEmbed/DialogOverlay.d.ts +20 -0
- package/dist/es/src/components/DialogEmbed/DialogPortal.d.ts +36 -0
- package/dist/es/src/components/DialogEmbed/index.d.ts +38 -0
- package/dist/es/src/components/PlayerEmbed/controllers/event-forwarder.d.ts +15 -0
- package/dist/es/src/components/{Embed → PlayerEmbed}/controllers/fetcher.d.ts +4 -4
- package/dist/es/src/components/{Embed → PlayerEmbed}/controllers/tracking/index.d.ts +4 -4
- package/dist/es/src/components/{Embed → PlayerEmbed}/controllers/tracking/utils.d.ts +1 -1
- package/dist/es/src/components/PlayerEmbed/index.d.ts +75 -0
- package/dist/es/src/components/PlayerEmbed/tests/data.d.ts +4 -0
- package/dist/es/src/components/PlayerEmbed/tests/media-data.d.ts +19 -0
- package/dist/es/src/index.d.ts +2 -1
- package/dist/iife/dialog-embed/embed.iife.js +4042 -0
- package/dist/iife/dialog-embed/embed.iife.js.map +1 -0
- package/dist/iife/embeds.iife.js +2868 -398
- package/dist/iife/embeds.iife.js.map +1 -1
- package/dist/iife/player-embed/embed.iife.js +3904 -0
- package/dist/iife/player-embed/embed.iife.js.map +1 -0
- package/package.json +42 -32
- package/src/components/DialogEmbed/Dialog.stories.ts +91 -0
- package/src/components/DialogEmbed/DialogOverlay.ts +131 -0
- package/src/components/DialogEmbed/DialogPortal.ts +126 -0
- package/src/components/DialogEmbed/index.ts +97 -0
- package/src/components/PlayerEmbed/MultiEmbed.stories.ts +135 -0
- package/src/components/{Embed/Embed.stories.ts → PlayerEmbed/PlayerEmbed.stories.ts} +29 -15
- package/src/components/{Embed → PlayerEmbed}/controllers/event-forwarder.ts +6 -5
- package/src/components/{Embed → PlayerEmbed}/controllers/fetcher.ts +11 -11
- package/src/components/{Embed → PlayerEmbed}/controllers/tracking/index.ts +11 -11
- package/src/components/{Embed → PlayerEmbed}/controllers/tracking/utils.ts +2 -2
- package/src/components/{Embed → PlayerEmbed}/index.ts +58 -39
- package/src/components/{Embed/tests/Embed.spec.ts → PlayerEmbed/tests/PlayerEmbed.spec.ts} +19 -10
- package/src/components/PlayerEmbed/tests/data.ts +227 -0
- package/src/components/PlayerEmbed/tests/media-data.ts +22 -0
- package/src/index.ts +2 -1
- package/dist/es/browser-8d4ae80d.js +0 -433
- package/dist/es/browser-8d4ae80d.js.map +0 -1
- package/dist/es/index-74d4cefa.js +0 -9980
- package/dist/es/index-74d4cefa.js.map +0 -1
- package/dist/es/src/components/Embed/index.d.ts +0 -71
- package/dist/es/src/components/Embed/tests/data.d.ts +0 -3
- package/src/components/Embed/tests/data.ts +0 -183
@@ -0,0 +1,135 @@
|
|
1
|
+
import { html } from 'lit';
|
2
|
+
import { ifDefined } from 'lit/directives/if-defined.js';
|
3
|
+
|
4
|
+
import type { PlayerEmbedProps } from '.';
|
5
|
+
import type { Meta, StoryObj } from '@storybook/web-components';
|
6
|
+
|
7
|
+
import '.';
|
8
|
+
|
9
|
+
type MultiEmbedArgs = PlayerEmbedProps & {
|
10
|
+
apiKey1?: string;
|
11
|
+
apiKey2?: string;
|
12
|
+
apiKey3?: string;
|
13
|
+
vouchId1?: string;
|
14
|
+
vouchId2?: string;
|
15
|
+
vouchId3?: string;
|
16
|
+
showVouch?: boolean;
|
17
|
+
};
|
18
|
+
|
19
|
+
const _MultiEmbed = ({
|
20
|
+
vouchId1,
|
21
|
+
vouchId2,
|
22
|
+
vouchId3,
|
23
|
+
templateId,
|
24
|
+
questions,
|
25
|
+
preload,
|
26
|
+
autoplay,
|
27
|
+
env,
|
28
|
+
apiKey1,
|
29
|
+
apiKey2,
|
30
|
+
apiKey3,
|
31
|
+
controls,
|
32
|
+
aspectRatio
|
33
|
+
}: MultiEmbedArgs) => {
|
34
|
+
return html`
|
35
|
+
<div style="height: 33vh">
|
36
|
+
<vouch-embed-player
|
37
|
+
env=${ifDefined(env)}
|
38
|
+
apiKey=${ifDefined(apiKey1)}
|
39
|
+
vouchId=${ifDefined(vouchId1)}
|
40
|
+
templateId=${ifDefined(templateId)}
|
41
|
+
.questions=${questions}
|
42
|
+
.controls=${controls}
|
43
|
+
?autoplay=${autoplay}
|
44
|
+
preload=${ifDefined(preload)}
|
45
|
+
aspectRatio=${ifDefined(aspectRatio)}
|
46
|
+
@error=${console.log}
|
47
|
+
></vouch-embed-player>
|
48
|
+
</div>
|
49
|
+
<div style="height: 33vh">
|
50
|
+
<vouch-embed-player
|
51
|
+
env=${ifDefined(env)}
|
52
|
+
apiKey=${ifDefined(apiKey2)}
|
53
|
+
vouchId=${ifDefined(vouchId2)}
|
54
|
+
templateId=${ifDefined(templateId)}
|
55
|
+
.questions=${questions}
|
56
|
+
.controls=${controls}
|
57
|
+
?autoplay=${autoplay}
|
58
|
+
preload=${ifDefined(preload)}
|
59
|
+
aspectRatio=${ifDefined(aspectRatio)}
|
60
|
+
@error=${console.log}
|
61
|
+
></vouch-embed-player>
|
62
|
+
</div>
|
63
|
+
<div style="height: 33vh">
|
64
|
+
<vouch-embed-player
|
65
|
+
env=${ifDefined(env)}
|
66
|
+
apiKey=${ifDefined(apiKey3)}
|
67
|
+
vouchId=${ifDefined(vouchId3)}
|
68
|
+
templateId=${ifDefined(templateId)}
|
69
|
+
.questions=${questions}
|
70
|
+
.controls=${controls}
|
71
|
+
?autoplay=${autoplay}
|
72
|
+
preload=${ifDefined(preload)}
|
73
|
+
aspectRatio=${ifDefined(aspectRatio)}
|
74
|
+
@error=${console.log}
|
75
|
+
></vouch-embed-player>
|
76
|
+
</div>
|
77
|
+
`;
|
78
|
+
};
|
79
|
+
|
80
|
+
// More on how to set up stories at: https://storybook.js.org/docs/web-components/writing-stories/introduction
|
81
|
+
const meta = {
|
82
|
+
title: 'Embeds',
|
83
|
+
tags: ['autodocs'],
|
84
|
+
render: (args) => _MultiEmbed(args),
|
85
|
+
component: 'vouch-embed-player'
|
86
|
+
} satisfies Meta<PlayerEmbedProps>;
|
87
|
+
|
88
|
+
type Story = StoryObj<MultiEmbedArgs>;
|
89
|
+
|
90
|
+
const MultiPlayer: Story = {
|
91
|
+
args: {
|
92
|
+
env: 'dev',
|
93
|
+
apiKey1: 'TVik9uTMgE-PD25UTHIS6gyl0hMBWC7AT4dkpdlLBT4VIfDWZJrQiCk6Ak7m1',
|
94
|
+
vouchId1: '6JQEIPeStt',
|
95
|
+
apiKey2: 'TVik9uTMgE-PD25UTHIS6gyl0hMBWC7AT4dkpdlLBT4VIfDWZJrQiCk6Ak7m1',
|
96
|
+
vouchId2: '6JQEIPeStt',
|
97
|
+
apiKey3: 'TVik9uTMgE-PD25UTHIS6gyl0hMBWC7AT4dkpdlLBT4VIfDWZJrQiCk6Ak7m1',
|
98
|
+
vouchId3: '6JQEIPeStt',
|
99
|
+
templateId: '357fc118-e179-4171-9446-ff2b8e9d1b29',
|
100
|
+
questions: [],
|
101
|
+
aspectRatio: 0,
|
102
|
+
preload: 'none',
|
103
|
+
autoplay: false,
|
104
|
+
controls: [
|
105
|
+
'progress',
|
106
|
+
'play-large',
|
107
|
+
'navigation',
|
108
|
+
'play',
|
109
|
+
'volume',
|
110
|
+
'current-time',
|
111
|
+
'duration',
|
112
|
+
'speed',
|
113
|
+
'captions',
|
114
|
+
'fullscreen',
|
115
|
+
'preview',
|
116
|
+
'languages'
|
117
|
+
]
|
118
|
+
},
|
119
|
+
argTypes: {
|
120
|
+
env: {
|
121
|
+
control: 'radio',
|
122
|
+
options: ['local', 'dev', 'staging', 'prod']
|
123
|
+
},
|
124
|
+
preload: {
|
125
|
+
control: 'radio',
|
126
|
+
options: ['auto', 'none']
|
127
|
+
}
|
128
|
+
},
|
129
|
+
parameters: {
|
130
|
+
layout: 'fullscreen'
|
131
|
+
}
|
132
|
+
};
|
133
|
+
|
134
|
+
export default meta;
|
135
|
+
export { MultiPlayer };
|
@@ -1,16 +1,16 @@
|
|
1
1
|
import { html } from 'lit';
|
2
2
|
import { ifDefined } from 'lit/directives/if-defined.js';
|
3
3
|
|
4
|
-
import type {
|
4
|
+
import type { PlayerEmbedProps } from '.';
|
5
5
|
import type { Meta, StoryObj } from '@storybook/web-components';
|
6
6
|
|
7
|
-
import '
|
7
|
+
import '.';
|
8
8
|
|
9
|
-
type
|
9
|
+
type PlayerEmbedArgs = PlayerEmbedProps & {
|
10
10
|
showVouch?: boolean;
|
11
11
|
};
|
12
12
|
|
13
|
-
const
|
13
|
+
const _PlayerEmbed = ({
|
14
14
|
vouchId,
|
15
15
|
templateId,
|
16
16
|
questions,
|
@@ -20,10 +20,10 @@ const _Embed = ({
|
|
20
20
|
apiKey,
|
21
21
|
controls,
|
22
22
|
aspectRatio
|
23
|
-
}:
|
23
|
+
}: PlayerEmbedArgs) => {
|
24
24
|
return html`
|
25
25
|
<div style="height: 100vh">
|
26
|
-
<vouch-embed
|
26
|
+
<vouch-embed-player
|
27
27
|
env=${ifDefined(env)}
|
28
28
|
apiKey=${ifDefined(apiKey)}
|
29
29
|
vouchId=${ifDefined(vouchId)}
|
@@ -34,22 +34,22 @@ const _Embed = ({
|
|
34
34
|
preload=${ifDefined(preload)}
|
35
35
|
aspectRatio=${ifDefined(aspectRatio)}
|
36
36
|
@error=${console.log}
|
37
|
-
></vouch-embed>
|
37
|
+
></vouch-embed-player>
|
38
38
|
</div>
|
39
39
|
`;
|
40
40
|
};
|
41
41
|
|
42
42
|
// More on how to set up stories at: https://storybook.js.org/docs/web-components/writing-stories/introduction
|
43
43
|
const meta = {
|
44
|
-
title: '
|
44
|
+
title: 'Embeds',
|
45
45
|
tags: ['autodocs'],
|
46
|
-
render: (args) =>
|
47
|
-
component: 'vouch-embed'
|
48
|
-
} satisfies Meta<
|
46
|
+
render: (args) => _PlayerEmbed(args),
|
47
|
+
component: 'vouch-embed-player'
|
48
|
+
} satisfies Meta<PlayerEmbedProps>;
|
49
49
|
|
50
|
-
type Story = StoryObj<
|
50
|
+
type Story = StoryObj<PlayerEmbedArgs>;
|
51
51
|
|
52
|
-
const
|
52
|
+
const Player: Story = {
|
53
53
|
args: {
|
54
54
|
env: 'dev',
|
55
55
|
apiKey: 'TVik9uTMgE-PD25UTHIS6gyl0hMBWC7AT4dkpdlLBT4VIfDWZJrQiCk6Ak7m1',
|
@@ -58,7 +58,21 @@ const Embed: Story = {
|
|
58
58
|
questions: [],
|
59
59
|
aspectRatio: 0,
|
60
60
|
preload: 'none',
|
61
|
-
autoplay: false
|
61
|
+
autoplay: false,
|
62
|
+
controls: [
|
63
|
+
'progress',
|
64
|
+
'play-large',
|
65
|
+
'navigation',
|
66
|
+
'play',
|
67
|
+
'volume',
|
68
|
+
'current-time',
|
69
|
+
'duration',
|
70
|
+
'speed',
|
71
|
+
'captions',
|
72
|
+
'fullscreen',
|
73
|
+
'preview',
|
74
|
+
'languages'
|
75
|
+
]
|
62
76
|
},
|
63
77
|
argTypes: {
|
64
78
|
env: {
|
@@ -76,4 +90,4 @@ const Embed: Story = {
|
|
76
90
|
};
|
77
91
|
|
78
92
|
export default meta;
|
79
|
-
export {
|
93
|
+
export { Player };
|
@@ -1,27 +1,28 @@
|
|
1
1
|
import { createRef, ref } from 'lit/directives/ref.js';
|
2
2
|
|
3
|
-
import type {
|
3
|
+
import type { PlayerEmbed } from '..';
|
4
4
|
import type { ReactiveController, ReactiveControllerHost } from 'lit';
|
5
|
+
import type { DirectiveResult } from 'lit/directive.js';
|
5
6
|
import type { Ref } from 'lit/directives/ref.js';
|
6
7
|
|
7
8
|
import { forwardEvent } from '~/utils/events';
|
8
9
|
|
9
|
-
type
|
10
|
+
type PlayerEmbedHost = ReactiveControllerHost & PlayerEmbed;
|
10
11
|
|
11
12
|
class EventForwardController implements ReactiveController {
|
12
|
-
host:
|
13
|
+
host: PlayerEmbedHost;
|
13
14
|
|
14
15
|
private _events: string[] = [];
|
15
16
|
private _cleanup: (() => void)[] = [];
|
16
17
|
private _forwardElementRef: Ref<HTMLElement> = createRef();
|
17
18
|
|
18
|
-
constructor(host:
|
19
|
+
constructor(host: PlayerEmbedHost, events: string[]) {
|
19
20
|
this.host = host;
|
20
21
|
this._events = events;
|
21
22
|
host.addController(this);
|
22
23
|
}
|
23
24
|
|
24
|
-
register() {
|
25
|
+
register(): DirectiveResult {
|
25
26
|
return ref(this._forwardElementRef);
|
26
27
|
}
|
27
28
|
|
@@ -1,29 +1,29 @@
|
|
1
1
|
import { Task } from '@lit/task';
|
2
2
|
import { v4 as uuidv4 } from 'uuid';
|
3
3
|
|
4
|
-
import type {
|
4
|
+
import type { PlayerEmbed, PlayerEmbedProps } from '..';
|
5
5
|
import type { ReactiveControllerHost } from 'lit';
|
6
6
|
import type { Environment } from '~/utils/env';
|
7
7
|
|
8
8
|
import { getEnvUrls } from '~/utils/env';
|
9
9
|
|
10
|
-
type
|
10
|
+
type PlayerEmbedHost = ReactiveControllerHost & PlayerEmbed;
|
11
11
|
|
12
12
|
type FetchTaskDeps = [
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
13
|
+
PlayerEmbedProps['env'],
|
14
|
+
PlayerEmbedProps['apiKey'],
|
15
|
+
PlayerEmbedProps['data'],
|
16
|
+
PlayerEmbedProps['vouchId'],
|
17
|
+
PlayerEmbedProps['templateId']
|
18
18
|
];
|
19
19
|
|
20
|
-
type FilterTaskDeps = [
|
20
|
+
type FilterTaskDeps = [PlayerEmbedProps['data'], PlayerEmbedProps['questions']];
|
21
21
|
|
22
22
|
class FetcherController {
|
23
|
-
host:
|
23
|
+
host: PlayerEmbedHost;
|
24
24
|
|
25
25
|
private _fetching = false;
|
26
|
-
private _vouch:
|
26
|
+
private _vouch: PlayerEmbedProps['data'];
|
27
27
|
|
28
28
|
set fetching(value) {
|
29
29
|
if (this._fetching !== value) {
|
@@ -97,7 +97,7 @@ class FetcherController {
|
|
97
97
|
return template;
|
98
98
|
};
|
99
99
|
|
100
|
-
constructor(host:
|
100
|
+
constructor(host: PlayerEmbedHost) {
|
101
101
|
this.host = host;
|
102
102
|
new Task<FetchTaskDeps, void>(
|
103
103
|
this.host,
|
@@ -1,5 +1,5 @@
|
|
1
|
-
import type {
|
2
|
-
import type {
|
1
|
+
import type { PlayerEmbed } from '../..';
|
2
|
+
import type { MediaEventDetail } from '@vouchfor/media-player';
|
3
3
|
import type { ReactiveController, ReactiveControllerHost } from 'lit';
|
4
4
|
|
5
5
|
import { findVouchId, getReportingMetadata, getUids } from './utils';
|
@@ -7,7 +7,7 @@ import { getEnvUrls } from '~/utils/env';
|
|
7
7
|
|
8
8
|
const MINIMUM_SEND_THRESHOLD = 1;
|
9
9
|
|
10
|
-
type
|
10
|
+
type PlayerEmbedHost = ReactiveControllerHost & PlayerEmbed;
|
11
11
|
|
12
12
|
type TrackingEvent = 'VOUCH_LOADED' | 'VOUCH_RESPONSE_VIEWED' | 'VIDEO_PLAYED' | 'VIDEO_STREAMED';
|
13
13
|
type TrackingPayload = {
|
@@ -33,7 +33,7 @@ type BooleanMap = {
|
|
33
33
|
};
|
34
34
|
|
35
35
|
class TrackingController implements ReactiveController {
|
36
|
-
host:
|
36
|
+
host: PlayerEmbedHost;
|
37
37
|
|
38
38
|
private _batchedEvents: BatchEvent[] = [];
|
39
39
|
private _hasPlayed = false;
|
@@ -41,9 +41,9 @@ class TrackingController implements ReactiveController {
|
|
41
41
|
private _answersViewed: BooleanMap = {};
|
42
42
|
private _streamStartTime: TimeMap = {};
|
43
43
|
private _streamLatestTime: TimeMap = {};
|
44
|
-
private _currentlyPlayingVideo:
|
44
|
+
private _currentlyPlayingVideo: MediaEventDetail | null = null;
|
45
45
|
|
46
|
-
constructor(host:
|
46
|
+
constructor(host: PlayerEmbedHost) {
|
47
47
|
this.host = host;
|
48
48
|
host.addController(this);
|
49
49
|
}
|
@@ -134,7 +134,7 @@ class TrackingController implements ReactiveController {
|
|
134
134
|
}
|
135
135
|
};
|
136
136
|
|
137
|
-
private _handleVideoPlay = ({ detail: { id, key } }: CustomEvent<
|
137
|
+
private _handleVideoPlay = ({ detail: { id, key } }: CustomEvent<MediaEventDetail>) => {
|
138
138
|
// Only increment play count once per session
|
139
139
|
if (!this._answersViewed[key]) {
|
140
140
|
this._createTrackingEvent('VOUCH_RESPONSE_VIEWED', {
|
@@ -144,12 +144,12 @@ class TrackingController implements ReactiveController {
|
|
144
144
|
}
|
145
145
|
};
|
146
146
|
|
147
|
-
private _handleVideoTimeUpdate = ({ detail: { id, key, node } }: CustomEvent<
|
147
|
+
private _handleVideoTimeUpdate = ({ detail: { id, key, node } }: CustomEvent<MediaEventDetail>) => {
|
148
148
|
if (
|
149
149
|
// We only want to count any time that the video is actually playing
|
150
|
-
!this.host.paused
|
150
|
+
!this.host.paused
|
151
151
|
// Only update the latest time if this event fires for the currently active video
|
152
|
-
id === this.host.scene?.video?.id
|
152
|
+
// id === this.host.scene?.video?.id
|
153
153
|
) {
|
154
154
|
this._currentlyPlayingVideo = { id, key, node };
|
155
155
|
this._streamLatestTime[key] = node.currentTime;
|
@@ -161,7 +161,7 @@ class TrackingController implements ReactiveController {
|
|
161
161
|
}
|
162
162
|
};
|
163
163
|
|
164
|
-
private _handleVideoPause = ({ detail: { id, key } }: CustomEvent<
|
164
|
+
private _handleVideoPause = ({ detail: { id, key } }: CustomEvent<MediaEventDetail>) => {
|
165
165
|
if (this._streamLatestTime[key] > this._streamStartTime[key] + MINIMUM_SEND_THRESHOLD) {
|
166
166
|
this._createTrackingEvent('VIDEO_STREAMED', {
|
167
167
|
answerId: id,
|
@@ -2,10 +2,10 @@ import { TEMPLATE_VERSION } from '@vouchfor/canvas-video';
|
|
2
2
|
import { v4 as uuidv4 } from 'uuid';
|
3
3
|
|
4
4
|
import type { TrackingPayload } from '.';
|
5
|
-
import type { Vouch } from '@vouchfor/
|
5
|
+
import type { Vouch } from '@vouchfor/video-utils';
|
6
6
|
import type { Environment } from '~/utils/env';
|
7
7
|
|
8
|
-
import packageJson from '
|
8
|
+
import packageJson from '~/../package.json';
|
9
9
|
import { getEnvUrls } from '~/utils/env';
|
10
10
|
|
11
11
|
function createVisitor(env: Environment) {
|
@@ -3,9 +3,10 @@ import { customElement, property, state } from 'lit/decorators.js';
|
|
3
3
|
import { ifDefined } from 'lit/directives/if-defined.js';
|
4
4
|
import { createRef, ref } from 'lit/directives/ref.js';
|
5
5
|
|
6
|
-
import type {
|
6
|
+
import type { TemplateInstance } from '@vouchfor/canvas-video';
|
7
7
|
import type { MediaPlayer, MediaPlayerProps } from '@vouchfor/media-player';
|
8
|
-
import type {
|
8
|
+
import type { Vouch } from '@vouchfor/video-utils';
|
9
|
+
import type { PropertyValueMap } from 'lit';
|
9
10
|
import type { Environment } from '~/utils/env';
|
10
11
|
|
11
12
|
import { EventForwardController } from './controllers/event-forwarder';
|
@@ -14,7 +15,8 @@ import { TrackingController } from './controllers/tracking';
|
|
14
15
|
|
15
16
|
import '@vouchfor/media-player';
|
16
17
|
|
17
|
-
type
|
18
|
+
type PlayerEmbedProps = Pick<MediaPlayerProps, 'aspectRatio' | 'language' | 'preload' | 'autoplay' | 'controls'> & {
|
19
|
+
data?: Vouch;
|
18
20
|
env: Environment;
|
19
21
|
apiKey: string;
|
20
22
|
disableTracking?: boolean;
|
@@ -25,8 +27,8 @@ type EmbedProps = Pick<MediaPlayerProps, 'data' | 'aspectRatio' | 'preload' | 'a
|
|
25
27
|
questions?: number[];
|
26
28
|
};
|
27
29
|
|
28
|
-
@customElement('vouch-embed')
|
29
|
-
class
|
30
|
+
@customElement('vouch-embed-player')
|
31
|
+
class PlayerEmbed extends LitElement {
|
30
32
|
static styles = [
|
31
33
|
css`
|
32
34
|
:host {
|
@@ -35,22 +37,21 @@ class Embed extends LitElement {
|
|
35
37
|
`
|
36
38
|
];
|
37
39
|
|
38
|
-
|
40
|
+
@property({ type: Object }) data: PlayerEmbedProps['data'];
|
41
|
+
@property({ type: String }) vouchId: PlayerEmbedProps['vouchId'];
|
42
|
+
@property({ type: String }) templateId: PlayerEmbedProps['templateId'];
|
43
|
+
@property({ type: Array }) questions: PlayerEmbedProps['questions'];
|
39
44
|
|
40
|
-
@property({ type:
|
41
|
-
@property({ type: String })
|
42
|
-
@property({ type:
|
43
|
-
@property({ type:
|
45
|
+
@property({ type: String }) env: PlayerEmbedProps['env'] = 'prod';
|
46
|
+
@property({ type: String }) apiKey: PlayerEmbedProps['apiKey'] = '';
|
47
|
+
@property({ type: Boolean }) disableTracking: PlayerEmbedProps['disableTracking'] = false;
|
48
|
+
@property({ type: String }) trackingSource: PlayerEmbedProps['trackingSource'] = 'embedded_player';
|
44
49
|
|
45
|
-
@property({ type:
|
46
|
-
@property({ type: String })
|
47
|
-
@property({ type: Boolean })
|
48
|
-
@property({ type:
|
49
|
-
|
50
|
-
@property({ type: Array }) controls: EmbedProps['controls'];
|
51
|
-
@property({ type: String }) preload: EmbedProps['preload'] = 'auto';
|
52
|
-
@property({ type: Boolean }) autoplay: EmbedProps['autoplay'] = false;
|
53
|
-
@property({ type: Number }) aspectRatio: EmbedProps['aspectRatio'] = 0;
|
50
|
+
@property({ type: Array }) controls: PlayerEmbedProps['controls'];
|
51
|
+
@property({ type: String }) preload: PlayerEmbedProps['preload'] = 'auto';
|
52
|
+
@property({ type: Boolean }) autoplay: PlayerEmbedProps['autoplay'] = false;
|
53
|
+
@property({ type: Number }) aspectRatio: PlayerEmbedProps['aspectRatio'] = 0;
|
54
|
+
@property({ type: String }) language?: MediaPlayerProps['language'];
|
54
55
|
|
55
56
|
private eventController = new EventForwardController(this, [
|
56
57
|
'durationchange',
|
@@ -63,10 +64,12 @@ class Embed extends LitElement {
|
|
63
64
|
'playing',
|
64
65
|
'ratechange',
|
65
66
|
'scenechange',
|
67
|
+
'scenesupdate',
|
66
68
|
'seeking',
|
67
69
|
'seeked',
|
68
70
|
'timeupdate',
|
69
71
|
'volumechange',
|
72
|
+
'processing',
|
70
73
|
'waiting',
|
71
74
|
|
72
75
|
'video:loadeddata',
|
@@ -85,17 +88,23 @@ class Embed extends LitElement {
|
|
85
88
|
// @ts-ignore
|
86
89
|
private _trackingController = new TrackingController(this);
|
87
90
|
|
88
|
-
@state() vouch:
|
91
|
+
@state() vouch: PlayerEmbedProps['data'];
|
89
92
|
@state() template: TemplateInstance | undefined;
|
90
93
|
|
91
94
|
get fetching() {
|
92
95
|
return this._fetcherController.fetching;
|
93
96
|
}
|
94
97
|
|
98
|
+
private _mediaPlayerRef = createRef<MediaPlayer>();
|
99
|
+
|
95
100
|
get waiting() {
|
96
101
|
return this._mediaPlayerRef.value?.waiting;
|
97
102
|
}
|
98
103
|
|
104
|
+
get initialised() {
|
105
|
+
return this._mediaPlayerRef.value?.initialised;
|
106
|
+
}
|
107
|
+
|
99
108
|
get seeking() {
|
100
109
|
return this._mediaPlayerRef.value?.seeking;
|
101
110
|
}
|
@@ -152,20 +161,20 @@ class Embed extends LitElement {
|
|
152
161
|
return this._mediaPlayerRef.value?.muted ?? false;
|
153
162
|
}
|
154
163
|
|
155
|
-
get scene(): Scene | null {
|
156
|
-
|
157
|
-
}
|
164
|
+
// get scene(): Scene | null {
|
165
|
+
// return this._mediaPlayerRef.value?.scene ?? null;
|
166
|
+
// }
|
158
167
|
|
159
|
-
get scenes(): Scene[] {
|
160
|
-
|
161
|
-
}
|
168
|
+
// get scenes(): Scene[] {
|
169
|
+
// return this._mediaPlayerRef.value?.scenes ?? [];
|
170
|
+
// }
|
162
171
|
|
163
|
-
get sceneConfig(): Scenes | null {
|
164
|
-
|
165
|
-
}
|
172
|
+
// get sceneConfig(): Scenes | null {
|
173
|
+
// return this._mediaPlayerRef.value?.sceneConfig ?? null;
|
174
|
+
// }
|
166
175
|
|
167
|
-
get
|
168
|
-
return this._mediaPlayerRef.value?.
|
176
|
+
get mediaState() {
|
177
|
+
return this._mediaPlayerRef.value?.mediaState;
|
169
178
|
}
|
170
179
|
|
171
180
|
get mediaPlayer() {
|
@@ -180,10 +189,14 @@ class Embed extends LitElement {
|
|
180
189
|
this._mediaPlayerRef.value?.pause();
|
181
190
|
}
|
182
191
|
|
183
|
-
|
184
|
-
this._mediaPlayerRef.value?.
|
192
|
+
reset(time = 0, play = false) {
|
193
|
+
this._mediaPlayerRef.value?.reset(time, play);
|
185
194
|
}
|
186
195
|
|
196
|
+
// setScene(index: number) {
|
197
|
+
// this._mediaPlayerRef.value?.setScene(index);
|
198
|
+
// }
|
199
|
+
|
187
200
|
private _renderStyles() {
|
188
201
|
if (!this.aspectRatio) {
|
189
202
|
return html`
|
@@ -209,6 +222,13 @@ class Embed extends LitElement {
|
|
209
222
|
return null;
|
210
223
|
}
|
211
224
|
|
225
|
+
protected willUpdate(changedProperties: PropertyValueMap<PlayerEmbedProps>) {
|
226
|
+
// If the vouch this embed is pointing to changes then reset the player
|
227
|
+
if (changedProperties.has('vouchId') && this.vouchId !== changedProperties.get('vouchId')) {
|
228
|
+
this.reset(0, false);
|
229
|
+
}
|
230
|
+
}
|
231
|
+
|
212
232
|
render() {
|
213
233
|
return html`
|
214
234
|
${this._renderStyles()}
|
@@ -217,10 +237,9 @@ class Embed extends LitElement {
|
|
217
237
|
${this.eventController.register()}
|
218
238
|
?autoplay=${this.autoplay}
|
219
239
|
?loading=${this.fetching}
|
220
|
-
.data=${this.vouch}
|
221
|
-
.template=${this.template}
|
222
240
|
aspectRatio=${ifDefined(this.aspectRatio)}
|
223
241
|
preload=${ifDefined(this.preload)}
|
242
|
+
language=${ifDefined(this.language)}
|
224
243
|
.controls=${this.controls}
|
225
244
|
></vmp-media-player>
|
226
245
|
`;
|
@@ -229,15 +248,15 @@ class Embed extends LitElement {
|
|
229
248
|
|
230
249
|
declare global {
|
231
250
|
interface HTMLElementTagNameMap {
|
232
|
-
'vouch-embed':
|
251
|
+
'vouch-embed-player': PlayerEmbed;
|
233
252
|
}
|
234
253
|
|
235
254
|
namespace JSX {
|
236
255
|
interface IntrinsicElements {
|
237
|
-
'vouch-embed':
|
256
|
+
'vouch-embed-player': PlayerEmbed;
|
238
257
|
}
|
239
258
|
}
|
240
259
|
}
|
241
260
|
|
242
|
-
export {
|
243
|
-
export type {
|
261
|
+
export { PlayerEmbed };
|
262
|
+
export type { PlayerEmbedProps };
|
@@ -3,8 +3,8 @@ import { expect, fixture, waitUntil } from '@open-wc/testing';
|
|
3
3
|
import { html } from 'lit';
|
4
4
|
import sinon from 'sinon';
|
5
5
|
|
6
|
-
import type {
|
7
|
-
import type {
|
6
|
+
import type { PlayerEmbed } from '../index.js';
|
7
|
+
import type { MediaMap } from '@vouchfor/media-player';
|
8
8
|
|
9
9
|
import { data } from './data.js';
|
10
10
|
|
@@ -13,11 +13,11 @@ import { data } from './data.js';
|
|
13
13
|
// https://modern-web.dev/guides/test-runner/typescript/
|
14
14
|
import '../../../test/lib/embeds.js';
|
15
15
|
|
16
|
-
function getVideo(videos:
|
16
|
+
function getVideo(videos: MediaMap) {
|
17
17
|
return Object.values(videos)[0];
|
18
18
|
}
|
19
19
|
|
20
|
-
function playerLoaded(player:
|
20
|
+
function playerLoaded(player: PlayerEmbed) {
|
21
21
|
return waitUntil(
|
22
22
|
() => {
|
23
23
|
return player.mediaPlayer?.initialised;
|
@@ -27,9 +27,11 @@ function playerLoaded(player: Embed) {
|
|
27
27
|
);
|
28
28
|
}
|
29
29
|
|
30
|
-
describe('Embeds', () => {
|
31
|
-
it('
|
32
|
-
const player = await fixture<
|
30
|
+
describe.skip('Embeds', () => {
|
31
|
+
it('Sends correct tracking events', async () => {
|
32
|
+
const player = await fixture<PlayerEmbed>(
|
33
|
+
html`<vouch-embed-player env="dev" .data=${data} aspectratio=${1}></vouch-embed-player>`
|
34
|
+
);
|
33
35
|
// @ts-ignore - accessing private property
|
34
36
|
const sendTrackingSpy = sinon.spy(player._trackingController, '_sendTrackingEvent');
|
35
37
|
// @ts-ignore - accessing private property
|
@@ -43,17 +45,24 @@ describe('Embeds', () => {
|
|
43
45
|
await waitUntil(
|
44
46
|
() => {
|
45
47
|
// Video plays for 3 seconds
|
46
|
-
return (getVideo(player.mediaPlayer!.
|
48
|
+
return (getVideo(player.mediaPlayer!.media)?.node?.currentTime ?? 0) > 3;
|
47
49
|
},
|
48
50
|
'Video did not play for 3 seconds',
|
49
51
|
{ timeout: 20000 }
|
50
52
|
);
|
51
|
-
expect(getVideo(player.mediaPlayer!.
|
53
|
+
expect(getVideo(player.mediaPlayer!.media)?.node?.paused).eq(false);
|
52
54
|
player.pause();
|
53
|
-
expect(getVideo(player.mediaPlayer!.
|
55
|
+
expect(getVideo(player.mediaPlayer!.media)?.node?.paused).eq(true);
|
54
56
|
expect(sendTrackingSpy.callCount).to.be.eq(0);
|
55
57
|
// Destroy node because events are sent when node is removed from the document
|
56
58
|
player.remove();
|
59
|
+
await waitUntil(
|
60
|
+
() => {
|
61
|
+
return createTrackingSpy.args[2];
|
62
|
+
},
|
63
|
+
'Cleanup event has not fired',
|
64
|
+
{ timeout: 5000 }
|
65
|
+
);
|
57
66
|
expect(sendTrackingSpy.callCount).to.be.eq(1);
|
58
67
|
expect(createTrackingSpy.args[0]).to.eql([
|
59
68
|
'VIDEO_PLAYED',
|