@superblocksteam/shared 0.9108.0

package/dist/socket/protocol.d.ts

@@ -0,0 +1,248 @@
+import { DirectoryEntry, PutManyRequestPayload, PutManyResponsePayload } from '../dbfs/types';
+import { ApiToSign, ApiToVerify, AppToSign, AppToVerify, ApplicationSignatureTreeSigned, Signature } from '../signing/constants';
+import { ApplicationConfiguration, ApplicationPageClonePayload, CreateApplicationPageResponseBody, CreateApplicationPageSocketPayload, GetMultiPageApplicationResponseBody, GetApiResponseBody, IApplicationV2Dto, PageSummary, PostApiBranchCreateResponseBody, PostApplicationBranchCreateResponseBody, PostApplicationCreateRequestBody, RemoteCommitDto, ResponseMeta, ExportedMultiPageApplicationDto, ExportViewMode, ExportedApiV3Dto, ModifyEntitiesPayload, ModifyEntitiesResponse, GetAppBranchLockResponseBody } from '../types';
+import { MethodSchema } from './types';
+export declare const serverWsPath = "v1/rpc-ws";
+type ResponseDto<T> = {
+    responseMeta: ResponseMeta;
+    data: T;
+};
+type ServerMethodSchema<Params, Response> = MethodSchema<Params, ResponseDto<Response>>;
+export interface ServerMethods {
+    v1: {
+        echo: ServerMethodSchema<{
+            message: string;
+        }, {
+            message: string;
+        }>;
+        public: {
+            application: {
+                component: {
+                    register: ServerMethodSchema<{
+                        applicationId: string;
+                        branchName: string;
+                        cliVersion: string;
+                        componentEvent: string;
+                        components: Record<string, unknown>;
+                    }, {
+                        success: boolean;
+                    }>;
+                    update: ServerMethodSchema<{
+                        applicationId: string;
+                        branchName?: string;
+                        srcFiles: string[];
+                        buildFiles: string[];
+                        registeredComponents: Record<string, never>;
+                        cliVersion: string | undefined;
+                        componentBaseUrl: string;
+                        signingRequired: boolean;
+                    }, {
+                        success: boolean;
+                    }>;
+                };
+                pushCommit: ServerMethodSchema<{
+                    applicationId: string;
+                    branchName: string;
+                    commitId: string;
+                    commitMessage: string;
+                    application: Record<string, unknown>;
+                    page: Record<string, unknown>;
+                    apis: Record<string, unknown>[];
+                    gitState: Record<string, unknown>;
+                }, RemoteCommitDto>;
+            };
+            api: {
+                pushCommit: ServerMethodSchema<{
+                    apiId: string;
+                    branchName: string;
+                    commitId: string;
+                    commitMessage: string;
+                    apiPb: Record<string, unknown>;
+                    gitState: Record<string, unknown>;
+                    skipCommit?: boolean;
+                }, RemoteCommitDto | {
+                    updated: Date;
+                }>;
+                get: ServerMethodSchema<{
+                    apiId: string;
+                    branchName?: string;
+                    viewMode: ExportViewMode;
+                    commitId?: string;
+                }, ExportedApiV3Dto>;
+            };
+        };
+        dbfs: {
+            fileContents: {
+                get: ServerMethodSchema<{
+                    hash: string;
+                }, {
+                    contents: string;
+                }>;
+                getByPath: ServerMethodSchema<{
+                    directoryHash: string;
+                    path: string;
+                }, {
+                    contents: string;
+                }>;
+                put: ServerMethodSchema<{
+                    contents: string;
+                }, {
+                    hash: string;
+                }>;
+            };
+            directoryContents: {
+                get: ServerMethodSchema<{
+                    hash: string;
+                }, {
+                    contents: DirectoryEntry[];
+                }>;
+                getByPath: ServerMethodSchema<{
+                    directoryHash: string;
+                    path: string;
+                }, {
+                    contents: DirectoryEntry[];
+                }>;
+                put: ServerMethodSchema<{
+                    contents: DirectoryEntry[];
+                }, {
+                    hash: string;
+                }>;
+            };
+            /**
+             * This method is used to put multiple files and directories at once. It is more efficient than calling the put method
+             * for each file and directory. The response is a list of hashes for the items that were put, in the same order as the items
+             * in the request.
+             */
+            putMany: ServerMethodSchema<PutManyRequestPayload, PutManyResponsePayload>;
+        };
+    };
+    v2: {
+        application: {
+            create: ServerMethodSchema<PostApplicationCreateRequestBody, IApplicationV2Dto>;
+            clone: ServerMethodSchema<{
+                applicationId: string;
+            }, IApplicationV2Dto>;
+            createBranch: ServerMethodSchema<{
+                applicationId: string;
+                branchName: string;
+                baseBranchName: string;
+            }, PostApplicationBranchCreateResponseBody>;
+            page: {
+                clone: ServerMethodSchema<ApplicationPageClonePayload, {
+                    page: PageSummary;
+                    updated: Date;
+                    signature: ApplicationSignatureTreeSigned | null;
+                    configuration: ApplicationConfiguration;
+                }>;
+                create: ServerMethodSchema<CreateApplicationPageSocketPayload, CreateApplicationPageResponseBody>;
+            };
+            modifyEntities: ServerMethodSchema<ModifyEntitiesPayload, ModifyEntitiesResponse>;
+        };
+        public: {
+            application: {
+                pushCommit: ServerMethodSchema<{
+                    applicationId: string;
+                    branchName: string;
+                    commitId: string;
+                    commitMessage: string;
+                    application: Record<string, unknown>;
+                    pages: Record<string, unknown>[];
+                    apis: Record<string, unknown>[];
+                    gitState: Record<string, unknown>;
+                    skipCommit?: boolean;
+                }, RemoteCommitDto | {
+                    updated: Date;
+                }>;
+                get: ServerMethodSchema<{
+                    applicationId: string;
+                    viewMode: ExportViewMode;
+                    branchName?: string;
+                    commitId?: string;
+                }, ExportedMultiPageApplicationDto>;
+            };
+        };
+    };
+    v3: {
+        application: {
+            get: ServerMethodSchema<{
+                applicationId: string;
+                branchName?: string;
+            }, GetMultiPageApplicationResponseBody>;
+            liveEditDirectoryContents: {
+                get: ServerMethodSchema<{
+                    applicationId: string;
+                    branchName?: string;
+                }, {
+                    hash: string;
+                }>;
+                set: ServerMethodSchema<{
+                    applicationId: string;
+                    branchName?: string;
+                    hash: string;
+                }, {
+                    hash: string;
+                }>;
+            };
+        };
+        api: {
+            createBranch: ServerMethodSchema<{
+                apiId: string;
+                branchName: string;
+                baseBranchName: string;
+            }, PostApiBranchCreateResponseBody>;
+            get: ServerMethodSchema<{
+                apiId: string;
+                branchName?: string;
+            }, GetApiResponseBody>;
+        };
+        lock: {
+            acquire: ServerMethodSchema<{
+                applicationId: string;
+                branchName: string;
+                sessionType: string;
+            }, GetAppBranchLockResponseBody>;
+            release: ServerMethodSchema<{
+                applicationId: string;
+                branchName: string;
+                lockId: string;
+            }, void>;
+            grab: ServerMethodSchema<{
+                applicationId: string;
+                branchName: string;
+                lockId: string;
+            }, GetAppBranchLockResponseBody>;
+        };
+    };
+}
+export interface ClientMethods {
+    v1: {
+        signing: {
+            signApplication: MethodSchema<{
+                branchName: string;
+                toSign: AppToSign;
+            }, {
+                signature: Signature;
+            }>;
+            signApis: MethodSchema<{
+                branchName: string;
+                toSign: ApiToSign[];
+            }, {
+                signatures: Signature[];
+            }>;
+            verifyApplication: MethodSchema<{
+                branchName: string;
+                toVerify: AppToVerify;
+            }, {
+                ok: boolean;
+            }>;
+            verifyApi: MethodSchema<{
+                branchName: string;
+                toVerify: ApiToVerify[];
+            }, {
+                ok: boolean;
+            }>;
+        };
+    };
+}
+export {};
+//# sourceMappingURL=protocol.d.ts.map

