@pnp/cli-microsoft365 4.2.0-beta.bf7382d → 4.3.0-beta.0aaa522

package/.devcontainer/Dockerfile

@@ -23,11 +23,11 @@ RUN apt-get update && apt-get install -y \
   vim \
   python3.8 \
   python3-pip \
-  && curl -sL https://deb.nodesource.com/setup_14.x | sudo -E bash - \
+  && curl -sL https://deb.nodesource.com/setup_16.x | sudo -E bash - \
   && apt-get install nodejs -y \
   && rm -rf /var/lib/apt/lists/*
 
-RUN pip3 install mkdocs-material==3.1.0 pymdown-extensions==6.0
+RUN pip3 install mkdocs-material==7.1.7 pymdown-extensions==9.0
 
 RUN useradd \
   --user-group \

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

@@ -4,6 +4,8 @@ const packageJSON = require('../package.json');
 // disable automatic third-party instrumentation for Application Insights
 // speeds up execution by preventing loading unnecessary dependencies
 process.env.APPLICATION_INSIGHTS_NO_DIAGNOSTIC_CHANNEL = 'none';
+// prevents tests from hanging
+process.env.APPLICATION_INSIGHTS_NO_STATSBEAT = 'true';
 const appInsights = require("applicationinsights");
 const crypto = require("crypto");
 const fs = require("fs");
@@ -18,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,
@@ -386,7 +391,10 @@ class Cli {
             logStatementType = typeof logStatement;
         }
         if (!options.output || options.output === 'json') {
-            return JSON.stringify(logStatement, null, 2);
+            return JSON
+                .stringify(logStatement, null, 2)
+                // replace unescaped newlines with escaped newlines #2807
+                .replace(/([^\\])\\n/g, '$1\\\\\\n');
         }
         if (logStatement instanceof Command_1.CommandError) {
             const chalk = require('chalk');
@@ -413,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' &&
@@ -437,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/app/app-add.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const fs = require("fs");
 const uuid_1 = require("uuid");
 const Auth_1 = require("../../../../Auth");
 const request_1 = require("../../../../request");
@@ -7,6 +8,10 @@ const Utils_1 = require("../../../../Utils");
 const GraphItemsListCommand_1 = require("../../../base/GraphItemsListCommand");
 const commands_1 = require("../../commands");
 class AadAppAddCommand extends GraphItemsListCommand_1.GraphItemsListCommand {
+    constructor() {
+        super(...arguments);
+        this.appName = '';
+    }
     get name() {
         return commands_1.default.APP_ADD;
     }
@@ -32,18 +37,23 @@ class AadAppAddCommand extends GraphItemsListCommand_1.GraphItemsListCommand {
         this
             .resolveApis(args, logger)
             .then(apis => this.createAppRegistration(args, apis, logger))
+            .then(appInfo => {
+            // based on the assumption that we're adding AAD app to the current
+            // directory. If we in the future extend the command with allowing
+            // users to create AAD app in a different directory, we'll need to
+            // adjust this
+            appInfo.tenantId = Utils_1.default.getTenantIdFromAccessToken(Auth_1.default.service.accessTokens[Auth_1.default.defaultResource].accessToken);
+            return Promise.resolve(appInfo);
+        })
             .then(appInfo => this.updateAppFromManifest(args, appInfo))
             .then(appInfo => this.configureUri(args, appInfo, logger))
             .then(appInfo => this.configureSecret(args, appInfo, logger))
+            .then(appInfo => this.saveAppInfo(args, appInfo, logger))
             .then((_appInfo) => {
             const appInfo = {
                 appId: _appInfo.appId,
                 objectId: _appInfo.id,
-                // based on the assumption that we're adding AAD app to the current
-                // directory. If we in the future extend the command with allowing
-                // users to create AAD app in a different directory, we'll need to
-                // adjust this
-                tenantId: Utils_1.default.getTenantIdFromAccessToken(Auth_1.default.service.accessTokens[Auth_1.default.defaultResource].accessToken)
+                tenantId: _appInfo.tenantId
             };
             if (_appInfo.secret) {
                 appInfo.secret = _appInfo.secret;
@@ -60,6 +70,7 @@ class AadAppAddCommand extends GraphItemsListCommand_1.GraphItemsListCommand {
         if (!applicationInfo.displayName && this.manifest) {
             applicationInfo.displayName = this.manifest.name;
         }
+        this.appName = applicationInfo.displayName;
         if (apis.length > 0) {
             applicationInfo.requiredResourceAccess = apis;
         }
@@ -332,6 +343,45 @@ class AadAppAddCommand extends GraphItemsListCommand_1.GraphItemsListCommand {
             return Promise.resolve(appInfo);
         });
     }
+    saveAppInfo(args, appInfo, logger) {
+        if (!args.options.save) {
+            return Promise.resolve(appInfo);
+        }
+        const filePath = '.m365rc.json';
+        if (this.verbose) {
+            logger.logToStderr(`Saving Azure AD app registration information to the ${filePath} file...`);
+        }
+        let m365rc = {};
+        if (fs.existsSync(filePath)) {
+            if (this.debug) {
+                logger.logToStderr(`Reading existing ${filePath}...`);
+            }
+            try {
+                const fileContents = fs.readFileSync(filePath, 'utf8');
+                if (fileContents) {
+                    m365rc = JSON.parse(fileContents);
+                }
+            }
+            catch (e) {
+                logger.logToStderr(`Error reading ${filePath}: ${e}. Please add app info to ${filePath} manually.`);
+                return Promise.resolve(appInfo);
+            }
+        }
+        if (!m365rc.apps) {
+            m365rc.apps = [];
+        }
+        m365rc.apps.push({
+            appId: appInfo.appId,
+            name: this.appName
+        });
+        try {
+            fs.writeFileSync(filePath, JSON.stringify(m365rc, null, 2));
+        }
+        catch (e) {
+            logger.logToStderr(`Error writing ${filePath}: ${e}. Please add app info to ${filePath} manually.`);
+        }
+        return Promise.resolve(appInfo);
+    }
     options() {
         const options = [
             {
@@ -377,6 +427,9 @@ class AadAppAddCommand extends GraphItemsListCommand_1.GraphItemsListCommand {
             },
             {
                 option: '--manifest [manifest]'
+            },
+            {
+                option: '--save'
             }
         ];
         const parentOptions = super.options();

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/o365group/o365group-add.js

@@ -5,6 +5,7 @@ const path = require("path");
 const request_1 = require("../../../../request");
 const GraphCommand_1 = require("../../../base/GraphCommand");
 const commands_1 = require("../../commands");
+const Utils_1 = require("../../../../Utils");
 class AadO365GroupAddCommand extends GraphCommand_1.default {
     get name() {
         return commands_1.default.O365GROUP_ADD;
@@ -14,6 +15,8 @@ class AadO365GroupAddCommand extends GraphCommand_1.default {
     }
     commandAction(logger, args, cb) {
         let group;
+        let ownerIds = [];
+        let memberIds = [];
         if (this.verbose) {
             logger.logToStderr(`Creating Microsoft 365 Group...`);
         }
@@ -35,8 +38,16 @@ class AadO365GroupAddCommand extends GraphCommand_1.default {
                 visibility: args.options.isPrivate === 'true' ? 'Private' : 'Public'
             }
         };
-        request_1.default
-            .post(requestOptions)
+        this
+            .getUserIds(logger, args.options.owners)
+            .then((ownerIdsRes) => {
+            ownerIds = ownerIdsRes;
+            return this.getUserIds(logger, args.options.members);
+        })
+            .then((memberIdsRes) => {
+            memberIds = memberIdsRes;
+            return request_1.default.post(requestOptions);
+        })
             .then((res) => {
             group = res;
             if (!args.options.logoPath) {
@@ -61,72 +72,32 @@ class AadO365GroupAddCommand extends GraphCommand_1.default {
             });
         })
             .then(() => {
-            if (!args.options.owners) {
-                if (this.debug) {
-                    logger.logToStderr('Owners not set. Skipping');
-                }
-                return Promise.resolve(undefined);
-            }
-            const owners = args.options.owners.split(',').map(o => o.trim());
-            if (this.verbose) {
-                logger.logToStderr('Retrieving user information to set group owners...');
-            }
-            const requestOptions = {
-                url: `${this.resource}/v1.0/users?$filter=${owners.map(o => `userPrincipalName eq '${o}'`).join(' or ')}&$select=id`,
-                headers: {
-                    'content-type': 'application/json'
-                },
-                responseType: 'json'
-            };
-            return request_1.default.get(requestOptions);
-        })
-            .then((res) => {
-            if (!res) {
-                return Promise.resolve();
+            if (ownerIds.length === 0) {
+                return Promise.resolve([]);
             }
-            return Promise.all(res.value.map(u => request_1.default.post({
+            return Promise.all(ownerIds.map(ownerId => request_1.default.post({
                 url: `${this.resource}/v1.0/groups/${group.id}/owners/$ref`,
                 headers: {
                     'content-type': 'application/json'
                 },
                 responseType: 'json',
                 data: {
-                    "@odata.id": `https://graph.microsoft.com/v1.0/users/${u.id}`
+                    "@odata.id": `https://graph.microsoft.com/v1.0/users/${ownerId}`
                 }
             })));
         })
             .then(() => {
-            if (!args.options.members) {
-                if (this.debug) {
-                    logger.logToStderr('Members not set. Skipping');
-                }
-                return Promise.resolve(undefined);
-            }
-            const members = args.options.members.split(',').map(o => o.trim());
-            if (this.verbose) {
-                logger.logToStderr('Retrieving user information to set group members...');
-            }
-            const requestOptions = {
-                url: `${this.resource}/v1.0/users?$filter=${members.map(o => `userPrincipalName eq '${o}'`).join(' or ')}&$select=id`,
-                headers: {
-                    'content-type': 'application/json'
-                },
-                responseType: 'json'
-            };
-            return request_1.default.get(requestOptions);
-        })
-            .then((res) => {
-            if (!res) {
-                return Promise.resolve();
+            if (memberIds.length === 0) {
+                return Promise.resolve([]);
             }
-            return Promise.all(res.value.map(u => request_1.default.post({
+            return Promise.all(memberIds.map(memberId => request_1.default.post({
                 url: `${this.resource}/v1.0/groups/${group.id}/members/$ref`,
                 headers: {
                     'content-type': 'application/json'
                 },
                 responseType: 'json',
                 data: {
-                    "@odata.id": `https://graph.microsoft.com/v1.0/users/${u.id}`
+                    "@odata.id": `https://graph.microsoft.com/v1.0/users/${memberId}`
                 }
             })));
         })
@@ -135,6 +106,41 @@ class AadO365GroupAddCommand extends GraphCommand_1.default {
             cb();
         }, (rawRes) => this.handleRejectedODataJsonPromise(rawRes, logger, cb));
     }
+    getUserIds(logger, users) {
+        if (!users) {
+            if (this.debug) {
+                logger.logToStderr('No users to validate, skipping.');
+            }
+            return Promise.resolve([]);
+        }
+        if (this.verbose) {
+            logger.logToStderr('Retrieving user information.');
+        }
+        const userArr = users.split(',').map(o => o.trim());
+        let promises = [];
+        let userIds = [];
+        promises = userArr.map(user => {
+            const requestOptions = {
+                url: `${this.resource}/v1.0/users?$filter=userPrincipalName eq '${Utils_1.default.encodeQueryParameter(user)}'&$select=id,userPrincipalName`,
+                headers: {
+                    'content-type': 'application/json'
+                },
+                responseType: 'json'
+            };
+            return request_1.default.get(requestOptions);
+        });
+        return Promise.all(promises).then((usersRes) => {
+            let userUpns = [];
+            userUpns = usersRes.map(res => { var _a; return (_a = res.value[0]) === null || _a === void 0 ? void 0 : _a.userPrincipalName; });
+            userIds = usersRes.map(res => { var _a; return (_a = res.value[0]) === null || _a === void 0 ? void 0 : _a.id; });
+            // Find the members where no graph response was found
+            const invalidUsers = userArr.filter(user => !userUpns.some((upn) => (upn === null || upn === void 0 ? void 0 : upn.toLowerCase()) === user.toLowerCase()));
+            if (invalidUsers && invalidUsers.length > 0) {
+                return Promise.reject(`Cannot proceed with group creation. The following users provided are invalid : ${invalidUsers.join(',')}`);
+            }
+            return Promise.resolve(userIds);
+        });
+    }
     setGroupLogo(requestOptions, retryLeft, resolve, reject, logger) {
         request_1.default
             .put(requestOptions)

package/dist/m365/aad/commands/oauth2grant/oauth2grant-add.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 AadOAuth2GrantAddCommand extends AadCommand_1.default {
+class AadOAuth2GrantAddCommand extends GraphCommand_1.default {
     get name() {
         return commands_1.default.OAUTH2GRANT_ADD;
     }
@@ -16,20 +16,17 @@ class AadOAuth2GrantAddCommand extends AadCommand_1.default {
             logger.logToStderr(`Granting the service principal specified permissions...`);
         }
         const requestOptions = {
-            url: `${this.resource}/myorganization/oauth2PermissionGrants?api-version=1.6`,
+            url: `${this.resource}/v1.0/oauth2PermissionGrants`,
             headers: {
-                'content-type': 'application/json'
+                'content-type': 'application/json;odata.metadata=none'
             },
             responseType: 'json',
             data: {
-                "odata.type": "Microsoft.DirectoryServices.OAuth2PermissionGrant",
                 "clientId": args.options.clientId,
                 "consentType": "AllPrincipals",
                 "principalId": null,
                 "resourceId": args.options.resourceId,
-                "scope": args.options.scope,
-                "startTime": "0001-01-01T00:00:00",
-                "expiryTime": "9000-01-01T00:00:00"
+                "scope": args.options.scope
             }
         };
         request_1.default

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

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const request_1 = require("../../../../request");
-const AadCommand_1 = require("../../../base/AadCommand");
+const GraphCommand_1 = require("../../../base/GraphCommand");
 const commands_1 = require("../../commands");
-class AadOAuth2GrantRemoveCommand extends AadCommand_1.default {
+class AadOAuth2GrantRemoveCommand extends GraphCommand_1.default {
     get name() {
         return commands_1.default.OAUTH2GRANT_REMOVE;
     }
@@ -15,7 +15,10 @@ class AadOAuth2GrantRemoveCommand extends AadCommand_1.default {
             logger.logToStderr(`Removing OAuth2 permissions...`);
         }
         const requestOptions = {
-            url: `${this.resource}/myorganization/oauth2PermissionGrants/${encodeURIComponent(args.options.grantId)}?api-version=1.6`,
+            url: `${this.resource}/v1.0/oauth2PermissionGrants/${encodeURIComponent(args.options.grantId)}`,
+            headers: {
+                'accept': 'application/json;odata.metadata=none'
+            },
             responseType: 'json'
         };
         request_1.default

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

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const request_1 = require("../../../../request");
-const AadCommand_1 = require("../../../base/AadCommand");
+const GraphCommand_1 = require("../../../base/GraphCommand");
 const commands_1 = require("../../commands");
-class AadOAuth2GrantSetCommand extends AadCommand_1.default {
+class AadOAuth2GrantSetCommand extends GraphCommand_1.default {
     get name() {
         return commands_1.default.OAUTH2GRANT_SET;
     }
@@ -15,7 +15,7 @@ class AadOAuth2GrantSetCommand extends AadCommand_1.default {
             logger.logToStderr(`Updating OAuth2 permissions...`);
         }
         const requestOptions = {
-            url: `${this.resource}/myorganization/oauth2PermissionGrants/${encodeURIComponent(args.options.grantId)}?api-version=1.6`,
+            url: `${this.resource}/v1.0/oauth2PermissionGrants/${encodeURIComponent(args.options.grantId)}`,
             headers: {
                 'content-type': 'application/json'
             },