@pnp/cli-microsoft365 9.0.0-beta.62575a1 → 9.0.0-beta.e16d09c

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 (61) hide show
  1. package/allCommands.json +1 -1
  2. package/allCommandsFull.json +1 -1
  3. package/dist/Auth.js +9 -9
  4. package/dist/Command.js +49 -2
  5. package/dist/cli/cli.js +60 -38
  6. package/dist/m365/commands/login.js +44 -96
  7. package/dist/m365/connection/commands/connection-remove.js +6 -2
  8. package/dist/m365/connection/commands/connection-set.js +4 -1
  9. package/dist/m365/connection/commands/connection-use.js +25 -4
  10. package/dist/m365/entra/commands/multitenant/multitenant-add.js +65 -0
  11. package/dist/m365/entra/commands/multitenant/multitenant-remove.js +118 -0
  12. package/dist/m365/entra/commands/multitenant/multitenant-set.js +72 -0
  13. package/dist/m365/entra/commands.js +3 -0
  14. package/dist/m365/spe/ContainerTypeProperties.js +2 -0
  15. package/dist/m365/spe/commands/containertype/containertype-list.js +49 -0
  16. package/dist/m365/spe/commands.js +2 -1
  17. package/dist/m365/spo/commands/applicationcustomizer/applicationcustomizer-get.js +16 -21
  18. package/dist/m365/spo/commands/commandset/commandset-get.js +31 -17
  19. package/dist/m365/spo/commands/file/file-roleassignment-add.js +1 -1
  20. package/dist/m365/spo/commands/file/file-roleinheritance-break.js +1 -1
  21. package/dist/m365/spo/commands/file/file-roleinheritance-reset.js +1 -1
  22. package/dist/m365/spo/commands/folder/folder-retentionlabel-ensure.js +1 -1
  23. package/dist/m365/spo/commands/list/list-roleassignment-add.js +46 -21
  24. package/dist/m365/spo/commands/list/list-roleassignment-remove.js +48 -46
  25. package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-get.js +19 -5
  26. package/dist/m365/spo/commands/tenant/tenant-commandset-get.js +20 -6
  27. package/dist/utils/formatting.js +16 -0
  28. package/dist/utils/spo.js +37 -6
  29. package/dist/utils/zod.js +124 -0
  30. package/docs/docs/cmd/connection/connection-use.mdx +8 -2
  31. package/docs/docs/cmd/entra/multitenant/multitenant-add.mdx +107 -0
  32. package/docs/docs/cmd/entra/multitenant/multitenant-remove.mdx +58 -0
  33. package/docs/docs/cmd/entra/multitenant/multitenant-set.mdx +53 -0
  34. package/docs/docs/cmd/planner/plan/plan-remove.mdx +1 -1
  35. package/docs/docs/cmd/spe/containertype/containertype-list.mdx +102 -0
  36. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-get.mdx +87 -38
  37. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-list.mdx +22 -28
  38. package/docs/docs/cmd/spo/commandset/commandset-get.mdx +75 -24
  39. package/docs/docs/cmd/spo/commandset/commandset-list.mdx +26 -32
  40. package/docs/docs/cmd/spo/file/file-retentionlabel-ensure.mdx +1 -1
  41. package/docs/docs/cmd/spo/file/file-roleassignment-add.mdx +2 -2
  42. package/docs/docs/cmd/spo/file/file-roleassignment-remove.mdx +1 -1
  43. package/docs/docs/cmd/spo/file/file-roleinheritance-break.mdx +1 -1
  44. package/docs/docs/cmd/spo/file/file-roleinheritance-reset.mdx +1 -1
  45. package/docs/docs/cmd/spo/folder/folder-retentionlabel-ensure.mdx +2 -2
  46. package/docs/docs/cmd/spo/list/list-roleassignment-add.mdx +15 -3
  47. package/docs/docs/cmd/spo/list/list-roleassignment-remove.mdx +15 -3
  48. package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-ensure.mdx +4 -4
  49. package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-remove.mdx +1 -1
  50. package/docs/docs/cmd/spo/listitem/listitem-roleassignment-add.mdx +9 -9
  51. package/docs/docs/cmd/spo/listitem/listitem-roleassignment-remove.mdx +7 -7
  52. package/docs/docs/cmd/spo/site/site-recyclebinitem-list.mdx +1 -1
  53. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-get.mdx +79 -30
  54. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-list.mdx +20 -19
  55. package/docs/docs/cmd/spo/tenant/tenant-commandset-get.mdx +84 -38
  56. package/docs/docs/cmd/spo/tenant/tenant-commandset-list.mdx +20 -19
  57. package/docs/docs/cmd/spo/web/web-roleassignment-add.mdx +1 -1
  58. package/docs/docs/cmd/spo/web/web-roleassignment-remove.mdx +1 -1
  59. package/docs/docs/cmd/teams/meeting/meeting-list.mdx +7 -3
  60. package/npm-shrinkwrap.json +604 -843
  61. package/package.json +6 -2
