read-excel-file 7.0.3 → 8.0.0

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

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"xpathBrowser.js","names":["xpath","document","element","path","namespaces","arguments","length","undefined","elements","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, element, path, namespaces = {}) {\r\n\tconst elements = document.evaluate(\r\n\t\tpath,\r\n\t\telement || 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 = elements.iterateNext()\r\n\twhile (result) {\r\n\t\tresults.push(result)\r\n\t\tresult = elements.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,OAAO,EAAEC,IAAI,EAAmB;EAAA,IAAjBC,UAAU,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,CAAC,CAAC;EACrE,IAAMG,QAAQ,GAAGP,QAAQ,CAACQ,QAAQ,CACjCN,IAAI,EACJD,OAAO,IAAID,QAAQ,EACnB,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,QAAQ,CAACO,WAAW,CAAC,CAAC;EACnC,OAAOD,MAAM,EAAE;IACdD,OAAO,CAACG,IAAI,CAACF,MAAM,CAAC;IACpBA,MAAM,GAAGN,QAAQ,CAACO,WAAW,CAAC,CAAC;EAChC;EACA,OAAOF,OAAO;AACf"}

package/modules/xml/xpath/xpathNode.js

@@ -1,9 +1,9 @@
 // This file is no longer used.
 
 import xpath from 'xpath';
-export default function (document, node, path) {
+export default function (document, element, path) {
   var namespaces = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
   var select = xpath.useNamespaces(namespaces);
-  return select(path, node || document);
+  return select(path, element || document);
 }
 //# sourceMappingURL=xpathNode.js.map

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

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"xpathNode.js","names":["xpath","document","element","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, element, path, namespaces = {}) {\r\n\tconst select = xpath.useNamespaces(namespaces)\r\n\treturn select(path, element || document)\r\n}"],"mappings":"AAAA;;AAEA,OAAOA,KAAK,MAAM,OAAO;AAEzB,eAAe,UAASC,QAAQ,EAAEC,OAAO,EAAEC,IAAI,EAAmB;EAAA,IAAjBC,UAAU,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,CAAC,CAAC;EAC/D,IAAMG,MAAM,GAAGR,KAAK,CAACS,aAAa,CAACL,UAAU,CAAC;EAC9C,OAAOI,MAAM,CAACL,IAAI,EAAED,OAAO,IAAID,QAAQ,CAAC;AACzC"}

package/node/index.cjs

@@ -1,7 +1,10 @@
 exports = module.exports = require('../commonjs/export/readXlsxFileNode.js').default
 exports['default'] = require('../commonjs/export/readXlsxFileNode.js').default
-exports.readSheetNames = require('../commonjs/export/readSheetNamesNode.js').default
-exports.parseExcelDate = require('../commonjs/xlsx/parseDate.js').default
-exports.Integer = require('../commonjs/types/Integer.js').default
-exports.Email = require('../commonjs/types/Email.js').default
-exports.URL = require('../commonjs/types/URL.js').default
+
+exports.readSheet = require('../commonjs/export/readSheetNode.js').default
+
+// `parseData()`
+exports.parseData = require('../commonjs/parseData/parseData.js').default
+exports.Integer = require('../commonjs/parseData/types/additional/Integer.js').default
+exports.Email = require('../commonjs/parseData/types/additional/Email.js').default
+exports.URL = require('../commonjs/parseData/types/additional/URL.js').default

package/node/index.d.ts

@@ -1,36 +1,71 @@
-// See the discussion:
-// https://github.com/catamphetamine/read-excel-file/issues/71
+// The contents of this file is identical between the different exports:
+// `/node`, `/browser`, etc.
 
