@rest-vir/implement-service 0.0.6 → 0.1.0

package/README.md

@@ -39,7 +39,7 @@ export const myServiceImplementation = implementService(
         },
         webSockets: {
             '/my-web-socket': {
-                onMessage({webSocket}) {
+                message({webSocket}) {
                     webSocket.send('hi!');
                 },
             },

package/dist/implementation/implement-web-socket.d.ts

@@ -11,21 +11,36 @@ import { type ServiceLogger } from '../util/service-logger.js';
  * @category Package : @rest-vir/implement-service
  * @package [`@rest-vir/implement-service`](https://www.npmjs.com/package/@rest-vir/implement-service)
  */
-export type WebSocketImplementation<Context = any, ServiceName extends string = any, SpecificWebSocket extends WebSocketDefinition | NoParam = NoParam> = SpecificWebSocket extends NoParam ? any : Partial<{
-    /** This will be called when the WebSocket is connected and created. */
-    onConnection: (params: WebSocketImplementationParams<Context, ServiceName, SpecificWebSocket, false>) => MaybePromise<void>;
+export type WebSocketImplementation<Context = any, ServiceName extends string = any, SpecificWebSocket extends WebSocketDefinition | NoParam = NoParam> = SpecificWebSocket extends NoParam ? Partial<{
+    /** This will be called when the WebSocket is opened and created. */
+    open: (params: any) => MaybePromise<void>;
     /**
      * This will be called on every received WebSocket message.
      *
      * @see https://github.com/websockets/ws/blob/HEAD/doc/ws.md#event-message
      */
-    onMessage: (params: WebSocketImplementationParams<Context, ServiceName, SpecificWebSocket, true>) => MaybePromise<void>;
+    message: (params: any) => MaybePromise<void>;
     /**
      * This will be called when the WebSocket is closed.
      *
      * @see https://github.com/websockets/ws/blob/HEAD/doc/ws.md#event-close-1
      */
-    onClose: (params: WebSocketImplementationParams<Context, ServiceName, SpecificWebSocket, false>) => MaybePromise<void>;
+    close: (params: any) => MaybePromise<void>;
+}> : Partial<{
+    /** This will be called when the WebSocket is opened and created. */
+    open: (params: WebSocketImplementationParams<Context, ServiceName, SpecificWebSocket, false>) => MaybePromise<void>;
+    /**
+     * This will be called on every received WebSocket message.
+     *
+     * @see https://github.com/websockets/ws/blob/HEAD/doc/ws.md#event-message
+     */
+    message: (params: WebSocketImplementationParams<Context, ServiceName, SpecificWebSocket, true>) => MaybePromise<void>;
+    /**
+     * This will be called when the WebSocket is closed.
+     *
+     * @see https://github.com/websockets/ws/blob/HEAD/doc/ws.md#event-close-1
+     */
+    close: (params: WebSocketImplementationParams<Context, ServiceName, SpecificWebSocket, false>) => MaybePromise<void>;
 }>;
 /**
  * Parameters for event callbacks in {@link WebSocketImplementation}.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rest-vir/implement-service",
-    "version": "0.0.6",
+    "version": "0.1.0",
     "description": "Implement a service defined by @rest-vir/define-service.",
     "keywords": [
         "rest",
@@ -41,7 +41,7 @@
     "dependencies": {
         "@augment-vir/assert": "^31.9.2",
         "@augment-vir/common": "^31.9.2",
-        "@rest-vir/define-service": "^0.0.6",
+        "@rest-vir/define-service": "^0.1.0",
         "@types/ws": "^8.5.14",
         "fastify": "^5.2.1",
         "path-to-regexp": "^8.2.0",