[APP-8687] Add ListMachineSummaries (#580)

Co-authored-by: Naveed Jooma <[email protected]>

Author: JosephBorodach

src/app/app-client.spec.ts

@@ -1105,6 +1105,47 @@ describe('AppClient tests', () => {
     });
   });
 
+  describe('listMachineSummaries tests', () => {
+    const locSummary1 = new pb.LocationSummary({});
+    const locSummary2 = new pb.LocationSummary({});
+    const locationSummaries = [locSummary1, locSummary2];
+    let capturedReq: pb.ListMachineSummariesRequest | undefined;
+
+    beforeEach(() => {
+      mockTransport = createRouterTransport(({ service }) => {
+        service(AppService, {
+          listMachineSummaries: (req: pb.ListMachineSummariesRequest) => {
+            capturedReq = req;
+            return new pb.ListMachineSummariesResponse({ locationSummaries });
+          },
+        });
+      });
+    });
+
+    it('returns location summaries with only organizationId', async () => {
+      const response = await subject().listMachineSummaries('orgId');
+      expect(response).toEqual(locationSummaries);
+      expect(capturedReq?.organizationId).toEqual('orgId');
+      expect(capturedReq?.fragmentIds).toEqual([]);
+      expect(capturedReq?.locationIds).toEqual([]);
+      expect(capturedReq?.limit).toBeUndefined();
+    });
+
+    it('returns location summaries with all filters', async () => {
+      const response = await subject().listMachineSummaries(
+        'orgId',
+        ['frag1', 'frag2'],
+        ['loc1'],
+        5
+      );
+      expect(response).toEqual(locationSummaries);
+      expect(capturedReq?.organizationId).toEqual('orgId');
+      expect(capturedReq?.fragmentIds).toEqual(['frag1', 'frag2']);
+      expect(capturedReq?.locationIds).toEqual(['loc1']);
+      expect(capturedReq?.limit).toEqual(5);
+    });
+  });
+
   describe('newRobot tests', () => {
     beforeEach(() => {
       mockTransport = createRouterTransport(({ service }) => {

src/app/app-client.ts

@@ -34,6 +34,8 @@ import {
   RotateKeyResponse,
   RoverRentalRobot,
   Visibility,
+  ListMachineSummariesRequest,
+  LocationSummary,
 } from '../gen/app/v1/app_pb';
 import type { LogEntry } from '../gen/common/v1/common_pb';
 
@@ -2240,4 +2242,41 @@ export class AppClient {
   ): Promise<GetAppBrandingResponse> {
     return this.client.getAppBranding({ publicNamespace, name });
   }
+
+  /**
+   * Lists machine summaries for an organization, optionally filtered by
+   * fragment IDs, location IDs, and limit.
+   *
+   * @example
+   *
+   * ```ts
+   * const summaries = await appClient.listMachineSummaries(
+   *   'orgId',
+   *   ['frag1'],
+   *   ['loc1'],
+   *   10
+   * );
+   * ```
+   *
+   * @param organizationId The ID of the organization
+   * @param fragmentIds Optional list of fragment IDs to filter machines
+   * @param locationIds Optional list of location IDs to filter machines
+   * @param limit Optional max number of machines to return
+   * @returns The list of location summaries
+   */
+  async listMachineSummaries(
+    organizationId: string,
+    fragmentIds?: string[],
+    locationIds?: string[],
+    limit?: number
+  ): Promise<LocationSummary[]> {
+    const req: ListMachineSummariesRequest = new ListMachineSummariesRequest({
+      organizationId,
+      fragmentIds,
+      locationIds,
+      limit,
+    });
+    const resp = await this.client.listMachineSummaries(req);
+    return resp.locationSummaries;
+  }
 }