@pnp/sp 2.10.0 → 2.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (294) hide show
  1. package/LICENSE +25 -25
  2. package/appcatalog/index.d.ts +8 -8
  3. package/appcatalog/index.js +30 -30
  4. package/appcatalog/types.d.ts +81 -81
  5. package/appcatalog/types.js +177 -177
  6. package/appcatalog/web.d.ts +16 -16
  7. package/appcatalog/web.js +6 -6
  8. package/attachments/index.d.ts +2 -2
  9. package/attachments/index.js +2 -2
  10. package/attachments/item.d.ts +12 -12
  11. package/attachments/item.js +4 -4
  12. package/attachments/types.d.ts +92 -92
  13. package/attachments/types.js +240 -240
  14. package/batch.d.ts +17 -17
  15. package/batch.js +223 -223
  16. package/clientside-pages/funcs.d.ts +22 -22
  17. package/clientside-pages/funcs.js +25 -25
  18. package/clientside-pages/index.d.ts +2 -2
  19. package/clientside-pages/index.js +2 -2
  20. package/clientside-pages/types.d.ts +496 -496
  21. package/clientside-pages/types.js +1496 -1496
  22. package/clientside-pages/web.d.ts +41 -41
  23. package/clientside-pages/web.js +57 -57
  24. package/column-defaults/folder.d.ts +27 -27
  25. package/column-defaults/folder.js +82 -82
  26. package/column-defaults/index.d.ts +3 -3
  27. package/column-defaults/index.js +2 -2
  28. package/column-defaults/list.d.ts +19 -19
  29. package/column-defaults/list.js +198 -198
  30. package/column-defaults/types.d.ts +21 -21
  31. package/column-defaults/types.js +1 -1
  32. package/comments/clientside-page.d.ts +57 -57
  33. package/comments/clientside-page.d.ts.map +1 -1
  34. package/comments/clientside-page.js +136 -136
  35. package/comments/index.d.ts +2 -2
  36. package/comments/index.js +2 -2
  37. package/comments/item.d.ts +29 -29
  38. package/comments/item.js +47 -47
  39. package/comments/types.d.ts +107 -107
  40. package/comments/types.d.ts.map +1 -1
  41. package/comments/types.js +145 -145
  42. package/comments/types.js.map +1 -1
  43. package/content-types/index.d.ts +4 -4
  44. package/content-types/index.js +4 -4
  45. package/content-types/item.d.ts +12 -12
  46. package/content-types/item.js +4 -4
  47. package/content-types/list.d.ts +12 -12
  48. package/content-types/list.js +4 -4
  49. package/content-types/types.d.ts +107 -107
  50. package/content-types/types.js +166 -166
  51. package/content-types/web.d.ts +12 -12
  52. package/content-types/web.js +4 -4
  53. package/decorators.d.ts +11 -11
  54. package/decorators.js +28 -28
  55. package/features/index.d.ts +3 -3
  56. package/features/index.js +3 -3
  57. package/features/site.d.ts +12 -12
  58. package/features/site.js +4 -4
  59. package/features/types.d.ts +47 -47
  60. package/features/types.js +109 -109
  61. package/features/web.d.ts +12 -12
  62. package/features/web.js +4 -4
  63. package/fields/index.d.ts +4 -4
  64. package/fields/index.js +4 -4
  65. package/fields/list.d.ts +12 -12
  66. package/fields/list.js +4 -4
  67. package/fields/types.d.ts +368 -368
  68. package/fields/types.js +624 -624
  69. package/fields/web.d.ts +17 -17
  70. package/fields/web.js +5 -5
  71. package/files/folder.d.ts +12 -12
  72. package/files/folder.js +4 -4
  73. package/files/index.d.ts +4 -4
  74. package/files/index.js +4 -4
  75. package/files/item.d.ts +12 -12
  76. package/files/item.js +4 -4
  77. package/files/types.d.ts +421 -421
  78. package/files/types.js +853 -853
  79. package/files/web.d.ts +35 -35
  80. package/files/web.js +15 -15
  81. package/folders/index.d.ts +4 -4
  82. package/folders/index.js +4 -4
  83. package/folders/item.d.ts +9 -9
  84. package/folders/item.js +4 -4
  85. package/folders/list.d.ts +12 -12
  86. package/folders/list.js +4 -4
  87. package/folders/types.d.ts +207 -207
  88. package/folders/types.js +433 -433
  89. package/folders/web.d.ts +39 -39
  90. package/folders/web.js +15 -15
  91. package/forms/index.d.ts +2 -2
  92. package/forms/index.js +2 -2
  93. package/forms/list.d.ts +9 -9
  94. package/forms/list.js +4 -4
  95. package/forms/types.d.ts +35 -35
  96. package/forms/types.js +41 -41
  97. package/hubsites/index.d.ts +12 -12
  98. package/hubsites/index.js +15 -15
  99. package/hubsites/site.d.ts +26 -26
  100. package/hubsites/site.js +39 -39
  101. package/hubsites/types.d.ts +55 -55
  102. package/hubsites/types.js +53 -53
  103. package/hubsites/web.d.ts +21 -21
  104. package/hubsites/web.js +23 -23
  105. package/index.d.ts +14 -14
  106. package/index.js +13 -13
  107. package/items/index.d.ts +2 -2
  108. package/items/index.js +2 -2
  109. package/items/list.d.ts +9 -9
  110. package/items/list.js +4 -4
  111. package/items/types.d.ts +226 -226
  112. package/items/types.js +549 -549
  113. package/lists/index.d.ts +2 -2
  114. package/lists/index.js +2 -2
  115. package/lists/types.d.ts +495 -495
  116. package/lists/types.js +522 -522
  117. package/lists/web.d.ts +43 -43
  118. package/lists/web.js +27 -27
  119. package/navigation/index.d.ts +8 -8
  120. package/navigation/index.js +14 -14
  121. package/navigation/types.d.ts +154 -154
  122. package/navigation/types.js +219 -219
  123. package/navigation/web.d.ts +13 -13
  124. package/navigation/web.js +4 -4
  125. package/odata.d.ts +5 -5
  126. package/odata.js +90 -90
  127. package/operations.d.ts +9 -9
  128. package/operations.js +63 -63
  129. package/package.json +4 -4
  130. package/presets/all.d.ts +72 -72
  131. package/presets/all.js +72 -72
  132. package/presets/core.d.ts +11 -11
  133. package/presets/core.js +11 -11
  134. package/profiles/index.d.ts +7 -7
  135. package/profiles/index.js +13 -13
  136. package/profiles/types.d.ts +357 -357
  137. package/profiles/types.js +454 -454
  138. package/readme.md +21 -21
  139. package/regional-settings/content-type.d.ts +7 -7
  140. package/regional-settings/content-type.js +4 -4
  141. package/regional-settings/field.d.ts +7 -7
  142. package/regional-settings/field.js +4 -4
  143. package/regional-settings/funcs.d.ts +2 -2
  144. package/regional-settings/funcs.js +8 -8
  145. package/regional-settings/index.d.ts +6 -6
  146. package/regional-settings/index.js +6 -6
  147. package/regional-settings/list.d.ts +7 -7
  148. package/regional-settings/list.js +4 -4
  149. package/regional-settings/types.d.ts +111 -111
  150. package/regional-settings/types.js +159 -159
  151. package/regional-settings/user-custom-actions.d.ts +7 -7
  152. package/regional-settings/user-custom-actions.js +4 -4
  153. package/regional-settings/web.d.ts +12 -12
  154. package/regional-settings/web.js +7 -7
  155. package/related-items/index.d.ts +1 -1
  156. package/related-items/index.js +1 -1
  157. package/related-items/types.d.ts +76 -76
  158. package/related-items/types.js +103 -103
  159. package/related-items/web.d.ts +12 -12
  160. package/related-items/web.js +9 -9
  161. package/rest.d.ts +44 -44
  162. package/rest.js +72 -72
  163. package/search/index.d.ts +30 -30
  164. package/search/index.js +25 -25
  165. package/search/query.d.ts +62 -62
  166. package/search/query.js +302 -302
  167. package/search/suggest.d.ts +76 -76
  168. package/search/suggest.js +66 -66
  169. package/search/types.d.ts +426 -426
  170. package/search/types.js +57 -57
  171. package/security/funcs.d.ts +43 -43
  172. package/security/funcs.js +142 -142
  173. package/security/index.d.ts +4 -4
  174. package/security/index.js +4 -4
  175. package/security/item.d.ts +7 -7
  176. package/security/item.js +14 -14
  177. package/security/list.d.ts +7 -7
  178. package/security/list.js +14 -14
  179. package/security/types.d.ts +318 -318
  180. package/security/types.js +399 -399
  181. package/security/web.d.ts +9 -9
  182. package/security/web.js +15 -15
  183. package/sharepointqueryable.d.ts +135 -135
  184. package/sharepointqueryable.js +265 -265
  185. package/sharing/file.d.ts +18 -18
  186. package/sharing/file.js +116 -116
  187. package/sharing/folder.d.ts +9 -9
  188. package/sharing/folder.js +136 -136
  189. package/sharing/funcs.d.ts +62 -62
  190. package/sharing/funcs.js +239 -239
  191. package/sharing/index.d.ts +5 -5
  192. package/sharing/index.js +5 -5
  193. package/sharing/item.d.ts +16 -16
  194. package/sharing/item.js +15 -15
  195. package/sharing/types.d.ts +583 -583
  196. package/sharing/types.js +113 -113
  197. package/sharing/web.d.ts +19 -19
  198. package/sharing/web.js +76 -76
  199. package/site-designs/index.d.ts +8 -8
  200. package/site-designs/index.js +14 -14
  201. package/site-designs/types.d.ts +319 -319
  202. package/site-designs/types.js +203 -203
  203. package/site-designs/web.d.ts +25 -25
  204. package/site-designs/web.js +11 -11
  205. package/site-groups/index.d.ts +2 -2
  206. package/site-groups/index.js +2 -2
  207. package/site-groups/types.d.ts +89 -89
  208. package/site-groups/types.js +125 -125
  209. package/site-groups/web.d.ts +40 -40
  210. package/site-groups/web.js +30 -30
  211. package/site-scripts/index.d.ts +9 -9
  212. package/site-scripts/index.js +15 -15
  213. package/site-scripts/list.d.ts +12 -12
  214. package/site-scripts/list.js +24 -24
  215. package/site-scripts/types.d.ts +183 -183
  216. package/site-scripts/types.js +141 -141
  217. package/site-scripts/web.d.ts +13 -13
  218. package/site-scripts/web.js +5 -5
  219. package/site-users/index.d.ts +2 -2
  220. package/site-users/index.js +2 -2
  221. package/site-users/types.d.ts +138 -138
  222. package/site-users/types.js +122 -122
  223. package/site-users/web.d.ts +31 -31
  224. package/site-users/web.js +27 -27
  225. package/sites/index.d.ts +7 -7
  226. package/sites/index.js +13 -13
  227. package/sites/types.d.ts +147 -147
  228. package/sites/types.js +321 -321
  229. package/social/index.d.ts +10 -10
  230. package/social/index.js +13 -13
  231. package/social/types.d.ts +309 -309
  232. package/social/types.js +322 -322
  233. package/sphttpclient.d.ts +18 -18
  234. package/sphttpclient.js +189 -189
  235. package/splibconfig.d.ts +22 -22
  236. package/splibconfig.js +13 -13
  237. package/sputilities/index.d.ts +7 -7
  238. package/sputilities/index.js +13 -13
  239. package/sputilities/types.d.ts +130 -130
  240. package/sputilities/types.js +118 -118
  241. package/subscriptions/index.d.ts +2 -2
  242. package/subscriptions/index.js +2 -2
  243. package/subscriptions/list.d.ts +13 -13
  244. package/subscriptions/list.js +4 -4
  245. package/subscriptions/types.d.ts +54 -54
  246. package/subscriptions/types.js +111 -111
  247. package/taxonomy/index.d.ts +7 -7
  248. package/taxonomy/index.js +13 -13
  249. package/taxonomy/types.d.ts +200 -200
  250. package/taxonomy/types.js +347 -347
  251. package/telemetry.d.ts +12 -12
  252. package/telemetry.js +48 -48
  253. package/types.d.ts +218 -218
  254. package/types.js +79 -79
  255. package/user-custom-actions/index.d.ts +4 -4
  256. package/user-custom-actions/index.js +4 -4
  257. package/user-custom-actions/list.d.ts +12 -12
  258. package/user-custom-actions/list.js +4 -4
  259. package/user-custom-actions/site.d.ts +12 -12
  260. package/user-custom-actions/site.js +4 -4
  261. package/user-custom-actions/types.d.ts +82 -82
  262. package/user-custom-actions/types.js +93 -93
  263. package/user-custom-actions/web.d.ts +15 -15
  264. package/user-custom-actions/web.js +4 -4
  265. package/utils/escapeQueryStrValue.d.ts +1 -1
  266. package/utils/escapeQueryStrValue.js +19 -19
  267. package/utils/extractweburl.d.ts +1 -1
  268. package/utils/extractweburl.js +15 -15
  269. package/utils/file-names.d.ts +17 -17
  270. package/utils/file-names.js +38 -38
  271. package/utils/metadata.d.ts +5 -5
  272. package/utils/metadata.js +5 -5
  273. package/utils/objectToSPKeyValueCollection.d.ts +20 -20
  274. package/utils/objectToSPKeyValueCollection.js +16 -16
  275. package/utils/toResourcePath.d.ts +7 -7
  276. package/utils/toResourcePath.js +6 -6
  277. package/utils/toabsoluteurl.d.ts +7 -7
  278. package/utils/toabsoluteurl.js +61 -61
  279. package/views/index.d.ts +2 -2
  280. package/views/index.js +2 -2
  281. package/views/list.d.ts +23 -23
  282. package/views/list.js +8 -8
  283. package/views/types.d.ts +140 -140
  284. package/views/types.js +184 -184
  285. package/webparts/file.d.ts +15 -15
  286. package/webparts/file.js +6 -6
  287. package/webparts/index.d.ts +2 -2
  288. package/webparts/index.js +2 -2
  289. package/webparts/types.d.ts +83 -83
  290. package/webparts/types.js +117 -117
  291. package/webs/index.d.ts +16 -16
  292. package/webs/index.js +16 -16
  293. package/webs/types.d.ts +210 -210
  294. package/webs/types.js +295 -295
