oox 0.3.0-beta9 → 0.3.1

package/types/index.d.ts

@@ -1,76 +1,78 @@
-/// <reference types="node" />
-import * as app from './app';
-import Module, { ModuleConfig } from './modules/module';
-import Modules from './modules';
-export { ReturnsBody } from './app';
-export { Module, ModuleConfig };
-export declare const modules: Modules;
-export declare const asyncStore: import("async_hooks").AsyncLocalStorage<app.Context>, setMethods: typeof app.setMethods, getMethods: typeof app.getMethods, kvMethods: Map<string, Function>, sourceKVMethods: Map<string, Function>, call: typeof app.call, execute: typeof app.execute, logger: typeof app.logger, on: typeof app.on, once: typeof app.once, off: typeof app.off, emit: typeof app.emit;
-export declare class Context extends app.Context {
-    sourceIP: string;
-    ip: string;
-    caller: string;
-    callerId: string;
-    connection?: RPCKeepAliveConnection;
-    toJSON?(): {} & this;
-}
-export declare class Config {
-    [x: string]: any;
-    name: string;
-    entryFile: {
-        path: string;
-        group: string;
-    };
-    host: string;
-    port: number;
-    origin: string;
-}
-export declare const config: Config;
-export declare function setGenTraceIdFunction(fn: () => string): void;
-/**
- * 生成随机不重复id
- */
-export declare function genTraceId(): string;
-/**
- * 获取链路跟踪上下文
- */
-export declare function genContext(context?: Context): Context;
-export declare function getContext(): Context;
-export declare function serve(): Promise<void>;
-export declare function stop(): Promise<void>;
-export interface RPCConnectionAdapter {
-    rpc(connection: any, action: string, params: any[], context: Context): Promise<any>;
-}
-export interface RPCKeepAliveConnectionData {
-    /**
-     * 是否连接成功
-     */
-    connected: boolean;
-    /**
-     * 连接主机地址
-     */
-    host: string;
-    /**
-     * 连接服务名称
-     */
-    name: string;
-    /**
-     * 目标服务网络唯一ID
-     */
-    id: string;
-}
-export declare class RPCKeepAliveConnection {
-    data: RPCKeepAliveConnectionData;
-    nativeConnection: any;
-    adapter: RPCConnectionAdapter;
-    constructor(adapter: RPCConnectionAdapter, nativeConnection: any, data?: RPCKeepAliveConnectionData);
-}
-export declare const keepAliveConnections: Map<string, Map<string, RPCKeepAliveConnection>>;
-export declare function getKeepAliveConnections(name: string): Map<string, RPCKeepAliveConnection>;
-export declare function getKeepAliveConnection(name: string, id: string): RPCKeepAliveConnection | null;
-export declare function addKeepAliveConnection(connection: RPCKeepAliveConnection): void;
-export declare function removeKeepAliveConnection(connection: RPCKeepAliveConnection): void;
-export declare function removeKeepAliveConnection(name: string, id: string): void;
-export declare function setLoadBalancePolicy(policy: (name: string) => RPCKeepAliveConnection): void;
-export declare function rpc(appName: string, action: string, params: any[], context?: Context): Promise<any>;
-export declare function rpc(connection: RPCKeepAliveConnection, action: string, params: any[], context?: Context): Promise<any>;
+import * as app from './app.js';
+import Module, { ModuleConfig } from './modules/module.js';
+import Modules from './modules/index.js';
+export { ReturnsBody } from './app.js';
+export { Module, ModuleConfig };
+export declare const modules: Modules;
+export declare const asyncStore: import("async_hooks").AsyncLocalStorage<app.Context>, setMethods: typeof app.setMethods, getMethods: typeof app.getMethods, kvMethods: Map<string, Function>, sourceKVMethods: Map<string, Function>, call: typeof app.call, execute: typeof app.execute, logger: typeof app.logger, on: typeof app.on, once: typeof app.once, off: typeof app.off, emit: typeof app.emit;
+export declare class Context extends app.Context {
+    sourceIP: string;
+    ip: string;
+    caller: string;
+    callerId: string;
+    connection?: RPCKeepAliveConnection;
+    toJSON?(): {} & this;
+}
+export declare class Config {
+    [x: string]: any;
+    name: string;
+    group: string;
+    ignore: string[];
+    entryInfo: {
+        path: string;
+        group: string;
+    };
+    host: string;
+    port: number;
+    origin: string;
+    errorStack: boolean;
+}
+export declare const config: Config;
+export declare function setGenTraceIdFunction(fn: () => string): void;
+/**
+ * 生成随机不重复id
+ */
+export declare function genTraceId(): string;
+/**
+ * 获取链路跟踪上下文
+ */
+export declare function genContext(context?: Context): Context;
+export declare function getContext(): Context;
+export declare function serve(): Promise<void>;
+export declare function stop(): Promise<void>;
+export interface RPCConnectionAdapter {
+    rpc(connection: any, action: string, params: any[], context: Context): Promise<any>;
+}
+export interface RPCKeepAliveConnectionData {
+    /**
+     * 是否连接成功
+     */
+    connected: boolean;
+    /**
+     * 连接主机地址
+     */
+    host: string;
+    /**
+     * 连接服务名称
+     */
+    name: string;
+    /**
+     * 目标服务网络唯一ID
+     */
+    id: string;
+}
+export declare class RPCKeepAliveConnection {
+    data: RPCKeepAliveConnectionData;
+    nativeConnection: any;
+    adapter: RPCConnectionAdapter;
+    constructor(adapter: RPCConnectionAdapter, nativeConnection: any, data?: RPCKeepAliveConnectionData);
+}
+export declare const keepAliveConnections: Map<string, Map<string, RPCKeepAliveConnection>>;
+export declare function getKeepAliveConnections(name: string): Map<string, RPCKeepAliveConnection>;
+export declare function getKeepAliveConnection(name: string, id: string): RPCKeepAliveConnection | null;
+export declare function addKeepAliveConnection(connection: RPCKeepAliveConnection): void;
+export declare function removeKeepAliveConnection(connection: RPCKeepAliveConnection): void;
+export declare function removeKeepAliveConnection(name: string, id: string): void;
+export declare function setLoadBalancePolicy(policy: (name: string) => RPCKeepAliveConnection): void;
+export declare function rpc(appName: string, action: string, params: any[], context?: Context): Promise<any>;
+export declare function rpc(connection: RPCKeepAliveConnection, action: string, params: any[], context?: Context): Promise<any>;

