@pnp/cli-microsoft365 6.0.0-beta.78fdd2c → 6.0.0-beta.7920dfd

package/.devcontainer/Dockerfile

@@ -27,7 +27,9 @@ RUN apt-get update && apt-get install -y \
   && apt-get install nodejs -y \
   && rm -rf /var/lib/apt/lists/*
 
-RUN pip3 install mkdocs-material==7.1.7 pymdown-extensions==9.0 pygments==2.11
+COPY ../docs/pip_requirements.txt .
+
+RUN pip install -r pip_requirements.txt
 
 RUN useradd \
   --user-group \

package/.devcontainer/devcontainer.json

@@ -1,6 +1,7 @@
 {
   "name": "CLI for Microsoft 365",
   "dockerFile": "Dockerfile",
+  "context": "..",
   "settings": {
     "terminal.integrated.profiles.linux": {
       "zsh": {

package/.eslintrc.js

@@ -17,6 +17,7 @@ const dictionary = [
   'content',
   'conversation',
   'custom',
+  'dataverse',
   'default',
   'external',
   'externalize',
@@ -61,6 +62,7 @@ const dictionary = [
   'site',
   'status',
   'storage',
+  'table',
   'teams',
   'token',
   'type',
@@ -98,7 +100,8 @@ module.exports = {
   },
   "plugins": [
     "@typescript-eslint",
-    "cli-microsoft365"
+    "cli-microsoft365",
+    "mocha"
   ],
   "ignorePatterns": [
     "**/pcf-init/assets/**",
@@ -172,7 +175,20 @@ module.exports = {
     "eqeqeq": [
       "error",
       "always"
-    ]
+    ],
+    "@typescript-eslint/naming-convention": [
+      "error",
+      {
+        "selector": [
+          "method"
+        ],
+        "format": [
+          "camelCase"
+        ]
+      }
+    ],
+    "@typescript-eslint/explicit-function-return-type": ["error", { "allowExpressions": true }],
+    "mocha/no-identical-title": "error"
   },
   "overrides": [
     {
@@ -183,7 +199,8 @@ module.exports = {
         "no-console": "error",
         "@typescript-eslint/no-empty-function": "off",
         "cli-microsoft365/correct-command-class-name": "off",
-        "cli-microsoft365/correct-command-name": "off"
+        "cli-microsoft365/correct-command-name": "off",
+        "@typescript-eslint/explicit-function-return-type": "off"
       }
     },
     {

package/LICENSE

@@ -1,5 +1,3 @@
-Copyright (c) Microsoft Corporation. All rights reserved. 
-
 MIT License
 
 Permission is hereby granted, free of charge, to any person obtaining
@@ -19,4 +17,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -15,6 +15,11 @@
       alt="GitHub" />
   </a>
 
+  <a href="https://discord.com/invite/7rfW4kg6B5">
+    <img src="https://img.shields.io/badge/Discord-Join-7289da?style=flat-square"
+      alt="Discord" />
+  </a>
+
   <a href="https://twitter.com/climicrosoft365">
     <img src="https://img.shields.io/badge/Twitter-%40climicrosoft365-blue?style=flat-square"
       alt="Twitter" />

package/dist/Auth.js

@@ -12,7 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Auth = exports.CertificateType = exports.AuthType = exports.Service = void 0;
 const FileTokenStorage_1 = require("./auth/FileTokenStorage");
 const msalCachePlugin_1 = require("./auth/msalCachePlugin");
-const cli_1 = require("./cli");
+const Cli_1 = require("./cli/Cli");
 const Command_1 = require("./Command");
 const config_1 = require("./config");
 const request_1 = require("./request");
@@ -301,8 +301,7 @@ class Auth {
             logger.logToStderr('');
         }
         logger.log(response.message);
-        if (cli_1.Cli.getInstance().getSettingWithDefaultValue(settingsNames_1.settingsNames.autoOpenBrowserOnLogin, false)
-            || cli_1.Cli.getInstance().getSettingWithDefaultValue(settingsNames_1.settingsNames.autoOpenLinksInBrowser, false)) {
+        if (Cli_1.Cli.getInstance().getSettingWithDefaultValue(settingsNames_1.settingsNames.autoOpenLinksInBrowser, false)) {
             // _open is never set before hitting this line, but this check
             // is implemented so that we can support lazy loading
             // but also stub it for testing
@@ -312,7 +311,7 @@ class Auth {
             }
             this._open(response.verificationUri);
         }
-        if (cli_1.Cli.getInstance().getSettingWithDefaultValue(settingsNames_1.settingsNames.copyDeviceCodeToClipboard, false)) {
+        if (Cli_1.Cli.getInstance().getSettingWithDefaultValue(settingsNames_1.settingsNames.copyDeviceCodeToClipboard, false)) {
             // _clipboardy is never set before hitting this line, but this check
             // is implemented so that we can support lazy loading
             // but also stub it for testing

package/dist/Command.js

@@ -19,10 +19,10 @@ exports.CommandErrorWithOutput = exports.CommandError = void 0;
 const os = require("os");
 const appInsights_1 = require("./appInsights");
 const Auth_1 = require("./Auth");
-const cli_1 = require("./cli");
+const Cli_1 = require("./cli/Cli");
 const request_1 = require("./request");
 const settingsNames_1 = require("./settingsNames");
-const utils_1 = require("./utils");
+const accessToken_1 = require("./utils/accessToken");
 class CommandError {
     constructor(message, code) {
         this.message = message;
@@ -61,6 +61,9 @@ class Command {
         __classPrivateFieldGet(this, _Command_instances, "m", _Command_initOptions).call(this);
         __classPrivateFieldGet(this, _Command_instances, "m", _Command_initValidators).call(this);
     }
+    get allowedOutputs() {
+        return ['csv', 'json', 'text'];
+    }
     validateUnknownOptions(args, command) {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.allowUnknownOptions()) {
@@ -87,7 +90,7 @@ class Command {
     }
     validateRequiredOptions(args, command) {
         return __awaiter(this, void 0, void 0, function* () {
-            const shouldPrompt = cli_1.Cli.getInstance().getSettingWithDefaultValue(settingsNames_1.settingsNames.prompt, false);
+            const shouldPrompt = Cli_1.Cli.getInstance().getSettingWithDefaultValue(settingsNames_1.settingsNames.prompt, false);
             let inquirer;
             let prompted = false;
             for (let i = 0; i < command.options.length; i++) {
@@ -100,7 +103,7 @@ class Command {
                 }
                 if (!prompted) {
                     prompted = true;
-                    cli_1.Cli.log('Provide values for the following parameters:');
+                    Cli_1.Cli.log('Provide values for the following parameters:');
                 }
                 if (!inquirer) {
                     inquirer = require('inquirer');
@@ -124,17 +127,30 @@ class Command {
             }
             const argsOptions = Object.keys(args.options);
             for (const optionSet of optionsSets) {
-                const commonOptions = argsOptions.filter(opt => optionSet.includes(opt));
-                if (commonOptions.length === 0) {
-                    return `Specify one of the following options: ${optionSet.map(opt => opt).join(', ')}.`;
-                }
-                if (commonOptions.length > 1) {
-                    return `Specify one of the following options: ${optionSet.map(opt => opt).join(', ')}, but not multiple.`;
+                if (optionSet.runsWhen === undefined || optionSet.runsWhen(args)) {
+                    const commonOptions = argsOptions.filter(opt => optionSet.options.includes(opt));
+                    if (commonOptions.length === 0) {
+                        return `Specify one of the following options: ${optionSet.options.map(opt => opt).join(', ')}.`;
+                    }
+                    if (commonOptions.length > 1) {
+                        return `Specify one of the following options: ${optionSet.options.map(opt => opt).join(', ')}, but not multiple.`;
+                    }
                 }
             }
             return true;
         });
     }
+    validateOutput(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (args.options.output &&
+                this.allowedOutputs.indexOf(args.options.output) < 0) {
+                return `'${args.options.output}' is not a valid output type. Allowed output types are ${this.allowedOutputs.join(', ')}`;
+            }
+            else {
+                return true;
+            }
+        });
+    }
     alias() {
         return;
     }
@@ -159,24 +175,28 @@ class Command {
         return __awaiter(this, void 0, void 0, function* () {
         });
     }
-    action(logger, args, cb) {
-        Auth_1.default
-            .restoreAuth()
-            .then(() => {
+    action(logger, args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                yield Auth_1.default.restoreAuth();
+            }
+            catch (error) {
+                throw new CommandError(error);
+            }
             this.initAction(args, logger);
             if (!Auth_1.default.service.connected) {
-                cb(new CommandError('Log in to Microsoft 365 first'));
-                return;
+                throw new CommandError('Log in to Microsoft 365 first');
             }
             try {
                 this.loadValuesFromAccessToken(args);
-                this.commandAction(logger, args, cb);
+                yield this.commandAction(logger, args);
             }
             catch (ex) {
-                cb(new CommandError(ex));
+                if (ex instanceof CommandError) {
+                    throw ex;
+                }
+                throw new CommandError(ex);
             }
-        }, (error) => {
-            cb(new CommandError(error));
         });
     }
     validate(args, command) {
@@ -207,86 +227,95 @@ class Command {
         }
         return commandName;
     }
-    handleRejectedODataPromise(rawResponse, logger, callback) {
+    handleRejectedODataPromise(rawResponse) {
         const res = JSON.parse(JSON.stringify(rawResponse));
         if (res.error) {
             try {
                 const err = JSON.parse(res.error);
-                callback(new CommandError(err['odata.error'].message.value));
+                throw new CommandError(err['odata.error'].message.value);
             }
-            catch (_a) {
+            catch (err) {
+                if (err instanceof CommandError) {
+                    throw err;
+                }
                 try {
                     const graphResponseError = res.error;
                     if (graphResponseError.error.code) {
-                        callback(new CommandError(graphResponseError.error.code + " - " + graphResponseError.error.message));
+                        throw new CommandError(graphResponseError.error.code + " - " + graphResponseError.error.message);
                     }
                     else {
-                        callback(new CommandError(graphResponseError.error.message));
+                        throw new CommandError(graphResponseError.error.message);
                     }
                 }
-                catch (_b) {
-                    callback(new CommandError(res.error));
+                catch (err) {
+                    if (err instanceof CommandError) {
+                        throw err;
+                    }
+                    throw new CommandError(res.error);
                 }
             }
         }
         else {
             if (rawResponse instanceof Error) {
-                callback(new CommandError(rawResponse.message));
+                throw new CommandError(rawResponse.message);
             }
             else {
-                callback(new CommandError(rawResponse));
+                throw new CommandError(rawResponse);
             }
         }
     }
-    handleRejectedODataJsonPromise(response, logger, callback) {
+    handleRejectedODataJsonPromise(response) {
         if (response.error &&
             response.error['odata.error'] &&
             response.error['odata.error'].message) {
-            return callback(new CommandError(response.error['odata.error'].message.value));
+            throw new CommandError(response.error['odata.error'].message.value);
         }
         if (!response.error) {
             if (response instanceof Error) {
-                return callback(new CommandError(response.message));
+                throw new CommandError(response.message);
             }
             else {
-                return callback(new CommandError(response));
+                throw new CommandError(response);
             }
         }
         if (response.error.error &&
             response.error.error.message) {
-            return callback(new CommandError(response.error.error.message));
+            throw new CommandError(response.error.error.message);
         }
         if (response.error.message) {
-            return callback(new CommandError(response.error.message));
+            throw new CommandError(response.error.message);
         }
         if (response.error.error_description) {
-            return callback(new CommandError(response.error.error_description));
+            throw new CommandError(response.error.error_description);
         }
         try {
             const error = JSON.parse(response.error);
             if (error &&
                 error.error &&
                 error.error.message) {
-                callback(new CommandError(error.error.message));
+                throw new CommandError(error.error.message);
             }
             else {
-                callback(new CommandError(response.error));
+                throw new CommandError(response.error);
             }
         }
-        catch (_a) {
-            callback(new CommandError(response.error));
+        catch (err) {
+            if (err instanceof CommandError) {
+                throw err;
+            }
+            throw new CommandError(response.error);
         }
     }
-    handleError(rawResponse, logger, callback) {
+    handleError(rawResponse) {
         if (rawResponse instanceof Error) {
-            callback(new CommandError(rawResponse.message));
+            throw new CommandError(rawResponse.message);
         }
         else {
-            callback(new CommandError(rawResponse));
+            throw new CommandError(rawResponse);
         }
     }
-    handleRejectedPromise(rawResponse, logger, callback) {
-        this.handleError(rawResponse, logger, callback);
+    handleRejectedPromise(rawResponse) {
+        this.handleError(rawResponse);
     }
     initAction(args, logger) {
         this.debug = args.options.debug || process.env.CLIMICROSOFT365_DEBUG === '1';
@@ -346,15 +375,15 @@ class Command {
             }
             const lowerCaseValue = value.toLowerCase();
             if (lowerCaseValue === '@meid') {
-                args.options[option] = utils_1.accessToken.getUserIdFromAccessToken(token);
+                args.options[option] = accessToken_1.accessToken.getUserIdFromAccessToken(token);
             }
             if (lowerCaseValue === '@meusername') {
-                args.options[option] = utils_1.accessToken.getUserNameFromAccessToken(token);
+                args.options[option] = accessToken_1.accessToken.getUserNameFromAccessToken(token);
             }
         });
     }
     showDeprecationWarning(logger, deprecated, recommended) {
-        const cli = cli_1.Cli.getInstance();
+        const cli = Cli_1.Cli.getInstance();
         if (cli.currentCommandName &&
             cli.currentCommandName.indexOf(deprecated) === 0) {
             const chalk = require('chalk');
@@ -366,7 +395,7 @@ class Command {
         logger.logToStderr(chalk.yellow(warning));
     }
     getUsedCommandName() {
-        const cli = cli_1.Cli.getInstance();
+        const cli = Cli_1.Cli.getInstance();
         const commandName = this.getCommandName();
         if (!cli.currentCommandName) {
             return commandName;
@@ -404,9 +433,9 @@ _Command_instances = new WeakSet(), _Command_initTelemetry = function _Command_i
 }, _Command_initOptions = function _Command_initOptions() {
     this.options.unshift({ option: '--query [query]' }, {
         option: '-o, --output [output]',
-        autocomplete: ['csv', 'json', 'text']
+        autocomplete: this.allowedOutputs
     }, { option: '--verbose' }, { option: '--debug' });
 }, _Command_initValidators = function _Command_initValidators() {
-    this.validators.push((args, command) => this.validateUnknownOptions(args, command), (args, command) => this.validateRequiredOptions(args, command), (args, command) => this.validateOptionSets(args, command));
+    this.validators.push((args, command) => this.validateUnknownOptions(args, command), (args, command) => this.validateRequiredOptions(args, command), args => this.validateOutput(args), (args, command) => this.validateOptionSets(args, command));
 };
 //# sourceMappingURL=Command.js.map

package/dist/api.js

@@ -1,17 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.executeCommand = void 0;
-const cli_1 = require("./cli");
+const Cli_1 = require("./cli/Cli");
 const path = require("path");
 function executeCommand(commandName, options, listener) {
-    const cli = cli_1.Cli.getInstance();
+    const cli = Cli_1.Cli.getInstance();
     cli.commandsFolder = path.join(__dirname, 'm365');
     cli.commands = [];
     cli.loadCommandFromArgs(commandName.split(' '));
     if (cli.commands.length !== 1) {
         return Promise.reject(`Command not found: ${commandName}`);
     }
-    return cli_1.Cli.executeCommandWithOutput(cli.commands[0].command, { options: options !== null && options !== void 0 ? options : {} }, listener);
+    return Cli_1.Cli.executeCommandWithOutput(cli.commands[0].command, { options: options !== null && options !== void 0 ? options : {} }, listener);
 }
 exports.executeCommand = executeCommand;
 //# sourceMappingURL=api.js.map

package/dist/appInsights.js

@@ -10,6 +10,7 @@ const appInsights = require("applicationinsights");
 const crypto = require("crypto");
 const fs = require("fs");
 const path = require("path");
+const pid_1 = require("./utils/pid");
 const config = appInsights.setup('6b908c80-d09f-4cf6-8274-e54349a0149a');
 config.setInternalLogging(false, false);
 // append -dev to the version number when ran locally
@@ -20,6 +21,7 @@ const env = process.env.CLIMICROSOFT365_ENV !== undefined ? process.env.CLIMICRO
 appInsights.defaultClient.commonProperties = {
     version: version,
     node: process.version,
+    shell: pid_1.pid.getProcessName(process.ppid) || '',
     env: env,
     ci: Boolean(process.env.CI).toString()
 };