@univerjs-pro/sheets-mcp 0.10.14 → 0.11.0

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 _0x5ce7(_0x5ef5c8,_0x9198c7){const _0x4278b5=_0x4278();return _0x5ce7=function(_0x5ce7aa,_0x24d94a){_0x5ce7aa=_0x5ce7aa-0x116;let _0x568ae2=_0x4278b5[_0x5ce7aa];return _0x568ae2;},_0x5ce7(_0x5ef5c8,_0x9198c7);}(function(_0x23cf83,_0x19d2f2){const _0x1dad50=_0x5ce7,_0x109dc3=_0x23cf83();while(!![]){try{const _0x260ae9=-parseInt(_0x1dad50(0x124))/0x1+-parseInt(_0x1dad50(0x120))/0x2*(-parseInt(_0x1dad50(0x142))/0x3)+-parseInt(_0x1dad50(0x12b))/0x4*(parseInt(_0x1dad50(0x116))/0x5)+parseInt(_0x1dad50(0x133))/0x6+parseInt(_0x1dad50(0x132))/0x7*(-parseInt(_0x1dad50(0x11b))/0x8)+parseInt(_0x1dad50(0x11f))/0x9+parseInt(_0x1dad50(0x135))/0xa;if(_0x260ae9===_0x19d2f2)break;else _0x109dc3['push'](_0x109dc3['shift']());}catch(_0x1568bd){_0x109dc3['push'](_0x109dc3['shift']());}}}(_0x4278,0xf40c8),function(_0x513cad,_0x55aa17){const _0x464f0e=_0x5ce7;typeof exports=='object'&&typeof module<'u'?_0x55aa17(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==_0x464f0e(0x125)&&define[_0x464f0e(0x13e)]?define([_0x464f0e(0x11c),_0x464f0e(0x119),_0x464f0e(0x137),'@univerjs/sheets/facade',_0x464f0e(0x130),_0x464f0e(0x118)],_0x55aa17):(_0x513cad=typeof globalThis<'u'?globalThis:_0x513cad||self,_0x55aa17(_0x513cad[_0x464f0e(0x146)],_0x513cad[_0x464f0e(0x11a)],_0x513cad['UniverSheetsDataValidationFacade'],_0x513cad[_0x464f0e(0x134)],_0x513cad['UniverProSheetsMcp'],_0x513cad[_0x464f0e(0x129)]));}(this,function(_0x52b74e,_0x564295,_0x55549b,_0x3fb9b8,_0x2be888,_0x4d0f64){'use strict';const _0x46c8ed=_0x5ce7;class _0x594f53 extends _0x52b74e['FUniver']{async[_0x46c8ed(0x13c)](){const _0x13fc03=_0x46c8ed;return this[_0x13fc03(0x121)]()[_0x13fc03(0x13c)]();}}_0x52b74e[_0x46c8ed(0x144)]['extend'](_0x594f53);class _0x1cbc33 extends _0x3fb9b8[_0x46c8ed(0x12d)]{async[_0x46c8ed(0x13c)](){const _0x113915=_0x46c8ed,_0xef3637=this[_0x113915(0x143)](),_0x3ef277=await this[_0x113915(0x128)]();return{'formulaErrors':_0xef3637,'dataValidationErrors':_0x3ef277};}}_0x3fb9b8[_0x46c8ed(0x12d)][_0x46c8ed(0x13a)](_0x1cbc33);class _0x3926dc extends _0x3fb9b8[_0x46c8ed(0x11e)]{async[_0x46c8ed(0x122)](){const _0x70627f=_0x46c8ed,_0x244b71=this[_0x70627f(0x11d)][_0x70627f(0x117)](_0x2be888[_0x70627f(0x138)]),_0x23655c=this[_0x70627f(0x141)](0x0,0x0,this['getMaxRows']()+0x1,this[_0x70627f(0x12f)]()+0x1)[_0x70627f(0x139)]();return await _0x244b71[_0x70627f(0x131)](_0x23655c);}async['getFormulaUsagesAsA1'](){const _0x21e323=_0x46c8ed;return(await this['getFormulaUsages']())[_0x21e323(0x12c)](_0x2be888[_0x21e323(0x127)]);}}_0x3fb9b8['FWorksheet'][_0x46c8ed(0x13a)](_0x3926dc);class _0x4576e3 extends _0x3fb9b8['FRange']{async[_0x46c8ed(0x122)](){const _0xeee94c=_0x46c8ed,_0x182c7d=this[_0xeee94c(0x11d)]['get'](_0x2be888['IFormulaUsageAnalyzer']),_0x24bb7b=(({startRow:_0x1e4680,endRow:_0x6946c,startColumn:_0x20af19,endColumn:_0xd05730})=>{const _0x343665=_0xeee94c,_0x4befe2=[];for(let _0x530615=_0x1e4680;_0x530615<=_0x6946c;_0x530615++){const _0x25b08c=[];for(let _0x5974b5=_0x20af19;_0x5974b5<=_0xd05730;_0x5974b5++)_0x25b08c[_0x343665(0x13b)](this['_worksheet']['getCellRaw'](_0x530615,_0x5974b5));_0x4befe2[_0x343665(0x13b)](_0x25b08c);}return _0x4befe2;})({'startRow':0x0,'endRow':this[_0xeee94c(0x13d)][_0xeee94c(0x13f)](),'startColumn':0x0,'endColumn':this[_0xeee94c(0x13d)]['getMaxColumns']()}),_0x3252e8=await _0x182c7d[_0xeee94c(0x131)](_0x24bb7b),_0x16fb9e=this['getRange'](),_0x2c775b=[];for(let _0x4d8edb=0x0;_0x4d8edb<_0x3252e8[_0xeee94c(0x123)];_0x4d8edb++){const _0x436d0e=_0x3252e8[_0x4d8edb],_0x23aaca=_0x436d0e[_0xeee94c(0x12e)],_0xb3f477=[];for(let _0x17b14a=0x0;_0x17b14a<_0x23aaca[_0xeee94c(0x123)];_0x17b14a++){const _0x5c137e=_0x23aaca[_0x17b14a],_0x166e4d=_0x4d0f64[_0xeee94c(0x140)](_0x5c137e,_0x16fb9e);_0x166e4d&&_0xb3f477[_0xeee94c(0x13b)](_0x166e4d);}if(_0xb3f477[_0xeee94c(0x123)]>0x0){_0x436d0e['filledRanges']=_0xb3f477;const _0x35f6c2=_0xb3f477[0x0],_0xfac242=_0x35f6c2['startRow']-_0x16fb9e[_0xeee94c(0x145)],_0x438433=_0x35f6c2[_0xeee94c(0x126)]-_0x16fb9e['startColumn'];_0x436d0e['formula']=await _0x182c7d[_0xeee94c(0x147)](_0x436d0e[_0xeee94c(0x136)],_0xfac242,_0x438433),_0x2c775b['push'](_0x436d0e);}}return _0x2c775b;}async[_0x46c8ed(0x12a)](){const _0x1d5c6d=_0x46c8ed;return(await this[_0x1d5c6d(0x122)]())['map'](_0x2be888[_0x1d5c6d(0x127)]);}}_0x3fb9b8['FRange']['extend'](_0x4576e3);}));function _0x4278(){const _0x223bac=['9635838ZkkIVF','UniverSheetsFacade','28111360LLdxPL','formula','@univerjs/sheets-data-validation/facade','IFormulaUsageAnalyzer','getCellDataGrid','extend','push','getLintErrors','_worksheet','amd','getMaxRows','getIntersectRange','getRange','77238XtYXDR','getAllFormulaError','FUniver','startRow','UniverCoreFacade','moveFormulaRefOffset','9971575YaJoxP','get','@univerjs/core','@univerjs/sheets-formula/facade','UniverSheetsFormulaFacade','5872AbvYnJ','@univerjs/core/facade','_injector','FWorksheet','10754415rphVvu','26cVcEqP','getActiveWorkbook','getFormulaUsages','length','1310845UrPQhA','function','startColumn','toA1','getAllDataValidationErrorAsync','UniverCore','getFormulaUsagesAsA1','4blFPeQ','map','FWorkbook','filledRanges','getMaxColumns','@univerjs-pro/sheets-mcp','getAllFormulaUsages','15659TmVHuH'];_0x4278=function(){return _0x223bac;};return _0x4278();}