package/types/logger.d.ts

@@ -1,4 +1,5 @@
-export declare function info(...msgs: any[]): void;
-export declare function warn(...msgs: any[]): void;
-export declare function error(...msgs: any[]): void;
-export declare function trace(name?: string): void;
+export declare function info(...content: any[]): void;
+export declare function warn(...content: any[]): void;
+export declare function error(...content: any[]): void;
+export declare function tag(name: string): void;
+export declare function trace(name?: string): void;

package/types/modules/http/index.d.ts

@@ -1,47 +1,58 @@
-/// <reference types="node" />
-import * as http from 'node:http';
-import * as oox from '../../index';
-import Module, { ModuleConfig } from '../module';
-export declare class HTTPConfig extends ModuleConfig {
-    port: number;
-    path: string;
-    origin: string;
-}
-export default class HTTPModule extends Module {
-    name: string;
-    config: HTTPConfig;
-    server: http.Server;
-    setConfig(config: HTTPConfig): void;
-    getConfig(): HTTPConfig;
-    /**
-     * start http service
-     */
-    serve(): Promise<void>;
-    /**
-     * stop http service
-     */
-    stop(): Promise<void>;
-    /**
-     * browser cross origin
-     */
-    cors(request: http.IncomingMessage, response: http.ServerResponse): boolean;
-    /**
-     * HTTP-RPC服务器请求监听方法
-     */
-    call(request: http.IncomingMessage, response: http.ServerResponse): Promise<void>;
-    /**
-     * HTTP Response Catch
-     */
-    respond(request: http.IncomingMessage, response: http.ServerResponse, format: {
-        body?: any;
-        success: boolean;
-        error?: {
-            message: any;
-            stack: any;
-        };
-    }): void;
-    /**
-     * HTTP RPC
-     */
-    rpc(url: string | URL, action: string, params: Array<any>, context?: oox.Context): Promise<any>;
-}
+import * as http from 'node:http';
+import * as oox from '../../index.js';
+import Module, { ModuleConfig } from '../module.js';
+export declare class HTTPConfig extends ModuleConfig {
+    port: number;
+    path: string;
+    origin: string;
+    ssl: {
+        enabled: boolean;
+        cert: string;
+        key: string;
+        ca: string;
+    };
+}
+export default class HTTPModule extends Module {
+    name: string;
+    config: HTTPConfig;
+    server: http.Server;
+    getUrl(): string;
+    setConfig(config: HTTPConfig): void;
+    getConfig(): HTTPConfig;
+    /**
+     * start http service
+     */
+    serve(): Promise<void>;
+    /**
+     * stop http service
+     */
+    stop(): Promise<void>;
+    /**
+     * browser cross origin
+     */
+    cors(request: http.IncomingMessage, response: http.ServerResponse): boolean;
+    requestHandler(request: http.IncomingMessage, response: http.ServerResponse): Promise<void>;
+    /**
+     * 从请求里获取调用的接口和参数
+     */
+    getCallArgsFromRequest(request: http.IncomingMessage): Promise<any>;
+    /**
+     * HTTP-RPC服务器请求监听方法
+     */
+    call(request: http.IncomingMessage, response: http.ServerResponse): Promise<void>;
+    /**
+     * HTTP Response Catch
+     */
+    respond(_request: http.IncomingMessage, response: http.ServerResponse, returns: {
+        body?: any;
+        success: boolean;
+        error?: {
+            message: any;
+            stack?: any;
+        };
+    }): void;
+    /**
+     * HTTP RPC
+     */
+    rpc(url: string | URL, action: string, params: Array<any>, context?: oox.Context): Promise<any>;
+}

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

