@grest-ts/websocket 0.0.5 → 0.0.7

package/src/server/GGWebSocketSchema.startServer.ts

@@ -1,136 +1,136 @@
-/**
- * Server extension for WebSocketSchema - adds startServer and register methods
- * This file should only be imported in server (Node.js) context
- */
-
-import type {GGSocket} from "../socket/GGSocket"
-import {GGWebSocketSchema} from "../schema/GGWebSocketSchema";
-import {GGWebSocketMiddleware} from "../schema/GGWebSocketMiddleware";
-import {GGSocketServer} from "./GGSocketServer";
-import {GGLocator} from "@grest-ts/locator";
-import {WebSocketIncoming, WebSocketOutgoing} from "../socket/WebSocketTypes";
-import {GG_HTTP_SERVER, GGHttpServer} from "@grest-ts/http";
-
-export interface WebSocketSchemaConfig {
-    /**
-     * The HTTP server adapter to attach the WebSocket server to.
-     * If not provided, will look up from locator.
-     */
-    http?: GGHttpServer;
-    /**
-     * Additional middlewares to apply to all connections.
-     */
-    middlewares?: GGWebSocketMiddleware[];
-}
-
-declare module "../schema/GGWebSocketSchema" {
-    interface GGWebSocketSchema<TClientToServer, TServerToClient, TContext = {}, TQuery = undefined, TClientToServerImpl = TClientToServer> {
-        /**
-         * Start the WebSocket server for this API.
-         */
-        startServer(
-            onConnection: (incoming: WebSocketIncoming<TClientToServerImpl>, outgoing: WebSocketOutgoing<TServerToClient>) => void,
-            config: WebSocketSchemaConfig
-        ): GGSocketServer<TContext, TQuery>
-
-        /**
-         * Register this WebSocket API with the default HTTP server.
-         * Uses GGHttpServerAdapter from locator if not explicitly provided.
-         */
-        register(
-            onConnection: (incoming: WebSocketIncoming<TClientToServerImpl>, outgoing: WebSocketOutgoing<TServerToClient>) => void,
-            config?: WebSocketSchemaConfig
-        ): void
-    }
-}
-
-GGWebSocketSchema.prototype.startServer = function (
-    this: GGWebSocketSchema<any, any, any, any>,
-    onConnection: any,
-    config: WebSocketSchemaConfig
-): GGSocketServer<any, any> {
-    const contract = this.contract
-    if (!contract) {
-        throw new Error(`WebSocketSchema "${this.name}" has no contract.`)
-    }
-
-    const normalizedPath = this.path.startsWith('/') ? this.path : '/' + this.path
-    const schemaName = this.name
-    const http = config.http ?? GGLocator.getScope().get(GG_HTTP_SERVER);
-
-    // @TODO We might want some lookup here based on path/middlewares etc. If I use same socket for multiple paths, we need to reuse also same GGSocketServer.
-    const socketServer = new GGSocketServer(http, {
-        apiName: schemaName,
-        path: normalizedPath,
-        middlewares: [...this.middlewares, ...(config?.middlewares ?? [])]
-    });
-
-    socketServer.onConnection((socket: GGSocket) => {
-        const clientToServerContract = contract.clientToServer
-        const serverToClientContract = contract.serverToClient
-
-        const incoming: any = {
-            on(handlers: any) {
-                const impl: Record<string, any> = {};
-                for (const methodName of Object.keys(clientToServerContract.methods)) {
-                    const methodDef = clientToServerContract.methods[methodName] as any;
-                    const params = methodDef.params;
-                    impl[methodName] = (data: any) => {
-                        // If method has params info, unpack data object to positional args
-                        if (params && params.length > 0 && data && typeof data === 'object') {
-                            const args = params.map((p: any) => data[p.name]);
-                            return handlers[methodName](...args);
-                        }
-                        // Single or no parameter - pass directly
-                        return handlers[methodName](data);
-                    };
-                }
-
-                const incomingInstance = clientToServerContract.implement(impl);
-
-                for (const methodName of Object.keys(clientToServerContract.methods)) {
-                    socket.registerHandler({
-                        path: `${schemaName}.${methodName}`,
-                        handler: (incomingInstance as any)[methodName]
-                    });
-                }
-            }
-        }
-
-        const impl: Record<string, any> = {};
-        for (const methodName of Object.keys(serverToClientContract.methods)) {
-            const method = serverToClientContract.methods[methodName];
-            const expectsResponse = 'success' in method;
-            impl[methodName] = (data: any) => {
-                return socket.send(`${schemaName}.${methodName}`, data, expectsResponse);
-            };
-        }
-
-        const outgoingInstance = serverToClientContract.implement(impl);
-        (outgoingInstance as any).onClose = (callback: () => void) => {
-            socket.onClose(callback)
-        }
-        onConnection(incoming, outgoingInstance)
-    });
-
-    return socketServer;
-}
-
-GGWebSocketSchema.prototype.register = function (
-    this: GGWebSocketSchema<any, any, any, any>,
-    onConnection: any,
-    config?: WebSocketSchemaConfig
-): void {
-    let httpServer = config?.http;
-    if (!httpServer) {
-        httpServer = GGLocator.getScope().get(GG_HTTP_SERVER);
-    }
-    if (!httpServer) {
-        throw new Error(`No HTTP server found. Make sure to register GGHttpServerAdapter in the scope or pass it via config`)
-    }
-
-    this.startServer(onConnection, {
-        http: httpServer,
-        middlewares: config?.middlewares
-    });
-}
+/**
+ * Server extension for WebSocketSchema - adds startServer and register methods
+ * This file should only be imported in server (Node.js) context
+ */
+
+import type {GGSocket} from "../socket/GGSocket"
+import {GGWebSocketSchema} from "../schema/GGWebSocketSchema";
+import {GGWebSocketMiddleware} from "../schema/GGWebSocketMiddleware";
+import {GGSocketServer} from "./GGSocketServer";
+import {GGLocator} from "@grest-ts/locator";
+import {WebSocketIncoming, WebSocketOutgoing} from "../socket/WebSocketTypes";
+import {GG_HTTP_SERVER, GGHttpServer} from "@grest-ts/http";
+
+export interface WebSocketSchemaConfig {
+    /**
+     * The HTTP server adapter to attach the WebSocket server to.
+     * If not provided, will look up from locator.
+     */
+    http?: GGHttpServer;
+    /**
+     * Additional middlewares to apply to all connections.
+     */
+    middlewares?: GGWebSocketMiddleware[];
+}
+
+declare module "../schema/GGWebSocketSchema" {
+    interface GGWebSocketSchema<TClientToServer, TServerToClient, TContext = {}, TQuery = undefined, TClientToServerImpl = TClientToServer> {
+        /**
+         * Start the WebSocket server for this API.
+         */
+        startServer(
+            onConnection: (incoming: WebSocketIncoming<TClientToServerImpl>, outgoing: WebSocketOutgoing<TServerToClient>) => void,
+            config: WebSocketSchemaConfig
+        ): GGSocketServer<TContext, TQuery>
+
+        /**
+         * Register this WebSocket API with the default HTTP server.
+         * Uses GGHttpServerAdapter from locator if not explicitly provided.
+         */
+        register(
+            onConnection: (incoming: WebSocketIncoming<TClientToServerImpl>, outgoing: WebSocketOutgoing<TServerToClient>) => void,
+            config?: WebSocketSchemaConfig
+        ): void
+    }
+}
+
+GGWebSocketSchema.prototype.startServer = function (
+    this: GGWebSocketSchema<any, any, any, any>,
+    onConnection: any,
+    config: WebSocketSchemaConfig
+): GGSocketServer<any, any> {
+    const contract = this.contract
+    if (!contract) {
+        throw new Error(`WebSocketSchema "${this.name}" has no contract.`)
+    }
+
+    const normalizedPath = this.path.startsWith('/') ? this.path : '/' + this.path
+    const schemaName = this.name
+    const http = config.http ?? GGLocator.getScope().get(GG_HTTP_SERVER);
+
+    // @TODO We might want some lookup here based on path/middlewares etc. If I use same socket for multiple paths, we need to reuse also same GGSocketServer.
+    const socketServer = new GGSocketServer(http, {
+        apiName: schemaName,
+        path: normalizedPath,
+        middlewares: [...this.middlewares, ...(config?.middlewares ?? [])]
+    });
+
+    socketServer.onConnection((socket: GGSocket) => {
+        const clientToServerContract = contract.clientToServer
+        const serverToClientContract = contract.serverToClient
+
+        const incoming: any = {
+            on(handlers: any) {
+                const impl: Record<string, any> = {};
+                for (const methodName of Object.keys(clientToServerContract.methods)) {
+                    const methodDef = clientToServerContract.methods[methodName] as any;
+                    const params = methodDef.params;
+                    impl[methodName] = (data: any) => {
+                        // If method has params info, unpack data object to positional args
+                        if (params && params.length > 0 && data && typeof data === 'object') {
+                            const args = params.map((p: any) => data[p.name]);
+                            return handlers[methodName](...args);
+                        }
+                        // Single or no parameter - pass directly
+                        return handlers[methodName](data);
+                    };
+                }
+
+                const incomingInstance = clientToServerContract.implement(impl);
+
+                for (const methodName of Object.keys(clientToServerContract.methods)) {
+                    socket.registerHandler({
+                        path: `${schemaName}.${methodName}`,
+                        handler: (incomingInstance as any)[methodName]
+                    });
+                }
+            }
+        }
+
+        const impl: Record<string, any> = {};
+        for (const methodName of Object.keys(serverToClientContract.methods)) {
+            const method = serverToClientContract.methods[methodName];
+            const expectsResponse = 'success' in method;
+            impl[methodName] = (data: any) => {
+                return socket.send(`${schemaName}.${methodName}`, data, expectsResponse);
+            };
+        }
+
+        const outgoingInstance = serverToClientContract.implement(impl);
+        (outgoingInstance as any).onClose = (callback: () => void) => {
+            socket.onClose(callback)
+        }
+        onConnection(incoming, outgoingInstance)
+    });
+
+    return socketServer;
+}
+
+GGWebSocketSchema.prototype.register = function (
+    this: GGWebSocketSchema<any, any, any, any>,
+    onConnection: any,
+    config?: WebSocketSchemaConfig
+): void {
+    let httpServer = config?.http;
+    if (!httpServer) {
+        httpServer = GGLocator.getScope().get(GG_HTTP_SERVER);
+    }
+    if (!httpServer) {
+        throw new Error(`No HTTP server found. Make sure to register GGHttpServerAdapter in the scope or pass it via config`)
+    }
+
+    this.startServer(onConnection, {
+        http: httpServer,
+        middlewares: config?.middlewares
+    });
+}

