sheetra 1.0.0

package/dist/types/types/cell.types.d.ts

@@ -0,0 +1,288 @@
+/**
+ * Cell value types supported by Sheetra
+ */
+export type CellValueType = 'string' | 'number' | 'date' | 'boolean' | 'formula' | 'error';
+/**
+ * Cell alignment options
+ */
+export type HorizontalAlignment = 'left' | 'center' | 'right' | 'fill' | 'justify' | 'centerContinuous' | 'distributed';
+export type VerticalAlignment = 'top' | 'middle' | 'bottom' | 'distributed' | 'justify';
+/**
+ * Border style options
+ */
+export type BorderStyleType = 'thin' | 'medium' | 'thick' | 'dotted' | 'dashed' | 'double' | 'hair' | 'mediumDashed' | 'dashDot' | 'mediumDashDot' | 'dashDotDot' | 'mediumDashDotDot' | 'slantDashDot';
+/**
+ * Font styling options
+ */
+export interface FontStyle {
+    /** Font name (e.g., 'Arial', 'Calibri') */
+    name?: string;
+    /** Font size in points */
+    size?: number;
+    /** Bold text */
+    bold?: boolean;
+    /** Italic text */
+    italic?: boolean;
+    /** Underline style */
+    underline?: boolean | 'single' | 'double' | 'singleAccounting' | 'doubleAccounting';
+    /** Strikethrough text */
+    strike?: boolean;
+    /** Font color in hex or RGB */
+    color?: string;
+    /** Font family */
+    family?: number;
+    /** Font scheme */
+    scheme?: 'major' | 'minor' | 'none';
+    /** Character set */
+    charset?: number;
+    /** Outline font */
+    outline?: boolean;
+    /** Shadow font */
+    shadow?: boolean;
+    /** Condense font */
+    condense?: boolean;
+    /** Extend font */
+    extend?: boolean;
+    /** Vertical alignment text */
+    verticalAlign?: 'superscript' | 'subscript' | 'baseline';
+}
+/**
+ * Border definition for a single side
+ */
+export interface BorderEdge {
+    /** Border style */
+    style?: BorderStyleType;
+    /** Border color in hex or RGB */
+    color?: string;
+}
+/**
+ * Complete border configuration
+ */
+export interface Border {
+    /** Top border */
+    top?: BorderEdge;
+    /** Bottom border */
+    bottom?: BorderEdge;
+    /** Left border */
+    left?: BorderEdge;
+    /** Right border */
+    right?: BorderEdge;
+    /** Diagonal border (top-left to bottom-right) */
+    diagonal?: BorderEdge;
+    /** Diagonal border (bottom-left to top-right) */
+    diagonalDown?: BorderEdge;
+    /** Diagonal border (top-right to bottom-left) */
+    diagonalUp?: BorderEdge;
+    /** Diagonal border type */
+    diagonalType?: 'both' | 'up' | 'down';
+}
+/**
+ * Fill pattern types
+ */
+export type FillPattern = 'none' | 'solid' | 'gray125' | 'gray0625' | 'gray75' | 'gray50' | 'gray25' | 'gray12' | 'gray6' | 'horizontalStripe' | 'verticalStripe' | 'reverseDiagonalStripe' | 'diagonalStripe' | 'diagonalCrosshatch' | 'thickDiagonalCrosshatch' | 'thinHorizontalStripe' | 'thinVerticalStripe' | 'thinReverseDiagonalStripe' | 'thinDiagonalStripe' | 'thinHorizontalCrosshatch' | 'thinDiagonalCrosshatch';
+/**
+ * Fill configuration for cell background
+ */
+export interface Fill {
+    /** Fill pattern type */
+    patternType?: FillPattern;
+    /** Foreground color (pattern color) */
+    fgColor?: string;
+    /** Background color */
+    bgColor?: string;
+}
+/**
+ * Number format configuration
+ */
+export interface NumberFormat {
+    /** Format code (e.g., '#,##0.00', '0%', 'm/d/yyyy') */
+    format: string;
+    /** Number of decimal places */
+    decimals?: number;
+    /** Thousands separator */
+    thousandsSeparator?: boolean;
+    /** Currency symbol */
+    currencySymbol?: string;
+    /** Negative number format */
+    negativeFormat?: 'parentheses' | 'minus' | 'red';
+}
+/**
+ * Complete cell style configuration
+ */
+export interface CellStyle {
+    /** Font styling */
+    font?: FontStyle;
+    /** Border configuration */
+    border?: Border;
+    /** Fill configuration */
+    fill?: Fill;
+    /** Number format */
+    numberFormat?: string | NumberFormat;
+    /** Horizontal alignment */
+    alignment?: HorizontalAlignment;
+    /** Vertical alignment */
+    verticalAlignment?: VerticalAlignment;
+    /** Text wrapping */
+    wrapText?: boolean;
+    /** Text rotation in degrees */
+    textRotation?: number;
+    /** Indentation level */
+    indent?: number;
+    /** Shrink to fit */
+    shrinkToFit?: boolean;
+    /** Reading order */
+    readingOrder?: 'context' | 'leftToRight' | 'rightToLeft';
+    /** Hidden cell */
+    hidden?: boolean;
+    /** Locked cell (for protection) */
+    locked?: boolean;
+    bold?: boolean;
+    italic?: boolean;
+    underline?: boolean | 'single' | 'double' | 'singleAccounting' | 'doubleAccounting';
+    fontSize?: number;
+    fontFamily?: string;
+    color?: string;
+    backgroundColor?: string;
+    borderAll?: {
+        style: BorderStyleType;
+        color?: string;
+    };
+}
+/**
+ * Cell data structure
+ */
+export interface CellData {
+    /** Cell value */
+    value: string | number | boolean | Date | null;
+    /** Cell style */
+    style?: CellStyle;
+    /** Cell formula (if any) */
+    formula?: string;
+    /** Cell value type */
+    type?: CellValueType;
+    /** Cell comment */
+    comment?: string;
+    /** Hyperlink */
+    hyperlink?: string;
+    /** Tooltip */
+    tooltip?: string;
+    /** Cell error value */
+    error?: string;
+    /** Shared formula reference */
+    sharedFormula?: string;
+    /** Array formula */
+    arrayFormula?: {
+        formula: string;
+        range: string;
+    };
+    /** Rich text (array of formatted text runs) */
+    richText?: Array<{
+        text: string;
+        font?: FontStyle;
+    }>;
+}
+/**
+ * Cell address (A1 notation)
+ */
+export interface CellAddress {
+    /** Column name (A, B, C, etc.) */
+    column: string;
+    /** Row number (1-based) */
+    row: number;
+    /** Absolute column ($A) */
+    absoluteColumn?: boolean;
+    /** Absolute row ($1) */
+    absoluteRow?: boolean;
+}
+/**
+ * Cell range (A1:B2 notation)
+ */
+export interface CellRange {
+    /** Start cell */
+    start: CellAddress;
+    /** End cell */
+    end: CellAddress;
+}
+/**
+ * Data validation rules
+ */
+export interface DataValidation {
+    /** Validation type */
+    type: 'whole' | 'decimal' | 'list' | 'date' | 'time' | 'textLength' | 'custom';
+    /** Operator for comparison */
+    operator?: 'between' | 'notBetween' | 'equal' | 'notEqual' | 'greaterThan' | 'lessThan' | 'greaterThanOrEqual' | 'lessThanOrEqual';
+    /** Formula 1 (value or range) */
+    formula1?: string | number;
+    /** Formula 2 (for between operators) */
+    formula2?: string | number;
+    /** Allow blank */
+    allowBlank?: boolean;
+    /** Show input message */
+    showInputMessage?: boolean;
+    /** Show error message */
+    showErrorMessage?: boolean;
+    /** Input title */
+    inputTitle?: string;
+    /** Input message */
+    inputMessage?: string;
+    /** Error title */
+    errorTitle?: string;
+    /** Error message */
+    errorMessage?: string;
+    /** Error style */
+    errorStyle?: 'stop' | 'warning' | 'information';
+    /** List of values (for list type) */
+    values?: any[];
+    /** Reference to list range */
+    listRange?: string;
+}
+/**
+ * Conditional formatting rule
+ */
+export interface ConditionalFormatRule {
+    /** Rule type */
+    type: 'expression' | 'cellIs' | 'colorScale' | 'dataBar' | 'iconSet' | 'top10' | 'uniqueValues' | 'duplicateValues' | 'containsText' | 'notContainsText' | 'beginsWith' | 'endsWith' | 'containsBlanks' | 'notContainsBlanks' | 'containsErrors' | 'notContainsErrors' | 'timePeriod' | 'aboveAverage';
+    /** Priority of rule */
+    priority: number;
+    /** Stop if true */
+    stopIfTrue?: boolean;
+    /** Formula for expression type */
+    formula?: string;
+    /** Operator for cellIs type */
+    operator?: string;
+    /** Value for comparison */
+    value?: any;
+    /** Style to apply */
+    style?: CellStyle;
+    /** Format for data bars */
+    dataBar?: {
+        minLength?: number;
+        maxLength?: number;
+        showValue?: boolean;
+        gradient?: boolean;
+        border?: boolean;
+        negativeBarColor?: string;
+        axisColor?: string;
+        direction?: 'context' | 'leftToRight' | 'rightToLeft';
+    };
+    /** Format for color scales */
+    colorScale?: {
+        minColor?: string;
+        midColor?: string;
+        maxColor?: string;
+    };
+    /** Format for icon sets */
+    iconSet?: {
+        iconSet?: '3Arrows' | '3ArrowsGray' | '3Flags' | '3TrafficLights1' | '3TrafficLights2' | '3Signs' | '3Symbols' | '3Symbols2' | '4Arrows' | '4ArrowsGray' | '4RedToBlack' | '4Rating' | '4TrafficLights' | '5Arrows' | '5ArrowsGray' | '5Rating' | '5Quarters';
+        showValue?: boolean;
+        percent?: boolean;
+        reverse?: boolean;
+    };
+}
+/**
+ * Border style
+ */
+export interface BorderStyle {
+    style: BorderStyleType;
+    color?: string;
+}