@@ -1,17 +1,14 @@
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
-import * as http from 'node:http';
-import { Readable } from 'node:stream';
-/**
- * Stream => Buffer
- */
-export declare function stream2buffer(stream: Readable, totalLength?: number): Promise<Buffer>;
-/**
- * Request => JSONObject
- */
-export declare function parseHTTPBody(request: http.IncomingMessage): Promise<any>;
-/**
- * http request
- */
-export declare function httpRequest(url: URL | string, options: http.RequestOptions, body: string): Promise<any>;
+import * as http from 'node:http';
+import { Readable } from 'node:stream';
+/**
+ * Stream => Buffer
+ */
+export declare function stream2buffer(stream: Readable, totalLength?: number): Promise<Buffer>;
+/**
+ * Request => JSONObject
+ */
+export declare function parseHTTPBody(request: http.IncomingMessage): Promise<any>;
+/**
+ * http request
+ */
+export declare function httpRequest(url: URL | string, options: http.RequestOptions, body: string): Promise<any>;

package/types/modules/index.d.ts

@@ -1,24 +1,24 @@
-import Module from './module';
-import HTTP from './http';
-import SocketIO from './socketio';
-export default class Modules extends Module {
-    #private;
-    /**
-     * the module unique name
-     */
-    name: string;
-    /**
-     * all builtin modules
-     */
-    builtins: {
-        http: HTTP;
-        socketio: SocketIO;
-    };
-    constructor();
-    add(module: Module): this;
-    get(name: string): Module;
-    remove(name: string): Promise<void>;
-    setConfig(config: any): void;
-    serve(): Promise<void>;
-    stop(): Promise<void>;
-}
+import Module from './module.js';
+import HTTP from './http/index.js';
+import SocketIO from './socketio/index.js';
+export default class Modules extends Module {
+    #private;
+    /**
+     * the module unique name
+     */
+    name: string;
+    /**
+     * all builtin modules
+     */
+    builtins: {
+        http: HTTP;
+        socketio: SocketIO;
+    };
+    constructor();
+    add(module: Module): this;
+    get(name: string): Module;
+    remove(name: string): Promise<void>;
+    setConfig(config: any): void;
+    serve(): Promise<void>;
+    stop(): Promise<void>;
+}

