tiny-essentials 1.28.1 → 1.28.3

package/dist/v1/libs/TinyHtml.mjs

@@ -333,7 +333,6 @@ class TinyHtml {
      * Enables or disables debug output.
      * @param {boolean} value True to enable debug output; false to disable.
      * @throws {TypeError} Thrown if the provided value is not a boolean.
-     * @returns {void}
      */
     static set elemDebug(value) {
         if (typeof value !== 'boolean')
@@ -511,7 +510,7 @@ class TinyHtml {
      *
      * @param {string} url - The URL of the HTML file.
      * @param {RequestInit} [ops] - Optional fetch configuration (e.g., method, headers, cache, etc).
-     * @returns {Promise<TinyHtml<TinyElement|Text>[]>} A promise that resolves with the TinyHtml instances.
+     * Returns the promise that resolves with the TinyHtml instances.
      */
     static async fetchHtmlTinyElems(url, ops) {
         const nodes = await TinyHtml.fetchHtmlNodes(url, ops);
@@ -1437,7 +1436,7 @@ class TinyHtml {
      * of the input form.
      *
      * @param {TinyElement|Text|(TinyElement|Text)[]} elems - A single element or an array of elements (DOM or TinyHtml).
-     * @returns {TinyHtml<TinyElement|Text>[]} An array of TinyHtml instances corresponding to the input elements.
+     * Returns the array of TinyHtml instances corresponding to the input elements.
      */
     static toTinyElm(elems) {
         /** @param {(TinyElement|Text)[]} item */
@@ -3706,7 +3705,7 @@ class TinyHtml {
     // TITLE: Animate DOM (cssExpand)
     /**
      * CSS expansion shorthand used by genStyleFx to include margin/padding values.
-     * @typedef {['Top', 'Right', 'Bottom', 'Left']}
+     * @type {['Top', 'Right', 'Bottom', 'Left']}
      */
     static #cssExpand = ['Top', 'Right', 'Bottom', 'Left'];
     // TITLE: Animate DOM (styleEffects)

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

@@ -1,34 +1,11 @@
-export default TinyI18;
-/**
- * Supported operating modes for TinyI18.
- * - `"local"` → All translations are managed entirely in memory (browser + Node.js).
- * - `"file"` → Translations are loaded from JSON files on disk (Node.js only).
- */
 export type ModeTypes = "local" | "file";
-/**
- * Dictionary of translation keys mapped to values.
- */
 export type Dict = Record<string, any>;
-/**
- * `$pattern` - Regex string (will be compiled into RegExp).
- *
- * `$fn` - Helper function name associated with this entry.
- *
- * `[key]` - Additional key-value pairs for interpolation or extra metadata.
- */
 export type FileValue = {
     $pattern: string;
     $fn: string;
     [key: string]: string;
 };
-/**
- * Represents a valid locale code string.
- * Example: "en", "pt-BR", "fr".
- */
 export type LocaleCode = string;
-/**
- * Represents a single regex-based translation entry.
- */
 export type PatternEntry = {
     /**
      * - Compiled regular expression used for matching.
@@ -47,7 +24,7 @@ export type FileModeEntryJSON = {
     /**
      * - regex as string e.g. "^user\\.(\\d+)$"
      */
-    $pattern?: string | undefined;
+    $pattern?: string;
     /**
      * - string or { $fn: string, args?: any }
      */
@@ -63,25 +40,22 @@ export type TinyI18Options = {
     /**
      * - Required in file mode. Directory with <locale>.json
      */
-    basePath?: string | undefined;
+    basePath?: string;
     /**
      * - Optional initial map { locale: dict } for local mode
      */
-    localResources?: Dict | undefined;
+    localResources?: Dict;
     /**
      * - If true, throws on missing keys; else returns key
      */
-    strict?: boolean | undefined;
+    strict?: boolean;
 };
 export type ResolveOptions = {
     /**
      * - force resolve using a specific locale first
      */
-    locale?: string | undefined;
+    locale?: LocaleCode;
 };
-/**
- * Represents statistics for a specific locale.
- */
 export type StatLocale = {
     /**
      * - The locale code (e.g., "en", "pt-BR").
@@ -104,30 +78,17 @@ export type StatLocale = {
      */
     isCurrent: boolean;
 };
-/**
- * Read-only view of registered helpers, exposed to function-based entries.
- *
- * Provides safe access to:
- * - check if a helper exists by name
- * - call a helper by name, passing arguments
- */
-export type HelpersReadonly<T extends unknown, R extends unknown> = {
+export type HelpersReadonly<T extends any, R extends any> = {
     /**
      * - Check if a helper with given name is registered.
      */
-    has?: ((name: string) => boolean) | undefined;
+    has?: (name: string) => boolean;
     /**
      * -
      * Invoke a helper by name with an argument and optional extras.
      */
-    call?: ((name: string, arg: T, extras?: HelpersReadonly<T, R>) => R) | undefined;
+    call?: (name: string, arg: T, extras?: HelpersReadonly<T, R>) => R;
 };
-/**
- * A helper callback function used in translations.
- *
- * - Receives user-supplied parameters and a read-only facade for calling other helpers.
- * - Must return a string (e.g. processed, interpolated, or formatted output).
- */
 export type HelperCallback = (params: Dict, helpers: HelpersReadonly<any, any>) => string;
 /**
  * Supported operating modes for TinyI18.
@@ -241,6 +202,7 @@ export type HelperCallback = (params: Dict, helpers: HelpersReadonly<any, any>)
  * - Safe: no dynamic code eval from files; functions in file mode are referenced by name ("$fn").
  */
 declare class TinyI18 {
+    #private;
     /**
      * Merges multiple JSON locale files into a single file for TinyI18 usage.
      * @param {Object} options
@@ -253,20 +215,8 @@ declare class TinyI18 {
     static mergeLocaleFiles({ files, output, spaces }: {
         files: string[];
         output: string;
-        spaces?: number | undefined;
+        spaces?: number;
     }): Promise<void>;
-    /**
-     * Creates a new TinyI18 instance for managing localized strings and patterns.
-     *
-     * Supports two modes:
-     * - "local": loads translations directly from provided objects.
-     * - "file": loads translations from JSON files on demand.
-     *
-     * Ensures the default locale is always initialized. In "file" mode, `basePath` is required.
-     *
-     * @param {TinyI18Options} options - Configuration options for the instance.
-     */
-    constructor(options: TinyI18Options);
     /**
      * Gets the current destruction status of the instance.
      *
@@ -334,6 +284,18 @@ declare class TinyI18 {
      * @returns {Record<string, RegExp>}
      */
     get regexCache(): Record<string, RegExp>;
+    /**
+     * Creates a new TinyI18 instance for managing localized strings and patterns.
+     *
+     * Supports two modes:
+     * - "local": loads translations directly from provided objects.
+     * - "file": loads translations from JSON files on demand.
+     *
+     * Ensures the default locale is always initialized. In "file" mode, `basePath` is required.
+     *
+     * @param {TinyI18Options} options - Configuration options for the instance.
+     */
+    constructor(options: TinyI18Options);
     /**
      * Clears the internal regex cache.
      *
@@ -427,6 +389,6 @@ declare class TinyI18 {
      * @returns {void}
      */
     destroy(): void;
-    #private;
 }
+export default TinyI18;
 //# sourceMappingURL=TinyI18.d.mts.map

package/dist/v1/libs/TinyIframeEvents.cjs

@@ -97,7 +97,7 @@ class TinyIframeEvents extends events.EventEmitter {
    * Executes the provided callback when the secure MessageChannel connection is fully established.
    * If the connection is already ready, the callback is executed immediately.
    *
-   * @param {function(): void} handler - The callback function to execute.
+   * @param {() => void} handler - The callback function to execute.
    */
   onReady(handler) {
     checkDestroy(this.#isDestroyed);

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

@@ -1,41 +1,32 @@
-export default TinyIframeEvents;
-/**
- * A function to handle incoming event payloads.
- */
+import { EventEmitter } from 'events';
 export type handler = (payload: any, event: MessageEvent<any>) => any;
-/**
- * Configuration object for initializing TinyIframeEvents.
- */
 export type TinyIframeEventsConfig = {
     /**
      * - The target iframe element to post messages to. Required if instantiated in the parent window.
      */
-    targetIframe?: HTMLIFrameElement | undefined;
+    targetIframe?: HTMLIFrameElement;
     /**
      * - The target origin to restrict messages to. Defaults to `window.location.origin`.
      */
-    targetOrigin?: string | undefined;
+    targetOrigin?: string;
     /**
      * - Custom internal name used to validate standard routing messages.
      */
-    secretEventName?: string | undefined;
+    secretEventName?: string;
     /**
      * - Custom internal name used for the initial MessageChannel handshake.
      */
-    handshakeEventName?: string | undefined;
+    handshakeEventName?: string;
     /**
      * - Custom internal name used for the ready event trigger.
      */
-    readyEventName?: string | undefined;
+    readyEventName?: string;
 };
-/**
- * Internal message structure for routed communication.
- */
 export type IframeEventBase = {
     /**
      * - Dynamic key based on secretEventName to validate the message.
      */
-    secretIndicator?: boolean | undefined;
+    secretIndicator?: boolean;
     /**
      * - The name of the custom event route.
      */
@@ -47,7 +38,7 @@ export type IframeEventBase = {
     /**
      * - Indicates the sender: 'iframe' or 'parent'.
      */
-    direction: "iframe" | "parent";
+    direction: 'iframe' | 'parent';
 };
 /**
  * @callback handler
@@ -86,14 +77,10 @@ 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 extends EventEmitter<any> {
-    /**
-     * Creates a new TinyIframeEvents instance to manage secure communication.
-     * Automatically establishes a MessageChannel connection between contexts.
-     *
-     * @param {TinyIframeEventsConfig} config - Configuration object.
-     */
-    constructor({ targetIframe, targetOrigin, secretEventName, handshakeEventName, readyEventName, }?: TinyIframeEventsConfig);
+declare class TinyIframeEvents extends EventEmitter {
+    #private;
+    _boundWindowMessage: (event: MessageEvent<any>) => void;
+    _boundPortMessage: (event: MessageEvent<any>) => void;
     get targetWindow(): Window;
     get targetIframeElement(): HTMLIFrameElement | undefined;
     get targetOrigin(): string;
@@ -103,44 +90,49 @@ declare class TinyIframeEvents extends EventEmitter<any> {
      * Executes the provided callback when the secure MessageChannel connection is fully established.
      * If the connection is already ready, the callback is executed immediately.
      *
-     * @param {function(): void} handler - The callback function to execute.
+     * @param {() => void} handler - The callback function to execute.
      */
     onReady(handler: () => void): void;
-    _boundWindowMessage: (event: MessageEvent<any>) => void;
-    _boundPortMessage: (event: MessageEvent<any>) => void;
     /**
-     * Sets the internal secret iframe event name.
-     * @param {string} name
-     * @throws {TypeError} If the value is not a string.
+     * Creates a new TinyIframeEvents instance to manage secure communication.
+     * Automatically establishes a MessageChannel connection between contexts.
+     *
+     * @param {TinyIframeEventsConfig} config - Configuration object.
      */
-    set secretEventName(name: string);
+    constructor({ targetIframe, targetOrigin, secretEventName, handshakeEventName, readyEventName, }?: TinyIframeEventsConfig);
     /**
      * Gets the internal secret iframe event name used for validation.
      * @returns {string}
      */
     get secretEventName(): string;
     /**
-     * Sets the internal handshake event name.
+     * Sets the internal secret iframe event name.
      * @param {string} name
      * @throws {TypeError} If the value is not a string.
      */
-    set handshakeEventName(name: string);
+    set secretEventName(name: string);
     /**
      * Gets the internal handshake event name used for establishing the MessageChannel.
      * @returns {string}
      */
     get handshakeEventName(): string;
     /**
-     * Sets the internal ready event name.
+     * Sets the internal handshake event name.
      * @param {string} name
      * @throws {TypeError} If the value is not a string.
      */
-    set readyEventName(name: string);
+    set handshakeEventName(name: string);
     /**
      * Gets the internal ready event name used when the connection is fully established.
      * @returns {string}
      */
     get readyEventName(): string;
+    /**
+     * Sets the internal ready event name.
+     * @param {string} name
+     * @throws {TypeError} If the value is not a string.
+     */
+    set readyEventName(name: string);
     /**
      * Sends an event to the target window through the secure MessageChannel.
      *
@@ -161,7 +153,6 @@ declare class TinyIframeEvents extends EventEmitter<any> {
      * Call this when the instance is no longer needed to prevent memory leaks.
      */
     destroy(): void;
-    #private;
 }
-import { EventEmitter } from 'events';
+export default TinyIframeEvents;
 //# sourceMappingURL=TinyIframeEvents.d.mts.map

package/dist/v1/libs/TinyIframeEvents.mjs

@@ -78,7 +78,7 @@ class TinyIframeEvents extends EventEmitter {
      * Executes the provided callback when the secure MessageChannel connection is fully established.
      * If the connection is already ready, the callback is executed immediately.
      *
-     * @param {function(): void} handler - The callback function to execute.
+     * @param {() => void} handler - The callback function to execute.
      */
     onReady(handler) {
         checkDestroy(this.#isDestroyed);