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,16 @@ import InvalidArgumentError from "../../errors/InvalidArgumentError.js";
2
2
  import { operation } from "../../graphApi.js";
3
3
  // Overview of SendMail process: https://learn.microsoft.com/en-us/graph/outlook-things-to-know-about-send-mail
4
4
  const emailPattern = /^[a-zA-Z0-9._\-@]+$/; // Basic, but intended just to avoid URL escaping issues
5
- /** Send an email from the current or a specified user. @see https://learn.microsoft.com/en-us/graph/api/user-sendmail */
5
+ /**
6
+ * Send an email.
7
+ *
8
+ * @param contextRef - A reference to the context.
9
+ * @param sender - The email address of the sender or NULL for the current user. Must match a valid email address in this tenant.
10
+ * @param message - The email message to be sent.
11
+ * @returns Nothing.
12
+ * @throws InvalidArgumentError if the sender email address does not match the required pattern.
13
+ * @see https://learn.microsoft.com/en-us/graph/api/user-sendmail
14
+ */
6
15
  export default function userSendMail(contextRef, sender, message) {
7
16
  if (sender && !emailPattern.test(sender)) {
8
17
  throw new InvalidArgumentError(`Invalid email address. Must match pattern '${emailPattern}'`);
@@ -1,7 +1,19 @@
1
1
  import type { GraphOperation } from "../../models/GraphOperation.ts";
2
2
  import type { WorkbookRef } from "../../models/WorkbookRef.ts";
3
- /** Recalculate a workbook. @see https://learn.microsoft.com/en-us/graph/api/workbookapplication-calculate */
3
+ /**
4
+ * Recalculate a workbook.
5
+ *
6
+ * @param workbookRef - A reference to the workbook to be recalculated.
7
+ * @param calculationType - The type of recalculation to perform. Can be "Recalculate", "Full", or "FullRebuild". Defaults to "Recalculate".
8
+ * @returns Nothing.
9
+ * @see https://learn.microsoft.com/en-us/graph/api/workbookapplication-calculate
10
+ */
4
11
  export default function calculateWorkbook(workbookRef: WorkbookRef, calculationType?: "Recalculate" | "Full" | "FullRebuild"): GraphOperation<void>;
5
- /** @deprecated Use calculateWorkbook instead. */
12
+ /**
13
+ * @deprecated Use calculateWorkbook instead.
14
+ *
15
+ * @param workbookRef - A reference to the workbook to be recalculated.
16
+ * @returns Nothing.
17
+ */
6
18
  export declare function recalculateWorkbook(workbookRef: WorkbookRef): GraphOperation<void>;
7
19
  //# sourceMappingURL=calculateWorkbook.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"calculateWorkbook.d.ts","sourceRoot":"","sources":["../../../src/operations/workbook/calculateWorkbook.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAG/D,6GAA6G;AAC7G,MAAM,CAAC,OAAO,UAAU,iBAAiB,CAAC,WAAW,EAAE,WAAW,EAAE,eAAe,GAAE,aAAa,GAAG,MAAM,GAAG,aAA6B,GAAG,cAAc,CAAC,IAAI,CAAC,CAajK;AAED,iDAAiD;AACjD,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,cAAc,CAAC,IAAI,CAAC,CAElF"}
1
+ {"version":3,"file":"calculateWorkbook.d.ts","sourceRoot":"","sources":["../../../src/operations/workbook/calculateWorkbook.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAG/D;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,UAAU,iBAAiB,CAAC,WAAW,EAAE,WAAW,EAAE,eAAe,GAAE,aAAa,GAAG,MAAM,GAAG,aAA6B,GAAG,cAAc,CAAC,IAAI,CAAC,CAajK;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,cAAc,CAAC,IAAI,CAAC,CAElF"}
@@ -1,6 +1,13 @@
1
1
  import { operation } from "../../graphApi.js";
2
2
  import { generatePath } from "../../services/templatedPaths.js";
3
- /** Recalculate a workbook. @see https://learn.microsoft.com/en-us/graph/api/workbookapplication-calculate */
3
+ /**
4
+ * Recalculate a workbook.
5
+ *
6
+ * @param workbookRef - A reference to the workbook to be recalculated.
7
+ * @param calculationType - The type of recalculation to perform. Can be "Recalculate", "Full", or "FullRebuild". Defaults to "Recalculate".
8
+ * @returns Nothing.
9
+ * @see https://learn.microsoft.com/en-us/graph/api/workbookapplication-calculate
10
+ */
4
11
  export default function calculateWorkbook(workbookRef, calculationType = "Recalculate") {
5
12
  return operation({
6
13
  contextId: workbookRef.contextId,
@@ -15,7 +22,12 @@ export default function calculateWorkbook(workbookRef, calculationType = "Recalc
15
22
  responseTransform: () => undefined,
16
23
  });
17
24
  }
18
- /** @deprecated Use calculateWorkbook instead. */
25
+ /**
26
+ * @deprecated Use calculateWorkbook instead.
27
+ *
28
+ * @param workbookRef - A reference to the workbook to be recalculated.
29
+ * @returns Nothing.
30
+ */
19
31
  export function recalculateWorkbook(workbookRef) {
20
32
  return calculateWorkbook(workbookRef, "Recalculate");
21
33
  }
@@ -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
  });
@@ -4,6 +4,14 @@ import type { DriveItemRef } from "../../models/DriveItemRef.ts";
4
4
  import type { DriveRef } from "../../models/DriveRef.ts";
5
5
  import type { GraphOperation } from "../../models/GraphOperation.ts";
6
6
  import type { WorkbookRef } from "../../models/WorkbookRef.ts";
7
- /** Create a new blank workbook. @see https://learn.microsoft.com/en-us/graph/api/driveitem-put-content */
7
+ /**
8
+ * Create a new blank workbook.
9
+ *
10
+ * @param parentRef - A reference to the parent drive or folder where the workbook will be created.
11
+ * @param itemPath - The path (including the filename) for the new workbook. Must end with `.xlsx`.
12
+ * @returns The newly created workbook, including its metadata and reference information.
13
+ * @throws InvalidArgumentError if the item path does not end with `.xlsx`.
14
+ * @see https://learn.microsoft.com/en-us/graph/api/driveitem-put-content
15
+ */
8
16
  export default function createWorkbook(parentRef: DriveRef | DriveItemRef, itemPath: DriveItemPath): GraphOperation<DriveItem & WorkbookRef>;
9
17
  //# sourceMappingURL=createWorkbook.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"createWorkbook.d.ts","sourceRoot":"","sources":["../../../src/operations/workbook/createWorkbook.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAC;AAIlE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAI/D,0GAA0G;AAC1G,MAAM,CAAC,OAAO,UAAU,cAAc,CAAC,SAAS,EAAE,QAAQ,GAAG,YAAY,EAAE,QAAQ,EAAE,aAAa,GAAG,cAAc,CAAC,SAAS,GAAG,WAAW,CAAC,CAyB3I"}
1
+ {"version":3,"file":"createWorkbook.d.ts","sourceRoot":"","sources":["../../../src/operations/workbook/createWorkbook.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAC;AAIlE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAI/D;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,UAAU,cAAc,CAAC,SAAS,EAAE,QAAQ,GAAG,YAAY,EAAE,QAAQ,EAAE,aAAa,GAAG,cAAc,CAAC,SAAS,GAAG,WAAW,CAAC,CAyB3I"}
@@ -2,7 +2,15 @@ import InvalidArgumentError from "../../errors/InvalidArgumentError.js";
2
2
  import { operation } from "../../graphApi.js";
3
3
  import { createDriveItemRef, workbookFileExtension } from "../../services/driveItem.js";
4
4
  import { generatePath } from "../../services/templatedPaths.js";
5
- /** Create a new blank workbook. @see https://learn.microsoft.com/en-us/graph/api/driveitem-put-content */
5
+ /**
6
+ * Create a new blank workbook.
7
+ *
8
+ * @param parentRef - A reference to the parent drive or folder where the workbook will be created.
9
+ * @param itemPath - The path (including the filename) for the new workbook. Must end with `.xlsx`.
10
+ * @returns The newly created workbook, including its metadata and reference information.
11
+ * @throws InvalidArgumentError if the item path does not end with `.xlsx`.
12
+ * @see https://learn.microsoft.com/en-us/graph/api/driveitem-put-content
13
+ */
6
14
  export default function createWorkbook(parentRef, itemPath) {
7
15
  if (!itemPath.endsWith(`.${workbookFileExtension}`)) {
8
16
  throw new InvalidArgumentError(`Item path must end with '.${workbookFileExtension}'`);
@@ -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
  });
@@ -1,5 +1,11 @@
1
1
  import type { GraphOperation } from "../../models/GraphOperation.ts";
2
2
  import type { WorkbookRef } from "../../models/WorkbookRef.ts";
3
- /** Delete a workbook. @see https://learn.microsoft.com/en-us/graph/api/driveitem-delete */
3
+ /**
4
+ * Delete a workbook.
5
+ *
6
+ * @param workbookRef - A reference to the workbook to be deleted.
7
+ * @returns Nothing.
8
+ * @see https://learn.microsoft.com/en-us/graph/api/driveitem-delete
9
+ */
4
10
  export default function deleteWorkbook(workbookRef: WorkbookRef): GraphOperation<void>;
5
11
  //# sourceMappingURL=deleteWorkbook.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"deleteWorkbook.d.ts","sourceRoot":"","sources":["../../../src/operations/workbook/deleteWorkbook.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAG/D,2FAA2F;AAC3F,MAAM,CAAC,OAAO,UAAU,cAAc,CAAC,WAAW,EAAE,WAAW,GAAG,cAAc,CAAC,IAAI,CAAC,CAErF"}
1
+ {"version":3,"file":"deleteWorkbook.d.ts","sourceRoot":"","sources":["../../../src/operations/workbook/deleteWorkbook.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAG/D;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,cAAc,CAAC,WAAW,EAAE,WAAW,GAAG,cAAc,CAAC,IAAI,CAAC,CAErF"}
@@ -1,5 +1,11 @@
1
1
  import deleteDriveItem from "../driveItem/deleteDriveItem.js";
2
- /** Delete a workbook. @see https://learn.microsoft.com/en-us/graph/api/driveitem-delete */
2
+ /**
3
+ * Delete a workbook.
4
+ *
5
+ * @param workbookRef - A reference to the workbook to be deleted.
6
+ * @returns Nothing.
7
+ * @see https://learn.microsoft.com/en-us/graph/api/driveitem-delete
8
+ */
3
9
  export default function deleteWorkbook(workbookRef) {
4
10
  return deleteDriveItem(workbookRef);
5
11
  }
@@ -1,5 +1,12 @@
1
1
  import type { GraphOperation } from "../../models/GraphOperation.ts";
2
2
  import type { WorkbookRangeRef } from "../../models/WorkbookRangeRef.ts";
3
- /** Clear a range - content, formatting or both. @see https://learn.microsoft.com/en-us/graph/api/range-delete */
3
+ /**
4
+ * Clear a range - content, formatting, or both.
5
+ *
6
+ * @param rangeRef - A reference to the range to be cleared, optionally including session information.
7
+ * @param applyTo - Specifies what to clear. Can be "All", "Formats", or "Contents". Defaults to "All".
8
+ * @returns Nothing.
9
+ * @see https://learn.microsoft.com/en-us/graph/api/range-delete
10
+ */
4
11
  export default function clearWorkbookRange(rangeRef: WorkbookRangeRef, applyTo?: "All" | "Formats" | "Contents"): GraphOperation<void>;
5
12
  //# sourceMappingURL=clearWorkbookRange.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"clearWorkbookRange.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookRange/clearWorkbookRange.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAGzE,iHAAiH;AACjH,MAAM,CAAC,OAAO,UAAU,kBAAkB,CAAC,QAAQ,EAAE,gBAAgB,EAAE,OAAO,GAAE,KAAK,GAAG,SAAS,GAAG,UAAkB,GAAG,cAAc,CAAC,IAAI,CAAC,CAc5I"}
1
+ {"version":3,"file":"clearWorkbookRange.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookRange/clearWorkbookRange.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAGzE;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,UAAU,kBAAkB,CAAC,QAAQ,EAAE,gBAAgB,EAAE,OAAO,GAAE,KAAK,GAAG,SAAS,GAAG,UAAkB,GAAG,cAAc,CAAC,IAAI,CAAC,CAc5I"}
@@ -1,6 +1,13 @@
1
1
  import { operation } from "../../graphApi.js";
2
2
  import { generatePath } from "../../services/templatedPaths.js";
3
- /** Clear a range - content, formatting or both. @see https://learn.microsoft.com/en-us/graph/api/range-delete */
3
+ /**
4
+ * Clear a range - content, formatting, or both.
5
+ *
6
+ * @param rangeRef - A reference to the range to be cleared, optionally including session information.
7
+ * @param applyTo - Specifies what to clear. Can be "All", "Formats", or "Contents". Defaults to "All".
8
+ * @returns Nothing.
9
+ * @see https://learn.microsoft.com/en-us/graph/api/range-delete
10
+ */
4
11
  export default function clearWorkbookRange(rangeRef, applyTo = "All") {
5
12
  return operation({
6
13
  contextId: rangeRef.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 { 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
  });
@@ -1,5 +1,12 @@
1
1
  import type { GraphOperation } from "../../models/GraphOperation.ts";
2
2
  import type { WorkbookRangeRef } from "../../models/WorkbookRangeRef.ts";
3
- /** Delete a range. @see https://learn.microsoft.com/en-us/graph/api/range-clear */
3
+ /**
4
+ * Delete a range.
5
+ *
6
+ * @param rangeRef - A reference to the range to be deleted, optionally including session information.
7
+ * @param shift - The direction to shift existing cells after deletion. Can be "Up" or "Left".
8
+ * @returns Nothing.
9
+ * @see https://learn.microsoft.com/en-us/graph/api/range-clear
10
+ */
4
11
  export default function deleteWorkbookRange(rangeRef: WorkbookRangeRef, shift: "Up" | "Left"): GraphOperation<void>;
5
12
  //# sourceMappingURL=deleteWorkbookRange.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"deleteWorkbookRange.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookRange/deleteWorkbookRange.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAGzE,mFAAmF;AACnF,MAAM,CAAC,OAAO,UAAU,mBAAmB,CAAC,QAAQ,EAAE,gBAAgB,EAAE,KAAK,EAAE,IAAI,GAAG,MAAM,GAAG,cAAc,CAAC,IAAI,CAAC,CAclH"}
1
+ {"version":3,"file":"deleteWorkbookRange.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookRange/deleteWorkbookRange.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAGzE;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,UAAU,mBAAmB,CAAC,QAAQ,EAAE,gBAAgB,EAAE,KAAK,EAAE,IAAI,GAAG,MAAM,GAAG,cAAc,CAAC,IAAI,CAAC,CAclH"}
@@ -1,6 +1,13 @@
1
1
  import { operation } from "../../graphApi.js";
2
2
  import { generatePath } from "../../services/templatedPaths.js";
3
- /** Delete a range. @see https://learn.microsoft.com/en-us/graph/api/range-clear */
3
+ /**
4
+ * Delete a range.
5
+ *
6
+ * @param rangeRef - A reference to the range to be deleted, optionally including session information.
7
+ * @param shift - The direction to shift existing cells after deletion. Can be "Up" or "Left".
8
+ * @returns Nothing.
9
+ * @see https://learn.microsoft.com/en-us/graph/api/range-clear
10
+ */
4
11
  export default function deleteWorkbookRange(rangeRef, shift) {
5
12
  return operation({
6
13
  contextId: rangeRef.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 { 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
  });
@@ -1,6 +1,12 @@
1
1
  import type { WorkbookRange } from "@microsoft/microsoft-graph-types";
2
2
  import type { GraphOperation } from "../../models/GraphOperation.ts";
3
3
  import type { WorkbookNamedRangeRef } from "../../models/WorkbookNamedRangeRef.ts";
4
- /** Retrieve range that has been defined using the "named range" functionality. @see https://learn.microsoft.com/en-us/graph/api/range-get */
4
+ /**
5
+ * Retrieve a range that has been defined using the "named range" functionality.
6
+ *
7
+ * @param rangeRef - A reference to the named range, optionally including session information.
8
+ * @returns The specified named range, including its metadata and reference information.
9
+ * @see https://learn.microsoft.com/en-us/graph/api/range-get
10
+ */
5
11
  export default function getWorkbookNamedRange(rangeRef: WorkbookNamedRangeRef): GraphOperation<WorkbookRange & WorkbookNamedRangeRef>;
6
12
  //# sourceMappingURL=getWorkbookNamedRange.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"getWorkbookNamedRange.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookRange/getWorkbookNamedRange.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,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AAGnF,6IAA6I;AAC7I,MAAM,CAAC,OAAO,UAAU,qBAAqB,CAAC,QAAQ,EAAE,qBAAqB,GAAG,cAAc,CAAC,aAAa,GAAG,qBAAqB,CAAC,CAiBpI"}
1
+ {"version":3,"file":"getWorkbookNamedRange.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookRange/getWorkbookNamedRange.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,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AAGnF;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,qBAAqB,CAAC,QAAQ,EAAE,qBAAqB,GAAG,cAAc,CAAC,aAAa,GAAG,qBAAqB,CAAC,CAiBpI"}
@@ -1,6 +1,12 @@
1
1
  import { operation } from "../../graphApi.js";
2
2
  import { generatePath } from "../../services/templatedPaths.js";
3
- /** Retrieve range that has been defined using the "named range" functionality. @see https://learn.microsoft.com/en-us/graph/api/range-get */
3
+ /**
4
+ * Retrieve a range that has been defined using the "named range" functionality.
5
+ *
6
+ * @param rangeRef - A reference to the named range, optionally including session information.
7
+ * @returns The specified named range, including its metadata and reference information.
8
+ * @see https://learn.microsoft.com/en-us/graph/api/range-get
9
+ */
4
10
  export default function getWorkbookNamedRange(rangeRef) {
5
11
  return operation({
6
12
  contextId: rangeRef.contextId,
@@ -1,6 +1,12 @@
1
1
  import type { WorkbookRangeFormat } from "@microsoft/microsoft-graph-types";
2
2
  import type { GraphOperation } from "../../models/GraphOperation.ts";
3
3
  import type { WorkbookRangeRef } from "../../models/WorkbookRangeRef.ts";
4
- /** Retrieve the format of a workbook range. @see https://learn.microsoft.com/en-us/graph/api/rangeformat-get */
4
+ /**
5
+ * Retrieve the format of a workbook range.
6
+ *
7
+ * @param rangeRef - A reference to the range, optionally including session information.
8
+ * @returns The format of the specified range, including its metadata and reference information.
9
+ * @see https://learn.microsoft.com/en-us/graph/api/rangeformat-get
10
+ */
5
11
  export default function getWorkbookRangeFormat(rangeRef: WorkbookRangeRef): GraphOperation<WorkbookRangeFormat & WorkbookRangeRef>;
6
12
  //# sourceMappingURL=getWorkbookRangeFormat.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"getWorkbookRangeFormat.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookRange/getWorkbookRangeFormat.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,gHAAgH;AAChH,MAAM,CAAC,OAAO,UAAU,sBAAsB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,cAAc,CAAC,mBAAmB,GAAG,gBAAgB,CAAC,CAiBjI"}
1
+ {"version":3,"file":"getWorkbookRangeFormat.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookRange/getWorkbookRangeFormat.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,sBAAsB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,cAAc,CAAC,mBAAmB,GAAG,gBAAgB,CAAC,CAiBjI"}
@@ -1,6 +1,12 @@
1
1
  import { operation } from "../../graphApi.js";
2
2
  import { generatePath } from "../../services/templatedPaths.js";
3
- /** Retrieve the format of a workbook range. @see https://learn.microsoft.com/en-us/graph/api/rangeformat-get */
3
+ /**
4
+ * Retrieve the format of a workbook range.
5
+ *
6
+ * @param rangeRef - A reference to the range, optionally including session information.
7
+ * @returns The format of the specified range, including its metadata and reference information.
8
+ * @see https://learn.microsoft.com/en-us/graph/api/rangeformat-get
9
+ */
4
10
  export default function getWorkbookRangeFormat(rangeRef) {
5
11
  return operation({
6
12
  contextId: rangeRef.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 { 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
  });
@@ -2,6 +2,8 @@ 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 { WorkbookWorksheetRef } from "../../models/WorkbookWorksheetRef.ts";
5
- /** Retrieve the used range in a worksheet, ignoring trailing rows and columns that are blank. @see https://learn.microsoft.com/en-us/graph/api/range-usedrange */
5
+ /**
6
+ * @deprecated Use `getWorkbookWorksheetUsedRange` instead.
7
+ */
6
8
  export default function getWorkbookUsedRange(worksheetRef: WorkbookWorksheetRef): GraphOperation<WorkbookRange & WorkbookRangeRef>;
7
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,kKAAkK;AAClK,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"}
@@ -2,7 +2,9 @@ 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 used range in a worksheet, ignoring trailing rows and columns that are blank. @see https://learn.microsoft.com/en-us/graph/api/range-usedrange */
5
+ /**
6
+ * @deprecated Use `getWorkbookWorksheetUsedRange` instead.
7
+ */
6
8
  export default function getWorkbookUsedRange(worksheetRef) {
7
9
  return operation({
8
10
  contextId: worksheetRef.contextId,
@@ -1,6 +1,12 @@
1
1
  import type { WorkbookRangeView } from "@microsoft/microsoft-graph-types";
2
2
  import type { GraphOperation } from "../../models/GraphOperation.ts";
3
3
  import type { WorkbookRangeRef } from "../../models/WorkbookRangeRef.ts";
4
- /** Retrieve the visible view of a range. @see https://learn.microsoft.com/en-us/graph/api/workbookrange-visibleview */
4
+ /**
5
+ * Retrieve the visible view of a range.
6
+ *
7
+ * @param rangeRef - A reference to the range to be fetched, optionally including session information.
8
+ * @returns The visible view of the specified range, including its metadata and reference information.
9
+ * @see https://learn.microsoft.com/en-us/graph/api/workbookrange-visibleview
10
+ */
5
11
  export default function getWorkbookVisibleRange(rangeRef: WorkbookRangeRef): GraphOperation<WorkbookRangeView & WorkbookRangeRef>;
6
12
  //# sourceMappingURL=getWorkbookVisibleRange.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"getWorkbookVisibleRange.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookRange/getWorkbookVisibleRange.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,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAGzE,uHAAuH;AACvH,MAAM,CAAC,OAAO,UAAU,uBAAuB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,cAAc,CAAC,iBAAiB,GAAG,gBAAgB,CAAC,CAmBhI"}
1
+ {"version":3,"file":"getWorkbookVisibleRange.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookRange/getWorkbookVisibleRange.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,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAGzE;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,uBAAuB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,cAAc,CAAC,iBAAiB,GAAG,gBAAgB,CAAC,CAmBhI"}
@@ -1,6 +1,12 @@
1
1
  import { operation } from "../../graphApi.js";
2
2
  import { generatePath } from "../../services/templatedPaths.js";
3
- /** Retrieve the visible view of a range. @see https://learn.microsoft.com/en-us/graph/api/workbookrange-visibleview */
3
+ /**
4
+ * Retrieve the visible view of a range.
5
+ *
6
+ * @param rangeRef - A reference to the range to be fetched, optionally including session information.
7
+ * @returns The visible view of the specified range, including its metadata and reference information.
8
+ * @see https://learn.microsoft.com/en-us/graph/api/workbookrange-visibleview
9
+ */
4
10
  export default function getWorkbookVisibleRange(rangeRef) {
5
11
  // TODO: Should be a visible ref type?
6
12
  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
  });
@@ -1,6 +1,12 @@
1
1
  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
- /** Fetch a range, including values and formatting. @see https://learn.microsoft.com/en-us/graph/api/range-get */
4
+ /**
5
+ * Fetch a range, including values and formatting.
6
+ *
7
+ * @param rangeRef - A reference to the range to be fetched, optionally including session information.
8
+ * @returns The fetched range, including its metadata and reference information.
9
+ * @see https://learn.microsoft.com/en-us/graph/api/range-get
10
+ */
5
11
  export default function getWorkbookWorksheetRange(rangeRef: WorkbookRangeRef): GraphOperation<WorkbookRange & WorkbookRangeRef>;
6
12
  //# sourceMappingURL=getWorkbookWorksheetRange.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"getWorkbookWorksheetRange.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookRange/getWorkbookWorksheetRange.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,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAGzE,iHAAiH;AACjH,MAAM,CAAC,OAAO,UAAU,yBAAyB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,cAAc,CAAC,aAAa,GAAG,gBAAgB,CAAC,CAkB9H"}
1
+ {"version":3,"file":"getWorkbookWorksheetRange.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookRange/getWorkbookWorksheetRange.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,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAGzE;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,yBAAyB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,cAAc,CAAC,aAAa,GAAG,gBAAgB,CAAC,CAkB9H"}
@@ -1,6 +1,12 @@
1
1
  import { operation } from "../../graphApi.js";
2
2
  import { generatePath } from "../../services/templatedPaths.js";
3
- /** Fetch a range, including values and formatting. @see https://learn.microsoft.com/en-us/graph/api/range-get */
3
+ /**
4
+ * Fetch a range, including values and formatting.
5
+ *
6
+ * @param rangeRef - A reference to the range to be fetched, optionally including session information.
7
+ * @returns The fetched range, including its metadata and reference information.
8
+ * @see https://learn.microsoft.com/en-us/graph/api/range-get
9
+ */
4
10
  export default function getWorkbookWorksheetRange(rangeRef) {
5
11
  return operation({
6
12
  contextId: rangeRef.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 { 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
  });
@@ -3,6 +3,14 @@ import type { Address } from "../../models/Address.ts";
3
3
  import type { GraphOperation } from "../../models/GraphOperation.ts";
4
4
  import type { WorkbookRangeRef } from "../../models/WorkbookRangeRef.ts";
5
5
  import type { WorkbookWorksheetRef } from "../../models/WorkbookWorksheetRef.ts";
6
- /** Insert a new blank range at a specified address, shifting existing cells. Use `updateRange` after to set content. @see https://learn.microsoft.com/en-us/graph/api/range-insert */
6
+ /**
7
+ * Insert a new blank range at a specified address, shifting existing cells. Use `updateWorkbookRange` afterward to set content.
8
+ *
9
+ * @param worksheetRef - A reference to the worksheet where the range will be inserted, optionally including session information.
10
+ * @param address - The address where the new range will be inserted.
11
+ * @param shift - The direction to shift existing cells. Can be "Down" or "Right".
12
+ * @returns The newly inserted range, including its metadata and reference information.
13
+ * @see https://learn.microsoft.com/en-us/graph/api/range-insert
14
+ */
7
15
  export default function insertWorkbookCells(worksheetRef: WorkbookWorksheetRef, address: Address, shift: "Down" | "Right"): GraphOperation<WorkbookRange & WorkbookRangeRef>;
8
16
  //# sourceMappingURL=insertWorkbookCells.d.ts.map