read-excel-file 5.7.0 → 5.8.0

package/modules/xml/xpath/xpathBrowser.js

@@ -1,4 +1,5 @@
 // This file is no longer used.
+
 // Turns out IE11 doesn't support XPath, so not using `./xpathBrowser` for browsers.
 // https://github.com/catamphetamine/read-excel-file/issues/26
 // The inclusion of `xpath` package in `./xpathNode`
@@ -13,16 +14,14 @@ export default function xpath(document, node, path) {
   var namespaces = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
   var nodes = document.evaluate(path, node || document, function (prefix) {
     return namespaces[prefix];
-  }, XPathResult.ANY_TYPE, null); // Convert iterator to an array.
-
+  }, XPathResult.ANY_TYPE, null);
+  // Convert iterator to an array.
   var results = [];
   var result = nodes.iterateNext();
-
   while (result) {
     results.push(result);
     result = nodes.iterateNext();
   }
-
   return results;
 }
 //# sourceMappingURL=xpathBrowser.js.map

package/modules/xml/xpath/xpathBrowser.js.map

@@ -1 +1 @@
-{"version":3,"file":"xpathBrowser.js","names":["xpath","document","node","path","namespaces","nodes","evaluate","prefix","XPathResult","ANY_TYPE","results","result","iterateNext","push"],"sources":["../../../source/xml/xpath/xpathBrowser.js"],"sourcesContent":["// This file is no longer used.\r\n\r\n// Turns out IE11 doesn't support XPath, so not using `./xpathBrowser` for browsers.\r\n// https://github.com/catamphetamine/read-excel-file/issues/26\r\n// The inclusion of `xpath` package in `./xpathNode`\r\n// increases the bundle size by about 100 kilobytes.\r\n// IE11 is a wide-spread browser and it's unlikely that\r\n// anyone would ignore it for now.\r\n// There could be a separate export `read-excel-file/ie11`\r\n// for using `./xpathNode` instead of `./xpathBrowser`\r\n// but this library has been migrated to not using `xpath` anyway.\r\n// This code is just alternative/historical now, it seems.\r\nexport default function xpath(document, node, path, namespaces = {}) {\r\n\tconst nodes = document.evaluate(\r\n\t\tpath,\r\n\t\tnode || document,\r\n\t\tprefix => namespaces[prefix],\r\n\t\tXPathResult.ANY_TYPE,\r\n\t\tnull\r\n\t)\r\n\t// Convert iterator to an array.\r\n\tconst results = []\r\n\tlet result = nodes.iterateNext()\r\n\twhile (result) {\r\n\t\tresults.push(result)\r\n\t\tresult = nodes.iterateNext()\r\n\t}\r\n\treturn results\r\n}"],"mappings":"AAAA;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,eAAe,SAASA,KAAT,CAAeC,QAAf,EAAyBC,IAAzB,EAA+BC,IAA/B,EAAsD;EAAA,IAAjBC,UAAiB,uEAAJ,EAAI;EACpE,IAAMC,KAAK,GAAGJ,QAAQ,CAACK,QAAT,CACbH,IADa,EAEbD,IAAI,IAAID,QAFK,EAGb,UAAAM,MAAM;IAAA,OAAIH,UAAU,CAACG,MAAD,CAAd;EAAA,CAHO,EAIbC,WAAW,CAACC,QAJC,EAKb,IALa,CAAd,CADoE,CAQpE;;EACA,IAAMC,OAAO,GAAG,EAAhB;EACA,IAAIC,MAAM,GAAGN,KAAK,CAACO,WAAN,EAAb;;EACA,OAAOD,MAAP,EAAe;IACdD,OAAO,CAACG,IAAR,CAAaF,MAAb;IACAA,MAAM,GAAGN,KAAK,CAACO,WAAN,EAAT;EACA;;EACD,OAAOF,OAAP;AACA"}
+{"version":3,"file":"xpathBrowser.js","names":["xpath","document","node","path","namespaces","arguments","length","undefined","nodes","evaluate","prefix","XPathResult","ANY_TYPE","results","result","iterateNext","push"],"sources":["../../../source/xml/xpath/xpathBrowser.js"],"sourcesContent":["// This file is no longer used.\r\n\r\n// Turns out IE11 doesn't support XPath, so not using `./xpathBrowser` for browsers.\r\n// https://github.com/catamphetamine/read-excel-file/issues/26\r\n// The inclusion of `xpath` package in `./xpathNode`\r\n// increases the bundle size by about 100 kilobytes.\r\n// IE11 is a wide-spread browser and it's unlikely that\r\n// anyone would ignore it for now.\r\n// There could be a separate export `read-excel-file/ie11`\r\n// for using `./xpathNode` instead of `./xpathBrowser`\r\n// but this library has been migrated to not using `xpath` anyway.\r\n// This code is just alternative/historical now, it seems.\r\nexport default function xpath(document, node, path, namespaces = {}) {\r\n\tconst nodes = document.evaluate(\r\n\t\tpath,\r\n\t\tnode || document,\r\n\t\tprefix => namespaces[prefix],\r\n\t\tXPathResult.ANY_TYPE,\r\n\t\tnull\r\n\t)\r\n\t// Convert iterator to an array.\r\n\tconst results = []\r\n\tlet result = nodes.iterateNext()\r\n\twhile (result) {\r\n\t\tresults.push(result)\r\n\t\tresult = nodes.iterateNext()\r\n\t}\r\n\treturn results\r\n}"],"mappings":"AAAA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,eAAe,SAASA,KAAKA,CAACC,QAAQ,EAAEC,IAAI,EAAEC,IAAI,EAAmB;EAAA,IAAjBC,UAAU,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,CAAC,CAAC;EAClE,IAAMG,KAAK,GAAGP,QAAQ,CAACQ,QAAQ,CAC9BN,IAAI,EACJD,IAAI,IAAID,QAAQ,EAChB,UAAAS,MAAM;IAAA,OAAIN,UAAU,CAACM,MAAM,CAAC;EAAA,GAC5BC,WAAW,CAACC,QAAQ,EACpB,IACD,CAAC;EACD;EACA,IAAMC,OAAO,GAAG,EAAE;EAClB,IAAIC,MAAM,GAAGN,KAAK,CAACO,WAAW,CAAC,CAAC;EAChC,OAAOD,MAAM,EAAE;IACdD,OAAO,CAACG,IAAI,CAACF,MAAM,CAAC;IACpBA,MAAM,GAAGN,KAAK,CAACO,WAAW,CAAC,CAAC;EAC7B;EACA,OAAOF,OAAO;AACf"}

