@adminforth/upload 1.4.6 → 1.5.0

package/build.log

@@ -11,5 +11,5 @@ custom/preview.vue
 custom/tsconfig.json
 custom/uploader.vue
 
-sent 42,982 bytes  received 134 bytes  86,232.00 bytes/sec
-total size is 42,493  speedup is 0.99
+sent 43,165 bytes  received 134 bytes  86,598.00 bytes/sec
+total size is 42,676  speedup is 0.99

package/custom/imageGenerator.vue

@@ -50,7 +50,7 @@
                       :minValue="0"
                       :maxValue="historicalAverage"
                       :showValues="false"
-                      :progressFormatter="(value: number, percentage: number) => `${ formatTime(loadingTimer) } ( ${ Math.floor( (
+                      :progressFormatter="(value: number, percentage: number) => `${ formatTime(loadingTimer) } ( ~ ${ Math.floor( (
                         loadingTimer < historicalAverage ? loadingTimer : historicalAverage
                       ) / historicalAverage * 100) }% )`"
                     />
@@ -252,15 +252,10 @@ async function confirmImage() {
 
 const loadingTimer: Ref<number | null> = ref(null);
 
-const historicalRuns: Ref<number[]> = ref([]);
 
 const errorMessage: Ref<string | null> = ref(null);
 
-const historicalAverage: Ref<number | null> = computed(() => {
-  if (historicalRuns.value.length === 0) return null;
-  const sum = historicalRuns.value.reduce((a, b) => a + b, 0);
-  return Math.floor(sum / historicalRuns.value.length);
-});
+const historicalAverage: Ref<number | null> = ref(null);
 
 
 function formatTime(seconds: number): string {
@@ -269,6 +264,14 @@ function formatTime(seconds: number): string {
 }
 
 
+async function getHistoricalAverage() {
+  const resp = await callAdminForthApi({
+    path: `/plugin/${props.meta.pluginInstanceId}/averageDuration`,
+    method: 'GET',
+  });
+  historicalAverage.value = resp?.averageDuration || null;
+}
+
 async function generateImages() {
   errorMessage.value = null;
   loading.value = true;
@@ -279,7 +282,8 @@ async function generateImages() {
     loadingTimer.value = elapsed;
   }, 100);
   const currentIndex = caurosel.value?.getActiveItem()?.position || 0;
-  
+
+  await getHistoricalAverage();
   let resp = null;
   let error = null;
   try {
@@ -294,7 +298,6 @@ async function generateImages() {
   } catch (e) {
     console.error(e);
   } finally {
-    historicalRuns.value.push(loadingTimer.value);
     clearInterval(ticker);
     loadingTimer.value = null;
     loading.value = false;
@@ -330,12 +333,17 @@ async function generateImages() {
   // ];
   await nextTick();
 
+
   caurosel.value = new Carousel(
     document.getElementById('gallery'), 
-    images.value.map((img, index) => ({
-      el: document.getElementById('gallery').querySelector(`[data-carousel-item]:nth-child(${index + 1})`),
-      position: index,
-    })),
+    images.value.map((img, index) => {
+      console.log('mapping image', img, index);
+      return {
+        image: img,
+        el: document.getElementById('gallery').querySelector(`[data-carousel-item]:nth-child(${index + 1})`),
+        position: index,
+      };
+    }),
     {
       internal: 0,
       defaultPosition: currentIndex,
@@ -345,6 +353,7 @@ async function generateImages() {
     }
   );
   await nextTick();
+  
   loading.value = false;
 }
 

package/custom/preview.vue

@@ -7,7 +7,6 @@
         class="rounded-md" 
         :style="[maxWidth, minWidth]"
         ref="img"
-        data-zoomable
         @click.stop="zoom.open()" 
       />
       <video 

package/custom/uploader.vue

@@ -229,8 +229,8 @@ const onFileChange = async (e) => {
       reader.readAsDataURL(file);
     }
     
-    const { uploadUrl, tagline, s3Path, error } = await callAdminForthApi({
-        path: `/plugin/${props.meta.pluginInstanceId}/get_s3_upload_url`,
+    const { uploadUrl, uploadExtraParams, filePath, error } = await callAdminForthApi({
+        path: `/plugin/${props.meta.pluginInstanceId}/get_file_upload_url`,
         method: 'POST',
         body: {
           originalFilename: nameNoExtension,
@@ -266,7 +266,9 @@ const onFileChange = async (e) => {
       });
       xhr.open('PUT', uploadUrl, true);
       xhr.setRequestHeader('Content-Type', type);
-      xhr.setRequestHeader('x-amz-tagging', tagline);
+      uploadExtraParams && Object.entries(uploadExtraParams).forEach(([key, value]: [string, string]) => {
+        xhr.setRequestHeader(key, value);
+      })
       xhr.send(file);
     });
     if (!success) {
@@ -284,7 +286,7 @@ const onFileChange = async (e) => {
       return;
     }
     uploaded.value = true;
-    emit('update:value', s3Path);
+    emit('update:value', filePath);
   } catch (error) {
     console.error('Error uploading file:', error);
     adminforth.alert({

package/dist/custom/imageGenerator.vue

@@ -50,7 +50,7 @@
                       :minValue="0"
                       :maxValue="historicalAverage"
                       :showValues="false"
-                      :progressFormatter="(value: number, percentage: number) => `${ formatTime(loadingTimer) } ( ${ Math.floor( (
+                      :progressFormatter="(value: number, percentage: number) => `${ formatTime(loadingTimer) } ( ~ ${ Math.floor( (
                         loadingTimer < historicalAverage ? loadingTimer : historicalAverage
                       ) / historicalAverage * 100) }% )`"
                     />
@@ -252,15 +252,10 @@ async function confirmImage() {
 
 const loadingTimer: Ref<number | null> = ref(null);
 
-const historicalRuns: Ref<number[]> = ref([]);
 
 const errorMessage: Ref<string | null> = ref(null);
 
-const historicalAverage: Ref<number | null> = computed(() => {
-  if (historicalRuns.value.length === 0) return null;
-  const sum = historicalRuns.value.reduce((a, b) => a + b, 0);
-  return Math.floor(sum / historicalRuns.value.length);
-});
+const historicalAverage: Ref<number | null> = ref(null);
 
 
 function formatTime(seconds: number): string {
@@ -269,6 +264,14 @@ function formatTime(seconds: number): string {
 }
 
 
+async function getHistoricalAverage() {
+  const resp = await callAdminForthApi({
+    path: `/plugin/${props.meta.pluginInstanceId}/averageDuration`,
+    method: 'GET',
+  });
+  historicalAverage.value = resp?.averageDuration || null;
+}
+
 async function generateImages() {
   errorMessage.value = null;
   loading.value = true;
@@ -279,7 +282,8 @@ async function generateImages() {
     loadingTimer.value = elapsed;
   }, 100);
   const currentIndex = caurosel.value?.getActiveItem()?.position || 0;
-  
+
+  await getHistoricalAverage();
   let resp = null;
   let error = null;
   try {
@@ -294,7 +298,6 @@ async function generateImages() {
   } catch (e) {
     console.error(e);
   } finally {
-    historicalRuns.value.push(loadingTimer.value);
     clearInterval(ticker);
     loadingTimer.value = null;
     loading.value = false;
@@ -330,12 +333,17 @@ async function generateImages() {
   // ];
   await nextTick();
 
+
   caurosel.value = new Carousel(
     document.getElementById('gallery'), 
-    images.value.map((img, index) => ({
-      el: document.getElementById('gallery').querySelector(`[data-carousel-item]:nth-child(${index + 1})`),
-      position: index,
-    })),
+    images.value.map((img, index) => {
+      console.log('mapping image', img, index);
+      return {
+        image: img,
+        el: document.getElementById('gallery').querySelector(`[data-carousel-item]:nth-child(${index + 1})`),
+        position: index,
+      };
+    }),
     {
       internal: 0,
       defaultPosition: currentIndex,
@@ -345,6 +353,7 @@ async function generateImages() {
     }
   );
   await nextTick();
+  
   loading.value = false;
 }
 

package/dist/custom/preview.vue

@@ -7,7 +7,6 @@
         class="rounded-md" 
         :style="[maxWidth, minWidth]"
         ref="img"
-        data-zoomable
         @click.stop="zoom.open()" 
       />
       <video 

package/dist/custom/uploader.vue

@@ -229,8 +229,8 @@ const onFileChange = async (e) => {
       reader.readAsDataURL(file);
     }
     
-    const { uploadUrl, tagline, s3Path, error } = await callAdminForthApi({
-        path: `/plugin/${props.meta.pluginInstanceId}/get_s3_upload_url`,
+    const { uploadUrl, uploadExtraParams, filePath, error } = await callAdminForthApi({
+        path: `/plugin/${props.meta.pluginInstanceId}/get_file_upload_url`,
         method: 'POST',
         body: {
           originalFilename: nameNoExtension,
@@ -266,7 +266,9 @@ const onFileChange = async (e) => {
       });
       xhr.open('PUT', uploadUrl, true);
       xhr.setRequestHeader('Content-Type', type);
-      xhr.setRequestHeader('x-amz-tagging', tagline);
+      uploadExtraParams && Object.entries(uploadExtraParams).forEach(([key, value]: [string, string]) => {
+        xhr.setRequestHeader(key, value);
+      })
       xhr.send(file);
     });
     if (!success) {
@@ -284,7 +286,7 @@ const onFileChange = async (e) => {
       return;
     }
     uploaded.value = true;
-    emit('update:value', s3Path);
+    emit('update:value', filePath);
   } catch (error) {
     console.error('Error uploading file:', error);
     adminforth.alert({

package/dist/index.js

@@ -7,8 +7,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { getSignedUrl } from '@aws-sdk/s3-request-presigner';
-import { ExpirationStatus, GetObjectCommand, PutObjectCommand, S3 } from '@aws-sdk/client-s3';
 import { AdminForthPlugin, Filters, suggestIfTypo } from "adminforth";
 import { Readable } from "stream";
 import { RateLimiter } from "adminforth";
@@ -17,80 +15,26 @@ export default class UploadPlugin extends AdminForthPlugin {
     constructor(options) {
         super(options, import.meta.url);
         this.options = options;
+        // for calcualting average time
+        this.totalCalls = 0;
+        this.totalDuration = 0;
     }
     instanceUniqueRepresentation(pluginOptions) {
         return `${pluginOptions.pathColumnName}`;
     }
     setupLifecycleRule() {
         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,
-            });
-            // check bucket exists
-            const bucketExists = s3.headBucket({ Bucket: this.options.s3Bucket });
-            if (!bucketExists) {
-                throw new Error(`Bucket ${this.options.s3Bucket} does not exist`);
-            }
-            // check that lifecycle rule exists
-            let ruleExists = false;
-            try {
-                const lifecycleConfig = yield s3.getBucketLifecycleConfiguration({ Bucket: this.options.s3Bucket });
-                ruleExists = lifecycleConfig.Rules.some((rule) => rule.ID === CLEANUP_RULE_ID);
-            }
-            catch (e) {
-                if (e.name !== 'NoSuchLifecycleConfiguration') {
-                    console.error(`⛔ Error checking lifecycle configuration, please check keys have permissions to 
-getBucketLifecycleConfiguration on bucket ${this.options.s3Bucket} in region ${this.options.s3Region}. Exception:`, e);
-                    throw e;
-                }
-                else {
-                    ruleExists = false;
-                }
-            }
-            if (!ruleExists) {
-                // create
-                // rule deletes object has tag adminforth-candidate-for-cleanup = true after 2 days
-                const params = {
-                    Bucket: this.options.s3Bucket,
-                    LifecycleConfiguration: {
-                        Rules: [
-                            {
-                                ID: CLEANUP_RULE_ID,
-                                Status: ExpirationStatus.Enabled,
-                                Filter: {
-                                    Tag: {
-                                        Key: ADMINFORTH_NOT_YET_USED_TAG,
-                                        Value: 'true'
-                                    }
-                                },
-                                Expiration: {
-                                    Days: 2
-                                }
-                            }
-                        ]
-                    }
-                };
-                yield s3.putBucketLifecycleConfiguration(params);
-            }
+            this.options.storage.adapter.setupLifecycle();
         });
     }
-    genPreviewUrl(record, s3) {
+    genPreviewUrl(record) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;
             if ((_a = this.options.preview) === null || _a === void 0 ? void 0 : _a.previewUrl) {
-                record[`previewUrl_${this.pluginInstanceId}`] = this.options.preview.previewUrl({ s3Path: record[this.options.pathColumnName] });
+                record[`previewUrl_${this.pluginInstanceId}`] = this.options.preview.previewUrl({ filePath: record[this.options.pathColumnName] });
                 return;
             }
-            const previewUrl = yield yield getSignedUrl(s3, new GetObjectCommand({
-                Bucket: this.options.s3Bucket,
-                Key: record[this.options.pathColumnName],
-            }));
+            const previewUrl = yield this.options.storage.adapter.getDownloadUrl(record[this.options.pathColumnName], 1800);
             record[`previewUrl_${this.pluginInstanceId}`] = previewUrl;
         });
     }
@@ -202,22 +146,9 @@ getBucketLifecycleConfiguration on bucket ${this.options.s3Bucket} in region ${t
             resourceConfig.hooks.create.afterSave.push((_a) => __awaiter(this, [_a], void 0, function* ({ record }) {
                 process.env.HEAVY_DEBUG && console.log('💾💾  after save ', record === null || record === void 0 ? void 0 : record.id);
                 if (record[pathColumnName]) {
-                    const s3 = new S3({
-                        credentials: {
-                            accessKeyId: this.options.s3AccessKeyId,
-                            secretAccessKey: this.options.s3SecretAccessKey,
-                        },
-                        region: this.options.s3Region,
-                    });
                     process.env.HEAVY_DEBUG && console.log('🪥🪥 remove ObjectTagging', record[pathColumnName]);
                     // 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],
-                        Tagging: {
-                            TagSet: []
-                        }
-                    });
+                    yield this.options.storage.adapter.markKeyForNotDeletation(record[pathColumnName]);
                 }
                 return { ok: true };
             }));
@@ -230,14 +161,7 @@ getBucketLifecycleConfiguration on bucket ${this.options.s3Bucket} in region ${t
                         return { ok: true };
                     }
                     if (record[pathColumnName]) {
-                        const s3 = new S3({
-                            credentials: {
-                                accessKeyId: this.options.s3AccessKeyId,
-                                secretAccessKey: this.options.s3SecretAccessKey,
-                            },
-                            region: this.options.s3Region,
-                        });
-                        yield this.genPreviewUrl(record, s3);
+                        yield this.genPreviewUrl(record);
                     }
                     return { ok: true };
                 }));
@@ -245,16 +169,9 @@ getBucketLifecycleConfiguration on bucket ${this.options.s3Bucket} in region ${t
             // ** HOOKS FOR LIST **//
             if (pathColumn.showIn.list) {
                 resourceConfig.hooks.list.afterDatasourceResponse.push((_a) => __awaiter(this, [_a], void 0, function* ({ response }) {
-                    const s3 = new S3({
-                        credentials: {
-                            accessKeyId: this.options.s3AccessKeyId,
-                            secretAccessKey: this.options.s3SecretAccessKey,
-                        },
-                        region: this.options.s3Region,
-                    });
                     yield Promise.all(response.map((record) => __awaiter(this, void 0, void 0, function* () {
                         if (record[this.options.pathColumnName]) {
-                            yield this.genPreviewUrl(record, s3);
+                            yield this.genPreviewUrl(record);
                         }
                     })));
                     return { ok: true };
@@ -264,26 +181,8 @@ getBucketLifecycleConfiguration on bucket ${this.options.s3Bucket} in region ${t
             // add delete hook which sets tag adminforth-candidate-for-cleanup to true
             resourceConfig.hooks.delete.afterSave.push((_a) => __awaiter(this, [_a], void 0, function* ({ record }) {
                 if (record[pathColumnName]) {
-                    const s3 = new S3({
-                        credentials: {
-                            accessKeyId: this.options.s3AccessKeyId,
-                            secretAccessKey: this.options.s3SecretAccessKey,
-                        },
-                        region: this.options.s3Region,
-                    });
                     try {
-                        yield s3.putObjectTagging({
-                            Bucket: this.options.s3Bucket,
-                            Key: record[pathColumnName],
-                            Tagging: {
-                                TagSet: [
-                                    {
-                                        Key: ADMINFORTH_NOT_YET_USED_TAG,
-                                        Value: 'true'
-                                    }
-                                ]
-                            }
-                        });
+                        yield this.options.storage.adapter.markKeyForDeletation(record[pathColumnName]);
                     }
                     catch (e) {
                         // file might be e.g. already deleted, so we catch error
@@ -304,28 +203,10 @@ getBucketLifecycleConfiguration on bucket ${this.options.s3Bucket} in region ${t
             // add edit postSave hook to delete old file and remove tag from new file
             resourceConfig.hooks.edit.afterSave.push((_a) => __awaiter(this, [_a], void 0, function* ({ updates, oldRecord }) {
                 if (updates[virtualColumn.name] || updates[virtualColumn.name] === null) {
-                    const s3 = new S3({
-                        credentials: {
-                            accessKeyId: this.options.s3AccessKeyId,
-                            secretAccessKey: this.options.s3SecretAccessKey,
-                        },
-                        region: this.options.s3Region,
-                    });
                     if (oldRecord[pathColumnName]) {
                         // put tag to delete old file
                         try {
-                            yield s3.putObjectTagging({
-                                Bucket: this.options.s3Bucket,
-                                Key: oldRecord[pathColumnName],
-                                Tagging: {
-                                    TagSet: [
-                                        {
-                                            Key: ADMINFORTH_NOT_YET_USED_TAG,
-                                            Value: 'true'
-                                        }
-                                    ]
-                                }
-                            });
+                            yield this.options.storage.adapter.markKeyForDeletation(oldRecord[pathColumnName]);
                         }
                         catch (e) {
                             // file might be e.g. already deleted, so we catch error
@@ -335,13 +216,7 @@ getBucketLifecycleConfiguration on bucket ${this.options.s3Bucket} in region ${t
                     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: updates[pathColumnName],
-                            Tagging: {
-                                TagSet: []
-                            }
-                        });
+                        yield this.options.storage.adapter.markKeyForNotDeletation(updates[pathColumnName]);
                     }
                 }
                 return { ok: true };
@@ -354,9 +229,20 @@ getBucketLifecycleConfiguration on bucket ${this.options.s3Bucket} in region ${t
         this.setupLifecycleRule();
     }
     setupEndpoints(server) {
+        server.endpoint({
+            method: 'GET',
+            path: `/plugin/${this.pluginInstanceId}/averageDuration`,
+            handler: () => __awaiter(this, void 0, void 0, function* () {
+                return {
+                    totalCalls: this.totalCalls,
+                    totalDuration: this.totalDuration,
+                    averageDuration: this.totalCalls ? this.totalDuration / this.totalCalls : null,
+                };
+            })
+        });
         server.endpoint({
             method: 'POST',
-            path: `/plugin/${this.pluginInstanceId}/get_s3_upload_url`,
+            path: `/plugin/${this.pluginInstanceId}/get_file_upload_url`,
             handler: (_a) => __awaiter(this, [_a], void 0, function* ({ body }) {
                 var _b, _c;
                 const { originalFilename, contentType, size, originalExtension, recordPk } = body;
@@ -371,46 +257,22 @@ getBucketLifecycleConfiguration on bucket ${this.options.s3Bucket} in region ${t
                     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('/')) {
+                const filePath = this.options.filePath({ originalFilename, originalExtension, contentType, record });
+                if (filePath.startsWith('/')) {
                     throw new Error('s3Path should not start with /, please adjust s3path function to not return / at the start of the path');
                 }
-                const s3 = new S3({
-                    credentials: {
-                        accessKeyId: this.options.s3AccessKeyId,
-                        secretAccessKey: this.options.s3SecretAccessKey,
-                    },
-                    region: this.options.s3Region,
-                });
-                const tagline = `${ADMINFORTH_NOT_YET_USED_TAG}=true`;
-                const params = {
-                    Bucket: this.options.s3Bucket,
-                    Key: s3Path,
-                    ContentType: contentType,
-                    ACL: (this.options.s3ACL || 'private'),
-                    Tagging: tagline,
-                };
-                const uploadUrl = yield yield getSignedUrl(s3, new PutObjectCommand(params), {
-                    expiresIn: 1800,
-                    unhoistableHeaders: new Set(['x-amz-tagging']),
-                });
+                const { uploadUrl, uploadExtraParams } = yield this.options.storage.adapter.getUploadSignedUrl(filePath, contentType, 1800);
                 let 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') {
-                    previewUrl = `https://${this.options.s3Bucket}.s3.${this.options.s3Region}.amazonaws.com/${s3Path}`;
+                    previewUrl = this.options.preview.previewUrl({ filePath });
                 }
                 else {
-                    previewUrl = yield getSignedUrl(s3, new GetObjectCommand({
-                        Bucket: this.options.s3Bucket,
-                        Key: s3Path,
-                    }));
+                    previewUrl = yield this.options.storage.adapter.getDownloadUrl(filePath, 1800);
                 }
                 return {
                     uploadUrl,
-                    s3Path,
-                    tagline,
+                    filePath,
+                    uploadExtraParams,
                     previewUrl,
                 };
             })
