.

catamphetamine · catamphetamine · commit 34e66f244931 · 2025-03-11T00:36:13.000+03:00
diff --git a/README.md b/README.md
@@ -258,9 +258,9 @@ readXlsxFile(file, { schema }).then(({ rows, errors }) => {
 The function for converting input data rows to JSON objects using a schema is exported independently as `read-excel-file/map`, if anyone's interested.
 
 ```js
-import convertToJson from "read-excel-file/map"
+import mapToObjects from "read-excel-file/map"
 
-const { rows, errors } = convertToJson(data, schema, options)
+const { rows, errors } = mapToObjects(data, schema, options)
 ```
 
 Maps a list of rows — `data` — into a list of objects — `rows` — using a `schema` as a mapping specification.
diff --git a/map/index.cjs b/map/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/mapToObjects.js').default
+exports['default'] = require('../commonjs/read/schema/mapToObjects.js').default
diff --git a/map/index.cjs.js b/map/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/mapToObjects.js').default
+exports['default'] = require('../commonjs/read/schema/mapToObjects.js').default
diff --git a/map/index.d.ts b/map/index.d.ts
@@ -1,11 +1,15 @@
 import {
 	Row,
 	Schema,
+	Error,
 	MappingParameters
 } from '../types.d.js';
 
 export {
 	MappingParameters
 } from '../types.d.js'
 
-export default function map<T>(data: Row[], schema: Schema<T>, options?: MappingParameters): T[];
+export default function map<T>(data: Row[], schema: Schema<T>, options?: MappingParameters): {
+	rows: T[];
+	errors: Error[];
+};
diff --git a/map/index.js b/map/index.js
@@ -1 +1 @@
-export { default as default } from '../modules/read/schema/convertToJson.js'
+export { default as default } from '../modules/read/schema/mapToObjects.js'
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "read-excel-file",
-  "version": "5.8.6",
+  "version": "5.8.7",
   "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",
diff --git a/schema/index.cjs b/schema/index.cjs
@@ -1,2 +1,2 @@
-exports = module.exports = require('../commonjs/read/schema/convertToJson.legacy.js').default
-exports['default'] = require('../commonjs/read/schema/convertToJson.legacy.js').default
+exports = module.exports = require('../commonjs/read/schema/mapToObjects.legacy.js').default
+exports['default'] = require('../commonjs/read/schema/mapToObjects.legacy.js').default
diff --git a/schema/index.cjs.js b/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.legacy.js').default
-exports['default'] = require('../commonjs/read/schema/convertToJson.legacy.js').default
+exports = module.exports = require('../commonjs/read/schema/mapToObjects.legacy.js').default
+exports['default'] = require('../commonjs/read/schema/mapToObjects.legacy.js').default
diff --git a/schema/index.js b/schema/index.js
@@ -1 +1 @@
-export { default as default } from '../modules/read/schema/convertToJson.legacy.js'
+export { default as default } from '../modules/read/schema/mapToObjects.legacy.js'
diff --git a/source/read/readXlsxFileContents.js b/source/read/readXlsxFileContents.js
@@ -1,7 +1,7 @@
 import readXlsx from './readXlsx.js'
 
-import convertToJsonLegacyBehavior from './schema/convertToJson.legacy.js'
-import convertToJsonSpreadsheetBehavior from './schema/convertToJson.spreadsheet.js'
+import mapToObjectsLegacyBehavior from './schema/mapToObjects.legacy.js'
+import mapToObjectsSpreadsheetBehavior from './schema/mapToObjects.spreadsheet.js'
 
 import convertMapToSchema from './schema/convertMapToSchema.js'
 
@@ -12,7 +12,7 @@ export default function readXlsxFileContents(entries, xml, { schema, map, ...opt
 	// `readXlsx()` adds `options.rowMap`, if not passed.
 	const result = readXlsx(entries, xml, { ...options, properties: schema || options.properties })
 	if (schema) {
-		return convertToJsonSpreadsheetBehavior(convertToJsonLegacyBehavior, result.data, schema, {
+		return mapToObjectsSpreadsheetBehavior(mapToObjectsLegacyBehavior, result.data, schema, {
 			...options,
 			properties: result.properties
 		})
diff --git a/source/read/schema/convertToJson.spreadsheet.js b/source/read/schema/convertToJson.spreadsheet.js
diff --git a/source/read/schema/mapToObjects.js b/source/read/schema/mapToObjects.js
@@ -33,7 +33,7 @@ const DEFAULT_OPTIONS = {
  * @param {object} [options.rowIndexMap] — Custom row index mapping `data` rows. If present, will overwrite the indexes of `data` rows with the indexes from this `rowIndexMap`.
  * @return {object[]}
  */
-export default function(data, schema, options) {
+export default function mapToObjects(data, schema, options) {
   if (options) {
     options = {
       ...DEFAULT_OPTIONS,
diff --git a/source/read/schema/mapToObjects.legacy.js b/source/read/schema/mapToObjects.legacy.js
@@ -1,6 +1,6 @@
-import convertToJson from './convertToJson.js'
+import mapToObjects from './mapToObjects.js'
 
-export default function convertToJsonLegacyBehavior(data, schema, options = {}) {
+export default function mapToObjectsLegacyBehavior(data, schema, options = {}) {
 	const {
 		includeNullValues,
 		ignoreEmptyRows,
@@ -22,7 +22,7 @@ export default function convertToJsonLegacyBehavior(data, schema, options = {})
 		defaultConversionOptions.schemaPropertyValueForNullCellValue = null
 		defaultConversionOptions.getEmptyObjectValue = (object, { path }) => null
 	}
-	const result = convertToJson(data, schema, {
+	const result = mapToObjects(data, schema, {
 		...defaultConversionOptions,
 		rowIndexMap: rowMap,
 		isColumnOriented
diff --git a/source/read/schema/mapToObjects.legacy.test.js b/source/read/schema/mapToObjects.legacy.test.js
@@ -1,10 +1,10 @@
-import convertToJson from './convertToJson.legacy.js'
+import mapToObjects from './mapToObjects.legacy.js'
 
 import Integer from '../../types/Integer.js'
 
-describe('convertToJson (legacy behavior)', () => {
+describe('mapToObjects (legacy behavior)', () => {
 	it('should include `null` values when `includeNullValues: true` option is passed', function() {
-		const { rows } = convertToJson(
+		const { rows } = mapToObjects(
 			[
 				['A', 'B', 'CA', 'CB'],
 				['a', 'b', 'ca', null],
@@ -45,7 +45,7 @@ describe('convertToJson (legacy behavior)', () => {
 	})
 
 	it('should handle missing columns / empty cells (default) (`required: false`)', () => {
-		const { rows, errors } = convertToJson([
+		const { rows, errors } = mapToObjects([
 			[
 				'COLUMN_2',
 				'COLUMN_3',
@@ -94,7 +94,7 @@ describe('convertToJson (legacy behavior)', () => {
 	})
 
 	it('should handle missing columns / empty cells (`includeNullValues: true`) (`required: false`)', () => {
-		const { rows, errors } = convertToJson([
+		const { rows, errors } = mapToObjects([
 			[
 				'COLUMN_2',
 				'COLUMN_3',
@@ -149,7 +149,7 @@ describe('convertToJson (legacy behavior)', () => {
 	})
 
 	it('should require fields when cell value is empty', () => {
-		const { rows, errors } = convertToJson([
+		const { rows, errors } = mapToObjects([
 			[
 				'NUMBER',
 				'STRING'
@@ -186,7 +186,7 @@ describe('convertToJson (legacy behavior)', () => {
 	})
 
 	it('shouldn\'t require fields when cell value is empty and object is empty too', () => {
-		const { rows, errors } = convertToJson([
+		const { rows, errors } = mapToObjects([
 			[
 				'NUMBER'
 			],
@@ -205,7 +205,7 @@ describe('convertToJson (legacy behavior)', () => {
 	})
 
 	it('should parse arrays (and remove `null` empty objects from result)', () => {
-		const { rows, errors } = convertToJson([
+		const { rows, errors } = mapToObjects([
 			[
 				'NAMES'
 			], [
@@ -229,7 +229,7 @@ describe('convertToJson (legacy behavior)', () => {
 
 	it('should parse integers (and drop `null` errored objects from result)', () =>
 	{
-		const { rows, errors } = convertToJson([
+		const { rows, errors } = mapToObjects([
 			[
 				'INTEGER'
 			], [
@@ -260,7 +260,7 @@ describe('convertToJson (legacy behavior)', () => {
 	})
 
 	it('should not include `null` values by default (and set `null` for an "empty" object)', function() {
-		const { rows } = convertToJson(
+		const { rows } = mapToObjects(
 			[
 				['A', 'B', 'CA', 'CB'],
 				['a', 'b', 'ca', null],
diff --git a/source/read/schema/mapToObjects.spreadsheet.js b/source/read/schema/mapToObjects.spreadsheet.js
@@ -0,0 +1,11 @@
+// Renames some of the `react-excel-file` options to `mapToObjects()` options.
+export default function mapToObjectsSpreadsheetBehavior(mapToObjects, data, schema, options = {}) {
+	const {
+		schemaPropertyValueForEmptyCell,
+		...restOptions
+	} = options
+	return mapToObjects(data, schema, {
+		...restOptions,
+		schemaPropertyValueForNullCellValue: schemaPropertyValueForEmptyCell
+	})
+}
diff --git a/source/read/schema/mapToObjects.spreadsheet.test.js b/source/read/schema/mapToObjects.spreadsheet.test.js
@@ -1,13 +1,13 @@
-import convertToJson_ from './convertToJson.js'
-import convertToJsonSpreadsheetBehavior from './convertToJson.spreadsheet.js'
+import mapToObjects_ from './mapToObjects.js'
+import mapToObjectsSpreadsheetBehavior from './mapToObjects.spreadsheet.js'
 
-function convertToJson(data, schema, options) {
-	return convertToJsonSpreadsheetBehavior(convertToJson_, data, schema, options)
+function mapToObjects(data, schema, options) {
+	return mapToObjectsSpreadsheetBehavior(mapToObjects_, data, schema, options)
 }
 
-describe('convertToJson (spreadsheet behavior)', () => {
+describe('mapToObjects (spreadsheet behavior)', () => {
 	it('should handle missing columns / empty cells (`schemaPropertyValueForMissingColumn: null`) (`required: false`)', () => {
-		const { rows, errors } = convertToJson([
+		const { rows, errors } = mapToObjects([
 			[
 				'COLUMN_2',
 				'COLUMN_3',
@@ -62,7 +62,7 @@ describe('convertToJson (spreadsheet behavior)', () => {
 	})
 
 	it('should handle missing columns / empty cells (`schemaPropertyValueForEmptyCell: null`) (`required: false`)', () => {
-		const { rows, errors } = convertToJson([
+		const { rows, errors } = mapToObjects([
 			[
 				'COLUMN_2',
 				'COLUMN_3',
diff --git a/source/read/schema/mapToObjects.test.js b/source/read/schema/mapToObjects.test.js
diff --git a/source/read/unpackXlsxFileNode.js b/source/read/unpackXlsxFileNode.js

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-export { default as default } from '../modules/read/schema/convertToJson.js'`
	`1`	`+export { default as default } from '../modules/read/schema/mapToObjects.js'`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "read-excel-file",`
`3`		`- "version": "5.8.6",`
	`3`	`+ "version": "5.8.7",`
`4`	`4`	"description": "Read small to medium `*.xlsx` files in a browser or Node.js. Parse to JSON with a strict schema.",
`5`	`5`	`"module": "index.js",`
`6`	`6`	`"main": "index.cjs",`