@adminforth/upload 1.1.1 → 1.2.0

package/README.md

@@ -0,0 +1,2 @@
+
+Ussage guide and documentation: https://adminforth.dev/docs/tutorial/Plugins/upload/

package/dist/index.js

@@ -99,7 +99,7 @@ getBucketLifecycleConfiguration on bucket ${this.options.s3Bucket} in region ${t
             modifyResourceConfig: { get: () => super.modifyResourceConfig }
         });
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+            var _a, _b, _c, _d;
             _super.modifyResourceConfig.call(this, adminforth, resourceConfig);
             // after column to store the path of the uploaded file, add new VirtualColumn,
             // show only in edit and create views
@@ -149,33 +149,34 @@ getBucketLifecycleConfiguration on bucket ${this.options.s3Bucket} in region ${t
                     list: false,
                     show: false,
                     filter: false,
-                }
+                },
             };
             if (!resourceConfig.columns[pathColumnIndex].components) {
                 resourceConfig.columns[pathColumnIndex].components = {};
             }
-            if (((_e = this.options.preview) === null || _e === void 0 ? void 0 : _e.showInList) || ((_f = this.options.preview) === null || _f === void 0 ? void 0 : _f.showInList) === undefined) {
-                // add preview column to list
-                resourceConfig.columns[pathColumnIndex].components.list = {
-                    file: this.componentPath('preview.vue'),
-                    meta: pluginFrontendOptions,
-                };
-            }
-            if (((_g = this.options.preview) === null || _g === void 0 ? void 0 : _g.showInShow) || ((_h = this.options.preview) === null || _h === void 0 ? void 0 : _h.showInShow) === undefined) {
-                resourceConfig.columns[pathColumnIndex].components.show = {
-                    file: this.componentPath('preview.vue'),
-                    meta: pluginFrontendOptions,
-                };
-            }
+            const pathColumn = resourceConfig.columns[pathColumnIndex];
+            // add preview column to list
+            resourceConfig.columns[pathColumnIndex].components.list = {
+                file: this.componentPath('preview.vue'),
+                meta: pluginFrontendOptions,
+            };
+            resourceConfig.columns[pathColumnIndex].components.show = {
+                file: this.componentPath('preview.vue'),
+                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
-            const pathColumn = resourceConfig.columns[pathColumnIndex];
-            if (pathColumn.showIn && (pathColumn.showIn.create || pathColumn.showIn.edit)) {
-                pathColumn.showIn = Object.assign(Object.assign({}, pathColumn.showIn), { create: false, edit: false });
+            // 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;
@@ -214,25 +215,27 @@ getBucketLifecycleConfiguration on bucket ${this.options.s3Bucket} in region ${t
             }));
             // ** HOOKS FOR SHOW **//
             // add show hook to get presigned URL
-            resourceConfig.hooks.show.afterDatasourceResponse.push((_a) => __awaiter(this, [_a], void 0, function* ({ response }) {
-                const record = response[0];
-                if (!record) {
+            if (pathColumn.showIn.show) {
+                resourceConfig.hooks.show.afterDatasourceResponse.push((_a) => __awaiter(this, [_a], void 0, function* ({ response }) {
+                    const record = response[0];
+                    if (!record) {
+                        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);
+                    }
                     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);
-                }
-                return { ok: true };
-            }));
+                }));
+            }
             // ** HOOKS FOR LIST **//
