Merge branch 'next' into feature/AdminForth/1181/we-need-to-limit-error-length

Author: kulikp1

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() {

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/documentation/docs/tutorial/05-ListOfAdapters.md

@@ -244,10 +244,49 @@ 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 redis database.
+
+```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 local storage for storing keys.
+
+```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/05-upload.md

@@ -305,6 +305,73 @@ new UploadPlugin({
 > adminServeBaseUrl defines the public path prefix. If your AdminForth base URL is /admin, files will be accessible under /admin/static/source/<key>.
 
 
+## API
+
+### uploadFromBufferToNewRecord
+
+In some cases you may want to upload a file directly from your backend (for example, a file generated by a background job or received from a webhook) without going through the browser. For this, the Upload plugin exposes the `uploadFromBufferToNewRecord` method.
+
+You can code it as custom logic or you can simply reuse Upload plugin for this purpose as well.
+
+This method uploads a file from a Node.js `Buffer`, automatically creates a record in the corresponding resource, and returns both the stored file path and a preview URL.
+
+```ts title="./some-backend-service.ts"
+import { admin } from './admin'; // your AdminForth instance
+
+...
+plugins: [
+  new UploadPlugin({
+    id: 'my_reports_plugin', // unique identifier for your plugin instance
+    ....
+  })
+]
+...
+
+const plugin = admin.getPluginById('my_reports_plugin');
+
+const { path, previewUrl } = await plugin.uploadFromBufferToNewRecord({
+  filename: 'report.pdf',
+  contentType: 'application/pdf',
+  buffer, // Node.js Buffer with file content
+  adminUser, // current admin user or system user
+  recordAttributes: {
+    title: 'Generated report',
+    listed: false,
+  },
+});
+```
+
+- `uploadFromBufferToNewRecord` uses the configured storage adapter (S3, local, etc.) to store the file.
+- It automatically creates a new record in the resource and stores the file path into the column defined by `pathColumnName`, together with any extra `recordAttributes` you pass.
+- It returns an object `{ path, previewUrl }`, where `previewUrl` is the same URL that would be used for previews inside AdminForth.
+
+> ⚠️ It is not recommended to upload large files from the backend using `uploadFromBuffer`, because the entire file must go through your server memory and network. For large uploads you should prefer frontend presigned uploads directly to storage. You can find an example of presigned upload flow using upload plugin in the Rich editor plugin source code (Rich editor actually uses Upload plugin to upload images in edited content).
+
+
+### uploadFromBufferToExistingRecord
+
+If you already have a record and just want to replace the file referenced in its `pathColumnName` field, you can use the `uploadFromBufferToExistingRecord` method. It uploads a file from a Node.js `Buffer`, updates the existing record, and returns the new file path and preview URL.
+
+```ts title="./some-backend-service.ts"
+const plugin = admin.getPluginById('my_reports_plugin');
+
+const { path, previewUrl } = await plugin.uploadFromBufferToExistingRecord({
+  recordId: existingRecordId, // primary key of the record to update
+  filename: 'report.pdf',
+  contentType: 'application/pdf',
+  buffer,        // Node.js Buffer with file content
+  adminUser,     // current admin user or system user
+  extra: {},     // optional extra meta for your hooks / audit
+});
+```
+
+- Uses the same storage adapter and validation rules as `uploadFromBufferToNewRecord` (file extension whitelist, `maxFileSize`, `filePath` callback, etc.).
+- Does not create a new record – it only updates the existing one identified by `recordId`, replacing the value in `pathColumnName` with the new storage path.
+- If the generated `filePath` would be the same as the current value in the record, it throws an error to help you avoid CDN/browser caching issues. To force a refresh, make sure your `filePath` callback produces a different key (for example, include a timestamp or random UUID).
+
+> ⚠️ The same recommendation about large files applies here: avoid using `uploadFromBufferToExistingRecord` for very large uploads; prefer a presigned upload flow from the frontend instead.
+
+
 
 ## Image generation
 

adminforth/index.ts

@@ -568,17 +568,21 @@ class AdminForth implements IAdminForth {
         response, 
         extra,
       });
-      if (!resp || (typeof resp.ok !== 'boolean' && (!resp.error && !resp.newRecordId))) {
+      if (resp.newRecordId) {
+        afLogger.warn(`Deprecation warning: beforeSave hook returned 'newRecordId'. Since AdminForth v1.2.9 use 'redirectToRecordId' instead. 'newRecordId' will be removed in v2.0.0`);
+      }
+      if (!resp || (typeof resp.ok !== 'boolean' && (!resp.error && !resp.newRecordId && !resp.redirectToRecordId))) {
         throw new Error(
-          `Invalid return value from beforeSave hook. Expected: { ok: boolean, error?: string | null, newRecordId?: any }.\n` +
-          `Note: Return { ok: false, error: null, newRecordId } to stop creation and redirect to an existing record.`
+          `Invalid return value from beforeSave hook. Expected: { ok: boolean, error?: string | null, newRecordId?: any, redirectToRecordId?: any }.\n` +
+          `Note: Return { ok: false, error: null, redirectToRecordId } (preferred) or { ok: false, error: null, newRecordId } (deprecated) to stop creation and redirect to an existing record.`
         );
       }
       if (resp.ok === false && !resp.error) {
-        const { error, ok, newRecordId } = resp;
+        const { error, ok, newRecordId, redirectToRecordId } = resp;
         return {
           error: error ?? 'Operation aborted by hook',
-          newRecordId: newRecordId
+          newRecordId: redirectToRecordId ? redirectToRecordId : newRecordId,
+          redirectToRecordId: redirectToRecordId
         };
       }
       if (resp.error) {

adminforth/modules/logger.ts

@@ -6,23 +6,21 @@ const baseLogger = pino({
     options: {
       colorize: true,
       ignore: 'pid,hostname',
-      hideObject: true,
-      messageFormat: '{layer}: {msg}',
     }
   },
 });
 
 export const logger = baseLogger.child(
-  { layer: 'user_logs' },
-  { level: process.env.HEAVY_DEBUG ? 'trace' : ( process.env.DEBUG_LEVEL || 'info' ) }
+  { name: 'User logs' },
+  { level: process.env.HEAVY_DEBUG ? 'trace' : ( process.env.DEBUG_LEVEL || 'info' ) },
 );
 
 export const afLogger = baseLogger.child(
-  { layer: 'af' },
+  { name: 'AF' },
   { level: process.env.HEAVY_DEBUG ? 'trace' :  ( process.env.AF_DEBUG_LEVEL || 'info' ) }
 );
 
 export const dbLogger = baseLogger.child(
-  { layer: 'db' },
+  { name: 'DB' },
   { level: process.env.HEAVY_DEBUG_QUERY ? 'trace' : (process.env.DB_DEBUG_LEVEL|| 'info') }
 );

adminforth/modules/restApi.ts

@@ -1280,7 +1280,11 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
               extra: { body, query, headers, cookies, requestUrl, response } 
             });
             if (createRecordResponse.error) {
-              return { error: createRecordResponse.error, ok: false, newRecordId: createRecordResponse.newRecordId };
+              return { 
+                error: createRecordResponse.error, 
+                ok: false, 
+                newRecordId: createRecordResponse.redirectToRecordId ? createRecordResponse.redirectToRecordId :createRecordResponse.newRecordId, 
+                redirectToRecordId: createRecordResponse.redirectToRecordId };
             }
             const connector = this.adminforth.connectors[resource.dataSource];
 

adminforth/servers/express.ts

@@ -217,7 +217,7 @@ class ExpressServer implements IExpressHttpServer {
     this.server.listen(...args);
   }
 
-  async processAuthorizeCallbacks(adminUser: AdminUser, toReturn: { error?: string, allowed: boolean }, response: Response, extra: any) {
+  async processAuthorizeCallbacks(adminUser: AdminUser, toReturn: { error?: string, allowed: boolean }, response: Response, extra: HttpExtra) {
     const adminUserAuthorize = this.adminforth.config.auth.adminUserAuthorize as (AdminUserAuthorizeFunction[] | undefined);
 
     for (const hook of listify(adminUserAuthorize)) {
@@ -269,7 +269,15 @@ class ExpressServer implements IExpressHttpServer {
       } else {
         req.adminUser = adminforthUser;
         const toReturn: { error?: string, allowed: boolean } = { allowed: true };
-        await this.processAuthorizeCallbacks(adminforthUser, toReturn, res, {});
+        await this.processAuthorizeCallbacks(adminforthUser, toReturn, res, {
+          body: req.body,
+          query: req.query,
+          headers: req.headers,
+          cookies: cookies as any,
+          requestUrl: req.url,
+          meta: {},
+          response: res
+        });
         if (!toReturn.allowed) {
           res.status(401).send('Unauthorized by AdminForth');
         } else {

adminforth/spa/src/components/Toast.vue

@@ -23,12 +23,12 @@
     <div class="ms-3 text-sm font-normal max-w-xs pr-2" v-else>
         <div class="flex flex-col items-center justify-center break-all overflow-hidden [display:-webkit-box] [-webkit-box-orient:vertical] [-webkit-line-clamp:70]">
             {{toast.message}}
-            <div v-if="toast.buttons" class="flex justify-center mt-2 gap-2">
-                <div v-for="button in toast.buttons" class="af-toast-button rounded-md bg-lightButtonsBackground hover:bg-lightButtonsHover text-lightButtonsText dark:bg-darkPrimary dark:hover:bg-darkButtonsBackground  dark:text-darkButtonsText">
-                    <button @click="onButtonClick(button.value)" class="px-2 py-1 rounded hover:bg-black/5 dark:hover:bg-white/10">
-                        {{ button.label }}
-                    </button>
-                </div>
+        </div>
+        <div v-if="toast.buttons" class="flex mt-2 gap-2 w-full ml-6">
+            <div v-for="button in toast.buttons" class="af-toast-button rounded-md bg-lightButtonsBackground hover:bg-lightButtonsHover text-lightButtonsText dark:bg-darkPrimary dark:hover:bg-darkButtonsBackground  dark:text-darkButtonsText">
+                <button @click="onButtonClick(button.value)" class="px-2 py-1 rounded hover:bg-black/5 dark:hover:bg-white/10">
+                    {{ button.label }}
+                </button>
             </div>
         </div>
     </div>

adminforth/spa/src/utils/index.ts

@@ -0,0 +1,2 @@
+export * from './utils';
+export * from './listUtils';