@pnp/cli-microsoft365 5.0.0-beta.c9c30c0 → 5.0.0-beta.ccc8737

package/.devcontainer/devcontainer.json

@@ -2,7 +2,15 @@
   "name": "CLI for Microsoft 365",
   "dockerFile": "Dockerfile",
   "settings": {
-    "terminal.integrated.shell.linux": "/bin/zsh"
+    "terminal.integrated.profiles.linux": {
+        "zsh": {
+          "path": "/bin/zsh",
+          "args": [
+            "-l"
+          ]
+        }
+      },
+      "terminal.integrated.defaultProfile.linux": "zsh"
   },
   "postCreateCommand": "npm i && npm run clean && npm run build && npm link",
   "extensions": [

package/.eslintrc.js

@@ -30,6 +30,7 @@ const dictionary = [
   'in',
   'init',
   'install',
+  'installed',
   'is',
   'issue',
   'list',

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);
@@ -48,6 +51,10 @@ class Utils {
         const guidRegEx = new RegExp(/^19:[0-9a-zA-Z-_]+@thread\.(skype|tacv2)$/i);
         return guidRegEx.test(guid);
     }
+    static isValidTeamsChatId(guid) {
+        const guidRegEx = new RegExp(/^19:[0-9a-zA-Z-_]+(@thread\.v2|@unq\.gbl\.spaces)$/i);
+        return guidRegEx.test(guid);
+    }
     static isValidUserPrincipalName(upn) {
         const upnRegEx = new RegExp(/^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*$/i);
         return upnRegEx.test(upn);

package/dist/appInsights.js

@@ -20,10 +20,11 @@ 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');
-delete appInsights.defaultClient.context.tags['ai.cloud.roleInstance'];
+appInsights.defaultClient.context.tags['ai.cloud.roleInstance'] = crypto.createHash('sha256').update(appInsights.defaultClient.context.tags['ai.cloud.roleInstance']).digest('hex');
 delete appInsights.defaultClient.context.tags['ai.cloud.role'];
 exports.default = appInsights.defaultClient;
 //# sourceMappingURL=appInsights.js.map

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,18 @@ class Cli {
                 }
             }
         }
