microsoft-graph 2.3.1 → 2.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (89) hide show
  1. package/README.md +2 -2
  2. package/dist/models/WorkbookTableColumnRef.d.ts +6 -0
  3. package/dist/models/WorkbookTableColumnRef.d.ts.map +1 -0
  4. package/dist/models/WorkbookTableColumnRef.js +1 -0
  5. package/dist/operations/driveItem/getDriveItem.test.js +2 -2
  6. package/dist/operations/driveItem/getDriveItemByPath.test.js +2 -2
  7. package/dist/operations/driveItem/getDriveItemContent.test.js +2 -2
  8. package/dist/operations/driveItem/initiateCopyDriveItem.test.js +3 -3
  9. package/dist/operations/driveItem/listDriveItems.test.js +2 -2
  10. package/dist/operations/workbook/calculateWorkbook.test.js +4 -4
  11. package/dist/operations/workbook/createWorkbook.test.js +2 -2
  12. package/dist/operations/workbookRange/clearWorkbookRange.test.js +3 -3
  13. package/dist/operations/workbookRange/deleteWorkbookRange.test.js +3 -3
  14. package/dist/operations/workbookRange/getWorkbookRangeFormat.test.js +2 -2
  15. package/dist/operations/workbookRange/getWorkbookUsedRange.d.ts +1 -5
  16. package/dist/operations/workbookRange/getWorkbookUsedRange.d.ts.map +1 -1
  17. package/dist/operations/workbookRange/getWorkbookUsedRange.js +1 -5
  18. package/dist/operations/workbookRange/getWorkbookVisibleRange.test.js +5 -5
  19. package/dist/operations/workbookRange/getWorkbookWorksheetRange.test.js +2 -2
  20. package/dist/operations/workbookRange/insertWorkbookCells.test.js +2 -2
  21. package/dist/operations/workbookRange/updateWorkbookRange.test.js +3 -3
  22. package/dist/operations/workbookTable/applyWorkbookTableColulmnFilter.test.d.ts +2 -0
  23. package/dist/operations/workbookTable/applyWorkbookTableColulmnFilter.test.d.ts.map +1 -0
  24. package/dist/operations/workbookTable/applyWorkbookTableColulmnFilter.test.js +45 -0
  25. package/dist/operations/workbookTable/applyWorkbookTableColumnFilter.d.ts +13 -0
  26. package/dist/operations/workbookTable/applyWorkbookTableColumnFilter.d.ts.map +1 -0
  27. package/dist/operations/workbookTable/applyWorkbookTableColumnFilter.js +25 -0
  28. package/dist/operations/workbookTable/clearWorkbookTableFilters.d.ts +10 -0
  29. package/dist/operations/workbookTable/clearWorkbookTableFilters.d.ts.map +1 -0
  30. package/dist/operations/workbookTable/clearWorkbookTableFilters.js +20 -0
  31. package/dist/operations/workbookTable/clearWorkbookTableFilters.test.d.ts +2 -0
  32. package/dist/operations/workbookTable/clearWorkbookTableFilters.test.d.ts.map +1 -0
  33. package/dist/operations/workbookTable/clearWorkbookTableFilters.test.js +51 -0
  34. package/dist/operations/workbookTable/createWorkbookTable.test.js +2 -2
  35. package/dist/operations/workbookTable/deleteWorkbookTable.d.ts +10 -0
  36. package/dist/operations/workbookTable/deleteWorkbookTable.d.ts.map +1 -0
  37. package/dist/operations/workbookTable/deleteWorkbookTable.js +22 -0
  38. package/dist/operations/workbookTable/deleteWorkbookTable.test.d.ts +2 -0
  39. package/dist/operations/workbookTable/deleteWorkbookTable.test.d.ts.map +1 -0
  40. package/dist/operations/workbookTable/deleteWorkbookTable.test.js +48 -0
  41. package/dist/operations/workbookTable/deleteWorkbookTablePreservingValues.d.ts +10 -0
  42. package/dist/operations/workbookTable/deleteWorkbookTablePreservingValues.d.ts.map +1 -0
  43. package/dist/operations/workbookTable/deleteWorkbookTablePreservingValues.js +20 -0
  44. package/dist/operations/workbookTable/deleteWorkbookTablePreservingValues.test.d.ts +2 -0
  45. package/dist/operations/workbookTable/deleteWorkbookTablePreservingValues.test.d.ts.map +1 -0
  46. package/dist/operations/workbookTable/deleteWorkbookTablePreservingValues.test.js +48 -0
  47. package/dist/operations/workbookTable/getWorkbookTable.test.js +2 -2
  48. package/dist/operations/workbookTable/getWorkbookTableBodyRange.test.js +3 -3
  49. package/dist/operations/workbookTable/getWorkbookTableBodyVisibleRange.d.ts +13 -0
  50. package/dist/operations/workbookTable/getWorkbookTableBodyVisibleRange.d.ts.map +1 -0
  51. package/dist/operations/workbookTable/getWorkbookTableBodyVisibleRange.js +29 -0
  52. package/dist/operations/workbookTable/getWorkbookTableBodyVisibleRange.test.d.ts +2 -0
  53. package/dist/operations/workbookTable/getWorkbookTableBodyVisibleRange.test.d.ts.map +1 -0
  54. package/dist/operations/workbookTable/getWorkbookTableBodyVisibleRange.test.js +45 -0
  55. package/dist/operations/workbookTable/getWorkbookTableHeaderRange.test.js +2 -2
  56. package/dist/operations/workbookTable/listWorkbookTableColumns.test.js +2 -2
  57. package/dist/operations/workbookTable/listWorkbookTableRows.test.js +2 -2
  58. package/dist/operations/workbookTable/listWorkbookTables.test.js +2 -2
  59. package/dist/operations/workbookWorksheet/createWorkbookWorksheet.test.js +3 -3
  60. package/dist/operations/workbookWorksheet/deleteWorkbookWorksheet.test.js +2 -2
  61. package/dist/operations/workbookWorksheet/getWorkbookWorksheetUsedRange.d.ts +13 -0
  62. package/dist/operations/workbookWorksheet/getWorkbookWorksheetUsedRange.d.ts.map +1 -0
  63. package/dist/operations/workbookWorksheet/getWorkbookWorksheetUsedRange.js +33 -0
  64. package/dist/operations/workbookWorksheet/getWorkbookWorksheetUsedRange.test.d.ts +2 -0
  65. package/dist/operations/workbookWorksheet/getWorkbookWorksheetUsedRange.test.d.ts.map +1 -0
  66. package/dist/operations/workbookWorksheet/getWorkbookWorksheetUsedRange.test.js +54 -0
  67. package/dist/operations/workbookWorksheet/getWorkbookWorksheetUsedVisibleRange.d.ts +13 -0
  68. package/dist/operations/workbookWorksheet/getWorkbookWorksheetUsedVisibleRange.d.ts.map +1 -0
  69. package/dist/operations/workbookWorksheet/getWorkbookWorksheetUsedVisibleRange.js +29 -0
  70. package/dist/operations/workbookWorksheet/getWorkbookWorksheetUsedVisibleRange.test.d.ts +2 -0
  71. package/dist/operations/workbookWorksheet/getWorkbookWorksheetUsedVisibleRange.test.d.ts.map +1 -0
  72. package/dist/operations/workbookWorksheet/getWorkbookWorksheetUsedVisibleRange.test.js +37 -0
  73. package/dist/operations/workbookWorksheet/listWorkbookWorksheets.test.js +3 -3
  74. package/dist/operations/workbookWorksheet/updateWorkbookWorksheet.test.js +3 -3
  75. package/dist/services/workbookTableColumn.d.ts +12 -0
  76. package/dist/services/workbookTableColumn.d.ts.map +1 -0
  77. package/dist/services/workbookTableColumn.js +22 -0
  78. package/dist/tasks/getRangeLastUsedCell.test.js +4 -4
  79. package/dist/tasks/getWorkbookTableVisibleBody.d.ts +1 -6
  80. package/dist/tasks/getWorkbookTableVisibleBody.d.ts.map +1 -1
  81. package/dist/tasks/getWorkbookTableVisibleBody.js +1 -6
  82. package/dist/tasks/setColumnHidden.test.js +2 -2
  83. package/dist/tasks/setRowHidden.test.js +2 -2
  84. package/dist/tasks/setWorkbookTableBodyVisibleRows.test.js +8 -8
  85. package/dist/tasks/tryDeleteDriveItem.d.ts +9 -0
  86. package/dist/tasks/tryDeleteDriveItem.d.ts.map +1 -0
  87. package/dist/tasks/tryDeleteDriveItem.js +16 -0
  88. package/docs/findingSiteDriveId.md +21 -0
  89. package/package.json +41 -1
