@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/social/types.js CHANGED
@@ -1,323 +1,323 @@
1
- import { __awaiter, __decorate, __extends, __generator } from "tslib";
2
- import { _SharePointQueryableInstance, spInvokableFactory, } from "../sharepointqueryable.js";
3
- import { defaultPath } from "../decorators.js";
4
- import { hOP } from "@pnp/common";
5
- import { metadata } from "../utils/metadata.js";
6
- import { body } from "@pnp/odata";
7
- import { spPost } from "../operations.js";
8
- import { tag } from "../telemetry.js";
9
- var _Social = /** @class */ (function (_super) {
10
- __extends(_Social, _super);
11
- function _Social() {
12
- return _super !== null && _super.apply(this, arguments) || this;
13
- }
14
- Object.defineProperty(_Social.prototype, "my", {
15
- get: function () {
16
- return MySocial(this);
17
- },
18
- enumerable: false,
19
- configurable: true
20
- });
21
- _Social.prototype.getFollowedSitesUri = function () {
22
- return __awaiter(this, void 0, void 0, function () {
23
- var r;
24
- return __generator(this, function (_a) {
25
- switch (_a.label) {
26
- case 0: return [4 /*yield*/, this.clone(SocialCloneFactory, "FollowedSitesUri").get()];
27
- case 1:
28
- r = _a.sent();
29
- return [2 /*return*/, r.FollowedSitesUri || r];
30
- }
31
- });
32
- });
33
- };
34
- _Social.prototype.getFollowedDocumentsUri = function () {
35
- return __awaiter(this, void 0, void 0, function () {
36
- var r;
37
- return __generator(this, function (_a) {
38
- switch (_a.label) {
39
- case 0: return [4 /*yield*/, this.clone(SocialCloneFactory, "FollowedDocumentsUri").get()];
40
- case 1:
41
- r = _a.sent();
42
- return [2 /*return*/, r.FollowedDocumentsUri || r];
43
- }
44
- });
45
- });
46
- };
47
- _Social.prototype.follow = function (actorInfo) {
48
- return __awaiter(this, void 0, void 0, function () {
49
- return __generator(this, function (_a) {
50
- switch (_a.label) {
51
- case 0: return [4 /*yield*/, spPost(this.clone(SocialCloneFactory, "follow"), this.createSocialActorInfoRequestBody(actorInfo))];
52
- case 1: return [2 /*return*/, _a.sent()];
53
- }
54
- });
55
- });
56
- };
57
- _Social.prototype.isFollowed = function (actorInfo) {
58
- return __awaiter(this, void 0, void 0, function () {
59
- return __generator(this, function (_a) {
60
- switch (_a.label) {
61
- case 0: return [4 /*yield*/, spPost(this.clone(SocialCloneFactory, "isfollowed"), this.createSocialActorInfoRequestBody(actorInfo))];
62
- case 1: return [2 /*return*/, _a.sent()];
63
- }
64
- });
65
- });
66
- };
67
- _Social.prototype.stopFollowing = function (actorInfo) {
68
- return __awaiter(this, void 0, void 0, function () {
69
- return __generator(this, function (_a) {
70
- switch (_a.label) {
71
- case 0: return [4 /*yield*/, spPost(this.clone(SocialCloneFactory, "stopfollowing"), this.createSocialActorInfoRequestBody(actorInfo))];
72
- case 1: return [2 /*return*/, _a.sent()];
73
- }
74
- });
75
- });
76
- };
77
- _Social.prototype.createSocialActorInfoRequestBody = function (actorInfo) {
78
- return body({
79
- "actor": Object.assign(metadata("SP.Social.SocialActorInfo"), {
80
- Id: null,
81
- }, actorInfo),
82
- });
83
- };
84
- __decorate([
85
- tag("soc.getFollowedSitesUri")
86
- ], _Social.prototype, "getFollowedSitesUri", null);
87
- __decorate([
88
- tag("soc.getFollowedDocumentsUri")
89
- ], _Social.prototype, "getFollowedDocumentsUri", null);
90
- __decorate([
91
- tag("soc.follow")
92
- ], _Social.prototype, "follow", null);
93
- __decorate([
94
- tag("soc.isFollowed")
95
- ], _Social.prototype, "isFollowed", null);
96
- __decorate([
97
- tag("soc.stopFollowing")
98
- ], _Social.prototype, "stopFollowing", null);
99
- _Social = __decorate([
100
- defaultPath("_api/social.following")
101
- ], _Social);
102
- return _Social;
103
- }(_SharePointQueryableInstance));
104
- export { _Social };
105
- /**
106
- * Get a new Social instance for the particular Url
107
- */
108
- export var Social = function (baseUrl) { return new _Social(baseUrl); };
109
- var SocialCloneFactory = function (baseUrl, paths) { return new _Social(baseUrl, paths); };
110
- /**
111
- * Current user's Social instance
112
- */
113
- var _MySocial = /** @class */ (function (_super) {
114
- __extends(_MySocial, _super);
115
- function _MySocial() {
116
- return _super !== null && _super.apply(this, arguments) || this;
117
- }
118
- _MySocial.prototype.followed = function (types) {
119
- return __awaiter(this, void 0, void 0, function () {
120
- var r;
121
- return __generator(this, function (_a) {
122
- switch (_a.label) {
123
- case 0: return [4 /*yield*/, this.clone(MySocialCloneFactory, "followed(types=" + types + ")")()];
124
- case 1:
125
- r = _a.sent();
126
- return [2 /*return*/, hOP(r, "Followed") ? r.Followed.results : r];
127
- }
128
- });
129
- });
130
- };
131
- _MySocial.prototype.followedCount = function (types) {
132
- return __awaiter(this, void 0, void 0, function () {
133
- var r;
134
- return __generator(this, function (_a) {
135
- switch (_a.label) {
136
- case 0: return [4 /*yield*/, this.clone(MySocialCloneFactory, "followedcount(types=" + types + ")")()];
137
- case 1:
138
- r = _a.sent();
139
- return [2 /*return*/, r.FollowedCount || r];
140
- }
141
- });
142
- });
143
- };
144
- _MySocial.prototype.followers = function () {
145
- return __awaiter(this, void 0, void 0, function () {
146
- var r;
147
- return __generator(this, function (_a) {
148
- switch (_a.label) {
149
- case 0: return [4 /*yield*/, this.clone(MySocialCloneFactory, "followers")()];
150
- case 1:
151
- r = _a.sent();
152
- return [2 /*return*/, hOP(r, "Followers") ? r.Followers.results : r];
153
- }
154
- });
155
- });
156
- };
157
- _MySocial.prototype.suggestions = function () {
158
- return __awaiter(this, void 0, void 0, function () {
159
- var r;
160
- return __generator(this, function (_a) {
161
- switch (_a.label) {
162
- case 0: return [4 /*yield*/, this.clone(MySocialCloneFactory, "suggestions")()];
163
- case 1:
164
- r = _a.sent();
165
- return [2 /*return*/, hOP(r, "Suggestions") ? r.Suggestions.results : r];
166
- }
167
- });
168
- });
169
- };
170
- __decorate([
171
- tag("msoc.followed")
172
- ], _MySocial.prototype, "followed", null);
173
- __decorate([
174
- tag("msoc.followedCount")
175
- ], _MySocial.prototype, "followedCount", null);
176
- __decorate([
177
- tag("msoc.followers")
178
- ], _MySocial.prototype, "followers", null);
179
- __decorate([
180
- tag("msoc.suggestions")
181
- ], _MySocial.prototype, "suggestions", null);
182
- _MySocial = __decorate([
183
- defaultPath("my")
184
- ], _MySocial);
185
- return _MySocial;
186
- }(_SharePointQueryableInstance));
187
- export { _MySocial };
188
- /**
189
- * Invokable factory for IMySocial instances
190
- */
191
- export var MySocial = spInvokableFactory(_MySocial);
192
- var MySocialCloneFactory = function (baseUrl, path) { return MySocial(baseUrl, path); };
193
- /**
194
- * Social actor type
195
- *
196
- */
197
- export var SocialActorType;
198
- (function (SocialActorType) {
199
- SocialActorType[SocialActorType["User"] = 0] = "User";
200
- SocialActorType[SocialActorType["Document"] = 1] = "Document";
201
- SocialActorType[SocialActorType["Site"] = 2] = "Site";
202
- SocialActorType[SocialActorType["Tag"] = 3] = "Tag";
203
- })(SocialActorType || (SocialActorType = {}));
204
- /**
205
- * Social actor type
206
- *
207
- */
208
- /* eslint-disable no-bitwise */
209
- export var SocialActorTypes;
210
- (function (SocialActorTypes) {
211
- SocialActorTypes[SocialActorTypes["None"] = 0] = "None";
212
- SocialActorTypes[SocialActorTypes["User"] = 1] = "User";
213
- SocialActorTypes[SocialActorTypes["Document"] = 2] = "Document";
214
- SocialActorTypes[SocialActorTypes["Site"] = 4] = "Site";
215
- SocialActorTypes[SocialActorTypes["Tag"] = 8] = "Tag";
216
- /**
217
- * The set excludes documents and sites that do not have feeds.
218
- */
219
- SocialActorTypes[SocialActorTypes["ExcludeContentWithoutFeeds"] = 268435456] = "ExcludeContentWithoutFeeds";
220
- /**
221
- * The set includes group sites
222
- */
223
- SocialActorTypes[SocialActorTypes["IncludeGroupsSites"] = 536870912] = "IncludeGroupsSites";
224
- /**
225
- * The set includes only items created within the last 24 hours
226
- */
227
- SocialActorTypes[SocialActorTypes["WithinLast24Hours"] = 1073741824] = "WithinLast24Hours";
228
- })(SocialActorTypes || (SocialActorTypes = {}));
229
- /* eslint-enable no-bitwise */
230
- /**
231
- * Result from following
232
- *
233
- */
234
- export var SocialFollowResult;
235
- (function (SocialFollowResult) {
236
- SocialFollowResult[SocialFollowResult["Ok"] = 0] = "Ok";
237
- SocialFollowResult[SocialFollowResult["AlreadyFollowing"] = 1] = "AlreadyFollowing";
238
- SocialFollowResult[SocialFollowResult["LimitReached"] = 2] = "LimitReached";
239
- SocialFollowResult[SocialFollowResult["InternalError"] = 3] = "InternalError";
240
- })(SocialFollowResult || (SocialFollowResult = {}));
241
- /**
242
- * Specifies an exception or status code.
243
- */
244
- export var SocialStatusCode;
245
- (function (SocialStatusCode) {
246
- /**
247
- * The operation completed successfully
248
- */
249
- SocialStatusCode[SocialStatusCode["OK"] = 0] = "OK";
250
- /**
251
- * The request is invalid.
252
- */
253
- SocialStatusCode[SocialStatusCode["InvalidRequest"] = 1] = "InvalidRequest";
254
- /**
255
- * The current user is not authorized to perform the operation.
256
- */
257
- SocialStatusCode[SocialStatusCode["AccessDenied"] = 2] = "AccessDenied";
258
- /**
259
- * The target of the operation was not found.
260
- */
261
- SocialStatusCode[SocialStatusCode["ItemNotFound"] = 3] = "ItemNotFound";
262
- /**
263
- * The operation is invalid for the target's current state.
264
- */
265
- SocialStatusCode[SocialStatusCode["InvalidOperation"] = 4] = "InvalidOperation";
266
- /**
267
- * The operation completed without modifying the target.
268
- */
269
- SocialStatusCode[SocialStatusCode["ItemNotModified"] = 5] = "ItemNotModified";
270
- /**
271
- * The operation failed because an internal error occurred.
272
- */
273
- SocialStatusCode[SocialStatusCode["InternalError"] = 6] = "InternalError";
274
- /**
275
- * The operation failed because the server could not access the distributed cache.
276
- */
277
- SocialStatusCode[SocialStatusCode["CacheReadError"] = 7] = "CacheReadError";
278
- /**
279
- * The operation succeeded but the server could not update the distributed cache.
280
- */
281
- SocialStatusCode[SocialStatusCode["CacheUpdateError"] = 8] = "CacheUpdateError";
282
- /**
283
- * No personal site exists for the current user, and no further information is available.
284
- */
285
- SocialStatusCode[SocialStatusCode["PersonalSiteNotFound"] = 9] = "PersonalSiteNotFound";
286
- /**
287
- * No personal site exists for the current user, and a previous attempt to create one failed.
288
- */
289
- SocialStatusCode[SocialStatusCode["FailedToCreatePersonalSite"] = 10] = "FailedToCreatePersonalSite";
290
- /**
291
- * No personal site exists for the current user, and a previous attempt to create one was not authorized.
292
- */
293
- SocialStatusCode[SocialStatusCode["NotAuthorizedToCreatePersonalSite"] = 11] = "NotAuthorizedToCreatePersonalSite";
294
- /**
295
- * No personal site exists for the current user, and no attempt should be made to create one.
296
- */
297
- SocialStatusCode[SocialStatusCode["CannotCreatePersonalSite"] = 12] = "CannotCreatePersonalSite";
298
- /**
299
- * The operation was rejected because an internal limit had been reached.
300
- */
301
- SocialStatusCode[SocialStatusCode["LimitReached"] = 13] = "LimitReached";
302
- /**
303
- * The operation failed because an error occurred during the processing of the specified attachment.
304
- */
305
- SocialStatusCode[SocialStatusCode["AttachmentError"] = 14] = "AttachmentError";
306
- /**
307
- * The operation succeeded with recoverable errors; the returned data is incomplete.
308
- */
309
- SocialStatusCode[SocialStatusCode["PartialData"] = 15] = "PartialData";
310
- /**
311
- * A required SharePoint feature is not enabled.
312
- */
313
- SocialStatusCode[SocialStatusCode["FeatureDisabled"] = 16] = "FeatureDisabled";
314
- /**
315
- * The site's storage quota has been exceeded.
316
- */
317
- SocialStatusCode[SocialStatusCode["StorageQuotaExceeded"] = 17] = "StorageQuotaExceeded";
318
- /**
319
- * The operation failed because the server could not access the database.
320
- */
321
- SocialStatusCode[SocialStatusCode["DatabaseError"] = 18] = "DatabaseError";
322
- })(SocialStatusCode || (SocialStatusCode = {}));
1
+ import { __awaiter, __decorate, __extends, __generator } from "tslib";
2
+ import { _SharePointQueryableInstance, spInvokableFactory, } from "../sharepointqueryable.js";
3
+ import { defaultPath } from "../decorators.js";
4
+ import { hOP } from "@pnp/common";
5
+ import { metadata } from "../utils/metadata.js";
6
+ import { body } from "@pnp/odata";
7
+ import { spPost } from "../operations.js";
8
+ import { tag } from "../telemetry.js";
9
+ var _Social = /** @class */ (function (_super) {
10
+ __extends(_Social, _super);
11
+ function _Social() {
12
+ return _super !== null && _super.apply(this, arguments) || this;
13
+ }
14
+ Object.defineProperty(_Social.prototype, "my", {
15
+ get: function () {
16
+ return MySocial(this);
17
+ },
18
+ enumerable: false,
19
+ configurable: true
20
+ });
21
+ _Social.prototype.getFollowedSitesUri = function () {
22
+ return __awaiter(this, void 0, void 0, function () {
23
+ var r;
24
+ return __generator(this, function (_a) {
25
+ switch (_a.label) {
26
+ case 0: return [4 /*yield*/, this.clone(SocialCloneFactory, "FollowedSitesUri").get()];
27
+ case 1:
28
+ r = _a.sent();
29
+ return [2 /*return*/, r.FollowedSitesUri || r];
30
+ }
31
+ });
32
+ });
33
+ };
34
+ _Social.prototype.getFollowedDocumentsUri = function () {
35
+ return __awaiter(this, void 0, void 0, function () {
36
+ var r;
37
+ return __generator(this, function (_a) {
38
+ switch (_a.label) {
39
+ case 0: return [4 /*yield*/, this.clone(SocialCloneFactory, "FollowedDocumentsUri").get()];
40
+ case 1:
41
+ r = _a.sent();
42
+ return [2 /*return*/, r.FollowedDocumentsUri || r];
43
+ }
44
+ });
45
+ });
46
+ };
47
+ _Social.prototype.follow = function (actorInfo) {
48
+ return __awaiter(this, void 0, void 0, function () {
49
+ return __generator(this, function (_a) {
50
+ switch (_a.label) {
51
+ case 0: return [4 /*yield*/, spPost(this.clone(SocialCloneFactory, "follow"), this.createSocialActorInfoRequestBody(actorInfo))];
52
+ case 1: return [2 /*return*/, _a.sent()];
53
+ }
54
+ });
55
+ });
56
+ };
57
+ _Social.prototype.isFollowed = function (actorInfo) {
58
+ return __awaiter(this, void 0, void 0, function () {
59
+ return __generator(this, function (_a) {
60
+ switch (_a.label) {
61
+ case 0: return [4 /*yield*/, spPost(this.clone(SocialCloneFactory, "isfollowed"), this.createSocialActorInfoRequestBody(actorInfo))];
62
+ case 1: return [2 /*return*/, _a.sent()];
63
+ }
64
+ });
65
+ });
66
+ };
67
+ _Social.prototype.stopFollowing = function (actorInfo) {
68
+ return __awaiter(this, void 0, void 0, function () {
69
+ return __generator(this, function (_a) {
70
+ switch (_a.label) {
71
+ case 0: return [4 /*yield*/, spPost(this.clone(SocialCloneFactory, "stopfollowing"), this.createSocialActorInfoRequestBody(actorInfo))];
72
+ case 1: return [2 /*return*/, _a.sent()];
73
+ }
74
+ });
75
+ });
76
+ };
77
+ _Social.prototype.createSocialActorInfoRequestBody = function (actorInfo) {
78
+ return body({
79
+ "actor": Object.assign(metadata("SP.Social.SocialActorInfo"), {
80
+ Id: null,
81
+ }, actorInfo),
82
+ });
83
+ };
84
+ __decorate([
85
+ tag("soc.getFollowedSitesUri")
86
+ ], _Social.prototype, "getFollowedSitesUri", null);
87
+ __decorate([
88
+ tag("soc.getFollowedDocumentsUri")
89
+ ], _Social.prototype, "getFollowedDocumentsUri", null);
90
+ __decorate([
91
+ tag("soc.follow")
92
+ ], _Social.prototype, "follow", null);
93
+ __decorate([
94
+ tag("soc.isFollowed")
95
+ ], _Social.prototype, "isFollowed", null);
96
+ __decorate([
97
+ tag("soc.stopFollowing")
98
+ ], _Social.prototype, "stopFollowing", null);
99
+ _Social = __decorate([
100
+ defaultPath("_api/social.following")
101
+ ], _Social);
102
+ return _Social;
103
+ }(_SharePointQueryableInstance));
104
+ export { _Social };
105
+ /**
106
+ * Get a new Social instance for the particular Url
107
+ */
108
+ export var Social = function (baseUrl) { return new _Social(baseUrl); };
109
+ var SocialCloneFactory = function (baseUrl, paths) { return new _Social(baseUrl, paths); };
110
+ /**
111
+ * Current user's Social instance
112
+ */
113
+ var _MySocial = /** @class */ (function (_super) {
114
+ __extends(_MySocial, _super);
115
+ function _MySocial() {
116
+ return _super !== null && _super.apply(this, arguments) || this;
117
+ }
118
+ _MySocial.prototype.followed = function (types) {
119
+ return __awaiter(this, void 0, void 0, function () {
120
+ var r;
121
+ return __generator(this, function (_a) {
122
+ switch (_a.label) {
123
+ case 0: return [4 /*yield*/, this.clone(MySocialCloneFactory, "followed(types=" + types + ")")()];
124
+ case 1:
125
+ r = _a.sent();
126
+ return [2 /*return*/, hOP(r, "Followed") ? r.Followed.results : r];
127
+ }
128
+ });
129
+ });
130
+ };
131
+ _MySocial.prototype.followedCount = function (types) {
132
+ return __awaiter(this, void 0, void 0, function () {
133
+ var r;
134
+ return __generator(this, function (_a) {
135
+ switch (_a.label) {
136
+ case 0: return [4 /*yield*/, this.clone(MySocialCloneFactory, "followedcount(types=" + types + ")")()];
137
+ case 1:
138
+ r = _a.sent();
139
+ return [2 /*return*/, r.FollowedCount || r];
140
+ }
141
+ });
142
+ });
143
+ };
144
+ _MySocial.prototype.followers = function () {
145
+ return __awaiter(this, void 0, void 0, function () {
146
+ var r;
147
+ return __generator(this, function (_a) {
148
+ switch (_a.label) {
149
+ case 0: return [4 /*yield*/, this.clone(MySocialCloneFactory, "followers")()];
150
+ case 1:
151
+ r = _a.sent();
152
+ return [2 /*return*/, hOP(r, "Followers") ? r.Followers.results : r];
153
+ }
154
+ });
155
+ });
156
+ };
157
+ _MySocial.prototype.suggestions = function () {
158
+ return __awaiter(this, void 0, void 0, function () {
159
+ var r;
160
+ return __generator(this, function (_a) {
161
+ switch (_a.label) {
162
+ case 0: return [4 /*yield*/, this.clone(MySocialCloneFactory, "suggestions")()];
163
+ case 1:
164
+ r = _a.sent();
165
+ return [2 /*return*/, hOP(r, "Suggestions") ? r.Suggestions.results : r];
166
+ }
167
+ });
168
+ });
169
+ };
170
+ __decorate([
171
+ tag("msoc.followed")
172
+ ], _MySocial.prototype, "followed", null);
173
+ __decorate([
174
+ tag("msoc.followedCount")
175
+ ], _MySocial.prototype, "followedCount", null);
176
+ __decorate([
177
+ tag("msoc.followers")
178
+ ], _MySocial.prototype, "followers", null);
179
+ __decorate([
180
+ tag("msoc.suggestions")
181
+ ], _MySocial.prototype, "suggestions", null);
182
+ _MySocial = __decorate([
183
+ defaultPath("my")
184
+ ], _MySocial);
185
+ return _MySocial;
186
+ }(_SharePointQueryableInstance));
187
+ export { _MySocial };
188
+ /**
189
+ * Invokable factory for IMySocial instances
190
+ */
191
+ export var MySocial = spInvokableFactory(_MySocial);
192
+ var MySocialCloneFactory = function (baseUrl, path) { return MySocial(baseUrl, path); };
193
+ /**
194
+ * Social actor type
195
+ *
196
+ */
197
+ export var SocialActorType;
198
+ (function (SocialActorType) {
199
+ SocialActorType[SocialActorType["User"] = 0] = "User";
200
+ SocialActorType[SocialActorType["Document"] = 1] = "Document";
201
+ SocialActorType[SocialActorType["Site"] = 2] = "Site";
202
+ SocialActorType[SocialActorType["Tag"] = 3] = "Tag";
203
+ })(SocialActorType || (SocialActorType = {}));
204
+ /**
205
+ * Social actor type
206
+ *
207
+ */
208
+ /* eslint-disable no-bitwise */
209
+ export var SocialActorTypes;
210
+ (function (SocialActorTypes) {
211
+ SocialActorTypes[SocialActorTypes["None"] = 0] = "None";
212
+ SocialActorTypes[SocialActorTypes["User"] = 1] = "User";
213
+ SocialActorTypes[SocialActorTypes["Document"] = 2] = "Document";
214
+ SocialActorTypes[SocialActorTypes["Site"] = 4] = "Site";
215
+ SocialActorTypes[SocialActorTypes["Tag"] = 8] = "Tag";
216
+ /**
217
+ * The set excludes documents and sites that do not have feeds.
218
+ */
219
+ SocialActorTypes[SocialActorTypes["ExcludeContentWithoutFeeds"] = 268435456] = "ExcludeContentWithoutFeeds";
220
+ /**
221
+ * The set includes group sites
222
+ */
223
+ SocialActorTypes[SocialActorTypes["IncludeGroupsSites"] = 536870912] = "IncludeGroupsSites";
224
+ /**
225
+ * The set includes only items created within the last 24 hours
226
+ */
227
+ SocialActorTypes[SocialActorTypes["WithinLast24Hours"] = 1073741824] = "WithinLast24Hours";
228
+ })(SocialActorTypes || (SocialActorTypes = {}));
229
+ /* eslint-enable no-bitwise */
230
+ /**
231
+ * Result from following
232
+ *
233
+ */
234
+ export var SocialFollowResult;
235
+ (function (SocialFollowResult) {
236
+ SocialFollowResult[SocialFollowResult["Ok"] = 0] = "Ok";
237
+ SocialFollowResult[SocialFollowResult["AlreadyFollowing"] = 1] = "AlreadyFollowing";
238
+ SocialFollowResult[SocialFollowResult["LimitReached"] = 2] = "LimitReached";
239
+ SocialFollowResult[SocialFollowResult["InternalError"] = 3] = "InternalError";
240
+ })(SocialFollowResult || (SocialFollowResult = {}));
241
+ /**
242
+ * Specifies an exception or status code.
243
+ */
244
+ export var SocialStatusCode;
245
+ (function (SocialStatusCode) {
246
+ /**
247
+ * The operation completed successfully
248
+ */
249
+ SocialStatusCode[SocialStatusCode["OK"] = 0] = "OK";
250
+ /**
251
+ * The request is invalid.
252
+ */
253
+ SocialStatusCode[SocialStatusCode["InvalidRequest"] = 1] = "InvalidRequest";
254
+ /**
255
+ * The current user is not authorized to perform the operation.
256
+ */
257
+ SocialStatusCode[SocialStatusCode["AccessDenied"] = 2] = "AccessDenied";
258
+ /**
259
+ * The target of the operation was not found.
260
+ */
261
+ SocialStatusCode[SocialStatusCode["ItemNotFound"] = 3] = "ItemNotFound";
262
+ /**
263
+ * The operation is invalid for the target's current state.
264
+ */
265
+ SocialStatusCode[SocialStatusCode["InvalidOperation"] = 4] = "InvalidOperation";
266
+ /**
267
+ * The operation completed without modifying the target.
268
+ */
269
+ SocialStatusCode[SocialStatusCode["ItemNotModified"] = 5] = "ItemNotModified";
270
+ /**
271
+ * The operation failed because an internal error occurred.
272
+ */
273
+ SocialStatusCode[SocialStatusCode["InternalError"] = 6] = "InternalError";
274
+ /**
275
+ * The operation failed because the server could not access the distributed cache.
276
+ */
277
+ SocialStatusCode[SocialStatusCode["CacheReadError"] = 7] = "CacheReadError";
278
+ /**
279
+ * The operation succeeded but the server could not update the distributed cache.
280
+ */
281
+ SocialStatusCode[SocialStatusCode["CacheUpdateError"] = 8] = "CacheUpdateError";
282
+ /**
283
+ * No personal site exists for the current user, and no further information is available.
284
+ */
285
+ SocialStatusCode[SocialStatusCode["PersonalSiteNotFound"] = 9] = "PersonalSiteNotFound";
286
+ /**
287
+ * No personal site exists for the current user, and a previous attempt to create one failed.
288
+ */
289
+ SocialStatusCode[SocialStatusCode["FailedToCreatePersonalSite"] = 10] = "FailedToCreatePersonalSite";
290
+ /**
291
+ * No personal site exists for the current user, and a previous attempt to create one was not authorized.
292
+ */
293
+ SocialStatusCode[SocialStatusCode["NotAuthorizedToCreatePersonalSite"] = 11] = "NotAuthorizedToCreatePersonalSite";
294
+ /**
295
+ * No personal site exists for the current user, and no attempt should be made to create one.
296
+ */
297
+ SocialStatusCode[SocialStatusCode["CannotCreatePersonalSite"] = 12] = "CannotCreatePersonalSite";
298
+ /**
299
+ * The operation was rejected because an internal limit had been reached.
300
+ */
301
+ SocialStatusCode[SocialStatusCode["LimitReached"] = 13] = "LimitReached";
302
+ /**
303
+ * The operation failed because an error occurred during the processing of the specified attachment.
304
+ */
305
+ SocialStatusCode[SocialStatusCode["AttachmentError"] = 14] = "AttachmentError";
306
+ /**
307
+ * The operation succeeded with recoverable errors; the returned data is incomplete.
308
+ */
309
+ SocialStatusCode[SocialStatusCode["PartialData"] = 15] = "PartialData";
310
+ /**
311
+ * A required SharePoint feature is not enabled.
312
+ */
313
+ SocialStatusCode[SocialStatusCode["FeatureDisabled"] = 16] = "FeatureDisabled";
314
+ /**
315
+ * The site's storage quota has been exceeded.
316
+ */
317
+ SocialStatusCode[SocialStatusCode["StorageQuotaExceeded"] = 17] = "StorageQuotaExceeded";
318
+ /**
319
+ * The operation failed because the server could not access the database.
320
+ */
321
+ SocialStatusCode[SocialStatusCode["DatabaseError"] = 18] = "DatabaseError";
322
+ })(SocialStatusCode || (SocialStatusCode = {}));
323
323
  //# sourceMappingURL=types.js.map