gridjs-spreadsheet 26.4.3 → 26.4.5

package/index.d.ts

@@ -35,14 +35,68 @@ declare module 'gridjs-spreadsheet' {
         italic: false;
       };
     };
+    /** Enable redaction feature */
+    enableRedactionShape?: boolean;
+    /** Predefined redaction reasons */
+    redactionReasons?: string[];
+    /** Default redaction color */
+    redactionDefaultColor?: string;
+    /**
+     * Custom callback for adding new redaction reason.
+     * If provided, replaces the default modal dialog.
+     * @param existingReasons - Current list of existing reasons
+     * @returns Promise<string> for the new reason, or null to cancel
+     */
+    onRedactionAddReason?: (existingReasons: string[]) => Promise<string | null>;
   }
 
   export type CELL_SELECTED = 'cell-selected';
   export type CELLS_SELECTED = 'cells-selected';
   export type CELL_EDITED = 'cell-edited';
+  export type OBJECT_SELECTED = 'object-selected';
+  export type SHEET_SELECTED = 'sheet-selected';
+  export type SHEET_LOADED = 'sheet-loaded';
+  export type VERTICAL_SCROLLED = 'vertical-scrolled';
+  export type HORIZONTAL_SCROLLED = 'horizontal-scrolled';
+  export type CELLS_DELETED = 'cells-deleted';
+  export type CELLS_UPDATED = 'cells-updated';
+  export type ROWS_INSERTED = 'rows-inserted';
+  export type COLUMNS_INSERTED = 'columns-inserted';
+  export type ROWS_DELETED = 'rows-deleted';
+  export type COLUMNS_DELETED = 'columns-deleted';
+  export type CHANGE = 'change';
+  export type REDACTION_BURNED = 'redaction-burned';
+  export type REDACTION_INSERTED = 'redaction-inserted';
+  export type REDACTION_DELETED = 'redaction-deleted';
+  export type REDACTION_UPDATED = 'redaction-updated';
+  export type REDACTION_REASON_INSERTED = 'redactionReason-inserted';
+  export type REDACTION_REASON_CLEARED = 'redactionReason-cleared';
+  export type REDACTION_TRANSPARENCY_TOGGLED = 'redactionTransparency-toggled';
+  export type UPDATE_SERVER_ERROR = 'updateServerError';
+  export type UPDATE_CELL_ERROR = 'updateCellError';
 
   export type CellMerge = [number, number];
 
+  export interface CellRange {
+    sri: number;
+    sci: number;
+    eri: number;
+    eci: number;
+  }
+
+  export interface RedactionData {
+    id: string;
+    originId?: string;
+    redactionReason?: string;
+    redactionLabel?: string;
+    redactionColor?: string;
+    bgColor?: string;
+    targetType?: string;
+    targetId?: string;
+    isRedaction?: boolean;
+    fabobj?: any;
+  }
+
   export interface SpreadsheetEventHandler {
     (
       envt: CELL_SELECTED,
@@ -52,13 +106,97 @@ declare module 'gridjs-spreadsheet' {
       envt: CELLS_SELECTED,
       callback: (
         cell: Cell,
-        parameters: { sri: number; sci: number; eri: number; eci: number }
+        range: CellRange
       ) => void
     ): void;
     (
-      evnt: CELL_EDITED,
+      envt: OBJECT_SELECTED,
+      callback: (obj: { id: string; type: string; left: number; top: number; width: number; height: number }) => void
+    ): void;
+    (
+      envt: SHEET_SELECTED,
+      callback: (index: number, name: string) => void
+    ): void;
+    (
+      envt: CELL_EDITED,
       callback: (text: string, rowIndex: number, colIndex: number) => void
     ): void;
+    (
+      envt: SHEET_LOADED,
+      callback: (index: number, name: string) => void
+    ): void;
+    (
+      envt: VERTICAL_SCROLLED,
+      callback: (rowIndex: number) => void
+    ): void;
+    (
+      envt: HORIZONTAL_SCROLLED,
+      callback: (colIndex: number) => void
+    ): void;
+    (
+      envt: CELLS_DELETED,
+      callback: (range: CellRange) => void
+    ): void;
+    (
+      envt: CELLS_UPDATED,
+      callback: (sheetName: string, cells: any) => void
+    ): void;
+    (
+      envt: ROWS_INSERTED,
+      callback: (rowIndex: number, count: number) => void
+    ): void;
+    (
+      envt: COLUMNS_INSERTED,
+      callback: (colIndex: number, count: number) => void
+    ): void;
+    (
+      envt: ROWS_DELETED,
+      callback: (rowIndex: number, count: number) => void
+    ): void;
+    (
+      envt: COLUMNS_DELETED,
+      callback: (colIndex: number, count: number) => void
+    ): void;
+    (
+      envt: CHANGE,
+      callback: (...args: any[]) => void
+    ): void;
+    (
+      envt: REDACTION_BURNED,
+      callback: () => void
+    ): void;
+    (
+      envt: REDACTION_INSERTED,
+      callback: (sheetName: string, redactionData: RedactionData) => void
+    ): void;
+    (
+      envt: REDACTION_DELETED,
+      callback: (sheetName: string, redactionData: RedactionData) => void
+    ): void;
+    (
+      envt: REDACTION_UPDATED,
+      callback: (sheetName: string, shape: any) => void
+    ): void;
+    (
+      envt: REDACTION_REASON_INSERTED,
+      callback: (reason: string) => void
+    ): void;
+    (
+      envt: REDACTION_REASON_CLEARED,
+      callback: () => void
+    ): void;
+    (
+      envt: REDACTION_TRANSPARENCY_TOGGLED,
+      callback: (isTransparent: boolean) => void
+    ): void;
+    (
+      envt: UPDATE_SERVER_ERROR,
+      callback: (...args: any[]) => void
+    ): void;
+    (
+      envt: UPDATE_CELL_ERROR,
+      callback: (...args: any[]) => void
+    ): void;
   }
 
   export interface ColProperties {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gridjs-spreadsheet",
-  "version": "26.4.3",
+  "version": "26.4.5",
   "description": "this is the client side script for GridJs which is a lightweight, scalable, and customizable toolkit that provides cross-platform web applications, enables convenient development for editing or viewing Excel/Spreadsheet files, offers simple deployment, and provides easy-to-use APIs based on JSON format.",
   "types": "index.d.ts",
   "main": "xspreadsheet.js",