ooxml-core 0.3.0 → 0.4.0

package/dist/xlsx/layout/types.d.ts

@@ -0,0 +1,106 @@
+import type { CellRange } from '../address.js';
+import type { DifferentialStyle, PatternType } from '../model.js';
+/** A font ready to paint. */
+export interface FontView {
+    family: string;
+    /** CSS pixels at 100% zoom (points * 4/3). */
+    sizePx: number;
+    bold: boolean;
+    italic: boolean;
+    underline?: 'single' | 'double';
+    strike: boolean;
+    /** `#RRGGBB`. */
+    color: string;
+    vertAlign?: 'super' | 'sub';
+}
+export interface EdgeView {
+    widthPx: number;
+    style: 'solid' | 'dashed' | 'dotted' | 'double';
+    color: string;
+}
+export type FillView = {
+    background: string;
+} | {
+    gradient: string;
+} | {
+    pattern: PatternType;
+    fg: string;
+    bg: string;
+};
+export interface BordersView {
+    top?: EdgeView;
+    right?: EdgeView;
+    bottom?: EdgeView;
+    left?: EdgeView;
+    diagonalUp?: EdgeView;
+    diagonalDown?: EdgeView;
+}
+export type HAlignView = 'left' | 'center' | 'right' | 'justify' | 'fill' | 'centerContinuous' | 'distributed';
+export type VAlignView = 'top' | 'center' | 'bottom' | 'justify' | 'distributed';
+export interface DataBarView {
+    /** 0..1 bar length relative to the cell's width. */
+    fraction: number;
+    color: string;
+    negative?: boolean;
+}
+export interface IconView {
+    /** Icon set name (`3TrafficLights1`, `5Arrows`, ...). */
+    set: string;
+    /** 0 is the lowest bucket. */
+    index: number;
+}
+export interface CellView {
+    /** Display text (number formats applied; empty when a CF rule hides the value). */
+    text: string;
+    /** Tooltip: the hyperlink's tooltip or target. */
+    title?: string;
+    font: FontView;
+    fill?: FillView;
+    borders: BordersView;
+    hAlign: HAlignView;
+    vAlign: VAlignView;
+    wrap: boolean;
+    shrink: boolean;
+    indentPx: number;
+    /** Degrees counter-clockwise, -90..90 (0 for vertical stacked text, see `verticalText`). */
+    rotation: number;
+    /** Stacked vertical text (`textRotation` 255). */
+    verticalText?: boolean;
+    isNumber: boolean;
+    /** Text may spill into empty neighbours (see `overflowExtent`). */
+    overflow: boolean;
+    dataBar?: DataBarView;
+    icon?: IconView;
+    hasComment: boolean;
+    hasHyperlink: boolean;
+    /** A list data validation with an in-cell drop-down covers the cell. */
+    validationList: boolean;
+    isError: boolean;
+    /** Rich text runs, each with its fully resolved font. */
+    rich?: {
+        text: string;
+        font: FontView;
+    }[];
+}
+/** What conditional formatting contributes to one cell. */
+export interface ConditionalFormatResult {
+    /** Merged differential format of every matching rule (higher priority wins per property). */
+    style?: DifferentialStyle;
+    dataBar?: DataBarView;
+    /** Colour-scale background, `#RRGGBB`. */
+    colorScale?: string;
+    icon?: IconView;
+    /** A data bar or icon set with `showValue="0"` hides the cell text. */
+    hideValue?: boolean;
+}
+export interface ConditionalFormatEvaluator {
+    at(row: number, col: number): ConditionalFormatResult | undefined;
+}
+export interface MergeView {
+    /** The cell is the top-left cell of a merge. */
+    anchor: boolean;
+    /** The cell is covered by a merge it does not anchor (paint nothing). */
+    hidden: boolean;
+    range?: CellRange;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/xlsx/layout/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/xlsx/layout/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,KAAK,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAElE,6BAA6B;AAC7B,MAAM,WAAW,QAAQ;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,8CAA8C;IAC9C,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAChC,MAAM,EAAE,OAAO,CAAC;IAChB,iBAAiB;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,OAAO,GAAG,KAAK,CAAC;CAC5B;AAED,MAAM,WAAW,QAAQ;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,OAAO,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAChD,KAAK,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,QAAQ,GACjB;IAAE,UAAU,EAAE,MAAM,CAAA;CAAE,GACtB;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAY,GAC9B;IAAE,OAAO,EAAE,WAAW,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,CAAC;AAEpD,MAAM,WAAW,WAAW;IAC3B,GAAG,CAAC,EAAE,QAAQ,CAAC;IACf,KAAK,CAAC,EAAE,QAAQ,CAAC;IACjB,MAAM,CAAC,EAAE,QAAQ,CAAC;IAClB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,UAAU,CAAC,EAAE,QAAQ,CAAC;IACtB,YAAY,CAAC,EAAE,QAAQ,CAAC;CACxB;AAED,MAAM,MAAM,UAAU,GACnB,MAAM,GACN,QAAQ,GACR,OAAO,GACP,SAAS,GACT,MAAM,GACN,kBAAkB,GAClB,aAAa,CAAC;AACjB,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,aAAa,CAAC;AAEjF,MAAM,WAAW,WAAW;IAC3B,oDAAoD;IACpD,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,QAAQ;IACxB,yDAAyD;IACzD,GAAG,EAAE,MAAM,CAAC;IACZ,8BAA8B;IAC9B,KAAK,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,QAAQ;IACxB,mFAAmF;IACnF,IAAI,EAAE,MAAM,CAAC;IACb,kDAAkD;IAClD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,OAAO,EAAE,WAAW,CAAC;IACrB,MAAM,EAAE,UAAU,CAAC;IACnB,MAAM,EAAE,UAAU,CAAC;IACnB,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,OAAO,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,4FAA4F;IAC5F,QAAQ,EAAE,MAAM,CAAC;IACjB,kDAAkD;IAClD,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,QAAQ,EAAE,OAAO,CAAC;IAClB,mEAAmE;IACnE,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,UAAU,EAAE,OAAO,CAAC;IACpB,YAAY,EAAE,OAAO,CAAC;IACtB,wEAAwE;IACxE,cAAc,EAAE,OAAO,CAAC;IACxB,OAAO,EAAE,OAAO,CAAC;IACjB,yDAAyD;IACzD,IAAI,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,QAAQ,CAAA;KAAE,EAAE,CAAC;CAC1C;AAED,2DAA2D;AAC3D,MAAM,WAAW,uBAAuB;IACvC,6FAA6F;IAC7F,KAAK,CAAC,EAAE,iBAAiB,CAAC;IAC1B,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,0CAA0C;IAC1C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,uEAAuE;IACvE,SAAS,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,0BAA0B;IAC1C,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,uBAAuB,GAAG,SAAS,CAAC;CAClE;AAED,MAAM,WAAW,SAAS;IACzB,gDAAgD;IAChD,MAAM,EAAE,OAAO,CAAC;IAChB,yEAAyE;IACzE,MAAM,EAAE,OAAO,CAAC;IAChB,KAAK,CAAC,EAAE,SAAS,CAAC;CAClB"}

package/dist/xlsx/layout/units.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Excel's column and row size conversions. Column widths in SpreadsheetML (`<col width>`,
+ * `defaultColWidth`) are "file widths": characters of the default font's maximum digit width
+ * *including* the 5 px cell padding. The width Excel shows in its UI ("8.43") excludes the padding;
+ * {@link charactersToColumnWidth} and {@link pixelsToCharacters} convert that one.
+ */
+/** Maximum digit width in pixels of 11pt Calibri at 96 dpi, Excel's default font. */
+export declare const DEFAULT_MAX_DIGIT_WIDTH = 7;
+/** Excel's default `baseColWidth` (characters) when a sheet records no `defaultColWidth`. */
+export declare const DEFAULT_BASE_COL_WIDTH = 8;
+/** Pixels of left plus right cell padding Excel adds to every column. */
+export declare const COLUMN_PADDING_PX = 5;
+/** Pixels per indent level at 100% zoom with the default font (Excel uses about three spaces). */
+export declare const INDENT_PX_PER_LEVEL = 9;
+/**
+ * Pixels of a column with file width `width`:
+ * `Truncate(((256 * width + Truncate(128 / mdw)) / 256) * mdw)` (ECMA-376 Part 1, 18.3.1.13).
+ */
+export declare function columnWidthToPixels(width: number, mdw?: number): number;
+/** The file width that renders as `px` pixels: `Truncate(px / mdw * 256) / 256`. */
+export declare function pixelsToColumnWidth(px: number, mdw?: number): number;
+/**
+ * The file width for a width typed in Excel's column-width dialog (characters without padding):
+ * `Truncate((chars * mdw + 5) / mdw * 256) / 256`. `8.43` gives `9.140625`.
+ */
+export declare function charactersToColumnWidth(chars: number, mdw?: number): number;
+/** Pixels of a column `chars` characters wide as Excel's UI counts them (`8.43` -> 64 at mdw 7). */
+export declare const charactersToPixels: (chars: number, mdw?: number) => number;
+/** The width Excel's UI shows for a column of `px` pixels: `Truncate((px - 5) / mdw * 100 + 0.5) / 100`. */
+export declare function pixelsToCharacters(px: number, mdw?: number): number;
+/** The default column width in pixels for a sheet, from its `defaultColWidth` file width or from `baseColWidth`. */
+export declare function defaultColumnPixels(defaultColWidth: number | undefined, mdw?: number, baseColWidth?: number): number;
+/** Points to whole pixels at 96 dpi (`15` -> `20`). */
+export declare const pointsToPixels: (pt: number) => number;
+/** Pixels at 96 dpi to points (`20` -> `15`). */
+export declare const pixelsToPoints: (px: number) => number;
+//# sourceMappingURL=units.d.ts.map

