@ply-ct/ply/src/read-excel-file.d.ts

REST API Automated Testing

declare module 'read-excel-file/node' {
    export function Integer(): void;
    export function URL(): void;
    export function Email(): void;

    type BasicType = string | number | boolean | typeof Date | typeof Integer | URL | typeof Email;

    export type Type = <T>(value: Cell) => T;

    interface SchemaEntryBasic {
        prop: string;
        type?: BasicType | Type;
        oneOf?<T>(): T[];
        required?: boolean;
        validate?<T>(value: T): void;
    }

    interface SchemaEntryParsed {
        prop: string;
        parse<T>(): (value: Cell) => T;
        oneOf?<T>(): T[];
        required?: boolean;
        validate?<T>(value: T): 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?: boolean;
    }

    type SchemaEntry = SchemaEntryBasic | SchemaEntryParsed | SchemaEntryRecursive;

    export type Schema = Record<string, SchemaEntry>;

    export interface Error {
        error: string;
        row: number;
        column: number;
        value?: any;
        type?: SchemaEntry;
    }

    type Cell = string | number | boolean | typeof Date;
    export type Row = Cell[];

    export interface ParsedObjectsResult {
        rows: object[];
        errors: Error[];
    }

    export interface ParseWithSchemaOptions {
        schema: Schema;
        transformData?: (rows: Row[]) => Row[];
        sheet?: number | string;
    }

    export interface ParseWithMapOptions {
        map: object;
        transformData?: (rows: Row[]) => Row[];
        sheet?: number | string;
    }

    export interface ParseWithoutSchemaOptions {
        sheet?: number | string;
    }

    export function readXlsxFile(
        input: any,
        options: ParseWithSchemaOptions
    ): Promise<ParsedObjectsResult>;
    export function readXlsxFile(input: any, options?: ParseWithoutSchemaOptions): Promise<Row[]>;

    export default readXlsxFile;
}