@opra/socketio 1.20.0 → 1.22.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opra/socketio",
-  "version": "1.20.0",
+  "version": "1.22.0",
   "description": "Opra Socket.IO adapter",
   "author": "Panates",
   "license": "MIT",
@@ -8,50 +8,34 @@
     "@jsopen/objects": "^2.0.2",
     "@browsery/type-is": "^2.0.1",
     "content-type": "^1.0.5",
-    "iconv-lite": "^0.7.0",
-    "node-events-async": "^1.2.0",
+    "iconv-lite": "^0.7.1",
+    "node-events-async": "^1.4.0",
     "tslib": "^2.8.1",
     "valgen": "^5.18.2"
   },
   "peerDependencies": {
-    "@opra/common": "^1.20.0",
-    "@opra/core": "^1.20.0",
+    "@opra/common": "^1.22.0",
+    "@opra/core": "^1.22.0",
     "socket.io": ">=4.0.0"
   },
   "type": "module",
+  "module": "./index.js",
+  "types": "./index.d.ts",
   "exports": {
     ".": {
-      "import": {
-        "types": "./types/index.d.ts",
-        "default": "./esm/index.js"
-      },
-      "require": {
-        "types": "./types/index.d.cts",
-        "default": "./cjs/index.js"
-      },
-      "default": "./esm/index.js"
+      "types": "./index.d.ts",
+      "default": "./index.js"
     },
     "./package.json": "./package.json"
   },
-  "main": "./cjs/index.js",
-  "module": "./esm/index.js",
-  "types": "./types/index.d.ts",
+  "engines": {
+    "node": ">=20.0"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/panates/opra.git",
     "directory": "packages/socketio"
   },
