@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/funcs.js CHANGED
@@ -1,240 +1,240 @@
1
- import { __awaiter, __generator, __read, __spreadArray } from "tslib";
2
- import { body } from "@pnp/odata";
3
- import { jsS, assign } from "@pnp/common";
4
- import { SharePointQueryableCollection, SharePointQueryableInstance } from "../sharepointqueryable.js";
5
- import { extractWebUrl } from "../utils/extractweburl.js";
6
- import { Web } from "../webs/types.js";
7
- import { SharingRole, RoleType, } from "./types.js";
8
- import { spPost } from "../operations.js";
9
- import { tag } from "../telemetry.js";
10
- import { RoleDefinitions } from "../security/types.js";
11
- import { emptyGuid } from "../splibconfig.js";
12
- /**
13
- * Shares an object based on the supplied options
14
- *
15
- * @param options The set of options to send to the ShareObject method
16
- * @param bypass If true any processing is skipped and the options are sent directly to the ShareObject method
17
- */
18
- export function shareObject(o, options, bypass) {
19
- if (bypass === void 0) { bypass = false; }
20
- return __awaiter(this, void 0, void 0, function () {
21
- var roleValue, userStr, postBody;
22
- return __generator(this, function (_a) {
23
- switch (_a.label) {
24
- case 0:
25
- if (bypass) {
26
- // if the bypass flag is set send the supplied parameters directly to the service
27
- return [2 /*return*/, sendShareObjectRequest(o, options)];
28
- }
29
- // extend our options with some defaults
30
- options = assign(options, {
31
- group: null,
32
- includeAnonymousLinkInEmail: false,
33
- propagateAcl: false,
34
- useSimplifiedRoles: true,
35
- }, true);
36
- return [4 /*yield*/, getRoleValue(options.role, options.group)];
37
- case 1:
38
- roleValue = _a.sent();
39
- // handle the multiple input types
40
- if (!Array.isArray(options.loginNames)) {
41
- options.loginNames = [options.loginNames];
42
- }
43
- userStr = jsS(options.loginNames.map(function (Key) { return ({ Key: Key }); }));
44
- postBody = {
45
- peoplePickerInput: userStr,
46
- roleValue: roleValue,
47
- url: options.url,
48
- };
49
- if (options.emailData !== undefined && options.emailData !== null) {
50
- postBody = assign(postBody, {
51
- emailBody: options.emailData.body,
52
- emailSubject: options.emailData.subject !== undefined ? options.emailData.subject : "Shared with you.",
53
- sendEmail: true,
54
- });
55
- }
56
- return [2 /*return*/, sendShareObjectRequest(o, postBody)];
57
- }
58
- });
59
- });
60
- }
61
- /**
62
- * Gets a sharing link for the supplied
63
- *
64
- * @param kind The kind of link to share
65
- * @param expiration The optional expiration for this link
66
- */
67
- export function getShareLink(kind, expiration) {
68
- if (expiration === void 0) { expiration = null; }
69
- // date needs to be an ISO string or null
70
- var expString = expiration !== null ? expiration.toISOString() : null;
71
- // clone using the factory and send the request
72
- var o = tag.configure(this.clone(SharePointQueryableInstance, "shareLink"), "sh.getShareLink");
73
- return spPost(o, body({
74
- request: {
75
- createLink: true,
76
- emailData: null,
77
- settings: {
78
- expiration: expString,
79
- linkKind: kind,
80
- },
81
- },
82
- }));
83
- }
84
- /**
85
- * Checks Permissions on the list of Users and returns back role the users have on the Item.
86
- *
87
- * @param recipients The array of Entities for which Permissions need to be checked.
88
- */
89
- export function checkPermissions(recipients) {
90
- var o = tag.configure(this.clone(SharePointQueryableInstance, "checkPermissions"), "sh.checkPermissions");
91
- return spPost(o, body({ recipients: recipients }));
92
- }
93
- /**
94
- * Get Sharing Information.
95
- *
96
- * @param request The SharingInformationRequest Object.
97
- * @param expands Expand more fields.
98
- *
99
- */
100
- export function getSharingInformation(request, expands) {
101
- if (request === void 0) { request = null; }
102
- if (expands === void 0) { expands = []; }
103
- var o = tag.configure(this.clone(SharePointQueryableInstance, "getSharingInformation"), "sh.getSharingInformation");
104
- return spPost(o.expand.apply(o, __spreadArray([], __read(expands))), body({ request: request }));
105
- }
106
- /**
107
- * Gets the sharing settings of an item.
108
- *
109
- * @param useSimplifiedRoles Determines whether to use simplified roles.
110
- */
111
- export function getObjectSharingSettings(useSimplifiedRoles) {
112
- if (useSimplifiedRoles === void 0) { useSimplifiedRoles = true; }
113
- var o = tag.configure(this.clone(SharePointQueryableInstance, "getObjectSharingSettings"), "sh.getObjectSharingSettings");
114
- return spPost(o, body({ useSimplifiedRoles: useSimplifiedRoles }));
115
- }
116
- /**
117
- * Unshares this object
118
- */
119
- export function unshareObject() {
120
- return spPost(tag.configure(this.clone(SharePointQueryableInstance, "unshareObject"), "sh.unshareObject"));
121
- }
122
- /**
123
- * Deletes a link by type
124
- *
125
- * @param kind Deletes a sharing link by the kind of link
126
- */
127
- export function deleteLinkByKind(linkKind) {
128
- return spPost(tag.configure(this.clone(SharePointQueryableInstance, "deleteLinkByKind"), "sh.deleteLinkByKind"), body({ linkKind: linkKind }));
129
- }
130
- /**
131
- * Removes the specified link to the item.
132
- *
133
- * @param kind The kind of link to be deleted.
134
- * @param shareId
135
- */
136
- export function unshareLink(linkKind, shareId) {
137
- if (shareId === void 0) { shareId = emptyGuid; }
138
- return spPost(tag.configure(this.clone(SharePointQueryableInstance, "unshareLink"), "sh.unshareLink"), body({ linkKind: linkKind, shareId: shareId }));
139
- }
140
- /**
141
- * Shares this instance with the supplied users
142
- *
143
- * @param loginNames Resolved login names to share
144
- * @param role The role
145
- * @param requireSignin True to require the user is authenticated, otherwise false
146
- * @param propagateAcl True to apply this share to all children
147
- * @param emailData If supplied an email will be sent with the indicated properties
148
- */
149
- export function shareWith(o, loginNames, role, requireSignin, propagateAcl, emailData) {
150
- if (requireSignin === void 0) { requireSignin = false; }
151
- if (propagateAcl === void 0) { propagateAcl = false; }
152
- return __awaiter(this, void 0, void 0, function () {
153
- var userStr, roleFilter, w, def, postBody;
154
- return __generator(this, function (_a) {
155
- switch (_a.label) {
156
- case 0:
157
- // handle the multiple input types
158
- if (!Array.isArray(loginNames)) {
159
- loginNames = [loginNames];
160
- }
161
- userStr = jsS(loginNames.map(function (login) {
162
- return { Key: login };
163
- }));
164
- roleFilter = role === SharingRole.Edit ? RoleType.Contributor : RoleType.Reader;
165
- w = SharePointQueryableCollection("_api/web", "roledefinitions");
166
- return [4 /*yield*/, w.select("Id").filter("RoleTypeKind eq " + roleFilter).get()];
167
- case 1:
168
- def = _a.sent();
169
- if (!Array.isArray(def) || def.length < 1) {
170
- throw Error("Could not locate a role defintion with RoleTypeKind " + roleFilter);
171
- }
172
- postBody = {
173
- includeAnonymousLinkInEmail: requireSignin,
174
- peoplePickerInput: userStr,
175
- propagateAcl: propagateAcl,
176
- roleValue: "role:" + def[0].Id,
177
- useSimplifiedRoles: true,
178
- };
179
- if (emailData !== undefined) {
180
- postBody = assign(postBody, {
181
- emailBody: emailData.body,
182
- emailSubject: emailData.subject !== undefined ? emailData.subject : "",
183
- sendEmail: true,
184
- });
185
- }
186
- return [2 /*return*/, spPost(tag.configure(o.clone(SharePointQueryableInstance, "shareObject"), "sh.shareWith"), body(postBody))];
187
- }
188
- });
189
- });
190
- }
191
- function sendShareObjectRequest(o, options) {
192
- var w = tag.configure(Web(extractWebUrl(o.toUrl()), "/_api/SP.Web.ShareObject"), "sh.sendShareObjectRequest");
193
- w.configureFrom(o);
194
- return spPost(w.expand("UsersWithAccessRequests", "GroupsSharedWith"), body(options));
195
- }
196
- /**
197
- * Calculates the roleValue string used in the sharing query
198
- *
199
- * @param role The Sharing Role
200
- * @param group The Group type
201
- */
202
- function getRoleValue(role, group) {
203
- return __awaiter(this, void 0, void 0, function () {
204
- var _a, g1, g2, roleFilter, def;
205
- return __generator(this, function (_b) {
206
- switch (_b.label) {
207
- case 0:
208
- if (!(group !== undefined && group !== null)) return [3 /*break*/, 7];
209
- _a = group;
210
- switch (_a) {
211
- case RoleType.Contributor: return [3 /*break*/, 1];
212
- case RoleType.Reader: return [3 /*break*/, 3];
213
- case RoleType.Guest: return [3 /*break*/, 3];
214
- }
215
- return [3 /*break*/, 5];
216
- case 1: return [4 /*yield*/, Web("_api/web", "associatedmembergroup").configureFrom(this).select("Id")()];
217
- case 2:
218
- g1 = _b.sent();
219
- return [2 /*return*/, "group: " + g1.Id];
220
- case 3: return [4 /*yield*/, Web("_api/web", "associatedvisitorgroup").configureFrom(this).select("Id")()];
221
- case 4:
222
- g2 = _b.sent();
223
- return [2 /*return*/, "group: " + g2.Id];
224
- case 5: throw Error("Could not determine role value for supplied value. Contributor, Reader, and Guest are supported");
225
- case 6: return [3 /*break*/, 9];
226
- case 7:
227
- roleFilter = role === SharingRole.Edit ? RoleType.Contributor : RoleType.Reader;
228
- return [4 /*yield*/, RoleDefinitions("_api/web").select("Id").top(1).filter("RoleTypeKind eq " + roleFilter)()];
229
- case 8:
230
- def = _b.sent();
231
- if (def.length < 1) {
232
- throw Error("Could not locate associated role definition for supplied role. Edit and View are supported");
233
- }
234
- return [2 /*return*/, "role: " + def[0].Id];
235
- case 9: return [2 /*return*/];
236
- }
237
- });
238
- });
239
- }
1
+ import { __awaiter, __generator, __read, __spreadArray } from "tslib";
2
+ import { body } from "@pnp/odata";
3
+ import { jsS, assign } from "@pnp/common";
4
+ import { SharePointQueryableCollection, SharePointQueryableInstance } from "../sharepointqueryable.js";
5
+ import { extractWebUrl } from "../utils/extractweburl.js";
6
+ import { Web } from "../webs/types.js";
7
+ import { SharingRole, RoleType, } from "./types.js";
8
+ import { spPost } from "../operations.js";
9
+ import { tag } from "../telemetry.js";
10
+ import { RoleDefinitions } from "../security/types.js";
11
+ import { emptyGuid } from "../splibconfig.js";
12
+ /**
13
+ * Shares an object based on the supplied options
14
+ *
15
+ * @param options The set of options to send to the ShareObject method
16
+ * @param bypass If true any processing is skipped and the options are sent directly to the ShareObject method
17
+ */
18
+ export function shareObject(o, options, bypass) {
19
+ if (bypass === void 0) { bypass = false; }
20
+ return __awaiter(this, void 0, void 0, function () {
21
+ var roleValue, userStr, postBody;
22
+ return __generator(this, function (_a) {
23
+ switch (_a.label) {
24
+ case 0:
25
+ if (bypass) {
26
+ // if the bypass flag is set send the supplied parameters directly to the service
27
+ return [2 /*return*/, sendShareObjectRequest(o, options)];
28
+ }
29
+ // extend our options with some defaults
30
+ options = assign(options, {
31
+ group: null,
32
+ includeAnonymousLinkInEmail: false,
33
+ propagateAcl: false,
34
+ useSimplifiedRoles: true,
35
+ }, true);
36
+ return [4 /*yield*/, getRoleValue(options.role, options.group)];
37
+ case 1:
38
+ roleValue = _a.sent();
39
+ // handle the multiple input types
40
+ if (!Array.isArray(options.loginNames)) {
41
+ options.loginNames = [options.loginNames];
42
+ }
43
+ userStr = jsS(options.loginNames.map(function (Key) { return ({ Key: Key }); }));
44
+ postBody = {
45
+ peoplePickerInput: userStr,
46
+ roleValue: roleValue,
47
+ url: options.url,
48
+ };
49
+ if (options.emailData !== undefined && options.emailData !== null) {
50
+ postBody = assign(postBody, {
51
+ emailBody: options.emailData.body,
52
+ emailSubject: options.emailData.subject !== undefined ? options.emailData.subject : "Shared with you.",
53
+ sendEmail: true,
54
+ });
55
+ }
56
+ return [2 /*return*/, sendShareObjectRequest(o, postBody)];
57
+ }
58
+ });
59
+ });
60
+ }
61
+ /**
62
+ * Gets a sharing link for the supplied
63
+ *
64
+ * @param kind The kind of link to share
65
+ * @param expiration The optional expiration for this link
66
+ */
67
+ export function getShareLink(kind, expiration) {
68
+ if (expiration === void 0) { expiration = null; }
69
+ // date needs to be an ISO string or null
70
+ var expString = expiration !== null ? expiration.toISOString() : null;
71
+ // clone using the factory and send the request
72
+ var o = tag.configure(this.clone(SharePointQueryableInstance, "shareLink"), "sh.getShareLink");
73
+ return spPost(o, body({
74
+ request: {
75
+ createLink: true,
76
+ emailData: null,
77
+ settings: {
78
+ expiration: expString,
79
+ linkKind: kind,
80
+ },
81
+ },
82
+ }));
83
+ }
84
+ /**
85
+ * Checks Permissions on the list of Users and returns back role the users have on the Item.
86
+ *
87
+ * @param recipients The array of Entities for which Permissions need to be checked.
88
+ */
89
+ export function checkPermissions(recipients) {
90
+ var o = tag.configure(this.clone(SharePointQueryableInstance, "checkPermissions"), "sh.checkPermissions");
91
+ return spPost(o, body({ recipients: recipients }));
92
+ }
93
+ /**
94
+ * Get Sharing Information.
95
+ *
96
+ * @param request The SharingInformationRequest Object.
97
+ * @param expands Expand more fields.
98
+ *
99
+ */
100
+ export function getSharingInformation(request, expands) {
101
+ if (request === void 0) { request = null; }
102
+ if (expands === void 0) { expands = []; }
103
+ var o = tag.configure(this.clone(SharePointQueryableInstance, "getSharingInformation"), "sh.getSharingInformation");
104
+ return spPost(o.expand.apply(o, __spreadArray([], __read(expands), false)), body({ request: request }));
105
+ }
106
+ /**
107
+ * Gets the sharing settings of an item.
108
+ *
109
+ * @param useSimplifiedRoles Determines whether to use simplified roles.
110
+ */
111
+ export function getObjectSharingSettings(useSimplifiedRoles) {
112
+ if (useSimplifiedRoles === void 0) { useSimplifiedRoles = true; }
113
+ var o = tag.configure(this.clone(SharePointQueryableInstance, "getObjectSharingSettings"), "sh.getObjectSharingSettings");
114
+ return spPost(o, body({ useSimplifiedRoles: useSimplifiedRoles }));
115
+ }
116
+ /**
117
+ * Unshares this object
118
+ */
119
+ export function unshareObject() {
120
+ return spPost(tag.configure(this.clone(SharePointQueryableInstance, "unshareObject"), "sh.unshareObject"));
121
+ }
122
+ /**
123
+ * Deletes a link by type
124
+ *
125
+ * @param kind Deletes a sharing link by the kind of link
126
+ */
127
+ export function deleteLinkByKind(linkKind) {
128
+ return spPost(tag.configure(this.clone(SharePointQueryableInstance, "deleteLinkByKind"), "sh.deleteLinkByKind"), body({ linkKind: linkKind }));
129
+ }
130
+ /**
131
+ * Removes the specified link to the item.
132
+ *
133
+ * @param kind The kind of link to be deleted.
134
+ * @param shareId
135
+ */
136
+ export function unshareLink(linkKind, shareId) {
137
+ if (shareId === void 0) { shareId = emptyGuid; }
138
+ return spPost(tag.configure(this.clone(SharePointQueryableInstance, "unshareLink"), "sh.unshareLink"), body({ linkKind: linkKind, shareId: shareId }));
139
+ }
140
+ /**
141
+ * Shares this instance with the supplied users
142
+ *
143
+ * @param loginNames Resolved login names to share
144
+ * @param role The role
145
+ * @param requireSignin True to require the user is authenticated, otherwise false
146
+ * @param propagateAcl True to apply this share to all children
147
+ * @param emailData If supplied an email will be sent with the indicated properties
148
+ */
149
+ export function shareWith(o, loginNames, role, requireSignin, propagateAcl, emailData) {
150
+ if (requireSignin === void 0) { requireSignin = false; }
151
+ if (propagateAcl === void 0) { propagateAcl = false; }
152
+ return __awaiter(this, void 0, void 0, function () {
153
+ var userStr, roleFilter, w, def, postBody;
154
+ return __generator(this, function (_a) {
155
+ switch (_a.label) {
156
+ case 0:
157
+ // handle the multiple input types
158
+ if (!Array.isArray(loginNames)) {
159
+ loginNames = [loginNames];
160
+ }
161
+ userStr = jsS(loginNames.map(function (login) {
162
+ return { Key: login };
163
+ }));
164
+ roleFilter = role === SharingRole.Edit ? RoleType.Contributor : RoleType.Reader;
165
+ w = SharePointQueryableCollection("_api/web", "roledefinitions");
166
+ return [4 /*yield*/, w.select("Id").filter("RoleTypeKind eq " + roleFilter).get()];
167
+ case 1:
168
+ def = _a.sent();
169
+ if (!Array.isArray(def) || def.length < 1) {
170
+ throw Error("Could not locate a role defintion with RoleTypeKind " + roleFilter);
171
+ }
172
+ postBody = {
173
+ includeAnonymousLinkInEmail: requireSignin,
174
+ peoplePickerInput: userStr,
175
+ propagateAcl: propagateAcl,
176
+ roleValue: "role:" + def[0].Id,
177
+ useSimplifiedRoles: true,
178
+ };
179
+ if (emailData !== undefined) {
180
+ postBody = assign(postBody, {
181
+ emailBody: emailData.body,
182
+ emailSubject: emailData.subject !== undefined ? emailData.subject : "",
183
+ sendEmail: true,
184
+ });
185
+ }
186
+ return [2 /*return*/, spPost(tag.configure(o.clone(SharePointQueryableInstance, "shareObject"), "sh.shareWith"), body(postBody))];
187
+ }
188
+ });
189
+ });
190
+ }
191
+ function sendShareObjectRequest(o, options) {
192
+ var w = tag.configure(Web(extractWebUrl(o.toUrl()), "/_api/SP.Web.ShareObject"), "sh.sendShareObjectRequest");
193
+ w.configureFrom(o);
194
+ return spPost(w.expand("UsersWithAccessRequests", "GroupsSharedWith"), body(options));
195
+ }
196
+ /**
197
+ * Calculates the roleValue string used in the sharing query
198
+ *
199
+ * @param role The Sharing Role
200
+ * @param group The Group type
201
+ */
202
+ function getRoleValue(role, group) {
203
+ return __awaiter(this, void 0, void 0, function () {
204
+ var _a, g1, g2, roleFilter, def;
205
+ return __generator(this, function (_b) {
206
+ switch (_b.label) {
207
+ case 0:
208
+ if (!(group !== undefined && group !== null)) return [3 /*break*/, 7];
209
+ _a = group;
210
+ switch (_a) {
211
+ case RoleType.Contributor: return [3 /*break*/, 1];
212
+ case RoleType.Reader: return [3 /*break*/, 3];
213
+ case RoleType.Guest: return [3 /*break*/, 3];
214
+ }
215
+ return [3 /*break*/, 5];
216
+ case 1: return [4 /*yield*/, Web("_api/web", "associatedmembergroup").configureFrom(this).select("Id")()];
217
+ case 2:
218
+ g1 = _b.sent();
219
+ return [2 /*return*/, "group: " + g1.Id];
220
+ case 3: return [4 /*yield*/, Web("_api/web", "associatedvisitorgroup").configureFrom(this).select("Id")()];
221
+ case 4:
222
+ g2 = _b.sent();
223
+ return [2 /*return*/, "group: " + g2.Id];
224
+ case 5: throw Error("Could not determine role value for supplied value. Contributor, Reader, and Guest are supported");
225
+ case 6: return [3 /*break*/, 9];
226
+ case 7:
227
+ roleFilter = role === SharingRole.Edit ? RoleType.Contributor : RoleType.Reader;
228
+ return [4 /*yield*/, RoleDefinitions("_api/web").select("Id").top(1).filter("RoleTypeKind eq " + roleFilter)()];
229
+ case 8:
230
+ def = _b.sent();
231
+ if (def.length < 1) {
232
+ throw Error("Could not locate associated role definition for supplied role. Edit and View are supported");
233
+ }
234
+ return [2 /*return*/, "role: " + def[0].Id];
235
+ case 9: return [2 /*return*/];
236
+ }
237
+ });
238
+ });
239
+ }
240
240
  //# sourceMappingURL=funcs.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"funcs.js","sourceRoot":"","sources":["../../../../../packages/sp/sharing/funcs.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAClC,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,6BAA6B,EAAE,2BAA2B,EAAE,MAAM,2BAA2B,CAAC;AACvG,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAC;AACvC,OAAO,EAGH,WAAW,EAUX,QAAQ,GACX,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAE9C;;;;;GAKG;AACH,MAAM,UAAgB,WAAW,CAAC,CAAqB,EAAE,OAA4B,EAAE,MAAc;IAAd,uBAAA,EAAA,cAAc;;;;;;oBAEjG,IAAI,MAAM,EAAE;wBAER,iFAAiF;wBACjF,sBAAO,sBAAsB,CAAC,CAAC,EAAE,OAAO,CAAC,EAAC;qBAC7C;oBAED,wCAAwC;oBACxC,OAAO,GAAG,MAAM,CAAC,OAAO,EAAE;wBACtB,KAAK,EAAE,IAAI;wBACX,2BAA2B,EAAE,KAAK;wBAClC,YAAY,EAAE,KAAK;wBACnB,kBAAkB,EAAE,IAAI;qBAC3B,EAAE,IAAI,CAAC,CAAC;oBAES,qBAAM,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,EAAA;;oBAA3D,SAAS,GAAG,SAA+C;oBAEjE,kCAAkC;oBAClC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;wBACpC,OAAO,CAAC,UAAU,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;qBAC7C;oBAEK,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,UAAA,GAAG,IAAI,OAAA,CAAC,EAAE,GAAG,KAAA,EAAE,CAAC,EAAT,CAAS,CAAC,CAAC,CAAC;oBAE1D,QAAQ,GAAG;wBACX,iBAAiB,EAAE,OAAO;wBAC1B,SAAS,EAAE,SAAS;wBACpB,GAAG,EAAE,OAAO,CAAC,GAAG;qBACnB,CAAC;oBAEF,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,IAAI,OAAO,CAAC,SAAS,KAAK,IAAI,EAAE;wBAC/D,QAAQ,GAAG,MAAM,CAAC,QAAQ,EAAE;4BACxB,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,IAAI;4BACjC,YAAY,EAAE,OAAO,CAAC,SAAS,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,kBAAkB;4BACtG,SAAS,EAAE,IAAI;yBAClB,CAAC,CAAC;qBACN;oBAED,sBAAO,sBAAsB,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAC;;;;CAC9C;AAED;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAA2B,IAAqB,EAAE,UAAuB;IAAvB,2BAAA,EAAA,iBAAuB;IAEjG,yCAAyC;IACzC,IAAM,SAAS,GAAG,UAAU,KAAK,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IAExE,+CAA+C;IAC/C,IAAM,CAAC,GAAG,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,2BAA2B,EAAE,WAAW,CAAC,EAAE,iBAAiB,CAAC,CAAC;IACjG,OAAO,MAAM,CAAqB,CAAC,EAAE,IAAI,CAAC;QACtC,OAAO,EAAE;YACL,UAAU,EAAE,IAAI;YAChB,SAAS,EAAE,IAAI;YACf,QAAQ,EAAE;gBACN,UAAU,EAAE,SAAS;gBACrB,QAAQ,EAAE,IAAI;aACjB;SACJ;KACJ,CAAC,CAAC,CAAC;AACR,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAA2B,UAA+B;IAEtF,IAAM,CAAC,GAAG,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,2BAA2B,EAAE,kBAAkB,CAAC,EAAE,qBAAqB,CAAC,CAAC;IAC5G,OAAO,MAAM,CAA6B,CAAC,EAAE,IAAI,CAAC,EAAE,UAAU,YAAA,EAAE,CAAC,CAAC,CAAC;AACvE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,qBAAqB,CAA2B,OAA0C,EAAE,OAAsB;IAAlE,wBAAA,EAAA,cAA0C;IAAE,wBAAA,EAAA,YAAsB;IAE9H,IAAM,CAAC,GAAG,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,2BAA2B,EAAE,uBAAuB,CAAC,EAAE,0BAA0B,CAAC,CAAC;IACtH,OAAO,MAAM,CAAC,CAAC,CAAC,MAAM,OAAR,CAAC,2BAAW,OAAO,KAAG,IAAI,CAAC,EAAE,OAAO,SAAA,EAAE,CAAC,CAAC,CAAC;AAC3D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,wBAAwB,CAA2B,kBAAyB;IAAzB,mCAAA,EAAA,yBAAyB;IAExF,IAAM,CAAC,GAAG,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,2BAA2B,EAAE,0BAA0B,CAAC,EAAE,6BAA6B,CAAC,CAAC;IAC5H,OAAO,MAAM,CAAyB,CAAC,EAAE,IAAI,CAAC,EAAE,kBAAkB,oBAAA,EAAE,CAAC,CAAC,CAAC;AAC3E,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa;IAEzB,OAAO,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,2BAA2B,EAAE,eAAe,CAAC,EAAE,kBAAkB,CAAC,CAAC,CAAC;AAC/G,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAA2B,QAAyB;IAEhF,OAAO,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,2BAA2B,EAAE,kBAAkB,CAAC,EAAE,qBAAqB,CAAC,EAAE,IAAI,CAAC,EAAE,QAAQ,UAAA,EAAE,CAAC,CAAC,CAAC;AACzI,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAA2B,QAAyB,EAAE,OAAmB;IAAnB,wBAAA,EAAA,mBAAmB;IAEhG,OAAO,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,2BAA2B,EAAE,aAAa,CAAC,EAAE,gBAAgB,CAAC,EAAE,IAAI,CAAC,EAAE,QAAQ,UAAA,EAAE,OAAO,SAAA,EAAE,CAAC,CAAC,CAAC;AACxI,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAgB,SAAS,CAC3B,CAAqB,EACrB,UAA6B,EAC7B,IAAiB,EACjB,aAAqB,EACrB,YAAoB,EACpB,SAA6B;IAF7B,8BAAA,EAAA,qBAAqB;IACrB,6BAAA,EAAA,oBAAoB;;;;;;oBAGpB,kCAAkC;oBAClC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;wBAC5B,UAAU,GAAG,CAAC,UAAU,CAAC,CAAC;qBAC7B;oBAEK,OAAO,GAAG,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,UAAA,KAAK;wBACpC,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;oBAC1B,CAAC,CAAC,CAAC,CAAC;oBACE,UAAU,GAAG,IAAI,KAAK,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;oBAIhF,CAAC,GAAG,6BAA6B,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;oBAC3D,qBAAM,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,qBAAmB,UAAY,CAAC,CAAC,GAAG,EAAE,EAAA;;oBAAxE,GAAG,GAAG,SAAkE;oBAC9E,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE;wBACvC,MAAM,KAAK,CAAC,yDAAuD,UAAY,CAAC,CAAC;qBACpF;oBACG,QAAQ,GAAG;wBACX,2BAA2B,EAAE,aAAa;wBAC1C,iBAAiB,EAAE,OAAO;wBAC1B,YAAY,EAAE,YAAY;wBAC1B,SAAS,EAAE,UAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,EAAI;wBAC9B,kBAAkB,EAAE,IAAI;qBAC3B,CAAC;oBACF,IAAI,SAAS,KAAK,SAAS,EAAE;wBACzB,QAAQ,GAAG,MAAM,CAAC,QAAQ,EAAE;4BACxB,SAAS,EAAE,SAAS,CAAC,IAAI;4BACzB,YAAY,EAAE,SAAS,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;4BACtE,SAAS,EAAE,IAAI;yBAClB,CAAC,CAAC;qBACN;oBAED,sBAAO,MAAM,CAAiB,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,2BAA2B,EAAE,aAAa,CAAC,EAAE,cAAc,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAC;;;;CACrI;AAED,SAAS,sBAAsB,CAAC,CAAqB,EAAE,OAAY;IAE/D,IAAM,CAAC,GAAG,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,0BAA0B,CAAC,EAAE,2BAA2B,CAAC,CAAC;IAChH,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IACnB,OAAO,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,yBAAyB,EAAE,kBAAkB,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;AAC1F,CAAC;AAED;;;;;GAKG;AACH,SAAe,YAAY,CAAC,IAAiB,EAAE,KAAe;;;;;;yBAGtD,CAAA,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,CAAA,EAArC,wBAAqC;oBAE7B,KAAA,KAAK,CAAA;;6BACJ,QAAQ,CAAC,WAAW,CAAC,CAArB,wBAAoB;6BAIpB,QAAQ,CAAC,MAAM,CAAC,CAAhB,wBAAe;6BACf,QAAQ,CAAC,KAAK,CAAC,CAAf,wBAAc;;;wBAJJ,qBAAM,GAAG,CAAC,UAAU,EAAE,uBAAuB,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAkB,EAAA;;oBAAtG,EAAE,GAAG,SAAiG;oBAC5G,sBAAO,YAAU,EAAE,CAAC,EAAI,EAAC;wBAId,qBAAM,GAAG,CAAC,UAAU,EAAE,wBAAwB,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAkB,EAAA;;oBAAvG,EAAE,GAAG,SAAkG;oBAC7G,sBAAO,YAAU,EAAE,CAAC,EAAI,EAAC;wBAGzB,MAAM,KAAK,CAAC,iGAAiG,CAAC,CAAC;;;oBAIjH,UAAU,GAAG,IAAI,KAAK,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;oBAC1E,qBAAM,eAAe,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,qBAAmB,UAAY,CAAC,EAAoB,EAAA;;oBAAvH,GAAG,GAAG,SAAiH;oBAC7H,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE;wBAChB,MAAM,KAAK,CAAC,4FAA4F,CAAC,CAAC;qBAC7G;oBACD,sBAAO,WAAS,GAAG,CAAC,CAAC,CAAC,CAAC,EAAI,EAAC;;;;;CAEnC"}
