@clockworkdog/cogs-client 2.4.0 → 2.7.0

package/README.md

@@ -2,7 +2,7 @@
 
 Create content for your COGS Media Master
 
-## [Documentation](https://clockwork-dog.github.io/cogs-client-lib/)
+## [Documentation](https://clockwork-dog.github.io/cogs-sdk/javascript/)
 
 ## Add to your project
 
@@ -32,7 +32,7 @@ yarn add @clockworkdog/cogs-client
 
 ### Create a `cogs-plugin-manifest.js` file
 
-See [PluginManifestJson](https://clockwork-dog.github.io/cogs-client-lib/interfaces/PluginManifestJson.html) for details of what to include.
+See [CogsPluginManifestJson](https://clockwork-dog.github.io/cogs-sdk/javascript/interfaces/CogsPluginManifestJson.html) for details of what to include.
 
 If using Typescript set `"allowJs": true` in your `tsconfig.json`.
 
@@ -107,7 +107,7 @@ import { CogsConnection, CogsAudioPlayer } from '@clockworkdog/cogs-client';
 
 ### Connect to COGS
 
-Initialize a [CogsConnection](https://clockwork-dog.github.io/cogs-client-lib/interfaces/CogsConnection.html) with the manifest you created above.
+Initialize a [CogsConnection](https://clockwork-dog.github.io/cogs-sdk/javascript/classes/CogsConnection.html) with the manifest you created above.
 
 ```ts
 let connected = false;
@@ -152,14 +152,14 @@ You can save arbitrary data to COGS which will be restored when reconnecting wit
 ```ts
 const cogsConnection = new CogsConnection(manifest, {
   // Initial items in the store
-  'my-key': { foo: 0, bar: '' }
+  'my-key': { foo: 0, bar: '' },
 });
 
 // Update the store
 cogsConnection.store.setItems({ 'my-key': { foo: 1, bar: 'two' } });
 
 // Get item from data store
-cogsConnection.store.items.getItem('my-key')
+cogsConnection.store.items.getItem('my-key');
 
 // Listen for data changes
 cogsConnection.store.addEventListener('item', ({ key, value }) => {
@@ -182,7 +182,7 @@ Add `audio` to `cogs-plugin-manifest.js`:
 }
 ```
 
-Add [CogsAudioPlayer](https://clockwork-dog.github.io/cogs-client-lib/classes/CogsAudioPlayer.html) to your page:
+Add [CogsAudioPlayer](https://clockwork-dog.github.io/cogs-sdk/javascript/classes/CogsAudioPlayer.html) to your page:
 
 ```ts
 const audioPlayer = new CogsAudioPlayer(cogsConnection);

package/dist/AudioPlayer.js

@@ -5,6 +5,7 @@ const DEBUG = false;
 // Check an iOS-only property (See https://developer.mozilla.org/en-US/docs/Web/API/Navigator#non-standard_properties)
 const IS_IOS = typeof navigator.standalone !== 'undefined';
 class AudioPlayer {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     constructor(cogsConnection) {
         this.cogsConnection = cogsConnection;
         this.eventTarget = new EventTarget();

package/dist/CogsConnection.d.ts

@@ -20,14 +20,6 @@ export default class CogsConnection<Manifest extends CogsPluginManifest, DataT e
     get showPhase(): ShowPhase;
     private _timerState;
     get timerState(): TimerState | null;
-    /**
-     * Track the support for HTTP/2 assets on the client and server side
-     * Client side is dictated by the environment we're connecting from (and the media cogs-av-box version)
-     * Server side is dictated by the COGS version which added the HTTP/2 assets server itself
-     */
-    private clientSupportsHttp2Assets;
-    private serverSupportsHttp2Assets;
-    get supportsHttp2Assets(): boolean;
     /**
      * Return asset URLs using the information about the client and server support for HTTP/2
      */

package/dist/CogsConnection.js

@@ -4,7 +4,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CogsIncomingEvent = exports.CogsStateChangedEvent = exports.CogsConfigChangedEvent = exports.CogsMessageEvent = exports.CogsConnectionCloseEvent = exports.CogsConnectionOpenEvent = void 0;
-const compare_versions_1 = require("compare-versions");
 const ShowPhase_1 = __importDefault(require("./types/ShowPhase"));
 const reconnecting_websocket_1 = __importDefault(require("reconnecting-websocket"));
 const urls_1 = require("./helpers/urls");
@@ -22,15 +21,12 @@ class CogsConnection {
     get timerState() {
         return this._timerState ? { ...this._timerState } : null;
     }
-    get supportsHttp2Assets() {
-        return this.clientSupportsHttp2Assets && this.serverSupportsHttp2Assets;
-    }
     /**
      * Return asset URLs using the information about the client and server support for HTTP/2
      */
     getAssetUrl(path) {
         var _a, _b;
-        return `${(0, urls_1.assetUrl)(path, this.supportsHttp2Assets)}?${(_b = (_a = this.urlParams) === null || _a === void 0 ? void 0 : _a.toString()) !== null && _b !== void 0 ? _b : ''}`;
+        return `${(0, urls_1.assetUrl)(path)}?${(_b = (_a = this.urlParams) === null || _a === void 0 ? void 0 : _a.toString()) !== null && _b !== void 0 ? _b : ''}`;
     }
     get selectedAudioOutput() {
         return this._selectedAudioOutput;
@@ -43,13 +39,6 @@ class CogsConnection {
         this.currentState = {}; // Received on open connection - TODO: set initial state from manifest?
         this._showPhase = ShowPhase_1.default.Setup;
         this._timerState = null;
-        /**
-         * Track the support for HTTP/2 assets on the client and server side
-         * Client side is dictated by the environment we're connecting from (and the media cogs-av-box version)
-         * Server side is dictated by the COGS version which added the HTTP/2 assets server itself
-         */
-        this.clientSupportsHttp2Assets = false;
-        this.serverSupportsHttp2Assets = false;
         /**
          * Cached audio outputs use to look up the device/sink ID when a different device label is requested
          */
@@ -57,7 +46,7 @@ class CogsConnection {
         this._selectedAudioOutput = '';
         this.currentState = { ...initialClientState };
         this.store = new DataStore_1.default(initialDataStoreData !== null && initialDataStoreData !== void 0 ? initialDataStoreData : {});
-        const { useReconnectingWebsocket, path, pathParams, supportsHttp2Assets } = websocketParametersFromUrl(document.location.href);
+        const { useReconnectingWebsocket, path, pathParams } = websocketParametersFromUrl(document.location.href);
         // Store the URL parameters for use in asset URLs
         // and add screen dimensions which COGS can use to determine the best asset quality to serve
         //
@@ -69,13 +58,9 @@ class CogsConnection {
         this.urlParams.set('screenPixelRatio', window.devicePixelRatio.toString());
         const socketUrl = `ws://${hostname}:${port}${path}?${this.urlParams}`;
         this.websocket = useReconnectingWebsocket ? new reconnecting_websocket_1.default(socketUrl) : new WebSocket(socketUrl);
-        this.clientSupportsHttp2Assets = !!supportsHttp2Assets;
         this.websocket.onopen = () => {
             this.currentConfig = {}; // Received on open connection
             this.currentState = {}; // Received on open connection
-            // Reset this flag as we might have just connected to an old COGS version which doesn't support HTTP/2
-            // The flag will be set when COGS sends a "cogs_environment" message
-            this.serverSupportsHttp2Assets = false;
             this.dispatchEvent(new CogsConnectionOpenEvent());
             this.setState(this.currentState); // TODO: Remove this because you should set it manually...??
         };
@@ -110,9 +95,6 @@ class CogsConnection {
                             case 'show_phase':
                                 this._showPhase = message.phase;
                                 break;
-                            case 'cogs_environment':
-                                this.serverSupportsHttp2Assets = message.http2AssetsServer;
-                                break;
                             case 'media_config_update':
                                 for (const optionName of ['preferOptimizedAudio', 'preferOptimizedVideo', 'preferOptimizedImages']) {
                                     const optionEnabled = message[optionName];
@@ -227,66 +209,52 @@ class CogsConnection {
 }
 exports.default = CogsConnection;
 function websocketParametersFromUrl(url) {
-    var _a, _b, _c, _d, _e, _f, _g, _h;
+    var _a, _b, _c, _d, _e;
     const parsedUrl = new URL(url);
     const pathParams = new URLSearchParams(parsedUrl.searchParams);
     const localClientId = pathParams.get('local_id');
     const isSimulator = pathParams.get('simulator') === 'true';
     const display = (_a = pathParams.get('display')) !== null && _a !== void 0 ? _a : '';
     const pluginId = parsedUrl.pathname.startsWith('/plugin/') ? decodeURIComponent(parsedUrl.pathname.split('/')[2]) : undefined;
-    // Allow explicitly disabling HTTP/2 assets. This is useful in situations where we know the self-signed certificate cannot be
-    // supported such as the native mobile app
-    const disableHttp2Assets = ((_b = pathParams.get('http2Assets')) !== null && _b !== void 0 ? _b : '') === 'false';
     if (localClientId) {
-        const type = (_c = pathParams.get('t')) !== null && _c !== void 0 ? _c : '';
+        const type = (_b = pathParams.get('t')) !== null && _b !== void 0 ? _b : '';
         pathParams.delete('local_id');
         return {
             path: `/local/${encodeURIComponent(localClientId)}`,
             pathParams: new URLSearchParams({ t: type }),
             useReconnectingWebsocket: true,
-            supportsHttp2Assets: !disableHttp2Assets,
         };
     }
     else if (isSimulator) {
-        const supportsHttp2Assets = ((_d = pathParams.get('http2Assets')) !== null && _d !== void 0 ? _d : '') === 'true';
-        pathParams.delete('http2Assets');
-        const name = (_e = pathParams.get('name')) !== null && _e !== void 0 ? _e : '';
+        const name = (_c = pathParams.get('name')) !== null && _c !== void 0 ? _c : '';
         pathParams.delete('simulator');
         pathParams.delete('name');
         return {
             path: `/simulator/${encodeURIComponent(name)}`,
             pathParams,
             useReconnectingWebsocket: true,
-            supportsHttp2Assets: !disableHttp2Assets && supportsHttp2Assets,
         };
     }
     else if (display) {
-        const displayIdIndex = (_f = pathParams.get('displayIdIndex')) !== null && _f !== void 0 ? _f : '';
+        const displayIdIndex = (_d = pathParams.get('displayIdIndex')) !== null && _d !== void 0 ? _d : '';
         pathParams.delete('display');
         pathParams.delete('displayIdIndex');
         return {
             path: `/display/${encodeURIComponent(display)}/${encodeURIComponent(displayIdIndex)}`,
-            supportsHttp2Assets: !disableHttp2Assets,
         };
     }
     else if (pluginId) {
         return {
             path: `/plugin/${encodeURIComponent(pluginId)}`,
             useReconnectingWebsocket: true,
-            supportsHttp2Assets: !disableHttp2Assets,
         };
     }
     else {
-        const serial = (_g = pathParams.get('serial')) !== null && _g !== void 0 ? _g : '';
+        const serial = (_e = pathParams.get('serial')) !== null && _e !== void 0 ? _e : '';
         pathParams.delete('serial');
-        // Check if cogs-box-av is a version which added support for ignoring HTTP/2 self-signed certificates
-        const firmwareVersion = ((_h = pathParams.get('f')) !== null && _h !== void 0 ? _h : '').replace(/^v/, '');
-        const isCogsBoxAvDevBuild = firmwareVersion === '0.0.0'; // We assume dev firmware builds have HTTP/2 assets support - Added in 2024-03
-        const supportsHttp2Assets = isCogsBoxAvDevBuild || ((0, compare_versions_1.validate)(firmwareVersion) && (0, compare_versions_1.satisfies)(firmwareVersion, '>=4.9.0'));
         return {
             path: `/client/${encodeURIComponent(serial)}`,
             pathParams,
-            supportsHttp2Assets: !disableHttp2Assets && supportsHttp2Assets,
         };
     }
 }

package/dist/VideoPlayer.js

@@ -3,7 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const VideoState_1 = require("./types/VideoState");
 const DEFAULT_PARENT_ELEMENT = document.body;
 class VideoPlayer {
-    constructor(cogsConnection, parentElement = DEFAULT_PARENT_ELEMENT) {
+    constructor(
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    cogsConnection, parentElement = DEFAULT_PARENT_ELEMENT) {
         this.cogsConnection = cogsConnection;
         this.eventTarget = new EventTarget();
         this.globalVolume = 1;
@@ -262,7 +264,7 @@ class VideoPlayer {
                     loop: (_d = (_c = this.videoClipPlayers[this.activeClip.path].videoElement) === null || _c === void 0 ? void 0 : _c.loop) !== null && _d !== void 0 ? _d : false,
                     volume: ((_e = this.videoClipPlayers[this.activeClip.path].videoElement) === null || _e === void 0 ? void 0 : _e.muted)
                         ? 0
-                        : (_g = (_f = this.videoClipPlayers[this.activeClip.path].videoElement) === null || _f === void 0 ? void 0 : _f.volume) !== null && _g !== void 0 ? _g : 0,
+                        : ((_g = (_f = this.videoClipPlayers[this.activeClip.path].videoElement) === null || _f === void 0 ? void 0 : _f.volume) !== null && _g !== void 0 ? _g : 0),
                 }
                 : undefined,
         };