@mog-sdk/spreadsheet-contracts 0.1.12

package/dist/api/worksheet/pivots.d.ts

@@ -0,0 +1,257 @@
+/**
+ * WorksheetPivots — Sub-API for pivot table operations on a worksheet.
+ *
+ * Provides methods to create, query, modify, and remove pivot tables within a
+ * worksheet. Pivot tables are rendered on a target sheet and connected
+ * to a source data range.
+ *
+ * Operations on this sub-API operate on the worksheet's sheet (no sheetId parameter needed).
+ */
+import type { CellRange, CellValue } from '../../core';
+import type { AggregateFunction, CalculatedField, PivotExpansionState, PivotFieldArea, PivotFilter, PivotTableConfig, PivotTableLayout, PivotTableStyle, SortOrder } from '../../data/pivot';
+import type { PivotQueryResult, PivotTableHandle, PivotTableInfo } from '../types';
+/** Sub-API for pivot table operations on a worksheet. */
+export interface WorksheetPivots {
+    /**
+     * Create a new pivot table on this worksheet.
+     *
+     * @param config - Pivot table configuration (source, fields, placements).
+     *   The `id`, `createdAt`, and `updatedAt` fields are auto-generated and should be omitted.
+     * @returns The created pivot table configuration (with generated id, timestamps)
+     */
+    add(config: Omit<PivotTableConfig, 'id' | 'createdAt' | 'updatedAt'>): Promise<PivotTableConfig>;
+    /**
+     * Atomically create a new sheet AND a pivot table on it.
+     * Both operations happen in a single transaction for undo atomicity.
+     *
+     * @param sheetName - Name for the new sheet
+     * @param config - Pivot table configuration (id, createdAt, updatedAt auto-generated)
+     * @returns The new sheet ID and the created pivot config
+     */
+    addWithSheet(sheetName: string, config: Omit<PivotTableConfig, 'id' | 'createdAt' | 'updatedAt'>): Promise<{
+        sheetId: string;
+        config: PivotTableConfig;
+    }>;
+    /**
+     * Remove a pivot table by name.
+     *
+     * @param name - Pivot table name
+     */
+    remove(name: string): Promise<void>;
+    /**
+     * List all pivot tables on this worksheet.
+     *
+     * @returns Array of pivot table summary information
+     */
+    list(): Promise<PivotTableInfo[]>;
+    /**
+     * Get a pivot table handle by name.
+     *
+     * @param name - Pivot table name
+     * @returns A handle for the pivot table, or null if not found
+     */
+    get(name: string): Promise<PivotTableHandle | null>;
+    /**
+     * Add a field to a pivot table area.
+     *
+     * @param pivotId - Pivot table ID
+     * @param fieldId - Field ID to add
+     * @param area - Target area (row, column, value, or filter)
+     * @param options - Optional configuration (position, aggregateFunction, sortOrder, displayName)
+     */
+    addField(pivotId: string, fieldId: string, area: PivotFieldArea, options?: {
+        position?: number;
+        aggregateFunction?: AggregateFunction;
+        sortOrder?: SortOrder;
+        displayName?: string;
+    }): Promise<void>;
+    /**
+     * Remove a field from a pivot table area.
+     *
+     * @param pivotId - Pivot table ID
+     * @param fieldId - Field ID to remove
+     * @param area - Area to remove the field from
+     */
+    removeField(pivotId: string, fieldId: string, area: PivotFieldArea): Promise<void>;
+    /**
+     * Move a field to a different area or position.
+     *
+     * @param pivotId - Pivot table ID
+     * @param fieldId - Field ID to move
+     * @param fromArea - Source area
+     * @param toArea - Target area
+     * @param toPosition - Target position within the area
+     */
+    moveField(pivotId: string, fieldId: string, fromArea: PivotFieldArea, toArea: PivotFieldArea, toPosition: number): Promise<void>;
+    /**
+     * Set the aggregate function for a value field.
+     *
+     * @param pivotId - Pivot table ID
+     * @param fieldId - Field ID (must be in the 'value' area)
+     * @param aggregateFunction - New aggregation function
+     */
+    setAggregateFunction(pivotId: string, fieldId: string, aggregateFunction: AggregateFunction): Promise<void>;
+    /**
+     * Set the sort order for a row or column field.
+     *
+     * @param pivotId - Pivot table ID
+     * @param fieldId - Field ID (must be in 'row' or 'column' area)
+     * @param sortOrder - Sort order ('asc', 'desc', or 'none')
+     */
+    setSortOrder(pivotId: string, fieldId: string, sortOrder: SortOrder): Promise<void>;
+    /**
+     * Set (add or update) a filter on a field.
+     *
+     * @param pivotId - Pivot table ID
+     * @param fieldId - Field ID to filter
+     * @param filter - Filter configuration (without fieldId)
+     */
+    setFilter(pivotId: string, fieldId: string, filter: Omit<PivotFilter, 'fieldId'>): Promise<void>;
+    /**
+     * Remove a filter from a field.
+     *
+     * @param pivotId - Pivot table ID
+     * @param fieldId - Field ID whose filter should be removed
+     */
+    removeFilter(pivotId: string, fieldId: string): Promise<void>;
+    /**
+     * Set layout options for a pivot table.
+     *
+     * @param pivotId - Pivot table ID
+     * @param layout - Partial layout configuration to merge with existing
+     */
+    setLayout(pivotId: string, layout: Partial<PivotTableLayout>): Promise<void>;
+    /**
+     * Set style options for a pivot table.
+     *
+     * @param pivotId - Pivot table ID
+     * @param style - Partial style configuration to merge with existing
+     */
+    setStyle(pivotId: string, style: Partial<PivotTableStyle>): Promise<void>;
+    /**
+     * Detect fields from source data for pivot table creation.
+     *
+     * @param sourceSheetId - Sheet ID containing the source data
+     * @param range - Source data range
+     * @returns Array of detected pivot fields
+     */
+    detectFields(sourceSheetId: string, range: {
+        startRow: number;
+        startCol: number;
+        endRow: number;
+        endCol: number;
+    }): Promise<any[]>;
+    /**
+     * Compute a pivot table result (uses cache if available).
+     *
+     * @param pivotId - Pivot table ID
+     * @param forceRefresh - Force recomputation ignoring cache
+     * @returns Computed pivot table result
+     */
+    compute(pivotId: string, forceRefresh?: boolean): Promise<any>;
+    /**
+     * Query a pivot table by name, returning flat records optionally filtered by dimension values.
+     * Eliminates the need to manually traverse hierarchical PivotTableResult trees.
+     *
+     * @param pivotName - Pivot table name
+     * @param filters - Optional dimension filters: field name → value or array of values to include
+     * @returns Flat query result, or null if pivot not found or not computable
+     */
+    queryPivot(pivotName: string, filters?: Record<string, CellValue | CellValue[]>): Promise<PivotQueryResult | null>;
+    /**
+     * Refresh a pivot table (recompute without cache).
+     *
+     * @param pivotId - Pivot table ID
+     */
+    refresh(pivotId: string): Promise<void>;
+    /**
+     * Get drill-down data for a pivot table cell.
+     *
+     * @param pivotId - Pivot table ID
+     * @param rowKey - Row key from the pivot result
+     * @param columnKey - Column key from the pivot result
+     * @returns Source data rows that contribute to this cell
+     */
+    getDrillDownData(pivotId: string, rowKey: string, columnKey: string): Promise<any[][]>;
+    /**
+     * Add a calculated field to a pivot table.
+     *
+     * @param pivotId - Pivot table ID
+     * @param field - Calculated field definition (fieldId, name, formula)
+     */
+    addCalculatedField(pivotId: string, field: CalculatedField): Promise<void>;
+    /**
+     * Remove a calculated field from a pivot table.
+     *
+     * @param pivotId - Pivot table ID
+     * @param fieldId - Calculated field ID to remove
+     */
+    removeCalculatedField(pivotId: string, fieldId: string): Promise<void>;
+    /**
+     * Update a calculated field on a pivot table.
+     *
+     * @param pivotId - Pivot table ID
+     * @param fieldId - Calculated field ID to update
+     * @param updates - Partial updates (name and/or formula)
+     */
+    updateCalculatedField(pivotId: string, fieldId: string, updates: Partial<Pick<CalculatedField, 'name' | 'formula'>>): Promise<void>;
+    /**
+     * Get the full range occupied by the rendered pivot table.
+     *
+     * @param pivotId - Pivot table ID
+     * @returns CellRange covering the entire pivot table, or null if not computed
+     */
+    getRange(pivotId: string): Promise<CellRange | null>;
+    /**
+     * Get the range of the data body (values only, excluding headers and totals row labels).
+     *
+     * @param pivotId - Pivot table ID
+     * @returns CellRange covering the data body, or null if not computed
+     */
+    getDataBodyRange(pivotId: string): Promise<CellRange | null>;
+    /**
+     * Get the range of column label headers.
+     *
+     * @param pivotId - Pivot table ID
+     * @returns CellRange covering the column headers, or null if not computed
+     */
+    getColumnLabelRange(pivotId: string): Promise<CellRange | null>;
+    /**
+     * Get the range of row label headers.
+     *
+     * @param pivotId - Pivot table ID
+     * @returns CellRange covering the row headers, or null if not computed
+     */
+    getRowLabelRange(pivotId: string): Promise<CellRange | null>;
+    /**
+     * Get the range of the filter area (page fields above the pivot table).
+     *
+     * @param pivotId - Pivot table ID
+     * @returns CellRange covering filter dropdowns, or null if no filter fields
+     */
+    getFilterAxisRange(pivotId: string): Promise<CellRange | null>;
+    /**
+     * Toggle expansion state for a header.
+     *
+     * @param pivotId - Pivot table ID
+     * @param headerKey - Header key to toggle
+     * @param isRow - Whether this is a row header (true) or column header (false)
+     * @returns The new expansion state (true = expanded, false = collapsed)
+     */
+    toggleExpanded(pivotId: string, headerKey: string, isRow: boolean): Promise<boolean>;
+    /**
+     * Set expansion state for all headers.
+     *
+     * @param pivotId - Pivot table ID
+     * @param expanded - Whether all headers should be expanded (true) or collapsed (false)
+     */
+    setAllExpanded(pivotId: string, expanded: boolean): Promise<void>;
+    /**
+     * Get the current expansion state for a pivot table.
+     *
+     * @param pivotId - Pivot table ID
+     * @returns Expansion state with expandedRows and expandedColumns maps
+     */
+    getExpansionState(pivotId: string): Promise<PivotExpansionState>;
+}
+//# sourceMappingURL=pivots.d.ts.map

