@mescius/spread-sheets-collaboration-client 18.2.4 → 19.0.0

package/README.md

@@ -8,7 +8,7 @@ For a detailed listing of SpreadJS sub-libraries and plug-ins, please see [Using
 
 ## Installation
 ```sh
-npm install @mescius/spread-sheets-collaboration
+npm install @mescius/spread-sheets-collaboration-client
 ```
 
 ## Getting more help

package/dist/index.d.ts

@@ -246,6 +246,10 @@ export enum OpType {
      * clearFormatStringName
      */
     clearFormatStringName = 63,
+    /**
+     * setSelectionPolicyAndUnit
+     */
+    setSelectionPolicyAndUnit = 64,
     /**
      * addExternalReference
      */
@@ -398,6 +402,10 @@ export enum OpType {
      * updateChart
      */
     updateChart = 222,
+    /**
+     * preserveUnsupportedChart
+     */
+    preserveUnsupportedChart = 223,
     /**
      * addPivotCache
      */
@@ -442,6 +450,10 @@ export enum OpType {
      * removePivotField
      */
     removePivotField = 276,
+    /**
+     * updatePivotTableOptions
+     */
+    updatePivotTableOptions = 277,
     /**
      * addRule
      */
@@ -562,6 +574,58 @@ export enum OpType {
      * setPrintInfoOption
      */
     setPrintInfoOption = 382,
+    /**
+     * addTableItemSlicerCache
+     */
+    addTableItemSlicerCache = 391,
+    /**
+     * updateTableItemSlicerCache
+     */
+    updateTableItemSlicerCacheProperty = 392,
+    /**
+     * removeTableItemSlicerCache
+     */
+    removeTableItemSlicerCache = 393,
+    /**
+     * addPivotSlicerCache
+     */
+    addPivotSlicerCache = 394,
+    /**
+     * updatePivotSlicerCache
+     */
+    updatePivotSlicerCacheProperty = 395,
+    /**
+     * removePivotSlicerCache
+     */
+    removePivotSlicerCache = 396,
+    /**
+     * updateSlicerProperty
+     */
+    updateSlicerProperty = 397,
+    /**
+     * addThreadedComment
+     */
+    addThreadedComment = 410,
+    /**
+     * updateThreadedComment
+     */
+    updateThreadedComment = 411,
+    /**
+     * removeThreadedComment
+     */
+    removeThreadedComment = 412,
+    /**
+     * addThreadedCommentReply
+     */
+    addThreadedCommentReply = 413,
+    /**
+     * updateThreadedCommentReply
+     */
+    updateThreadedCommentReply = 414,
+    /**
+     * removeThreadedCommentReply
+     */
+    removeThreadedCommentReply = 415,
 }
 
 /**
@@ -627,23 +691,61 @@ export interface IPermission {
 }
 
 /**
- * Represents a user in the collaboration system.
+ * @typedef IImageSource
+ * @type {{kind: 'url';src: string;} | {kind: 'data';dataUrl: string;} | {kind: 'blobUrl';blobUrl: string;} | {kind: 'blob';blob: Blob;} | {kind: 'file';file: File;}
+ */
+/**
+{
+    kind: 'url';
+    src: string;
+} | {
+    kind: 'data';
+    dataUrl: string;
+} | {
+    kind: 'blobUrl';
+    blobUrl: string;
+} | {
+    kind: 'blob';
+    blob: Blob;
+} | {
+    kind: 'file';
+    file: File;
+}
+*/
+export type IImageSource =
+    | { kind: 'url'; src: string }
+    | { kind: 'data'; dataUrl: string }
+    | { kind: 'blobUrl'; blobUrl: string }
+    | { kind: 'blob'; blob: Blob }
+    | { kind: 'file'; file: File };
+
+/**
+ * Represents a user in the collaboration system. It comes from GC.Spread.Common.IUser
  */
 export interface IUser {
     id: string;
     name: string;
+    avatar?: IImageSource;
     color?: string;
+    email?: string;
+}
+
+/**
+ * Represents a user with associated permission settings.
+ * Extends IUser with document permission information.
+ */
+export interface IUserWithPermission extends IUser {
     permission?: IPermission;
 }
 /**
  * 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 {IUserWithPermission} 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>;
+export declare function bindPresence(workbook: any, presence: Presence<IPresence>, user: IUserWithPermission, options?: IBindPresenceOptions): Promise<void>;
 /**
  * Options for binding presence to a workbook.
  */