Feat: WebSocket Client

packages/timeline-state-resolver-types/src/__tests__/__snapshots__/index.spec.ts.snap

@@ -70,6 +70,7 @@ exports[`index imports 1`] = `
   "TimelineContentTypeTriCaster",
   "TimelineContentTypeVMix",
   "TimelineContentTypeVizMSE",
+  "TimelineContentTypeWebSocketTcpClient",
   "Transition",
   "TranslationsBundleType",
   "TransportStatus",
@@ -81,5 +82,6 @@ exports[`index imports 1`] = `
   "ViscaOverIPActions",
   "VizMSEActions",
   "VmixActions",
+  "WebsocketTcpClientActions",
 ]
 `;

packages/timeline-state-resolver-types/src/device.ts

@@ -23,6 +23,7 @@ import {
 	TriCasterOptions,
 	MultiOSCOptions,
 	ViscaOverIPOptions,
+	WebSocketTCPClientOptions,
 } from '.'
 import { DeviceCommonOptions } from './generated/common-options'
 
@@ -78,6 +79,7 @@ export type DeviceOptionsAny =
 	| DeviceOptionsTriCaster
 	| DeviceOptionsMultiOSC
 	| DeviceOptionsViscaOverIP
+	| DeviceOptionsWebSocketTcpClient
 
 export interface DeviceOptionsAbstract extends DeviceOptionsBase<AbstractOptions> {
 	type: DeviceType.ABSTRACT
@@ -148,3 +150,7 @@ export interface DeviceOptionsMultiOSC extends DeviceOptionsBase<MultiOSCOptions
 export interface DeviceOptionsViscaOverIP extends DeviceOptionsBase<ViscaOverIPOptions> {
 	type: DeviceType.VISCA_OVER_IP
 }
+
+export interface DeviceOptionsWebSocketTcpClient extends DeviceOptionsBase<WebSocketTCPClientOptions> {
+	type: DeviceType.WEBSOCKET_TCP_CLIENT
+}

packages/timeline-state-resolver-types/src/generated/index.ts

@@ -76,6 +76,9 @@ import { SomeMappingVizMSE } from './vizMSE'
 export * from './vmix'
 import { SomeMappingVmix } from './vmix'
 
+export * from './websocketTcpClient'
+import { SomeMappingWebsocketTcpClient } from './websocketTcpClient'
+
 export type TSRMappingOptions =
 	| SomeMappingAbstract
 	| SomeMappingAtem
@@ -100,3 +103,4 @@ export type TSRMappingOptions =
 	| SomeMappingViscaOverIP
 	| SomeMappingVizMSE
 	| SomeMappingVmix
+	| SomeMappingWebsocketTcpClient

packages/timeline-state-resolver-types/src/generated/websocketTcpClient.ts

@@ -0,0 +1,75 @@
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run "yarn generate-schema-types" to regenerate this file.
+ */
+import { ActionExecutionResult } from ".."
+
+export interface WebSocketTCPClientOptions {
+	webSocket: {
+		/**
+		 * URI to connect to, e.g. 'ws://localhost:8080'
+		 */
+		uri: string
+		/**
+		 * Interval between reconnection attempts in milliseconds
+		 */
+		reconnectInterval?: number
+		[k: string]: unknown
+	}
+	tcp: {
+		/**
+		 * Optional TCP server host to connect to, e.g. '127.0.0.1' - some devices may have a TCP connection too
+		 */
+		host: string
+		/**
+		 * TCP server port to connect to
+		 */
+		port: number
+		[k: string]: unknown
+	}
+}
+
+export type SomeMappingWebsocketTcpClient = Record<string, never>
+
+export interface SendWebSocketMessagePayload {
+	/**
+	 * Message to send over WebSocket
+	 */
+	message: string
+	/**
+	 * Optional queue ID for ordered message handling
+	 */
+	queueId?: string
+}
+
+export interface SendTcpMessagePayload {
+	/**
+	 * Message to send over TCP
+	 */
+	message: string
+	/**
+	 * Optional queue ID for ordered message handling
+	 */
+	queueId?: string
+}
+
+export enum WebsocketTcpClientActions {
+	Reconnect = 'reconnect',
+	ResetState = 'resetState',
+	SendWebSocketMessage = 'sendWebSocketMessage',
+	SendTcpMessage = 'sendTcpMessage'
+}
+export interface WebsocketTcpClientActionExecutionResults {
+	reconnect: () => void,
+	resetState: () => void,
+	sendWebSocketMessage: (payload: SendWebSocketMessagePayload) => void,
+	sendTcpMessage: (payload: SendTcpMessagePayload) => void
+}
+export type WebsocketTcpClientActionExecutionPayload<A extends keyof WebsocketTcpClientActionExecutionResults> = Parameters<
+	WebsocketTcpClientActionExecutionResults[A]
+>[0]
+
+export type WebsocketTcpClientActionExecutionResult<A extends keyof WebsocketTcpClientActionExecutionResults> =
+	ActionExecutionResult<ReturnType<WebsocketTcpClientActionExecutionResults[A]>>

packages/timeline-state-resolver-types/src/index.ts

@@ -23,6 +23,7 @@ import { TimelineContentSingularLiveAny } from './integrations/singularLive'
 import { TimelineContentVMixAny } from './integrations/vmix'
 import { TimelineContentOBSAny } from './integrations/obs'
 import { TimelineContentTriCasterAny } from './integrations/tricaster'
+import { TimelineContentWebSocketTcpClientAny } from './integrations/websocketTcpClient'
 
 export * from './integrations/abstract'
 export * from './integrations/atem'
@@ -46,6 +47,7 @@ export * from './integrations/tricaster'
 export * from './integrations/telemetrics'
 export * from './integrations/multiOsc'
 export * from './integrations/viscaOverIP'
+export * from './integrations/websocketTcpClient'
 
 export * from './device'
 export * from './mapping'
@@ -88,6 +90,7 @@ export enum DeviceType {
 	TRICASTER = 'TRICASTER',
 	MULTI_OSC = 'MULTI_OSC',
 	VISCA_OVER_IP = 'VISCA_OVER_IP',
+	WEBSOCKET_TCP_CLIENT = 'WEBSOCKET_TCP_CLIENT',
 }
 
 export interface TSRTimelineKeyframe<TContent> extends Omit<Timeline.TimelineKeyframe, 'content'> {
@@ -149,6 +152,7 @@ export type TSRTimelineContent =
 	| TimelineContentVIZMSEAny
 	| TimelineContentTelemetricsAny
 	| TimelineContentTriCasterAny
+	| TimelineContentWebSocketTcpClientAny
 
 /**
  * A simple key value store that can be referred to from the timeline objects

packages/timeline-state-resolver-types/src/integrations/websocketTcpClient.ts

@@ -0,0 +1,29 @@
+import { DeviceType } from '..'
+
+export enum TimelineContentTypeWebSocketTcpClient {
+	WEBSOCKET_MESSAGE = 'websocketMessage',
+	TCP_MESSAGE = 'tcpMessage',
+}
+
+export interface TimelineContentWebSocketTcpClientBase {
+	deviceType: DeviceType.WEBSOCKET_TCP_CLIENT
+	type: TimelineContentTypeWebSocketTcpClient
+}
+
+export interface TimelineContentWebSocketMessage extends TimelineContentWebSocketTcpClientBase {
+	type: TimelineContentTypeWebSocketTcpClient.WEBSOCKET_MESSAGE
+	/**  Stringified data to send over TCP */
+	message: string
+	/** If message contains stringified Base64 binary data or UTF-8 encoded string */
+	isBase64Encoded?: boolean
+}
+
+export interface TimelineContentTcpMessage extends TimelineContentWebSocketTcpClientBase {
+	type: TimelineContentTypeWebSocketTcpClient.TCP_MESSAGE
+	/**  Stringified data to send over TCP */
+	message: string
+	/** If message contains stringified Base64 binary data or UTF-8 encoded string */
+	isBase64Encoded?: boolean
+}
+
+export type TimelineContentWebSocketTcpClientAny = TimelineContentWebSocketMessage | TimelineContentTcpMessage

packages/timeline-state-resolver/src/__tests__/__snapshots__/index.spec.ts.snap

@@ -83,6 +83,7 @@ exports[`index imports 1`] = `
   "TimelineContentTypeTriCaster",
   "TimelineContentTypeVMix",
   "TimelineContentTypeVizMSE",