@@ -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 _SpoListRoleAssignmentAddCommand_instances, _SpoListRoleAssignmentAddCommand_initTelemetry, _SpoListRoleAssignmentAddCommand_initOptions, _SpoListRoleAssignmentAddCommand_initValidators, _SpoListRoleAssignmentAddCommand_initOptionSets;
6
+ var _SpoListRoleAssignmentAddCommand_instances, _SpoListRoleAssignmentAddCommand_initTelemetry, _SpoListRoleAssignmentAddCommand_initOptions, _SpoListRoleAssignmentAddCommand_initValidators, _SpoListRoleAssignmentAddCommand_initOptionSets, _SpoListRoleAssignmentAddCommand_initTypes;
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 { spo } from '../../../../utils/spo.js';
10
11
  import { urlUtil } from '../../../../utils/urlUtil.js';
@@ -25,6 +26,7 @@ class SpoListRoleAssignmentAddCommand extends SpoCommand {
25
26
  __classPrivateFieldGet(this, _SpoListRoleAssignmentAddCommand_instances, "m", _SpoListRoleAssignmentAddCommand_initOptions).call(this);
26
27
  __classPrivateFieldGet(this, _SpoListRoleAssignmentAddCommand_instances, "m", _SpoListRoleAssignmentAddCommand_initValidators).call(this);
27
28
  __classPrivateFieldGet(this, _SpoListRoleAssignmentAddCommand_instances, "m", _SpoListRoleAssignmentAddCommand_initOptionSets).call(this);
29
+ __classPrivateFieldGet(this, _SpoListRoleAssignmentAddCommand_instances, "m", _SpoListRoleAssignmentAddCommand_initTypes).call(this);
28
30
  }
