@clockworkdog/cogs-client 1.5.6 → 2.0.0-beta.1

package/dist/index.d.ts

@@ -1,7 +1,8 @@
 export { default as CogsConnection } from './CogsConnection';
+export * from './CogsConnection';
 export { default as CogsClientMessage } from './types/CogsClientMessage';
 export { default as MediaClipStateMessage } from './types/MediaClipStateMessage';
-export * from './types/valueTypes';
+export * from './types/ShowPhase';
 export { default as MediaObjectFit } from './types/MediaObjectFit';
 export { default as CogsAudioPlayer } from './AudioPlayer';
 export { default as CogsRtspStreamer, LIVE_VIDEO_PLAYBACK_RATE } from './RtspStreamer';

package/dist/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -16,7 +20,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.preloadUrl = exports.assetUrl = exports.CogsVideoPlayer = exports.LIVE_VIDEO_PLAYBACK_RATE = exports.CogsRtspStreamer = exports.CogsAudioPlayer = exports.CogsConnection = void 0;
 var CogsConnection_1 = require("./CogsConnection");
 Object.defineProperty(exports, "CogsConnection", { enumerable: true, get: function () { return __importDefault(CogsConnection_1).default; } });
-__exportStar(require("./types/valueTypes"), exports);
+__exportStar(require("./CogsConnection"), exports);
+__exportStar(require("./types/ShowPhase"), exports);
 var AudioPlayer_1 = require("./AudioPlayer");
 Object.defineProperty(exports, "CogsAudioPlayer", { enumerable: true, get: function () { return __importDefault(AudioPlayer_1).default; } });
 var RtspStreamer_1 = require("./RtspStreamer");

package/dist/types/AllMediaClipStatesMessage.d.ts

