microsoft-graph 2.6.0 → 2.7.0

package/dist/esm/operations/workbookTable/listWorkbookTables.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"listWorkbookTables.d.ts","sourceRoot":"","sources":["../../../../src/operations/workbookTable/listWorkbookTables.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AAEtE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAE/D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAIjF;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,kBAAkB,CAAC,YAAY,EAAE,oBAAoB,GAAG,cAAc,CAAC,CAAC,aAAa,GAAG,WAAW,CAAC,EAAE,CAAC,CAwB9H"}

package/dist/esm/operations/workbookTable/listWorkbookTables.js

@@ -0,0 +1,32 @@
+import { operation } from "../../graphApi.js";
+import { generatePath } from "../../services/templatedPaths.js";
+import { createWorkbookTableRef } from "../../services/workbookTable.js";
+/**
+ * Retrieve a list of tables in a worksheet.
+ *
+ * @param worksheetRef - A reference to the worksheet, optionally including session information.
+ * @returns An array of tables, each including its metadata and reference information.
+ * @see https://learn.microsoft.com/en-us/graph/api/worksheet-list-tables
+ */
+export default function listWorkbookTables(worksheetRef) {
+    return operation({
+        contextId: worksheetRef.contextId,
+        method: "GET",
+        path: generatePath("/sites/{site-id}/drives/{drive-id}/items/{item-id}/workbook/worksheets/{worksheet-id}/tables", worksheetRef),
+        headers: {
+            "workbook-session-id": worksheetRef.sessionId,
+        },
+        body: null,
+        responseTransform: (response) => {
+            const list = response;
+            const tables = list.value.map((table) => {
+                const tableRef = createWorkbookTableRef(worksheetRef, table.id);
+                return {
+                    ...table,
+                    ...tableRef,
+                };
+            });
+            return tables;
+        },
+    });
+}

package/dist/esm/operations/workbookTable/listWorkbookTables.test.d.ts

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

package/dist/esm/operations/workbookTable/listWorkbookTables.test.d.ts.map

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

package/dist/esm/operations/workbookTable/listWorkbookTables.test.js

@@ -0,0 +1,30 @@
+import { describe, expect, it } from "vitest";
+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 tryDeleteDriveItem from "../../tasks/tryDeleteDriveItem.js";
+import calculateWorkbook from "../workbook/calculateWorkbook.js";
+import createWorkbook from "../workbook/createWorkbook.js";
+import createWorkbookTable from "./createWorkbookTable.js";
+import listTables from "./listWorkbookTables.js";
+describe("listWorkbookTables", () => {
+    it("can list tables in an existing worksheet", async () => {
+        const workbookName = generateTempFileName("xlsx");
+        const workbookPath = driveItemPath(workbookName);
+        const driveRef = getDefaultDriveRef();
+        const workbook = await createWorkbook(driveRef, workbookPath);
+        try {
+            const worksheetRef = createDefaultWorkbookWorksheetRef(workbook);
+            const rangeRef = createWorkbookRangeRef(worksheetRef, "A1:D4");
+            await createWorkbookTable(rangeRef, true);
+            await calculateWorkbook(workbook);
+            const tables = await listTables(worksheetRef);
+            expect(tables.length).toBeGreaterThan(0);
+        }
+        finally {
+            await tryDeleteDriveItem(workbook);
+        }
+    });
+});

package/dist/esm/operations/workbookWorksheet/createWorkbookWorksheet.d.ts

@@ -0,0 +1,15 @@
+import type { WorkbookWorksheet } from "@microsoft/microsoft-graph-types";
+import type { GraphOperation } from "../../models/GraphOperation.ts";
+import type { WorkbookRef } from "../../models/WorkbookRef.ts";
+import type { WorkbookWorksheetName } from "../../models/WorkbookWorksheetName.ts";
+import type { WorkbookWorksheetRef } from "../../models/WorkbookWorksheetRef.ts";
+/**
+ * Create a new worksheet in a workbook, optionally with a defined name.
+ *
+ * @param workbookRef - A reference to the workbook where the worksheet will be created, optionally including session information.
+ * @param name - (Optional) The name of the new worksheet.
+ * @returns The newly created worksheet, including its metadata and reference information.
+ * @see https://learn.microsoft.com/en-us/graph/api/worksheetcollection-add
+ */
+export default function createWorkbookWorksheet(workbookRef: WorkbookRef, name?: WorkbookWorksheetName): GraphOperation<WorkbookWorksheet & WorkbookWorksheetRef>;
+//# sourceMappingURL=createWorkbookWorksheet.d.ts.map

