@pnp/sp 2.10.0 → 2.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (294) hide show
  1. package/LICENSE +25 -25
  2. package/appcatalog/index.d.ts +8 -8
  3. package/appcatalog/index.js +30 -30
  4. package/appcatalog/types.d.ts +81 -81
  5. package/appcatalog/types.js +177 -177
  6. package/appcatalog/web.d.ts +16 -16
  7. package/appcatalog/web.js +6 -6
  8. package/attachments/index.d.ts +2 -2
  9. package/attachments/index.js +2 -2
  10. package/attachments/item.d.ts +12 -12
  11. package/attachments/item.js +4 -4
  12. package/attachments/types.d.ts +92 -92
  13. package/attachments/types.js +240 -240
  14. package/batch.d.ts +17 -17
  15. package/batch.js +223 -223
  16. package/clientside-pages/funcs.d.ts +22 -22
  17. package/clientside-pages/funcs.js +25 -25
  18. package/clientside-pages/index.d.ts +2 -2
  19. package/clientside-pages/index.js +2 -2
  20. package/clientside-pages/types.d.ts +496 -496
  21. package/clientside-pages/types.js +1496 -1496
  22. package/clientside-pages/web.d.ts +41 -41
  23. package/clientside-pages/web.js +57 -57
  24. package/column-defaults/folder.d.ts +27 -27
  25. package/column-defaults/folder.js +82 -82
  26. package/column-defaults/index.d.ts +3 -3
  27. package/column-defaults/index.js +2 -2
  28. package/column-defaults/list.d.ts +19 -19
  29. package/column-defaults/list.js +198 -198
  30. package/column-defaults/types.d.ts +21 -21
  31. package/column-defaults/types.js +1 -1
  32. package/comments/clientside-page.d.ts +57 -57
  33. package/comments/clientside-page.d.ts.map +1 -1
  34. package/comments/clientside-page.js +136 -136
  35. package/comments/index.d.ts +2 -2
  36. package/comments/index.js +2 -2
  37. package/comments/item.d.ts +29 -29
  38. package/comments/item.js +47 -47
  39. package/comments/types.d.ts +107 -107
  40. package/comments/types.d.ts.map +1 -1
  41. package/comments/types.js +145 -145
  42. package/comments/types.js.map +1 -1
  43. package/content-types/index.d.ts +4 -4
  44. package/content-types/index.js +4 -4
  45. package/content-types/item.d.ts +12 -12
  46. package/content-types/item.js +4 -4
  47. package/content-types/list.d.ts +12 -12
  48. package/content-types/list.js +4 -4
  49. package/content-types/types.d.ts +107 -107
  50. package/content-types/types.js +166 -166
  51. package/content-types/web.d.ts +12 -12
  52. package/content-types/web.js +4 -4
  53. package/decorators.d.ts +11 -11
  54. package/decorators.js +28 -28
  55. package/features/index.d.ts +3 -3
  56. package/features/index.js +3 -3
  57. package/features/site.d.ts +12 -12
  58. package/features/site.js +4 -4
  59. package/features/types.d.ts +47 -47
  60. package/features/types.js +109 -109
  61. package/features/web.d.ts +12 -12
  62. package/features/web.js +4 -4
  63. package/fields/index.d.ts +4 -4
  64. package/fields/index.js +4 -4
  65. package/fields/list.d.ts +12 -12
  66. package/fields/list.js +4 -4
  67. package/fields/types.d.ts +368 -368
  68. package/fields/types.js +624 -624
  69. package/fields/web.d.ts +17 -17
  70. package/fields/web.js +5 -5
  71. package/files/folder.d.ts +12 -12
  72. package/files/folder.js +4 -4
  73. package/files/index.d.ts +4 -4
  74. package/files/index.js +4 -4
  75. package/files/item.d.ts +12 -12
  76. package/files/item.js +4 -4
  77. package/files/types.d.ts +421 -421
  78. package/files/types.js +853 -853
  79. package/files/web.d.ts +35 -35
  80. package/files/web.js +15 -15
  81. package/folders/index.d.ts +4 -4
  82. package/folders/index.js +4 -4
  83. package/folders/item.d.ts +9 -9
  84. package/folders/item.js +4 -4
  85. package/folders/list.d.ts +12 -12
  86. package/folders/list.js +4 -4
  87. package/folders/types.d.ts +207 -207
  88. package/folders/types.js +433 -433
  89. package/folders/web.d.ts +39 -39
  90. package/folders/web.js +15 -15
  91. package/forms/index.d.ts +2 -2
  92. package/forms/index.js +2 -2
  93. package/forms/list.d.ts +9 -9
  94. package/forms/list.js +4 -4
  95. package/forms/types.d.ts +35 -35
  96. package/forms/types.js +41 -41
  97. package/hubsites/index.d.ts +12 -12
  98. package/hubsites/index.js +15 -15
  99. package/hubsites/site.d.ts +26 -26
  100. package/hubsites/site.js +39 -39
  101. package/hubsites/types.d.ts +55 -55
  102. package/hubsites/types.js +53 -53
  103. package/hubsites/web.d.ts +21 -21
  104. package/hubsites/web.js +23 -23
  105. package/index.d.ts +14 -14
  106. package/index.js +13 -13
  107. package/items/index.d.ts +2 -2
  108. package/items/index.js +2 -2
  109. package/items/list.d.ts +9 -9
  110. package/items/list.js +4 -4
  111. package/items/types.d.ts +226 -226
  112. package/items/types.js +549 -549
  113. package/lists/index.d.ts +2 -2
  114. package/lists/index.js +2 -2
  115. package/lists/types.d.ts +495 -495
  116. package/lists/types.js +522 -522
  117. package/lists/web.d.ts +43 -43
  118. package/lists/web.js +27 -27
  119. package/navigation/index.d.ts +8 -8
  120. package/navigation/index.js +14 -14
  121. package/navigation/types.d.ts +154 -154
  122. package/navigation/types.js +219 -219
  123. package/navigation/web.d.ts +13 -13
  124. package/navigation/web.js +4 -4
  125. package/odata.d.ts +5 -5
  126. package/odata.js +90 -90
  127. package/operations.d.ts +9 -9
  128. package/operations.js +63 -63
  129. package/package.json +4 -4
  130. package/presets/all.d.ts +72 -72
  131. package/presets/all.js +72 -72
  132. package/presets/core.d.ts +11 -11
  133. package/presets/core.js +11 -11
  134. package/profiles/index.d.ts +7 -7
  135. package/profiles/index.js +13 -13
  136. package/profiles/types.d.ts +357 -357
  137. package/profiles/types.js +454 -454
  138. package/readme.md +21 -21
  139. package/regional-settings/content-type.d.ts +7 -7
  140. package/regional-settings/content-type.js +4 -4
  141. package/regional-settings/field.d.ts +7 -7
  142. package/regional-settings/field.js +4 -4
  143. package/regional-settings/funcs.d.ts +2 -2
  144. package/regional-settings/funcs.js +8 -8
  145. package/regional-settings/index.d.ts +6 -6
  146. package/regional-settings/index.js +6 -6
  147. package/regional-settings/list.d.ts +7 -7
  148. package/regional-settings/list.js +4 -4
  149. package/regional-settings/types.d.ts +111 -111
  150. package/regional-settings/types.js +159 -159
  151. package/regional-settings/user-custom-actions.d.ts +7 -7
  152. package/regional-settings/user-custom-actions.js +4 -4
  153. package/regional-settings/web.d.ts +12 -12
  154. package/regional-settings/web.js +7 -7
  155. package/related-items/index.d.ts +1 -1
  156. package/related-items/index.js +1 -1
  157. package/related-items/types.d.ts +76 -76
  158. package/related-items/types.js +103 -103
  159. package/related-items/web.d.ts +12 -12
  160. package/related-items/web.js +9 -9
  161. package/rest.d.ts +44 -44
  162. package/rest.js +72 -72
  163. package/search/index.d.ts +30 -30
  164. package/search/index.js +25 -25
  165. package/search/query.d.ts +62 -62
  166. package/search/query.js +302 -302
  167. package/search/suggest.d.ts +76 -76
  168. package/search/suggest.js +66 -66
  169. package/search/types.d.ts +426 -426
  170. package/search/types.js +57 -57
  171. package/security/funcs.d.ts +43 -43
  172. package/security/funcs.js +142 -142
  173. package/security/index.d.ts +4 -4
  174. package/security/index.js +4 -4
  175. package/security/item.d.ts +7 -7
  176. package/security/item.js +14 -14
  177. package/security/list.d.ts +7 -7
  178. package/security/list.js +14 -14
  179. package/security/types.d.ts +318 -318
  180. package/security/types.js +399 -399
  181. package/security/web.d.ts +9 -9
  182. package/security/web.js +15 -15
  183. package/sharepointqueryable.d.ts +135 -135
  184. package/sharepointqueryable.js +265 -265
  185. package/sharing/file.d.ts +18 -18
  186. package/sharing/file.js +116 -116
  187. package/sharing/folder.d.ts +9 -9
  188. package/sharing/folder.js +136 -136
  189. package/sharing/funcs.d.ts +62 -62
  190. package/sharing/funcs.js +239 -239
  191. package/sharing/index.d.ts +5 -5
  192. package/sharing/index.js +5 -5
  193. package/sharing/item.d.ts +16 -16
  194. package/sharing/item.js +15 -15
  195. package/sharing/types.d.ts +583 -583
  196. package/sharing/types.js +113 -113
  197. package/sharing/web.d.ts +19 -19
  198. package/sharing/web.js +76 -76
  199. package/site-designs/index.d.ts +8 -8
  200. package/site-designs/index.js +14 -14
  201. package/site-designs/types.d.ts +319 -319
  202. package/site-designs/types.js +203 -203
  203. package/site-designs/web.d.ts +25 -25
  204. package/site-designs/web.js +11 -11
  205. package/site-groups/index.d.ts +2 -2
  206. package/site-groups/index.js +2 -2
  207. package/site-groups/types.d.ts +89 -89
  208. package/site-groups/types.js +125 -125
  209. package/site-groups/web.d.ts +40 -40
  210. package/site-groups/web.js +30 -30
  211. package/site-scripts/index.d.ts +9 -9
  212. package/site-scripts/index.js +15 -15
  213. package/site-scripts/list.d.ts +12 -12
  214. package/site-scripts/list.js +24 -24
  215. package/site-scripts/types.d.ts +183 -183
  216. package/site-scripts/types.js +141 -141
  217. package/site-scripts/web.d.ts +13 -13
  218. package/site-scripts/web.js +5 -5
  219. package/site-users/index.d.ts +2 -2
  220. package/site-users/index.js +2 -2
  221. package/site-users/types.d.ts +138 -138
  222. package/site-users/types.js +122 -122
  223. package/site-users/web.d.ts +31 -31
  224. package/site-users/web.js +27 -27
  225. package/sites/index.d.ts +7 -7
  226. package/sites/index.js +13 -13
  227. package/sites/types.d.ts +147 -147
  228. package/sites/types.js +321 -321
  229. package/social/index.d.ts +10 -10
  230. package/social/index.js +13 -13
  231. package/social/types.d.ts +309 -309
  232. package/social/types.js +322 -322
  233. package/sphttpclient.d.ts +18 -18
  234. package/sphttpclient.js +189 -189
  235. package/splibconfig.d.ts +22 -22
  236. package/splibconfig.js +13 -13
  237. package/sputilities/index.d.ts +7 -7
  238. package/sputilities/index.js +13 -13
  239. package/sputilities/types.d.ts +130 -130
  240. package/sputilities/types.js +118 -118
  241. package/subscriptions/index.d.ts +2 -2
  242. package/subscriptions/index.js +2 -2
  243. package/subscriptions/list.d.ts +13 -13
  244. package/subscriptions/list.js +4 -4
  245. package/subscriptions/types.d.ts +54 -54
  246. package/subscriptions/types.js +111 -111
  247. package/taxonomy/index.d.ts +7 -7
  248. package/taxonomy/index.js +13 -13
  249. package/taxonomy/types.d.ts +200 -200
  250. package/taxonomy/types.js +347 -347
  251. package/telemetry.d.ts +12 -12
  252. package/telemetry.js +48 -48
  253. package/types.d.ts +218 -218
  254. package/types.js +79 -79
  255. package/user-custom-actions/index.d.ts +4 -4
  256. package/user-custom-actions/index.js +4 -4
  257. package/user-custom-actions/list.d.ts +12 -12
  258. package/user-custom-actions/list.js +4 -4
  259. package/user-custom-actions/site.d.ts +12 -12
  260. package/user-custom-actions/site.js +4 -4
  261. package/user-custom-actions/types.d.ts +82 -82
  262. package/user-custom-actions/types.js +93 -93
  263. package/user-custom-actions/web.d.ts +15 -15
  264. package/user-custom-actions/web.js +4 -4
  265. package/utils/escapeQueryStrValue.d.ts +1 -1
  266. package/utils/escapeQueryStrValue.js +19 -19
  267. package/utils/extractweburl.d.ts +1 -1
  268. package/utils/extractweburl.js +15 -15
  269. package/utils/file-names.d.ts +17 -17
  270. package/utils/file-names.js +38 -38
  271. package/utils/metadata.d.ts +5 -5
  272. package/utils/metadata.js +5 -5
  273. package/utils/objectToSPKeyValueCollection.d.ts +20 -20
  274. package/utils/objectToSPKeyValueCollection.js +16 -16
  275. package/utils/toResourcePath.d.ts +7 -7
  276. package/utils/toResourcePath.js +6 -6
  277. package/utils/toabsoluteurl.d.ts +7 -7
  278. package/utils/toabsoluteurl.js +61 -61
  279. package/views/index.d.ts +2 -2
  280. package/views/index.js +2 -2
  281. package/views/list.d.ts +23 -23
  282. package/views/list.js +8 -8
  283. package/views/types.d.ts +140 -140
  284. package/views/types.js +184 -184
  285. package/webparts/file.d.ts +15 -15
  286. package/webparts/file.js +6 -6
  287. package/webparts/index.d.ts +2 -2
  288. package/webparts/index.js +2 -2
  289. package/webparts/types.d.ts +83 -83
  290. package/webparts/types.js +117 -117
  291. package/webs/index.d.ts +16 -16
  292. package/webs/index.js +16 -16
  293. package/webs/types.d.ts +210 -210
  294. package/webs/types.js +295 -295
