@adaptabletools/adaptable-plugin-nocode-aggrid-cjs 17.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

@@ -0,0 +1,18 @@
+{
+  "name": "@adaptabletools/adaptable-plugin-nocode-aggrid-cjs",
+  "version": "17.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-cjs": "17.0.0-canary.1"
+  },
+  "peerDependencies": {}
+}

package/src/index.d.ts

@@ -0,0 +1,24 @@
+/// <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>;
+interface NoCodePluginOptions {
+    modules?: any[];
+    onInit?: (adaptableOptions: AdaptableOptions) => void | Promise<any>;
+    headerMessage?: React.ReactNode;
+    actionMessage?: React.ReactNode;
+    dropActionMessage?: React.ReactNode;
+    loadingMessage?: React.ReactNode;
+    theme?: 'dark' | 'light';
+    fetchData?: () => Promise<any>;
+    showFetchDataWizard?: boolean;
+    skipToWizard?: boolean;
+}
+declare class NoCodePlugin extends AdaptablePlugin {
+    options: NoCodePluginOptions;
+    pluginId: string;
+    constructor(options?: NoCodePluginOptions);
+    beforeInit(adaptableOptions: AdaptableOptions, agGridOptions: AgGridConfig): Promise<unknown>;
+}
+declare const _default: (options?: NoCodePluginOptions) => NoCodePlugin;
+export default _default;

package/src/index.js

@@ -0,0 +1,131 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readExcelFile = exports.readJSONFile = void 0;
+const xlsx_1 = require("xlsx");
+const agGrid_1 = require("@adaptabletools/adaptable-cjs/agGrid");
+const types_1 = require("@adaptabletools/adaptable-cjs/types");
+const package_json_1 = require("../package.json");
+const package_json_2 = require("@adaptabletools/adaptable-cjs/package.json");
+const suffix = package_json_1.name.endsWith('-cjs') ? '-cjs' : '';
+if (package_json_1.version !== package_json_2.version) {
+    console.warn(`
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+!!!!!!! "@adaptabletools/adaptable-plugin-nocode${suffix}" (v @${package_json_1.version}) and "@adaptabletools/adaptable${suffix}" (v @${package_json_2.version}) have different versions - they should have the exact same version.
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+`);
+}
+const readJSONFile = async (file, toJSON) => {
+    const reader = new FileReader();
+    return new Promise((resolve, reject) => {
+        reader.onload = function (e) {
+            try {
+                const fn = toJSON || JSON.parse;
+                const json = fn(e.target.result);
+                Promise.resolve(json).then(resolve);
+            }
+            catch (ex) {
+                reject('Invalid JSON');
+            }
+        };
+        reader.onerror = function (e) {
+            reject(e);
+        };
+        reader.readAsText(file);
+    });
+};
+exports.readJSONFile = readJSONFile;
+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, {
+                type: asBinary ? 'binary' : 'array',
+                cellDates: true,
+            });
+            // Get first worksheet
+            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 });
+            resolve(data);
+        };
+        reader.onerror = reject;
+        if (asBinary) {
+            reader.readAsBinaryString(file);
+        }
+        else {
+            reader.readAsArrayBuffer(file);
+        }
+    });
+};
+exports.readExcelFile = readExcelFile;
+const defaultOptions = {};
+class NoCodePlugin extends types_1.AdaptablePlugin {
+    constructor(options) {
+        super(options);
+        this.pluginId = 'nocode-aggrid';
+        this.options = Object.assign(Object.assign({}, defaultOptions), options);
+    }
+    beforeInit(adaptableOptions, agGridOptions) {
+        const theme = this.options.theme ||
+            (typeof adaptableOptions.predefinedConfig === 'object' &&
+                adaptableOptions.predefinedConfig.Theme &&
+                adaptableOptions.predefinedConfig.Theme.CurrentTheme
+                ? adaptableOptions.predefinedConfig.Theme.CurrentTheme
+                : null);
+        if (theme) {
+            document.documentElement.classList.add(`ab--theme-${theme}`);
+        }
+        let isJSON;
+        return new Promise((resolve) => {
+            new agGrid_1.AdaptableNoCodeWizard(adaptableOptions, {
+                fileAccept: '.json,.csv,application/vnd.openxmlformats-officedocument.spreadsheetml.sheet,application/vnd.ms-excel',
+                helpText: this.options.headerMessage,
+                defaultActionMessage: this.options.actionMessage ||
+                    'Click to select an Excel or JSON file to load — or drag it here',
+                dragOverActionMessage: this.options.dropActionMessage,
+                loadingMessage: this.options.loadingMessage,
+                fetchData: this.options.fetchData,
+                showFetchDataWizard: this.options.showFetchDataWizard,
+                skipToWizard: this.options.skipToWizard,
+                readFile: (file) => {
+                    isJSON = (file.type && file.type.indexOf('json')) != -1 || file.name.endsWith('.json');
+                    if (isJSON) {
+                        return (0, exports.readJSONFile)(file);
+                    }
+                    return (0, exports.readExcelFile)(file);
+                },
+                onInit: ({ gridOptions, adaptableOptions: newAdaptableOptions }) => {
+                    Object.keys(newAdaptableOptions).forEach((key) => {
+                        adaptableOptions[key] = newAdaptableOptions[key];
+                    });
+                    /**
+                     * Update the gridOptions with the new gridOptions
+                     */
+                    if (agGridOptions.gridOptions) {
+                        Object.assign(agGridOptions.gridOptions, gridOptions);
+                    }
+                    else {
+                        agGridOptions.gridOptions = gridOptions;
+                    }
+                    let onInitResult = Promise.resolve(true);
+                    if (this.options.onInit) {
+                        onInitResult = this.options.onInit(adaptableOptions);
+                    }
+                    if (onInitResult && onInitResult.then) {
+                        onInitResult.then(() => {
+                            requestAnimationFrame(resolve);
+                        });
+                    }
+                    else {
+                        requestAnimationFrame(resolve);
+                    }
+                    return null;
+                },
+            }, agGridOptions);
+        });
+    }
+}
+exports.default = (options) => new NoCodePlugin(options);