@socket-mesh/core 1.0.3 → 2.0.0

package/dist/socket-transport.d.ts

@@ -1,94 +1,97 @@
-import { CodecEngine } from "@socket-mesh/formatter";
-import ws from "isomorphic-ws";
-import { Plugin } from "./plugins/plugin.js";
-import { AnyRequest, InvokeMethodRequest, InvokeServiceRequest, TransmitMethodRequest, TransmitServiceRequest } from "./request.js";
-import { AnyPacket } from "./packet.js";
-import { FunctionReturnType, MethodMap, PrivateMethodMap, PublicMethodMap, ServiceMap } from "./maps/method-map.js";
-import { AnyResponse } from "./response.js";
-import { AuthToken, SignedAuthToken } from "@socket-mesh/auth";
-import { Socket, SocketOptions, SocketStatus, StreamCleanupMode } from "./socket.js";
+import { AuthToken, SignedAuthToken } from '@socket-mesh/auth';
+import { CodecEngine } from '@socket-mesh/formatter';
+import ws from 'isomorphic-ws';
+import { FunctionReturnType, MethodMap, PrivateMethodMap, PublicMethodMap, ServiceMap, ServiceMethodName, ServiceName } from './maps/method-map.js';
+import { AnyPacket } from './packet.js';
+import { AnyPlugin } from './plugins/plugin.js';
+import { AnyRequest } from './request.js';
+import { AnyResponse } from './response.js';
+import { BaseSocket, BaseSocketOptions, Socket, SocketStatus, StreamCleanupMode } from './socket.js';
 export type CallIdGenerator = () => number;
