@ceeblue/web-utils 3.2.1 → 4.1.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,13 +298,13 @@ 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;
     /**
      * Optional query to add into the generated url of connection
      */
-    query?: Record<string, string>;
+    query?: URLSearchParams;
 };
 /**
  * Type of connection
@@ -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
@@ -349,6 +352,20 @@ declare namespace Connect {
  * See file LICENSE or go to https://spdx.org/licenses/AGPL-3.0-or-later.html for full license details.
  */
 
+type FilterOnKey<T> = T extends 'once' | 'on' ? never : T extends `on${infer R}` ? R : never;
+type CaseVariations<T extends string> = string extends T ? string : Lowercase<T> | Capitalize<T>;
+/**
+ * Extract all event keys from a class.
+ * @example
+ * class Logger extends EventEmitter {
+ *   onLog(log:string) { console.log(log); }
+ *   onClick(log:string) { console.log(log); }
+ * }
+ * type LoggerEvents = EventKeys<Logger>; // "log" | "click"
+ */
+type EventKeys<Keys> = keyof {
+    [K in keyof Keys as CaseVariations<FilterOnKey<K>>]: never;
+};
 /**
  * A advanced EventEmitter which allows to declare event as natural function in the inheriting children class,
  * function must start by `on` prefix to be recognized as an event.
@@ -402,7 +419,7 @@ declare class EventEmitter extends Loggable {
      * @param event Subscriber Function
      * @param options.signal Optional `AbortSignal` to stop this or multiple subscriptions in same time
      */
-    on(name: string, event: Function, options?: {
+    on(name: EventKeys<this>, event: Function, options?: {
         signal?: AbortSignal;
     }): void;
     /**
@@ -411,7 +428,7 @@ declare class EventEmitter extends Loggable {
      * @param event Subscriber Function
      * @param options.abortSignal Optional `AbortSignal` to stop this or multiple subscriptions in same time
      */
-    once(name: string, event: Function, options?: {
+    once(name: EventKeys<this>, event: Function, options?: {
         signal?: AbortSignal;
     }): void;
     /**
@@ -419,7 +436,7 @@ declare class EventEmitter extends Loggable {
      * @param name Name of event without the 'on' prefix (ex: 'log' to 'onLog' event declared)
      * @param event Unsubscriber Function, must be the one passed to {@link on} or {@link once} subscription methods
      */
-    off(name: string, event: Function): void;
+    off(name: EventKeys<this>, event: Function): boolean;
     private _event;
 }
 
@@ -782,9 +799,12 @@ declare function objectFrom(value: any, params: {
     noEmptyString: boolean;
 }): any;
 /**
- * Returns entries from something iterable, such as a Map, Set, or 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): [string, any][];
 /**

package/dist/web-utils.js

@@ -257,21 +257,28 @@ function objectFrom(value, params) {
     return obj;
 }
 /**
- * Returns entries from something iterable, such as a Map, Set, or 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.entries) {
-        return value.entries();
+    if (!value) {
+        return [];
     }
-    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,
@@ -1188,6 +1195,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
@@ -1218,12 +1226,20 @@ 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 = parts[2] || parts[1] || parts[0];
+        }
+    }
     if (params.accessToken) {
         url.searchParams.set('id', params.accessToken);
     }
-    for (const key in params.query) {
-        url.searchParams.set(key, params.query[key]);
+    for (const [key, value] of objectEntries(params.query)) {
+        url.searchParams.set(key, value);
     }
     return url;
 }var Connect=/*#__PURE__*/Object.freeze({__proto__:null,get Type(){return Type},buildURL:buildURL,defineMediaExt:defineMediaExt});/**
@@ -1286,19 +1302,18 @@ class EventEmitter extends Loggable {
                 if (name.length < 3 || !name.startsWith('on')) {
                     continue;
                 }
-                if (proto[name] instanceof Function) {
+                let defaultEvent = proto[name];
+                if (defaultEvent instanceof Function) {
                     const events = new Set();
                     this._events.set(name.substring(2).toLowerCase(), events);
-                    let defaultEvent = proto[name];
                     const raise = (...args) => {
-                        // Call default event if not null (can happen in JS usage)
-                        if (defaultEvent) {
-                            defaultEvent.call(this, ...args);
-                        }
+                        // Call default event if not undefined, can happen if assigned to null/undefined
+                        const result = defaultEvent ? defaultEvent.call(this, ...args) : undefined;
                         // Call subscribers
                         for (const event of events) {
                             event(...args);
                         }
+                        return result;
                     };
                     Object.defineProperties(this, {
                         [name]: {
@@ -1322,8 +1337,8 @@ class EventEmitter extends Loggable {
      */
     on(name, event, options) {
         var _a;
-        if (!event) {
-            throw Error('event to subscribe cannot be null');
+        if (typeof event !== 'function') {
+            throw Error('event callback must be a function');
         }
         const events = this._event(name);
         events.add(event);
@@ -1337,8 +1352,8 @@ class EventEmitter extends Loggable {
      */
     once(name, event, options) {
         var _a;
-        if (!event) {
-            throw Error('event to subscribe cannot be null');
+        if (typeof event !== 'function') {
+            throw Error('event callback must be a function');
         }
         const events = this._event(name);
         events.add((...args) => {
@@ -1356,7 +1371,7 @@ class EventEmitter extends Loggable {
         if (!event) {
             throw Error('event to unsubscribe cannot be null');
         }
-        this._event(name).delete(event);
+        return this._event(name).delete(event);
     }
     _event(name) {
         const events = this._events.get(name.toLowerCase());
@@ -2416,4 +2431,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 = '3.2.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
+const VERSION = '4.1.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