29
31
  async commandAction(logger, args) {
30
32
  if (this.verbose) {
@@ -42,39 +44,48 @@ class SpoListRoleAssignmentAddCommand extends SpoCommand {
42
44
  const listServerRelativeUrl = urlUtil.getServerRelativePath(args.options.webUrl, args.options.listUrl);
43
45
  requestUrl += `GetList('${formatting.encodeQueryParameter(listServerRelativeUrl)}')/`;
44
46
  }
45
- args.options.roleDefinitionId = await this.getRoleDefinitionId(args.options, logger);
47
+ const roleDefinitionId = await this.getRoleDefinitionId(args.options, logger);
48
+ let principalId = args.options.principalId;
46
49
  if (args.options.upn) {
47
- const user = await spo.getUserByEmail(args.options.webUrl, args.options.upn, logger, this.verbose);
48
- args.options.principalId = user.Id;
49
- await this.addRoleAssignment(requestUrl, logger, args.options);
50
+ const user = await spo.ensureUser(args.options.webUrl, args.options.upn);
51
+ principalId = user.Id;
50
52
  }
51
53
  else if (args.options.groupName) {
52
54
  const group = await spo.getGroupByName(args.options.webUrl, args.options.groupName, logger, this.verbose);
53
- args.options.principalId = group.Id;
54
- await this.addRoleAssignment(requestUrl, logger, args.options);
55
+ principalId = group.Id;
55
56
  }
56
- else {
57
- await this.addRoleAssignment(requestUrl, logger, args.options);
57
+ else if (args.options.entraGroupId || args.options.entraGroupName) {
58
+ if (this.verbose) {
59
+ await logger.logToStderr('Retrieving group information...');
60
+ }
61
+ let group;
62
+ if (args.options.entraGroupId) {
63
+ group = await entraGroup.getGroupById(args.options.entraGroupId);
64
+ }
65
+ else {
66
+ group = await entraGroup.getGroupByDisplayName(args.options.entraGroupName);
67
+ }
68
+ const siteUser = await spo.ensureEntraGroup(args.options.webUrl, group);
69
+ principalId = siteUser.Id;
58
70
  }
71
+ await this.addRoleAssignment(requestUrl, principalId, roleDefinitionId);
59
72
  }
60
73
  catch (err) {
61
74
  this.handleRejectedODataJsonPromise(err);
62
75
  }
63
76
  }
64
- async addRoleAssignment(requestUrl, logger, options) {
77
+ async addRoleAssignment(requestUrl, principalId, roleDefinitionId) {
65
78
  const requestOptions = {
66
- url: `${requestUrl}roleassignments/addroleassignment(principalid='${options.principalId}',roledefid='${options.roleDefinitionId}')`,
67
- method: 'POST',
79
+ url: `${requestUrl}roleassignments/addroleassignment(principalid='${principalId}',roledefid='${roleDefinitionId}')`,
68
80
  headers: {
69
- 'accept': 'application/json;odata=nometadata',
70
- 'content-type': 'application/json'
81
+ accept: 'application/json;odata=nometadata'
71
82
  },
72
83
  responseType: 'json'
73
84
  };
74
85
  return request.post(requestOptions);
75
86
  }
76
87
  async getRoleDefinitionId(options, logger) {
77
- if (!options.roleDefinitionName) {
88
+ if (options.roleDefinitionId) {
78
89
  return options.roleDefinitionId;
79
90
  }
80
91
  const roleDefinition = await spo.getRoleDefinitionByName(options.webUrl, options.roleDefinitionName, logger, this.verbose);
@@ -90,6 +101,8 @@ _SpoListRoleAssignmentAddCommand_instances = new WeakSet(), _SpoListRoleAssignme
90
101
  principalId: typeof args.options.principalId !== 'undefined',
91
102
  upn: typeof args.options.upn !== 'undefined',
92
103
  groupName: typeof args.options.groupName !== 'undefined',
104
+ entraGroupId: typeof args.options.entraGroupId !== 'undefined',
105
+ entraGroupName: typeof args.options.entraGroupName !== 'undefined',
93
106
  roleDefinitionId: typeof args.options.roleDefinitionId !== 'undefined',
94
107
  roleDefinitionName: typeof args.options.roleDefinitionName !== 'undefined'
95
108
  });
@@ -109,6 +122,10 @@ _SpoListRoleAssignmentAddCommand_instances = new WeakSet(), _SpoListRoleAssignme
109
122
  option: '--upn [upn]'
110
123
  }, {
111
124
  option: '--groupName [groupName]'
125
+ }, {
126
+ option: '--entraGroupId [entraGroupId]'
127
+ }, {
128
+ option: '--entraGroupName [entraGroupName]'
112
129
  }, {
113
130
  option: '--roleDefinitionId [roleDefinitionId]'
114
131
  }, {
@@ -121,18 +138,26 @@ _SpoListRoleAssignmentAddCommand_instances = new WeakSet(), _SpoListRoleAssignme
121
138
  return isValidSharePointUrl;
122
139
  }
123
140
  if (args.options.listId && !validation.isValidGuid(args.options.listId)) {
124
- return `${args.options.listId} is not a valid GUID`;
141
+ return `'${args.options.listId}' is not a valid GUID for option listId.`;
142
+ }
143
+ if (args.options.upn && !validation.isValidUserPrincipalName(args.options.upn)) {
144
+ return `'${args.options.upn}' is not a valid user principal name for option upn.`;
145
+ }
146
+ if (args.options.principalId && !validation.isValidPositiveInteger(args.options.principalId)) {
147
+ return `Specified principalId '${args.options.principalId}' is not a valid number.`;
125
148
  }
126
- if (args.options.principalId && isNaN(args.options.principalId)) {
127
- return `Specified principalId ${args.options.principalId} is not a number`;
149
+ if (args.options.entraGroupId && !validation.isValidGuid(args.options.entraGroupId)) {
150
+ return `'${args.options.entraGroupId}' is not a valid GUID for option entraGroupId.`;
128
151
  }
129
- if (args.options.roleDefinitionId && isNaN(args.options.roleDefinitionId)) {
130
- return `Specified roleDefinitionId ${args.options.roleDefinitionId} is not a number`;
152
+ if (args.options.roleDefinitionId && !validation.isValidPositiveInteger(args.options.roleDefinitionId)) {
153
+ return `Specified roleDefinitionId '${args.options.roleDefinitionId}' is not a valid number.`;
131
154
  }
132
155
  return true;
133
156
  });
134
157
  }, _SpoListRoleAssignmentAddCommand_initOptionSets = function _SpoListRoleAssignmentAddCommand_initOptionSets() {
135
- this.optionSets.push({ options: ['listId', 'listTitle', 'listUrl'] }, { options: ['principalId', 'upn', 'groupName'] }, { options: ['roleDefinitionId', 'roleDefinitionName'] });
158
+ this.optionSets.push({ options: ['listId', 'listTitle', 'listUrl'] }, { options: ['principalId', 'upn', 'groupName', 'entraGroupId', 'entraGroupName'] }, { options: ['roleDefinitionId', 'roleDefinitionName'] });
159
+ }, _SpoListRoleAssignmentAddCommand_initTypes = function _SpoListRoleAssignmentAddCommand_initTypes() {
160
+ this.types.string.push('webUrl', 'listId', 'listTitle', 'listUrl', 'upn', 'groupName', 'entraGroupId', 'entraGroupName', 'roleDefinitionName');
136
161
  };
137
162
  export default new SpoListRoleAssignmentAddCommand();
138
163
  //# sourceMappingURL=list-roleassignment-add.js.map
@@ -3,16 +3,16 @@ 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 _SpoListRoleAssignmentRemoveCommand_instances, _SpoListRoleAssignmentRemoveCommand_initTelemetry, _SpoListRoleAssignmentRemoveCommand_initOptions, _SpoListRoleAssignmentRemoveCommand_initValidators, _SpoListRoleAssignmentRemoveCommand_initOptionSets;
6
+ var _SpoListRoleAssignmentRemoveCommand_instances, _SpoListRoleAssignmentRemoveCommand_initTelemetry, _SpoListRoleAssignmentRemoveCommand_initOptions, _SpoListRoleAssignmentRemoveCommand_initValidators, _SpoListRoleAssignmentRemoveCommand_initOptionSets, _SpoListRoleAssignmentRemoveCommand_initTypes;
7
7
  import { cli } from '../../../../cli/cli.js';
8
8
  import request from '../../../../request.js';
9
9
  import { formatting } from '../../../../utils/formatting.js';
10
+ import { spo } from '../../../../utils/spo.js';
10
11
  import { urlUtil } from '../../../../utils/urlUtil.js';
11
12
  import { validation } from '../../../../utils/validation.js';
12
13
  import SpoCommand from '../../../base/SpoCommand.js';
