@sheetxl/sdk 0.7.4 → 0.7.6

package/node/esm/{BSXcEX1dCLWEqbk_.mjs → jJ7v5a6zu09dIALd.mjs}

@@ -1,5 +1,5 @@
 /**
- * @license @sheetxl/sdk - SDK - A high-performance, embeddable spreadsheet engine. - v0.7.4
+ * @license @sheetxl/sdk - SDK - A high-performance, embeddable spreadsheet engine. - v0.7.6
  *
  * (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.4",
+  "version": "0.7.6",
   "license": "SEE LICENSE IN <LICENSE>",
   "type": "module",
   "exports": {
@@ -21,19 +21,31 @@
     "node": ">=20 <21 || >=22"
   },
   "engineStrict": true,
+  "homepage": "https://sheetxl.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sheetxl/sheetxl.git"
+  },
+  "bugs": {
+    "url": "https://github.com/sheetxl/sheetxl/issues"
+  },
   "keywords": [
     "sheetxl",
     "spreadsheet",
-    "api",
+    "javascript",
     "typescript",
+    "data grid",
+    "excel",
+    "xlsx",
+    "api",
     "sdk",
     "headless",
     "automation"
   ],
   "dependencies": {
-    "@sheetxl/primitives": "^0.7.4",
-    "@sheetxl/scripting": "^0.7.4",
-    "@sheetxl/utils": "^0.7.4",
+    "@sheetxl/primitives": "^0.7.6",
+    "@sheetxl/scripting": "^0.7.6",
+    "@sheetxl/utils": "^0.7.6",
     "bahttext": "^2.3.0",
     "bessel": "^1.0.2",
     "chalk": "^5.5.0",

package/types/index.d.ts

@@ -5,7 +5,6 @@ import { CompiledModule } from '@sheetxl/scripting';
 import { CompileOptions } from '@sheetxl/scripting';
 import { CompileResults } from '@sheetxl/scripting';
 import { CoordUtils } from '@sheetxl/utils';
-import { Dimensions } from '@sheetxl/utils';
 import { Direction } from '@sheetxl/utils';
 import { EditMode } from '@sheetxl/utils';
 import { FetchArgs } from '@sheetxl/utils';
@@ -29,6 +28,7 @@ import { RunCoords } from '@sheetxl/utils';
 import { Scalar } from '@sheetxl/primitives';
 import { ScalarType } from '@sheetxl/primitives';
 import { SelectionCoords } from '@sheetxl/utils';
+import { Size } from '@sheetxl/utils';
 import { TextAlign } from 'csstype';
 import { TopLeft } from '@sheetxl/utils';
 import { UndoManager } from '@sheetxl/utils';
@@ -805,7 +805,7 @@ declare const clampString: (str: string, maxLength?: number) => string;
  * Takes an an inner un-rotated dimension and an outer un-rotated dimension and then will return
  * an un-rotated rectangle that if rotated will fit inside the outer rectangle.
  */
-declare const clipToOuterRect: (dimInner: Dimensions, dimOuter: Dimensions, rotation?: number) => Dimensions;
+declare const clipToOuterRect: (dimInner: Size, dimOuter: Size, rotation?: number) => Size;
 
 /**
  * Capabilities for working with {@link IColor | colors}.
@@ -1321,7 +1321,7 @@ declare const getFileNameExtension: (path: string) => string;
 declare function getFontList(): readonly FontHandle[];
 
 declare interface GetRangeEntriesOptions<T = any, E = any> {
-    excludeHidden?: boolean | IRange.Orientation;
+    ignoreHidden?: boolean | IRange.Orientation;
     fullyContained?: boolean;
     onEntry?: (value: E, entry: ISpatialMap.Entry<T>) => T | void;
     noCache?: boolean;
@@ -3302,12 +3302,10 @@ export declare interface ICell {
     /**
      * Returns the cell's value as a formatted string, applying any number formatting.
      *
-     * @param numFmt A custom number format to apply (optional).
-     *
      * @see
      * {@link toTextUnformatted}
      */
-    toText(numFmt?: string): string;
+    toText(): string;
     /**
      * Returns the cell's value as an unformatted string.
      *
@@ -3354,7 +3352,7 @@ export declare interface ICell {
      * Returns `null` if this cell should be ignored for sizing purposes.
      * Either dimension can also be `null`, indicating that the specific direction should not be used.
      */
-    getBestFit(colWidth?: number, minContent?: boolean): Readonly<Partial<Dimensions>> | null;
+    getBestFit(colWidth?: number, minContent?: boolean): Readonly<Partial<Size>> | null;
     /**
      * Returns protection information.
      */