package/search/types.js CHANGED
@@ -1,58 +1,58 @@
1
- /**
2
- * defines the SortDirection enum
3
- */
4
- export var SortDirection;
5
- (function (SortDirection) {
6
- SortDirection[SortDirection["Ascending"] = 0] = "Ascending";
7
- SortDirection[SortDirection["Descending"] = 1] = "Descending";
8
- SortDirection[SortDirection["FQLFormula"] = 2] = "FQLFormula";
9
- })(SortDirection || (SortDirection = {}));
10
- /**
11
- * defines the ReorderingRuleMatchType enum
12
- */
13
- export var ReorderingRuleMatchType;
14
- (function (ReorderingRuleMatchType) {
15
- ReorderingRuleMatchType[ReorderingRuleMatchType["ResultContainsKeyword"] = 0] = "ResultContainsKeyword";
16
- ReorderingRuleMatchType[ReorderingRuleMatchType["TitleContainsKeyword"] = 1] = "TitleContainsKeyword";
17
- ReorderingRuleMatchType[ReorderingRuleMatchType["TitleMatchesKeyword"] = 2] = "TitleMatchesKeyword";
18
- ReorderingRuleMatchType[ReorderingRuleMatchType["UrlStartsWith"] = 3] = "UrlStartsWith";
19
- ReorderingRuleMatchType[ReorderingRuleMatchType["UrlExactlyMatches"] = 4] = "UrlExactlyMatches";
20
- ReorderingRuleMatchType[ReorderingRuleMatchType["ContentTypeIs"] = 5] = "ContentTypeIs";
21
- ReorderingRuleMatchType[ReorderingRuleMatchType["FileExtensionMatches"] = 6] = "FileExtensionMatches";
22
- ReorderingRuleMatchType[ReorderingRuleMatchType["ResultHasTag"] = 7] = "ResultHasTag";
23
- ReorderingRuleMatchType[ReorderingRuleMatchType["ManualCondition"] = 8] = "ManualCondition";
24
- })(ReorderingRuleMatchType || (ReorderingRuleMatchType = {}));
25
- /**
26
- * Specifies the type value for the property
27
- */
28
- export var QueryPropertyValueType;
29
- (function (QueryPropertyValueType) {
30
- QueryPropertyValueType[QueryPropertyValueType["None"] = 0] = "None";
31
- QueryPropertyValueType[QueryPropertyValueType["StringType"] = 1] = "StringType";
32
- QueryPropertyValueType[QueryPropertyValueType["Int32Type"] = 2] = "Int32Type";
33
- QueryPropertyValueType[QueryPropertyValueType["BooleanType"] = 3] = "BooleanType";
34
- QueryPropertyValueType[QueryPropertyValueType["StringArrayType"] = 4] = "StringArrayType";
35
- QueryPropertyValueType[QueryPropertyValueType["UnSupportedType"] = 5] = "UnSupportedType";
36
- })(QueryPropertyValueType || (QueryPropertyValueType = {}));
37
- var SearchBuiltInSourceId = /** @class */ (function () {
38
- function SearchBuiltInSourceId() {
39
- }
40
- SearchBuiltInSourceId.Documents = "e7ec8cee-ded8-43c9-beb5-436b54b31e84";
41
- SearchBuiltInSourceId.ItemsMatchingContentType = "5dc9f503-801e-4ced-8a2c-5d1237132419";
42
- SearchBuiltInSourceId.ItemsMatchingTag = "e1327b9c-2b8c-4b23-99c9-3730cb29c3f7";
43
- SearchBuiltInSourceId.ItemsRelatedToCurrentUser = "48fec42e-4a92-48ce-8363-c2703a40e67d";
44
- SearchBuiltInSourceId.ItemsWithSameKeywordAsThisItem = "5c069288-1d17-454a-8ac6-9c642a065f48";
45
- SearchBuiltInSourceId.LocalPeopleResults = "b09a7990-05ea-4af9-81ef-edfab16c4e31";
46
- SearchBuiltInSourceId.LocalReportsAndDataResults = "203fba36-2763-4060-9931-911ac8c0583b";
47
- SearchBuiltInSourceId.LocalSharePointResults = "8413cd39-2156-4e00-b54d-11efd9abdb89";
48
- SearchBuiltInSourceId.LocalVideoResults = "78b793ce-7956-4669-aa3b-451fc5defebf";
49
- SearchBuiltInSourceId.Pages = "5e34578e-4d08-4edc-8bf3-002acf3cdbcc";
50
- SearchBuiltInSourceId.Pictures = "38403c8c-3975-41a8-826e-717f2d41568a";
51
- SearchBuiltInSourceId.Popular = "97c71db1-58ce-4891-8b64-585bc2326c12";
52
- SearchBuiltInSourceId.RecentlyChangedItems = "ba63bbae-fa9c-42c0-b027-9a878f16557c";
53
- SearchBuiltInSourceId.RecommendedItems = "ec675252-14fa-4fbe-84dd-8d098ed74181";
54
- SearchBuiltInSourceId.Wiki = "9479bf85-e257-4318-b5a8-81a180f5faa1";
55
- return SearchBuiltInSourceId;
56
- }());
57
- export { SearchBuiltInSourceId };
1
+ /**
2
+ * defines the SortDirection enum
3
+ */
4
+ export var SortDirection;
5
+ (function (SortDirection) {
6
+ SortDirection[SortDirection["Ascending"] = 0] = "Ascending";
7
+ SortDirection[SortDirection["Descending"] = 1] = "Descending";
8
+ SortDirection[SortDirection["FQLFormula"] = 2] = "FQLFormula";
9
+ })(SortDirection || (SortDirection = {}));
10
+ /**
11
+ * defines the ReorderingRuleMatchType enum
12
+ */
13
+ export var ReorderingRuleMatchType;
14
+ (function (ReorderingRuleMatchType) {
15
+ ReorderingRuleMatchType[ReorderingRuleMatchType["ResultContainsKeyword"] = 0] = "ResultContainsKeyword";
16
+ ReorderingRuleMatchType[ReorderingRuleMatchType["TitleContainsKeyword"] = 1] = "TitleContainsKeyword";
17
+ ReorderingRuleMatchType[ReorderingRuleMatchType["TitleMatchesKeyword"] = 2] = "TitleMatchesKeyword";
18
+ ReorderingRuleMatchType[ReorderingRuleMatchType["UrlStartsWith"] = 3] = "UrlStartsWith";
19
+ ReorderingRuleMatchType[ReorderingRuleMatchType["UrlExactlyMatches"] = 4] = "UrlExactlyMatches";
20
+ ReorderingRuleMatchType[ReorderingRuleMatchType["ContentTypeIs"] = 5] = "ContentTypeIs";
21
+ ReorderingRuleMatchType[ReorderingRuleMatchType["FileExtensionMatches"] = 6] = "FileExtensionMatches";
22
+ ReorderingRuleMatchType[ReorderingRuleMatchType["ResultHasTag"] = 7] = "ResultHasTag";
23
+ ReorderingRuleMatchType[ReorderingRuleMatchType["ManualCondition"] = 8] = "ManualCondition";
24
+ })(ReorderingRuleMatchType || (ReorderingRuleMatchType = {}));
25
+ /**
26
+ * Specifies the type value for the property
27
+ */
28
+ export var QueryPropertyValueType;
29
+ (function (QueryPropertyValueType) {
30
+ QueryPropertyValueType[QueryPropertyValueType["None"] = 0] = "None";
31
+ QueryPropertyValueType[QueryPropertyValueType["StringType"] = 1] = "StringType";
32
+ QueryPropertyValueType[QueryPropertyValueType["Int32Type"] = 2] = "Int32Type";
33
+ QueryPropertyValueType[QueryPropertyValueType["BooleanType"] = 3] = "BooleanType";
34
+ QueryPropertyValueType[QueryPropertyValueType["StringArrayType"] = 4] = "StringArrayType";
35
+ QueryPropertyValueType[QueryPropertyValueType["UnSupportedType"] = 5] = "UnSupportedType";
36
+ })(QueryPropertyValueType || (QueryPropertyValueType = {}));
37
+ var SearchBuiltInSourceId = /** @class */ (function () {
38
+ function SearchBuiltInSourceId() {
39
+ }
40
+ SearchBuiltInSourceId.Documents = "e7ec8cee-ded8-43c9-beb5-436b54b31e84";
41
+ SearchBuiltInSourceId.ItemsMatchingContentType = "5dc9f503-801e-4ced-8a2c-5d1237132419";
42
+ SearchBuiltInSourceId.ItemsMatchingTag = "e1327b9c-2b8c-4b23-99c9-3730cb29c3f7";
43
+ SearchBuiltInSourceId.ItemsRelatedToCurrentUser = "48fec42e-4a92-48ce-8363-c2703a40e67d";
44
+ SearchBuiltInSourceId.ItemsWithSameKeywordAsThisItem = "5c069288-1d17-454a-8ac6-9c642a065f48";
45
+ SearchBuiltInSourceId.LocalPeopleResults = "b09a7990-05ea-4af9-81ef-edfab16c4e31";
46
+ SearchBuiltInSourceId.LocalReportsAndDataResults = "203fba36-2763-4060-9931-911ac8c0583b";
47
+ SearchBuiltInSourceId.LocalSharePointResults = "8413cd39-2156-4e00-b54d-11efd9abdb89";
48
+ SearchBuiltInSourceId.LocalVideoResults = "78b793ce-7956-4669-aa3b-451fc5defebf";
49
+ SearchBuiltInSourceId.Pages = "5e34578e-4d08-4edc-8bf3-002acf3cdbcc";
50
+ SearchBuiltInSourceId.Pictures = "38403c8c-3975-41a8-826e-717f2d41568a";
51
+ SearchBuiltInSourceId.Popular = "97c71db1-58ce-4891-8b64-585bc2326c12";
52
+ SearchBuiltInSourceId.RecentlyChangedItems = "ba63bbae-fa9c-42c0-b027-9a878f16557c";
53
+ SearchBuiltInSourceId.RecommendedItems = "ec675252-14fa-4fbe-84dd-8d098ed74181";
54
+ SearchBuiltInSourceId.Wiki = "9479bf85-e257-4318-b5a8-81a180f5faa1";
55
+ return SearchBuiltInSourceId;
56
+ }());
57
+ export { SearchBuiltInSourceId };
58
58
  //# sourceMappingURL=types.js.map
