@zxncij2390/monorepo3 3.18.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (921) hide show
  1. package/.eslintignore +16 -0
  2. package/.eslintrc.cjs +150 -0
  3. package/.github/ISSUE_TEMPLATE/bug-report.yml +178 -0
  4. package/.github/ISSUE_TEMPLATE/enhancement.yml +99 -0
  5. package/.github/ISSUE_TEMPLATE/question.yml +72 -0
  6. package/.github/ISSUE_TEMPLATE.md +39 -0
  7. package/.github/PULL_REQUEST_TEMPLATE.md +24 -0
  8. package/.github/workflows/lock.yml +18 -0
  9. package/.github/workflows/publish-buildsystem.yml +34 -0
  10. package/.github/workflows/publish-docs.yml +21 -0
  11. package/.github/workflows/publish.yml +40 -0
  12. package/.github/workflows/pull_request.yaml +28 -0
  13. package/.github/workflows/push.yaml +32 -0
  14. package/.github/workflows/v3-nightly.yml +40 -0
  15. package/.mocharc.cjs +68 -0
  16. package/.vscode/launch.json +103 -0
  17. package/.vscode/settings.json +17 -0
  18. package/.vscode/tasks.json +124 -0
  19. package/AUTHORS +13 -0
  20. package/CHANGELOG.md +33 -0
  21. package/CODE_OF_CONDUCT.md +6 -0
  22. package/CONTRIBUTING.md +9 -0
  23. package/LICENSE +25 -0
  24. package/README.md +66 -0
  25. package/buildsystem-config.ts +146 -0
  26. package/debug/launch/graph.ts +20 -0
  27. package/debug/launch/main.ts +38 -0
  28. package/debug/launch/setup.ts +50 -0
  29. package/debug/launch/sp.ts +21 -0
  30. package/debug/launch/tsconfig.json +27 -0
  31. package/debug/serve/main.ts +47 -0
  32. package/debug/serve/plumbing/local-module-resolver-plugin.ts +68 -0
  33. package/debug/serve/plumbing/run.ts +24 -0
  34. package/debug/serve/plumbing/serve.ts +27 -0
  35. package/debug/serve/plumbing/webpack.config.ts +43 -0
  36. package/debug/serve/spa.html +12 -0
  37. package/debug/serve/tsconfig.json +15 -0
  38. package/debug/spfx/.eslintrc.js +352 -0
  39. package/debug/spfx/README.md +73 -0
  40. package/debug/spfx/package-lock.json +57299 -0
  41. package/debug/spfx/package.json +38 -0
  42. package/debug/spfx/pnpjs-local-debug-start.js +19 -0
  43. package/debug/spfx/teams/f4c0e5ff-c402-46b7-8073-8cc506808d06_color.png +0 -0
  44. package/debug/spfx/teams/f4c0e5ff-c402-46b7-8073-8cc506808d06_outline.png +0 -0
  45. package/docs/_theme/main.html +5 -0
  46. package/docs/azidjsclient/index.md +36 -0
  47. package/docs/concepts/adv-clientside-pages.md +169 -0
  48. package/docs/concepts/auth-browser.md +42 -0
  49. package/docs/concepts/auth-nodejs.md +101 -0
  50. package/docs/concepts/auth-spfx.md +76 -0
  51. package/docs/concepts/authentication.md +42 -0
  52. package/docs/concepts/batching-caching.md +77 -0
  53. package/docs/concepts/batching.md +257 -0
  54. package/docs/concepts/calling-other-endpoints.md +213 -0
  55. package/docs/concepts/custom-bundle.md +15 -0
  56. package/docs/concepts/error-handling.md +245 -0
  57. package/docs/concepts/invokable.md +7 -0
  58. package/docs/concepts/nightly-builds.md +19 -0
  59. package/docs/concepts/project-preset.md +123 -0
  60. package/docs/concepts/selective-imports.md +106 -0
  61. package/docs/concepts/typings.md +23 -0
  62. package/docs/contributing/debug-tests.md +76 -0
  63. package/docs/contributing/debugging.md +135 -0
  64. package/docs/contributing/documentation.md +34 -0
  65. package/docs/contributing/extending-the-library.md +223 -0
  66. package/docs/contributing/index.md +22 -0
  67. package/docs/contributing/local-debug-configuration.md +28 -0
  68. package/docs/contributing/npm-scripts.md +148 -0
  69. package/docs/contributing/pull-requests.md +27 -0
  70. package/docs/contributing/settings.md +98 -0
  71. package/docs/contributing/setup-dev-machine.md +36 -0
  72. package/docs/core/behavior-recipes.md +199 -0
  73. package/docs/core/behaviors.md +179 -0
  74. package/docs/core/moments.md +215 -0
  75. package/docs/core/observers.md +100 -0
  76. package/docs/core/storage.md +90 -0
  77. package/docs/core/timeline.md +190 -0
  78. package/docs/core/util.md +191 -0
  79. package/docs/css/extra.css +33 -0
  80. package/docs/getting-started.md +361 -0
  81. package/docs/graph/behaviors.md +267 -0
  82. package/docs/graph/bookings.md +180 -0
  83. package/docs/graph/calendars.md +270 -0
  84. package/docs/graph/cloud-communications.md +40 -0
  85. package/docs/graph/columns.md +125 -0
  86. package/docs/graph/contacts.md +298 -0
  87. package/docs/graph/content-types.md +193 -0
  88. package/docs/graph/directoryobjects.md +106 -0
  89. package/docs/graph/groups.md +164 -0
  90. package/docs/graph/insights.md +151 -0
  91. package/docs/graph/invitations.md +22 -0
  92. package/docs/graph/items.md +38 -0
  93. package/docs/graph/lists.md +87 -0
  94. package/docs/graph/messages.md +20 -0
  95. package/docs/graph/onedrive.md +614 -0
  96. package/docs/graph/outlook.md +82 -0
  97. package/docs/graph/photos.md +71 -0
  98. package/docs/graph/planner.md +249 -0
  99. package/docs/graph/search.md +25 -0
  100. package/docs/graph/shares.md +44 -0
  101. package/docs/graph/sites.md +47 -0
  102. package/docs/graph/subscriptions.md +79 -0
  103. package/docs/graph/teams.md +293 -0
  104. package/docs/graph/users.md +134 -0
  105. package/docs/img/ConsoleListenerColors.png +0 -0
  106. package/docs/img/Logo.png +0 -0
  107. package/docs/img/PnPJS_FluentAPI.gif +0 -0
  108. package/docs/img/SPFx-On-Premesis-2016-1.png +0 -0
  109. package/docs/img/TimelineArchitecture.jpg +0 -0
  110. package/docs/img/csp_copyccvalue.png +0 -0
  111. package/docs/img/csp_networktab.png +0 -0
  112. package/docs/img/office365-header-icon.png +0 -0
  113. package/docs/img/usage-2020-eoy.png +0 -0
  114. package/docs/img/usage-2021-eoy.png +0 -0
  115. package/docs/img/usage-2022-eoy.png +0 -0
  116. package/docs/index.md +56 -0
  117. package/docs/logging/index.md +262 -0
  118. package/docs/msaljsclient/index.md +33 -0
  119. package/docs/news/2020-year-in-review.md +162 -0
  120. package/docs/news/2021-year-in-review.md +148 -0
  121. package/docs/news/2022-year-in-review.md +122 -0
  122. package/docs/nodejs/behaviors.md +164 -0
  123. package/docs/nodejs/sp-extensions.md +99 -0
  124. package/docs/packages.md +53 -0
  125. package/docs/queryable/behaviors.md +496 -0
  126. package/docs/queryable/extensions.md +204 -0
  127. package/docs/queryable/queryable.md +385 -0
  128. package/docs/sp/alias-parameters.md +76 -0
  129. package/docs/sp/alm.md +139 -0
  130. package/docs/sp/attachments.md +157 -0
  131. package/docs/sp/behaviors.md +142 -0
  132. package/docs/sp/clientside-pages.md +1048 -0
  133. package/docs/sp/column-defaults.md +241 -0
  134. package/docs/sp/comments-likes.md +302 -0
  135. package/docs/sp/content-types.md +131 -0
  136. package/docs/sp/context-info.md +67 -0
  137. package/docs/sp/favorites.md +91 -0
  138. package/docs/sp/features.md +83 -0
  139. package/docs/sp/fields.md +668 -0
  140. package/docs/sp/files.md +559 -0
  141. package/docs/sp/folders.md +532 -0
  142. package/docs/sp/forms.md +22 -0
  143. package/docs/sp/groupSiteManager.md +40 -0
  144. package/docs/sp/hubsites.md +140 -0
  145. package/docs/sp/items.md +601 -0
  146. package/docs/sp/lists.md +572 -0
  147. package/docs/sp/navigation.md +171 -0
  148. package/docs/sp/permissions.md +82 -0
  149. package/docs/sp/profiles.md +407 -0
  150. package/docs/sp/publishing-sitepageservice.md +16 -0
  151. package/docs/sp/recycle-bin.md +72 -0
  152. package/docs/sp/regional-settings.md +108 -0
  153. package/docs/sp/related-items.md +136 -0
  154. package/docs/sp/search.md +207 -0
  155. package/docs/sp/security.md +196 -0
  156. package/docs/sp/sharing.md +273 -0
  157. package/docs/sp/site-designs.md +117 -0
  158. package/docs/sp/site-groups.md +144 -0
  159. package/docs/sp/site-scripts.md +123 -0
  160. package/docs/sp/site-users.md +211 -0
  161. package/docs/sp/sites.md +269 -0
  162. package/docs/sp/social.md +182 -0
  163. package/docs/sp/sp-utilities-utility.md +159 -0
  164. package/docs/sp/subscriptions.md +79 -0
  165. package/docs/sp/taxonomy.md +470 -0
  166. package/docs/sp/tenant-properties.md +55 -0
  167. package/docs/sp/user-custom-actions.md +95 -0
  168. package/docs/sp/views.md +226 -0
  169. package/docs/sp/webs.md +947 -0
  170. package/docs/sp-admin/index.md +139 -0
  171. package/docs/transition-guide.md +87 -0
  172. package/docs/v1/404.html +1611 -0
  173. package/docs/v1/assets/fonts/font-awesome.css +4 -0
  174. package/docs/v1/assets/fonts/material-icons.css +13 -0
  175. package/docs/v1/assets/fonts/specimen/FontAwesome.ttf +0 -0
  176. package/docs/v1/assets/fonts/specimen/FontAwesome.woff +0 -0
  177. package/docs/v1/assets/fonts/specimen/FontAwesome.woff2 +0 -0
  178. package/docs/v1/assets/fonts/specimen/MaterialIcons-Regular.ttf +0 -0
  179. package/docs/v1/assets/fonts/specimen/MaterialIcons-Regular.woff +0 -0
  180. package/docs/v1/assets/fonts/specimen/MaterialIcons-Regular.woff2 +0 -0
  181. package/docs/v1/assets/images/favicon.png +0 -0
  182. package/docs/v1/assets/images/icons/bitbucket.1b09e088.svg +20 -0
  183. package/docs/v1/assets/images/icons/github.f0b8504a.svg +18 -0
  184. package/docs/v1/assets/images/icons/gitlab.6dd19c00.svg +38 -0
  185. package/docs/v1/assets/javascripts/application.583bbe55.js +1 -0
  186. package/docs/v1/assets/javascripts/lunr/lunr.da.js +1 -0
  187. package/docs/v1/assets/javascripts/lunr/lunr.de.js +1 -0
  188. package/docs/v1/assets/javascripts/lunr/lunr.du.js +1 -0
  189. package/docs/v1/assets/javascripts/lunr/lunr.es.js +1 -0
  190. package/docs/v1/assets/javascripts/lunr/lunr.fi.js +1 -0
  191. package/docs/v1/assets/javascripts/lunr/lunr.fr.js +1 -0
  192. package/docs/v1/assets/javascripts/lunr/lunr.hu.js +1 -0
  193. package/docs/v1/assets/javascripts/lunr/lunr.it.js +1 -0
  194. package/docs/v1/assets/javascripts/lunr/lunr.jp.js +1 -0
  195. package/docs/v1/assets/javascripts/lunr/lunr.multi.js +1 -0
  196. package/docs/v1/assets/javascripts/lunr/lunr.no.js +1 -0
  197. package/docs/v1/assets/javascripts/lunr/lunr.pt.js +1 -0
  198. package/docs/v1/assets/javascripts/lunr/lunr.ro.js +1 -0
  199. package/docs/v1/assets/javascripts/lunr/lunr.ru.js +1 -0
  200. package/docs/v1/assets/javascripts/lunr/lunr.stemmer.support.js +1 -0
  201. package/docs/v1/assets/javascripts/lunr/lunr.sv.js +1 -0
  202. package/docs/v1/assets/javascripts/lunr/lunr.tr.js +1 -0
  203. package/docs/v1/assets/javascripts/lunr/tinyseg.js +1 -0
  204. package/docs/v1/assets/javascripts/modernizr.1aa3b519.js +1 -0
  205. package/docs/v1/assets/stylesheets/application-palette.22915126.css +1176 -0
  206. package/docs/v1/assets/stylesheets/application.451f80e5.css +2552 -0
  207. package/docs/v1/common/docs/adalclient/index.html +1994 -0
  208. package/docs/v1/common/docs/collections/index.html +1786 -0
  209. package/docs/v1/common/docs/custom-httpclientimpl/index.html +1798 -0
  210. package/docs/v1/common/docs/index.html +1787 -0
  211. package/docs/v1/common/docs/libconfig/index.html +1930 -0
  212. package/docs/v1/common/docs/netutil/index.html +1860 -0
  213. package/docs/v1/common/docs/storage/index.html +1850 -0
  214. package/docs/v1/common/docs/util/index.html +2058 -0
  215. package/docs/v1/config-store/docs/configuration/index.html +1730 -0
  216. package/docs/v1/config-store/docs/index.html +1761 -0
  217. package/docs/v1/config-store/docs/providers/index.html +1782 -0
  218. package/docs/v1/documentation/SPFx-On-Premesis-2016/index.html +1720 -0
  219. package/docs/v1/documentation/beta-versions/index.html +1742 -0
  220. package/docs/v1/documentation/css/extra.css +33 -0
  221. package/docs/v1/documentation/debugging/index.html +2098 -0
  222. package/docs/v1/documentation/deployment/index.html +1972 -0
  223. package/docs/v1/documentation/documentation/index.html +1760 -0
  224. package/docs/v1/documentation/getting-started/index.html +2280 -0
  225. package/docs/v1/documentation/getting-started-dev/index.html +1799 -0
  226. package/docs/v1/documentation/gulp-commands/index.html +2100 -0
  227. package/docs/v1/documentation/img/Logo.png +0 -0
  228. package/docs/v1/documentation/img/PnPJS_FluentAPI.gif +0 -0
  229. package/docs/v1/documentation/img/SPFx-On-Premesis-2016-1.png +0 -0
  230. package/docs/v1/documentation/img/office365-header-icon.png +0 -0
  231. package/docs/v1/documentation/img/pnpjs-common-uml.svg +220 -0
  232. package/docs/v1/documentation/img/pnpjs-config-store-uml.svg +56 -0
  233. package/docs/v1/documentation/img/pnpjs-graph-uml.svg +602 -0
  234. package/docs/v1/documentation/img/pnpjs-logging-uml.svg +59 -0
  235. package/docs/v1/documentation/img/pnpjs-nodejs-uml.svg +85 -0
  236. package/docs/v1/documentation/img/pnpjs-odata-uml.svg +253 -0
  237. package/docs/v1/documentation/img/pnpjs-sp-addinhelpers-uml.svg +48 -0
  238. package/docs/v1/documentation/img/pnpjs-sp-clientsvc-uml.svg +167 -0
  239. package/docs/v1/documentation/img/pnpjs-sp-taxonomy-uml.svg +458 -0
  240. package/docs/v1/documentation/img/pnpjs-sp-uml.svg +2833 -0
  241. package/docs/v1/documentation/package-structure/index.html +1875 -0
  242. package/docs/v1/documentation/packages/index.html +1741 -0
  243. package/docs/v1/documentation/polyfill/index.html +1877 -0
  244. package/docs/v1/documentation/theme/main.html +5 -0
  245. package/docs/v1/documentation/transition-guide/index.html +1977 -0
  246. package/docs/v1/graph/docs/contacts/index.html +2080 -0
  247. package/docs/v1/graph/docs/directoryobjects/index.html +1865 -0
  248. package/docs/v1/graph/docs/index.html +1858 -0
  249. package/docs/v1/graph/docs/insights/index.html +1698 -0
  250. package/docs/v1/graph/docs/invitations/index.html +1742 -0
  251. package/docs/v1/graph/docs/onedrive/index.html +2086 -0
  252. package/docs/v1/graph/docs/people/index.html +1664 -0
  253. package/docs/v1/graph/docs/planner/index.html +2097 -0
  254. package/docs/v1/graph/docs/security/index.html +1692 -0
  255. package/docs/v1/graph/docs/sites/index.html +2043 -0
  256. package/docs/v1/graph/docs/subscriptions/index.html +1835 -0
  257. package/docs/v1/graph/docs/teams/index.html +2097 -0
  258. package/docs/v1/index.html +1889 -0
  259. package/docs/v1/logging/docs/index.html +2045 -0
  260. package/docs/v1/nodejs/docs/adal-certificate-fetch-client/index.html +1676 -0
  261. package/docs/v1/nodejs/docs/adal-fetch-client/index.html +1713 -0
  262. package/docs/v1/nodejs/docs/bearer-token-fetch-client/index.html +1712 -0
  263. package/docs/v1/nodejs/docs/index.html +1764 -0
  264. package/docs/v1/nodejs/docs/provider-hosted-app/index.html +1725 -0
  265. package/docs/v1/nodejs/docs/proxy/index.html +1699 -0
  266. package/docs/v1/nodejs/docs/sp-fetch-client/index.html +1895 -0
  267. package/docs/v1/odata/docs/caching/index.html +1988 -0
  268. package/docs/v1/odata/docs/core/index.html +1829 -0
  269. package/docs/v1/odata/docs/index.html +1781 -0
  270. package/docs/v1/odata/docs/odata-batch/index.html +1755 -0
  271. package/docs/v1/odata/docs/parsers/index.html +1862 -0
  272. package/docs/v1/odata/docs/pipeline/index.html +1811 -0
  273. package/docs/v1/odata/docs/queryable/index.html +1967 -0
  274. package/docs/v1/pnpjs/docs/index.html +1814 -0
  275. package/docs/v1/search/search_index.json +1 -0
  276. package/docs/v1/sitemap.xml +428 -0
  277. package/docs/v1/sitemap.xml.gz +0 -0
  278. package/docs/v1/sp/docs/alias-parameters/index.html +1830 -0
  279. package/docs/v1/sp/docs/alm/index.html +1920 -0
  280. package/docs/v1/sp/docs/attachments/index.html +1998 -0
  281. package/docs/v1/sp/docs/client-side-pages/index.html +2031 -0
  282. package/docs/v1/sp/docs/comments-likes/index.html +1958 -0
  283. package/docs/v1/sp/docs/content-types/index.html +1758 -0
  284. package/docs/v1/sp/docs/entity-merging/index.html +1838 -0
  285. package/docs/v1/sp/docs/features/index.html +1824 -0
  286. package/docs/v1/sp/docs/fields/index.html +2031 -0
  287. package/docs/v1/sp/docs/files/index.html +2178 -0
  288. package/docs/v1/sp/docs/index.html +1894 -0
  289. package/docs/v1/sp/docs/items/index.html +2362 -0
  290. package/docs/v1/sp/docs/navigation-service/index.html +1791 -0
  291. package/docs/v1/sp/docs/permissions/index.html +1860 -0
  292. package/docs/v1/sp/docs/profiles/index.html +1794 -0
  293. package/docs/v1/sp/docs/related-items/index.html +1886 -0
  294. package/docs/v1/sp/docs/search/index.html +1830 -0
  295. package/docs/v1/sp/docs/sharing/index.html +2058 -0
  296. package/docs/v1/sp/docs/sitedesigns/index.html +1851 -0
  297. package/docs/v1/sp/docs/sites/index.html +2186 -0
  298. package/docs/v1/sp/docs/social/index.html +2011 -0
  299. package/docs/v1/sp/docs/sp-utilities-utility/index.html +2061 -0
  300. package/docs/v1/sp/docs/tenant-properties/index.html +1795 -0
  301. package/docs/v1/sp/docs/views/index.html +1869 -0
  302. package/docs/v1/sp/docs/webs/index.html +1972 -0
  303. package/docs/v1/sp-addinhelpers/docs/index.html +1771 -0
  304. package/docs/v1/sp-addinhelpers/docs/sp-request-executor-client/index.html +1760 -0
  305. package/docs/v1/sp-addinhelpers/docs/sp-rest-addin/index.html +1711 -0
  306. package/docs/v1/sp-clientsvc/docs/index.html +1736 -0
  307. package/docs/v1/sp-taxonomy/docs/index.html +1887 -0
  308. package/docs/v1/sp-taxonomy/docs/labels/index.html +1827 -0
  309. package/docs/v1/sp-taxonomy/docs/term-groups/index.html +1875 -0
  310. package/docs/v1/sp-taxonomy/docs/term-sets/index.html +1946 -0
  311. package/docs/v1/sp-taxonomy/docs/term-stores/index.html +2111 -0
  312. package/docs/v1/sp-taxonomy/docs/terms/index.html +2036 -0
  313. package/docs/v1/sp-taxonomy/docs/utilities/index.html +1783 -0
  314. package/docs/v2/404.html +2108 -0
  315. package/docs/v2/SPFx-on-premises/index.html +2278 -0
  316. package/docs/v2/_theme/main.html +5 -0
  317. package/docs/v2/adaljsclient/adalclient/index.html +15 -0
  318. package/docs/v2/adaljsclient/index.html +15 -0
  319. package/docs/v2/assets/images/favicon.png +0 -0
  320. package/docs/v2/assets/javascripts/bundle.9554a270.min.js +2 -0
  321. package/docs/v2/assets/javascripts/bundle.9554a270.min.js.map +1 -0
  322. package/docs/v2/assets/javascripts/lunr/min/lunr.ar.min.js +1 -0
  323. package/docs/v2/assets/javascripts/lunr/min/lunr.da.min.js +18 -0
  324. package/docs/v2/assets/javascripts/lunr/min/lunr.de.min.js +18 -0
  325. package/docs/v2/assets/javascripts/lunr/min/lunr.du.min.js +18 -0
  326. package/docs/v2/assets/javascripts/lunr/min/lunr.es.min.js +18 -0
  327. package/docs/v2/assets/javascripts/lunr/min/lunr.fi.min.js +18 -0
  328. package/docs/v2/assets/javascripts/lunr/min/lunr.fr.min.js +18 -0
  329. package/docs/v2/assets/javascripts/lunr/min/lunr.hu.min.js +18 -0
  330. package/docs/v2/assets/javascripts/lunr/min/lunr.it.min.js +18 -0
  331. package/docs/v2/assets/javascripts/lunr/min/lunr.ja.min.js +1 -0
  332. package/docs/v2/assets/javascripts/lunr/min/lunr.jp.min.js +1 -0
  333. package/docs/v2/assets/javascripts/lunr/min/lunr.multi.min.js +1 -0
  334. package/docs/v2/assets/javascripts/lunr/min/lunr.nl.min.js +18 -0
  335. package/docs/v2/assets/javascripts/lunr/min/lunr.no.min.js +18 -0
  336. package/docs/v2/assets/javascripts/lunr/min/lunr.pt.min.js +18 -0
  337. package/docs/v2/assets/javascripts/lunr/min/lunr.ro.min.js +18 -0
  338. package/docs/v2/assets/javascripts/lunr/min/lunr.ru.min.js +18 -0
  339. package/docs/v2/assets/javascripts/lunr/min/lunr.stemmer.support.min.js +1 -0
  340. package/docs/v2/assets/javascripts/lunr/min/lunr.sv.min.js +18 -0
  341. package/docs/v2/assets/javascripts/lunr/min/lunr.tr.min.js +18 -0
  342. package/docs/v2/assets/javascripts/lunr/min/lunr.vi.min.js +1 -0
  343. package/docs/v2/assets/javascripts/lunr/tinyseg.min.js +1 -0
  344. package/docs/v2/assets/javascripts/vendor.77e55a48.min.js +30 -0
  345. package/docs/v2/assets/javascripts/vendor.77e55a48.min.js.map +1 -0
  346. package/docs/v2/assets/javascripts/worker/search.4ac00218.min.js +59 -0
  347. package/docs/v2/assets/javascripts/worker/search.4ac00218.min.js.map +1 -0
  348. package/docs/v2/assets/stylesheets/main.38780c08.min.css +3 -0
  349. package/docs/v2/assets/stylesheets/main.38780c08.min.css.map +1 -0
  350. package/docs/v2/assets/stylesheets/palette.3f72e892.min.css +3 -0
  351. package/docs/v2/assets/stylesheets/palette.3f72e892.min.css.map +1 -0
  352. package/docs/v2/authentication/adaljsclient/index.html +2510 -0
  353. package/docs/v2/authentication/bearertokenclient/index.html +2251 -0
  354. package/docs/v2/authentication/client-spa/index.html +2206 -0
  355. package/docs/v2/authentication/client-spfx/index.html +2397 -0
  356. package/docs/v2/authentication/index.html +2307 -0
  357. package/docs/v2/authentication/lambdaclient/index.html +2304 -0
  358. package/docs/v2/authentication/msaljsclient/index.html +2413 -0
  359. package/docs/v2/authentication/server-nodejs/index.html +2404 -0
  360. package/docs/v2/authentication/sp-app-registration/index.html +2273 -0
  361. package/docs/v2/common/collections/index.html +2277 -0
  362. package/docs/v2/common/custom-httpclientimpl/index.html +2300 -0
  363. package/docs/v2/common/index.html +2262 -0
  364. package/docs/v2/common/libconfig/index.html +2413 -0
  365. package/docs/v2/common/netutil/index.html +2350 -0
  366. package/docs/v2/common/storage/index.html +2339 -0
  367. package/docs/v2/common/util/index.html +2638 -0
  368. package/docs/v2/concepts/configuration/index.html +2685 -0
  369. package/docs/v2/concepts/custom-bundle/index.html +2279 -0
  370. package/docs/v2/concepts/error-handling/index.html +2539 -0
  371. package/docs/v2/concepts/ie11-mode/index.html +2278 -0
  372. package/docs/v2/concepts/invokable/index.html +2254 -0
  373. package/docs/v2/concepts/polyfill/index.html +2401 -0
  374. package/docs/v2/concepts/selective-imports/index.html +2360 -0
  375. package/docs/v2/concepts/settings/index.html +2551 -0
  376. package/docs/v2/config-store/configuration/index.html +2226 -0
  377. package/docs/v2/config-store/index.html +2239 -0
  378. package/docs/v2/config-store/providers/index.html +2275 -0
  379. package/docs/v2/contributing/debug-tests/index.html +2323 -0
  380. package/docs/v2/contributing/debugging/index.html +2514 -0
  381. package/docs/v2/contributing/documentation/index.html +2291 -0
  382. package/docs/v2/contributing/extending-the-library/index.html +2521 -0
  383. package/docs/v2/contributing/index.html +2270 -0
  384. package/docs/v2/contributing/local-debug-configuration/index.html +2284 -0
  385. package/docs/v2/contributing/pull-requests/index.html +2261 -0
  386. package/docs/v2/contributing/setup-dev-machine/index.html +2284 -0
  387. package/docs/v2/css/extra.css +33 -0
  388. package/docs/v2/debug-tests/index.html +15 -0
  389. package/docs/v2/debugging/index.html +15 -0
  390. package/docs/v2/documentation/index.html +15 -0
  391. package/docs/v2/getting-started/index.html +2789 -0
  392. package/docs/v2/getting-started-dev/index.html +15 -0
  393. package/docs/v2/graph/calendars/index.html +2569 -0
  394. package/docs/v2/graph/contacts/index.html +2673 -0
  395. package/docs/v2/graph/directoryobjects/index.html +2402 -0
  396. package/docs/v2/graph/groups/index.html +2488 -0
  397. package/docs/v2/graph/index.html +2333 -0
  398. package/docs/v2/graph/insights/index.html +2478 -0
  399. package/docs/v2/graph/invitations/index.html +2273 -0
  400. package/docs/v2/graph/onedrive/index.html +2617 -0
  401. package/docs/v2/graph/outlook/index.html +2363 -0
  402. package/docs/v2/graph/photos/index.html +2351 -0
  403. package/docs/v2/graph/planner/index.html +2628 -0
  404. package/docs/v2/graph/search/index.html +2264 -0
  405. package/docs/v2/graph/subscriptions/index.html +2333 -0
  406. package/docs/v2/graph/teams/index.html +2619 -0
  407. package/docs/v2/graph/users/index.html +2461 -0
  408. package/docs/v2/img/ConsoleListenerColors.png +0 -0
  409. package/docs/v2/img/Logo.png +0 -0
  410. package/docs/v2/img/PnPJS_FluentAPI.gif +0 -0
  411. package/docs/v2/img/SPFx-On-Premesis-2016-1.png +0 -0
  412. package/docs/v2/img/office365-header-icon.png +0 -0
  413. package/docs/v2/img/usage-2020-eoy.png +0 -0
  414. package/docs/v2/index.html +2410 -0
  415. package/docs/v2/logging/index.html +2622 -0
  416. package/docs/v2/news/2020-year-in-review/index.html +2525 -0
  417. package/docs/v2/nodejs/adal-fetch-client/index.html +2204 -0
  418. package/docs/v2/nodejs/bearer-token-fetch-client/index.html +2203 -0
  419. package/docs/v2/nodejs/index.html +2261 -0
  420. package/docs/v2/nodejs/provider-hosted-app/index.html +2220 -0
  421. package/docs/v2/nodejs/proxy/index.html +2238 -0
  422. package/docs/v2/nodejs/sp-extensions/index.html +2362 -0
  423. package/docs/v2/nodejs/sp-fetch-client/index.html +2294 -0
  424. package/docs/v2/nodejs-support/index.html +2398 -0
  425. package/docs/v2/npm-scripts/index.html +2521 -0
  426. package/docs/v2/odata/caching/index.html +2465 -0
  427. package/docs/v2/odata/core/index.html +2322 -0
  428. package/docs/v2/odata/debug/index.html +2358 -0
  429. package/docs/v2/odata/extensions/index.html +2581 -0
  430. package/docs/v2/odata/index.html +2259 -0
  431. package/docs/v2/odata/odata-batch/index.html +2250 -0
  432. package/docs/v2/odata/parsers/index.html +2355 -0
  433. package/docs/v2/odata/pipeline/index.html +2297 -0
  434. package/docs/v2/odata/queryable/index.html +2455 -0
  435. package/docs/v2/packages/index.html +2251 -0
  436. package/docs/v2/pnpjs/index.html +2281 -0
  437. package/docs/v2/search/search_index.json +1 -0
  438. package/docs/v2/sitemap.xml +483 -0
  439. package/docs/v2/sitemap.xml.gz +0 -0
  440. package/docs/v2/sp/alias-parameters/index.html +2330 -0
  441. package/docs/v2/sp/alm/index.html +2433 -0
  442. package/docs/v2/sp/attachments/index.html +2504 -0
  443. package/docs/v2/sp/clientside-pages/index.html +3477 -0
  444. package/docs/v2/sp/column-defaults/index.html +2540 -0
  445. package/docs/v2/sp/comments-likes/index.html +2646 -0
  446. package/docs/v2/sp/content-types/index.html +2462 -0
  447. package/docs/v2/sp/custom-irequestclient/index.html +2339 -0
  448. package/docs/v2/sp/entity-merging/index.html +2325 -0
  449. package/docs/v2/sp/features/index.html +2440 -0
  450. package/docs/v2/sp/fields/index.html +3103 -0
  451. package/docs/v2/sp/files/index.html +2949 -0
  452. package/docs/v2/sp/folders/index.html +2968 -0
  453. package/docs/v2/sp/forms/index.html +2289 -0
  454. package/docs/v2/sp/hubsites/index.html +2485 -0
  455. package/docs/v2/sp/index.html +2328 -0
  456. package/docs/v2/sp/items/index.html +2974 -0
  457. package/docs/v2/sp/lists/index.html +3387 -0
  458. package/docs/v2/sp/navigation/index.html +2535 -0
  459. package/docs/v2/sp/permissions/index.html +2338 -0
  460. package/docs/v2/sp/profiles/index.html +2806 -0
  461. package/docs/v2/sp/regional-settings/index.html +2394 -0
  462. package/docs/v2/sp/related-items/index.html +2417 -0
  463. package/docs/v2/sp/search/index.html +2474 -0
  464. package/docs/v2/sp/security/index.html +2432 -0
  465. package/docs/v2/sp/sharing/index.html +2589 -0
  466. package/docs/v2/sp/site-designs/index.html +2414 -0
  467. package/docs/v2/sp/site-groups/index.html +2504 -0
  468. package/docs/v2/sp/site-scripts/index.html +2433 -0
  469. package/docs/v2/sp/site-users/index.html +2641 -0
  470. package/docs/v2/sp/sites/index.html +2727 -0
  471. package/docs/v2/sp/social/index.html +2517 -0
  472. package/docs/v2/sp/sp-utilities-utility/index.html +2460 -0
  473. package/docs/v2/sp/subscriptions/index.html +2395 -0
  474. package/docs/v2/sp/taxonomy/index.html +2565 -0
  475. package/docs/v2/sp/tenant-properties/index.html +2286 -0
  476. package/docs/v2/sp/user-custom-actions/index.html +2424 -0
  477. package/docs/v2/sp/views/index.html +2652 -0
  478. package/docs/v2/sp/webs/index.html +4190 -0
  479. package/docs/v2/sp-addinhelpers/index.html +2274 -0
  480. package/docs/v2/sp-addinhelpers/sp-request-executor-client/index.html +2253 -0
  481. package/docs/v2/sp-addinhelpers/sp-rest-addin/index.html +2206 -0
  482. package/docs/v2/transition-guide/index.html +2435 -0
  483. package/mkdocs-requirements.txt +2 -0
  484. package/mkdocs.yml +188 -0
  485. package/package.json +96 -0
  486. package/packages/azidjsclient/index.ts +68 -0
  487. package/packages/azidjsclient/package.json +13 -0
  488. package/packages/azidjsclient/tsconfig.json +12 -0
  489. package/packages/core/behaviors/assign-from.ts +17 -0
  490. package/packages/core/behaviors/copy-from.ts +58 -0
  491. package/packages/core/extendable.ts +193 -0
  492. package/packages/core/index.ts +11 -0
  493. package/packages/core/moments.ts +117 -0
  494. package/packages/core/package.json +10 -0
  495. package/packages/core/storage.ts +274 -0
  496. package/packages/core/timeline.ts +387 -0
  497. package/packages/core/tsconfig.json +10 -0
  498. package/packages/core/util.ts +169 -0
  499. package/packages/graph/attachments/conversations.ts +14 -0
  500. package/packages/graph/attachments/index.ts +8 -0
  501. package/packages/graph/attachments/types.ts +37 -0
  502. package/packages/graph/batching.ts +408 -0
  503. package/packages/graph/behaviors/consistency-level.ts +17 -0
  504. package/packages/graph/behaviors/defaults.ts +41 -0
  505. package/packages/graph/behaviors/endpoint.ts +22 -0
  506. package/packages/graph/behaviors/graphbrowser.ts +38 -0
  507. package/packages/graph/behaviors/paged.ts +109 -0
  508. package/packages/graph/behaviors/spfx.ts +46 -0
  509. package/packages/graph/behaviors/telemetry.ts +19 -0
  510. package/packages/graph/bookings/funcs.ts +18 -0
  511. package/packages/graph/bookings/index.ts +62 -0
  512. package/packages/graph/bookings/types.ts +352 -0
  513. package/packages/graph/calendars/funcs.ts +58 -0
  514. package/packages/graph/calendars/groups.ts +19 -0
  515. package/packages/graph/calendars/index.ts +18 -0
  516. package/packages/graph/calendars/types.ts +73 -0
  517. package/packages/graph/calendars/users.ts +28 -0
  518. package/packages/graph/cloud-communications/index.ts +24 -0
  519. package/packages/graph/cloud-communications/types.ts +32 -0
  520. package/packages/graph/cloud-communications/users.ts +15 -0
  521. package/packages/graph/columns/addColumns.ts +28 -0
  522. package/packages/graph/columns/content-types.ts +44 -0
  523. package/packages/graph/columns/index.ts +14 -0
  524. package/packages/graph/columns/lists.ts +33 -0
  525. package/packages/graph/columns/sites.ts +32 -0
  526. package/packages/graph/columns/types.ts +24 -0
  527. package/packages/graph/contacts/index.ts +14 -0
  528. package/packages/graph/contacts/types.ts +126 -0
  529. package/packages/graph/contacts/users.ts +17 -0
  530. package/packages/graph/content-types/index.ts +11 -0
  531. package/packages/graph/content-types/lists.ts +44 -0
  532. package/packages/graph/content-types/sites.ts +70 -0
  533. package/packages/graph/content-types/types.ts +112 -0
  534. package/packages/graph/conversations/groups.ts +20 -0
  535. package/packages/graph/conversations/index.ts +19 -0
  536. package/packages/graph/conversations/types.ts +147 -0
  537. package/packages/graph/decorators.ts +164 -0
  538. package/packages/graph/directory-objects/index.ts +24 -0
  539. package/packages/graph/directory-objects/types.ts +94 -0
  540. package/packages/graph/fi.ts +46 -0
  541. package/packages/graph/graphqueryable.ts +193 -0
  542. package/packages/graph/groups/index.ts +25 -0
  543. package/packages/graph/groups/types.ts +130 -0
  544. package/packages/graph/index.ts +21 -0
  545. package/packages/graph/insights/index.ts +20 -0
  546. package/packages/graph/insights/types.ts +105 -0
  547. package/packages/graph/insights/users.ts +14 -0
  548. package/packages/graph/invitations/index.ts +22 -0
  549. package/packages/graph/invitations/types.ts +41 -0
  550. package/packages/graph/lists/drive.ts +21 -0
  551. package/packages/graph/lists/index.ts +10 -0
  552. package/packages/graph/lists/sites.ts +16 -0
  553. package/packages/graph/lists/types.ts +47 -0
  554. package/packages/graph/members/groups.ts +17 -0
  555. package/packages/graph/members/index.ts +8 -0
  556. package/packages/graph/members/types.ts +40 -0
  557. package/packages/graph/messages/index.ts +14 -0
  558. package/packages/graph/messages/types.ts +46 -0
  559. package/packages/graph/messages/users.ts +27 -0
  560. package/packages/graph/onedrive/funcs.ts +40 -0
  561. package/packages/graph/onedrive/groups.ts +33 -0
  562. package/packages/graph/onedrive/index.ts +48 -0
  563. package/packages/graph/onedrive/sites.ts +35 -0
  564. package/packages/graph/onedrive/types.ts +482 -0
  565. package/packages/graph/onedrive/users.ts +56 -0
  566. package/packages/graph/onenote/index.ts +16 -0
  567. package/packages/graph/onenote/types.ts +119 -0
  568. package/packages/graph/onenote/users.ts +14 -0
  569. package/packages/graph/operations.ts +22 -0
  570. package/packages/graph/outlook/index.ts +11 -0
  571. package/packages/graph/outlook/types.ts +58 -0
  572. package/packages/graph/outlook/users.ts +14 -0
  573. package/packages/graph/package.json +16 -0
  574. package/packages/graph/photos/groups.ts +14 -0
  575. package/packages/graph/photos/index.ts +7 -0
  576. package/packages/graph/photos/types.ts +33 -0
  577. package/packages/graph/photos/users.ts +14 -0
  578. package/packages/graph/planner/groups.ts +14 -0
  579. package/packages/graph/planner/index.ts +42 -0
  580. package/packages/graph/planner/types.ts +213 -0
  581. package/packages/graph/planner/users.ts +14 -0
  582. package/packages/graph/post-install.cjs +20 -0
  583. package/packages/graph/presets/all.ts +42 -0
  584. package/packages/graph/search/index.ts +18 -0
  585. package/packages/graph/search/types.ts +20 -0
  586. package/packages/graph/shares/index.ts +23 -0
  587. package/packages/graph/shares/types.ts +47 -0
  588. package/packages/graph/sites/group.ts +14 -0
  589. package/packages/graph/sites/index.ts +25 -0
  590. package/packages/graph/sites/types.ts +45 -0
  591. package/packages/graph/subscriptions/index.ts +24 -0
  592. package/packages/graph/subscriptions/types.ts +59 -0
  593. package/packages/graph/teams/index.ts +68 -0
  594. package/packages/graph/teams/types.ts +333 -0
  595. package/packages/graph/teams/users.ts +14 -0
  596. package/packages/graph/tsconfig.json +16 -0
  597. package/packages/graph/users/index.ts +34 -0
  598. package/packages/graph/users/types.ts +56 -0
  599. package/packages/graph/utils/type.ts +3 -0
  600. package/packages/logging/index.ts +145 -0
  601. package/packages/logging/listeners.ts +134 -0
  602. package/packages/logging/package.json +10 -0
  603. package/packages/logging/tsconfig.json +7 -0
  604. package/packages/msaljsclient/index.ts +40 -0
  605. package/packages/msaljsclient/package.json +12 -0
  606. package/packages/msaljsclient/tsconfig.json +12 -0
  607. package/packages/nodejs/behaviors/fetch.ts +130 -0
  608. package/packages/nodejs/behaviors/graphdefault.ts +50 -0
  609. package/packages/nodejs/behaviors/msal.ts +24 -0
  610. package/packages/nodejs/behaviors/spdefault.ts +45 -0
  611. package/packages/nodejs/behaviors/stream-parse.ts +7 -0
  612. package/packages/nodejs/index.ts +33 -0
  613. package/packages/nodejs/package.json +17 -0
  614. package/packages/nodejs/sp-extensions/stream.ts +136 -0
  615. package/packages/nodejs/tsconfig.json +28 -0
  616. package/packages/queryable/add-prop.ts +18 -0
  617. package/packages/queryable/behaviors/bearer-token.ts +15 -0
  618. package/packages/queryable/behaviors/browser-fetch.ts +131 -0
  619. package/packages/queryable/behaviors/caching-pessimistic.ts +67 -0
  620. package/packages/queryable/behaviors/caching.ts +149 -0
  621. package/packages/queryable/behaviors/cancelable.ts +264 -0
  622. package/packages/queryable/behaviors/inject-headers.ts +23 -0
  623. package/packages/queryable/behaviors/parsers.ts +134 -0
  624. package/packages/queryable/behaviors/resolvers.ts +28 -0
  625. package/packages/queryable/behaviors/timeout.ts +24 -0
  626. package/packages/queryable/index.ts +19 -0
  627. package/packages/queryable/invokable.ts +42 -0
  628. package/packages/queryable/operations.ts +32 -0
  629. package/packages/queryable/package.json +11 -0
  630. package/packages/queryable/queryable-factory.ts +19 -0
  631. package/packages/queryable/queryable.ts +239 -0
  632. package/packages/queryable/request-builders.ts +20 -0
  633. package/packages/queryable/tsconfig.json +11 -0
  634. package/packages/readme.md +21 -0
  635. package/packages/sp/appcatalog/index.ts +35 -0
  636. package/packages/sp/appcatalog/types.ts +176 -0
  637. package/packages/sp/appcatalog/web.ts +19 -0
  638. package/packages/sp/attachments/index.ts +11 -0
  639. package/packages/sp/attachments/item.ts +17 -0
  640. package/packages/sp/attachments/types.ts +95 -0
  641. package/packages/sp/batching.ts +483 -0
  642. package/packages/sp/behaviors/defaults.ts +38 -0
  643. package/packages/sp/behaviors/request-digest.ts +78 -0
  644. package/packages/sp/behaviors/spbrowser.ts +40 -0
  645. package/packages/sp/behaviors/spfx.ts +83 -0
  646. package/packages/sp/behaviors/telemetry.ts +35 -0
  647. package/packages/sp/clientside-pages/funcs.ts +27 -0
  648. package/packages/sp/clientside-pages/index.ts +27 -0
  649. package/packages/sp/clientside-pages/types.ts +1661 -0
  650. package/packages/sp/clientside-pages/web.ts +93 -0
  651. package/packages/sp/column-defaults/folder.ts +89 -0
  652. package/packages/sp/column-defaults/index.ts +8 -0
  653. package/packages/sp/column-defaults/list.ts +219 -0
  654. package/packages/sp/column-defaults/types.ts +19 -0
  655. package/packages/sp/comments/clientside-page.ts +120 -0
  656. package/packages/sp/comments/index.ts +14 -0
  657. package/packages/sp/comments/item.ts +77 -0
  658. package/packages/sp/comments/types.ts +160 -0
  659. package/packages/sp/content-types/index.ts +17 -0
  660. package/packages/sp/content-types/item.ts +17 -0
  661. package/packages/sp/content-types/list.ts +17 -0
  662. package/packages/sp/content-types/types.ts +181 -0
  663. package/packages/sp/content-types/web.ts +17 -0
  664. package/packages/sp/context-info/index.ts +40 -0
  665. package/packages/sp/decorators.ts +18 -0
  666. package/packages/sp/favorites/index.ts +32 -0
  667. package/packages/sp/favorites/types.ts +187 -0
  668. package/packages/sp/features/index.ts +11 -0
  669. package/packages/sp/features/site.ts +17 -0
  670. package/packages/sp/features/types.ts +73 -0
  671. package/packages/sp/features/web.ts +17 -0
  672. package/packages/sp/fi.ts +46 -0
  673. package/packages/sp/fields/index.ts +22 -0
  674. package/packages/sp/fields/list.ts +17 -0
  675. package/packages/sp/fields/types.ts +648 -0
  676. package/packages/sp/fields/web.ts +23 -0
  677. package/packages/sp/files/folder.ts +17 -0
  678. package/packages/sp/files/index.ts +25 -0
  679. package/packages/sp/files/item.ts +17 -0
  680. package/packages/sp/files/readable-file.ts +40 -0
  681. package/packages/sp/files/types.ts +771 -0
  682. package/packages/sp/files/web.ts +46 -0
  683. package/packages/sp/folders/index.ts +19 -0
  684. package/packages/sp/folders/item.ts +16 -0
  685. package/packages/sp/folders/list.ts +17 -0
  686. package/packages/sp/folders/types.ts +439 -0
  687. package/packages/sp/folders/web.ts +50 -0
  688. package/packages/sp/forms/index.ts +9 -0
  689. package/packages/sp/forms/list.ts +14 -0
  690. package/packages/sp/forms/types.ts +41 -0
  691. package/packages/sp/groupsitemanager/index.ts +18 -0
  692. package/packages/sp/groupsitemanager/types.ts +433 -0
  693. package/packages/sp/hubsites/index.ts +31 -0
  694. package/packages/sp/hubsites/site.ts +43 -0
  695. package/packages/sp/hubsites/types.ts +71 -0
  696. package/packages/sp/hubsites/web.ts +38 -0
  697. package/packages/sp/index.ts +24 -0
  698. package/packages/sp/items/get-all.ts +52 -0
  699. package/packages/sp/items/index.ts +18 -0
  700. package/packages/sp/items/list.ts +14 -0
  701. package/packages/sp/items/types.ts +405 -0
  702. package/packages/sp/lists/index.ts +23 -0
  703. package/packages/sp/lists/types.ts +851 -0
  704. package/packages/sp/lists/web.ts +68 -0
  705. package/packages/sp/navigation/index.ts +35 -0
  706. package/packages/sp/navigation/types.ts +243 -0
  707. package/packages/sp/navigation/web.ts +19 -0
  708. package/packages/sp/operations.ts +33 -0
  709. package/packages/sp/package.json +15 -0
  710. package/packages/sp/post-install.cjs +20 -0
  711. package/packages/sp/presets/all.ts +75 -0
  712. package/packages/sp/profiles/index.ts +30 -0
  713. package/packages/sp/profiles/types.ts +595 -0
  714. package/packages/sp/publishing-sitepageservice/index.ts +22 -0
  715. package/packages/sp/publishing-sitepageservice/types.ts +18 -0
  716. package/packages/sp/recycle-bin/index.ts +36 -0
  717. package/packages/sp/recycle-bin/types.ts +113 -0
  718. package/packages/sp/regional-settings/content-type.ts +11 -0
  719. package/packages/sp/regional-settings/field.ts +11 -0
  720. package/packages/sp/regional-settings/funcs.ts +10 -0
  721. package/packages/sp/regional-settings/index.ts +18 -0
  722. package/packages/sp/regional-settings/list.ts +11 -0
  723. package/packages/sp/regional-settings/types.ts +159 -0
  724. package/packages/sp/regional-settings/user-custom-actions.ts +11 -0
  725. package/packages/sp/regional-settings/web.ts +21 -0
  726. package/packages/sp/related-items/index.ts +7 -0
  727. package/packages/sp/related-items/types.ts +194 -0
  728. package/packages/sp/related-items/web.ts +22 -0
  729. package/packages/sp/search/index.ts +48 -0
  730. package/packages/sp/search/query.ts +254 -0
  731. package/packages/sp/search/suggest.ts +130 -0
  732. package/packages/sp/search/types.ts +480 -0
  733. package/packages/sp/security/funcs.ts +94 -0
  734. package/packages/sp/security/index.ts +21 -0
  735. package/packages/sp/security/item.ts +29 -0
  736. package/packages/sp/security/list.ts +29 -0
  737. package/packages/sp/security/types.ts +440 -0
  738. package/packages/sp/security/web.ts +34 -0
  739. package/packages/sp/sharing/file.ts +75 -0
  740. package/packages/sp/sharing/folder.ts +69 -0
  741. package/packages/sp/sharing/funcs.ts +258 -0
  742. package/packages/sp/sharing/index.ts +27 -0
  743. package/packages/sp/sharing/item.ts +53 -0
  744. package/packages/sp/sharing/types.ts +626 -0
  745. package/packages/sp/sharing/web.ts +109 -0
  746. package/packages/sp/site-designs/index.ts +29 -0
  747. package/packages/sp/site-designs/types.ts +456 -0
  748. package/packages/sp/site-designs/web.ts +41 -0
  749. package/packages/sp/site-groups/index.ts +11 -0
  750. package/packages/sp/site-groups/types.ts +133 -0
  751. package/packages/sp/site-groups/web.ts +73 -0
  752. package/packages/sp/site-scripts/index.ts +27 -0
  753. package/packages/sp/site-scripts/list.ts +27 -0
  754. package/packages/sp/site-scripts/types.ts +243 -0
  755. package/packages/sp/site-scripts/web.ts +24 -0
  756. package/packages/sp/site-users/index.ts +12 -0
  757. package/packages/sp/site-users/types.ts +195 -0
  758. package/packages/sp/site-users/web.ts +56 -0
  759. package/packages/sp/sites/index.ts +26 -0
  760. package/packages/sp/sites/types.ts +422 -0
  761. package/packages/sp/social/index.ts +33 -0
  762. package/packages/sp/social/types.ts +381 -0
  763. package/packages/sp/spqueryable.ts +244 -0
  764. package/packages/sp/sputilities/index.ts +23 -0
  765. package/packages/sp/sputilities/types.ts +197 -0
  766. package/packages/sp/subscriptions/index.ts +10 -0
  767. package/packages/sp/subscriptions/list.ts +18 -0
  768. package/packages/sp/subscriptions/types.ts +107 -0
  769. package/packages/sp/taxonomy/index.ts +50 -0
  770. package/packages/sp/taxonomy/types.ts +508 -0
  771. package/packages/sp/tsconfig.json +16 -0
  772. package/packages/sp/types.ts +283 -0
  773. package/packages/sp/user-custom-actions/index.ts +15 -0
  774. package/packages/sp/user-custom-actions/list.ts +18 -0
  775. package/packages/sp/user-custom-actions/site.ts +18 -0
  776. package/packages/sp/user-custom-actions/types.ts +133 -0
  777. package/packages/sp/user-custom-actions/web.ts +21 -0
  778. package/packages/sp/utils/encode-path-str.ts +29 -0
  779. package/packages/sp/utils/extract-web-url.ts +21 -0
  780. package/packages/sp/utils/file-names.ts +35 -0
  781. package/packages/sp/utils/metadata.ts +5 -0
  782. package/packages/sp/utils/odata-url-from.ts +42 -0
  783. package/packages/sp/utils/to-resource-path.ts +9 -0
  784. package/packages/sp/views/index.ts +14 -0
  785. package/packages/sp/views/list.ts +33 -0
  786. package/packages/sp/views/types.ts +210 -0
  787. package/packages/sp/webparts/file.ts +21 -0
  788. package/packages/sp/webparts/index.ts +11 -0
  789. package/packages/sp/webparts/types.ts +141 -0
  790. package/packages/sp/webs/index.ts +32 -0
  791. package/packages/sp/webs/types.ts +350 -0
  792. package/packages/sp-admin/index.ts +46 -0
  793. package/packages/sp-admin/office-tenant.ts +567 -0
  794. package/packages/sp-admin/package.json +13 -0
  795. package/packages/sp-admin/site-properties.ts +45 -0
  796. package/packages/sp-admin/tenant.ts +595 -0
  797. package/packages/sp-admin/tsconfig.json +20 -0
  798. package/packages/sp-admin/types.ts +1679 -0
  799. package/packages/tsconfig-watch.json +9 -0
  800. package/packages/tsconfig.json +37 -0
  801. package/pre-install.cjs +1 -0
  802. package/samples/custom-bundle-webpack/index.ts +33 -0
  803. package/samples/custom-bundle-webpack/package-lock.json +4601 -0
  804. package/samples/custom-bundle-webpack/package.json +18 -0
  805. package/samples/custom-bundle-webpack/readme.md +102 -0
  806. package/samples/custom-bundle-webpack/tsconfig.json +12 -0
  807. package/samples/custom-bundle-webpack/webpack.config.js +27 -0
  808. package/samples/nodejs-app/.vscode/launch.json +27 -0
  809. package/samples/nodejs-app/.vscode/settings.json +10 -0
  810. package/samples/nodejs-app/.vscode/tasks.json +22 -0
  811. package/samples/nodejs-app/index.ts +63 -0
  812. package/samples/nodejs-app/package-lock.json +259 -0
  813. package/samples/nodejs-app/package.json +21 -0
  814. package/samples/nodejs-app/readme.md +140 -0
  815. package/samples/nodejs-app/tsconfig.json +14 -0
  816. package/samples/nodejs-commonjs/package-lock.json +702 -0
  817. package/samples/nodejs-commonjs/package.json +21 -0
  818. package/samples/nodejs-commonjs/readme.md +58 -0
  819. package/samples/nodejs-commonjs/src/index.ts +23 -0
  820. package/samples/nodejs-commonjs/src/settings.ts +35 -0
  821. package/samples/nodejs-commonjs/tsconfig.json +35 -0
  822. package/samples/project-preset/README.md +73 -0
  823. package/samples/project-preset/package-lock.json +21097 -0
  824. package/samples/project-preset/package.json +29 -0
  825. package/samples/project-preset/teams/4530a515-8ba7-45bb-9a27-be06b33c59d4_color.png +0 -0
  826. package/samples/project-preset/teams/4530a515-8ba7-45bb-9a27-be06b33c59d4_outline.png +0 -0
  827. package/samples/readme.md +16 -0
  828. package/settings.example.js +57 -0
  829. package/test/args.ts +107 -0
  830. package/test/clean-subsite.ts +36 -0
  831. package/test/core/assumptions.ts +99 -0
  832. package/test/core/storage.ts +60 -0
  833. package/test/core/timeline.ts +205 -0
  834. package/test/core/util.ts +205 -0
  835. package/test/graph/assets/testconvert.docx +0 -0
  836. package/test/graph/batch.ts +125 -0
  837. package/test/graph/calendars.ts +234 -0
  838. package/test/graph/columns.ts +247 -0
  839. package/test/graph/contacts.ts +254 -0
  840. package/test/graph/content-types.ts +206 -0
  841. package/test/graph/directoryobjects.ts +115 -0
  842. package/test/graph/groups.ts +130 -0
  843. package/test/graph/lists.ts +72 -0
  844. package/test/graph/onedrive.ts +365 -0
  845. package/test/graph/outlook.ts +95 -0
  846. package/test/graph/paging.ts +91 -0
  847. package/test/graph/planner.ts +160 -0
  848. package/test/graph/querable.ts +97 -0
  849. package/test/graph/search.ts +4 -0
  850. package/test/graph/shares.ts +26 -0
  851. package/test/graph/sites.ts +40 -0
  852. package/test/graph/teams.ts +76 -0
  853. package/test/graph/utilities/getTestingGraphSPSite.ts +27 -0
  854. package/test/graph/utilities/getValidUser.ts +37 -0
  855. package/test/load-settings.ts +103 -0
  856. package/test/logging/logging.ts +86 -0
  857. package/test/mocha-root-hooks.ts +227 -0
  858. package/test/nodejs/sp-extensions.ts +86 -0
  859. package/test/pnp-test.ts +60 -0
  860. package/test/queryable/add-prop.ts +24 -0
  861. package/test/queryable/behaviors.ts +188 -0
  862. package/test/queryable/invokable.ts +35 -0
  863. package/test/queryable/queryable.ts +118 -0
  864. package/test/sp/alias.ts +46 -0
  865. package/test/sp/appcatalog.ts +142 -0
  866. package/test/sp/assets/helloworld.sppkg +0 -0
  867. package/test/sp/assets/sample_file.jpg +0 -0
  868. package/test/sp/attachments.ts +134 -0
  869. package/test/sp/batch.ts +362 -0
  870. package/test/sp/clientside-pages.ts +426 -0
  871. package/test/sp/column-defaults.ts +225 -0
  872. package/test/sp/comments.ts +202 -0
  873. package/test/sp/content-types.ts +68 -0
  874. package/test/sp/favorites.ts +2 -0
  875. package/test/sp/features.ts +201 -0
  876. package/test/sp/fields.ts +396 -0
  877. package/test/sp/files.ts +338 -0
  878. package/test/sp/folders.ts +242 -0
  879. package/test/sp/forms.ts +22 -0
  880. package/test/sp/groupsitemanager.ts +88 -0
  881. package/test/sp/hubsites.ts +41 -0
  882. package/test/sp/items.ts +179 -0
  883. package/test/sp/lists.ts +319 -0
  884. package/test/sp/navigation.ts +167 -0
  885. package/test/sp/profiles.ts +2 -0
  886. package/test/sp/query-escaping.ts +94 -0
  887. package/test/sp/recycle-bin.ts +1 -0
  888. package/test/sp/regional-settings.ts +58 -0
  889. package/test/sp/related-items.ts +94 -0
  890. package/test/sp/search.ts +39 -0
  891. package/test/sp/security.ts +90 -0
  892. package/test/sp/sharing.ts +313 -0
  893. package/test/sp/site-designs.ts +224 -0
  894. package/test/sp/site-groups.ts +98 -0
  895. package/test/sp/site-scripts.ts +162 -0
  896. package/test/sp/site-users.ts +93 -0
  897. package/test/sp/sites.ts +156 -0
  898. package/test/sp/social.ts +2 -0
  899. package/test/sp/spfx.ts +52 -0
  900. package/test/sp/sputilities.ts +78 -0
  901. package/test/sp/subscriptions.ts +64 -0
  902. package/test/sp/taxonomy.ts +178 -0
  903. package/test/sp/user-custom-actions.ts +31 -0
  904. package/test/sp/views.ts +117 -0
  905. package/test/sp/webparts.ts +38 -0
  906. package/test/sp/webs.ts +249 -0
  907. package/test/test-invokable-props.ts +35 -0
  908. package/test/test-props.ts +90 -0
  909. package/test/test-recording.ts +171 -0
  910. package/test/tsconfig.json +18 -0
  911. package/tools/buildsystem/package-lock.json +4404 -0
  912. package/tools/buildsystem/package.json +56 -0
  913. package/tools/buildsystem/readme.md +23 -0
  914. package/tools/config.js +34 -0
  915. package/tools/local-module-resolver/cjs.ts +33 -0
  916. package/tools/local-module-resolver/esm-debug.ts +2 -0
  917. package/tools/local-module-resolver/esm-test.ts +2 -0
  918. package/tools/local-module-resolver/esm.ts +112 -0
  919. package/tools/local-module-resolver/readme.md +8 -0
  920. package/tsconfig.buildsystem.json +17 -0
  921. package/tsconfig.json +42 -0