+        if (options.output === 'csv') {
+            const { stringify } = require('csv-stringify/sync');
+            const cli = Cli.getInstance();
+            // https://csv.js.org/stringify/options/
+            return stringify(logStatement, {
+                header: cli.getSettingWithDefaultValue(settingsNames_1.settingsNames.csvHeader, true),
+                escape: cli.getSettingWithDefaultValue(settingsNames_1.settingsNames.csvEscape, '"'),
+                quote: cli.config.get(settingsNames_1.settingsNames.csvQuote),
+                quoted: cli.getSettingWithDefaultValue(settingsNames_1.settingsNames.csvQuoted, false),
+                quotedEmpty: cli.getSettingWithDefaultValue(settingsNames_1.settingsNames.csvQuotedEmpty, false)
+            });
+        }
         // display object as a list of key-value pairs
         if (logStatement.length === 1) {
             const obj = logStatement[0];

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

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const Utils_1 = require("../../../../Utils");
+const GraphCommand_1 = require("../../../base/GraphCommand");
+const commands_1 = require("../../commands");
+class AadAppGetCommand extends GraphCommand_1.default {
+    get name() {
+        return commands_1.default.APP_GET;
+    }
+    get description() {
+        return 'Gets an Azure AD app registration';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.appId = typeof args.options.appId !== 'undefined';
+        telemetryProps.objectId = typeof args.options.objectId !== 'undefined';
+        telemetryProps.name = typeof args.options.name !== 'undefined';
+        return telemetryProps;
+    }
+    commandAction(logger, args, cb) {
+        this
+            .getAppObjectId(args)
+            .then((appObjectId) => {
+            const requestOptions = {
+                url: `${this.resource}/v1.0/myorganization/applications/${appObjectId}`,
+                headers: {
+                    accept: 'application/json;odata.metadata=none'
+                },
+                responseType: 'json'
+            };
+            return request_1.default.get(requestOptions);
+        })
+            .then((res) => {
+            logger.log(res);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    getAppObjectId(args) {
+        if (args.options.objectId) {
+            return Promise.resolve(args.options.objectId);
+        }
+        const { appId, name } = args.options;
+        const filter = appId ?
+            `appId eq '${encodeURIComponent(appId)}'` :
+            `displayName eq '${encodeURIComponent(name)}'`;
+        const requestOptions = {
+            url: `${this.resource}/v1.0/myorganization/applications?$filter=${filter}&$select=id`,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json'
+        };
+        return request_1.default
+            .get(requestOptions)
+            .then((res) => {
+            if (res.value.length === 1) {
+                return Promise.resolve(res.value[0].id);
+            }
+            if (res.value.length === 0) {
+                const applicationIdentifier = appId ? `ID ${appId}` : `name ${name}`;
+                return Promise.reject(`No Azure AD application registration with ${applicationIdentifier} found`);
+            }
+            return Promise.reject(`Multiple Azure AD application registration with name ${name} found. Please disambiguate (app object IDs): ${res.value.map(a => a.id).join(', ')}`);
+        });
+    }
+    options() {
+        const options = [
+            { option: '--appId [appId]' },
+            { option: '--objectId [objectId]' },
+            { option: '--name [name]' }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        if (!args.options.appId &&
+            !args.options.objectId &&
+            !args.options.name) {
+            return 'Specify either appId, objectId, or name';
+        }
+        if ((args.options.appId && args.options.objectId) ||
+            (args.options.appId && args.options.name) ||
+            (args.options.objectId && args.options.name)) {
+            return 'Specify either appId, objectId, or name but not both';
+        }
+        if (args.options.appId && !Utils_1.default.isValidGuid(args.options.appId)) {
+            return `${args.options.appId} is not a valid GUID`;
+        }
+        if (args.options.objectId && !Utils_1.default.isValidGuid(args.options.objectId)) {
+            return `${args.options.objectId} is not a valid GUID`;
+        }
+        return true;
+    }
+}
+module.exports = new AadAppGetCommand();
+//# sourceMappingURL=app-get.js.map

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

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const GraphItemsListCommand_1 = require("../../../base/GraphItemsListCommand");
+const commands_1 = require("../../commands");
+class AadGroupListCommand extends GraphItemsListCommand_1.GraphItemsListCommand {
+    get name() {
+        return commands_1.default.GROUP_LIST;
+    }
+    get description() {
+        return 'Lists all groups defined in Azure Active Directory.';
+    }
+    defaultProperties() {
+        return ['id', 'displayName', 'groupType'];
+    }
+    commandAction(logger, args, cb) {
+        this
+            .getAllItems(`${this.resource}/v1.0/groups`, logger, true)
+            .then(() => {
+            if (args.options.output === 'text') {
+                this.items.forEach((group) => {
+                    if (group.groupTypes && group.groupTypes.length > 0 && group.groupTypes[0] === 'Unified') {
+                        group.groupType = 'Microsoft 365';
+                    }
+                    else if (group.mailEnabled && group.securityEnabled) {
+                        group.groupType = 'Mail enabled security';
+                    }
+                    else if (group.securityEnabled) {
+                        group.groupType = 'Security';
+                    }
+                    else if (group.mailEnabled) {
+                        group.groupType = 'Distribution';
+                    }
+                });
+            }
+            logger.log(this.items);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+}
+module.exports = new AadGroupListCommand();
+//# sourceMappingURL=group-list.js.map

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/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-hibp.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const Utils_1 = require("../../../../Utils");
+const AnonymousCommand_1 = require("../../../base/AnonymousCommand");
+const commands_1 = require("../../commands");
+class AadUserHibpCommand extends AnonymousCommand_1.default {
+    get name() {
+        return commands_1.default.USER_HIBP;
+    }
+    get description() {
+        return 'Allows you to retrieve all accounts that have been pwned with the specified username';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.domain = args.options.domain;
+        return telemetryProps;
+    }
+    commandAction(logger, args, cb) {
+        const requestOptions = {
+            url: `https://haveibeenpwned.com/api/v3/breachedaccount/${encodeURIComponent(args.options.userName)}${(args.options.domain ? `?domain=${encodeURIComponent(args.options.domain)}` : '')}`,
+            headers: {
+                'accept': 'application/json',
+                'hibp-api-key': args.options.apiKey,
+                'x-anonymous': true
+            },
+            responseType: 'json'
+        };
+        request_1.default
+            .get(requestOptions)
+            .then((res) => {
+            logger.log(res);
+            cb();
+        })
+            .catch((err) => {
+            if ((err && err.response !== undefined && err.response.status === 404) && (this.debug || this.verbose)) {
+                logger.log('No pwnage found');
+                cb();
+                return;
+            }
+            return this.handleRejectedODataJsonPromise(err, logger, cb);
+        });
+    }
+    options() {
+        const options = [
+            {
+                option: '-n, --userName <userName>'
+            },
+            {
+                option: '--apiKey, <apiKey>'
+            },
+            {
+                option: '--domain, [domain]'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        if (!Utils_1.default.isValidUserPrincipalName(args.options.userName)) {
+            return 'Specify valid userName';
+        }
+        return true;
+    }
+}
+module.exports = new AadUserHibpCommand();
+//# sourceMappingURL=user-hibp.js.map

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

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const prefix = 'aad';
 exports.default = {
     APP_ADD: `${prefix} app add`,
+    APP_GET: `${prefix} app get`,
     APP_SET: `${prefix} app set`,
     APP_ROLE_ADD: `${prefix} app role add`,
     APP_ROLE_LIST: `${prefix} app role list`,
@@ -10,6 +11,7 @@ exports.default = {
     APPROLEASSIGNMENT_ADD: `${prefix} approleassignment add`,
     APPROLEASSIGNMENT_LIST: `${prefix} approleassignment list`,
     APPROLEASSIGNMENT_REMOVE: `${prefix} approleassignment remove`,
+    GROUP_LIST: `${prefix} group list`,
     GROUPSETTING_ADD: `${prefix} groupsetting add`,
     GROUPSETTING_GET: `${prefix} groupsetting get`,
     GROUPSETTING_LIST: `${prefix} groupsetting list`,
@@ -49,7 +51,9 @@ exports.default = {
     SP_ADD: `${prefix} sp add`,
     SP_GET: `${prefix} sp get`,
     USER_GET: `${prefix} user get`,
+    USER_HIBP: `${prefix} user hibp`,
     USER_LIST: `${prefix} user list`,
+    USER_PASSWORD_VALIDATE: `${prefix} user password validate`,
     USER_SET: `${prefix} user set`
 };
 //# sourceMappingURL=commands.js.map