@js-toolkit/web-utils 1.47.0

package/webrtc/PeerConnection.js

@@ -0,0 +1 @@
+import{__awaiter}from"tslib";import DataEventEmitter,{}from"@jstoolkit/utils/DataEventEmitter";import getErrorMessage from"@jstoolkit/utils/getErrorMessage";import{hasIn}from"@jstoolkit/utils/hasIn";import*as sdpUtils from"./sdputils";export class PeerConnection extends DataEventEmitter{get Events(){return PeerConnection.Events}constructor(e={}){var t;super(),this.options=e,this.logger=null!==(t=e.logger)&&void 0!==t?t:console,this.pc=this.createPC()}clear(){this.pc.onsignalingstatechange=null,this.pc.onconnectionstatechange=null,this.pc.oniceconnectionstatechange=null,this.pc.ontrack=null,this.pc.onnegotiationneeded=null,this.pc.onicecandidate=null,this.pc.onicecandidateerror=null}createPC(){const e=new RTCPeerConnection(this.options.rtc);return e.onsignalingstatechange=()=>{this.logger.debug(`Signaling state changed to: ${e.signalingState}`),"closed"===e.signalingState&&(this.emit(this.Events.Closed),this.clear())},hasIn(RTCPeerConnection.prototype,"onconnectionstatechange")?e.onconnectionstatechange=()=>{this.logger.debug(`Connection state changed to: ${e.connectionState}`),"connected"===e.connectionState?this.emit(this.Events.Connected):"disconnected"===e.connectionState&&this.emit(this.Events.Disconnected)}:e.oniceconnectionstatechange=()=>{this.logger.debug(`ICE connection state changed to: ${e.iceConnectionState}`),"connected"===e.iceConnectionState?this.emit(this.Events.Connected):"disconnected"===e.iceConnectionState&&this.emit(this.Events.Disconnected)},e.ontrack=({streams:e,track:t})=>{if(this.logger.debug("Remote stream received.",e.length,t.kind),0===e.length)return;const[n]=e;n.onremovetrack=()=>{this.logger.debug("onremovetrack"),this.emit(this.Events.RemoteStreamChanged,n)},n.onaddtrack=()=>{this.logger.debug("onaddtrack"),this.emit(this.Events.RemoteStreamChanged,n)},this.emit(this.Events.RemoteStreamChanged,n)},e.onnegotiationneeded=()=>{const{iceConnectionState:t}=e;"connected"!==t&&"completed"!==t||(this.logger.debug("Reinitializing connection..."),this.emit(this.Events.ReinitializingConnectionRequired))},e.onicecandidate=({candidate:e})=>{e?sdpUtils.isValidIceCandidate(e)&&this.emit(this.Events.LocalIceCandidate,e):this.emit(this.Events.EndOfIceCandidates)},e.onicecandidateerror=e=>{if(e instanceof RTCPeerConnectionIceErrorEvent){const{errorCode:t,errorText:n,hostCandidate:i,url:o}=e;this.logger.warn(`ICE candidate error: errorCode=${t}, errorText=${n}, hostCandidate=${i}, url=${o}`)}else this.logger.warn(`ICE candidate error: ${getErrorMessage(e)}`)},e}setLocalDescription(e,t){return __awaiter(this,void 0,void 0,(function*(){const n=sdpUtils.prepareLocalDescription(t,this.options.codecs);return yield e.setLocalDescription(n),n}))}setRemoteDescription(e,t){return __awaiter(this,void 0,void 0,(function*(){const n=sdpUtils.prepareRemoteDescription(t,this.options.codecs);return yield e.setRemoteDescription(n),n}))}isConnected(){return"connected"===this.pc.iceConnectionState||"completed"===this.pc.iceConnectionState}isClosed(){return"closed"===this.pc.signalingState}addIceCandidate(e){return this.pc.addIceCandidate(e)}attachStream(e){const t=this.pc.getSenders(),n=t.length?e.getTracks().filter((e=>!t.find((({track:t})=>!!t&&t.id===e.id)))):e.getTracks();n.length?(n.forEach((t=>this.pc.addTrack(t,e))),this.logger.debug(`Attached ${n.length} track(s) to a peer connection.`)):this.logger.debug("No tracks to attach to a peer connection.")}reattachStream(e){const t=this.pc.iceConnectionState;if("new"!==t&&"connected"!==t&&"completed"!==t)return;const n=e?e.getTracks():[];this.pc.getSenders().forEach((e=>{const{track:t}=e;!t||"ended"!==t.readyState&&n.find((e=>e.id===t.id))||(this.pc.removeTrack(e),this.logger.debug(`'${t&&t.kind}' track is removed from a peer connection.`))})),e&&this.attachStream(e)}createOffer(){return __awaiter(this,void 0,void 0,(function*(){const e=yield this.pc.createOffer(this.options.offerOptions);return this.setLocalDescription(this.pc,e)}))}createAnswer(e){return __awaiter(this,void 0,void 0,(function*(){yield this.setRemoteDescription(this.pc,e);const t=yield this.pc.createAnswer(this.options.offerOptions);return this.setLocalDescription(this.pc,t)}))}applyAnswer(e){return this.setRemoteDescription(this.pc,e)}reconnect(){this.close(),this.pc=this.createPC()}close(){this.pc.close(),this.pc.onsignalingstatechange&&(this.emit(this.Events.Closed),this.clear())}destroy(){this.close(),this.removeAllListeners()}}!function(e){let t;!function(e){e.LocalIceCandidate="LocalIceCandidate",e.EndOfIceCandidates="EndOfIceCandidates",e.Connected="Connected",e.Disconnected="Disconnected",e.RemoteStreamChanged="RemoteStreamChanged",e.ReinitializingConnectionRequired="ReinitializingConnectionRequired",e.Closed="Closed"}(t=e.Events||(e.Events={}))}(PeerConnection||(PeerConnection={}));

