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

package/dist/m365/aad/commands/approleassignment/approleassignment-list.js

@@ -22,29 +22,14 @@ class AadAppRoleAssignmentListCommand extends GraphCommand_1.default {
         return ['resourceDisplayName', 'roleName'];
     }
     commandAction(logger, args, cb) {
-        let sp;
-        // get the service principal associated with the appId
-        let spMatchQuery = '';
-        if (args.options.appId) {
-            spMatchQuery = `appId eq '${encodeURIComponent(args.options.appId)}'`;
-        }
-        else if (args.options.objectId) {
-            spMatchQuery = `id eq '${encodeURIComponent(args.options.objectId)}'`;
-        }
-        else {
-            spMatchQuery = `displayName eq '${encodeURIComponent(args.options.displayName)}'`;
-        }
-        this
-            .getServicePrincipalForApp(spMatchQuery)
-            .then((resp) => {
-            if (!resp.value.length) {
-                return Promise.reject('app registration not found');
-            }
-            sp = resp.value[0];
+        let spAppRoleAssignments;
+        this.getAppRoleAssignments(args.options)
+            .then((appRoleAssignments) => {
+            spAppRoleAssignments = appRoleAssignments;
             // the role assignment has an appRoleId but no name. To get the name,
             // we need to get all the roles from the resource. the resource is
             // a service principal. Multiple roles may have same resource id.
-            const resourceIds = sp.appRoleAssignments.map((item) => item.resourceId);
+            const resourceIds = appRoleAssignments.map((item) => item.resourceId);
             const tasks = [];
             for (let i = 0; i < resourceIds.length; i++) {
                 tasks.push(this.getServicePrincipal(resourceIds[i]));
@@ -55,7 +40,7 @@ class AadAppRoleAssignmentListCommand extends GraphCommand_1.default {
             // loop through all appRoleAssignments for the servicePrincipal
             // and lookup the appRole.Id in the resources[resourceId].appRoles array...
             const results = [];
-            sp.appRoleAssignments.map((appRoleAssignment) => {
+            spAppRoleAssignments.map((appRoleAssignment) => {
                 const resource = resources.find((r) => r.id === appRoleAssignment.resourceId);
                 if (resource) {
                     const appRole = resource.appRoles.find((r) => r.id === appRoleAssignment.appRoleId);
@@ -65,7 +50,9 @@ class AadAppRoleAssignmentListCommand extends GraphCommand_1.default {
                             resourceDisplayName: appRoleAssignment.resourceDisplayName,
                             resourceId: appRoleAssignment.resourceId,
                             roleId: appRole.id,
-                            roleName: appRole.value
+                            roleName: appRole.value,
+                            created: appRoleAssignment.createdDateTime,
+                            deleted: appRoleAssignment.deletedDateTime
                         });
                     }
                 }
@@ -74,6 +61,52 @@ class AadAppRoleAssignmentListCommand extends GraphCommand_1.default {
             cb();
         }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
     }
+    getAppRoleAssignments(argOptions) {
+        return new Promise((resolve, reject) => {
+            if (argOptions.objectId) {
+                this.getSPAppRoleAssignments(argOptions.objectId)
+                    .then((spAppRoleAssignments) => {
+                    if (!spAppRoleAssignments.value.length) {
+                        reject('no app role assignments found');
+                    }
+                    resolve(spAppRoleAssignments.value);
+                })
+                    .catch((err) => {
+                    reject(err);
+                });
+            }
+            else {
+                // Use existing way to get service principal object
+                let spMatchQuery = '';
+                if (argOptions.appId) {
+                    spMatchQuery = `appId eq '${encodeURIComponent(argOptions.appId)}'`;
+                }
+                else {
+                    spMatchQuery = `displayName eq '${encodeURIComponent(argOptions.displayName)}'`;
+                }
+                this.getServicePrincipalForApp(spMatchQuery)
+                    .then((resp) => {
+                    if (!resp.value.length) {
+                        reject('app registration not found');
+                    }
+                    resolve(resp.value[0].appRoleAssignments);
+                })
+                    .catch((err) => {
+                    reject(err);
+                });
+            }
+        });
+    }
+    getSPAppRoleAssignments(spId) {
+        const spRequestOptions = {
+            url: `${this.resource}/v1.0/servicePrincipals/${spId}/appRoleAssignments`,
+            headers: {
+                accept: 'application/json'
+            },
+            responseType: 'json'
+        };
+        return request_1.default.get(spRequestOptions);
+    }
     getServicePrincipalForApp(filterParam) {
         const spRequestOptions = {
             url: `${this.resource}/v1.0/servicePrincipals?$expand=appRoleAssignments&$filter=${filterParam}`,

package/dist/m365/aad/commands.js

@@ -6,11 +6,11 @@ exports.default = {
     APP_DELETE: `${prefix} app delete`,
     APP_GET: `${prefix} app get`,
     APP_REMOVE: `${prefix} app remove`,
-    APP_SET: `${prefix} app set`,
     APP_ROLE_ADD: `${prefix} app role add`,
     APP_ROLE_DELETE: `${prefix} app role delete`,
     APP_ROLE_LIST: `${prefix} app role list`,
     APP_ROLE_REMOVE: `${prefix} app role remove`,
+    APP_SET: `${prefix} app set`,
     APPROLEASSIGNMENT_ADD: `${prefix} approleassignment add`,
     APPROLEASSIGNMENT_LIST: `${prefix} approleassignment list`,
     APPROLEASSIGNMENT_REMOVE: `${prefix} approleassignment remove`,

package/dist/m365/app/commands/app-open.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_1 = require("../../../cli");
+const validation_1 = require("../../../utils/validation");
+const settingsNames_1 = require("../../../settingsNames");
+const AppCommand_1 = require("../../base/AppCommand");
+const commands_1 = require("../commands");
+class AppOpenCommand extends AppCommand_1.default {
+    get name() {
+        return commands_1.default.OPEN;
+    }
+    get description() {
+        return 'Opens Azure AD app in the Azure AD portal';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.appId = typeof args.options.appId !== 'undefined';
+        telemetryProps.preview = typeof args.options.preview !== 'undefined';
+        return telemetryProps;
+    }
+    commandAction(logger, args, cb) {
+        this.logOrOpenUrl(args, logger)
+            .then(_ => cb(), (rawRes) => this.handleRejectedODataJsonPromise(rawRes, logger, cb));
+    }
+    logOrOpenUrl(args, logger) {
+        return new Promise((resolve, reject) => {
+            const previewPrefix = args.options.preview === true ? "preview." : "";
+            const url = `https://${previewPrefix}portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationMenuBlade/Overview/appId/${this.appId}/isMSAApp/`;
+            if (cli_1.Cli.getInstance().getSettingWithDefaultValue(settingsNames_1.settingsNames.autoOpenLinksInBrowser, false) === false) {
+                logger.log(`Use a web browser to open the page ${url}`);
+                return resolve();
+            }
+            logger.log(`Opening the following page in your browser: ${url}`);
+            // 'open' is required here so we can lazy load the dependency.
+            // _open is never set before hitting this line, but this check
+            // is implemented so that we can stub it when testing.
+            /* c8 ignore next 3 */
+            if (!this._open) {
+                this._open = require('open');
+            }
+            this._open(url).then(() => {
+                resolve();
+            }, (error) => {
+                reject(error);
+            });
+        });
+    }
+    options() {
+        const options = [
+            { option: '--appId [appId]' },
+            { option: '--preview' }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        if (args.options.appId && !validation_1.validation.isValidGuid(args.options.appId)) {
+            return `${args.options.appId} is not a valid GUID`;
+        }
+        return true;
+    }
+}
+module.exports = new AppOpenCommand();
+//# sourceMappingURL=app-open.js.map

package/dist/m365/app/commands.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const prefix = 'app';
 exports.default = {
     GET: `${prefix} get`,
+    OPEN: `${prefix} open`,
     PERMISSION_LIST: `${prefix} permission list`
 };
 //# sourceMappingURL=commands.js.map

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

@@ -0,0 +1,198 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+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 PlannerBucketGetCommand extends GraphCommand_1.default {
+    get name() {
+        return commands_1.default.BUCKET_GET;
+    }
+    get description() {
+        return 'Gets the Microsoft Planner bucket in 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';
+        return telemetryProps;
+    }
+    commandAction(logger, args, cb) {
+        this
+            .getBucketId(args)
+            .then((bucketId) => this.getBucketById(bucketId))
+            .then((bucket) => {
+            logger.log(bucket);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    getBucketId(args) {
+        const { id, name } = args.options;
+        if (id) {
+            return Promise.resolve(id);
+        }
+        return this
+            .getPlanId(args)
+            .then((planId) => {
+            const requestOptions = {
+                url: `${this.resource}/v1.0/planner/plans/${planId}/buckets`,
+                headers: {
+                    accept: 'application/json;odata.metadata=none'
+                },
+                responseType: 'json'
+            };
+            return request_1.default.get(requestOptions);
+        })
+            .then(buckets => {
+            const filteredBuckets = buckets.value.filter(b => name.toLowerCase() === b.name.toLowerCase());
+            if (!filteredBuckets.length) {
+                return Promise.reject(`The specified bucket ${name} does not exist`);
+            }
+            if (filteredBuckets.length > 1) {
+                return Promise.reject(`Multiple buckets with name ${name} found: ${filteredBuckets.map(x => x.id)}`);
+            }
+            return Promise.resolve(filteredBuckets[0].id.toString());
+        });
+    }
+    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 === 0) {
+                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);
+        });
+    }
+    getBucketById(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = {
+                url: `${this.resource}/v1.0/planner/buckets/${id}`,
+                headers: {
+                    accept: 'application/json'
+                },
+                responseType: 'json'
+            };
+            return request_1.default.get(requestOptions);
+        });
+    }
+    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: '-i, --id [id]'
+            },
+            {
+                option: '--name [name]'
+            },
+            {
+                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.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';
+            }
+            if (args.options.name) {
+                return 'Specify either id or name';
+            }
+        }
+        if (args.options.name) {
+            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`;
+                }
+            }
+            if (args.options.planId) {
+                if (args.options.ownerGroupId || args.options.ownerGroupName) {
+                    return 'Don\'t specify ownerGroupId or ownerGroupName when using planId';
+                }
+            }
+        }
+        if (!args.options.id && !args.options.name) {
+            return 'Please specify id or name';
+        }
+        return true;
+    }
+}
+module.exports = new PlannerBucketGetCommand();
+//# sourceMappingURL=bucket-get.js.map

package/dist/m365/planner/commands.js

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

package/docs/docs/cmd/app/app-open.md

@@ -0,0 +1,45 @@
+# aad app open
+
+Returns deep link of the current AD app to open the Azure portal on the Azure AD app registration management page.
+
+## Usage
+
+```sh
+m365 app open [options]
+```
+
+## Options
+
+`--appId [appId]`
+: Optional Application (client) ID of the Azure AD application registration to open. Uses the app from the `.m365rc.json` file corresponding to the `appId`. If multiple apps are available, this will evade the prompt to choose an app. If the `appId` is not available in the list of apps, an error is thrown.
+
+`--preview`
+: Use to open the url of the Azure AD preview portal.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+If config setting `autoOpenLinksInBrowser` is configured to true, the command will automatically open the link to the Azure Portal in the browser.
+
+Gets the app from the `.m365rc.json` file in the current directory. If the `--appId` option is not used and multiple apps are available, it will prompt the user to choose one.
+
+## Examples
+
+Prints the URL to the Azure AD application registration management page on the Azure Portal. 
+
+```sh
+m365 app open
+```
+
+Prints the url of the Azure AD application registration management page on the preview Azure Portal.
+
+```sh
+m365 app open --preview
+```
+
+Prints the URL to the Azure AD application registration management page on the Azure Portal, evading a possible choice prompt in the case of multiple saved apps in the `.m365rc.json` file. 
+
+```sh
+m365 app open --appId d75be2e1-0204-4f95-857d-51a37cf40be8 
+```

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

@@ -0,0 +1,57 @@
+# planner bucket get
+
+Gets the Microsoft Planner bucket in a plan
+
+## Usage
+
+```sh
+m365 planner bucket get [options]
+```
+
+## Options
+
+`-i, --id [id]`
+: ID of the bucket to retrieve details. Specify either `id` or `name` but not both.
+
+`-name, --name [name]`
+: Name of the bucket to retrieve details. Specify either `id` or `name` but not both. 
+
+`--planId [planId]`
+: Plan ID to which the bucket belongs. Specify either `planId` or `planName` when using `name`.
+
+`--planName [planName]`
+: Plan Name to which the bucket belongs. Specify either `planId` or `planName` when using `name`.
+
+`--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`.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Gets the specified Microsoft Planner bucket 
+
+```sh
+m365 planner bucket get --id "5h1uuYFk4kKQ0hfoTUkRLpgALtYi"
+```
+
+Gets the Microsoft Planner bucket in the PlanId xqQg5FS2LkCp935s-FIFm2QAFkHM
+
+```sh
+m365 planner bucket get --name "Planner Bucket A" --planId "xqQg5FS2LkCp935s-FIFm2QAFkHM"
+```
+
+Gets the Microsoft Planner bucket in the Plan _My Plan_ owned by group _My Group_
+
+```sh
+m365 planner bucket get --name "Planner Bucket A" --planName "My Plan" --ownerGroupName "My Group"
+```
+
+Gets the Microsoft Planner bucket in the Plan _My Plan_ owned by groupId ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e
+
+```sh
+m365 planner bucket get --name "Planner Bucket A" --planName "My Plan" --ownerGroupId "ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e"
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "5.3.0-beta.9caead4",
+  "version": "5.3.0-beta.cb66cfd",
   "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
   "license": "MIT",
   "main": "./dist/api.js",