@loaders.gl/excel 3.1.0-alpha.4 → 3.1.0-beta.3

package/dist/index.d.ts

@@ -0,0 +1,22 @@
+import type { LoaderWithParser } from '@loaders.gl/loader-utils';
+import { ExcelLoader as ExcelWorkerLoader, ExcelLoaderOptions } from './excel-loader';
+export type { ExcelLoaderOptions };
+export { ExcelWorkerLoader };
+/**
+ * Loader for Excel files
+ */
+export declare const ExcelLoader: {
+    parse: (arrayBuffer: ArrayBuffer, options?: ExcelLoaderOptions | undefined) => Promise<never[]>;
+    name: string;
+    id: string;
+    module: string;
+    version: any;
+    worker: boolean;
+    extensions: string[];
+    mimeTypes: string[];
+    category: string;
+    binary: boolean;
+    options: ExcelLoaderOptions;
+};
+export declare const _typecheckLoader: LoaderWithParser;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAC,WAAW,IAAI,iBAAiB,EAAE,kBAAkB,EAAC,MAAM,gBAAgB,CAAC;AAKpF,YAAY,EAAC,kBAAkB,EAAC,CAAC;AACjC,OAAO,EAAC,iBAAiB,EAAC,CAAC;AAE3B;;GAEG;AACH,eAAO,MAAM,WAAW;yBAED,WAAW;;;;;;;;;;;CAEjC,CAAC;AAEF,eAAO,MAAM,gBAAgB,EAAE,gBAA8B,CAAC"}

package/dist/index.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._typecheckLoader = exports.ExcelLoader = exports.ExcelWorkerLoader = void 0;
+const excel_loader_1 = require("./excel-loader");
+Object.defineProperty(exports, "ExcelWorkerLoader", { enumerable: true, get: function () { return excel_loader_1.ExcelLoader; } });
+const parse_excel_1 = require("./lib/parse-excel");
+/**
+ * Loader for Excel files
+ */
+exports.ExcelLoader = {
+    ...excel_loader_1.ExcelLoader,
+    parse: (arrayBuffer, options) => (0, parse_excel_1.parseExcel)(arrayBuffer, options)
+};
+exports._typecheckLoader = exports.ExcelLoader;

package/dist/lib/encode-excel.d.ts

@@ -0,0 +1,80 @@
+/**
+   * Saves JSON data in Excel format for html, ods, xml, xlsb and xlsx file types.
+   * @param filePath Local data file path.
+   * @param fileData Raw data to save.
+   * @param tableName Table name for data files with multiple tables support.
+   * @param showData Show saved data callback.
+   *
+  public saveData(filePath: string, fileData: any, tableName: string, showData?: Function): void {
+    const fileType: string = filePath.substr(filePath.lastIndexOf('.'));
+    fileData = this.jsonToExcelData(fileData, fileType, tableName);
+    if ( fileData.length > 0) {
+      // TODO: change this to async later
+      fs.writeFile(filePath, fileData, (error) => showData(error));
+    }
+  }
+
+  /**
+   * Converts JSON data to Excel data formats.
+   * @param jsonData Json data to convert.
+   * @param bookType Excel data file/book type.
+   *
+  private jsonToExcelData(jsonData: any, fileType: string, tableName: string): any {
+    console.debug('jsonToExcelData(): creating excel data:', fileType);
+
+    // create new workbook
+    const workbook = xlsx.utils.book_new();
+
+    // convert json data to worksheet format
+    const worksheet = xlsx.utils.json_to_sheet(jsonData, {
+      //header: JSON.parse(this._viewConfig.columns)
+    });
+
+    // append worksheet to workbook
+    xlsx.utils.book_append_sheet(workbook, worksheet, tableName);
+
+    // get text data string or binary spreadsheet data buffer
+    let data: any = '';
+    if (fileType === 'html' || fileType === 'xml') {
+      data = xlsx.write(workbook, {
+        type: 'string',
+        compression: false,
+        bookType: getBookType(fileType)
+      });
+    } else {
+      data = xlsx.write(workbook, {
+        type: 'buffer',
+        compression: true, // use zip compression for zip-based formats
+        bookType: getBookType(fileType)
+      });
+    }
+    return data;
+  }
+
+
+}
+
+/**
+ * Converts file type to Excel book type.
+ * @param {string} fileType File type: .html, .ods, .xml, .xlsb, .xlsx, etc.
+ * @returns {xlsx.BookType}
+ *
+function getBookType(fileType) {
+  // TODO: must be a better way to do this string to type conversion :)
+  switch (fileType) {
+    case '.html':
+      return 'html';
+    case '.ods':
+      return 'ods';
+    case '.xml':
+      return 'xlml';
+    case '.xlsb':
+      return 'xlsb';
+    case '.xlsx':
+      return 'xlsx';
+    default:
+      return 'xlsb';
+  }
+}
+*/
+//# sourceMappingURL=encode-excel.d.ts.map

