@adminforth/import-export 1.4.27 → 1.5.1

package/build.log

@@ -11,5 +11,5 @@ custom/package.json
 custom/pnpm-lock.yaml
 custom/tsconfig.json
 
-sent 17,871 bytes  received 134 bytes  36,010.00 bytes/sec
+sent 17,878 bytes  received 134 bytes  36,024.00 bytes/sec
 total size is 17,389  speedup is 0.97

package/dist/index.d.ts

@@ -6,8 +6,11 @@ export default class ImportExport extends AdminForthPlugin {
     emailField: AdminForthResourceColumn;
     authResourceId: string;
     adminforth: IAdminForth;
+    auditLogPlugin: Record<string, any> | undefined;
     constructor(options: PluginOptions);
     private isRowValid;
+    private tryToAuditLogAction;
+    private ensureAnyAllowed;
     modifyResourceConfig(adminforth: IAdminForth, resourceConfig: AdminForthResource): Promise<void>;
     validateConfigAfterDiscover(adminforth: IAdminForth, resourceConfig: AdminForthResource): void;
     instanceUniqueRepresentation(pluginOptions: any): string;

package/dist/index.js

@@ -7,7 +7,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { AdminForthPlugin, suggestIfTypo, AdminForthFilterOperators, Filters, AdminForthDataTypes, rejectApiRawFilters } from "adminforth";
+import { AdminForthPlugin, suggestIfTypo, AdminForthFilterOperators, Filters, AdminForthDataTypes, rejectApiRawFilters, interpretResource, ActionCheckSource, AllowedActionsEnum } from "adminforth";
 import pLimit from 'p-limit';
 export default class ImportExport extends AdminForthPlugin {
     constructor(options) {
@@ -31,6 +31,42 @@ export default class ImportExport extends AdminForthPlugin {
         }
         return errors;
     }
+    tryToAuditLogAction(actionName, actionDetails, adminUser, headers) {
+        if (!this.auditLogPlugin) {
+            console.warn('AuditLogPlugin not found, skipping audit log for action:', actionDetails);
+            return;
+        }
+        try {
+            this.auditLogPlugin.logCustomAction({
+                resourceId: this.resourceConfig.resourceId,
+                recordId: null,
+                actionId: actionName,
+                oldData: null,
+                data: {
+                    details: actionDetails,
+                },
+                user: adminUser,
+                headers: headers || {},
+            });
+        }
+        catch (e) {
+            console.error('Failed to log action to AuditLogPlugin:', e);
+        }
+    }
+    ensureAnyAllowed(adminUser_1, checks_1) {
+        return __awaiter(this, arguments, void 0, function* (adminUser, checks, meta = {}) {
+            for (const { source, action } of checks) {
+                const { allowedActions } = yield interpretResource(adminUser, this.resourceConfig, meta, source, this.adminforth);
+                if (allowedActions[action] === true) {
+                    return { ok: true };
+                }
+            }
+            return {
+                ok: false,
+                error: 'Action is not allowed',
+            };
+        });
+    }
     modifyResourceConfig(adminforth, resourceConfig) {
         const _super = Object.create(null, {
             modifyResourceConfig: { get: () => super.modifyResourceConfig }
@@ -61,6 +97,12 @@ export default class ImportExport extends AdminForthPlugin {
     }
     validateConfigAfterDiscover(adminforth, resourceConfig) {
         // optional method where you can safely check field types after database discovery was performed
+        try {
+            this.auditLogPlugin = this.adminforth.getPluginByClassName('AuditLogPlugin');
+        }
+        catch (e) {
+            console.warn('Failed to get AuditLogPlugin for imort-export plugin. Audit logging will be skipped.');
+        }
     }
     instanceUniqueRepresentation(pluginOptions) {
         // optional method to return unique string representation of plugin instance. 
@@ -71,8 +113,15 @@ export default class ImportExport extends AdminForthPlugin {
         server.endpoint({
             method: 'POST',
             path: `/plugin/${this.pluginInstanceId}/export-csv`,
-            handler: (_a) => __awaiter(this, [_a], void 0, function* ({ body }) {
+            handler: (_a) => __awaiter(this, [_a], void 0, function* ({ body, adminUser, headers }) {
                 const { filters, sort } = body;
+                const access = yield this.ensureAnyAllowed(adminUser, [
+                    { source: ActionCheckSource.ListRequest, action: AllowedActionsEnum.list },
+                    { source: ActionCheckSource.ShowRequest, action: AllowedActionsEnum.show },
+                ], { requestBody: body });
+                if (!access.ok) {
+                    return { ok: false, error: access.error };
+                }
                 const rawFilterError = rejectApiRawFilters(body.filters);
                 if (rawFilterError) {
                     return rawFilterError;
@@ -96,6 +145,7 @@ export default class ImportExport extends AdminForthPlugin {
                 const rows = data.data.map((row) => {
                     return columns.map((col) => row[col.name]);
                 });
+                this.tryToAuditLogAction('export', `Export CSV with filters: ${JSON.stringify(filters)} and sort: ${JSON.stringify(sort)}. Total records: ${rows.length}`, adminUser, headers);
                 return {
                     data: { fields, data: rows },
                     columnsToForceQuote,
@@ -109,6 +159,13 @@ export default class ImportExport extends AdminForthPlugin {
             path: `/plugin/${this.pluginInstanceId}/import-csv`,
             handler: (_a) => __awaiter(this, [_a], void 0, function* ({ body, adminUser, query, headers, cookies, requestUrl, response }) {
                 const { data } = body;
+                const createEditAccess = yield this.ensureAnyAllowed(adminUser, [
+                    { source: ActionCheckSource.CreateRequest, action: AllowedActionsEnum.create },
+                    { source: ActionCheckSource.EditRequest, action: AllowedActionsEnum.edit }
+                ], { requestBody: body });
+                if (!createEditAccess.ok) {
+                    return { ok: false, error: createEditAccess.error };
+                }
                 const columns = this.getColumnNames(data);
                 const { errors, resourceColumns } = this.validateColumns(columns);
                 const resource = this.adminforth.config.resources.find(r => r.resourceId === this.resourceConfig.resourceId);
@@ -118,6 +175,7 @@ export default class ImportExport extends AdminForthPlugin {
                 const primaryKeyColumn = this.resourceConfig.columns.find(col => col.primaryKey);
                 const rows = this.buildRowsFromData(data, columns, resourceColumns, { coerceTypes: true });
                 console.log('Prepared rows for import:', rows);
+                this.tryToAuditLogAction('import', `Import CSV with ${Object.keys(data).length} columns`, adminUser, headers);
                 let importedCount = 0;
                 let updatedCount = 0;
                 const limit = pLimit(100);
@@ -170,6 +228,10 @@ export default class ImportExport extends AdminForthPlugin {
             path: `/plugin/${this.pluginInstanceId}/import-csv-new-only`,
             handler: (_a) => __awaiter(this, [_a], void 0, function* ({ body, adminUser, query, headers, cookies, requestUrl, response }) {
                 const { data } = body;
+                const access = yield this.ensureAnyAllowed(adminUser, [{ source: ActionCheckSource.CreateRequest, action: AllowedActionsEnum.create }], { requestBody: body });
+                if (!access.ok) {
+                    return { ok: false, error: access.error };
+                }
                 const columns = this.getColumnNames(data);
                 const resource = this.adminforth.config.resources.find(r => r.resourceId === this.resourceConfig.resourceId);
                 const { errors, resourceColumns } = this.validateColumns(columns);
@@ -178,6 +240,7 @@ export default class ImportExport extends AdminForthPlugin {
                 }
                 const primaryKeyColumn = this.resourceConfig.columns.find(col => col.primaryKey);
                 const rows = this.buildRowsFromData(data, columns, resourceColumns, { coerceTypes: true });
+                this.tryToAuditLogAction('import', `Import CSV (new only) with ${Object.keys(data).length} columns`, adminUser, headers);
                 let importedCount = 0;
                 const limit = pLimit(100);
                 yield Promise.all(rows.map((row) => limit(() => __awaiter(this, void 0, void 0, function* () {
@@ -212,7 +275,14 @@ export default class ImportExport extends AdminForthPlugin {
         server.endpoint({
             method: 'POST',
             path: `/plugin/${this.pluginInstanceId}/check-records`,
-            handler: (_a) => __awaiter(this, [_a], void 0, function* ({ body }) {
+            handler: (_a) => __awaiter(this, [_a], void 0, function* ({ body, adminUser }) {
+                const access = yield this.ensureAnyAllowed(adminUser, [
+                    { source: ActionCheckSource.ListRequest, action: AllowedActionsEnum.list },
+                    { source: ActionCheckSource.ShowRequest, action: AllowedActionsEnum.show },
+                ], { requestBody: body });
+                if (!access.ok) {
+                    return { ok: false, error: access.error };
+                }
                 const { data } = body;
                 const primaryKeyColumn = this.resourceConfig.columns.find(col => col.primaryKey);
                 const columns = this.getColumnNames(data);

package/index.ts

@@ -1,5 +1,5 @@
-import { AdminForthPlugin, suggestIfTypo, AdminForthFilterOperators, Filters, AdminForthDataTypes, rejectApiRawFilters } from "adminforth";
-import type { IAdminForth, IHttpServer, AdminForthResourceColumn, AdminForthComponentDeclaration, AdminForthResource } from "adminforth";
+import { AdminForthPlugin, suggestIfTypo, AdminForthFilterOperators, Filters, AdminForthDataTypes, rejectApiRawFilters, interpretResource, ActionCheckSource, AllowedActionsEnum } from "adminforth";
+import type { IAdminForth, IHttpServer, AdminForthResourceColumn, AdminForthComponentDeclaration, AdminForthResource, AdminUser } from "adminforth";
 import type { PluginOptions } from './types.js';
 import pLimit from 'p-limit';
 
@@ -8,6 +8,7 @@ export default class ImportExport extends AdminForthPlugin {
   emailField: AdminForthResourceColumn;
   authResourceId: string;
   adminforth: IAdminForth;
+  auditLogPlugin: Record<string, any> | undefined;
   
 
   constructor(options: PluginOptions) {
@@ -33,6 +34,54 @@ export default class ImportExport extends AdminForthPlugin {
     return errors;
   }
 
+  private tryToAuditLogAction(actionName: 'import' | 'export', actionDetails: string, adminUser: AdminUser, headers?: Record<string, string> ) {
+    if (!this.auditLogPlugin) {
+      console.warn('AuditLogPlugin not found, skipping audit log for action:', actionDetails);
+      return;
+    }
+    try {
+      this.auditLogPlugin.logCustomAction({
+        resourceId: this.resourceConfig.resourceId,
+        recordId: null,
+        actionId: actionName,
+        oldData: null,
+        data: {
+          details: actionDetails,
+
+        },
+        user: adminUser,
+        headers: headers || {},
+      });
+    } catch (e) {
+      console.error('Failed to log action to AuditLogPlugin:', e);
+    }
+  }
+
+  private async ensureAnyAllowed(
+    adminUser: AdminUser,
+    checks: { source: ActionCheckSource; action: AllowedActionsEnum }[],
+    meta: Record<string, unknown> = {}
+  ): Promise<{ ok: boolean; error?: string }> {
+    for (const { source, action } of checks) {
+      const { allowedActions } = await interpretResource(
+        adminUser,
+        this.resourceConfig,
+        meta,
+        source,
+        this.adminforth
+      );
+
+      if (allowedActions[action] === true) {
+        return { ok: true };
+      }
+    }
+
+    return {
+      ok: false,
+      error: 'Action is not allowed',
+    };
+  }
+
   async modifyResourceConfig(adminforth: IAdminForth, resourceConfig: AdminForthResource) {
     super.modifyResourceConfig(adminforth, resourceConfig);
     if (!resourceConfig.options.pageInjections) {
@@ -61,6 +110,11 @@ export default class ImportExport extends AdminForthPlugin {
   
   validateConfigAfterDiscover(adminforth: IAdminForth, resourceConfig: AdminForthResource) {
     // optional method where you can safely check field types after database discovery was performed
+    try {
+      this.auditLogPlugin = this.adminforth.getPluginByClassName('AuditLogPlugin');
+    } catch (e) {
+      console.warn('Failed to get AuditLogPlugin for imort-export plugin. Audit logging will be skipped.');
+    }
   }
 
   instanceUniqueRepresentation(pluginOptions: any) : string {
@@ -73,8 +127,19 @@ export default class ImportExport extends AdminForthPlugin {
     server.endpoint({
       method: 'POST',
       path: `/plugin/${this.pluginInstanceId}/export-csv`,
-      handler: async ({ body }) => {
+      handler: async ({ body, adminUser, headers }) => {
         const { filters, sort } = body;
+        const access = await this.ensureAnyAllowed(
+          adminUser,
+          [
+            { source: ActionCheckSource.ListRequest, action: AllowedActionsEnum.list },
+            { source: ActionCheckSource.ShowRequest, action: AllowedActionsEnum.show },
+          ],
+          { requestBody: body }
+        );
+        if (!access.ok) {
+          return { ok: false, error: access.error };
+        }
         const rawFilterError = rejectApiRawFilters(body.filters);
         if (rawFilterError) {
           return rawFilterError;
@@ -103,6 +168,8 @@ export default class ImportExport extends AdminForthPlugin {
           return columns.map((col) => row[col.name]);
         });
 
+        this.tryToAuditLogAction('export', `Export CSV with filters: ${JSON.stringify(filters)} and sort: ${JSON.stringify(sort)}. Total records: ${rows.length}`, adminUser, headers);
+
         return { 
           data: { fields, data: rows }, 
           columnsToForceQuote, 
@@ -117,6 +184,17 @@ export default class ImportExport extends AdminForthPlugin {
       path: `/plugin/${this.pluginInstanceId}/import-csv`,
       handler: async ({ body, adminUser, query, headers, cookies, requestUrl, response }) => {
         const { data } = body;
+        const createEditAccess = await this.ensureAnyAllowed(
+          adminUser,
+          [
+            { source: ActionCheckSource.CreateRequest, action: AllowedActionsEnum.create },
+            { source: ActionCheckSource.EditRequest, action: AllowedActionsEnum.edit }
+          ],
+          { requestBody: body }
+        );
+        if (!createEditAccess.ok) {
+          return { ok: false, error: createEditAccess.error };
+        }
         const columns = this.getColumnNames(data);
         const { errors, resourceColumns } = this.validateColumns(columns);
         const resource = this.adminforth.config.resources.find(r => r.resourceId === this.resourceConfig.resourceId);
@@ -128,6 +206,7 @@ export default class ImportExport extends AdminForthPlugin {
         const rows = this.buildRowsFromData(data, columns, resourceColumns, { coerceTypes: true });
 
         console.log('Prepared rows for import:', rows);
+        this.tryToAuditLogAction('import', `Import CSV with ${Object.keys(data).length} columns`, adminUser, headers);
 
         let importedCount = 0;
         let updatedCount = 0;
@@ -184,6 +263,14 @@ export default class ImportExport extends AdminForthPlugin {
       path: `/plugin/${this.pluginInstanceId}/import-csv-new-only`,
       handler: async ({ body, adminUser, query, headers, cookies, requestUrl, response }) => {
         const { data } = body;
+        const access = await this.ensureAnyAllowed(
+          adminUser,
+          [{ source: ActionCheckSource.CreateRequest, action: AllowedActionsEnum.create }],
+          { requestBody: body }
+        );
+        if (!access.ok) {
+          return { ok: false, error: access.error };
+        }
         const columns = this.getColumnNames(data);
         const resource = this.adminforth.config.resources.find(r => r.resourceId === this.resourceConfig.resourceId);
         const { errors, resourceColumns } = this.validateColumns(columns);
@@ -193,6 +280,7 @@ export default class ImportExport extends AdminForthPlugin {
 
         const primaryKeyColumn = this.resourceConfig.columns.find(col => col.primaryKey);
         const rows = this.buildRowsFromData(data, columns, resourceColumns, { coerceTypes: true });
+        this.tryToAuditLogAction('import', `Import CSV (new only) with ${Object.keys(data).length} columns`, adminUser, headers);
 
         let importedCount = 0;
         const limit = pLimit(100);
@@ -231,7 +319,18 @@ export default class ImportExport extends AdminForthPlugin {
     server.endpoint({
       method: 'POST',
       path: `/plugin/${this.pluginInstanceId}/check-records`,
-      handler: async ({ body }) => {
+      handler: async ({ body, adminUser }) => {
+        const access = await this.ensureAnyAllowed(
+          adminUser,
+          [
+            { source: ActionCheckSource.ListRequest, action: AllowedActionsEnum.list },
+            { source: ActionCheckSource.ShowRequest, action: AllowedActionsEnum.show },
+          ],
+          { requestBody: body }
+        );
+        if (!access.ok) {
+          return { ok: false, error: access.error };
+        }
         const { data } = body as { data: Record<string, unknown[]> };
         const primaryKeyColumn = this.resourceConfig.columns.find(col => col.primaryKey);
         const columns = this.getColumnNames(data);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adminforth/import-export",
-  "version": "1.4.27",
+  "version": "1.5.1",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",