@pnp/cli-microsoft365 7.7.0-beta.7b57cf9 → 7.7.0-beta.7d3ef49

package/dist/cli/cli.js

@@ -17,6 +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';
 const require = createRequire(import.meta.url);
 const __dirname = fileURLToPath(new URL('.', import.meta.url));
 let _config;
@@ -96,7 +97,7 @@ async function execute(rawArgs) {
         parsedArgs.h ||
         parsedArgs.help) {
         if (parsedArgs.output !== 'none') {
-            printHelp(await getHelpMode(parsedArgs));
+            await printHelp(await getHelpMode(parsedArgs));
         }
         return;
     }
@@ -546,13 +547,16 @@ function getFirstNonUndefinedArrayItem(arr) {
     }
     return undefined;
 }
-function printHelp(helpMode, exitCode = 0) {
+async function printHelp(helpMode, exitCode = 0) {
     const properties = {};
     if (cli.commandToExecute) {
         properties.command = cli.commandToExecute.name;
         printCommandHelp(helpMode);
     }
     else {
+        if (cli.currentCommandName && !cli.commands.some(command => command.name.startsWith(cli.currentCommandName))) {
+            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();
         cli.log(`CLI for Microsoft 365 v${app.packageJson().version}`);
         cli.log(`${app.packageJson().description} `);
@@ -732,7 +736,7 @@ async function closeWithError(error, args, showHelpIfEnabled = false) {
     await cli.error(errorMessage);
     if (showHelpIfEnabled &&
         await cli.getSettingWithDefaultValue(settingsNames.showHelpOnFailure, showHelpIfEnabled)) {
-        printHelp(await getHelpMode(args.options), exitCode);
+        await printHelp(await getHelpMode(args.options), exitCode);
     }
     else {
         process.exit(exitCode);
@@ -875,7 +879,8 @@ export const cli = {
 const spinnerOptions = {
     text: 'Running command...',
     /* c8 ignore next 1 */
-    stream: cli.getSettingWithDefaultValue('errorOutput', 'stderr') === 'stderr' ? process.stderr : process.stdout
+    stream: cli.getSettingWithDefaultValue('errorOutput', 'stderr') === 'stderr' ? process.stderr : process.stdout,
+    discardStdin: false
 };
 cli.spinner = ora(spinnerOptions);
 //# sourceMappingURL=cli.js.map

package/dist/m365/entra/commands/user/user-list.js

@@ -31,17 +31,22 @@ class EntraUserListCommand extends GraphCommand {
     async commandAction(logger, args) {
         await this.showDeprecationWarning(logger, aadCommands.USER_LIST, commands.USER_LIST);
         try {
+            const selectProperties = args.options.properties ? args.options.properties : 'id,displayName,mail,userPrincipalName';
+            const allSelectProperties = selectProperties.split(',');
+            const propertiesWithSlash = allSelectProperties.filter(item => item.includes('/'));
+            const fieldExpand = propertiesWithSlash
+                .map(p => `${p.split('/')[0]}($select=${p.split('/')[1]})`)
+                .join(',');
+            const expandParam = fieldExpand.length > 0 ? `&$expand=${fieldExpand}` : '';
+            const selectParam = allSelectProperties.filter(item => !item.includes('/'));
             let filter = '';
-            const properties = args.options.properties ?
-                args.options.properties.split(',').map(p => p.trim()) :
-                ['userPrincipalName', 'displayName'];
             try {
                 filter = this.getFilter(args.options);
             }
             catch (ex) {
                 throw ex;
             }
-            const url = `${this.resource}/v1.0/users?$select=${properties.join(',')}${(filter.length > 0 ? '&' + filter : '')}&$top=100`;
+            const url = `${this.resource}/v1.0/users?$select=${selectParam}${expandParam}${(filter.length > 0 ? '&' + filter : '')}&$top=100`;
             const users = await odata.getAllItems(url);
             await logger.log(users);
         }
@@ -52,6 +57,7 @@ class EntraUserListCommand extends GraphCommand {
     getFilter(options) {
         const filters = {};
         const excludeOptions = [
+            'type',
             'properties',
             'p',
             'd',
@@ -72,7 +78,10 @@ class EntraUserListCommand extends GraphCommand {
         });
         let filter = Object.keys(filters).map(key => `startsWith(${key}, '${filters[key]}')`).join(' and ');
         if (filter.length > 0) {
-            filter = '$filter=' + filter;
+            filter = `$filter=${filter}`;
+        }
+        if (options.type) {
+            filter += filter.length > 0 ? ` and userType eq '${options.type}'` : `$filter=userType eq '${options.type}'`;
         }
         return filter;
     }
@@ -80,11 +89,15 @@ class EntraUserListCommand extends GraphCommand {
 _EntraUserListCommand_instances = new WeakSet(), _EntraUserListCommand_initTelemetry = function _EntraUserListCommand_initTelemetry() {
     this.telemetry.push((args) => {
         Object.assign(this.telemetryProperties, {
-            properties: args.options.properties
+            type: typeof args.options.type !== 'undefined',
+            properties: typeof args.options.properties !== 'undefined'
         });
     });
 }, _EntraUserListCommand_initOptions = function _EntraUserListCommand_initOptions() {
-    this.options.unshift({ option: '-p, --properties [properties]' });
+    this.options.unshift({
+        option: "--type [type]",
+        autocomplete: ["Member", "Guest"]
+    }, { option: '-p, --properties [properties]' });
 };
 export default new EntraUserListCommand();
 //# sourceMappingURL=user-list.js.map

package/docs/docs/cmd/entra/user/user-list.mdx

@@ -21,6 +21,9 @@ m365 aad user list [options]
 ## Options
 
 ```md definition-list
+`--type [type]`
+: Filter the results to only users of a given type: `Member` or `Guest`. By default, all users are listed.
+
 `-p, --properties [properties]`
 : Comma-separated list of properties to retrieve
 ```
@@ -29,7 +32,9 @@ m365 aad user list [options]
 
 ## Remarks
 
-Using the `--properties` option, you can specify a comma-separated list of user properties to retrieve from the Microsoft Graph. If you don't specify any properties, the command will retrieve user's display name and account name.
+Using the `--properties` option, you can specify a comma-separated list of user properties to retrieve from the Microsoft Graph. If you don't specify any properties, the command will retrieve user's display name, account name, id, and mail.
+
+When the `properties` option includes values with a `/`, for example: `manager/displayName`, an additional `$expand` query parameter will be included on `manager`.
 
 To filter the list of users, include additional options that match the user property that you want to filter with. For example `--displayName Patt` will return all users whose `displayName` starts with `Patt`. Multiple filters will be combined using the `and` operator.
 
@@ -37,30 +42,42 @@ Certain properties cannot be returned within a user collection. The following pr
 
 ## Examples
 
-List all users in the tenant
+List all users in the tenant.
 
 ```sh
 m365 entra user list
 ```
 
-List all users in the tenant. For each one return the display name and e-mail address
+List all guest users in the tenant.
+
+```sh
+m365 entra user list --type Guest
+```
+
+List all users in the tenant. For each one return the display name and e-mail address.
 
 ```sh
 m365 entra user list --properties "displayName,mail"
 ```
 
-Show users whose display name starts with _Patt_
+Show users whose display name starts with _Patt_.
 
 ```sh
 m365 entra user list --displayName Patt
 ```
 
-Show all account managers whose display name starts with _Patt_
+Show all account managers whose display name starts with _Patt_.
 
 ```sh
 m365 entra user list --displayName Patt --jobTitle 'Account manager'
 ```
 
+List users from the tenant. For each one return the display name, e-mail address, and manager information.
+
+```sh
+m365 entra user list --properties "displayName,mail,manager/*"
+```
+
 ## Response
 
 <Tabs>
@@ -69,8 +86,10 @@ m365 entra user list --displayName Patt --jobTitle 'Account manager'
   ```json
   [
     {
-      "userPrincipalName": "John@contoso.onmicrosoft.com",
-      "displayName": "John Doe"
+      "id": "1f5595b2-aa07-445d-9801-a45ea18160b2",
+      "displayName": "John Doe",
+      "mail": "John@contoso.onmicrosoft.com",
+      "userPrincipalName": "John@contoso.onmicrosoft.com"
     }
   ]
   ```
@@ -79,17 +98,17 @@ m365 entra user list --displayName Patt --jobTitle 'Account manager'
   <TabItem value="Text">
 
   ```text
-  userPrincipalName                         displayName
-  ----------------------------------------  -------------------------
-  John@contoso.onmicrosoft.com              John Doe
+  id                                    displayName         mail                                 userPrincipalName
+  ------------------------------------  ------------------  -----------------------------------  ------------------------------------------
+  1f5595b2-aa07-445d-9801-a45ea18160b2  John Doe            John@contoso.onmicrosoft.com         John@contoso.onmicrosoft.com
   ```
 
   </TabItem>
   <TabItem value="CSV">
 
   ```csv
-  userPrincipalName,displayName
-  John@contoso.onmicrosoft.com,John Doe
+  id,displayName,mail,userPrincipalName
+  1f5595b2-aa07-445d-9801-a45ea18160b2,John Doe,John@contoso.onmicrosoft.com,John@contoso.onmicrosoft.com
   ```
 
   </TabItem>
@@ -100,12 +119,14 @@ m365 entra user list --displayName Patt --jobTitle 'Account manager'
 
   Date: 2023-06-02
 
-  ## John Doe
+  ## John Doe (1f5595b2-aa07-445d-9801-a45ea18160b2)
 
   Property | Value
   ---------|-------
-  userPrincipalName | John@contoso.onmicrosoft.com
+  id | 1f5595b2-aa07-445d-9801-a45ea18160b2
   displayName | John Doe
+  mail | John@contoso.onmicrosoft.com
+  userPrincipalName | John@contoso.onmicrosoft.com  
   ```
 
   </TabItem>
@@ -113,4 +134,4 @@ m365 entra user list --displayName Patt --jobTitle 'Account manager'
 
 ## More information
 
-- Microsoft Graph User properties: [https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/user#properties](https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/user#properties)
+- Microsoft Graph User properties: [https://learn.microsoft.com/graph/api/resources/user?view=graph-rest-1.0#properties](https://learn.microsoft.com/graph/api/resources/user?view=graph-rest-1.0#properties)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "7.7.0-beta.7b57cf9",
+  "version": "7.7.0-beta.7d3ef49",
   "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
   "license": "MIT",
   "main": "./dist/api.js",