package/dist/lib/encode-excel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"encode-excel.d.ts","sourceRoot":"","sources":["../../src/lib/encode-excel.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA8EE"}

package/dist/lib/encode-excel.js

@@ -0,0 +1,81 @@
+"use strict";
+// import * as xlsx from 'xlsx';
+/**
+   * Saves JSON data in Excel format for html, ods, xml, xlsb and xlsx file types.
+   * @param filePath Local data file path.
+   * @param fileData Raw data to save.
+   * @param tableName Table name for data files with multiple tables support.
+   * @param showData Show saved data callback.
+   *
+  public saveData(filePath: string, fileData: any, tableName: string, showData?: Function): void {
+    const fileType: string = filePath.substr(filePath.lastIndexOf('.'));
+    fileData = this.jsonToExcelData(fileData, fileType, tableName);
+    if ( fileData.length > 0) {
+      // TODO: change this to async later
+      fs.writeFile(filePath, fileData, (error) => showData(error));
+    }
+  }
+
+  /**
+   * Converts JSON data to Excel data formats.
+   * @param jsonData Json data to convert.
+   * @param bookType Excel data file/book type.
+   *
+  private jsonToExcelData(jsonData: any, fileType: string, tableName: string): any {
+    console.debug('jsonToExcelData(): creating excel data:', fileType);
+
+    // create new workbook
+    const workbook = xlsx.utils.book_new();
+
+    // convert json data to worksheet format
+    const worksheet = xlsx.utils.json_to_sheet(jsonData, {
+      //header: JSON.parse(this._viewConfig.columns)
+    });
+
+    // append worksheet to workbook
+    xlsx.utils.book_append_sheet(workbook, worksheet, tableName);
+
+    // get text data string or binary spreadsheet data buffer
+    let data: any = '';
+    if (fileType === 'html' || fileType === 'xml') {
+      data = xlsx.write(workbook, {
+        type: 'string',
+        compression: false,
+        bookType: getBookType(fileType)
+      });
+    } else {
+      data = xlsx.write(workbook, {
+        type: 'buffer',
+        compression: true, // use zip compression for zip-based formats
+        bookType: getBookType(fileType)
+      });
+    }
+    return data;
+  }
+
+
+}
+
+/**
+ * Converts file type to Excel book type.
+ * @param {string} fileType File type: .html, .ods, .xml, .xlsb, .xlsx, etc.
+ * @returns {xlsx.BookType}
+ *
+function getBookType(fileType) {
+  // TODO: must be a better way to do this string to type conversion :)
+  switch (fileType) {
+    case '.html':
+      return 'html';
+    case '.ods':
+      return 'ods';
+    case '.xml':
+      return 'xlml';
+    case '.xlsb':
+      return 'xlsb';
+    case '.xlsx':
+      return 'xlsx';
+    default:
+      return 'xlsb';
+  }
+}
+*/

package/dist/lib/parse-excel.d.ts

@@ -0,0 +1,8 @@
+import type { ExcelLoaderOptions } from '../excel-loader';
+/**
+ * Gets local or remote Excel file data.
+ * @param arrayBuffer Loaded data
+ * @param options Data parse options.
+ */
+export declare function parseExcel(arrayBuffer: ArrayBuffer, options?: ExcelLoaderOptions): Promise<never[]>;
+//# sourceMappingURL=parse-excel.d.ts.map

package/dist/lib/parse-excel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse-excel.d.ts","sourceRoot":"","sources":["../../src/lib/parse-excel.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,kBAAkB,EAAC,MAAM,iBAAiB,CAAC;AAOxD;;;;GAIG;AACH,wBAAsB,UAAU,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,kBAAkB,oBAuCtF"}

