@js-toolkit/web-utils 1.64.0 → 1.64.2

package/FullscreenController.d.ts

@@ -7,7 +7,7 @@ declare global {
         webkitSupportsFullscreen?: boolean | undefined;
     }
 }
-export declare class FullscreenController extends EventEmitter<FullscreenController.EventMap> implements AsyncDisposable {
+export declare class FullscreenController extends EventEmitter<FullscreenController.EventMap, FullscreenController> implements AsyncDisposable {
     private readonly element;
     private options;
     static isApiAvailable(): boolean;
@@ -44,7 +44,7 @@ export declare namespace FullscreenController {
         Change = "change",
         Error = "error"
     }
-    type EventMap = DefineAll<Events, {
+    type EventMap = EventEmitter.EventMap<DefineAll<Events, {
         [Events.Change]: [{
             fullscreen: boolean;
             type: FullscreenType;
@@ -53,7 +53,7 @@ export declare namespace FullscreenController {
             error: unknown;
             type: FullscreenType;
         }];
-    }>;
+    }>, FullscreenController>;
     type EventHandler<T extends Events = Events> = EventEmitter.EventListener<EventMap, T, FullscreenController>;
     type EventHandlerMap<T extends Events = Events> = {
         [P in T]: EventHandler<P>;

package/README.md

@@ -2,4 +2,40 @@
 
 [![npm package](https://img.shields.io/npm/v/@js-toolkit/web-utils.svg?style=flat-square)](https://www.npmjs.org/package/@js-toolkit/web-utils)
 
-Useful utils for browser environment.
+A lightweight utility library for common operations in the browser environment. This package simplifies tasks such as DOM manipulation, event handling, and other browser-related utilities.
+
+## Installation
+
+Install the library via npm:
+
+```bash
+yarn add @js-toolkit/web-utils
+# or
+npm install @js-toolkit/web-utils
+```
+
+# Usage
+
+Here’s an example of how to use the library:
+
+```ts
+import { getRandomID } from '@js-toolkit/web-utils/getRandomID';
+
+const id = getRandomID();
+```
+
+# Features
+
+- Simplifies common browser tasks
+- Lightweight and fast
+- Easy to integrate with other JavaScript projects
+
+# Contributing
+
+Contributions are welcome! Please follow these steps:
+
+1. Fork the repository.
+1. Create a new branch (git checkout -b feature/my-feature-name).
+1. Commit your changes (git commit -m 'Add some feature').
+1. Push the branch (git push origin feature/my-feature-name).
+1. Open a pull request.

package/media/resetMedia.js

@@ -1 +1 @@
-export function resetMedia(e){(e.src||e.srcObject||e.childElementCount>0)&&(URL.revokeObjectURL(e.src),e.removeAttribute("src"),e.srcObject=null,e.childElementCount>0&&Array.prototype.filter.call(e.children,(e=>e instanceof HTMLSourceElement)).forEach((r=>e.removeChild(r))),e.load())}
+export function resetMedia(e){(e.src||e.srcObject||e.childElementCount>0)&&(URL.revokeObjectURL(e.src),e.removeAttribute("src"),e.srcObject=null,e.childElementCount>0&&Array.prototype.filter.call(e.children,(e=>e instanceof HTMLSourceElement)).forEach((r=>{URL.revokeObjectURL(r.src),e.removeChild(r)})),e.load())}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@js-toolkit/web-utils",
-  "version": "1.64.0",
+  "version": "1.64.2",
   "description": "Web utils",
   "author": "VZH",
   "license": "MIT",
@@ -20,30 +20,30 @@
     "@js-toolkit/node-utils": "^1.2.1"
   },
   "devDependencies": {
-    "@eslint/compat": "^1.2.8",
+    "@eslint/compat": "^1.2.9",
     "@eslint/eslintrc": "^3.3.1",
-    "@eslint/js": "^9.25.0",
-    "@js-toolkit/configs": "^3.94.2",
+    "@eslint/js": "^9.27.0",
+    "@js-toolkit/configs": "^3.94.3",
     "@js-toolkit/utils": "^1.59.2",
     "@types/eslint": "^9.6.1",
     "@types/lodash.throttle": "^4.1.9",
     "@types/uuid": "^10.0.0",
     "copyfiles": "^2.4.1",
-    "eslint": "^9.25.0",
-    "eslint-config-prettier": "^10.1.2",
-    "eslint-import-resolver-typescript": "^4.3.3",
+    "eslint": "^9.27.0",
+    "eslint-config-prettier": "^10.1.5",
+    "eslint-import-resolver-typescript": "^4.3.5",
     "eslint-plugin-import": "^2.31.0",
-    "eslint-plugin-prettier": "^5.2.6",
+    "eslint-plugin-prettier": "^5.4.0",
     "lodash.throttle": "^4.1.1",
     "prettier": "^3.5.3",
     "reconnecting-websocket": "^4.4.0",
     "rimraf": "^6.0.1",
-    "terser": "^5.39.0",
+    "terser": "^5.39.2",
     "typescript": "^5.8.3",
-    "typescript-eslint": "^8.30.1",
+    "typescript-eslint": "^8.32.1",
     "ua-parser-js": "^2.0.3",
     "uuid": "^11.1.0",
-    "webpack": "^5.99.6",
+    "webpack": "^5.99.8",
     "yargs": "^17.7.2"
   }
 }

package/patchConsoleLogging.d.ts

@@ -0,0 +1,9 @@
+type Methods = Pick<Console, 'debug' | 'error' | 'info' | 'log' | 'trace' | 'warn'>;
+interface PatchConsoleLoggingOptions {
+    /** Defaults to 'replace'. */
+    readonly mode?: 'replace' | 'prepend' | 'append';
+}
+type CustomMethod = (level: keyof Methods, ...data: unknown[]) => void;
+export declare function restoreConsoleLogging(): void;
+export declare function patchConsoleLogging(customMethod: CustomMethod, { mode }?: PatchConsoleLoggingOptions): void;
+export {};

package/patchConsoleLogging.js

@@ -0,0 +1 @@
+const methods={debug:console.debug.bind(console),error:console.error.bind(console),info:console.info.bind(console),log:console.log.bind(console),trace:console.trace.bind(console),warn:console.warn.bind(console)};export function restoreConsoleLogging(){Object.entries(methods).forEach((([o,e])=>{console[o]=e}))}export function patchConsoleLogging(o,{mode:e="replace"}={}){restoreConsoleLogging(),Object.getOwnPropertyNames(methods).forEach((n=>{const s=n;console[s]=(...n)=>{"append"===e&&methods[s](...n),o(s,...n),"prepend"===e&&methods[s](...n)}}))}

package/webrtc/PeerConnection.d.ts

@@ -4,7 +4,7 @@ import * as sdpUtils from './sdputils';
 export declare class PeerConnection extends EventEmitter<PeerConnection.EventMap, PeerConnection> implements Disposable {
     readonly options: PeerConnection.Options;
     get Events(): typeof PeerConnection.Events;
-    readonly logger: Pick<log.Logger, "warn" | "debug">;
+    readonly logger: Pick<log.Logger, "debug" | "warn">;
     private pc;
     constructor(options?: PeerConnection.Options);
     private clear;

package/webrtc/PeerConnection.js

@@ -1 +1 @@
-import{EventEmitter}from"@js-toolkit/utils/EventEmitter";import{getErrorMessage}from"@js-toolkit/utils/getErrorMessage";import{hasIn}from"@js-toolkit/utils/hasIn";import log from"@js-toolkit/utils/log";import*as sdpUtils from"./sdputils";export class PeerConnection extends EventEmitter{options;get Events(){return PeerConnection.Events}logger;pc;constructor(e={}){super(),this.options=e,this.logger=e.logger??log.getLogger("PeerConnection"),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}async setLocalDescription(e,t){const n=sdpUtils.prepareLocalDescription(t,this.options.codecs);return await e.setLocalDescription(n),n}async setRemoteDescription(e,t){const n=sdpUtils.prepareRemoteDescription(t,this.options.codecs);return await 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)}async createOffer(){const e=await this.pc.createOffer(this.options.offerOptions);return this.setLocalDescription(this.pc,e)}async createAnswer(e){await this.setRemoteDescription(this.pc,e);const t=await 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()}[Symbol.dispose](){this.destroy()}}!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={}));
+import{EventEmitter}from"@js-toolkit/utils/EventEmitter";import{getErrorMessage}from"@js-toolkit/utils/getErrorMessage";import{hasIn}from"@js-toolkit/utils/hasIn";import log from"@js-toolkit/utils/log";import*as sdpUtils from"./sdputils";export class PeerConnection extends EventEmitter{options;get Events(){return PeerConnection.Events}logger;pc;constructor(e={}){super(),this.options=e,this.logger=e.logger??log.getLogger("PeerConnection"),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);e.onsignalingstatechange=()=>{this.logger.debug(`Signaling state changed to: ${e.signalingState}`),"closed"===e.signalingState&&(this.emit(this.Events.Closed),this.clear())};const t=e=>{this.logger.debug(`Connection state changed to: ${e}`),"connected"===e?this.emit(this.Events.Connected):"disconnected"===e&&this.emit(this.Events.Disconnected)};return hasIn(RTCPeerConnection.prototype,"onconnectionstatechange")?e.onconnectionstatechange=()=>t(e.connectionState):e.oniceconnectionstatechange=()=>t(e.iceConnectionState),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}async setLocalDescription(e,t){const n=sdpUtils.prepareLocalDescription(t,this.options.codecs);return await e.setLocalDescription(n),n}async setRemoteDescription(e,t){const n=sdpUtils.prepareRemoteDescription(t,this.options.codecs);return await 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)}async createOffer(){const e=await this.pc.createOffer(this.options.offerOptions);return this.setLocalDescription(this.pc,e)}async createAnswer(e){await this.setRemoteDescription(this.pc,e);const t=await 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()}[Symbol.dispose](){this.destroy()}}!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={}));