package/dist/api/worksheet/pivots.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pivots.d.ts","sourceRoot":"","sources":["../../../src/api/worksheet/pivots.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvD,OAAO,KAAK,EACV,iBAAiB,EACjB,eAAe,EACf,mBAAmB,EACnB,cAAc,EACd,WAAW,EACX,gBAAgB,EAChB,gBAAgB,EAChB,eAAe,EACf,SAAS,EACV,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAEnF,yDAAyD;AACzD,MAAM,WAAW,eAAe;IAK9B;;;;;;OAMG;IACH,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,gBAAgB,EAAE,IAAI,GAAG,WAAW,GAAG,WAAW,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAEjG;;;;;;;OAOG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,IAAI,CAAC,gBAAgB,EAAE,IAAI,GAAG,WAAW,GAAG,WAAW,CAAC,GAC/D,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,gBAAgB,CAAA;KAAE,CAAC,CAAC;IAE1D;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpC;;;;OAIG;IACH,IAAI,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IAElC;;;;;OAKG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAAC;IAMpD;;;;;;;OAOG;IACH,QAAQ,CACN,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,cAAc,EACpB,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;QACtC,SAAS,CAAC,EAAE,SAAS,CAAC;QACtB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,GACA,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;;;OAMG;IACH,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnF;;;;;;;;OAQG;IACH,SAAS,CACP,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,cAAc,EACxB,MAAM,EAAE,cAAc,EACtB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,IAAI,CAAC,CAAC;IAMjB;;;;;;OAMG;IACH,oBAAoB,CAClB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,iBAAiB,EAAE,iBAAiB,GACnC,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;;;OAMG;IACH,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpF;;;;;;OAMG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,WAAW,EAAE,SAAS,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjG;;;;;OAKG;IACH,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAM9D;;;;;OAKG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7E;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAM1E;;;;;;OAMG;IACH,YAAY,CACV,aAAa,EAAE,MAAM,EACrB,KAAK,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAC5E,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IAElB;;;;;;OAMG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAE/D;;;;;;;OAOG;IACH,UAAU,CACR,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,GAAG,SAAS,EAAE,CAAC,GAChD,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAAC;IAEpC;;;;OAIG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExC;;;;;;;OAOG;IACH,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IAMvF;;;;;OAKG;IACH,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3E;;;;;OAKG;IACH,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvE;;;;;;OAMG;IACH,qBAAqB,CACnB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,GAC1D,OAAO,CAAC,IAAI,CAAC,CAAC;IAMjB;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC;IAErD;;;;;OAKG;IACH,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC;IAE7D;;;;;OAKG;IACH,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC;IAEhE;;;;;OAKG;IACH,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC;IAE7D;;;;;OAKG;IACH,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC;IAM/D;;;;;;;OAOG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAErF;;;;;OAKG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElE;;;;;OAKG;IACH,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;CAClE"}