package/dist/socket/protocol.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../../src/socket/protocol.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAC;AAC9F,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,WAAW,EAAE,8BAA8B,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjI,OAAO,EACL,wBAAwB,EACxB,2BAA2B,EAC3B,iCAAiC,EACjC,kCAAkC,EAClC,mCAAmC,EACnC,kBAAkB,EAClB,iBAAiB,EACjB,WAAW,EACX,+BAA+B,EAC/B,uCAAuC,EACvC,gCAAgC,EAChC,eAAe,EACf,YAAY,EACZ,+BAA+B,EAC/B,cAAc,EACd,gBAAgB,EAChB,qBAAqB,EACrB,sBAAsB,EACtB,4BAA4B,EAC7B,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC,eAAO,MAAM,YAAY,cAAc,CAAC;AAExC,KAAK,WAAW,CAAC,CAAC,IAAI;IACpB,YAAY,EAAE,YAAY,CAAC;IAC3B,IAAI,EAAE,CAAC,CAAC;CACT,CAAC;AAEF,KAAK,kBAAkB,CAAC,MAAM,EAAE,QAAQ,IAAI,YAAY,CAAC,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC;AAGxF,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE;QACF,IAAI,EAAE,kBAAkB,CAAC;YAAE,OAAO,EAAE,MAAM,CAAA;SAAE,EAAE;YAAE,OAAO,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;QACnE,MAAM,EAAE;YACN,WAAW,EAAE;gBACX,SAAS,EAAE;oBACT,QAAQ,EAAE,kBAAkB,CAC1B;wBACE,aAAa,EAAE,MAAM,CAAC;wBACtB,UAAU,EAAE,MAAM,CAAC;wBACnB,UAAU,EAAE,MAAM,CAAC;wBACnB,cAAc,EAAE,MAAM,CAAC;wBACvB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;qBACrC,EACD;wBAAE,OAAO,EAAE,OAAO,CAAA;qBAAE,CACrB,CAAC;oBACF,MAAM,EAAE,kBAAkB,CACxB;wBACE,aAAa,EAAE,MAAM,CAAC;wBACtB,UAAU,CAAC,EAAE,MAAM,CAAC;wBACpB,QAAQ,EAAE,MAAM,EAAE,CAAC;wBACnB,UAAU,EAAE,MAAM,EAAE,CAAC;wBACrB,oBAAoB,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;wBAC5C,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;wBAC/B,gBAAgB,EAAE,MAAM,CAAC;wBACzB,eAAe,EAAE,OAAO,CAAC;qBAC1B,EACD;wBAAE,OAAO,EAAE,OAAO,CAAA;qBAAE,CACrB,CAAC;iBACH,CAAC;gBACF,UAAU,EAAE,kBAAkB,CAC5B;oBACE,aAAa,EAAE,MAAM,CAAC;oBACtB,UAAU,EAAE,MAAM,CAAC;oBACnB,QAAQ,EAAE,MAAM,CAAC;oBACjB,aAAa,EAAE,MAAM,CAAC;oBACtB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;oBACrC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;oBAC9B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;oBAChC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;iBACnC,EACD,eAAe,CAChB,CAAC;aACH,CAAC;YACF,GAAG,EAAE;gBACH,UAAU,EAAE,kBAAkB,CAC5B;oBACE,KAAK,EAAE,MAAM,CAAC;oBACd,UAAU,EAAE,MAAM,CAAC;oBACnB,QAAQ,EAAE,MAAM,CAAC;oBACjB,aAAa,EAAE,MAAM,CAAC;oBACtB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;oBAC/B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;oBAClC,UAAU,CAAC,EAAE,OAAO,CAAC;iBACtB,EACD,eAAe,GAAG;oBAAE,OAAO,EAAE,IAAI,CAAA;iBAAE,CACpC,CAAC;gBACF,GAAG,EAAE,kBAAkB,CAAC;oBAAE,KAAK,EAAE,MAAM,CAAC;oBAAC,UAAU,CAAC,EAAE,MAAM,CAAC;oBAAC,QAAQ,EAAE,cAAc,CAAC;oBAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;iBAAE,EAAE,gBAAgB,CAAC,CAAC;aAChI,CAAC;SACH,CAAC;QACF,IAAI,EAAE;YACJ,YAAY,EAAE;gBACZ,GAAG,EAAE,kBAAkB,CAAC;oBAAE,IAAI,EAAE,MAAM,CAAA;iBAAE,EAAE;oBAAE,QAAQ,EAAE,MAAM,CAAA;iBAAE,CAAC,CAAC;gBAChE,SAAS,EAAE,kBAAkB,CAAC;oBAAE,aAAa,EAAE,MAAM,CAAC;oBAAC,IAAI,EAAE,MAAM,CAAA;iBAAE,EAAE;oBAAE,QAAQ,EAAE,MAAM,CAAA;iBAAE,CAAC,CAAC;gBAC7F,GAAG,EAAE,kBAAkB,CAAC;oBAAE,QAAQ,EAAE,MAAM,CAAA;iBAAE,EAAE;oBAAE,IAAI,EAAE,MAAM,CAAA;iBAAE,CAAC,CAAC;aACjE,CAAC;YACF,iBAAiB,EAAE;gBACjB,GAAG,EAAE,kBAAkB,CAAC;oBAAE,IAAI,EAAE,MAAM,CAAA;iBAAE,EAAE;oBAAE,QAAQ,EAAE,cAAc,EAAE,CAAA;iBAAE,CAAC,CAAC;gBAC1E,SAAS,EAAE,kBAAkB,CAAC;oBAAE,aAAa,EAAE,MAAM,CAAC;oBAAC,IAAI,EAAE,MAAM,CAAA;iBAAE,EAAE;oBAAE,QAAQ,EAAE,cAAc,EAAE,CAAA;iBAAE,CAAC,CAAC;gBACvG,GAAG,EAAE,kBAAkB,CAAC;oBAAE,QAAQ,EAAE,cAAc,EAAE,CAAA;iBAAE,EAAE;oBAAE,IAAI,EAAE,MAAM,CAAA;iBAAE,CAAC,CAAC;aAC3E,CAAC;YACF;;;;eAIG;YACH,OAAO,EAAE,kBAAkB,CAAC,qBAAqB,EAAE,sBAAsB,CAAC,CAAC;SAC5E,CAAC;KACH,CAAC;IACF,EAAE,EAAE;QACF,WAAW,EAAE;YACX,MAAM,EAAE,kBAAkB,CAAC,gCAAgC,EAAE,iBAAiB,CAAC,CAAC;YAChF,KAAK,EAAE,kBAAkB,CAAC;gBAAE,aAAa,EAAE,MAAM,CAAA;aAAE,EAAE,iBAAiB,CAAC,CAAC;YACxE,YAAY,EAAE,kBAAkB,CAC9B;gBAAE,aAAa,EAAE,MAAM,CAAC;gBAAC,UAAU,EAAE,MAAM,CAAC;gBAAC,cAAc,EAAE,MAAM,CAAA;aAAE,EACrE,uCAAuC,CACxC,CAAC;YACF,IAAI,EAAE;gBACJ,KAAK,EAAE,kBAAkB,CACvB,2BAA2B,EAC3B;oBACE,IAAI,EAAE,WAAW,CAAC;oBAClB,OAAO,EAAE,IAAI,CAAC;oBACd,SAAS,EAAE,8BAA8B,GAAG,IAAI,CAAC;oBACjD,aAAa,EAAE,wBAAwB,CAAC;iBACzC,CACF,CAAC;gBACF,MAAM,EAAE,kBAAkB,CAAC,kCAAkC,EAAE,iCAAiC,CAAC,CAAC;aACnG,CAAC;YACF,cAAc,EAAE,kBAAkB,CAAC,qBAAqB,EAAE,sBAAsB,CAAC,CAAC;SACnF,CAAC;QACF,MAAM,EAAE;YACN,WAAW,EAAE;gBACX,UAAU,EAAE,kBAAkB,CAC5B;oBACE,aAAa,EAAE,MAAM,CAAC;oBACtB,UAAU,EAAE,MAAM,CAAC;oBACnB,QAAQ,EAAE,MAAM,CAAC;oBACjB,aAAa,EAAE,MAAM,CAAC;oBACtB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;oBACrC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;oBACjC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;oBAChC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;oBAClC,UAAU,CAAC,EAAE,OAAO,CAAC;iBACtB,EACD,eAAe,GAAG;oBAAE,OAAO,EAAE,IAAI,CAAA;iBAAE,CACpC,CAAC;gBACF,GAAG,EAAE,kBAAkB,CACrB;oBAAE,aAAa,EAAE,MAAM,CAAC;oBAAC,QAAQ,EAAE,cAAc,CAAC;oBAAC,UAAU,CAAC,EAAE,MAAM,CAAC;oBAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;iBAAE,EAC3F,+BAA+B,CAChC,CAAC;aACH,CAAC;SACH,CAAC;KACH,CAAC;IACF,EAAE,EAAE;QACF,WAAW,EAAE;YACX,GAAG,EAAE,kBAAkB,CAAC;gBAAE,aAAa,EAAE,MAAM,CAAC;gBAAC,UAAU,CAAC,EAAE,MAAM,CAAA;aAAE,EAAE,mCAAmC,CAAC,CAAC;YAC7G,yBAAyB,EAAE;gBACzB,GAAG,EAAE,kBAAkB,CAAC;oBAAE,aAAa,EAAE,MAAM,CAAC;oBAAC,UAAU,CAAC,EAAE,MAAM,CAAA;iBAAE,EAAE;oBAAE,IAAI,EAAE,MAAM,CAAA;iBAAE,CAAC,CAAC;gBAC1F,GAAG,EAAE,kBAAkB,CAAC;oBAAE,aAAa,EAAE,MAAM,CAAC;oBAAC,UAAU,CAAC,EAAE,MAAM,CAAC;oBAAC,IAAI,EAAE,MAAM,CAAA;iBAAE,EAAE;oBAAE,IAAI,EAAE,MAAM,CAAA;iBAAE,CAAC,CAAC;aACzG,CAAC;SACH,CAAC;QACF,GAAG,EAAE;YACH,YAAY,EAAE,kBAAkB,CAAC;gBAAE,KAAK,EAAE,MAAM,CAAC;gBAAC,UAAU,EAAE,MAAM,CAAC;gBAAC,cAAc,EAAE,MAAM,CAAA;aAAE,EAAE,+BAA+B,CAAC,CAAC;YACjI,GAAG,EAAE,kBAAkB,CAAC;gBAAE,KAAK,EAAE,MAAM,CAAC;gBAAC,UAAU,CAAC,EAAE,MAAM,CAAA;aAAE,EAAE,kBAAkB,CAAC,CAAC;SACrF,CAAC;QACF,IAAI,EAAE;YACJ,OAAO,EAAE,kBAAkB,CAAC;gBAAE,aAAa,EAAE,MAAM,CAAC;gBAAC,UAAU,EAAE,MAAM,CAAC;gBAAC,WAAW,EAAE,MAAM,CAAA;aAAE,EAAE,4BAA4B,CAAC,CAAC;YAC9H,OAAO,EAAE,kBAAkB,CAAC;gBAAE,aAAa,EAAE,MAAM,CAAC;gBAAC,UAAU,EAAE,MAAM,CAAC;gBAAC,MAAM,EAAE,MAAM,CAAA;aAAE,EAAE,IAAI,CAAC,CAAC;YACjG,IAAI,EAAE,kBAAkB,CAAC;gBAAE,aAAa,EAAE,MAAM,CAAC;gBAAC,UAAU,EAAE,MAAM,CAAC;gBAAC,MAAM,EAAE,MAAM,CAAA;aAAE,EAAE,4BAA4B,CAAC,CAAC;SACvH,CAAC;KACH,CAAC;CACH;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE;QACF,OAAO,EAAE;YACP,eAAe,EAAE,YAAY,CAAC;gBAAE,UAAU,EAAE,MAAM,CAAC;gBAAC,MAAM,EAAE,SAAS,CAAA;aAAE,EAAE;gBAAE,SAAS,EAAE,SAAS,CAAA;aAAE,CAAC,CAAC;YACnG,QAAQ,EAAE,YAAY,CAAC;gBAAE,UAAU,EAAE,MAAM,CAAC;gBAAC,MAAM,EAAE,SAAS,EAAE,CAAA;aAAE,EAAE;gBAAE,UAAU,EAAE,SAAS,EAAE,CAAA;aAAE,CAAC,CAAC;YACjG,iBAAiB,EAAE,YAAY,CAAC;gBAAE,UAAU,EAAE,MAAM,CAAC;gBAAC,QAAQ,EAAE,WAAW,CAAA;aAAE,EAAE;gBAAE,EAAE,EAAE,OAAO,CAAA;aAAE,CAAC,CAAC;YAChG,SAAS,EAAE,YAAY,CAAC;gBAAE,UAAU,EAAE,MAAM,CAAC;gBAAC,QAAQ,EAAE,WAAW,EAAE,CAAA;aAAE,EAAE;gBAAE,EAAE,EAAE,OAAO,CAAA;aAAE,CAAC,CAAC;SAC3F,CAAC;KACH,CAAC;CACH"}

