@litert/televoke 1.2.0 → 1.3.0

package/src/lib/shared/Encodings/v2/Encoding.v2.decl.ts

@@ -17,122 +17,174 @@
 import type * as CS from './Constants.v2';
 import type { TelevokeError } from '../../Errors';
 
-export type IDataChunkArray = Array<string | Buffer>;
+export type IBinLike = Buffer | string;
 
-export type IDataChunkField = string | Buffer | IDataChunkArray;
+export type IBinLikeArray = IBinLike[];
+
+export type IDecBinItem = Buffer[];
+
+export type IEncBinItem = IBinLike | IBinLikeArray;
 
 export interface ICommandPacket {
 
     /**
      * The command of this packet.
      */
-    readonly cmd: CS.ECommand;
+    cmd: CS.ECommand;
 
     /**
      * The type of this packet.
      */
-    readonly typ: CS.EPacketType;
+    typ: CS.EPacketType;
 
     /**
      * The sequence number of this packet.
      */
-    readonly seq: number;
+    seq: number;
 
     /**
      * The content of this packet.
      */
-    readonly ct: unknown;
+    ct: unknown;
 }
 
 export interface IRequestPacket extends ICommandPacket {
 
-    readonly typ: CS.EPacketType.REQUEST;
+    typ: CS.EPacketType.REQUEST;
 }
 
