microsoft-graph 2.6.0 → 2.7.0

package/dist/cjs/operations/site/listSites.js

@@ -0,0 +1,31 @@
+import { operation } from "../../graphApi.js";
+import { createSiteRef } from "../../services/site.js";
+import { generatePath } from "../../services/templatedPaths.js";
+/**
+ * List accessible sites.
+ *
+ * @param contextRef - A reference to the context.
+ * @returns An array of sites, each including its metadata and reference information.
+ * @see https://learn.microsoft.com/en-us/graph/api/site-list
+ */
+export default function listSites(contextRef) {
+    return operation({
+        contextId: contextRef.contextId,
+        method: "GET",
+        path: generatePath("/sites", {}),
+        headers: {},
+        body: null,
+        responseTransform: (response) => {
+            const list = response;
+            const sites = list.value.map((site) => {
+                const siteId = site.id;
+                const siteRef = createSiteRef(contextRef, siteId);
+                return {
+                    ...site,
+                    ...siteRef,
+                };
+            });
+            return sites;
+        },
+    });
+}

package/dist/cjs/operations/site/listSites.test.d.ts

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

package/dist/cjs/operations/site/listSites.test.d.ts.map

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

package/dist/cjs/operations/site/listSites.test.js

@@ -0,0 +1,12 @@
+import { describe, expect, it } from "vitest";
+import listSites from "./listSites.js";
+import { getDefaultContextRef } from "../../services/context.js";
+describe("listSites", () => {
+    it("can list all sites", async () => {
+        const contextRef = getDefaultContextRef();
+        const sites = await listSites(contextRef);
+        console.debug("Sites:", sites.map((site) => [site.id, site.name]));
+        expect(sites).toBeInstanceOf(Array);
+        expect(sites.length).toBeGreaterThan(0);
+    });
+});

package/dist/cjs/operations/site/searchSites.d.ts

@@ -0,0 +1,14 @@
+import type { Site } from "@microsoft/microsoft-graph-types";
+import type { ContextRef } from "../../models/ContextRef.ts";
+import type { GraphOperation } from "../../models/GraphOperation.ts";
+import type { SiteRef } from "../../models/SiteRef.ts";
+/**
+ * Find accessible sites that match the provided keywords.
+ *
+ * @param contextRef - A reference to the context.
+ * @param search - The search keywords to find matching sites.
+ * @returns An array of sites that match the search criteria, each including its metadata and reference information.
+ * @see https://learn.microsoft.com/en-us/graph/api/site-search
+ */
+export default function searchSites(contextRef: ContextRef, search: string): GraphOperation<(Site & SiteRef)[]>;
+//# sourceMappingURL=searchSites.d.ts.map

package/dist/cjs/operations/site/searchSites.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchSites.d.ts","sourceRoot":"","sources":["../../../../src/operations/site/searchSites.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kCAAkC,CAAC;AAE7D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAErE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAIvD;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,UAAU,WAAW,CAAC,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,cAAc,CAAC,CAAC,IAAI,GAAG,OAAO,CAAC,EAAE,CAAC,CAuB9G"}

package/dist/cjs/operations/site/searchSites.js

@@ -0,0 +1,32 @@
+import { operation } from "../../graphApi.js";
+import { createSiteRef } from "../../services/site.js";
+import { generatePath } from "../../services/templatedPaths.js";
+/**
+ * Find accessible sites that match the provided keywords.
+ *
+ * @param contextRef - A reference to the context.
+ * @param search - The search keywords to find matching sites.
+ * @returns An array of sites that match the search criteria, each including its metadata and reference information.
+ * @see https://learn.microsoft.com/en-us/graph/api/site-search
+ */
+export default function searchSites(contextRef, search) {
+    return operation({
+        contextId: contextRef.contextId,
+        method: "GET",
+        path: generatePath("/sites?search={search}", { search }),
+        headers: {},
+        body: null,
+        responseTransform: (response) => {
+            const list = response;
+            const sites = list.value.map((site) => {
+                const siteId = site.id;
+                const siteRef = createSiteRef(contextRef, siteId);
+                return {
+                    ...site,
+                    ...siteRef,
+                };
+            });
+            return sites;
+        },
+    });
+}

package/dist/cjs/operations/site/searchSites.test.d.ts

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

package/dist/cjs/operations/site/searchSites.test.d.ts.map

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