@@ -1,44 +1,44 @@
1
- import { SecurableQueryable, IBasePermissions, PermissionKind } from "./types.js";
2
- /**
3
- * Gets the effective permissions for the user supplied
4
- *
5
- * @param loginName The claims username for the user (ex: i:0#.f|membership|user@domain.com)
6
- */
7
- export declare function getUserEffectivePermissions(this: SecurableQueryable, loginName: string): Promise<IBasePermissions>;
8
- /**
9
- * Gets the effective permissions for the current user
10
- */
11
- export declare function getCurrentUserEffectivePermissions(this: SecurableQueryable): Promise<IBasePermissions>;
12
- /**
13
- * Breaks the security inheritance at this level optinally copying permissions and clearing subscopes
14
- *
15
- * @param copyRoleAssignments If true the permissions are copied from the current parent scope
16
- * @param clearSubscopes Optional. true to make all child securable objects inherit role assignments from the current object
17
- */
18
- export declare function breakRoleInheritance(this: SecurableQueryable, copyRoleAssignments?: boolean, clearSubscopes?: boolean): Promise<void>;
19
- /**
20
- * Removes the local role assignments so that it re-inherit role assignments from the parent object.
21
- *
22
- */
23
- export declare function resetRoleInheritance(this: SecurableQueryable): Promise<void>;
24
- /**
25
- * Determines if a given user has the appropriate permissions
26
- *
27
- * @param loginName The user to check
28
- * @param permission The permission being checked
29
- */
30
- export declare function userHasPermissions(this: SecurableQueryable, loginName: string, permission: PermissionKind): Promise<boolean>;
31
- /**
32
- * Determines if the current user has the requested permissions
33
- *
34
- * @param permission The permission we wish to check
35
- */
36
- export declare function currentUserHasPermissions(this: SecurableQueryable, permission: PermissionKind): Promise<boolean>;
37
- /**
38
- * Taken from sp.js, checks the supplied permissions against the mask
39
- *
40
- * @param value The security principal's permissions on the given object
41
- * @param perm The permission checked against the value
42
- */
43
- export declare function hasPermissions(value: IBasePermissions, perm: PermissionKind): boolean;
1
+ import { SecurableQueryable, IBasePermissions, PermissionKind } from "./types.js";
2
+ /**
3
+ * Gets the effective permissions for the user supplied
4
+ *
5
+ * @param loginName The claims username for the user (ex: i:0#.f|membership|user@domain.com)
6
+ */
7
+ export declare function getUserEffectivePermissions(this: SecurableQueryable, loginName: string): Promise<IBasePermissions>;
8
+ /**
9
+ * Gets the effective permissions for the current user
10
+ */
11
+ export declare function getCurrentUserEffectivePermissions(this: SecurableQueryable): Promise<IBasePermissions>;
12
+ /**
13
+ * Breaks the security inheritance at this level optinally copying permissions and clearing subscopes
14
+ *
15
+ * @param copyRoleAssignments If true the permissions are copied from the current parent scope
16
+ * @param clearSubscopes Optional. true to make all child securable objects inherit role assignments from the current object
17
+ */
18
+ export declare function breakRoleInheritance(this: SecurableQueryable, copyRoleAssignments?: boolean, clearSubscopes?: boolean): Promise<void>;
19
+ /**
20
+ * Removes the local role assignments so that it re-inherit role assignments from the parent object.
21
+ *
22
+ */
23
+ export declare function resetRoleInheritance(this: SecurableQueryable): Promise<void>;
24
+ /**
25
+ * Determines if a given user has the appropriate permissions
26
+ *
27
+ * @param loginName The user to check
28
+ * @param permission The permission being checked
29
+ */
30
+ export declare function userHasPermissions(this: SecurableQueryable, loginName: string, permission: PermissionKind): Promise<boolean>;
31
+ /**
32
+ * Determines if the current user has the requested permissions
33
+ *
34
+ * @param permission The permission we wish to check
35
+ */
36
+ export declare function currentUserHasPermissions(this: SecurableQueryable, permission: PermissionKind): Promise<boolean>;
37
+ /**
38
+ * Taken from sp.js, checks the supplied permissions against the mask
39
+ *
40
+ * @param value The security principal's permissions on the given object
41
+ * @param perm The permission checked against the value
42
+ */
43
+ export declare function hasPermissions(value: IBasePermissions, perm: PermissionKind): boolean;
44
44
  //# sourceMappingURL=funcs.d.ts.map