package/dist/xlsx/layout/units.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"units.d.ts","sourceRoot":"","sources":["../../../src/xlsx/layout/units.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,qFAAqF;AACrF,eAAO,MAAM,uBAAuB,IAAI,CAAC;AAEzC,6FAA6F;AAC7F,eAAO,MAAM,sBAAsB,IAAI,CAAC;AAExC,yEAAyE;AACzE,eAAO,MAAM,iBAAiB,IAAI,CAAC;AAEnC,kGAAkG;AAClG,eAAO,MAAM,mBAAmB,IAAI,CAAC;AAIrC;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,SAA0B,GAAG,MAAM,CAGxF;AAED,oFAAoF;AACpF,wBAAgB,mBAAmB,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,SAA0B,GAAG,MAAM,CAGrF;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,SAA0B,GAAG,MAAM,CAG5F;AAED,oGAAoG;AACpG,eAAO,MAAM,kBAAkB,GAAI,OAAO,MAAM,EAAE,YAA6B,KAAG,MACpB,CAAC;AAE/D,4GAA4G;AAC5G,wBAAgB,kBAAkB,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,SAA0B,GAAG,MAAM,CAGpF;AAED,oHAAoH;AACpH,wBAAgB,mBAAmB,CAClC,eAAe,EAAE,MAAM,GAAG,SAAS,EACnC,GAAG,SAA0B,EAC7B,YAAY,SAAyB,GACnC,MAAM,CAKR;AAED,uDAAuD;AACvD,eAAO,MAAM,cAAc,GAAI,IAAI,MAAM,KAAG,MAAmD,CAAC;AAEhG,iDAAiD;AACjD,eAAO,MAAM,cAAc,GAAI,IAAI,MAAM,KAAG,MAAwB,CAAC"}

