@sheetxl/sdk 0.7.6 → 0.7.8

package/node/esm/{4TCSsIA1FcFUpZq3.mjs → oZjh_m_aA_353-p9.mjs}

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

package/node/esm/{CK44O-jioQqnJwi9.mjs → zOhwNujLCRmercSc.mjs}

@@ -1,5 +1,5 @@
 /**
- * @license @sheetxl/sdk - SDK - A high-performance, embeddable spreadsheet engine. - v0.7.6
+ * @license @sheetxl/sdk - SDK - A high-performance, embeddable spreadsheet engine. - v0.7.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.7.6",
+  "version": "0.7.8",
   "license": "SEE LICENSE IN <LICENSE>",
   "type": "module",
   "exports": {
@@ -43,20 +43,20 @@
     "automation"
   ],
   "dependencies": {
-    "@sheetxl/primitives": "^0.7.6",
-    "@sheetxl/scripting": "^0.7.6",
-    "@sheetxl/utils": "^0.7.6",
+    "@sheetxl/primitives": "^0.7.8",
+    "@sheetxl/scripting": "^0.7.8",
+    "@sheetxl/utils": "^0.7.8",
     "bahttext": "^2.3.0",
     "bessel": "^1.0.2",
-    "chalk": "^5.5.0",
+    "chalk": "^5.6.2",
     "chevrotain": "^11.0.3",
-    "configstore": "^7.0.0",
+    "configstore": "^7.1.0",
     "css-font-parser": "^2.0.0",
     "csstype": "^3.1.3",
     "fontkit": "^2.0.4",
     "jstat": "^1.9.6",
     "linebreak": "^1.1.0",
-    "lru-cache": "^11.0.2",
+    "lru-cache": "^11.2.2",
     "papaparse": "^5.5.3"
   },
   "devDependencies": {

package/types/index.d.ts

@@ -4585,6 +4585,7 @@ export declare interface ICellRange {
     setValues(values: ICellRange.ValuesUpdate, options?: ICellRange.SetValuesOptions): this;
     /**
      * Provides a convenient method for setting values with a range of calls.
+     *
      * @param update {@link ICellRange.Update}
      * @param options {@link ICellRange.UpdateCellsOptions}
      * @returns The current `ICellRange`.
@@ -4696,10 +4697,9 @@ export declare interface ICellRange {
     /**
      * Returns an iterator of ICells that match the results.
      *
-     * @param text The text to search for.
-     * @param options {@link FindOptions}
+     * @param options The text to search for or {@link FindOptions}
      */
-    find(text: string, options?: ICellRange.FindOptions): Iterator<ICell>;
+    find(options: string | ICellRange.FindOptions): Iterator<ICell>;
     /**
      * Sort the given range.
      *
@@ -4717,28 +4717,28 @@ export declare interface ICellRange {
      * By default the values will direction in whichever direction the selection shape is smaller.
      * For example a selection with a 5 column by 1 row will direction Down (rows).
      * Note - This will error if direction data will fall outsize of the max sheet size.
-     * @param orientation The direction in which to shift existing cells.
+     * @param options The orientation or The direction in which to shift existing cells.
      *   Defaults to the orientation where the range's dimension is smaller (e.g., shifts down if the range is wider than it is tall).
      *   See {@link ICellRange.getDefaultShiftOrientation} for details on the default behavior.
-     * @param options {@link ITransaction.OperationOptions}
+     *   See {@link ITransaction.OperationOptions}
      * @throws `Error` If the insertion would cause data to exceed the maximum sheet size.
      * @returns Current `ICellRange`.
      */
-    insert(orientation?: IRange.Orientation, options?: ITransaction.OperationOptions): this;
+    insert(options?: IRange.Orientation | ICellRange.InsertOptions): this;
     /**
      * Delete the cells within the range and shifts the remaining cells to fill the gap.
      *
-     * @param orientation The direction in which to shift the remaining cells.
-     *   Defaults to the orientation where the range's dimension is smaller (e.g., shifts left if the range is taller than it is wide).
+     * @param options The orientation or The direction in which to shift existing cells.
+     *   Defaults to the orientation where the range's dimension is smaller (e.g., shifts down if the range is wider than it is tall).
      *   See {@link ICellRange.getDefaultShiftOrientation} for details on the default behavior.
-     * @param options {@link ITransaction.OperationOptions}
+     *   See {@link ITransaction.OperationOptions}
      * @returns Current `ICellRange`.
      *
      * @remarks
      * This is different from clearing cells, which removes their content but doesn't affect the
      * overall sheet structure. Deleting cells results in a shift of the remaining data.
      */
-    delete(orientation?: IRange.Orientation, options?: ITransaction.OperationOptions): this;
+    delete(options?: IRange.Orientation | ICellRange.DeleteOptions): this;
     /**
      * Returns a snapshot of the current range's data and formatting suitable for copying or archiving.
      *
@@ -4969,6 +4969,13 @@ export declare interface ICellRange {
      * @returns An iterator that yields `[ICell.IteratorContext, Value]` tuples for each value within the range.
      */
     entries(options?: ICellRange.IteratorOptions): IterableIterator<ICellRange.Entry>;
