adminforth 1.3.54-next.9 → 1.3.55-next.2

package/dist/spa/src/types/AdminForthConfig.ts

@@ -1,4 +1,5 @@
-import { Express } from 'express';
+import type { Express } from 'express';
+import type { Writable } from 'stream';
 
 export interface ICodeInjector {
   srcFoldersToSync: Object;
@@ -13,6 +14,7 @@ export interface IConfigValidator {
 export interface IAdminForthHttpResponse {
     setHeader: (key: string, value: string) => void,
     setStatus: (code: number, message: string) => void,
+    blobStream: () => Writable,
 };
 
 /**
@@ -51,16 +53,18 @@ export interface IHttpServer {
 
 export type AdminUser = {
   /**
-   * primaryKey field value of user in table which is defined by {@link AdminForthConfig.auth.resourceId}
-   * or null if it is user logged in as {@link AdminForthConfig.rootUser}
+   * primaryKey field value of user in table which is defined by {@link AdminForthConfig.auth.usersResourceId}
    */
   pk: string | null,
 
   /**
-   * Username which takend from {@link AdminForthConfig.auth.usernameField} field in user resource {@link AdminForthConfig.auth.resourceId}
+   * Username which taken from {@link AdminForthConfig.auth.usernameField} field in user resource {@link AdminForthConfig.auth.usersResourceId}
    */
   username: string,
-  isRoot: boolean,
+
+  /**
+   * User record fetched from database, from resource defined in {@link AdminForthConfig.auth.usersResourceId}
+   */
   dbUser: any,
 }
 
@@ -90,6 +94,17 @@ export interface IExpressHttpServer extends IHttpServer {
   authorize(callable: Function): void;
 }
 
+export interface IAdminForthFilter {
+  field: string;
+  operator: AdminForthFilterOperators;
+  value: any;
+}
+
+export interface IAdminForthSort {
+  field: string, 
+  direction: AdminForthSortDirections 
+}
+
 export interface IAdminForthDataSourceConnector {
   
   /**
@@ -145,15 +160,21 @@ export interface IAdminForthDataSourceConnector {
    * 
    * Fields are returned from db "as is" then {@link AdminForthBaseConnector.getData} will transform each field using {@link IAdminForthDataSourceConnector.getFieldValue}
    */
-  getDataWithOriginalTypes({ resource, limit, offset, sort, filters, getTotals }: {
+  getDataWithOriginalTypes({ resource, limit, offset, sort, filters }: {
     resource: AdminForthResource,
     limit: number,
     offset: number,
-    sort: { field: string, direction: AdminForthSortDirections }[], 
-    filters: { field: string, operator: AdminForthFilterOperators, value: any }[],
-    getTotals?: boolean
-  }): Promise<{data: Array<any>, total: number}>;
+    sort: IAdminForthSort[], 
+    filters: IAdminForthFilter[],
+  }): Promise<Array<any>>;
 
+  /**
+   * Used to get count of records in database.
+   */
+  getCount({ resource, filters }: {
+    resource: AdminForthResource,
+    filters: IAdminForthFilter[],
+  }): Promise<number>;
 
   /**
    * Optional method which used to get min and max values for columns in resource.
@@ -170,18 +191,16 @@ export interface IAdminForthDataSourceConnector {
   createRecordOriginalValues({ resource, record }: { resource: AdminForthResource, record: any }): Promise<void>;
 
   /**
-   * Used to update record in database.
+   * Update record in database. newValues might have not all fields in record, but only changed ones.
    * recordId is value of field which is marked as {@link AdminForthResourceColumn.primaryKey}
-   * newValues is array of fields which should be updated (might be not all fields in record, but only changed fields).
    */
-  updateRecord({ resource, recordId, newValues }:
-    { resource: AdminForthResource, recordId: string, newValues: any }
-  ): Promise<void>;
-  
+  updateRecordOriginalValues({ resource, recordId, newValues }: { resource: AdminForthResource; recordId: string; newValues: any; }): Promise<void>;
+
+
   /**
    * Used to delete record in database.
    */
-  deleteRecord({ resource, recordId }: { resource: AdminForthResource, recordId: any }): Promise<void>;
+  deleteRecord({ resource, recordId }: { resource: AdminForthResource, recordId: any }): Promise<boolean>;
 }
 
 
@@ -196,27 +215,40 @@ export interface IAdminForthDataSourceConnectorBase extends IAdminForthDataSourc
     resource: AdminForthResource,
     limit: number,
     offset: number,
-    sort: { field: string, direction: AdminForthSortDirections }[],
-    filters: { field: string, operator: AdminForthFilterOperators, value: any }[]
+    sort: IAdminForthSort[],
+    filters: IAdminForthFilter[],
+    getTotals?: boolean,
   }): Promise<{ data: Array<any>, total: number }>;
 
   getRecordByPrimaryKey(resource: AdminForthResource, recordId: string): Promise<any>;
 