-  "engines": {
-    "node": ">=16.0",
-    "npm": ">=7.0.0"
-  },
-  "files": [
-    "cjs/",
-    "esm/",
-    "types/",
-    "LICENSE",
-    "README.md"
-  ],
   "keywords": [
     "opra",
     "socketio",

package/{esm/socketio-adapter.js → socketio-adapter.js}

@@ -1,19 +1,24 @@
 import { OpraException, WSApi, } from '@opra/common';
 import { PlatformAdapter } from '@opra/core';
 import * as socketio from 'socket.io';
+import { vg } from 'valgen';
 import { SocketioContext } from './socketio-context.js';
 /**
  *
  * @class SocketioAdapter
  */
 export class SocketioAdapter extends PlatformAdapter {
+    static PlatformName = 'socketio';
+    _controllerInstances = new Map();
+    _eventsRegByName = new Map();
+    _eventsRegByPattern = [];
+    _scope;
+    transform = 'ws';
+    platform = SocketioAdapter.PlatformName;
+    interceptors;
+    server;
     constructor(document, options) {
         super(options);
-        this._controllerInstances = new Map();
-        this._eventsRegByName = new Map();
-        this._eventsRegByPattern = [];
-        this.transform = 'ws';
-        this.platform = SocketioAdapter.PlatformName;
         this._document = document;
         if (!(this.document.api instanceof WSApi)) {
             throw new TypeError(`The document doesn't expose a WS Api`);
@@ -28,6 +33,32 @@ export class SocketioAdapter extends PlatformAdapter {
             this._initSocket(socket);
             this.emit('connection', socket, this);
         });
+    }
+    get api() {
+        return this.document.getWsApi();
+    }
+    get scope() {
+        return this._scope;
+    }
+    async close() {
+        return this.server.close().finally(() => {
+            this._controllerInstances.clear();
+            this._eventsRegByName.clear();
+            this._eventsRegByPattern = [];
+        });
+    }
+    /**
+     * Attaches socket.io to a server or port.
+     *
+     * @param srv - server or port
+     * @param opts - options passed to engine.io
+     * @return self
+     */
+    listen(srv, opts) {
+        if (this.server.httpServer?.listening)
+            throw new Error('Server is already listening');
+        if (opts?.path)
+            this.server.path(opts?.path);
         for (const contDef of this.api.controllers.values()) {
             for (const oprDef of contDef.operations.values()) {
                 const fn = contDef.instance[oprDef.name];
@@ -46,11 +77,16 @@ export class SocketioAdapter extends PlatformAdapter {
                     this._eventsRegByPattern.push(reg);
                 /** Generate decoders */
                 if (oprDef.arguments?.length) {
-                    for (const dt of oprDef.arguments) {
-                        reg.decoders.push(dt.generateCodec('decode', {
+                    for (const arg of oprDef.arguments) {
+                        let fn2 = arg.type.generateCodec('decode', {
                             scope: this.scope,
                             ignoreReadonlyFields: true,
-                        }));
+                        });
+                        if (arg.required)
+                            fn2 = vg.required(fn2);
+                        else
+                            fn2 = vg.optional(fn2);
+                        reg.decoders.push(fn2);
                     }
                 }
                 /** Generate response encoder */
@@ -62,28 +98,6 @@ export class SocketioAdapter extends PlatformAdapter {
                 }
             }
         }
-    }
-    get api() {
-        return this.document.getWsApi();
-    }
-    get scope() {
-        return this._scope;
-    }
-    close() {
-        return this.server.close();
-    }
-    /**
-     * Attaches socket.io to a server or port.
-     *
-     * @param srv - server or port
-     * @param opts - options passed to engine.io
-     * @return self
-     */
-    listen(srv, opts) {
-        if (this.server.httpServer?.listening)
-            throw new Error('Server is already listening');
-        if (opts?.path)
-            this.server.path(opts?.path);
         this.server.listen(srv, opts);
         return this;
     }
@@ -100,26 +114,40 @@ export class SocketioAdapter extends PlatformAdapter {
                 this._eventsRegByPattern.find(r => r.event.test(event));
             if (!reg) {
                 if (callback)
-                    callback(new Error(`Unknown event "${event}"`));
+                    callback(new OpraException(`Unknown event "${event}"`));
                 return;
             }
-            const parameters = callback ? args.slice(0, -1) : args;
             Promise.resolve().then(async () => {
-                const ctx = new SocketioContext({
-                    __adapter: this,
-                    __contDef: reg.contDef,
-                    __oprDef: reg.oprDef,
-                    __controller: reg.contDef.instance,
-                    __handler: reg.handler,
-                    socket,
-                    event,
-                    parameters,
-                });
                 try {
-                    let x = await reg.handler.apply(reg.contDef.instance, [
-                        ctx,
-                        ...parameters,
-                    ]);
+                    const inputParameters = callback ? args.slice(0, -1) : args;
+                    const ctx = new SocketioContext({
+                        __adapter: this,
+                        __contDef: reg.contDef,
+                        __oprDef: reg.oprDef,
+                        __controller: reg.contDef.instance,
+                        __handler: reg.handler,
+                        socket,
+                        event,
+                    });
+                    const callArgs = [ctx];
+                    let i = 0;
+                    for (const prm of inputParameters) {
+                        try {
+                            const v = reg.decoders[i](prm);
+                            const arg = reg.oprDef.arguments[i];
+                            ctx.parameters.push(v);
+                            if (arg.parameterIndex != null)
+                                callArgs[arg.parameterIndex] = v;
+                            else
+                                callArgs.push(v);
+                        }
+                        catch (err) {
+                            err.message = `Failed to decode parameter ${i} of event "${event}": ${err.message}`;
+                            throw err;
+                        }
+                        i++;
+                    }
+                    let x = await reg.handler.apply(reg.contDef.instance, callArgs);
                     if (reg.encoder)
                         x = reg.encoder(x);
                     if (x != null && typeof x !== 'string')
@@ -127,8 +155,8 @@ export class SocketioAdapter extends PlatformAdapter {
                     callback(x);
                 }
                 catch (err) {
-                    const error = new OpraException(err);
-                    callback(error);
+                    const error = err instanceof OpraException ? err : new OpraException(err);
+                    callback({ error });
                 }
             });
         });
@@ -138,4 +166,3 @@ export class SocketioAdapter extends PlatformAdapter {
         return controller && this._controllerInstances.get(controller);
     }
 }
-SocketioAdapter.PlatformName = 'socketio';

package/{esm/socketio-context.js → socketio-context.js}

@@ -4,6 +4,9 @@ import { ExecutionContext } from '@opra/core';
  * It extends the ExecutionContext and implements the AsyncEventEmitter.
  */
 export class SocketioContext extends ExecutionContext {
+    socket;
+    event;
+    parameters = [];
     /**
      * Constructor
      * @param init the context options
@@ -17,7 +20,6 @@ export class SocketioContext extends ExecutionContext {
             transport: 'ws',
             platform: 'socketio',
         });
-        this.parameters = [];
         this.socket = init.socket;
         this.event = init.event;
         this.parameters = init.parameters || [];

package/cjs/index.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-// export * from './constants.js';
-tslib_1.__exportStar(require("./socketio-adapter.js"), exports);
-tslib_1.__exportStar(require("./socketio-context.js"), exports);

package/cjs/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "commonjs"
-}

package/cjs/socketio-adapter.js

@@ -1,146 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SocketioAdapter = void 0;
-const tslib_1 = require("tslib");
-const common_1 = require("@opra/common");
-const core_1 = require("@opra/core");
-const socketio = tslib_1.__importStar(require("socket.io"));
-const socketio_context_js_1 = require("./socketio-context.js");
-/**
- *
- * @class SocketioAdapter
- */
-class SocketioAdapter extends core_1.PlatformAdapter {
-    constructor(document, options) {
-        super(options);
-        this._controllerInstances = new Map();
-        this._eventsRegByName = new Map();
-        this._eventsRegByPattern = [];
-        this.transform = 'ws';
-        this.platform = SocketioAdapter.PlatformName;
-        this._document = document;
-        if (!(this.document.api instanceof common_1.WSApi)) {
-            throw new TypeError(`The document doesn't expose a WS Api`);
-        }
-        this.interceptors = [...(options?.interceptors || [])];
-        this._scope = options?.scope;
-        this.server = new socketio.Server();
-        this.server.on('error', error => {
-            this.emit('error', error, undefined, this);
-        });
-        this.server.on('connection', (socket) => {
-            this._initSocket(socket);
-            this.emit('connection', socket, this);
-        });
-        for (const contDef of this.api.controllers.values()) {
-            for (const oprDef of contDef.operations.values()) {
-                const fn = contDef.instance[oprDef.name];
-                if (typeof fn !== 'function')
-                    continue;
-                const reg = {
-                    event: oprDef.event,
-                    contDef,
-                    oprDef,
-                    handler: fn,
-                    decoders: [],
-                };
-                if (typeof reg.event === 'string')
-                    this._eventsRegByName.set(reg.event, reg);
-                else
-                    this._eventsRegByPattern.push(reg);
-                /** Generate decoders */
-                if (oprDef.arguments?.length) {
-                    for (const dt of oprDef.arguments) {
-                        reg.decoders.push(dt.generateCodec('decode', {
-                            scope: this.scope,
-                            ignoreReadonlyFields: true,
-                        }));
-                    }
-                }
-                /** Generate response encoder */
-                if (oprDef.response) {
-                    reg.encoder = oprDef.response.generateCodec('encode', {
-                        scope: this.scope,
-                        ignoreWriteonlyFields: true,
-                    });
-                }
-            }
-        }
-    }
-    get api() {
-        return this.document.getWsApi();
-    }
-    get scope() {
-        return this._scope;
-    }
-    close() {
-        return this.server.close();
-    }
-    /**
-     * Attaches socket.io to a server or port.
-     *
-     * @param srv - server or port
-     * @param opts - options passed to engine.io
-     * @return self
-     */
-    listen(srv, opts) {
-        if (this.server.httpServer?.listening)
-            throw new Error('Server is already listening');
-        if (opts?.path)
-            this.server.path(opts?.path);
-        this.server.listen(srv, opts);
-        return this;
-    }
-    _initSocket(socket) {
-        socket.on('close', () => {
-            this.emit('close', socket, this);
-        });
-        socket.on('error', error => {
-            this.emit('error', error, socket, this);
-        });
-        socket.onAny((event, ...args) => {
-            const callback = args.length > 0 ? args[args.length - 1] : null;
-            const reg = this._eventsRegByName.get(event) ||
-                this._eventsRegByPattern.find(r => r.event.test(event));
-            if (!reg) {
-                if (callback)
-                    callback(new Error(`Unknown event "${event}"`));
-                return;
-            }
-            const parameters = callback ? args.slice(0, -1) : args;
-            Promise.resolve().then(async () => {
-                const ctx = new socketio_context_js_1.SocketioContext({
-                    __adapter: this,
-                    __contDef: reg.contDef,
-                    __oprDef: reg.oprDef,
-                    __controller: reg.contDef.instance,
-                    __handler: reg.handler,
-                    socket,
-                    event,
-                    parameters,
-                });
-                try {
-                    let x = await reg.handler.apply(reg.contDef.instance, [
-                        ctx,
-                        ...parameters,
-                    ]);
-                    if (reg.encoder)
-                        x = reg.encoder(x);
-                    if (x != null && typeof x !== 'string')
-                        x = JSON.stringify(x);
-                    callback(x);
-                }
-                catch (err) {
-                    const error = new common_1.OpraException(err);
-                    callback(error);
-                }
-            });
-        });
-    }
-    getControllerInstance(controllerPath) {
-        const controller = this.api.findController(controllerPath);
-        return controller && this._controllerInstances.get(controller);
-    }
-}
-exports.SocketioAdapter = SocketioAdapter;
-SocketioAdapter.PlatformName = 'socketio';

package/cjs/socketio-context.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SocketioContext = void 0;
-const core_1 = require("@opra/core");
-/**
- * Provides the context for handling messages.
- * It extends the ExecutionContext and implements the AsyncEventEmitter.
- */
-class SocketioContext extends core_1.ExecutionContext {
-    /**
-     * Constructor
-     * @param init the context options
-     */
-    constructor(init) {
-        super({
-            ...init,
-            __docNode: init.__oprDef?.node ||
-                init.__contDef?.node ||
-                init.__adapter.document.node,
-            transport: 'ws',
-            platform: 'socketio',
-        });
-        this.parameters = [];
-        this.socket = init.socket;
-        this.event = init.event;
-        this.parameters = init.parameters || [];
-        if (init.__contDef)
-            this.__contDef = init.__contDef;
-        if (init.__controller)
-            this.__controller = init.__controller;
-        if (init.__oprDef)
-            this.__oprDef = init.__oprDef;
-        if (init.__handler)
-            this.__handler = init.__handler;
-    }
-    get server() {
-        return this.__adapter.server;
-    }
-}
-exports.SocketioContext = SocketioContext;

package/esm/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "module"
-}

package/types/index.d.cts

@@ -1,2 +0,0 @@
-export * from './socketio-adapter.js';
-export * from './socketio-context.js';