microsoft-graph 2.3.0 → 2.4.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 (281) hide show
  1. package/.vscode/settings.json +2 -1
  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/drive/createFolder.d.ts +8 -1
  6. package/dist/operations/drive/createFolder.d.ts.map +1 -1
  7. package/dist/operations/drive/createFolder.js +8 -1
  8. package/dist/operations/drive/listDrives.d.ts +7 -1
  9. package/dist/operations/drive/listDrives.d.ts.map +1 -1
  10. package/dist/operations/drive/listDrives.js +7 -1
  11. package/dist/operations/driveItem/deleteDriveItem.d.ts +7 -1
  12. package/dist/operations/driveItem/deleteDriveItem.d.ts.map +1 -1
  13. package/dist/operations/driveItem/deleteDriveItem.js +7 -1
  14. package/dist/operations/driveItem/getDriveItem.d.ts +7 -1
  15. package/dist/operations/driveItem/getDriveItem.d.ts.map +1 -1
  16. package/dist/operations/driveItem/getDriveItem.js +7 -1
  17. package/dist/operations/driveItem/getDriveItem.test.js +2 -2
  18. package/dist/operations/driveItem/getDriveItemByPath.d.ts +8 -1
  19. package/dist/operations/driveItem/getDriveItemByPath.d.ts.map +1 -1
  20. package/dist/operations/driveItem/getDriveItemByPath.js +8 -1
  21. package/dist/operations/driveItem/getDriveItemByPath.test.js +2 -2
  22. package/dist/operations/driveItem/getDriveItemContent.d.ts +8 -1
  23. package/dist/operations/driveItem/getDriveItemContent.d.ts.map +1 -1
  24. package/dist/operations/driveItem/getDriveItemContent.js +8 -1
  25. package/dist/operations/driveItem/getDriveItemContent.test.js +2 -2
  26. package/dist/operations/driveItem/initiateCopyDriveItem.d.ts +9 -1
  27. package/dist/operations/driveItem/initiateCopyDriveItem.d.ts.map +1 -1
  28. package/dist/operations/driveItem/initiateCopyDriveItem.js +9 -1
  29. package/dist/operations/driveItem/initiateCopyDriveItem.test.js +3 -3
  30. package/dist/operations/driveItem/listDriveItems.d.ts +8 -2
  31. package/dist/operations/driveItem/listDriveItems.d.ts.map +1 -1
  32. package/dist/operations/driveItem/listDriveItems.js +8 -3
  33. package/dist/operations/driveItem/listDriveItems.test.js +2 -2
  34. package/dist/operations/site/getSite.d.ts +7 -1
  35. package/dist/operations/site/getSite.d.ts.map +1 -1
  36. package/dist/operations/site/getSite.js +7 -1
  37. package/dist/operations/site/getSiteByName.d.ts +9 -1
  38. package/dist/operations/site/getSiteByName.d.ts.map +1 -1
  39. package/dist/operations/site/getSiteByName.js +9 -1
  40. package/dist/operations/site/listSites.d.ts +7 -1
  41. package/dist/operations/site/listSites.d.ts.map +1 -1
  42. package/dist/operations/site/listSites.js +7 -1
  43. package/dist/operations/site/searchSites.d.ts +8 -1
  44. package/dist/operations/site/searchSites.d.ts.map +1 -1
  45. package/dist/operations/site/searchSites.js +8 -1
  46. package/dist/operations/user/userSendMail.d.ts +10 -1
  47. package/dist/operations/user/userSendMail.d.ts.map +1 -1
  48. package/dist/operations/user/userSendMail.js +10 -1
  49. package/dist/operations/workbook/calculateWorkbook.d.ts +14 -2
  50. package/dist/operations/workbook/calculateWorkbook.d.ts.map +1 -1
  51. package/dist/operations/workbook/calculateWorkbook.js +14 -2
  52. package/dist/operations/workbook/calculateWorkbook.test.js +4 -4
  53. package/dist/operations/workbook/createWorkbook.d.ts +9 -1
  54. package/dist/operations/workbook/createWorkbook.d.ts.map +1 -1
  55. package/dist/operations/workbook/createWorkbook.js +9 -1
  56. package/dist/operations/workbook/createWorkbook.test.js +2 -2
  57. package/dist/operations/workbook/deleteWorkbook.d.ts +7 -1
  58. package/dist/operations/workbook/deleteWorkbook.d.ts.map +1 -1
  59. package/dist/operations/workbook/deleteWorkbook.js +7 -1
  60. package/dist/operations/workbookRange/clearWorkbookRange.d.ts +8 -1
  61. package/dist/operations/workbookRange/clearWorkbookRange.d.ts.map +1 -1
  62. package/dist/operations/workbookRange/clearWorkbookRange.js +8 -1
  63. package/dist/operations/workbookRange/clearWorkbookRange.test.js +3 -3
  64. package/dist/operations/workbookRange/deleteWorkbookRange.d.ts +8 -1
  65. package/dist/operations/workbookRange/deleteWorkbookRange.d.ts.map +1 -1
  66. package/dist/operations/workbookRange/deleteWorkbookRange.js +8 -1
  67. package/dist/operations/workbookRange/deleteWorkbookRange.test.js +3 -3
  68. package/dist/operations/workbookRange/getWorkbookNamedRange.d.ts +7 -1
  69. package/dist/operations/workbookRange/getWorkbookNamedRange.d.ts.map +1 -1
  70. package/dist/operations/workbookRange/getWorkbookNamedRange.js +7 -1
  71. package/dist/operations/workbookRange/getWorkbookRangeFormat.d.ts +7 -1
  72. package/dist/operations/workbookRange/getWorkbookRangeFormat.d.ts.map +1 -1
  73. package/dist/operations/workbookRange/getWorkbookRangeFormat.js +7 -1
  74. package/dist/operations/workbookRange/getWorkbookRangeFormat.test.js +2 -2
  75. package/dist/operations/workbookRange/getWorkbookUsedRange.d.ts +3 -1
  76. package/dist/operations/workbookRange/getWorkbookUsedRange.d.ts.map +1 -1
  77. package/dist/operations/workbookRange/getWorkbookUsedRange.js +3 -1
  78. package/dist/operations/workbookRange/getWorkbookVisibleRange.d.ts +7 -1
  79. package/dist/operations/workbookRange/getWorkbookVisibleRange.d.ts.map +1 -1
  80. package/dist/operations/workbookRange/getWorkbookVisibleRange.js +7 -1
  81. package/dist/operations/workbookRange/getWorkbookVisibleRange.test.js +5 -5
  82. package/dist/operations/workbookRange/getWorkbookWorksheetRange.d.ts +7 -1
  83. package/dist/operations/workbookRange/getWorkbookWorksheetRange.d.ts.map +1 -1
  84. package/dist/operations/workbookRange/getWorkbookWorksheetRange.js +7 -1
  85. package/dist/operations/workbookRange/getWorkbookWorksheetRange.test.js +2 -2
  86. package/dist/operations/workbookRange/insertWorkbookCells.d.ts +9 -1
  87. package/dist/operations/workbookRange/insertWorkbookCells.d.ts.map +1 -1
  88. package/dist/operations/workbookRange/insertWorkbookCells.js +9 -1
  89. package/dist/operations/workbookRange/insertWorkbookCells.test.js +2 -2
  90. package/dist/operations/workbookRange/updateWorkbookNamedRange.d.ts +8 -1
  91. package/dist/operations/workbookRange/updateWorkbookNamedRange.d.ts.map +1 -1
  92. package/dist/operations/workbookRange/updateWorkbookNamedRange.js +8 -1
  93. package/dist/operations/workbookRange/updateWorkbookRange.d.ts +8 -1
  94. package/dist/operations/workbookRange/updateWorkbookRange.d.ts.map +1 -1
  95. package/dist/operations/workbookRange/updateWorkbookRange.js +8 -1
  96. package/dist/operations/workbookRange/updateWorkbookRange.test.js +3 -3
  97. package/dist/operations/workbookSession/closeWorkbookSession.d.ts +8 -1
  98. package/dist/operations/workbookSession/closeWorkbookSession.d.ts.map +1 -1
  99. package/dist/operations/workbookSession/closeWorkbookSession.js +8 -1
  100. package/dist/operations/workbookSession/createWorkbookSession.d.ts +9 -1
  101. package/dist/operations/workbookSession/createWorkbookSession.d.ts.map +1 -1
  102. package/dist/operations/workbookSession/createWorkbookSession.js +9 -1
  103. package/dist/operations/workbookSession/refreshWorkbookSession.d.ts +8 -1
  104. package/dist/operations/workbookSession/refreshWorkbookSession.d.ts.map +1 -1
  105. package/dist/operations/workbookSession/refreshWorkbookSession.js +8 -1
  106. package/dist/operations/workbookTable/applyWorkbookTableColulmnFilter.test.d.ts +2 -0
  107. package/dist/operations/workbookTable/applyWorkbookTableColulmnFilter.test.d.ts.map +1 -0
  108. package/dist/operations/workbookTable/applyWorkbookTableColulmnFilter.test.js +45 -0
  109. package/dist/operations/workbookTable/applyWorkbookTableColumnFilter.d.ts +13 -0
  110. package/dist/operations/workbookTable/applyWorkbookTableColumnFilter.d.ts.map +1 -0
  111. package/dist/operations/workbookTable/applyWorkbookTableColumnFilter.js +25 -0
  112. package/dist/operations/workbookTable/clearWorkbookTableFilters.d.ts +10 -0
  113. package/dist/operations/workbookTable/clearWorkbookTableFilters.d.ts.map +1 -0
  114. package/dist/operations/workbookTable/clearWorkbookTableFilters.js +20 -0
  115. package/dist/operations/workbookTable/clearWorkbookTableFilters.test.d.ts +2 -0
  116. package/dist/operations/workbookTable/clearWorkbookTableFilters.test.d.ts.map +1 -0
  117. package/dist/operations/workbookTable/clearWorkbookTableFilters.test.js +51 -0
  118. package/dist/operations/workbookTable/createWorkbookTable.d.ts +8 -1
  119. package/dist/operations/workbookTable/createWorkbookTable.d.ts.map +1 -1
  120. package/dist/operations/workbookTable/createWorkbookTable.js +8 -1
  121. package/dist/operations/workbookTable/createWorkbookTable.test.js +2 -2
  122. package/dist/operations/workbookTable/getWorkbookTable.d.ts +7 -1
  123. package/dist/operations/workbookTable/getWorkbookTable.d.ts.map +1 -1
  124. package/dist/operations/workbookTable/getWorkbookTable.js +7 -1
  125. package/dist/operations/workbookTable/getWorkbookTable.test.js +2 -2
  126. package/dist/operations/workbookTable/getWorkbookTableBodyRange.d.ts +7 -1
  127. package/dist/operations/workbookTable/getWorkbookTableBodyRange.d.ts.map +1 -1
  128. package/dist/operations/workbookTable/getWorkbookTableBodyRange.js +7 -1
  129. package/dist/operations/workbookTable/getWorkbookTableBodyRange.test.js +3 -3
  130. package/dist/operations/workbookTable/getWorkbookTableBodyVisibleRange.d.ts +13 -0
  131. package/dist/operations/workbookTable/getWorkbookTableBodyVisibleRange.d.ts.map +1 -0
  132. package/dist/operations/workbookTable/getWorkbookTableBodyVisibleRange.js +29 -0
  133. package/dist/operations/workbookTable/getWorkbookTableBodyVisibleRange.test.d.ts +2 -0
  134. package/dist/operations/workbookTable/getWorkbookTableBodyVisibleRange.test.d.ts.map +1 -0
  135. package/dist/operations/workbookTable/getWorkbookTableBodyVisibleRange.test.js +45 -0
  136. package/dist/operations/workbookTable/getWorkbookTableHeaderRange.d.ts +7 -1
  137. package/dist/operations/workbookTable/getWorkbookTableHeaderRange.d.ts.map +1 -1
  138. package/dist/operations/workbookTable/getWorkbookTableHeaderRange.js +7 -1
  139. package/dist/operations/workbookTable/getWorkbookTableHeaderRange.test.js +2 -2
  140. package/dist/operations/workbookTable/listWorkbookTableColumns.d.ts +7 -1
  141. package/dist/operations/workbookTable/listWorkbookTableColumns.d.ts.map +1 -1
  142. package/dist/operations/workbookTable/listWorkbookTableColumns.js +7 -1
  143. package/dist/operations/workbookTable/listWorkbookTableColumns.test.js +2 -2
  144. package/dist/operations/workbookTable/listWorkbookTableRows.d.ts +7 -1
  145. package/dist/operations/workbookTable/listWorkbookTableRows.d.ts.map +1 -1
  146. package/dist/operations/workbookTable/listWorkbookTableRows.js +7 -1
  147. package/dist/operations/workbookTable/listWorkbookTableRows.test.js +2 -2
  148. package/dist/operations/workbookTable/listWorkbookTables.d.ts +7 -1
  149. package/dist/operations/workbookTable/listWorkbookTables.d.ts.map +1 -1
  150. package/dist/operations/workbookTable/listWorkbookTables.js +7 -1
  151. package/dist/operations/workbookTable/listWorkbookTables.test.js +2 -2
  152. package/dist/operations/workbookWorksheet/createWorkbookWorksheet.d.ts +8 -1
  153. package/dist/operations/workbookWorksheet/createWorkbookWorksheet.d.ts.map +1 -1
  154. package/dist/operations/workbookWorksheet/createWorkbookWorksheet.js +8 -1
  155. package/dist/operations/workbookWorksheet/createWorkbookWorksheet.test.js +3 -3
  156. package/dist/operations/workbookWorksheet/deleteWorkbookWorksheet.d.ts +7 -1
  157. package/dist/operations/workbookWorksheet/deleteWorkbookWorksheet.d.ts.map +1 -1
  158. package/dist/operations/workbookWorksheet/deleteWorkbookWorksheet.js +7 -1
  159. package/dist/operations/workbookWorksheet/deleteWorkbookWorksheet.test.js +2 -2
  160. package/dist/operations/workbookWorksheet/getWorkbookWorksheetUsedRange.d.ts +13 -0
  161. package/dist/operations/workbookWorksheet/getWorkbookWorksheetUsedRange.d.ts.map +1 -0
  162. package/dist/operations/workbookWorksheet/getWorkbookWorksheetUsedRange.js +33 -0
  163. package/dist/operations/workbookWorksheet/getWorkbookWorksheetUsedRange.test.d.ts +2 -0
  164. package/dist/operations/workbookWorksheet/getWorkbookWorksheetUsedRange.test.d.ts.map +1 -0
  165. package/dist/operations/workbookWorksheet/getWorkbookWorksheetUsedRange.test.js +54 -0
  166. package/dist/operations/workbookWorksheet/getWorkbookWorksheetUsedVisibleRange.d.ts +13 -0
  167. package/dist/operations/workbookWorksheet/getWorkbookWorksheetUsedVisibleRange.d.ts.map +1 -0
  168. package/dist/operations/workbookWorksheet/getWorkbookWorksheetUsedVisibleRange.js +29 -0
  169. package/dist/operations/workbookWorksheet/getWorkbookWorksheetUsedVisibleRange.test.d.ts +2 -0
  170. package/dist/operations/workbookWorksheet/getWorkbookWorksheetUsedVisibleRange.test.d.ts.map +1 -0
  171. package/dist/operations/workbookWorksheet/getWorkbookWorksheetUsedVisibleRange.test.js +37 -0
  172. package/dist/operations/workbookWorksheet/listWorkbookWorksheets.d.ts +7 -1
  173. package/dist/operations/workbookWorksheet/listWorkbookWorksheets.d.ts.map +1 -1
  174. package/dist/operations/workbookWorksheet/listWorkbookWorksheets.js +7 -1
  175. package/dist/operations/workbookWorksheet/listWorkbookWorksheets.test.js +3 -3
  176. package/dist/operations/workbookWorksheet/updateWorkbookWorksheet.d.ts +11 -1
  177. package/dist/operations/workbookWorksheet/updateWorkbookWorksheet.d.ts.map +1 -1
  178. package/dist/operations/workbookWorksheet/updateWorkbookWorksheet.js +11 -1
  179. package/dist/operations/workbookWorksheet/updateWorkbookWorksheet.test.js +3 -3
  180. package/dist/services/accessToken.d.ts +9 -1
  181. package/dist/services/accessToken.d.ts.map +1 -1
  182. package/dist/services/accessToken.js +9 -1
  183. package/dist/services/addressManipulation.d.ts +67 -0
  184. package/dist/services/addressManipulation.d.ts.map +1 -1
  185. package/dist/services/addressManipulation.js +67 -0
  186. package/dist/services/addressOffset.d.ts +20 -0
  187. package/dist/services/addressOffset.d.ts.map +1 -1
  188. package/dist/services/addressOffset.js +20 -0
  189. package/dist/services/context.d.ts +19 -2
  190. package/dist/services/context.d.ts.map +1 -1
  191. package/dist/services/context.js +19 -2
  192. package/dist/services/drive.d.ts +12 -1
  193. package/dist/services/drive.d.ts.map +1 -1
  194. package/dist/services/drive.js +12 -1
  195. package/dist/services/driveItem.d.ts +13 -1
  196. package/dist/services/driveItem.d.ts.map +1 -1
  197. package/dist/services/driveItem.js +13 -1
  198. package/dist/services/environmentVariable.d.ts +13 -0
  199. package/dist/services/environmentVariable.d.ts.map +1 -1
  200. package/dist/services/environmentVariable.js +13 -0
  201. package/dist/services/httpAgent.d.ts +5 -0
  202. package/dist/services/httpAgent.d.ts.map +1 -1
  203. package/dist/services/httpAgent.js +5 -0
  204. package/dist/services/httpStatus.d.ts +15 -0
  205. package/dist/services/httpStatus.d.ts.map +1 -1
  206. package/dist/services/httpStatus.js +15 -0
  207. package/dist/services/operationId.d.ts +10 -0
  208. package/dist/services/operationId.d.ts.map +1 -1
  209. package/dist/services/operationId.js +10 -0
  210. package/dist/services/random.d.ts +5 -0
  211. package/dist/services/random.d.ts.map +1 -1
  212. package/dist/services/random.js +5 -0
  213. package/dist/services/sharepointUrl.d.ts +6 -1
  214. package/dist/services/sharepointUrl.d.ts.map +1 -1
  215. package/dist/services/sharepointUrl.js +6 -1
  216. package/dist/services/site.d.ts +12 -1
  217. package/dist/services/site.d.ts.map +1 -1
  218. package/dist/services/site.js +12 -1
  219. package/dist/services/sleep.d.ts +5 -0
  220. package/dist/services/sleep.d.ts.map +1 -1
  221. package/dist/services/sleep.js +5 -0
  222. package/dist/services/stringCaseConversion.d.ts +5 -0
  223. package/dist/services/stringCaseConversion.d.ts.map +1 -1
  224. package/dist/services/stringCaseConversion.js +5 -0
  225. package/dist/services/templatedPaths.d.ts +7 -1
  226. package/dist/services/templatedPaths.d.ts.map +1 -1
  227. package/dist/services/templatedPaths.js +7 -1
  228. package/dist/services/temporaryFiles.d.ts +5 -0
  229. package/dist/services/temporaryFiles.d.ts.map +1 -1
  230. package/dist/services/temporaryFiles.js +5 -0
  231. package/dist/services/workbookRange.d.ts +6 -0
  232. package/dist/services/workbookRange.d.ts.map +1 -1
  233. package/dist/services/workbookRange.js +6 -0
  234. package/dist/services/workbookTable.d.ts +7 -0
  235. package/dist/services/workbookTable.d.ts.map +1 -1
  236. package/dist/services/workbookTable.js +7 -0
  237. package/dist/services/workbookTableColumn.d.ts +12 -0
  238. package/dist/services/workbookTableColumn.d.ts.map +1 -0
  239. package/dist/services/workbookTableColumn.js +22 -0
  240. package/dist/services/workbookWorksheet.d.ts +12 -0
  241. package/dist/services/workbookWorksheet.d.ts.map +1 -1
  242. package/dist/services/workbookWorksheet.js +12 -0
  243. package/dist/tasks/createWorkbookAndStartSession.d.ts +7 -1
  244. package/dist/tasks/createWorkbookAndStartSession.d.ts.map +1 -1
  245. package/dist/tasks/createWorkbookAndStartSession.js +7 -1
  246. package/dist/tasks/deleteDriveItemWithRetry.d.ts +6 -1
  247. package/dist/tasks/deleteDriveItemWithRetry.d.ts.map +1 -1
  248. package/dist/tasks/deleteDriveItemWithRetry.js +6 -1
  249. package/dist/tasks/downloadDriveItemContent.d.ts +7 -1
  250. package/dist/tasks/downloadDriveItemContent.d.ts.map +1 -1
  251. package/dist/tasks/downloadDriveItemContent.js +7 -1
  252. package/dist/tasks/getRangeLastUsedCell.d.ts +7 -1
  253. package/dist/tasks/getRangeLastUsedCell.d.ts.map +1 -1
  254. package/dist/tasks/getRangeLastUsedCell.js +7 -1
  255. package/dist/tasks/getRangeLastUsedCell.test.js +4 -4
  256. package/dist/tasks/getWorkbookTableVisibleBody.d.ts +1 -1
  257. package/dist/tasks/getWorkbookTableVisibleBody.d.ts.map +1 -1
  258. package/dist/tasks/getWorkbookTableVisibleBody.js +1 -1
  259. package/dist/tasks/getWorkbookWorksheetByName.d.ts +8 -1
  260. package/dist/tasks/getWorkbookWorksheetByName.d.ts.map +1 -1
  261. package/dist/tasks/getWorkbookWorksheetByName.js +8 -1
  262. package/dist/tasks/safeDeleteWorkbook.d.ts +7 -1
  263. package/dist/tasks/safeDeleteWorkbook.d.ts.map +1 -1
  264. package/dist/tasks/safeDeleteWorkbook.js +7 -1
  265. package/dist/tasks/setColumnHidden.d.ts +7 -1
  266. package/dist/tasks/setColumnHidden.d.ts.map +1 -1
  267. package/dist/tasks/setColumnHidden.js +7 -1
  268. package/dist/tasks/setColumnHidden.test.js +2 -2
  269. package/dist/tasks/setRowHidden.d.ts +7 -1
  270. package/dist/tasks/setRowHidden.d.ts.map +1 -1
  271. package/dist/tasks/setRowHidden.js +7 -1
  272. package/dist/tasks/setRowHidden.test.js +2 -2
  273. package/dist/tasks/setWorkbookTableBodyVisibleRows.d.ts +9 -1
  274. package/dist/tasks/setWorkbookTableBodyVisibleRows.d.ts.map +1 -1
  275. package/dist/tasks/setWorkbookTableBodyVisibleRows.js +23 -16
  276. package/dist/tasks/setWorkbookTableBodyVisibleRows.test.js +10 -8
  277. package/dist/tasks/tryDeleteDriveItem.d.ts +9 -0
  278. package/dist/tasks/tryDeleteDriveItem.d.ts.map +1 -0
  279. package/dist/tasks/tryDeleteDriveItem.js +16 -0
  280. package/docs/findingSiteDriveId.md +21 -0
  281. package/package.json +33 -1
