@pathscale/wss-adapter 1.0.1 → 1.0.4

package/dist/types/index.d.ts

@@ -1,68 +1,77 @@
 interface IService {
-    remote: string;
-    methods: {
-        [methodCode: string]: {
-            name: string;
-            parameters: string[];
-        };
-    };
+  remote: string
+  methods: {
+    [methodCode: string]: {
+      name: string
+      parameters: string[]
+    }
+  }
 }
 interface IServiceConfig extends IService {
-    onDisconnect: () => void | null;
+  onDisconnect: (event: {
+    code: number
+    reason: string
+    wasClean: boolean
+  }) => void | null
 }
 interface IServices {
-    [serviceName: string]: IServiceConfig;
+  [serviceName: string]: IServiceConfig
 }
 interface IErrors {
-    [errorCode: number]: string;
+  [errorCode: number]: string
 }
 interface IConfiguration {
-    timeout: number;
-    services: IServices;
-    errors: IErrors;
-    onError: (error: {
-        error: number;
-        message: string;
-    }) => void;
+  timeout: number
+  services: IServices
+  errors: IErrors
+  onError: (error: { error: number; message: string }) => void
 }
 interface IServiceConnect {
-    connect<T>(payload: string | string[] | undefined): Promise<T>;
-    disconnect: () => void;
+  connect<T>(
+    payload: string | string[] | undefined,
+    remote?: string
+  ): Promise<T>
+  disconnect: () => void
 }
 interface IWssAdapter {
-    services: {
-        [serviceName: string]: IServiceConnect;
-    };
-    sessions: {
-        [serviceName: string]: unknown;
-    };
-    configure: (configuration: IConfiguration) => void;
+  services: {
+    [serviceName: string]: IServiceConnect
+  }
+  sessions: {
+    [serviceName: string]: any
+  }
+  configure: (configuration: IConfiguration) => void
 }
 interface ISequence {
-    value: number;
-    getSeq: () => number;
-    decreaseSeq: () => void;
+  value: number
+  getSeq: () => number
+  decreaseSeq: () => void
 }
 interface ISessions {
-    [serviceName: string]: WebSocket;
+  [serviceName: string]: WebSocket
 }
 interface IPendingPromises {
-    [seq: number]: {
-        resolve: (payload: unknown) => void;
-        reject: (error: Error) => void;
-        toHandler: ReturnType<typeof setTimeout>;
-    };
+  [seq: number]: {
+    resolve: (payload: unknown) => void
+    reject: (error: Error) => void
+    toHandler: ReturnType<typeof setTimeout>
+  }
 }
 interface IStore {
-    timeout: number;
-    errors: IErrors;
-    services: IServices;
-    sequence: ISequence;
-    sessions: ISessions;
-    pendingPromises: IPendingPromises;
-    onError: (error: {
-        error: number;
-        message: string;
-    }) => void;
+  timeout: number
+  errors: IErrors
+  services: IServices
+  sequence: ISequence
+  sessions: ISessions
+  pendingPromises: IPendingPromises
+  onError: (error: { error: number; message: string }) => void
+}
+export {
+  IStore,
+  IWssAdapter,
+  IServiceConfig,
+  IConfiguration,
+  IErrors,
+  IServices,
+  IService,
 }
-export { IStore, IWssAdapter, IServiceConfig, IConfiguration, IErrors, IServices, IService };

package/dist/wssAdapter.js

