read-excel-file 5.2.21 → 5.2.22

package/CHANGELOG.md

@@ -5,6 +5,11 @@
   * Added [TypeScript](https://github.com/catamphetamine/read-excel-file/issues/71) definitions.
 -->
 
+5.2.22 / 11.11.2021
+==================
+
+* [Added](https://github.com/catamphetamine/read-excel-file/issues/100) `/web-worker` export
+
 5.2.11 / 08.10.2021
 ==================
 

package/README.md

@@ -50,10 +50,47 @@ readXlsxFile('/path/to/file').then((rows) => {
 
 // Readable Stream.
 readXlsxFile(fs.createReadStream('/path/to/file')).then((rows) => {
-  ...
+  // `rows` is an array of rows
+  // each row being an array of cells.
+})
+```
+
+### Web Worker
+
+```js
+const worker = new Worker('web-worker.js')
+
+worker.onmessage = function(event) {
+  // `event.data` is an array of rows
+  // each row being an array of cells.
+  console.log(event.data)
+}
+
+worker.onerror = function(event) {
+  console.error(event.message)
+}
+
+const input = document.getElementById('input')
+
+input.addEventListener('change', () => {
+  worker.postMessage(input.files[0])
 })
 ```
 
+##### `web-worker.js`
+
+```js
+import readXlsxFile from 'read-excel-file/web-worker'
+
+onmessage = function(event) {
+  readXlsxFile(event.data).then((rows) => {
+    // `rows` is an array of rows
+    // each row being an array of cells.
+    postMessage(rows)
+  })
+}
+```
+
 ## JSON
 
 To convert table rows to JSON objects, pass a `schema` option to `readXlsxFile()`. It will return `{ rows, errors }` object instead of just `rows`.

package/commonjs/read/readXlsxFileNode.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = readXlsxFile;
 
-var _xmlNode = _interopRequireDefault(require("../xml/xmlNode"));
+var _xml = _interopRequireDefault(require("../xml/xml"));
 
 var _unpackXlsxFileNode = _interopRequireDefault(require("./unpackXlsxFileNode"));
 
@@ -23,7 +23,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "d
 function readXlsxFile(input) {
   var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   return (0, _unpackXlsxFileNode["default"])(input).then(function (entries) {
-    return (0, _readXlsxFileContents["default"])(entries, _xmlNode["default"], options);
+    return (0, _readXlsxFileContents["default"])(entries, _xml["default"], options);
   });
 }
 //# sourceMappingURL=readXlsxFileNode.js.map

package/commonjs/read/readXlsxFileNode.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../source/read/readXlsxFileNode.js"],"names":["readXlsxFile","input","options","then","entries","xml"],"mappings":";;;;;;;AAAA;;AAEA;;AACA;;;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACe,SAASA,YAAT,CAAsBC,KAAtB,EAA2C;AAAA,MAAdC,OAAc,uEAAJ,EAAI;AACzD,SAAO,oCAAeD,KAAf,EACLE,IADK,CACA,UAACC,OAAD;AAAA,WAAa,sCAAqBA,OAArB,EAA8BC,mBAA9B,EAAmCH,OAAnC,CAAb;AAAA,GADA,CAAP;AAEA","sourcesContent":["import xml from '../xml/xmlNode'\r\n\r\nimport unpackXlsxFile from './unpackXlsxFileNode'\r\nimport readXlsxFileContents from './readXlsxFileContents'\r\n\r\n/**\r\n * Reads XLSX file into a 2D array of cells in a browser.\r\n * @param  {(string|Stream|Buffer)} input - A Node.js readable stream or a `Buffer` or a path to a file.\r\n * @param  {object?} options\r\n * @param  {(number|string)?} options.sheet - Excel document sheet to read. Defaults to `1`. Will only read this sheet and skip others.\r\n * @return {Promise} Resolves to a 2D array of cells: an array of rows, each row being an array of cells.\r\n */\r\nexport default function readXlsxFile(input, options = {}) {\r\n\treturn unpackXlsxFile(input)\r\n\t\t.then((entries) => readXlsxFileContents(entries, xml, options))\r\n}"],"file":"readXlsxFileNode.js"}
+{"version":3,"sources":["../../source/read/readXlsxFileNode.js"],"names":["readXlsxFile","input","options","then","entries","xml"],"mappings":";;;;;;;AAAA;;AAEA;;AACA;;;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACe,SAASA,YAAT,CAAsBC,KAAtB,EAA2C;AAAA,MAAdC,OAAc,uEAAJ,EAAI;AACzD,SAAO,oCAAeD,KAAf,EACLE,IADK,CACA,UAACC,OAAD;AAAA,WAAa,sCAAqBA,OAArB,EAA8BC,eAA9B,EAAmCH,OAAnC,CAAb;AAAA,GADA,CAAP;AAEA","sourcesContent":["import xml from '../xml/xml'\r\n\r\nimport unpackXlsxFile from './unpackXlsxFileNode'\r\nimport readXlsxFileContents from './readXlsxFileContents'\r\n\r\n/**\r\n * Reads XLSX file into a 2D array of cells in a browser.\r\n * @param  {(string|Stream|Buffer)} input - A Node.js readable stream or a `Buffer` or a path to a file.\r\n * @param  {object?} options\r\n * @param  {(number|string)?} options.sheet - Excel document sheet to read. Defaults to `1`. Will only read this sheet and skip others.\r\n * @return {Promise} Resolves to a 2D array of cells: an array of rows, each row being an array of cells.\r\n */\r\nexport default function readXlsxFile(input, options = {}) {\r\n\treturn unpackXlsxFile(input)\r\n\t\t.then((entries) => readXlsxFileContents(entries, xml, options))\r\n}"],"file":"readXlsxFileNode.js"}

package/commonjs/read/readXlsxFileWebWorker.js

@@ -0,0 +1,29 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = readXlsxFile;
+
+var _xml = _interopRequireDefault(require("../xml/xml"));
+
+var _unpackXlsxFileBrowser = _interopRequireDefault(require("./unpackXlsxFileBrowser"));
+
+var _readXlsxFileContents = _interopRequireDefault(require("./readXlsxFileContents"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+
+/**
+ * Reads XLSX file into a 2D array of cells in a web worker.
+ * @param  {file} file - The file.
+ * @param  {object?} options
+ * @param  {(number|string)?} options.sheet - Excel document sheet to read. Defaults to `1`. Will only read this sheet and skip others.
+ * @return {Promise} Resolves to a 2D array of cells: an array of rows, each row being an array of cells.
+ */
+function readXlsxFile(file) {
+  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  return (0, _unpackXlsxFileBrowser["default"])(file).then(function (entries) {
+    return (0, _readXlsxFileContents["default"])(entries, _xml["default"], options);
+  });
+}
+//# sourceMappingURL=readXlsxFileWebWorker.js.map

package/commonjs/read/readXlsxFileWebWorker.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../source/read/readXlsxFileWebWorker.js"],"names":["readXlsxFile","file","options","then","entries","xml"],"mappings":";;;;;;;AAAA;;AAEA;;AACA;;;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACe,SAASA,YAAT,CAAsBC,IAAtB,EAA0C;AAAA,MAAdC,OAAc,uEAAJ,EAAI;AACxD,SAAO,uCAAeD,IAAf,EACLE,IADK,CACA,UAACC,OAAD;AAAA,WAAa,sCAAqBA,OAArB,EAA8BC,eAA9B,EAAmCH,OAAnC,CAAb;AAAA,GADA,CAAP;AAEA","sourcesContent":["import xml from '../xml/xml'\r\n\r\nimport unpackXlsxFile from './unpackXlsxFileBrowser'\r\nimport readXlsxFileContents from './readXlsxFileContents'\r\n\r\n/**\r\n * Reads XLSX file into a 2D array of cells in a web worker.\r\n * @param  {file} file - The file.\r\n * @param  {object?} options\r\n * @param  {(number|string)?} options.sheet - Excel document sheet to read. Defaults to `1`. Will only read this sheet and skip others.\r\n * @return {Promise} Resolves to a 2D array of cells: an array of rows, each row being an array of cells.\r\n */\r\nexport default function readXlsxFile(file, options = {}) {\r\n\treturn unpackXlsxFile(file)\r\n\t\t.then((entries) => readXlsxFileContents(entries, xml, options))\r\n}"],"file":"readXlsxFileWebWorker.js"}

package/commonjs/xml/{xmlNode.js → xml.js}

@@ -15,4 +15,4 @@ var _default = {
   }
 };
 exports["default"] = _default;
-//# sourceMappingURL=xmlNode.js.map
+//# sourceMappingURL=xml.js.map

package/commonjs/xml/xml.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../source/xml/xml.js"],"names":["createDocument","content","XMLDOM","DOMParser","parseFromString"],"mappings":";;;;;;;AAAA;;;;eAEe;AACdA,EAAAA,cADc,0BACCC,OADD,EACU;AACvB,WAAO,IAAIC,mBAAOC,SAAX,GAAuBC,eAAvB,CAAuCH,OAAvC,CAAP;AACA;AAHa,C","sourcesContent":["import XMLDOM from '@xmldom/xmldom'\r\n\r\nexport default {\r\n\tcreateDocument(content) {\r\n\t\treturn new XMLDOM.DOMParser().parseFromString(content)\r\n\t}\r\n}"],"file":"xml.js"}

package/modules/read/readXlsxFileNode.js

@@ -1,4 +1,4 @@
-import xml from '../xml/xmlNode';
+import xml from '../xml/xml';
 import unpackXlsxFile from './unpackXlsxFileNode';
 import readXlsxFileContents from './readXlsxFileContents';
 /**

package/modules/read/readXlsxFileNode.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../source/read/readXlsxFileNode.js"],"names":["xml","unpackXlsxFile","readXlsxFileContents","readXlsxFile","input","options","then","entries"],"mappings":"AAAA,OAAOA,GAAP,MAAgB,gBAAhB;AAEA,OAAOC,cAAP,MAA2B,sBAA3B;AACA,OAAOC,oBAAP,MAAiC,wBAAjC;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,eAAe,SAASC,YAAT,CAAsBC,KAAtB,EAA2C;AAAA,MAAdC,OAAc,uEAAJ,EAAI;AACzD,SAAOJ,cAAc,CAACG,KAAD,CAAd,CACLE,IADK,CACA,UAACC,OAAD;AAAA,WAAaL,oBAAoB,CAACK,OAAD,EAAUP,GAAV,EAAeK,OAAf,CAAjC;AAAA,GADA,CAAP;AAEA","sourcesContent":["import xml from '../xml/xmlNode'\r\n\r\nimport unpackXlsxFile from './unpackXlsxFileNode'\r\nimport readXlsxFileContents from './readXlsxFileContents'\r\n\r\n/**\r\n * Reads XLSX file into a 2D array of cells in a browser.\r\n * @param  {(string|Stream|Buffer)} input - A Node.js readable stream or a `Buffer` or a path to a file.\r\n * @param  {object?} options\r\n * @param  {(number|string)?} options.sheet - Excel document sheet to read. Defaults to `1`. Will only read this sheet and skip others.\r\n * @return {Promise} Resolves to a 2D array of cells: an array of rows, each row being an array of cells.\r\n */\r\nexport default function readXlsxFile(input, options = {}) {\r\n\treturn unpackXlsxFile(input)\r\n\t\t.then((entries) => readXlsxFileContents(entries, xml, options))\r\n}"],"file":"readXlsxFileNode.js"}
+{"version":3,"sources":["../../source/read/readXlsxFileNode.js"],"names":["xml","unpackXlsxFile","readXlsxFileContents","readXlsxFile","input","options","then","entries"],"mappings":"AAAA,OAAOA,GAAP,MAAgB,YAAhB;AAEA,OAAOC,cAAP,MAA2B,sBAA3B;AACA,OAAOC,oBAAP,MAAiC,wBAAjC;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,eAAe,SAASC,YAAT,CAAsBC,KAAtB,EAA2C;AAAA,MAAdC,OAAc,uEAAJ,EAAI;AACzD,SAAOJ,cAAc,CAACG,KAAD,CAAd,CACLE,IADK,CACA,UAACC,OAAD;AAAA,WAAaL,oBAAoB,CAACK,OAAD,EAAUP,GAAV,EAAeK,OAAf,CAAjC;AAAA,GADA,CAAP;AAEA","sourcesContent":["import xml from '../xml/xml'\r\n\r\nimport unpackXlsxFile from './unpackXlsxFileNode'\r\nimport readXlsxFileContents from './readXlsxFileContents'\r\n\r\n/**\r\n * Reads XLSX file into a 2D array of cells in a browser.\r\n * @param  {(string|Stream|Buffer)} input - A Node.js readable stream or a `Buffer` or a path to a file.\r\n * @param  {object?} options\r\n * @param  {(number|string)?} options.sheet - Excel document sheet to read. Defaults to `1`. Will only read this sheet and skip others.\r\n * @return {Promise} Resolves to a 2D array of cells: an array of rows, each row being an array of cells.\r\n */\r\nexport default function readXlsxFile(input, options = {}) {\r\n\treturn unpackXlsxFile(input)\r\n\t\t.then((entries) => readXlsxFileContents(entries, xml, options))\r\n}"],"file":"readXlsxFileNode.js"}

package/modules/read/readXlsxFileWebWorker.js

@@ -0,0 +1,18 @@
+import xml from '../xml/xml';
+import unpackXlsxFile from './unpackXlsxFileBrowser';
+import readXlsxFileContents from './readXlsxFileContents';
+/**
+ * Reads XLSX file into a 2D array of cells in a web worker.
+ * @param  {file} file - The file.
+ * @param  {object?} options
+ * @param  {(number|string)?} options.sheet - Excel document sheet to read. Defaults to `1`. Will only read this sheet and skip others.
+ * @return {Promise} Resolves to a 2D array of cells: an array of rows, each row being an array of cells.
+ */
+
+export default function readXlsxFile(file) {
+  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  return unpackXlsxFile(file).then(function (entries) {
+    return readXlsxFileContents(entries, xml, options);
+  });
+}
+//# sourceMappingURL=readXlsxFileWebWorker.js.map

package/modules/read/readXlsxFileWebWorker.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../source/read/readXlsxFileWebWorker.js"],"names":["xml","unpackXlsxFile","readXlsxFileContents","readXlsxFile","file","options","then","entries"],"mappings":"AAAA,OAAOA,GAAP,MAAgB,YAAhB;AAEA,OAAOC,cAAP,MAA2B,yBAA3B;AACA,OAAOC,oBAAP,MAAiC,wBAAjC;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,eAAe,SAASC,YAAT,CAAsBC,IAAtB,EAA0C;AAAA,MAAdC,OAAc,uEAAJ,EAAI;AACxD,SAAOJ,cAAc,CAACG,IAAD,CAAd,CACLE,IADK,CACA,UAACC,OAAD;AAAA,WAAaL,oBAAoB,CAACK,OAAD,EAAUP,GAAV,EAAeK,OAAf,CAAjC;AAAA,GADA,CAAP;AAEA","sourcesContent":["import xml from '../xml/xml'\r\n\r\nimport unpackXlsxFile from './unpackXlsxFileBrowser'\r\nimport readXlsxFileContents from './readXlsxFileContents'\r\n\r\n/**\r\n * Reads XLSX file into a 2D array of cells in a web worker.\r\n * @param  {file} file - The file.\r\n * @param  {object?} options\r\n * @param  {(number|string)?} options.sheet - Excel document sheet to read. Defaults to `1`. Will only read this sheet and skip others.\r\n * @return {Promise} Resolves to a 2D array of cells: an array of rows, each row being an array of cells.\r\n */\r\nexport default function readXlsxFile(file, options = {}) {\r\n\treturn unpackXlsxFile(file)\r\n\t\t.then((entries) => readXlsxFileContents(entries, xml, options))\r\n}"],"file":"readXlsxFileWebWorker.js"}

package/modules/xml/{xmlNode.js → xml.js}

@@ -4,4 +4,4 @@ export default {
     return new XMLDOM.DOMParser().parseFromString(content);
   }
 };
-//# sourceMappingURL=xmlNode.js.map
+//# sourceMappingURL=xml.js.map

package/modules/xml/xml.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../source/xml/xml.js"],"names":["XMLDOM","createDocument","content","DOMParser","parseFromString"],"mappings":"AAAA,OAAOA,MAAP,MAAmB,gBAAnB;AAEA,eAAe;AACdC,EAAAA,cADc,0BACCC,OADD,EACU;AACvB,WAAO,IAAIF,MAAM,CAACG,SAAX,GAAuBC,eAAvB,CAAuCF,OAAvC,CAAP;AACA;AAHa,CAAf","sourcesContent":["import XMLDOM from '@xmldom/xmldom'\r\n\r\nexport default {\r\n\tcreateDocument(content) {\r\n\t\treturn new XMLDOM.DOMParser().parseFromString(content)\r\n\t}\r\n}"],"file":"xml.js"}

package/node/package.json

@@ -4,6 +4,6 @@
   "version": "1.0.0",
   "main": "index.commonjs.js",
   "module": "index.js",
-  "types.test": "./index.d.ts.test",
+  "types": "./index.d.ts",
   "sideEffects": false
 }

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "read-excel-file",
-  "version": "5.2.21",
+  "version": "5.2.22",
   "description": "Read small to medium `*.xlsx` files in a browser or Node.js. Parse to JSON with a strict schema.",
   "module": "index.js",
   "sideEffects": false,
   "main": "index.commonjs.js",
-  "types.test": "./index.d.ts.test",
+  "types": "./index.d.ts",
   "scripts": {
     "test": "mocha --require @babel/register --colors --bail --reporter spec --require ./test/setup.js \"./{,!(node_modules|commonjs|modules)/**/}*.test.js\" --recursive",
     "test-coverage": "istanbul cover -x \"commonjs/**\" -x \"modules/**\" -x \"*.test.js\" node_modules/mocha/bin/_mocha -- --compilers js:babel-core/register --colors --reporter dot --require ./test/setup.js \"./{,!(node_modules|commonjs|modules)/**/}*.test.js\" --recursive",

package/schema/package.json

@@ -4,6 +4,6 @@
   "version": "1.0.0",
   "main": "index.commonjs.js",
   "module": "index.js",
-  "types.test": "./index.d.ts.test",
+  "types": "./index.d.ts",
   "sideEffects": false
 }

package/web-worker/index.commonjs.js

@@ -0,0 +1,6 @@
+exports = module.exports = require('../commonjs/read/readXlsxFileWebWorker').default
+exports['default'] = require('../commonjs/read/readXlsxFileWebWorker').default
+exports.parseExcelDate = require('../commonjs/read/parseDate').default
+exports.Integer = require('../commonjs/types/Integer').default
+exports.Email = require('../commonjs/types/Email').default
+exports.URL = require('../commonjs/types/URL').default

package/web-worker/index.d.ts

@@ -0,0 +1 @@
+export * from '../index.d';

package/web-worker/index.js

@@ -0,0 +1,5 @@
+export { default as default } from '../modules/read/readXlsxFileNode'
+export { default as parseExcelDate } from '../modules/read/parseDate'
+export { default as Integer } from '../modules/types/Integer'
+export { default as Email } from '../modules/types/Email'
+export { default as URL } from '../modules/types/URL'

package/web-worker/package.json

@@ -0,0 +1,9 @@
+{
+  "private": true,
+  "name": "read-excel-file/web-worker",
+  "version": "1.0.0",
+  "main": "index.commonjs.js",
+  "module": "index.js",
+  "types": "./index.d.ts",
+  "sideEffects": false
+}

package/commonjs/xml/xmlNode.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../source/xml/xmlNode.js"],"names":["createDocument","content","XMLDOM","DOMParser","parseFromString"],"mappings":";;;;;;;AAAA;;;;eAEe;AACdA,EAAAA,cADc,0BACCC,OADD,EACU;AACvB,WAAO,IAAIC,mBAAOC,SAAX,GAAuBC,eAAvB,CAAuCH,OAAvC,CAAP;AACA;AAHa,C","sourcesContent":["import XMLDOM from '@xmldom/xmldom'\r\n\r\nexport default {\r\n\tcreateDocument(content) {\r\n\t\treturn new XMLDOM.DOMParser().parseFromString(content)\r\n\t}\r\n}"],"file":"xmlNode.js"}

package/modules/xml/xmlNode.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../source/xml/xmlNode.js"],"names":["XMLDOM","createDocument","content","DOMParser","parseFromString"],"mappings":"AAAA,OAAOA,MAAP,MAAmB,gBAAnB;AAEA,eAAe;AACdC,EAAAA,cADc,0BACCC,OADD,EACU;AACvB,WAAO,IAAIF,MAAM,CAACG,SAAX,GAAuBC,eAAvB,CAAuCF,OAAvC,CAAP;AACA;AAHa,CAAf","sourcesContent":["import XMLDOM from '@xmldom/xmldom'\r\n\r\nexport default {\r\n\tcreateDocument(content) {\r\n\t\treturn new XMLDOM.DOMParser().parseFromString(content)\r\n\t}\r\n}"],"file":"xmlNode.js"}