tiny-essentials 1.28.18 → 1.28.19

package/dist/v1/webTemplates/bootstrap/5.3/html/BootstrapDialogs.d.mts

@@ -0,0 +1,290 @@
+/**
+ * @typedef {import('bootstrap').Modal} Modal
+ */
+export type Modal = import('bootstrap').Modal;
+export type ModalClass = typeof import('bootstrap').Modal;
+export type CustomElementConfig = {
+    /**
+     * - CSS classes to be added to the element (as a string or an array of strings).
+     */
+    className?: string | string[];
+    /**
+     * - CSS properties and values (e.g., { 'background-color': '#000' }).
+     */
+    styles?: Record<string, string | null>;
+};
+export type ModalOptions = {
+    /**
+     * - The text to be displayed in the modal header.
+     */
+    title?: string;
+    /**
+     * - The text to be displayed on the primary confirmation button.
+     */
+    confirmText?: string;
+    /**
+     * - The text to be displayed on the secondary cancel button.
+     */
+    cancelText?: string;
+    /**
+     * - The initial value for the input field (used in prompts).
+     */
+    defaultValue?: string;
+    /**
+     * - Customization for the main modal container.
+     */
+    modalConfig?: CustomElementConfig;
+    /**
+     * - Customization for the modal header.
+     */
+    headerConfig?: CustomElementConfig;
+    /**
+     * - Customization for the modal title.
+     */
+    titleConfig?: CustomElementConfig;
+    /**
+     * - Customization for the close button.
+     */
+    closeBtnConfig?: CustomElementConfig;
+    /**
+     * - Customization for the modal body.
+     */
+    bodyConfig?: CustomElementConfig;
+    /**
+     * - Customization for the modal footer.
+     */
+    footerConfig?: CustomElementConfig;
+    /**
+     * - Customization for the confirm button.
+     */
+    confirmBtnConfig?: CustomElementConfig;
+    /**
+     * - Customization for the cancel button.
+     */
+    cancelBtnConfig?: CustomElementConfig;
+    /**
+     * - Customization for the modal content container.
+     */
+    contentConfig?: CustomElementConfig;
+    /**
+     * - Customization for the modal dialog wrapper.
+     */
+    dialogConfig?: CustomElementConfig;
+};
+/**
+ * @typedef {typeof import('bootstrap').Modal} ModalClass
+ */
+/**
+ * @typedef {Object} CustomElementConfig
+ * @property {string | string[]} [className] - CSS classes to be added to the element (as a string or an array of strings).
+ * @property {Object<string, string|null>} [styles] - CSS properties and values (e.g., { 'background-color': '#000' }).
+ */
+/**
+ * @typedef {Object} ModalOptions - Configuration options for the dialog content and buttons.
+ * @property {string} [title] - The text to be displayed in the modal header.
+ * @property {string} [confirmText] - The text to be displayed on the primary confirmation button.
+ * @property {string} [cancelText] - The text to be displayed on the secondary cancel button.
+ * @property {string} [defaultValue] - The initial value for the input field (used in prompts).
+ * @property {CustomElementConfig} [modalConfig] - Customization for the main modal container.
+ * @property {CustomElementConfig} [headerConfig] - Customization for the modal header.
+ * @property {CustomElementConfig} [titleConfig] - Customization for the modal title.
+ * @property {CustomElementConfig} [closeBtnConfig] - Customization for the close button.
+ * @property {CustomElementConfig} [bodyConfig] - Customization for the modal body.
+ * @property {CustomElementConfig} [footerConfig] - Customization for the modal footer.
+ * @property {CustomElementConfig} [confirmBtnConfig] - Customization for the confirm button.
+ * @property {CustomElementConfig} [cancelBtnConfig] - Customization for the cancel button.
+ * @property {CustomElementConfig} [contentConfig] - Customization for the modal content container.
+ * @property {CustomElementConfig} [dialogConfig] - Customization for the modal dialog wrapper.
+ */
+/**
+ * Utility to replace native alert/confirm/prompt with Bootstrap 5 modals.
+ * Built with strict DOM manipulation to prevent XSS.
+ */
+declare class BootstrapDialogs {
+    #private;
+    /** @type {Modal|null} */
+    static _activeInstance: Modal | null;
+    /** @type {Modal|null} */
+    static _loadingInstance: Modal | null;
+    /** @type {HTMLElement|null} */
+    static _modalElement: HTMLElement | null;
+    /** @type {HTMLElement|null} */
+    static _loadingElement: HTMLElement | null;
+    /** @type {Function|null} */
+    static _activeResolve: Function | null;
+    /** @type {'alert'|'confirm'|'prompt'|null} */
+    static _activeType: 'alert' | 'confirm' | 'prompt' | null;
+    /**
+     * Gets a deep copy of the default configuration.
+     * @returns {Object<string, CustomElementConfig>}
+     */
+    static get defaultConfig(): Record<string, CustomElementConfig>;
+    /**
+     * Sets the entire default configuration.
+     * @param {Object<string, CustomElementConfig>} config - The new default configuration.
+     * @throws {TypeError} If the configuration is invalid.
+     */
+    static set defaultConfig(config: Record<string, CustomElementConfig>);
+    /**
+     * Sets the Modal class constructor (e.g., Bootstrap's Modal).
+     * @param {ModalClass} Modal - The Bootstrap Modal class constructor.
+     * @throws {Error} If a Modal class has already been set.
+     */
+    static set Modal(Modal: ModalClass);
+    /**
+     * Gets the currently set Modal class constructor.
+     * @returns {ModalClass} The currently configured Modal class.
+     * @throws {Error} If no Modal class has been set.
+     */
+    static get Modal(): ModalClass;
+    /**
+     * Updates a specific configuration key by merging it with existing defaults.
+     * @param {string} key - The key within #defaultConfig to update.
+     * @param {CustomElementConfig} config - The partial or full configuration to merge.
+     * @private
+     */
+    private static _updateConfigKey;
+    /** @param {CustomElementConfig} cfg */
+    static set modalConfig(cfg: CustomElementConfig);
+    static get modalConfig(): CustomElementConfig;
+    /** @param {CustomElementConfig} cfg */
+    static set headerConfig(cfg: CustomElementConfig);
+    static get headerConfig(): CustomElementConfig;
+    /** @param {CustomElementConfig} cfg */
+    static set titleConfig(cfg: CustomElementConfig);
+    static get titleConfig(): CustomElementConfig;
+    /** @param {CustomElementConfig} cfg */
+    static set closeBtnConfig(cfg: CustomElementConfig);
+    static get closeBtnConfig(): CustomElementConfig;
+    /** @param {CustomElementConfig} cfg */
+    static set bodyConfig(cfg: CustomElementConfig);
+    static get bodyConfig(): CustomElementConfig;
+    /** @param {CustomElementConfig} cfg */
+    static set footerConfig(cfg: CustomElementConfig);
+    static get footerConfig(): CustomElementConfig;
+    /** @param {CustomElementConfig} cfg */
+    static set confirmBtnConfig(cfg: CustomElementConfig);
+    static get confirmBtnConfig(): CustomElementConfig;
+    /** @param {CustomElementConfig} cfg */
+    static set cancelBtnConfig(cfg: CustomElementConfig);
+    static get cancelBtnConfig(): CustomElementConfig;
+    /** @param {CustomElementConfig} cfg */
+    static set contentConfig(cfg: CustomElementConfig);
+    static get contentConfig(): CustomElementConfig;
+    /** @param {CustomElementConfig} cfg */
+    static set dialogConfig(cfg: CustomElementConfig);
+    static get dialogConfig(): CustomElementConfig;
+    /**
+     * Helper to forcefully clean up body styles injected by Bootstrap JS.
+     * @returns {void}
+     */
+    static _restoreBody(): void;
+    /**
+     * Applies custom classes and styles to a given element.
+     * Combines default configurations with user-provided overrides.
+     * @param {HTMLElement} element - The target element.
+     * @param {CustomElementConfig} [defaultConfig] - The default configuration.
+     * @param {CustomElementConfig} [userConfig] - The user customization.
+     * @private
+     */
+    private static _applyCustomizations;
+    /**
+     * Validates the ModalOptions object deeply.
+     * @param {ModalOptions} options - The options to validate.
+     * @throws {TypeError} If validation fails.
+     * @private
+     */
+    private static _validateOptions;
+    /**
+     * Displays a simple alert modal.
+     * @param {string} message - The text message to be displayed to the user.
+     * @param {ModalOptions} [options={}] - Configuration options for the alert modal.
+     * @returns {Promise<void>} A promise that resolves when the alert is closed.
+     */
+    static alert(message: string, options?: ModalOptions): Promise<void>;
+    /**
+     * Displays a confirmation modal.
+     * @param {string} message - The question or message to be displayed to the user.
+     * @param {ModalOptions} [options={}] - Configuration options for the confirmation modal.
+     * @returns {Promise<boolean>} A promise that resolves with true if confirmed, or false if cancelled.
+     */
+    static confirm(message: string, options?: ModalOptions): Promise<boolean>;
+    /**
+     * Displays a prompt modal with an input field.
+     * @param {string} message - The instruction or question for the user.
+     * @param {string} [defaultValue=''] - The initial value for the input field.
+     * @param {ModalOptions} [options={}] - Configuration options for the prompt modal.
+     * @returns {Promise<string|null>} A promise that resolves with the input value, or null if cancelled.
+     */
+    static prompt(message: string, defaultValue?: string, options?: ModalOptions): Promise<string | null>;
+    /**
+     * Displays a global, non-dismissible loading overlay for background/DB tasks.
+     * @param {string} [message='Processing...'] - The text to display while the loading state is active.
+     * @returns {void}
+     */
+    static showLoading(message?: string): void;
+    /**
+     * Hides and destroys the active loading overlay.
+     * @returns {void}
+     */
+    static hideLoading(): void;
+    /**
+     * Core method to build the modal DOM structure safely.
+     * @param {string} titleText - The text to be placed in the modal header.
+     * @param {HTMLElement|string} bodyContent - The content to be placed in the modal body.
+     * @param {boolean} showCancel - Whether to display the cancel button.
+     * @param {string} confirmText - The text for the confirmation button.
+     * @param {string|null} [cancelText='Cancel'] - The text for the cancel button.
+     * @param {ModalOptions} [options={}] - Configuration options for customization.
+     * @returns {HTMLElement} The constructed modal element.
+     */
+    static _buildModalElement(titleText: string, bodyContent: HTMLElement | string, showCancel: boolean, confirmText: string, cancelText?: string | null, options?: ModalOptions): HTMLElement;
+    /**
+     * Clean up any existing modal and resolve its promise.
+     * @returns {void}
+     */
+    static _cleanup(): void;
+    /**
+     * Internal method to initialize the modal instance and handle lifecycle.
+     * @param {string} title - The title text for the modal.
+     * @param {HTMLElement|string} bodyContent - The content to be placed in the modal body.
+     * @param {boolean} showCancel - Whether to include a cancel button.
+     * @param {string} confirmText - The text for the confirmation button.
+     * @param {string|null} [cancelText='Cancel'] - The text for the cancel button.
+     * @param {'alert'|'confirm'|'prompt'} [type='alert'] - The type of dialog being shown.
+     * @param {ModalOptions} [options={}] - Configuration options for customization.
+     * @returns {Promise<any>} A promise that resolves with the user's action.
+     */
+    static _show(title: string, bodyContent: HTMLElement | string, showCancel: boolean, confirmText: string, cancelText?: string | null, type?: 'alert' | 'confirm' | 'prompt', options?: ModalOptions): Promise<any>;
+}
+export { BootstrapDialogs };
+/**
+ * @param {string} msg - The message to display.
+ * @param {ModalOptions} [options] - Configuration options for the alert.
+ * @returns {Promise<void>}
+ */
+export declare const alert: (msg: string, options?: ModalOptions) => Promise<void>;
+/**
+ * @param {string} msg - The message to display.
+ * @param {string} [def] - The default value for the input field.
+ * @param {ModalOptions} [options] - Configuration options for the prompt.
+ * @returns {Promise<string|null>}
+ */
+export declare const prompt: (msg: string, def?: string, options?: ModalOptions) => Promise<string | null>;
+/**
+ * @param {string} msg - The message to display.
+ * @param {ModalOptions} [options] - Configuration options for the confirmation.
+ * @returns {Promise<boolean>}
+ */
+export declare const confirm: (msg: string, options?: ModalOptions) => Promise<boolean>;
+/**
+ * @param {string} msg - The message to display.
+ * @returns {void}
+ */
+export declare const showLoading: (msg: string) => void;
+/**
+ * Hides and destroys the active loading overlay.
+ * @returns {void}
+ */
+export declare const hideLoading: () => void;
+//# sourceMappingURL=BootstrapDialogs.d.mts.map