package/dist/socket/protocol.js

@@ -0,0 +1,6 @@
+"use strict";
+// This file contains the definition of the protocol used for communication between the SB server and clients
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serverWsPath = void 0;
+exports.serverWsPath = 'v1/rpc-ws';
+//# sourceMappingURL=protocol.js.map

package/dist/socket/protocol.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocol.js","sourceRoot":"","sources":["../../src/socket/protocol.ts"],"names":[],"mappings":";AAAA,6GAA6G;;;AA2BhG,QAAA,YAAY,GAAG,WAAW,CAAC"}

package/dist/socket/socket.d.ts

@@ -0,0 +1,65 @@
+import WebSocket from 'isomorphic-ws';
+import { ISocketClient, MethodHandler, MethodHandlers, RequestContextBase, SocketTimeouts, GenericMiddleware } from './types';
+interface SocketRequest<Payload = unknown> {
+    method: string;
+    payload: Payload;
+    id: number;
+    setAuthorization?: string;
+    traceparent?: string;
+    tracestate?: string;
+}
+interface SocketResponse<Payload = unknown> {
+    id: number;
+    payload: Payload;
+    error: SocketError | null;
+}
+export interface SocketMessage<RequestPayload = unknown, ResponsePayload = unknown> {
+    request?: SocketRequest<RequestPayload>;
+    response?: SocketResponse<ResponsePayload>;
+}
+export interface SocketError {
+    message: string;
+    code: number;
+}
+/**
+ * ISocket is a class that wraps a WebSocket connection and provides a simple interface for sending and receiving messages.
+ * ISocket is initialized by both server and client and request/response is called symmetrically.
+ *
+ * ISocket handles has two timeout actions:
+ * 1. Connection timeout: If the connection is not closed after a certain time, the connection is closed.
+ *  - This is useful to prevent a connection from being open indefinitely. This is mainly used in the server side since
+ *    the client side manages connection lifecycle manually.
+ * 2. No response timeout: If the response is not received after a certain time, the request is timed out.
+ *  - This is mainly used by CLI to handle the case where the server is not responding.
+ *
+ * It is expected that timeouts should be relatively sorted in the order of connection timeout > request timeout > no response timeout.
+ */
+export declare class ISocket<ImplementedMethods, CallableMethods, RequestContext extends RequestContextBase> {
+    private readonly ws;
+    private readonly requestHandlers;
+    private readonly globalMiddlewares;
+    private readonly responseHandler;
+    private peerAuthorization?;
+    protected nxtRequestId: number;
+    private connectionTimeout;
+    protected logger: {
+        error: (message?: string) => void;
+    };
+    private timeouts?;
+    constructor(ws: WebSocket, requestHandlers: MethodHandlers<ImplementedMethods, CallableMethods, RequestContext>, globalMiddlewares: GenericMiddleware<CallableMethods, RequestContext>[], timeouts?: SocketTimeouts, logger?: {
+        error: (message?: string) => void;
+    });
+    protected handleMessage(message: SocketMessage): Promise<void>;
+    protected callHandler<Params, Result, CallableMethods, RequestContext extends RequestContextBase>(handler: MethodHandler<Params, Result, CallableMethods, RequestContext>, params: Params, ctx: RequestContext, client: ISocketClient<CallableMethods>, next: () => Promise<Result>): Promise<Result>;
+    request<Params, Result>(method: string, params: Params, authorization?: string): Promise<Result>;
+    protected respond<Result>(requestId: number, result: Result): void;
+    protected respondError(requestId: number, error: SocketError, exception?: Error): void;
+    private resetConnectionTimeout;
+    private handleConnectionTimeout;
+    private resetNoResponseTimeout;
+    private handleNoResponseTimeout;
+    close(): void;
+}
+export declare function createISocketClient<CallableMethods, ImplementedMethods, RequestContext extends RequestContextBase>(socket: ISocket<ImplementedMethods, CallableMethods, RequestContext>): ISocketClient<CallableMethods>;
+export {};
+//# sourceMappingURL=socket.d.ts.map

