adminforth 1.1.73 → 1.1.75

package/types/AdminForthConfig.ts

@@ -82,9 +82,113 @@ export interface AdminForthDataSourceConnector {
   /**
    * Function which will be called to fetch record from database.
    */
+  getRecordByPrimaryKeyWithOriginalTypes(resource: AdminForthResource, recordId: string): Promise<any>;
+
+
+  /**
+   * Function should go over all columns of table defined in resource.table and try to guess
+   * data and constraints for each columns. 
+   * Type should be saved to:
+   * -  {@link AdminForthResourceColumn.type}
+   * Constraints:
+   *  - {@link AdminForthResourceColumn.required}
+   *  - {@link AdminForthResourceColumn.primaryKey}
+   * For string fields:
+   *  - {@link AdminForthResourceColumn.maxLength}
+   * For numbers:
+   *  - {@link AdminForthResourceColumn.min}
+   *  - {@link AdminForthResourceColumn.max}
+   *  - {@link AdminForthResourceColumn.minValue}, {@link AdminForthResourceColumn.maxValue}, {@link AdminForthResourceColumn.enum}, {@link AdminForthResourceColumn.foreignResource}, {@link AdminForthResourceColumn.sortable}, {@link AdminForthResourceColumn.backendOnly}, {@link AdminForthResourceColumn.masked}, {@link AdminForthResourceColumn.virtual}, {@link AdminForthResourceColumn.components}, {@link AdminForthResourceColumn.allowMinMaxQuery}, {@link AdminForthResourceColumn.editingNote}, {@link AdminForthResourceColumn.showIn}, {@link AdminForthResourceColumn.isUnique}, {@link AdminForthResourceColumn.validation})
+   * Also you can additionally save original column type to {@link AdminForthResourceColumn._underlineType}. This might be later used
+   * in {@link AdminForthDataSourceConnector.getFieldValue} and {@link AdminForthDataSourceConnector.setFieldValue} methods.
+   * 
+   * 
+   * @param resource 
+   */
+  discoverFields(resource: AdminForthResource): Promise<{[key: string]: AdminForthResourceColumn}>;
+
+
+  /**
+   * Used to transform record after fetching from database.
+   * According to AdminForth convention, if {@link AdminForthResourceColumn.type} is set to {@link AdminForthDataTypes.DATETIME} then it should be transformed to ISO string.
+   * @param field 
+   * @param value 
+   */
+  getFieldValue(field: AdminForthResourceColumn, value: any): any;
+
+  /**
+   * Used to transform record before saving to database. Should perform operation inverse to {@link AdminForthDataSourceConnector.getFieldValue}
+   * @param field 
+   * @param value 
+   */
+  setFieldValue(field: AdminForthResourceColumn, value: any): any;
+
+  /**
+   * Used to fetch data from database.
+   * This method is reused both to list records and show one record (by passing limit 1 and offset 0) .
+   * 
+   * Fields are returned from db "as is" then {@link AdminForthBaseConnector.getData} will transform each field using {@link AdminForthDataSourceConnector.getFieldValue}
+   */
+  getDataWithOriginalTypes({ resource, limit, offset, sort, filters }: {
+    resource: AdminForthResource,
+    limit: number,
+    offset: number,
+    sort: { field: string, direction: AdminForthSortDirections }[], 
+    filters: { field: string, operator: AdminForthFilterOperators, value: any }[] 
+  }): Promise<{data: Array<any>, total: number}>;
+
+
+  /**
+   * Optional method which used to get min and max values for columns in resource.
+   * Called only for columns which have {@link AdminForthResourceColumn.allowMinMaxQuery} set to true.
+   * 
+   * Internally should call {@link AdminForthDataSourceConnector.getFieldValue} for both min and max values.
+   */
+  getMinMaxForColumnsWithOriginalTypes({ resource, columns }: { resource: AdminForthResource, columns: AdminForthResourceColumn[] }): Promise<{ [key: string]: { min: any, max: any } }>;
+
+
+  /**
+   * Used to create record in database.
+   */
+  createRecord({ resource, record }: { resource: AdminForthResource, record: any }): Promise<void>;
+
+  /**
+   * Used to update record in database.
+   * 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>;
+  
+  /**
+   * Used to delete record in database.
+   */
+  deleteRecord({ resource, recordId }: { resource: AdminForthResource, recordId: any }): Promise<void>;
+}
+
+
+/**
+ * Interface that exposes methods to interact with AdminForth in standard way
+ */
+export interface AdminForthDataSourceConnectorBase extends AdminForthDataSourceConnector {
+
+  getPrimaryKey(resource: AdminForthResource): string;
+
+  getData({ resource, limit, offset, sort, filters }: {
+    resource: AdminForthResource,
+    limit: number,
+    offset: number,
+    sort: { field: string, direction: AdminForthSortDirections }[],
+    filters: { field: string, operator: AdminForthFilterOperators, value: any }[]
+  }): Promise<{ data: Array<any>, total: number }>;
+
   getRecordByPrimaryKey(resource: AdminForthResource, recordId: string): Promise<any>;
+
+  getMinMaxForColumns({ resource, columns }: { resource: AdminForthResource, columns: AdminForthResourceColumn[] }): Promise<{ [key: string]: { min: any, max: any } }>;
 }
 
