@pnp/cli-microsoft365 5.2.0 → 5.3.0-beta.9caead4

package/.eslintrc.js

@@ -29,6 +29,7 @@ const dictionary = [
   'home',
   'hub',
   'in',
+  'inheritance',
   'init',
   'install',
   'installed',

package/dist/m365/planner/commands/bucket/bucket-remove.js

@@ -0,0 +1,214 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_1 = require("../../../../cli");
+const utils_1 = require("../../../../utils");
+const request_1 = require("../../../../request");
+const GraphCommand_1 = require("../../../base/GraphCommand");
+const commands_1 = require("../../commands");
+class PlannerBucketRemoveCommand extends GraphCommand_1.default {
+    get name() {
+        return commands_1.default.BUCKET_REMOVE;
+    }
+    get description() {
+        return 'Removes the Microsoft Planner bucket from a plan';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.id = typeof args.options.id !== 'undefined';
+        telemetryProps.name = typeof args.options.name !== '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.confirm = args.options.confirm || false;
+        return telemetryProps;
+    }
+    commandAction(logger, args, cb) {
+        const removeBucket = () => {
+            this
+                .getBucket(args)
+                .then(bucket => {
+                const requestOptions = {
+                    url: `${this.resource}/v1.0/planner/buckets/${bucket.id}`,
+                    headers: {
+                        accept: 'application/json;odata.metadata=none',
+                        'if-match': bucket['@odata.etag']
+                    },
+                    responseType: 'json'
+                };
+                return request_1.default.delete(requestOptions);
+            })
+                .then(_ => cb(), (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+        };
+        if (args.options.confirm) {
+            removeBucket();
+        }
+        else {
+            cli_1.Cli.prompt({
+                type: 'confirm',
+                name: 'continue',
+                default: false,
+                message: `Are you sure you want to remove the bucket ${args.options.id || args.options.name}?`
+            }, (result) => {
+                if (!result.continue) {
+                    cb();
+                }
+                else {
+                    removeBucket();
+                }
+            });
+        }
+    }
+    getBucket(args) {
+        if (args.options.id) {
+            const requestOptions = {
+                url: `${this.resource}/v1.0/planner/buckets/${args.options.id}`,
+                headers: {
+                    accept: 'application/json'
+                },
+                responseType: 'json'
+            };
+            return request_1.default.get(requestOptions);
+        }
+        return this
+            .getPlanId(args)
+            .then(planId => {
+            const requestOptions = {
+                url: `${this.resource}/v1.0/planner/plans/${planId}/buckets`,
+                headers: {
+                    accept: 'application/json'
+                },
+                responseType: 'json'
+            };
+            return request_1.default.get(requestOptions);
+        })
+            .then(buckets => {
+            const filteredBuckets = buckets.value.filter(b => args.options.name.toLowerCase() === b.name.toLowerCase());
+            if (!filteredBuckets.length) {
+                return Promise.reject(`The specified bucket ${args.options.name} does not exist`);
+            }
+            if (filteredBuckets.length > 1) {
+                return Promise.reject(`Multiple buckets with name ${args.options.name} found: ${filteredBuckets.map(x => x.id)}`);
+            }
+            return Promise.resolve(filteredBuckets[0]);
+        });
+    }
+    getPlanId(args) {
+        const { planId, planName } = args.options;
+        if (planId) {
+            return Promise.resolve(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(plans => {
+            const filteredPlans = plans.value.filter(p => p.title.toLowerCase() === planName.toLowerCase());
+            if (!filteredPlans.length) {
+                return Promise.reject(`The specified plan ${planName} does not exist`);
+            }
+            if (filteredPlans.length > 1) {
+                return Promise.reject(`Multiple plans with name ${planName} found: ${filteredPlans.map(x => x.id)}`);
+            }
+            return Promise.resolve(filteredPlans[0].id);
+        });
+    }
+    getGroupId(args) {
+        const { ownerGroupId, ownerGroupName } = args.options;
+        if (ownerGroupId) {
+            return Promise.resolve(ownerGroupId);
+        }
+        const requestOptions = {
+            url: `${this.resource}/v1.0/groups?$filter=displayName eq '${encodeURIComponent(ownerGroupName)}'`,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json'
+        };
+        return request_1.default
+            .get(requestOptions)
+            .then(response => {
+            if (!response.value.length) {
+                return Promise.reject(`The specified owner group ${ownerGroupName} does not exist`);
+            }
+            if (response.value.length > 1) {
+                return Promise.reject(`Multiple owner groups with name ${ownerGroupName} found: ${response.value.map(x => x.id)}`);
+            }
+            return Promise.resolve(response.value[0].id);
+        });
+    }
+    options() {
+        const options = [
+            {
+                option: '--id [id]'
+            },
+            {
+                option: '--name [name]'
+            },
+            {
+                option: '--planId [planId]'
+            },
+            {
+                option: '--planName [planName]'
+            },
+            {
+                option: '--ownerGroupId [ownerGroupId]'
+            },
+            {
+                option: '--ownerGroupName [ownerGroupName]'
+            },
+            {
+                option: '--confirm'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    optionSets() {
+        return [
+            ['id', 'name']
+        ];
+    }
+    validate(args) {
+        if (args.options.id) {
+            if (args.options.planId || args.options.planName || args.options.ownerGroupId || args.options.ownerGroupName) {
+                return 'Don\'t specify planId, planName, ownerGroupId or ownerGroupName when using id';
+            }
+        }
+        else {
+            if (!args.options.planId && !args.options.planName) {
+                return 'Specify either planId or planName when using name';
+            }
+            if (args.options.planId && args.options.planName) {
+                return 'Specify either planId or planName when using name but not both';
+            }
+            if (args.options.planName) {
+                if (!args.options.ownerGroupId && !args.options.ownerGroupName) {
+                    return 'Specify either ownerGroupId or ownerGroupName when using planName';
+                }
+                if (args.options.ownerGroupId && args.options.ownerGroupName) {
+                    return 'Specify either ownerGroupId or ownerGroupName when using planName but not both';
+                }
+                if (args.options.ownerGroupId && !utils_1.validation.isValidGuid(args.options.ownerGroupId)) {
+                    return `${args.options.ownerGroupId} is not a valid GUID`;
+                }
+            }
+            else {
+                if (args.options.ownerGroupId || args.options.ownerGroupName) {
+                    return 'Don\'t specify ownerGroupId or ownerGroupName when using planId';
+                }
+            }
+        }
+        return true;
+    }
+}
+module.exports = new PlannerBucketRemoveCommand();
+//# sourceMappingURL=bucket-remove.js.map

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

@@ -1,6 +1,7 @@
 "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 PlannerTaskGetCommand extends GraphCommand_1.default {
@@ -11,27 +12,169 @@ class PlannerTaskGetCommand extends GraphCommand_1.default {
         return 'Retrieve the the specified planner task';
     }
     commandAction(logger, args, cb) {
+        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((res) => {
+            logger.log(res);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    getTaskId(options) {
+        if (options.id) {
+            return Promise.resolve(options.id);
+        }
+        return this
+            .getBucketId(options)
+            .then(bucketId => {
+            const requestOptions = {
+                url: `${this.resource}/v1.0/planner/buckets/${bucketId}/tasks?$select=id,title`,
+                headers: {
+                    accept: 'application/json;odata.metadata=none'
+                },
+                responseType: 'json'
+            };
+            return request_1.default.get(requestOptions);
+        })
+            .then((response) => {
+            const title = options.title;
+            const tasks = response.value.filter(val => { var _a; return ((_a = val.title) === null || _a === void 0 ? void 0 : _a.toLocaleLowerCase()) === title.toLocaleLowerCase(); });
+            if (!tasks.length) {
+                return Promise.reject(`The specified task ${options.title} does not exist`);
+            }
+            if (tasks.length > 1) {
+                return Promise.reject(`Multiple tasks with title ${options.title} found: ${tasks.map(x => x.id)}`);
+            }
+            return Promise.resolve(tasks[0].id);
+        });
+    }
+    getBucketId(options) {
+        if (options.bucketId) {
+            return Promise.resolve(options.bucketId);
+        }
+        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 bucketName = options.bucketName;
+            const buckets = response.value.filter(val => { var _a; return ((_a = val.name) === null || _a === void 0 ? void 0 : _a.toLocaleLowerCase()) === bucketName.toLocaleLowerCase(); });
+            if (!buckets.length) {
+                return Promise.reject(`The specified bucket ${options.bucketName} does not exist`);
+            }
+            if (buckets.length > 1) {
+                return Promise.reject(`Multiple buckets with name ${options.bucketName} found: ${buckets.map(x => x.id)}`);
+            }
+            return Promise.resolve(buckets[0].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 planName = options.planName;
+            const plans = response.value.filter(val => { var _a; return ((_a = val.title) === null || _a === void 0 ? void 0 : _a.toLocaleLowerCase()) === planName.toLocaleLowerCase(); });
+            if (!plans.length) {
+                return Promise.reject(`The specified plan ${options.planName} does not exist`);
+            }
+            if (plans.length > 1) {
+                return Promise.reject(`Multiple plans with name ${options.planName} found: ${plans.map(x => x.id)}`);
+            }
+            return Promise.resolve(plans[0].id);
+        });
+    }
+    getGroupId(options) {
+        if (options.ownerGroupId) {
+            return Promise.resolve(options.ownerGroupId);
+        }
         const requestOptions = {
-            url: `${this.resource}/beta/planner/tasks/${encodeURIComponent(args.options.id)}`,
+            url: `${this.resource}/v1.0/groups?$filter=displayName eq '${encodeURIComponent(options.ownerGroupName)}'&$select=id`,
             headers: {
                 accept: 'application/json;odata.metadata=none'
             },
             responseType: 'json'
         };
-        request_1.default
+        return request_1.default
             .get(requestOptions)
-            .then((res) => {
-            logger.log(res);
-            cb();
-        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+            .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);
+        });
     }
     options() {
         const options = [
-            { option: '-i, --id <id>' }
+            { option: '-i, --id [id]' },
+            { option: '-t, --title [title]' },
+            { option: '--bucketId [bucketId]' },
+            { option: '--bucketName [bucketName]' },
+            { option: '--planId [planId]' },
+            { option: '--planName [planName]' },
+            { option: '--ownerGroupId [ownerGroupId]' },
+            { option: '--ownerGroupName [ownerGroupName]' }
         ];
         const parentOptions = super.options();
         return options.concat(parentOptions);
     }
+    validate(args) {
+        if (args.options.title && !args.options.bucketId && !args.options.bucketName) {
+            return 'Specify either bucketId or bucketName when using title';
+        }
+        if (args.options.title && args.options.bucketId && args.options.bucketName) {
+            return 'Specify either bucketId or bucketName when using title 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.validation.isValidGuid(args.options.ownerGroupId)) {
+            return `${args.options.ownerGroupId} is not a valid GUID`;
+        }
+        return true;
+    }
 }
 module.exports = new PlannerTaskGetCommand();
 //# sourceMappingURL=task-get.js.map

package/dist/m365/planner/commands.js

@@ -5,6 +5,7 @@ exports.default = {
     BUCKET_ADD: `${prefix} bucket add`,
     BUCKET_LIST: `${prefix} bucket list`,
     BUCKET_SET: `${prefix} bucket set`,
+    BUCKET_REMOVE: `${prefix} bucket remove`,
     PLAN_ADD: `${prefix} plan add`,
     PLAN_GET: `${prefix} plan get`,
     PLAN_DETAILS_GET: `${prefix} plan details get`,

package/dist/m365/spo/commands/field/field-list.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const utils_1 = require("../../../../utils");
+const SpoCommand_1 = require("../../../base/SpoCommand");
+const commands_1 = require("../../commands");
+class SpoFieldListCommand extends SpoCommand_1.default {
+    get name() {
+        return commands_1.default.FIELD_LIST;
+    }
+    get description() {
+        return 'Retrieves columns for the specified list or site';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.listId = typeof args.options.listId !== 'undefined';
+        telemetryProps.listTitle = typeof args.options.listTitle !== 'undefined';
+        telemetryProps.listUrl = typeof args.options.listUrl !== 'undefined';
+        return telemetryProps;
+    }
+    defaultProperties() {
+        return ['Id', 'Title', 'Group', 'Hidden'];
+    }
+    commandAction(logger, args, cb) {
+        let listUrl = '';
+        if (args.options.listId) {
+            listUrl = `lists(guid'${encodeURIComponent(args.options.listId)}')/`;
+        }
+        else if (args.options.listTitle) {
+            listUrl = `lists/getByTitle('${encodeURIComponent(args.options.listTitle)}')/`;
+        }
+        else if (args.options.listUrl) {
+            const listServerRelativeUrl = utils_1.urlUtil.getServerRelativePath(args.options.webUrl, args.options.listUrl);
+            listUrl = `GetList('${encodeURIComponent(listServerRelativeUrl)}')/`;
+        }
+        const requestOptions = {
+            url: `${args.options.webUrl}/_api/web/${listUrl}fields`,
+            headers: {
+                accept: 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        request_1.default
+            .get(requestOptions)
+            .then((res) => {
+            logger.log(res.value);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    options() {
+        const options = [
+            {
+                option: '-u, --webUrl <webUrl>'
+            },
+            {
+                option: '-t, --listTitle [listTitle]'
+            },
+            {
+                option: '-i, --listId [listId]'
+            },
+            {
+                option: '--listUrl [listUrl]'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        const isValidSharePointUrl = utils_1.validation.isValidSharePointUrl(args.options.webUrl);
+        if (isValidSharePointUrl !== true) {
+            return isValidSharePointUrl;
+        }
+        if (args.options.listId && !utils_1.validation.isValidGuid(args.options.listId)) {
+            return `${args.options.listId} is not a valid GUID`;
+        }
+        const listOptions = [args.options.listId, args.options.listTitle, args.options.listUrl];
+        if (listOptions.some(item => item !== undefined) && listOptions.filter(item => item !== undefined).length > 1) {
+            return `Specify either list id or title or list url`;
+        }
+        return true;
+    }
+}
+module.exports = new SpoFieldListCommand();
+//# sourceMappingURL=field-list.js.map

package/dist/m365/spo/commands/list/list-roleinheritance-break.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const utils_1 = require("../../../../utils");
+const SpoCommand_1 = require("../../../base/SpoCommand");
+const commands_1 = require("../../commands");
+class SpoListRoleInheritanceBreakCommand extends SpoCommand_1.default {
+    get name() {
+        return commands_1.default.LIST_ROLEINHERITANCE_BREAK;
+    }
+    get description() {
+        return 'Breaks role inheritance on list or library';
+    }
+    optionSets() {
+        return [
+            ['listId', 'listTitle']
+        ];
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.listId = typeof args.options.listId !== 'undefined';
+        telemetryProps.listTitle = typeof args.options.listTitle !== 'undefined';
+        telemetryProps.clearExistingPermissions = args.options.clearExistingPermissions === true;
+        return telemetryProps;
+    }
+    commandAction(logger, args, cb) {
+        if (this.verbose) {
+            logger.logToStderr(`Breaking role inheritance of list in site at ${args.options.webUrl}...`);
+        }
+        let requestUrl = `${args.options.webUrl}/_api/web/lists`;
+        if (args.options.listId) {
+            requestUrl += `(guid'${encodeURIComponent(args.options.listId)}')`;
+        }
+        else {
+            requestUrl += `/getbytitle('${encodeURIComponent(args.options.listTitle)}')`;
+        }
+        let keepExistingPermissions = true;
+        if (args.options.clearExistingPermissions) {
+            keepExistingPermissions = !args.options.clearExistingPermissions;
+        }
+        const requestOptions = {
+            url: `${requestUrl}/breakroleinheritance(${keepExistingPermissions})`,
+            method: 'POST',
+            headers: {
+                'accept': 'application/json;odata=nometadata',
+                'content-type': 'application/json'
+            },
+            responseType: 'json'
+        };
+        request_1.default
+            .post(requestOptions)
+            .then(_ => cb(), (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    options() {
+        const options = [
+            {
+                option: '-u, --webUrl <webUrl>'
+            },
+            {
+                option: '-i, --listId [listId]'
+            },
+            {
+                option: '-t, --listTitle [listTitle]'
+            },
+            {
+                option: '-c, --clearExistingPermissions'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        const isValidSharePointUrl = utils_1.validation.isValidSharePointUrl(args.options.webUrl);
+        if (isValidSharePointUrl !== true) {
+            return isValidSharePointUrl;
+        }
+        if (args.options.listId && !utils_1.validation.isValidGuid(args.options.listId)) {
+            return `${args.options.listId} is not a valid GUID`;
+        }
+        return true;
+    }
+}
+module.exports = new SpoListRoleInheritanceBreakCommand();
+//# sourceMappingURL=list-roleinheritance-break.js.map

package/dist/m365/spo/commands/list/list-roleinheritance-reset.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const utils_1 = require("../../../../utils");
+const SpoCommand_1 = require("../../../base/SpoCommand");
+const commands_1 = require("../../commands");
+class SpoListRoleInheritanceResetCommand extends SpoCommand_1.default {
+    get name() {
+        return commands_1.default.LIST_ROLEINHERITANCE_RESET;
+    }
+    get description() {
+        return 'Restores role inheritance on list or library';
+    }
+    optionSets() {
+        return [
+            ['listId', 'listTitle']
+        ];
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.listId = typeof args.options.listId !== 'undefined';
+        telemetryProps.listTitle = typeof args.options.listTitle !== 'undefined';
+        return telemetryProps;
+    }
+    commandAction(logger, args, cb) {
+        if (this.verbose) {
+            logger.logToStderr(`Restore role inheritance of list in site at ${args.options.webUrl}...`);
+        }
+        let requestUrl = `${args.options.webUrl}/_api/web/lists`;
+        if (args.options.listId) {
+            requestUrl += `(guid'${encodeURIComponent(args.options.listId)}')`;
+        }
+        else {
+            requestUrl += `/getbytitle('${encodeURIComponent(args.options.listTitle)}')`;
+        }
+        const requestOptions = {
+            url: `${requestUrl}/resetroleinheritance`,
+            method: 'POST',
+            headers: {
+                'accept': 'application/json;odata=nometadata',
+                'content-type': 'application/json'
+            },
+            responseType: 'json'
+        };
+        request_1.default
+            .post(requestOptions)
+            .then(_ => cb(), (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    options() {
+        const options = [
+            {
+                option: '-u, --webUrl <webUrl>'
+            },
+            {
+                option: '-i, --listId [listId]'
+            },
+            {
+                option: '-t, --listTitle [listTitle]'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        const isValidSharePointUrl = utils_1.validation.isValidSharePointUrl(args.options.webUrl);
+        if (isValidSharePointUrl !== true) {
+            return isValidSharePointUrl;
+        }
+        if (args.options.listId && !utils_1.validation.isValidGuid(args.options.listId)) {
+            return `${args.options.listId} is not a valid GUID`;
+        }
+        return true;
+    }
+}
+module.exports = new SpoListRoleInheritanceResetCommand();
+//# sourceMappingURL=list-roleinheritance-reset.js.map