microsoft-graph 2.6.0 → 2.7.0

package/dist/esm/services/temporaryFiles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"temporaryFiles.d.ts","sourceRoot":"","sources":["../../../src/services/temporaryFiles.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAGhE;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,SAAS,GAAE,MAAM,GAAG,IAAY,GAAG,aAAa,CAGpF"}

package/dist/esm/services/temporaryFiles.js

@@ -0,0 +1,10 @@
+import { generateRandomString } from "./random.js";
+/**
+ * Generates a temporary file name with the specified extension.
+ * @param extension - The file extension. Defaults to "tmp".
+ * @returns A temporary file name.
+ */
+export function generateTempFileName(extension = "tmp") {
+    const body = generateRandomString(16);
+    return `~${body}.${extension}`;
+}

package/dist/esm/services/workbookRange.d.ts

@@ -0,0 +1,11 @@
+import type { Address } from "../models/Address.ts";
+import type { WorkbookRangeRef } from "../models/WorkbookRangeRef.ts";
+import type { WorkbookWorksheetRef } from "../models/WorkbookWorksheetRef.ts";
+/**
+ * Creates a reference to a workbook range.
+ * @param worksheetRef - The reference to the worksheet containing the range.
+ * @param address - The address of the range.
+ * @returns A reference to the workbook range.
+ */
+export declare function createWorkbookRangeRef(worksheetRef: WorkbookWorksheetRef, address: Address): WorkbookRangeRef;
+//# sourceMappingURL=workbookRange.d.ts.map

package/dist/esm/services/workbookRange.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workbookRange.d.ts","sourceRoot":"","sources":["../../../src/services/workbookRange.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACtE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAE9E;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,YAAY,EAAE,oBAAoB,EAAE,OAAO,EAAE,OAAO,GAAG,gBAAgB,CAU7G"}

package/dist/esm/services/workbookRange.js

@@ -0,0 +1,17 @@
+/**
+ * Creates a reference to a workbook range.
+ * @param worksheetRef - The reference to the worksheet containing the range.
+ * @param address - The address of the range.
+ * @returns A reference to the workbook range.
+ */
+export function createWorkbookRangeRef(worksheetRef, address) {
+    return {
+        contextId: worksheetRef.contextId,
+        siteId: worksheetRef.siteId,
+        driveId: worksheetRef.driveId,
+        itemId: worksheetRef.itemId,
+        sessionId: worksheetRef.sessionId,
+        worksheetId: worksheetRef.worksheetId,
+        address: address,
+    };
+}

package/dist/esm/services/workbookTable.d.ts

@@ -0,0 +1,12 @@
+import type { WorkbookTableId } from "../models/WorkbookTableId.ts";
+import type { WorkbookTableRef } from "../models/WorkbookTableRef.ts";
+import type { WorkbookWorksheetRef } from "../models/WorkbookWorksheetRef.ts";
+/**
+ * Creates a reference to a workbook table.
+ * @param worksheetRef - The reference to the worksheet containing the table.
+ * @param tableId - The ID of the table.
+ * @returns A reference to the workbook table.
+ * @throws Error if the table ID is missing.
+ */
+export declare function createWorkbookTableRef(worksheetRef: WorkbookWorksheetRef, tableId: WorkbookTableId | undefined): WorkbookTableRef;
+//# sourceMappingURL=workbookTable.d.ts.map

package/dist/esm/services/workbookTable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workbookTable.d.ts","sourceRoot":"","sources":["../../../src/services/workbookTable.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACtE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAE9E;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,YAAY,EAAE,oBAAoB,EAAE,OAAO,EAAE,eAAe,GAAG,SAAS,GAAG,gBAAgB,CAcjI"}

package/dist/esm/services/workbookTable.js

@@ -0,0 +1,21 @@
+/**
+ * Creates a reference to a workbook table.
+ * @param worksheetRef - The reference to the worksheet containing the table.
+ * @param tableId - The ID of the table.
+ * @returns A reference to the workbook table.
+ * @throws Error if the table ID is missing.
+ */
+export function createWorkbookTableRef(worksheetRef, tableId) {
+    if (!tableId) {
+        throw new Error("TableId is missing");
+    }
+    return {
+        contextId: worksheetRef.contextId,
+        siteId: worksheetRef.siteId,
+        driveId: worksheetRef.driveId,
+        itemId: worksheetRef.itemId,
+        worksheetId: worksheetRef.worksheetId,
+        sessionId: worksheetRef.sessionId,
+        tableId: tableId,
+    };
+}

