@pnp/cli-microsoft365 5.5.0-beta.f0f7ad7 → 5.6.0-beta.18a47a8

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;
@@ -16,9 +18,24 @@ class SpoHubSiteGetCommand extends SpoCommand_1.default {
         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) => {
@@ -30,7 +47,25 @@ class SpoHubSiteGetCommand extends SpoCommand_1.default {
             }
         })
             .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));
     }
@@ -75,7 +110,8 @@ class SpoHubSiteGetCommand extends SpoCommand_1.default {
         const options = [
             { option: '-i, --id [id]' },
             { option: '-t, --title [title]' },
-            { option: '-u, --url [url]' }
+            { option: '-u, --url [url]' },
+            { option: '--includeAssociatedSites' }
         ];
         const parentOptions = super.options();
         return options.concat(parentOptions);

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

@@ -23,6 +23,7 @@ class SpoSiteClassicListCommand extends SpoCommand_1.default {
         return ['Title', 'Url'];
     }
     commandAction(logger, args, cb) {
+        this.showDeprecationWarning(logger, commands_1.default.SITE_CLASSIC_LIST, commands_1.default.SITE_LIST);
         const webTemplate = args.options.webTemplate || '';
         const includeOneDriveSites = args.options.includeOneDriveSites || false;
         const personalSite = includeOneDriveSites === false ? '0' : '1';

package/dist/m365/spo/commands/site/site-classic-set.js

@@ -29,6 +29,7 @@ class SpoSiteClassicSetCommand extends SpoCommand_1.default {
         return telemetryProps;
     }
     commandAction(logger, args, cb) {
+        this.showDeprecationWarning(logger, commands_1.default.SITE_CLASSIC_SET, commands_1.default.SITE_SET);
         this.dots = '';
         utils_1.spo
             .getTenantId(logger, this.debug)

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

@@ -10,22 +10,25 @@ class SpoSiteListCommand extends SpoCommand_1.default {
         return commands_1.default.SITE_LIST;
     }
     get description() {
-        return 'Lists modern sites of the given type';
+        return 'Lists sites of the given type';
     }
     getTelemetryProperties(args) {
         const telemetryProps = super.getTelemetryProperties(args);
-        telemetryProps.siteType = args.options.type || 'TeamSite';
+        telemetryProps.webTemplate = args.options.webTemplate;
         telemetryProps.filter = (!(!args.options.filter)).toString();
-        telemetryProps.deleted = args.options.deleted;
+        telemetryProps.includeOneDriveSites = typeof args.options.includeOneDriveSites !== 'undefined';
+        telemetryProps.deleted = typeof args.options.deleted !== 'undefined';
+        telemetryProps.siteType = args.options.type || 'TeamSite';
         return telemetryProps;
     }
     defaultProperties() {
         return ['Title', 'Url'];
     }
     commandAction(logger, args, cb) {
-        const siteType = args.options.type || 'TeamSite';
-        const webTemplate = siteType === 'TeamSite' ? 'GROUP#0' : 'SITEPAGEPUBLISHING#0';
-        let spoAdminUrl;
+        const webTemplate = this.getWebTemplateId(args.options);
+        const includeOneDriveSites = args.options.includeOneDriveSites || false;
+        const personalSite = includeOneDriveSites === false ? '0' : '1';
+        let spoAdminUrl = '';
         utils_1.spo
             .getSpoAdminUrl(logger, this.debug)
             .then((_spoAdminUrl) => {
@@ -34,19 +37,19 @@ class SpoSiteListCommand extends SpoCommand_1.default {
                 logger.logToStderr(`Retrieving list of site collections...`);
             }
             this.allSites = [];
-            return this.getAllSites(spoAdminUrl, utils_1.formatting.escapeXml(args.options.filter || ''), '0', webTemplate, undefined, args.options.deleted, logger);
+            return this.getAllSites(spoAdminUrl, utils_1.formatting.escapeXml(args.options.filter || ''), '0', personalSite, webTemplate, undefined, args.options.deleted, logger);
         })
             .then(_ => {
             logger.log(this.allSites);
             cb();
         }, (err) => this.handleRejectedPromise(err, logger, cb));
     }
-    getAllSites(spoAdminUrl, filter, startIndex, webTemplate, formDigest, deleted, logger) {
+    getAllSites(spoAdminUrl, filter, startIndex, personalSite, webTemplate, formDigest, deleted, logger) {
         return new Promise((resolve, reject) => {
             utils_1.spo
                 .ensureFormDigest(spoAdminUrl, logger, formDigest, this.debug)
                 .then((res) => {
-                let requestBody = `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config_1.default.applicationName}" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009"><Actions><ObjectPath Id="2" ObjectPathId="1" /><ObjectPath Id="4" ObjectPathId="3" /><Query Id="5" ObjectPathId="3"><Query SelectAllProperties="true"><Properties /></Query><ChildItemQuery SelectAllProperties="true"><Properties /></ChildItemQuery></Query></Actions><ObjectPaths><Constructor Id="1" TypeId="{268004ae-ef6b-4e9b-8425-127220d84719}" /><Method Id="3" ParentId="1" Name="GetSitePropertiesFromSharePointByFilters"><Parameters><Parameter TypeId="{b92aeee2-c92c-4b67-abcc-024e471bc140}"><Property Name="Filter" Type="String">${filter}</Property><Property Name="IncludeDetail" Type="Boolean">false</Property><Property Name="IncludePersonalSite" Type="Enum">0</Property><Property Name="StartIndex" Type="String">${startIndex}</Property><Property Name="Template" Type="String">${webTemplate}</Property></Parameter></Parameters></Method></ObjectPaths></Request>`;
+                let requestBody = `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config_1.default.applicationName}" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009"><Actions><ObjectPath Id="2" ObjectPathId="1" /><ObjectPath Id="4" ObjectPathId="3" /><Query Id="5" ObjectPathId="3"><Query SelectAllProperties="true"><Properties /></Query><ChildItemQuery SelectAllProperties="true"><Properties /></ChildItemQuery></Query></Actions><ObjectPaths><Constructor Id="1" TypeId="{268004ae-ef6b-4e9b-8425-127220d84719}" /><Method Id="3" ParentId="1" Name="GetSitePropertiesFromSharePointByFilters"><Parameters><Parameter TypeId="{b92aeee2-c92c-4b67-abcc-024e471bc140}"><Property Name="Filter" Type="String">${filter}</Property><Property Name="IncludeDetail" Type="Boolean">false</Property><Property Name="IncludePersonalSite" Type="Enum">${personalSite}</Property><Property Name="StartIndex" Type="String">${startIndex}</Property><Property Name="Template" Type="String">${webTemplate}</Property></Parameter></Parameters></Method></ObjectPaths></Request>`;
                 if (deleted) {
                     requestBody = `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config_1.default.applicationName}" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009"><Actions><ObjectPath Id="4" ObjectPathId="3" /><ObjectPath Id="6" ObjectPathId="5" /><Query Id="7" ObjectPathId="5"><Query SelectAllProperties="true"><Properties><Property Name="NextStartIndexFromSharePoint" ScalarProperty="true" /></Properties></Query><ChildItemQuery SelectAllProperties="true"><Properties /></ChildItemQuery></Query></Actions><ObjectPaths><Constructor Id="3" TypeId="{268004ae-ef6b-4e9b-8425-127220d84719}" /><Method Id="5" ParentId="3" Name="GetDeletedSitePropertiesFromSharePoint"><Parameters><Parameter Type="String">${startIndex}</Parameter></Parameters></Method></ObjectPaths></Request>`;
                 }
@@ -71,7 +74,7 @@ class SpoSiteListCommand extends SpoCommand_1.default {
                     this.allSites.push(...sites._Child_Items_);
                     if (sites.NextStartIndexFromSharePoint) {
                         this
-                            .getAllSites(spoAdminUrl, filter, sites.NextStartIndexFromSharePoint, webTemplate, formDigest, deleted, logger)
+                            .getAllSites(spoAdminUrl, filter, sites.NextStartIndexFromSharePoint, personalSite, webTemplate, formDigest, deleted, logger)
                             .then(_ => resolve(), err => reject(err));
                     }
                     else {
@@ -81,15 +84,48 @@ class SpoSiteListCommand extends SpoCommand_1.default {
             }, err => reject(err));
         });
     }
+    /*
+      The type property currently defaults to Teamsite.
+      It makes more sense to default to All. Certainly after adding the 'includeOneDriveSites' option.
+      Changing this will be a breaking change. We'll remove the default the next major version.
+    */
+    getWebTemplateId(options) {
+        if (options.webTemplate) {
+            return options.webTemplate;
+        }
+        if (options.includeOneDriveSites) {
+            return '';
+        }
+        let siteType = options.type;
+        if (!siteType) {
+            siteType = 'TeamSite';
+        }
+        switch (siteType) {
+            case "TeamSite":
+                return 'GROUP#0';
+            case "CommunicationSite":
+                return 'SITEPAGEPUBLISHING#0';
+            default:
+                return '';
+        }
+    }
     options() {
         const options = [
             {
-                option: '--type [type]',
-                autocomplete: ['TeamSite', 'CommunicationSite']
+                option: '-t, --type [type]',
+                // To not introduce a breaking change, 'All' has been added.
+                // You should use all when using '--includeOneDriveSites'
+                autocomplete: ['TeamSite', 'CommunicationSite', 'All']
+            },
+            {
+                option: '--webTemplate [webTemplate]'
             },
             {
                 option: '-f, --filter [filter]'
             },
+            {
+                option: '--includeOneDriveSites'
+            },
             {
                 option: '--deleted'
             }
@@ -98,11 +134,17 @@ class SpoSiteListCommand extends SpoCommand_1.default {
         return options.concat(parentOptions);
     }
     validate(args) {
-        if (args.options.type) {
-            if (args.options.type !== 'TeamSite' &&
-                args.options.type !== 'CommunicationSite') {
-                return `${args.options.type} is not a valid modern site type. Allowed types are TeamSite and CommunicationSite`;
-            }
+        if (args.options.type && args.options.webTemplate) {
+            return 'Specify either type or webTemplate, but not both';
+        }
+        const typeValues = ['TeamSite', 'CommunicationSite', 'All'];
+        if (args.options.type &&
+            typeValues.indexOf(args.options.type) < 0) {
+            return `${args.options.type} is not a valid value for the type option. Allowed values are ${typeValues.join('|')}`;
+        }
+        if (args.options.includeOneDriveSites
+            && (!args.options.type || args.options.type !== 'All')) {
+            return 'When using includeOneDriveSites, specify All as value for type';
         }
         return true;
     }