package/dist/socket/socket.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"socket.d.ts","sourceRoot":"","sources":["../../src/socket/socket.ts"],"names":[],"mappings":"AACA,OAAO,SAAS,MAAM,eAAe,CAAC;AACtC,OAAO,EACL,aAAa,EACb,aAAa,EACb,cAAc,EACd,kBAAkB,EAClB,cAAc,EAEd,iBAAiB,EAClB,MAAM,SAAS,CAAC;AAEjB,UAAU,aAAa,CAAC,OAAO,GAAG,OAAO;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,UAAU,cAAc,CAAC,OAAO,GAAG,OAAO;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,WAAW,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,aAAa,CAAC,cAAc,GAAG,OAAO,EAAE,eAAe,GAAG,OAAO;IAChF,OAAO,CAAC,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;IACxC,QAAQ,CAAC,EAAE,cAAc,CAAC,eAAe,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,OAAO,CAAC,kBAAkB,EAAE,eAAe,EAAE,cAAc,SAAS,kBAAkB;IACjG,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAY;IAC/B,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAsE;IACtG,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAuD;IACzF,OAAO,CAAC,QAAQ,CAAC,eAAe,CAG5B;IACJ,OAAO,CAAC,iBAAiB,CAAC,CAAS;IACnC,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC;IAC/B,OAAO,CAAC,iBAAiB,CAAiB;IAE1C,SAAS,CAAC,MAAM,EAAE;QAAE,KAAK,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;KAAE,CAAC;IACxD,OAAO,CAAC,QAAQ,CAAC,CAAiB;gBAGhC,EAAE,EAAE,SAAS,EACb,eAAe,EAAE,cAAc,CAAC,kBAAkB,EAAE,eAAe,EAAE,cAAc,CAAC,EACpF,iBAAiB,EAAE,iBAAiB,CAAC,eAAe,EAAE,cAAc,CAAC,EAAE,EACvE,QAAQ,CAAC,EAAE,cAAc,EACzB,MAAM,CAAC,EAAE;QAAE,KAAK,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;KAAE;cAkBhC,aAAa,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;cAkFpD,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,cAAc,SAAS,kBAAkB,EACpG,OAAO,EAAE,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,cAAc,CAAC,EACvE,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,cAAc,EACnB,MAAM,EAAE,aAAa,CAAC,eAAe,CAAC,EACtC,IAAI,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,GAC1B,OAAO,CAAC,MAAM,CAAC;IAIX,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAcvG,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;IAWlE,SAAS,CAAC,YAAY,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,SAAS,CAAC,EAAE,KAAK,GAAG,IAAI;IAWtF,OAAO,CAAC,sBAAsB;IAW9B,OAAO,CAAC,uBAAuB;IAO/B,OAAO,CAAC,sBAAsB;IAiB9B,OAAO,CAAC,uBAAuB;IAQxB,KAAK,IAAI,IAAI;CASrB;AAoCD,wBAAgB,mBAAmB,CAAC,eAAe,EAAE,kBAAkB,EAAE,cAAc,SAAS,kBAAkB,EAChH,MAAM,EAAE,OAAO,CAAC,kBAAkB,EAAE,eAAe,EAAE,cAAc,CAAC,GACnE,aAAa,CAAC,eAAe,CAAC,CAMhC"}