package/dist/api/worksheet/print.d.ts

@@ -0,0 +1,108 @@
+/**
+ * WorksheetPrint — Sub-API Interface for Print Settings and Page Breaks
+ *
+ * Methods for managing print settings, print area, and manual page breaks.
+ */
+import type { PrintSettings } from '../types';
+/** Sub-API for worksheet print and page break operations. */
+export interface WorksheetPrint {
+    /**
+     * Get the current print settings for the sheet.
+     *
+     * @returns Current print settings
+     */
+    getSettings(): Promise<PrintSettings>;
+    /**
+     * Update print settings. Only the provided keys are changed.
+     *
+     * @param settings - Partial print settings to apply
+     */
+    setSettings(settings: Partial<PrintSettings>): Promise<void>;
+    /**
+     * Get the current print area as an A1-notation range string.
+     *
+     * @returns The print area range string, or null if no print area is set
+     */
+    getArea(): Promise<string | null>;
+    /**
+     * Set the print area to the specified A1-notation range.
+     *
+     * @param area - A1-notation range string (e.g., "A1:H20")
+     */
+    setArea(area: string): Promise<void>;
+    /**
+     * Clear the print area so the entire sheet prints.
+     */
+    clearArea(): Promise<void>;
+    /**
+     * Add a manual page break at the specified position.
+     *
+     * @param type - 'horizontal' (row break) or 'vertical' (column break)
+     * @param position - 0-based row or column index for the break
+     */
+    addPageBreak(type: 'horizontal' | 'vertical', position: number): Promise<void>;
+    /**
+     * Remove a manual page break at the specified position.
+     *
+     * @param type - 'horizontal' or 'vertical'
+     * @param position - 0-based row or column index of the break to remove
+     */
+    removePageBreak(type: 'horizontal' | 'vertical', position: number): Promise<void>;
+    /**
+     * Get all manual page breaks in the sheet.
+     *
+     * @returns Object containing arrays of horizontal and vertical break positions
+     */
+    getPageBreaks(): Promise<{
+        rowBreaks: Array<{
+            id: number;
+            min: number;
+            max: number;
+            manual: boolean;
+            pt: boolean;
+        }>;
+        colBreaks: Array<{
+            id: number;
+            min: number;
+            max: number;
+            manual: boolean;
+            pt: boolean;
+        }>;
+    }>;
+    /**
+     * Remove all manual page breaks from the sheet.
+     */
+    clearPageBreaks(): Promise<void>;
+    /**
+     * Set the rows to repeat at the top of each printed page (print titles).
+     *
+     * @param startRow - 0-based start row index
+     * @param endRow - 0-based end row index (inclusive)
+     */
+    setPrintTitleRows(startRow: number, endRow: number): Promise<void>;
+    /**
+     * Set the columns to repeat at the left of each printed page (print titles).
+     *
+     * @param startCol - 0-based start column index
+     * @param endCol - 0-based end column index (inclusive)
+     */
+    setPrintTitleColumns(startCol: number, endCol: number): Promise<void>;
+    /**
+     * Get the rows configured to repeat at the top of each printed page.
+     *
+     * @returns A [startRow, endRow] tuple (0-based, inclusive), or null if no repeat rows are set
+     */
+    getPrintTitleRows(): Promise<[number, number] | null>;
+    /**
+     * Get the columns configured to repeat at the left of each printed page.
+     *
+     * @returns A [startCol, endCol] tuple (0-based, inclusive), or null if no repeat columns are set
+     */
+    getPrintTitleColumns(): Promise<[number, number] | null>;
+    /**
+     * Clear all print titles (both repeat rows and repeat columns).
+     * Other print settings (margins, orientation, etc.) are preserved.
+     */
+    clearPrintTitles(): Promise<void>;
+}
+//# sourceMappingURL=print.d.ts.map

