Merge branch 'next' of github.com:devforth/adminforth into inline-create

Author: SerVitasik

adminforth/commands/createApp/templates/adminuser.ts.hbs

@@ -1,4 +1,5 @@
-import AdminForth, { AdminForthDataTypes, AdminForthResourceInput } from 'adminforth';
+import AdminForth, { AdminForthDataTypes, AdminForthResourceInput, AdminForthResource, AdminUser } from 'adminforth';
+
 import type { AdminUser } from  'adminforth';
 
 async function canModifyUsers({ adminUser }: { adminUser: AdminUser }): Promise<boolean> {
@@ -86,18 +87,19 @@ export default {
   ],
   hooks: {
     create: {
-      beforeSave: async ({ record, adminUser, resource }) => {
-        record.password_hash = await AdminForth.Utils.generatePasswordHash(record.password);
+      beforeSave: async ({ record, adminUser, resource }: { record: any, adminUser: AdminUser, resource: AdminForthResource }) => {
+        record.passwordHash = await AdminForth.Utils.generatePasswordHash(record.password);
         return { ok: true };
       }
     },
     edit: {
-      beforeSave: async ({ record, adminUser, resource }) => {
-        if (record.password) {
-          record.password_hash = await AdminForth.Utils.generatePasswordHash(record.password);
+      beforeSave: async ({ updates, adminUser, resource }: { updates: any, adminUser: AdminUser, resource: AdminForthResource }) => {
+        console.log('Updating user', updates);
+        if (updates.password) {
+          updates.passwordHash = await AdminForth.Utils.generatePasswordHash(updates.password);
         }
         return { ok: true }
       },
     },
-  }
+  },
 } as AdminForthResourceInput;

adminforth/dataConnectors/baseConnector.ts

@@ -72,7 +72,7 @@ export default class AdminForthBaseConnector implements IAdminForthDataSourceCon
     throw new Error('Method not implemented.');
   }
 
-  createRecordOriginalValues({ resource, record }: { resource: AdminForthResource; record: any; }): Promise<void> {
+  createRecordOriginalValues({ resource, record }: { resource: AdminForthResource; record: any; }): Promise<string> {
     throw new Error('Method not implemented.');
   }
 
@@ -94,6 +94,7 @@ export default class AdminForthBaseConnector implements IAdminForthDataSourceCon
     resource: AdminForthResource; record: any; adminUser: any;
   }): Promise<{ error?: string; ok: boolean; createdRecord?: any; }> {
     // transform value using setFieldValue and call createRecordOriginalValues
+
     const filledRecord = {...record};
     const recordWithOriginalValues = {...record};
 
@@ -106,9 +107,12 @@ export default class AdminForthBaseConnector implements IAdminForthDataSourceCon
           });
         }
       }
-      recordWithOriginalValues[col.name] = this.setFieldValue(col, filledRecord[col.name]);
+      if (filledRecord[col.name] !== undefined) {
+        // no sense to set value if it is not defined
+        recordWithOriginalValues[col.name] = this.setFieldValue(col, filledRecord[col.name]);
+      }
     }
-    
+
     let error: string | null = null;
     await Promise.all(
       resource.dataSourceColumns.map(async (col) => {
@@ -125,12 +129,17 @@ export default class AdminForthBaseConnector implements IAdminForthDataSourceCon
       return { error, ok: false };
     }
 
-    process.env.HEAVY_DEBUG && console.log('🪲🆕 creating record', recordWithOriginalValues);
-    await this.createRecordOriginalValues({ resource, record: recordWithOriginalValues });
+    process.env.HEAVY_DEBUG && console.log('🪲🆕 creating record',JSON.stringify(recordWithOriginalValues));
+    const pkValue = await this.createRecordOriginalValues({ resource, record: recordWithOriginalValues });
+
+    let createdRecord = recordWithOriginalValues;
+    if (pkValue) {
+      createdRecord = await this.getRecordByPrimaryKey(resource, pkValue);
+    }
 
     return {
       ok: true,
-      createdRecord: recordWithOriginalValues,
+      createdRecord,
     }
   }
 

adminforth/dataConnectors/clickhouse.ts

@@ -294,7 +294,7 @@ class ClickhouseConnector extends AdminForthBaseConnector implements IAdminForth
       }))
       return result;
     }
