@ifto/mantine-kit 0.0.0-stage → 0.2.0

package/dist/export/xlsx/XlsxFormat.js

@@ -0,0 +1,66 @@
+"use client";
+import { exportMessages } from "../ExportTexts.js";
+import { XlsxSheetWriter } from "./XlsxSheetWriter.js";
+import { xlsxSheetNames } from "./XlsxSheetName.js";
+import { xlsxStyles } from "./XlsxStyle.js";
+// src/export/xlsx/XlsxFormat.ts
+/**
+* Exports to Excel (`.xlsx`) with [ExcelJS](https://github.com/exceljs/exceljs): a sheet in the file for each sheet
+* of the document, with styles, the logo and the numbers in a numeric format (not text).
+*
+* ExcelJS is loaded on demand (dynamic `import()`), like ECharts: imported statically, it would be in the bundle of
+* every page that can export, even if the user exports nothing.
+* @author Manoel Campos
+*/
+var XlsxFormat = class {
+	id = "xlsx";
+	label = "Excel (.xlsx)";
+	extension = "xlsx";
+	mimeType = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
+	multipleSheets = true;
+	styles;
+	/** @param options options of the format, such as the colors of the file */
+	constructor(options = {}) {
+		this.styles = xlsxStyles(options.colors);
+	}
+	async generate(document) {
+		const buffer = await (await this.buildWorkbook(document)).xlsx.writeBuffer();
+		return new Blob([buffer], { type: this.mimeType });
+	}
+	/**
+	* Builds the workbook with a sheet for each sheet of the document.
+	* @param document data to export
+	* @return the workbook ready to be written
+	* @throws Error if the document has no sheets
+	*/
+	async buildWorkbook(document) {
+		if (document.sheets.length === 0) throw new Error("There is no data to export.");
+		const workbook = new (await (loadExcelJs())).Workbook();
+		workbook.creator = document.branding.systemName;
+		workbook.title = document.title;
+		workbook.created = document.generatedAt;
+		const logo = document.branding.logo;
+		const logoImageId = logo ? workbook.addImage({
+			base64: logo.pngDataUrl,
+			extension: "png"
+		}) : void 0;
+		const defaultName = exportMessages(document).defaultSheetName;
+		const names = xlsxSheetNames(document.sheets.map((sheet) => sheet.name), defaultName);
+		document.sheets.forEach((sheet, i) => {
+			new XlsxSheetWriter(workbook.addWorksheet(names[i]), document, this.styles).write(sheet, logoImageId);
+		});
+		return workbook;
+	}
+};
+/**
+* Loads ExcelJS. Being a CommonJS module, depending on the bundler the classes come in the module itself or in
+* `default`.
+* @return the ExcelJS module
+*/
+async function loadExcelJs() {
+	const excelJs = await import("exceljs");
+	return excelJs.default ?? excelJs;
+}
+export { XlsxFormat };
+
+//# sourceMappingURL=XlsxFormat.js.map

package/dist/export/xlsx/XlsxFormat.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"XlsxFormat.js","names":[],"sources":["../../../src/export/xlsx/XlsxFormat.ts"],"sourcesContent":["import type { Workbook } from 'exceljs';\n\nimport { ExportDocument } from '../ExportDocument';\nimport { ExportFormat } from '../ExportFormat';\nimport { exportMessages } from '../ExportTexts';\nimport { XlsxSheetWriter } from './XlsxSheetWriter';\nimport { xlsxSheetNames } from './XlsxSheetName';\nimport { XlsxColors, xlsxStyles, XlsxStyles } from './XlsxStyle';\n\ntype ExcelJsModule = typeof import('exceljs');\n\n/** Options of an {@link XlsxFormat}. */\nexport type XlsxFormatOptions = {\n    /** Colors of the file (e.g. the brand colors of the app); the ones not given use the defaults. */\n    colors?: Partial<XlsxColors>;\n};\n\n/**\n * Exports to Excel (`.xlsx`) with [ExcelJS](https://github.com/exceljs/exceljs): a sheet in the file for each sheet\n * of the document, with styles, the logo and the numbers in a numeric format (not text).\n *\n * ExcelJS is loaded on demand (dynamic `import()`), like ECharts: imported statically, it would be in the bundle of\n * every page that can export, even if the user exports nothing.\n * @author Manoel Campos\n */\nexport class XlsxFormat implements ExportFormat {\n    readonly id = 'xlsx';\n    readonly label = 'Excel (.xlsx)';\n    readonly extension = 'xlsx';\n    readonly mimeType = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet';\n    readonly multipleSheets = true;\n\n    private readonly styles: XlsxStyles;\n\n    /** @param options options of the format, such as the colors of the file */\n    constructor(options: XlsxFormatOptions = {}) {\n        this.styles = xlsxStyles(options.colors);\n    }\n\n    async generate(document: ExportDocument): Promise<Blob> {\n        const workbook = await this.buildWorkbook(document);\n        const buffer = await workbook.xlsx.writeBuffer();\n\n        return new Blob([buffer], { type: this.mimeType });\n    }\n\n    /**\n     * Builds the workbook with a sheet for each sheet of the document.\n     * @param document data to export\n     * @return the workbook ready to be written\n     * @throws Error if the document has no sheets\n     */\n    async buildWorkbook(document: ExportDocument): Promise<Workbook> {\n        // Excel does not open a file without any sheet.\n        if (document.sheets.length === 0) throw new Error('There is no data to export.');\n\n        const excelJs = await loadExcelJs();\n        const workbook = new excelJs.Workbook();\n        workbook.creator = document.branding.systemName;\n        workbook.title = document.title;\n        workbook.created = document.generatedAt;\n\n        const logo = document.branding.logo;\n        const logoImageId = logo ? workbook.addImage({ base64: logo.pngDataUrl, extension: 'png' }) : undefined;\n        const defaultName = exportMessages(document).defaultSheetName;\n        const names = xlsxSheetNames(\n            document.sheets.map(sheet => sheet.name),\n            defaultName\n        );\n        document.sheets.forEach((sheet, i) => {\n            new XlsxSheetWriter(workbook.addWorksheet(names[i]), document, this.styles).write(sheet, logoImageId);\n        });\n\n        return workbook;\n    }\n}\n\n/**\n * Loads ExcelJS. Being a CommonJS module, depending on the bundler the classes come in the module itself or in\n * `default`.\n * @return the ExcelJS module\n */\nasync function loadExcelJs(): Promise<ExcelJsModule> {\n    const excelJs: ExcelJsModule & { default?: ExcelJsModule } = await import('exceljs');\n\n    return excelJs.default ?? excelJs;\n}\n"],"mappings":";;;;;;;;;;;;;;AAyBA,IAAa,aAAb,MAAgD;CAC5C,KAAc;CACd,QAAiB;CACjB,YAAqB;CACrB,WAAoB;CACpB,iBAA0B;CAE1B;;CAGA,YAAY,UAA6B,CAAC,GAAG;EACzC,KAAK,SAAS,WAAW,QAAQ,MAAM;CAC3C;CAEA,MAAM,SAAS,UAAyC;EAEpD,MAAM,SAAS,OAAM,MADE,KAAK,cAAc,QAAQ,EAAA,CACpB,KAAK,YAAY;EAE/C,OAAO,IAAI,KAAK,CAAC,MAAM,GAAG,EAAE,MAAM,KAAK,SAAS,CAAC;CACrD;;;;;;;CAQA,MAAM,cAAc,UAA6C;EAE7D,IAAI,SAAS,OAAO,WAAW,GAAG,MAAM,IAAI,MAAM,6BAA6B;EAG/E,MAAM,WAAW,KAAI,OADC,YAAY,GAAA,CACL,SAAS;EACtC,SAAS,UAAU,SAAS,SAAS;EACrC,SAAS,QAAQ,SAAS;EAC1B,SAAS,UAAU,SAAS;EAE5B,MAAM,OAAO,SAAS,SAAS;EAC/B,MAAM,cAAc,OAAO,SAAS,SAAS;GAAE,QAAQ,KAAK;GAAY,WAAW;EAAM,CAAC,IAAI,KAAA;EAC9F,MAAM,cAAc,eAAe,QAAQ,CAAC,CAAC;EAC7C,MAAM,QAAQ,eACV,SAAS,OAAO,KAAI,UAAS,MAAM,IAAI,GACvC,WACJ;EACA,SAAS,OAAO,SAAS,OAAO,MAAM;GAClC,IAAI,gBAAgB,SAAS,aAAa,MAAM,EAAE,GAAG,UAAU,KAAK,MAAM,CAAC,CAAC,MAAM,OAAO,WAAW;EACxG,CAAC;EAED,OAAO;CACX;AACJ;;;;;;AAOA,eAAe,cAAsC;CACjD,MAAM,UAAuD,MAAM,OAAO;CAE1E,OAAO,QAAQ,WAAW;AAC9B"}