package/dist/v1/webTemplates/bootstrap/5.3/html/BootstrapDialogs.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BootstrapDialogs.d.mts","sourceRoot":"","sources":["../../../../../../src/v1/webTemplates/bootstrap/5.3/html/BootstrapDialogs.mjs"],"names":[],"mappings":"AAAA;;GAEG;AADA,YAAqC,KAAK,GAAhC,OAAO,WAAW,EAAE,KAAK,CAAO;AAI1C,YAA4C,UAAU,GAA5C,cAAc,WAAW,EAAE,KAAK,CAAY;AAItD,YAAkB,mBAAmB,GACrC;;;;IAA+B,SAAS,AAAxC,CACA,EADW,MAAM,GAAG,MAAM,EAAE,CAC5B;;;;IAAyC,MAAM,AAA/C,CACF,gCAAA;CAAA,CAAA;AAGE,YAAkB,YAAY,GAC9B;;;;IAAoB,KAAK,AAAzB,CACA,EADW,MAAM,CACjB;;;;IAAoB,WAAW,AAA/B,CACA,EADW,MAAM,CACjB;;;;IAAoB,UAAU,AAA9B,CACA,EADW,MAAM,CACjB;;;;IAAoB,YAAY,AAAhC,CACA,EADW,MAAM,CACjB;;;;IAAiC,WAAW,AAA5C,CACA,EADW,mBAAmB,CAC9B;;;;IAAiC,YAAY,AAA7C,CACA,EADW,mBAAmB,CAC9B;;;;IAAiC,WAAW,AAA5C,CACA,EADW,mBAAmB,CAC9B;;;;IAAiC,cAAc,AAA/C,CACA,EADW,mBAAmB,CAC9B;;;;IAAiC,UAAU,AAA3C,CACA,EADW,mBAAmB,CAC9B;;;;IAAiC,YAAY,AAA7C,CACA,EADW,mBAAmB,CAC9B;;;;IAAiC,gBAAgB,AAAjD,CACA,EADW,mBAAmB,CAC9B;;;;IAAiC,eAAe,AAAhD,CACA,EADW,mBAAmB,CAC9B;;;;IAAiC,aAAa,AAA9C,CACA,EADW,mBAAmB,CAC9B;;;;IAAiC,YAAY,AAA7C,CACF,EADa,mBAAmB,CAChC;CAAA,CAAA;AA1BD;;GAEG;AAEH;;;;GAIG;AAEH;;;;;;;;;;;;;;;;GAgBG;AAEH;;;GAGG;AACH,cAAM,gBAAgB;;IACpB,yBAAyB;IACzB,MAAM,CAAC,eAAe,EADX,KAAK,GAAC,IAAI,CACS;IAC9B,yBAAyB;IACzB,MAAM,CAAC,gBAAgB,EADZ,KAAK,GAAC,IAAI,CACU;IAC/B,+BAA+B;IAC/B,MAAM,CAAC,aAAa,EADT,WAAW,GAAC,IAAI,CACC;IAC5B,+BAA+B;IAC/B,MAAM,CAAC,eAAe,EADX,WAAW,GAAC,IAAI,CACG;IAC9B,4BAA4B;IAC5B,MAAM,CAAC,cAAc,EADV,WAAS,IAAI,CACK;IAC7B,8CAA8C;IAC9C,MAAM,CAAC,WAAW,EADP,OAAO,GAAC,SAAS,GAAC,QAAQ,GAAC,IAAI,CAChB;IAyB1B;;;OAGG;IACH,MAAM,KAAK,aAAa,wCAEvB;IAED;;;;OAIG;IACH,MAAM,KAAK,aAAa,CAAC,MAAM,qCAAA,EAG9B;IAED;;;;OAIG;IACH,MAAM,KAAK,KAAK,CAAC,KAAK,EAHX,UAGW,EAIrB;IAED;;;;OAIG;IACH,MAAM,KAAK,KAAK,IAHH,UAAU,CAMtB;IAED;;;;;OAKG;mBACI,gBAAgB;IAyBvB,uCAAuC;IACvC,MAAM,KAAK,WAAW,CAAC,GAAG,EADd,mBACc,EAEzB;IACD,MAAM,KAAK,WAAW,IAJV,mBAAmB,CAM9B;IACD,uCAAuC;IACvC,MAAM,KAAK,YAAY,CAAC,GAAG,EADf,mBACe,EAE1B;IACD,MAAM,KAAK,YAAY,IAJX,mBAAmB,CAM9B;IACD,uCAAuC;IACvC,MAAM,KAAK,WAAW,CAAC,GAAG,EADd,mBACc,EAEzB;IACD,MAAM,KAAK,WAAW,IAJV,mBAAmB,CAM9B;IACD,uCAAuC;IACvC,MAAM,KAAK,cAAc,CAAC,GAAG,EADjB,mBACiB,EAE5B;IACD,MAAM,KAAK,cAAc,IAJb,mBAAmB,CAM9B;IACD,uCAAuC;IACvC,MAAM,KAAK,UAAU,CAAC,GAAG,EADb,mBACa,EAExB;IACD,MAAM,KAAK,UAAU,IAJT,mBAAmB,CAM9B;IACD,uCAAuC;IACvC,MAAM,KAAK,YAAY,CAAC,GAAG,EADf,mBACe,EAE1B;IACD,MAAM,KAAK,YAAY,IAJX,mBAAmB,CAM9B;IACD,uCAAuC;IACvC,MAAM,KAAK,gBAAgB,CAAC,GAAG,EADnB,mBACmB,EAE9B;IACD,MAAM,KAAK,gBAAgB,IAJf,mBAAmB,CAM9B;IACD,uCAAuC;IACvC,MAAM,KAAK,eAAe,CAAC,GAAG,EADlB,mBACkB,EAE7B;IACD,MAAM,KAAK,eAAe,IAJd,mBAAmB,CAM9B;IACD,uCAAuC;IACvC,MAAM,KAAK,aAAa,CAAC,GAAG,EADhB,mBACgB,EAE3B;IACD,MAAM,KAAK,aAAa,IAJZ,mBAAmB,CAM9B;IACD,uCAAuC;IACvC,MAAM,KAAK,YAAY,CAAC,GAAG,EADf,mBACe,EAE1B;IACD,MAAM,KAAK,YAAY,IAJX,mBAAmB,CAM9B;IAED;;;OAGG;IACH,MAAM,CAAC,YAAY,IAFN,IAAI,CAahB;IAED;;;;;;;OAOG;mBACI,oBAAoB;IAwB3B;;;;;OAKG;mBACI,gBAAgB;IAmDvB;;;;;OAKG;IACH,OAAa,KAAK,CAAC,OAAO,EAJf,MAIe,EAAE,OAAO,AAHhC,CACA,EADQ,YAG6B,GAF3B,OAAO,CAAC,IAAI,CAAC,CAMzB;IAED;;;;;OAKG;IACH,OAAa,OAAO,CAAC,OAAO,EAJjB,MAIiB,EAAE,OAAO,AAHlC,CACA,EADQ,YAG+B,GAF7B,OAAO,CAAC,OAAO,CAAC,CAO5B;IAED;;;;;;OAMG;IACH,OAAa,MAAM,CAAC,OAAO,EALhB,MAKgB,EAAE,YAAY,AAJtC,CACA,EADQ,MAImC,EAAE,OAAO,AAHpD,CACA,EADQ,YAGiD,GAF/C,OAAO,CAAC,MAAM,GAAC,IAAI,CAAC,CAqBhC;IAED;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,OAAO,AAHvB,CACA,EADQ,MAGiC,GAF/B,IAAI,CA4ChB;IAED;;;OAGG;IACH,MAAM,CAAC,WAAW,IAFL,IAAI,CAehB;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,kBAAkB,CACvB,SAAS,EATA,MASA,EACT,WAAW,EATF,WAAW,GAAC,MASV,EACX,UAAU,EATD,OASC,EACV,WAAW,EATF,MASE,EACX,UAAU,AATT,CACA,EADQ,MAAM,GAAC,IASK,EACrB,OAAO,AATN,CACA,EADQ,YASG,GARD,WAAW,CAgFvB;IAED;;;OAGG;IACH,MAAM,CAAC,QAAQ,IAFF,IAAI,CAyBhB;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,KAAK,CACV,KAAK,EAVI,MAUJ,EACL,WAAW,EAVF,WAAW,GAAC,MAUV,EACX,UAAU,EAVD,OAUC,EACV,WAAW,EAVF,MAUE,EACX,UAAU,AAVT,CACA,EADQ,MAAM,GAAC,IAUN,EACV,IAAI,AAVH,CACA,EADQ,OAAO,GAAC,SAAS,GAAC,QAUb,EACd,OAAO,AAVN,CACA,EADQ,YAUG,GATD,OAAO,CAAC,GAAG,CAAC,CAqFxB;CACF;AAED,OAAO,EAAE,gBAAgB,EAAE,CAAC;AAE5B;;;;GAIG;AACH,eAAO,MAAM,KAAK,QAJP,MAAM,YACN,YAAY,KACV,OAAO,CAAC,IAAI,CAEkD,CAAC;AAE5E;;;;;GAKG;AACH,eAAO,MAAM,MAAM,QALR,MAAM,QACN,MAAM,YACN,YAAY,KACV,OAAO,CAAC,MAAM,GAAC,IAAI,CAEuD,CAAC;AAExF;;;;GAIG;AACH,eAAO,MAAM,OAAO,QAJT,MAAM,YACN,YAAY,KACV,OAAO,CAAC,OAAO,CAEmD,CAAC;AAEhF;;;GAGG;AACH,eAAO,MAAM,WAAW,QAHb,MAAM,KACJ,IAEwD,CAAC;AAEtE;;;GAGG;AACH,eAAO,MAAM,WAAW,QAFX,IAEkD,CAAC"}