-    async createRecordOriginalValues({ resource, record }: { resource: AdminForthResource, record: any }) {
+    async createRecordOriginalValues({ resource, record }: { resource: AdminForthResource, record: any }): Promise<string> {
       const tableName = resource.table;
       const columns = Object.keys(record);
       await this.client.insert({
@@ -303,6 +303,7 @@ class ClickhouseConnector extends AdminForthBaseConnector implements IAdminForth
         columns: columns,
         values: [Object.values(record)],
       });
+      return ''; // todo
     }
 
     async updateRecordOriginalValues({ resource, recordId, newValues }: { resource: AdminForthResource, recordId: any, newValues: any }) {

adminforth/dataConnectors/mongo.ts

@@ -174,7 +174,7 @@ class MongoConnector extends AdminForthBaseConnector implements IAdminForthDataS
         return result;
     }
 
-    async createRecordOriginalValues({ resource, record }) {
+    async createRecordOriginalValues({ resource, record }): Promise<string> {
         const tableName = resource.table;
         const collection = this.client.db().collection(tableName);
         const columns = Object.keys(record);
@@ -183,6 +183,7 @@ class MongoConnector extends AdminForthBaseConnector implements IAdminForthDataS
             newRecord[colName] = record[colName];
         }
         await collection.insertOne(newRecord);
+        return ''; // todo
     }
 
     async updateRecordOriginalValues({ resource, recordId, newValues }) {

adminforth/dataConnectors/mysql.ts

@@ -257,7 +257,7 @@ class MysqlConnector extends AdminForthBaseConnector implements IAdminForthDataS
     return result;
   }
 
-  async createRecordOriginalValues({ resource, record }) {
+  async createRecordOriginalValues({ resource, record }): Promise<string> {
     const tableName = resource.table;
     const columns = Object.keys(record);
     const placeholders = columns.map(() => '?').join(', ');
@@ -267,6 +267,8 @@ class MysqlConnector extends AdminForthBaseConnector implements IAdminForthDataS
       console.log('🪲📜 MySQL Q:', q, 'values:', values);
     }
     await this.client.execute(q, values);
+
+    return ''; // todo
   }
 
   async updateRecordOriginalValues({ resource, recordId,  newValues }) {

adminforth/dataConnectors/postgres.ts

@@ -302,19 +302,21 @@ class PostgresConnector extends AdminForthBaseConnector implements IAdminForthDa
         return result;
     }
 
-    async createRecordOriginalValues({ resource, record }) {
+    async createRecordOriginalValues({ resource, record }): Promise<string> {
         const tableName = resource.table;
         const columns = Object.keys(record);
         const placeholders = columns.map((_, i) => `$${i + 1}`).join(', ');
         const values = columns.map((colName) => record[colName]);
         for (let i = 0; i < columns.length; i++) {
             columns[i] = `"${columns[i]}"`;
         }
-        const q = `INSERT INTO "${tableName}" (${columns.join(', ')}) VALUES (${placeholders})`;
+        const primaryKey = this.getPrimaryKey(resource);
+        const q = `INSERT INTO "${tableName}" (${columns.join(', ')}) VALUES (${placeholders}) RETURNING "${primaryKey}"`;
         if (process.env.HEAVY_DEBUG_QUERY) {
             console.log('🪲📜 PG Q:', q, 'values:', values);
         }
-        await this.client.query(q, values);
+        const ret = await this.client.query(q, values);
+        return ret.rows[0][primaryKey];
     }
 
     async updateRecordOriginalValues({ resource, recordId,  newValues }) {

adminforth/dataConnectors/sqlite.ts

@@ -235,13 +235,14 @@ class SQLiteConnector extends AdminForthBaseConnector implements IAdminForthData
       return result;
     }
 
-    async createRecordOriginalValues({ resource, record }: { resource: AdminForthResource, record: any }) {
+    async createRecordOriginalValues({ resource, record }: { resource: AdminForthResource, record: any }): Promise<string> {
       const tableName = resource.table;
       const columns = Object.keys(record);
       const placeholders = columns.map(() => '?').join(', ');
       const values = columns.map((colName) => record[colName]);
       const q = this.client.prepare(`INSERT INTO ${tableName} (${columns.join(', ')}) VALUES (${placeholders})`);
       await q.run(values);
+      return ''; // todo q.lastInsertRowid;
     }
 
     async updateRecordOriginalValues({ resource, recordId, newValues }: { resource: AdminForthResource, recordId: any, newValues: any }) {

adminforth/documentation/docs/tutorial/001-gettingStarted.md

@@ -77,7 +77,7 @@ myadmin/
 
 ### Initial Migration & Future Migrations
 
-> ☝️ CLI creates Prisma schema file for managing migrations in relational databases, however you are not forced to use it. Instead you are free to use your favourite or existing migration tool. In this case just ignore generated prisma file, and don't run migration command which will be suggested by CLI. However you have to ensure that your migration tool will generate required table `adminuser` with same fields and types for Users resource.
+> ☝️ CLI creates Prisma schema file for managing migrations in relational databases, however you are not forced to use it. Instead you are free to use your favourite or existing migration tool. In this case just ignore generated prisma file, and don't run migration command which will be suggested by CLI. However you have to ensure that your migration tool will generate required table `adminuser` with same fields and types for Admin Users resource to implmenet BackOffice authentication.
 
 CLI will suggest you a command to initialize the database with Prisma:
 

adminforth/documentation/docs/tutorial/01-helloWorld.md

@@ -343,6 +343,9 @@ cd ./custom
 npm init -y
 ```
 
+We will use this directory for all custom components. If you want to call your dir with other name then `custom`, just set [customComponentsDir option](/docs/api/Back/interfaces/AdminForthConfigCustomization/#customcomponentsdir)
+
+
 Also, for better development experience we recommend to create file `custom/tsconfig.json` with the following content:
 
 ```json

adminforth/documentation/docs/tutorial/02-glossary.md

@@ -9,13 +9,12 @@ It used to:
 * Make queries to get the list and show records
 * Make queries to modify data
 
-There might be several datasources in the system for various databases e.g. One 2 Mongo DBs and 1 Postgres DB. 
+There might be several datasources in the system for various databases e.g. One datasource to Mongo DBs and one to Postgres DB. 
 
 ## resource
 
-A [Resource](/docs/api/Back/interfaces/AdminForthResource.md) is a representation of a table or collection in AdminForth. One resource is one table in the database.
-It has a `name` which should match name in database, a datasource id, and a list of columns.
-Also it has various customization options. 
+A [Resource](/docs/api/Back/interfaces/AdminForthResource.md) is a AdminForth representation of a table or collection in database. One resource is one table in the database. Resource has `table` property which should be equal to the name of the table in the database.
+It has a datasource id to point to database, a  definition of list of columns and various customization options. 
 
 ## column
 
@@ -47,6 +46,7 @@ There are next [actions](/docs/api/Common/enumerations/AllowedActionsEnum.md):
 
 Hook is a optional async function which allows to inject in backend logic before executing the datasource query or after it. 
 Hooks exist for all database queries including data read queries like list, show, and data write queries like create, edit, delete.
+All AdminForth hooks are executed on the backend side only.
 
 ## allowedAction
 
@@ -56,8 +56,16 @@ returned false you can be sure that user attempt to perform the action or get th
 
 ## component
 
-Component is a Vue component which is used to add or modify UI elements in AdminForth. It can be used as a full custom page with a link in menu or as a part of the existing AdminForth page
+Component is a Vue frontend component which is used to add or modify UI elements in AdminForth. It can be used as a full custom page with a link in menu or as a part of the existing AdminForth page
 
 ## field
 
-The column in the record.
+Same to column, but considered in context of record.
+
+## Plugin
+
+Plugin is a class defined to extend AdminForth functionality. Plugin philosophy is to simply modify AdminForth config after it is defined by user. In other words, everything that could be done in config, can be done in plugin and vice versa.
+
+In same way, like config does it, plugins set own Frontend components and backend hooks to modify AdminForth behavior.
+
+The main difference is that plugin allows to simplify routine repeating tasks and reduce the amount of code in the config file and code of cusomtom components.