Merge branch 'next' of github.com:devforth/adminforth into feature/AdminForth/893/bug-with-login-via-google

Author: SerVitasik

README.md

@@ -1,4 +1,4 @@
-# AdminForth - fully free Node.js admin panel framework on Vue & Tailwind
+# AdminForth - free powerfull Node.js admin panel framework on Vue & Tailwind
 
 
 <a href="https://adminforth.dev"><img src="https://img.shields.io/badge/website-adminforth.dev-blue" style="height:24px"/></a> <a href="https://adminforth.dev"><img src="https://img.shields.io/npm/dw/adminforth" style="height:24px"/></a> <a href="https://devforth.io"><img src="https://raw.githubusercontent.com/devforth/OnLogs/e97944fffc24fec0ce2347b205c9bda3be8de5c5/.assets/df_powered_by.svg" style="height:28px"/></a>
@@ -20,12 +20,15 @@
 <br/>
 
 Why AdminForth:
-* AdminForth is always free and open-source (no paid versions, no cloud subscriptions sh*t)
-* Init AdminForth with your database URL in Node.js file, easily describe the tables you wish to see in admin, and get fully functional UI for your data (filter, create, edit, remove)
-* Define Vue components to change look of various parts of admin (place in data cell, instead of row, add something above the table, inject something to header or sidebar, add custom page with charts or custom components)
-* Rich build-in Components library (AdminForth AFCL) with premade easy-to-use build-blocks which follow your theme
+
+* Init AdminForth project with `npx adminforth create-app` and pass your database URL, import the tables you wish to see in admin using `npx adminforth resource`, and get fully functional UI for your data (filter, create, edit, remove)
+* Modern look and simple Tailwind-ish ability to adjust it
+* Supports Postgres, MySQL, Mongo, SQLite, Clickhouse
+* Define Vue components to change look of various parts of admin using `npx adminforth component` (edit data cells, edit fields, add something above the table, inject something to header or sidebar, add custom page with charts or custom components)
+* Build-in Components library (AdminForth AFCL) with premade easy-to-use build-blocks which follow your theme
 * Define express APIs and call them from your components and pages
-* Use various modern back-office-must-have plugins like audit log, files/image upload, TOTP 2FA, I18N, Copilot-style AI writing and image generation
+* Use various modern back-office-must-have plugins like audit log, files/image upload, TOTP 2FA, I18N, Copilot-style AI writing and image generation and many more
+* AdminForth is always free and open-source (no paid versions, no cloud subscriptions sh*t)
 
 
 ## Project initialisation
@@ -79,6 +82,9 @@ npm run install-plugins
 npm run install-adapters
 
 npm ci
+
+./run_inventory.sh
+
 npm run migrate:local
 npm start
 ```
@@ -117,4 +123,4 @@ Then, go to testing app, e.g. created with CLI, and use next command:
 npx -g adminforth <your command under development>
 ```
 
-This will always run latest version of adminforth package.
+This will always run latest version of adminforth package.

adminforth/documentation/blog/authors.yml

@@ -4,7 +4,7 @@ ivanb:
   url: https://github.com/ivictbor
   image_url: https://avatars.githubusercontent.com/u/1838656?v=4
 mpipkun:
-  name: Maxim Pypkun
+  name: Maksym Pipkun
   title: Developer of AdminForth
   url: https://github.com/NoOne7135
   image_url: https://avatars.githubusercontent.com/u/120279695?v=4
@@ -22,4 +22,4 @@ kirilldorr:
   name: Kyrylo Doropii
   title: DevOps Engineer of AdminForth
   url: https://github.com/kirilldorr
-  image_url: https://avatars.githubusercontent.com/u/181721742?s=96&v=4
+  image_url: https://avatars.githubusercontent.com/u/181721742?s=96&v=4

adminforth/documentation/docs/tutorial/03-Customization/04-hooks.md

@@ -137,7 +137,7 @@ For example we can prevent the user to see Apartments created by other users. Su
         }
 
         // this function will skip existing realtor_id filter if it supplied already from UI or previous hook, and will add new one for realtor_id
