logisheets 0.8.0 → 1.0.0

package/dist/src/bindings/upsert_field_render_info.d.ts

@@ -0,0 +1,19 @@
+import { StyleUpdateType } from './style_update_type';
+export interface UpsertFieldRenderInfo {
+    renderId: string;
+    diyRender: boolean;
+    styleUpdate: StyleUpdateType;
+}
+export declare class UpsertFieldRenderInfoBuilder {
+    private _renderId;
+    private _diyRender;
+    private _styleUpdate;
+    renderId(value: string): this;
+    diyRender(value: boolean): this;
+    styleUpdate(value: StyleUpdateType): this;
+    build(): {
+        renderId: string;
+        diyRender: boolean;
+        styleUpdate: StyleUpdateType;
+    };
+}

package/dist/src/bindings/upsert_field_render_info.js

@@ -0,0 +1,26 @@
+export class UpsertFieldRenderInfoBuilder {
+    _renderId;
+    _diyRender;
+    _styleUpdate;
+    renderId(value) {
+        this._renderId = value;
+        return this;
+    }
+    diyRender(value) {
+        this._diyRender = value;
+        return this;
+    }
+    styleUpdate(value) {
+        this._styleUpdate = value;
+        return this;
+    }
+    build() {
+        if (this._renderId === undefined)
+            throw new Error('missing renderId');
+        if (this._diyRender === undefined)
+            throw new Error('missing diyRender');
+        if (this._styleUpdate === undefined)
+            throw new Error('missing styleUpdate');
+        return { renderId: this._renderId, diyRender: this._diyRender, styleUpdate: this._styleUpdate };
+    }
+}

package/dist/src/bindings/value.d.ts

@@ -1,9 +1,13 @@
 export type Value = {
-    str: string;
+    type: 'str';
+    value: string;
 } | {
-    bool: boolean;
+    type: 'bool';
+    value: boolean;
 } | {
-    number: number;
+    type: 'number';
+    value: number;
 } | {
-    error: string;
+    type: 'error';
+    value: string;
 } | 'empty';

package/dist/src/bindings/value.js

@@ -1,2 +1 @@
-// DO NOT EDIT. CODE GENERATED BY gents.
 export {};

package/dist/src/bindings/vertical_alignment.js

@@ -1,2 +1 @@
-// DO NOT EDIT. CODE GENERATED BY gents.
 export {};

package/dist/src/bindings/workbook_file.js

@@ -1,2 +1 @@
-// DO NOT EDIT. CODE GENERATED BY gents.
 export {};

package/dist/src/bindings/workbook_update_type.js

@@ -1,2 +1 @@
-// DO NOT EDIT. CODE GENERATED BY gents.
 export {};

package/dist/src/client.d.ts

@@ -1,82 +1,25 @@
-import type { SheetDimension, SheetInfo, DisplayWindowWithStartPoint, CellPosition, BlockInfo, MergeCell, ErrorMessage } from './bindings';
-import type { Cell, CustomFunc } from './api';
-import type { Transaction } from './transactions';
+import type { ErrorMessage, ActionEffect, SheetCellId, WorkbookMethods, HandleTransactionParams } from './bindings';
+import type { CustomFunc } from './api';
 export type Resp<T> = Promise<T | ErrorMessage>;
 /**
  * The client is the interface for the workbook. This is used when the workbook
  * is wrapped by a server.
  */
