@pnp/cli-microsoft365 9.0.0-beta.2f8dd1e → 9.0.0-beta.33615bd

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 (118) hide show
  1. package/.eslintrc.cjs +1 -0
  2. package/allCommands.json +1 -1
  3. package/allCommandsFull.json +1 -1
  4. package/dist/Auth.js +10 -18
  5. package/dist/Command.js +49 -2
  6. package/dist/chili/chili.js +0 -23
  7. package/dist/cli/cli.js +61 -101
  8. package/dist/m365/app/commands/permission/permission-add.js +9 -9
  9. package/dist/m365/commands/login.js +44 -96
  10. package/dist/m365/commands/setup.js +0 -4
  11. package/dist/m365/connection/commands/connection-remove.js +6 -2
  12. package/dist/m365/connection/commands/connection-set.js +4 -1
  13. package/dist/m365/connection/commands/connection-use.js +25 -4
  14. package/dist/m365/entra/commands/group/group-user-list.js +4 -4
  15. package/dist/m365/entra/commands/m365group/m365group-conversation-post-list.js +4 -4
  16. package/dist/m365/entra/commands/m365group/m365group-recyclebinitem-list.js +3 -3
  17. package/dist/m365/entra/commands/m365group/m365group-set.js +66 -29
  18. package/dist/m365/entra/commands/m365group/m365group-user-list.js +6 -9
  19. package/dist/m365/entra/commands/multitenant/MultitenantOrganization.js +2 -0
  20. package/dist/m365/entra/commands/multitenant/multitenant-add.js +65 -0
  21. package/dist/m365/entra/commands/multitenant/multitenant-get.js +32 -0
  22. package/dist/m365/entra/commands/multitenant/multitenant-remove.js +118 -0
  23. package/dist/m365/entra/commands/multitenant/multitenant-set.js +72 -0
  24. package/dist/m365/entra/commands.js +4 -0
  25. package/dist/m365/external/commands/connection/connection-doctor.js +10 -24
  26. package/dist/m365/flow/commands/flow-list.js +23 -24
  27. package/dist/m365/graph/commands/subscription/subscription-add.js +4 -2
  28. package/dist/m365/outlook/commands/message/message-get.js +11 -11
  29. package/dist/m365/spe/ContainerTypeProperties.js +2 -0
  30. package/dist/m365/spe/commands/containertype/containertype-list.js +49 -0
  31. package/dist/m365/spe/commands.js +2 -1
  32. package/dist/m365/spfx/commands/project/base-project-command.js +36 -126
  33. package/dist/m365/spo/commands/applicationcustomizer/applicationcustomizer-get.js +16 -21
  34. package/dist/m365/spo/commands/cdn/cdn-get.js +12 -15
  35. package/dist/m365/spo/commands/cdn/cdn-set.js +6 -4
  36. package/dist/m365/spo/commands/commandset/commandset-get.js +31 -17
  37. package/dist/m365/spo/commands/contenttype/contenttype-field-list.js +124 -0
  38. package/dist/m365/spo/commands/field/field-list.js +1 -1
  39. package/dist/m365/spo/commands/file/file-roleassignment-add.js +1 -1
  40. package/dist/m365/spo/commands/file/file-roleinheritance-break.js +1 -1
  41. package/dist/m365/spo/commands/file/file-roleinheritance-reset.js +1 -1
  42. package/dist/m365/spo/commands/folder/folder-retentionlabel-ensure.js +1 -1
  43. package/dist/m365/spo/commands/group/group-member-add.js +103 -99
  44. package/dist/m365/spo/commands/list/list-list.js +1 -4
  45. package/dist/m365/spo/commands/list/list-roleassignment-add.js +46 -21
  46. package/dist/m365/spo/commands/list/list-roleassignment-remove.js +48 -46
  47. package/dist/m365/spo/commands/page/page-clientsidewebpart-add.js +2 -3
  48. package/dist/m365/spo/commands/page/page-text-add.js +2 -3
  49. package/dist/m365/spo/commands/site/site-appcatalog-remove.js +48 -24
  50. package/dist/m365/spo/commands/spo-search.js +3 -4
  51. package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-get.js +19 -5
  52. package/dist/m365/spo/commands/tenant/tenant-commandset-get.js +20 -6
  53. package/dist/m365/spo/commands/tenant/tenant-recyclebinitem-restore.js +2 -22
  54. package/dist/m365/spo/commands.js +1 -0
  55. package/dist/m365/teams/commands/meeting/meeting-attendancereport-get.js +119 -0
  56. package/dist/m365/teams/commands/message/message-remove.js +112 -0
  57. package/dist/m365/teams/commands.js +2 -0
  58. package/dist/m365/viva/commands/engage/engage-community-add.js +166 -0
  59. package/dist/m365/viva/commands.js +1 -0
  60. package/dist/utils/formatting.js +30 -1
  61. package/dist/utils/spo.js +37 -6
  62. package/dist/utils/teams.js +49 -0
  63. package/dist/utils/validation.js +19 -0
  64. package/dist/utils/zod.js +124 -0
  65. package/docs/docs/cmd/app/permission/permission-add.mdx +5 -5
  66. package/docs/docs/cmd/connection/connection-use.mdx +8 -2
  67. package/docs/docs/cmd/entra/group/group-user-list.mdx +7 -7
  68. package/docs/docs/cmd/entra/m365group/m365group-conversation-post-list.mdx +5 -5
  69. package/docs/docs/cmd/entra/m365group/m365group-recyclebinitem-list.mdx +3 -3
  70. package/docs/docs/cmd/entra/m365group/m365group-set.mdx +37 -7
  71. package/docs/docs/cmd/entra/m365group/m365group-user-list.mdx +1 -1
  72. package/docs/docs/cmd/entra/multitenant/multitenant-add.mdx +107 -0
  73. package/docs/docs/cmd/entra/multitenant/multitenant-get.mdx +94 -0
  74. package/docs/docs/cmd/entra/multitenant/multitenant-remove.mdx +58 -0
  75. package/docs/docs/cmd/entra/multitenant/multitenant-set.mdx +53 -0
  76. package/docs/docs/cmd/external/connection/connection-doctor.mdx +9 -9
  77. package/docs/docs/cmd/flow/flow-list.mdx +114 -56
  78. package/docs/docs/cmd/graph/subscription/subscription-add.mdx +18 -0
  79. package/docs/docs/cmd/outlook/message/message-get.mdx +5 -5
  80. package/docs/docs/cmd/planner/plan/plan-remove.mdx +1 -1
  81. package/docs/docs/cmd/spe/containertype/containertype-list.mdx +102 -0
  82. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-get.mdx +87 -38
  83. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-list.mdx +22 -28
  84. package/docs/docs/cmd/spo/cdn/cdn-set.mdx +3 -3
  85. package/docs/docs/cmd/spo/commandset/commandset-get.mdx +75 -24
  86. package/docs/docs/cmd/spo/commandset/commandset-list.mdx +26 -32
  87. package/docs/docs/cmd/spo/contenttype/contenttype-field-list.mdx +172 -0
  88. package/docs/docs/cmd/spo/contenttype/contenttype-list.mdx +3 -3
  89. package/docs/docs/cmd/spo/field/field-list.mdx +3 -3
  90. package/docs/docs/cmd/spo/file/file-retentionlabel-ensure.mdx +1 -1
  91. package/docs/docs/cmd/spo/file/file-roleassignment-add.mdx +2 -2
  92. package/docs/docs/cmd/spo/file/file-roleassignment-remove.mdx +1 -1
  93. package/docs/docs/cmd/spo/file/file-roleinheritance-break.mdx +1 -1
  94. package/docs/docs/cmd/spo/file/file-roleinheritance-reset.mdx +1 -1
  95. package/docs/docs/cmd/spo/folder/folder-retentionlabel-ensure.mdx +2 -2
  96. package/docs/docs/cmd/spo/group/group-member-add.mdx +34 -27
  97. package/docs/docs/cmd/spo/list/list-list.mdx +5 -7
  98. package/docs/docs/cmd/spo/list/list-roleassignment-add.mdx +15 -3
  99. package/docs/docs/cmd/spo/list/list-roleassignment-remove.mdx +15 -3
  100. package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-ensure.mdx +4 -4
  101. package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-remove.mdx +1 -1
  102. package/docs/docs/cmd/spo/listitem/listitem-roleassignment-add.mdx +9 -9
  103. package/docs/docs/cmd/spo/listitem/listitem-roleassignment-remove.mdx +7 -7
  104. package/docs/docs/cmd/spo/site/site-appcatalog-remove.mdx +11 -2
  105. package/docs/docs/cmd/spo/site/site-recyclebinitem-list.mdx +1 -1
  106. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-get.mdx +79 -30
  107. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-list.mdx +20 -19
  108. package/docs/docs/cmd/spo/tenant/tenant-commandset-get.mdx +84 -38
  109. package/docs/docs/cmd/spo/tenant/tenant-commandset-list.mdx +20 -19
  110. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-restore.mdx +2 -49
  111. package/docs/docs/cmd/spo/web/web-roleassignment-add.mdx +1 -1
  112. package/docs/docs/cmd/spo/web/web-roleassignment-remove.mdx +1 -1
  113. package/docs/docs/cmd/teams/meeting/meeting-attendancereport-get.mdx +138 -0
  114. package/docs/docs/cmd/teams/meeting/meeting-list.mdx +7 -3
  115. package/docs/docs/cmd/teams/message/message-remove.mdx +63 -0
  116. package/docs/docs/cmd/viva/engage/engage-community-add.mdx +168 -0
  117. package/npm-shrinkwrap.json +588 -1022
  118. package/package.json +7 -3