package/webrtc/sdputils.d.ts

@@ -0,0 +1,20 @@
+export interface PreferCodecs {
+    videoRecvCodec?: string;
+    videoSendCodec?: string;
+    audioRecvCodec?: string;
+    audioSendCodec?: string;
+    opusStereo?: string;
+    opusFec?: string;
+    opusDtx?: string;
+    opusMaxPbr?: string;
+    videoSendInitialBitrate?: string;
+    videoSendBitrate?: string;
+    videoRecvBitrate?: string;
+    audioSendBitrate?: string;
+    audioRecvBitrate?: string;
+    videoFec?: string;
+}
+export declare function trace(text: string): void;
+export declare function isValidIceCandidate({ candidate }: RTCIceCandidate, config?: RTCConfiguration): boolean;
+export declare function prepareLocalDescription(desc: RTCSessionDescriptionInit, preferCodecs?: PreferCodecs): RTCSessionDescriptionInit;
+export declare function prepareRemoteDescription(desc: RTCSessionDescriptionInit, preferCodecs?: PreferCodecs): RTCSessionDescriptionInit;

package/webrtc/sdputils.js

@@ -0,0 +1 @@
+export function trace(e){if(e.endsWith("\n")&&(e=e.substring(0,e.length-1)),window.performance){const t=(window.performance.now()/1e3).toFixed(3);console.log(`${t}: ${e}`)}else console.log(e)}function iceCandidateType(e){return e.split(" ")[7]}export function isValidIceCandidate({candidate:e},t){return!(!e||e.includes("tcp"))&&(!t||"relay"!==t.iceTransportPolicy||"relay"===iceCandidateType(e))}function maybeSetOpusOptions(e,t){return"true"===t.opusStereo?e=setCodecParam(e,"opus/48000","stereo","1"):"false"===t.opusStereo&&(e=removeCodecParam(e,"opus/48000","stereo")),"true"===t.opusFec?e=setCodecParam(e,"opus/48000","useinbandfec","1"):"false"===t.opusFec&&(e=removeCodecParam(e,"opus/48000","useinbandfec")),"true"===t.opusDtx?e=setCodecParam(e,"opus/48000","usedtx","1"):"false"===t.opusDtx&&(e=removeCodecParam(e,"opus/48000","usedtx")),t.opusMaxPbr&&(e=setCodecParam(e,"opus/48000","maxplaybackrate",t.opusMaxPbr)),e}function maybeSetAudioSendBitRate(e,t){return t.audioSendBitrate?(trace(`Prefer audio send bitrate: ${t.audioSendBitrate}`),preferBitRate(e,t.audioSendBitrate,"audio")):e}function maybeSetAudioReceiveBitRate(e,t){return t.audioRecvBitrate?(trace(`Prefer audio receive bitrate: ${t.audioRecvBitrate}`),preferBitRate(e,t.audioRecvBitrate,"audio")):e}function maybeSetVideoSendBitRate(e,t){return t.videoSendBitrate?(trace(`Prefer video send bitrate: ${t.videoSendBitrate}`),preferBitRate(e,t.videoSendBitrate,"video")):e}function maybeSetVideoReceiveBitRate(e,t){return t.videoRecvBitrate?(trace(`Prefer video receive bitrate: ${t.videoRecvBitrate}`),preferBitRate(e,t.videoRecvBitrate,"video")):e}function preferBitRate(e,t,n){const i=e.split("\r\n"),o=findLine(i,"m=",n);if(-1===o)return trace("Failed to add bandwidth line to sdp, as no m-line found"),e;let r=findLineInRange(i,o+1,-1,"m=");-1===r&&(r=i.length);const a=findLineInRange(i,o+1,r,"c=");if(-1===a)return trace("Failed to add bandwidth line to sdp, as no c-line found"),e;const d=findLineInRange(i,a+1,r,"b=AS");d>=0&&i.splice(d,1);const c=`b=AS:${t}`;return i.splice(a+1,0,c),e=i.join("\r\n")}function maybeSetVideoSendInitialBitRate(e,t){let n=t.videoSendInitialBitrate;if(!n)return e;let i=n;const o=t.videoSendBitrate;o&&(n>o&&(trace(`Clamping initial bitrate to max bitrate of ${o} kbps.`),n=o,t.videoSendInitialBitrate=n),i=o);if(-1===findLine(e.split("\r\n"),"m=","video"))return trace("Failed to find video m-line"),e;const r=t.videoRecvCodec||"";return e=setCodecParam(e,r,"x-google-min-bitrate",t.videoSendInitialBitrate||""),e=setCodecParam(e,r,"x-google-max-bitrate",i.toString())}function removePayloadTypeFromMline(e,t){const n=e.split(" ");for(let e=0;e<n.length;++e)n[e]===t.toString()&&n.splice(e,1);return n.join(" ")}function removeCodecByName(e,t){const n=findLine(e,"a=rtpmap",t);if(-1===n)return e;const i=getCodecPayloadTypeFromLine(e[n]);e.splice(n,1);const o=findLine(e,"m=","video");return-1===o||(e[o]=removePayloadTypeFromMline(e[o],i)),e}function removeCodecByPayloadType(e,t){const n=findLine(e,"a=rtpmap",t.toString());if(-1===n)return e;e.splice(n,1);const i=findLine(e,"m=","video");return-1===i||(e[i]=removePayloadTypeFromMline(e[i],t)),e}function maybeRemoveVideoFec(e,t){if("false"!==t.videoFec)return e;let n=e.split("\r\n"),i=findLine(n,"a=rtpmap","red");if(-1===i)return e;const o=getCodecPayloadTypeFromLine(n[i]);if(n=removeCodecByPayloadType(n,o),n=removeCodecByName(n,"ulpfec"),i=findLine(n,"a=fmtp",o.toString()),-1===i)return e;const r=parseFmtpLine(n[i]).pt;return null==r?e:(n.splice(i,1),n=removeCodecByPayloadType(n,r),n.join("\r\n"))}function maybePreferAudioSendCodec(e,t){return maybePreferCodec(e,"audio","send",t.audioSendCodec)}function maybePreferAudioReceiveCodec(e,t){return maybePreferCodec(e,"audio","receive",t.audioRecvCodec)}function maybePreferVideoSendCodec(e,t){return maybePreferCodec(e,"video","send",t.videoSendCodec)}function maybePreferVideoReceiveCodec(e,t){return maybePreferCodec(e,"video","receive",t.videoRecvCodec)}function maybePreferCodec(e,t,n,i){if(!i)return e;const o=e.split("\r\n"),r=findLine(o,"m=",t);if(-1===r)return e;const a=getCodecPayloadType(o,i);return a&&(o[r]=setDefaultCodec(o[r],a)),e=o.join("\r\n")}function setCodecParam(e,t,n,i){const o=e.split("\r\n"),r=findFmtpLine(o,t);if(null===r){const r=findLine(o,"a=rtpmap",t);if(-1===r)return e;const a={pt:getCodecPayloadTypeFromLine(o[r]).toString(),params:{[n]:i}};o.splice(r+1,0,writeFmtpLine(a))}else{const e=parseFmtpLine(o[r]);e.params[n]=i,o[r]=writeFmtpLine(e)}return e=o.join("\r\n")}function removeCodecParam(e,t,n){const i=e.split("\r\n"),o=findFmtpLine(i,t);if(null===o)return e;const r=parseFmtpLine(i[o]);if(r){delete r.params[n];const e=writeFmtpLine(r);null===e?i.splice(o,1):i[o]=e}return e=i.join("\r\n")}function parseFmtpLine(e){const t={},n=e.indexOf(" "),i=e.substring(n+1).split("; "),o=/a=fmtp:(\d+)/.exec(e);o&&2===o.length&&(t.pt=o[1]);const r={};return i.forEach((e=>{const t=e.split("=");2===t.length&&(r[t[0]]=t[1])})),t.params=r,t}function writeFmtpLine(e){if(!e.hasOwnProperty("pt")||!e.hasOwnProperty("params"))return"";const{pt:t="",params:n={}}=e,i=Object.entries(n).map((([e,t])=>`${e}=${t}`));return 0===i.length?"":`a=fmtp:${t.toString()} ${i.join("; ")}`}function findFmtpLine(e,t){const n=getCodecPayloadType(e,t);return n?findLine(e,`a=fmtp:${n.toString()}`):null}function findLine(e,t,n){return findLineInRange(e,0,-1,t,n)}function findLineInRange(e,t,n,i,o){const r=-1!==n?n:e.length;for(let n=t;n<r;++n)if(e[n].startsWith(i)&&(!o||e[n].toLowerCase().includes(o.toLowerCase())))return n;return-1}function getCodecPayloadType(e,t){const n=findLine(e,"a=rtpmap",t);return n>=0?getCodecPayloadTypeFromLine(e[n]):null}function getCodecPayloadTypeFromLine(e){const t=/a=rtpmap:(\d+) [a-zA-Z0-9-]+\/\d+/.exec(e);return t&&2===t.length?t[1]:""}function setDefaultCodec(e,t){const n=e.split(" "),i=n.slice(0,3);i.push(t);for(let e=3;e<n.length;e++)n[e]!==t&&i.push(n[e]);return i.join(" ")}export function prepareLocalDescription(e,t={}){let n=maybePreferAudioReceiveCodec(e.sdp||"",t);n=maybePreferVideoReceiveCodec(n,t),n=maybeSetAudioReceiveBitRate(n,t),n=maybeSetVideoReceiveBitRate(n,t),n=maybeRemoveVideoFec(n,t);return{sdp:n,type:e.type}}export function prepareRemoteDescription(e,t={}){let n=maybeSetOpusOptions(e.sdp||"",t);n=maybePreferAudioSendCodec(n,t),n=maybePreferVideoSendCodec(n,t),n=maybeSetAudioSendBitRate(n,t),n=maybeSetVideoSendBitRate(n,t),n=maybeSetVideoSendInitialBitRate(n,t),n=maybeRemoveVideoFec(n,t);return{sdp:n,type:e.type}}

