adminforth 1.4.3-next.20 → 1.4.3-next.21

package/dist/adminforth/types/FrontendAPI.d.ts

@@ -0,0 +1,134 @@
+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: {
+        /**
+         * Full refresh the list. Loader will be shown during fetching data. Will fully reload table data from the server. If new data available, it will be shown in the list.
+         */
+        refresh(): Promise<{
+            error?: string;
+        }>;
+        /**
+         * Silently Refresh existing rows in the list (without loader).
+         * Should be called when table data already loaded, otherwise method will return an error.
+         * If new data available, it will not appear in the list.
+         */
+        silentRefresh(): Promise<{
+            error?: string;
+        }>;
+        /**
+         * Refresh a specific row in the list without loader, row should be already shown in the list, otherwise method will return an error
+         */
+        silentRefreshRow(pk: any): Promise<{
+            error?: string;
+        }>;
+        /**
+         * 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 declare enum AlertVariant {
+    danger = "danger",
+    success = "success",
+    warning = "warning",
+    info = "info"
+}
+//# sourceMappingURL=FrontendAPI.d.ts.map

package/dist/adminforth/types/FrontendAPI.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FrontendAPI.d.ts","sourceRoot":"","sources":["../../../types/FrontendAPI.ts"],"names":[],"mappings":"AACA,MAAM,WAAW,oBAAoB;IAEjC;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,MAAM,EAAC,aAAa,GAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9C;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,MAAM,EAAC,WAAW,GAAG,IAAI,CAAC;IAGhC,IAAI,EAAE;QAEF;;WAEG;QACH,OAAO,IAAI,OAAO,CAAC;YAAE,KAAK,CAAC,EAAG,MAAM,CAAA;SAAE,CAAC,CAAC;QAExC;;;;WAIG;QACH,aAAa,IAAI,OAAO,CAAC;YAAE,KAAK,CAAC,EAAG,MAAM,CAAA;SAAE,CAAC,CAAC;QAE9C;;WAEG;QACH,gBAAgB,CAAE,EAAE,EAAE,GAAG,GAAG,OAAO,CAAC;YAAE,KAAK,CAAC,EAAG,MAAM,CAAA;SAAE,CAAC,CAAC;QAEzD;;WAEG;QACH,sBAAsB,IAAI,IAAI,CAAC;QAE/B;;WAEG;QACH,qBAAqB,IAAI,IAAI,CAAC;QAE9B;;;;;;;;;;;;WAYG;QACH,SAAS,CAAC,MAAM,EAAE,GAAG,GAAG,IAAI,CAAC;QAE7B;;;;;;;;;;WAUG;QACH,YAAY,CAAC,MAAM,EAAE,GAAG,GAAG,IAAI,CAAC;QAEhC;;WAEG;QACH,YAAY,IAAI,IAAI,CAAC;KACxB,CAAA;CACJ;AAED,MAAM,MAAM,aAAa,GAAG;IACxB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CAEf,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,YAAY,GAAG,MAAM,OAAO,YAAY,CAAC;IAEnD;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC;CAElC,CAAA;AAID,oBAAY,YAAY;IACpB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,IAAI,SAAS;CACd"}

package/dist/adminforth/types/FrontendAPI.js

@@ -0,0 +1,8 @@
+export var AlertVariant;
+(function (AlertVariant) {
+    AlertVariant["danger"] = "danger";
+    AlertVariant["success"] = "success";
+    AlertVariant["warning"] = "warning";
+    AlertVariant["info"] = "info";
+})(AlertVariant || (AlertVariant = {}));
+//# sourceMappingURL=FrontendAPI.js.map

package/dist/adminforth/types/FrontendAPI.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FrontendAPI.js","sourceRoot":"","sources":["../../../types/FrontendAPI.ts"],"names":[],"mappings":"AAgJA,MAAM,CAAN,IAAY,YAKT;AALH,WAAY,YAAY;IACpB,iCAAiB,CAAA;IACjB,mCAAmB,CAAA;IACnB,mCAAmB,CAAA;IACnB,6BAAa,CAAA;AACf,CAAC,EALS,YAAY,KAAZ,YAAY,QAKrB"}

package/dist/dev-demo/index.d.ts

@@ -0,0 +1,3 @@
+import AdminForth from '../adminforth/index.js';
+export declare const admin: AdminForth;
+//# sourceMappingURL=index.d.ts.map

package/dist/dev-demo/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../dev-demo/index.ts"],"names":[],"mappings":"AAEA,OAAO,UAAyH,MAAM,wBAAwB,CAAC;AA4G/J,eAAO,MAAM,KAAK,YA64BhB,CAAA"}