microsoft-graph 2.5.0 → 2.7.0

package/dist/services/addressManipulation.d.ts

@@ -84,4 +84,40 @@ export declare function decrementRowAddress(address: Address): Address;
  * @returns True if the addresses overlap, otherwise false.
  */
 export declare function isAddressOverlapping(address1: Address, address2: Address): boolean;
+/**
+ * Checks if the address components represent a single row.
+ * @param address - The address to check.
+ * @returns True if the components represent a single riw, otherwise false.
+ */
+export declare function isSingleRowAddress(address: Address): boolean;
+/**
+ * Checks if the address components represent a single column.
+ * @param address - The address to check.
+ * @returns True if the components represent single columns, otherwise false.
+ */
+export declare function isSingleColumnAddress(address: Address): boolean;
+/**
+ * Checks if the address components represent all columns.
+ * @param address - The address to check.
+ * @returns True if the components represent all columns, otherwise false.
+ */
+export declare function isAllColumnsAddress(address: Address): boolean;
+/**
+ * Checks if the address components represent all rows.
+ * @param address - The address to check.
+ * @returns True if the components represent all rows, otherwise false.
+ */
+export declare function isAllRowsAddress(address: Address): boolean;
+/**
+ * Counts the number of rows in a given address.
+ * @param address - The address to analyze.
+ * @returns The number of rows in the address.
+ */
+export declare function countAddressRows(address: Address): number;
+/**
+ * Counts the number of columns in a given address.
+ * @param address - The address to analyze.
+ * @returns The number of columns in the address.
+ */
+export declare function countAddressColumns(address: Address): number;
 //# sourceMappingURL=addressManipulation.d.ts.map

