123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363
import { Border, border } from "./border.ts";import { Cell, Direction } from "./cell.ts";import { Column, ColumnOptions } from "./column.ts";import { TableLayout } from "./_layout.ts";import { DataRow, Row, RowType } from "./row.ts";
/** Border characters settings. */export type BorderOptions = Partial<Border>;
/** Table settings. */export interface TableSettings {  /** Table indentation. */  indent: number;  /** Enable/disable border on all cells. */  border: boolean;  /** Set min column width. */  minColWidth: number | Array<number>;  /** Set max column width. */  maxColWidth: number | Array<number>;  /** Set cell padding. */  padding: number | Array<number>;  /** Set table characters. */  chars: Border;  /** Set cell content alignment. */  align?: Direction;  /** Set column options. */  columns: Array<Column>;}
/** Table type. */export type TableType<TRow extends RowType = RowType> =  | Array<TRow>  | Table<TRow>;
/** * Table representation. * * ```ts * import { Row, Table } from "./mod.ts"; * * new Table() *   .header(new Row("Name", "Date", "City", "Country").border()) *   .body([ *     ["Baxter Herman", "Oct 1, 2020", "Harderwijk", "Slovenia"], *     ["Jescie Wolfe", "Dec 4, 2020", "Alto Hospicio", "Japan"], *     ["Allegra Cleveland", "Apr 16, 2020", "Avernas-le-Bauduin", "Samoa"], *     ["Aretha Gamble", "Feb 22, 2021", "Honolulu", "Georgia"], *   ]) *   .render(); * ``` */export class Table<TRow extends RowType = RowType> extends Array<TRow> {  protected static _chars: Border = { ...border };  protected options: TableSettings = {    indent: 0,    border: false,    maxColWidth: Infinity,    minColWidth: 0,    padding: 1,    chars: { ...Table._chars },    columns: [],  };  private headerRow?: Row;
  /**   * Create a new table. If rows is a table, all rows and options of the table   * will be copied to the new table.   *   * @param rows An array of rows or a table instance.   */  public static from<TRow extends RowType>(rows: TableType<TRow>): Table<TRow> {    const table = new this(...rows);    if (rows instanceof Table) {      table.options = { ...(rows as Table).options };      table.headerRow = rows.headerRow ? Row.from(rows.headerRow) : undefined;    }    return table;  }
  /**   * Create a new table from an array of json objects. An object represents a   * row and each property a column.   *   * @param rows Array of objects.   */  public static fromJson(rows: Array<DataRow>): Table {    return new this().fromJson(rows);  }
  /**   * Set global default border characters.   *   * @param chars Border options.   */  public static chars(chars: BorderOptions): typeof Table {    Object.assign(this._chars, chars);    return this;  }
  /**   * Write table or rows to stdout.   *   * @param rows Table or rows.   */  public static render<TRow extends RowType>(rows: TableType<TRow>): void {    Table.from(rows).render();  }
  /**   * Read data from an array of json objects. An object represents a   * row and each property a column.   *   * @param rows Array of objects.   */  public fromJson(rows: Array<DataRow>): this {    this.header(Object.keys(rows[0]));    this.body(rows.map((row) => Object.values(row) as TRow));    return this;  }
  /**   * Set column options.   *   * @param columns An array of columns or column options.   */  public columns(columns: Array<Column | ColumnOptions>): this {    this.options.columns = columns.map((column) =>      column instanceof Column ? column : Column.from(column)    );    return this;  }
  /**   * Set column options by index.   *   @param index   The column index.   @param column  Column or column options.   */  public column(    index: number,    column: Column | ColumnOptions,  ): this {    if (column instanceof Column) {      this.options.columns[index] = column;    } else if (this.options.columns[index]) {      this.options.columns[index].options(column);    } else {      this.options.columns[index] = Column.from(column);    }    return this;  }
  /**   * Set table header.   *   * @param header Header row or cells.   */  public header(header: RowType): this {    this.headerRow = header instanceof Row ? header : Row.from(header);    return this;  }
  /**   * Set table body.   *   * @param rows Array of rows.   */  public body(rows: Array<TRow>): this {    this.length = 0;    this.push(...rows);    return this;  }
  /** Clone table recursively with header and options. */  public clone(): Table {    const table = new Table(      ...this.map((row: TRow) =>        row instanceof Row ? row.clone() : Row.from(row).clone()      ),    );    table.options = { ...this.options };    table.headerRow = this.headerRow?.clone();    return table;  }
  /** Generate table string. */  public toString(): string {    return new TableLayout(this, this.options).toString();  }
  /** Write table to stdout. */  public render(): this {    console.log(this.toString());    return this;  }
  /**   * Set max column width.   *   * @param width     Max column width.   * @param override  Override existing value.   */  public maxColWidth(width: number | Array<number>, override = true): this {    if (override || typeof this.options.maxColWidth === "undefined") {      this.options.maxColWidth = width;    }    return this;  }
  /**   * Set min column width.   *   * @param width     Min column width.   * @param override  Override existing value.   */  public minColWidth(width: number | Array<number>, override = true): this {    if (override || typeof this.options.minColWidth === "undefined") {      this.options.minColWidth = width;    }    return this;  }
  /**   * Set table indentation.   *   * @param width     Indent width.   * @param override  Override existing value.   */  public indent(width: number, override = true): this {    if (override || typeof this.options.indent === "undefined") {      this.options.indent = width;    }    return this;  }
  /**   * Set cell padding.   *   * @param padding   Cell padding.   * @param override  Override existing value.   */  public padding(padding: number | Array<number>, override = true): this {    if (override || typeof this.options.padding === "undefined") {      this.options.padding = padding;    }    return this;  }
  /**   * Enable/disable cell border.   *   * @param enable    Enable/disable cell border.   * @param override  Override existing value.   */  public border(enable = true, override = true): this {    if (override || typeof this.options.border === "undefined") {      this.options.border = enable;    }    return this;  }
  /**   * Align table content.   *   * @param direction Align direction.   * @param override  Override existing value.   */  public align(direction: Direction, override = true): this {    if (override || typeof this.options.align === "undefined") {      this.options.align = direction;    }    return this;  }
  /**   * Set border characters.   *   * @param chars Border options.   */  public chars(chars: BorderOptions): this {    Object.assign(this.options.chars, chars);    return this;  }
  /** Get table header. */  public getHeader(): Row | undefined {    return this.headerRow;  }
  /** Get table body. */  public getBody(): Array<TRow> {    return [...this];  }
  /** Get max column width. */  public getMaxColWidth(): number | Array<number> {    return this.options.maxColWidth;  }
  /** Get min column width. */  public getMinColWidth(): number | Array<number> {    return this.options.minColWidth;  }
  /** Get table indentation. */  public getIndent(): number {    return this.options.indent;  }
  /** Get cell padding. */  public getPadding(): number | Array<number> {    return this.options.padding;  }
  /** Check if table has border. */  public getBorder(): boolean {    return this.options.border === true;  }
  /** Check if header row has border. */  public hasHeaderBorder(): boolean {    const hasBorder = this.headerRow?.hasBorder();    return hasBorder === true || (this.getBorder() && hasBorder !== false);  }
  /** Check if table bordy has border. */  public hasBodyBorder(): boolean {    return this.getBorder() ||      this.options.columns.some((column) => column.getBorder()) ||      this.some((row) =>        row instanceof Row          ? row.hasBorder()          : row.some((cell) => cell instanceof Cell ? cell.getBorder() : false)      );  }
  /** Check if table header or body has border. */  public hasBorder(): boolean {    return this.hasHeaderBorder() || this.hasBodyBorder();  }
  /** Get table alignment. */  public getAlign(): Direction {    return this.options.align ?? "left";  }
  /** Get columns. */  public getColumns(): Array<Column> {    return this.options.columns;  }
  /** Get column by column index. */  public getColumn(index: number): Column {    return this.options.columns[index] ??= new Column();  }}
/** @deprecated Use `BorderOptions` instead. */export type IBorderOptions = BorderOptions;
/** @deprecated Use `TableType` instead. */export type ITable = TableType;