@pnp/sp 2.8.0 → 2.12.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 (306) 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.d.ts.map +1 -1
  6. package/appcatalog/types.js +177 -177
  7. package/appcatalog/types.js.map +1 -1
  8. package/appcatalog/web.d.ts +16 -16
  9. package/appcatalog/web.js +6 -6
  10. package/attachments/index.d.ts +2 -2
  11. package/attachments/index.js +2 -2
  12. package/attachments/item.d.ts +12 -12
  13. package/attachments/item.js +4 -4
  14. package/attachments/types.d.ts +92 -92
  15. package/attachments/types.js +240 -240
  16. package/batch.d.ts +17 -17
  17. package/batch.js +223 -223
  18. package/clientside-pages/funcs.d.ts +22 -22
  19. package/clientside-pages/funcs.js +25 -25
  20. package/clientside-pages/index.d.ts +2 -2
  21. package/clientside-pages/index.js +2 -2
  22. package/clientside-pages/types.d.ts +496 -494
  23. package/clientside-pages/types.d.ts.map +1 -1
  24. package/clientside-pages/types.js +1496 -1487
  25. package/clientside-pages/types.js.map +1 -1
  26. package/clientside-pages/web.d.ts +41 -41
  27. package/clientside-pages/web.js +57 -57
  28. package/column-defaults/folder.d.ts +27 -27
  29. package/column-defaults/folder.js +82 -82
  30. package/column-defaults/index.d.ts +3 -3
  31. package/column-defaults/index.js +2 -2
  32. package/column-defaults/list.d.ts +19 -19
  33. package/column-defaults/list.js +198 -198
  34. package/column-defaults/types.d.ts +21 -21
  35. package/column-defaults/types.js +1 -1
  36. package/comments/clientside-page.d.ts +57 -57
  37. package/comments/clientside-page.d.ts.map +1 -1
  38. package/comments/clientside-page.js +136 -136
  39. package/comments/index.d.ts +2 -2
  40. package/comments/index.js +2 -2
  41. package/comments/item.d.ts +29 -29
  42. package/comments/item.js +47 -47
  43. package/comments/item.js.map +1 -1
  44. package/comments/types.d.ts +107 -107
  45. package/comments/types.d.ts.map +1 -1
  46. package/comments/types.js +145 -145
  47. package/comments/types.js.map +1 -1
  48. package/content-types/index.d.ts +4 -4
  49. package/content-types/index.js +4 -4
  50. package/content-types/item.d.ts +12 -12
  51. package/content-types/item.js +4 -4
  52. package/content-types/list.d.ts +12 -12
  53. package/content-types/list.js +4 -4
  54. package/content-types/types.d.ts +107 -107
  55. package/content-types/types.js +166 -166
  56. package/content-types/web.d.ts +12 -12
  57. package/content-types/web.js +4 -4
  58. package/decorators.d.ts +11 -11
  59. package/decorators.js +28 -28
  60. package/features/index.d.ts +3 -3
  61. package/features/index.js +3 -3
  62. package/features/site.d.ts +12 -12
  63. package/features/site.js +4 -4
  64. package/features/types.d.ts +47 -47
  65. package/features/types.js +109 -109
  66. package/features/web.d.ts +12 -12
  67. package/features/web.js +4 -4
  68. package/fields/index.d.ts +4 -4
  69. package/fields/index.js +4 -4
  70. package/fields/list.d.ts +12 -12
  71. package/fields/list.js +4 -4
  72. package/fields/types.d.ts +368 -368
  73. package/fields/types.js +624 -624
  74. package/fields/web.d.ts +17 -17
  75. package/fields/web.js +5 -5
  76. package/files/folder.d.ts +12 -12
  77. package/files/folder.js +4 -4
  78. package/files/index.d.ts +4 -4
  79. package/files/index.js +4 -4
  80. package/files/item.d.ts +12 -12
  81. package/files/item.js +4 -4
  82. package/files/types.d.ts +421 -421
  83. package/files/types.js +853 -853
  84. package/files/types.js.map +1 -1
  85. package/files/web.d.ts +35 -35
  86. package/files/web.js +15 -15
  87. package/folders/index.d.ts +4 -4
  88. package/folders/index.js +4 -4
  89. package/folders/item.d.ts +9 -9
  90. package/folders/item.js +4 -4
  91. package/folders/list.d.ts +12 -12
  92. package/folders/list.js +4 -4
  93. package/folders/types.d.ts +207 -207
  94. package/folders/types.js +433 -433
  95. package/folders/types.js.map +1 -1
  96. package/folders/web.d.ts +39 -39
  97. package/folders/web.js +15 -15
  98. package/forms/index.d.ts +2 -2
  99. package/forms/index.js +2 -2
  100. package/forms/list.d.ts +9 -9
  101. package/forms/list.js +4 -4
  102. package/forms/types.d.ts +35 -35
  103. package/forms/types.js +41 -41
  104. package/hubsites/index.d.ts +12 -12
  105. package/hubsites/index.js +15 -15
  106. package/hubsites/site.d.ts +26 -26
  107. package/hubsites/site.js +39 -39
  108. package/hubsites/types.d.ts +55 -55
  109. package/hubsites/types.d.ts.map +1 -1
  110. package/hubsites/types.js +53 -53
  111. package/hubsites/web.d.ts +21 -21
  112. package/hubsites/web.js +23 -23
  113. package/index.d.ts +14 -14
  114. package/index.js +13 -13
  115. package/items/index.d.ts +2 -2
  116. package/items/index.js +2 -2
  117. package/items/list.d.ts +9 -9
  118. package/items/list.js +4 -4
  119. package/items/types.d.ts +226 -226
  120. package/items/types.js +549 -549
  121. package/lists/index.d.ts +2 -2
  122. package/lists/index.js +2 -2
  123. package/lists/types.d.ts +495 -495
  124. package/lists/types.js +522 -522
  125. package/lists/types.js.map +1 -1
  126. package/lists/web.d.ts +43 -43
  127. package/lists/web.js +27 -27
  128. package/navigation/index.d.ts +8 -8
  129. package/navigation/index.js +14 -14
  130. package/navigation/types.d.ts +154 -154
  131. package/navigation/types.js +219 -219
  132. package/navigation/web.d.ts +13 -13
  133. package/navigation/web.js +4 -4
  134. package/odata.d.ts +5 -5
  135. package/odata.js +90 -90
  136. package/odata.js.map +1 -1
  137. package/operations.d.ts +9 -9
  138. package/operations.js +63 -63
  139. package/package.json +4 -4
  140. package/presets/all.d.ts +72 -72
  141. package/presets/all.js +72 -72
  142. package/presets/core.d.ts +11 -11
  143. package/presets/core.js +11 -11
  144. package/profiles/index.d.ts +7 -7
  145. package/profiles/index.js +13 -13
  146. package/profiles/types.d.ts +357 -357
  147. package/profiles/types.js +454 -454
  148. package/readme.md +21 -21
  149. package/regional-settings/content-type.d.ts +7 -7
  150. package/regional-settings/content-type.js +4 -4
  151. package/regional-settings/field.d.ts +7 -7
  152. package/regional-settings/field.js +4 -4
  153. package/regional-settings/funcs.d.ts +2 -2
  154. package/regional-settings/funcs.js +8 -8
  155. package/regional-settings/index.d.ts +6 -6
  156. package/regional-settings/index.js +6 -6
  157. package/regional-settings/list.d.ts +7 -7
  158. package/regional-settings/list.js +4 -4
  159. package/regional-settings/types.d.ts +111 -111
  160. package/regional-settings/types.js +159 -159
  161. package/regional-settings/user-custom-actions.d.ts +7 -7
  162. package/regional-settings/user-custom-actions.js +4 -4
  163. package/regional-settings/web.d.ts +12 -12
  164. package/regional-settings/web.js +7 -7
  165. package/related-items/index.d.ts +1 -1
  166. package/related-items/index.js +1 -1
  167. package/related-items/types.d.ts +76 -76
  168. package/related-items/types.js +103 -103
  169. package/related-items/web.d.ts +12 -12
  170. package/related-items/web.js +9 -9
  171. package/rest.d.ts +44 -44
  172. package/rest.js +72 -72
  173. package/search/index.d.ts +30 -30
  174. package/search/index.js +25 -25
  175. package/search/query.d.ts +62 -62
  176. package/search/query.js +302 -302
  177. package/search/suggest.d.ts +76 -76
  178. package/search/suggest.js +66 -66
  179. package/search/types.d.ts +426 -426
  180. package/search/types.js +57 -57
  181. package/security/funcs.d.ts +43 -43
  182. package/security/funcs.js +142 -142
  183. package/security/index.d.ts +4 -4
  184. package/security/index.js +4 -4
  185. package/security/item.d.ts +7 -7
  186. package/security/item.js +14 -14
  187. package/security/list.d.ts +7 -7
  188. package/security/list.js +14 -14
  189. package/security/types.d.ts +318 -318
  190. package/security/types.js +399 -399
  191. package/security/web.d.ts +9 -9
  192. package/security/web.js +15 -15
  193. package/sharepointqueryable.d.ts +135 -135
  194. package/sharepointqueryable.js +265 -265
  195. package/sharing/file.d.ts +18 -18
  196. package/sharing/file.js +116 -116
  197. package/sharing/folder.d.ts +9 -9
  198. package/sharing/folder.js +136 -136
  199. package/sharing/funcs.d.ts +62 -62
  200. package/sharing/funcs.js +239 -239
  201. package/sharing/funcs.js.map +1 -1
  202. package/sharing/index.d.ts +5 -5
  203. package/sharing/index.js +5 -5
  204. package/sharing/item.d.ts +16 -16
  205. package/sharing/item.js +15 -15
  206. package/sharing/types.d.ts +583 -583
  207. package/sharing/types.js +113 -113
  208. package/sharing/web.d.ts +19 -19
  209. package/sharing/web.js +76 -76
  210. package/site-designs/index.d.ts +8 -8
  211. package/site-designs/index.js +14 -14
  212. package/site-designs/types.d.ts +319 -319
  213. package/site-designs/types.js +203 -203
  214. package/site-designs/web.d.ts +25 -25
  215. package/site-designs/web.js +11 -11
  216. package/site-groups/index.d.ts +2 -2
  217. package/site-groups/index.js +2 -2
  218. package/site-groups/types.d.ts +89 -89
  219. package/site-groups/types.js +125 -125
  220. package/site-groups/web.d.ts +40 -40
  221. package/site-groups/web.js +30 -30
  222. package/site-scripts/index.d.ts +9 -9
  223. package/site-scripts/index.js +15 -15
  224. package/site-scripts/list.d.ts +12 -12
  225. package/site-scripts/list.js +24 -24
  226. package/site-scripts/types.d.ts +183 -183
  227. package/site-scripts/types.js +141 -141
  228. package/site-scripts/web.d.ts +13 -13
  229. package/site-scripts/web.js +5 -5
  230. package/site-users/index.d.ts +2 -2
  231. package/site-users/index.js +2 -2
  232. package/site-users/types.d.ts +138 -138
  233. package/site-users/types.js +122 -122
  234. package/site-users/web.d.ts +31 -31
  235. package/site-users/web.js +27 -27
  236. package/sites/index.d.ts +7 -7
  237. package/sites/index.js +13 -13
  238. package/sites/types.d.ts +147 -147
  239. package/sites/types.js +321 -321
  240. package/social/index.d.ts +10 -10
  241. package/social/index.js +13 -13
  242. package/social/types.d.ts +309 -309
  243. package/social/types.js +322 -322
  244. package/sphttpclient.d.ts +18 -18
  245. package/sphttpclient.js +189 -189
  246. package/splibconfig.d.ts +22 -22
  247. package/splibconfig.js +13 -13
  248. package/sputilities/index.d.ts +7 -7
  249. package/sputilities/index.js +13 -13
  250. package/sputilities/types.d.ts +130 -130
  251. package/sputilities/types.js +118 -118
  252. package/subscriptions/index.d.ts +2 -2
  253. package/subscriptions/index.js +2 -2
  254. package/subscriptions/list.d.ts +13 -13
  255. package/subscriptions/list.js +4 -4
  256. package/subscriptions/types.d.ts +54 -54
  257. package/subscriptions/types.js +111 -111
  258. package/taxonomy/index.d.ts +7 -7
  259. package/taxonomy/index.js +13 -13
  260. package/taxonomy/types.d.ts +200 -200
  261. package/taxonomy/types.js +347 -347
  262. package/taxonomy/types.js.map +1 -1
  263. package/telemetry.d.ts +12 -12
  264. package/telemetry.js +48 -48
  265. package/types.d.ts +218 -218
  266. package/types.js +79 -79
  267. package/user-custom-actions/index.d.ts +4 -4
  268. package/user-custom-actions/index.js +4 -4
  269. package/user-custom-actions/list.d.ts +12 -12
  270. package/user-custom-actions/list.js +4 -4
  271. package/user-custom-actions/site.d.ts +12 -12
  272. package/user-custom-actions/site.js +4 -4
  273. package/user-custom-actions/types.d.ts +82 -82
  274. package/user-custom-actions/types.js +93 -93
  275. package/user-custom-actions/web.d.ts +15 -15
  276. package/user-custom-actions/web.js +4 -4
  277. package/utils/escapeQueryStrValue.d.ts +1 -1
  278. package/utils/escapeQueryStrValue.js +19 -19
  279. package/utils/extractweburl.d.ts +1 -1
  280. package/utils/extractweburl.js +15 -15
  281. package/utils/file-names.d.ts +17 -17
  282. package/utils/file-names.js +38 -38
  283. package/utils/metadata.d.ts +5 -5
  284. package/utils/metadata.js +5 -5
  285. package/utils/objectToSPKeyValueCollection.d.ts +20 -20
  286. package/utils/objectToSPKeyValueCollection.js +16 -16
  287. package/utils/toResourcePath.d.ts +7 -7
  288. package/utils/toResourcePath.js +6 -6
  289. package/utils/toabsoluteurl.d.ts +7 -7
  290. package/utils/toabsoluteurl.js +61 -61
  291. package/views/index.d.ts +2 -2
  292. package/views/index.js +2 -2
  293. package/views/list.d.ts +23 -23
  294. package/views/list.js +8 -8
  295. package/views/types.d.ts +140 -140
  296. package/views/types.js +184 -184
  297. package/webparts/file.d.ts +15 -15
  298. package/webparts/file.js +6 -6
  299. package/webparts/index.d.ts +2 -2
  300. package/webparts/index.js +2 -2
  301. package/webparts/types.d.ts +83 -83
  302. package/webparts/types.js +117 -117
  303. package/webs/index.d.ts +16 -16
  304. package/webs/index.js +16 -16
  305. package/webs/types.d.ts +210 -210
  306. package/webs/types.js +295 -295