package/dist/esm/operations/workbookWorksheet/createWorkbookWorksheet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createWorkbookWorksheet.d.ts","sourceRoot":"","sources":["../../../../src/operations/workbookWorksheet/createWorkbookWorksheet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAE1E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAE/D,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AACnF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAIjF;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,UAAU,uBAAuB,CAAC,WAAW,EAAE,WAAW,EAAE,IAAI,CAAC,EAAE,qBAAqB,GAAG,cAAc,CAAC,iBAAiB,GAAG,oBAAoB,CAAC,CAsBhK"}

package/dist/esm/operations/workbookWorksheet/createWorkbookWorksheet.js

@@ -0,0 +1,33 @@
+import { operation } from "../../graphApi.js";
+import { generatePath } from "../../services/templatedPaths.js";
+import { createWorkbookWorksheetRef } from "../../services/workbookWorksheet.js";
+/**
+ * Create a new worksheet in a workbook, optionally with a defined name.
+ *
+ * @param workbookRef - A reference to the workbook where the worksheet will be created, optionally including session information.
+ * @param name - (Optional) The name of the new worksheet.
+ * @returns The newly created worksheet, including its metadata and reference information.
+ * @see https://learn.microsoft.com/en-us/graph/api/worksheetcollection-add
+ */
+export default function createWorkbookWorksheet(workbookRef, name) {
+    return operation({
+        contextId: workbookRef.contextId,
+        method: "POST",
+        path: generatePath("/sites/{site-id}/drives/{drive-id}/items/{item-id}/workbook/worksheets/add", workbookRef),
+        headers: {
+            "workbook-session-id": workbookRef.sessionId,
+            "content-type": "application/json",
+        },
+        body: {
+            name,
+        },
+        responseTransform: (response) => {
+            const worksheet = response;
+            const worksheetRef = createWorkbookWorksheetRef(workbookRef, worksheet.id);
+            return {
+                ...worksheet,
+                ...worksheetRef,
+            };
+        },
+    });
+}

package/dist/esm/operations/workbookWorksheet/createWorkbookWorksheet.test.d.ts

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

package/dist/esm/operations/workbookWorksheet/createWorkbookWorksheet.test.d.ts.map

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

package/dist/esm/operations/workbookWorksheet/createWorkbookWorksheet.test.js

@@ -0,0 +1,36 @@
+import { describe, expect, it } from "vitest";
+import { getDefaultDriveRef } from "../../services/drive.js";
+import { driveItemPath } from "../../services/driveItem.js";
+import { generateTempFileName } from "../../services/temporaryFiles.js";
+import tryDeleteDriveItem from "../../tasks/tryDeleteDriveItem.js";
+import createWorkbook from "../workbook/createWorkbook.js";
+import createWorkbookWorksheet from "./createWorkbookWorksheet.js";
+describe("createWorkbookWorksheet", () => {
+    it("can create a new worksheet in an existing workbook", async () => {
+        const workbookName = generateTempFileName("xlsx");
+        const workbookPath = driveItemPath(workbookName);
+        const driveRef = getDefaultDriveRef();
+        const workbook = await createWorkbook(driveRef, workbookPath);
+        const worksheetName = "Sheet2";
+        try {
+            const worksheet = await createWorkbookWorksheet(workbook, worksheetName);
+            expect(worksheet.name).toBe(worksheetName);
+        }
+        finally {
+            await tryDeleteDriveItem(workbook);
+        }
+    });
+    it("can create a new worksheet without a name", async () => {
+        const workbookName = generateTempFileName("xlsx");
+        const workbookPath = driveItemPath(workbookName);
+        const driveRef = getDefaultDriveRef();
+        const workbook = await createWorkbook(driveRef, workbookPath);
+        try {
+            const worksheet = await createWorkbookWorksheet(workbook);
+            expect(worksheet.name).toBeDefined();
+        }
+        finally {
+            await tryDeleteDriveItem(workbook);
+        }
+    });
+});

package/dist/esm/operations/workbookWorksheet/deleteWorkbookWorksheet.d.ts

