@pnp/cli-microsoft365 5.0.0-beta.6d4dbfb → 5.0.0-beta.6e613c5

package/dist/m365/teams/commands/chat/chat-message-send.js

@@ -0,0 +1,225 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const os = require("os");
+const Auth_1 = require("../../../../Auth");
+const request_1 = require("../../../../request");
+const Utils_1 = require("../../../../Utils");
+const GraphCommand_1 = require("../../../base/GraphCommand");
+const commands_1 = require("../../commands");
+class TeamsChatMessageSendCommand extends GraphCommand_1.default {
+    get name() {
+        return commands_1.default.CHAT_MESSAGE_SEND;
+    }
+    get description() {
+        return 'Send a message to an existing or new chat conversation.';
+    }
+    commandAction(logger, args, cb) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const chatId = args.options.chatId
+                    || args.options.userEmails && (yield this.ensureChatIdByUserEmails(args.options.userEmails))
+                    || args.options.chatName && (yield this.getChatIdByName(args.options.chatName));
+                yield this.sendChatMessage(chatId, args.options);
+                cb();
+            }
+            catch (error) {
+                this.handleRejectedODataJsonPromise(error, logger, cb);
+            }
+        });
+    }
+    options() {
+        const options = [
+            {
+                option: '--chatId [chatId]'
+            },
+            {
+                option: '-e, --userEmails [userEmails]'
+            },
+            {
+                option: '--chatName [chatName]'
+            },
+            {
+                option: '-m, --message <message>'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        if (!args.options.chatId && !args.options.userEmails && !args.options.chatName) {
+            return 'Specify chatId or userEmails or chatName, one is required.';
+        }
+        let nrOfMutuallyExclusiveOptionsInUse = 0;
+        if (args.options.chatId) {
+            nrOfMutuallyExclusiveOptionsInUse++;
+        }
+        if (args.options.userEmails) {
+            nrOfMutuallyExclusiveOptionsInUse++;
+        }
+        if (args.options.chatName) {
+            nrOfMutuallyExclusiveOptionsInUse++;
+        }
+        if (nrOfMutuallyExclusiveOptionsInUse > 1) {
+            return 'Specify either chatId or userEmails or chatName, but not multiple.';
+        }
+        if (!args.options.message) {
+            return 'Specify a message to send.';
+        }
+        if (args.options.chatId && !Utils_1.default.isValidTeamsChatId(args.options.chatId)) {
+            return `${args.options.chatId} is not a valid Teams ChatId.`;
+        }
+        if (args.options.userEmails) {
+            const userEmails = args.options.userEmails.toLowerCase().replace(/\s/g, '').split(',').filter(e => e && e !== '');
+            if (!userEmails || userEmails.length === 0 || userEmails.some(e => !Utils_1.default.isValidUserPrincipalName(e))) {
+                return `${args.options.userEmails} contains one or more invalid email addresses.`;
+            }
+        }
+        return true;
+    }
+    ensureChatIdByUserEmails(userEmailsOption) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const userEmails = userEmailsOption.toLowerCase().replace(/\s/g, '').split(',').filter(e => e && e !== '');
+            const currentUserEmail = Utils_1.default.getUserNameFromAccessToken(Auth_1.default.service.accessTokens[this.resource].accessToken).toLowerCase();
+            const existingChats = yield this.findExistingGroupChatsByMembers([currentUserEmail, ...userEmails]);
+            if (existingChats && existingChats.length > 0) {
+                if (existingChats.length > 1) {
+                    const disambiguationText = existingChats.map(c => {
+                        return `- ${c.id}${c.topic && ' - '}${c.topic} - ${c.createdDateTime && new Date(c.createdDateTime).toLocaleString()}`;
+                    }).join(os.EOL);
+                    throw new Error(`Multiple chat conversations with this topic found. Please disambiguate:${os.EOL}${disambiguationText}`);
+                }
+                else {
+                    return existingChats[0].id;
+                }
+            }
+            const chat = yield this.createConversation([currentUserEmail, ...userEmails]);
+            return chat.id;
+        });
+    }
+    getChatIdByName(chatName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const existingChats = yield this.findExistingGroupChatsByTopic(chatName);
+            if (!existingChats || existingChats.length === 0) {
+                throw new Error('No chat conversation was found with this name.');
+            }
+            if (existingChats.length === 1) {
+                return existingChats[0].id;
+            }
+            const disambiguationText = existingChats.map(c => {
+                const memberstring = c.members.map(m => m.email).join(', ');
+                return `- ${c.id} - ${c.createdDateTime && new Date(c.createdDateTime).toLocaleString()} - ${memberstring}`;
+            }).join(os.EOL);
+            throw new Error(`Multiple chat conversations with this topic found. Please disambiguate:${os.EOL}${disambiguationText}`);
+        });
+    }
+    // This Microsoft Graph API request throws an intermittent 404 exception, saying that it cannot find the principal.
+    // The same behavior occurs when creating the conversation through the Graph Explorer.
+    // It seems to happen when the userEmail casing does not match the casing of the actual UPN. 
+    // When the first request throws an error, the second request does succeed. 
+    // Therefore a retry-mechanism is implemented here. 
+    createConversation(memberEmails, retried = 0) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const jsonBody = {
+                    chatType: memberEmails.length > 2 ? 'group' : 'oneOnOne',
+                    members: memberEmails.map(email => {
+                        return {
+                            '@odata.type': '#microsoft.graph.aadUserConversationMember',
+                            roles: ['owner'],
+                            'user@odata.bind': `https://graph.microsoft.com/v1.0/users/${email}`
+                        };
+                    })
+                };
+                const requestOptions = {
+                    url: `${this.resource}/v1.0/chats`,
+                    headers: {
+                        accept: 'application/json;odata.metadata=none',
+                        'content-type': 'application/json;odata=nometadata'
+                    },
+                    responseType: 'json',
+                    data: jsonBody
+                };
+                return yield request_1.default.post(requestOptions);
+            }
+            catch (err) {
+                if (((_a = err.message) === null || _a === void 0 ? void 0 : _a.indexOf('404')) > -1 && retried < 4) {
+                    return yield this.createConversation(memberEmails, retried + 1);
+                }
+                throw err;
+            }
+        });
+    }
+    sendChatMessage(chatId, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = {
+                url: `${this.resource}/v1.0/chats/${chatId}/messages`,
+                headers: {
+                    accept: 'application/json;odata.metadata=none',
+                    'content-type': 'application/json;odata=nometadata'
+                },
+                responseType: 'json',
+                data: {
+                    body: {
+                        content: options.message
+                    }
+                }
+            };
+            yield request_1.default.post(requestOptions);
+        });
+    }
+    findExistingGroupChatsByMembers(expectedMemberEmails) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = `${this.resource}/v1.0/chats?$filter=chatType eq 'group'&$expand=members&$select=id,topic,createdDateTime,members`;
+            const foundChats = [];
+            const chats = yield this.getAllChats(endpoint, []);
+            for (const chat of chats) {
+                const chatMembers = chat.members;
+                if (chatMembers.length === expectedMemberEmails.length) {
+                    const chatMemberEmails = chatMembers.map(member => { var _a; return (_a = member.email) === null || _a === void 0 ? void 0 : _a.toLowerCase(); });
+                    if (expectedMemberEmails.every(email => chatMemberEmails.some(memberEmail => memberEmail === email))) {
+                        foundChats.push(chat);
+                    }
+                }
+            }
+            return foundChats;
+        });
+    }
+    findExistingGroupChatsByTopic(topic) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = `${this.resource}/v1.0/chats?$filter=topic eq '${encodeURIComponent(topic)}'&$expand=members&$select=id,topic,createdDateTime,chatType`;
+            const chats = yield this.getAllChats(endpoint, []);
+            return chats;
+        });
+    }
+    getAllChats(url, items) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = {
+                url: url,
+                headers: {
+                    accept: 'application/json;odata.metadata=none'
+                },
+                responseType: 'json'
+            };
+            const res = yield request_1.default.get(requestOptions);
+            items = items.concat(res.value);
+            if (res['@odata.nextLink']) {
+                return yield this.getAllChats(res['@odata.nextLink'], items);
+            }
+            else {
+                return items;
+            }
+        });
+    }
+}
+module.exports = new TeamsChatMessageSendCommand();
+//# sourceMappingURL=chat-message-send.js.map

