@pnp/cli-microsoft365 10.0.0-beta.a868b81 → 10.0.0-beta.c07d83f

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 (91) hide show
  1. package/allCommands.json +1 -1
  2. package/allCommandsFull.json +1 -1
  3. package/dist/Auth.js +6 -4
  4. package/dist/AuthServer.js +7 -7
  5. package/dist/Command.js +4 -1
  6. package/dist/api.js +1 -1
  7. package/dist/m365/commands/login.js +1 -1
  8. package/dist/m365/file/commands/file-move.js +135 -0
  9. package/dist/m365/file/commands.js +2 -1
  10. package/dist/m365/flow/commands/recyclebinitem/recyclebinitem-list.js +47 -0
  11. package/dist/m365/flow/commands/recyclebinitem/recyclebinitem-restore.js +48 -0
  12. package/dist/m365/flow/commands.js +2 -0
  13. package/dist/m365/spfx/commands/project/project-doctor/doctor-1.20.0-rc.1.js +25 -0
  14. package/dist/m365/spfx/commands/project/project-doctor.js +2 -1
  15. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.20.0-rc.1.js +57 -0
  16. package/dist/m365/spfx/commands/project/project-upgrade.js +16 -13
  17. package/dist/m365/spfx/commands/spfx-doctor.js +15 -0
  18. package/dist/m365/spo/commands/file/file-copy.js +5 -1
  19. package/dist/m365/spo/commands/file/file-move.js +55 -33
  20. package/dist/m365/spo/commands/folder/folder-sharinglink-add.js +143 -0
  21. package/dist/m365/spo/commands/folder/folder-sharinglink-clear.js +111 -0
  22. package/dist/m365/spo/commands/folder/folder-sharinglink-remove.js +95 -0
  23. package/dist/m365/spo/commands/site/SiteAdmin.js +2 -0
  24. package/dist/m365/spo/commands/site/site-admin-add.js +252 -0
  25. package/dist/m365/spo/commands/site/site-admin-list.js +2 -27
  26. package/dist/m365/spo/commands/site/site-admin-remove.js +193 -0
  27. package/dist/m365/spo/commands/sitescript/sitescript-get.js +3 -2
  28. package/dist/m365/spo/commands/user/user-get.js +67 -9
  29. package/dist/m365/spo/commands.js +5 -0
  30. package/dist/m365/spp/commands/contentcenter/contentcenter-list.js +56 -0
  31. package/dist/m365/spp/commands.js +5 -0
  32. package/dist/m365/teams/MeetingTranscript.js +2 -0
  33. package/dist/m365/teams/commands/meeting/meeting-transcript-get.js +152 -0
  34. package/dist/m365/teams/commands.js +1 -0
  35. package/dist/request.js +46 -61
  36. package/dist/utils/driveUtil.js +51 -0
  37. package/dist/utils/spo.js +48 -1
  38. package/dist/utils/timersUtil.js +12 -0
  39. package/dist/utils/zod.js +1 -1
  40. package/docs/docs/cmd/entra/m365group/m365group-report-activitystorage.mdx +2 -2
  41. package/docs/docs/cmd/file/file-move.mdx +79 -0
  42. package/docs/docs/cmd/flow/recyclebinitem/recyclebinitem-list.mdx +132 -0
  43. package/docs/docs/cmd/flow/recyclebinitem/recyclebinitem-restore.mdx +55 -0
  44. package/docs/docs/cmd/spo/cdn/cdn-get.mdx +1 -1
  45. package/docs/docs/cmd/spo/cdn/cdn-origin-add.mdx +1 -1
  46. package/docs/docs/cmd/spo/cdn/cdn-origin-list.mdx +1 -1
  47. package/docs/docs/cmd/spo/cdn/cdn-origin-remove.mdx +1 -1
  48. package/docs/docs/cmd/spo/cdn/cdn-policy-list.mdx +1 -1
  49. package/docs/docs/cmd/spo/cdn/cdn-policy-set.mdx +1 -1
  50. package/docs/docs/cmd/spo/externaluser/externaluser-list.mdx +1 -1
  51. package/docs/docs/cmd/spo/file/file-move.mdx +116 -9
  52. package/docs/docs/cmd/spo/folder/folder-sharinglink-add.mdx +125 -0
  53. package/docs/docs/cmd/spo/folder/folder-sharinglink-clear.mdx +50 -0
  54. package/docs/docs/cmd/spo/folder/folder-sharinglink-remove.mdx +50 -0
  55. package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-get.mdx +1 -1
  56. package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-set.mdx +1 -1
  57. package/docs/docs/cmd/spo/homesite/homesite-remove.mdx +1 -1
  58. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-get.mdx +1 -1
  59. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-remove.mdx +1 -1
  60. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-set.mdx +1 -1
  61. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-add.mdx +1 -1
  62. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-list.mdx +1 -1
  63. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-remove.mdx +1 -1
  64. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-list.mdx +1 -1
  65. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-remove.mdx +1 -1
  66. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-set.mdx +1 -1
  67. package/docs/docs/cmd/spo/site/site-admin-add.mdx +67 -0
  68. package/docs/docs/cmd/spo/site/site-admin-remove.mdx +67 -0
  69. package/docs/docs/cmd/spo/site/site-appcatalog-add.mdx +1 -1
  70. package/docs/docs/cmd/spo/site/site-appcatalog-remove.mdx +1 -1
  71. package/docs/docs/cmd/spo/site/site-commsite-enable.mdx +1 -1
  72. package/docs/docs/cmd/spo/site/site-list.mdx +6 -4
  73. package/docs/docs/cmd/spo/site/site-set.mdx +1 -1
  74. package/docs/docs/cmd/spo/sitescript/sitescript-get.mdx +14 -1
  75. package/docs/docs/cmd/spo/storageentity/storageentity-remove.mdx +1 -1
  76. package/docs/docs/cmd/spo/storageentity/storageentity-set.mdx +1 -1
  77. package/docs/docs/cmd/spo/tenant/tenant-appcatalog-add.mdx +1 -1
  78. package/docs/docs/cmd/spo/tenant/tenant-appcatalogurl-get.mdx +1 -1
  79. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-list.mdx +1 -1
  80. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-remove.mdx +1 -1
  81. package/docs/docs/cmd/spo/tenant/tenant-settings-list.mdx +1 -1
  82. package/docs/docs/cmd/spo/theme/theme-apply.mdx +1 -1
  83. package/docs/docs/cmd/spo/theme/theme-get.mdx +1 -1
  84. package/docs/docs/cmd/spo/theme/theme-list.mdx +1 -1
  85. package/docs/docs/cmd/spo/theme/theme-remove.mdx +1 -1
  86. package/docs/docs/cmd/spo/theme/theme-set.mdx +1 -1
  87. package/docs/docs/cmd/spo/user/user-get.mdx +35 -9
  88. package/docs/docs/cmd/spp/contentcenter/contentcenter-list.mdx +287 -0
  89. package/docs/docs/cmd/teams/meeting/meeting-transcript-get.mdx +132 -0
  90. package/npm-shrinkwrap.json +203 -375
  91. package/package.json +16 -17
