@ceeblue/web-utils 2.0.1 → 2.2.0

package/dist/web-utils.d.ts

@@ -140,7 +140,7 @@ type Params = {
  */
 declare enum Type {
     HESP = "HESP",
-    WEBRTS = "WebRTS",
+    WRTS = "WebRTS",
     WEBRTC = "WebRTC",
     META = "Meta",
     DATA = "Data"
@@ -634,14 +634,14 @@ declare function objectEntries(value: any): [string, any][];
  * @param obj Any objects, strings, exceptions, errors, or number
  * @param params.space `''`, allows to configure space in the string representation
  * @param params.decimal `2`, allows to choose the number of decimal to display in the string representation
- * @param params.recursive `false`, allows to serialize recursively every object value, beware if a value refers to a already parsed value an infinite loop will occur
+ * @param params.recursion `1`, recursion depth to stringify recursively every object value until this depth, beware if a value refers to a already parsed value an infinite loop will occur
  * @param params.noBin `false`, when set skip binary encoding and write inplace a bin-length information
  * @returns the final string representation
  */
 declare function stringify(obj: any, params?: {
     space?: string;
     decimal?: number;
-    recursive?: number;
+    recursion?: number;
     noBin?: boolean;
 }): string;
 /**
@@ -658,6 +658,10 @@ declare function safePromise<T>(timeout: number, promise: Promise<T>): Promise<u
  * Wait in milliseconds, requires a call with await keyword!
  */
 declare function sleep(ms: number): Promise<unknown>;
+/**
+ * Test equality between two value whatever their type, array included
+ */
+declare function equal(a: any, b: any): boolean;
 /**
  * fetch help method with few usefull fix:
  * - throw an string exception if response code is not 200 with the text of the response or uses statusText
@@ -671,6 +675,7 @@ declare function fetch(input: RequestInfo | URL, init?: RequestInit): Promise<Re
 declare function parseExtension(path: string): string;
 
 declare const Util_EMPTY_FUNCTION: typeof EMPTY_FUNCTION;
+declare const Util_equal: typeof equal;
 declare const Util_fetch: typeof fetch;
 declare const Util_objectEntries: typeof objectEntries;
 declare const Util_objectFrom: typeof objectFrom;
@@ -683,7 +688,7 @@ declare const Util_time: typeof time;
 declare const Util_timeOrigin: typeof timeOrigin;
 declare const Util_toBin: typeof toBin;
 declare namespace Util {
-  export { Util_EMPTY_FUNCTION as EMPTY_FUNCTION, Util_fetch as fetch, Util_objectEntries as objectEntries, Util_objectFrom as objectFrom, Util_options as options, Util_parseExtension as parseExtension, Util_safePromise as safePromise, Util_sleep as sleep, Util_stringify as stringify, Util_time as time, Util_timeOrigin as timeOrigin, Util_toBin as toBin };
+  export { Util_EMPTY_FUNCTION as EMPTY_FUNCTION, Util_equal as equal, Util_fetch as fetch, Util_objectEntries as objectEntries, Util_objectFrom as objectFrom, Util_options as options, Util_parseExtension as parseExtension, Util_safePromise as safePromise, Util_sleep as sleep, Util_stringify as stringify, Util_time as time, Util_timeOrigin as timeOrigin, Util_toBin as toBin };
 }
 
 /**

package/dist/web-utils.js

@@ -521,14 +521,14 @@ function objectEntries(value) {
  * @param obj Any objects, strings, exceptions, errors, or number
  * @param params.space `''`, allows to configure space in the string representation
  * @param params.decimal `2`, allows to choose the number of decimal to display in the string representation
- * @param params.recursive `false`, allows to serialize recursively every object value, beware if a value refers to a already parsed value an infinite loop will occur
+ * @param params.recursion `1`, recursion depth to stringify recursively every object value until this depth, beware if a value refers to a already parsed value an infinite loop will occur
  * @param params.noBin `false`, when set skip binary encoding and write inplace a bin-length information
  * @returns the final string representation
  */
 // Online Javascript Editor for free
 // Write, Edit and Run your Javascript code using JS Online Compiler
 function stringify(obj, params = {}) {
-    params = Object.assign({ space: ' ', decimal: 2, recursive: 1, noBin: false }, params);
+    params = Object.assign({ space: ' ', decimal: 2, recursion: 1, noBin: false }, params);
     if (obj == null) {
         return String(obj);
     }
@@ -549,7 +549,7 @@ function stringify(obj, params = {}) {
         return '[' + obj.byteLength + '#bytes]';
     }
     // boolean or string type or stop recursivity
-    if (typeof obj === 'boolean' || obj.substring || !params.recursive) {
+    if (typeof obj === 'boolean' || obj.substring || !params.recursion) {
         // is already a string OR has to be stringified
         return String(obj);
     }
@@ -559,14 +559,14 @@ function stringify(obj, params = {}) {
         let res = '';
         for (const value of obj) {
             res += (res ? ',' : '[') + space;
-            res += stringify(value, Object.assign(Object.assign({}, params), { recursive: params.recursive - 1 }));
+            res += stringify(value, Object.assign(Object.assign({}, params), { recursion: params.recursion - 1 }));
         }
         return (res += space + ']');
     }
     let res = '';
     for (const name in obj) {
         res += (res ? ',' : '{') + space + name + ':';
-        res += stringify(obj[name], Object.assign(Object.assign({}, params), { recursive: params.recursive - 1 }));
+        res += stringify(obj[name], Object.assign(Object.assign({}, params), { recursion: params.recursion - 1 }));
     }
     return (res += space + '}');
 }
@@ -597,6 +597,34 @@ function sleep(ms) {
         setTimeout(resolve, ms);
     });
 }
+/**
+ * Test equality between two value whatever their type, array included
+ */
+function equal(a, b) {
+    if (Object(a) !== a) {
+        if (Object(b) === b) {
+            return false;
+        }
+        // both primitive (null and undefined included)
+        return a === b;
+    }
+    // complexe object
+    if (a[Symbol.iterator]) {
+        if (!b[Symbol.iterator]) {
+            return false;
+        }
+        if (a.length !== b.length) {
+            return false;
+        }
+        for (let i = 0; i !== a.length; ++i) {
+            if (a[i] !== b[i]) {
+                return false;
+            }
+        }
+        return true;
+    }
+    return a === b;
+}
 /**
  * fetch help method with few usefull fix:
  * - throw an string exception if response code is not 200 with the text of the response or uses statusText
@@ -622,7 +650,7 @@ function parseExtension(path) {
     const dot = path.lastIndexOf('.');
     const ext = dot >= 0 && dot > path.lastIndexOf('/') ? path.substring(dot) : '';
     return ext;
-}var Util=/*#__PURE__*/Object.freeze({__proto__:null,EMPTY_FUNCTION:EMPTY_FUNCTION,fetch:fetch,objectEntries:objectEntries,objectFrom:objectFrom,options:options,parseExtension:parseExtension,safePromise:safePromise,sleep:sleep,stringify:stringify,time:time,timeOrigin:timeOrigin,toBin:toBin});/**
+}var Util=/*#__PURE__*/Object.freeze({__proto__:null,EMPTY_FUNCTION:EMPTY_FUNCTION,equal:equal,fetch:fetch,objectEntries:objectEntries,objectFrom:objectFrom,options:options,parseExtension:parseExtension,safePromise:safePromise,sleep:sleep,stringify:stringify,time:time,timeOrigin:timeOrigin,toBin:toBin});/**
  * Copyright 2024 Ceeblue B.V.
  * This file is part of https://github.com/CeeblueTV/web-utils which is released under GNU Affero General Public License.
  * See file LICENSE or go to https://spdx.org/licenses/AGPL-3.0-or-later.html for full license details.
@@ -795,7 +823,7 @@ class NetAddress {
 var Type;
 (function (Type) {
     Type["HESP"] = "HESP";
-    Type["WEBRTS"] = "WebRTS";
+    Type["WRTS"] = "WebRTS";
     Type["WEBRTC"] = "WebRTC";
     Type["META"] = "Meta";
     Type["DATA"] = "Data";
@@ -821,8 +849,8 @@ function buildURL(type, params, protocol = 'wss') {
             case Type.WEBRTC:
                 url.pathname = '/webrtc/' + params.streamName;
                 break;
-            case Type.WEBRTS:
-                url.pathname = '/webrts/' + params.streamName;
+            case Type.WRTS:
+                url.pathname = '/wrts/' + params.streamName;
                 break;
             case Type.META:
                 url.pathname = '/json_' + params.streamName + '.js';
@@ -1599,15 +1627,17 @@ class WebSocketReliable extends EventEmitter {
         ws.onclose = (e) => {
             if (!this._opened) {
                 // close during connection
-                this.close(url.toString() + ' connection failed (' + String(e.reason || e.code) + ')');
+                // the caller can differentiate this case of one server shutdown by looking if onOpen was op
+                this.close(url.toString() + ' connection failed, ' + String(e.reason || e.code));
             }
             else if (e.code === 1000 || e.code === 1005) {
-                // normal disconnection from server (no error code)
+                // normal disconnection from server, no error to indicate that a reconnection is possible!
+                // the caller can differentiate this case of one explicit websocket.close() call in the encpasulating class
                 this.close(url.toString() + ' shutdown');
             }
             else {
-                // disconnection from server
-                this.close(url.toString() + ' disconnection (' + String(e.reason || e.code) + ')');
+                // abnormal disconnection from server
+                this.close(url.toString() + ' disconnection, ' + String(e.reason || e.code));
             }
         };
         // Wrap send method to queue messages until connection is established.
@@ -1625,7 +1655,7 @@ class WebSocketReliable extends EventEmitter {
      * @returns this
      */
     send(message, queueing = false) {
-        if (!this._ws) {
+        if (this._closed) {
             throw Error('Open socket before to send data');
         }
         if (queueing || !this._opened) {
@@ -1661,10 +1691,12 @@ class WebSocketReliable extends EventEmitter {
         this._ws.onopen = this._ws.onclose = this._ws.onmessage = null; // otherwise can receive message AFTER close!
         this._ws.close(); // Don't set to undefined to keep this._ws properties valid!
         // release resources!
-        this._opened = false;
         this._queueing.length = 0;
         this._queueingBytes = 0;
         this.onClose(error);
+        // Reset _opened in last to allow to differenciate in onClose an error while connecting OR while connected
+        // Is welcome to attempt a reconnection when no error OR when error on connection!
+        this._opened = false;
     }
     _send(message) {
         if (!this._ws) {
@@ -1678,4 +1710,4 @@ class WebSocketReliable extends EventEmitter {
  * This file is part of https://github.com/CeeblueTV/web-utils which is released under GNU Affero General Public License.
  * See file LICENSE or go to https://spdx.org/licenses/AGPL-3.0-or-later.html for full license details.
  */
-const VERSION = '2.0.1';export{BinaryReader,BinaryWriter,BitReader,ByteRate,Connect,EventEmitter,FixMap,NetAddress,Numbers,Queue,SDP,Util,VERSION,WebSocketReliable};//# sourceMappingURL=web-utils.js.map
+const VERSION = '2.2.0';export{BinaryReader,BinaryWriter,BitReader,ByteRate,Connect,EventEmitter,FixMap,NetAddress,Numbers,Queue,SDP,Util,VERSION,WebSocketReliable};//# sourceMappingURL=web-utils.js.map