package/dist/api/worksheet/print.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"print.d.ts","sourceRoot":"","sources":["../../../src/api/worksheet/print.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAE9C,6DAA6D;AAC7D,MAAM,WAAW,cAAc;IAC7B;;;;OAIG;IACH,WAAW,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC;IAEtC;;;;OAIG;IACH,WAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7D;;;;OAIG;IACH,OAAO,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAElC;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAErC;;OAEG;IACH,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3B;;;;;OAKG;IACH,YAAY,CAAC,IAAI,EAAE,YAAY,GAAG,UAAU,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/E;;;;;OAKG;IACH,eAAe,CAAC,IAAI,EAAE,YAAY,GAAG,UAAU,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElF;;;;OAIG;IACH,aAAa,IAAI,OAAO,CAAC;QACvB,SAAS,EAAE,KAAK,CAAC;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,GAAG,EAAE,MAAM,CAAC;YAAC,GAAG,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,OAAO,CAAC;YAAC,EAAE,EAAE,OAAO,CAAA;SAAE,CAAC,CAAC;QACzF,SAAS,EAAE,KAAK,CAAC;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,GAAG,EAAE,MAAM,CAAC;YAAC,GAAG,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,OAAO,CAAC;YAAC,EAAE,EAAE,OAAO,CAAA;SAAE,CAAC,CAAC;KAC1F,CAAC,CAAC;IAEH;;OAEG;IACH,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjC;;;;;OAKG;IACH,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnE;;;;;OAKG;IACH,oBAAoB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtE;;;;OAIG;IACH,iBAAiB,IAAI,OAAO,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IAEtD;;;;OAIG;IACH,oBAAoB,IAAI,OAAO,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IAEzD;;;OAGG;IACH,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACnC"}

