@glomex/integration-web-component 1.1366.0 → 1.1367.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/build/index.d.ts +33 -5
  2. package/package.json +3 -3
package/build/index.d.ts CHANGED
@@ -14,6 +14,35 @@ export declare interface Ad {
14
14
  nonLinearHeight?: number;
15
15
  }
16
16
 
17
+ /**
18
+ * An additional API script definition that should be executed for this media-item.
19
+ *
20
+ * @example
21
+ * ```
22
+ * {
23
+ * name: 'some-name',
24
+ * scriptUrl: 'https://content-owner.com/tracking/script.js',
25
+ * conditions: [
26
+ * { startMethod: 'click-to-play', muted: false },
27
+ * { startMethod: 'autoplay-scroll', muted: undefined } // undefined = muted & unmuted
28
+ * ]
29
+ * }
30
+ * ```
31
+ */
32
+ declare interface ApiScript {
33
+ /** Name of the API script that should be exposed to tracking */
34
+ name: string;
35
+ /** URL of the API script that should be executed. Must implement {@link ConnectIntegration}. */
36
+ url: string;
37
+ /**
38
+ * Conditions under which the API script should be executed. Undefined means always.
39
+ */
40
+ conditions?: {
41
+ startMethod: StartMethod;
42
+ muted: boolean | undefined;
43
+ }[];
44
+ }
45
+
17
46
  export declare interface Channel {
18
47
  /** Name of the channel */
19
48
  name: string;
@@ -383,8 +412,9 @@ export declare class IntegrationElement extends HTMLElement implements Integrati
383
412
  }) => void;
384
413
  /**
385
414
  * Initiates playback of the media content.
415
+ * @param options.startMethod - The method used to start playback (defaults to CLICK)
386
416
  */
387
- play({ startMethod }?: {
417
+ play(options?: {
388
418
  startMethod: Exclude<StartMethod, StartMethod.PRE_CLICK>;
389
419
  }): void;
390
420
  /**
@@ -1213,12 +1243,10 @@ export declare interface MediaItem {
1213
1243
  */
1214
1244
  allowTeaserExperiments?: boolean;
1215
1245
  /**
1216
- * URL of the API script that should be executed for this media-item. Script
1217
- * must export `export function connectIntegration(glomexIntegration) {}`
1218
- *
1246
+ * An additional API script definition that should be executed for this media-item.
1219
1247
  * @ignore
1220
1248
  */
1221
- apiScriptUrl?: string;
1249
+ apiScript?: ApiScript;
1222
1250
  /**
1223
1251
  * Indicates the source from which additional metadata was derived (e.g., "joyn").
1224
1252
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@glomex/integration-web-component",
3
- "version": "1.1366.0",
3
+ "version": "1.1367.2",
4
4
  "description": "Web component and types to integrate the glomex player",
5
5
  "documentation": "https://docs.glomex.com",
6
6
  "homepage": "https://glomex.com",
@@ -30,7 +30,7 @@
30
30
  },
31
31
  "devDependencies": {
32
32
  "@biomejs/biome": "^1.9.4",
33
- "@glomex/integration": "^1.1366.0",
33
+ "@glomex/integration": "^1.1367.2",
34
34
  "@microsoft/api-extractor": "^7.52.8",
35
35
  "@rslib/core": "^0.8.0",
36
36
  "typescript": "^5.8.3"
@@ -39,5 +39,5 @@
39
39
  "access": "public"
40
40
  },
41
41
  "license": "MIT",
42
- "gitHead": "f9f64664f1c6c031e426264a0471ab08870078e5"
42
+ "gitHead": "f589fd073536eccde64a8547c0d9e64eeccbcc1f"
43
43
  }