@@ -0,0 +1,11 @@
+import type { GraphOperation } from "../../models/GraphOperation.ts";
+import type { WorkbookWorksheetRef } from "../../models/WorkbookWorksheetRef.ts";
+/**
+ * Permanently delete a worksheet.
+ *
+ * @param worksheetRef - A reference to the worksheet to be deleted, optionally including session information.
+ * @returns Nothing.
+ * @see https://learn.microsoft.com/en-us/graph/api/worksheet-delete
+ */
+export default function deleteWorkbookWorksheet(worksheetRef: WorkbookWorksheetRef): GraphOperation<void>;
+//# sourceMappingURL=deleteWorkbookWorksheet.d.ts.map

package/dist/esm/operations/workbookWorksheet/deleteWorkbookWorksheet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deleteWorkbookWorksheet.d.ts","sourceRoot":"","sources":["../../../../src/operations/workbookWorksheet/deleteWorkbookWorksheet.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAGjF;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,uBAAuB,CAAC,YAAY,EAAE,oBAAoB,GAAG,cAAc,CAAC,IAAI,CAAC,CAWxG"}

package/dist/esm/operations/workbookWorksheet/deleteWorkbookWorksheet.js

@@ -0,0 +1,21 @@
+import { operation } from "../../graphApi.js";
+import { generatePath } from "../../services/templatedPaths.js";
+/**
+ * Permanently delete a worksheet.
+ *
+ * @param worksheetRef - A reference to the worksheet to be deleted, optionally including session information.
+ * @returns Nothing.
+ * @see https://learn.microsoft.com/en-us/graph/api/worksheet-delete
+ */
+export default function deleteWorkbookWorksheet(worksheetRef) {
+    return operation({
+        contextId: worksheetRef.contextId,
+        method: "DELETE",
+        path: generatePath("/sites/{site-id}/drives/{drive-id}/items/{item-id}/workbook/worksheets/{worksheet-id}", worksheetRef),
+        headers: {
+            "workbook-session-id": worksheetRef.sessionId,
+        },
+        body: null,
+        responseTransform: () => undefined,
+    });
+}

package/dist/esm/operations/workbookWorksheet/deleteWorkbookWorksheet.test.d.ts

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

package/dist/esm/operations/workbookWorksheet/deleteWorkbookWorksheet.test.d.ts.map

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

package/dist/esm/operations/workbookWorksheet/deleteWorkbookWorksheet.test.js

@@ -0,0 +1,28 @@
+import { describe, expect, it } from "vitest";
+import { getDefaultDriveRef } from "../../services/drive.js";
+import { driveItemPath } from "../../services/driveItem.js";
+import { generateTempFileName } from "../../services/temporaryFiles.js";
+import tryDeleteDriveItem from "../../tasks/tryDeleteDriveItem.js";
+import calculateWorkbook from "../workbook/calculateWorkbook.js";
+import createWorkbook from "../workbook/createWorkbook.js";
+import createWorkbookWorksheet from "./createWorkbookWorksheet.js";
+import deleteWorkbookWorksheet from "./deleteWorkbookWorksheet.js";
+import listWorkbookWorksheets from "./listWorkbookWorksheets.js";
+describe("deleteWorkbookWorksheet", () => {
+    it("can delete a worksheet from an existing workbook", async () => {
+        const workbookName = generateTempFileName("xlsx");
+        const workbookPath = driveItemPath(workbookName);
+        const driveRef = getDefaultDriveRef();
+        const workbook = await createWorkbook(driveRef, workbookPath);
+        try {
+            const worksheet = await createWorkbookWorksheet(workbook);
+            await deleteWorkbookWorksheet(worksheet);
+            await calculateWorkbook(workbook);
+            const worksheets = await listWorkbookWorksheets(workbook);
+            expect(worksheets.some((ws) => ws.id === worksheet.worksheetId)).toBe(false);
+        }
+        finally {
+            await tryDeleteDriveItem(workbook);
+        }
+    });
+});

package/dist/esm/operations/workbookWorksheet/getWorkbookWorksheetUsedRange.d.ts