package/modules/xml/xpath/xpathNode.js

@@ -1,4 +1,5 @@
 // This file is no longer used.
+
 import xpath from 'xpath';
 export default function (document, node, path) {
   var namespaces = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};

package/modules/xml/xpath/xpathNode.js.map

@@ -1 +1 @@
-{"version":3,"file":"xpathNode.js","names":["xpath","document","node","path","namespaces","select","useNamespaces"],"sources":["../../../source/xml/xpath/xpathNode.js"],"sourcesContent":["// This file is no longer used.\r\n\r\nimport xpath from 'xpath'\r\n\r\nexport default function(document, node, path, namespaces = {}) {\r\n\tconst select = xpath.useNamespaces(namespaces)\r\n\treturn select(path, node || document)\r\n}"],"mappings":"AAAA;AAEA,OAAOA,KAAP,MAAkB,OAAlB;AAEA,eAAe,UAASC,QAAT,EAAmBC,IAAnB,EAAyBC,IAAzB,EAAgD;EAAA,IAAjBC,UAAiB,uEAAJ,EAAI;EAC9D,IAAMC,MAAM,GAAGL,KAAK,CAACM,aAAN,CAAoBF,UAApB,CAAf;EACA,OAAOC,MAAM,CAACF,IAAD,EAAOD,IAAI,IAAID,QAAf,CAAb;AACA"}
+{"version":3,"file":"xpathNode.js","names":["xpath","document","node","path","namespaces","arguments","length","undefined","select","useNamespaces"],"sources":["../../../source/xml/xpath/xpathNode.js"],"sourcesContent":["// This file is no longer used.\r\n\r\nimport xpath from 'xpath'\r\n\r\nexport default function(document, node, path, namespaces = {}) {\r\n\tconst select = xpath.useNamespaces(namespaces)\r\n\treturn select(path, node || document)\r\n}"],"mappings":"AAAA;;AAEA,OAAOA,KAAK,MAAM,OAAO;AAEzB,eAAe,UAASC,QAAQ,EAAEC,IAAI,EAAEC,IAAI,EAAmB;EAAA,IAAjBC,UAAU,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,CAAC,CAAC;EAC5D,IAAMG,MAAM,GAAGR,KAAK,CAACS,aAAa,CAACL,UAAU,CAAC;EAC9C,OAAOI,MAAM,CAACL,IAAI,EAAED,IAAI,IAAID,QAAQ,CAAC;AACtC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "read-excel-file",
-  "version": "5.7.0",
+  "version": "5.8.0",
   "description": "Read small to medium `*.xlsx` files in a browser or Node.js. Parse to JSON with a strict schema.",
   "module": "index.js",
   "main": "index.cjs",
@@ -26,6 +26,11 @@
       "import": "./schema/index.js",
       "require": "./schema/index.cjs"
     },
