@pnp/cli-microsoft365 5.0.0-beta.5a0b256 → 5.0.0-beta.6be8a88

package/.eslintrc.js

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

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/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/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

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

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const GraphCommand_1 = require("../../../base/GraphCommand");
+const commands_1 = require("../../commands");
+class PlannerTaskGetCommand extends GraphCommand_1.default {
+    get name() {
+        return commands_1.default.TASK_GET;
+    }
+    get description() {
+        return 'Retrieve the the specified planner task';
+    }
+    commandAction(logger, args, cb) {
+        const requestOptions = {
+            url: `${this.resource}/v1.0/planner/tasks/${encodeURIComponent(args.options.id)}`,
+            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, --id <id>' }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+}
+module.exports = new PlannerTaskGetCommand();
+//# sourceMappingURL=task-get.js.map

package/dist/m365/planner/commands.js

@@ -8,6 +8,8 @@ exports.default = {
     PLAN_GET: `${prefix} plan get`,
     PLAN_LIST: `${prefix} plan list`,
     TASK_ADD: `${prefix} task add`,
+    TASK_DETAILS_GET: `${prefix} task details get`,
+    TASK_GET: `${prefix} task get`,
     TASK_LIST: `${prefix} task list`,
     TASK_SET: `${prefix} task set`
 };

package/dist/m365/spo/commands/group/group-user-remove.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_1 = require("../../../../cli");
+const request_1 = require("../../../../request");
+const SpoCommand_1 = require("../../../base/SpoCommand");
+const commands_1 = require("../../commands");
+class SpoGroupUserRemoveCommand extends SpoCommand_1.default {
+    get name() {
+        return commands_1.default.GROUP_USER_REMOVE;
+    }
+    get description() {
+        return 'Removes the specified user from a SharePoint group';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.groupId = (!(!args.options.groupId)).toString();
+        telemetryProps.groupName = (!(!args.options.groupName)).toString();
+        telemetryProps.confirm = (!(!args.options.confirm)).toString();
+        return telemetryProps;
+    }
+    commandAction(logger, args, cb) {
+        const removeUserfromSPGroup = () => {
+            if (this.verbose) {
+                logger.logToStderr(`Removing User with Username ${args.options.userName} from Group: ${args.options.groupId ? args.options.groupId : args.options.groupName}`);
+            }
+            const loginName = `i:0#.f|membership|${args.options.userName}`;
+            const requestUrl = `${args.options.webUrl}/_api/web/sitegroups/${args.options.groupId
+                ? `GetById('${encodeURIComponent(args.options.groupId)}')`
+                : `GetByName('${encodeURIComponent(args.options.groupName)}')`}/users/removeByLoginName(@LoginName)?@LoginName='${encodeURIComponent(loginName)}'`;
+            const requestOptions = {
+                url: requestUrl,
+                headers: {
+                    'accept': 'application/json;odata=nometadata'
+                },
+                responseType: 'json'
+            };
+            request_1.default
+                .post(requestOptions)
+                .then(() => {
+                cb();
+            }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+        };
+        if (args.options.confirm) {
+            if (this.debug) {
+                logger.logToStderr('Confirmation bypassed by entering confirm option. Removing the user from SharePoint Group...');
+            }
+            removeUserfromSPGroup();
+        }
+        else {
+            cli_1.Cli.prompt({
+                type: 'confirm',
+                name: 'continue',
+                default: false,
+                message: `Are you sure you want to remove user User ${args.options.userName} from SharePoint group?`
+            }, (result) => {
+                if (!result.continue) {
+                    cb();
+                }
+                else {
+                    removeUserfromSPGroup();
+                }
+            });
+        }
+    }
+    options() {
+        const options = [
+            {
+                option: '-u, --webUrl <webUrl>'
+            },
+            {
+                option: '--groupId [groupId]'
+            },
+            {
+                option: '--groupName [groupName]'
+            },
+            {
+                option: '--userName <userName>'
+            },
+            {
+                option: '--confirm'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        if (args.options.groupId && args.options.groupName) {
+            return 'Use either "groupName" or "groupId", but not both';
+        }
+        if (!args.options.groupId && !args.options.groupName) {
+            return 'Either "groupName" or "groupId" is required';
+        }
+        if (args.options.groupId && isNaN(args.options.groupId)) {
+            return `Specified "groupId" ${args.options.groupId} is not valid`;
+        }
+        return SpoCommand_1.default.isValidSharePointUrl(args.options.webUrl);
+    }
+}
+module.exports = new SpoGroupUserRemoveCommand();
+//# sourceMappingURL=group-user-remove.js.map

package/dist/m365/spo/commands.js

@@ -64,6 +64,7 @@ exports.default = {
     GROUP_REMOVE: `${prefix} group remove`,
     GROUP_USER_ADD: `${prefix} group user add`,
     GROUP_USER_LIST: `${prefix} group user list`,
+    GROUP_USER_REMOVE: `${prefix} group user remove`,
     HIDEDEFAULTTHEMES_GET: `${prefix} hidedefaultthemes get`,
     HIDEDEFAULTTHEMES_SET: `${prefix} hidedefaultthemes set`,
     HOMESITE_GET: `${prefix} homesite get`,

package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-health-get.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const GraphCommand_1 = require("../../../base/GraphCommand");
+const request_1 = require("../../../../request");
+const commands_1 = require("../../commands");
+class TenantServiceAnnouncementHealthGetCommand extends GraphCommand_1.default {
+    get name() {
+        return commands_1.default.SERVICEANNOUNCEMENT_HEALTH_GET;
+    }
+    get description() {
+        return 'This operation provides the health information of a specified service for a tenant';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.issues = typeof args.options.issues !== 'undefined';
+        return telemetryProps;
+    }
+    defaultProperties() {
+        return ['id', 'status', 'service'];
+    }
+    commandAction(logger, args, cb) {
+        this
+            .getServiceHealth(args.options)
+            .then((res) => {
+            logger.log(res);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    getServiceHealth(options) {
+        const requestOptions = {
+            url: `${this.resource}/v1.0/admin/serviceAnnouncement/healthOverviews/${options.serviceName}${options.issues && (!options.output || options.output.toLocaleLowerCase() === 'json') ? '?$expand=issues' : ''}`,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json'
+        };
+        return request_1.default
+            .get(requestOptions)
+            .then(response => {
+            const serviceHealth = response;
+            if (!serviceHealth) {
+                return Promise.reject(`Error fetching service health`);
+            }
+            return Promise.resolve(serviceHealth);
+        });
+    }
+    options() {
+        const options = [
+            { option: '-s, --serviceName <serviceName>' },
+            { option: '-i, --issues' }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+}
+module.exports = new TenantServiceAnnouncementHealthGetCommand();
+//# sourceMappingURL=serviceannouncement-health-get.js.map

package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-health-list.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const GraphCommand_1 = require("../../../base/GraphCommand");
+const request_1 = require("../../../../request");
+const commands_1 = require("../../commands");
+class TenantServiceAnnouncementHealthListCommand extends GraphCommand_1.default {
+    get name() {
+        return commands_1.default.SERVICEANNOUNCEMENT_HEALTH_LIST;
+    }
+    get description() {
+        return 'This operation provides the health report of all subscribed services for a tenant';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.issues = typeof args.options.issues !== 'undefined';
+        return telemetryProps;
+    }
+    defaultProperties() {
+        return ['id', 'status', 'service'];
+    }
+    commandAction(logger, args, cb) {
+        this
+            .listServiceHealth(args.options)
+            .then((res) => {
+            logger.log(res);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    listServiceHealth(options) {
+        const requestOptions = {
+            url: `${this.resource}/v1.0/admin/serviceAnnouncement/healthOverviews${options.issues && (!options.output || options.output.toLocaleLowerCase() === 'json') ? '?$expand=issues' : ''}`,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json'
+        };
+        return request_1.default
+            .get(requestOptions)
+            .then(response => {
+            const serviceHealthList = response.value;
+            if (!serviceHealthList) {
+                return Promise.reject(`Error fetching service health`);
+            }
+            return Promise.resolve(serviceHealthList);
+        });
+    }
+    options() {
+        const options = [
+            { option: '-i, --issues' }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+}
+module.exports = new TenantServiceAnnouncementHealthListCommand();
+//# sourceMappingURL=serviceannouncement-health-list.js.map

package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-healthissue-get.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const GraphCommand_1 = require("../../../base/GraphCommand");
+const commands_1 = require("../../commands");
+class TenantServiceAnnouncementHealthIssueGetCommand extends GraphCommand_1.default {
+    get name() {
+        return commands_1.default.SERVICEANNOUNCEMENT_HEALTHISSUE_GET;
+    }
+    get description() {
+        return 'Gets a specified service health issue for tenant';
+    }
+    commandAction(logger, args, cb) {
+        const requestOptions = {
+            url: `${this.resource}/v1.0/admin/serviceAnnouncement/issues/${encodeURIComponent(args.options.id)}`,
+            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, --id <id>'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+}
+module.exports = new TenantServiceAnnouncementHealthIssueGetCommand();
+//# sourceMappingURL=serviceannouncement-healthissue-get.js.map

package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-healthissue-list.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const GraphItemsListCommand_1 = require("../../../base/GraphItemsListCommand");
+const commands_1 = require("../../commands");
+class TenantServiceAnnouncementHealthIssueListCommand extends GraphItemsListCommand_1.GraphItemsListCommand {
+    get name() {
+        return commands_1.default.SERVICEANNOUNCEMENT_HEALTHISSUE_LIST;
+    }
+    get description() {
+        return 'Gets all service health issues for the tenant';
+    }
+    defaultProperties() {
+        return ['id', 'title'];
+    }
+    commandAction(logger, args, cb) {
+        let endpoint = `${this.resource}/v1.0/admin/serviceAnnouncement/issues`;
+        if (args.options.service) {
+            endpoint += `?$filter=service eq '${encodeURIComponent(args.options.service)}'`;
+        }
+        this
+            .getAllItems(endpoint, logger, true)
+            .then(() => {
+            logger.log(this.items);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    options() {
+        const options = [
+            {
+                option: '-s, --service [service]'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+}
+module.exports = new TenantServiceAnnouncementHealthIssueListCommand();
+//# sourceMappingURL=serviceannouncement-healthissue-list.js.map

package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-message-get.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const GraphCommand_1 = require("../../../base/GraphCommand");
+const commands_1 = require("../../commands");
+class TenantServiceAnnouncementMessageGetCommand extends GraphCommand_1.default {
+    get name() {
+        return commands_1.default.SERVICEANNOUNCEMENT_MESSAGE_GET;
+    }
+    get description() {
+        return 'Retrieves a specified service update message for the tenant';
+    }
+    commandAction(logger, args, cb) {
+        if (this.verbose) {
+            logger.logToStderr(`Retrieving service update message ${args.options.id}`);
+        }
+        const requestOptions = {
+            url: `${this.resource}/v1.0/admin/serviceAnnouncement/messages/${args.options.id}`,
+            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, --id <id>'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    isValidId(id) {
+        return (/MC\d{6}/).test(id);
+    }
+    validate(args) {
+        if (!this.isValidId(args.options.id)) {
+            return `${args.options.id} is not a valid message ID`;
+        }
+        return true;
+    }
+}
+module.exports = new TenantServiceAnnouncementMessageGetCommand();
+//# sourceMappingURL=serviceannouncement-message-get.js.map