@@ -1,90 +1,90 @@
1
- import { _SharePointQueryableInstance, _SharePointQueryableCollection } from "../sharepointqueryable.js";
2
- import { ISiteUsers } from "../site-users/types.js";
3
- import { ITypedHash } from "@pnp/common";
4
- export declare class _SiteGroups extends _SharePointQueryableCollection<ISiteGroupInfo[]> {
5
- /**
6
- * Gets a group from the collection by id
7
- *
8
- * @param id The id of the group to retrieve
9
- */
10
- getById(id: number): ISiteGroup;
11
- /**
12
- * Adds a new group to the site collection
13
- *
14
- * @param properties The group properties object of property names and values to be set for the group
15
- */
16
- add(properties: ITypedHash<any>): Promise<IGroupAddResult>;
17
- /**
18
- * Gets a group from the collection by name
19
- *
20
- * @param groupName The name of the group to retrieve
21
- */
22
- getByName(groupName: string): ISiteGroup;
23
- /**
24
- * Removes the group with the specified member id from the collection
25
- *
26
- * @param id The id of the group to remove
27
- */
28
- removeById(id: number): Promise<void>;
29
- /**
30
- * Removes the cross-site group with the specified name from the collection
31
- *
32
- * @param loginName The name of the group to remove
33
- */
34
- removeByLoginName(loginName: string): Promise<any>;
35
- }
36
- export interface ISiteGroups extends _SiteGroups {
37
- }
38
- export declare const SiteGroups: import("../sharepointqueryable.js").ISPInvokableFactory<ISiteGroups>;
39
- export declare class _SiteGroup extends _SharePointQueryableInstance<ISiteGroupInfo> {
40
- /**
41
- * Gets the users for this group
42
- *
43
- */
44
- get users(): ISiteUsers;
45
- /**
46
- * Updates the group with the given property values
47
- *
48
- * @param props The group properties object of property names and values to be set for the group
49
- */
50
- update: (props: ITypedHash<any>) => Promise<IGroupUpdateResult>;
51
- /**
52
- * Set the owner of a group using a user id
53
- * @param userId the id of the user that will be set as the owner of the current group
54
- */
55
- setUserAsOwner(userId: number): Promise<any>;
56
- }
57
- export interface ISiteGroup extends _SiteGroup {
58
- }
59
- export declare const SiteGroup: import("../sharepointqueryable.js").ISPInvokableFactory<ISiteGroup>;
60
- /**
61
- * Result from updating a group
62
- *
63
- */
64
- export interface IGroupUpdateResult {
65
- group: ISiteGroup;
66
- data: any;
67
- }
68
- /**
69
- * Results from adding a group
70
- *
71
- */
72
- export interface IGroupAddResult {
73
- group: ISiteGroup;
74
- data: any;
75
- }
76
- export interface ISiteGroupInfo {
77
- AllowMembersEditMembership: boolean;
78
- AllowRequestToJoinLeave: boolean;
79
- AutoAcceptRequestToJoinLeave: boolean;
80
- Description: string;
81
- Id: number;
82
- IsHiddenInUI: boolean;
83
- LoginName: string;
84
- OnlyAllowMembersViewMembership: boolean;
85
- OwnerTitle: string;
86
- PrincipalType: number;
87
- RequestToJoinLeaveEmailSetting: string | null;
88
- Title: string;
89
- }
1
+ import { _SharePointQueryableInstance, _SharePointQueryableCollection } from "../sharepointqueryable.js";
2
+ import { ISiteUsers } from "../site-users/types.js";
3
+ import { ITypedHash } from "@pnp/common";
4
+ export declare class _SiteGroups extends _SharePointQueryableCollection<ISiteGroupInfo[]> {
5
+ /**
6
+ * Gets a group from the collection by id
7
+ *
8
+ * @param id The id of the group to retrieve
9
+ */
10
+ getById(id: number): ISiteGroup;
11
+ /**
12
+ * Adds a new group to the site collection
13
+ *
14
+ * @param properties The group properties object of property names and values to be set for the group
15
+ */
16
+ add(properties: ITypedHash<any>): Promise<IGroupAddResult>;
17
+ /**
18
+ * Gets a group from the collection by name
19
+ *
20
+ * @param groupName The name of the group to retrieve
21
+ */
22
+ getByName(groupName: string): ISiteGroup;
23
+ /**
24
+ * Removes the group with the specified member id from the collection
25
+ *
26
+ * @param id The id of the group to remove
27
+ */
28
+ removeById(id: number): Promise<void>;
29
+ /**
30
+ * Removes the cross-site group with the specified name from the collection
31
+ *
32
+ * @param loginName The name of the group to remove
33
+ */
34
+ removeByLoginName(loginName: string): Promise<any>;
35
+ }
36
+ export interface ISiteGroups extends _SiteGroups {
37
+ }
38
+ export declare const SiteGroups: import("../sharepointqueryable.js").ISPInvokableFactory<ISiteGroups>;
39
+ export declare class _SiteGroup extends _SharePointQueryableInstance<ISiteGroupInfo> {
40
+ /**
41
+ * Gets the users for this group
42
+ *
43
+ */
44
+ get users(): ISiteUsers;
45
+ /**
46
+ * Updates the group with the given property values
47
+ *
48
+ * @param props The group properties object of property names and values to be set for the group
49
+ */
50
+ update: (props: ITypedHash<any>) => Promise<IGroupUpdateResult>;
51
+ /**
52
+ * Set the owner of a group using a user id
53
+ * @param userId the id of the user that will be set as the owner of the current group
54
+ */
55
+ setUserAsOwner(userId: number): Promise<any>;
56
+ }
57
+ export interface ISiteGroup extends _SiteGroup {
58
+ }
59
+ export declare const SiteGroup: import("../sharepointqueryable.js").ISPInvokableFactory<ISiteGroup>;
60
+ /**
61
+ * Result from updating a group
62
+ *
63
+ */
64
+ export interface IGroupUpdateResult {
65
+ group: ISiteGroup;
66
+ data: any;
67
+ }
68
+ /**
69
+ * Results from adding a group
70
+ *
71
+ */
72
+ export interface IGroupAddResult {
73
+ group: ISiteGroup;
74
+ data: any;
75
+ }
76
+ export interface ISiteGroupInfo {
77
+ AllowMembersEditMembership: boolean;
78
+ AllowRequestToJoinLeave: boolean;
79
+ AutoAcceptRequestToJoinLeave: boolean;
80
+ Description: string;
81
+ Id: number;
82
+ IsHiddenInUI: boolean;
83
+ LoginName: string;
84
+ OnlyAllowMembersViewMembership: boolean;
85
+ OwnerTitle: string;
86
+ PrincipalType: number;
87
+ RequestToJoinLeaveEmailSetting: string | null;
88
+ Title: string;
89
+ }
90
90
  //# sourceMappingURL=types.d.ts.map
