@pnp/cli-microsoft365 4.3.0-beta.fd397f5 → 4.4.0-beta.23194d7

package/dist/m365/app/commands.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const prefix = 'app';
+exports.default = {
+    PERMISSION_LIST: `${prefix} permission list`
+};
+//# sourceMappingURL=commands.js.map

package/dist/m365/base/AppCommand.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs = require("fs");
+const cli_1 = require("../../cli");
+const Command_1 = require("../../Command");
+const Utils_1 = require("../../Utils");
+class AppCommand extends Command_1.default {
+    get resource() {
+        return 'https://graph.microsoft.com';
+    }
+    action(logger, args, cb) {
+        const m365rcJsonPath = '.m365rc.json';
+        if (!fs.existsSync(m365rcJsonPath)) {
+            return cb(new Command_1.CommandError(`Could not find file: ${m365rcJsonPath}`));
+        }
+        try {
+            const m365rcJsonContents = fs.readFileSync(m365rcJsonPath, 'utf8');
+            if (!m365rcJsonContents) {
+                return cb(new Command_1.CommandError(`File ${m365rcJsonPath} is empty`));
+            }
+            this.m365rcJson = JSON.parse(m365rcJsonContents);
+        }
+        catch (e) {
+            return cb(new Command_1.CommandError(`Could not parse file: ${m365rcJsonPath}`));
+        }
+        if (!this.m365rcJson.apps ||
+            this.m365rcJson.apps.length === 0) {
+            return cb(new Command_1.CommandError(`No Azure AD apps found in ${m365rcJsonPath}`));
+        }
+        if (args.options.appId) {
+            if (!this.m365rcJson.apps.some(app => app.appId === args.options.appId)) {
+                return cb(new Command_1.CommandError(`App ${args.options.appId} not found in ${m365rcJsonPath}`));
+            }
+            this.appId = args.options.appId;
+            return super.action(logger, args, cb);
+        }
+        if (this.m365rcJson.apps.length === 1) {
+            this.appId = this.m365rcJson.apps[0].appId;
+            return super.action(logger, args, cb);
+        }
+        if (this.m365rcJson.apps.length > 1) {
+            cli_1.Cli.prompt({
+                message: `Multiple Azure AD apps found in ${m365rcJsonPath}. Which app would you like to use?`,
+                type: 'list',
+                choices: this.m365rcJson.apps.map((app, i) => {
+                    return {
+                        name: `${app.name} (${app.appId})`,
+                        value: i
+                    };
+                }),
+                default: 0,
+                name: 'appIdIndex'
+            }, (result) => {
+                this.appId = this.m365rcJson.apps[result.appIdIndex].appId;
+                super.action(logger, args, cb);
+            });
+        }
+    }
+    options() {
+        const options = [
+            {
+                option: '--appId [appId]'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        if (args.options.appId && !Utils_1.default.isValidGuid(args.options.appId)) {
+            return `${args.options.appId} is not a valid GUID`;
+        }
+        return true;
+    }
+}
+exports.default = AppCommand;
+//# sourceMappingURL=AppCommand.js.map

package/dist/m365/cli/commands/config/config-set.js

@@ -21,6 +21,9 @@ class CliConfigSetCommand extends AnonymousCommand_1.default {
         switch (args.options.key) {
             case settingsNames_1.settingsNames.showHelpOnFailure:
             case settingsNames_1.settingsNames.printErrorsAsPlainText:
+            case settingsNames_1.settingsNames.csvHeader:
+            case settingsNames_1.settingsNames.csvQuoted:
+            case settingsNames_1.settingsNames.csvQuotedEmpty:
                 value = args.options.value === 'true';
                 break;
             default:
@@ -47,7 +50,7 @@ class CliConfigSetCommand extends AnonymousCommand_1.default {
         if (CliConfigSetCommand.optionNames.indexOf(args.options.key) < 0) {
             return `${args.options.key} is not a valid setting. Allowed values: ${CliConfigSetCommand.optionNames.join(', ')}`;
         }
-        const allowedOutputs = ['text', 'json'];
+        const allowedOutputs = ['text', 'json', 'csv'];
         if (args.options.key === settingsNames_1.settingsNames.output &&
             allowedOutputs.indexOf(args.options.value) === -1) {
             return `${args.options.value} is not a valid value for the option ${args.options.key}. Allowed values: ${allowedOutputs.join(', ')}`;

package/dist/m365/pa/cds-project-mutator.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const path = require("path");
-const xmldom_1 = require("xmldom");
+const xmldom_1 = require("@xmldom/xmldom");
 /*
  * Logic extracted from bolt.module.solution.dll
  * Version: 0.4.3

package/dist/m365/pa/commands/app/app-list.js

@@ -12,8 +12,14 @@ class PaAppListCommand extends AzmgmtItemsListCommand_1.AzmgmtItemsListCommand {
     defaultProperties() {
         return ['name', 'displayName'];
     }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.asAdmin = args.options.asAdmin === true;
+        telemetryProps.environment = typeof args.options.environment !== 'undefined';
+        return telemetryProps;
+    }
     commandAction(logger, args, cb) {
-        const url = `${this.resource}providers/Microsoft.PowerApps/apps?api-version=2017-08-01`;
+        const url = `${this.resource}providers/Microsoft.PowerApps${args.options.asAdmin ? '/scopes/admin' : ''}${args.options.environment ? '/environments/' + encodeURIComponent(args.options.environment) : ''}/apps?api-version=2017-08-01`;
         this
             .getAllItems(url, logger, true)
             .then(() => {
@@ -31,6 +37,27 @@ class PaAppListCommand extends AzmgmtItemsListCommand_1.AzmgmtItemsListCommand {
             cb();
         }, (rawRes) => this.handleRejectedODataJsonPromise(rawRes, logger, cb));
     }
+    options() {
+        const options = [
+            {
+                option: '-e, --environment [environment]'
+            },
+            {
+                option: '--asAdmin'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        if (args.options.asAdmin && !args.options.environment) {
+            return 'When specifying the asAdmin option the environment option is required as well';
+        }
+        if (args.options.environment && !args.options.asAdmin) {
+            return 'When specifying the environment option the asAdmin option is required as well';
+        }
+        return true;
+    }
 }
 module.exports = new PaAppListCommand();
 //# sourceMappingURL=app-list.js.map

package/dist/m365/planner/commands/task/task-add.js

@@ -0,0 +1,288 @@
+"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 PlannerTaskAddCommand extends GraphCommand_1.default {
+    get name() {
+        return commands_1.default.TASK_ADD;
+    }
+    get description() {
+        return 'Adds a new Microsoft Planner Task';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.planId = typeof args.options.planId !== 'undefined';
+        telemetryProps.planName = typeof args.options.planName !== 'undefined';
+        telemetryProps.ownerGroupId = typeof args.options.ownerGroupId !== 'undefined';
+        telemetryProps.ownerGroupName = typeof args.options.ownerGroupName !== 'undefined';
+        telemetryProps.bucketId = typeof args.options.bucketId !== 'undefined';
+        telemetryProps.bucketName = typeof args.options.bucketName !== 'undefined';
+        telemetryProps.startDateTime = typeof args.options.startDateTime !== 'undefined';
+        telemetryProps.dueDateTime = typeof args.options.dueDateTime !== 'undefined';
+        telemetryProps.percentComplete = typeof args.options.percentComplete !== 'undefined';
+        telemetryProps.assignedToUserIds = typeof args.options.assignedToUserIds !== 'undefined';
+        telemetryProps.assignedToUserNames = typeof args.options.assignedToUserNames !== 'undefined';
+        telemetryProps.description = typeof args.options.description !== 'undefined';
+        telemetryProps.orderHint = typeof args.options.orderHint !== 'undefined';
+        return telemetryProps;
+    }
+    commandAction(logger, args, cb) {
+        this
+            .getPlanId(args)
+            .then(planId => {
+            this.planId = planId;
+            return this.getBucketId(args, planId);
+        })
+            .then(bucketId => {
+            this.bucketId = bucketId;
+            return this.generateUserAssignments(args);
+        })
+            .then(assignments => {
+            const requestOptions = {
+                url: `${this.resource}/v1.0/planner/tasks`,
+                headers: {
+                    'accept': 'application/json;odata.metadata=none'
+                },
+                responseType: 'json',
+                data: {
+                    planId: this.planId,
+                    bucketId: this.bucketId,
+                    title: args.options.title,
+                    startDateTime: args.options.startDateTime,
+                    dueDateTime: args.options.dueDateTime,
+                    percentComplete: args.options.percentComplete,
+                    assignments: assignments,
+                    orderHint: args.options.orderHint
+                }
+            };
+            return request_1.default.post(requestOptions);
+        })
+            .then(newTask => this.updateTaskDetails(args.options, newTask))
+            .then((res) => {
+            logger.log(res);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    getTaskDetailsEtag(taskId) {
+        const requestOptions = {
+            url: `${this.resource}/v1.0/planner/tasks/${encodeURIComponent(taskId)}/details`,
+            headers: {
+                accept: 'application/json'
+            },
+            responseType: 'json'
+        };
+        return request_1.default
+            .get(requestOptions)
+            .then((response) => {
+            const etag = response ? response['@odata.etag'] : undefined;
+            if (!etag) {
+                return Promise.reject(`Error fetching task details`);
+            }
+            return Promise.resolve(etag);
+        });
+    }
+    updateTaskDetails(options, newTask) {
+        const taskId = newTask.id;
+        if (!options.description) {
+            return Promise.resolve(newTask);
+        }
+        return this
+            .getTaskDetailsEtag(taskId)
+            .then(etag => {
+            const requestOptionsTaskDetails = {
+                url: `${this.resource}/v1.0/planner/tasks/${taskId}/details`,
+                headers: {
+                    'accept': 'application/json;odata.metadata=none',
+                    'If-Match': etag,
+                    'Prefer': 'return=representation'
+                },
+                responseType: 'json',
+                data: {
+                    description: options.description
+                }
+            };
+            return request_1.default.patch(requestOptionsTaskDetails);
+        })
+            .then(taskDetails => {
+            return Object.assign(Object.assign({}, newTask), taskDetails);
+        });
+    }
+    generateUserAssignments(args) {
+        const assignments = {};
+        if (!args.options.assignedToUserIds && !args.options.assignedToUserNames) {
+            return Promise.resolve(assignments);
+        }
+        return this
+            .getUserIds(args.options)
+            .then((userIds) => {
+            userIds.map(x => assignments[x] = {
+                '@odata.type': '#microsoft.graph.plannerAssignment',
+                orderHint: ' !'
+            });
+            return Promise.resolve(assignments);
+        });
+    }
+    getBucketId(args, planId) {
+        if (args.options.bucketId) {
+            return Promise.resolve(args.options.bucketId);
+        }
+        const requestOptions = {
+            url: `${this.resource}/v1.0/planner/plans/${planId}/buckets`,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json'
+        };
+        return request_1.default
+            .get(requestOptions)
+            .then((response) => {
+            const bucket = response.value.find(val => val.name === args.options.bucketName);
+            if (!bucket) {
+                return Promise.reject(`The specified bucket does not exist`);
+            }
+            return Promise.resolve(bucket.id);
+        });
+    }
+    getPlanId(args) {
+        if (args.options.planId) {
+            return Promise.resolve(args.options.planId);
+        }
+        return this
+            .getGroupId(args)
+            .then((groupId) => {
+            const requestOptions = {
+                url: `${this.resource}/v1.0/planner/plans?$filter=(owner eq '${groupId}')`,
+                headers: {
+                    accept: 'application/json;odata.metadata=none'
+                },
+                responseType: 'json'
+            };
+            return request_1.default.get(requestOptions);
+        }).then((response) => {
+            const plan = response.value.find(val => val.title === args.options.planName);
+            if (!plan) {
+                return Promise.reject(`The specified plan does not exist`);
+            }
+            return Promise.resolve(plan.id);
+        });
+    }
+    getGroupId(args) {
+        if (args.options.ownerGroupId) {
+            return Promise.resolve(args.options.ownerGroupId);
+        }
+        const requestOptions = {
+            url: `${this.resource}/v1.0/groups?$filter=displayName eq '${encodeURIComponent(args.options.ownerGroupName)}'`,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json'
+        };
+        return request_1.default
+            .get(requestOptions)
+            .then(response => {
+            const group = response.value[0];
+            if (!group) {
+                return Promise.reject(`The specified owner group does not exist`);
+            }
+            return Promise.resolve(group.id);
+        });
+    }
+    getUserIds(options) {
+        if (options.assignedToUserIds) {
+            return Promise.resolve(options.assignedToUserIds.split(','));
+        }
+        // Hitting this section means assignedToUserNames won't be undefined
+        const userNames = options.assignedToUserNames;
+        const userArr = userNames.split(',').map(o => o.trim());
+        let userIds = [];
+        const 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 planner task creation. The following users provided are invalid : ${invalidUsers.join(',')}`);
+            }
+            return Promise.resolve(userIds);
+        });
+    }
+    options() {
+        const options = [
+            { option: '-t, --title <title>' },
+            { option: '--planId [planId]' },
+            { option: '--planName [planName]' },
+            { option: '--ownerGroupId [ownerGroupId]' },
+            { option: '--ownerGroupName [ownerGroupName]' },
+            { option: '--bucketId [bucketId]' },
+            { option: '--bucketName [bucketName]' },
+            { option: '--startDateTime [startDateTime]' },
+            { option: '--dueDateTime [dueDateTime]' },
+            { option: '--percentComplete [percentComplete]' },
+            { option: '--assignedToUserIds [assignedToUserIds]' },
+            { option: '--assignedToUserNames [assignedToUserNames]' },
+            { option: '--description [description]' },
+            { option: '--orderHint [orderHint]' }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        if (!args.options.planId && !args.options.planName) {
+            return 'Specify either planId or planName';
+        }
+        if (args.options.planId && args.options.planName) {
+            return 'Specify either planId or planName but not both';
+        }
+        if (args.options.planName && !args.options.ownerGroupId && !args.options.ownerGroupName) {
+            return 'Specify either ownerGroupId or ownerGroupName when using planName';
+        }
+        if (args.options.planName && args.options.ownerGroupId && args.options.ownerGroupName) {
+            return 'Specify either ownerGroupId or ownerGroupName when using planName but not both';
+        }
+        if (args.options.ownerGroupId && !Utils_1.default.isValidGuid(args.options.ownerGroupId)) {
+            return `${args.options.ownerGroupId} is not a valid GUID`;
+        }
+        if (!args.options.bucketId && !args.options.bucketName) {
+            return 'Specify either bucketId or bucketName';
+        }
+        if (args.options.bucketId && args.options.bucketName) {
+            return 'Specify either bucketId or bucketName but not both';
+        }
+        if (args.options.startDateTime && !Utils_1.default.isValidISODateTime(args.options.startDateTime)) {
+            return 'The startDateTime is not a valid ISO date string';
+        }
+        if (args.options.dueDateTime && !Utils_1.default.isValidISODateTime(args.options.dueDateTime)) {
+            return 'The dueDateTime is not a valid ISO date string';
+        }
+        if (args.options.percentComplete && isNaN(args.options.percentComplete)) {
+            return `percentComplete is not a number`;
+        }
+        if (args.options.percentComplete && (args.options.percentComplete < 0 || args.options.percentComplete > 100)) {
+            return `percentComplete should be between 0 and 100 `;
+        }
+        if (args.options.assignedToUserIds && !Utils_1.default.isValidGuidArray(args.options.assignedToUserIds.split(','))) {
+            return 'assignedToUserIds contains invalid GUID';
+        }
+        if (args.options.assignedToUserIds && args.options.assignedToUserNames) {
+            return 'Specify either assignedToUserIds or assignedToUserNames but not both';
+        }
+        return true;
+    }
+}
+module.exports = new PlannerTaskAddCommand();
+//# sourceMappingURL=task-add.js.map

package/dist/m365/planner/commands.js

@@ -7,6 +7,7 @@ exports.default = {
     PLAN_ADD: `${prefix} plan add`,
     PLAN_GET: `${prefix} plan get`,
     PLAN_LIST: `${prefix} plan list`,
+    TASK_ADD: `${prefix} task add`,
     TASK_LIST: `${prefix} task list`
 };
 //# sourceMappingURL=commands.js.map

package/dist/m365/spo/commands/group/group-user-add.js

@@ -3,8 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const cli_1 = require("../../../../cli");
 const Command_1 = require("../../../../Command");
 const request_1 = require("../../../../request");
-const SpoCommand_1 = require("../../../base/SpoCommand");
 const AadUserGetCommand = require("../../../aad/commands/user/user-get");
+const SpoCommand_1 = require("../../../base/SpoCommand");
 const commands_1 = require("../../commands");
 class SpoGroupUserAddCommand extends SpoCommand_1.default {
     get name() {
@@ -17,15 +17,21 @@ class SpoGroupUserAddCommand extends SpoCommand_1.default {
         return ['DisplayName', 'Email'];
     }
     commandAction(logger, args, cb) {
-        this.getOnlyActiveUsers(args, logger)
+        let groupId = 0;
+        this
+            .getGroupId(args)
+            .then((_groupId) => {
+            groupId = _groupId;
+            return this.getOnlyActiveUsers(args, logger);
+        })
             .then((resolvedUsernameList) => {
             if (this.verbose) {
-                logger.logToStderr(`Start adding Active user/s to SharePoint Group ${args.options.groupId}...`);
+                logger.logToStderr(`Start adding Active user/s to SharePoint Group ${args.options.groupId ? args.options.groupId : args.options.groupName}`);
             }
             const data = {
                 url: args.options.webUrl,
                 peoplePickerInput: this.getFormattedUserList(resolvedUsernameList),
-                roleValue: `group:${args.options.groupId}`
+                roleValue: `group:${groupId}`
             };
             const requestOptions = {
                 url: `${args.options.webUrl}/_api/SP.Web.ShareObject`,
@@ -46,24 +52,51 @@ class SpoGroupUserAddCommand extends SpoCommand_1.default {
             cb();
         }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
     }
+    getGroupId(args) {
+        if (args.options.groupId) {
+            return Promise.resolve(args.options.groupId);
+        }
+        const requestOptions = {
+            url: `${args.options.webUrl}/_api/web/sitegroups/GetByName('${encodeURIComponent(args.options.groupName)}')`,
+            headers: {
+                'accept': 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        return request_1.default
+            .get(requestOptions)
+            .then(response => {
+            const groupId = response.Id;
+            if (!groupId) {
+                return Promise.reject(`The specified group not exist in the SharePoint site`);
+            }
+            return Promise.resolve(groupId);
+        });
+    }
     getOnlyActiveUsers(args, logger) {
         if (this.verbose) {
             logger.logToStderr(`Removing Users which are not active from the original list`);
         }
-        const activeUsernamelist = [];
-        return Promise.all(args.options.userName.split(",").map(singleUsername => {
+        const activeUserNameList = [];
+        const userInfo = args.options.userName ? args.options.userName : args.options.email;
+        return Promise.all(userInfo.split(',').map(singleUserName => {
             const options = {
-                userName: singleUsername.trim(),
                 output: 'json',
                 debug: args.options.debug,
                 verbose: args.options.verbose
             };
+            if (args.options.userName) {
+                options.userName = singleUserName.trim();
+            }
+            else {
+                options.email = singleUserName.trim();
+            }
             return cli_1.Cli.executeCommandWithOutput(AadUserGetCommand, { options: Object.assign(Object.assign({}, options), { _: [] }) })
                 .then((getUserGetOutput) => {
                 if (this.debug) {
                     logger.logToStderr(getUserGetOutput.stderr);
                 }
-                activeUsernamelist.push(JSON.parse(getUserGetOutput.stdout).userPrincipalName);
+                activeUserNameList.push(JSON.parse(getUserGetOutput.stdout).userPrincipalName);
             }, (err) => {
                 if (this.debug) {
                     logger.logToStderr(err.stderr);
@@ -71,7 +104,7 @@ class SpoGroupUserAddCommand extends SpoCommand_1.default {
             });
         }))
             .then(() => {
-            return Promise.resolve(activeUsernamelist);
+            return Promise.resolve(activeUserNameList);
         });
     }
     getFormattedUserList(activeUserList) {
@@ -86,10 +119,16 @@ class SpoGroupUserAddCommand extends SpoCommand_1.default {
                 option: '-u, --webUrl <webUrl>'
             },
             {
-                option: '--groupId <groupId>'
+                option: '--groupId [groupId]'
+            },
+            {
+                option: '--groupName [groupName]'
+            },
+            {
+                option: '--userName [userName]'
             },
             {
-                option: '--userName <userName>'
+                option: '--email [email]'
             }
         ];
         const parentOptions = super.options();
@@ -100,8 +139,20 @@ class SpoGroupUserAddCommand extends SpoCommand_1.default {
         if (isValidSharePointUrl !== true) {
             return isValidSharePointUrl;
         }
-        if (typeof args.options.groupId !== 'number') {
-            return `Group Id : ${args.options.groupId} is not a number`;
+        if (!args.options.groupId && !args.options.groupName) {
+            return 'Specify either groupId or groupName';
+        }
+        if (args.options.groupId && args.options.groupName) {
+            return 'Specify either groupId or groupName but not both';
+        }
+        if (!args.options.userName && !args.options.email) {
+            return 'Specify either userName or email';
+        }
+        if (args.options.userName && args.options.email) {
+            return 'Specify either userName or email but not both';
+        }
+        if (args.options.groupId && isNaN(args.options.groupId)) {
+            return `Specified groupId ${args.options.groupId} is not a number`;
         }
         return true;
     }

package/dist/m365/spo/commands/site/site-ensure.js

@@ -59,7 +59,7 @@ class SpoSiteEnsureCommand extends SpoCommand_1.default {
             if (this.debug) {
                 logger.logToStderr(err.stderr);
             }
-            if (err.error.message !== 'Request failed with status code 404') {
+            if (err.error.message !== '404 FILE NOT FOUND') {
                 return Promise.reject(err);
             }
             if (this.verbose) {