refactor: WS (#1622)

* refactor: WS

* refactor refetch

extract refetch keys to package/types

auto invalidata all keys

use refetch keys for project data

no need for constant update of info, just fetch when looking at it

split refetch and query keys

rename types

* refactor viewSettings

* fixup! refactor: WS

* rearange files and make types for api calls

* cleanup viewsettings

* switch exhaustiveCheck

* combine send socket function

* exhaustive check

* rename type to tag

* fixup! fixup! refactor: WS

* remove custom etag solution

* get errors from socket

* lint

* small change

---------

Co-authored-by: Carlos Valente <carlosvalente@pm.me>

packages/types/src/api/websocket/api.type.ts

@@ -0,0 +1,15 @@
+export type ApiAction =
+  | 'version'
+  | 'poll'
+  | 'change'
+  | 'message'
+  | 'start'
+  | 'pause'
+  | 'stop'
+  | 'reload'
+  | 'roll'
+  | 'load'
+  | 'addtime'
+  | 'auxtimer'
+  | 'client'
+  | 'offsetmode';

packages/types/src/api/websocket/data.type.ts

@@ -0,0 +1,63 @@
+import type { Client } from '../../definitions/Clients.type.js';
+import type { Log } from '../../definitions/runtime/Logger.type.js';
+import type { RuntimeStore } from '../../definitions/runtime/RuntimeStore.type.js';
+import type { MaybeNumber } from '../../utils/utils.type.js';
+import type { RefetchKey } from './refetch.type.js';
+
+export enum MessageTag {
+  Ping = 'ping',
+  Pong = 'pong',
+  ClientInit = 'client-init',
+  ClientSet = 'client-set',
+  ClientSetPath = 'client-set-path',
+  ClientRename = 'client-rename',
+  ClientRedirect = 'client-redirect',
+  ClientList = 'client-list',
+  Dialog = 'dialog',
+  Log = 'log',
+  RuntimeData = 'runtime-data',
+  RuntimePatch = 'runtime-patch',
+  Refetch = 'refetch',
+}
+
+//CLIENT TO SERVER
+type PingPacket = { tag: MessageTag.Ping; payload: Date };
+type SetClientPacket = { tag: MessageTag.ClientSetPath; payload: string };
+type SetClientPathPacket = { tag: MessageTag.ClientSet; payload: Partial<Client> };
+
+// SERVER TO CLIENT
+type PongPacket = { tag: MessageTag.Pong; payload: Date };
+type InitClientPacket = { tag: MessageTag.ClientInit; payload: { clientId: string; clientName: string } };
+type RenameClientPacket = { tag: MessageTag.ClientRename; payload: { target: string; name: string } };
+type RedirectClientPacket = { tag: MessageTag.ClientRedirect; payload: { target: string; path: string } };
+type DialogPacket = { tag: MessageTag.Dialog; payload: { dialog: string } };
+type ListClientPacket = {
+  tag: MessageTag.ClientList;
+  payload: Record<string, Client>;
+};
+type RuntimePacket = { tag: MessageTag.RuntimeData; payload: RuntimeStore };
+type RuntimePatchPacket = { tag: MessageTag.RuntimePatch; payload: Partial<RuntimeStore> };
+
+type RefetchPacket = {
+  tag: MessageTag.Refetch;
+  payload: {
+    target: RefetchKey;
+    revision: MaybeNumber;
+  };
+};
+
+// SHARED
+type LogPacket = { tag: MessageTag.Log; payload: Log };
+
+export type WsPacketToServer = PingPacket | SetClientPacket | SetClientPathPacket | LogPacket;
+export type WsPacketToClient =
+  | PongPacket
+  | InitClientPacket
+  | RenameClientPacket
+  | RedirectClientPacket
+  | DialogPacket
+  | LogPacket
+  | ListClientPacket
+  | RuntimePacket
+  | RuntimePatchPacket
+  | RefetchPacket;

packages/types/src/api/websocket/refetch.type.ts

@@ -0,0 +1,6 @@
+export enum RefetchKey {
+  All = 'all',
+  Report = 'report',
+  Rundown = 'rundown',
+  ViewSettings = 'view-settings',
+}

packages/types/src/index.ts

@@ -85,6 +85,11 @@ export type {
   TransientEventPayload,
 } from './api/rundown-controller/BackendResponse.type.js';
 
+// web socket
+export { MessageTag } from './api/websocket/data.type.js';
+export type { WsPacketToServer, WsPacketToClient } from './api/websocket/data.type.js';
+export { RefetchKey } from './api/websocket/refetch.type.js';
+export type { ApiAction } from './api/websocket/api.type.js';
 // SERVER RUNTIME
 export { type Log, LogLevel, type LogMessage, LogOrigin } from './definitions/runtime/Logger.type.js';
 export { Playback } from './definitions/runtime/Playback.type.js';