+    "./map": {
+      "types": "./map/index.d.ts",
+      "import": "./map/index.js",
+      "require": "./map/index.cjs"
+    },
     "./package.json": "./package.json"
   },
   "sideEffects": false,

package/schema/index.cjs

@@ -1,2 +1,2 @@
-exports = module.exports = require('../commonjs/read/schema/convertToJson.js').default
-exports['default'] = require('../commonjs/read/schema/convertToJson.js').default
+exports = module.exports = require('../commonjs/read/schema/convertToJson.legacy.js').default
+exports['default'] = require('../commonjs/read/schema/convertToJson.legacy.js').default

package/schema/index.cjs.js

@@ -3,5 +3,5 @@
 // It fixes the issue when some software doesn't see files with `*.cjs` file extensions
 // when used as the `main` property value in `package.json`.
 
-exports = module.exports = require('../commonjs/read/schema/convertToJson.js').default
-exports['default'] = require('../commonjs/read/schema/convertToJson.js').default
+exports = module.exports = require('../commonjs/read/schema/convertToJson.legacy.js').default
+exports['default'] = require('../commonjs/read/schema/convertToJson.legacy.js').default

package/schema/index.d.ts

@@ -1,6 +1,11 @@
 import {
 	Row,
 	Schema
-} from '../types.d';
+} from '../types.d.js';
 
-export default function convert(data: Row[], schema: Schema): object[];
+export default function mapWithLegacyBehavior(data: Row[], schema: Schema, options?: {
+	ignoreEmptyRows?: boolean,
+	includeNullValues?: boolean,
+	isColumnOriented?: boolean,
+	rowMap?: Record<string, number>
+}): object[];

package/schema/index.js

@@ -1 +1 @@
-export { default as default } from '../modules/read/schema/convertToJson.js'
+export { default as default } from '../modules/read/schema/convertToJson.legacy.js'

package/types.d.ts

@@ -16,7 +16,7 @@ type BasicType =
 
 export type Type<T> = (value: Cell) => T | undefined;
 
-type SchemaEntryRequired = boolean | (row: Row) => boolean;
+type SchemaEntryRequired = boolean | ((row: Row) => boolean);
 
 interface SchemaEntryBasic<T> {
 	prop: string;
@@ -68,11 +68,16 @@ interface ParseCommonOptions {
 	parseNumber?: (string: string) => any;
 }
 
-export interface ParseWithSchemaOptions<T extends object> extends ParseCommonOptions {
+export interface ParseWithSchemaOptions<T extends object> extends ParseCommonOptions, MappingParametersReadExcelFile {
 	schema: Schema;
 	transformData?: (rows: Row[]) => Row[];
-	includeNullValues?: boolean;
 	ignoreEmptyRows?: boolean;
+	// `includeNullValues: true` parameter is deprecated.
+	// It could be replaced with the following combination of parameters:
+	// * `schemaPropertyValueForMissingColumn: null`
+	// * `schemaPropertyValueForEmptyCell: null`
+	// * `getEmptyObjectValue = () => null`
+	includeNullValues?: boolean;
 }
 
 type MapProperty = string;
@@ -89,4 +94,22 @@ export interface ParseWithMapOptions extends ParseCommonOptions {
 
 export interface ParseWithoutSchemaOptions extends ParseCommonOptions {
 	dateFormat?: string;
+}
+
+interface MappingParametersCommon {
+	schemaPropertyValueForMissingColumn?: any;
+	schemaPropertyShouldSkipRequiredValidationForMissingColumn?(column: string, parameters: { object: Record<string, any> }): boolean;
+	getEmptyObjectValue?(object: Record<string, any>, parameters: { path?: string }): any;
+	getEmptyArrayValue?(array: any[], parameters: { path: string }): any;
+}
+
+interface MappingParametersReadExcelFile extends MappingParametersCommon {
+	schemaPropertyValueForEmptyCell?: null | undefined;
+}
+
+export interface MappingParameters extends MappingParametersCommon {
+	schemaPropertyValueForUndefinedCellValue?: any;
+	schemaPropertyValueForNullCellValue?: any;
+	isColumnOriented?: boolean;
+	rowIndexMap?: Record<string, number>;
 }