package/ws/WSController.d.ts

@@ -0,0 +1,50 @@
+import ReconnectingWebSocket, { type ErrorEvent, type Message, type Options as BaseOptions, type UrlProvider } from 'reconnecting-websocket';
+import DataEventEmitter, { type DataEventListener, type DataEventMap } from '@jstoolkit/utils/DataEventEmitter';
+export declare class WSController<TData = unknown> extends DataEventEmitter<WSController.EventMap<TData>, WSController<TData>> {
+    get Events(): typeof WSController.Events;
+    readonly logger: NonNullable<WSController.Options['logger']>;
+    protected readonly ws: ReconnectingWebSocket;
+    private readonly listener;
+    private readonly reconnectOnIdle;
+    private readonly halfOpen;
+    constructor(url: UrlProvider, options?: WSController.Options | undefined);
+    isConnected(): boolean;
+    getUrl(): string;
+    connect(): void;
+    send(data: Message): void;
+    close(code?: number | undefined, reason?: string | undefined): void;
+    destroy(): void;
+}
+export declare namespace WSController {
+    interface Options extends OptionalToUndefined<BaseOptions & Partial<Pick<WebSocket, 'binaryType'>>> {
+        readonly protocols?: ConstructorParameters<typeof ReconnectingWebSocket>['1'] | undefined;
+        /** Reconnecting after an idle timeout (no message events). Default 30_000. */
+        readonly idleTimeout?: number | undefined;
+        readonly logger?: Pick<Console, 'warn' | 'info'> | undefined;
+        readonly halfOpenDetection?: {
+            /** Delay should be equal to the interval at which your server sends out pings plus a conservative assumption of the latency. */
+            readonly pingTimeout?: number;
+            readonly outMessage?: Message | (() => Message);
+            /** Returns `true` if inMessage is ping message. */
+            readonly inMessageFilter?: (message: unknown) => boolean;
+        };
+    }
+    enum Events {
+        Connected = "Connected",
+        Message = "Message",
+        Error = "Error",
+        /** If connection was closed and the object will not to try to reconnect */
+        Closed = "Closed"
+    }
+    type EventMap<TData = unknown> = DataEventMap<DefineAll<Events, {
+        [Events.Connected]: [];
+        [Events.Message]: [
+            event: OmitStrict<MessageEvent<TData>, keyof Event | 'initMessageEvent'>
+        ];
+        [Events.Error]: [event: Pick<ErrorEvent, 'error' | 'message'>];
+        [Events.Closed]: [{
+            readonly reason: string;
+        } | undefined];
+    }>, WSController<TData>>;
+    type EventHandler<T extends Events = Events, TData = unknown> = DataEventListener<EventMap<TData>, T, WSController<TData>>;
+}

