@pnp/cli-microsoft365 6.9.0-beta.f6054b4 → 6.10.0-beta.05cab2f

package/dist/m365/teams/commands/team/team-unarchive.js

@@ -36,14 +36,13 @@ class TeamsTeamUnarchiveCommand extends GraphCommand_1.default {
         __classPrivateFieldGet(this, _TeamsTeamUnarchiveCommand_instances, "m", _TeamsTeamUnarchiveCommand_initOptionSets).call(this);
     }
     getTeamId(args) {
-        if (args.options.id) {
-            return Promise.resolve(args.options.id);
-        }
-        return aadGroup_1.aadGroup
-            .getGroupByDisplayName(args.options.name)
-            .then(group => {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (args.options.id) {
+                return args.options.id;
+            }
+            const group = yield aadGroup_1.aadGroup.getGroupByDisplayName(args.options.name);
             if (group.resourceProvisioningOptions.indexOf('Team') === -1) {
-                return Promise.reject(`The specified team does not exist in the Microsoft Teams`);
+                throw 'The specified team does not exist in the Microsoft Teams';
             }
             return group.id;
         });

package/dist/m365/teams/commands/user/user-app-list.js

@@ -68,17 +68,19 @@ class TeamsUserAppListCommand extends GraphCommand_1.default {
         });
     }
     getUserId(args) {
-        if (args.options.userId) {
-            return Promise.resolve({ value: args.options.userId });
-        }
-        const requestOptions = {
-            url: `${this.resource}/v1.0/users/${formatting_1.formatting.encodeQueryParameter(args.options.userName)}/id`,
-            headers: {
-                accept: 'application/json;odata.metadata=none'
-            },
-            responseType: 'json'
-        };
-        return request_1.default.get(requestOptions);
+        return __awaiter(this, void 0, void 0, function* () {
+            if (args.options.userId) {
+                return { value: args.options.userId };
+            }
+            const requestOptions = {
+                url: `${this.resource}/v1.0/users/${formatting_1.formatting.encodeQueryParameter(args.options.userName)}/id`,
+                headers: {
+                    accept: 'application/json;odata.metadata=none'
+                },
+                responseType: 'json'
+            };
+            return request_1.default.get(requestOptions);
+        });
     }
 }
 _TeamsUserAppListCommand_instances = new WeakSet(), _TeamsUserAppListCommand_initTelemetry = function _TeamsUserAppListCommand_initTelemetry() {

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

@@ -54,8 +54,9 @@ class TeamsUserListCommand extends GraphCommand_1.default {
         });
     }
     getOwners(logger, groupId) {
-        const endpoint = `${this.resource}/v1.0/groups/${groupId}/owners?$select=id,displayName,userPrincipalName,userType`;
-        return odata_1.odata.getAllItems(endpoint).then((items) => {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = `${this.resource}/v1.0/groups/${groupId}/owners?$select=id,displayName,userPrincipalName,userType`;
+            const items = yield odata_1.odata.getAllItems(endpoint);
             this.items = this.items.concat(items);
             // Currently there is a bug in the Microsoft Graph that returns Owners as
             // userType 'member'. We therefore update all returned user as owner
@@ -65,8 +66,10 @@ class TeamsUserListCommand extends GraphCommand_1.default {
         });
     }
     getMembersAndGuests(logger, groupId) {
-        const endpoint = `${this.resource}/v1.0/groups/${groupId}/members?$select=id,displayName,userPrincipalName,userType`;
-        return odata_1.odata.getAllItems(endpoint);
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = `${this.resource}/v1.0/groups/${groupId}/members?$select=id,displayName,userPrincipalName,userType`;
+            return odata_1.odata.getAllItems(endpoint);
+        });
     }
 }
 _TeamsUserListCommand_instances = new WeakSet(), _TeamsUserListCommand_initTelemetry = function _TeamsUserListCommand_initTelemetry() {

package/dist/m365/tenant/commands/security/security-alerts-list.js

@@ -47,36 +47,35 @@ class TenantSecurityAlertsListCommand extends GraphCommand_1.default {
         });
     }
     listAlert(options) {
-        let queryFilter = '';
-        if (options.vendor) {
-            let vendorName = options.vendor;
-            switch (options.vendor.toLowerCase()) {
-                case 'azure security center':
-                    vendorName = 'ASC';
-                    break;
-                case 'microsoft cloud app security':
-                    vendorName = 'MCAS';
-                    break;
-                case 'azure active directory identity protection':
-                    vendorName = 'IPC';
+        return __awaiter(this, void 0, void 0, function* () {
+            let queryFilter = '';
+            if (options.vendor) {
+                let vendorName = options.vendor;
+                switch (options.vendor.toLowerCase()) {
+                    case 'azure security center':
+                        vendorName = 'ASC';
+                        break;
+                    case 'microsoft cloud app security':
+                        vendorName = 'MCAS';
+                        break;
+                    case 'azure active directory identity protection':
+                        vendorName = 'IPC';
+                }
+                queryFilter = `?$filter=vendorInformation/provider eq '${formatting_1.formatting.encodeQueryParameter(vendorName)}'`;
             }
-            queryFilter = `?$filter=vendorInformation/provider eq '${formatting_1.formatting.encodeQueryParameter(vendorName)}'`;
-        }
-        const requestOptions = {
-            url: `${this.resource}/v1.0/security/alerts${queryFilter}`,
-            headers: {
-                accept: 'application/json;odata.metadata=none'
-            },
-            responseType: 'json'
-        };
-        return request_1.default
-            .get(requestOptions)
-            .then(response => {
+            const requestOptions = {
+                url: `${this.resource}/v1.0/security/alerts${queryFilter}`,
+                headers: {
+                    accept: 'application/json;odata.metadata=none'
+                },
+                responseType: 'json'
+            };
+            const response = yield request_1.default.get(requestOptions);
             const alertList = response.value;
             if (!alertList) {
-                return Promise.reject(`Error fetching security alerts`);
+                throw `Error fetching security alerts`;
             }
-            return Promise.resolve(alertList);
+            return alertList;
         });
     }
 }

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

@@ -37,8 +37,8 @@ class TenantServiceAnnouncementHealthListCommand extends GraphCommand_1.default
     commandAction(logger, args) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const res = yield this.listServiceHealth(args.options);
-                logger.log(res);
+                const response = yield this.listServiceHealth(args.options);
+                logger.log(response);
             }
             catch (err) {
                 this.handleRejectedODataJsonPromise(err);
@@ -46,21 +46,20 @@ class TenantServiceAnnouncementHealthListCommand extends GraphCommand_1.default
         });
     }
     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 => {
+        return __awaiter(this, void 0, void 0, function* () {
+            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'
+            };
+            const response = yield request_1.default.get(requestOptions);
             const serviceHealthList = response.value;
             if (!serviceHealthList) {
-                return Promise.reject(`Error fetching service health`);
+                throw `Error fetching service health`;
             }
-            return Promise.resolve(serviceHealthList);
+            return serviceHealthList;
         });
     }
 }

