@adminforth/upload 2.3.5 → 2.3.7

package/build.log

@@ -11,5 +11,5 @@ custom/preview.vue
 custom/tsconfig.json
 custom/uploader.vue
 
-sent 46,947 bytes  received 134 bytes  94,162.00 bytes/sec
-total size is 46,465  speedup is 0.99
+sent 47,144 bytes  received 134 bytes  94,556.00 bytes/sec
+total size is 46,662  speedup is 0.99

package/custom/tsconfig.json

@@ -4,16 +4,27 @@
     "paths": {
       "@/*": [
         // "node_modules/adminforth/dist/spa/src/*"
-        "../../../spa/src/*"
+        "../../../adminforth/spa/src/*"
       ],
       "*": [
         // "node_modules/adminforth/dist/spa/node_modules/*"
-        "../../../spa/node_modules/*"
+        "../../../adminforth/spa/node_modules/*"
       ],
       "@@/*": [
         // "node_modules/adminforth/dist/spa/src/*"
         "."
       ]
     }
-  }
+  },
+  "include": [
+    "./**/*.ts",
+    "./**/*.tsx",
+    "./**/*.vue",
+    "../**/*.ts",
+    "../**/*.tsx",
+    "../**/*.vue",
+    "../*.vue",
+    "../*.ts",
+    "../*.tsx"
+  ]
 }

package/dist/custom/tsconfig.json

@@ -4,16 +4,27 @@
     "paths": {
       "@/*": [
         // "node_modules/adminforth/dist/spa/src/*"
-        "../../../spa/src/*"
+        "../../../adminforth/spa/src/*"
       ],
       "*": [
         // "node_modules/adminforth/dist/spa/node_modules/*"
-        "../../../spa/node_modules/*"
+        "../../../adminforth/spa/node_modules/*"
       ],
       "@@/*": [
         // "node_modules/adminforth/dist/spa/src/*"
         "."
       ]
     }
-  }
+  },
+  "include": [
+    "./**/*.ts",
+    "./**/*.tsx",
+    "./**/*.vue",
+    "../**/*.ts",
+    "../**/*.tsx",
+    "../**/*.vue",
+    "../*.vue",
+    "../*.ts",
+    "../*.tsx"
+  ]
 }

package/dist/index.js

@@ -13,13 +13,15 @@ import { RateLimiter } from "adminforth";
 const ADMINFORTH_NOT_YET_USED_TAG = 'adminforth-candidate-for-cleanup';
 export default class UploadPlugin extends AdminForthPlugin {
     constructor(options) {
-        var _a;
+        var _a, _b, _c;
         super(options, import.meta.url);
         this.options = options;
         // for calcualting average time
         this.totalCalls = 0;
         this.totalDuration = 0;
-        this.rateLimiter = new RateLimiter((_a = this.options.generation.rateLimit) === null || _a === void 0 ? void 0 : _a.limit);
+        if ((_b = (_a = this.options.generation) === null || _a === void 0 ? void 0 : _a.rateLimit) === null || _b === void 0 ? void 0 : _b.limit) {
+            this.rateLimiter = new RateLimiter((_c = this.options.generation.rateLimit) === null || _c === void 0 ? void 0 : _c.limit);
+        }
     }
     instanceUniqueRepresentation(pluginOptions) {
         return `${pluginOptions.pathColumnName}`;
@@ -84,27 +86,6 @@ export default class UploadPlugin extends AdminForthPlugin {
             };
             // define components which will be imported from other components
             this.componentPath('imageGenerator.vue');
-            const virtualColumn = {
-                virtual: true,
-                name: `uploader_${this.pluginInstanceId}`,
-                components: {
-                    edit: {
-                        file: this.componentPath('uploader.vue'),
-                        meta: pluginFrontendOptions,
-                    },
-                    create: {
-                        file: this.componentPath('uploader.vue'),
-                        meta: pluginFrontendOptions,
-                    },
-                },
-                showIn: {
-                    create: true,
-                    edit: true,
-                    list: false,
-                    show: false,
-                    filter: false,
-                },
-            };
             if (!resourceConfig.columns[pathColumnIndex].components) {
                 resourceConfig.columns[pathColumnIndex].components = {};
             }
@@ -120,32 +101,15 @@ export default class UploadPlugin extends AdminForthPlugin {
                     meta: pluginFrontendOptions,
                 };
             }
-            // insert virtual column after path column if it is not already there
-            const virtualColumnIndex = resourceConfig.columns.findIndex((column) => column.name === virtualColumn.name);
-            if (virtualColumnIndex === -1) {
-                resourceConfig.columns.splice(pathColumnIndex + 1, 0, virtualColumn);
-            }
-            // if showIn of path column has 'create' or 'edit' remove it but use it for virtual column
-            if (pathColumn.showIn && (pathColumn.showIn.create !== undefined)) {
-                virtualColumn.showIn = Object.assign(Object.assign({}, virtualColumn.showIn), { create: pathColumn.showIn.create });
-                pathColumn.showIn = Object.assign(Object.assign({}, pathColumn.showIn), { create: false });
-            }
-            if (pathColumn.showIn && (pathColumn.showIn.edit !== undefined)) {
-                virtualColumn.showIn = Object.assign(Object.assign({}, virtualColumn.showIn), { edit: pathColumn.showIn.edit });
-                pathColumn.showIn = Object.assign(Object.assign({}, pathColumn.showIn), { edit: false });
-            }
-            virtualColumn.required = pathColumn.required;
-            virtualColumn.label = pathColumn.label;
-            virtualColumn.editingNote = pathColumn.editingNote;
+            resourceConfig.columns[pathColumnIndex].components.create = {
+                file: this.componentPath('uploader.vue'),
+                meta: pluginFrontendOptions,
+            };
+            resourceConfig.columns[pathColumnIndex].components.edit = {
+                file: this.componentPath('uploader.vue'),
+                meta: pluginFrontendOptions,
+            };
             // ** HOOKS FOR CREATE **//
-            // add beforeSave hook to save virtual column to path column
-            resourceConfig.hooks.create.beforeSave.push((_a) => __awaiter(this, [_a], void 0, function* ({ record }) {
-                if (record[virtualColumn.name]) {
-                    record[pathColumnName] = record[virtualColumn.name];
-                    delete record[virtualColumn.name];
-                }
-                return { ok: true };
-            }));
             // in afterSave hook, aremove tag adminforth-not-yet-used from the file
             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);
