upload plugin: Add 'record' param for s3Path callback in edit mode

Author: ivictbor

adminforth/documentation/docs/tutorial/05-Plugins/05-upload.md

@@ -155,13 +155,13 @@ which are generated by plugin:
 ![alt text](Upload.png)
 
 
-> ☝ When upload feature is used on record which already exists in database (from 'edit' view), s3path callback will
+> ☝ When upload feature is used on record which already exists in database (from 'edit' page), s3path callback will
 > receive additional parameter `record` with all values of record. Generally we don't recommend denormalizing any state
-> of record into s3Path (and instead only store links from record to file path like in example above).
+> of record into s3 path (and instead store links to unique path on s3 in the record field, like in example above).
 > But if you are 100% sure this kind of sate will be static, you might link to it:
 >
 > ```ts
-> s3Path: ({originalExtension, record}) => `game_images/${record.game_code}.${originalExtension}`
+> s3Path: ({originalExtension, record}) => `game_images/${record.static_game_code}.${originalExtension}`
 > ```
 >
 > ! Please note that when upload is done from create view, record will be `undefined`.

adminforth/plugins/upload/ChangeLog.md

@@ -1,4 +1,9 @@
 
+## [1.0.30] - 2024-12-26
+
+### Improved
+
+- Add 'record' param for s3Path callback in edit mode
 
 ## [1.0.24] - 2023-12-24
 

adminforth/plugins/upload/index.ts

@@ -2,7 +2,7 @@
 import { PluginOptions } from './types.js';
 import { getSignedUrl } from '@aws-sdk/s3-request-presigner';
 import { ExpirationStatus, GetObjectCommand, ObjectCannedACL, PutObjectCommand, S3 } from '@aws-sdk/client-s3';
-import { AdminForthPlugin, AdminForthResourceColumn, AdminForthResourcePages, Filters, IAdminForth, IHttpServer, suggestIfTypo } from "adminforth";
+import { AdminForthPlugin, AdminForthResourceColumn, AdminForthResource, Filters, IAdminForth, IHttpServer, suggestIfTypo } from "adminforth";
 import { Readable } from "stream";
 import { RateLimiter } from "adminforth";
 
@@ -94,15 +94,15 @@ export default class UploadPlugin extends AdminForthPlugin {
     record[`previewUrl_${this.pluginInstanceId}`] = previewUrl;
   }
 
-  async modifyResourceConfig(adminforth: IAdminForth, resourceConfig: any) {
+  async modifyResourceConfig(adminforth: IAdminForth, resourceConfig: AdminForthResource) {
     super.modifyResourceConfig(adminforth, resourceConfig);
     // after column to store the path of the uploaded file, add new VirtualColumn,
     // show only in edit and create views
     // use component uploader.vue
     const { pathColumnName } = this.options;
     const pathColumnIndex = resourceConfig.columns.findIndex((column: any) => column.name === pathColumnName);
     if (pathColumnIndex === -1) {
-      throw new Error(`Column with name "${pathColumnName}" not found in resource "${resourceConfig.name}"`);
+      throw new Error(`Column with name "${pathColumnName}" not found in resource "${resourceConfig.label}"`);
     }
 
     if (this.options.generation?.fieldsForContext) {
@@ -315,7 +315,7 @@ export default class UploadPlugin extends AdminForthPlugin {
 
 
     // add edit postSave hook to delete old file and remove tag from new file
-    resourceConfig.hooks.edit.afterSave.push(async ({ updates, oldRecord }: { record: any, oldRecord: any }) => {
+    resourceConfig.hooks.edit.afterSave.push(async ({ updates, oldRecord }: { updates: any, oldRecord: any }) => {
 
       if (updates[virtualColumn.name] || updates[virtualColumn.name] === null) {
         const s3 = new S3({

adminforth/plugins/upload/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@adminforth/upload",
-  "version": "1.0.29",
+  "version": "1.0.30",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",