Adds 'm365 spo homesite list'. Closes #6091

docs/docs/cmd/spo/homesite/homesite-list.mdx

@@ -0,0 +1,104 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo homesite list
+
+Lists all home sites
+
+## Usage
+
+```sh
+m365 spo homesite list [options]
+```
+
+## Options
+
+<Global />
+
+## Examples
+
+List all the home sites
+
+```sh
+m365 spo homesite list
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "value": [
+      {
+        "Audiences": [
+          {
+            "Email": "[email protected]",
+            "Id": "978b5280-4f80-47ea-a1db-b0d1d2fb1ba4",
+            "Title": "ColumnSearchable Members"
+          },
+          {
+            "Email": "[email protected]",
+            "Id": "21af775d-17b3-4637-94a4-2ba8625277cb",
+            "Title": "Contoso TeamR Members"
+          }
+        ],
+        "IsInDraftMode": false,
+        "IsVivaBackendSite": false,
+        "SiteId": "431d7819-4aaf-49a1-b664-b2fe9e609b63",
+        "TargetedLicenseType": 2,
+        "Title": "The Landing",
+        "Url": "https://contoso.sharepoint.com/sites/TheLanding",
+        "VivaConnectionsDefaultStart": true,
+        "WebId": "626c1724-8ac8-45d5-af87-c07c752fab75"
+      }
+    ]
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+Url                                                              Title              
+---------------------------------------------------------------  -------------------
+https://contoso.sharepoint.com/sites/TheLanding           The Landing        
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  IsInDraftMode,IsVivaBackendSite,SiteId,TargetedLicenseType,Title,Url,VivaConnectionsDefaultStart,WebId
+0,0,431d7819-4aaf-49a1-b664-b2fe9e609b63,2,The Landing,https://contoso.sharepoint.com/sites/TheLanding,1,626c1724-8ac8-45d5-af87-c07c752fab75
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  m365 spo homesite list --output md      
+# spo homesite list 
+
+Date: 11/18/2024
+
+Property | Value
+---------|-------
+IsInDraftMode | false
+IsVivaBackendSite | false
+SiteId | 431d7819-4aaf-49a1-b664-b2fe9e609b63
+TargetedLicenseType | 2
+Title | The Landing
+Url | https://contoso.sharepoint.com/sites/TheLanding
+VivaConnectionsDefaultStart | true
+WebId | 626c1724-8ac8-45d5-af87-c07c752fab75
+```
+
+  </TabItem>
+</Tabs>
+
+## More information
+
+- SharePoint home sites [Viva Connections set up](https://learn.microsoft.com/en-us/viva/connections/set-up-admin-center)

docs/src/config/sidebars.ts

@@ -2710,6 +2710,11 @@ const sidebars: SidebarsConfig = {
               label: 'homesite get',
               id: 'cmd/spo/homesite/homesite-get'
             },
+            {
+              type: 'doc',
+              label: 'homesite list',
+              id: 'cmd/spo/homesite/homesite-list'
+            },
             {
               type: 'doc',
               label: 'homesite remove',

src/m365/spo/commands.ts

@@ -118,6 +118,7 @@ export default {
   HIDEDEFAULTTHEMES_GET: `${prefix} hidedefaultthemes get`,
   HIDEDEFAULTTHEMES_SET: `${prefix} hidedefaultthemes set`,
   HOMESITE_GET: `${prefix} homesite get`,
+  HOMESITE_LIST: `${prefix} homesite list`,
   HOMESITE_REMOVE: `${prefix} homesite remove`,
   HOMESITE_SET: `${prefix} homesite set`,
   HUBSITE_CONNECT: `${prefix} hubsite connect`,

src/m365/spo/commands/homesite/homesite-list.spec.ts

@@ -0,0 +1,123 @@
+import assert from 'assert';
+import sinon from 'sinon';
+import auth from '../../../../Auth.js';
+import { Logger } from '../../../../cli/Logger.js';
+import { CommandError } from '../../../../Command.js';
+import request from '../../../../request.js';
+import { telemetry } from '../../../../telemetry.js';
+import { pid } from '../../../../utils/pid.js';
+import { session } from '../../../../utils/session.js';
+import { sinonUtil } from '../../../../utils/sinonUtil.js';
+import commands from '../../commands.js';
+import command from './homesite-list.js';
+
+describe(commands.HOMESITE_LIST, () => {
+  let log: string[];
+  let logger: Logger;
+  let loggerLogSpy: sinon.SinonSpy;
+  const homeSites = {
+    "value": [
+      {
+        "Audiences": [
+          {
+            "Email": "[email protected]",
+            "Id": "978b5280-4f80-47ea-a1db-b0d1d2fb1ba4",
+            "Title": "ColumnSearchable Members"
+          },
+          {
+            "Email": "[email protected]",
+            "Id": "21af775d-17b3-4637-94a4-2ba8625277cb",
+            "Title": "Contoso TeamR Members"
+          }
+        ],
+        "IsInDraftMode": false,
+        "IsVivaBackendSite": false,
+        "SiteId": "431d7819-4aaf-49a1-b664-b2fe9e609b63",
+        "TargetedLicenseType": 2,
+        "Title": "The Landing",
+        "Url": "https://contoso.sharepoint.com/sites/TheLanding",
+        "VivaConnectionsDefaultStart": true,
+        "WebId": "626c1724-8ac8-45d5-af87-c07c752fab75"
+      },
+      {
+        "Audiences": [],
+        "IsInDraftMode": false,
+        "IsVivaBackendSite": false,
+        "SiteId": "45d4a135-40e4-4571-8340-61d17fdfd58a",
+        "TargetedLicenseType": 0,
+        "Title": "Contoso Electronics",
+        "Url": "https://contoso.sharepoint.com/sites/contosoportal",
+        "VivaConnectionsDefaultStart": true,
+        "WebId": "9418e2a1-855c-4752-8dd4-48693f43b10a"
+      }
+    ]
+  };
+
+  before(() => {
+    sinon.stub(auth, 'restoreAuth').resolves();
+    sinon.stub(telemetry, 'trackEvent').returns();
+    sinon.stub(pid, 'getProcessName').returns('');
+    sinon.stub(session, 'getId').returns('');
+    auth.connection.active = true;
+    auth.connection.spoUrl = 'https://contoso.sharepoint.com';
+  });
+
+  beforeEach(() => {
+    log = [];
+    logger = {
+      log: async (msg: string) => {
+        log.push(msg);
+      },
+      logRaw: async (msg: string) => {
+        log.push(msg);
+      },
+      logToStderr: async (msg: string) => {
+        log.push(msg);
+      }
+    };
+    loggerLogSpy = sinon.spy(logger, 'log');
+  });
+
+  afterEach(() => {
+    sinonUtil.restore([
+      request.get
+    ]);
+  });
+
+  after(() => {
+    sinon.restore();
+    auth.connection.active = false;
+    auth.connection.spoUrl = undefined;
+  });
+
+  it('has correct name', () => {
+    assert.strictEqual(command.name, commands.HOMESITE_LIST);
+  });
+
+  it('has a description', () => {
+    assert.notStrictEqual(command.description, null);
+  });
+
+  it('defines correct properties for the default output', () => {
+    assert.deepStrictEqual(command.defaultProperties(), ['Url', 'Title']);
+  });
+
+  it('lists available home sites (debug)', async () => {
+    sinon.stub(request, 'get').callsFake(async (opts) => {
+      if (opts.url === `https://contoso-admin.sharepoint.com/_api/SPO.Tenant/GetTargetedSitesDetails`) {
+        return homeSites;
+      }
+
+      throw opts.url;
+    });
+
+    await command.action(logger, { options: { debug: true, output: 'json' } });
+    assert(loggerLogSpy.calledWith(homeSites.value));
+  });
+
+  it('correctly handles OData error when retrieving available home sites', async () => {
+    sinon.stub(request, 'get').rejects({ error: { 'odata.error': { message: { value: 'An error has occurred' } } } });
+
+    await assert.rejects(command.action(logger, { options: {} } as any), new CommandError('An error has occurred'));
+  });
+});

src/m365/spo/commands/homesite/homesite-list.ts

@@ -0,0 +1,38 @@
+import { Logger } from '../../../../cli/Logger.js';
+import { odata } from '../../../../utils/odata.js';
+import { spo } from '../../../../utils/spo.js';
+import SpoCommand from '../../../base/SpoCommand.js';
+import commands from '../../commands.js';
+class SpoHomeSiteListCommand extends SpoCommand {
+  public get name(): string {
+    return commands.HOMESITE_LIST;
+  }
+
+  public get description(): string {
+    return 'Lists all home sites';
+  }
+
+  public defaultProperties(): string[] | undefined {
+    return ['Url', 'Title'];
+  }
+
+  public async commandAction(logger: Logger): Promise<void> {
+    try {
+      const spoAdminUrl: string = await spo.getSpoAdminUrl(logger, this.debug);
+      const requestOptions: any = {
+        url: `${spoAdminUrl}/_api/SPO.Tenant/GetTargetedSitesDetails`,
+        headers: {
+          accept: 'application/json;odata=nometadata'
+        },
+        responseType: 'json'
+      };
+      const res = await odata.getAllItems(requestOptions);
+      await logger.log(res);
+    }
+    catch (err: any) {
+      this.handleRejectedODataJsonPromise(err);
+    }
+  }
+}
+
+export default new SpoHomeSiteListCommand();