package/types/modules/module.d.ts

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

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

@@ -1,23 +1,23 @@
-import { ClientSocket as Socket } from './socket';
-import SocketIOServer from './server';
-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>;
-}
+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>;
+}

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

@@ -1,37 +1,37 @@
-import SocketIOClient from './client';
-import * as oox from '../../index';
-import { RPCKeepAliveConnectionData, RPCConnectionAdapter } from '../../index';
-import { Socket, sockets, ServerSocket, ClientSocket } from './socket';
-export { Socket, sockets };
-export default class SocketIOModule extends SocketIOClient implements RPCConnectionAdapter {
-    sockets: Map<string, Socket>;
-    serve(): Promise<void>;
-    onSyncConnection(socket: Socket): oox.RPCKeepAliveConnectionData[];
-    serverOnDisconnect(socket: ServerSocket, reason: string): void;
-    clientOnDisconnect(socket: ClientSocket, reason: any): void;
-    /**
-     *
-     * @param socket 是由哪个通道发送过来的
-     * @param connectionDatas
-     */
-    clientOnSyncConnection(socket: Socket, connectionDatas: RPCKeepAliveConnectionData[]): void;
-    onFetchActions(socket: Socket, search: string): string[];
-    fetchActions(url: string, search?: string): Promise<RPCKeepAliveConnectionData[]>;
-    fetchActions(name: string, search?: string): Promise<RPCKeepAliveConnectionData[]>;
-    onConnection(socket: Socket): void;
-    /**
-     *
-     * @param {Socket} socket
-     */
-    serverOnConnection(socket: ServerSocket): void;
-    call(action: string, params: any[], context: oox.Context, callback?: (returns: any) => void): Promise<oox.ReturnsBody>;
-    clientOnConnection(socket: ClientSocket): void;
-    /**
-     * socketio emit
-     */
-    emit(url: string, action: string, params: any[]): Promise<unknown>;
-    /**
-     * RPC
-     */
-    rpc(url: string, action: string, params: [], context?: oox.Context): Promise<any>;
-}
+import SocketIOClient from './client.js';
+import * as oox from '../../index.js';
+import { RPCKeepAliveConnectionData, RPCConnectionAdapter } from '../../index.js';
+import { Socket, sockets, ServerSocket, ClientSocket } from './socket.js';
+export { Socket, sockets };
+export default class SocketIOModule extends SocketIOClient implements RPCConnectionAdapter {
+    sockets: Map<string, Socket>;
+    serve(): Promise<void>;
+    onSyncConnection(socket: Socket): oox.RPCKeepAliveConnectionData[];
+    serverOnDisconnect(socket: ServerSocket, reason: string): void;
+    clientOnDisconnect(socket: ClientSocket, reason: any): void;
+    /**
+     *
+     * @param socket 是由哪个通道发送过来的
+     * @param connectionDatas
+     */
+    clientOnSyncConnection(socket: Socket, connectionDatas: RPCKeepAliveConnectionData[]): void;
+    onFetchActions(socket: Socket, search: string): string[];
+    fetchActions(url: string, search?: string): Promise<RPCKeepAliveConnectionData[]>;
+    fetchActions(name: string, search?: string): Promise<RPCKeepAliveConnectionData[]>;
+    onConnection(socket: Socket): void;
+    /**
+     *
+     * @param {Socket} socket
+     */
+    serverOnConnection(socket: ServerSocket): void;
+    call(action: string, params: any[], context: oox.Context, callback?: (returns: any) => void): Promise<oox.ReturnsBody>;
+    clientOnConnection(socket: ClientSocket): void;
+    /**
+     * socketio emit
+     */
+    emit(url: string, event: string, params: any[]): Promise<unknown>;
+    /**
+     * RPC
+     */
+    rpc(url: string, action: string, params: [], context?: oox.Context): Promise<any>;
+}

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

