@pnp/cli-microsoft365 6.8.0-beta.e41be56 → 6.8.0

package/.eslintrc.js

@@ -66,6 +66,7 @@ const dictionary = [
   'o365',
   'permission',
   'place',
+  'policy',
   'property',
   'records',
   'recycle',
@@ -73,6 +74,7 @@ const dictionary = [
   'role',
   'room',
   'schema',
+  'sensitivity',
   'service',
   'set',
   'setting',

package/.mocharc.json

@@ -3,6 +3,7 @@
     "ts"
   ],
   "spec": "dist/**/*.spec.js",
+  "reporter": "min",
   "require": "source-map-support/register",
   "watch": "dist/**/*.js",
   "timeout": 10000,

package/README.md

@@ -74,15 +74,20 @@
   - Access all your Microsoft 365 workloads
 - Supported workloads
   - Azure Active Directory
+  - Bookings
   - Microsoft Teams
   - Microsoft To Do
   - OneDrive
+  - OneNote
   - Outlook
   - Planner
   - Power Automate
   - Power Apps
+  - Power Platform
+  - Purview
   - Skype for Business
   - SharePoint Online
+  - To Do
   - Yammer
 - Supported authentication methods
   - Azure Managed Identity
@@ -98,7 +103,7 @@
 
 ## Install
 
-To install this CLI, you will need [`node`](https://nodejs.org) `>= 8.0.0` installed.
+To use the CLI for Microsoft 365 you need [`Node.js`](https://nodejs.org). The CLI has been tested with Node.js versions 18 and higher, but we recommend you to use the Node.js LTS version available at the moment.
 
 ```
 npm install -g @pnp/cli-microsoft365

package/dist/Command.js

@@ -420,6 +420,12 @@ class Command {
                 return;
             }
             const lowerCaseValue = value.toLowerCase().trim();
+            if (lowerCaseValue === '@meid' || lowerCaseValue === '@meusername') {
+                const isAppOnlyAccessToken = accessToken_1.accessToken.isAppOnlyAccessToken(Auth_1.default.service.accessTokens[Auth_1.default.defaultResource].accessToken);
+                if (isAppOnlyAccessToken) {
+                    throw `It's not possible to use ${value} with application permissions`;
+                }
+            }
             if (lowerCaseValue === '@meid') {
                 args.options[option] = accessToken_1.accessToken.getUserIdFromAccessToken(token);
             }

package/dist/chili/chili.js

@@ -0,0 +1,298 @@
+"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.chili = void 0;
+const fs = require("fs");
+const inquirer = require("inquirer");
+const ora = require("ora");
+const path = require("path");
+const Cli_1 = require("../cli/Cli");
+const request_1 = require("../request");
+const settingsNames_1 = require("../settingsNames");
+const md_1 = require("../utils/md");
+const mendableApiKey = 'd3313d54-6f8e-40e0-90d3-4095019d4be7';
+let showHelp = false;
+let debug = false;
+let promptForRating = true;
+let conversationId = 0;
+let initialPrompt = '';
+let history = [];
+const cli = Cli_1.Cli.getInstance();
+const showSpinner = cli.getSettingWithDefaultValue(settingsNames_1.settingsNames.showSpinner, true) && typeof global.it === 'undefined';
+request_1.default.logger = {
+    /* c8 ignore next 3 */
+    log: (msg) => console.log(msg),
+    logRaw: (msg) => console.log(msg),
+    logToStderr: (msg) => console.error(msg)
+};
+request_1.default.debug = debug;
+function getPromptFromArgs(args) {
+    showHelp = args.indexOf('--help') > -1 || args.indexOf('-h') > -1;
+    if (showHelp) {
+        const commandsFolder = path.join(__dirname, '..', 'm365');
+        const pathChunks = [commandsFolder, '..', '..', 'docs', 'docs', 'user-guide', 'chili.md'];
+        const helpFilePath = path.join(...pathChunks);
+        if (fs.existsSync(helpFilePath)) {
+            let helpContents = fs.readFileSync(helpFilePath, 'utf8');
+            helpContents = md_1.md.md2plain(helpContents, path.join(commandsFolder, '..', '..', 'docs'));
+            console.log(helpContents);
+            return '';
+        }
+        else {
+            console.error('Help file not found');
+            return '';
+        }
+    }
+    else {
+        // reset to default. needed for tests
+        showHelp = false;
+    }
+    const debugPos = args.indexOf('--debug');
+    if (debugPos > -1) {
+        debug = true;
+        request_1.default.debug = true;
+        args.splice(debugPos, 1);
+    }
+    else {
+        // reset to default. needed for tests
+        debug = false;
+    }
+    const noRatingPos = args.indexOf('--no-rating');
+    if (noRatingPos > -1) {
+        promptForRating = false;
+        args.splice(noRatingPos, 1);
+    }
+    else {
+        // reset to default. needed for tests
+        promptForRating = true;
+    }
+    return args.join(' ');
+}
+function startConversation(args) {
+    return __awaiter(this, void 0, void 0, function* () {
+        history = [];
+        initialPrompt = getPromptFromArgs(args);
+        if (showHelp) {
+            return;
+        }
+        conversationId = yield getConversationId();
+        if (!initialPrompt) {
+            initialPrompt = yield promptForPrompt();
+        }
+        yield runConversationTurn(conversationId, initialPrompt);
+    });
+}
+function promptForPrompt() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const answer = yield inquirer.prompt([{
+                type: 'input',
+                name: 'prompt',
+                message: '🌶️  How can I help you?'
+            }]);
+        return answer.prompt;
+    });
+}
+function runConversationTurn(conversationId, question) {
+    return __awaiter(this, void 0, void 0, function* () {
+        console.log('');
+        const spinner = ora('Searching documentation...');
+        /* c8 ignore next 3 */
+        if (showSpinner) {
+            spinner.start();
+        }
+        const response = yield runMendableChat(conversationId, question);
+        history.push({
+            prompt: question,
+            response: response.answer.text
+        });
+        /* c8 ignore next 3 */
+        if (showSpinner) {
+            spinner.stop();
+        }
+        console.log(md_1.md.md2plain(response.answer.text, ''));
+        console.log('');
+        console.log('Source:');
+        // remove duplicates
+        const sources = response.sources.filter((src, index, self) => index === self.findIndex(s => s.link === src.link));
+        sources.forEach(src => console.log(`⬥ ${src.link}`));
+        console.log('');
+        if (promptForRating) {
+            try {
+                yield rateResponse(response.message_id);
+            }
+            catch (err) {
+                if (debug) {
+                    console.error(`An error has occurred while rating the response: ${err}`);
+                }
+            }
+            console.log('');
+        }
+        const result = yield inquirer.prompt([{
+                type: 'list',
+                name: 'chat',
+                message: 'What would you like to do next?',
+                choices: [
+                    {
+                        name: '📝 I want to know more',
+                        value: 'ask'
+                    },
+                    {
+                        name: '👋 I know enough. Thanks!',
+                        value: 'end'
+                    },
+                    {
+                        name: '🔄 I want to ask about something else',
+                        value: 'new'
+                    }
+                ]
+            }]);
+        switch (result.chat) {
+            case 'ask':
+                const prompt = yield promptForPrompt();
+                return yield runConversationTurn(conversationId, prompt);
+            case 'end':
+                yield endConversation(conversationId);
+                console.log('');
+                console.log('🌶️   Bye!');
+                return;
+            case 'new':
+                initialPrompt = '';
+                return startConversation([]);
+        }
+    });
+}
+function rateResponse(messageId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const result = yield inquirer.prompt([{
+                type: 'list',
+                name: 'rating',
+                message: 'Was this helpful?',
+                choices: [
+                    {
+                        name: '👍 Yes',
+                        value: 1
+                    },
+                    {
+                        name: '👎 No',
+                        value: -1
+                    },
+                    {
+                        name: '🤔 Not sure/skip',
+                        value: 0
+                    }
+                ]
+            }]);
+        if (result.rating === 0) {
+            return;
+        }
+        console.log('Thanks for letting us know! 😊');
+        const requestOptions = {
+            url: 'https://api.mendable.ai/v0/rateMessage',
+            headers: {
+                'content-type': 'application/json',
+                'x-anonymous': true
+            },
+            responseType: 'json',
+            data: {
+                // eslint-disable-next-line camelcase
+                api_key: mendableApiKey,
+                // eslint-disable-next-line camelcase
+                conversation_id: conversationId,
+                // eslint-disable-next-line camelcase
+                message_id: messageId,
+                // eslint-disable-next-line camelcase
+                rating_value: result.rating
+            }
+        };
+        const spinner = ora('Sending rating...');
+        /* c8 ignore next 3 */
+        if (showSpinner) {
+            spinner.start();
+        }
+        yield request_1.default.post(requestOptions);
+        /* c8 ignore next 3 */
+        if (showSpinner) {
+            spinner.stop();
+        }
+    });
+}
+function endConversation(conversationId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const requestOptions = {
+            url: 'https://api.mendable.ai/v0/endConversation',
+            headers: {
+                'content-type': 'application/json',
+                'x-anonymous': true
+            },
+            responseType: 'json',
+            data: {
+                // eslint-disable-next-line camelcase
+                api_key: mendableApiKey,
+                // eslint-disable-next-line camelcase
+                conversation_id: conversationId
+            }
+        };
+        const spinner = ora('Ending conversation...');
+        /* c8 ignore next 3 */
+        if (showSpinner) {
+            spinner.start();
+        }
+        yield request_1.default.post(requestOptions);
+        /* c8 ignore next 3 */
+        if (showSpinner) {
+            spinner.stop();
+        }
+    });
+}
+function runMendableChat(conversationId, question) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const requestOptions = {
+            url: 'https://api.mendable.ai/v0/mendableChat',
+            headers: {
+                'content-type': 'application/json',
+                'x-anonymous': true
+            },
+            responseType: 'json',
+            data: {
+                // eslint-disable-next-line camelcase
+                api_key: mendableApiKey,
+                // eslint-disable-next-line camelcase
+                conversation_id: conversationId,
+                question,
+                history,
+                shouldStream: false
+            }
+        };
+        return yield request_1.default.post(requestOptions);
+    });
+}
+function getConversationId() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const requestOptions = {
+            url: 'https://api.mendable.ai/v0/newConversation',
+            headers: {
+                'content-type': 'application/json',
+                'x-anonymous': true
+            },
+            responseType: 'json',
+            data: {
+                // eslint-disable-next-line camelcase
+                api_key: mendableApiKey
+            }
+        };
+        const response = yield request_1.default.post(requestOptions);
+        return response.conversation_id;
+    });
+}
+exports.chili = {
+    startConversation
+};
+//# sourceMappingURL=chili.js.map