-            if (((_j = this.options.preview) === null || _j === void 0 ? void 0 : _j.showInList) || ((_k = this.options.preview) === null || _k === void 0 ? void 0 : _k.showInList) === undefined) {
+            if (pathColumn.showIn.list) {
                 resourceConfig.hooks.list.afterDatasourceResponse.push((_a) => __awaiter(this, [_a], void 0, function* ({ response }) {
                     const s3 = new S3({
                         credentials: {

package/index.ts

@@ -150,27 +150,24 @@ getBucketLifecycleConfiguration on bucket ${this.options.s3Bucket} in region ${t
         list: false,
         show: false,
         filter: false,
-      }
+      },
     };
    
     if (!resourceConfig.columns[pathColumnIndex].components) {
       resourceConfig.columns[pathColumnIndex].components = {};
     }
+    const pathColumn = resourceConfig.columns[pathColumnIndex];
     
-    if (this.options.preview?.showInList || this.options.preview?.showInList === undefined) {
-      // add preview column to list
-      resourceConfig.columns[pathColumnIndex].components.list = {
-        file: this.componentPath('preview.vue'),
-        meta: pluginFrontendOptions,
-      };
-    }
+    // add preview column to list
+    resourceConfig.columns[pathColumnIndex].components.list = {
+      file: this.componentPath('preview.vue'),
+      meta: pluginFrontendOptions,
+    };
 
-    if (this.options.preview?.showInShow || this.options.preview?.showInShow === undefined) {
-      resourceConfig.columns[pathColumnIndex].components.show = {
-        file: this.componentPath('preview.vue'),
-        meta: pluginFrontendOptions,
-      };
-    }
+    resourceConfig.columns[pathColumnIndex].components.show = {
+      file: this.componentPath('preview.vue'),
+      meta: pluginFrontendOptions,
+    };
 
     // insert virtual column after path column if it is not already there
     const virtualColumnIndex = resourceConfig.columns.findIndex((column: any) => column.name === virtualColumn.name);
@@ -178,10 +175,16 @@ getBucketLifecycleConfiguration on bucket ${this.options.s3Bucket} in region ${t
       resourceConfig.columns.splice(pathColumnIndex + 1, 0, virtualColumn);
     }
 
-    // if showIn of path column has 'create' or 'edit' remove it
-    const pathColumn = resourceConfig.columns[pathColumnIndex];
-    if (pathColumn.showIn && (pathColumn.showIn.create || pathColumn.showIn.edit)) {
-      pathColumn.showIn = { ...pathColumn.showIn, create: false, edit: false };
+
+    // 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 };
+    }
+
+    if (pathColumn.showIn && (pathColumn.showIn.edit !== undefined)) {
+      virtualColumn.showIn = { ...virtualColumn.showIn, edit: pathColumn.showIn.edit };
+      pathColumn.showIn = { ...pathColumn.showIn, edit: false };
     }
 
     virtualColumn.required = pathColumn.required;
@@ -229,30 +232,33 @@ getBucketLifecycleConfiguration on bucket ${this.options.s3Bucket} in region ${t
 
 
     // add show hook to get presigned URL
-    resourceConfig.hooks.show.afterDatasourceResponse.push(async ({ response }: { response: any }) => {
-      const record = response[0];
-      if (!record) {
-        return { ok: true };
-      }
-      if (record[pathColumnName]) {
-        const s3 = new S3({
-          credentials: {
-            accessKeyId: this.options.s3AccessKeyId,
-            secretAccessKey: this.options.s3SecretAccessKey,
-          },
+    if (pathColumn.showIn.show) {
 
-          region: this.options.s3Region,
-        });
+      resourceConfig.hooks.show.afterDatasourceResponse.push(async ({ response }: { response: any }) => {
+        const record = response[0];
+        if (!record) {
+          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);
-      }
-      return { ok: true };
-    });
+          await this.genPreviewUrl(record, s3);
+        }
+        return { ok: true };
+      });
+    }
 
     // ** HOOKS FOR LIST **//
 
 
-    if (this.options.preview?.showInList || this.options.preview?.showInList === undefined) {
+    if (pathColumn.showIn.list) {
       resourceConfig.hooks.list.afterDatasourceResponse.push(async ({ response }: { response: any }) => {
         const s3 = new S3({
           credentials: {

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@adminforth/upload",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "Plugin for uploading files for adminforth",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "homepage": "https://adminforth.dev/docs/tutorial/Plugins/upload/",
   "repository": {
     "type": "git",
     "url": "https://github.com/devforth/adminforth-upload.git"
@@ -19,6 +20,14 @@
     "@aws-sdk/client-s3": "^3.629.0",
     "@aws-sdk/s3-request-presigner": "^3.629.0"
   },
+  "keywords": [
+    "adminforth",
+    "upload",
+    "plugin",
+    "s3-upload",
+    "aws-s3",
+    "file-upload"
+  ],
   "release": {
     "plugins": [
       "@semantic-release/commit-analyzer",

package/types.ts

@@ -64,18 +64,6 @@ export type PluginOptions = {
 
   preview: {
 
-    /**
-     * Whether to show preview of image instead of path in list field
-     * By default true
-     */
-    showInList?: boolean,
-
-    /**
-     * Whether to show preview of image instead of path in list field
-     * By default true
-     */
-    showInShow?: boolean,
-
     /**
      * Maximum width of the preview image
      */