Add listMachineFragments (#394)

src/app/app-client.spec.ts

@@ -1256,6 +1256,35 @@ describe('AppClient tests', () => {
     });
   });
 
+  describe('listMachineFragment tests', () => {
+    let request: pb.ListMachineFragmentsRequest;
+    const response = [fragment];
+    beforeEach(() => {
+      mockTransport = createRouterTransport(({ service }) => {
+        service(AppService, {
+          listMachineFragments: (req) => {
+            request = req;
+            return new pb.ListMachineFragmentsResponse({
+              fragments: response,
+            });
+          },
+        });
+      });
+    });
+
+    it('listMachineFragments', async () => {
+      const machineId = 'MACHINE_ID';
+      const additionalFragmentIds = ['FRAGMENT ID 1', 'FRAGMENT ID 2'];
+      const resp = await subject().listMachineFragments(
+        machineId,
+        additionalFragmentIds
+      );
+      expect(request.machineId).toEqual(machineId);
+      expect(request.additionalFragmentIds).toEqual(additionalFragmentIds);
+      expect(resp).toEqual(response);
+    });
+  });
+
   describe('addRole tests', () => {
     const expectedRequest = new pb.AddRoleRequest({
       authorization,

src/app/app-client.ts

@@ -1,9 +1,5 @@
 import type { Struct } from '@bufbuild/protobuf';
-import {
-  createPromiseClient,
-  type PromiseClient,
-  type Transport,
-} from '@connectrpc/connect';
+import { createClient, type Client, type Transport } from '@connectrpc/connect';
 import { PackageType } from '../gen/app/packages/v1/packages_pb';
 import { AppService } from '../gen/app/v1/app_connect';
 import {
@@ -114,10 +110,10 @@ export const createPermission = (
 };
 
 export class AppClient {
-  private client: PromiseClient<typeof AppService>;
+  private client: Client<typeof AppService>;
 
   constructor(transport: Transport) {
-    this.client = createPromiseClient(AppService, transport);
+    this.client = createClient(AppService, transport);
   }
 
   /**
@@ -827,6 +823,27 @@ export class AppClient {
     await this.client.deleteFragment({ id });
   }
 
+  /**
+   * @param machineId The machine ID used to filter fragments defined in a
+   *   machine's parts. Also returns any fragments nested within the fragments
+   *   defined in parts.
+   * @param additionalFragmentIds Additional fragment IDs to append to the
+   *   response. Useful when needing to view fragments that will be
+   *   provisionally added to the machine alongside existing fragments.
+   * @returns The list of top level and nested fragments for a machine, as well
+   *   as additionally specified fragment IDs.
+   */
+  async listMachineFragments(
+    machineId: string,
+    additionalFragmentIds?: string[]
+  ): Promise<Fragment[]> {
+    const resp = await this.client.listMachineFragments({
+      machineId,
+      additionalFragmentIds,
+    });
+    return resp.fragments;
+  }
+
   /**
    * Add a role under an organization.
    *