microsoft-graph 2.33.0 → 2.34.0

package/dist/cjs/tasks/insertWorkbookRangeRow.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Inserts a single row into a workbook range.
+ * @module insertRow
+ * @category Tasks
+ * @experimental
+ */
+import type { Cell } from "../models/Cell.ts";
+import type { WorkbookRangeRef } from "../models/WorkbookRange.ts";
+/**
+ * Inserts a single row into a workbook range.
+ * @param originRef Reference to the workbook range to update. Only the upper-left cell is used as an origin point.
+ * @param row Array of cells to insert as a single row.
+ * @experimental
+ * @example
+ * await insertRow(originRef, [{ value: "A1" }, { value: "B1" }, { value: "C1" }]);
+ */
+export default function insertWorkbookRangeRow(originRef: WorkbookRangeRef, row: Partial<Cell>[]): Promise<void>;
+//# sourceMappingURL=insertWorkbookRangeRow.d.ts.map

package/dist/cjs/tasks/insertWorkbookRangeRow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"insertWorkbookRangeRow.d.ts","sourceRoot":"","sources":["../../../src/tasks/insertWorkbookRangeRow.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAGnE;;;;;;;GAOG;AACH,wBAA8B,sBAAsB,CAAC,SAAS,EAAE,gBAAgB,EAAE,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAErH"}

package/dist/cjs/tasks/insertWorkbookRangeRow.js

@@ -0,0 +1,24 @@
+"use strict";
+/**
+ * Inserts a single row into a workbook range.
+ * @module insertRow
+ * @category Tasks
+ * @experimental
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = insertWorkbookRangeRow;
+const insertWorkbookRangeRows_ts_1 = __importDefault(require("./insertWorkbookRangeRows.js"));
+/**
+ * Inserts a single row into a workbook range.
+ * @param originRef Reference to the workbook range to update. Only the upper-left cell is used as an origin point.
+ * @param row Array of cells to insert as a single row.
+ * @experimental
+ * @example
+ * await insertRow(originRef, [{ value: "A1" }, { value: "B1" }, { value: "C1" }]);
+ */
+async function insertWorkbookRangeRow(originRef, row) {
+    await (0, insertWorkbookRangeRows_ts_1.default)(originRef, [row]);
+}

package/dist/cjs/tasks/insertWorkbookRangeRows.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Inserts rows into a workbook range.
+ * @module insertRows
+ * @category Tasks
+ * @experimental
+ */
+import type { Cell } from "../models/Cell.ts";
+import type { WorkbookRangeRef } from "../models/WorkbookRange.ts";
+/**
+ * Inserts rows into a workbook range.
+ * @param originRef Reference to the workbook range to update. Only the upper-left cell is used as an origin point.
+ * @param cells Array of arrays of cells to update in the specified range.
+ * @param maxCellsPerOperation Prescribe max cells to retrieve per operation. `null` automatically determines value. DO NOT SET EXCEPT FOR ADVANCED TUNING.
+ * @experimental
+ * @example
+ * // Basic example:
+ * await insertRows(originRef, [
+ *   [{ value: "A1" }, { value: "B1" }, { value: "C1" }],
+ *   [{ value: "A2" }, { value: "B2" }, { value: "C2" }],
+ *  [{ value: "A3" }, { value: "B3" }, { value: "C3" }],
+ * ])
+ *
+ * // Advanced example with cell formatting:
+ * await insertRows(originRef, [
+ *   [{ value: "A1", format: { fontColor: "red" } }, { value: "B1" }, { value: "C1" }],
+ *   [{ value: "A2" }, { value: "B2", format: { fontColor: "blue" } }, { value: "C2" }],
+ *   [{ value: "A3" }, { value: "B3" }, { value: "C3", format: { fontColor: "green" } }],
+ * ]);
+ */
+export default function insertWorkbookRangeRows(originRef: WorkbookRangeRef, cells: Iterable<Partial<Cell>[]> | AsyncIterable<Partial<Cell>[]>, maxCellsPerOperation?: number | null): Promise<void>;
+//# sourceMappingURL=insertWorkbookRangeRows.d.ts.map

package/dist/cjs/tasks/insertWorkbookRangeRows.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"insertWorkbookRangeRows.d.ts","sourceRoot":"","sources":["../../../src/tasks/insertWorkbookRangeRows.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAMnE;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,wBAA8B,uBAAuB,CAAC,SAAS,EAAE,gBAAgB,EAAE,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,oBAAoB,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAwB/M"}

package/dist/cjs/tasks/insertWorkbookRangeRows.js