package/dist/cjs/operations/site/searchSites.test.js

@@ -0,0 +1,18 @@
+import { describe, expect, it } from "vitest";
+import { getDefaultContextRef } from "../../services/context.js";
+import searchSites from "./searchSites.js";
+describe("searchSites", () => {
+    it("can find sites matching the search keyword", async () => {
+        const contextRef = getDefaultContextRef();
+        const searchKeyword = "a";
+        const result = await searchSites(contextRef, searchKeyword);
+        expect(result).toBeInstanceOf(Array);
+        expect(result.length).toBeGreaterThan(0);
+    });
+    it("handles search with '/' character", async () => {
+        const contextRef = getDefaultContextRef();
+        const searchKeyword = "/";
+        const result = await searchSites(contextRef, searchKeyword);
+        expect(result).toBeInstanceOf(Array);
+    });
+});

package/dist/cjs/operations/user/userSendMail.d.ts

@@ -0,0 +1,15 @@
+import type { Message } from "@microsoft/microsoft-graph-types";
+import type { ContextRef } from "../../models/ContextRef.ts";
+import type { GraphOperation } from "../../models/GraphOperation.ts";
+/**
+ * Send an email.
+ *
+ * @param contextRef - A reference to the context.
+ * @param sender - The email address of the sender or NULL for the current user. Must match a valid email address in this tenant.
+ * @param message - The email message to be sent.
+ * @returns Nothing.
+ * @throws InvalidArgumentError if the sender email address does not match the required pattern.
+ * @see https://learn.microsoft.com/en-us/graph/api/user-sendmail
+ */
+export default function userSendMail(contextRef: ContextRef, sender: string | null, message: Message): GraphOperation<void>;
+//# sourceMappingURL=userSendMail.d.ts.map

package/dist/cjs/operations/user/userSendMail.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"userSendMail.d.ts","sourceRoot":"","sources":["../../../../src/operations/user/userSendMail.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kCAAkC,CAAC;AAGhE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,KAAK,EAAE,cAAc,EAAa,MAAM,gCAAgC,CAAC;AAMhF;;;;;;;;;GASG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,EAAE,OAAO,EAAE,OAAO,GAAG,cAAc,CAAC,IAAI,CAAC,CAmB1H"}

package/dist/cjs/operations/user/userSendMail.js

@@ -0,0 +1,32 @@
+import InvalidArgumentError from "../../errors/InvalidArgumentError.js";
+import { operation } from "../../graphApi.js";
+// Overview of SendMail process: https://learn.microsoft.com/en-us/graph/outlook-things-to-know-about-send-mail
+const emailPattern = /^[a-zA-Z0-9._\-@]+$/; // Basic, but intended just to avoid URL escaping issues
+/**
+ * Send an email.
+ *
+ * @param contextRef - A reference to the context.
+ * @param sender - The email address of the sender or NULL for the current user. Must match a valid email address in this tenant.
+ * @param message - The email message to be sent.
+ * @returns Nothing.
+ * @throws InvalidArgumentError if the sender email address does not match the required pattern.
+ * @see https://learn.microsoft.com/en-us/graph/api/user-sendmail
+ */
+export default function userSendMail(contextRef, sender, message) {
+    if (sender && !emailPattern.test(sender)) {
+        throw new InvalidArgumentError(`Invalid email address. Must match pattern '${emailPattern}'`);
+    }
+    const path = sender ? `/users/${sender}/sendMail` : "/me/sendMail";
+    return operation({
+        contextId: contextRef.contextId,
+        method: "POST",
+        path: path,
+        headers: {
+            "content-type": "application/json",
+        },
+        body: {
+            message,
+        },
+        responseTransform: () => undefined,
+    });
+}

package/dist/cjs/operations/workbook/calculateWorkbook.d.ts

@@ -0,0 +1,19 @@
+import type { GraphOperation } from "../../models/GraphOperation.ts";
+import type { WorkbookRef } from "../../models/WorkbookRef.ts";
+/**
+ * Recalculate a workbook.
+ *
+ * @param workbookRef - A reference to the workbook to be recalculated.
+ * @param calculationType - The type of recalculation to perform. Can be "Recalculate", "Full", or "FullRebuild". Defaults to "Recalculate".
+ * @returns Nothing.
+ * @see https://learn.microsoft.com/en-us/graph/api/workbookapplication-calculate
+ */
+export default function calculateWorkbook(workbookRef: WorkbookRef, calculationType?: "Recalculate" | "Full" | "FullRebuild"): GraphOperation<void>;
+/**
+ * @deprecated Use calculateWorkbook instead.
+ *
+ * @param workbookRef - A reference to the workbook to be recalculated.
+ * @returns Nothing.
+ */
+export declare function recalculateWorkbook(workbookRef: WorkbookRef): GraphOperation<void>;
+//# sourceMappingURL=calculateWorkbook.d.ts.map