package/dist/types/types/export.types.d.ts

@@ -0,0 +1,303 @@
+import { Border, Fill } from "./cell.types";
+/**
+ * Export options for exporting sheets, workbooks, etc.
+ */
+export interface ExportOptions {
+    /** Output file name (with extension) */
+    filename?: string;
+    /** File format: 'xlsx', 'csv', 'json', etc. */
+    format?: 'xlsx' | 'csv' | 'json';
+    /** Whether to include styles in export */
+    includeStyles?: boolean;
+    /** Whether to include hidden rows/columns */
+    includeHidden?: boolean;
+    /** Password for protected export (if supported) */
+    password?: string;
+    /** Sheet name (for single-sheet export) */
+    sheetName?: string;
+    /** Locale for formatting */
+    locale?: string;
+    /** Custom options for writers */
+    [key: string]: any;
+}
+/**
+ * Chart series data
+ */
+export interface ChartSeries {
+    /** Series name */
+    name?: string;
+    /** Categories (X-axis) */
+    categories?: any[];
+    /** Values (Y-axis) */
+    values: any[];
+    /** Series color */
+    color?: string;
+    /** Series style */
+    style?: number;
+    /** Marker style (for line charts) */
+    marker?: {
+        symbol?: 'circle' | 'diamond' | 'square' | 'triangle' | 'none';
+        size?: number;
+        fill?: string;
+        stroke?: string;
+    };
+    /** Trendline */
+    trendline?: {
+        type: 'linear' | 'exponential' | 'logarithmic' | 'polynomial' | 'movingAverage';
+        order?: number;
+        period?: number;
+        forward?: number;
+        backward?: number;
+        intercept?: number;
+        displayEquation?: boolean;
+        displayRSquared?: boolean;
+        name?: string;
+    };
+    /** Error bars */
+    errorBars?: {
+        type: 'fixed' | 'percentage' | 'standardDeviation' | 'standardError' | 'custom';
+        value?: number;
+        plusValues?: any[];
+        minusValues?: any[];
+        direction?: 'both' | 'plus' | 'minus';
+        endStyle?: 'cap' | 'noCap';
+    };
+}
+/**
+ * Chart axis configuration
+ */
+export interface ChartAxis {
+    /** Axis title */
+    title?: string;
+    /** Minimum value */
+    min?: number;
+    /** Maximum value */
+    max?: number;
+    /** Major unit */
+    majorUnit?: number;
+    /** Minor unit */
+    minorUnit?: number;
+    /** Reverse order */
+    reverse?: boolean;
+    /** Logarithmic scale */
+    logarithmic?: boolean;
+    /** Base for logarithmic scale */
+    logBase?: number;
+    /** Format code */
+    format?: string;
+    /** Axis position */
+    position?: 'bottom' | 'left' | 'right' | 'top';
+    /** Crossing point */
+    crosses?: 'auto' | 'min' | 'max' | number;
+    /** Gridlines */
+    gridlines?: {
+        major?: boolean;
+        minor?: boolean;
+        color?: string;
+    };
+    /** Tick marks */
+    tickMarks?: {
+        major?: 'none' | 'inside' | 'outside' | 'cross';
+        minor?: 'none' | 'inside' | 'outside' | 'cross';
+    };
+    /** Font */
+    font?: {
+        name?: string;
+        size?: number;
+        bold?: boolean;
+        color?: string;
+    };
+}
+/**
+ * Complete chart configuration
+ */
+export interface ChartConfig {
+    /** Chart title */
+    title?: string;
+    /** Chart type */
+    type: 'area' | 'bar' | 'column' | 'line' | 'pie' | 'doughnut' | 'radar' | 'scatter' | 'stock' | 'surface' | 'bubble' | 'radarArea' | 'radarLine' | 'radarFilled' | 'barStacked' | 'columnStacked' | 'barPercent' | 'columnPercent' | 'areaStacked' | 'areaPercent' | 'lineStacked' | 'linePercent' | 'pie3D' | 'bar3D' | 'column3D' | 'line3D' | 'area3D' | 'surface3D';
+    /** Chart sub-type */
+    subType?: 'clustered' | 'stacked' | 'percent' | '3D' | '3DClustered' | '3DStacked' | '3DPercent';
+    /** Data range */
+    dataRange?: string;
+    /** Series data */
+    series?: ChartSeries[];
+    /** X-axis configuration */
+    xAxis?: ChartAxis;
+    /** Y-axis configuration */
+    yAxis?: ChartAxis;
+    /** Secondary X-axis */
+    xAxis2?: ChartAxis;
+    /** Secondary Y-axis */
+    yAxis2?: ChartAxis;
+    /** Legend */
+    legend?: {
+        position?: 'top' | 'bottom' | 'left' | 'right' | 'corner' | 'none';
+        layout?: 'stack' | 'overlay';
+        showSeriesName?: boolean;
+        font?: {
+            name?: string;
+            size?: number;
+            bold?: boolean;
+            color?: string;
+        };
+    };
+    /** Data labels */
+    dataLabels?: {
+        show?: boolean;
+        position?: 'center' | 'insideEnd' | 'insideBase' | 'outsideEnd' | 'bestFit';
+        format?: string;
+        font?: {
+            name?: string;
+            size?: number;
+            bold?: boolean;
+            color?: string;
+        };
+        separator?: string;
+        showSeriesName?: boolean;
+        showCategoryName?: boolean;
+        showValue?: boolean;
+        showPercentage?: boolean;
+        showLeaderLines?: boolean;
+    };
+    /** Chart size in pixels */
+    size?: {
+        width: number;
+        height: number;
+    };
+    /** Chart position in pixels (from top-left of sheet) */
+    position?: {
+        x: number;
+        y: number;
+    };
+    /** Chart style (1-48) */
+    style?: number;
+    /** Chart template */
+    template?: string;
+    /** Gap width (for bar/column) */
+    gapWidth?: number;
+    /** Overlap (for bar/column) */
+    overlap?: number;
+    /** Vary colors by point */
+    varyColors?: boolean;
+    /** Smooth lines */
+    smooth?: boolean;
+    /** Show data table */
+    dataTable?: {
+        show?: boolean;
+        showLegendKeys?: boolean;
+        border?: boolean;
+        font?: {
+            name?: string;
+            size?: number;
+            bold?: boolean;
+            color?: string;
+        };
+    };
+    /** 3D options */
+    threeD?: {
+        rotation?: number;
+        perspective?: number;
+        height?: number;
+        depth?: number;
+        rightAngleAxes?: boolean;
+        lighting?: boolean;
+    };
+    /** Plot area */
+    plotArea?: {
+        border?: Border;
+        fill?: Fill;
+        transparency?: number;
+    };
+    /** Chart area */
+    chartArea?: {
+        border?: Border;
+        fill?: Fill;
+        transparency?: number;
+    };
+}
+/**
+ * Drawing object (image, shape, etc.)
+ */
+export interface Drawing {
+    /** Drawing type */
+    type: 'image' | 'shape' | 'chart' | 'smartArt';
+    /** Drawing position */
+    from: {
+        col: number;
+        row: number;
+        colOffset?: number;
+        rowOffset?: number;
+    };
+    /** Drawing size */
+    to?: {
+        col: number;
+        row: number;
+        colOffset?: number;
+        rowOffset?: number;
+    };
+    /** Image data (for images) */
+    image?: {
+        data: string | ArrayBuffer;
+        format: 'png' | 'jpg' | 'gif' | 'bmp' | 'svg';
+        name?: string;
+        description?: string;
+    };
+    /** Shape data (for shapes) */
+    shape?: {
+        type: 'rectangle' | 'ellipse' | 'triangle' | 'line' | 'arrow' | 'callout' | 'flowchart' | 'star' | 'banner';
+        text?: string;
+        fill?: Fill;
+        border?: Border;
+        rotation?: number;
+        flipHorizontal?: boolean;
+        flipVertical?: boolean;
+    };
+    /** Chart reference */
+    chart?: ChartConfig;
+    /** Alternative text */
+    altText?: string;
+    /** Hyperlink */
+    hyperlink?: string;
+    /** Lock aspect ratio */
+    lockAspect?: boolean;
+    /** Lock position */
+    lockPosition?: boolean;
+    /** Print object */
+    print?: boolean;
+    /** Hidden */
+    hidden?: boolean;
+}
+/**
+ * Section configuration for export (e.g., for splitting sheets into sections)
+ */
+export interface SectionConfig {
+    /** Section title */
+    title?: string;
+    /** Section description */
+    description?: string;
+    /** Range of rows included in this section (e.g., "A1:D10") */
+    range?: string;
+    /** Whether the section is collapsible */
+    collapsible?: boolean;
+    /** Whether the section is initially collapsed */
+    collapsed?: boolean;
+    /** Custom styles for the section */
+    style?: {
+        backgroundColor?: string;
+        fontColor?: string;
+        fontSize?: number;
+        bold?: boolean;
+        italic?: boolean;
+        border?: Border;
+        fill?: Fill;
+    };
+    /** Additional custom options */
+    [key: string]: any;
+}
+/**
+ * Export filters
+ */
+export interface ExportFilters {
+    [key: string]: any;
+}

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

@@ -0,0 +1,13 @@
+export * from './workbook.types';
+export * from './cell.types';
+import { CellStyle, Border, BorderStyle } from './cell.types';
+import { WorkbookData, WorksheetData, RowData, ColumnData } from './workbook.types';
+import { ExportOptions, SectionConfig, Drawing, ExportFilters } from './export.types';
+export type { CellStyle, Border, BorderStyle, WorkbookData, WorksheetData, RowData, ColumnData, ExportOptions, SectionConfig, Drawing, ExportFilters };
+export type DeepPartial<T> = {
+    [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+};
+export type Nullable<T> = T | null | undefined;
+export type Record = {
+    [key: string]: unknown;
+};