@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/file.js CHANGED
@@ -1,117 +1,117 @@
1
- import { __awaiter, __generator } from "tslib";
2
- import { _File } from "../files/types.js";
3
- import { SharingRole, } from "./types.js";
4
- import { emptyGuid } from "../splibconfig.js";
5
- _File.prototype.shareWith = function (loginNames, role, requireSignin, emailData) {
6
- if (role === void 0) { role = SharingRole.View; }
7
- if (requireSignin === void 0) { requireSignin = false; }
8
- return __awaiter(this, void 0, void 0, function () {
9
- var item;
10
- return __generator(this, function (_a) {
11
- switch (_a.label) {
12
- case 0: return [4 /*yield*/, this.getItem()];
13
- case 1:
14
- item = _a.sent();
15
- return [2 /*return*/, item.shareWith(loginNames, role, requireSignin, emailData)];
16
- }
17
- });
18
- });
19
- };
20
- _File.prototype.getShareLink = function (kind, expiration) {
21
- if (expiration === void 0) { expiration = null; }
22
- return __awaiter(this, void 0, void 0, function () {
23
- var item;
24
- return __generator(this, function (_a) {
25
- switch (_a.label) {
26
- case 0: return [4 /*yield*/, this.getItem()];
27
- case 1:
28
- item = _a.sent();
29
- return [2 /*return*/, item.getShareLink(kind, expiration)];
30
- }
31
- });
32
- });
33
- };
34
- _File.prototype.checkSharingPermissions = function (recipients) {
35
- return __awaiter(this, void 0, void 0, function () {
36
- var item;
37
- return __generator(this, function (_a) {
38
- switch (_a.label) {
39
- case 0: return [4 /*yield*/, this.getItem()];
40
- case 1:
41
- item = _a.sent();
42
- return [2 /*return*/, item.checkSharingPermissions(recipients)];
43
- }
44
- });
45
- });
46
- };
47
- // eslint-disable-next-line max-len
48
- _File.prototype.getSharingInformation = function (request, expands) {
49
- if (request === void 0) { request = null; }
50
- if (expands === void 0) { expands = []; }
51
- return __awaiter(this, void 0, void 0, function () {
52
- var item;
53
- return __generator(this, function (_a) {
54
- switch (_a.label) {
55
- case 0: return [4 /*yield*/, this.getItem()];
56
- case 1:
57
- item = _a.sent();
58
- return [2 /*return*/, item.getSharingInformation(request, expands)];
59
- }
60
- });
61
- });
62
- };
63
- _File.prototype.getObjectSharingSettings = function (useSimplifiedRoles) {
64
- if (useSimplifiedRoles === void 0) { useSimplifiedRoles = true; }
65
- return __awaiter(this, void 0, void 0, function () {
66
- var item;
67
- return __generator(this, function (_a) {
68
- switch (_a.label) {
69
- case 0: return [4 /*yield*/, this.getItem()];
70
- case 1:
71
- item = _a.sent();
72
- return [2 /*return*/, item.getObjectSharingSettings(useSimplifiedRoles)];
73
- }
74
- });
75
- });
76
- };
77
- _File.prototype.unshare = function () {
78
- return __awaiter(this, void 0, void 0, function () {
79
- var item;
80
- return __generator(this, function (_a) {
81
- switch (_a.label) {
82
- case 0: return [4 /*yield*/, this.getItem()];
83
- case 1:
84
- item = _a.sent();
85
- return [2 /*return*/, item.unshare()];
86
- }
87
- });
88
- });
89
- };
90
- _File.prototype.deleteSharingLinkByKind = function (linkKind) {
91
- return __awaiter(this, void 0, void 0, function () {
92
- var item;
93
- return __generator(this, function (_a) {
94
- switch (_a.label) {
95
- case 0: return [4 /*yield*/, this.getItem()];
96
- case 1:
97
- item = _a.sent();
98
- return [2 /*return*/, item.deleteSharingLinkByKind(linkKind)];
99
- }
100
- });
101
- });
102
- };
103
- _File.prototype.unshareLink = function unshareLink(linkKind, shareId) {
104
- if (shareId === void 0) { shareId = emptyGuid; }
105
- return __awaiter(this, void 0, void 0, function () {
106
- var item;
107
- return __generator(this, function (_a) {
108
- switch (_a.label) {
109
- case 0: return [4 /*yield*/, this.getItem()];
110
- case 1:
111
- item = _a.sent();
112
- return [2 /*return*/, item.unshareLink(linkKind, shareId)];
113
- }
114
- });
115
- });
116
- };
1
+ import { __awaiter, __generator } from "tslib";
2
+ import { _File } from "../files/types.js";
3
+ import { SharingRole, } from "./types.js";
4
+ import { emptyGuid } from "../splibconfig.js";
5
+ _File.prototype.shareWith = function (loginNames, role, requireSignin, emailData) {
6
+ if (role === void 0) { role = SharingRole.View; }
7
+ if (requireSignin === void 0) { requireSignin = false; }
8
+ return __awaiter(this, void 0, void 0, function () {
9
+ var item;
10
+ return __generator(this, function (_a) {
11
+ switch (_a.label) {
12
+ case 0: return [4 /*yield*/, this.getItem()];
13
+ case 1:
14
+ item = _a.sent();
15
+ return [2 /*return*/, item.shareWith(loginNames, role, requireSignin, emailData)];
16
+ }
17
+ });
18
+ });
19
+ };
20
+ _File.prototype.getShareLink = function (kind, expiration) {
21
+ if (expiration === void 0) { expiration = null; }
22
+ return __awaiter(this, void 0, void 0, function () {
23
+ var item;
24
+ return __generator(this, function (_a) {
25
+ switch (_a.label) {
26
+ case 0: return [4 /*yield*/, this.getItem()];
27
+ case 1:
28
+ item = _a.sent();
29
+ return [2 /*return*/, item.getShareLink(kind, expiration)];
30
+ }
31
+ });
32
+ });
33
+ };
34
+ _File.prototype.checkSharingPermissions = function (recipients) {
35
+ return __awaiter(this, void 0, void 0, function () {
36
+ var item;
37
+ return __generator(this, function (_a) {
38
+ switch (_a.label) {
39
+ case 0: return [4 /*yield*/, this.getItem()];
40
+ case 1:
41
+ item = _a.sent();
42
+ return [2 /*return*/, item.checkSharingPermissions(recipients)];
43
+ }
44
+ });
45
+ });
46
+ };
47
+ // eslint-disable-next-line max-len
48
+ _File.prototype.getSharingInformation = function (request, expands) {
49
+ if (request === void 0) { request = null; }
50
+ if (expands === void 0) { expands = []; }
51
+ return __awaiter(this, void 0, void 0, function () {
52
+ var item;
53
+ return __generator(this, function (_a) {
54
+ switch (_a.label) {
55
+ case 0: return [4 /*yield*/, this.getItem()];
56
+ case 1:
57
+ item = _a.sent();
58
+ return [2 /*return*/, item.getSharingInformation(request, expands)];
59
+ }
60
+ });
61
+ });
62
+ };
63
+ _File.prototype.getObjectSharingSettings = function (useSimplifiedRoles) {
64
+ if (useSimplifiedRoles === void 0) { useSimplifiedRoles = true; }
65
+ return __awaiter(this, void 0, void 0, function () {
66
+ var item;
67
+ return __generator(this, function (_a) {
68
+ switch (_a.label) {
69
+ case 0: return [4 /*yield*/, this.getItem()];
70
+ case 1:
71
+ item = _a.sent();
72
+ return [2 /*return*/, item.getObjectSharingSettings(useSimplifiedRoles)];
73
+ }
74
+ });
75
+ });
76
+ };
77
+ _File.prototype.unshare = function () {
78
+ return __awaiter(this, void 0, void 0, function () {
79
+ var item;
80
+ return __generator(this, function (_a) {
81
+ switch (_a.label) {
82
+ case 0: return [4 /*yield*/, this.getItem()];
83
+ case 1:
84
+ item = _a.sent();
85
+ return [2 /*return*/, item.unshare()];
86
+ }
87
+ });
88
+ });
89
+ };
90
+ _File.prototype.deleteSharingLinkByKind = function (linkKind) {
91
+ return __awaiter(this, void 0, void 0, function () {
92
+ var item;
93
+ return __generator(this, function (_a) {
94
+ switch (_a.label) {
95
+ case 0: return [4 /*yield*/, this.getItem()];
96
+ case 1:
97
+ item = _a.sent();
98
+ return [2 /*return*/, item.deleteSharingLinkByKind(linkKind)];
99
+ }
100
+ });
101
+ });
102
+ };
103
+ _File.prototype.unshareLink = function unshareLink(linkKind, shareId) {
104
+ if (shareId === void 0) { shareId = emptyGuid; }
105
+ return __awaiter(this, void 0, void 0, function () {
106
+ var item;
107
+ return __generator(this, function (_a) {
108
+ switch (_a.label) {
109
+ case 0: return [4 /*yield*/, this.getItem()];
110
+ case 1:
111
+ item = _a.sent();
112
+ return [2 /*return*/, item.unshareLink(linkKind, shareId)];
113
+ }
114
+ });
115
+ });
116
+ };
117
117
  //# sourceMappingURL=file.js.map