13
14
  import commands from '../../commands.js';
14
- import spoGroupGetCommand from '../group/group-get.js';
15
- import spoUserGetCommand from '../user/user-get.js';
15
+ import { entraGroup } from '../../../../utils/entraGroup.js';
16
16
  class SpoListRoleAssignmentRemoveCommand extends SpoCommand {
17
17
  get name() {
18
18
  return commands.LIST_ROLEASSIGNMENT_REMOVE;
@@ -27,11 +27,12 @@ class SpoListRoleAssignmentRemoveCommand extends SpoCommand {
27
27
  __classPrivateFieldGet(this, _SpoListRoleAssignmentRemoveCommand_instances, "m", _SpoListRoleAssignmentRemoveCommand_initOptions).call(this);
28
28
  __classPrivateFieldGet(this, _SpoListRoleAssignmentRemoveCommand_instances, "m", _SpoListRoleAssignmentRemoveCommand_initValidators).call(this);
29
29
  __classPrivateFieldGet(this, _SpoListRoleAssignmentRemoveCommand_instances, "m", _SpoListRoleAssignmentRemoveCommand_initOptionSets).call(this);
30
+ __classPrivateFieldGet(this, _SpoListRoleAssignmentRemoveCommand_instances, "m", _SpoListRoleAssignmentRemoveCommand_initTypes).call(this);
30
31
  }
31
32
  async commandAction(logger, args) {
32
33
  const removeRoleAssignment = async () => {
33
34
  if (this.verbose) {
34
- await logger.logToStderr(`Removing role assignment from list in site at ${args.options.webUrl}...`);
35
+ await logger.logToStderr(`Removing role assignment from list '${args.options.listId || args.options.listTitle || args.options.listUrl}' of site ${args.options.webUrl}...`);
35
36
  }
36
37
  try {
37
38
  let requestUrl = `${args.options.webUrl}/_api/web/`;
@@ -45,17 +46,30 @@ class SpoListRoleAssignmentRemoveCommand extends SpoCommand {
45
46
  const listServerRelativeUrl = urlUtil.getServerRelativePath(args.options.webUrl, args.options.listUrl);
46
47
  requestUrl += `GetList('${formatting.encodeQueryParameter(listServerRelativeUrl)}')/`;
47
48
  }
49
+ let principalId = args.options.principalId;
48
50
  if (args.options.upn) {
49
- args.options.principalId = await this.getUserPrincipalId(args.options);
50
- await this.removeRoleAssignment(requestUrl, logger, args.options);
51
+ const user = await spo.ensureUser(args.options.webUrl, args.options.upn);
52
+ principalId = user.Id;
51
53
  }
52
54
  else if (args.options.groupName) {
53
- args.options.principalId = await this.getGroupPrincipalId(args.options);
54
- await this.removeRoleAssignment(requestUrl, logger, args.options);
55
+ const spGroup = await spo.getGroupByName(args.options.webUrl, args.options.groupName, logger, this.verbose);
56
+ principalId = spGroup.Id;
55
57
  }
56
- else {
57
- await this.removeRoleAssignment(requestUrl, logger, args.options);
58
+ else if (args.options.entraGroupId || args.options.entraGroupName) {
59
+ if (this.verbose) {
60
+ await logger.logToStderr('Retrieving group information...');
61
+ }
62
+ let group;
63
+ if (args.options.entraGroupId) {
64
+ group = await entraGroup.getGroupById(args.options.entraGroupId);
65
+ }
66
+ else {
67
+ group = await entraGroup.getGroupByDisplayName(args.options.entraGroupName);
68
+ }
69
+ const siteUser = await spo.ensureEntraGroup(args.options.webUrl, group);
70
+ principalId = siteUser.Id;
58
71
  }
72
+ await this.removeRoleAssignment(requestUrl, principalId);
59
73
  }
60
74
  catch (err) {
61
75
  this.handleRejectedODataJsonPromise(err);
@@ -65,49 +79,22 @@ class SpoListRoleAssignmentRemoveCommand extends SpoCommand {
65
79
  await removeRoleAssignment();
66
80
  }
67
81
  else {
68
- const result = await cli.promptForConfirmation({ message: `Are you sure you want to remove role assignment from list ${args.options.listId || args.options.listTitle} from site ${args.options.webUrl}?` });
82
+ const result = await cli.promptForConfirmation({ message: `Are you sure you want to remove role assignment from the specified user of list '${args.options.listId || args.options.listTitle || args.options.listUrl}'?` });
69
83
  if (result) {
70
84
  await removeRoleAssignment();
71
85
  }
72
86
  }
73
87
  }
74
- async removeRoleAssignment(requestUrl, logger, options) {
88
+ async removeRoleAssignment(requestUrl, principalId) {
75
89
  const requestOptions = {
76
- url: `${requestUrl}roleassignments/removeroleassignment(principalid='${options.principalId}')`,
77
- method: 'POST',
90
+ url: `${requestUrl}roleassignments/removeroleassignment(principalid='${principalId}')`,
78
91
  headers: {
79
- 'accept': 'application/json;odata=nometadata',
80
- 'content-type': 'application/json'
92
+ accept: 'application/json;odata=nometadata'
81
93
  },
82
94
  responseType: 'json'
83
95
  };
84
96
  return request.post(requestOptions);
85
97
  }
86
- async getGroupPrincipalId(options) {
87
- const groupGetCommandOptions = {
88
- webUrl: options.webUrl,
89
- name: options.groupName,
90
- output: 'json',
91
- debug: this.debug,
92
- verbose: this.verbose
93
- };
94
- const output = await cli.executeCommandWithOutput(spoGroupGetCommand, { options: { ...groupGetCommandOptions, _: [] } });
95
- const getGroupOutput = JSON.parse(output.stdout);
96
- return getGroupOutput.Id;
97
- }
98
- async getUserPrincipalId(options) {
99
- const userGetCommandOptions = {
100
- webUrl: options.webUrl,
101
- email: options.upn,
102
- id: undefined,
103
- output: 'json',
104
- debug: this.debug,
105
- verbose: this.verbose
106
- };
107
- const output = await cli.executeCommandWithOutput(spoUserGetCommand, { options: { ...userGetCommandOptions, _: [] } });
108
- const getUserOutput = JSON.parse(output.stdout);
109
- return getUserOutput.Id;
110
- }
111
98
  }
112
99
  _SpoListRoleAssignmentRemoveCommand_instances = new WeakSet(), _SpoListRoleAssignmentRemoveCommand_initTelemetry = function _SpoListRoleAssignmentRemoveCommand_initTelemetry() {
113
100
  this.telemetry.push((args) => {
@@ -118,7 +105,9 @@ _SpoListRoleAssignmentRemoveCommand_instances = new WeakSet(), _SpoListRoleAssig
118
105
  principalId: typeof args.options.principalId !== 'undefined',
119
106
  upn: typeof args.options.upn !== 'undefined',
120
107
  groupName: typeof args.options.groupName !== 'undefined',
121
- force: (!(!args.options.force)).toString()
108
+ entraGroupId: typeof args.options.entraGroupId !== 'undefined',
109
+ entraGroupName: typeof args.options.entraGroupName !== 'undefined',
110
+ force: !!args.options.force
122
111
  });
123
112
  });
124
113
  }, _SpoListRoleAssignmentRemoveCommand_initOptions = function _SpoListRoleAssignmentRemoveCommand_initOptions() {
@@ -136,6 +125,10 @@ _SpoListRoleAssignmentRemoveCommand_instances = new WeakSet(), _SpoListRoleAssig
136
125
  option: '--upn [upn]'
137
126
  }, {
138
127
  option: '--groupName [groupName]'
128
+ }, {
129
+ option: '--entraGroupId [entraGroupId]'
130
+ }, {
131
+ option: '--entraGroupName [entraGroupName]'
139
132
  }, {
140
133
  option: '-f, --force'
141
134
  });
@@ -146,15 +139,24 @@ _SpoListRoleAssignmentRemoveCommand_instances = new WeakSet(), _SpoListRoleAssig
146
139
  return isValidSharePointUrl;
147
140
  }
148
141
  if (args.options.listId && !validation.isValidGuid(args.options.listId)) {
149
- return `${args.options.listId} is not a valid GUID`;
142
+ return `'${args.options.listId}' is not a valid GUID for option listId.`;
143
+ }
144
+ if (args.options.upn && !validation.isValidUserPrincipalName(args.options.upn)) {
145
+ return `'${args.options.upn}' is not a valid user principal name for option upn.`;
146
+ }
147
+ if (args.options.principalId && !validation.isValidPositiveInteger(args.options.principalId)) {
148
+ return `'${args.options.principalId}' is not a valid number for option principalId.`;
150
149
  }
151
- if (args.options.principalId && isNaN(args.options.principalId)) {
152
- return `Specified principalId ${args.options.principalId} is not a number`;
150
+ if (args.options.entraGroupId && !validation.isValidGuid(args.options.entraGroupId)) {
151
+ return `'${args.options.entraGroupId}' is not a valid GUID for option entraGroupId.`;
153
152
  }
154
153
  return true;
155
154
  });
