@pnp/cli-microsoft365 8.0.0-beta.e6f9331 → 8.1.0-beta.309a9b8

package/dist/Auth.js

@@ -1,4 +1,5 @@
 import { AzureCloudInstance } from '@azure/msal-common';
+import assert from 'assert';
 import { CommandError } from './Command.js';
 import { FileTokenStorage } from './auth/FileTokenStorage.js';
 import { msalCachePlugin } from './auth/msalCachePlugin.js';
@@ -6,16 +7,15 @@ import { cli } from './cli/cli.js';
 import config from './config.js';
 import request from './request.js';
 import { settingsNames } from './settingsNames.js';
-import { browserUtil } from './utils/browserUtil.js';
 import * as accessTokenUtil from './utils/accessToken.js';
-import assert from 'assert';
+import { browserUtil } from './utils/browserUtil.js';
 export var CloudType;
 (function (CloudType) {
-    CloudType[CloudType["Public"] = 0] = "Public";
-    CloudType[CloudType["USGov"] = 1] = "USGov";
-    CloudType[CloudType["USGovHigh"] = 2] = "USGovHigh";
-    CloudType[CloudType["USGovDoD"] = 3] = "USGovDoD";
-    CloudType[CloudType["China"] = 4] = "China";
+    CloudType["Public"] = "Public";
+    CloudType["USGov"] = "USGov";
+    CloudType["USGovHigh"] = "USGovHigh";
+    CloudType["USGovDoD"] = "USGovDoD";
+    CloudType["China"] = "China";
 })(CloudType || (CloudType = {}));
 export class Connection {
     constructor() {
@@ -354,15 +354,7 @@ export class Auth {
             await logger.logToStderr(response);
             await logger.logToStderr('');
         }
-        cli.spinner.text = response.message;
-        cli.spinner.spinner = {
-            frames: ['🌶️ ']
-        };
-        // don't show spinner if running tests
-        /* c8 ignore next 3 */
-        if (!cli.spinner.isSpinning && typeof global.it === 'undefined') {
-            cli.spinner.start();
-        }
+        await logger.logToStderr(`🌶️  ${response.message}`);
         if (cli.getSettingWithDefaultValue(settingsNames.autoOpenLinksInBrowser, false)) {
             await browserUtil.open(response.verificationUri);
         }
@@ -699,7 +691,7 @@ export class Auth {
         const allConnections = await this.getAllConnections();
         const connection = allConnections.find(i => i.name === name);
         if (!connection) {
-            throw new CommandError(`The connection '${name}' cannot be found`);
+            throw new CommandError(`The connection '${name}' cannot be found.`);
         }
         return connection;
     }
@@ -718,7 +710,7 @@ export class Auth {
         return details;
     }
 }
-Auth.cloudEndpoints = [];
+Auth.cloudEndpoints = {};
 Auth.initialize();
 export default new Auth();
 //# sourceMappingURL=Auth.js.map

package/dist/Command.js

@@ -5,6 +5,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 };
 var _Command_instances, _Command_initTelemetry, _Command_initOptions, _Command_initValidators;
 import os from 'os';
+import { z } from 'zod';
 import auth from './Auth.js';
 import { cli } from './cli/cli.js';
 import request from './request.js';
@@ -13,6 +14,7 @@ import { telemetry } from './telemetry.js';
 import { accessToken } from './utils/accessToken.js';
 import { md } from './utils/md.js';
 import { prompt } from './utils/prompt.js';
