@pnp/sp 4.0.0-alpha0-v4nightly.20240108 → 4.0.0-alpha0-v4nightly.20240110

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 (610) hide show
  1. package/commonjs/appcatalog/index.d.ts +11 -0
  2. package/commonjs/appcatalog/index.d.ts.map +1 -0
  3. package/commonjs/appcatalog/index.js +22 -0
  4. package/commonjs/appcatalog/index.js.map +1 -0
  5. package/commonjs/appcatalog/types.d.ts +79 -0
  6. package/commonjs/appcatalog/types.d.ts.map +1 -0
  7. package/commonjs/appcatalog/types.js +134 -0
  8. package/commonjs/appcatalog/types.js.map +1 -0
  9. package/commonjs/appcatalog/web.d.ts +13 -0
  10. package/commonjs/appcatalog/web.d.ts.map +1 -0
  11. package/commonjs/appcatalog/web.js +9 -0
  12. package/commonjs/appcatalog/web.js.map +1 -0
  13. package/commonjs/attachments/index.d.ts +3 -0
  14. package/commonjs/attachments/index.d.ts.map +1 -0
  15. package/commonjs/attachments/index.js +8 -0
  16. package/commonjs/attachments/index.js.map +1 -0
  17. package/commonjs/attachments/item.d.ts +13 -0
  18. package/commonjs/attachments/item.d.ts.map +1 -0
  19. package/commonjs/attachments/item.js +7 -0
  20. package/commonjs/attachments/item.js.map +1 -0
  21. package/commonjs/attachments/types.d.ts +57 -0
  22. package/commonjs/attachments/types.d.ts.map +1 -0
  23. package/commonjs/attachments/types.js +68 -0
  24. package/commonjs/attachments/types.js.map +1 -0
  25. package/commonjs/batching.d.ts +45 -0
  26. package/commonjs/batching.d.ts.map +1 -0
  27. package/commonjs/batching.js +355 -0
  28. package/commonjs/batching.js.map +1 -0
  29. package/commonjs/behaviors/defaults.d.ts +5 -0
  30. package/commonjs/behaviors/defaults.d.ts.map +1 -0
  31. package/commonjs/behaviors/defaults.js +29 -0
  32. package/commonjs/behaviors/defaults.js.map +1 -0
  33. package/commonjs/behaviors/request-digest.d.ts +9 -0
  34. package/commonjs/behaviors/request-digest.d.ts.map +1 -0
  35. package/commonjs/behaviors/request-digest.js +59 -0
  36. package/commonjs/behaviors/request-digest.js.map +1 -0
  37. package/commonjs/behaviors/spbrowser.d.ts +7 -0
  38. package/commonjs/behaviors/spbrowser.d.ts.map +1 -0
  39. package/commonjs/behaviors/spbrowser.js +27 -0
  40. package/commonjs/behaviors/spbrowser.js.map +1 -0
  41. package/commonjs/behaviors/spfx.d.ts +21 -0
  42. package/commonjs/behaviors/spfx.d.ts.map +1 -0
  43. package/commonjs/behaviors/spfx.js +62 -0
  44. package/commonjs/behaviors/spfx.js.map +1 -0
  45. package/commonjs/behaviors/telemetry.d.ts +4 -0
  46. package/commonjs/behaviors/telemetry.d.ts.map +1 -0
  47. package/commonjs/behaviors/telemetry.js +27 -0
  48. package/commonjs/behaviors/telemetry.js.map +1 -0
  49. package/commonjs/clientside-pages/funcs.d.ts +23 -0
  50. package/commonjs/clientside-pages/funcs.d.ts.map +1 -0
  51. package/commonjs/clientside-pages/funcs.js +31 -0
  52. package/commonjs/clientside-pages/funcs.js.map +1 -0
  53. package/commonjs/clientside-pages/index.d.ts +3 -0
  54. package/commonjs/clientside-pages/index.d.ts.map +1 -0
  55. package/commonjs/clientside-pages/index.js +14 -0
  56. package/commonjs/clientside-pages/index.js.map +1 -0
  57. package/commonjs/clientside-pages/types.d.ts +495 -0
  58. package/commonjs/clientside-pages/types.d.ts.map +1 -0
  59. package/commonjs/clientside-pages/types.js +1155 -0
  60. package/commonjs/clientside-pages/types.js.map +1 -0
  61. package/commonjs/clientside-pages/web.d.ts +42 -0
  62. package/commonjs/clientside-pages/web.d.ts.map +1 -0
  63. package/commonjs/clientside-pages/web.js +33 -0
  64. package/commonjs/clientside-pages/web.js.map +1 -0
  65. package/commonjs/column-defaults/folder.d.ts +28 -0
  66. package/commonjs/column-defaults/folder.d.ts.map +1 -0
  67. package/commonjs/column-defaults/folder.js +50 -0
  68. package/commonjs/column-defaults/folder.js.map +1 -0
  69. package/commonjs/column-defaults/index.d.ts +4 -0
  70. package/commonjs/column-defaults/index.d.ts.map +1 -0
  71. package/commonjs/column-defaults/index.js +5 -0
  72. package/commonjs/column-defaults/index.js.map +1 -0
  73. package/commonjs/column-defaults/list.d.ts +20 -0
  74. package/commonjs/column-defaults/list.d.ts.map +1 -0
  75. package/commonjs/column-defaults/list.js +171 -0
  76. package/commonjs/column-defaults/list.js.map +1 -0
  77. package/commonjs/column-defaults/types.d.ts +22 -0
  78. package/commonjs/column-defaults/types.d.ts.map +1 -0
  79. package/commonjs/column-defaults/types.js +3 -0
  80. package/commonjs/column-defaults/types.js.map +1 -0
  81. package/commonjs/comments/clientside-page.d.ts +58 -0
  82. package/commonjs/comments/clientside-page.d.ts.map +1 -0
  83. package/commonjs/comments/clientside-page.js +51 -0
  84. package/commonjs/comments/clientside-page.js.map +1 -0
  85. package/commonjs/comments/index.d.ts +3 -0
  86. package/commonjs/comments/index.d.ts.map +1 -0
  87. package/commonjs/comments/index.js +9 -0
  88. package/commonjs/comments/index.js.map +1 -0
  89. package/commonjs/comments/item.d.ts +37 -0
  90. package/commonjs/comments/item.d.ts.map +1 -0
  91. package/commonjs/comments/item.js +37 -0
  92. package/commonjs/comments/item.js.map +1 -0
  93. package/commonjs/comments/types.d.ts +111 -0
  94. package/commonjs/comments/types.d.ts.map +1 -0
  95. package/commonjs/comments/types.js +89 -0
  96. package/commonjs/comments/types.js.map +1 -0
  97. package/commonjs/content-types/index.d.ts +5 -0
  98. package/commonjs/content-types/index.d.ts.map +1 -0
  99. package/commonjs/content-types/index.js +12 -0
  100. package/commonjs/content-types/index.js.map +1 -0
  101. package/commonjs/content-types/item.d.ts +13 -0
  102. package/commonjs/content-types/item.d.ts.map +1 -0
  103. package/commonjs/content-types/item.js +7 -0
  104. package/commonjs/content-types/item.js.map +1 -0
  105. package/commonjs/content-types/list.d.ts +13 -0
  106. package/commonjs/content-types/list.d.ts.map +1 -0
  107. package/commonjs/content-types/list.js +7 -0
  108. package/commonjs/content-types/list.js.map +1 -0
  109. package/commonjs/content-types/types.d.ts +120 -0
  110. package/commonjs/content-types/types.d.ts.map +1 -0
  111. package/commonjs/content-types/types.js +115 -0
  112. package/commonjs/content-types/types.js.map +1 -0
  113. package/commonjs/content-types/web.d.ts +13 -0
  114. package/commonjs/content-types/web.d.ts.map +1 -0
  115. package/commonjs/content-types/web.js +7 -0
  116. package/commonjs/content-types/web.js.map +1 -0
  117. package/commonjs/context-info/index.d.ts +22 -0
  118. package/commonjs/context-info/index.d.ts.map +1 -0
  119. package/commonjs/context-info/index.js +17 -0
  120. package/commonjs/context-info/index.js.map +1 -0
  121. package/commonjs/decorators.d.ts +9 -0
  122. package/commonjs/decorators.d.ts.map +1 -0
  123. package/commonjs/decorators.js +20 -0
  124. package/commonjs/decorators.js.map +1 -0
  125. package/commonjs/favorites/index.d.ts +11 -0
  126. package/commonjs/favorites/index.d.ts.map +1 -0
  127. package/commonjs/favorites/index.js +15 -0
  128. package/commonjs/favorites/index.js.map +1 -0
  129. package/commonjs/favorites/types.d.ts +113 -0
  130. package/commonjs/favorites/types.d.ts.map +1 -0
  131. package/commonjs/favorites/types.js +115 -0
  132. package/commonjs/favorites/types.js.map +1 -0
  133. package/commonjs/features/index.d.ts +4 -0
  134. package/commonjs/features/index.d.ts.map +1 -0
  135. package/commonjs/features/index.js +9 -0
  136. package/commonjs/features/index.js.map +1 -0
  137. package/commonjs/features/site.d.ts +13 -0
  138. package/commonjs/features/site.d.ts.map +1 -0
  139. package/commonjs/features/site.js +7 -0
  140. package/commonjs/features/site.js.map +1 -0
  141. package/commonjs/features/types.d.ts +42 -0
  142. package/commonjs/features/types.d.ts.map +1 -0
  143. package/commonjs/features/types.js +56 -0
  144. package/commonjs/features/types.js.map +1 -0
  145. package/commonjs/features/web.d.ts +13 -0
  146. package/commonjs/features/web.d.ts.map +1 -0
  147. package/commonjs/features/web.js +7 -0
  148. package/commonjs/features/web.js.map +1 -0
  149. package/commonjs/fi.d.ts +25 -0
  150. package/commonjs/fi.d.ts.map +1 -0
  151. package/commonjs/fi.js +40 -0
  152. package/commonjs/fi.js.map +1 -0
  153. package/commonjs/fields/index.d.ts +4 -0
  154. package/commonjs/fields/index.d.ts.map +1 -0
  155. package/commonjs/fields/index.js +17 -0
  156. package/commonjs/fields/index.js.map +1 -0
  157. package/commonjs/fields/list.d.ts +13 -0
  158. package/commonjs/fields/list.d.ts.map +1 -0
  159. package/commonjs/fields/list.js +7 -0
  160. package/commonjs/fields/list.js.map +1 -0
  161. package/commonjs/fields/types.d.ts +402 -0
  162. package/commonjs/fields/types.d.ts.map +1 -0
  163. package/commonjs/fields/types.js +459 -0
  164. package/commonjs/fields/types.js.map +1 -0
  165. package/commonjs/fields/web.d.ts +18 -0
  166. package/commonjs/fields/web.d.ts.map +1 -0
  167. package/commonjs/fields/web.js +8 -0
  168. package/commonjs/fields/web.js.map +1 -0
  169. package/commonjs/files/folder.d.ts +13 -0
  170. package/commonjs/files/folder.d.ts.map +1 -0
  171. package/commonjs/files/folder.js +7 -0
  172. package/commonjs/files/folder.js.map +1 -0
  173. package/commonjs/files/index.d.ts +5 -0
  174. package/commonjs/files/index.d.ts.map +1 -0
  175. package/commonjs/files/index.js +18 -0
  176. package/commonjs/files/index.js.map +1 -0
  177. package/commonjs/files/item.d.ts +13 -0
  178. package/commonjs/files/item.d.ts.map +1 -0
  179. package/commonjs/files/item.js +7 -0
  180. package/commonjs/files/item.js.map +1 -0
  181. package/commonjs/files/readable-file.d.ts +23 -0
  182. package/commonjs/files/readable-file.d.ts.map +1 -0
  183. package/commonjs/files/readable-file.js +38 -0
  184. package/commonjs/files/readable-file.js.map +1 -0
  185. package/commonjs/files/types.d.ts +451 -0
  186. package/commonjs/files/types.d.ts.map +1 -0
  187. package/commonjs/files/types.js +589 -0
  188. package/commonjs/files/types.js.map +1 -0
  189. package/commonjs/files/web.d.ts +29 -0
  190. package/commonjs/files/web.d.ts.map +1 -0
  191. package/commonjs/files/web.js +15 -0
  192. package/commonjs/files/web.js.map +1 -0
  193. package/commonjs/folders/index.d.ts +5 -0
  194. package/commonjs/folders/index.d.ts.map +1 -0
  195. package/commonjs/folders/index.js +13 -0
  196. package/commonjs/folders/index.js.map +1 -0
  197. package/commonjs/folders/item.d.ts +10 -0
  198. package/commonjs/folders/item.d.ts.map +1 -0
  199. package/commonjs/folders/item.js +7 -0
  200. package/commonjs/folders/item.js.map +1 -0
  201. package/commonjs/folders/list.d.ts +13 -0
  202. package/commonjs/folders/list.d.ts.map +1 -0
  203. package/commonjs/folders/list.js +7 -0
  204. package/commonjs/folders/list.js.map +1 -0
  205. package/commonjs/folders/types.d.ts +237 -0
  206. package/commonjs/folders/types.d.ts.map +1 -0
  207. package/commonjs/folders/types.js +253 -0
  208. package/commonjs/folders/types.js.map +1 -0
  209. package/commonjs/folders/web.d.ts +33 -0
  210. package/commonjs/folders/web.d.ts.map +1 -0
  211. package/commonjs/folders/web.js +14 -0
  212. package/commonjs/folders/web.js.map +1 -0
  213. package/commonjs/forms/index.d.ts +3 -0
  214. package/commonjs/forms/index.d.ts.map +1 -0
  215. package/commonjs/forms/index.js +8 -0
  216. package/commonjs/forms/index.js.map +1 -0
  217. package/commonjs/forms/list.d.ts +10 -0
  218. package/commonjs/forms/list.d.ts.map +1 -0
  219. package/commonjs/forms/list.js +7 -0
  220. package/commonjs/forms/list.js.map +1 -0
  221. package/commonjs/forms/types.d.ts +36 -0
  222. package/commonjs/forms/types.d.ts.map +1 -0
  223. package/commonjs/forms/types.js +34 -0
  224. package/commonjs/forms/types.js.map +1 -0
  225. package/commonjs/groupsitemanager/index.d.ts +8 -0
  226. package/commonjs/groupsitemanager/index.d.ts.map +1 -0
  227. package/commonjs/groupsitemanager/index.js +14 -0
  228. package/commonjs/groupsitemanager/index.js.map +1 -0
  229. package/commonjs/groupsitemanager/types.d.ts +312 -0
  230. package/commonjs/groupsitemanager/types.d.ts.map +1 -0
  231. package/commonjs/groupsitemanager/types.js +325 -0
  232. package/commonjs/groupsitemanager/types.js.map +1 -0
  233. package/commonjs/hubsites/index.d.ts +13 -0
  234. package/commonjs/hubsites/index.d.ts.map +1 -0
  235. package/commonjs/hubsites/index.js +18 -0
  236. package/commonjs/hubsites/index.js.map +1 -0
  237. package/commonjs/hubsites/site.d.ts +27 -0
  238. package/commonjs/hubsites/site.d.ts.map +1 -0
  239. package/commonjs/hubsites/site.js +14 -0
  240. package/commonjs/hubsites/site.js.map +1 -0
  241. package/commonjs/hubsites/types.d.ts +56 -0
  242. package/commonjs/hubsites/types.d.ts.map +1 -0
  243. package/commonjs/hubsites/types.js +34 -0
  244. package/commonjs/hubsites/types.js.map +1 -0
  245. package/commonjs/hubsites/web.d.ts +22 -0
  246. package/commonjs/hubsites/web.d.ts.map +1 -0
  247. package/commonjs/hubsites/web.js +15 -0
  248. package/commonjs/hubsites/web.js.map +1 -0
  249. package/commonjs/index.d.ts +15 -0
  250. package/commonjs/index.d.ts.map +1 -0
  251. package/commonjs/index.js +21 -0
  252. package/commonjs/index.js.map +1 -0
  253. package/commonjs/items/index.d.ts +3 -0
  254. package/commonjs/items/index.d.ts.map +1 -0
  255. package/commonjs/items/index.js +10 -0
  256. package/commonjs/items/index.js.map +1 -0
  257. package/commonjs/items/list.d.ts +10 -0
  258. package/commonjs/items/list.d.ts.map +1 -0
  259. package/commonjs/items/list.js +7 -0
  260. package/commonjs/items/list.js.map +1 -0
  261. package/commonjs/items/types.d.ts +193 -0
  262. package/commonjs/items/types.d.ts.map +1 -0
  263. package/commonjs/items/types.js +295 -0
  264. package/commonjs/items/types.js.map +1 -0
  265. package/commonjs/lists/index.d.ts +3 -0
  266. package/commonjs/lists/index.d.ts.map +1 -0
  267. package/commonjs/lists/index.js +10 -0
  268. package/commonjs/lists/index.js.map +1 -0
  269. package/commonjs/lists/types.d.ts +626 -0
  270. package/commonjs/lists/types.d.ts.map +1 -0
  271. package/commonjs/lists/types.js +357 -0
  272. package/commonjs/lists/types.js.map +1 -0
  273. package/commonjs/lists/web.d.ts +44 -0
  274. package/commonjs/lists/web.d.ts.map +1 -0
  275. package/commonjs/lists/web.js +20 -0
  276. package/commonjs/lists/web.js.map +1 -0
  277. package/commonjs/navigation/index.d.ts +9 -0
  278. package/commonjs/navigation/index.d.ts.map +1 -0
  279. package/commonjs/navigation/index.js +19 -0
  280. package/commonjs/navigation/index.js.map +1 -0
  281. package/commonjs/navigation/types.d.ts +155 -0
  282. package/commonjs/navigation/types.d.ts.map +1 -0
  283. package/commonjs/navigation/types.js +153 -0
  284. package/commonjs/navigation/types.js.map +1 -0
  285. package/commonjs/navigation/web.d.ts +14 -0
  286. package/commonjs/navigation/web.d.ts.map +1 -0
  287. package/commonjs/navigation/web.js +7 -0
  288. package/commonjs/navigation/web.js.map +1 -0
  289. package/commonjs/package.json +1 -0
  290. package/commonjs/presets/all.d.ts +75 -0
  291. package/commonjs/presets/all.d.ts.map +1 -0
  292. package/commonjs/presets/all.js +78 -0
  293. package/commonjs/presets/all.js.map +1 -0
  294. package/commonjs/profiles/index.d.ts +8 -0
  295. package/commonjs/profiles/index.d.ts.map +1 -0
  296. package/commonjs/profiles/index.js +16 -0
  297. package/commonjs/profiles/index.js.map +1 -0
  298. package/commonjs/profiles/types.d.ts +358 -0
  299. package/commonjs/profiles/types.d.ts.map +1 -0
  300. package/commonjs/profiles/types.js +362 -0
  301. package/commonjs/profiles/types.js.map +1 -0
  302. package/commonjs/publishing-sitepageservice/index.d.ts +11 -0
  303. package/commonjs/publishing-sitepageservice/index.d.ts.map +1 -0
  304. package/commonjs/publishing-sitepageservice/index.js +13 -0
  305. package/commonjs/publishing-sitepageservice/index.js.map +1 -0
  306. package/commonjs/publishing-sitepageservice/types.d.ts +12 -0
  307. package/commonjs/publishing-sitepageservice/types.d.ts.map +1 -0
  308. package/commonjs/publishing-sitepageservice/types.js +20 -0
  309. package/commonjs/publishing-sitepageservice/types.js.map +1 -0
  310. package/commonjs/recycle-bin/index.d.ts +25 -0
  311. package/commonjs/recycle-bin/index.d.ts.map +1 -0
  312. package/commonjs/recycle-bin/index.js +12 -0
  313. package/commonjs/recycle-bin/index.js.map +1 -0
  314. package/commonjs/recycle-bin/types.d.ts +82 -0
  315. package/commonjs/recycle-bin/types.d.ts.map +1 -0
  316. package/commonjs/recycle-bin/types.js +83 -0
  317. package/commonjs/recycle-bin/types.js.map +1 -0
  318. package/commonjs/regional-settings/content-type.d.ts +8 -0
  319. package/commonjs/regional-settings/content-type.d.ts.map +1 -0
  320. package/commonjs/regional-settings/content-type.js +7 -0
  321. package/commonjs/regional-settings/content-type.js.map +1 -0
  322. package/commonjs/regional-settings/field.d.ts +8 -0
  323. package/commonjs/regional-settings/field.d.ts.map +1 -0
  324. package/commonjs/regional-settings/field.js +7 -0
  325. package/commonjs/regional-settings/field.js.map +1 -0
  326. package/commonjs/regional-settings/funcs.d.ts +3 -0
  327. package/commonjs/regional-settings/funcs.d.ts.map +1 -0
  328. package/commonjs/regional-settings/funcs.js +12 -0
  329. package/commonjs/regional-settings/funcs.js.map +1 -0
  330. package/commonjs/regional-settings/index.d.ts +7 -0
  331. package/commonjs/regional-settings/index.d.ts.map +1 -0
  332. package/commonjs/regional-settings/index.js +13 -0
  333. package/commonjs/regional-settings/index.js.map +1 -0
  334. package/commonjs/regional-settings/list.d.ts +8 -0
  335. package/commonjs/regional-settings/list.d.ts.map +1 -0
  336. package/commonjs/regional-settings/list.js +7 -0
  337. package/commonjs/regional-settings/list.js.map +1 -0
  338. package/commonjs/regional-settings/types.d.ts +105 -0
  339. package/commonjs/regional-settings/types.d.ts.map +1 -0
  340. package/commonjs/regional-settings/types.js +88 -0
  341. package/commonjs/regional-settings/types.js.map +1 -0
  342. package/commonjs/regional-settings/user-custom-actions.d.ts +8 -0
  343. package/commonjs/regional-settings/user-custom-actions.d.ts.map +1 -0
  344. package/commonjs/regional-settings/user-custom-actions.js +7 -0
  345. package/commonjs/regional-settings/user-custom-actions.js.map +1 -0
  346. package/commonjs/regional-settings/web.d.ts +13 -0
  347. package/commonjs/regional-settings/web.d.ts.map +1 -0
  348. package/commonjs/regional-settings/web.js +10 -0
  349. package/commonjs/regional-settings/web.js.map +1 -0
  350. package/commonjs/related-items/index.d.ts +3 -0
  351. package/commonjs/related-items/index.d.ts.map +1 -0
  352. package/commonjs/related-items/index.js +7 -0
  353. package/commonjs/related-items/index.js.map +1 -0
  354. package/commonjs/related-items/types.d.ts +77 -0
  355. package/commonjs/related-items/types.d.ts.map +1 -0
  356. package/commonjs/related-items/types.js +84 -0
  357. package/commonjs/related-items/types.js.map +1 -0
  358. package/commonjs/related-items/web.d.ts +13 -0
  359. package/commonjs/related-items/web.d.ts.map +1 -0
  360. package/commonjs/related-items/web.js +12 -0
  361. package/commonjs/related-items/web.js.map +1 -0
  362. package/commonjs/search/index.d.ts +23 -0
  363. package/commonjs/search/index.d.ts.map +1 -0
  364. package/commonjs/search/index.js +21 -0
  365. package/commonjs/search/index.js.map +1 -0
  366. package/commonjs/search/query.d.ts +62 -0
  367. package/commonjs/search/query.d.ts.map +1 -0
  368. package/commonjs/search/query.js +220 -0
  369. package/commonjs/search/query.js.map +1 -0
  370. package/commonjs/search/suggest.d.ts +76 -0
  371. package/commonjs/search/suggest.d.ts.map +1 -0
  372. package/commonjs/search/suggest.js +44 -0
  373. package/commonjs/search/suggest.js.map +1 -0
  374. package/commonjs/search/types.d.ts +436 -0
  375. package/commonjs/search/types.d.ts.map +1 -0
  376. package/commonjs/search/types.js +58 -0
  377. package/commonjs/search/types.js.map +1 -0
  378. package/commonjs/security/funcs.d.ts +44 -0
  379. package/commonjs/security/funcs.d.ts.map +1 -0
  380. package/commonjs/security/funcs.js +91 -0
  381. package/commonjs/security/funcs.js.map +1 -0
  382. package/commonjs/security/index.d.ts +5 -0
  383. package/commonjs/security/index.d.ts.map +1 -0
  384. package/commonjs/security/index.js +13 -0
  385. package/commonjs/security/index.js.map +1 -0
  386. package/commonjs/security/item.d.ts +8 -0
  387. package/commonjs/security/item.d.ts.map +1 -0
  388. package/commonjs/security/item.js +17 -0
  389. package/commonjs/security/item.js.map +1 -0
  390. package/commonjs/security/list.d.ts +8 -0
  391. package/commonjs/security/list.d.ts.map +1 -0
  392. package/commonjs/security/list.js +17 -0
  393. package/commonjs/security/list.js.map +1 -0
  394. package/commonjs/security/types.d.ts +319 -0
  395. package/commonjs/security/types.d.ts.map +1 -0
  396. package/commonjs/security/types.js +336 -0
  397. package/commonjs/security/types.js.map +1 -0
  398. package/commonjs/security/web.d.ts +10 -0
  399. package/commonjs/security/web.d.ts.map +1 -0
  400. package/commonjs/security/web.js +18 -0
  401. package/commonjs/security/web.js.map +1 -0
  402. package/commonjs/sharing/file.d.ts +19 -0
  403. package/commonjs/sharing/file.d.ts.map +1 -0
  404. package/commonjs/sharing/file.js +40 -0
  405. package/commonjs/sharing/file.js.map +1 -0
  406. package/commonjs/sharing/folder.d.ts +10 -0
  407. package/commonjs/sharing/folder.d.ts.map +1 -0
  408. package/commonjs/sharing/folder.js +38 -0
  409. package/commonjs/sharing/folder.js.map +1 -0
  410. package/commonjs/sharing/funcs.d.ts +63 -0
  411. package/commonjs/sharing/funcs.d.ts.map +1 -0
  412. package/commonjs/sharing/funcs.js +211 -0
  413. package/commonjs/sharing/funcs.js.map +1 -0
  414. package/commonjs/sharing/index.d.ts +6 -0
  415. package/commonjs/sharing/index.d.ts.map +1 -0
  416. package/commonjs/sharing/index.js +15 -0
  417. package/commonjs/sharing/index.js.map +1 -0
  418. package/commonjs/sharing/item.d.ts +17 -0
  419. package/commonjs/sharing/item.d.ts.map +1 -0
  420. package/commonjs/sharing/item.js +16 -0
  421. package/commonjs/sharing/item.js.map +1 -0
  422. package/commonjs/sharing/types.d.ts +589 -0
  423. package/commonjs/sharing/types.d.ts.map +1 -0
  424. package/commonjs/sharing/types.js +117 -0
  425. package/commonjs/sharing/types.js.map +1 -0
  426. package/commonjs/sharing/web.d.ts +20 -0
  427. package/commonjs/sharing/web.d.ts.map +1 -0
  428. package/commonjs/sharing/web.js +59 -0
  429. package/commonjs/sharing/web.js.map +1 -0
  430. package/commonjs/site-designs/index.d.ts +9 -0
  431. package/commonjs/site-designs/index.d.ts.map +1 -0
  432. package/commonjs/site-designs/index.js +16 -0
  433. package/commonjs/site-designs/index.js.map +1 -0
  434. package/commonjs/site-designs/types.d.ts +376 -0
  435. package/commonjs/site-designs/types.d.ts.map +1 -0
  436. package/commonjs/site-designs/types.js +179 -0
  437. package/commonjs/site-designs/types.js.map +1 -0
  438. package/commonjs/site-designs/web.d.ts +26 -0
  439. package/commonjs/site-designs/web.d.ts.map +1 -0
  440. package/commonjs/site-designs/web.js +14 -0
  441. package/commonjs/site-designs/web.js.map +1 -0
  442. package/commonjs/site-groups/index.d.ts +3 -0
  443. package/commonjs/site-groups/index.d.ts.map +1 -0
  444. package/commonjs/site-groups/index.js +8 -0
  445. package/commonjs/site-groups/index.js.map +1 -0
  446. package/commonjs/site-groups/types.d.ts +87 -0
  447. package/commonjs/site-groups/types.d.ts.map +1 -0
  448. package/commonjs/site-groups/types.js +88 -0
  449. package/commonjs/site-groups/types.js.map +1 -0
  450. package/commonjs/site-groups/web.d.ts +41 -0
  451. package/commonjs/site-groups/web.d.ts.map +1 -0
  452. package/commonjs/site-groups/web.js +20 -0
  453. package/commonjs/site-groups/web.js.map +1 -0
  454. package/commonjs/site-scripts/index.d.ts +10 -0
  455. package/commonjs/site-scripts/index.d.ts.map +1 -0
  456. package/commonjs/site-scripts/index.js +17 -0
  457. package/commonjs/site-scripts/index.js.map +1 -0
  458. package/commonjs/site-scripts/list.d.ts +13 -0
  459. package/commonjs/site-scripts/list.d.ts.map +1 -0
  460. package/commonjs/site-scripts/list.js +15 -0
  461. package/commonjs/site-scripts/list.js.map +1 -0
  462. package/commonjs/site-scripts/types.d.ts +184 -0
  463. package/commonjs/site-scripts/types.d.ts.map +1 -0
  464. package/commonjs/site-scripts/types.js +112 -0
  465. package/commonjs/site-scripts/types.js.map +1 -0
  466. package/commonjs/site-scripts/web.d.ts +14 -0
  467. package/commonjs/site-scripts/web.d.ts.map +1 -0
  468. package/commonjs/site-scripts/web.js +10 -0
  469. package/commonjs/site-scripts/web.js.map +1 -0
  470. package/commonjs/site-users/index.d.ts +3 -0
  471. package/commonjs/site-users/index.d.ts.map +1 -0
  472. package/commonjs/site-users/index.js +8 -0
  473. package/commonjs/site-users/index.js.map +1 -0
  474. package/commonjs/site-users/types.d.ts +138 -0
  475. package/commonjs/site-users/types.d.ts.map +1 -0
  476. package/commonjs/site-users/types.js +99 -0
  477. package/commonjs/site-users/types.js.map +1 -0
  478. package/commonjs/site-users/web.d.ts +32 -0
  479. package/commonjs/site-users/web.d.ts.map +1 -0
  480. package/commonjs/site-users/web.js +20 -0
  481. package/commonjs/site-users/web.js.map +1 -0
  482. package/commonjs/sites/index.d.ts +8 -0
  483. package/commonjs/sites/index.d.ts.map +1 -0
  484. package/commonjs/sites/index.js +17 -0
  485. package/commonjs/sites/index.js.map +1 -0
  486. package/commonjs/sites/types.d.ts +221 -0
  487. package/commonjs/sites/types.d.ts.map +1 -0
  488. package/commonjs/sites/types.js +261 -0
  489. package/commonjs/sites/types.js.map +1 -0
  490. package/commonjs/social/index.d.ts +11 -0
  491. package/commonjs/social/index.d.ts.map +1 -0
  492. package/commonjs/social/index.js +20 -0
  493. package/commonjs/social/index.js.map +1 -0
  494. package/commonjs/social/types.d.ts +305 -0
  495. package/commonjs/social/types.d.ts.map +1 -0
  496. package/commonjs/social/types.js +210 -0
  497. package/commonjs/social/types.js.map +1 -0
  498. package/commonjs/spqueryable.d.ts +117 -0
  499. package/commonjs/spqueryable.d.ts.map +1 -0
  500. package/commonjs/spqueryable.js +219 -0
  501. package/commonjs/spqueryable.js.map +1 -0
  502. package/commonjs/sputilities/index.d.ts +8 -0
  503. package/commonjs/sputilities/index.d.ts.map +1 -0
  504. package/commonjs/sputilities/index.js +15 -0
  505. package/commonjs/sputilities/index.js.map +1 -0
  506. package/commonjs/sputilities/types.d.ts +101 -0
  507. package/commonjs/sputilities/types.d.ts.map +1 -0
  508. package/commonjs/sputilities/types.js +69 -0
  509. package/commonjs/sputilities/types.js.map +1 -0
  510. package/commonjs/subscriptions/index.d.ts +3 -0
  511. package/commonjs/subscriptions/index.d.ts.map +1 -0
  512. package/commonjs/subscriptions/index.js +8 -0
  513. package/commonjs/subscriptions/index.js.map +1 -0
  514. package/commonjs/subscriptions/list.d.ts +14 -0
  515. package/commonjs/subscriptions/list.d.ts.map +1 -0
  516. package/commonjs/subscriptions/list.js +7 -0
  517. package/commonjs/subscriptions/list.js.map +1 -0
  518. package/commonjs/subscriptions/types.d.ts +55 -0
  519. package/commonjs/subscriptions/types.d.ts.map +1 -0
  520. package/commonjs/subscriptions/types.js +74 -0
  521. package/commonjs/subscriptions/types.js.map +1 -0
  522. package/commonjs/taxonomy/index.d.ts +8 -0
  523. package/commonjs/taxonomy/index.d.ts.map +1 -0
  524. package/commonjs/taxonomy/index.js +24 -0
  525. package/commonjs/taxonomy/index.js.map +1 -0
  526. package/commonjs/taxonomy/types.d.ts +314 -0
  527. package/commonjs/taxonomy/types.d.ts.map +1 -0
  528. package/commonjs/taxonomy/types.js +305 -0
  529. package/commonjs/taxonomy/types.js.map +1 -0
  530. package/commonjs/types.d.ts +241 -0
  531. package/commonjs/types.d.ts.map +1 -0
  532. package/commonjs/types.js +84 -0
  533. package/commonjs/types.js.map +1 -0
  534. package/commonjs/user-custom-actions/index.d.ts +5 -0
  535. package/commonjs/user-custom-actions/index.d.ts.map +1 -0
  536. package/commonjs/user-custom-actions/index.js +12 -0
  537. package/commonjs/user-custom-actions/index.js.map +1 -0
  538. package/commonjs/user-custom-actions/list.d.ts +13 -0
  539. package/commonjs/user-custom-actions/list.d.ts.map +1 -0
  540. package/commonjs/user-custom-actions/list.js +7 -0
  541. package/commonjs/user-custom-actions/list.js.map +1 -0
  542. package/commonjs/user-custom-actions/site.d.ts +13 -0
  543. package/commonjs/user-custom-actions/site.d.ts.map +1 -0
  544. package/commonjs/user-custom-actions/site.js +7 -0
  545. package/commonjs/user-custom-actions/site.js.map +1 -0
  546. package/commonjs/user-custom-actions/types.d.ts +82 -0
  547. package/commonjs/user-custom-actions/types.d.ts.map +1 -0
  548. package/commonjs/user-custom-actions/types.js +76 -0
  549. package/commonjs/user-custom-actions/types.js.map +1 -0
  550. package/commonjs/user-custom-actions/web.d.ts +16 -0
  551. package/commonjs/user-custom-actions/web.d.ts.map +1 -0
  552. package/commonjs/user-custom-actions/web.js +7 -0
  553. package/commonjs/user-custom-actions/web.js.map +1 -0
  554. package/commonjs/utils/encode-path-str.d.ts +8 -0
  555. package/commonjs/utils/encode-path-str.d.ts.map +1 -0
  556. package/commonjs/utils/encode-path-str.js +29 -0
  557. package/commonjs/utils/encode-path-str.js.map +1 -0
  558. package/commonjs/utils/extract-web-url.d.ts +2 -0
  559. package/commonjs/utils/extract-web-url.d.ts.map +1 -0
  560. package/commonjs/utils/extract-web-url.js +20 -0
  561. package/commonjs/utils/extract-web-url.js.map +1 -0
  562. package/commonjs/utils/file-names.d.ts +18 -0
  563. package/commonjs/utils/file-names.d.ts.map +1 -0
  564. package/commonjs/utils/file-names.js +41 -0
  565. package/commonjs/utils/file-names.js.map +1 -0
  566. package/commonjs/utils/metadata.d.ts +6 -0
  567. package/commonjs/utils/metadata.d.ts.map +1 -0
  568. package/commonjs/utils/metadata.js +10 -0
  569. package/commonjs/utils/metadata.js.map +1 -0
  570. package/commonjs/utils/odata-url-from.d.ts +2 -0
  571. package/commonjs/utils/odata-url-from.d.ts.map +1 -0
  572. package/commonjs/utils/odata-url-from.js +41 -0
  573. package/commonjs/utils/odata-url-from.js.map +1 -0
  574. package/commonjs/utils/to-resource-path.d.ts +5 -0
  575. package/commonjs/utils/to-resource-path.d.ts.map +1 -0
  576. package/commonjs/utils/to-resource-path.js +10 -0
  577. package/commonjs/utils/to-resource-path.js.map +1 -0
  578. package/commonjs/views/index.d.ts +3 -0
  579. package/commonjs/views/index.d.ts.map +1 -0
  580. package/commonjs/views/index.js +10 -0
  581. package/commonjs/views/index.js.map +1 -0
  582. package/commonjs/views/list.d.ts +24 -0
  583. package/commonjs/views/list.d.ts.map +1 -0
  584. package/commonjs/views/list.js +11 -0
  585. package/commonjs/views/list.js.map +1 -0
  586. package/commonjs/views/types.d.ts +147 -0
  587. package/commonjs/views/types.d.ts.map +1 -0
  588. package/commonjs/views/types.js +140 -0
  589. package/commonjs/views/types.js.map +1 -0
  590. package/commonjs/webparts/file.d.ts +16 -0
  591. package/commonjs/webparts/file.d.ts.map +1 -0
  592. package/commonjs/webparts/file.js +8 -0
  593. package/commonjs/webparts/file.js.map +1 -0
  594. package/commonjs/webparts/index.d.ts +3 -0
  595. package/commonjs/webparts/index.d.ts.map +1 -0
  596. package/commonjs/webparts/index.js +10 -0
  597. package/commonjs/webparts/index.js.map +1 -0
  598. package/commonjs/webparts/types.d.ts +84 -0
  599. package/commonjs/webparts/types.d.ts.map +1 -0
  600. package/commonjs/webparts/types.js +92 -0
  601. package/commonjs/webparts/types.js.map +1 -0
  602. package/commonjs/webs/index.d.ts +11 -0
  603. package/commonjs/webs/index.d.ts.map +1 -0
  604. package/commonjs/webs/index.js +16 -0
  605. package/commonjs/webs/index.js.map +1 -0
  606. package/commonjs/webs/types.d.ts +204 -0
  607. package/commonjs/webs/types.d.ts.map +1 -0
  608. package/commonjs/webs/types.js +227 -0
  609. package/commonjs/webs/types.js.map +1 -0
  610. package/package.json +3 -3