-export interface IErrorResponsePacket extends ICommandPacket {
+export interface IErrorReplyPacket extends ICommandPacket {
 
-    readonly typ: CS.EPacketType.ERROR_RESPONSE;
+    typ: CS.EPacketType.ERROR_RESPONSE;
 
-    readonly ct: TelevokeError;
+    ct: TelevokeError;
 }
 
-export interface ISuccessResponsePacket extends ICommandPacket {
+export interface IOkReplyPacket extends ICommandPacket {
 
-    readonly typ: CS.EPacketType.SUCCESS_RESPONSE;
+    typ: CS.EPacketType.SUCCESS_RESPONSE;
 }
 
-export interface IApiRequestPacket extends IRequestPacket {
+export interface IApiRequestPacket<TIsReq extends boolean> extends IRequestPacket {
 
-    readonly cmd: CS.ECommand.API_CALL;
+    cmd: CS.ECommand.API_CALL;
 
-    readonly ct: {
+    ct: {
 
         /**
          * The name of the API to be invoked.
          */
-        readonly name: string;
+        name: string;
 
         /**
          * The arguments of the API to be invoked.
          */
-        readonly body: IDataChunkField;
+        body: TIsReq extends true ? IEncBinItem : Buffer[];
+
+        /**
+         * The encoding identifier of the body.
+         *
+         * @default 0 which means JSON
+         */
+        bodyEnc?: number;
+
+        /**
+         * The extension binary chunks of the API to be invoked.
+         */
+        binChunks?: TIsReq extends true ? IEncBinItem[] : Buffer[][];
     };
 }
 
-export interface IPingRequestPacket extends IRequestPacket {
+export type IApiRequestPacketEncoding = IApiRequestPacket<true>;
+
+export type IApiRequestPacketDecoded = IApiRequestPacket<false>;
+
+export interface IApiReplyPacket<TIsReq extends boolean> extends IOkReplyPacket {
 
-    readonly cmd: CS.ECommand.PING;
+    cmd: CS.ECommand.API_CALL;
 
-    readonly ct: IDataChunkField;
+    ct: {
+
+        body: TIsReq extends true ? IEncBinItem : Buffer[];
+
+        /**
+         * The extension binary chunks of the API to be invoked.
+         */
+        binChunks?: TIsReq extends true ? IEncBinItem[] : Buffer[][];
+    };
 }
 
-export interface IPushMessageRequestPacket extends IRequestPacket {
+export type IApiReplyPacketEncoding = IApiReplyPacket<true>;
 
-    readonly cmd: CS.ECommand.PUSH_MESSAGE;
+export type IApiReplyPacketDecoded = IApiReplyPacket<false>;
 
-    readonly ct: IDataChunkField;
+// PING Command
+
+export interface IPingRequestPacket<TIsReq extends boolean> extends IRequestPacket {
+
+    cmd: CS.ECommand.PING;
+
+    ct: TIsReq extends true ? IEncBinItem : IDecBinItem;
 }
 
+export type IPingRequestPacketEncoding = IPingRequestPacket<true>;
+
+export type IPingRequestPacketDecoded = IPingRequestPacket<false>;
+
+export interface IPingReplyPacket<TIsReq extends boolean> extends IOkReplyPacket {
+
+    cmd: CS.ECommand.PING;
+
+    ct: TIsReq extends true ? IEncBinItem : Buffer[];
+}
+
+export type IPingReplyPacketEncoding = IPingReplyPacket<true>;
+
+export type IPingReplyPacketDecoded = IPingReplyPacket<false>;
+
+// PUSH_MESSAGE Command
+
+export interface IPushMessageRequestPacket<TIsReq extends boolean> extends IRequestPacket {
+
+    cmd: CS.ECommand.PUSH_MESSAGE;
+
+    ct: TIsReq extends true ? IEncBinItem : Buffer[];
+}
+
+export type IPushMessageRequestPacketEncoding = IPushMessageRequestPacket<true>;
+
+export type IPushMessageRequestPacketDecoded = IPushMessageRequestPacket<false>;
+
 export interface ICloseRequestPacket extends IRequestPacket {
 
-    readonly cmd: CS.ECommand.CLOSE;
+    cmd: CS.ECommand.CLOSE;
 
-    readonly ct: null;
+    ct: null;
 }
 
-export interface IBinaryChunkRequestPacket extends IRequestPacket {
+export interface IBinaryChunkRequestPacket<TIsReq extends boolean> extends IRequestPacket {
 
-    readonly cmd: CS.ECommand.BINARY_CHUNK;
+    cmd: CS.ECommand.BINARY_CHUNK;
 
-    readonly ct: {
+    ct: {
 
         /**
          * The stream ID of this chunk should be sent to.
          */
-        readonly streamId: number;
+        streamId: number;
 
         /**
          * The index of this chunk in the stream.
          */
-        readonly index: number;
+        index: number;
 
         /**
          * The chunk data.
          */
-        readonly body: IDataChunkField;
+        body: TIsReq extends true ? IEncBinItem : Buffer[];
     };
 }
 
-export interface IApiResponsePacket extends ISuccessResponsePacket {
+export type IBinaryChunkRequestPacketEncoding = IBinaryChunkRequestPacket<true>;
 
-    readonly cmd: CS.ECommand.API_CALL;
-
-    readonly ct: IDataChunkField;
-}
-
-export interface IPingResponsePacket extends ISuccessResponsePacket {
-
-    readonly cmd: CS.ECommand.PING;
-
-    readonly ct: IDataChunkField;
-}
+export type IBinaryChunkRequestPacketDecoded = IBinaryChunkRequestPacket<false>;

package/src/lib/shared/Errors.ts

@@ -69,6 +69,7 @@ const errorCtors = {
     ...defineProtocolError('channel_inactive'),
     ...defineProtocolError('channel_closed'),
     ...defineProtocolError('api_not_found'),
+    ...defineProtocolError('unk_api_enc'),
     ...defineProtocolError('cmd_not_impl'),
     ...defineProtocolError('network_error'),
     ...defineProtocolError('stream_not_found'),

package/src/lib/shared/Shared.decl.ts

@@ -14,18 +14,23 @@
  * limitations under the License.
  */
 
-import { Readable } from 'node:stream';
+import type { Readable } from 'node:stream';
 
-export type IFn<TArgs extends any[], TRet> = (...args: TArgs) => TRet;
+export type IFn<TArgs extends unknown[], TRet> = (...args: TArgs) => TRet;
 
-export type IVoidFn<TArgs extends any[]> = IFn<TArgs, void>;
+export type IVoidFn<TArgs extends any[] = any[]> = IFn<TArgs, void>;
 
 // eslint-disable-next-line @typescript-eslint/no-restricted-types, @typescript-eslint/consistent-type-definitions
 export type IObject = {};
 
-export type IfIsFn<T, TTrue = T, TFalse = never> = T extends IFn<any[], any> ? TTrue : TFalse;
+export type IfIsFn<T, TTrue = T, TFalse = never> = T extends IFn<any[], unknown> ? TTrue : TFalse;
 
-export type IfIsOfFn<T, TFn extends IFn<any[], any>, TTrue = T, TFalse = never> = T extends TFn ? TTrue : TFalse;
+export type IfIsOfFn<
+    T,
+    TFn extends IFn<unknown[], unknown>,
+    TTrue = T,
+    TFalse = never
+> = T extends TFn ? TTrue : TFalse;
 
 export interface IEventListener<T extends IDefaultEvents> {
 
@@ -37,7 +42,7 @@ export interface IEventListener<T extends IDefaultEvents> {
      * @param event         The event name.
      * @param listener      The listener function.
      */
-    on<TKey extends keyof T>(event: TKey, listener: IfIsOfFn<T[TKey], IVoidFn<any[]>>): this;
+    on<TKey extends keyof T>(event: TKey, listener: IfIsOfFn<T[TKey], IVoidFn>): this;
 
     /**
      * Register a listener for the given event.
@@ -47,7 +52,7 @@ export interface IEventListener<T extends IDefaultEvents> {
      * @param event         The event name.
      * @param listener      The listener function.
      */
-    on(event: string | symbol, listener: IVoidFn<any[]>): this;
+    on(event: string | symbol, listener: IVoidFn): this;
 
     /**
      * Register a one-time listener for the given event.
@@ -57,7 +62,7 @@ export interface IEventListener<T extends IDefaultEvents> {
      * @param event         The event name.
      * @param listener      The listener function.
      */
-    once<TKey extends keyof T>(event: TKey, listener: IfIsOfFn<T[TKey], IVoidFn<any[]>>): this;
+    once<TKey extends keyof T>(event: TKey, listener: IfIsOfFn<T[TKey], IVoidFn>): this;
 
     /**
      * Register a one-time listener for the given event.
@@ -67,7 +72,7 @@ export interface IEventListener<T extends IDefaultEvents> {
      * @param event         The event name.
      * @param listener      The listener function.
      */
-    once(event: string | symbol, listener: IVoidFn<any[]>): this;
+    once(event: string | symbol, listener: IVoidFn): this;
 
     /**
      * Register a listener for the given event.
@@ -77,7 +82,7 @@ export interface IEventListener<T extends IDefaultEvents> {
      * @param event         The event name.
      * @param listener      The listener function.
      */
-    addListener<TKey extends keyof T>(event: TKey, listener: IfIsOfFn<T[TKey], IVoidFn<any[]>>): this;
+    addListener<TKey extends keyof T>(event: TKey, listener: IfIsOfFn<T[TKey], IVoidFn>): this;
 
     /**
      * Register a listener for the given event.
@@ -87,7 +92,7 @@ export interface IEventListener<T extends IDefaultEvents> {
      * @param event         The event name.
      * @param listener      The listener function.
      */
-    addListener(event: string | symbol, listener: IVoidFn<any[]>): this;
+    addListener(event: string | symbol, listener: IVoidFn): this;
 
     /**
      * Remove the given listener for the given event.
@@ -97,7 +102,7 @@ export interface IEventListener<T extends IDefaultEvents> {
      * @param event     The event name.
      * @param listener  The listener function.
      */
-    removeListener<TKey extends keyof T>(event: TKey, listener: IVoidFn<any[]>): this;
+    removeListener<TKey extends keyof T>(event: TKey, listener: IVoidFn): this;
 
     /**
      * Remove the given listener for the given event.
@@ -107,7 +112,7 @@ export interface IEventListener<T extends IDefaultEvents> {
      * @param event     The event name.
      * @param listener  The listener function.
      */
-    removeListener(event: string | symbol, listener: IVoidFn<any[]>): this;
+    removeListener(event: string | symbol, listener: IVoidFn): this;
 
     /**
      * Remove the given listener for the given event.
@@ -117,7 +122,7 @@ export interface IEventListener<T extends IDefaultEvents> {
      * @param event     The event name.
      * @param listener  The listener function.
      */
-    off<TKey extends keyof T>(event: TKey, listener: IVoidFn<any[]>): this;
+    off<TKey extends keyof T>(event: TKey, listener: IVoidFn): this;
 
     /**
      * Remove the given listener for the given event.
@@ -127,7 +132,7 @@ export interface IEventListener<T extends IDefaultEvents> {
      * @param event     The event name.
      * @param listener  The listener function.
      */
-    off(event: string | symbol, listener: IVoidFn<any[]>): this;
+    off(event: string | symbol, listener: IVoidFn): this;
 
     /**
      * Remove all listeners for the given event.

package/src/lib/shared/Utils.ts

@@ -20,10 +20,10 @@
  * @param fn    The function to call.
  * @returns     The wrapped function.
  */
-export function once<T extends (...args: any[]) => any>(fn: T): T {
+export function once<T extends (...args: any[]) => unknown>(fn: T): T {
 
     let called = false;
-    let result: any;
+    let result: unknown;
 
     return function(...args: any[]) {
 

package/src/lib/transporters/http-listener/Http.Decl.ts

@@ -67,7 +67,6 @@ const DEFAULT_REFUSE_STATUS_CODE = 400;
  */
 export const DEFAULT_LEGACY_HTTP_API_PROCESSOR: ILegacyHttpApiProcessor = function(_req, resp): void {
 
-    // eslint-disable-next-line @typescript-eslint/naming-convention
     resp.writeHead(DEFAULT_REFUSE_STATUS_CODE, {
         'Content-Type': 'text/plain',
         'Content-Length': DEFAULT_REFUSE_PAYLOAD.byteLength,

package/src/lib/transporters/legacy-http/LegacyHttp.Client.Native.ts

@@ -21,8 +21,9 @@ import * as Shared from '../../shared';
 import * as v1 from '../../shared/Encodings/v1';
 import { EventEmitter } from 'node:events';
 
-const HTTP_HEADER_CONTENT_LENGTH = 'content-length';
-const HTTP_HEADER_TV_VER = 'x-tv-ver';
+const H_HDR_NAME_CONTENT_LENGTH = 'content-length';
+const H_HDR_NAME_CONTENT_TYPE = 'content-type';
+const H_HDR_NAME_TV_VER = 'x-tv-ver';
 
 const DEFAULT_MAX_CONNECTIONS = 100;
 const DEFAULT_TIMEOUT = 30_000;
@@ -40,6 +41,8 @@ export interface ILegacyHttpClient<T extends Shared.IObject> extends C.IClient<T
     setHeaders(newHeaders: $Http.OutgoingHttpHeaders, append?: boolean): void;
 }
 
+const H_HDR_VAL_JSON_MIME = 'application/json';
+
 class TvLegacyHttpClient extends EventEmitter implements ILegacyHttpClient<any> {
 
     public onError!: any;
@@ -121,6 +124,25 @@ class TvLegacyHttpClient extends EventEmitter implements ILegacyHttpClient<any>
         }
     }
 
+    public async callApi(api: any, args: any[]): Promise<any> {
+
+        try {
+
+            return await this._invoke(api, ...args);
+        }
+        catch (e) {
+
+            if (this._retryOnConnReset && (e as any)?.code === 'ECONNRESET') {
+
+                return this._invoke(api, ...args);
+            }
+            else {
+
+                throw e;
+            }
+        }
+    }
+
     private _invoke(api: any, ...args: any[]): Promise<any> {
 
         const CST = Date.now();
@@ -149,8 +171,9 @@ class TvLegacyHttpClient extends EventEmitter implements ILegacyHttpClient<any>
                 method: 'POST',
                 headers: {
                     ...this._opts.headers,
-                    [HTTP_HEADER_CONTENT_LENGTH]: Buffer.byteLength(content),
-                    [HTTP_HEADER_TV_VER]: 1
+                    [H_HDR_NAME_CONTENT_TYPE]: H_HDR_VAL_JSON_MIME,
+                    [H_HDR_NAME_CONTENT_LENGTH]: Buffer.byteLength(content),
+                    [H_HDR_NAME_TV_VER]: 1
                 },
             }, (resp) => {
 
@@ -164,14 +187,14 @@ class TvLegacyHttpClient extends EventEmitter implements ILegacyHttpClient<any>
                     return;
                 }
 
-                if (!resp.headers[HTTP_HEADER_CONTENT_LENGTH]) {
+                if (!resp.headers[H_HDR_NAME_CONTENT_LENGTH]) {
 
                     resp.socket.destroy();
                     reject(new Shared.errors.invalid_response({ reason: 'missing_content_length' }));
                     return;
                 }
 
-                const length = parseInt(resp.headers[HTTP_HEADER_CONTENT_LENGTH]);
+                const length = parseInt(resp.headers[H_HDR_NAME_CONTENT_LENGTH]);
 
                 if (!Number.isSafeInteger(length) || length > v1.MAX_PACKET_SIZE) { // Maximum request packet is 64MB
 
@@ -208,7 +231,7 @@ class TvLegacyHttpClient extends EventEmitter implements ILegacyHttpClient<any>
 
                     try {
 
-                        data = JSON.parse(buf as any);
+                        data = JSON.parse(buf as unknown as string);
                     }
                     catch (e) {
 

package/src/lib/transporters/legacy-http/LegacyHttp.Server.ts

@@ -184,7 +184,7 @@ class LegacyHttpGateway extends EventEmitter implements dT.IGateway {
 
                 try {
 
-                    input = JSON.parse(buf as any);
+                    input = JSON.parse(buf as unknown as string);
                 }
                 catch (e) {
 

package/src/lib/transporters/memory/Memory.Impl.ts

@@ -33,9 +33,9 @@ function createRandomName(): string {
 
 interface IMemoryExchangeEvents extends Shared.IDefaultEvents {
 
-    ['data_a'](data: any): void;
+    ['data_a'](data: unknown): void;
 
-    ['data_b'](data: any): void;
+    ['data_b'](data: unknown): void;
 
     ['end_a'](): void;
 
@@ -57,7 +57,7 @@ class MemoryExchange extends EventEmitter implements Shared.IEventListener<IMemo
         super();
     }
 
-    public send(targetEndpoint: 'a' | 'b', data: any): void {
+    public send(targetEndpoint: 'a' | 'b', data: unknown): void {
 
         setImmediate(() => this.emit('data_' + targetEndpoint, data));
     }

package/src/lib/transporters/websocket/WebSocket.Server.ts

@@ -16,6 +16,7 @@
 
 import * as LibWS from '@litert/websocket';
 import type * as NodeHttp from 'node:http';
+import type * as NodeNet from 'node:net';
 import * as dWS from './WebSocket.decl';
 import type * as Listener from '../http-listener';
 import type * as dT from '../Transporter.decl';
@@ -71,7 +72,7 @@ class WebSocketGateway extends EventEmitter implements dT.IGateway {
 
             this._wsServer.reject({
                 'request': req,
-                'socket': socket as any,
+                'socket': socket as unknown as NodeNet.Socket,
             });
             return;
         }
@@ -85,14 +86,14 @@ class WebSocketGateway extends EventEmitter implements dT.IGateway {
 
             this._wsServer.reject({
                 'request': req,
-                'socket': socket as any,
+                'socket': socket as unknown as NodeNet.Socket,
             });
             return;
         }
 
         const ws = this._wsServer.accept({
             'request': req,
-            'socket': socket as any,
+            'socket': socket as unknown as NodeNet.Socket,
             'subProtocol': dWS.WEBSOCKET_SUB_PROTOCOL,
         });