package/src/server/GG_WS_CONNECTION.ts

@@ -1,10 +1,10 @@
-import {GGContextKey} from "@grest-ts/context";
-import {IsNumber, IsObject, IsString} from "@grest-ts/schema";
-
-const IsWsConnectionContext = IsObject({
-    port: IsNumber.orUndefined,
-    path: IsString
-});
-export type WsConnectionContext = typeof IsWsConnectionContext.infer;
-
-export const GG_WS_CONNECTION = new GGContextKey<WsConnectionContext>('ws-connection', IsWsConnectionContext);
+import {GGContextKey} from "@grest-ts/context";
+import {IsNumber, IsObject, IsString} from "@grest-ts/schema";
+
+const IsWsConnectionContext = IsObject({
+    port: IsNumber.orUndefined,
+    path: IsString
+});
+export type WsConnectionContext = typeof IsWsConnectionContext.infer;
+
+export const GG_WS_CONNECTION = new GGContextKey<WsConnectionContext>('ws-connection', IsWsConnectionContext);

package/src/server/GG_WS_MESSAGE.ts

@@ -1,9 +1,9 @@
-import {GGContextKey} from "@grest-ts/context";
-import {IsObject, IsString} from "@grest-ts/schema";
-
-const IsWsMessageContext = IsObject({
-    path: IsString
-});
-export type WsMessageContext = typeof IsWsMessageContext.infer;
-
-export const GG_WS_MESSAGE = new GGContextKey<WsMessageContext>('ws-message', IsWsMessageContext);
+import {GGContextKey} from "@grest-ts/context";
+import {IsObject, IsString} from "@grest-ts/schema";
+
+const IsWsMessageContext = IsObject({
+    path: IsString
+});
+export type WsMessageContext = typeof IsWsMessageContext.infer;
+
+export const GG_WS_MESSAGE = new GGContextKey<WsMessageContext>('ws-message', IsWsMessageContext);