@@ -196,17 +160,9 @@ export default class UploadPlugin extends AdminForthPlugin {
                 return { ok: true };
             }));
             // ** HOOKS FOR EDIT **//
-            // beforeSave
-            resourceConfig.hooks.edit.beforeSave.push((_a) => __awaiter(this, [_a], void 0, function* ({ record }) {
-                // null is when value is removed
-                if (record[virtualColumn.name] || record[virtualColumn.name] === null) {
-                    record[pathColumnName] = record[virtualColumn.name];
-                }
-                return { ok: true };
-            }));
             // 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) {
+                if (updates[pathColumnName] || updates[pathColumnName] === null) {
                     if (oldRecord[pathColumnName]) {
                         // put tag to delete old file
                         try {
@@ -217,7 +173,7 @@ 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 (updates[virtualColumn.name] !== null) {
+                    if (updates[pathColumnName] !== 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 this.options.storageAdapter.markKeyForNotDeletation(updates[pathColumnName]);
@@ -305,9 +261,9 @@ export default class UploadPlugin extends AdminForthPlugin {
             method: 'POST',
             path: `/plugin/${this.pluginInstanceId}/generate_images`,
             handler: (_a) => __awaiter(this, [_a], void 0, function* ({ body, adminUser, headers }) {
-                var _b, _c;
+                var _b;
                 const { prompt, recordId } = body;
-                if ((_b = this.options.generation.rateLimit) === null || _b === void 0 ? void 0 : _b.limit) {
+                if (this.rateLimiter) {
                     // rate limit
                     // const { error } = RateLimiter.checkRateLimit(
                     //   this.pluginInstanceId, 
@@ -322,7 +278,7 @@ export default class UploadPlugin extends AdminForthPlugin {
                 if (this.options.generation.attachFiles) {
                     // TODO - does it require additional allowed action to check this record id has access to get the image?
                     // or should we mention in docs that user should do validation in method itself
-                    const record = yield this.adminforth.resource(this.resourceConfig.resourceId).get([Filters.EQ((_c = this.resourceConfig.columns.find((column) => column.primaryKey)) === null || _c === void 0 ? void 0 : _c.name, recordId)]);
+                    const record = yield this.adminforth.resource(this.resourceConfig.resourceId).get([Filters.EQ((_b = this.resourceConfig.columns.find((column) => column.primaryKey)) === null || _b === void 0 ? void 0 : _b.name, recordId)]);
                     if (!record) {
                         return { error: `Record with id ${recordId} not found` };
                     }

package/index.ts

@@ -25,7 +25,9 @@ export default class UploadPlugin extends AdminForthPlugin {
     // for calcualting average time
     this.totalCalls = 0;
     this.totalDuration = 0;
+    if (this.options.generation?.rateLimit?.limit) {
     this.rateLimiter = new RateLimiter(this.options.generation.rateLimit?.limit)
+    }
   }
 
   instanceUniqueRepresentation(pluginOptions: any) : string {
@@ -88,28 +90,6 @@ export default class UploadPlugin extends AdminForthPlugin {
     // define components which will be imported from other components
     this.componentPath('imageGenerator.vue');
 
-    const virtualColumn: AdminForthResourceColumn = {
-      virtual: true,
-      name: `uploader_${this.pluginInstanceId}`,
-      components: {
-        edit: {
-          file: this.componentPath('uploader.vue'),
-          meta: pluginFrontendOptions,
-        },
-        create: {
-          file: this.componentPath('uploader.vue'),
-          meta: pluginFrontendOptions,
-        },
-      },
-      showIn: {
-        create: true,
-        edit: true,
-        list: false,
-        show: false,
-        filter: false,
-      },
-    };
-   
     if (!resourceConfig.columns[pathColumnIndex].components) {
       resourceConfig.columns[pathColumnIndex].components = {};
     }
@@ -128,38 +108,18 @@ export default class UploadPlugin extends AdminForthPlugin {
       };
     }
 
-    // insert virtual column after path column if it is not already there
-    const virtualColumnIndex = resourceConfig.columns.findIndex((column: any) => column.name === virtualColumn.name);
-    if (virtualColumnIndex === -1) {
-      resourceConfig.columns.splice(pathColumnIndex + 1, 0, virtualColumn);
-    }
-
-
-    // if showIn of path column has 'create' or 'edit' remove it but use it for virtual column
-    if (pathColumn.showIn && (pathColumn.showIn.create !== undefined)) {
-      virtualColumn.showIn = { ...virtualColumn.showIn, create: pathColumn.showIn.create };
-      pathColumn.showIn = { ...pathColumn.showIn, create: false };
+    resourceConfig.columns[pathColumnIndex].components.create = {
+      file: this.componentPath('uploader.vue'),
+      meta: pluginFrontendOptions,
     }
 
-    if (pathColumn.showIn && (pathColumn.showIn.edit !== undefined)) {
-      virtualColumn.showIn = { ...virtualColumn.showIn, edit: pathColumn.showIn.edit };
-      pathColumn.showIn = { ...pathColumn.showIn, edit: false };
+    resourceConfig.columns[pathColumnIndex].components.edit = {
+      file: this.componentPath('uploader.vue'),
+      meta: pluginFrontendOptions,
     }
 
-    virtualColumn.required = pathColumn.required;
-    virtualColumn.label = pathColumn.label;
-    virtualColumn.editingNote = pathColumn.editingNote;
-
     // ** HOOKS FOR CREATE **//
 
-    // add beforeSave hook to save virtual column to path column
-    resourceConfig.hooks.create.beforeSave.push(async ({ record }: { record: any }) => {
-      if (record[virtualColumn.name]) {
-        record[pathColumnName] = record[virtualColumn.name];
-        delete record[virtualColumn.name];
-      }
-      return { ok: true };
-    });
 
     // in afterSave hook, aremove tag adminforth-not-yet-used from the file
     resourceConfig.hooks.create.afterSave.push(async ({ record }: { record: any }) => {
@@ -223,20 +183,12 @@ export default class UploadPlugin extends AdminForthPlugin {
 
     // ** HOOKS FOR EDIT **//
 
-    // beforeSave
-    resourceConfig.hooks.edit.beforeSave.push(async ({ record }: { record: any }) => {
-      // null is when value is removed
-      if (record[virtualColumn.name] || record[virtualColumn.name] === null) {
-        record[pathColumnName] = record[virtualColumn.name];
-      }
-      return { ok: true };
-    })
 
 
     // add edit postSave hook to delete old file and remove tag from new file
     resourceConfig.hooks.edit.afterSave.push(async ({ updates, oldRecord }: { updates: any, oldRecord: any }) => {
 
-      if (updates[virtualColumn.name] || updates[virtualColumn.name] === null) {
+      if (updates[pathColumnName] || updates[pathColumnName] === null) {
         if (oldRecord[pathColumnName]) {
           // put tag to delete old file
           try {
@@ -246,7 +198,7 @@ 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 (updates[virtualColumn.name] !== null) {
+        if (updates[pathColumnName] !== 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  this.options.storageAdapter.markKeyForNotDeletation(updates[pathColumnName]);
@@ -347,7 +299,7 @@ export default class UploadPlugin extends AdminForthPlugin {
       path: `/plugin/${this.pluginInstanceId}/generate_images`,
       handler: async ({ body, adminUser, headers }) => {
         const { prompt, recordId } = body;
-        if (this.options.generation.rateLimit?.limit) {
+        if (this.rateLimiter) {
           // rate limit
           // const { error } = RateLimiter.checkRateLimit(
           //   this.pluginInstanceId, 

package/package.json

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