@@ -37,8 +37,8 @@ wssAdapter.configure = function (configuration) {
         // construct services objects with two simple functions
         // intended use: `wssAdapter.services.admin.connect([1, 2, 3])` or `wssAdapter.services.auth.connect([1, 2, 3])`
         wssAdapter.services[serviceName] = {
-            connect: function (payload) {
-                return connectHandler(serviceName, serviceConfig, payload);
+            connect: function (payload, remote) {
+                return connectHandler(serviceName, serviceConfig, payload, remote);
             },
             disconnect: function () { return disconnectHandler(serviceName); },
         };
@@ -55,21 +55,25 @@ wssAdapter.configure = function (configuration) {
         _loop_1(serviceName, serviceConfig);
     }
 };
-var connectHandler = function (serviceName, serviceConfig, payload) {
+var connectHandler = function (serviceName, serviceConfig, payload, remote) {
     return new Promise(function (resolve, reject) {
-        store.sessions[serviceName] = new WebSocket(serviceConfig.remote, payload);
+        store.sessions[serviceName] = new WebSocket(remote || serviceConfig.remote, payload);
         store.sessions[serviceName].onmessage = function (event) {
             var _a;
             var response = JSON.parse(event.data);
             console.log(response);
             if (response.params.error) {
-                reject(new Error((_a = store.errors[response.params.error]) !== null && _a !== void 0 ? _a : 'Something went wrong'));
+                reject(new Error((_a = store.errors[response.params.error]) !== null && _a !== void 0 ? _a : response.params.error));
                 return;
             }
             store.sessions[serviceName].onmessage = receiveHandler;
             resolve(response.params);
         };
-        store.sessions[serviceName].onclose = serviceConfig.onDisconnect;
+        store.sessions[serviceName].onclose = function (event) {
+            var _a;
+            (_a = serviceConfig.onDisconnect) === null || _a === void 0 ? void 0 : _a.call(serviceConfig, event);
+            reject(new Error("code: ".concat(event.code, ", reason: ").concat(event.reason, ", wasClean: ").concat(event.wasClean)));
+        };
     });
 };
 var disconnectHandler = function (serviceName) {
@@ -90,18 +94,20 @@ var sendHandler = function (serviceName, serviceConfig, methodName, params) {
     if (!methodCode) {
         throw new Error("method ".concat(methodName, " not available in ").concat(serviceName, " service"));
     }
-    if (!Object.keys(params).every(function (param) {
-        return serviceConfig.methods[methodCode].parameters.includes(param);
-    })) {
-        throw new Error("method ".concat(methodCode, " is being called with missing parameters"));
-    }
     var purgedParams = {};
-    serviceConfig.methods[methodCode].parameters.forEach(function (k) {
-        purgedParams[k] = params[k];
-    });
-    var difference = Object.keys(params).filter(function (x) { return !serviceConfig.methods[methodCode].parameters.includes(x); });
-    if (difference.length) {
-        throw new Error("method ".concat(methodCode, " is being called with unknow parameters, ").concat(difference));
+    if (params) {
+        if (!Object.keys(params).every(function (param) {
+            return serviceConfig.methods[methodCode].parameters.includes(param);
+        })) {
+            throw new Error("method ".concat(methodCode, " is being called with missing parameters"));
+        }
+        serviceConfig.methods[methodCode].parameters.forEach(function (k) {
+            purgedParams[k] = params[k];
+        });
+        var difference = Object.keys(params).filter(function (x) { return !serviceConfig.methods[methodCode].parameters.includes(x); });
+        if (difference.length) {
+            throw new Error("method ".concat(methodCode, " is being called with unknow parameters, ").concat(difference));
+        }
     }
     var payload = {
         method: Number.parseInt(methodCode),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pathscale/wss-adapter",
-  "version": "1.0.1",
+  "version": "1.0.4",
   "description": "Websocket adapter for the Pathscale WSS",
   "main": "dist/wssAdapter.js",
   "types": "dist/wssAdapter.d.ts",

package/types/index.ts

@@ -7,51 +7,49 @@ interface IService {
     }
   }
 }
-
 interface IServiceConfig extends IService {
-  onDisconnect: () => void | null
+  onDisconnect: (event: {
+    code: number
+    reason: string
+    wasClean: boolean
+  }) => void | null
 }
-
 interface IServices {
   [serviceName: string]: IServiceConfig
 }
-
 interface IErrors {
   [errorCode: number]: string
 }
-
 interface IConfiguration {
   timeout: number
   services: IServices
   errors: IErrors
   onError: (error: { error: number; message: string }) => void
 }
-
 interface IServiceConnect {
-  connect<T>(payload: string | string[] | undefined): Promise<T>
+  connect<T>(
+    payload: string | string[] | undefined,
+    remote?: string
+  ): Promise<T>
   disconnect: () => void
 }
-
 interface IWssAdapter {
   services: {
     [serviceName: string]: IServiceConnect
   }
   sessions: {
-    [serviceName: string]: unknown
+    [serviceName: string]: any
   }
   configure: (configuration: IConfiguration) => void
 }
-
 interface ISequence {
   value: number
   getSeq: () => number
   decreaseSeq: () => void
 }
-
 interface ISessions {
   [serviceName: string]: WebSocket
 }
-
 interface IPendingPromises {
   [seq: number]: {
     resolve: (payload: unknown) => void
@@ -59,7 +57,6 @@ interface IPendingPromises {
     toHandler: ReturnType<typeof setTimeout>
   }
 }
-
 interface IStore {
   timeout: number
   errors: IErrors
@@ -69,5 +66,12 @@ interface IStore {
   pendingPromises: IPendingPromises
   onError: (error: { error: number; message: string }) => void
 }
-
-export { IStore, IWssAdapter, IServiceConfig, IConfiguration, IErrors, IServices, IService }
+export {
+  IStore,
+  IWssAdapter,
+  IServiceConfig,
+  IConfiguration,
+  IErrors,
+  IServices,
+  IService,
+}

package/wssAdapter.ts

@@ -31,7 +31,7 @@ const store: IStore = {
   onError() {},
 }
 
-wssAdapter.configure = configuration => {
+wssAdapter.configure = (configuration) => {
   const { timeout, services, errors, onError } = configuration
 
   // save some stuff for later retrieval
@@ -44,8 +44,8 @@ wssAdapter.configure = configuration => {
     // construct services objects with two simple functions
     // intended use: `wssAdapter.services.admin.connect([1, 2, 3])` or `wssAdapter.services.auth.connect([1, 2, 3])`
     wssAdapter.services[serviceName] = {
-      connect: <T>(payload: string | string[] | undefined) =>
-        connectHandler<T>(serviceName, serviceConfig, payload),
+      connect: <T>(payload: string | string[] | undefined, remote?: string) =>
+        connectHandler<T>(serviceName, serviceConfig, payload, remote),
       disconnect: () => disconnectHandler(serviceName),
     }
 
@@ -54,9 +54,10 @@ wssAdapter.configure = configuration => {
     wssAdapter.sessions[serviceName] = new Proxy(
       {},
       {
-        get: (target, methodName: string) => (payload: Record<string, unknown>) =>
-          sendHandler(serviceName, serviceConfig, methodName, payload),
-      },
+        get:
+          (target, methodName: string) => (payload: Record<string, unknown>) =>
+            sendHandler(serviceName, serviceConfig, methodName, payload),
+      }
     )
   }
 }
@@ -65,16 +66,24 @@ const connectHandler = <T>(
   serviceName: string,
   serviceConfig: IServiceConfig,
   payload: string | string[] | undefined,
+  remote?: string
 ) => {
   return new Promise((resolve, reject) => {
-    store.sessions[serviceName] = new WebSocket(serviceConfig.remote, payload)
+    store.sessions[serviceName] = new WebSocket(
+      remote || serviceConfig.remote,
+      payload
+    )
 
     store.sessions[serviceName].onmessage = function (event: { data: string }) {
       const response = JSON.parse(event.data)
       console.log(response)
 
       if (response.params.error) {
-        reject(new Error(store.errors[response.params.error] ?? 'Something went wrong'))
+        reject(
+          new Error(
+            store.errors[response.params.error] ?? response.params.error
+          )
+        )
         return
       }
 
@@ -82,7 +91,15 @@ const connectHandler = <T>(
       resolve(response.params)
     }
 
-    store.sessions[serviceName].onclose = serviceConfig.onDisconnect
+    store.sessions[serviceName].onclose = (event) => {
+      serviceConfig.onDisconnect?.(event)
+
+      reject(
+        new Error(
+          `code: ${event.code}, reason: ${event.reason}, wasClean: ${event.wasClean}`
+        )
+      )
+    }
   }) as Promise<T>
 }
 
@@ -94,35 +111,44 @@ const sendHandler = (
   serviceName: string,
   serviceConfig: IServiceConfig,
   methodName: string,
-  params: Record<string, unknown>,
+  params: Record<string, unknown>
 ) => {
   const methodCode = Object.entries(serviceConfig.methods)
     .map(([code, info]) => ({ code, info }))
     .find(({ info }) => info.name === methodName)?.code
 
   if (!methodCode) {
-    throw new Error(`method ${methodName} not available in ${serviceName} service`)
-  }
-
-  if (
-    !Object.keys(params).every(param =>
-      serviceConfig.methods[methodCode].parameters.includes(param),
+    throw new Error(
+      `method ${methodName} not available in ${serviceName} service`
     )
-  ) {
-    throw new Error(`method ${methodCode} is being called with missing parameters`)
   }
 
   const purgedParams: Record<string, unknown> = {}
-  serviceConfig.methods[methodCode].parameters.forEach(k => {
-    purgedParams[k] = params[k]
-  })
 
-  const difference = Object.keys(params).filter(
-    x => !serviceConfig.methods[methodCode].parameters.includes(x),
-  )
+  if (params) {
+    if (
+      !Object.keys(params).every((param) =>
+        serviceConfig.methods[methodCode].parameters.includes(param)
+      )
+    ) {
+      throw new Error(
+        `method ${methodCode} is being called with missing parameters`
+      )
+    }
+
+    serviceConfig.methods[methodCode].parameters.forEach((k) => {
+      purgedParams[k] = params[k]
+    })
 
-  if (difference.length) {
-    throw new Error(`method ${methodCode} is being called with unknow parameters, ${difference}`)
+    const difference = Object.keys(params).filter(
+      (x) => !serviceConfig.methods[methodCode].parameters.includes(x)
+    )
+
+    if (difference.length) {
+      throw new Error(
+        `method ${methodCode} is being called with unknow parameters, ${difference}`
+      )
+    }
   }
 
   const payload = {