+  createRecord({ resource, record, adminUser }: { 
+    resource: AdminForthResource, 
+    record: any 
+    adminUser: AdminUser
+  }): Promise<{ok: boolean, error?: string, createdRecord?: any}>;
+
+  updateRecord({ resource, recordId, newValues }: { 
+    resource: AdminForthResource, 
+    recordId: string, 
+    newValues: any, 
+  }): Promise<{ok: boolean, error?: string}>;
+
   getMinMaxForColumns({ resource, columns }: { resource: AdminForthResource, columns: AdminForthResourceColumn[] }): Promise<{ [key: string]: { min: any, max: any } }>;
 }
 
 
 export interface IAdminForthDataSourceConnectorConstructor {
-  new ({ url }: { url: string }): IAdminForthDataSourceConnector;
+  new ({ url }: { url: string }): IAdminForthDataSourceConnectorBase;
 }
 
 export interface IAdminForthAuth {
-  verify(jwt : string, mustHaveType: string): Promise<any>;
-  issueJWT(payload: Object, type: string): string;
+  verify(jwt : string, mustHaveType: string, decodeUser?: boolean): Promise<any>;
+  issueJWT(payload: Object, type: string, expiresIn?: string): string;
 
   removeCustomCookie({response, name}: {response: any, name: string}): void;
 
-  setAuthCookie({response, username, pk,}: {response: any, username: string, pk: string}): void;
+  setAuthCookie({expireInDays, response, username, pk,}: {expireInDays?: number, response: any, username: string, pk: string}): void;
   
   removeAuthCookie(response: any): void;
 }
@@ -238,7 +270,17 @@ export interface IAdminForth {
     [key: string]: IAdminForthDataSourceConnectorBase;
   };
 
-  createResourceRecord(params: { resource: AdminForthResource, record: any, adminUser: AdminUser }): Promise<any>;
+  createResourceRecord(
+    params: { resource: AdminForthResource, record: any, adminUser: AdminUser }
+  ): Promise<{ error?: string, createdRecord?: any }>;
+
+  updateResourceRecord(
+    params: { resource: AdminForthResource, recordId: any, record: any, oldRecord: any, adminUser: AdminUser }
+  ): Promise<{ error?: string }>;
+
+  deleteResourceRecord(
+    params: { resource: AdminForthResource, recordId: string, adminUser: AdminUser, record: any }
+  ): Promise<{ error?: string }>;
 
   auth: IAdminForthAuth;
 