package/dist/cjs/operations/workbook/calculateWorkbook.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"calculateWorkbook.d.ts","sourceRoot":"","sources":["../../../../src/operations/workbook/calculateWorkbook.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAG/D;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,UAAU,iBAAiB,CAAC,WAAW,EAAE,WAAW,EAAE,eAAe,GAAE,aAAa,GAAG,MAAM,GAAG,aAA6B,GAAG,cAAc,CAAC,IAAI,CAAC,CAajK;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,cAAc,CAAC,IAAI,CAAC,CAElF"}

package/dist/cjs/operations/workbook/calculateWorkbook.js

@@ -0,0 +1,33 @@
+import { operation } from "../../graphApi.js";
+import { generatePath } from "../../services/templatedPaths.js";
+/**
+ * Recalculate a workbook.
+ *
+ * @param workbookRef - A reference to the workbook to be recalculated.
+ * @param calculationType - The type of recalculation to perform. Can be "Recalculate", "Full", or "FullRebuild". Defaults to "Recalculate".
+ * @returns Nothing.
+ * @see https://learn.microsoft.com/en-us/graph/api/workbookapplication-calculate
+ */
+export default function calculateWorkbook(workbookRef, calculationType = "Recalculate") {
+    return operation({
+        contextId: workbookRef.contextId,
+        method: "POST",
+        path: generatePath("/sites/{site-id}/drives/{drive-id}/items/{item-id}/workbook/application/calculate", workbookRef),
+        headers: {
+            "content-type": "application/json",
+        },
+        body: {
+            calculationType,
+        },
+        responseTransform: () => undefined,
+    });
+}
+/**
+ * @deprecated Use calculateWorkbook instead.
+ *
+ * @param workbookRef - A reference to the workbook to be recalculated.
+ * @returns Nothing.
+ */
+export function recalculateWorkbook(workbookRef) {
+    return calculateWorkbook(workbookRef, "Recalculate");
+}

package/dist/cjs/operations/workbook/calculateWorkbook.test.d.ts

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

package/dist/cjs/operations/workbook/calculateWorkbook.test.d.ts.map

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

package/dist/cjs/operations/workbook/calculateWorkbook.test.js