package/dist/export/xlsx/XlsxNumberFormat.d.ts

@@ -0,0 +1,8 @@
+import { NumberFormat } from '../ExportDocument';
+/**
+ * Converts a {@link NumberFormat} to the Excel number format code. The code uses `.` and `,` as in the American
+ * format, but Excel shows the separators of the language of whoever opens the file (e.g. "1.234,56" in Portuguese).
+ * @param format decimal places and whether the value is a percentage (in the 0..1 scale)
+ * @return the format code (e.g. `#,##0.00` or `0.0%`)
+ */
+export declare function xlsxNumberFormat(format: NumberFormat): string;

package/dist/export/xlsx/XlsxNumberFormat.js

@@ -0,0 +1,15 @@
+"use client";
+// src/export/xlsx/XlsxNumberFormat.ts
+/**
+* Converts a {@link NumberFormat} to the Excel number format code. The code uses `.` and `,` as in the American
+* format, but Excel shows the separators of the language of whoever opens the file (e.g. "1.234,56" in Portuguese).
+* @param format decimal places and whether the value is a percentage (in the 0..1 scale)
+* @return the format code (e.g. `#,##0.00` or `0.0%`)
+*/
+function xlsxNumberFormat(format) {
+	const decimalPart = format.decimals > 0 ? `.${"0".repeat(format.decimals)}` : "";
+	return format.percent ? `0${decimalPart}%` : `#,##0${decimalPart}`;
+}
+export { xlsxNumberFormat };
+
+//# sourceMappingURL=XlsxNumberFormat.js.map

package/dist/export/xlsx/XlsxNumberFormat.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"XlsxNumberFormat.js","names":[],"sources":["../../../src/export/xlsx/XlsxNumberFormat.ts"],"sourcesContent":["import { NumberFormat } from '../ExportDocument';\n\n/**\n * Converts a {@link NumberFormat} to the Excel number format code. The code uses `.` and `,` as in the American\n * format, but Excel shows the separators of the language of whoever opens the file (e.g. \"1.234,56\" in Portuguese).\n * @param format decimal places and whether the value is a percentage (in the 0..1 scale)\n * @return the format code (e.g. `#,##0.00` or `0.0%`)\n */\nexport function xlsxNumberFormat(format: NumberFormat): string {\n    const decimalPart = format.decimals > 0 ? `.${'0'.repeat(format.decimals)}` : '';\n\n    return format.percent ? `0${decimalPart}%` : `#,##0${decimalPart}`;\n}\n"],"mappings":";;;;;;;;AAQA,SAAgB,iBAAiB,QAA8B;CAC3D,MAAM,cAAc,OAAO,WAAW,IAAI,IAAI,IAAI,OAAO,OAAO,QAAQ,MAAM;CAE9E,OAAO,OAAO,UAAU,IAAI,YAAY,KAAK,QAAQ;AACzD"}

package/dist/export/xlsx/XlsxSheetName.d.ts

@@ -0,0 +1,12 @@
+/** Maximum length of a sheet name in Excel. */
+export declare const MAX_SHEET_NAME_LENGTH = 31;
+/**
+ * Adapts the sheet names to the Excel rules: at most {@link MAX_SHEET_NAME_LENGTH} characters, without `[ ] : * ? /
+ * \`, without an apostrophe at the beginning or at the end, without the reserved name "History" and without repeating
+ * a name (Excel is case insensitive). A repeated or reserved name gets a number at the end (e.g. "Sales (2)").
+ * @param names desired names, in the order of the sheets
+ * @param defaultName builds the name of a sheet without any valid character, from its position (starting at 1);
+ *        defaults to the one of the default locale
+ * @return the names accepted by Excel, in the same order
+ */
+export declare function xlsxSheetNames(names: string[], defaultName?: (position: number) => string): string[];

package/dist/export/xlsx/XlsxSheetName.js

@@ -0,0 +1,62 @@
+"use client";
+import { DEFAULT_MESSAGES } from "../../i18n/resolveMessages.js";
+// src/export/xlsx/XlsxSheetName.ts
+/** Maximum length of a sheet name in Excel. */
+var MAX_SHEET_NAME_LENGTH = 31;
+/** Characters Excel does not accept in a sheet name. */
+var INVALID_CHARS = /[[\]:*?/\\]/g;
+/** Spaces and apostrophes at the ends of the name: Excel accepts no apostrophe at the beginning or at the end. */
+var EDGES = /^[\s']+|[\s']+$/g;
+/** Name reserved by Excel, which cannot be used by a sheet (case insensitive). */
+var RESERVED_NAME = "history";
+/**
+* Adapts the sheet names to the Excel rules: at most {@link MAX_SHEET_NAME_LENGTH} characters, without `[ ] : * ? /
+* \`, without an apostrophe at the beginning or at the end, without the reserved name "History" and without repeating
+* a name (Excel is case insensitive). A repeated or reserved name gets a number at the end (e.g. "Sales (2)").
+* @param names desired names, in the order of the sheets
+* @param defaultName builds the name of a sheet without any valid character, from its position (starting at 1);
+*        defaults to the one of the default locale
+* @return the names accepted by Excel, in the same order
+*/
+function xlsxSheetNames(names, defaultName = DEFAULT_MESSAGES.export.defaultSheetName) {
+	const usedNames = /* @__PURE__ */ new Set([RESERVED_NAME]);
+	return names.map((name, i) => {
+		const sheetName = uniqueName(sanitize(name) || defaultName(i + 1), usedNames);
+		usedNames.add(sheetName.toLowerCase());
+		return sheetName;
+	});
+}
+/**
+* Removes from the name the characters Excel does not accept.
+* @param name desired name of the sheet
+* @return the name without the invalid characters and without spaces or apostrophes at the ends
+*/
+function sanitize(name) {
+	return name.replace(INVALID_CHARS, "-").replace(EDGES, "");
+}
+/**
+* Cuts the name to the maximum length and adds a number if it is already used.
+* @param name name of the sheet, already without invalid characters
+* @param usedNames names already used, in lower case
+* @return a name not used yet
+*/
+function uniqueName(name, usedNames) {
+	let candidate = cut(name, 31);
+	for (let number = 2; usedNames.has(candidate.toLowerCase()); number++) {
+		const suffix = ` (${number})`;
+		candidate = cut(name, 31 - suffix.length) + suffix;
+	}
+	return candidate;
+}
+/**
+* Cuts the name to a length and removes again the spaces and apostrophes at the ends, which the cut may have left.
+* @param name name of the sheet
+* @param maxLength maximum length
+* @return the cut name
+*/
+function cut(name, maxLength) {
+	return name.slice(0, maxLength).replace(EDGES, "");
+}
+export { MAX_SHEET_NAME_LENGTH, xlsxSheetNames };
+
+//# sourceMappingURL=XlsxSheetName.js.map