-import { PathLike } from 'fs';
-import { Stream } from 'stream';
-import { Blob } from 'buffer'
+import { Input } from './input.d.js'
 
 import {
-	ParseWithSchemaOptions,
-	ParseWithoutSchemaOptions,
-	ParsedObjectsResult,
-	Row
-} from '../types.d.js';
+	SheetData,
+	ReadOptions,
+	ReadFileResult
+} from '../types/types.d.js';
+
+import {
+	ParseDataOptions,
+	ParseDataResult
+} from '../types/parseData/parseData.d.js';
+
+import {
+	Schema
+} from '../types/parseData/parseDataSchema.d.js';
 
 export {
-	Schema,
-	ParsedObjectsResult,
-	SchemaParseCellValueError,
-	CellValueRequiredError,
 	CellValue,
 	Row,
+	SheetData
+} from '../types/types.d.js';
+
+export {
+	ParseDataValueCustomType as ParseDataValueType,
+	// Additional built-in `type`s when parsing data.
 	Integer,
 	Email,
 	URL
-} from '../types.d.js';
+} from '../types/parseData/parseDataValueType.d.js';
 
-export function parseExcelDate(excelSerialDate: number) : typeof Date;
+export {
+	ParseDataError,
+	ParseDataValueRequiredError
+} from '../types/parseData/parseDataError.d.js';
+
+export {
+	ParseDataResult
+} from '../types/parseData/parseData.d.js';
+
+export {
+	Schema
+} from '../types/parseData/parseDataSchema.d.js';
 
-type Input = Stream | Buffer | PathLike | Blob;
+export default function readXlsxFile<ParsedNumber = number>(
+	input: Input,
+	options?: ReadOptions<ParsedNumber>
+): Promise<ReadFileResult<ParsedNumber>>;
 
-export function readXlsxFile<T extends object>(input: Input, options: ParseWithSchemaOptions<T>) : Promise<ParsedObjectsResult<T>>;
-export function readXlsxFile(input: Input, options?: ParseWithoutSchemaOptions) : Promise<Row[]>;
+export function readSheet<ParsedNumber = number>(
+	input: Input,
+	sheet?: number | string,
+	options?: ReadOptions<ParsedNumber>
+): Promise<SheetData<ParsedNumber>>;
 
-export function readSheetNames(input: Input) : Promise<string[]>;
+export function readSheet<ParsedNumber = number>(
+	input: Input,
+	options?: ReadOptions<ParsedNumber>
+): Promise<SheetData<ParsedNumber>>;
 
-export default readXlsxFile;
+export function parseData<
+	Object extends object,
+	ColumnTitle extends string
+>(
+	data: SheetData,
+	schema: Schema<Object, ColumnTitle>,
+	options?: ParseDataOptions
+): ParseDataResult<Object>;

package/node/index.js

@@ -1,6 +1,8 @@
 export { default as default } from '../modules/export/readXlsxFileNode.js'
-export { default as readSheetNames } from '../modules/export/readSheetNamesNode.js'
-export { default as parseExcelDate } from '../modules/xlsx/parseDate.js'
-export { default as Integer } from '../modules/types/Integer.js'
-export { default as Email } from '../modules/types/Email.js'
-export { default as URL } from '../modules/types/URL.js'
+export { default as readSheet } from '../modules/export/readSheetNode.js'
+
+// `parseData()`
+export { default as parseData } from '../modules/parseData/parseData.js'
+export { default as Integer } from '../modules/parseData/types/additional/Integer.js'
+export { default as Email } from '../modules/parseData/types/additional/Email.js'
+export { default as URL } from '../modules/parseData/types/additional/URL.js'

package/node/input.d.ts

