@sheetxl/sdk 0.6.16 → 0.6.18

package/{browser/esm/DL8H1TIz4eYTJlVj.mjs → node/esm/lz0-1WdmlC0gLtak.mjs}

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

package/types/index.d.ts

@@ -2155,7 +2155,19 @@ export declare namespace IBorder {
     }
     export interface IStroke {
         getStyle(): StrokeStyle;
+        /**
+         * Sets the stroke style.
+         *
+         * @param style The stroke style.
+         */
+        setStyle(style: IBorder.StrokeStyle | string | null, options?: IStyle.UpdateOptions): IBorder.IStroke;
         getColor(): IColor;
+        /**
+         * Sets the stroke color.
+         *
+         * @param color The stroke color.
+         */
+        setColor(color: IColor.Serializable | null, options?: IStyle.UpdateOptions): IBorder.IStroke;
         /**
          * Returns all the set properties and their values for the border.
          */
@@ -2188,6 +2200,10 @@ export declare namespace IBorder {
      * Modifiers describe a partial list of properties that can be set with values or shorthand strings.
      */
     export type Modifiers = Partial<IBorder.Properties>;
+    /**
+     * Options for updating a border.
+     */
+    export type Update = IBorder | Modifiers | string | null;
     /**
      * JSON representation of a border.
      */
@@ -2209,7 +2225,7 @@ export declare interface IBorder {
      *
      * @param edge The border edge.
      */
-    setLeft(edge: IBorder.IStroke | IProperties.ResolvableProperties<IBorder.StrokeProperties> | string | null, options?: IStyle.UpdateOptions): IBorder.IStroke;
+    setLeft(edge: IBorder.IStroke | IProperties.ResolvableProperties<IBorder.Properties> | string | null, options?: IStyle.UpdateOptions): IBorder;
     /**
      * @returns The top border.
      */
@@ -2219,17 +2235,17 @@ export declare interface IBorder {
      *
      * @param edge The border edge.
      */
-    setTop(edge: IBorder.IStroke | IProperties.ResolvableProperties<IBorder.StrokeProperties> | string | null, options?: IStyle.UpdateOptions): IBorder.IStroke;
+    setTop(edge: IBorder.IStroke | IProperties.ResolvableProperties<IBorder.Properties> | string | null, options?: IStyle.UpdateOptions): IBorder;
     /**
      * @returns The right border.
      */
     getRight(): IBorder.IStroke;
     /**
-     * Sets the left border.
+     * Sets the right border.
      *
      * @param edge The border edge.
      */
-    setLeft(edge: IBorder.IStroke | IProperties.ResolvableProperties<IBorder.StrokeProperties> | string | null, options?: IStyle.UpdateOptions): IBorder.IStroke;
+    setRight(edge: IBorder.IStroke | IProperties.ResolvableProperties<IBorder.Properties> | string | null, options?: IStyle.UpdateOptions): IBorder;
     /**
      * @returns The bottom border.
      */
@@ -2239,7 +2255,7 @@ export declare interface IBorder {
      *
      * @param edge The border edge.
      */
-    setBottom(edge: IBorder.IStroke | IProperties.ResolvableProperties<IBorder.StrokeProperties> | string | null, options?: IStyle.UpdateOptions): IBorder.IStroke;
+    setBottom(edge: IBorder.IStroke | IProperties.ResolvableProperties<IBorder.Properties> | string | null, options?: IStyle.UpdateOptions): IBorder;
     /**
      * @returns The diagonalUp border.
      */
@@ -2249,7 +2265,7 @@ export declare interface IBorder {
      *
      * @param edge The border edge.
      */
-    setDiagonalUp(edge: IBorder.IStroke | IProperties.ResolvableProperties<IBorder.StrokeProperties> | string | null, options?: IStyle.UpdateOptions): IBorder.IStroke;
+    setDiagonalUp(edge: IBorder.IStroke | IProperties.ResolvableProperties<IBorder.Properties> | string | null, options?: IStyle.UpdateOptions): IBorder;
     /**
      * @returns The diagonalDown border.
      */
@@ -2259,7 +2275,7 @@ export declare interface IBorder {
      *
      * @param edge The border edge.
      */
-    setDiagonalDown(edge: IBorder.IStroke | IProperties.ResolvableProperties<IBorder.StrokeProperties> | string | null, options?: IStyle.UpdateOptions): IBorder.IStroke;
+    setDiagonalDown(edge: IBorder.IStroke | IProperties.ResolvableProperties<IBorder.StrokeProperties> | string | null, options?: IStyle.UpdateOptions): IBorder;
     /**
      * If there are any borders that are not none.
      */
@@ -4348,11 +4364,10 @@ export declare interface ICellRange {
      */
     getValue(options?: ICellRange.GetValuesOptions): Scalar | JSScalar;
     /**
-     * Returns the style for the range.
+     * Returns the style for the ranges.
      *
-     * @remarks
-     * When querying the style the values will always be for the top left. However the
-     * set values work for the entire range.
+     * @see
+     * {@link ICellRange.getStyle}
      */
     getStyle(): IStyle;
     /**
@@ -4676,14 +4691,6 @@ export declare interface ICellRange {
      * @returns Current `ICellRange`.
      */
     unmerge(options?: ITransaction.OperationOptions): this;
-    /**
-     * Update the style for the range(s).
-     *
-     * @param style {@link IStyle.Update}
-     * @param options {@link IStyle.UpdateOptions}
-     * @returns Current `ICellRange`.
-     */
-    updateStyle(style: IStyle.Update, options?: IStyle.UpdateOptions): this;
     /**
      * Returns an iterator of ICells that match the results.
      *
@@ -5849,9 +5856,13 @@ export declare interface ICellRanges {
      */
     getSheet(): ISheet;
     /**
-     * {@inheritDoc ICellRange.updateStyle}
+     * 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.
      */
-    updateStyle(style: IStyle.Update, options?: IStyle.UpdateOptions): this;
+    getStyle(): IStyle;
     /**
      * {@inheritDoc ICellRange.find}
      */
@@ -8150,6 +8161,14 @@ export declare namespace IFill {
          */
         type: IFill.Type;
     }
+    /**
+     * Modifiers describe a partial list of properties that can be set with values or shorthand strings.
+     */
+    export type Modifiers = Partial<IFill.Properties>;
+    /**
+     * Options for updating a fill.
+     */
+    export type Update = IFill | Modifiers | string | null;
     /**
      * A JSON representation useful for persistence.
      */
@@ -8186,6 +8205,12 @@ export declare namespace IFill {
          * Returns the color of the fill.
          */
         getColor(): IColor;
+        /**
+         * Sets the stroke color.
+         *
+         * @param color The stroke color.
+         */
+        setColor(color: IColor.Serializable | null, options?: IStyle.UpdateOptions): IFill.ISolid;
     }
     export interface SolidProperties<C = IColor.Serializable> extends IFill.Properties {
         /**
@@ -8311,19 +8336,46 @@ export declare namespace IFill {
          * * This must be at least two stops.
          */
         getStops(): IGradientStop[];
+        /**
+         * Sets the gradient stops.
+         *
+         * @param stops The gradient stops.
+         */
+        setStops(stops: (IGradientStop | IColor.Serializable | null)[], options?: IStyle.UpdateOptions): IFill.IGradient;
         /**
          * The type of gradient.
          * @defaultValue GradientType.Linear
          */
         getGradientType(): IFill.GradientType;
+        /**
+         * Sets the gradient type.
+         *
+         * @param type The gradient type.
+         */
+        setGradientType(type: IFill.GradientType | null, options?: IStyle.UpdateOptions): IFill.IGradient;
         /**
          * The angle of the gradient in degrees if gradient type is linear.
          */
         getAngle(): number;
+        /**
+         * Sets the rotation
+         *
+         * @param angle The angle
+         */
+        setAngle(angle: number | null, options?: IStyle.UpdateOptions): IFill.IGradient;
         /**
          * Used for path and circular gradients.
          */
         getFillTo(): Rectangle;
+        /**
+         * Sets the fill area for the gradient.
+         *
+         * @param fillTo The fill area.
+         */
+        setFillTo(fillTo: Rectangle | null, options?: IStyle.UpdateOptions): IFill.IGradient;
+        /**
+         * Converts the gradient fill to a JSON representation.
+         */
         toJSON(): GradientJSON;
     }
     export interface GradientJSON extends GradientProperties<string> {
@@ -8340,14 +8392,35 @@ export declare namespace IFill {
          * The foreground color for the pattern.
          */
         getForeground(): IColor;
+        /**
+         * Sets the foreground color.
+         *
+         * @param color The foreground color.
+         */
+        setForeground(color: IColor.Serializable | null, options?: IStyle.UpdateOptions): IFill.IPattern;
         /**
          * The background color for the pattern.
          */
         getBackground(): IColor;
+        /**
+         * Sets the background color.
+         *
+         * @param color The background color.
+         */
+        setBackground(color: IColor.Serializable | null, options?: IStyle.UpdateOptions): IFill.IPattern;
         /**
          * The type of pattern used.
          */
         getPatternType(): IFill.BuiltInSheetPattern;
+        /**
+         * Sets the pattern type.
+         *
+         * @param type The pattern type.
+         */
+        setPatternType(type: IFill.BuiltInSheetPattern | null, options?: IStyle.UpdateOptions): IFill.IPattern;
+        /**
+         * Converts the pattern fill to a JSON representation.
+         */
         toJSON(): PatternJSON;
     }
     export interface PatternProperties<C = IColor.Serializable> extends IFill.Properties {
@@ -13957,13 +14030,13 @@ export declare interface IStyle {
      *
      * @remarks
      * * If a number provided the builtIn numFmtId as defined in OOXML will be used.
-     * - {@link NumberFormat.Type}
+     * * {@link NumberFormat.Type}
      */
     getNumberFormat(): string;
     /**
      * @see {@link IStyle.getNumberFormat}
      */
-    setNumberFormat(numFmt: string | null, options?: IStyle.UpdateOptions): this;
+    setNumberFormat(numFmt: string | null, options?: IStyle.UpdateOptions): IStyle;
     /**
      * 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.
@@ -13972,7 +14045,7 @@ export declare interface IStyle {
     /**
      * @see {@link IStyle.getQuotePrefix}
      */
-    setQuotePrefix(quotePrefix: boolean | null, options?: IStyle.UpdateOptions): this;
+    setQuotePrefix(quotePrefix: boolean | null, options?: IStyle.UpdateOptions): IStyle;
     /**
      * Returns the border style.
      */
@@ -13986,7 +14059,7 @@ export declare interface IStyle {
      * @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;
+    setBorder(border: IBorder.Modifiers, options?: IStyle.UpdateOptions): IStyle;
     /**
      * Fill properties for the background.
      */
@@ -14000,7 +14073,7 @@ export declare interface IStyle {
      * @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;
+    setFill(fill: IFill.Update, options?: IStyle.UpdateOptions): IStyle;
     /**
      * Returns the alignment for the style.
      */
@@ -14014,7 +14087,7 @@ export declare interface IStyle {
      * @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;
+    setAlignment(alignment: ITextFrame.Update, options?: IStyle.UpdateOptions): IStyle;
     /**
      * Returns the font for the style.
      */
@@ -14028,7 +14101,25 @@ export declare interface IStyle {
      * @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;
+    setFont(font: IStyledFont.Update, options?: IStyle.UpdateOptions): IStyle;
+    /**
+     * Returns an instance of the named style that this is derived from.
+     */
+    getNamed(): IStyle.INamed;
+    /**
+     * Sets the named style that this is derived from.
+     *
+     * @param named The named style to set.
+     */
+    setNamed(named: string | IStyle.INamed | null, options?: IStyle.UpdateOptions): IStyle;
+    /**
+     * Update many style properties at once.
+     *
+     * @param update {@link IStyle.Update}
+     * @param options {@link IStyle.UpdateOptions}
+     * @returns The `IStyle` for further modifications.
+     */
+    update(update: IStyle.Update, options?: IStyle.UpdateOptions): IStyle;
     /**
      * Measure the text using the styling properties
      *
@@ -14065,10 +14156,6 @@ export declare interface IStyle {
      * @param update Adjustments to the style.
      */
     createTemporaryStyle(update: IStyle.Update): IStyle;
-    /**
-     * Returns an instance of the named style that this is derived from.
-     */
-    getNamed(): IStyle.INamed;
     /**
      * Returns `true` if the CellStyle is the normal style
      */
@@ -14643,23 +14730,43 @@ export declare interface IStyledFont {
      * marshalled into their correct property.
      */
     getFamily(): string;
+    /**
+     * @see {@link IStyledFont.getFamily}
+     */
+    setFamily(family: string | null, options?: IStyle.UpdateOptions): IStyledFont;
     /**
      * A list of fonts and their fallbacks. These can also be provided in the fontFamily attribute but will
      * be normalized to here.
      */
     getFallbacks(): string[];
+    /**
+     * @see {@link IStyledFont.setFallbacks}
+     */
+    setFallbacks(fallbacks: string[] | null, options?: IStyle.UpdateOptions): IStyledFont;
     /**
      * Font size is either a number in points or a string that can be converted such as '14px', '1.5em'.
      */
     getSize(): number;
+    /**
+     * @see {@link IStyledFont.setSize}
+     */
+    setSize(size: number | null, options?: IStyle.UpdateOptions): IStyledFont;
     /**
      * The weight of the characters.
      */
     getWeight(): number;
+    /**
+     * @see {@link IStyledFont.setWeight}
+     */
+    setWeight(weight: number | null, options?: IStyle.UpdateOptions): IStyledFont;
     /**
      * @default `IFont.Style.Normal`
      */
     getStyle(): IFont.Style;
+    /**
+     * @see {@link IStyledFont.setStyle}
+     */
+    setStyle(style: IFont.Style | null, options?: IStyle.UpdateOptions): IStyledFont;
     /**
      * The text color.
      *
@@ -14667,25 +14774,45 @@ export declare interface IStyledFont {
      * Currently only solid fill is supported but this will be expanded to allow all fill types similar to DrawML.
      */
     getFill(): IColor;
+    /**
+     * @see {@link IStyledFont.setFill}
+     */
+    setFill(fill: IColor | null, options?: IStyle.UpdateOptions): IStyledFont;
     /**
      * Adds or removes additional spacing between the characters.
      */
     getLetterSpacing(): number;
+    /**
+     * @see {@link IStyledFont.setLetterSpacing}
+     */
+    setLetterSpacing(letterSpacing: number | null, options?: IStyle.UpdateOptions): IStyledFont;
     /**
      * Sets the underline style. If true defaults to single. If false or null defaults to none.
      *
      * @default `IFont.UnderlineStyle.None`
      */
     getUnderline(): IFont.UnderlineStyle;
+    /**
+     * @see {@link IStyledFont.setUnderline}
+     */
+    setUnderline(underline: IFont.UnderlineStyle | null, options?: IStyle.UpdateOptions): IStyledFont;
     /**
      * The effect draws the text with a line through it.
      */
     getStrike(): boolean;
+    /**
+     * @see {@link IStyledFont.setStrike}
+     */
+    setStrike(strike: boolean | null, options?: IStyle.UpdateOptions): IStyledFont;
     /**
      * Defines the font scheme to use.
      * @default `IFont.Scheme.Minor`
      */
     getScheme(): IFont.Scheme;
+    /**
+     * @see {@link IStyledFont.setScheme}
+     */
+    setScheme(scheme: IFont.Scheme | null, options?: IStyle.UpdateOptions): IStyledFont;
     /**
      * Returns the vertical alignment of the text within a text line.
      *
@@ -14693,6 +14820,10 @@ export declare interface IStyledFont {
      * If the IFont.VerticalAlignment is superscript or subscript then the font size should also render smaller.
      */
     getVerticalAlignment(): IFont.VerticalAlignment;
+    /**
+     * @see {@link IStyledFont.setVerticalAlignment}
+     */
+    setVerticalAlignment(verticalAlignment: IFont.VerticalAlignment | null, options?: IStyle.UpdateOptions): IStyledFont;
     /**
      * The effect draws a shadow around the text.
      *
@@ -14700,6 +14831,10 @@ export declare interface IStyledFont {
      * Not rendered by Excel or SheetXL.
      */
     getShadow(): boolean;
+    /**
+     * @see {@link IStyledFont.setShadow}
+     */
+    setShadow(shadow: boolean | null, options?: IStyle.UpdateOptions): IStyledFont;
     /**
      * The effect draws the text as an outline.
      *
@@ -14707,6 +14842,10 @@ export declare interface IStyledFont {
      * Not rendered by Excel or SheetXL.
      */
     getOutline(): boolean;
+    /**
+     * @see {@link IStyledFont.setOutline}
+     */
+    setOutline(outline: boolean | null, options?: IStyle.UpdateOptions): IStyledFont;
     /**
      * The effect extends or stretches out the text.
      *
@@ -14714,6 +14853,10 @@ export declare interface IStyledFont {
      * Not rendered by Excel or SheetXL.
      */
     getExtend(): boolean;
+    /**
+     * @see {@link IStyledFont.setExtend}
+     */
+    setExtend(extend: boolean | null, options?: IStyle.UpdateOptions): IStyledFont;
     /**
      * Returns `true` if the font is either a superscript or a subscript.
      */
@@ -14779,6 +14922,14 @@ export declare namespace IStyledFont {
         outline?: boolean;
         extend?: boolean;
     }
+    /**
+     * Modifiers describe a partial list of properties that can be set with values or shorthand strings.
+     */
+    export type Modifiers<C = IColor.Serializable> = Partial<IStyledFont.Properties<C>>;
+    /**
+     * Options for updating a font.
+     */
+    export type Update<C = IColor.Serializable> = IStyledFont | Modifiers<C> | string | null;
     export interface JSON extends Properties<string> {
     }
 }
@@ -15648,10 +15799,22 @@ export declare interface ITextBoxAlignment {
      * Types of horizontal alignment.
      */
     getHorizontal(): ITextFrame.HorizontalAlignment;
+    /**
+     * Sets the horizontal alignment
+     *
+     * @param horizontal The horizontal alignment
+     */
+    setHorizontal(horizontal: ITextFrame.HorizontalAlignment | null, options?: IStyle.UpdateOptions): ITextBoxAlignment;
     /**
      * Types of horizontal alignment.
      */
     getVertical(): ITextFrame.VerticalAlignment;
+    /**
+     * Sets the vertical alignment
+     *
+     * @param vertical The vertical alignment
+     */
+    setVertical(vertical: ITextFrame.VerticalAlignment | null, options?: IStyle.UpdateOptions): ITextBoxAlignment;
     /**
      * An integer value, where an increment of 1 represents 3 spaces.
      * Indicates the number of spaces (of the normal style font) of indentation for text in a cell.
@@ -15660,34 +15823,76 @@ export declare interface ITextBoxAlignment {
      * This is only applied for alignments: left, right, and distributed.
      */
     getIndent(): number;
+    /**
+     * Sets the indentation
+     *
+     * @param indent The indentation
+     */
+    setIndent(indent: number | null, options?: IStyle.UpdateOptions): ITextBoxAlignment;
     /**
      * Indicates additional number of spaces of indentation to adjust for text in a cell.
      */
     getRelativeIndent(): number;
+    /**
+     * Sets the relative indentation
+     *
+     * @param relativeIndent The relative indentation
+     */
+    setRelativeIndent(relativeIndent: number | null, options?: IStyle.UpdateOptions): ITextBoxAlignment;
     /**
      * The behavior for text that does not fit with the cell bounds.
      * @see
      * {@link ITextFrame.Overflow}
      */
     getOverflow(): ITextFrame.Overflow;
+    /**
+     * Sets the overflow behavior
+     *
+     * @param overflow The overflow behavior
+     */
+    setOverflow(overflow: ITextFrame.Overflow | null, options?: IStyle.UpdateOptions): ITextBoxAlignment;
     /**
      * Rotation of the text.
      * @defaultValue 0
      */
     getRotation(): number;
+    /**
+     * Sets the rotation
+     *
+     * @param rotation The rotation
+     */
+    setRotation(rotation: number | null, options?: IStyle.UpdateOptions): ITextBoxAlignment;
     /**
      * If the text should stack vertically instead of horizontally.
      */
     getStacked(): boolean;
+    /**
+     * Sets the stacked
+     *
+     * @param stacked The stacked
+     */
+    setStacked(stacked: boolean | null, options?: IStyle.UpdateOptions): ITextBoxAlignment;
     /**
      * If the cells justified or distributed alignment should be used on the last line of text.
      * (This is typical for East Asian alignments but not typical in other contexts.)
      */
     getJustifyLastLine(): boolean;
+    /**
+     * Sets the justified last line
+     *
+     * @param justifyLastLine The justified last line
+     */
+    setJustifyLastLine(justifyLastLine: boolean | null, options?: IStyle.UpdateOptions): ITextBoxAlignment;
     /**
      * The direction the cell is being read.
      */
     getReadingDirection(): ITextFrame.ReadingDirection;
+    /**
+     * Sets the reading direction
+     *
+     * @param readingDirection The reading direction
+     */
+    setReadingDirection(readingDirection: ITextFrame.ReadingDirection | null, options?: IStyle.UpdateOptions): ITextBoxAlignment;
     toJSON(): ITextBoxAlignment.JSON;
     /**
      * For runtime type checking.
@@ -15785,6 +15990,14 @@ export declare namespace ITextFrame {
         export type Properties = ITextBoxAlignment.Properties;
         export type JSON = ITextBoxAlignment.JSON;
     }
+    /**
+     * Modifiers describe a partial list of properties that can be set with values or shorthand strings.
+     */
+    export type Modifiers = Partial<IAlignment.Properties>;
+    /**
+     * Options for updating an IAlignment.
+     */
+    export type Update = IAlignment | Modifiers | string | null;
     export type IAlignment = ITextBoxAlignment;
     /**
      * Represents a tab stop within a text frame or paragraph.