@@ -0,0 +1,80 @@
+"use strict";
+/**
+ * Inserts rows into a workbook range.
+ * @module insertRows
+ * @category Tasks
+ * @experimental
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = insertWorkbookRangeRows;
+const InvalidArgumentError_ts_1 = __importDefault(require("../errors/InvalidArgumentError.js"));
+const insertWorkbookCells_ts_1 = __importDefault(require("../operations/workbookRange/insertWorkbookCells.js"));
+const addressManipulation_ts_1 = require("../services/addressManipulation.js");
+const batch_ts_1 = require("../services/batch.js");
+const updateWorkbookRangeRows_ts_1 = __importDefault(require("./updateWorkbookRangeRows.js"));
+/**
+ * Inserts rows into a workbook range.
+ * @param originRef Reference to the workbook range to update. Only the upper-left cell is used as an origin point.
+ * @param cells Array of arrays of cells to update in the specified range.
+ * @param maxCellsPerOperation Prescribe max cells to retrieve per operation. `null` automatically determines value. DO NOT SET EXCEPT FOR ADVANCED TUNING.
+ * @experimental
+ * @example
+ * // Basic example:
+ * await insertRows(originRef, [
+ *   [{ value: "A1" }, { value: "B1" }, { value: "C1" }],
+ *   [{ value: "A2" }, { value: "B2" }, { value: "C2" }],
+ *  [{ value: "A3" }, { value: "B3" }, { value: "C3" }],
+ * ])
+ *
+ * // Advanced example with cell formatting:
+ * await insertRows(originRef, [
+ *   [{ value: "A1", format: { fontColor: "red" } }, { value: "B1" }, { value: "C1" }],
+ *   [{ value: "A2" }, { value: "B2", format: { fontColor: "blue" } }, { value: "C2" }],
+ *   [{ value: "A3" }, { value: "B3" }, { value: "C3", format: { fontColor: "green" } }],
+ * ]);
+ */
+async function insertWorkbookRangeRows(originRef, cells, maxCellsPerOperation = null) {
+    let maxRowsPerOperation = maxCellsPerOperation;
+    let colCount = null;
+    let rowCount = 0;
+    const batch = [];
+    for await (const row of cells) {
+        if (colCount === null) {
+            colCount = row.length;
+        }
+        else if (colCount !== row.length) {
+            throw new InvalidArgumentError_ts_1.default("Not all rows have the same number of cells. Ensure all rows are consistent in length.");
+        }
+        if (maxRowsPerOperation === null) {
+            maxRowsPerOperation = calculateMaxRowsPerOperation(colCount, maxCellsPerOperation);
+        }
+        if (batch.push(row) >= maxRowsPerOperation) {
+            rowCount += await writeBatch(batch, originRef, rowCount, colCount);
+        }
+    }
+    if (colCount !== null) {
+        rowCount += await writeBatch(batch, originRef, rowCount, colCount);
+    }
+}
+async function writeBatch(batch, originRef, rowsCompleted, colCount) {
+    const rowCount = batch.length;
+    if (rowCount === 0) {
+        return 0;
+    }
+    const rangeRef = (0, addressManipulation_ts_1.superRange)(originRef, rowsCompleted, rowCount, 0, colCount);
+    await (0, insertWorkbookCells_ts_1.default)(rangeRef, "Down");
+    await (0, updateWorkbookRangeRows_ts_1.default)(rangeRef, batch);
+    batch.length = 0;
+    return rowCount;
+}
+function calculateMaxRowsPerOperation(columnCount, overwriteMaxCellsPerOperation) {
+    const maxCellsPerOperation = overwriteMaxCellsPerOperation ?? batch_ts_1.maxCellsPerRequest;
+    const maxRowsPerOperation = Math.floor(maxCellsPerOperation / columnCount);
+    if (maxRowsPerOperation < 1) {
+        throw new InvalidArgumentError_ts_1.default("maxCellsPerOperation must be greater than or equal to the number of columns in the range."); // Excel supports up to 16k columns, which exceeds the assumed 10k cell limit per write. This might not be a problem, but not worth spending time checking this currently either.
+    }
+    return maxRowsPerOperation;
+}

package/dist/cjs/tasks/{iterateRows.d.ts → iterateWorkbookRangeRows.d.ts}

@@ -8,7 +8,7 @@ import type { Cell, CellScope } from "../models/Cell.ts";
 import type { RowOffset } from "../models/Row.ts";
 import type { WorkbookRangeRef } from "../models/WorkbookRange.ts";
 /**
- * Represents a row yielded by the {@link iterateRows} generator.
+ * Represents a row yielded by the {@link iterateWorkbookRangeRows} generator.
  * @property {Cell[]} cells Array of cells in the row, each containing value, text, format, and optionally style information depending on the scope.
  * @property {RowOffset} offset Zero-based offset of the row within the original range.
  * @property {boolean} isFirst If this is the first row in the iteration.
@@ -31,5 +31,5 @@ export type IteratedRow = {
  *   console.log(row);
  * }
  */