package/sharing/types.js CHANGED
@@ -1,114 +1,114 @@
1
- /**
2
- * Indicates the role of the sharing link
3
- */
4
- export var SharingRole;
5
- (function (SharingRole) {
6
- SharingRole[SharingRole["None"] = 0] = "None";
7
- SharingRole[SharingRole["View"] = 1] = "View";
8
- SharingRole[SharingRole["Edit"] = 2] = "Edit";
9
- SharingRole[SharingRole["Owner"] = 3] = "Owner";
10
- })(SharingRole || (SharingRole = {}));
11
- export var SPSharedObjectType;
12
- (function (SPSharedObjectType) {
13
- SPSharedObjectType[SPSharedObjectType["Unknown"] = 0] = "Unknown";
14
- SPSharedObjectType[SPSharedObjectType["File"] = 1] = "File";
15
- SPSharedObjectType[SPSharedObjectType["Folder"] = 2] = "Folder";
16
- SPSharedObjectType[SPSharedObjectType["Item"] = 3] = "Item";
17
- SPSharedObjectType[SPSharedObjectType["List"] = 4] = "List";
18
- SPSharedObjectType[SPSharedObjectType["Web"] = 5] = "Web";
19
- SPSharedObjectType[SPSharedObjectType["Max"] = 6] = "Max";
20
- })(SPSharedObjectType || (SPSharedObjectType = {}));
21
- export var SharingDomainRestrictionMode;
22
- (function (SharingDomainRestrictionMode) {
23
- SharingDomainRestrictionMode[SharingDomainRestrictionMode["None"] = 0] = "None";
24
- SharingDomainRestrictionMode[SharingDomainRestrictionMode["AllowList"] = 1] = "AllowList";
25
- SharingDomainRestrictionMode[SharingDomainRestrictionMode["BlockList"] = 2] = "BlockList";
26
- })(SharingDomainRestrictionMode || (SharingDomainRestrictionMode = {}));
27
- export var SharingOperationStatusCode;
28
- (function (SharingOperationStatusCode) {
29
- /**
30
- * The share operation completed without errors.
31
- */
32
- SharingOperationStatusCode[SharingOperationStatusCode["CompletedSuccessfully"] = 0] = "CompletedSuccessfully";
33
- /**
34
- * The share operation completed and generated requests for access.
35
- */
36
- SharingOperationStatusCode[SharingOperationStatusCode["AccessRequestsQueued"] = 1] = "AccessRequestsQueued";
37
- /**
38
- * The share operation failed as there were no resolved users.
39
- */
40
- SharingOperationStatusCode[SharingOperationStatusCode["NoResolvedUsers"] = -1] = "NoResolvedUsers";
41
- /**
42
- * The share operation failed due to insufficient permissions.
43
- */
44
- SharingOperationStatusCode[SharingOperationStatusCode["AccessDenied"] = -2] = "AccessDenied";
45
- /**
46
- * The share operation failed when attempting a cross site share, which is not supported.
47
- */
48
- SharingOperationStatusCode[SharingOperationStatusCode["CrossSiteRequestNotSupported"] = -3] = "CrossSiteRequestNotSupported";
49
- /**
50
- * The sharing operation failed due to an unknown error.
51
- */
52
- SharingOperationStatusCode[SharingOperationStatusCode["UnknowError"] = -4] = "UnknowError";
53
- /**
54
- * The text you typed is too long. Please shorten it.
55
- */
56
- SharingOperationStatusCode[SharingOperationStatusCode["EmailBodyTooLong"] = -5] = "EmailBodyTooLong";
57
- /**
58
- * The maximum number of unique scopes in the list has been exceeded.
59
- */
60
- SharingOperationStatusCode[SharingOperationStatusCode["ListUniqueScopesExceeded"] = -6] = "ListUniqueScopesExceeded";
61
- /**
62
- * The share operation failed because a sharing capability is disabled in the site.
63
- */
64
- SharingOperationStatusCode[SharingOperationStatusCode["CapabilityDisabled"] = -7] = "CapabilityDisabled";
65
- /**
66
- * The specified object for the share operation is not supported.
67
- */
68
- SharingOperationStatusCode[SharingOperationStatusCode["ObjectNotSupported"] = -8] = "ObjectNotSupported";
69
- /**
70
- * A SharePoint group cannot contain another SharePoint group.
71
- */
72
- SharingOperationStatusCode[SharingOperationStatusCode["NestedGroupsNotSupported"] = -9] = "NestedGroupsNotSupported";
73
- })(SharingOperationStatusCode || (SharingOperationStatusCode = {}));
74
- export var SharingLinkKind;
75
- (function (SharingLinkKind) {
76
- /**
77
- * Uninitialized link
78
- */
79
- SharingLinkKind[SharingLinkKind["Uninitialized"] = 0] = "Uninitialized";
80
- /**
81
- * Direct link to the object being shared
82
- */
83
- SharingLinkKind[SharingLinkKind["Direct"] = 1] = "Direct";
84
- /**
85
- * Organization-shareable link to the object being shared with view permissions
86
- */
87
- SharingLinkKind[SharingLinkKind["OrganizationView"] = 2] = "OrganizationView";
88
- /**
89
- * Organization-shareable link to the object being shared with edit permissions
90
- */
91
- SharingLinkKind[SharingLinkKind["OrganizationEdit"] = 3] = "OrganizationEdit";
92
- /**
93
- * View only anonymous link
94
- */
95
- SharingLinkKind[SharingLinkKind["AnonymousView"] = 4] = "AnonymousView";
96
- /**
97
- * Read/Write anonymous link
98
- */
99
- SharingLinkKind[SharingLinkKind["AnonymousEdit"] = 5] = "AnonymousEdit";
100
- /**
101
- * Flexible sharing Link where properties can change without affecting link URL
102
- */
103
- SharingLinkKind[SharingLinkKind["Flexible"] = 6] = "Flexible";
104
- })(SharingLinkKind || (SharingLinkKind = {}));
105
- export var RoleType;
106
- (function (RoleType) {
107
- RoleType[RoleType["None"] = 0] = "None";
108
- RoleType[RoleType["Guest"] = 1] = "Guest";
109
- RoleType[RoleType["Reader"] = 2] = "Reader";
110
- RoleType[RoleType["Contributor"] = 3] = "Contributor";
111
- RoleType[RoleType["WebDesigner"] = 4] = "WebDesigner";
112
- RoleType[RoleType["Administrator"] = 5] = "Administrator";
113
- })(RoleType || (RoleType = {}));
1
+ /**
2
+ * Indicates the role of the sharing link
3
+ */
4
+ export var SharingRole;
5
+ (function (SharingRole) {
6
+ SharingRole[SharingRole["None"] = 0] = "None";
7
+ SharingRole[SharingRole["View"] = 1] = "View";
8
+ SharingRole[SharingRole["Edit"] = 2] = "Edit";
9
+ SharingRole[SharingRole["Owner"] = 3] = "Owner";
10
+ })(SharingRole || (SharingRole = {}));
11
+ export var SPSharedObjectType;
12
+ (function (SPSharedObjectType) {
13
+ SPSharedObjectType[SPSharedObjectType["Unknown"] = 0] = "Unknown";
14
+ SPSharedObjectType[SPSharedObjectType["File"] = 1] = "File";
15
+ SPSharedObjectType[SPSharedObjectType["Folder"] = 2] = "Folder";
16
+ SPSharedObjectType[SPSharedObjectType["Item"] = 3] = "Item";
17
+ SPSharedObjectType[SPSharedObjectType["List"] = 4] = "List";
18
+ SPSharedObjectType[SPSharedObjectType["Web"] = 5] = "Web";
19
+ SPSharedObjectType[SPSharedObjectType["Max"] = 6] = "Max";
20
+ })(SPSharedObjectType || (SPSharedObjectType = {}));
21
+ export var SharingDomainRestrictionMode;
22
+ (function (SharingDomainRestrictionMode) {
23
+ SharingDomainRestrictionMode[SharingDomainRestrictionMode["None"] = 0] = "None";
24
+ SharingDomainRestrictionMode[SharingDomainRestrictionMode["AllowList"] = 1] = "AllowList";
25
+ SharingDomainRestrictionMode[SharingDomainRestrictionMode["BlockList"] = 2] = "BlockList";
26
+ })(SharingDomainRestrictionMode || (SharingDomainRestrictionMode = {}));
27
+ export var SharingOperationStatusCode;
28
+ (function (SharingOperationStatusCode) {
29
+ /**
30
+ * The share operation completed without errors.
31
+ */
32
+ SharingOperationStatusCode[SharingOperationStatusCode["CompletedSuccessfully"] = 0] = "CompletedSuccessfully";
33
+ /**
34
+ * The share operation completed and generated requests for access.
35
+ */
36
+ SharingOperationStatusCode[SharingOperationStatusCode["AccessRequestsQueued"] = 1] = "AccessRequestsQueued";
37
+ /**
38
+ * The share operation failed as there were no resolved users.
39
+ */
40
+ SharingOperationStatusCode[SharingOperationStatusCode["NoResolvedUsers"] = -1] = "NoResolvedUsers";
41
+ /**
42
+ * The share operation failed due to insufficient permissions.
43
+ */
44
+ SharingOperationStatusCode[SharingOperationStatusCode["AccessDenied"] = -2] = "AccessDenied";
45
+ /**
46
+ * The share operation failed when attempting a cross site share, which is not supported.
47
+ */
48
+ SharingOperationStatusCode[SharingOperationStatusCode["CrossSiteRequestNotSupported"] = -3] = "CrossSiteRequestNotSupported";
49
+ /**
50
+ * The sharing operation failed due to an unknown error.
51
+ */
52
+ SharingOperationStatusCode[SharingOperationStatusCode["UnknowError"] = -4] = "UnknowError";
53
+ /**
54
+ * The text you typed is too long. Please shorten it.
55
+ */
56
+ SharingOperationStatusCode[SharingOperationStatusCode["EmailBodyTooLong"] = -5] = "EmailBodyTooLong";
57
+ /**
58
+ * The maximum number of unique scopes in the list has been exceeded.
59
+ */
60
+ SharingOperationStatusCode[SharingOperationStatusCode["ListUniqueScopesExceeded"] = -6] = "ListUniqueScopesExceeded";
61
+ /**
62
+ * The share operation failed because a sharing capability is disabled in the site.
63
+ */
64
+ SharingOperationStatusCode[SharingOperationStatusCode["CapabilityDisabled"] = -7] = "CapabilityDisabled";
65
+ /**
66
+ * The specified object for the share operation is not supported.
67
+ */
68
+ SharingOperationStatusCode[SharingOperationStatusCode["ObjectNotSupported"] = -8] = "ObjectNotSupported";
69
+ /**
70
+ * A SharePoint group cannot contain another SharePoint group.
71
+ */
72
+ SharingOperationStatusCode[SharingOperationStatusCode["NestedGroupsNotSupported"] = -9] = "NestedGroupsNotSupported";
73
+ })(SharingOperationStatusCode || (SharingOperationStatusCode = {}));
74
+ export var SharingLinkKind;
75
+ (function (SharingLinkKind) {
76
+ /**
77
+ * Uninitialized link
78
+ */
79
+ SharingLinkKind[SharingLinkKind["Uninitialized"] = 0] = "Uninitialized";
80
+ /**
81
+ * Direct link to the object being shared
82
+ */
83
+ SharingLinkKind[SharingLinkKind["Direct"] = 1] = "Direct";
84
+ /**
85
+ * Organization-shareable link to the object being shared with view permissions
86
+ */
87
+ SharingLinkKind[SharingLinkKind["OrganizationView"] = 2] = "OrganizationView";
88
+ /**
89
+ * Organization-shareable link to the object being shared with edit permissions
90
+ */
91
+ SharingLinkKind[SharingLinkKind["OrganizationEdit"] = 3] = "OrganizationEdit";
92
+ /**
93
+ * View only anonymous link
94
+ */
95
+ SharingLinkKind[SharingLinkKind["AnonymousView"] = 4] = "AnonymousView";
96
+ /**
97
+ * Read/Write anonymous link
98
+ */
99
+ SharingLinkKind[SharingLinkKind["AnonymousEdit"] = 5] = "AnonymousEdit";
100
+ /**
101
+ * Flexible sharing Link where properties can change without affecting link URL
102
+ */
103
+ SharingLinkKind[SharingLinkKind["Flexible"] = 6] = "Flexible";
104
+ })(SharingLinkKind || (SharingLinkKind = {}));
105
+ export var RoleType;
106
+ (function (RoleType) {
107
+ RoleType[RoleType["None"] = 0] = "None";
108
+ RoleType[RoleType["Guest"] = 1] = "Guest";
109
+ RoleType[RoleType["Reader"] = 2] = "Reader";
110
+ RoleType[RoleType["Contributor"] = 3] = "Contributor";
111
+ RoleType[RoleType["WebDesigner"] = 4] = "WebDesigner";
112
+ RoleType[RoleType["Administrator"] = 5] = "Administrator";
113
+ })(RoleType || (RoleType = {}));
114
114
  //# sourceMappingURL=types.js.map