package/security/funcs.js CHANGED
@@ -1,143 +1,143 @@
1
- import { __awaiter, __generator } from "tslib";
2
- import { PermissionKind } from "./types.js";
3
- import { SharePointQueryableInstance, SharePointQueryable } from "../sharepointqueryable.js";
4
- import { hOP } from "@pnp/common";
5
- import { spPost } from "../operations.js";
6
- /**
7
- * Gets the effective permissions for the user supplied
8
- *
9
- * @param loginName The claims username for the user (ex: i:0#.f|membership|user@domain.com)
10
- */
11
- export function getUserEffectivePermissions(loginName) {
12
- return __awaiter(this, void 0, void 0, function () {
13
- var q, r;
14
- return __generator(this, function (_a) {
15
- switch (_a.label) {
16
- case 0:
17
- q = this.clone(SharePointQueryableInstance, "getUserEffectivePermissions(@user)");
18
- q.query.set("@user", "'" + encodeURIComponent(loginName) + "'");
19
- return [4 /*yield*/, q.get()];
20
- case 1:
21
- r = _a.sent();
22
- // handle verbose mode
23
- return [2 /*return*/, hOP(r, "GetUserEffectivePermissions") ? r.GetUserEffectivePermissions : r];
24
- }
25
- });
26
- });
27
- }
28
- /**
29
- * Gets the effective permissions for the current user
30
- */
31
- export function getCurrentUserEffectivePermissions() {
32
- return __awaiter(this, void 0, void 0, function () {
33
- var q;
34
- return __generator(this, function (_a) {
35
- q = this.clone(SharePointQueryable, "EffectiveBasePermissions");
36
- return [2 /*return*/, q.get().then(function (r) {
37
- // handle verbose mode
38
- return hOP(r, "EffectiveBasePermissions") ? r.EffectiveBasePermissions : r;
39
- })];
40
- });
41
- });
42
- }
43
- /**
44
- * Breaks the security inheritance at this level optinally copying permissions and clearing subscopes
45
- *
46
- * @param copyRoleAssignments If true the permissions are copied from the current parent scope
47
- * @param clearSubscopes Optional. true to make all child securable objects inherit role assignments from the current object
48
- */
49
- export function breakRoleInheritance(copyRoleAssignments, clearSubscopes) {
50
- if (copyRoleAssignments === void 0) { copyRoleAssignments = false; }
51
- if (clearSubscopes === void 0) { clearSubscopes = false; }
52
- return __awaiter(this, void 0, void 0, function () {
53
- return __generator(this, function (_a) {
54
- switch (_a.label) {
55
- case 0: return [4 /*yield*/, spPost(this.clone(SharePointQueryable, "breakroleinheritance(copyroleassignments=" + copyRoleAssignments + ", clearsubscopes=" + clearSubscopes + ")"))];
56
- case 1:
57
- _a.sent();
58
- return [2 /*return*/];
59
- }
60
- });
61
- });
62
- }
63
- /**
64
- * Removes the local role assignments so that it re-inherit role assignments from the parent object.
65
- *
66
- */
67
- export function resetRoleInheritance() {
68
- return __awaiter(this, void 0, void 0, function () {
69
- return __generator(this, function (_a) {
70
- switch (_a.label) {
71
- case 0: return [4 /*yield*/, spPost(this.clone(SharePointQueryable, "resetroleinheritance"))];
72
- case 1:
73
- _a.sent();
74
- return [2 /*return*/];
75
- }
76
- });
77
- });
78
- }
79
- /**
80
- * Determines if a given user has the appropriate permissions
81
- *
82
- * @param loginName The user to check
83
- * @param permission The permission being checked
84
- */
85
- export function userHasPermissions(loginName, permission) {
86
- return __awaiter(this, void 0, void 0, function () {
87
- var perms;
88
- return __generator(this, function (_a) {
89
- switch (_a.label) {
90
- case 0: return [4 /*yield*/, getUserEffectivePermissions.call(this, loginName)];
91
- case 1:
92
- perms = _a.sent();
93
- return [2 /*return*/, this.hasPermissions(perms, permission)];
94
- }
95
- });
96
- });
97
- }
98
- /**
99
- * Determines if the current user has the requested permissions
100
- *
101
- * @param permission The permission we wish to check
102
- */
103
- export function currentUserHasPermissions(permission) {
104
- return __awaiter(this, void 0, void 0, function () {
105
- var perms;
106
- return __generator(this, function (_a) {
107
- switch (_a.label) {
108
- case 0: return [4 /*yield*/, getCurrentUserEffectivePermissions.call(this)];
109
- case 1:
110
- perms = _a.sent();
111
- return [2 /*return*/, this.hasPermissions(perms, permission)];
112
- }
113
- });
114
- });
115
- }
116
- /**
117
- * Taken from sp.js, checks the supplied permissions against the mask
118
- *
119
- * @param value The security principal's permissions on the given object
120
- * @param perm The permission checked against the value
121
- */
122
- /* eslint-disable no-bitwise */
123
- export function hasPermissions(value, perm) {
124
- if (!perm) {
125
- return true;
126
- }
127
- if (perm === PermissionKind.FullMask) {
128
- return (value.High & 32767) === 32767 && value.Low === 65535;
129
- }
130
- perm = perm - 1;
131
- var num = 1;
132
- if (perm >= 0 && perm < 32) {
133
- num = num << perm;
134
- return 0 !== (value.Low & num);
135
- }
136
- else if (perm >= 32 && perm < 64) {
137
- num = num << perm - 32;
138
- return 0 !== (value.High & num);
139
- }
140
- return false;
141
- }
142
- /* eslint-enable no-bitwise */
1
+ import { __awaiter, __generator } from "tslib";
2
+ import { PermissionKind } from "./types.js";
3
+ import { SharePointQueryableInstance, SharePointQueryable } from "../sharepointqueryable.js";
4
+ import { hOP } from "@pnp/common";
5
+ import { spPost } from "../operations.js";
6
+ /**
7
+ * Gets the effective permissions for the user supplied
8
+ *
9
+ * @param loginName The claims username for the user (ex: i:0#.f|membership|user@domain.com)
10
+ */
11
+ export function getUserEffectivePermissions(loginName) {
12
+ return __awaiter(this, void 0, void 0, function () {
13
+ var q, r;
14
+ return __generator(this, function (_a) {
15
+ switch (_a.label) {
16
+ case 0:
17
+ q = this.clone(SharePointQueryableInstance, "getUserEffectivePermissions(@user)");
18
+ q.query.set("@user", "'" + encodeURIComponent(loginName) + "'");
19
+ return [4 /*yield*/, q.get()];
20
+ case 1:
21
+ r = _a.sent();
22
+ // handle verbose mode
23
+ return [2 /*return*/, hOP(r, "GetUserEffectivePermissions") ? r.GetUserEffectivePermissions : r];
24
+ }
25
+ });
26
+ });
27
+ }
28
+ /**
29
+ * Gets the effective permissions for the current user
30
+ */
31
+ export function getCurrentUserEffectivePermissions() {
32
+ return __awaiter(this, void 0, void 0, function () {
33
+ var q;
34
+ return __generator(this, function (_a) {
35
+ q = this.clone(SharePointQueryable, "EffectiveBasePermissions");
36
+ return [2 /*return*/, q.get().then(function (r) {
37
+ // handle verbose mode
38
+ return hOP(r, "EffectiveBasePermissions") ? r.EffectiveBasePermissions : r;
39
+ })];
40
+ });
41
+ });
42
+ }
43
+ /**
44
+ * Breaks the security inheritance at this level optinally copying permissions and clearing subscopes
45
+ *
46
+ * @param copyRoleAssignments If true the permissions are copied from the current parent scope
47
+ * @param clearSubscopes Optional. true to make all child securable objects inherit role assignments from the current object
48
+ */
49
+ export function breakRoleInheritance(copyRoleAssignments, clearSubscopes) {
50
+ if (copyRoleAssignments === void 0) { copyRoleAssignments = false; }
51
+ if (clearSubscopes === void 0) { clearSubscopes = false; }
52
+ return __awaiter(this, void 0, void 0, function () {
53
+ return __generator(this, function (_a) {
54
+ switch (_a.label) {
55
+ case 0: return [4 /*yield*/, spPost(this.clone(SharePointQueryable, "breakroleinheritance(copyroleassignments=" + copyRoleAssignments + ", clearsubscopes=" + clearSubscopes + ")"))];
56
+ case 1:
57
+ _a.sent();
58
+ return [2 /*return*/];
59
+ }
60
+ });
61
+ });
62
+ }
63
+ /**
64
+ * Removes the local role assignments so that it re-inherit role assignments from the parent object.
65
+ *
66
+ */
67
+ export function resetRoleInheritance() {
68
+ return __awaiter(this, void 0, void 0, function () {
69
+ return __generator(this, function (_a) {
70
+ switch (_a.label) {
71
+ case 0: return [4 /*yield*/, spPost(this.clone(SharePointQueryable, "resetroleinheritance"))];
72
+ case 1:
73
+ _a.sent();
74
+ return [2 /*return*/];
75
+ }
76
+ });
77
+ });
78
+ }
79
+ /**
80
+ * Determines if a given user has the appropriate permissions
81
+ *
82
+ * @param loginName The user to check
83
+ * @param permission The permission being checked
84
+ */
85
+ export function userHasPermissions(loginName, permission) {
86
+ return __awaiter(this, void 0, void 0, function () {
87
+ var perms;
88
+ return __generator(this, function (_a) {
89
+ switch (_a.label) {
90
+ case 0: return [4 /*yield*/, getUserEffectivePermissions.call(this, loginName)];
91
+ case 1:
92
+ perms = _a.sent();
93
+ return [2 /*return*/, this.hasPermissions(perms, permission)];
94
+ }
95
+ });
96
+ });
97
+ }
98
+ /**
99
+ * Determines if the current user has the requested permissions
100
+ *
101
+ * @param permission The permission we wish to check
102
+ */
103
+ export function currentUserHasPermissions(permission) {
104
+ return __awaiter(this, void 0, void 0, function () {
105
+ var perms;
106
+ return __generator(this, function (_a) {
107
+ switch (_a.label) {
108
+ case 0: return [4 /*yield*/, getCurrentUserEffectivePermissions.call(this)];
109
+ case 1:
110
+ perms = _a.sent();
111
+ return [2 /*return*/, this.hasPermissions(perms, permission)];
112
+ }
113
+ });
114
+ });
115
+ }
116
+ /**
117
+ * Taken from sp.js, checks the supplied permissions against the mask
118
+ *
119
+ * @param value The security principal's permissions on the given object
120
+ * @param perm The permission checked against the value
121
+ */
122
+ /* eslint-disable no-bitwise */
123
+ export function hasPermissions(value, perm) {
124
+ if (!perm) {
125
+ return true;
126
+ }
127
+ if (perm === PermissionKind.FullMask) {
128
+ return (value.High & 32767) === 32767 && value.Low === 65535;
129
+ }
130
+ perm = perm - 1;
131
+ var num = 1;
132
+ if (perm >= 0 && perm < 32) {
133
+ num = num << perm;
134
+ return 0 !== (value.Low & num);
135
+ }
136
+ else if (perm >= 32 && perm < 64) {
137
+ num = num << perm - 32;
138
+ return 0 !== (value.High & num);
139
+ }
140
+ return false;
141
+ }
142
+ /* eslint-enable no-bitwise */
143
143
  //# sourceMappingURL=funcs.js.map
