@pnp/cli-microsoft365 5.2.0 → 5.3.0-beta.d2ec1f4

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.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.js

@@ -41,6 +41,7 @@ exports.default = {
     FEATURE_LIST: `${prefix} feature list`,
     FIELD_ADD: `${prefix} field add`,
     FIELD_GET: `${prefix} field get`,
+    FIELD_LIST: `${prefix} field list`,
     FIELD_REMOVE: `${prefix} field remove`,
     FIELD_SET: `${prefix} field set`,
     FILE_ADD: `${prefix} file add`,

package/docs/docs/cmd/planner/bucket/bucket-remove.md

@@ -0,0 +1,60 @@
+# planner bucket remove
+
+Removes the Microsoft Planner bucket from a plan
+
+## Usage
+
+```sh
+m365 planner bucket remove [options]
+```
+
+## Options
+
+`--id [id]`
+: ID of the bucket to remove. Specify either `id` or `name` but not both.
+
+`--name [name]`
+: Name of the bucket to remove. Specify either `id` or `name` but not both.
+
+`--planId [planId]`
+: ID of the plan to which the bucket to remove belongs. Specify either `planId` or `planName` when using `name`.
+
+`--planName [planName]`
+: Name of the plan to which the bucket to remove belongs. Specify either `planId` or `planName` when using `name`.
+
+`--ownerGroupId [ownerGroupId]`
+: ID of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planName`.
+
+`--ownerGroupName [ownerGroupName]`
+: Name of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planName`.
+
+`--confirm`
+: Don't prompt for confirmation
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Removes the Microsoft Planner bucket by ID
+
+```sh
+m365 planner bucket remove --id "vncYUXCRBke28qMLB-d4xJcACtNz"
+```
+
+Removes the Microsoft Planner bucket by ID without confirmation
+
+```sh
+m365 planner bucket remove --id "vncYUXCRBke28qMLB-d4xJcACtNz" --confirm
+```
+
+Removes the Microsoft Planner bucket with name _My Bucket_ in the Plan with ID _oUHpnKBFekqfGE_PS6GGUZcAFY7b_
+
+```sh
+m365 planner bucket remove --name "My Bucket" --planId "oUHpnKBFekqfGE_PS6GGUZcAFY7b"
+```
+
+Removes the Microsoft Planner bucket with name _My Bucket_ in the Plan _My Plan_ owned by group _My Group_
+
+```sh
+m365 planner bucket remove --name "My Bucket" --planName "My Plan" --ownerGroupName "My Group"
+```

package/docs/docs/cmd/spo/field/field-list.md

@@ -0,0 +1,51 @@
+# spo field list
+
+Retrieves columns for the specified list or site
+
+## Usage
+
+```sh
+m365 spo field list [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: Absolute URL of the site where fields are located
+
+`-t, --listTitle [listTitle]`
+: Title of the list where fields are located. Specify `listTitle`, `listId` or `listUrl`
+
+`-i --listId [listId]`
+: ID of the list where fields are located. Specify `listTitle`, `listId` or `listUrl`
+
+`--listUrl [listUrl]`
+: Server- or web-relative URL of the list where fields are located. Specify `listTitle`, `listId` or `listUrl`
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Retrieves site columns for site _https://contoso.sharepoint.com/sites/contoso-sales_.
+
+```sh
+m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales
+```
+
+Retrieves list columns for list _Events_ in site _https://contoso.sharepoint.com/sites/contoso-sales_
+
+```sh
+m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events
+```
+
+Retrieves list columns for list _202b8199-b9de-43fd-9737-7f213f51c991_ in site _https://contoso.sharepoint.com/sites/contoso-sales_
+
+```sh
+m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '202b8199-b9de-43fd-9737-7f213f51c991'
+```
+
+Retrieves list columns for list _/sites/contoso-sales/lists/Events_ in site _https://contoso.sharepoint.com/sites/contoso-sales_
+
+```sh
+m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events'
+```