@cj-tech-master/excelts 6.2.0 → 7.0.0

package/dist/types/index.browser.d.ts

@@ -37,6 +37,6 @@ export { xmlEncode, xmlDecode } from "./utils/utils.base.js";
 export { DateParser, DateFormatter, getSupportedFormats, type DateFormat } from "./utils/datetime.js";
 export { BaseError, type BaseErrorOptions, toError, errorToJSON, getErrorChain, getRootCause } from "./utils/errors.js";
 export { concatUint8Arrays, toUint8Array, stringToUint8Array, uint8ArrayToString } from "./utils/binary.js";
-export { PdfExporter, exportPdf, PageSizes, PdfError, PdfRenderError, PdfFontError, PdfStructureError, isPdfError } from "./modules/pdf/index.js";
+export { pdf, excelToPdf, PageSizes, PdfError, PdfRenderError, PdfFontError, PdfStructureError, isPdfError } from "./modules/pdf/index.js";
 export type { PdfExportOptions, PdfPageSize, PdfOrientation, PdfMargins, PageSizeName, PdfColor } from "./modules/pdf/index.js";
 export { ExcelError, isExcelError, ExcelFileError, ExcelDownloadError, ExcelNotSupportedError, ExcelStreamStateError, InvalidAddressError, ColumnOutOfBoundsError, RowOutOfBoundsError, MergeConflictError, InvalidValueTypeError, XmlParseError, WorksheetNameError, PivotTableError, TableError, ImageError, MaxItemsExceededError } from "./modules/excel/errors.js";

package/dist/types/index.d.ts

@@ -19,7 +19,7 @@ export type { PivotTable, PivotTableModel, PivotTableValue, PivotTableSource, Ca
 export type { FormCheckboxModel, FormCheckboxOptions, FormControlRange, FormControlAnchor } from "./modules/excel/form-control.js";
 export type { WorkbookReaderOptions, ParseEvent, SharedStringEvent, WorksheetReadyEvent, HyperlinksEvent } from "./modules/excel/stream/workbook-reader.js";
 export type { WorksheetReaderOptions, WorksheetEvent, RowEvent, HyperlinkEvent, WorksheetHyperlink } from "./modules/excel/stream/worksheet-reader.js";
-export type { WorkbookWriterOptions, WorkbookZipOptions, ZipOptions, ZlibOptions } from "./modules/excel/stream/workbook-writer.js";
+export type { WorkbookWriterOptions, WorkbookZipOptions, ZlibOptions } from "./modules/excel/stream/workbook-writer.js";
 export type { CsvOptions, CsvInput } from "./modules/excel/workbook.js";
 export { CsvParserStream, CsvFormatterStream, createCsvParserStream, createCsvFormatterStream } from "./modules/csv/stream/index.js";
 export { DefinedNames, type DefinedNameModel } from "./modules/excel/defined-names.js";
@@ -37,6 +37,6 @@ export { xmlEncode, xmlDecode } from "./utils/utils.base.js";
 export { DateParser, DateFormatter, getSupportedFormats, type DateFormat } from "./utils/datetime.js";
 export { BaseError, type BaseErrorOptions, toError, errorToJSON, getErrorChain, getRootCause } from "./utils/errors.js";
 export { concatUint8Arrays, toUint8Array, stringToUint8Array, uint8ArrayToString } from "./utils/binary.js";
-export { PdfExporter, exportPdf, PageSizes, PdfError, PdfRenderError, PdfFontError, PdfStructureError, isPdfError } from "./modules/pdf/index.js";
+export { pdf, excelToPdf, PageSizes, PdfError, PdfRenderError, PdfFontError, PdfStructureError, isPdfError } from "./modules/pdf/index.js";
 export type { PdfExportOptions, PdfPageSize, PdfOrientation, PdfMargins, PageSizeName, PdfColor } from "./modules/pdf/index.js";
 export { ExcelError, isExcelError, ExcelFileError, ExcelDownloadError, ExcelNotSupportedError, ExcelStreamStateError, InvalidAddressError, ColumnOutOfBoundsError, RowOutOfBoundsError, MergeConflictError, InvalidValueTypeError, XmlParseError, WorksheetNameError, PivotTableError, TableError, ImageError, MaxItemsExceededError } from "./modules/excel/errors.js";

package/dist/types/modules/excel/stream/workbook-writer.browser.d.ts

@@ -42,8 +42,6 @@ export interface WorkbookZipOptions {
         level?: number;
     };
 }
