@pnp/cli-microsoft365 4.2.0-beta.b126b71 → 4.3.0-beta.014ebf5

package/.devcontainer/Dockerfile

@@ -23,7 +23,7 @@ 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/*
 

package/.eslintrc.js

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

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");

package/dist/cli/Cli.js

@@ -386,7 +386,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');

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

@@ -0,0 +1,107 @@
+"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 AadSpAddCommand extends GraphCommand_1.default {
+    get name() {
+        return commands_1.default.SP_ADD;
+    }
+    get description() {
+        return 'Adds a service principal to a registered Azure AD app';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.appId = (!(!args.options.appId)).toString();
+        telemetryProps.appName = (!(!args.options.appName)).toString();
+        telemetryProps.objectId = (!(!args.options.objectId)).toString();
+        return telemetryProps;
+    }
+    getAppId(args) {
+        if (args.options.appId) {
+            return Promise.resolve(args.options.appId);
+        }
+        let spMatchQuery = '';
+        if (args.options.appName) {
+            spMatchQuery = `displayName eq '${encodeURIComponent(args.options.appName)}'`;
+        }
+        else if (args.options.objectId) {
+            spMatchQuery = `id eq '${encodeURIComponent(args.options.objectId)}'`;
+        }
+        const appIdRequestOptions = {
+            url: `${this.resource}/v1.0/applications?$filter=${spMatchQuery}`,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json'
+        };
+        return request_1.default
+            .get(appIdRequestOptions)
+            .then(response => {
+            const spItem = response.value[0];
+            if (!spItem) {
+                return Promise.reject(`The specified Azure AD app doesn't exist`);
+            }
+            if (response.value.length > 1) {
+                return Promise.reject(`Multiple Azure AD apps with name ${args.options.appName} found: ${response.value.map(x => x.appId)}`);
+            }
+            return Promise.resolve(spItem.appId);
+        });
+    }
+    commandAction(logger, args, cb) {
+        this
+            .getAppId(args)
+            .then((appId) => {
+            const requestOptions = {
+                url: `${this.resource}/v1.0/servicePrincipals`,
+                headers: {
+                    accept: 'application/json;odata.metadata=none',
+                    'content-type': 'application/json;odata=nometadata'
+                },
+                data: {
+                    appId: appId
+                },
+                responseType: 'json'
+            };
+            return request_1.default.post(requestOptions);
+        })
+            .then((res) => {
+            logger.log(res);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    options() {
+        const options = [
+            {
+                option: '--appId [appId]'
+            },
+            {
+                option: '--appName [appName]'
+            },
+            {
+                option: '--objectId [objectId]'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        let optionsSpecified = 0;
+        optionsSpecified += args.options.appId ? 1 : 0;
+        optionsSpecified += args.options.appName ? 1 : 0;
+        optionsSpecified += args.options.objectId ? 1 : 0;
+        if (optionsSpecified !== 1) {
+            return 'Specify either appId, appName, or objectId';
+        }
+        if (args.options.appId && !Utils_1.default.isValidGuid(args.options.appId)) {
+            return `${args.options.appId} is not a valid appId GUID`;
+        }
+        if (args.options.objectId && !Utils_1.default.isValidGuid(args.options.objectId)) {
+            return `${args.options.objectId} is not a valid objectId GUID`;
+        }
+        return true;
+    }
+}
+module.exports = new AadSpAddCommand();
+//# sourceMappingURL=sp-add.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`,
@@ -46,6 +47,7 @@ exports.default = {
     SITECLASSIFICATION_ENABLE: `${prefix} siteclassification enable`,
     SITECLASSIFICATION_GET: `${prefix} siteclassification get`,
     SITECLASSIFICATION_SET: `${prefix} siteclassification set`,
+    SP_ADD: `${prefix} sp add`,
     SP_GET: `${prefix} sp get`,
     USER_GET: `${prefix} user get`,
     USER_LIST: `${prefix} user list`,

package/dist/m365/base/M365RcJson.js

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