package/dist/export/xlsx/XlsxSheetName.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"XlsxSheetName.js","names":[],"sources":["../../../src/export/xlsx/XlsxSheetName.ts"],"sourcesContent":["import { DEFAULT_MESSAGES } from '../../i18n/resolveMessages';\n\n/** Maximum length of a sheet name in Excel. */\nexport const MAX_SHEET_NAME_LENGTH = 31;\n\n/** Characters Excel does not accept in a sheet name. */\nconst INVALID_CHARS = /[[\\]:*?/\\\\]/g;\n\n/** Spaces and apostrophes at the ends of the name: Excel accepts no apostrophe at the beginning or at the end. */\nconst EDGES = /^[\\s']+|[\\s']+$/g;\n\n/** Name reserved by Excel, which cannot be used by a sheet (case insensitive). */\nconst RESERVED_NAME = 'history';\n\n/**\n * Adapts the sheet names to the Excel rules: at most {@link MAX_SHEET_NAME_LENGTH} characters, without `[ ] : * ? /\n * \\`, without an apostrophe at the beginning or at the end, without the reserved name \"History\" and without repeating\n * a name (Excel is case insensitive). A repeated or reserved name gets a number at the end (e.g. \"Sales (2)\").\n * @param names desired names, in the order of the sheets\n * @param defaultName builds the name of a sheet without any valid character, from its position (starting at 1);\n *        defaults to the one of the default locale\n * @return the names accepted by Excel, in the same order\n */\nexport function xlsxSheetNames(\n    names: string[],\n    defaultName: (position: number) => string = DEFAULT_MESSAGES.export.defaultSheetName\n): string[] {\n    const usedNames = new Set<string>([RESERVED_NAME]);\n\n    return names.map((name, i) => {\n        const sheetName = uniqueName(sanitize(name) || defaultName(i + 1), usedNames);\n        usedNames.add(sheetName.toLowerCase());\n        return sheetName;\n    });\n}\n\n/**\n * Removes from the name the characters Excel does not accept.\n * @param name desired name of the sheet\n * @return the name without the invalid characters and without spaces or apostrophes at the ends\n */\nfunction sanitize(name: string): string {\n    return name.replace(INVALID_CHARS, '-').replace(EDGES, '');\n}\n\n/**\n * Cuts the name to the maximum length and adds a number if it is already used.\n * @param name name of the sheet, already without invalid characters\n * @param usedNames names already used, in lower case\n * @return a name not used yet\n */\nfunction uniqueName(name: string, usedNames: Set<string>): string {\n    let candidate = cut(name, MAX_SHEET_NAME_LENGTH);\n    for (let number = 2; usedNames.has(candidate.toLowerCase()); number++) {\n        const suffix = ` (${number})`;\n        candidate = cut(name, MAX_SHEET_NAME_LENGTH - suffix.length) + suffix;\n    }\n\n    return candidate;\n}\n\n/**\n * Cuts the name to a length and removes again the spaces and apostrophes at the ends, which the cut may have left.\n * @param name name of the sheet\n * @param maxLength maximum length\n * @return the cut name\n */\nfunction cut(name: string, maxLength: number): string {\n    return name.slice(0, maxLength).replace(EDGES, '');\n}\n"],"mappings":";;;;AAGA,IAAa,wBAAwB;;AAGrC,IAAM,gBAAgB;;AAGtB,IAAM,QAAQ;;AAGd,IAAM,gBAAgB;;;;;;;;;;AAWtB,SAAgB,eACZ,OACA,cAA4C,iBAAiB,OAAO,kBAC5D;CACR,MAAM,4BAAY,IAAI,IAAY,CAAC,aAAa,CAAC;CAEjD,OAAO,MAAM,KAAK,MAAM,MAAM;EAC1B,MAAM,YAAY,WAAW,SAAS,IAAI,KAAK,YAAY,IAAI,CAAC,GAAG,SAAS;EAC5E,UAAU,IAAI,UAAU,YAAY,CAAC;EACrC,OAAO;CACX,CAAC;AACL;;;;;;AAOA,SAAS,SAAS,MAAsB;CACpC,OAAO,KAAK,QAAQ,eAAe,GAAG,CAAC,CAAC,QAAQ,OAAO,EAAE;AAC7D;;;;;;;AAQA,SAAS,WAAW,MAAc,WAAgC;CAC9D,IAAI,YAAY,IAAI,MAAA,EAA2B;CAC/C,KAAK,IAAI,SAAS,GAAG,UAAU,IAAI,UAAU,YAAY,CAAC,GAAG,UAAU;EACnE,MAAM,SAAS,KAAK,OAAO;EAC3B,YAAY,IAAI,MAAA,KAA8B,OAAO,MAAM,IAAI;CACnE;CAEA,OAAO;AACX;;;;;;;AAQA,SAAS,IAAI,MAAc,WAA2B;CAClD,OAAO,KAAK,MAAM,GAAG,SAAS,CAAC,CAAC,QAAQ,OAAO,EAAE;AACrD"}

package/dist/export/xlsx/XlsxSheetWriter.d.ts

@@ -0,0 +1,67 @@
+import type { Worksheet } from 'exceljs';
+import { ExportDocument, ExportSheet } from '../ExportDocument';
+import { XlsxStyles } from './XlsxStyle';
+/**
+ * Writes a sheet of the `.xlsx`, from top to bottom: the logo, the title, the generation date, the context info, the
+ * table and the footer with the link of the system. Numbers are numeric (not text), with the format of each cell.
+ * @author Manoel Campos
+ */
+export declare class XlsxSheetWriter {
+    private readonly worksheet;
+    private readonly document;
+    private readonly messages;
+    private readonly styles;
+    /** Next free row of the sheet (starts at 1, as in Excel). */
+    private nextRow;
+    /**
+     * @param worksheet sheet to write to
+     * @param document exported document, where the title, the context, the texts and the visual identity come from
+     * @param styles fonts, fills and borders of the sheet
+     */
+    constructor(worksheet: Worksheet, document: ExportDocument, styles?: XlsxStyles);
+    /**
+     * Writes the whole sheet.
+     * @param sheet columns and rows of the table
+     * @param logoImageId id of the logo registered in the workbook; absent to show no logo
+     */
+    write(sheet: ExportSheet, logoImageId?: number): void;
+    /**
+     * Writes the logo, the title, the generation date and the context info.
+     * @param logoImageId id of the logo registered in the workbook
+     */
+    private writeHeader;
+    /**
+     * Writes the table: the header and the rows, with borders, zebra stripes and the Excel filter in the header.
+     * @param sheet columns of the table
+     * @param rows cells of each row, already classified
+     * @return the number of the header row
+     */
+    private writeTable;
+    /**
+     * Writes a row of the table.
+     * @param row cells of the row, already classified
+     * @param index position of the row in the table (0 for the first one), used in the zebra stripes
+     */
+    private writeTableRow;
+    /** Writes the footer, with the name of the system and the link to it. */
+    private writeFooter;
+    /**
+     * Fits the width of each column to the longest text of the table. The rows outside the table (title, info and
+     * footer) do not count, since their text can flow to the empty cells beside them.
+     * @param sheet columns of the table
+     * @param rows cells of each row, already classified
+     */
+    private adjustColumnWidths;
+    /**
+     * Sets up printing: landscape, the table fitting the page width, the header repeated on every page and a page
+     * footer with the system and the page number.
+     * @param headerRow number of the header row
+     */
+    private setupPrinting;
+    /**
+     * Adds a row at the next free position.
+     * @param values values of the cells, from the first column on
+     * @return the created row
+     */
+    private addRow;
+}