package/sharing/web.d.ts CHANGED
@@ -1,20 +1,20 @@
1
- import { ISharingEmailData, ISharingResult, SharingRole } from "./types.js";
2
- import { RoleType } from "./types.js";
3
- /**
4
- * Extend _Web
5
- */
6
- declare module "../webs/types" {
7
- interface _Web {
8
- shareWith: (loginNames: string | string[], role?: SharingRole, emailData?: ISharingEmailData) => Promise<ISharingResult>;
9
- shareObject: (url: string, loginNames: string | string[], role: SharingRole, emailData?: ISharingEmailData, group?: RoleType, propagateAcl?: boolean, includeAnonymousLinkInEmail?: boolean, useSimplifiedRoles?: boolean) => Promise<ISharingResult>;
10
- shareObjectRaw(options: any): Promise<ISharingResult>;
11
- unshareObject(url: string): Promise<ISharingResult>;
12
- }
13
- interface IWeb {
14
- shareWith: (loginNames: string | string[], role?: SharingRole, emailData?: ISharingEmailData) => Promise<ISharingResult>;
15
- shareObject: (url: string, loginNames: string | string[], role: SharingRole, emailData?: ISharingEmailData, group?: RoleType, propagateAcl?: boolean, includeAnonymousLinkInEmail?: boolean, useSimplifiedRoles?: boolean) => Promise<ISharingResult>;
16
- shareObjectRaw(options: any): Promise<ISharingResult>;
17
- unshareObject(url: string): Promise<ISharingResult>;
18
- }
19
- }
1
+ import { ISharingEmailData, ISharingResult, SharingRole } from "./types.js";
2
+ import { RoleType } from "./types.js";
3
+ /**
4
+ * Extend _Web
5
+ */
6
+ declare module "../webs/types" {
7
+ interface _Web {
8
+ shareWith: (loginNames: string | string[], role?: SharingRole, emailData?: ISharingEmailData) => Promise<ISharingResult>;
9
+ shareObject: (url: string, loginNames: string | string[], role: SharingRole, emailData?: ISharingEmailData, group?: RoleType, propagateAcl?: boolean, includeAnonymousLinkInEmail?: boolean, useSimplifiedRoles?: boolean) => Promise<ISharingResult>;
10
+ shareObjectRaw(options: any): Promise<ISharingResult>;
11
+ unshareObject(url: string): Promise<ISharingResult>;
12
+ }
13
+ interface IWeb {
14
+ shareWith: (loginNames: string | string[], role?: SharingRole, emailData?: ISharingEmailData) => Promise<ISharingResult>;
15
+ shareObject: (url: string, loginNames: string | string[], role: SharingRole, emailData?: ISharingEmailData, group?: RoleType, propagateAcl?: boolean, includeAnonymousLinkInEmail?: boolean, useSimplifiedRoles?: boolean) => Promise<ISharingResult>;
16
+ shareObjectRaw(options: any): Promise<ISharingResult>;
17
+ unshareObject(url: string): Promise<ISharingResult>;
18
+ }
19
+ }
20
20
  //# sourceMappingURL=web.d.ts.map