@@ -1,5 +1,5 @@
1
- import "./item.js";
2
- import "./list.js";
3
- import "./web.js";
4
- export { IRoleDefinitions, IRoleDefinition, IRoleAssignment, IRoleAssignments, IRoleDefinitionAddResult, IRoleDefinitionUpdateResult, RoleAssignment, RoleAssignments, RoleDefinition, RoleDefinitions, IBasePermissions, PermissionKind, SecurableQueryable, IRoleAssignmentInfo, IRoleDefinitionInfo, } from "./types.js";
1
+ import "./item.js";
2
+ import "./list.js";
3
+ import "./web.js";
4
+ export { IRoleDefinitions, IRoleDefinition, IRoleAssignment, IRoleAssignments, IRoleDefinitionAddResult, IRoleDefinitionUpdateResult, RoleAssignment, RoleAssignments, RoleDefinition, RoleDefinitions, IBasePermissions, PermissionKind, SecurableQueryable, IRoleAssignmentInfo, IRoleDefinitionInfo, } from "./types.js";
5
5
  //# sourceMappingURL=index.d.ts.map
package/security/index.js CHANGED
@@ -1,5 +1,5 @@
1
- import "./item.js";
2
- import "./list.js";
3
- import "./web.js";
4
- export { RoleAssignment, RoleAssignments, RoleDefinition, RoleDefinitions, PermissionKind, } from "./types.js";
1
+ import "./item.js";
2
+ import "./list.js";
3
+ import "./web.js";
4
+ export { RoleAssignment, RoleAssignments, RoleDefinition, RoleDefinitions, PermissionKind, } from "./types.js";
5
5
  //# sourceMappingURL=index.js.map