@@ -3369,7 +3367,7 @@ export declare interface ICell {
     /**
      * Returns the span dimensions for merged cells.
      */
-    getSpans(): Readonly<Dimensions>;
+    getSpans(): Readonly<Size>;
     /**
      * Returns `true` if the cell is the top-left cell of a merged region, or if it is not part of a merged region.
      */
@@ -4134,7 +4132,7 @@ export declare namespace ICellHeaderRange {
          * optionally a header orientation for skipping case be passed in.
          * An example of this is for sorting where the sort direction (row) skips hidden rows but the column direction does not.
          */
-        excludeHidden?: boolean;
+        ignoreHidden?: boolean;
     }
     /**
      * Context for Iterators to provide access to the `IRange.CellCoords`, the `ICellHeader`, and additional operators.
@@ -4357,7 +4355,7 @@ export declare interface ICellRange {
      * Returns the value for the top left `Scalar`.
      *
      * @remarks
-     * The `excludeHidden` option is ignored.
+     * The `ignoreHidden` option is ignored.
      *
      * @see
      * {@link ICellRange.getValues}
@@ -4567,6 +4565,10 @@ export declare interface ICellRange {
      * * Setting {@link ICellRange.GetValuesOptions.asJSDate} to `true` will add make slower.
      */
     getValues(options?: ICellRange.GetValuesOptions): Scalar[][];
+    /**
+     * Returns the range value as a string.
+     */
+    toText(options?: ICellRange.ToTextOptions): string;
     /**
      * Set the value(s) of one or more cells within a range.
      *
@@ -5227,10 +5229,16 @@ export declare namespace ICellRange {
          * - Optionally, you can specify a `IRange.Orientation` to indicate the header orientation for skipping cases.
          *   For example, in sorting, you might want to skip hidden rows but not hidden columns.
          */
-        excludeHidden?: boolean | IRange.Orientation;
+        ignoreHidden?: boolean | IRange.Orientation;
         /** {@inheritDoc ICellRange.IteratorOptions.includeMergeOverflow} */
         includeMergeOverflow?: boolean;
     }
+    /**
+     * Options for {@link ICellRange.toText}.
+     */
+    export interface ToTextOptions extends ICellRange.GetValuesOptions {
+        ignoreFormatting?: boolean;
+    }
     /**
      * Options for {@link ICellRange.autoFit}.
      */
