logisheets 0.6.0

package/README.md

@@ -0,0 +1,15 @@
+# LogiSheets
+
+## What is LogiSheets?
+
+LogiSheets is a web-based spreadsheet application that seamlessly integrates with Excel and is crafted for expansion. Notably, it comes at no cost!
+
+You can utilize the Rust crate and Node package to efficiently read, perform operations, and write .xlsx files.
+
+We are also working on a user interface to enable users to use spreadsheets directly in their web browsers.
+
+## WARNING
+
+This version is specifically used for Node. If you are seeking a version compatible with web browsers, please see [`logisheets-web`](https://www.npmjs.com/package/logisheets-web).
+
+LogiSheets is currently in its **early development** stages. We welcome your feedback, issues, or pull requests!

package/index.ts

@@ -0,0 +1 @@
+export * from './src'

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "logisheets",
+  "version": "0.6.0",
+  "description": "Read and write the xlsx files",
+  "main": "index.js",
+  "scripts": {
+    "wasm-build": "wasm-pack build ../../crates/wasms/server --out-dir ../../../packages/node/wasm --target nodejs",
+    "link": "rm -rf ./src && cp -r ../web/src ./src",
+    "prepublishOnly": "yarn link && yarn wasm-build",
+    "prepare": "yarn link && yarn wasm-build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/logisky/LogiSheets.git"
+  },
+  "keywords": [
+    "xlsx",
+    "spreadsheets"
+  ],
+  "author": "Jeremy He<yiliang.he@qq.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/logisky/LogiSheets/issues"
+  },
+  "homepage": "https://github.com/logisky/LogiSheets",
+  "files": [
+    "wasm/*",
+    "src/*",
+    "index.ts"
+  ]
+}

package/src/api/index.ts

@@ -0,0 +1 @@
+export * from './workbook'

package/src/api/workbook.ts