@@ -1,8 +1,8 @@
1
- import { ISecurableMethods } from "./types.js";
2
- declare module "../items/types" {
3
- interface _Item extends ISecurableMethods {
4
- }
5
- interface IItem extends ISecurableMethods {
6
- }
7
- }
1
+ import { ISecurableMethods } from "./types.js";
2
+ declare module "../items/types" {
3
+ interface _Item extends ISecurableMethods {
4
+ }
5
+ interface IItem extends ISecurableMethods {
6
+ }
7
+ }
8
8
  //# sourceMappingURL=item.d.ts.map
package/security/item.js CHANGED
@@ -1,15 +1,15 @@
1
- import { addProp } from "@pnp/odata";
2
- import { _Item } from "../items/types.js";
3
- import { RoleAssignments } from "./types.js";
4
- import { SharePointQueryableInstance } from "../sharepointqueryable.js";
5
- import { getUserEffectivePermissions, getCurrentUserEffectivePermissions, breakRoleInheritance, resetRoleInheritance, userHasPermissions, currentUserHasPermissions, hasPermissions, } from "./funcs.js";
6
- addProp(_Item, "roleAssignments", RoleAssignments);
7
- addProp(_Item, "firstUniqueAncestorSecurableObject", SharePointQueryableInstance);
8
- _Item.prototype.getUserEffectivePermissions = getUserEffectivePermissions;
9
- _Item.prototype.getCurrentUserEffectivePermissions = getCurrentUserEffectivePermissions;
10
- _Item.prototype.breakRoleInheritance = breakRoleInheritance;
11
- _Item.prototype.resetRoleInheritance = resetRoleInheritance;
12
- _Item.prototype.userHasPermissions = userHasPermissions;
13
- _Item.prototype.currentUserHasPermissions = currentUserHasPermissions;
14
- _Item.prototype.hasPermissions = hasPermissions;
1
+ import { addProp } from "@pnp/odata";
2
+ import { _Item } from "../items/types.js";
3
+ import { RoleAssignments } from "./types.js";
4
+ import { SharePointQueryableInstance } from "../sharepointqueryable.js";
5
+ import { getUserEffectivePermissions, getCurrentUserEffectivePermissions, breakRoleInheritance, resetRoleInheritance, userHasPermissions, currentUserHasPermissions, hasPermissions, } from "./funcs.js";
6
+ addProp(_Item, "roleAssignments", RoleAssignments);
7
+ addProp(_Item, "firstUniqueAncestorSecurableObject", SharePointQueryableInstance);
8
+ _Item.prototype.getUserEffectivePermissions = getUserEffectivePermissions;
9
+ _Item.prototype.getCurrentUserEffectivePermissions = getCurrentUserEffectivePermissions;
10
+ _Item.prototype.breakRoleInheritance = breakRoleInheritance;
11
+ _Item.prototype.resetRoleInheritance = resetRoleInheritance;
12
+ _Item.prototype.userHasPermissions = userHasPermissions;
13
+ _Item.prototype.currentUserHasPermissions = currentUserHasPermissions;
14
+ _Item.prototype.hasPermissions = hasPermissions;
15
15
  //# sourceMappingURL=item.js.map
