wspromisify 3.0.3 → 3.1.1

package/README.md

@@ -72,6 +72,7 @@ interface Config {
   server: { // Unique id's and data keys to negotiate with back-end.
     id_key:   'id'
     data_key: 'data'
+    on_collision: 'error'|'pass'|'ignore' // if a message with unregistred id_key value has come. pass -> handle in 'message-ext'.
   }
   ping: { // Pings to avoid interruptions or false to disable.
     interval: number       // inter-ping interval. default: 55.

package/dist/bundle.cjs

@@ -284,7 +284,7 @@ const default_config = () => ({
     }),
     decode: (rawMessage) => JSON.parse(rawMessage),
     protocols: [], pipes: [],
-    server: { id_key: 'id', data_key: 'data' },
+    server: { id_key: 'id', data_key: 'data', on_collision: 'error' },
     ping: { interval: 55, timeout: 30, out: 'ping', in: 'pong' }
 });
 const processConfig = (config) => {
@@ -313,6 +313,7 @@ const nil = null, inf = Infinity;
 const resolved = Promise.resolve(nil);
 const label_message = 'message';
 const label_message_ext = 'message-ext';
+const label_error = 'error';
 const zipnum = new J();
 const dnow = () => Date.now();
 const now = () => dnow() / 1e3;
@@ -455,7 +456,7 @@ class WebSocketClient {
         const { reconnect } = config;
         this.ws = ws;
         clear_q(call_q(this.queue.on_ready));
-        const { id_key, data_key } = config.server;
+        const { id_key, data_key, on_collision } = config.server;
         // works also on previously opened sockets that do not fire 'open' event.
         this.call('open', ws);
         for (const { msg } of queue.send.values())
@@ -486,11 +487,21 @@ class WebSocketClient {
                         this.call(label_message, d);
                         q.ff(d);
                     }
+                    else
+                        switch (on_collision) {
+                            case 'error':
+                                const err = {
+                                    data,
+                                    message: `WSP: id_key exists in the incoming message, but does not exist in the queue!`
+                                };
+                                this.log(label_error, err);
+                                this.call(label_error, err);
+                            case 'ignore': return;
+                            case 'pass': break;
+                        }
                 }
-                else {
-                    this.log(label_message_ext, data);
-                    this.call(label_message_ext, { data });
-                }
+                this.log(label_message_ext, data);
+                this.call(label_message_ext, { data });
             }
             catch (err) {
                 console.error(err, `WSP: Decode error. Got: ${raw}`);

package/dist/bundle.d.ts

@@ -57,6 +57,7 @@ declare namespace wsc {
 		server: {
 			id_key: string;
 			data_key: string;
+			on_collision: "error" | "pass" | "ignore";
 		};
 		ping: {
 			interval: number;

package/dist/bundle.mjs

@@ -282,7 +282,7 @@ const default_config = () => ({
     }),
     decode: (rawMessage) => JSON.parse(rawMessage),
     protocols: [], pipes: [],
-    server: { id_key: 'id', data_key: 'data' },
+    server: { id_key: 'id', data_key: 'data', on_collision: 'error' },
     ping: { interval: 55, timeout: 30, out: 'ping', in: 'pong' }
 });
 const processConfig = (config) => {
@@ -311,6 +311,7 @@ const nil = null, inf = Infinity;
 const resolved = Promise.resolve(nil);
 const label_message = 'message';
 const label_message_ext = 'message-ext';
+const label_error = 'error';
 const zipnum = new J();
 const dnow = () => Date.now();
 const now = () => dnow() / 1e3;
@@ -453,7 +454,7 @@ class WebSocketClient {
         const { reconnect } = config;
         this.ws = ws;
         clear_q(call_q(this.queue.on_ready));
-        const { id_key, data_key } = config.server;
+        const { id_key, data_key, on_collision } = config.server;
         // works also on previously opened sockets that do not fire 'open' event.
         this.call('open', ws);
         for (const { msg } of queue.send.values())
@@ -484,11 +485,21 @@ class WebSocketClient {
                         this.call(label_message, d);
                         q.ff(d);
                     }
+                    else
+                        switch (on_collision) {
+                            case 'error':
+                                const err = {
+                                    data,
+                                    message: `WSP: id_key exists in the incoming message, but does not exist in the queue!`
+                                };
+                                this.log(label_error, err);
+                                this.call(label_error, err);
+                            case 'ignore': return;
+                            case 'pass': break;
+                        }
                 }
-                else {
-                    this.log(label_message_ext, data);
-                    this.call(label_message_ext, { data });
-                }
+                this.log(label_message_ext, data);
+                this.call(label_message_ext, { data });
             }
             catch (err) {
                 console.error(err, `WSP: Decode error. Got: ${raw}`);

package/package.json

@@ -30,18 +30,7 @@
     "type": "git",
     "url": "git+https://github.com/houd1ni/WebsocketPromisify.git"
   },
-  "scripts": {
-    "lint": "tslint src/*.ts",
-    "test": "tsx test/index",
-    "test:report": "nyc npm test && nyc report --reporter=text-lcov > coverage.lcov && codecov",
-    "gentypes": "dts-bundle-generator --no-check -o dist/bundle.d.ts src/WSC.ts",
-    "dev": "cross-env NODE_ENV=development BUILD=es rollup -c",
-    "prod:cjs": "cross-env NODE_ENV=production BUILD=cjs rollup -c",
-    "prod:es": "cross-env NODE_ENV=production BUILD=es rollup -c",
-    "prod": "npm run gentypes && npm run prod:es && npm run prod:cjs",
-    "all": "npm run dev && npm run prod"
-  },
-  "version": "3.0.3",
+  "version": "3.1.1",
   "type": "module",
   "exports": {
     ".": {
@@ -75,5 +64,16 @@
   "dependencies": {
     "pepka": "^1.13.0",
     "zipnum": "^2.1.3"
+  },
+  "scripts": {
+    "lint": "tslint src/*.ts",
+    "test": "tsx test/index",
+    "test:report": "nyc npm test && nyc report --reporter=text-lcov > coverage.lcov && codecov",
+    "gentypes": "dts-bundle-generator --no-check -o dist/bundle.d.ts src/WSC.ts",
+    "dev": "cross-env NODE_ENV=development BUILD=es rollup -c",
+    "prod:cjs": "cross-env NODE_ENV=production BUILD=cjs rollup -c",
+    "prod:es": "cross-env NODE_ENV=production BUILD=es rollup -c",
+    "prod": "npm run gentypes && npm run prod:es && npm run prod:cjs",
+    "all": "npm run dev && npm run prod"
   }
-}
+}