@@ -467,6 +329,7 @@ getBucketLifecycleConfiguration on bucket ${this.options.s3Bucket} in region ${t
                         yield new Promise((resolve) => setTimeout(resolve, 2000));
                         return `https://picsum.photos/200/300?random=${Math.floor(Math.random() * 1000)}`;
                     }
+                    const start = +new Date();
                     const resp = yield this.options.generation.adapter.generate({
                         prompt,
                         inputFiles: attachmentFiles,
@@ -478,6 +341,8 @@ getBucketLifecycleConfiguration on bucket ${this.options.s3Bucket} in region ${t
                         error = resp.error;
                         return;
                     }
+                    this.totalCalls++;
+                    this.totalDuration += (+new Date() - start) / 1000;
                     return resp.imageURLs[0];
                 })));
                 return { error, images };

package/index.ts

@@ -1,7 +1,5 @@
 
 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, AdminForthResource, Filters, IAdminForth, IHttpServer, suggestIfTypo } from "adminforth";
 import { Readable } from "stream";
 import { RateLimiter } from "adminforth";
@@ -13,9 +11,16 @@ export default class UploadPlugin extends AdminForthPlugin {
 
   adminforth!: IAdminForth;
 
+  totalCalls: number;
+  totalDuration: number;
+
   constructor(options: PluginOptions) {
     super(options, import.meta.url);
     this.options = options;
+
+    // for calcualting average time
+    this.totalCalls = 0;
+    this.totalDuration = 0;
   }
 
   instanceUniqueRepresentation(pluginOptions: any) : string {
@@ -23,76 +28,15 @@ 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,
-    });
-   
-    // check bucket exists
-    const bucketExists = s3.headBucket({ Bucket: this.options.s3Bucket })
-    if (!bucketExists) {
-      throw new Error(`Bucket ${this.options.s3Bucket} does not exist`);
-    }
-
-    // check that lifecycle rule exists
-    let ruleExists: boolean = false;
-
-    try {
-        const lifecycleConfig: any = await s3.getBucketLifecycleConfiguration({ Bucket: this.options.s3Bucket });
-        ruleExists = lifecycleConfig.Rules.some((rule: any) => rule.ID === CLEANUP_RULE_ID);
-    } catch (e: any) {
-      if (e.name !== 'NoSuchLifecycleConfiguration') {
-        console.error(`⛔ Error checking lifecycle configuration, please check keys have permissions to 
-getBucketLifecycleConfiguration on bucket ${this.options.s3Bucket} in region ${this.options.s3Region}. Exception:`, e);
-        throw e;
-      } else {
-        ruleExists = false;
-      }
-    }
-
-    if (!ruleExists) {
-      // create
-      // rule deletes object has tag adminforth-candidate-for-cleanup = true after 2 days
-      const params = {
-        Bucket: this.options.s3Bucket,
-        LifecycleConfiguration: {
-          Rules: [
-            {
-              ID: CLEANUP_RULE_ID,
-              Status: ExpirationStatus.Enabled,
-              Filter: {
-                Tag: {
-                  Key: ADMINFORTH_NOT_YET_USED_TAG,
-                  Value: 'true'
-                }
-              },
-              Expiration: {
-                Days: 2
-              }
-            }
-          ]
-        }
-      };
-
-      await s3.putBucketLifecycleConfiguration(params);
-    }
+    this.options.storage.adapter.setupLifecycle();
   }
 