@@ -1,8 +1,8 @@
1
- import { ISecurableMethods } from "./types.js";
2
- declare module "../lists/types" {
3
- interface _List extends ISecurableMethods {
4
- }
5
- interface IList extends ISecurableMethods {
6
- }
7
- }
1
+ import { ISecurableMethods } from "./types.js";
2
+ declare module "../lists/types" {
3
+ interface _List extends ISecurableMethods {
4
+ }
5
+ interface IList extends ISecurableMethods {
6
+ }
7
+ }
8
8
  //# sourceMappingURL=list.d.ts.map
package/security/list.js CHANGED
@@ -1,15 +1,15 @@
1
- import { addProp } from "@pnp/odata";
2
- import { _List } from "../lists/types.js";
3
- import { RoleAssignments } from "./types.js";
4
- import { SharePointQueryableInstance } from "../sharepointqueryable.js";
5
- import { getUserEffectivePermissions, getCurrentUserEffectivePermissions, breakRoleInheritance, resetRoleInheritance, userHasPermissions, currentUserHasPermissions, hasPermissions, } from "./funcs.js";
6
- addProp(_List, "roleAssignments", RoleAssignments);
7
- addProp(_List, "firstUniqueAncestorSecurableObject", SharePointQueryableInstance);
8
- _List.prototype.getUserEffectivePermissions = getUserEffectivePermissions;
9
- _List.prototype.getCurrentUserEffectivePermissions = getCurrentUserEffectivePermissions;
10
- _List.prototype.breakRoleInheritance = breakRoleInheritance;
11
- _List.prototype.resetRoleInheritance = resetRoleInheritance;
12
- _List.prototype.userHasPermissions = userHasPermissions;
13
- _List.prototype.currentUserHasPermissions = currentUserHasPermissions;
14
- _List.prototype.hasPermissions = hasPermissions;
1
+ import { addProp } from "@pnp/odata";
2
+ import { _List } from "../lists/types.js";
3
+ import { RoleAssignments } from "./types.js";
4
+ import { SharePointQueryableInstance } from "../sharepointqueryable.js";
5
+ import { getUserEffectivePermissions, getCurrentUserEffectivePermissions, breakRoleInheritance, resetRoleInheritance, userHasPermissions, currentUserHasPermissions, hasPermissions, } from "./funcs.js";
6
+ addProp(_List, "roleAssignments", RoleAssignments);
7
+ addProp(_List, "firstUniqueAncestorSecurableObject", SharePointQueryableInstance);
8
+ _List.prototype.getUserEffectivePermissions = getUserEffectivePermissions;
9
+ _List.prototype.getCurrentUserEffectivePermissions = getCurrentUserEffectivePermissions;
10
+ _List.prototype.breakRoleInheritance = breakRoleInheritance;
11
+ _List.prototype.resetRoleInheritance = resetRoleInheritance;
12
+ _List.prototype.userHasPermissions = userHasPermissions;
13
+ _List.prototype.currentUserHasPermissions = currentUserHasPermissions;
14
+ _List.prototype.hasPermissions = hasPermissions;
15
15
  //# sourceMappingURL=list.js.map