P-5672: Support for getting customer groups as part of customer

.changeset/sixty-timers-perform.md

@@ -0,0 +1,5 @@
+---
+'@team-plain/typescript-sdk': minor
+---
+
+Updates the customer fragment so that it also fetches customer groups

src/client.ts

@@ -58,7 +58,32 @@ import {
 import { request } from './request';
 import type { Result } from './result';
 
-type SDKResult<T> = Promise<Result<T, PlainSDKError>>;
+type SDKResult<T> = Promise<Result<Transform<T>, PlainSDKError>>;
+
+// Transform takes a GraphQL Fragment and transforms it into a type in which
+// all of its connection-like fields (e.g. fields which have an `edges`) property
+// are flattened into an array. For example:
+//
+// Given the type:
+//
+// type Fragment = {
+//     customerGroupMemberships: {
+//        edges: Array<{ node: CustomerGroupMembershipPartsFragment }>
+//     }
+// }
+//
+// When we apply Transform to it, we get:
+//
+// type Transform<Fragment> = {
+// {
+//     customerGroupMemberships: Array<CustomerGroupMembershipPartsFragment>
+// }
+//
+type Transform<T> = T extends { edges: Array<{ node: infer E }> }
+  ? Array<Transform<E>>
+  : T extends object
+  ? { [K in keyof T]: Transform<T[K]> }
+  : T;
 
 function nonNullable<T>(x: T | null | undefined): T {
   if (x === null || x === undefined) {
@@ -159,7 +184,10 @@ export class PlainClient {
 
     return unwrapData(res, (q) => ({
       pageInfo: q.customers.pageInfo,
-      customers: q.customers.edges.map((edge) => edge.node),
+      customers: q.customers.edges.map((edge) => ({
+        ...edge.node,
+        customerGroupMemberships: edge.node.customerGroupMemberships.edges.map((e) => e.node),
+      })),
       totalCount: q.customers.totalCount,
     }));
   }
@@ -175,7 +203,15 @@ export class PlainClient {
       variables,
     });
 
-    return unwrapData(res, (q) => q.customer);
+    return unwrapData(res, (q) => {
+      if (!q.customer) {
+        return null;
+      }
+      return {
+        ...q.customer,
+        customerGroupMemberships: q.customer.customerGroupMemberships.edges.map((e) => e.node),
+      };
+    });
   }
 
   /**
@@ -189,7 +225,18 @@ export class PlainClient {
       variables,
     });
 
-    return unwrapData(res, (q) => q.customerByEmail);
+    return unwrapData(res, (q) => {
+      if (!q.customerByEmail) {
+        return null;
+      }
+
+      return {
+        ...q.customerByEmail,
+        customerGroupMemberships: q.customerByEmail.customerGroupMemberships.edges.map(
+          (e) => e.node
+        ),
+      };
+    });
   }
 
   /**
@@ -207,9 +254,13 @@ export class PlainClient {
     });
 
     return unwrapData(res, (q) => {
+      const customer = nonNullable(q.upsertCustomer.customer);
       return {
         result: nonNullable(q.upsertCustomer.result),
-        customer: nonNullable(q.upsertCustomer.customer),
+        customer: {
+          ...customer,
+          customerGroupMemberships: customer.customerGroupMemberships.edges.map((e) => e.node),
+        },
       };
     });
   }

src/graphql/fragments/customerCardConfigParts.gql

@@ -1,4 +1,5 @@
 fragment CustomerCardConfigParts on CustomerCardConfig {
+  __typename
   id
   title
   key

src/graphql/fragments/customerEventParts.gql

@@ -1,4 +1,5 @@
 fragment CustomerEventParts on CustomerEvent {
+  __typename
   id
   customerId
   title

src/graphql/fragments/customerGroupMembershipParts.gql

@@ -1,4 +1,5 @@
 fragment CustomerGroupMembershipParts on CustomerGroupMembership {
+  __typename
   customerId
   createdAt {
     ...DateTimeParts

src/graphql/fragments/customerGroupParts.gql

@@ -1,4 +1,5 @@
 fragment CustomerGroupParts on CustomerGroup {
+  __typename
   id
   name
   key

src/graphql/fragments/customerParts.gql

@@ -23,4 +23,11 @@ fragment CustomerParts on Customer {
   markedAsSpamAt {
     ...DateTimeParts
   }
+  customerGroupMemberships {
+    edges {
+      node {
+        ...CustomerGroupMembershipParts
+      }
+    }
+  }
 }

src/tests/query.test.ts

@@ -3,15 +3,15 @@ import { describe, expect, test } from 'vitest';
 
 import { PlainClient } from '..';
 import type { PlainSDKError } from '../error';
-import { CustomerByIdDocument } from '../graphql/types';
+import { CustomerByIdDocument, type CustomerPartsFragment } from '../graphql/types';
 import { PlainGraphQLError } from '../graphql-utlities';
 import { testHelpers } from './test-helpers';
 
 describe('query test - customer by id', () => {
   test('should return a valid customer', async () => {
     const customerId = 'c_123';
 
-    const response = {
+    const response: { data: { customer: CustomerPartsFragment } } = {
       data: {
         customer: {
           __typename: 'Customer',
@@ -22,17 +22,27 @@ describe('query test - customer by id', () => {
           email: {
             email: 'test@gmail.com',
             isVerified: true,
-            verifiedAt: { __typename: 'DateTime', iso8601: '2023-03-20T13:06:37.918Z' },
+            verifiedAt: {
+              __typename: 'DateTime',
+              iso8601: '2023-03-20T13:06:37.918Z',
+              unixTimestamp: '1699890305',
+            },
+          },
+          updatedAt: {
+            __typename: 'DateTime',
+            iso8601: '2023-05-01T09:54:51.715Z',
+            unixTimestamp: '1699890305',
+          },
+          createdAt: {
+            __typename: 'DateTime',
+            iso8601: '2023-03-20T13:06:37.961Z',
+            unixTimestamp: '1699890305',
           },
-          status: 'ACTIVE',
-          statusChangedAt: { __typename: 'DateTime', iso8601: '2023-05-01T09:54:51.715Z' },
-          assignedToUser: { __typename: 'UserActor', userId: 'u_123' },
-          assignedAt: { __typename: 'DateTime', iso8601: '2023-04-10T15:01:54.499Z' },
-          updatedAt: { __typename: 'DateTime', iso8601: '2023-05-01T09:54:51.715Z' },
-          lastIdleAt: { __typename: 'DateTime', iso8601: '2023-03-20T13:06:47.492Z' },
-          createdAt: { __typename: 'DateTime', iso8601: '2023-03-20T13:06:37.961Z' },
           createdBy: {},
           markedAsSpamAt: null,
+          customerGroupMemberships: {
+            edges: [],
+          },
         },
       },
     };
@@ -56,7 +66,10 @@ describe('query test - customer by id', () => {
     });
 
     expect(result.error).toBeUndefined();
-    expect(result.data).toEqual(response.data.customer);
+    expect(result.data).toEqual({
+      ...response.data.customer,
+      customerGroupMemberships: [],
+    });
   });
 
   test('should accept a null customer when not found', async () => {