@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/v1/documentation/getting-started/index.html ADDED
@@ -0,0 +1,2280 @@
1
+
2
+
3
+
4
+
5
+ <!DOCTYPE html>
6
+ <html lang="en" class="no-js">
7
+ <head>
8
+
9
+ <meta charset="utf-8">
10
+ <meta name="viewport" content="width=device-width,initial-scale=1">
11
+ <meta http-equiv="x-ua-compatible" content="ie=edge">
12
+
13
+
14
+ <link rel="canonical" href="https://pnp.github.io/pnpjs/documentation/getting-started/">
15
+
16
+
17
+
18
+ <meta name="lang:clipboard.copy" content="Copy to clipboard">
19
+
20
+ <meta name="lang:clipboard.copied" content="Copied to clipboard">
21
+
22
+ <meta name="lang:search.language" content="en">
23
+
24
+ <meta name="lang:search.pipeline.stopwords" content="True">
25
+
26
+ <meta name="lang:search.pipeline.trimmer" content="True">
27
+
28
+ <meta name="lang:search.result.none" content="No matching documents">
29
+
30
+ <meta name="lang:search.result.one" content="1 matching document">
31
+
32
+ <meta name="lang:search.result.other" content="# matching documents">
33
+
34
+ <meta name="lang:search.tokenizer" content="[\s\-]+">
35
+
36
+ <link rel="shortcut icon" href="../../assets/images/favicon.png">
37
+ <meta name="generator" content="mkdocs-1.0.1, mkdocs-material-3.0.3">
38
+
39
+
40
+
41
+ <title>Getting Started - PnP/PnPjs</title>
42
+
43
+
44
+
45
+ <link rel="stylesheet" href="../../assets/stylesheets/application.451f80e5.css">
46
+
47
+ <link rel="stylesheet" href="../../assets/stylesheets/application-palette.22915126.css">
48
+
49
+
50
+
51
+
52
+ <meta name="theme-color" content="#2196f3">
53
+
54
+
55
+
56
+ <script src="../../assets/javascripts/modernizr.1aa3b519.js"></script>
57
+
58
+
59
+ <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
60
+
61
+ <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono">
62
+ <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
63
+
64
+
65
+ <link rel="stylesheet" href="../../assets/fonts/material-icons.css">
66
+
67
+ <link rel="stylesheet" href="../css/extra.css">
68
+
69
+
70
+ </head>
71
+
72
+
73
+
74
+ <body dir="ltr" data-md-color-primary="blue" data-md-color-accent="">
75
+
76
+ <svg class="md-svg">
77
+ <defs>
78
+
79
+
80
+ <svg xmlns="http://www.w3.org/2000/svg" width="416" height="448"
81
+ viewBox="0 0 416 448" id="__github">
82
+ <path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19-18.125
83
+ 8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 18.125-8.5
84
+ 18.125 8.5 10.75 19 3.125 20.5zM320 304q0 10-3.125 20.5t-10.75
85
+ 19-18.125 8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19
86
+ 18.125-8.5 18.125 8.5 10.75 19 3.125 20.5zM360
87
+ 304q0-30-17.25-51t-46.75-21q-10.25 0-48.75 5.25-17.75 2.75-39.25
88
+ 2.75t-39.25-2.75q-38-5.25-48.75-5.25-29.5 0-46.75 21t-17.25 51q0 22 8
89
+ 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0
90
+ 37.25-1.75t35-7.375 30.5-15 20.25-25.75 8-38.375zM416 260q0 51.75-15.25
91
+ 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5-41.75
92
+ 1.125q-19.5 0-35.5-0.75t-36.875-3.125-38.125-7.5-34.25-12.875-30.25-20.25-21.5-28.75q-15.5-30.75-15.5-82.75
93
+ 0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25
94
+ 30.875q36.75-8.75 77.25-8.75 37 0 70 8 26.25-20.5
95
+ 46.75-30.25t47.25-9.75q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34
96
+ 99.5z" />
97
+ </svg>
98
+
99
+ </defs>
100
+ </svg>
101
+ <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
102
+ <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
103
+ <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
104
+
105
+ <a href="../../#getting-started" tabindex="1" class="md-skip">
106
+ Skip to content
107
+ </a>
108
+
109
+
110
+ <header class="md-header" data-md-component="header">
111
+ <nav class="md-header-nav md-grid">
112
+ <div class="md-flex">
113
+ <div class="md-flex__cell md-flex__cell--shrink">
114
+ <a href="https://pnp.github.io/pnpjs/" title="PnP/PnPjs" class="md-header-nav__button md-logo">
115
+
116
+ <img src="../img/Logo.png" width="24" height="24">
117
+
118
+ </a>
119
+ </div>
120
+ <div class="md-flex__cell md-flex__cell--shrink">
121
+ <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
122
+ </div>
123
+ <div class="md-flex__cell md-flex__cell--stretch">
124
+ <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
125
+
126
+
127
+ <span class="md-header-nav__topic">
128
+ PnP/PnPjs
129
+ </span>
130
+ <span class="md-header-nav__topic">
131
+ Getting Started
132
+ </span>
133
+
134
+
135
+ </div>
136
+ </div>
137
+ <div class="md-flex__cell md-flex__cell--shrink">
138
+
139
+
140
+ <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
141
+
142
+ <div class="md-search" data-md-component="search" role="dialog">
143
+ <label class="md-search__overlay" for="__search"></label>
144
+ <div class="md-search__inner" role="search">
145
+ <form class="md-search__form" name="search">
146
+ <input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
147
+ <label class="md-icon md-search__icon" for="__search"></label>
148
+ <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
149
+ &#xE5CD;
150
+ </button>
151
+ </form>
152
+ <div class="md-search__output">
153
+ <div class="md-search__scrollwrap" data-md-scrollfix>
154
+ <div class="md-search-result" data-md-component="result">
155
+ <div class="md-search-result__meta">
156
+ Type to start searching
157
+ </div>
158
+ <ol class="md-search-result__list"></ol>
159
+ </div>
160
+ </div>
161
+ </div>
162
+ </div>
163
+ </div>
164
+
165
+
166
+ </div>
167
+
168
+ <div class="md-flex__cell md-flex__cell--shrink">
169
+ <div class="md-header-nav__source">
170
+
171
+
172
+
173
+
174
+
175
+
176
+ <a href="http://github.com/pnp/pnpjs/" title="Go to repository" class="md-source" data-md-source="github">
177
+
178
+ <div class="md-source__icon">
179
+ <svg viewBox="0 0 24 24" width="24" height="24">
180
+ <use xlink:href="#__github" width="24" height="24"></use>
181
+ </svg>
182
+ </div>
183
+
184
+ <div class="md-source__repository">
185
+ GitHub
186
+ </div>
187
+ </a>
188
+
189
+ </div>
190
+ </div>
191
+
192
+ </div>
193
+ </nav>
194
+ </header>
195
+
196
+ <div class="md-container">
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+ <nav class="md-tabs md-tabs--active" data-md-component="tabs">
206
+ <div class="md-tabs__inner md-grid">
207
+ <ul class="md-tabs__list">
208
+
209
+
210
+ <li class="md-tabs__item">
211
+
212
+ <a href="../.." title="Home" class="md-tabs__link">
213
+ Home
214
+ </a>
215
+
216
+ </li>
217
+
218
+
219
+
220
+
221
+
222
+
223
+
224
+
225
+
226
+ <li class="md-tabs__item">
227
+
228
+ <a href="./" title="General" class="md-tabs__link md-tabs__link--active">
229
+ General
230
+ </a>
231
+
232
+ </li>
233
+
234
+
235
+
236
+
237
+
238
+
239
+ <li class="md-tabs__item">
240
+
241
+ <a href="../packages/" title="Packages" class="md-tabs__link">
242
+ Packages
243
+ </a>
244
+
245
+ </li>
246
+
247
+
248
+
249
+ </ul>
250
+ </div>
251
+ </nav>
252
+
253
+ <main class="md-main">
254
+ <div class="md-main__inner md-grid" data-md-component="container">
255
+
256
+
257
+ <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
258
+ <div class="md-sidebar__scrollwrap">
259
+ <div class="md-sidebar__inner">
260
+ <nav class="md-nav md-nav--primary" data-md-level="0">
261
+ <label class="md-nav__title md-nav__title--site" for="__drawer">
262
+ <a href="https://pnp.github.io/pnpjs/" title="PnP/PnPjs" class="md-nav__button md-logo">
263
+
264
+ <img src="../img/Logo.png" width="48" height="48">
265
+
266
+ </a>
267
+ PnP/PnPjs
268
+ </label>
269
+
270
+ <div class="md-nav__source">
271
+
272
+
273
+
274
+
275
+
276
+
277
+ <a href="http://github.com/pnp/pnpjs/" title="Go to repository" class="md-source" data-md-source="github">
278
+
279
+ <div class="md-source__icon">
280
+ <svg viewBox="0 0 24 24" width="24" height="24">
281
+ <use xlink:href="#__github" width="24" height="24"></use>
282
+ </svg>
283
+ </div>
284
+
285
+ <div class="md-source__repository">
286
+ GitHub
287
+ </div>
288
+ </a>
289
+
290
+ </div>
291
+
292
+ <ul class="md-nav__list" data-md-scrollfix>
293
+
294
+
295
+
296
+
297
+
298
+
299
+ <li class="md-nav__item">
300
+ <a href="../.." title="Home" class="md-nav__link">
301
+ Home
302
+ </a>
303
+ </li>
304
+
305
+
306
+
307
+
308
+
309
+
310
+
311
+ <li class="md-nav__item">
312
+
313
+ <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
314
+
315
+
316
+
317
+
318
+ <label class="md-nav__link md-nav__link--active" for="__toc">
319
+ Getting Started
320
+ </label>
321
+
322
+ <a href="./" title="Getting Started" class="md-nav__link md-nav__link--active">
323
+ Getting Started
324
+ </a>
325
+
326
+
327
+ <nav class="md-nav md-nav--secondary">
328
+
329
+
330
+
331
+
332
+
333
+ <label class="md-nav__title" for="__toc">Table of contents</label>
334
+ <ul class="md-nav__list" data-md-scrollfix>
335
+
336
+ <li class="md-nav__item">
337
+ <a href="#install" title="Install" class="md-nav__link">
338
+ Install
339
+ </a>
340
+
341
+ </li>
342
+
343
+ <li class="md-nav__item">
344
+ <a href="#getting-started-with-sharepoint-framework" title="Getting Started with SharePoint Framework" class="md-nav__link">
345
+ Getting Started with SharePoint Framework
346
+ </a>
347
+
348
+ <nav class="md-nav">
349
+ <ul class="md-nav__list">
350
+
351
+ <li class="md-nav__item">
352
+ <a href="#establish-context" title="Establish Context" class="md-nav__link">
353
+ Establish Context
354
+ </a>
355
+
356
+ <nav class="md-nav">
357
+ <ul class="md-nav__list">
358
+
359
+ <li class="md-nav__item">
360
+ <a href="#using-pnpcommon-setup" title="Using @pnp/core setup" class="md-nav__link">
361
+ Using @pnp/core setup
362
+ </a>
363
+
364
+ </li>
365
+
366
+ <li class="md-nav__item">
367
+ <a href="#using-pnpsp-setup" title="Using @pnp/sp setup" class="md-nav__link">
368
+ Using @pnp/sp setup
369
+ </a>
370
+
371
+ </li>
372
+
373
+ <li class="md-nav__item">
374
+ <a href="#using-pnpgraph-setup" title="Using @pnp/graph setup" class="md-nav__link">
375
+ Using @pnp/graph setup
376
+ </a>
377
+
378
+ </li>
379
+
380
+ <li class="md-nav__item">
381
+ <a href="#establish-context-with-an-spfx-service" title="Establish Context with an SPFx Service" class="md-nav__link">
382
+ Establish Context with an SPFx Service
383
+ </a>
384
+
385
+ </li>
386
+
387
+ </ul>
388
+ </nav>
389
+
390
+ </li>
391
+
392
+ </ul>
393
+ </nav>
394
+
395
+ </li>
396
+
397
+ <li class="md-nav__item">
398
+ <a href="#connect-to-sharepoint-from-node" title="Connect to SharePoint from Node" class="md-nav__link">
399
+ Connect to SharePoint from Node
400
+ </a>
401
+
402
+ </li>
403
+
404
+ <li class="md-nav__item">
405
+ <a href="#connect-to-microsoft-graph-from-node" title="Connect to Microsoft Graph From Node" class="md-nav__link">
406
+ Connect to Microsoft Graph From Node
407
+ </a>
408
+
409
+ </li>
410
+
411
+ <li class="md-nav__item">
412
+ <a href="#getting-started-outside-sharepoint-framework" title="Getting Started outside SharePoint Framework" class="md-nav__link">
413
+ Getting Started outside SharePoint Framework
414
+ </a>
415
+
416
+ <nav class="md-nav">
417
+ <ul class="md-nav__list">
418
+
419
+ <li class="md-nav__item">
420
+ <a href="#set-baseurl-through-setup" title="Set baseUrl through setup:" class="md-nav__link">
421
+ Set baseUrl through setup:
422
+ </a>
423
+
424
+ </li>
425
+
426
+ <li class="md-nav__item">
427
+ <a href="#create-web-instances-directly" title="Create Web instances directly" class="md-nav__link">
428
+ Create Web instances directly
429
+ </a>
430
+
431
+ </li>
432
+
433
+ </ul>
434
+ </nav>
435
+
436
+ </li>
437
+
438
+
439
+
440
+
441
+
442
+ </ul>
443
+
444
+ </nav>
445
+
446
+ </li>
447
+
448
+
449
+
450
+
451
+
452
+
453
+
454
+ <li class="md-nav__item">
455
+ <a href="../transition-guide/" title="Transition Guide" class="md-nav__link">
456
+ Transition Guide
457
+ </a>
458
+ </li>
459
+
460
+
461
+
462
+
463
+
464
+
465
+
466
+
467
+
468
+ <li class="md-nav__item md-nav__item--active md-nav__item--nested">
469
+
470
+ <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4" checked>
471
+
472
+ <label class="md-nav__link" for="nav-4">
473
+ General
474
+ </label>
475
+ <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
476
+ <label class="md-nav__title" for="nav-4">
477
+ General
478
+ </label>
479
+ <ul class="md-nav__list" data-md-scrollfix>
480
+
481
+
482
+
483
+
484
+
485
+
486
+
487
+
488
+
489
+ <li class="md-nav__item md-nav__item--active">
490
+
491
+ <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
492
+
493
+
494
+
495
+
496
+ <label class="md-nav__link md-nav__link--active" for="__toc">
497
+ Getting Started
498
+ </label>
499
+
500
+ <a href="./" title="Getting Started" class="md-nav__link md-nav__link--active">
501
+ Getting Started
502
+ </a>
503
+
504
+
505
+ <nav class="md-nav md-nav--secondary">
506
+
507
+
508
+
509
+
510
+
511
+ <label class="md-nav__title" for="__toc">Table of contents</label>
512
+ <ul class="md-nav__list" data-md-scrollfix>
513
+
514
+ <li class="md-nav__item">
515
+ <a href="#install" title="Install" class="md-nav__link">
516
+ Install
517
+ </a>
518
+
519
+ </li>
520
+
521
+ <li class="md-nav__item">
522
+ <a href="#getting-started-with-sharepoint-framework" title="Getting Started with SharePoint Framework" class="md-nav__link">
523
+ Getting Started with SharePoint Framework
524
+ </a>
525
+
526
+ <nav class="md-nav">
527
+ <ul class="md-nav__list">
528
+
529
+ <li class="md-nav__item">
530
+ <a href="#establish-context" title="Establish Context" class="md-nav__link">
531
+ Establish Context
532
+ </a>
533
+
534
+ <nav class="md-nav">
535
+ <ul class="md-nav__list">
536
+
537
+ <li class="md-nav__item">
538
+ <a href="#using-pnpcommon-setup" title="Using @pnp/core setup" class="md-nav__link">
539
+ Using @pnp/core setup
540
+ </a>
541
+
542
+ </li>
543
+
544
+ <li class="md-nav__item">
545
+ <a href="#using-pnpsp-setup" title="Using @pnp/sp setup" class="md-nav__link">
546
+ Using @pnp/sp setup
547
+ </a>
548
+
549
+ </li>
550
+
551
+ <li class="md-nav__item">
552
+ <a href="#using-pnpgraph-setup" title="Using @pnp/graph setup" class="md-nav__link">
553
+ Using @pnp/graph setup
554
+ </a>
555
+
556
+ </li>
557
+
558
+ <li class="md-nav__item">
559
+ <a href="#establish-context-with-an-spfx-service" title="Establish Context with an SPFx Service" class="md-nav__link">
560
+ Establish Context with an SPFx Service
561
+ </a>
562
+
563
+ </li>
564
+
565
+ </ul>
566
+ </nav>
567
+
568
+ </li>
569
+
570
+ </ul>
571
+ </nav>
572
+
573
+ </li>
574
+
575
+ <li class="md-nav__item">
576
+ <a href="#connect-to-sharepoint-from-node" title="Connect to SharePoint from Node" class="md-nav__link">
577
+ Connect to SharePoint from Node
578
+ </a>
579
+
580
+ </li>
581
+
582
+ <li class="md-nav__item">
583
+ <a href="#connect-to-microsoft-graph-from-node" title="Connect to Microsoft Graph From Node" class="md-nav__link">
584
+ Connect to Microsoft Graph From Node
585
+ </a>
586
+
587
+ </li>
588
+
589
+ <li class="md-nav__item">
590
+ <a href="#getting-started-outside-sharepoint-framework" title="Getting Started outside SharePoint Framework" class="md-nav__link">
591
+ Getting Started outside SharePoint Framework
592
+ </a>
593
+
594
+ <nav class="md-nav">
595
+ <ul class="md-nav__list">
596
+
597
+ <li class="md-nav__item">
598
+ <a href="#set-baseurl-through-setup" title="Set baseUrl through setup:" class="md-nav__link">
599
+ Set baseUrl through setup:
600
+ </a>
601
+
602
+ </li>
603
+
604
+ <li class="md-nav__item">
605
+ <a href="#create-web-instances-directly" title="Create Web instances directly" class="md-nav__link">
606
+ Create Web instances directly
607
+ </a>
608
+
609
+ </li>
610
+
611
+ </ul>
612
+ </nav>
613
+
614
+ </li>
615
+
616
+
617
+
618
+
619
+
620
+ </ul>
621
+
622
+ </nav>
623
+
624
+ </li>
625
+
626
+
627
+
628
+
629
+
630
+
631
+
632
+ <li class="md-nav__item">
633
+ <a href="../getting-started-dev/" title="Getting Started Contributing" class="md-nav__link">
634
+ Getting Started Contributing
635
+ </a>
636
+ </li>
637
+
638
+
639
+
640
+
641
+
642
+
643
+
644
+ <li class="md-nav__item">
645
+ <a href="../gulp-commands/" title="Gulp Commands" class="md-nav__link">
646
+ Gulp Commands
647
+ </a>
648
+ </li>
649
+
650
+
651
+
652
+
653
+
654
+
655
+
656
+ <li class="md-nav__item">
657
+ <a href="../debugging/" title="Debugging" class="md-nav__link">
658
+ Debugging
659
+ </a>
660
+ </li>
661
+
662
+
663
+
664
+
665
+
666
+
667
+
668
+ <li class="md-nav__item">
669
+ <a href="../documentation/" title="Building Docs" class="md-nav__link">
670
+ Building Docs
671
+ </a>
672
+ </li>
673
+
674
+
675
+
676
+
677
+
678
+
679
+
680
+ <li class="md-nav__item">
681
+ <a href="../deployment/" title="Deployment" class="md-nav__link">
682
+ Deployment
683
+ </a>
684
+ </li>
685
+
686
+
687
+
688
+
689
+
690
+
691
+
692
+ <li class="md-nav__item">
693
+ <a href="../beta-versions/" title="Install Beta Versions" class="md-nav__link">
694
+ Install Beta Versions
695
+ </a>
696
+ </li>
697
+
698
+
699
+
700
+
701
+
702
+
703
+
704
+ <li class="md-nav__item">
705
+ <a href="../polyfill/" title="Polyfills" class="md-nav__link">
706
+ Polyfills
707
+ </a>
708
+ </li>
709
+
710
+
711
+
712
+
713
+
714
+
715
+
716
+ <li class="md-nav__item">
717
+ <a href="../package-structure/" title="Package Structure" class="md-nav__link">
718
+ Package Structure
719
+ </a>
720
+ </li>
721
+
722
+
723
+
724
+
725
+
726
+
727
+
728
+ <li class="md-nav__item">
729
+ <a href="../SPFx-On-Premesis-2016/" title="SPFx On-Premises 2016" class="md-nav__link">
730
+ SPFx On-Premises 2016
731
+ </a>
732
+ </li>
733
+
734
+
735
+
736
+
737
+
738
+
739
+
740
+ <li class="md-nav__item">
741
+ <a href="../transition-guide/" title="Transition Guide" class="md-nav__link">
742
+ Transition Guide
743
+ </a>
744
+ </li>
745
+
746
+
747
+ </ul>
748
+ </nav>
749
+ </li>
750
+
751
+
752
+
753
+
754
+
755
+
756
+
757
+ <li class="md-nav__item md-nav__item--nested">
758
+
759
+ <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
760
+
761
+ <label class="md-nav__link" for="nav-5">
762
+ Packages
763
+ </label>
764
+ <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
765
+ <label class="md-nav__title" for="nav-5">
766
+ Packages
767
+ </label>
768
+ <ul class="md-nav__list" data-md-scrollfix>
769
+
770
+
771
+
772
+
773
+
774
+
775
+
776
+ <li class="md-nav__item">
777
+ <a href="../packages/" title="Packages" class="md-nav__link">
778
+ Packages
779
+ </a>
780
+ </li>
781
+
782
+
783
+
784
+
785
+
786
+
787
+
788
+ <li class="md-nav__item md-nav__item--nested">
789
+
790
+ <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-2" type="checkbox" id="nav-5-2">
791
+
792
+ <label class="md-nav__link" for="nav-5-2">
793
+ common
794
+ </label>
795
+ <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
796
+ <label class="md-nav__title" for="nav-5-2">
797
+ common
798
+ </label>
799
+ <ul class="md-nav__list" data-md-scrollfix>
800
+
801
+
802
+
803
+
804
+
805
+
806
+
807
+ <li class="md-nav__item">
808
+ <a href="../../common/docs/" title="common" class="md-nav__link">
809
+ common
810
+ </a>
811
+ </li>
812
+
813
+
814
+
815
+
816
+
817
+
818
+
819
+ <li class="md-nav__item">
820
+ <a href="../../common/docs/adalclient/" title="adalclient" class="md-nav__link">
821
+ adalclient
822
+ </a>
823
+ </li>
824
+
825
+
826
+
827
+
828
+
829
+
830
+
831
+ <li class="md-nav__item">
832
+ <a href="../../common/docs/blobutil.md" title="blobutil" class="md-nav__link">
833
+ blobutil
834
+ </a>
835
+ </li>
836
+
837
+
838
+
839
+
840
+
841
+
842
+
843
+ <li class="md-nav__item">
844
+ <a href="../../common/docs/collections/" title="collections" class="md-nav__link">
845
+ collections
846
+ </a>
847
+ </li>
848
+
849
+
850
+
851
+
852
+
853
+
854
+
855
+ <li class="md-nav__item">
856
+ <a href="../../common/docs/custom-httpclientimpl/" title="Custom HttpClientImpl" class="md-nav__link">
857
+ Custom HttpClientImpl
858
+ </a>
859
+ </li>
860
+
861
+
862
+
863
+
864
+
865
+
866
+
867
+ <li class="md-nav__item">
868
+ <a href="../../common/docs/libconfig/" title="libconfig" class="md-nav__link">
869
+ libconfig
870
+ </a>
871
+ </li>
872
+
873
+
874
+
875
+
876
+
877
+
878
+
879
+ <li class="md-nav__item">
880
+ <a href="../../common/docs/netutil/" title="netutil" class="md-nav__link">
881
+ netutil
882
+ </a>
883
+ </li>
884
+
885
+
886
+
887
+
888
+
889
+
890
+
891
+ <li class="md-nav__item">
892
+ <a href="../../common/docs/storage/" title="storage" class="md-nav__link">
893
+ storage
894
+ </a>
895
+ </li>
896
+
897
+
898
+
899
+
900
+
901
+
902
+
903
+ <li class="md-nav__item">
904
+ <a href="../../common/docs/util/" title="util" class="md-nav__link">
905
+ util
906
+ </a>
907
+ </li>
908
+
909
+
910
+ </ul>
911
+ </nav>
912
+ </li>
913
+
914
+
915
+
916
+
917
+
918
+
919
+
920
+ <li class="md-nav__item md-nav__item--nested">
921
+
922
+ <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-3" type="checkbox" id="nav-5-3">
923
+
924
+ <label class="md-nav__link" for="nav-5-3">
925
+ config-store
926
+ </label>
927
+ <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
928
+ <label class="md-nav__title" for="nav-5-3">
929
+ config-store
930
+ </label>
931
+ <ul class="md-nav__list" data-md-scrollfix>
932
+
933
+
934
+
935
+
936
+
937
+
938
+
939
+ <li class="md-nav__item">
940
+ <a href="../../config-store/docs/" title="config-store" class="md-nav__link">
941
+ config-store
942
+ </a>
943
+ </li>
944
+
945
+
946
+
947
+
948
+
949
+
950
+
951
+ <li class="md-nav__item">
952
+ <a href="../../config-store/docs/configuration/" title="configuration" class="md-nav__link">
953
+ configuration
954
+ </a>
955
+ </li>
956
+
957
+
958
+
959
+
960
+
961
+
962
+
963
+ <li class="md-nav__item">
964
+ <a href="../../config-store/docs/providers/" title="providers" class="md-nav__link">
965
+ providers
966
+ </a>
967
+ </li>
968
+
969
+
970
+ </ul>
971
+ </nav>
972
+ </li>
973
+
974
+
975
+
976
+
977
+
978
+
979
+
980
+ <li class="md-nav__item md-nav__item--nested">
981
+
982
+ <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-4" type="checkbox" id="nav-5-4">
983
+
984
+ <label class="md-nav__link" for="nav-5-4">
985
+ graph
986
+ </label>
987
+ <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
988
+ <label class="md-nav__title" for="nav-5-4">
989
+ graph
990
+ </label>
991
+ <ul class="md-nav__list" data-md-scrollfix>
992
+
993
+
994
+
995
+
996
+
997
+
998
+
999
+ <li class="md-nav__item">
1000
+ <a href="../../graph/docs/" title="graph" class="md-nav__link">
1001
+ graph
1002
+ </a>
1003
+ </li>
1004
+
1005
+
1006
+
1007
+
1008
+
1009
+
1010
+
1011
+ <li class="md-nav__item">
1012
+ <a href="../../graph/docs/contacts/" title="contacts" class="md-nav__link">
1013
+ contacts
1014
+ </a>
1015
+ </li>
1016
+
1017
+
1018
+
1019
+
1020
+
1021
+
1022
+
1023
+ <li class="md-nav__item">
1024
+ <a href="../../graph/docs/directoryobjects/" title="directory objects" class="md-nav__link">
1025
+ directory objects
1026
+ </a>
1027
+ </li>
1028
+
1029
+
1030
+
1031
+
1032
+
1033
+
1034
+
1035
+ <li class="md-nav__item">
1036
+ <a href="../../graph/docs/invitations/" title="invitations" class="md-nav__link">
1037
+ invitations
1038
+ </a>
1039
+ </li>
1040
+
1041
+
1042
+
1043
+
1044
+
1045
+
1046
+
1047
+ <li class="md-nav__item">
1048
+ <a href="../../graph/docs/onedrive/" title="onedrive" class="md-nav__link">
1049
+ onedrive
1050
+ </a>
1051
+ </li>
1052
+
1053
+
1054
+
1055
+
1056
+
1057
+
1058
+
1059
+ <li class="md-nav__item">
1060
+ <a href="../../graph/docs/planner/" title="planner" class="md-nav__link">
1061
+ planner
1062
+ </a>
1063
+ </li>
1064
+
1065
+
1066
+
1067
+
1068
+
1069
+
1070
+
1071
+ <li class="md-nav__item">
1072
+ <a href="../../graph/docs/subscriptions/" title="subscriptions" class="md-nav__link">
1073
+ subscriptions
1074
+ </a>
1075
+ </li>
1076
+
1077
+
1078
+
1079
+
1080
+
1081
+
1082
+
1083
+ <li class="md-nav__item">
1084
+ <a href="../../graph/docs/teams/" title="teams" class="md-nav__link">
1085
+ teams
1086
+ </a>
1087
+ </li>
1088
+
1089
+
1090
+ </ul>
1091
+ </nav>
1092
+ </li>
1093
+
1094
+
1095
+
1096
+
1097
+
1098
+
1099
+
1100
+ <li class="md-nav__item">
1101
+ <a href="../../logging/docs/" title="logging" class="md-nav__link">
1102
+ logging
1103
+ </a>
1104
+ </li>
1105
+
1106
+
1107
+
1108
+
1109
+
1110
+
1111
+
1112
+ <li class="md-nav__item md-nav__item--nested">
1113
+
1114
+ <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-6" type="checkbox" id="nav-5-6">
1115
+
1116
+ <label class="md-nav__link" for="nav-5-6">
1117
+ nodejs
1118
+ </label>
1119
+ <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
1120
+ <label class="md-nav__title" for="nav-5-6">
1121
+ nodejs
1122
+ </label>
1123
+ <ul class="md-nav__list" data-md-scrollfix>
1124
+
1125
+
1126
+
1127
+
1128
+
1129
+
1130
+
1131
+ <li class="md-nav__item">
1132
+ <a href="../../nodejs/docs/" title="nodejs" class="md-nav__link">
1133
+ nodejs
1134
+ </a>
1135
+ </li>
1136
+
1137
+
1138
+
1139
+
1140
+
1141
+
1142
+
1143
+ <li class="md-nav__item">
1144
+ <a href="../../nodejs/docs/adal-fetch-client/" title="AdalFetchClient" class="md-nav__link">
1145
+ AdalFetchClient
1146
+ </a>
1147
+ </li>
1148
+
1149
+
1150
+
1151
+
1152
+
1153
+
1154
+
1155
+ <li class="md-nav__item">
1156
+ <a href="../../nodejs/docs/sp-fetch-client/" title="SPFetchClient" class="md-nav__link">
1157
+ SPFetchClient
1158
+ </a>
1159
+ </li>
1160
+
1161
+
1162
+
1163
+
1164
+
1165
+
1166
+
1167
+ <li class="md-nav__item">
1168
+ <a href="../../nodejs/docs/bearer-token-fetch-client/" title="BearerTokenFetchClient" class="md-nav__link">
1169
+ BearerTokenFetchClient
1170
+ </a>
1171
+ </li>
1172
+
1173
+
1174
+
1175
+
1176
+
1177
+
1178
+
1179
+ <li class="md-nav__item">
1180
+ <a href="../../nodejs/docs/provider-hosted-app/" title="ProviderHostedRequestContext" class="md-nav__link">
1181
+ ProviderHostedRequestContext
1182
+ </a>
1183
+ </li>
1184
+
1185
+
1186
+ </ul>
1187
+ </nav>
1188
+ </li>
1189
+
1190
+
1191
+
1192
+
1193
+
1194
+
1195
+
1196
+ <li class="md-nav__item md-nav__item--nested">
1197
+
1198
+ <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-7" type="checkbox" id="nav-5-7">
1199
+
1200
+ <label class="md-nav__link" for="nav-5-7">
1201
+ odata
1202
+ </label>
1203
+ <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
1204
+ <label class="md-nav__title" for="nav-5-7">
1205
+ odata
1206
+ </label>
1207
+ <ul class="md-nav__list" data-md-scrollfix>
1208
+
1209
+
1210
+
1211
+
1212
+
1213
+
1214
+
1215
+ <li class="md-nav__item">
1216
+ <a href="../../queryable/docs/" title="odata" class="md-nav__link">
1217
+ odata
1218
+ </a>
1219
+ </li>
1220
+
1221
+
1222
+
1223
+
1224
+
1225
+
1226
+
1227
+ <li class="md-nav__item">
1228
+ <a href="../../queryable/docs/caching/" title="caching" class="md-nav__link">
1229
+ caching
1230
+ </a>
1231
+ </li>
1232
+
1233
+
1234
+
1235
+
1236
+
1237
+
1238
+
1239
+ <li class="md-nav__item">
1240
+ <a href="../../queryable/docs/core/" title="core" class="md-nav__link">
1241
+ core
1242
+ </a>
1243
+ </li>
1244
+
1245
+
1246
+
1247
+
1248
+
1249
+
1250
+
1251
+ <li class="md-nav__item">
1252
+ <a href="../../queryable/docs/odata-batch/" title="OData Batching" class="md-nav__link">
1253
+ OData Batching
1254
+ </a>
1255
+ </li>
1256
+
1257
+
1258
+
1259
+
1260
+
1261
+
1262
+
1263
+ <li class="md-nav__item">
1264
+ <a href="../../queryable/docs/parsers/" title="Parsers" class="md-nav__link">
1265
+ Parsers
1266
+ </a>
1267
+ </li>
1268
+
1269
+
1270
+
1271
+
1272
+
1273
+
1274
+
1275
+ <li class="md-nav__item">
1276
+ <a href="../../queryable/docs/pipeline/" title="Pipeline" class="md-nav__link">
1277
+ Pipeline
1278
+ </a>
1279
+ </li>
1280
+
1281
+
1282
+
1283
+
1284
+
1285
+
1286
+
1287
+ <li class="md-nav__item">
1288
+ <a href="../../queryable/docs/queryable/" title="Queryable" class="md-nav__link">
1289
+ Queryable
1290
+ </a>
1291
+ </li>
1292
+
1293
+
1294
+ </ul>
1295
+ </nav>
1296
+ </li>
1297
+
1298
+
1299
+
1300
+
1301
+
1302
+
1303
+
1304
+ <li class="md-nav__item">
1305
+ <a href="../../pnpjs/docs/" title="pnpjs" class="md-nav__link">
1306
+ pnpjs
1307
+ </a>
1308
+ </li>
1309
+
1310
+
1311
+
1312
+
1313
+
1314
+
1315
+
1316
+ <li class="md-nav__item md-nav__item--nested">
1317
+
1318
+ <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-9" type="checkbox" id="nav-5-9">
1319
+
1320
+ <label class="md-nav__link" for="nav-5-9">
1321
+ sp
1322
+ </label>
1323
+ <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
1324
+ <label class="md-nav__title" for="nav-5-9">
1325
+ sp
1326
+ </label>
1327
+ <ul class="md-nav__list" data-md-scrollfix>
1328
+
1329
+
1330
+
1331
+
1332
+
1333
+
1334
+
1335
+ <li class="md-nav__item">
1336
+ <a href="../../sp/docs/" title="sp" class="md-nav__link">
1337
+ sp
1338
+ </a>
1339
+ </li>
1340
+
1341
+
1342
+
1343
+
1344
+
1345
+
1346
+
1347
+ <li class="md-nav__item">
1348
+ <a href="../../sp/docs/alias-parameters/" title="Alias Parameters" class="md-nav__link">
1349
+ Alias Parameters
1350
+ </a>
1351
+ </li>
1352
+
1353
+
1354
+
1355
+
1356
+
1357
+
1358
+
1359
+ <li class="md-nav__item">
1360
+ <a href="../../sp/docs/alm/" title="ALM api" class="md-nav__link">
1361
+ ALM api
1362
+ </a>
1363
+ </li>
1364
+
1365
+
1366
+
1367
+
1368
+
1369
+
1370
+
1371
+ <li class="md-nav__item">
1372
+ <a href="../../sp/docs/attachments/" title="Attachments" class="md-nav__link">
1373
+ Attachments
1374
+ </a>
1375
+ </li>
1376
+
1377
+
1378
+
1379
+
1380
+
1381
+
1382
+
1383
+ <li class="md-nav__item">
1384
+ <a href="../../sp/docs/client-side-pages/" title="Client-side Pages" class="md-nav__link">
1385
+ Client-side Pages
1386
+ </a>
1387
+ </li>
1388
+
1389
+
1390
+
1391
+
1392
+
1393
+
1394
+
1395
+ <li class="md-nav__item">
1396
+ <a href="../../sp/docs/content-types/" title="Content Types" class="md-nav__link">
1397
+ Content Types
1398
+ </a>
1399
+ </li>
1400
+
1401
+
1402
+
1403
+
1404
+
1405
+
1406
+
1407
+ <li class="md-nav__item">
1408
+ <a href="../../sp/docs/entity-merging/" title="Entity Merging" class="md-nav__link">
1409
+ Entity Merging
1410
+ </a>
1411
+ </li>
1412
+
1413
+
1414
+
1415
+
1416
+
1417
+
1418
+
1419
+ <li class="md-nav__item">
1420
+ <a href="../../sp/docs/features/" title="Features" class="md-nav__link">
1421
+ Features
1422
+ </a>
1423
+ </li>
1424
+
1425
+
1426
+
1427
+
1428
+
1429
+
1430
+
1431
+ <li class="md-nav__item">
1432
+ <a href="../../sp/docs/fields/" title="Fields" class="md-nav__link">
1433
+ Fields
1434
+ </a>
1435
+ </li>
1436
+
1437
+
1438
+
1439
+
1440
+
1441
+
1442
+
1443
+ <li class="md-nav__item">
1444
+ <a href="../../sp/docs/files/" title="Files" class="md-nav__link">
1445
+ Files
1446
+ </a>
1447
+ </li>
1448
+
1449
+
1450
+
1451
+
1452
+
1453
+
1454
+
1455
+ <li class="md-nav__item">
1456
+ <a href="../../sp/docs/items/" title="List Items" class="md-nav__link">
1457
+ List Items
1458
+ </a>
1459
+ </li>
1460
+
1461
+
1462
+
1463
+
1464
+
1465
+
1466
+
1467
+ <li class="md-nav__item">
1468
+ <a href="../../sp/docs/navigation-service/" title="Navigation Service" class="md-nav__link">
1469
+ Navigation Service
1470
+ </a>
1471
+ </li>
1472
+
1473
+
1474
+
1475
+
1476
+
1477
+
1478
+
1479
+ <li class="md-nav__item">
1480
+ <a href="../../sp/docs/permissions/" title="Permissions" class="md-nav__link">
1481
+ Permissions
1482
+ </a>
1483
+ </li>
1484
+
1485
+
1486
+
1487
+
1488
+
1489
+
1490
+
1491
+ <li class="md-nav__item">
1492
+ <a href="../../sp/docs/profiles/" title="Profiles" class="md-nav__link">
1493
+ Profiles
1494
+ </a>
1495
+ </li>
1496
+
1497
+
1498
+
1499
+
1500
+
1501
+
1502
+
1503
+ <li class="md-nav__item">
1504
+ <a href="../../sp/docs/related-items/" title="Related Items" class="md-nav__link">
1505
+ Related Items
1506
+ </a>
1507
+ </li>
1508
+
1509
+
1510
+
1511
+
1512
+
1513
+
1514
+
1515
+ <li class="md-nav__item">
1516
+ <a href="../../sp/docs/search/" title="Search" class="md-nav__link">
1517
+ Search
1518
+ </a>
1519
+ </li>
1520
+
1521
+
1522
+
1523
+
1524
+
1525
+
1526
+
1527
+ <li class="md-nav__item">
1528
+ <a href="../../sp/docs/sharing/" title="Sharing" class="md-nav__link">
1529
+ Sharing
1530
+ </a>
1531
+ </li>
1532
+
1533
+
1534
+
1535
+
1536
+
1537
+
1538
+
1539
+ <li class="md-nav__item">
1540
+ <a href="../../sp/docs/sites/" title="Sites" class="md-nav__link">
1541
+ Sites
1542
+ </a>
1543
+ </li>
1544
+
1545
+
1546
+
1547
+
1548
+
1549
+
1550
+
1551
+ <li class="md-nav__item">
1552
+ <a href="../../sp/docs/sitedesigns/" title="Site Designs" class="md-nav__link">
1553
+ Site Designs
1554
+ </a>
1555
+ </li>
1556
+
1557
+
1558
+
1559
+
1560
+
1561
+
1562
+
1563
+ <li class="md-nav__item">
1564
+ <a href="../../sp/docs/social/" title="Social" class="md-nav__link">
1565
+ Social
1566
+ </a>
1567
+ </li>
1568
+
1569
+
1570
+
1571
+
1572
+
1573
+
1574
+
1575
+ <li class="md-nav__item">
1576
+ <a href="../../sp/docs/sp-utilities-utility/" title="SP.Utilities.Utility" class="md-nav__link">
1577
+ SP.Utilities.Utility
1578
+ </a>
1579
+ </li>
1580
+
1581
+
1582
+
1583
+
1584
+
1585
+
1586
+
1587
+ <li class="md-nav__item">
1588
+ <a href="../../sp/docs/tenant-properties/" title="Tenant Properties" class="md-nav__link">
1589
+ Tenant Properties
1590
+ </a>
1591
+ </li>
1592
+
1593
+
1594
+
1595
+
1596
+
1597
+
1598
+
1599
+ <li class="md-nav__item">
1600
+ <a href="../../sp/docs/views/" title="Views" class="md-nav__link">
1601
+ Views
1602
+ </a>
1603
+ </li>
1604
+
1605
+
1606
+
1607
+
1608
+
1609
+
1610
+
1611
+ <li class="md-nav__item">
1612
+ <a href="../../sp/docs/webs/" title="Webs" class="md-nav__link">
1613
+ Webs
1614
+ </a>
1615
+ </li>
1616
+
1617
+
1618
+
1619
+
1620
+
1621
+
1622
+
1623
+ <li class="md-nav__item">
1624
+ <a href="../../sp/docs/comments-likes/" title="Comments and Likes" class="md-nav__link">
1625
+ Comments and Likes
1626
+ </a>
1627
+ </li>
1628
+
1629
+
1630
+ </ul>
1631
+ </nav>
1632
+ </li>
1633
+
1634
+
1635
+
1636
+
1637
+
1638
+
1639
+
1640
+ <li class="md-nav__item md-nav__item--nested">
1641
+
1642
+ <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-10" type="checkbox" id="nav-5-10">
1643
+
1644
+ <label class="md-nav__link" for="nav-5-10">
1645
+ sp-addinhelpers
1646
+ </label>
1647
+ <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
1648
+ <label class="md-nav__title" for="nav-5-10">
1649
+ sp-addinhelpers
1650
+ </label>
1651
+ <ul class="md-nav__list" data-md-scrollfix>
1652
+
1653
+
1654
+
1655
+
1656
+
1657
+
1658
+
1659
+ <li class="md-nav__item">
1660
+ <a href="../../sp-addinhelpers/docs/" title="sp-addinhelpers" class="md-nav__link">
1661
+ sp-addinhelpers
1662
+ </a>
1663
+ </li>
1664
+
1665
+
1666
+
1667
+
1668
+
1669
+
1670
+
1671
+ <li class="md-nav__item">
1672
+ <a href="../../sp-addinhelpers/docs/sp-request-executor-client/" title="SPRequestExecutorClient" class="md-nav__link">
1673
+ SPRequestExecutorClient
1674
+ </a>
1675
+ </li>
1676
+
1677
+
1678
+
1679
+
1680
+
1681
+
1682
+
1683
+ <li class="md-nav__item">
1684
+ <a href="../../sp-addinhelpers/docs/sp-rest-addin/" title="SPRestAddIn" class="md-nav__link">
1685
+ SPRestAddIn
1686
+ </a>
1687
+ </li>
1688
+
1689
+
1690
+ </ul>
1691
+ </nav>
1692
+ </li>
1693
+
1694
+
1695
+
1696
+
1697
+
1698
+
1699
+
1700
+ <li class="md-nav__item">
1701
+ <a href="../../sp-clientsvc/docs/" title="sp-clientsvc" class="md-nav__link">
1702
+ sp-clientsvc
1703
+ </a>
1704
+ </li>
1705
+
1706
+
1707
+
1708
+
1709
+
1710
+
1711
+
1712
+ <li class="md-nav__item md-nav__item--nested">
1713
+
1714
+ <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-12" type="checkbox" id="nav-5-12">
1715
+
1716
+ <label class="md-nav__link" for="nav-5-12">
1717
+ sp-taxonomy
1718
+ </label>
1719
+ <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
1720
+ <label class="md-nav__title" for="nav-5-12">
1721
+ sp-taxonomy
1722
+ </label>
1723
+ <ul class="md-nav__list" data-md-scrollfix>
1724
+
1725
+
1726
+
1727
+
1728
+
1729
+
1730
+
1731
+ <li class="md-nav__item">
1732
+ <a href="../../sp-taxonomy/docs/" title="sp-taxonomy" class="md-nav__link">
1733
+ sp-taxonomy
1734
+ </a>
1735
+ </li>
1736
+
1737
+
1738
+
1739
+
1740
+
1741
+
1742
+
1743
+ <li class="md-nav__item">
1744
+ <a href="../../sp-taxonomy/docs/term-stores/" title="Term Stores" class="md-nav__link">
1745
+ Term Stores
1746
+ </a>
1747
+ </li>
1748
+
1749
+
1750
+
1751
+
1752
+
1753
+
1754
+
1755
+ <li class="md-nav__item">
1756
+ <a href="../../sp-taxonomy/docs/term-groups/" title="Term Groups" class="md-nav__link">
1757
+ Term Groups
1758
+ </a>
1759
+ </li>
1760
+
1761
+
1762
+
1763
+
1764
+
1765
+
1766
+
1767
+ <li class="md-nav__item">
1768
+ <a href="../../sp-taxonomy/docs/term-sets/" title="Term Sets" class="md-nav__link">
1769
+ Term Sets
1770
+ </a>
1771
+ </li>
1772
+
1773
+
1774
+
1775
+
1776
+
1777
+
1778
+
1779
+ <li class="md-nav__item">
1780
+ <a href="../../sp-taxonomy/docs/terms/" title="Terms" class="md-nav__link">
1781
+ Terms
1782
+ </a>
1783
+ </li>
1784
+
1785
+
1786
+
1787
+
1788
+
1789
+
1790
+
1791
+ <li class="md-nav__item">
1792
+ <a href="../../sp-taxonomy/docs/labels/" title="Labels" class="md-nav__link">
1793
+ Labels
1794
+ </a>
1795
+ </li>
1796
+
1797
+
1798
+
1799
+
1800
+
1801
+
1802
+
1803
+ <li class="md-nav__item">
1804
+ <a href="../../sp-taxonomy/docs/utilities/" title="Utilities" class="md-nav__link">
1805
+ Utilities
1806
+ </a>
1807
+ </li>
1808
+
1809
+
1810
+ </ul>
1811
+ </nav>
1812
+ </li>
1813
+
1814
+
1815
+ </ul>
1816
+ </nav>
1817
+ </li>
1818
+
1819
+
1820
+ </ul>
1821
+ </nav>
1822
+ </div>
1823
+ </div>
1824
+ </div>
1825
+
1826
+
1827
+ <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
1828
+ <div class="md-sidebar__scrollwrap">
1829
+ <div class="md-sidebar__inner">
1830
+
1831
+ <nav class="md-nav md-nav--secondary">
1832
+
1833
+
1834
+
1835
+
1836
+
1837
+ <label class="md-nav__title" for="__toc">Table of contents</label>
1838
+ <ul class="md-nav__list" data-md-scrollfix>
1839
+
1840
+ <li class="md-nav__item">
1841
+ <a href="#install" title="Install" class="md-nav__link">
1842
+ Install
1843
+ </a>
1844
+
1845
+ </li>
1846
+
1847
+ <li class="md-nav__item">
1848
+ <a href="#getting-started-with-sharepoint-framework" title="Getting Started with SharePoint Framework" class="md-nav__link">
1849
+ Getting Started with SharePoint Framework
1850
+ </a>
1851
+
1852
+ <nav class="md-nav">
1853
+ <ul class="md-nav__list">
1854
+
1855
+ <li class="md-nav__item">
1856
+ <a href="#establish-context" title="Establish Context" class="md-nav__link">
1857
+ Establish Context
1858
+ </a>
1859
+
1860
+ <nav class="md-nav">
1861
+ <ul class="md-nav__list">
1862
+
1863
+ <li class="md-nav__item">
1864
+ <a href="#using-pnpcommon-setup" title="Using @pnp/core setup" class="md-nav__link">
1865
+ Using @pnp/core setup
1866
+ </a>
1867
+
1868
+ </li>
1869
+
1870
+ <li class="md-nav__item">
1871
+ <a href="#using-pnpsp-setup" title="Using @pnp/sp setup" class="md-nav__link">
1872
+ Using @pnp/sp setup
1873
+ </a>
1874
+
1875
+ </li>
1876
+
1877
+ <li class="md-nav__item">
1878
+ <a href="#using-pnpgraph-setup" title="Using @pnp/graph setup" class="md-nav__link">
1879
+ Using @pnp/graph setup
1880
+ </a>
1881
+
1882
+ </li>
1883
+
1884
+ <li class="md-nav__item">
1885
+ <a href="#establish-context-with-an-spfx-service" title="Establish Context with an SPFx Service" class="md-nav__link">
1886
+ Establish Context with an SPFx Service
1887
+ </a>
1888
+
1889
+ </li>
1890
+
1891
+ </ul>
1892
+ </nav>
1893
+
1894
+ </li>
1895
+
1896
+ </ul>
1897
+ </nav>
1898
+
1899
+ </li>
1900
+
1901
+ <li class="md-nav__item">
1902
+ <a href="#connect-to-sharepoint-from-node" title="Connect to SharePoint from Node" class="md-nav__link">
1903
+ Connect to SharePoint from Node
1904
+ </a>
1905
+
1906
+ </li>
1907
+
1908
+ <li class="md-nav__item">
1909
+ <a href="#connect-to-microsoft-graph-from-node" title="Connect to Microsoft Graph From Node" class="md-nav__link">
1910
+ Connect to Microsoft Graph From Node
1911
+ </a>
1912
+
1913
+ </li>
1914
+
1915
+ <li class="md-nav__item">
1916
+ <a href="#getting-started-outside-sharepoint-framework" title="Getting Started outside SharePoint Framework" class="md-nav__link">
1917
+ Getting Started outside SharePoint Framework
1918
+ </a>
1919
+
1920
+ <nav class="md-nav">
1921
+ <ul class="md-nav__list">
1922
+
1923
+ <li class="md-nav__item">
1924
+ <a href="#set-baseurl-through-setup" title="Set baseUrl through setup:" class="md-nav__link">
1925
+ Set baseUrl through setup:
1926
+ </a>
1927
+
1928
+ </li>
1929
+
1930
+ <li class="md-nav__item">
1931
+ <a href="#create-web-instances-directly" title="Create Web instances directly" class="md-nav__link">
1932
+ Create Web instances directly
1933
+ </a>
1934
+
1935
+ </li>
1936
+
1937
+ </ul>
1938
+ </nav>
1939
+
1940
+ </li>
1941
+
1942
+
1943
+
1944
+
1945
+
1946
+ </ul>
1947
+
1948
+ </nav>
1949
+ </div>
1950
+ </div>
1951
+ </div>
1952
+
1953
+
1954
+ <div class="md-content">
1955
+ <article class="md-content__inner md-typeset">
1956
+
1957
+
1958
+ <a href="http://github.com/pnp/pnpjs/tree/dev/packages/documentation/getting-started.md" title="Edit this page" class="md-icon md-content__icon">&#xE3C9;</a>
1959
+
1960
+
1961
+ <h1 id="getting-started">Getting Started<a class="headerlink" href="#getting-started" title="Permanent link">&para;</a></h1>
1962
+ <p>These libraries are geared towards folks working with TypeScript but will work equally well for JavaScript projects. To get started you need to install
1963
+ the libraries you need via npm. Many of the packages have a peer dependency to other packages with the @pnp namespace meaning you may need to install
1964
+ more than one package. All packages are released together eliminating version confusion - all packages will depend on packages with the same version number.</p>
1965
+ <p>If you need to support older browsers please review the article on <a href="../polyfill/">polyfills</a> for required functionality.</p>
1966
+ <h2 id="install">Install<a class="headerlink" href="#install" title="Permanent link">&para;</a></h2>
1967
+ <p>First you will need to install those libraries you want to use in your application. Here we will install the most frequently used packages. This step applies to any
1968
+ environment or project.</p>
1969
+ <p><code>npm install @pnp/logging @pnp/core @pnp/queryable @pnp/sp @pnp/graph --save</code></p>
1970
+ <p>Next we can import and use the functionality within our application. The below is a very simple example, please see the individual package documentation
1971
+ for more details.</p>
1972
+ <div class="codehilite"><pre><span></span><span class="kr">import</span> <span class="p">{</span> <span class="nx">getRandomString</span> <span class="p">}</span> <span class="nx">from</span> <span class="s2">&quot;@pnp/core&quot;</span><span class="p">;</span>
1973
+
1974
+ <span class="p">(</span><span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
1975
+
1976
+ <span class="c1">// get and log a random string</span>
1977
+ <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">getRandomString</span><span class="p">(</span><span class="mi">20</span><span class="p">));</span>
1978
+
1979
+ <span class="p">})()</span>
1980
+ </pre></div>
1981
+
1982
+
1983
+ <h2 id="getting-started-with-sharepoint-framework">Getting Started with SharePoint Framework<a class="headerlink" href="#getting-started-with-sharepoint-framework" title="Permanent link">&para;</a></h2>
1984
+ <p>The @pnp/sp and @pnp/graph libraries are designed to work seamlessly within SharePoint Framework projects with a small amount of upfront configuration. If you are running in 2016 on-premises please <a href="../SPFx-On-Premesis-2016/">read this note</a> on a workaround for the included TypeScript version. If you are targetting SharePoint online you do not need to take any additional steps.</p>
1985
+ <h3 id="establish-context">Establish Context<a class="headerlink" href="#establish-context" title="Permanent link">&para;</a></h3>
1986
+ <p>Because SharePoint Framework provides a local context to each component we need to set that context within the library. This allows us to determine request
1987
+ urls as well as use the SPFx HttpGraphClient within @pnp/graph. There are two ways to provide the spfx context to the library. Either through the setup method
1988
+ imported from @pnp/core or using the setup method on either the @pnp/sp or @pnp/graph main export. All three are shown below and are equivalent, meaning if
1989
+ you are already importing the sp variable from @pnp/sp or the graph variable from @pnp/graph you should use their setup method to reduce imports. </p>
1990
+ <p>The setup is always done in the onInit method to ensure it runs before your other lifecycle code. You can also set any other settings at this time.</p>
1991
+ <h4 id="using-pnpcommon-setup">Using @pnp/core setup<a class="headerlink" href="#using-pnpcommon-setup" title="Permanent link">&para;</a></h4>
1992
+ <div class="codehilite"><pre><span></span><span class="kr">import</span> <span class="p">{</span> <span class="nx">setup</span> <span class="kr">as</span> <span class="nx">pnpSetup</span> <span class="p">}</span> <span class="nx">from</span> <span class="s2">&quot;@pnp/core&quot;</span><span class="p">;</span>
1993
+
1994
+ <span class="c1">// ...</span>
1995
+
1996
+ <span class="kr">public</span> <span class="nx">onInit</span><span class="p">()</span><span class="o">:</span> <span class="nx">Promise</span><span class="o">&lt;</span><span class="k">void</span><span class="o">&gt;</span> <span class="p">{</span>
1997
+
1998
+ <span class="k">return</span> <span class="kr">super</span><span class="p">.</span><span class="nx">onInit</span><span class="p">().</span><span class="nx">then</span><span class="p">(</span><span class="nx">_</span> <span class="o">=&gt;</span> <span class="p">{</span>
1999
+
2000
+ <span class="c1">// other init code may be present</span>
2001
+
2002
+ <span class="nx">pnpSetup</span><span class="p">({</span>
2003
+ <span class="nx">spfxContext</span>: <span class="kt">this.context</span>
2004
+ <span class="p">});</span>
2005
+ <span class="p">});</span>
2006
+ <span class="p">}</span>
2007
+
2008
+ <span class="c1">// ...</span>
2009
+ </pre></div>
2010
+
2011
+
2012
+ <h4 id="using-pnpsp-setup">Using @pnp/sp setup<a class="headerlink" href="#using-pnpsp-setup" title="Permanent link">&para;</a></h4>
2013
+ <div class="codehilite"><pre><span></span><span class="kr">import</span> <span class="p">{</span> <span class="nx">sp</span> <span class="p">}</span> <span class="nx">from</span> <span class="s2">&quot;@pnp/sp&quot;</span><span class="p">;</span>
2014
+
2015
+ <span class="c1">// ...</span>
2016
+
2017
+ <span class="kr">public</span> <span class="nx">onInit</span><span class="p">()</span><span class="o">:</span> <span class="nx">Promise</span><span class="o">&lt;</span><span class="k">void</span><span class="o">&gt;</span> <span class="p">{</span>
2018
+
2019
+ <span class="k">return</span> <span class="kr">super</span><span class="p">.</span><span class="nx">onInit</span><span class="p">().</span><span class="nx">then</span><span class="p">(</span><span class="nx">_</span> <span class="o">=&gt;</span> <span class="p">{</span>
2020
+
2021
+ <span class="c1">// other init code may be present</span>
2022
+
2023
+ <span class="nx">sp</span><span class="p">.</span><span class="nx">setup</span><span class="p">({</span>
2024
+ <span class="nx">spfxContext</span>: <span class="kt">this.context</span>
2025
+ <span class="p">});</span>
2026
+ <span class="p">});</span>
2027
+ <span class="p">}</span>
2028
+
2029
+ <span class="c1">// ...</span>
2030
+ </pre></div>
2031
+
2032
+
2033
+ <h4 id="using-pnpgraph-setup">Using @pnp/graph setup<a class="headerlink" href="#using-pnpgraph-setup" title="Permanent link">&para;</a></h4>
2034
+ <div class="codehilite"><pre><span></span><span class="kr">import</span> <span class="p">{</span> <span class="nx">graph</span> <span class="p">}</span> <span class="nx">from</span> <span class="s2">&quot;@pnp/graph&quot;</span><span class="p">;</span>
2035
+
2036
+ <span class="c1">// ...</span>
2037
+
2038
+ <span class="kr">public</span> <span class="nx">onInit</span><span class="p">()</span><span class="o">:</span> <span class="nx">Promise</span><span class="o">&lt;</span><span class="k">void</span><span class="o">&gt;</span> <span class="p">{</span>
2039
+
2040
+ <span class="k">return</span> <span class="kr">super</span><span class="p">.</span><span class="nx">onInit</span><span class="p">().</span><span class="nx">then</span><span class="p">(</span><span class="nx">_</span> <span class="o">=&gt;</span> <span class="p">{</span>
2041
+
2042
+ <span class="c1">// other init code may be present</span>
2043
+
2044
+ <span class="nx">graph</span><span class="p">.</span><span class="nx">setup</span><span class="p">({</span>
2045
+ <span class="nx">spfxContext</span>: <span class="kt">this.context</span>
2046
+ <span class="p">});</span>
2047
+ <span class="p">});</span>
2048
+ <span class="p">}</span>
2049
+
2050
+ <span class="c1">// ...</span>
2051
+ </pre></div>
2052
+
2053
+
2054
+ <h4 id="establish-context-with-an-spfx-service">Establish Context with an SPFx Service<a class="headerlink" href="#establish-context-with-an-spfx-service" title="Permanent link">&para;</a></h4>
2055
+ <p>Because you do not have access to the full context object within a service you need to setup things slightly differently. This works for the sp library, but not the graph library as we don't have access to the AAD token provider from the full context.</p>
2056
+ <div class="codehilite"><pre><span></span><span class="kr">import</span> <span class="p">{</span> <span class="nx">ServiceKey</span><span class="p">,</span> <span class="nx">ServiceScope</span> <span class="p">}</span> <span class="nx">from</span> <span class="s2">&quot;@microsoft/sp-core-library&quot;</span><span class="p">;</span>
2057
+ <span class="kr">import</span> <span class="p">{</span> <span class="nx">PageContext</span> <span class="p">}</span> <span class="nx">from</span> <span class="s2">&quot;@microsoft/sp-page-context&quot;</span><span class="p">;</span>
2058
+ <span class="kr">import</span> <span class="p">{</span> <span class="nx">AadTokenProviderFactory</span> <span class="p">}</span> <span class="nx">from</span> <span class="s2">&quot;@microsoft/sp-http&quot;</span><span class="p">;</span>
2059
+ <span class="kr">import</span> <span class="p">{</span> <span class="nx">sp</span> <span class="p">}</span> <span class="nx">from</span> <span class="s2">&quot;@pnp/sp&quot;</span><span class="p">;</span>
2060
+
2061
+ <span class="kr">export</span> <span class="kr">interface</span> <span class="nx">ISampleService</span> <span class="p">{</span>
2062
+ <span class="nx">getLists</span><span class="p">()</span><span class="o">:</span> <span class="nx">Promise</span><span class="o">&lt;</span><span class="nx">any</span><span class="p">[]</span><span class="o">&gt;</span><span class="p">;</span>
2063
+ <span class="p">}</span>
2064
+
2065
+ <span class="kr">export</span> <span class="kr">class</span> <span class="nx">SampleService</span> <span class="p">{</span>
2066
+
2067
+ <span class="kr">public</span> <span class="kr">static</span> <span class="nx">readonly</span> <span class="nx">serviceKey</span>: <span class="kt">ServiceKey</span><span class="o">&lt;</span><span class="nx">ISampleService</span><span class="o">&gt;</span> <span class="o">=</span> <span class="nx">ServiceKey</span><span class="p">.</span><span class="nx">create</span><span class="o">&lt;</span><span class="nx">ISampleService</span><span class="o">&gt;</span><span class="p">(</span><span class="s1">&#39;SPFx:SampleService&#39;</span><span class="p">,</span> <span class="nx">SampleService</span><span class="p">);</span>
2068
+
2069
+ <span class="kr">constructor</span><span class="p">(</span><span class="nx">serviceScope</span>: <span class="kt">ServiceScope</span><span class="p">)</span> <span class="p">{</span>
2070
+
2071
+ <span class="nx">serviceScope</span><span class="p">.</span><span class="nx">whenFinished</span><span class="p">(()</span> <span class="o">=&gt;</span> <span class="p">{</span>
2072
+
2073
+ <span class="kr">const</span> <span class="nx">pageContext</span> <span class="o">=</span> <span class="nx">serviceScope</span><span class="p">.</span><span class="nx">consume</span><span class="p">(</span><span class="nx">PageContext</span><span class="p">.</span><span class="nx">serviceKey</span><span class="p">);</span>
2074
+ <span class="kr">const</span> <span class="nx">tokenProviderFactory</span> <span class="o">=</span> <span class="nx">serviceScope</span><span class="p">.</span><span class="nx">consume</span><span class="p">(</span><span class="nx">AadTokenProviderFactory</span><span class="p">.</span><span class="nx">serviceKey</span><span class="p">);</span>
2075
+
2076
+ <span class="c1">// we need to &quot;spoof&quot; the context object with the parts we need for PnPjs</span>
2077
+ <span class="nx">sp</span><span class="p">.</span><span class="nx">setup</span><span class="p">({</span>
2078
+ <span class="nx">spfxContext</span><span class="o">:</span> <span class="p">{</span>
2079
+ <span class="nx">aadTokenProviderFactory</span>: <span class="kt">tokenProviderFactory</span><span class="p">,</span>
2080
+ <span class="nx">pageContext</span>: <span class="kt">pageContext</span><span class="p">,</span>
2081
+ <span class="p">}</span>
2082
+ <span class="p">});</span>
2083
+
2084
+ <span class="c1">// This approach also works if you do not require AAD tokens</span>
2085
+ <span class="c1">// you don&#39;t need to do both</span>
2086
+ <span class="c1">// sp.setup({</span>
2087
+ <span class="c1">// sp : {</span>
2088
+ <span class="c1">// baseUrl : pageContext.web.absoluteUrl</span>
2089
+ <span class="c1">// }</span>
2090
+ <span class="c1">// });</span>
2091
+ <span class="p">});</span>
2092
+ <span class="p">}</span>
2093
+ <span class="kr">public</span> <span class="nx">getLists</span><span class="p">()</span><span class="o">:</span> <span class="nx">Promise</span><span class="o">&lt;</span><span class="nx">any</span><span class="p">[]</span><span class="o">&gt;</span> <span class="p">{</span>
2094
+ <span class="k">return</span> <span class="nx">sp</span><span class="p">.</span><span class="nx">web</span><span class="p">.</span><span class="nx">lists</span><span class="p">.</span><span class="nx">get</span><span class="p">();</span>
2095
+ <span class="p">}</span>
2096
+ <span class="p">}</span>
2097
+ </pre></div>
2098
+
2099
+
2100
+ <h2 id="connect-to-sharepoint-from-node">Connect to SharePoint from Node<a class="headerlink" href="#connect-to-sharepoint-from-node" title="Permanent link">&para;</a></h2>
2101
+ <p>Because peer dependencies are not installed automatically you will need to list out each package to install. Don't worry if you forget one you will get a message
2102
+ on the command line that a peer dependency is missing. Let's for example look at installing the required libraries to connect to SharePoint from nodejs. You can see
2103
+ <a href="https://github.com/pnp/pnpjs/blob/main/debug/launch/sp.ts">./debug/launch/sp.ts</a> for a live example.</p>
2104
+ <div class="codehilite"><pre><span></span>npm i @pnp/logging @pnp/core @pnp/queryable @pnp/sp @pnp/nodejs
2105
+ </pre></div>
2106
+
2107
+
2108
+ <p>This will install the logging, common, odata, sp, and nodejs packages. You can read more about what each package does starting on the <a href="../packages/">packages</a> page.
2109
+ Once these are installed you need to import them into your project, to communicate with SharePoint from node we'll need the following imports:</p>
2110
+ <div class="codehilite"><pre><span></span><span class="kr">import</span> <span class="p">{</span> <span class="nx">sp</span> <span class="p">}</span> <span class="nx">from</span> <span class="s2">&quot;@pnp/sp&quot;</span><span class="p">;</span>
2111
+ <span class="kr">import</span> <span class="p">{</span> <span class="nx">SPFetchClient</span> <span class="p">}</span> <span class="nx">from</span> <span class="s2">&quot;@pnp/nodejs&quot;</span><span class="p">;</span>
2112
+ </pre></div>
2113
+
2114
+
2115
+ <p>Once you have imported the necessary resources you can update your code to setup the node fetch client as well as make a call to SharePoint.</p>
2116
+ <div class="codehilite"><pre><span></span><span class="c1">// configure your node options (only once in your application)</span>
2117
+ <span class="nx">sp</span><span class="p">.</span><span class="nx">setup</span><span class="p">({</span>
2118
+ <span class="nx">sp</span><span class="o">:</span> <span class="p">{</span>
2119
+ <span class="nx">fetchClientFactory</span><span class="o">:</span> <span class="p">()</span> <span class="o">=&gt;</span> <span class="p">{</span>
2120
+ <span class="k">return</span> <span class="k">new</span> <span class="nx">SPFetchClient</span><span class="p">(</span><span class="s2">&quot;{site url}&quot;</span><span class="p">,</span> <span class="s2">&quot;{client id}&quot;</span><span class="p">,</span> <span class="s2">&quot;{client secret}&quot;</span><span class="p">);</span>
2121
+ <span class="p">},</span>
2122
+ <span class="p">},</span>
2123
+ <span class="p">});</span>
2124
+
2125
+ <span class="c1">// make a call to SharePoint and log it in the console</span>
2126
+ <span class="nx">sp</span><span class="p">.</span><span class="nx">web</span><span class="p">.</span><span class="nx">select</span><span class="p">(</span><span class="s2">&quot;Title&quot;</span><span class="p">,</span> <span class="s2">&quot;Description&quot;</span><span class="p">).</span><span class="nx">get</span><span class="p">().</span><span class="nx">then</span><span class="p">(</span><span class="nx">w</span> <span class="o">=&gt;</span> <span class="p">{</span>
2127
+ <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">JSON</span><span class="p">.</span><span class="nx">stringify</span><span class="p">(</span><span class="nx">w</span><span class="p">,</span> <span class="kc">null</span><span class="p">,</span> <span class="mi">4</span><span class="p">));</span>
2128
+ <span class="p">});</span>
2129
+ </pre></div>
2130
+
2131
+
2132
+ <h2 id="connect-to-microsoft-graph-from-node">Connect to Microsoft Graph From Node<a class="headerlink" href="#connect-to-microsoft-graph-from-node" title="Permanent link">&para;</a></h2>
2133
+ <p>Similar to the above you can also make calls to the Graph api from node using the libraries. Again we start with installing the required resources. You can see
2134
+ <a href="https://github.com/pnp/pnpjs/blob/main/debug/launch/graph.ts">./debug/launch/graph.ts</a> for a live example.</p>
2135
+ <div class="codehilite"><pre><span></span>npm i @pnp/logging @pnp/core @pnp/queryable @pnp/graph @pnp/nodejs
2136
+ </pre></div>
2137
+
2138
+
2139
+ <p>Now we need to import what we'll need to call graph</p>
2140
+ <div class="codehilite"><pre><span></span><span class="kr">import</span> <span class="p">{</span> <span class="nx">graph</span> <span class="p">}</span> <span class="nx">from</span> <span class="s2">&quot;@pnp/graph&quot;</span><span class="p">;</span>
2141
+ <span class="kr">import</span> <span class="p">{</span> <span class="nx">AdalFetchClient</span> <span class="p">}</span> <span class="nx">from</span> <span class="s2">&quot;@pnp/nodejs&quot;</span><span class="p">;</span>
2142
+ </pre></div>
2143
+
2144
+
2145
+ <p>Now we can make our graph calls after setting up the Adal client. Note you'll need to setup an AzureAD App registration with the necessary permissions.</p>
2146
+ <div class="codehilite"><pre><span></span><span class="nx">graph</span><span class="p">.</span><span class="nx">setup</span><span class="p">({</span>
2147
+ <span class="nx">graph</span><span class="o">:</span> <span class="p">{</span>
2148
+ <span class="nx">fetchClientFactory</span><span class="o">:</span> <span class="p">()</span> <span class="o">=&gt;</span> <span class="p">{</span>
2149
+ <span class="k">return</span> <span class="k">new</span> <span class="nx">AdalFetchClient</span><span class="p">(</span><span class="s2">&quot;{mytenant}.onmicrosoft.com&quot;</span><span class="p">,</span> <span class="s2">&quot;{application id}&quot;</span><span class="p">,</span> <span class="s2">&quot;{application secret}&quot;</span><span class="p">);</span>
2150
+ <span class="p">},</span>
2151
+ <span class="p">},</span>
2152
+ <span class="p">});</span>
2153
+
2154
+ <span class="c1">// make a call to Graph and get all the groups</span>
2155
+ <span class="nx">graph</span><span class="p">.</span><span class="nx">v1</span><span class="p">.</span><span class="nx">groups</span><span class="p">.</span><span class="nx">get</span><span class="p">().</span><span class="nx">then</span><span class="p">(</span><span class="nx">g</span> <span class="o">=&gt;</span> <span class="p">{</span>
2156
+ <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">JSON</span><span class="p">.</span><span class="nx">stringify</span><span class="p">(</span><span class="nx">g</span><span class="p">,</span> <span class="kc">null</span><span class="p">,</span> <span class="mi">4</span><span class="p">));</span>
2157
+ <span class="p">});</span>
2158
+ </pre></div>
2159
+
2160
+
2161
+ <h2 id="getting-started-outside-sharepoint-framework">Getting Started outside SharePoint Framework<a class="headerlink" href="#getting-started-outside-sharepoint-framework" title="Permanent link">&para;</a></h2>
2162
+ <p>In some cases you may be working in a way such that we cannot determine the base url for the web. In this scenario you have two options.</p>
2163
+ <h3 id="set-baseurl-through-setup">Set baseUrl through setup:<a class="headerlink" href="#set-baseurl-through-setup" title="Permanent link">&para;</a></h3>
2164
+ <p>Here we are setting the baseUrl via the sp.setup method. We are also setting the headers to use verbose mode, something you may have to do when
2165
+ working against unpatched versions of SharePoint 2013 as <a href="https://blogs.msdn.microsoft.com/patrickrodgers/2016/06/13/pnp-jscore-1-0-1/">discussed here</a>.
2166
+ This is optional for 2016 or SharePoint Online.</p>
2167
+ <div class="codehilite"><pre><span></span><span class="kr">import</span> <span class="p">{</span> <span class="nx">sp</span> <span class="p">}</span> <span class="nx">from</span> <span class="s2">&quot;@pnp/sp&quot;</span><span class="p">;</span>
2168
+
2169
+ <span class="nx">sp</span><span class="p">.</span><span class="nx">setup</span><span class="p">({</span>
2170
+ <span class="nx">sp</span><span class="o">:</span> <span class="p">{</span>
2171
+ <span class="nx">headers</span><span class="o">:</span> <span class="p">{</span>
2172
+ <span class="nx">Accept</span><span class="o">:</span> <span class="s2">&quot;application/json;odata=verbose&quot;</span><span class="p">,</span>
2173
+ <span class="p">},</span>
2174
+ <span class="nx">baseUrl</span><span class="o">:</span> <span class="s2">&quot;{Absolute SharePoint Web URL}&quot;</span>
2175
+ <span class="p">},</span>
2176
+ <span class="p">});</span>
2177
+
2178
+ <span class="kr">const</span> <span class="nx">w</span> <span class="o">=</span> <span class="nx">await</span> <span class="nx">sp</span><span class="p">.</span><span class="nx">web</span><span class="p">.</span><span class="nx">get</span><span class="p">();</span>
2179
+ </pre></div>
2180
+
2181
+
2182
+ <h3 id="create-web-instances-directly">Create Web instances directly<a class="headerlink" href="#create-web-instances-directly" title="Permanent link">&para;</a></h3>
2183
+ <p>Using this method you create the web directly with the url you want to use as the base.</p>
2184
+ <div class="codehilite"><pre><span></span><span class="kr">import</span> <span class="p">{</span> <span class="nx">Web</span> <span class="p">}</span> <span class="nx">from</span> <span class="s2">&quot;@pnp/sp&quot;</span><span class="p">;</span>
2185
+
2186
+ <span class="kr">const</span> <span class="nx">web</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Web</span><span class="p">(</span><span class="s2">&quot;{Absolute SharePoint Web URL}&quot;</span><span class="p">);</span>
2187
+ <span class="kr">const</span> <span class="nx">w</span> <span class="o">=</span> <span class="nx">await</span> <span class="nx">web</span><span class="p">.</span><span class="nx">get</span><span class="p">();</span>
2188
+ </pre></div>
2189
+
2190
+
2191
+
2192
+
2193
+
2194
+
2195
+
2196
+
2197
+
2198
+ </article>
2199
+ </div>
2200
+ </div>
2201
+ </main>
2202
+
2203
+
2204
+ <footer class="md-footer">
2205
+
2206
+ <div class="md-footer-nav">
2207
+ <nav class="md-footer-nav__inner md-grid">
2208
+
2209
+ <a href="../transition-guide/" title="Transition Guide" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
2210
+ <div class="md-flex__cell md-flex__cell--shrink">
2211
+ <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
2212
+ </div>
2213
+ <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
2214
+ <span class="md-flex__ellipsis">
2215
+ <span class="md-footer-nav__direction">
2216
+ Previous
2217
+ </span>
2218
+ Transition Guide
2219
+ </span>
2220
+ </div>
2221
+ </a>
2222
+
2223
+
2224
+ <a href="../getting-started-dev/" title="Getting Started Contributing" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
2225
+ <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
2226
+ <span class="md-flex__ellipsis">
2227
+ <span class="md-footer-nav__direction">
2228
+ Next
2229
+ </span>
2230
+ Getting Started Contributing
2231
+ </span>
2232
+ </div>
2233
+ <div class="md-flex__cell md-flex__cell--shrink">
2234
+ <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
2235
+ </div>
2236
+ </a>
2237
+
2238
+ </nav>
2239
+ </div>
2240
+
2241
+ <div class="md-footer-meta md-typeset">
2242
+ <div class="md-footer-meta__inner md-grid">
2243
+ <div class="md-footer-copyright">
2244
+
2245
+ powered by
2246
+ <a href="https://www.mkdocs.org">MkDocs</a>
2247
+ and
2248
+ <a href="https://squidfunk.github.io/mkdocs-material/">
2249
+ Material for MkDocs</a>
2250
+ </div>
2251
+
2252
+
2253
+ <div class="md-footer-social">
2254
+ <link rel="stylesheet" href="../../assets/fonts/font-awesome.css">
2255
+
2256
+ <a href="https://twitter.com/officedevpnp" class="md-footer-social__link fa fa-twitter"></a>
2257
+
2258
+ <a href="http://aka.ms/sppnp-videos" class="md-footer-social__link fa fa-youtube"></a>
2259
+
2260
+ <a href="https://aka.ms/sppnp" class="md-footer-social__link fa fa-link"></a>
2261
+
2262
+ </div>
2263
+
2264
+
2265
+ </div>
2266
+ </div>
2267
+ </footer>
2268
+
2269
+ </div>
2270
+
2271
+ <script src="../../assets/javascripts/application.583bbe55.js"></script>
2272
+
2273
+ <script>app.initialize({version:"1.0.1",url:{base:"../.."}})</script>
2274
+
2275
+
2276
+
2277
+ <img src="https://telemetry.sharepointpnp.com/@pnp/pnpjs/ghpages/pnpjs/documentation/getting-started/" alt="spacer" />
2278
+
2279
+ </body>
2280
+ </html>