package/dist/xlsx/layout/viewport.d.ts

@@ -0,0 +1,27 @@
+import type { FreezePane } from '../model.js';
+import type { GridMetrics } from './metrics.js';
+/**
+ * The scrollable pane's scroll offsets and the size of the whole cell area (frozen panes included),
+ * in pixels, excluding row and column headers.
+ */
+export interface Viewport {
+    scrollLeft: number;
+    scrollTop: number;
+    width: number;
+    height: number;
+}
+export interface VisibleCells {
+    /** Scrolling rows in view, ascending, hidden rows left out. */
+    rows: number[];
+    cols: number[];
+    /** Frozen rows / columns (always painted), hidden ones left out. */
+    frozenRows: number[];
+    frozenCols: number[];
+}
+/**
+ * The rows and columns to paint. With frozen panes, `scrollTop`/`scrollLeft` scroll only the area
+ * below and right of the frozen rows and columns, exactly like Excel; the first scrolling row is
+ * the one at `rowTop(freeze.rows) + scrollTop`.
+ */
+export declare function visibleCells(metrics: GridMetrics, viewport: Viewport, freeze?: FreezePane): VisibleCells;
+//# sourceMappingURL=viewport.d.ts.map

package/dist/xlsx/layout/viewport.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"viewport.d.ts","sourceRoot":"","sources":["../../../src/xlsx/layout/viewport.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAEhD;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,YAAY;IAC5B,+DAA+D;IAC/D,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,oEAAoE;IACpE,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,UAAU,EAAE,MAAM,EAAE,CAAC;CACrB;AA+BD;;;;GAIG;AACH,wBAAgB,YAAY,CAC3B,OAAO,EAAE,WAAW,EACpB,QAAQ,EAAE,QAAQ,EAClB,MAAM,CAAC,EAAE,UAAU,GACjB,YAAY,CA+Bd"}

package/dist/xlsx/load/csv.d.ts

