add customer list function

Author: xavpaice

README.md

@@ -3,3 +3,58 @@
 This is a library for interacting with the Replicated Vendor Portal API using TypeScript.
 
 Source code: [Github](https://github.com/replicatedhq/replicated-lib)
+
+## Testing Locally
+
+### Prerequisites
+
+- Node.js >= 20.0.0
+- npm
+
+### Running Tests
+
+1. **Install dependencies:**
+   ```bash
+   npm install
+   ```
+   Or using Make:
+   ```bash
+   make deps
+   ```
+
+2. **Run all tests:**
+   ```bash
+   npm test
+   ```
+   Or using Make:
+   ```bash
+   make test
+   ```
+   
+   This will:
+   - Build the TypeScript source code
+   - Run all test suites with coverage reporting
+   - Display verbose output for each test
+
+3. **Run tests without building first:**
+   ```bash
+   npx jest --coverage --verbose --setupFiles ./pacts/configuration.ts
+   ```
+
+### Test Structure
+
+- Test files are located alongside source files with `.spec.ts` extension (e.g., `src/customers.spec.ts`)
+- Tests use `mockttp` for HTTP request mocking
+- Some tests use Pact for contract testing (configured in `pacts/configuration.ts`)
+
+### Running Specific Tests
+
+To run a specific test file:
+```bash
+npx jest src/customers.spec.ts
+```
+
+To run tests matching a pattern:
+```bash
+npx jest --testNamePattern="List Customers"
+```

src/customers.ts

@@ -12,6 +12,11 @@ export class Customer {
   license: string;
 }
 
+export class CustomerSummary {
+  name: string;
+  customerId: string;
+}
+
 interface entitlementValue {
   name: string;
   value: string;
@@ -113,6 +118,44 @@ export async function archiveCustomer(vendorPortalApi: VendorPortalApi, customer
   }
 }
 
+export async function listCustomersByName(vendorPortalApi: VendorPortalApi, appSlug: string, customerName: string): Promise<CustomerSummary[]> {
+  const http = await vendorPortalApi.client();
+
+  // 1. get the app
+  const app = await getApplicationDetails(vendorPortalApi, appSlug);
+
+  // 2. list customers filtered by name
+  const listCustomersUri = `${vendorPortalApi.endpoint}/app/${app.id}/customers?name=${encodeURIComponent(customerName)}`;
+  const listCustomersRes = await http.get(listCustomersUri);
+  if (listCustomersRes.message.statusCode != 200) {
+    let body = "";
+    try {
+      body = await listCustomersRes.readBody();
+    } catch (err) {
+      // ignore
+    }
+    throw new Error(`Failed to list customers: Server responded with ${listCustomersRes.message.statusCode}: ${body}`);
+  }
+  const listCustomersBody: any = JSON.parse(await listCustomersRes.readBody());
+
+  // 3. Convert response body into CustomerSummary array
+  let customers: CustomerSummary[] = [];
+
+  // check if listCustomersBody.customers is undefined
+  if (!listCustomersBody.customers) {
+    return customers;
+  }
+
+  for (const customer of listCustomersBody.customers) {
+    customers.push({
+      name: customer.name,
+      customerId: customer.id
+    });
+  }
+
+  return customers;
+}
+
 export async function getUsedKubernetesDistributions(vendorPortalApi: VendorPortalApi, appSlug: string): Promise<KubernetesDistribution[]> {
   const http = await vendorPortalApi.client();
 

src/index.ts

@@ -2,5 +2,5 @@ export { VendorPortalApi } from "./configuration";
 export { getApplicationDetails } from "./applications";
 export { Channel, createChannel, getChannelDetails, archiveChannel, pollForAirgapReleaseStatus, getDownloadUrlAirgapBuildRelease } from "./channels";
 export { ClusterVersion, createCluster, createClusterWithLicense, pollForStatus, getKubeconfig, removeCluster, upgradeCluster, getClusterVersions, createAddonObjectStore, pollForAddonStatus, exposeClusterPort } from "./clusters";
-export { KubernetesDistribution, archiveCustomer, createCustomer, getUsedKubernetesDistributions } from "./customers";
+export { KubernetesDistribution, CustomerSummary, archiveCustomer, createCustomer, getUsedKubernetesDistributions, listCustomersByName } from "./customers";
 export { Release, CompatibilityResult, createRelease, createReleaseFromChart, promoteRelease, reportCompatibilityResult } from "./releases";