-export interface InvokeMethodOptions<TMethodMap extends MethodMap, TMethod extends keyof TMethodMap> {
-    method: TMethod;
-    ackTimeoutMs?: number | false;
+export interface InboundMessage {
+    packet: (AnyPacket | AnyResponse)[] | (AnyPacket | AnyResponse) | null;
+    timestamp: Date;
 }
-export interface InvokeServiceOptions<TServiceMap extends ServiceMap, TService extends keyof TServiceMap, TMethod extends keyof TServiceMap[TService]> {
-    service: TService;
+export interface InvokeMethodOptions<TMethodMap extends MethodMap = MethodMap, TMethod extends keyof TMethodMap & string = keyof TMethodMap & string> {
+    ackTimeoutMs?: false | number;
     method: TMethod;
-    ackTimeoutMs?: number | false;
 }
-export interface InboundMessage<TIncoming extends MethodMap, TOutgoing extends PublicMethodMap, TPrivateOutgoing extends PrivateMethodMap, TService extends ServiceMap> {
-    timestamp: Date;
-    packet: (AnyPacket<TIncoming, TService> | AnyResponse<TOutgoing, TPrivateOutgoing, TService>) | (AnyPacket<TIncoming, TService> | AnyResponse<TOutgoing, TPrivateOutgoing, TService>)[];
+export interface InvokeServiceOptions<TServiceMap extends ServiceMap = ServiceMap, TService extends keyof TServiceMap & string = keyof TServiceMap & string, TMethod extends keyof TServiceMap[TService] & string = keyof TServiceMap[TService] & string> {
+    ackTimeoutMs?: false | number;
+    method: TMethod;
+    service: TService;
 }
-export declare class SocketTransport<TIncoming extends MethodMap, TOutgoing extends PublicMethodMap, TPrivateOutgoing extends PrivateMethodMap, TService extends ServiceMap, TState extends object> {
-    private _socket;
-    private _webSocket;
+export type SocketTransport<TIncoming extends PublicMethodMap = {}, TOutgoing extends PublicMethodMap = {}, TState extends object = {}, TService extends ServiceMap = {}, TPrivateIncoming extends PrivateMethodMap = {}, TPrivateOutgoing extends PrivateMethodMap = {}> = Omit<BaseSocketTransport<TState>, 'invoke' | 'socket' | 'transmit'> & {
+    invoke<TMethod extends keyof TOutgoing & string>(method: TMethod, arg?: Parameters<TOutgoing[TMethod]>[0]): [Promise<FunctionReturnType<TOutgoing[TMethod]>>, () => void];
+    invoke<TMethod extends keyof TOutgoing & string>(options: InvokeMethodOptions<TOutgoing, TMethod>, arg?: Parameters<TOutgoing[TMethod]>[0]): [Promise<FunctionReturnType<TOutgoing[TMethod]>>, () => void];
+    invoke<TServiceName extends ServiceName<TService>, TMethod extends ServiceMethodName<TService, TServiceName>>(options: [TServiceName, TMethod, (false | number)?], arg?: Parameters<TService[TServiceName][TMethod]>[0]): [Promise<FunctionReturnType<TService[TServiceName][TMethod]>>, () => void];
+    invoke<TServiceName extends ServiceName<TService>, TMethod extends ServiceMethodName<TService, TServiceName>>(options: InvokeServiceOptions<TService, TServiceName, TMethod>, arg?: Parameters<TService[TServiceName][TMethod]>[0]): [Promise<FunctionReturnType<TService[TServiceName][TMethod]>>, () => void];
+    invoke<TMethod extends keyof TPrivateOutgoing & string>(method: TMethod, arg?: Parameters<TPrivateOutgoing[TMethod]>[0]): [Promise<FunctionReturnType<TPrivateOutgoing[TMethod]>>, () => void];
+    invoke<TMethod extends keyof TPrivateOutgoing & string>(options: InvokeMethodOptions<TPrivateOutgoing, TMethod>, arg?: Parameters<TPrivateOutgoing[TMethod]>[0]): [Promise<FunctionReturnType<TPrivateOutgoing[TMethod]>>, () => void];
+    readonly socket: Socket<TIncoming, TOutgoing, TState, TService, TPrivateIncoming, TPrivateOutgoing>;
+    transmit<TMethod extends keyof TOutgoing & string>(method: TMethod, arg?: Parameters<TOutgoing[TMethod]>[0]): Promise<void>;
+    transmit<TServiceName extends ServiceName<TService>, TMethod extends ServiceMethodName<TService, TServiceName>>(options: [TServiceName, TMethod], arg?: Parameters<TService[TServiceName][TMethod]>[0]): Promise<void>;
+    transmit<TMethod extends keyof TPrivateOutgoing & string>(method: TMethod, arg?: Parameters<TPrivateOutgoing[TMethod]>[0]): Promise<void>;
+};
+export declare class BaseSocketTransport<TState extends object = {}> {
+    private _authToken;
+    private readonly _callbackMap;
+    private readonly _callIdGenerator;
+    private readonly _handlers;
     private _inboundProcessedMessageCount;
     private _inboundReceivedMessageCount;
+    private _isReady;
     private _outboundPreparedMessageCount;
     private _outboundSentMessageCount;
-    private _isReady;
-    private _authToken?;
-    private _signedAuthToken?;
-    private readonly _callIdGenerator;
-    private readonly _callbackMap;
-    private readonly _handlers;
-    private _onUnhandledRequest;
+    private _pingTimeoutRef;
+    private _signedAuthToken;
+    private _socket;
+    private _webSocket;
+    ackTimeoutMs: number;
     readonly codecEngine: CodecEngine;
-    readonly plugins: Plugin<TIncoming, TOutgoing, TPrivateOutgoing, TService, TState>[];
+    id: null | string;
+    readonly plugins: AnyPlugin[];
     streamCleanupMode: StreamCleanupMode;
-    id: string | null;
-    ackTimeoutMs: number;
-    private _pingTimeoutRef;
-    protected constructor(options?: SocketOptions<TIncoming, TOutgoing, TPrivateOutgoing, TService, TState>);
+    protected constructor(options?: BaseSocketOptions<TState>);
     protected abortAllPendingCallbacksDueToBadConnection(status: SocketStatus): void;
-    get authToken(): AuthToken;
+    get authToken(): AuthToken | null;
     changeToUnauthenticatedState(): Promise<boolean>;
     protected decode(data: string | ws.RawData): any;
     disconnect(code?: number, reason?: string): void;
     getBackpressure(): number;
     getInboundBackpressure(): number;
     getOutboundBackpressure(): number;
-    protected handleInboudMessage({ packet, timestamp }: InboundMessage<TIncoming, TOutgoing, TPrivateOutgoing, TService>): Promise<void>;
+    protected handleInboudMessage({ packet, timestamp }: InboundMessage): Promise<void>;
+    invoke(methodOptions: [string, string, (false | number)?] | InvokeMethodOptions | InvokeServiceOptions | string, arg?: unknown): [Promise<unknown>, () => void];
     protected onClose(code: number, reason?: Buffer | string): void;
     protected onDisconnect(status: SocketStatus, code: number, reason?: string): void;
     onError(error: Error): void;
-    protected onInvoke<TServiceName extends keyof TService, TServiceMethod extends keyof TService[TServiceName], TMethod extends keyof TOutgoing, TPrivateMethod extends keyof TPrivateOutgoing>(request: InvokeMethodRequest<TOutgoing, TMethod> | InvokeMethodRequest<TPrivateOutgoing, TPrivateMethod> | InvokeServiceRequest<TService, TServiceName, TServiceMethod>): void;
+    protected onInvoke(request: AnyRequest): void;
     protected onMessage(data: ws.Data, isBinary: boolean): void;
     protected onOpen(): void;
     protected onPingPong(): void;
-    protected onRequest(packet: AnyPacket<TIncoming, TService>, timestamp: Date, pluginError?: Error): Promise<boolean>;
-    protected onResponse(response: AnyResponse<TOutgoing, TPrivateOutgoing, TService>, pluginError?: Error): void;
+    protected onRequest(packet: AnyPacket, timestamp: Date, pluginError?: Error): Promise<boolean>;
+    protected onResponse(response: AnyResponse, pluginError?: Error): void;
     private onSocketClose;
     private onSocketError;
     private onSocketMessage;
-    protected onTransmit<TServiceName extends keyof TService, TServiceMethod extends keyof TService[TServiceName], TMethod extends keyof TOutgoing>(request: TransmitMethodRequest<TOutgoing, TMethod> | TransmitServiceRequest<TService, TServiceName, TServiceMethod>): void;
-    protected onUnhandledRequest(packet: AnyPacket<TIncoming, TService>): boolean;
-    protected resetPingTimeout(timeoutMs: number | false, code: number): void;
+    protected onTransmit(request: AnyRequest): void;
+    protected onUnhandledRequest(_: AnyPacket): boolean;
+    protected resetPingTimeout(timeoutMs: false | number, code: number): void;
     send(data: Buffer | string): Promise<void>;
-    protected sendRequest(requests: (AnyRequest<TOutgoing, TPrivateOutgoing, TService>)[]): void;
-    protected sendRequest(index: number, requests: (AnyRequest<TOutgoing, TPrivateOutgoing, TService>)[]): void;
-    protected sendResponse(responses: (AnyResponse<TOutgoing, TPrivateOutgoing, TService>)[]): void;
-    protected sendResponse(index: number, responses: (AnyResponse<TOutgoing, TPrivateOutgoing, TService>)[]): void;
-    setAuthorization(authToken: AuthToken): Promise<boolean>;
+    protected sendRequest(requests: AnyRequest[]): void;
+    protected sendRequest(index: number, requests: AnyRequest[]): void;
+    protected sendResponse(responses: AnyResponse[]): void;
+    protected sendResponse(index: number, responses: AnyResponse[]): void;
     setAuthorization(signedAuthToken: SignedAuthToken, authToken?: AuthToken): Promise<boolean>;
     setReadyStatus(pingTimeoutMs: number, authError?: Error): void;
-    get signedAuthToken(): SignedAuthToken;
-    get socket(): Socket<TIncoming, TOutgoing, TPrivateOutgoing, TService, TState>;
-    set socket(value: Socket<TIncoming, TOutgoing, TPrivateOutgoing, TService, TState>);
+    get signedAuthToken(): null | SignedAuthToken;
+    get socket(): BaseSocket<TState>;
+    set socket(value: BaseSocket<TState>);
     get status(): SocketStatus;
+    transmit(serviceAndMethod: [string, string] | string, arg?: unknown): Promise<void>;
     triggerAuthenticationEvents(wasSigned: boolean, wasAuthenticated: boolean): void;
-    transmit<TMethod extends keyof TOutgoing>(method: TMethod, arg?: Parameters<TOutgoing[TMethod]>[0]): Promise<void>;
-    transmit<TServiceName extends keyof TService, TMethod extends keyof TService[TServiceName]>(options: [TServiceName, TMethod], arg?: Parameters<TService[TServiceName][TMethod]>[0]): Promise<void>;
-    transmit<TMethod extends keyof TPrivateOutgoing>(method: TMethod, arg?: Parameters<TPrivateOutgoing[TMethod]>[0]): Promise<void>;
-    invoke<TMethod extends keyof TOutgoing>(method: TMethod, arg?: Parameters<TOutgoing[TMethod]>[0]): [Promise<FunctionReturnType<TOutgoing[TMethod]>>, () => void];
-    invoke<TServiceName extends keyof TService, TMethod extends keyof TService[TServiceName]>(options: [TServiceName, TMethod, (number | false)?], arg?: Parameters<TService[TServiceName][TMethod]>[0]): [Promise<FunctionReturnType<TService[TServiceName][TMethod]>>, () => void];
-    invoke<TServiceName extends keyof TService, TMethod extends keyof TService[TServiceName]>(options: InvokeServiceOptions<TService, TServiceName, TMethod>, arg?: Parameters<TService[TServiceName][TMethod]>[0]): [Promise<FunctionReturnType<TService[TServiceName][TMethod]>>, () => void];
-    invoke<TMethod extends keyof TOutgoing>(options: InvokeMethodOptions<TOutgoing, TMethod>, arg?: Parameters<TOutgoing[TMethod]>[0]): [Promise<FunctionReturnType<TOutgoing[TMethod]>>, () => void];
-    invoke<TMethod extends keyof TPrivateOutgoing>(method: TMethod, arg: Parameters<TPrivateOutgoing[TMethod]>[0]): [Promise<FunctionReturnType<TPrivateOutgoing[TMethod]>>, () => void];
-    invoke<TMethod extends keyof TPrivateOutgoing>(options: InvokeMethodOptions<TPrivateOutgoing, TMethod>, arg?: Parameters<TPrivateOutgoing[TMethod]>[0]): [Promise<FunctionReturnType<TPrivateOutgoing[TMethod]>>, () => void];
     get url(): string;
-    protected get webSocket(): ws.WebSocket;
-    protected set webSocket(value: ws.WebSocket | null);
+    protected get webSocket(): null | ws.WebSocket;
+    protected set webSocket(value: null | ws.WebSocket);
 }