@@ -1,35 +1,44 @@
-/// <reference types="node" />
-import * as http from 'node:http';
-import { Server, ServerOptions } from 'socket.io';
-import { Module, ModuleConfig } from '../../index';
-import { ServerSocket as Socket } from './socket';
-export declare class SocketIOConfig extends ModuleConfig {
-    port: number;
-    path: string;
-    origin: string;
-}
-export default class SocketIOServer extends Module {
-    #private;
-    name: string;
-    config: SocketIOConfig;
-    server: http.Server;
-    socketServer: Server;
-    setConfig(config: SocketIOConfig): void;
-    getConfig(): SocketIOConfig;
-    serve(): Promise<void>;
-    stop(): Promise<void>;
-    genSocketIOServerOptions(): Partial<ServerOptions>;
-    createSocketIOServer(): void;
-    /**
-     * 服务端Socket连接事件
-     */
-    serverOnSocketConnection(socket: Socket): void;
-    serverOnConnection(socket: Socket): void;
-    /**
-     * 服务端Socket断开事件
-     * @param {Socket} socket
-     * @param {Error} reason
-     */
-    serverOnSocketDisconnect(socket: Socket, reason: string): void;
-    serverOnDisconnect(socket: Socket, reason: string): void;
-}
+import * as http from 'node:http';
+import * as https from 'node:https';
+import { Server, ServerOptions } from 'socket.io';
+import { Module, ModuleConfig } from '../../index.js';
+import { ServerSocket as Socket } from './socket.js';
+export declare class SocketIOConfig extends ModuleConfig {
+    port: number;
+    path: string;
+    origin: string;
+    ssl: {
+        enabled: boolean;
+        cert: string;
+        key: string;
+        ca: string;
+    };
+}
+export default class SocketIOServer extends Module {
+    #private;
+    name: string;
+    config: SocketIOConfig;
+    server: http.Server | https.Server;
+    socketServer: Server;
+    static isWebSocketUrl(url: string): boolean;
+    static genWebSocketUrl(url: string): string;
+    getUrl(): string;
+    setConfig(config: SocketIOConfig): void;
+    getConfig(): SocketIOConfig;
+    serve(): Promise<void>;
+    stop(): Promise<void>;
+    genSocketIOServerOptions(): Partial<ServerOptions>;
+    createSocketIOServer(): void;
+    /**
+     * 服务端Socket连接事件
+     */
+    serverOnSocketConnection(socket: Socket): void;
+    serverOnConnection(socket: Socket): void;
+    /**
+     * 服务端Socket断开事件
+     * @param {Socket} socket
+     * @param {Error} reason
+     */
+    serverOnSocketDisconnect(socket: Socket, reason: string): void;
+    serverOnDisconnect(socket: Socket, reason: string): void;
+}

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

@@ -1,11 +1,11 @@
-import { Socket as _ServerSocket } from 'socket.io';
-import { Socket as _ClientSocket } from 'socket.io-client';
-import { RPCKeepAliveConnectionData } from '../../index';
-export interface ServerSocket extends _ServerSocket {
-    data: RPCKeepAliveConnectionData;
-}
-export interface ClientSocket extends _ClientSocket {
-    data: RPCKeepAliveConnectionData;
-}
-export declare 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';
+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>;

package/types/utils.d.ts

@@ -1,6 +1,6 @@
-export declare function getIPAddress(version?: number): string[];
-export declare function getAllCallablePropertyNames(obj: any): string[];
-export declare function genKVMethods(methods: any, kvMethods?: Map<string, Function>, sourceKVMethods?: Map<string, Function>, nameStack?: string[]): {
-    kvMethods: Map<string, Function>;
-    sourceKVMethods: Map<string, Function>;
-};
+export declare function getIPAddress(version?: number): string[];
+export declare function getAllCallablePropertyNames(obj: any): string[];
+export declare function genKVMethods(methods: any, kvMethods?: Map<string, Function>, sourceKVMethods?: Map<string, Function>, nameStack?: string[]): {
+    kvMethods: Map<string, Function>;
+    sourceKVMethods: Map<string, Function>;
+};