package/README.md CHANGED
@@ -14,8 +14,8 @@ Something like this, but whatever works in your context.
14
14
  const tenantId = getEnvironmentVariable("AZURE_TENANT_ID") as TenantId;
15
15
  const clientId = getEnvironmentVariable("AZURE_CLIENT_ID") as ClientId;
16
16
  const clientSecret = getEnvironmentVariable("AZURE_CLIENT_SECRET") as ClientSecret;
17
- const siteId = getEnvironmentVariable("SHAREPOINT_SITE_ID") as SiteId;
18
- const driveId = getEnvironmentVariable("SHAREPOINT_DRIVE_ID") as DriveId;
17
+ const siteId = getEnvironmentVariable("SHAREPOINT_DEFAULT_SITE_ID") as SiteId;
18
+ const driveId = getEnvironmentVariable("SHAREPOINT_DEFAULT_DRIVE_ID") as DriveId;
19
19
  ```
20
20
 
21
21
  ### Get reference to drive
@@ -0,0 +1,6 @@
1
+ import type { ColumnAddress } from "./Address.ts";
2
+ import type { WorkbookTableRef } from "./WorkbookTableRef.ts";
3
+ export type WorkbookTableColumnRef = WorkbookTableRef & {
4
+ column: ColumnAddress;
5
+ };
6
+ //# sourceMappingURL=WorkbookTableColumnRef.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"WorkbookTableColumnRef.d.ts","sourceRoot":"","sources":["../../src/models/WorkbookTableColumnRef.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAClD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAE9D,MAAM,MAAM,sBAAsB,GAAG,gBAAgB,GAAG;IACvD,MAAM,EAAE,aAAa,CAAC;CACtB,CAAC"}
@@ -0,0 +1 @@
1
+ export {};
@@ -1,7 +1,7 @@
1
1
  import { describe, expect, it } from "vitest";
2
2
  import { getDefaultDriveRef } from "../../services/drive.js";
3
3
  import { generateTempFileName } from "../../services/temporaryFiles.js";
4
- import deleteDriveItemWithRetry from "../../tasks/deleteDriveItemWithRetry.js";
4
+ import tryDeleteDriveItem from "../../tasks/tryDeleteDriveItem.js";
5
5
  import createFolder from "../drive/createFolder.js";
6
6
  import getDriveItem from "./getDriveItem.js";
7
7
  describe("getDriveItem", () => {
@@ -12,7 +12,7 @@ describe("getDriveItem", () => {
12
12
  const retrievedFolder = await getDriveItem(folder);
13
13
  expect(retrievedFolder.id).toBe(folder.id);
14
14
  expect(retrievedFolder.name).toBe(folderName);
15
- await deleteDriveItemWithRetry(folder);
15
+ await tryDeleteDriveItem(folder);
16
16
  });
17
17
  it("throws an error when trying to retrieve a non-existent item", async () => {
18
18
  const nonExistentItemRef = {
@@ -2,7 +2,7 @@ import { describe, expect, it } from "vitest";
2
2
  import { getDefaultDriveRef } from "../../services/drive.js";
3
3
  import { driveItemPath } from "../../services/driveItem.js";
4
4
  import { generateTempFileName } from "../../services/temporaryFiles.js";
5
- import deleteDriveItemWithRetry from "../../tasks/deleteDriveItemWithRetry.js";
5
+ import tryDeleteDriveItem from "../../tasks/tryDeleteDriveItem.js";
6
6
  import createFolder from "../drive/createFolder.js";
7
7
  import getDriveItemByPath from "./getDriveItemByPath.js";
8
8
  describe("getDriveItemByPath", () => {
@@ -13,7 +13,7 @@ describe("getDriveItemByPath", () => {
13
13
  const retrievedFolder = await getDriveItemByPath(getDefaultDriveRef(), folderPath);
14
14
  expect(retrievedFolder.id).toBe(folder.id);
15
15
  expect(retrievedFolder.name).toBe(folderName);
16
- await deleteDriveItemWithRetry(folder);
16
+ await tryDeleteDriveItem(folder);
17
17
  });
18
18
  it("throws an error when trying to retrieve a non-existent item by path", async () => {
19
19
  const nonExistentItemPath = driveItemPath("non-existent-item-path");
@@ -4,7 +4,7 @@ import { createDriveItemRef, driveItemPath } from "../../services/driveItem.js";
4
4
  import { generateTempFileName } from "../../services/temporaryFiles.js";
5
5
  import { createWorkbookRangeRef } from "../../services/workbookRange.js";
6
6
  import { createWorkbookWorksheetRef, defaultWorkbookWorksheetId } from "../../services/workbookWorksheet.js";
7
- import deleteDriveItemWithRetry from "../../tasks/deleteDriveItemWithRetry.js";
7
+ import tryDeleteDriveItem from "../../tasks/tryDeleteDriveItem.js";
8
8
  import calculateWorkbook from "../workbook/calculateWorkbook.js";
9
9
  import createWorkbook from "../workbook/createWorkbook.js";
10
10
  import updateWorkbookRange from "../workbookRange/updateWorkbookRange.js";
@@ -25,7 +25,7 @@ describe("getDriveItemContent", () => {
25
25
  expect(content.byteLength).toBeGreaterThan(0);
26
26
  }
27
27
  finally {
28
- await deleteDriveItemWithRetry(workbook);
28
+ await tryDeleteDriveItem(workbook);
29
29
  }
30
30
  });
31
31
  it("throws an error when trying to download a non-existent item", async () => {
@@ -2,7 +2,7 @@ import { describe, expect, it } from "vitest";
2
2
  import { getDefaultDriveRef } from "../../services/drive.js";
3
3
  import { driveItemPath } from "../../services/driveItem.js";
4
4
  import { generateTempFileName } from "../../services/temporaryFiles.js";
5
- import deleteDriveItemWithRetry from "../../tasks/deleteDriveItemWithRetry.js";
5
+ import tryDeleteDriveItem from "../../tasks/tryDeleteDriveItem.js";
6
6
  import createFolder from "../drive/createFolder.js";
7
7
  import getDriveItemByPath from "./getDriveItemByPath.js";
8
8
  import initiateCopyDriveItem from "./initiateCopyDriveItem.js";
@@ -21,8 +21,8 @@ describe("initiateCopyDriveItem", () => {
21
21
  expect(copyFolder.webUrl?.endsWith(copyPath)).toBeTruthy();
22
22
  }
23
23
  finally {
24
- await deleteDriveItemWithRetry(srcFolder);
25
- await deleteDriveItemWithRetry(dstFolder);
24
+ await tryDeleteDriveItem(srcFolder);
25
+ await tryDeleteDriveItem(dstFolder);
26
26
  }
27
27
  });
28
28
  });
@@ -1,7 +1,7 @@
1
1
  import { describe, expect, it } from "vitest";
2
2
  import { getDefaultDriveRef } from "../../services/drive.js";
3
3
  import { generateTempFileName } from "../../services/temporaryFiles.js";
4
- import deleteDriveItemWithRetry from "../../tasks/deleteDriveItemWithRetry.js";
4
+ import tryDeleteDriveItem from "../../tasks/tryDeleteDriveItem.js";
5
5
  import createFolder from "../drive/createFolder.js";
6
6
  import listDriveItems from "./listDriveItems.js";
7
7
  describe("listDriveItems", () => {
@@ -18,7 +18,7 @@ describe("listDriveItems", () => {
18
18
  expect(items).toBeInstanceOf(Array);
19
19
  }
20
20
  finally {
21
- await deleteDriveItemWithRetry(folder);
21
+ await tryDeleteDriveItem(folder);
22
22
  }
23
23
  });
24
24
  });
@@ -2,7 +2,7 @@ import { describe, it } from "vitest";
2
2
  import { getDefaultDriveRef } from "../../services/drive.js";
3
3
  import { driveItemPath } from "../../services/driveItem.js";
4
4
  import { generateTempFileName } from "../../services/temporaryFiles.js";
5
- import deleteDriveItemWithRetry from "../../tasks/deleteDriveItemWithRetry.js";
5
+ import tryDeleteDriveItem from "../../tasks/tryDeleteDriveItem.js";
6
6
  import calculateWorkbook from "./calculateWorkbook.js";
7
7
  import createWorkbook from "./createWorkbook.js";
8
8
  describe("calculateWorkbook", () => {
@@ -16,7 +16,7 @@ describe("calculateWorkbook", () => {
16
16
  await calculateWorkbook(workbook, "Recalculate");
17
17
  }
18
18
  finally {
19
- await deleteDriveItemWithRetry(workbook);
19
+ await tryDeleteDriveItem(workbook);
20
20
  }
21
21
  });
22
22
  it(`can calculate workbook with calculation type: 'Full'`, async () => {
@@ -28,7 +28,7 @@ describe("calculateWorkbook", () => {
28
28
  await calculateWorkbook(workbook, "Full");
29
29
  }
30
30
  finally {
31
- await deleteDriveItemWithRetry(workbook);
31
+ await tryDeleteDriveItem(workbook);
32
32
  }
33
33
  });
34
34
  it(`can calculate workbook with calculation type: 'FullRebuild'`, async () => {
@@ -40,7 +40,7 @@ describe("calculateWorkbook", () => {
40
40
  await calculateWorkbook(workbook, "FullRebuild");
41
41
  }
42
42
  finally {
43
- await deleteDriveItemWithRetry(workbook);
43
+ await tryDeleteDriveItem(workbook);
44
44
  }
45
45
  });
46
46
  });
@@ -2,7 +2,7 @@ import { describe, expect, it } from "vitest";
2
2
  import { getDefaultDriveRef } from "../../services/drive.js";
3
3
  import { driveItemPath } from "../../services/driveItem.js";
4
4
  import { generateTempFileName } from "../../services/temporaryFiles.js";
5
- import deleteDriveItemWithRetry from "../../tasks/deleteDriveItemWithRetry.js";
5
+ import tryDeleteDriveItem from "../../tasks/tryDeleteDriveItem.js";
6
6
  import createWorkbook from "./createWorkbook.js";
7
7
  describe("createWorkbook", () => {
8
8
  it("can create a new workbook", async () => {
@@ -10,6 +10,6 @@ describe("createWorkbook", () => {
10
10
  const workbookPath = driveItemPath(workbookName);
11
11
  const workbook = await createWorkbook(getDefaultDriveRef(), workbookPath);
12
12
  expect(workbook.name).toBe(workbookName);
13
- await deleteDriveItemWithRetry(workbook);
13
+ await tryDeleteDriveItem(workbook);
14
14
  });
15
15
  });
@@ -5,7 +5,7 @@ import { driveItemPath } from "../../services/driveItem.js";
5
5
  import { generateTempFileName } from "../../services/temporaryFiles.js";
6
6
  import { createWorkbookRangeRef } from "../../services/workbookRange.js";
7
7
  import { createWorkbookWorksheetRef, defaultWorkbookWorksheetId } from "../../services/workbookWorksheet.js";
8
- import deleteDriveItemWithRetry from "../../tasks/deleteDriveItemWithRetry.js";
8
+ import tryDeleteDriveItem from "../../tasks/tryDeleteDriveItem.js";
9
9
  import calculateWorkbook from "../workbook/calculateWorkbook.js";
10
10
  import createWorkbook from "../workbook/createWorkbook.js";
11
11
  import clearWorkbookRange from "./clearWorkbookRange.js";
@@ -37,7 +37,7 @@ describe("clearWorkbookRange", () => {
37
37
  expect(clearedRange.values).toEqual(clearedValues);
38
38
  }
39
39
  finally {
40
- await deleteDriveItemWithRetry(workbook);
40
+ await tryDeleteDriveItem(workbook);
41
41
  }
42
42
  });
43
43
  it("can clear a range in an existing workbook sequential", async () => {
@@ -54,7 +54,7 @@ describe("clearWorkbookRange", () => {
54
54
  expect(clearedRange.values).toEqual(clearedValues);
55
55
  }
56
56
  finally {
57
- await deleteDriveItemWithRetry(workbook);
57
+ await tryDeleteDriveItem(workbook);
58
58
  }
59
59
  });
60
60
  });
@@ -5,7 +5,7 @@ import { driveItemPath } from "../../services/driveItem.js";
5
5
  import { generateTempFileName } from "../../services/temporaryFiles.js";
6
6
  import { createWorkbookRangeRef } from "../../services/workbookRange.js";
7
7
  import { createWorkbookWorksheetRef, defaultWorkbookWorksheetId } from "../../services/workbookWorksheet.js";
8
- import deleteDriveItemWithRetry from "../../tasks/deleteDriveItemWithRetry.js";
8
+ import tryDeleteDriveItem from "../../tasks/tryDeleteDriveItem.js";
9
9
  import calculateWorkbook from "../workbook/calculateWorkbook.js";
10
10
  import createWorkbook from "../workbook/createWorkbook.js";
11
11
  import deleteWorkbookRange from "./deleteWorkbookRange.js";
@@ -37,7 +37,7 @@ describe("deleteWorkbookRange", () => {
37
37
  expect(deletedRange.values).toEqual(clearedValues);
38
38
  }
39
39
  finally {
40
- await deleteDriveItemWithRetry(workbook);
40
+ await tryDeleteDriveItem(workbook);
41
41
  }
42
42
  });
43
43
  it("can delete a range in an existing workbook sequential", async () => {
@@ -58,7 +58,7 @@ describe("deleteWorkbookRange", () => {
58
58
  expect(deletedRange.values).toEqual(clearedValues);
59
59
  }
60
60
  finally {
61
- await deleteDriveItemWithRetry(workbook);
61
+ await tryDeleteDriveItem(workbook);
62
62
  }
63
63
  });
64
64
  });
@@ -4,7 +4,7 @@ import { driveItemPath } from "../../services/driveItem.js";
4
4
  import { generateTempFileName } from "../../services/temporaryFiles.js";
5
5
  import { createWorkbookRangeRef } from "../../services/workbookRange.js";
6
6
  import { createWorkbookWorksheetRef, defaultWorkbookWorksheetId } from "../../services/workbookWorksheet.js";
7
- import deleteDriveItemWithRetry from "../../tasks/deleteDriveItemWithRetry.js";
7
+ import tryDeleteDriveItem from "../../tasks/tryDeleteDriveItem.js";
8
8
  import createWorkbook from "../workbook/createWorkbook.js";
9
9
  import getWorkbookRangeFormat from "./getWorkbookRangeFormat.js";
10
10
  import updateWorkbookRange from "./updateWorkbookRange.js";
@@ -27,7 +27,7 @@ describe("getWorkbookRangeFormat", () => {
27
27
  expect(format.verticalAlignment).toBe("Bottom");
28
28
  }
29
29
  finally {
30
- await deleteDriveItemWithRetry(workbook);
30
+ await tryDeleteDriveItem(workbook);
31
31
  }
32
32
  });
33
33
  });
@@ -3,11 +3,7 @@ import type { GraphOperation } from "../../models/GraphOperation.ts";
3
3
  import type { WorkbookRangeRef } from "../../models/WorkbookRangeRef.ts";
4
4
  import type { WorkbookWorksheetRef } from "../../models/WorkbookWorksheetRef.ts";
5
5
  /**
6
- * Retrieve the used range in a worksheet, ignoring trailing rows and columns that are blank.
7
- *
8
- * @param worksheetRef - A reference to the worksheet, optionally including session information.
9
- * @returns The used range of the worksheet, including its metadata and reference information.
10
- * @see https://learn.microsoft.com/en-us/graph/api/range-usedrange
6
+ * @deprecated Use `getWorkbookWorksheetUsedRange` instead.
11
7
  */
12
8
  export default function getWorkbookUsedRange(worksheetRef: WorkbookWorksheetRef): GraphOperation<WorkbookRange & WorkbookRangeRef>;
13
9
  //# sourceMappingURL=getWorkbookUsedRange.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"getWorkbookUsedRange.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookRange/getWorkbookUsedRange.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,oBAAoB,CAAC,YAAY,EAAE,oBAAoB,GAAG,cAAc,CAAC,aAAa,GAAG,gBAAgB,CAAC,CAsBjI"}
1
+ {"version":3,"file":"getWorkbookUsedRange.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookRange/getWorkbookUsedRange.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;;GAEG;AACH,MAAM,CAAC,OAAO,UAAU,oBAAoB,CAAC,YAAY,EAAE,oBAAoB,GAAG,cAAc,CAAC,aAAa,GAAG,gBAAgB,CAAC,CAsBjI"}
@@ -3,11 +3,7 @@ import { operation } from "../../graphApi.js";
3
3
  import { generatePath } from "../../services/templatedPaths.js";
4
4
  import { createWorkbookRangeRef } from "../../services/workbookRange.js";
5
5
  /**
6
- * Retrieve the used range in a worksheet, ignoring trailing rows and columns that are blank.
7
- *
8
- * @param worksheetRef - A reference to the worksheet, optionally including session information.
9
- * @returns The used range of the worksheet, including its metadata and reference information.
10
- * @see https://learn.microsoft.com/en-us/graph/api/range-usedrange
6
+ * @deprecated Use `getWorkbookWorksheetUsedRange` instead.
11
7
  */
12
8
  export default function getWorkbookUsedRange(worksheetRef) {
13
9
  return operation({
@@ -5,7 +5,7 @@ import { driveItemPath } from "../../services/driveItem.js";
5
5
  import { generateTempFileName } from "../../services/temporaryFiles.js";
6
6
  import { createWorkbookRangeRef } from "../../services/workbookRange.js";
7
7
  import { createWorkbookWorksheetRef, defaultWorkbookWorksheetId } from "../../services/workbookWorksheet.js";
8
- import deleteDriveItemWithRetry from "../../tasks/deleteDriveItemWithRetry.js";
8
+ import tryDeleteDriveItem from "../../tasks/tryDeleteDriveItem.js";
9
9
  import calculateWorkbook from "../workbook/calculateWorkbook.js";
10
10
  import createWorkbook from "../workbook/createWorkbook.js";
11
11
  import getWorkbookVisibleRange from "./getWorkbookVisibleRange.js";
@@ -29,7 +29,7 @@ describe("getWorkbookRangeVisible", () => {
29
29
  expect(visibleView).toBeDefined();
30
30
  }
31
31
  finally {
32
- await deleteDriveItemWithRetry(workbook);
32
+ await tryDeleteDriveItem(workbook);
33
33
  }
34
34
  });
35
35
  it("can retrieve the visible view of a range in an existing workbook sequential", async () => {
@@ -44,7 +44,7 @@ describe("getWorkbookRangeVisible", () => {
44
44
  expect(visibleView).toBeDefined();
45
45
  }
46
46
  finally {
47
- await deleteDriveItemWithRetry(workbook);
47
+ await tryDeleteDriveItem(workbook);
48
48
  }
49
49
  });
50
50
  it("omits hidden row from the visible view of a range", async () => {
@@ -75,7 +75,7 @@ describe("getWorkbookRangeVisible", () => {
75
75
  ]);
76
76
  }
77
77
  finally {
78
- await deleteDriveItemWithRetry(workbook);
78
+ await tryDeleteDriveItem(workbook);
79
79
  }
80
80
  });
81
81
  it("omits hidden column from the visible view of a range", async () => {
@@ -103,7 +103,7 @@ describe("getWorkbookRangeVisible", () => {
103
103
  ]);
104
104
  }
105
105
  finally {
106
- await deleteDriveItemWithRetry(workbook);
106
+ await tryDeleteDriveItem(workbook);
107
107
  }
108
108
  });
109
109
  });
@@ -4,7 +4,7 @@ import { driveItemPath } from "../../services/driveItem.js";
4
4
  import { generateTempFileName } from "../../services/temporaryFiles.js";
5
5
  import { createWorkbookRangeRef } from "../../services/workbookRange.js";
6
6
  import { createWorkbookWorksheetRef, defaultWorkbookWorksheetId } from "../../services/workbookWorksheet.js";
7
- import deleteDriveItemWithRetry from "../../tasks/deleteDriveItemWithRetry.js";
7
+ import tryDeleteDriveItem from "../../tasks/tryDeleteDriveItem.js";
8
8
  import createWorkbook from "../workbook/createWorkbook.js";
9
9
  import updateWorkbookRange from "./updateWorkbookRange.js";
10
10
  const values = [
@@ -26,7 +26,7 @@ describe("getWorkbookRange", () => {
26
26
  expect(range.values).toEqual(values);
27
27
  }
28
28
  finally {
29
- await deleteDriveItemWithRetry(workbook);
29
+ await tryDeleteDriveItem(workbook);
30
30
  }
31
31
  });
32
32
  });
@@ -4,7 +4,7 @@ import { driveItemPath } from "../../services/driveItem.js";
4
4
  import { generateTempFileName } from "../../services/temporaryFiles.js";
5
5
  import { createWorkbookRangeRef } from "../../services/workbookRange.js";
6
6
  import { createWorkbookWorksheetRef, defaultWorkbookWorksheetId } from "../../services/workbookWorksheet.js";
7
- import deleteDriveItemWithRetry from "../../tasks/deleteDriveItemWithRetry.js";
7
+ import tryDeleteDriveItem from "../../tasks/tryDeleteDriveItem.js";
8
8
  import calculateWorkbook from "../workbook/calculateWorkbook.js";
9
9
  import createWorkbook from "../workbook/createWorkbook.js";
10
10
  import getWorkbookUsedRange from "./getWorkbookUsedRange.js";
@@ -34,7 +34,7 @@ describe("insertWorkbookCells", () => {
34
34
  expect(insertedRange.values).toEqual(finalValues);
35
35
  }
36
36
  finally {
37
- await deleteDriveItemWithRetry(workbook);
37
+ await tryDeleteDriveItem(workbook);
38
38
  }
39
39
  });
40
40
  });
@@ -5,7 +5,7 @@ import { driveItemPath } from "../../services/driveItem.js";
5
5
  import { generateTempFileName } from "../../services/temporaryFiles.js";
6
6
  import { createWorkbookRangeRef } from "../../services/workbookRange.js";
7
7
  import { createWorkbookWorksheetRef, defaultWorkbookWorksheetId } from "../../services/workbookWorksheet.js";
8
- import deleteDriveItemWithRetry from "../../tasks/deleteDriveItemWithRetry.js";
8
+ import tryDeleteDriveItem from "../../tasks/tryDeleteDriveItem.js";
9
9
  import calculateWorkbook from "../workbook/calculateWorkbook.js";
10
10
  import createWorkbook from "../workbook/createWorkbook.js";
11
11
  import getWorkbookWorksheetRange from "./getWorkbookWorksheetRange.js";
@@ -31,7 +31,7 @@ describe("updateWorkbookRange", () => {
31
31
  expect(updatedRange.values).toEqual(values);
32
32
  }
33
33
  finally {
34
- await deleteDriveItemWithRetry(workbook);
34
+ await tryDeleteDriveItem(workbook);
35
35
  }
36
36
  });
37
37
  it("can update a range in an existing workbook sequential", async () => {
@@ -48,7 +48,7 @@ describe("updateWorkbookRange", () => {
48
48
  expect(updatedRange.values).toEqual(values);
49
49
  }
50
50
  finally {
51
- await deleteDriveItemWithRetry(workbook);
51
+ await tryDeleteDriveItem(workbook);
52
52
  }
53
53
  });
54
54
  });
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=applyWorkbookTableColulmnFilter.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"applyWorkbookTableColulmnFilter.test.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookTable/applyWorkbookTableColulmnFilter.test.ts"],"names":[],"mappings":""}
@@ -0,0 +1,45 @@
1
+ import { describe, expect, it } from "vitest";
2
+ import { getDefaultDriveRef } from "../../services/drive.js";
3
+ import { driveItemPath } from "../../services/driveItem.js";
4
+ import { generateTempFileName } from "../../services/temporaryFiles.js";
5
+ import { createWorkbookRangeRef } from "../../services/workbookRange.js";
6
+ import { createWorkbookTableColumnRef } from "../../services/workbookTableColumn.js";
7
+ import { createDefaultWorkbookWorksheetRef } from "../../services/workbookWorksheet.js";
8
+ import tryDeleteDriveItem from "../../tasks/tryDeleteDriveItem.js";
9
+ import calculateWorkbook from "../workbook/calculateWorkbook.js";
10
+ import createWorkbook from "../workbook/createWorkbook.js";
11
+ import updateWorkbookRange from "../workbookRange/updateWorkbookRange.js";
12
+ import applyWorkbookTableColumnFilter from "./applyWorkbookTableColumnFilter.js";
13
+ import createWorkbookTable from "./createWorkbookTable.js";
14
+ import getWorkbookTableBodyVisibleRange from "./getWorkbookTableBodyVisibleRange.js";
15
+ describe("applyWorkbookTableColumnFilter", () => {
16
+ it("can apply a filter to a workbook table column", async () => {
17
+ const workbookName = generateTempFileName("xlsx");
18
+ const workbookPath = driveItemPath(workbookName);
19
+ const driveRef = getDefaultDriveRef();
20
+ const workbook = await createWorkbook(driveRef, workbookPath);
21
+ try {
22
+ const worksheetRef = createDefaultWorkbookWorksheetRef(workbook);
23
+ const rangeRef = createWorkbookRangeRef(worksheetRef, "A1:D4");
24
+ const table = await createWorkbookTable(rangeRef, true);
25
+ await updateWorkbookRange(rangeRef, {
26
+ values: [
27
+ ["A", "B", "C", "D"],
28
+ [1, 2, 3, 4],
29
+ [5, 6, 7, 8],
30
+ [9, 10, 11, 12],
31
+ ],
32
+ });
33
+ await applyWorkbookTableColumnFilter(createWorkbookTableColumnRef(table, "A"), {
34
+ filterOn: "custom",
35
+ criterion1: ">5",
36
+ });
37
+ await calculateWorkbook(workbook);
38
+ const visible = await getWorkbookTableBodyVisibleRange(table);
39
+ expect(visible.values).toEqual([[9, 10, 11, 12]]);
40
+ }
41
+ finally {
42
+ await tryDeleteDriveItem(workbook);
43
+ }
44
+ });
45
+ });
@@ -0,0 +1,13 @@
1
+ import type { WorkbookFilterCriteria } from "@microsoft/microsoft-graph-types";
2
+ import type { GraphOperation } from "../../models/GraphOperation.ts";
3
+ import type { WorkbookTableColumnRef } from "../../models/WorkbookTableColumnRef.ts";
4
+ /**
5
+ * Apply a filter to a workbook table column.
6
+ *
7
+ * @param columnRef - A reference to the table column.
8
+ * @param criteria - The filter criteria to apply.
9
+ * @remarks If you intend to immediately read the visible range from this table after changing the filter you must perform a `calculateWorksheet` otherwise the changes may not yet have taken effect.
10
+ * @see https://learn.microsoft.com/en-us/graph/api/filter-apply
11
+ */
12
+ export default function applyWorkbookTableColumnFilter(columnRef: WorkbookTableColumnRef, criteria: WorkbookFilterCriteria): GraphOperation<void>;
13
+ //# sourceMappingURL=applyWorkbookTableColumnFilter.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"applyWorkbookTableColumnFilter.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookTable/applyWorkbookTableColumnFilter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,kCAAkC,CAAC;AAE/E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,wCAAwC,CAAC;AAGrF;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,UAAU,8BAA8B,CAAC,SAAS,EAAE,sBAAsB,EAAE,QAAQ,EAAE,sBAAsB,GAAG,cAAc,CAAC,IAAI,CAAC,CAchJ"}
@@ -0,0 +1,25 @@
1
+ import { operation } from "../../graphApi.js";
2
+ import { generatePath } from "../../services/templatedPaths.js";
3
+ /**
4
+ * Apply a filter to a workbook table column.
5
+ *
6
+ * @param columnRef - A reference to the table column.
7
+ * @param criteria - The filter criteria to apply.
8
+ * @remarks If you intend to immediately read the visible range from this table after changing the filter you must perform a `calculateWorksheet` otherwise the changes may not yet have taken effect.
9
+ * @see https://learn.microsoft.com/en-us/graph/api/filter-apply
10
+ */
11
+ export default function applyWorkbookTableColumnFilter(columnRef, criteria) {
12
+ return operation({
13
+ contextId: columnRef.contextId,
14
+ method: "POST",
15
+ path: generatePath("/sites/{site-id}/drives/{drive-id}/items/{item-id}/workbook/worksheets/{worksheet-id}/tables/{table-id}/columns/{column}/filter/apply", columnRef),
16
+ headers: {
17
+ "workbook-session-id": columnRef.sessionId,
18
+ "content-type": "application/json",
19
+ },
20
+ body: {
21
+ criteria: criteria,
22
+ },
23
+ responseTransform: () => undefined,
24
+ });
25
+ }
@@ -0,0 +1,10 @@
1
+ import type { GraphOperation } from "../../models/GraphOperation.ts";
2
+ import type { WorkbookTableRef } from "../../models/WorkbookTableRef.ts";
3
+ /**
4
+ * Clear all filters from a workbook table.
5
+ *
6
+ * @param tableRef - A reference to the table, optionally including session information.
7
+ * @see https://learn.microsoft.com/en-us/graph/api/table-clearfilters
8
+ */
9
+ export default function clearWorkbookTableColumnFilters(tableRef: WorkbookTableRef): GraphOperation<void>;
10
+ //# sourceMappingURL=clearWorkbookTableFilters.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"clearWorkbookTableFilters.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookTable/clearWorkbookTableFilters.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAGzE;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,+BAA+B,CAAC,QAAQ,EAAE,gBAAgB,GAAG,cAAc,CAAC,IAAI,CAAC,CAWxG"}
@@ -0,0 +1,20 @@
1
+ import { operation } from "../../graphApi.js";
2
+ import { generatePath } from "../../services/templatedPaths.js";
3
+ /**
4
+ * Clear all filters from a workbook table.
5
+ *
6
+ * @param tableRef - A reference to the table, optionally including session information.
7
+ * @see https://learn.microsoft.com/en-us/graph/api/table-clearfilters
8
+ */
9
+ export default function clearWorkbookTableColumnFilters(tableRef) {
10
+ return operation({
11
+ contextId: tableRef.contextId,
12
+ method: "POST",
13
+ path: generatePath("/sites/{site-id}/drives/{drive-id}/items/{item-id}/workbook/worksheets/{worksheet-id}/tables/{table-id}/clearFilters", tableRef),
14
+ headers: {
15
+ "workbook-session-id": tableRef.sessionId,
16
+ },
17
+ body: null,
18
+ responseTransform: () => undefined,
19
+ });
20
+ }
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=clearWorkbookTableFilters.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"clearWorkbookTableFilters.test.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookTable/clearWorkbookTableFilters.test.ts"],"names":[],"mappings":""}
@@ -0,0 +1,51 @@
1
+ import { describe, expect, it } from "vitest";
2
+ import { getDefaultDriveRef } from "../../services/drive.js";
3
+ import { driveItemPath } from "../../services/driveItem.js";
4
+ import { generateTempFileName } from "../../services/temporaryFiles.js";
5
+ import { createWorkbookRangeRef } from "../../services/workbookRange.js";
6
+ import { createWorkbookTableColumnRef } from "../../services/workbookTableColumn.js";
7
+ import { createDefaultWorkbookWorksheetRef } from "../../services/workbookWorksheet.js";
8
+ import tryDeleteDriveItem from "../../tasks/tryDeleteDriveItem.js";
9
+ import calculateWorkbook from "../workbook/calculateWorkbook.js";
10
+ import createWorkbook from "../workbook/createWorkbook.js";
11
+ import updateWorkbookRange from "../workbookRange/updateWorkbookRange.js";
12
+ import applyWorkbookTableColumnFilter from "./applyWorkbookTableColumnFilter.js";
13
+ import clearWorkbookTableColumnFilters from "./clearWorkbookTableFilters.js";
14
+ import createWorkbookTable from "./createWorkbookTable.js";
15
+ import getWorkbookTableBodyVisibleRange from "./getWorkbookTableBodyVisibleRange.js";
16
+ describe("clearWorkbookTableFilters", () => {
17
+ it("can clear all filters from a workbook table", async () => {
18
+ const workbookName = generateTempFileName("xlsx");
19
+ const workbookPath = driveItemPath(workbookName);
20
+ const driveRef = getDefaultDriveRef();
21
+ const workbook = await createWorkbook(driveRef, workbookPath);
22
+ try {
23
+ const worksheetRef = createDefaultWorkbookWorksheetRef(workbook);
24
+ const rangeRef = createWorkbookRangeRef(worksheetRef, "A1:D4");
25
+ const table = await createWorkbookTable(rangeRef, true);
26
+ await updateWorkbookRange(rangeRef, {
27
+ values: [
28
+ ["A", "B", "C", "D"],
29
+ [1, 2, 3, 4],
30
+ [5, 6, 7, 8],
31
+ [9, 10, 11, 12],
32
+ ],
33
+ });
34
+ await applyWorkbookTableColumnFilter(createWorkbookTableColumnRef(table, "A"), {
35
+ filterOn: "custom",
36
+ criterion1: ">5",
37
+ });
38
+ await clearWorkbookTableColumnFilters(table);
39
+ await calculateWorkbook(workbook);
40
+ const visible = await getWorkbookTableBodyVisibleRange(table);
41
+ expect(visible.values).toEqual([
42
+ [1, 2, 3, 4],
43
+ [5, 6, 7, 8],
44
+ [9, 10, 11, 12],
45
+ ]);
46
+ }
47
+ finally {
48
+ await tryDeleteDriveItem(workbook);
49
+ }
50
+ });
51
+ });
@@ -4,7 +4,7 @@ import { driveItemPath } from "../../services/driveItem.js";
4
4
  import { generateTempFileName } from "../../services/temporaryFiles.js";
5
5
  import { createWorkbookRangeRef } from "../../services/workbookRange.js";
6
6
  import { createDefaultWorkbookWorksheetRef } from "../../services/workbookWorksheet.js";
7
- import deleteDriveItemWithRetry from "../../tasks/deleteDriveItemWithRetry.js";
7
+ import tryDeleteDriveItem from "../../tasks/tryDeleteDriveItem.js";
8
8
  import createWorkbook from "../workbook/createWorkbook.js";
9
9
  import createWorkbookTable from "./createWorkbookTable.js";
10
10
  describe("createWorkbookTable", () => {
@@ -19,7 +19,7 @@ describe("createWorkbookTable", () => {
19
19
  expect(table.id).toBeTruthy();
20
20
  }
21
21
  finally {
22
- await deleteDriveItemWithRetry(workbook);
22
+ await tryDeleteDriveItem(workbook);
23
23
  }
24
24
  });
25
25
  });
@@ -0,0 +1,10 @@
1
+ import type { GraphOperation } from "../../models/GraphOperation.ts";
2
+ import type { WorkbookTableRef } from "../../models/WorkbookTableRef.ts";
3
+ /**
4
+ * Delete a workbook table. All data in the table will be cleared.
5
+ *
6
+ * @param tableRef - A reference to the table, optionally including session information.
7
+ * @see https://learn.microsoft.com/en-us/graph/api/table-delete
8
+ */
9
+ export default function deleteWorkbookTable(tableRef: WorkbookTableRef): GraphOperation<void>;
10
+ //# sourceMappingURL=deleteWorkbookTable.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"deleteWorkbookTable.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookTable/deleteWorkbookTable.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAGzE;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,mBAAmB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,cAAc,CAAC,IAAI,CAAC,CAW5F"}