@adminforth/import-export 1.0.0

package/custom/ExportCsv.vue

@@ -0,0 +1,71 @@
+<template>
+  <div @click="exportCsv" class="cursor-pointer flex gap-2 items-center">
+    Export {{ meta.select === 'all' ? 'All': 'Filtered' }} to CSV
+
+    <svg v-if="inProgress"
+      aria-hidden="true" class="w-4 h-4 text-gray-200 animate-spin dark:text-gray-600 fill-blue-600" viewBox="0 0 100 101" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M100 50.5908C100 78.2051 77.6142 100.591 50 100.591C22.3858 100.591 0 78.2051 0 50.5908C0 22.9766 22.3858 0.59082 50 0.59082C77.6142 0.59082 100 22.9766 100 50.5908ZM9.08144 50.5908C9.08144 73.1895 27.4013 91.5094 50 91.5094C72.5987 91.5094 90.9186 73.1895 90.9186 50.5908C90.9186 27.9921 72.5987 9.67226 50 9.67226C27.4013 9.67226 9.08144 27.9921 9.08144 50.5908Z" fill="currentColor"/><path d="M93.9676 39.0409C96.393 38.4038 97.8624 35.9116 97.0079 33.5539C95.2932 28.8227 92.871 24.3692 89.8167 20.348C85.8452 15.1192 80.8826 10.7238 75.2124 7.41289C69.5422 4.10194 63.2754 1.94025 56.7698 1.05124C51.7666 0.367541 46.6976 0.446843 41.7345 1.27873C39.2613 1.69328 37.813 4.19778 38.4501 6.62326C39.0873 9.04874 41.5694 10.4717 44.0505 10.1071C47.8511 9.54855 51.7191 9.52689 55.5402 10.0491C60.8642 10.7766 65.9928 12.5457 70.6331 15.2552C75.2735 17.9648 79.3347 21.5619 82.5849 25.841C84.9175 28.9121 86.7997 32.2913 88.1811 35.8758C89.083 38.2158 91.5421 39.6781 93.9676 39.0409Z" fill="currentFill"/></svg>
+        
+  </div>
+</template>
+
+
+<script setup lang="ts">
+
+import { onMounted, ref } from 'vue';
+import { useCoreStore } from '@/stores/core';
+import { callAdminForthApi, loadFile } from '@/utils';
+import { useFiltersStore } from '@/stores/filters';
+
+
+const filtersStore = useFiltersStore();
+
+const props = defineProps({
+  meta: Object,
+  record: Object,
+})
+
+const inProgress = ref(false);
+
+const coreStore = useCoreStore();
+
+
+onMounted(async () => {
+});
+
+function loadFile(data, filename) {
+  const blob = new Blob([data], { type: 'text/csv' });
+  const url = window.URL.createObjectURL(blob);
+  const a = document.createElement('a');
+  a.href = url;
+  a.download = filename;
+  a.click();
+  window.URL.revokeObjectURL(url);
+}
+
+async function exportCsv() {
+
+  inProgress.value = true;
+  const resp = await callAdminForthApi({
+    path: `/plugin/${props.meta.pluginInstanceId}/export-csv`,
+    method: 'POST',
+    body: {
+      filters:  props.meta.select === 'all' ? [] : filtersStore.getFilters(),
+      sort: filtersStore.getSort(),
+    }
+  });
+  inProgress.value = false;
+  if (resp.error) {
+    window.adminforth.alert({
+      message: resp.error,
+    })
+  } else {
+    loadFile(resp.data, `export-${coreStore.resource.resourceId}-${new Date().toISOString()}.csv`);
+    window.adminforth.alert({
+      message: 'Exported successfully. Check your downloads folder',
+    })
+  }
+}
+
+
+
+</script>

package/custom/ImportCsv.vue

