@flowplayer/player 3.32.1-rc → 3.32.1-rc.2

package/index.d.ts

@@ -1,6 +1,8 @@
 import type { Get } from 'type-fest';
 import type { Level } from 'hls.js';
+import type { Paths } from 'type-fest';
 import type { Representation } from 'dashjs';
+import type { Translation } from '@flowplayer/translations';
 import type { TupleToUnion } from 'type-fest';
 
 /* Excluded from this release type: AnyLoader */
@@ -792,6 +794,13 @@ declare interface FlowplayerUMDBase {
     /* Excluded from this release type: support */
     /* Excluded from this release type: jwt */
     /* Excluded from this release type: loaders */
+    /**
+     * @public
+     * Translations dictionaries to be used with `@flowplayer/translations` package
+     *
+     * See [official documentation](https://developer.wowza.com/docs/wowza-flowplayer/player/translations/)
+     */
+    i18n: typeof I18n;
 }
 
 /**
@@ -869,6 +878,112 @@ declare type HasSrcExtensions<PluginBareConfigs extends unknown[]> = TupleToUnio
 
 declare const HOVERED = "is-hovered";
 
+declare class I18n implements Plugin_2 {
+    static pluginName: string;
+    static en: {
+        ads: {
+            ad: string;
+            ads: string;
+            advertisement: string;
+            indicator: string;
+            adchoices: string;
+        };
+        audio: {
+            button_txt: string;
+            menu_title: string;
+        };
+        cc: {
+            button: string;
+            menu_title: string;
+            options: string;
+            tracks: string;
+            reset: string;
+            colors: {
+                Black: string;
+                Blue: string;
+                Cyan: string;
+                Green: string;
+                Magenta: string;
+                Red: string;
+                White: string;
+                Yellow: string;
+            };
+            edgeStyle: {
+                None: string;
+                "Drop shadow": string;
+                Raised: string;
+                Depressed: string;
+                Outline: string;
+            };
+            fontFamily: {
+                "Monospaced Serif": string;
+                "Proportional Serif": string;
+                "Monospaced Sans-Serif": string;
+                "Proportional Sans-Serif": string;
+                Casual: string;
+                Cursive: string;
+            };
+            properties: {
+                fontFamily: string;
+                fontSize: string;
+                fontColor: string;
+                fontOpacity: string;
+                backgroundColor: string;
+                backgroundOpacity: string;
+                characterEdgeStyle: string;
+            };
+        };
+        chromecast: {
+            start: string;
+            stop: string;
+        };
+        core: {
+            exit_fullscreen: string;
+            fullscreen: string;
+            mute: string;
+            muted: string;
+            pause: string;
+            play: string;
+            seconds: string;
+            timeline_aria_label: string;
+            unmute: string;
+            volume: string;
+            close: string;
+            "skip-next": string;
+            "skip-prev": string;
+        };
+        ovp: {
+            starting_in: string;
+        };
+        playlist: {
+            cancel: string;
+            up_next: string;
+            autoplay: string;
+            now_playing: string;
+            turn_off_autoplay: string;
+            playlist: string;
+        };
+        qsel: {
+            menu_title: string;
+        };
+        share: {
+            clipboard_failure: string;
+            clipboard_success: string;
+            embed: string;
+            link: string;
+            menu_title: string;
+        };
+        speed: {
+            menu_title: string;
+        };
+        vtsel: {
+            button_txt: string;
+            menu_title: string;
+        };
+    };
+    init(config: Config, _root: never, video: Player): void;
+}
+
 declare const IN_VIEWPORT = "is-in-viewport";
 
 /* Excluded from this release type: INTERSECTIONCHANGE */
