@clockworkdog/cogs-client 1.5.2 → 1.5.5

package/dist/index.d.ts

@@ -9,3 +9,4 @@ export { default as CogsVideoPlayer } from './VideoPlayer';
 export * from './types/AudioState';
 export { assetUrl } from './helpers/urls';
 export { preloadUrl } from './helpers/urls';
+export * from './types/PluginManifestJson';

package/dist/index.js

@@ -29,3 +29,4 @@ var urls_1 = require("./helpers/urls");
 Object.defineProperty(exports, "assetUrl", { enumerable: true, get: function () { return urls_1.assetUrl; } });
 var urls_2 = require("./helpers/urls");
 Object.defineProperty(exports, "preloadUrl", { enumerable: true, get: function () { return urls_2.preloadUrl; } });
+__exportStar(require("./types/PluginManifestJson"), exports);

package/dist/types/PluginManifestJson.d.ts

@@ -0,0 +1,116 @@
+export declare type FontAwesomeIconId = string;
+export interface CogsValueTypeBase<Id extends string> {
+    type: Id;
+}
+export declare type CogsValueTypeString = CogsValueTypeBase<'string'>;
+export interface CogsValueTypeNumber extends CogsValueTypeBase<'number'> {
+    integer?: true;
+    min?: number;
+    max?: number;
+}
+export declare type CogsValueTypeBoolean = CogsValueTypeBase<'boolean'>;
+export interface CogsValueTypeOption<Options extends string[]> extends CogsValueTypeBase<'option'> {
+    options: Options;
+}
+export declare type CogsValueType = CogsValueTypeString | CogsValueTypeNumber | CogsValueTypeBoolean | CogsValueTypeOption<string[]>;
+export declare type CogsValueTypeStringWithDefault = CogsValueTypeString & {
+    default: string;
+};
+export declare type CogsValueTypeNumberWithDefault = CogsValueTypeNumber & {
+    default: number;
+};
+export declare type CogsValueTypeBooleanWithDefault = CogsValueTypeBoolean & {
+    default: boolean;
+};
+export declare type CogsValueTypeOptionWithDefault = CogsValueTypeOption<string[]> & {
+    default: string;
+};
+export declare type CogsValueTypeWithDefault = CogsValueTypeStringWithDefault | CogsValueTypeNumberWithDefault | CogsValueTypeBooleanWithDefault | CogsValueTypeOptionWithDefault;
+export declare type PluginManifestConfigJson = {
+    name: string;
+    value: CogsValueType | CogsValueTypeWithDefault;
+};
+export declare type PluginManifestEventJson = {
+    name: string;
+    value?: CogsValueType;
+};
+export declare type PluginManifestStateJson = {
+    name: string;
+    value: CogsValueTypeWithDefault;
+    writableFromCogs?: true;
+    writableFromClient?: true;
+};
+/**
+ * `cogs-plugin-manifest.json` is a JSON manifest file describing the content of a COGS plugin or COGS Media Master custom content.
+ *
+ *
+ * It should be saved in the root of a folder in the `plugins` or `client_content` folder in your COGS project
+ *
+ * The [COGS plugins directory](/plugins) contains a number of plugins you can use out of the box
+ */
+export interface PluginManifestJson {
+    /**
+     * e.g. `1.0.0`
+     */
+    version: `${number}` | `${number}.${number}` | `${number}.${number}.${number}`;
+    /**
+     * A short human-readable name
+     */
+    name: string;
+    /**
+     * The minimum COGS version required
+     *
+     * Follows semantic versioning with `semver`
+     * e.g. `4.12.0
+     */
+    minCogsVersion?: `${number}.${number}.${number}`;
+    /**
+     * A description that appears alongside `name` in the list of plugins, and in the [COGS plugins directory](/plugins)
+     */
+    description?: string;
+    /**
+     * A FontAwesome 5.X icon shown alongside `name`, in the COGS navigation bar, and in the [COGS plugins directory](/plugins)
+     */
+    icon?: FontAwesomeIconId;
+    /**
+     * The HTML entrypoint for the plugin
+     *
+     * Defaults to `/` which includes `/index.html`
+     */
+    indexPath?: string;
+    /**
+     * If set, shows a popup window to the user where you can show the HTML content of your plugin
+     *
+     * By default a window is not shown to the user
+     * The window can later be opened/closed from the Javascript running in the plugin
+     * Only valid for plugins, not for Media Master custom content
+     */
+    window?: {
+        width: number;
+        height: number;
+        /**
+         * Whether the window is initially visible
+         */
+        visible?: boolean;
+    };
+    config?: PluginManifestConfigJson[];
+    /**
+     * Events that trigger COGS behaviors or can trigger actions in this plugin
+     */
+    events?: {
+        fromCogs?: PluginManifestEventJson[];
+        toCogs?: PluginManifestEventJson[];
+    };
+    /**
+     * State that can be set by COGS behaviors
+     */
+    state?: PluginManifestStateJson[];
+    /**
+     * The types of COGS media actions supported
+     */
+    media?: {
+        audio?: true;
+        video?: true;
+        images?: true;
+    };
+}

package/dist/types/PluginManifestJson.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clockworkdog/cogs-client",
-  "version": "v1.5.2",
+  "version": "v1.5.5",
   "main": "dist/index.js",
   "unpkg": "dist/browser/index.js",
   "scripts": {