tiny-essentials 1.27.1 → 1.28.1

package/dist/v1/libs/TinyIframeEvents.cjs

@@ -1,7 +1,10 @@
 'use strict';
 
+var events = require('events');
 var objChecker = require('../basics/objChecker.cjs');
-var TinyEvents = require('./TinyEvents.cjs');
+var utils = require('./utils.cjs');
+
+const checkDestroy = utils.createCheckDestroyed('TinyIframeEvents');
 
 /** @type {WeakMap<Window, TinyIframeEvents>} */
 const instances = new WeakMap();
@@ -46,199 +49,12 @@ const instances = new WeakMap();
  * - Queue management for messages sent before the connection is established.
  * - Auto-reconnects and resets ports if the target iframe is reloaded.
  */
-class TinyIframeEvents {
-  #events = new TinyEvents();
-
-  /**
-   * Enables or disables throwing an error when the maximum number of listeners is exceeded.
-   *
-   * @param {boolean} shouldThrow - If true, an error will be thrown when the max is exceeded.
-   */
-  setThrowOnMaxListeners(shouldThrow) {
-    return this.#events.setThrowOnMaxListeners(shouldThrow);
-  }
-
-  /**
-   * Checks whether an error will be thrown when the max listener limit is exceeded.
-   *
-   * @returns {boolean} True if an error will be thrown, false if only a warning is shown.
-   */
-  getThrowOnMaxListeners() {
-    return this.#events.getThrowOnMaxListeners();
-  }
-
-  /////////////////////////////////////////////////////////////
-
-  /**
-   * Adds a listener to the beginning of the listeners array for the specified event.
-   *
-   * @param {string|string[]} event - Event name.
-   * @param {handler} handler - The callback function.
-   */
-  prependListener(event, handler) {
-    return this.#events.prependListener(event, handler);
-  }
-
-  /**
-   * Adds a one-time listener to the beginning of the listeners array for the specified event.
-   *
-   * @param {string|string[]} event - Event name.
-   * @param {handler} handler - The callback function.
-   * @returns {handler[]} - The wrapped handler used internally.
-   */
-  prependListenerOnce(event, handler) {
-    return this.#events.prependListenerOnce(event, handler);
-  }
-
-  //////////////////////////////////////////////////////////////////////
-
-  /**
-   * Adds a event listener.
-   *
-   * @param {string|string[]} event - Event name, such as 'onScrollBoundary' or 'onAutoScroll'.
-   * @param {handler} handler - Callback function to be called when event fires.
-   */
-  appendListener(event, handler) {
-    return this.#events.appendListener(event, handler);
-  }
-
-  /**
-   * Registers an event listener that runs only once, then is removed.
-   *
-   * @param {string|string[]} event - Event name, such as 'onScrollBoundary' or 'onAutoScroll'.
-   * @param {handler} handler - The callback function to run on event.
-   * @returns {handler[]} - The wrapped version of the handler.
-   */
-  appendListenerOnce(event, handler) {
-    return this.#events.appendListenerOnce(event, handler);
-  }
-
-  /**
-   * Adds a event listener.
-   *
-   * @param {string|string[]} event - Event name, such as 'onScrollBoundary' or 'onAutoScroll'.
-   * @param {handler} handler - Callback function to be called when event fires.
-   */
-  on(event, handler) {
-    return this.#events.on(event, handler);
-  }
-
-  /**
-   * Registers an event listener that runs only once, then is removed.
-   *
-   * @param {string|string[]} event - Event name, such as 'onScrollBoundary' or 'onAutoScroll'.
-   * @param {handler} handler - The callback function to run on event.
-   * @returns {handler[]} - The wrapped version of the handler.
-   */
-  once(event, handler) {
-    return this.#events.once(event, handler);
-  }
-
-  ////////////////////////////////////////////////////////////////////
-
-  /**
-   * Removes a previously registered event listener.
-   *
-   * @param {string|string[]} event - The name of the event to remove the handler from.
-   * @param {handler} handler - The specific callback function to remove.
-   */
-  off(event, handler) {
-    return this.#events.off(event, handler);
-  }
-
-  /**
-   * Removes all event listeners of a specific type from the element.
-   *
-   * @param {string|string[]} event - The event type to remove (e.g. 'onScrollBoundary').
-   */
-  offAll(event) {
-    return this.#events.offAll(event);
-  }
-
-  /**
-   * Removes all event listeners of all types from the element.
-   */
-  offAllTypes() {
-    return this.#events.offAllTypes();
-  }
-
-  ////////////////////////////////////////////////////////////
-
-  /**
-   * Returns the number of listeners for a given event.
-   *
-   * @param {string} event - The name of the event.
-   * @returns {number} Number of listeners for the event.
-   */
-  listenerCount(event) {
-    return this.#events.listenerCount(event);
-  }
-
-  /**
-   * Returns a copy of the array of listeners for the specified event.
-   *
-   * @param {string} event - The name of the event.
-   * @returns {handler[]} Array of listener functions.
-   */
-  listeners(event) {
-    return this.#events.listeners(event);
-  }
-
-  /**
-   * Returns a copy of the array of listeners for the specified event.
-   *
-   * @param {string} event - The name of the event.
-   * @returns {handler[]} Array of listener functions.
-   */
-  onceListeners(event) {
-    return this.#events.onceListeners(event);
-  }
-
-  /**
-   * Returns a copy of the internal listeners array for the specified event,
-   * including wrapper functions like those used by `.once()`.
-   * @param {string | symbol} event - The event name.
-   * @returns {handler[]} An array of raw listener functions.
-   */
-  allListeners(event) {
-    return this.#events.allListeners(event);
-  }
-
-  /**
-   * Returns an array of event names for which there are registered listeners.
-   *
-   * @returns {string[]} Array of registered event names.
-   */
-  eventNames() {
-    return this.#events.eventNames();
-  }
-
-  //////////////////////////////////////////////////////
-
-  /**
-   * Sets the maximum number of listeners per event before a warning is shown.
-   *
-   * @param {number} n - The maximum number of listeners.
-   */
-  setMaxListeners(n) {
-    return this.#events.setMaxListeners(n);
-  }
-
-  /**
-   * Gets the maximum number of listeners allowed per event.
-   *
-   * @returns {number} The maximum number of listeners.
-   */
-  getMaxListeners() {
-    return this.#events.getMaxListeners();
-  }
-
-  ///////////////////////////////////////////////////
-
+class TinyIframeEvents extends events.EventEmitter {
   /** @type {Window} */
   #targetWindow;
 
   get targetWindow() {
+    checkDestroy(this.#isDestroyed);
     return this.#targetWindow;
   }
 
@@ -246,6 +62,7 @@ class TinyIframeEvents {
   #targetIframeElement;
 
   get targetIframeElement() {
+    checkDestroy(this.#isDestroyed);
     return this.#targetIframeElement;
   }
 
@@ -253,6 +70,7 @@ class TinyIframeEvents {
   #targetOrigin;
 
   get targetOrigin() {
+    checkDestroy(this.#isDestroyed);
     return this.#targetOrigin;
   }
 
@@ -260,6 +78,7 @@ class TinyIframeEvents {
   #selfType;
 
   get selfType() {
+    checkDestroy(this.#isDestroyed);
     return this.#selfType;
   }
 
@@ -270,6 +89,7 @@ class TinyIframeEvents {
   #ready = false;
 
   get ready() {
+    checkDestroy(this.#isDestroyed);
     return this.#ready;
   }
 
@@ -280,10 +100,11 @@ class TinyIframeEvents {
    * @param {function(): void} handler - The callback function to execute.
    */
   onReady(handler) {
+    checkDestroy(this.#isDestroyed);
     if (this.#ready) {
       handler();
     } else {
-      this.#events.once(this.#readyEventName, handler);
+      this.once(this.#readyEventName, handler);
     }
   }
 
@@ -318,6 +139,7 @@ class TinyIframeEvents {
     handshakeEventName = '__tinyIframeHandshake__',
     readyEventName = '__tinyIframeReady__',
   } = {}) {
+    super();
     if (
       targetIframe !== undefined &&
       (!(targetIframe instanceof HTMLIFrameElement) || !targetIframe.contentWindow)
@@ -355,6 +177,7 @@ class TinyIframeEvents {
    * @returns {string}
    */
   get secretEventName() {
+    checkDestroy(this.#isDestroyed);
     return this.#secretEventName;
   }
 
@@ -364,6 +187,7 @@ class TinyIframeEvents {
    * @throws {TypeError} If the value is not a string.
    */
   set secretEventName(name) {
+    checkDestroy(this.#isDestroyed);
     if (typeof name !== 'string')
       throw new TypeError('TinyIframeEvents: secretEventName must be a string.');
     this.#secretEventName = name;
@@ -374,6 +198,7 @@ class TinyIframeEvents {
    * @returns {string}
    */
   get handshakeEventName() {
+    checkDestroy(this.#isDestroyed);
     return this.#handshakeEventName;
   }
 
@@ -383,6 +208,7 @@ class TinyIframeEvents {
    * @throws {TypeError} If the value is not a string.
    */
   set handshakeEventName(name) {
+    checkDestroy(this.#isDestroyed);
     if (typeof name !== 'string')
       throw new TypeError('TinyIframeEvents: handshakeEventName must be a string.');
     this.#handshakeEventName = name;
@@ -393,6 +219,7 @@ class TinyIframeEvents {
    * @returns {string}
    */
   get readyEventName() {
+    checkDestroy(this.#isDestroyed);
     return this.#readyEventName;
   }
 
@@ -402,6 +229,7 @@ class TinyIframeEvents {
    * @throws {TypeError} If the value is not a string.
    */
   set readyEventName(name) {
+    checkDestroy(this.#isDestroyed);
     if (typeof name !== 'string')
       throw new TypeError('TinyIframeEvents: readyEventName must be a string.');
     this.#readyEventName = name;
@@ -489,7 +317,7 @@ class TinyIframeEvents {
       return;
     }
 
-    this.#events.emit(eventName, payload, event);
+    this.emit(`win:${eventName}`, payload, event);
   }
 
   /**
@@ -500,7 +328,7 @@ class TinyIframeEvents {
     if (this.#ready) return;
     this.#ready = true;
     this.#flushQueue();
-    this.#events.emit(this.#readyEventName);
+    this.emit(this.#readyEventName);
   }
 
   /**
@@ -525,7 +353,8 @@ class TinyIframeEvents {
    * @throws {TypeError} If `eventName` is not a string.
    * @throws {Error} If instance has been destroyed.
    */
-  emit(eventName, payload) {
+  winEmit(eventName, payload) {
+    checkDestroy(this.#isDestroyed);
     if (typeof eventName !== 'string') throw new TypeError('Event name must be a string.');
     if (this.#isDestroyed) throw new Error('Cannot emit: instance has been destroyed.');
 
@@ -559,7 +388,7 @@ class TinyIframeEvents {
    * Call this when the instance is no longer needed to prevent memory leaks.
    */
   destroy() {
-    this.#isDestroyed = true;
+    if (this.#isDestroyed) return;
     this.#ready = false;
 
     window.removeEventListener('message', this._boundWindowMessage);
@@ -573,9 +402,10 @@ class TinyIframeEvents {
       this.#port = null;
     }
 
-    this.#events.offAllTypes();
+    this.removeAllListeners();
     this.#pendingQueue = [];
     instances.delete(this.#targetWindow);
+    this.#isDestroyed = true;
   }
 }
 

package/dist/v1/libs/TinyIframeEvents.d.mts

@@ -86,7 +86,7 @@ export type IframeEventBase = {
  * - Queue management for messages sent before the connection is established.
  * - Auto-reconnects and resets ports if the target iframe is reloaded.
  */
-declare class TinyIframeEvents {
+declare class TinyIframeEvents extends EventEmitter<any> {
     /**
      * Creates a new TinyIframeEvents instance to manage secure communication.
      * Automatically establishes a MessageChannel connection between contexts.
@@ -94,126 +94,6 @@ declare class TinyIframeEvents {
      * @param {TinyIframeEventsConfig} config - Configuration object.
      */
     constructor({ targetIframe, targetOrigin, secretEventName, handshakeEventName, readyEventName, }?: TinyIframeEventsConfig);
-    /**
-     * Enables or disables throwing an error when the maximum number of listeners is exceeded.
-     *
-     * @param {boolean} shouldThrow - If true, an error will be thrown when the max is exceeded.
-     */
-    setThrowOnMaxListeners(shouldThrow: boolean): void;
-    /**
-     * Checks whether an error will be thrown when the max listener limit is exceeded.
-     *
-     * @returns {boolean} True if an error will be thrown, false if only a warning is shown.
-     */
-    getThrowOnMaxListeners(): boolean;
-    /**
-     * Adds a listener to the beginning of the listeners array for the specified event.
-     *
-     * @param {string|string[]} event - Event name.
-     * @param {handler} handler - The callback function.
-     */
-    prependListener(event: string | string[], handler: handler): void;
-    /**
-     * Adds a one-time listener to the beginning of the listeners array for the specified event.
-     *
-     * @param {string|string[]} event - Event name.
-     * @param {handler} handler - The callback function.
-     * @returns {handler[]} - The wrapped handler used internally.
-     */
-    prependListenerOnce(event: string | string[], handler: handler): handler[];
-    /**
-     * Adds a event listener.
-     *
-     * @param {string|string[]} event - Event name, such as 'onScrollBoundary' or 'onAutoScroll'.
-     * @param {handler} handler - Callback function to be called when event fires.
-     */
-    appendListener(event: string | string[], handler: handler): void;
-    /**
-     * Registers an event listener that runs only once, then is removed.
-     *
-     * @param {string|string[]} event - Event name, such as 'onScrollBoundary' or 'onAutoScroll'.
-     * @param {handler} handler - The callback function to run on event.
-     * @returns {handler[]} - The wrapped version of the handler.
-     */
-    appendListenerOnce(event: string | string[], handler: handler): handler[];
-    /**
-     * Adds a event listener.
-     *
-     * @param {string|string[]} event - Event name, such as 'onScrollBoundary' or 'onAutoScroll'.
-     * @param {handler} handler - Callback function to be called when event fires.
-     */
-    on(event: string | string[], handler: handler): void;
-    /**
-     * Registers an event listener that runs only once, then is removed.
-     *
-     * @param {string|string[]} event - Event name, such as 'onScrollBoundary' or 'onAutoScroll'.
-     * @param {handler} handler - The callback function to run on event.
-     * @returns {handler[]} - The wrapped version of the handler.
-     */
-    once(event: string | string[], handler: handler): handler[];
-    /**
-     * Removes a previously registered event listener.
-     *
-     * @param {string|string[]} event - The name of the event to remove the handler from.
-     * @param {handler} handler - The specific callback function to remove.
-     */
-    off(event: string | string[], handler: handler): void;
-    /**
-     * Removes all event listeners of a specific type from the element.
-     *
-     * @param {string|string[]} event - The event type to remove (e.g. 'onScrollBoundary').
-     */
-    offAll(event: string | string[]): void;
-    /**
-     * Removes all event listeners of all types from the element.
-     */
-    offAllTypes(): void;
-    /**
-     * Returns the number of listeners for a given event.
-     *
-     * @param {string} event - The name of the event.
-     * @returns {number} Number of listeners for the event.
-     */
-    listenerCount(event: string): number;
-    /**
-     * Returns a copy of the array of listeners for the specified event.
-     *
-     * @param {string} event - The name of the event.
-     * @returns {handler[]} Array of listener functions.
-     */
-    listeners(event: string): handler[];
-    /**
-     * Returns a copy of the array of listeners for the specified event.
-     *
-     * @param {string} event - The name of the event.
-     * @returns {handler[]} Array of listener functions.
-     */
-    onceListeners(event: string): handler[];
-    /**
-     * Returns a copy of the internal listeners array for the specified event,
-     * including wrapper functions like those used by `.once()`.
-     * @param {string | symbol} event - The event name.
-     * @returns {handler[]} An array of raw listener functions.
-     */
-    allListeners(event: string | symbol): handler[];
-    /**
-     * Returns an array of event names for which there are registered listeners.
-     *
-     * @returns {string[]} Array of registered event names.
-     */
-    eventNames(): string[];
-    /**
-     * Sets the maximum number of listeners per event before a warning is shown.
-     *
-     * @param {number} n - The maximum number of listeners.
-     */
-    setMaxListeners(n: number): void;
-    /**
-     * Gets the maximum number of listeners allowed per event.
-     *
-     * @returns {number} The maximum number of listeners.
-     */
-    getMaxListeners(): number;
     get targetWindow(): Window;
     get targetIframeElement(): HTMLIFrameElement | undefined;
     get targetOrigin(): string;
@@ -269,7 +149,7 @@ declare class TinyIframeEvents {
      * @throws {TypeError} If `eventName` is not a string.
      * @throws {Error} If instance has been destroyed.
      */
-    emit(eventName: string, payload: any): void;
+    winEmit(eventName: string, payload: any): void;
     /**
      * Checks if the communication instance has been destroyed.
      *
@@ -283,4 +163,5 @@ declare class TinyIframeEvents {
     destroy(): void;
     #private;
 }
+import { EventEmitter } from 'events';
 //# sourceMappingURL=TinyIframeEvents.d.mts.map