microsoft-graph 2.3.0 → 2.3.1

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 (213) hide show
  1. package/.vscode/settings.json +2 -1
  2. package/dist/operations/drive/createFolder.d.ts +8 -1
  3. package/dist/operations/drive/createFolder.d.ts.map +1 -1
  4. package/dist/operations/drive/createFolder.js +8 -1
  5. package/dist/operations/drive/listDrives.d.ts +7 -1
  6. package/dist/operations/drive/listDrives.d.ts.map +1 -1
  7. package/dist/operations/drive/listDrives.js +7 -1
  8. package/dist/operations/driveItem/deleteDriveItem.d.ts +7 -1
  9. package/dist/operations/driveItem/deleteDriveItem.d.ts.map +1 -1
  10. package/dist/operations/driveItem/deleteDriveItem.js +7 -1
  11. package/dist/operations/driveItem/getDriveItem.d.ts +7 -1
  12. package/dist/operations/driveItem/getDriveItem.d.ts.map +1 -1
  13. package/dist/operations/driveItem/getDriveItem.js +7 -1
  14. package/dist/operations/driveItem/getDriveItemByPath.d.ts +8 -1
  15. package/dist/operations/driveItem/getDriveItemByPath.d.ts.map +1 -1
  16. package/dist/operations/driveItem/getDriveItemByPath.js +8 -1
  17. package/dist/operations/driveItem/getDriveItemContent.d.ts +8 -1
  18. package/dist/operations/driveItem/getDriveItemContent.d.ts.map +1 -1
  19. package/dist/operations/driveItem/getDriveItemContent.js +8 -1
  20. package/dist/operations/driveItem/initiateCopyDriveItem.d.ts +9 -1
  21. package/dist/operations/driveItem/initiateCopyDriveItem.d.ts.map +1 -1
  22. package/dist/operations/driveItem/initiateCopyDriveItem.js +9 -1
  23. package/dist/operations/driveItem/listDriveItems.d.ts +8 -2
  24. package/dist/operations/driveItem/listDriveItems.d.ts.map +1 -1
  25. package/dist/operations/driveItem/listDriveItems.js +8 -3
  26. package/dist/operations/site/getSite.d.ts +7 -1
  27. package/dist/operations/site/getSite.d.ts.map +1 -1
  28. package/dist/operations/site/getSite.js +7 -1
  29. package/dist/operations/site/getSiteByName.d.ts +9 -1
  30. package/dist/operations/site/getSiteByName.d.ts.map +1 -1
  31. package/dist/operations/site/getSiteByName.js +9 -1
  32. package/dist/operations/site/listSites.d.ts +7 -1
  33. package/dist/operations/site/listSites.d.ts.map +1 -1
  34. package/dist/operations/site/listSites.js +7 -1
  35. package/dist/operations/site/searchSites.d.ts +8 -1
  36. package/dist/operations/site/searchSites.d.ts.map +1 -1
  37. package/dist/operations/site/searchSites.js +8 -1
  38. package/dist/operations/user/userSendMail.d.ts +10 -1
  39. package/dist/operations/user/userSendMail.d.ts.map +1 -1
  40. package/dist/operations/user/userSendMail.js +10 -1
  41. package/dist/operations/workbook/calculateWorkbook.d.ts +14 -2
  42. package/dist/operations/workbook/calculateWorkbook.d.ts.map +1 -1
  43. package/dist/operations/workbook/calculateWorkbook.js +14 -2
  44. package/dist/operations/workbook/createWorkbook.d.ts +9 -1
  45. package/dist/operations/workbook/createWorkbook.d.ts.map +1 -1
  46. package/dist/operations/workbook/createWorkbook.js +9 -1
  47. package/dist/operations/workbook/deleteWorkbook.d.ts +7 -1
  48. package/dist/operations/workbook/deleteWorkbook.d.ts.map +1 -1
  49. package/dist/operations/workbook/deleteWorkbook.js +7 -1
  50. package/dist/operations/workbookRange/clearWorkbookRange.d.ts +8 -1
  51. package/dist/operations/workbookRange/clearWorkbookRange.d.ts.map +1 -1
  52. package/dist/operations/workbookRange/clearWorkbookRange.js +8 -1
  53. package/dist/operations/workbookRange/deleteWorkbookRange.d.ts +8 -1
  54. package/dist/operations/workbookRange/deleteWorkbookRange.d.ts.map +1 -1
  55. package/dist/operations/workbookRange/deleteWorkbookRange.js +8 -1
  56. package/dist/operations/workbookRange/getWorkbookNamedRange.d.ts +7 -1
  57. package/dist/operations/workbookRange/getWorkbookNamedRange.d.ts.map +1 -1
  58. package/dist/operations/workbookRange/getWorkbookNamedRange.js +7 -1
  59. package/dist/operations/workbookRange/getWorkbookRangeFormat.d.ts +7 -1
  60. package/dist/operations/workbookRange/getWorkbookRangeFormat.d.ts.map +1 -1
  61. package/dist/operations/workbookRange/getWorkbookRangeFormat.js +7 -1
  62. package/dist/operations/workbookRange/getWorkbookUsedRange.d.ts +7 -1
  63. package/dist/operations/workbookRange/getWorkbookUsedRange.d.ts.map +1 -1
  64. package/dist/operations/workbookRange/getWorkbookUsedRange.js +7 -1
  65. package/dist/operations/workbookRange/getWorkbookVisibleRange.d.ts +7 -1
  66. package/dist/operations/workbookRange/getWorkbookVisibleRange.d.ts.map +1 -1
  67. package/dist/operations/workbookRange/getWorkbookVisibleRange.js +7 -1
  68. package/dist/operations/workbookRange/getWorkbookWorksheetRange.d.ts +7 -1
  69. package/dist/operations/workbookRange/getWorkbookWorksheetRange.d.ts.map +1 -1
  70. package/dist/operations/workbookRange/getWorkbookWorksheetRange.js +7 -1
  71. package/dist/operations/workbookRange/insertWorkbookCells.d.ts +9 -1
  72. package/dist/operations/workbookRange/insertWorkbookCells.d.ts.map +1 -1
  73. package/dist/operations/workbookRange/insertWorkbookCells.js +9 -1
  74. package/dist/operations/workbookRange/updateWorkbookNamedRange.d.ts +8 -1
  75. package/dist/operations/workbookRange/updateWorkbookNamedRange.d.ts.map +1 -1
  76. package/dist/operations/workbookRange/updateWorkbookNamedRange.js +8 -1
  77. package/dist/operations/workbookRange/updateWorkbookRange.d.ts +8 -1
  78. package/dist/operations/workbookRange/updateWorkbookRange.d.ts.map +1 -1
  79. package/dist/operations/workbookRange/updateWorkbookRange.js +8 -1
  80. package/dist/operations/workbookSession/closeWorkbookSession.d.ts +8 -1
  81. package/dist/operations/workbookSession/closeWorkbookSession.d.ts.map +1 -1
  82. package/dist/operations/workbookSession/closeWorkbookSession.js +8 -1
  83. package/dist/operations/workbookSession/createWorkbookSession.d.ts +9 -1
  84. package/dist/operations/workbookSession/createWorkbookSession.d.ts.map +1 -1
  85. package/dist/operations/workbookSession/createWorkbookSession.js +9 -1
  86. package/dist/operations/workbookSession/refreshWorkbookSession.d.ts +8 -1
  87. package/dist/operations/workbookSession/refreshWorkbookSession.d.ts.map +1 -1
  88. package/dist/operations/workbookSession/refreshWorkbookSession.js +8 -1
  89. package/dist/operations/workbookTable/createWorkbookTable.d.ts +8 -1
  90. package/dist/operations/workbookTable/createWorkbookTable.d.ts.map +1 -1
  91. package/dist/operations/workbookTable/createWorkbookTable.js +8 -1
  92. package/dist/operations/workbookTable/getWorkbookTable.d.ts +7 -1
  93. package/dist/operations/workbookTable/getWorkbookTable.d.ts.map +1 -1
  94. package/dist/operations/workbookTable/getWorkbookTable.js +7 -1
  95. package/dist/operations/workbookTable/getWorkbookTableBodyRange.d.ts +7 -1
  96. package/dist/operations/workbookTable/getWorkbookTableBodyRange.d.ts.map +1 -1
  97. package/dist/operations/workbookTable/getWorkbookTableBodyRange.js +7 -1
  98. package/dist/operations/workbookTable/getWorkbookTableHeaderRange.d.ts +7 -1
  99. package/dist/operations/workbookTable/getWorkbookTableHeaderRange.d.ts.map +1 -1
  100. package/dist/operations/workbookTable/getWorkbookTableHeaderRange.js +7 -1
  101. package/dist/operations/workbookTable/listWorkbookTableColumns.d.ts +7 -1
  102. package/dist/operations/workbookTable/listWorkbookTableColumns.d.ts.map +1 -1
  103. package/dist/operations/workbookTable/listWorkbookTableColumns.js +7 -1
  104. package/dist/operations/workbookTable/listWorkbookTableRows.d.ts +7 -1
  105. package/dist/operations/workbookTable/listWorkbookTableRows.d.ts.map +1 -1
  106. package/dist/operations/workbookTable/listWorkbookTableRows.js +7 -1
  107. package/dist/operations/workbookTable/listWorkbookTables.d.ts +7 -1
  108. package/dist/operations/workbookTable/listWorkbookTables.d.ts.map +1 -1
  109. package/dist/operations/workbookTable/listWorkbookTables.js +7 -1
  110. package/dist/operations/workbookWorksheet/createWorkbookWorksheet.d.ts +8 -1
  111. package/dist/operations/workbookWorksheet/createWorkbookWorksheet.d.ts.map +1 -1
  112. package/dist/operations/workbookWorksheet/createWorkbookWorksheet.js +8 -1
  113. package/dist/operations/workbookWorksheet/deleteWorkbookWorksheet.d.ts +7 -1
  114. package/dist/operations/workbookWorksheet/deleteWorkbookWorksheet.d.ts.map +1 -1
  115. package/dist/operations/workbookWorksheet/deleteWorkbookWorksheet.js +7 -1
  116. package/dist/operations/workbookWorksheet/listWorkbookWorksheets.d.ts +7 -1
  117. package/dist/operations/workbookWorksheet/listWorkbookWorksheets.d.ts.map +1 -1
  118. package/dist/operations/workbookWorksheet/listWorkbookWorksheets.js +7 -1
  119. package/dist/operations/workbookWorksheet/updateWorkbookWorksheet.d.ts +11 -1
  120. package/dist/operations/workbookWorksheet/updateWorkbookWorksheet.d.ts.map +1 -1
  121. package/dist/operations/workbookWorksheet/updateWorkbookWorksheet.js +11 -1
  122. package/dist/services/accessToken.d.ts +9 -1
  123. package/dist/services/accessToken.d.ts.map +1 -1
  124. package/dist/services/accessToken.js +9 -1
  125. package/dist/services/addressManipulation.d.ts +67 -0
  126. package/dist/services/addressManipulation.d.ts.map +1 -1
  127. package/dist/services/addressManipulation.js +67 -0
  128. package/dist/services/addressOffset.d.ts +20 -0
  129. package/dist/services/addressOffset.d.ts.map +1 -1
  130. package/dist/services/addressOffset.js +20 -0
  131. package/dist/services/context.d.ts +19 -2
  132. package/dist/services/context.d.ts.map +1 -1
  133. package/dist/services/context.js +19 -2
  134. package/dist/services/drive.d.ts +12 -1
  135. package/dist/services/drive.d.ts.map +1 -1
  136. package/dist/services/drive.js +12 -1
  137. package/dist/services/driveItem.d.ts +13 -1
  138. package/dist/services/driveItem.d.ts.map +1 -1
  139. package/dist/services/driveItem.js +13 -1
  140. package/dist/services/environmentVariable.d.ts +13 -0
  141. package/dist/services/environmentVariable.d.ts.map +1 -1
  142. package/dist/services/environmentVariable.js +13 -0
  143. package/dist/services/httpAgent.d.ts +5 -0
  144. package/dist/services/httpAgent.d.ts.map +1 -1
  145. package/dist/services/httpAgent.js +5 -0
  146. package/dist/services/httpStatus.d.ts +15 -0
  147. package/dist/services/httpStatus.d.ts.map +1 -1
  148. package/dist/services/httpStatus.js +15 -0
  149. package/dist/services/operationId.d.ts +10 -0
  150. package/dist/services/operationId.d.ts.map +1 -1
  151. package/dist/services/operationId.js +10 -0
  152. package/dist/services/random.d.ts +5 -0
  153. package/dist/services/random.d.ts.map +1 -1
  154. package/dist/services/random.js +5 -0
  155. package/dist/services/sharepointUrl.d.ts +6 -1
  156. package/dist/services/sharepointUrl.d.ts.map +1 -1
  157. package/dist/services/sharepointUrl.js +6 -1
  158. package/dist/services/site.d.ts +12 -1
  159. package/dist/services/site.d.ts.map +1 -1
  160. package/dist/services/site.js +12 -1
  161. package/dist/services/sleep.d.ts +5 -0
  162. package/dist/services/sleep.d.ts.map +1 -1
  163. package/dist/services/sleep.js +5 -0
  164. package/dist/services/stringCaseConversion.d.ts +5 -0
  165. package/dist/services/stringCaseConversion.d.ts.map +1 -1
  166. package/dist/services/stringCaseConversion.js +5 -0
  167. package/dist/services/templatedPaths.d.ts +7 -1
  168. package/dist/services/templatedPaths.d.ts.map +1 -1
  169. package/dist/services/templatedPaths.js +7 -1
  170. package/dist/services/temporaryFiles.d.ts +5 -0
  171. package/dist/services/temporaryFiles.d.ts.map +1 -1
  172. package/dist/services/temporaryFiles.js +5 -0
  173. package/dist/services/workbookRange.d.ts +6 -0
  174. package/dist/services/workbookRange.d.ts.map +1 -1
  175. package/dist/services/workbookRange.js +6 -0
  176. package/dist/services/workbookTable.d.ts +7 -0
  177. package/dist/services/workbookTable.d.ts.map +1 -1
  178. package/dist/services/workbookTable.js +7 -0
  179. package/dist/services/workbookWorksheet.d.ts +12 -0
  180. package/dist/services/workbookWorksheet.d.ts.map +1 -1
  181. package/dist/services/workbookWorksheet.js +12 -0
  182. package/dist/tasks/createWorkbookAndStartSession.d.ts +7 -1
  183. package/dist/tasks/createWorkbookAndStartSession.d.ts.map +1 -1
  184. package/dist/tasks/createWorkbookAndStartSession.js +7 -1
  185. package/dist/tasks/deleteDriveItemWithRetry.d.ts +6 -1
  186. package/dist/tasks/deleteDriveItemWithRetry.d.ts.map +1 -1
  187. package/dist/tasks/deleteDriveItemWithRetry.js +6 -1
  188. package/dist/tasks/downloadDriveItemContent.d.ts +7 -1
  189. package/dist/tasks/downloadDriveItemContent.d.ts.map +1 -1
  190. package/dist/tasks/downloadDriveItemContent.js +7 -1
  191. package/dist/tasks/getRangeLastUsedCell.d.ts +7 -1
  192. package/dist/tasks/getRangeLastUsedCell.d.ts.map +1 -1
  193. package/dist/tasks/getRangeLastUsedCell.js +7 -1
  194. package/dist/tasks/getWorkbookTableVisibleBody.d.ts +6 -1
  195. package/dist/tasks/getWorkbookTableVisibleBody.d.ts.map +1 -1
  196. package/dist/tasks/getWorkbookTableVisibleBody.js +6 -1
  197. package/dist/tasks/getWorkbookWorksheetByName.d.ts +8 -1
  198. package/dist/tasks/getWorkbookWorksheetByName.d.ts.map +1 -1
  199. package/dist/tasks/getWorkbookWorksheetByName.js +8 -1
  200. package/dist/tasks/safeDeleteWorkbook.d.ts +7 -1
  201. package/dist/tasks/safeDeleteWorkbook.d.ts.map +1 -1
  202. package/dist/tasks/safeDeleteWorkbook.js +7 -1
  203. package/dist/tasks/setColumnHidden.d.ts +7 -1
  204. package/dist/tasks/setColumnHidden.d.ts.map +1 -1
  205. package/dist/tasks/setColumnHidden.js +7 -1
  206. package/dist/tasks/setRowHidden.d.ts +7 -1
  207. package/dist/tasks/setRowHidden.d.ts.map +1 -1
  208. package/dist/tasks/setRowHidden.js +7 -1
  209. package/dist/tasks/setWorkbookTableBodyVisibleRows.d.ts +9 -1
  210. package/dist/tasks/setWorkbookTableBodyVisibleRows.d.ts.map +1 -1
  211. package/dist/tasks/setWorkbookTableBodyVisibleRows.js +23 -16
  212. package/dist/tasks/setWorkbookTableBodyVisibleRows.test.js +2 -0
  213. package/package.json +1 -1