package/dist/m365/todo/commands/list/list-remove.js

@@ -35,42 +35,8 @@ class TodoListRemoveCommand extends GraphCommand_1.default {
     }
     commandAction(logger, args) {
         return __awaiter(this, void 0, void 0, function* () {
-            const getListId = () => __awaiter(this, void 0, void 0, function* () {
-                if (args.options.name) {
-                    // Search list by its name
-                    const requestOptions = {
-                        url: `${this.resource}/v1.0/me/todo/lists?$filter=displayName eq '${escape(args.options.name)}'`,
-                        headers: {
-                            accept: "application/json;odata.metadata=none"
-                        },
-                        responseType: 'json'
-                    };
-                    const response = yield request_1.default.get(requestOptions);
-                    return response.value && response.value.length === 1 ? response.value[0].id : null;
-                }
-                return args.options.id;
-            });
-            const removeList = () => __awaiter(this, void 0, void 0, function* () {
-                try {
-                    const listId = yield getListId();
-                    if (!listId) {
-                        return Promise.reject(`The list ${args.options.name} cannot be found`);
-                    }
-                    const requestOptions = {
-                        url: `${this.resource}/v1.0/me/todo/lists/${listId}`,
-                        headers: {
-                            accept: "application/json;odata.metadata=none"
-                        },
-                        responseType: 'json'
-                    };
-                    yield request_1.default.delete(requestOptions);
-                }
-                catch (err) {
-                    this.handleRejectedODataJsonPromise(err);
-                }
-            });
             if (args.options.confirm) {
-                yield removeList();
+                yield this.removeList(args);
             }
             else {
                 const result = yield Cli_1.Cli.prompt({
@@ -80,11 +46,48 @@ class TodoListRemoveCommand extends GraphCommand_1.default {
                     message: `Are you sure you want to remove the task list ${args.options.id || args.options.name}?`
                 });
                 if (result.continue) {
-                    yield removeList();
+                    yield this.removeList(args);
                 }
             }
         });
     }
+    getListId(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (args.options.id) {
+                return args.options.id;
+            }
+            const requestOptions = {
+                url: `${this.resource}/v1.0/me/todo/lists?$filter=displayName eq '${escape(args.options.name)}'`,
+                headers: {
+                    accept: "application/json;odata.metadata=none"
+                },
+                responseType: 'json'
+            };
+            const response = yield request_1.default.get(requestOptions);
+            return response.value && response.value.length === 1 ? response.value[0].id : null;
+        });
+    }
+    removeList(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const listId = yield this.getListId(args);
+                if (!listId) {
+                    throw `The list ${args.options.name} cannot be found`;
+                }
+                const requestOptions = {
+                    url: `${this.resource}/v1.0/me/todo/lists/${listId}`,
+                    headers: {
+                        accept: "application/json;odata.metadata=none"
+                    },
+                    responseType: 'json'
+                };
+                yield request_1.default.delete(requestOptions);
+            }
+            catch (err) {
+                this.handleRejectedODataJsonPromise(err);
+            }
+        });
+    }
 }
 _TodoListRemoveCommand_instances = new WeakSet(), _TodoListRemoveCommand_initTelemetry = function _TodoListRemoveCommand_initTelemetry() {
     this.telemetry.push((args) => {

package/dist/m365/todo/commands/list/list-set.js

@@ -60,20 +60,22 @@ class TodoListSetCommand extends GraphCommand_1.default {
         });
     }
     getListId(args) {
-        const endpoint = `${this.resource}/v1.0`;
-        if (args.options.id) {
-            return Promise.resolve(args.options.id);
-        }
-        const requestOptions = {
-            url: `${endpoint}/me/todo/lists?$filter=displayName eq '${escape(args.options.name)}'`,
-            headers: {
-                accept: "application/json;odata.metadata=none"
-            },
-            responseType: 'json'
-        };
-        return request_1.default
-            .get(requestOptions)
-            .then((response) => response.value && response.value.length === 1 ? response.value[0].id : null);
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = `${this.resource}/v1.0`;
+            if (args.options.id) {
+                return args.options.id;
+            }
+            const requestOptions = {
+                url: `${endpoint}/me/todo/lists?$filter=displayName eq '${escape(args.options.name)}'`,
+                headers: {
+                    accept: "application/json;odata.metadata=none"
+                },
+                responseType: 'json'
+            };
+            return request_1.default
+                .get(requestOptions)
+                .then((response) => response.value && response.value.length === 1 ? response.value[0].id : null);
+        });
     }
 }
 _TodoListSetCommand_instances = new WeakSet(), _TodoListSetCommand_initTelemetry = function _TodoListSetCommand_initTelemetry() {

package/dist/m365/todo/commands/task/task-add.js

@@ -81,23 +81,23 @@ class TodoTaskAddCommand extends GraphCommand_1.default {
         };
     }
     getTodoListId(args) {
-        if (args.options.listId) {
-            return Promise.resolve(args.options.listId);
-        }
-        const requestOptions = {
-            url: `${this.resource}/v1.0/me/todo/lists?$filter=displayName eq '${escape(args.options.listName)}'`,
-            headers: {
-                accept: 'application/json;odata.metadata=none'
-            },
-            responseType: 'json'
-        };
-        return request_1.default.get(requestOptions)
-            .then(response => {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (args.options.listId) {
+                return args.options.listId;
+            }
+            const requestOptions = {
+                url: `${this.resource}/v1.0/me/todo/lists?$filter=displayName eq '${escape(args.options.listName)}'`,
+                headers: {
+                    accept: 'application/json;odata.metadata=none'
+                },
+                responseType: 'json'
+            };
+            const response = yield request_1.default.get(requestOptions);
             const taskList = response.value[0];
             if (!taskList) {
-                return Promise.reject(`The specified task list does not exist`);
+                throw `The specified task list does not exist`;
             }
-            return Promise.resolve(taskList.id);
+            return taskList.id;
         });
     }
 }

