@cj-tech-master/excelts 4.0.0 → 4.0.1

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

@@ -0,0 +1,518 @@
+/**
+ * Type definitions for ExcelTS
+ * This file exports all public types used by the library
+ */
+export type Buffer = Uint8Array;
+export declare enum PaperSize {
+    Legal = 5,
+    Executive = 7,
+    A4 = 9,
+    A5 = 11,
+    B5 = 13,
+    Envelope_10 = 20,
+    Envelope_DL = 27,
+    Envelope_C5 = 28,
+    Envelope_B5 = 34,
+    Envelope_Monarch = 37,
+    Double_Japan_Postcard_Rotated = 82,
+    K16_197x273_mm = 119
+}
+export interface Color {
+    argb: string;
+    theme: number;
+}
+export interface Font {
+    name: string;
+    size: number;
+    family: number;
+    scheme: "minor" | "major" | "none";
+    charset: number;
+    color: Partial<Color>;
+    bold: boolean;
+    italic: boolean;
+    underline: boolean | "none" | "single" | "double" | "singleAccounting" | "doubleAccounting";
+    vertAlign: "superscript" | "subscript";
+    strike: boolean;
+    outline: boolean;
+}
+export interface Alignment {
+    horizontal: "left" | "center" | "right" | "fill" | "justify" | "centerContinuous" | "distributed";
+    vertical: "top" | "middle" | "bottom" | "distributed" | "justify";
+    wrapText: boolean;
+    shrinkToFit: boolean;
+    indent: number;
+    readingOrder: "rtl" | "ltr";
+    textRotation: number | "vertical";
+}
+export interface Protection {
+    locked: boolean;
+    hidden: boolean;
+}
+export type BorderStyle = "thin" | "dotted" | "hair" | "medium" | "double" | "thick" | "dashed" | "dashDot" | "dashDotDot" | "slantDashDot" | "mediumDashed" | "mediumDashDotDot" | "mediumDashDot";
+export interface Border {
+    style: BorderStyle;
+    color: Partial<Color>;
+}
+export interface BorderDiagonal extends Border {
+    up: boolean;
+    down: boolean;
+}
+export interface Borders {
+    top: Partial<Border>;
+    left: Partial<Border>;
+    bottom: Partial<Border>;
+    right: Partial<Border>;
+    diagonal: Partial<BorderDiagonal>;
+}
+export type FillPatterns = "none" | "solid" | "darkVertical" | "darkHorizontal" | "darkGrid" | "darkTrellis" | "darkDown" | "darkUp" | "lightVertical" | "lightHorizontal" | "lightGrid" | "lightTrellis" | "lightDown" | "lightUp" | "darkGray" | "mediumGray" | "lightGray" | "gray125" | "gray0625";
+export interface FillPattern {
+    type: "pattern";
+    pattern: FillPatterns;
+    fgColor?: Partial<Color>;
+    bgColor?: Partial<Color>;
+}
+export interface GradientStop {
+    position: number;
+    color: Partial<Color>;
+}
+export interface FillGradientAngle {
+    type: "gradient";
+    gradient: "angle";
+    degree: number;
+    stops: GradientStop[];
+}
+export interface FillGradientPath {
+    type: "gradient";
+    gradient: "path";
+    center: {
+        left: number;
+        top: number;
+    };
+    stops: GradientStop[];
+}
+export type Fill = FillPattern | FillGradientAngle | FillGradientPath;
+export interface NumFmt {
+    id: number;
+    formatCode: string;
+}
+interface StyleBase {
+    font: Partial<Font>;
+    alignment: Partial<Alignment>;
+    protection: Partial<Protection>;
+    border: Partial<Borders>;
+    fill: Fill;
+}
+export interface StyleInput extends StyleBase {
+    numFmt: string;
+}
+export interface StyleOutput extends StyleBase {
+    numFmt: NumFmt;
+}
+export interface Style extends StyleBase {
+    numFmt: string | NumFmt;
+}
+export interface Margins {
+    top: number;
+    left: number;
+    bottom: number;
+    right: number;
+    header: number;
+    footer: number;
+}
+export interface PageSetup {
+    margins: Margins;
+    orientation: "portrait" | "landscape";
+    horizontalDpi: number;
+    verticalDpi: number;
+    fitToPage: boolean;
+    fitToWidth: number;
+    fitToHeight: number;
+    scale: number;
+    pageOrder: "downThenOver" | "overThenDown";
+    blackAndWhite: boolean;
+    draft: boolean;
+    cellComments: "atEnd" | "asDisplayed" | "None";
+    errors: "dash" | "blank" | "NA" | "displayed";
+    paperSize: PaperSize;
+    showRowColHeaders: boolean;
+    showGridLines: boolean;
+    firstPageNumber: number;
+    horizontalCentered: boolean;
+    verticalCentered: boolean;
+    printArea: string;
+    printTitlesRow: string;
+    printTitlesColumn: string;
+}
+export interface HeaderFooter {
+    differentFirst: boolean;
+    differentOddEven: boolean;
+    oddHeader: string;
+    oddFooter: string;
+    evenHeader: string;
+    evenFooter: string;
+    firstHeader: string;
+    firstFooter: string;
+}
+export interface WorksheetViewCommon {
+    rightToLeft?: boolean;
+    activeCell?: string;
+    showRuler?: boolean;
+    showRowColHeaders?: boolean;
+    showGridLines?: boolean;
+    zoomScale?: number;
+    zoomScaleNormal?: number;
+}
+export interface WorksheetViewNormal {
+    state: "normal";
+    style: "pageBreakPreview" | "pageLayout";
+}
+export interface WorksheetViewFrozen {
+    state: "frozen";
+    style?: "pageBreakPreview";
+    xSplit?: number;
+    ySplit?: number;
+    topLeftCell?: string;
+}
+export interface WorksheetViewSplit {
+    state: "split";
+    style?: "pageBreakPreview" | "pageLayout";
+    xSplit?: number;
+    ySplit?: number;
+    topLeftCell?: string;
+    activePane?: "topLeft" | "topRight" | "bottomLeft" | "bottomRight";
+}
+export type WorksheetView = WorksheetViewCommon & (WorksheetViewNormal | WorksheetViewFrozen | WorksheetViewSplit);
+export interface WorksheetProperties {
+    tabColor: Partial<Color>;
+    outlineLevelCol: number;
+    outlineLevelRow: number;
+    outlineProperties: {
+        summaryBelow: boolean;
+        summaryRight: boolean;
+    };
+    defaultRowHeight: number;
+    defaultColWidth?: number;
+    dyDescent?: number;
+    showGridLines: boolean;
+}
+export type WorksheetState = "visible" | "hidden" | "veryHidden";
+export type AutoFilter = string | {
+    from: string | {
+        row: number;
+        column: number;
+    };
+    to: string | {
+        row: number;
+        column: number;
+    };
+};
+export interface WorksheetProtection {
+    objects: boolean;
+    scenarios: boolean;
+    selectLockedCells: boolean;
+    selectUnlockedCells: boolean;
+    formatCells: boolean;
+    formatColumns: boolean;
+    formatRows: boolean;
+    insertColumns: boolean;
+    insertRows: boolean;
+    insertHyperlinks: boolean;
+    deleteColumns: boolean;
+    deleteRows: boolean;
+    sort: boolean;
+    autoFilter: boolean;
+    pivotTables: boolean;
+    spinCount: number;
+}
+export interface WorkbookView {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    firstSheet: number;
+    activeTab: number;
+    visibility: string;
+}
+export interface WorkbookProperties {
+    date1904: boolean;
+}
+export interface CalculationProperties {
+    fullCalcOnLoad: boolean;
+}
+export interface CellErrorValue {
+    error: "#N/A" | "#REF!" | "#NAME?" | "#DIV/0!" | "#NULL!" | "#VALUE!" | "#NUM!";
+}
+export interface RichText {
+    text: string;
+    font?: Partial<Font>;
+}
+export interface CellRichTextValue {
+    richText: RichText[];
+}
+export interface CellHyperlinkValue {
+    text: string;
+    hyperlink: string;
+    tooltip?: string;
+}
+export interface CellFormulaValue {
+    formula: string;
+    result?: number | string | boolean | Date | CellErrorValue;
+    date1904?: boolean;
+}
+/** Array formula that spans multiple cells */
+export interface CellArrayFormulaValue {
+    formula: string;
+    result?: number | string | boolean | Date | CellErrorValue;
+    /** Must be "array" for array formulas */
+    shareType: "array";
+    /** The range this array formula applies to, e.g. "A1:B2" */
+    ref: string;
+}
+export interface CellSharedFormulaValue {
+    sharedFormula: string;
+    readonly formula?: string;
+    result?: number | string | boolean | Date | CellErrorValue;
+    date1904?: boolean;
+}
+export type CellValue = null | number | string | boolean | Date | undefined | CellErrorValue | CellRichTextValue | CellHyperlinkValue | CellFormulaValue | CellArrayFormulaValue | CellSharedFormulaValue;
+export interface CommentMargins {
+    insetmode: "auto" | "custom";
+    inset: number[];
+}
+export interface CommentProtection {
+    locked: "True" | "False";
+    lockText: "True" | "False";
+}
+export type CommentEditAs = "twoCells" | "oneCells" | "absolute";
+export interface Comment {
+    texts?: RichText[];
+    margins?: Partial<CommentMargins>;
+    protection?: Partial<CommentProtection>;
+    editAs?: CommentEditAs;
+}
+export type DataValidationOperator = "between" | "notBetween" | "equal" | "notEqual" | "greaterThan" | "lessThan" | "greaterThanOrEqual" | "lessThanOrEqual";
+/** Base properties shared by all data validation types */
+interface DataValidationBase {
+    allowBlank?: boolean;
+    error?: string;
+    errorTitle?: string;
+    errorStyle?: string;
+    prompt?: string;
+    promptTitle?: string;
+    showErrorMessage?: boolean;
+    showInputMessage?: boolean;
+}
+/** Data validation that requires formulae and operator */
+export interface DataValidationWithFormulae extends DataValidationBase {
+    type: "list" | "whole" | "decimal" | "date" | "textLength" | "custom";
+    formulae: any[];
+    operator?: DataValidationOperator;
+}
+/** Data validation type 'any' - no formulae needed */
+export interface DataValidationAny extends DataValidationBase {
+    type: "any";
+}
+export type DataValidation = DataValidationWithFormulae | DataValidationAny;
+export interface Image {
+    extension: "jpeg" | "png" | "gif";
+    base64?: string;
+    filename?: string;
+    buffer?: Buffer;
+}
+export interface ImagePosition {
+    tl: {
+        col: number;
+        row: number;
+    };
+    ext: {
+        width: number;
+        height: number;
+    };
+}
+/** Anchor position for image placement */
+export interface ImageAnchor {
+    col: number;
+    row: number;
+    nativeCol?: number;
+    nativeRow?: number;
+    nativeColOff?: number;
+    nativeRowOff?: number;
+}
+/** Range input for addImage - can be a string like "A1:B2" or an object */
+export type AddImageRange = string | {
+    /** Top-left anchor position */
+    tl: ImageAnchor | string;
+    /** Bottom-right anchor position (optional if ext is provided) */
+    br?: ImageAnchor | string;
+    /** Image dimensions (alternative to br) */
+    ext?: {
+        width: number;
+        height: number;
+    };
+    /** How the image behaves when cells are resized */
+    editAs?: "oneCell" | "twoCell" | "absolute";
+    /** Hyperlink for the image */
+    hyperlinks?: {
+        hyperlink?: string;
+        tooltip?: string;
+    };
+};
+export interface ImageHyperlinkValue {
+    hyperlink: string;
+    tooltip?: string;
+}
+export type Location = {
+    top: number;
+    left: number;
+    bottom: number;
+    right: number;
+};
+export type Address = {
+    sheetName?: string;
+    address: string;
+    col: number;
+    row: number;
+    $col$row?: string;
+};
+export type RowValues = CellValue[] | {
+    [key: string]: CellValue;
+} | undefined | null;
+export type CellIsOperators = "equal" | "greaterThan" | "lessThan" | "between";
+export type ContainsTextOperators = "containsText" | "containsBlanks" | "notContainsBlanks" | "containsErrors" | "notContainsErrors";
+export type TimePeriodTypes = "lastWeek" | "thisWeek" | "nextWeek" | "yesterday" | "today" | "tomorrow" | "last7Days" | "lastMonth" | "thisMonth" | "nextMonth";
+export type IconSetTypes = "5Arrows" | "5ArrowsGray" | "5Boxes" | "5Quarters" | "5Rating" | "4Arrows" | "4ArrowsGray" | "4Rating" | "4RedToBlack" | "4TrafficLights" | "NoIcons" | "3Arrows" | "3ArrowsGray" | "3Flags" | "3Signs" | "3Stars" | "3Symbols" | "3Symbols2" | "3TrafficLights1" | "3TrafficLights2" | "3Triangles";
+export type CfvoTypes = "percentile" | "percent" | "num" | "min" | "max" | "formula" | "autoMin" | "autoMax";
+export interface Cvfo {
+    type: CfvoTypes;
+    value?: number | string;
+}
+export interface ConditionalFormattingBaseRule {
+    priority?: number;
+    style?: Partial<Style>;
+}
+export interface ExpressionRuleType extends ConditionalFormattingBaseRule {
+    type: "expression";
+    formulae?: any[];
+}
+export interface CellIsRuleType extends ConditionalFormattingBaseRule {
+    type: "cellIs";
+    formulae?: any[];
+    operator?: CellIsOperators;
+}
+export interface Top10RuleType extends ConditionalFormattingBaseRule {
+    type: "top10";
+    rank: number;
+    percent: boolean;
+    bottom?: boolean;
+}
+export interface AboveAverageRuleType extends ConditionalFormattingBaseRule {
+    type: "aboveAverage";
+    aboveAverage?: boolean;
+}
+export interface ColorScaleRuleType extends ConditionalFormattingBaseRule {
+    type: "colorScale";
+    cfvo?: Cvfo[];
+    color?: Partial<Color>[];
+}
+export interface IconSetRuleType extends ConditionalFormattingBaseRule {
+    type: "iconSet";
+    showValue?: boolean;
+    reverse?: boolean;
+    custom?: boolean;
+    iconSet?: IconSetTypes;
+    cfvo?: Cvfo[];
+}
+export interface ContainsTextRuleType extends ConditionalFormattingBaseRule {
+    type: "containsText";
+    operator?: ContainsTextOperators;
+    text?: string;
+}
+export interface TimePeriodRuleType extends ConditionalFormattingBaseRule {
+    type: "timePeriod";
+    timePeriod?: TimePeriodTypes;
+}
+export interface DataBarRuleType extends ConditionalFormattingBaseRule {
+    type: "dataBar";
+    gradient?: boolean;
+    minLength?: number;
+    maxLength?: number;
+    showValue?: boolean;
+    border?: boolean;
+    negativeBarColorSameAsPositive?: boolean;
+    negativeBarBorderColorSameAsPositive?: boolean;
+    axisPosition?: "auto" | "middle" | "none";
+    direction?: "context" | "leftToRight" | "rightToLeft";
+    cfvo?: Cvfo[];
+    color?: Partial<Color>;
+}
+export type ConditionalFormattingRule = ExpressionRuleType | CellIsRuleType | Top10RuleType | AboveAverageRuleType | ColorScaleRuleType | IconSetRuleType | ContainsTextRuleType | TimePeriodRuleType | DataBarRuleType;
+export interface ConditionalFormattingOptions {
+    ref: string;
+    rules: ConditionalFormattingRule[];
+}
+export interface ConditionalFormattingOptions {
+    ref: string;
+    rules: ConditionalFormattingRule[];
+}
+export interface TableStyleProperties {
+    theme?: string;
+    showFirstColumn?: boolean;
+    showLastColumn?: boolean;
+    showRowStripes?: boolean;
+    showColumnStripes?: boolean;
+}
+export interface TableColumnProperties {
+    name: string;
+    filterButton?: boolean;
+    totalsRowLabel?: string;
+    totalsRowFunction?: "none" | "average" | "countNums" | "count" | "max" | "min" | "stdDev" | "var" | "sum" | "custom";
+    totalsRowFormula?: string;
+    totalsRowResult?: CellFormulaValue["result"];
+    style?: Partial<Style>;
+}
+export interface TableProperties {
+    name: string;
+    displayName?: string;
+    ref: string;
+    headerRow?: boolean;
+    totalsRow?: boolean;
+    style?: TableStyleProperties;
+    columns: TableColumnProperties[];
+    rows: any[][];
+}
+export type TableColumn = Required<TableColumnProperties>;
+export interface Media {
+    type: string;
+    name: string;
+    extension: string;
+    buffer: Buffer;
+}
+export interface AddWorksheetOptions {
+    properties?: Partial<WorksheetProperties>;
+    pageSetup?: Partial<PageSetup>;
+    headerFooter?: Partial<HeaderFooter>;
+    views?: Array<Partial<WorksheetView>>;
+    state?: WorksheetState;
+    /** Specifies whether to use shared strings. Overrides workbook setting. */
+    useSharedStrings?: boolean;
+    /** Apply an auto filter to the worksheet */
+    autoFilter?: AutoFilter;
+}
+export interface DefinedNamesRanges {
+    name: string;
+    ranges: string[];
+}
+export type DefinedNamesModel = DefinedNamesRanges[];
+export interface RowBreak {
+    id: number;
+    max: number;
+    min?: number;
+    man: number;
+}
+export interface ColBreak {
+    id: number;
+    max: number;
+    min?: number;
+    man: number;
+}
+export {};

