@ceeblue/web-utils 1.3.0 → 1.4.0

package/README.md

@@ -2,7 +2,7 @@
 
 # Ceeblue Web Utilities
 
-This is a Web base compoments for CeeblueTV's web libraries : a collection of tools and utilities used across all of CeeblueTV's web projects.
+This is a basic component library for Ceeblue projects, consisting of a collection of essential tools and utilities used in all Ceeblue web projects.
 
 ## Usage
 
@@ -16,8 +16,8 @@ import { Util, ILog } from '@ceeblue/web-utils';
 ```
 > 💡 **TIP**
 > 
-> If your project uses [TypeScript](https://www.typescriptlang.org/), it is recommended to set `"target": "ES6"` in your configuration to align with our usage of ES6 features and ensures that your build will succeed (for those requiring a backwards-compatible [UMD](https://github.com/umdjs/umd) version, a [local build](#building-locally) is advised).
-> Then Defining the compiler option `"moduleResolution": "Node"` in **tsconfig.json** helps with import errors by ensuring that TypeScript uses the correct strategy for resolving imports based on the targeted Node.js version.
+> If your project uses TypeScript, it is recommended that you set target: "ES6" in your configuration to match our use of ES6 features and ensure that your build will succeed (for those requiring a backward-compatible UMD version, a local build is recommended).
+> Then define the "moduleResolution" compiler option: "Node" in tsconfig.json helps with import failures by ensuring that TypeScript uses the correct import resolution strategy based on the targeted Node.js version.
 >   ```json
 >   {
 >      "compilerOptions": {
@@ -30,8 +30,8 @@ import { Util, ILog } from '@ceeblue/web-utils';
 ## Building locally
 
 1. [Clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) this repository
-2. Enter the `webr-utils` folder and run `npm install` to install packages dependencies.
-3. Execute `npm run build`. The output will be five files placed in the **/dist/** folder:
+2. Got to the `web-utils` folder and run `npm install` to install the packages dependencies.
+3. Run `npm run build`. The output will be five files placed in the **/dist/** folder:
    - **web-utils.d.ts** Typescript definitions file
    - **web-utils.js**: Bundled JavaScript library
    - **web-utils.js.map**: Source map that associates the bundled library with the original source files
@@ -51,10 +51,7 @@ This monorepo also contains built-in documentation about the APIs in the library
 ```
 npm run build:docs
 ```
-You can access the documentation by opening the index.html file in the docs folder with your browser (`./docs/index.html`), or if you have installed and started the [http-server package](https://www.npmjs.com/package/http-server) by navigating to:
-```
-http://localhost:8080/docs/
-```
+You can access the documentation by opening the index.html file in the docs folder with your browser (`./docs/index.html`).
 
 ## Contribution
 

package/dist/web-utils.d.ts

@@ -92,6 +92,22 @@ declare class BitReader {
     read32(): number;
 }
 
+/**
+ * Compute ByteRate every delta time
+ */
+declare class ByteRate {
+    onBytes(bytes: number): void;
+    get delta(): number;
+    private _bytes;
+    private _time;
+    private _delta;
+    private _value;
+    constructor(delta?: number);
+    value(): number;
+    exact(): number;
+    addBytes(bytes: number): this;
+}
+
 /**
  * Parameters of connections
  */
@@ -223,6 +239,32 @@ declare class EventEmitter {
     private _event;
 }
 
+/**
+ * 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.
+ */
+/**
+ * Some fix for JS MAP:
+ * - find(key) search an item in the map and returns undefined if not found
+ * - get(key) return the item if exists or otherwise create and returns it
+ * - set(key, value) returns the value of the item (rather the MAP)
+ */
+declare class FixMap<KeyType, ValueType> {
+    private _initValue;
+    [Symbol.iterator](): IterableIterator<[KeyType, ValueType]>;
+    get size(): number;
+    private _map;
+    constructor(_initValue: () => ValueType);
+    get(key: KeyType): ValueType;
+    find(key: KeyType): ValueType | undefined;
+    has(key: KeyType): boolean;
+    clear(): void;
+    delete(key: KeyType): boolean;
+    set(key: KeyType, value: ValueType): ValueType;
+    forEach(callbackfn: (value: ValueType, key: KeyType, map: Map<KeyType, ValueType>) => void, thisArg?: any): void;
+}
+
 /**
  * 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.
@@ -774,4 +816,4 @@ declare class WebSocketReliable extends EventEmitter {
 
 declare const VERSION: string;
 
-export { BinaryReader, BinaryWriter, BitReader, Connect, EventEmitter, type ILog, NetAddress, Numbers, Queue, SDP, Util, VERSION, WebSocketReliable };
+export { BinaryReader, BinaryWriter, BitReader, ByteRate, Connect, EventEmitter, FixMap, type ILog, NetAddress, Numbers, Queue, SDP, Util, VERSION, WebSocketReliable };

package/dist/web-utils.js

@@ -341,130 +341,6 @@ class BitReader {
     read32() {
         return this.read(32);
     }
-}/**
- * 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.
- */
-/**
- * Help class to manipulate and parse a net address. The Address can be only the domain field,
- * or a URL format with protocol and path part `(http://)domain(:port/path)`
- * @example
- * const address = new Address('nl-ams-42.live.ceeblue.tv:80');
- * console.log(address.domain) // 'nl-ams-42.live.ceeblue.tv'
- * console.log(address.port) // '80'
- * console.log(address) // 'nl-ams-42.live.ceeblue.tv:80'
- */
-class NetAddress {
-    /**
-     * Static help function to build an end point from an address `(proto://)domain(:port/path)`
-     *
-     * Mainly it fix the protocol, in addition if:
-     *  - the address passed is securized (TLS) and protocol is not => it tries to fix protocol to get its securize version
-     *  - the address passed is non securized and protocol is (TLS) => it tries to fix protocol to get its unsecurized version
-     * @param protocol protocol to set in the end point returned
-     * @param address string address to fix with protocol as indicated
-     * @returns the end point built
-     * @example
-     * console.log(NetAddress.fixProtocol('ws','http://domain/path')) // 'ws://domain/path'
-     * console.log(NetAddress.fixProtocol('ws','https://domain/path')) // 'wss://domain/path'
-     * console.log(NetAddress.fixProtocol('wss','http://domain/path')) // 'ws://domain/path'
-     */
-    static fixProtocol(protocol, address) {
-        const found = address.indexOf('://');
-        // isolate protocol is present in address
-        if (found >= 0) {
-            // In this case replace by protocol in keeping SSL like given in address
-            if (found > 2 && address.charAt(found - 1).toLowerCase() === 's') {
-                // SSL!
-                if (protocol.length <= 2 || !protocol.endsWith('s')) {
-                    protocol += 's'; // Add SSL
-                }
-            }
-            else {
-                // Not SSL!
-                if (protocol.length > 2 && protocol.endsWith('s')) {
-                    protocol = protocol.slice(0, -1); // Remove SSL
-                }
-            }
-            // Build host!
-            address = address.substring(found + 3);
-        }
-        return protocol + '://' + address;
-    }
-    /**
-     * The domain part from address `(http://)domain(:port/path)`
-     */
-    get domain() {
-        return this._domain;
-    }
-    /**
-     * The port part from address `(http://)domain(:port/path)`, or defaultPort if passed in NetAddress constructor
-     */
-    get port() {
-        return this._port;
-    }
-    /**
-     * @returns the string address as passed in the constructor
-     */
-    toString() {
-        return this._address;
-    }
-    /**
-     * @returns the string address as passed in the constructor
-     * @override
-     */
-    valueOf() {
-        return this._address;
-    }
-    /**
-     * Build a NetAddress object and parse address
-     * @param address string address to parse, accept an url format with protocol and path `(http://)domain(:port/path)`
-     * @param defaultPort set a default port to use if there is no port in the string address parsed
-     */
-    constructor(address, defaultPort) {
-        this._address = address;
-        // Remove Protocol
-        let pos = address.indexOf('/');
-        if (pos >= 0) {
-            // Remove ://
-            if (address.charCodeAt(pos + 1) === 47) {
-                // has //
-                if (pos > 0) {
-                    if (address.charCodeAt(pos - 1) === 58) {
-                        // has ://
-                        address = address.substring(pos + 2);
-                    } //  something else #//
-                }
-                else {
-                    // otherwise starts by //
-                    address = address.substring(2);
-                }
-            }
-            else if (!pos) {
-                // starts by /, remove it
-                address = address.substring(1);
-            } // else something else #/
-        }
-        this._domain = address;
-        this._port = defaultPort;
-        // Parse Port
-        pos = address.lastIndexOf(':');
-        if (pos >= 0) {
-            const port = parseInt(address.substring(pos + 1));
-            if (port && port <= 0xffff) {
-                this._port = port;
-                this._domain = address.substring(0, pos);
-            }
-        }
-        else {
-            // Remove Path!
-            pos = address.indexOf('/');
-            if (pos >= 0) {
-                this._domain = address.substring(0, pos);
-            }
-        }
-    }
 }/******************************************************************************
 Copyright (c) Microsoft Corporation.
 
@@ -736,6 +612,168 @@ function parseExtension(path) {
  * 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.
  */
+/**
+ * Compute ByteRate every delta time
+ */
+class ByteRate {
+    onBytes(bytes) { }
+    get delta() {
+        return this._delta;
+    }
+    constructor(delta = 1000) {
+        this._time = time();
+        this._value = NaN;
+        this._delta = delta;
+        this._bytes = 0;
+    }
+    value() {
+        return Math.round(this.exact());
+    }
+    exact() {
+        const now = time();
+        const elapsed = now - this._time;
+        if (elapsed > this._delta || isNaN(this._value)) {
+            // wait "_delta" before next compute rate
+            this._value = (this._bytes * 1000) / elapsed;
+            this._bytes = 0;
+            this._time = now;
+        }
+        return this._value;
+    }
+    addBytes(bytes) {
+        this._bytes += bytes;
+        this.onBytes(bytes);
+        return this;
+    }
+}/**
+ * 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.
+ */
+/**
+ * Help class to manipulate and parse a net address. The Address can be only the domain field,
+ * or a URL format with protocol and path part `(http://)domain(:port/path)`
+ * @example
+ * const address = new Address('nl-ams-42.live.ceeblue.tv:80');
+ * console.log(address.domain) // 'nl-ams-42.live.ceeblue.tv'
+ * console.log(address.port) // '80'
+ * console.log(address) // 'nl-ams-42.live.ceeblue.tv:80'
+ */
+class NetAddress {
+    /**
+     * Static help function to build an end point from an address `(proto://)domain(:port/path)`
+     *
+     * Mainly it fix the protocol, in addition if:
+     *  - the address passed is securized (TLS) and protocol is not => it tries to fix protocol to get its securize version
+     *  - the address passed is non securized and protocol is (TLS) => it tries to fix protocol to get its unsecurized version
+     * @param protocol protocol to set in the end point returned
+     * @param address string address to fix with protocol as indicated
+     * @returns the end point built
+     * @example
+     * console.log(NetAddress.fixProtocol('ws','http://domain/path')) // 'ws://domain/path'
+     * console.log(NetAddress.fixProtocol('ws','https://domain/path')) // 'wss://domain/path'
+     * console.log(NetAddress.fixProtocol('wss','http://domain/path')) // 'ws://domain/path'
+     */
+    static fixProtocol(protocol, address) {
+        const found = address.indexOf('://');
+        // isolate protocol is present in address
+        if (found >= 0) {
+            // In this case replace by protocol in keeping SSL like given in address
+            if (found > 2 && address.charAt(found - 1).toLowerCase() === 's') {
+                // SSL!
+                if (protocol.length <= 2 || !protocol.endsWith('s')) {
+                    protocol += 's'; // Add SSL
+                }
+            }
+            else {
+                // Not SSL!
+                if (protocol.length > 2 && protocol.endsWith('s')) {
+                    protocol = protocol.slice(0, -1); // Remove SSL
+                }
+            }
+            // Build host!
+            address = address.substring(found + 3);
+        }
+        return protocol + '://' + address;
+    }
+    /**
+     * The domain part from address `(http://)domain(:port/path)`
+     */
+    get domain() {
+        return this._domain;
+    }
+    /**
+     * The port part from address `(http://)domain(:port/path)`, or defaultPort if passed in NetAddress constructor
+     */
+    get port() {
+        return this._port;
+    }
+    /**
+     * @returns the string address as passed in the constructor
+     */
+    toString() {
+        return this._address;
+    }
+    /**
+     * @returns the string address as passed in the constructor
+     * @override
+     */
+    valueOf() {
+        return this._address;
+    }
+    /**
+     * Build a NetAddress object and parse address
+     * @param address string address to parse, accept an url format with protocol and path `(http://)domain(:port/path)`
+     * @param defaultPort set a default port to use if there is no port in the string address parsed
+     */
+    constructor(address, defaultPort) {
+        this._address = address;
+        // Remove Protocol
+        let pos = address.indexOf('/');
+        if (pos >= 0) {
+            // Remove ://
+            if (address.charCodeAt(pos + 1) === 47) {
+                // has //
+                if (pos > 0) {
+                    if (address.charCodeAt(pos - 1) === 58) {
+                        // has ://
+                        address = address.substring(pos + 2);
+                    } //  something else #//
+                }
+                else {
+                    // otherwise starts by //
+                    address = address.substring(2);
+                }
+            }
+            else if (!pos) {
+                // starts by /, remove it
+                address = address.substring(1);
+            } // else something else #/
+        }
+        this._domain = address;
+        this._port = defaultPort;
+        // Parse Port
+        pos = address.lastIndexOf(':');
+        if (pos >= 0) {
+            const port = parseInt(address.substring(pos + 1));
+            if (port && port <= 0xffff) {
+                this._port = port;
+                this._domain = address.substring(0, pos);
+            }
+        }
+        else {
+            // Remove Path!
+            pos = address.indexOf('/');
+            if (pos >= 0) {
+                this._domain = address.substring(0, pos);
+            }
+        }
+    }
+}/**
+ * 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.
+ */
 /**
  * Type of connection
  */
@@ -936,6 +974,55 @@ class 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.
  */
+/**
+ * Some fix for JS MAP:
+ * - find(key) search an item in the map and returns undefined if not found
+ * - get(key) return the item if exists or otherwise create and returns it
+ * - set(key, value) returns the value of the item (rather the MAP)
+ */
+class FixMap {
+    [Symbol.iterator]() {
+        return this._map[Symbol.iterator]();
+    }
+    get size() {
+        return this._map.size;
+    }
+    constructor(_initValue) {
+        this._initValue = _initValue;
+        this._map = new Map();
+    }
+    get(key) {
+        let value = this.find(key);
+        if (value === undefined) {
+            this._map.set(key, (value = this._initValue()));
+        }
+        return value;
+    }
+    find(key) {
+        return this._map.get(key);
+    }
+    has(key) {
+        return this._map.has(key);
+    }
+    clear() {
+        this._map.clear();
+    }
+    delete(key) {
+        return this._map.delete(key);
+    }
+    set(key, value) {
+        this._map.set(key, value);
+        return value;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    forEach(callbackfn, thisArg) {
+        this._map.forEach(callbackfn, thisArg);
+    }
+}/**
+ * 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.
+ */
 /**
  * Queue typed similar to a {@link https://en.cppreference.com/w/cpp/container/queue | std::queue<Type>} with possibility to limit the capacity like a FIFO
  * @example
@@ -1353,44 +1440,6 @@ Object.freeze(SDP);/**
  * 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.
  */
-/**
- * Compute ByteRate every delta time
- */
-class ByteRate {
-    onBytes(bytes) { }
-    get delta() {
-        return this._delta;
-    }
-    constructor(delta = 1000) {
-        this._time = time();
-        this._value = NaN;
-        this._delta = delta;
-        this._bytes = 0;
-    }
-    value() {
-        return Math.round(this.exact());
-    }
-    exact() {
-        const now = time();
-        const elapsed = now - this._time;
-        if (elapsed > this._delta || isNaN(this._value)) {
-            // wait "_delta" before next compute rate
-            this._value = (this._bytes * 1000) / elapsed;
-            this._bytes = 0;
-            this._time = now;
-        }
-        return this._value;
-    }
-    addBytes(bytes) {
-        this._bytes += bytes;
-        this.onBytes(bytes);
-        return this;
-    }
-}/**
- * 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.
- */
 /**
  * The WebSocketReliable class extends WebSocket to bring up the following improvements:
  * - Fix all possible unintentional closing ways to get always a related error message, {@link onClose | onClose(error?) event}
@@ -1614,4 +1663,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 = '1.3.0';export{BinaryReader,BinaryWriter,BitReader,Connect,EventEmitter,NetAddress,Numbers,Queue,SDP,Util,VERSION,WebSocketReliable};//# sourceMappingURL=web-utils.js.map
+const VERSION = '1.4.0';export{BinaryReader,BinaryWriter,BitReader,ByteRate,Connect,EventEmitter,FixMap,NetAddress,Numbers,Queue,SDP,Util,VERSION,WebSocketReliable};//# sourceMappingURL=web-utils.js.map