-/** @deprecated Use {@link WorkbookZipOptions} instead */
-export type ZipOptions = WorkbookZipOptions;
 export interface WorkbookWriterOptions {
     created?: Date;
     modified?: Date;

package/dist/types/modules/excel/stream/workbook-writer.d.ts

@@ -4,8 +4,8 @@
  * Extends base with file path support and file system image loading.
  */
 import { WorksheetWriter } from "./worksheet-writer.js";
-import { WorkbookWriterBase, type WorkbookWriterOptions as BaseOptions, type WorkbookZipOptions, type ZipOptions, type ZlibOptions } from "./workbook-writer.browser.js";
-export type { WorkbookZipOptions, ZipOptions, ZlibOptions };
+import { WorkbookWriterBase, type WorkbookWriterOptions as BaseOptions, type WorkbookZipOptions, type ZlibOptions } from "./workbook-writer.browser.js";
+export type { WorkbookZipOptions, ZlibOptions };
 export interface WorkbookWriterOptions extends BaseOptions {
     /** If stream not specified, this field specifies the path to a file to write the XLSX workbook to */
     filename?: string;

package/dist/types/modules/excel/types.d.ts

@@ -326,8 +326,6 @@ export interface ImageData {
     filename?: string;
     buffer?: Buffer;
 }
-/** @deprecated Use {@link ImageData} instead */
-export type Image = ImageData;
 export interface ImagePosition {
     tl: {
         col: number;

package/dist/types/modules/pdf/excel-bridge.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Excel-to-PDF Bridge
+ *
+ * Converts Excel Workbook data into the PDF module's independent data model.
+ * This is the ONLY file in the PDF module that imports from @excel.
+ *
+ * @example
+ * ```typescript
+ * import { Workbook } from "excelts";
+ * import { excelToPdf } from "excelts/pdf";
+ *
+ * const workbook = new Workbook();
+ * // ... build workbook ...
+ * const pdf = excelToPdf(workbook);
+ * ```
+ */
+import type { Workbook } from "../excel/workbook.js";
+import { type PdfExportOptions } from "./types.js";
+/**
+ * Export an Excel Workbook directly to PDF.
+ *
+ * This is a convenience function that converts the Workbook to the PDF module's
+ * data model and then generates the PDF.
+ *
+ * @param workbook - An Excel Workbook instance
+ * @param options  - PDF export options
+ * @returns PDF file as a Uint8Array
+ */
+export declare function excelToPdf(workbook: Workbook, options?: PdfExportOptions): Uint8Array;

package/dist/types/modules/pdf/index.d.ts

@@ -1,39 +1,37 @@
 /**
  * PDF module for excelts.
  *
- * Provides Excel-to-PDF conversion with zero external dependencies.
- * Supports cell values, fonts, colors, borders, fills, alignment,
- * merged cells, pagination, and customizable page layout.
+ * A full-featured, zero-dependency PDF engine.
  *
- * @example
+ * @example Standalone:
  * ```typescript
- * import { Workbook, PdfExporter } from "excelts";
+ * import { pdf } from "excelts/pdf";
  *
- * const workbook = new Workbook();
- * const sheet = workbook.addWorksheet("Sales");
- * sheet.columns = [
- *   { header: "Product", key: "product", width: 20 },
- *   { header: "Revenue", key: "revenue", width: 15 }
- * ];
- * sheet.addRow({ product: "Widget", revenue: 1000 });
+ * const bytes = pdf([
+ *   ["Product", "Revenue"],
+ *   ["Widget", 1000],
+ *   ["Gadget", 2500]
+ * ]);
+ * ```
  *
- * const exporter = new PdfExporter(workbook);
- * const pdfBuffer = exporter.export({
- *   pageSize: "A4",
- *   orientation: "portrait",
- *   fitToPage: true,
- *   showGridLines: true,
- *   showPageNumbers: true
- * });
+ * @example From Excel Workbook:
+ * ```typescript
+ * import { Workbook } from "excelts";
+ * import { excelToPdf } from "excelts/pdf";
  *
- * // Write to file (Node.js)
- * import { writeFileSync } from "fs";
- * writeFileSync("output.pdf", pdfBuffer);
+ * const workbook = new Workbook();
+ * const sheet = workbook.addWorksheet("Sales");
+ * sheet.addRow(["Product", "Revenue"]);
+ * const bytes = excelToPdf(workbook);
  * ```
  *
  * @module pdf
  */
-export { PdfExporter, exportPdf } from "./render/pdf-exporter.js";
+/** Standalone PDF generation — accepts plain arrays, sheet objects, or workbooks. */
+export { pdf } from "./pdf.js";
+/** Excel-to-PDF conversion — accepts an Excel Workbook instance. */
+export { excelToPdf } from "./excel-bridge.js";
+export type { PdfCell, PdfRow, PdfColumn, PdfSheet, PdfBook, PdfImage } from "./pdf.js";
 export type { PdfExportOptions, PdfOrientation, PdfPageSize, PdfMargins, PdfColor, PageSizeName } from "./types.js";
 export { PageSizes } from "./types.js";
 export { PdfError, PdfRenderError, PdfFontError, PdfStructureError, isPdfError } from "./errors.js";

package/dist/types/modules/pdf/pdf.d.ts

@@ -0,0 +1,121 @@
+/**
+ * Simplified PDF generation API.
+ *
+ * Provides a concise way to create PDFs from plain data — no need to manually
+ * construct Map objects, compute bounds, or specify cell types.
+ *
+ * @example Simplest — pass a 2D array:
+ * ```typescript
+ * import { pdf } from "@cj-tech-master/excelts/pdf";
+ *
+ * const bytes = pdf([
+ *   ["Product", "Revenue"],
+ *   ["Widget", 1000],
+ *   ["Gadget", 2500]
+ * ]);
+ * ```
+ *
+ * @example With options:
+ * ```typescript
+ * const bytes = pdf([
+ *   ["Name", "Score"],
+ *   ["Alice", 95],
+ *   ["Bob", 87]
+ * ], { showGridLines: true, title: "Scores" });
+ * ```
+ *
+ * @example Multiple sheets:
+ * ```typescript
+ * const bytes = pdf({
+ *   sheets: [
+ *     { name: "Sales", data: [["Product", "Revenue"], ["Widget", 1000]] },
+ *     { name: "Costs", data: [["Item", "Amount"], ["Rent", 500]] }
+ *   ]
+ * });
+ * ```
+ *
+ * @example With column widths and styles:
+ * ```typescript
+ * const bytes = pdf({
+ *   name: "Report",
+ *   columns: [{ width: 25 }, { width: 15 }],
+ *   data: [
+ *     ["Product", "Revenue"],
+ *     ["Widget", "$1,000"]
+ *   ]
+ * });
+ * ```
+ */
+import { type PdfExportOptions } from "./types.js";
+/** A cell value: string, number, boolean, Date, null, or a styled cell object. */
+export type PdfCellValue = string | number | boolean | Date | null | undefined | PdfCell;
+/** A cell with an explicit value and optional style overrides. */
+export interface PdfCell {
+    value: string | number | boolean | Date | null | undefined;
+    bold?: boolean;
+    italic?: boolean;
+    fontSize?: number;
+    fontColor?: string;
+    fillColor?: string;
+    align?: "left" | "center" | "right";
+}
+/** A row is an array of cell values. */
+export type PdfRow = PdfCellValue[];
+/** Column configuration. */
+export interface PdfColumn {
+    width?: number;
+    header?: string;
+}
+/** An image to embed in a sheet. */
+export interface PdfImage {
+    /** Raw image bytes (JPEG or PNG). */
+    data: Uint8Array;
+    /** Image format. */
+    format: "jpeg" | "png";
+    /**
+     * Top-left column position (0-indexed).
+     * This is relative to the final sheet grid — if column headers are used,
+     * they occupy the first row, so data starts at row 1.
+     */
+    col: number;
+    /**
+     * Top-left row position (0-indexed).
+     * This is relative to the final sheet grid — if column headers are used,
+     * row 0 is the header row, and data rows start at row 1.
+     */
+    row: number;
+    /** Image width in pixels. */
+    width: number;
+    /** Image height in pixels. */
+    height: number;
+}
+/** A single sheet definition. */
+export interface PdfSheet {
+    name?: string;
+    columns?: (PdfColumn | number)[];
+    data: PdfRow[];
+    images?: PdfImage[];
+}
+/** A multi-sheet document definition. */
+export interface PdfBook {
+    title?: string;
+    author?: string;
+    sheets: PdfSheet[];
+}
+/**
+ * The input to {@link pdf} — can be:
+ * - A 2D array (single sheet)
+ * - A sheet object `{ name?, columns?, data, images? }`
+ * - A workbook object `{ sheets: [...] }`
+ */
+export type PdfInput = PdfRow[] | PdfSheet | PdfBook;
+/**
+ * Generate a PDF.
+ *
+ * Accepts anything from a plain 2D array to a multi-sheet workbook.
+ *
+ * @param input   - 2D array, sheet object, or workbook object
+ * @param options - PDF export options (page size, margins, etc.)
+ * @returns PDF file as Uint8Array
+ */
+export declare function pdf(input: PdfInput, options?: PdfExportOptions): Uint8Array;

package/dist/types/modules/pdf/render/layout-engine.d.ts

@@ -1,23 +1,25 @@
 /**
- * Layout engine for Excel-to-PDF conversion.
+ * Layout engine for PDF generation.
  *
- * Takes a worksheet and produces LayoutPage objects that describe exactly
+ * Takes a PdfSheetData and produces LayoutPage objects that describe exactly
  * where each cell, border, and piece of text should be drawn on each PDF page.
  *
+ * This module is fully independent of the Excel module — it works with
+ * the PDF module's own data model (PdfSheetData, PdfCellData, etc.).
+ *
  * Key responsibilities:
- * - Convert Excel column widths (character units) to PDF points
- * - Convert Excel row heights (points already, but may need scaling)
+ * - Convert column widths (character units) to PDF points
+ * - Convert row heights (points already, but may need scaling)
  * - Handle merged cells spanning multiple rows/columns
  * - Paginate content across multiple pages
  * - Handle fitToPage scaling
  * - Handle repeated header rows
  * - Skip hidden rows and columns
  */
-import type { Worksheet } from "../../excel/worksheet.js";
-import type { ResolvedPdfOptions, LayoutPage } from "../types.js";
+import type { PdfSheetData, ResolvedPdfOptions, LayoutPage } from "../types.js";
 import type { FontManager } from "../font/font-manager.js";
 /**
- * Compute the layout for a worksheet across one or more PDF pages.
+ * Compute the layout for a sheet across one or more PDF pages.
  */
-export declare function layoutWorksheet(worksheet: Worksheet, options: ResolvedPdfOptions, fontManager: FontManager): LayoutPage[];
+export declare function layoutSheet(sheet: PdfSheetData, options: ResolvedPdfOptions, fontManager: FontManager): LayoutPage[];
 export declare function paginateRows(rowHeights: number[], availableHeight: number, repeatRowCount: number, rowBreaks: Set<number>): number[][];

package/dist/types/modules/pdf/render/pdf-exporter.d.ts

@@ -1,72 +1,19 @@
 /**
- * PDF Exporter - Main orchestrator for Excel-to-PDF conversion.
+ * PDF Exporter - Main orchestrator for PDF document generation.
  *
  * Coordinates the layout engine, page renderer, font manager, and PDF writer
- * to produce a complete PDF document from an Excel workbook.
+ * to produce a complete PDF document from a PdfWorkbook data structure.
  *
- * @example
- * ```typescript
- * import { Workbook, PdfExporter } from "excelts";
- *
- * const workbook = new Workbook();
- * // ... populate workbook ...
- *
- * const exporter = new PdfExporter(workbook);
- * const pdfBuffer = exporter.export({ fitToPage: true });
- * ```
- */
-import type { Worksheet } from "../../excel/worksheet.js";
-import type { WorksheetState } from "../../excel/types.js";
-import { type PdfExportOptions } from "../types.js";
-/**
- * Minimal interface for a workbook to avoid tight coupling.
- * The actual Workbook class satisfies this interface.
- */
-interface WorkbookLike {
-    worksheets: WorksheetLike[];
-    title: string;
-    creator?: string;
-    subject: string;
-}
-/**
- * Minimal interface for a worksheet within the WorkbookLike.
+ * This module is fully independent of the Excel module.
+ * It is used internally by the public `pdf()` and `excelToPdf()` APIs.
  */
-type WorksheetLike = Worksheet & {
-    state: WorksheetState;
-};
+import { type PdfWorkbook, type PdfExportOptions } from "../types.js";
 /**
- * Export a workbook to PDF format.
+ * Export a PdfWorkbook to PDF format.
  *
- * @param workbook - The workbook to export
+ * @param workbook - The workbook data to export
  * @param options - Export options controlling layout, pagination, and appearance
  * @returns PDF file as a Uint8Array
- * @throws {PdfError} If the workbook has no worksheets or export fails
- *
- * @example
- * ```typescript
- * const pdf = exportPdf(workbook, { fitToPage: true, showGridLines: true });
- * ```
- */
-export declare function exportPdf(workbook: WorkbookLike, options?: PdfExportOptions): Uint8Array;
-/**
- * Class-based API for PDF export (wraps {@link exportPdf}).
- *
- * @example
- * ```typescript
- * const exporter = new PdfExporter(workbook);
- * const pdfBuffer = exporter.export({ fitToPage: true });
- * ```
+ * @throws {PdfError} If the workbook has no sheets or export fails
  */
-export declare class PdfExporter {
-    private workbook;
-    constructor(workbook: WorkbookLike);
-    /**
-     * Export the workbook as a PDF document.
-     *
-     * @param options - Export options controlling layout, pagination, and appearance
-     * @returns PDF file as a Uint8Array
-     * @throws {PdfError} If the workbook has no worksheets or export fails
-     */
-    export(options?: PdfExportOptions): Uint8Array;
-}
-export {};
+export declare function exportPdf(workbook: PdfWorkbook, options?: PdfExportOptions): Uint8Array;

package/dist/types/modules/pdf/render/style-converter.d.ts

@@ -1,22 +1,24 @@
 /**
- * Converts Excel styles to PDF rendering parameters.
+ * Converts input styles to PDF rendering parameters.
  *
- * Maps Excel font, color, border, fill, and alignment properties
+ * Maps font, color, border, fill, and alignment properties
  * to their PDF equivalents for the layout engine and page renderer.
+ *
+ * This module is fully independent of the Excel module — it works with
+ * the PDF module's own style interfaces (PdfFontStyle, PdfFillData, etc.).
  */
-import type { PdfColor, LayoutBorders } from "../types.js";
-import type { Font, Color, Fill, Borders, Alignment } from "../../excel/types.js";
+import type { PdfColor, LayoutBorders, PdfColorData, PdfFontStyle, PdfFillData, PdfBordersData, PdfAlignmentData } from "../types.js";
 /**
- * Convert an Excel ARGB color string to PDF RGB color.
- * Excel uses "AARRGGBB" format (e.g., "FF000000" for black).
+ * Convert an ARGB color string to PDF RGB color.
+ * Handles "AARRGGBB" (8-char) and "RRGGBB" (6-char) formats.
  * PDF uses 0-1 floats for each component.
  */
 export declare function argbToPdfColor(argb: string | undefined): PdfColor | null;
 /**
- * Convert an Excel Color object to PDF color.
+ * Convert a color data object to PDF color.
  * Handles both ARGB and theme-based colors.
  */
-export declare function excelColorToPdf(color: Partial<Color> | undefined): PdfColor | null;
+export declare function excelColorToPdf(color: Partial<PdfColorData> | undefined): PdfColor | null;
 /**
  * Apply a tint value to a color.
  * Tint range: -1.0 (fully dark) to +1.0 (fully light).
@@ -34,9 +36,9 @@ export declare const DEFAULT_COLORS: {
     gridLine: PdfColor;
 };
 /**
- * Extract font properties from an Excel font for PDF rendering.
+ * Extract font properties for PDF rendering.
  */
-export declare function extractFontProperties(font: Partial<Font> | undefined, defaultFamily: string, defaultSize: number): {
+export declare function extractFontProperties(font: Partial<PdfFontStyle> | undefined, defaultFamily: string, defaultSize: number): {
     fontFamily: string;
     fontSize: number;
     bold: boolean;
@@ -46,20 +48,20 @@ export declare function extractFontProperties(font: Partial<Font> | undefined, d
     textColor: PdfColor;
 };
 /**
- * Convert an Excel fill to a PDF background color.
+ * Convert a fill to a PDF background color.
  * Only pattern fills with "solid" pattern are supported as PDF backgrounds.
  * Other patterns are approximated or ignored.
  */
-export declare function excelFillToPdfColor(fill: Fill | undefined): PdfColor | null;
+export declare function excelFillToPdfColor(fill: PdfFillData | undefined): PdfColor | null;
 /**
- * Convert Excel Borders to PDF LayoutBorders.
+ * Convert border data to PDF LayoutBorders.
  */
-export declare function excelBordersToPdf(borders: Partial<Borders> | undefined): LayoutBorders;
+export declare function excelBordersToPdf(borders: Partial<PdfBordersData> | undefined): LayoutBorders;
 /**
- * Convert Excel horizontal alignment to PDF alignment.
+ * Convert horizontal alignment to PDF alignment.
  */
-export declare function excelHAlignToPdf(alignment: Partial<Alignment> | undefined): "left" | "center" | "right";
+export declare function excelHAlignToPdf(alignment: Partial<PdfAlignmentData> | undefined): "left" | "center" | "right";
 /**
- * Convert Excel vertical alignment to PDF alignment.
+ * Convert vertical alignment to PDF alignment.
  */
-export declare function excelVAlignToPdf(alignment: Partial<Alignment> | undefined): "top" | "middle" | "bottom";
+export declare function excelVAlignToPdf(alignment: Partial<PdfAlignmentData> | undefined): "top" | "middle" | "bottom";