-        query.filterTools.replaceOrAddTopFilter(Filters.EQ('realtor_id', adminUser.dbUser.id).
+        query.filterTools.replaceOrAddTopFilter(Filters.EQ('realtor_id', adminUser.dbUser.id)
 
         return { ok: true };
       },

adminforth/documentation/docs/tutorial/03-Customization/15-afcl.md

@@ -333,6 +333,26 @@ import { IconSearchOutline } from '@iconify-prerendered/vue-flowbite'
   </div>
 </div>
 
+## Textarea
+<div class="split-screen" >
+  <div >
+```ts
+import { Textarea } from '@/afcl'
+```
+
+```ts
+    <Textarea
+      v-model="textAreaInput"
+      placeholder="Enter some text..."
+      class="w-64"
+    />
+```
+  </div>
+  <div>
+    ![AFCL Textarea](textarea.png)
+  </div>
+</div>
+
 ## Tooltip
 
 Wrap an element on which you would like to show a tooltip with the `Tooltip` component and add a `tooltip` slot to it.

adminforth/documentation/docs/tutorial/03-Customization/textarea.png

@@ -0,0 +1,163 @@
+# Email Invite
+
+Email Invite plugin allows administrators to create users without setting passwords. Instead, the plugin sends an email invitation to the newly created user, asking them to set their own password. This is more secure and user-friendly than having administrators set passwords for users.
+
+## Installation
+
+To install the plugin:
+
+```bash
+npm install @adminforth/email-invite --save
+```
+
+You'll also need an email adapter. For AWS SES:
+
+```bash
+npm install @adminforth/email-adapter-aws-ses --save
+```
+
+## SES
+
+To Setup SES, you need to have an AWS account and SES service enabled. You can follow the steps below to setup SES.
+
+1. Go to the AWS Management Console and open the Amazon SES console at [https://console.aws.amazon.com/ses/](https://console.aws.amazon.com/ses/).
+2. Make sure you are in the correct region. You can change the region from the top right corner. For example, if you are in the `us-east-1` region, you can see the region name US East (N. Virginia) in the top right corner.
+
+3. Add your email address (any email), and verify it.
+4. Add some domain you own and verify it by creating DNS records which AWS suggests. This will be used as the domain for sending emails. e.g. if you want to send from no-reply@devforth.io you need to verify `devforth.io`. 
+
+## Basic Usage
+
+```typescript title="./resources/adminuser.ts"
+import EmailInvitePlugin from '@adminforth/email-invite';
+import EmailAdapterAwsSes from '@adminforth/email-adapter-aws-ses';
+
+export default {
+  dataSource: 'maindb',
+  table: 'adminuser',
+  resourceId: 'adminuser',
+  columns: [
+    { name: 'id', primaryKey: true },
+    { name: 'email', required: true },
+    { name: 'password_hash', showIn: [] }, // Hide from UI
+
+    { name: 'role' },
+
+    {
+          name: 'password',
+          virtual: true,
+          required: { create: true },
+          editingNote: { edit: 'Leave empty to keep password unchanged' },
+          minLength: 8,
+          type: AdminForthDataTypes.STRING,
+          showIn: {
+// hide password column - but don't remove whole column it because it has constrains for password field!
+// diff-remove
+            show: false,
+// diff-remove
+            list: false,
+// diff-remove
+            filter: false,
+// diff-add
+            all: false,
+          },
+          masked: true,
+        },
+
+    // ... other columns
+  ],
+  hooks: {
+    create: {
+      beforeSave: async ({ record, adminUser, resource }: { record: any, adminUser: AdminUser, resource: AdminForthResource }) => {
+// since we don't show password input in resource - no sense to hande it in hook anymore!       
+//diff-remove   
+          record.password_hash = await AdminForth.Utils.generatePasswordHash(record.password);
+          return { ok: true };
+        }
+    },
+    edit: {
+      beforeSave: async ({ oldRecord, updates, adminUser, resource }: { oldRecord: any, updates: any, adminUser: AdminUser, resource: AdminForthResource }) => {
+        console.log('Updating user', updates);
+        if (oldRecord.id === adminUser.dbUser.id && updates.role) {
+          return { ok: false, error: 'You cannot change your own role' };
+        }
+// also no sense to have updatres - we dont allow edit password by admin anymore
+//diff-remove  
+        if (updates.password) {
+//diff-remove  
+          updates.password_hash = await AdminForth.Utils.generatePasswordHash(updates.password);
+//diff-remove  
+        }
+        return { ok: true }
+      },
+    },
+  },
+  plugins: [
+    new EmailInvitePlugin({
+      emailField: 'email',
+      sendFrom: 'noreply@yourapp.com',
+      adapter: new EmailAdapterAwsSes({
+        region: 'us-east-1',
+        accessKeyId: process.env.AWS_ACCESS_KEY_ID,
+        secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
+      }),
+    }),
+  ],
+};
+```
+
+Please note that previously (in defauklt CLI setup) we needed it to allow admins to set passwords when created new users (to invite them). Also Admens were able to edit passwords of users.
+Now since we added this plugin, user will have email link on which he will get form to enter password by hiumself.
+Please note that the form for user will still use constraints from password virtual field, that is why we just hid it using showIn - not remove it.
+
+To allow users to edit their passwords please use [email password reset plugin](https://adminforth.dev/docs/tutorial/Plugins/email-password-reset/)
+
+## Email Confirmation boolean flag
+
+This plugin can write into the database the fact that invited user was able to set password and as a result confirmed that he owns his email.
+To enable email this behaviour, first add a boolean field to your user table:
+
+```prisma title="./schema.prisma"
+model adminuser {
+  id             String   @id @default(cuid())
+  email          String   @unique
+  password_hash  String
+  role           String   @default("user")
+  //diff-add
+  email_confirmed Boolean? @default(false)
+  // ... other fields
+}
+```
+
+Run the migration:
+
+```bash
+npx prisma migrate dev --name add-email-confirmed
+```
+
+Then update your resource configuration:
+
+```typescript title="./resources/adminuser.ts"
+export default {
+  // ... existing config
+  columns: [
+    { name: 'id', primaryKey: true },
+    { name: 'email', required: true },
+    { name: 'password_hash', showIn: [] },
+    { name: 'role' },
+    //diff-add
+    { name: 'email_confirmed', type: AdminForthDataTypes.BOOLEAN },
+    // ... other columns
+  ],
+  plugins: [
+    new EmailInvitePlugin({
+      emailField: 'email',
+      sendFrom: 'noreply@yourapp.com',
+      adapter: new EmailAdapterAwsSes(/* ... */),
+      //diff-add
+      emailConfirmedField: 'email_confirmed', // Enable email confirmation
+    }),
+  ],
+};
+```
+

adminforth/documentation/docs/tutorial/05-Plugins/15-email-invite.md

@@ -72,9 +72,119 @@ Add to your `'adminuser'` resource configuration the plugin instance:
 }
 ```
 
-You can use `modifyTableResourceConfig` callback to modify what columns to show in the list and filter of the foreign table.
+You can use the `modifyTableResourceConfig` callback to modify which columns to show in the list and filter of the foreign table.
 
 ![alt text](ForeignInlineList.png)
 
 > 👆 To make plugin work, the specified resource (defined with `foreignResourceId`) should have one (and only one) column that refers to the current resource on which you add a plugin.
-> In our case we add plugin to `adminuser` resource, so the `aparts` resource should have one column with `foreignResource.resourceId` equal to `adminuser` resourceId.
+> In our case we add plugin to `adminuser` resource, so the `aparts` resource should have one column with `foreignResource.resourceId` equal to `adminuser` resourceId.
+
+## Default filters
+
+If you need to add default filters for the foreign resource based on your current record (for example show apartment only from Italy, when user have country Italy), you can use defaultFilters callback:
+>👆 This example won't work until you'll add counrty field in your adminuser resource and it's only for demonstrating concept of callback
+
+```ts title="./resources/adminuser.ts"
+
+  ...
+
+  new ForeignInlineListPlugin({
+
+    ...
+      //diff-add
+      defaultFilters: (record: any) => {
+        //diff-add
+        return [
+          //diff-add
+          {
+            //diff-add
+            field: "country",
+            //diff-add
+            operator: AdminForthFilterOperators.EQ,
+            //diff-add
+            value: record.country,
+            //diff-add
+          }
+          //diff-add
+        ]
+        //diff-add
+      }
+
+    ...
+
+  })
+
+  ...
+
+```
+
+>👆It also makes sense to modify the table resource and hide the country field from filters, because this value is hardcoded and equals the country from the record:  
+
+
+```ts title="./resources/adminuser.ts"
+
+  ...
+
+  new ForeignInlineListPlugin({
+
+    ...
+
+    //diff-add
+    modifyTableResourceConfig: (resourceConfig: AdminForthResource) => {
+      //diff-add
+      const column = resourceConfig.columns.find((c: AdminForthResourceColumn) => c.name === 'country')!.showIn = {
+        //diff-add
+        list: true,
+        //diff-add
+        show: true,
+        //diff-add
+        edit: true,
+        //diff-add
+        create: true,
+        //diff-add
+        filter: false
+        //diff-add
+      };
+      //diff-add
+    },
+
+    defaultFilters: (record: any) => {
+      return [
+        {
+          field: "country",
+          operator: AdminForthFilterOperators.EQ,
+          value: record.country,
+        }
+      ]
+    }
+
+    ...
+
+  })
+
+  ...
+  
+```
+
+
+## Show table from another resource without any filters applied
+
+There might be cases when you want to remove the default filter applied by the plugin and then use the `defaultFilters` callback to apply your own custom filters.
+
+```ts title="./resources/adminuser.ts"
+
+plugins: [
+//diff-add
+  new ForeignInlineListPlugin({
+//diff-add
+    foreignResourceId: 'aparts',
+//diff-add
+    disableForeignListResourceRefColumn: true
+//diff-add
+  }),
+//diff-add
+    ],
+
+```
+
+This setup will show, in the show view for each record, the `aparts` resource without any filters. And you don’t have to modify the `aparts` resource.