@@ -0,0 +1,13 @@
+import type { WorkbookRange } from "@microsoft/microsoft-graph-types";
+import type { GraphOperation } from "../../models/GraphOperation.ts";
+import type { WorkbookRangeRef } from "../../models/WorkbookRangeRef.ts";
+import type { WorkbookWorksheetRef } from "../../models/WorkbookWorksheetRef.ts";
+/**
+ * Retrieve the used range in a worksheet, ignoring trailing rows and columns that are blank.
+ *
+ * @param worksheetRef - A reference to the worksheet, optionally including session information.
+ * @returns The used range of the worksheet, including its metadata and reference information.
+ * @see https://learn.microsoft.com/en-us/graph/api/range-usedrange
+ */
+export default function getWorkbookWorksheetUsedRange(worksheetRef: WorkbookWorksheetRef): GraphOperation<WorkbookRange & WorkbookRangeRef>;
+//# sourceMappingURL=getWorkbookWorksheetUsedRange.d.ts.map

package/dist/esm/operations/workbookWorksheet/getWorkbookWorksheetUsedRange.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getWorkbookWorksheetUsedRange.d.ts","sourceRoot":"","sources":["../../../../src/operations/workbookWorksheet/getWorkbookWorksheetUsedRange.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AAItE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACzE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAIjF;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,6BAA6B,CAAC,YAAY,EAAE,oBAAoB,GAAG,cAAc,CAAC,aAAa,GAAG,gBAAgB,CAAC,CAsB1I"}

package/dist/esm/operations/workbookWorksheet/getWorkbookWorksheetUsedRange.js

@@ -0,0 +1,33 @@
+import ProtocolError from "../../errors/ProtocolError.js";
+import { operation } from "../../graphApi.js";
+import { generatePath } from "../../services/templatedPaths.js";
+import { createWorkbookRangeRef } from "../../services/workbookRange.js";
+/**
+ * Retrieve the used range in a worksheet, ignoring trailing rows and columns that are blank.
+ *
+ * @param worksheetRef - A reference to the worksheet, optionally including session information.
+ * @returns The used range of the worksheet, including its metadata and reference information.
+ * @see https://learn.microsoft.com/en-us/graph/api/range-usedrange
+ */
+export default function getWorkbookWorksheetUsedRange(worksheetRef) {
+    return operation({
+        contextId: worksheetRef.contextId,
+        method: "GET",
+        path: generatePath("/sites/{site-id}/drives/{drive-id}/items/{item-id}/workbook/worksheets/{worksheet-id}/range/usedRange", worksheetRef),
+        headers: {
+            "workbook-session-id": worksheetRef.sessionId,
+        },
+        body: null,
+        responseTransform: (response) => {
+            const range = response;
+            if (!range.address) {
+                throw new ProtocolError("Invalid response: address is missing");
+            }
+            const rangeRef = createWorkbookRangeRef(worksheetRef, range.address);
+            return {
+                ...range,
+                ...rangeRef,
+            };
+        },
+    });
+}

package/dist/esm/operations/workbookWorksheet/getWorkbookWorksheetUsedRange.test.d.ts

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

package/dist/esm/operations/workbookWorksheet/getWorkbookWorksheetUsedRange.test.d.ts.map

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

package/dist/esm/operations/workbookWorksheet/getWorkbookWorksheetUsedRange.test.js

@@ -0,0 +1,54 @@
+import { describe, expect, it } from "vitest";
+import { sequential } from "../../graphApi.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 tryDeleteDriveItem from "../../tasks/tryDeleteDriveItem.js";
+import calculateWorkbook from "../workbook/calculateWorkbook.js";
+import createWorkbook from "../workbook/createWorkbook.js";
+import updateWorkbookRange from "../workbookRange/updateWorkbookRange.js";
+import getWorkbookUsedRange from "./getWorkbookWorksheetUsedRange.js";
+const values = [
+    [1, 2],
+    [3, 4],
+];
+describe("getWorkbookUsedRange", () => {
+    it("can retrieve the used range from 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);
+        const rangeRef = createWorkbookRangeRef(worksheetRef, "A1:B2");
+        try {
+            await updateWorkbookRange(rangeRef, {
+                values: values,
+            });
+            await calculateWorkbook(workbook);
+            const usedRange = await getWorkbookUsedRange(worksheetRef);
+            expect(usedRange.values).toEqual(values);
+        }
+        finally {
+            await tryDeleteDriveItem(workbook);
+        }
+    });
+    it("can retrieve the used range from an existing workbook sequential", 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 {
+            const [_, __, usedRange] = await sequential(updateWorkbookRange(rangeRef, {
+                values: values,
+            }), calculateWorkbook(workbook), getWorkbookUsedRange(worksheetRef));
+            expect(usedRange.values).toEqual(values);
+        }
+        finally {
+            await tryDeleteDriveItem(workbook);
+        }
+    });
+});

