adminforth 2.17.0-next.6 → 2.17.0-next.61

package/dist/types/Back.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" resolution-mode="require"/>
 import type { Express, Request } from 'express';
 import type { Writable } from 'stream';
-import { ActionCheckSource, AdminForthFilterOperators, AdminForthSortDirections, AllowedActionsEnum, type AdminForthComponentDeclaration, type AdminUser, type AllowedActionsResolved, type AdminForthBulkActionCommon, type AdminForthForeignResourceCommon, type AdminForthResourceColumnCommon, type AdminForthResourceInputCommon, type AdminForthComponentDeclarationFull, type AdminForthConfigMenuItem, type AnnouncementBadgeResponse, AdminForthResourcePages, type AdminForthResourceColumnInputCommon } from './Common.js';
+import { ActionCheckSource, AdminForthFilterOperators, AdminForthSortDirections, AllowedActionsEnum, AdminForthResourcePages, type AdminForthComponentDeclaration, type AdminUser, type AllowedActionsResolved, type AdminForthBulkActionCommon, type AdminForthForeignResourceCommon, type AdminForthResourceColumnCommon, type AdminForthResourceInputCommon, type AdminForthComponentDeclarationFull, type AdminForthConfigMenuItem, type AnnouncementBadgeResponse, type AdminForthResourceColumnInputCommon } from './Common.js';
 export interface ICodeInjector {
     srcFoldersToSync: Object;
     allComponentNames: Object;
@@ -87,7 +87,7 @@ export interface ITranslateExpressRequest extends Omit<Request, 'protocol' | 'pa
 }
 export interface IAdminForthSingleFilter {
     field?: string;
-    operator?: AdminForthFilterOperators.EQ | AdminForthFilterOperators.NE | AdminForthFilterOperators.GT | AdminForthFilterOperators.LT | AdminForthFilterOperators.GTE | AdminForthFilterOperators.LTE | AdminForthFilterOperators.LIKE | AdminForthFilterOperators.ILIKE | AdminForthFilterOperators.IN | AdminForthFilterOperators.NIN;
+    operator?: AdminForthFilterOperators.EQ | AdminForthFilterOperators.NE | AdminForthFilterOperators.GT | AdminForthFilterOperators.LT | AdminForthFilterOperators.GTE | AdminForthFilterOperators.LTE | AdminForthFilterOperators.LIKE | AdminForthFilterOperators.ILIKE | AdminForthFilterOperators.IN | AdminForthFilterOperators.NIN | AdminForthFilterOperators.IS_EMPTY | AdminForthFilterOperators.IS_NOT_EMPTY;
     value?: any;
     rightField?: string;
     insecureRawSQL?: string;
@@ -283,7 +283,7 @@ export interface IAdminForthAuth {
         payload: {
             name: string;
             value: string;
-            expiry: number;
+            expiry?: number;
             expirySeconds: number;
             httpOnly: boolean;
         };
@@ -338,44 +338,9 @@ export interface IAdminForth {
     };
     formatAdminForth(): string;
     tr(msg: string, category: string, lang: string, params: any, pluralizationNumber?: number): Promise<string>;
-    createResourceRecord(params: {
-        resource: AdminForthResource;
-        record: any;
-        adminUser: AdminUser;
-        extra?: HttpExtra;
-    }): Promise<{
-        error?: string;
-        createdRecord?: any;
-        newRecordId?: any;
-    }>;
-    updateResourceRecord(params: {
-        resource: AdminForthResource;
-        recordId: any;
-        record: any;
-        oldRecord: any;
-        adminUser: AdminUser;
-        extra?: HttpExtra;
-        updates?: never;
-    } | {
-        resource: AdminForthResource;
-        recordId: any;
-        record?: never;
-        oldRecord: any;
-        adminUser: AdminUser;
-        extra?: HttpExtra;
-        updates: any;
-    }): Promise<{
-        error?: string;
-    }>;
-    deleteResourceRecord(params: {
-        resource: AdminForthResource;
-        recordId: string;
-        adminUser: AdminUser;
-        record: any;
-        extra?: HttpExtra;
-    }): Promise<{
-        error?: string;
-    }>;
+    createResourceRecord(params: CreateResourceRecordParams): Promise<CreateResourceRecordResult>;
+    updateResourceRecord(params: UpdateResourceRecordParams): Promise<UpdateResourceRecordResult>;
+    deleteResourceRecord(params: DeleteResourceRecordParams): Promise<DeleteResourceRecordResult>;
     auth: IAdminForthAuth;
     /**
      * Internal flag which indicates if AdminForth is running in hot reload mode.
@@ -464,6 +429,12 @@ export interface IAdminForthPlugin {
      * @param pluginOptions - options of plugin
      */
     instanceUniqueRepresentation(pluginOptions: any): string;
+    /**
+     * If this method returns true, AdminForth will allow only one instance of plugin per whole app
+     * (only for case when we are creating copy of resource and activating plugins)
+     * If false, multiple instances of plugin can be installed on different resources.
+     */
+    shouldHaveSingleInstancePerWholeApp?(): boolean;
     /**
      * Optional method which will be called after AdminForth discovers all resources and their columns.
      * Can be used to validate types of columns, check if some columns are missing, etc.
@@ -528,40 +499,276 @@ export interface HttpExtra {
     cookies: Record<string, string>;
     requestUrl: string;
     meta?: any;
+    response: IAdminForthHttpResponse;
 }
+/**
+ * Result of {@link IAdminForth.createResourceRecord}.
+ */
+export type CreateResourceRecordResult = {
+    /** Optional error message if creation failed. */
+    error?: string;
+    /** Created record as returned from the connector. */
+    createdRecord?: any;
+    /**
+     * Optional id of an existing record to redirect to
+     * (used when a beforeSave hook aborts creation and supplies newRecordId, allows to implement programmatic creation via API).
+     */
+    newRecordId?: any;
+};
+/**
+ * Parameters for {@link IAdminForth.createResourceRecord}.
+ */
+export type CreateResourceRecordParams = {
+    /**
+     * Resource configuration used to create a record.
+     */
+    resource: AdminForthResource;
+    /**
+     * Record data to create.
+     */
+    record: any;
+    /**
+     * Admin user performing the action.
+     */
+    adminUser: AdminUser;
+    /**
+     * HTTP response object.
+     *
+     * @deprecated Since 1.2.9. Will be removed in 2.0.0. Use extra.response instead.
+     */
+    response?: IAdminForthHttpResponse;
+    /**
+     * Extra HTTP information. Prefer using extra.response over the top-level response field.
+     */
+    extra?: HttpExtra;
+};
+/**
+ * Parameters for {@link IAdminForth.updateResourceRecord}.
+ */
+export type UpdateResourceRecordParams = {
+    /**
+     * Resource configuration used to update a record.
+     */
+    resource: AdminForthResource;
+    /**
+     * Primary key value of the record to update.
+     */
+    recordId: any;
+    /**
+     * Full record data with applied changes.
+     *
+     * @deprecated Since 1.2.9. Will be removed in 2.0.0. Use updates instead.
+     */
+    record: any;
+    /**
+     * Record data before update.
+     */
+    oldRecord: any;
+    /**
+     * Admin user performing the action.
+     */
+    adminUser: AdminUser;
+    /**
+     * HTTP response object.
+     *
+     * @deprecated Since 1.2.9. Will be removed in 2.0.0. Use extra.response instead.
+     */
+    response?: IAdminForthHttpResponse;
+    /**
+     * Extra HTTP information. Prefer using extra.response over the top-level response field.
+     */
+    extra?: HttpExtra;
+    /**
+     * Partial record data with only changed fields. Mutually exclusive with record.
+     */
+    updates?: never;
+} | {
+    /**
+     * Resource configuration used to update a record.
+     */
+    resource: AdminForthResource;
+    /**
+     * Primary key value of the record to update.
+     */
+    recordId: any;
+    /**
+     * Full record data with applied changes.
+     *
+     * @deprecated Since 1.2.9. Will be removed in 2.0.0. Use updates instead.
+     */
+    record?: never;
+    /**
+     * Record data before update.
+     */
+    oldRecord: any;
+    /**
+     * Admin user performing the action.
+     */
+    adminUser: AdminUser;
+    /**
+     * HTTP response object.
+     *
+     * @deprecated Since 1.2.9. Will be removed in 2.0.0. Use extra.response instead.
+     */
+    response?: IAdminForthHttpResponse;
+    /**
+     * Extra HTTP information. Prefer using extra.response over the top-level response field.
+     */
+    extra?: HttpExtra;
+    /**
+     * Partial record data with only changed fields. Mutually exclusive with record.
+     */
+    updates: any;
+};
+/**
+ * Parameters for {@link IAdminForth.deleteResourceRecord}.
+ */
+export type DeleteResourceRecordParams = {
+    /**
+     * Resource configuration used to delete a record.
+     */
+    resource: AdminForthResource;
+    /**
+     * Primary key value of the record to delete.
+     */
+    recordId: string;
+    /**
+     * Admin user performing the action.
+     */
+    adminUser: AdminUser;
+    /**
+     * Record data before deletion.
+     */
+    record: any;
+    /**
+     * HTTP response object.
+     *
+     * @deprecated Since 1.2.9. Will be removed in 2.0.0. Use extra.response instead.
+     */
+    response?: IAdminForthHttpResponse;
+    /**
+     * Extra HTTP information. Prefer using extra.response over the top-level response field.
+     */
+    extra?: HttpExtra;
+};
+/**
+ * Result of {@link IAdminForth.updateResourceRecord}.
+ */
+export type UpdateResourceRecordResult = {
+    /** Optional error message if update failed. */
+    error?: string;
+};
+/**
+ * Result of {@link IAdminForth.deleteResourceRecord}.
+ */
+export type DeleteResourceRecordResult = {
+    /** Optional error message if delete failed. */
+    error?: string;
+};
 /**
  * Modify record to change how data is saved to database.
  * Return ok: false and error: string to stop execution and show error message to user. Return ok: true to continue execution.
  */
 export type BeforeDeleteSaveFunction = (params: {
+    /**
+     * Resource info.
+     */
     resource: AdminForthResource;
+    /**
+     * Primary key value of the record to delete.
+     */
     recordId: any;
+    /**
+     * Admin user performing the action.
+     */
     adminUser: AdminUser;
+    /**
+     * Record data before deletion.
+     */
     record: any;
+    /**
+     * Adminforth instance.
+     */
     adminforth: IAdminForth;
+    /**
+     * HTTP response object.
+     *
+     * @deprecated Since 1.2.9. Will be removed in 2.0.0. Use extra.response instead.
+     */
+    response?: IAdminForthHttpResponse;
+    /**
+     * Extra HTTP information. Prefer using extra.response over the top-level response field.
+     */
     extra?: HttpExtra;
 }) => Promise<{
     ok: boolean;
     error?: string;
 }>;
 export type BeforeEditSaveFunction = (params: {
+    /**
+   * Resource info.
+   */
     resource: AdminForthResource;
+    /**
+   * Primary key value of the record to delete.
+   */
     recordId: any;
+    /**
+   * Admin user performing the action.
+   */
     adminUser: AdminUser;
     updates: any;
+    /**
+    * Record with updates
+    *
+    *  @deprecated. Will be removed in 2.0.0. Use updates instead.
+    */
     record: any;
+    /**
+     * Record data before update.
+     */
     oldRecord: any;
+    /**
+     * Adminforth instance.
+     */
     adminforth: IAdminForth;
+    /**
+   * HTTP response object.
+   *
+   * @deprecated Since 1.2.9. Will be removed in 2.0.0. Use extra.response instead.
+   */
+    response: IAdminForthHttpResponse;
+    /**
+   * Extra HTTP information. Prefer using extra.response over the top-level response field.
+   */
     extra?: HttpExtra;
 }) => Promise<{
     ok: boolean;
     error?: string | null;
 }>;
 export type BeforeCreateSaveFunction = (params: {
+    /**
+     * Resource info.
+     */
     resource: AdminForthResource;
+    /**
+     * Admin user performing the action.
+     */
     adminUser: AdminUser;
+    /**
+    * Record data to create.
+    */
     record: any;
+    /**
+     * Adminforth instance.
+     */
     adminforth: IAdminForth;
+    /**
+     * HTTP response object.
+     *
+     * @deprecated Since 1.2.9. Will be removed in 2.0.0. Use extra.response instead.
+     */
+    response: IAdminForthHttpResponse;
     extra?: HttpExtra;
 }) => Promise<{
     ok: boolean;
@@ -569,12 +776,39 @@ export type BeforeCreateSaveFunction = (params: {
     newRecordId?: string;
 }>;
 export type AfterCreateSaveFunction = (params: {
+    /**
+   * Resource info.
+   */
     resource: AdminForthResource;
+    /**
+   * Primary key value of the record to delete.
+   */
     recordId: any;
+    /**
+   * Admin user performing the action.
+   */
     adminUser: AdminUser;
+    /**
+     * Record data after creation.
+     */
     record: any;
+    /**
+   * Adminforth instance.
+   */
     adminforth: IAdminForth;
+    /**
+     * Record with virtual columns after creation.
+     */
     recordWithVirtualColumns?: any;
+    /**
+     * HTTP response object.
+     *
+     * @deprecated Since 1.2.9. Will be removed in 2.0.0. Use extra.response instead.
+     */
+    response: IAdminForthHttpResponse;
+    /**
+   * Extra HTTP information. Prefer using extra.response over the top-level response field.
+   */
     extra?: HttpExtra;
 }) => Promise<{
     ok: boolean;
@@ -585,24 +819,80 @@ export type AfterCreateSaveFunction = (params: {
  * Return ok: false and error: string to stop execution and show error message to user. Return ok: true to continue execution.
  */
 export type AfterDeleteSaveFunction = (params: {
+    /**
+   * Resource info.
+   */
     resource: AdminForthResource;
+    /**
+   * Primary key value of the record to delete.
+   */
     recordId: any;
+    /**
+   * Admin user performing the action.
+   */
     adminUser: AdminUser;
+    /**
+     * Record data, that was deleted.
+     */
     record: any;
+    /**
+     * Adminforth instance.
+     */
     adminforth: IAdminForth;
+    /**
+     * HTTP response object.
+     *
+     * @deprecated Since 1.2.9. Will be removed in 2.0.0. Use extra.response instead.
+     */
+    response: IAdminForthHttpResponse;
+    /**
+   * Extra HTTP information. Prefer using extra.response over the top-level response field.
+   */
     extra?: HttpExtra;
 }) => Promise<{
     ok: boolean;
     error?: string;
 }>;
 export type AfterEditSaveFunction = (params: {
+    /**
+   * Resource info.
+   */
     resource: AdminForthResource;
+    /**
+   * Primary key value of the record to delete.
+   */
     recordId: any;
+    /**
+   * Admin user performing the action.
+   */
     adminUser: AdminUser;
+    /**
+    * Record updates.
+    */
     updates: any;
+    /**
+    * Record after update.
+    *
+    *  @deprecated. Will be removed in 2.0.0. Use updates instead.
+    */
     record: any;
+    /**
+     * Record data before update.
+     */
     oldRecord: any;
+    /**
+     * Adminforth instance.
+     */
     adminforth: IAdminForth;
+    /**
+     * HTTP response object.
+     *
+     * @deprecated Since 1.2.9. Will be removed in 2.0.0. Use extra.response instead.
+     */
+    response: IAdminForthHttpResponse;
+    /**
+   * Extra HTTP information. Prefer using extra.response over the top-level response field.
+   */
     extra?: HttpExtra;
 }) => Promise<{
     ok: boolean;
@@ -612,10 +902,27 @@ export type AfterEditSaveFunction = (params: {
  * Allow to get user data before login confirmation, will triger when user try to login.
  */
 export type BeforeLoginConfirmationFunction = (params?: {
+    /**
+   * Admin user performing the action.
+   */
     adminUser: AdminUser;
+    /**
+     * HTTP response object.
+     *
+     * @deprecated Since 1.2.9. Will be removed in 2.0.0. Use extra.response instead.
+     */
     response: IAdminForthHttpResponse;
+    /**
+     * Adminforth instance.
+     */
     adminforth: IAdminForth;
+    /**
+   * Extra HTTP information. Prefer using extra.response over the top-level response field.
+   */
     extra?: HttpExtra;
+    /**
+   * Duration of session in format "1s", "1m", "1h", or "1d" (e.g., "30d" for 30 days)
+   */
     sessionDuration?: string;
 }) => Promise<{
     error?: string;
@@ -628,9 +935,23 @@ export type BeforeLoginConfirmationFunction = (params?: {
  * Allow to make extra authorization
  */
 export type AdminUserAuthorizeFunction = ((params?: {
+    /**
+   * Admin user performing the action.
+   */
     adminUser: AdminUser;
+    /**
+   * HTTP response object.
+   *
+   * @deprecated Since 1.2.9. Will be removed in 2.0.0. Use extra.response instead.
+   */
     response: IAdminForthHttpResponse;
+    /**
+     * Adminforth instance.
+     */
     adminforth: IAdminForth;
+    /**
+   * Extra HTTP information. Prefer using extra.response over the top-level response field.
+   */
     extra?: HttpExtra;
 }) => Promise<{
     error?: string;
@@ -830,6 +1151,7 @@ export interface AdminForthActionInput {
     name: string;
     showIn?: {
         list?: boolean;
+        listThreeDotsMenu?: boolean;
         showButton?: boolean;
         showThreeDotsMenu?: boolean;
     };
@@ -843,6 +1165,7 @@ export interface AdminForthActionInput {
         resource: AdminForthResource;
         recordId: string;
         adminUser: AdminUser;
+        response: IAdminForthHttpResponse;
         extra?: HttpExtra;
         tr: Function;
     }) => Promise<{
@@ -1014,7 +1337,7 @@ export interface AdminForthInputConfig {
         /**
          * Function to return avatar URL for user.
          */
-        avatarUrl?: ((adminUser: AdminUser) => string | Promise<string>);
+        avatarUrl?: ((adminUser: AdminUser) => string | Promise<string> | undefined | Promise<undefined>);
         /**
          * Remember me duration for "Remember Me" checkbox on login page.
          * If not set or set to null/undefined, "Remember Me" checkbox will not be displayed.
@@ -1051,7 +1374,7 @@ export interface AdminForthInputConfig {
         /**
          * Add custom page to the settings page
          */
-        userMenuSettingsPages: {
+        userMenuSettingsPages?: {
             icon?: string;
             pageLabel: string;
             slug?: string;
@@ -1153,6 +1476,8 @@ export declare class Filters {
     static LTE_FIELD(leftField: string, rightField: string): IAdminForthSingleFilter;
     static AND(...args: (IAdminForthSingleFilter | IAdminForthAndOrFilter | Array<IAdminForthSingleFilter | IAdminForthAndOrFilter>)[]): IAdminForthAndOrFilter;
     static OR(...args: (IAdminForthSingleFilter | IAdminForthAndOrFilter | Array<IAdminForthSingleFilter | IAdminForthAndOrFilter>)[]): IAdminForthAndOrFilter;
+    static IS_EMPTY(field: string): IAdminForthSingleFilter;
+    static IS_NOT_EMPTY(field: string): IAdminForthSingleFilter;
 }
 export type FDataSort = (field: string, direction: AdminForthSortDirections) => IAdminForthSort;
 export declare class Sorts {
@@ -1208,6 +1533,7 @@ export type AllowedActions = {
  * General options for resource.
  */
 export interface ResourceOptionsInput extends Omit<NonNullable<AdminForthResourceInputCommon['options']>, 'allowedActions' | 'bulkActions'> {
+    baseActionsAsQuickIcons?: ('show' | 'edit' | 'delete')[];
     /**
      * Custom bulk actions list. Bulk actions available in list view when user selects multiple records by
      * using checkboxes.
@@ -1359,10 +1685,11 @@ export interface AdminForthBulkAction extends AdminForthBulkActionCommon {
      * Callback which will be called on backend when user clicks on action button.
      * It should return Promise which will be resolved when action is done.
      */
-    action: ({ resource, selectedIds, adminUser, tr }: {
+    action: ({ resource, selectedIds, adminUser, response, tr }: {
         resource: AdminForthResource;
         selectedIds: Array<any>;
         adminUser: AdminUser;
+        response: IAdminForthHttpResponse;
         tr: (key: string, category?: string, params?: any) => string;
     }) => Promise<{
         ok: boolean;