oox 0.3.1 → 0.3.3

package/types/modules/socketio/server.d.ts

@@ -1,12 +1,15 @@
 import * as http from 'node:http';
 import * as https from 'node:https';
 import { Server, ServerOptions } from 'socket.io';
+import * as oox from '../../index.js';
 import { Module, ModuleConfig } from '../../index.js';
-import { ServerSocket as Socket } from './socket.js';
+import { Socket } from './socket.js';
+import SocketIOAdapter from './adapter.js';
+import { OOXEvent } from './utils.js';
 export declare class SocketIOConfig extends ModuleConfig {
     port: number;
     path: string;
-    origin: string;
+    origin: string | string[];
     ssl: {
         enabled: boolean;
         cert: string;
@@ -20,9 +23,8 @@ export default class SocketIOServer extends Module {
     config: SocketIOConfig;
     server: http.Server | https.Server;
     socketServer: Server;
-    static isWebSocketUrl(url: string): boolean;
-    static genWebSocketUrl(url: string): string;
-    getUrl(): string;
+    adapter: SocketIOAdapter;
+    getURL(): URL;
     setConfig(config: SocketIOConfig): void;
     getConfig(): SocketIOConfig;
     serve(): Promise<void>;
@@ -32,13 +34,15 @@ export default class SocketIOServer extends Module {
     /**
      * 服务端Socket连接事件
      */
-    serverOnSocketConnection(socket: Socket): void;
-    serverOnConnection(socket: Socket): void;
+    serverOnSocketConnection(socket: Socket<'server'>): void;
     /**
-     * 服务端Socket断开事件
-     * @param {Socket} socket
-     * @param {Error} reason
+    * 服务器发送连接列表
+    * @param connection
+    */
+    [OOXEvent.SYNC_CONNECTIONS](connection: oox.RPCKeepAliveConnection<Socket<'server'>>): oox.RPCKeepAliveConnectionData[];
+    /**
+     * 绑定服务器连接事件
+     * @param connection
      */
-    serverOnSocketDisconnect(socket: Socket, reason: string): void;
-    serverOnDisconnect(socket: Socket, reason: string): void;
+    bindServerConnectionEvents(connection: oox.RPCKeepAliveConnection<Socket<'server'>>): void;
 }

package/types/modules/socketio/socket.d.ts

@@ -1,11 +1,8 @@
-import { Socket as _ServerSocket } from 'socket.io';
-import { Socket as _ClientSocket } from 'socket.io-client';
-import { RPCKeepAliveConnectionData } from '../../index.js';
-export interface ServerSocket extends _ServerSocket {
-    data: RPCKeepAliveConnectionData;
-}
-export interface ClientSocket extends _ClientSocket {
-    data: RPCKeepAliveConnectionData;
-}
-export type Socket = ServerSocket | ClientSocket;
-export declare const sockets: Map<string, Socket>;
+import { Socket as ServerSocket } from 'socket.io';
+import { Socket as ClientSocket } from 'socket.io-client';
+export type SocketMap = {
+    [key: string]: ServerSocket | ClientSocket;
+    server: ServerSocket;
+    client: ClientSocket;
+};
+export type Socket<T extends keyof SocketMap = keyof SocketMap> = SocketMap[T];

package/types/modules/socketio/utils.d.ts

@@ -0,0 +1,7 @@
+export declare enum OOXEvent {
+    CONNECTED = "oox:connected",
+    DISABLED = "oox:disabled",
+    SYNC_CONNECTIONS = "oox:sync_connections"
+}
+export declare function isWebSocketURL(url: string | URL): boolean;
+export declare function genWebSocketURL(url: string): URL;

package/types/rpc-keepalive-connection.d.ts

@@ -0,0 +1,57 @@
+import EventEmitter from 'node:events';
+import { Context } from './index.js';
+export interface RPCKeepAliveConnectionAdapter<T> {
+    open(url: string | URL): Promise<RPCKeepAliveConnection<T>>;
+    close(connection: RPCKeepAliveConnection<T>): Promise<void>;
+    rpc(connection: RPCKeepAliveConnection<T>, action: string, params: any[], context: Context): Promise<any>;
+}
+export interface RPCKeepAliveConnectionData {
+    /**
+     * 连接主机地址
+     */
+    host: string;
+    /**
+     * 连接服务名称
+     */
+    name: string;
+    /**
+     * 连接URL
+     */
+    url?: string | URL;
+    /**
+     * 目标服务网络唯一ID
+     */
+    id: string;
+}
+export type RPCKeepAliveConnectionEventMap = Record<keyof {
+    "enabled": any;
+    "disabled": any;
+    "connect": any;
+    "disconnect": any;
+    'error': any;
+}, any[]>;
+export declare class RPCKeepAliveConnection<T> extends EventEmitter<RPCKeepAliveConnectionEventMap> {
+    #private;
+    data: RPCKeepAliveConnectionData;
+    nativeConnection: T;
+    adapter: RPCKeepAliveConnectionAdapter<T>;
+    constructor(adapter: RPCKeepAliveConnectionAdapter<T>, nativeConnection: T, data: RPCKeepAliveConnectionData);
+    set enabled(enabled: boolean);
+    get enabled(): boolean;
+    updateId(newId: string): void;
+    updateName(newName: string): void;
+    updateIdAndName(newId: string, newName: string): void;
+}
+export declare class KeepAliveConnectionStore<T> {
+    #private;
+    entries(): MapIterator<[string, Map<string, RPCKeepAliveConnection<T>>]>;
+    getConnectionsOfService(name: string): Map<string, RPCKeepAliveConnection<T>>;
+    has(name: string, id: string): boolean;
+    get(name: string, id: string): RPCKeepAliveConnection<T> | null;
+    add(connection: RPCKeepAliveConnection<T>): void;
+    remove(connection: RPCKeepAliveConnection<T>): void;
+    remove(name: string, id: string): void;
+}
+export declare const rpcKeepAliveConnectionAdapters: Map<string, RPCKeepAliveConnectionAdapter<any>>;
+export declare const keepAliveConnections: KeepAliveConnectionStore<any>;
+export declare const enabledKeepAliveConnections: KeepAliveConnectionStore<any>;

package/modules/socketio/client.js

@@ -1,97 +0,0 @@
-import * as SocketIOClient from 'socket.io-client';
-import { sockets } from './socket.js';
-import SocketIOServer from './server.js';
-import * as oox from '../../index.js';
-export default class SocketIOCore extends SocketIOServer {
-    /**
-     * connect to <SocketIO RPC> service
-     */
-    async connect(url) {
-        let socket = sockets.get(url);
-        // 已经连接的直接返回
-        if (socket) {
-            try {
-                await this.clientWaitConnection(socket);
-            }
-            catch (error) {
-                this.clientOnSocketDisconnect(socket, error.message);
-                throw error;
-            }
-            return socket;
-        }
-        const headers = {
-            'x-caller': oox.config.name
-        };
-        const { host } = oox.config;
-        headers['x-ip'] = host;
-        headers['x-caller-id'] = this.getUrl();
-        // create socket handler
-        const mURL = new URL(url);
-        socket = SocketIOClient.io(mURL.origin, {
-            extraHeaders: headers,
-            path: mURL.pathname
-        });
-        socket.data = { name: 'anonymous', connected: false, id: url, host: mURL.host };
-        sockets.set(url, socket);
-        try {
-            await this.clientWaitConnection(socket);
-        }
-        catch (error) {
-            this.clientOnSocketDisconnect(socket, error);
-            throw error;
-        }
-        return socket;
-    }
-    /**
-     * 客户端Socket连接事件
-     */
-    clientOnSocketConnection(socket) {
-        socket.data.connected = true;
-        socket.once('disconnect', reason => this.clientOnSocketDisconnect(socket, reason));
-        this.clientOnConnection(socket);
-    }
-    clientOnDisconnect(socket, reason) { }
-    clientOnConnection(socket) { }
-    /**
-     * 客户端Socket断开事件
-     * @param {Socket} socket
-     */
-    clientOnSocketDisconnect(socket, reason) {
-        socket.data.connected = false;
-        socket.disconnect();
-        sockets.delete(socket.data.id);
-        this.clientOnDisconnect(socket, reason);
-    }
-    /**
-     * 等待socket连接
-     */
-    async clientWaitConnection(socket) {
-        if (socket.data.connected)
-            return;
-        if (socket.connect)
-            socket.connect();
-        try {
-            await new Promise((resolve, reject) => {
-                const onError = (reason) => {
-                    socket.offAny(onError);
-                    const message = 'string' === typeof reason ? reason : reason instanceof Error ? reason.message : 'connect error';
-                    reject(new Error(message));
-                };
-                socket.once('disconnect', onError);
-                socket.once('connect_error', onError);
-                socket.once('connect_timeout', onError);
-                socket.once('reconnect_error', onError);
-                socket.once('reconnect_failed', onError);
-                socket.once('oox_connected', ({ name }) => {
-                    socket.offAny(onError);
-                    socket.data.name = name;
-                    resolve();
-                });
-            });
-        }
-        catch (error) {
-            throw new Error(error.message);
-        }
-        this.clientOnSocketConnection(socket);
-    }
-}

package/types/modules/socketio/client.d.ts

@@ -1,23 +0,0 @@
-import { ClientSocket as Socket } from './socket.js';
-import SocketIOServer from './server.js';
-export default class SocketIOCore extends SocketIOServer {
-    /**
-     * connect to <SocketIO RPC> service
-     */
-    connect(url: string): Promise<Socket>;
-    /**
-     * 客户端Socket连接事件
-     */
-    clientOnSocketConnection(socket: Socket): void;
-    clientOnDisconnect(socket: Socket, reason: any): void;
-    clientOnConnection(socket: Socket): void;
-    /**
-     * 客户端Socket断开事件
-     * @param {Socket} socket
-     */
-    clientOnSocketDisconnect(socket: Socket, reason: any): void;
-    /**
-     * 等待socket连接
-     */
-    clientWaitConnection(socket: Socket): Promise<void>;
-}