@litert/televoke 0.4.7 → 1.0.0-0

package/lib/transporters/websocket/WebSocket.Transporter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebSocket.Transporter.js","sourceRoot":"","sources":["../../../src/lib/transporters/websocket/WebSocket.Transporter.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;EAcE;;;AAEF,2CAA2C;AAC3C,uCAAuC;AAEvC,6CAA2C;AAE3C,MAAM,cAAc,GAAG,CAAC,eAAe,EAAE,YAAY,EAAE,cAAc,EAAE,WAAW,EAAE,iBAAiB,CAAC,CAAC;AAEvG,MAAa,oBAAqB,SAAQ,0BAAY;IAElD,YACoB,QAAgB,EACb,KAAuB;QAE1C,KAAK,EAAE,CAAC;QAHQ,aAAQ,GAAR,QAAQ,CAAQ;QACb,UAAK,GAAL,KAAK,CAAkB;QAI1C,IAAI,CAAC,KAAK;aACL,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aACjC,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;aACvC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAEnB,QAAQ,KAAK,CAAC,MAAM,EAAE;gBAClB,KAAK,KAAK,CAAC,OAAO,CAAC,MAAM;oBACrB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAG,KAA0B,CAAC,IAAI,CAAC,CAAC;oBACrD,MAAM;gBACV,KAAK,KAAK,CAAC,OAAO,CAAC,KAAK;oBACpB,IAAI,CAAC,GAAG,EAAE,CAAC;oBACX,MAAM;gBACV,KAAK,KAAK,CAAC,OAAO,CAAC,IAAI;oBACnB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAE,KAA0B,CAAC,IAAI,CAAC,CAAC,CAAC;oBACjE,MAAM;gBACV;oBACI,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC,CAAC,CAAC;oBACjF,IAAI,CAAC,OAAO,EAAE,CAAC;aACtB;QACL,CAAC,CAAC;aACD,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;aACzC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAC/C,CAAC;IAEM,OAAO;QAEV,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;IACzB,CAAC;IAEM,gBAAgB;QAEnB,OAAO,cAAc,CAAC;IAC1B,CAAC;IAEM,gBAAgB;QAEnB,OAAO;YACH,eAAe,EAAE,IAAI,CAAC,KAAK,CAAC,aAAa;YACzC,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU;YACnC,cAAc,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY;YACvC,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS;YACjC,iBAAiB,EAAE,IAAI,CAAC,KAAK,CAAC,eAAe;SAChD,CAAC;IACN,CAAC;IAEM,WAAW,CAAC,IAAY;QAE3B,QAAQ,IAAI,EAAE;YACV,KAAK,WAAW,CAAC;YACjB,KAAK,cAAc,CAAC;YACpB,KAAK,YAAY,CAAC;YAClB,KAAK,eAAe,CAAC;YACrB,KAAK,iBAAiB;gBAClB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC5B;gBACI,OAAO,SAAS,CAAC;SACxB;IACL,CAAC;IAED,IAAW,QAAQ;QAEf,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC;IAChC,CAAC;IAEM,KAAK,CAAC,KAA+C;QAExD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE;YAEtB,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC;SAClE;QAED,IAAI;YAEA,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;SACjC;QACD,OAAO,CAAC,EAAE;YAEN,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;SAC5E;IACL,CAAC;IAEM,GAAG,CAAC,KAAuB;QAE9B,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE;YAErB,IAAI,KAAK,EAAE;gBAEP,IAAI;oBAEA,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;iBACjC;gBACD,OAAO,CAAC,EAAE;oBAEN,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;iBAC5E;aACJ;YAED,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;SACpB;IACL,CAAC;CACJ;AA5GD,oDA4GC"}

package/lib/transporters/websocket/WebSocket.decl.d.ts

