@zxncij2390/monorepo3 3.18.0

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