Merge branch 'next' into feature/AdminForth/1193/i-think-we-had-some-feature-wh

Author: SerVitasik

adapters/install-adapters.sh

@@ -4,7 +4,8 @@ adminforth-email-adapter-mailgun adminforth-google-oauth-adapter adminforth-gith
 adminforth-facebook-oauth-adapter adminforth-keycloak-oauth-adapter adminforth-microsoft-oauth-adapter \
 adminforth-twitch-oauth-adapter adminforth-image-generation-adapter-openai adminforth-storage-adapter-amazon-s3 \
 adminforth-storage-adapter-local adminforth-image-vision-adapter-openai adminforth-key-value-adapter-ram \
-adminforth-login-captcha-adapter-cloudflare adminforth-login-captcha-adapter-recaptcha adminforth-completion-adapter-google-gemini"
+adminforth-login-captcha-adapter-cloudflare adminforth-login-captcha-adapter-recaptcha adminforth-completion-adapter-google-gemini \
+adminforth-key-value-adapter-redis adminforth-key-value-adapter-leveldb"
 
 # for each
 install_adapter() {
@@ -16,7 +17,7 @@ install_adapter() {
       git pull
   else
       echo "Repository for $adapter does not exist. Cloning..."
-      git clone git@github.com:devforth/$adapter.git "$adapter"
+      git clone https://github.com/devforth/$adapter.git "$adapter"
       cd "$adapter"
   fi
 

adminforth/commands/createApp/templates/.env.local.hbs

@@ -1,5 +1,8 @@
 ADMINFORTH_SECRET=123
 NODE_ENV=development
+DEBUG_LEVEL=info
+AF_DEBUG_LEVEL=info
+DB_DEBUG_LEVEL=info
 DATABASE_URL={{{dbUrl}}}
 {{#if prismaDbUrl}}
 PRISMA_DATABASE_URL={{{prismaDbUrl}}}

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

@@ -1,10 +1,13 @@
-import { Express } from "express";
+import { Express, Request, Response } from "express";
 import { IAdminForth } from "adminforth";
-
 export function initApi(app: Express, admin: IAdminForth) {
   app.get(`${admin.config.baseUrl}/api/hello/`,
-    (req, res) => {
-      res.json({ message: "Hello from AdminForth API!" });
+    async (req: Request, res: Response) => {
+      const allUsers = await admin.resource("adminuser").list([]);
+      res.json({
+        message: "Hello from AdminForth API!",
+        users: allUsers,
+      });
     }
   );
 }

adminforth/dataConnectors/postgres.ts

@@ -232,7 +232,7 @@ class PostgresConnector extends AdminForthBaseConnector implements IAdminForthDa
             }
             return JSON.stringify(value);
         } else if (field.type == AdminForthDataTypes.BOOLEAN) {
-            return value === null ? null : (value ? 1 : 0);
+            return value === null ? null : (value ? true : false);
         } else if (field.type == AdminForthDataTypes.JSON) {
             if (field._underlineType == 'json') {
                 return typeof value === 'string' || value === null ? value : JSON.stringify(value);
@@ -385,7 +385,7 @@ class PostgresConnector extends AdminForthBaseConnector implements IAdminForthDa
         const tableName = resource.table;
         const result = {};
         await Promise.all(columns.map(async (col) => {
-            const q = `SELECT MIN(${col.name}) as min, MAX(${col.name}) as max FROM "${tableName}"`;
+            const q = `SELECT MIN("${col.name}") as min, MAX("${col.name}") as max FROM "${tableName}"`;
             dbLogger.trace(`🪲📜 PG Q: ${q}`);
             const stmt = await this.client.query(q);
             const { min, max } = stmt.rows[0];

adminforth/documentation/docs/tutorial/03-Customization/02-customFieldRendering.md

@@ -233,6 +233,100 @@ Now you can use this component in the configuration of the resource:
 }
 ```
 
+### Custom record editing (updating other fields)
+
+Sometimes a custom editor needs to update not only its own field, but also other fields of the record (for example, generate a slug from a title).
+
+For this, custom `edit`/`create` components can emit an `update:recordFieldValue` event with the payload `{ fieldName, fieldValue }`. AdminForth will update the corresponding field in the record.
+
+> If you emit `update:recordFieldValue` to modify a field which is hidden by `showIn.create: false` / `showIn.edit: false`, the backend will reject the request by default.
+> To allow this, set the target column config to `allowModifyWhenNotShowInCreate: true` and/or `allowModifyWhenNotShowInEdit: true`.
+
+```html title='./custom/TitleWithSlugEditor.vue'
+<template>
+  <div class="flex flex-col gap-2">
+    <Input
+      :model-value="record[column.name]"
+      :placeholder="$t('Title')"
+      @update:model-value="onTitleChange"
+    />
+    <Input
+      :model-value="record.slug"
+      :placeholder="$t('Slug')"
+      readonly
+    />
+  </div>
+</template>
+
+<script setup lang="ts">
+import Input from "@/afcl/Input.vue";
+import type {
+  AdminForthResourceColumnCommon,
+  AdminForthResourceCommon,
+  AdminUser,
+} from "@/types/Common";
+
+const props = defineProps<{
+  column: AdminForthResourceColumnCommon;
+  record: any;
+  meta: any;
+  resource: AdminForthResourceCommon;
+  adminUser: AdminUser;
+  readonly: boolean;
+}>();
+
+const emit = defineEmits([
+  "update:value", // update current column value
+  "update:recordFieldValue", // update any other field in the record
+]);
+
+function slugify(value: string) {
+  return value
+    ?.toLowerCase()
+    .trim()
+    .replace(/[^a-z0-9]+/g, "-")
+    .replace(/(^-|-$)+/g, "");
+}
+
+function onTitleChange(newTitle: string) {
+  // update current column value
+  emit("update:value", newTitle);
+
+  // update another field in the record (e.g. slug)
+  emit("update:recordFieldValue", {
+    fieldName: "slug",
+    fieldValue: slugify(newTitle),
+  });
+}
+</script>
+```
+
+And use it in the resource configuration for both `edit` and `create` views:
+
+```ts title='./resources/apartments.ts'
+{
+  ...
+  resourceId: 'aparts',
+  columns: [
+    ...
+    {
+      name: 'title',
+      components: {
+        edit: '@@/TitleWithSlugEditor.vue',
+        create: '@@/TitleWithSlugEditor.vue',
+      },
+    },
+    {
+      name: 'slug',
+      // standard input; value will be kept in sync
+      ...
+    },
+    ...
+  ],
+  ...
+}
+```
+
 ### Custom inValidity inside of the custom create/edit components
 
 Custom componets can emit `update:inValidity` event to parent to say that the field is invalid.

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

@@ -44,7 +44,7 @@ When user opens edit page, AdminForth makes a request to the backend to get the
 
 Practically you can use `show.afterDatasourceResponse` to modify or add some data before it is displayed on the edit page. 
 
-For example [upload plugin](/docs/tutorial/Plugins/upload/) uses this hook to generate signed preview URL so user can see existing uploaded file preview  in form, and at the same time database stores only original file path which might be not accessible without presigned URL.
+For example [upload plugin](/docs/tutorial/Plugins/05-0-upload/) uses this hook to generate signed preview URL so user can see existing uploaded file preview  in form, and at the same time database stores only original file path which might be not accessible without presigned URL.
 
 ## Saving data on edit page
 

adminforth/documentation/docs/tutorial/03-Customization/12-security.md

@@ -66,7 +66,7 @@ Also you can add custom rules. For example to prevent popular words:
   ],
 ```
 
-All rules defined in password column will be also delivered to [password reset plugin](../07-Plugins/07-email-password-reset.md) if you are using it to ensure that password reset will also respect same rules.
+All rules defined in password column will be also delivered to [password reset plugin](../08-Plugins/07-email-password-reset.md) if you are using it to ensure that password reset will also respect same rules.
 
 
 ## Trusting client IP addresses

adminforth/documentation/docs/tutorial/05-ListOfAdapters.md

@@ -244,10 +244,52 @@ The RAM adapter is a simplest in-memory key-value storage. Stores data in proces
 
 Pros:
 * Simplest in use - does not reqauire any external daemon.
+
 Cones:
 * In production sutable for single-process installations only
 
 
+### Redis adapter
+
+```bash
+npm i @adminforth/key-value-adapter-redis
+```
+
+Redis adapter uses in-memory RAM-based Redis database with O(1) get complexity. It is great fit for most of lightweight tasks which fit in RAM. Also capable with multi-process or replica-based installations as centralized storage. Please note that Redis daemon might be not persisted to disk during restarts without additional settings, so if persistence is critical for your task - you might need to set up it separately (for many tasks like rate-limits ephemeral data are fine 
+
+
+```ts
+import RedisKeyValueAdapter from '@adminforth/key-value-adapter-redis';
+
+const adapter = new RedisKeyValueAdapter({
+  redisUrl: '127.0.0.1:6379'
+})
+
+adapeter.set('test-key', 'test-value', 120); //expiry in 120 seconds
+
+```
+
+### LevelDB adapter
+
+```bash
+npm i @adminforth/key-value-adapter-leveldb
+```
+
+LebelDB uses disk storage with o(log(n)) get complexity. Good fit for large and/or persistent KV datasets which still require fast KV access but don't efficently fit into RAM. Please not that this is a single-process adapter only, so if you will run severall processes of admin - they will not be able to work with this adapter (>=2 processes which look at same level database might lead to unpredicted behaviour - exceptions or crashes). 
+
+You can use replicas with isolated disks, however in this case state will be also separated between replicas.
+
+```ts
+import LevelDBKeyValueAdapter from '@adminforth/key-value-adapter-leveldb'
+
+const adapter = new LevelDBKeyValueAdapter({ 
+  dbPath: './testdb' 
+});
+
+adapeter.set('test-key', 'test-value', 120); //expiry in 120 seconds
+
+```
+
 ## 🤖Captcha adapters
 
 Used to add capthca to the login screen

adminforth/documentation/docs/tutorial/08-Plugins/02-TwoFactorsAuth.md

@@ -280,10 +280,6 @@ options: {
           adminUser: adminUser,
         //diff-add
           userPk: adminUser.pk,
-        //diff-add
-          cookies: extra.cookies,
-        //diff-add
-          response: response,
         //diff-add
           extra: extra,
         //diff-add
@@ -393,8 +389,6 @@ hooks: {
       const verifyRes = await t2fa.verify(confirmationResult, {
         adminUser,
         userPk: adminUser.pk,
-        cookies: extra?.cookies,
-        response,
         extra
       });
       if (!verifyRes || 'error' in verifyRes) {
@@ -404,7 +398,7 @@ hooks: {
     },
   },
   create: {
-    beforeSave: async ({ adminUser, adminforth, extra }) => {
+    beforeSave: async ({ adminUser, adminforth, response, extra }) => {
       const t2fa = adminforth.getPluginByClassName('TwoFactorsAuthPlugin');
       if (!t2fa) {
         return { ok: false, error: 'TwoFactorsAuthPlugin is not configured' };
@@ -418,7 +412,7 @@ hooks: {
       const verifyRes = await t2fa.verify(confirmationResult, {
         adminUser,
         userPk: adminUser.pk,
-        cookies: extra?.cookies,
+        extra
       });
       if (!verifyRes || 'error' in verifyRes) {
         return { ok: false, error: verifyRes?.error || 'Two-factor verification failed' };
@@ -534,12 +528,8 @@ app.post(`${ADMIN_BASE_URL}/myCriticalAction`,
         adminUser: adminUser,
       // diff-add
         userPk: adminUser.pk,
-      // diff-add
-        cookies: cookies,
-      //diff-add
-        response: res, 
       //diff-add
-        extra: {...req.headers},
+        extra: {...req.headers, ...req.cookies, response: res},
       //diff-add
       });
       // diff-add

…on/docs/tutorial/08-Plugins/05-upload.md …/docs/tutorial/08-Plugins/05-0-upload.mdadminforth/documentation/docs/tutorial/08-Plugins/05-upload.md renamed to adminforth/documentation/docs/tutorial/08-Plugins/05-0-upload.md adminforth/documentation/docs/tutorial/08-Plugins/05-upload.md renamed to adminforth/documentation/docs/tutorial/08-Plugins/05-0-upload.md

@@ -659,4 +659,9 @@ And finally add this callback:
 
 ```
 
-And now you can easily update avatar for each user
+And now you can easily update avatar for each user
+
+# API
+
+If you wish to reuse Upload plugin for advanced tasks like upload custom files from frontend/backend
+ (including presigned frontend upload), see [05-1-upload-api.md](05-1-upload-api.md).