@@ -0,0 +1,166 @@
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 _VivaEngageCommunityAddCommand_instances, _VivaEngageCommunityAddCommand_initTelemetry, _VivaEngageCommunityAddCommand_initOptions, _VivaEngageCommunityAddCommand_initValidators, _VivaEngageCommunityAddCommand_initTypes, _VivaEngageCommunityAddCommand_initOptionSets;
7
+ import GraphCommand from '../../../base/GraphCommand.js';
8
+ import commands from '../../commands.js';
9
+ import request from '../../../../request.js';
10
+ import { validation } from '../../../../utils/validation.js';
11
+ import { accessToken } from '../../../../utils/accessToken.js';
12
+ import auth from '../../../../Auth.js';
13
+ import { formatting } from '../../../../utils/formatting.js';
14
+ import { entraUser } from '../../../../utils/entraUser.js';
15
+ import { setTimeout } from 'timers/promises';
16
+ class VivaEngageCommunityAddCommand extends GraphCommand {
17
+ get name() {
18
+ return commands.ENGAGE_COMMUNITY_ADD;
19
+ }
20
+ get description() {
21
+ return 'Creates a new community in Viva Engage';
22
+ }
23
+ constructor() {
24
+ super();
25
+ _VivaEngageCommunityAddCommand_instances.add(this);
26
+ this.pollingInterval = 5000;
27
+ this.privacyOptions = ['public', 'private'];
28
+ __classPrivateFieldGet(this, _VivaEngageCommunityAddCommand_instances, "m", _VivaEngageCommunityAddCommand_initTelemetry).call(this);
29
+ __classPrivateFieldGet(this, _VivaEngageCommunityAddCommand_instances, "m", _VivaEngageCommunityAddCommand_initOptions).call(this);
30
+ __classPrivateFieldGet(this, _VivaEngageCommunityAddCommand_instances, "m", _VivaEngageCommunityAddCommand_initValidators).call(this);
31
+ __classPrivateFieldGet(this, _VivaEngageCommunityAddCommand_instances, "m", _VivaEngageCommunityAddCommand_initTypes).call(this);
32
+ __classPrivateFieldGet(this, _VivaEngageCommunityAddCommand_instances, "m", _VivaEngageCommunityAddCommand_initOptionSets).call(this);
33
+ }
34
+ async commandAction(logger, args) {
35
+ const { displayName, description, privacy, adminEntraIds, adminEntraUserNames, wait } = args.options;
36
+ const isAppOnlyAccessToken = accessToken.isAppOnlyAccessToken(auth.connection.accessTokens[auth.defaultResource].accessToken);
37
+ if (isAppOnlyAccessToken && !adminEntraIds && !adminEntraUserNames) {
38
+ this.handleError(`Specify at least one admin using either adminEntraIds or adminEntraUserNames options when using application permissions.`);
39
+ }
40
+ if (this.verbose) {
41
+ await logger.logToStderr(`Creating a Viva Engage community with display name '${displayName}'...`);
42
+ }
43
+ try {
44
+ const requestOptions = {
45
+ url: `${this.resource}/beta/employeeExperience/communities`,
46
+ headers: {
47
+ accept: 'application/json;odata.metadata=none',
48
+ 'content-type': 'application/json'
49
+ },
50
+ responseType: 'json',
51
+ fullResponse: true,
52
+ data: {
53
+ displayName: displayName,
54
+ description: description,
55
+ privacy: privacy
56
+ }
57
+ };
58
+ const entraIds = await this.getGraphUserUrls(args.options);
59
+ if (entraIds.length > 0) {
60
+ requestOptions.data['owners@odata.bind'] = entraIds;
61
+ }
62
+ const res = await request.post(requestOptions);
63
+ const location = res.headers.location;
64
+ if (!wait) {
65
+ await logger.log(location);
66
+ return;
67
+ }
68
+ let status;
69
+ do {
70
+ if (this.verbose) {
71
+ await logger.logToStderr(`Community still provisioning. Retrying in ${this.pollingInterval / 1000} seconds...`);
72
+ }
73
+ await setTimeout(this.pollingInterval);
74
+ if (this.verbose) {
75
+ await logger.logToStderr(`Checking create community operation status...`);
76
+ }
77
+ const operation = await request.get({
78
+ url: location,
79
+ headers: {
80
+ accept: 'application/json;odata.metadata=none'
81
+ },
82
+ responseType: 'json'
83
+ });
84
+ status = operation.status;
85
+ if (this.verbose) {
86
+ await logger.logToStderr(`Community creation operation status: ${status}`);
87
+ }
88
+ if (status === 'failed') {
89
+ throw `Community creation failed: ${operation.statusDetail}`;
90
+ }
91
+ if (status === 'succeeded') {
92
+ await logger.log(operation);
93
+ }
94
+ } while (status === 'notStarted' || status === 'running');
95
+ }
96
+ catch (err) {
97
+ this.handleRejectedODataJsonPromise(err);
98
+ }
99
+ }
100
+ async getGraphUserUrls(options) {
101
+ let entraIds = [];
102
+ if (options.adminEntraIds) {
103
+ entraIds = formatting.splitAndTrim(options.adminEntraIds);
104
+ }
105
+ else if (options.adminEntraUserNames) {
106
+ entraIds = await entraUser.getUserIdsByUpns(formatting.splitAndTrim(options.adminEntraUserNames));
107
+ }
108
+ const graphUserUrls = entraIds.map(id => `${this.resource}/beta/users/${id}`);
109
+ return graphUserUrls;
110
+ }
111
+ }
112
+ _VivaEngageCommunityAddCommand_instances = new WeakSet(), _VivaEngageCommunityAddCommand_initTelemetry = function _VivaEngageCommunityAddCommand_initTelemetry() {
113
+ this.telemetry.push((args) => {
114
+ Object.assign(this.telemetryProperties, {
115
+ adminEntraIds: typeof args.options.adminEntraIds !== 'undefined',
116
+ adminEntraUserNames: typeof args.options.adminEntraUserNames !== 'undefined',
117
+ wait: !!args.options.wait
118
+ });
119
+ });
120
+ }, _VivaEngageCommunityAddCommand_initOptions = function _VivaEngageCommunityAddCommand_initOptions() {
121
+ this.options.unshift({ option: '--displayName <displayName>' }, { option: '--description <description>' }, {
122
+ option: '--privacy <privacy>',
123
+ autocomplete: this.privacyOptions
124
+ }, { option: '--adminEntraIds [adminEntraIds]' }, { option: '--adminEntraUserNames [adminEntraUserNames]' }, { option: '--wait' });
125
+ }, _VivaEngageCommunityAddCommand_initValidators = function _VivaEngageCommunityAddCommand_initValidators() {
126
+ this.validators.push(async (args) => {
127
+ if (args.options.displayName.length > 255) {
128
+ return `The maximum amount of characters for 'displayName' is 255.`;
129
+ }
130
+ if (args.options.description.length > 1024) {
131
+ return `The maximum amount of characters for 'description' is 1024.`;
132
+ }
133
+ if (this.privacyOptions.indexOf(args.options.privacy) === -1) {
134
+ return `'${args.options.privacy}' is not a valid value for privacy. Allowed values are: ${this.privacyOptions.join(', ')}.`;
135
+ }
136
+ if (args.options.adminEntraIds) {
137
+ const isValidGUIDArrayResult = validation.isValidGuidArray(args.options.adminEntraIds);
138
+ if (isValidGUIDArrayResult !== true) {
139
+ return `The following GUIDs are invalid for the option 'adminEntraIds': ${isValidGUIDArrayResult}.`;
140
+ }
141
+ if (formatting.splitAndTrim(args.options.adminEntraIds).length > 20) {
142
+ return `Maximum of 20 admins allowed. Please reduce the number of users and try again.`;
143
+ }
144
+ }
145
+ if (args.options.adminEntraUserNames) {
146
+ const isValidUPNArrayResult = validation.isValidUserPrincipalNameArray(args.options.adminEntraUserNames);
147
+ if (isValidUPNArrayResult !== true) {
148
+ return `The following user principal names are invalid for the option 'adminEntraUserNames': ${isValidUPNArrayResult}.`;
149
+ }
150
+ if (formatting.splitAndTrim(args.options.adminEntraUserNames).length > 20) {
151
+ return `Maximum of 20 admins allowed. Please reduce the number of users and try again.`;
152
+ }
153
+ }
154
+ return true;
155
+ });
156
+ }, _VivaEngageCommunityAddCommand_initTypes = function _VivaEngageCommunityAddCommand_initTypes() {
157
+ this.types.string.push('displayName', 'description', 'privacy', 'adminEntraIds', 'adminEntraUserNames');
158
+ this.types.boolean.push('wait');
159
+ }, _VivaEngageCommunityAddCommand_initOptionSets = function _VivaEngageCommunityAddCommand_initOptionSets() {
160
+ this.optionSets.push({
161
+ options: ['adminEntraIds', 'adminEntraUserNames'],
162
+ runsWhen: (args) => args.options.adminEntraIds || args.options.adminEntraUserNames
163
+ });
164
+ };
165
+ export default new VivaEngageCommunityAddCommand();
166
+ //# sourceMappingURL=engage-community-add.js.map
@@ -1,6 +1,7 @@
1
1
  const prefix = 'viva';