@@ -263,6 +305,11 @@ export interface IAdminForth {
    */
   bundleNow({ hotReload, verbose }: { hotReload: boolean, verbose: boolean }): Promise<void>;
 
+  /**
+   * Resource to get access to operational resources for data api fetching and manipulation.
+   */
+  resource(resourceId: string): IOperationalResource;
+
   /**
    * This method will be automatically called from AdminForth HTTP adapter to serve AdminForth SPA.
    */
@@ -277,6 +324,15 @@ export interface IAdminForthPlugin {
   pluginInstanceId: string;
   customFolderPath: string;
   pluginOptions: any;
+  resourceConfig: AdminForthResource;
+  className: string;
+
+  /**
+   * Before activating all plugins are sorted by this number and then activated in order.
+   * If you want to make sure that your plugin is activated after some other plugin, set this number to higher value. (default is 0)
+   */
+  activationOrder: number;
+
 
   /**
    * AdminForth plugins concept is based on modification of full AdminForth configuration
@@ -461,6 +517,12 @@ export type AdminForthConfigMenuItem = {
      * You can use it to hide menu items depending on some user
      */
     visible?: (user: AdminUser) => boolean,
+
+    /**
+     * Optional callback which will be called before rendering the menu for each item.
+     * Result of callback if not null will be used as a small badge near the menu item.
+     */
+    badge?: string | ((user: AdminUser) => Promise<string>),
   }
   
 
@@ -529,6 +591,10 @@ export type AdminForthResourceColumn = {
      */
     isUnique?: boolean,
 
+    /**
+     * Will automatically convert any capital letters to lowercase in input during editing
+     */
+    enforceLowerCase?: boolean,
 
     /**
      * Runtime validation Regexp rules for this field.
@@ -650,13 +716,13 @@ export type AfterDataSourceResponseFunction = (params: {resource: AdminForthReso
  * 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 BeforeSaveFunction = (params:{resource: AdminForthResource, adminUser: AdminUser, record: any}) => Promise<{ok: boolean, error?: string}>;
+export type BeforeSaveFunction = (params: {resource: AdminForthResource, recordId: any, adminUser: AdminUser, record: any, oldRecord?: any}) => Promise<{ok: boolean, 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 AfterSaveFunction = (params: {resource: AdminForthResource, adminUser: AdminUser, record: any}) => Promise<{ok: boolean, error?: string}>;
+export type AfterSaveFunction = (params: {resource: AdminForthResource, recordId: any, adminUser: AdminUser, record: any, oldRecord?: any}) => Promise<{ok: boolean, error?: string}>;
 
 /**
  * Allow to get user data before login confirmation, will triger when user try to login.
@@ -692,13 +758,17 @@ export type AdminForthBulkAction = {
    * 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 }: { resource: AdminForthResource, selectedIds: Array<any>, adminUser: AdminUser }) => Promise<{ ok: boolean, error?: string }>,
+  action: ({ resource, selectedIds, adminUser }: { resource: AdminForthResource, selectedIds: Array<any>, adminUser: AdminUser }) => Promise<{ ok: boolean, error?: string, successMessage?: string }>,
 
   /**
    * Confirmation message which will be displayed to user before action is executed.
    */
   confirm?: string,
 
+  /**
+   * Success message which will be displayed to user after action is executed.
+   */
+  successMessage?: string,
   /**
    * Allowed callback called to check whether action is allowed for user.
    * 1. It called first time when user goes to list view. If callback returns false, action button will be hidden on list view.
@@ -710,7 +780,7 @@ export type AdminForthBulkAction = {
    * 
    * ```ts
    * allowed: async ({ resource, adminUser, selectedIds }) => {
-   *   if (adminUser.isRoot || adminUser.dbUser.role !== 'superadmin') {
+   *   if (adminUser.dbUser.role !== 'superadmin') {
    *    return false;
    *   } 
    *   return true;
@@ -752,7 +822,7 @@ export type AdminForthBulkAction = {
      *   ],
      *   allowedActions: \{
      *     edit: (\{ resource, adminUser, recordIds \}) => \{
-     *       return adminUser.isRoot || adminUser.dbUser.role === 'superadmin';
+     *       return adminUser.dbUser.role === 'superadmin';
      *     \}
      *   \}
      * \}
@@ -798,7 +868,9 @@ export type AdminForthResource = {
      */
     columns: Array<AdminForthResourceColumn>,
 
-    
+    /**
+     * Internal array of columns which are not virtual. You should not edit it. 
+     */
     dataSourceColumns?: Array<AdminForthResourceColumn>,  // TODO, mark as private
 
     /**
@@ -818,25 +890,79 @@ export type AdminForthResource = {
      * 
      */
     plugins?: Array<IAdminForthPlugin>,
+
+    /**
+     * Hooks allow you to change the data on different stages of resource lifecycle.
+     * Hooks are functions which will be called on backend side (only backend side).
+     */
     hooks?: {
       show?: {
+        /**
+         * Typical usecases: 
+         * - request additional data from database before returning to frontend for soft-join 
+         */
         beforeDatasourceRequest?: BeforeDataSourceRequestFunction | Array<BeforeDataSourceRequestFunction>,
+
+        /**
+         * Typical usecases:
+         * - Transform value for some field for record returned from database before returning to frontend (minimize, sanitize, etc)
+         * - If some-why you can't use `backendOnly` you can cleanup sensitive fields here
+         * - Attach additional data to record before returning to frontend 
+         */
         afterDatasourceResponse?: AfterDataSourceResponseFunction | Array<AfterDataSourceResponseFunction>,
       },
       list?: {
+        /**
+         * Typical usecases:
+         * - add additional filters in addition to what user selected before fetching data from database.
+         * - same as hooks.show.beforeDatasourceRequest 
+         */
         beforeDatasourceRequest?: BeforeDataSourceRequestFunction | Array<BeforeDataSourceRequestFunction>,
+
+        /**
+         * Typical usecases:
+         * - Same as hooks.show.afterDatasourceResponse but applied for each record in list
+         */
         afterDatasourceResponse?: AfterDataSourceResponseFunction | Array<AfterDataSourceResponseFunction>,
       },
       create?: {
+        /**
+         * Typical usecases:
+         * - Validate record before saving to database and interrupt execution if validation failed (`allowedActions.create` should be preferred in most cases)
+         * - fill-in adminUser as creator of record
+         * - Attach additional data to record before saving to database (mostly fillOnCreate should be used instead)
+         */
         beforeSave?: BeforeSaveFunction | Array<BeforeSaveFunction>,
+
+        /**
+         * Typical usecases:
+         * - Initiate some trigger after record saved to database (e.g sync to another datasource)
+         */
         afterSave?: AfterSaveFunction | Array<AfterSaveFunction>,
       },
       edit?: {
+        /**
+         * Typical usecases:
+         * - Same as hooks.create.beforeSave but for edit page
+         */
         beforeSave?: BeforeSaveFunction | Array<BeforeSaveFunction>,
+
+        /**
+         * Typical usecases:
+         * - Same as hooks.create.afterSave but for edit page
+         */
         afterSave?: AfterSaveFunction | Array<AfterSaveFunction>,
       },
       delete?: {
+        /**
+         * Typical usecases:
+         * - Validate that record can be deleted and interrupt execution if validation failed (`allowedActions.delete` should be preferred in most cases)
+         */
         beforeSave?: BeforeSaveFunction | Array<BeforeSaveFunction>,
+        /**
+         * Typical usecases:
+         * - Initiate some trigger after record deleted from database (e.g sync to another datasource)
+         */
         afterSave?: BeforeSaveFunction | Array<BeforeSaveFunction>,
       },
     },
@@ -889,8 +1015,8 @@ export type AdminForthResource = {
        * ```ts
        * allowedActions: {
        *  create: ({ resource, adminUser }) => {
-       *    // Allow only superadmin or root user to create records
-       *    return adminUser.isRoot || adminUser.dbUser.role === 'superadmin';
+       *    // Allow only superadmin to create records
+       *    return adminUser.dbUser.role === 'superadmin';
        *  },
        *  delete: false, // disable delete action for all users
        * }
@@ -904,6 +1030,34 @@ export type AdminForthResource = {
        */
       listPageSize?: number,
 
+      /**
+       * Callback to define what happens when user clicks on record in list view.
+       * By default show view will be opened.
+       * If you wish to open custom page, return URL to the custom page (can start with https://, or relative adminforth path)
+       * If you wish to open page in new tab, add `target=_blank` get param to returned URL, example:
+       * 
+       * ```ts
+       * listTableClickUrl: async (record, adminUser) => {
+       *   return `https://google.com/search?q=${record.name}&target=_blank`;
+       * }
+       * ```
+       * 
+       * If you wish to do nothing on click, return null.
+       * 
+       * Example:
+       * 
+       * ```ts
+       * listTableClickUrl: async (record, adminUser) => {
+       *   return null;
+       * }
+       * ```
+       * 
+       * @param record - record which was clicked
+       * @param adminUser - user who clicked
+       * @returns 
+       */
+      listTableClickUrl?: (record: any, adminUser: AdminUser) => Promise<string | null>,
+
       /** 
        * Custom components which can be injected into AdminForth CRUD pages.
        * Each injection is a path to a custom component which will be displayed in the admin panel.
@@ -922,6 +1076,8 @@ export type AdminForthResource = {
        * 
        */
       pageInjections?: {
+
+
         /**
          * Custom components which can be injected into resource list page.
          * 
@@ -931,6 +1087,8 @@ export type AdminForthResource = {
           beforeBreadcrumbs?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
           afterBreadcrumbs?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
           bottom?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
+          threeDotsDropdownItems?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
+          customActionIcons?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
         },
 
         /**
@@ -942,6 +1100,7 @@ export type AdminForthResource = {
           beforeBreadcrumbs?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
           afterBreadcrumbs?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
           bottom?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
+          threeDotsDropdownItems?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
         },
 
         /**
@@ -953,6 +1112,7 @@ export type AdminForthResource = {
           beforeBreadcrumbs?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
           afterBreadcrumbs?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
           bottom?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
+          threeDotsDropdownItems?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
         },
 
         /**
@@ -964,6 +1124,7 @@ export type AdminForthResource = {
           beforeBreadcrumbs?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
           afterBreadcrumbs?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
           bottom?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
+          threeDotsDropdownItems?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
         },
       }
     },
@@ -995,33 +1156,21 @@ export type AdminForthDataSource = {
  */
 export type AdminForthConfig = {
 
-    /**
-     * Root user should be used to login to the admin panel first time.
-     * Then you should create User for yourself using AdminForth (so it will be persisted in DB), 
-     * and then disable this option as it is less secure
-     */
-    rootUser?: {
-      /**
-       * Username for root user
-       */
-      username: string,
-
-      /**
-       * Password for root user
-       */
-      password: string,
-    },
-
     /**
      * Authorization module configuration
      */
     auth?: {
       /**
-       * Resource ID for user resource. 
+       * Resource ID for resource which stores user table.
        * Resource is a table in database where users will be stored and fetched from. Resources and their ids are defined in resources section of the config.
        * In other words this setting is a reference to a table in database where users will be fetched from on login. 
        */
-      resourceId: string,
+      usersResourceId?: string,
+
+      /**
+       * Legacy field left for backward compatibility. Use usersResourceId instead.
+       */
+      resourceId?: string,
 
       /**
        * Field name (column name) in user resource which will be used as username for searching user in database during login.
@@ -1046,11 +1195,20 @@ export type AdminForthConfig = {
        */
       loginBackgroundImage?: string,
 
+
+      /**
+       * Position of background image on login page
+       * 'over' - image will be displayed over full login page under login form
+       * '1/2' - image will be displayed on left 1/2 of login page
+       * 
+       * Default: '1/2'
+       */
+      loginBackgroundPosition?: 'over' | '1/2' | '1/3' | '2/3' | '3/4' | '2/5' | '3/5',
+
       /**
        * Function or functions  which will be called before user try to login.
        * Each function will resive User object as an argument
        */
-
       beforeLoginConfirmation?: BeforeLoginConfirmationFunction | Array<BeforeLoginConfirmationFunction>,
 
       /**
@@ -1069,6 +1227,13 @@ export type AdminForthConfig = {
        * Any prompt to show users on login. Supports HTML.
        */
       loginPromptHTML?: string,
+
+      /**
+       * Remember me days for "Remember Me" checkbox on login page.
+       * If not set or set to null/0/undefined, "Remember Me" checkbox will not be displayed.
+       * If rememberMeDays is set, then users who check "Remember Me" will be staying logged in for this amount of days.
+       */
+      rememberMeDays?: number,
     },
      /**
       * Array of resources which will be displayed in the admin panel.
@@ -1110,6 +1275,13 @@ export type AdminForthConfig = {
        */
       brandName?: string,
 
+
+      /**
+       * Whether to show brand name in sidebar
+       * default is true
+       */
+      showBrandNameInSidebar?: boolean,
+
       /**
        * Path to your app logo
        * 
@@ -1136,10 +1308,17 @@ export type AdminForthConfig = {
       favicon?: string,
 
       /**
-       * DayJS format string for all dates in the app
+       * DayJS format string for all dates in the app.
+       * Defaulted to 'MMM D, YYYY'
        */
       datesFormat?: string,
 
+      /**
+       * DayJS format string for all datetimes in the app.
+       * Defaulted to 'HH:mm:ss'
+       */
+      timeFormat?: string,
+
       /**
        * HTML title tag value, defaults to brandName
        */
@@ -1205,14 +1384,39 @@ export type AdminForthConfig = {
        * Object to redefine default styles for AdminForth components.  Use this file as reference for all possible adjustments https://github.com/devforth/adminforth/blob/main/adminforth/modules/styles.ts
        */
       styles?: Object,
+
       /**
        * Description of custom pages which will let register custom pages for custom routes in AdminForth.
        */
-
       customPages?: Array<{
         path: string,
         component: AdminForthComponentDeclaration,
       }>,
+
+      /**
+       * Function to return custom badge in side bar for users. Can return text or html
+       * If function is not passed or returns null, badge will not be shown.
+       * Execution is done on admin app load. 
+       */
+      announcementBadge?: (user: AdminUser) => { text?: string, html?: string, closable?: boolean, title?: string } | null,
+      
+      /**
+       * Custom panel components or array of components which will be displayed in the login form 
+       * right after the inputs. Use it to add custom authorization methods like social login or other custom fields e.g. 'reset' 
+       * password link.
+       */
+      loginPageInjections?: {
+        underInputs?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
+      }
+
+      /**
+       * Custom panel components or array of components which will be displayed in different parts of the admin panel.
+       */
+      globalInjections?: {
+        userMenu?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
+        header?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
+        sidebar?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
+      }
     }
 
     /**
@@ -1224,11 +1428,77 @@ export type AdminForthConfig = {
      * 
      */
     baseUrl?: string,
-   
+    
+    
+    /**
+     * Whether to show delete confirmation dialog before deleting record.
+     * By default it is true.
+     */
     deleteConfirmation?: boolean,
     
    
 }
+
+// define typescript objects which I can instantiate as Filters.EQ(field, value) and they woudl
+// return { field: field, operator: 'eq', value: value }. They should be exported with Filters namespace so I can import Filters from this file
+// and use Filters.EQ(field, value) in my code
+
+export type FDataFilter = (field: string, value: any) => IAdminForthFilter;
+
+export class Filters {
+  static EQ(field: string, value: any): IAdminForthFilter {
+    return { field, operator: AdminForthFilterOperators.EQ, value };
+  }
+  static NEQ(field: string, value: any): IAdminForthFilter {
+    return { field, operator: AdminForthFilterOperators.NE, value };
+  }
+  static GT(field: string, value: any): IAdminForthFilter {
+    return { field, operator: AdminForthFilterOperators.GT, value };
+  }
+  static GTE(field: string, value: any): IAdminForthFilter {
+    return { field, operator: AdminForthFilterOperators.GTE, value };
+  }
+  static LT(field: string, value: any): IAdminForthFilter {
+    return { field, operator: AdminForthFilterOperators.LT, value };
+  }
+  static LTE(field: string, value: any): IAdminForthFilter {
+    return { field, operator: AdminForthFilterOperators.LTE, value };
+  }
+  static IN(field: string, value: any): IAdminForthFilter {
+    return { field, operator: AdminForthFilterOperators.IN, value };
+  }
+  static NOT_IN(field: string, value: any): IAdminForthFilter {
+    return { field, operator: AdminForthFilterOperators.NIN, value };
+  }
+  static LIKE(field: string, value: any): IAdminForthFilter {
+    return { field, operator: AdminForthFilterOperators.LIKE, value };
+  }
+}
+
+export type FDataSort = (field: string, direction: AdminForthSortDirections) => IAdminForthSort;
+
+export class Sorts {
+  static ASC(field: string): IAdminForthSort {
+    return { field, direction: AdminForthSortDirections.asc };
+  }
+  static DESC(field: string): IAdminForthSort {
+    return { field, direction: AdminForthSortDirections.desc };
+  }
+}
+
+export interface IOperationalResource {
+  get: (filter: IAdminForthFilter | IAdminForthFilter[]) => Promise<any | null>;
+
+  list: (filter: IAdminForthFilter | IAdminForthFilter[], limit?: number, offset?: number, sort?: IAdminForthSort | IAdminForthSort[]) => Promise<any[]>;
+
+  count: (filter: IAdminForthFilter | IAdminForthFilter[] | undefined) => Promise<number>;
+
+  create: (record: any) => Promise<{ ok: boolean; createdRecord: any; error?: string; }>;
+
+  update: (primaryKey: any, record: any) => Promise<any>;
+
+  delete: (primaryKey: any) => Promise<boolean>;
+}
   
 
 export enum AllowedActionsEnum {
@@ -1303,6 +1573,21 @@ export type ValidationObject = {
      * Example: "Invalid email format"
      */
     message: string,
+
+    /**
+     * Whether to check case sensitivity (i flag)
+     */
+    caseSensitive?: boolean,
+    
+    /**
+     * Whether to check Multiline strings (m flag)
+     */
+    multiline?: boolean, 
+    
+    /**
+     * Whether to check global strings (g flag)
+     */
+    global?: boolean
   }
 
 export type AdminForthComponentDeclarationFull = {