Table.ts

import { Row } from './Row.js';
import { TableData, RowOptionData, EmbedField, TableToFieldOptions, TableToStringOptions } from '../typings/index.js';

export class Table {
	/**
	 * An array of titles for the Table
	 */
	private readonly titles: string[];

	/**
	 * The starting indexes for each column title in the title string
	 */
	private readonly titleIndexes: number[];

	/**
	 * The starting indexes for each column of data
	 */
	private readonly columnIndexes: number[];

	/**
	 * A string to add to the start of every row
	 */
	public readonly start: string;

	/**
	 * A string to add to the end of every row
	 */
	public readonly end: string;

	/**
	 * A pad for the end of each row, before the end
	 * @see [String.prototype.padEnd()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/padEnd)
	 */
	public readonly padEnd: number;

	/**
	 * The Table's generated rows. Do not modify unless you know what you're doing.
	 */
	public readonly rows: string[];

	/**
	 * The Table's generated title string
	 */
	public readonly titleString: string;

	/**
	 * Whether or not to include the Whitespace character (\u200b) in spacing (not required if using backticks for the start and end)
	 */
	private readonly whiteSpace: boolean;

	/**
	 * Create a new Table
	 * @param {TableData} options 
	 */
	public constructor(options: TableData) {
		this.titleString = '';
		this.titles = options.titles;
		this.titleIndexes = options.titleIndexes;
		this.rows = [];
		this.columnIndexes = options.columnIndexes;
		this.start = options.start ?? '';
		this.end = options.end ?? '';
		this.padEnd = options.padEnd ?? 0;
		this.whiteSpace = options.whiteSpace ?? false;

		if (this.titles.length !== this.titleIndexes.length) {
			throw new RangeError('The \'titles\' and \'titleIndex\' array must be of the same length.');
		}

		for (let i = 0; i < this.titles.length; i++) {
			this.titleString += this.padTitle(i);
		}
	}

	/**
	 * Add a row with data to the Table
	 * @param {string[]} columns 
	 * @param {RowOptionData} options
	 * @returns {this}
	 */
	public addRow(columns: string[], options?: RowOptionData): this {
		this.rows.push((options?.url ? '[' : '') +
			this.start + new Row({
				columns,
				indexes: this.columnIndexes,
				whiteSpace: this.whiteSpace
			})
				.toString()
				.padEnd(this.columnIndexes[this.columnIndexes.length - 1]! + (options?.override ?? 0 + this.padEnd), ' ') + this.end + (options?.url ? `](${options?.url})` : '')
		);

		return this;
	}

	/**
	 * Convert the Table to an EmbedField object
	 * @param {TableToFieldOptions} options Whether or not the field is inline
	 * @returns {EmbedField} Use this when creating a MessageEmbed
	 */
	public toField(options?: TableToFieldOptions): EmbedField {
		const field: EmbedField = {
			name: this.titleString,
			value: this.rows.join('\n'),
			inline: options?.inline ?? false
		};

		if (!options?.keepRows) this.clear();

		return field;
	}

	/**
	 * Convert the Table to a nice string
	 * @param {TableToStringOptions} options 
	 * @returns 
	 */
	public toString(options?: TableToStringOptions): string {
		const string = this.titleString + '\n' + this.rows.join('\n');

		if (!options?.keepRows) this.clear();

		return string;
	}

	/**
	 * Clear the rows out of the Table
	 * @returns {void}
	 */
	private clear(): void {
		this.rows.length = 0;
	}

	/**
	 * Adds the spacing to the titles in the title string
	 * @param {number} i 
	 * @returns {string} The padded title
	 */
	private padTitle(i: number): string {
		if (!this.checkTitles()) {
			throw new RangeError('Length of a \'title\' cannot be longer than the starting index of the next title. Try increasing the value of the subsequent \'titleIndex\'.');
		}

		return ' '.repeat(this.titleIndexes[i]! - (this.titleIndexes[i - 1] ?? 0) - (this.titles[i - 1]?.length ?? 0)) + this.titles[i]!.slice(0, (this.titleIndexes[i + 1] ?? Infinity) - this.titleIndexes[i]! - 1);
	}

	/**
	 * Checks if the title texts are greater than the indexes provided
	 * Returns true if less than, false if greater than.
	 * @returns {boolean}
	 */
	private checkTitles(): boolean {
		for (let i = 0; i < this.titles.length - 1; i++) {
			if (this.titles[i]!.length > this.titleIndexes[i + 1]!) return false;
		}

		return true;
	}
}