package/dist/socket/socket.js

@@ -0,0 +1,241 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createISocketClient = exports.ISocket = void 0;
+const api_1 = require("@opentelemetry/api");
+const types_1 = require("./types");
+/**
+ * ISocket is a class that wraps a WebSocket connection and provides a simple interface for sending and receiving messages.
+ * ISocket is initialized by both server and client and request/response is called symmetrically.
+ *
+ * ISocket handles has two timeout actions:
+ * 1. Connection timeout: If the connection is not closed after a certain time, the connection is closed.
+ *  - This is useful to prevent a connection from being open indefinitely. This is mainly used in the server side since
+ *    the client side manages connection lifecycle manually.
+ * 2. No response timeout: If the response is not received after a certain time, the request is timed out.
+ *  - This is mainly used by CLI to handle the case where the server is not responding.
+ *
+ * It is expected that timeouts should be relatively sorted in the order of connection timeout > request timeout > no response timeout.
+ */
+class ISocket {
+    constructor(ws, requestHandlers, globalMiddlewares, timeouts, logger) {
+        this.responseHandler = new Map();
+        this.ws = ws;
+        this.requestHandlers = requestHandlers;
+        this.globalMiddlewares = globalMiddlewares;
+        this.nxtRequestId = 0;
+        this.logger = logger ?? { error: console.error };
+        this.timeouts = timeouts;
+        // reset connection timeout in each message received. It means connection still active
+        this.resetConnectionTimeout();
+        // eslint-disable-next-line @typescript-eslint/no-misused-promises
+        this.ws.addEventListener('message', async (event) => {
+            const eventData = JSON.parse(event.data.toString());
+            return this.handleMessage(eventData);
+        });
+    }
+    async handleMessage(message) {
+        this.resetConnectionTimeout();
+        if (message.request) {
+            // Split the method string into parts
+            const parts = message.request.method.split('.');
+            let handlers = this.requestHandlers;
+            for (const part of parts) {
+                handlers = handlers[part];
+                if (!handlers) {
+                    return this.respondError(message.request.id, {
+                        code: 2,
+                        message: `unknown method ${message.request.method}`
+                    });
+                }
+            }
+            if (!Array.isArray(handlers)) {
+                return this.respondError(message.request.id, {
+                    code: 2,
+                    message: 'unknown method'
+                });
+            }
+            handlers = [...this.globalMiddlewares, ...handlers];
+            if (message.request.setAuthorization) {
+                this.peerAuthorization = message.request.setAuthorization;
+            }
+            const reqCtx = {
+                peerAuthorization: this.peerAuthorization,
+                method: message.request.method,
+                requestId: message.request.id
+            };
+            const client = createISocketClient(this);
+            const payload = message.request.payload;
+            let alreadyResponded = false;
+            const generateNextFn = (idx) => {
+                let wasCalled = false;
+                return async () => {
+                    if (alreadyResponded) {
+                        throw new types_1.SocketErrorException(4, 'next() was called after the response was sent');
+                    }
+                    const handler = handlers[idx];
+                    if (!handler) {
+                        throw new types_1.SocketErrorException(5, 'cannot call past the last handler in the chain');
+                    }
+                    if (wasCalled) {
+                        throw new types_1.SocketErrorException(6, 'next() was called multiple times');
+                    }
+                    wasCalled = true;
+                    return this.callHandler(handler, payload, reqCtx, client, generateNextFn(idx + 1));
+                };
+            };
+            let response;
+            try {
+                // call the first handler in the chain
+                response = await generateNextFn(0)();
+            }
+            catch (error) {
+                const socketError = error instanceof types_1.SocketErrorException ? { code: error.code, message: error.message } : { code: 3, message: error.toString() };
+                return this.respondError(message.request.id, socketError, error);
+            }
+            this.respond(message.request.id, response);
+            alreadyResponded = true;
+        }
+        else if (message.response && message.response.id) {
+            const responseHandler = this.responseHandler.get(message.response.id);
+            if (!responseHandler) {
+                return;
+            }
+            if (message.response.error) {
+                responseHandler.reject(message.response.error);
+            }
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            responseHandler.resolve(message.response.payload);
+            clearTimeout(responseHandler.timeout);
+            this.responseHandler.delete(message.response.id);
+        }
+        else {
+            return this.respondError(-1, {
+                code: 3,
+                message: 'unknown request id'
+            });
+        }
+    }
+    async callHandler(handler, params, ctx, client, next) {
+        return handler(params, ctx, client, next);
+    }
+    request(method, params, authorization) {
+        return new Promise((resolve, reject) => {
+            const requestId = ++this.nxtRequestId;
+            this.responseHandler.set(requestId, {
+                resolve: (result) => resolve(result),
+                reject: (error) => reject(error)
+            });
+            const toSend = { request: { method, payload: params, id: requestId, setAuthorization: authorization } };
+            api_1.propagation.inject(api_1.context.active(), toSend.request);
+            this.ws.send(JSON.stringify(toSend));
+            this.resetNoResponseTimeout(requestId);
+        });
+    }
+    respond(requestId, result) {
+        const toSend = {
+            response: {
+                payload: result,
+                id: requestId,
+                error: null
+            }
+        };
+        return this.ws.send(JSON.stringify(toSend));
+    }
+    respondError(requestId, error, exception) {
+        const toSend = {
+            response: {
+                payload: null,
+                id: requestId,
+                error: error
+            }
+        };
+        return this.ws.send(JSON.stringify(toSend));
+    }
+    resetConnectionTimeout() {
+        if (!this.timeouts?.connectionTimeoutInSeconds) {
+            return;
+        }
+        if (this.connectionTimeout) {
+            clearTimeout(this.connectionTimeout);
+        }
+        // Set a new timeout for the next message
+        this.connectionTimeout = setTimeout(this.handleConnectionTimeout(), this.timeouts?.connectionTimeoutInSeconds * 1000);
+    }
+    handleConnectionTimeout() {
+        return () => {
+            this.logger.error(`Connection timed out after ${this.timeouts?.connectionTimeoutInSeconds} seconds`);
+            this.close();
+        };
+    }
+    resetNoResponseTimeout(requestId) {
+        if (!this.timeouts?.noResponseTimeoutInSeconds) {
+            return;
+        }
+        const responseHandler = this.responseHandler.get(requestId);
+        if (!responseHandler) {
+            return;
+        }
+        const noResponseTimeout = responseHandler.timeout;
+        const reject = responseHandler.reject;
+        if (responseHandler.timeout) {
+            clearTimeout(noResponseTimeout);
+        }
+        // Set a new timeout for the next message
+        responseHandler.timeout = setTimeout(this.handleNoResponseTimeout(reject), this.timeouts?.noResponseTimeoutInSeconds * 1000);
+    }
+    handleNoResponseTimeout(reject) {
+        return () => {
+            const message = `Request timed out after ${this.timeouts?.noResponseTimeoutInSeconds} seconds`;
+            this.logger.error(message);
+            reject({ code: 7, message });
+        };
+    }
+    close() {
+        clearTimeout(this.connectionTimeout);
+        this.responseHandler.forEach((handler, key) => {
+            clearTimeout(handler.timeout);
+            this.logger.error(`Rejecting pending requestId ${key} due to connection close`);
+            handler.reject({ code: 8, message: 'Connection closed' });
+        });
+        this.ws.close();
+    }
+}
+exports.ISocket = ISocket;
+const proxyTarget = Object.freeze(() => {
+    /* return nothing */
+});
+function createIsocketProxy(socket, 
+// if path is undefined, it means the current object is the root object
+path) {
+    return new Proxy(proxyTarget, {
+        get(_target, prop) {
+            const childPath = path ? `${path}.${prop}` : prop;
+            // sometimes, when `createISocketClient` is called from an async function, JS will implicitly call the `then` method on
+            // its return value, because promises can be arbitrarily nested
+            // so return undefined for the `then` method to avoid this
+            if (childPath === 'then') {
+                return undefined;
+            }
+            return createIsocketProxy(socket, childPath);
+        },
+        apply(_target, _thisArg, args) {
+            if (path === undefined) {
+                throw new Error('The root object is not callable');
+            }
+            if (path.endsWith('.apply') && args.length === 2 && Array.isArray(args[1])) {
+                path = path.slice(0, -'.apply'.length);
+                args = args[1];
+            }
+            return socket.request(path, args[0]);
+        }
+    });
+}
+function createISocketClient(socket) {
+    return {
+        close: () => socket.close(),
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        call: createIsocketProxy(socket, undefined)
+    };
+}
+exports.createISocketClient = createISocketClient;
+//# sourceMappingURL=socket.js.map

