@pixerate/editor 0.3.0 → 0.4.1

package/dist/spreadsheet/index.d.ts

@@ -0,0 +1,269 @@
+type CellFormat = 'text' | 'number' | 'currency' | 'percentage' | 'date' | 'badge' | 'status' | 'assignee';
+type ColumnType = 'bound' | 'freeform' | 'formula';
+interface ColumnBinding {
+    dataSource: string;
+    field: string;
+}
+interface SpreadsheetColumn {
+    id: string;
+    key: string;
+    title: string;
+    width?: number;
+    type: ColumnType;
+    binding?: ColumnBinding;
+    formula?: string;
+    format?: CellFormat;
+    readOnly?: boolean;
+}
+type RowType = 'record' | 'freeform';
+interface SpreadsheetRow {
+    id: string;
+    index: number;
+    height?: number;
+    recordId?: string;
+    type: RowType;
+}
+interface CellCoordinate {
+    row: number;
+    col: number;
+    rowId?: string;
+    colId?: string;
+}
+interface CellRange {
+    startRow: number;
+    startCol: number;
+    endRow: number;
+    endCol: number;
+}
+interface CellData {
+    raw: string;
+    value: any;
+    error?: string;
+    format?: CellFormat;
+    readOnly?: boolean;
+}
+interface SpreadsheetDocument {
+    id: string;
+    name: string;
+    columns: SpreadsheetColumn[];
+    rows: SpreadsheetRow[];
+    cells: Record<string, Record<string, CellData>>;
+    createdAt?: number;
+    updatedAt?: number;
+}
+interface SpreadsheetDataSourceField {
+    key: string;
+    label: string;
+    type: 'string' | 'number' | 'date' | 'boolean' | 'enum';
+    options?: Array<{
+        key: string;
+        label: string;
+        color?: string;
+    }>;
+}
+interface SpreadsheetDataSource {
+    id: string;
+    name: string;
+    getRecords(): Array<{
+        id: string;
+        [key: string]: any;
+    }>;
+    getFields(): SpreadsheetDataSourceField[];
+    updateRecord(recordId: string, field: string, value: any): Promise<void> | void;
+}
+
+type FormulaTokenType = 'NUMBER' | 'STRING' | 'BOOLEAN' | 'CELL_REF' | 'RANGE' | 'PROPERTY_REF' | 'IDENTIFIER' | 'OPERATOR' | 'LPAREN' | 'RPAREN' | 'COMMA' | 'EOF';
+interface FormulaToken {
+    type: FormulaTokenType;
+    value: string;
+    position: number;
+}
+declare function tokenizeFormula(formula: string): FormulaToken[];
+
+type ASTNode = LiteralNode | CellRefNode | RangeNode | PropertyRefNode | BinaryOpNode | UnaryOpNode | FunctionCallNode;
+interface LiteralNode {
+    type: 'Literal';
+    value: number | string | boolean;
+}
+interface CellRefNode {
+    type: 'CellRef';
+    ref: string;
+    col: string;
+    row: number;
+}
+interface RangeNode {
+    type: 'Range';
+    raw: string;
+    startCol: string;
+    startRow: number;
+    endCol: string;
+    endRow: number;
+}
+interface PropertyRefNode {
+    type: 'PropertyRef';
+    property: string;
+}
+interface BinaryOpNode {
+    type: 'BinaryOp';
+    op: string;
+    left: ASTNode;
+    right: ASTNode;
+}
+interface UnaryOpNode {
+    type: 'UnaryOp';
+    op: string;
+    argument: ASTNode;
+}
+interface FunctionCallNode {
+    type: 'FunctionCall';
+    name: string;
+    args: ASTNode[];
+}
+declare function parseCellReference(ref: string): {
+    col: string;
+    row: number;
+};
+declare function parseRange(rangeStr: string): RangeNode;
+declare class FormulaParser {
+    private tokens;
+    private current;
+    constructor(tokens: FormulaToken[]);
+    parse(): ASTNode;
+    private expression;
+    private comparison;
+    private concatenation;
+    private addition;
+    private multiplication;
+    private exponentiation;
+    private unary;
+    private primary;
+    private match;
+    private matchOperator;
+    private check;
+    private advance;
+    private isAtEnd;
+    private peek;
+    private previous;
+    private consume;
+}
+declare function parseFormula(formula: string): ASTNode;
+
+interface EvaluationContext {
+    resolveCell?: (col: string, row: number) => any;
+    resolveRange?: (startCol: string, startRow: number, endCol: string, endRow: number) => any[];
+    resolveProperty?: (property: string) => any;
+}
+declare function colNameToIndex(col: string): number;
+declare function indexToColName(index: number): string;
+declare class FormulaEvaluator {
+    private context;
+    constructor(context?: EvaluationContext);
+    evaluate(astOrFormula: ASTNode | string): any;
+    private evaluateNode;
+    private callFunction;
+}
+
+interface CellDep {
+    col: string;
+    row: number;
+}
+declare function extractCellDependencies(node: ASTNode): CellDep[];
+declare class DependencyGraph {
+    private dependencies;
+    private dependents;
+    setCellFormula(cellKey: string, formulaStr: string | null): void;
+    getDependencies(cellKey: string): string[];
+    getDependents(cellKey: string): string[];
+    /**
+     * Detects if there is a cycle containing cellKey.
+     */
+    hasCycle(cellKey: string): boolean;
+    /**
+     * Returns cells affected by updating cellKey in topological order.
+     */
+    getEvaluationOrder(startCellKey: string): {
+        order: string[];
+        hasCycle: boolean;
+    };
+}
+
+declare class DataSourceBinder {
+    private dataSources;
+    register(dataSource: SpreadsheetDataSource): void;
+    unregister(dataSourceId: string): void;
+    getDataSource(id: string): SpreadsheetDataSource | undefined;
+    /**
+     * Generates or reconciles spreadsheet rows from a primary data source.
+     */
+    syncRows(currentRows: SpreadsheetRow[], dataSourceId: string): SpreadsheetRow[];
+    /**
+     * Resolves a record's bound field value.
+     */
+    resolveBoundValue(dataSourceId: string, recordId: string, field: string): any;
+    /**
+     * Dispatches an update to the underlying data source.
+     */
+    commitBoundValue(dataSourceId: string, recordId: string, field: string, value: any): Promise<void>;
+}
+
+interface SpreadsheetControllerOptions {
+    document?: Partial<SpreadsheetDocument>;
+    dataSources?: SpreadsheetDataSource[];
+    primaryDataSourceId?: string;
+    onDocumentChange?: (doc: SpreadsheetDocument) => void;
+    onSelectionChange?: (activeCell: CellCoordinate | null, range: CellRange | null) => void;
+    onCellCommit?: (rowId: string, colId: string, raw: string, value: any) => void;
+}
+declare class SpreadsheetController {
+    document: SpreadsheetDocument;
+    activeCell: CellCoordinate | null;
+    selectedRange: CellRange | null;
+    editingCell: CellCoordinate | null;
+    draftValue: string;
+    readonly binder: DataSourceBinder;
+    readonly depGraph: DependencyGraph;
+    readonly evaluator: FormulaEvaluator;
+    private primaryDataSourceId?;
+    private onDocumentChange?;
+    private onSelectionChange?;
+    private onCellCommit?;
+    private undoStack;
+    private redoStack;
+    private isApplyingHistory;
+    constructor(options?: SpreadsheetControllerOptions);
+    loadDocument(document: SpreadsheetDocument): void;
+    registerDataSource(ds: SpreadsheetDataSource): void;
+    setPrimaryDataSource(dataSourceId: string | undefined): void;
+    syncWithDataSource(): void;
+    private recomputeRowIndices;
+    getColumn(colIdOrKey: string): SpreadsheetColumn | undefined;
+    getRow(rowIdOrIndex: string | number): SpreadsheetRow | undefined;
+    getCell(rowId: string, colId: string): CellData;
+    setCellValue(rowId: string, colId: string, raw: string): void;
+    private getCellKey;
+    recalculateCell(rowId: string, colId: string): void;
+    recalculateAll(): void;
+    private evalSingleCellByKey;
+    private resolveCellByCoord;
+    private resolveRangeByCoords;
+    private resolveCurrentRowProperty;
+    selectCell(row: number, col: number, extendSelection?: boolean): void;
+    selectRange(range: CellRange): void;
+    startEditing(row?: number, col?: number, initialValue?: string): void;
+    commitEditing(valueToCommit?: string): void;
+    cancelEditing(): void;
+    moveCursor(direction: 'up' | 'down' | 'left' | 'right', extendSelection?: boolean): void;
+    insertColumn(index: number, config?: Partial<SpreadsheetColumn>): void;
+    deleteColumn(colId: string): void;
+    insertRow(index: number, config?: Partial<SpreadsheetRow>): void;
+    deleteRow(rowId: string): void;
+    setColumnWidth(colId: string, width: number): void;
+    exportToTsv(): string;
+    importFromTsv(tsvData: string, startRow?: number, startCol?: number): void;
+    private recordSnapshot;
+    undo(): void;
+    redo(): void;
+    private notifyChange;
+}
+
+export { type ASTNode, type BinaryOpNode, type CellCoordinate, type CellData, type CellDep, type CellFormat, type CellRange, type CellRefNode, type ColumnBinding, type ColumnType, DataSourceBinder, DependencyGraph, type EvaluationContext, FormulaEvaluator, FormulaParser, type FormulaToken, type FormulaTokenType, type FunctionCallNode, type LiteralNode, type PropertyRefNode, type RangeNode, type RowType, type SpreadsheetColumn, SpreadsheetController, type SpreadsheetControllerOptions, type SpreadsheetDataSource, type SpreadsheetDataSourceField, type SpreadsheetDocument, type SpreadsheetRow, type UnaryOpNode, colNameToIndex, extractCellDependencies, indexToColName, parseCellReference, parseFormula, parseRange, tokenizeFormula };