@pnp/cli-microsoft365 5.0.0-beta.aff293c → 5.0.0-beta.cdbc898

package/dist/m365/app/commands/permission/permission-list.js

@@ -0,0 +1,266 @@
+"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 cli_1 = require("../../../../cli");
+const request_1 = require("../../../../request");
+const appGetCommand = require("../../../aad/commands/app/app-get");
+const AppCommand_1 = require("../../../base/AppCommand");
+const commands_1 = require("../../commands");
+var GetServicePrincipal;
+(function (GetServicePrincipal) {
+    GetServicePrincipal[GetServicePrincipal["withPermissions"] = 0] = "withPermissions";
+    GetServicePrincipal[GetServicePrincipal["withPermissionDefinitions"] = 1] = "withPermissionDefinitions";
+})(GetServicePrincipal || (GetServicePrincipal = {}));
+class AppPermissionListCommand extends AppCommand_1.default {
+    get name() {
+        return commands_1.default.PERMISSION_LIST;
+    }
+    get description() {
+        return 'Lists API permissions for the current AAD app';
+    }
+    commandAction(logger, args, cb) {
+        this
+            .getServicePrincipal({ appId: this.appId }, logger, GetServicePrincipal.withPermissions)
+            .then(servicePrincipal => {
+            if (servicePrincipal) {
+                // service principal found, get permissions from the service principal
+                return this.getServicePrincipalPermissions(servicePrincipal, logger);
+            }
+            else {
+                // service principal not found, get permissions from app registration
+                return this.getAppRegPermissions(this.appId, logger);
+            }
+        })
+            .then(permissions => {
+            logger.log(permissions);
+            cb();
+        }, err => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    getServicePrincipal(servicePrincipalInfo, logger, mode) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.verbose) {
+                logger.logToStderr(`Retrieving service principal ${(_a = servicePrincipalInfo.appId) !== null && _a !== void 0 ? _a : servicePrincipalInfo.id}`);
+            }
+            const lookupUrl = servicePrincipalInfo.appId ? `?$filter=appId eq '${servicePrincipalInfo.appId}'&` : `/${servicePrincipalInfo.id}?`;
+            const requestOptions = {
+                url: `${this.resource}/v1.0/servicePrincipals${lookupUrl}$select=appId,id,displayName`,
+                headers: {
+                    accept: 'application/json;odata.metadata=none'
+                },
+                responseType: 'json'
+            };
+            const response = yield request_1.default.get(requestOptions);
+            if ((servicePrincipalInfo.id && !response) ||
+                (servicePrincipalInfo.appId && response.value.length === 0)) {
+                return undefined;
+            }
+            const servicePrincipal = servicePrincipalInfo.appId ?
+                response.value[0] :
+                response;
+            if (this.verbose) {
+                logger.logToStderr(`Retrieving permissions for service principal ${servicePrincipal.id}...`);
+            }
+            const permissionsPromises = [];
+            switch (mode) {
+                case GetServicePrincipal.withPermissions:
+                    const appRoleAssignmentsRequestOptions = {
+                        url: `${this.resource}/v1.0/servicePrincipals/${servicePrincipal.id}/appRoleAssignments`,
+                        headers: {
+                            accept: 'application/json;odata.metadata=none'
+                        },
+                        responseType: 'json'
+                    };
+                    const oauth2PermissionGrantsRequestOptions = {
+                        url: `${this.resource}/v1.0/servicePrincipals/${servicePrincipal.id}/oauth2PermissionGrants`,
+                        headers: {
+                            accept: 'application/json;odata.metadata=none'
+                        },
+                        responseType: 'json'
+                    };
+                    permissionsPromises.push(...[
+                        request_1.default.get(appRoleAssignmentsRequestOptions),
+                        request_1.default.get(oauth2PermissionGrantsRequestOptions)
+                    ]);
+                    break;
+                case GetServicePrincipal.withPermissionDefinitions:
+                    const oauth2PermissionScopesRequestOptions = {
+                        url: `${this.resource}/v1.0/servicePrincipals/${servicePrincipal.id}/oauth2PermissionScopes`,
+                        headers: {
+                            accept: 'application/json;odata.metadata=none'
+                        },
+                        responseType: 'json'
+                    };
+                    const appRolesRequestOptions = {
+                        url: `${this.resource}/v1.0/servicePrincipals/${servicePrincipal.id}/appRoles`,
+                        headers: {
+                            accept: 'application/json;odata.metadata=none'
+                        },
+                        responseType: 'json'
+                    };
+                    permissionsPromises.push(...[
+                        request_1.default.get(oauth2PermissionScopesRequestOptions),
+                        request_1.default.get(appRolesRequestOptions)
+                    ]);
+                    break;
+            }
+            const permissions = yield Promise.all(permissionsPromises);
+            switch (mode) {
+                case GetServicePrincipal.withPermissions:
+                    servicePrincipal.appRoleAssignments = permissions[0].value;
+                    servicePrincipal.oauth2PermissionGrants = permissions[1].value;
+                    break;
+                case GetServicePrincipal.withPermissionDefinitions:
+                    servicePrincipal.oauth2PermissionScopes = permissions[0].value;
+                    servicePrincipal.appRoles = permissions[1].value;
+                    break;
+            }
+            return servicePrincipal;
+        });
+    }
+    getServicePrincipalPermissions(servicePrincipal, logger) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.verbose) {
+                logger.logToStderr(`Resolving permissions for the service principal...`);
+            }
+            const apiPermissions = [];
+            // hash table for resolving resource IDs to names
+            const resourceLookup = {};
+            // list of service principals for which to load permissions
+            const servicePrincipalsToResolve = [];
+            const appRoleAssignments = servicePrincipal.appRoleAssignments;
+            apiPermissions.push(...appRoleAssignments.map(appRoleAssignment => {
+                // store resource name for resolving OAuth2 grants
+                resourceLookup[appRoleAssignment.resourceId] = appRoleAssignment.resourceDisplayName;
+                // add to the list of service principals to load to get the app role
+                // display name
+                if (!servicePrincipalsToResolve.find(r => r.id === appRoleAssignment.resourceId)) {
+                    servicePrincipalsToResolve.push({ id: appRoleAssignment.resourceId });
+                }
+                return {
+                    resource: appRoleAssignment.resourceDisplayName,
+                    // we store the app role ID temporarily and will later resolve to display name
+                    permission: appRoleAssignment.appRoleId,
+                    type: 'Application'
+                };
+            }));
+            const oauth2Grants = servicePrincipal.oauth2PermissionGrants;
+            oauth2Grants.forEach(oauth2Grant => {
+                var _a;
+                // see if we can resolve the resource name from the resources
+                // retrieved from app role assignments
+                const resource = (_a = resourceLookup[oauth2Grant.resourceId]) !== null && _a !== void 0 ? _a : oauth2Grant.resourceId;
+                if (resource === oauth2Grant.resourceId &&
+                    !servicePrincipalsToResolve.find(r => r.id === oauth2Grant.resourceId)) {
+                    // resource name not found in the resources
+                    // add it to the list of resources to resolve
+                    servicePrincipalsToResolve.push({ id: oauth2Grant.resourceId });
+                }
+                const scopes = oauth2Grant.scope.split(' ');
+                scopes.forEach(scope => {
+                    apiPermissions.push({
+                        resource,
+                        permission: scope,
+                        type: 'Delegated'
+                    });
+                });
+            });
+            if (servicePrincipalsToResolve.length > 0) {
+                const servicePrincipals = yield Promise
+                    .all(servicePrincipalsToResolve
+                    .map(servicePrincipalInfo => this.getServicePrincipal(servicePrincipalInfo, logger, GetServicePrincipal.withPermissionDefinitions)));
+                servicePrincipals.forEach(servicePrincipal => {
+                    apiPermissions.forEach(apiPermission => {
+                        var _a, _b;
+                        if (apiPermission.resource === servicePrincipal.id) {
+                            apiPermission.resource = servicePrincipal.displayName;
+                        }
+                        if (apiPermission.resource === servicePrincipal.displayName &&
+                            apiPermission.type === 'Application') {
+                            apiPermission.permission = (_b = (_a = servicePrincipal.appRoles
+                                .find(appRole => appRole.id === apiPermission.permission)) === null || _a === void 0 ? void 0 : _a.value) !== null && _b !== void 0 ? _b : apiPermission.permission;
+                        }
+                    });
+                });
+            }
+            return apiPermissions;
+        });
+    }
+    getAppRegistration(appId, logger) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.verbose) {
+                logger.logToStderr(`Retrieving Azure AD application registration ${appId}`);
+            }
+            const options = {
+                appId: appId,
+                output: 'json',
+                debug: this.debug,
+                verbose: this.verbose
+            };
+            const output = yield cli_1.Cli.executeCommandWithOutput(appGetCommand, { options: Object.assign(Object.assign({}, options), { _: [] }) });
+            if (this.debug) {
+                logger.logToStderr(output.stderr);
+            }
+            return JSON.parse(output.stdout);
+        });
+    }
+    getAppRegPermissions(appId, logger) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const application = yield this.getAppRegistration(appId, logger);
+            if (application.requiredResourceAccess.length === 0) {
+                return [];
+            }
+            const servicePrincipalsToResolve = application.requiredResourceAccess
+                .map(resourceAccess => {
+                return {
+                    appId: resourceAccess.resourceAppId
+                };
+            });
+            const servicePrincipals = yield Promise
+                .all(servicePrincipalsToResolve.map(servicePrincipalInfo => this.getServicePrincipal(servicePrincipalInfo, logger, GetServicePrincipal.withPermissionDefinitions)));
+            const apiPermissions = [];
+            application.requiredResourceAccess.forEach(requiredResourceAccess => {
+                var _a;
+                const servicePrincipal = servicePrincipals
+                    .find(servicePrincipal => (servicePrincipal === null || servicePrincipal === void 0 ? void 0 : servicePrincipal.appId) === requiredResourceAccess.resourceAppId);
+                const resourceName = (_a = servicePrincipal === null || servicePrincipal === void 0 ? void 0 : servicePrincipal.displayName) !== null && _a !== void 0 ? _a : requiredResourceAccess.resourceAppId;
+                requiredResourceAccess.resourceAccess.forEach(permission => {
+                    apiPermissions.push({
+                        resource: resourceName,
+                        permission: this.getPermissionName(permission.id, permission.type, servicePrincipal),
+                        type: permission.type === 'Role' ? 'Application' : 'Delegated'
+                    });
+                });
+            });
+            return apiPermissions;
+        });
+    }
+    getPermissionName(permissionId, permissionType, servicePrincipal) {
+        var _a, _b, _c, _d;
+        if (!servicePrincipal) {
+            return permissionId;
+        }
+        switch (permissionType) {
+            case 'Role':
+                return (_b = (_a = servicePrincipal.appRoles
+                    .find(appRole => appRole.id === permissionId)) === null || _a === void 0 ? void 0 : _a.value) !== null && _b !== void 0 ? _b : permissionId;
+            case 'Scope':
+                return (_d = (_c = servicePrincipal.oauth2PermissionScopes
+                    .find(permissionScope => permissionScope.id === permissionId)) === null || _c === void 0 ? void 0 : _c.value) !== null && _d !== void 0 ? _d : permissionId;
+        }
+        /* c8 ignore next 4 */
+        // permissionType is either 'Scope' or 'Role' but we need a safe default
+        // to avoid building errors. This code will never be reached.
+        return permissionId;
+    }
+}
+module.exports = new AppPermissionListCommand();
+//# sourceMappingURL=permission-list.js.map