package/dist/chili/index.js

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+"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 chili_1 = require("./chili");
+try {
+    (() => __awaiter(void 0, void 0, void 0, function* () { return yield chili_1.chili.startConversation(process.argv.slice(2)); }))();
+}
+catch (err) {
+    console.error(`🛑 An error has occurred while searching documentation: ${err}`);
+}
+//# sourceMappingURL=index.js.map

package/dist/cli/Cli.js

@@ -783,7 +783,7 @@ class Cli {
             console.error(message, ...optionalParams);
         }
     }
-    static prompt(options) {
+    static prompt(options, answers) {
         return __awaiter(this, void 0, void 0, function* () {
             const inquirer = require('inquirer');
             const cli = Cli.getInstance();
@@ -792,7 +792,7 @@ class Cli {
             if (spinnerSpinning) {
                 cli.spinner.stop();
             }
-            const response = yield inquirer.prompt(options);
+            const response = yield inquirer.prompt(options, answers);
             // Restart the spinner if it was running before the prompt
             /* c8 ignore next 3 */
             if (spinnerSpinning) {

package/dist/m365/aad/commands/user/user-add.js

@@ -26,6 +26,9 @@ class AadUserAddCommand extends GraphCommand_1.default {
     get description() {
         return 'Creates a new user';
     }
+    allowUnknownOptions() {
+        return true;
+    }
     constructor() {
         super();
         _AadUserAddCommand_instances.add(this);
@@ -36,37 +39,19 @@ class AadUserAddCommand extends GraphCommand_1.default {
         __classPrivateFieldGet(this, _AadUserAddCommand_instances, "m", _AadUserAddCommand_initTypes).call(this);
     }
     commandAction(logger, args) {
-        var _a, _b, _c;
         return __awaiter(this, void 0, void 0, function* () {
             if (this.verbose) {
                 logger.logToStderr(`Adding user to AAD with displayName ${args.options.displayName} and userPrincipalName ${args.options.userName}`);
             }
             try {
+                const manifest = this.mapRequestBody(args.options);
                 const requestOptions = {
                     url: `${this.resource}/v1.0/users`,
                     headers: {
                         accept: 'application/json;odata.metadata=none'
                     },
                     responseType: 'json',
-                    data: {
-                        accountEnabled: (_a = args.options.accountEnabled) !== null && _a !== void 0 ? _a : true,
-                        displayName: args.options.displayName,
-                        userPrincipalName: args.options.userName,
-                        mailNickName: (_b = args.options.mailNickname) !== null && _b !== void 0 ? _b : args.options.userName.split('@')[0],
-                        passwordProfile: {
-                            forceChangePasswordNextSignIn: args.options.forceChangePasswordNextSignIn || false,
-                            forceChangePasswordNextSignInWithMfa: args.options.forceChangePasswordNextSignInWithMfa || false,
-                            password: (_c = args.options.password) !== null && _c !== void 0 ? _c : this.generatePassword()
-                        },
-                        givenName: args.options.firstName,
-                        surName: args.options.lastName,
-                        usageLocation: args.options.usageLocation,
-                        officeLocation: args.options.officeLocation,
-                        jobTitle: args.options.jobTitle,
-                        companyName: args.options.companyName,
-                        department: args.options.department,
-                        preferredLanguage: args.options.preferredLanguage
-                    }
+                    data: manifest
                 };
                 const user = yield request_1.default.post(requestOptions);
                 user.password = requestOptions.data.passwordProfile.password;
@@ -89,8 +74,32 @@ class AadUserAddCommand extends GraphCommand_1.default {
             }
         });
     }
+    mapRequestBody(options) {
+        var _a, _b, _c;
+        const requestBody = {
+            accountEnabled: (_a = options.accountEnabled) !== null && _a !== void 0 ? _a : true,
+            displayName: options.displayName,
+            userPrincipalName: options.userName,
+            mailNickName: (_b = options.mailNickname) !== null && _b !== void 0 ? _b : options.userName.split('@')[0],
+            passwordProfile: {
+                forceChangePasswordNextSignIn: options.forceChangePasswordNextSignIn || false,
+                forceChangePasswordNextSignInWithMfa: options.forceChangePasswordNextSignInWithMfa || false,
+                password: (_c = options.password) !== null && _c !== void 0 ? _c : this.generatePassword()
+            },
+            givenName: options.firstName,
+            surName: options.lastName,
+            usageLocation: options.usageLocation,
+            officeLocation: options.officeLocation,
+            jobTitle: options.jobTitle,
+            companyName: options.companyName,
+            department: options.department,
+            preferredLanguage: options.preferredLanguage
+        };
+        this.addUnknownOptionsToPayload(requestBody, options);
+        return requestBody;
+    }
     /**
-     * Generate a password with at least: one digit, one lowercase chracter, one uppercase character and special character.
+     * Generate a password with at least: one digit, one lowercase character, one uppercase character, and a special character.
      */
     generatePassword() {
         const numberChars = '0123456789';