package/dist/api/worksheet/protection.d.ts

@@ -0,0 +1,73 @@
+/**
+ * WorksheetProtection — Sub-API Interface for Sheet Protection
+ *
+ * Methods for protecting/unprotecting sheets, querying protection state,
+ * and checking whether specific operations are allowed under protection.
+ */
+import type { ProtectionConfig, ProtectionOptions } from '../types';
+/** Sub-API for worksheet protection operations. */
+export interface WorksheetProtection {
+    /**
+     * Check whether the sheet is currently protected.
+     *
+     * @returns True if the sheet is protected
+     */
+    isProtected(): Promise<boolean>;
+    /**
+     * Protect the sheet with an optional password and granular permission options.
+     *
+     * @param password - Optional password to require for unprotection
+     * @param options - Granular permissions (e.g., allowSort, allowFormatCells)
+     */
+    protect(password?: string, options?: ProtectionOptions): Promise<void>;
+    /**
+     * Unprotect the sheet. Returns true if unprotection succeeded.
+     *
+     * @param password - Password if the sheet was protected with one
+     * @returns True if the sheet was successfully unprotected
+     */
+    unprotect(password?: string): Promise<boolean>;
+    /**
+     * Check whether a specific cell can be edited under current protection.
+     * Returns true if the sheet is unprotected or the cell is unlocked.
+     *
+     * @param row - Row index (0-based)
+     * @param col - Column index (0-based)
+     * @returns True if the cell is editable
+     */
+    canEditCell(row: number, col: number): Promise<boolean>;
+    /**
+     * Check whether a structural operation is allowed under current protection.
+     *
+     * @param operation - Operation name (e.g., 'sort', 'insertRows', 'deleteColumns')
+     * @returns True if the operation is allowed
+     */
+    canDoStructureOp(operation: string): Promise<boolean>;
+    /**
+     * Check whether sorting is allowed under current protection.
+     * Convenience shorthand for `canDoStructureOp('sort')`.
+     *
+     * @returns True if sorting is allowed
+     */
+    canSort(): Promise<boolean>;
+    /**
+     * Get the full protection configuration for the sheet.
+     *
+     * @returns Protection configuration including status and permission flags
+     */
+    getConfig(): Promise<ProtectionConfig>;
+    /**
+     * Get the current selection mode when the sheet is protected.
+     *
+     * @returns 'normal' (all cells selectable), 'unlockedOnly' (only unlocked cells), or 'none' (no selection)
+     */
+    getSelectionMode(): Promise<'normal' | 'unlockedOnly' | 'none'>;
+    /**
+     * Set the selection mode for when the sheet is protected.
+     * Only takes effect when the sheet is actually protected.
+     *
+     * @param mode - Selection mode
+     */
+    setSelectionMode(mode: 'normal' | 'unlockedOnly' | 'none'): Promise<void>;
+}
+//# sourceMappingURL=protection.d.ts.map