@@ -1264,7 +1379,8 @@ export declare type Player = HTMLVideoElement & PlayerEventOverloads & {
     /**
      * Adds a language to the project. See {@link https://developer.wowza.com/docs/wowza-flowplayer/player/translations/#using-npm| Official documentation}
      */
-    i18n(k: string, fallback?: string): string;
+    i18n(k: TranslationKey): string;
+    i18n(k: string, fallback: string): string;
     /* Excluded from this release type: deviceId */
     /* Excluded from this release type: live_state */
     /**
@@ -1999,6 +2115,15 @@ export declare type TouchMoveEventDetail = TouchEvent;
  */
 export declare type TouchStartEventDetail = TouchEvent;
 
+/**
+ * @public
+ * All possible full paths to each translation,  i.e. "core.mute"| "core.play" | "ads.ad" etc.
+ * This type is useful for developers using translation querying based on path, like in lodash's get()
+ */
+export declare type TranslationKey = Paths<Translation, {
+    leavesOnly: true;
+}>;
+
 declare type TSampleRate = typeof SampleRate;
 
 declare const TV = "is-tv";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowplayer/player",
-  "version": "3.32.1-rc",
+  "version": "3.32.1-rc.2",
   "description": "video player for the future",
   "keywords": [
     "flowplayer",
@@ -18,7 +18,7 @@
   "types": "index.d.ts",
   "dependencies": {
     "hls.js": "1.6.12",
-    "type-fest": "^4.32.0",
+    "type-fest": "^5.1.0",
     "dashjs": "5.0.3"
   },
   "exports": {

package/plugins/ads.d.ts

@@ -1,6 +1,8 @@
 import type { Get } from 'type-fest';
 import type { Level } from 'hls.js';
+import type { Paths } from 'type-fest';
 import type { Representation } from 'dashjs';
+import type { Translation } from '@flowplayer/translations';
 import type { TupleToUnion } from 'type-fest';
 
 declare const AD_ATTRIBUTION: number;
@@ -1410,6 +1412,13 @@ declare interface FlowplayerUMDBase {
     /* Excluded from this release type: support */
     /* Excluded from this release type: jwt */
     /* Excluded from this release type: loaders */
+    /**
+     * @public
+     * Translations dictionaries to be used with `@flowplayer/translations` package
+     *
+     * See [official documentation](https://developer.wowza.com/docs/wowza-flowplayer/player/translations/)
+     */
+    i18n: typeof I18n;
 }
 
 /**
@@ -2789,6 +2798,112 @@ declare type HasSrcExtensions<PluginBareConfigs extends unknown[]> = TupleToUnio
 
 declare const HOVERED = "is-hovered";
 
+declare class I18n implements Plugin_2 {
+    static pluginName: string;
+    static en: {
+        ads: {
+            ad: string;
+            ads: string;
+            advertisement: string;
+            indicator: string;
+            adchoices: string;
+        };
+        audio: {
+            button_txt: string;
+            menu_title: string;
+        };
+        cc: {
+            button: string;
+            menu_title: string;
+            options: string;
+            tracks: string;
+            reset: string;
+            colors: {
+                Black: string;
+                Blue: string;
+                Cyan: string;
+                Green: string;
+                Magenta: string;
+                Red: string;
+                White: string;
+                Yellow: string;
+            };
+            edgeStyle: {
+                None: string;
+                "Drop shadow": string;
+                Raised: string;
+                Depressed: string;
+                Outline: string;
+            };
+            fontFamily: {
+                "Monospaced Serif": string;
+                "Proportional Serif": string;
+                "Monospaced Sans-Serif": string;
+                "Proportional Sans-Serif": string;
+                Casual: string;
+                Cursive: string;
+            };
+            properties: {
+                fontFamily: string;
+                fontSize: string;
+                fontColor: string;
+                fontOpacity: string;
+                backgroundColor: string;
+                backgroundOpacity: string;
+                characterEdgeStyle: string;
+            };
+        };
+        chromecast: {
+            start: string;
+            stop: string;
+        };
+        core: {
+            exit_fullscreen: string;
+            fullscreen: string;
+            mute: string;
+            muted: string;
+            pause: string;
+            play: string;
+            seconds: string;
+            timeline_aria_label: string;
+            unmute: string;
+            volume: string;
+            close: string;
+            "skip-next": string;
+            "skip-prev": string;
+        };
+        ovp: {
+            starting_in: string;
+        };
+        playlist: {
+            cancel: string;
+            up_next: string;
+            autoplay: string;
+            now_playing: string;
+            turn_off_autoplay: string;
+            playlist: string;
+        };
+        qsel: {
+            menu_title: string;
+        };
+        share: {
+            clipboard_failure: string;
+            clipboard_success: string;
+            embed: string;
+            link: string;
+            menu_title: string;
+        };
+        speed: {
+            menu_title: string;
+        };
+        vtsel: {
+            button_txt: string;
+            menu_title: string;
+        };
+    };
+    init(config: Config, _root: never, video: Player): void;
+}
+
 declare class IMA implements Adapter {
     readonly eventHandler: AdsController;
     readonly log: Logger;
@@ -3372,7 +3487,8 @@ declare type Player = HTMLVideoElement & PlayerEventOverloads & {
     /**
      * Adds a language to the project. See {@link https://developer.wowza.com/docs/wowza-flowplayer/player/translations/#using-npm| Official documentation}
      */
-    i18n(k: string, fallback?: string): string;
+    i18n(k: TranslationKey): string;
+    i18n(k: string, fallback: string): string;
     /* Excluded from this release type: deviceId */
     /* Excluded from this release type: live_state */
     /**
@@ -4223,6 +4339,15 @@ TOUCH_START = "touchstart";
 
 declare const TOUCHED = "is-touched";
 
+/**
+ * @public
+ * All possible full paths to each translation,  i.e. "core.mute"| "core.play" | "ads.ad" etc.
+ * This type is useful for developers using translation querying based on path, like in lodash's get()
+ */
+declare type TranslationKey = Paths<Translation, {
+    leavesOnly: true;
+}>;
+
 declare type TSampleRate = typeof SampleRate;
 
 declare const TV = "is-tv";