package/docs/v2/transition-guide/index.html ADDED
@@ -0,0 +1,2435 @@
1
+
2
+ <!doctype html>
3
+ <html lang="en" class="no-js">
4
+ <head>
5
+
6
+ <meta charset="utf-8">
7
+ <meta name="viewport" content="width=device-width,initial-scale=1">
8
+
9
+
10
+ <link rel="canonical" href="https://pnp.github.io/pnpjs/transition-guide/">
11
+
12
+
13
+ <link rel="shortcut icon" href="../assets/images/favicon.png">
14
+ <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-6.0.2">
15
+
16
+
17
+
18
+ <title>Transition Guide - PnP/PnPjs</title>
19
+
20
+
21
+
22
+ <link rel="stylesheet" href="../assets/stylesheets/main.38780c08.min.css">
23
+
24
+
25
+ <link rel="stylesheet" href="../assets/stylesheets/palette.3f72e892.min.css">
26
+
27
+
28
+
29
+ <meta name="theme-color" content="#2094f3">
30
+
31
+
32
+
33
+
34
+
35
+
36
+
37
+ <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
38
+ <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
39
+ <style>body,input{font-family:"Roboto",-apple-system,BlinkMacSystemFont,Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono",SFMono-Regular,Consolas,Menlo,monospace}</style>
40
+
41
+
42
+
43
+
44
+ <link rel="stylesheet" href="../css/extra.css">
45
+
46
+
47
+ <img src="https://telemetry.sharepointpnp.com/@pnp/pnpjs/ghpages/pnpjs/transition-guide/" alt="spacer" width="1" height="1" />
48
+
49
+
50
+ </head>
51
+
52
+
53
+
54
+
55
+
56
+
57
+
58
+ <body dir="ltr" data-md-color-scheme="" data-md-color-primary="blue" data-md-color-accent="">
59
+
60
+
61
+ <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
62
+ <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
63
+ <label class="md-overlay" for="__drawer"></label>
64
+ <div data-md-component="skip">
65
+
66
+
67
+ <a href="#transition-guide" class="md-skip">
68
+ Skip to content
69
+ </a>
70
+
71
+ </div>
72
+ <div data-md-component="announce">
73
+
74
+ </div>
75
+
76
+ <header class="md-header" data-md-component="header">
77
+ <nav class="md-header-nav md-grid" aria-label="Header">
78
+ <a href="https://pnp.github.io/pnpjs/" title="PnP/PnPjs" class="md-header-nav__button md-logo" aria-label="PnP/PnPjs">
79
+
80
+ <img src="../img/Logo.png" alt="logo">
81
+
82
+ </a>
83
+ <label class="md-header-nav__button md-icon" for="__drawer">
84
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
85
+ </label>
86
+ <div class="md-header-nav__title" data-md-component="header-title">
87
+
88
+ <div class="md-header-nav__ellipsis">
89
+ <span class="md-header-nav__topic md-ellipsis">
90
+ PnP/PnPjs
91
+ </span>
92
+ <span class="md-header-nav__topic md-ellipsis">
93
+
94
+ Transition Guide
95
+
96
+ </span>
97
+ </div>
98
+
99
+ </div>
100
+
101
+ <label class="md-header-nav__button md-icon" for="__search">
102
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0116 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
103
+ </label>
104
+
105
+ <div class="md-search" data-md-component="search" role="dialog">
106
+ <label class="md-search__overlay" for="__search"></label>
107
+ <div class="md-search__inner" role="search">
108
+ <form class="md-search__form" name="search">
109
+ <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active">
110
+ <label class="md-search__icon md-icon" for="__search">
111
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0116 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
112
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
113
+ </label>
114
+ <button type="reset" class="md-search__icon md-icon" aria-label="Clear" data-md-component="search-reset" tabindex="-1">
115
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
116
+ </button>
117
+ </form>
118
+ <div class="md-search__output">
119
+ <div class="md-search__scrollwrap" data-md-scrollfix>
120
+ <div class="md-search-result" data-md-component="search-result">
121
+ <div class="md-search-result__meta">
122
+ Initializing search
123
+ </div>
124
+ <ol class="md-search-result__list"></ol>
125
+ </div>
126
+ </div>
127
+ </div>
128
+ </div>
129
+ </div>
130
+
131
+
132
+ <div class="md-header-nav__source">
133
+
134
+ <a href="https://github.com/pnp/pnpjs/" title="Go to repository" class="md-source">
135
+ <div class="md-source__icon md-icon">
136
+
137
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 40.45a28.87 28.87 0 00-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 01-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 000 40.81l195.61 195.6a28.86 28.86 0 0040.8 0l194.69-194.69a28.86 28.86 0 000-40.81z"/></svg>
138
+ </div>
139
+ <div class="md-source__repository">
140
+ GitHub
141
+ </div>
142
+ </a>
143
+ </div>
144
+
145
+ </nav>
146
+ </header>
147
+
148
+ <div class="md-container" data-md-component="container">
149
+
150
+
151
+
152
+
153
+ <main class="md-main" data-md-component="main">
154
+ <div class="md-main__inner md-grid">
155
+
156
+
157
+ <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
158
+ <div class="md-sidebar__scrollwrap">
159
+ <div class="md-sidebar__inner">
160
+ <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
161
+ <label class="md-nav__title" for="__drawer">
162
+ <a href="https://pnp.github.io/pnpjs/" title="PnP/PnPjs" class="md-nav__button md-logo" aria-label="PnP/PnPjs">
163
+
164
+ <img src="../img/Logo.png" alt="logo">
165
+
166
+ </a>
167
+ PnP/PnPjs
168
+ </label>
169
+
170
+ <div class="md-nav__source">
171
+
172
+ <a href="https://github.com/pnp/pnpjs/" title="Go to repository" class="md-source">
173
+ <div class="md-source__icon md-icon">
174
+
175
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 40.45a28.87 28.87 0 00-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 01-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 000 40.81l195.61 195.6a28.86 28.86 0 0040.8 0l194.69-194.69a28.86 28.86 0 000-40.81z"/></svg>
176
+ </div>
177
+ <div class="md-source__repository">
178
+ GitHub
179
+ </div>
180
+ </a>
181
+ </div>
182
+
183
+ <ul class="md-nav__list" data-md-scrollfix>
184
+
185
+
186
+
187
+
188
+
189
+
190
+ <li class="md-nav__item">
191
+ <a href=".." class="md-nav__link">
192
+ Home
193
+ </a>
194
+ </li>
195
+
196
+
197
+
198
+
199
+
200
+
201
+
202
+ <li class="md-nav__item">
203
+ <a href="../getting-started/" class="md-nav__link">
204
+ Getting Started
205
+ </a>
206
+ </li>
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+ <li class="md-nav__item">
215
+ <a href="../news/2020-year-in-review/" class="md-nav__link">
216
+ 2020 Year In Review
217
+ </a>
218
+ </li>
219
+
220
+
221
+
222
+
223
+
224
+
225
+
226
+
227
+
228
+ <li class="md-nav__item md-nav__item--active md-nav__item--nested">
229
+
230
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4" checked>
231
+
232
+ <label class="md-nav__link" for="nav-4">
233
+ General
234
+ <span class="md-nav__icon md-icon"></span>
235
+ </label>
236
+ <nav class="md-nav" aria-label="General" data-md-level="1">
237
+ <label class="md-nav__title" for="nav-4">
238
+ <span class="md-nav__icon md-icon"></span>
239
+ General
240
+ </label>
241
+ <ul class="md-nav__list" data-md-scrollfix>
242
+
243
+
244
+
245
+
246
+
247
+
248
+
249
+ <li class="md-nav__item">
250
+ <a href="../getting-started/" class="md-nav__link">
251
+ Getting Started
252
+ </a>
253
+ </li>
254
+
255
+
256
+
257
+
258
+
259
+
260
+
261
+
262
+
263
+ <li class="md-nav__item md-nav__item--active">
264
+
265
+ <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
266
+
267
+
268
+
269
+
270
+ <label class="md-nav__link md-nav__link--active" for="__toc">
271
+ Transition Guide
272
+ <span class="md-nav__icon md-icon"></span>
273
+ </label>
274
+
275
+ <a href="./" class="md-nav__link md-nav__link--active">
276
+ Transition Guide
277
+ </a>
278
+
279
+
280
+ <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
281
+
282
+
283
+
284
+
285
+
286
+ <label class="md-nav__title" for="__toc">
287
+ <span class="md-nav__icon md-icon"></span>
288
+ Table of contents
289
+ </label>
290
+ <ul class="md-nav__list" data-md-scrollfix>
291
+
292
+ <li class="md-nav__item">
293
+ <a href="#installing-pnp-libraries" class="md-nav__link">
294
+ Installing @pnp libraries
295
+ </a>
296
+
297
+ </li>
298
+
299
+ <li class="md-nav__item">
300
+ <a href="#selective-imports" class="md-nav__link">
301
+ Selective Imports
302
+ </a>
303
+
304
+ <nav class="md-nav" aria-label="Selective Imports">
305
+ <ul class="md-nav__list">
306
+
307
+ <li class="md-nav__item">
308
+ <a href="#selectively-import-web-lists-functionality" class="md-nav__link">
309
+ Selectively Import Web lists functionality
310
+ </a>
311
+
312
+ </li>
313
+
314
+ <li class="md-nav__item">
315
+ <a href="#presets" class="md-nav__link">
316
+ Presets
317
+ </a>
318
+
319
+ </li>
320
+
321
+ </ul>
322
+ </nav>
323
+
324
+ </li>
325
+
326
+ <li class="md-nav__item">
327
+ <a href="#invokable-objects" class="md-nav__link">
328
+ Invokable Objects
329
+ </a>
330
+
331
+ </li>
332
+
333
+ <li class="md-nav__item">
334
+ <a href="#factory-functions-interfaces" class="md-nav__link">
335
+ Factory Functions &amp; Interfaces
336
+ </a>
337
+
338
+ </li>
339
+
340
+ <li class="md-nav__item">
341
+ <a href="#extension-methods" class="md-nav__link">
342
+ Extension Methods
343
+ </a>
344
+
345
+ </li>
346
+
347
+ <li class="md-nav__item">
348
+ <a href="#cdn-publishing" class="md-nav__link">
349
+ CDN publishing
350
+ </a>
351
+
352
+ </li>
353
+
354
+ <li class="md-nav__item">
355
+ <a href="#drop-client-svc-and-sp-taxonomy-libraries" class="md-nav__link">
356
+ Drop client-svc and sp-taxonomy libraries
357
+ </a>
358
+
359
+ </li>
360
+
361
+ </ul>
362
+
363
+ </nav>
364
+
365
+ </li>
366
+
367
+
368
+
369
+
370
+
371
+
372
+
373
+ <li class="md-nav__item">
374
+ <a href="../npm-scripts/" class="md-nav__link">
375
+ Npm Scripts
376
+ </a>
377
+ </li>
378
+
379
+
380
+
381
+
382
+
383
+
384
+
385
+ <li class="md-nav__item">
386
+ <a href="../SPFx-on-premises/" class="md-nav__link">
387
+ SPFx On-Premises
388
+ </a>
389
+ </li>
390
+
391
+
392
+
393
+
394
+
395
+
396
+
397
+ <li class="md-nav__item">
398
+ <a href="../nodejs-support/" class="md-nav__link">
399
+ Working in Nodejs
400
+ </a>
401
+ </li>
402
+
403
+
404
+ </ul>
405
+ </nav>
406
+ </li>
407
+
408
+
409
+
410
+
411
+
412
+
413
+
414
+ <li class="md-nav__item md-nav__item--nested">
415
+
416
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
417
+
418
+ <label class="md-nav__link" for="nav-5">
419
+ Library Concepts
420
+ <span class="md-nav__icon md-icon"></span>
421
+ </label>
422
+ <nav class="md-nav" aria-label="Library Concepts" data-md-level="1">
423
+ <label class="md-nav__title" for="nav-5">
424
+ <span class="md-nav__icon md-icon"></span>
425
+ Library Concepts
426
+ </label>
427
+ <ul class="md-nav__list" data-md-scrollfix>
428
+
429
+
430
+
431
+
432
+
433
+
434
+
435
+ <li class="md-nav__item">
436
+ <a href="../concepts/configuration/" class="md-nav__link">
437
+ Configuration
438
+ </a>
439
+ </li>
440
+
441
+
442
+
443
+
444
+
445
+
446
+
447
+ <li class="md-nav__item">
448
+ <a href="../concepts/selective-imports/" class="md-nav__link">
449
+ Selective Imports
450
+ </a>
451
+ </li>
452
+
453
+
454
+
455
+
456
+
457
+
458
+
459
+ <li class="md-nav__item">
460
+ <a href="../concepts/custom-bundle/" class="md-nav__link">
461
+ Custom Bundle
462
+ </a>
463
+ </li>
464
+
465
+
466
+
467
+
468
+
469
+
470
+
471
+ <li class="md-nav__item">
472
+ <a href="../concepts/ie11-mode/" class="md-nav__link">
473
+ IE11 Mode
474
+ </a>
475
+ </li>
476
+
477
+
478
+
479
+
480
+
481
+
482
+
483
+ <li class="md-nav__item">
484
+ <a href="../concepts/invokable/" class="md-nav__link">
485
+ Invokables
486
+ </a>
487
+ </li>
488
+
489
+
490
+
491
+
492
+
493
+
494
+
495
+ <li class="md-nav__item">
496
+ <a href="../concepts/polyfill/" class="md-nav__link">
497
+ Polyfills
498
+ </a>
499
+ </li>
500
+
501
+
502
+
503
+
504
+
505
+
506
+
507
+ <li class="md-nav__item">
508
+ <a href="../concepts/settings/" class="md-nav__link">
509
+ Settings
510
+ </a>
511
+ </li>
512
+
513
+
514
+
515
+
516
+
517
+
518
+
519
+ <li class="md-nav__item">
520
+ <a href="../concepts/error-handling/" class="md-nav__link">
521
+ Error Handling
522
+ </a>
523
+ </li>
524
+
525
+
526
+
527
+
528
+
529
+
530
+
531
+ <li class="md-nav__item md-nav__item--nested">
532
+
533
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-5-9" type="checkbox" id="nav-5-9">
534
+
535
+ <label class="md-nav__link" for="nav-5-9">
536
+ Authentication
537
+ <span class="md-nav__icon md-icon"></span>
538
+ </label>
539
+ <nav class="md-nav" aria-label="Authentication" data-md-level="2">
540
+ <label class="md-nav__title" for="nav-5-9">
541
+ <span class="md-nav__icon md-icon"></span>
542
+ Authentication
543
+ </label>
544
+ <ul class="md-nav__list" data-md-scrollfix>
545
+
546
+
547
+
548
+
549
+
550
+
551
+
552
+ <li class="md-nav__item">
553
+ <a href="../authentication/" class="md-nav__link">
554
+ Getting Started
555
+ </a>
556
+ </li>
557
+
558
+
559
+
560
+
561
+
562
+
563
+
564
+ <li class="md-nav__item">
565
+ <a href="../authentication/client-spfx/" class="md-nav__link">
566
+ SPFx Auth
567
+ </a>
568
+ </li>
569
+
570
+
571
+
572
+
573
+
574
+
575
+
576
+ <li class="md-nav__item">
577
+ <a href="../authentication/msaljsclient/" class="md-nav__link">
578
+ MSAL Client
579
+ </a>
580
+ </li>
581
+
582
+
583
+
584
+
585
+
586
+
587
+
588
+ <li class="md-nav__item">
589
+ <a href="../authentication/adaljsclient/" class="md-nav__link">
590
+ ADAL Client
591
+ </a>
592
+ </li>
593
+
594
+
595
+
596
+
597
+
598
+
599
+
600
+ <li class="md-nav__item">
601
+ <a href="../authentication/client-spa/" class="md-nav__link">
602
+ SPA Auth
603
+ </a>
604
+ </li>
605
+
606
+
607
+
608
+
609
+
610
+
611
+
612
+ <li class="md-nav__item">
613
+ <a href="../authentication/server-nodejs/" class="md-nav__link">
614
+ NodeJS Auth
615
+ </a>
616
+ </li>
617
+
618
+
619
+
620
+
621
+
622
+
623
+
624
+ <li class="md-nav__item">
625
+ <a href="../authentication/sp-app-registration/" class="md-nav__link">
626
+ SP App Reg
627
+ </a>
628
+ </li>
629
+
630
+
631
+
632
+
633
+
634
+
635
+
636
+ <li class="md-nav__item">
637
+ <a href="../authentication/bearertokenclient/" class="md-nav__link">
638
+ Bearer Token Client
639
+ </a>
640
+ </li>
641
+
642
+
643
+
644
+
645
+
646
+
647
+
648
+ <li class="md-nav__item">
649
+ <a href="../authentication/lambdaclient/" class="md-nav__link">
650
+ Lambda Token Client
651
+ </a>
652
+ </li>
653
+
654
+
655
+ </ul>
656
+ </nav>
657
+ </li>
658
+
659
+
660
+ </ul>
661
+ </nav>
662
+ </li>
663
+
664
+
665
+
666
+
667
+
668
+
669
+
670
+ <li class="md-nav__item md-nav__item--nested">
671
+
672
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6">
673
+
674
+ <label class="md-nav__link" for="nav-6">
675
+ Packages
676
+ <span class="md-nav__icon md-icon"></span>
677
+ </label>
678
+ <nav class="md-nav" aria-label="Packages" data-md-level="1">
679
+ <label class="md-nav__title" for="nav-6">
680
+ <span class="md-nav__icon md-icon"></span>
681
+ Packages
682
+ </label>
683
+ <ul class="md-nav__list" data-md-scrollfix>
684
+
685
+
686
+
687
+
688
+
689
+
690
+
691
+ <li class="md-nav__item">
692
+ <a href="../packages/" class="md-nav__link">
693
+ Packages
694
+ </a>
695
+ </li>
696
+
697
+
698
+
699
+
700
+
701
+
702
+
703
+ <li class="md-nav__item md-nav__item--nested">
704
+
705
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-6-2" type="checkbox" id="nav-6-2">
706
+
707
+ <label class="md-nav__link" for="nav-6-2">
708
+ common
709
+ <span class="md-nav__icon md-icon"></span>
710
+ </label>
711
+ <nav class="md-nav" aria-label="common" data-md-level="2">
712
+ <label class="md-nav__title" for="nav-6-2">
713
+ <span class="md-nav__icon md-icon"></span>
714
+ common
715
+ </label>
716
+ <ul class="md-nav__list" data-md-scrollfix>
717
+
718
+
719
+
720
+
721
+
722
+
723
+
724
+ <li class="md-nav__item">
725
+ <a href="../common/" class="md-nav__link">
726
+ common
727
+ </a>
728
+ </li>
729
+
730
+
731
+
732
+
733
+
734
+
735
+
736
+ <li class="md-nav__item">
737
+ <a href="../common/collections/" class="md-nav__link">
738
+ collections
739
+ </a>
740
+ </li>
741
+
742
+
743
+
744
+
745
+
746
+
747
+
748
+ <li class="md-nav__item">
749
+ <a href="../common/custom-httpclientimpl/" class="md-nav__link">
750
+ Custom HttpClientImpl
751
+ </a>
752
+ </li>
753
+
754
+
755
+
756
+
757
+
758
+
759
+
760
+ <li class="md-nav__item">
761
+ <a href="../common/libconfig/" class="md-nav__link">
762
+ libconfig
763
+ </a>
764
+ </li>
765
+
766
+
767
+
768
+
769
+
770
+
771
+
772
+ <li class="md-nav__item">
773
+ <a href="../common/netutil/" class="md-nav__link">
774
+ netutil
775
+ </a>
776
+ </li>
777
+
778
+
779
+
780
+
781
+
782
+
783
+
784
+ <li class="md-nav__item">
785
+ <a href="../common/storage/" class="md-nav__link">
786
+ storage
787
+ </a>
788
+ </li>
789
+
790
+
791
+
792
+
793
+
794
+
795
+
796
+ <li class="md-nav__item">
797
+ <a href="../common/util/" class="md-nav__link">
798
+ util
799
+ </a>
800
+ </li>
801
+
802
+
803
+ </ul>
804
+ </nav>
805
+ </li>
806
+
807
+
808
+
809
+
810
+
811
+
812
+
813
+ <li class="md-nav__item md-nav__item--nested">
814
+
815
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-6-3" type="checkbox" id="nav-6-3">
816
+
817
+ <label class="md-nav__link" for="nav-6-3">
818
+ config-store
819
+ <span class="md-nav__icon md-icon"></span>
820
+ </label>
821
+ <nav class="md-nav" aria-label="config-store" data-md-level="2">
822
+ <label class="md-nav__title" for="nav-6-3">
823
+ <span class="md-nav__icon md-icon"></span>
824
+ config-store
825
+ </label>
826
+ <ul class="md-nav__list" data-md-scrollfix>
827
+
828
+
829
+
830
+
831
+
832
+
833
+
834
+ <li class="md-nav__item">
835
+ <a href="../config-store/" class="md-nav__link">
836
+ config-store
837
+ </a>
838
+ </li>
839
+
840
+
841
+
842
+
843
+
844
+
845
+
846
+ <li class="md-nav__item">
847
+ <a href="../config-store/configuration/" class="md-nav__link">
848
+ configuration
849
+ </a>
850
+ </li>
851
+
852
+
853
+
854
+
855
+
856
+
857
+
858
+ <li class="md-nav__item">
859
+ <a href="../config-store/providers/" class="md-nav__link">
860
+ providers
861
+ </a>
862
+ </li>
863
+
864
+
865
+ </ul>
866
+ </nav>
867
+ </li>
868
+
869
+
870
+
871
+
872
+
873
+
874
+
875
+ <li class="md-nav__item md-nav__item--nested">
876
+
877
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-6-4" type="checkbox" id="nav-6-4">
878
+
879
+ <label class="md-nav__link" for="nav-6-4">
880
+ graph
881
+ <span class="md-nav__icon md-icon"></span>
882
+ </label>
883
+ <nav class="md-nav" aria-label="graph" data-md-level="2">
884
+ <label class="md-nav__title" for="nav-6-4">
885
+ <span class="md-nav__icon md-icon"></span>
886
+ graph
887
+ </label>
888
+ <ul class="md-nav__list" data-md-scrollfix>
889
+
890
+
891
+
892
+
893
+
894
+
895
+
896
+ <li class="md-nav__item">
897
+ <a href="../graph/" class="md-nav__link">
898
+ graph
899
+ </a>
900
+ </li>
901
+
902
+
903
+
904
+
905
+
906
+
907
+
908
+ <li class="md-nav__item">
909
+ <a href="../graph/groups/" class="md-nav__link">
910
+ groups
911
+ </a>
912
+ </li>
913
+
914
+
915
+
916
+
917
+
918
+
919
+
920
+ <li class="md-nav__item">
921
+ <a href="../graph/insights/" class="md-nav__link">
922
+ insights
923
+ </a>
924
+ </li>
925
+
926
+
927
+
928
+
929
+
930
+
931
+
932
+ <li class="md-nav__item">
933
+ <a href="../graph/contacts/" class="md-nav__link">
934
+ contacts
935
+ </a>
936
+ </li>
937
+
938
+
939
+
940
+
941
+
942
+
943
+
944
+ <li class="md-nav__item">
945
+ <a href="../graph/calendars/" class="md-nav__link">
946
+ calendars
947
+ </a>
948
+ </li>
949
+
950
+
951
+
952
+
953
+
954
+
955
+
956
+ <li class="md-nav__item">
957
+ <a href="../graph/directoryobjects/" class="md-nav__link">
958
+ directory objects
959
+ </a>
960
+ </li>
961
+
962
+
963
+
964
+
965
+
966
+
967
+
968
+ <li class="md-nav__item">
969
+ <a href="../graph/invitations/" class="md-nav__link">
970
+ invitations
971
+ </a>
972
+ </li>
973
+
974
+
975
+
976
+
977
+
978
+
979
+
980
+ <li class="md-nav__item">
981
+ <a href="../graph/onedrive/" class="md-nav__link">
982
+ onedrive
983
+ </a>
984
+ </li>
985
+
986
+
987
+
988
+
989
+
990
+
991
+
992
+ <li class="md-nav__item">
993
+ <a href="../graph/outlook/" class="md-nav__link">
994
+ outlook
995
+ </a>
996
+ </li>
997
+
998
+
999
+
1000
+
1001
+
1002
+
1003
+
1004
+ <li class="md-nav__item">
1005
+ <a href="../graph/photos/" class="md-nav__link">
1006
+ photos
1007
+ </a>
1008
+ </li>
1009
+
1010
+
1011
+
1012
+
1013
+
1014
+
1015
+
1016
+ <li class="md-nav__item">
1017
+ <a href="../graph/planner/" class="md-nav__link">
1018
+ planner
1019
+ </a>
1020
+ </li>
1021
+
1022
+
1023
+
1024
+
1025
+
1026
+
1027
+
1028
+ <li class="md-nav__item">
1029
+ <a href="../graph/search/" class="md-nav__link">
1030
+ search
1031
+ </a>
1032
+ </li>
1033
+
1034
+
1035
+
1036
+
1037
+
1038
+
1039
+
1040
+ <li class="md-nav__item">
1041
+ <a href="../graph/subscriptions/" class="md-nav__link">
1042
+ subscriptions
1043
+ </a>
1044
+ </li>
1045
+
1046
+
1047
+
1048
+
1049
+
1050
+
1051
+
1052
+ <li class="md-nav__item">
1053
+ <a href="../graph/teams/" class="md-nav__link">
1054
+ teams
1055
+ </a>
1056
+ </li>
1057
+
1058
+
1059
+
1060
+
1061
+
1062
+
1063
+
1064
+ <li class="md-nav__item">
1065
+ <a href="../graph/users/" class="md-nav__link">
1066
+ users
1067
+ </a>
1068
+ </li>
1069
+
1070
+
1071
+ </ul>
1072
+ </nav>
1073
+ </li>
1074
+
1075
+
1076
+
1077
+
1078
+
1079
+
1080
+
1081
+ <li class="md-nav__item">
1082
+ <a href="../logging/" class="md-nav__link">
1083
+ logging
1084
+ </a>
1085
+ </li>
1086
+
1087
+
1088
+
1089
+
1090
+
1091
+
1092
+
1093
+ <li class="md-nav__item md-nav__item--nested">
1094
+
1095
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-6-6" type="checkbox" id="nav-6-6">
1096
+
1097
+ <label class="md-nav__link" for="nav-6-6">
1098
+ nodejs
1099
+ <span class="md-nav__icon md-icon"></span>
1100
+ </label>
1101
+ <nav class="md-nav" aria-label="nodejs" data-md-level="2">
1102
+ <label class="md-nav__title" for="nav-6-6">
1103
+ <span class="md-nav__icon md-icon"></span>
1104
+ nodejs
1105
+ </label>
1106
+ <ul class="md-nav__list" data-md-scrollfix>
1107
+
1108
+
1109
+
1110
+
1111
+
1112
+
1113
+
1114
+ <li class="md-nav__item">
1115
+ <a href="../nodejs/" class="md-nav__link">
1116
+ nodejs
1117
+ </a>
1118
+ </li>
1119
+
1120
+
1121
+
1122
+
1123
+
1124
+
1125
+
1126
+ <li class="md-nav__item">
1127
+ <a href="../nodejs/sp-fetch-client/" class="md-nav__link">
1128
+ SPFetchClient
1129
+ </a>
1130
+ </li>
1131
+
1132
+
1133
+
1134
+
1135
+
1136
+
1137
+
1138
+ <li class="md-nav__item">
1139
+ <a href="../nodejs/adal-fetch-client/" class="md-nav__link">
1140
+ AdalFetchClient
1141
+ </a>
1142
+ </li>
1143
+
1144
+
1145
+
1146
+
1147
+
1148
+
1149
+
1150
+ <li class="md-nav__item">
1151
+ <a href="../nodejs/bearer-token-fetch-client/" class="md-nav__link">
1152
+ BearerTokenFetchClient
1153
+ </a>
1154
+ </li>
1155
+
1156
+
1157
+
1158
+
1159
+
1160
+
1161
+
1162
+ <li class="md-nav__item">
1163
+ <a href="../nodejs/provider-hosted-app/" class="md-nav__link">
1164
+ ProviderHostedRequestContext
1165
+ </a>
1166
+ </li>
1167
+
1168
+
1169
+
1170
+
1171
+
1172
+
1173
+
1174
+ <li class="md-nav__item">
1175
+ <a href="../nodejs/sp-extensions/" class="md-nav__link">
1176
+ sp Extensions
1177
+ </a>
1178
+ </li>
1179
+
1180
+
1181
+
1182
+
1183
+
1184
+
1185
+
1186
+ <li class="md-nav__item">
1187
+ <a href="../nodejs/proxy/" class="md-nav__link">
1188
+ proxy
1189
+ </a>
1190
+ </li>
1191
+
1192
+
1193
+ </ul>
1194
+ </nav>
1195
+ </li>
1196
+
1197
+
1198
+
1199
+
1200
+
1201
+
1202
+
1203
+ <li class="md-nav__item md-nav__item--nested">
1204
+
1205
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-6-7" type="checkbox" id="nav-6-7">
1206
+
1207
+ <label class="md-nav__link" for="nav-6-7">
1208
+ odata
1209
+ <span class="md-nav__icon md-icon"></span>
1210
+ </label>
1211
+ <nav class="md-nav" aria-label="odata" data-md-level="2">
1212
+ <label class="md-nav__title" for="nav-6-7">
1213
+ <span class="md-nav__icon md-icon"></span>
1214
+ odata
1215
+ </label>
1216
+ <ul class="md-nav__list" data-md-scrollfix>
1217
+
1218
+
1219
+
1220
+
1221
+
1222
+
1223
+
1224
+ <li class="md-nav__item">
1225
+ <a href="../odata/" class="md-nav__link">
1226
+ odata
1227
+ </a>
1228
+ </li>
1229
+
1230
+
1231
+
1232
+
1233
+
1234
+
1235
+
1236
+ <li class="md-nav__item">
1237
+ <a href="../odata/caching/" class="md-nav__link">
1238
+ caching
1239
+ </a>
1240
+ </li>
1241
+
1242
+
1243
+
1244
+
1245
+
1246
+
1247
+
1248
+ <li class="md-nav__item">
1249
+ <a href="../odata/core/" class="md-nav__link">
1250
+ core
1251
+ </a>
1252
+ </li>
1253
+
1254
+
1255
+
1256
+
1257
+
1258
+
1259
+
1260
+ <li class="md-nav__item">
1261
+ <a href="../odata/odata-batch/" class="md-nav__link">
1262
+ OData Batching
1263
+ </a>
1264
+ </li>
1265
+
1266
+
1267
+
1268
+
1269
+
1270
+
1271
+
1272
+ <li class="md-nav__item">
1273
+ <a href="../odata/extensions/" class="md-nav__link">
1274
+ Extending an OData library
1275
+ </a>
1276
+ </li>
1277
+
1278
+
1279
+
1280
+
1281
+
1282
+
1283
+
1284
+ <li class="md-nav__item">
1285
+ <a href="../odata/debug/" class="md-nav__link">
1286
+ Debugging Proxy Objects
1287
+ </a>
1288
+ </li>
1289
+
1290
+
1291
+
1292
+
1293
+
1294
+
1295
+
1296
+ <li class="md-nav__item">
1297
+ <a href="../odata/parsers/" class="md-nav__link">
1298
+ Parsers
1299
+ </a>
1300
+ </li>
1301
+
1302
+
1303
+
1304
+
1305
+
1306
+
1307
+
1308
+ <li class="md-nav__item">
1309
+ <a href="../odata/pipeline/" class="md-nav__link">
1310
+ Pipeline
1311
+ </a>
1312
+ </li>
1313
+
1314
+
1315
+
1316
+
1317
+
1318
+
1319
+
1320
+ <li class="md-nav__item">
1321
+ <a href="../odata/queryable/" class="md-nav__link">
1322
+ Queryable
1323
+ </a>
1324
+ </li>
1325
+
1326
+
1327
+ </ul>
1328
+ </nav>
1329
+ </li>
1330
+
1331
+
1332
+
1333
+
1334
+
1335
+
1336
+
1337
+ <li class="md-nav__item md-nav__item--nested">
1338
+
1339
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-6-8" type="checkbox" id="nav-6-8">
1340
+
1341
+ <label class="md-nav__link" for="nav-6-8">
1342
+ pnpjs
1343
+ <span class="md-nav__icon md-icon"></span>
1344
+ </label>
1345
+ <nav class="md-nav" aria-label="pnpjs" data-md-level="2">
1346
+ <label class="md-nav__title" for="nav-6-8">
1347
+ <span class="md-nav__icon md-icon"></span>
1348
+ pnpjs
1349
+ </label>
1350
+ <ul class="md-nav__list" data-md-scrollfix>
1351
+
1352
+
1353
+
1354
+
1355
+
1356
+
1357
+
1358
+ <li class="md-nav__item">
1359
+ <a href="../pnpjs/" class="md-nav__link">
1360
+ pnpjs
1361
+ </a>
1362
+ </li>
1363
+
1364
+
1365
+ </ul>
1366
+ </nav>
1367
+ </li>
1368
+
1369
+
1370
+
1371
+
1372
+
1373
+
1374
+
1375
+ <li class="md-nav__item md-nav__item--nested">
1376
+
1377
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-6-9" type="checkbox" id="nav-6-9">
1378
+
1379
+ <label class="md-nav__link" for="nav-6-9">
1380
+ sp
1381
+ <span class="md-nav__icon md-icon"></span>
1382
+ </label>
1383
+ <nav class="md-nav" aria-label="sp" data-md-level="2">
1384
+ <label class="md-nav__title" for="nav-6-9">
1385
+ <span class="md-nav__icon md-icon"></span>
1386
+ sp
1387
+ </label>
1388
+ <ul class="md-nav__list" data-md-scrollfix>
1389
+
1390
+
1391
+
1392
+
1393
+
1394
+
1395
+
1396
+ <li class="md-nav__item">
1397
+ <a href="../sp/" class="md-nav__link">
1398
+ sp
1399
+ </a>
1400
+ </li>
1401
+
1402
+
1403
+
1404
+
1405
+
1406
+
1407
+
1408
+ <li class="md-nav__item">
1409
+ <a href="../sp/alias-parameters/" class="md-nav__link">
1410
+ Alias Parameters
1411
+ </a>
1412
+ </li>
1413
+
1414
+
1415
+
1416
+
1417
+
1418
+
1419
+
1420
+ <li class="md-nav__item">
1421
+ <a href="../sp/alm/" class="md-nav__link">
1422
+ ALM api
1423
+ </a>
1424
+ </li>
1425
+
1426
+
1427
+
1428
+
1429
+
1430
+
1431
+
1432
+ <li class="md-nav__item">
1433
+ <a href="../sp/attachments/" class="md-nav__link">
1434
+ Attachments
1435
+ </a>
1436
+ </li>
1437
+
1438
+
1439
+
1440
+
1441
+
1442
+
1443
+
1444
+ <li class="md-nav__item">
1445
+ <a href="../sp/clientside-pages/" class="md-nav__link">
1446
+ Client-side Pages
1447
+ </a>
1448
+ </li>
1449
+
1450
+
1451
+
1452
+
1453
+
1454
+
1455
+
1456
+ <li class="md-nav__item">
1457
+ <a href="../sp/column-defaults/" class="md-nav__link">
1458
+ Column Defaults
1459
+ </a>
1460
+ </li>
1461
+
1462
+
1463
+
1464
+
1465
+
1466
+
1467
+
1468
+ <li class="md-nav__item">
1469
+ <a href="../sp/comments-likes/" class="md-nav__link">
1470
+ Comments and Likes
1471
+ </a>
1472
+ </li>
1473
+
1474
+
1475
+
1476
+
1477
+
1478
+
1479
+
1480
+ <li class="md-nav__item">
1481
+ <a href="../sp/content-types/" class="md-nav__link">
1482
+ Content Types
1483
+ </a>
1484
+ </li>
1485
+
1486
+
1487
+
1488
+
1489
+
1490
+
1491
+
1492
+ <li class="md-nav__item">
1493
+ <a href="../sp/entity-merging/" class="md-nav__link">
1494
+ Entity Merging
1495
+ </a>
1496
+ </li>
1497
+
1498
+
1499
+
1500
+
1501
+
1502
+
1503
+
1504
+ <li class="md-nav__item">
1505
+ <a href="../sp/features/" class="md-nav__link">
1506
+ Features
1507
+ </a>
1508
+ </li>
1509
+
1510
+
1511
+
1512
+
1513
+
1514
+
1515
+
1516
+ <li class="md-nav__item">
1517
+ <a href="../sp/fields/" class="md-nav__link">
1518
+ Fields
1519
+ </a>
1520
+ </li>
1521
+
1522
+
1523
+
1524
+
1525
+
1526
+
1527
+
1528
+ <li class="md-nav__item">
1529
+ <a href="../sp/files/" class="md-nav__link">
1530
+ Files
1531
+ </a>
1532
+ </li>
1533
+
1534
+
1535
+
1536
+
1537
+
1538
+
1539
+
1540
+ <li class="md-nav__item">
1541
+ <a href="../sp/folders/" class="md-nav__link">
1542
+ Folders
1543
+ </a>
1544
+ </li>
1545
+
1546
+
1547
+
1548
+
1549
+
1550
+
1551
+
1552
+ <li class="md-nav__item">
1553
+ <a href="../sp/forms/" class="md-nav__link">
1554
+ Forms
1555
+ </a>
1556
+ </li>
1557
+
1558
+
1559
+
1560
+
1561
+
1562
+
1563
+
1564
+ <li class="md-nav__item">
1565
+ <a href="../sp/hubsites/" class="md-nav__link">
1566
+ Hubsites
1567
+ </a>
1568
+ </li>
1569
+
1570
+
1571
+
1572
+
1573
+
1574
+
1575
+
1576
+ <li class="md-nav__item">
1577
+ <a href="../sp/items/" class="md-nav__link">
1578
+ List Items
1579
+ </a>
1580
+ </li>
1581
+
1582
+
1583
+
1584
+
1585
+
1586
+
1587
+
1588
+ <li class="md-nav__item">
1589
+ <a href="../sp/lists/" class="md-nav__link">
1590
+ Lists
1591
+ </a>
1592
+ </li>
1593
+
1594
+
1595
+
1596
+
1597
+
1598
+
1599
+
1600
+ <li class="md-nav__item">
1601
+ <a href="../sp/navigation/" class="md-nav__link">
1602
+ Navigation
1603
+ </a>
1604
+ </li>
1605
+
1606
+
1607
+
1608
+
1609
+
1610
+
1611
+
1612
+ <li class="md-nav__item">
1613
+ <a href="../sp/permissions/" class="md-nav__link">
1614
+ Permissions
1615
+ </a>
1616
+ </li>
1617
+
1618
+
1619
+
1620
+
1621
+
1622
+
1623
+
1624
+ <li class="md-nav__item">
1625
+ <a href="../sp/profiles/" class="md-nav__link">
1626
+ Profiles
1627
+ </a>
1628
+ </li>
1629
+
1630
+
1631
+
1632
+
1633
+
1634
+
1635
+
1636
+ <li class="md-nav__item">
1637
+ <a href="../sp/regional-settings/" class="md-nav__link">
1638
+ Regional Settings
1639
+ </a>
1640
+ </li>
1641
+
1642
+
1643
+
1644
+
1645
+
1646
+
1647
+
1648
+ <li class="md-nav__item">
1649
+ <a href="../sp/related-items/" class="md-nav__link">
1650
+ Related Items
1651
+ </a>
1652
+ </li>
1653
+
1654
+
1655
+
1656
+
1657
+
1658
+
1659
+
1660
+ <li class="md-nav__item">
1661
+ <a href="../sp/search/" class="md-nav__link">
1662
+ Search
1663
+ </a>
1664
+ </li>
1665
+
1666
+
1667
+
1668
+
1669
+
1670
+
1671
+
1672
+ <li class="md-nav__item">
1673
+ <a href="../sp/security/" class="md-nav__link">
1674
+ Security
1675
+ </a>
1676
+ </li>
1677
+
1678
+
1679
+
1680
+
1681
+
1682
+
1683
+
1684
+ <li class="md-nav__item">
1685
+ <a href="../sp/sharing/" class="md-nav__link">
1686
+ Sharing
1687
+ </a>
1688
+ </li>
1689
+
1690
+
1691
+
1692
+
1693
+
1694
+
1695
+
1696
+ <li class="md-nav__item">
1697
+ <a href="../sp/site-designs/" class="md-nav__link">
1698
+ Site Designs
1699
+ </a>
1700
+ </li>
1701
+
1702
+
1703
+
1704
+
1705
+
1706
+
1707
+
1708
+ <li class="md-nav__item">
1709
+ <a href="../sp/site-groups/" class="md-nav__link">
1710
+ Site Groups
1711
+ </a>
1712
+ </li>
1713
+
1714
+
1715
+
1716
+
1717
+
1718
+
1719
+
1720
+ <li class="md-nav__item">
1721
+ <a href="../sp/site-scripts/" class="md-nav__link">
1722
+ Site Scripts
1723
+ </a>
1724
+ </li>
1725
+
1726
+
1727
+
1728
+
1729
+
1730
+
1731
+
1732
+ <li class="md-nav__item">
1733
+ <a href="../sp/site-users/" class="md-nav__link">
1734
+ Site Users
1735
+ </a>
1736
+ </li>
1737
+
1738
+
1739
+
1740
+
1741
+
1742
+
1743
+
1744
+ <li class="md-nav__item">
1745
+ <a href="../sp/sites/" class="md-nav__link">
1746
+ Sites
1747
+ </a>
1748
+ </li>
1749
+
1750
+
1751
+
1752
+
1753
+
1754
+
1755
+
1756
+ <li class="md-nav__item">
1757
+ <a href="../sp/social/" class="md-nav__link">
1758
+ Social
1759
+ </a>
1760
+ </li>
1761
+
1762
+
1763
+
1764
+
1765
+
1766
+
1767
+
1768
+ <li class="md-nav__item">
1769
+ <a href="../sp/sp-utilities-utility/" class="md-nav__link">
1770
+ SP.Utilities.Utility
1771
+ </a>
1772
+ </li>
1773
+
1774
+
1775
+
1776
+
1777
+
1778
+
1779
+
1780
+ <li class="md-nav__item">
1781
+ <a href="../sp/subscriptions/" class="md-nav__link">
1782
+ Subscriptions
1783
+ </a>
1784
+ </li>
1785
+
1786
+
1787
+
1788
+
1789
+
1790
+
1791
+
1792
+ <li class="md-nav__item">
1793
+ <a href="../sp/taxonomy/" class="md-nav__link">
1794
+ Taxonomy
1795
+ </a>
1796
+ </li>
1797
+
1798
+
1799
+
1800
+
1801
+
1802
+
1803
+
1804
+ <li class="md-nav__item">
1805
+ <a href="../sp/tenant-properties/" class="md-nav__link">
1806
+ Tenant Properties
1807
+ </a>
1808
+ </li>
1809
+
1810
+
1811
+
1812
+
1813
+
1814
+
1815
+
1816
+ <li class="md-nav__item">
1817
+ <a href="../sp/user-custom-actions/" class="md-nav__link">
1818
+ User custom actions
1819
+ </a>
1820
+ </li>
1821
+
1822
+
1823
+
1824
+
1825
+
1826
+
1827
+
1828
+ <li class="md-nav__item">
1829
+ <a href="../sp/views/" class="md-nav__link">
1830
+ Views
1831
+ </a>
1832
+ </li>
1833
+
1834
+
1835
+
1836
+
1837
+
1838
+
1839
+
1840
+ <li class="md-nav__item">
1841
+ <a href="../sp/webs/" class="md-nav__link">
1842
+ Webs
1843
+ </a>
1844
+ </li>
1845
+
1846
+
1847
+
1848
+
1849
+
1850
+
1851
+
1852
+ <li class="md-nav__item">
1853
+ <a href="../sp/custom-irequestclient/" class="md-nav__link">
1854
+ Custom Request Client
1855
+ </a>
1856
+ </li>
1857
+
1858
+
1859
+ </ul>
1860
+ </nav>
1861
+ </li>
1862
+
1863
+
1864
+
1865
+
1866
+
1867
+
1868
+
1869
+ <li class="md-nav__item md-nav__item--nested">
1870
+
1871
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-6-10" type="checkbox" id="nav-6-10">
1872
+
1873
+ <label class="md-nav__link" for="nav-6-10">
1874
+ sp-addinhelpers
1875
+ <span class="md-nav__icon md-icon"></span>
1876
+ </label>
1877
+ <nav class="md-nav" aria-label="sp-addinhelpers" data-md-level="2">
1878
+ <label class="md-nav__title" for="nav-6-10">
1879
+ <span class="md-nav__icon md-icon"></span>
1880
+ sp-addinhelpers
1881
+ </label>
1882
+ <ul class="md-nav__list" data-md-scrollfix>
1883
+
1884
+
1885
+
1886
+
1887
+
1888
+
1889
+
1890
+ <li class="md-nav__item">
1891
+ <a href="../sp-addinhelpers/" class="md-nav__link">
1892
+ sp-addinhelpers
1893
+ </a>
1894
+ </li>
1895
+
1896
+
1897
+
1898
+
1899
+
1900
+
1901
+
1902
+ <li class="md-nav__item">
1903
+ <a href="../sp-addinhelpers/sp-request-executor-client/" class="md-nav__link">
1904
+ SPRequestExecutorClient
1905
+ </a>
1906
+ </li>
1907
+
1908
+
1909
+
1910
+
1911
+
1912
+
1913
+
1914
+ <li class="md-nav__item">
1915
+ <a href="../sp-addinhelpers/sp-rest-addin/" class="md-nav__link">
1916
+ SPRestAddIn
1917
+ </a>
1918
+ </li>
1919
+
1920
+
1921
+ </ul>
1922
+ </nav>
1923
+ </li>
1924
+
1925
+
1926
+ </ul>
1927
+ </nav>
1928
+ </li>
1929
+
1930
+
1931
+
1932
+
1933
+
1934
+
1935
+
1936
+ <li class="md-nav__item md-nav__item--nested">
1937
+
1938
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7">
1939
+
1940
+ <label class="md-nav__link" for="nav-7">
1941
+ Contributing
1942
+ <span class="md-nav__icon md-icon"></span>
1943
+ </label>
1944
+ <nav class="md-nav" aria-label="Contributing" data-md-level="1">
1945
+ <label class="md-nav__title" for="nav-7">
1946
+ <span class="md-nav__icon md-icon"></span>
1947
+ Contributing
1948
+ </label>
1949
+ <ul class="md-nav__list" data-md-scrollfix>
1950
+
1951
+
1952
+
1953
+
1954
+
1955
+
1956
+
1957
+ <li class="md-nav__item">
1958
+ <a href="../contributing/" class="md-nav__link">
1959
+ Contributing
1960
+ </a>
1961
+ </li>
1962
+
1963
+
1964
+
1965
+
1966
+
1967
+
1968
+
1969
+ <li class="md-nav__item">
1970
+ <a href="../contributing/setup-dev-machine/" class="md-nav__link">
1971
+ Setup Dev Machine
1972
+ </a>
1973
+ </li>
1974
+
1975
+
1976
+
1977
+
1978
+
1979
+
1980
+
1981
+ <li class="md-nav__item">
1982
+ <a href="../contributing/local-debug-configuration/" class="md-nav__link">
1983
+ Local Debug Configuration
1984
+ </a>
1985
+ </li>
1986
+
1987
+
1988
+
1989
+
1990
+
1991
+
1992
+
1993
+ <li class="md-nav__item">
1994
+ <a href="../contributing/debugging/" class="md-nav__link">
1995
+ Debugging
1996
+ </a>
1997
+ </li>
1998
+
1999
+
2000
+
2001
+
2002
+
2003
+
2004
+
2005
+ <li class="md-nav__item">
2006
+ <a href="../contributing/extending-the-library/" class="md-nav__link">
2007
+ Extending the library
2008
+ </a>
2009
+ </li>
2010
+
2011
+
2012
+
2013
+
2014
+
2015
+
2016
+
2017
+ <li class="md-nav__item">
2018
+ <a href="../contributing/debug-tests/" class="md-nav__link">
2019
+ Writing Tests
2020
+ </a>
2021
+ </li>
2022
+
2023
+
2024
+
2025
+
2026
+
2027
+
2028
+
2029
+ <li class="md-nav__item">
2030
+ <a href="../contributing/documentation/" class="md-nav__link">
2031
+ Update Documentation
2032
+ </a>
2033
+ </li>
2034
+
2035
+
2036
+
2037
+
2038
+
2039
+
2040
+
2041
+ <li class="md-nav__item">
2042
+ <a href="../contributing/pull-requests/" class="md-nav__link">
2043
+ Submit a Pull Request
2044
+ </a>
2045
+ </li>
2046
+
2047
+
2048
+ </ul>
2049
+ </nav>
2050
+ </li>
2051
+
2052
+
2053
+
2054
+
2055
+
2056
+
2057
+
2058
+ <li class="md-nav__item md-nav__item--nested">
2059
+
2060
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-8" type="checkbox" id="nav-8">
2061
+
2062
+ <label class="md-nav__link" for="nav-8">
2063
+ Version 1 Docs
2064
+ <span class="md-nav__icon md-icon"></span>
2065
+ </label>
2066
+ <nav class="md-nav" aria-label="Version 1 Docs" data-md-level="1">
2067
+ <label class="md-nav__title" for="nav-8">
2068
+ <span class="md-nav__icon md-icon"></span>
2069
+ Version 1 Docs
2070
+ </label>
2071
+ <ul class="md-nav__list" data-md-scrollfix>
2072
+
2073
+
2074
+
2075
+
2076
+
2077
+
2078
+
2079
+ <li class="md-nav__item">
2080
+ <a href="../v1/" class="md-nav__link">
2081
+ Home
2082
+ </a>
2083
+ </li>
2084
+
2085
+
2086
+ </ul>
2087
+ </nav>
2088
+ </li>
2089
+
2090
+
2091
+
2092
+
2093
+
2094
+
2095
+
2096
+ <li class="md-nav__item md-nav__item--nested">
2097
+
2098
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-9" type="checkbox" id="nav-9">
2099
+
2100
+ <label class="md-nav__link" for="nav-9">
2101
+ Version 2 Docs
2102
+ <span class="md-nav__icon md-icon"></span>
2103
+ </label>
2104
+ <nav class="md-nav" aria-label="Version 2 Docs" data-md-level="1">
2105
+ <label class="md-nav__title" for="nav-9">
2106
+ <span class="md-nav__icon md-icon"></span>
2107
+ Version 2 Docs
2108
+ </label>
2109
+ <ul class="md-nav__list" data-md-scrollfix>
2110
+
2111
+
2112
+
2113
+
2114
+
2115
+
2116
+
2117
+ <li class="md-nav__item">
2118
+ <a href="../v2/index.html" class="md-nav__link">
2119
+ Home
2120
+ </a>
2121
+ </li>
2122
+
2123
+
2124
+ </ul>
2125
+ </nav>
2126
+ </li>
2127
+
2128
+
2129
+ </ul>
2130
+ </nav>
2131
+ </div>
2132
+ </div>
2133
+ </div>
2134
+
2135
+
2136
+ <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
2137
+ <div class="md-sidebar__scrollwrap">
2138
+ <div class="md-sidebar__inner">
2139
+
2140
+ <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2141
+
2142
+
2143
+
2144
+
2145
+
2146
+ <label class="md-nav__title" for="__toc">
2147
+ <span class="md-nav__icon md-icon"></span>
2148
+ Table of contents
2149
+ </label>
2150
+ <ul class="md-nav__list" data-md-scrollfix>
2151
+
2152
+ <li class="md-nav__item">
2153
+ <a href="#installing-pnp-libraries" class="md-nav__link">
2154
+ Installing @pnp libraries
2155
+ </a>
2156
+
2157
+ </li>
2158
+
2159
+ <li class="md-nav__item">
2160
+ <a href="#selective-imports" class="md-nav__link">
2161
+ Selective Imports
2162
+ </a>
2163
+
2164
+ <nav class="md-nav" aria-label="Selective Imports">
2165
+ <ul class="md-nav__list">
2166
+
2167
+ <li class="md-nav__item">
2168
+ <a href="#selectively-import-web-lists-functionality" class="md-nav__link">
2169
+ Selectively Import Web lists functionality
2170
+ </a>
2171
+
2172
+ </li>
2173
+
2174
+ <li class="md-nav__item">
2175
+ <a href="#presets" class="md-nav__link">
2176
+ Presets
2177
+ </a>
2178
+
2179
+ </li>
2180
+
2181
+ </ul>
2182
+ </nav>
2183
+
2184
+ </li>
2185
+
2186
+ <li class="md-nav__item">
2187
+ <a href="#invokable-objects" class="md-nav__link">
2188
+ Invokable Objects
2189
+ </a>
2190
+
2191
+ </li>
2192
+
2193
+ <li class="md-nav__item">
2194
+ <a href="#factory-functions-interfaces" class="md-nav__link">
2195
+ Factory Functions &amp; Interfaces
2196
+ </a>
2197
+
2198
+ </li>
2199
+
2200
+ <li class="md-nav__item">
2201
+ <a href="#extension-methods" class="md-nav__link">
2202
+ Extension Methods
2203
+ </a>
2204
+
2205
+ </li>
2206
+
2207
+ <li class="md-nav__item">
2208
+ <a href="#cdn-publishing" class="md-nav__link">
2209
+ CDN publishing
2210
+ </a>
2211
+
2212
+ </li>
2213
+
2214
+ <li class="md-nav__item">
2215
+ <a href="#drop-client-svc-and-sp-taxonomy-libraries" class="md-nav__link">
2216
+ Drop client-svc and sp-taxonomy libraries
2217
+ </a>
2218
+
2219
+ </li>
2220
+
2221
+ </ul>
2222
+
2223
+ </nav>
2224
+ </div>
2225
+ </div>
2226
+ </div>
2227
+
2228
+
2229
+ <div class="md-content">
2230
+ <article class="md-content__inner md-typeset">
2231
+
2232
+
2233
+ <a href="https://github.com/pnp/pnpjs/tree/version-2/docs/transition-guide.md" title="Edit this page" class="md-content__button md-icon">
2234
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
2235
+ </a>
2236
+
2237
+
2238
+ <h1 id="transition-guide">Transition Guide<a class="headerlink" href="#transition-guide" title="Permanent link">&para;</a></h1>
2239
+ <p>We have worked to make moving from @pnp library 1.<em> to 2.</em> as painless as possible, however there are some changes to how things work. The below guide we have provided an overview of what it takes to transition between the libraries. If we missed something, please let us know in the issues list so we can update the guide. Thanks!</p>
2240
+ <h2 id="installing-pnp-libraries">Installing @pnp libraries<a class="headerlink" href="#installing-pnp-libraries" title="Permanent link">&para;</a></h2>
2241
+ <p>In version 1.* the libraries were setup as peer dependencies of each other requiring you to install each of them separately. We continue to believe this correctly describes the relationship, but recognize that basically nothing in the world accounts for peer dependencies. So we have updated the libraries to be dependencies. This makes it easier to install into your projects as you only need to install a single library:</p>
2242
+ <p><code>npm i --save @pnp/sp</code></p>
2243
+ <h2 id="selective-imports">Selective Imports<a class="headerlink" href="#selective-imports" title="Permanent link">&para;</a></h2>
2244
+ <p>Another big change in v2 is the ability to selectively import the pieces you need from the libraries. This allows you to have smaller bundles and works well with tree-shaking. It does require you to have more import statements, which can potentially be a bit confusing at first. The selective imports apply to the sp and graph libraries.</p>
2245
+ <p>To help explain let's take the example of the Web object. In v1 Web includes a reference to pretty much everything else in the entire sp library. Meaning that if you use web (and you pretty much have to) you hold a ref to all the other pieces (like Fields, Lists, ContentTypes) even if you aren't using them. Because of that tree shaking can't do anything to reduce the bundle size because it "thinks" you are using them simply because they have been imported. To solve this in v2 the Web object no longer contains references to anything, it is a bare object with a few methods. If you look at the source you will see that, for example, there is no longer a "lists" property. These properties and methods are now added through selectively importing the functionality you need:</p>
2246
+ <h3 id="selectively-import-web-lists-functionality">Selectively Import Web lists functionality<a class="headerlink" href="#selectively-import-web-lists-functionality" title="Permanent link">&para;</a></h3>
2247
+ <pre><code class="language-TypeScript">import { sp } from &quot;@pnp/sp&quot;;
2248
+ import &quot;@pnp/sp/webs&quot;;
2249
+ // this imports the functionality for lists associated only with web
2250
+ import &quot;@pnp/sp/lists/web&quot;;
2251
+
2252
+ const r = await sp.web.lists();
2253
+ </code></pre>
2254
+ <pre><code class="language-TypeScript">import { sp } from &quot;@pnp/sp&quot;;
2255
+ import &quot;@pnp/sp/webs&quot;;
2256
+ // this imports all the functionality for lists
2257
+ import &quot;@pnp/sp/lists&quot;;
2258
+
2259
+ const r = await sp.web.lists();
2260
+ </code></pre>
2261
+ <p>Each of the docs pages shows the selective import paths for each sub-module (lists, items, etc.).</p>
2262
+ <h3 id="presets">Presets<a class="headerlink" href="#presets" title="Permanent link">&para;</a></h3>
2263
+ <p>In addition to the ability to selectively import functionality you can import presets. This allows you to import an entire set of functionality in a single line. At launch the sp library will support two presets "all" and "core" with the graph library supporting "all". <strong>Using the "all" preset will match the functionality of v1.</strong> This can save you time in transitioning your projects so you can update to selective imports later. For new projects we recommend using the selective imports from day 1.</p>
2264
+ <p>To update your V1 projects to V2 you can replace all instances of "@pnp/sp" with "@pnp/sp/presets/all" and things should work as before (though some class names or other things may have changed, please review the change log and the rest of this guide).</p>
2265
+ <pre><code class="language-TypeScript">// V1 way of doing things:
2266
+ import {
2267
+ sp,
2268
+ ClientSideWebpart,
2269
+ ClientSideWebpartPropertyTypes,
2270
+ } from &quot;@pnp/sp&quot;;
2271
+
2272
+ // V2 way with selective imports
2273
+ import { sp } from &quot;@pnp/sp&quot;;
2274
+ import { ClientSideWebpart, ClientSideWebpartPropertyTypes } from &quot;@pnp/sp/clientside-pages&quot;;
2275
+
2276
+ // V2 way with preset &quot;all&quot;
2277
+ import { sp, ClientSideWebpart, ClientSideWebpartPropertyTypes } from &quot;@pnp/sp/presets/all&quot;;
2278
+ </code></pre>
2279
+ <h2 id="invokable-objects">Invokable Objects<a class="headerlink" href="#invokable-objects" title="Permanent link">&para;</a></h2>
2280
+ <p>Another new feature is the addition of invokable objects. Previously where you used "get()" to invoke a request you can now leave it off. We have left the .get method in place so everyone's code wasn't broken immediately upon transitioning.</p>
2281
+ <pre><code class="language-TypeScript">import { sp } from &quot;@pnp/sp&quot;;
2282
+ import &quot;@pnp/sp/webs&quot;;
2283
+
2284
+ // old way (still works)
2285
+ const r1 = sp.web();
2286
+
2287
+ // invokable
2288
+ const r2 = sp.web();
2289
+ </code></pre>
2290
+ <p>The benefit is that objects can now support default actions that are not "get" but might be "post". And you save typing a few extra characters. This still work the same as with select or any of the other odata methods:</p>
2291
+ <pre><code class="language-TypeScript">import { sp } from &quot;@pnp/sp&quot;;
2292
+ import &quot;@pnp/sp/webs&quot;;
2293
+
2294
+ // invokable
2295
+ const r = sp.web.select(&quot;Title&quot;, &quot;Url&quot;)();
2296
+ </code></pre>
2297
+ <h2 id="factory-functions-interfaces">Factory Functions &amp; Interfaces<a class="headerlink" href="#factory-functions-interfaces" title="Permanent link">&para;</a></h2>
2298
+ <p>Another change in the library is in the structure of exports. We are no longer exporting the objects themselves, rather we are only exposing factory functions and interfaces. This allows us to decouple what developers use from our internal implementation. For folks using the fluent chain starting with sp you shouldn't need to update your code. If you are using any of the v1 classes directly you should just need to remove the "new" keyword and update the import path. The factory functions signature matches the constructor signature of the v1 objects.</p>
2299
+ <pre><code class="language-TypeScript">// v1
2300
+ import { Web } from &quot;@pnp/sp&quot;;
2301
+
2302
+ const web: Web = new Web(&quot;some absolute url&quot;);
2303
+
2304
+ const r1 = web();
2305
+
2306
+ // v2
2307
+ import { Web, IWeb } from &quot;@pnp/sp/webs&quot;;
2308
+
2309
+ const web: IWeb = Web(&quot;some absolute url&quot;);
2310
+
2311
+ const r2 = web();
2312
+ </code></pre>
2313
+ <h2 id="extension-methods">Extension Methods<a class="headerlink" href="#extension-methods" title="Permanent link">&para;</a></h2>
2314
+ <p>Another new capability in v2 is the ability to extend objects and factories. This allows you to easily add methods or properties on a per-object basis. Please see the <a href="../odata/extensions/">full article on extension methods</a> describing this great new capability.</p>
2315
+ <h2 id="cdn-publishing">CDN publishing<a class="headerlink" href="#cdn-publishing" title="Permanent link">&para;</a></h2>
2316
+ <p>Starting with v2 we will no longer create bundles for each of the packages. Historically these are not commonly used, don't work perfectly for everyone (there are a lot of ways to bundle things), and another piece we need to maintain. Instead we encourage folks to create their <a href="../concepts/custom-bundle/">own bundles</a>, optimized for their particular scenario. This will result in smaller overall bundle size and allow folks to bundle things to match their scenario. Please <a href="../concepts/custom-bundle/">review the article on creating your custom bundles</a> to see how to tailor bundles to your needs.</p>
2317
+ <p>The PnPjs bundle will remain, though it is designed only for backwards compatibility and we strongly recommend creating your own bundles, or directly importing the libraries into your projects using selective imports.</p>
2318
+ <h2 id="drop-client-svc-and-sp-taxonomy-libraries">Drop client-svc and sp-taxonomy libraries<a class="headerlink" href="#drop-client-svc-and-sp-taxonomy-libraries" title="Permanent link">&para;</a></h2>
2319
+ <p>These libraries were created to allow folks to access and manage SharePoint taxonomy and manage metadata. Given that there is upcoming support for taxonomy via a supported REST API we will drop these two libraries. If working with taxonomy remains a core requirement of your application and we do not yet have support for the new apis, please remain on v1 for the time being.</p>
2320
+ <blockquote>
2321
+ <p>As of 2.0.6 we support reading the modern taxonomy API. <a href="../sp/taxonomy/">Docs here</a></p>
2322
+ </blockquote>
2323
+
2324
+
2325
+
2326
+
2327
+
2328
+
2329
+
2330
+ </article>
2331
+ </div>
2332
+ </div>
2333
+ </main>
2334
+
2335
+
2336
+ <footer class="md-footer">
2337
+
2338
+ <div class="md-footer-nav">
2339
+ <nav class="md-footer-nav__inner md-grid" aria-label="Footer">
2340
+
2341
+ <a href="../getting-started/" class="md-footer-nav__link md-footer-nav__link--prev" rel="prev">
2342
+ <div class="md-footer-nav__button md-icon">
2343
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
2344
+ </div>
2345
+ <div class="md-footer-nav__title">
2346
+ <div class="md-ellipsis">
2347
+ <span class="md-footer-nav__direction">
2348
+ Previous
2349
+ </span>
2350
+ Getting Started
2351
+ </div>
2352
+ </div>
2353
+ </a>
2354
+
2355
+
2356
+ <a href="../npm-scripts/" class="md-footer-nav__link md-footer-nav__link--next" rel="next">
2357
+ <div class="md-footer-nav__title">
2358
+ <div class="md-ellipsis">
2359
+ <span class="md-footer-nav__direction">
2360
+ Next
2361
+ </span>
2362
+ Npm Scripts
2363
+ </div>
2364
+ </div>
2365
+ <div class="md-footer-nav__button md-icon">
2366
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
2367
+ </div>
2368
+ </a>
2369
+
2370
+ </nav>
2371
+ </div>
2372
+
2373
+ <div class="md-footer-meta md-typeset">
2374
+ <div class="md-footer-meta__inner md-grid">
2375
+ <div class="md-footer-copyright">
2376
+
2377
+ Made with
2378
+ <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2379
+ Material for MkDocs
2380
+ </a>
2381
+ </div>
2382
+
2383
+ <div class="md-footer-social">
2384
+
2385
+
2386
+
2387
+
2388
+
2389
+
2390
+ <a href="https://twitter.com/m365pnpjs" target="_blank" rel="noopener" title="twitter.com" class="md-footer-social__link">
2391
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z"/></svg>
2392
+ </a>
2393
+
2394
+
2395
+
2396
+
2397
+
2398
+
2399
+ <a href="http://aka.ms/sppnp-videos" target="_blank" rel="noopener" title="aka.ms" class="md-footer-social__link">
2400
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><path d="M549.655 124.083c-6.281-23.65-24.787-42.276-48.284-48.597C458.781 64 288 64 288 64S117.22 64 74.629 75.486c-23.497 6.322-42.003 24.947-48.284 48.597-11.412 42.867-11.412 132.305-11.412 132.305s0 89.438 11.412 132.305c6.281 23.65 24.787 41.5 48.284 47.821C117.22 448 288 448 288 448s170.78 0 213.371-11.486c23.497-6.321 42.003-24.171 48.284-47.821 11.412-42.867 11.412-132.305 11.412-132.305s0-89.438-11.412-132.305zm-317.51 213.508V175.185l142.739 81.205-142.739 81.201z"/></svg>
2401
+ </a>
2402
+
2403
+
2404
+
2405
+
2406
+
2407
+
2408
+ <a href="https://aka.ms/sppnp" target="_blank" rel="noopener" title="aka.ms" class="md-footer-social__link">
2409
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M0 32h214.6v214.6H0V32zm233.4 0H448v214.6H233.4V32zM0 265.4h214.6V480H0V265.4zm233.4 0H448V480H233.4V265.4z"/></svg>
2410
+ </a>
2411
+
2412
+ </div>
2413
+
2414
+ </div>
2415
+ </div>
2416
+ </footer>
2417
+
2418
+ </div>
2419
+
2420
+ <script src="../assets/javascripts/vendor.77e55a48.min.js"></script>
2421
+ <script src="../assets/javascripts/bundle.9554a270.min.js"></script><script id="__lang" type="application/json">{"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}</script>
2422
+
2423
+ <script>
2424
+ app = initialize({
2425
+ base: "..",
2426
+ features: [],
2427
+ search: Object.assign({
2428
+ worker: "../assets/javascripts/worker/search.4ac00218.min.js"
2429
+ }, typeof search !== "undefined" && search)
2430
+ })
2431
+ </script>
2432
+
2433
+
2434
+ </body>
2435
+ </html>