oox 0.3.4 → 0.3.5

package/types/modules/module.d.ts

@@ -1,11 +1,11 @@
-export declare class ModuleConfig {
-    enabled: boolean;
+export interface ModuleConfig {
+    enabled?: boolean;
 }
-export default class Module {
-    config: ModuleConfig;
-    name: string;
-    setConfig(config: any): void;
-    getConfig(): ModuleConfig;
-    serve(): Promise<void>;
-    stop(): Promise<void>;
+export default abstract class Module {
+    abstract config: ModuleConfig;
+    abstract name: string;
+    abstract setConfig(config: any): void;
+    abstract getConfig(): ModuleConfig;
+    abstract serve(): Promise<void>;
+    abstract stop(): Promise<void>;
 }

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

@@ -10,5 +10,5 @@ export default class SocketIOAdapter extends SampleKeepAliveConnectionAdapter<So
         DISCONNECT: string;
         ERROR: string;
     };
-    newConnection(url: string | URL): oox.KeepAliveConnection<Socket>;
+    newConnection(identify: string | URL | oox.KeepAliveConnectionData): oox.KeepAliveConnection<Socket>;
 }

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

@@ -5,7 +5,8 @@ import * as oox from '../../index.js';
 import { Module, ModuleConfig } from '../../index.js';
 import { Socket } from './socket.js';
 import SocketIOAdapter from './adapter.js';
-export declare class SocketIOConfig extends ModuleConfig {
+export declare class SocketIOConfig implements ModuleConfig {
+    enabled: boolean;
     port: number;
     path: string;
     origin: string | string[];
@@ -20,9 +21,10 @@ export default class SocketIOServer extends Module {
     #private;
     name: string;
     config: SocketIOConfig;
-    server: http.Server | https.Server;
-    socketServer: Server;
+    server: http.Server | https.Server | null;
+    socketServer: Server | null;
     adapter: SocketIOAdapter;
+    constructor();
     getURL(): URL;
     setConfig(config: SocketIOConfig): void;
     getConfig(): SocketIOConfig;

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

@@ -2,7 +2,9 @@ export declare enum OOXEvent {
     READY = "oox:ready",
     ENABLED = "oox:enabled",
     DISABLED = "oox:disabled",
-    SYNC_CONNECTIONS = "oox:sync_connections"
+    REGISTRY_SYNC_CONNECTIONS = "oox:registry:sync_connections",
+    REGISTRY_SUBSCRIBE = "oox:registry:subscribe",
+    REGISTRY_NOTIFY = "oox:registry:notify"
 }
 export declare function isWebSocketURL(url: string | URL): boolean;
 export declare function genWebSocketURL(url: string): URL;

package/types/registry.d.ts

@@ -1,16 +1,41 @@
-import { KeepAliveConnection, KeepAliveConnectionData } from './keepalive-connection.js';
+import { ReturnsBody } from './index.js';
+import { KeepAliveConnection, KeepAliveConnectionData, KeepAliveNativeConnection } from './keepalive-connection.js';
 export interface SyncConnectionsQuery {
     name?: string | string[];
 }
+/**
+ * 取消订阅连接列表
+ * @param connection
+ */
+export declare function unsubscribe(connection: KeepAliveConnection<KeepAliveNativeConnection>): void;
+/**
+ * 订阅连接列表
+ * @param connection
+ * @param query
+ * @returns
+ */
+export declare function subscribe(connection: KeepAliveConnection<KeepAliveNativeConnection>, query: SyncConnectionsQuery): void;
+/**
+ * 停止广播连接列表
+ */
+export declare function stopBroadcastTimer(): void;
+/**
+ * 开始广播连接列表
+ */
+export declare function startBroadcastTimer(): void;
+/**
+ * 广播连接列表
+ */
+export declare function broadcast(): void;
 /**
  * 服务器发送连接列表
  * @param connection
  * @param query
  * @param callback
  */
-export declare function onSyncConnections(connection: KeepAliveConnection<any>, query: SyncConnectionsQuery, callback: (datas: KeepAliveConnectionData[]) => void): void;
+export declare function onSyncConnections(connection: KeepAliveConnection<KeepAliveNativeConnection>, query: SyncConnectionsQuery, callback: (returns: ReturnsBody<KeepAliveConnectionData[]>) => void): void;
 /**
  * 同步连接列表
  * @param datas 连接参数列表
  */
-export declare function syncConnections(datas: KeepAliveConnectionData[]): void;
+export declare function syncConnections(returns: ReturnsBody<KeepAliveConnectionData[]>): void;

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

@@ -1,30 +1,39 @@
 import * as oox from '../index.js';
-export interface SampleKeepAliveNativeConnection {
+export interface SampleKeepAliveNativeConnection extends oox.KeepAliveNativeConnection {
     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;
+    on(event: string | symbol, listener: (...args: any[]) => any): any;
+    once(event: string | symbol, listener: (...args: any[]) => any): any;
+    off(event?: string | symbol, listener?: (...args: any[]) => any): 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;
+    abstract name: string;
     OOXEvent: {
         READY: string;
         ENABLED: string;
         DISABLED: string;
-        SYNC_CONNECTIONS: string;
+        REGISTRY_SYNC_CONNECTIONS: string;
+        REGISTRY_SUBSCRIBE: string;
+        REGISTRY_NOTIFY: string;
     };
     nativeEvent: {
         CONNECT: string;
         DISCONNECT: string;
         ERROR: string;
     };
-    abstract newConnection(url: string | URL): oox.KeepAliveConnection<NativeConnection>;
+    abstract newConnection(identify: string | URL | oox.KeepAliveConnectionData): oox.KeepAliveConnection<NativeConnection>;
+    /**
+     * 通知连接列表
+     */
+    ['registry:notify'](connection: oox.KeepAliveConnection<NativeConnection>, datas: oox.KeepAliveConnectionData[]): void;
+    /**
+     * 订阅连接列表
+     */
+    ['registry:subscribe'](connection: oox.KeepAliveConnection<NativeConnection>, query: oox.KeepAliveSyncConnectionsQuery): void;
     bindConnectionEvents(connection: oox.KeepAliveConnection<NativeConnection>): void;
-    open(url: string | URL): Promise<oox.KeepAliveConnection<NativeConnection>>;
+    open(identify: string | URL | oox.KeepAliveConnectionData): Promise<oox.KeepAliveConnection<NativeConnection>>;
     close(connection: oox.KeepAliveConnection<NativeConnection>): Promise<void>;
     /**
      * 发送事件
@@ -36,11 +45,11 @@ export declare abstract class SampleKeepAliveConnectionAdapter<NativeConnection
     /**
      * RPC
      */
-    rpc(connection: oox.KeepAliveConnection<NativeConnection>, action: string, params: [], context?: oox.Context): Promise<any>;
+    rpc(connection: oox.KeepAliveConnection<NativeConnection>, action: string, params: any[], context?: oox.KeepAliveRPCContext): 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>;
+    call(action: string, params: any[], context: oox.Context, callback?: (returns: any) => void): Promise<oox.ReturnsBody<any>>;
 }

package/utils.js

@@ -3,7 +3,7 @@ export function getIPAddress(version = 4) {
     const interfaces = networkInterfaces();
     const ip = [];
     for (const name of Object.keys(interfaces))
-        for (const intf of interfaces[name])
+        for (const intf of interfaces[name] || [])
             if (intf.mac !== '00:00:00:00:00:00')
                 if ((version !== 4 && version !== 6) || 'IPv' + version === intf.family)
                     ip.push(intf.address);