@clockworkdog/cogs-client 2.3.0 → 2.5.0

package/dist/helpers/urls.d.ts

@@ -1,12 +1,6 @@
-export declare const COGS_ASSETS_SERVER_PORT = 12094;
 export declare const COGS_SERVER_PORT = 12095;
 /**
- * @deprecated Use {@link CogsConnection#getAssetUrl} instead. Or pass a boolean to say if you want a
- * HTTP/2 asset URL or not.
+ * Get the URL of an asset hosted by the COGS server.
  */
 export declare function assetUrl(file: string): string;
-/**
- * Returns a URL for the asset. This is different based on if HTTP/2 is requested or not
- */
-export declare function assetUrl(file: string, useHttp2AssetsServer: boolean): string;
 export declare function preloadUrl(url: string): Promise<string>;

package/dist/helpers/urls.js

@@ -1,17 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.preloadUrl = exports.assetUrl = exports.COGS_SERVER_PORT = exports.COGS_ASSETS_SERVER_PORT = void 0;
-exports.COGS_ASSETS_SERVER_PORT = 12094;
+exports.preloadUrl = exports.assetUrl = exports.COGS_SERVER_PORT = void 0;
 exports.COGS_SERVER_PORT = 12095;
-function assetUrl(file, useHttp2AssetsServer) {
+/**
+ * Get the URL of an asset hosted by the COGS server.
+ */
+function assetUrl(file) {
     const location = typeof window !== 'undefined' ? window.location : undefined;
     const path = `/assets/${encodeURIComponent(file)}`;
-    if (useHttp2AssetsServer) {
-        return `https://${location === null || location === void 0 ? void 0 : location.hostname}:${exports.COGS_ASSETS_SERVER_PORT}${path}`;
-    }
-    else {
-        return `${location === null || location === void 0 ? void 0 : location.protocol}//${location === null || location === void 0 ? void 0 : location.hostname}:${exports.COGS_SERVER_PORT}${path}`;
-    }
+    return `${location === null || location === void 0 ? void 0 : location.protocol}//${location === null || location === void 0 ? void 0 : location.hostname}:${exports.COGS_SERVER_PORT}${path}`;
 }
 exports.assetUrl = assetUrl;
 async function preloadUrl(url) {

package/dist/index.d.ts

@@ -12,3 +12,4 @@ export { assetUrl } from './helpers/urls';
 export { preloadUrl } from './helpers/urls';
 export * from './types/CogsPluginManifest';
 export * as ManifestTypes from './types/ManifestTypes';
+export * from './DataStore';

package/dist/index.js

@@ -49,3 +49,4 @@ var urls_2 = require("./helpers/urls");
 Object.defineProperty(exports, "preloadUrl", { enumerable: true, get: function () { return urls_2.preloadUrl; } });
 __exportStar(require("./types/CogsPluginManifest"), exports);
 exports.ManifestTypes = __importStar(require("./types/ManifestTypes"));
+__exportStar(require("./DataStore"), exports);

package/dist/types/CogsClientMessage.d.ts

@@ -19,7 +19,12 @@ interface TextHintsUpdateMessage {
 interface CogsEnvironmentMessage {
     type: 'cogs_environment';
     cogsVersion: string;
-    http2AssetsServer: boolean;
+}
+export interface DataStoreItemsClientMessage {
+    type: 'data_store_items';
+    items: {
+        [key: string]: unknown;
+    };
 }
 export type Media = {
     type: 'audio';
@@ -89,5 +94,5 @@ type MediaClientMessage = {
     file: string;
     fit: MediaObjectFit;
 };
-export type CogsClientMessage<CustomConfig = {}> = ShowResetMessage | ShowPhaseMessage | AdjustableTimerUpdateMessage | TextHintsUpdateMessage | (MediaClientConfigMessage & CustomConfig) | CogsEnvironmentMessage | MediaClientMessage;
+export type CogsClientMessage<CustomConfig = {}> = ShowResetMessage | ShowPhaseMessage | AdjustableTimerUpdateMessage | TextHintsUpdateMessage | (MediaClientConfigMessage & CustomConfig) | CogsEnvironmentMessage | MediaClientMessage | DataStoreItemsClientMessage;
 export default CogsClientMessage;

package/dist/types/CogsPluginManifest.d.ts

@@ -120,6 +120,25 @@ export interface CogsPluginManifestJson {
         video?: true;
         images?: true;
     };
+    /**
+     * COGS-managed key/value data store settings
+     *
+     * Allows certain key/value pairs to be saved to disk in the project folder alongside the plugin.
+     * Any key that is not listed here can still be used.
+     */
+    store?: {
+        items?: {
+            [key: string]: {
+                /**
+                 * When `true` saves this key/value pair to the project folder when the value changes
+                 * and restores the value when the project is next loaded.
+                 *
+                 * **This option is only available for COGS plugins**, not for custom Media Master content.
+                 */
+                persistValue?: boolean;
+            };
+        };
+    };
 }
 /**
  * A readonly version of `PluginManifestJson`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clockworkdog/cogs-client",
-  "version": "v2.3.0",
+  "version": "v2.5.0",
   "main": "dist/index.js",
   "unpkg": "dist/browser/index.js",
   "scripts": {
@@ -31,7 +31,6 @@
   },
   "dependencies": {
     "@clockworkdog/media-stream-library-browser": "^11.1.1-fixes.6",
-    "compare-versions": "^6.1.0",
     "howler": "clockwork-dog/howler.js#fix-looping-clips",
     "reconnecting-websocket": "^4.4.0"
   },