-  async genPreviewUrl(record: any, s3: S3) {
+  async genPreviewUrl(record: any) {
     if (this.options.preview?.previewUrl) {
-      record[`previewUrl_${this.pluginInstanceId}`] = this.options.preview.previewUrl({ s3Path: record[this.options.pathColumnName] });
+      record[`previewUrl_${this.pluginInstanceId}`] = this.options.preview.previewUrl({ filePath: record[this.options.pathColumnName] });
       return;
     }
-    const previewUrl = await await getSignedUrl(s3, new GetObjectCommand({
-      Bucket: this.options.s3Bucket,
-      Key: record[this.options.pathColumnName],
-    }));
+    const previewUrl = await this.options.storage.adapter.getDownloadUrl(record[this.options.pathColumnName], 1800);
 
     record[`previewUrl_${this.pluginInstanceId}`] = previewUrl;
   }
@@ -215,23 +159,9 @@ getBucketLifecycleConfiguration on bucket ${this.options.s3Bucket} in region ${t
       process.env.HEAVY_DEBUG && console.log('💾💾  after save ', record?.id);
       
       if (record[pathColumnName]) {
-        const s3 = new S3({
-          credentials: {
-            accessKeyId: this.options.s3AccessKeyId,
-            secretAccessKey: this.options.s3SecretAccessKey,
-          },
-
-          region: this.options.s3Region,
-        });
         process.env.HEAVY_DEBUG && console.log('🪥🪥 remove ObjectTagging', record[pathColumnName]);
         // 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],
-          Tagging: {
-            TagSet: []
-          }
-        });
+        await this.options.storage.adapter.markKeyForNotDeletation(record[pathColumnName]);
       }
       return { ok: true };
     });