@@ -0,0 +1,89 @@
+<template>
+  <div @click="importCsv" class="cursor-pointer flex gap-2 items-center">
+    Import from CSV
+
+    <svg v-if="inProgress"
+      aria-hidden="true" class="w-4 h-4 text-gray-200 animate-spin dark:text-gray-600 fill-blue-600" viewBox="0 0 100 101" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M100 50.5908C100 78.2051 77.6142 100.591 50 100.591C22.3858 100.591 0 78.2051 0 50.5908C0 22.9766 22.3858 0.59082 50 0.59082C77.6142 0.59082 100 22.9766 100 50.5908ZM9.08144 50.5908C9.08144 73.1895 27.4013 91.5094 50 91.5094C72.5987 91.5094 90.9186 73.1895 90.9186 50.5908C90.9186 27.9921 72.5987 9.67226 50 9.67226C27.4013 9.67226 9.08144 27.9921 9.08144 50.5908Z" fill="currentColor"/><path d="M93.9676 39.0409C96.393 38.4038 97.8624 35.9116 97.0079 33.5539C95.2932 28.8227 92.871 24.3692 89.8167 20.348C85.8452 15.1192 80.8826 10.7238 75.2124 7.41289C69.5422 4.10194 63.2754 1.94025 56.7698 1.05124C51.7666 0.367541 46.6976 0.446843 41.7345 1.27873C39.2613 1.69328 37.813 4.19778 38.4501 6.62326C39.0873 9.04874 41.5694 10.4717 44.0505 10.1071C47.8511 9.54855 51.7191 9.52689 55.5402 10.0491C60.8642 10.7766 65.9928 12.5457 70.6331 15.2552C75.2735 17.9648 79.3347 21.5619 82.5849 25.841C84.9175 28.9121 86.7997 32.2913 88.1811 35.8758C89.083 38.2158 91.5421 39.6781 93.9676 39.0409Z" fill="currentFill"/></svg>
+        
+  </div>
+</template>
+
+<script setup lang="ts">
+import { ref, Ref } from 'vue';
+import { callAdminForthApi } from '@/utils';
+
+const inProgress: Ref<boolean> = ref(false);
+
+const props = defineProps({
+  meta: Object,
+  record: Object,
+});
+
+async function postData(data: Record<string, string[]>) {
+  console.log('postData 1 ', data);
+
+  const resp = await callAdminForthApi({
+    path: `/plugin/${props.meta.pluginInstanceId}/import-csv`,
+    method: 'POST',
+    body: {
+      data
+    }
+  });
+
+  inProgress.value = false;
+  
+  window.adminforth.alert({
+    message: `Imported count ${resp.importedCount} records. ${resp.errors.length ? `Errors: ${resp.errors.join(', ')}` : ''}`,
+    variant: resp.errors.length ? (
+      resp.importedCount ? 'warning' : 'danger'
+    ) : 'success'
+  });
+}
+
+async function importCsv() {
+  // create file input and open it (with csv type)
+  inProgress.value = false;
+  const fileInput = document.createElement('input');
+
+  fileInput.type = 'file';
+  fileInput.accept = '.csv';
+  fileInput.click();
+  fileInput.onchange = async (e) => {
+    inProgress.value = true;
+
+    const file = (e.target as HTMLInputElement).files?.[0];
+    if (!file) {
+      inProgress.value = false;
+      return;
+    }
+
+    // post data in format, plain json 
+    // data is in format {[columnName]: [value1, value2, value3...], [columnName2]: [value1, value2, value3...]}
+    const data = {};
+    const reader = new FileReader();
+    reader.onload = async (e) => {
+      const text = e.target.result as string;
+    console.log('fileInput.onchange 3 ', text);
+
+      const lines = text.split('\n');
+      const columns = lines[0].split(',');
+      for (let i = 1; i < lines.length; i++) {
+        const values = lines[i].split(',');
+        for (let j = 0; j < columns.length; j++) {
+          if (!data[columns[j]]) {
+            data[columns[j]] = [];
+          }
+          data[columns[j]].push(values[j]);
+        }
+      }
+      await postData(data);
+    };
+    reader.readAsText(file);
+
+
+    
+  };
+
+}
+
+</script>

package/index.ts