package/sharing/web.js CHANGED
@@ -1,77 +1,77 @@
1
- import { __awaiter, __generator } from "tslib";
2
- import { _Web, Web } from "../webs/types.js";
3
- import { SharingRole } from "./types.js";
4
- import { _SharePointQueryableInstance } from "../sharepointqueryable.js";
5
- import { extractWebUrl } from "../utils/extractweburl.js";
6
- import { shareObject } from "./funcs.js";
7
- import { combine } from "@pnp/common";
8
- import { body } from "@pnp/odata";
9
- import { spPost } from "../operations.js";
10
- /**
11
- * Shares this web with the supplied users
12
- * @param loginNames The resolved login names to share
13
- * @param role The role to share this web
14
- * @param emailData Optional email data
15
- */
16
- _Web.prototype.shareWith = function (loginNames, role, emailData) {
17
- if (role === void 0) { role = SharingRole.View; }
18
- return __awaiter(this, void 0, void 0, function () {
19
- var dependency, web, url;
20
- return __generator(this, function (_a) {
21
- switch (_a.label) {
22
- case 0:
23
- dependency = this.addBatchDependency();
24
- web = new _SharePointQueryableInstance(extractWebUrl(this.toUrl()), "/_api/web/url");
25
- return [4 /*yield*/, web.get()];
26
- case 1:
27
- url = _a.sent();
28
- dependency();
29
- return [2 /*return*/, this.shareObject(combine(url, "/_layouts/15/aclinv.aspx?forSharing=1&mbypass=1"), loginNames, role, emailData)];
30
- }
31
- });
32
- });
33
- };
34
- /**
35
- * Provides direct access to the static web.ShareObject method
36
- *
37
- * @param url The url to share
38
- * @param loginNames Resolved loginnames string[] of a single login name string
39
- * @param roleValue Role value
40
- * @param emailData Optional email data
41
- * @param groupId Optional group id
42
- * @param propagateAcl
43
- * @param includeAnonymousLinkInEmail
44
- * @param useSimplifiedRoles
45
- */
46
- _Web.prototype.shareObject = function (url, loginNames, role, emailData, group, propagateAcl, includeAnonymousLinkInEmail, useSimplifiedRoles) {
47
- if (propagateAcl === void 0) { propagateAcl = false; }
48
- if (includeAnonymousLinkInEmail === void 0) { includeAnonymousLinkInEmail = false; }
49
- if (useSimplifiedRoles === void 0) { useSimplifiedRoles = true; }
50
- return shareObject(this, {
51
- emailData: emailData,
52
- group: group,
53
- includeAnonymousLinkInEmail: includeAnonymousLinkInEmail,
54
- loginNames: loginNames,
55
- propagateAcl: propagateAcl,
56
- role: role,
57
- url: url,
58
- useSimplifiedRoles: useSimplifiedRoles,
59
- });
60
- };
61
- /**
62
- * Supplies a method to pass any set of arguments to ShareObject
63
- *
64
- * @param options The set of options to send to ShareObject
65
- */
66
- _Web.prototype.shareObjectRaw = function (options) {
67
- return shareObject(this, options, true);
68
- };
69
- /**
70
- * Supplies a method to pass any set of arguments to ShareObject
71
- *
72
- * @param options The set of options to send to ShareObject
73
- */
74
- _Web.prototype.unshareObject = function (url) {
75
- return spPost(Web(this, "unshareObject").configureFrom(this), body({ url: url }));
76
- };
1
+ import { __awaiter, __generator } from "tslib";
2
+ import { _Web, Web } from "../webs/types.js";
3
+ import { SharingRole } from "./types.js";
4
+ import { _SharePointQueryableInstance } from "../sharepointqueryable.js";
5
+ import { extractWebUrl } from "../utils/extractweburl.js";
6
+ import { shareObject } from "./funcs.js";
7
+ import { combine } from "@pnp/common";
8
+ import { body } from "@pnp/odata";
9
+ import { spPost } from "../operations.js";
10
+ /**
11
+ * Shares this web with the supplied users
12
+ * @param loginNames The resolved login names to share
13
+ * @param role The role to share this web
14
+ * @param emailData Optional email data
15
+ */
16
+ _Web.prototype.shareWith = function (loginNames, role, emailData) {
17
+ if (role === void 0) { role = SharingRole.View; }
18
+ return __awaiter(this, void 0, void 0, function () {
19
+ var dependency, web, url;
20
+ return __generator(this, function (_a) {
21
+ switch (_a.label) {
22
+ case 0:
23
+ dependency = this.addBatchDependency();
24
+ web = new _SharePointQueryableInstance(extractWebUrl(this.toUrl()), "/_api/web/url");
25
+ return [4 /*yield*/, web.get()];
26
+ case 1:
27
+ url = _a.sent();
28
+ dependency();
29
+ return [2 /*return*/, this.shareObject(combine(url, "/_layouts/15/aclinv.aspx?forSharing=1&mbypass=1"), loginNames, role, emailData)];
30
+ }
31
+ });
32
+ });
33
+ };
34
+ /**
35
+ * Provides direct access to the static web.ShareObject method
36
+ *
37
+ * @param url The url to share
38
+ * @param loginNames Resolved loginnames string[] of a single login name string
39
+ * @param roleValue Role value
40
+ * @param emailData Optional email data
41
+ * @param groupId Optional group id
42
+ * @param propagateAcl
43
+ * @param includeAnonymousLinkInEmail
44
+ * @param useSimplifiedRoles
45
+ */
46
+ _Web.prototype.shareObject = function (url, loginNames, role, emailData, group, propagateAcl, includeAnonymousLinkInEmail, useSimplifiedRoles) {
47
+ if (propagateAcl === void 0) { propagateAcl = false; }
48
+ if (includeAnonymousLinkInEmail === void 0) { includeAnonymousLinkInEmail = false; }
49
+ if (useSimplifiedRoles === void 0) { useSimplifiedRoles = true; }
50
+ return shareObject(this, {
51
+ emailData: emailData,
52
+ group: group,
53
+ includeAnonymousLinkInEmail: includeAnonymousLinkInEmail,
54
+ loginNames: loginNames,
55
+ propagateAcl: propagateAcl,
56
+ role: role,
57
+ url: url,
58
+ useSimplifiedRoles: useSimplifiedRoles,
59
+ });
60
+ };
61
+ /**
62
+ * Supplies a method to pass any set of arguments to ShareObject
63
+ *
64
+ * @param options The set of options to send to ShareObject
65
+ */
66
+ _Web.prototype.shareObjectRaw = function (options) {
67
+ return shareObject(this, options, true);
68
+ };
69
+ /**
70
+ * Supplies a method to pass any set of arguments to ShareObject
71
+ *
72
+ * @param options The set of options to send to ShareObject
73
+ */
74
+ _Web.prototype.unshareObject = function (url) {
75
+ return spPost(Web(this, "unshareObject").configureFrom(this), body({ url: url }));
76
+ };
77
77
  //# sourceMappingURL=web.js.map