156
155
  }, _SpoListRoleAssignmentRemoveCommand_initOptionSets = function _SpoListRoleAssignmentRemoveCommand_initOptionSets() {
157
- this.optionSets.push({ options: ['listId', 'listTitle', 'listUrl'] }, { options: ['principalId', 'upn', 'groupName'] });
156
+ this.optionSets.push({ options: ['listId', 'listTitle', 'listUrl'] }, { options: ['principalId', 'upn', 'groupName', 'entraGroupId', 'entraGroupName'] });
157
+ }, _SpoListRoleAssignmentRemoveCommand_initTypes = function _SpoListRoleAssignmentRemoveCommand_initTypes() {
158
+ this.types.string.push('webUrl', 'listId', 'listTitle', 'listUrl', 'upn', 'groupName', 'entraGroupId', 'entraGroupName');
159
+ this.types.boolean.push('force');
158
160
  };
159
161
  export default new SpoListRoleAssignmentRemoveCommand();
160
162
  //# sourceMappingURL=list-roleassignment-remove.js.map
@@ -3,7 +3,7 @@ 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 _SpoTenantApplicationCustomizerGetCommand_instances, _SpoTenantApplicationCustomizerGetCommand_initTelemetry, _SpoTenantApplicationCustomizerGetCommand_initOptions, _SpoTenantApplicationCustomizerGetCommand_initValidators, _SpoTenantApplicationCustomizerGetCommand_initOptionSets;
6
+ var _SpoTenantApplicationCustomizerGetCommand_instances, _SpoTenantApplicationCustomizerGetCommand_initTelemetry, _SpoTenantApplicationCustomizerGetCommand_initOptions, _SpoTenantApplicationCustomizerGetCommand_initValidators, _SpoTenantApplicationCustomizerGetCommand_initOptionSets, _SpoTenantApplicationCustomizerGetCommand_initTypes;
7
7
  import { formatting } from '../../../../utils/formatting.js';
