@univerjs-pro/sheets-mcp 0.10.14 → 0.11.0-nightly.202511151013

package/lib/types/controllers/config.schema.d.ts

@@ -1,5 +1,7 @@
 export declare const SHEET_MCP_PLUGIN_CONFIG_KEY = "sheet-mcp.config";
 export declare const configSymbol: unique symbol;
 export interface IUniverSheetMCPConfig {
+    /** Whether to enable worker mode */
+    enableWorker?: boolean;
 }
 export declare const defaultPluginConfig: IUniverSheetMCPConfig;

package/lib/types/facade/f-range.d.ts

@@ -0,0 +1,41 @@
+import { IFormulaUsage, IFormulaUsageAsA1 } from '@univerjs-pro/sheets-mcp';
+import { FRange } from '@univerjs/sheets/facade';
+/**
+ * @ignore
+ */
+export interface IFRangeSheetsMCP {
+    /**
+     * Get all formula usages in the range
+     * @returns A promise that resolves to an array of formula usages
+     *
+     * @example
+     * ```ts
+     * const workbook = univerAPI.getActiveWorkbook()
+     * const sheet = workbook.getActiveSheet()
+     * const range = sheet.getRangeByA1('A1:C10')
+     * const usages = await range.getFormulaUsages();
+     * ```
+     */
+    getFormulaUsages(): Promise<IFormulaUsage[]>;
+    /**
+     * Get all formula usages in the range in A1 notation
+     * @returns A promise that resolves to an array of formula usages in A1 notation
+     *
+     * @example
+     * ```ts
+     * const workbook = univerAPI.getActiveWorkbook()
+     * const sheet = workbook.getActiveSheet()
+     * const range = sheet.getRangeByA1('A1:C10')
+     * const usagesA1 = await range.getFormulaUsagesAsA1();
+     * ```
+     */
+    getFormulaUsagesAsA1(): Promise<IFormulaUsageAsA1[]>;
+}
+export declare class FRangeSheetsMCP extends FRange implements IFRangeSheetsMCP {
+    getFormulaUsages(): Promise<IFormulaUsage[]>;
+    getFormulaUsagesAsA1(): Promise<IFormulaUsageAsA1[]>;
+}
+declare module '@univerjs/sheets/facade' {
+    interface FRange extends IFRangeSheetsMCP {
+    }
+}

package/lib/types/facade/f-univer.d.ts

@@ -1,16 +1,14 @@
-import { ISheetFormulaError } from '@univerjs/engine-formula';
-import { IDataValidationError } from '@univerjs/sheets-data-validation/facade';
+import { ILintErrorReport } from './f-workbook';
 import { FUniver } from '@univerjs/core/facade';
 import '@univerjs/sheets-formula/facade';
 import '@univerjs/sheets-data-validation/facade';
