@pnp/cli-microsoft365 6.0.0-beta.8352f49 → 6.0.0-beta.9d619b2

package/dist/m365/spo/commands/group/group-set.js

@@ -0,0 +1,167 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const AadUserGetCommand = require("../../../aad/commands/user/user-get");
+const cli_1 = require("../../../../cli");
+const utils_1 = require("../../../../utils");
+const request_1 = require("../../../../request");
+const SpoCommand_1 = require("../../../base/SpoCommand");
+const commands_1 = require("../../commands");
+class SpoGroupSetCommand extends SpoCommand_1.default {
+    get name() {
+        return commands_1.default.GROUP_SET;
+    }
+    get description() {
+        return 'Updates a group in the specified site';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.id = typeof args.options.id !== 'undefined';
+        telemetryProps.name = typeof args.options.name !== 'undefined';
+        telemetryProps.newName = typeof args.options.newName !== 'undefined';
+        telemetryProps.description = typeof args.options.description !== 'undefined';
+        telemetryProps.allowMembersEditMembership = typeof args.options.allowMembersEditMembership !== 'undefined';
+        telemetryProps.onlyAllowMembersViewMembership = typeof args.options.onlyAllowMembersViewMembership !== 'undefined';
+        telemetryProps.allowRequestToJoinLeave = typeof args.options.allowRequestToJoinLeave !== 'undefined';
+        telemetryProps.autoAcceptRequestToJoinLeave = typeof args.options.autoAcceptRequestToJoinLeave !== 'undefined';
+        telemetryProps.requestToJoinLeaveEmailSetting = typeof args.options.requestToJoinLeaveEmailSetting !== 'undefined';
+        telemetryProps.ownerEmail = typeof args.options.ownerEmail !== 'undefined';
+        telemetryProps.ownerUserName = typeof args.options.ownerUserName !== 'undefined';
+        return telemetryProps;
+    }
+    commandAction(logger, args, cb) {
+        const requestOptions = {
+            url: `${args.options.webUrl}/_api/web/sitegroups/${args.options.id ? `GetById(${args.options.id})` : `GetByName('${args.options.name}')`}`,
+            headers: {
+                accept: 'application/json;odata.metadata=none',
+                'content-type': 'application/json'
+            },
+            responseType: 'json',
+            data: {
+                Title: args.options.newName,
+                Description: args.options.description,
+                AllowMembersEditMembership: args.options.allowMembersEditMembership,
+                OnlyAllowMembersViewMembership: args.options.onlyAllowMembersViewMembership,
+                AllowRequestToJoinLeave: args.options.allowRequestToJoinLeave,
+                AutoAcceptRequestToJoinLeave: args.options.autoAcceptRequestToJoinLeave,
+                RequestToJoinLeaveEmailSetting: args.options.requestToJoinLeaveEmailSetting
+            }
+        };
+        request_1.default
+            .patch(requestOptions)
+            .then(() => this.setGroupOwner(args.options))
+            .then(_ => cb(), (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    setGroupOwner(options) {
+        if (!options.ownerEmail && !options.ownerUserName) {
+            return Promise.resolve();
+        }
+        return this
+            .getOwnerId(options)
+            .then((ownerId) => {
+            const requestOptions = {
+                url: `${options.webUrl}/_api/web/sitegroups/${options.id ? `GetById(${options.id})` : `GetByName('${options.name}')`}/SetUserAsOwner(${ownerId})`,
+                headers: {
+                    accept: 'application/json;odata.metadata=none',
+                    'content-type': 'application/json'
+                },
+                responseType: 'json'
+            };
+            return request_1.default.post(requestOptions);
+        });
+    }
+    getOwnerId(options) {
+        const cmdOptions = {
+            userName: options.ownerUserName,
+            email: options.ownerEmail,
+            output: 'json',
+            debug: options.debug,
+            verbose: options.verbose
+        };
+        return cli_1.Cli
+            .executeCommandWithOutput(AadUserGetCommand, { options: Object.assign(Object.assign({}, cmdOptions), { _: [] }) })
+            .then((output) => {
+            const getUserOutput = JSON.parse(output.stdout);
+            const requestOptions = {
+                url: `${options.webUrl}/_api/web/ensureUser('${getUserOutput.userPrincipalName}')?$select=Id`,
+                headers: {
+                    accept: 'application/json',
+                    'content-type': 'application/json'
+                },
+                responseType: 'json'
+            };
+            return request_1.default.post(requestOptions);
+        })
+            .then((response) => response.Id);
+    }
+    options() {
+        const options = [
+            {
+                option: '-u, --webUrl <webUrl>'
+            },
+            {
+                option: '-i, --id [id]'
+            },
+            {
+                option: '-n, --name [name]'
+            },
+            {
+                option: '--newName [newName]'
+            },
+            {
+                option: '--description [description]'
+            },
+            {
+                option: '--allowMembersEditMembership [allowMembersEditMembership]'
+            },
+            {
+                option: '--onlyAllowMembersViewMembership [onlyAllowMembersViewMembership]'
+            },
+            {
+                option: '--allowRequestToJoinLeave [allowRequestToJoinLeave]'
+            },
+            {
+                option: '--autoAcceptRequestToJoinLeave [autoAcceptRequestToJoinLeave]'
+            },
+            {
+                option: '--requestToJoinLeaveEmailSetting [requestToJoinLeaveEmailSetting]'
+            },
+            {
+                option: '--ownerEmail [ownerEmail]'
+            },
+            {
+                option: '--ownerUserName [ownerUserName]'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    optionSets() {
+        return [
+            ['id', 'name']
+        ];
+    }
+    validate(args) {
+        const isValidSharePointUrl = utils_1.validation.isValidSharePointUrl(args.options.webUrl);
+        if (isValidSharePointUrl !== true) {
+            return isValidSharePointUrl;
+        }
+        if (args.options.id && isNaN(args.options.id)) {
+            return `Specified id ${args.options.id} is not a number`;
+        }
+        if (args.options.ownerEmail && args.options.ownerUserName) {
+            return 'Specify either ownerEmail or ownerUserName but not both';
+        }
+        const booleanOptions = [
+            args.options.allowMembersEditMembership, args.options.onlyAllowMembersViewMembership,
+            args.options.allowRequestToJoinLeave, args.options.autoAcceptRequestToJoinLeave
+        ];
+        for (const option of booleanOptions) {
+            if (typeof option !== 'undefined' && !utils_1.validation.isValidBoolean(option)) {
+                return `Value '${option}' is not a valid boolean`;
+            }
+        }
+        return true;
+    }
+}
+module.exports = new SpoGroupSetCommand();
+//# sourceMappingURL=group-set.js.map

package/dist/m365/spo/commands/hubsite/hubsite-get.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const cli_1 = require("../../../../cli");
 const request_1 = require("../../../../request");
 const utils_1 = require("../../../../utils");
 const SpoCommand_1 = require("../../../base/SpoCommand");
 const commands_1 = require("../../commands");
+const SpoListItemListCommand = require("../listitem/listitem-list");
 class SpoHubSiteGetCommand extends SpoCommand_1.default {
     get name() {
         return commands_1.default.HUBSITE_GET;
@@ -11,37 +13,121 @@ class SpoHubSiteGetCommand extends SpoCommand_1.default {
     get description() {
         return 'Gets information about the specified hub site';
     }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.id = typeof args.options.id !== 'undefined';
+        telemetryProps.title = typeof args.options.title !== 'undefined';
+        telemetryProps.url = typeof args.options.url !== 'undefined';
+        telemetryProps.includeAssociatedSites = args.options.includeAssociatedSites === true;
+        return telemetryProps;
+    }
+    getAssociatedSites(spoAdminUrl, hubSiteId, logger, args) {
+        const options = {
+            output: 'json',
+            debug: args.options.debug,
+            verbose: args.options.verbose,
+            listTitle: 'DO_NOT_DELETE_SPLIST_TENANTADMIN_AGGREGATED_SITECOLLECTIONS',
+            webUrl: spoAdminUrl,
+            filter: `HubSiteId eq '${hubSiteId}'`,
+            fields: 'Title,SiteUrl,SiteId'
+        };
+        return cli_1.Cli
+            .executeCommandWithOutput(SpoListItemListCommand, { options: Object.assign(Object.assign({}, options), { _: [] }) });
+    }
     commandAction(logger, args, cb) {
+        let hubSite;
         utils_1.spo
             .getSpoUrl(logger, this.debug)
             .then((spoUrl) => {
-            const requestOptions = {
-                url: `${spoUrl}/_api/hubsites/getbyid('${encodeURIComponent(args.options.id)}')`,
-                headers: {
-                    accept: 'application/json;odata=nometadata'
-                },
-                responseType: 'json'
-            };
-            return request_1.default.get(requestOptions);
+            if (args.options.id) {
+                return this.getHubSiteById(spoUrl, args.options);
+            }
+            else {
+                return this.getHubSite(spoUrl, args.options);
+            }
         })
             .then((res) => {
-            logger.log(res);
+            hubSite = res;
+            if (args.options.includeAssociatedSites && (args.options.output && args.options.output !== 'json')) {
+                throw Error('includeAssociatedSites option is only allowed with json output mode');
+            }
+            if (args.options.includeAssociatedSites !== true || args.options.output && args.options.output !== 'json') {
+                return Promise.resolve();
+            }
+            return utils_1.spo
+                .getSpoAdminUrl(logger, this.debug)
+                .then((spoAdminUrl) => {
+                return this.getAssociatedSites(spoAdminUrl, hubSite.SiteId, logger, args);
+            });
+        })
+            .then((associatedSitesCommandOutput) => {
+            if (args.options.includeAssociatedSites) {
+                const associatedSites = JSON.parse(associatedSitesCommandOutput.stdout);
+                hubSite.AssociatedSites = associatedSites.filter(s => s.SiteId !== hubSite.SiteId);
+            }
+            logger.log(hubSite);
             cb();
         }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
     }
+    getHubSiteById(spoUrl, options) {
+        const requestOptions = {
+            url: `${spoUrl}/_api/hubsites/getbyid('${options.id}')`,
+            headers: {
+                accept: 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        return request_1.default.get(requestOptions);
+    }
+    getHubSite(spoUrl, options) {
+        const requestOptions = {
+            url: `${spoUrl}/_api/hubsites`,
+            headers: {
+                accept: 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        return request_1.default
+            .get(requestOptions)
+            .then((response) => {
+            let hubSites = response.value;
+            if (options.title) {
+                hubSites = hubSites.filter(site => site.Title.toLocaleLowerCase() === options.title.toLocaleLowerCase());
+            }
+            else if (options.url) {
+                hubSites = hubSites.filter(site => site.SiteUrl.toLocaleLowerCase() === options.url.toLocaleLowerCase());
+            }
+            if (hubSites.length === 0) {
+                return Promise.reject(`The specified hub site ${options.title || options.url} does not exist`);
+            }
+            if (hubSites.length > 1) {
+                return Promise.reject(`Multiple hub sites with ${options.title || options.url} found. Please disambiguate: ${hubSites.map(site => site.SiteUrl).join(', ')}`);
+            }
+            return hubSites[0];
+        });
+    }
     options() {
         const options = [
-            {
-                option: '-i, --id <id>'
-            }
+            { option: '-i, --id [id]' },
+            { option: '-t, --title [title]' },
+            { option: '-u, --url [url]' },
+            { option: '--includeAssociatedSites' }
         ];
         const parentOptions = super.options();
         return options.concat(parentOptions);
     }
+    optionSets() {
+        return [
+            ['id', 'title', 'url']
+        ];
+    }
     validate(args) {
-        if (!utils_1.validation.isValidGuid(args.options.id)) {
+        if (args.options.id && !utils_1.validation.isValidGuid(args.options.id)) {
             return `${args.options.id} is not a valid GUID`;
         }
+        if (args.options.url) {
+            return utils_1.validation.isValidSharePointUrl(args.options.url);
+        }
         return true;
     }
 }

package/dist/m365/spo/commands/list/list-list.js

@@ -14,18 +14,12 @@ class SpoListListCommand extends SpoCommand_1.default {
     defaultProperties() {
         return ['Title', 'Url', 'Id'];
     }
-    getTelemetryProperties(args) {
-        const telemetryProps = super.getTelemetryProperties(args);
-        telemetryProps.executeWithLimitedPermissions = !!args.options.executeWithLimitedPermissions;
-        return telemetryProps;
-    }
     commandAction(logger, args, cb) {
         if (this.verbose) {
             logger.logToStderr(`Retrieving all lists in site at ${args.options.webUrl}...`);
         }
-        const suffix = args.options.executeWithLimitedPermissions ? '&$select=RootFolder/ServerRelativeUrl,*' : '';
         const requestOptions = {
-            url: `${args.options.webUrl}/_api/web/lists?$expand=RootFolder${suffix}`,
+            url: `${args.options.webUrl}/_api/web/lists?$expand=RootFolder&$select=RootFolder/ServerRelativeUrl,*`,
             method: 'GET',
             headers: {
                 'accept': 'application/json;odata=nometadata'
@@ -46,9 +40,6 @@ class SpoListListCommand extends SpoCommand_1.default {
         const options = [
             {
                 option: '-u, --webUrl <webUrl>'
-            },
-            {
-                option: '--executeWithLimitedPermissions'
             }
         ];
         const parentOptions = super.options();

package/dist/m365/spo/commands/listitem/listitem-get.js

@@ -24,15 +24,15 @@ class SpoListItemGetCommand extends SpoCommand_1.default {
         const listIdArgument = args.options.listId || '';
         const listTitleArgument = args.options.listTitle || '';
         const listRestUrl = (args.options.listId ?
-            `${args.options.webUrl}/_api/web/lists(guid'${utils_1.formatting.encodeQueryParameter(listIdArgument)}')`
-            : `${args.options.webUrl}/_api/web/lists/getByTitle('${utils_1.formatting.encodeQueryParameter(listTitleArgument)}')`);
-        const propertiesSelect = args.options.properties ?
-            `?$select=${encodeURIComponent(args.options.properties)}` :
-            ((!args.options.output || args.options.output === 'text') ?
-                `?$select=Id,Title` :
-                ``);
+            `${args.options.webUrl}/_api/web/lists(guid'${utils_1.formatting.encodeQueryParameter(listIdArgument)}')` :
+            `${args.options.webUrl}/_api/web/lists/getByTitle('${utils_1.formatting.encodeQueryParameter(listTitleArgument)}')`);
+        const propertiesSelect = args.options.properties ? args.options.properties.split(',') : [];
+        const propertiesWithSlash = propertiesSelect.filter(item => item.includes('/'));
+        const propertiesToExpand = propertiesWithSlash.map(e => e.split('/')[0]);
+        const expandPropertiesArray = propertiesToExpand.filter((item, pos) => propertiesToExpand.indexOf(item) === pos);
+        const fieldExpand = expandPropertiesArray.length > 0 ? `&$expand=${expandPropertiesArray.join(",")}` : ``;
         const requestOptions = {
-            url: `${listRestUrl}/items(${args.options.id})${propertiesSelect}`,
+            url: `${listRestUrl}/items(${args.options.id})?$select=${encodeURIComponent(propertiesSelect.join(","))}${fieldExpand}`,
             headers: {
                 'accept': 'application/json;odata=nometadata'
             },
@@ -41,7 +41,7 @@ class SpoListItemGetCommand extends SpoCommand_1.default {
         request_1.default
             .get(requestOptions)
             .then((response) => {
-            delete response["ID"];
+            delete response['ID'];
             logger.log(response);
             cb();
         }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));

package/dist/m365/spo/commands/listitem/listitem-list.js

@@ -13,10 +13,8 @@ class SpoListItemListCommand extends SpoCommand_1.default {
     }
     getTelemetryProperties(args) {
         const telemetryProps = super.getTelemetryProperties(args);
-        telemetryProps.id = typeof args.options.id !== 'undefined';
         telemetryProps.listId = typeof args.options.listId !== 'undefined';
         telemetryProps.listTitle = typeof args.options.listTitle !== 'undefined';
-        telemetryProps.title = typeof args.options.title !== 'undefined';
         telemetryProps.fields = typeof args.options.fields !== 'undefined';
         telemetryProps.filter = typeof args.options.filter !== 'undefined';
         telemetryProps.pageNumber = typeof args.options.pageNumber !== 'undefined';
@@ -25,17 +23,14 @@ class SpoListItemListCommand extends SpoCommand_1.default {
         return telemetryProps;
     }
     commandAction(logger, args, cb) {
-        if (args.options.id) {
-            this.warn(logger, `Option 'id' is deprecated. Please use 'listId' instead.`);
-        }
-        if (args.options.title) {
-            this.warn(logger, `Option 'title' is deprecated. Please use 'listTitle' instead.`);
-        }
-        const listIdArgument = args.options.listId || args.options.id || '';
-        const listTitleArgument = args.options.listTitle || args.options.title || '';
+        const listIdArgument = args.options.listId || '';
+        const listTitleArgument = args.options.listTitle || '';
         let formDigestValue = '';
         const fieldsArray = args.options.fields ? args.options.fields.split(",")
             : (!args.options.output || args.options.output === "text") ? ["Title", "Id"] : [];
+        const fieldsWithSlash = fieldsArray.filter(item => item.includes('/'));
+        const fieldsToExpand = fieldsWithSlash.map(e => e.split('/')[0]);
+        const expandFieldsArray = fieldsToExpand.filter((item, pos) => fieldsToExpand.indexOf(item) === pos);
         const listRestUrl = listIdArgument ?
             `${args.options.webUrl}/_api/web/lists(guid'${utils_1.formatting.encodeQueryParameter(listIdArgument)}')`
             : `${args.options.webUrl}/_api/web/lists/getByTitle('${utils_1.formatting.encodeQueryParameter(listTitleArgument)}')`;
@@ -75,8 +70,9 @@ class SpoListItemListCommand extends SpoCommand_1.default {
             const skipToken = (args.options.pageNumber && Number(args.options.pageNumber) > 0 && skipTokenId > 0) ? `$skiptoken=Paged=TRUE%26p_ID=${res.value[res.value.length - 1].Id}` : ``;
             const rowLimit = args.options.pageSize ? `$top=${args.options.pageSize}` : ``;
             const filter = args.options.filter ? `$filter=${encodeURIComponent(args.options.filter)}` : ``;
+            const fieldExpand = expandFieldsArray.length > 0 ? `&$expand=${expandFieldsArray.join(",")}` : ``;
             const fieldSelect = fieldsArray.length > 0 ?
-                `?$select=${encodeURIComponent(fieldsArray.join(","))}&${rowLimit}&${skipToken}&${filter}` :
+                `?$select=${encodeURIComponent(fieldsArray.join(","))}${fieldExpand}&${rowLimit}&${skipToken}&${filter}` :
                 `?${rowLimit}&${skipToken}&${filter}`;
             const requestBody = args.options.camlQuery ?
                 {
@@ -107,12 +103,6 @@ class SpoListItemListCommand extends SpoCommand_1.default {
             {
                 option: '-u, --webUrl <webUrl>'
             },
-            {
-                option: '--id [id]'
-            },
-            {
-                option: '--title [title]'
-            },
             {
                 option: '-i, --listId [listId]'
             },
@@ -157,14 +147,10 @@ class SpoListItemListCommand extends SpoCommand_1.default {
         if (isValidSharePointUrl !== true) {
             return isValidSharePointUrl;
         }
-        if (!args.options.id && !args.options.title && !args.options.listId && !args.options.listTitle) {
+        if (!args.options.listId && !args.options.listTitle) {
             return `Specify listId or listTitle`;
         }
-        if (args.options.id && args.options.title) {
-            return `Specify list id or title but not both`;
-        }
-        // Check if only one of the 4 options is specified
-        if ([args.options.id, args.options.title, args.options.listId, args.options.listTitle].filter(o => o).length > 1) {
+        if (args.options.listId && args.options.listTitle) {
             return 'Specify listId or listTitle but not both';
         }
         if (args.options.camlQuery && args.options.fields) {
@@ -188,9 +174,6 @@ class SpoListItemListCommand extends SpoCommand_1.default {
         if (args.options.listId && !utils_1.validation.isValidGuid(args.options.listId)) {
             return `${args.options.listId} is not a valid GUID`;
         }
-        if (args.options.id && !utils_1.validation.isValidGuid(args.options.id)) {
-            return `${args.options.id} in option id is not a valid GUID`;
-        }
         return true;
     }
 }

package/dist/m365/spo/commands/roledefinition/RoleDefinition.js

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

package/dist/m365/spo/commands/roledefinition/RoleType.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RoleType = void 0;
+var RoleType;
+(function (RoleType) {
+    RoleType[RoleType["None"] = 0] = "None";
+    RoleType[RoleType["Guest"] = 1] = "Guest";
+    RoleType[RoleType["Reader"] = 2] = "Reader";
+    RoleType[RoleType["Contributor"] = 3] = "Contributor";
+    RoleType[RoleType["WebDesigner"] = 4] = "WebDesigner";
+    RoleType[RoleType["Administrator"] = 5] = "Administrator";
+    RoleType[RoleType["Editor"] = 6] = "Editor";
+    RoleType[RoleType["Reviewer"] = 7] = "Reviewer";
+    RoleType[RoleType["System"] = 8] = "System";
+})(RoleType = exports.RoleType || (exports.RoleType = {}));
+//# sourceMappingURL=RoleType.js.map

package/dist/m365/spo/commands/roledefinition/roledefinition-get.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const utils_1 = require("../../../../utils");
+const SpoCommand_1 = require("../../../base/SpoCommand");
+const base_permissions_1 = require("../../base-permissions");
+const commands_1 = require("../../commands");
+const RoleType_1 = require("./RoleType");
+class SpoRoleDefinitionGetCommand extends SpoCommand_1.default {
+    get name() {
+        return commands_1.default.ROLEDEFINITION_GET;
+    }
+    get description() {
+        return 'Gets specified role definition from web by id';
+    }
+    commandAction(logger, args, cb) {
+        if (this.verbose) {
+            logger.logToStderr(`Getting role definition from ${args.options.webUrl}...`);
+        }
+        const requestOptions = {
+            url: `${args.options.webUrl}/_api/web/roledefinitions(${args.options.id})`,
+            headers: {
+                'accept': 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        request_1.default
+            .get(requestOptions)
+            .then((response) => {
+            const permissions = new base_permissions_1.BasePermissions();
+            permissions.high = response.BasePermissions.High;
+            permissions.low = response.BasePermissions.Low;
+            response.BasePermissionsValue = permissions.parse();
+            response.RoleTypeKindValue = RoleType_1.RoleType[response.RoleTypeKind];
+            logger.log(response);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    options() {
+        const options = [
+            {
+                option: '-u, --webUrl <webUrl>'
+            },
+            {
+                option: '-i, --id <id>'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        if (isNaN(args.options.id)) {
+            return `${args.options.id} is not a number`;
+        }
+        return utils_1.validation.isValidSharePointUrl(args.options.webUrl);
+    }
+}
+module.exports = new SpoRoleDefinitionGetCommand();
+//# sourceMappingURL=roledefinition-get.js.map