@@ -0,0 +1,5 @@
1
+ import "./item.js";
2
+ import "./list.js";
3
+ import "./web.js";
4
+ export { Folder, IFolderAddResult, IFolderUpdateResult, Folders, IFolder, IFolders, IFolderInfo, IFolderDeleteParams, IFolderParentInfos, folderFromServerRelativePath, folderFromAbsolutePath, folderFromPath, IStorageMetrics, } from "./types.js";
5
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/folders/index.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,CAAC;AACnB,OAAO,WAAW,CAAC;AACnB,OAAO,UAAU,CAAC;AAElB,OAAO,EACH,MAAM,EACN,gBAAgB,EAChB,mBAAmB,EACnB,OAAO,EACP,OAAO,EACP,QAAQ,EACR,WAAW,EACX,mBAAmB,EACnB,kBAAkB,EAClB,4BAA4B,EAC5B,sBAAsB,EACtB,cAAc,EACd,eAAe,GAClB,MAAM,YAAY,CAAC"}
@@ -0,0 +1,13 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.folderFromPath = exports.folderFromAbsolutePath = exports.folderFromServerRelativePath = exports.Folders = exports.Folder = void 0;
4
+ require("./item.js");
5
+ require("./list.js");
6
+ require("./web.js");
7
+ var types_js_1 = require("./types.js");
8
+ Object.defineProperty(exports, "Folder", { enumerable: true, get: function () { return types_js_1.Folder; } });
9
+ Object.defineProperty(exports, "Folders", { enumerable: true, get: function () { return types_js_1.Folders; } });
10
+ Object.defineProperty(exports, "folderFromServerRelativePath", { enumerable: true, get: function () { return types_js_1.folderFromServerRelativePath; } });
11
+ Object.defineProperty(exports, "folderFromAbsolutePath", { enumerable: true, get: function () { return types_js_1.folderFromAbsolutePath; } });
12
+ Object.defineProperty(exports, "folderFromPath", { enumerable: true, get: function () { return types_js_1.folderFromPath; } });
13
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/sp/folders/index.ts"],"names":[],"mappings":";;;AAAA,qBAAmB;AACnB,qBAAmB;AACnB,oBAAkB;AAElB,uCAcoB;AAbhB,kGAAA,MAAM,OAAA;AAGN,mGAAA,OAAO,OAAA;AAMP,wHAAA,4BAA4B,OAAA;AAC5B,kHAAA,sBAAsB,OAAA;AACtB,0GAAA,cAAc,OAAA"}
@@ -0,0 +1,10 @@
1
+ import { IFolder } from "./types.js";
2
+ declare module "../items/types" {
3
+ interface _Item {
4
+ readonly folder: IFolder;
5
+ }
6
+ interface IItem {
7
+ readonly folder: IFolder;
8
+ }
9
+ }
10
+ //# sourceMappingURL=item.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"item.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/folders/item.ts"],"names":[],"mappings":"AAEA,OAAO,EAAU,OAAO,EAAE,MAAM,YAAY,CAAC;AAE7C,OAAO,QAAQ,gBAAgB,CAAC;IAC5B,UAAU,KAAK;QACX,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;KAE5B;IACD,UAAU,KAAK;QACX,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;KAE5B;CACJ"}
@@ -0,0 +1,7 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const queryable_1 = require("@pnp/queryable");
4
+ const types_js_1 = require("../items/types.js");
5
+ const types_js_2 = require("./types.js");
6
+ (0, queryable_1.addProp)(types_js_1._Item, "folder", types_js_2.Folder);
7
+ //# sourceMappingURL=item.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"item.js","sourceRoot":"","sources":["../../../../../packages/sp/folders/item.ts"],"names":[],"mappings":";;AAAA,8CAAyC;AACzC,gDAA0C;AAC1C,yCAA6C;AAa7C,IAAA,mBAAO,EAAC,gBAAK,EAAE,QAAQ,EAAE,iBAAM,CAAC,CAAC"}
@@ -0,0 +1,13 @@
1
+ import { IFolder } from "./types.js";
2
+ declare module "../lists/types" {
3
+ interface _List {
4
+ readonly rootFolder: IFolder;
5
+ }
6
+ interface IList {
7
+ /**
8
+ * Root folder for this list/library
9
+ */
10
+ readonly rootFolder: IFolder;
11
+ }
12
+ }
13
+ //# sourceMappingURL=list.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"list.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/folders/list.ts"],"names":[],"mappings":"AAEA,OAAO,EAAU,OAAO,EAAE,MAAM,YAAY,CAAC;AAE7C,OAAO,QAAQ,gBAAgB,CAAC;IAC5B,UAAU,KAAK;QACX,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;KAChC;IACD,UAAU,KAAK;QACX;;WAEG;QACH,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;KAChC;CACJ"}
@@ -0,0 +1,7 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const queryable_1 = require("@pnp/queryable");
4
+ const types_js_1 = require("../lists/types.js");
5
+ const types_js_2 = require("./types.js");
6
+ (0, queryable_1.addProp)(types_js_1._List, "rootFolder", types_js_2.Folder);
7
+ //# sourceMappingURL=list.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"list.js","sourceRoot":"","sources":["../../../../../packages/sp/folders/list.ts"],"names":[],"mappings":";;AAAA,8CAAyC;AACzC,gDAA0C;AAC1C,yCAA6C;AAc7C,IAAA,mBAAO,EAAC,gBAAK,EAAE,YAAY,EAAE,iBAAM,CAAC,CAAC"}
@@ -0,0 +1,237 @@
1
+ import { _SPCollection, _SPInstance, ISPInstance, IDeleteableWithETag, ISPQueryable } from "../spqueryable.js";
2
+ import { IItem } from "../items/types.js";
3
+ import { IResourcePath } from "../utils/to-resource-path.js";
4
+ import "../context-info/index.js";
5
+ import { IMoveCopyOptions } from "../types.js";
6
+ export declare class _Folders extends _SPCollection<IFolderInfo[]> {
7
+ /**
8
+ * Gets a folder by it's name
9
+ *
10
+ * @param name Folder's name
11
+ */
12
+ getByUrl(name: string): IFolder;
13
+ /**
14
+ * Adds a new folder by path and should be prefered over add
15
+ *
16
+ * @param serverRelativeUrl The server relative url of the new folder to create
17
+ * @param overwrite True to overwrite an existing folder, default false
18
+ */
19
+ addUsingPath(serverRelativeUrl: string, overwrite?: boolean): Promise<IFolderAddResult>;
20
+ }
21
+ export interface IFolders extends _Folders {
22
+ }
23
+ export declare const Folders: import("../spqueryable.js").ISPInvokableFactory<IFolders>;
24
+ export declare class _Folder extends _SPInstance<IFolderInfo> {
25
+ delete: (this: ISPQueryable<any>, eTag?: string) => Promise<void>;
26
+ /**
27
+ * Gets this folder's sub folders
28
+ *
29
+ */
30
+ get folders(): IFolders;
31
+ /**
32
+ * Gets this folder's list item field values
33
+ *
34
+ */
35
+ get listItemAllFields(): ISPInstance;
36
+ /**
37
+ * Gets the parent folder, if available
38
+ *
39
+ */
40
+ get parentFolder(): IFolder;
41
+ /**
42
+ * Gets this folder's properties
43
+ *
44
+ */
45
+ get properties(): ISPInstance;
46
+ /**
47
+ * Gets this folder's storage metrics information
48
+ *
49
+ */
50
+ get storageMetrics(): ISPInstance<IStorageMetrics>;
51
+ /**
52
+ * Updates folder's properties
53
+ * @param props Folder's properties to update
54
+ */
55
+ update(props: Partial<IFolderInfo>): Promise<IFolderUpdateResult>;
56
+ /**
57
+ * Moves the folder to the Recycle Bin and returns the identifier of the new Recycle Bin item.
58
+ */
59
+ recycle(): Promise<string>;
60
+ /**
61
+ * Gets the associated list item for this folder, loading the default properties
62
+ */
63
+ getItem<T>(...selects: string[]): Promise<IItem & T>;
64
+ /**
65
+ * Moves the file by path to the specified destination url.
66
+ * Also works with different site collections.
67
+ *
68
+ * @param destUrl The absolute url or server relative url of the destination file path to move to.
69
+ * @param shouldOverWrite Should a file with the same name in the same location be overwritten?
70
+ * @param options Allows you to supply the full set of options controlling the move behavior
71
+ */
72
+ moveByPath(destUrl: string, options: Partial<Omit<IMoveCopyOptions, "ResetAuthorAndCreatedOnCopy">>): Promise<IFolder>;
73
+ /**
74
+ * Moves the file by path to the specified destination url.
75
+ * Also works with different site collections.
76
+ *
77
+ * @param destUrl The absolute url or server relative url of the destination file path to move to.
78
+ * @param keepBoth Keep both if file with the same name in the same location already exists? Only relevant when shouldOverWrite is set to false.
79
+ */
80
+ moveByPath(destUrl: string, KeepBoth?: boolean): Promise<IFolder>;
81
+ /**
82
+ * Moves the folder by path to the specified destination url.
83
+ * Also works with different site collections.
84
+ *
85
+ * @param destUrl The absolute url or server relative url of the destination folder path to move to.
86
+ * @param shouldOverWrite Should a folder with the same name in the same location be overwritten?
87
+ * @param options Allows you to supply the full set of options controlling the copy behavior
88
+ */
89
+ copyByPath(destUrl: string, options: Partial<Omit<IMoveCopyOptions, "RetainEditorAndModifiedOnMove">>): Promise<IFolder>;
90
+ /**
91
+ * Copies a folder by path to destination path
92
+ * Also works with different site collections.
93
+ *
94
+ * @param destUrl Absolute or relative URL of the destination path
95
+ * @param keepBoth Keep both if folder with the same name in the same location already exists?
96
+ */
97
+ copyByPath(destUrl: string, KeepBoth?: boolean): Promise<IFolder>;
98
+ /**
99
+ * Deletes the folder object with options.
100
+ *
101
+ * @param parameters Specifies the options to use when deleting a folder.
102
+ */
103
+ deleteWithParams(parameters: Partial<IFolderDeleteParams>): Promise<void>;
104
+ /**
105
+ * Create the subfolder inside the current folder, as specified by the leafPath
106
+ *
107
+ * @param leafPath leafName of the new folder
108
+ */
109
+ addSubFolderUsingPath(leafPath: string): Promise<IFolder>;
110
+ /**
111
+ * Gets the parent information for this folder's list and web
112
+ */
113
+ getParentInfos(): Promise<IFolderParentInfos>;
114
+ /**
115
+ * Implementation of folder move/copy
116
+ *
117
+ * @param destUrl The server relative path to which the folder will be copied/moved
118
+ * @param options Any options
119
+ * @param methodName The method to call
120
+ * @returns An IFolder representing the moved or copied folder
121
+ */
122
+ protected moveCopyImpl(destUrl: string, options: Partial<IMoveCopyOptions>, methodName: "MoveFolderByPath" | "CopyFolderByPath"): Promise<IFolder>;
123
+ }
124
+ export interface IFolder extends _Folder, IDeleteableWithETag {
125
+ }
126
+ export declare const Folder: import("../spqueryable.js").ISPInvokableFactory<IFolder>;
127
+ /**
128
+ * Creates an IFolder instance given a base object and a server relative path
129
+ *
130
+ * @param base Valid SPQueryable from which the observers will be used and the web url extracted
131
+ * @param serverRelativePath The server relative url to the folder (ex: '/sites/dev/documents/folder3')
132
+ * @returns IFolder instance referencing the folder described by the supplied parameters
133
+ */
134
+ export declare function folderFromServerRelativePath(base: ISPQueryable, serverRelativePath: string): IFolder;
135
+ /**
136
+ * Creates an IFolder instance given a base object and an absolute path
137
+ *
138
+ * @param base Valid SPQueryable from which the observers will be used
139
+ * @param serverRelativePath The absolute url to the folder (ex: 'https://tenant.sharepoint.com/sites/dev/documents/folder/')
140
+ * @returns IFolder instance referencing the folder described by the supplied parameters
141
+ */
142
+ export declare function folderFromAbsolutePath(base: ISPQueryable, absoluteFolderPath: string): Promise<IFolder>;
143
+ /**
144
+ * Creates an IFolder intance given a base object and either an absolute or server relative path to a folder
145
+ *
146
+ * @param base Valid SPQueryable from which the observers will be used
147
+ * @param serverRelativePath server relative or absolute url to the file (ex: 'https://tenant.sharepoint.com/sites/dev/documents/folder' or '/sites/dev/documents/folder')
148
+ * @returns IFile instance referencing the file described by the supplied parameters
149
+ */
150
+ export declare function folderFromPath(base: ISPQueryable, path: string): Promise<IFolder>;
151
+ /**
152
+ * Describes result of adding a folder
153
+ */
154
+ export interface IFolderAddResult {
155
+ /**
156
+ * A folder's instance
157
+ */
158
+ folder: IFolder;
159
+ /**
160
+ * Additional data from the server
161
+ */
162
+ data: any;
163
+ }
164
+ /**
165
+ * Describes result of updating a folder
166
+ */
167
+ export interface IFolderUpdateResult {
168
+ /**
169
+ * A folder's instance
170
+ */
171
+ folder: IFolder;
172
+ /**
173
+ * Additional data from the server
174
+ */
175
+ data: any;
176
+ }
177
+ export interface IFolderInfo {
178
+ readonly "odata.id": string;
179
+ Exists: boolean;
180
+ IsWOPIEnabled: boolean;
181
+ ItemCount: number;
182
+ Name: string;
183
+ ProgID: string | null;
184
+ ServerRelativeUrl: string;
185
+ ServerRelativePath: IResourcePath;
186
+ TimeCreated: string;
187
+ TimeLastModified: string;
188
+ UniqueId: string;
189
+ WelcomePage: string;
190
+ ContentTypeOrder: string[];
191
+ UniqueContentTypeOrder: string[];
192
+ StorageMetrics?: IStorageMetrics;
193
+ }
194
+ export interface IStorageMetrics {
195
+ LastModified: string;
196
+ TotalFileCount: number;
197
+ TotalFileStreamSize: number;
198
+ TotalSize: number;
199
+ }
200
+ export interface IFolderDeleteParams {
201
+ /**
202
+ * If true, delete or recycle a folder iff all files have
203
+ * LockType values SPLockType.Shared or SPLockType.None.
204
+ * When false, delete or recycle the folder if all files
205
+ * have the LockType value SPLockType.None. See the <see cref="SPFile.SPLockType"/> enum.
206
+ */
207
+ BypassSharedLock: boolean;
208
+ /**
209
+ * Gets or sets a string value that allows SPFolder delete
210
+ * and recycle methods to target a folder with a matching value
211
+ */
212
+ ETagMatch: string;
213
+ /**
214
+ * Gets or sets a Boolean that controls the way in which folders
215
+ * are deleted. If set to true, only empty folders will be deleted.
216
+ * If set to false, folders that are not empty may be deleted.
217
+ */
218
+ DeleteIfEmpty: boolean;
219
+ }
220
+ export interface IFolderParentInfos {
221
+ Folder: {
222
+ ServerRelativeUrl: string;
223
+ };
224
+ ParentList: {
225
+ Id: string;
226
+ RootFolderServerRelativePath: IResourcePath;
227
+ RootFolderServerRelativeUrl: string;
228
+ RootFolderUniqueId: string;
229
+ };
230
+ ParentWeb: {
231
+ Id: string;
232
+ ServerRelativePath: IResourcePath;
233
+ ServerRelativeUrl: string;
234
+ Url: string;
235
+ };
236
+ }
237
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/folders/types.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,aAAa,EAEb,WAAW,EAGX,WAAW,EACX,mBAAmB,EACnB,YAAY,EAGf,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,KAAK,EAAQ,MAAM,mBAAmB,CAAC;AAGhD,OAAO,EAAkB,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAE7E,OAAO,0BAA0B,CAAC;AAClC,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAG/C,qBACa,QAAS,SAAQ,aAAa,CAAC,WAAW,EAAE,CAAC;IAEtD;;;;OAIG;IACI,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAItC;;;;;OAKG;IACU,YAAY,CAAC,iBAAiB,EAAE,MAAM,EAAE,SAAS,UAAQ,GAAG,OAAO,CAAC,gBAAgB,CAAC;CASrG;AACD,MAAM,WAAW,QAAS,SAAQ,QAAQ;CAAI;AAC9C,eAAO,MAAM,OAAO,2DAAyC,CAAC;AAG9D,qBAAa,OAAQ,SAAQ,WAAW,CAAC,WAAW,CAAC;IAE1C,MAAM,4DAAwB;IAErC;;;OAGG;IACH,IAAW,OAAO,IAAI,QAAQ,CAE7B;IAED;;;OAGG;IACH,IAAW,iBAAiB,IAAI,WAAW,CAE1C;IAED;;;OAGG;IACH,IAAW,YAAY,IAAI,OAAO,CAEjC;IAED;;;OAGG;IACH,IAAW,UAAU,IAAI,WAAW,CAEnC;IAED;;;OAGG;IACH,IAAW,cAAc,IAAI,WAAW,CAAC,eAAe,CAAC,CAExD;IAED;;;OAGG;IACU,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAU9E;;OAEG;IACI,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC;IAIjC;;OAEG;IACU,OAAO,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,KAAK,GAAG,CAAC,CAAC;IAUjE;;;;;;;OAOG;IACU,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,6BAA6B,CAAC,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IACnI;;;;;;OAMG;IACU,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAqB9E;;;;;;;OAOG;IACU,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,+BAA+B,CAAC,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IACrI;;;;;;OAMG;IACU,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAqB9E;;;;OAIG;IACU,gBAAgB,CAAC,UAAU,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAItF;;;;OAIG;IACU,qBAAqB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAKtE;;OAEG;IACU,cAAc,IAAI,OAAO,CAAC,kBAAkB,CAAC;IAqC1D;;;;;;;OAOG;IACH,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,gBAAgB,CAAC,EAAE,UAAU,EAAE,kBAAkB,GAAG,kBAAkB,GAAG,OAAO,CAAC,OAAO,CAAC;CAyBrJ;AACD,MAAM,WAAW,OAAQ,SAAQ,OAAO,EAAE,mBAAmB;CAAI;AACjE,eAAO,MAAM,MAAM,0DAAuC,CAAC;AAE3D;;;;;;GAMG;AACH,wBAAgB,4BAA4B,CAAC,IAAI,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,GAAG,OAAO,CAGpG;AAED;;;;;;GAMG;AACH,wBAAsB,sBAAsB,CAAC,IAAI,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAK7G;AAED;;;;;;GAMG;AACH,wBAAsB,cAAc,CAAC,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAEvF;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAE7B;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,GAAG,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAEhC;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,GAAG,CAAC;CACb;AAED,MAAM,WAAW,WAAW;IACxB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,MAAM,EAAE,OAAO,CAAC;IAChB,aAAa,EAAE,OAAO,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,kBAAkB,EAAE,aAAa,CAAC;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,EAAE,MAAM,CAAC;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,sBAAsB,EAAE,MAAM,EAAE,CAAC;IACjC,cAAc,CAAC,EAAE,eAAe,CAAC;CACpC;AAED,MAAM,WAAW,eAAe;IAC5B,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,SAAS,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,mBAAmB;IAGhC;;;;;OAKG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,aAAa,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,kBAAkB;IAC/B,MAAM,EAAE;QACJ,iBAAiB,EAAE,MAAM,CAAC;KAC7B,CAAC;IACF,UAAU,EAAE;QACR,EAAE,EAAE,MAAM,CAAC;QACX,4BAA4B,EAAE,aAAa,CAAC;QAC5C,2BAA2B,EAAE,MAAM,CAAC;QACpC,kBAAkB,EAAE,MAAM,CAAC;KAC9B,CAAC;IACF,SAAS,EAAE;QACP,EAAE,EAAE,MAAM,CAAC;QACX,kBAAkB,EAAE,aAAa,CAAC;QAClC,iBAAiB,EAAE,MAAM,CAAC;QAC1B,GAAG,EAAE,MAAM,CAAC;KACf,CAAC;CACL"}
@@ -0,0 +1,253 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.folderFromPath = exports.folderFromAbsolutePath = exports.folderFromServerRelativePath = exports.Folder = exports._Folder = exports.Folders = exports._Folders = void 0;
4
+ const tslib_1 = require("tslib");
5
+ const core_1 = require("@pnp/core");
6
+ const queryable_1 = require("@pnp/queryable");
7
+ const spqueryable_js_1 = require("../spqueryable.js");
8
+ const odata_url_from_js_1 = require("../utils/odata-url-from.js");
9
+ const types_js_1 = require("../items/types.js");
10
+ const decorators_js_1 = require("../decorators.js");
11
+ const extract_web_url_js_1 = require("../utils/extract-web-url.js");
12
+ const to_resource_path_js_1 = require("../utils/to-resource-path.js");
13
+ const encode_path_str_js_1 = require("../utils/encode-path-str.js");
14
+ require("../context-info/index.js");
15
+ const batching_js_1 = require("../batching.js");
16
+ let _Folders = class _Folders extends spqueryable_js_1._SPCollection {
17
+ /**
18
+ * Gets a folder by it's name
19
+ *
20
+ * @param name Folder's name
21
+ */
22
+ getByUrl(name) {
23
+ return (0, exports.Folder)(this).concat(`('${(0, encode_path_str_js_1.encodePath)(name)}')`);
24
+ }
25
+ /**
26
+ * Adds a new folder by path and should be prefered over add
27
+ *
28
+ * @param serverRelativeUrl The server relative url of the new folder to create
29
+ * @param overwrite True to overwrite an existing folder, default false
30
+ */
31
+ async addUsingPath(serverRelativeUrl, overwrite = false) {
32
+ const data = await (0, spqueryable_js_1.spPost)((0, exports.Folders)(this, `addUsingPath(DecodedUrl='${(0, encode_path_str_js_1.encodePath)(serverRelativeUrl)}',overwrite=${overwrite})`));
33
+ return {
34
+ data,
35
+ folder: folderFromServerRelativePath(this, data.ServerRelativeUrl),
36
+ };
37
+ }
38
+ };
39
+ _Folders = (0, tslib_1.__decorate)([
40
+ (0, decorators_js_1.defaultPath)("folders")
41
+ ], _Folders);
42
+ exports._Folders = _Folders;
43
+ exports.Folders = (0, spqueryable_js_1.spInvokableFactory)(_Folders);
44
+ class _Folder extends spqueryable_js_1._SPInstance {
45
+ constructor() {
46
+ super(...arguments);
47
+ this.delete = (0, spqueryable_js_1.deleteableWithETag)();
48
+ }
49
+ /**
50
+ * Gets this folder's sub folders
51
+ *
52
+ */
53
+ get folders() {
54
+ return (0, exports.Folders)(this);
55
+ }
56
+ /**
57
+ * Gets this folder's list item field values
58
+ *
59
+ */
60
+ get listItemAllFields() {
61
+ return (0, spqueryable_js_1.SPInstance)(this, "listItemAllFields");
62
+ }
63
+ /**
64
+ * Gets the parent folder, if available
65
+ *
66
+ */
67
+ get parentFolder() {
68
+ return (0, exports.Folder)(this, "parentFolder");
69
+ }
70
+ /**
71
+ * Gets this folder's properties
72
+ *
73
+ */
74
+ get properties() {
75
+ return (0, spqueryable_js_1.SPInstance)(this, "properties");
76
+ }
77
+ /**
78
+ * Gets this folder's storage metrics information
79
+ *
80
+ */
81
+ get storageMetrics() {
82
+ return (0, spqueryable_js_1.SPInstance)(this, "storagemetrics");
83
+ }
84
+ /**
85
+ * Updates folder's properties
86
+ * @param props Folder's properties to update
87
+ */
88
+ async update(props) {
89
+ const data = await (0, spqueryable_js_1.spPostMerge)(this, (0, queryable_1.body)(props));
90
+ return {
91
+ data,
92
+ folder: this,
93
+ };
94
+ }
95
+ /**
96
+ * Moves the folder to the Recycle Bin and returns the identifier of the new Recycle Bin item.
97
+ */
98
+ recycle() {
99
+ return (0, spqueryable_js_1.spPost)((0, exports.Folder)(this, "recycle"));
100
+ }
101
+ /**
102
+ * Gets the associated list item for this folder, loading the default properties
103
+ */
104
+ async getItem(...selects) {
105
+ const q = this.listItemAllFields;
106
+ const d = await q.select(...selects)();
107
+ if (d["odata.null"]) {
108
+ throw Error("No associated item was found for this folder. It may be the root folder, which does not have an item.");
109
+ }
110
+ return Object.assign((0, types_js_1.Item)([this, (0, odata_url_from_js_1.odataUrlFrom)(d)]), d);
111
+ }
112
+ async moveByPath(destUrl, ...rest) {
113
+ let options = {
114
+ KeepBoth: false,
115
+ ShouldBypassSharedLocks: true,
116
+ RetainEditorAndModifiedOnMove: false,
117
+ };
118
+ if (rest.length === 1) {
119
+ if (typeof rest[0] === "boolean") {
120
+ options.KeepBoth = rest[0];
121
+ }
122
+ else if (typeof rest[0] === "object") {
123
+ options = { ...options, ...rest[0] };
124
+ }
125
+ }
126
+ return this.moveCopyImpl(destUrl, options, "MoveFolderByPath");
127
+ }
128
+ async copyByPath(destUrl, ...rest) {
129
+ let options = {
130
+ ShouldBypassSharedLocks: true,
131
+ ResetAuthorAndCreatedOnCopy: true,
132
+ KeepBoth: false,
133
+ };
134
+ if (rest.length === 1) {
135
+ if (typeof rest[0] === "boolean") {
136
+ options.KeepBoth = rest[0];
137
+ }
138
+ else if (typeof rest[0] === "object") {
139
+ options = { ...options, ...rest[0] };
140
+ }
141
+ }
142
+ return this.moveCopyImpl(destUrl, options, "CopyFolderByPath");
143
+ }
144
+ /**
145
+ * Deletes the folder object with options.
146
+ *
147
+ * @param parameters Specifies the options to use when deleting a folder.
148
+ */
149
+ async deleteWithParams(parameters) {
150
+ return (0, spqueryable_js_1.spPost)((0, exports.Folder)(this, "DeleteWithParameters"), (0, queryable_1.body)({ parameters }));
151
+ }
152
+ /**
153
+ * Create the subfolder inside the current folder, as specified by the leafPath
154
+ *
155
+ * @param leafPath leafName of the new folder
156
+ */
157
+ async addSubFolderUsingPath(leafPath) {
158
+ await (0, spqueryable_js_1.spPost)((0, exports.Folder)(this, "AddSubFolderUsingPath"), (0, queryable_1.body)({ leafPath: (0, to_resource_path_js_1.toResourcePath)(leafPath) }));
159
+ return this.folders.getByUrl(leafPath);
160
+ }
161
+ /**
162
+ * Gets the parent information for this folder's list and web
163
+ */
164
+ async getParentInfos() {
165
+ const urlInfo = await this.select("ServerRelativeUrl", "ListItemAllFields/ParentList/Id", "ListItemAllFields/ParentList/RootFolder/UniqueId", "ListItemAllFields/ParentList/RootFolder/ServerRelativeUrl", "ListItemAllFields/ParentList/RootFolder/ServerRelativePath", "ListItemAllFields/ParentList/ParentWeb/Id", "ListItemAllFields/ParentList/ParentWeb/Url", "ListItemAllFields/ParentList/ParentWeb/ServerRelativeUrl", "ListItemAllFields/ParentList/ParentWeb/ServerRelativePath").expand("ListItemAllFields/ParentList", "ListItemAllFields/ParentList/RootFolder", "ListItemAllFields/ParentList/ParentWeb")();
166
+ return {
167
+ Folder: {
168
+ ServerRelativeUrl: urlInfo.ServerRelativeUrl,
169
+ },
170
+ ParentList: {
171
+ Id: urlInfo.ListItemAllFields.ParentList.Id,
172
+ RootFolderServerRelativePath: urlInfo.ListItemAllFields.ParentList.RootFolder.ServerRelativePath,
173
+ RootFolderServerRelativeUrl: urlInfo.ListItemAllFields.ParentList.RootFolder.ServerRelativeUrl,
174
+ RootFolderUniqueId: urlInfo.ListItemAllFields.ParentList.RootFolder.UniqueId,
175
+ },
176
+ ParentWeb: {
177
+ Id: urlInfo.ListItemAllFields.ParentList.ParentWeb.Id,
178
+ ServerRelativePath: urlInfo.ListItemAllFields.ParentList.ParentWeb.ServerRelativePath,
179
+ ServerRelativeUrl: urlInfo.ListItemAllFields.ParentList.ParentWeb.ServerRelativeUrl,
180
+ Url: urlInfo.ListItemAllFields.ParentList.ParentWeb.Url,
181
+ },
182
+ };
183
+ }
184
+ /**
185
+ * Implementation of folder move/copy
186
+ *
187
+ * @param destUrl The server relative path to which the folder will be copied/moved
188
+ * @param options Any options
189
+ * @param methodName The method to call
190
+ * @returns An IFolder representing the moved or copied folder
191
+ */
192
+ moveCopyImpl(destUrl, options, methodName) {
193
+ // create a timeline we will manipulate for this request
194
+ const poster = (0, exports.Folder)(this);
195
+ // add our pre-request actions, this fixes issues with batching hanging #2668
196
+ poster.on.pre((0, core_1.noInherit)(async (url, init, result) => {
197
+ const urlInfo = await (0, exports.Folder)(this).using((0, batching_js_1.BatchNever)()).getParentInfos();
198
+ const uri = new URL(urlInfo.ParentWeb.Url);
199
+ url = (0, core_1.combine)(urlInfo.ParentWeb.Url, `/_api/SP.MoveCopyUtil.${methodName}()`);
200
+ init = (0, queryable_1.body)({
201
+ destPath: (0, to_resource_path_js_1.toResourcePath)((0, core_1.isUrlAbsolute)(destUrl) ? destUrl : (0, core_1.combine)(uri.origin, destUrl)),
202
+ options,
203
+ srcPath: (0, to_resource_path_js_1.toResourcePath)((0, core_1.combine)(uri.origin, urlInfo.Folder.ServerRelativeUrl)),
204
+ }, init);
205
+ return [url, init, result];
206
+ }));
207
+ return (0, spqueryable_js_1.spPost)(poster).then(() => folderFromPath(this, destUrl));
208
+ }
209
+ }
210
+ (0, tslib_1.__decorate)([
211
+ queryable_1.cancelableScope
212
+ ], _Folder.prototype, "moveByPath", null);
213
+ (0, tslib_1.__decorate)([
214
+ queryable_1.cancelableScope
215
+ ], _Folder.prototype, "copyByPath", null);
216
+ exports._Folder = _Folder;
217
+ exports.Folder = (0, spqueryable_js_1.spInvokableFactory)(_Folder);
218
+ /**
219
+ * Creates an IFolder instance given a base object and a server relative path
220
+ *
221
+ * @param base Valid SPQueryable from which the observers will be used and the web url extracted
222
+ * @param serverRelativePath The server relative url to the folder (ex: '/sites/dev/documents/folder3')
223
+ * @returns IFolder instance referencing the folder described by the supplied parameters
224
+ */
225
+ function folderFromServerRelativePath(base, serverRelativePath) {
226
+ return (0, exports.Folder)([base, (0, extract_web_url_js_1.extractWebUrl)(base.toUrl())], `_api/web/getFolderByServerRelativePath(decodedUrl='${(0, encode_path_str_js_1.encodePath)(serverRelativePath)}')`);
227
+ }
228
+ exports.folderFromServerRelativePath = folderFromServerRelativePath;
229
+ /**
230
+ * Creates an IFolder instance given a base object and an absolute path
231
+ *
232
+ * @param base Valid SPQueryable from which the observers will be used
233
+ * @param serverRelativePath The absolute url to the folder (ex: 'https://tenant.sharepoint.com/sites/dev/documents/folder/')
234
+ * @returns IFolder instance referencing the folder described by the supplied parameters
235
+ */
236
+ async function folderFromAbsolutePath(base, absoluteFolderPath) {
237
+ const { WebFullUrl } = await (0, exports.Folder)(this).using((0, batching_js_1.BatchNever)()).getContextInfo(absoluteFolderPath);
238
+ const { pathname } = new URL(absoluteFolderPath);
239
+ return folderFromServerRelativePath((0, exports.Folder)([base, (0, core_1.combine)(WebFullUrl, "_api/web")]), decodeURIComponent(pathname));
240
+ }
241
+ exports.folderFromAbsolutePath = folderFromAbsolutePath;
242
+ /**
243
+ * Creates an IFolder intance given a base object and either an absolute or server relative path to a folder
244
+ *
245
+ * @param base Valid SPQueryable from which the observers will be used
246
+ * @param serverRelativePath server relative or absolute url to the file (ex: 'https://tenant.sharepoint.com/sites/dev/documents/folder' or '/sites/dev/documents/folder')
247
+ * @returns IFile instance referencing the file described by the supplied parameters
248
+ */
249
+ async function folderFromPath(base, path) {
250
+ return ((0, core_1.isUrlAbsolute)(path) ? folderFromAbsolutePath : folderFromServerRelativePath)(base, path);
251
+ }
252
+ exports.folderFromPath = folderFromPath;
253
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../packages/sp/folders/types.ts"],"names":[],"mappings":";;;;AAAA,oCAA8D;AAC9D,8CAAuD;AACvD,sDAW2B;AAC3B,kEAA0D;AAC1D,gDAAgD;AAChD,oDAA+C;AAC/C,oEAA4D;AAC5D,sEAA6E;AAC7E,oEAAyD;AACzD,oCAAkC;AAElC,gDAA4C;AAG5C,IAAa,QAAQ,GAArB,MAAa,QAAS,SAAQ,8BAA4B;IAEtD;;;;OAIG;IACI,QAAQ,CAAC,IAAY;QACxB,OAAO,IAAA,cAAM,EAAC,IAAI,CAAC,CAAC,MAAM,CAAC,KAAK,IAAA,+BAAU,EAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,YAAY,CAAC,iBAAyB,EAAE,SAAS,GAAG,KAAK;QAElE,MAAM,IAAI,GAAgB,MAAM,IAAA,uBAAM,EAAC,IAAA,eAAO,EAAC,IAAI,EAAE,4BAA4B,IAAA,+BAAU,EAAC,iBAAiB,CAAC,eAAe,SAAS,GAAG,CAAC,CAAC,CAAC;QAE5I,OAAO;YACH,IAAI;YACJ,MAAM,EAAE,4BAA4B,CAAC,IAAI,EAAE,IAAI,CAAC,iBAAiB,CAAC;SACrE,CAAC;IACN,CAAC;CACJ,CAAA;AA1BY,QAAQ;IADpB,IAAA,2BAAW,EAAC,SAAS,CAAC;GACV,QAAQ,CA0BpB;AA1BY,4BAAQ;AA4BR,QAAA,OAAO,GAAG,IAAA,mCAAkB,EAAW,QAAQ,CAAC,CAAC;AAG9D,MAAa,OAAQ,SAAQ,4BAAwB;IAArD;;QAEW,WAAM,GAAG,IAAA,mCAAkB,GAAE,CAAC;IAkPzC,CAAC;IAhPG;;;OAGG;IACH,IAAW,OAAO;QACd,OAAO,IAAA,eAAO,EAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IAED;;;OAGG;IACH,IAAW,iBAAiB;QACxB,OAAO,IAAA,2BAAU,EAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC;IACjD,CAAC;IAED;;;OAGG;IACH,IAAW,YAAY;QACnB,OAAO,IAAA,cAAM,EAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IACxC,CAAC;IAED;;;OAGG;IACH,IAAW,UAAU;QACjB,OAAO,IAAA,2BAAU,EAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IAC1C,CAAC;IAED;;;OAGG;IACH,IAAW,cAAc;QACrB,OAAO,IAAA,2BAAU,EAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;IAC9C,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,MAAM,CAAC,KAA2B;QAE3C,MAAM,IAAI,GAAG,MAAM,IAAA,4BAAW,EAAC,IAAI,EAAE,IAAA,gBAAI,EAAC,KAAK,CAAC,CAAC,CAAC;QAElD,OAAO;YACH,IAAI;YACJ,MAAM,EAAE,IAAI;SACf,CAAC;IACN,CAAC;IAED;;OAEG;IACI,OAAO;QACV,OAAO,IAAA,uBAAM,EAAC,IAAA,cAAM,EAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAO,CAAI,GAAG,OAAiB;QAExC,MAAM,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC;QACjC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,EAAE,CAAC;QACvC,IAAI,CAAC,CAAC,YAAY,CAAC,EAAE;YACjB,MAAM,KAAK,CAAC,uGAAuG,CAAC,CAAC;SACxH;QACD,OAAO,MAAM,CAAC,MAAM,CAAC,IAAA,eAAI,EAAC,CAAC,IAAI,EAAE,IAAA,gCAAY,EAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3D,CAAC;IAoBM,KAAK,CAAC,UAAU,CAAC,OAAe,EAAE,GAAG,IAAmF;QAE3H,IAAI,OAAO,GAA8B;YACrC,QAAQ,EAAE,KAAK;YACf,uBAAuB,EAAE,IAAI;YAC7B,6BAA6B,EAAE,KAAK;SACvC,CAAC;QAEF,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;YACnB,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE;gBAC9B,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;aAC9B;iBAAM,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE;gBACpC,OAAO,GAAG,EAAE,GAAG,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;aACxC;SACJ;QAED,OAAO,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,kBAAkB,CAAC,CAAC;IACnE,CAAC;IAoBM,KAAK,CAAC,UAAU,CAAC,OAAe,EAAE,GAAG,IAAqF;QAE7H,IAAI,OAAO,GAA8B;YACrC,uBAAuB,EAAE,IAAI;YAC7B,2BAA2B,EAAE,IAAI;YACjC,QAAQ,EAAE,KAAK;SAClB,CAAC;QAEF,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;YACnB,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE;gBAC9B,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;aAC9B;iBAAM,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE;gBACpC,OAAO,GAAG,EAAE,GAAG,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;aACxC;SACJ;QAED,OAAO,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,kBAAkB,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,gBAAgB,CAAC,UAAwC;QAClE,OAAO,IAAA,uBAAM,EAAC,IAAA,cAAM,EAAC,IAAI,EAAE,sBAAsB,CAAC,EAAE,IAAA,gBAAI,EAAC,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;IAC9E,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,qBAAqB,CAAC,QAAgB;QAC/C,MAAM,IAAA,uBAAM,EAAC,IAAA,cAAM,EAAC,IAAI,EAAE,uBAAuB,CAAC,EAAE,IAAA,gBAAI,EAAC,EAAE,QAAQ,EAAE,IAAA,oCAAc,EAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;QAClG,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,cAAc;QAEvB,MAAM,OAAO,GACT,MAAM,IAAI,CAAC,MAAM,CACb,mBAAmB,EACnB,iCAAiC,EACjC,kDAAkD,EAClD,2DAA2D,EAC3D,4DAA4D,EAC5D,2CAA2C,EAC3C,4CAA4C,EAC5C,0DAA0D,EAC1D,2DAA2D,CAC9D,CAAC,MAAM,CACJ,8BAA8B,EAC9B,yCAAyC,EACzC,wCAAwC,CAAC,EAAE,CAAC;QAEpD,OAAO;YACH,MAAM,EAAE;gBACJ,iBAAiB,EAAE,OAAO,CAAC,iBAAiB;aAC/C;YACD,UAAU,EAAE;gBACR,EAAE,EAAE,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAAC,EAAE;gBAC3C,4BAA4B,EAAE,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAAC,UAAU,CAAC,kBAAkB;gBAChG,2BAA2B,EAAE,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAAC,UAAU,CAAC,iBAAiB;gBAC9F,kBAAkB,EAAE,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAAC,UAAU,CAAC,QAAQ;aAC/E;YACD,SAAS,EAAE;gBACP,EAAE,EAAE,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;gBACrD,kBAAkB,EAAE,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAAC,SAAS,CAAC,kBAAkB;gBACrF,iBAAiB,EAAE,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAAC,SAAS,CAAC,iBAAiB;gBACnF,GAAG,EAAE,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAAC,SAAS,CAAC,GAAG;aAC1D;SACJ,CAAC;IACN,CAAC;IAED;;;;;;;OAOG;IACO,YAAY,CAAC,OAAe,EAAE,OAAkC,EAAE,UAAmD;QAE3H,wDAAwD;QACxD,MAAM,MAAM,GAAG,IAAA,cAAM,EAAC,IAAI,CAAC,CAAC;QAE5B,6EAA6E;QAC7E,MAAM,CAAC,EAAE,CAAC,GAAG,CAAC,IAAA,gBAAS,EAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE;YAEhD,MAAM,OAAO,GAAG,MAAM,IAAA,cAAM,EAAC,IAAI,CAAC,CAAC,KAAK,CAAC,IAAA,wBAAU,GAAE,CAAC,CAAC,cAAc,EAAE,CAAC;YAExE,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;YAE3C,GAAG,GAAG,IAAA,cAAO,EAAC,OAAO,CAAC,SAAS,CAAC,GAAG,EAAE,yBAAyB,UAAU,IAAI,CAAC,CAAC;YAE9E,IAAI,GAAG,IAAA,gBAAI,EAAC;gBACR,QAAQ,EAAE,IAAA,oCAAc,EAAC,IAAA,oBAAa,EAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;gBACzF,OAAO;gBACP,OAAO,EAAE,IAAA,oCAAc,EAAC,IAAA,cAAO,EAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;aACjF,EAAE,IAAI,CAAC,CAAC;YAET,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC,CAAC;QAEJ,OAAO,IAAA,uBAAM,EAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IACpE,CAAC;CACJ;AApJG;IADC,2BAAe;yCAkBf;AAoBD;IADC,2BAAe;yCAkBf;AAtJL,0BAoPC;AAEY,QAAA,MAAM,GAAG,IAAA,mCAAkB,EAAU,OAAO,CAAC,CAAC;AAE3D;;;;;;GAMG;AACH,SAAgB,4BAA4B,CAAC,IAAkB,EAAE,kBAA0B;IAEvF,OAAO,IAAA,cAAM,EAAC,CAAC,IAAI,EAAE,IAAA,kCAAa,EAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,sDAAsD,IAAA,+BAAU,EAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;AACjJ,CAAC;AAHD,oEAGC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,sBAAsB,CAAC,IAAkB,EAAE,kBAA0B;IAEvF,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,IAAA,cAAM,EAAC,IAAI,CAAC,CAAC,KAAK,CAAC,IAAA,wBAAU,GAAE,CAAC,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;IACjG,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,GAAG,CAAC,kBAAkB,CAAC,CAAC;IACjD,OAAO,4BAA4B,CAAC,IAAA,cAAM,EAAC,CAAC,IAAI,EAAE,IAAA,cAAO,EAAC,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAAC;AACvH,CAAC;AALD,wDAKC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,cAAc,CAAC,IAAkB,EAAE,IAAY;IACjE,OAAO,CAAC,IAAA,oBAAa,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,4BAA4B,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AACrG,CAAC;AAFD,wCAEC"}
@@ -0,0 +1,33 @@
1
+ import { IFolders, IFolder } from "./types.js";
2
+ declare module "../webs/types" {
3
+ interface _Web {
4
+ readonly folders: IFolders;
5
+ readonly rootFolder: IFolder;
6
+ getFolderByServerRelativePath(folderRelativeUrl: string): IFolder;
7
+ getFolderById(uniqueId: string): IFolder;
8
+ }
9
+ interface IWeb {
10
+ /**
11
+ * Gets the collection of folders in this web
12
+ */
13
+ readonly folders: IFolders;
14
+ /**
15
+ * Gets the root folder of the web
16
+ */
17
+ readonly rootFolder: IFolder;
18
+ /**
19
+ * Gets a folder by server relative path if your folder name contains # and % characters
20
+ * This works only in SharePoint online.
21
+ *
22
+ * @param folderRelativeUrl The server relative path to the folder (including /sites/ if applicable)
23
+ */
24
+ getFolderByServerRelativePath(folderRelativeUrl: string): IFolder;
25
+ /**
26
+ * Gets a folder by id
27
+ *
28
+ * @param uniqueId The UniqueId of the folder
29
+ */
30
+ getFolderById(uniqueId: string): IFolder;
31
+ }
32
+ }
33
+ //# sourceMappingURL=web.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"web.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/folders/web.ts"],"names":[],"mappings":"AAEA,OAAO,EAAW,QAAQ,EAAU,OAAO,EAAgC,MAAM,YAAY,CAAC;AAE9F,OAAO,QAAQ,eAAe,CAAC;IAC3B,UAAU,IAAI;QACV,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC;QAC3B,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;QAC7B,6BAA6B,CAAC,iBAAiB,EAAE,MAAM,GAAG,OAAO,CAAC;QAClE,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;KAC5C;IACD,UAAU,IAAI;QAEV;;WAEG;QACH,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC;QAE3B;;WAEG;QACH,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;QAE7B;;;;;WAKG;QACH,6BAA6B,CAAC,iBAAiB,EAAE,MAAM,GAAG,OAAO,CAAC;QAElE;;;;WAIG;QACH,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;KAC5C;CACJ"}
@@ -0,0 +1,14 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const queryable_1 = require("@pnp/queryable");
4
+ const types_js_1 = require("../webs/types.js");
5
+ const types_js_2 = require("./types.js");
6
+ (0, queryable_1.addProp)(types_js_1._Web, "folders", types_js_2.Folders);
7
+ (0, queryable_1.addProp)(types_js_1._Web, "rootFolder", types_js_2.Folder);
8
+ types_js_1._Web.prototype.getFolderByServerRelativePath = function (folderRelativeUrl) {
9
+ return (0, types_js_2.folderFromServerRelativePath)(this, folderRelativeUrl);
10
+ };
11
+ types_js_1._Web.prototype.getFolderById = function (uniqueId) {
12
+ return (0, types_js_2.Folder)(this, `getFolderById('${uniqueId}')`);
13
+ };
14
+ //# sourceMappingURL=web.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"web.js","sourceRoot":"","sources":["../../../../../packages/sp/folders/web.ts"],"names":[],"mappings":";;AAAA,8CAAyC;AACzC,+CAAwC;AACxC,yCAA8F;AAsC9F,IAAA,mBAAO,EAAC,eAAI,EAAE,SAAS,EAAE,kBAAO,CAAC,CAAC;AAClC,IAAA,mBAAO,EAAC,eAAI,EAAE,YAAY,EAAE,iBAAM,CAAC,CAAC;AAEpC,eAAI,CAAC,SAAS,CAAC,6BAA6B,GAAG,UAAsB,iBAAyB;IAC1F,OAAO,IAAA,uCAA4B,EAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;AACjE,CAAC,CAAC;AAEF,eAAI,CAAC,SAAS,CAAC,aAAa,GAAG,UAAsB,QAAgB;IACjE,OAAO,IAAA,iBAAM,EAAC,IAAI,EAAE,kBAAkB,QAAQ,IAAI,CAAC,CAAC;AACxD,CAAC,CAAC"}