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

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;
     }