@ceeblue/web-utils 2.2.1 → 2.3.0

package/dist/web-utils.d.ts

@@ -130,6 +130,11 @@ type Params = {
      * iceServer to use while connecting to a WebRTC stream
      */
     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
+     */
+    mediaExt?: string;
     /**
      * Optional query to add into the generated url of connection
      */
@@ -148,6 +153,14 @@ declare enum Type {
 /**
  * Some connection utility functions
  */
+/**
+ * Defines the {@link Params.mediaExt} based on the type of parameters and its endpoint.
+ * This method always assigns a value to params.mediaExt, defaulting to an empty string if indeterminable,
+ * allowing detection of whether the function has been applied to the parameters.
+ * @param type The type of parameters to define.
+ * @param params The parameters for which the media extension is to be defined
+ */
+declare function defineMediaExt(type: Type, params: Params): void;
 /**
  * Build an URL from {@link Type | type} and {@link Params | params}
  * @param type Type of the connection wanted
@@ -161,8 +174,9 @@ 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 };
+  export { type Connect_Params as Params, Connect_Type as Type, Connect_buildURL as buildURL, Connect_defineMediaExt as defineMediaExt };
 }
 
 /**
@@ -668,27 +682,58 @@ declare function equal(a: any, b: any): boolean;
  */
 declare function fetch(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
 /**
- * Extension parser
+ * Get Extension part from path
  * @param path path to parse
  * @returns the extension
  */
-declare function parseExtension(path: string): string;
+declare function getExtension(path: string): string;
+/**
+ * Get File part from path
+ * @param path path to parse
+ * @returns the file name
+ */
+declare function getFile(path: string): string;
+/**
+ * String Trim function with customizable chars
+ * @param value string to trim
+ * @param chars chars to use to trim
+ * @returns string trimmed
+ */
+declare function trim(value: string, chars?: string): string;
+/**
+ * String Trim Start function with customizable chars
+ * @param value string to trim start
+ * @param chars chars to use to trim start
+ * @returns string trimmed
+ */
+declare function trimStart(value: string, chars?: string): string;
+/**
+ * String Trim End function with customizable chars
+ * @param value string to trim end
+ * @param chars chars to use to trim end
+ * @returns string trimmed
+ */
+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_getExtension: typeof getExtension;
+declare const Util_getFile: typeof getFile;
 declare const Util_objectEntries: typeof objectEntries;
 declare const Util_objectFrom: typeof objectFrom;
 declare const Util_options: typeof options;
-declare const Util_parseExtension: typeof parseExtension;
 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 namespace Util {
-  export { Util_EMPTY_FUNCTION as EMPTY_FUNCTION, Util_equal as equal, Util_fetch as fetch, Util_objectEntries as objectEntries, Util_objectFrom as objectFrom, Util_options as options, Util_parseExtension as parseExtension, Util_safePromise as safePromise, Util_sleep as sleep, Util_stringify as stringify, Util_time as time, Util_timeOrigin as timeOrigin, Util_toBin as toBin };
+  export { Util_EMPTY_FUNCTION as EMPTY_FUNCTION, Util_equal as equal, Util_fetch as fetch, 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 };
 }
 
 /**

package/dist/web-utils.js

@@ -642,15 +642,76 @@ function fetch(input, init) {
     });
 }
 /**
- * Extension parser
+ * Get Extension part from path
  * @param path path to parse
  * @returns the extension
  */
-function parseExtension(path) {
+function getExtension(path) {
     const dot = path.lastIndexOf('.');
     const ext = dot >= 0 && dot > path.lastIndexOf('/') ? path.substring(dot) : '';
     return ext;
-}var Util=/*#__PURE__*/Object.freeze({__proto__:null,EMPTY_FUNCTION:EMPTY_FUNCTION,equal:equal,fetch:fetch,objectEntries:objectEntries,objectFrom:objectFrom,options:options,parseExtension:parseExtension,safePromise:safePromise,sleep:sleep,stringify:stringify,time:time,timeOrigin:timeOrigin,toBin:toBin});/**
+}
+/**
+ * Get File part from path
+ * @param path path to parse
+ * @returns the file name
+ */
+function getFile(path) {
+    return path.substring(path.lastIndexOf('/') + 1);
+}
+function codesFromString(value) {
+    const codes = [];
+    for (let i = 0; i < value.length; ++i) {
+        codes.push(value.charCodeAt(i));
+    }
+    return codes;
+}
+/**
+ * String Trim function with customizable chars
+ * @param value string to trim
+ * @param chars chars to use to trim
+ * @returns string trimmed
+ */
+function trim(value, chars = ' ') {
+    const codes = codesFromString(chars);
+    let start = 0;
+    while (start < value.length && codes.includes(value.charCodeAt(start))) {
+        ++start;
+    }
+    let end = value.length;
+    while (end > 0 && codes.includes(value.charCodeAt(end - 1))) {
+        --end;
+    }
+    return value.substring(start, end);
+}
+/**
+ * String Trim Start function with customizable chars
+ * @param value string to trim start
+ * @param chars chars to use to trim start
+ * @returns string trimmed
+ */
+function trimStart(value, chars = ' ') {
+    const codes = codesFromString(chars);
+    let i = 0;
+    while (i < value.length && codes.includes(value.charCodeAt(i))) {
+        ++i;
+    }
+    return value.substring(i);
+}
+/**
+ * String Trim End function with customizable chars
+ * @param value string to trim end
+ * @param chars chars to use to trim end
+ * @returns string trimmed
+ */
+function trimEnd(value, chars = ' ') {
+    const codes = codesFromString(chars);
+    let i = value.length;
+    while (i > 0 && codes.includes(value.charCodeAt(i - 1))) {
+        --i;
+    }
+    return value.substring(0, i);
+}var Util=/*#__PURE__*/Object.freeze({__proto__:null,EMPTY_FUNCTION:EMPTY_FUNCTION,equal:equal,fetch:fetch,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});/**
  * 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.
@@ -831,6 +892,56 @@ var Type;
 /**
  * Some connection utility functions
  */
+/**
+ * Defines the {@link Params.mediaExt} based on the type of parameters and its endpoint.
+ * This method always assigns a value to params.mediaExt, defaulting to an empty string if indeterminable,
+ * allowing detection of whether the function has been applied to the parameters.
+ * @param type The type of parameters to define.
+ * @param params The parameters for which the media extension is to be defined
+ */
+function defineMediaExt(type, params) {
+    // Fix mediaExt in removing the possible '.' prefix
+    if (params.mediaExt) {
+        params.mediaExt = trimStart(params.mediaExt, '.');
+    }
+    // Compute appropriate mediaExt out parameter
+    switch (type) {
+        case Type.HESP:
+            params.mediaExt = 'mp4';
+            break;
+        case Type.WEBRTC:
+            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 !== '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!
+                params.mediaExt = 'rts';
+            }
+            break;
+        }
+        case Type.META:
+            params.mediaExt = 'js';
+            break;
+        case Type.DATA:
+            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);
+            break;
+    }
+}
 /**
  * Build an URL from {@link Type | type} and {@link Params | params}
  * @param type Type of the connection wanted
@@ -839,10 +950,8 @@ var Type;
  * @returns The URL of connection
  */
 function buildURL(type, params, protocol = 'wss') {
+    defineMediaExt(type, params);
     const url = new URL(NetAddress.fixProtocol(protocol, params.endPoint));
-    // Remove possible extension of streamName put sometimes to decide format when multiple choices are possible like with WRTS
-    const ext = parseExtension(params.streamName);
-    params.streamName = params.streamName.substring(0, params.streamName.length - ext.length);
     if (url.pathname.length <= 1) {
         // build ceeblue path!
         switch (type) {
@@ -853,7 +962,7 @@ function buildURL(type, params, protocol = 'wss') {
                 url.pathname = '/webrtc/' + params.streamName;
                 break;
             case Type.WRTS:
-                url.pathname = '/wrts/' + params.streamName + ext;
+                url.pathname = '/wrts/' + params.streamName;
                 break;
             case Type.META:
                 url.pathname = '/json_' + params.streamName + '.js';
@@ -873,7 +982,7 @@ function buildURL(type, params, protocol = 'wss') {
         url.searchParams.set(key, params.query[key]);
     }
     return url;
-}var Connect=/*#__PURE__*/Object.freeze({__proto__:null,get Type(){return Type},buildURL:buildURL});/**
+}var Connect=/*#__PURE__*/Object.freeze({__proto__:null,get Type(){return Type},buildURL:buildURL,defineMediaExt:defineMediaExt});/**
  * 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.
@@ -1711,4 +1820,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 = '2.2.1';export{BinaryReader,BinaryWriter,BitReader,ByteRate,Connect,EventEmitter,FixMap,NetAddress,Numbers,Queue,SDP,Util,VERSION,WebSocketReliable};//# sourceMappingURL=web-utils.js.map
+const VERSION = '2.3.0';export{BinaryReader,BinaryWriter,BitReader,ByteRate,Connect,EventEmitter,FixMap,NetAddress,Numbers,Queue,SDP,Util,VERSION,WebSocketReliable};//# sourceMappingURL=web-utils.js.map