+import { zod } from './utils/zod.js';
 export class CommandError {
     constructor(message, code) {
         this.message = message;
@@ -25,10 +27,26 @@ export class CommandErrorWithOutput {
         this.stderr = stderr;
     }
 }
+export const globalOptionsZod = z.object({
+    query: z.string().optional(),
+    output: zod.alias('o', z.enum(['csv', 'json', 'md', 'text', 'none']).optional()),
+    debug: z.boolean().default(false),
+    verbose: z.boolean().default(false)
+});
 class Command {
     get allowedOutputs() {
         return ['csv', 'json', 'md', 'text', 'none'];
     }
+    get schema() {
+        return undefined;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    getRefinedSchema(schema) {
+        return undefined;
+    }
+    getSchemaToParse() {
+        return this.getRefinedSchema(this.schema) ?? this.schema;
+    }
     constructor() {
         // These functions must be defined with # so that they're truly private
         // otherwise you'll get a ts2415 error (Types have separate declarations of
@@ -48,6 +66,9 @@ class Command {
             string: []
         };
         this.validators = [];
+        // metadata for command's options
+        // used for building telemetry
+        this.optionsInfo = [];
         __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);
@@ -90,9 +111,7 @@ class Command {
                 prompted = true;
                 await cli.error('🌶️  Provide values for the following parameters:');
             }
-            const answer = optionInfo.autocomplete !== undefined
-                ? await prompt.forSelection({ message: `${optionInfo.name}: `, choices: optionInfo.autocomplete.map((choice) => { return { name: choice, value: choice }; }) })
-                : await prompt.forInput({ message: `${optionInfo.name}: ` });
+            const answer = await cli.promptForValue(optionInfo);
             args.options[optionInfo.name] = answer;
         }
         if (prompted) {
@@ -410,8 +429,34 @@ class Command {
         return '';
     }
     getTelemetryProperties(args) {
-        this.telemetry.forEach(t => t(args));
-        return this.telemetryProperties;
+        if (this.schema) {
+            const telemetryProperties = {};
+            this.optionsInfo.forEach(o => {
+                if (o.required) {
+                    return;
+                }
+                if (typeof args.options[o.name] === 'undefined') {
+                    return;
+                }
+                switch (o.type) {
+                    case 'string':
+                        telemetryProperties[o.name] = o.autocomplete ? args.options[o.name] : typeof args.options[o.name] !== 'undefined';
+                        break;
+                    case 'boolean':
+                        telemetryProperties[o.name] = args.options[o.name];
+                        break;
+                    case 'number':
+                        telemetryProperties[o.name] = typeof args.options[o.name] !== 'undefined';
+                        break;
+                }
+                ;
+            });
+            return telemetryProperties;
+        }
+        else {
+            this.telemetry.forEach(t => t(args));
+            return this.telemetryProperties;
+        }
     }
     async getTextOutput(logStatement) {
         // display object as a list of key-value pairs

package/dist/chili/chili.js

@@ -1,22 +1,17 @@
 import fs from 'fs';
-import ora from 'ora';
 import path from 'path';
 import url from 'url';
-import { cli } from '../cli/cli.js';
 import request from '../request.js';
-import { settingsNames } from '../settingsNames.js';
 import { md } from '../utils/md.js';
 import { prompt } from '../utils/prompt.js';
 const __dirname = url.fileURLToPath(new URL('.', import.meta.url));
 const mendableBaseUrl = 'https://api.mendable.ai/v1';
 const mendableApiKey = 'd3313d54-6f8e-40e0-90d3-4095019d4be7';
-const spinner = ora({ discardStdin: false });
 let showHelp = false;
 let debug = false;
 let conversationId = 0;
 let initialPrompt = '';
 let history = [];
-const showSpinner = cli.getSettingWithDefaultValue(settingsNames.showSpinner, true) && typeof global.it === 'undefined';
 request.logger = {
     /* c8 ignore next 3 */
     log: async (msg) => console.log(msg),
@@ -74,20 +69,11 @@ async function promptForPrompt() {
 }
 async function runConversationTurn(conversationId, question) {
     console.log('');
-    /* c8 ignore next 4 */
-    if (showSpinner) {
-        spinner.text = 'Searching documentation...';
-        spinner.start();
-    }
     const response = await runMendableChat(conversationId, question);
     history.push({
         prompt: question,
         response: response.answer.text
     });
-    /* c8 ignore next 3 */
-    if (showSpinner) {
-        spinner.stop();
-    }
     console.log(md.md2plain(response.answer.text, ''));
     console.log('');
     console.log('Source:');
@@ -141,16 +127,7 @@ async function endConversation(conversationId) {
             conversation_id: conversationId
         }
     };
-    /* c8 ignore next 4 */
-    if (showSpinner) {
-        spinner.text = 'Ending conversation...';
-        spinner.start();
-    }
     await request.post(requestOptions);
-    /* c8 ignore next 3 */
-    if (showSpinner) {
-        spinner.stop();
-    }
 }
 async function runMendableChat(conversationId, question) {
     const requestOptions = {

package/dist/cli/cli.js

@@ -1,29 +1,27 @@
 import Configstore from 'configstore';
 import fs from 'fs';
-import minimist from 'minimist';
 import { createRequire } from 'module';
-import ora from 'ora';
 import os from 'os';
 import path from 'path';
 import { fileURLToPath, pathToFileURL } from 'url';
+import yargs from 'yargs-parser';
+import { ZodError } from 'zod';
 import Command, { CommandError } from '../Command.js';
 import config from '../config.js';
 import request from '../request.js';
 import { settingsNames } from '../settingsNames.js';
 import { telemetry } from '../telemetry.js';
 import { app } from '../utils/app.js';
+import { browserUtil } from '../utils/browserUtil.js';
 import { formatting } from '../utils/formatting.js';
 import { md } from '../utils/md.js';
-import { validation } from '../utils/validation.js';
 import { prompt } from '../utils/prompt.js';
+import { validation } from '../utils/validation.js';
+import { zod } from '../utils/zod.js';
 import { timings } from './timings.js';
-import { browserUtil } from '../utils/browserUtil.js';
 const require = createRequire(import.meta.url);
 const __dirname = fileURLToPath(new URL('.', import.meta.url));
 let _config;
-// we assign it through exported function to support mocking
-// eslint-disable-next-line prefer-const
-let spinner = ora();
 const commands = [];
 /**
  * Command to execute
@@ -38,6 +36,14 @@ const defaultHelpMode = 'options';
 const defaultHelpTarget = 'console';
 const helpModes = ['options', 'examples', 'remarks', 'response', 'full'];
 const helpTargets = ['console', 'web'];
+const yargsConfiguration = {
+    'parse-numbers': true,
+    'strip-aliased': true,
+    'strip-dashed': true,
+    'dot-notation': false,
+    'boolean-negation': true,
+    'camel-case-expansion': false
+};
 function getConfig() {
     if (!_config) {
         _config = new Configstore(config.configstoreName);
@@ -68,7 +74,7 @@ async function execute(rawArgs) {
         rawArgs.shift();
     }
     // parse args to see if a command has been specified
-    const parsedArgs = minimist(rawArgs);
+    const parsedArgs = yargs(rawArgs);
     // load command
     await cli.loadCommandFromArgs(parsedArgs._);
     if (cli.commandToExecute) {
@@ -81,8 +87,7 @@ async function execute(rawArgs) {
             };
         }
         catch (e) {
-            const optionsWithoutShorts = removeShortOptions({ options: parsedArgs });
-            return cli.closeWithError(e.message, optionsWithoutShorts, false);
+            return cli.closeWithError(e.message, { options: parsedArgs }, false);
         }
     }
     else {
@@ -130,18 +135,54 @@ async function execute(rawArgs) {
     if (cli.optionsFromArgs.options.output === undefined) {
         cli.optionsFromArgs.options.output = cli.getSettingWithDefaultValue(settingsNames.output, 'json');
     }
-    const startValidation = process.hrtime.bigint();
-    const validationResult = await cli.commandToExecute.command.validate(cli.optionsFromArgs, cli.commandToExecute);
-    const endValidation = process.hrtime.bigint();
-    timings.validation.push(Number(endValidation - startValidation));
-    if (validationResult !== true) {
-        return cli.closeWithError(validationResult, cli.optionsFromArgs, true);
+    let finalArgs = cli.optionsFromArgs.options;
+    if (cli.commandToExecute?.command.schema) {
+        while (true) {
+            const startValidation = process.hrtime.bigint();
+            const result = cli.commandToExecute.command.getSchemaToParse().safeParse(cli.optionsFromArgs.options);
+            const endValidation = process.hrtime.bigint();
+            timings.validation.push(Number(endValidation - startValidation));
+            if (result.success) {
+                finalArgs = result.data;
+                break;
+            }
+            else {
+                const hasNonRequiredErrors = result.error.errors.some(e => e.code !== 'invalid_type' || e.received !== 'undefined');
+                const shouldPrompt = cli.getSettingWithDefaultValue(settingsNames.prompt, true);
+                if (hasNonRequiredErrors === false &&
+                    shouldPrompt) {
+                    await cli.error('🌶️  Provide values for the following parameters:');
+                    for (const error of result.error.errors) {
+                        const optionInfo = cli.commandToExecute.options.find(o => o.name === error.path.join('.'));
+                        const answer = await cli.promptForValue(optionInfo);
+                        cli.optionsFromArgs.options[error.path.join('.')] = answer;
+                    }
+                }
+                else {
+                    result.error.errors.forEach(e => {
+                        if (e.code === 'invalid_type' &&
+                            e.received === 'undefined') {
+                            e.message = `Required option not specified`;
+                        }
+                    });
+                    return cli.closeWithError(result.error, cli.optionsFromArgs, true);
+                }
+            }
+        }
+    }
+    else {
+        const startValidation = process.hrtime.bigint();
+        const validationResult = await cli.commandToExecute.command.validate(cli.optionsFromArgs, cli.commandToExecute);
+        const endValidation = process.hrtime.bigint();
+        timings.validation.push(Number(endValidation - startValidation));
+        if (validationResult !== true) {
+            return cli.closeWithError(validationResult, cli.optionsFromArgs, true);
+        }
     }
-    cli.optionsFromArgs = removeShortOptions(cli.optionsFromArgs);
     const end = process.hrtime.bigint();
     timings.core.push(Number(end - start));
     try {
-        await cli.executeCommand(cli.commandToExecute.command, cli.optionsFromArgs);
+        await cli.executeCommand(cli.commandToExecute.command, { options: finalArgs });
         const endTotal = process.hrtime.bigint();
         timings.total.push(Number(endTotal - start));
         await printTimings(rawArgs);
@@ -190,12 +231,6 @@ async function executeCommand(command, args) {
     // the command to execute
     const parentCommandName = cli.currentCommandName;
     cli.currentCommandName = command.getCommandName(cli.currentCommandName);
-    const showSpinner = cli.getSettingWithDefaultValue(settingsNames.showSpinner, true) && args.options.output !== 'none';
-    // don't show spinner if running tests
-    /* c8 ignore next 3 */
-    if (showSpinner && typeof global.it === 'undefined') {
-        cli.spinner.start();
-    }
     const startCommand = process.hrtime.bigint();
     try {
         await command.action(logger, args);
@@ -207,10 +242,6 @@ async function executeCommand(command, args) {
     finally {
         // restore the original command name
         cli.currentCommandName = parentCommandName;
-        /* c8 ignore next 3 */
-        if (cli.spinner.isSpinning) {
-            cli.spinner.stop();
-        }
         const endCommand = process.hrtime.bigint();
         timings.command.push(Number(endCommand - startCommand));
     }
@@ -361,12 +392,14 @@ async function loadCommandFromFile(commandFileUrl) {
     catch { }
 }
 function getCommandInfo(command, filePath = '', helpFilePath = '') {
+    const options = command.schema ? zod.schemaToOptions(command.schema) : getCommandOptions(command);
+    command.optionsInfo = options;
     return {
         aliases: command.alias(),
         name: command.name,
         description: command.description,
         command: command,
-        options: getCommandOptions(command),
+        options,
         defaultProperties: command.defaultProperties(),
         file: filePath,
         help: helpFilePath
@@ -401,36 +434,43 @@ function getCommandOptions(command) {
     return options;
 }
 function getCommandOptionsFromArgs(args, commandInfo) {
-    const minimistOptions = {
-        alias: {}
+    const yargsOptions = {
+        alias: {},
+        configuration: yargsConfiguration
     };
     let argsToParse = args;
     if (commandInfo) {
-        const commandTypes = commandInfo.command.types;
-        if (commandTypes) {
-            minimistOptions.string = commandTypes.string;
-            // minimist will parse unused boolean options to 'false' (unused options => options that are not included in the args)
-            // But in the CLI booleans are nullable. They can can be true, false or undefined.
-            // For this reason we only pass boolean types that are actually used as arg.
-            minimistOptions.boolean = commandTypes.boolean.filter(optionName => args.some(arg => `--${optionName}` === arg || `-${optionName}` === arg));
-        }
-        minimistOptions.alias = {};
+        if (commandInfo.command.schema) {
+            yargsOptions.string = commandInfo.options.filter(o => o.type === 'string').map(o => o.name);
+            yargsOptions.boolean = commandInfo.options.filter(o => o.type === 'boolean').map(o => o.name);
+            yargsOptions.number = commandInfo.options.filter(o => o.type === 'number').map(o => o.name);
+            argsToParse = getRewrittenArgs(args, yargsOptions.boolean);
+        }
+        else {
+            const commandTypes = commandInfo.command.types;
+            if (commandTypes) {
+                yargsOptions.string = commandTypes.string;
+                // minimist will parse unused boolean options to 'false' (unused options => options that are not included in the args)
+                // But in the CLI booleans are nullable. They can can be true, false or undefined.
+                // For this reason we only pass boolean types that are actually used as arg.
+                yargsOptions.boolean = commandTypes.boolean.filter(optionName => args.some(arg => `--${optionName}` === arg || `-${optionName}` === arg));
+            }
+            argsToParse = getRewrittenArgs(args, commandTypes.boolean);
+        }
         commandInfo.options.forEach(option => {
             if (option.short && option.long) {
-                minimistOptions.alias[option.short] = option.long;
+                yargsOptions.alias[option.long] = option.short;
             }
         });
-        argsToParse = getRewrittenArgs(args, commandTypes);
     }
-    return minimist(argsToParse, minimistOptions);
+    return yargs(argsToParse, yargsOptions);
 }
 /**
  * Rewrites arguments (if necessary) before passing them into minimist.
  * Currently only boolean values are checked and fixed.
  * Args are only checked and rewritten if the option has been added to the 'types.boolean' array.
  */
-function getRewrittenArgs(args, commandTypes) {
-    const booleanTypes = commandTypes.boolean;
+function getRewrittenArgs(args, booleanTypes) {
     if (booleanTypes.length === 0) {
         return args;
     }
@@ -736,6 +776,9 @@ async function closeWithError(error, args, showHelpIfEnabled = false) {
         return process.exit(exitCode);
     }
     let errorMessage = error instanceof CommandError ? error.message : error;
+    if (error instanceof ZodError) {
+        errorMessage = error.errors.map(e => `${e.path.join('.')}: ${e.message}`).join(os.EOL);
+    }
     if ((!args.options.output || args.options.output === 'json') &&
         !cli.getSettingWithDefaultValue(settingsNames.printErrorsAsPlainText, true)) {
         errorMessage = JSON.stringify({ error: errorMessage });
@@ -758,29 +801,14 @@ async function closeWithError(error, args, showHelpIfEnabled = false) {
     /* c8 ignore next */
 }
 function log(message, ...optionalParams) {
-    const spinnerSpinning = cli.spinner.isSpinning;
-    /* c8 ignore next 3 */
-    if (spinnerSpinning) {
-        cli.spinner.stop();
-    }
     if (message) {
         console.log(message, ...optionalParams);
     }
     else {
         console.log();
     }
-    // Restart the spinner if it was running before the log
-    /* c8 ignore next 3 */
-    if (spinnerSpinning) {
-        cli.spinner.start();
-    }
 }
 async function error(message, ...optionalParams) {
-    const spinnerSpinning = cli.spinner.isSpinning;
-    /* c8 ignore next 3 */
-    if (spinnerSpinning) {
-        cli.spinner.stop();
-    }
     const errorOutput = cli.getSettingWithDefaultValue(settingsNames.errorOutput, 'stderr');
     if (errorOutput === 'stdout') {
         console.log(message, ...optionalParams);
@@ -788,40 +816,25 @@ async function error(message, ...optionalParams) {
     else {
         console.error(message, ...optionalParams);
     }
-    // Restart the spinner if it was running before the log
-    /* c8 ignore next 3 */
-    if (spinnerSpinning) {
-        cli.spinner.start();
-    }
+}
+async function promptForValue(optionInfo) {
+    return optionInfo.autocomplete !== undefined
+        ? await prompt.forSelection({
+            message: `${optionInfo.name}: `,
+            choices: optionInfo.autocomplete.map((choice) => {
+                return { name: choice, value: choice };
+            })
+        })
+        : await prompt.forInput({ message: `${optionInfo.name}: ` });
 }
 async function promptForSelection(config) {
-    const spinnerSpinning = cli.spinner.isSpinning;
-    /* c8 ignore next 3 */
-    if (spinnerSpinning) {
-        cli.spinner.stop();
-    }
     const answer = await prompt.forSelection(config);
     await cli.error('');
-    // Restart the spinner if it was running before the prompt
-    /* c8 ignore next 3 */
-    if (spinnerSpinning) {
-        cli.spinner.start();
-    }
     return answer;
 }
 async function promptForConfirmation(config) {
-    const spinnerSpinning = cli.spinner.isSpinning;
-    /* c8 ignore next 3 */
-    if (spinnerSpinning) {
-        cli.spinner.stop();
-    }
     const answer = await prompt.forConfirmation(config);
     await cli.error('');
-    // Restart the spinner if it was running before the prompt
-    /* c8 ignore next 3 */
-    if (spinnerSpinning) {
-        cli.spinner.start();
-    }
     return answer;
 }
 async function handleMultipleResultsFound(message, values) {
@@ -834,13 +847,6 @@ async function handleMultipleResultsFound(message, values) {
     const response = await cli.promptForSelection({ message: `Please choose one:`, choices });
     return values[response];
 }
-function removeShortOptions(args) {
-    const filteredArgs = JSON.parse(JSON.stringify(args));
-    const optionsToRemove = Object.getOwnPropertyNames(args.options)
-        .filter(option => option.length === 1 || option === '--');
-    optionsToRemove.forEach(option => delete filteredArgs.options[option]);
-    return filteredArgs;
-}
 function loadOptionValuesFromFiles(args) {
     const optionNames = Object.getOwnPropertyNames(args.options);
     optionNames.forEach(option => {
@@ -885,14 +891,8 @@ export const cli = {
     printAvailableCommands,
     promptForConfirmation,
     promptForSelection,
+    promptForValue,
     shouldTrimOutput,
-    spinner
-};
-const spinnerOptions = {
-    text: 'Running command...',
-    /* c8 ignore next 1 */
-    stream: cli.getSettingWithDefaultValue('errorOutput', 'stderr') === 'stderr' ? process.stderr : process.stdout,
-    discardStdin: false
+    yargsConfiguration
 };
-cli.spinner = ora(spinnerOptions);
 //# sourceMappingURL=cli.js.map