@pnp/cli-microsoft365 5.0.0-beta.c9c30c0 → 5.0.0-beta.d17a15f

package/.devcontainer/devcontainer.json

@@ -2,7 +2,15 @@
   "name": "CLI for Microsoft 365",
   "dockerFile": "Dockerfile",
   "settings": {
-    "terminal.integrated.shell.linux": "/bin/zsh"
+    "terminal.integrated.profiles.linux": {
+        "zsh": {
+          "path": "/bin/zsh",
+          "args": [
+            "-l"
+          ]
+        }
+      },
+      "terminal.integrated.defaultProfile.linux": "zsh"
   },
   "postCreateCommand": "npm i && npm run clean && npm run build && npm link",
   "extensions": [

package/.eslintrc.js

@@ -23,6 +23,7 @@ const dictionary = [
   'group',
   'groupify',
   'guest',
+  'health',
   'hide',
   'historical',
   'home',
@@ -30,6 +31,7 @@ const dictionary = [
   'in',
   'init',
   'install',
+  'installed',
   'is',
   'issue',
   'list',

package/README.md

@@ -179,7 +179,7 @@ m365 spo site get --url https://contoso.sharepoint.com --output text
 
 ## Build
 
-To build and run this CLI locally, you will need [`node`](https://nodejs.org) `>= 14.0.0` installed.
+To build and run this CLI locally, you will need [`node`](https://nodejs.org) `>= 16.0.0` installed.
 
 ```sh
 # Clone this repository

package/dist/Command.js

@@ -113,7 +113,7 @@ class Command {
             },
             {
                 option: '-o, --output [output]',
-                autocomplete: ['json', 'text']
+                autocomplete: ['csv', 'json', 'text']
             },
             {
                 option: '--verbose'

package/dist/Utils.js

@@ -40,6 +40,9 @@ class Utils {
             }
         });
     }
+    static isValidGuidArray(guids) {
+        return guids.every(guid => this.isValidGuid(guid));
+    }
     static isValidGuid(guid) {
         const guidRegEx = new RegExp(/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i);
         return guidRegEx.test(guid);
@@ -48,6 +51,10 @@ class Utils {
         const guidRegEx = new RegExp(/^19:[0-9a-zA-Z-_]+@thread\.(skype|tacv2)$/i);
         return guidRegEx.test(guid);
     }
+    static isValidTeamsChatId(guid) {
+        const guidRegEx = new RegExp(/^19:[0-9a-zA-Z-_]+(@thread\.v2|@unq\.gbl\.spaces)$/i);
+        return guidRegEx.test(guid);
+    }
     static isValidUserPrincipalName(upn) {
         const upnRegEx = new RegExp(/^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*$/i);
         return upnRegEx.test(upn);

package/dist/api.d.ts

@@ -0,0 +1,11 @@
+export interface CommandOutput {
+  error?: {
+    message: string;
+    code?: number;
+  }
+  stdout: string;
+  stderr: string;
+}
+
+export declare function executeCommand(commandName: string, options: any): Promise<CommandOutput>;
+export declare function on(eventName: string, listener: (...args: any[]) => void): void;

package/dist/api.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.executeCommand = void 0;
+const cli_1 = require("./cli");
+const path = require("path");
+function executeCommand(commandName, options, listener) {
+    const cli = cli_1.Cli.getInstance();
+    cli.commandsFolder = path.join(__dirname, 'm365');
+    cli.commands = [];
+    cli.loadCommandFromArgs(commandName.split(' '));
+    if (cli.commands.length !== 1) {
+        return Promise.reject(`Command not found: ${commandName}`);
+    }
+    return cli_1.Cli.executeCommandWithOutput(cli.commands[0].command, { options: options !== null && options !== void 0 ? options : {} }, listener);
+}
+exports.executeCommand = executeCommand;
+//# sourceMappingURL=api.js.map

package/dist/appInsights.js

@@ -20,10 +20,11 @@ const env = process.env.CLIMICROSOFT365_ENV !== undefined ? process.env.CLIMICRO
 appInsights.defaultClient.commonProperties = {
     version: version,
     node: process.version,
-    env: env
+    env: env,
+    ci: Boolean(process.env.CI).toString()
 };
 appInsights.defaultClient.context.tags['ai.session.id'] = crypto.randomBytes(24).toString('base64');
-delete appInsights.defaultClient.context.tags['ai.cloud.roleInstance'];
+appInsights.defaultClient.context.tags['ai.cloud.roleInstance'] = crypto.createHash('sha256').update(appInsights.defaultClient.context.tags['ai.cloud.roleInstance']).digest('hex');
 delete appInsights.defaultClient.context.tags['ai.cloud.role'];
 exports.default = appInsights.defaultClient;
 //# sourceMappingURL=appInsights.js.map

package/dist/cli/Cli.js

@@ -17,6 +17,7 @@ const path = require("path");
 const appInsights_1 = require("../appInsights");
 const Command_1 = require("../Command");
 const config_1 = require("../config");
+const request_1 = require("../request");
 const settingsNames_1 = require("../settingsNames");
 const Utils_1 = require("../Utils");
 const packageJSON = require('../../package.json');
@@ -188,32 +189,51 @@ class Cli {
             });
         });
     }
-    static executeCommandWithOutput(command, args) {
+    static executeCommandWithOutput(command, args, listener) {
         return new Promise((resolve, reject) => {
             const log = [];
             const logErr = [];
             const logger = {
                 log: (message) => {
-                    log.push(Cli.formatOutput(message, args.options));
+                    const formattedMessage = Cli.formatOutput(message, args.options);
+                    if (listener && listener.stdout) {
+                        listener.stdout(formattedMessage);
+                    }
+                    log.push(formattedMessage);
                 },
                 logRaw: (message) => {
-                    log.push(Cli.formatOutput(message, args.options));
+                    const formattedMessage = Cli.formatOutput(message, args.options);
+                    if (listener && listener.stdout) {
+                        listener.stdout(formattedMessage);
+                    }
+                    log.push(formattedMessage);
                 },
                 logToStderr: (message) => {
+                    if (listener && listener.stderr) {
+                        listener.stderr(message);
+                    }
                     logErr.push(message);
                 }
             };
             if (args.options.debug) {
-                Cli.log(`Executing command ${command.name} with options ${JSON.stringify(args)}`);
+                const message = `Executing command ${command.name} with options ${JSON.stringify(args)}`;
+                if (listener && listener.stderr) {
+                    listener.stderr(message);
+                }
+                logErr.push(message);
             }
             // store the current command name, if any and set the name to the name of
             // the command to execute
             const cli = Cli.getInstance();
             const parentCommandName = cli.currentCommandName;
             cli.currentCommandName = command.getCommandName();
+            // store the current logger if any
+            const currentLogger = request_1.default.logger;
             command.action(logger, args, (err) => {
                 // restore the original command name
                 cli.currentCommandName = parentCommandName;
+                // restore the original logger
+                request_1.default.logger = currentLogger;
                 if (err) {
                     return reject({
                         error: err,
@@ -416,11 +436,11 @@ class Cli {
         if (arrayType !== 'object') {
             return logStatement.join(os.EOL);
         }
-        // if output type has been set to 'text', process the retrieved
+        // if output type has been set to 'text' or 'csv', process the retrieved
         // data so that returned objects contain only default properties specified
         // on the current command. If there is no current command or the
         // command doesn't specify default properties, return original data
-        if (options.output === 'text') {
+        if (options.output === 'text' || options.output === 'csv') {
             const cli = Cli.getInstance();
             const currentCommand = cli.commandToExecute;
             if (arrayType === 'object' &&
@@ -440,6 +460,18 @@ class Cli {
                 }
             }
         }
+        if (options.output === 'csv') {
+            const { stringify } = require('csv-stringify/sync');
+            const cli = Cli.getInstance();
+            // https://csv.js.org/stringify/options/
+            return stringify(logStatement, {
+                header: cli.getSettingWithDefaultValue(settingsNames_1.settingsNames.csvHeader, true),
+                escape: cli.getSettingWithDefaultValue(settingsNames_1.settingsNames.csvEscape, '"'),
+                quote: cli.config.get(settingsNames_1.settingsNames.csvQuote),
+                quoted: cli.getSettingWithDefaultValue(settingsNames_1.settingsNames.csvQuoted, false),
+                quotedEmpty: cli.getSettingWithDefaultValue(settingsNames_1.settingsNames.csvQuotedEmpty, false)
+            });
+        }
         // display object as a list of key-value pairs
         if (logStatement.length === 1) {
             const obj = logStatement[0];

package/dist/m365/aad/commands/app/app-add.js

@@ -105,21 +105,49 @@ class AadAppAddCommand extends GraphItemsListCommand_1.GraphItemsListCommand {
         if (!args.options.manifest) {
             return Promise.resolve(appInfo);
         }
-        const manifest = JSON.parse(args.options.manifest);
+        const v2Manifest = JSON.parse(args.options.manifest);
         // remove properties that might be coming from the original app that was
         // used to create the manifest and which can't be updated
-        delete manifest.id;
-        delete manifest.appId;
-        delete manifest.publisherDomain;
+        delete v2Manifest.id;
+        delete v2Manifest.appId;
+        delete v2Manifest.publisherDomain;
         // Azure Portal returns v2 manifest whereas the Graph API expects a v1.6
-        const transformedManifest = this.transformManifest(manifest);
+        const graphManifest = this.transformManifest(v2Manifest);
         const updateAppRequestOptions = {
             url: `${this.resource}/v1.0/myorganization/applications/${appInfo.id}`,
             headers: {
                 'content-type': 'application/json'
             },
             responseType: 'json',
-            data: transformedManifest
+            data: graphManifest
+        };
+        return request_1.default
+            .patch(updateAppRequestOptions)
+            .then(_ => this.updatePreAuthorizedAppsFromManifest(v2Manifest, appInfo))
+            .then(_ => Promise.resolve(appInfo));
+    }
+    updatePreAuthorizedAppsFromManifest(manifest, appInfo) {
+        if (!manifest ||
+            !manifest.preAuthorizedApplications ||
+            manifest.preAuthorizedApplications.length === 0) {
+            return Promise.resolve(appInfo);
+        }
+        const graphManifest = {
+            api: {
+                preAuthorizedApplications: manifest.preAuthorizedApplications
+            }
+        };
+        graphManifest.api.preAuthorizedApplications.forEach((p) => {
+            p.delegatedPermissionIds = p.permissionIds;
+            delete p.permissionIds;
+        });
+        const updateAppRequestOptions = {
+            url: `${this.resource}/v1.0/myorganization/applications/${appInfo.id}`,
+            headers: {
+                'content-type': 'application/json'
+            },
+            responseType: 'json',
+            data: graphManifest
         };
         return request_1.default
             .patch(updateAppRequestOptions)
@@ -180,8 +208,16 @@ class AadAppAddCommand extends GraphItemsListCommand_1.GraphItemsListCommand {
         delete graphManifest.oauth2AllowIdTokenImplicitFlow;
         graphManifest.api.oauth2PermissionScopes = v2Manifest.oauth2Permissions;
         delete graphManifest.oauth2Permissions;
+        if (graphManifest.api.oauth2PermissionScopes) {
+            graphManifest.api.oauth2PermissionScopes.forEach((scope) => {
+                delete scope.lang;
+                delete scope.origin;
+            });
+        }
         delete graphManifest.oauth2RequiredPostResponse;
-        graphManifest.api.preAuthorizedApplications = v2Manifest.preAuthorizedApplications;
+        // MS Graph doesn't support creating OAuth2 permissions and pre-authorized
+        // apps in one request. This is why we need to remove it here and do it in
+        // the next request
         delete graphManifest.preAuthorizedApplications;
         if (v2Manifest.replyUrlsWithType) {
             v2Manifest.replyUrlsWithType.forEach((urlWithType) => {

package/dist/m365/aad/commands/app/app-delete.js

@@ -0,0 +1,123 @@
+"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 AadAppDeleteCommand extends GraphCommand_1.default {
+    get name() {
+        return commands_1.default.APP_DELETE;
+    }
+    get description() {
+        return 'Removes an Azure AD app registration';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.appId = typeof args.options.appId !== 'undefined';
+        telemetryProps.objectId = typeof args.options.objectId !== 'undefined';
+        telemetryProps.name = typeof args.options.name !== 'undefined';
+        telemetryProps.confirm = (!(!args.options.confirm)).toString();
+        return telemetryProps;
+    }
+    commandAction(logger, args, cb) {
+        const deleteApp = () => {
+            this
+                .getObjectId(args, logger)
+                .then((objectId) => {
+                if (this.verbose) {
+                    logger.logToStderr(`Deleting Azure AD app ${objectId}...`);
+                }
+                const requestOptions = {
+                    url: `${this.resource}/v1.0/myorganization/applications/${objectId}`,
+                    headers: {
+                        accept: 'application/json;odata.metadata=none'
+                    },
+                    responseType: 'json'
+                };
+                return request_1.default.delete(requestOptions);
+            })
+                .then(_ => cb(), (rawRes) => this.handleRejectedODataJsonPromise(rawRes, logger, cb));
+        };
+        if (args.options.confirm) {
+            deleteApp();
+        }
+        else {
+            cli_1.Cli.prompt({
+                type: 'confirm',
+                name: 'continue',
+                default: false,
+                message: `Are you sure you want to delete the App?`
+            }, (result) => {
+                if (!result.continue) {
+                    cb();
+                }
+                else {
+                    deleteApp();
+                }
+            });
+        }
+    }
+    getObjectId(args, logger) {
+        if (args.options.objectId) {
+            return Promise.resolve(args.options.objectId);
+        }
+        const { appId, name } = args.options;
+        if (this.verbose) {
+            logger.logToStderr(`Retrieving information about Azure AD app ${appId ? appId : name}...`);
+        }
+        const filter = appId ?
+            `appId eq '${encodeURIComponent(appId)}'` :
+            `displayName eq '${encodeURIComponent(name)}'`;
+        const requestOptions = {
+            url: `${this.resource}/v1.0/myorganization/applications?$filter=${filter}&$select=id`,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json'
+        };
+        return request_1.default
+            .get(requestOptions)
+            .then((res) => {
+            if (res.value.length === 1) {
+                return Promise.resolve(res.value[0].id);
+            }
+            if (res.value.length === 0) {
+                const applicationIdentifier = appId ? `ID ${appId}` : `name ${name}`;
+                return Promise.reject(`No Azure AD application registration with ${applicationIdentifier} found`);
+            }
+            return Promise.reject(`Multiple Azure AD application registration with name ${name} found. Please choose one of the object IDs: ${res.value.map(a => a.id).join(', ')}`);
+        });
+    }
+    options() {
+        const options = [
+            { option: '--appId [appId]' },
+            { option: '--objectId [objectId]' },
+            { option: '--name [name]' },
+            { option: '--confirm' }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        if (!args.options.appId &&
+            !args.options.objectId &&
+            !args.options.name) {
+            return 'Specify either appId, objectId, or name';
+        }
+        if ((args.options.appId && args.options.objectId) ||
+            (args.options.appId && args.options.name) ||
+            (args.options.objectId && args.options.name)) {
+            return 'Specify either appId, objectId, or name';
+        }
+        if (args.options.appId && !Utils_1.default.isValidGuid(args.options.appId)) {
+            return `${args.options.appId} is not a valid GUID`;
+        }
+        if (args.options.objectId && !Utils_1.default.isValidGuid(args.options.objectId)) {
+            return `${args.options.objectId} is not a valid GUID`;
+        }
+        return true;
+    }
+}
+module.exports = new AadAppDeleteCommand();
+//# sourceMappingURL=app-delete.js.map

package/dist/m365/aad/commands/app/app-get.js

@@ -0,0 +1,97 @@
+"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 AadAppGetCommand extends GraphCommand_1.default {
+    get name() {
+        return commands_1.default.APP_GET;
+    }
+    get description() {
+        return 'Gets an Azure AD app registration';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.appId = typeof args.options.appId !== 'undefined';
+        telemetryProps.objectId = typeof args.options.objectId !== 'undefined';
+        telemetryProps.name = typeof args.options.name !== 'undefined';
+        return telemetryProps;
+    }
+    commandAction(logger, args, cb) {
+        this
+            .getAppObjectId(args)
+            .then((appObjectId) => {
+            const requestOptions = {
+                url: `${this.resource}/v1.0/myorganization/applications/${appObjectId}`,
+                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));
+    }
+    getAppObjectId(args) {
+        if (args.options.objectId) {
+            return Promise.resolve(args.options.objectId);
+        }
+        const { appId, name } = args.options;
+        const filter = appId ?
+            `appId eq '${encodeURIComponent(appId)}'` :
+            `displayName eq '${encodeURIComponent(name)}'`;
+        const requestOptions = {
+            url: `${this.resource}/v1.0/myorganization/applications?$filter=${filter}&$select=id`,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json'
+        };
+        return request_1.default
+            .get(requestOptions)
+            .then((res) => {
+            if (res.value.length === 1) {
+                return Promise.resolve(res.value[0].id);
+            }
+            if (res.value.length === 0) {
+                const applicationIdentifier = appId ? `ID ${appId}` : `name ${name}`;
+                return Promise.reject(`No Azure AD application registration with ${applicationIdentifier} found`);
+            }
+            return Promise.reject(`Multiple Azure AD application registration with name ${name} found. Please disambiguate (app object IDs): ${res.value.map(a => a.id).join(', ')}`);
+        });
+    }
+    options() {
+        const options = [
+            { option: '--appId [appId]' },
+            { option: '--objectId [objectId]' },
+            { option: '--name [name]' }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        if (!args.options.appId &&
+            !args.options.objectId &&
+            !args.options.name) {
+            return 'Specify either appId, objectId, or name';
+        }
+        if ((args.options.appId && args.options.objectId) ||
+            (args.options.appId && args.options.name) ||
+            (args.options.objectId && args.options.name)) {
+            return 'Specify either appId, objectId, or name but not both';
+        }
+        if (args.options.appId && !Utils_1.default.isValidGuid(args.options.appId)) {
+            return `${args.options.appId} is not a valid GUID`;
+        }
+        if (args.options.objectId && !Utils_1.default.isValidGuid(args.options.objectId)) {
+            return `${args.options.objectId} is not a valid GUID`;
+        }
+        return true;
+    }
+}
+module.exports = new AadAppGetCommand();
+//# sourceMappingURL=app-get.js.map

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

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const GraphItemsListCommand_1 = require("../../../base/GraphItemsListCommand");
+const commands_1 = require("../../commands");
+class AadGroupListCommand extends GraphItemsListCommand_1.GraphItemsListCommand {
+    get name() {
+        return commands_1.default.GROUP_LIST;
+    }
+    get description() {
+        return 'Lists all groups defined in Azure Active Directory.';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.deleted = args.options.deleted;
+        return telemetryProps;
+    }
+    defaultProperties() {
+        return ['id', 'displayName', 'groupType'];
+    }
+    commandAction(logger, args, cb) {
+        const endpoint = args.options.deleted ? 'directory/deletedItems/microsoft.graph.group' : 'groups';
+        this
+            .getAllItems(`${this.resource}/v1.0/${endpoint}`, logger, true)
+            .then(() => {
+            if (args.options.output === 'text') {
+                this.items.forEach((group) => {
+                    if (group.groupTypes && group.groupTypes.length > 0 && group.groupTypes[0] === 'Unified') {
+                        group.groupType = 'Microsoft 365';
+                    }
+                    else if (group.mailEnabled && group.securityEnabled) {
+                        group.groupType = 'Mail enabled security';
+                    }
+                    else if (group.securityEnabled) {
+                        group.groupType = 'Security';
+                    }
+                    else if (group.mailEnabled) {
+                        group.groupType = 'Distribution';
+                    }
+                });
+            }
+            logger.log(this.items);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    options() {
+        const options = [
+            { option: '-d, --deleted' }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+}
+module.exports = new AadGroupListCommand();
+//# sourceMappingURL=group-list.js.map

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

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

package/dist/m365/aad/commands/o365group/o365group-user-set.js

@@ -37,14 +37,14 @@ class AadO365GroupUserSetCommand extends GraphItemsListCommand_1.GraphItemsListC
                 logger.logToStderr(this.items);
                 logger.logToStderr('');
             }
-            if (this.items.filter(i => i.userPrincipalName.toLocaleLowerCase() === args.options.userName.toLocaleLowerCase()).length <= 0) {
+            if (this.items.filter(i => args.options.userName.toUpperCase() === i.userPrincipalName.toUpperCase()).length <= 0) {
                 const userNotInGroup = (typeof args.options.groupId !== 'undefined') ?
                     'The specified user does not belong to the given Microsoft 365 Group. Please use the \'o365group user add\' command to add new users.' :
                     'The specified user does not belong to the given Microsoft Teams team. Please use the \'graph teams user add\' command to add new users.';
                 throw new Error(userNotInGroup);
             }
             if (args.options.role === "Owner") {
-                const foundMember = this.items.find(e => e.userPrincipalName.toLocaleLowerCase() === args.options.userName.toLocaleLowerCase() && e.userType === 'Member');
+                const foundMember = this.items.find(e => args.options.userName.toUpperCase() === e.userPrincipalName.toUpperCase() && e.userType === 'Member');
                 if (foundMember !== undefined) {
                     const endpoint = `${this.resource}/v1.0/groups/${groupId}/owners/$ref`;
                     const requestOptions = {
@@ -65,7 +65,7 @@ class AadO365GroupUserSetCommand extends GraphItemsListCommand_1.GraphItemsListC
                 }
             }
             else {
-                const foundOwner = this.items.find(e => e.userPrincipalName.toLocaleLowerCase() === args.options.userName.toLocaleLowerCase() && e.userType === 'Owner');
+                const foundOwner = this.items.find(e => args.options.userName.toUpperCase() === e.userPrincipalName.toUpperCase() && e.userType === 'Owner');
                 if (foundOwner !== undefined) {
                     const endpoint = `${this.resource}/v1.0/groups/${groupId}/owners/${foundOwner.id}/$ref`;
                     const requestOptions = {