-export declare function iterateRows(rangeRef: WorkbookRangeRef, scope?: Partial<CellScope>, maxCellsPerOperation?: number | null): AsyncIterable<IteratedRow>;
-//# sourceMappingURL=iterateRows.d.ts.map
+export declare function iterateWorkbookRangeRows(rangeRef: WorkbookRangeRef, scope?: Partial<CellScope>, maxCellsPerOperation?: number | null): AsyncIterable<IteratedRow>;
+//# sourceMappingURL=iterateWorkbookRangeRows.d.ts.map

package/dist/cjs/tasks/iterateWorkbookRangeRows.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"iterateWorkbookRangeRows.d.ts","sourceRoot":"","sources":["../../../src/tasks/iterateWorkbookRangeRows.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH,OAAO,KAAK,EAAE,IAAI,EAAuC,SAAS,EAA6D,MAAM,mBAAmB,CAAC;AAIzJ,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAUnE;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,GAAG;IACzB,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,MAAM,EAAE,SAAS,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,wBAAuB,wBAAwB,CAAC,QAAQ,EAAE,gBAAgB,EAAE,KAAK,GAAE,OAAO,CAAC,SAAS,CAAoB,EAAE,oBAAoB,GAAE,MAAM,GAAG,IAAW,GAAG,aAAa,CAAC,WAAW,CAAC,CAgDhM"}

package/dist/cjs/tasks/{iterateRows.js → iterateWorkbookRangeRows.js}

@@ -9,7 +9,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.iterateRows = iterateRows;
+exports.iterateWorkbookRangeRows = iterateWorkbookRangeRows;
 const InvalidArgumentError_ts_1 = __importDefault(require("../errors/InvalidArgumentError.js"));
 const getWorkbookRangeFill_ts_1 = __importDefault(require("../operations/workbookRange/getWorkbookRangeFill.js"));
 const getWorkbookRangeFont_ts_1 = __importDefault(require("../operations/workbookRange/getWorkbookRangeFont.js"));
@@ -30,7 +30,7 @@ const cell_ts_1 = require("../services/cell.js");
  *   console.log(row);
  * }
  */
