@pnp/cli-microsoft365 6.0.0-beta.fe4e66d → 6.0.0

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

@@ -8,13 +8,21 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+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 _Command_instances, _Command_initTelemetry, _Command_initOptions, _Command_initValidators;
 Object.defineProperty(exports, "__esModule", { value: true });
 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 utils_1 = require("./utils");
+const settingsNames_1 = require("./settingsNames");
+const accessToken_1 = require("./utils/accessToken");
 class CommandError {
     constructor(message, code) {
         this.message = message;
@@ -31,77 +39,121 @@ class CommandErrorWithOutput {
 exports.CommandErrorWithOutput = CommandErrorWithOutput;
 class Command {
     constructor() {
-        this._debug = false;
-        this._verbose = false;
-    }
-    get debug() {
-        return this._debug;
+        // These functions must be defined with # so that they're truly private
+        // otherwise you'll get a ts2415 error (Types have separate declarations of
+        // a private property 'x'.).
+        // `private` in TS is a design-time flag and private members end-up being
+        // regular class properties that would collide on runtime, which is why we
+        // need the extra `#`
+        _Command_instances.add(this);
+        this.debug = false;
+        this.verbose = false;
+        this.telemetry = [];
+        this.telemetryProperties = {};
+        this.options = [];
+        this.optionSets = [];
+        this.types = {
+            boolean: [],
+            string: []
+        };
+        this.validators = [];
+        __classPrivateFieldGet(this, _Command_instances, "m", _Command_initTelemetry).call(this);
+        __classPrivateFieldGet(this, _Command_instances, "m", _Command_initOptions).call(this);
+        __classPrivateFieldGet(this, _Command_instances, "m", _Command_initValidators).call(this);
     }
-    get verbose() {
-        return this._verbose;
+    get allowedOutputs() {
+        return ['csv', 'json', 'text'];
     }
-    showDeprecationWarning(logger, deprecated, recommended) {
-        const cli = cli_1.Cli.getInstance();
-        if (cli.currentCommandName &&
-            cli.currentCommandName.indexOf(deprecated) === 0) {
-            const chalk = require('chalk');
-            logger.logToStderr(chalk.yellow(`Command '${deprecated}' is deprecated. Please use '${recommended}' instead`));
-        }
-    }
-    warn(logger, warning) {
-        const chalk = require('chalk');
-        logger.logToStderr(chalk.yellow(warning));
+    validateUnknownOptions(args, command) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.allowUnknownOptions()) {
+                return true;
+            }
+            // if the command doesn't allow unknown options, check if all specified
+            // options match command options
+            for (const optionFromArgs in args.options) {
+                let matches = false;
+                for (let i = 0; i < command.options.length; i++) {
+                    const option = command.options[i];
+                    if (optionFromArgs === option.long ||
+                        optionFromArgs === option.short) {
+                        matches = true;
+                        break;
+                    }
+                }
+                if (!matches) {
+                    return `Invalid option: '${optionFromArgs}'${os.EOL}`;
+                }
+            }
+            return true;
+        });
     }
-    getUsedCommandName() {
-        const cli = cli_1.Cli.getInstance();
-        const commandName = this.getCommandName();
-        if (!cli.currentCommandName) {
-            return commandName;
-        }
-        if (cli.currentCommandName &&
-            cli.currentCommandName.indexOf(commandName) === 0) {
-            return commandName;
-        }
-        // since the command was called by something else than its name
-        // it must have aliases
-        const aliases = this.alias();
-        for (let i = 0; i < aliases.length; i++) {
-            if (cli.currentCommandName.indexOf(aliases[i]) === 0) {
-                return aliases[i];
+    validateRequiredOptions(args, command) {
+        return __awaiter(this, void 0, void 0, function* () {
+            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++) {
+                if (!command.options[i].required ||
+                    typeof args.options[command.options[i].name] !== 'undefined') {
+                    continue;
+                }
+                if (!shouldPrompt) {
+                    return `Required option ${command.options[i].name} not specified`;
+                }
+                if (!prompted) {
+                    prompted = true;
+                    Cli_1.Cli.log('Provide values for the following parameters:');
+                }
+                if (!inquirer) {
+                    inquirer = require('inquirer');
+                }
+                const missingRequireOptionValue = yield inquirer
+                    .prompt({
+                    name: 'missingRequireOptionValue',
+                    message: `${command.options[i].name}: `
+                })
+                    .then(result => result.missingRequireOptionValue);
+                args.options[command.options[i].name] = missingRequireOptionValue;
             }
-        }
-        // shouldn't happen because the command is called either by its name or alias
-        return '';
+            return true;
+        });
     }
-    action(logger, args, cb) {
-        Auth_1.default
-            .restoreAuth()
-            .then(() => {
-            this.initAction(args, logger);
-            if (!Auth_1.default.service.connected) {
-                cb(new CommandError('Log in to Microsoft 365 first'));
-                return;
+    validateOptionSets(args, command) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const optionsSets = command.command.optionSets;
+            if (!optionsSets || optionsSets.length === 0) {
+                return true;
             }
-            this.loadValuesFromAccessToken(args);
-            this.commandAction(logger, args, cb);
-        }, (error) => {
-            cb(new CommandError(error));
+            const argsOptions = Object.keys(args.options);
+            for (const optionSet of optionsSets) {
+                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;
         });
     }
-    getTelemetryProperties(args) {
-        return {
-            debug: this.debug.toString(),
-            verbose: this.verbose.toString(),
-            output: args.options.output,
-            query: typeof args.options.query !== 'undefined'
-        };
+    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;
     }
-    autocomplete() {
-        return;
-    }
     /**
      * Returns list of properties that should be returned in the text output.
      * Returns all properties if no default properties specified
@@ -112,33 +164,6 @@ class Command {
     allowUnknownOptions() {
         return;
     }
-    options() {
-        return [
-            {
-                option: '--query [query]'
-            },
-            {
-                option: '-o, --output [output]',
-                autocomplete: ['csv', 'json', 'text']
-            },
-            {
-                option: '--verbose'
-            },
-            {
-                option: '--debug'
-            }
-        ];
-    }
-    optionSets() {
-        return;
-    }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    validate(args) {
-        return true;
-    }
-    types() {
-        return;
-    }
     /**
      * Processes options after resolving them from the user input and before
      * passing them on to command action for execution. Used for example for
@@ -150,6 +175,41 @@ class Command {
         return __awaiter(this, void 0, void 0, function* () {
         });
     }
+    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) {
+                throw new CommandError('Log in to Microsoft 365 first');
+            }
+            try {
+                this.loadValuesFromAccessToken(args);
+                yield this.commandAction(logger, args);
+            }
+            catch (ex) {
+                if (ex instanceof CommandError) {
+                    throw ex;
+                }
+                throw new CommandError(ex);
+            }
+        });
+    }
+    validate(args, command) {
+        return __awaiter(this, void 0, void 0, function* () {
+            for (const validate of this.validators) {
+                const result = yield validate(args, command);
+                if (result !== true) {
+                    return result;
+                }
+            }
+            return true;
+        });
+    }
     getCommandName(alias) {
         var _a;
         if (alias &&
@@ -167,92 +227,100 @@ 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) {
-        // console.log(JSON.stringify(response, null, 2));
+    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';
-        this._verbose = this._debug || args.options.verbose || process.env.CLIMICROSOFT365_VERBOSE === '1';
-        request_1.default.debug = this._debug;
+        this.debug = args.options.debug || process.env.CLIMICROSOFT365_DEBUG === '1';
+        this.verbose = this.debug || args.options.verbose || process.env.CLIMICROSOFT365_VERBOSE === '1';
+        request_1.default.debug = this.debug;
         request_1.default.logger = logger;
         appInsights_1.default.trackEvent({
             name: this.getUsedCommandName(),
@@ -264,7 +332,7 @@ class Command {
         const unknownOptions = JSON.parse(JSON.stringify(options));
         // remove minimist catch-all option
         delete unknownOptions._;
-        const knownOptions = this.options();
+        const knownOptions = this.options;
         const longOptionRegex = /--([^\s]+)/;
         const shortOptionRegex = /-([a-z])\b/;
         knownOptions.forEach(o => {
@@ -307,13 +375,67 @@ 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();
+        if (cli.currentCommandName &&
+            cli.currentCommandName.indexOf(deprecated) === 0) {
+            const chalk = require('chalk');
+            logger.logToStderr(chalk.yellow(`Command '${deprecated}' is deprecated. Please use '${recommended}' instead`));
+        }
+    }
+    warn(logger, warning) {
+        const chalk = require('chalk');
+        logger.logToStderr(chalk.yellow(warning));
+    }
+    getUsedCommandName() {
+        const cli = Cli_1.Cli.getInstance();
+        const commandName = this.getCommandName();
+        if (!cli.currentCommandName) {
+            return commandName;
+        }
+        if (cli.currentCommandName &&
+            cli.currentCommandName.indexOf(commandName) === 0) {
+            return commandName;
+        }
+        // since the command was called by something else than its name
+        // it must have aliases
+        const aliases = this.alias();
+        for (let i = 0; i < aliases.length; i++) {
+            if (cli.currentCommandName.indexOf(aliases[i]) === 0) {
+                return aliases[i];
+            }
+        }
+        // shouldn't happen because the command is called either by its name or alias
+        return '';
+    }
+    getTelemetryProperties(args) {
+        this.telemetry.forEach(t => t(args));
+        return this.telemetryProperties;
+    }
 }
 exports.default = Command;
+_Command_instances = new WeakSet(), _Command_initTelemetry = function _Command_initTelemetry() {
+    this.telemetry.push((args) => {
+        Object.assign(this.telemetryProperties, {
+            debug: this.debug.toString(),
+            verbose: this.verbose.toString(),
+            output: args.options.output,
+            query: typeof args.options.query !== 'undefined'
+        });
+    });
+}, _Command_initOptions = function _Command_initOptions() {
+    this.options.unshift({ option: '--query [query]' }, {
+        option: '-o, --output [output]',
+        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 => 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()
 };