package/dist/lib/parse-excel.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseExcel = void 0;
+const xlsx_1 = require("xlsx");
+// import {convertToArrayRow} from '@loaders.gl/schema';
+// local table names cache with dataUrl/tableNames array key/values
+const dataTableNamesMap = {};
+/**
+ * Gets local or remote Excel file data.
+ * @param arrayBuffer Loaded data
+ * @param options Data parse options.
+ */
+async function parseExcel(arrayBuffer, options) {
+    const dataUrl = 'dummy';
+    // const dataFileType: string = dataUrl.substr(dataUrl.lastIndexOf('.')); // file extension
+    // create Excel 'workbook'
+    const workbook = (0, xlsx_1.read)(arrayBuffer, {
+        type: 'array'
+        // cellDates: true
+    });
+    // load data sheets
+    let dataRows = [];
+    dataTableNamesMap[dataUrl] = [];
+    if (workbook.SheetNames.length > 0) {
+        if (workbook.SheetNames.length > 1) {
+            // cache sheet names
+            dataTableNamesMap[dataUrl] = workbook.SheetNames;
+            // eslint-ignore-next-line
+            // console.debug(`getData(): file:  sheetNames:`, workbook.SheetNames);
+        }
+        // determine spreadsheet to load
+        let sheetName = workbook.SheetNames[0];
+        if (options?.excel?.sheet && workbook.SheetNames.indexOf(options?.excel?.sheet) >= 0) {
+            // reset to requested table name
+            sheetName = options?.excel?.sheet;
+        }
+        // get worksheet data row objects array
+        const worksheet = workbook.Sheets[sheetName];
+        dataRows = xlsx_1.utils.sheet_to_json(worksheet);
+        // const headers = dataRows.length ? Object.keys(dataRows[0]) : [];
+        // if (options?.excel?.type === 'array-row-table') {
+        //   dataRows = dataRows.map(row => convertToArrayRow(row, headers))
+        // }
+    }
+    return dataRows;
+}
+exports.parseExcel = parseExcel;

package/dist/workers/excel-worker.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=excel-worker.d.ts.map

package/dist/workers/excel-worker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"excel-worker.d.ts","sourceRoot":"","sources":["../../src/workers/excel-worker.ts"],"names":[],"mappings":""}

package/dist/workers/excel-worker.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const loader_utils_1 = require("@loaders.gl/loader-utils");
+const index_1 = require("../index");
+(0, loader_utils_1.createLoaderWorker)(index_1.ExcelLoader);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loaders.gl/excel",
-  "version": "3.1.0-alpha.4",
+  "version": "3.1.0-beta.3",
   "description": "Framework-independent loader for Excel files",
   "license": "MIT",
   "publishConfig": {
@@ -20,7 +20,7 @@
     "Worksheets",
     "Spreadsheets"
   ],
-  "types": "src/index.ts",
+  "types": "dist/index.d.ts",
   "main": "dist/es5/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -31,13 +31,13 @@
   ],
   "scripts": {
     "pre-build": "npm run build-bundle && npm run build-worker",
-    "build-bundle": "webpack --display=minimal --config ../../scripts/webpack/bundle.js",
-    "build-worker": "webpack --entry ./src/workers/excel-worker.ts --output ./dist/excel-worker.js --config ../../scripts/webpack/worker.js"
+    "build-bundle": "esbuild src/bundle.ts --bundle --outfile=dist/bundle.js",
+    "build-worker": "esbuild src/workers/excel-worker.ts --bundle --outfile=dist/excel-worker.js"
   },
   "dependencies": {
-    "@loaders.gl/loader-utils": "3.1.0-alpha.4",
-    "@loaders.gl/schema": "3.1.0-alpha.4",
+    "@loaders.gl/loader-utils": "3.1.0-beta.3",
+    "@loaders.gl/schema": "3.1.0-beta.3",
     "xlsx": "^0.17.0"
   },
-  "gitHead": "e309784af37ef9f3640c7733c7851124c72e1fa3"
+  "gitHead": "3537c382b3ea4e092b24b6f94c3edee72076039c"
 }