package/dist/api/worksheet/protection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"protection.d.ts","sourceRoot":"","sources":["../../../src/api/worksheet/protection.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,KAAK,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAEpE,mDAAmD;AACnD,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAEhC;;;;;OAKG;IACH,OAAO,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvE;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAE/C;;;;;;;OAOG;IACH,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAExD;;;;;OAKG;IACH,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEtD;;;;;OAKG;IACH,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAE5B;;;;OAIG;IACH,SAAS,IAAI,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAEvC;;;;OAIG;IACH,gBAAgB,IAAI,OAAO,CAAC,QAAQ,GAAG,cAAc,GAAG,MAAM,CAAC,CAAC;IAEhE;;;;;OAKG;IACH,gBAAgB,CAAC,IAAI,EAAE,QAAQ,GAAG,cAAc,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3E"}

package/dist/api/worksheet/settings.d.ts

@@ -0,0 +1,54 @@
+/**
+ * WorksheetSettings — Sub-API Interface for Sheet Settings
+ *
+ * Methods for reading and writing sheet-level settings (default dimensions,
+ * gridline color, RTL layout, etc.) and workbook-level custom lists.
+ */
+import type { SheetSettingsInfo } from '../types';
+/** Sub-API for worksheet settings operations. */
+export interface WorksheetSettings {
+    /**
+     * Get all sheet settings.
+     *
+     * @returns Current sheet settings
+     */
+    get(): Promise<SheetSettingsInfo>;
+    /**
+     * Set an individual sheet setting by key.
+     *
+     * @param key - Setting key (e.g., 'showGridlines', 'defaultRowHeight')
+     * @param value - New value for the setting
+     */
+    set<K extends keyof SheetSettingsInfo>(key: K, value: SheetSettingsInfo[K]): Promise<void>;
+    /**
+     * Get the workbook-level custom sort lists.
+     *
+     * @returns Array of custom lists, each being an array of string values
+     */
+    getCustomLists(): Promise<string[][]>;
+    /**
+     * Replace all user-defined custom sort lists.
+     *
+     * @param lists - Array of custom lists to set
+     */
+    setCustomLists(lists: string[][]): Promise<void>;
+    /**
+     * Get the standard (default) row height in pixels.
+     * This is the height used for rows that haven't been explicitly sized.
+     * Read-only (matches OfficeJS semantics).
+     */
+    getStandardHeight(): Promise<number>;
+    /**
+     * Get the standard (default) column width in pixels.
+     * This is the width used for columns that haven't been explicitly sized.
+     */
+    getStandardWidth(): Promise<number>;
+    /**
+     * Set the standard (default) column width in pixels.
+     * This changes the default width for all columns that haven't been explicitly sized.
+     *
+     * @param width - New default column width in pixels
+     */
+    setStandardWidth(width: number): Promise<void>;
+}
+//# sourceMappingURL=settings.d.ts.map