@@ -1,10 +1,10 @@
1
- import { ISharingEmailData, ISharingResult, SharingRole, ISharedFuncs } from "./types.js";
2
- declare module "../folders/types" {
3
- interface _Folder extends ISharedFuncs {
4
- shareWith(loginNames: string | string[], role?: SharingRole, requireSignin?: boolean, shareEverything?: boolean, emailData?: ISharingEmailData): Promise<ISharingResult>;
5
- }
6
- interface IFolder extends ISharedFuncs {
7
- shareWith(loginNames: string | string[], role?: SharingRole, requireSignin?: boolean, shareEverything?: boolean, emailData?: ISharingEmailData): Promise<ISharingResult>;
8
- }
9
- }
1
+ import { ISharingEmailData, ISharingResult, SharingRole, ISharedFuncs } from "./types.js";
2
+ declare module "../folders/types" {
3
+ interface _Folder extends ISharedFuncs {
4
+ shareWith(loginNames: string | string[], role?: SharingRole, requireSignin?: boolean, shareEverything?: boolean, emailData?: ISharingEmailData): Promise<ISharingResult>;
5
+ }
6
+ interface IFolder extends ISharedFuncs {
7
+ shareWith(loginNames: string | string[], role?: SharingRole, requireSignin?: boolean, shareEverything?: boolean, emailData?: ISharingEmailData): Promise<ISharingResult>;
8
+ }
9
+ }
10
10
  //# sourceMappingURL=folder.d.ts.map