package/dist/browser/modules/excel/types.js

@@ -0,0 +1,22 @@
+/**
+ * Type definitions for ExcelTS
+ * This file exports all public types used by the library
+ */
+// ============================================================================
+// Paper Size Enum
+// ============================================================================
+export var PaperSize;
+(function (PaperSize) {
+    PaperSize[PaperSize["Legal"] = 5] = "Legal";
+    PaperSize[PaperSize["Executive"] = 7] = "Executive";
+    PaperSize[PaperSize["A4"] = 9] = "A4";
+    PaperSize[PaperSize["A5"] = 11] = "A5";
+    PaperSize[PaperSize["B5"] = 13] = "B5";
+    PaperSize[PaperSize["Envelope_10"] = 20] = "Envelope_10";
+    PaperSize[PaperSize["Envelope_DL"] = 27] = "Envelope_DL";
+    PaperSize[PaperSize["Envelope_C5"] = 28] = "Envelope_C5";
+    PaperSize[PaperSize["Envelope_B5"] = 34] = "Envelope_B5";
+    PaperSize[PaperSize["Envelope_Monarch"] = 37] = "Envelope_Monarch";
+    PaperSize[PaperSize["Double_Japan_Postcard_Rotated"] = 82] = "Double_Japan_Postcard_Rotated";
+    PaperSize[PaperSize["K16_197x273_mm"] = 119] = "K16_197x273_mm";
+})(PaperSize || (PaperSize = {}));

package/dist/browser/modules/excel/utils/cell-format.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Excel Cell Format Parser
+ * A simplified implementation for formatting cell values according to Excel numFmt patterns
+ * Supports: General, percentages, decimals, thousands separators, dates, currencies,
+ * scientific notation, fractions, elapsed time, and more
+ */
+/**
+ * Get format string from numFmtId
+ * Handles default mappings for certain format IDs
+ */
+export declare function getFormat(numFmtId: number): string;
+/**
+ * Check if format is "General"
+ */
+declare function isGeneral(fmt: string): boolean;
+/**
+ * Check if format is a date format
+ */
+declare function isDateFormat(fmt: string): boolean;
+/**
+ * Main format function - formats a value according to Excel numFmt
+ * @param fmt The Excel number format string (e.g., "0.00%", "#,##0", "yyyy-mm-dd")
+ * @param val The value to format
+ */
+export declare function format(fmt: string, val: number | string | boolean): string;
+export declare const cellFormat: {
+    format: typeof format;
+    getFormat: typeof getFormat;
+    isDateFormat: typeof isDateFormat;
+    isGeneral: typeof isGeneral;
+};
+export {};