@pnp/cli-microsoft365 4.4.0-beta.ffe290f → 5.0.0-beta.156f91b

package/.eslintrc.js

@@ -23,6 +23,7 @@ const dictionary = [
   'group',
   'groupify',
   'guest',
+  'health',
   'hide',
   'historical',
   'home',

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/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/cli/Cli.js

@@ -189,23 +189,38 @@ 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) {
-                logErr.push(`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

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,126 @@
+"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';
+        return telemetryProps;
+    }
+    commandAction(logger, args, cb) {
+        const deleteApp = () => {
+            this
+                .processAppDelete(logger, args)
+                .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();
+                }
+            });
+        }
+    }
+    processAppDelete(logger, args) {
+        return this
+            .getAadApp(args, logger)
+            .then((aadAppId) => {
+            if (this.verbose) {
+                logger.logToStderr(`Deleting Azure AD app ${aadAppId}...`);
+            }
+            const requestOptions = {
+                url: `${this.resource}/v1.0/myorganization/applications/${aadAppId}`,
+                headers: {
+                    accept: 'application/json;odata.metadata=none'
+                },
+                responseType: 'json'
+            };
+            return request_1.default.delete(requestOptions);
+        });
+    }
+    getAadApp(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 from one of the app 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/group/group-list.js

@@ -13,8 +13,9 @@ class AadGroupListCommand extends GraphItemsListCommand_1.GraphItemsListCommand
         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/groups`, logger, true)
+            .getAllItems(`${this.resource}/v1.0/${endpoint}`, logger, true)
             .then(() => {
             if (args.options.output === 'text') {
                 this.items.forEach((group) => {
@@ -36,6 +37,13 @@ class AadGroupListCommand extends GraphItemsListCommand_1.GraphItemsListCommand
             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/oauth2grant/oauth2grant-list.js

@@ -2,9 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const request_1 = require("../../../../request");
 const Utils_1 = require("../../../../Utils");
-const AadCommand_1 = require("../../../base/AadCommand");
+const GraphCommand_1 = require("../../../base/GraphCommand");
 const commands_1 = require("../../commands");
-class AadOAuth2GrantListCommand extends AadCommand_1.default {
+class AadOAuth2GrantListCommand extends GraphCommand_1.default {
     get name() {
         return commands_1.default.OAUTH2GRANT_LIST;
     }
@@ -19,9 +19,9 @@ class AadOAuth2GrantListCommand extends AadCommand_1.default {
             logger.logToStderr(`Retrieving list of OAuth grants for the service principal...`);
         }
         const requestOptions = {
-            url: `${this.resource}/myorganization/oauth2PermissionGrants?api-version=1.6&$filter=clientId eq '${encodeURIComponent(args.options.clientId)}'`,
+            url: `${this.resource}/v1.0/oauth2PermissionGrants?$filter=clientId eq '${encodeURIComponent(args.options.spObjectId)}'`,
             headers: {
-                accept: 'application/json;odata=nometadata'
+                accept: 'application/json;odata.metadata=none'
             },
             responseType: 'json'
         };
@@ -37,15 +37,15 @@ class AadOAuth2GrantListCommand extends AadCommand_1.default {
     options() {
         const options = [
             {
-                option: '-i, --clientId <clientId>'
+                option: '-i, --spObjectId <spObjectId>'
             }
         ];
         const parentOptions = super.options();
         return options.concat(parentOptions);
     }
     validate(args) {
-        if (!Utils_1.default.isValidGuid(args.options.clientId)) {
-            return `${args.options.clientId} is not a valid GUID`;
+        if (!Utils_1.default.isValidGuid(args.options.spObjectId)) {
+            return `${args.options.spObjectId} is not a valid GUID`;
         }
         return true;
     }

package/dist/m365/aad/commands/oauth2grant/oauth2grant-remove.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const cli_1 = require("../../../../cli");
 const request_1 = require("../../../../request");
 const GraphCommand_1 = require("../../../base/GraphCommand");
 const commands_1 = require("../../commands");
@@ -11,24 +12,47 @@ class AadOAuth2GrantRemoveCommand extends GraphCommand_1.default {
         return 'Remove specified service principal OAuth2 permissions';
     }
     commandAction(logger, args, cb) {
-        if (this.verbose) {
-            logger.logToStderr(`Removing OAuth2 permissions...`);
-        }
-        const requestOptions = {
-            url: `${this.resource}/v1.0/oauth2PermissionGrants/${encodeURIComponent(args.options.grantId)}`,
-            headers: {
-                'accept': 'application/json;odata.metadata=none'
-            },
-            responseType: 'json'
+        const removeOauth2Grant = () => {
+            if (this.verbose) {
+                logger.logToStderr(`Removing OAuth2 permissions...`);
+            }
+            const requestOptions = {
+                url: `${this.resource}/v1.0/oauth2PermissionGrants/${encodeURIComponent(args.options.grantId)}`,
+                headers: {
+                    'accept': 'application/json;odata.metadata=none'
+                },
+                responseType: 'json'
+            };
+            request_1.default
+                .delete(requestOptions)
+                .then(_ => cb(), (rawRes) => this.handleRejectedODataJsonPromise(rawRes, logger, cb));
         };
-        request_1.default
-            .delete(requestOptions)
-            .then(_ => cb(), (rawRes) => this.handleRejectedODataJsonPromise(rawRes, logger, cb));
+        if (args.options.confirm) {
+            removeOauth2Grant();
+        }
+        else {
+            cli_1.Cli.prompt({
+                type: 'confirm',
+                name: 'continue',
+                default: false,
+                message: `Are you sure you want to remove the OAuth2 permissions for ${args.options.grantId}?`
+            }, (result) => {
+                if (!result.continue) {
+                    cb();
+                }
+                else {
+                    removeOauth2Grant();
+                }
+            });
+        }
     }
     options() {
         const options = [
             {
                 option: '-i, --grantId <grantId>'
+            },
+            {
+                option: '--confirm'
             }
         ];
         const parentOptions = super.options();

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

@@ -2,9 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const request_1 = require("../../../../request");
 const Utils_1 = require("../../../../Utils");
-const AadCommand_1 = require("../../../base/AadCommand");
+const GraphCommand_1 = require("../../../base/GraphCommand");
 const commands_1 = require("../../commands");
-class AadSpGetCommand extends AadCommand_1.default {
+class AadSpGetCommand extends GraphCommand_1.default {
     get name() {
         return commands_1.default.SP_GET;
     }
@@ -18,35 +18,58 @@ class AadSpGetCommand extends AadCommand_1.default {
         telemetryProps.objectId = (!(!args.options.objectId)).toString();
         return telemetryProps;
     }
-    commandAction(logger, args, cb) {
-        if (this.verbose) {
-            logger.logToStderr(`Retrieving service principal information...`);
+    getSpId(args) {
+        if (args.options.objectId) {
+            return Promise.resolve(args.options.objectId);
         }
         let spMatchQuery = '';
-        if (args.options.appId) {
-            spMatchQuery = `appId eq '${encodeURIComponent(args.options.appId)}'`;
-        }
-        else if (args.options.objectId) {
-            spMatchQuery = `objectId eq '${encodeURIComponent(args.options.objectId)}'`;
-        }
-        else {
+        if (args.options.displayName) {
             spMatchQuery = `displayName eq '${encodeURIComponent(args.options.displayName)}'`;
         }
-        const requestOptions = {
-            url: `${this.resource}/myorganization/servicePrincipals?api-version=1.6&$filter=${spMatchQuery}`,
+        else if (args.options.appId) {
+            spMatchQuery = `appId eq '${encodeURIComponent(args.options.appId)}'`;
+        }
+        const idRequestOptions = {
+            url: `${this.resource}/v1.0/servicePrincipals?$filter=${spMatchQuery}`,
             headers: {
-                accept: 'application/json;odata=nometadata'
+                accept: 'application/json;odata.metadata=none'
             },
             responseType: 'json'
         };
-        request_1.default
-            .get(requestOptions)
-            .then((res) => {
-            if (res.value && res.value.length > 0) {
-                logger.log(res.value[0]);
+        return request_1.default
+            .get(idRequestOptions)
+            .then(response => {
+            const spItem = response.value[0];
+            if (!spItem) {
+                return Promise.reject(`The specified Azure AD app does not exist`);
+            }
+            if (response.value.length > 1) {
+                return Promise.reject(`Multiple Azure AD apps with name ${args.options.displayName} found: ${response.value.map(x => x.id)}`);
             }
+            return Promise.resolve(spItem.id);
+        });
+    }
+    commandAction(logger, args, cb) {
+        if (this.verbose) {
+            logger.logToStderr(`Retrieving service principal information...`);
+        }
+        this
+            .getSpId(args)
+            .then((id) => {
+            const requestOptions = {
+                url: `${this.resource}/v1.0/servicePrincipals/${id}`,
+                headers: {
+                    accept: 'application/json;odata.metadata=none',
+                    'content-type': 'application/json;odata.metadata=none'
+                },
+                responseType: 'json'
+            };
+            return request_1.default.get(requestOptions);
+        })
+            .then((res) => {
+            logger.log(res);
             cb();
-        }, (rawRes) => this.handleRejectedODataJsonPromise(rawRes, logger, cb));
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
     }
     options() {
         const options = [

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

@@ -15,6 +15,7 @@ class AadUserListCommand extends GraphItemsListCommand_1.GraphItemsListCommand {
     getTelemetryProperties(args) {
         const telemetryProps = super.getTelemetryProperties(args);
         telemetryProps.properties = args.options.properties;
+        telemetryProps.deleted = typeof args.options.deleted !== 'undefined';
         return telemetryProps;
     }
     commandAction(logger, args, cb) {
@@ -22,7 +23,8 @@ class AadUserListCommand extends GraphItemsListCommand_1.GraphItemsListCommand {
             args.options.properties.split(',').map(p => p.trim()) :
             ['userPrincipalName', 'displayName'];
         const filter = this.getFilter(args.options);
-        const url = `${this.resource}/v1.0/users?$select=${properties.join(',')}${(filter.length > 0 ? '&' + filter : '')}&$top=100`;
+        const endpoint = args.options.deleted ? 'directory/deletedItems/microsoft.graph.user' : 'users';
+        const url = `${this.resource}/v1.0/${endpoint}?$select=${properties.join(',')}${(filter.length > 0 ? '&' + filter : '')}&$top=100`;
         this
             .getAllItems(url, logger, true)
             .then(() => {
@@ -35,6 +37,8 @@ class AadUserListCommand extends GraphItemsListCommand_1.GraphItemsListCommand {
         const excludeOptions = [
             'properties',
             'p',
+            'deleted',
+            'd',
             'debug',
             'verbose',
             'output',
@@ -55,9 +59,8 @@ class AadUserListCommand extends GraphItemsListCommand_1.GraphItemsListCommand {
     }
     options() {
         const options = [
-            {
-                option: '-p, --properties [properties]'
-            }
+            { option: '-p, --properties [properties]' },
+            { option: '-d, --deleted' }
         ];
         const parentOptions = super.options();
         return options.concat(parentOptions);

package/dist/m365/aad/commands.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const prefix = 'aad';
 exports.default = {
     APP_ADD: `${prefix} app add`,
+    APP_DELETE: `${prefix} app delete`,
     APP_GET: `${prefix} app get`,
     APP_SET: `${prefix} app set`,
     APP_ROLE_ADD: `${prefix} app role add`,

package/dist/m365/flow/commands/flow-get.js

@@ -29,8 +29,8 @@ class FlowGetCommand extends AzmgmtCommand_1.default {
             .then((res) => {
             res.displayName = res.properties.displayName;
             res.description = res.properties.definitionSummary.description || '';
-            res.triggers = Object.keys(res.properties.definition.triggers).join(', ');
-            res.actions = Object.keys(res.properties.definition.actions).join(', ');
+            res.triggers = res.properties.definitionSummary.triggers.map((t) => (t.type + (t.kind ? "-" + t.kind : ''))).join(', ');
+            res.actions = res.properties.definitionSummary.actions.map((a) => (a.type + (a.swaggerOperationId ? "-" + a.swaggerOperationId : ''))).join(', ');
             logger.log(res);
             cb();
         }, (rawRes) => this.handleRejectedODataJsonPromise(rawRes, logger, cb));

package/dist/m365/planner/AppliedCategories.js

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

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

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const GraphItemsListCommand_1 = require("../../../base/GraphItemsListCommand");
+const commands_1 = require("../../commands");
+class PlannerTaskDetailsGetCommand extends GraphItemsListCommand_1.GraphItemsListCommand {
+    get name() {
+        return commands_1.default.TASK_DETAILS_GET;
+    }
+    get description() {
+        return 'Retrieve the details of the specified planner task';
+    }
+    commandAction(logger, args, cb) {
+        const requestOptions = {
+            url: `${this.resource}/v1.0/planner/tasks/${encodeURIComponent(args.options.taskId)}/details`,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json'
+        };
+        request_1.default
+            .get(requestOptions)
+            .then((res) => {
+            logger.log(res);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    options() {
+        const options = [
+            {
+                option: '-i, --taskId <taskId>'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+}
+module.exports = new PlannerTaskDetailsGetCommand();
+//# sourceMappingURL=task-details-get.js.map