@mescius/spread-sheets-collaboration-client 18.0.7 → 18.1.0

package/dist/index.d.ts

@@ -1,41 +1,642 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import { OT_Type, SharedDoc } from "@mescius/js-collaboration-ot-client";
-import {Presence} from "@mescius/js-collaboration-presence-client";
+import { Presence } from "@mescius/js-collaboration-presence-client";
+import { SharedDoc, OT_Type } from "@mescius/js-collaboration-ot-client";
+
 /**
- * The ot type of spread-sheets.
+ * Defines the Operational type
+ * @enum {number}
  */
-export declare const type: OT_Type;
-
-export interface IOpComponent {
-    type: string;
+export enum OpType {
+    /**
+     * addSheet
+     */
+    addSheet = 1,
+    /**
+     * removeSheet
+     */
+    removeSheet = 2,
+    /**
+     * clearSheets
+     */
+    clearSheets = 3,
+    /**
+     * reorderSheet
+     */
+    reorderSheet = 4,
+    /**
+     * setStartSheetIndex
+     */
+    setStartSheetIndex = 5,
+    /**
+     * setActiveSheetId
+     */
+    setActiveSheetId = 6,
+    /**
+     * setWorkbookOptions
+     */
+    setWorkbookOptions = 7,
+    /**
+     * addNamedStyle
+     */
+    addNamedStyle = 8,
+    /**
+     * removeNamedStyle
+     */
+    removeNamedStyle = 9,
+    /**
+     * addSheetNamedStyle
+     */
+    addSheetNamedStyle = 10,
+    /**
+     * removeSheetNamedStyle
+     */
+    removeSheetNamedStyle = 11,
+    /**
+     * addCustomTheme
+     */
+    addCustomTheme = 12,
+    /**
+     * removeCustomTheme
+     */
+    removeCustomTheme = 13,
+    /**
+     * updateCustomTheme
+     */
+    updateCustomTheme = 14,
+    /**
+     * addSheetTabStyle
+     */
+    addSheetTabStyle = 15,
+    /**
+     * removeSheetTabStyle
+     */
+    removeSheetTabStyle = 16,
+    /**
+     * clearSheetTabStyle
+     */
+    clearSheetTabStyle = 17,
+    /**
+     * updateDocProp
+     */
+    updateDocProp = 18,
+    /**
+     * updateDocPropForApp
+     */
+    updateDocPropForApp = 19,
+    /**
+     * updateDocPropForCore
+     */
+    updateDocPropForCore = 20,
+    /**
+     * addCustomDocProp
+     */
+    addCustomDocProp = 21,
+    /**
+     * removeCustomDocProp
+     */
+    removeCustomDocProp = 22,
+    /**
+     * clearCustomDocProp
+     */
+    clearCustomDocProp = 23,
+    /**
+     * updateCustomDocProp
+     */
+    updateCustomDocProp = 24,
+    /**
+     * setCustomDocProps
+     */
+    setCustomDocProps = 25,
+    /**
+     * setTabSelected
+     */
+    setTabSelected = 26,
+    /**
+     * setSheetName
+     */
+    setSheetName = 27,
+    /**
+     * setRange
+     */
+    setRange = 28,
+    /**
+     * setCustomName
+     */
+    setCustomName = 29,
+    /**
+     * setSheetScopeCustomName
+     */
+    setSheetScopeCustomName = 30,
+    /**
+     * clearCustomName
+     */
+    clearCustomName = 31,
+    /**
+     * clearSheetScopeCustomName
+     */
+    clearSheetScopeCustomName = 32,
+    /**
+     * addRows
+     */
+    addRows = 33,
+    /**
+     * deleteRows
+     */
+    deleteRows = 34,
+    /**
+     * addSpan
+     */
+    addSpan = 35,
+    /**
+     * removeSpan
+     */
+    removeSpan = 36,
+    /**
+     * updateSpan
+     */
+    updateSpan = 37,
+    /**
+     * addColumns
+     */
+    addColumns = 39,
+    /**
+     * deleteColumns
+     */
+    deleteColumns = 40,
+    /**
+     * setRowCount
+     */
+    setRowCount = 41,
+    /**
+     * setColumnCount
+     */
+    setColumnCount = 42,
+    /**
+     * setFrozen
+     */
+    setFrozen = 43,
+    /**
+     * setFreeAreaCount
+     */
+    setFreeAreaCount = 44,
+    /**
+     * setAxisSize
+     */
+    setAxisSize = 45,
+    /**
+     * updateZoom
+     */
+    updateZoom = 46,
+    /**
+     * setAxisOptions
+     */
+    setAxisOptions = 47,
+    /**
+     * setHeaderFitMode
+     */
+    setHeaderFitMode = 48,
+    /**
+     * setWorksheetOptions
+     */
+    setWorksheetOptions = 49,
+    /**
+     * setCurrentTheme
+     */
+    setCurrentTheme = 50,
+    /**
+     * clearRange
+     */
+    clearRange = 51,
+    /**
+     * setSheetVisible
+     */
+    setSheetVisible = 52,
+    /**
+     * setFileInfo
+     */
+    setFileInfo = 53,
+    /**
+     * updateTopLeftPosition
+     */
+    updateTopLeftPosition = 54,
+    /**
+     * setWorkbookProperty
+     */
+    setWorkbookProperty = 55,
+    /**
+     * addExternalReference
+     */
+    addExternalReference = 101,
+    /**
+     * updateExternalReference
+     */
+    updateExternalReference = 102,
+    /**
+     * sortSwap
+     */
+    sortSwap = 111,
+    /**
+     * updateSortState
+     */
+    updateSortState = 112,
+    /**
+     * setFilter
+     */
+    setFilter = 121,
+    /**
+     * filterItemMap
+     */
+    filterItemMap = 122,
+    /**
+     * filteredColumns
+     */
+    filteredColumns = 123,
+    /**
+     * updateFilterSortInfo
+     */
+    updateFilterSortInfo = 124,
+    /**
+     * updateFilterButtonVisibleInfo
+     */
+    updateFilterButtonVisibleInfo = 125,
+    /**
+     * updateFilterRange
+     */
+    updateFilterRange = 126,
+    /**
+     * filterRowVisibleInfo
+     */
+    filterRowVisibleInfo = 127,
+    /**
+     * addGroup
+     */
+    addGroup = 141,
+    /**
+     * removeGroup
+     */
+    removeGroup = 142,
+    /**
+     * resetGroup
+     */
+    resetGroup = 143,
+    /**
+     * updateCollapsed
+     */
+    updateCollapsed = 144,
+    /**
+     * setDirection
+     */
+    setDirection = 145,
+    /**
+     * showOutline
+     */
+    showOutline = 146,
+    /**
+     * insertGroupItem
+     */
+    insertGroupItem = 147,
+    /**
+     * setGroupItems
+     */
+    setGroupItems = 148,
+    /**
+     * deleteGroupItem
+     */
+    deleteGroupItem = 149,
+    /**
+     * addComment
+     */
+    addComment = 161,
+    /**
+     * removeComment
+     */
+    removeComment = 162,
+    /**
+     * updateComment
+     */
+    updateComment = 163,
+    /**
+     * addTable
+     */
+    addTable = 171,
+    /**
+     * removeTable
+     */
+    removeTable = 172,
+    /**
+     * showHeader
+     */
+    showHeader = 173,
+    /**
+     * showFooter
+     */
+    showFooter = 174,
+    /**
+     * setTableProperty
+     */
+    setTableProperty = 175,
+    /**
+     * setTableLayoutStyle
+     */
+    setTableLayoutStyle = 176,
+    /**
+     * addTableRow
+     */
+    addTableRow = 177,
+    /**
+     * removeTableRow
+     */
+    removeTableRow = 178,
+    /**
+     * updateTablePosition
+     */
+    updateTablePosition = 179,
+    /**
+     * addTableColumn
+     */
+    addTableColumn = 180,
+    /**
+     * removeTableColumn
+     */
+    removeTableColumn = 181,
+    /**
+     * setTableColumnProperty
+     */
+    setTableColumnProperty = 182,
+    /**
+     * addShape
+     */
+    addShape = 201,
+    /**
+     * removeShape
+     */
+    removeShape = 202,
+    /**
+     * reorderShape
+     */
+    reorderShape = 203,
+    /**
+     * updateShapeProp
+     */
+    updateShapeProp = 204,
+    /**
+     * updateShapeFormula
+     */
+    updateShapeFormula = 205,
+    /**
+     * updateShapeTransform
+     */
+    updateShapeTransform = 206,
+    /**
+     * addChildShape
+     */
+    addChildShape = 207,
+    /**
+     * removeChildShape
+     */
+    removeChildShape = 208,
+    /**
+     * reorderChildShape
+     */
+    reorderChildShape = 209,
+    /**
+     * updateChartSeries
+     */
+    updateChartSeries = 221,
+    /**
+     * updateChart
+     */
+    updateChart = 222,
+    /**
+     * addPivotCache
+     */
+    addPivotCache = 251,
+    /**
+     * removePivotCache
+     */
+    removePivotCache = 252,
+    /**
+     * updatePivotCache
+     */
+    updatePivotCache = 253,
+    /**
+     * switchPivotCache
+     */
+    switchPivotCache = 254,
+    /**
+     * updatePivotCacheField
+     */
+    updatePivotCacheField = 255,
+    /**
+     * addPivotTable
+     */
+    addPivotTable = 271,
+    /**
+     * removePivotTable
+     */
+    removePivotTable = 272,
+    /**
+     * updatePivotTableLayout
+     */
+    updatePivotTableLayout = 273,
+    /**
+     * updateFieldsModel
+     */
+    updateFieldsModel = 274,
+    /**
+     * addPivotField
+     */
+    addPivotField = 275,
+    /**
+     * removePivotField
+     */
+    removePivotField = 276,
+    /**
+     * addRule
+     */
+    addRule = 301,
+    /**
+     * updateRule
+     */
+    updateRule = 302,
+    /**
+     * removeRule
+     */
+    removeRule = 303,
+    /**
+     * clearRule
+     */
+    clearRule = 304,
+    /**
+     * addAutoMerge
+     */
+    addAutoMerge = 311,
+    /**
+     * removeAutoMerge
+     */
+    removeAutoMerge = 312,
+    /**
+     * setSheetAreaAutoMerge
+     */
+    setSheetAreaAutoMerge = 313,
+    /**
+     * addSparklineEx
+     */
+    addSparklineEx = 321,
+    /**
+     * removeSparklineEx
+     */
+    removeSparklineEx = 322,
+    /**
+     * updateSparklineGroup
+     */
+    updateSparklineGroup = 323,
+    /**
+     * addSparklineGroup
+     */
+    addSparklineGroup = 324,
+    /**
+     * removeSparklineGroup
+     */
+    removeSparklineGroup = 325,
+    /**
+     * groupSparkline
+     */
+    groupSparkline = 326,
+    /**
+     * setGroupSparklines
+     */
+    setGroupSparklines = 327,
+    /**
+     * addSparklineForGroup
+     */
+    addSparklineForGroup = 328,
+    /**
+     * removeSparklineForGroup
+     */
+    removeSparklineForGroup = 329,
+    /**
+     * clearSparklineForGroup
+     */
+    clearSparklineForGroup = 330,
+    /**
+     * updateSparkline
+     */
+    updateSparkline = 331,
+    /**
+     * addCellState
+     */
+    addCellState = 351,
+    /**
+     * removeCellState
+     */
+    removeCellState = 352,
+    /**
+     * updateCellState
+     */
+    updateCellState = 353,
+    /**
+     * setCellState
+     */
+    setCellState = 354,
+    /**
+     * addDataValidator
+     */
+    addDataValidator = 361,
+    /**
+     * updateDataValidator
+     */
+    updateDataValidator = 362,
+    /**
+     * removeDataValidator
+     */
+    removeDataValidator = 363,
+    /**
+     * setDataValidatorRange
+     */
+    setDataValidatorRange = 364,
+    /**
+     * setOutlineColumnOptions
+     */
+    setOutlineColumnOptions = 371,
+    /**
+     * setOutlineColumnProperty
+     */
+    setOutlineColumnProperty = 372,
+    /**
+     * setPrintInfo
+     */
+    setPrintInfo = 381,
+    /**
+     * setPrintInfoOption
+     */
+    setPrintInfoOption = 382,
 }
 
-export interface IChangeSet {
-    ops: IOpComponent[];
+/**
+ * Enumerates the browsing modes for document interaction.
+ * @enum {number}
+ */
+export enum BrowsingMode {
+    /** Allows the user to edit the document.
+     */
+    edit,
+    /** Restricts the user to viewing the document only.
+     */
+    view,
 }
 
 /**
- * Binds workbook with the document.
- * @param workbook - The instance of GC.Spread.Sheets.Workbook.
- * @param doc - The instance of SharedDoc.
+ * Enumerates permission types for viewers.
+ * @enum {number}
  */
-export declare function bind(workbook: any, doc: SharedDoc<any, IChangeSet>): void;
-
-export interface ISelections {
-    selections?: Range[];
-    sheetId?: string;
+export enum PermissionTypes {
+    /**
+     * Permits non-data-modifying operations
+     */
+    allowNonDataModifyingOperations = 1,
+    /**
+     * Permits hide or unhide rows/columns.
+     */
+    allowHideRowsOrColumns = 2,
+    /**
+     * Permits resizing rows/columns.
+     */
+    allowResizeRowsOrColumns = 4,
+    /**
+     * Permits filtering ranges.
+     */
+    allowFilter = 8,
+    /**
+     * Permits sorting.
+     */
+    allowSort = 16,
 }
 
-export enum BrowsingMode {
-    edit,
-    view
+/**
+ * Represents a set of changes for operational transformation.
+ */
+export interface IChangeSet {
+    ops: IOpComponent[];
 }
 
+/**
+ * Represents a single operation component.
+ */
+export interface IOpComponent {
+    type: OpType;
+}
 
+/**
+ * Defines user permissions for document interaction.
+ */
 export interface IPermission {
     mode: BrowsingMode;
+    viewModePermissions?: PermissionTypes;
 }
 
+/**
+ * Represents a user in the collaboration system.
+ */
 export interface IUser {
     id: string;
     name: string;
@@ -43,34 +644,53 @@ export interface IUser {
     permission?: IPermission;
 }
 
+/**
+ * Represents selection data for a worksheet.
+ */
+export interface ISelections {
+    selections?: Range[];
+    sheetId?: string;
+}
+
+/**
+ * Represents presence information for a user.
+ */
 export interface IPresence {
     user: IUser;
-    status: {
-        selections?: ISelections;
-    };
+    status: { selections?: ISelections };
 }
-
+/**
+ * Binds a workbook to a presence instance.
+ * @param {any} workbook - The instance of GC.Spread.Sheets.Workbook.
+ * @param {Presence<IPresence>} presence - The presence instance.
+ * @param {IUser} user - The user information.
+ * @param {IBindPresenceOptions} [options] - Optional binding options.
+ * @returns {Promise<void>} A promise that resolves when the binding is complete.
+ */
+export declare function bindPresence(workbook: any, presence: Presence<IPresence>, user: IUser, options?: IBindPresenceOptions): Promise<void>;
+/**
+ * Options for binding presence to a workbook.
+ */
 export interface IBindPresenceOptions {
     onPresencesUpdate?: (presences?: IPresence[]) => void;
     colorScheme?: string[];
 }
 /**
- * Binds workbook with the presence.
- * @param workbook - The instance of GC.Spread.Sheets.Workbook.
- * @param {Presence} presence - The instance of Presence.
- * @param {IUser} user - The user info.
- * @param {IBindPresenceOptions} [options] - The bind presence options.
+ * Binds a workbook to a shared document.
+ * @param {any} workbook - The instance of GC.Spread.Sheets.Workbook.
+ * @param {SharedDoc<any, IChangeSet>} doc - The instance of SharedDoc.
+ * @returns {Promise<void>} A promise that resolves when the binding is complete.
+ */
+export declare function bind(workbook: any, doc: SharedDoc<any, IChangeSet>): Promise<void>;
+/**
+ * Defines the interface for a worksheet.
  */
-export declare function bindPresence(workbook: any, presence: Presence<IPresence>, user: IUser, options?: IBindPresenceOptions): void;
-
 export interface IWorksheet {
     getId(): string;
     getSelections(): Range[];
 }
 
-export interface IPresence {
-    user: IUser;
-    status: {
-        selections?: ISelections;
-    };
-}
+/**
+ * Defines the OT type for spreadsheets.
+ **/
+export declare const type: OT_Type<unknown, IChangeSet>;