Merge pull request #481 from devforth/next

Next

Author: yaroslav8765

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);

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

@@ -239,6 +239,9 @@ Sometimes a custom editor needs to update not only its own field, but also other
 
 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">

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/03-Customization/15-afcl.md

@@ -2215,7 +2215,7 @@ const datePickerValue = ref()
 <div>
 ```html
 <DatePicker
-  v-model:datePickerValue="datePickerValue"
+  v-model:valueStart="datePickerValue"
   :column="{ type: 'datetime' }"
   label="Pick start"
 />

…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

@@ -305,73 +305,6 @@ 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
 
@@ -726,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).