read-excel-file 5.8.0 → 5.8.2

package/index.d.ts

@@ -4,7 +4,7 @@ import {
 	ParseWithoutSchemaOptions,
 	ParsedObjectsResult,
 	Row
-} from './types.d';
+} from './types.d.js';
 
 export {
 	Schema,
@@ -13,7 +13,7 @@ export {
 	Integer,
 	Email,
 	URL
-} from './types.d';
+} from './types.d.js';
 
 export function parseExcelDate(excelSerialDate: number) : typeof Date;
 

package/map/index.d.ts

@@ -8,4 +8,4 @@ export {
 	MappingParameters
 } from '../types.d.js'
 
-export default function map(data: Row[], schema: Schema, options?: MappingParameters): object[];
+export default function map<T>(data: Row[], schema: Schema<T>, options?: MappingParameters): T[];

package/node/index.d.ts

@@ -10,7 +10,7 @@ import {
 	ParseWithoutSchemaOptions,
 	ParsedObjectsResult,
 	Row
-} from '../types.d';
+} from '../types.d.js';
 
 export {
 	ParsedObjectsResult,
@@ -18,7 +18,7 @@ export {
 	Integer,
 	Email,
 	URL
-} from '../types.d';
+} from '../types.d.js';
 
 export function parseExcelDate(excelSerialDate: number) : typeof Date;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "read-excel-file",
-  "version": "5.8.0",
+  "version": "5.8.2",
   "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",

package/schema/index.d.ts

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

package/types.d.ts

@@ -14,51 +14,55 @@ type BasicType =
 	| typeof URL
 	| typeof Email;
 
-export type Type<T> = (value: Cell) => T | undefined;
+// A cell "type" is a function that receives a "raw" value and returns a "parsed" value or `undefined`.
+export type Type<Value> = (value: Cell) => Value | undefined;
 
-type SchemaEntryRequired = boolean | ((row: Row) => boolean);
+type SchemaEntryRequiredProperty<Object> = boolean | ((row: Object) => boolean);
 
-interface SchemaEntryBasic<T> {
-	prop: string;
-	type?: BasicType | Type<T>;
-	oneOf?: T[];
-	required?: SchemaEntryRequired;
-	validate?(value: T): void;
+interface SchemaEntryForValue<Key extends keyof Object, Object, TopLevelObject> {
+	prop: Key;
+	type?: BasicType | Type<Object[Key]>;
+	oneOf?: Object[Key][];
+	required?: SchemaEntryRequiredProperty<TopLevelObject>;
+	validate?(value: Object[Key]): void;
 }
 
 // Legacy versions of this library supported supplying a custom `parse()` function.
 // Since then, the `parse()` function has been renamed to `type()` function.
-interface SchemaEntryParsed<T> {
-	prop: string;
-	parse: (value: Cell) => T | undefined;
-	oneOf?: T[];
-	required?: SchemaEntryRequired;
-	validate?(value: T): void;
+interface SchemaEntryForValueLegacy<Key extends keyof Object, Object, TopLevelObject> {
+	prop: Key;
+	parse: (value: Cell) => Object[Key] | undefined;
+	oneOf?: Object[Key][];
+	required?: SchemaEntryRequiredProperty<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 {
-	prop: string;
-	type: Record<string, SchemaEntry>;
-	required?: SchemaEntryRequired;
+interface SchemaEntryRecursive<Key extends keyof Object, Object, TopLevelObject> {
+	prop: Key;
+	type: Record<keyof Object[Key], SchemaEntry<keyof Object[Key], Object[Key], TopLevelObject>>;
+	required?: SchemaEntryRequiredProperty<TopLevelObject>;
 }
 
-type SchemaEntry = SchemaEntryBasic<any> | SchemaEntryParsed<any> | SchemaEntryRecursive
+type SchemaEntry<Key extends keyof Object, Object, TopLevelObject> =
+	SchemaEntryForValue<Key, Object, TopLevelObject> |
+	SchemaEntryForValueLegacy<Key, Object, TopLevelObject> |
+	SchemaEntryRecursive<Key, Object, TopLevelObject>
 
-export type Schema = Record<string, SchemaEntry>
+export type Schema<Object = Record<string, any>> = Record<keyof Object, SchemaEntry<keyof Object, Object, Object>>
 
-export interface Error {
+export interface Error<Value = any> {
 	error: string;
 	reason?: string;
 	row: number;
 	column: string;
-	value?: any;
-	type?: SchemaEntry;
+	value?: Value;
+	type?: Type<Value>;
 }
 
-export interface ParsedObjectsResult<T extends object> {
-	rows: T[];
+export interface ParsedObjectsResult<Object> {
+	rows: Object[];
 	errors: Error[];
 }
 
@@ -68,8 +72,8 @@ interface ParseCommonOptions {
 	parseNumber?: (string: string) => any;
 }
 
-export interface ParseWithSchemaOptions<T extends object> extends ParseCommonOptions, MappingParametersReadExcelFile {
-	schema: Schema;
+export interface ParseWithSchemaOptions<Object> extends ParseCommonOptions, MappingParametersReadExcelFile {
+	schema: Schema<Object>;
 	transformData?: (rows: Row[]) => Row[];
 	ignoreEmptyRows?: boolean;
 	// `includeNullValues: true` parameter is deprecated.

package/web-worker/index.d.ts

@@ -4,7 +4,7 @@ import {
 	ParseWithoutSchemaOptions,
 	ParsedObjectsResult,
 	Row
-} from '../types.d';
+} from '../types.d.js';
 
 export {
 	ParsedObjectsResult,
@@ -12,7 +12,7 @@ export {
 	Integer,
 	Email,
 	URL
-} from '../types.d';
+} from '../types.d.js';
 
 export function parseExcelDate(excelSerialDate: number) : typeof Date;