@@ -0,0 +1,143 @@
+import AdminForth, { AdminForthPlugin, Filters, suggestIfTypo, AdminForthFilterOperators } from "adminforth";
+import type { IAdminForth, IHttpServer, AdminForthResourceColumn, AdminForthComponentDeclaration, AdminForthResource } from "adminforth";
+import type { PluginOptions } from './types.js';
+
+export default class ImportExport extends AdminForthPlugin {
+  options: PluginOptions;
+  emailField: AdminForthResourceColumn;
+  authResourceId: string;
+  adminforth: IAdminForth;
+
+  constructor(options: PluginOptions) {
+    super(options, import.meta.url);
+    this.options = options;
+  }
+
+  async modifyResourceConfig(adminforth: IAdminForth, resourceConfig: AdminForthResource) {
+    super.modifyResourceConfig(adminforth, resourceConfig);
+    if (!resourceConfig.options.pageInjections) {
+      resourceConfig.options.pageInjections = {};
+    }
+    if (!resourceConfig.options.pageInjections.list) {
+      resourceConfig.options.pageInjections.list = {};
+    }
+    if (!resourceConfig.options.pageInjections.list.threeDotsDropdownItems) {
+      resourceConfig.options.pageInjections.list.threeDotsDropdownItems = [];
+    }
+    (resourceConfig.options.pageInjections.list.threeDotsDropdownItems as AdminForthComponentDeclaration[]).push({
+      file: this.componentPath('ExportCsv.vue'),
+      meta: { pluginInstanceId: this.pluginInstanceId, select: 'all' }
+    }, {
+      file: this.componentPath('ExportCsv.vue'),
+      meta: { pluginInstanceId: this.pluginInstanceId, select: 'filtered' }
+    }, {
+      file: this.componentPath('ImportCsv.vue'),
+      meta: { pluginInstanceId: this.pluginInstanceId }
+    });
+
+
+    // simply modify resourceConfig or adminforth.config. You can get access to plugin options via this.options;
+  }
+  
+  validateConfigAfterDiscover(adminforth: IAdminForth, resourceConfig: AdminForthResource) {
+    // optional method where you can safely check field types after database discovery was performed
+  }
+
+  instanceUniqueRepresentation(pluginOptions: any) : string {
+    // optional method to return unique string representation of plugin instance. 
+    // Needed if plugin can have multiple instances on one resource 
+    return `${this.pluginInstanceId}`;
+  }
+
+  setupEndpoints(server: IHttpServer) {
+    server.endpoint({
+      method: 'POST',
+      path: `/plugin/${this.pluginInstanceId}/export-csv`,
+      noAuth: true,
+      handler: async ({ body }) => {
+        const { filters, sort } = body;
+
+        for (const filter of (filters || [])) {
+          if (!Object.values(AdminForthFilterOperators).includes(filter.operator)) {
+              throw new Error(`Operator '${filter.operator}' is not allowed`);
+          }
+          if (!this.resourceConfig.columns.some((col) => col.name === filter.field)) {
+              throw new Error(`Field '${filter.field}' is not in resource '${this.resourceConfig.resourceId}'. Available fields: ${this.resourceConfig.columns.map((col) => col.name).join(', ')}`);
+          }
+          if (filter.operator === AdminForthFilterOperators.IN || filter.operator === AdminForthFilterOperators.NIN) {
+              if (!Array.isArray(filter.value)) {
+                  throw new Error(`Value for operator '${filter.operator}' should be an array`);
+              }
+          }
+          if (filter.operator === AdminForthFilterOperators.IN && filter.value.length === 0) {
+              // nonsense
+              return { data: [], total: 0 };
+          }
+        }
+
+        const data = await this.adminforth.connectors[this.resourceConfig.dataSource].getData({
+          resource: this.resourceConfig,
+          limit: 1e6,
+          offset: 0,
+          filters,
+          sort,
+          getTotals: true,
+        });
+
+        // csv export
+
+        const columns = this.resourceConfig.columns.filter((col) => !col.virtual);
+        let csv = data.data.map((row) => {
+          return columns.map((col) => {
+            return row[col.name];
+          }).join(',');
+        }).join('\n');
+
+        // add headers
+        const headers = columns.map((col) => col.name).join(',');
+        csv = `${headers}\n${csv}`;
+
+        return { data: csv, total: data.total, ok: true };
+
+      }
+    });
+
+    server.endpoint({
+      method: 'POST',
+      path: `/plugin/${this.pluginInstanceId}/import-csv`,
+      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);
+        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);
+        }
+
+        const errors: string[] = [];
+        let importedCount = 0;
+        await Promise.all(rows.map(async (row) => {
+          try {
+              await this.adminforth.resource(this.resourceConfig.resourceId).create(row);
+              importedCount++;
+          } catch (e) {
+              errors.push(e.message);
+          }
+        }));
+
+
+        return { ok: true, importedCount, errors};
+
+      }
+    });
+
+  }
+
+}

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@adminforth/import-export",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "scripts": {
+    "build": "tsc && rsync -av --exclude 'node_modules' custom dist/ && npm version patch",
+    "rollout": "npm publish --access public"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "description": "",
+  "devDependencies": {
+    "@types/node": "^22.6.1",
+    "adminforth": "file:../..",
+    "typescript": "^5.6.2"
+  },
+  "dependencies": {
+  }
+}

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include*/ 
+    "module": "node16",                                /* Specify what module code is generated. */
+    "outDir": "./dist",                                   /* Specify an output folder for all emitted files. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules.  */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+    "strict": false,                                     /* Enable all strict type-checking options. */
+    "skipLibCheck": true,                                 /* Skip type checking all .d.ts files. */
+  },
+  "exclude": ["node_modules", "dist", "custom"],           /* Exclude files from compilation. */
+}

package/types.ts

@@ -0,0 +1,3 @@
+export interface PluginOptions {
+
+}