@adaptabletools/adaptable-plugin-nocode-aggrid 17.0.6 → 18.0.0-canary.1

package/README.md

@@ -0,0 +1,63 @@
+# AdapTable 'No Code' Plugin
+
+The No Code Plugin allows end users to create an AdapTable instance at runtime from any JSON or Excel file that they provide.
+ 
+It will dynamically instantiate a fully functional AdapTable including advanced features like state management and audit log, enabling Users to attach to the same source daily or multiple different sources.
+ 
+## No Code Wizard
+Once a JSON or Excel file has been selected (or dragged and droppped), the AdapTable No Code Wizard will appear.
+
+It has 2 steps:
+
+1.  The Wizard will read the input file / JSON and list the available columns it contains, together with options for each column to change the DataType, and set editing, filtering, sorting, grouping and other properties.
+
+2. A second (optional) step allows Users to set up many of the [Adaptable Options](https://docs.adaptabletools.com/guide/reference-options-overview) that would normally be configured at design-time, in order to ensure that the AdapTable instance suits their precise requirements.
+         
+> The source data must have one column that contains **unique values** which will be set as the Primary Key column (by convention this is the first column).
+
+## Code Required
+There is minimum code required to set up the No Code plugin. 
+
+A full example would be as follows:
+
+```jsx
+import "@adaptabletools/adaptable/index.css";
+import "@ag-grid-community/all-modules/dist/styles/ag-grid.css";
+import "@ag-grid-community/all-modules/dist/styles/ag-theme-balham.css";
+import nocode from "@adaptabletools/adaptable-plugin-nocode-aggrid";
+import { AdaptableOptions} from "@adaptabletools/adaptable/types";
+import { AllEnterpriseModules } from "@ag-grid-enterprise/all-modules";
+import Adaptable from "@adaptabletools/adaptable/agGrid";
+
+const adaptableOptions: AdaptableOptions = {
+  primaryKey: "",
+  userName: "Demo User",
+  adaptableId: "Nocode Plugin Demo",
+  plugins: [
+    nocode({
+      onInit: adaptableOptions => {
+        adaptableOptions.modules = AllEnterpriseModules;
+      }
+    })
+  ]
+};
+
+Adaptable.init(adaptableOptions).then((api) => {
+  console.log(api, "!!!");
+});
+```
+
+## Example Project
+Visit the [No Code Example Project](https://github.com/AdaptableTools/example-adaptable-nocode-aggrid) to see a basic example of how to set up the No Code plugin.
+
+## Demo
+Visit the [No Code Demo](https://demo.adaptabletools.com/admin/aggridnocodedemo) to see AdapTable running the No Code plugin.
+
+## Help
+Developers can learn how to access AdapTable programmatically at [AdapTable Documentation](https://docs.adaptabletools.com).
+
+## Other AdapTable Resources
+General information about Adaptable Tools is available at our [Website](http://www.adaptabletools.com) 
+
+## Support
+For all support enquiries please email [`support@adaptabletools.com`](mailto:support@adaptabletools.com) or [raise a Support Ticket](https://adaptabletools.zendesk.com/hc/en-us/requests/new).

package/package.json

@@ -1,17 +1,18 @@
 {
   "name": "@adaptabletools/adaptable-plugin-nocode-aggrid",
-  "version": "17.0.6",
+  "version": "18.0.0-canary.1",
   "description": "",
   "homepage": "http://www.adaptabletools.com/",
   "author": {
     "name": "Jonny Wolfson",
     "email": "jonny.wolfson@adaptabletools.com"
   },
-  "main": "src/index.js",
   "typings": "src/index.d.ts",
   "dependencies": {
     "tslib": "^2.3.0",
     "xlsx": "^0.15.5",
-    "@adaptabletools/adaptable": "17.0.6"
-  }
+    "@adaptabletools/adaptable": "18.0.0-canary.1"
+  },
+  "type": "module",
+  "module": "src/index.js"
 }

package/src/index.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="react" />
 import { AdaptableOptions, AdaptablePlugin, AgGridConfig } from '@adaptabletools/adaptable/types';
 export declare const readJSONFile: (file: File, toJSON?: (str: string) => Promise<any> | any) => Promise<unknown>;
 export declare const readExcelFile: (file: File) => Promise<any>;

package/src/index.js

@@ -1,20 +1,18 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.readExcelFile = exports.readJSONFile = void 0;
-const tslib_1 = require("tslib");
-const xlsx_1 = require("xlsx");
-const agGrid_1 = require("@adaptabletools/adaptable/agGrid");
-const types_1 = require("@adaptabletools/adaptable/types");
-const package_json_1 = require("../package.json");
-const version_1 = tslib_1.__importDefault(require("@adaptabletools/adaptable/version"));
-if (package_json_1.version !== version_1.default) {
-    console.warn(`
-!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-!!!!!!! "@adaptabletools/adaptable-plugin-nocode" (v @${package_json_1.version}) and "@adaptabletools/adaptable" (v @${version_1.default}) have different versions - they should have the exact same version.
-!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-`);
-}
-const readJSONFile = async (file, toJSON) => {
+import { read as XLSXRead, utils as XLSXUtils } from 'xlsx';
+import { AdaptableNoCodeWizard } from '@adaptabletools/adaptable/agGrid';
+import { AdaptablePlugin } from '@adaptabletools/adaptable/types';
+// TODO in the future, try to put back the version check
+// import { version, name } from '../package.json';
+// import { version as coreVersion } from '@adaptabletools/adaptable/package.json';
+// const suffix = name.endsWith('-cjs') ? '-cjs' : '';
+// if (version !== coreVersion) {
+//   console.warn(`
+// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+// !!!!!!! "@adaptabletools/adaptable-plugin-nocode${suffix}" (v @${version}) and "@adaptabletools/adaptable${suffix}" (v @${coreVersion}) have different versions - they should have the exact same version.
+// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+// `);
+// }
+export const readJSONFile = async (file, toJSON) => {
     const reader = new FileReader();
     return new Promise((resolve, reject) => {
         reader.onload = function (e) {
@@ -33,14 +31,13 @@ const readJSONFile = async (file, toJSON) => {
         reader.readAsText(file);
     });
 };
-exports.readJSONFile = readJSONFile;
-const readExcelFile = (file) => {
+export const readExcelFile = (file) => {
     /* Boilerplate to set up FileReader */
     const reader = new FileReader();
     const asBinary = !!reader.readAsBinaryString;
     return new Promise((resolve, reject) => {
         reader.onload = (e) => {
-            const wb = (0, xlsx_1.read)(e.target.result, {
+            const wb = XLSXRead(e.target.result, {
                 type: asBinary ? 'binary' : 'array',
                 cellDates: true,
             });
@@ -48,7 +45,7 @@ const readExcelFile = (file) => {
             const wsname = wb.SheetNames[0];
             const ws = wb.Sheets[wsname];
             // Convert array of arrays
-            const data = xlsx_1.utils.sheet_to_json(ws, { header: 1 });
+            const data = XLSXUtils.sheet_to_json(ws, { header: 1 });
             resolve(data);
         };
         reader.onerror = reject;
@@ -60,9 +57,8 @@ const readExcelFile = (file) => {
         }
     });
 };
-exports.readExcelFile = readExcelFile;
 const defaultOptions = {};
-class NoCodePlugin extends types_1.AdaptablePlugin {
+class NoCodePlugin extends AdaptablePlugin {
     constructor(options) {
         super(options);
         this.pluginId = 'nocode-aggrid';
@@ -80,7 +76,7 @@ class NoCodePlugin extends types_1.AdaptablePlugin {
         }
         let isJSON;
         return new Promise((resolve) => {
-            new agGrid_1.AdaptableNoCodeWizard(adaptableOptions, {
+            new AdaptableNoCodeWizard(adaptableOptions, {
                 fileAccept: '.json,.csv,application/vnd.openxmlformats-officedocument.spreadsheetml.sheet,application/vnd.ms-excel',
                 helpText: this.options.headerMessage,
                 defaultActionMessage: this.options.actionMessage ||
@@ -93,9 +89,9 @@ class NoCodePlugin extends types_1.AdaptablePlugin {
                 readFile: (file) => {
                     isJSON = (file.type && file.type.indexOf('json')) != -1 || file.name.endsWith('.json');
                     if (isJSON) {
-                        return (0, exports.readJSONFile)(file);
+                        return readJSONFile(file);
                     }
-                    return (0, exports.readExcelFile)(file);
+                    return readExcelFile(file);
                 },
                 onInit: ({ gridOptions, adaptableOptions: newAdaptableOptions }) => {
                     Object.keys(newAdaptableOptions).forEach((key) => {
@@ -128,4 +124,4 @@ class NoCodePlugin extends types_1.AdaptablePlugin {
         });
     }
 }
-exports.default = (options) => new NoCodePlugin(options);
+export default (options) => new NoCodePlugin(options);