@ceeblue/web-utils 4.2.0 → 6.0.0

package/.codecov.yml

@@ -0,0 +1,21 @@
+coverage:
+  status:
+    project:
+      default:
+        target: 90%
+        threshold: 10%
+    patch:
+      default:
+        target: 90%
+        threshold: 10%
+
+comment:
+  layout: "reach, diff, flags, files"
+  behavior: default
+  require_changes: true
+
+ignore:
+  - "**/*.test.ts"
+  - "**/*.spec.ts"
+  - "**/__tests__/**"
+  - "**/__mocks__/**"

package/dist/web-utils.d.ts

@@ -273,6 +273,41 @@ declare class ByteRate {
     private updateSamples;
 }
 
+/**
+ * Parameters of a key system for encrypted streams (DRM)
+ *
+ * If the key system is a string, it's the URL of the license server.
+ *
+ * If the key system is an object, it's a key system configuration with more parameters.
+ */
+type KeySystem = string | {
+    /**
+     * The license server URL
+     */
+    licenseUrl: string;
+    /**
+     * The certificate URL if needed (for FairPlay)
+     *
+     * Or directly the certificate
+     */
+    certificate?: string | Uint8Array;
+    /**
+     * The additional HTTP headers to send to the license server
+     */
+    headers?: Record<string, string>;
+    /**
+     * Audio robustness level
+     *
+     * A list of robustness levels, prioritized by the order of the array.
+     */
+    audioRobustness?: string[];
+    /**
+     * Video robustness level
+     *
+     * A list of robustness levels, prioritized by the order of the array.
+     */
+    videoRobustness?: string[];
+};
 /**
  * Parameters of connections
  */
@@ -296,6 +331,11 @@ type Params = {
      * iceServer to use while connecting to a WebRTC stream
      */
     iceServer?: RTCIceServer;
+    /**
+     * Map of keys to content protection settings for encrypted streams
+     * The key can be "com.apple.fps" for example for FairPlay
+     */
+    contentProtection?: Record<string, KeySystem>;
     /**
      * 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 for {@link defineMediaExt} to indicate what is the media type selected
@@ -337,13 +377,14 @@ declare function defineMediaExt(type: Type, params: Params): void;
  */
 declare function buildURL(type: Type, params: Params, protocol?: string): URL;
 
+type Connect_KeySystem = KeySystem;
 type Connect_Params = Params;
 type Connect_Type = Type;
 declare const Connect_Type: typeof Type;
 declare const Connect_buildURL: typeof buildURL;
 declare const Connect_defineMediaExt: typeof defineMediaExt;
 declare namespace Connect {
-  export { type Connect_Params as Params, Connect_Type as Type, Connect_buildURL as buildURL, Connect_defineMediaExt as defineMediaExt };
+  export { type Connect_KeySystem as KeySystem, type Connect_Params as Params, Connect_Type as Type, Connect_buildURL as buildURL, Connect_defineMediaExt as defineMediaExt };
 }
 
 /**
@@ -776,13 +817,22 @@ declare const SDP: {
  */
 declare const EMPTY_FUNCTION: () => void;
 /**
- * Efficient and high resolution timestamp in milliseconds elapsed since {@link Util.timeOrigin}
+ * Returns an efficient timestamp in milliseconds elapsed since {@link performance.timeOrigin},
+ * representing the start of the current JavaScript execution context.
+ *
+ * Note: Each Web Worker runs in a separate JS context, so timestamps
+ * are not directly comparable between different workers. Use {@link unixTime}
+ * for comparable timestamps across different Web Workers.
  */
 declare function time(): number;
 /**
- * Time origin represents the time when the application has started
+ * Returns an efficient Unix timestamp in milliseconds.
+ *
+ * Unix timestamps are universally comparable across different JavaScript
+ * contexts (e.g., Web Workers), as they reference the number of milliseconds
+ * elapsed since January 1, 1970 (UNIX epoch).
  */
-declare function timeOrigin(): number;
+declare function unixTime(): number;
 /**
  * Parse query and returns it in an easy-to-use Javascript object form
  * @param urlOrQueryOrSearch string, url, or searchParams containing query. If not set it uses `location.search` to determinate query.
@@ -801,14 +851,14 @@ declare function objectFrom(value: any, params: {
     noEmptyString: boolean;
 }): any;
 /**
- * Returns entries from an iterable input like Map, Set, or Array.
+ * Returns a IterableIterator<[string, any]> from any iterable input like Map, Set, Array, or Object.
  *
- * For all other types of values (including `null` or `undefined`), it returns an empty array.
+ * For all other types of values (including `null` or `undefined`) it returns an empty iterator.
  *
  * @param value An iterable input
- * @returns An array of key-value pairs
+ * @returns a IterableIterator<[string, any]>
  */
-declare function objectEntries(value: any): [string, any][];
+declare function iterableEntries(value: any): IterableIterator<[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,
@@ -895,20 +945,20 @@ declare const Util_fetch: typeof fetch;
 declare const Util_getBaseFile: typeof getBaseFile;
 declare const Util_getExtension: typeof getExtension;
 declare const Util_getFile: typeof getFile;
-declare const Util_objectEntries: typeof objectEntries;
+declare const Util_iterableEntries: typeof iterableEntries;
 declare const Util_objectFrom: typeof objectFrom;
 declare const Util_options: typeof options;
 declare const Util_safePromise: typeof safePromise;
 declare const Util_sleep: typeof sleep;
 declare const Util_stringify: typeof stringify;
 declare const Util_time: typeof time;
-declare const Util_timeOrigin: typeof timeOrigin;
 declare const Util_toBin: typeof toBin;
 declare const Util_trim: typeof trim;
 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_objectEntries as objectEntries, 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_timeOrigin as timeOrigin, Util_toBin as toBin, Util_trim as trim, Util_trimEnd as trimEnd, Util_trimStart as trimStart };
+  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 };
 }
 
 /**
@@ -1183,6 +1233,7 @@ declare class UIMetrics {
     private _legendFontSize;
     private _stepSize;
     private _ranges;
+    private _mouseX?;
     constructor(ui: HTMLElement);
     /**
      * Reset metrics stats, essentially rescaling the metrics

package/dist/web-utils.js

@@ -164,16 +164,25 @@ const _perf = performance; // to increase x10 now performance!
  */
 const EMPTY_FUNCTION = () => { };
 /**
- * Efficient and high resolution timestamp in milliseconds elapsed since {@link Util.timeOrigin}
+ * Returns an efficient timestamp in milliseconds elapsed since {@link performance.timeOrigin},
+ * representing the start of the current JavaScript execution context.
+ *
+ * Note: Each Web Worker runs in a separate JS context, so timestamps
+ * are not directly comparable between different workers. Use {@link unixTime}
+ * for comparable timestamps across different Web Workers.
  */
 function time() {
     return Math.floor(_perf.now());
 }
 /**
- * Time origin represents the time when the application has started
+ * Returns an efficient Unix timestamp in milliseconds.
+ *
+ * Unix timestamps are universally comparable across different JavaScript
+ * contexts (e.g., Web Workers), as they reference the number of milliseconds
+ * elapsed since January 1, 1970 (UNIX epoch).
  */
