@adminforth/upload 1.0.29 → 1.0.31-next.0

package/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
 

package/custom/uploader.vue

@@ -70,7 +70,9 @@ import { computed, ref, onMounted, watch } from 'vue'
 import { callAdminForthApi } from '@/utils'
 import { IconMagic } from '@iconify-prerendered/vue-mdi';
 import { useI18n } from 'vue-i18n';
+import { useRoute } from 'vue-router';
 
+const route = useRoute();
 const { t } = useI18n();
 
 const inputId = computed(() => `dropzone-file-${props.meta.pluginInstanceId}`);
@@ -233,6 +235,7 @@ const onFileChange = async (e) => {
           contentType: type,
           size,
           originalExtension: extension,
+          recordPk: route?.params?.primaryKey,
         },
     });
 

package/dist/custom/uploader.vue

@@ -70,7 +70,9 @@ import { computed, ref, onMounted, watch } from 'vue'
 import { callAdminForthApi } from '@/utils'
 import { IconMagic } from '@iconify-prerendered/vue-mdi';
 import { useI18n } from 'vue-i18n';
+import { useRoute } from 'vue-router';
 
+const route = useRoute();
 const { t } = useI18n();
 
 const inputId = computed(() => `dropzone-file-${props.meta.pluginInstanceId}`);
@@ -233,6 +235,7 @@ const onFileChange = async (e) => {
           contentType: type,
           size,
           originalExtension: extension,
+          recordPk: route?.params?.primaryKey,
         },
     });
 

package/dist/index.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { getSignedUrl } from '@aws-sdk/s3-request-presigner';
 import { ExpirationStatus, GetObjectCommand, PutObjectCommand, S3 } from '@aws-sdk/client-s3';
-import { AdminForthPlugin, suggestIfTypo } from "adminforth";
+import { AdminForthPlugin, Filters, suggestIfTypo } from "adminforth";
 import { Readable } from "stream";
 import { RateLimiter } from "adminforth";
 const ADMINFORTH_NOT_YET_USED_TAG = 'adminforth-candidate-for-cleanup';
