@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
@@ -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