1
+ {"version":3,"file":"funcs.js","sourceRoot":"","sources":["../../../../../packages/sp/sharing/funcs.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAClC,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,6BAA6B,EAAE,2BAA2B,EAAE,MAAM,2BAA2B,CAAC;AACvG,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAC;AACvC,OAAO,EAGH,WAAW,EAUX,QAAQ,GACX,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAE9C;;;;;GAKG;AACH,MAAM,UAAgB,WAAW,CAAC,CAAqB,EAAE,OAA4B,EAAE,MAAc;IAAd,uBAAA,EAAA,cAAc;;;;;;oBAEjG,IAAI,MAAM,EAAE;wBAER,iFAAiF;wBACjF,sBAAO,sBAAsB,CAAC,CAAC,EAAE,OAAO,CAAC,EAAC;qBAC7C;oBAED,wCAAwC;oBACxC,OAAO,GAAG,MAAM,CAAC,OAAO,EAAE;wBACtB,KAAK,EAAE,IAAI;wBACX,2BAA2B,EAAE,KAAK;wBAClC,YAAY,EAAE,KAAK;wBACnB,kBAAkB,EAAE,IAAI;qBAC3B,EAAE,IAAI,CAAC,CAAC;oBAES,qBAAM,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,EAAA;;oBAA3D,SAAS,GAAG,SAA+C;oBAEjE,kCAAkC;oBAClC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;wBACpC,OAAO,CAAC,UAAU,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;qBAC7C;oBAEK,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,UAAA,GAAG,IAAI,OAAA,CAAC,EAAE,GAAG,KAAA,EAAE,CAAC,EAAT,CAAS,CAAC,CAAC,CAAC;oBAE1D,QAAQ,GAAG;wBACX,iBAAiB,EAAE,OAAO;wBAC1B,SAAS,EAAE,SAAS;wBACpB,GAAG,EAAE,OAAO,CAAC,GAAG;qBACnB,CAAC;oBAEF,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,IAAI,OAAO,CAAC,SAAS,KAAK,IAAI,EAAE;wBAC/D,QAAQ,GAAG,MAAM,CAAC,QAAQ,EAAE;4BACxB,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,IAAI;4BACjC,YAAY,EAAE,OAAO,CAAC,SAAS,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,kBAAkB;4BACtG,SAAS,EAAE,IAAI;yBAClB,CAAC,CAAC;qBACN;oBAED,sBAAO,sBAAsB,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAC;;;;CAC9C;AAED;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAA2B,IAAqB,EAAE,UAAuB;IAAvB,2BAAA,EAAA,iBAAuB;IAEjG,yCAAyC;IACzC,IAAM,SAAS,GAAG,UAAU,KAAK,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IAExE,+CAA+C;IAC/C,IAAM,CAAC,GAAG,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,2BAA2B,EAAE,WAAW,CAAC,EAAE,iBAAiB,CAAC,CAAC;IACjG,OAAO,MAAM,CAAqB,CAAC,EAAE,IAAI,CAAC;QACtC,OAAO,EAAE;YACL,UAAU,EAAE,IAAI;YAChB,SAAS,EAAE,IAAI;YACf,QAAQ,EAAE;gBACN,UAAU,EAAE,SAAS;gBACrB,QAAQ,EAAE,IAAI;aACjB;SACJ;KACJ,CAAC,CAAC,CAAC;AACR,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAA2B,UAA+B;IAEtF,IAAM,CAAC,GAAG,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,2BAA2B,EAAE,kBAAkB,CAAC,EAAE,qBAAqB,CAAC,CAAC;IAC5G,OAAO,MAAM,CAA6B,CAAC,EAAE,IAAI,CAAC,EAAE,UAAU,YAAA,EAAE,CAAC,CAAC,CAAC;AACvE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,qBAAqB,CAA2B,OAA0C,EAAE,OAAsB;IAAlE,wBAAA,EAAA,cAA0C;IAAE,wBAAA,EAAA,YAAsB;IAE9H,IAAM,CAAC,GAAG,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,2BAA2B,EAAE,uBAAuB,CAAC,EAAE,0BAA0B,CAAC,CAAC;IACtH,OAAO,MAAM,CAAC,CAAC,CAAC,MAAM,OAAR,CAAC,2BAAW,OAAO,YAAG,IAAI,CAAC,EAAE,OAAO,SAAA,EAAE,CAAC,CAAC,CAAC;AAC3D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,wBAAwB,CAA2B,kBAAyB;IAAzB,mCAAA,EAAA,yBAAyB;IAExF,IAAM,CAAC,GAAG,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,2BAA2B,EAAE,0BAA0B,CAAC,EAAE,6BAA6B,CAAC,CAAC;IAC5H,OAAO,MAAM,CAAyB,CAAC,EAAE,IAAI,CAAC,EAAE,kBAAkB,oBAAA,EAAE,CAAC,CAAC,CAAC;AAC3E,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa;IAEzB,OAAO,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,2BAA2B,EAAE,eAAe,CAAC,EAAE,kBAAkB,CAAC,CAAC,CAAC;AAC/G,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAA2B,QAAyB;IAEhF,OAAO,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,2BAA2B,EAAE,kBAAkB,CAAC,EAAE,qBAAqB,CAAC,EAAE,IAAI,CAAC,EAAE,QAAQ,UAAA,EAAE,CAAC,CAAC,CAAC;AACzI,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAA2B,QAAyB,EAAE,OAAmB;IAAnB,wBAAA,EAAA,mBAAmB;IAEhG,OAAO,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,2BAA2B,EAAE,aAAa,CAAC,EAAE,gBAAgB,CAAC,EAAE,IAAI,CAAC,EAAE,QAAQ,UAAA,EAAE,OAAO,SAAA,EAAE,CAAC,CAAC,CAAC;AACxI,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAgB,SAAS,CAC3B,CAAqB,EACrB,UAA6B,EAC7B,IAAiB,EACjB,aAAqB,EACrB,YAAoB,EACpB,SAA6B;IAF7B,8BAAA,EAAA,qBAAqB;IACrB,6BAAA,EAAA,oBAAoB;;;;;;oBAGpB,kCAAkC;oBAClC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;wBAC5B,UAAU,GAAG,CAAC,UAAU,CAAC,CAAC;qBAC7B;oBAEK,OAAO,GAAG,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,UAAA,KAAK;wBACpC,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;oBAC1B,CAAC,CAAC,CAAC,CAAC;oBACE,UAAU,GAAG,IAAI,KAAK,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;oBAIhF,CAAC,GAAG,6BAA6B,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;oBAC3D,qBAAM,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,qBAAmB,UAAY,CAAC,CAAC,GAAG,EAAE,EAAA;;oBAAxE,GAAG,GAAG,SAAkE;oBAC9E,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE;wBACvC,MAAM,KAAK,CAAC,yDAAuD,UAAY,CAAC,CAAC;qBACpF;oBACG,QAAQ,GAAG;wBACX,2BAA2B,EAAE,aAAa;wBAC1C,iBAAiB,EAAE,OAAO;wBAC1B,YAAY,EAAE,YAAY;wBAC1B,SAAS,EAAE,UAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,EAAI;wBAC9B,kBAAkB,EAAE,IAAI;qBAC3B,CAAC;oBACF,IAAI,SAAS,KAAK,SAAS,EAAE;wBACzB,QAAQ,GAAG,MAAM,CAAC,QAAQ,EAAE;4BACxB,SAAS,EAAE,SAAS,CAAC,IAAI;4BACzB,YAAY,EAAE,SAAS,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;4BACtE,SAAS,EAAE,IAAI;yBAClB,CAAC,CAAC;qBACN;oBAED,sBAAO,MAAM,CAAiB,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,2BAA2B,EAAE,aAAa,CAAC,EAAE,cAAc,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAC;;;;CACrI;AAED,SAAS,sBAAsB,CAAC,CAAqB,EAAE,OAAY;IAE/D,IAAM,CAAC,GAAG,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,0BAA0B,CAAC,EAAE,2BAA2B,CAAC,CAAC;IAChH,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IACnB,OAAO,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,yBAAyB,EAAE,kBAAkB,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;AAC1F,CAAC;AAED;;;;;GAKG;AACH,SAAe,YAAY,CAAC,IAAiB,EAAE,KAAe;;;;;;yBAGtD,CAAA,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,CAAA,EAArC,wBAAqC;oBAE7B,KAAA,KAAK,CAAA;;6BACJ,QAAQ,CAAC,WAAW,CAAC,CAArB,wBAAoB;6BAIpB,QAAQ,CAAC,MAAM,CAAC,CAAhB,wBAAe;6BACf,QAAQ,CAAC,KAAK,CAAC,CAAf,wBAAc;;;wBAJJ,qBAAM,GAAG,CAAC,UAAU,EAAE,uBAAuB,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAkB,EAAA;;oBAAtG,EAAE,GAAG,SAAiG;oBAC5G,sBAAO,YAAU,EAAE,CAAC,EAAI,EAAC;wBAId,qBAAM,GAAG,CAAC,UAAU,EAAE,wBAAwB,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAkB,EAAA;;oBAAvG,EAAE,GAAG,SAAkG;oBAC7G,sBAAO,YAAU,EAAE,CAAC,EAAI,EAAC;wBAGzB,MAAM,KAAK,CAAC,iGAAiG,CAAC,CAAC;;;oBAIjH,UAAU,GAAG,IAAI,KAAK,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;oBAC1E,qBAAM,eAAe,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,qBAAmB,UAAY,CAAC,EAAoB,EAAA;;oBAAvH,GAAG,GAAG,SAAiH;oBAC7H,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE;wBAChB,MAAM,KAAK,CAAC,4FAA4F,CAAC,CAAC;qBAC7G;oBACD,sBAAO,WAAS,GAAG,CAAC,CAAC,CAAC,CAAC,EAAI,EAAC;;;;;CAEnC"}
@@ -1,6 +1,6 @@
1
- import "./file.js";
2
- import "./folder.js";
3
- import "./item.js";
4
- import "./web.js";
5
- export { ISharingEmailData, ISharingEntityPermission, ISharingInformation, ISharingInformationRequest, ISharingLinkInfo, ISharingRecipient, ISharingResult, IUserSharingResult, SPSharedObjectType, SharingDomainRestrictionMode, SharingLinkKind, SharingOperationStatusCode, SharingRole, IInvitationCreationResult, IObjectSharingSettings, IShareLinkRequest, IShareLinkResponse, IShareLinkSettings, IShareObjectOptions, RoleType, } from "./types.js";
1
+ import "./file.js";
2
+ import "./folder.js";
3
+ import "./item.js";
4
+ import "./web.js";
5
+ export { ISharingEmailData, ISharingEntityPermission, ISharingInformation, ISharingInformationRequest, ISharingLinkInfo, ISharingRecipient, ISharingResult, IUserSharingResult, SPSharedObjectType, SharingDomainRestrictionMode, SharingLinkKind, SharingOperationStatusCode, SharingRole, IInvitationCreationResult, IObjectSharingSettings, IShareLinkRequest, IShareLinkResponse, IShareLinkSettings, IShareObjectOptions, RoleType, } from "./types.js";
6
6
  //# sourceMappingURL=index.d.ts.map
package/sharing/index.js CHANGED
@@ -1,6 +1,6 @@
1
- import "./file.js";
2
- import "./folder.js";
3
- import "./item.js";
4
- import "./web.js";
5
- export { SPSharedObjectType, SharingDomainRestrictionMode, SharingLinkKind, SharingOperationStatusCode, SharingRole, RoleType, } from "./types.js";
1
+ import "./file.js";
2
+ import "./folder.js";
3
+ import "./item.js";
4
+ import "./web.js";
5
+ export { SPSharedObjectType, SharingDomainRestrictionMode, SharingLinkKind, SharingOperationStatusCode, SharingRole, RoleType, } from "./types.js";
6
6
  //# sourceMappingURL=index.js.map
package/sharing/item.d.ts CHANGED
@@ -1,17 +1,17 @@
1
- import { ISharingEmailData, ISharingResult, SharingRole, ISharedFuncs } from "./types.js";
2
- declare module "../items/types" {
3
- interface _Item extends ISharedFuncs {
4
- shareWith(loginNames: string | string[], role?: SharingRole, requireSignin?: boolean, emailData?: ISharingEmailData): Promise<ISharingResult>;
5
- }
6
- interface IItem extends ISharedFuncs {
7
- /**
8
- * Shares this item with one or more users
9
- *
10
- * @param loginNames string or string[] of resolved login names to which this item will be shared
11
- * @param role The role (View | Edit) applied to the share
12
- * @param emailData Optional, if inlucded an email will be sent. Note subject currently has no effect.
13
- */
14
- shareWith(loginNames: string | string[], role?: SharingRole, requireSignin?: boolean, emailData?: ISharingEmailData): Promise<ISharingResult>;
15
- }
16
- }
1
+ import { ISharingEmailData, ISharingResult, SharingRole, ISharedFuncs } from "./types.js";
2
+ declare module "../items/types" {
3
+ interface _Item extends ISharedFuncs {
4
+ shareWith(loginNames: string | string[], role?: SharingRole, requireSignin?: boolean, emailData?: ISharingEmailData): Promise<ISharingResult>;
5
+ }
6
+ interface IItem extends ISharedFuncs {
7
+ /**
8
+ * Shares this item with one or more users
9
+ *
10
+ * @param loginNames string or string[] of resolved login names to which this item will be shared
11
+ * @param role The role (View | Edit) applied to the share
12
+ * @param emailData Optional, if inlucded an email will be sent. Note subject currently has no effect.
13
+ */
14
+ shareWith(loginNames: string | string[], role?: SharingRole, requireSignin?: boolean, emailData?: ISharingEmailData): Promise<ISharingResult>;
15
+ }
16
+ }
17
17
  //# sourceMappingURL=item.d.ts.map
package/sharing/item.js CHANGED
@@ -1,16 +1,16 @@
1
- import { _Item } from "../items/types.js";
2
- import { SharingRole, } from "./types.js";
3
- import { shareWith, getShareLink, checkPermissions, getSharingInformation, getObjectSharingSettings, unshareObject, deleteLinkByKind, unshareLink, } from "./funcs.js";
4
- _Item.prototype.shareWith = function (loginNames, role, requireSignin, emailData) {
5
- if (role === void 0) { role = SharingRole.View; }
6
- if (requireSignin === void 0) { requireSignin = false; }
7
- return shareWith(this, loginNames, role, requireSignin, false, emailData);
8
- };
9
- _Item.prototype.getShareLink = getShareLink;
10
- _Item.prototype.checkSharingPermissions = checkPermissions;
11
- _Item.prototype.getSharingInformation = getSharingInformation;
12
- _Item.prototype.getObjectSharingSettings = getObjectSharingSettings;
13
- _Item.prototype.unshare = unshareObject;
14
- _Item.prototype.deleteSharingLinkByKind = deleteLinkByKind;
15
- _Item.prototype.unshareLink = unshareLink;
1
+ import { _Item } from "../items/types.js";
2
+ import { SharingRole, } from "./types.js";
3
+ import { shareWith, getShareLink, checkPermissions, getSharingInformation, getObjectSharingSettings, unshareObject, deleteLinkByKind, unshareLink, } from "./funcs.js";
4
+ _Item.prototype.shareWith = function (loginNames, role, requireSignin, emailData) {
5
+ if (role === void 0) { role = SharingRole.View; }
6
+ if (requireSignin === void 0) { requireSignin = false; }
7
+ return shareWith(this, loginNames, role, requireSignin, false, emailData);
8
+ };
9
+ _Item.prototype.getShareLink = getShareLink;
10
+ _Item.prototype.checkSharingPermissions = checkPermissions;
11
+ _Item.prototype.getSharingInformation = getSharingInformation;
12
+ _Item.prototype.getObjectSharingSettings = getObjectSharingSettings;
13
+ _Item.prototype.unshare = unshareObject;
14
+ _Item.prototype.deleteSharingLinkByKind = deleteLinkByKind;
15
+ _Item.prototype.unshareLink = unshareLink;
16
16
  //# sourceMappingURL=item.js.map