package/dist/esm/services/workbookTableColumn.d.ts

@@ -0,0 +1,12 @@
+import type { ColumnAddress } from "../models/Address.ts";
+import type { WorkbookTableColumnRef } from "../models/WorkbookTableColumnRef.ts";
+import type { WorkbookTableRef } from "../models/WorkbookTableRef.ts";
+/**
+ * Creates a reference to a workbook table column.
+ * @param tableRef - The reference to the worksheet containing the table.
+ * @param column  - The ID of the table.
+ * @returns A reference to the workbook table.
+ * @throws Error if the table ID is missing.
+ */
+export declare function createWorkbookTableColumnRef(tableRef: WorkbookTableRef, column: ColumnAddress | undefined): WorkbookTableColumnRef;
+//# sourceMappingURL=workbookTableColumn.d.ts.map

package/dist/esm/services/workbookTableColumn.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workbookTableColumn.d.ts","sourceRoot":"","sources":["../../../src/services/workbookTableColumn.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAClF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAEtE;;;;;;GAMG;AACH,wBAAgB,4BAA4B,CAAC,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,aAAa,GAAG,SAAS,GAAG,sBAAsB,CAelI"}

package/dist/esm/services/workbookTableColumn.js

@@ -0,0 +1,22 @@
+/**
+ * Creates a reference to a workbook table column.
+ * @param tableRef - The reference to the worksheet containing the table.
+ * @param column  - The ID of the table.
+ * @returns A reference to the workbook table.
+ * @throws Error if the table ID is missing.
+ */
+export function createWorkbookTableColumnRef(tableRef, column) {
+    if (!column) {
+        throw new Error("TableId is missing");
+    }
+    return {
+        contextId: tableRef.contextId,
+        siteId: tableRef.siteId,
+        driveId: tableRef.driveId,
+        itemId: tableRef.itemId,
+        worksheetId: tableRef.worksheetId,
+        sessionId: tableRef.sessionId,
+        tableId: tableRef.tableId,
+        column: column,
+    };
+}

package/dist/esm/services/workbookWorksheet.d.ts

@@ -0,0 +1,19 @@
+import type { WorkbookRef } from "../models/WorkbookRef.ts";
+import type { WorkbookWorksheetId } from "../models/WorkbookWorksheetId.ts";
+import type { WorkbookWorksheetRef } from "../models/WorkbookWorksheetRef.ts";
+export declare const defaultWorkbookWorksheetId: WorkbookWorksheetId;
+/**
+ * Creates a reference to a workbook worksheet.
+ * @param workbookRef - The reference to the workbook.
+ * @param worksheetId - The ID of the worksheet.
+ * @returns A reference to the workbook worksheet.
+ * @throws Error if the worksheet ID is missing.
+ */
+export declare function createWorkbookWorksheetRef(workbookRef: WorkbookRef, worksheetId: WorkbookWorksheetId | undefined): WorkbookWorksheetRef;
+/**
+ * Creates a reference to the default workbook worksheet that is initially included in all new workbooks.
+ * @param workbookRef - The reference to the workbook.
+ * @returns A reference to the default workbook worksheet.
+ */
+export declare function createDefaultWorkbookWorksheetRef(workbookRef: WorkbookRef): WorkbookWorksheetRef;
+//# sourceMappingURL=workbookWorksheet.d.ts.map

package/dist/esm/services/workbookWorksheet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workbookWorksheet.d.ts","sourceRoot":"","sources":["../../../src/services/workbookWorksheet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAC5E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAE9E,eAAO,MAAM,0BAA0B,EAA+C,mBAAmB,CAAC;AAE1G;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CAAC,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,mBAAmB,GAAG,SAAS,GAAG,oBAAoB,CAavI;AAED;;;;GAIG;AACH,wBAAgB,iCAAiC,CAAC,WAAW,EAAE,WAAW,GAAG,oBAAoB,CAEhG"}

package/dist/esm/services/workbookWorksheet.js