+  "TimelineContentTypeWebSocketTcpClient",
   "Transition",
   "TranslationsBundleType",
   "TransportStatus",
@@ -95,6 +96,7 @@ exports[`index imports 1`] = `
   "VizMSEActions",
   "VizMSEDevice",
   "VmixActions",
+  "WebsocketTcpClientActions",
   "manifest",
 ]
 `;

packages/timeline-state-resolver/src/conductor.ts

@@ -44,6 +44,7 @@ import {
 	DeviceOptionsViscaOverIP,
 	DeviceOptionsTriCaster,
 	DeviceOptionsSingularLive,
+	DeviceOptionsWebSocketTcpClient,
 } from 'timeline-state-resolver-types'
 
 import { DoOnTime } from './devices/doOnTime'
@@ -1218,6 +1219,7 @@ export type DeviceOptionsAnyInternal =
 	| DeviceOptionsTelemetrics
 	| DeviceOptionsTriCaster
 	| DeviceOptionsViscaOverIP
+	| DeviceOptionsWebSocketTcpClient
 
 function removeParentFromState(
 	o: Timeline.TimelineState<TSRTimelineContent>

packages/timeline-state-resolver/src/integrations/websocketTcpClient/$schemas/actions.json

@@ -0,0 +1,59 @@
+{
+    "$schema": "../../../$schemas/action-schema.json",
+    "actions": [
+      {
+        "id": "reconnect",
+        "name": "Reconnect device",
+        "destructive": true,
+        "timeout": 5000
+      },
+      {
+        "id": "resetState",
+        "name": "Reset state",
+        "destructive": true,
+        "timeout": 5000
+      },
+      {
+        "id": "sendWebSocketMessage",
+        "name": "Send WebSocket message",
+        "destructive": false,
+        "timeout": 5000,
+        "payload": {
+          "type": "object",
+          "properties": {
+            "message": {
+              "type": "string",
+              "description": "Message to send over WebSocket"
+            },
+            "queueId": {
+              "type": "string",
+              "description": "Optional queue ID for ordered message handling"
+            }
+          },
+          "required": ["message"],
+          "additionalProperties": false
+        }
+      },
+      {
+        "id": "sendTcpMessage", 
+        "name": "Send TCP Message",
+        "destructive": false,
+        "timeout": 5000,
+        "payload": {
+          "type": "object",
+          "properties": {
+            "message": {
+              "type": "string",
+              "description": "Message to send over TCP"
+            },
+            "queueId": {
+              "type": "string",
+              "description": "Optional queue ID for ordered message handling"
+            }
+          },
+          "required": ["message"],
+          "additionalProperties": false
+        }
+      }
+    ]
+  }

packages/timeline-state-resolver/src/integrations/websocketTcpClient/$schemas/options.json

@@ -0,0 +1,43 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "title": "WebSocket & TCP Client Options",
+    "type": "object",
+    "properties": {
+      "webSocket": {
+        "type": "object",
+        "properties": {
+          "uri": {
+            "type": "string",
+            "ui:title": "WebSocket URI",
+            "ui:description": "URI to connect to, e.g. 'ws://localhost:8080'",
+            "description": "URI to connect to, e.g. 'ws://localhost:8080'"
+          },
+          "reconnectInterval": {
+            "type": "integer",
+            "ui:title": "Reconnect Interval",
+            "description": "Interval between reconnection attempts in milliseconds",
+            "default": 5000
+          }
+        },
+        "required": ["uri"]
+      },
+      "tcp": {
+        "type": "object", 
+        "properties": {
+          "host": {
+            "type": "string",
+            "ui:title": "Optional - TCP Host",
+            "description": "Optional TCP server host to connect to, e.g. '127.0.0.1' - some devices may have a TCP connection too"
+          },
+          "port": {
+            "type": "integer",
+            "ui:title": "TCP Port",
+            "description": "TCP server port to connect to"
+          }
+        },
+        "required": ["host", "port"]
+      }
+    },
+    "required": ["webSocket", "tcp"],
+    "additionalProperties": false
+  }