@pnp/cli-microsoft365 7.11.0-beta.b404d9d → 8.0.0-beta.3c404b8

package/dist/m365/viva/commands/engage/engage-community-add.js

@@ -0,0 +1,166 @@
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    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");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _VivaEngageCommunityAddCommand_instances, _VivaEngageCommunityAddCommand_initTelemetry, _VivaEngageCommunityAddCommand_initOptions, _VivaEngageCommunityAddCommand_initValidators, _VivaEngageCommunityAddCommand_initTypes, _VivaEngageCommunityAddCommand_initOptionSets;
+import GraphCommand from '../../../base/GraphCommand.js';
+import commands from '../../commands.js';
+import request from '../../../../request.js';
+import { validation } from '../../../../utils/validation.js';
+import { accessToken } from '../../../../utils/accessToken.js';
+import auth from '../../../../Auth.js';
+import { formatting } from '../../../../utils/formatting.js';
+import { entraUser } from '../../../../utils/entraUser.js';
+import { setTimeout } from 'timers/promises';
+class VivaEngageCommunityAddCommand extends GraphCommand {
+    get name() {
+        return commands.ENGAGE_COMMUNITY_ADD;
+    }
+    get description() {
+        return 'Creates a new community in Viva Engage';
+    }
+    constructor() {
+        super();
+        _VivaEngageCommunityAddCommand_instances.add(this);
+        this.pollingInterval = 5000;
+        this.privacyOptions = ['public', 'private'];
+        __classPrivateFieldGet(this, _VivaEngageCommunityAddCommand_instances, "m", _VivaEngageCommunityAddCommand_initTelemetry).call(this);
+        __classPrivateFieldGet(this, _VivaEngageCommunityAddCommand_instances, "m", _VivaEngageCommunityAddCommand_initOptions).call(this);
+        __classPrivateFieldGet(this, _VivaEngageCommunityAddCommand_instances, "m", _VivaEngageCommunityAddCommand_initValidators).call(this);
+        __classPrivateFieldGet(this, _VivaEngageCommunityAddCommand_instances, "m", _VivaEngageCommunityAddCommand_initTypes).call(this);
+        __classPrivateFieldGet(this, _VivaEngageCommunityAddCommand_instances, "m", _VivaEngageCommunityAddCommand_initOptionSets).call(this);
+    }
+    async commandAction(logger, args) {
+        const { displayName, description, privacy, adminEntraIds, adminEntraUserNames, wait } = args.options;
+        const isAppOnlyAccessToken = accessToken.isAppOnlyAccessToken(auth.connection.accessTokens[auth.defaultResource].accessToken);
+        if (isAppOnlyAccessToken && !adminEntraIds && !adminEntraUserNames) {
+            this.handleError(`Specify at least one admin using either adminEntraIds or adminEntraUserNames options when using application permissions.`);
+        }
+        if (this.verbose) {
+            await logger.logToStderr(`Creating a Viva Engage community with display name '${displayName}'...`);
+        }
+        try {
+            const requestOptions = {
+                url: `${this.resource}/beta/employeeExperience/communities`,
+                headers: {
+                    accept: 'application/json;odata.metadata=none',
+                    'content-type': 'application/json'
+                },
+                responseType: 'json',
+                fullResponse: true,
+                data: {
+                    displayName: displayName,
+                    description: description,
+                    privacy: privacy
+                }
+            };
+            const entraIds = await this.getGraphUserUrls(args.options);
+            if (entraIds.length > 0) {
+                requestOptions.data['owners@odata.bind'] = entraIds;
+            }
+            const res = await request.post(requestOptions);
+            const location = res.headers.location;
+            if (!wait) {
+                await logger.log(location);
+                return;
+            }
+            let status;
+            do {
+                if (this.verbose) {
+                    await logger.logToStderr(`Community still provisioning. Retrying in ${this.pollingInterval / 1000} seconds...`);
+                }
+                await setTimeout(this.pollingInterval);
+                if (this.verbose) {
+                    await logger.logToStderr(`Checking create community operation status...`);
+                }
+                const operation = await request.get({
+                    url: location,
+                    headers: {
+                        accept: 'application/json;odata.metadata=none'
+                    },
+                    responseType: 'json'
+                });
+                status = operation.status;
+                if (this.verbose) {
+                    await logger.logToStderr(`Community creation operation status: ${status}`);
+                }
+                if (status === 'failed') {
+                    throw `Community creation failed: ${operation.statusDetail}`;
+                }
+                if (status === 'succeeded') {
+                    await logger.log(operation);
+                }
+            } while (status === 'notStarted' || status === 'running');
+        }
+        catch (err) {
+            this.handleRejectedODataJsonPromise(err);
+        }
+    }
+    async getGraphUserUrls(options) {
+        let entraIds = [];
+        if (options.adminEntraIds) {
+            entraIds = formatting.splitAndTrim(options.adminEntraIds);
+        }
+        else if (options.adminEntraUserNames) {
+            entraIds = await entraUser.getUserIdsByUpns(formatting.splitAndTrim(options.adminEntraUserNames));
+        }
+        const graphUserUrls = entraIds.map(id => `${this.resource}/beta/users/${id}`);
+        return graphUserUrls;
+    }
+}
+_VivaEngageCommunityAddCommand_instances = new WeakSet(), _VivaEngageCommunityAddCommand_initTelemetry = function _VivaEngageCommunityAddCommand_initTelemetry() {
+    this.telemetry.push((args) => {
+        Object.assign(this.telemetryProperties, {
+            adminEntraIds: typeof args.options.adminEntraIds !== 'undefined',
+            adminEntraUserNames: typeof args.options.adminEntraUserNames !== 'undefined',
+            wait: !!args.options.wait
+        });
+    });
+}, _VivaEngageCommunityAddCommand_initOptions = function _VivaEngageCommunityAddCommand_initOptions() {
+    this.options.unshift({ option: '--displayName <displayName>' }, { option: '--description <description>' }, {
+        option: '--privacy <privacy>',
+        autocomplete: this.privacyOptions
+    }, { option: '--adminEntraIds [adminEntraIds]' }, { option: '--adminEntraUserNames [adminEntraUserNames]' }, { option: '--wait' });
+}, _VivaEngageCommunityAddCommand_initValidators = function _VivaEngageCommunityAddCommand_initValidators() {
+    this.validators.push(async (args) => {
+        if (args.options.displayName.length > 255) {
+            return `The maximum amount of characters for 'displayName' is 255.`;
+        }
+        if (args.options.description.length > 1024) {
+            return `The maximum amount of characters for 'description' is 1024.`;
+        }
+        if (this.privacyOptions.indexOf(args.options.privacy) === -1) {
+            return `'${args.options.privacy}' is not a valid value for privacy. Allowed values are: ${this.privacyOptions.join(', ')}.`;
+        }
+        if (args.options.adminEntraIds) {
+            const isValidGUIDArrayResult = validation.isValidGuidArray(args.options.adminEntraIds);
+            if (isValidGUIDArrayResult !== true) {
+                return `The following GUIDs are invalid for the option 'adminEntraIds': ${isValidGUIDArrayResult}.`;
+            }
+            if (formatting.splitAndTrim(args.options.adminEntraIds).length > 20) {
+                return `Maximum of 20 admins allowed. Please reduce the number of users and try again.`;
+            }
+        }
+        if (args.options.adminEntraUserNames) {
+            const isValidUPNArrayResult = validation.isValidUserPrincipalNameArray(args.options.adminEntraUserNames);
+            if (isValidUPNArrayResult !== true) {
+                return `The following user principal names are invalid for the option 'adminEntraUserNames': ${isValidUPNArrayResult}.`;
+            }
+            if (formatting.splitAndTrim(args.options.adminEntraUserNames).length > 20) {
+                return `Maximum of 20 admins allowed. Please reduce the number of users and try again.`;
+            }
+        }
+        return true;
+    });
+}, _VivaEngageCommunityAddCommand_initTypes = function _VivaEngageCommunityAddCommand_initTypes() {
+    this.types.string.push('displayName', 'description', 'privacy', 'adminEntraIds', 'adminEntraUserNames');
+    this.types.boolean.push('wait');
+}, _VivaEngageCommunityAddCommand_initOptionSets = function _VivaEngageCommunityAddCommand_initOptionSets() {
+    this.optionSets.push({
+        options: ['adminEntraIds', 'adminEntraUserNames'],
+        runsWhen: (args) => args.options.adminEntraIds || args.options.adminEntraUserNames
+    });
+};
+export default new VivaEngageCommunityAddCommand();
+//# sourceMappingURL=engage-community-add.js.map