@@ -0,0 +1,201 @@
+import {Payload} from '../payloads'
+import {
+    new_workbook,
+    undo,
+    redo,
+    transaction_end,
+    transaction_start,
+    cell_input,
+    row_insert,
+    row_delete,
+    col_insert,
+    col_delete,
+    create_block,
+    move_block,
+    block_input,
+    set_font,
+    set_border,
+    read_file,
+    release,
+    input_async_result,
+    get_patches,
+    block_line_shift,
+    sheet_rename_by_idx,
+    sheet_rename_by_name,
+    create_sheet,
+    delete_sheet,
+} from '../../wasm/logisheets_wasm_server'
+import {ActionEffect, AsyncFuncResult, DisplayResponse} from '../bindings'
+import {Transaction} from '../transactions'
+
+export type ReturnCode = number
+
+export class Workbook {
+    public constructor() {
+        this._id = new_workbook()
+    }
+
+    public undo(): boolean {
+        return undo(this._id)
+    }
+
+    public redo(): boolean {
+        return redo(this._id)
+    }
+
+    public execTransaction(tx: Transaction, undoable: boolean): ActionEffect {
+        transaction_start(this._id)
+        tx.payloads.forEach((p: Payload) => {
+            this._addPayload(p)
+        })
+        return transaction_end(this._id, undoable) as ActionEffect
+    }
+
+    public load(buf: Uint8Array, book_name: string): ReturnCode {
+        return read_file(this._id, book_name, buf)
+    }
+
+    public release() {
+        release(this._id)
+    }
+
+    public inputAsyncResult(r: AsyncFuncResult): ActionEffect {
+        return input_async_result(this._id, r) as ActionEffect
+    }
+
+    public getPatches(sheet_idx: number, version: number): DisplayResponse {
+        const res = get_patches(this._id, sheet_idx, version)
+        return res as DisplayResponse
+    }
+
+    private _addPayload(p: Payload) {
+        if (p.type === 'cellInput')
+            return cell_input(this._id, p.sheetIdx, p.row, p.col, p.input)
+        if (p.type === 'insertRows')
+            return row_insert(this._id, p.sheetIdx, p.start, p.cnt)
+        if (p.type === 'deleteRows')
+            return row_delete(this._id, p.sheetIdx, p.start, p.cnt)
+        if (p.type === 'insertCols')
+            return col_insert(this._id, p.sheetIdx, p.start, p.cnt)
+        if (p.type === 'deleteCols')
+            return col_delete(this._id, p.sheetIdx, p.start, p.cnt)
+        if (p.type === 'createBlock')
+            return create_block(
+                this._id,
+                p.sheetIdx,
+                p.blockId,
+                p.masterRow,
+                p.masterCol,
+                p.rowCnt,
+                p.colCnt
+            )
+
+        if (p.type === 'moveBlock')
+            return move_block(
+                this._id,
+                p.sheetIdx,
+                p.blockId,
+                p.newMasterRow,
+                p.newMasterCol
+            )
+        if (p.type === 'setBorder')
+            return set_border(
+                this._id,
+                p.sheetIdx,
+                p.row,
+                p.col,
+                p.leftColor,
+                p.rightColor,
+                p.topColor,
+                p.bottomColor,
+                p.leftBorderType,
+                p.rightBorderType,
+                p.topBorderType,
+                p.bottomBorderType,
+                p.outline,
+                p.diagonalUp,
+                p.diagonalDown
+            )
+        if (p.type === 'setFont')
+            return set_font(
+                this._id,
+                p.sheetIdx,
+                p.row,
+                p.col,
+                p.bold,
+                p.italic,
+                p.name,
+                p.underline,
+                p.color,
+                p.size,
+                p.outline,
+                p.shadow,
+                p.strike,
+                p.condense
+            )
+        if (p.type === 'blockInput')
+            return block_input(
+                this._id,
+                p.sheetIdx,
+                p.blockId,
+                p.row,
+                p.col,
+                p.input
+            )
+
+        if (p.type === 'insertBlockCols')
+            return block_line_shift(
+                this._id,
+                p.sheetIdx,
+                p.blockId,
+                p.colIdx,
+                p.cnt,
+                false,
+                true
+            )
+        if (p.type === 'insertBlockRows')
+            return block_line_shift(
+                this._id,
+                p.sheetIdx,
+                p.blockId,
+                p.rowIdx,
+                p.cnt,
+                true,
+                true
+            )
+        if (p.type === 'deleteBlockRows')
+            return block_line_shift(
+                this._id,
+                p.sheetIdx,
+                p.blockId,
+                p.rowIdx,
+                p.cnt,
+                true,
+                false
+            )
+        if (p.type === 'deleteBlockCols')
+            return block_line_shift(
+                this._id,
+                p.sheetIdx,
+                p.blockId,
+                p.colIdx,
+                p.cnt,
+                true,
+                true
+            )
+        if (p.type === 'sheetRename') {
+            if (p.oldName) {
+                return sheet_rename_by_name(this._id, p.oldName, p.newName)
+            }
+            if (p.idx) {
+                return sheet_rename_by_idx(this._id, p.idx, p.newName)
+            }
+        }
+        if (p.type === 'deleteSheet') return delete_sheet(this._id, p.sheetIdx)
+        if (p.type === 'insertSheet')
+            return create_sheet(this._id, p.sheetIdx, p.name)
+        // eslint-disable-next-line no-console
+        console.log('Unimplemented!')
+    }
+    private _id: number
+}

package/src/bindings/action_effect.ts

@@ -0,0 +1,17 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+import {StatusCode} from './status_code'
+import {Task} from './task'
+
+// `ActionEffect` represents the result of handling `EditAction`.
+// `version` would be increased if the action is successfully handled.
+// 
+// What's more, since `LogiSheets` provides developers with the ability
+// of developing their own functions, in these cases, `engine` will not know
+// how to compute them and just return it the JS side.
+export interface ActionEffect {
+    // The latest version after processing an action
+    version: number
+    // Tasks should be calculated outside this engine(mainly because of network limitations and customer defined)
+    asyncTasks: readonly Task[]
+    status: StatusCode
+}

