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

package/dist/CogsConnection.d.ts

@@ -2,10 +2,10 @@ import ShowPhase from './types/ShowPhase';
 import CogsClientMessage from './types/CogsClientMessage';
 import MediaClipStateMessage from './types/MediaClipStateMessage';
 import AllMediaClipStatesMessage from './types/AllMediaClipStatesMessage';
-import { PluginManifestEventJson } from './types/PluginManifestJson';
+import { CogsPluginManifest, PluginManifestEventJson } from './types/CogsPluginManifestJson';
 import * as ManifestTypes from './types/ManifestTypes';
 import { DeepReadonly } from './types/utils';
-export default class CogsConnection<Manifest extends ManifestTypes.PluginManifest> {
+export default class CogsConnection<Manifest extends CogsPluginManifest> {
     readonly manifest: Manifest;
     private websocket;
     private eventTarget;
@@ -31,7 +31,7 @@ export default class CogsConnection<Manifest extends ManifestTypes.PluginManifes
     }>> | undefined);
     get isConnected(): boolean;
     close(): void;
-    sendEvent<EventName extends ManifestTypes.EventToCogsKey<Manifest>>(eventName: EventName, ...[eventValue]: ManifestTypes.EventToCogsAsObject<Manifest>[EventName] extends undefined ? [] : [ManifestTypes.EventToCogsAsObject<Manifest>[EventName]]): void;
+    sendEvent<EventName extends ManifestTypes.EventNameToCogs<Manifest>>(eventName: EventName, ...[eventValue]: ManifestTypes.EventToCogsAsObject<Manifest>[EventName] extends undefined ? [] : [ManifestTypes.EventToCogsAsObject<Manifest>[EventName]]): void;
     setState(values: Partial<ManifestTypes.StateAsObject<Manifest, {
         writableFromClient: true;
     }>>): void;
@@ -45,11 +45,11 @@ export default class CogsConnection<Manifest extends ManifestTypes.PluginManifes
      * This is only relevant for plugins, not for Media Master content.
      */
     setPluginWindowVisible(visible: boolean): void;