package/dist/m365/teams/commands.js

@@ -16,6 +16,7 @@ exports.default = {
     CHAT_LIST: `${prefix} chat list`,
     CHAT_MEMBER_LIST: `${prefix} chat member list`,
     CHAT_MESSAGE_LIST: `${prefix} chat message list`,
+    CHAT_MESSAGE_SEND: `${prefix} chat message send`,
     CONVERSATIONMEMBER_ADD: `${prefix} conversationmember add`,
     CONVERSATIONMEMBER_LIST: `${prefix} conversationmember list`,
     FUNSETTINGS_LIST: `${prefix} funsettings list`,

package/docs/docs/cmd/aad/app/app-delete.md

@@ -0,0 +1,51 @@
+# aad app delete
+
+Removes an Azure AD app registration
+
+## Usage
+
+```sh
+m365 aad app delete [options]
+```
+
+## Options
+
+`--appId [appId]`
+: Application (client) ID of the Azure AD application registration to remove. Specify either `appId`, `objectId` or `name`
+
+`--objectId [objectId]`
+: Object ID of the Azure AD application registration to remove. Specify either `appId`, `objectId` or `name`
+
+`--name [name]`
+: Name of the Azure AD application registration to remove. Specify either `appId`, `objectId` or `name`
+
+`--confirm`:
+: Don't prompt for confirmation to delete the app
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+For best performance use the `objectId` option to reference the Azure AD application registration to delete. If you use `appId` or `name`, this command will first need to find the corresponding object ID for that application.
+
+If the command finds multiple Azure AD application registrations with the specified app name, it will prompt you to disambiguate which app it should use, listing the discovered object IDs.
+
+## Examples
+
+Delete the Azure AD application registration by its app (client) ID
+
+```sh
+m365 aad app delete --appId d75be2e1-0204-4f95-857d-51a37cf40be8
+```
+
+Delete the Azure AD application registration by its object ID
+
+```sh
+m365 aad app delete --objectId d75be2e1-0204-4f95-857d-51a37cf40be8
+```
+
+Delete the Azure AD application registration by its name. Will NOT prompt for confirmation before deleting.
+
+```sh
+m365 aad app delete --name "My app" --confirm
+```

package/docs/docs/cmd/aad/app/app-get.md

@@ -19,14 +19,19 @@ m365 aad app get [options]
 `--name [name]`
 : Name of the Azure AD application registration to get. Specify either `appId`, `objectId` or `name`
 
+`--save`
+: Use to store the information about the created app in a local file
+
 --8<-- "docs/cmd/_global.md"
 
 ## Remarks
 
-For best performance use the `objectId` option to reference the Azure AD application registration to update. If you use `appId` or `name`, this command will first need to find the corresponding object ID for that application.
+For best performance use the `objectId` option to reference the Azure AD application registration to get. If you use `appId` or `name`, this command will first need to find the corresponding object ID for that application.
 
 If the command finds multiple Azure AD application registrations with the specified app name, it will prompt you to disambiguate which app it should use, listing the discovered object IDs.
 
+If you want to store the information about the Azure AD app registration, use the `--save` option. This is useful when you build solutions connected to Microsoft 365 and want to easily manage app registrations used with your solution. When you use the `--save` option, after you get the app registration, the command will write its ID and name to the `.m365rc.json` file in the current directory. If the file already exists, it will add the information about the App registration to it if it's not already present, allowing you to track multiple apps. If the file doesn't exist, the command will create it.
+
 ## Examples
 
 Get the Azure AD application registration by its app (client) ID
@@ -46,3 +51,9 @@ Get the Azure AD application registration by its name
 ```sh
 m365 aad app get --name "My app"
 ```
+
+Get the Azure AD application registration by its name. Store information about the retrieved app registration in the _.m365rc.json_ file in the current directory.
+
+```sh
+m365 aad app get --name "My app" --save
+```

package/docs/docs/cmd/aad/app/app-set.md

@@ -22,6 +22,15 @@ m365 aad app set [options]
 `-u, --uri [uri]`
 : Application ID URI to update
 
+`-r, --redirectUris [redirectUris]`
+: Comma-separated list of redirect URIs to add to the app registration. Requires `platform` to be specified
+
+`-p, --platform [platform]`
+: Platform for which the `redirectUri` should be configured. Allowed values `spa,web,publicClient`
+
+`--redirectUrisToRemove [redirectUrisToRemove]`
+: Comma-separated list of existing redirect URIs to remove. Specify, when you want to replace existing redirect URIs with another
+
 --8<-- "docs/cmd/_global.md"
 
 ## Remarks
@@ -49,3 +58,15 @@ Update the app URI of the Azure AD application registration specified by its nam
 ```sh
 m365 aad app set --name "My app" --uri https://contoso.com/e75be2e1-0204-4f95-857d-51a37cf40be8
 ```
+
+Add a new redirect URI for SPA authentication
+
+```sh
+m365 aad app set --objectId 95cfe30d-ed44-4f9d-b73d-c66560f72e83 --redirectUris https://contoso.com/auth --platform spa
+```
+
+Replace one redirect URI with another for SPA authentication
+
+```sh
+m365 aad app set --objectId 95cfe30d-ed44-4f9d-b73d-c66560f72e83 --redirectUris https://contoso.com/auth --platform spa --redirectUrisToRemove https://contoso.com/old-auth
+```

package/docs/docs/cmd/aad/group/group-list.md

@@ -10,6 +10,9 @@ m365 aad group list [options]
 
 ## Options
 
+`-d, --deleted`
+: Use to retrieve deleted groups
+
 --8<-- "docs/cmd/_global.md"
 
 ## Examples
@@ -18,4 +21,10 @@ Lists all groups defined in Azure Active Directory.
 
 ```sh
 m365 aad group list
+```
+
+List all recently deleted groups in the tenant
+
+```sh
+m365 aad group list --deleted
 ```

package/docs/docs/cmd/aad/o365group/o365group-conversation-list.md

@@ -0,0 +1,24 @@
+# aad o365group conversation list
+
+Lists conversations for the specified Microsoft 365 group
+
+## Usage
+
+```sh
+m365 aad o365group conversation list [options]
+```
+
+## Options
+
+`-i, --groupId <groupId>`
+: The ID of the Microsoft 365 group
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Lists conversations for the specified Microsoft 365 group
+
+```sh
+m365 aad o365group conversation list --groupId '00000000-0000-0000-0000-000000000000'
+```

package/docs/docs/cmd/outlook/room/room-list.md

@@ -0,0 +1,30 @@
+# outlook room list
+
+Get a collection of all available rooms
+
+## Usage
+
+```sh
+m365 outlook room list [options]
+```
+
+## Options
+
+`--roomlistEmail [roomlistEmail]`
+: Use to filter returned rooms by their roomlist email (eg. bldg2@contoso.com)
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get all the rooms
+
+```sh
+m365 outlook room list
+```
+
+Get all the rooms of specified roomlist e-mail address
+
+```sh
+m365 outlook room list --roomlistEmail "bldg2@contoso.com"
+```

package/docs/docs/cmd/outlook/roomlist/roomlist-list.md

@@ -0,0 +1,21 @@
+# outlook roomlist list
+
+Get a collection of available roomlists
+
+## Usage
+
+```sh
+m365 outlook roomlist list [options]
+```
+
+## Options
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get all roomlists in your tenant
+
+```sh
+m365 outlook roomlist list
+```

package/docs/docs/cmd/planner/task/task-get.md

@@ -15,6 +15,11 @@ m365 planner task get [options]
 
 --8<-- "docs/cmd/_global.md"
 
+## Remarks
+
+!!! attention
+    This command uses an API that is currently in preview to enrich the results with the `priority` field. Keep in mind that this preview API is subject to change once the API reached general availability.
+
 ## Examples
 
 Retrieve the the specified planner task

package/docs/docs/cmd/planner/task/task-list.md

@@ -30,6 +30,11 @@ m365 planner task list [options]
 
 --8<-- "docs/cmd/_global.md"
 
+## Remarks
+
+!!! attention
+    This command uses API that is currently in preview to enrich the results with the `priority` field. Keep in mind that this preview API is subject to change once the API reached general availability.
+
 ## Examples
 
 List tasks for the currently logged in user

package/docs/docs/cmd/search/externalconnection/externalconnection-add.md

@@ -30,14 +30,14 @@ The `id` must be at least 3 and no more than 32 characters long. It can contain
 
 ## Examples
 
-Adds a new external connection with name and description of test
+Adds a new external connection with name and description of test app
 
 ```sh
-m365 search externalconnection add --id MyApp --name "My application" --description "Description of your application"
+m365 search externalconnection add --id MyApp --name "Test" --description "Test"
 ```
 
 Adds a new external connection with a limited number of authorized apps
 
 ```sh
-m365 search externalconnection add --id MyApp --name "My application" --description "Description of your application" --authorizedAppIds  "00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002"
+m365 search externalconnection add --id MyApp --name "Test" --description "Test" --authorizedAppIds  "00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002"
 ```

package/docs/docs/cmd/spo/group/group-user-add.md

@@ -27,6 +27,10 @@ m365 spo group user add [options]
 
 --8<-- "docs/cmd/_global.md"
 
+## Remarks
+
+For the `--userName` or `--email` options you can specify multiple values by separating them with a comma. If one of the specified entries is not valid, the command will fail with an error message showing the list invalid values.
+
 ## Examples
 
 Add a user with name _Alex.Wilber@contoso.com_ to the SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_

package/docs/docs/cmd/teams/app/app-install.md

@@ -1,6 +1,6 @@
 # teams app install
 
-Installs an app from the catalog to a Microsoft Teams team
+Installs a Microsoft Teams team app from the catalog in the specified team or for the specified user
 
 ## Usage
 
@@ -13,14 +13,20 @@ m365 teams app install [options]
 `--appId <appId>`
 : The ID of the app to install
 
-`--teamId <teamId>`
+`--teamId [teamId]`
 : The ID of the Microsoft Teams team to which to install the app
 
+`--userId [userId]`
+: The ID of the user for who to install the app. Specify either `userId` or `userName` to install a personal app for a user.
+
+`--userName [userName]`
+: The UPN of the user for who to install the app. Specify either `userId` or `userName` to install a personal app for a user.
+
 --8<-- "docs/cmd/_global.md"
 
 ## Remarks
 
-The `appId` has to be the ID of the app from the Microsoft Teams App Catalog. Do not use the ID from the manifest of the zip app package. Use the [teams app list](./app-list.md) command to get this ID.
+The `appId` has to be the ID of the app from the Microsoft Teams App Catalog. Do not use the ID from the manifest of the zip app package. Use the [teams app list](./app-list.md) command to get this ID instead.
 
 ## Examples
 
@@ -28,4 +34,16 @@ Install an app from the catalog in a Microsoft Teams team
 
 ```sh
 m365 teams app install --appId 4440558e-8c73-4597-abc7-3644a64c4bce --teamId 2609af39-7775-4f94-a3dc-0dd67657e900
-```
+```
+
+Install a personal app for the user specified using their user name
+
+```sh
+m365 teams app install --appId 4440558e-8c73-4597-abc7-3644a64c4bce --userName steve@contoso.com
+```
+
+Install a personal app for the user specified using their ID
+
+```sh
+m365 teams app install --appId 4440558e-8c73-4597-abc7-3644a64c4bce --userId 2609af39-7775-4f94-a3dc-0dd67657e900
+```

package/docs/docs/cmd/teams/channel/channel-get.md

@@ -22,6 +22,9 @@ m365 teams channel get [options]
 `--channelName [channelName]`
 : The display name of the channel for which to retrieve more information. Specify either channelId or channelName but not both
 
+`--primary`
+: Gets the default channel, General, of a team. If specified, channelId or channelName are not needed
+
 --8<-- "docs/cmd/_global.md"
 
 ## Examples
@@ -36,4 +39,10 @@ Get information about Microsoft Teams team channel with name _Channel Name_
 
 ```sh
 m365 teams channel get --teamName "Team Name" --channelName "Channel Name"
-```
+```
+
+Get information about Microsoft Teams team primary channel , i.e. General
+
+```sh
+m365 teams channel get --teamName "Team Name" --primary
+```

package/docs/docs/cmd/teams/chat/chat-message-send.md

@@ -0,0 +1,55 @@
+# teams chat message send
+
+Sends a chat message to a Microsoft Teams chat conversation.
+
+## Usage
+
+```sh
+m365 teams chat message send [options]
+```
+
+## Options
+
+`--chatId [chatId]`
+: The ID of the chat conversation. Specify either `chatId`, `chatName` or `userEmails`, but not multiple.
+
+`--chatName [chatName]`
+: The display name of the chat conversation. Specify either `chatId`, `chatName` or `userEmails`, but not multiple.
+
+`-e, --userEmails [userEmails]`
+: A comma-separated list of one or more e-mail addresses. Specify either `chatId`, `chatName` or `userEmails`, but not multiple.
+
+`-m, --message <message>`
+: The message to send
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+A new chat conversation will be created if no existing conversation with the participants specified with emails is found.
+
+## Examples
+
+Send a message to a Microsoft Teams chat conversation by id
+
+```sh
+m365 teams chat message send --chatId 19:2da4c29f6d7041eca70b638b43d45437@thread.v2
+```
+
+Send a message to a single person
+
+```sh
+m365 teams chat message send --userEmails alexw@contoso.com
+```
+
+Send a message to a group of people
+
+```sh
+m365 teams chat message send --userEmails alexw@contoso.com,meganb@contoso.com
+```
+
+Send a message to a chat conversation finding it by display name
+
+```sh
+m365 teams chat message send --chatName "Just a conversation"
+```