@@ -0,0 +1,29 @@
+export const defaultWorkbookWorksheetId = "{00000000-0001-0000-0000-000000000000}"; // Program Manager in Microsoft Office Extensibility team says this ID is used for the first sheet of all workbooks by design, but not documented. https://github.com/OfficeDev/office-js/issues/552#issuecomment-800841930
+/**
+ * Creates a reference to a workbook worksheet.
+ * @param workbookRef - The reference to the workbook.
+ * @param worksheetId - The ID of the worksheet.
+ * @returns A reference to the workbook worksheet.
+ * @throws Error if the worksheet ID is missing.
+ */
+export function createWorkbookWorksheetRef(workbookRef, worksheetId) {
+    if (!worksheetId) {
+        throw new Error("WorksheetID is missing");
+    }
+    return {
+        contextId: workbookRef.contextId,
+        siteId: workbookRef.siteId,
+        driveId: workbookRef.driveId,
+        itemId: workbookRef.itemId,
+        sessionId: workbookRef.sessionId,
+        worksheetId,
+    };
+}
+/**
+ * Creates a reference to the default workbook worksheet that is initially included in all new workbooks.
+ * @param workbookRef - The reference to the workbook.
+ * @returns A reference to the default workbook worksheet.
+ */
+export function createDefaultWorkbookWorksheetRef(workbookRef) {
+    return createWorkbookWorksheetRef(workbookRef, defaultWorkbookWorksheetId);
+}

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

@@ -0,0 +1,13 @@
+import type { Workbook } from "@microsoft/microsoft-graph-types";
+import type { DriveItemPath } from "../models/DriveItemPath.ts";
+import type { DriveRef } from "../models/DriveRef.ts";
+import type { WorkbookRef } from "../models/WorkbookRef.ts";
+/**
+ * Create a new workbook and open a session for that workbook in a single operation.
+ *
+ * @param driveRef - A reference to the drive where the workbook will be created.
+ * @param itemPath - The path of the new workbook within the drive.
+ * @returns The created workbook and session details.
+ */
+export default function createWorkbookAndStartSession(driveRef: DriveRef, itemPath: DriveItemPath): Promise<Workbook & WorkbookRef>;
+//# sourceMappingURL=createWorkbookAndStartSession.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"createWorkbookAndStartSession.d.ts","sourceRoot":"","sources":["../../../src/tasks/createWorkbookAndStartSession.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAI5D;;;;;;GAMG;AACH,wBAA8B,6BAA6B,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,aAAa,GAAG,OAAO,CAAC,QAAQ,GAAG,WAAW,CAAC,CAQxI"}

package/dist/esm/tasks/createWorkbookAndStartSession.js

@@ -0,0 +1,17 @@
+import createWorkbook from "../operations/workbook/createWorkbook.js";
+import createWorkbookSession from "../operations/workbookSession/createWorkbookSession.js";
+/**
+ * Create a new workbook and open a session for that workbook in a single operation.
+ *
+ * @param driveRef - A reference to the drive where the workbook will be created.
+ * @param itemPath - The path of the new workbook within the drive.
+ * @returns The created workbook and session details.
+ */
+export default async function createWorkbookAndStartSession(driveRef, itemPath) {
+    const workbook = await createWorkbook(driveRef, itemPath);
+    const workbookRef = await createWorkbookSession(workbook);
+    return {
+        ...workbook,
+        ...workbookRef,
+    };
+}

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

@@ -0,0 +1,9 @@
+import type { DriveItemRef } from "../models/DriveItemRef.ts";
+/**
+ * Delete a DriveItem, avoiding locking issues through automatic retries.
+ *
+ * @param driveItemRef - A reference to the DriveItem to delete.
+ * @returns Void when the DriveItem is successfully deleted.
+ */
+export default function deleteDriveItemWithRetry(driveItemRef: DriveItemRef): Promise<void>;
+//# sourceMappingURL=deleteDriveItemWithRetry.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"deleteDriveItemWithRetry.d.ts","sourceRoot":"","sources":["../../../src/tasks/deleteDriveItemWithRetry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAI9D;;;;;GAKG;AACH,wBAA8B,wBAAwB,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAahG"}

package/dist/esm/tasks/deleteDriveItemWithRetry.js