package/dist/socket/socket.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"socket.js","sourceRoot":"","sources":["../../src/socket/socket.ts"],"names":[],"mappings":";;;AAAA,4CAAqE;AAErE,mCAQiB;AA2BjB;;;;;;;;;;;;GAYG;AACH,MAAa,OAAO;IAelB,YACE,EAAa,EACb,eAAoF,EACpF,iBAAuE,EACvE,QAAyB,EACzB,MAA8C;QAhB/B,oBAAe,GAAG,IAAI,GAAG,EAGvC,CAAC;QAeF,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAC3C,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;QACtB,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;QACjD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,sFAAsF;QACtF,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAE9B,kEAAkE;QAClE,IAAI,CAAC,EAAE,CAAC,gBAAgB,CAAC,SAAS,EAAE,KAAK,EAAE,KAA6B,EAAE,EAAE;YAC1E,MAAM,SAAS,GAAkB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;YACnE,OAAO,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC;IAES,KAAK,CAAC,aAAa,CAAC,OAAsB;QAClD,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC9B,IAAI,OAAO,CAAC,OAAO,EAAE;YACnB,qCAAqC;YACrC,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAChD,IAAI,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC;YACpC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;gBACxB,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAC1B,IAAI,CAAC,QAAQ,EAAE;oBACb,OAAO,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE;wBAC3C,IAAI,EAAE,CAAC;wBACP,OAAO,EAAE,kBAAkB,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE;qBACpD,CAAC,CAAC;iBACJ;aACF;YAED,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;gBAC5B,OAAO,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE;oBAC3C,IAAI,EAAE,CAAC;oBACP,OAAO,EAAE,gBAAgB;iBAC1B,CAAC,CAAC;aACJ;YACD,QAAQ,GAAG,CAAC,GAAG,IAAI,CAAC,iBAAiB,EAAE,GAAG,QAAQ,CAAwE,CAAC;YAC3H,IAAI,OAAO,CAAC,OAAO,CAAC,gBAAgB,EAAE;gBACpC,IAAI,CAAC,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC;aAC3D;YACD,MAAM,MAAM,GAAG;gBACb,iBAAiB,EAAE,IAAI,CAAC,iBAAiB;gBACzC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,MAAM;gBAC9B,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE;aACZ,CAAC;YACpB,MAAM,MAAM,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC;YACzC,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC;YACxC,IAAI,gBAAgB,GAAG,KAAK,CAAC;YAC7B,MAAM,cAAc,GAAG,CAAC,GAAW,EAA4B,EAAE;gBAC/D,IAAI,SAAS,GAAG,KAAK,CAAC;gBACtB,OAAO,KAAK,IAAI,EAAE;oBAChB,IAAI,gBAAgB,EAAE;wBACpB,MAAM,IAAI,4BAAoB,CAAC,CAAC,EAAE,+CAA+C,CAAC,CAAC;qBACpF;oBACD,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAiF,CAAC;oBAC9G,IAAI,CAAC,OAAO,EAAE;wBACZ,MAAM,IAAI,4BAAoB,CAAC,CAAC,EAAE,gDAAgD,CAAC,CAAC;qBACrF;oBACD,IAAI,SAAS,EAAE;wBACb,MAAM,IAAI,4BAAoB,CAAC,CAAC,EAAE,kCAAkC,CAAC,CAAC;qBACvE;oBACD,SAAS,GAAG,IAAI,CAAC;oBACjB,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;gBACrF,CAAC,CAAC;YACJ,CAAC,CAAC;YACF,IAAI,QAAiB,CAAC;YACtB,IAAI;gBACF,sCAAsC;gBACtC,QAAQ,GAAG,MAAM,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;aACtC;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,WAAW,GACf,KAAK,YAAY,4BAAoB,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC;gBAChI,OAAO,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC;aAClE;YACD,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;YAC3C,gBAAgB,GAAG,IAAI,CAAC;SACzB;aAAM,IAAI,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE;YAClD,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACtE,IAAI,CAAC,eAAe,EAAE;gBACpB,OAAO;aACR;YACD,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE;gBAC1B,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;aAChD;YACD,8DAA8D;YAC9D,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAc,CAAC,CAAC;YACzD,YAAY,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;YACtC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;SAClD;aAAM;YACL,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE;gBAC3B,IAAI,EAAE,CAAC;gBACP,OAAO,EAAE,oBAAoB;aAC9B,CAAC,CAAC;SACJ;IACH,CAAC;IAES,KAAK,CAAC,WAAW,CACzB,OAAuE,EACvE,MAAc,EACd,GAAmB,EACnB,MAAsC,EACtC,IAA2B;QAE3B,OAAO,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IAC5C,CAAC;IAEM,OAAO,CAAiB,MAAc,EAAE,MAAc,EAAE,aAAsB;QACnF,OAAO,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC7C,MAAM,SAAS,GAAG,EAAE,IAAI,CAAC,YAAY,CAAC;YACtC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,SAAS,EAAE;gBAClC,OAAO,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,MAAgB,CAAC;gBAC9C,MAAM,EAAE,CAAC,KAAkB,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC;aAC9C,CAAC,CAAC;YACH,MAAM,MAAM,GAAkB,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,SAAS,EAAE,gBAAgB,EAAE,aAAa,EAAE,EAAE,CAAC;YACvH,iBAAW,CAAC,MAAM,CAAC,aAAO,CAAC,MAAM,EAAE,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;YACrD,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;YACrC,IAAI,CAAC,sBAAsB,CAAC,SAAS,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC;IAES,OAAO,CAAS,SAAiB,EAAE,MAAc;QACzD,MAAM,MAAM,GAAkB;YAC5B,QAAQ,EAAE;gBACR,OAAO,EAAE,MAAM;gBACf,EAAE,EAAE,SAAS;gBACb,KAAK,EAAE,IAAI;aACZ;SACF,CAAC;QACF,OAAO,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;IAC9C,CAAC;IAES,YAAY,CAAC,SAAiB,EAAE,KAAkB,EAAE,SAAiB;QAC7E,MAAM,MAAM,GAAkB;YAC5B,QAAQ,EAAE;gBACR,OAAO,EAAE,IAAI;gBACb,EAAE,EAAE,SAAS;gBACb,KAAK,EAAE,KAAK;aACb;SACF,CAAC;QACF,OAAO,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;IAC9C,CAAC;IAEO,sBAAsB;QAC5B,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,0BAA0B,EAAE;YAC9C,OAAO;SACR;QACD,IAAI,IAAI,CAAC,iBAAiB,EAAE;YAC1B,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;SACtC;QACD,yCAAyC;QACzC,IAAI,CAAC,iBAAiB,GAAG,UAAU,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,CAAC,QAAQ,EAAE,0BAA0B,GAAG,IAAI,CAAC,CAAC;IACxH,CAAC;IAEO,uBAAuB;QAC7B,OAAO,GAAG,EAAE;YACV,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,8BAA8B,IAAI,CAAC,QAAQ,EAAE,0BAA0B,UAAU,CAAC,CAAC;YACrG,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,CAAC,CAAC;IACJ,CAAC;IAEO,sBAAsB,CAAC,SAAiB;QAC9C,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,0BAA0B,EAAE;YAC9C,OAAO;SACR;QACD,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC5D,IAAI,CAAC,eAAe,EAAE;YACpB,OAAO;SACR;QACD,MAAM,iBAAiB,GAAG,eAAe,CAAC,OAAO,CAAC;QAClD,MAAM,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC;QACtC,IAAI,eAAe,CAAC,OAAO,EAAE;YAC3B,YAAY,CAAC,iBAAiB,CAAC,CAAC;SACjC;QACD,yCAAyC;QACzC,eAAe,CAAC,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,QAAQ,EAAE,0BAA0B,GAAG,IAAI,CAAC,CAAC;IAC/H,CAAC;IAEO,uBAAuB,CAAC,MAAoC;QAClE,OAAO,GAAG,EAAE;YACV,MAAM,OAAO,GAAG,2BAA2B,IAAI,CAAC,QAAQ,EAAE,0BAA0B,UAAU,CAAC;YAC/F,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC3B,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QAC/B,CAAC,CAAC;IACJ,CAAC;IAEM,KAAK;QACV,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACrC,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE;YAC5C,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAC9B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,+BAA+B,GAAG,0BAA0B,CAAC,CAAC;YAChF,OAAO,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,mBAAmB,EAAE,CAAC,CAAC;QAC5D,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC;IAClB,CAAC;CACF;AA1ND,0BA0NC;AAED,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE;IACrC,oBAAoB;AACtB,CAAC,CAAC,CAAC;AAEH,SAAS,kBAAkB,CACzB,MAAoE;AACpE,uEAAuE;AACvE,IAAwB;IAExB,OAAO,IAAI,KAAK,CAAC,WAAW,EAAE;QAC5B,GAAG,CAAC,OAAO,EAAE,IAAY;YACvB,MAAM,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;YAClD,uHAAuH;YACvH,+DAA+D;YAC/D,0DAA0D;YAC1D,IAAI,SAAS,KAAK,MAAM,EAAE;gBACxB,OAAO,SAAS,CAAC;aAClB;YACD,OAAO,kBAAkB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAC/C,CAAC;QAED,KAAK,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAe;YACtC,IAAI,IAAI,KAAK,SAAS,EAAE;gBACtB,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;aACpD;YACD,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE;gBAC1E,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;gBACvC,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;aAChB;YACD,OAAO,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACvC,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,mBAAmB,CACjC,MAAoE;IAEpE,OAAO;QACL,KAAK,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE;QAC3B,8DAA8D;QAC9D,IAAI,EAAE,kBAAkB,CAAC,MAAM,EAAE,SAAS,CAAQ;KACnD,CAAC;AACJ,CAAC;AARD,kDAQC"}

