@ceeblue/web-utils 4.0.0 → 4.2.0

package/dist/web-utils.d.ts

@@ -283,7 +283,9 @@ type Params = {
      */
     endPoint: string;
     /**
-     * The name of the stream to join
+     * The name of the stream to join.
+     * If `endPoint` is a complete URL and `streamName` is not provided, {@link buildURL} will set this parameter automatically
+     * using the second part of the URL's path (the first part being the protocol name), or the first path if no other part exists.
      */
     streamName: string;
     /**
@@ -296,7 +298,7 @@ type Params = {
     iceServer?: RTCIceServer;
     /**
      * Optional media extension (mp4, flv, ts, rts), usefull for protocol like WebRTS which supports different container type.
-     * When not set, it's also an output parameter to indicate what is the media type selected
+     * When not set, it's also an output parameter for {@link defineMediaExt} to indicate what is the media type selected
      */
     mediaExt?: string;
     /**
@@ -327,6 +329,7 @@ declare enum Type {
 declare function defineMediaExt(type: Type, params: Params): void;
 /**
  * Build an URL from {@link Type | type} and {@link Params | params}
+ * Can assign {@link Params.mediaExt | params.mediaExt} or {@link Params.streamName | params.streamName}
  * @param type Type of the connection wanted
  * @param params Connection parameters
  * @param protocol Optional parameter to choose the prefered protocol to connect
@@ -493,6 +496,10 @@ declare class NetAddress {
      * console.log(NetAddress.fixProtocol('wss','http://domain/path')) // 'ws://domain/path'
      */
     static fixProtocol(protocol: string, address: string): string;
+    /**
+     * The host part from address `(http://)domain:port/path)`
+     */
+    get host(): string;
     /**
      * The domain part from address `(http://)domain(:port/path)`
      */
@@ -501,9 +508,6 @@ declare class NetAddress {
      * The port part from address `(http://)domain(:port/path)`, or defaultPort if passed in NetAddress constructor
      */
     get port(): number | undefined;
-    /**
-     * @returns the string address as passed in the constructor
-     */
     toString(): string;
     /**
      * @returns the string address as passed in the constructor
@@ -512,6 +516,7 @@ declare class NetAddress {
     valueOf(): string;
     private _address;
     private _domain;
+    private _host;
     private _port?;
     /**
      * Build a NetAddress object and parse address
@@ -796,12 +801,14 @@ declare function objectFrom(value: any, params: {
     noEmptyString: boolean;
 }): any;
 /**
- * Returns entries from something iterable, such as a Map, Set, or Array
- * If value is null it returns an empty array
- * @param value iterable input
- * @returns An javascript object
+ * Returns entries from an iterable input like Map, Set, or Array.
+ *
+ * For all other types of values (including `null` or `undefined`), it returns an empty array.
+ *
+ * @param value An iterable input
+ * @returns An array of key-value pairs
  */
-declare function objectEntries(value: any | null): [string, any][];
+declare function objectEntries(value: any): [string, any][];
 /**
  * Converts various data types, such as objects, strings, exceptions, errors,
  * or numbers, into a string representation. Since it offers a more comprehensive format,

package/dist/web-utils.js

@@ -257,25 +257,28 @@ function objectFrom(value, params) {
     return obj;
 }
 /**
- * Returns entries from something iterable, such as a Map, Set, or Array
- * If value is null it returns an empty array
- * @param value iterable input
- * @returns An javascript object
+ * Returns entries from an iterable input like Map, Set, or Array.
+ *
+ * For all other types of values (including `null` or `undefined`), it returns an empty array.
+ *
+ * @param value An iterable input
+ * @returns An array of key-value pairs
  */
 function objectEntries(value) {
     if (!value) {
         return [];
     }
-    if (value.entries) {
-        return value.entries();
-    }
-    return Array.from({
-        [Symbol.iterator]: function* () {
-            for (const key in value) {
-                yield [key, value[key]];
-            }
+    if (value.entries && typeof value.entries === 'function') {
+        value = value.entries();
+        if (Array.isArray(value)) {
+            return value;
         }
-    });
+    }
+    const entries = [];
+    for (const key of Object.keys(value)) {
+        entries.push([key, value[key]]);
+    }
+    return entries;
 }
 /**
  * Converts various data types, such as objects, strings, exceptions, errors,
@@ -1050,6 +1053,12 @@ class NetAddress {
         }
         return protocol + '://' + address;
     }
+    /**
+     * The host part from address `(http://)domain:port/path)`
+     */
+    get host() {
+        return this._host;
+    }
     /**
      * The domain part from address `(http://)domain(:port/path)`
      */
@@ -1062,9 +1071,6 @@ class NetAddress {
     get port() {
         return this._port;
     }
-    /**
-     * @returns the string address as passed in the constructor
-     */
     toString() {
         return this._address;
     }
@@ -1104,24 +1110,24 @@ class NetAddress {
                 address = address.substring(1);
             } // else something else #/
         }
+        // Remove Path!
+        pos = address.indexOf('/');
+        if (pos >= 0) {
+            address = address.substring(0, pos);
+        }
+        this._host = address;
         this._domain = address;
         this._port = defaultPort;
         // Parse Port
-        pos = address.lastIndexOf(':');
-        if (pos >= 0) {
+        pos = this._host.lastIndexOf(':');
+        const endOfBrace = this._host.lastIndexOf(']'); // to support IPv6
+        if (pos > endOfBrace) {
             const port = parseInt(address.substring(pos + 1));
-            if (port && port <= 0xffff) {
+            if (port >= 0 && 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.
@@ -1192,6 +1198,7 @@ function defineMediaExt(type, params) {
 }
 /**
  * Build an URL from {@link Type | type} and {@link Params | params}
+ * Can assign {@link Params.mediaExt | params.mediaExt} or {@link Params.streamName | params.streamName}
  * @param type Type of the connection wanted
  * @param params Connection parameters
  * @param protocol Optional parameter to choose the prefered protocol to connect
@@ -1222,7 +1229,15 @@ function buildURL(type, params, protocol = 'wss') {
                 console.warn('Unknown url type ' + type);
                 break;
         }
-    } // Host has already a path! keep it unchanged, it's user intentionnal (used with some other WHIP/WHEP server?)
+    }
+    else {
+        // Host has already a path! keep it unchanged, it's user intentionnal (used with some other WHIP/WHEP server?)
+        if (!params.streamName) {
+            // extract the second part of the URL's path (the first part being the protocol name), or the first path if no other part exists
+            const parts = url.pathname.split('/');
+            params.streamName = getBaseFile(parts[2] || parts[1] || parts[0]);
+        }
+    }
     if (params.accessToken) {
         url.searchParams.set('id', params.accessToken);
     }
@@ -2419,4 +2434,4 @@ class UIMetrics {
  * 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 = '4.0.0';export{BinaryReader,BinaryWriter,BitReader,ByteRate,Connect,EpochTime,EventEmitter,FixMap,Log,LogLevel,Loggable,NetAddress,Numbers,Queue,SDP,UIMetrics,Util,VERSION,WebSocketReliable,log};//# sourceMappingURL=web-utils.js.map
+const VERSION = '4.2.0';export{BinaryReader,BinaryWriter,BitReader,ByteRate,Connect,EpochTime,EventEmitter,FixMap,Log,LogLevel,Loggable,NetAddress,Numbers,Queue,SDP,UIMetrics,Util,VERSION,WebSocketReliable,log};//# sourceMappingURL=web-utils.js.map