package/dist/export/xlsx/XlsxSheetWriter.js

@@ -0,0 +1,215 @@
+"use client";
+import { cellText } from "../ExportCellText.js";
+import { classifyCell } from "../ExportDocument.js";
+import { exportLocale, exportMessages } from "../ExportTexts.js";
+import { xlsxNumberFormat } from "./XlsxNumberFormat.js";
+import { xlsxStyles } from "./XlsxStyle.js";
+// src/export/xlsx/XlsxSheetWriter.ts
+/**
+* Writes a sheet of the `.xlsx`, from top to bottom: the logo, the title, the generation date, the context info, the
+* table and the footer with the link of the system. Numbers are numeric (not text), with the format of each cell.
+* @author Manoel Campos
+*/
+var XlsxSheetWriter = class {
+	worksheet;
+	document;
+	messages;
+	styles;
+	/** Next free row of the sheet (starts at 1, as in Excel). */
+	nextRow = 1;
+	/**
+	* @param worksheet sheet to write to
+	* @param document exported document, where the title, the context, the texts and the visual identity come from
+	* @param styles fonts, fills and borders of the sheet
+	*/
+	constructor(worksheet, document, styles = xlsxStyles()) {
+		this.worksheet = worksheet;
+		this.document = document;
+		this.messages = exportMessages(document);
+		this.styles = styles;
+	}
+	/**
+	* Writes the whole sheet.
+	* @param sheet columns and rows of the table
+	* @param logoImageId id of the logo registered in the workbook; absent to show no logo
+	*/
+	write(sheet, logoImageId) {
+		this.writeHeader(logoImageId);
+		const rows = classifyRows(sheet, this.messages.invalidCell);
+		const headerRow = this.writeTable(sheet, rows);
+		this.writeFooter();
+		this.adjustColumnWidths(sheet, rows);
+		this.setupPrinting(headerRow);
+	}
+	/**
+	* Writes the logo, the title, the generation date and the context info.
+	* @param logoImageId id of the logo registered in the workbook
+	*/
+	writeHeader(logoImageId) {
+		const { logo } = this.document.branding;
+		if (logoImageId !== void 0 && logo) {
+			const width = Math.round(48 * logo.width / logo.height);
+			this.worksheet.addImage(logoImageId, {
+				tl: {
+					col: 0,
+					row: 0
+				},
+				ext: {
+					width,
+					height: 48
+				}
+			});
+			this.nextRow += 3;
+		}
+		this.addRow([this.document.title]).getCell(1).font = this.styles.titleFont;
+		this.addRow([this.messages.generatedAt(this.document.generatedAt)]).getCell(1).font = this.styles.subtitleFont;
+		this.document.info.forEach((info) => {
+			this.addRow([]).getCell(1).value = { richText: [{
+				font: this.styles.infoLabelFont,
+				text: `${info.label}: `
+			}, { text: info.value }] };
+		});
+		this.nextRow++;
+	}
+	/**
+	* Writes the table: the header and the rows, with borders, zebra stripes and the Excel filter in the header.
+	* @param sheet columns of the table
+	* @param rows cells of each row, already classified
+	* @return the number of the header row
+	*/
+	writeTable(sheet, rows) {
+		const headerRow = this.nextRow;
+		this.addRow(sheet.columns.map((column) => column.header)).eachCell((cell) => {
+			cell.font = this.styles.headerFont;
+			cell.fill = this.styles.headerFill;
+			cell.border = this.styles.cellBorder;
+			cell.alignment = {
+				vertical: "middle",
+				wrapText: true
+			};
+		});
+		rows.forEach((row, i) => this.writeTableRow(row, i));
+		if (rows.length > 0 && sheet.columns.length > 0) this.worksheet.autoFilter = {
+			from: {
+				row: headerRow,
+				column: 1
+			},
+			to: {
+				row: headerRow + rows.length,
+				column: sheet.columns.length
+			}
+		};
+		return headerRow;
+	}
+	/**
+	* Writes a row of the table.
+	* @param row cells of the row, already classified
+	* @param index position of the row in the table (0 for the first one), used in the zebra stripes
+	*/
+	writeTableRow(row, index) {
+		const excelRow = this.worksheet.getRow(this.nextRow++);
+		row.forEach((classified, i) => {
+			const cell = excelRow.getCell(i + 1);
+			writeCell(cell, classified, this.styles);
+			cell.border = this.styles.cellBorder;
+			if (index % 2 === 1) cell.fill = this.styles.zebraFill;
+		});
+	}
+	/** Writes the footer, with the name of the system and the link to it. */
+	writeFooter() {
+		const { branding } = this.document;
+		this.nextRow++;
+		this.addRow([this.messages.footer(branding.systemName)]).getCell(1).font = this.styles.footerFont;
+		const link = this.addRow([]).getCell(1);
+		link.value = {
+			text: branding.siteUrl,
+			hyperlink: branding.siteUrl
+		};
+		link.font = this.styles.linkFont;
+	}
+	/**
+	* Fits the width of each column to the longest text of the table. The rows outside the table (title, info and
+	* footer) do not count, since their text can flow to the empty cells beside them.
+	* @param sheet columns of the table
+	* @param rows cells of each row, already classified
+	*/
+	adjustColumnWidths(sheet, rows) {
+		const locale = exportLocale(this.document);
+		sheet.columns.forEach((column, i) => {
+			const maxLength = rows.reduce((max, row) => Math.max(max, cellText(row[i], true, locale).length), column.header.length);
+			this.worksheet.getColumn(i + 1).width = Math.min(60, Math.max(8, maxLength + 2));
+		});
+	}
+	/**
+	* Sets up printing: landscape, the table fitting the page width, the header repeated on every page and a page
+	* footer with the system and the page number.
+	* @param headerRow number of the header row
+	*/
+	setupPrinting(headerRow) {
+		this.worksheet.pageSetup = {
+			...this.worksheet.pageSetup,
+			orientation: "landscape",
+			fitToPage: true,
+			fitToWidth: 1,
+			fitToHeight: 0,
+			printTitlesRow: `${headerRow}:${headerRow}`
+		};
+		const { branding } = this.document;
+		const footer = `${this.messages.footer(branding.systemName)} - ${branding.siteUrl}`.replaceAll("&", "&&");
+		this.worksheet.headerFooter.oddFooter = `&L${footer}&R${this.messages.excelPageNumber}`;
+		this.worksheet.views = [{ showGridLines: false }];
+	}
+	/**
+	* Adds a row at the next free position.
+	* @param values values of the cells, from the first column on
+	* @return the created row
+	*/
+	addRow(values) {
+		const row = this.worksheet.getRow(this.nextRow++);
+		values.forEach((value, i) => {
+			row.getCell(i + 1).value = value;
+		});
+		return row;
+	}
+};
+/**
+* Classifies the cells of all rows of the table, completing with empty cells the rows shorter than the number of
+* columns.
+* @param sheet columns and rows of the table
+* @param invalidText text of an infinite number
+* @return a classified cell per column, in each row
+* @throws Error if a row has more cells than columns, since the extra data would be lost without warning
+*/
+function classifyRows(sheet, invalidText) {
+	return sheet.rows.map((row, rowIndex) => {
+		if (row.length > sheet.columns.length) throw new Error(`Row ${rowIndex + 1} of the sheet "${sheet.name}" has ${row.length} cells, but the sheet has ${sheet.columns.length} columns.`);
+		return sheet.columns.map((column, i) => classifyCell(row[i], column.format, invalidText));
+	});
+}
+/**
+* Writes the value of a table cell, with the number format and the highlight of the invalid results.
+* @param cell Excel cell
+* @param classified value already classified (see {@link classifyCell})
+* @param styles styles of the sheet, for the highlight of the invalid results
+*/
+function writeCell(cell, classified, styles) {
+	switch (classified.kind) {
+		case "empty":
+			cell.value = null;
+			break;
+		case "text":
+			cell.value = classified.text;
+			break;
+		case "invalid":
+			cell.value = classified.text;
+			cell.font = styles.invalidFont;
+			cell.alignment = { horizontal: "right" };
+			break;
+		case "number":
+			cell.value = classified.value;
+			cell.numFmt = xlsxNumberFormat(classified.format);
+	}
+}
+export { XlsxSheetWriter };
+
+//# sourceMappingURL=XlsxSheetWriter.js.map