+    /**
+     * Returns the values within the range, yielding each value.
+     *
+     * @param options Configuration options for the iterator, such as filtering or sorting.
+     * @returns An iterator that yields `[ICell.IteratorContext, Value]` tuples for each value within the range.
+     */
+    values(options?: ICellRange.IteratorOptions): IterableIterator<Scalar>;
     /**
      * Iterates over the cells within the range, applying the provided callback function to each cell.
      *
@@ -5025,6 +5032,28 @@ export declare namespace ICellRange {
      */
     export interface GetRangeOptions {
     }
+    /**
+     * Options for `ICellRange.delete`.
+     */
+    export interface InsertOptions extends ITransaction.OperationOptions {
+        /**
+         * The direction in which to shift existing cells.
+         *   Defaults to the orientation where the range's dimension is smaller (e.g., shifts down if the range is wider than it is tall).
+         *   See {@link ICellRange.getDefaultShiftOrientation}
+         */
+        orientation?: IRange.Orientation;
+    }
+    /**
+     * Options for `ICellRange.delete`.
+     */
+    export interface DeleteOptions extends ITransaction.OperationOptions {
+        /**
+         * The direction in which to shift existing cells.
+         *   Defaults to the orientation where the range's dimension is smaller (e.g., shifts down if the range is wider than it is tall).
+         *   See {@link ICellRange.getDefaultShiftOrientation}
+         */
+        orientation?: IRange.Orientation;
+    }
     /**
      * Shorthand for persisting.
      */
