@rest-vir/define-service 0.2.0 → 0.3.1

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/frontend-connect/mock-client-web-socket.d.ts

@@ -78,7 +78,7 @@ export declare function createMockClientWebSocketConstructor<const WebSocketToCo
  * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
  */
 export type MockClientWebSocketListeners = Partial<{
-    [EventName in keyof CommonWebSocketEventMap]: Set<(event: CommonWebSocketEventMap[EventName]) => void>;
+    [EventName in keyof CommonWebSocketEventMap]: Set<(event: CommonWebSocketEventMap[EventName]) => MaybePromise<void>>;
 }>;
 /**
  * A mock WebSocket constructor for connections from the client side. This can be passed to
@@ -165,14 +165,14 @@ export declare class MockClientWebSocket<const WebSocketToConnect extends WebSoc
      *
      * @see https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener
      */
-    addEventListener<const EventName extends keyof CommonWebSocketEventMap>(eventName: EventName, listener: (event: CommonWebSocketEventMap[EventName]) => void): void;
+    addEventListener<const EventName extends keyof CommonWebSocketEventMap>(eventName: EventName, listener: (event: CommonWebSocketEventMap[EventName]) => MaybePromise<void>): void;
     /**
      * Implements and mocks the standard `WebSocket.removeEventListener` property but with message
      * type safety.
      *
      * @see https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener
      */
-    removeEventListener<const EventName extends keyof CommonWebSocketEventMap>(eventName: EventName, listener: (event: CommonWebSocketEventMap[EventName]) => void): void;
+    removeEventListener<const EventName extends keyof CommonWebSocketEventMap>(eventName: EventName, listener: (event: CommonWebSocketEventMap[EventName]) => MaybePromise<void>): void;
     /**
      * Implements and mocks the standard `WebSocket.send` property but with message type safety.
      *

package/dist/frontend-connect/mock-client-web-socket.js

@@ -139,11 +139,13 @@ export class MockClientWebSocket {
      * methods instead (which appropriately dispatch their events).
      */
     dispatchEvent(eventName, event) {
-        this.listeners[eventName]?.forEach((listener) => listener({
-            ...event,
-            target: this,
-            type: eventName,
-        }));
+        this.listeners[eventName]?.forEach((listener) => {
+            void listener({
+                ...event,
+                target: this,
+                type: eventName,
+            });
+        });
     }
     /**
      * Implements and mocks the standard `WebSocket.addEventListener` property but with message type
@@ -187,7 +189,7 @@ export class MockClientWebSocket {
             return;
         }
         this.dispatchEvent('message', {
-            data,
+            data: JSON.stringify(data),
         });
         void this.sendCallback?.({
             messageData: data,

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

@@ -69,6 +69,13 @@ export type SendAndWaitForReplyParams<Location extends WebSocketLocation, WebSoc
      * @default {seconds: 10}
      */
     timeout?: Readonly<AnyDuration> | undefined;
+    /**
+     * An optional function to check if the current reply is the one you were waiting for.
+     *
+     * If this is set, `sendAndWaitForReply` will wait until a reply is received that matches this
+     * condition. If this not set, the first reply is used.
+     */
+    replyCheck?: (messageFromHost: WebSocketToConnect extends NoParam ? any : Exclude<WebSocketToConnect, NoParam>['MessageFromHostType']) => MaybePromise<boolean>;
 };
 /**
  * Collapsed version of {@link SendAndWaitForReplyParams} for the `sendAndWaitForReply` method that
@@ -82,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.
@@ -104,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.
@@ -112,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
@@ -121,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/dist/web-socket/overwrite-web-socket-methods.js

@@ -1,5 +1,5 @@
 import { waitUntil } from '@augment-vir/assert';
-import { callAsynchronously, DeferredPromise, ensureErrorAndPrependMessage, getOrSet, stringify, } from '@augment-vir/common';
+import { callAsynchronously, DeferredPromise, ensureErrorAndPrependMessage, getOrSet, stringify, wrapInTry, } from '@augment-vir/common';
 import { convertDuration } from 'date-vir';
 import { assertValidShape } from 'object-shape-tester';
 import { parseJsonWithUndefined } from '../augments/json.js';
@@ -103,11 +103,16 @@ export function overwriteWebSocketMethods(webSocketDefinition, rawWebSocket, web
                 originalRemoveEventListener.call(webSocket, eventName, existing);
             }
         },
-        async sendAndWaitForReply({ message, timeout = { seconds: 10 }, } = {}) {
+        async sendAndWaitForReply({ message, timeout = { seconds: 10 }, replyCheck, } = {}) {
             const deferredReply = new DeferredPromise();
-            function listener({ message, }) {
+            async function listener({ message, }) {
                 if (!deferredReply.isSettled) {
-                    deferredReply.resolve(message);
+                    const matchesChecker = replyCheck
+                        ? (await wrapInTry(() => replyCheck(message))) === true
+                        : true;
+                    if (matchesChecker) {
+                        deferredReply.resolve(message);
+                    }
                 }
             }
             setTimeout(() => {

package/package.json

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