-interface ILintErrorReport {
-    formulaErrors: ISheetFormulaError[];
-    dataValidationErrors: IDataValidationError[];
-}
 /**
  * @ignore
  */
 export interface IFUniverLintMCP {
+    /**
+     * @deprecated use {@link FWorkbookSheetsMCP.getLintErrors} instead.
+     */
     getLintErrors(): Promise<ILintErrorReport>;
 }
 export declare class FUniverLintMCPMixin extends FUniver implements IFUniverLintMCP {
@@ -20,4 +18,3 @@ declare module '@univerjs/core/facade' {
     interface FUniver extends IFUniverLintMCP {
     }
 }
-export {};

package/lib/types/facade/f-workbook.d.ts

@@ -0,0 +1,30 @@
+import { ISheetFormulaError } from '@univerjs/engine-formula';
+import { IDataValidationError } from '@univerjs/sheets-data-validation/facade';
+import { FWorkbook } from '@univerjs/sheets/facade';
+export interface ILintErrorReport {
+    formulaErrors: ISheetFormulaError[];
+    dataValidationErrors: IDataValidationError[];
+}
+/**
+ * @ignore
+ */
+export interface IFWorkbookSheetsMCPMixin {
+    /**
+     * Get lint errors report including formula errors and data validation errors
+     *
+     * @example
+     * ```ts
+     * const workbook = univerAPI.getActiveWorkbook()
+     * const lintErrors = await workbook.getLintErrors();
+     * console.log(lintErrors.formulaErrors, lintErrors.dataValidationErrors);
+     * ```
+     */
+    getLintErrors(): Promise<ILintErrorReport>;
+}
+export declare class FWorkbookSheetsMCPMixin extends FWorkbook implements IFWorkbookSheetsMCPMixin {
+    getLintErrors(): Promise<ILintErrorReport>;
+}
+declare module '@univerjs/sheets/facade' {
+    interface FWorkbook extends IFWorkbookSheetsMCPMixin {
+    }
+}

package/lib/types/facade/f-worksheet.d.ts

@@ -0,0 +1,39 @@
+import { IFormulaUsage, IFormulaUsageAsA1 } from '@univerjs-pro/sheets-mcp';
+import { FWorksheet } from '@univerjs/sheets/facade';
+/**
+ * @ignore
+ */
+export interface IFWorksheetSheetsMCP {
+    /**
+     * Get all formula usages in the worksheet
+     * @returns A promise that resolves to an array of formula usages
+     *
+     * @example
+     * ```ts
+     * const workbook = univerAPI.getActiveWorkbook()
+     * const sheet = workbook.getActiveSheet()
+     * const usages = await sheet.getFormulaUsages();
+     * ```
+     */
+    getFormulaUsages(): Promise<IFormulaUsage[]>;
+    /**
+     * Get all formula usages in the worksheet in A1 notation
+     * @returns A promise that resolves to an array of formula usages in A1 notation
+     *
+     * @example
+     * ```ts
+     * const workbook = univerAPI.getActiveWorkbook()
+     * const sheet = workbook.getActiveSheet()
+     * const usagesA1 = await sheet.getFormulaUsagesAsA1();
+     * ```
+     */
+    getFormulaUsagesAsA1(): Promise<IFormulaUsageAsA1[]>;
+}
+export declare class FWorksheetSheetsMCP extends FWorksheet implements IFWorksheetSheetsMCP {
+    getFormulaUsages(): Promise<IFormulaUsage[]>;
+    getFormulaUsagesAsA1(): Promise<IFormulaUsageAsA1[]>;
+}
+declare module '@univerjs/sheets/facade' {
+    interface FWorksheet extends IFWorksheetSheetsMCP {
+    }
+}

package/lib/types/facade/index.d.ts

@@ -1 +1,4 @@
 import './f-univer';
+import './f-workbook';
+import './f-worksheet';
+import './f-range';

package/lib/types/index.d.ts

@@ -1,2 +1,3 @@
 export { UniverSheetMCPPlugin } from './plugin';
+export { type IFormulaUsage, IFormulaUsageAnalyzer, type IFormulaUsageAsA1, toA1 } from './services/formula-analysis.service';
 export * from './tools';

package/lib/types/services/formula-analysis.service.d.ts

@@ -0,0 +1,53 @@
+import { ICellData, IRange, Nullable } from '@univerjs/core';
+import { ICalculateFormulaService, LexerTreeBuilder } from '@univerjs/engine-formula';
+/**
+ * Interface for formula usage information
+ */
+export interface IFormulaUsage {
+    /**
+     * The formula's first occurrence location
+     */
+    formula: string;
+    /**
+     * The formula's first occurrence cell range
+     */
+    firstOccurrence: IRange;
+    /**
+     * The filled ranges of the formula, including the first occurrence
+     */
+    filledRanges: IRange[];
+}
+/**
+ * Interface for formula usage information in A1 notation
+ */
+export interface IFormulaUsageAsA1 {
+    /**
+     * The formula's first occurrence location
+     */
+    formula: string;
+    /**
+     * The formula's first occurrence cell range in A1 notation
+     */
+    firstOccurrence: string;
+    /**
+     * The filled ranges of the formula in A1 notation, including the first occurrence
+     */
+    filledRanges: string;
+}
+export declare function toA1(usage: IFormulaUsage): IFormulaUsageAsA1;
+/**
+ * Convert rectangle coordinates to A1 notation
+ * @param param0 [r1, r2, c1, c2]
+ * @returns A1 notation string
+ */
+export declare function getA1Notation([r1, r2, c1, c2]: [number, number, number, number]): string;
+export declare const FormulaUsageAnalyzerChannelName = "sheets.mcp.formula-usage-analyzer";
+export declare const IFormulaUsageAnalyzer: import('@wendellhu/redi').IdentifierDecorator<FormulaUsageAnalyzer>;
+export declare class FormulaUsageAnalyzer {
+    protected _formulaService: ICalculateFormulaService;
+    private _lexerTreeBuilder;
+    constructor(_formulaService: ICalculateFormulaService, _lexerTreeBuilder: LexerTreeBuilder);
+    getAllFormulaUsages(data: Nullable<ICellData>[][]): IFormulaUsage[];
+    getFormulaHash(formulaString: string, refOffsetX: number, refOffsetY: number, ignoreAbsolute?: boolean): string;
+    moveFormulaRefOffset(formula: string, refOffsetX: number, refOffsetY: number, ignoreAbsolute?: boolean): string;
+}

package/lib/types/tools/formula-utils.d.ts

@@ -0,0 +1 @@
+export declare function extractFormulas(univerAPI: any, sheets?: string[]): Promise<string>;

package/lib/umd/facade.js

@@ -1 +1 @@
-function _0xfa01(_0xb00263,_0x1c3e38){const _0x4bbe16=_0x4bbe();return _0xfa01=function(_0xfa01e1,_0x4e4a11){_0xfa01e1=_0xfa01e1-0x10c;let _0x309ba0=_0x4bbe16[_0xfa01e1];return _0x309ba0;},_0xfa01(_0xb00263,_0x1c3e38);}function _0x4bbe(){const _0x49b414=['9UTBAaB','1119uQMgMW','4254531rZHryM','getActiveWorkbook','object','extend','11CJSCTk','10vZqwun','@univerjs/sheets-data-validation/facade','6113346xtllJM','@univerjs/core/facade','@univerjs/sheets-formula/facade','UniverCoreFacade','12113240UEtayP','amd','3050OHPSfO','FUniver','1742685iYpoCn','getLintErrors','getAllFormulaError','35837710aAVAjq','1268084oIDxCH'];_0x4bbe=function(){return _0x49b414;};return _0x4bbe();}(function(_0x2e9f2,_0x46d8bc){const _0x280eaf=_0xfa01,_0x2b0cd4=_0x2e9f2();while(!![]){try{const _0x4ac3da=-parseInt(_0x280eaf(0x11e))/0x1*(-parseInt(_0x280eaf(0x116))/0x2)+parseInt(_0x280eaf(0x11f))/0x3+-parseInt(_0x280eaf(0x11c))/0x4*(-parseInt(_0x280eaf(0x10e))/0x5)+-parseInt(_0x280eaf(0x110))/0x6+parseInt(_0x280eaf(0x118))/0x7+parseInt(_0x280eaf(0x114))/0x8*(parseInt(_0x280eaf(0x11d))/0x9)+-parseInt(_0x280eaf(0x11b))/0xa*(parseInt(_0x280eaf(0x10d))/0xb);if(_0x4ac3da===_0x46d8bc)break;else _0x2b0cd4['push'](_0x2b0cd4['shift']());}catch(_0x47191f){_0x2b0cd4['push'](_0x2b0cd4['shift']());}}}(_0x4bbe,0xe0666),function(_0x19f152,_0xafbde9){const _0x27e30=_0xfa01;typeof exports==_0x27e30(0x121)&&typeof module<'u'?_0xafbde9(require('@univerjs/core/facade'),require('@univerjs/sheets-formula/facade'),require('@univerjs/sheets-data-validation/facade')):typeof define=='function'&&define[_0x27e30(0x115)]?define([_0x27e30(0x111),_0x27e30(0x112),_0x27e30(0x10f)],_0xafbde9):(_0x19f152=typeof globalThis<'u'?globalThis:_0x19f152||self,_0xafbde9(_0x19f152[_0x27e30(0x113)]));}(this,function(_0x49d35b){'use strict';const _0xd7b970=_0xfa01;class _0x362966 extends _0x49d35b[_0xd7b970(0x117)]{async[_0xd7b970(0x119)](){const _0x5413a8=_0xd7b970,_0x3ab580=this[_0x5413a8(0x120)](),_0x4c2626=_0x3ab580[_0x5413a8(0x11a)](),_0x276ffe=await _0x3ab580['getAllDataValidationErrorAsync']();return{'formulaErrors':_0x4c2626,'dataValidationErrors':_0x276ffe};}}_0x49d35b[_0xd7b970(0x117)][_0xd7b970(0x10c)](_0x362966);}));
+function _0x1e9e(){const _0x1762e5=['getMaxRows','_worksheet','getAllFormulaError','@univerjs/sheets/facade','getFormulaUsagesAsA1','getFormulaUsages','1276924tZJTuS','49uFOLbj','extend','startRow','object','@univerjs/core','10aARqXb','UniverCoreFacade','38698060kJULcQ','getActiveWorkbook','FUniver','formula','getCellDataGrid','@univerjs/core/facade','2009624URcfug','getCellRaw','getIntersectRange','function','FRange','map','amd','filledRanges','_injector','getRange','IFormulaUsageAnalyzer','4205358bGiZlP','FWorksheet','1809798FkOJpo','4894731vmjOTK','3LGoRzD','UniverSheetsFormulaFacade','moveFormulaRefOffset','getAllDataValidationErrorAsync','getAllFormulaUsages','UniverSheetsDataValidationFacade','push','223979BEHRsn','UniverSheetsFacade','@univerjs/sheets-data-validation/facade','getMaxColumns','length','get','FWorkbook','@univerjs/sheets-formula/facade','getLintErrors','startColumn'];_0x1e9e=function(){return _0x1762e5;};return _0x1e9e();}function _0x5d5f(_0x373317,_0x5ac3e1){const _0x1e9e79=_0x1e9e();return _0x5d5f=function(_0x5d5fc2,_0x4f4b5c){_0x5d5fc2=_0x5d5fc2-0xd4;let _0x31eafe=_0x1e9e79[_0x5d5fc2];return _0x31eafe;},_0x5d5f(_0x373317,_0x5ac3e1);}(function(_0x39d5c6,_0x65c12b){const _0x2043f9=_0x5d5f,_0x18d9f0=_0x39d5c6();while(!![]){try{const _0x34a553=parseInt(_0x2043f9(0xf0))/0x1+parseInt(_0x2043f9(0xe7))/0x2*(-parseInt(_0x2043f9(0xe9))/0x3)+parseInt(_0x2043f9(0x100))/0x4*(-parseInt(_0x2043f9(0x106))/0x5)+parseInt(_0x2043f9(0xe5))/0x6+-parseInt(_0x2043f9(0x101))/0x7*(parseInt(_0x2043f9(0xda))/0x8)+-parseInt(_0x2043f9(0xe8))/0x9+parseInt(_0x2043f9(0xd4))/0xa;if(_0x34a553===_0x65c12b)break;else _0x18d9f0['push'](_0x18d9f0['shift']());}catch(_0x559218){_0x18d9f0['push'](_0x18d9f0['shift']());}}}(_0x1e9e,0xe7b2d),function(_0x21614a,_0x1f3e95){const _0x511fff=_0x5d5f;typeof exports==_0x511fff(0x104)&&typeof module<'u'?_0x1f3e95(require('@univerjs/core/facade'),require('@univerjs/sheets-formula/facade'),require('@univerjs/sheets-data-validation/facade'),require('@univerjs/sheets/facade'),require('@univerjs-pro/sheets-mcp'),require('@univerjs/core')):typeof define==_0x511fff(0xdd)&&define[_0x511fff(0xe0)]?define([_0x511fff(0xd9),_0x511fff(0xf7),_0x511fff(0xf2),_0x511fff(0xfd),'@univerjs-pro/sheets-mcp',_0x511fff(0x105)],_0x1f3e95):(_0x21614a=typeof globalThis<'u'?globalThis:_0x21614a||self,_0x1f3e95(_0x21614a[_0x511fff(0x107)],_0x21614a[_0x511fff(0xea)],_0x21614a[_0x511fff(0xee)],_0x21614a[_0x511fff(0xf1)],_0x21614a['UniverProSheetsMcp'],_0x21614a['UniverCore']));}(this,function(_0x2cc7f1,_0x5636e2,_0x661199,_0x3cb89d,_0x3a0c7f,_0x21f12c){'use strict';const _0x31c113=_0x5d5f;class _0x28abe8 extends _0x2cc7f1[_0x31c113(0xd6)]{async['getLintErrors'](){const _0x3b9cee=_0x31c113;return this[_0x3b9cee(0xd5)]()['getLintErrors']();}}_0x2cc7f1[_0x31c113(0xd6)]['extend'](_0x28abe8);class _0x142d77 extends _0x3cb89d['FWorkbook']{async[_0x31c113(0xf8)](){const _0x377ee5=_0x31c113,_0x1cdd90=this[_0x377ee5(0xfc)](),_0x305f60=await this[_0x377ee5(0xec)]();return{'formulaErrors':_0x1cdd90,'dataValidationErrors':_0x305f60};}}_0x3cb89d[_0x31c113(0xf6)][_0x31c113(0x102)](_0x142d77);class _0x13fb9b extends _0x3cb89d[_0x31c113(0xe6)]{async[_0x31c113(0xff)](){const _0x19ec40=_0x31c113,_0x4f0cbd=this[_0x19ec40(0xe2)][_0x19ec40(0xf5)](_0x3a0c7f[_0x19ec40(0xe4)]),_0x1c11ce=this['getRange'](0x0,0x0,this[_0x19ec40(0xfa)]()+0x1,this[_0x19ec40(0xf3)]()+0x1)[_0x19ec40(0xd8)]();return await _0x4f0cbd[_0x19ec40(0xed)](_0x1c11ce);}async[_0x31c113(0xfe)](){const _0x353a80=_0x31c113;return(await this[_0x353a80(0xff)]())[_0x353a80(0xdf)](_0x3a0c7f['toA1']);}}_0x3cb89d['FWorksheet'][_0x31c113(0x102)](_0x13fb9b);class _0x30e1d9 extends _0x3cb89d[_0x31c113(0xde)]{async[_0x31c113(0xff)](){const _0x1c0792=_0x31c113,_0xe52f8d=this[_0x1c0792(0xe2)][_0x1c0792(0xf5)](_0x3a0c7f[_0x1c0792(0xe4)]),_0x46f0f4=(({startRow:_0x179e8c,endRow:_0x1bf074,startColumn:_0x5c63b6,endColumn:_0x5a6eb4})=>{const _0x5b29df=_0x1c0792,_0x48887f=[];for(let _0x5e60dd=_0x179e8c;_0x5e60dd<=_0x1bf074;_0x5e60dd++){const _0x5a73bc=[];for(let _0x3e6391=_0x5c63b6;_0x3e6391<=_0x5a6eb4;_0x3e6391++)_0x5a73bc[_0x5b29df(0xef)](this[_0x5b29df(0xfb)][_0x5b29df(0xdb)](_0x5e60dd,_0x3e6391));_0x48887f['push'](_0x5a73bc);}return _0x48887f;})({'startRow':0x0,'endRow':this[_0x1c0792(0xfb)][_0x1c0792(0xfa)](),'startColumn':0x0,'endColumn':this[_0x1c0792(0xfb)][_0x1c0792(0xf3)]()}),_0x3cbc46=await _0xe52f8d[_0x1c0792(0xed)](_0x46f0f4),_0x4d39b2=this[_0x1c0792(0xe3)](),_0x11c641=[];for(let _0x42eb69=0x0;_0x42eb69<_0x3cbc46[_0x1c0792(0xf4)];_0x42eb69++){const _0x2fc43a=_0x3cbc46[_0x42eb69],_0x5bd5c8=_0x2fc43a[_0x1c0792(0xe1)],_0x657c2=[];for(let _0xbc71fa=0x0;_0xbc71fa<_0x5bd5c8[_0x1c0792(0xf4)];_0xbc71fa++){const _0x123ac7=_0x5bd5c8[_0xbc71fa],_0x27c444=_0x21f12c[_0x1c0792(0xdc)](_0x123ac7,_0x4d39b2);_0x27c444&&_0x657c2[_0x1c0792(0xef)](_0x27c444);}if(_0x657c2[_0x1c0792(0xf4)]>0x0){_0x2fc43a[_0x1c0792(0xe1)]=_0x657c2;const _0x52f8fc=_0x657c2[0x0],_0x22c3e8=_0x52f8fc[_0x1c0792(0x103)]-_0x4d39b2['startRow'],_0x349f5f=_0x52f8fc[_0x1c0792(0xf9)]-_0x4d39b2['startColumn'];_0x2fc43a[_0x1c0792(0xd7)]=await _0xe52f8d[_0x1c0792(0xeb)](_0x2fc43a['formula'],_0x22c3e8,_0x349f5f),_0x11c641[_0x1c0792(0xef)](_0x2fc43a);}}return _0x11c641;}async[_0x31c113(0xfe)](){const _0x4ec495=_0x31c113;return(await this[_0x4ec495(0xff)]())[_0x4ec495(0xdf)](_0x3a0c7f['toA1']);}}_0x3cb89d['FRange'][_0x31c113(0x102)](_0x30e1d9);}));