@@ -5490,6 +5519,12 @@ export declare namespace ICellRange {
      * Options for {@link ICellRange.find}.
      */
     export interface FindOptions extends FindCriteria {
+        /**
+         * The text to search for.
+         *
+         * @required
+         */
+        text: string;
         /**
          * Provides custom logic for matching values during the find operation.
          *
@@ -5631,6 +5666,15 @@ export declare namespace ICellRange {
      * Alias type for count results by type.
      */
     export type Counts = Partial<Record<ICell.Content, number>>;
+    export interface ScrollIntoViewOptions extends globalThis.ScrollIntoViewOptions {
+        /**
+         * If provided then will only scroll in the provided orientation.
+         *
+         * @remarks
+         * This is useful for only scrolling vertically or horizontally for insert/deleteCells
+         */
+        orientation?: IRange.Orientation;
+    }
     /**
      * Extends SelectionOptions to include the option to adjust the anchor cell.
      */
@@ -5644,6 +5688,17 @@ export declare namespace ICellRange {
          * If the current anchor is not within the current range this will be forced to `true`.
          */
         anchor?: boolean | Partial<IRange.CellCoords>;
+        /**
+         * If `true` or if a valid `ScrollIntoViewOptions` object is provided,
+         * the selected element will be scrolled into view.
+         *
+         * @remarks
+         * - If a `ScrollIntoViewOptions` object is provided, it will control the exact scrolling behavior.
+         * - If `false` (or omitted), the selected element will not be scrolled into view.
+         *
+         * @defaultValue false
+         */
+        scrollIntoView?: boolean | ICellRange.ScrollIntoViewOptions;
     }
     /**
      * Options for customizing how values are retrieved from a range and returned as a 2D array.
@@ -5874,7 +5929,7 @@ export declare interface ICellRanges {
     /**
      * {@inheritDoc ICellRange.find}
      */
-    find(findText: string, options?: ICellRange.FindOptions): Iterator<ICell>;
+    find(options: string | ICellRange.FindOptions): Iterator<ICell>;
     /**
      * Iterates over the values, yielding each values in the collection.
      *
@@ -5910,7 +5965,7 @@ export declare interface ICellRanges {
     /**
      * {@inheritDoc ICellRange.merge}
      */
-    merge(options?: ICellRange.MergeOptions | IRange.Orientations): this;
+    merge(options?: IRange.Orientations | ICellRange.MergeOptions): this;
     /**
      * {@inheritDoc ICellRange.unmerge}
      */
@@ -5918,11 +5973,11 @@ export declare interface ICellRanges {
     /**
      * {@inheritDoc ICellRange.insert}
      */
-    insert(orientation?: IRange.Orientation, options?: ITransaction.OperationOptions): this;
+    insert(options?: IRange.Orientation | ICellRange.InsertOptions): this;
     /**
      * {@inheritDoc ICellRange.delete}
      */
-    delete(orientation?: IRange.Orientation, options?: ITransaction.OperationOptions): this;
+    delete(options?: IRange.Orientation | ICellRange.DeleteOptions): this;
     /**
      * {@inheritDoc ICellRange.insertFrom}
      */
@@ -11692,7 +11747,7 @@ export declare interface ISheet extends ITransaction.ITransactional, IListener.I
      * @see
      * {@link ICellRange.find}
      */
-    find(text: string, options?: ICellRange.FindOptions): Iterator<ICell>;
+    find(options: string | ICellRange.FindOptions): Iterator<ICell>;
     /**
      * Enable and return an {@link IAutoFilter}.
      *
@@ -12087,7 +12142,7 @@ export declare namespace ISheet {
          * @remarks
          * This should only be handled by one consumer.
          */
-        onRequestScrollIntoView?(source: ISheet, options: ScrollToOptions): Promise<boolean>;
+        onRequestScrollIntoView?(source: ISheet, options: ISheet.ScrollToOptions): Promise<boolean>;
         /**
          * Request that the sheet become focused.
          * @returns A promise indicating if the focus was honored.
@@ -17070,7 +17125,7 @@ export declare namespace ITypes {
          *
          * @defaultValue false
          */
-        scrollIntoView?: globalThis.ScrollIntoViewOptions | boolean;
+        scrollIntoView?: boolean | globalThis.ScrollIntoViewOptions;
         /**
          * If `true`, the selected element will automatically receive focus after being selected.
          *
@@ -17175,8 +17230,7 @@ export declare interface IWorkbook extends ITransaction.ITransactional, IListene
     /**
      * Search the entire Workbook.
      *
-     * @param text The text to search for.
-     * @param options {@link ICellRange.FindOptions}
+     * @param options The text to search for or {@link ICellRange.FindOptions}
      *
      * @remarks
      * Searches all sheets.
@@ -17184,7 +17238,7 @@ export declare interface IWorkbook extends ITransaction.ITransactional, IListene
      * @see
      * {@link ICellRange.find}
      */
-    find(text: string, options?: ICellRange.FindOptions): Iterator<ICell>;
+    find(options: string | ICellRange.FindOptions): Iterator<ICell>;
     /**
      * Replace all items in the iterator
      *
@@ -17215,6 +17269,7 @@ export declare interface IWorkbook extends ITransaction.ITransactional, IListene
     findValidSheetName(sheetName: string): string;
     /**
      * Indicate if the current character is a valid character for a sheetName.
+     *
      * @param character The string to validate.
      */
     isValidSheetNameCharacter(character: string): boolean;
@@ -17258,6 +17313,7 @@ export declare interface IWorkbook extends ITransaction.ITransactional, IListene
     setTheme(theme: ITheme | null): ITheme;
     /**
      * Is date resolution 1904 instead of 1900 based.
+     *
      * @see
      * {@link https://support.microsoft.com/en-us/office/date-systems-in-excel-e7fe7167-48a9-4b96-bb53-5612a800b487}
      */
@@ -18761,7 +18817,7 @@ export declare class Sheet implements ISheet {
     /** {@inheritDoc ISheet.getSelectedCell} */
     getSelectedCell(): ICell;
     /** {@inheritDoc ISheet.find} */
-    find(text: string, options?: ICellRange.FindOptions): Iterator<ICell>;
+    find(options?: string | ICellRange.FindOptions): Iterator<ICell>;
     /* Excluded from this release type: _find */
     /** {@inheritDoc ISheet.isDate1904} */
     isDate1904(): boolean;
@@ -18777,6 +18833,7 @@ export declare class Sheet implements ISheet {
     /* Excluded from this release type: _selectSheet */
     /** {@inheritDoc ISheet.scrollTo} */
     scrollTo(coords: Partial<IRange.Coords>, options?: ISheet.ScrollToOptions): Promise<boolean>;
+    /* Excluded from this release type: _resolveSelectOptions */
     /* Excluded from this release type: _commitAndAutoSelect */
     /* Excluded from this release type: _autoSelect */
     /** {@inheritDoc ISheet.getSelection} */
@@ -18980,7 +19037,7 @@ declare class SheetHeader implements ISheetHeader {
     constructor(options: SheetHeader.ConstructorOptions);
     /** {@inheritDoc IListener.ISource.addListeners} */
     addListeners(listeners: ISheetHeader.IListeners, options?: IListener.Options): IListener.Remove;
-    protected _invalidSizes(): void;
+    protected _invalidSizes(force?: boolean): void;
     protected _onHeaderChange(): void;
     /** {@inheritDoc ISheetHeader.getSheet} */
     getSheet(): ISheet;
@@ -20890,7 +20947,7 @@ export declare class Workbook implements IWorkbook {
     /* Excluded from this release type: _validateDeleteSheet */
     /* Excluded from this release type: _findOffsetForId */
     /** {@inheritDoc IWorkbook.find} */
-    find(text: string, options?: ICellRange.FindOptions): Iterator<ICell>;
+    find(options: string | ICellRange.FindOptions): Iterator<ICell>;
     /** {@inheritDoc IWorkbook.replace} */
     replace(cells: Iterator<ICell>, replace: ICell.Update | ((original: ICell) => ICell.Update), options?: IWorkbook.ReplaceOptions): IWorkbook.ReplaceResults;
     /* Excluded from this release type: _nextSheetIndex */