package/dist/socket/socketWithClientAuth.d.ts

@@ -0,0 +1,11 @@
+import WebSocket from 'isomorphic-ws';
+import { ISocket } from './socket';
+import { GenericMiddleware, ISocketClient, MethodHandlers, RequestContextBase, SocketTimeouts } from './types';
+export declare class ISocketWithClientAuth<ImplementedMethods, CallableMethods, RequestContext extends RequestContextBase> extends ISocket<ImplementedMethods, CallableMethods, RequestContext> {
+    private readonly authorization?;
+    private hasSentAuth;
+    constructor(ws: WebSocket, authorization: string | undefined, requestHandlers: MethodHandlers<ImplementedMethods, CallableMethods, RequestContext>, globalMiddlewares: GenericMiddleware<CallableMethods, RequestContext>[], timeouts?: SocketTimeouts);
+    request<Params, Result>(method: string, params: Params): Promise<Result>;
+}
+export declare function connectISocket<CallableMethods, ImplementedMethods, RequestContext extends RequestContextBase = RequestContextBase>(wsUrl: string, authorization: string | undefined, requestHandlers: MethodHandlers<ImplementedMethods, CallableMethods, RequestContext>, globalMiddlewares: GenericMiddleware<CallableMethods, RequestContext>[], timeouts?: SocketTimeouts): Promise<ISocketClient<CallableMethods>>;
+//# sourceMappingURL=socketWithClientAuth.d.ts.map

