tiny-essentials 1.27.1 → 1.28.1

package/dist/v1/libs/TinyNewWinEvents.cjs

@@ -1,6 +1,9 @@
 'use strict';
 
-var TinyEvents = require('./TinyEvents.cjs');
+var events = require('events');
+var utils = require('./utils.cjs');
+
+const checkDestroy = utils.createCheckDestroyed('TinyNewWinEvents');
 
 /**
  * Stores polling intervals associated with window references.
@@ -26,195 +29,7 @@ const pollClosedInterval = new WeakMap();
  *
  * @class
  */
-class TinyNewWinEvents {
-  #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 TinyNewWinEvents extends events.EventEmitter {
   /** @type {Window|null} Reference to the opened or parent window */
   #windowRef;
 
@@ -239,11 +54,27 @@ class TinyNewWinEvents {
   /** @type {string} Internal message type for routed communication */
   #routeEventName = '__TNE_ROUTE__';
 
+  /**
+   * Tracks whether the instance has been destroyed.
+   * @type {boolean}
+   */
+  #destroyed = false;
+
+  /**
+   * Gets the current destruction status of the instance.
+   *
+   * @returns {boolean} True if the instance is destroyed, false otherwise.
+   */
+  get destroyed() {
+    return this.#destroyed;
+  }
+
   /**
    * Gets the internal handshake event name.
    * @returns {string}
    */
   get readyEventName() {
+    checkDestroy(this.#destroyed);
     return this.#readyEventName;
   }
 
@@ -253,6 +84,7 @@ class TinyNewWinEvents {
    * @throws {TypeError} If the value is not a string.
    */
   set readyEventName(name) {
+    checkDestroy(this.#destroyed);
     if (typeof name !== 'string')
       throw new TypeError('TinyNewWinEvents: readyEventName must be a string.');
     this.#readyEventName = name;
@@ -263,6 +95,7 @@ class TinyNewWinEvents {
    * @returns {string}
    */
   get routeEventName() {
+    checkDestroy(this.#destroyed);
     return this.#routeEventName;
   }
 
@@ -272,6 +105,7 @@ class TinyNewWinEvents {
    * @throws {TypeError} If the value is not a string.
    */
   set routeEventName(name) {
+    checkDestroy(this.#destroyed);
     if (typeof name !== 'string')
       throw new TypeError('TinyNewWinEvents: routeEventName must be a string.');
     this.#routeEventName = name;
@@ -291,6 +125,7 @@ class TinyNewWinEvents {
    * @throws {Error} If the window reference is invalid or already being tracked.
    */
   constructor({ targetOrigin, url, name, features } = {}) {
+    super();
     if (typeof name === 'string' && name === '_blank')
       throw new Error(
         'TinyNewWinEvents: The window name "_blank" is not supported. Please use a custom name to allow tracking.',
@@ -329,6 +164,7 @@ class TinyNewWinEvents {
    * @returns {Window|null}
    */
   getWin() {
+    checkDestroy(this.#destroyed);
     return this.#windowRef;
   }
 
@@ -350,7 +186,7 @@ class TinyNewWinEvents {
       return;
     }
 
-    if (type === this.#routeEventName) this.#events.emit(route, payload, event);
+    if (type === this.#routeEventName) this.emit(`win:${route}`, payload, event);
   }
 
   /**
@@ -363,7 +199,7 @@ class TinyNewWinEvents {
       const data = this.#pendingQueue.shift();
       if (data) {
         const { route, payload } = data;
-        this.emit(route, payload);
+        this.winEmit(route, payload);
       }
     }
   }
@@ -387,6 +223,7 @@ class TinyNewWinEvents {
    * @returns {void}
    */
   close() {
+    checkDestroy(this.#destroyed);
     if (!this.#isHost) throw new Error('Only host can close the window.');
     if (this.#windowRef && !this.#windowRef.closed) this.#windowRef.close();
   }
@@ -401,7 +238,8 @@ class TinyNewWinEvents {
    * @throws {Error} If the instance is already destroyed.
    * @returns {void}
    */
-  emit(route, payload) {
+  winEmit(route, payload) {
+    checkDestroy(this.#destroyed);
     if (typeof route !== 'string') throw new TypeError('Event name must be a string.');
     if (this.isDestroyed()) throw new Error('Cannot emit: instance has been destroyed.');
     if (!this.#ready) {
@@ -417,6 +255,7 @@ class TinyNewWinEvents {
    * @returns {boolean}
    */
   isConnected() {
+    checkDestroy(this.#destroyed);
     return this.#ready && this.#windowRef && !this.#windowRef.closed ? true : false;
   }
 
@@ -429,7 +268,7 @@ class TinyNewWinEvents {
     if (!this.#windowRef || this.#pollClosedInterval) return;
     this.#pollClosedInterval = setInterval(() => {
       if (this.#windowRef?.closed) {
-        this.#events.emit('WINDOW_REF_CLOSED');
+        this.emit('WINDOW_REF_CLOSED');
         this.destroy();
       }
     }, 500);
@@ -443,7 +282,8 @@ class TinyNewWinEvents {
    * @returns {void}
    */
   onClose(callback) {
-    return this.#events.on('WINDOW_REF_CLOSED', callback);
+    checkDestroy(this.#destroyed);
+    this.on('WINDOW_REF_CLOSED', callback);
   }
 
   /**
@@ -453,7 +293,8 @@ class TinyNewWinEvents {
    * @returns {void}
    */
   offClose(callback) {
-    return this.#events.off('WINDOW_REF_CLOSED', callback);
+    checkDestroy(this.#destroyed);
+    this.off('WINDOW_REF_CLOSED', callback);
   }
 
   /**
@@ -481,7 +322,8 @@ class TinyNewWinEvents {
     this.#pendingQueue = [];
     this.#ready = false;
     this.#windowRef = null;
-    this.#events.offAllTypes();
+    this.removeAllListeners();
+    this.#destroyed = true;
   }
 }
 

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

@@ -18,7 +18,7 @@ export type handler = (payload: any, event: MessageEvent<any>) => any;
  *
  * @class
  */
-declare class TinyNewWinEvents {
+declare class TinyNewWinEvents extends EventEmitter<any> {
     /**
      * Initializes a TinyNewWinEvents instance for communication.
      *
@@ -39,125 +39,11 @@ declare class TinyNewWinEvents {
         features?: string | undefined;
     });
     /**
-     * Enables or disables throwing an error when the maximum number of listeners is exceeded.
+     * Gets the current destruction status of the instance.
      *
-     * @param {boolean} shouldThrow - If true, an error will be thrown when the max is exceeded.
+     * @returns {boolean} True if the instance is destroyed, false otherwise.
      */
-    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 destroyed(): boolean;
     /**
      * Sets the internal handshake event name.
      * @param {string} name
@@ -203,7 +89,7 @@ declare class TinyNewWinEvents {
      * @throws {Error} If the instance is already destroyed.
      * @returns {void}
      */
-    emit(route: string, payload: any): void;
+    winEmit(route: string, payload: any): void;
     /**
      * Checks if the connection is active and the window is still open.
      *
@@ -238,4 +124,5 @@ declare class TinyNewWinEvents {
     destroy(): void;
     #private;
 }
+import { EventEmitter } from 'events';
 //# sourceMappingURL=TinyNewWinEvents.d.mts.map