package/dist/m365/util/commands/accesstoken/accesstoken-get.js

@@ -34,15 +34,18 @@ class UtilAccessTokenGetCommand extends Command_1.default {
     commandAction(logger, args) {
         return __awaiter(this, void 0, void 0, function* () {
             let resource = args.options.resource;
-            if (resource.toLowerCase() === 'sharepoint') {
-                if (Auth_1.default.service.spoUrl) {
-                    resource = Auth_1.default.service.spoUrl;
+            try {
+                if (resource.toLowerCase() === 'sharepoint') {
+                    if (Auth_1.default.service.spoUrl) {
+                        resource = Auth_1.default.service.spoUrl;
+                    }
+                    else {
+                        throw `SharePoint URL undefined. Use the 'm365 spo set --url https://contoso.sharepoint.com' command to set the URL`;
+                    }
                 }
-                else {
-                    throw `SharePoint URL undefined. Use the 'm365 spo set --url https://contoso.sharepoint.com' command to set the URL`;
+                else if (resource.toLowerCase() === 'graph') {
+                    resource = Auth_1.Auth.getEndpointForResource('https://graph.microsoft.com', Auth_1.default.service.cloudType);
                 }
-            }
-            try {
                 const accessToken = yield Auth_1.default.ensureAccessToken(resource, logger, this.debug, args.options.new);
                 logger.log(accessToken);
             }

package/dist/settingsNames.js

@@ -12,7 +12,6 @@ const settingsNames = {
     disableTelemetry: 'disableTelemetry',
     errorOutput: 'errorOutput',
     helpMode: 'helpMode',
-    interactive: 'interactive',
     output: 'output',
     printErrorsAsPlainText: 'printErrorsAsPlainText',
     prompt: 'prompt',

package/dist/utils/browserUtil.js

@@ -0,0 +1,23 @@
+"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 });
+exports.browserUtil = void 0;
+exports.browserUtil = {
+    /* c8 ignore next 5 */
+    open(url) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const _open = require('open');
+            const runningOnWindows = process.platform === 'win32';
+            yield _open(url, { wait: runningOnWindows });
+        });
+    }
+};
+//# sourceMappingURL=browserUtil.js.map

package/dist/utils/md.js

@@ -25,9 +25,7 @@ function includeContent(md, rootFolder) {
         { tag: "<CLISettings />", location: "docs/_clisettings.mdx" }
     ];
     mdxImports.forEach(mdxImport => {
-        md = md.replace(mdxImport.tag, () => {
-            return fs.readFileSync(path.join(rootFolder, mdxImport.location), 'utf8');
-        }).replace(/(```\r\n)\r\n(```md defintion-list\r\n)/g, "$1$2");
+        md = md.replace(mdxImport.tag, () => fs.readFileSync(path.join(rootFolder, mdxImport.location), 'utf8')).replace(/(```\r\n)\r\n(```md definition-list\r\n)/g, "$1$2");
     });
     return md;
 }

package/dist/utils/spo.js

@@ -19,6 +19,7 @@ const base_permissions_1 = require("../m365/spo/base-permissions");
 const request_1 = require("../request");
 const formatting_1 = require("./formatting");
 const odata_1 = require("./odata");
+const RoleType_1 = require("../m365/spo/commands/roledefinition/RoleType");
 exports.spo = {
     getRequestDigest(siteUrl) {
         const requestOptions = {
@@ -569,6 +570,30 @@ exports.spo = {
             return res.AadObjectId.NameId;
         });
     },
+    /**
+   * Retrieves the spo user by email.
+   * @param webUrl Web url
+   * @param email The email of the user
+   * @param logger the Logger object
+   * @param debug set if debug logging should be logged
+   */
+    getUserByEmail(webUrl, email, logger, debug) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (debug) {
+                logger.logToStderr(`Retrieving the spo user by email ${email}`);
+            }
+            const requestUrl = `${webUrl}/_api/web/siteusers/GetByEmail('${formatting_1.formatting.encodeQueryParameter(email)}')`;
+            const requestOptions = {
+                url: requestUrl,
+                headers: {
+                    'accept': 'application/json;odata=nometadata'
+                },
+                responseType: 'json'
+            };
+            const userInstance = yield request_1.default.get(requestOptions);
+            return userInstance;
+        });
+    },
     /**
      * Retrieves the menu state for the quick launch.
      * @param webUrl Web url
@@ -628,6 +653,55 @@ exports.spo = {
             };
             return request_1.default.post(requestOptions);
         });
+    },
+    /**
+  * Retrieves the spo group by name.
+  * @param webUrl Web url
+  * @param name The name of the group
+  * @param logger the Logger object
+  * @param debug set if debug logging should be logged
+  */
+    getGroupByName(webUrl, name, logger, debug) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (debug) {
+                logger.logToStderr(`Retrieving the group by name ${name}`);
+            }
+            const requestUrl = `${webUrl}/_api/web/sitegroups/GetByName('${formatting_1.formatting.encodeQueryParameter(name)}')`;
+            const requestOptions = {
+                url: requestUrl,
+                headers: {
+                    'accept': 'application/json;odata=nometadata'
+                },
+                responseType: 'json'
+            };
+            const groupInstance = yield request_1.default.get(requestOptions);
+            return groupInstance;
+        });
+    },
+    /**
+  * Retrieves the role definition by name.
+  * @param webUrl Web url
+  * @param name the name of the role definition
+  * @param logger the Logger object
+  * @param debug set if debug logging should be logged
+  */
+    getRoleDefinitionByName(webUrl, name, logger, debug) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (debug) {
+                logger.logToStderr(`Retrieving the role definitions for ${name}`);
+            }
+            const roledefinitions = yield odata_1.odata.getAllItems(`${webUrl}/_api/web/roledefinitions`);
+            const roledefinition = roledefinitions.find((role) => role.Name === name);
+            if (!roledefinition) {
+                throw `No roledefinition is found for ${name}`;
+            }
+            const permissions = new base_permissions_1.BasePermissions();
+            permissions.high = roledefinition.BasePermissions.High;
+            permissions.low = roledefinition.BasePermissions.Low;
+            roledefinition.BasePermissionsValue = permissions.parse();
+            roledefinition.RoleTypeKindValue = RoleType_1.RoleType[roledefinition.RoleTypeKind];
+            return roledefinition;
+        });
     }
 };
 //# sourceMappingURL=spo.js.map

