@nyirusu/nact-websocket-nuxtjs-server 0.0.0-stage → 1.0.4

package/README.md

@@ -1,3 +1,9 @@
-# Temporary Holding Version
+# nact-websocket-nuxtjs-server
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Nuxt / Nitro 原生 WebSocket 路由的 NACT Server Provider。
+
+在 Nitro 插件内注册 Provider，配置 `type: 'websocket-nuxtjs', provider: {}` 并启动 NApp；路由通过 `defineWebSocketHandler(provider.hooks)` 接入。启用 `nitro.experimental.websocket`，由 Nitro/CrossWS 完成升级，不自行监听端口，不操作 Node Req/Res。
+
+`provider.authorize(request)` 可在升级前鉴权。关闭 Provider 释放自己的连接，不关闭 Nitro 服务。客户端使用现有 `nact-websocket-client`，客户端传输类型为 `websocket`。
+
+完整示例见 [运行时接入文档](../../docs/transport/nact/runtime-build.md#nuxt)。

package/dist/index.d.ts

@@ -0,0 +1,24 @@
+import type { Channel, ServerHandle, ServerProvider } from '@nyirusu/nasdk/NACT';
+import type { Hooks } from 'crossws';
+export interface NuxtWebSocketServerOptions {
+    authorize?: (request: Parameters<Hooks['upgrade']>[0]) => boolean | Promise<boolean>;
+}
+export interface NuxtWebSocketServerTransportSpec {
+    type: 'websocket-nuxtjs';
+    provider?: NuxtWebSocketServerOptions;
+    nact?: {
+        chunkSize?: number;
+    };
+}
+export default class NuxtWebSocketServerProvider implements ServerProvider<'websocket-nuxtjs', NuxtWebSocketServerOptions> {
+    readonly type = "websocket-nuxtjs";
+    readonly role = "server";
+    readonly defaultChunkSize: number;
+    private accept?;
+    private options?;
+    private channels;
+    private admissions;
+    listen(options: NuxtWebSocketServerOptions, accept: (channel: Channel) => void): Promise<ServerHandle>;
+    readonly hooks: Hooks;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAChF,OAAO,KAAK,EAAE,KAAK,EAAQ,MAAM,SAAS,CAAA;AAE1C,MAAM,WAAW,0BAA0B;IACzC,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,UAAU,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CACrF;AAED,MAAM,WAAW,gCAAgC;IAC/C,IAAI,EAAE,kBAAkB,CAAA;IACxB,QAAQ,CAAC,EAAE,0BAA0B,CAAA;IACrC,IAAI,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;CAC9B;AAoDD,MAAM,CAAC,OAAO,OAAO,2BACnB,YAAW,cAAc,CAAC,kBAAkB,EAAE,0BAA0B,CAAC;IACzE,QAAQ,CAAC,IAAI,sBAAqB;IAClC,QAAQ,CAAC,IAAI,YAAW;IACxB,QAAQ,CAAC,gBAAgB,SAAY;IACrC,OAAO,CAAC,MAAM,CAAC,CAA4B;IAC3C,OAAO,CAAC,OAAO,CAAC,CAA4B;IAC5C,OAAO,CAAC,QAAQ,CAAwC;IACxD,OAAO,CAAC,UAAU,CAAoD;IAEhE,MAAM,CAAC,OAAO,EAAE,0BAA0B,EAAE,MAAM,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC;IAkB5G,QAAQ,CAAC,KAAK,EAAE,KAAK,CAyBpB;CACF"}

package/dist/index.js

@@ -0,0 +1,136 @@
+const transportError = (code) => Object.assign(new Error(code), { code });
+class NuxtWebSocketChannel {
+    peer;
+    receivers = new Set();
+    closers = new Set();
+    errors = new Set();
+    ended = false;
+    constructor(peer) {
+        this.peer = peer;
+    }
+    send(frame) {
+        if (this.ended)
+            throw transportError('transport-closed');
+        const bytes = new Uint8Array(frame.reduce((size, part) => size + part.byteLength, 0));
+        let offset = 0;
+        for (const part of frame) {
+            bytes.set(part, offset);
+            offset += part.byteLength;
+        }
+        this.peer.send(bytes, { compress: false });
+    }
+    close() { this.end(); this.peer.close(1000, 'NACT closed'); }
+    terminate() { this.end(); this.peer.terminate(); }
+    onReceive(handler) {
+        this.receivers.add(handler);
+        return () => this.receivers.delete(handler);
+    }
+    onClose(handler) {
+        if (this.ended)
+            queueMicrotask(handler);
+        else
+            this.closers.add(handler);
+        return () => this.closers.delete(handler);
+    }
+    onError(handler) {
+        this.errors.add(handler);
+        return () => this.errors.delete(handler);
+    }
+    receive(bytes) {
+        if (!this.ended)
+            for (const handler of this.receivers)
+                handler([bytes]);
+    }
+    fail(reason) {
+        if (this.ended)
+            return;
+        try {
+            for (const handler of this.errors)
+                handler(reason);
+        }
+        finally {
+            this.terminate();
+        }
+    }
+    end() {
+        if (this.ended)
+            return;
+        this.ended = true;
+        for (const handler of this.closers)
+            handler();
+        this.receivers.clear();
+        this.closers.clear();
+        this.errors.clear();
+    }
+}
+// Nitro/CrossWS owns routing and upgrade; this Provider only handles accepted peers.
+export default class NuxtWebSocketServerProvider {
+    type = 'websocket-nuxtjs';
+    role = 'server';
+    defaultChunkSize = 64 * 1024;
+    accept;
+    options;
+    channels = new Map();
+    admissions = new WeakMap();
+    async listen(options, accept) {
+        if (this.accept)
+            throw transportError('provider-already-listening');
+        this.accept = accept;
+        this.options = options;
+        let closed = false;
+        return {
+            close: async () => {
+                if (closed)
+                    return;
+                closed = true;
+                this.accept = undefined;
+                this.options = undefined;
+                this.admissions = new WeakMap();
+                for (const channel of this.channels.values())
+                    channel.terminate();
+                this.channels.clear();
+            },
+        };
+    }
+    hooks = {
+        upgrade: async (request) => {
+            const accept = this.accept;
+            const options = this.options;
+            if (!accept || !options)
+                return new Response(null, { status: 503 });
+            if (options.authorize && !await options.authorize(request))
+                return new Response(null, { status: 403 });
+            if (this.accept !== accept)
+                return new Response(null, { status: 503 });
+            this.admissions.set(request.context, accept);
+        },
+        open: peer => {
+            const accept = this.accept;
+            if (!accept || this.admissions.get(peer.context) !== accept) {
+                peer.terminate();
+                return;
+            }
+            this.admissions.delete(peer.context);
+            const channel = new NuxtWebSocketChannel(peer);
+            this.channels.set(peer, channel);
+            channel.onClose(() => this.channels.delete(peer));
+            try {
+                accept(channel);
+            }
+            catch (reason) {
+                channel.fail(reason);
+                throw reason;
+            }
+        },
+        message: (peer, message) => {
+            const channel = this.channels.get(peer);
+            if (typeof message.rawData === 'string')
+                channel?.fail(transportError('non-binary-frame'));
+            else
+                channel?.receive(message.uint8Array());
+        },
+        close: peer => { this.channels.get(peer)?.end(); },
+        error: (peer, reason) => { this.channels.get(peer)?.fail(reason); },
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAaA,MAAM,cAAc,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAA;AAEjF,MAAM,oBAAoB;IAKJ;IAJZ,SAAS,GAAG,IAAI,GAAG,EAA0C,CAAA;IAC7D,OAAO,GAAG,IAAI,GAAG,EAAc,CAAA;IAC/B,MAAM,GAAG,IAAI,GAAG,EAA6B,CAAA;IAC7C,KAAK,GAAG,KAAK,CAAA;IACrB,YAAoB,IAAU;QAAV,SAAI,GAAJ,IAAI,CAAM;IAAG,CAAC;IAElC,IAAI,CAAC,KAA4B;QAC/B,IAAI,IAAI,CAAC,KAAK;YAAE,MAAM,cAAc,CAAC,kBAAkB,CAAC,CAAA;QACxD,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,CAAA;QACrF,IAAI,MAAM,GAAG,CAAC,CAAA;QACd,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YAAC,MAAM,IAAI,IAAI,CAAC,UAAU,CAAA;QAAC,CAAC;QAChF,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAA;IAC5C,CAAC;IACD,KAAK,KAAK,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,aAAa,CAAC,CAAA,CAAC,CAAC;IAC5D,SAAS,KAAK,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAA,CAAC,CAAC;IACjD,SAAS,CAAC,OAA+C;QACvD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;QAC3B,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IAC7C,CAAC;IACD,OAAO,CAAC,OAAmB;QACzB,IAAI,IAAI,CAAC,KAAK;YAAE,cAAc,CAAC,OAAO,CAAC,CAAA;;YAClC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;QAC9B,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IAC3C,CAAC;IACD,OAAO,CAAC,OAAkC;QACxC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;QACxB,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IAC1C,CAAC;IACD,OAAO,CAAC,KAAiB;QACvB,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS;gBAAE,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,CAAA;IACzE,CAAC;IACD,IAAI,CAAC,MAAe;QAClB,IAAI,IAAI,CAAC,KAAK;YAAE,OAAM;QACtB,IAAI,CAAC;YAAC,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,MAAM;gBAAE,OAAO,CAAC,MAAM,CAAC,CAAA;QAAC,CAAC;gBAClD,CAAC;YAAC,IAAI,CAAC,SAAS,EAAE,CAAA;QAAC,CAAC;IAC9B,CAAC;IACD,GAAG;QACD,IAAI,IAAI,CAAC,KAAK;YAAE,OAAM;QACtB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;QACjB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,OAAO;YAAE,OAAO,EAAE,CAAA;QAC7C,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAA;QACtB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAA;QACpB,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;IACrB,CAAC;CACF;AAED,qFAAqF;AACrF,MAAM,CAAC,OAAO,OAAO,2BAA2B;IAErC,IAAI,GAAG,kBAAkB,CAAA;IACzB,IAAI,GAAG,QAAQ,CAAA;IACf,gBAAgB,GAAG,EAAE,GAAG,IAAI,CAAA;IAC7B,MAAM,CAA6B;IACnC,OAAO,CAA6B;IACpC,QAAQ,GAAG,IAAI,GAAG,EAA8B,CAAA;IAChD,UAAU,GAAG,IAAI,OAAO,EAAsC,CAAA;IAEtE,KAAK,CAAC,MAAM,CAAC,OAAmC,EAAE,MAAkC;QAClF,IAAI,IAAI,CAAC,MAAM;YAAE,MAAM,cAAc,CAAC,4BAA4B,CAAC,CAAA;QACnE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,MAAM,GAAG,KAAK,CAAA;QAClB,OAAO;YACL,KAAK,EAAE,KAAK,IAAI,EAAE;gBAChB,IAAI,MAAM;oBAAE,OAAM;gBAClB,MAAM,GAAG,IAAI,CAAA;gBACb,IAAI,CAAC,MAAM,GAAG,SAAS,CAAA;gBACvB,IAAI,CAAC,OAAO,GAAG,SAAS,CAAA;gBACxB,IAAI,CAAC,UAAU,GAAG,IAAI,OAAO,EAAE,CAAA;gBAC/B,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;oBAAE,OAAO,CAAC,SAAS,EAAE,CAAA;gBACjE,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAA;YACvB,CAAC;SACF,CAAA;IACH,CAAC;IAEQ,KAAK,GAAU;QACtB,OAAO,EAAE,KAAK,EAAC,OAAO,EAAC,EAAE;YACvB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAA;YAC1B,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAA;YAC5B,IAAI,CAAC,MAAM,IAAI,CAAC,OAAO;gBAAE,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAA;YACnE,IAAI,OAAO,CAAC,SAAS,IAAI,CAAC,MAAM,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC;gBAAE,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAA;YACtG,IAAI,IAAI,CAAC,MAAM,KAAK,MAAM;gBAAE,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAA;YACtE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;QAC9C,CAAC;QACD,IAAI,EAAE,IAAI,CAAC,EAAE;YACX,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAA;YAC1B,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,MAAM,EAAE,CAAC;gBAAC,IAAI,CAAC,SAAS,EAAE,CAAC;gBAAC,OAAM;YAAC,CAAC;YACzF,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YACpC,MAAM,OAAO,GAAG,IAAI,oBAAoB,CAAC,IAAI,CAAC,CAAA;YAC9C,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;YAChC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAA;YACjD,IAAI,CAAC;gBAAC,MAAM,CAAC,OAAO,CAAC,CAAA;YAAC,CAAC;YAAC,OAAO,MAAM,EAAE,CAAC;gBAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAAC,MAAM,MAAM,CAAA;YAAC,CAAC;QAC/E,CAAC;QACD,OAAO,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE;YACzB,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;YACvC,IAAI,OAAO,OAAO,CAAC,OAAO,KAAK,QAAQ;gBAAE,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC,CAAA;;gBACrF,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;QAC7C,CAAC;QACD,KAAK,EAAE,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA,CAAC,CAAC;QACjD,KAAK,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA,CAAC,CAAC;KACnE,CAAA;CACF"}

package/package.json

@@ -1,6 +1,20 @@
 {
   "name": "@nyirusu/nact-websocket-nuxtjs-server",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.4",
+  "type": "module",
+  "files": ["dist"],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": { ".": { "types": "./dist/index.d.ts", "import": "./dist/index.js" } },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "npm run test:simple",
+    "test:simple": "node --import tsx --test test/simple.test.mjs",
+    "test:full": "node --import tsx --test test/full.test.mjs",
+    "test:edge": "node --import tsx --test test/edge.test.mjs"
+  },
+  "devDependencies": { "crossws": "^0.3.5" },
+  "peerDependencies": { "@nyirusu/nasdk": ">=1.0.4", "crossws": "^0.3.5" },
+  "peerDependenciesMeta": { "@nyirusu/nasdk": { "optional": true } }
+}