@pnp/cli-microsoft365 4.4.0-beta.23194d7 → 4.4.0-beta.3913c30

package/dist/m365/planner/AppliedCategories.js

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

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

@@ -0,0 +1,357 @@
+"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 PlannerTaskSetCommand extends GraphCommand_1.default {
+    constructor() {
+        super(...arguments);
+        this.allowedAppliedCategories = ['category1', 'category2', 'category3', 'category4', 'category5', 'category6'];
+    }
+    get name() {
+        return commands_1.default.TASK_SET;
+    }
+    get description() {
+        return 'Updates a Microsoft Planner Task';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.title = typeof args.options.title !== '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';
+        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.assigneePriority = typeof args.options.assigneePriority !== 'undefined';
+        telemetryProps.description = typeof args.options.description !== 'undefined';
+        telemetryProps.appliedCategories = typeof args.options.appliedCategories !== 'undefined';
+        telemetryProps.orderHint = typeof args.options.orderHint !== 'undefined';
+        return telemetryProps;
+    }
+    commandAction(logger, args, cb) {
+        this
+            .getBucketId(args.options)
+            .then(bucketId => {
+            this.bucketId = bucketId;
+            return this.generateUserAssignments(args.options);
+        })
+            .then(resultAssignments => {
+            this.assignments = resultAssignments;
+            return this.getTaskEtag(args.options.id);
+        })
+            .then(etag => {
+            const appliedCategories = this.generateAppliedCategories(args.options);
+            const data = this.mapRequestBody(args.options, appliedCategories);
+            const requestOptions = {
+                url: `${this.resource}/v1.0/planner/tasks/${args.options.id}`,
+                headers: {
+                    'accept': 'application/json;odata.metadata=none',
+                    'If-Match': etag,
+                    'Prefer': 'return=representation'
+                },
+                responseType: 'json',
+                data: data
+            };
+            return request_1.default.patch(requestOptions);
+        })
+            .then(newTask => this.updateTaskDetails(args.options, newTask))
+            .then((res) => {
+            logger.log(res);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    updateTaskDetails(options, newTask) {
+        if (!options.description) {
+            return Promise.resolve(newTask);
+        }
+        const taskId = newTask.id;
+        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);
+        });
+    }
+    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);
+        });
+    }
+    getTaskEtag(taskId) {
+        const requestOptions = {
+            url: `${this.resource}/v1.0/planner/tasks/${encodeURIComponent(taskId)}`,
+            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`);
+            }
+            return Promise.resolve(etag);
+        });
+    }
+    generateAppliedCategories(options) {
+        if (!options.appliedCategories) {
+            return {};
+        }
+        const categories = {};
+        options.appliedCategories.toLocaleLowerCase().split(',').forEach(x => categories[x] = true);
+        return categories;
+    }
+    generateUserAssignments(options) {
+        const assignments = {};
+        if (!options.assignedToUserIds && !options.assignedToUserNames) {
+            return Promise.resolve(assignments);
+        }
+        return this
+            .getUserIds(options)
+            .then((userIds) => {
+            userIds.forEach(x => assignments[x] = {
+                '@odata.type': '#microsoft.graph.plannerAssignment',
+                orderHint: ' !'
+            });
+            return Promise.resolve(assignments);
+        });
+    }
+    getUserIds(options) {
+        if (options.assignedToUserIds) {
+            return Promise.resolve(options.assignedToUserIds.split(',').map(o => o.trim()));
+        }
+        // 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: {
+                    'accept ': 'application/json;odata.metadata=none'
+                },
+                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 update. The following users provided are invalid : ${invalidUsers.join(',')}`);
+            }
+            return Promise.resolve(userIds);
+        });
+    }
+    getBucketId(options) {
+        if (options.bucketId) {
+            return Promise.resolve(options.bucketId);
+        }
+        if (!options.bucketName) {
+            return Promise.resolve(undefined);
+        }
+        return this
+            .getPlanId(options)
+            .then(planId => {
+            const requestOptions = {
+                url: `${this.resource}/v1.0/planner/plans/${planId}/buckets?$select=id,name`,
+                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 === options.bucketName);
+            if (!bucket) {
+                return Promise.reject(`The specified bucket does not exist`);
+            }
+            return Promise.resolve(bucket.id);
+        });
+    }
+    getPlanId(options) {
+        if (options.planId) {
+            return Promise.resolve(options.planId);
+        }
+        return this
+            .getGroupId(options)
+            .then((groupId) => {
+            const requestOptions = {
+                url: `${this.resource}/v1.0/planner/plans?$filter=(owner eq '${groupId}')&$select=id,title`,
+                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 === options.planName);
+            if (!plan) {
+                return Promise.reject(`The specified plan does not exist`);
+            }
+            return Promise.resolve(plan.id);
+        });
+    }
+    getGroupId(options) {
+        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 group = response.value[0];
+            if (!group) {
+                return Promise.reject(`The specified owner group does not exist`);
+            }
+            return Promise.resolve(group.id);
+        });
+    }
+    mapRequestBody(options, appliedCategories) {
+        const requestBody = {};
+        if (options.title) {
+            requestBody.title = options.title;
+        }
+        if (this.bucketId) {
+            requestBody.bucketId = this.bucketId;
+        }
+        if (options.startDateTime) {
+            requestBody.startDateTime = options.startDateTime;
+        }
+        if (options.dueDateTime) {
+            requestBody.dueDateTime = options.dueDateTime;
+        }
+        if (options.percentComplete) {
+            requestBody.percentComplete = options.percentComplete;
+        }
+        if (this.assignments && Object.keys(this.assignments).length > 0) {
+            requestBody.assignments = this.assignments;
+        }
+        if (options.assigneePriority) {
+            requestBody.assigneePriority = options.assigneePriority;
+        }
+        if (appliedCategories && Object.keys(appliedCategories).length > 0) {
+            requestBody.appliedCategories = appliedCategories;
+        }
+        if (options.orderHint) {
+            requestBody.orderHint = options.orderHint;
+        }
+        return requestBody;
+    }
+    options() {
+        const options = [
+            { option: '-i, --id <id>' },
+            { 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: '--assigneePriority [assigneePriority]' },
+            { option: '--description [description]' },
+            { option: '--appliedCategories [appliedCategories]' },
+            { option: '--orderHint [orderHint]' }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        if (args.options.bucketId && args.options.bucketName) {
+            return 'Specify either bucketId or bucketName but not both';
+        }
+        if (args.options.bucketName && !args.options.planId && !args.options.planName) {
+            return 'Specify either planId or planName when using bucketName';
+        }
+        if (args.options.bucketName && args.options.planId && args.options.planName) {
+            return 'Specify either planId or planName when using bucketName 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.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';
+        }
+        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 category1, category2, category3, category4, category5 and/or category6 as properties';
+        }
+        return true;
+    }
+}
+module.exports = new PlannerTaskSetCommand();
+//# sourceMappingURL=task-set.js.map