8
8
  import { odata } from '../../../../utils/odata.js';
9
9
  import { spo } from '../../../../utils/spo.js';
@@ -26,6 +26,7 @@ class SpoTenantApplicationCustomizerGetCommand extends SpoCommand {
26
26
  __classPrivateFieldGet(this, _SpoTenantApplicationCustomizerGetCommand_instances, "m", _SpoTenantApplicationCustomizerGetCommand_initOptions).call(this);
27
27
  __classPrivateFieldGet(this, _SpoTenantApplicationCustomizerGetCommand_instances, "m", _SpoTenantApplicationCustomizerGetCommand_initValidators).call(this);
28
28
  __classPrivateFieldGet(this, _SpoTenantApplicationCustomizerGetCommand_instances, "m", _SpoTenantApplicationCustomizerGetCommand_initOptionSets).call(this);
29
+ __classPrivateFieldGet(this, _SpoTenantApplicationCustomizerGetCommand_instances, "m", _SpoTenantApplicationCustomizerGetCommand_initTypes).call(this);
29
30
  }
30
31
  async commandAction(logger, args) {
31
32
  try {
@@ -50,13 +51,20 @@ class SpoTenantApplicationCustomizerGetCommand extends SpoCommand {
50
51
  throw 'The specified application customizer was not found';
51
52
  }
52
53
  listItemInstances.forEach(v => delete v['ID']);
54
+ let listItemInstance;
53
55
  if (listItemInstances.length > 1) {
54
56
  const resultAsKeyValuePair = formatting.convertArrayToHashTable('Id', listItemInstances);
55
- const result = await cli.handleMultipleResultsFound(`Multiple application customizers with ${args.options.title || args.options.clientSideComponentId} were found.`, resultAsKeyValuePair);
56
- await logger.log(result);
57
+ listItemInstance = await cli.handleMultipleResultsFound(`Multiple application customizers with ${args.options.title || args.options.clientSideComponentId} were found.`, resultAsKeyValuePair);
57
58
  }
58
59
  else {
59
- await logger.log(listItemInstances[0]);
60
+ listItemInstance = listItemInstances[0];
61
+ }
62
+ if (!args.options.tenantWideExtensionComponentProperties) {
63
+ await logger.log(listItemInstance);
64
+ }
65
+ else {
66
+ const properties = formatting.tryParseJson(listItemInstance.TenantWideExtensionComponentProperties);
67
+ await logger.log(properties);
60
68
  }
61
69
  }
62
70
  else {
@@ -73,7 +81,8 @@ _SpoTenantApplicationCustomizerGetCommand_instances = new WeakSet(), _SpoTenantA
73
81
  Object.assign(this.telemetryProperties, {
74
82
  title: typeof args.options.title !== 'undefined',
75
83
  id: typeof args.options.id !== 'undefined',
76
- clientSideComponentId: typeof args.options.clientSideComponentId !== 'undefined'
84
+ clientSideComponentId: typeof args.options.clientSideComponentId !== 'undefined',
85
+ tenantWideExtensionComponentProperties: !!args.options.tenantWideExtensionComponentProperties
77
86
  });
78
87
  });
79
88
  }, _SpoTenantApplicationCustomizerGetCommand_initOptions = function _SpoTenantApplicationCustomizerGetCommand_initOptions() {
@@ -83,6 +92,8 @@ _SpoTenantApplicationCustomizerGetCommand_instances = new WeakSet(), _SpoTenantA
83
92
  option: '-i, --id [id]'
84
93
  }, {
85
94
  option: '-c, --clientSideComponentId [clientSideComponentId]'
95
+ }, {
96
+ option: '-p, --tenantWideExtensionComponentProperties'
86
97
  });
87
98
  }, _SpoTenantApplicationCustomizerGetCommand_initValidators = function _SpoTenantApplicationCustomizerGetCommand_initValidators() {
88
99
  this.validators.push(async (args) => {
@@ -96,6 +107,9 @@ _SpoTenantApplicationCustomizerGetCommand_instances = new WeakSet(), _SpoTenantA
96
107
  });
97
108
  }, _SpoTenantApplicationCustomizerGetCommand_initOptionSets = function _SpoTenantApplicationCustomizerGetCommand_initOptionSets() {
98
109
  this.optionSets.push({ options: ['title', 'id', 'clientSideComponentId'] });
110
+ }, _SpoTenantApplicationCustomizerGetCommand_initTypes = function _SpoTenantApplicationCustomizerGetCommand_initTypes() {
111
+ this.types.string.push('title', 'id', 'clientSideComponentId');
112
+ this.types.boolean.push('tenantWideExtensionComponentProperties');
99
113
  };
