@pnp/cli-microsoft365 7.8.0-beta.3152fc7 → 7.8.0-beta.5f64790

package/dist/cli/cli.js

@@ -17,7 +17,7 @@ import { md } from '../utils/md.js';
 import { validation } from '../utils/validation.js';
 import { prompt } from '../utils/prompt.js';
 import { timings } from './timings.js';
-import chalk from 'chalk';
+import { browserUtil } from '../utils/browserUtil.js';
 const require = createRequire(import.meta.url);
 const __dirname = fileURLToPath(new URL('.', import.meta.url));
 let _config;
@@ -35,7 +35,9 @@ let commandToExecute;
 let currentCommandName;
 let optionsFromArgs;
 const defaultHelpMode = 'options';
+const defaultHelpTarget = 'console';
 const helpModes = ['options', 'examples', 'remarks', 'response', 'full'];
+const helpTargets = ['console', 'web'];
 function getConfig() {
     if (!_config) {
         _config = new Configstore(config.configstoreName);
@@ -551,10 +553,17 @@ async function printHelp(helpMode, exitCode = 0) {
     const properties = {};
     if (cli.commandToExecute) {
         properties.command = cli.commandToExecute.name;
-        printCommandHelp(helpMode);
+        const helpTarget = getSettingWithDefaultValue(settingsNames.helpTarget, defaultHelpTarget);
+        if (helpTarget === 'web') {
+            await openHelpInBrowser();
+        }
+        else {
+            printCommandHelp(helpMode);
+        }
     }
     else {
         if (cli.currentCommandName && !cli.commands.some(command => command.name.startsWith(cli.currentCommandName))) {
+            const chalk = (await import('chalk')).default;
             await cli.error(chalk.red(`Command '${cli.currentCommandName}' was not found. Below you can find the commands and command groups you can use. For detailed information on a command group, use 'm365 [command group] --help'.`));
         }
         cli.log();
@@ -567,6 +576,11 @@ async function printHelp(helpMode, exitCode = 0) {
     telemetry.trackEvent('help', properties);
     process.exit(exitCode);
 }
+async function openHelpInBrowser() {
+    const pathChunks = cli.commandToExecute.help?.replace(/\\/g, '/').replace(/\.[^/.]+$/, '');
+    const onlineUrl = `https://pnp.github.io/cli-microsoft365/cmd/${pathChunks}`;
+    await browserUtil.open(onlineUrl);
+}
 function printCommandHelp(helpMode) {
     const docsRootDir = path.join(__dirname, '..', '..', 'docs');
     const helpFilePath = path.join(docsRootDir, 'docs', 'cmd', cli.commandToExecute.help);
@@ -721,13 +735,13 @@ async function closeWithError(error, args, showHelpIfEnabled = false) {
     if (args.options.output === 'none') {
         return process.exit(exitCode);
     }
-    const chalk = (await import('chalk')).default;
     let errorMessage = error instanceof CommandError ? error.message : error;
     if ((!args.options.output || args.options.output === 'json') &&
         !cli.getSettingWithDefaultValue(settingsNames.printErrorsAsPlainText, true)) {
         errorMessage = JSON.stringify({ error: errorMessage });
     }
     else {
+        const chalk = (await import('chalk')).default;
         errorMessage = chalk.red(`Error: ${errorMessage}`);
     }
     if (error instanceof CommandError && error.code) {
@@ -735,7 +749,7 @@ async function closeWithError(error, args, showHelpIfEnabled = false) {
     }
     await cli.error(errorMessage);
     if (showHelpIfEnabled &&
-        await cli.getSettingWithDefaultValue(settingsNames.showHelpOnFailure, showHelpIfEnabled)) {
+        cli.getSettingWithDefaultValue(settingsNames.showHelpOnFailure, showHelpIfEnabled)) {
         await printHelp(await getHelpMode(args.options), exitCode);
     }
     else {
@@ -865,6 +879,7 @@ export const cli = {
     getSettingWithDefaultValue,
     handleMultipleResultsFound,
     helpModes,
+    helpTargets,
     loadAllCommandsInfo,
     loadCommandFromArgs,
     loadCommandFromFile,

package/dist/index.js

@@ -1,17 +1,18 @@
 #!/usr/bin/env node
 import { cli } from './cli/cli.js';
 import { app } from './utils/app.js';
-// required to make console.log() in combination with piped output synchronous
-// on Windows/in PowerShell so that the output is not trimmed by calling
-// process.exit() after executing the command, while the output is still
-// being processed; https://github.com/pnp/cli-microsoft365/issues/1266
-if (process.stdout._handle) {
-    process.stdout._handle.setBlocking(true);
-}
-if (!process.env.CLIMICROSOFT365_NOUPDATE) {
-    import('update-notifier').then(updateNotifier => {
+(async () => {
+    // required to make console.log() in combination with piped output synchronous
+    // on Windows/in PowerShell so that the output is not trimmed by calling
+    // process.exit() after executing the command, while the output is still
+    // being processed; https://github.com/pnp/cli-microsoft365/issues/1266
+    if (process.stdout._handle) {
+        process.stdout._handle.setBlocking(true);
+    }
+    if (!process.env.CLIMICROSOFT365_NOUPDATE) {
+        const updateNotifier = await import('update-notifier');
         updateNotifier.default({ pkg: app.packageJson() }).notify({ defer: false });
-    });
-}
-cli.execute(process.argv.slice(2));
+    }
+    await cli.execute(process.argv.slice(2));
+})();
 //# sourceMappingURL=index.js.map

package/dist/m365/cli/commands/config/config-set.js

@@ -87,6 +87,10 @@ _a = CliConfigSetCommand, _CliConfigSetCommand_instances = new WeakSet(), _CliCo
             allowedAuthTypes.indexOf(args.options.value) === -1) {
             return `${args.options.value} is not a valid value for the option ${args.options.key}. Allowed values: ${allowedAuthTypes.join(', ')}`;
         }
+        if (args.options.key === settingsNames.helpTarget &&
+            !cli.helpTargets.includes(args.options.value)) {
+            return `${args.options.value} is not a valid value for the option ${args.options.key}. Allowed values: ${cli.helpTargets.join(', ')}`;
+        }
         return true;
     });
 };

package/dist/m365/commands/setup.js

@@ -35,9 +35,9 @@ class SetupCommand extends AnonymousCommand {
             }
             else if (args.options.scripting) {
                 Object.assign(settings, scriptingPreset);
-            }
-            if (pid.isPowerShell()) {
-                Object.assign(settings, powerShellPreset);
+                if (pid.isPowerShell()) {
+                    Object.assign(settings, powerShellPreset);
+                }
             }
             await this.configureSettings(settings, true, logger);
             return;

package/dist/m365/entra/commands/m365group/m365group-add.js

@@ -189,6 +189,7 @@ class EntraM365GroupAddCommand extends GraphCommand {
 _EntraM365GroupAddCommand_instances = new WeakSet(), _EntraM365GroupAddCommand_initTelemetry = function _EntraM365GroupAddCommand_initTelemetry() {
     this.telemetry.push((args) => {
         Object.assign(this.telemetryProperties, {
+            description: typeof args.options.description !== 'undefined',
             owners: typeof args.options.owners !== 'undefined',
             members: typeof args.options.members !== 'undefined',
             logoPath: typeof args.options.logoPath !== 'undefined',
@@ -202,10 +203,10 @@ _EntraM365GroupAddCommand_instances = new WeakSet(), _EntraM365GroupAddCommand_i
 }, _EntraM365GroupAddCommand_initOptions = function _EntraM365GroupAddCommand_initOptions() {
     this.options.unshift({
         option: '-n, --displayName <displayName>'
-    }, {
-        option: '-d, --description <description>'
     }, {
         option: '-m, --mailNickname <mailNickname>'
+    }, {
+        option: '-d, --description [description]'
     }, {
         option: '--owners [owners]'
     }, {
@@ -229,6 +230,7 @@ _EntraM365GroupAddCommand_instances = new WeakSet(), _EntraM365GroupAddCommand_i
         option: '-l, --logoPath [logoPath]'
     });
 }, _EntraM365GroupAddCommand_initTypes = function _EntraM365GroupAddCommand_initTypes() {
+    this.types.string.push('displayName', 'mailNickname', 'description', 'owners', 'members', 'visibility', 'logoPath');
     this.types.boolean.push('allowMembersToPost', 'hideGroupInOutlook', 'subscribeNewGroupMembers', 'welcomeEmailDisabled');
 }, _EntraM365GroupAddCommand_initValidators = function _EntraM365GroupAddCommand_initValidators() {
     this.validators.push(async (args) => {

package/dist/m365/flow/commands/run/run-list.js

@@ -4,6 +4,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _FlowRunListCommand_instances, _FlowRunListCommand_initTelemetry, _FlowRunListCommand_initOptions, _FlowRunListCommand_initValidators;
+import request from '../../../../request.js';
 import { formatting } from '../../../../utils/formatting.js';
 import { odata } from '../../../../utils/odata.js';
 import { validation } from '../../../../utils/validation.js';
@@ -38,6 +39,9 @@ class FlowRunListCommand extends PowerAutomateCommand {
         }
         try {
             const items = await odata.getAllItems(url);
+            if (args.options.withTrigger) {
+                await this.retrieveTriggerInformation(items);
+            }
             if (args.options.output !== 'json' && items.length > 0) {
                 items.forEach(i => {
                     i.startTime = i.properties.startTime;
@@ -63,6 +67,21 @@ class FlowRunListCommand extends PowerAutomateCommand {
         }
         return filters;
     }
+    async retrieveTriggerInformation(items) {
+        const tasks = items.map(async (item) => {
+            const requestOptions = {
+                url: item.properties.trigger.outputsLink.uri,
+                headers: {
+                    accept: 'application/json',
+                    'x-anonymous': true
+                },
+                responseType: 'json'
+            };
+            const response = await request.get(requestOptions);
+            item.triggerInformation = response.body;
+        });
+        await Promise.all(tasks);
+    }
 }
 _FlowRunListCommand_instances = new WeakSet(), _FlowRunListCommand_initTelemetry = function _FlowRunListCommand_initTelemetry() {
     this.telemetry.push((args) => {
@@ -70,6 +89,7 @@ _FlowRunListCommand_instances = new WeakSet(), _FlowRunListCommand_initTelemetry
             status: typeof args.options.status !== 'undefined',
             triggerStartTime: typeof args.options.triggerStartTime !== 'undefined',
             triggerEndTime: typeof args.options.triggerEndTime !== 'undefined',
+            withTrigger: !!args.options.withTrigger,
             asAdmin: !!args.options.asAdmin
         });
     });
@@ -85,6 +105,8 @@ _FlowRunListCommand_instances = new WeakSet(), _FlowRunListCommand_initTelemetry
         option: '--triggerStartTime [triggerStartTime]'
     }, {
         option: '--triggerEndTime [triggerEndTime]'
+    }, {
+        option: '--withTrigger'
     }, {
         option: '--asAdmin'
     });
@@ -102,6 +124,9 @@ _FlowRunListCommand_instances = new WeakSet(), _FlowRunListCommand_initTelemetry
         if (args.options.triggerEndTime && !validation.isValidISODateTime(args.options.triggerEndTime)) {
             return `'${args.options.triggerEndTime}' is not a valid datetime.`;
         }
+        if (args.options.output !== 'json' && args.options.withTrigger) {
+            return 'The --withTrigger option is only available when output is set to json';
+        }
         return true;
     });
 };

package/dist/m365/outlook/commands/message/message-list.js

@@ -3,7 +3,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     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 _OutlookMessageListCommand_instances, _OutlookMessageListCommand_initTelemetry, _OutlookMessageListCommand_initOptions, _OutlookMessageListCommand_initOptionSets;
+var _OutlookMessageListCommand_instances, _OutlookMessageListCommand_initTelemetry, _OutlookMessageListCommand_initOptions, _OutlookMessageListCommand_initValidators, _OutlookMessageListCommand_initTypes, _OutlookMessageListCommand_initOptionSets;
 import request from '../../../../request.js';
 import { formatting } from '../../../../utils/formatting.js';
 import { odata } from '../../../../utils/odata.js';
@@ -11,6 +11,9 @@ import GraphCommand from '../../../base/GraphCommand.js';
 import commands from '../../commands.js';
 import { Outlook } from '../../Outlook.js';
 import { cli } from '../../../../cli/cli.js';
+import { validation } from '../../../../utils/validation.js';
+import { accessToken } from '../../../../utils/accessToken.js';
+import auth from '../../../../Auth.js';
 class OutlookMessageListCommand extends GraphCommand {
     get name() {
         return commands.MESSAGE_LIST;
@@ -23,6 +26,8 @@ class OutlookMessageListCommand extends GraphCommand {
         _OutlookMessageListCommand_instances.add(this);
         __classPrivateFieldGet(this, _OutlookMessageListCommand_instances, "m", _OutlookMessageListCommand_initTelemetry).call(this);
         __classPrivateFieldGet(this, _OutlookMessageListCommand_instances, "m", _OutlookMessageListCommand_initOptions).call(this);
+        __classPrivateFieldGet(this, _OutlookMessageListCommand_instances, "m", _OutlookMessageListCommand_initValidators).call(this);
+        __classPrivateFieldGet(this, _OutlookMessageListCommand_instances, "m", _OutlookMessageListCommand_initTypes).call(this);
         __classPrivateFieldGet(this, _OutlookMessageListCommand_instances, "m", _OutlookMessageListCommand_initOptionSets).call(this);
     }
     defaultProperties() {
@@ -30,27 +35,44 @@ class OutlookMessageListCommand extends GraphCommand {
     }
     async commandAction(logger, args) {
         try {
-            const folderId = await this.getFolderId(args);
-            const url = folderId ? `me/mailFolders/${folderId}/messages` : 'me/messages';
-            const messages = await odata.getAllItems(`${this.resource}/v1.0/${url}?$top=50`);
+            if (!args.options.userId && !args.options.userName && accessToken.isAppOnlyAccessToken(auth.connection.accessTokens[auth.defaultResource].accessToken)) {
+                throw 'You must specify either the userId or userName option when using app-only permissions.';
+            }
+            const userUrl = args.options.userId || args.options.userName ? `users/${args.options.userId || formatting.encodeQueryParameter(args.options.userName)}` : 'me';
+            const folderId = await this.getFolderId(userUrl, args.options);
+            const folderUrl = folderId ? `/mailFolders/${folderId}` : '';
+            let requestUrl = `${this.resource}/v1.0/${userUrl}${folderUrl}/messages?$top=100`;
+            if (args.options.startTime || args.options.endTime) {
+                const filters = [];
+                if (args.options.startTime) {
+                    filters.push(`receivedDateTime ge ${args.options.startTime}`);
+                }
+                if (args.options.endTime) {
+                    filters.push(`receivedDateTime lt ${args.options.endTime}`);
+                }
+                if (filters.length > 0) {
+                    requestUrl += `&$filter=${filters.join(' and ')}`;
+                }
+            }
+            const messages = await odata.getAllItems(requestUrl);
             await logger.log(messages);
         }
         catch (err) {
             this.handleRejectedODataJsonPromise(err);
         }
     }
-    async getFolderId(args) {
-        if (!args.options.folderId && !args.options.folderName) {
+    async getFolderId(userUrl, options) {
+        if (!options.folderId && !options.folderName) {
             return '';
         }
-        if (args.options.folderId) {
-            return args.options.folderId;
+        if (options.folderId) {
+            return options.folderId;
         }
-        if (Outlook.wellKnownFolderNames.indexOf(args.options.folderName) > -1) {
-            return args.options.folderName;
+        if (Outlook.wellKnownFolderNames.includes(options.folderName.toLowerCase())) {
+            return options.folderName;
         }
         const requestOptions = {
-            url: `${this.resource}/v1.0/me/mailFolders?$filter=displayName eq '${formatting.encodeQueryParameter(args.options.folderName)}'&$select=id`,
+            url: `${this.resource}/v1.0/${userUrl}/mailFolders?$filter=displayName eq '${formatting.encodeQueryParameter(options.folderName)}'&$select=id`,
             headers: {
                 accept: 'application/json;odata.metadata=none'
             },
@@ -58,11 +80,11 @@ class OutlookMessageListCommand extends GraphCommand {
         };
         const response = await request.get(requestOptions);
         if (response.value.length === 0) {
-            throw `Folder with name '${args.options.folderName}' not found`;
+            throw `Folder with name '${options.folderName}' not found`;
         }
         if (response.value.length > 1) {
             const resultAsKeyValuePair = formatting.convertArrayToHashTable('id', response.value);
-            const result = await cli.handleMultipleResultsFound(`Multiple folders with name '${args.options.folderName}' found.`, resultAsKeyValuePair);
+            const result = await cli.handleMultipleResultsFound(`Multiple folders with name '${options.folderName}' found.`, resultAsKeyValuePair);
             return result.id;
         }
         return response.value[0].id;
@@ -72,7 +94,11 @@ _OutlookMessageListCommand_instances = new WeakSet(), _OutlookMessageListCommand
     this.telemetry.push((args) => {
         Object.assign(this.telemetryProperties, {
             folderId: typeof args.options.folderId !== 'undefined',
-            folderName: typeof args.options.folderName !== 'undefined'
+            folderName: typeof args.options.folderName !== 'undefined',
+            startTime: typeof args.options.startTime !== 'undefined',
+            endTime: typeof args.options.endTime !== 'undefined',
+            userId: typeof args.options.userId !== 'undefined',
+            userName: typeof args.options.userName !== 'undefined'
         });
     });
 }, _OutlookMessageListCommand_initOptions = function _OutlookMessageListCommand_initOptions() {
@@ -80,11 +106,55 @@ _OutlookMessageListCommand_instances = new WeakSet(), _OutlookMessageListCommand
         option: '--folderName [folderName]',
         autocomplete: Outlook.wellKnownFolderNames
     }, {
-        option: '--folderId [folderId]',
-        autocomplete: Outlook.wellKnownFolderNames
+        option: '--folderId [folderId]'
+    }, {
+        option: '--startTime [startTime]'
+    }, {
+        option: '--endTime [endTime]'
+    }, {
+        option: '--userId [userId]'
+    }, {
+        option: '--userName [userName]'
     });
+}, _OutlookMessageListCommand_initValidators = function _OutlookMessageListCommand_initValidators() {
+    this.validators.push(async (args) => {
+        if (args.options.startTime) {
+            if (!validation.isValidISODateTime(args.options.startTime)) {
+                return `'${args.options.startTime}' is not a valid ISO date string for option startTime.`;
+            }
+            if (new Date(args.options.startTime) > new Date()) {
+                return 'startTime value cannot be in the future.';
+            }
+        }
+        if (args.options.endTime) {
+            if (!validation.isValidISODateTime(args.options.endTime)) {
+                return `'${args.options.endTime}' is not a valid ISO date string for option endTime.`;
+            }
+            if (new Date(args.options.endTime) > new Date()) {
+                return 'endTime value cannot be in the future.';
+            }
+        }
+        if (args.options.startTime && args.options.endTime && new Date(args.options.startTime) >= new Date(args.options.endTime)) {
+            return 'startTime must be before endTime.';
+        }
+        if (args.options.userId && !validation.isValidGuid(args.options.userId)) {
+            return `${args.options.userId} is not a valid GUID for option userId.`;
+        }
+        if (args.options.userName && !validation.isValidUserPrincipalName(args.options.userName)) {
+            return `${args.options.userName} is not a valid UPN for option userName.`;
+        }
+        return true;
+    });
+}, _OutlookMessageListCommand_initTypes = function _OutlookMessageListCommand_initTypes() {
+    this.types.string.push('folderName', 'folderId', 'startTime', 'endTime', 'userId', 'userName');
 }, _OutlookMessageListCommand_initOptionSets = function _OutlookMessageListCommand_initOptionSets() {
-    this.optionSets.push({ options: ['folderId', 'folderName'] });
+    this.optionSets.push({
+        options: ['folderId', 'folderName'],
+        runsWhen: (args) => args.options.folderId || args.options.folderName
+    }, {
+        options: ['userId', 'userName'],
+        runsWhen: (args) => args.options.userId || args.options.userName
+    });
 };
 export default new OutlookMessageListCommand();
 //# sourceMappingURL=message-list.js.map

package/dist/m365/spo/commands/site/site-add.js

@@ -4,6 +4,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _SpoSiteAddCommand_instances, _SpoSiteAddCommand_initTelemetry, _SpoSiteAddCommand_initOptions, _SpoSiteAddCommand_initValidators;
+import { setTimeout } from 'timers/promises';
 import config from '../../../../config.js';
 import request from '../../../../request.js';
 import { formatting } from '../../../../utils/formatting.js';
@@ -198,19 +199,14 @@ class SpoSiteAddCommand extends SpoCommand {
             if ((!args.options.wait && !args.options.withAppCatalog) || isComplete) {
                 return args.options.url;
             }
-            await new Promise((resolve, reject) => {
-                setTimeout(() => {
-                    spo.waitUntilFinished({
-                        operationId: JSON.stringify(operation._ObjectIdentity_),
-                        siteUrl: this.spoAdminUrl,
-                        resolve,
-                        reject,
-                        logger,
-                        currentContext: this.context,
-                        verbose: this.verbose,
-                        debug: this.debug
-                    });
-                }, operation.PollingInterval);
+            await setTimeout(operation.PollingInterval);
+            await spo.waitUntilFinished({
+                operationId: JSON.stringify(operation._ObjectIdentity_),
+                siteUrl: this.spoAdminUrl,
+                logger,
+                currentContext: this.context,
+                verbose: this.verbose,
+                debug: this.debug
             });
             return args.options.url;
         }
@@ -291,19 +287,14 @@ class SpoSiteAddCommand extends SpoCommand {
         if (!wait || isComplete) {
             return;
         }
-        await new Promise((resolve, reject) => {
-            setTimeout(() => {
-                spo.waitUntilFinished({
-                    operationId: JSON.stringify(operation._ObjectIdentity_),
-                    siteUrl: this.spoAdminUrl,
-                    resolve,
-                    reject,
-                    logger,
-                    currentContext: this.context,
-                    verbose: this.verbose,
-                    debug: this.debug
-                });
-            }, operation.PollingInterval);
+        await setTimeout(operation.PollingInterval);
+        await spo.waitUntilFinished({
+            operationId: JSON.stringify(operation._ObjectIdentity_),
+            siteUrl: this.spoAdminUrl,
+            logger,
+            currentContext: this.context,
+            verbose: this.verbose,
+            debug: this.debug
         });
     }
     async addAppCatalog(url, logger) {