@@ -1,126 +1,126 @@
1
- import { __awaiter, __decorate, __extends, __generator } from "tslib";
2
- import { _SharePointQueryableInstance, _SharePointQueryableCollection, spInvokableFactory, } from "../sharepointqueryable.js";
3
- import { SiteUsers } from "../site-users/types.js";
4
- import { assign, hOP } from "@pnp/common";
5
- import { metadata } from "../utils/metadata.js";
6
- import { body } from "@pnp/odata";
7
- import { defaultPath } from "../decorators.js";
8
- import { spPost } from "../operations.js";
9
- import { tag } from "../telemetry.js";
10
- var _SiteGroups = /** @class */ (function (_super) {
11
- __extends(_SiteGroups, _super);
12
- function _SiteGroups() {
13
- return _super !== null && _super.apply(this, arguments) || this;
14
- }
15
- /**
16
- * Gets a group from the collection by id
17
- *
18
- * @param id The id of the group to retrieve
19
- */
20
- _SiteGroups.prototype.getById = function (id) {
21
- return tag.configure(SiteGroup(this).concat("(" + id + ")"), "sgs.getById");
22
- };
23
- /**
24
- * Adds a new group to the site collection
25
- *
26
- * @param properties The group properties object of property names and values to be set for the group
27
- */
28
- _SiteGroups.prototype.add = function (properties) {
29
- return __awaiter(this, void 0, void 0, function () {
30
- var postBody, data;
31
- return __generator(this, function (_a) {
32
- switch (_a.label) {
33
- case 0:
34
- postBody = body(assign(metadata("SP.Group"), properties));
35
- return [4 /*yield*/, spPost(tag.configure(this, "sgs.add"), postBody)];
36
- case 1:
37
- data = _a.sent();
38
- return [2 /*return*/, {
39
- data: data,
40
- group: this.getById(data.Id),
41
- }];
42
- }
43
- });
44
- });
45
- };
46
- /**
47
- * Gets a group from the collection by name
48
- *
49
- * @param groupName The name of the group to retrieve
50
- */
51
- _SiteGroups.prototype.getByName = function (groupName) {
52
- return tag.configure(SiteGroup(this, "getByName('" + groupName + "')"), "sgs.getByName");
53
- };
54
- /**
55
- * Removes the group with the specified member id from the collection
56
- *
57
- * @param id The id of the group to remove
58
- */
59
- _SiteGroups.prototype.removeById = function (id) {
60
- return spPost(this.clone(SiteGroups, "removeById('" + id + "')"));
61
- };
62
- /**
63
- * Removes the cross-site group with the specified name from the collection
64
- *
65
- * @param loginName The name of the group to remove
66
- */
67
- _SiteGroups.prototype.removeByLoginName = function (loginName) {
68
- return spPost(this.clone(SiteGroups, "removeByLoginName('" + loginName + "')"));
69
- };
70
- __decorate([
71
- tag("sgs.removeById")
72
- ], _SiteGroups.prototype, "removeById", null);
73
- __decorate([
74
- tag("sgs.removeByLoginName")
75
- ], _SiteGroups.prototype, "removeByLoginName", null);
76
- _SiteGroups = __decorate([
77
- defaultPath("sitegroups")
78
- ], _SiteGroups);
79
- return _SiteGroups;
80
- }(_SharePointQueryableCollection));
81
- export { _SiteGroups };
82
- export var SiteGroups = spInvokableFactory(_SiteGroups);
83
- var _SiteGroup = /** @class */ (function (_super) {
84
- __extends(_SiteGroup, _super);
85
- function _SiteGroup() {
86
- var _this = _super !== null && _super.apply(this, arguments) || this;
87
- /**
88
- * Updates the group with the given property values
89
- *
90
- * @param props The group properties object of property names and values to be set for the group
91
- */
92
- _this.update = _this._update("SP.Group", function (d, p) {
93
- var retGroup = hOP(p, "Title") ? _this.getParent(SiteGroup, _this.parentUrl, "getByName('" + p.Title + "')") : SiteGroup(_this);
94
- return {
95
- data: d,
96
- group: retGroup,
97
- };
98
- });
99
- return _this;
100
- }
101
- Object.defineProperty(_SiteGroup.prototype, "users", {
102
- /**
103
- * Gets the users for this group
104
- *
105
- */
106
- get: function () {
107
- return tag.configure(SiteUsers(this, "users"), "sg.users");
108
- },
109
- enumerable: false,
110
- configurable: true
111
- });
112
- /**
113
- * Set the owner of a group using a user id
114
- * @param userId the id of the user that will be set as the owner of the current group
115
- */
116
- _SiteGroup.prototype.setUserAsOwner = function (userId) {
117
- return spPost(this.clone(SiteGroup, "SetUserAsOwner(" + userId + ")"));
118
- };
119
- __decorate([
120
- tag("sg.setUserAsOwner")
121
- ], _SiteGroup.prototype, "setUserAsOwner", null);
122
- return _SiteGroup;
123
- }(_SharePointQueryableInstance));
124
- export { _SiteGroup };
125
- export var SiteGroup = spInvokableFactory(_SiteGroup);
1
+ import { __awaiter, __decorate, __extends, __generator } from "tslib";
2
+ import { _SharePointQueryableInstance, _SharePointQueryableCollection, spInvokableFactory, } from "../sharepointqueryable.js";
3
+ import { SiteUsers } from "../site-users/types.js";
4
+ import { assign, hOP } from "@pnp/common";
5
+ import { metadata } from "../utils/metadata.js";
6
+ import { body } from "@pnp/odata";
7
+ import { defaultPath } from "../decorators.js";
8
+ import { spPost } from "../operations.js";
9
+ import { tag } from "../telemetry.js";
10
+ var _SiteGroups = /** @class */ (function (_super) {
11
+ __extends(_SiteGroups, _super);
12
+ function _SiteGroups() {
13
+ return _super !== null && _super.apply(this, arguments) || this;
14
+ }
15
+ /**
16
+ * Gets a group from the collection by id
17
+ *
18
+ * @param id The id of the group to retrieve
19
+ */
20
+ _SiteGroups.prototype.getById = function (id) {
21
+ return tag.configure(SiteGroup(this).concat("(" + id + ")"), "sgs.getById");
22
+ };
23
+ /**
24
+ * Adds a new group to the site collection
25
+ *
26
+ * @param properties The group properties object of property names and values to be set for the group
27
+ */
28
+ _SiteGroups.prototype.add = function (properties) {
29
+ return __awaiter(this, void 0, void 0, function () {
30
+ var postBody, data;
31
+ return __generator(this, function (_a) {
32
+ switch (_a.label) {
33
+ case 0:
34
+ postBody = body(assign(metadata("SP.Group"), properties));
35
+ return [4 /*yield*/, spPost(tag.configure(this, "sgs.add"), postBody)];
36
+ case 1:
37
+ data = _a.sent();
38
+ return [2 /*return*/, {
39
+ data: data,
40
+ group: this.getById(data.Id),
41
+ }];
42
+ }
43
+ });
44
+ });
45
+ };
46
+ /**
47
+ * Gets a group from the collection by name
48
+ *
49
+ * @param groupName The name of the group to retrieve
50
+ */
51
+ _SiteGroups.prototype.getByName = function (groupName) {
52
+ return tag.configure(SiteGroup(this, "getByName('" + groupName + "')"), "sgs.getByName");
53
+ };
54
+ /**
55
+ * Removes the group with the specified member id from the collection
56
+ *
57
+ * @param id The id of the group to remove
58
+ */
59
+ _SiteGroups.prototype.removeById = function (id) {
60
+ return spPost(this.clone(SiteGroups, "removeById('" + id + "')"));
61
+ };
62
+ /**
63
+ * Removes the cross-site group with the specified name from the collection
64
+ *
65
+ * @param loginName The name of the group to remove
66
+ */
67
+ _SiteGroups.prototype.removeByLoginName = function (loginName) {
68
+ return spPost(this.clone(SiteGroups, "removeByLoginName('" + loginName + "')"));
69
+ };
70
+ __decorate([
71
+ tag("sgs.removeById")
72
+ ], _SiteGroups.prototype, "removeById", null);
73
+ __decorate([
74
+ tag("sgs.removeByLoginName")
75
+ ], _SiteGroups.prototype, "removeByLoginName", null);
76
+ _SiteGroups = __decorate([
77
+ defaultPath("sitegroups")
78
+ ], _SiteGroups);
79
+ return _SiteGroups;
80
+ }(_SharePointQueryableCollection));
81
+ export { _SiteGroups };
82
+ export var SiteGroups = spInvokableFactory(_SiteGroups);
83
+ var _SiteGroup = /** @class */ (function (_super) {
84
+ __extends(_SiteGroup, _super);
85
+ function _SiteGroup() {
86
+ var _this = _super !== null && _super.apply(this, arguments) || this;
87
+ /**
88
+ * Updates the group with the given property values
89
+ *
90
+ * @param props The group properties object of property names and values to be set for the group
91
+ */
92
+ _this.update = _this._update("SP.Group", function (d, p) {
93
+ var retGroup = hOP(p, "Title") ? _this.getParent(SiteGroup, _this.parentUrl, "getByName('" + p.Title + "')") : SiteGroup(_this);
94
+ return {
95
+ data: d,
96
+ group: retGroup,
97
+ };
98
+ });
99
+ return _this;
100
+ }
101
+ Object.defineProperty(_SiteGroup.prototype, "users", {
102
+ /**
103
+ * Gets the users for this group
104
+ *
105
+ */
106
+ get: function () {
107
+ return tag.configure(SiteUsers(this, "users"), "sg.users");
108
+ },
109
+ enumerable: false,
110
+ configurable: true
111
+ });
112
+ /**
113
+ * Set the owner of a group using a user id
114
+ * @param userId the id of the user that will be set as the owner of the current group
115
+ */
116
+ _SiteGroup.prototype.setUserAsOwner = function (userId) {
117
+ return spPost(this.clone(SiteGroup, "SetUserAsOwner(" + userId + ")"));
118
+ };
119
+ __decorate([
120
+ tag("sg.setUserAsOwner")
121
+ ], _SiteGroup.prototype, "setUserAsOwner", null);
122
+ return _SiteGroup;
123
+ }(_SharePointQueryableInstance));
124
+ export { _SiteGroup };
125
+ export var SiteGroup = spInvokableFactory(_SiteGroup);
126
126
  //# sourceMappingURL=types.js.map
