@sheetxl/sdk 0.6.7 → 0.6.8

package/node/esm/{mLbyGFmnqVEUU5k1.mjs → lQwFvDr-SsCqhuIe.mjs}

@@ -1,5 +1,5 @@
 /**
- * @license @sheetxl/sdk - SDK - A high-performance, embeddable spreadsheet engine. - v0.6.7
+ * @license @sheetxl/sdk - SDK - A high-performance, embeddable spreadsheet engine. - v0.6.8
  *
  * (C) 2025-present SheetXL Inc. & Michael T. Ford
  * License: The license can be found at https://www.sheetxl.com/license.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sheetxl/sdk",
   "description": "SDK - A high-performance, embeddable spreadsheet engine.",
-  "version": "0.6.7",
+  "version": "0.6.8",
   "license": "SEE LICENSE IN <LICENSE>",
   "type": "module",
   "exports": {
@@ -31,9 +31,9 @@
     "automation"
   ],
   "dependencies": {
-    "@sheetxl/primitives": "^0.6.7",
-    "@sheetxl/scripting": "^0.6.7",
-    "@sheetxl/utils": "^0.6.7",
+    "@sheetxl/primitives": "^0.6.8",
+    "@sheetxl/scripting": "^0.6.8",
+    "@sheetxl/utils": "^0.6.8",
     "bahttext": "^2.3.0",
     "bessel": "^1.0.2",
     "chalk": "^5.5.0",

package/types/index.d.ts

@@ -615,6 +615,8 @@ export declare class Calculation extends AbstractModel<State_2, ICalculation.JSO
     stop(): Promise<void>;
     /** @inheritdoc ICalculation.getStatus */
     getStatus(): ICalculation.Status;
+    /** @inheritdoc ICalculation.waitForFinish */
+    waitForFinish(): Promise<void>;
     /** @inheritdoc ICalculation.getFunctions */
     getFunctions(): IFunctionCollection;
     /** @inheritdoc IFormulaContext.getRuntime */
