@rest-vir/define-service 0.3.0 → 0.3.2

package/dist/frontend-connect/generate-api.d.ts

@@ -24,7 +24,7 @@ export type RestVirApi<SpecificService extends ServiceDefinition> = {
     webSockets: {
         [WebSocketPath in keyof SpecificService['webSockets']]: SpecificService['webSockets'][WebSocketPath] extends WebSocketDefinition ? SpecificService['webSockets'][WebSocketPath] & {
             /** Connect to this WebSocket. */
-            connect(...params: CollapsedConnectWebSocketParams<SpecificService['webSockets'][WebSocketPath], false, globalThis.WebSocket>): Promise<ClientWebSocket<SpecificService['webSockets'][WebSocketPath], globalThis.WebSocket>>;
+            connect(...params: CollapsedConnectWebSocketParams<SpecificService['webSockets'][WebSocketPath], false>): Promise<ClientWebSocket<SpecificService['webSockets'][WebSocketPath]>>;
         } : never;
     };
 };

package/dist/web-socket/overwrite-web-socket-methods.d.ts

@@ -89,6 +89,23 @@ export type CollapsedSendAndWaitForReplyParams<Location extends WebSocketLocatio
     MessageFromClientType: true;
     MessageFromHostType: true;
 }>> | NoParam = NoParam> = HasRequiredKeys<SendAndWaitForReplyParams<Location, WebSocketToConnect>> extends true ? [SendAndWaitForReplyParams<Location, WebSocketToConnect>] : [SendAndWaitForReplyParams<Location, WebSocketToConnect>?];
+/**
+ * Narrows a {@link WebSocketDefinition} for use within {@link OverwriteWebSocketMethods}.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/define-service
+ * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
+ */
+export type NarrowOriginalDefinition<OriginalWebSocketDefinition extends Readonly<SelectFrom<WebSocketDefinition, {
+    MessageFromClientType: true;
+    MessageFromHostType: true;
+    SearchParamsType: true;
+}>> | NoParam = NoParam> = OriginalWebSocketDefinition extends NoParam ? NoParam : Omit<OriginalWebSocketDefinition, 
+/**
+ * Omit connect so this is compatible with API WebSocket objects (which have a `connect`
+ * method).
+ */
+'connect'>;
 /**
  * Takes any WebSocket class and overwrites it with some new rest vir methods and makes some
  * existing WebSocket methods type safe.
@@ -111,7 +128,7 @@ export type OverwriteWebSocketMethods<WebSocketClass extends CommonWebSocket, Lo
      * Adds an event listener that's wrapped in assertions to verify that message events have
      * the expected contents.
      */
-    addEventListener<const EventName extends keyof CommonWebSocketEventMap>(eventName: EventName, listener: WebSocketListener<EventName, OriginalWebSocketDefinition, FlipWebSocketLocation<Location>, WebSocketClass>): void;
+    addEventListener<const EventName extends keyof CommonWebSocketEventMap>(eventName: EventName, listener: WebSocketListener<EventName, NarrowOriginalDefinition<OriginalWebSocketDefinition>, FlipWebSocketLocation<Location>, WebSocketClass>): void;
     /**
      * Sends a message to the other side of the WebSocket connection and waits that other side
      * to send a message in response.
@@ -119,7 +136,7 @@ export type OverwriteWebSocketMethods<WebSocketClass extends CommonWebSocket, Lo
      * This will catch messages that might not have been intended as a response for the original
      * message as it will catch _any_ message sent from the other side.
      */
-    sendAndWaitForReply(...params: CollapsedSendAndWaitForReplyParams<Location, OriginalWebSocketDefinition>): Promise<OriginalWebSocketDefinition extends NoParam ? any : GetWebSocketMessageTypeFromLocation<Exclude<OriginalWebSocketDefinition, NoParam>, FlipWebSocketLocation<Location>>>;
+    sendAndWaitForReply(...params: CollapsedSendAndWaitForReplyParams<Location, NarrowOriginalDefinition<OriginalWebSocketDefinition>>): Promise<NarrowOriginalDefinition<OriginalWebSocketDefinition> extends NoParam ? any : GetWebSocketMessageTypeFromLocation<Exclude<NarrowOriginalDefinition<OriginalWebSocketDefinition>, NoParam>, FlipWebSocketLocation<Location>>>;
     /**
      * Sends data through the WebSocket to the other side of the connection. This rest-vir
      * wrapper ensures that all sent messages match expected types from the WebSocket
@@ -128,10 +145,10 @@ export type OverwriteWebSocketMethods<WebSocketClass extends CommonWebSocket, Lo
      * See [MDN](https://developer.mozilla.org/docs/Web/API/WebSocket/send) for the original
      * `WebSocket.send()` docs.
      */
-    send(...args: OriginalWebSocketDefinition extends NoParam ? [message?: any] : GetWebSocketMessageTypeFromLocation<Exclude<OriginalWebSocketDefinition, NoParam>, Location> extends undefined ? [
-        message?: GetWebSocketMessageTypeFromLocation<Exclude<OriginalWebSocketDefinition, NoParam>, Location>
+    send(...args: NarrowOriginalDefinition<OriginalWebSocketDefinition> extends NoParam ? [message?: any] : GetWebSocketMessageTypeFromLocation<Exclude<NarrowOriginalDefinition<OriginalWebSocketDefinition>, NoParam>, Location> extends undefined ? [
+        message?: GetWebSocketMessageTypeFromLocation<Exclude<NarrowOriginalDefinition<OriginalWebSocketDefinition>, NoParam>, Location>
     ] : [
-        message: GetWebSocketMessageTypeFromLocation<Exclude<OriginalWebSocketDefinition, NoParam>, Location>
+        message: GetWebSocketMessageTypeFromLocation<Exclude<NarrowOriginalDefinition<OriginalWebSocketDefinition>, NoParam>, Location>
     ]): void;
 }>;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rest-vir/define-service",
-    "version": "0.3.0",
+    "version": "0.3.2",
     "description": "Define an connect to a declarative and type safe REST and WebSocket service.",
     "keywords": [
         "rest",