@ceeblue/web-utils 6.0.0 → 7.0.1

package/dist/web-utils.d.ts

@@ -322,7 +322,7 @@ type Params = {
      * 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;
+    streamName?: string;
     /**
      * Optional access token to use to join a private stream
      */
@@ -891,14 +891,26 @@ declare function safePromise<T>(timeout: number, promise: Promise<T>): Promise<u
  */
 declare function sleep(ms: number): Promise<unknown>;
 /**
- * Test equality between two value whatever their type, array included
+ * Test equality between two value whatever their type, object and array included
  */
-declare function equal(a: any, b: any): boolean;
+declare function equal(a: any, b: any, seen?: WeakMap<WeakKey, 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
+ * Fetch help method adding an explicit error property when Response is NOK, with the more accurate textual error inside
  */
-declare function fetch(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
+declare function fetch(input: RequestInfo | URL, init?: RequestInit): Promise<Response & {
+    error?: string;
+}>;
+/**
+ * Fetch help method adding an explicit error property when Response is NOK, with the more accurate textual error inside
+ * Also measure the rtt of fetching and returns it in the property Response.rtt (guaranteed to be ≥ 1),
+ * supports subtracting server processing time using either the Response-Delay or CMSD-rd header when available
+ *
+ * WIP => replace the current implementation to use Resource Timing API
+ */
+declare function fetchWithRTT(input: RequestInfo | URL, init?: RequestInit): Promise<Response & {
+    rtt: number;
+    error?: string;
+}>;
 /**
  * Get Extension part from path
  * @param path path to parse
@@ -942,6 +954,7 @@ declare function trimEnd(value: string, chars?: 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_fetchWithRTT: typeof fetchWithRTT;
 declare const Util_getBaseFile: typeof getBaseFile;
 declare const Util_getExtension: typeof getExtension;
 declare const Util_getFile: typeof getFile;
@@ -958,7 +971,7 @@ declare const Util_trimEnd: typeof trimEnd;
 declare const Util_trimStart: typeof trimStart;
 declare const Util_unixTime: typeof unixTime;
 declare namespace Util {
-  export { Util_EMPTY_FUNCTION as EMPTY_FUNCTION, Util_equal as equal, Util_fetch as fetch, Util_getBaseFile as getBaseFile, Util_getExtension as getExtension, Util_getFile as getFile, Util_iterableEntries as iterableEntries, Util_objectFrom as objectFrom, Util_options as options, Util_safePromise as safePromise, Util_sleep as sleep, Util_stringify as stringify, Util_time as time, Util_toBin as toBin, Util_trim as trim, Util_trimEnd as trimEnd, Util_trimStart as trimStart, Util_unixTime as unixTime };
+  export { Util_EMPTY_FUNCTION as EMPTY_FUNCTION, Util_equal as equal, Util_fetch as fetch, Util_fetchWithRTT as fetchWithRTT, Util_getBaseFile as getBaseFile, Util_getExtension as getExtension, Util_getFile as getFile, Util_iterableEntries as iterableEntries, Util_objectFrom as objectFrom, Util_options as options, Util_safePromise as safePromise, Util_sleep as sleep, Util_stringify as stringify, Util_time as time, Util_toBin as toBin, Util_trim as trim, Util_trimEnd as trimEnd, Util_trimStart as trimStart, Util_unixTime as unixTime };
 }
 
 /**

package/dist/web-utils.js

@@ -371,55 +371,141 @@ function safePromise(timeout, promise) {
  * Wait in milliseconds, requires a call with await keyword!
  */
 function sleep(ms) {
-    return new Promise(resolve => {
-        setTimeout(resolve, ms);
+    return __awaiter(this, void 0, void 0, function* () {
+        return new Promise(resolve => {
+            setTimeout(resolve, ms);
+        });
     });
 }
 /**
- * Test equality between two value whatever their type, array included
+ * Test equality between two value whatever their type, object and 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;
+function equal(a, b, seen = new WeakMap()) {
+    // 1. Check primitve identiy or NaN
+    if (a === b) {
+        return true;
     }
-    // complexe object
-    if (a[Symbol.iterator]) {
-        if (!b[Symbol.iterator]) {
-            return false;
+    if (Number.isNaN(a) && Number.isNaN(b)) {
+        return true;
+    }
+    // 2. Check the both are complexe object
+    if (Object(a) !== a || Object(b) !== b) {
+        return false;
+    }
+    // 3. Catch circular reference
+    if (seen.has(a)) {
+        return seen.get(a) === b;
+    }
+    seen.set(a, b);
+    // 4. Check « toStringTag » (Date, RegExp, Map, Set…)
+    const tagA = Object.prototype.toString.call(a);
+    if (tagA !== Object.prototype.toString.call(b)) {
+        return false;
+    }
+    // 5. Special Case
+    switch (tagA) {
+        case '[object Date]':
+            return a.getTime() === b.getTime();
+        case '[object RegExp]':
+            return a.source === b.source && a.flags === b.flags;
+        case '[object Set]':
+        case '[object Map]': {
+            if (a.size !== b.size) {
+                return false;
+            }
+            const aKeys = a.keys();
+            const bKeys = a.keys();
+            const aValues = a.values();
+            const bValues = b.values();
+            let aKey;
+            while (!(aKey = aKeys.next()).done) {
+                if (!equal(aKey.value, bKeys.next().value)) {
+                    return false;
+                }
+                const aValue = aValues.next().value;
+                const bValue = bValues.next().value;
+                if (aValue !== aKey && !equal(aValue, bValue)) {
+                    return false;
+                }
+            }
+            return true;
         }
-        if (a.length !== b.length) {
+    }
+    // 6. Arrays
+    if (Array.isArray(a)) {
+        if (!Array.isArray(b) || a.length !== b.length) {
             return false;
         }
-        for (let i = 0; i !== a.length; ++i) {
-            if (a[i] !== b[i]) {
+        for (let i = 0; i < a.length; i++) {
+            if (!equal(a[i], b[i], seen)) {
                 return false;
             }
         }
         return true;
     }
-    return a === b;
+    // 7. Generic object : keys + symbols
+    const keysA = [...Object.keys(a), ...Object.getOwnPropertySymbols(a)];
+    if (keysA.length !== Object.keys(b).length + Object.getOwnPropertySymbols(b).length) {
+        return false;
+    }
+    for (const key of keysA) {
+        if (!equal(a[key], b[key], seen)) {
+            return false;
+        }
+    }
+    return true;
 }
 /**
- * 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
+ * Fetch help method adding an explicit error property when Response is NOK, with the more accurate textual error inside
  */
 function fetch(input, init) {
     return __awaiter(this, void 0, void 0, function* () {
-        const response = yield self.fetch(input, init);
-        if (response.status >= 300) {
-            let error;
+        const response = (yield self.fetch(input, init));
+        if (!response.ok) {
             if (response.body) {
-                error = yield response.text();
+                response.error = yield response.text();
+            }
+            if (!response.error) {
+                response.error = response.statusText || response.status.toString() || 'Unknown error';
             }
-            throw (error || response.statusText || response.status).toString();
         }
         return response;
     });
 }
+/**
+ * Fetch help method adding an explicit error property when Response is NOK, with the more accurate textual error inside
+ * Also measure the rtt of fetching and returns it in the property Response.rtt (guaranteed to be ≥ 1),
+ * supports subtracting server processing time using either the Response-Delay or CMSD-rd header when available
+ *
+ * WIP => replace the current implementation to use Resource Timing API
+ */
+function fetchWithRTT(input, init) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // A first OPTIONS request to establish a connection (keep-alive)
+        yield fetch(input, Object.assign(Object.assign({}, init), { method: 'OPTIONS' }));
+        // Actual RTT measurement
+        const startTime = time();
+        const response = (yield fetch(input, init));
+        response.rtt = time() - startTime;
+        // remove the ResponseDelay if indicated by the server
+        let responseDelay = Number(response.headers.get('Response-Delay')) || 0;
+        if (!responseDelay) {
+            // search if we have a CMSD info?
+            // cmsd-dynamic "fly";rd=1
+            const cmsd = response.headers.get('cmsd-dynamic');
+            if (cmsd) {
+                for (const param of cmsd.split(';')) {
+                    const [name, value] = param.split('=');
+                    if (name.trim().toLowerCase() === 'rd') {
+                        responseDelay = Number(value) || responseDelay;
+                    }
+                }
+            }
+        }
+        response.rtt = Math.max(1, response.rtt - responseDelay);
+        return response;
+    });
+}
 /**
  * Get Extension part from path
  * @param path path to parse
@@ -500,7 +586,7 @@ function trimEnd(value, chars = ' ') {
         --i;
     }
     return value.substring(0, i);
-}var Util=/*#__PURE__*/Object.freeze({__proto__:null,EMPTY_FUNCTION:EMPTY_FUNCTION,equal:equal,fetch:fetch,getBaseFile:getBaseFile,getExtension:getExtension,getFile:getFile,iterableEntries:iterableEntries,objectFrom:objectFrom,options:options,safePromise:safePromise,sleep:sleep,stringify:stringify,time:time,toBin:toBin,trim:trim,trimEnd:trimEnd,trimStart:trimStart,unixTime:unixTime});/**
+}var Util=/*#__PURE__*/Object.freeze({__proto__:null,EMPTY_FUNCTION:EMPTY_FUNCTION,equal:equal,fetch:fetch,fetchWithRTT:fetchWithRTT,getBaseFile:getBaseFile,getExtension:getExtension,getFile:getFile,iterableEntries:iterableEntries,objectFrom:objectFrom,options:options,safePromise:safePromise,sleep:sleep,stringify:stringify,time:time,toBin:toBin,trim:trim,trimEnd:trimEnd,trimStart:trimStart,unixTime:unixTime});/**
  * 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.
@@ -1167,7 +1253,21 @@ var Type;
  * @param params The parameters for which the media extension is to be defined
  */
 function defineMediaExt(type, params) {
+    var _a;
     // Compute appropriate mediaExt out parameter
+    if (!params.mediaExt) {
+        try {
+            const url = new URL(params.endPoint);
+            // Set mediaExt with ?ext= param when set OR url extension
+            params.mediaExt = (_a = url.searchParams.get('ext')) !== null && _a !== void 0 ? _a : getExtension(getFile(url.pathname));
+        }
+        catch (_) {
+            // not an URL, it's only a host
+            params.mediaExt = '';
+        }
+    }
+    // Normalize mediaExt in removing the possible '.' prefix and change it to lower case
+    params.mediaExt = trimStart(params.mediaExt, '.').toLowerCase();
     switch (type) {
         case Type.HESP:
             params.mediaExt = 'mp4';
@@ -1176,19 +1276,8 @@ function defineMediaExt(type, params) {
             params.mediaExt = 'rtp';
             break;
         case Type.WRTS: {
-            try {
-                const url = new URL(params.endPoint);
-                const ext = getExtension(getFile(url.pathname));
-                // set extension just if not json, json means a manifest file endPoint
-                if (ext && ext.toLowerCase() !== '.json') {
-                    params.mediaExt = ext;
-                }
-            }
-            catch (_) {
-                // not an URL, it's only a host => keep mediaExt unchanged to build the URL
-            }
-            if (!params.mediaExt) {
-                // set to its default rts value => always set for WRTS!
+            // json means a manifest file endPoint, replace with default rts media extension
+            if (!params.mediaExt || params.mediaExt === 'json') {
                 params.mediaExt = 'rts';
             }
             break;
@@ -1200,12 +1289,9 @@ function defineMediaExt(type, params) {
             params.mediaExt = 'json';
             break;
         default:
-            params.mediaExt = ''; // set always a value to know that the parameters have been fixed
-            console.warn('Unknown params type ' + type);
+            log('Unknown params type ' + type).warn();
             break;
     }
-    // Fix mediaExt in removing the possible '.' prefix
-    params.mediaExt = trimStart(params.mediaExt, '.');
 }
 /**
  * Build an URL from {@link Type | type} and {@link Params | params}
@@ -1238,7 +1324,7 @@ function buildURL(type, params, protocol = 'wss') {
                 url.pathname = '/' + params.streamName + '.json';
                 break;
             default:
-                console.warn('Unknown url type ' + type);
+                log('Unknown url type ' + type).warn();
                 break;
         }
     }
@@ -2462,4 +2548,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 = '6.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 = '7.0.1';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