package/src/bindings/async_func_result.ts

@@ -0,0 +1,12 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+import {Task} from './task'
+
+// The results of the tasks which are passed to JS side to calculate previously.
+export interface AsyncFuncResult {
+    tasks: readonly Task[]
+    // These strings can be numbers, strings and other things.
+    // Note that now error types are hardcoded, which means if the
+    // value is equal to the a specific string like `#TIMEOUT!`,
+    // it is reagarded as an error.
+    values: readonly string[]
+}

package/src/bindings/block_cell_id.ts

@@ -0,0 +1,7 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+
+export interface BlockCellId {
+    block_id: number
+    row: number
+    col: number
+}

package/src/bindings/block_info.ts

@@ -0,0 +1,9 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+
+export interface BlockInfo {
+    blockId: number
+    rowStart: number
+    rowCnt: number
+    colStart: number
+    colCnt: number
+}

package/src/bindings/block_input.ts

@@ -0,0 +1,9 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+
+export interface BlockInput {
+    sheetIdx: number
+    blockId: number
+    row: number
+    col: number
+    input: string
+}

package/src/bindings/block_style_update.ts

@@ -0,0 +1,10 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+import {StyleUpdateType} from './style_update_type'
+
+export interface BlockStyleUpdate {
+    sheetIdx: number
+    blockId: number
+    row: number
+    col: number
+    styleUpdate: StyleUpdateType
+}

package/src/bindings/border.ts

@@ -0,0 +1,15 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+import {BorderPr} from './border_pr'
+
+export interface Border {
+    left?: BorderPr
+    right?: BorderPr
+    top?: BorderPr
+    bottom?: BorderPr
+    diagonal?: BorderPr
+    vertical?: BorderPr
+    horizontal?: BorderPr
+    diagonalUp?: boolean
+    diagonalDown?: boolean
+    outline: boolean
+}

package/src/bindings/border_pr.ts

@@ -0,0 +1,8 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+import {Color} from './color'
+import {StBorderStyle} from './st_border_style'
+
+export interface BorderPr {
+    color?: Color
+    style: StBorderStyle
+}

package/src/bindings/cell_alignment.ts

@@ -0,0 +1,15 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+import {StHorizontalAlignment} from './st_horizontal_alignment'
+import {StVerticalAlignment} from './st_vertical_alignment'
+
+export interface CtCellAlignment {
+    horizontal?: StHorizontalAlignment
+    vertical?: StVerticalAlignment
+    textRotation?: number
+    wrapText?: boolean
+    indent?: number
+    relativeIndent?: number
+    justifyLastLine?: boolean
+    shrinkToFit?: boolean
+    readingOrder?: number
+}

package/src/bindings/cell_formula_value.ts

@@ -0,0 +1,9 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+import {Value} from './value'
+
+export interface CellFormulaValue {
+    row: number
+    col: number
+    formula: string
+    value: Value
+}

package/src/bindings/cell_id.ts

@@ -0,0 +1,7 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+import {BlockCellId} from './block_cell_id'
+import {NormalCellId} from './normal_cell_id'
+
+export type CellId =
+    | {NormalCell: NormalCellId}
+    | {BlockCell: BlockCellId}

package/src/bindings/cell_input.ts

@@ -0,0 +1,9 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+
+// Take the `content` as input to the cell. The type of the `content` can be referred automatically.
+export interface CellInput {
+    sheetIdx: number
+    row: number
+    col: number
+    content: string
+}

package/src/bindings/cell_protection.ts

@@ -0,0 +1,6 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+
+export interface CtCellProtection {
+    locked?: boolean
+    hidden?: boolean
+}

package/src/bindings/cell_style.ts