+
 export interface AdminForthDataSourceConnectorConstructor {
   new ({ url }: { url: string }): AdminForthDataSourceConnector;
 }
@@ -95,14 +199,13 @@ export interface AdminForthClass {
   express: GenericHttpServer;
 
   connectors: {
-    [key: string]: AdminForthDataSourceConnector,
+    [key: string]: AdminForthDataSourceConnectorBase;
   };
 
   createResourceRecord(params: { resource: AdminForthResource, record: any, adminUser: AdminUser }): Promise<any>;
 
   auth: {
     verify(jwt : string, mustHaveType: string): Promise<any>;
-
     issueJWT(payload: Object, type: string): string;
   }
 
@@ -425,21 +528,57 @@ export type AdminForthResourceColumn = {
      * Custom components which will be used to render this field in the admin panel.
      */
     components?: AdminForthFieldComponents
+
+    /**
+     * Maximum length of string that can be entered in this field.
+     */
     maxLength?: number, 
+
+    /**
+     * Minimum length of string that can be entered in this field.
+     */
     minLength?: number,
+
     min?: number,
     max?: number,
+
+    /**
+     * Minimum value that can be entered in this field.
+     */
     minValue?: number,
+
+    /**
+     * Maximum value that can be entered in this field.
+     */
     maxValue?: number,
+
+    /**
+     * Enum of possible values for this field.
+     */
     enum?: Array<AdminForthColumnEnumItem>,
+
+    /**
+     * Foreign resource which has pk column with values same that written in this column.
+     */
     foreignResource?:AdminForthForeignResource,
+
     sortable?: boolean,
-    backendOnly?: boolean, // if true field will not be passed to UI under no circumstances, but will be presented in hooks
+
+    /**
+     * if true field will !not be passed to UI under no circumstances, but will be presented in hooks
+     */
+    backendOnly?: boolean,
 
     /**
      * Masked fields will be displayed as `*****` on Edit and Create pages.
      */
     masked?: boolean,
+
+
+    /**
+     * Internal type which indicates original type of column in database.
+     */
+    _underlineType?: string,
 }
   
 
@@ -467,11 +606,17 @@ export type BeforeSaveFunction = (params:{resource: AdminForthResource, adminUse
  */
 export type AfterSaveFunction = (params: {resource: AdminForthResource, adminUser: AdminUser, record: any}) => Promise<{ok: boolean, error?: string}>;
 
+/**
+ * Allow to get user data before login confirmation, will triger when user try to login.
+ */
+export type BeforeLoginConfirmationFunction = (params?: { userRecord: AdminUser }) => Promise<{ok:boolean, error?:string, body:{setCookie?:[], redirectTo?: 'string', allowedLogin?: boolean   }}>;
 
 /**
  * Resource describes one table or collection in database.
  * AdminForth generates set of pages for 'list', 'show', 'edit', 'create', 'filter' operations for each resource.
  */
+
+
 export type AdminForthResource = {
     /**
      * Unique identifier of resource. By default it equals to table name in database. 
@@ -706,6 +851,13 @@ export type AdminForthConfig = {
        */
       loginBackgroundImage?: string,
 
+      /**
+       * 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>,
+
       /**
        * Optionally if your users table has a field(column) with full name, you can set it here.
        * This field will be used to display user name in the top right corner of the admin panel.
@@ -845,7 +997,15 @@ 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,
+      }>,
+    }
 
     /**
      * If you want to Serve AdminForth from a subdirectory, e.g. on example.com/backoffice, you can specify it like:
@@ -1095,4 +1255,5 @@ export type AdminForthForeignResource = {
         afterDatasourceResponse?: AfterDataSourceResponseFunction | Array<AfterDataSourceResponseFunction>,
       },
     },
-  }
+  }
+

package/dist/plugins/AuditLog/index.js

@@ -1,13 +0,0 @@
-import AdminForthPlugin from "../base.js";
-class AuditLogPlugin extends AdminForthPlugin {
-    constructor(options) {
-        super(options, import.meta.url);
-        this.options = options;
-    }
-    modifyResourceConfig(adminforth, resourceConfig) {
-        super.modifyResourceConfig(adminforth, resourceConfig);
-        this.adminforth = adminforth;
-    }
-}
-AuditLogPlugin.defaultError = 'Sorry, you do not have access to this resource.';
-export default AuditLogPlugin;

package/dist/spa/spa/.eslintrc.cjs

@@ -1,14 +0,0 @@
-/* eslint-env node */
-require('@rushstack/eslint-patch/modern-module-resolution')
-
-module.exports = {
-  root: true,
-  'extends': [
-    'plugin:vue/vue3-essential',
-    'eslint:recommended',
-    '@vue/eslint-config-typescript'
-  ],
-  parserOptions: {
-    ecmaVersion: 'latest'
-  }
-}

package/dist/spa/spa/.vscode/extensions.json

@@ -1,6 +0,0 @@
-{
-  "recommendations": [
-    "Vue.volar",
-    "dbaeumer.vscode-eslint"
-  ]
-}

package/dist/spa/spa/README.md

@@ -1,39 +0,0 @@
-# spa
-
-This template should help get you started developing with Vue 3 in Vite.
-
-## Recommended IDE Setup
-
-[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur).
-
-## Type Support for `.vue` Imports in TS
-
-TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) to make the TypeScript language service aware of `.vue` types.
-
-## Customize configuration
-
-See [Vite Configuration Reference](https://vitejs.dev/config/).
-
-## Project Setup
-
-```sh
-npm install
-```
-
-### Compile and Hot-Reload for Development
-
-```sh
-npm run dev
-```
-
-### Type-Check, Compile and Minify for Production
-
-```sh
-npm run build
-```
-
-### Lint with [ESLint](https://eslint.org/)
-
-```sh
-npm run lint
-```

package/dist/spa/spa/env.d.ts

@@ -1 +0,0 @@
-/// <reference types="vite/client" />

package/dist/spa/spa/index.html

@@ -1,23 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8">
-    <link rel="icon" href="/* IMPORTANT:ADMINFORTH FAVICON */">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>/* IMPORTANT:ADMINFORTH TITLE */</title>
-<!--     
-    <script>
-      // On page load or when changing themes, best to add inline in `head` to avoid FOUC
-      if (localStorage.getItem('color-theme') === 'dark' || (!('color-theme' in localStorage) && window.matchMedia('(prefers-color-scheme: dark)').matches)) {
-          document.documentElement.classList.add('dark');
-      } else {
-          document.documentElement.classList.remove('dark')
-      }
-  </script> -->
-
-  </head>
-  <body class=" ">
-    <div id="app" class="min-h-screen bg-lightHtml dark:bg-darkHtml"></div>
-    <script type="module" src="/src/main.ts"></script>
-  </body>
-</html>