oox 0.3.0-beta1 → 0.3.0-beta2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/modules/module.js CHANGED
@@ -1,16 +1,16 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.ModuleConfig = void 0;
4
- class ModuleConfig {
5
- disabled = false;
6
- }
7
- exports.ModuleConfig = ModuleConfig;
8
- class Module {
9
- config;
10
- name;
11
- setConfig(config) { }
12
- getConfig() { return this.config; }
13
- async serve() { }
14
- async stop() { }
15
- }
16
- exports.default = Module;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ModuleConfig = void 0;
4
+ class ModuleConfig {
5
+ disabled = false;
6
+ }
7
+ exports.ModuleConfig = ModuleConfig;
8
+ class Module {
9
+ config;
10
+ name;
11
+ setConfig(config) { }
12
+ getConfig() { return this.config; }
13
+ async serve() { }
14
+ async stop() { }
15
+ }
16
+ exports.default = Module;
package/package.json CHANGED
@@ -1,9 +1,10 @@
1
1
  {
2
2
  "name": "oox",
3
- "version": "0.3.0-beta1",
3
+ "version": "0.3.0-beta2",
4
4
  "description": "Graceful NodeJS distributed application solution",
5
5
  "keywords": [
6
6
  "http",
7
+ "websocket",
7
8
  "socket.io",
8
9
  "rpc",
9
10
  "microservice",
@@ -25,9 +26,8 @@
25
26
  "homepage": "https://github.com/lipingruan/oox",
26
27
  "license": "MIT",
27
28
  "dependencies": {
28
- "chalk": "^4.1.0",
29
- "socket.io": "^4.4.0",
30
- "socket.io-client": "^4.4.0"
29
+ "@oox/module-socketio": "^0.0.1",
30
+ "chalk": "^4.1.0"
31
31
  },
32
32
  "engines": {
33
33
  "node": ">=12.0.0"
package/types/app.d.ts CHANGED
@@ -1,37 +1,37 @@
1
- /// <reference types="node" />
2
- /// <reference types="node" />
3
- import { EventEmitter } from 'node:events';
4
- import { AsyncLocalStorage } from 'node:async_hooks';
5
- export interface ReturnsBody {
6
- traceId: string;
7
- success: boolean;
8
- body?: any;
9
- error?: {
10
- message: string;
11
- stack: string;
12
- };
13
- }
14
- export declare class Context {
15
- traceId?: string;
16
- }
17
- export declare const asyncStore: AsyncLocalStorage<Context>;
18
- export declare const eventHub: EventEmitter;
19
- /**
20
- * the kvMethods is all actions refs [has bind this]
21
- */
22
- export declare const kvMethods: Map<string, Function>;
23
- export declare const sourceKVMethods: Map<string, Function>;
24
- export declare function setMethods(methods: any): void;
25
- export declare function getMethods(): any;
26
- export declare function on(event: 'request', listener: (action: string, params: any[], context: Context) => void): void;
27
- export declare function on(event: 'success', listener: (action: string, params: any[], context: Context, result: ReturnsBody) => void): void;
28
- export declare function on(event: 'fail', listener: (action: string, params: any[], context: Context, error: Error) => void): void;
29
- /**
30
- * Call an Function on RPC server
31
- * @param action
32
- * @param params
33
- * @param context
34
- * @returns
35
- */
36
- export declare function call(action: string, params: any[], context: Context): Promise<ReturnsBody>;
37
- export declare function execute(action: string, params: Array<any>, context: Context): Promise<any>;
1
+ /// <reference types="node" />
2
+ /// <reference types="node" />
3
+ import { EventEmitter } from 'node:events';
4
+ import { AsyncLocalStorage } from 'node:async_hooks';
5
+ export interface ReturnsBody {
6
+ traceId: string;
7
+ success: boolean;
8
+ body?: any;
9
+ error?: {
10
+ message: string;
11
+ stack: string;
12
+ };
13
+ }
14
+ export declare class Context {
15
+ traceId?: string;
16
+ }
17
+ export declare const asyncStore: AsyncLocalStorage<Context>;
18
+ export declare const eventHub: EventEmitter;
19
+ /**
20
+ * the kvMethods is all actions refs [has bind this]
21
+ */
22
+ export declare const kvMethods: Map<string, Function>;
23
+ export declare const sourceKVMethods: Map<string, Function>;
24
+ export declare function setMethods(methods: any): void;
25
+ export declare function getMethods(): any;
26
+ export declare function on(event: 'request', listener: (action: string, params: any[], context: Context) => void): void;
27
+ export declare function on(event: 'success', listener: (action: string, params: any[], context: Context, result: ReturnsBody) => void): void;
28
+ export declare function on(event: 'fail', listener: (action: string, params: any[], context: Context, error: Error) => void): void;
29
+ /**
30
+ * Call an Function on RPC server
31
+ * @param action
32
+ * @param params
33
+ * @param context
34
+ * @returns
35
+ */
36
+ export declare function call(action: string, params: any[], context: Context): Promise<ReturnsBody>;
37
+ export declare function execute(action: string, params: Array<any>, context: Context): Promise<any>;
@@ -1,8 +1,8 @@
1
- export declare function getAllEnvArgs(): {
2
- [x: string]: any;
3
- };
4
- export declare function getEnvArgs(names: string[]): {
5
- [x: string]: any;
6
- };
7
- export declare function getEnvArg(name: string): any;
8
- export declare function parseEnvArg(value: string): any;
1
+ export declare function getAllEnvArgs(): {
2
+ [x: string]: any;
3
+ };
4
+ export declare function getEnvArgs(names: string[]): {
5
+ [x: string]: any;
6
+ };
7
+ export declare function getEnvArg(name: string): any;
8
+ export declare function parseEnvArg(value: string): any;
@@ -1,2 +1,2 @@
1
- #! /usr/bin/env node
2
- export {};
1
+ #! /usr/bin/env node
2
+ export {};
@@ -1 +1 @@
1
- export declare function configure(): any;
1
+ export declare function configure(): any;
@@ -1 +1 @@
1
- export declare function proxyGroup(groupDirectory: string, excludes?: any[]): void;
1
+ export declare function proxyGroup(groupDirectory: string, excludes?: any[]): void;
@@ -1 +1 @@
1
- export declare function registry(urls: string | string[]): Promise<void>;
1
+ export declare function registry(urls: string | string[]): Promise<void>;
@@ -1 +1 @@
1
- export declare function startup(): Promise<void>;
1
+ export declare function startup(): Promise<void>;
package/types/index.d.ts CHANGED
@@ -1,70 +1,70 @@
1
- /// <reference types="node" />
2
- import * as app from './app';
3
- import Module, { ModuleConfig } from './modules/module';
4
- import Modules from './modules';
5
- export { ReturnsBody } from './app';
6
- export { Module, ModuleConfig };
7
- export declare const modules: Modules;
8
- 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, on: typeof app.on;
9
- export declare class Context extends app.Context {
10
- sourceIP: string;
11
- ip: string;
12
- caller: string;
13
- callerId: string;
14
- connection?: RPCKeepAliveConnection;
15
- toJSON?(): string;
16
- }
17
- export declare class Config {
18
- [x: string]: any;
19
- name: string;
20
- host: string;
21
- }
22
- export declare const config: Config;
23
- export declare function getConfig(): void;
24
- export declare function setGenTraceIdFunction(fn: () => string): void;
25
- /**
26
- * 生成随机不重复id
27
- */
28
- export declare function genTraceId(): string;
29
- /**
30
- * 获取链路跟踪上下文
31
- */
32
- export declare function genContext(context?: Context): Context;
33
- export declare function getContext(): Context;
34
- export declare function serve(): Promise<void>;
35
- export declare function stop(): Promise<void>;
36
- export interface RPCConnectionAdapter {
37
- rpc(connection: any, action: string, params: any[], context: Context): Promise<any>;
38
- }
39
- export interface RPCKeepAliveConnectionData {
40
- /**
41
- * 是否连接成功
42
- */
43
- connected: boolean;
44
- /**
45
- * 连接主机地址
46
- */
47
- host: string;
48
- /**
49
- * 连接服务名称
50
- */
51
- name: string;
52
- /**
53
- * 目标服务网络唯一ID
54
- */
55
- id: string;
56
- }
57
- export declare class RPCKeepAliveConnection {
58
- data: RPCKeepAliveConnectionData;
59
- nativeConnection: any;
60
- adapter: RPCConnectionAdapter;
61
- constructor(adapter: RPCConnectionAdapter, nativeConnection: any, data?: RPCKeepAliveConnectionData);
62
- }
63
- export declare const keepAliveConnections: Map<string, Map<string, RPCKeepAliveConnection>>;
64
- export declare function getKeepAliveConnections(name: string): Map<string, RPCKeepAliveConnection>;
65
- export declare function getKeepAliveConnection(name: string, id: string): RPCKeepAliveConnection | null;
66
- export declare function addKeepAliveConnection(connection: RPCKeepAliveConnection): void;
67
- export declare function removeKeepAliveConnection(connection: RPCKeepAliveConnection): void;
68
- export declare function removeKeepAliveConnection(name: string, id: string): void;
69
- export declare function rpc(appName: string, action: string, params: any[], context?: Context): Promise<any>;
70
- export declare function rpc(connection: RPCKeepAliveConnection, action: string, params: any[], context?: Context): Promise<any>;
1
+ /// <reference types="node" />
2
+ import * as app from './app';
3
+ import Module, { ModuleConfig } from './modules/module';
4
+ import Modules from './modules';
5
+ export { ReturnsBody } from './app';
6
+ export { Module, ModuleConfig };
7
+ export declare const modules: Modules;
8
+ 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, on: typeof app.on;
9
+ export declare class Context extends app.Context {
10
+ sourceIP: string;
11
+ ip: string;
12
+ caller: string;
13
+ callerId: string;
14
+ connection?: RPCKeepAliveConnection;
15
+ toJSON?(): string;
16
+ }
17
+ export declare class Config {
18
+ [x: string]: any;
19
+ name: string;
20
+ host: string;
21
+ }
22
+ export declare const config: Config;
23
+ export declare function getConfig(): void;
24
+ export declare function setGenTraceIdFunction(fn: () => string): void;
25
+ /**
26
+ * 生成随机不重复id
27
+ */
28
+ export declare function genTraceId(): string;
29
+ /**
30
+ * 获取链路跟踪上下文
31
+ */
32
+ export declare function genContext(context?: Context): Context;
33
+ export declare function getContext(): Context;
34
+ export declare function serve(): Promise<void>;
35
+ export declare function stop(): Promise<void>;
36
+ export interface RPCConnectionAdapter {
37
+ rpc(connection: any, action: string, params: any[], context: Context): Promise<any>;
38
+ }
39
+ export interface RPCKeepAliveConnectionData {
40
+ /**
41
+ * 是否连接成功
42
+ */
43
+ connected: boolean;
44
+ /**
45
+ * 连接主机地址
46
+ */
47
+ host: string;
48
+ /**
49
+ * 连接服务名称
50
+ */
51
+ name: string;
52
+ /**
53
+ * 目标服务网络唯一ID
54
+ */
55
+ id: string;
56
+ }
57
+ export declare class RPCKeepAliveConnection {
58
+ data: RPCKeepAliveConnectionData;
59
+ nativeConnection: any;
60
+ adapter: RPCConnectionAdapter;
61
+ constructor(adapter: RPCConnectionAdapter, nativeConnection: any, data?: RPCKeepAliveConnectionData);
62
+ }
63
+ export declare const keepAliveConnections: Map<string, Map<string, RPCKeepAliveConnection>>;
64
+ export declare function getKeepAliveConnections(name: string): Map<string, RPCKeepAliveConnection>;
65
+ export declare function getKeepAliveConnection(name: string, id: string): RPCKeepAliveConnection | null;
66
+ export declare function addKeepAliveConnection(connection: RPCKeepAliveConnection): void;
67
+ export declare function removeKeepAliveConnection(connection: RPCKeepAliveConnection): void;
68
+ export declare function removeKeepAliveConnection(name: string, id: string): void;
69
+ export declare function rpc(appName: string, action: string, params: any[], context?: Context): Promise<any>;
70
+ export declare function rpc(connection: RPCKeepAliveConnection, action: string, params: any[], context?: Context): Promise<any>;
@@ -1,47 +1,47 @@
1
- /// <reference types="node" />
2
- import * as http from 'node:http';
3
- import * as oox from '../../index';
4
- import Module, { ModuleConfig } from '../module';
5
- export declare class HTTPConfig extends ModuleConfig {
6
- port: number;
7
- path: string;
8
- origin: string;
9
- }
10
- export default class HTTPModule extends Module {
11
- name: string;
12
- config: HTTPConfig;
13
- server: http.Server;
14
- setConfig(config: HTTPConfig): void;
15
- getConfig(): HTTPConfig;
16
- /**
17
- * start http service
18
- */
19
- serve(): Promise<void>;
20
- /**
21
- * stop http service
22
- */
23
- stop(): Promise<void>;
24
- /**
25
- * browser cross origin
26
- */
27
- cors(request: http.IncomingMessage, response: http.ServerResponse): boolean;
28
- /**
29
- * HTTP-RPC服务器请求监听方法
30
- */
31
- call(request: http.IncomingMessage, response: http.ServerResponse): Promise<void>;
32
- /**
33
- * HTTP Response Catch
34
- */
35
- respond(request: http.IncomingMessage, response: http.ServerResponse, format: {
36
- body?: any;
37
- success: boolean;
38
- error?: {
39
- message: any;
40
- stack: any;
41
- };
42
- }): void;
43
- /**
44
- * HTTP RPC
45
- */
46
- rpc(url: string | URL, action: string, params: Array<any>, context?: oox.Context): Promise<any>;
47
- }
1
+ /// <reference types="node" />
2
+ import * as http from 'node:http';
3
+ import * as oox from '../../index';
4
+ import Module, { ModuleConfig } from '../module';
5
+ export declare class HTTPConfig extends ModuleConfig {
6
+ port: number;
7
+ path: string;
8
+ origin: string;
9
+ }
10
+ export default class HTTPModule extends Module {
11
+ name: string;
12
+ config: HTTPConfig;
13
+ server: http.Server;
14
+ setConfig(config: HTTPConfig): void;
15
+ getConfig(): HTTPConfig;
16
+ /**
17
+ * start http service
18
+ */
19
+ serve(): Promise<void>;
20
+ /**
21
+ * stop http service
22
+ */
23
+ stop(): Promise<void>;
24
+ /**
25
+ * browser cross origin
26
+ */
27
+ cors(request: http.IncomingMessage, response: http.ServerResponse): boolean;
28
+ /**
29
+ * HTTP-RPC服务器请求监听方法
30
+ */
31
+ call(request: http.IncomingMessage, response: http.ServerResponse): Promise<void>;
32
+ /**
33
+ * HTTP Response Catch
34
+ */
35
+ respond(request: http.IncomingMessage, response: http.ServerResponse, format: {
36
+ body?: any;
37
+ success: boolean;
38
+ error?: {
39
+ message: any;
40
+ stack: any;
41
+ };
42
+ }): void;
43
+ /**
44
+ * HTTP RPC
45
+ */
46
+ rpc(url: string | URL, action: string, params: Array<any>, context?: oox.Context): Promise<any>;
47
+ }
@@ -1,17 +1,17 @@
1
- /// <reference types="node" />
2
- /// <reference types="node" />
3
- /// <reference types="node" />
4
- import * as http from 'node:http';
5
- import * as stream from 'node:stream';
6
- /**
7
- * Stream => Buffer
8
- */
9
- export declare function stream2buffer(stream: stream.Readable, totalLength?: number): Promise<Buffer>;
10
- /**
11
- * Request => JSONObject
12
- */
13
- export declare function parseHTTPBody(request: http.IncomingMessage): Promise<any>;
14
- /**
15
- * http request
16
- */
17
- export declare function httpRequest(url: URL | string, options: http.RequestOptions, body: string): Promise<any>;
1
+ /// <reference types="node" />
2
+ /// <reference types="node" />
3
+ /// <reference types="node" />
4
+ import * as http from 'node:http';
5
+ import * as stream from 'node:stream';
6
+ /**
7
+ * Stream => Buffer
8
+ */
9
+ export declare function stream2buffer(stream: stream.Readable, totalLength?: number): Promise<Buffer>;
10
+ /**
11
+ * Request => JSONObject
12
+ */
13
+ export declare function parseHTTPBody(request: http.IncomingMessage): Promise<any>;
14
+ /**
15
+ * http request
16
+ */
17
+ export declare function httpRequest(url: URL | string, options: http.RequestOptions, body: string): Promise<any>;
@@ -1,23 +1,21 @@
1
- import Module from './module';
2
- import HTTP from './http';
3
- import SocketIO from './socketio';
4
- export default class Modules extends Module {
5
- #private;
6
- /**
7
- * the module unique name
8
- */
9
- name: string;
10
- /**
11
- * all builtin modules
12
- */
13
- builtins: {
14
- http: HTTP;
15
- socketio: SocketIO;
16
- };
17
- constructor();
18
- add(module: Module): this;
19
- get(name: string): Module;
20
- remove(name: string): Promise<void>;
21
- serve(): Promise<void>;
22
- stop(): Promise<void>;
23
- }
1
+ import Module from './module';
2
+ import HTTP from './http';
3
+ export default class Modules extends Module {
4
+ #private;
5
+ /**
6
+ * the module unique name
7
+ */
8
+ name: string;
9
+ /**
10
+ * all builtin modules
11
+ */
12
+ builtins: {
13
+ http: HTTP;
14
+ };
15
+ constructor();
16
+ add(module: Module): this;
17
+ get(name: string): Module;
18
+ remove(name: string): Promise<void>;
19
+ serve(): Promise<void>;
20
+ stop(): Promise<void>;
21
+ }
@@ -1,11 +1,13 @@
1
- export declare class ModuleConfig {
2
- disabled: boolean;
3
- }
4
- export default class Module {
5
- config: ModuleConfig;
6
- name: string;
7
- setConfig(config: any): void;
8
- getConfig(): ModuleConfig;
9
- serve(): Promise<void>;
10
- stop(): Promise<void>;
11
- }
1
+ export declare class ModuleConfig {
2
+ [x: string]: any;
3
+ disabled: boolean;
4
+ }
5
+ export default class Module {
6
+ [x: string]: any;
7
+ config: ModuleConfig;
8
+ name: string;
9
+ setConfig(config: any): void;
10
+ getConfig(): ModuleConfig;
11
+ serve(): Promise<void>;
12
+ stop(): Promise<void>;
13
+ }
package/types/utils.d.ts CHANGED
@@ -1,6 +1,6 @@
1
- export declare function getIPAddress(version?: number): string[];
2
- export declare function getAllCallablePropertyNames(obj: any): string[];
3
- export declare function genKVMethods(methods: any, kvMethods?: Map<string, Function>, sourceKVMethods?: Map<string, Function>, nameStack?: string[]): {
4
- kvMethods: Map<string, Function>;
5
- sourceKVMethods: Map<string, Function>;
6
- };
1
+ export declare function getIPAddress(version?: number): string[];
2
+ export declare function getAllCallablePropertyNames(obj: any): string[];
3
+ export declare function genKVMethods(methods: any, kvMethods?: Map<string, Function>, sourceKVMethods?: Map<string, Function>, nameStack?: string[]): {
4
+ kvMethods: Map<string, Function>;
5
+ sourceKVMethods: Map<string, Function>;
6
+ };