package/docs/docs/_clisettings.mdx

@@ -0,0 +1,17 @@
+Setting name|Definition|Default value
+------------|----------|-------------
+`autoOpenLinksInBrowser`|Automatically open the browser for all commands which return a url and expect the user to copy paste this to the browser. For example when logging in, using `m365 login` in device code mode.|`false`
+`copyDeviceCodeToClipboard`|Automatically copy the device code to the clipboard when running `m365 login` command in device code mode|`false`
+`csvEscape`|Single character used for escaping; only apply to characters matching the quote and the escape options|`"`
+`csvHeader`|Display the column names on the first line|`true`
+`csvQuote`|The quote characters surrounding a field. An empty quote value will preserve the original field, whether it contains quotation marks or not.|` `
+`csvQuoted`|Quote all the non-empty fields even if not required|`false`
+`csvQuotedEmpty`|Quote empty strings and overrides quoted_string on empty strings when defined|`false`
+`disableTelemetry`|Disables sending of telemetry data|`false`
+`errorOutput`|Defines if errors should be written to `stdout` or `stderr`|`stderr`
+`helpMode`|Defines what part of command's help to display. Allowed values are `options`, `examples`, `remarks`, `response`, `full`|`full`
+`output`|Defines the default output when issuing a command. Allowed values are `json`, `text`, `csv`, `md`, `none`|`json`
+`printErrorsAsPlainText`|When output mode is set to `json`, print error messages as plain-text rather than JSON|`true`
+`prompt`|Prompts for missing values in required options and enables interactive selection when multiple values are available for a command that requires a specific value to be retrieved.|`false`
+`showHelpOnFailure`|Automatically display help when executing a command failed|`true`
+`showSpinner`|Display spinner when executing commands|`true`

package/docs/docs/cmd/_global.mdx

@@ -6,7 +6,7 @@
 : JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples.
 
 `-o, --output [output]`
-: Output type. `json`, `text`, `csv`, `md`. Default `json`.
+: Output type. `json`, `text`, `csv`, `md`, `none`. Default `json`.
 
 `--verbose`
 : Runs command with verbose logging.