@pnp/cli-microsoft365 5.2.0-beta.0f1c454 → 5.2.0-beta.90d2227

package/dist/cli/Cli.js

@@ -586,23 +586,7 @@ class Cli {
         helpFilePath = path.join(...pathChunks);
         if (fs.existsSync(helpFilePath)) {
             Cli.log();
-            // because of prism, loading markshell slows down CLI a lot
-            // let's lazy-load it only when it's needed (help was requested)
-            const markshell = require('markshell');
-            const chalk = require('chalk');
-            const theme = markshell.getTheme();
-            const admonitionStyles = theme.admonitions.getStyles();
-            admonitionStyles.indent.beforeIndent = 0;
-            admonitionStyles.indent.titleIndent = 3;
-            admonitionStyles.indent.afterIndent = 0;
-            theme.admonitions.setStyles(admonitionStyles);
-            theme.indents.definitionList = 2;
-            theme.headline = chalk.white;
-            theme.inlineCode = chalk.cyan;
-            theme.sourceCodeTheme = 'solarizelight';
-            theme.includePath = path.join(this.commandsFolder, '..', '..', 'docs');
-            markshell.setTheme(theme);
-            Cli.log(markshell.toRawContent(helpFilePath));
+            Cli.log(utils_1.md.md2plain(fs.readFileSync(helpFilePath, 'utf8'), path.join(this.commandsFolder, '..', '..', 'docs')));
         }
     }
     printAvailableCommands() {

package/dist/m365/spo/commands/tenant/tenant-recyclebinitem-restore.js

@@ -1,6 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const config_1 = require("../../../../config");
 const request_1 = require("../../../../request");
 const utils_1 = require("../../../../utils");
 const SpoCommand_1 = require("../../../base/SpoCommand");
@@ -18,58 +17,25 @@ class SpoTenantRecycleBinItemRestoreCommand extends SpoCommand_1.default {
         return telemetryProps;
     }
     commandAction(logger, args, cb) {
-        this.dots = '';
         utils_1.spo
             .getSpoAdminUrl(logger, this.debug)
             .then((adminUrl) => {
-            this.spoAdminUrl = adminUrl;
-            return utils_1.spo.ensureFormDigest(this.spoAdminUrl, logger, this.context, this.debug);
-        })
-            .then((res) => {
-            this.context = res;
-            if (this.verbose) {
-                logger.logToStderr(`Restoring deleted site collection ${args.options.url}...`);
-            }
             const requestOptions = {
-                url: `${this.spoAdminUrl}/_vti_bin/client.svc/ProcessQuery`,
+                url: `${adminUrl}/_api/SPOInternalUseOnly.Tenant/RestoreDeletedSite`,
                 headers: {
-                    'X-RequestDigest': this.context.FormDigestValue
+                    accept: 'application/json;odata=nometadata',
+                    'content-type': 'application/json;charset=utf-8'
                 },
-                data: `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config_1.default.applicationName}" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009"><Actions><ObjectPath Id="2" ObjectPathId="1" /><ObjectPath Id="4" ObjectPathId="3" /><Query Id="5" ObjectPathId="3"><Query SelectAllProperties="false"><Properties><Property Name="PollingInterval" ScalarProperty="true" /><Property Name="IsComplete" ScalarProperty="true" /></Properties></Query></Query></Actions><ObjectPaths><Constructor Id="1" TypeId="{268004ae-ef6b-4e9b-8425-127220d84719}" /><Method Id="3" ParentId="1" Name="RestoreDeletedSite"><Parameters><Parameter Type="String">${utils_1.formatting.escapeXml(args.options.url)}</Parameter></Parameters></Method></ObjectPaths></Request>`
+                data: {
+                    siteUrl: args.options.url
+                }
             };
             return request_1.default.post(requestOptions);
         })
-            .then((res) => {
-            return new Promise((resolve, reject) => {
-                const json = JSON.parse(res);
-                const response = json[0];
-                if (response.ErrorInfo) {
-                    reject(response.ErrorInfo.ErrorMessage);
-                }
-                else {
-                    const operation = json[json.length - 1];
-                    const isComplete = operation.IsComplete;
-                    if (!args.options.wait || isComplete) {
-                        resolve();
-                        return;
-                    }
-                    setTimeout(() => {
-                        utils_1.spo.waitUntilFinished({
-                            operationId: JSON.stringify(operation._ObjectIdentity_),
-                            siteUrl: this.spoAdminUrl,
-                            resolve,
-                            reject,
-                            logger,
-                            currentContext: this.context,
-                            dots: this.dots,
-                            debug: this.debug,
-                            verbose: this.verbose
-                        });
-                    }, operation.PollingInterval);
-                }
-            });
-        })
-            .then(_ => cb(), (err) => this.handleRejectedPromise(err, logger, cb));
+            .then(res => {
+            logger.log(JSON.parse(res));
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
     }
     options() {
         const options = [

package/dist/m365/teams/commands/chat/chat-get.js

@@ -0,0 +1,143 @@
+"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 Auth_1 = require("../../../../Auth");
+const os = require("os");
+const request_1 = require("../../../../request");
+const GraphCommand_1 = require("../../../base/GraphCommand");
+const commands_1 = require("../../commands");
+const validation_1 = require("../../../../utils/validation");
+const accessToken_1 = require("../../../../utils/accessToken");
+const chatUtil_1 = require("./chatUtil");
+class TeamsChatGetCommand extends GraphCommand_1.default {
+    get name() {
+        return commands_1.default.CHAT_GET;
+    }
+    get description() {
+        return 'Get a Microsoft Teams chat conversation by id, participants or chat name.';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.id = typeof args.options.id !== 'undefined';
+        telemetryProps.participants = typeof args.options.participants !== 'undefined';
+        telemetryProps.name = typeof args.options.name !== 'undefined';
+        return telemetryProps;
+    }
+    commandAction(logger, args, cb) {
+        this
+            .getChatId(logger, args)
+            .then(chatId => this.getChatDetailsById(chatId))
+            .then((chat) => {
+            logger.log(chat);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    options() {
+        const options = [
+            {
+                option: '-i, --id [id]'
+            },
+            {
+                option: '-p, --participants [participants]'
+            },
+            {
+                option: '-n, --name [name]'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        if (!args.options.id && !args.options.participants && !args.options.name) {
+            return 'Specify id or participants or name, one is required.';
+        }
+        let nrOfMutuallyExclusiveOptionsInUse = 0;
+        if (args.options.id) {
+            nrOfMutuallyExclusiveOptionsInUse++;
+        }
+        if (args.options.participants) {
+            nrOfMutuallyExclusiveOptionsInUse++;
+        }
+        if (args.options.name) {
+            nrOfMutuallyExclusiveOptionsInUse++;
+        }
+        if (nrOfMutuallyExclusiveOptionsInUse > 1) {
+            return 'Specify either id or participants or name, but not multiple.';
+        }
+        if (args.options.id && !validation_1.validation.isValidTeamsChatId(args.options.id)) {
+            return `${args.options.id} is not a valid Teams ChatId.`;
+        }
+        if (args.options.participants) {
+            const participants = chatUtil_1.chatUtil.convertParticipantStringToArray(args.options.participants);
+            if (!participants || participants.length === 0 || participants.some(e => !validation_1.validation.isValidUserPrincipalName(e))) {
+                return `${args.options.participants} contains one or more invalid email addresses.`;
+            }
+        }
+        return true;
+    }
+    getChatId(logger, args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (args.options.id) {
+                return args.options.id;
+            }
+            return args.options.participants
+                ? this.getChatIdByParticipants(args.options.participants, logger)
+                : this.getChatIdByName(args.options.name, logger);
+        });
+    }
+    getChatDetailsById(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = {
+                url: `${this.resource}/v1.0/chats/${encodeURIComponent(id)}`,
+                headers: {
+                    accept: 'application/json;odata.metadata=none'
+                },
+                responseType: 'json'
+            };
+            return request_1.default.get(requestOptions);
+        });
+    }
+    getChatIdByParticipants(participantsString, logger) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const participants = chatUtil_1.chatUtil.convertParticipantStringToArray(participantsString);
+            const currentUserEmail = accessToken_1.accessToken.getUserNameFromAccessToken(Auth_1.default.service.accessTokens[this.resource].accessToken).toLowerCase();
+            const existingChats = yield chatUtil_1.chatUtil.findExistingChatsByParticipants([currentUserEmail, ...participants], logger);
+            if (!existingChats || existingChats.length === 0) {
+                throw new Error('No chat conversation was found with these participants.');
+            }
+            if (existingChats.length === 1) {
+                return existingChats[0].id;
+            }
+            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 these participants found. Please disambiguate:${os.EOL}${disambiguationText}`);
+        });
+    }
+    getChatIdByName(name, logger) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const existingChats = yield chatUtil_1.chatUtil.findExistingGroupChatsByName(name, logger);
+            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 name found. Please disambiguate:${os.EOL}${disambiguationText}`);
+        });
+    }
+}
+module.exports = new TeamsChatGetCommand();
+//# sourceMappingURL=chat-get.js.map

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

@@ -15,6 +15,7 @@ const request_1 = require("../../../../request");
 const utils_1 = require("../../../../utils");
 const GraphCommand_1 = require("../../../base/GraphCommand");
 const commands_1 = require("../../commands");
+const chatUtil_1 = require("./chatUtil");
 class TeamsChatMessageSendCommand extends GraphCommand_1.default {
     get name() {
         return commands_1.default.CHAT_MESSAGE_SEND;
@@ -79,7 +80,7 @@ class TeamsChatMessageSendCommand extends GraphCommand_1.default {
             return `${args.options.chatId} is not a valid Teams ChatId.`;
         }
         if (args.options.userEmails) {
-            const userEmails = this.convertCommaSeparatedListToArray(args.options.userEmails);
+            const userEmails = chatUtil_1.chatUtil.convertParticipantStringToArray(args.options.userEmails);
             if (!userEmails || userEmails.length === 0 || userEmails.some(e => !utils_1.validation.isValidUserPrincipalName(e))) {
                 return `${args.options.userEmails} contains one or more invalid email addresses.`;
             }
@@ -98,9 +99,9 @@ class TeamsChatMessageSendCommand extends GraphCommand_1.default {
     }
     ensureChatIdByUserEmails(userEmailsOption, logger) {
         return __awaiter(this, void 0, void 0, function* () {
-            const userEmails = this.convertCommaSeparatedListToArray(userEmailsOption);
+            const userEmails = chatUtil_1.chatUtil.convertParticipantStringToArray(userEmailsOption);
             const currentUserEmail = utils_1.accessToken.getUserNameFromAccessToken(Auth_1.default.service.accessTokens[this.resource].accessToken).toLowerCase();
-            const existingChats = yield this.findExistingGroupChatsByMembers([currentUserEmail, ...userEmails], logger);
+            const existingChats = yield chatUtil_1.chatUtil.findExistingChatsByParticipants([currentUserEmail, ...userEmails], logger);
             if (!existingChats || existingChats.length === 0) {
                 const chat = yield this.createConversation([currentUserEmail, ...userEmails]);
                 return chat.id;
@@ -116,7 +117,7 @@ class TeamsChatMessageSendCommand extends GraphCommand_1.default {
     }
     getChatIdByName(chatName, logger) {
         return __awaiter(this, void 0, void 0, function* () {
-            const existingChats = yield this.findExistingGroupChatsByName(chatName, logger);
+            const existingChats = yield chatUtil_1.chatUtil.findExistingGroupChatsByName(chatName, logger);
             if (!existingChats || existingChats.length === 0) {
                 throw new Error('No chat conversation was found with this name.');
             }
@@ -186,32 +187,6 @@ class TeamsChatMessageSendCommand extends GraphCommand_1.default {
             yield request_1.default.post(requestOptions);
         });
     }
-    findExistingGroupChatsByMembers(expectedMemberEmails, logger) {
-        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 utils_1.odata.getAllItems(endpoint, logger);
-            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;
-        });
-    }
-    findExistingGroupChatsByName(name, logger) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const endpoint = `${this.resource}/v1.0/chats?$filter=topic eq '${encodeURIComponent(name)}'&$expand=members&$select=id,topic,createdDateTime,chatType`;
-            return utils_1.odata.getAllItems(endpoint, logger);
-        });
-    }
-    convertCommaSeparatedListToArray(userEmailsString) {
-        return userEmailsString.toLowerCase().replace(/\s/g, '').split(',').filter(e => e && e !== '');
-    }
 }
 module.exports = new TeamsChatMessageSendCommand();
 //# sourceMappingURL=chat-message-send.js.map

package/dist/m365/teams/commands/chat/chatUtil.js

@@ -0,0 +1,62 @@
+"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 });
+exports.chatUtil = void 0;
+const odata_1 = require("../../../../utils/odata");
+exports.chatUtil = {
+    /**
+     * Finds existing Microsoft Teams chats by participants, using the Microsoft Graph
+     * @param expectedMemberEmails a string array of participant emailaddresses
+     * @param logger a logger to pipe into the graph request odata helper.
+     */
+    findExistingChatsByParticipants(expectedMemberEmails, logger) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const chatType = expectedMemberEmails.length === 2 ? 'oneOnOne' : 'group';
+            const endpoint = `https://graph.microsoft.com/v1.0/chats?$filter=chatType eq '${chatType}'&$expand=members&$select=id,topic,createdDateTime,members`;
+            const foundChats = [];
+            const chats = yield odata_1.odata.getAllItems(endpoint, logger);
+            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;
+        });
+    },
+    /**
+     * Finds existing Microsoft Teams chats by name, using the Microsoft Graph
+     * @param name the name of the chat conversation to find
+     * @param logger a logger to pipe into the graph request odata helper.
+     */
+    findExistingGroupChatsByName(name, logger) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = `https://graph.microsoft.com/v1.0/chats?$filter=topic eq '${encodeURIComponent(name).replace("'", "''")}'&$expand=members&$select=id,topic,createdDateTime,chatType`;
+            return odata_1.odata.getAllItems(endpoint, logger);
+        });
+    },
+    /**
+     * Converts a comma or space separated string into an array.
+     * @param value the string to convert
+     */
+    convertParticipantStringToArray(value) {
+        if (value.indexOf(',') === -1) {
+            return value.trim().toLowerCase().split(' ').filter(e => e && e !== '');
+        }
+        else {
+            return value.trim().toLowerCase().split(',').filter(e => e && e !== '');
+        }
+    }
+};
+//# sourceMappingURL=chatUtil.js.map

