@sheetxl/sdk 0.6.6 → 0.6.8

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

@@ -1,5 +1,5 @@
 /**
- * @license @sheetxl/sdk - SDK - A high-performance, embeddable spreadsheet engine. - v0.6.6
+ * @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.6",
+  "version": "0.6.8",
   "license": "SEE LICENSE IN <LICENSE>",
   "type": "module",
   "exports": {
@@ -31,9 +31,9 @@
     "automation"
   ],
   "dependencies": {
-    "@sheetxl/primitives": "^0.6.6",
-    "@sheetxl/scripting": "^0.6.6",
-    "@sheetxl/utils": "^0.6.6",
+    "@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.
      *
@@ -3720,6 +3729,10 @@ export declare interface ICellContainerOptions {
      * Option to provide a custom calculation.
      */
     calculation?: ICalculation;
+    /**
+     * If the parent has a workbook
+     */
+    workbook?: IWorkbook;
     /**
      * The store for all state changes. This is provided to enable versioning, undo/redo, distributed editing, etc.
      *
@@ -4565,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}.
      *
@@ -8568,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 });
@@ -8591,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.
          */
@@ -9475,6 +9495,10 @@ export declare interface IModule {
      */
     getLanguage(): string;
     getErrors(): any[];
+    /**
+     * The name of the module.
+     */
+    getName(): string;
     /**
      * Remove the module from the collection.
      */
@@ -11353,13 +11377,21 @@ export declare interface IScript {
     /**
      * Returns if the script is readonly.
      */
+    isReadOnly(): boolean;
     /**
      * Convenience method for creating a module from a file.
      *
      * @remarks
      * equivalent to `getModules().search( { type: 'macro', name } )`
      */
-    searchFunction(options?: IScript.SearchFunctionsOptions): IFunction[];
+    searchFunctions(options?: IScript.SearchOptions): Promise<IFunction[]>;
+    /**
+     * Add Listeners.
+     *
+     * @see
+     * {@link IListener.ISource.addListeners}
+     */
+    addListeners(listeners: IScript.IListeners, options?: IListener.Options): IListener.Remove;
     /**
      * Returns a JSON representation of the script.
      */
@@ -11374,6 +11406,30 @@ export declare interface IScript {
  * {@link IFunctionCollection}
  */
 export declare namespace IScript {
+    /**
+     * Events for {@link ISheet}.
+     */
+    export interface Events {
+        /**
+         * Called before search.
+         */
+        onBeforeSearch?(source: IScript): Promise<void> | void;
+        /**
+         * Called after load.
+         */
+        onChange?(source: IScript): void;
+        /**
+         * Called before load. If any exception is thrown this
+         * exception will be returned to the client and delete will be aborted.
+         */
+        onBeforeSave?(source: IScript): Promise<void> | void;
+        /**
+         * Called after save.
+         */
+        onSave?(source: IScript): void;
+    }
+    export interface IListeners extends IListener.Callbacks<IScript, IScript.Events> {
+    }
     /**
      * The results from a macro script
      */
@@ -11381,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;
     }
 }
 
@@ -11696,6 +11750,13 @@ export declare interface ISheet extends ITransaction.ITransactional, IListener.I
      * Returns the {@link ICalculation} for the sheet.
      */
     getCalculation(): ICalculation;
+    /**
+     * Returns the {@link IWorkbook} for the sheet.
+     *
+     * @remarks
+     * This may be null if not created via a workbook
+     */
+    getWorkbook(): IWorkbook | null;
     /**
      * Removes from a container. This is usually the `Workbook`. If this is being
      * used standalone this operation will throw an exception.
@@ -18328,6 +18389,7 @@ export declare class Sheet implements ISheet {
     protected _namesRemoveListener: IListener.Remove;
     protected _calculation: ICalculation;
     protected _ownsCalculation: boolean;
+    protected _workbook: IWorkbook | null;
     protected _tables: ITableCollection;
     protected _conditionals: IConditionalFormatCollection;
     protected _movables: IMovableCollection;
@@ -18435,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 */
@@ -18583,8 +18646,10 @@ export declare class Sheet implements ISheet {
     setPosition(index: number): ISheet;
     /** {@inheritDoc ISheet.getNames} */
     getNames(): INamedCollection;
-    /** {@inheritDoc IWorkbook.getCalculation} */
+    /** {@inheritDoc ISheet.getCalculation} */
     getCalculation(): ICalculation;
+    /** {@inheritDoc ISheet.getWorkbook} */
+    getWorkbook(): IWorkbook | null;
     get [Symbol.toStringTag](): string;
     /** {@inheritDoc ICellRange.toString} */
     toString(): string;