microsoft-graph 2.0.0 → 2.2.0

package/dist/tasks/getWorkbookTableVisibleBody.test.js

@@ -3,98 +3,98 @@ 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 createWorkbookWorksheet from "../operations/workbookWorksheet/createWorkbookWorksheet.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 deleteDriveItemWithRetry from "./deleteDriveItemWithRetry.js";
 import { getWorkbookTableVisibleBody } from "./getWorkbookTableVisibleBody.js";
 describe("getWorkbookTableVisibleBody", () => {
-    it("can retrieve the visible body range of a table", { timeout: 10000 }, async () => {
+    it("can retrieve the visible body range of a table", async () => {
         const workbookName = generateTempFileName("xlsx");
         const workbookPath = driveItemPath(workbookName);
         const driveRef = getDefaultDriveRef();
         const workbook = await createWorkbook(driveRef, workbookPath);
         try {
-            const worksheet = await createWorkbookWorksheet(workbook);
-            const rangeRef = createWorkbookRangeRef(worksheet, "A1:D4");
+            const worksheetRef = createWorkbookWorksheetRef(workbook, defaultWorkbookWorksheetId);
+            const rangeRef = createWorkbookRangeRef(worksheetRef, "A1:D4");
             const table = await createWorkbookTable(rangeRef, true);
             await updateWorkbookRange(rangeRef, {
                 values: [
                     ["Header1", "Header2", "Header3", "Header4"],
                     ["Value1", "Value2", "Value3", "Value4"],
                     ["Value5", "Value6", "Value7", "Value8"],
-                    ["Value9", "Value10", "Value11", "Value12"]
-                ]
+                    ["Value9", "Value10", "Value11", "Value12"],
+                ],
             });
             await calculateWorkbook(workbook);
             const visibleBodyRange = await getWorkbookTableVisibleBody(table);
             expect(visibleBodyRange.values).toEqual([
                 ["Value1", "Value2", "Value3", "Value4"],
                 ["Value5", "Value6", "Value7", "Value8"],
-                ["Value9", "Value10", "Value11", "Value12"]
+                ["Value9", "Value10", "Value11", "Value12"],
             ]);
         }
         finally {
             await deleteDriveItemWithRetry(workbook);
         }
     });
-    it("omits hidden rows from the visible body range of a table", { timeout: 10000 }, async () => {
+    it("omits hidden rows from the visible body range of a table", async () => {
         const workbookName = generateTempFileName("xlsx");
         const workbookPath = driveItemPath(workbookName);
         const driveRef = getDefaultDriveRef();
         const workbook = await createWorkbook(driveRef, workbookPath);
         try {
-            const worksheet = await createWorkbookWorksheet(workbook);
-            const rangeRef = createWorkbookRangeRef(worksheet, "A1:D4");
+            const worksheetRef = createWorkbookWorksheetRef(workbook, defaultWorkbookWorksheetId);
+            const rangeRef = createWorkbookRangeRef(worksheetRef, "A1:D4");
             const table = await createWorkbookTable(rangeRef, true);
             await updateWorkbookRange(rangeRef, {
                 values: [
                     ["Header1", "Header2", "Header3", "Header4"],
                     ["Value1", "Value2", "Value3", "Value4"],
                     ["Value5", "Value6", "Value7", "Value8"],
-                    ["Value9", "Value10", "Value11", "Value12"]
-                ]
+                    ["Value9", "Value10", "Value11", "Value12"],
+                ],
             });
-            const hiddenRange = createWorkbookRangeRef(worksheet, "2:2");
+            const hiddenRange = createWorkbookRangeRef(worksheetRef, "2:2");
             await updateWorkbookRange(hiddenRange, { rowHidden: true });
             await calculateWorkbook(workbook);
             const visibleBodyRange = await getWorkbookTableVisibleBody(table);
             expect(visibleBodyRange.values).toEqual([
                 ["Value5", "Value6", "Value7", "Value8"],
-                ["Value9", "Value10", "Value11", "Value12"]
+                ["Value9", "Value10", "Value11", "Value12"],
             ]);
         }
         finally {
             await deleteDriveItemWithRetry(workbook);
         }
     });
-    it("omits hidden columns from the visible body range of a table", { timeout: 10000 }, async () => {
+    it("omits hidden columns from the visible body range of a table", async () => {
         const workbookName = generateTempFileName("xlsx");
         const workbookPath = driveItemPath(workbookName);
         const driveRef = getDefaultDriveRef();
         const workbook = await createWorkbook(driveRef, workbookPath);
         try {
-            const worksheet = await createWorkbookWorksheet(workbook);
-            const rangeRef = createWorkbookRangeRef(worksheet, "A1:D4");
+            const worksheetRef = createWorkbookWorksheetRef(workbook, defaultWorkbookWorksheetId);
+            const rangeRef = createWorkbookRangeRef(worksheetRef, "A1:D4");
             const table = await createWorkbookTable(rangeRef, true);
             await updateWorkbookRange(rangeRef, {
                 values: [
                     ["Header1", "Header2", "Header3", "Header4"],
                     ["Value1", "Value2", "Value3", "Value4"],
                     ["Value5", "Value6", "Value7", "Value8"],
-                    ["Value9", "Value10", "Value11", "Value12"]
-                ]
+                    ["Value9", "Value10", "Value11", "Value12"],
+                ],
             });
-            const hiddenRange = createWorkbookRangeRef(worksheet, "B:B");
+            const hiddenRange = createWorkbookRangeRef(worksheetRef, "B:B");
             await updateWorkbookRange(hiddenRange, { columnHidden: true });
             await calculateWorkbook(workbook);
             const visibleBodyRange = await getWorkbookTableVisibleBody(table);
             expect(visibleBodyRange.values).toEqual([
                 ["Value1", "Value3", "Value4"],
                 ["Value5", "Value7", "Value8"],
-                ["Value9", "Value11", "Value12"]
+                ["Value9", "Value11", "Value12"],
             ]);
         }
         finally {

package/dist/tasks/getWorkbookWorksheetRefByName.js

@@ -2,7 +2,7 @@ import listWorkbookWorksheets from "../operations/workbookWorksheet/listWorkbook
 export default async function getWorkbookWorksheetByName(workbookRef, name) {
     // TODO: Probably can get this from a direct API call without fetching all worksheets
     const worksheets = await listWorkbookWorksheets(workbookRef);
-    const worksheet = worksheets.find(worksheetRef => worksheetRef.name === name);
+    const worksheet = worksheets.find((worksheetRef) => worksheetRef.name === name);
     if (!worksheet) {
         throw new Error(`Worksheet '${name}' not found.`); // TODO: Make NotFoundError
     }

package/dist/tasks/safeDeleteWorkbook.d.ts

@@ -0,0 +1,4 @@
+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. */
+export default function safeDeleteWorkbook(workbookRef: WorkbookRef): Promise<void>;
+//# sourceMappingURL=safeDeleteWorkbook.d.ts.map

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

@@ -0,0 +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,yJAAyJ;AACzJ,wBAA8B,kBAAkB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAKxF"}

package/dist/tasks/safeDeleteWorkbook.js

@@ -0,0 +1,9 @@
+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. */
+export default async function safeDeleteWorkbook(workbookRef) {
+    if (workbookRef.sessionId) {
+        await closeWorkbookSession(workbookRef);
+    }
+    await deleteDriveItemWithRetry(workbookRef);
+}

package/dist/tasks/setColumnHidden.js

@@ -1,7 +1,6 @@
 import updateWorkbookRange from "../operations/workbookRange/updateWorkbookRange.js";
 export default async function setColumnHidden(rangeRef, hidden) {
     await updateWorkbookRange(rangeRef, {
-        columnHidden: hidden
+        columnHidden: hidden,
     });
 }
-;

package/dist/tasks/setColumnHidden.test.js

@@ -4,14 +4,14 @@ import createWorkbook from "../operations/workbook/createWorkbook.js";
 import getWorkbookVisibleRange from "../operations/workbookRange/getWorkbookVisibleRange.js";
 import updateWorkbookRange from "../operations/workbookRange/updateWorkbookRange.js";
 import { getDefaultDriveRef } from "../services/drive.js";
-import { driveItemPath, } from "../services/driveItem.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 deleteDriveItemWithRetry from "./deleteDriveItemWithRetry.js";
 import setColumnHidden from "./setColumnHidden.js";
 describe("setColumnHidden", () => {
-    it("hides a column in an existing workbook", { timeout: 10000 }, async () => {
+    it("hides a column in an existing workbook", async () => {
         const workbookName = generateTempFileName("xlsx");
         const workbookPath = driveItemPath(workbookName);
         const driveRef = getDefaultDriveRef();
@@ -23,8 +23,8 @@ describe("setColumnHidden", () => {
                 values: [
                     [1, 2, 3],
                     [4, 5, 6],
-                    [7, 8, 9]
-                ]
+                    [7, 8, 9],
+                ],
             });
             const hiddenRange = createWorkbookRangeRef(worksheetRef, "B:B");
             await setColumnHidden(hiddenRange, true);
@@ -33,7 +33,7 @@ describe("setColumnHidden", () => {
             expect(visibleView.values).toEqual([
                 [1, 3],
                 [4, 6],
-                [7, 9]
+                [7, 9],
             ]);
         }
         finally {

package/dist/tasks/setRowHidden.js

@@ -1,7 +1,6 @@
 import updateWorkbookRange from "../operations/workbookRange/updateWorkbookRange.js";
 export default async function setRowHidden(rangeRef, hidden) {
     await updateWorkbookRange(rangeRef, {
-        rowHidden: hidden
+        rowHidden: hidden,
     });
 }
-;

package/dist/tasks/setRowHidden.test.js

@@ -4,14 +4,14 @@ import createWorkbook from "../operations/workbook/createWorkbook.js";
 import getWorkbookVisibleRange from "../operations/workbookRange/getWorkbookVisibleRange.js";
 import updateWorkbookRange from "../operations/workbookRange/updateWorkbookRange.js";
 import { getDefaultDriveRef } from "../services/drive.js";
-import { driveItemPath, } from "../services/driveItem.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 deleteDriveItemWithRetry from "./deleteDriveItemWithRetry.js";
 import setRowHidden from "./setRowHidden.js";
 describe("setRowHidden", () => {
-    it("hides a row in an existing workbook", { timeout: 10000 }, async () => {
+    it("hides a row in an existing workbook", async () => {
         const workbookName = generateTempFileName("xlsx");
         const workbookPath = driveItemPath(workbookName);
         const driveRef = getDefaultDriveRef();
@@ -23,8 +23,8 @@ describe("setRowHidden", () => {
                 values: [
                     [1, 2, 3],
                     [4, 5, 6],
-                    [7, 8, 9]
-                ]
+                    [7, 8, 9],
+                ],
             });
             const hiddenRange = createWorkbookRangeRef(worksheetRef, "2:2");
             await setRowHidden(hiddenRange, true);
@@ -32,7 +32,7 @@ describe("setRowHidden", () => {
             const visibleView = await getWorkbookVisibleRange(rangeRef);
             expect(visibleView.values).toEqual([
                 [1, 2, 3],
-                [7, 8, 9]
+                [7, 8, 9],
             ]);
         }
         finally {

package/dist/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["../src/index.ts"],"version":"5.7.3"}

package/docs/lockedWorkbook.md

@@ -0,0 +1,2 @@
+# "The resource you are attempting to access is locked"
+If you attempt to delete a workbook you may occasionally get this error. To mitigate this call [`safeDeleteWorkbook`](/src/tasks/safeDeleteWorkbook.ts) instead of `deleteDriveItem`. It will attempt to close any active session first, and then delete with a retry in case it takes some time for the lock to be removed.

package/docs/pivotTables.md

@@ -0,0 +1,9 @@
+# Pivot Tables
+
+As of the time of writing, the Graph API does not support creating or modifying pivot tables. Consequently, this SDK does not include pivot table support. Additionally, most Excel manipulation libraries do not provide robust support for pivot tables. If you require pivot table functionality, your options are limited to the following:
+
+* **Use a pre-designed template**: Create an Excel template with a pivot table, upload it to SharePoint (possibly using this SDK), and modify it using the Graph API.
+* **Explore specialized Excel libraries**: Some commercial Excel libraries offer pivot table support, but they typically require a paid license.
+* **Manually edit the workbook's XML**: This involves directly manipulating the XML structure of the workbook locally.
+
+In summary: There are no straightforward solutions for working with pivot tables via the Graph API or this SDK. If possible, it is recommended to avoid relying on pivot tables.

package/docs/requestRetrying.md

@@ -0,0 +1,3 @@
+# Request retrying
+
+[GraphAPI has unmerciful throttling limits](https://learn.microsoft.com/en-us/graph/throttling). If the rate of requests exceed it's predefined limits it will reject requests with a HTTP 429. It appears there are general limits, and then more restrictive limits applied to workbook manipulation. To cater for these limits. This library supports retrying. If a request is throttled, and GraphAPI has provided a retry time, then the library will honour that request and retry automatically. Nothing needs to be done when consuming the library.