@@ -0,0 +1,19 @@
+/**
+* Copyright 2023 Angus.Fenying <fenying@litert.org>
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*   https://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+export declare const WEBSOCKET_SUB_PROTOCOL = "televoke2";
+export declare const WS_PROTOCOL_NAME = "ws";
+export declare const WSS_PROTOCOL_NAME = "wss";
+//# sourceMappingURL=WebSocket.decl.d.ts.map

package/lib/transporters/websocket/WebSocket.decl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebSocket.decl.d.ts","sourceRoot":"","sources":["../../../src/lib/transporters/websocket/WebSocket.decl.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;EAcE;AAEF,eAAO,MAAM,sBAAsB,cAAc,CAAC;AAElD,eAAO,MAAM,gBAAgB,OAAO,CAAC;AAErC,eAAO,MAAM,iBAAiB,QAAQ,CAAC"}

package/lib/transporters/websocket/WebSocket.decl.js

@@ -0,0 +1,22 @@
+"use strict";
+/**
+* Copyright 2023 Angus.Fenying <fenying@litert.org>
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*   https://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WSS_PROTOCOL_NAME = exports.WS_PROTOCOL_NAME = exports.WEBSOCKET_SUB_PROTOCOL = void 0;
+exports.WEBSOCKET_SUB_PROTOCOL = 'televoke2';
+exports.WS_PROTOCOL_NAME = 'ws';
+exports.WSS_PROTOCOL_NAME = 'wss';
+//# sourceMappingURL=WebSocket.decl.js.map

package/lib/transporters/websocket/WebSocket.decl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebSocket.decl.js","sourceRoot":"","sources":["../../../src/lib/transporters/websocket/WebSocket.decl.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;EAcE;;;AAEW,QAAA,sBAAsB,GAAG,WAAW,CAAC;AAErC,QAAA,gBAAgB,GAAG,IAAI,CAAC;AAExB,QAAA,iBAAiB,GAAG,KAAK,CAAC"}

package/lib/transporters/websocket/index.d.ts

@@ -0,0 +1,19 @@
+/**
+* Copyright 2023 Angus.Fenying <fenying@litert.org>
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*   https://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+export * from './WebSocket.Client';
+export * from './WebSocket.Server';
+export * from './WebSocket.decl';
+//# sourceMappingURL=index.d.ts.map

package/lib/transporters/websocket/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/lib/transporters/websocket/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;EAcE;AAEF,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC"}

package/lib/transporters/websocket/index.js

@@ -0,0 +1,35 @@
+"use strict";
+/**
+* Copyright 2023 Angus.Fenying <fenying@litert.org>
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*   https://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./WebSocket.Client"), exports);
+__exportStar(require("./WebSocket.Server"), exports);
+__exportStar(require("./WebSocket.decl"), exports);
+//# sourceMappingURL=index.js.map

package/lib/transporters/websocket/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/transporters/websocket/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;EAcE;;;;;;;;;;;;;;;;AAEF,qDAAmC;AACnC,qDAAmC;AACnC,mDAAiC"}

package/package.json

@@ -1,17 +1,16 @@
 {
   "name": "@litert/televoke",
-  "version": "0.4.7",
+  "version": "1.0.0-0",
   "description": "A simple RPC service framework.",
   "main": "lib/index.js",
   "scripts": {
-    "prepublishOnly": "npm run rebuild-production",
+    "prepublishOnly": "npm run rebuild",
     "build": "tsc -v && tsc -p .",
-    "build-production": "tsc -v && tsc -p tsconfig.production.json",
     "rebuild": "npm run clean && npm run lint && npm run build",
-    "rebuild-production": "npm run clean && npm run lint && npm run build-production",
     "build-watch": "tsc -v && tsc -w -p .",
     "typecheck": "tsc -p tsconfig.json --noEmit",
     "test": "mocha",
+    "prepare": "husky install",
     "clean": "rm -rf lib examples benchmarks test",
     "lint": "eslint -c .eslintrc --ext '.ts' ./src"
   },
@@ -30,20 +29,21 @@
     "url": "https://github.com/litert/televoke.js/issues"
   },
   "homepage": "https://github.com/litert/televoke.js#readme",
-  "dependencies": {
-    "@litert/observable": "^0.3.0"
-  },
   "types": "lib/index.d.ts",
   "typings": "lib/index.d.ts",
   "devDependencies": {
-    "@commitlint/cli": "^17.7.2",
-    "@commitlint/config-conventional": "^17.6.6",
-    "@litert/eslint-plugin-rules": "^0.1.5",
-    "@types/node": "^20.8.4",
+    "@commitlint/cli": "^18.2.0",
+    "@commitlint/config-conventional": "^18.1.0",
+    "@litert/eslint-plugin-rules": "^0.1.6",
+    "@litert/lwdfx": "^1.1.1",
+    "@litert/websocket": "^0.1.0",
+    "@types/mocha": "^10.0.3",
+    "@types/node": "^20.8.10",
     "husky": "^8.0.3",
+    "mocha": "^10.2.0",
     "typescript": "^5.2.2"
   },
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=18.0.0"
   }
 }

package/src/lib/client/Client.decl.ts

@@ -0,0 +1,61 @@
+/**
+* Copyright 2023 Angus.Fenying <fenying@litert.org>
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*   https://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+import type * as Shared from '../shared';
+
+export interface IChannelEvents extends Shared.IDefaultEvents {
+
+    close(): void;
+
+    ['push_message'](msg: Buffer[]): void;
+}
+
+export interface IClient<TApis extends Shared.IObject>
+    extends Shared.IEventListener<IChannelEvents>, Pick<
+        Shared.IChannelBase<IChannelEvents>,
+        'close' | 'sendBinaryChunk' | 'finished' | 'ended' | 'ping' | 'writable' | 'streams'
+    > {
+
+    /**
+     * The timeout for waiting replies of each command sent to the remote endpoint, in milliseconds.
+     *
+     * @default 60000
+     */
+    timeout: number;
+
+    /**
+     * The transporter object is used to send and receive data to and from the remote endpoint.
+     *
+     * > Should be `null` when disconnected.
+     */
+    readonly transporter: Shared.ITransporter | null;
+
+    /**
+     * Connect to the remote endpoint.
+     */
+    connect(): Promise<void>;
+
+    /**
+     * Invoke an API.
+     *
+     * @param name  The API name.
+     * @param args  The arguments.
+     */
+    invoke<TName extends keyof TApis>(
+        name: Shared.IfIsFn<TApis[TName], TName>,
+        ...args: TApis[TName] extends Shared.IFn<infer TArgs, any> ? TArgs : never
+    ): Promise<TApis[TName] extends Shared.IFn<any[], infer TRet> ? TRet : never>;
+}