package/dist/m365/planner/commands.js

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

package/docs/docs/cmd/planner/task/task-set.md

@@ -0,0 +1,99 @@
+# planner task set
+
+Updates a Microsoft Planner task
+
+## Usage
+
+```sh
+m365 planner task set [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: ID of the task.
+
+`-t, --title [title]`
+: New title of the task.
+
+`--bucketId [bucketId]`
+: ID of the bucket to move the task to. Specify either `bucketId` or `bucketName` but not both.
+
+`--bucketName [bucketName]`
+: Name of the bucket to move the task to. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` but not both.
+
+`--planId [planId]`
+: ID of the plan to move the task to. Specify either `planId` or `planName` but not both.
+
+`--planName [planName]`
+: Name of the plan to move the task to. Specify either `planId` or `planName` but not both.
+
+`--ownerGroupId [ownerGroupId]`
+: ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
+
+`--ownerGroupName [ownerGroupName]`
+: Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
+
+`--startDateTime [startDateTime]`
+: The date and time when the task started. This should be defined as a valid ISO 8601 string. `2021-12-16T18:28:48.6964197Z`
+
+`--dueDateTime [dueDateTime]`
+: The date and time when the task is due. This should be defined as a valid ISO 8601 string. `2021-12-16T18:28:48.6964197Z`
+
+`--percentComplete [percentComplete]`
+: Percentage of task completion. Number between 0 and 100.
+
+`--assignedToUserIds [assignedToUserIds]`
+: Comma-separated IDs of the assignees that should be added to the task assignment. Specify either `assignedToUserIds` or `assignedToUserNames` but not both.
+
+`--assignedToUserNames [assignedToUserNames]`
+: Comma-separated UPNs of the assignees that should be added to the task assignment. Specify either `assignedToUserIds` or `assignedToUserNames` but not both.
+
+`--description [description]`
+: Description of the task
+
+`--orderHint [orderHint]`
+: Hint used to order items of this type in a list view
+
+`--assigneePriority [assigneePriority]`
+: Hint used to order items of this type in a list view
+
+`--appliedCategories [appliedCategories]`
+: Comma-separated categories that should be added to the task
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+When you specify the value for `percentageComplete`, consider the following:
+
+- when set to 0, the task is considered _Not started_
+- when set between 1 and 99, the task is considered _In progress_
+- when set to 100, the task is considered _Completed_
+
+You can add up to 6 categories to the task. An example to add _category1_ and _category3_ would be `category1,category3`.
+
+## Examples
+
+Updates a Microsoft Planner task name to _My Planner Task_ for the task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_
+
+```sh
+m365 planner task set --id "Z-RLQGfppU6H3663DBzfs5gAMD3o" --title "My Planner Task"
+```
+
+Moves a Microsoft Planner task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_ to the bucket named _My Planner Bucket_. Based on the plan with the name _My Planner Plan_ owned by the group _My Planner Group_
+
+```sh
+m365 planner task set  --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --bucketName "My Planner Bucket" --planName "My Planner Plan" --ownerGroupName "My Planner Group"
+```
+
+Marks a Microsoft Planner task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_ as 50% complete and assigned to categories 1 and 3.
+
+```sh
+m365 planner task set --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2"  --percentComplete 50 --appliedCategories "category1,category3"
+```
+
+## Additional information
+
+- Using order hints in Planner: [https://docs.microsoft.com/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0](https://docs.microsoft.com/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0)
+- Applied categories in Planner: [https://docs.microsoft.com/graph/api/resources/plannerappliedcategories?view=graph-rest-1.0](https://docs.microsoft.com/en-us/graph/api/resources/plannerappliedcategories?view=graph-rest-1.0)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "4.4.0-beta.23194d7",
+  "version": "4.4.0-beta.3913c30",
   "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
   "license": "MIT",
   "main": "./dist/index.js",