package/dist/api/worksheet/settings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings.d.ts","sourceRoot":"","sources":["../../../src/api/worksheet/settings.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAElD,iDAAiD;AACjD,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,GAAG,IAAI,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAElC;;;;;OAKG;IACH,GAAG,CAAC,CAAC,SAAS,MAAM,iBAAiB,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3F;;;;OAIG;IACH,cAAc,IAAI,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAEtC;;;;OAIG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjD;;;;OAIG;IACH,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAErC;;;OAGG;IACH,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAEpC;;;;;OAKG;IACH,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAChD"}

package/dist/api/worksheet/slicers.d.ts

@@ -0,0 +1,101 @@
+/**
+ * WorksheetSlicers — Sub-API for slicer operations on a worksheet.
+ *
+ * Provides methods to create, query, modify, and remove slicers (visual
+ * filter controls) within a worksheet. Slicers are connected to tables
+ * or pivot tables and filter data by column values.
+ */
+import type { CellValue } from '../../core/core';
+import type { Slicer, SlicerConfig, SlicerInfo, SlicerItem, SlicerState } from '../types';
+/** Sub-API for slicer operations on a worksheet. */
+export interface WorksheetSlicers {
+    /**
+     * Create a new slicer on this worksheet.
+     *
+     * @param config - Slicer configuration (table, column, position)
+     * @returns The ID of the created slicer
+     */
+    add(config: SlicerConfig): Promise<string>;
+    /**
+     * Remove a slicer from this worksheet.
+     *
+     * @param slicerId - ID of the slicer to remove
+     */
+    remove(slicerId: string): Promise<void>;
+    /**
+     * List all slicers on this worksheet.
+     *
+     * @returns Array of slicer summary information
+     */
+    list(): Promise<SlicerInfo[]>;
+    /**
+     * Get a slicer by ID, including full state.
+     *
+     * @param slicerId - ID of the slicer
+     * @returns Full slicer state, or null if not found
+     */
+    get(slicerId: string): Promise<Slicer | null>;
+    /**
+     * Get the items (values) available in a slicer.
+     *
+     * @param slicerId - ID of the slicer
+     * @returns Array of slicer items with selection state
+     */
+    getItems(slicerId: string): Promise<SlicerItem[]>;
+    /**
+     * Get a slicer item by its string key.
+     *
+     * @param slicerId - ID of the slicer
+     * @param key - The value to look up (matched via string coercion)
+     * @returns The matching slicer item
+     * @throws KernelError if no item matches the key
+     */
+    getItem(slicerId: string, key: CellValue): Promise<SlicerItem>;
+    /**
+     * Get a slicer item by its string key, or null if not found.
+     *
+     * @param slicerId - ID of the slicer
+     * @param key - The value to look up (matched via string coercion)
+     * @returns The matching slicer item, or null if not found
+     */
+    getItemOrNullObject(slicerId: string, key: CellValue): Promise<SlicerItem | null>;
+    /**
+     * Set the selected items in a slicer, replacing any existing selection.
+     *
+     * @param slicerId - ID of the slicer
+     * @param selectedItems - Array of values to select
+     */
+    setSelection(slicerId: string, selectedItems: CellValue[]): Promise<void>;
+    /**
+     * Clear all selections in a slicer (show all items).
+     *
+     * @param slicerId - ID of the slicer
+     */
+    clearSelection(slicerId: string): Promise<void>;
+    /**
+     * Duplicate a slicer with an optional position offset.
+     *
+     * @param slicerId - ID of the slicer to duplicate
+     * @param offset - Position offset in pixels (defaults to { x: 20, y: 20 })
+     * @returns The ID of the newly created slicer
+     */
+    duplicate(slicerId: string, offset?: {
+        x?: number;
+        y?: number;
+    }): Promise<string>;
+    /**
+     * Update a slicer's configuration.
+     *
+     * @param slicerId - ID of the slicer
+     * @param updates - Partial configuration updates
+     */
+    updateConfig(slicerId: string, updates: Partial<SlicerConfig>): Promise<void>;
+    /**
+     * Get the enriched runtime state of a slicer.
+     *
+     * @param slicerId - ID of the slicer
+     * @returns Enriched slicer state including computed items and connection status
+     */
+    getState(slicerId: string): Promise<SlicerState>;
+}
+//# sourceMappingURL=slicers.d.ts.map