@@ -0,0 +1,5 @@
+import { Stream } from 'stream';
+import { Blob } from 'buffer';
+
+// FYI: `Buffer` is also an `ArrayBuffer`.
+export type Input = string | Stream | Blob | Buffer;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "read-excel-file",
-  "version": "7.0.3",
+  "version": "8.0.0",
   "description": "Read `.xlsx` files in a web browser or in Node.js",
   "type": "module",
   "exports": {

package/rollup.config.mjs

@@ -22,7 +22,7 @@ export default [
     ],
     output: {
       format: 'umd',
-      name: 'readXlsxFile',
+      name: 'readExcelFile',
       file: 'bundle/read-excel-file.min.js',
       sourcemap: true,
       globals: {

package/types/parseData/parseData.d.ts

@@ -0,0 +1,38 @@
+import { ParseDataPossibleError } from './parseDataError.d.js'
+import { ParseDataValueCustomType } from './parseDataValueType.d.js'
+
+export type ParseDataResult<
+	Object,
+	ParseDataValueCustomType_ extends ParseDataValueCustomType<unknown> = never
+> = ParseDataResultItem<
+	Object,
+	ParseDataValueCustomType_
+>[]
+
+type ParseDataResultItem<
+	Object,
+	ParseDataValueCustomType_ extends ParseDataValueCustomType<unknown> = never
+> =
+	| ParseDataResultItemSuccess<Object>
+	| ParseDataResultItemError<ParseDataValueCustomType_>
+
+interface ParseDataResultItemSuccess<Object> {
+	object: Object;
+	errors: undefined;
+}
+
+interface ParseDataResultItemError<
+	ParseDataValueCustomType_ extends ParseDataValueCustomType<unknown> = never
+> {
+	object: undefined;
+	errors: ParseDataPossibleError<ParseDataValueCustomType_>[];
+}
+
+export interface ParseDataOptions {
+	propertyValueWhenColumnIsMissing?: any;
+	propertyValueWhenCellIsEmpty?: any;
+	transformEmptyArray?(arrayPropertyValue: never[], parameters: { path: string }): any;
+	transformEmptyObject?(object: Record<string, undefined | null>, parameters: { path?: string }): any;
+	// shouldSkipRequiredValidationWhenColumnIsMissing?(columnTitle: string, parameters: { object: Record<string, any> }): boolean;
+	arrayValueSeparator?: string;
+}

package/types/parseData/parseDataError.d.ts

@@ -0,0 +1,239 @@
+import { CellValue } from '../types.d.js'
+
+import {
+	Constructor,
+	ParseDataValueCustomType,
+	ParseDataValueType,
+	Integer,
+	Email,
+	URL
+} from './parseDataValueType.d.js'
+
+// When `error` is `"required"`, `value` could only be `null` or `undefined`.
+export interface ParseDataValueRequiredError<
+	ParseDataValueType = unknown,
+	ColumnTitle = string
+> {
+	// row: number;
+	column: ColumnTitle;
+	type?: ParseDataValueType;
+	error: 'required';
+	reason: undefined;
+	value: null | undefined;
+}
+
+// When `error` is not `"required"`, `value` is known to not be `null` or `undefined`
+// because when `value` is `null` or `undefined`, it won't be parsed at all,
+// so there can't be any error thrown during parsing phase.
+interface ParseDataError_<
+	ParseDataValueType extends ParseDataValueCustomType<unknown> | undefined = ParseDataValueCustomType<unknown>,
+	ColumnTitle = string,
+	ErrorMessage extends string = string,
+	ErrorReason extends string | undefined = string | undefined
+> {
+	// row: number;
+	column: ColumnTitle;
+	type: ParseDataValueType;
+	error: ErrorMessage;
+	reason: ErrorReason;
+	value: CellValue;
+}
+
+export interface ParseDataError<
+	ParseDataValueType extends ParseDataValueCustomType<unknown> = ParseDataValueCustomType<unknown>,
+	ColumnTitle = string,
+	ErrorMessage extends string = string,
+	ErrorReason extends string | undefined = string | undefined
+> extends ParseDataError_<
+	ParseDataValueType,
+	ColumnTitle,
+	ErrorMessage,
+	ErrorReason
+> {}
+
+interface ParseDataErrorNotABoolean<ColumnTitle = string> extends ParseDataError_<
+	Constructor<Boolean>,
+	ColumnTitle,
+	'not_a_boolean',
+	undefined
+> {
+	value: Exclude<CellValue, boolean>;
+}
+
+interface ParseDataErrorNotADate<ColumnTitle = string> extends ParseDataError_<
+	Constructor<Date>,
+	ColumnTitle,
+	'not_a_date',
+	undefined
+> {
+	value: Exclude<CellValue, typeof Date | number>;
+}
+
+interface ParseDataErrorDateOutOfBounds<ColumnTitle = string> extends ParseDataError_<
+	Constructor<Date>,
+	ColumnTitle,
+	'out_of_bounds',
+	undefined
+> {
+	value: typeof Date;
+}
+
+interface ParseDataErrorNotAString<ColumnTitle = string> extends ParseDataError_<
+	Constructor<String> | undefined,
+	ColumnTitle,
+	'not_a_string',
+	undefined
+> {
+	value: Exclude<CellValue, string | number>;
+}
+
+interface ParseDataErrorStringInvalidNumber<ColumnTitle = string> extends ParseDataError_<
+	Constructor<String> | undefined,
+	ColumnTitle,
+	'invalid_number',
+	undefined
+> {
+	value: number;
+}
+
+interface ParseDataErrorStringNumberOutOfBounds<ColumnTitle = string> extends ParseDataError_<
+	Constructor<String> | undefined,
+	ColumnTitle,
+	'out_of_bounds',
+	undefined
+> {
+	value: number;
+}
+
+interface ParseDataErrorNotANumber<
+	Type extends ParseDataValueCustomType<unknown> | undefined = Constructor<Number>,
+	ColumnTitle = string
+> extends ParseDataError_<
+	Type,
+	ColumnTitle,
+	'not_a_number',
+	undefined
+> {
+	value: Exclude<CellValue, number | string>;
+}
+
+interface ParseDataErrorNotANumberString<
+	Type extends ParseDataValueCustomType<unknown> | undefined = Constructor<Number>,
+	ColumnTitle = string
+> extends ParseDataError_<
+	Type,
+	ColumnTitle,
+	'not_a_number',
+	undefined
+> {
+	value: string;
+}
+
+interface ParseDataErrorNumberInvalid<
+	Type extends ParseDataValueCustomType<unknown> | undefined = Constructor<Number>,
+	ColumnTitle = string
+> extends ParseDataError_<
+	Type,
+	ColumnTitle,
+	'invalid_number',
+	undefined
+> {
+	value: number | string;
+}
+
+interface ParseDataErrorNumberOutOfBounds<
+	Type extends ParseDataValueCustomType<unknown> | undefined = Constructor<Number>,
+	ColumnTitle = string
+> extends ParseDataError_<
+	Type,
+	ColumnTitle,
+	'out_of_bounds',
+	undefined
+> {
+	value: number | string;
+}
+
+type ParseDataBaseValueTypeError<ColumnTitle = string> =
+	| ParseDataErrorNotABoolean<ColumnTitle>
+	| ParseDataErrorNotADate<ColumnTitle>
+	| ParseDataErrorDateOutOfBounds<ColumnTitle>
+	| ParseDataErrorNotAString<ColumnTitle>
+	| ParseDataErrorStringInvalidNumber<ColumnTitle>
+	| ParseDataErrorStringNumberOutOfBounds<ColumnTitle>
+	| ParseDataErrorNotANumber<Constructor<Number>, ColumnTitle>
+	| ParseDataErrorNotANumberString<Constructor<Number>, ColumnTitle>
+	| ParseDataErrorNumberInvalid<Constructor<Number>, ColumnTitle>
+	| ParseDataErrorNumberOutOfBounds<Constructor<Number>, ColumnTitle>;
+
+interface ParseDataErrorNotAnInteger<ColumnTitle = string> extends ParseDataError_<
+	typeof Integer,
+	ColumnTitle,
+	'not_an_integer',
+	undefined
+> {
+	value: number | string;
+}
+
+interface ParseDataErrorIntegerNotANumber<ColumnTitle = string> extends ParseDataErrorNotANumber<typeof Integer, ColumnTitle> {}
+interface ParseDataErrorIntegerNotANumberString<ColumnTitle = string> extends ParseDataErrorNotANumberString<typeof Integer, ColumnTitle> {}
+interface ParseDataErrorIntegerNumberInvalid<ColumnTitle = string> extends ParseDataErrorNumberInvalid<typeof Integer, ColumnTitle> {}
+interface ParseDataErrorIntegerNumberOutOfBounds<ColumnTitle = string> extends ParseDataErrorNumberOutOfBounds<typeof Integer, ColumnTitle> {}
+
+interface ParseDataErrorNotAUrl<ColumnTitle = string> extends ParseDataError_<
+	typeof URL,
+	ColumnTitle,
+	'not_a_url',
+	undefined
+> {
+	value: string;
+}
+
+interface ParseDataErrorUrlNotAString<ColumnTitle = string> extends ParseDataError_<
+	typeof URL,
+	ColumnTitle,
+	'not_a_string',
+	undefined
+> {
+	value: Exclude<CellValue, string>;
+}
+
+interface ParseDataErrorNotAnEmail<ColumnTitle = string> extends ParseDataError_<
+	typeof Email,
+	ColumnTitle,
+	'not_an_email',
+	undefined
+> {
+	value: string;
+}
+
+interface ParseDataErrorEmailNotAString<ColumnTitle = string> extends ParseDataError_<
+	typeof Email,
+	ColumnTitle,
+	'not_a_string',
+	undefined
+> {
+	value: Exclude<CellValue, string>;
+}
+
+type ParseDataAdditionalBuiltInValueTypeError<ColumnTitle = string> =
+	| ParseDataErrorNotAnInteger<ColumnTitle>
+	| ParseDataErrorIntegerNotANumber<ColumnTitle>
+	| ParseDataErrorIntegerNotANumberString<ColumnTitle>
+	| ParseDataErrorIntegerNumberInvalid<ColumnTitle>
+	| ParseDataErrorIntegerNumberOutOfBounds<ColumnTitle>
+	| ParseDataErrorNotAUrl<ColumnTitle>
+	| ParseDataErrorUrlNotAString<ColumnTitle>
+	| ParseDataErrorNotAnEmail<ColumnTitle>
+	| ParseDataErrorEmailNotAString<ColumnTitle>;
+
+type ParseDataBuiltInValueTypeError<ColumnTitle = string> =
+	| ParseDataBaseValueTypeError<ColumnTitle>
+	| ParseDataAdditionalBuiltInValueTypeError<ColumnTitle>;
+
+export type ParseDataPossibleError<
+	ParseDataValueCustomType_ extends ParseDataValueCustomType<unknown>,
+	ColumnTitle = string
+> =
+	| ParseDataBuiltInValueTypeError<ColumnTitle>
+	| ParseDataValueRequiredError<ParseDataValueType<ParseDataValueCustomType_>, ColumnTitle>
+	| ParseDataError<ParseDataValueType<ParseDataValueCustomType_>, ColumnTitle>;

package/types/parseData/parseDataSchema.d.ts

@@ -0,0 +1,48 @@
+import { ParseDataValueType, ParseDataValueCustomType } from './parseDataValueType.js'
+
+type SchemaEntryRequiredOrNot<Object> = boolean | ((row: Object) => boolean);
+
+interface SchemaEntryForValue<
+	Key extends keyof Object,
+	Object,
+	TopLevelObject,
+	ColumnTitle extends string
+> {
+	column: ColumnTitle;
+	type?: ParseDataValueType<ParseDataValueCustomType<Object[Key]>>;
+	oneOf?: Object[Key][];
+	required?: SchemaEntryRequiredOrNot<TopLevelObject>;
+	validate?(value: Object[Key]): void;
+}
+
+// Implementing recursive types in TypeScript:
+// https://dev.to/busypeoples/notes-on-typescript-recursive-types-and-immutability-5ck1
+interface SchemaEntryRecursive<
+	Key extends keyof Object,
+	Object,
+	TopLevelObject,
+	ColumnTitle extends string
+> {
+	schema: Record<
+		keyof Object[Key],
+		SchemaEntry<keyof Object[Key], Object[Key], TopLevelObject, ColumnTitle>
+	>;
+	required?: SchemaEntryRequiredOrNot<TopLevelObject>;
+}
+
+type SchemaEntry<
+	Key extends keyof Object,
+	Object,
+	TopLevelObject,
+	ColumnTitle extends string
+> =
+	| SchemaEntryForValue<Key, Object, TopLevelObject, ColumnTitle>
+	| SchemaEntryRecursive<Key, Object, TopLevelObject, ColumnTitle>;
+
+export type Schema<
+	Object = Record<string, any>,
+	ColumnTitle extends string = string
+> = Record<
+	keyof Object,
+	SchemaEntry<keyof Object, Object, Object, ColumnTitle>
+>

package/types/parseData/parseDataValueType.d.ts

@@ -0,0 +1,45 @@
+import { CellValue } from '../types.d.js';
+
+// A way to define a `type = String` or `type = Number` variable in TypeScript
+// is by defining it as `type: StringConstructor` or `type: NumberConstructor`.
+// https://gitlab.com/catamphetamine/write-excel-file/-/issues/4#note_715204034
+// https://www.typescriptlang.org/docs/handbook/2/conditional-types.html
+export type Constructor<Type> =
+	Type extends String
+		? StringConstructor
+		: Type extends Date
+			? DateConstructor
+			: Type extends Number
+				? NumberConstructor
+				: Type extends Boolean
+					? BooleanConstructor
+					: never;
+
+// Parsed value `type` (foundational ones).
+type BaseType =
+	Constructor<String> |
+	Constructor<Date> |
+	Constructor<Number> |
+	Constructor<Boolean>;
+
+// Parsed value `type` (custom one).
+// A function that receives a cell `value` and returns a "parsed" value.
+// Returning `undefined` will have same effect as returning `null`.
+// When cell value is `undefined` or `null`, its `type` is completely ignored (skipped).
+export type ParseDataValueCustomType<ParsedValue> = (value: CellValue) => ParsedValue | undefined | null;
+
+// Parsed value `type` (additional built-in ones).
+export function Integer(value: CellValue): number;
+export function URL(value: CellValue): string;
+export function Email(value: CellValue): string;
+
+type AdditionalBuiltInParseDataValueType =
+	| typeof Integer
+	| typeof URL
+	| typeof Email;
+
+// Schema entry `type`: foundational ones, additional ones, custom ones.
+export type ParseDataValueType<ParseDataValueCustomType> =
+	| BaseType
+	| AdditionalBuiltInParseDataValueType
+	| ParseDataValueCustomType;

package/types/types.d.ts

@@ -0,0 +1,20 @@
+export type CellValue<ParsedNumber = number> =
+	| string
+	| ParsedNumber
+	| boolean
+	| typeof Date
+
+export type Row<ParsedNumber = number> = (CellValue<ParsedNumber> | null)[]
+
+export type SheetData<ParsedNumber = number> = Row<ParsedNumber>[]
+
+export type ReadFileResult<ParsedNumber = number> = {
+	sheet: string;
+	data: SheetData<ParsedNumber>;
+}[]
+
+export interface ReadOptions<ParsedNumber = number> {
+	trim?: boolean;
+	parseNumber?: (string: string) => ParsedNumber;
+	dateFormat?: string;
+}

package/universal/index.cjs

@@ -1,7 +1,10 @@
 exports = module.exports = require('../commonjs/export/readXlsxFileUniversal.js').default
 exports['default'] = require('../commonjs/export/readXlsxFileUniversal.js').default
-exports.readSheetNames = require('../commonjs/export/readSheetNamesUniversal.js').default
-exports.parseExcelDate = require('../commonjs/xlsx/parseDate.js').default
-exports.Integer = require('../commonjs/types/Integer.js').default
-exports.Email = require('../commonjs/types/Email.js').default
-exports.URL = require('../commonjs/types/URL.js').default
+
+exports.readSheet = require('../commonjs/export/readSheetUniversal.js').default
+
+// `parseData()`
+exports.parseData = require('../commonjs/parseData/parseData.js').default
+exports.Integer = require('../commonjs/parseData/types/additional/Integer.js').default
+exports.Email = require('../commonjs/parseData/types/additional/Email.js').default
+exports.URL = require('../commonjs/parseData/types/additional/URL.js').default