-function timeOrigin() {
-    return Math.floor(_perf.now() + _perf.timeOrigin);
+function unixTime() {
+    return Math.floor(_perf.timeOrigin + _perf.now());
 }
 /**
  * Parse query and returns it in an easy-to-use Javascript object form
@@ -214,7 +223,7 @@ function objectFrom(value, params) {
     if (!value) {
         return obj;
     }
-    for (const [key, val] of objectEntries(value)) {
+    for (const [key, val] of iterableEntries(value)) {
         value = val;
         if (params.withType && value != null && value.substring) {
             if (value) {
@@ -257,28 +266,28 @@ function objectFrom(value, params) {
     return obj;
 }
 /**
- * Returns entries from an iterable input like Map, Set, or Array.
+ * Returns a IterableIterator<[string, any]> from any iterable input like Map, Set, Array, or Object.
  *
- * For all other types of values (including `null` or `undefined`), it returns an empty array.
+ * For all other types of values (including `null` or `undefined`) it returns an empty iterator.
  *
  * @param value An iterable input
- * @returns An array of key-value pairs
+ * @returns a IterableIterator<[string, any]>
  */
-function objectEntries(value) {
+function iterableEntries(value) {
     if (!value) {
-        return [];
+        return (function* () { })();
     }
-    if (value.entries && typeof value.entries === 'function') {
+    if (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]]);
+    if (typeof value[Symbol.iterator] === 'function') {
+        return value;
     }
-    return entries;
+    return (function* () {
+        for (const key in value) {
+            yield [key.toString(), value[key]];
+        }
+    })();
 }
 /**
  * Converts various data types, such as objects, strings, exceptions, errors,
@@ -491,7 +500,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,objectEntries:objectEntries,objectFrom:objectFrom,options:options,safePromise:safePromise,sleep:sleep,stringify:stringify,time:time,timeOrigin:timeOrigin,toBin:toBin,trim:trim,trimEnd:trimEnd,trimStart:trimStart});/**
+}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});/**
  * 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.
@@ -1032,6 +1041,8 @@ class NetAddress {
      * console.log(NetAddress.fixProtocol('wss','http://domain/path')) // 'ws://domain/path'
      */
     static fixProtocol(protocol, address) {
+        // Remove leading slashes for absolute pathes!
+        address = address.replace(/^[\/]+/, '');
         const found = address.indexOf('://');
         // isolate protocol is present in address
         if (found >= 0) {
@@ -1118,14 +1129,14 @@ class NetAddress {
         this._host = address;
         this._domain = address;
         this._port = defaultPort;
-        // Parse Port
-        pos = this._host.lastIndexOf(':');
-        const endOfBrace = this._host.lastIndexOf(']'); // to support IPv6
-        if (pos > endOfBrace) {
-            const port = parseInt(address.substring(pos + 1));
-            if (port >= 0 && port <= 0xffff) {
-                this._port = port;
-                this._domain = address.substring(0, pos);
+        const domainPortMatch = this._host.match(/^(?:\[([0-9a-fA-F:]+)\]|([^:/?#]+))(?::(\d+))?(?=[/#?]|$)/);
+        if (domainPortMatch) {
+            this._domain = domainPortMatch[1] || domainPortMatch[2];
+            if (domainPortMatch[3]) {
+                const port = parseInt(domainPortMatch[3]);
+                if (port >= 0 && port <= 0xffff) {
+                    this._port = port;
+                }
             }
         }
     }
@@ -1205,6 +1216,7 @@ function defineMediaExt(type, params) {
  * @returns The URL of connection
  */
 function buildURL(type, params, protocol = 'wss') {
+    var _a;
     defineMediaExt(type, params);
     const url = new URL(NetAddress.fixProtocol(protocol, params.endPoint));
     if (url.pathname.length <= 1) {
@@ -1241,7 +1253,7 @@ function buildURL(type, params, protocol = 'wss') {
     if (params.accessToken) {
         url.searchParams.set('id', params.accessToken);
     }
-    for (const [key, value] of objectEntries(params.query)) {
+    for (const [key, value] of (_a = params.query) !== null && _a !== void 0 ? _a : []) {
         url.searchParams.set(key, value);
     }
     return url;
@@ -1359,11 +1371,12 @@ class EventEmitter extends Loggable {
             throw Error('event callback must be a function');
         }
         const events = this._event(name);
-        events.add((...args) => {
-            events.delete(event); // delete from events
+        const wrapper = (...args) => {
+            events.delete(wrapper); // delete the wrapper from events
             event(...args); // execute event
-        });
-        (_a = options === null || options === void 0 ? void 0 : options.signal) === null || _a === void 0 ? void 0 : _a.addEventListener('abort', () => events.delete(event), { once: true });
+        };
+        events.add(wrapper);
+        (_a = options === null || options === void 0 ? void 0 : options.signal) === null || _a === void 0 ? void 0 : _a.addEventListener('abort', () => events.delete(wrapper), { once: true });
     }
     /**
      * Event unsubscription
@@ -2287,6 +2300,12 @@ class UIMetrics {
     }
     constructor(ui) {
         this._ui = ui;
+        ui.addEventListener('mousemove', (event) => {
+            this._mouseX = event.offsetX;
+        });
+        ui.addEventListener('mouseleave', (event) => {
+            this._mouseX = undefined;
+        });
         // default values in pixels
         this._lineHeight = 40;
         this._labelWidth = 170;
@@ -2370,6 +2389,7 @@ class UIMetrics {
             const delta = range.max - range.min;
             let minCircle = '';
             let maxCircle = '';
+            let mouseCircle = this._mouseX == null || this._mouseX > x ? null : '';
             for (let i = 0; i < values.length; ++i) {
                 x -= this._stepSize;
                 const value = parseFloat(values[i].toString());
@@ -2381,6 +2401,9 @@ class UIMetrics {
                 else if (value === max) {
                     minCircle = minCircle || this._drawCircle(x, y, value);
                 }
+                if (mouseCircle === '' && x <= (this._mouseX || 0)) {
+                    mouseCircle = this._drawCircle(x, y, value, 'blue', '');
+                }
             }
             this._html += '" />'; // end path
             // Average
@@ -2395,7 +2418,10 @@ class UIMetrics {
                     '</tspan>';
             this._html += '<tspan x="' + (width + averageCenter) + '" dy="1em">±' + average + '</tspan>';
             this._html += '</text>';
-            this._html += minCircle + maxCircle;
+            this._html += minCircle + maxCircle + (mouseCircle !== null && mouseCircle !== void 0 ? mouseCircle : '');
+            if (mouseCircle) {
+                this._html += mouseCircle;
+            }
             this._html += '</svg>';
         }
         requestAnimationFrame(() => {
@@ -2405,8 +2431,8 @@ class UIMetrics {
             }
         });
     }
-    _drawCircle(x, y, value) {
-        let circle = '<circle cx="' + x + '" cy="' + y + '" r="2" fill="green" />';
+    _drawCircle(x, y, value, color = 'green', fontStyle = 'italic') {
+        let circle = '<circle cx="' + x + '" cy="' + y + '" r="2" fill="' + color + '" />';
         const legendFontHeight = 0.7 * this._legendFontSize;
         const graphMiddle = Math.round(this._lineHeight / 2);
         if (y < graphMiddle) {
@@ -2418,7 +2444,9 @@ class UIMetrics {
             y -= this.textMargin;
         }
         circle +=
-            '<text font-style="italic" font-size="' +
+            '<text font-style="' +
+                fontStyle +
+                '" font-size="' +
                 this._legendFontSize +
                 '" x="' +
                 (x - this._legendFontSize) +
@@ -2434,4 +2462,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.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
+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