oox 0.3.2 → 0.3.4

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,8 @@
+export declare enum OOXEvent {
+    READY = "oox:ready",
+    ENABLED = "oox:enabled",
+    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/registry.d.ts

@@ -0,0 +1,16 @@
+import { KeepAliveConnection, KeepAliveConnectionData } from './keepalive-connection.js';
+export interface SyncConnectionsQuery {
+    name?: string | string[];
+}
+/**
+ * 服务器发送连接列表
+ * @param connection
+ * @param query
+ * @param callback
+ */
+export declare function onSyncConnections(connection: KeepAliveConnection<any>, query: SyncConnectionsQuery, callback: (datas: KeepAliveConnectionData[]) => void): void;
+/**
+ * 同步连接列表
+ * @param datas 连接参数列表
+ */
+export declare function syncConnections(datas: KeepAliveConnectionData[]): void;

package/types/samples/index.d.ts

@@ -0,0 +1 @@
+export { SampleKeepAliveConnectionAdapter, SampleKeepAliveNativeConnection } from './keepalive-connection-sample.js';

package/types/samples/keepalive-connection-sample.d.ts

@@ -0,0 +1,46 @@
+import * as oox from '../index.js';
+export interface SampleKeepAliveNativeConnection {
+    connected: boolean;
+    connect?(): void;
+    disconnect(): void;
+    on(event: string | symbol, listener: (...args: any[]) => void): any;
+    once(event: string | symbol, listener: (...args: any[]) => void): any;
+    off(event: string | symbol, listener?: (...args: any[]) => void): any;
+    emit(event: string | symbol, ...args: any[]): any;
+    removeAllListeners(event?: string | symbol): any;
+}
+export declare abstract class SampleKeepAliveConnectionAdapter<NativeConnection extends SampleKeepAliveNativeConnection> implements oox.KeepAliveConnectionAdapter<NativeConnection> {
+    name: string;
+    OOXEvent: {
+        READY: string;
+        ENABLED: string;
+        DISABLED: string;
+        SYNC_CONNECTIONS: string;
+    };
+    nativeEvent: {
+        CONNECT: string;
+        DISCONNECT: string;
+        ERROR: string;
+    };
+    abstract newConnection(url: string | URL): oox.KeepAliveConnection<NativeConnection>;
+    bindConnectionEvents(connection: oox.KeepAliveConnection<NativeConnection>): void;
+    open(url: string | URL): Promise<oox.KeepAliveConnection<NativeConnection>>;
+    close(connection: oox.KeepAliveConnection<NativeConnection>): Promise<void>;
+    /**
+     * 发送事件
+     * @param socket
+     * @param event
+     * @param params
+     */
+    emit(socket: NativeConnection, event: string, params: any[]): Promise<unknown>;
+    /**
+     * RPC
+     */
+    rpc(connection: oox.KeepAliveConnection<NativeConnection>, action: string, params: [], context?: oox.Context): Promise<any>;
+    /**
+     * 绑定 call 事件
+     * @param connection
+     */
+    bindCall(connection: oox.KeepAliveConnection<NativeConnection>): void;
+    call(action: string, params: any[], context: oox.Context, callback?: (returns: any) => void): Promise<oox.ReturnsBody>;
+}

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>;
-}