@adminforth/import-export 1.0.2 → 1.2.0

package/index.ts

@@ -1,4 +1,4 @@
-import AdminForth, { AdminForthPlugin, Filters, suggestIfTypo, AdminForthFilterOperators } from "adminforth";
+import { AdminForthPlugin, suggestIfTypo, AdminForthFilterOperators, Filters } from "adminforth";
 import type { IAdminForth, IHttpServer, AdminForthResourceColumn, AdminForthComponentDeclaration, AdminForthResource } from "adminforth";
 import type { PluginOptions } from './types.js';
 
@@ -85,20 +85,26 @@ export default class ImportExport extends AdminForthPlugin {
         });
 
         // csv export
-
         const columns = this.resourceConfig.columns.filter((col) => !col.virtual);
+        
+        const escapeCSV = (value: any) => {
+          if (value === null || value === undefined) return '""';
+          const str = String(value);
+          if (str.includes(',') || str.includes('"') || str.includes('\n')) {
+            return `"${str.replace(/"/g, '""')}"`;
+          }
+          return `"${str}"`;
+        };
+
         let csv = data.data.map((row) => {
-          return columns.map((col) => {
-            return row[col.name];
-          }).join(',');
+          return columns.map((col) => escapeCSV(row[col.name])).join(',');
         }).join('\n');
 
         // add headers
-        const headers = columns.map((col) => col.name).join(',');
+        const headers = columns.map((col) => escapeCSV(col.name)).join(',');
         csv = `${headers}\n${csv}`;
 
         return { data: csv, exportedCount: data.total, ok: true };
-
       }
     });
 
@@ -108,8 +114,6 @@ export default class ImportExport extends AdminForthPlugin {
       noAuth: true,
       handler: async ({ body }) => {
         const { data } = body;
-        // data is in format {[columnName]: [value1, value2, value3...], [columnName2]: [value1, value2, value3...]}
-        // we need to convert it to [{columnName: value1, columnName2: value1}, {columnName: value2, columnName2: value2}...]
         const rows = [];
         const columns = Object.keys(data);
 
@@ -127,6 +131,8 @@ export default class ImportExport extends AdminForthPlugin {
           return { ok: false, errors };
         }
 
+        const primaryKeyColumn = this.resourceConfig.columns.find(col => col.primaryKey);
+
         const columnValues: any[] = Object.values(data);
         for (let i = 0; i < columnValues[0].length; i++) {
           const row = {};
@@ -137,21 +143,124 @@ export default class ImportExport extends AdminForthPlugin {
         }
 
         let importedCount = 0;
+        let updatedCount = 0;
+
         await Promise.all(rows.map(async (row) => {
           try {
-              await this.adminforth.resource(this.resourceConfig.resourceId).create(row);
-              importedCount++;
+            if (primaryKeyColumn && row[primaryKeyColumn.name]) {
+              const existingRecord = await this.adminforth.resource(this.resourceConfig.resourceId)
+                .list([Filters.EQ(primaryKeyColumn.name, row[primaryKeyColumn.name])]);
+              
+              if (existingRecord.length > 0) {
+                await this.adminforth.resource(this.resourceConfig.resourceId)
+                  .update(row[primaryKeyColumn.name], row);
+                updatedCount++;
+                return;
+              }
+            }
+            await this.adminforth.resource(this.resourceConfig.resourceId).create(row);
+            importedCount++;
           } catch (e) {
-              errors.push(e.message);
+            errors.push(e.message);
           }
         }));
 
+        return { ok: true, importedCount, updatedCount, errors };
+      }
+    });
 