@@ -0,0 +1,46 @@
+import { describe, 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 "./calculateWorkbook.js";
+import createWorkbook from "./createWorkbook.js";
+describe("calculateWorkbook", () => {
+    // All we're really doing is check that there's no errors
+    it(`can calculate workbook with calculation type: 'Recalculate'`, async () => {
+        const workbookName = generateTempFileName("xlsx");
+        const workbookPath = driveItemPath(workbookName);
+        const driveRef = getDefaultDriveRef();
+        const workbook = await createWorkbook(driveRef, workbookPath);
+        try {
+            await calculateWorkbook(workbook, "Recalculate");
+        }
+        finally {
+            await tryDeleteDriveItem(workbook);
+        }
+    });
+    it(`can calculate workbook with calculation type: 'Full'`, async () => {
+        const driveRef = getDefaultDriveRef();
+        const workbookName = generateTempFileName("xlsx");
+        const workbookPath = driveItemPath(workbookName);
+        const workbook = await createWorkbook(driveRef, workbookPath);
+        try {
+            await calculateWorkbook(workbook, "Full");
+        }
+        finally {
+            await tryDeleteDriveItem(workbook);
+        }
+    });
+    it(`can calculate workbook with calculation type: 'FullRebuild'`, async () => {
+        const driveRef = getDefaultDriveRef();
+        const workbookName = generateTempFileName("xlsx");
+        const workbookPath = driveItemPath(workbookName);
+        const workbook = await createWorkbook(driveRef, workbookPath);
+        try {
+            await calculateWorkbook(workbook, "FullRebuild");
+        }
+        finally {
+            await tryDeleteDriveItem(workbook);
+        }
+    });
+});

package/dist/cjs/operations/workbook/createWorkbook.d.ts

@@ -0,0 +1,17 @@
+import type { DriveItem } from "@microsoft/microsoft-graph-types";
+import type { DriveItemPath } from "../../models/DriveItemPath.ts";
+import type { DriveItemRef } from "../../models/DriveItemRef.ts";
+import type { DriveRef } from "../../models/DriveRef.ts";
+import type { GraphOperation } from "../../models/GraphOperation.ts";
+import type { WorkbookRef } from "../../models/WorkbookRef.ts";
+/**
+ * Create a new blank workbook.
+ *
+ * @param parentRef - A reference to the parent drive or folder where the workbook will be created.
+ * @param itemPath - The path (including the filename) for the new workbook. Must end with `.xlsx`.
+ * @returns The newly created workbook, including its metadata and reference information.
+ * @throws InvalidArgumentError if the item path does not end with `.xlsx`.
+ * @see https://learn.microsoft.com/en-us/graph/api/driveitem-put-content
+ */
+export default function createWorkbook(parentRef: DriveRef | DriveItemRef, itemPath: DriveItemPath): GraphOperation<DriveItem & WorkbookRef>;
+//# sourceMappingURL=createWorkbook.d.ts.map

package/dist/cjs/operations/workbook/createWorkbook.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createWorkbook.d.ts","sourceRoot":"","sources":["../../../../src/operations/workbook/createWorkbook.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAC;AAIlE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAI/D;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,UAAU,cAAc,CAAC,SAAS,EAAE,QAAQ,GAAG,YAAY,EAAE,QAAQ,EAAE,aAAa,GAAG,cAAc,CAAC,SAAS,GAAG,WAAW,CAAC,CAyB3I"}

package/dist/cjs/operations/workbook/createWorkbook.js

@@ -0,0 +1,36 @@
+import InvalidArgumentError from "../../errors/InvalidArgumentError.js";
+import { operation } from "../../graphApi.js";
+import { createDriveItemRef, workbookFileExtension } from "../../services/driveItem.js";
+import { generatePath } from "../../services/templatedPaths.js";
+/**
+ * Create a new blank workbook.
+ *
+ * @param parentRef - A reference to the parent drive or folder where the workbook will be created.
+ * @param itemPath - The path (including the filename) for the new workbook. Must end with `.xlsx`.
+ * @returns The newly created workbook, including its metadata and reference information.
+ * @throws InvalidArgumentError if the item path does not end with `.xlsx`.
+ * @see https://learn.microsoft.com/en-us/graph/api/driveitem-put-content
+ */
+export default function createWorkbook(parentRef, itemPath) {
+    if (!itemPath.endsWith(`.${workbookFileExtension}`)) {
+        throw new InvalidArgumentError(`Item path must end with '.${workbookFileExtension}'`);
+    }
+    const pathSegment = parentRef.itemId ? "items/{item-id}" : "root";
+    return operation({
+        contextId: parentRef.contextId,
+        method: "PUT",
+        path: generatePath(`/sites/{site-id}/drives/{drive-id}/${pathSegment}:/${itemPath}:/content`, parentRef),
+        headers: {
+            "content-type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+        },
+        body: null, // This is correct, Sharepoint interprets a 0-byte files as a new workbook.
+        responseTransform: (response) => {
+            const driveItem = response;
+            const itemRef = createDriveItemRef(parentRef, driveItem.id);
+            return {
+                ...driveItem,
+                ...itemRef,
+            };
+        },
+    });
+}

package/dist/cjs/operations/workbook/createWorkbook.test.d.ts

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

package/dist/cjs/operations/workbook/createWorkbook.test.d.ts.map

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

package/dist/cjs/operations/workbook/createWorkbook.test.js

@@ -0,0 +1,15 @@
+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 "./createWorkbook.js";
+describe("createWorkbook", () => {
+    it("can create a new workbook", async () => {
+        const workbookName = generateTempFileName("xlsx");
+        const workbookPath = driveItemPath(workbookName);
+        const workbook = await createWorkbook(getDefaultDriveRef(), workbookPath);
+        expect(workbook.name).toBe(workbookName);
+        await tryDeleteDriveItem(workbook);
+    });
+});

package/dist/cjs/operations/workbook/deleteWorkbook.d.ts

@@ -0,0 +1,11 @@
+import type { GraphOperation } from "../../models/GraphOperation.ts";
+import type { WorkbookRef } from "../../models/WorkbookRef.ts";
+/**
+ * Delete a workbook.
+ *
+ * @param workbookRef - A reference to the workbook to be deleted.
+ * @returns Nothing.
+ * @see https://learn.microsoft.com/en-us/graph/api/driveitem-delete
+ */
+export default function deleteWorkbook(workbookRef: WorkbookRef): GraphOperation<void>;
+//# sourceMappingURL=deleteWorkbook.d.ts.map

package/dist/cjs/operations/workbook/deleteWorkbook.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deleteWorkbook.d.ts","sourceRoot":"","sources":["../../../../src/operations/workbook/deleteWorkbook.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAG/D;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,cAAc,CAAC,WAAW,EAAE,WAAW,GAAG,cAAc,CAAC,IAAI,CAAC,CAErF"}

package/dist/cjs/operations/workbook/deleteWorkbook.js

@@ -0,0 +1,11 @@
+import deleteDriveItem from "../driveItem/deleteDriveItem.js";
+/**
+ * Delete a workbook.
+ *
+ * @param workbookRef - A reference to the workbook to be deleted.
+ * @returns Nothing.
+ * @see https://learn.microsoft.com/en-us/graph/api/driveitem-delete
+ */
+export default function deleteWorkbook(workbookRef) {
+    return deleteDriveItem(workbookRef);
+}

package/dist/cjs/operations/workbookRange/clearWorkbookRange.d.ts

@@ -0,0 +1,12 @@
+import type { GraphOperation } from "../../models/GraphOperation.ts";
+import type { WorkbookRangeRef } from "../../models/WorkbookRangeRef.ts";
+/**
+ * Clear a range - content, formatting, or both.
+ *
+ * @param rangeRef - A reference to the range to be cleared, optionally including session information.
+ * @param applyTo - Specifies what to clear. Can be "All", "Formats", or "Contents". Defaults to "All".
+ * @returns Nothing.
+ * @see https://learn.microsoft.com/en-us/graph/api/range-delete
+ */
+export default function clearWorkbookRange(rangeRef: WorkbookRangeRef, applyTo?: "All" | "Formats" | "Contents"): GraphOperation<void>;
+//# sourceMappingURL=clearWorkbookRange.d.ts.map

package/dist/cjs/operations/workbookRange/clearWorkbookRange.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"clearWorkbookRange.d.ts","sourceRoot":"","sources":["../../../../src/operations/workbookRange/clearWorkbookRange.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAGzE;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,UAAU,kBAAkB,CAAC,QAAQ,EAAE,gBAAgB,EAAE,OAAO,GAAE,KAAK,GAAG,SAAS,GAAG,UAAkB,GAAG,cAAc,CAAC,IAAI,CAAC,CAc5I"}

package/dist/cjs/operations/workbookRange/clearWorkbookRange.js

@@ -0,0 +1,25 @@
+import { operation } from "../../graphApi.js";
+import { generatePath } from "../../services/templatedPaths.js";
+/**
+ * Clear a range - content, formatting, or both.
+ *
+ * @param rangeRef - A reference to the range to be cleared, optionally including session information.
+ * @param applyTo - Specifies what to clear. Can be "All", "Formats", or "Contents". Defaults to "All".
+ * @returns Nothing.
+ * @see https://learn.microsoft.com/en-us/graph/api/range-delete
+ */
+export default function clearWorkbookRange(rangeRef, applyTo = "All") {
+    return operation({
+        contextId: rangeRef.contextId,
+        method: "POST",
+        path: generatePath("/sites/{site-id}/drives/{drive-id}/items/{item-id}/workbook/worksheets/{worksheet-id}/range(address='{address}')/clear", rangeRef),
+        headers: {
+            "workbook-session-id": rangeRef.sessionId,
+            "content-type": "application/json",
+        },
+        body: {
+            applyTo,
+        },
+        responseTransform: () => undefined,
+    });
+}

package/dist/cjs/operations/workbookRange/clearWorkbookRange.test.d.ts

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

package/dist/cjs/operations/workbookRange/clearWorkbookRange.test.d.ts.map

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

package/dist/cjs/operations/workbookRange/clearWorkbookRange.test.js

@@ -0,0 +1,60 @@
+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 clearWorkbookRange from "./clearWorkbookRange.js";
+import getWorkbookWorksheetRange from "./getWorkbookWorksheetRange.js";
+import updateWorkbookRange from "./updateWorkbookRange.js";
+const values = [
+    [1, 2],
+    [3, 4],
+];
+const clearedValues = [
+    ["", ""],
+    ["", ""],
+];
+describe("clearWorkbookRange", () => {
+    it("can clear a range in an existing workbook", async () => {
+        const workbookName = generateTempFileName("xlsx");
+        const workbookPath = driveItemPath(workbookName);
+        const driveRef = getDefaultDriveRef();
+        const workbook = await createWorkbook(driveRef, workbookPath);
+        const worksheetRef = createWorkbookWorksheetRef(workbook, defaultWorkbookWorksheetId);
+        const rangeRef = createWorkbookRangeRef(worksheetRef, "A1:B2");
+        try {
+            await updateWorkbookRange(rangeRef, {
+                values: values,
+            });
+            await clearWorkbookRange(rangeRef);
+            await calculateWorkbook(workbook);
+            const clearedRange = await getWorkbookWorksheetRange(rangeRef);
+            expect(clearedRange.values).toEqual(clearedValues);
+        }
+        finally {
+            await tryDeleteDriveItem(workbook);
+        }
+    });
+    it("can clear a range in 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 [_, __, ___, clearedRange] = await sequential(updateWorkbookRange(rangeRef, {
+                values: values,
+            }), clearWorkbookRange(rangeRef), calculateWorkbook(workbook), getWorkbookWorksheetRange(rangeRef));
+            expect(clearedRange.values).toEqual(clearedValues);
+        }
+        finally {
+            await tryDeleteDriveItem(workbook);
+        }
+    });
+});