package/dist/m365/app/commands.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const prefix = 'app';
+exports.default = {
+    PERMISSION_LIST: `${prefix} permission list`
+};
+//# sourceMappingURL=commands.js.map

package/dist/m365/base/AppCommand.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs = require("fs");
+const cli_1 = require("../../cli");
+const Command_1 = require("../../Command");
+const Utils_1 = require("../../Utils");
+class AppCommand extends Command_1.default {
+    get resource() {
+        return 'https://graph.microsoft.com';
+    }
+    action(logger, args, cb) {
+        const m365rcJsonPath = '.m365rc.json';
+        if (!fs.existsSync(m365rcJsonPath)) {
+            return cb(new Command_1.CommandError(`Could not find file: ${m365rcJsonPath}`));
+        }
+        try {
+            const m365rcJsonContents = fs.readFileSync(m365rcJsonPath, 'utf8');
+            if (!m365rcJsonContents) {
+                return cb(new Command_1.CommandError(`File ${m365rcJsonPath} is empty`));
+            }
+            this.m365rcJson = JSON.parse(m365rcJsonContents);
+        }
+        catch (e) {
+            return cb(new Command_1.CommandError(`Could not parse file: ${m365rcJsonPath}`));
+        }
+        if (!this.m365rcJson.apps ||
+            this.m365rcJson.apps.length === 0) {
+            return cb(new Command_1.CommandError(`No Azure AD apps found in ${m365rcJsonPath}`));
+        }
+        if (args.options.appId) {
+            if (!this.m365rcJson.apps.some(app => app.appId === args.options.appId)) {
+                return cb(new Command_1.CommandError(`App ${args.options.appId} not found in ${m365rcJsonPath}`));
+            }
+            this.appId = args.options.appId;
+            return super.action(logger, args, cb);
+        }
+        if (this.m365rcJson.apps.length === 1) {
+            this.appId = this.m365rcJson.apps[0].appId;
+            return super.action(logger, args, cb);
+        }
+        if (this.m365rcJson.apps.length > 1) {
+            cli_1.Cli.prompt({
+                message: `Multiple Azure AD apps found in ${m365rcJsonPath}. Which app would you like to use?`,
+                type: 'list',
+                choices: this.m365rcJson.apps.map((app, i) => {
+                    return {
+                        name: `${app.name} (${app.appId})`,
+                        value: i
+                    };
+                }),
+                default: 0,
+                name: 'appIdIndex'
+            }, (result) => {
+                this.appId = this.m365rcJson.apps[result.appIdIndex].appId;
+                super.action(logger, args, cb);
+            });
+        }
+    }
+    options() {
+        const options = [
+            {
+                option: '--appId [appId]'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        if (args.options.appId && !Utils_1.default.isValidGuid(args.options.appId)) {
+            return `${args.options.appId} is not a valid GUID`;
+        }
+        return true;
+    }
+}
+exports.default = AppCommand;
+//# sourceMappingURL=AppCommand.js.map

package/dist/m365/{aad/commands/o365group/Group.js → base/M365RcJson.js}

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

package/dist/m365/cli/commands/cli-doctor.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const os = require("os");
 const Auth_1 = require("../../../Auth");
+const cli_1 = require("../../../cli");
 const Command_1 = require("../../../Command");
 const Utils_1 = require("../../../Utils");
 const commands_1 = require("../commands");
@@ -33,6 +34,7 @@ class CliDoctorCommand extends Command_1.default {
             cliAadAppTenant: Utils_1.default.isValidGuid(Auth_1.default.service.tenant) ? 'single' : Auth_1.default.service.tenant,
             authMode: Auth_1.AuthType[Auth_1.default.service.authType],
             cliEnvironment: process.env.CLIMICROSOFT365_ENV ? process.env.CLIMICROSOFT365_ENV : '',
+            cliConfig: cli_1.Cli.getInstance().config.all,
             roles: roles,
             scopes: scopes
         };

package/dist/m365/cli/commands/config/config-set.js

@@ -21,6 +21,9 @@ class CliConfigSetCommand extends AnonymousCommand_1.default {
         switch (args.options.key) {
             case settingsNames_1.settingsNames.showHelpOnFailure:
             case settingsNames_1.settingsNames.printErrorsAsPlainText:
+            case settingsNames_1.settingsNames.csvHeader:
+            case settingsNames_1.settingsNames.csvQuoted:
+            case settingsNames_1.settingsNames.csvQuotedEmpty:
                 value = args.options.value === 'true';
                 break;
             default:
@@ -47,7 +50,7 @@ class CliConfigSetCommand extends AnonymousCommand_1.default {
         if (CliConfigSetCommand.optionNames.indexOf(args.options.key) < 0) {
             return `${args.options.key} is not a valid setting. Allowed values: ${CliConfigSetCommand.optionNames.join(', ')}`;
         }
-        const allowedOutputs = ['text', 'json'];
+        const allowedOutputs = ['text', 'json', 'csv'];
         if (args.options.key === settingsNames_1.settingsNames.output &&
             allowedOutputs.indexOf(args.options.value) === -1) {
             return `${args.options.value} is not a valid value for the option ${args.options.key}. Allowed values: ${allowedOutputs.join(', ')}`;

package/dist/m365/file/commands/file-add.js

@@ -20,7 +20,7 @@ class FileAddCommand extends GraphCommand_1.default {
             folderUrlWithoutTrailingSlash = folderUrlWithoutTrailingSlash.substr(0, folderUrlWithoutTrailingSlash.length - 1);
         }
         this
-            .getGraphFileUrl(logger, `${folderUrlWithoutTrailingSlash}/${path.basename(args.options.filePath)}`)
+            .getGraphFileUrl(logger, `${folderUrlWithoutTrailingSlash}/${path.basename(args.options.filePath)}`, args.options.siteUrl)
             .then(graphFileUrl => this.uploadFile(args.options.filePath, graphFileUrl))
             .then(_ => cb(), rawRes => this.handleRejectedODataJsonPromise(rawRes, logger, cb));
     }
@@ -80,20 +80,23 @@ class FileAddCommand extends GraphCommand_1.default {
      *
      * @param logger Logger instance
      * @param fileWebUrl Web URL of the file for which to get drive item URL
+     * @param siteUrl URL of the site to which upload the file. Optional. Specify to suppress lookup.
      * @returns Graph's drive item URL for the specified file
      */
-    getGraphFileUrl(logger, fileWebUrl) {
+    getGraphFileUrl(logger, fileWebUrl, siteUrl) {
         if (this.debug) {
             logger.logToStderr(`Resolving Graph drive item URL for ${fileWebUrl}`);
         }
-        const _url = url.parse(fileWebUrl);
+        const _fileWebUrl = url.parse(fileWebUrl);
+        const _siteUrl = url.parse(siteUrl || fileWebUrl);
+        const isSiteUrl = typeof siteUrl !== 'undefined';
         let siteId = '';
         let driveRelativeFileUrl = '';
         return this
-            .getGraphSiteInfoFromFullUrl(_url.host, _url.path)
+            .getGraphSiteInfoFromFullUrl(_siteUrl.host, _siteUrl.path, isSiteUrl)
             .then(siteInfo => {
             siteId = siteInfo.id;
-            let siteRelativeFileUrl = _url.path.replace(siteInfo.serverRelativeUrl, '');
+            let siteRelativeFileUrl = _fileWebUrl.path.replace(siteInfo.serverRelativeUrl, '');
             // normalize site-relative URLs for root site collections and root sites
             if (!siteRelativeFileUrl.startsWith('/')) {
                 siteRelativeFileUrl = '/' + siteRelativeFileUrl;
@@ -116,13 +119,14 @@ class FileAddCommand extends GraphCommand_1.default {
      * Automatically detects which path chunks correspond to (sub)site.
      * @param hostName SharePoint host name, eg. contoso.sharepoint.com
      * @param urlPath Server-relative file URL, eg. /sites/site/docs/file1.aspx
+     * @param isSiteUrl Set to true to indicate that the specified URL is a site URL
      * @returns ID and server-relative URL of the site denoted by urlPath
      */
-    getGraphSiteInfoFromFullUrl(hostName, urlPath) {
+    getGraphSiteInfoFromFullUrl(hostName, urlPath, isSiteUrl) {
         const siteId = '';
         const urlChunks = urlPath.split('/');
         return new Promise((resolve, reject) => {
-            this.getGraphSiteInfo(hostName, urlChunks, 0, siteId, resolve, reject);
+            this.getGraphSiteInfo(hostName, urlChunks, isSiteUrl ? urlChunks.length - 1 : 0, siteId, resolve, reject);
         });
     }
     /**
@@ -156,20 +160,28 @@ class FileAddCommand extends GraphCommand_1.default {
             },
             responseType: 'json'
         };
+        const getResult = (id, serverRelativeUrl) => {
+            return {
+                id,
+                serverRelativeUrl
+            };
+        };
         request_1.default
             .get(requestOptions)
             .then((res) => {
-            this.getGraphSiteInfo(hostName, urlChunks, ++currentChunk, res.id, resolve, reject);
+            if (currentChunk === urlChunks.length - 1) {
+                resolve(getResult(res.id, currentPath));
+            }
+            else {
+                this.getGraphSiteInfo(hostName, urlChunks, ++currentChunk, res.id, resolve, reject);
+            }
         }, err => {
             if (lastSiteId) {
                 let serverRelativeUrl = `${urlChunks.slice(0, currentChunk).join('/')}`;
                 if (!serverRelativeUrl.startsWith('/')) {
                     serverRelativeUrl = '/' + serverRelativeUrl;
                 }
-                resolve({
-                    id: lastSiteId,
-                    serverRelativeUrl: serverRelativeUrl
-                });
+                resolve(getResult(lastSiteId, serverRelativeUrl));
             }
             else {
                 reject(err);
@@ -206,7 +218,8 @@ class FileAddCommand extends GraphCommand_1.default {
     options() {
         const options = [
             { option: '-u, --folderUrl <folderUrl>' },
-            { option: '-p, --filePath <filePath>' }
+            { option: '-p, --filePath <filePath>' },
+            { option: '--siteUrl [siteUrl]' }
         ];
         const parentOptions = super.options();
         return options.concat(parentOptions);
@@ -215,6 +228,12 @@ class FileAddCommand extends GraphCommand_1.default {
         if (!fs.existsSync(args.options.filePath)) {
             return `Specified source file ${args.options.sourceFile} doesn't exist`;
         }
+        if (args.options.siteUrl) {
+            const isValidSiteUrl = SpoCommand_1.default.isValidSharePointUrl(args.options.siteUrl);
+            if (isValidSiteUrl !== true) {
+                return isValidSiteUrl;
+            }
+        }
         return SpoCommand_1.default.isValidSharePointUrl(args.options.folderUrl);
     }
 }