@@ -2,7 +2,13 @@ import ProtocolError from "../../errors/ProtocolError.js";
2
2
  import { operation } from "../../graphApi.js";
3
3
  import { generatePath } from "../../services/templatedPaths.js";
4
4
  import { createWorkbookRangeRef } from "../../services/workbookRange.js";
5
- /** Retrieve the data body range of a table. @see https://learn.microsoft.com/en-us/graph/api/table-databodyrange */
5
+ /**
6
+ * Retrieve the data body range of a table.
7
+ *
8
+ * @param tableRef - A reference to the table, optionally including session information.
9
+ * @returns The data body range of the specified table, including its metadata and reference information.
10
+ * @see https://learn.microsoft.com/en-us/graph/api/table-databodyrange
11
+ */
6
12
  export default function getWorkbookTableBodyRange(tableRef) {
7
13
  return operation({
8
14
  contextId: tableRef.contextId,
@@ -4,13 +4,13 @@ import { getDefaultDriveRef } from "../../services/drive.js";
4
4
  import { driveItemPath } from "../../services/driveItem.js";
5
5
  import { generateTempFileName } from "../../services/temporaryFiles.js";
6
6
  import { createWorkbookRangeRef } from "../../services/workbookRange.js";
7
- import deleteDriveItemWithRetry from "../../tasks/deleteDriveItemWithRetry.js";
7
+ import { createDefaultWorkbookWorksheetRef } from "../../services/workbookWorksheet.js";
8
+ import tryDeleteDriveItem from "../../tasks/tryDeleteDriveItem.js";
8
9
  import calculateWorkbook from "../workbook/calculateWorkbook.js";
9
10
  import createWorkbook from "../workbook/createWorkbook.js";
10
11
  import updateWorkbookRange from "../workbookRange/updateWorkbookRange.js";
11
12
  import createWorkbookTable from "./createWorkbookTable.js";
12
13
  import getWorkbookTableBodyRange from "./getWorkbookTableBodyRange.js";
13
- import { createDefaultWorkbookWorksheetRef } from "../../services/workbookWorksheet.js";
14
14
  describe("getWorkbookTableBodyRange", () => {
15
15
  it("can retrieve the data body range of a table", async () => {
16
16
  const workbookName = generateTempFileName("xlsx");
@@ -39,7 +39,7 @@ describe("getWorkbookTableBodyRange", () => {
39
39
  ]);
40
40
  }
41
41
  finally {
42
- await deleteDriveItemWithRetry(workbook);
42
+ await tryDeleteDriveItem(workbook);
43
43
  }
44
44
  });
45
45
  });
@@ -0,0 +1,13 @@
1
+ import type { WorkbookRange } from "@microsoft/microsoft-graph-types";
2
+ import type { GraphOperation } from "../../models/GraphOperation.ts";
3
+ import type { WorkbookRangeRef } from "../../models/WorkbookRangeRef.ts";
4
+ import type { WorkbookTableRef } from "../../models/WorkbookTableRef.ts";
5
+ /**
6
+ * Retrieve the visible data body range of a table.
7
+ *
8
+ * @param tableRef - A reference to the table, optionally including session information.
9
+ * @returns The data body range of the specified table, including its metadata and reference information.
10
+ * @see https://learn.microsoft.com/en-us/graph/api/table-databodyrange
11
+ */
12
+ export default function getWorkbookTableBodyVisibleRange(tableRef: WorkbookTableRef): GraphOperation<WorkbookRange & WorkbookRangeRef>;
13
+ //# sourceMappingURL=getWorkbookTableBodyVisibleRange.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"getWorkbookTableBodyVisibleRange.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookTable/getWorkbookTableBodyVisibleRange.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,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAIzE;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,gCAAgC,CAAC,QAAQ,EAAE,gBAAgB,GAAG,cAAc,CAAC,aAAa,GAAG,gBAAgB,CAAC,CAmBrI"}
@@ -0,0 +1,29 @@
1
+ import { operation } from "../../graphApi.js";
2
+ import { generatePath } from "../../services/templatedPaths.js";
3
+ import { createWorkbookRangeRef } from "../../services/workbookRange.js";
4
+ /**
5
+ * Retrieve the visible data body range of a table.
6
+ *
7
+ * @param tableRef - A reference to the table, optionally including session information.
8
+ * @returns The data body range of the specified table, including its metadata and reference information.
9
+ * @see https://learn.microsoft.com/en-us/graph/api/table-databodyrange
10
+ */
11
+ export default function getWorkbookTableBodyVisibleRange(tableRef) {
12
+ return operation({
13
+ contextId: tableRef.contextId,
14
+ method: "GET",
15
+ path: generatePath("/sites/{site-id}/drives/{drive-id}/items/{item-id}/workbook/worksheets/{worksheet-id}/tables/{table-id}/dataBodyRange/visibleView", tableRef),
16
+ headers: {
17
+ "workbook-session-id": tableRef.sessionId,
18
+ },
19
+ body: null,
20
+ responseTransform: (response) => {
21
+ const range = response;
22
+ const rangeRef = createWorkbookRangeRef(tableRef, range.address);
23
+ return {
24
+ ...range,
25
+ ...rangeRef,
26
+ };
27
+ },
28
+ });
29
+ }
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=getWorkbookTableBodyVisibleRange.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"getWorkbookTableBodyVisibleRange.test.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookTable/getWorkbookTableBodyVisibleRange.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("getWorkbookTableBodyVisibleRange", () => {
16
+ it("can retrieve the visible body range of a table from an existing workbook", 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
+ });
@@ -2,6 +2,12 @@ import type { WorkbookRange } from "@microsoft/microsoft-graph-types";
2
2
  import type { GraphOperation } from "../../models/GraphOperation.ts";
3
3
  import type { WorkbookRangeRef } from "../../models/WorkbookRangeRef.ts";
4
4
  import type { WorkbookTableRef } from "../../models/WorkbookTableRef.ts";
5
- /** Retrieve the header row range of a table. @see https://learn.microsoft.com/en-us/graph/api/table-headerrowrange */
5
+ /**
6
+ * Retrieve the header row range of a table.
7
+ *
8
+ * @param tableRef - A reference to the table, optionally including session information.
9
+ * @returns The header row range of the specified table, including its metadata and reference information.
10
+ * @see https://learn.microsoft.com/en-us/graph/api/table-headerrowrange
11
+ */
6
12
  export default function getWorkbookTableHeaderRange(tableRef: WorkbookTableRef): GraphOperation<WorkbookRange & WorkbookRangeRef>;
7
13
  //# sourceMappingURL=getWorkbookTableHeaderRange.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"getWorkbookTableHeaderRange.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookTable/getWorkbookTableHeaderRange.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,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAIzE,sHAAsH;AACtH,MAAM,CAAC,OAAO,UAAU,2BAA2B,CAAC,QAAQ,EAAE,gBAAgB,GAAG,cAAc,CAAC,aAAa,GAAG,gBAAgB,CAAC,CAsBhI"}
1
+ {"version":3,"file":"getWorkbookTableHeaderRange.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookTable/getWorkbookTableHeaderRange.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,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAIzE;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,2BAA2B,CAAC,QAAQ,EAAE,gBAAgB,GAAG,cAAc,CAAC,aAAa,GAAG,gBAAgB,CAAC,CAsBhI"}
@@ -2,7 +2,13 @@ import ProtocolError from "../../errors/ProtocolError.js";
2
2
  import { operation } from "../../graphApi.js";
3
3
  import { generatePath } from "../../services/templatedPaths.js";
4
4
  import { createWorkbookRangeRef } from "../../services/workbookRange.js";
5
- /** Retrieve the header row range of a table. @see https://learn.microsoft.com/en-us/graph/api/table-headerrowrange */
5
+ /**
6
+ * Retrieve the header row range of a table.
7
+ *
8
+ * @param tableRef - A reference to the table, optionally including session information.
9
+ * @returns The header row range of the specified table, including its metadata and reference information.
10
+ * @see https://learn.microsoft.com/en-us/graph/api/table-headerrowrange
11
+ */
6
12
  export default function getWorkbookTableHeaderRange(tableRef) {
7
13
  return operation({
8
14
  contextId: tableRef.contextId,
@@ -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 { createDefaultWorkbookWorksheetRef } 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 updateWorkbookRange from "../workbookRange/updateWorkbookRange.js";
@@ -35,7 +35,7 @@ describe("getWorkbookTableHeaderRange", () => {
35
35
  expect(headerRange.values).toEqual([["Header1", "Header2", "Header3", "Header4"]]);
36
36
  }
37
37
  finally {
38
- await deleteDriveItemWithRetry(workbook);
38
+ await tryDeleteDriveItem(workbook);
39
39
  }
40
40
  });
41
41
  });
@@ -1,6 +1,12 @@
1
1
  import type { WorkbookTableColumn } from "@microsoft/microsoft-graph-types";
2
2
  import type { GraphOperation } from "../../models/GraphOperation.ts";
3
3
  import type { WorkbookTableRef } from "../../models/WorkbookTableRef.ts";
4
- /** Retrieve a list of columns in a table. @see https://learn.microsoft.com/en-us/graph/api/tablecolumn-list */
4
+ /**
5
+ * Retrieve a list of columns in a table.
6
+ *
7
+ * @param tableRef - A reference to the table, optionally including session information.
8
+ * @returns An array of columns in the specified table.
9
+ * @see https://learn.microsoft.com/en-us/graph/api/tablecolumn-list
10
+ */
5
11
  export default function listWorkbookTableColumns(tableRef: WorkbookTableRef): GraphOperation<WorkbookTableColumn[]>;
6
12
  //# sourceMappingURL=listWorkbookTableColumns.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"listWorkbookTableColumns.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookTable/listWorkbookTableColumns.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAE5E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAGzE,+GAA+G;AAC/G,MAAM,CAAC,OAAO,UAAU,wBAAwB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,cAAc,CAAC,mBAAmB,EAAE,CAAC,CAclH"}
1
+ {"version":3,"file":"listWorkbookTableColumns.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookTable/listWorkbookTableColumns.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAE5E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAGzE;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,wBAAwB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,cAAc,CAAC,mBAAmB,EAAE,CAAC,CAclH"}
@@ -1,6 +1,12 @@
1
1
  import { operation } from "../../graphApi.js";
2
2
  import { generatePath } from "../../services/templatedPaths.js";
3
- /** Retrieve a list of columns in a table. @see https://learn.microsoft.com/en-us/graph/api/tablecolumn-list */
3
+ /**
4
+ * Retrieve a list of columns in a table.
5
+ *
6
+ * @param tableRef - A reference to the table, optionally including session information.
7
+ * @returns An array of columns in the specified table.
8
+ * @see https://learn.microsoft.com/en-us/graph/api/tablecolumn-list
9
+ */
4
10
  export default function listWorkbookTableColumns(tableRef) {
5
11
  return operation({
6
12
  contextId: tableRef.contextId,
@@ -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 calculateWorkbook from "../workbook/calculateWorkbook.js";
9
9
  import createWorkbook from "../workbook/createWorkbook.js";
10
10
  import createWorkbookTable from "./createWorkbookTable.js";
@@ -23,7 +23,7 @@ describe("listWorkbookTableColumns", () => {
23
23
  expect(columns.length).toBeGreaterThan(0);
24
24
  }
25
25
  finally {
26
- await deleteDriveItemWithRetry(workbook);
26
+ await tryDeleteDriveItem(workbook);
27
27
  }
28
28
  });
29
29
  });
@@ -1,6 +1,12 @@
1
1
  import type { WorkbookTableRow } from "@microsoft/microsoft-graph-types";
2
2
  import type { GraphOperation } from "../../models/GraphOperation.ts";
3
3
  import type { WorkbookTableRef } from "../../models/WorkbookTableRef.ts";
4
- /** Retrieve a list of rows in a table. @see https://learn.microsoft.com/en-us/graph/api/tablerow-list */
4
+ /**
5
+ * Retrieve a list of rows in a table.
6
+ *
7
+ * @param tableRef - A reference to the table, optionally including session information.
8
+ * @returns An array of rows in the specified table.
9
+ * @see https://learn.microsoft.com/en-us/graph/api/tablerow-list
10
+ */
5
11
  export default function listWorkbookTableRows(tableRef: WorkbookTableRef): GraphOperation<WorkbookTableRow[]>;
6
12
  //# sourceMappingURL=listWorkbookTableRows.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"listWorkbookTableRows.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookTable/listWorkbookTableRows.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAEzE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAGzE,yGAAyG;AACzG,MAAM,CAAC,OAAO,UAAU,qBAAqB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,cAAc,CAAC,gBAAgB,EAAE,CAAC,CAc5G"}
1
+ {"version":3,"file":"listWorkbookTableRows.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookTable/listWorkbookTableRows.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAEzE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAGzE;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,qBAAqB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,cAAc,CAAC,gBAAgB,EAAE,CAAC,CAc5G"}
@@ -1,6 +1,12 @@
1
1
  import { operation } from "../../graphApi.js";
2
2
  import { generatePath } from "../../services/templatedPaths.js";
3
- /** Retrieve a list of rows in a table. @see https://learn.microsoft.com/en-us/graph/api/tablerow-list */
3
+ /**
4
+ * Retrieve a list of rows in a table.
5
+ *
6
+ * @param tableRef - A reference to the table, optionally including session information.
7
+ * @returns An array of rows in the specified table.
8
+ * @see https://learn.microsoft.com/en-us/graph/api/tablerow-list
9
+ */
4
10
  export default function listWorkbookTableRows(tableRef) {
5
11
  return operation({
6
12
  contextId: tableRef.contextId,
@@ -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 calculateWorkbook from "../workbook/calculateWorkbook.js";
9
9
  import createWorkbook from "../workbook/createWorkbook.js";
10
10
  import createWorkbookTable from "./createWorkbookTable.js";
@@ -23,7 +23,7 @@ describe("listWorkbookTableRows", () => {
23
23
  expect(rows.length).toBeGreaterThan(0);
24
24
  }
25
25
  finally {
26
- await deleteDriveItemWithRetry(workbook);
26
+ await tryDeleteDriveItem(workbook);
27
27
  }
28
28
  });
29
29
  });
@@ -2,6 +2,12 @@ import type { WorkbookTable } from "@microsoft/microsoft-graph-types";
2
2
  import type { GraphOperation } from "../../models/GraphOperation.ts";
3
3
  import type { WorkbookRef } from "../../models/WorkbookRef.ts";
4
4
  import type { WorkbookWorksheetRef } from "../../models/WorkbookWorksheetRef.ts";
5
- /** Retrieve a list of tables in a worksheet. @see https://learn.microsoft.com/en-us/graph/api/worksheet-list-tables */
5
+ /**
6
+ * Retrieve a list of tables in a worksheet.
7
+ *
8
+ * @param worksheetRef - A reference to the worksheet, optionally including session information.
9
+ * @returns An array of tables, each including its metadata and reference information.
10
+ * @see https://learn.microsoft.com/en-us/graph/api/worksheet-list-tables
11
+ */
6
12
  export default function listWorkbookTables(worksheetRef: WorkbookWorksheetRef): GraphOperation<(WorkbookTable & WorkbookRef)[]>;
7
13
  //# sourceMappingURL=listWorkbookTables.d.ts.map
@@ -1 +1 @@
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,uHAAuH;AACvH,MAAM,CAAC,OAAO,UAAU,kBAAkB,CAAC,YAAY,EAAE,oBAAoB,GAAG,cAAc,CAAC,CAAC,aAAa,GAAG,WAAW,CAAC,EAAE,CAAC,CAwB9H"}
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"}
@@ -1,7 +1,13 @@
1
1
  import { operation } from "../../graphApi.js";
2
2
  import { generatePath } from "../../services/templatedPaths.js";
3
3
  import { createWorkbookTableRef } from "../../services/workbookTable.js";
4
- /** Retrieve a list of tables in a worksheet. @see https://learn.microsoft.com/en-us/graph/api/worksheet-list-tables */
4
+ /**
5
+ * Retrieve a list of tables in a worksheet.
6
+ *
7
+ * @param worksheetRef - A reference to the worksheet, optionally including session information.
8
+ * @returns An array of tables, each including its metadata and reference information.
9
+ * @see https://learn.microsoft.com/en-us/graph/api/worksheet-list-tables
10
+ */
5
11
  export default function listWorkbookTables(worksheetRef) {
6
12
  return operation({
7
13
  contextId: worksheetRef.contextId,
@@ -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 calculateWorkbook from "../workbook/calculateWorkbook.js";
9
9
  import createWorkbook from "../workbook/createWorkbook.js";
10
10
  import createWorkbookTable from "./createWorkbookTable.js";
@@ -24,7 +24,7 @@ describe("listWorkbookTables", () => {
24
24
  expect(tables.length).toBeGreaterThan(0);
25
25
  }
26
26
  finally {
27
- await deleteDriveItemWithRetry(workbook);
27
+ await tryDeleteDriveItem(workbook);
28
28
  }
29
29
  });
30
30
  });
@@ -3,6 +3,13 @@ import type { GraphOperation } from "../../models/GraphOperation.ts";
3
3
  import type { WorkbookRef } from "../../models/WorkbookRef.ts";
4
4
  import type { WorkbookWorksheetName } from "../../models/WorkbookWorksheetName.ts";
5
5
  import type { WorkbookWorksheetRef } from "../../models/WorkbookWorksheetRef.ts";
6
- /** Create a new worksheet, optionally with a defined name. @see https://learn.microsoft.com/en-us/graph/api/worksheetcollection-add */
6
+ /**
7
+ * Create a new worksheet in a workbook, optionally with a defined name.
8
+ *
9
+ * @param workbookRef - A reference to the workbook where the worksheet will be created, optionally including session information.
10
+ * @param name - (Optional) The name of the new worksheet.
11
+ * @returns The newly created worksheet, including its metadata and reference information.
12
+ * @see https://learn.microsoft.com/en-us/graph/api/worksheetcollection-add
13
+ */
7
14
  export default function createWorkbookWorksheet(workbookRef: WorkbookRef, name?: WorkbookWorksheetName): GraphOperation<WorkbookWorksheet & WorkbookWorksheetRef>;
8
15
  //# sourceMappingURL=createWorkbookWorksheet.d.ts.map
@@ -1 +1 @@
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,uIAAuI;AACvI,MAAM,CAAC,OAAO,UAAU,uBAAuB,CAAC,WAAW,EAAE,WAAW,EAAE,IAAI,CAAC,EAAE,qBAAqB,GAAG,cAAc,CAAC,iBAAiB,GAAG,oBAAoB,CAAC,CAsBhK"}
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"}
@@ -1,7 +1,14 @@
1
1
  import { operation } from "../../graphApi.js";
2
2
  import { generatePath } from "../../services/templatedPaths.js";
3
3
  import { createWorkbookWorksheetRef } from "../../services/workbookWorksheet.js";
4
- /** Create a new worksheet, optionally with a defined name. @see https://learn.microsoft.com/en-us/graph/api/worksheetcollection-add */
4
+ /**
5
+ * Create a new worksheet in a workbook, optionally with a defined name.
6
+ *
7
+ * @param workbookRef - A reference to the workbook where the worksheet will be created, optionally including session information.
8
+ * @param name - (Optional) The name of the new worksheet.
9
+ * @returns The newly created worksheet, including its metadata and reference information.
10
+ * @see https://learn.microsoft.com/en-us/graph/api/worksheetcollection-add
11
+ */
5
12
  export default function createWorkbookWorksheet(workbookRef, name) {
6
13
  return operation({
7
14
  contextId: workbookRef.contextId,
@@ -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 "../workbook/createWorkbook.js";
7
7
  import createWorkbookWorksheet from "./createWorkbookWorksheet.js";
8
8
  describe("createWorkbookWorksheet", () => {
@@ -17,7 +17,7 @@ describe("createWorkbookWorksheet", () => {
17
17
  expect(worksheet.name).toBe(worksheetName);
18
18
  }
19
19
  finally {
20
- await deleteDriveItemWithRetry(workbook);
20
+ await tryDeleteDriveItem(workbook);
21
21
  }
22
22
  });
23
23
  it("can create a new worksheet without a name", async () => {
@@ -30,7 +30,7 @@ describe("createWorkbookWorksheet", () => {
30
30
  expect(worksheet.name).toBeDefined();
31
31
  }
32
32
  finally {
33
- await deleteDriveItemWithRetry(workbook);
33
+ await tryDeleteDriveItem(workbook);
34
34
  }
35
35
  });
36
36
  });
@@ -1,5 +1,11 @@
1
1
  import type { GraphOperation } from "../../models/GraphOperation.ts";
2
2
  import type { WorkbookWorksheetRef } from "../../models/WorkbookWorksheetRef.ts";
3
- /** Permanently delete a worksheet. @see https://learn.microsoft.com/en-us/graph/api/worksheet-delete */
3
+ /**
4
+ * Permanently delete a worksheet.
5
+ *
6
+ * @param worksheetRef - A reference to the worksheet to be deleted, optionally including session information.
7
+ * @returns Nothing.
8
+ * @see https://learn.microsoft.com/en-us/graph/api/worksheet-delete
9
+ */
4
10
  export default function deleteWorkbookWorksheet(worksheetRef: WorkbookWorksheetRef): GraphOperation<void>;
5
11
  //# sourceMappingURL=deleteWorkbookWorksheet.d.ts.map
@@ -1 +1 @@
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,wGAAwG;AACxG,MAAM,CAAC,OAAO,UAAU,uBAAuB,CAAC,YAAY,EAAE,oBAAoB,GAAG,cAAc,CAAC,IAAI,CAAC,CAWxG"}
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"}
@@ -1,6 +1,12 @@
1
1
  import { operation } from "../../graphApi.js";
2
2
  import { generatePath } from "../../services/templatedPaths.js";
3
- /** Permanently delete a worksheet. @see https://learn.microsoft.com/en-us/graph/api/worksheet-delete */
3
+ /**
4
+ * Permanently delete a worksheet.
5
+ *
6
+ * @param worksheetRef - A reference to the worksheet to be deleted, optionally including session information.
7
+ * @returns Nothing.
8
+ * @see https://learn.microsoft.com/en-us/graph/api/worksheet-delete
9
+ */
4
10
  export default function deleteWorkbookWorksheet(worksheetRef) {
5
11
  return operation({
6
12
  contextId: worksheetRef.contextId,
@@ -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 calculateWorkbook from "../workbook/calculateWorkbook.js";
7
7
  import createWorkbook from "../workbook/createWorkbook.js";
8
8
  import createWorkbookWorksheet from "./createWorkbookWorksheet.js";
@@ -22,7 +22,7 @@ describe("deleteWorkbookWorksheet", () => {
22
22
  expect(worksheets.some((ws) => ws.id === worksheet.worksheetId)).toBe(false);
23
23
  }
24
24
  finally {
25
- await deleteDriveItemWithRetry(workbook);
25
+ await tryDeleteDriveItem(workbook);
26
26
  }
27
27
  });
28
28
  });
@@ -0,0 +1,13 @@
1
+ import type { WorkbookRange } from "@microsoft/microsoft-graph-types";
2
+ import type { GraphOperation } from "../../models/GraphOperation.ts";
3
+ import type { WorkbookRangeRef } from "../../models/WorkbookRangeRef.ts";
4
+ import type { WorkbookWorksheetRef } from "../../models/WorkbookWorksheetRef.ts";
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
11
+ */
12
+ export default function getWorkbookWorksheetUsedRange(worksheetRef: WorkbookWorksheetRef): GraphOperation<WorkbookRange & WorkbookRangeRef>;
13
+ //# sourceMappingURL=getWorkbookWorksheetUsedRange.d.ts.map
@@ -0,0 +1 @@
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"}
@@ -0,0 +1,33 @@
1
+ import ProtocolError from "../../errors/ProtocolError.js";
2
+ import { operation } from "../../graphApi.js";
3
+ import { generatePath } from "../../services/templatedPaths.js";
4
+ import { createWorkbookRangeRef } from "../../services/workbookRange.js";
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
11
+ */
12
+ export default function getWorkbookWorksheetUsedRange(worksheetRef) {
13
+ return operation({
14
+ contextId: worksheetRef.contextId,
15
+ method: "GET",
16
+ path: generatePath("/sites/{site-id}/drives/{drive-id}/items/{item-id}/workbook/worksheets/{worksheet-id}/range/usedRange", worksheetRef),
17
+ headers: {
18
+ "workbook-session-id": worksheetRef.sessionId,
19
+ },
20
+ body: null,
21
+ responseTransform: (response) => {
22
+ const range = response;
23
+ if (!range.address) {
24
+ throw new ProtocolError("Invalid response: address is missing");
25
+ }
26
+ const rangeRef = createWorkbookRangeRef(worksheetRef, range.address);
27
+ return {
28
+ ...range,
29
+ ...rangeRef,
30
+ };
31
+ },
32
+ });
33
+ }
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=getWorkbookWorksheetUsedRange.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"getWorkbookWorksheetUsedRange.test.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookWorksheet/getWorkbookWorksheetUsedRange.test.ts"],"names":[],"mappings":""}
@@ -0,0 +1,54 @@
1
+ import { describe, expect, it } from "vitest";
2
+ import { sequential } from "../../graphApi.js";
3
+ import { getDefaultDriveRef } from "../../services/drive.js";
4
+ import { driveItemPath } from "../../services/driveItem.js";
5
+ import { generateTempFileName } from "../../services/temporaryFiles.js";
6
+ import { createWorkbookRangeRef } from "../../services/workbookRange.js";
7
+ import { createWorkbookWorksheetRef, defaultWorkbookWorksheetId } 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 getWorkbookUsedRange from "./getWorkbookWorksheetUsedRange.js";
13
+ const values = [
14
+ [1, 2],
15
+ [3, 4],
16
+ ];
17
+ describe("getWorkbookUsedRange", () => {
18
+ it("can retrieve the used range from an existing workbook", async () => {
19
+ const workbookName = generateTempFileName("xlsx");
20
+ const workbookPath = driveItemPath(workbookName);
21
+ const driveRef = getDefaultDriveRef();
22
+ const workbook = await createWorkbook(driveRef, workbookPath);
23
+ const worksheetRef = createWorkbookWorksheetRef(workbook, defaultWorkbookWorksheetId);
24
+ const rangeRef = createWorkbookRangeRef(worksheetRef, "A1:B2");
25
+ try {
26
+ await updateWorkbookRange(rangeRef, {
27
+ values: values,
28
+ });
29
+ await calculateWorkbook(workbook);
30
+ const usedRange = await getWorkbookUsedRange(worksheetRef);
31
+ expect(usedRange.values).toEqual(values);
32
+ }
33
+ finally {
34
+ await tryDeleteDriveItem(workbook);
35
+ }
36
+ });
37
+ it("can retrieve the used range from an existing workbook sequential", async () => {
38
+ const workbookName = generateTempFileName("xlsx");
39
+ const workbookPath = driveItemPath(workbookName);
40
+ const driveRef = getDefaultDriveRef();
41
+ const workbook = await createWorkbook(driveRef, workbookPath);
42
+ const worksheetRef = createWorkbookWorksheetRef(workbook, defaultWorkbookWorksheetId);
43
+ const rangeRef = createWorkbookRangeRef(worksheetRef, "A1:B2");
44
+ try {
45
+ const [_, __, usedRange] = await sequential(updateWorkbookRange(rangeRef, {
46
+ values: values,
47
+ }), calculateWorkbook(workbook), getWorkbookUsedRange(worksheetRef));
48
+ expect(usedRange.values).toEqual(values);
49
+ }
50
+ finally {
51
+ await tryDeleteDriveItem(workbook);
52
+ }
53
+ });
54
+ });