100
114
  export default new SpoTenantApplicationCustomizerGetCommand();
101
115
  //# sourceMappingURL=tenant-applicationcustomizer-get.js.map
@@ -3,7 +3,7 @@ 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 _SpoTenantCommandSetGetCommand_instances, _SpoTenantCommandSetGetCommand_initTelemetry, _SpoTenantCommandSetGetCommand_initOptions, _SpoTenantCommandSetGetCommand_initValidators, _SpoTenantCommandSetGetCommand_initOptionSets;
6
+ var _SpoTenantCommandSetGetCommand_instances, _SpoTenantCommandSetGetCommand_initTelemetry, _SpoTenantCommandSetGetCommand_initOptions, _SpoTenantCommandSetGetCommand_initValidators, _SpoTenantCommandSetGetCommand_initOptionSets, _SpoTenantCommandSetGetCommand_initTypes;
7
7
  import { cli } from '../../../../cli/cli.js';
8
8
  import { CommandError } from '../../../../Command.js';
9
9
  import request from '../../../../request.js';
@@ -27,6 +27,7 @@ class SpoTenantCommandSetGetCommand extends SpoCommand {
27
27
  __classPrivateFieldGet(this, _SpoTenantCommandSetGetCommand_instances, "m", _SpoTenantCommandSetGetCommand_initOptions).call(this);
28
28
  __classPrivateFieldGet(this, _SpoTenantCommandSetGetCommand_instances, "m", _SpoTenantCommandSetGetCommand_initValidators).call(this);
29
29
  __classPrivateFieldGet(this, _SpoTenantCommandSetGetCommand_instances, "m", _SpoTenantCommandSetGetCommand_initOptionSets).call(this);
30
+ __classPrivateFieldGet(this, _SpoTenantCommandSetGetCommand_instances, "m", _SpoTenantCommandSetGetCommand_initTypes).call(this);
30
31
  }
31
32
  async commandAction(logger, args) {
32
33
  const appCatalogUrl = await spo.getTenantAppCatalogUrl(logger, this.debug);
@@ -47,7 +48,7 @@ class SpoTenantCommandSetGetCommand extends SpoCommand {
47
48
  const reqOptions = {
48
49
  url: `${appCatalogUrl}/_api/web/GetList('${formatting.encodeQueryParameter(listServerRelativeUrl)}')/items?$filter=${filter}`,
49
50
  headers: {
50
- 'accept': 'application/json;odata=nometadata'
51
+ accept: 'application/json;odata=nometadata'
51
52
  },
52
53
  responseType: 'json'
53
54
  };
@@ -55,13 +56,20 @@ class SpoTenantCommandSetGetCommand extends SpoCommand {
55
56
  const listItemInstances = await request.get(reqOptions);
56
57
  if (listItemInstances?.value.length > 0) {
57
58
  listItemInstances.value.forEach(v => delete v['ID']);
59
+ let listItemInstance;
58
60
  if (listItemInstances.value.length > 1) {
59
61
  const resultAsKeyValuePair = formatting.convertArrayToHashTable('Id', listItemInstances.value);
60
- const result = await cli.handleMultipleResultsFound(`Multiple ListView Command Sets with ${args.options.title || args.options.clientSideComponentId} were found.`, resultAsKeyValuePair);
61
- await logger.log(result);
62
+ listItemInstance = await cli.handleMultipleResultsFound(`Multiple ListView Command Sets with ${args.options.title || args.options.clientSideComponentId} were found.`, resultAsKeyValuePair);
62
63
  }
63
64
  else {
64
- await logger.log(listItemInstances.value[0]);
65
+ listItemInstance = listItemInstances.value[0];
66
+ }
67
+ if (!args.options.tenantWideExtensionComponentProperties) {
68
+ await logger.log(listItemInstance);
69
+ }
70
+ else {
71
+ const properties = formatting.tryParseJson(listItemInstance.TenantWideExtensionComponentProperties);
72
+ await logger.log(properties);
65
73
  }
66
74
  }
67
75
  else {
@@ -78,7 +86,8 @@ _SpoTenantCommandSetGetCommand_instances = new WeakSet(), _SpoTenantCommandSetGe
78
86
  Object.assign(this.telemetryProperties, {
79
87
  title: typeof args.options.title !== 'undefined',
80
88
  id: typeof args.options.id !== 'undefined',
81
- clientSideComponentId: typeof args.options.clientSideComponentId !== 'undefined'
89
+ clientSideComponentId: typeof args.options.clientSideComponentId !== 'undefined',
90
+ tenantWideExtensionComponentProperties: !!args.options.tenantWideExtensionComponentProperties
82
91
  });
83
92
  });
84
93
  }, _SpoTenantCommandSetGetCommand_initOptions = function _SpoTenantCommandSetGetCommand_initOptions() {
@@ -88,6 +97,8 @@ _SpoTenantCommandSetGetCommand_instances = new WeakSet(), _SpoTenantCommandSetGe
88
97
  option: '-i, --id [id]'
89
98
  }, {
90
99
  option: '-c, --clientSideComponentId [clientSideComponentId]'
100
+ }, {
101
+ option: '-p, --tenantWideExtensionComponentProperties'
91
102
  });