package/sharing/folder.js CHANGED
@@ -1,137 +1,137 @@
1
- import { __awaiter, __generator } from "tslib";
2
- import { _Folder, } from "../folders/types.js";
3
- import { SharingRole, } from "./types.js";
4
- _Folder.prototype.shareWith = function (loginNames, role, requireSignin, shareEverything, emailData) {
5
- if (role === void 0) { role = SharingRole.View; }
6
- if (requireSignin === void 0) { requireSignin = false; }
7
- if (shareEverything === void 0) { shareEverything = false; }
8
- return __awaiter(this, void 0, void 0, function () {
9
- var dependency, shareable;
10
- return __generator(this, function (_a) {
11
- switch (_a.label) {
12
- case 0:
13
- dependency = this.addBatchDependency();
14
- return [4 /*yield*/, this.getShareable()];
15
- case 1:
16
- shareable = _a.sent();
17
- dependency();
18
- return [2 /*return*/, shareable.shareWith(loginNames, role, requireSignin, shareEverything, emailData)];
19
- }
20
- });
21
- });
22
- };
23
- _Folder.prototype.getShareLink = function (kind, expiration) {
24
- if (expiration === void 0) { expiration = null; }
25
- return __awaiter(this, void 0, void 0, function () {
26
- var dependency, shareable;
27
- return __generator(this, function (_a) {
28
- switch (_a.label) {
29
- case 0:
30
- dependency = this.addBatchDependency();
31
- return [4 /*yield*/, this.getShareable()];
32
- case 1:
33
- shareable = _a.sent();
34
- dependency();
35
- return [2 /*return*/, shareable.getShareLink(kind, expiration)];
36
- }
37
- });
38
- });
39
- };
40
- _Folder.prototype.checkSharingPermissions = function (recipients) {
41
- return __awaiter(this, void 0, void 0, function () {
42
- var dependency, shareable;
43
- return __generator(this, function (_a) {
44
- switch (_a.label) {
45
- case 0:
46
- dependency = this.addBatchDependency();
47
- return [4 /*yield*/, this.getShareable()];
48
- case 1:
49
- shareable = _a.sent();
50
- dependency();
51
- return [2 /*return*/, shareable.checkSharingPermissions(recipients)];
52
- }
53
- });
54
- });
55
- };
56
- _Folder.prototype.getSharingInformation = function (request, expands) {
57
- return __awaiter(this, void 0, void 0, function () {
58
- var dependency, shareable;
59
- return __generator(this, function (_a) {
60
- switch (_a.label) {
61
- case 0:
62
- dependency = this.addBatchDependency();
63
- return [4 /*yield*/, this.getShareable()];
64
- case 1:
65
- shareable = _a.sent();
66
- dependency();
67
- return [2 /*return*/, shareable.getSharingInformation(request, expands)];
68
- }
69
- });
70
- });
71
- };
72
- _Folder.prototype.getObjectSharingSettings = function (useSimplifiedRoles) {
73
- if (useSimplifiedRoles === void 0) { useSimplifiedRoles = true; }
74
- return __awaiter(this, void 0, void 0, function () {
75
- var dependency, shareable;
76
- return __generator(this, function (_a) {
77
- switch (_a.label) {
78
- case 0:
79
- dependency = this.addBatchDependency();
80
- return [4 /*yield*/, this.getShareable()];
81
- case 1:
82
- shareable = _a.sent();
83
- dependency();
84
- return [2 /*return*/, shareable.getObjectSharingSettings(useSimplifiedRoles)];
85
- }
86
- });
87
- });
88
- };
89
- _Folder.prototype.unshare = function () {
90
- return __awaiter(this, void 0, void 0, function () {
91
- var dependency, shareable;
92
- return __generator(this, function (_a) {
93
- switch (_a.label) {
94
- case 0:
95
- dependency = this.addBatchDependency();
96
- return [4 /*yield*/, this.getShareable()];
97
- case 1:
98
- shareable = _a.sent();
99
- dependency();
100
- return [2 /*return*/, shareable.unshare()];
101
- }
102
- });
103
- });
104
- };
105
- _Folder.prototype.deleteSharingLinkByKind = function (kind) {
106
- return __awaiter(this, void 0, void 0, function () {
107
- var dependency, shareable;
108
- return __generator(this, function (_a) {
109
- switch (_a.label) {
110
- case 0:
111
- dependency = this.addBatchDependency();
112
- return [4 /*yield*/, this.getShareable()];
113
- case 1:
114
- shareable = _a.sent();
115
- dependency();
116
- return [2 /*return*/, shareable.deleteSharingLinkByKind(kind)];
117
- }
118
- });
119
- });
120
- };
121
- _Folder.prototype.unshareLink = function (kind, shareId) {
122
- return __awaiter(this, void 0, void 0, function () {
123
- var dependency, shareable;
124
- return __generator(this, function (_a) {
125
- switch (_a.label) {
126
- case 0:
127
- dependency = this.addBatchDependency();
128
- return [4 /*yield*/, this.getShareable()];
129
- case 1:
130
- shareable = _a.sent();
131
- dependency();
132
- return [2 /*return*/, shareable.unshareLink(kind, shareId)];
133
- }
134
- });
135
- });
136
- };
1
+ import { __awaiter, __generator } from "tslib";
2
+ import { _Folder, } from "../folders/types.js";
3
+ import { SharingRole, } from "./types.js";
4
+ _Folder.prototype.shareWith = function (loginNames, role, requireSignin, shareEverything, emailData) {
5
+ if (role === void 0) { role = SharingRole.View; }
6
+ if (requireSignin === void 0) { requireSignin = false; }
7
+ if (shareEverything === void 0) { shareEverything = false; }
8
+ return __awaiter(this, void 0, void 0, function () {
9
+ var dependency, shareable;
10
+ return __generator(this, function (_a) {
11
+ switch (_a.label) {
12
+ case 0:
13
+ dependency = this.addBatchDependency();
14
+ return [4 /*yield*/, this.getShareable()];
15
+ case 1:
16
+ shareable = _a.sent();
17
+ dependency();
18
+ return [2 /*return*/, shareable.shareWith(loginNames, role, requireSignin, shareEverything, emailData)];
19
+ }
20
+ });
21
+ });
22
+ };
23
+ _Folder.prototype.getShareLink = function (kind, expiration) {
24
+ if (expiration === void 0) { expiration = null; }
25
+ return __awaiter(this, void 0, void 0, function () {
26
+ var dependency, shareable;
27
+ return __generator(this, function (_a) {
28
+ switch (_a.label) {
29
+ case 0:
30
+ dependency = this.addBatchDependency();
31
+ return [4 /*yield*/, this.getShareable()];
32
+ case 1:
33
+ shareable = _a.sent();
34
+ dependency();
35
+ return [2 /*return*/, shareable.getShareLink(kind, expiration)];
36
+ }
37
+ });
38
+ });
39
+ };
40
+ _Folder.prototype.checkSharingPermissions = function (recipients) {
41
+ return __awaiter(this, void 0, void 0, function () {
42
+ var dependency, shareable;
43
+ return __generator(this, function (_a) {
44
+ switch (_a.label) {
45
+ case 0:
46
+ dependency = this.addBatchDependency();
47
+ return [4 /*yield*/, this.getShareable()];
48
+ case 1:
49
+ shareable = _a.sent();
50
+ dependency();
51
+ return [2 /*return*/, shareable.checkSharingPermissions(recipients)];
52
+ }
53
+ });
54
+ });
55
+ };
56
+ _Folder.prototype.getSharingInformation = function (request, expands) {
57
+ return __awaiter(this, void 0, void 0, function () {
58
+ var dependency, shareable;
59
+ return __generator(this, function (_a) {
60
+ switch (_a.label) {
61
+ case 0:
62
+ dependency = this.addBatchDependency();
63
+ return [4 /*yield*/, this.getShareable()];
64
+ case 1:
65
+ shareable = _a.sent();
66
+ dependency();
67
+ return [2 /*return*/, shareable.getSharingInformation(request, expands)];
68
+ }
69
+ });
70
+ });
71
+ };
72
+ _Folder.prototype.getObjectSharingSettings = function (useSimplifiedRoles) {
73
+ if (useSimplifiedRoles === void 0) { useSimplifiedRoles = true; }
74
+ return __awaiter(this, void 0, void 0, function () {
75
+ var dependency, shareable;
76
+ return __generator(this, function (_a) {
77
+ switch (_a.label) {
78
+ case 0:
79
+ dependency = this.addBatchDependency();
80
+ return [4 /*yield*/, this.getShareable()];
81
+ case 1:
82
+ shareable = _a.sent();
83
+ dependency();
84
+ return [2 /*return*/, shareable.getObjectSharingSettings(useSimplifiedRoles)];
85
+ }
86
+ });
87
+ });
88
+ };
89
+ _Folder.prototype.unshare = function () {
90
+ return __awaiter(this, void 0, void 0, function () {
91
+ var dependency, shareable;
92
+ return __generator(this, function (_a) {
93
+ switch (_a.label) {
94
+ case 0:
95
+ dependency = this.addBatchDependency();
96
+ return [4 /*yield*/, this.getShareable()];
97
+ case 1:
98
+ shareable = _a.sent();
99
+ dependency();
100
+ return [2 /*return*/, shareable.unshare()];
101
+ }
102
+ });
103
+ });
104
+ };
105
+ _Folder.prototype.deleteSharingLinkByKind = function (kind) {
106
+ return __awaiter(this, void 0, void 0, function () {
107
+ var dependency, shareable;
108
+ return __generator(this, function (_a) {
109
+ switch (_a.label) {
110
+ case 0:
111
+ dependency = this.addBatchDependency();
112
+ return [4 /*yield*/, this.getShareable()];
113
+ case 1:
114
+ shareable = _a.sent();
115
+ dependency();
116
+ return [2 /*return*/, shareable.deleteSharingLinkByKind(kind)];
117
+ }
118
+ });
119
+ });
120
+ };
121
+ _Folder.prototype.unshareLink = function (kind, shareId) {
122
+ return __awaiter(this, void 0, void 0, function () {
123
+ var dependency, shareable;
124
+ return __generator(this, function (_a) {
125
+ switch (_a.label) {
126
+ case 0:
127
+ dependency = this.addBatchDependency();
128
+ return [4 /*yield*/, this.getShareable()];
129
+ case 1:
130
+ shareable = _a.sent();
131
+ dependency();
132
+ return [2 /*return*/, shareable.unshareLink(kind, shareId)];
133
+ }
134
+ });
135
+ });
136
+ };
137
137
  //# sourceMappingURL=folder.js.map