@@ -1,41 +1,41 @@
1
- import { ISiteGroups, ISiteGroup } from "./types.js";
2
- import "../security/web.js";
3
- declare module "../webs/types" {
4
- interface _Web {
5
- readonly siteGroups: ISiteGroups;
6
- readonly associatedOwnerGroup: ISiteGroup;
7
- readonly associatedMemberGroup: ISiteGroup;
8
- readonly associatedVisitorGroup: ISiteGroup;
9
- createDefaultAssociatedGroups(groupNameSeed: string, siteOwner: string, copyRoleAssignments?: boolean, clearSubscopes?: boolean, siteOwner2?: string): Promise<void>;
10
- }
11
- interface IWeb {
12
- /**
13
- * Returns the site groups of this web
14
- */
15
- readonly siteGroups: ISiteGroups;
16
- /**
17
- * The web's owner group
18
- */
19
- readonly associatedOwnerGroup: ISiteGroup;
20
- /**
21
- * The web's member group
22
- */
23
- readonly associatedMemberGroup: ISiteGroup;
24
- /**
25
- * The web's visitor group
26
- */
27
- readonly associatedVisitorGroup: ISiteGroup;
28
- /**
29
- * Creates the default associated groups (Members, Owners, Visitors) and gives them the default permissions on the site.
30
- * The target site must have unique permissions and no associated members / owners / visitors groups
31
- *
32
- * @param groupNameSeed The base group name. E.g. 'TestSite' would produce 'TestSite Members' etc.
33
- * @param siteOwner The user login name to be added to the site Owners group. Default is the current user
34
- * @param copyRoleAssignments Optional. If true the permissions are copied from the current parent scope
35
- * @param clearSubscopes Optional. true to make all child securable objects inherit role assignments from the current object
36
- * @param siteOwner2 Optional. The second user login name to be added to the site Owners group. Default is empty
37
- */
38
- createDefaultAssociatedGroups(groupNameSeed: string, siteOwner: string, copyRoleAssignments?: boolean, clearSubscopes?: boolean, siteOwner2?: string): Promise<void>;
39
- }
40
- }
1
+ import { ISiteGroups, ISiteGroup } from "./types.js";
2
+ import "../security/web.js";
3
+ declare module "../webs/types" {
4
+ interface _Web {
5
+ readonly siteGroups: ISiteGroups;
6
+ readonly associatedOwnerGroup: ISiteGroup;
7
+ readonly associatedMemberGroup: ISiteGroup;
8
+ readonly associatedVisitorGroup: ISiteGroup;
9
+ createDefaultAssociatedGroups(groupNameSeed: string, siteOwner: string, copyRoleAssignments?: boolean, clearSubscopes?: boolean, siteOwner2?: string): Promise<void>;
10
+ }
11
+ interface IWeb {
12
+ /**
13
+ * Returns the site groups of this web
14
+ */
15
+ readonly siteGroups: ISiteGroups;
16
+ /**
17
+ * The web's owner group
18
+ */
19
+ readonly associatedOwnerGroup: ISiteGroup;
20
+ /**
21
+ * The web's member group
22
+ */
23
+ readonly associatedMemberGroup: ISiteGroup;
24
+ /**
25
+ * The web's visitor group
26
+ */
27
+ readonly associatedVisitorGroup: ISiteGroup;
28
+ /**
29
+ * Creates the default associated groups (Members, Owners, Visitors) and gives them the default permissions on the site.
30
+ * The target site must have unique permissions and no associated members / owners / visitors groups
31
+ *
32
+ * @param groupNameSeed The base group name. E.g. 'TestSite' would produce 'TestSite Members' etc.
33
+ * @param siteOwner The user login name to be added to the site Owners group. Default is the current user
34
+ * @param copyRoleAssignments Optional. If true the permissions are copied from the current parent scope
35
+ * @param clearSubscopes Optional. true to make all child securable objects inherit role assignments from the current object
36
+ * @param siteOwner2 Optional. The second user login name to be added to the site Owners group. Default is empty
37
+ */
38
+ createDefaultAssociatedGroups(groupNameSeed: string, siteOwner: string, copyRoleAssignments?: boolean, clearSubscopes?: boolean, siteOwner2?: string): Promise<void>;
39
+ }
40
+ }
41
41
  //# sourceMappingURL=web.d.ts.map
