import type { DelimiterType } from '../enums/delimiter.type.js';
import type { FileType } from '../enums/file.type.js';

export interface ExportTextDownloadOption {
  filename: string;
  content: string;
  format: FileType | string;
  mimeType: string;
  useUtf8WithBom?: boolean;
}

export interface TextExportOption {
  /** export delimiter, can be (comma, tab, ... or even custom string). */
  delimiter?: DelimiterType;

  /** Allows you to override for the export delimiter */
  delimiterOverride?: DelimiterType;

  /** Defaults to false, which leads to all Formatters of the grid being evaluated on export. You can also override a column by changing the propery on the column itself */
  exportWithFormatter?: boolean;

  /** filename (without extension) */
  filename?: string;

  /** file type format, .csv/.txt (this will provide the extension) */
  format?: Extract<FileType, 'csv' | 'txt'>;

  /** Defaults to false, should we also include hidden properties in the export? */
  includeHidden?: boolean;

  /** The column header title (at position A0 in Excel) of the Group by column. If nothing is provided it will use "Group By" (which is a translated value of GROUP_BY i18n) */
  groupingColumnHeaderTitle?: string;

  /** The default text to display in 1st column of the File Export, which will identify that the current row is a Grouping Aggregator */
  groupingAggregatorRowText?: string;

  /** Defaults to "text/plain", mime type to use when exporting the output file. */
  mimeType?: string;

  /** Defaults to false, which leads to Sanitizing all data (striping out any HTML tags) when being evaluated on export. */
  sanitizeDataExport?: boolean;

  /**
   * If you want to use UTF-8 and unicode, in most case it's better to use it with BOM.
   * This will basically add a special string  at the beginning of the file "" which will tell the application that it is UTF-8 format.
   */
  useUtf8WithBom?: boolean;
}