@@ -1,63 +1,63 @@
1
- import { ShareableQueryable, ISharingResult, SharingRole, IShareObjectOptions, SharingLinkKind, IShareLinkResponse, ISharingInformationRequest, ISharingRecipient, ISharingEntityPermission, ISharingInformation, IObjectSharingSettings, ISharingEmailData } from "./types.js";
2
- /**
3
- * Shares an object based on the supplied options
4
- *
5
- * @param options The set of options to send to the ShareObject method
6
- * @param bypass If true any processing is skipped and the options are sent directly to the ShareObject method
7
- */
8
- export declare function shareObject(o: ShareableQueryable, options: IShareObjectOptions, bypass?: boolean): Promise<ISharingResult>;
9
- /**
10
- * Gets a sharing link for the supplied
11
- *
12
- * @param kind The kind of link to share
13
- * @param expiration The optional expiration for this link
14
- */
15
- export declare function getShareLink(this: ShareableQueryable, kind: SharingLinkKind, expiration?: Date): Promise<IShareLinkResponse>;
16
- /**
17
- * Checks Permissions on the list of Users and returns back role the users have on the Item.
18
- *
19
- * @param recipients The array of Entities for which Permissions need to be checked.
20
- */
21
- export declare function checkPermissions(this: ShareableQueryable, recipients: ISharingRecipient[]): Promise<ISharingEntityPermission[]>;
22
- /**
23
- * Get Sharing Information.
24
- *
25
- * @param request The SharingInformationRequest Object.
26
- * @param expands Expand more fields.
27
- *
28
- */
29
- export declare function getSharingInformation(this: ShareableQueryable, request?: ISharingInformationRequest, expands?: string[]): Promise<ISharingInformation>;
30
- /**
31
- * Gets the sharing settings of an item.
32
- *
33
- * @param useSimplifiedRoles Determines whether to use simplified roles.
34
- */
35
- export declare function getObjectSharingSettings(this: ShareableQueryable, useSimplifiedRoles?: boolean): Promise<IObjectSharingSettings>;
36
- /**
37
- * Unshares this object
38
- */
39
- export declare function unshareObject(this: ShareableQueryable): Promise<ISharingResult>;
40
- /**
41
- * Deletes a link by type
42
- *
43
- * @param kind Deletes a sharing link by the kind of link
44
- */
45
- export declare function deleteLinkByKind(this: ShareableQueryable, linkKind: SharingLinkKind): Promise<void>;
46
- /**
47
- * Removes the specified link to the item.
48
- *
49
- * @param kind The kind of link to be deleted.
50
- * @param shareId
51
- */
52
- export declare function unshareLink(this: ShareableQueryable, linkKind: SharingLinkKind, shareId?: string): Promise<void>;
53
- /**
54
- * Shares this instance with the supplied users
55
- *
56
- * @param loginNames Resolved login names to share
57
- * @param role The role
58
- * @param requireSignin True to require the user is authenticated, otherwise false
59
- * @param propagateAcl True to apply this share to all children
60
- * @param emailData If supplied an email will be sent with the indicated properties
61
- */
62
- export declare function shareWith(o: ShareableQueryable, loginNames: string | string[], role: SharingRole, requireSignin?: boolean, propagateAcl?: boolean, emailData?: ISharingEmailData): Promise<ISharingResult>;
1
+ import { ShareableQueryable, ISharingResult, SharingRole, IShareObjectOptions, SharingLinkKind, IShareLinkResponse, ISharingInformationRequest, ISharingRecipient, ISharingEntityPermission, ISharingInformation, IObjectSharingSettings, ISharingEmailData } from "./types.js";
2
+ /**
3
+ * Shares an object based on the supplied options
4
+ *
5
+ * @param options The set of options to send to the ShareObject method
6
+ * @param bypass If true any processing is skipped and the options are sent directly to the ShareObject method
7
+ */
8
+ export declare function shareObject(o: ShareableQueryable, options: IShareObjectOptions, bypass?: boolean): Promise<ISharingResult>;
9
+ /**
10
+ * Gets a sharing link for the supplied
11
+ *
12
+ * @param kind The kind of link to share
13
+ * @param expiration The optional expiration for this link
14
+ */
15
+ export declare function getShareLink(this: ShareableQueryable, kind: SharingLinkKind, expiration?: Date): Promise<IShareLinkResponse>;
16
+ /**
17
+ * Checks Permissions on the list of Users and returns back role the users have on the Item.
18
+ *
19
+ * @param recipients The array of Entities for which Permissions need to be checked.
20
+ */
21
+ export declare function checkPermissions(this: ShareableQueryable, recipients: ISharingRecipient[]): Promise<ISharingEntityPermission[]>;
22
+ /**
23
+ * Get Sharing Information.
24
+ *
25
+ * @param request The SharingInformationRequest Object.
26
+ * @param expands Expand more fields.
27
+ *
28
+ */
29
+ export declare function getSharingInformation(this: ShareableQueryable, request?: ISharingInformationRequest, expands?: string[]): Promise<ISharingInformation>;
30
+ /**
31
+ * Gets the sharing settings of an item.
32
+ *
33
+ * @param useSimplifiedRoles Determines whether to use simplified roles.
34
+ */
35
+ export declare function getObjectSharingSettings(this: ShareableQueryable, useSimplifiedRoles?: boolean): Promise<IObjectSharingSettings>;
36
+ /**
37
+ * Unshares this object
38
+ */
39
+ export declare function unshareObject(this: ShareableQueryable): Promise<ISharingResult>;
40
+ /**
41
+ * Deletes a link by type
42
+ *
43
+ * @param kind Deletes a sharing link by the kind of link
44
+ */
45
+ export declare function deleteLinkByKind(this: ShareableQueryable, linkKind: SharingLinkKind): Promise<void>;
46
+ /**
47
+ * Removes the specified link to the item.
48
+ *
49
+ * @param kind The kind of link to be deleted.
50
+ * @param shareId
51
+ */
52
+ export declare function unshareLink(this: ShareableQueryable, linkKind: SharingLinkKind, shareId?: string): Promise<void>;
53
+ /**
54
+ * Shares this instance with the supplied users
55
+ *
56
+ * @param loginNames Resolved login names to share
57
+ * @param role The role
58
+ * @param requireSignin True to require the user is authenticated, otherwise false
59
+ * @param propagateAcl True to apply this share to all children
60
+ * @param emailData If supplied an email will be sent with the indicated properties
61
+ */
62
+ export declare function shareWith(o: ShareableQueryable, loginNames: string | string[], role: SharingRole, requireSignin?: boolean, propagateAcl?: boolean, emailData?: ISharingEmailData): Promise<ISharingResult>;
63
63
  //# sourceMappingURL=funcs.d.ts.map