@@ -1,31 +1,31 @@
1
- import { __awaiter, __generator } from "tslib";
2
- import { addProp } from "@pnp/odata";
3
- import { _Web, Web } from "../webs/types.js";
4
- import { SiteGroups, SiteGroup } from "./types.js";
5
- import { spPost } from "../operations.js";
6
- import { escapeQueryStrValue } from "../utils/escapeQueryStrValue.js";
7
- import "../security/web.js";
8
- addProp(_Web, "siteGroups", SiteGroups);
9
- addProp(_Web, "associatedOwnerGroup", SiteGroup, "associatedownergroup");
10
- addProp(_Web, "associatedMemberGroup", SiteGroup, "associatedmembergroup");
11
- addProp(_Web, "associatedVisitorGroup", SiteGroup, "associatedvisitorgroup");
12
- _Web.prototype.createDefaultAssociatedGroups = function (groupNameSeed, siteOwner, copyRoleAssignments, clearSubscopes, siteOwner2) {
13
- if (copyRoleAssignments === void 0) { copyRoleAssignments = false; }
14
- if (clearSubscopes === void 0) { clearSubscopes = true; }
15
- return __awaiter(this, void 0, void 0, function () {
16
- var q;
17
- return __generator(this, function (_a) {
18
- switch (_a.label) {
19
- case 0: return [4 /*yield*/, this.breakRoleInheritance(copyRoleAssignments, clearSubscopes)];
20
- case 1:
21
- _a.sent();
22
- q = this.clone(Web, "createDefaultAssociatedGroups(userLogin=@u,userLogin2=@v,groupNameSeed=@s)");
23
- q.query.set("@u", "'" + escapeQueryStrValue(siteOwner || "") + "'");
24
- q.query.set("@v", "'" + escapeQueryStrValue(siteOwner2 || "") + "'");
25
- q.query.set("@s", "'" + escapeQueryStrValue(groupNameSeed || "") + "'");
26
- return [2 /*return*/, spPost(q)];
27
- }
28
- });
29
- });
30
- };
1
+ import { __awaiter, __generator } from "tslib";
2
+ import { addProp } from "@pnp/odata";
3
+ import { _Web, Web } from "../webs/types.js";
4
+ import { SiteGroups, SiteGroup } from "./types.js";
5
+ import { spPost } from "../operations.js";
6
+ import { escapeQueryStrValue } from "../utils/escapeQueryStrValue.js";
7
+ import "../security/web.js";
8
+ addProp(_Web, "siteGroups", SiteGroups);
9
+ addProp(_Web, "associatedOwnerGroup", SiteGroup, "associatedownergroup");
10
+ addProp(_Web, "associatedMemberGroup", SiteGroup, "associatedmembergroup");
11
+ addProp(_Web, "associatedVisitorGroup", SiteGroup, "associatedvisitorgroup");
12
+ _Web.prototype.createDefaultAssociatedGroups = function (groupNameSeed, siteOwner, copyRoleAssignments, clearSubscopes, siteOwner2) {
13
+ if (copyRoleAssignments === void 0) { copyRoleAssignments = false; }
14
+ if (clearSubscopes === void 0) { clearSubscopes = true; }
15
+ return __awaiter(this, void 0, void 0, function () {
16
+ var q;
17
+ return __generator(this, function (_a) {
18
+ switch (_a.label) {
19
+ case 0: return [4 /*yield*/, this.breakRoleInheritance(copyRoleAssignments, clearSubscopes)];
20
+ case 1:
21
+ _a.sent();
22
+ q = this.clone(Web, "createDefaultAssociatedGroups(userLogin=@u,userLogin2=@v,groupNameSeed=@s)");
23
+ q.query.set("@u", "'" + escapeQueryStrValue(siteOwner || "") + "'");
24
+ q.query.set("@v", "'" + escapeQueryStrValue(siteOwner2 || "") + "'");
25
+ q.query.set("@s", "'" + escapeQueryStrValue(groupNameSeed || "") + "'");
26
+ return [2 /*return*/, spPost(q)];
27
+ }
28
+ });
29
+ });
30
+ };
31
31
  //# sourceMappingURL=web.js.map