package/ws/WSController.js

@@ -0,0 +1 @@
+import{__rest}from"tslib";import ReconnectingWebSocket,{}from"reconnecting-websocket";import DataEventEmitter,{}from"@jstoolkit/utils/DataEventEmitter";import delayed from"@jstoolkit/utils/delayed";import{EventEmitterListener}from"../EventEmitterListener";function getNotConnectedError(){return new Error("The object is not connected yet.")}export class WSController extends DataEventEmitter{get Events(){return WSController.Events}constructor(e,t){super();const n=null!=t?t:{},{logger:s,protocols:o,binaryType:i,idleTimeout:r,halfOpenDetection:c,startClosed:l}=n,a=__rest(n,["logger","protocols","binaryType","idleTimeout","halfOpenDetection","startClosed"]);this.logger=null!=s?s:console,this.ws=new ReconnectingWebSocket(e,o,Object.assign(Object.assign({},a),{startClosed:!0})),null!=i&&(this.ws.binaryType=i),this.listener=new EventEmitterListener(this.ws),r&&r>0&&(this.reconnectOnIdle=delayed((()=>{this.logger.info(`WS connection reconnecting after ${r}ms due to inactivity.`),this.ws.reconnect()}),r)),this.halfOpen=(()=>{if(!c)return;const{pingTimeout:e=12e3,outMessage:t=(()=>JSON.stringify({type:"pong"})),inMessageFilter:n=(e=>e&&"object"==typeof e&&"ping"===e.type)}=c,s=delayed((()=>{this.logger.info(`WS connection reconnecting after ${e}ms due to the probability of a half-open connection.`),this.ws.reconnect()}),e),o=()=>{s(),this.ws.send("function"!=typeof t||t instanceof Blob?t:t())};return{heartbeat:o,cancel:()=>s.cancel(),onMessage:({data:e})=>{n(e)?o():s()}}})(),this.listener.on("open",(()=>{var e;this.reconnectOnIdle&&this.reconnectOnIdle(),null===(e=this.halfOpen)||void 0===e||e.heartbeat(),this.emit(this.Events.Connected)})).on("close",(({code:e})=>{var n,s;null===(n=this.reconnectOnIdle)||void 0===n||n.cancel(),null===(s=this.halfOpen)||void 0===s||s.cancel(),null!=(null==t?void 0:t.maxRetries)&&this.ws.readyState===this.ws.CLOSED&&this.ws.retryCount===t.maxRetries&&this.close(e,`Failed to connect after ${t.maxRetries} attempts.`)})).on("message",(e=>{var t;this.reconnectOnIdle&&this.reconnectOnIdle(),null===(t=this.halfOpen)||void 0===t||t.onMessage(e),this.emit(this.Events.Message,e)})).on("error",(({error:e,message:t})=>{this.emit(this.Events.Error,{error:e,message:t})})),this.halfOpen&&(this.isConnected()||this.ws.readyState===this.ws.CONNECTING)&&this.halfOpen.heartbeat(),l||this.connect()}isConnected(){return this.ws.readyState===this.ws.OPEN}getUrl(){return this.ws.url}connect(){this.ws.reconnect()}send(e){if(!this.ws)throw getNotConnectedError();this.ws.send(e)}close(e,t){const n=!!this.ws;try{this.reconnectOnIdle&&this.reconnectOnIdle.cancel(),this.halfOpen&&this.halfOpen.cancel(),this.ws.close(e,t)}catch(e){this.logger.warn(e)}n&&this.emit(this.Events.Closed,t?{reason:t}:void 0)}destroy(){this.close(),this.listener.removeAllListeners(),this.removeAllListeners()}}!function(e){let t;!function(e){e.Connected="Connected",e.Message="Message",e.Error="Error",e.Closed="Closed"}(t=e.Events||(e.Events={}))}(WSController||(WSController={}));