@@ -0,0 +1,8 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+import {Style} from './style'
+
+export interface CellStyle {
+    row: number
+    col: number
+    style: Style
+}

package/src/bindings/col_info.ts

@@ -0,0 +1,7 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+
+export interface ColInfo {
+    idx: number
+    width: number
+    hidden: boolean
+}

package/src/bindings/color.ts

@@ -0,0 +1,8 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+
+export interface Color {
+    red?: number
+    green?: number
+    blue?: number
+    alpha?: number
+}

package/src/bindings/comment.ts

@@ -0,0 +1,8 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+
+export interface Comment {
+    row: number
+    col: number
+    author: string
+    content: string
+}

package/src/bindings/create_block.ts

@@ -0,0 +1,15 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+
+// Create a new block.
+// 
+// Note that the block id is assigned by you. You are supposed to
+// manage all your blocks. If the `block id` is already existed, engines
+// will remove the old one.
+export interface CreateBlock {
+    sheetIdx: number
+    id: number
+    masterRow: number
+    masterCol: number
+    rowCnt: number
+    colCnt: number
+}

package/src/bindings/create_sheet.ts

@@ -0,0 +1,6 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+
+export interface CreateSheet {
+    idx: number
+    newName: string
+}

package/src/bindings/delete_cols.ts

@@ -0,0 +1,7 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+
+export interface DeleteCols {
+    sheetIdx: number
+    start: number
+    count: number
+}

package/src/bindings/delete_cols_in_block.ts

@@ -0,0 +1,8 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+
+export interface DeleteColsInBlock {
+    sheetIdx: number
+    blockId: number
+    start: number
+    cnt: number
+}

package/src/bindings/delete_rows.ts

@@ -0,0 +1,7 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+
+export interface DeleteRows {
+    sheetIdx: number
+    start: number
+    count: number
+}

package/src/bindings/delete_rows_in_block.ts

@@ -0,0 +1,8 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+
+export interface DeleteRowsInBlock {
+    sheetIdx: number
+    blockId: number
+    start: number
+    cnt: number
+}

package/src/bindings/delete_sheet.ts

@@ -0,0 +1,5 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+
+export interface DeleteSheet {
+    idx: number
+}

package/src/bindings/display_patch.ts

@@ -0,0 +1,19 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+import {SheetBlocks} from './sheet_blocks'
+import {SheetColInfo} from './sheet_col_info'
+import {SheetComments} from './sheet_comments'
+import {SheetMergeCells} from './sheet_merge_cells'
+import {SheetNames} from './sheet_names'
+import {SheetRowInfo} from './sheet_row_info'
+import {SheetStyles} from './sheet_styles'
+import {SheetValues} from './sheet_values'
+
+export type DisplayPatch =
+    | {values: SheetValues}
+    | {styles: SheetStyles}
+    | {rowInfo: SheetRowInfo}
+    | {colInfo: SheetColInfo}
+    | {mergeCells: SheetMergeCells}
+    | {comments: SheetComments}
+    | {blocks: SheetBlocks}
+    | {sheetNames: SheetNames}

package/src/bindings/display_request.ts

@@ -0,0 +1,6 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+
+export interface DisplayRequest {
+    sheetIdx: number
+    version: number
+}

package/src/bindings/display_response.ts

@@ -0,0 +1,7 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+import {DisplayPatch} from './display_patch'
+
+export interface DisplayResponse {
+    incremental: boolean
+    patches: readonly DisplayPatch[]
+}

package/src/bindings/edit_action.ts

@@ -0,0 +1,10 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+import {PayloadsAction} from './payloads_action'
+import {RecalcCell} from './recalc_cell'
+
+// `EditAction` represents your update behavior to the workbook.
+export type EditAction =
+    | 'undo'
+    | 'redo'
+    | {payloads: PayloadsAction}
+    | {recalc: readonly RecalcCell[]}

package/src/bindings/edit_payload.ts