@@ -248,16 +178,7 @@ getBucketLifecycleConfiguration on bucket ${this.options.s3Bucket} in region ${t
           return { ok: true };
         }
         if (record[pathColumnName]) {
-          const s3 = new S3({
-            credentials: {
-              accessKeyId: this.options.s3AccessKeyId,
-              secretAccessKey: this.options.s3SecretAccessKey,
-            },
-
-            region: this.options.s3Region,
-          });
-
-          await this.genPreviewUrl(record, s3);
+          await this.genPreviewUrl(record)
         }
         return { ok: true };
       });
@@ -268,18 +189,9 @@ getBucketLifecycleConfiguration on bucket ${this.options.s3Bucket} in region ${t
 
     if (pathColumn.showIn.list) {
       resourceConfig.hooks.list.afterDatasourceResponse.push(async ({ response }: { response: any }) => {
-        const s3 = new S3({
-          credentials: {
-            accessKeyId: this.options.s3AccessKeyId,
-            secretAccessKey: this.options.s3SecretAccessKey,
-          },
-
-          region: this.options.s3Region,
-        });
-  
        await Promise.all(response.map(async (record: any) => {
           if (record[this.options.pathColumnName]) {
-            await this.genPreviewUrl(record, s3);
+            await this.genPreviewUrl(record)
           }
         }));
         return { ok: true };
@@ -291,28 +203,8 @@ getBucketLifecycleConfiguration on bucket ${this.options.s3Bucket} in region ${t
     // add delete hook which sets tag adminforth-candidate-for-cleanup to true
     resourceConfig.hooks.delete.afterSave.push(async ({ record }: { record: any }) => {
       if (record[pathColumnName]) {
-        const s3 = new S3({
-          credentials: {
-            accessKeyId: this.options.s3AccessKeyId,
-            secretAccessKey: this.options.s3SecretAccessKey,
-          },
-
-          region: this.options.s3Region,
-        });
-
         try {
-          await s3.putObjectTagging({
-            Bucket: this.options.s3Bucket,
-            Key: record[pathColumnName],
-            Tagging: {
-              TagSet: [
-                {
-                  Key: ADMINFORTH_NOT_YET_USED_TAG,
-                  Value: 'true'
-                }
-              ]
-            }
-          });
+          await this.options.storage.adapter.markKeyForDeletation(record[pathColumnName]);
         } catch (e) {
           // file might be e.g. already deleted, so we catch error
           console.error(`Error setting tag ${ADMINFORTH_NOT_YET_USED_TAG} to true for object ${record[pathColumnName]}. File will not be auto-cleaned up`, e);
@@ -338,30 +230,10 @@ getBucketLifecycleConfiguration on bucket ${this.options.s3Bucket} in region ${t
     resourceConfig.hooks.edit.afterSave.push(async ({ updates, oldRecord }: { updates: any, oldRecord: any }) => {
 
       if (updates[virtualColumn.name] || updates[virtualColumn.name] === null) {
-        const s3 = new S3({
-          credentials: {
-            accessKeyId: this.options.s3AccessKeyId,
-            secretAccessKey: this.options.s3SecretAccessKey,
-          },
-
-          region: this.options.s3Region,
-        });
-
         if (oldRecord[pathColumnName]) {
           // put tag to delete old file
           try {
-            await s3.putObjectTagging({
-              Bucket: this.options.s3Bucket,
-              Key: oldRecord[pathColumnName],
-              Tagging: {
-                TagSet: [
-                  {
-                    Key: ADMINFORTH_NOT_YET_USED_TAG,
-                    Value: 'true'
-                  }
-                ]
-              }
-            });
+            await this.options.storage.adapter.markKeyForDeletation(oldRecord[pathColumnName]);
           } catch (e) {
             // file might be e.g. already deleted, so we catch error
             console.error(`Error setting tag ${ADMINFORTH_NOT_YET_USED_TAG} to true for object ${oldRecord[pathColumnName]}. File will not be auto-cleaned up`, e);
@@ -370,13 +242,7 @@ getBucketLifecycleConfiguration on bucket ${this.options.s3Bucket} in region ${t
         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: updates[pathColumnName],
-            Tagging: {
-              TagSet: []
-            }
-          });
+          await  this.options.storage.adapter.markKeyForNotDeletation(updates[pathColumnName]);
         }
       }
       return { ok: true };
@@ -390,11 +256,24 @@ getBucketLifecycleConfiguration on bucket ${this.options.s3Bucket} in region ${t
     // called here because modifyResourceConfig can be called in build time where there is no environment and AWS secrets
     this.setupLifecycleRule();
   }
+  
 
   setupEndpoints(server: IHttpServer) {
+    server.endpoint({
+      method: 'GET',
+      path: `/plugin/${this.pluginInstanceId}/averageDuration`,
+      handler: async () => {
+        return {
+          totalCalls: this.totalCalls,
+          totalDuration: this.totalDuration,
+          averageDuration: this.totalCalls ? this.totalDuration / this.totalCalls : null,
+        };
+      }
+    });
+
     server.endpoint({
       method: 'POST',
-      path: `/plugin/${this.pluginInstanceId}/get_s3_upload_url`,
+      path: `/plugin/${this.pluginInstanceId}/get_file_upload_url`,
       handler: async ({ body }) => {
         const { originalFilename, contentType, size, originalExtension, recordPk } = body;
 
@@ -413,49 +292,22 @@ getBucketLifecycleConfiguration on bucket ${this.options.s3Bucket} in region ${t
           )
         }
 
-        const s3Path: string = this.options.s3Path({ originalFilename, originalExtension, contentType, record });
-        if (s3Path.startsWith('/')) {
+        const filePath: string = this.options.filePath({ originalFilename, originalExtension, contentType, record });
+        if (filePath.startsWith('/')) {
           throw new Error('s3Path should not start with /, please adjust s3path function to not return / at the start of the path');
         }
-        const s3 = new S3({
-          credentials: {
-            accessKeyId: this.options.s3AccessKeyId,
-            secretAccessKey: this.options.s3SecretAccessKey,
-          },
-
-          region: this.options.s3Region,
-        });
-
-        const tagline = `${ADMINFORTH_NOT_YET_USED_TAG}=true`;
-        const params = {
-          Bucket: this.options.s3Bucket,
-          Key: s3Path,
-          ContentType: contentType,
-          ACL: (this.options.s3ACL || 'private') as  ObjectCannedACL,
-          Tagging: tagline,
-        };
-
-        const uploadUrl = await await getSignedUrl(s3, new PutObjectCommand(params), {
-          expiresIn: 1800,
-          unhoistableHeaders: new Set(['x-amz-tagging']),
-        });
-
+        const { uploadUrl, uploadExtraParams } = await this.options.storage.adapter.getUploadSignedUrl(filePath, contentType, 1800);
         let previewUrl;
         if (this.options.preview?.previewUrl) {
-          previewUrl = this.options.preview.previewUrl({ s3Path });
-        } else if (this.options.s3ACL === 'public-read') {
-          previewUrl = `https://${this.options.s3Bucket}.s3.${this.options.s3Region}.amazonaws.com/${s3Path}`;
+          previewUrl = this.options.preview.previewUrl({ filePath });
         } else {
-          previewUrl = await getSignedUrl(s3, new GetObjectCommand({
-            Bucket: this.options.s3Bucket,
-            Key: s3Path,
-          }));
+          previewUrl = await this.options.storage.adapter.getDownloadUrl(filePath, 1800);
         }
         
         return {
           uploadUrl,
-          s3Path,
-          tagline,
+          filePath,
+          uploadExtraParams,
           previewUrl,
         };
       }
@@ -527,6 +379,7 @@ getBucketLifecycleConfiguration on bucket ${this.options.s3Bucket} in region ${t
               await new Promise((resolve) => setTimeout(resolve, 2000));
               return `https://picsum.photos/200/300?random=${Math.floor(Math.random() * 1000)}`;
             }
+            const start = +new Date();
             const resp = await this.options.generation.adapter.generate(
               {
                 prompt,
@@ -541,6 +394,9 @@ getBucketLifecycleConfiguration on bucket ${this.options.s3Bucket} in region ${t
               error = resp.error;
               return;
             }
+
+            this.totalCalls++;
+            this.totalDuration += (+new Date() - start) / 1000;
             
             return resp.imageURLs[0]
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adminforth/upload",
-  "version": "1.4.6",
+  "version": "1.5.0",
   "description": "Plugin for uploading files for adminforth",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/types.ts

@@ -1,4 +1,4 @@
-import { AdminUser, ImageGenerationAdapter } from "adminforth";
+import { AdminUser, ImageGenerationAdapter, StorageAdapter } from "adminforth";
 
 export type PluginOptions = {
 
@@ -18,32 +18,6 @@ export type PluginOptions = {
    */
   maxFileSize?: number;
 
-  /**
-   * S3 bucket name where we will upload the files, e.g. 'my-bucket'
-   */
-  s3Bucket: string,
-
-  /**
-   * S3 region, e.g. 'us-east-1'
-   */
-  s3Region: string,
-
-  /**
-   * S3 access key id
-   */
-  s3AccessKeyId: string,
-
-  /**
-   * S3 secret access key
-   */
-  s3SecretAccessKey: string,
-
-  /**
-   * ACL which will be set to uploaded file, e.g. 'public-read'.
-   * If you want to use 'public-read', it is your responsibility to set the "ACL Enabled" to true in the S3 bucket policy and Uncheck "Block all public access" in the bucket settings.
-   */
-  s3ACL?: string,
-
   /**
    * The path where the file will be uploaded to the S3 bucket, same path will be stored in the database
    * in the column specified in {@link pathColumnName}
@@ -55,7 +29,7 @@ export type PluginOptions = {
    * ```
    * 
    */
-  s3Path: ({originalFilename, originalExtension, contentType, record }: {
+  filePath: ({originalFilename, originalExtension, contentType, record }: {
     originalFilename: string,
     originalExtension: string,
     contentType: string,
@@ -113,7 +87,7 @@ export type PluginOptions = {
      * ```
      * 
      */ 
-    previewUrl?: ({s3Path}) => string,
+    previewUrl?: ({filePath}) => string,
   }
 
 
@@ -181,4 +155,12 @@ export type PluginOptions = {
     
   }
 
+  storage?: {
+    /**
+     * The adapter used to store the files.
+     * For now only S3 adapter is supported.
+     */
+    adapter: StorageAdapter,
+  }
+
 }