logisheets 0.7.0 → 1.0.0

package/dist/src/bindings/style_update_type.js

@@ -1 +1,125 @@
-export {};
+export class StyleUpdateTypeBuilder {
+    _setFontBold;
+    _setFontItalic;
+    _setFontUnderline;
+    _setFontColor;
+    _setFontSize;
+    _setFontName;
+    _setFontOutline;
+    _setFontShadow;
+    _setFontStrike;
+    _setFontCondense;
+    _setLeftBorderColor;
+    _setRightBorderColor;
+    _setTopBorderColor;
+    _setBottomBorderColor;
+    _setLeftBorderStyle;
+    _setRightBorderStyle;
+    _setTopBorderStyle;
+    _setBottomBorderStyle;
+    _setBorderGiagonalUp;
+    _setBorderGiagonalDown;
+    _setBorderOutline;
+    _setPatternFill;
+    _setAlignment;
+    _setNumFmt;
+    setFontBold(value) {
+        this._setFontBold = value;
+        return this;
+    }
+    setFontItalic(value) {
+        this._setFontItalic = value;
+        return this;
+    }
+    setFontUnderline(value) {
+        this._setFontUnderline = value;
+        return this;
+    }
+    setFontColor(value) {
+        this._setFontColor = value;
+        return this;
+    }
+    setFontSize(value) {
+        this._setFontSize = value;
+        return this;
+    }
+    setFontName(value) {
+        this._setFontName = value;
+        return this;
+    }
+    setFontOutline(value) {
+        this._setFontOutline = value;
+        return this;
+    }
+    setFontShadow(value) {
+        this._setFontShadow = value;
+        return this;
+    }
+    setFontStrike(value) {
+        this._setFontStrike = value;
+        return this;
+    }
+    setFontCondense(value) {
+        this._setFontCondense = value;
+        return this;
+    }
+    setLeftBorderColor(value) {
+        this._setLeftBorderColor = value;
+        return this;
+    }
+    setRightBorderColor(value) {
+        this._setRightBorderColor = value;
+        return this;
+    }
+    setTopBorderColor(value) {
+        this._setTopBorderColor = value;
+        return this;
+    }
+    setBottomBorderColor(value) {
+        this._setBottomBorderColor = value;
+        return this;
+    }
+    setLeftBorderStyle(value) {
+        this._setLeftBorderStyle = value;
+        return this;
+    }
+    setRightBorderStyle(value) {
+        this._setRightBorderStyle = value;
+        return this;
+    }
+    setTopBorderStyle(value) {
+        this._setTopBorderStyle = value;
+        return this;
+    }
+    setBottomBorderStyle(value) {
+        this._setBottomBorderStyle = value;
+        return this;
+    }
+    setBorderGiagonalUp(value) {
+        this._setBorderGiagonalUp = value;
+        return this;
+    }
+    setBorderGiagonalDown(value) {
+        this._setBorderGiagonalDown = value;
+        return this;
+    }
+    setBorderOutline(value) {
+        this._setBorderOutline = value;
+        return this;
+    }
+    setPatternFill(value) {
+        this._setPatternFill = value;
+        return this;
+    }
+    setAlignment(value) {
+        this._setAlignment = value;
+        return this;
+    }
+    setNumFmt(value) {
+        this._setNumFmt = value;
+        return this;
+    }
+    build() {
+        return { setFontBold: this._setFontBold, setFontItalic: this._setFontItalic, setFontUnderline: this._setFontUnderline, setFontColor: this._setFontColor, setFontSize: this._setFontSize, setFontName: this._setFontName, setFontOutline: this._setFontOutline, setFontShadow: this._setFontShadow, setFontStrike: this._setFontStrike, setFontCondense: this._setFontCondense, setLeftBorderColor: this._setLeftBorderColor, setRightBorderColor: this._setRightBorderColor, setTopBorderColor: this._setTopBorderColor, setBottomBorderColor: this._setBottomBorderColor, setLeftBorderStyle: this._setLeftBorderStyle, setRightBorderStyle: this._setRightBorderStyle, setTopBorderStyle: this._setTopBorderStyle, setBottomBorderStyle: this._setBottomBorderStyle, setBorderGiagonalUp: this._setBorderGiagonalUp, setBorderGiagonalDown: this._setBorderGiagonalDown, setBorderOutline: this._setBorderOutline, setPatternFill: this._setPatternFill, setAlignment: this._setAlignment, setNumFmt: this._setNumFmt };
+    }
+}

package/dist/src/bindings/task.js

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

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

@@ -0,0 +1,8 @@
+import { Value } from './value';
+export interface TempCellChange {
+    sheetIdx: number;
+    row: number;
+    col: number;
+    oldValue: Value;
+    newValue: Value;
+}

package/dist/src/bindings/temp_cell_change.js

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

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

@@ -0,0 +1,4 @@
+import { TempCellChange } from './temp_cell_change';
+export interface TempStatusDiff {
+    cells: readonly TempCellChange[];
+}

package/dist/src/bindings/temp_status_diff.js

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

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

@@ -0,0 +1 @@
+export type TokenType = 'funcName' | 'funcArg' | 'cellReference' | 'errorConstant' | 'wrongSuffix' | 'other';

package/dist/src/bindings/token_type.js

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

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

@@ -0,0 +1,6 @@
+import { TokenType } from './token_type';
+export interface TokenUnit {
+    tokenType: TokenType;
+    start: number;
+    end: number;
+}

package/dist/src/bindings/token_unit.js

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

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

