@pnp/cli-microsoft365 4.3.0-beta.fd397f5 → 5.0.0-beta.40b91b5

package/README.md

@@ -179,7 +179,7 @@ m365 spo site get --url https://contoso.sharepoint.com --output text
 
 ## Build
 
-To build and run this CLI locally, you will need [`node`](https://nodejs.org) `>= 14.0.0` installed.
+To build and run this CLI locally, you will need [`node`](https://nodejs.org) `>= 16.0.0` installed.
 
 ```sh
 # Clone this repository

package/dist/Utils.js

@@ -40,6 +40,9 @@ class Utils {
             }
         });
     }
+    static isValidGuidArray(guids) {
+        return guids.every(guid => this.isValidGuid(guid));
+    }
     static isValidGuid(guid) {
         const guidRegEx = new RegExp(/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i);
         return guidRegEx.test(guid);

package/dist/appInsights.js

@@ -20,7 +20,8 @@ const env = process.env.CLIMICROSOFT365_ENV !== undefined ? process.env.CLIMICRO
 appInsights.defaultClient.commonProperties = {
     version: version,
     node: process.version,
-    env: env
+    env: env,
+    ci: Boolean(process.env.CI).toString()
 };
 appInsights.defaultClient.context.tags['ai.session.id'] = crypto.randomBytes(24).toString('base64');
 appInsights.defaultClient.context.tags['ai.cloud.roleInstance'] = crypto.createHash('sha256').update(appInsights.defaultClient.context.tags['ai.cloud.roleInstance']).digest('hex');

package/dist/cli/Cli.js

@@ -17,6 +17,7 @@ const path = require("path");
 const appInsights_1 = require("../appInsights");
 const Command_1 = require("../Command");
 const config_1 = require("../config");
+const request_1 = require("../request");
 const settingsNames_1 = require("../settingsNames");
 const Utils_1 = require("../Utils");
 const packageJSON = require('../../package.json');
@@ -204,16 +205,20 @@ class Cli {
                 }
             };
             if (args.options.debug) {
-                Cli.log(`Executing command ${command.name} with options ${JSON.stringify(args)}`);
+                logErr.push(`Executing command ${command.name} with options ${JSON.stringify(args)}`);
             }
             // store the current command name, if any and set the name to the name of
             // the command to execute
             const cli = Cli.getInstance();
             const parentCommandName = cli.currentCommandName;
             cli.currentCommandName = command.getCommandName();
+            // store the current logger if any
+            const currentLogger = request_1.default.logger;
             command.action(logger, args, (err) => {
                 // restore the original command name
                 cli.currentCommandName = parentCommandName;
+                // restore the original logger
+                request_1.default.logger = currentLogger;
                 if (err) {
                     return reject({
                         error: err,
@@ -416,11 +421,11 @@ class Cli {
         if (arrayType !== 'object') {
             return logStatement.join(os.EOL);
         }
-        // if output type has been set to 'text', process the retrieved
+        // if output type has been set to 'text' or 'csv', process the retrieved
         // data so that returned objects contain only default properties specified
         // on the current command. If there is no current command or the
         // command doesn't specify default properties, return original data
-        if (options.output === 'text') {
+        if (options.output === 'text' || options.output === 'csv') {
             const cli = Cli.getInstance();
             const currentCommand = cli.commandToExecute;
             if (arrayType === 'object' &&
@@ -440,6 +445,20 @@ class Cli {
                 }
             }
         }
+        if (options.output === 'csv') {
+            const { stringify } = require('csv-stringify/sync');
+            /*
+              https://csv.js.org/stringify/options/
+              header: Display the column names on the first line if the columns option is provided or discovered.
+              escape: Single character used for escaping; only apply to characters matching the quote and the escape options default to ".
+              quote: The quote characters surrounding a field, defaults to the " (double quotation marks), an empty quote value will preserve the original field, whether it contains quotation marks or not.
+              quoted: Boolean, default to false, quote all the non-empty fields even if not required.
+              quotedEmpty: Quote empty strings and overrides quoted_string on empty strings when defined; default is false.
+            */
+            return stringify(logStatement, {
+                header: true
+            });
+        }
         // display object as a list of key-value pairs
         if (logStatement.length === 1) {
             const obj = logStatement[0];

package/dist/m365/aad/commands/o365group/{Group.js → GroupExtended.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=Group.js.map
+//# sourceMappingURL=GroupExtended.js.map

package/dist/m365/aad/commands/o365group/o365group-user-set.js

@@ -37,14 +37,14 @@ class AadO365GroupUserSetCommand extends GraphItemsListCommand_1.GraphItemsListC
                 logger.logToStderr(this.items);
                 logger.logToStderr('');
             }
-            if (this.items.filter(i => i.userPrincipalName.toLocaleLowerCase() === args.options.userName.toLocaleLowerCase()).length <= 0) {
+            if (this.items.filter(i => args.options.userName.toUpperCase() === i.userPrincipalName.toUpperCase()).length <= 0) {
                 const userNotInGroup = (typeof args.options.groupId !== 'undefined') ?
                     'The specified user does not belong to the given Microsoft 365 Group. Please use the \'o365group user add\' command to add new users.' :
                     'The specified user does not belong to the given Microsoft Teams team. Please use the \'graph teams user add\' command to add new users.';
                 throw new Error(userNotInGroup);
             }
             if (args.options.role === "Owner") {
-                const foundMember = this.items.find(e => e.userPrincipalName.toLocaleLowerCase() === args.options.userName.toLocaleLowerCase() && e.userType === 'Member');
+                const foundMember = this.items.find(e => args.options.userName.toUpperCase() === e.userPrincipalName.toUpperCase() && e.userType === 'Member');
                 if (foundMember !== undefined) {
                     const endpoint = `${this.resource}/v1.0/groups/${groupId}/owners/$ref`;
                     const requestOptions = {
@@ -65,7 +65,7 @@ class AadO365GroupUserSetCommand extends GraphItemsListCommand_1.GraphItemsListC
                 }
             }
             else {
-                const foundOwner = this.items.find(e => e.userPrincipalName.toLocaleLowerCase() === args.options.userName.toLocaleLowerCase() && e.userType === 'Owner');
+                const foundOwner = this.items.find(e => args.options.userName.toUpperCase() === e.userPrincipalName.toUpperCase() && e.userType === 'Owner');
                 if (foundOwner !== undefined) {
                     const endpoint = `${this.resource}/v1.0/groups/${groupId}/owners/${foundOwner.id}/$ref`;
                     const requestOptions = {

package/dist/m365/aad/commands/oauth2grant/oauth2grant-list.js

@@ -2,9 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const request_1 = require("../../../../request");
 const Utils_1 = require("../../../../Utils");
-const AadCommand_1 = require("../../../base/AadCommand");
+const GraphCommand_1 = require("../../../base/GraphCommand");
 const commands_1 = require("../../commands");
-class AadOAuth2GrantListCommand extends AadCommand_1.default {
+class AadOAuth2GrantListCommand extends GraphCommand_1.default {
     get name() {
         return commands_1.default.OAUTH2GRANT_LIST;
     }
@@ -19,9 +19,9 @@ class AadOAuth2GrantListCommand extends AadCommand_1.default {
             logger.logToStderr(`Retrieving list of OAuth grants for the service principal...`);
         }
         const requestOptions = {
-            url: `${this.resource}/myorganization/oauth2PermissionGrants?api-version=1.6&$filter=clientId eq '${encodeURIComponent(args.options.clientId)}'`,
+            url: `${this.resource}/v1.0/oauth2PermissionGrants?$filter=clientId eq '${encodeURIComponent(args.options.spObjectId)}'`,
             headers: {
-                accept: 'application/json;odata=nometadata'
+                accept: 'application/json;odata.metadata=none'
             },
             responseType: 'json'
         };
@@ -37,15 +37,15 @@ class AadOAuth2GrantListCommand extends AadCommand_1.default {
     options() {
         const options = [
             {
-                option: '-i, --clientId <clientId>'
+                option: '-i, --spObjectId <spObjectId>'
             }
         ];
         const parentOptions = super.options();
         return options.concat(parentOptions);
     }
     validate(args) {
-        if (!Utils_1.default.isValidGuid(args.options.clientId)) {
-            return `${args.options.clientId} is not a valid GUID`;
+        if (!Utils_1.default.isValidGuid(args.options.spObjectId)) {
+            return `${args.options.spObjectId} is not a valid GUID`;
         }
         return true;
     }

package/dist/m365/aad/commands/oauth2grant/oauth2grant-remove.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const cli_1 = require("../../../../cli");
 const request_1 = require("../../../../request");
 const GraphCommand_1 = require("../../../base/GraphCommand");
 const commands_1 = require("../../commands");
@@ -11,24 +12,47 @@ class AadOAuth2GrantRemoveCommand extends GraphCommand_1.default {
         return 'Remove specified service principal OAuth2 permissions';
     }
     commandAction(logger, args, cb) {
-        if (this.verbose) {
-            logger.logToStderr(`Removing OAuth2 permissions...`);
-        }
-        const requestOptions = {
-            url: `${this.resource}/v1.0/oauth2PermissionGrants/${encodeURIComponent(args.options.grantId)}`,
-            headers: {
-                'accept': 'application/json;odata.metadata=none'
-            },
-            responseType: 'json'
+        const removeOauth2Grant = () => {
+            if (this.verbose) {
+                logger.logToStderr(`Removing OAuth2 permissions...`);
+            }
+            const requestOptions = {
+                url: `${this.resource}/v1.0/oauth2PermissionGrants/${encodeURIComponent(args.options.grantId)}`,
+                headers: {
+                    'accept': 'application/json;odata.metadata=none'
+                },
+                responseType: 'json'
+            };
+            request_1.default
+                .delete(requestOptions)
+                .then(_ => cb(), (rawRes) => this.handleRejectedODataJsonPromise(rawRes, logger, cb));
         };
-        request_1.default
-            .delete(requestOptions)
-            .then(_ => cb(), (rawRes) => this.handleRejectedODataJsonPromise(rawRes, logger, cb));
+        if (args.options.confirm) {
+            removeOauth2Grant();
+        }
+        else {
+            cli_1.Cli.prompt({
+                type: 'confirm',
+                name: 'continue',
+                default: false,
+                message: `Are you sure you want to remove the OAuth2 permissions for ${args.options.grantId}?`
+            }, (result) => {
+                if (!result.continue) {
+                    cb();
+                }
+                else {
+                    removeOauth2Grant();
+                }
+            });
+        }
     }
     options() {
         const options = [
             {
                 option: '-i, --grantId <grantId>'
+            },
+            {
+                option: '--confirm'
             }
         ];
         const parentOptions = super.options();

package/dist/m365/aad/commands/sp/sp-get.js

@@ -2,9 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const request_1 = require("../../../../request");
 const Utils_1 = require("../../../../Utils");
-const AadCommand_1 = require("../../../base/AadCommand");
+const GraphCommand_1 = require("../../../base/GraphCommand");
 const commands_1 = require("../../commands");
-class AadSpGetCommand extends AadCommand_1.default {
+class AadSpGetCommand extends GraphCommand_1.default {
     get name() {
         return commands_1.default.SP_GET;
     }
@@ -18,35 +18,58 @@ class AadSpGetCommand extends AadCommand_1.default {
         telemetryProps.objectId = (!(!args.options.objectId)).toString();
         return telemetryProps;
     }
-    commandAction(logger, args, cb) {
-        if (this.verbose) {
-            logger.logToStderr(`Retrieving service principal information...`);
+    getSpId(args) {
+        if (args.options.objectId) {
+            return Promise.resolve(args.options.objectId);
         }
         let spMatchQuery = '';
-        if (args.options.appId) {
-            spMatchQuery = `appId eq '${encodeURIComponent(args.options.appId)}'`;
-        }
-        else if (args.options.objectId) {
-            spMatchQuery = `objectId eq '${encodeURIComponent(args.options.objectId)}'`;
-        }
-        else {
+        if (args.options.displayName) {
             spMatchQuery = `displayName eq '${encodeURIComponent(args.options.displayName)}'`;
         }
-        const requestOptions = {
-            url: `${this.resource}/myorganization/servicePrincipals?api-version=1.6&$filter=${spMatchQuery}`,
+        else if (args.options.appId) {
+            spMatchQuery = `appId eq '${encodeURIComponent(args.options.appId)}'`;
+        }
+        const idRequestOptions = {
+            url: `${this.resource}/v1.0/servicePrincipals?$filter=${spMatchQuery}`,
             headers: {
-                accept: 'application/json;odata=nometadata'
+                accept: 'application/json;odata.metadata=none'
             },
             responseType: 'json'
         };
-        request_1.default
-            .get(requestOptions)
-            .then((res) => {
-            if (res.value && res.value.length > 0) {
-                logger.log(res.value[0]);
+        return request_1.default
+            .get(idRequestOptions)
+            .then(response => {
+            const spItem = response.value[0];
+            if (!spItem) {
+                return Promise.reject(`The specified Azure AD app does not exist`);
+            }
+            if (response.value.length > 1) {
+                return Promise.reject(`Multiple Azure AD apps with name ${args.options.displayName} found: ${response.value.map(x => x.id)}`);
             }
+            return Promise.resolve(spItem.id);
+        });
+    }
+    commandAction(logger, args, cb) {
+        if (this.verbose) {
+            logger.logToStderr(`Retrieving service principal information...`);
+        }
+        this
+            .getSpId(args)
+            .then((id) => {
+            const requestOptions = {
+                url: `${this.resource}/v1.0/servicePrincipals/${id}`,
+                headers: {
+                    accept: 'application/json;odata.metadata=none',
+                    'content-type': 'application/json;odata.metadata=none'
+                },
+                responseType: 'json'
+            };
+            return request_1.default.get(requestOptions);
+        })
+            .then((res) => {
+            logger.log(res);
             cb();
-        }, (rawRes) => this.handleRejectedODataJsonPromise(rawRes, logger, cb));
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
     }
     options() {
         const options = [

package/dist/m365/aad/commands/user/user-get.js

@@ -20,10 +20,20 @@ class AadUserGetCommand extends GraphCommand_1.default {
     }
     commandAction(logger, args, cb) {
         const properties = args.options.properties ?
-            `?$select=${args.options.properties.split(',').map(p => encodeURIComponent(p.trim())).join(',')}` :
+            `&$select=${args.options.properties.split(',').map(p => encodeURIComponent(p.trim())).join(',')}` :
             '';
+        let requestUrl = `${this.resource}/v1.0/users`;
+        if (args.options.id) {
+            requestUrl += `?$filter=id eq '${encodeURIComponent(args.options.id)}'${properties}`;
+        }
+        else if (args.options.userName) {
+            requestUrl += `?$filter=userPrincipalName eq '${encodeURIComponent(args.options.userName)}'${properties}`;
+        }
+        else if (args.options.email) {
+            requestUrl += `?$filter=mail eq '${encodeURIComponent(args.options.email)}'${properties}`;
+        }
         const requestOptions = {
-            url: `${this.resource}/v1.0/users/${encodeURIComponent(args.options.id ? args.options.id : args.options.userName)}${properties}`,
+            url: requestUrl,
             headers: {
                 accept: 'application/json;odata.metadata=none'
             },
@@ -31,6 +41,18 @@ class AadUserGetCommand extends GraphCommand_1.default {
         };
         request_1.default
             .get(requestOptions)
+            .then((res) => {
+            if (res.value.length === 1) {
+                return Promise.resolve(res.value[0]);
+            }
+            const identifier = args.options.id ? `id ${args.options.id}`
+                : args.options.userName ? `user name ${args.options.userName}`
+                    : `email ${args.options.email}`;
+            if (res.value.length === 0) {
+                return Promise.reject(`The specified user with ${identifier} does not exist`);
+            }
+            return Promise.reject(`Multiple users with ${identifier} found. Please disambiguate (user names): ${res.value.map(a => a.userPrincipalName).join(', ')} or (ids): ${res.value.map(a => a.id).join(', ')}`);
+        })
             .then((res) => {
             logger.log(res);
             cb();
@@ -44,6 +66,9 @@ class AadUserGetCommand extends GraphCommand_1.default {
             {
                 option: '-n, --userName [userName]'
             },
+            {
+                option: '--email [email]'
+            },
             {
                 option: '-p, --properties [properties]'
             }
@@ -52,11 +77,13 @@ class AadUserGetCommand extends GraphCommand_1.default {
         return options.concat(parentOptions);
     }
     validate(args) {
-        if (!args.options.id && !args.options.userName) {
-            return 'Specify either id or userName';
+        if (!args.options.id && !args.options.userName && !args.options.email) {
+            return 'Specify id, userName or email, one is required';
         }
-        if (args.options.id && args.options.userName) {
-            return 'Specify either id or userName but not both';
+        if ((args.options.id && args.options.email) ||
+            (args.options.id && args.options.userName) ||
+            (args.options.userName && args.options.email)) {
+            return 'Use either id, userName or email, but not all';
         }
         if (args.options.id &&
             !Utils_1.default.isValidGuid(args.options.id)) {

package/dist/m365/aad/commands/user/user-password-validate.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const GraphCommand_1 = require("../../../base/GraphCommand");
+const commands_1 = require("../../commands");
+class AadUserPasswordValidateCommand extends GraphCommand_1.default {
+    get name() {
+        return commands_1.default.USER_PASSWORD_VALIDATE;
+    }
+    get description() {
+        return "Check a user's password against the organization's password validation policy";
+    }
+    commandAction(logger, args, cb) {
+        const requestOptions = {
+            url: `${this.resource}/beta/users/validatePassword`,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            data: {
+                password: args.options.password
+            },
+            responseType: 'json'
+        };
+        request_1.default
+            .post(requestOptions)
+            .then((res) => {
+            logger.log(res);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    options() {
+        const options = [
+            {
+                option: '-p, --password <password>'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+}
+module.exports = new AadUserPasswordValidateCommand();
+//# sourceMappingURL=user-password-validate.js.map

package/dist/m365/aad/commands.js

@@ -51,6 +51,7 @@ exports.default = {
     SP_GET: `${prefix} sp get`,
     USER_GET: `${prefix} user get`,
     USER_LIST: `${prefix} user list`,
+    USER_PASSWORD_VALIDATE: `${prefix} user password validate`,
     USER_SET: `${prefix} user set`
 };
 //# sourceMappingURL=commands.js.map