92
103
  }, _SpoTenantCommandSetGetCommand_initValidators = function _SpoTenantCommandSetGetCommand_initValidators() {
93
104
  this.validators.push(async (args) => {
@@ -101,6 +112,9 @@ _SpoTenantCommandSetGetCommand_instances = new WeakSet(), _SpoTenantCommandSetGe
101
112
  });
102
113
  }, _SpoTenantCommandSetGetCommand_initOptionSets = function _SpoTenantCommandSetGetCommand_initOptionSets() {
103
114
  this.optionSets.push({ options: ['title', 'id', 'clientSideComponentId'] });
115
+ }, _SpoTenantCommandSetGetCommand_initTypes = function _SpoTenantCommandSetGetCommand_initTypes() {
116
+ this.types.string.push('title', 'id', 'clientSideComponentId');
117
+ this.types.boolean.push('tenantWideExtensionComponentProperties');
104
118
  };
105
119
  export default new SpoTenantCommandSetGetCommand();
106
120
  //# sourceMappingURL=tenant-commandset-get.js.map
@@ -39,6 +39,22 @@ export const formatting = {
39
39
  parseJsonWithBom(s) {
40
40
  return JSON.parse(s.replace(/^\uFEFF/, ''));
41
41
  },
42
+ /**
43
+ * Tries to parse a string as JSON. If it fails, returns the original string.
44
+ * @param value JSON string to parse.
45
+ * @returns JSON object or the original string if parsing fails.
46
+ */
47
+ tryParseJson(value) {
48
+ try {
49
+ if (typeof value !== 'string') {
50
+ return value;
51
+ }
52
+ return JSON.parse(value);
53
+ }
54
+ catch {
55
+ return value;
56
+ }
57
+ },
42
58
  filterObject(obj, propertiesToInclude) {
43
59
  const objKeys = Object.keys(obj);
44
60
  return propertiesToInclude
package/dist/utils/spo.js CHANGED
@@ -454,15 +454,46 @@ export const spo = {
454
454
  const res = await request.get(requestOptions);
455
455
  return res.AadObjectId.NameId;
456
456
  },
457
+ /**
458
+ * Ensure a user exists on a specific SharePoint site.
459
+ * @param webUrl URL of the SharePoint site.
460
+ * @param logonName Logon name of the user to ensure on the SharePoint site.
461
+ * @returns SharePoint user object.
462
+ */
463
+ async ensureUser(webUrl, logonName) {
464
+ const requestOptions = {
465
+ url: `${webUrl}/_api/web/EnsureUser`,
466
+ headers: {
467
+ accept: 'application/json;odata=nometadata'
468
+ },
469
+ responseType: 'json',
470
+ data: {
471
+ logonName: logonName
472
+ }
473
+ };
474
+ return request.post(requestOptions);
475
+ },
476
+ /**
477
+ * Ensure a Microsoft Entra ID group exists on a specific SharePoint site.
478
+ * @param webUrl URL of the SharePoint site.
479
+ * @param group Microsoft Entra ID group.
480
+ * @returns SharePoint user object.
481
+ */
482
+ async ensureEntraGroup(webUrl, group) {
483
+ if (!group.securityEnabled) {
484
+ throw new Error('Cannot ensure a Microsoft Entra ID group that is not security enabled.');
485
+ }
486
+ return this.ensureUser(webUrl, group.mailEnabled ? `c:0o.c|federateddirectoryclaimprovider|${group.id}` : `c:0t.c|tenant|${group.id}`);
487
+ },
457
488
  /**
458
489
  * Retrieves the spo user by email.
459
490
  * @param webUrl Web url
460
491
  * @param email The email of the user
461
492
  * @param logger the Logger object
462
- * @param debug set if debug logging should be logged
493
+ * @param verbose set if verbose logging should be logged
463
494
  */
464
- async getUserByEmail(webUrl, email, logger, debug) {
465
- if (debug) {
495
+ async getUserByEmail(webUrl, email, logger, verbose) {
496
+ if (verbose) {
466
497
  await logger.logToStderr(`Retrieving the spo user by email ${email}`);
467
498
  }
468
499
  const requestUrl = `${webUrl}/_api/web/siteusers/GetByEmail('${formatting.encodeQueryParameter(email)}')`;
@@ -533,10 +564,10 @@ export const spo = {
533
564
  * @param webUrl Web url
534
565
  * @param name The name of the group
535
566
  * @param logger the Logger object
536
- * @param debug set if debug logging should be logged
567
+ * @param verbose set if verbose logging should be logged
537
568
  */
538
- async getGroupByName(webUrl, name, logger, debug) {
539
- if (debug) {
569
+ async getGroupByName(webUrl, name, logger, verbose) {
570
+ if (verbose) {
540
571
  await logger.logToStderr(`Retrieving the group by name ${name}`);
541
572
  }
542
573
  const requestUrl = `${webUrl}/_api/web/sitegroups/GetByName('${formatting.encodeQueryParameter(name)}')`;