package/dist/esm/operations/workbookWorksheet/getWorkbookWorksheetUsedVisibleRange.d.ts

@@ -0,0 +1,13 @@
+import type { WorkbookRange } from "@microsoft/microsoft-graph-types";
+import type { GraphOperation } from "../../models/GraphOperation.ts";
+import type { WorkbookRangeRef } from "../../models/WorkbookRangeRef.ts";
+import type { WorkbookWorksheetRef } from "../../models/WorkbookWorksheetRef.ts";
+/**
+ * Retrieve the visible (not hidden) range in a worksheet.
+ *
+ * @param worksheetRef - A reference to the worksheet, optionally including session information.
+ * @returns The visible range of the worksheet, including its metadata and reference information.
+ * @see https://learn.microsoft.com/en-us/graph/api/range-usedrange
+ */
+export default function getWorkbookWorksheetUsedVisibleRange(worksheetRef: WorkbookWorksheetRef): GraphOperation<WorkbookRange & WorkbookRangeRef>;
+//# sourceMappingURL=getWorkbookWorksheetUsedVisibleRange.d.ts.map

package/dist/esm/operations/workbookWorksheet/getWorkbookWorksheetUsedVisibleRange.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getWorkbookWorksheetUsedVisibleRange.d.ts","sourceRoot":"","sources":["../../../../src/operations/workbookWorksheet/getWorkbookWorksheetUsedVisibleRange.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AAGtE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACzE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAIjF;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,oCAAoC,CAAC,YAAY,EAAE,oBAAoB,GAAG,cAAc,CAAC,aAAa,GAAG,gBAAgB,CAAC,CAmBjJ"}

package/dist/esm/operations/workbookWorksheet/getWorkbookWorksheetUsedVisibleRange.js

@@ -0,0 +1,29 @@
+import { operation } from "../../graphApi.js";
+import { generatePath } from "../../services/templatedPaths.js";
+import { createWorkbookRangeRef } from "../../services/workbookRange.js";
+/**
+ * Retrieve the visible (not hidden) range in a worksheet.
+ *
+ * @param worksheetRef - A reference to the worksheet, optionally including session information.
+ * @returns The visible range of the worksheet, including its metadata and reference information.
+ * @see https://learn.microsoft.com/en-us/graph/api/range-usedrange
+ */
+export default function getWorkbookWorksheetUsedVisibleRange(worksheetRef) {
+    return operation({
+        contextId: worksheetRef.contextId,
+        method: "GET",
+        path: generatePath("/sites/{site-id}/drives/{drive-id}/items/{item-id}/workbook/worksheets/{worksheet-id}/range/usedRange/visibleView", worksheetRef),
+        headers: {
+            "workbook-session-id": worksheetRef.sessionId,
+        },
+        body: null,
+        responseTransform: (response) => {
+            const range = response;
+            const rangeRef = createWorkbookRangeRef(worksheetRef, range.address);
+            return {
+                ...range,
+                ...rangeRef,
+            };
+        },
+    });
+}

package/dist/esm/operations/workbookWorksheet/getWorkbookWorksheetUsedVisibleRange.test.d.ts

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

package/dist/esm/operations/workbookWorksheet/getWorkbookWorksheetUsedVisibleRange.test.d.ts.map

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

package/dist/esm/operations/workbookWorksheet/getWorkbookWorksheetUsedVisibleRange.test.js