package/dist/cjs/operations/workbookRange/deleteWorkbookRange.d.ts

@@ -0,0 +1,12 @@
+import type { GraphOperation } from "../../models/GraphOperation.ts";
+import type { WorkbookRangeRef } from "../../models/WorkbookRangeRef.ts";
+/**
+ * Delete a range.
+ *
+ * @param rangeRef - A reference to the range to be deleted, optionally including session information.
+ * @param shift - The direction to shift existing cells after deletion. Can be "Up" or "Left".
+ * @returns Nothing.
+ * @see https://learn.microsoft.com/en-us/graph/api/range-clear
+ */
+export default function deleteWorkbookRange(rangeRef: WorkbookRangeRef, shift: "Up" | "Left"): GraphOperation<void>;
+//# sourceMappingURL=deleteWorkbookRange.d.ts.map

package/dist/cjs/operations/workbookRange/deleteWorkbookRange.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deleteWorkbookRange.d.ts","sourceRoot":"","sources":["../../../../src/operations/workbookRange/deleteWorkbookRange.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAGzE;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,UAAU,mBAAmB,CAAC,QAAQ,EAAE,gBAAgB,EAAE,KAAK,EAAE,IAAI,GAAG,MAAM,GAAG,cAAc,CAAC,IAAI,CAAC,CAclH"}

