@foxglove/ws-protocol: Update to spec changes

foxglove · Nov 6, 2023 · 17d842f · 17d842f
1 parent bd960ad
commit 17d842f
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 4 deletions.
diff --git a/typescript/ws-protocol/src/FoxgloveServer.ts b/typescript/ws-protocol/src/FoxgloveServer.ts
@@ -22,6 +22,7 @@ import {
   ServiceCallPayload,
   ServiceCallRequest,
   ServiceId,
+  ServiceWithoutId,
   SubscriptionId,
 } from "./types";
 
@@ -187,7 +188,7 @@ export default class FoxgloveServer {
    * Advertise a new service and inform any connected clients.
    * @returns The id of the new service
    */
-  addService(service: Omit<Service, "id">): ServiceId {
+  addService(service: ServiceWithoutId): ServiceId {
     const newId = ++this.#nextServiceId;
     const newService: Service = { ...service, id: newId };
     this.#services.set(newId, newService);

diff --git a/typescript/ws-protocol/src/types.ts b/typescript/ws-protocol/src/types.ts
@@ -40,13 +40,27 @@ export type Channel = {
   schema: string;
   schemaEncoding?: string;
 };
-export type Service = {
+
+type ServiceRequest = {
+  encoding: string;
+  schemaName: string;
+  schemaEncoding: string;
+  schema: string;
+};
+type ServiceRequestDef =
+  | { requestSchema: string; request?: ServiceRequest }
+  | { requestSchema?: string; request: ServiceRequest };
+type ServiceResponse = ServiceRequest;
+type ServiceResponseDef =
+  | { responseSchema: string; response?: ServiceResponse }
+  | { responseSchema?: string; response: ServiceResponse };
+type ServiceBase = {
   id: number;
   name: string;
   type: string;
-  requestSchema: string;
-  responseSchema: string;
 };
+export type Service = ServiceBase & ServiceRequestDef & ServiceResponseDef;
+export type ServiceWithoutId = Omit<ServiceBase, "id"> & ServiceRequestDef & ServiceResponseDef;
 
 export type Subscribe = {
   op: "subscribe";