@@ -1,4 +1,4 @@
-export declare type MediaStatus = 'playing' | 'paused' | 'stopped';
+export type MediaStatus = 'playing' | 'paused' | 'stopped';
 export default interface AllMediaClipStatesMessage {
     mediaType: 'audio' | 'video';
     files: [string, MediaStatus][];

package/dist/types/AudioState.d.ts

@@ -1,4 +1,4 @@
-export declare type ActiveAudioClipState = {
+export type ActiveAudioClipState = {
     type: 'paused';
 } | {
     type: 'pause_requested';

package/dist/types/CogsClientMessage.d.ts

@@ -1,5 +1,5 @@
 import MediaObjectFit from './MediaObjectFit';
-import { ShowPhase } from './valueTypes';
+import ShowPhase from './ShowPhase';
 interface ShowResetMessage {
     type: 'show_reset';
 }
@@ -16,7 +16,7 @@ interface TextHintsUpdateMessage {
     type: 'text_hints_update';
     lastSentHint: string;
 }
-export declare type Media = {
+export type Media = {
     type: 'audio';
     preload: boolean;
 } | {
@@ -31,7 +31,7 @@ interface MediaClientConfigMessage {
         [path: string]: Media;
     };
 }
-declare type MediaClientMessage = {
+type MediaClientMessage = {
     type: 'audio_play';
     playId: string;
     file: string;
@@ -81,5 +81,5 @@ declare type MediaClientMessage = {
     file: string;
     fit: MediaObjectFit;
 };
-export declare type CogsClientMessage<CustomConfig = {}> = ShowResetMessage | ShowPhaseMessage | AdjustableTimerUpdateMessage | TextHintsUpdateMessage | (MediaClientConfigMessage & CustomConfig) | MediaClientMessage;
+export type CogsClientMessage<CustomConfig = {}> = ShowResetMessage | ShowPhaseMessage | AdjustableTimerUpdateMessage | TextHintsUpdateMessage | (MediaClientConfigMessage & CustomConfig) | MediaClientMessage;
 export default CogsClientMessage;

package/dist/types/ManifestTypes.d.ts

@@ -0,0 +1,33 @@
+import { CogsValueType, CogsValueTypeBoolean, CogsValueTypeNumber, CogsValueTypeOption, CogsValueTypeString, PluginManifestJson, PluginManifestJsonReadonly, PluginManifestStateJson } from './PluginManifestJson';
+import { DeepMutable, DistributeObject } from './utils';
+export type TypeFromCogsValueType<ValueType extends Pick<CogsValueType, 'type'> | undefined> = ValueType extends CogsValueTypeOption<string[]> ? ValueType['options'][number] : ValueType extends CogsValueTypeString ? Readonly<string> : ValueType extends CogsValueTypeNumber ? number : ValueType extends CogsValueTypeBoolean ? boolean : undefined;
+/**
+ * Allow readonly (i.e. `const`) versions of a manifest as well as a regular PluginManifestJson
+ */
+export type PluginManifest = PluginManifestJson | PluginManifestJsonReadonly;
+export type ConfigKey<Manifest extends Pick<PluginManifest, 'config'>> = NonNullable<Manifest['config']>[number]['name'];
+export type ConfigAsObject<Manifest extends Pick<PluginManifest, 'config'>> = DistributeObject<{
+    [Key in ConfigKey<Manifest>]: TypeFromCogsValueType<Extract<DeepMutable<NonNullable<Manifest['config']>[number]>, {
+        name: Key;
+    }>['value']>;
+}>;
+export type StateKey<Manifest extends Pick<PluginManifest, 'state'>, Constraints extends Partial<PluginManifestStateJson> = Record<never, never>> = Extract<DeepMutable<NonNullable<Manifest['state']>[number]>, Constraints>['name'];
+export type StateAsObject<Manifest extends Pick<PluginManifest, 'state'>, Constraints extends Partial<PluginManifestStateJson> = Record<never, never>> = DistributeObject<{
+    [Key in StateKey<Manifest, Constraints>]: TypeFromCogsValueType<Extract<DeepMutable<NonNullable<Manifest['state']>[number]>, {
+        name: Key;
+    }>['value']>;
+}>;
+export type EventFromCogsKey<Manifest extends PluginManifest> = NonNullable<NonNullable<Manifest['events']>['fromCogs']>[number]['name'];
+export type EventsFromCogs<Manifest extends PluginManifest> = NonNullable<NonNullable<Manifest['events']>['fromCogs']>[number];
+export type EventFromCogsAsObject<Manifest extends PluginManifest> = DistributeObject<{
+    [Key in EventFromCogsKey<Manifest>]: TypeFromCogsValueType<Extract<DeepMutable<EventsFromCogs<Manifest>>, {
+        name: Key;
+    }>['value']>;
+}>;
+export type EventToCogsKey<Manifest extends PluginManifest> = NonNullable<NonNullable<Manifest['events']>['toCogs']>[number]['name'];
+export type EventsToCogs<Manifest extends PluginManifest> = NonNullable<NonNullable<Manifest['events']>['toCogs']>[number];
+export type EventToCogsAsObject<Manifest extends PluginManifest> = DistributeObject<{
+    [Key in EventToCogsKey<Manifest>]: TypeFromCogsValueType<Extract<DeepMutable<EventsToCogs<Manifest>>, {
+        name: Key;
+    }>['value']>;
+}>;

package/dist/types/ManifestTypes.js

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

package/dist/types/MediaClipStateMessage.d.ts

@@ -1,4 +1,4 @@
-export declare type MediaStatus = 'playing' | 'paused' | 'stopped';
+export type MediaStatus = 'playing' | 'paused' | 'stopped';
 export default interface MediaClipStateMessage {
     playId: string;
     mediaType: 'audio' | 'video';

package/dist/types/MediaObjectFit.d.ts

@@ -1,2 +1,2 @@
-export declare type MediaObjectFit = 'contain' | 'cover' | 'none';
+export type MediaObjectFit = 'contain' | 'cover' | 'none';
 export default MediaObjectFit;

package/dist/types/PluginManifestJson.d.ts

@@ -1,40 +1,41 @@
-export declare type FontAwesomeIconId = string;
+import { DeepReadonly } from './utils';
+export type FontAwesomeIconId = string;
 export interface CogsValueTypeBase<Id extends string> {
     type: Id;
 }
-export declare type CogsValueTypeString = CogsValueTypeBase<'string'>;
+export type CogsValueTypeString = CogsValueTypeBase<'string'>;
 export interface CogsValueTypeNumber extends CogsValueTypeBase<'number'> {
     integer?: true;
     min?: number;
     max?: number;
 }
-export declare type CogsValueTypeBoolean = CogsValueTypeBase<'boolean'>;
+export 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 & {
+export type CogsValueType = CogsValueTypeString | CogsValueTypeNumber | CogsValueTypeBoolean | CogsValueTypeOption<string[]>;
+export type CogsValueTypeStringWithDefault = CogsValueTypeString & {
     default: string;
 };
-export declare type CogsValueTypeNumberWithDefault = CogsValueTypeNumber & {
+export type CogsValueTypeNumberWithDefault = CogsValueTypeNumber & {
     default: number;
 };
-export declare type CogsValueTypeBooleanWithDefault = CogsValueTypeBoolean & {
+export type CogsValueTypeBooleanWithDefault = CogsValueTypeBoolean & {
     default: boolean;
 };
-export declare type CogsValueTypeOptionWithDefault = CogsValueTypeOption<string[]> & {
+export type CogsValueTypeOptionWithDefault = CogsValueTypeOption<string[]> & {
     default: string;
 };
-export declare type CogsValueTypeWithDefault = CogsValueTypeStringWithDefault | CogsValueTypeNumberWithDefault | CogsValueTypeBooleanWithDefault | CogsValueTypeOptionWithDefault;
-export declare type PluginManifestConfigJson = {
+export type CogsValueTypeWithDefault = CogsValueTypeStringWithDefault | CogsValueTypeNumberWithDefault | CogsValueTypeBooleanWithDefault | CogsValueTypeOptionWithDefault;
+export type PluginManifestConfigJson = {
     name: string;
     value: CogsValueType | CogsValueTypeWithDefault;
 };
-export declare type PluginManifestEventJson = {
+export type PluginManifestEventJson = {
     name: string;
     value?: CogsValueType;
 };
-export declare type PluginManifestStateJson = {
+export type PluginManifestStateJson = {
     name: string;
     value: CogsValueTypeWithDefault;
     writableFromCogs?: true;
@@ -69,9 +70,15 @@ export interface PluginManifestJson {
      */
     description?: string;
     /**
-     * A FontAwesome 5.X icon shown alongside `name`, in the COGS navigation bar, and in the [COGS plugins directory](/plugins)
+     * An icon shown alongside `name`, in the COGS navigation bar, and in the [COGS plugins directory](/plugins)
+     *
+     * The icon can be either:
+     * - A FontAwesome 5 icon
+     * - The relative path to an image in your plugin folder (Requires COGS 4.13 or later)
+     *   - Must start with `./`
+     *   - Alpha channel is used as a mask
      */
-    icon?: FontAwesomeIconId;
+    icon?: string;
     /**
      * The HTML entrypoint for the plugin
      *
@@ -114,3 +121,9 @@ export interface PluginManifestJson {
         images?: true;
     };
 }
+/**
+ * A readonly version of `PluginManifestJson`
+ * to help editors and IDEs provide autocomplete and type checking
+ * with `@type {const}` enabled
+ */
+export type PluginManifestJsonReadonly = DeepReadonly<PluginManifestJson>;

package/dist/types/ShowPhase.d.ts

@@ -0,0 +1,7 @@
+declare enum ShowPhase {
+    Setup = "setup",
+    Preshow = "pre-show",
+    InProgress = "in progress",
+    Finished = "finished"
+}
+export default ShowPhase;

package/dist/types/{valueTypes.js → ShowPhase.js}

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ShowPhase = void 0;
 var ShowPhase;
 (function (ShowPhase) {
     ShowPhase["Setup"] = "setup";
     ShowPhase["Preshow"] = "pre-show";
     ShowPhase["InProgress"] = "in progress";
     ShowPhase["Finished"] = "finished";
-})(ShowPhase = exports.ShowPhase || (exports.ShowPhase = {}));
+})(ShowPhase || (ShowPhase = {}));
+exports.default = ShowPhase;

package/dist/types/VideoState.js

@@ -5,4 +5,4 @@ var ActiveVideoClipState;
 (function (ActiveVideoClipState) {
     ActiveVideoClipState["Paused"] = "paused";
     ActiveVideoClipState["Playing"] = "playing";
-})(ActiveVideoClipState = exports.ActiveVideoClipState || (exports.ActiveVideoClipState = {}));
+})(ActiveVideoClipState || (exports.ActiveVideoClipState = ActiveVideoClipState = {}));

package/dist/types/utils.d.ts

@@ -0,0 +1,9 @@
+export type DeepReadonly<T> = T extends unknown ? {
+    readonly [P in keyof T]: DeepReadonly<T[P]>;
+} : never;
+export type DeepMutable<T> = T extends unknown ? {
+    -readonly [P in keyof T]: DeepMutable<T[P]>;
+} : never;
+export type DistributeObject<T> = T extends Record<string | number | symbol, unknown> ? {
+    [K in keyof T]: T[K];
+} : T;

package/dist/types/utils.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.6",
+  "version": "v2.0.0-beta.1",
   "main": "dist/index.js",
   "unpkg": "dist/browser/index.js",
   "scripts": {
@@ -17,6 +17,7 @@
   "license": "MIT",
   "devDependencies": {
     "@types/howler": "2.2.7",
+    "@types/node": "^18.14.1",
     "@typescript-eslint/eslint-plugin": "^4.12.0",
     "@typescript-eslint/parser": "^4.12.0",
     "browserify": "^17.0.0",
@@ -24,7 +25,7 @@
     "eslint-config-prettier": "^7.1.0",
     "eslint-plugin-prettier": "^3.3.1",
     "prettier": "^2.2.1",
-    "typescript": "^4.1.3"
+    "typescript": "^5.1.6"
   },
   "dependencies": {
     "@clockworkdog/media-stream-library-browser": "^11.1.1-fixes.6",

package/dist/types/valueTypes.d.ts

@@ -1,18 +0,0 @@
-export declare type PortValue = string | number | boolean;
-export declare type ConfigValue = string | number | boolean;
-export declare type EventValue = string | number | boolean;
-export declare enum ShowPhase {
-    Setup = "setup",
-    Preshow = "pre-show",
-    InProgress = "in progress",
-    Finished = "finished"
-}
-export declare type EventKeyValue<TypeMap extends {
-    [key: string]: EventValue | null;
-}, Key extends keyof TypeMap = keyof TypeMap> = Key extends string ? TypeMap[Key] extends null ? {
-    key: Key;
-    value: undefined;
-} : {
-    key: Key;
-    value: TypeMap[Key];
-} : never;