@@ -1 +1 @@
1
- {"version":3,"file":"site.d.ts","sourceRoot":"","sources":["../../src/services/site.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAIpD,wBAAgB,aAAa,CAAC,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CASzF;AAED,gGAAgG;AAChG,wBAAgB,iBAAiB,IAAI,OAAO,CAO3C"}
1
+ {"version":3,"file":"site.d.ts","sourceRoot":"","sources":["../../src/services/site.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAIpD;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CASzF;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,OAAO,CAO3C"}
@@ -1,6 +1,13 @@
1
1
  import ProtocolError from "../errors/ProtocolError.js";
2
2
  import { getDefaultContextRef } from "./context.js";
3
3
  import { getEnvironmentVariable } from "./environmentVariable.js";
4
+ /**
5
+ * Creates a reference to a site.
6
+ * @param contextRef - The reference to the context.
7
+ * @param siteId - The ID of the site.
8
+ * @returns A reference to the site.
9
+ * @throws ProtocolError if the site ID is missing.
10
+ */
4
11
  export function createSiteRef(contextRef, siteId) {
5
12
  if (!siteId) {
6
13
  throw new ProtocolError("SiteID is missing");
@@ -10,7 +17,11 @@ export function createSiteRef(contextRef, siteId) {
10
17
  siteId,
11
18
  };
12
19
  }
13
- /** Opinionated method of getting default site reference. Not recommended for production use. */
20
+ /**
21
+ * Retrieves the opinionated default site reference. NOT RECOMMENDED FOR PRODUCTION USE
22
+ * @returns A reference to the default site.
23
+ * @remarks This method is opinionated and not recommended for production use.
24
+ */
14
25
  export function getDefaultSiteRef() {
15
26
  const contextRef = getDefaultContextRef();
16
27
  const siteId = getEnvironmentVariable("SHAREPOINT_DEFAULT_SITE_ID");
@@ -1,2 +1,7 @@
1
+ /**
2
+ * Pauses execution for the specified number of milliseconds.
3
+ * @param ms - The number of milliseconds to sleep.
4
+ * @returns A promise that resolves after the specified time.
5
+ */
1
6
  export declare function sleep(ms: number): Promise<void>;
2
7
  //# sourceMappingURL=sleep.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"sleep.d.ts","sourceRoot":"","sources":["../../src/services/sleep.ts"],"names":[],"mappings":"AAAA,wBAAgB,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAE/C"}
1
+ {"version":3,"file":"sleep.d.ts","sourceRoot":"","sources":["../../src/services/sleep.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,wBAAgB,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAE/C"}
@@ -1,3 +1,8 @@
1
+ /**
2
+ * Pauses execution for the specified number of milliseconds.
3
+ * @param ms - The number of milliseconds to sleep.
4
+ * @returns A promise that resolves after the specified time.
5
+ */
1
6
  export function sleep(ms) {
2
7
  return new Promise((resolve) => setTimeout(resolve, ms));
3
8
  }
@@ -1,2 +1,7 @@
1
+ /**
2
+ * Converts a kebab-case string to camelCase.
3
+ * @param str - The kebab-case string.
4
+ * @returns The camelCase string.
5
+ */
1
6
  export declare function kebabToCamelCase(str: string): string;
2
7
  //# sourceMappingURL=stringCaseConversion.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"stringCaseConversion.d.ts","sourceRoot":"","sources":["../../src/services/stringCaseConversion.ts"],"names":[],"mappings":"AAAA,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAIpD"}
1
+ {"version":3,"file":"stringCaseConversion.d.ts","sourceRoot":"","sources":["../../src/services/stringCaseConversion.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAIpD"}
@@ -1,3 +1,8 @@
1
+ /**
2
+ * Converts a kebab-case string to camelCase.
3
+ * @param str - The kebab-case string.
4
+ * @returns The camelCase string.
5
+ */
1
6
  export function kebabToCamelCase(str) {
2
7
  return str
3
8
  .replace(/^-+|-+$/g, "") // Remove leading and trailing dashes
@@ -1,4 +1,10 @@
1
1
  import type { GraphPath } from "../models/GraphOperation.ts";
2
- /** Create a GraphAPI path based on a given template and arguments. Escaping is automatically handeld */
2
+ /**
3
+ * Generates a HTTP path based on a template and arguments. Arguments are automatically escaped.
4
+ * @param template - The path template, which must start with a slash.
5
+ * @param args - A record of arguments to replace placeholders in the template.
6
+ * @returns The generated Graph API path.
7
+ * @throws BadTemplateError if the template is invalid or required arguments are missing.
8
+ */
3
9
  export declare function generatePath(template: string, args: Record<string, string | undefined>): GraphPath;
4
10
  //# sourceMappingURL=templatedPaths.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"templatedPaths.d.ts","sourceRoot":"","sources":["../../src/services/templatedPaths.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AAK7D,wGAAwG;AACxG,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS,CAgBlG"}
1
+ {"version":3,"file":"templatedPaths.d.ts","sourceRoot":"","sources":["../../src/services/templatedPaths.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AAK7D;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS,CAgBlG"}
@@ -1,7 +1,13 @@
1
1
  import BadTemplateError from "../errors/BadTemplateError.js";
2
2
  import { kebabToCamelCase } from "./stringCaseConversion.js";
3
3
  const argumentPattern = /\{([a-z-]+)\}/g;
4
- /** Create a GraphAPI path based on a given template and arguments. Escaping is automatically handeld */
4
+ /**
5
+ * Generates a HTTP path based on a template and arguments. Arguments are automatically escaped.
6
+ * @param template - The path template, which must start with a slash.
7
+ * @param args - A record of arguments to replace placeholders in the template.
8
+ * @returns The generated Graph API path.
9
+ * @throws BadTemplateError if the template is invalid or required arguments are missing.
10
+ */
5
11
  export function generatePath(template, args) {
6
12
  if (!template.startsWith("/")) {
7
13
  throw new BadTemplateError(`Path template '${template}' must start with a slash.`);
@@ -1,3 +1,8 @@
1
1
  import type { DriveItemPath } from "../models/DriveItemPath.ts";
2
+ /**
3
+ * Generates a temporary file name with the specified extension.
4
+ * @param extension - The file extension. Defaults to "tmp".
5
+ * @returns A temporary file name.
6
+ */
2
7
  export declare function generateTempFileName(extension?: string | null): DriveItemPath;
3
8
  //# sourceMappingURL=temporaryFiles.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"temporaryFiles.d.ts","sourceRoot":"","sources":["../../src/services/temporaryFiles.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAGhE,wBAAgB,oBAAoB,CAAC,SAAS,GAAE,MAAM,GAAG,IAAY,GAAG,aAAa,CAGpF"}
1
+ {"version":3,"file":"temporaryFiles.d.ts","sourceRoot":"","sources":["../../src/services/temporaryFiles.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAGhE;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,SAAS,GAAE,MAAM,GAAG,IAAY,GAAG,aAAa,CAGpF"}
@@ -1,4 +1,9 @@
1
1
  import { generateRandomString } from "./random.js";
2
+ /**
3
+ * Generates a temporary file name with the specified extension.
4
+ * @param extension - The file extension. Defaults to "tmp".
5
+ * @returns A temporary file name.
6
+ */
2
7
  export function generateTempFileName(extension = "tmp") {
3
8
  const body = generateRandomString(16);
4
9
  return `~${body}.${extension}`;
@@ -1,5 +1,11 @@
1
1
  import type { Address } from "../models/Address.ts";
2
2
  import type { WorkbookRangeRef } from "../models/WorkbookRangeRef.ts";
3
3
  import type { WorkbookWorksheetRef } from "../models/WorkbookWorksheetRef.ts";
4
+ /**
5
+ * Creates a reference to a workbook range.
6
+ * @param worksheetRef - The reference to the worksheet containing the range.
7
+ * @param address - The address of the range.
8
+ * @returns A reference to the workbook range.
9
+ */
4
10
  export declare function createWorkbookRangeRef(worksheetRef: WorkbookWorksheetRef, address: Address): WorkbookRangeRef;
5
11
  //# sourceMappingURL=workbookRange.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"workbookRange.d.ts","sourceRoot":"","sources":["../../src/services/workbookRange.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACtE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAE9E,wBAAgB,sBAAsB,CAAC,YAAY,EAAE,oBAAoB,EAAE,OAAO,EAAE,OAAO,GAAG,gBAAgB,CAU7G"}
1
+ {"version":3,"file":"workbookRange.d.ts","sourceRoot":"","sources":["../../src/services/workbookRange.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACtE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAE9E;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,YAAY,EAAE,oBAAoB,EAAE,OAAO,EAAE,OAAO,GAAG,gBAAgB,CAU7G"}
@@ -1,3 +1,9 @@
1
+ /**
2
+ * Creates a reference to a workbook range.
3
+ * @param worksheetRef - The reference to the worksheet containing the range.
4
+ * @param address - The address of the range.
5
+ * @returns A reference to the workbook range.
6
+ */
1
7
  export function createWorkbookRangeRef(worksheetRef, address) {
2
8
  return {
3
9
  contextId: worksheetRef.contextId,
@@ -1,5 +1,12 @@
1
1
  import type { WorkbookTableId } from "../models/WorkbookTableId.ts";
2
2
  import type { WorkbookTableRef } from "../models/WorkbookTableRef.ts";
3
3
  import type { WorkbookWorksheetRef } from "../models/WorkbookWorksheetRef.ts";
4
+ /**
5
+ * Creates a reference to a workbook table.
6
+ * @param worksheetRef - The reference to the worksheet containing the table.
7
+ * @param tableId - The ID of the table.
8
+ * @returns A reference to the workbook table.
9
+ * @throws Error if the table ID is missing.
10
+ */
4
11
  export declare function createWorkbookTableRef(worksheetRef: WorkbookWorksheetRef, tableId: WorkbookTableId | undefined): WorkbookTableRef;
5
12
  //# sourceMappingURL=workbookTable.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"workbookTable.d.ts","sourceRoot":"","sources":["../../src/services/workbookTable.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACtE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAE9E,wBAAgB,sBAAsB,CAAC,YAAY,EAAE,oBAAoB,EAAE,OAAO,EAAE,eAAe,GAAG,SAAS,GAAG,gBAAgB,CAajI"}
1
+ {"version":3,"file":"workbookTable.d.ts","sourceRoot":"","sources":["../../src/services/workbookTable.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACtE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAE9E;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,YAAY,EAAE,oBAAoB,EAAE,OAAO,EAAE,eAAe,GAAG,SAAS,GAAG,gBAAgB,CAcjI"}
@@ -1,3 +1,10 @@
1
+ /**
2
+ * Creates a reference to a workbook table.
3
+ * @param worksheetRef - The reference to the worksheet containing the table.
4
+ * @param tableId - The ID of the table.
5
+ * @returns A reference to the workbook table.
6
+ * @throws Error if the table ID is missing.
7
+ */
1
8
  export function createWorkbookTableRef(worksheetRef, tableId) {
2
9
  if (!tableId) {
3
10
  throw new Error("TableId is missing");
@@ -2,6 +2,18 @@ import type { WorkbookRef } from "../models/WorkbookRef.ts";
2
2
  import type { WorkbookWorksheetId } from "../models/WorkbookWorksheetId.ts";
3
3
  import type { WorkbookWorksheetRef } from "../models/WorkbookWorksheetRef.ts";
4
4
  export declare const defaultWorkbookWorksheetId: WorkbookWorksheetId;
5
+ /**
6
+ * Creates a reference to a workbook worksheet.
7
+ * @param workbookRef - The reference to the workbook.
8
+ * @param worksheetId - The ID of the worksheet.
9
+ * @returns A reference to the workbook worksheet.
10
+ * @throws Error if the worksheet ID is missing.
11
+ */
5
12
  export declare function createWorkbookWorksheetRef(workbookRef: WorkbookRef, worksheetId: WorkbookWorksheetId | undefined): WorkbookWorksheetRef;
13
+ /**
14
+ * Creates a reference to the default workbook worksheet that is initially included in all new workbooks.
15
+ * @param workbookRef - The reference to the workbook.
16
+ * @returns A reference to the default workbook worksheet.
17
+ */
6
18
  export declare function createDefaultWorkbookWorksheetRef(workbookRef: WorkbookRef): WorkbookWorksheetRef;
7
19
  //# sourceMappingURL=workbookWorksheet.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"workbookWorksheet.d.ts","sourceRoot":"","sources":["../../src/services/workbookWorksheet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAC5E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAE9E,eAAO,MAAM,0BAA0B,EAA+C,mBAAmB,CAAC;AAE1G,wBAAgB,0BAA0B,CAAC,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,mBAAmB,GAAG,SAAS,GAAG,oBAAoB,CAavI;AAED,wBAAgB,iCAAiC,CAAC,WAAW,EAAE,WAAW,GAAG,oBAAoB,CAEhG"}
1
+ {"version":3,"file":"workbookWorksheet.d.ts","sourceRoot":"","sources":["../../src/services/workbookWorksheet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAC5E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAE9E,eAAO,MAAM,0BAA0B,EAA+C,mBAAmB,CAAC;AAE1G;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CAAC,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,mBAAmB,GAAG,SAAS,GAAG,oBAAoB,CAavI;AAED;;;;GAIG;AACH,wBAAgB,iCAAiC,CAAC,WAAW,EAAE,WAAW,GAAG,oBAAoB,CAEhG"}
@@ -1,4 +1,11 @@
1
1
  export const defaultWorkbookWorksheetId = "{00000000-0001-0000-0000-000000000000}"; // Program Manager in Microsoft Office Extensibility team says this ID is used for the first sheet of all workbooks by design, but not documented. https://github.com/OfficeDev/office-js/issues/552#issuecomment-800841930
2
+ /**
3
+ * Creates a reference to a workbook worksheet.
4
+ * @param workbookRef - The reference to the workbook.
5
+ * @param worksheetId - The ID of the worksheet.
6
+ * @returns A reference to the workbook worksheet.
7
+ * @throws Error if the worksheet ID is missing.
8
+ */
2
9
  export function createWorkbookWorksheetRef(workbookRef, worksheetId) {
3
10
  if (!worksheetId) {
4
11
  throw new Error("WorksheetID is missing");
@@ -12,6 +19,11 @@ export function createWorkbookWorksheetRef(workbookRef, worksheetId) {
12
19
  worksheetId,
13
20
  };
14
21
  }
22
+ /**
23
+ * Creates a reference to the default workbook worksheet that is initially included in all new workbooks.
24
+ * @param workbookRef - The reference to the workbook.
25
+ * @returns A reference to the default workbook worksheet.
26
+ */
15
27
  export function createDefaultWorkbookWorksheetRef(workbookRef) {
16
28
  return createWorkbookWorksheetRef(workbookRef, defaultWorkbookWorksheetId);
17
29
  }
@@ -2,6 +2,12 @@ import type { Workbook } from "@microsoft/microsoft-graph-types";
2
2
  import type { DriveItemPath } from "../models/DriveItemPath.ts";
3
3
  import type { DriveRef } from "../models/DriveRef.ts";
4
4
  import type { WorkbookRef } from "../models/WorkbookRef.ts";
5
- /** One-shot creation of a new workbook and opening a session for that workbook. */
5
+ /**
6
+ * Create a new workbook and open a session for that workbook in a single operation.
7
+ *
8
+ * @param driveRef - A reference to the drive where the workbook will be created.
9
+ * @param itemPath - The path of the new workbook within the drive.
10
+ * @returns The created workbook and session details.
11
+ */
6
12
  export default function createWorkbookAndStartSession(driveRef: DriveRef, itemPath: DriveItemPath): Promise<Workbook & WorkbookRef>;
7
13
  //# sourceMappingURL=createWorkbookAndStartSession.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"createWorkbookAndStartSession.d.ts","sourceRoot":"","sources":["../../src/tasks/createWorkbookAndStartSession.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAI5D,mFAAmF;AACnF,wBAA8B,6BAA6B,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,aAAa,GAAG,OAAO,CAAC,QAAQ,GAAG,WAAW,CAAC,CAQxI"}
1
+ {"version":3,"file":"createWorkbookAndStartSession.d.ts","sourceRoot":"","sources":["../../src/tasks/createWorkbookAndStartSession.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAI5D;;;;;;GAMG;AACH,wBAA8B,6BAA6B,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,aAAa,GAAG,OAAO,CAAC,QAAQ,GAAG,WAAW,CAAC,CAQxI"}
@@ -1,6 +1,12 @@
1
1
  import createWorkbook from "../operations/workbook/createWorkbook.js";
2
2
  import createWorkbookSession from "../operations/workbookSession/createWorkbookSession.js";
3
- /** One-shot creation of a new workbook and opening a session for that workbook. */
3
+ /**
4
+ * Create a new workbook and open a session for that workbook in a single operation.
5
+ *
6
+ * @param driveRef - A reference to the drive where the workbook will be created.
7
+ * @param itemPath - The path of the new workbook within the drive.
8
+ * @returns The created workbook and session details.
9
+ */
4
10
  export default async function createWorkbookAndStartSession(driveRef, itemPath) {
5
11
  const workbook = await createWorkbook(driveRef, itemPath);
6
12
  const workbookRef = await createWorkbookSession(workbook);
@@ -1,4 +1,9 @@
1
1
  import type { DriveItemRef } from "../models/DriveItemRef.ts";
2
- /** Delete an item, avoiding locking issues through automatically retrying. */
2
+ /**
3
+ * Delete a DriveItem, avoiding locking issues through automatic retries.
4
+ *
5
+ * @param driveItemRef - A reference to the DriveItem to delete.
6
+ * @returns Void when the DriveItem is successfully deleted.
7
+ */
3
8
  export default function deleteDriveItemWithRetry(driveItemRef: DriveItemRef): Promise<void>;
4
9
  //# sourceMappingURL=deleteDriveItemWithRetry.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"deleteDriveItemWithRetry.d.ts","sourceRoot":"","sources":["../../src/tasks/deleteDriveItemWithRetry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAI9D,8EAA8E;AAC9E,wBAA8B,wBAAwB,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAahG"}
1
+ {"version":3,"file":"deleteDriveItemWithRetry.d.ts","sourceRoot":"","sources":["../../src/tasks/deleteDriveItemWithRetry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAI9D;;;;;GAKG;AACH,wBAA8B,wBAAwB,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAahG"}
@@ -1,6 +1,11 @@
1
1
  import deleteDriveItem from "../operations/driveItem/deleteDriveItem.js";
2
2
  import { sleep } from "../services/sleep.js";
3
- /** Delete an item, avoiding locking issues through automatically retrying. */
3
+ /**
4
+ * Delete a DriveItem, avoiding locking issues through automatic retries.
5
+ *
6
+ * @param driveItemRef - A reference to the DriveItem to delete.
7
+ * @returns Void when the DriveItem is successfully deleted.
8
+ */
4
9
  export default async function deleteDriveItemWithRetry(driveItemRef) {
5
10
  const retryDelays = [1000, 2000, 4000];
6
11
  for (const delay of retryDelays) {
@@ -1,4 +1,10 @@
1
1
  import type { DriveItemRef } from "../models/DriveItemRef.ts";
2
- /** Download a DriveItem and save it as a local file. */
2
+ /**
3
+ * Download a DriveItem and save it as a local file.
4
+ *
5
+ * @param itemRef - A reference to the DriveItem to download.
6
+ * @param localFilePath - The local file path where the content should be saved.
7
+ * @returns Void when the content is successfully downloaded and saved.
8
+ */
3
9
  export default function downloadDriveItemContent(itemRef: DriveItemRef, localFilePath: string): Promise<void>;
4
10
  //# sourceMappingURL=downloadDriveItemContent.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"downloadDriveItemContent.d.ts","sourceRoot":"","sources":["../../src/tasks/downloadDriveItemContent.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAG9D,wDAAwD;AACxD,wBAA8B,wBAAwB,CAAC,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAKlH"}
1
+ {"version":3,"file":"downloadDriveItemContent.d.ts","sourceRoot":"","sources":["../../src/tasks/downloadDriveItemContent.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAG9D;;;;;;GAMG;AACH,wBAA8B,wBAAwB,CAAC,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAKlH"}
@@ -1,6 +1,12 @@
1
1
  import { writeFile } from "node:fs/promises";
2
2
  import getDriveItemContent from "../operations/driveItem/getDriveItemContent.js";
3
- /** Download a DriveItem and save it as a local file. */
3
+ /**
4
+ * Download a DriveItem and save it as a local file.
5
+ *
6
+ * @param itemRef - A reference to the DriveItem to download.
7
+ * @param localFilePath - The local file path where the content should be saved.
8
+ * @returns Void when the content is successfully downloaded and saved.
9
+ */
4
10
  export default async function downloadDriveItemContent(itemRef, localFilePath) {
5
11
  const arrayBuffer = await getDriveItemContent(itemRef);
6
12
  const buffer = Buffer.from(arrayBuffer);
@@ -1,5 +1,11 @@
1
1
  import type { WorkbookRangeRef } from "../models/WorkbookRangeRef.ts";
2
- /** Get the last used cell (ie, the most-lower-right) in a given range. */
2
+ /**
3
+ * Get the last used cell (i.e., the most lower-right cell) in a given range.
4
+ *
5
+ * @param rangeRef - A reference to the workbook range to search.
6
+ * @throws {ProtocolError} If the range's row or column counts, or values, are missing.
7
+ * @returns The last used cell's value and address, or `null` if no cells are used.
8
+ */
3
9
  export default function getRangeLastUsedCell(rangeRef: WorkbookRangeRef): Promise<{
4
10
  value: string | number | boolean | null;
5
11
  address: string;
@@ -1 +1 @@
1
- {"version":3,"file":"getRangeLastUsedCell.d.ts","sourceRoot":"","sources":["../../src/tasks/getRangeLastUsedCell.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAItE,0EAA0E;AAC1E,wBAA8B,oBAAoB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAC;IAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAAC,CAyC3J"}
1
+ {"version":3,"file":"getRangeLastUsedCell.d.ts","sourceRoot":"","sources":["../../src/tasks/getRangeLastUsedCell.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAItE;;;;;;GAMG;AACH,wBAA8B,oBAAoB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAC;IAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAAC,CAyC3J"}
@@ -1,7 +1,13 @@
1
1
  import ProtocolError from "../errors/ProtocolError.js";
2
2
  import getWorkbookWorksheetRange from "../operations/workbookRange/getWorkbookWorksheetRange.js";
3
3
  import { getFirstCellAddress, offsetAddress } from "../services/addressManipulation.js";
4
- /** Get the last used cell (ie, the most-lower-right) in a given range. */
4
+ /**
5
+ * Get the last used cell (i.e., the most lower-right cell) in a given range.
6
+ *
7
+ * @param rangeRef - A reference to the workbook range to search.
8
+ * @throws {ProtocolError} If the range's row or column counts, or values, are missing.
9
+ * @returns The last used cell's value and address, or `null` if no cells are used.
10
+ */
5
11
  export default async function getRangeLastUsedCell(rangeRef) {
6
12
  // TODO: Consider adding chunking if the range is too large
7
13
  // TODO: Reduce cells returned by using "used range"?
@@ -1,5 +1,10 @@
1
1
  import type { WorkbookRangeView } from "@microsoft/microsoft-graph-types";
2
2
  import type { WorkbookTableRef } from "../models/WorkbookTableRef.ts";
3
- /** Get the visible cells of a workbook table. Ie any hidden cells are omitted. */
3
+ /**
4
+ * Get the visible cells of a workbook table. Hidden cells are omitted.
5
+ *
6
+ * @param tableRef - A reference to the workbook table.
7
+ * @returns The visible range of the table.
8
+ */
4
9
  export declare function getWorkbookTableVisibleBody(tableRef: WorkbookTableRef): Promise<WorkbookRangeView>;
5
10
  //# sourceMappingURL=getWorkbookTableVisibleBody.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"getWorkbookTableVisibleBody.d.ts","sourceRoot":"","sources":["../../src/tasks/getWorkbookTableVisibleBody.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAC1E,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAItE,kFAAkF;AAClF,wBAAsB,2BAA2B,CAAC,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAKxG"}
1
+ {"version":3,"file":"getWorkbookTableVisibleBody.d.ts","sourceRoot":"","sources":["../../src/tasks/getWorkbookTableVisibleBody.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAC1E,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAItE;;;;;GAKG;AACH,wBAAsB,2BAA2B,CAAC,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAKxG"}
@@ -1,6 +1,11 @@
1
1
  import getWorkbookVisibleRange from "../operations/workbookRange/getWorkbookVisibleRange.js";
2
2
  import getWorkbookTableBodyRange from "../operations/workbookTable/getWorkbookTableBodyRange.js";
3
- /** Get the visible cells of a workbook table. Ie any hidden cells are omitted. */
3
+ /**
4
+ * Get the visible cells of a workbook table. Hidden cells are omitted.
5
+ *
6
+ * @param tableRef - A reference to the workbook table.
7
+ * @returns The visible range of the table.
8
+ */
4
9
  export async function getWorkbookTableVisibleBody(tableRef) {
5
10
  const range = await getWorkbookTableBodyRange(tableRef);
6
11
  const visibleRange = await getWorkbookVisibleRange(range);
@@ -1,6 +1,13 @@
1
1
  import type { WorkbookWorksheet } from "@microsoft/microsoft-graph-types";
2
2
  import type { WorkbookRef } from "../models/WorkbookRef.ts";
3
3
  import type { WorkbookWorksheetRef } from "../models/WorkbookWorksheetRef.ts";
4
- /** Get a worksheet by it's name. Throws error if not found. */
4
+ /**
5
+ * Get a worksheet by its name. Throws an error if not found.
6
+ *
7
+ * @param workbookRef - A reference to the workbook containing the worksheet.
8
+ * @param name - The name of the worksheet to retrieve.
9
+ * @throws {NotFoundError} If the worksheet with the specified name is not found.
10
+ * @returns The worksheet details.
11
+ */
5
12
  export default function getWorkbookWorksheetByName(workbookRef: WorkbookRef, name: string): Promise<WorkbookWorksheet & WorkbookWorksheetRef>;
6
13
  //# sourceMappingURL=getWorkbookWorksheetByName.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"getWorkbookWorksheetByName.d.ts","sourceRoot":"","sources":["../../src/tasks/getWorkbookWorksheetByName.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAE1E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAG9E,+DAA+D;AAC/D,wBAA8B,0BAA0B,CAAC,WAAW,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,GAAG,oBAAoB,CAAC,CAUlJ"}
1
+ {"version":3,"file":"getWorkbookWorksheetByName.d.ts","sourceRoot":"","sources":["../../src/tasks/getWorkbookWorksheetByName.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAE1E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAG9E;;;;;;;GAOG;AACH,wBAA8B,0BAA0B,CAAC,WAAW,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,GAAG,oBAAoB,CAAC,CAUlJ"}
@@ -1,6 +1,13 @@
1
1
  import NotFoundError from "../errors/NotFoundError.js";
2
2
  import listWorkbookWorksheets from "../operations/workbookWorksheet/listWorkbookWorksheets.js";
3
- /** Get a worksheet by it's name. Throws error if not found. */
3
+ /**
4
+ * Get a worksheet by its name. Throws an error if not found.
5
+ *
6
+ * @param workbookRef - A reference to the workbook containing the worksheet.
7
+ * @param name - The name of the worksheet to retrieve.
8
+ * @throws {NotFoundError} If the worksheet with the specified name is not found.
9
+ * @returns The worksheet details.
10
+ */
4
11
  export default async function getWorkbookWorksheetByName(workbookRef, name) {
5
12
  // TODO: More performant to get it by a direct call without listing all workbooks?
6
13
  const worksheets = await listWorkbookWorksheets(workbookRef);
@@ -1,4 +1,10 @@
1
1
  import type { WorkbookRef } from "../models/WorkbookRef.ts";
2
- /** Safely delete a workbook by first closing any open sessions and then delete with a back-off retry to allow for any outstanding locks to be closed. @see https://github.com/Future-Secure-AI/microsoft-graph/blob/main/docs/lockedWorkbook.md */
2
+ /**
3
+ * Safely delete a workbook by first closing any open sessions and then deleting it with a back-off retry to allow for any outstanding locks to be closed.
4
+ *
5
+ * @param workbookRef - A reference to the workbook to be deleted.
6
+ * @returns Void when the workbook is successfully deleted.
7
+ * @see https://github.com/Future-Secure-AI/microsoft-graph/blob/main/docs/lockedWorkbook.md
8
+ */
3
9
  export default function safeDeleteWorkbook(workbookRef: WorkbookRef): Promise<void>;
4
10
  //# sourceMappingURL=safeDeleteWorkbook.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"safeDeleteWorkbook.d.ts","sourceRoot":"","sources":["../../src/tasks/safeDeleteWorkbook.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAI5D,mPAAmP;AACnP,wBAA8B,kBAAkB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAKxF"}
1
+ {"version":3,"file":"safeDeleteWorkbook.d.ts","sourceRoot":"","sources":["../../src/tasks/safeDeleteWorkbook.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAI5D;;;;;;GAMG;AACH,wBAA8B,kBAAkB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAKxF"}
@@ -1,6 +1,12 @@
1
1
  import closeWorkbookSession from "../operations/workbookSession/closeWorkbookSession.js";
2
2
  import deleteDriveItemWithRetry from "./deleteDriveItemWithRetry.js";
3
- /** Safely delete a workbook by first closing any open sessions and then delete with a back-off retry to allow for any outstanding locks to be closed. @see https://github.com/Future-Secure-AI/microsoft-graph/blob/main/docs/lockedWorkbook.md */
3
+ /**
4
+ * Safely delete a workbook by first closing any open sessions and then deleting it with a back-off retry to allow for any outstanding locks to be closed.
5
+ *
6
+ * @param workbookRef - A reference to the workbook to be deleted.
7
+ * @returns Void when the workbook is successfully deleted.
8
+ * @see https://github.com/Future-Secure-AI/microsoft-graph/blob/main/docs/lockedWorkbook.md
9
+ */
4
10
  export default async function safeDeleteWorkbook(workbookRef) {
5
11
  if (workbookRef.sessionId) {
6
12
  await closeWorkbookSession(workbookRef);
@@ -1,5 +1,11 @@
1
1
  import type { WorkbookRange } from "@microsoft/microsoft-graph-types";
2
2
  import type { WorkbookRangeRef } from "../models/WorkbookRangeRef.ts";
3
- /** Hide or show one or more columns. */
3
+ /**
4
+ * Hide or show one or more columns.
5
+ *
6
+ * @param rangeRef - A reference to the workbook range representing the columns to hide or show.
7
+ * @param hidden - A boolean indicating whether to hide (`true`) or show (`false`) the columns.
8
+ * @returns The updated workbook range.
9
+ */
4
10
  export default function setColumnHidden(rangeRef: WorkbookRangeRef, hidden: boolean): Promise<WorkbookRange & WorkbookRangeRef>;
5
11
  //# sourceMappingURL=setColumnHidden.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"setColumnHidden.d.ts","sourceRoot":"","sources":["../../src/tasks/setColumnHidden.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAGtE,wCAAwC;AACxC,wBAA8B,eAAe,CAAC,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,GAAG,gBAAgB,CAAC,CAIpI"}
1
+ {"version":3,"file":"setColumnHidden.d.ts","sourceRoot":"","sources":["../../src/tasks/setColumnHidden.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAGtE;;;;;;GAMG;AACH,wBAA8B,eAAe,CAAC,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,GAAG,gBAAgB,CAAC,CAIpI"}
@@ -1,5 +1,11 @@
1
1
  import updateWorkbookRange from "../operations/workbookRange/updateWorkbookRange.js";
2
- /** Hide or show one or more columns. */
2
+ /**
3
+ * Hide or show one or more columns.
4
+ *
5
+ * @param rangeRef - A reference to the workbook range representing the columns to hide or show.
6
+ * @param hidden - A boolean indicating whether to hide (`true`) or show (`false`) the columns.
7
+ * @returns The updated workbook range.
8
+ */
3
9
  export default async function setColumnHidden(rangeRef, hidden) {
4
10
  return await updateWorkbookRange(rangeRef, {
5
11
  columnHidden: hidden,
@@ -1,5 +1,11 @@
1
1
  import type { WorkbookRange } from "@microsoft/microsoft-graph-types";
2
2
  import type { WorkbookRangeRef } from "../models/WorkbookRangeRef.ts";
3
- /** Hide or show one or more rows. */
3
+ /**
4
+ * Hide or show one or more rows.
5
+ *
6
+ * @param rangeRef - A reference to the workbook range representing the rows to hide or show.
7
+ * @param hidden - A boolean indicating whether to hide (`true`) or show (`false`) the rows.
8
+ * @returns The updated workbook range.
9
+ */
4
10
  export default function setRowHidden(rangeRef: WorkbookRangeRef, hidden: boolean): Promise<WorkbookRange & WorkbookRangeRef>;
5
11
  //# sourceMappingURL=setRowHidden.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"setRowHidden.d.ts","sourceRoot":"","sources":["../../src/tasks/setRowHidden.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAGtE,qCAAqC;AACrC,wBAA8B,YAAY,CAAC,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,GAAG,gBAAgB,CAAC,CAIjI"}
1
+ {"version":3,"file":"setRowHidden.d.ts","sourceRoot":"","sources":["../../src/tasks/setRowHidden.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAGtE;;;;;;GAMG;AACH,wBAA8B,YAAY,CAAC,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,GAAG,gBAAgB,CAAC,CAIjI"}
@@ -1,5 +1,11 @@
1
1
  import updateWorkbookRange from "../operations/workbookRange/updateWorkbookRange.js";
2
- /** Hide or show one or more rows. */
2
+ /**
3
+ * Hide or show one or more rows.
4
+ *
5
+ * @param rangeRef - A reference to the workbook range representing the rows to hide or show.
6
+ * @param hidden - A boolean indicating whether to hide (`true`) or show (`false`) the rows.
7
+ * @returns The updated workbook range.
8
+ */
3
9
  export default async function setRowHidden(rangeRef, hidden) {
4
10
  return await updateWorkbookRange(rangeRef, {
5
11
  rowHidden: hidden,
@@ -1,4 +1,12 @@
1
1
  import type { WorkbookTableRef } from "../models/WorkbookTableRef.ts";
2
- /** Overwrite visible rows of a workbook table with the provided 2D array of values, inserting new rows at the end if needed. THIS IS SLOW as it must check each rows visibility. */
2
+ /**
3
+ * Overwrite visible rows of a workbook table with the provided 2D array of values, inserting new rows at the end if needed.
4
+ * THIS IS SLOW as it must check each row's visibility.
5
+ *
6
+ * @param tableRef - A reference to the workbook table.
7
+ * @param values - A 2D array of strings representing the values to set in the visible rows of the table.
8
+ * @throws {InvalidArgumentError} If the number of columns in any row of `values` does not match the table's column count.
9
+ * @returns Void when the operation is complete.
10
+ */
3
11
  export declare function setWorkbookTableBodyVisibleRows(tableRef: WorkbookTableRef, values: string[][]): Promise<void>;
4
12
  //# sourceMappingURL=setWorkbookTableBodyVisibleRows.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"setWorkbookTableBodyVisibleRows.d.ts","sourceRoot":"","sources":["../../src/tasks/setWorkbookTableBodyVisibleRows.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAQtE,oLAAoL;AACpL,wBAAsB,+BAA+B,CAAC,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CA6BnH"}
1
+ {"version":3,"file":"setWorkbookTableBodyVisibleRows.d.ts","sourceRoot":"","sources":["../../src/tasks/setWorkbookTableBodyVisibleRows.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAQtE;;;;;;;;GAQG;AACH,wBAAsB,+BAA+B,CAAC,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CA4BnH"}