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

package/dist/index.d.ts

@@ -2,7 +2,7 @@ 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/ShowPhase';
+export { default as ShowPhase } 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';
@@ -10,4 +10,5 @@ export { default as CogsVideoPlayer } from './VideoPlayer';
 export * from './types/AudioState';
 export { assetUrl } from './helpers/urls';
 export { preloadUrl } from './helpers/urls';
-export * from './types/PluginManifestJson';
+export * from './types/CogsPluginManifestJson';
+export * as ManifestTypes from './types/ManifestTypes';

package/dist/index.js

@@ -10,18 +10,31 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 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;
+exports.ManifestTypes = exports.preloadUrl = exports.assetUrl = exports.CogsVideoPlayer = exports.LIVE_VIDEO_PLAYBACK_RATE = exports.CogsRtspStreamer = exports.CogsAudioPlayer = exports.ShowPhase = exports.CogsConnection = void 0;
 var CogsConnection_1 = require("./CogsConnection");
 Object.defineProperty(exports, "CogsConnection", { enumerable: true, get: function () { return __importDefault(CogsConnection_1).default; } });
 __exportStar(require("./CogsConnection"), exports);
-__exportStar(require("./types/ShowPhase"), exports);
+var ShowPhase_1 = require("./types/ShowPhase");
+Object.defineProperty(exports, "ShowPhase", { enumerable: true, get: function () { return __importDefault(ShowPhase_1).default; } });
 var AudioPlayer_1 = require("./AudioPlayer");
 Object.defineProperty(exports, "CogsAudioPlayer", { enumerable: true, get: function () { return __importDefault(AudioPlayer_1).default; } });
 var RtspStreamer_1 = require("./RtspStreamer");
@@ -34,4 +47,5 @@ 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);
+__exportStar(require("./types/CogsPluginManifestJson"), exports);
+exports.ManifestTypes = __importStar(require("./types/ManifestTypes"));

package/dist/types/{PluginManifestJson.d.ts → CogsPluginManifestJson.d.ts}

@@ -49,7 +49,7 @@ export type PluginManifestStateJson = {
  *
  * The [COGS plugins directory](/plugins) contains a number of plugins you can use out of the box
  */
-export interface PluginManifestJson {
+export interface CogsPluginManifestJson {
     /**
      * e.g. `1.0.0`
      */
@@ -126,4 +126,8 @@ export interface PluginManifestJson {
  * to help editors and IDEs provide autocomplete and type checking
  * with `@type {const}` enabled
  */
-export type PluginManifestJsonReadonly = DeepReadonly<PluginManifestJson>;
+export type CogsPluginManifestJsonReadonly = DeepReadonly<CogsPluginManifestJson>;
+/**
+ * Allow readonly (i.e. `const`) versions of a manifest as well as a regular PluginManifestJson
+ */
+export type CogsPluginManifest = CogsPluginManifestJson | CogsPluginManifestJsonReadonly;

package/dist/types/ManifestTypes.d.ts

@@ -1,33 +1,30 @@
-import { CogsValueType, CogsValueTypeBoolean, CogsValueTypeNumber, CogsValueTypeOption, CogsValueTypeString, PluginManifestJson, PluginManifestJsonReadonly, PluginManifestStateJson } from './PluginManifestJson';
+import { CogsValueType, CogsValueTypeBoolean, CogsValueTypeNumber, CogsValueTypeOption, CogsValueTypeString, CogsPluginManifest, PluginManifestStateJson } from './CogsPluginManifestJson';
 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;
+export type ConfigName<Manifest extends Pick<CogsPluginManifest, 'config'>> = NonNullable<Manifest['config']>[number]['name'];
+export type ConfigAsObject<Manifest extends Pick<CogsPluginManifest, 'config'>> = DistributeObject<{
+    [Name in ConfigName<Manifest>]: TypeFromCogsValueType<Extract<DeepMutable<NonNullable<Manifest['config']>[number]>, {
+        name: Name;
     }>['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 StateName<Manifest extends Pick<CogsPluginManifest, 'state'>, Constraints extends Partial<PluginManifestStateJson> = Record<never, never>> = Extract<DeepMutable<NonNullable<Manifest['state']>[number]>, Constraints>['name'];
+export type StateValue<Manifest extends Pick<CogsPluginManifest, 'state'>, Name extends StateName<Manifest>> = TypeFromCogsValueType<Extract<DeepMutable<NonNullable<Manifest['state']>[number]>, {
+    name: Name;
+}>['value']>;
+export type StateAsObject<Manifest extends Pick<CogsPluginManifest, 'state'>, Constraints extends Partial<PluginManifestStateJson> = Record<never, never>> = DistributeObject<{
+    [Name in StateName<Manifest, Constraints>]: StateValue<Manifest, Name>;
 }>;
-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;
+export type EventNameFromCogs<Manifest extends CogsPluginManifest> = NonNullable<NonNullable<Manifest['events']>['fromCogs']>[number]['name'];
+export type EventFromCogs<Manifest extends CogsPluginManifest> = NonNullable<NonNullable<Manifest['events']>['fromCogs']>[number];
+export type EventFromCogsAsObject<Manifest extends CogsPluginManifest> = DistributeObject<{
+    [Name in EventNameFromCogs<Manifest>]: TypeFromCogsValueType<Extract<DeepMutable<EventFromCogs<Manifest>>, {
+        name: Name;
     }>['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;
+export type EventNameToCogs<Manifest extends CogsPluginManifest> = NonNullable<NonNullable<Manifest['events']>['toCogs']>[number]['name'];
+export type EventToCogs<Manifest extends CogsPluginManifest> = NonNullable<NonNullable<Manifest['events']>['toCogs']>[number];
+export type EventToCogsAsObject<Manifest extends CogsPluginManifest> = DistributeObject<{
+    [Name in EventNameToCogs<Manifest>]: TypeFromCogsValueType<Extract<DeepMutable<EventToCogs<Manifest>>, {
+        name: Name;
     }>['value']>;
 }>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clockworkdog/cogs-client",
-  "version": "v2.0.0-beta.1",
+  "version": "v2.0.0-beta.2",
   "main": "dist/index.js",
   "unpkg": "dist/browser/index.js",
   "scripts": {