@@ -0,0 +1,47 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+import {BlockInput} from './block_input'
+import {BlockStyleUpdate} from './block_style_update'
+import {CellInput} from './cell_input'
+import {CreateBlock} from './create_block'
+import {CreateSheet} from './create_sheet'
+import {DeleteColsInBlock} from './delete_cols_in_block'
+import {DeleteCols} from './delete_cols'
+import {DeleteRowsInBlock} from './delete_rows_in_block'
+import {DeleteRows} from './delete_rows'
+import {DeleteSheet} from './delete_sheet'
+import {InsertColsInBlock} from './insert_cols_in_block'
+import {InsertCols} from './insert_cols'
+import {InsertRowsInBlock} from './insert_rows_in_block'
+import {InsertRows} from './insert_rows'
+import {MoveBlock} from './move_block'
+import {RemoveBlock} from './remove_block'
+import {SetColWidth} from './set_col_width'
+import {SetRowHeight} from './set_row_height'
+import {SetVisible} from './set_visible'
+import {SheetRename} from './sheet_rename'
+import {StyleUpdate} from './style_update'
+
+// `EditPayload` is the basic update unit of the Workbook. Developers can config their own
+// `EditAction` (e.g. setting a button to create a table) to facilitate their users.
+export type EditPayload =
+    | {blockInput: BlockInput}
+    | {moveBlock: MoveBlock}
+    | {removeBlock: RemoveBlock}
+    | {createBlock: CreateBlock}
+    | {styleUpdate: StyleUpdate}
+    | {blockStyleUpdate: BlockStyleUpdate}
+    | {cellInput: CellInput}
+    | {setColWidth: SetColWidth}
+    | {setRowHeight: SetRowHeight}
+    | {setVisible: SetVisible}
+    | {sheetRename: SheetRename}
+    | {createSheet: CreateSheet}
+    | {deleteSheet: DeleteSheet}
+    | {insertCols: InsertCols}
+    | {deleteCols: DeleteCols}
+    | {insertRows: InsertRows}
+    | {deleteRows: DeleteRows}
+    | {insertColsInBlock: InsertColsInBlock}
+    | {deleteColsInBlock: DeleteColsInBlock}
+    | {insertRowsInBlock: InsertRowsInBlock}
+    | {deleteRowsInBlock: DeleteRowsInBlock}

package/src/bindings/fill.ts

@@ -0,0 +1,7 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+import {GradientFill} from './gradient_fill'
+import {PatternFill} from './pattern_fill'
+
+export type Fill =
+    | {patternFill: PatternFill}
+    | {gradientFill: GradientFill}

package/src/bindings/font.ts

@@ -0,0 +1,25 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+import {Color} from './color'
+import {CtFontFamily} from './font_family'
+import {CtFontName} from './font_name'
+import {CtFontScheme} from './font_scheme'
+import {CtUnderlineProperty} from './underline_property'
+import {CtVerticalAlignFontProperty} from './vertical_align_font_property'
+
+export interface Font {
+    bold: boolean
+    italic: boolean
+    underline?: CtUnderlineProperty
+    color?: Color
+    sz?: number
+    name?: CtFontName
+    charset?: number
+    family?: CtFontFamily
+    strike: boolean
+    outline: boolean
+    shadow: boolean
+    condense: boolean
+    extend: boolean
+    vertAlign?: CtVerticalAlignFontProperty
+    scheme?: CtFontScheme
+}

package/src/bindings/font_family.ts

@@ -0,0 +1,5 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+
+export interface CtFontFamily {
+    val: number
+}

package/src/bindings/font_name.ts

@@ -0,0 +1,5 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+
+export interface CtFontName {
+    val: string
+}

package/src/bindings/font_scheme.ts

@@ -0,0 +1,6 @@
+// DO NOT EDIT. CODE GENERATED BY gents.
+import {StFontScheme} from './st_font_scheme'
+
+export interface CtFontScheme {
+    val: StFontScheme
+}