-    addEventListener<EventType extends CogsConnectionEvent<Manifest>['type']>(type: EventType, listener: (event: CogsConnectionEvent<Manifest> & {
-        type: EventType;
+    addEventListener<EventType extends CogsConnectionEvent<Manifest>['_cogsConnectionEventType']>(type: EventType, listener: (event: CogsConnectionEvent<Manifest> & {
+        _cogsConnectionEventType: EventType;
     }) => void, options?: boolean | AddEventListenerOptions): void;
-    removeEventListener<EventType extends CogsConnectionEvent<Manifest>['type']>(type: EventType, listener: (event: Extract<CogsConnectionEvent<Manifest>, {
-        type: EventType;
+    removeEventListener<EventType extends CogsConnectionEvent<Manifest>['_cogsConnectionEventType']>(type: EventType, listener: (event: Extract<CogsConnectionEvent<Manifest>, {
+        _cogsConnectionEventType: EventType;
     }>) => void, options?: boolean | EventListenerOptions): void;
     private dispatchEvent;
 }
@@ -59,36 +59,36 @@ export type TimerState = Omit<Extract<CogsClientMessage, {
     startedAt: number;
 };
 export declare class CogsConnectionOpenEvent extends Event {
-    readonly type = "open";
+    readonly _cogsConnectionEventType = "open";
     constructor();
 }
 export declare class CogsConnectionCloseEvent extends Event {
-    readonly type = "close";
+    readonly _cogsConnectionEventType = "close";
     constructor();
 }
 export declare class CogsMessageEvent extends Event {
     readonly message: CogsClientMessage;
-    readonly type = "message";
+    readonly _cogsConnectionEventType = "message";
     constructor(message: CogsClientMessage);
 }
 export declare class CogsConfigChangedEvent<CogsConfig> extends Event {
     readonly config: CogsConfig;
-    readonly type = "config";
+    readonly _cogsConnectionEventType = "config";
     constructor(config: CogsConfig);
 }
 export declare class CogsStateChangedEvent<CogsState> extends Event {
     readonly state: CogsState;
-    readonly type = "state";
+    readonly _cogsConnectionEventType = "state";
     constructor(state: CogsState);
 }
 export declare class CogsIncomingEvent<CogsEvent extends DeepReadonly<PluginManifestEventJson> | PluginManifestEventJson> extends Event {
     readonly name: CogsEvent['name'];
     readonly value: ManifestTypes.TypeFromCogsValueType<CogsEvent['value']>;
-    readonly type = "event";
+    readonly _cogsConnectionEventType = "event";
     constructor(name: CogsEvent['name'], value: ManifestTypes.TypeFromCogsValueType<CogsEvent['value']>);
 }
 /**
  * Allows CogsIncomingEvent of each supported value type
  */
 export type CogsIncomingEventTypes<CogsEvent extends DeepReadonly<PluginManifestEventJson> | PluginManifestEventJson> = CogsEvent extends unknown ? CogsIncomingEvent<CogsEvent> : never;
-export type CogsConnectionEvent<Manifest extends ManifestTypes.PluginManifest> = CogsConnectionOpenEvent | CogsConnectionCloseEvent | CogsMessageEvent | CogsConfigChangedEvent<ManifestTypes.ConfigAsObject<Manifest>> | CogsStateChangedEvent<Partial<ManifestTypes.StateAsObject<Manifest>>> | CogsIncomingEventTypes<ManifestTypes.EventsFromCogs<Manifest>>;
+export type CogsConnectionEvent<Manifest extends CogsPluginManifest> = CogsConnectionOpenEvent | CogsConnectionCloseEvent | CogsMessageEvent | CogsConfigChangedEvent<ManifestTypes.ConfigAsObject<Manifest>> | CogsStateChangedEvent<Partial<ManifestTypes.StateAsObject<Manifest>>> | CogsIncomingEventTypes<ManifestTypes.EventFromCogs<Manifest>>;

package/dist/CogsConnection.js

@@ -208,14 +208,14 @@ function websocketParametersFromUrl(url) {
 class CogsConnectionOpenEvent extends Event {
     constructor() {
         super('open');
-        this.type = 'open';
+        this._cogsConnectionEventType = 'open';
     }
 }
 exports.CogsConnectionOpenEvent = CogsConnectionOpenEvent;
 class CogsConnectionCloseEvent extends Event {
     constructor() {
         super('close');
-        this.type = 'close';
+        this._cogsConnectionEventType = 'close';
     }
 }
 exports.CogsConnectionCloseEvent = CogsConnectionCloseEvent;
@@ -223,7 +223,7 @@ class CogsMessageEvent extends Event {
     constructor(message) {
         super('message');
         this.message = message;
-        this.type = 'message';
+        this._cogsConnectionEventType = 'message';
     }
 }
 exports.CogsMessageEvent = CogsMessageEvent;
@@ -231,7 +231,7 @@ class CogsConfigChangedEvent extends Event {
     constructor(config) {
         super('config');
         this.config = config;
-        this.type = 'config';
+        this._cogsConnectionEventType = 'config';
     }
 }
 exports.CogsConfigChangedEvent = CogsConfigChangedEvent;
@@ -239,7 +239,7 @@ class CogsStateChangedEvent extends Event {
     constructor(state) {
         super('state');
         this.state = state;
-        this.type = 'state';
+        this._cogsConnectionEventType = 'state';
     }
 }
 exports.CogsStateChangedEvent = CogsStateChangedEvent;
@@ -248,7 +248,7 @@ class CogsIncomingEvent extends Event {
         super('event');
         this.name = name;
         this.value = value;
-        this.type = 'event';
+        this._cogsConnectionEventType = 'event';
     }
 }
 exports.CogsIncomingEvent = CogsIncomingEvent;