@@ -0,0 +1,21 @@
+import deleteDriveItem from "../operations/driveItem/deleteDriveItem.js";
+import { sleep } from "../services/sleep.js";
+/**
+ * Delete a DriveItem, avoiding locking issues through automatic retries.
+ *
+ * @param driveItemRef - A reference to the DriveItem to delete.
+ * @returns Void when the DriveItem is successfully deleted.
+ */
+export default async function deleteDriveItemWithRetry(driveItemRef) {
+    const retryDelays = [1000, 2000, 4000];
+    for (const delay of retryDelays) {
+        try {
+            await deleteDriveItem(driveItemRef);
+            return;
+        }
+        catch (_) {
+            await sleep(delay);
+        }
+    }
+    await deleteDriveItem(driveItemRef);
+}

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

@@ -0,0 +1,10 @@
+import type { DriveItemRef } from "../models/DriveItemRef.ts";
+/**
+ * Download a DriveItem and save it as a local file.
+ *
+ * @param itemRef - A reference to the DriveItem to download.
+ * @param localFilePath - The local file path where the content should be saved.
+ * @returns Void when the content is successfully downloaded and saved.
+ */
+export default function downloadDriveItemContent(itemRef: DriveItemRef, localFilePath: string): Promise<void>;
+//# sourceMappingURL=downloadDriveItemContent.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"downloadDriveItemContent.d.ts","sourceRoot":"","sources":["../../../src/tasks/downloadDriveItemContent.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAG9D;;;;;;GAMG;AACH,wBAA8B,wBAAwB,CAAC,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAKlH"}

package/dist/esm/tasks/downloadDriveItemContent.js

@@ -0,0 +1,14 @@
+import { writeFile } from "node:fs/promises";
+import getDriveItemContent from "../operations/driveItem/getDriveItemContent.js";
+/**
+ * Download a DriveItem and save it as a local file.
+ *
+ * @param itemRef - A reference to the DriveItem to download.
+ * @param localFilePath - The local file path where the content should be saved.
+ * @returns Void when the content is successfully downloaded and saved.
+ */
+export default async function downloadDriveItemContent(itemRef, localFilePath) {
+    const arrayBuffer = await getDriveItemContent(itemRef);
+    const buffer = Buffer.from(arrayBuffer);
+    await writeFile(localFilePath, buffer);
+}

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

@@ -0,0 +1,13 @@
+import type { WorkbookRangeRef } from "../models/WorkbookRangeRef.ts";
+/**
+ * Get the last used cell (i.e., the most lower-right cell) in a given range.
+ *
+ * @param rangeRef - A reference to the workbook range to search.
+ * @throws {ProtocolError} If the range's row or column counts, or values, are missing.
+ * @returns The last used cell's value and address, or `null` if no cells are used.
+ */
+export default function getRangeLastUsedCell(rangeRef: WorkbookRangeRef): Promise<{
+    value: string | number | boolean | null;
+    address: string;
+} | null>;
+//# sourceMappingURL=getRangeLastUsedCell.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getRangeLastUsedCell.d.ts","sourceRoot":"","sources":["../../../src/tasks/getRangeLastUsedCell.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAItE;;;;;;GAMG;AACH,wBAA8B,oBAAoB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAC;IAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAAC,CAyC3J"}

package/dist/esm/tasks/getRangeLastUsedCell.js

