@pnp/cli-microsoft365 5.4.0-beta.3879fc9 → 5.4.0-beta.5d38887

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

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const Auth_1 = require("../../../../Auth");
 const request_1 = require("../../../../request");
 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");
@@ -10,6 +11,9 @@ 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 specified planner task';
     }
@@ -26,27 +30,49 @@ class PlannerTaskGetCommand extends GraphCommand_1.default {
         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}/v1.0/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);
@@ -116,25 +142,9 @@ 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 [
@@ -143,6 +153,7 @@ class PlannerTaskGetCommand extends GraphCommand_1.default {
     }
     options() {
         const options = [
+            { option: '--taskId [taskId]' },
             { option: '-i, --id [id]' },
             { option: '-t, --title [title]' },
             { option: '--bucketId [bucketId]' },

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

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

@@ -0,0 +1,125 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_1 = require("../../../../cli");
+const request_1 = require("../../../../request");
+const utils_1 = require("../../../../utils");
+const GraphCommand_1 = require("../../../base/GraphCommand");
+const commands_1 = require("../../commands");
+class PlannerTaskReferenceRemoveCommand extends GraphCommand_1.default {
+    get name() {
+        return commands_1.default.TASK_REFERENCE_REMOVE;
+    }
+    get description() {
+        return 'Removes the reference from the Planner task';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.url = typeof args.options.url !== 'undefined';
+        telemetryProps.alias = typeof args.options.alias !== 'undefined';
+        telemetryProps.confirm = (!(!args.options.confirm)).toString();
+        return telemetryProps;
+    }
+    commandAction(logger, args, cb) {
+        if (args.options.confirm) {
+            this.removeReference(logger, args, cb);
+        }
+        else {
+            cli_1.Cli.prompt({
+                type: 'confirm',
+                name: 'continue',
+                default: false,
+                message: `Are you sure you want to remove the reference from the Planner task?`
+            }, (result) => {
+                if (!result.continue) {
+                    cb();
+                }
+                else {
+                    this.removeReference(logger, args, cb);
+                }
+            });
+        }
+    }
+    removeReference(logger, args, cb) {
+        this
+            .getTaskDetailsEtagAndUrl(args.options)
+            .then(({ etag, url }) => {
+            const requestOptionsTaskDetails = {
+                url: `${this.resource}/v1.0/planner/tasks/${args.options.taskId}/details`,
+                headers: {
+                    'accept': 'application/json;odata.metadata=none',
+                    'If-Match': etag,
+                    'Prefer': 'return=representation'
+                },
+                responseType: 'json',
+                data: {
+                    references: {
+                        [utils_1.formatting.openTypesEncoder(url)]: null
+                    }
+                }
+            };
+            return request_1.default.patch(requestOptionsTaskDetails);
+        })
+            .then(() => {
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    getTaskDetailsEtagAndUrl(options) {
+        const requestOptions = {
+            url: `${this.resource}/v1.0/planner/tasks/${encodeURIComponent(options.taskId)}/details`,
+            headers: {
+                accept: 'application/json'
+            },
+            responseType: 'json'
+        };
+        let url = options.url;
+        return request_1.default
+            .get(requestOptions)
+            .then((response) => {
+            const etag = response ? response['@odata.etag'] : undefined;
+            if (!etag) {
+                return Promise.reject(`Error fetching task details`);
+            }
+            if (options.alias) {
+                const alias = options.alias;
+                const urls = [];
+                Object.entries(response.references).forEach((ref) => {
+                    var _a;
+                    if (((_a = ref[1].alias) === null || _a === void 0 ? void 0 : _a.toLocaleLowerCase()) === alias.toLocaleLowerCase()) {
+                        urls.push(decodeURIComponent(ref[0]));
+                    }
+                });
+                if (!urls.length) {
+                    return Promise.reject(`The specified reference with alias ${options.alias} does not exist`);
+                }
+                if (urls.length > 1) {
+                    return Promise.reject(`Multiple references with alias ${options.alias} found. Pass one of the following urls within the "--url" option : ${urls}`);
+                }
+                url = urls[0];
+            }
+            return Promise.resolve({ etag, url });
+        });
+    }
+    options() {
+        const options = [
+            { option: '-u, --url [url]' },
+            { option: '--alias [alias]' },
+            { option: '-i, --taskId <taskId>' },
+            { option: '--confirm' }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    optionSets() {
+        return [
+            ['url', 'alias']
+        ];
+    }
+    validate(args) {
+        if (args.options.url && args.options.url.indexOf('https://') !== 0 && args.options.url.indexOf('http://') !== 0) {
+            return 'The url option should contain a valid URL. A valid URL starts with http(s)://';
+        }
+        return true;
+    }
+}
+module.exports = new PlannerTaskReferenceRemoveCommand();
+//# sourceMappingURL=task-reference-remove.js.map

package/dist/m365/planner/commands/task/task-set.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 PlannerTaskSetCommand extends GraphCommand_1.default {
     constructor() {
         super(...arguments);
@@ -230,22 +231,9 @@ class PlannerTaskSetCommand 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 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(options.ownerGroupName)
+            .then(group => group.id);
     }
     mapRequestBody(options, appliedCategories) {
         const requestBody = {};

package/dist/m365/planner/commands/tenant/tenant-settings-list.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const PlannerCommand_1 = require("../../../base/PlannerCommand");
+const commands_1 = require("../../commands");
+class PlannerTenantSettingsListCommand extends PlannerCommand_1.default {
+    get name() {
+        return commands_1.default.TENANT_SETTINGS_LIST;
+    }
+    get description() {
+        return 'Lists the Microsoft Planner configuration of the tenant';
+    }
+    defaultProperties() {
+        return ['isPlannerAllowed', 'allowCalendarSharing', 'allowTenantMoveWithDataLoss', 'allowTenantMoveWithDataMigration', 'allowRosterCreation', 'allowPlannerMobilePushNotifications'];
+    }
+    commandAction(logger, args, cb) {
+        const requestOptions = {
+            url: `${this.resource}/taskAPI/tenantAdminSettings/Settings`,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json'
+        };
+        request_1.default
+            .get(requestOptions)
+            .then((result) => {
+            logger.log(result);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+}
+module.exports = new PlannerTenantSettingsListCommand();
+//# sourceMappingURL=tenant-settings-list.js.map

package/dist/m365/planner/commands.js

@@ -12,12 +12,17 @@ exports.default = {
     PLAN_GET: `${prefix} plan get`,
     PLAN_LIST: `${prefix} plan list`,
     TASK_ADD: `${prefix} task add`,
+    TASK_CHECKLISTITEM_ADD: `${prefix} task checklistitem add`,
+    TASK_CHECKLISTITEM_LIST: `${prefix} task checklistitem list`,
+    TASK_CHECKLISTITEM_REMOVE: `${prefix} task checklistitem remove`,
     TASK_DETAILS_GET: `${prefix} task details get`,
     TASK_GET: `${prefix} task get`,
     TASK_LIST: `${prefix} task list`,
     TASK_REFERENCE_ADD: `${prefix} task reference add`,
     TASK_REFERENCE_LIST: `${prefix} task reference list`,
+    TASK_REFERENCE_REMOVE: `${prefix} task reference remove`,
     TASK_REMOVE: `${prefix} task remove`,
-    TASK_SET: `${prefix} task set`
+    TASK_SET: `${prefix} task set`,
+    TENANT_SETTINGS_LIST: `${prefix} tenant settings list`
 };
 //# sourceMappingURL=commands.js.map