@@ -0,0 +1,37 @@
+import { describe, expect, it } from "vitest";
+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 setRowHidden from "../../tasks/setRowHidden.js";
+import tryDeleteDriveItem from "../../tasks/tryDeleteDriveItem.js";
+import calculateWorkbook from "../workbook/calculateWorkbook.js";
+import createWorkbook from "../workbook/createWorkbook.js";
+import updateWorkbookRange from "../workbookRange/updateWorkbookRange.js";
+import getWorkbookWorksheetUsedVisibleRange from "./getWorkbookWorksheetUsedVisibleRange.js";
+describe("getWorkbookWorksheetUsedVisibleRange", () => {
+    it("can retrieve the used visible range from 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);
+        const rangeRef = createWorkbookRangeRef(worksheetRef, "A1:B2");
+        try {
+            await updateWorkbookRange(rangeRef, {
+                values: [
+                    [1, 2],
+                    [3, 4],
+                ],
+            });
+            await setRowHidden(createWorkbookRangeRef(worksheetRef, "1:1"), true);
+            await calculateWorkbook(workbook);
+            const usedRange = await getWorkbookWorksheetUsedVisibleRange(worksheetRef);
+            expect(usedRange.values).toEqual([[3, 4]]);
+        }
+        finally {
+            await tryDeleteDriveItem(workbook);
+        }
+    });
+});

package/dist/esm/operations/workbookWorksheet/listWorkbookWorksheets.d.ts

@@ -0,0 +1,13 @@
+import type { WorkbookWorksheet } from "@microsoft/microsoft-graph-types";
+import type { GraphOperation } from "../../models/GraphOperation.ts";
+import type { WorkbookRef } from "../../models/WorkbookRef.ts";
+import type { WorkbookWorksheetRef } from "../../models/WorkbookWorksheetRef.ts";
+/**
+ * Retrieve a list of worksheets in a workbook.
+ *
+ * @param workbookRef - A reference to the workbook, optionally including session information.
+ * @returns An array of worksheets, each including its metadata and reference information.
+ * @see https://learn.microsoft.com/en-us/graph/api/worksheet-list
+ */
+export default function listWorkbookWorksheets(workbookRef: WorkbookRef): GraphOperation<(WorkbookWorksheet & WorkbookWorksheetRef)[]>;
+//# sourceMappingURL=listWorkbookWorksheets.d.ts.map

package/dist/esm/operations/workbookWorksheet/listWorkbookWorksheets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"listWorkbookWorksheets.d.ts","sourceRoot":"","sources":["../../../../src/operations/workbookWorksheet/listWorkbookWorksheets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAG1E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAE/D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAIjF;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,sBAAsB,CAAC,WAAW,EAAE,WAAW,GAAG,cAAc,CAAC,CAAC,iBAAiB,GAAG,oBAAoB,CAAC,EAAE,CAAC,CA0BrI"}

package/dist/esm/operations/workbookWorksheet/listWorkbookWorksheets.js

@@ -0,0 +1,35 @@
+import ProtocolError from "../../errors/ProtocolError.js";
+import { operation } from "../../graphApi.js";
+import { generatePath } from "../../services/templatedPaths.js";
+import { createWorkbookWorksheetRef } from "../../services/workbookWorksheet.js";
+/**
+ * Retrieve a list of worksheets in a workbook.
+ *
+ * @param workbookRef - A reference to the workbook, optionally including session information.
+ * @returns An array of worksheets, each including its metadata and reference information.
+ * @see https://learn.microsoft.com/en-us/graph/api/worksheet-list
+ */
+export default function listWorkbookWorksheets(workbookRef) {
+    return operation({
+        contextId: workbookRef.contextId,
+        method: "GET",
+        path: generatePath("/sites/{site-id}/drives/{drive-id}/items/{item-id}/workbook/worksheets", workbookRef),
+        headers: {
+            "workbook-session-id": workbookRef.sessionId,
+        },
+        body: null,
+        responseTransform: (response) => {
+            const worksheets = response;
+            return worksheets.value.map((worksheet) => {
+                const worksheetRef = createWorkbookWorksheetRef(workbookRef, worksheet.id);
+                if (!worksheet.name) {
+                    throw new ProtocolError("Item.name is undefined");
+                }
+                return {
+                    ...worksheet,
+                    ...worksheetRef,
+                };
+            });
+        },
+    });
+}

package/dist/esm/operations/workbookWorksheet/listWorkbookWorksheets.test.d.ts

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

package/dist/esm/operations/workbookWorksheet/listWorkbookWorksheets.test.d.ts.map

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

package/dist/esm/operations/workbookWorksheet/listWorkbookWorksheets.test.js