-export interface Client {
+export interface Client extends WorkbookMethods {
     isReady(): Promise<void>;
-    getSheetDimension(sheetIdx: number): Resp<SheetDimension>;
-    getAllSheetInfo(params: GetAllSheetInfoParams): Resp<readonly SheetInfo[]>;
-    getDisplayWindow(params: GetDisplayWindowParams): Resp<DisplayWindowWithStartPoint>;
-    getCell(params: GetCellParams): Resp<Cell>;
-    getCellPosition(params: GetCellParams): Resp<CellPosition>;
-    getFullyCoveredBlocks(params: GetFullyCoveredBlocksParams): Resp<readonly BlockInfo[]>;
-    undo(): Resp<void>;
-    redo(): Resp<void>;
-    handleTransaction(params: HandleTransactionParams): Resp<void>;
-    loadWorkbook(params: LoadWorkbookParams): Resp<void>;
-    registryCustomFunc(f: CustomFunc): void;
-    registryCellUpdatedCallback(f: () => void): void;
-    registrySheetUpdatedCallback(f: () => void): void;
-    getMergedCells(params: GetMergedCellsParams): Resp<readonly MergeCell[]>;
-    calcCondition(params: CalcConditionParams): Resp<boolean>;
-}
-export interface GetAllSheetInfoParams {
-}
-export interface CalcConditionParams {
-    sheetIdx: number;
-    condition: string;
-}
-export interface GetDisplayWindowParams {
-    sheetIdx: number;
-    startX: number;
-    startY: number;
-    height: number;
-    width: number;
-}
-export interface GetDisplayWindowWithPositionParams {
-    sheetIdx: number;
-    row: number;
-    col: number;
-    height: number;
-    width: number;
-}
-export interface GetCellParams {
-    sheetIdx: number;
-    row: number;
-    col: number;
-}
-export interface HandleTransactionParams {
-    transaction: Transaction;
-}
-export interface LoadWorkbookParams {
-    content: Uint8Array;
-    name: string;
-}
-export interface MessageResp<T> {
-    result: T;
-    id: number;
-}
-export interface GetFullyCoveredBlocksParams {
-    sheetIdx: number;
-    row: number;
-    col: number;
-    height: number;
-    width: number;
-}
-export declare const enum WorkerUpdate {
-    Cell = 0,
-    Sheet = 1,
-    CellAndSheet = 2,
-    Ready = 3
-}
-export interface GetMergedCellsParams {
-    sheetIdx: number;
-    startRow: number;
-    startCol: number;
-    endRow: number;
-    endCol: number;
+    handleTransactionWithoutEvents(params: HandleTransactionParams): Resp<ActionEffect>;
+    registerCustomFunc(f: CustomFunc): void;
+    registerCellUpdatedCallback(f: () => void): void;
+    registerSheetUpdatedCallback(f: () => void): void;
+    registerCellValueChangedCallback(sheetIdx: number, rowIdx: number, colIdx: number, callback: () => void): Resp<void>;
+    /**
+     * Like {@link registerCellValueChangedCallback} but takes a
+     * pre-resolved {@link SheetCellId} — useful with
+     * `getCellIdByBlockRef` so subscriptions can be made by
+     * (refName, key, field) without the redundant (sheet,row,col)
+     * round-trip.
+     */
+    registerCellValueChangedByCellId(cellId: SheetCellId, callback: () => void): void;
+    registerCellRemovedCallback(sheetIdx: number, rowIdx: number, colIdx: number, callback: () => void): Resp<void>;
+    registerShadowCellValueChangedCallback(sheetIdx: number, rowIdx: number, colIdx: number, callback: () => void): Resp<number>;
 }

package/dist/src/index.d.ts

@@ -1,5 +1,7 @@
 export * from './api';
 export * from './payloads';
-export * from './transactions';
+export * from './types';
 export * from './client';
-export type { ActionEffect, Alignment, AsyncFuncResult, BlockInfo, Border, BorderPr, CellInfo, CellPosition, ColInfo, Color, Comment, CtCellProtection, CtFontFamily, CtFontName, CtFontScheme, CtUnderlineProperty, DisplayWindow, DisplayWindowWithStartPoint, EditAction, ErrorMessage, Fill, Font, HorizontalAlignment, MergeCell, PatternFill, RowInfo, SheetDimension, SheetInfo, StPatternType, Style, Task, Value, VerticalAlignment, StBorderStyle, } from './bindings';
+export * from './bindings';
+export * from './utils';
+export * from './layout';

package/dist/src/index.js

@@ -1,4 +1,7 @@
 export * from './api';
 export * from './payloads';
-export * from './transactions';
+export * from './types';
 export * from './client';
+export * from './bindings';
+export * from './utils';
+export * from './layout';

package/dist/src/layout.d.ts

@@ -0,0 +1,7 @@
+export interface CellLayout {
+    readonly sheetIdx: number;
+    readonly row: number;
+    readonly col: number;
+    readonly background?: string;
+    readonly tooltip?: string;
+}

package/dist/src/layout.js

@@ -0,0 +1 @@
+export {};

package/dist/src/payloads/index.d.ts

@@ -1,65 +1 @@
-import { BlockInput } from './block_input';
-import { CellClear } from './cell_clear';
-import { CellInput } from './cell_input';
-import { CreateBlock } from './create_block';
-import { DeleteBlockCols } from './delete_block_cols';
-import { DeleteBlockRows } from './delete_block_rows';
-import { DeleteCols } from './delete_cols';
-import { DeleteRows } from './delete_rows';
-import { DeleteSheet } from './delete_sheet';
-import { CellFormatBrush } from './cell_format_brush';
-import { LineFormatBrush } from './line_format_brush';
-import { InsertBlockCols } from './insert_block_cols';
-import { InsertBlockRows } from './insert_block_rows';
-import { InsertCols } from './insert_cols';
-import { InsertRows } from './insert_rows';
-import { InsertSheet } from './insert_sheet';
-import { MergeCells } from './merge_cells';
-import { MoveBlock } from './move_block';
-import { SetCellAlignment } from './set_cell_alignment';
-import { SetCellBorder } from './set_cell_border';
-import { SetCellFont } from './set_cell_font';
-import { SetCellPatternFill } from './set_cell_pattern_fill';
-import { SetColVisible } from './set_col_visible';
-import { SetColWidth } from './set_col_width';
-import { SetLineAlignment } from './set_line_alignment';
-import { SetLineBorder } from './set_line_border';
-import { SetLineFont } from './set_line_font';
-import { SetLinePatternFill } from './set_line_pattern_fill';
-import { SetRowHeight } from './set_row_height';
-import { SetRowVisible } from './set_row_visible';
-import { SheetRename } from './sheet_rename';
-import { SplitMergedCells } from './split_merged_cells';
-export * from './block_input';
-export * from './cell_clear';
-export * from './cell_input';
-export * from './create_block';
-export * from './delete_block_cols';
-export * from './delete_block_rows';
-export * from './delete_cols';
-export * from './delete_rows';
-export * from './delete_sheet';
-export * from './cell_format_brush';
-export * from './line_format_brush';
-export * from './insert_block_cols';
-export * from './insert_block_rows';
-export * from './insert_cols';
-export * from './insert_rows';
-export * from './insert_sheet';
-export * from './merge_cells';
-export * from './move_block';
-export * from './set_cell_alignment';
-export * from './set_cell_border';
-export * from './set_cell_font';
-export * from './set_cell_pattern_fill';
-export * from './set_col_visible';
-export * from './set_col_width';
-export * from './set_line_alignment';
-export * from './set_line_border';
-export * from './set_line_font';
-export * from './set_line_pattern_fill';
-export * from './set_row_height';
-export * from './set_row_visible';
-export * from './sheet_rename';
-export * from './split_merged_cells';
-export type Payload = BlockInput | CellClear | CellInput | CreateBlock | DeleteBlockCols | DeleteBlockRows | DeleteCols | DeleteRows | DeleteSheet | CellFormatBrush | InsertBlockCols | InsertBlockRows | InsertCols | InsertRows | InsertSheet | MergeCells | MoveBlock | SetCellAlignment | SetCellBorder | SetCellFont | SetCellPatternFill | SetColVisible | SetColWidth | SetLineAlignment | SetLineBorder | SetLineFont | SetLinePatternFill | SetRowHeight | SetRowVisible | SheetRename | SplitMergedCells | LineFormatBrush;
+export type { EditPayload as Payload } from '../bindings';

package/dist/src/payloads/index.js

@@ -1,32 +1 @@
-export * from './block_input';
-export * from './cell_clear';
-export * from './cell_input';
-export * from './create_block';
-export * from './delete_block_cols';
-export * from './delete_block_rows';
-export * from './delete_cols';
-export * from './delete_rows';
-export * from './delete_sheet';
-export * from './cell_format_brush';
-export * from './line_format_brush';
-export * from './insert_block_cols';
-export * from './insert_block_rows';
-export * from './insert_cols';
-export * from './insert_rows';
-export * from './insert_sheet';
-export * from './merge_cells';
-export * from './move_block';
-export * from './set_cell_alignment';
-export * from './set_cell_border';
-export * from './set_cell_font';
-export * from './set_cell_pattern_fill';
-export * from './set_col_visible';
-export * from './set_col_width';
-export * from './set_line_alignment';
-export * from './set_line_border';
-export * from './set_line_font';
-export * from './set_line_pattern_fill';
-export * from './set_row_height';
-export * from './set_row_visible';
-export * from './sheet_rename';
-export * from './split_merged_cells';
+export {};

package/dist/src/payloads/set_block_line_name_field.d.ts

@@ -0,0 +1,34 @@
+export interface SetBlockLineNameField {
+    readonly sheetIdx: number;
+    readonly blockId: number;
+    readonly line: number;
+    readonly isRow: boolean;
+    readonly name: string;
+    readonly fieldId: string;
+    readonly diyRender: boolean;
+}
+export declare class SetBlockLineNameFieldBuilder {
+    private _sheetIdx;
+    private _blockId;
+    private _line;
+    private _isRow;
+    private _name;
+    private _fieldId;
+    private _diyRender;
+    sheetIdx(value: number): this;
+    blockId(value: number): this;
+    line(value: number): this;
+    isRow(value: boolean): this;
+    name(value: string): this;
+    fieldId(value: string): this;
+    diyRender(value: boolean): this;
+    build(): {
+        sheetIdx: number;
+        blockId: number;
+        line: number;
+        isRow: boolean;
+        name: string;
+        fieldId: string;
+        diyRender: boolean;
+    };
+}

package/dist/src/payloads/set_block_line_name_field.js

@@ -0,0 +1,62 @@
+export class SetBlockLineNameFieldBuilder {
+    _sheetIdx;
+    _blockId;
+    _line;
+    _isRow;
+    _name;
+    _fieldId;
+    _diyRender;
+    sheetIdx(value) {
+        this._sheetIdx = value;
+        return this;
+    }
+    blockId(value) {
+        this._blockId = value;
+        return this;
+    }
+    line(value) {
+        this._line = value;
+        return this;
+    }
+    isRow(value) {
+        this._isRow = value;
+        return this;
+    }
+    name(value) {
+        this._name = value;
+        return this;
+    }
+    fieldId(value) {
+        this._fieldId = value;
+        return this;
+    }
+    diyRender(value) {
+        this._diyRender = value;
+        return this;
+    }
+    build() {
+        if (this._sheetIdx === undefined)
+            throw new Error('missing sheetIdx');
+        if (this._blockId === undefined)
+            throw new Error('missing blockId');
+        if (this._line === undefined)
+            throw new Error('missing line');
+        if (this._isRow === undefined)
+            throw new Error('missing isRow');
+        if (this._name === undefined)
+            throw new Error('missing name');
+        if (this._fieldId === undefined)
+            throw new Error('missing fieldId');
+        if (this._diyRender === undefined)
+            throw new Error('missing diyRender');
+        return {
+            sheetIdx: this._sheetIdx,
+            blockId: this._blockId,
+            line: this._line,
+            isRow: this._isRow,
+            name: this._name,
+            fieldId: this._fieldId,
+            diyRender: this._diyRender,
+        };
+    }
+}

package/dist/src/payloads/set_block_line_num_fmt.d.ts

@@ -0,0 +1,23 @@
+export interface SetBlockLineNumFmt {
+    readonly sheetIdx: number;
+    readonly blockId: number;
+    readonly from: number;
+    readonly to: number;
+    readonly isRow: boolean;
+    readonly numFmt: string;
+}
+export declare class SetBlockLineNumFmtBuilder {
+    private _sheetIdx?;
+    private _blockId?;
+    private _from?;
+    private _to?;
+    private _isRow?;
+    private _numFmt?;
+    sheetIdx(sheetIdx: number): this;
+    blockId(blockId: number): this;
+    from(from: number): this;
+    to(to: number): this;
+    isRow(isRow: boolean): this;
+    numFmt(numFmt: string): this;
+    build(): SetBlockLineNumFmt;
+}

package/dist/src/payloads/set_block_line_num_fmt.js

@@ -0,0 +1,54 @@
+export class SetBlockLineNumFmtBuilder {
+    _sheetIdx;
+    _blockId;
+    _from;
+    _to;
+    _isRow;
+    _numFmt;
+    sheetIdx(sheetIdx) {
+        this._sheetIdx = sheetIdx;
+        return this;
+    }
+    blockId(blockId) {
+        this._blockId = blockId;
+        return this;
+    }
+    from(from) {
+        this._from = from;
+        return this;
+    }
+    to(to) {
+        this._to = to;
+        return this;
+    }
+    isRow(isRow) {
+        this._isRow = isRow;
+        return this;
+    }
+    numFmt(numFmt) {
+        this._numFmt = numFmt;
+        return this;
+    }
+    build() {
+        if (this._sheetIdx === undefined)
+            throw Error('sheetIdx is undefined!');
+        if (this._blockId === undefined)
+            throw Error('blockId is undefined!');
+        if (this._from === undefined)
+            throw Error('from is undefined!');
+        if (this._to === undefined)
+            throw Error('to is undefined!');
+        if (this._isRow === undefined)
+            throw Error('isRow is undefined!');
+        if (this._numFmt === undefined)
+            throw Error('numFmt is undefined!');
+        return {
+            sheetIdx: this._sheetIdx,
+            blockId: this._blockId,
+            from: this._from,
+            to: this._to,
+            isRow: this._isRow,
+            numFmt: this._numFmt,
+        };
+    }
+}

package/dist/src/payloads/set_cell_alignment.d.ts

@@ -1,6 +1,5 @@
 import { Alignment } from '../bindings';
 export interface SetCellAlignment {
-    readonly type: 'setCellAlignment';
     readonly sheetIdx: number;
     readonly row: number;
     readonly col: number;

package/dist/src/payloads/set_cell_alignment.js

@@ -29,7 +29,6 @@ export class SetCellAlignmentBuilder {
         if (this._alignment === undefined)
             throw Error('alignment is undefined!');
         return {
-            type: 'setCellAlignment',
             sheetIdx: this._sheetIdx,
             row: this._row,
             col: this._col,

package/dist/src/payloads/set_cell_border.d.ts

@@ -1,6 +1,5 @@
 import { StBorderStyle } from '../bindings';
 export interface SetCellBorder {
-    readonly type: 'setCellBorder';
     readonly sheetIdx: number;
     readonly row: number;
     readonly col: number;

package/dist/src/payloads/set_cell_border.js

@@ -77,7 +77,6 @@ export class SetCellBorderBuilder {
         if (this._col === undefined)
             throw Error('col is undefined!');
         return {
-            type: 'setCellBorder',
             sheetIdx: this._sheetIdx,
             row: this._row,
             col: this._col,

package/dist/src/payloads/set_cell_font.d.ts

@@ -1,6 +1,5 @@
 import { StUnderlineValues as UnderlineType } from '../bindings';
 export interface SetCellFont {
-    readonly type: 'setCellFont';
     readonly sheetIdx: number;
     readonly row: number;
     readonly col: number;

package/dist/src/payloads/set_cell_font.js

@@ -72,7 +72,6 @@ export class SetCellFontBuilder {
         if (this._col === undefined)
             throw Error('col is undefined!');
         return {
-            type: 'setCellFont',
             sheetIdx: this._sheetIdx,
             row: this._row,
             col: this._col,

package/dist/src/payloads/{cell_clear.d.ts → set_cell_num_fmt.d.ts}

@@ -1,15 +1,17 @@
-export interface CellClear {
-    readonly type: 'cellClear';
+export interface SetCellNumFmt {
     readonly sheetIdx: number;
     readonly row: number;
     readonly col: number;
+    readonly numFmt: string;
 }
-export declare class CellClearBuilder {
+export declare class SetCellNumFmtBuilder {
     private _sheetIdx?;
     private _row?;
     private _col?;
+    private _numFmt?;
     sheetIdx(sheetIdx: number): this;
     row(row: number): this;
     col(col: number): this;
-    build(): CellClear;
+    numFmt(numFmt: string): this;
+    build(): SetCellNumFmt;
 }

package/dist/src/payloads/{cell_input.js → set_cell_num_fmt.js}

@@ -1,8 +1,8 @@
-export class CellInputBuilder {
+export class SetCellNumFmtBuilder {
     _sheetIdx;
     _row;
     _col;
-    _input;
+    _numFmt;
     sheetIdx(sheetIdx) {
         this._sheetIdx = sheetIdx;
         return this;
@@ -15,8 +15,8 @@ export class CellInputBuilder {
         this._col = col;
         return this;
     }
-    input(input) {
-        this._input = input;
+    numFmt(numFmt) {
+        this._numFmt = numFmt;
         return this;
     }
     build() {
@@ -26,14 +26,13 @@ export class CellInputBuilder {
             throw Error('row is undefined!');
         if (this._col === undefined)
             throw Error('col is undefined!');
-        if (this._input === undefined)
-            throw Error('input is undefined!');
+        if (this._numFmt === undefined)
+            throw Error('numFmt is undefined!');
         return {
-            type: 'cellInput',
             sheetIdx: this._sheetIdx,
             row: this._row,
             col: this._col,
-            input: this._input,
+            numFmt: this._numFmt,
         };
     }
 }

package/dist/src/payloads/set_cell_pattern_fill.d.ts

@@ -1,6 +1,5 @@
 import { StPatternType } from '../bindings';
 export interface SetCellPatternFill {
-    readonly type: 'setCellPatternFill';
     readonly sheetIdx: number;
     readonly row: number;
     readonly col: number;

package/dist/src/payloads/set_cell_pattern_fill.js

@@ -37,7 +37,6 @@ export class SetCellPatternFillBuilder {
         if (this._col === undefined)
             throw Error('col is undefined!');
         return {
-            type: 'setCellPatternFill',
             sheetIdx: this._sheetIdx,
             row: this._row,
             col: this._col,

package/dist/src/payloads/{split_merged_cells.d.ts → set_cell_wrap_text.d.ts}

@@ -1,15 +1,17 @@
-export interface SplitMergedCells {
-    readonly type: 'splitMergedCells';
+export interface SetCellWrapText {
     readonly sheetIdx: number;
     readonly row: number;
     readonly col: number;
+    readonly wrapText: boolean;
 }
-export declare class SplitMergedCellsBuilder {
+export declare class SetCellWrapTextBuilder {
     private _sheetIdx?;
     private _row?;
     private _col?;
+    private _wrapText?;
     sheetIdx(sheetIdx: number): this;
     row(row: number): this;
     col(col: number): this;
-    build(): SplitMergedCells;
+    wrapText(value: boolean): this;
+    build(): SetCellWrapText;
 }