package/dist/cjs/operations/workbookRange/deleteWorkbookRange.js

@@ -0,0 +1,25 @@
+import { operation } from "../../graphApi.js";
+import { generatePath } from "../../services/templatedPaths.js";
+/**
+ * Delete a range.
+ *
+ * @param rangeRef - A reference to the range to be deleted, optionally including session information.
+ * @param shift - The direction to shift existing cells after deletion. Can be "Up" or "Left".
+ * @returns Nothing.
+ * @see https://learn.microsoft.com/en-us/graph/api/range-clear
+ */
+export default function deleteWorkbookRange(rangeRef, shift) {
+    return operation({
+        contextId: rangeRef.contextId,
+        method: "POST",
+        path: generatePath("/sites/{site-id}/drives/{drive-id}/items/{item-id}/workbook/worksheets/{worksheet-id}/range(address='{address}')/delete", rangeRef),
+        headers: {
+            "workbook-session-id": rangeRef.sessionId,
+            "content-type": "application/json",
+        },
+        body: {
+            shift,
+        },
+        responseTransform: () => undefined,
+    });
+}

package/dist/cjs/operations/workbookRange/deleteWorkbookRange.test.d.ts

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

package/dist/cjs/operations/workbookRange/deleteWorkbookRange.test.d.ts.map

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