package/dist/socket/socketWithClientAuth.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"socketWithClientAuth.d.ts","sourceRoot":"","sources":["../../src/socket/socketWithClientAuth.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,OAAO,EAAuB,MAAM,UAAU,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,cAAc,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAM/G,qBAAa,qBAAqB,CAAC,kBAAkB,EAAE,eAAe,EAAE,cAAc,SAAS,kBAAkB,CAAE,SAAQ,OAAO,CAChI,kBAAkB,EAClB,eAAe,EACf,cAAc,CACf;IACC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAS;IACxC,OAAO,CAAC,WAAW,CAAS;gBAG1B,EAAE,EAAE,SAAS,EACb,aAAa,EAAE,MAAM,GAAG,SAAS,EACjC,eAAe,EAAE,cAAc,CAAC,kBAAkB,EAAE,eAAe,EAAE,cAAc,CAAC,EACpF,iBAAiB,EAAE,iBAAiB,CAAC,eAAe,EAAE,cAAc,CAAC,EAAE,EACvE,QAAQ,CAAC,EAAE,cAAc;IAOrB,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAO/E;AAED,wBAAsB,cAAc,CAAC,eAAe,EAAE,kBAAkB,EAAE,cAAc,SAAS,kBAAkB,GAAG,kBAAkB,EACtI,KAAK,EAAE,MAAM,EACb,aAAa,EAAE,MAAM,GAAG,SAAS,EACjC,eAAe,EAAE,cAAc,CAAC,kBAAkB,EAAE,eAAe,EAAE,cAAc,CAAC,EACpF,iBAAiB,EAAE,iBAAiB,CAAC,eAAe,EAAE,cAAc,CAAC,EAAE,EACvE,QAAQ,CAAC,EAAE,cAAc,GACxB,OAAO,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC,CAIzC"}

package/dist/socket/socketWithClientAuth.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.connectISocket = exports.ISocketWithClientAuth = void 0;
+const socket_1 = require("./socket");
+const util_1 = require("./util");
+// a subclass of ISocket that sends an auth token on the first request
+// this is useful for client-side sockets that need to authenticate
+// TODO(george): if we start using this for long-lived connections, we should add a way to refresh the token
+class ISocketWithClientAuth extends socket_1.ISocket {
+    constructor(ws, authorization, requestHandlers, globalMiddlewares, timeouts) {
+        super(ws, requestHandlers, globalMiddlewares, timeouts);
+        this.hasSentAuth = false;
+        this.authorization = authorization;
+    }
+    // override `request` from the base class to send `authorization` when appropriate
+    async request(method, params) {
+        // only send `authorization` on the first request
+        const authorization = this.hasSentAuth ? undefined : this.authorization;
+        const result = await super.request(method, params, authorization);
+        this.hasSentAuth = true;
+        return result;
+    }
+}
+exports.ISocketWithClientAuth = ISocketWithClientAuth;
+async function connectISocket(wsUrl, authorization, requestHandlers, globalMiddlewares, timeouts) {
+    const ws = await (0, util_1.connectWebSocket)(wsUrl);
+    const isocket = new ISocketWithClientAuth(ws, authorization, requestHandlers, globalMiddlewares, timeouts);
+    return (0, socket_1.createISocketClient)(isocket);
+}
+exports.connectISocket = connectISocket;
+//# sourceMappingURL=socketWithClientAuth.js.map

package/dist/socket/socketWithClientAuth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"socketWithClientAuth.js","sourceRoot":"","sources":["../../src/socket/socketWithClientAuth.ts"],"names":[],"mappings":";;;AACA,qCAAwD;AAExD,iCAA0C;AAE1C,sEAAsE;AACtE,mEAAmE;AACnE,4GAA4G;AAC5G,MAAa,qBAAsG,SAAQ,gBAI1H;IAIC,YACE,EAAa,EACb,aAAiC,EACjC,eAAoF,EACpF,iBAAuE,EACvE,QAAyB;QAEzB,KAAK,CAAC,EAAE,EAAE,eAAe,EAAE,iBAAiB,EAAE,QAAQ,CAAC,CAAC;QATlD,gBAAW,GAAG,KAAK,CAAC;QAU1B,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACrC,CAAC;IAED,kFAAkF;IAClF,KAAK,CAAC,OAAO,CAAiB,MAAc,EAAE,MAAc;QAC1D,iDAAiD;QACjD,MAAM,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC;QACxE,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,OAAO,CAAiB,MAAM,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC;QAClF,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AA3BD,sDA2BC;AAEM,KAAK,UAAU,cAAc,CAClC,KAAa,EACb,aAAiC,EACjC,eAAoF,EACpF,iBAAuE,EACvE,QAAyB;IAEzB,MAAM,EAAE,GAAG,MAAM,IAAA,uBAAgB,EAAC,KAAK,CAAC,CAAC;IACzC,MAAM,OAAO,GAAG,IAAI,qBAAqB,CAAC,EAAE,EAAE,aAAa,EAAE,eAAe,EAAE,iBAAiB,EAAE,QAAQ,CAAC,CAAC;IAC3G,OAAO,IAAA,4BAAmB,EAAC,OAAO,CAAC,CAAC;AACtC,CAAC;AAVD,wCAUC"}