@@ -0,0 +1,44 @@
+import ProtocolError from "../errors/ProtocolError.js";
+import getWorkbookWorksheetRange from "../operations/workbookRange/getWorkbookWorksheetRange.js";
+import { getFirstCellAddress, offsetAddress } from "../services/addressManipulation.js";
+/**
+ * Get the last used cell (i.e., the most lower-right cell) in a given range.
+ *
+ * @param rangeRef - A reference to the workbook range to search.
+ * @throws {ProtocolError} If the range's row or column counts, or values, are missing.
+ * @returns The last used cell's value and address, or `null` if no cells are used.
+ */
+export default async function getRangeLastUsedCell(rangeRef) {
+    // TODO: Consider adding chunking if the range is too large
+    // TODO: Reduce cells returned by using "used range"?
+    const range = await getWorkbookWorksheetRange(rangeRef);
+    const { rowCount, columnCount } = range;
+    if (rowCount === undefined || columnCount === undefined) {
+        throw new ProtocolError("Counts missing");
+    }
+    const values = range.values;
+    if (values === undefined) {
+        throw new ProtocolError("Range values missing");
+    }
+    for (let rowIndex = (rowCount - 1); rowIndex >= 0; rowIndex--) {
+        const row = values[rowIndex];
+        if (row === undefined) {
+            throw new ProtocolError("Row missing");
+        }
+        for (let columnIndex = (columnCount - 1); columnIndex >= 0; columnIndex--) {
+            const cell = row[columnIndex];
+            if (cell === undefined) {
+                throw new ProtocolError("Cell missing");
+            }
+            if (cell !== null && cell !== "") {
+                const firstCellAddress = getFirstCellAddress(rangeRef.address);
+                const lastUsedCellAddress = offsetAddress(firstCellAddress, columnIndex, rowIndex);
+                return {
+                    value: cell,
+                    address: lastUsedCellAddress,
+                };
+            }
+        }
+    }
+    return null;
+}

package/dist/esm/tasks/getRangeLastUsedCell.test.d.ts

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

package/dist/esm/tasks/getRangeLastUsedCell.test.d.ts.map

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

package/dist/esm/tasks/getRangeLastUsedCell.test.js

@@ -0,0 +1,85 @@
+import { describe, expect, it } from "vitest";
+import { sequential } from "../graphApi.js";
+import calculateWorkbook from "../operations/workbook/calculateWorkbook.js";
+import createWorkbook from "../operations/workbook/createWorkbook.js";
+import updateWorkbookRange from "../operations/workbookRange/updateWorkbookRange.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 getRangeLastUsedCell from "./getRangeLastUsedCell.js";
+import tryDeleteDriveItem from "./tryDeleteDriveItem.js";
+describe("getRangeLastUsedCell", () => {
+    it("should return the last used cell value", async () => {
+        const workbookName = generateTempFileName("xlsx");
+        const workbookPath = driveItemPath(workbookName);
+        const driveRef = getDefaultDriveRef();
+        const workbook = await createWorkbook(driveRef, workbookPath);
+        const worksheetRef = createWorkbookWorksheetRef(workbook, defaultWorkbookWorksheetId);
+        const rangeRef = createWorkbookRangeRef(worksheetRef, "A1:B2");
+        try {
+            await sequential(updateWorkbookRange(rangeRef, {
+                values: [
+                    [1, 2],
+                    [3, 4],
+                ],
+            }), calculateWorkbook(workbook));
+            const result = await getRangeLastUsedCell(rangeRef);
+            if (result === null) {
+                throw new Error("Expected a result");
+            }
+            expect(result.value).toBe(4);
+            expect(result.address).toBe("B2");
+        }
+        finally {
+            await tryDeleteDriveItem(workbook);
+        }
+    });
+    it("should return the last non-empty cell value when the last cell is empty", async () => {
+        const workbookName = generateTempFileName("xlsx");
+        const workbookPath = driveItemPath(workbookName);
+        const driveRef = getDefaultDriveRef();
+        const workbook = await createWorkbook(driveRef, workbookPath);
+        const worksheetRef = createWorkbookWorksheetRef(workbook, defaultWorkbookWorksheetId);
+        const rangeRef = createWorkbookRangeRef(worksheetRef, "A1:B2");
+        try {
+            await sequential(updateWorkbookRange(rangeRef, {
+                values: [
+                    [1, 2],
+                    [3, null],
+                ],
+            }), calculateWorkbook(workbook));
+            const result = await getRangeLastUsedCell(rangeRef);
+            if (result === null) {
+                throw new Error("Expected a result");
+            }
+            expect(result.value).toBe(3);
+            expect(result.address).toBe("A2");
+        }
+        finally {
+            await tryDeleteDriveItem(workbook);
+        }
+    });
+    it("should return null when no cells are used", async () => {
+        const workbookName = generateTempFileName("xlsx");
+        const workbookPath = driveItemPath(workbookName);
+        const driveRef = getDefaultDriveRef();
+        const workbook = await createWorkbook(driveRef, workbookPath);
+        const worksheetRef = createWorkbookWorksheetRef(workbook, defaultWorkbookWorksheetId);
+        const rangeRef = createWorkbookRangeRef(worksheetRef, "A1:B2");
+        try {
+            await sequential(updateWorkbookRange(rangeRef, {
+                values: [
+                    [null, null],
+                    [null, null],
+                ],
+            }), calculateWorkbook(workbook));
+            const result = await getRangeLastUsedCell(rangeRef);
+            expect(result).toBeNull();
+        }
+        finally {
+            await tryDeleteDriveItem(workbook);
+        }
+    });
+});

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