@@ -5669,7 +5677,7 @@ export declare namespace ICellRange {
          * Optionally a header orientation for skipping case be passed in.
          * An example of this is for sorting where the sort direction (row) skips hidden rows but the column direction does not.
          */
-        excludeHidden?: boolean | IRange.Orientation;
+        ignoreHidden?: boolean | IRange.Orientation;
         /**
          * If set to true the only the raw values will be visited.
          *
@@ -5678,7 +5686,7 @@ export declare namespace ICellRange {
          * @remarks
          * This allows for much faster reading when only the value is needed.
          */
-        excludeCellDetails?: boolean;
+        ignoreCellDetails?: boolean;
         /**
          * Includes any merge overflow in first element visited.
          *
@@ -7901,7 +7909,7 @@ export declare namespace IConditionalFormatCollection {
          *
          * @defaultValue false
          */
-        excludeHidden?: boolean;
+        ignoreHidden?: boolean;
         /**
          * Only return items that are completely contained with the search bounds.
          *
@@ -10094,7 +10102,7 @@ export declare namespace IMovableCollection {
          * Indicate if items that are in hidden headers or marked as hidden should be returned.
          * @defaultValue false
          */
-        excludeHidden?: boolean;
+        ignoreHidden?: boolean;
         /**
          * The type to search for. If not provided all items will be returned.
          */
@@ -10660,7 +10668,7 @@ export declare namespace IPicture {
         /**
          * The size of the image without any constraints. This info is determined by the file.
          */
-        getNaturalDimensions(): Dimensions;
+        getNaturalSize(): Size;
         /**
          * As a url that can be attached to the dom.
          */
@@ -11888,9 +11896,9 @@ export declare interface ISheet extends ITransaction.ITransactional, IListener.I
     /**
      * Returns a JSON representation of the sheet.
      *
-     * @param excludeData If `true` only meta data about the sheet will be saved.
+     * @param ignoreData If `true` only meta data about the sheet will be saved.
      */
-    toJSON(excludeData?: boolean): Promise<ISheet.JSON>;
+    toJSON(ignoreData?: boolean): Promise<ISheet.JSON>;
     /**
      * Free all resources associated with the sheet.
      *
@@ -13206,7 +13214,7 @@ export declare namespace ISort {
     export interface DefaultSortCriteria {
         /**
          * The cords that will be sorted.
-         * This may exclude the header.
+         * This may ignore the header.
          */
         coords: IRange.Coords;
         /**
@@ -14139,7 +14147,7 @@ export declare interface IStyle {
     /**
      * Returns the best fit size assuming no content.
      */
-    getBestFit(): Partial<Dimensions> | null;
+    getBestFit(): Partial<Size> | null;
     /**
      * Returns insets used for content. This does not taking into account indent because
      * this is alignment and type specific.
@@ -14884,7 +14892,7 @@ export declare interface IStyledFont {
      * Additionally due to the nature of css having different properties for the same logic value
      * (for example color, backgroundColor)
      */
-    toCSS(darkMode?: boolean, zoom?: number, excludeNormal?: boolean): Properties;
+    toCSS(darkMode?: boolean, zoom?: number, ignoreNormal?: boolean): Properties;
     /**
      * Serializes to a JSON object.
      */
@@ -15406,7 +15414,7 @@ export declare namespace ITableCollection {
          *
          * @defaultValue false
          */
-        excludeHidden?: boolean;
+        ignoreHidden?: boolean;
         /**
          * Only return items that are completely contained with the filter bounds.
          *
@@ -15968,7 +15976,7 @@ export declare interface ITextFrame {
      *
      * @param dimensions will cause the text to wrap. If bounds are not specified or only a dimension then it will not wrap.
      */
-    layout(dimensions?: Partial<Dimensions>): ITextFrame;
+    layout(dimensions?: Partial<Size>): ITextFrame;
     /**
      * This is the bound of a textfield include any whitespace
      */
@@ -17291,9 +17299,9 @@ export declare interface IWorkbook extends ITransaction.ITransactional, IListene
     /**
      * Serialize the workbook to a JSON.
      *
-     * @param excludeData If `true` only meta data about the workbook will be saved.
+     * @param ignoreData If `true` only meta data about the workbook will be saved.
      */
-    toJSON(excludeData?: boolean): Promise<IWorkbook.JSON>;
+    toJSON(ignoreData?: boolean): Promise<IWorkbook.JSON>;
     /**
      * Returns any custom workbook options that are provided in constructor.
      */
@@ -18397,7 +18405,7 @@ declare namespace RangeState {
     interface IteratorOptions extends OverlappingRange.IteratorOptions {
         includeRangeTypes: boolean | SearchTypes;
         bounds?: IRange.Coords;
-        excludeHidden?: boolean | IRange.Orientation;
+        ignoreHidden?: boolean | IRange.Orientation;
         includeMergeOverflow?: boolean;
     }
     interface Entry {
@@ -18626,7 +18634,7 @@ export declare class Sheet implements ISheet {
     };
     protected _lastGetRangeRead: Record<string, {
         ranges: readonly IRange.Coords[];
-        excludeHidden: boolean | IRange.Orientation;
+        ignoreHidden: boolean | IRange.Orientation;
         results: any[];
     }>;
     protected _lastUsedCoordsRead: {
@@ -18669,7 +18677,7 @@ export declare class Sheet implements ISheet {
     protected _closed: boolean;
     protected _defaultColWidthCache: number;
     protected _defaultRowHeightCache: number;
-    protected _defaultFontBoundsCache: Readonly<Dimensions>;
+    protected _defaultFontBoundsCache: Readonly<Size>;
     constructor(options?: ISheet.ConstructorOptions);
     /* Excluded from this release type: _createRange */
     /* Excluded from this release type: _createRanges */
@@ -18786,7 +18794,7 @@ export declare class Sheet implements ISheet {
     /** {@inheritDoc ISheet.getColumnHeaders} */
     getColumnHeaders(): ISheetHeader;
     /** {@inheritDoc ISheet.toJSON} */
-    toJSON(excludeData?: boolean): Promise<ISheet.JSON>;
+    toJSON(ignoreData?: boolean): Promise<ISheet.JSON>;
     /** {@inheritDoc ISheet.getStyles} */
     getStyles(): IStyleCollection;
     /** {@inheritDoc ISheet.getResources} */
@@ -20927,7 +20935,7 @@ export declare class Workbook implements IWorkbook {
     /* Excluded from this release type: _fromJSON */
     /* Excluded from this release type: _createScripts */
     /** {@inheritDoc IWorkbook.toJSON} */
-    toJSON(excludeData?: boolean): Promise<IWorkbook.JSON>;
+    toJSON(ignoreData?: boolean): Promise<IWorkbook.JSON>;
     /** {@inheritDoc IWorkbook.isClosed} */
     isClosed(): boolean;
     /** {@inheritDoc IWorkbook.close} */