@sheetxl/sdk 0.6.0 → 0.6.2

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sheetxl/sdk",
   "description": "SDK - A high-performance, embeddable spreadsheet engine.",
-  "version": "0.6.0",
+  "version": "0.6.2",
   "license": "SEE LICENSE IN <LICENSE>",
   "type": "module",
   "exports": {
@@ -31,9 +31,9 @@
     "automation"
   ],
   "dependencies": {
-    "@sheetxl/primitives": "^0.6.0",
-    "@sheetxl/scripting": "^0.6.0",
-    "@sheetxl/utils": "^0.6.0",
+    "@sheetxl/primitives": "^0.6.2",
+    "@sheetxl/scripting": "^0.6.2",
+    "@sheetxl/utils": "^0.6.2",
     "bahttext": "^2.3.0",
     "bessel": "^1.0.2",
     "chalk": "^5.5.0",

package/types/index.d.ts

@@ -3162,6 +3162,14 @@ export declare namespace ICalculation {
  * A single unit of data and meta data within an `ICellRange`, located at a specific row and column.
  */
 export declare interface ICell {
+    /**
+     * Returns the range of the cell.
+     *
+     * @remarks
+     * Returns a range for a single cell.
+     * Temporary cells will have to return InvalidRange
+     */
+    getRange(): ICellRange;
     /**
      * Returns the value of the cell.
      *
@@ -4282,12 +4290,14 @@ export declare interface ICellRange {
      */
     getMerges(): IRange.Coords[];
     /**
-     * A convenience method to get the top left `ICell`.
+     * Returns a cell in the range.
+     *
+     * @param address The address of the cell to retrieve. This must be within the range bounds. Default Value the 'top left'
      *
      * @see
      * {@link ICellRange.getCells}
      */
-    getCell(): ICell;
+    getCell(address?: ICell.Address): ICell;
     /**
      * Return a 2D array of {@link ICell | cells} in the shape of the range.
      *
@@ -4542,6 +4552,15 @@ export declare interface ICellRange {
      * {@link ICellRange.setValues}
      */
     setValue(value: ICellRange.ValuesUpdateOrCallback, options?: ICellRange.SetValuesOptions): this;
+    /**
+     * Set the formula for a range.
+     *
+     * @remarks
+     * Identical behavior to setValue. Exists for ergonomics
+     * @see
+     * {@link ICellRange.setValue}
+     */
+    setFormula(value: ICellRange.ValuesUpdateOrCallback, options?: ICellRange.SetValuesOptions): this;
     /**
      * Re-evaluates and formulas within the range.
      * @param full If `true` then all formulas will be recalculated.
@@ -11453,6 +11472,12 @@ export declare interface ISheet extends ITransaction.ITransactional, IListener.I
      * @param options Options for the ranges.
      */
     getRange(address: ICellRange.Address, options?: ICellRange.GetRangeOptions): ICellRange;
+    /**
+     * Returns a {@link ICell} at the specified address.
+     *
+     * @param address Address of the cell.
+     */
+    getCell(address: ICell.Address): ICell;
     /**
      * Returns an {@link ICellRanges}. An {@link ICellRanges} is an ordered list of
      * {@link ICellRange}s. These are used to interact with a set of contiguous 2D ranges.
@@ -12160,7 +12185,7 @@ export declare interface ISheetCollection extends ICollection<ISheet> {
     /**
      * Add an `ISheet` to the collection.
      */
-    add(options?: ISheetCollection.AddOptions): ISheet;
+    add(options?: ISheetCollection.AddOptions | string | number): ISheet;
     /**
      * Returns sheets that match the filter criteria.
      *
@@ -16805,6 +16830,13 @@ export declare interface IWorkbook extends ITransaction.ITransactional, IListene
      * Returns the collection of sheets within the workbook.
      */
     getSheets(): ISheetCollection;
+    /**
+     * Adds a new sheet to the workbook.
+     *
+     * @remarks
+     * This is a convenience method that wraps `getSheets().add`.
+     */
+    addSheet(options?: ISheetCollection.AddOptions | string | number): ISheet;
     /**
      * Returns the sheet at the given offset.
      *
@@ -18371,6 +18403,8 @@ export declare class Sheet implements ISheet {
     /* Excluded from this release type: _createRanges */
     /** {@inheritDoc ISheet.getRange} */
     getRange(address: ICellRange.Address, options?: ICellRange.GetRangeOptions): ICellRange;
+    /** {@inheritDoc ISheet.getCell} */
+    getCell(address: ICell.Address): ICell;
     /** {@inheritDoc ISheet.getRange} */
     getRanges(address: ICellRanges.Address, options?: ICellRange.GetRangeOptions): ICellRanges;
     /** {@inheritDoc ISheet.getSelectedRange} */
@@ -20539,6 +20573,8 @@ export declare class Workbook implements IWorkbook {
     getSheetAt(index: number, visibility?: ISheet.Visibility): ISheet;
     /** {@inheritDoc IWorkbook.getSheets} */
     getSheets(): ISheetCollection;
+    /** {@inheritDoc IWorkbook.addSheet} */
+    addSheet(options?: ISheetCollection.AddOptions | string | number): ISheet;
     protected _getSheets(visibility?: ISheet.Visibility): ISheet[];
     protected _getSheetRefs(visibility?: ISheet.Visibility): SheetRef[];
     /* Excluded from this release type: _getSheetRef */

package/types/scripting.d.ts

@@ -15519,6 +15519,12 @@ declare module "sheet/ISheet" {
          * @param options Options for the ranges.
          */
         getRange(address: ICellRange.Address, options?: ICellRange.GetRangeOptions): ICellRange;
+        /**
+         * Returns a {@link ICell} at the specified address.
+         *
+         * @param address Address of the cell.
+            */
+        getCell(address: ICell.Address): ICell;
         /**
          * Returns an {@link ICellRanges}. An {@link ICellRanges} is an ordered list of
          * {@link ICellRange}s. These are used to interact with a set of contiguous 2D ranges.
@@ -17944,6 +17950,9 @@ declare module "sheet/SheetCell" {
         protected _styleConditional: IStyle;
         constructor(options: SheetCellOptions, coords: IRange.CellCoords, type?: ScalarType, value?: Scalar, rs?: RangeState.Intersection, p?: IRange.CellCoords, // prev
         n?: IRange.CellCoords);
+        /** {@inheritDoc ICell.getRange} */
+        getRange(): ICellRange;
+        /** {@inheritDoc ICell.isEqual} */
         isEqual(other: ICell): boolean;
         /** {@inheritDoc ICell.getCoords} */
         getCoords(): IRange.CellCoords;
@@ -23987,6 +23996,14 @@ declare module "cell/ICell" {
      * A single unit of data and meta data within an `ICellRange`, located at a specific row and column.
      */
     export interface ICell {
+        /**
+         * Returns the range of the cell.
+         *
+         * @remarks
+         * Returns a range for a single cell.
+         * Temporary cells will have to return InvalidRange
+         */
+        getRange(): ICellRange;
         /**
          * Returns the value of the cell.
          *
@@ -26879,12 +26896,14 @@ declare module "cellRange/ICellRange" {
          */
         getMerges(): IRange.Coords[];
         /**
-         * A convenience method to get the top left `ICell`.
+         * Returns a cell in the range.
+         *
+         * @param address The address of the cell to retrieve. This must be within the range bounds. Default Value the 'top left'
          *
          * @see
          * {@link ICellRange.getCells}
          */
-        getCell(): ICell;
+        getCell(address?: ICell.Address): ICell;
         /**
          * Return a 2D array of {@link ICell | cells} in the shape of the range.
          *
@@ -27139,6 +27158,15 @@ declare module "cellRange/ICellRange" {
          * {@link ICellRange.setValues}
          */
         setValue(value: ICellRange.ValuesUpdateOrCallback, options?: ICellRange.SetValuesOptions): this;
+        /**
+         * Set the formula for a range.
+         *
+         * @remarks
+         * Identical behavior to setValue. Exists for ergonomics
+         * @see
+         * {@link ICellRange.setValue}
+         */
+        setFormula(value: ICellRange.ValuesUpdateOrCallback, options?: ICellRange.SetValuesOptions): this;
         /**
          * Re-evaluates and formulas within the range.
          * @param full If `true` then all formulas will be recalculated.
@@ -29587,7 +29615,7 @@ declare module "sheet/ISheetCollection" {
         /**
          * Add an `ISheet` to the collection.
          */
-        add(options?: ISheetCollection.AddOptions): ISheet;
+        add(options?: ISheetCollection.AddOptions | string | number): ISheet;
         /**
          * Returns sheets that match the filter criteria.
          *
@@ -32091,10 +32119,12 @@ declare module "sheet/SheetRange" {
         protected _validateWrite(): void;
         /** {@inheritDoc ICellRange.updateCells} */
         updateCells(value: ICellRange.Update, options?: ICellRange.UpdateCellsOptions, updateCoords?: IRange.Coords): this;
-        /** {@inheritDoc ICellRange.setValue} */
-        setValue(value: ScalarUpdate, options?: ICellRange.SetValuesOptions): this;
         /** {@inheritDoc ICellRange.setValues} */
         setValues(value: ICellRange.ValuesUpdate, options?: ICellRange.SetValuesOptions): this;
+        /** {@inheritDoc ICellRange.setValue} */
+        setValue(value: ScalarUpdate, options?: ICellRange.SetValuesOptions): this;
+        /** {@inheritDoc ICellRange.setFormula} */
+        setFormula(value: ScalarUpdate, options?: ICellRange.SetValuesOptions): this;
         /** @internal */
         protected _setValueOrValues(value: ICellRange.ValuesUpdate, options?: ICellRange.SetValuesOptions): this;
         /** {@inheritDoc ICellRange.getValues} */
@@ -32106,7 +32136,7 @@ declare module "sheet/SheetRange" {
         /** {@inheritDoc ICellRange.getCells} */
         getCells(options?: ICellRange.GetValuesOptions): ICell[][];
         /** {@inheritDoc ICellRange.getCell} */
-        getCell(): ICell;
+        getCell(address?: ICell.Address): ICell;
         /** {@inheritDoc ICellRange.select} */
         select(options?: ICellRange.SelectOptions): Promise<this>;
         /** {@inheritDoc ICellRange.find} */
@@ -32205,8 +32235,6 @@ declare module "sheet/SheetRange" {
         setHyperlink(hyperlink: IHyperlink.Update, options?: ITransaction.OperationOptions): this;
         /** {@inheritDoc ICellRange.setComments} */
         setComments(comments: IComment.Properties, options?: ITransaction.OperationOptions): this;
-        /** {@inheritDoc ICellRange.setFormula} */
-        setFormula(formula: string, options?: ITransaction.OperationOptions): this;
         /** {@inheritDoc ICellRange.updateStyle} */
         updateStyle(style: IStyle.Update, options?: IStyle.UpdateOptions): this;
         /** {@inheritDoc ICellRange.getStyleUpdater} */
@@ -32523,6 +32551,8 @@ declare module "sheet/Sheet" {
         protected _createRanges(coords: readonly IRange.Coords[], getOptions?: ICellRange.GetRangeOptions, readOnly?: string): ICellRanges;
         /** {@inheritDoc ISheet.getRange} */
         getRange(address: ICellRange.Address, options?: ICellRange.GetRangeOptions): ICellRange;
+        /** {@inheritDoc ISheet.getCell} */
+        getCell(address: ICell.Address): ICell;
         /** {@inheritDoc ISheet.getRange} */
         getRanges(address: ICellRanges.Address, options?: ICellRange.GetRangeOptions): ICellRanges;
         /** {@inheritDoc ISheet.getSelectedRange} */
@@ -33153,6 +33183,13 @@ declare module "workbook/IWorkbook" {
          * Returns the collection of sheets within the workbook.
          */
         getSheets(): ISheetCollection;
+        /**
+         * Adds a new sheet to the workbook.
+         *
+         * @remarks
+         * This is a convenience method that wraps `getSheets().add`.
+         */
+        addSheet(options?: ISheetCollection.AddOptions | string | number): ISheet;
         /**
          * Returns the sheet at the given offset.
          *
@@ -33776,7 +33813,7 @@ declare module "sheet/SheetCollection" {
         private _get;
         constructor(add: (options: ISheetCollection.AddOptions) => ISheet, get: (name?: string, visibility?: ISheet.Visibility) => ISheet[]);
         /** {@inheritDoc ISheetCollection.add} */
-        add(options?: ISheetCollection.AddOptions): ISheet;
+        add(options?: ISheetCollection.AddOptions | string | number): ISheet;
         /** {@inheritDoc ISheetCollection.getItems} */
         getItems(options?: ISheetCollection.GetItemsOptions): ISheet[];
         /** {@inheritDoc ISheetCollection.getByName} */
@@ -34023,6 +34060,8 @@ declare module "workbook/Workbook" {
         getSheetAt(index: number, visibility?: ISheet.Visibility): ISheet;
         /** {@inheritDoc IWorkbook.getSheets} */
         getSheets(): ISheetCollection;
+        /** {@inheritDoc IWorkbook.addSheet} */
+        addSheet(options?: ISheetCollection.AddOptions | string | number): ISheet;
         protected _getSheets(visibility?: ISheet.Visibility): ISheet[];
         protected _getSheetRefs(visibility?: ISheet.Visibility): SheetRef[];
         /** @internal */
@@ -34034,7 +34073,7 @@ declare module "workbook/Workbook" {
         /** {@inheritDoc IWorkbook.isValidSheetNameCharacter} */
         isValidSheetNameCharacter(character: string): boolean;
         /** @internal */
-        protected _addSheetOptions(options?: ISheetCollection.AddOptions): ISheet;
+        protected _addSheetOptions(options?: ISheetCollection.AddOptions | string | number): ISheet;
         /** @internal */
         protected _nextSheetName(sheetName?: string): string;
         /** @internal */