pdfreader/index.d.ts

Read text and parse tables from PDF files. Supports tabular data with automatic column detection, and rule-based parsing.

export type InitOptions = {
  password?: string;
  debug?: boolean;
  signal?: AbortSignal;
};
export type Error = null | string;

export type DataEntry = {
  page?: number;
  width?: number;
  height?: number;
  text?: string;
  file?: {
    path?: string;
    buffer?: string;
  };
} | null;

export type ItemHandler = (err: Error, data: DataEntry) => void;

export declare class PdfReader {
  constructor(opts?: InitOptions | null);
  parseFileItems(pdfFilePath: string, itemHandler: ItemHandler): void;
  parseBuffer(buffer: Buffer, itemHandler: ItemHandler): void;
}

export type Item = {
  x: number;
  y: number;
  sw: number;
  w: number;
  A: string;
  clr: number;
  R: {
    T: string;
    S: number;
    TS: any[];
  }[];
  text: string;
};

export type RuleAccumulator = (item: Item) => boolean | void;
export type RuleHandler<T = any> = (value: T) => void;

export interface TableResult {
  matrix: string[][];
  items: Item[];
}

export class TableParser {
  private rows: { [key: string]: Item[] };
  constructor();
  processItem(item: Item, col: number): void;
  processHeadingItem(item: Item, col: number): void;
  getRows(): Item[][];
  renderRows(): string;
  /** row-> column-> items_collisionning_in_column-> item:Item */
  getMatrix(): Item[][][];
  getCleanMatrix(options?: { collisionSeparator: string }): string[][];
  renderMatrix(): string;
}

export class Rule {
  static on(regexp: RegExp): Rule;
  static after(regexp: RegExp): Rule;
  static makeItemProcessor(rules: Rule[]): (item: DataEntry) => void;
  static addAccumulator(methodName: string, methodBuilder: Function): void;

  constructor(regexp: RegExp);

  // Accumulator methods
  extractRegexpValues(): Rule;
  parseNextItemValue(): Rule;
  accumulateAfterHeading(): Rule;
  accumulateFromSameX(): Rule;
  parseColumns(...args: any[]): Rule;
  parseTable(columnCount: number): Rule & {
    then(handler: (result: TableResult) => void): Rule;
  };

  then<T>(handler: RuleHandler<T>): Rule;

  private test(item: Item): RuleAccumulator | undefined;
  private whenDone(callback: () => void): void;
}