@@ -0,0 +1,252 @@
1
+ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
2
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
3
+ if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
4
+ return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
5
+ };
6
+ var _SpoSiteAdminAddCommand_instances, _SpoSiteAdminAddCommand_initTelemetry, _SpoSiteAdminAddCommand_initOptions, _SpoSiteAdminAddCommand_initValidators, _SpoSiteAdminAddCommand_initOptionSets, _SpoSiteAdminAddCommand_initTypes;
7
+ import config from '../../../../config.js';
8
+ import request from '../../../../request.js';
9
+ import { entraGroup } from '../../../../utils/entraGroup.js';
10
+ import { entraUser } from '../../../../utils/entraUser.js';
11
+ import { formatting } from '../../../../utils/formatting.js';
12
+ import { spo } from '../../../../utils/spo.js';
13
+ import { validation } from '../../../../utils/validation.js';
14
+ import SpoCommand from '../../../base/SpoCommand.js';
15
+ import commands from '../../commands.js';
16
+ class SpoSiteAdminAddCommand extends SpoCommand {
17
+ get name() {
18
+ return commands.SITE_ADMIN_ADD;
19
+ }
20
+ get description() {
21
+ return 'Adds a user or group as a site collection administrator';
22
+ }
23
+ constructor() {
24
+ super();
25
+ _SpoSiteAdminAddCommand_instances.add(this);
26
+ __classPrivateFieldGet(this, _SpoSiteAdminAddCommand_instances, "m", _SpoSiteAdminAddCommand_initTelemetry).call(this);
27
+ __classPrivateFieldGet(this, _SpoSiteAdminAddCommand_instances, "m", _SpoSiteAdminAddCommand_initOptions).call(this);
28
+ __classPrivateFieldGet(this, _SpoSiteAdminAddCommand_instances, "m", _SpoSiteAdminAddCommand_initValidators).call(this);
29
+ __classPrivateFieldGet(this, _SpoSiteAdminAddCommand_instances, "m", _SpoSiteAdminAddCommand_initOptionSets).call(this);
30
+ __classPrivateFieldGet(this, _SpoSiteAdminAddCommand_instances, "m", _SpoSiteAdminAddCommand_initTypes).call(this);
31
+ }
32
+ async commandAction(logger, args) {
33
+ try {
34
+ const loginNameToAdd = await this.getCorrectLoginName(args.options);
35
+ if (args.options.asAdmin) {
36
+ await this.callActionAsAdmin(logger, args, loginNameToAdd);
37
+ return;
38
+ }
39
+ await this.callAction(logger, args, loginNameToAdd);
40
+ }
41
+ catch (err) {
42
+ this.handleRejectedODataJsonPromise(err);
43
+ }
44
+ }
45
+ async callActionAsAdmin(logger, args, loginNameToAdd) {
46
+ if (this.verbose) {
47
+ await logger.logToStderr('Adding site administrator as an administrator...');
48
+ }
49
+ const adminUrl = await spo.getSpoAdminUrl(logger, this.debug);
50
+ const siteId = await this.getSiteIdBasedOnUrl(args.options.siteUrl, logger);
51
+ const siteAdmins = (await this.getSiteAdmins(adminUrl, siteId)).map(u => u.loginName);
52
+ siteAdmins.push(loginNameToAdd);
53
+ await this.setSiteAdminsAsAdmin(adminUrl, siteId, siteAdmins);
54
+ if (args.options.primary) {
55
+ await this.setPrimaryAdminAsAdmin(adminUrl, siteId, loginNameToAdd);
56
+ }
57
+ }
58
+ async getSiteIdBasedOnUrl(siteUrl, logger) {
59
+ const siteGraphId = await spo.getSiteId(siteUrl, logger, this.verbose);
60
+ const match = siteGraphId.match(/,([a-f0-9\-]{36}),/i);
61
+ if (!match) {
62
+ throw `Site with URL ${siteUrl} not found`;
63
+ }
64
+ return match[1];
65
+ }
66
+ async getSiteAdmins(adminUrl, siteId) {
67
+ const requestOptions = {
68
+ url: `${adminUrl}/_api/SPO.Tenant/GetSiteAdministrators?siteId='${siteId}'`,
69
+ headers: {
70
+ accept: 'application/json;odata=nometadata',
71
+ 'content-type': 'application/json;charset=utf-8'
72
+ }
73
+ };
74
+ const response = await request.post(requestOptions);
75
+ const responseContent = JSON.parse(response);
76
+ return responseContent.value;
77
+ }
78
+ async getCorrectLoginName(options) {
79
+ if (options.userId || options.userName) {
80
+ const userPrincipalName = options.userName ? options.userName : await entraUser.getUpnByUserId(options.userId);
81
+ if (userPrincipalName) {
82
+ return `i:0#.f|membership|${userPrincipalName}`;
83
+ }
84
+ throw 'User not found.';
85
+ }
86
+ else {
87
+ const group = options.groupId ? await entraGroup.getGroupById(options.groupId) : await entraGroup.getGroupByDisplayName(options.groupName);
88
+ //for entra groups, M365 groups have an associated email and security groups don't
89
+ if (group?.mail) {
90
+ //M365 group is prefixed with c:0o.c|federateddirectoryclaimprovider
91
+ return `c:0o.c|federateddirectoryclaimprovider|${group.id}`;
92
+ }
93
+ else {
94
+ //security group is prefixed with c:0t.c|tenant
95
+ return `c:0t.c|tenant|${group?.id}`;
96
+ }
97
+ }
98
+ }
99
+ async setSiteAdminsAsAdmin(adminUrl, siteId, admins) {
100
+ const requestOptions = {
101
+ url: `${adminUrl}/_api/SPOInternalUseOnly.Tenant/SetSiteSecondaryAdministrators`,
102
+ headers: {
103
+ accept: 'application/json;odata=nometadata',
104
+ 'content-type': 'application/json;charset=utf-8'
105
+ },
106
+ data: {
107
+ secondaryAdministratorsFieldsData: {
108
+ siteId: siteId,
109
+ secondaryAdministratorLoginNames: admins
110
+ }
111
+ }
112
+ };
113
+ return request.post(requestOptions);
114
+ }
115
+ async setPrimaryAdminAsAdmin(adminUrl, siteId, adminLogin) {
116
+ const requestOptions = {
117
+ url: `${adminUrl}/_api/SPO.Tenant/sites('${siteId}')`,
118
+ headers: {
119
+ accept: 'application/json;odata=nometadata',
120
+ 'content-type': 'application/json;charset=utf-8'
121
+ },
122
+ data: {
123
+ Owner: adminLogin,
124
+ SetOwnerWithoutUpdatingSecondaryAdmin: true
125
+ }
126
+ };
127
+ return request.patch(requestOptions);
128
+ }
129
+ async callAction(logger, args, loginNameToAdd) {
130
+ if (this.verbose) {
131
+ await logger.logToStderr('Adding site administrator...');
132
+ }
133
+ const ensuredUserData = await this.ensureUser(args, loginNameToAdd);
134
+ await this.setSiteAdmin(args.options.siteUrl, loginNameToAdd);
135
+ if (args.options.primary) {
136
+ const siteId = await this.getSiteId(args.options.siteUrl);
137
+ const previousPrimaryOwner = await this.getSiteOwnerLoginName(args.options.siteUrl);
138
+ await this.setPrimaryOwnerLoginFromSite(logger, args.options.siteUrl, siteId, ensuredUserData);
139
+ await this.setSiteAdmin(args.options.siteUrl, previousPrimaryOwner);
140
+ }
141
+ }
142
+ async ensureUser(args, loginName) {
143
+ const requestOptions = {
144
+ url: `${args.options.siteUrl}/_api/web/ensureuser`,
145
+ headers: {
146
+ accept: 'application/json;odata=nometadata'
147
+ },
148
+ data: {
149
+ logonName: loginName
150
+ },
151
+ responseType: 'json'
152
+ };
153
+ return request.post(requestOptions);
154
+ }
155
+ async setSiteAdmin(siteUrl, loginName) {
156
+ const requestOptions = {
157
+ url: `${siteUrl}/_api/web/siteusers('${formatting.encodeQueryParameter(loginName)}')`,
158
+ headers: {
159
+ 'accept': 'application/json',
160
+ 'X-Http-Method': 'MERGE',
161
+ 'If-Match': '*'
162
+ },
163
+ data: { IsSiteAdmin: true },
164
+ responseType: 'json'
165
+ };
166
+ return request.post(requestOptions);
167
+ }
168
+ async getSiteId(siteUrl) {
169
+ const requestOptions = {
170
+ url: `${siteUrl}/_api/site?$select=Id`,
171
+ headers: {
172
+ accept: 'application/json;odata=nometadata'
173
+ },
174
+ responseType: 'json'
175
+ };
176
+ const response = await request.get(requestOptions);
177
+ return response.Id;
178
+ }
179
+ async getSiteOwnerLoginName(siteUrl) {
180
+ const requestOptions = {
181
+ url: `${siteUrl}/_api/site/owner?$select=LoginName`,
182
+ headers: {
183
+ accept: 'application/json;odata=nometadata'
184
+ },
185
+ responseType: 'json'
186
+ };
187
+ const response = await request.get(requestOptions);
188
+ return response.LoginName;
189
+ }
190
+ async setPrimaryOwnerLoginFromSite(logger, siteUrl, siteId, loginName) {
191
+ const res = await spo.ensureFormDigest(siteUrl, logger, undefined, this.debug);
192
+ const body = `<Request xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config.applicationName}"><Actions><SetProperty Id="10" ObjectPathId="2" Name="Owner"><Parameter ObjectPathId="3" /></SetProperty></Actions><ObjectPaths><Property Id="2" ParentId="0" Name="Site" /><Identity Id="3" Name="6d452ba1-40a8-8000-e00d-46e1adaa12bf|740c6a0b-85e2-48a0-a494-e0f1759d4aa7:site:${siteId}:u:${loginName.Id}" /><StaticProperty Id="0" TypeId="{3747adcd-a3c3-41b9-bfab-4a64dd2f1e0a}" Name="Current" /></ObjectPaths></Request>`;
193
+ const requestOptions = {
194
+ url: `${siteUrl}/_vti_bin/client.svc/ProcessQuery`,
195
+ headers: {
196
+ 'X-RequestDigest': res.FormDigestValue
197
+ },
198
+ data: body
199
+ };
200
+ return request.post(requestOptions);
201
+ }
202
+ }
203
+ _SpoSiteAdminAddCommand_instances = new WeakSet(), _SpoSiteAdminAddCommand_initTelemetry = function _SpoSiteAdminAddCommand_initTelemetry() {
204
+ this.telemetry.push((args) => {
205
+ Object.assign(this.telemetryProperties, {
206
+ userId: typeof args.options.userId !== 'undefined',
207
+ userName: typeof args.options.userName !== 'undefined',
208
+ groupId: typeof args.options.groupId !== 'undefined',
209
+ groupName: typeof args.options.groupName !== 'undefined',
210
+ primary: !!args.options.primary,
211
+ asAdmin: !!args.options.asAdmin
212
+ });
213
+ });
214
+ }, _SpoSiteAdminAddCommand_initOptions = function _SpoSiteAdminAddCommand_initOptions() {
215
+ this.options.unshift({
216
+ option: '-u, --siteUrl <siteUrl>'
217
+ }, {
218
+ option: '--userId [userId]'
219
+ }, {
220
+ option: '--userName [userName]'
221
+ }, {
222
+ option: '--groupId [groupId]'
223
+ }, {
224
+ option: '--groupName [groupName]'
225
+ }, {
226
+ option: '--primary'
227
+ }, {
228
+ option: '--asAdmin'
229
+ });
230
+ }, _SpoSiteAdminAddCommand_initValidators = function _SpoSiteAdminAddCommand_initValidators() {
231
+ this.validators.push(async (args) => {
232
+ if (args.options.userId &&
233
+ !validation.isValidGuid(args.options.userId)) {
234
+ return `'${args.options.userId}' is not a valid GUID for option 'userId'`;
235
+ }
236
+ if (args.options.userName && !validation.isValidUserPrincipalName(args.options.userName)) {
237
+ return `'${args.options.userName}' is not a valid 'userName'`;
238
+ }
239
+ if (args.options.groupId &&
240
+ !validation.isValidGuid(args.options.groupId)) {
241
+ return `'${args.options.groupId}' is not a valid GUID for option 'groupId'`;
242
+ }
243
+ return validation.isValidSharePointUrl(args.options.siteUrl);
244
+ });
245
+ }, _SpoSiteAdminAddCommand_initOptionSets = function _SpoSiteAdminAddCommand_initOptionSets() {
246
+ this.optionSets.push({ options: ['userId', 'userName', 'groupId', 'groupName'] });
247
+ }, _SpoSiteAdminAddCommand_initTypes = function _SpoSiteAdminAddCommand_initTypes() {
248
+ this.types.string.push('siteUrl', 'userId', 'userName', 'groupId', 'groupName');
249
+ this.types.boolean.push('primary', 'asAdmin');
250
+ };
251
+ export default new SpoSiteAdminAddCommand();
252
+ //# sourceMappingURL=site-admin-add.js.map
@@ -52,7 +52,7 @@ class SpoSiteAdminListCommand extends SpoCommand {
52
52
  };