2
2
  export default {
3
3
  CONNECTIONS_APP_CREATE: `${prefix} connections app create`,
4
+ ENGAGE_COMMUNITY_ADD: `${prefix} engage community add`,
4
5
  ENGAGE_COMMUNITY_GET: `${prefix} engage community get`,
5
6
  ENGAGE_GROUP_LIST: `${prefix} engage group list`,
6
7
  ENGAGE_GROUP_USER_ADD: `${prefix} engage group user add`,
@@ -9,6 +9,8 @@ export var CheckStatus;
9
9
  (function (CheckStatus) {
10
10
  CheckStatus[CheckStatus["Success"] = 0] = "Success";
11
11
  CheckStatus[CheckStatus["Failure"] = 1] = "Failure";
12
+ CheckStatus[CheckStatus["Information"] = 2] = "Information";
13
+ CheckStatus[CheckStatus["Warning"] = 3] = "Warning";
12
14
  })(CheckStatus || (CheckStatus = {}));
13
15
  export const formatting = {
14
16
  escapeXml(s) {
@@ -37,6 +39,22 @@ export const formatting = {
37
39
  parseJsonWithBom(s) {
38
40
  return JSON.parse(s.replace(/^\uFEFF/, ''));
39
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
+ },
40
58
  filterObject(obj, propertiesToInclude) {
41
59
  const objKeys = Object.keys(obj);
42
60
  return propertiesToInclude
@@ -152,7 +170,18 @@ export const formatting = {
152
170
  process.env.TERM === 'xterm-256color';
153
171
  const success = primarySupported ? '✔' : '√';
154
172
  const failure = primarySupported ? '✖' : '×';
155
- return `${result === CheckStatus.Success ? chalk.green(success) : chalk.red(failure)} ${message}`;
173
+ const information = 'i';
174
+ const warning = '!';
175
+ switch (result) {
176
+ case CheckStatus.Success:
177
+ return `${chalk.green(success)} ${message}`;
178
+ case CheckStatus.Failure:
179
+ return `${chalk.red(failure)} ${message}`;
180
+ case CheckStatus.Information:
181
+ return `${chalk.blue(information)} ${message}`;
182
+ case CheckStatus.Warning:
183
+ return `${chalk.yellow(warning)} ${message}`;
184
+ }
156
185
  },
157
186
  convertArrayToHashTable(key, array) {
158
187
  const resultAsKeyValuePair = {};
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)}')`;
@@ -0,0 +1,49 @@
1
+ import { formatting } from './formatting.js';
2
+ import { odata } from './odata.js';
3
+ import { cli } from '../cli/cli.js';
4
+ const graphResource = 'https://graph.microsoft.com';
5
+ export const teams = {
6
+ /**
7
+ * Retrieve the id of a team by its name.
8
+ * @param displayName Name of the team to retrieve.
9
+ * @throws Error if the team cannot be found.
10
+ * @throws Error when multiple teams with the same name and prompting is disabled.
11
+ * @returns The ID of the team.
12
+ */
13
+ async getTeamIdByDisplayName(displayName) {
14
+ const teams = await odata.getAllItems(`${graphResource}/v1.0/teams?$filter=displayName eq '${formatting.encodeQueryParameter(displayName)}'&$select=id`);
15
+ if (!teams.length) {
16
+ throw Error(`The specified team '${displayName}' does not exist.`);
17
+ }
18
+ if (teams.length > 1) {
19
+ const resultAsKeyValuePair = formatting.convertArrayToHashTable('id', teams);
20
+ const result = await cli.handleMultipleResultsFound(`Multiple teams with name '${displayName}' found.`, resultAsKeyValuePair);
21
+ return result.id;
22
+ }
23
+ return teams[0].id;
24
+ },
25
+ /**
26
+ * Retrieves the channel ID by its name in a Microsoft Teams team.
27
+ * @param teamId The ID of the team.
28
+ * @param name The name of the channel.
29
+ * @returns The ID of the channel.
30
+ * @throws Throws an error if the specified channel does not exist in the team.
31
+ */
32
+ async getChannelIdByDisplayName(teamId, name) {
33
+ const channelRequestOptions = {
34
+ url: `${graphResource}/v1.0/teams/${teamId}/channels?$filter=displayName eq '${formatting.encodeQueryParameter(name)}'&$select=id`,
35
+ headers: {
36
+ accept: 'application/json;odata.metadata=none'
37
+ },
38
+ responseType: 'json'
39
+ };
40
+ const response = await odata.getAllItems(channelRequestOptions);
41
+ // Only one channel can have the same name in a team
42
+ const channelItem = response[0];
43
+ if (!channelItem) {
44
+ throw Error(`The channel '${name}' does not exist in the Microsoft Teams team with ID '${teamId}'.`);
45
+ }
46
+ return channelItem.id;
47
+ }
48
+ };
49
+ //# sourceMappingURL=teams.js.map
@@ -1,3 +1,4 @@
1
+ import { formatting } from "./formatting.js";
1
2
  export const validation = {
2
3
  isValidGuidArray(guidsString) {
3
4
  const guids = guidsString.split(',').map(guid => guid.trim());
@@ -33,6 +34,24 @@ export const validation = {
33
34
  // verify if the upn is a valid upn. @meusername will be replaced in a later stage with the actual username of the logged in user
34
35
  return upnRegEx.test(upn) || upn.toLowerCase().trim() === '@meusername';
35
36
  },
37
+ /**
38
+ * Validates if the provided number is a valid positive integer (1 or higher).
39
+ * @param integer Integer value.
40
+ * @returns True if integer, false otherwise.
41
+ */
42
+ isValidPositiveInteger(integer) {
43
+ return !isNaN(Number(integer)) && Number.isInteger(+integer) && +integer > 0;
44
+ },
45
+ /**
46
+ * Validates an array of integers. The integers must be positive (1 or higher).
47
+ * @param integerString Comma-separated string of integers.
48
+ * @returns True if the integers are valid, an error message with the invalid integers otherwise.
49
+ */
50
+ isValidPositiveIntegerArray(integerString) {
51
+ const integers = formatting.splitAndTrim(integerString);
52
+ const invalidIntegers = integers.filter(integer => !this.isValidPositiveInteger(integer));
53
+ return invalidIntegers.length > 0 ? invalidIntegers.join(', ') : true;
54
+ },
36
55
  isDateInRange(date, monthOffset) {
37
56
  const d = new Date(date);
38
57
  const cutoffDate = new Date();
@@ -0,0 +1,124 @@
1
+ import { z } from 'zod';
2
+ function parseEffect(def, _options, _currentOption) {
3
+ return def.schema._def;
4
+ }
5
+ function parseIntersection(def, _options, _currentOption) {
6
+ if (def.left._def.typeName !== z.ZodFirstPartyTypeKind.ZodAny) {
7
+ return def.left._def;
8
+ }
9
+ if (def.right._def.typeName !== z.ZodFirstPartyTypeKind.ZodAny) {
10
+ return def.right._def;
11
+ }
12
+ return;
13
+ }
14
+ function parseObject(def, options, _currentOption) {
15
+ const properties = def.shape();
16
+ for (const key in properties) {
17
+ const property = properties[key];
18
+ const option = {
19
+ name: key,
20
+ long: key,
21
+ short: property._def.alias,
22
+ required: true,
23
+ type: 'string'
24
+ };
25
+ parseDef(property._def, options, option);
26
+ options.push(option);
27
+ }
28
+ return;
29
+ }
30
+ function parseString(_def, _options, currentOption) {
31
+ if (currentOption) {
32
+ currentOption.type = 'string';
33
+ }
34
+ return;
35
+ }
36
+ function parseNumber(_def, _options, currentOption) {
37
+ if (currentOption) {
38
+ currentOption.type = 'number';
39
+ }
40
+ return;
41
+ }
42
+ function parseBoolean(_def, _options, currentOption) {
43
+ if (currentOption) {
44
+ currentOption.type = 'boolean';
45
+ }
46
+ return;
47
+ }
48
+ function parseOptional(def, _options, currentOption) {
49
+ if (currentOption) {
50
+ currentOption.required = false;
51
+ }
52
+ return def.innerType._def;
53
+ }
54
+ function parseDefault(def, _options, currentOption) {
55
+ if (currentOption) {
56
+ currentOption.required = false;
57
+ }
58
+ return def.innerType._def;
59
+ }
60
+ function parseEnum(def, _options, currentOption) {
61
+ if (currentOption) {
62
+ currentOption.type = 'string';
63
+ currentOption.autocomplete = def.values;
64
+ }
65
+ return;
66
+ }
67
+ function parseNativeEnum(def, _options, currentOption) {
68
+ if (currentOption) {
69
+ currentOption.type = 'string';
70
+ currentOption.autocomplete = Object.getOwnPropertyNames(def.values);
71
+ }
72
+ return;
73
+ }
74
+ function getParseFn(typeName) {
75
+ switch (typeName) {
76
+ case z.ZodFirstPartyTypeKind.ZodEffects:
77
+ return parseEffect;
78
+ case z.ZodFirstPartyTypeKind.ZodObject:
79
+ return parseObject;
80
+ case z.ZodFirstPartyTypeKind.ZodOptional:
81
+ return parseOptional;
82
+ case z.ZodFirstPartyTypeKind.ZodString:
83
+ return parseString;
84
+ case z.ZodFirstPartyTypeKind.ZodNumber:
85
+ return parseNumber;
86
+ case z.ZodFirstPartyTypeKind.ZodBoolean:
87
+ return parseBoolean;
88
+ case z.ZodFirstPartyTypeKind.ZodEnum:
89
+ return parseEnum;
90
+ case z.ZodFirstPartyTypeKind.ZodNativeEnum:
91
+ return parseNativeEnum;
92
+ case z.ZodFirstPartyTypeKind.ZodDefault:
93
+ return parseDefault;
94
+ case z.ZodFirstPartyTypeKind.ZodIntersection:
95
+ return parseIntersection;
96
+ default:
97
+ return;
98
+ }
99
+ }
100
+ function parseDef(def, options, currentOption) {
101
+ let parsedDef = def;
102
+ do {
103
+ const parse = getParseFn(parsedDef.typeName);
104
+ if (!parse) {
105
+ break;
106
+ }
107
+ parsedDef = parse(parsedDef, options, currentOption);
108
+ if (!parsedDef) {
109
+ break;
110
+ }
111
+ } while (parsedDef);
112
+ }
113
+ export const zod = {
114
+ alias(alias, type) {
115
+ type._def.alias = alias;
116
+ return type;
117
+ },
118
+ schemaToOptions(schema) {
119
+ const options = [];
120
+ parseDef(schema._def, options);
121
+ return options;
122
+ }
123
+ };
124
+ //# sourceMappingURL=zod.js.map
@@ -16,10 +16,10 @@ m365 app permission add [options]
16
16
  `--appId [appId]`
17
17
  : Client ID of the Microsoft Entra app registered in the .m365rc.json file to retrieve API permissions for.
18
18
 
19
- `--applicationPermission [applicationPermission]`
19
+ `--applicationPermissions [applicationPermissions]`
20
20
  : Space-separated list of application permissions to add.
21
21
 
22
- `--delegatedPermission [delegatedPermission]`
22
+ `--delegatedPermissions [delegatedPermissions]`
23
23
  : Space-separated list of delegated permissions to add.
24
24
 
25
25
  `--grantAdminConsent`
@@ -37,19 +37,19 @@ If you have multiple apps registered in your .m365rc.json file, you can specify
37
37
  Adds the specified application permissions to the default app registered in the _.m365rc.json_ file while granting admin consent.
38
38
 
39
39
  ```sh
40
- m365 app permission add --applicationPermission 'https://graph.microsoft.com/User.ReadWrite.All https://graph.microsoft.com/User.Read.All' --grantAdminConsent
40
+ m365 app permission add --applicationPermissions 'https://graph.microsoft.com/User.ReadWrite.All https://graph.microsoft.com/User.Read.All' --grantAdminConsent
41
41
  ```
42
42
 
43
43
  Adds the specified delegated permissions to the default app registered in the _.m365rc.json_ file without granting admin consent.
44
44
 
45
45
  ```sh
46
- m365 app permission add --delegatedPermission 'https://graph.microsoft.com/offline_access'
46
+ m365 app permission add --delegatedPermissions 'https://graph.microsoft.com/offline_access'
47
47
  ```
48
48
 
49
49
  Adds the specified application and delegated permissions to a specific app registered in the _.m365rc.json_ file while granting admin consent.
50
50
 
51
51
  ```sh
52
- m365 app permission add --appId '1663767b-4172-4519-bfd1-28e6ff19055b' --applicationPermission 'https://graph.microsoft.com/User.ReadWrite.All https://graph.microsoft.com/User.Read.All' --delegatedPermission 'https://graph.microsoft.com/offline_access' --grantAdminConsent
52
+ m365 app permission add --appId '1663767b-4172-4519-bfd1-28e6ff19055b' --applicationPermissions 'https://graph.microsoft.com/User.ReadWrite.All https://graph.microsoft.com/User.Read.All' --delegatedPermissions 'https://graph.microsoft.com/offline_access' --grantAdminConsent
53
53
  ```
54
54
 
55
55
  ## Response
@@ -15,7 +15,7 @@ m365 connection use [options]
15
15
  ## Options
16
16
 
17
17
  ```md definition-list
18
- `-n, --name <name>`
18
+ `-n, --name [name]`
19
19
  : The name of the connection to switch to.
20
20
  ```
21
21
 
@@ -23,7 +23,13 @@ m365 connection use [options]
23
23
 
24
24
  ## Remarks
25
25
 
26
- The value for `--name` can be found by running [m365 connection list](connection-list.mdx). You can update the name of a connection by running [m365 connection set](connection-set.mdx).
26
+ :::tip
27
+
28
+ If you haven't disabled the "prompt" setting, running this command without options will show a list of available connections. You can then select the connection to activate it.
29
+
30
+ :::
31
+
32
+ You can update the name of a connection by running [m365 connection set](connection-set.mdx).
27
33
 
28
34
  ## Examples
29
35
 
@@ -22,10 +22,10 @@ m365 aad group user list [options]
22
22
 
23
23
  ```md definition-list
24
24
  `-i, --groupId [groupId]`
25
- : The ID of the Entra group. Specify `groupId` or `groupDisplayName` but not both.
25
+ : The ID of the Entra group. Specify `groupId` or `groupName` but not both.
26
26
 
27
- `-n, --groupDisplayName [groupDisplayName]`
28
- : The display name of the Entra group. Specify `groupId` or `groupDisplayName` but not both.
27
+ `-n, --groupName [groupName]`
28
+ : The display name of the Entra group. Specify `groupId` or `groupName` but not both.
29
29
 
30
30
  `-r, --role [role]`
31
31
  : Filter the results to only users with the given role: `Owner`, `Member`.
@@ -54,25 +54,25 @@ m365 entra group user list --groupId 03cba9da-3974-46c1-afaf-79caa2e45bbe
54
54
  List all owners from a group specified by display name.
55
55
 
56
56
  ```sh
57
- m365 entra group user list --groupDisplayName Developers --role Owner
57
+ m365 entra group user list --groupName Developers --role Owner
58
58
  ```
59
59
 
60
60
  List all group users from a group specified by name. For each one return the display name, e-mail address, and manager display name.
61
61
 
62
62
  ```sh
63
- m365 entra group user list --groupDisplayName Developers --properties "displayName,mail,manager/displayName"
63
+ m365 entra group user list --groupName Developers --properties "displayName,mail,manager/displayName"
64
64
  ```
65
65
 
66
66
  List all group users from a group specified by name. For each one return the display name, e-mail address, and manager information.
67
67
 
68
68
  ```sh
69
- m365 entra group user list --groupDisplayName Developers --properties "displayName,mail,manager/*"
69
+ m365 entra group user list --groupName Developers --properties "displayName,mail,manager/*"
70
70
  ```
71
71
 
72
72
  List all group members that are guest users.
73
73
 
74
74
  ```sh
75
- m365 entra group user list --groupDisplayName Developers --filter "userType eq 'Guest'"
75
+ m365 entra group user list --groupName Developers --filter "userType eq 'Guest'"
76
76
  ```
77
77
 
78
78
  ## Response
@@ -22,10 +22,10 @@ m365 aad m365group conversation post list [options]
22
22
 
23
23
  ```md definition-list
24
24
  `-i, --groupId [groupId]`
25
- : The Id of the Microsoft 365 Group. You can specify the groupId or groupDisplayName, but not both.
25
+ : The Id of the Microsoft 365 Group. You can specify the groupId or groupName, but not both.
26
26
 
27
- `-d, --groupDisplayName [groupDisplayName]`
28
- : The Displayname of the Microsoft 365 Group. You can specify the groupId or groupDisplayName, but not both.
27
+ `-d, --groupName [groupName]`
28
+ : The Displayname of the Microsoft 365 Group. You can specify the groupId or groupName, but not both.
29
29
 
30
30
  `-t, --threadId <threadId>`
31
31
  : The ID of the thread to retrieve details for
@@ -41,10 +41,10 @@ Lists the posts of the specific conversation of Microsoft 365 group by groupId
41
41
  m365 entra m365group conversation post list --groupId '00000000-0000-0000-0000-000000000000' --threadId 'AAQkADkwN2Q2NDg1LWQ3ZGYtNDViZi1iNGRiLTVhYjJmN2Q5NDkxZQAQAOnRAfDf71lIvrdK85FAn5E='
42
42
  ```
43
43
 
44
- Lists the posts of the specific conversation of Microsoft 365 group by groupDisplayName
44
+ Lists the posts of the specific conversation of Microsoft 365 group by groupName
45
45
 
46
46
  ```sh
47
- m365 entra m365group conversation post list --groupDisplayName 'MyGroup' --threadId 'AAQkADkwN2Q2NDg1LWQ3ZGYtNDViZi1iNGRiLTVhYjJmN2Q5NDkxZQAQAOnRAfDf71lIvrdK85FAn5E='
47
+ m365 entra m365group conversation post list --groupName 'MyGroup' --threadId 'AAQkADkwN2Q2NDg1LWQ3ZGYtNDViZi1iNGRiLTVhYjJmN2Q5NDkxZQAQAOnRAfDf71lIvrdK85FAn5E='
48
48
  ```
49
49
 
50
50
  ## Response
@@ -21,7 +21,7 @@ m365 aad m365group recyclebinitem list [options]
21
21
  ## Options
22
22
 
23
23
  ```md definition-list
24
- `-d, --groupDisplayName [groupDisplayName]`
24
+ `-d, --groupName [groupName]`
25
25
  : Lists groups with DisplayName starting with the specified value
26
26
 
27
27
  `-m, --groupMailNickname [groupMailNickname]`
@@ -41,7 +41,7 @@ m365 entra m365group recyclebinitem list
41
41
  List deleted Microsoft 365 Groups with display name starting with _Project_
42
42
 
43
43
  ```sh
44
- m365 entra m365group recyclebinitem list --groupDisplayName Project
44
+ m365 entra m365group recyclebinitem list --groupName Project
45
45
  ```
46
46
 
47
47
  List deleted Microsoft 365 Groups mail nick name starting with _team_
@@ -53,7 +53,7 @@ m365 entra m365group recyclebinitem list --groupMailNickname team
53
53
  List deleted Microsoft 365 Groups mail nick name starting with _team_ and with display name starting with _Project_
54
54
 
55
55
  ```sh
56
- m365 entra m365group recyclebinitem list --groupMailNickname team --groupDisplayName Project
56
+ m365 entra m365group recyclebinitem list --groupMailNickname team --groupName Project
57
57
  ```
58
58
 
59
59
  ## Response