@sheetxl/sdk 0.6.5 → 0.6.7

package/node/esm/{qu-NfeeDZTjvhO6W.mjs → mLbyGFmnqVEUU5k1.mjs}

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

package/node/esm/{DONfOZ2QJQtXJM5_.mjs → wa0JB_y6NmzvoRKB.mjs}

@@ -1,5 +1,5 @@
 /**
- * @license @sheetxl/sdk - SDK - A high-performance, embeddable spreadsheet engine. - v0.6.5
+ * @license @sheetxl/sdk - SDK - A high-performance, embeddable spreadsheet engine. - v0.6.7
  *
  * (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.5",
+  "version": "0.6.7",
   "license": "SEE LICENSE IN <LICENSE>",
   "type": "module",
   "exports": {
@@ -31,9 +31,9 @@
     "automation"
   ],
   "dependencies": {
-    "@sheetxl/primitives": "^0.6.5",
-    "@sheetxl/scripting": "^0.6.5",
-    "@sheetxl/utils": "^0.6.5",
+    "@sheetxl/primitives": "^0.6.7",
+    "@sheetxl/scripting": "^0.6.7",
+    "@sheetxl/utils": "^0.6.7",
     "bahttext": "^2.3.0",
     "bessel": "^1.0.2",
     "chalk": "^5.5.0",

package/types/index.d.ts

@@ -3720,6 +3720,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.
      *
@@ -11353,13 +11357,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.SearchFunctionsOptions): 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 +11386,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
      */
@@ -11383,6 +11419,7 @@ export declare namespace IScript {
     }
     export interface SearchFunctionsOptions {
         name?: string;
+        category?: string;
         type?: string;
         moduleName?: string;
     }
@@ -11695,6 +11732,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.
@@ -18327,6 +18371,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;
@@ -18582,8 +18627,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;