@@ -25,13 +25,20 @@ export default class UploadPlugin extends AdminForthPlugin {
         return __awaiter(this, void 0, void 0, function* () {
             // check that lifecyle rule "adminforth-unused-cleaner" exists
             const CLEANUP_RULE_ID = 'adminforth-unused-cleaner';
-            const s3 = new S3({
-                credentials: {
-                    accessKeyId: this.options.s3AccessKeyId,
-                    secretAccessKey: this.options.s3SecretAccessKey,
-                },
-                region: this.options.s3Region,
-            });
+            let s3;
+            try {
+                s3 = new S3({
+                    credentials: {
+                        accessKeyId: this.options.s3AccessKeyId,
+                        secretAccessKey: this.options.s3SecretAccessKey,
+                    },
+                    region: this.options.s3Region,
+                });
+            }
+            catch (e) {
+                console.error('Unable to connect to S3. Upload will not work. Skipping setup of lifecycle rule', e);
+                return;
+            }
             // check bucket exists
             const bucketExists = s3.headBucket({ Bucket: this.options.s3Bucket });
             if (!bucketExists) {
@@ -105,7 +112,7 @@ export default class UploadPlugin extends AdminForthPlugin {
             const { pathColumnName } = this.options;
             const pathColumnIndex = resourceConfig.columns.findIndex((column) => 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 ((_a = this.options.generation) === null || _a === void 0 ? void 0 : _a.fieldsForContext) {
                 (_b = this.options.generation) === null || _b === void 0 ? void 0 : _b.fieldsForContext.forEach((field) => {
@@ -283,8 +290,8 @@ export default class UploadPlugin extends AdminForthPlugin {
                 return { ok: true };
             }));
             // add edit postSave hook to delete old file and remove tag from new file
-            resourceConfig.hooks.edit.afterSave.push((_s) => __awaiter(this, [_s], void 0, function* ({ record, oldRecord }) {
-                if (record[virtualColumn.name] || record[virtualColumn.name] === null) {
+            resourceConfig.hooks.edit.afterSave.push((_s) => __awaiter(this, [_s], void 0, function* ({ updates, oldRecord }) {
+                if (updates[virtualColumn.name] || updates[virtualColumn.name] === null) {
                     const s3 = new S3({
                         credentials: {
                             accessKeyId: this.options.s3AccessKeyId,
@@ -313,12 +320,12 @@ export default class UploadPlugin extends AdminForthPlugin {
                             console.error(`Error setting tag ${ADMINFORTH_NOT_YET_USED_TAG} to true for object ${oldRecord[pathColumnName]}. File will not be auto-cleaned up`, e);
                         }
                     }
-                    if (record[virtualColumn.name] !== null) {
+                    if (updates[virtualColumn.name] !== null) {
                         // remove tag from new file
                         // in this case we let it crash if it fails: this is a new file which just was uploaded. 
                         yield s3.putObjectTagging({
                             Bucket: this.options.s3Bucket,
-                            Key: record[pathColumnName],
+                            Key: updates[pathColumnName],
                             Tagging: {
                                 TagSet: []
                             }
@@ -339,14 +346,20 @@ export default class UploadPlugin extends AdminForthPlugin {
             method: 'POST',
             path: `/plugin/${this.pluginInstanceId}/get_s3_upload_url`,
             handler: (_a) => __awaiter(this, [_a], void 0, function* ({ body }) {
-                var _b;
-                const { originalFilename, contentType, size, originalExtension } = body;
+                var _b, _c;
+                const { originalFilename, contentType, size, originalExtension, recordPk } = body;
                 if (this.options.allowedFileExtensions && !this.options.allowedFileExtensions.includes(originalExtension)) {
                     return {
                         error: `File extension "${originalExtension}" is not allowed, allowed extensions are: ${this.options.allowedFileExtensions.join(', ')}`
                     };
                 }
-                const s3Path = this.options.s3Path({ originalFilename, originalExtension, contentType });
+                let record = undefined;
+                if (recordPk) {
+                    // get record by recordPk
+                    const pkName = (_b = this.resourceConfig.columns.find((column) => column.primaryKey)) === null || _b === void 0 ? void 0 : _b.name;
+                    record = yield this.adminforth.resource(this.resourceConfig.resourceId).get([Filters.EQ(pkName, recordPk)]);
+                }
+                const s3Path = this.options.s3Path({ originalFilename, originalExtension, contentType, record });
                 if (s3Path.startsWith('/')) {
                     throw new Error('s3Path should not start with /, please adjust s3path function to not return / at the start of the path');
                 }
@@ -370,7 +383,7 @@ export default class UploadPlugin extends AdminForthPlugin {
                     unhoistableHeaders: new Set(['x-amz-tagging']),
                 });
                 let previewUrl;
-                if ((_b = this.options.preview) === null || _b === void 0 ? void 0 : _b.previewUrl) {
+                if ((_c = this.options.preview) === null || _c === void 0 ? void 0 : _c.previewUrl) {
                     previewUrl = this.options.preview.previewUrl({ s3Path });
                 }
                 else if (this.options.s3ACL === 'public-read') {
@@ -411,15 +424,15 @@ export default class UploadPlugin extends AdminForthPlugin {
         server.endpoint({
             method: 'POST',
             path: `/plugin/${this.pluginInstanceId}/generate_images`,
-            handler: (_c) => __awaiter(this, [_c], void 0, function* ({ body, headers }) {
-                var _d, _e;
+            handler: (_d) => __awaiter(this, [_d], void 0, function* ({ body, headers }) {
+                var _e, _f;
                 const { prompt } = body;
                 if (this.options.generation.provider !== 'openai-dall-e') {
                     throw new Error(`Provider ${this.options.generation.provider} is not supported`);
                 }
-                if ((_d = this.options.generation.rateLimit) === null || _d === void 0 ? void 0 : _d.limit) {
+                if ((_e = this.options.generation.rateLimit) === null || _e === void 0 ? void 0 : _e.limit) {
                     // rate limit
-                    const { error } = RateLimiter.checkRateLimit(this.pluginInstanceId, (_e = this.options.generation.rateLimit) === null || _e === void 0 ? void 0 : _e.limit, this.adminforth.auth.getClientIp(headers));
+                    const { error } = RateLimiter.checkRateLimit(this.pluginInstanceId, (_f = this.options.generation.rateLimit) === null || _f === void 0 ? void 0 : _f.limit, this.adminforth.auth.getClientIp(headers));
                     if (error) {
                         return { error: this.options.generation.rateLimit.errorMessage };
                     }
@@ -455,7 +468,7 @@ export default class UploadPlugin extends AdminForthPlugin {
         server.endpoint({
             method: 'GET',
             path: `/plugin/${this.pluginInstanceId}/cors-proxy`,
-            handler: (_f) => __awaiter(this, [_f], void 0, function* ({ query, response }) {
+            handler: (_g) => __awaiter(this, [_g], void 0, function* ({ query, response }) {
                 const { url } = query;
                 const resp = yield fetch(url);
                 response.setHeader('Content-Type', resp.headers.get('Content-Type'));

package/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, IAdminForth, IHttpServer, suggestIfTypo } from "adminforth";
+import { AdminForthPlugin, AdminForthResourceColumn, AdminForthResource, Filters, IAdminForth, IHttpServer, suggestIfTypo } from "adminforth";
 import { Readable } from "stream";
 import { RateLimiter } from "adminforth";
 
@@ -25,14 +25,20 @@ export default class UploadPlugin extends AdminForthPlugin {
   async setupLifecycleRule() {
     // check that lifecyle rule "adminforth-unused-cleaner" exists
     const CLEANUP_RULE_ID = 'adminforth-unused-cleaner';
-    const s3 = new S3({
-      credentials: {
-        accessKeyId: this.options.s3AccessKeyId,
-        secretAccessKey: this.options.s3SecretAccessKey,
-      },
 
-      region: this.options.s3Region,
-    });
+    let s3;
+    try {
+      s3 = new S3({
+        credentials: {
+          accessKeyId: this.options.s3AccessKeyId,
+          secretAccessKey: this.options.s3SecretAccessKey,
+        },
+        region: this.options.s3Region,
+      });
+    } catch (e) {
+      console.error('Unable to connect to S3. Upload will not work. Skipping setup of lifecycle rule', e);
+      return;
+    }
     // check bucket exists
     const bucketExists = s3.headBucket({ Bucket: this.options.s3Bucket })
     if (!bucketExists) {
@@ -94,7 +100,7 @@ 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
@@ -102,7 +108,7 @@ export default class UploadPlugin extends AdminForthPlugin {
     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,9 +321,9 @@ 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 ({ record, oldRecord }: { record: any, oldRecord: any }) => {
+    resourceConfig.hooks.edit.afterSave.push(async ({ updates, oldRecord }: { updates: any, oldRecord: any }) => {
 
-      if (record[virtualColumn.name] || record[virtualColumn.name] === null) {
+      if (updates[virtualColumn.name] || updates[virtualColumn.name] === null) {
         const s3 = new S3({
           credentials: {
             accessKeyId: this.options.s3AccessKeyId,
@@ -347,12 +353,12 @@ export default class UploadPlugin extends AdminForthPlugin {
             console.error(`Error setting tag ${ADMINFORTH_NOT_YET_USED_TAG} to true for object ${oldRecord[pathColumnName]}. File will not be auto-cleaned up`, e);
           }
         }
-        if (record[virtualColumn.name] !== null) {
+        if (updates[virtualColumn.name] !== null) {
           // remove tag from new file
           // in this case we let it crash if it fails: this is a new file which just was uploaded. 
           await s3.putObjectTagging({
             Bucket: this.options.s3Bucket,
-            Key: record[pathColumnName],
+            Key: updates[pathColumnName],
             Tagging: {
               TagSet: []
             }
@@ -376,7 +382,7 @@ export default class UploadPlugin extends AdminForthPlugin {
       method: 'POST',
       path: `/plugin/${this.pluginInstanceId}/get_s3_upload_url`,
       handler: async ({ body }) => {
-        const { originalFilename, contentType, size, originalExtension } = body;
+        const { originalFilename, contentType, size, originalExtension, recordPk } = body;
 
         if (this.options.allowedFileExtensions && !this.options.allowedFileExtensions.includes(originalExtension)) {
           return {
@@ -384,7 +390,16 @@ export default class UploadPlugin extends AdminForthPlugin {
           };
         }
 
-        const s3Path: string = this.options.s3Path({ originalFilename, originalExtension, contentType });
+        let record = undefined;
+        if (recordPk) {
+          // get record by recordPk
+          const pkName = this.resourceConfig.columns.find((column: any) => column.primaryKey)?.name;
+          record = await this.adminforth.resource(this.resourceConfig.resourceId).get(
+            [Filters.EQ(pkName, recordPk)]
+          )
+        }
+
+        const s3Path: string = this.options.s3Path({ originalFilename, originalExtension, contentType, record });
         if (s3Path.startsWith('/')) {
           throw new Error('s3Path should not start with /, please adjust s3path function to not return / at the start of the path');
         }

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@adminforth/upload",
-  "version": "1.0.29",
+  "version": "1.0.31-next.0",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "rollout": "tsc && rsync -av --exclude 'node_modules' custom dist/ && npm version patch && npm publish --access public",
     "prepare": "npm link adminforth",
+    "rollout-next": "npm run build && npm version prerelease --preid=next && npm publish --tag next",
     "build": "tsc"
   },
   "type": "module",

package/types.ts

@@ -50,11 +50,16 @@ export type PluginOptions = {
    * example:
    * 
    * ```typescript
-   * s3Path: ({record, originalFilename}) => `/aparts/${record.id}/${originalFilename}`
+   * s3Path: ({originalFilename}) => `/aparts/${originalFilename}`
    * ```
    * 
    */
-  s3Path: ({originalFilename, originalExtension, contentType}) => string,
+  s3Path: ({originalFilename, originalExtension, contentType, record }: {
+    originalFilename: string,
+    originalExtension: string,
+    contentType: string,
+    record?: any,
+  }) => string,
 
 
   preview: {