@@ -1,9 +1,9 @@
1
- import "./web.js";
2
- import { ISiteDesigns } from "./types.js";
3
- export { ISiteDesignCreationInfo, ISiteDesignInfo, ISiteDesignPrincipals, ISiteDesignUpdateInfo, ISiteDesigns, SiteDesigns, ISiteDesignRun, ISiteDesignTask, ISiteScriptActionStatus, } from "./types.js";
4
- declare module "../rest" {
5
- interface SPRest {
6
- readonly siteDesigns: ISiteDesigns;
7
- }
8
- }
1
+ import "./web.js";
2
+ import { ISiteDesigns } from "./types.js";
3
+ export { ISiteDesignCreationInfo, ISiteDesignInfo, ISiteDesignPrincipals, ISiteDesignUpdateInfo, ISiteDesigns, SiteDesigns, ISiteDesignRun, ISiteDesignTask, ISiteScriptActionStatus, } from "./types.js";
4
+ declare module "../rest" {
5
+ interface SPRest {
6
+ readonly siteDesigns: ISiteDesigns;
7
+ }
8
+ }
9
9
  //# sourceMappingURL=index.d.ts.map
@@ -1,15 +1,15 @@
1
- import "./web.js";
2
- import { SPRest } from "../rest.js";
3
- import { SiteDesigns } from "./types.js";
4
- export { SiteDesigns, } from "./types.js";
5
- Reflect.defineProperty(SPRest.prototype, "siteDesigns", {
6
- configurable: true,
7
- enumerable: true,
8
- get: function () {
9
- return this.childConfigHook(function (_a) {
10
- var options = _a.options, baseUrl = _a.baseUrl, runtime = _a.runtime;
11
- return SiteDesigns(baseUrl).configure(options).setRuntime(runtime);
12
- });
13
- },
14
- });
1
+ import "./web.js";
2
+ import { SPRest } from "../rest.js";
3
+ import { SiteDesigns } from "./types.js";
4
+ export { SiteDesigns, } from "./types.js";
5
+ Reflect.defineProperty(SPRest.prototype, "siteDesigns", {
6
+ configurable: true,
7
+ enumerable: true,
8
+ get: function () {
9
+ return this.childConfigHook(function (_a) {
10
+ var options = _a.options, baseUrl = _a.baseUrl, runtime = _a.runtime;
11
+ return SiteDesigns(baseUrl).configure(options).setRuntime(runtime);
12
+ });
13
+ },
14
+ });
15
15
  //# sourceMappingURL=index.js.map