package/src/lib/client/JsonApiClient.impl.ts

@@ -0,0 +1,258 @@
+/**
+* Copyright 2023 Angus.Fenying <fenying@litert.org>
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*   https://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+import * as Shared from '../shared';
+import type * as dC from './Client.decl';
+import type * as dT from '../transporters';
+import { EventEmitter } from 'node:events';
+import { AbstractTvChannelV2, encoder } from '../shared/Channel.impl';
+import * as v2 from '../shared/Encodings/v2';
+import { buffer2json, /* debugLog */ } from '../shared/Utils';
+
+let channelIdCounter = Date.now();
+
+class TvJsonApiClient<TApis extends Shared.IObject> extends EventEmitter implements dC.IClient<TApis> {
+
+    private _channel: TvClientChannel | null = null;
+
+    private _connecting: Promise<TvClientChannel> | null = null;
+
+    public constructor(
+        private readonly _connector: dT.IConnector,
+        public timeout: number,
+        private readonly _streamManagerFactory: Shared.IStreamManagerFactory,
+    ) {
+
+        super();
+    }
+
+    public get streams(): Shared.IStreamManager {
+
+        const ret = this._channel?.streams;
+
+        if (!ret) {
+
+            throw new Shared.errors.channel_inactive();
+        }
+
+        return ret;
+    }
+
+    private readonly _onChannelClose = (): void => {
+
+        this._channel?.off('close', this._onChannelClose)
+            .off('push_message', this._onMessage);
+
+        this._channel = null;
+    };
+
+    private readonly _onMessage = (msg: Buffer[]): void => {
+
+        this.emit('push_message', msg);
+    };
+
+    private readonly _onError = (e: unknown): void => {
+
+        this.emit('error', e);
+    };
+
+    public get transporter(): Shared.ITransporter  | null {
+
+        return this._channel?.transporter ?? null;
+    }
+
+    public get ended(): boolean {
+
+        return false !== this._channel?.ended;
+    }
+
+    public get finished(): boolean {
+
+        return false !== this._channel?.finished;
+    }
+
+    public get writable(): boolean {
+
+        return false !== this._channel?.writable;
+    }
+
+    protected async _getChannel(): Promise<TvClientChannel> {
+
+        if (this._channel?.transporter?.writable) {
+
+            // debugLog('televoke', 'Reusing existing channel.');
+            return this._channel;
+        }
+
+        if (this._connecting) {
+
+            // debugLog('televoke', 'Waiting for previous connection to be established.');
+            return this._connecting;
+        }
+
+        try {
+
+            // debugLog('televoke', 'Attempting to connect...');
+            return this._channel = await (this._connecting = this._connect());
+        }
+        catch (e) {
+
+            // debugLog('televoke', 'Attempts to connect failed.');
+            this._channel = null;
+            this._connecting = null;
+            throw e;
+        }
+        finally {
+
+            // debugLog('televoke', 'Attempts to connect finished.');
+            this._connecting = null;
+        }
+    }
+
+    private async _connect(): Promise<TvClientChannel> {
+
+        this._channel = new TvClientChannel(
+            await this._connector.connect() as any,
+            this._streamManagerFactory,
+            this.timeout
+        )
+            .on('close', this._onChannelClose)
+            .on('error', this._onError)
+            .on('push_message', this._onMessage);
+
+        return this._channel;
+    }
+
+    public async invoke(
+        name: unknown,
+        ...args: any[]
+    ): Promise<any> {
+
+        try {
+
+            const resp = await (await this._getChannel()).apiCall(name as string, JSON.stringify(args));
+
+            return buffer2json(resp);
+        }
+        catch (e) {
+
+            if (e instanceof Shared.errors.app_error) {
+
+                let info: unknown;
+
+                try {
+
+                    info = JSON.parse(e.message);
+                }
+                catch {
+
+                    throw e;
+                }
+
+                throw new Shared.TvErrorResponse(info);
+            }
+
+            throw e;
+        }
+    }
+
+    public close(): void {
+
+        this._channel?.close();
+        // this._onChannelClose();
+    }
+
+    public async ping(msg?: Buffer | string): Promise<Buffer> {
+
+        return (await this._getChannel()).ping(msg);
+    }
+
+    public async connect(): Promise<void> {
+
+        await this._getChannel();
+    }
+
+    public async sendBinaryChunk(streamId: number, chunk: Buffer): Promise<void> {
+
+        return (await this._getChannel()).sendBinaryChunk(streamId, chunk);
+    }
+}
+
+class TvClientChannel extends AbstractTvChannelV2 {
+
+    public constructor(
+        transporter: dT.ITransporter & Shared.ITransporter,
+        streamManagerFactory: Shared.IStreamManagerFactory,
+        timeout: number = 60_000,
+    ) {
+
+        super(channelIdCounter++, transporter, timeout, streamManagerFactory);
+    }
+
+    public apiCall(
+        name: string,
+        argsBody: Buffer | string | Buffer[],
+    ): Promise<Buffer[]> {
+
+        if (!this.writable) {
+
+            return Promise.reject(new Shared.errors.channel_inactive());
+        }
+
+        const seq = this._seqCounter++;
+
+        (this.transporter as dT.ITransporter).write(encoder.encode({
+            'typ': v2.EPacketType.REQUEST,
+            'cmd': v2.ECommand.API_CALL,
+            'seq': seq,
+            'ct': {
+                'name': name,
+                'body': typeof argsBody === 'string' ? Buffer.from(argsBody) : argsBody
+            }
+        } satisfies v2.IApiRequestPacket));
+
+        return new Promise((resolve, reject) => {
+
+            this._setTimeout(v2.ECommand.API_CALL, seq, (resp) => {
+
+                if (resp.ct instanceof Shared.TelevokeError) {
+
+                    reject(resp.ct);
+                    return;
+                }
+
+                resolve(resp.ct as Buffer[]);
+            });
+        });
+    }
+}
+
+/**
+ * Create a JSON-RPC client instance, over televoke2 protocol.
+ *
+ * @param connector             The connector instance.
+ * @param streamManagerFactory  The stream manager factory function. [default: createSharedStreamManagerFactory()]
+ * @param timeout               The default timeout value of commands, in milliseconds. [default: 60000]
+ * @returns                     The client instance.
+ */
+export function createJsonApiClient<TApis extends Shared.IObject>(
+    connector: dT.IConnector,
+    streamManagerFactory: Shared.IStreamManagerFactory = Shared.createSharedStreamManagerFactory(),
+    timeout: number = 60_000,
+): dC.IClient<TApis> {
+
+    return new TvJsonApiClient<TApis>(connector, timeout, streamManagerFactory);
+}