@@ -0,0 +1,5 @@
+import type { WorkbookRangeView } from "@microsoft/microsoft-graph-types";
+import type { WorkbookTableRef } from "../models/WorkbookTableRef.ts";
+/** @deprecated Use `getWorkbookTableBodyVisibleRange` instead. */
+export declare function getWorkbookTableVisibleBody(tableRef: WorkbookTableRef): Promise<WorkbookRangeView>;
+//# sourceMappingURL=getWorkbookTableVisibleBody.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getWorkbookTableVisibleBody.d.ts","sourceRoot":"","sources":["../../../src/tasks/getWorkbookTableVisibleBody.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAC1E,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAItE,kEAAkE;AAClE,wBAAsB,2BAA2B,CAAC,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAKxG"}

package/dist/esm/tasks/getWorkbookTableVisibleBody.js

@@ -0,0 +1,8 @@
+import getWorkbookVisibleRange from "../operations/workbookRange/getWorkbookVisibleRange.js";
+import getWorkbookTableBodyRange from "../operations/workbookTable/getWorkbookTableBodyRange.js";
+/** @deprecated Use `getWorkbookTableBodyVisibleRange` instead. */
+export async function getWorkbookTableVisibleBody(tableRef) {
+    const range = await getWorkbookTableBodyRange(tableRef);
+    const visibleRange = await getWorkbookVisibleRange(range);
+    return visibleRange;
+}

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

@@ -0,0 +1,13 @@
+import type { WorkbookWorksheet } from "@microsoft/microsoft-graph-types";
+import type { WorkbookRef } from "../models/WorkbookRef.ts";
+import type { WorkbookWorksheetRef } from "../models/WorkbookWorksheetRef.ts";
+/**
+ * Get a worksheet by its name. Throws an error if not found.
+ *
+ * @param workbookRef - A reference to the workbook containing the worksheet.
+ * @param name - The name of the worksheet to retrieve.
+ * @throws {NotFoundError} If the worksheet with the specified name is not found.
+ * @returns The worksheet details.
+ */
+export default function getWorkbookWorksheetByName(workbookRef: WorkbookRef, name: string): Promise<WorkbookWorksheet & WorkbookWorksheetRef>;
+//# sourceMappingURL=getWorkbookWorksheetByName.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getWorkbookWorksheetByName.d.ts","sourceRoot":"","sources":["../../../src/tasks/getWorkbookWorksheetByName.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAE1E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAG9E;;;;;;;GAOG;AACH,wBAA8B,0BAA0B,CAAC,WAAW,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,GAAG,oBAAoB,CAAC,CAUlJ"}

package/dist/esm/tasks/getWorkbookWorksheetByName.js

@@ -0,0 +1,19 @@
+import NotFoundError from "../errors/NotFoundError.js";
+import listWorkbookWorksheets from "../operations/workbookWorksheet/listWorkbookWorksheets.js";
+/**
+ * Get a worksheet by its name. Throws an error if not found.
+ *
+ * @param workbookRef - A reference to the workbook containing the worksheet.
+ * @param name - The name of the worksheet to retrieve.
+ * @throws {NotFoundError} If the worksheet with the specified name is not found.
+ * @returns The worksheet details.
+ */
+export default async function getWorkbookWorksheetByName(workbookRef, name) {
+    // TODO: More performant to get it by a direct call without listing all workbooks?
+    const worksheets = await listWorkbookWorksheets(workbookRef);
+    const worksheet = worksheets.find((worksheetRef) => worksheetRef.name === name);
+    if (!worksheet) {
+        throw new NotFoundError(`Worksheet '${name}' not found.`);
+    }
+    return worksheet;
+}

package/dist/esm/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/esm/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/esm/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/esm/tasks/iterateWorkbookRangeValues.test.d.ts

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

package/dist/esm/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":""}