microsoft-graph 2.3.0 → 2.4.0

package/dist/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/services/workbookWorksheet.d.ts

@@ -2,6 +2,18 @@ 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/services/workbookWorksheet.d.ts.map

@@ -1 +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,wBAAgB,0BAA0B,CAAC,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,mBAAmB,GAAG,SAAS,GAAG,oBAAoB,CAavI;AAED,wBAAgB,iCAAiC,CAAC,WAAW,EAAE,WAAW,GAAG,oBAAoB,CAEhG"}
+{"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/services/workbookWorksheet.js

@@ -1,4 +1,11 @@
 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");
@@ -12,6 +19,11 @@ export function createWorkbookWorksheetRef(workbookRef, worksheetId) {
         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/tasks/createWorkbookAndStartSession.d.ts

@@ -2,6 +2,12 @@ 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";
-/** One-shot creation of a new workbook and opening a session for that workbook. */
+/**
+ * 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/tasks/createWorkbookAndStartSession.d.ts.map

@@ -1 +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,mFAAmF;AACnF,wBAA8B,6BAA6B,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,aAAa,GAAG,OAAO,CAAC,QAAQ,GAAG,WAAW,CAAC,CAQxI"}
+{"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/tasks/createWorkbookAndStartSession.js

@@ -1,6 +1,12 @@
 import createWorkbook from "../operations/workbook/createWorkbook.js";
 import createWorkbookSession from "../operations/workbookSession/createWorkbookSession.js";
-/** One-shot creation of a new workbook and opening a session for that workbook. */
+/**
+ * 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);

package/dist/tasks/deleteDriveItemWithRetry.d.ts

@@ -1,4 +1,9 @@
 import type { DriveItemRef } from "../models/DriveItemRef.ts";
-/** Delete an item, avoiding locking issues through automatically retrying. */
+/**
+ * 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/tasks/deleteDriveItemWithRetry.d.ts.map

@@ -1 +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,8EAA8E;AAC9E,wBAA8B,wBAAwB,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAahG"}
+{"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/tasks/deleteDriveItemWithRetry.js

@@ -1,6 +1,11 @@
 import deleteDriveItem from "../operations/driveItem/deleteDriveItem.js";
 import { sleep } from "../services/sleep.js";
-/** Delete an item, avoiding locking issues through automatically retrying. */
+/**
+ * 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) {

package/dist/tasks/downloadDriveItemContent.d.ts

@@ -1,4 +1,10 @@
 import type { DriveItemRef } from "../models/DriveItemRef.ts";
-/** Download a DriveItem and save it as a local file. */
+/**
+ * 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/tasks/downloadDriveItemContent.d.ts.map

@@ -1 +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,wDAAwD;AACxD,wBAA8B,wBAAwB,CAAC,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAKlH"}
+{"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/tasks/downloadDriveItemContent.js

@@ -1,6 +1,12 @@
 import { writeFile } from "node:fs/promises";
 import getDriveItemContent from "../operations/driveItem/getDriveItemContent.js";
-/** Download a DriveItem and save it as a local file. */
+/**
+ * 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);

package/dist/tasks/getRangeLastUsedCell.d.ts

@@ -1,5 +1,11 @@
 import type { WorkbookRangeRef } from "../models/WorkbookRangeRef.ts";
-/** Get the last used cell (ie, the most-lower-right) in a given range. */
+/**
+ * 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;

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

@@ -1 +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,0EAA0E;AAC1E,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"}
+{"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/tasks/getRangeLastUsedCell.js

@@ -1,7 +1,13 @@
 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 (ie, the most-lower-right) in a given range. */
+/**
+ * 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"?

package/dist/tasks/getRangeLastUsedCell.test.js

@@ -8,8 +8,8 @@ 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 deleteDriveItemWithRetry from "./deleteDriveItemWithRetry.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");
@@ -33,7 +33,7 @@ describe("getRangeLastUsedCell", () => {
             expect(result.address).toBe("B2");
         }
         finally {
-            await deleteDriveItemWithRetry(workbook);
+            await tryDeleteDriveItem(workbook);
         }
     });
     it("should return the last non-empty cell value when the last cell is empty", async () => {
@@ -58,7 +58,7 @@ describe("getRangeLastUsedCell", () => {
             expect(result.address).toBe("A2");
         }
         finally {
-            await deleteDriveItemWithRetry(workbook);
+            await tryDeleteDriveItem(workbook);
         }
     });
     it("should return null when no cells are used", async () => {
@@ -79,7 +79,7 @@ describe("getRangeLastUsedCell", () => {
             expect(result).toBeNull();
         }
         finally {
-            await deleteDriveItemWithRetry(workbook);
+            await tryDeleteDriveItem(workbook);
         }
     });
 });

package/dist/tasks/getWorkbookTableVisibleBody.d.ts

@@ -1,5 +1,5 @@
 import type { WorkbookRangeView } from "@microsoft/microsoft-graph-types";
 import type { WorkbookTableRef } from "../models/WorkbookTableRef.ts";
-/** Get the visible cells of a workbook table. Ie any hidden cells are omitted. */
+/** @deprecated Use `getWorkbookTableBodyVisibleRange` instead. */
 export declare function getWorkbookTableVisibleBody(tableRef: WorkbookTableRef): Promise<WorkbookRangeView>;
 //# sourceMappingURL=getWorkbookTableVisibleBody.d.ts.map

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

@@ -1 +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,kFAAkF;AAClF,wBAAsB,2BAA2B,CAAC,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAKxG"}
+{"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/tasks/getWorkbookTableVisibleBody.js

@@ -1,6 +1,6 @@
 import getWorkbookVisibleRange from "../operations/workbookRange/getWorkbookVisibleRange.js";
 import getWorkbookTableBodyRange from "../operations/workbookTable/getWorkbookTableBodyRange.js";
-/** Get the visible cells of a workbook table. Ie any hidden cells are omitted. */
+/** @deprecated Use `getWorkbookTableBodyVisibleRange` instead. */
 export async function getWorkbookTableVisibleBody(tableRef) {
     const range = await getWorkbookTableBodyRange(tableRef);
     const visibleRange = await getWorkbookVisibleRange(range);

package/dist/tasks/getWorkbookWorksheetByName.d.ts

@@ -1,6 +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 it's name. Throws error if not found. */
+/**
+ * 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/tasks/getWorkbookWorksheetByName.d.ts.map

@@ -1 +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,+DAA+D;AAC/D,wBAA8B,0BAA0B,CAAC,WAAW,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,GAAG,oBAAoB,CAAC,CAUlJ"}
+{"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/tasks/getWorkbookWorksheetByName.js

@@ -1,6 +1,13 @@
 import NotFoundError from "../errors/NotFoundError.js";
 import listWorkbookWorksheets from "../operations/workbookWorksheet/listWorkbookWorksheets.js";
-/** Get a worksheet by it's name. Throws error if not found. */
+/**
+ * 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);

package/dist/tasks/safeDeleteWorkbook.d.ts

@@ -1,4 +1,10 @@
 import type { WorkbookRef } from "../models/WorkbookRef.ts";
-/** Safely delete a workbook by first closing any open sessions and then delete with a back-off retry to allow for any outstanding locks to be closed. @see https://github.com/Future-Secure-AI/microsoft-graph/blob/main/docs/lockedWorkbook.md */
+/**
+ * Safely delete a workbook by first closing any open sessions and then deleting it with a back-off retry to allow for any outstanding locks to be closed.
+ *
+ * @param workbookRef - A reference to the workbook to be deleted.
+ * @returns Void when the workbook is successfully deleted.
+ * @see https://github.com/Future-Secure-AI/microsoft-graph/blob/main/docs/lockedWorkbook.md
+ */
 export default function safeDeleteWorkbook(workbookRef: WorkbookRef): Promise<void>;
 //# sourceMappingURL=safeDeleteWorkbook.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"safeDeleteWorkbook.d.ts","sourceRoot":"","sources":["../../src/tasks/safeDeleteWorkbook.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAI5D,mPAAmP;AACnP,wBAA8B,kBAAkB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAKxF"}
+{"version":3,"file":"safeDeleteWorkbook.d.ts","sourceRoot":"","sources":["../../src/tasks/safeDeleteWorkbook.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAI5D;;;;;;GAMG;AACH,wBAA8B,kBAAkB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAKxF"}

package/dist/tasks/safeDeleteWorkbook.js

@@ -1,6 +1,12 @@
 import closeWorkbookSession from "../operations/workbookSession/closeWorkbookSession.js";
 import deleteDriveItemWithRetry from "./deleteDriveItemWithRetry.js";
-/** Safely delete a workbook by first closing any open sessions and then delete with a back-off retry to allow for any outstanding locks to be closed. @see https://github.com/Future-Secure-AI/microsoft-graph/blob/main/docs/lockedWorkbook.md */
+/**
+ * Safely delete a workbook by first closing any open sessions and then deleting it with a back-off retry to allow for any outstanding locks to be closed.
+ *
+ * @param workbookRef - A reference to the workbook to be deleted.
+ * @returns Void when the workbook is successfully deleted.
+ * @see https://github.com/Future-Secure-AI/microsoft-graph/blob/main/docs/lockedWorkbook.md
+ */
 export default async function safeDeleteWorkbook(workbookRef) {
     if (workbookRef.sessionId) {
         await closeWorkbookSession(workbookRef);

package/dist/tasks/setColumnHidden.d.ts

@@ -1,5 +1,11 @@
 import type { WorkbookRange } from "@microsoft/microsoft-graph-types";
 import type { WorkbookRangeRef } from "../models/WorkbookRangeRef.ts";
-/** Hide or show one or more columns. */
+/**
+ * Hide or show one or more columns.
+ *
+ * @param rangeRef - A reference to the workbook range representing the columns to hide or show.
+ * @param hidden - A boolean indicating whether to hide (`true`) or show (`false`) the columns.
+ * @returns The updated workbook range.
+ */
 export default function setColumnHidden(rangeRef: WorkbookRangeRef, hidden: boolean): Promise<WorkbookRange & WorkbookRangeRef>;
 //# sourceMappingURL=setColumnHidden.d.ts.map

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,wCAAwC;AACxC,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;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"}

package/dist/tasks/setColumnHidden.js

@@ -1,5 +1,11 @@
 import updateWorkbookRange from "../operations/workbookRange/updateWorkbookRange.js";
-/** Hide or show one or more columns. */
+/**
+ * Hide or show one or more columns.
+ *
+ * @param rangeRef - A reference to the workbook range representing the columns to hide or show.
+ * @param hidden - A boolean indicating whether to hide (`true`) or show (`false`) the columns.
+ * @returns The updated workbook range.
+ */
 export default async function setColumnHidden(rangeRef, hidden) {
     return await updateWorkbookRange(rangeRef, {
         columnHidden: hidden,

package/dist/tasks/setColumnHidden.test.js

@@ -8,8 +8,8 @@ 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 deleteDriveItemWithRetry from "./deleteDriveItemWithRetry.js";
 import setColumnHidden from "./setColumnHidden.js";
+import tryDeleteDriveItem from "./tryDeleteDriveItem.js";
 describe("setColumnHidden", () => {
     it("hides a column in an existing workbook", async () => {
         const workbookName = generateTempFileName("xlsx");
@@ -37,7 +37,7 @@ describe("setColumnHidden", () => {
             ]);
         }
         finally {
-            await deleteDriveItemWithRetry(workbook);
+            await tryDeleteDriveItem(workbook);
         }
     });
 });

package/dist/tasks/setRowHidden.d.ts

@@ -1,5 +1,11 @@
 import type { WorkbookRange } from "@microsoft/microsoft-graph-types";
 import type { WorkbookRangeRef } from "../models/WorkbookRangeRef.ts";
-/** Hide or show one or more rows. */
+/**
+ * Hide or show one or more rows.
+ *
+ * @param rangeRef - A reference to the workbook range representing the rows to hide or show.
+ * @param hidden - A boolean indicating whether to hide (`true`) or show (`false`) the rows.
+ * @returns The updated workbook range.
+ */
 export default function setRowHidden(rangeRef: WorkbookRangeRef, hidden: boolean): Promise<WorkbookRange & WorkbookRangeRef>;
 //# sourceMappingURL=setRowHidden.d.ts.map

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,qCAAqC;AACrC,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;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"}

package/dist/tasks/setRowHidden.js

@@ -1,5 +1,11 @@
 import updateWorkbookRange from "../operations/workbookRange/updateWorkbookRange.js";
-/** Hide or show one or more rows. */
+/**
+ * Hide or show one or more rows.
+ *
+ * @param rangeRef - A reference to the workbook range representing the rows to hide or show.
+ * @param hidden - A boolean indicating whether to hide (`true`) or show (`false`) the rows.
+ * @returns The updated workbook range.
+ */
 export default async function setRowHidden(rangeRef, hidden) {
     return await updateWorkbookRange(rangeRef, {
         rowHidden: hidden,

package/dist/tasks/setRowHidden.test.js

@@ -8,8 +8,8 @@ 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 deleteDriveItemWithRetry from "./deleteDriveItemWithRetry.js";
 import setRowHidden from "./setRowHidden.js";
+import tryDeleteDriveItem from "./tryDeleteDriveItem.js";
 describe("setRowHidden", () => {
     it("hides a row in an existing workbook", async () => {
         const workbookName = generateTempFileName("xlsx");
@@ -36,7 +36,7 @@ describe("setRowHidden", () => {
             ]);
         }
         finally {
-            await deleteDriveItemWithRetry(workbook);
+            await tryDeleteDriveItem(workbook);
         }
     });
 });

package/dist/tasks/setWorkbookTableBodyVisibleRows.d.ts

@@ -1,4 +1,12 @@
 import type { WorkbookTableRef } from "../models/WorkbookTableRef.ts";
-/** Overwrite visible rows of a workbook table with the provided 2D array of values, inserting new rows at the end if needed. THIS IS SLOW as it must check each rows visibility. */
+/**
+ * Overwrite visible rows of a workbook table with the provided 2D array of values, inserting new rows at the end if needed.
+ * THIS IS SLOW as it must check each row's visibility.
+ *
+ * @param tableRef - A reference to the workbook table.
+ * @param values - A 2D array of strings representing the values to set in the visible rows of the table.
+ * @throws {InvalidArgumentError} If the number of columns in any row of `values` does not match the table's column count.
+ * @returns Void when the operation is complete.
+ */
 export declare function setWorkbookTableBodyVisibleRows(tableRef: WorkbookTableRef, values: string[][]): Promise<void>;
 //# sourceMappingURL=setWorkbookTableBodyVisibleRows.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"setWorkbookTableBodyVisibleRows.d.ts","sourceRoot":"","sources":["../../src/tasks/setWorkbookTableBodyVisibleRows.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAQtE,oLAAoL;AACpL,wBAAsB,+BAA+B,CAAC,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CA6BnH"}
+{"version":3,"file":"setWorkbookTableBodyVisibleRows.d.ts","sourceRoot":"","sources":["../../src/tasks/setWorkbookTableBodyVisibleRows.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAQtE;;;;;;;;GAQG;AACH,wBAAsB,+BAA+B,CAAC,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CA4BnH"}

package/dist/tasks/setWorkbookTableBodyVisibleRows.js

@@ -5,30 +5,37 @@ import updateWorkbookRange from "../operations/workbookRange/updateWorkbookRange
 import getWorkbookTableBodyRange from "../operations/workbookTable/getWorkbookTableBodyRange.js";
 import { getFirstRowAddress, incrementRowAddress, isAddressOverlapping } from "../services/addressManipulation.js";
 import { createWorkbookRangeRef } from "../services/workbookRange.js";
-/** Overwrite visible rows of a workbook table with the provided 2D array of values, inserting new rows at the end if needed. THIS IS SLOW as it must check each rows visibility. */
+/**
+ * Overwrite visible rows of a workbook table with the provided 2D array of values, inserting new rows at the end if needed.
+ * THIS IS SLOW as it must check each row's visibility.
+ *
+ * @param tableRef - A reference to the workbook table.
+ * @param values - A 2D array of strings representing the values to set in the visible rows of the table.
+ * @throws {InvalidArgumentError} If the number of columns in any row of `values` does not match the table's column count.
+ * @returns Void when the operation is complete.
+ */
 export async function setWorkbookTableBodyVisibleRows(tableRef, values) {
     const visibleRange = await getWorkbookTableBodyRange(tableRef);
     if (values.some((row) => row.length !== visibleRange.columnCount)) {
         throw new InvalidArgumentError(`Invalid number of columns in input values. Expected all rows to have ${visibleRange.columnCount}.`);
     }
-    const dstFirstRowAddress = getFirstRowAddress(visibleRange.address);
-    let dstCurrentRowAddress = dstFirstRowAddress;
-    for (const srcRowValues of values) {
-        let dstRowRef;
-        let dstRow;
-        let dstRowHidden = false;
+    const firstRowAddress = getFirstRowAddress(visibleRange.address);
+    let currentRowAddress = firstRowAddress;
+    for (const rowValues of values) {
+        let rowRef;
+        let rowHidden = false;
         do {
-            dstRowRef = createWorkbookRangeRef(tableRef, dstCurrentRowAddress);
-            if (isAddressOverlapping(dstCurrentRowAddress, visibleRange.address)) {
-                dstRow = await getWorkbookWorksheetRange(dstRowRef);
-                dstRowHidden = dstRow.rowHidden ?? false;
+            rowRef = createWorkbookRangeRef(tableRef, currentRowAddress);
+            if (isAddressOverlapping(currentRowAddress, visibleRange.address)) {
+                const row = await getWorkbookWorksheetRange(rowRef);
+                rowHidden = row.rowHidden ?? false;
             }
             else {
-                await insertWorkbookCells(dstRowRef, dstRowRef.address, "Down");
-                dstRowHidden = false;
+                await insertWorkbookCells(rowRef, rowRef.address, "Down");
+                rowHidden = false;
             }
-            dstCurrentRowAddress = incrementRowAddress(dstCurrentRowAddress);
-        } while (dstRowHidden);
-        await updateWorkbookRange(dstRowRef, { values: [srcRowValues] });
+            currentRowAddress = incrementRowAddress(currentRowAddress);
+        } while (rowHidden);
+        await updateWorkbookRange(rowRef, { values: [rowValues] });
     }
 }

package/dist/tasks/setWorkbookTableBodyVisibleRows.test.js

@@ -3,15 +3,15 @@ import calculateWorkbook from "../operations/workbook/calculateWorkbook.js";
 import createWorkbook from "../operations/workbook/createWorkbook.js";
 import updateWorkbookRange from "../operations/workbookRange/updateWorkbookRange.js";
 import createWorkbookTable from "../operations/workbookTable/createWorkbookTable.js";
+import getWorkbookTableBodyVisibleRange from "../operations/workbookTable/getWorkbookTableBodyVisibleRange.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 { createDefaultWorkbookWorksheetRef } from "../services/workbookWorksheet.js";
-import deleteDriveItemWithRetry from "./deleteDriveItemWithRetry.js";
-import { getWorkbookTableVisibleBody } from "./getWorkbookTableVisibleBody.js";
 import setRowHidden from "./setRowHidden.js";
 import { setWorkbookTableBodyVisibleRows } from "./setWorkbookTableBodyVisibleRows.js";
+import tryDeleteDriveItem from "./tryDeleteDriveItem.js";
 describe("setWorkbookTableBodyVisibleRows", () => {
     it("writes input rows to visible rows of a table", { timeout: 30000 }, async () => {
         const workbookName = generateTempFileName("xlsx");
@@ -31,12 +31,12 @@ describe("setWorkbookTableBodyVisibleRows", () => {
                 ],
             });
             await setRowHidden(createWorkbookRangeRef(worksheetRef, "A3:A3"), true);
-            await calculateWorkbook(workbook);
             await setWorkbookTableBodyVisibleRows(table, [
                 ["NewValue1", "NewValue2", "NewValue3", "NewValue4"],
                 ["NewValue5", "NewValue6", "NewValue7", "NewValue8"],
             ]);
-            const visibleBodyRange = await getWorkbookTableVisibleBody(table);
+            await calculateWorkbook(workbook);
+            const visibleBodyRange = await getWorkbookTableBodyVisibleRange(table);
             expect(visibleBodyRange.values).toEqual([
                 ["NewValue1", "NewValue2", "NewValue3", "NewValue4"],
                 ["OldValue5", "OldValue6", "OldValue7", "OldValue8"],
@@ -44,7 +44,7 @@ describe("setWorkbookTableBodyVisibleRows", () => {
             ]);
         }
         finally {
-            await deleteDriveItemWithRetry(workbook);
+            await tryDeleteDriveItem(workbook);
         }
     });
     it("writes input rows to visible rows of a table with insert", { timeout: 30000 }, async () => {
@@ -64,20 +64,22 @@ describe("setWorkbookTableBodyVisibleRows", () => {
                 ],
             });
             await setRowHidden(createWorkbookRangeRef(worksheetRef, "A3:A3"), true);
-            await calculateWorkbook(workbook);
             await setWorkbookTableBodyVisibleRows(table, [
                 ["NewValue1", "NewValue2", "NewValue3", "NewValue4"],
                 ["NewValue5", "NewValue6", "NewValue7", "NewValue8"],
+                ["NewValue9", "NewValue10", "NewValue11", "NewValue12"],
             ]);
-            const visibleBodyRange = await getWorkbookTableVisibleBody(table);
+            await calculateWorkbook(workbook);
+            const visibleBodyRange = await getWorkbookTableBodyVisibleRange(table);
             expect(visibleBodyRange.values).toEqual([
                 ["NewValue1", "NewValue2", "NewValue3", "NewValue4"],
                 ["OldValue5", "OldValue6", "OldValue7", "OldValue8"],
                 ["NewValue5", "NewValue6", "NewValue7", "NewValue8"],
+                ["NewValue9", "NewValue10", "NewValue11", "NewValue12"],
             ]);
         }
         finally {
-            await deleteDriveItemWithRetry(workbook);
+            await tryDeleteDriveItem(workbook);
         }
     });
 });

package/dist/tasks/tryDeleteDriveItem.d.ts

@@ -0,0 +1,9 @@
+import type { DriveItemRef } from "../models/DriveItemRef.ts";
+/**
+ * Attempts to delete a DriveItem, returning a boolean indicating success or failure.
+ *
+ * @param driveItemRef - A reference to the DriveItem to delete.
+ * @returns A boolean indicating whether the DriveItem was successfully deleted.
+ */
+export default function tryDeleteDriveItem(driveItemRef: DriveItemRef): Promise<boolean>;
+//# sourceMappingURL=tryDeleteDriveItem.d.ts.map

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

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