package/dist/export/xlsx/XlsxSheetWriter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"XlsxSheetWriter.js","names":[],"sources":["../../../src/export/xlsx/XlsxSheetWriter.ts"],"sourcesContent":["import type { Cell, Row, Worksheet } from 'exceljs';\n\nimport { ExportMessages } from '../../i18n/KitMessages';\nimport { cellText } from '../ExportCellText';\nimport { ClassifiedCell, classifyCell, ExportDocument, ExportSheet } from '../ExportDocument';\nimport { exportLocale, exportMessages } from '../ExportTexts';\nimport { xlsxNumberFormat } from './XlsxNumberFormat';\nimport {\n    COLUMN_PADDING,\n    LOGO_HEIGHT,\n    LOGO_ROWS,\n    MAX_COLUMN_WIDTH,\n    MIN_COLUMN_WIDTH,\n    xlsxStyles,\n    XlsxStyles\n} from './XlsxStyle';\n\n/**\n * Writes a sheet of the `.xlsx`, from top to bottom: the logo, the title, the generation date, the context info, the\n * table and the footer with the link of the system. Numbers are numeric (not text), with the format of each cell.\n * @author Manoel Campos\n */\nexport class XlsxSheetWriter {\n    private readonly worksheet: Worksheet;\n    private readonly document: ExportDocument;\n    private readonly messages: ExportMessages;\n    private readonly styles: XlsxStyles;\n\n    /** Next free row of the sheet (starts at 1, as in Excel). */\n    private nextRow = 1;\n\n    /**\n     * @param worksheet sheet to write to\n     * @param document exported document, where the title, the context, the texts and the visual identity come from\n     * @param styles fonts, fills and borders of the sheet\n     */\n    constructor(worksheet: Worksheet, document: ExportDocument, styles: XlsxStyles = xlsxStyles()) {\n        this.worksheet = worksheet;\n        this.document = document;\n        this.messages = exportMessages(document);\n        this.styles = styles;\n    }\n\n    /**\n     * Writes the whole sheet.\n     * @param sheet columns and rows of the table\n     * @param logoImageId id of the logo registered in the workbook; absent to show no logo\n     */\n    write(sheet: ExportSheet, logoImageId?: number): void {\n        this.writeHeader(logoImageId);\n        const rows = classifyRows(sheet, this.messages.invalidCell);\n        const headerRow = this.writeTable(sheet, rows);\n        this.writeFooter();\n        this.adjustColumnWidths(sheet, rows);\n        this.setupPrinting(headerRow);\n    }\n\n    /**\n     * Writes the logo, the title, the generation date and the context info.\n     * @param logoImageId id of the logo registered in the workbook\n     */\n    private writeHeader(logoImageId?: number): void {\n        const { logo } = this.document.branding;\n        if (logoImageId !== undefined && logo) {\n            const width = Math.round((LOGO_HEIGHT * logo.width) / logo.height);\n            this.worksheet.addImage(logoImageId, { tl: { col: 0, row: 0 }, ext: { width, height: LOGO_HEIGHT } });\n            this.nextRow += LOGO_ROWS;\n        }\n\n        this.addRow([this.document.title]).getCell(1).font = this.styles.titleFont;\n        this.addRow([this.messages.generatedAt(this.document.generatedAt)]).getCell(1).font = this.styles.subtitleFont;\n        /* The label and the value stay in a single cell (as rich text, with the label in bold): the text flows to the\n           empty cells beside it, instead of being cut by the width of the first column, which fits the table. */\n        this.document.info.forEach(info => {\n            this.addRow([]).getCell(1).value = {\n                richText: [{ font: this.styles.infoLabelFont, text: `${info.label}: ` }, { text: info.value }]\n            };\n        });\n        this.nextRow++;\n    }\n\n    /**\n     * Writes the table: the header and the rows, with borders, zebra stripes and the Excel filter in the header.\n     * @param sheet columns of the table\n     * @param rows cells of each row, already classified\n     * @return the number of the header row\n     */\n    private writeTable(sheet: ExportSheet, rows: ClassifiedCell[][]): number {\n        const headerRow = this.nextRow;\n        this.addRow(sheet.columns.map(column => column.header)).eachCell(cell => {\n            cell.font = this.styles.headerFont;\n            cell.fill = this.styles.headerFill;\n            cell.border = this.styles.cellBorder;\n            cell.alignment = { vertical: 'middle', wrapText: true };\n        });\n\n        rows.forEach((row, i) => this.writeTableRow(row, i));\n        if (rows.length > 0 && sheet.columns.length > 0) {\n            this.worksheet.autoFilter = {\n                from: { row: headerRow, column: 1 },\n                to: { row: headerRow + rows.length, column: sheet.columns.length }\n            };\n        }\n\n        return headerRow;\n    }\n\n    /**\n     * Writes a row of the table.\n     * @param row cells of the row, already classified\n     * @param index position of the row in the table (0 for the first one), used in the zebra stripes\n     */\n    private writeTableRow(row: ClassifiedCell[], index: number): void {\n        const excelRow = this.worksheet.getRow(this.nextRow++);\n        row.forEach((classified, i) => {\n            const cell = excelRow.getCell(i + 1);\n            writeCell(cell, classified, this.styles);\n            cell.border = this.styles.cellBorder;\n            if (index % 2 === 1) cell.fill = this.styles.zebraFill;\n        });\n    }\n\n    /** Writes the footer, with the name of the system and the link to it. */\n    private writeFooter(): void {\n        const { branding } = this.document;\n        this.nextRow++;\n        this.addRow([this.messages.footer(branding.systemName)]).getCell(1).font = this.styles.footerFont;\n\n        const link = this.addRow([]).getCell(1);\n        link.value = { text: branding.siteUrl, hyperlink: branding.siteUrl };\n        link.font = this.styles.linkFont;\n    }\n\n    /**\n     * Fits the width of each column to the longest text of the table. The rows outside the table (title, info and\n     * footer) do not count, since their text can flow to the empty cells beside them.\n     * @param sheet columns of the table\n     * @param rows cells of each row, already classified\n     */\n    private adjustColumnWidths(sheet: ExportSheet, rows: ClassifiedCell[][]): void {\n        const locale = exportLocale(this.document);\n        sheet.columns.forEach((column, i) => {\n            // reduce, not Math.max(...): the spread passes a row per argument and overflows the stack in a big sheet.\n            const maxLength = rows.reduce(\n                (max, row) => Math.max(max, cellText(row[i], true, locale).length),\n                column.header.length\n            );\n            this.worksheet.getColumn(i + 1).width = Math.min(\n                MAX_COLUMN_WIDTH,\n                Math.max(MIN_COLUMN_WIDTH, maxLength + COLUMN_PADDING)\n            );\n        });\n    }\n\n    /**\n     * Sets up printing: landscape, the table fitting the page width, the header repeated on every page and a page\n     * footer with the system and the page number.\n     * @param headerRow number of the header row\n     */\n    private setupPrinting(headerRow: number): void {\n        this.worksheet.pageSetup = {\n            ...this.worksheet.pageSetup,\n            orientation: 'landscape',\n            fitToPage: true,\n            fitToWidth: 1,\n            fitToHeight: 0,\n            printTitlesRow: `${headerRow}:${headerRow}`\n        };\n\n        // In the Excel page footer, `&` starts a code (e.g. &P is the page number), so it is escaped.\n        const { branding } = this.document;\n        const footer = `${this.messages.footer(branding.systemName)} - ${branding.siteUrl}`.replaceAll('&', '&&');\n        this.worksheet.headerFooter.oddFooter = `&L${footer}&R${this.messages.excelPageNumber}`;\n        this.worksheet.views = [{ showGridLines: false }];\n    }\n\n    /**\n     * Adds a row at the next free position.\n     * @param values values of the cells, from the first column on\n     * @return the created row\n     */\n    private addRow(values: string[]): Row {\n        const row = this.worksheet.getRow(this.nextRow++);\n        values.forEach((value, i) => {\n            row.getCell(i + 1).value = value;\n        });\n\n        return row;\n    }\n}\n\n/**\n * Classifies the cells of all rows of the table, completing with empty cells the rows shorter than the number of\n * columns.\n * @param sheet columns and rows of the table\n * @param invalidText text of an infinite number\n * @return a classified cell per column, in each row\n * @throws Error if a row has more cells than columns, since the extra data would be lost without warning\n */\nfunction classifyRows(sheet: ExportSheet, invalidText: string): ClassifiedCell[][] {\n    return sheet.rows.map((row, rowIndex) => {\n        if (row.length > sheet.columns.length) {\n            throw new Error(\n                `Row ${rowIndex + 1} of the sheet \"${sheet.name}\" has ${row.length} cells, but the sheet has ` +\n                    `${sheet.columns.length} columns.`\n            );\n        }\n\n        return sheet.columns.map((column, i) => classifyCell(row[i], column.format, invalidText));\n    });\n}\n\n/**\n * Writes the value of a table cell, with the number format and the highlight of the invalid results.\n * @param cell Excel cell\n * @param classified value already classified (see {@link classifyCell})\n * @param styles styles of the sheet, for the highlight of the invalid results\n */\nfunction writeCell(cell: Cell, classified: ClassifiedCell, styles: XlsxStyles): void {\n    switch (classified.kind) {\n        case 'empty':\n            cell.value = null;\n            break;\n        case 'text':\n            cell.value = classified.text;\n            break;\n        case 'invalid':\n            cell.value = classified.text;\n            cell.font = styles.invalidFont;\n            cell.alignment = { horizontal: 'right' };\n            break;\n        case 'number':\n            cell.value = classified.value;\n            cell.numFmt = xlsxNumberFormat(classified.format);\n            break;\n    }\n}\n"],"mappings":";;;;;;;;;;;;AAsBA,IAAa,kBAAb,MAA6B;CACzB;CACA;CACA;CACA;;CAGA,UAAkB;;;;;;CAOlB,YAAY,WAAsB,UAA0B,SAAqB,WAAW,GAAG;EAC3F,KAAK,YAAY;EACjB,KAAK,WAAW;EAChB,KAAK,WAAW,eAAe,QAAQ;EACvC,KAAK,SAAS;CAClB;;;;;;CAOA,MAAM,OAAoB,aAA4B;EAClD,KAAK,YAAY,WAAW;EAC5B,MAAM,OAAO,aAAa,OAAO,KAAK,SAAS,WAAW;EAC1D,MAAM,YAAY,KAAK,WAAW,OAAO,IAAI;EAC7C,KAAK,YAAY;EACjB,KAAK,mBAAmB,OAAO,IAAI;EACnC,KAAK,cAAc,SAAS;CAChC;;;;;CAMA,YAAoB,aAA4B;EAC5C,MAAM,EAAE,SAAS,KAAK,SAAS;EAC/B,IAAI,gBAAgB,KAAA,KAAa,MAAM;GACnC,MAAM,QAAQ,KAAK,MAAA,KAAqB,KAAK,QAAS,KAAK,MAAM;GACjE,KAAK,UAAU,SAAS,aAAa;IAAE,IAAI;KAAE,KAAK;KAAG,KAAK;IAAE;IAAG,KAAK;KAAE;KAAO,QAAA;IAAoB;GAAE,CAAC;GACpG,KAAK,WAAA;EACT;EAEA,KAAK,OAAO,CAAC,KAAK,SAAS,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,KAAK,OAAO;EACjE,KAAK,OAAO,CAAC,KAAK,SAAS,YAAY,KAAK,SAAS,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,KAAK,OAAO;EAGlG,KAAK,SAAS,KAAK,SAAQ,SAAQ;GAC/B,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,EAC/B,UAAU,CAAC;IAAE,MAAM,KAAK,OAAO;IAAe,MAAM,GAAG,KAAK,MAAM;GAAI,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC,EACjG;EACJ,CAAC;EACD,KAAK;CACT;;;;;;;CAQA,WAAmB,OAAoB,MAAkC;EACrE,MAAM,YAAY,KAAK;EACvB,KAAK,OAAO,MAAM,QAAQ,KAAI,WAAU,OAAO,MAAM,CAAC,CAAC,CAAC,UAAS,SAAQ;GACrE,KAAK,OAAO,KAAK,OAAO;GACxB,KAAK,OAAO,KAAK,OAAO;GACxB,KAAK,SAAS,KAAK,OAAO;GAC1B,KAAK,YAAY;IAAE,UAAU;IAAU,UAAU;GAAK;EAC1D,CAAC;EAED,KAAK,SAAS,KAAK,MAAM,KAAK,cAAc,KAAK,CAAC,CAAC;EACnD,IAAI,KAAK,SAAS,KAAK,MAAM,QAAQ,SAAS,GAC1C,KAAK,UAAU,aAAa;GACxB,MAAM;IAAE,KAAK;IAAW,QAAQ;GAAE;GAClC,IAAI;IAAE,KAAK,YAAY,KAAK;IAAQ,QAAQ,MAAM,QAAQ;GAAO;EACrE;EAGJ,OAAO;CACX;;;;;;CAOA,cAAsB,KAAuB,OAAqB;EAC9D,MAAM,WAAW,KAAK,UAAU,OAAO,KAAK,SAAS;EACrD,IAAI,SAAS,YAAY,MAAM;GAC3B,MAAM,OAAO,SAAS,QAAQ,IAAI,CAAC;GACnC,UAAU,MAAM,YAAY,KAAK,MAAM;GACvC,KAAK,SAAS,KAAK,OAAO;GAC1B,IAAI,QAAQ,MAAM,GAAG,KAAK,OAAO,KAAK,OAAO;EACjD,CAAC;CACL;;CAGA,cAA4B;EACxB,MAAM,EAAE,aAAa,KAAK;EAC1B,KAAK;EACL,KAAK,OAAO,CAAC,KAAK,SAAS,OAAO,SAAS,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,KAAK,OAAO;EAEvF,MAAM,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;EACtC,KAAK,QAAQ;GAAE,MAAM,SAAS;GAAS,WAAW,SAAS;EAAQ;EACnE,KAAK,OAAO,KAAK,OAAO;CAC5B;;;;;;;CAQA,mBAA2B,OAAoB,MAAgC;EAC3E,MAAM,SAAS,aAAa,KAAK,QAAQ;EACzC,MAAM,QAAQ,SAAS,QAAQ,MAAM;GAEjC,MAAM,YAAY,KAAK,QAClB,KAAK,QAAQ,KAAK,IAAI,KAAK,SAAS,IAAI,IAAI,MAAM,MAAM,CAAC,CAAC,MAAM,GACjE,OAAO,OAAO,MAClB;GACA,KAAK,UAAU,UAAU,IAAI,CAAC,CAAC,CAAC,QAAQ,KAAK,IAAA,IAEzC,KAAK,IAAA,GAAsB,YAAA,CAA0B,CACzD;EACJ,CAAC;CACL;;;;;;CAOA,cAAsB,WAAyB;EAC3C,KAAK,UAAU,YAAY;GACvB,GAAG,KAAK,UAAU;GAClB,aAAa;GACb,WAAW;GACX,YAAY;GACZ,aAAa;GACb,gBAAgB,GAAG,UAAU,GAAG;EACpC;EAGA,MAAM,EAAE,aAAa,KAAK;EAC1B,MAAM,SAAS,GAAG,KAAK,SAAS,OAAO,SAAS,UAAU,EAAE,KAAK,SAAS,UAAU,WAAW,KAAK,IAAI;EACxG,KAAK,UAAU,aAAa,YAAY,KAAK,OAAO,IAAI,KAAK,SAAS;EACtE,KAAK,UAAU,QAAQ,CAAC,EAAE,eAAe,MAAM,CAAC;CACpD;;;;;;CAOA,OAAe,QAAuB;EAClC,MAAM,MAAM,KAAK,UAAU,OAAO,KAAK,SAAS;EAChD,OAAO,SAAS,OAAO,MAAM;GACzB,IAAI,QAAQ,IAAI,CAAC,CAAC,CAAC,QAAQ;EAC/B,CAAC;EAED,OAAO;CACX;AACJ;;;;;;;;;AAUA,SAAS,aAAa,OAAoB,aAAyC;CAC/E,OAAO,MAAM,KAAK,KAAK,KAAK,aAAa;EACrC,IAAI,IAAI,SAAS,MAAM,QAAQ,QAC3B,MAAM,IAAI,MACN,OAAO,WAAW,EAAE,iBAAiB,MAAM,KAAK,QAAQ,IAAI,OAAO,4BAC5D,MAAM,QAAQ,OAAO,UAChC;EAGJ,OAAO,MAAM,QAAQ,KAAK,QAAQ,MAAM,aAAa,IAAI,IAAI,OAAO,QAAQ,WAAW,CAAC;CAC5F,CAAC;AACL;;;;;;;AAQA,SAAS,UAAU,MAAY,YAA4B,QAA0B;CACjF,QAAQ,WAAW,MAAnB;EACI,KAAK;GACD,KAAK,QAAQ;GACb;EACJ,KAAK;GACD,KAAK,QAAQ,WAAW;GACxB;EACJ,KAAK;GACD,KAAK,QAAQ,WAAW;GACxB,KAAK,OAAO,OAAO;GACnB,KAAK,YAAY,EAAE,YAAY,QAAQ;GACvC;EACJ,KAAK;GACD,KAAK,QAAQ,WAAW;GACxB,KAAK,SAAS,iBAAiB,WAAW,MAAM;CAExD;AACJ"}

