adminforth 1.3.54-next.3 → 1.3.54-next.30

package/types/FrontendAPI.ts

@@ -1,143 +0,0 @@
- 
-export interface FrontendAPIInterface {
-
-    /**
-     * Show a confirmation dialog
-     * 
-     * The dialog will be displayed to the user
-     * 
-     * Example: 
-     * 
-     * ```ts
-     * const isConfirmed = await window.adminforth.confirm({message: 'Are you sure?', yes: 'Yes', no: 'No'})
-     * if (isConfirmed) {
-     *  your code...
-     * }
-     * ```
-     * 
-     * @param params - The parameters of the dialog
-     * @returns A promise that resolves when the user confirms the dialog
-     */   
-    confirm(params:ConfirmParams ): Promise<void>;
-    
-    /**
-     * Show an alert
-     * 
-     * The alert will be displayed to the user
-     * 
-     * Example:
-     * 
-     * ```ts
-     *  window.adminforth.alert({message: 'Hello', variant: 'success'})
-     * ```
-     * 
-     * @param params - The parameters of the alert
-     */
-    alert(params:AlertParams): void;
-
-
-    list: {
-
-        /**
-         * Refresh the list
-         */
-        refresh(): void;
-
-        /**
-         * Close the three dots dropdown
-         */
-        closeThreeDotsDropdown(): void;
-
-        /**
-         * Close the user menu dropdown
-         */
-        closeUserMenuDropdown(): void;
-
-        /**
-         * Set a filter in the list
-         * Works only when user located on the list page.
-         * Can be used to set filter from charts or other components in pageInjections.
-         * 
-         * Example:
-         * 
-         * ```ts
-         * window.adminforth.list.setFilter({field: 'name', operator: 'ilike', value: 'john'})
-         * ```
-         * 
-         * @param filter - The filter to set
-         */
-        setFilter(filter: any): void;
-
-        /**
-         * Update a filter in the list
-         * 
-         * Example:
-         * 
-         * ```ts
-         * window.adminforth.list.updateFilter({field: 'name', operator: 'ilike', value: 'john'})
-         * ```
-         * 
-         * @param filter - The filter to update
-         */
-        updateFilter(filter: any): void;
-
-        /**
-         * Clear all filters from the list
-         */
-        clearFilters(): void;
-    }
-}
-
-export type ConfirmParams = {
-    /**
-     * The message to display in the dialog
-     */
-    message?: string;
-    /**
-     * The text to display in the "accept" button
-     */
-    yes?: string;
-    /**
-     * The text to display in the "cancel" button
-     */
-    no?: string;
-   
-}
-
-export type AlertParams = {
-    /**
-     * The message to display in the alert
-     */
-    message?: string;
-
-    /**
-     * The message to display in the alert as HTML (can be used instead of message)
-     */
-    messageHtml?: string;
-    
-    /**
-     * The variant of the alert
-     */
-    variant?: AlertVariant | keyof typeof AlertVariant;
-
-    /**
-     * The timeout of the alert in seconds or 'unlimited' to keep the alert open until the user closes it.
-     * Default is 10 seconds;
-     */
-    timeout?: number | 'unlimited';
-    
-}
-
-
-
-export enum AlertVariant {
-    danger = 'danger',
-    success = 'success',
-    warning = 'warning',
-    info = 'info'
-  }
-
-  
-  
-
-