@sheetxl/sdk 0.6.14 → 0.6.16

package/{browser/esm/DN_xnwatUgZObGQv.mjs → node/esm/ktpMAehXfPbHpZxp.mjs}

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

package/types/index.d.ts

@@ -776,6 +776,10 @@ declare namespace CellState {
     /* Excluded from this release type: IteratorOptions */
 }
 
+declare interface CellStyleUpdater {
+    (update: IStyle.Update, options?: IStyle.UpdateOptions, range?: IRange.Coords): IStyle;
+}
+
 declare type CellToString<C extends IRange.CellCoords = IRange.CellCoords> = (cell: C) => string;
 
 /**
@@ -2200,26 +2204,62 @@ export declare interface IBorder {
      * @returns The left border.
      */
     getLeft(): IBorder.IStroke;
+    /**
+     * Sets the left border.
+     *
+     * @param edge The border edge.
+     */
+    setLeft(edge: IBorder.IStroke | IProperties.ResolvableProperties<IBorder.StrokeProperties> | string | null, options?: IStyle.UpdateOptions): IBorder.IStroke;
     /**
      * @returns The top border.
      */
     getTop(): IBorder.IStroke;
+    /**
+     * Sets the top border.
+     *
+     * @param edge The border edge.
+     */
+    setTop(edge: IBorder.IStroke | IProperties.ResolvableProperties<IBorder.StrokeProperties> | string | null, options?: IStyle.UpdateOptions): IBorder.IStroke;
     /**
      * @returns The right border.
      */
     getRight(): IBorder.IStroke;
+    /**
+     * Sets the left border.
+     *
+     * @param edge The border edge.
+     */
+    setLeft(edge: IBorder.IStroke | IProperties.ResolvableProperties<IBorder.StrokeProperties> | string | null, options?: IStyle.UpdateOptions): IBorder.IStroke;
     /**
      * @returns The bottom border.
      */
     getBottom(): IBorder.IStroke;
+    /**
+     * Sets the bottom border.
+     *
+     * @param edge The border edge.
+     */
+    setBottom(edge: IBorder.IStroke | IProperties.ResolvableProperties<IBorder.StrokeProperties> | string | null, options?: IStyle.UpdateOptions): IBorder.IStroke;
     /**
      * @returns The diagonalUp border.
      */
     getDiagonalUp(): IBorder.IStroke;
+    /**
+     * Sets the diagonalUp border.
+     *
+     * @param edge The border edge.
+     */
+    setDiagonalUp(edge: IBorder.IStroke | IProperties.ResolvableProperties<IBorder.StrokeProperties> | string | null, options?: IStyle.UpdateOptions): IBorder.IStroke;
     /**
      * @returns The diagonalDown border.
      */
     getDiagonalDown(): IBorder.IStroke;
+    /**
+     * Sets the diagonalDown border.
+     *
+     * @param edge The border edge.
+     */
+    setDiagonalDown(edge: IBorder.IStroke | IProperties.ResolvableProperties<IBorder.StrokeProperties> | string | null, options?: IStyle.UpdateOptions): IBorder.IStroke;
     /**
      * If there are any borders that are not none.
      */