package/dist/export/xlsx/XlsxStyle.d.ts

@@ -0,0 +1,51 @@
+import type { Border, Fill, Font } from 'exceljs';
+/**
+ * Styles of the `.xlsx` file, built from a set of colors so that all sheets look the same and an app can use its own
+ * brand colors.
+ * @author Manoel Campos
+ */
+/** Colors of the `.xlsx` file, in the Excel ARGB format (e.g. `FF055087`). */
+export type XlsxColors = {
+    /** Title, table header background and links. */
+    primary: string;
+    /** Background of the even rows (zebra stripes). */
+    primaryLight: string;
+    /** Text of the table header. */
+    headerText: string;
+    /** Table borders. */
+    border: string;
+    /** Secondary texts: generation date, info labels and footer. */
+    secondaryText: string;
+    /** Cells with an invalid result. */
+    invalid: string;
+};
+/** Default colors: a dark blue primary color with a light blue zebra. */
+export declare const DEFAULT_XLSX_COLORS: XlsxColors;
+/** Fonts, fills and borders of the `.xlsx` file. */
+export type XlsxStyles = {
+    titleFont: Partial<Font>;
+    subtitleFont: Partial<Font>;
+    infoLabelFont: Partial<Font>;
+    headerFont: Partial<Font>;
+    invalidFont: Partial<Font>;
+    footerFont: Partial<Font>;
+    linkFont: Partial<Font>;
+    headerFill: Fill;
+    zebraFill: Fill;
+    cellBorder: Partial<Record<'top' | 'left' | 'bottom' | 'right', Partial<Border>>>;
+};
+/**
+ * Builds the styles of the `.xlsx` file from a set of colors.
+ * @param colors colors of the file; the ones not given use {@link DEFAULT_XLSX_COLORS}
+ * @return the fonts, fills and borders of the file
+ */
+export declare function xlsxStyles(colors?: Partial<XlsxColors>): XlsxStyles;
+/** Height of the logo in the header (px). The width follows the aspect ratio of the image. */
+export declare const LOGO_HEIGHT = 48;
+/** Header rows taken by the logo, so the text is not placed under it. */
+export declare const LOGO_ROWS = 3;
+/** Minimum and maximum width of a column, in characters. */
+export declare const MIN_COLUMN_WIDTH = 8;
+export declare const MAX_COLUMN_WIDTH = 60;
+/** Room added to the longest text of the column, in characters, so the text does not touch the border. */
+export declare const COLUMN_PADDING = 2;