@@ -0,0 +1,45 @@
+import { describe, expect, it } from "vitest";
+import { sequential } from "../../graphApi.js";
+import { getDefaultDriveRef } from "../../services/drive.js";
+import { driveItemPath } from "../../services/driveItem.js";
+import { generateTempFileName } from "../../services/temporaryFiles.js";
+import tryDeleteDriveItem from "../../tasks/tryDeleteDriveItem.js";
+import calculateWorkbook from "../workbook/calculateWorkbook.js";
+import createWorkbook from "../workbook/createWorkbook.js";
+import createWorkbookWorksheet from "./createWorkbookWorksheet.js";
+import listWorkbookWorksheets from "./listWorkbookWorksheets.js";
+describe("listWorkbookWorksheets", () => {
+    it("can list worksheets in an existing workbook", async () => {
+        const workbookName = generateTempFileName("xlsx");
+        const workbookPath = driveItemPath(workbookName);
+        const driveRef = getDefaultDriveRef();
+        const workbook = await createWorkbook(driveRef, workbookPath);
+        try {
+            const worksheet1 = await createWorkbookWorksheet(workbook);
+            const worksheet2 = await createWorkbookWorksheet(workbook);
+            await calculateWorkbook(workbook);
+            const worksheets = await listWorkbookWorksheets(workbook);
+            const worksheetIds = worksheets.map((ws) => ws.worksheetId);
+            expect(worksheetIds).toContain(worksheet1.worksheetId);
+            expect(worksheetIds).toContain(worksheet2.worksheetId);
+        }
+        finally {
+            await tryDeleteDriveItem(workbook);
+        }
+    });
+    it("can list worksheets in an existing workbook parallel", async () => {
+        const workbookName = generateTempFileName("xlsx");
+        const workbookPath = driveItemPath(workbookName);
+        const driveRef = getDefaultDriveRef();
+        const workbook = await createWorkbook(driveRef, workbookPath);
+        try {
+            const [worksheet1, worksheet2, _, worksheets] = await sequential(createWorkbookWorksheet(workbook), createWorkbookWorksheet(workbook), calculateWorkbook(workbook), listWorkbookWorksheets(workbook));
+            const worksheetIds = worksheets.map((worksheet) => worksheet.worksheetId);
+            expect(worksheetIds).toContain(worksheet1.worksheetId);
+            expect(worksheetIds).toContain(worksheet2.worksheetId);
+        }
+        finally {
+            await tryDeleteDriveItem(workbook);
+        }
+    });
+});

package/dist/esm/operations/workbookWorksheet/updateWorkbookWorksheet.d.ts

@@ -0,0 +1,20 @@
+import type { WorkbookWorksheet } from "@microsoft/microsoft-graph-types";
+import type { GraphOperation } from "../../models/GraphOperation.ts";
+import type { WorkbookWorksheetRef } from "../../models/WorkbookWorksheetRef.ts";
+/**
+ * Update the name, position, and/or visibility of a worksheet.
+ *
+ * @param worksheetRef - A reference to the worksheet to be updated, optionally including session information.
+ * @param updates - An object containing the properties to update:
+ *   - `name` (optional): The new name for the worksheet.
+ *   - `position` (optional): The new position of the worksheet in the workbook.
+ *   - `visibility` (optional): The visibility state of the worksheet. Can be "Visible", "Hidden", or "VeryHidden".
+ * @returns The updated worksheet, including its reference information.
+ * @see https://learn.microsoft.com/en-us/graph/api/worksheet-update
+ */
+export default function updateWorkbookWorksheet(worksheetRef: WorkbookWorksheetRef, updates: {
+    name?: string;
+    position?: number;
+    visibility?: "Visible" | "Hidden" | "VeryHidden";
+}): GraphOperation<WorkbookWorksheet & WorkbookWorksheetRef>;
+//# sourceMappingURL=updateWorkbookWorksheet.d.ts.map

package/dist/esm/operations/workbookWorksheet/updateWorkbookWorksheet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"updateWorkbookWorksheet.d.ts","sourceRoot":"","sources":["../../../../src/operations/workbookWorksheet/updateWorkbookWorksheet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAE1E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAGjF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,OAAO,UAAU,uBAAuB,CAAC,YAAY,EAAE,oBAAoB,EAAE,OAAO,EAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,YAAY,CAAA;CAAE,GAAG,cAAc,CAAC,iBAAiB,GAAG,oBAAoB,CAAC,CAkB7O"}