@@ -4271,30 +4311,6 @@ export declare namespace ICellProtection {
  * - Methods that transform the range's data into a different type use a `to` prefix (e.g., `toArray()`).
  */
 export declare interface ICellRange {
-    /**
-     * Retrieves an {@link IStyle.Updater} object for updating the styles of the range.
-     *
-     * Unlike {@link ICell.getStyle}, which provides a read-only view of a cell's style,
-     * this method returns an updater object that allows modifications to the styles
-     * of all cells in the range.
-     *
-     * @example
-     * ```typescript
-     * const updater = range.getStyleUpdater();
-     * updater.setColor("blue").setFont("Arial");
-     * ```
-     * @returns {IStyle.Updater} A style updater for the range.
-     *
-     * @remarks
-     * - **Deterministic Behavior**: All updates via the `IStyle.Updater` are applied
-     *   to the entire range, overriding any mixed styles with the specified values.
-     * - **Read-Only Alternatives**: To inspect styles across all cells in the range
-     *   without modifying them, use {@link ICellRange.entries} or {@link ICellRange.forEach} to iterate over immutable
-     *   {@link ICell}s.
-     * - **Immutable Philosophy**: This API aligns with the principle that `ICell`
-     *   objects are immutable, while `ICellRange` is the interface for mutable operations.
-     */
-    getStyleUpdater(): IStyle.Updater;
     /**
      * Return an array of coords for all merges.
      *
@@ -4331,6 +4347,14 @@ export declare interface ICellRange {
      * {@link ICellRange.getValues}
      */
     getValue(options?: ICellRange.GetValuesOptions): Scalar | JSScalar;
+    /**
+     * Returns the style for the range.
+     *
+     * @remarks
+     * When querying the style the values will always be for the top left. However the
+     * set values work for the entire range.
+     */
+    getStyle(): IStyle;
     /**
      * Returns the intersection of the current range and the specified range.
      *
@@ -5824,10 +5848,6 @@ export declare interface ICellRanges {
      * {@inheritDoc ICellRange.getSheet}
      */
     getSheet(): ISheet;
-    /**
-     * {@inheritDoc ICellRange.getStyleUpdater}
-     */
-    getStyleUpdater(): IStyle.Updater;
     /**
      * {@inheritDoc ICellRange.updateStyle}
      */
@@ -7906,7 +7926,14 @@ export declare interface IFill {
      * (for example color, backgroundColor)
      */
     toCSS(darkMode?: boolean, bounds?: Bounds): Properties;
+    /**
+     * Returns the fill as a JSON object.
+     */
     toJSON(): IFill.JSON;
+    /**
+     * For type checking.
+     */
+    readonly isIFill: true;
 }
 
 /**
@@ -8252,7 +8279,7 @@ export declare namespace IFill {
          * @see
          * {@link IFill.IGradient.getStops}
          */
-        stops?: GradientStopProperties<C>[];
+        stops?: (GradientStopProperties<C> | C)[];
         /**
          * @see
          * {@link IFill.IGradient.getGradientType}
@@ -13933,27 +13960,75 @@ export declare interface IStyle {
      * - {@link NumberFormat.Type}
      */
     getNumberFormat(): string;
+    /**
+     * @see {@link IStyle.getNumberFormat}
+     */
+    setNumberFormat(numFmt: string | null, options?: IStyle.UpdateOptions): this;
     /**
      * A boolean value indicating whether the text string in a cell should be prefixed by a single quote mark (e.g., 'text).
      * In these cases, the quote is not stored in the Shared Strings Part.
      */
     getQuotePrefix(): boolean;
     /**
-     * Returns the alignment for the style.
+     * @see {@link IStyle.getQuotePrefix}
      */
-    getAlignment(): ITextFrame.IAlignment;
+    setQuotePrefix(quotePrefix: boolean | null, options?: IStyle.UpdateOptions): this;
     /**
      * Returns the border style.
      */
     getBorder(): IBorder;
+    /**
+     * Sets the border style.
+     *
+     * This method allows updating borders using an {@link IBorder} or a shorthand property object.
+     *
+     * @param border The border object or a shorthand property object to apply. Pass `null` to clear.
+     * @param options Optional configuration for the update.
+     * @returns The `IBorder` object for further modifications.
+     */
+    setBorder(border: IBorder | IProperties.ResolvableProperties<IBorder.Properties> | string | null, options?: IStyle.UpdateOptions): IBorder;
     /**
      * Fill properties for the background.
      */
     getFill(): IFill.ISolid | IFill.IGradient | IFill.IPattern | IFill.INone;
+    /**
+     * Sets the fill style.
+     *
+     * This method allows updating fill using an {@link IFill} or a shorthand property object.
+     *
+     * @param fill The fill object or a shorthand property object to apply. Pass `null` to clear.
+     * @param options Optional configuration for the update.
+     * @returns The `IFill` object for further modifications.
+     */
+    setFill(fill: IFill | IProperties.ResolvableProperties<IFill.Properties> | string | null, options?: IStyle.UpdateOptions): IFill;
+    /**
+     * Returns the alignment for the style.
+     */
+    getAlignment(): ITextFrame.IAlignment;
+    /**
+     * Sets the alignment style.
+     *
+     * This method allows updating alignments using an {@link ITextFrame.IAlignment} or a shorthand property object.
+     *
+     * @param alignment The alignment object or a shorthand property object to apply. Pass `null` to clear.
+     * @param options Optional configuration for the update.
+     * @returns The `ITextFrame.IAlignment` object for further modifications.
+     */
+    setAlignment(alignment: ITextFrame.IAlignment | IProperties.ResolvableProperties<ITextFrame.IAlignment.Properties> | string | null, options?: IStyle.UpdateOptions): ITextFrame.IAlignment;
     /**
      * Returns the font for the style.
      */
     getFont(): IStyledFont;
+    /**
+     * Sets the font style.
+     *
+     * This method allows updating fill using an {@link IStyledFont} or a shorthand property object.
+     *
+     * @param font The font object or a shorthand property object to apply. Pass `null` to clear.
+     * @param options Optional configuration for the update.
+     * @returns The `IStyledFont` object for further modifications.
+     */
+    setFont(font: IStyledFont | IProperties.ResolvableProperties<IStyledFont.Properties> | string | null, options?: IStyle.UpdateOptions): IStyledFont;
     /**
      * Measure the text using the styling properties
      *
@@ -13998,6 +14073,10 @@ export declare interface IStyle {
      * Returns `true` if the CellStyle is the normal style
      */
     isNormal(): boolean;
+    /**
+     * Returns a JSON representation of the style.
+     */
+    toJSON(): IStyle.JSON | null;
     /**
      * For runtime type checking.
      */
@@ -14101,106 +14180,6 @@ export declare namespace IStyle {
          */
         autoFit?: boolean | ICellRange.AutoFitOptions;
     }
-    /**
-     * Provides an API for updating styles.
-     */
-    export interface Updater {
-        /**
-         * @see {@link IStyle.getNumberFormat}
-         */
-        setNumberFormat(numFmt: string | null, options?: IStyle.UpdateOptions): this;
-        /**
-         * Sets or removes the quote prefix for the range.
-         *
-         * The quote prefix ensures that values in cells are treated as text.
-         *
-         * @see {@link IStyle.getQuotePrefix}
-         */
-        setQuotePrefix(quotePrefix: boolean | null, options?: IStyle.UpdateOptions): this;
-        /**
-         * Sets the alignment style.
-         *
-         * This method allows updating alignments using an {@link ITextFrame.IAlignment} or a shorthand property object.
-         *
-         * @param alignment The alignment object or a shorthand property object to apply. Pass `null` to clear.
-         * @param options Optional configuration for the update.
-         * @returns The `ITextFrame.IAlignment.Updater` object for further modifications.
-         */
-        setAlignment(alignment: ITextFrame.IAlignment | IProperties.ResolvableProperties<ITextFrame.IAlignment.Properties> | string | null, options?: IStyle.UpdateOptions): ITextFrame.IAlignment;
-        /**
-         * Retrieves the alignment updater.
-         *
-         * @returns An `ITextFrame.IAlignment.Updater` object.
-         */
-        getAlignment(): ITextFrame.IAlignment;
-        /**
-         * Sets the border style.
-         *
-         * This method allows updating borders using an {@link IBorder} or a shorthand property object.
-         *
-         * @param border The border object or a shorthand property object to apply. Pass `null` to clear.
-         * @param options Optional configuration for the update.
-         * @returns The `IBorder.Updater` object for further modifications.
-         */
-        setBorder(border: IBorder | IProperties.ResolvableProperties<IBorder.Properties> | string | null, options?: IStyle.UpdateOptions): IBorder;
-        /**
-         * Retrieves the border updater.
-         *
-         * @returns An `IBorder.Updater` object.
-         */
-        getBorder(): IBorder;
-        /**
-         * Sets the fill style.
-         *
-         * This method allows updating fill using an {@link IFill} or a shorthand property object.
-         *
-         * @param fill The fill object or a shorthand property object to apply. Pass `null` to clear.
-         * @param options Optional configuration for the update.
-         * @returns The `IFill.Updater` object for further modifications.
-         */
-        setFill(fill: IFill | IProperties.ResolvableProperties<IFill.Properties> | string | null, options?: IStyle.UpdateOptions): IFill;
-        /**
-         * Retrieves the fill updater.
-         *
-         * @returns An `IFIll.Updater` object.
-         */
-        getFill(): IFill;
-        /**
-         * Sets the font style.
-         *
-         * This method allows updating fill using an {@link IStyledFont} or a shorthand property object.
-         *
-         * @param font The font object or a shorthand property object to apply. Pass `null` to clear.
-         * @param options Optional configuration for the update.
-         * @returns The `IStyledFont.Updater` object for further modifications.
-         */
-        setFont(font: IFill | IProperties.ResolvableProperties<IFill.Properties> | string | null, options?: IStyle.UpdateOptions): IFill;
-        /**
-         * Retrieves the IStyledFont updater.
-         *
-         * @returns An `IStyledFont.Updater` object.
-         */
-        getFont(): IStyledFont;
-        /**
-         * Updates multiple style properties at once.
-         *
-         * This method is the most versatile way to update styles, allowing bulk updates with nested properties,
-         * shorthand strings, or function callbacks.
-         *
-         * @example
-         * ```typescript
-         * updater.update({
-         *     font: { bold: true, color: "blue" },
-         *     fill: { pattern: "solid", color: "yellow" }
-         * });
-         * ```
-         *
-         * @param style An object describing the style updates.
-         * @param options Optional configuration for the update.
-         * @returns The current `Updater` instance for chaining.
-         */
-        update(style: IStyle.Update, options?: IStyle.UpdateOptions): this;
-    }
     export interface JSON extends Properties<string> {
     }
     /**
@@ -18627,7 +18606,7 @@ export declare class Sheet implements ISheet {
     /* Excluded from this release type: _updateState */
     /* Excluded from this release type: _addEvent */
     /* Excluded from this release type: _getScalar */
-    /* Excluded from this release type: getStyleUpdater */
+    /* Excluded from this release type: _getStyle */
     /* Excluded from this release type: _initState */
     /* Excluded from this release type: _clearState */
     /* Excluded from this release type: _createTableEntry */
@@ -18673,6 +18652,7 @@ declare interface SheetCellOptions {
     calcGraph(): ICalcGraph;
     colHeaders: ISheetHeader;
     getRange(coords: IRange.Coords): ICellRange;
+    styleUpdater: CellStyleUpdater;
     opener(url: string, options: ICellRange.SelectOptions, target?: string, features?: string): Promise<boolean>;
 }