package/dist/m365/viva/commands.js

@@ -1,6 +1,7 @@
 const prefix = 'viva';
 export default {
     CONNECTIONS_APP_CREATE: `${prefix} connections app create`,
+    ENGAGE_COMMUNITY_ADD: `${prefix} engage community add`,
     ENGAGE_COMMUNITY_GET: `${prefix} engage community get`,
     ENGAGE_GROUP_LIST: `${prefix} engage group list`,
     ENGAGE_GROUP_USER_ADD: `${prefix} engage group user add`,

package/dist/utils/formatting.js

@@ -9,6 +9,8 @@ export var CheckStatus;
 (function (CheckStatus) {
     CheckStatus[CheckStatus["Success"] = 0] = "Success";
     CheckStatus[CheckStatus["Failure"] = 1] = "Failure";
+    CheckStatus[CheckStatus["Information"] = 2] = "Information";
+    CheckStatus[CheckStatus["Warning"] = 3] = "Warning";
 })(CheckStatus || (CheckStatus = {}));
 export const formatting = {
     escapeXml(s) {
@@ -152,7 +154,18 @@ export const formatting = {
             process.env.TERM === 'xterm-256color';
         const success = primarySupported ? '✔' : '√';
         const failure = primarySupported ? '✖' : '×';
-        return `${result === CheckStatus.Success ? chalk.green(success) : chalk.red(failure)} ${message}`;
+        const information = 'i';
+        const warning = '!';
+        switch (result) {
+            case CheckStatus.Success:
+                return `${chalk.green(success)} ${message}`;
+            case CheckStatus.Failure:
+                return `${chalk.red(failure)} ${message}`;
+            case CheckStatus.Information:
+                return `${chalk.blue(information)} ${message}`;
+            case CheckStatus.Warning:
+                return `${chalk.yellow(warning)} ${message}`;
+        }
     },
     convertArrayToHashTable(key, array) {
         const resultAsKeyValuePair = {};

package/dist/utils/teams.js

@@ -0,0 +1,49 @@
+import { formatting } from './formatting.js';
+import { odata } from './odata.js';
+import { cli } from '../cli/cli.js';
+const graphResource = 'https://graph.microsoft.com';
+export const teams = {
+    /**
+     * Retrieve the id of a team by its name.
+     * @param displayName Name of the team to retrieve.
+     * @throws Error if the team cannot be found.
+     * @throws Error when multiple teams with the same name and prompting is disabled.
+     * @returns The ID of the team.
+     */
+    async getTeamIdByDisplayName(displayName) {
+        const teams = await odata.getAllItems(`${graphResource}/v1.0/teams?$filter=displayName eq '${formatting.encodeQueryParameter(displayName)}'&$select=id`);
+        if (!teams.length) {
+            throw Error(`The specified team '${displayName}' does not exist.`);
+        }
+        if (teams.length > 1) {
+            const resultAsKeyValuePair = formatting.convertArrayToHashTable('id', teams);
+            const result = await cli.handleMultipleResultsFound(`Multiple teams with name '${displayName}' found.`, resultAsKeyValuePair);
+            return result.id;
+        }
+        return teams[0].id;
+    },
+    /**
+     * Retrieves the channel ID by its name in a Microsoft Teams team.
+     * @param teamId The ID of the team.
+     * @param name The name of the channel.
+     * @returns The ID of the channel.
+     * @throws Throws an error if the specified channel does not exist in the team.
+     */
+    async getChannelIdByDisplayName(teamId, name) {
+        const channelRequestOptions = {
+            url: `${graphResource}/v1.0/teams/${teamId}/channels?$filter=displayName eq '${formatting.encodeQueryParameter(name)}'&$select=id`,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json'
+        };
+        const response = await odata.getAllItems(channelRequestOptions);
+        // Only one channel can have the same name in a team
+        const channelItem = response[0];
+        if (!channelItem) {
+            throw Error(`The channel '${name}' does not exist in the Microsoft Teams team with ID '${teamId}'.`);
+        }
+        return channelItem.id;
+    }
+};
+//# sourceMappingURL=teams.js.map

package/dist/utils/validation.js

@@ -1,3 +1,4 @@
+import { formatting } from "./formatting.js";
 export const validation = {
     isValidGuidArray(guidsString) {
         const guids = guidsString.split(',').map(guid => guid.trim());
@@ -33,6 +34,24 @@ export const validation = {
         // 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
         return upnRegEx.test(upn) || upn.toLowerCase().trim() === '@meusername';
     },
+    /**
+     * Validates if the provided number is a valid positive integer (1 or higher).
+     * @param integer Integer value.
+     * @returns True if integer, false otherwise.
+     */
+    isValidPositiveInteger(integer) {
+        return !isNaN(Number(integer)) && Number.isInteger(+integer) && +integer > 0;
+    },
+    /**
+     * Validates an array of integers. The integers must be positive (1 or higher).
+     * @param integerString Comma-separated string of integers.
+     * @returns True if the integers are valid, an error message with the invalid integers otherwise.
+     */
+    isValidPositiveIntegerArray(integerString) {
+        const integers = formatting.splitAndTrim(integerString);
+        const invalidIntegers = integers.filter(integer => !this.isValidPositiveInteger(integer));
+        return invalidIntegers.length > 0 ? invalidIntegers.join(', ') : true;
+    },
     isDateInRange(date, monthOffset) {
         const d = new Date(date);
         const cutoffDate = new Date();

package/docs/docs/cmd/entra/m365group/m365group-set.mdx

@@ -35,10 +35,22 @@ m365 aad m365group set [options]
 : Comma-separated list of Microsoft 365 Group members to add
 
 `--isPrivate [isPrivate]`
-: Set to true if the Microsoft 365 Group should be private and to false if it should be public (default)
+: Set to `true` if the Microsoft 365 Group should be private and `false` if it should be public.  
 
 `-l, --logoPath [logoPath]`
 : Local path to the image file to use as group logo
+
+`--allowExternalSenders [allowExternalSenders]`
+: Indicates if people external to the organization can send messages to the group. Valid values: `true`, `false`.
+
+`--autoSubscribeNewMembers [autoSubscribeNewMembers]`
+: Indicates if new members added to the group will be auto-subscribed to receive email notifications. Valid values: `true`, `false`.
+
+`--hideFromAddressLists [hideFromAddressLists]`
+: Indicates if the group is not displayed in certain parts of the Outlook UI: the Address Book, address lists for selecting message recipients, and the Browse Groups dialog for searching groups. Valid values: `true`, `false`.
+
+`--hideFromOutlookClients [hideFromOutlookClients]`
+: Indicates if the group is not displayed in Outlook clients, such as Outlook for Windows and Outlook on the web. Valid values: `true`, `false`.
 ```
 
 <Global />
@@ -49,38 +61,56 @@ When updating group's owners and members, the command will add newly specified u
 
 When specifying the path to the logo image you can use both relative and absolute paths. Note, that ~ in the path, will not be resolved and will most likely result in an error.
 
+:::note
+
+Options `allowExternalSenders` and `autoSubscribeNewMembers` can only be set using delegated permissions.  
+
+:::
+
 ## Examples
 
-Update Microsoft 365 Group display name
+Update Microsoft 365 Group display name.
 
 ```sh
 m365 entra m365group set --id 28beab62-7540-4db1-a23f-29a6018a3848 --displayName Finance
 ```
 
-Change Microsoft 365 Group visibility to public
+Change Microsoft 365 Group visibility to public.
 
 ```sh
-m365 entra m365group set --id 28beab62-7540-4db1-a23f-29a6018a3848 --isPrivate false
+m365 entra m365group set --id 28beab62-7540-4db1-a23f-29a6018a3848 --isPrivate `false`
 ```
 
-Add new Microsoft 365 Group owners
+Add new Microsoft 365 Group owners.
 
 ```sh
 m365 entra m365group set --id 28beab62-7540-4db1-a23f-29a6018a3848 --owners "DebraB@contoso.onmicrosoft.com,DiegoS@contoso.onmicrosoft.com"
 ```
 
-Add new Microsoft 365 Group members
+Add new Microsoft 365 Group members.
 
 ```sh
 m365 entra m365group set --id 28beab62-7540-4db1-a23f-29a6018a3848 --members "DebraB@contoso.onmicrosoft.com,DiegoS@contoso.onmicrosoft.com"
 ```
 
-Update Microsoft 365 Group logo
+Update Microsoft 365 Group logo.
 
 ```sh
 m365 entra m365group set --id 28beab62-7540-4db1-a23f-29a6018a3848 --logoPath images/logo.png
 ```
 
+Hide the Microsoft 365 group from the address lists and the Outlook clients.
+
+```sh
+m365 entra m365group set --id 28beab62-7540-4db1-a23f-29a6018a3848 --hideFromOutlookClients true --hideFromAddressLists true
+```
+
+Auto-subscribe new members to receive email notifications and do not allow external senders to send messages to the group.
+
+```sh
+m365 entra m365group set --id 28beab62-7540-4db1-a23f-29a6018a3848 --autoSubscribeNewMembers true --allowExternalSenders false
+```
+
 ## Response
 
 The command won't return a response on success.

package/docs/docs/cmd/entra/multitenant/multitenant-get.mdx

@@ -0,0 +1,94 @@
+
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# entra multitenant get
+
+Gets properties of the multitenant organization
+
+## Usage
+
+```sh
+m365 entra multitenant get [options]
+```
+
+## Options
+
+<Global />
+
+## Remarks
+
+:::info
+
+To use this command you must be at least **Security Administrator**.
+
+:::
+
+## Examples
+
+Gets properties of the multitenant organization
+
+```sh
+m365 entra multitenant get
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "id": "c231d4a5-138f-4bdf-9fee-f26a90ea3ad0",
+    "createdDateTime": "2024-05-05T05:05:05Z",
+    "state": "active",
+    "displayName": "Contoso organization",
+    "description": "Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank"
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  createdDateTime: 2024-05-05T05:05:05Z
+  description    : Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank
+  displayName    : Contoso organization
+  id             : c231d4a5-138f-4bdf-9fee-f26a90ea3ad0
+  state          : active
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,createdDateTime,state,displayName,description
+  c231d4a5-138f-4bdf-9fee-f26a90ea3ad0,2024-05-05T05:05:05Z,active,Contoso organization,"Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank"
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # entra multitenant get
+
+  Date: 5/5/2024
+
+  ## Contoso organization (c231d4a5-138f-4bdf-9fee-f26a90ea3ad0)
+
+  Property | Value
+  ---------|-------
+  id | c231d4a5-138f-4bdf-9fee-f26a90ea3ad0
+  createdDateTime | 2024-05-05T05:05:05Z
+  state | active
+  displayName | Contoso organization
+  description | Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank
+  ```
+
+  </TabItem>
+</Tabs>
+
+## More information
+
+- Multitenant organization: https://learn.microsoft.com/entra/identity/multi-tenant-organizations/overview

package/docs/docs/cmd/external/connection/connection-doctor.mdx

@@ -126,15 +126,15 @@ m365 external connection doctor --id contosoproducts --ux copilot
   <TabItem value="Text">
 
   ```text
-  ✔ Load connection
-  ✔ Load schema
-  ✖ Required semantic labels: Missing label iconUrl
-  ✔ Searchable properties
-  ✔ Items have content ingested
-  ℹ Connection configured for inline results (manual)
-  ℹ Items have activities recorded (manual)
-  ℹ Meaningful connection name and description (manual)
-  ✔ urlToItemResolver configured
+  √ Load connection
+  √ Load schema
+  × Required semantic labels: Missing label iconUrl
+  √ Searchable properties
+  √ Items have content ingested
+  i Connection configured for inline results (manual)
+  i Items have activities recorded (manual)
+  i Meaningful connection name and description (manual)
+  √ urlToItemResolver configured
   ```
 
   </TabItem>