@@ -0,0 +1,18 @@
+export interface UpsertFieldFormulas {
+    sheetIdx: number;
+    blockId: number;
+    fieldFormulas: readonly string[];
+}
+export declare class UpsertFieldFormulasBuilder {
+    private _sheetIdx;
+    private _blockId;
+    private _fieldFormulas;
+    sheetIdx(value: number): this;
+    blockId(value: number): this;
+    fieldFormulas(value: readonly string[]): this;
+    build(): {
+        sheetIdx: number;
+        blockId: number;
+        fieldFormulas: readonly string[];
+    };
+}

package/dist/src/bindings/upsert_field_formulas.js

@@ -0,0 +1,26 @@
+export class UpsertFieldFormulasBuilder {
+    _sheetIdx;
+    _blockId;
+    _fieldFormulas;
+    sheetIdx(value) {
+        this._sheetIdx = value;
+        return this;
+    }
+    blockId(value) {
+        this._blockId = value;
+        return this;
+    }
+    fieldFormulas(value) {
+        this._fieldFormulas = value;
+        return this;
+    }
+    build() {
+        if (this._sheetIdx === undefined)
+            throw new Error('missing sheetIdx');
+        if (this._blockId === undefined)
+            throw new Error('missing blockId');
+        if (this._fieldFormulas === undefined)
+            throw new Error('missing fieldFormulas');
+        return { sheetIdx: this._sheetIdx, blockId: this._blockId, fieldFormulas: this._fieldFormulas };
+    }
+}

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 declare type Value = {
-    str: string;
+export type Value = {
+    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.d.ts

@@ -0,0 +1 @@
+export type VerticalAlignment = 'center' | 'top' | 'bottom' | 'justify' | 'distributed';

package/dist/src/bindings/vertical_alignment.js

@@ -0,0 +1 @@
+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.d.ts

@@ -0,0 +1 @@
+export type WorkbookUpdateType = 'doNothing' | 'cell' | 'sheet' | 'sheetAndCell' | 'undoNothing' | 'redoNothing' | 'undo' | 'redo' | 'ephemeralCells';

package/dist/src/bindings/workbook_update_type.js

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

package/dist/src/client.d.ts

@@ -0,0 +1,25 @@
+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 extends WorkbookMethods {
+    isReady(): Promise<void>;
+    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/client.js

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

package/dist/src/index.d.ts

@@ -1,4 +1,7 @@
 export * from './api';
 export * from './payloads';
-export * from './transactions';
-export type { ActionEffect, AsyncFuncResult, BlockInfo, Border, BorderPr, ColInfo, Color, Comment, CtCellAlignment, CtCellProtection, CtFontFamily, CtFontName, CtFontScheme, CtUnderlineProperty, DisplayPatch, DisplayRequest, DisplayResponse, EditAction, Fill, Font, MergeCell, PatternFill, RowInfo, SheetBlocks, SheetColInfo, SheetComments, SheetMergeCells, SheetNames, SheetRowInfo, SheetStyles, SheetValues, StHorizontalAlignment, StPatternType, StVerticalAlignment, Style, Task, Value, } from './bindings';
+export * from './types';
+export * from './client';
+export * from './bindings';
+export * from './utils';
+export * from './layout';

package/dist/src/index.js

@@ -1,3 +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,43 +1 @@
-import { BlockInput } from './block_input';
-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 { 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 { MoveBlock } from './move_block';
-import { SetBorder } from './set_border';
-import { SetColVisible } from './set_col_visible';
-import { SetColWidth } from './set_col_width';
-import { SetFont } from './set_font';
-import { SetRowHeight } from './set_row_height';
-import { SetRowVisible } from './set_row_visible';
-import { SheetRename } from './sheet_rename';
-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 './insert_block_cols';
-export * from './insert_block_rows';
-export * from './insert_cols';
-export * from './insert_rows';
-export * from './insert_sheet';
-export * from './move_block';
-export * from './set_border';
-export * from './set_col_visible';
-export * from './set_col_width';
-export * from './set_font';
-export * from './set_row_height';
-export * from './set_row_visible';
-export * from './sheet_rename';
-export * from './block_input';
-export declare type Payload = BlockInput | CellInput | CreateBlock | DeleteBlockCols | DeleteBlockRows | DeleteCols | DeleteRows | DeleteSheet | InsertBlockCols | InsertBlockRows | InsertCols | InsertRows | InsertSheet | MoveBlock | SetBorder | SetColVisible | SetColWidth | SetFont | SetRowHeight | SetRowVisible | SheetRename;
+export type { EditPayload as Payload } from '../bindings';

package/dist/src/payloads/index.js

@@ -1,21 +1 @@
-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 './insert_block_cols';
-export * from './insert_block_rows';
-export * from './insert_cols';
-export * from './insert_rows';
-export * from './insert_sheet';
-export * from './move_block';
-export * from './set_border';
-export * from './set_col_visible';
-export * from './set_col_width';
-export * from './set_font';
-export * from './set_row_height';
-export * from './set_row_visible';
-export * from './sheet_rename';
-export * from './block_input';
+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

@@ -0,0 +1,18 @@
+import { Alignment } from '../bindings';
+export interface SetCellAlignment {
+    readonly sheetIdx: number;
+    readonly row: number;
+    readonly col: number;
+    readonly alignment: Alignment;
+}
+export declare class SetCellAlignmentBuilder {
+    private _sheetIdx?;
+    private _row?;
+    private _col?;
+    private _alignment?;
+    sheetIdx(sheetIdx: number): this;
+    row(row: number): this;
+    col(col: number): this;
+    alignment(value: Alignment): this;
+    build(): SetCellAlignment;
+}