@@ -1,10 +1,10 @@
1
- import "./web.js";
2
- import "./list.js";
3
- import { ISiteScripts } from "./types.js";
4
- export { SiteScripts, ISiteScripts, ISiteScriptInfo, ISiteScriptUpdateInfo, ISiteScriptSerializationInfo, ISiteScriptSerializationResult, } from "./types.js";
5
- declare module "../rest" {
6
- interface SPRest {
7
- readonly siteScripts: ISiteScripts;
8
- }
9
- }
1
+ import "./web.js";
2
+ import "./list.js";
3
+ import { ISiteScripts } from "./types.js";
4
+ export { SiteScripts, ISiteScripts, ISiteScriptInfo, ISiteScriptUpdateInfo, ISiteScriptSerializationInfo, ISiteScriptSerializationResult, } from "./types.js";
5
+ declare module "../rest" {
6
+ interface SPRest {
7
+ readonly siteScripts: ISiteScripts;
8
+ }
9
+ }
10
10
  //# sourceMappingURL=index.d.ts.map
@@ -1,16 +1,16 @@
1
- import "./web.js";
2
- import "./list.js";
3
- import { SPRest } from "../rest.js";
4
- import { SiteScripts } from "./types.js";
5
- export { SiteScripts, } from "./types.js";
6
- Reflect.defineProperty(SPRest.prototype, "siteScripts", {
7
- configurable: true,
8
- enumerable: true,
9
- get: function () {
10
- return this.childConfigHook(function (_a) {
11
- var options = _a.options, baseUrl = _a.baseUrl, runtime = _a.runtime;
12
- return SiteScripts(baseUrl).configure(options).setRuntime(runtime);
13
- });
14
- },
15
- });
1
+ import "./web.js";
2
+ import "./list.js";
3
+ import { SPRest } from "../rest.js";
4
+ import { SiteScripts } from "./types.js";
5
+ export { SiteScripts, } from "./types.js";
6
+ Reflect.defineProperty(SPRest.prototype, "siteScripts", {
7
+ configurable: true,
8
+ enumerable: true,
9
+ get: function () {
10
+ return this.childConfigHook(function (_a) {
11
+ var options = _a.options, baseUrl = _a.baseUrl, runtime = _a.runtime;
12
+ return SiteScripts(baseUrl).configure(options).setRuntime(runtime);
13
+ });
14
+ },
15
+ });
16
16
  //# sourceMappingURL=index.js.map
@@ -1,13 +1,13 @@
1
- import "../folders/list.js";
2
- declare module "../lists/types" {
3
- interface _List {
4
- getSiteScript(): Promise<string>;
5
- }
6
- interface IList {
7
- /**
8
- * Gets the site script syntax (JSON) from the current list
9
- */
10
- getSiteScript(): Promise<string>;
11
- }
12
- }
1
+ import "../folders/list.js";
2
+ declare module "../lists/types" {
3
+ interface _List {
4
+ getSiteScript(): Promise<string>;
5
+ }
6
+ interface IList {
7
+ /**
8
+ * Gets the site script syntax (JSON) from the current list
9
+ */
10
+ getSiteScript(): Promise<string>;
11
+ }
12
+ }
13
13
  //# sourceMappingURL=list.d.ts.map