53
53
  const response = await request.post(requestOptions);
54
54
  const responseContent = JSON.parse(response);
55
- const primaryAdminLoginName = await this.getPrimaryAdminLoginNameFromAdmin(adminUrl, siteId);
55
+ const primaryAdminLoginName = await spo.getPrimaryAdminLoginNameAsAdmin(adminUrl, siteId, logger, this.verbose);
56
56
  const mappedResult = responseContent.value.map((u) => ({
57
57
  Id: null,
58
58
  Email: u.email,
@@ -72,18 +72,6 @@ class SpoSiteAdminListCommand extends SpoCommand {
72
72
  }
73
73
  return match[1];
74
74
  }
75
- async getPrimaryAdminLoginNameFromAdmin(adminUrl, siteId) {
76
- const requestOptions = {
77
- url: `${adminUrl}/_api/SPO.Tenant/sites('${siteId}')?$select=OwnerLoginName`,
78
- headers: {
79
- accept: 'application/json;odata=nometadata',
80
- 'content-type': 'application/json;charset=utf-8'
81
- }
82
- };
83
- const response = await request.get(requestOptions);
84
- const responseContent = JSON.parse(response);
85
- return responseContent.OwnerLoginName;
86
- }
87
75
  async callAction(logger, args) {
88
76
  if (this.verbose) {
89
77
  await logger.logToStderr('Retrieving site administrators...');
@@ -97,7 +85,7 @@ class SpoSiteAdminListCommand extends SpoCommand {
97
85
  responseType: 'json'
98
86
  };
99
87
  const responseContent = await request.get(requestOptions);
100
- const primaryOwnerLogin = await this.getPrimaryOwnerLoginFromSite(args.options.siteUrl);
88
+ const primaryOwnerLogin = await spo.getPrimaryOwnerLoginFromSite(args.options.siteUrl, logger, this.verbose);
101
89
  const mappedResult = responseContent.value.map((u) => ({
102
90
  Id: u.Id,
103
91
  LoginName: u.LoginName,
@@ -109,23 +97,10 @@ class SpoSiteAdminListCommand extends SpoCommand {
109
97
  }));
110
98
  await logger.log(mappedResult);
111
99
  }
112
- async getPrimaryOwnerLoginFromSite(siteUrl) {
113
- const requestOptions = {
114
- url: `${siteUrl}/_api/site/owner`,
115
- method: 'GET',
116
- headers: {
117
- 'accept': 'application/json;odata=nometadata'
118
- },
119
- responseType: 'json'
120
- };
121
- const responseContent = await request.get(requestOptions);
122
- return responseContent?.LoginName ?? null;
123
- }
124
100
  }
125
101
  _SpoSiteAdminListCommand_instances = new WeakSet(), _SpoSiteAdminListCommand_initTelemetry = function _SpoSiteAdminListCommand_initTelemetry() {
126
102
  this.telemetry.push((args) => {
127
103
  Object.assign(this.telemetryProperties, {
128
- siteUrl: typeof args.options.siteUrl !== 'undefined',
129
104
  asAdmin: !!args.options.asAdmin
130
105
  });
131
106
  });
@@ -0,0 +1,193 @@
1
+ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
2
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
3
+ if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
4
+ return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
5
+ };
6
+ var _SpoSiteAdminRemoveCommand_instances, _SpoSiteAdminRemoveCommand_initTelemetry, _SpoSiteAdminRemoveCommand_initOptions, _SpoSiteAdminRemoveCommand_initValidators, _SpoSiteAdminRemoveCommand_initOptionSets, _SpoSiteAdminRemoveCommand_initTypes;
7
+ import { cli } from '../../../../cli/cli.js';
8
+ import request from '../../../../request.js';
9
+ import { entraGroup } from '../../../../utils/entraGroup.js';
10
+ import { entraUser } from '../../../../utils/entraUser.js';
11
+ import { formatting } from '../../../../utils/formatting.js';
12
+ import { spo } from '../../../../utils/spo.js';
13
+ import { validation } from '../../../../utils/validation.js';
14
+ import SpoCommand from '../../../base/SpoCommand.js';
15
+ import commands from '../../commands.js';
16
+ class SpoSiteAdminRemoveCommand extends SpoCommand {
17
+ get name() {
18
+ return commands.SITE_ADMIN_REMOVE;
19
+ }
20
+ get description() {
21
+ return 'Removes a user or group as site collection administrator';
22
+ }
23
+ constructor() {
24
+ super();
25
+ _SpoSiteAdminRemoveCommand_instances.add(this);
26
+ __classPrivateFieldGet(this, _SpoSiteAdminRemoveCommand_instances, "m", _SpoSiteAdminRemoveCommand_initTelemetry).call(this);
27
+ __classPrivateFieldGet(this, _SpoSiteAdminRemoveCommand_instances, "m", _SpoSiteAdminRemoveCommand_initOptions).call(this);
28
+ __classPrivateFieldGet(this, _SpoSiteAdminRemoveCommand_instances, "m", _SpoSiteAdminRemoveCommand_initValidators).call(this);
29
+ __classPrivateFieldGet(this, _SpoSiteAdminRemoveCommand_instances, "m", _SpoSiteAdminRemoveCommand_initOptionSets).call(this);
30
+ __classPrivateFieldGet(this, _SpoSiteAdminRemoveCommand_instances, "m", _SpoSiteAdminRemoveCommand_initTypes).call(this);
31
+ }
32
+ async commandAction(logger, args) {
33
+ try {
34
+ if (!args.options.force) {
35
+ const principalToDelete = args.options.groupId || args.options.groupName ? 'group' : 'user';
36
+ const result = await cli.promptForConfirmation({ message: `Are you sure you want to remove specified ${principalToDelete} from the site administrators list ${args.options.siteUrl}?` });
37
+ if (!result) {
38
+ return;
39
+ }
40
+ }
41
+ const loginNameToRemove = await this.getCorrectLoginName(args.options);
42
+ if (args.options.asAdmin) {
43
+ await this.callActionAsAdmin(logger, args, loginNameToRemove);
44
+ return;
45
+ }
46
+ await this.callAction(logger, args, loginNameToRemove);
47
+ }
48
+ catch (err) {
49
+ this.handleRejectedODataJsonPromise(err);
50
+ }
51
+ }
52
+ async callActionAsAdmin(logger, args, loginNameToRemove) {
53
+ if (this.verbose) {
54
+ await logger.logToStderr('Removing site administrator as an administrator...');
55
+ }
56
+ const adminUrl = await spo.getSpoAdminUrl(logger, this.debug);
57
+ const siteId = await this.getSiteId(args.options.siteUrl, logger);
58
+ const primaryAdminLoginName = await spo.getPrimaryAdminLoginNameAsAdmin(adminUrl, siteId, logger, this.verbose);
59
+ if (loginNameToRemove === primaryAdminLoginName) {
60
+ throw 'You cannot remove the primary site collection administrator.';
61
+ }
62
+ const existingAdmins = await this.getSiteAdmins(adminUrl, siteId);
63
+ const adminsToSet = existingAdmins.filter(u => u.loginName.toLowerCase() !== loginNameToRemove.toLowerCase());
64
+ await this.setSiteAdminsAsAdmin(adminUrl, siteId, adminsToSet);
65
+ }
66
+ async getSiteId(siteUrl, logger) {
67
+ const siteGraphId = await spo.getSiteId(siteUrl, logger, this.verbose);
68
+ const match = siteGraphId.match(/,([a-f0-9\-]{36}),/i);
69
+ if (!match) {
70
+ throw `Site with URL ${siteUrl} not found`;
71
+ }
72
+ return match[1];
73
+ }
74
+ async getSiteAdmins(adminUrl, siteId) {
75
+ const requestOptions = {
76
+ url: `${adminUrl}/_api/SPO.Tenant/GetSiteAdministrators?siteId='${siteId}'`,
77
+ headers: {
78
+ accept: 'application/json;odata=nometadata',
79
+ 'content-type': 'application/json;charset=utf-8'
80
+ }
81
+ };
82
+ const response = await request.post(requestOptions);
83
+ const responseContent = JSON.parse(response);
84
+ return responseContent.value;
85
+ }
86
+ async getCorrectLoginName(options) {
87
+ if (options.userId || options.userName) {
88
+ const userPrincipalName = options.userName ? options.userName : await entraUser.getUpnByUserId(options.userId);
89
+ if (userPrincipalName) {
90
+ return `i:0#.f|membership|${userPrincipalName}`;
91
+ }
92
+ throw 'User not found.';
93
+ }
94
+ else {
95
+ const group = options.groupId ? await entraGroup.getGroupById(options.groupId) : await entraGroup.getGroupByDisplayName(options.groupName);
96
+ //for entra groups, M365 groups have an associated email and security groups don't
97
+ if (group?.mail) {
98
+ //M365 group is prefixed with c:0o.c|federateddirectoryclaimprovider
99
+ return `c:0o.c|federateddirectoryclaimprovider|${group.id}`;
100
+ }
101
+ else {
102
+ //security group is prefixed with c:0t.c|tenant
103
+ return `c:0t.c|tenant|${group?.id}`;
104
+ }
105
+ }
106
+ }
107
+ async setSiteAdminsAsAdmin(adminUrl, siteId, admins) {
108
+ const requestOptions = {
109
+ url: `${adminUrl}/_api/SPOInternalUseOnly.Tenant/SetSiteSecondaryAdministrators`,
110
+ headers: {
111
+ accept: 'application/json;odata=nometadata',
112
+ 'content-type': 'application/json;charset=utf-8'
113
+ },
114
+ data: {
115
+ secondaryAdministratorsFieldsData: {
116
+ siteId: siteId,
117
+ secondaryAdministratorLoginNames: admins.map(u => u.loginName)
118
+ }
119
+ }
120
+ };
121
+ await request.post(requestOptions);
122
+ }
123
+ async callAction(logger, args, loginNameToRemove) {
124
+ if (this.verbose) {
125
+ await logger.logToStderr('Removing site administrator...');
126
+ }
127
+ const primaryOwnerLogin = await spo.getPrimaryOwnerLoginFromSite(args.options.siteUrl, logger, this.verbose);
128
+ if (loginNameToRemove === primaryOwnerLogin) {
129
+ throw 'You cannot remove the primary site collection administrator.';
130
+ }
131
+ const requestOptions = {
132
+ url: `${args.options.siteUrl}/_api/web/siteusers('${formatting.encodeQueryParameter(loginNameToRemove)}')`,
133
+ headers: {
134
+ 'accept': 'application/json',
135
+ 'X-Http-Method': 'MERGE',
136
+ 'If-Match': '*'
137
+ },
138
+ data: { IsSiteAdmin: false },
139
+ responseType: 'json'
140
+ };
141
+ await request.post(requestOptions);
142
+ }
143
+ }
144
+ _SpoSiteAdminRemoveCommand_instances = new WeakSet(), _SpoSiteAdminRemoveCommand_initTelemetry = function _SpoSiteAdminRemoveCommand_initTelemetry() {
145
+ this.telemetry.push((args) => {
146
+ Object.assign(this.telemetryProperties, {
147
+ userId: typeof args.options.userId !== 'undefined',
148
+ userName: typeof args.options.userName !== 'undefined',
149
+ groupId: typeof args.options.groupId !== 'undefined',
150
+ groupName: typeof args.options.groupName !== 'undefined',
151
+ force: !!args.options.force,
152
+ asAdmin: !!args.options.asAdmin
153
+ });
154
+ });
155
+ }, _SpoSiteAdminRemoveCommand_initOptions = function _SpoSiteAdminRemoveCommand_initOptions() {
156
+ this.options.unshift({
157
+ option: '-u, --siteUrl <siteUrl>'
158
+ }, {
159
+ option: '--userId [userId]'
160
+ }, {
161
+ option: '--userName [userName]'
162
+ }, {
163
+ option: '--groupId [groupId]'
164
+ }, {
165
+ option: '--groupName [groupName]'
166
+ }, {
167
+ option: '--asAdmin'
168
+ }, {
169
+ option: '-f, --force'
170
+ });
171
+ }, _SpoSiteAdminRemoveCommand_initValidators = function _SpoSiteAdminRemoveCommand_initValidators() {
172
+ this.validators.push(async (args) => {
173
+ if (args.options.userId &&
174
+ !validation.isValidGuid(args.options.userId)) {
175
+ return `${args.options.userId} is not a valid GUID`;
176
+ }
177
+ if (args.options.userName && !validation.isValidUserPrincipalName(args.options.userName)) {
178
+ return `${args.options.userName} is not a valid userName`;
179
+ }
180
+ if (args.options.groupId &&
181
+ !validation.isValidGuid(args.options.groupId)) {
182
+ return `${args.options.groupId} is not a valid GUID`;
183
+ }
184
+ return validation.isValidSharePointUrl(args.options.siteUrl);
185
+ });
186
+ }, _SpoSiteAdminRemoveCommand_initOptionSets = function _SpoSiteAdminRemoveCommand_initOptionSets() {
187
+ this.optionSets.push({ options: ['userId', 'userName', 'groupId', 'groupName'] });
188
+ }, _SpoSiteAdminRemoveCommand_initTypes = function _SpoSiteAdminRemoveCommand_initTypes() {
189
+ this.types.string.push('siteUrl', 'userId', 'userName', 'groupId', 'groupName');
190
+ this.types.boolean.push('force', 'asAdmin');
191
+ };
192
+ export default new SpoSiteAdminRemoveCommand();
193
+ //# sourceMappingURL=site-admin-remove.js.map
@@ -37,8 +37,9 @@ class SpoSiteScriptGetCommand extends SpoCommand {
37
37
  responseType: 'json'
38
38
  };
39
39
  const response = await request.post(requestOptions);
40
- if (args.options.content === true) {
41
- await logger.log(JSON.parse(response.Content));
40
+ response.Content = JSON.parse(response.Content);
41
+ if (args.options.content) {
42
+ await logger.log(response.Content);
42
43
  return;
43
44
  }
44
45
  await logger.log(response);
@@ -3,8 +3,9 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
3
3
  if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
4
4
  return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
5
5
  };
6
- var _SpoUserGetCommand_instances, _SpoUserGetCommand_initTelemetry, _SpoUserGetCommand_initOptions, _SpoUserGetCommand_initValidators, _SpoUserGetCommand_initOptionSets;
6
+ var _SpoUserGetCommand_instances, _SpoUserGetCommand_initTelemetry, _SpoUserGetCommand_initOptions, _SpoUserGetCommand_initTypes, _SpoUserGetCommand_initValidators, _SpoUserGetCommand_initOptionSets;
7
7
  import request from '../../../../request.js';
8
+ import { entraGroup } from '../../../../utils/entraGroup.js';
8
9
  import { formatting } from '../../../../utils/formatting.js';
9
10
  import { validation } from '../../../../utils/validation.js';
10
11
  import SpoCommand from '../../../base/SpoCommand.js';
@@ -23,23 +24,38 @@ class SpoUserGetCommand extends SpoCommand {
23
24
  __classPrivateFieldGet(this, _SpoUserGetCommand_instances, "m", _SpoUserGetCommand_initOptions).call(this);
24
25
  __classPrivateFieldGet(this, _SpoUserGetCommand_instances, "m", _SpoUserGetCommand_initValidators).call(this);
25
26
  __classPrivateFieldGet(this, _SpoUserGetCommand_instances, "m", _SpoUserGetCommand_initOptionSets).call(this);
27
+ __classPrivateFieldGet(this, _SpoUserGetCommand_instances, "m", _SpoUserGetCommand_initTypes).call(this);
26
28
  }
27
29
  async commandAction(logger, args) {
28
30
  if (this.verbose) {
29
31
  await logger.logToStderr(`Retrieving information for user in site '${args.options.webUrl}'...`);
30
32
  }
31
- let requestUrl = '';
33
+ let requestUrl = `${args.options.webUrl}/_api/web/`;
32
34
  if (args.options.id) {
33
- requestUrl = `${args.options.webUrl}/_api/web/siteusers/GetById('${formatting.encodeQueryParameter(args.options.id.toString())}')`;
35
+ requestUrl += `siteusers/GetById('${formatting.encodeQueryParameter(args.options.id.toString())}')`;
34
36
  }
35
37
  else if (args.options.email) {
36
- requestUrl = `${args.options.webUrl}/_api/web/siteusers/GetByEmail('${formatting.encodeQueryParameter(args.options.email)}')`;
38
+ requestUrl += `siteusers/GetByEmail('${formatting.encodeQueryParameter(args.options.email)}')`;
37
39
  }
38
40
  else if (args.options.loginName) {
39
- requestUrl = `${args.options.webUrl}/_api/web/siteusers/GetByLoginName('${formatting.encodeQueryParameter(args.options.loginName)}')`;
41
+ requestUrl += `siteusers/GetByLoginName('${formatting.encodeQueryParameter(args.options.loginName)}')`;
42
+ }
43
+ else if (args.options.userName) {
44
+ const user = await this.getUser(requestUrl, args.options.userName);
45
+ requestUrl += `siteusers/GetById('${formatting.encodeQueryParameter(user.Id.toString())}')`;
46
+ }
47
+ else if (args.options.entraGroupId || args.options.entraGroupName) {
48
+ const entraGroup = await this.getEntraGroup(args.options.entraGroupId, args.options.entraGroupName);
49
+ // For entra groups, M365 groups have an associated email and security groups don't
50
+ if (entraGroup?.mail) {
51
+ requestUrl += `siteusers/GetByEmail('${formatting.encodeQueryParameter(entraGroup.mail)}')`;
52
+ }
53
+ else {
54
+ requestUrl += `siteusers/GetByLoginName('c:0t.c|tenant|${entraGroup?.id}')`;
55
+ }
40
56
  }
41
57
  else {
42
- requestUrl = `${args.options.webUrl}/_api/web/currentuser`;
58
+ requestUrl += `currentuser`;
43
59
  }
44
60
  const requestOptions = {
45
61
  url: requestUrl,
@@ -57,13 +73,38 @@ class SpoUserGetCommand extends SpoCommand {
57
73
  this.handleRejectedODataJsonPromise(err);
58
74
  }
59
75
  }
76
+ async getUser(baseUrl, userName) {
77
+ const requestUrl = `${baseUrl}siteusers?$filter=UserPrincipalName eq ('${formatting.encodeQueryParameter(userName)}')`;
78
+ const requestOptions = {
79
+ url: requestUrl,
80
+ headers: {
81
+ accept: 'application/json;odata=nometadata'
82
+ },
83
+ responseType: 'json'
84
+ };
85
+ const userInstance = await request.get(requestOptions);
86
+ const userInstanceValue = userInstance.value[0];
87
+ if (!userInstanceValue) {
88
+ throw `User not found: ${userName}`;
89
+ }
90
+ return userInstanceValue;
91
+ }
92
+ async getEntraGroup(entraGroupId, entraGroupName) {
93
+ if (entraGroupId) {
94
+ return entraGroup.getGroupById(entraGroupId);
95
+ }
96
+ return entraGroup.getGroupByDisplayName(entraGroupName);
97
+ }
60
98
  }
61
99
  _SpoUserGetCommand_instances = new WeakSet(), _SpoUserGetCommand_initTelemetry = function _SpoUserGetCommand_initTelemetry() {
62
100
  this.telemetry.push((args) => {
63
101
  Object.assign(this.telemetryProperties, {
64
102
  id: typeof args.options.id !== 'undefined',
65
103
  email: typeof args.options.email !== 'undefined',
66
- loginName: typeof args.options.loginName !== 'undefined'
104
+ loginName: typeof args.options.loginName !== 'undefined',
105
+ userName: typeof args.options.userName !== 'undefined',
106
+ entraGroupId: typeof args.options.entraGroupId !== 'undefined',
107
+ entraGroupName: typeof args.options.entraGroupName !== 'undefined'
67
108
  });
68
109
  });
69
110
  }, _SpoUserGetCommand_initOptions = function _SpoUserGetCommand_initOptions() {
@@ -75,19 +116,36 @@ _SpoUserGetCommand_instances = new WeakSet(), _SpoUserGetCommand_initTelemetry =
75
116
  option: '--email [email]'
76
117
  }, {
77
118
  option: '--loginName [loginName]'
119
+ }, {
120
+ option: '--userName [userName]'
121
+ }, {
122
+ option: '--entraGroupId [entraGroupId]'
123
+ }, {
124
+ option: '--entraGroupName [entraGroupName]'
78
125
  });
126
+ }, _SpoUserGetCommand_initTypes = function _SpoUserGetCommand_initTypes() {
127
+ this.types.string.push('webUrl', 'id', 'email', 'loginName', 'userName', 'entraGroupId', 'entraGroupName');
79
128
  }, _SpoUserGetCommand_initValidators = function _SpoUserGetCommand_initValidators() {
80
129
  this.validators.push(async (args) => {
81
130
  if (args.options.id &&
82
131
  typeof args.options.id !== 'number') {
83
132
  return `Specified id ${args.options.id} is not a number`;
84
133
  }
134
+ if (args.options.entraGroupId && !validation.isValidGuid(args.options.entraGroupId)) {
135
+ return `${args.options.entraGroupId} is not a valid GUID.`;
136
+ }
137
+ if (args.options.userName && !validation.isValidUserPrincipalName(args.options.userName)) {
138
+ return `${args.options.userName} is not a valid userName.`;
139
+ }
140
+ if (args.options.email && !validation.isValidUserPrincipalName(args.options.email)) {
141
+ return `${args.options.email} is not a valid email.`;
142
+ }
85
143
  return validation.isValidSharePointUrl(args.options.webUrl);
86
144
  });
87
145
  }, _SpoUserGetCommand_initOptionSets = function _SpoUserGetCommand_initOptionSets() {
88
146
  this.optionSets.push({
89
- options: ['id', 'email', 'loginName'],
90
- runsWhen: (args) => args.options.id || args.options.loginName || args.options.email
147
+ options: ['id', 'email', 'loginName', 'userName', 'entraGroupId', 'entraGroupName'],
148
+ runsWhen: (args) => args.options.id || args.options.email || args.options.loginName || args.options.userName || args.options.entraGroupId || args.options.entraGroupName
91
149
  });
92
150
  };
93
151
  export default new SpoUserGetCommand();