@clockworkdog/cogs-client 2.3.0 → 2.4.0

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

@@ -21,6 +21,12 @@ interface CogsEnvironmentMessage {
     cogsVersion: string;
     http2AssetsServer: boolean;
 }
+export interface DataStoreItemsClientMessage {
+    type: 'data_store_items';
+    items: {
+        [key: string]: unknown;
+    };
+}
 export type Media = {
     type: 'audio';
     preload: boolean;
@@ -89,5 +95,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.4.0",
   "main": "dist/index.js",
   "unpkg": "dist/browser/index.js",
   "scripts": {