@@ -0,0 +1,29 @@
+import type { Workbook } from '../model.js';
+export interface CsvOptions {
+    /** Field delimiter; detected from the text when omitted. */
+    delimiter?: string;
+}
+/**
+ * The delimiter that splits the most lines into the same, non-zero number of fields. On a tie,
+ * tab beats semicolon beats comma: a consistent semicolon or tab is the separator, while commas
+ * then are usually decimal separators or text.
+ */
+export declare function detectDelimiter(text: string): string;
+/** Parses CSV text into rows of fields. A trailing line break does not add an empty row. */
+export declare function parseCsv(input: string, options?: CsvOptions): string[][];
+/** A valid sheet name derived from a file name (`report.csv` -> `report`). */
+export declare function sheetNameFromFileName(fileName: string | undefined): string;
+export interface CsvWorkbookOptions extends CsvOptions {
+    sheetName?: string;
+}
+/**
+ * A one-sheet workbook from CSV text. Each field goes through `parseCellInput`, so numbers,
+ * dates, percentages, booleans, errors and `=` formulas become typed cells as Excel opens them.
+ */
+export declare function csvToWorkbook(text: string, options?: CsvWorkbookOptions): Workbook;
+/**
+ * One sheet as CSV: each cell's formatted display text (as Excel's CSV export writes it), rows
+ * from A1 to the end of the used range padded to the same width, CRLF line endings.
+ */
+export declare function sheetToCsv(workbook: Workbook, sheetIndex: number, options?: CsvOptions): string;
+//# sourceMappingURL=csv.d.ts.map

package/dist/xlsx/load/csv.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"csv.d.ts","sourceRoot":"","sources":["../../../src/xlsx/load/csv.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAQ,QAAQ,EAAE,MAAM,aAAa,CAAC;AAKlD,MAAM,WAAW,UAAU;IAC1B,4DAA4D;IAC5D,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB;AAyBD;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAepD;AAKD,4FAA4F;AAC5F,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,UAAe,GAAG,MAAM,EAAE,EAAE,CA4C5E;AAKD,8EAA8E;AAC9E,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CAQ1E;AAED,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACrD,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,kBAAuB,GAAG,QAAQ,CAkCtF;AAMD;;;GAGG;AACH,wBAAgB,UAAU,CACzB,QAAQ,EAAE,QAAQ,EAClB,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE,UAAe,GACtB,MAAM,CAsBR"}

package/dist/xlsx/load/detect.d.ts

@@ -0,0 +1,22 @@
+import type { Workbook } from '../model.js';
+export type WorkbookFormat = 'xlsx' | 'xlsm' | 'xls' | 'csv';
+/** Sniffs a spreadsheet's format from its bytes (and, for macro-enabled packages, its name). */
+export declare function detectWorkbookFormat(input: Uint8Array | ArrayBuffer, fileName?: string): WorkbookFormat;
+/** Decodes CSV bytes: UTF-8 (with or without BOM) or UTF-16 with a BOM. */
+export declare function decodeText(bytes: Uint8Array): string;
+export interface LoadWorkbookOptions {
+    /** The file name, used for the CSV sheet name and to recognise macro-enabled packages. */
+    fileName?: string;
+    /** CSV field delimiter; detected when omitted. */
+    delimiter?: string;
+}
+/** Loads any supported spreadsheet: .xlsx, .xlsm, .xltx, .xls or CSV. */
+export declare function loadWorkbook(input: Uint8Array | ArrayBuffer, options?: LoadWorkbookOptions): Promise<Workbook>;
+/**
+ * Serializes a workbook. `'xlsx'` writes the whole workbook as an OOXML package (an .xls or CSV
+ * source is converted: the result is always .xlsx/.xlsm content); `'csv'` writes one sheet
+ * (`sheetIndex`, default the active sheet) as UTF-8 CSV with a byte-order mark, as Excel's
+ * "CSV UTF-8" does.
+ */
+export declare function saveWorkbook(workbook: Workbook, format: 'xlsx' | 'csv', sheetIndex?: number): Promise<Uint8Array>;
+//# sourceMappingURL=detect.d.ts.map

package/dist/xlsx/load/detect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"detect.d.ts","sourceRoot":"","sources":["../../../src/xlsx/load/detect.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAM5C,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,CAAC;AAgD7D,gGAAgG;AAChG,wBAAgB,oBAAoB,CACnC,KAAK,EAAE,UAAU,GAAG,WAAW,EAC/B,QAAQ,CAAC,EAAE,MAAM,GACf,cAAc,CAShB;AAED,2EAA2E;AAC3E,wBAAgB,UAAU,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAOpD;AAED,MAAM,WAAW,mBAAmB;IACnC,0FAA0F;IAC1F,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kDAAkD;IAClD,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,yEAAyE;AACzE,wBAAsB,YAAY,CACjC,KAAK,EAAE,UAAU,GAAG,WAAW,EAC/B,OAAO,GAAE,mBAAwB,GAC/B,OAAO,CAAC,QAAQ,CAAC,CAanB;AAED;;;;;GAKG;AACH,wBAAsB,YAAY,CACjC,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,MAAM,GAAG,KAAK,EACtB,UAAU,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,UAAU,CAAC,CAIrB"}