package/dist/export/xlsx/XlsxStyle.js

@@ -0,0 +1,87 @@
+"use client";
+// src/export/xlsx/XlsxStyle.ts
+/** Default colors: a dark blue primary color with a light blue zebra. */
+var DEFAULT_XLSX_COLORS = {
+	primary: "FF055087",
+	primaryLight: "FFF0F8FF",
+	headerText: "FFFFFFFF",
+	border: "FFD0D7DE",
+	secondaryText: "FF5F6B7A",
+	invalid: "FFC92A2A"
+};
+/**
+* Builds the styles of the `.xlsx` file from a set of colors.
+* @param colors colors of the file; the ones not given use {@link DEFAULT_XLSX_COLORS}
+* @return the fonts, fills and borders of the file
+*/
+function xlsxStyles(colors = {}) {
+	const color = {
+		...DEFAULT_XLSX_COLORS,
+		...colors
+	};
+	const thinBorder = {
+		style: "thin",
+		color: { argb: color.border }
+	};
+	return {
+		titleFont: {
+			size: 16,
+			bold: true,
+			color: { argb: color.primary }
+		},
+		subtitleFont: {
+			size: 10,
+			italic: true,
+			color: { argb: color.secondaryText }
+		},
+		infoLabelFont: {
+			bold: true,
+			color: { argb: color.secondaryText }
+		},
+		headerFont: {
+			bold: true,
+			color: { argb: color.headerText }
+		},
+		invalidFont: {
+			bold: true,
+			color: { argb: color.invalid }
+		},
+		footerFont: {
+			size: 9,
+			color: { argb: color.secondaryText }
+		},
+		linkFont: {
+			size: 9,
+			underline: true,
+			color: { argb: color.primary }
+		},
+		headerFill: {
+			type: "pattern",
+			pattern: "solid",
+			fgColor: { argb: color.primary }
+		},
+		zebraFill: {
+			type: "pattern",
+			pattern: "solid",
+			fgColor: { argb: color.primaryLight }
+		},
+		cellBorder: {
+			top: thinBorder,
+			left: thinBorder,
+			bottom: thinBorder,
+			right: thinBorder
+		}
+	};
+}
+/** Height of the logo in the header (px). The width follows the aspect ratio of the image. */
+var LOGO_HEIGHT = 48;
+/** Header rows taken by the logo, so the text is not placed under it. */
+var LOGO_ROWS = 3;
+/** Minimum and maximum width of a column, in characters. */
+var MIN_COLUMN_WIDTH = 8;
+var MAX_COLUMN_WIDTH = 60;
+/** Room added to the longest text of the column, in characters, so the text does not touch the border. */
+var COLUMN_PADDING = 2;
+export { COLUMN_PADDING, DEFAULT_XLSX_COLORS, LOGO_HEIGHT, LOGO_ROWS, MAX_COLUMN_WIDTH, MIN_COLUMN_WIDTH, xlsxStyles };
+
+//# sourceMappingURL=XlsxStyle.js.map