-        return { ok: true, importedCount, errors};
+    server.endpoint({
+      method: 'POST',
+      path: `/plugin/${this.pluginInstanceId}/import-csv-new-only`,
+      noAuth: true,
+      handler: async ({ body }) => {
+        const { data } = body;
+        const rows = [];
+        const columns = Object.keys(data);
 
+        // check column names are valid
+        const errors: string[] = [];
+        columns.forEach((col) => {
+          if (!this.resourceConfig.columns.some((c) => c.name === col)) {
+            const similar = suggestIfTypo(this.resourceConfig.columns.map((c) => c.name), col);
+            errors.push(`Column '${col}' defined in CSV not found in resource '${this.resourceConfig.resourceId}'. ${
+              similar ? `If you mean '${similar}', rename it in CSV` : 'If column is in database but not in resource configuration, add it with showIn:[]'}`
+            );
+          }
+        });
+        if (errors.length > 0) {
+          return { ok: false, errors };
+        }
+
+        const primaryKeyColumn = this.resourceConfig.columns.find(col => col.primaryKey);
+        const columnValues: any[] = Object.values(data);
+        for (let i = 0; i < columnValues[0].length; i++) {
+          const row = {};
+          for (let j = 0; j < columns.length; j++) {
+            row[columns[j]] = columnValues[j][i];
+          }
+          rows.push(row);
+        }
+
+        let importedCount = 0;
+
+        await Promise.all(rows.map(async (row) => {
+          try {
+            if (primaryKeyColumn && row[primaryKeyColumn.name]) {
+              const existingRecord = await this.adminforth.resource(this.resourceConfig.resourceId)
+                .list([Filters.EQ(primaryKeyColumn.name, row[primaryKeyColumn.name])]);
+              
+              if (existingRecord.length > 0) {
+                return;
+              }
+            }
+            await this.adminforth.resource(this.resourceConfig.resourceId).create(row);
+            importedCount++;
+          } catch (e) {
+            errors.push(e.message);
+          }
+        }));
+
+        return { ok: true, importedCount, errors };
       }
     });
 
+    server.endpoint({
+      method: 'POST',
+      path: `/plugin/${this.pluginInstanceId}/check-records`,
+      noAuth: true,
+      handler: async ({ body }) => {
+        const { data } = body;
+
+        const primaryKeyColumn = this.resourceConfig.columns.find(col => col.primaryKey);
+
+        const rows = [];
+        const columns = Object.keys(data);
+        const columnValues = Object.values(data);
+        for (let i = 0; i < (columnValues[0] as any[]).length; i++) {
+          const row = {};
+          for (let j = 0; j < columns.length; j++) {
+            row[columns[j]] = columnValues[j][i];
+          }
+          rows.push(row);
+        }
+
+        const primaryKeys = rows
+          .map(row => row[primaryKeyColumn.name])
+          .filter(key => key !== undefined && key !== null && key !== '');
+
+        const records = await this.adminforth.resource(this.resourceConfig.resourceId).list([])
+
+        const existingRecords = records.filter((record) => primaryKeys.includes(record[primaryKeyColumn.name]));
+
+        return {
+          ok: true,
+          total: rows.length,
+          existingCount: existingRecords.length,
+          newCount: rows.length - existingRecords.length
+        };
+      }
+    });
   }
 
 }

package/package.json

@@ -1,17 +1,56 @@
 {
   "name": "@adminforth/import-export",
-  "version": "1.0.2",
+  "version": "1.2.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",
+  "homepage": "https://adminforth.dev/docs/tutorial/Plugins/import-export/",
   "scripts": {
-    "build": "tsc && rsync -av --exclude 'node_modules' custom dist/ && npm version patch",
-    "rollout": "npm run build && npm version patch && npm publish --access public",
+    "build": "tsc && rsync -av --exclude 'node_modules' custom dist/",
     "prepare": "npm link adminforth"
   },
-  "keywords": [],
-  "author": "",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/devforth/adminforth-import-export.git"
+  },
+  "keywords": [
+    "adminforth",
+    "import",
+    "export",
+    "csv"
+  ],
+  "author": "devforth",
   "license": "ISC",
-  "description": "",
-  "dependencies": {}
+  "description": "CSV import/export plugin for adminforth",
+  "dependencies": {},
+  "devDependencies": {
+    "@types/node": "^22.10.7",
+    "semantic-release": "^24.2.1",
+    "semantic-release-slack-bot": "^4.0.2",
+    "typescript": "^5.7.3"
+  },
+  "release": {
+    "plugins": [
+      "@semantic-release/commit-analyzer",
+      "@semantic-release/release-notes-generator",
+      "@semantic-release/npm",
+      "@semantic-release/github",
+      [
+        "semantic-release-slack-bot",
+        {
+          "notifyOnSuccess": true,
+          "notifyOnFail": true,
+          "slackIcon": ":package:",
+          "markdownReleaseNotes": true
+        }
+      ]
+    ],
+    "branches": [
+      "main",
+      {
+        "name": "next",
+        "prerelease": true
+      }
+    ]
+  }
 }