adminforth 1.2.99 → 1.2.100

package/types/AdminForthConfig.ts

@@ -51,16 +51,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,
 }
 
@@ -220,7 +222,11 @@ export interface IAdminForthDataSourceConnectorBase extends IAdminForthDataSourc
 
   getRecordByPrimaryKey(resource: AdminForthResource, recordId: string): Promise<any>;
 
-  createRecord({ resource, record }: { resource: AdminForthResource, record: any }): Promise<void>;
+  createRecord({ resource, record, adminUser }: { 
+    resource: AdminForthResource, 
+    record: any 
+    adminUser: AdminUser
+  }): Promise<{ok: boolean, error?: string, createdRecord?: any}>;
 
   getMinMaxForColumns({ resource, columns }: { resource: AdminForthResource, columns: AdminForthResourceColumn[] }): Promise<{ [key: string]: { min: any, max: any } }>;
 }
@@ -258,7 +264,9 @@ 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<{ ok: boolean, error?: string, createdRecord?: any }>;
 
   auth: IAdminForthAuth;
 
@@ -563,6 +571,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.
@@ -684,13 +696,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}) => 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}) => Promise<{ok: boolean, error?: string}>;
 
 /**
  * Allow to get user data before login confirmation, will triger when user try to login.
@@ -744,7 +756,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;
@@ -786,7 +798,7 @@ export type AdminForthBulkAction = {
      *   ],
      *   allowedActions: \{
      *     edit: (\{ resource, adminUser, recordIds \}) => \{
-     *       return adminUser.isRoot || adminUser.dbUser.role === 'superadmin';
+     *       return adminUser.dbUser.role === 'superadmin';
      *     \}
      *   \}
      * \}
@@ -979,8 +991,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
        * }
@@ -1085,33 +1097,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.
@@ -1136,6 +1136,16 @@ 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
@@ -1199,6 +1209,13 @@ export type AdminForthConfig = {
        */
       brandName?: string,
 
+
+      /**
+       * Whether to show brand name in sidebar
+       * default is true
+       */
+      showBrandNameInSidebar?: boolean,
+
       /**
        * Path to your app logo
        * 
@@ -1322,6 +1339,10 @@ export type AdminForthConfig = {
     baseUrl?: string,
     
     
+    /**
+     * Whether to show delete confirmation dialog before deleting record.
+     * By default it is true.
+     */
     deleteConfirmation?: boolean,
     
    
@@ -1375,13 +1396,13 @@ export class Sorts {
 }
 
 export interface IOperationalResource {
-  get: (filter: IAdminForthFilter | IAdminForthFilter[]) => Promise<any[]>;
+  get: (filter: IAdminForthFilter | IAdminForthFilter[]) => Promise<any | null>;
 
   list: (filter: IAdminForthFilter | IAdminForthFilter[], limit: number, offset: number, sort: IAdminForthSort | IAdminForthSort[]) => Promise<any[]>;
 
   count: (filter: IAdminForthFilter | IAdminForthFilter[]) => Promise<number>;
 
-  create: (record: any) => Promise<any>;
+  create: (record: any) => Promise<{ ok: boolean; createdRecord: any; error?: string; }>;
 
   update: (primaryKey: any, record: any) => Promise<any>;