package/dist/export/xlsx/XlsxStyle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"XlsxStyle.js","names":[],"sources":["../../../src/export/xlsx/XlsxStyle.ts"],"sourcesContent":["import type { Border, Fill, Font } from 'exceljs';\n\n/**\n * Styles of the `.xlsx` file, built from a set of colors so that all sheets look the same and an app can use its own\n * brand colors.\n * @author Manoel Campos\n */\n\n/** Colors of the `.xlsx` file, in the Excel ARGB format (e.g. `FF055087`). */\nexport type XlsxColors = {\n    /** Title, table header background and links. */\n    primary: string;\n\n    /** Background of the even rows (zebra stripes). */\n    primaryLight: string;\n\n    /** Text of the table header. */\n    headerText: string;\n\n    /** Table borders. */\n    border: string;\n\n    /** Secondary texts: generation date, info labels and footer. */\n    secondaryText: string;\n\n    /** Cells with an invalid result. */\n    invalid: string;\n};\n\n/** Default colors: a dark blue primary color with a light blue zebra. */\nexport const DEFAULT_XLSX_COLORS: XlsxColors = {\n    primary: 'FF055087',\n    primaryLight: 'FFF0F8FF',\n    headerText: 'FFFFFFFF',\n    border: 'FFD0D7DE',\n    secondaryText: 'FF5F6B7A',\n    invalid: 'FFC92A2A'\n};\n\n/** Fonts, fills and borders of the `.xlsx` file. */\nexport type XlsxStyles = {\n    titleFont: Partial<Font>;\n    subtitleFont: Partial<Font>;\n    infoLabelFont: Partial<Font>;\n    headerFont: Partial<Font>;\n    invalidFont: Partial<Font>;\n    footerFont: Partial<Font>;\n    linkFont: Partial<Font>;\n    headerFill: Fill;\n    zebraFill: Fill;\n    cellBorder: Partial<Record<'top' | 'left' | 'bottom' | 'right', Partial<Border>>>;\n};\n\n/**\n * Builds the styles of the `.xlsx` file from a set of colors.\n * @param colors colors of the file; the ones not given use {@link DEFAULT_XLSX_COLORS}\n * @return the fonts, fills and borders of the file\n */\nexport function xlsxStyles(colors: Partial<XlsxColors> = {}): XlsxStyles {\n    const color = { ...DEFAULT_XLSX_COLORS, ...colors };\n    const thinBorder: Partial<Border> = { style: 'thin', color: { argb: color.border } };\n\n    return {\n        titleFont: { size: 16, bold: true, color: { argb: color.primary } },\n        subtitleFont: { size: 10, italic: true, color: { argb: color.secondaryText } },\n        infoLabelFont: { bold: true, color: { argb: color.secondaryText } },\n        headerFont: { bold: true, color: { argb: color.headerText } },\n        invalidFont: { bold: true, color: { argb: color.invalid } },\n        footerFont: { size: 9, color: { argb: color.secondaryText } },\n        linkFont: { size: 9, underline: true, color: { argb: color.primary } },\n        headerFill: { type: 'pattern', pattern: 'solid', fgColor: { argb: color.primary } },\n        zebraFill: { type: 'pattern', pattern: 'solid', fgColor: { argb: color.primaryLight } },\n        cellBorder: { top: thinBorder, left: thinBorder, bottom: thinBorder, right: thinBorder }\n    };\n}\n\n/** Height of the logo in the header (px). The width follows the aspect ratio of the image. */\nexport const LOGO_HEIGHT = 48;\n\n/** Header rows taken by the logo, so the text is not placed under it. */\nexport const LOGO_ROWS = 3;\n\n/** Minimum and maximum width of a column, in characters. */\nexport const MIN_COLUMN_WIDTH = 8;\nexport const MAX_COLUMN_WIDTH = 60;\n\n/** Room added to the longest text of the column, in characters, so the text does not touch the border. */\nexport const COLUMN_PADDING = 2;\n"],"mappings":";;;AA8BA,IAAa,sBAAkC;CAC3C,SAAS;CACT,cAAc;CACd,YAAY;CACZ,QAAQ;CACR,eAAe;CACf,SAAS;AACb;;;;;;AAqBA,SAAgB,WAAW,SAA8B,CAAC,GAAe;CACrE,MAAM,QAAQ;EAAE,GAAG;EAAqB,GAAG;CAAO;CAClD,MAAM,aAA8B;EAAE,OAAO;EAAQ,OAAO,EAAE,MAAM,MAAM,OAAO;CAAE;CAEnF,OAAO;EACH,WAAW;GAAE,MAAM;GAAI,MAAM;GAAM,OAAO,EAAE,MAAM,MAAM,QAAQ;EAAE;EAClE,cAAc;GAAE,MAAM;GAAI,QAAQ;GAAM,OAAO,EAAE,MAAM,MAAM,cAAc;EAAE;EAC7E,eAAe;GAAE,MAAM;GAAM,OAAO,EAAE,MAAM,MAAM,cAAc;EAAE;EAClE,YAAY;GAAE,MAAM;GAAM,OAAO,EAAE,MAAM,MAAM,WAAW;EAAE;EAC5D,aAAa;GAAE,MAAM;GAAM,OAAO,EAAE,MAAM,MAAM,QAAQ;EAAE;EAC1D,YAAY;GAAE,MAAM;GAAG,OAAO,EAAE,MAAM,MAAM,cAAc;EAAE;EAC5D,UAAU;GAAE,MAAM;GAAG,WAAW;GAAM,OAAO,EAAE,MAAM,MAAM,QAAQ;EAAE;EACrE,YAAY;GAAE,MAAM;GAAW,SAAS;GAAS,SAAS,EAAE,MAAM,MAAM,QAAQ;EAAE;EAClF,WAAW;GAAE,MAAM;GAAW,SAAS;GAAS,SAAS,EAAE,MAAM,MAAM,aAAa;EAAE;EACtF,YAAY;GAAE,KAAK;GAAY,MAAM;GAAY,QAAQ;GAAY,OAAO;EAAW;CAC3F;AACJ;;AAGA,IAAa,cAAc;;AAG3B,IAAa,YAAY;;AAGzB,IAAa,mBAAmB;AAChC,IAAa,mBAAmB;;AAGhC,IAAa,iBAAiB"}