@@ -2825,6 +2827,13 @@ export declare interface ICalculation extends IModel {
     getFunctions(): IFunctionCollection;
     /** @inheritdoc IFormulaContext.getRuntime */
     getRuntime(): IRuntime;
+    /**
+     * Waits for the calculation to finish.
+     *
+     * @remarks
+     * This is useful when needing to ensure that the values in the calculation cycle are up-to-date.
+     */
+    waitForFinish(): Promise<void>;
     /**
      * Add Listeners.
      *
@@ -4569,6 +4578,13 @@ export declare interface ICellRange {
      * @param full If `true` then all formulas will be recalculated.
      */
     calculate(full?: boolean): this;
+    /**
+     * Waits for all calculations to finish.
+     *
+     * @remarks
+     * Useful for ensuring that all calculations are complete before proceeding.
+     */
+    waitForCalcs(): Promise<this>;
     /**
      * Fill the range to a destination using an array of {@link IAutoFill.Filler}.
      *
@@ -8572,9 +8588,9 @@ export declare interface IFunctionCollection extends ICollection<IFunction> {
      *
      * If no filter criteria is provided, all items will be returned.
      *
-     * @param options {@link IFunctionCollection.GetItemsOptions}
+     * @param options {@link IFunctionCollection.SearchOptions}
      */
-    getItems(options?: IFunctionCollection.GetItemsOptions): IFunction[];
+    search(options?: IFunctionCollection.SearchOptions): Promise<IFunction[]>;
     /**
      * Convenience method for filter by name.
      * This is functionally equivalent to getItems({ name });
@@ -8595,7 +8611,7 @@ export declare namespace IFunctionCollection {
     /**
      * Options for searching a function in the collection.
      */
-    export interface GetItemsOptions {
+    export interface SearchOptions {
         /**
          * Search with the given name. This is case insensitive.
          */
@@ -9479,6 +9495,10 @@ export declare interface IModule {
      */
     getLanguage(): string;
     getErrors(): any[];
+    /**
+     * The name of the module.
+     */
+    getName(): string;
     /**
      * Remove the module from the collection.
      */
@@ -11364,7 +11384,7 @@ export declare interface IScript {
      * @remarks
      * equivalent to `getModules().search( { type: 'macro', name } )`
      */
-    searchFunctions(options?: IScript.SearchFunctionsOptions): Promise<IFunction[]>;
+    searchFunctions(options?: IScript.SearchOptions): Promise<IFunction[]>;
     /**
      * Add Listeners.
      *
@@ -11417,11 +11437,9 @@ export declare namespace IScript {
         params: any[];
         results: any;
     }
-    export interface SearchFunctionsOptions {
-        name?: string;
-        category?: string;
-        type?: string;
+    export interface SearchOptions extends IFunctionCollection.SearchOptions {
         moduleName?: string;
+        includeBuiltIn?: boolean;
     }
 }
 
@@ -18479,6 +18497,7 @@ export declare class Sheet implements ISheet {
     /* Excluded from this release type: _updateFormulaSpatial */
     /* Excluded from this release type: _realizeCalcedValues */
     /* Excluded from this release type: _calculate */
+    /* Excluded from this release type: _waitForCalcs */
     /* Excluded from this release type: _calculateFull */
     /* Excluded from this release type: _setComments */
     /* Excluded from this release type: _clear */

package/types/scripting.d.ts

@@ -9515,9 +9515,9 @@ declare module "script/IFunctionCollection" {
          *
          * If no filter criteria is provided, all items will be returned.
          *
-         * @param options {@link IFunctionCollection.GetItemsOptions}
+         * @param options {@link IFunctionCollection.SearchOptions}
          */
-        getItems(options?: IFunctionCollection.GetItemsOptions): IFunction[];
+        search(options?: IFunctionCollection.SearchOptions): Promise<IFunction[]>;
         /**
          * Convenience method for filter by name.
          * This is functionally equivalent to getItems({ name });
@@ -9537,7 +9537,7 @@ declare module "script/IFunctionCollection" {
         /**
          * Options for searching a function in the collection.
          */
-        interface GetItemsOptions {
+        interface SearchOptions {
             /**
              * Search with the given name. This is case insensitive.
              */
@@ -9621,6 +9621,10 @@ declare module "script/IModule" {
          */
         getLanguage(): string;
         getErrors(): any[];
+        /**
+         * The name of the module.
+         */
+        getName(): string;
         /**
          * Remove the module from the collection.
          */
@@ -9744,6 +9748,7 @@ declare module "script/IModuleCollection" {
 declare module "script/IScript" {
     import type { IFunction } from '@sheetxl/primitives';
     import type { IListener } from "listener/index";
+    import type { IFunctionCollection } from "script/IFunctionCollection";
     import type { IModule } from "script/IModule";
     import type { IModuleCollection } from "script/IModuleCollection";
     /**
@@ -9793,7 +9798,7 @@ declare module "script/IScript" {
          * @remarks
          * equivalent to `getModules().search( { type: 'macro', name } )`
          */
-        searchFunctions(options?: IScript.SearchFunctionsOptions): Promise<IFunction[]>;
+        searchFunctions(options?: IScript.SearchOptions): Promise<IFunction[]>;
         /**
          * Add Listeners.
          *
@@ -9845,11 +9850,9 @@ declare module "script/IScript" {
             params: any[];
             results: any;
         }
-        interface SearchFunctionsOptions {
-            name?: string;
-            category?: string;
-            type?: string;
+        interface SearchOptions extends IFunctionCollection.SearchOptions {
             moduleName?: string;
+            includeBuiltIn?: boolean;
         }
     }
 }
@@ -9892,6 +9895,13 @@ declare module "calculation/ICalculation" {
         getFunctions(): IFunctionCollection;
         /** @inheritdoc IFormulaContext.getRuntime */
         getRuntime(): IRuntime;
+        /**
+         * Waits for the calculation to finish.
+         *
+         * @remarks
+         * This is useful when needing to ensure that the values in the calculation cycle are up-to-date.
+         */
+        waitForFinish(): Promise<void>;
         /**
          * Add Listeners.
          *
@@ -15467,6 +15477,7 @@ declare module "script/FunctionCollection" {
     import type { IFunction, IFormulaContext } from '@sheetxl/primitives';
     import { type ITransaction } from "transaction/index";
     import type { IListener } from "listener/index";
+    import type { ICollection } from "type/index";
     import { ListenerEmitter } from "listener/ListenerEmitter";
     import type { IFunctionCollection } from "script/IFunctionCollection";
     /**
@@ -15481,9 +15492,11 @@ declare module "script/FunctionCollection" {
         private _closed;
         constructor(options: ConstructorOptions);
         /** {@inheritDoc IFunctionCollection.getItems} */
-        getItems(options?: IFunctionCollection.GetItemsOptions): IFunction[];
+        getItems(options?: ICollection.GetItemsOptions): IFunction[];
         /** {@inheritDoc IFunctionCollection.getByName} */
         getByName(name: string): IFunction | null;
+        /** {@inheritDoc IFunctionCollection.search} */
+        search(options?: IFunctionCollection.SearchOptions): Promise<IFunction[]>;
         /** {@inheritDoc ICollection.getCount} */
         getCount(): number;
         /** {@inheritDoc IFunctionCollection.validateName} */
@@ -15522,10 +15535,14 @@ declare module "script/Module" {
         protected _json: IModule.JSON;
         protected _functions: IFunctionCollection;
         protected _emitter: ListenerEmitter<IModule, IModule.IListeners>;
+        protected _name?: string;
         constructor(options: {
             json: IModule.JSON;
             readonlyFunctions: Map<string, IFunction>;
+            name: string;
         });
+        /** {@inheritDoc IModule.getName} */
+        getName(): string;
         /** {@inheritDoc IModule.getFunctions} */
         getFunctions(): IFunctionCollection;
         /** {@inheritDoc IModule.getSource} */
@@ -15544,7 +15561,7 @@ declare module "script/Module" {
 }
 declare module "script/_ModuleUtils" {
     import { IModule } from "script/IModule";
-    export const jsonToModule: (json: IModule.JSON, declarationsOnly?: boolean) => Promise<IModule>;
+    export const jsonToModule: (name: string, json: IModule.JSON, declarationsOnly?: boolean) => Promise<IModule>;
     export function runAsyncGenerator<T>(generator: AsyncGenerator<any, T, any>): Promise<T>;
 }
 declare module "script/Scripts" {
@@ -15572,7 +15589,7 @@ declare module "script/Scripts" {
         /** {@inheritDoc IScript.search} */
         executeMacro(functionName: string, moduleId?: string): Promise<IScript.MacroResults>;
         /** {@inheritDoc IScript.searchFunctions} */
-        searchFunctions(options?: IScript.SearchFunctionsOptions): Promise<IFunction[]>;
+        searchFunctions(options?: IScript.SearchOptions): Promise<IFunction[]>;
         /** {@inheritDoc IScript.start} */
         start(): Promise<void>;
         /** {@inheritDoc IListener.ISource.addListeners} */
@@ -15592,7 +15609,7 @@ declare module "script/Scripts" {
             workbook: IWorkbook;
             onRemove?: (moduleId: string, module: IModule) => void;
             onAdd?: (moduleId: string, module: IModule) => void;
-            getBuiltInFunctions?(): Promise<IFunctionCollection>;
+            getBuiltInFunctions?(): IFunctionCollection;
         }
     }
 }
@@ -21775,6 +21792,8 @@ declare module "sheet/Sheet" {
         /** @internal */
         protected _calculate(ranges: ICellRanges.Coords, options?: ICalcGraph.CalculateOptions): void;
         /** @internal */
+        protected _waitForCalcs(): Promise<void>;
+        /** @internal */
         protected _calculateFull(): void;
         /** @internal */
         protected _setComments(ranges: readonly ISpatialMap.Entry<IComment.JSON>[], comments?: IComment.JSON, // we do this because updateTuples may update each
@@ -22111,6 +22130,8 @@ declare module "sheet/SheetRange" {
         getValue(options?: ICellRange.GetValuesOptions): Scalar | JSScalar;
         /** {@inheritDoc ICellRange.calculate} */
         calculate(full: boolean): this;
+        /** {@inheritDoc ICellRange.waitForCalcs} */
+        waitForCalcs(): Promise<this>;
         /** {@inheritDoc ICellRange.getCells} */
         getCells(options?: ICellRange.GetValuesOptions): ICell[][];
         /** {@inheritDoc ICellRange.getCell} */
@@ -29319,6 +29340,8 @@ declare module "calculation/Calculation" {
         stop(): Promise<void>;
         /** @inheritdoc ICalculation.getStatus */
         getStatus(): ICalculation.Status;
+        /** @inheritdoc ICalculation.waitForFinish */
+        waitForFinish(): Promise<void>;
         /** @inheritdoc ICalculation.getFunctions */
         getFunctions(): IFunctionCollection;
         /** @inheritdoc IFormulaContext.getRuntime */
@@ -32071,6 +32094,13 @@ declare module "cellRange/ICellRange" {
          * @param full If `true` then all formulas will be recalculated.
          */
         calculate(full?: boolean): this;
+        /**
+         * Waits for all calculations to finish.
+         *
+         * @remarks
+         * Useful for ensuring that all calculations are complete before proceeding.
+         */
+        waitForCalcs(): Promise<this>;
         /**
          * Fill the range to a destination using an array of {@link IAutoFill.Filler}.
          *