-async function* iterateRows(rangeRef, scope = cell_ts_1.defaultCellScope, maxCellsPerOperation = null) {
+async function* iterateWorkbookRangeRows(rangeRef, scope = cell_ts_1.defaultCellScope, maxCellsPerOperation = null) {
     const totalColumnCount = (0, addressManipulation_ts_1.countAddressColumns)(rangeRef.address);
     const totalRowCount = (0, addressManipulation_ts_1.countAddressRows)(rangeRef.address);
     const maxRowsPerOperation = calculateMaxRowsPerOperation(totalColumnCount, maxCellsPerOperation);

package/dist/{esm/tasks/readFirstRow.d.ts → cjs/tasks/readWorkbookRangeFirstRow.d.ts}

@@ -14,5 +14,5 @@ import type { WorkbookRangeRef } from "../models/WorkbookRange.ts";
  * @example
  * const firstRow = await readFirstRow(rangeRef);
  */
-export default function readFirstRow(rangeRef: WorkbookRangeRef, scope?: import("../models/Cell.ts").CellScope): Promise<Cell[]>;
-//# sourceMappingURL=readFirstRow.d.ts.map
+export default function readWorkbookRangeFirstRow(rangeRef: WorkbookRangeRef, scope?: import("../models/Cell.ts").CellScope): Promise<Cell[]>;
+//# sourceMappingURL=readWorkbookRangeFirstRow.d.ts.map

package/dist/cjs/tasks/readWorkbookRangeFirstRow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"readWorkbookRangeFirstRow.d.ts","sourceRoot":"","sources":["../../../src/tasks/readWorkbookRangeFirstRow.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAKnE;;;;;;;GAOG;AACH,wBAA8B,yBAAyB,CAAC,QAAQ,EAAE,gBAAgB,EAAE,KAAK,wCAAmB,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAQ7H"}

package/dist/cjs/tasks/{readFirstRow.js → readWorkbookRangeFirstRow.js}

@@ -9,11 +9,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = readFirstRow;
+exports.default = readWorkbookRangeFirstRow;
 const InvalidArgumentError_ts_1 = __importDefault(require("../errors/InvalidArgumentError.js"));
 const addressManipulation_ts_1 = require("../services/addressManipulation.js");
 const cell_ts_1 = require("../services/cell.js");
-const iterateRows_ts_1 = require("./iterateRows.js");
+const iterateWorkbookRangeRows_ts_1 = require("./iterateWorkbookRangeRows.js");
 /** * Read the first row from a given workbook range.
  * @param rangeRef Reference to the workbook range to read.
  * @param scope Amount of detail to include for each cell.
@@ -22,9 +22,9 @@ const iterateRows_ts_1 = require("./iterateRows.js");
  * @example
  * const firstRow = await readFirstRow(rangeRef);
  */
-async function readFirstRow(rangeRef, scope = cell_ts_1.defaultCellScope) {
+async function readWorkbookRangeFirstRow(rangeRef, scope = cell_ts_1.defaultCellScope) {
     const firstRowRef = (0, addressManipulation_ts_1.subRange)(rangeRef, 0, 1);
-    for await (const { cells } of (0, iterateRows_ts_1.iterateRows)(firstRowRef, scope)) {
+    for await (const { cells } of (0, iterateWorkbookRangeRows_ts_1.iterateWorkbookRangeRows)(firstRowRef, scope)) {
         return cells;
     }
     throw new InvalidArgumentError_ts_1.default("No rows in the specified range.");

package/dist/{esm/tasks/readRows.d.ts → cjs/tasks/readWorkbookRangeRows.d.ts}

@@ -11,10 +11,10 @@ import type { WorkbookRangeRef } from "../models/WorkbookRange.ts";
  * @param rangeRef Reference to the workbook range to read.
  * @param scope Amount of detail to include for each cell.
  * @returns A promise that resolves to an array of rows, each containing an array of cells.
- * @remarks Where practical, prefer using {@link iterateRows} for more efficient memory usage.
+ * @remarks Where practical, prefer using {@link iterateWorkbookRangeRows} for more efficient memory usage.
  * @experimental
  * @example
  * const rows = await readRows(rangeRef);
  */
-export default function readRows(rangeRef: WorkbookRangeRef, scope?: import("../models/Cell.ts").CellScope): Promise<Cell[][]>;
-//# sourceMappingURL=readRows.d.ts.map
+export default function readWorkbookRangeRows(rangeRef: WorkbookRangeRef, scope?: import("../models/Cell.ts").CellScope): Promise<Cell[][]>;
+//# sourceMappingURL=readWorkbookRangeRows.d.ts.map

package/dist/cjs/tasks/readWorkbookRangeRows.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"readWorkbookRangeRows.d.ts","sourceRoot":"","sources":["../../../src/tasks/readWorkbookRangeRows.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAInE;;;;;;;;;GASG;AACH,wBAA8B,qBAAqB,CAAC,QAAQ,EAAE,gBAAgB,EAAE,KAAK,wCAAmB,GAAG,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAO3H"}

package/dist/cjs/tasks/{readRows.js → readWorkbookRangeRows.js}

@@ -6,22 +6,22 @@
  * @experimental
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = readRows;
+exports.default = readWorkbookRangeRows;
 const cell_ts_1 = require("../services/cell.js");
-const iterateRows_ts_1 = require("./iterateRows.js");
+const iterateWorkbookRangeRows_ts_1 = require("./iterateWorkbookRangeRows.js");
 /**
  * Read all rows from a given workbook range.
  * @param rangeRef Reference to the workbook range to read.
  * @param scope Amount of detail to include for each cell.
  * @returns A promise that resolves to an array of rows, each containing an array of cells.
- * @remarks Where practical, prefer using {@link iterateRows} for more efficient memory usage.
+ * @remarks Where practical, prefer using {@link iterateWorkbookRangeRows} for more efficient memory usage.
  * @experimental
  * @example
  * const rows = await readRows(rangeRef);
  */
-async function readRows(rangeRef, scope = cell_ts_1.defaultCellScope) {
+async function readWorkbookRangeRows(rangeRef, scope = cell_ts_1.defaultCellScope) {
     const rows = [];
-    for await (const { cells } of (0, iterateRows_ts_1.iterateRows)(rangeRef, scope)) {
+    for await (const { cells } of (0, iterateWorkbookRangeRows_ts_1.iterateWorkbookRangeRows)(rangeRef, scope)) {
         rows.push(cells);
     }
     return rows;

package/dist/cjs/tasks/{updateFirstRow.d.ts → updateWorkbookRangeFirstRow.d.ts}

@@ -22,5 +22,5 @@ import type { WorkbookRangeRef } from "../models/WorkbookRange.ts";
  *  { value: "Column B", style: { alignment: { horizontal: "Right" }, font: { bold: true } } }
  * ]);
  */
-export default function updateFirstRow(originRef: WorkbookRangeRef, cells: Partial<Cell>[]): Promise<void>;
-//# sourceMappingURL=updateFirstRow.d.ts.map
+export default function updateWorkbookRangeFirstRow(originRef: WorkbookRangeRef, cells: Partial<Cell>[]): Promise<void>;
+//# sourceMappingURL=updateWorkbookRangeFirstRow.d.ts.map

package/dist/cjs/tasks/updateWorkbookRangeFirstRow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"updateWorkbookRangeFirstRow.d.ts","sourceRoot":"","sources":["../../../src/tasks/updateWorkbookRangeFirstRow.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAGnE;;;;;;;;;;;;;;;GAeG;AACH,wBAA8B,2BAA2B,CAAC,SAAS,EAAE,gBAAgB,EAAE,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAG5H"}

package/dist/cjs/tasks/{updateFirstRow.js → updateWorkbookRangeFirstRow.js}

@@ -9,8 +9,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = updateFirstRow;
-const updateRows_ts_1 = __importDefault(require("./updateRows.js"));
+exports.default = updateWorkbookRangeFirstRow;
+const updateWorkbookRangeRows_ts_1 = __importDefault(require("./updateWorkbookRangeRows.js"));
 /**
  * Update first row in a given workbook range.
  * @param originRef Reference to the workbook range to update. Only the upper-left cell is used as an origin point.
@@ -27,7 +27,7 @@ const updateRows_ts_1 = __importDefault(require("./updateRows.js"));
  *  { value: "Column B", style: { alignment: { horizontal: "Right" }, font: { bold: true } } }
  * ]);
  */
-async function updateFirstRow(originRef, cells) {
+async function updateWorkbookRangeFirstRow(originRef, cells) {
     const rows = [cells];
-    await (0, updateRows_ts_1.default)(originRef, rows);
+    await (0, updateWorkbookRangeRows_ts_1.default)(originRef, rows);
 }

package/dist/{esm/tasks/updateRows.d.ts → cjs/tasks/updateWorkbookRangeRows.d.ts}

@@ -22,5 +22,5 @@ import type { WorkbookRangeRef } from "../models/WorkbookRange.ts";
  *   [{ value: 2, format: accountingCellFormat }, { value: "B" }],
  * ]);
  */
-export default function updateRows(originRef: WorkbookRangeRef, cells: Iterable<Partial<Cell>[]> | AsyncIterable<Partial<Cell>[]>, maxCellsPerOperation?: number | null): Promise<void>;
-//# sourceMappingURL=updateRows.d.ts.map
+export default function updateWorkbookRangeRows(originRef: WorkbookRangeRef, cells: Iterable<Partial<Cell>[]> | AsyncIterable<Partial<Cell>[]>, maxCellsPerOperation?: number | null): Promise<void>;
+//# sourceMappingURL=updateWorkbookRangeRows.d.ts.map

package/dist/cjs/tasks/updateWorkbookRangeRows.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"updateWorkbookRangeRows.d.ts","sourceRoot":"","sources":["../../../src/tasks/updateWorkbookRangeRows.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAWnE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAA8B,uBAAuB,CAAC,SAAS,EAAE,gBAAgB,EAAE,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,oBAAoB,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAwB/M"}

package/dist/cjs/tasks/{updateRows.js → updateWorkbookRangeRows.js}

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = updateRows;
+exports.default = updateWorkbookRangeRows;
 /**
  * Update rows in a given workbook range.
  * @module updateRows
@@ -43,7 +43,7 @@ const stringCaseConversion_ts_1 = require("../services/stringCaseConversion.js")
  *   [{ value: 2, format: accountingCellFormat }, { value: "B" }],
  * ]);
  */
-async function updateRows(originRef, cells, maxCellsPerOperation = null) {
+async function updateWorkbookRangeRows(originRef, cells, maxCellsPerOperation = null) {
     let maxRowsPerOperation = maxCellsPerOperation;
     let colCount = null;
     let rowCount = 0;
@@ -62,8 +62,8 @@ async function updateRows(originRef, cells, maxCellsPerOperation = null) {
             rowCount += await writeBatch(batch, originRef, rowCount, colCount);
         }
     }
-    if (colCount) {
-        await writeBatch(batch, originRef, rowCount, colCount);
+    if (colCount !== null) {
+        rowCount += await writeBatch(batch, originRef, rowCount, colCount);
     }
 }
 async function writeBatch(cells, originRef, rowsCompleted, colCount) {

package/dist/esm/tasks/insertWorkbookRangeRow.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Inserts a single row into a workbook range.
+ * @module insertRow
+ * @category Tasks
+ * @experimental
+ */
+import type { Cell } from "../models/Cell.ts";
+import type { WorkbookRangeRef } from "../models/WorkbookRange.ts";
+/**
+ * Inserts a single row into a workbook range.
+ * @param originRef Reference to the workbook range to update. Only the upper-left cell is used as an origin point.
+ * @param row Array of cells to insert as a single row.
+ * @experimental
+ * @example
+ * await insertRow(originRef, [{ value: "A1" }, { value: "B1" }, { value: "C1" }]);
+ */
+export default function insertWorkbookRangeRow(originRef: WorkbookRangeRef, row: Partial<Cell>[]): Promise<void>;
+//# sourceMappingURL=insertWorkbookRangeRow.d.ts.map

package/dist/esm/tasks/insertWorkbookRangeRow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"insertWorkbookRangeRow.d.ts","sourceRoot":"","sources":["../../../src/tasks/insertWorkbookRangeRow.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAGnE;;;;;;;GAOG;AACH,wBAA8B,sBAAsB,CAAC,SAAS,EAAE,gBAAgB,EAAE,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAErH"}

package/dist/esm/tasks/insertWorkbookRangeRow.js

@@ -0,0 +1,18 @@
+/**
+ * Inserts a single row into a workbook range.
+ * @module insertRow
+ * @category Tasks
+ * @experimental
+ */
+import insertWorkbookRangeRows from "./insertWorkbookRangeRows.js";
+/**
+ * Inserts a single row into a workbook range.
+ * @param originRef Reference to the workbook range to update. Only the upper-left cell is used as an origin point.
+ * @param row Array of cells to insert as a single row.
+ * @experimental
+ * @example
+ * await insertRow(originRef, [{ value: "A1" }, { value: "B1" }, { value: "C1" }]);
+ */
+export default async function insertWorkbookRangeRow(originRef, row) {
+    await insertWorkbookRangeRows(originRef, [row]);
+}

package/dist/esm/tasks/insertWorkbookRangeRows.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Inserts rows into a workbook range.
+ * @module insertRows
+ * @category Tasks
+ * @experimental
+ */
+import type { Cell } from "../models/Cell.ts";
+import type { WorkbookRangeRef } from "../models/WorkbookRange.ts";
+/**
+ * Inserts rows into a workbook range.
+ * @param originRef Reference to the workbook range to update. Only the upper-left cell is used as an origin point.
+ * @param cells Array of arrays of cells to update in the specified range.
+ * @param maxCellsPerOperation Prescribe max cells to retrieve per operation. `null` automatically determines value. DO NOT SET EXCEPT FOR ADVANCED TUNING.
+ * @experimental
+ * @example
+ * // Basic example:
+ * await insertRows(originRef, [
+ *   [{ value: "A1" }, { value: "B1" }, { value: "C1" }],
+ *   [{ value: "A2" }, { value: "B2" }, { value: "C2" }],
+ *  [{ value: "A3" }, { value: "B3" }, { value: "C3" }],
+ * ])
+ *
+ * // Advanced example with cell formatting:
+ * await insertRows(originRef, [
+ *   [{ value: "A1", format: { fontColor: "red" } }, { value: "B1" }, { value: "C1" }],
+ *   [{ value: "A2" }, { value: "B2", format: { fontColor: "blue" } }, { value: "C2" }],
+ *   [{ value: "A3" }, { value: "B3" }, { value: "C3", format: { fontColor: "green" } }],
+ * ]);
+ */
+export default function insertWorkbookRangeRows(originRef: WorkbookRangeRef, cells: Iterable<Partial<Cell>[]> | AsyncIterable<Partial<Cell>[]>, maxCellsPerOperation?: number | null): Promise<void>;
+//# sourceMappingURL=insertWorkbookRangeRows.d.ts.map

package/dist/esm/tasks/insertWorkbookRangeRows.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"insertWorkbookRangeRows.d.ts","sourceRoot":"","sources":["../../../src/tasks/insertWorkbookRangeRows.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAMnE;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,wBAA8B,uBAAuB,CAAC,SAAS,EAAE,gBAAgB,EAAE,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,oBAAoB,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAwB/M"}

package/dist/esm/tasks/insertWorkbookRangeRows.js

@@ -0,0 +1,74 @@
+/**
+ * Inserts rows into a workbook range.
+ * @module insertRows
+ * @category Tasks
+ * @experimental
+ */
+import InvalidArgumentError from "../errors/InvalidArgumentError.js";
+import insertWorkbookCells from "../operations/workbookRange/insertWorkbookCells.js";
+import { superRange } from "../services/addressManipulation.js";
+import { maxCellsPerRequest } from "../services/batch.js";
+import updateWorkbookRangeRows from "./updateWorkbookRangeRows.js";
+/**
+ * Inserts rows into a workbook range.
+ * @param originRef Reference to the workbook range to update. Only the upper-left cell is used as an origin point.
+ * @param cells Array of arrays of cells to update in the specified range.
+ * @param maxCellsPerOperation Prescribe max cells to retrieve per operation. `null` automatically determines value. DO NOT SET EXCEPT FOR ADVANCED TUNING.
+ * @experimental
+ * @example
+ * // Basic example:
+ * await insertRows(originRef, [
+ *   [{ value: "A1" }, { value: "B1" }, { value: "C1" }],
+ *   [{ value: "A2" }, { value: "B2" }, { value: "C2" }],
+ *  [{ value: "A3" }, { value: "B3" }, { value: "C3" }],
+ * ])
+ *
+ * // Advanced example with cell formatting:
+ * await insertRows(originRef, [
+ *   [{ value: "A1", format: { fontColor: "red" } }, { value: "B1" }, { value: "C1" }],
+ *   [{ value: "A2" }, { value: "B2", format: { fontColor: "blue" } }, { value: "C2" }],
+ *   [{ value: "A3" }, { value: "B3" }, { value: "C3", format: { fontColor: "green" } }],
+ * ]);
+ */
+export default async function insertWorkbookRangeRows(originRef, cells, maxCellsPerOperation = null) {
+    let maxRowsPerOperation = maxCellsPerOperation;
+    let colCount = null;
+    let rowCount = 0;
+    const batch = [];
+    for await (const row of cells) {
+        if (colCount === null) {
+            colCount = row.length;
+        }
+        else if (colCount !== row.length) {
+            throw new InvalidArgumentError("Not all rows have the same number of cells. Ensure all rows are consistent in length.");
+        }
+        if (maxRowsPerOperation === null) {
+            maxRowsPerOperation = calculateMaxRowsPerOperation(colCount, maxCellsPerOperation);
+        }
+        if (batch.push(row) >= maxRowsPerOperation) {
+            rowCount += await writeBatch(batch, originRef, rowCount, colCount);
+        }
+    }
+    if (colCount !== null) {
+        rowCount += await writeBatch(batch, originRef, rowCount, colCount);
+    }
+}
+async function writeBatch(batch, originRef, rowsCompleted, colCount) {
+    const rowCount = batch.length;
+    if (rowCount === 0) {
+        return 0;
+    }
+    const rangeRef = superRange(originRef, rowsCompleted, rowCount, 0, colCount);
+    await insertWorkbookCells(rangeRef, "Down");
+    await updateWorkbookRangeRows(rangeRef, batch);
+    batch.length = 0;
+    return rowCount;
+}
+function calculateMaxRowsPerOperation(columnCount, overwriteMaxCellsPerOperation) {
+    const maxCellsPerOperation = overwriteMaxCellsPerOperation ?? maxCellsPerRequest;
+    const maxRowsPerOperation = Math.floor(maxCellsPerOperation / columnCount);
+    if (maxRowsPerOperation < 1) {
+        throw new InvalidArgumentError("maxCellsPerOperation must be greater than or equal to the number of columns in the range."); // Excel supports up to 16k columns, which exceeds the assumed 10k cell limit per write. This might not be a problem, but not worth spending time checking this currently either.
+    }
+    return maxRowsPerOperation;
+}

package/dist/esm/tasks/{iterateRows.d.ts → iterateWorkbookRangeRows.d.ts}

@@ -8,7 +8,7 @@ import type { Cell, CellScope } from "../models/Cell.ts";
 import type { RowOffset } from "../models/Row.ts";
 import type { WorkbookRangeRef } from "../models/WorkbookRange.ts";
 /**
- * Represents a row yielded by the {@link iterateRows} generator.
+ * Represents a row yielded by the {@link iterateWorkbookRangeRows} generator.
  * @property {Cell[]} cells Array of cells in the row, each containing value, text, format, and optionally style information depending on the scope.
  * @property {RowOffset} offset Zero-based offset of the row within the original range.
  * @property {boolean} isFirst If this is the first row in the iteration.
@@ -31,5 +31,5 @@ export type IteratedRow = {
  *   console.log(row);
  * }
  */
-export declare function iterateRows(rangeRef: WorkbookRangeRef, scope?: Partial<CellScope>, maxCellsPerOperation?: number | null): AsyncIterable<IteratedRow>;
-//# sourceMappingURL=iterateRows.d.ts.map
+export declare function iterateWorkbookRangeRows(rangeRef: WorkbookRangeRef, scope?: Partial<CellScope>, maxCellsPerOperation?: number | null): AsyncIterable<IteratedRow>;
+//# sourceMappingURL=iterateWorkbookRangeRows.d.ts.map

package/dist/esm/tasks/iterateWorkbookRangeRows.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"iterateWorkbookRangeRows.d.ts","sourceRoot":"","sources":["../../../src/tasks/iterateWorkbookRangeRows.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH,OAAO,KAAK,EAAE,IAAI,EAAuC,SAAS,EAA6D,MAAM,mBAAmB,CAAC;AAIzJ,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAUnE;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,GAAG;IACzB,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,MAAM,EAAE,SAAS,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,wBAAuB,wBAAwB,CAAC,QAAQ,EAAE,gBAAgB,EAAE,KAAK,GAAE,OAAO,CAAC,SAAS,CAAoB,EAAE,oBAAoB,GAAE,MAAM,GAAG,IAAW,GAAG,aAAa,CAAC,WAAW,CAAC,CAgDhM"}

package/dist/esm/tasks/{iterateRows.js → iterateWorkbookRangeRows.js}

@@ -24,7 +24,7 @@ import { defaultCellScope } from "../services/cell.js";
  *   console.log(row);
  * }
  */
-export async function* iterateRows(rangeRef, scope = defaultCellScope, maxCellsPerOperation = null) {
+export async function* iterateWorkbookRangeRows(rangeRef, scope = defaultCellScope, maxCellsPerOperation = null) {
     const totalColumnCount = countAddressColumns(rangeRef.address);
     const totalRowCount = countAddressRows(rangeRef.address);
     const maxRowsPerOperation = calculateMaxRowsPerOperation(totalColumnCount, maxCellsPerOperation);

package/dist/{cjs/tasks/readFirstRow.d.ts → esm/tasks/readWorkbookRangeFirstRow.d.ts}

@@ -14,5 +14,5 @@ import type { WorkbookRangeRef } from "../models/WorkbookRange.ts";
  * @example
  * const firstRow = await readFirstRow(rangeRef);
  */
-export default function readFirstRow(rangeRef: WorkbookRangeRef, scope?: import("../models/Cell.ts").CellScope): Promise<Cell[]>;
-//# sourceMappingURL=readFirstRow.d.ts.map
+export default function readWorkbookRangeFirstRow(rangeRef: WorkbookRangeRef, scope?: import("../models/Cell.ts").CellScope): Promise<Cell[]>;
+//# sourceMappingURL=readWorkbookRangeFirstRow.d.ts.map

package/dist/esm/tasks/readWorkbookRangeFirstRow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"readWorkbookRangeFirstRow.d.ts","sourceRoot":"","sources":["../../../src/tasks/readWorkbookRangeFirstRow.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAKnE;;;;;;;GAOG;AACH,wBAA8B,yBAAyB,CAAC,QAAQ,EAAE,gBAAgB,EAAE,KAAK,wCAAmB,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAQ7H"}

package/dist/esm/tasks/{readFirstRow.js → readWorkbookRangeFirstRow.js}

@@ -7,7 +7,7 @@
 import InvalidArgumentError from "../errors/InvalidArgumentError.js";
 import { subRange } from "../services/addressManipulation.js";
 import { defaultCellScope } from "../services/cell.js";
-import { iterateRows } from "./iterateRows.js";
+import { iterateWorkbookRangeRows } from "./iterateWorkbookRangeRows.js";
 /** * Read the first row from a given workbook range.
  * @param rangeRef Reference to the workbook range to read.
  * @param scope Amount of detail to include for each cell.
@@ -16,9 +16,9 @@ import { iterateRows } from "./iterateRows.js";
  * @example
  * const firstRow = await readFirstRow(rangeRef);
  */
-export default async function readFirstRow(rangeRef, scope = defaultCellScope) {
+export default async function readWorkbookRangeFirstRow(rangeRef, scope = defaultCellScope) {
     const firstRowRef = subRange(rangeRef, 0, 1);
-    for await (const { cells } of iterateRows(firstRowRef, scope)) {
+    for await (const { cells } of iterateWorkbookRangeRows(firstRowRef, scope)) {
         return cells;
     }
     throw new InvalidArgumentError("No rows in the specified range.");

package/dist/{cjs/tasks/readRows.d.ts → esm/tasks/readWorkbookRangeRows.d.ts}

@@ -11,10 +11,10 @@ import type { WorkbookRangeRef } from "../models/WorkbookRange.ts";
  * @param rangeRef Reference to the workbook range to read.
  * @param scope Amount of detail to include for each cell.
  * @returns A promise that resolves to an array of rows, each containing an array of cells.
- * @remarks Where practical, prefer using {@link iterateRows} for more efficient memory usage.
+ * @remarks Where practical, prefer using {@link iterateWorkbookRangeRows} for more efficient memory usage.
  * @experimental
  * @example
  * const rows = await readRows(rangeRef);
  */
-export default function readRows(rangeRef: WorkbookRangeRef, scope?: import("../models/Cell.ts").CellScope): Promise<Cell[][]>;
-//# sourceMappingURL=readRows.d.ts.map
+export default function readWorkbookRangeRows(rangeRef: WorkbookRangeRef, scope?: import("../models/Cell.ts").CellScope): Promise<Cell[][]>;
+//# sourceMappingURL=readWorkbookRangeRows.d.ts.map

package/dist/esm/tasks/readWorkbookRangeRows.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"readWorkbookRangeRows.d.ts","sourceRoot":"","sources":["../../../src/tasks/readWorkbookRangeRows.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAInE;;;;;;;;;GASG;AACH,wBAA8B,qBAAqB,CAAC,QAAQ,EAAE,gBAAgB,EAAE,KAAK,wCAAmB,GAAG,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAO3H"}