@pnp/cli-microsoft365 5.3.0 → 5.4.0-beta.1107211

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

@@ -2,11 +2,18 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const Auth_1 = require("../../../../Auth");
 const request_1 = require("../../../../request");
-const planner_1 = require("../../../../utils/planner");
 const utils_1 = require("../../../../utils");
+const aadGroup_1 = require("../../../../utils/aadGroup");
+const planner_1 = require("../../../../utils/planner");
 const GraphCommand_1 = require("../../../base/GraphCommand");
 const commands_1 = require("../../commands");
+const taskPriority_1 = require("../../taskPriority");
 class PlannerTaskAddCommand extends GraphCommand_1.default {
+    constructor() {
+        super(...arguments);
+        this.allowedAppliedCategories = ['category1', 'category2', 'category3', 'category4', 'category5', 'category6'];
+        this.allowedPreviewTypes = ['automatic', 'nopreview', 'checklist', 'description', 'reference'];
+    }
     get name() {
         return commands_1.default.TASK_ADD;
     }
@@ -26,8 +33,12 @@ class PlannerTaskAddCommand extends GraphCommand_1.default {
         telemetryProps.percentComplete = typeof args.options.percentComplete !== 'undefined';
         telemetryProps.assignedToUserIds = typeof args.options.assignedToUserIds !== 'undefined';
         telemetryProps.assignedToUserNames = typeof args.options.assignedToUserNames !== 'undefined';
+        telemetryProps.assigneePriority = typeof args.options.assigneePriority !== 'undefined';
         telemetryProps.description = typeof args.options.description !== 'undefined';
+        telemetryProps.appliedCategories = typeof args.options.appliedCategories !== 'undefined';
+        telemetryProps.previewType = typeof args.options.previewType !== 'undefined';
         telemetryProps.orderHint = typeof args.options.orderHint !== 'undefined';
+        telemetryProps.priority = typeof args.options.priority !== 'undefined';
         return telemetryProps;
     }
     commandAction(logger, args, cb) {
@@ -46,10 +57,11 @@ class PlannerTaskAddCommand extends GraphCommand_1.default {
             return this.generateUserAssignments(args);
         })
             .then(assignments => {
+            const appliedCategories = this.generateAppliedCategories(args.options);
             const requestOptions = {
                 url: `${this.resource}/v1.0/planner/tasks`,
                 headers: {
-                    'accept': 'application/json;odata.metadata=none'
+                    accept: 'application/json;odata.metadata=none'
                 },
                 responseType: 'json',
                 data: {
@@ -60,7 +72,10 @@ class PlannerTaskAddCommand extends GraphCommand_1.default {
                     dueDateTime: args.options.dueDateTime,
                     percentComplete: args.options.percentComplete,
                     assignments: assignments,
-                    orderHint: args.options.orderHint
+                    orderHint: args.options.orderHint,
+                    assigneePriority: args.options.assigneePriority,
+                    appliedCategories: appliedCategories,
+                    priority: taskPriority_1.taskPriority.getPriorityValue(args.options.priority)
                 }
             };
             return request_1.default.post(requestOptions);
@@ -89,9 +104,17 @@ class PlannerTaskAddCommand extends GraphCommand_1.default {
             return Promise.resolve(etag);
         });
     }
+    generateAppliedCategories(options) {
+        if (!options.appliedCategories) {
+            return {};
+        }
+        const categories = {};
+        options.appliedCategories.toLocaleLowerCase().split(',').forEach(x => categories[x] = true);
+        return categories;
+    }
     updateTaskDetails(options, newTask) {
         const taskId = newTask.id;
-        if (!options.description) {
+        if (!options.description && !options.previewType) {
             return Promise.resolve(newTask);
         }
         return this
@@ -106,7 +129,8 @@ class PlannerTaskAddCommand extends GraphCommand_1.default {
                 },
                 responseType: 'json',
                 data: {
-                    description: options.description
+                    description: options.description,
+                    previewType: options.previewType
                 }
             };
             return request_1.default.patch(requestOptionsTaskDetails);
@@ -164,22 +188,9 @@ class PlannerTaskAddCommand extends GraphCommand_1.default {
         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);
-        });
+        return aadGroup_1.aadGroup
+            .getGroupByDisplayName(args.options.ownerGroupName)
+            .then(group => group.id);
     }
     getUserIds(options) {
         if (options.assignedToUserIds) {
@@ -227,8 +238,18 @@ class PlannerTaskAddCommand extends GraphCommand_1.default {
             { option: '--percentComplete [percentComplete]' },
             { option: '--assignedToUserIds [assignedToUserIds]' },
             { option: '--assignedToUserNames [assignedToUserNames]' },
+            { option: '--assigneePriority [assigneePriority]' },
             { option: '--description [description]' },
-            { option: '--orderHint [orderHint]' }
+            {
+                option: '--appliedCategories [appliedCategories]',
+                autocomplete: this.allowedAppliedCategories
+            },
+            {
+                option: '--previewType [previewType]',
+                autocomplete: this.allowedPreviewTypes
+            },
+            { option: '--orderHint [orderHint]' },
+            { option: '--priority [priority]', autocomplete: taskPriority_1.taskPriority.priorityValues }
         ];
         const parentOptions = super.options();
         return options.concat(parentOptions);
@@ -265,7 +286,7 @@ class PlannerTaskAddCommand extends GraphCommand_1.default {
             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 `;
+            return `percentComplete should be between 0 and 100`;
         }
         if (args.options.assignedToUserIds && !utils_1.validation.isValidGuidArray(args.options.assignedToUserIds.split(','))) {
             return 'assignedToUserIds contains invalid GUID';
@@ -273,6 +294,22 @@ class PlannerTaskAddCommand extends GraphCommand_1.default {
         if (args.options.assignedToUserIds && args.options.assignedToUserNames) {
             return 'Specify either assignedToUserIds or assignedToUserNames but not both';
         }
+        if (args.options.appliedCategories && args.options.appliedCategories.split(',').filter(category => this.allowedAppliedCategories.indexOf(category.toLocaleLowerCase()) < 0).length !== 0) {
+            return `The appliedCategories contains invalid value. Specify either ${this.allowedAppliedCategories.join(', ')} as properties`;
+        }
+        if (args.options.previewType && this.allowedPreviewTypes.indexOf(args.options.previewType.toLocaleLowerCase()) === -1) {
+            return `${args.options.previewType} is not a valid preview type value. Allowed values are ${this.allowedPreviewTypes.join(', ')}`;
+        }
+        if (args.options.priority !== undefined) {
+            if (typeof args.options.priority === "number") {
+                if (isNaN(args.options.priority) || args.options.priority < 0 || args.options.priority > 10 || !Number.isInteger(args.options.priority)) {
+                    return 'priority should be an integer between 0 and 10.';
+                }
+            }
+            else if (taskPriority_1.taskPriority.priorityValues.map(l => l.toLowerCase()).indexOf(args.options.priority.toString().toLowerCase()) === -1) {
+                return `${args.options.priority} is not a valid priority value. Allowed values are ${taskPriority_1.taskPriority.priorityValues.join('|')}.`;
+            }
+        }
         return true;
     }
 }

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

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const accessToken_1 = require("../../../../utils/accessToken");
+const uuid_1 = require("uuid");
+const Auth_1 = require("../../../../Auth");
+const GraphCommand_1 = require("../../../base/GraphCommand");
+const commands_1 = require("../../commands");
+const request_1 = require("../../../../request");
+class PlannerTaskChecklistItemAddCommand extends GraphCommand_1.default {
+    get name() {
+        return commands_1.default.TASK_CHECKLISTITEM_ADD;
+    }
+    get description() {
+        return 'Adds a new checklist item to a Planner task.';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.isChecked = args.options.isChecked || false;
+        return telemetryProps;
+    }
+    defaultProperties() {
+        return ['id', 'title', 'isChecked'];
+    }
+    commandAction(logger, args, cb) {
+        if (accessToken_1.accessToken.isAppOnlyAccessToken(Auth_1.default.service.accessTokens[this.resource].accessToken)) {
+            this.handleError('This command does not support application permissions.', logger, cb);
+            return;
+        }
+        this
+            .getTaskDetailsEtag(args.options.taskId)
+            .then(etag => {
+            const body = {
+                checklist: {
+                    // Generate new GUID for new task checklist item
+                    [(0, uuid_1.v4)()]: {
+                        '@odata.type': 'microsoft.graph.plannerChecklistItem',
+                        title: args.options.title,
+                        isChecked: args.options.isChecked || false
+                    }
+                }
+            };
+            const requestOptions = {
+                url: `${this.resource}/v1.0/planner/tasks/${encodeURIComponent(args.options.taskId)}/details`,
+                headers: {
+                    accept: 'application/json;odata.metadata=none',
+                    prefer: 'return=representation',
+                    'if-match': etag
+                },
+                responseType: 'json',
+                data: body
+            };
+            return request_1.default.patch(requestOptions);
+        })
+            .then((result) => {
+            if (args.options.output === 'json') {
+                logger.log(result.checklist);
+            }
+            else {
+                // Transform checklist item object to text friendly format
+                const output = Object.getOwnPropertyNames(result.checklist).map(prop => (Object.assign({ id: prop }, result.checklist[prop])));
+                logger.log(output);
+            }
+            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;odata.metadata=minimal'
+            },
+            responseType: 'json'
+        };
+        return request_1.default
+            .get(requestOptions)
+            .then((task) => task['@odata.etag'], () => Promise.reject('Planner task was not found.'));
+    }
+    options() {
+        const options = [
+            { option: '-i, --taskId <taskId>' },
+            { option: '-t, --title <title>' },
+            { option: '--isChecked' }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+}
+module.exports = new PlannerTaskChecklistItemAddCommand();
+//# sourceMappingURL=task-checklistitem-add.js.map

package/dist/m365/planner/commands/task/{task-details-get.js → task-checklistitem-list.js}

@@ -5,12 +5,15 @@ const Auth_1 = require("../../../../Auth");
 const request_1 = require("../../../../request");
 const GraphCommand_1 = require("../../../base/GraphCommand");
 const commands_1 = require("../../commands");
-class PlannerTaskDetailsGetCommand extends GraphCommand_1.default {
+class PlannerTaskChecklistItemListCommand extends GraphCommand_1.default {
     get name() {
-        return commands_1.default.TASK_DETAILS_GET;
+        return commands_1.default.TASK_CHECKLISTITEM_LIST;
     }
     get description() {
-        return 'Retrieve the details of the specified planner task';
+        return "Lists the checklist items of a Planner task.";
+    }
+    defaultProperties() {
+        return ['id', 'title', 'isChecked'];
     }
     commandAction(logger, args, cb) {
         if (utils_1.accessToken.isAppOnlyAccessToken(Auth_1.default.service.accessTokens[this.resource].accessToken)) {
@@ -18,28 +21,33 @@ class PlannerTaskDetailsGetCommand extends GraphCommand_1.default {
             return;
         }
         const requestOptions = {
-            url: `${this.resource}/v1.0/planner/tasks/${encodeURIComponent(args.options.taskId)}/details`,
+            url: `${this.resource}/v1.0/planner/tasks/${encodeURIComponent(args.options.taskId)}/details?$select=checklist`,
             headers: {
-                accept: 'application/json;odata.metadata=none'
+                accept: "application/json;odata.metadata=none"
             },
-            responseType: 'json'
+            responseType: "json"
         };
-        request_1.default
-            .get(requestOptions)
-            .then((res) => {
-            logger.log(res);
+        request_1.default.get(requestOptions).then((res) => {
+            if (!args.options.output || args.options.output === 'json') {
+                logger.log(res.checklist);
+            }
+            else {
+                //converted to text friendly output
+                const output = Object.getOwnPropertyNames(res.checklist).map(prop => (Object.assign({ id: prop }, res.checklist[prop])));
+                logger.log(output);
+            }
             cb();
         }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
     }
     options() {
         const options = [
             {
-                option: '-i, --taskId <taskId>'
+                option: "-i, --taskId <taskId>"
             }
         ];
         const parentOptions = super.options();
         return options.concat(parentOptions);
     }
 }
-module.exports = new PlannerTaskDetailsGetCommand();
-//# sourceMappingURL=task-details-get.js.map
+module.exports = new PlannerTaskChecklistItemListCommand();
+//# sourceMappingURL=task-checklistitem-list.js.map

package/dist/m365/planner/commands/task/task-checklistitem-remove.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_1 = require("../../../../cli");
+const request_1 = require("../../../../request");
+const GraphCommand_1 = require("../../../base/GraphCommand");
+const commands_1 = require("../../commands");
+class PlannerTaskChecklistItemRemoveCommand extends GraphCommand_1.default {
+    get name() {
+        return commands_1.default.TASK_CHECKLISTITEM_REMOVE;
+    }
+    get description() {
+        return 'Removes the checklist item from the planner task';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.confirm = (!(!args.options.confirm)).toString();
+        return telemetryProps;
+    }
+    commandAction(logger, args, cb) {
+        if (args.options.confirm) {
+            this.removeChecklistitem(logger, args, cb);
+        }
+        else {
+            cli_1.Cli.prompt({
+                type: 'confirm',
+                name: 'continue',
+                default: false,
+                message: `Are you sure you want to remove the checklist item with id ${args.options.id} from the planner task?`
+            }, (result) => {
+                if (!result.continue) {
+                    cb();
+                }
+                else {
+                    this.removeChecklistitem(logger, args, cb);
+                }
+            });
+        }
+    }
+    removeChecklistitem(logger, args, cb) {
+        this
+            .getTaskDetails(args.options.taskId)
+            .then(task => {
+            if (!task.checklist || !task.checklist[args.options.id]) {
+                return Promise.reject(`The specified checklist item with id ${args.options.id} does not exist`);
+            }
+            const requestOptionsTaskDetails = {
+                url: `${this.resource}/v1.0/planner/tasks/${args.options.taskId}/details`,
+                headers: {
+                    'accept': 'application/json;odata.metadata=none',
+                    'If-Match': task['@odata.etag'],
+                    'Prefer': 'return=representation'
+                },
+                responseType: 'json',
+                data: {
+                    checklist: {
+                        [args.options.id]: null
+                    }
+                }
+            };
+            return request_1.default.patch(requestOptionsTaskDetails);
+        })
+            .then(_ => cb(), (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    getTaskDetails(taskId) {
+        const requestOptions = {
+            url: `${this.resource}/v1.0/planner/tasks/${encodeURIComponent(taskId)}/details?$select=checklist`,
+            headers: {
+                accept: 'application/json;odata.metadata=minimal'
+            },
+            responseType: 'json'
+        };
+        return request_1.default.get(requestOptions);
+    }
+    options() {
+        const options = [
+            { option: '-i, --id <id>' },
+            { option: '--taskId <taskId>' },
+            { option: '--confirm' }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+}
+module.exports = new PlannerTaskChecklistItemRemoveCommand();
+//# sourceMappingURL=task-checklistitem-remove.js.map

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

@@ -1,41 +1,78 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const utils_1 = require("../../../../utils");
+const Auth_1 = require("../../../../Auth");
 const request_1 = require("../../../../request");
-const utils_2 = require("../../../../utils");
+const utils_1 = require("../../../../utils");
+const aadGroup_1 = require("../../../../utils/aadGroup");
 const planner_1 = require("../../../../utils/planner");
 const GraphCommand_1 = require("../../../base/GraphCommand");
 const commands_1 = require("../../commands");
-const Auth_1 = require("../../../../Auth");
 class PlannerTaskGetCommand extends GraphCommand_1.default {
     get name() {
         return commands_1.default.TASK_GET;
     }
+    alias() {
+        return [commands_1.default.TASK_DETAILS_GET];
+    }
     get description() {
-        return 'Retrieve the the specified planner task';
+        return 'Retrieve the specified planner task';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.id = typeof args.options.id !== 'undefined';
+        telemetryProps.title = typeof args.options.title !== 'undefined';
+        telemetryProps.bucketId = typeof args.options.bucketId !== 'undefined';
+        telemetryProps.bucketName = typeof args.options.bucketName !== 'undefined';
+        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';
+        return telemetryProps;
     }
     commandAction(logger, args, cb) {
+        this.showDeprecationWarning(logger, commands_1.default.TASK_DETAILS_GET, commands_1.default.TASK_GET);
         if (utils_1.accessToken.isAppOnlyAccessToken(Auth_1.default.service.accessTokens[this.resource].accessToken)) {
             this.handleError('This command does not support application permissions.', logger, cb);
             return;
         }
+        // This check has been added to support task details get alias. Needs to be removed when deprecation is removed. 
+        if (args.options.taskId) {
+            args.options.id = args.options.taskId;
+        }
         this
             .getTaskId(args.options)
-            .then(taskId => {
-            const requestOptions = {
-                url: `${this.resource}/beta/planner/tasks/${encodeURIComponent(taskId)}`,
-                headers: {
-                    accept: 'application/json;odata.metadata=none'
-                },
-                responseType: 'json'
-            };
-            return request_1.default.get(requestOptions);
-        })
+            .then(taskId => this.getTask(taskId))
+            .then(task => this.getTaskDetails(task))
             .then((res) => {
             logger.log(res);
             cb();
         }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
     }
+    getTask(taskId) {
+        const requestOptions = {
+            url: `${this.resource}/v1.0/planner/tasks/${encodeURIComponent(taskId)}`,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json'
+        };
+        return request_1.default.get(requestOptions);
+    }
+    getTaskDetails(task) {
+        const requestOptionsTaskDetails = {
+            url: `${this.resource}/v1.0/planner/tasks/${task.id}/details`,
+            headers: {
+                'accept': 'application/json;odata.metadata=none',
+                'Prefer': 'return=representation'
+            },
+            responseType: 'json'
+        };
+        return request_1.default
+            .get(requestOptionsTaskDetails)
+            .then(taskDetails => {
+            return Object.assign(Object.assign({}, task), taskDetails);
+        });
+    }
     getTaskId(options) {
         if (options.id) {
             return Promise.resolve(options.id);
@@ -105,28 +142,18 @@ class PlannerTaskGetCommand extends GraphCommand_1.default {
         if (options.ownerGroupId) {
             return Promise.resolve(options.ownerGroupId);
         }
-        const requestOptions = {
-            url: `${this.resource}/v1.0/groups?$filter=displayName eq '${encodeURIComponent(options.ownerGroupName)}'&$select=id`,
-            headers: {
-                accept: 'application/json;odata.metadata=none'
-            },
-            responseType: 'json'
-        };
-        return request_1.default
-            .get(requestOptions)
-            .then(response => {
-            const groups = response.value;
-            if (!groups.length) {
-                return Promise.reject(`The specified ownerGroup ${options.ownerGroupName} does not exist`);
-            }
-            if (groups.length > 1) {
-                return Promise.reject(`Multiple ownerGroups with name ${options.ownerGroupName} found: ${groups.map(x => x.id)}`);
-            }
-            return Promise.resolve(groups[0].id);
-        });
+        return aadGroup_1.aadGroup
+            .getGroupByDisplayName(options.ownerGroupName)
+            .then(group => group.id);
+    }
+    optionSets() {
+        return [
+            ['id', 'title']
+        ];
     }
     options() {
         const options = [
+            { option: '--taskId [taskId]' },
             { option: '-i, --id [id]' },
             { option: '-t, --title [title]' },
             { option: '--bucketId [bucketId]' },
@@ -158,7 +185,7 @@ class PlannerTaskGetCommand extends GraphCommand_1.default {
         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_2.validation.isValidGuid(args.options.ownerGroupId)) {
+        if (args.options.ownerGroupId && !utils_1.validation.isValidGuid(args.options.ownerGroupId)) {
             return `${args.options.ownerGroupId} is not a valid GUID`;
         }
         return true;

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

@@ -6,6 +6,7 @@ const request_1 = require("../../../../request");
 const planner_1 = require("../../../../utils/planner");
 const GraphCommand_1 = require("../../../base/GraphCommand");
 const commands_1 = require("../../commands");
+const aadGroup_1 = require("../../../../utils/aadGroup");
 class PlannerTaskListCommand extends GraphCommand_1.default {
     get name() {
         return commands_1.default.TASK_LIST;
@@ -118,22 +119,9 @@ class PlannerTaskListCommand extends GraphCommand_1.default {
         if (args.options.ownerGroupId) {
             return Promise.resolve(encodeURIComponent(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);
-        });
+        return aadGroup_1.aadGroup
+            .getGroupByDisplayName(args.options.ownerGroupName)
+            .then(group => group.id);
     }
     mergeTaskPriority(taskItems, betaTaskItems) {
         const findBetaTask = (id) => betaTaskItems.find(task => task.id === id);