package/dist/services/addressManipulation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"addressManipulation.d.ts","sourceRoot":"","sources":["../../src/services/addressManipulation.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAoB,aAAa,EAAsB,UAAU,EAAmB,MAAM,sBAAsB,CAAC;AAmBnJ,MAAM,MAAM,iBAAiB,GAAG;IAC/B,WAAW,EAAE,aAAa,CAAC;IAC3B,SAAS,EAAE,aAAa,CAAC;IACzB,QAAQ,EAAE,UAAU,CAAC;IACrB,MAAM,EAAE,UAAU,CAAC;CACnB,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,iBAAiB,CAcpE;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,UAAU,EAAE,iBAAiB,GAAG,OAAO,CA6BrE;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,WAAW,CAGjE;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,WAAW,CAGhE;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAS5D;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAS3D;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAS/D;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAS9D;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAqChG;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAE7D;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAE7D;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,GAAG,OAAO,CAKlF"}
+{"version":3,"file":"addressManipulation.d.ts","sourceRoot":"","sources":["../../src/services/addressManipulation.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAoB,aAAa,EAAsB,UAAU,EAAmB,MAAM,sBAAsB,CAAC;AAmBnJ,MAAM,MAAM,iBAAiB,GAAG;IAC/B,WAAW,EAAE,aAAa,CAAC;IAC3B,SAAS,EAAE,aAAa,CAAC;IACzB,QAAQ,EAAE,UAAU,CAAC;IACrB,MAAM,EAAE,UAAU,CAAC;CACnB,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,iBAAiB,CAcpE;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,UAAU,EAAE,iBAAiB,GAAG,OAAO,CA6BrE;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,WAAW,CAGjE;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,WAAW,CAGhE;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAS5D;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAS3D;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAS/D;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAS9D;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAqChG;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAE7D;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAE7D;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,GAAG,OAAO,CAKlF;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAG5D;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAG/D;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAG7D;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAG1D;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAGzD;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAG5D"}

package/dist/services/addressManipulation.js

@@ -32,16 +32,16 @@ export function decomposeAddress(address) {
  * @throws InvalidArgumentError if the components are invalid.
  */
 export function composeAddress(components) {
-    if (isSingleColumn(components) && isMaxRows(components)) {
+    if (isSingleColumn(components) && isAllRows(components)) {
         return composeColumnAddress(components.startColumn);
     }
-    if (isSingleRow(components) && isMaxColumns(components)) {
+    if (isSingleRow(components) && isAllColumns(components)) {
         return composeRowAddress(components.startRow);
     }
-    if (isMaxRows(components)) {
+    if (isAllRows(components)) {
         return composeColumnRangeAddress(components.startColumn, components.endColumn);
     }
-    if (isMaxColumns(components)) {
+    if (isAllColumns(components)) {
         return composeRowRangeAddress(components.startRow, components.endRow);
     }
     if (isSingleColumn(components) && isSingleRow(components)) {
@@ -140,10 +140,10 @@ export function getLastColumnAddress(address) {
  */
 export function offsetAddress(address, columnOffset, rowOffset) {
     const components = decomposeAddress(address);
-    if (isMaxRows(components) && rowOffset !== 0) {
+    if (isAllRows(components) && rowOffset !== 0) {
         throw new UnsupportedAddressTypeError("All rows are selected. Cannot offset rows.");
     }
-    if (isMaxColumns(components) && columnOffset !== 0) {
+    if (isAllColumns(components) && columnOffset !== 0) {
         throw new UnsupportedAddressTypeError("All columns are selected. Cannot offset columns.");
     }
     const newStartRowIndex = rowAddressToOffset(components.startRow) + rowOffset;
@@ -194,6 +194,72 @@ export function isAddressOverlapping(address1, address2) {
     const components2 = decomposeAddress(address2);
     return components1.startColumn <= components2.endColumn && components1.endColumn >= components2.startColumn && rowAddressToOffset(components1.startRow) <= rowAddressToOffset(components2.endRow) && rowAddressToOffset(components1.endRow) >= rowAddressToOffset(components2.startRow);
 }
+/**
+ * Checks if the address components represent a single row.
+ * @param address - The address to check.
+ * @returns True if the components represent a single riw, otherwise false.
+ */
+export function isSingleRowAddress(address) {
+    const components = decomposeAddress(address);
+    return isSingleRow(components);
+}
+/**
+ * Checks if the address components represent a single column.
+ * @param address - The address to check.
+ * @returns True if the components represent single columns, otherwise false.
+ */
+export function isSingleColumnAddress(address) {
+    const components = decomposeAddress(address);
+    return isSingleColumn(components);
+}
+/**
+ * Checks if the address components represent all columns.
+ * @param address - The address to check.
+ * @returns True if the components represent all columns, otherwise false.
+ */
+export function isAllColumnsAddress(address) {
+    const components = decomposeAddress(address);
+    return isAllColumns(components);
+}
+/**
+ * Checks if the address components represent all rows.
+ * @param address - The address to check.
+ * @returns True if the components represent all rows, otherwise false.
+ */
+export function isAllRowsAddress(address) {
+    const components = decomposeAddress(address);
+    return isAllRows(components);
+}
+/**
+ * Counts the number of rows in a given address.
+ * @param address - The address to analyze.
+ * @returns The number of rows in the address.
+ */
+export function countAddressRows(address) {
+    const components = decomposeAddress(address);
+    return rowAddressToOffset(components.endRow) - rowAddressToOffset(components.startRow) + 1;
+}
+/**
+ * Counts the number of columns in a given address.
+ * @param address - The address to analyze.
+ * @returns The number of columns in the address.
+ */
+export function countAddressColumns(address) {
+    const components = decomposeAddress(address);
+    return columnAddressToOffset(components.endColumn) - columnAddressToOffset(components.startColumn) + 1;
+}
+function isSingleRow(components) {
+    return components.startRow === components.endRow;
+}
+function isSingleColumn(components) {
+    return components.startColumn === components.endColumn;
+}
+function isAllColumns(components) {
+    return components.startColumn === firstColumn && components.endColumn === lastColumn;
+}
+function isAllRows(components) {
+    return components.startRow === firstRow && components.endRow === lastRow;
+}
 function composeCellRangeAddress(startColumn, startRow, endColumn, endRow) {
     return `${startColumn}${startRow}:${endColumn}${endRow}`;
 }
@@ -212,15 +278,3 @@ function composeRowAddress(startRow) {
 function composeColumnAddress(startColumn) {
     return startColumn;
 }
-function isSingleRow(components) {
-    return components.startRow === components.endRow;
-}
-function isSingleColumn(components) {
-    return components.startColumn === components.endColumn;
-}
-function isMaxColumns(components) {
-    return components.startColumn === firstColumn && components.endColumn === lastColumn;
-}
-function isMaxRows(components) {
-    return components.startRow === firstRow && components.endRow === lastRow;
-}

package/dist/services/addressManipulation.test.js

@@ -1,6 +1,6 @@
 import { describe, expect, it } from "vitest";
 import InvalidArgumentError from "../errors/InvalidArgumentError.js";
-import { composeAddress, decomposeAddress, decrementRowAddress, getFirstCellAddress, getFirstColumnAddress, getFirstRowAddress, getLastCellAddress, getLastColumnAddress, getLastRowAddress, incrementRowAddress, isAddressOverlapping, offsetAddress } from "./addressManipulation.js";
+import { composeAddress, countAddressColumns, countAddressRows, decomposeAddress, decrementRowAddress, getFirstCellAddress, getFirstColumnAddress, getFirstRowAddress, getLastCellAddress, getLastColumnAddress, getLastRowAddress, incrementRowAddress, isAddressOverlapping, isAllColumnsAddress, isAllRowsAddress, isSingleColumnAddress, isSingleRowAddress, offsetAddress, } from "./addressManipulation.js";
 describe("getFirstCellAddress", () => {
     it("should return the start cell of a range address", () => {
         expect(getFirstCellAddress("C3:D4")).toBe("C3");
@@ -308,3 +308,77 @@ describe("isAddressOverlapping", () => {
         expect(isAddressOverlapping("A1", "B1")).toBe(false); // Different columns
     });
 });
+describe("isSingleRowAddress", () => {
+    it("should return true for single row addresses", () => {
+        expect(isSingleRowAddress("1")).toBe(true);
+        expect(isSingleRowAddress("A1:A1")).toBe(true);
+    });
+    it("should return false for multi-row addresses", () => {
+        expect(isSingleRowAddress("1:2")).toBe(false);
+        expect(isSingleRowAddress("A1:A2")).toBe(false);
+    });
+});
+describe("isSingleColumnAddress", () => {
+    it("should return true for single column addresses", () => {
+        expect(isSingleColumnAddress("A")).toBe(true);
+        expect(isSingleColumnAddress("A1:A1")).toBe(true);
+    });
+    it("should return false for multi-column addresses", () => {
+        expect(isSingleColumnAddress("A:B")).toBe(false);
+        expect(isSingleColumnAddress("A1:B1")).toBe(false);
+    });
+});
+describe("isAllColumnsAddress", () => {
+    it("should return true for addresses spanning all columns", () => {
+        expect(isAllColumnsAddress("1")).toBe(true);
+        expect(isAllColumnsAddress("1:10")).toBe(true);
+    });
+    it("should return false for addresses not spanning all columns", () => {
+        expect(isAllColumnsAddress("A")).toBe(false);
+        expect(isAllColumnsAddress("A1:B1")).toBe(false);
+    });
+});
+describe("isAllRowsAddress", () => {
+    it("should return true for addresses spanning all rows", () => {
+        expect(isAllRowsAddress("A")).toBe(true);
+        expect(isAllRowsAddress("A:C")).toBe(true);
+    });
+    it("should return false for addresses not spanning all rows", () => {
+        expect(isAllRowsAddress("1")).toBe(false);
+        expect(isAllRowsAddress("A1:A10")).toBe(false);
+    });
+});
+describe("countAddressRows", () => {
+    it("should return the correct number of rows for a cell range", () => {
+        expect(countAddressRows("A1:C5")).toBe(5);
+    });
+    it("should return the correct number of rows for a row range", () => {
+        expect(countAddressRows("1:5")).toBe(5);
+    });
+    it("should return 1 for a single cell address", () => {
+        expect(countAddressRows("A1")).toBe(1);
+    });
+    it("should return the correct number of rows for a column address", () => {
+        expect(countAddressRows("A")).toBe(1048576);
+    });
+    it("should return the correct number of rows for a column range address", () => {
+        expect(countAddressRows("A:C")).toBe(1048576);
+    });
+});
+describe("countAddressColumns", () => {
+    it("should return the correct number of columns for a cell range", () => {
+        expect(countAddressColumns("A1:C5")).toBe(3);
+    });
+    it("should return the correct number of columns for a column range", () => {
+        expect(countAddressColumns("A:C")).toBe(3);
+    });
+    it("should return 1 for a single cell address", () => {
+        expect(countAddressColumns("A1")).toBe(1);
+    });
+    it("should return the correct number of columns for a row address", () => {
+        expect(countAddressColumns("1")).toBe(16384);
+    });
+    it("should return the correct number of columns for a row range address", () => {
+        expect(countAddressColumns("1:5")).toBe(16384);
+    });
+});

package/dist/tasks/iterateWorkbookRangeValues.d.ts

@@ -0,0 +1,11 @@
+import type { RowRangeValues } from "../models/RowRangeValues.ts";
+import type { WorkbookRangeRef } from "../models/WorkbookRangeRef.ts";
+/**
+ * Iterates over the values of a workbook range in chunks, fetching data in manageable sizes.
+ *
+ * @param rangeRef - A reference to the workbook range to iterate over.
+ * @param overwriteRowsPerRequest - Optional. The number of rows to fetch per request. If omitted, it is automatically calculated.
+ * @returns An async iterable that yields rows of range values.
+ */
+export default function iterateWorkbookRangeValues(rangeRef: WorkbookRangeRef, overwriteRowsPerRequest?: number | null): AsyncIterable<RowRangeValues>;
+//# sourceMappingURL=iterateWorkbookRangeValues.d.ts.map

package/dist/tasks/iterateWorkbookRangeValues.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"iterateWorkbookRangeValues.d.ts","sourceRoot":"","sources":["../../src/tasks/iterateWorkbookRangeValues.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AActE;;;;;;GAMG;AACH,wBAA+B,0BAA0B,CAAC,QAAQ,EAAE,gBAAgB,EAAE,uBAAuB,GAAE,MAAM,GAAG,IAAW,GAAG,aAAa,CAAC,cAAc,CAAC,CAoClK"}

package/dist/tasks/iterateWorkbookRangeValues.js

@@ -0,0 +1,47 @@
+import InvalidArgumentError from "../errors/InvalidArgumentError.js";
+import getWorkbookWorksheetRange from "../operations/workbookRange/getWorkbookWorksheetRange.js";
+import { composeAddress, decomposeAddress } from "../services/addressManipulation.js";
+import { columnAddressToOffset, offsetToRowAddress, rowAddressToOffset } from "../services/addressOffset.js";
+import { createWorkbookRangeRef } from "../services/workbookRange.js";
+/**
+ * Maximum number of cells that can be retrieved in a single request, unless overwritten.
+ * @remarks The Microsoft Graph API documentation does not specify a fixed maximum number of cells that can be retrieved in a single request.
+ * However, it mentions that large ranges may result in errors due to resource constraints. Additionally, discussions in developer
+ * communities suggest that requests exceeding 10,000 cells may encounter issues.
+ */
+const maxCellsPerRequest = 10_000;
+/**
+ * Iterates over the values of a workbook range in chunks, fetching data in manageable sizes.
+ *
+ * @param rangeRef - A reference to the workbook range to iterate over.
+ * @param overwriteRowsPerRequest - Optional. The number of rows to fetch per request. If omitted, it is automatically calculated.
+ * @returns An async iterable that yields rows of range values.
+ */
+export default async function* iterateWorkbookRangeValues(rangeRef, overwriteRowsPerRequest = null) {
+    const address = rangeRef.address;
+    const components = decomposeAddress(address);
+    const columnsPerRow = columnAddressToOffset(components.endColumn) - columnAddressToOffset(components.startColumn) + 1;
+    if (overwriteRowsPerRequest !== null && overwriteRowsPerRequest < 1) {
+        throw new InvalidArgumentError("overwriteRowsPerRequest must be greater than 0");
+    }
+    const rowsPerRequest = overwriteRowsPerRequest ?? Math.floor(maxCellsPerRequest / columnsPerRow);
+    const rangeStartRowOffset = rowAddressToOffset(components.startRow);
+    const rangeEndRowOffset = rowAddressToOffset(components.endRow);
+    for (let chunkRowOffset = rangeStartRowOffset; chunkRowOffset <= rangeEndRowOffset; chunkRowOffset = (chunkRowOffset + rowsPerRequest)) {
+        const requestStartRowOffset = chunkRowOffset;
+        const requestEndRowOffset = Math.min(chunkRowOffset + rowsPerRequest - 1, rangeEndRowOffset);
+        const chunkStartRow = offsetToRowAddress(requestStartRowOffset);
+        const chunkEndRow = offsetToRowAddress(requestEndRowOffset);
+        const requestAddress = composeAddress({
+            startRow: chunkStartRow,
+            endRow: chunkEndRow,
+            startColumn: components.startColumn,
+            endColumn: components.endColumn,
+        });
+        const requestRef = createWorkbookRangeRef(rangeRef, requestAddress);
+        const range = await getWorkbookWorksheetRange(requestRef);
+        for (const row of range.values) {
+            yield row;
+        }
+    }
+}

package/dist/tasks/iterateWorkbookRangeValues.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=iterateWorkbookRangeValues.test.d.ts.map

package/dist/tasks/iterateWorkbookRangeValues.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"iterateWorkbookRangeValues.test.d.ts","sourceRoot":"","sources":["../../src/tasks/iterateWorkbookRangeValues.test.ts"],"names":[],"mappings":""}

package/dist/tasks/iterateWorkbookRangeValues.test.js

@@ -0,0 +1,61 @@
+import { describe, expect, it } from "vitest";
+import calculateWorkbook from "../operations/workbook/calculateWorkbook.js";
+import createWorkbook from "../operations/workbook/createWorkbook.js";
+import { getDefaultDriveRef } from "../services/drive.js";
+import { driveItemPath } from "../services/driveItem.js";
+import { generateTempFileName } from "../services/temporaryFiles.js";
+import { createWorkbookRangeRef } from "../services/workbookRange.js";
+import { createWorkbookWorksheetRef, defaultWorkbookWorksheetId } from "../services/workbookWorksheet.js";
+import iterateWorkbookRangeValues from "./iterateWorkbookRangeValues.js";
+import setWorkbookRangeValues from "./setWorkbookRangeValues.js";
+import tryDeleteDriveItem from "./tryDeleteDriveItem.js";
+describe("iterateWorkbookRangeValues", () => {
+    it("Single request", async () => {
+        const workbookName = generateTempFileName("xlsx");
+        const workbookPath = driveItemPath(workbookName);
+        const driveRef = getDefaultDriveRef();
+        const workbook = await createWorkbook(driveRef, workbookPath);
+        const worksheetRef = createWorkbookWorksheetRef(workbook, defaultWorkbookWorksheetId);
+        try {
+            const rangeRef = createWorkbookRangeRef(worksheetRef, "A1:C3");
+            const values = [
+                [1, 2, 3],
+                [4, 5, 6],
+                [7, 8, 9],
+            ];
+            await setWorkbookRangeValues(rangeRef, values);
+            await calculateWorkbook(workbook);
+            let idx = 0;
+            for await (const row of iterateWorkbookRangeValues(rangeRef)) {
+                expect(row).toEqual(values[idx++]);
+            }
+        }
+        finally {
+            await tryDeleteDriveItem(workbook);
+        }
+    });
+    it("Multiple requests", async () => {
+        const workbookName = generateTempFileName("xlsx");
+        const workbookPath = driveItemPath(workbookName);
+        const driveRef = getDefaultDriveRef();
+        const workbook = await createWorkbook(driveRef, workbookPath);
+        const worksheetRef = createWorkbookWorksheetRef(workbook, defaultWorkbookWorksheetId);
+        try {
+            const rangeRef = createWorkbookRangeRef(worksheetRef, "A1:C3");
+            const values = [
+                [1, 2, 3],
+                [4, 5, 6],
+                [7, 8, 9],
+            ];
+            await setWorkbookRangeValues(rangeRef, values);
+            await calculateWorkbook(workbook);
+            let idx = 0;
+            for await (const row of iterateWorkbookRangeValues(rangeRef, 1)) {
+                expect(row).toEqual(values[idx++]);
+            }
+        }
+        finally {
+            await tryDeleteDriveItem(workbook);
+        }
+    });
+});

package/dist/tasks/setColumnHidden.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"setColumnHidden.d.ts","sourceRoot":"","sources":["../../src/tasks/setColumnHidden.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAGtE;;;;;;GAMG;AACH,wBAA8B,eAAe,CAAC,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,GAAG,gBAAgB,CAAC,CAIpI"}
+{"version":3,"file":"setColumnHidden.d.ts","sourceRoot":"","sources":["../../src/tasks/setColumnHidden.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AAEtE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAItE;;;;;;GAMG;AACH,wBAA8B,eAAe,CAAC,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,GAAG,gBAAgB,CAAC,CAWpI"}

package/dist/tasks/setColumnHidden.js

@@ -1,4 +1,5 @@
 import updateWorkbookRange from "../operations/workbookRange/updateWorkbookRange.js";
+import { decomposeAddress, isAllColumnsAddress } from "../services/addressManipulation.js";
 /**
  * Hide or show one or more columns.
  *
@@ -7,6 +8,11 @@ import updateWorkbookRange from "../operations/workbookRange/updateWorkbookRange
  * @returns The updated workbook range.
  */
 export default async function setColumnHidden(rangeRef, hidden) {
+    if (isAllColumnsAddress(rangeRef.address)) {
+        throw new Error("Cannot hide all columns");
+    }
+    const components = decomposeAddress(rangeRef.address);
+    rangeRef.address = `${components.startColumn}:${components.endColumn}`; // Workaround API explicitly wanting a range
     return await updateWorkbookRange(rangeRef, {
         columnHidden: hidden,
     });

package/dist/tasks/setColumnHidden.test.js

@@ -11,7 +11,7 @@ import { createWorkbookWorksheetRef, defaultWorkbookWorksheetId } from "../servi
 import setColumnHidden from "./setColumnHidden.js";
 import tryDeleteDriveItem from "./tryDeleteDriveItem.js";
 describe("setColumnHidden", () => {
-    it("hides a column in an existing workbook", async () => {
+    it("hides a single column in an existing workbook", async () => {
         const workbookName = generateTempFileName("xlsx");
         const workbookPath = driveItemPath(workbookName);
         const driveRef = getDefaultDriveRef();
@@ -26,7 +26,7 @@ describe("setColumnHidden", () => {
                     [7, 8, 9],
                 ],
             });
-            const hiddenRange = createWorkbookRangeRef(worksheetRef, "B:B");
+            const hiddenRange = createWorkbookRangeRef(worksheetRef, "B");
             await setColumnHidden(hiddenRange, true);
             await calculateWorkbook(workbook);
             const visibleView = await getWorkbookVisibleRange(rangeRef);
@@ -40,4 +40,29 @@ describe("setColumnHidden", () => {
             await tryDeleteDriveItem(workbook);
         }
     });
+    it("hides a multiple columns in an existing workbook", async () => {
+        const workbookName = generateTempFileName("xlsx");
+        const workbookPath = driveItemPath(workbookName);
+        const driveRef = getDefaultDriveRef();
+        const workbook = await createWorkbook(driveRef, workbookPath);
+        const worksheetRef = createWorkbookWorksheetRef(workbook, defaultWorkbookWorksheetId);
+        try {
+            const rangeRef = createWorkbookRangeRef(worksheetRef, "A1:C3");
+            await updateWorkbookRange(rangeRef, {
+                values: [
+                    [1, 2, 3],
+                    [4, 5, 6],
+                    [7, 8, 9],
+                ],
+            });
+            const hiddenRange = createWorkbookRangeRef(worksheetRef, "B:C");
+            await setColumnHidden(hiddenRange, true);
+            await calculateWorkbook(workbook);
+            const visibleView = await getWorkbookVisibleRange(rangeRef);
+            expect(visibleView.values).toEqual([[1], [4], [7]]);
+        }
+        finally {
+            await tryDeleteDriveItem(workbook);
+        }
+    });
 });

package/dist/tasks/setRowHidden.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"setRowHidden.d.ts","sourceRoot":"","sources":["../../src/tasks/setRowHidden.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAGtE;;;;;;GAMG;AACH,wBAA8B,YAAY,CAAC,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,GAAG,gBAAgB,CAAC,CAIjI"}
+{"version":3,"file":"setRowHidden.d.ts","sourceRoot":"","sources":["../../src/tasks/setRowHidden.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AAEtE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAItE;;;;;;GAMG;AACH,wBAA8B,YAAY,CAAC,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,GAAG,gBAAgB,CAAC,CAWjI"}

package/dist/tasks/setRowHidden.js

@@ -1,4 +1,5 @@
 import updateWorkbookRange from "../operations/workbookRange/updateWorkbookRange.js";
+import { decomposeAddress, isAllRowsAddress } from "../services/addressManipulation.js";
 /**
  * Hide or show one or more rows.
  *
@@ -7,6 +8,11 @@ import updateWorkbookRange from "../operations/workbookRange/updateWorkbookRange
  * @returns The updated workbook range.
  */
 export default async function setRowHidden(rangeRef, hidden) {
+    if (isAllRowsAddress(rangeRef.address)) {
+        throw new Error("Cannot hide all rows");
+    }
+    const components = decomposeAddress(rangeRef.address);
+    rangeRef.address = `${components.startRow}:${components.endRow}`; // Workaround API explicitly wanting a range
     return await updateWorkbookRange(rangeRef, {
         rowHidden: hidden,
     });

package/dist/tasks/setRowHidden.test.js

@@ -11,7 +11,7 @@ import { createWorkbookWorksheetRef, defaultWorkbookWorksheetId } from "../servi
 import setRowHidden from "./setRowHidden.js";
 import tryDeleteDriveItem from "./tryDeleteDriveItem.js";
 describe("setRowHidden", () => {
-    it("hides a row in an existing workbook", async () => {
+    it("hides a single row in an existing workbook", async () => {
         const workbookName = generateTempFileName("xlsx");
         const workbookPath = driveItemPath(workbookName);
         const driveRef = getDefaultDriveRef();
@@ -26,7 +26,7 @@ describe("setRowHidden", () => {
                     [7, 8, 9],
                 ],
             });
-            const hiddenRange = createWorkbookRangeRef(worksheetRef, "2:2");
+            const hiddenRange = createWorkbookRangeRef(worksheetRef, "2");
             await setRowHidden(hiddenRange, true);
             await calculateWorkbook(workbook);
             const visibleView = await getWorkbookVisibleRange(rangeRef);
@@ -39,4 +39,29 @@ describe("setRowHidden", () => {
             await tryDeleteDriveItem(workbook);
         }
     });
+    it("hides multiple rows in an existing workbook", async () => {
+        const workbookName = generateTempFileName("xlsx");
+        const workbookPath = driveItemPath(workbookName);
+        const driveRef = getDefaultDriveRef();
+        const workbook = await createWorkbook(driveRef, workbookPath);
+        const worksheetRef = createWorkbookWorksheetRef(workbook, defaultWorkbookWorksheetId);
+        try {
+            const rangeRef = createWorkbookRangeRef(worksheetRef, "A1:C3");
+            await updateWorkbookRange(rangeRef, {
+                values: [
+                    [1, 2, 3],
+                    [4, 5, 6],
+                    [7, 8, 9],
+                ],
+            });
+            const hiddenRange = createWorkbookRangeRef(worksheetRef, "2:3");
+            await setRowHidden(hiddenRange, true);
+            await calculateWorkbook(workbook);
+            const visibleView = await getWorkbookVisibleRange(rangeRef);
+            expect(visibleView.values).toEqual([[1, 2, 3]]);
+        }
+        finally {
+            await tryDeleteDriveItem(workbook);
+        }
+    });
 });

package/dist/tasks/setWorkbookRangeValues.d.ts

@@ -0,0 +1,11 @@
+import type { CellRangeValues } from "../models/CellRangeValues.ts";
+import type { WorkbookRangeRef } from "../models/WorkbookRangeRef.ts";
+/**
+ * Sets the values of a specified workbook range.
+ *
+ * @param {WorkbookRangeRef} rangeRef - A reference to the workbook range to update.
+ * @param {CellRangeValues} values - The values to set in the specified workbook range. Must match the range's dimensions.
+ * @returns Nothing
+ */
+export default function setWorkbookRangeValues(rangeRef: WorkbookRangeRef, values: CellRangeValues): Promise<void>;
+//# sourceMappingURL=setWorkbookRangeValues.d.ts.map

package/dist/tasks/setWorkbookRangeValues.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setWorkbookRangeValues.d.ts","sourceRoot":"","sources":["../../src/tasks/setWorkbookRangeValues.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAItE;;;;;;GAMG;AACH,wBAA8B,sBAAsB,CAAC,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,eAAe,iBAcvG"}

package/dist/tasks/setWorkbookRangeValues.js

@@ -0,0 +1,23 @@
+import InvalidArgumentError from "../errors/InvalidArgumentError.js";
+import updateWorkbookRange from "../operations/workbookRange/updateWorkbookRange.js";
+import { countAddressColumns, countAddressRows } from "../services/addressManipulation.js";
+/**
+ * Sets the values of a specified workbook range.
+ *
+ * @param {WorkbookRangeRef} rangeRef - A reference to the workbook range to update.
+ * @param {CellRangeValues} values - The values to set in the specified workbook range. Must match the range's dimensions.
+ * @returns Nothing
+ */
+export default async function setWorkbookRangeValues(rangeRef, values) {
+    const rowCount = countAddressRows(rangeRef.address);
+    if (values.length !== rowCount) {
+        throw new InvalidArgumentError(`The number of rows in the values array (${values.length}) does not match the number of rows in the range (${rowCount}).`);
+    }
+    const columnCount = countAddressColumns(rangeRef.address);
+    if (values.some((row) => row.length !== columnCount)) {
+        throw new InvalidArgumentError(`The number of columns in the values array does not match the number of columns in the range (${columnCount}).`);
+    }
+    await updateWorkbookRange(rangeRef, {
+        values: values,
+    });
+}

package/dist/tasks/setWorkbookRangeValues.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=setWorkbookRangeValues.test.d.ts.map

package/dist/tasks/setWorkbookRangeValues.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setWorkbookRangeValues.test.d.ts","sourceRoot":"","sources":["../../src/tasks/setWorkbookRangeValues.test.ts"],"names":[],"mappings":""}

package/dist/tasks/setWorkbookRangeValues.test.js

@@ -0,0 +1,35 @@
+import { describe, expect, it } from "vitest";
+import calculateWorkbook from "../operations/workbook/calculateWorkbook.js";
+import createWorkbook from "../operations/workbook/createWorkbook.js";
+import getWorkbookWorksheetUsedRange from "../operations/workbookWorksheet/getWorkbookWorksheetUsedRange.js";
+import { getDefaultDriveRef } from "../services/drive.js";
+import { driveItemPath } from "../services/driveItem.js";
+import { generateTempFileName } from "../services/temporaryFiles.js";
+import { createWorkbookRangeRef } from "../services/workbookRange.js";
+import { createWorkbookWorksheetRef, defaultWorkbookWorksheetId } from "../services/workbookWorksheet.js";
+import setWorkbookRangeValues from "./setWorkbookRangeValues.js";
+import tryDeleteDriveItem from "./tryDeleteDriveItem.js";
+describe("setWorkbookRangeValues", () => {
+    it("calls updateWorkbookRange with the correct arguments when values match the range dimensions", async () => {
+        const workbookName = generateTempFileName("xlsx");
+        const workbookPath = driveItemPath(workbookName);
+        const driveRef = getDefaultDriveRef();
+        const workbook = await createWorkbook(driveRef, workbookPath);
+        const worksheetRef = createWorkbookWorksheetRef(workbook, defaultWorkbookWorksheetId);
+        try {
+            const rangeRef = createWorkbookRangeRef(worksheetRef, "A1:C3");
+            const values = [
+                [1, 2, 3],
+                [4, 5, 6],
+                [7, 8, 9],
+            ];
+            await setWorkbookRangeValues(rangeRef, values);
+            await calculateWorkbook(workbook);
+            const visibleView = await getWorkbookWorksheetUsedRange(rangeRef);
+            expect(visibleView.values).toEqual(values);
+        }
+        finally {
+            await tryDeleteDriveItem(workbook);
+        }
+    });
+});