package/dist/m365/teams/commands.js

@@ -13,6 +13,7 @@ exports.default = {
     CHANNEL_LIST: `${prefix} channel list`,
     CHANNEL_REMOVE: `${prefix} channel remove`,
     CHANNEL_SET: `${prefix} channel set`,
+    CHAT_GET: `${prefix} chat get`,
     CHAT_LIST: `${prefix} chat list`,
     CHAT_MEMBER_LIST: `${prefix} chat member list`,
     CHAT_MESSAGE_LIST: `${prefix} chat message list`,

package/dist/utils/index.js

@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./accessToken"), exports);
 __exportStar(require("./formatting"), exports);
 __exportStar(require("./fsUtil"), exports);
+__exportStar(require("./md"), exports);
 __exportStar(require("./odata"), exports);
 __exportStar(require("./packageManager"), exports);
 __exportStar(require("./sinonUtil"), exports);

package/dist/utils/md.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.md = void 0;
+const fs = require("fs");
+const os_1 = require("os");
+const path = require("path");
+function convertTitle(md) {
+    return md.replace(/^#\s+(.*)/gm, (match, title) => {
+        return title.toLocaleUpperCase() + os_1.EOL + Array(title.length + 1).join('=');
+    });
+}
+function convertHeadings(md) {
+    return md.replace(/^(#+)\s+(.*)/gm, (match, level, content) => {
+        return `${os_1.EOL}${content.toLocaleUpperCase()}`;
+    });
+}
+function convertAdmonitions(md) {
+    const regex = new RegExp('^!!!\\s(.*)' + os_1.EOL + '\\s+', 'gm');
+    return md.replace(regex, (match, content) => {
+        return content.toLocaleUpperCase() + os_1.EOL + os_1.EOL;
+    });
+}
+function includeContent(md, rootFolder) {
+    return md.replace(/^--8<-- "([^"]+)"/gm, (match, filePath) => {
+        return fs.readFileSync(path.join(rootFolder, filePath), 'utf8');
+    });
+}
+function convertDd(md) {
+    return md.replace(/^:\s(.*)/gm, (match, content) => {
+        return `  ${content}`;
+    });
+}
+function convertHyperlinks(md) {
+    return md.replace(/\[([^\]]+)\]\(([^\)]+)\)/gm, (match, label, url) => {
+        // if the link is the same as the content, return just the link
+        if (label === url) {
+            return url;
+        }
+        // if the link is relative, remove it because there's no way to open it
+        // from the terminal anyway. In the future, we could convert it to the
+        // actual link of the docs.
+        if (!url.startsWith('http:') && !url.startsWith('https:')) {
+            return label;
+        }
+        return `${label} (${url})`;
+    });
+}
+function convertCodeFences(md) {
+    const regex = new RegExp('^```.*?' + os_1.EOL + '(.*?)```' + os_1.EOL, 'gms');
+    return md.replace(regex, (match, code) => {
+        return `  ${code}${os_1.EOL}`;
+    });
+}
+function removeInlineMarkup(md) {
+    // from https://stackoverflow.com/a/70064453
+    return md.replace(/(?<marks>[`]|\*{1,3}|_{1,3}|~{2})(?<inmarks>.*?)\1/g, '$<inmarks>$<link_text>');
+}
+function removeTooManyEmptyLines(md) {
+    const regex = new RegExp('(' + os_1.EOL + '){4,}', 'g');
+    return md.replace(regex, Array(4).join(os_1.EOL));
+}
+const convertFunctions = [
+    convertTitle,
+    convertHeadings,
+    convertAdmonitions,
+    convertDd,
+    convertHyperlinks,
+    convertCodeFences,
+    removeInlineMarkup,
+    removeTooManyEmptyLines
+];
+exports.md = {
+    md2plain(md, rootFolderDocs) {
+        md = includeContent(md, rootFolderDocs);
+        convertFunctions.forEach(convert => {
+            md = convert(md);
+        });
+        return md;
+    }
+};
+//# sourceMappingURL=md.js.map

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

@@ -0,0 +1,53 @@
+# teams chat get
+
+Get a Microsoft Teams chat conversation by id, participants or chat name.
+
+## Usage
+
+```sh
+m365 teams chat get [options]
+```
+
+## Options
+
+`-i, --id [id]`
+: The ID of the chat conversation. Specify either `id`, `name` or `participants`, but not multiple.
+
+`-n, --name [name]`
+: The display name of the chat conversation. Specify either `id`, `name` or `participants`, but not multiple.
+
+`-p, --participants [participants]`
+: A comma-separated list of one or more e-mail addresses. Specify either `id`, `name` or `participants`, but not multiple.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+The output will not include the chat conversation members or messages. It will just retrieve the conversation details.
+When using the `participants` option, the signed-in user will automatically be included as a participant. There's no need to add it to the list manually.
+
+## Examples
+
+Get a Microsoft Teams chat conversation by id
+
+```sh
+m365 teams chat get --id 19:2da4c29f6d7041eca70b638b43d45437@thread.v2
+```
+
+Get a Microsoft Teams one on one chat conversation, finding it by participant.
+
+```sh
+m365 teams chat get --participants alexw@contoso.com
+```
+
+Get a Microsoft Teams group chat conversation, finding it by participants.
+
+```sh
+m365 teams chat get --participants alexw@contoso.com,meganb@contoso.com
+```
+
+Get a Microsoft Teams chat conversation, finding it by display name
+
+```sh
+m365 teams chat get --name "Just a conversation"
+```