package/dist/api/worksheet/slicers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"slicers.d.ts","sourceRoot":"","sources":["../../../src/api/worksheet/slicers.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAE1F,oDAAoD;AACpD,MAAM,WAAW,gBAAgB;IAC/B;;;;;OAKG;IACH,GAAG,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE3C;;;;OAIG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExC;;;;OAIG;IACH,IAAI,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;IAE9B;;;;;OAKG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAE9C;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;IAElD;;;;;;;OAOG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAE/D;;;;;;OAMG;IACH,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;IAElF;;;;;OAKG;IACH,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1E;;;;OAIG;IACH,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhD;;;;;;OAMG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAElF;;;;;OAKG;IACH,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9E;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;CAClD"}

package/dist/api/worksheet/smartart.d.ts

@@ -0,0 +1,49 @@
+/**
+ * WorksheetSmartArt — Sub-API Interface for SmartArt Diagram Operations
+ *
+ * CRUD operations plus node manipulation, layout/style changes,
+ * and computed layout cache management.
+ */
+import type { SmartArtConfig } from '../types';
+import type { ComputedLayout, NodeId, SmartArtDiagram, SmartArtNode } from '../../smartart/types';
+export type NodePosition = 'before' | 'after' | 'above' | 'below' | 'child';
+export type NodeMoveDirection = 'promote' | 'demote' | 'move-up' | 'move-down';
+export interface WorksheetSmartArt {
+    /** Add a SmartArt diagram to the sheet. Returns the object ID. */
+    add(config: SmartArtConfig): Promise<string>;
+    /** Get a SmartArt diagram by object ID, or null if not found. */
+    get(objectId: string): Promise<SmartArtDiagram | null>;
+    /** Remove a SmartArt diagram by object ID. */
+    remove(objectId: string): Promise<void>;
+    /** List all SmartArt diagrams on the sheet. */
+    list(): Promise<SmartArtDiagram[]>;
+    /** Duplicate a SmartArt diagram. Returns the new object ID. */
+    duplicate(objectId: string): Promise<string>;
+    /** Add a node to a diagram. Returns the new node ID. */
+    addNode(objectId: string, text: string, position: NodePosition, referenceNodeId: NodeId | null): NodeId | Promise<NodeId>;
+    /** Remove a node from a diagram. */
+    removeNode(objectId: string, nodeId: NodeId): void | Promise<void>;
+    /** Update a node's properties. */
+    updateNode(objectId: string, nodeId: NodeId, updates: Partial<SmartArtNode>): void | Promise<void>;
+    /** Move a node in the hierarchy. */
+    moveNode(objectId: string, nodeId: NodeId, direction: NodeMoveDirection): void | Promise<void>;
+    /** Get a node by ID. */
+    getNode(objectId: string, nodeId: NodeId): SmartArtNode | undefined | Promise<SmartArtNode | undefined>;
+    /** Get a diagram by object ID. */
+    getDiagram(objectId: string): SmartArtDiagram | undefined | Promise<SmartArtDiagram | undefined>;
+    /** Get all diagrams on this sheet. */
+    getDiagramsOnSheet(): SmartArtDiagram[] | Promise<SmartArtDiagram[]>;
+    /** Change the diagram layout. */
+    changeLayout(objectId: string, newLayoutId: string): void | Promise<void>;
+    /** Change the quick style. */
+    changeQuickStyle(objectId: string, quickStyleId: string): void | Promise<void>;
+    /** Change the color theme. */
+    changeColorTheme(objectId: string, colorThemeId: string): void | Promise<void>;
+    /** Get the computed layout for a diagram. Returns cached result if valid. */
+    getComputedLayout(objectId: string): ComputedLayout | undefined | Promise<ComputedLayout | undefined>;
+    /** Invalidate the cached layout for a diagram. */
+    invalidateLayout(objectId: string): void;
+    /** Invalidate all cached layouts. */
+    invalidateAllLayouts(): void;
+}
+//# sourceMappingURL=smartart.d.ts.map