feat: add country selection to address component 🇨🇦

apps/member-profile/app/routes/_profile.home.claim-swag-pack._index.tsx

@@ -54,32 +54,33 @@ export async function loader({ request }: LoaderFunctionArgs) {
   });
 }
 
-const ClaimSwagPackFormData = ClaimSwagPackInput.omit({
-  studentId: true,
-});
-
 export async function action({ request }: ActionFunctionArgs) {
   const session = await ensureUserAuthenticated(request);
 
   const { data, errors, ok } = await validateForm(
     request,
-    ClaimSwagPackFormData
+    ClaimSwagPackInput.omit({ studentId: true })
   );
 
   if (!ok) {
     return json({ errors }, { status: 400 });
   }
 
   try {
-    await claimSwagPack({
+    const result = await claimSwagPack({
       addressCity: data.addressCity,
+      addressCountry: data.addressCountry,
       addressLine1: data.addressLine1,
       addressLine2: data.addressLine2,
       addressState: data.addressState,
       addressZip: data.addressZip,
       studentId: user(session),
     });
 
+    if (!result.ok) {
+      return json({ error: result.error }, { status: result.code });
+    }
+
     return redirect(Route['/home/claim-swag-pack/confirmation']);
   } catch (e) {
     reportException(e);
@@ -91,7 +92,7 @@ export async function action({ request }: ActionFunctionArgs) {
   }
 }
 
-const keys = ClaimSwagPackFormData.keyof().enum;
+const keys = ClaimSwagPackInput.keyof().enum;
 
 export default function ClaimSwagPack() {
   const { inventoryPromise } = useLoaderData<typeof loader>();
@@ -142,6 +143,19 @@ function ClaimSwagPackForm() {
       <Text color="gray-500">Let us know where to send your swag pack!</Text>
 
       <Address>
+        <Form.Field
+          error={errors.addressCountry}
+          label="Country"
+          labelFor={keys.addressCountry}
+          required
+        >
+          <Address.Country
+            id={keys.addressCountry}
+            name={keys.addressCountry}
+            required
+          />
+        </Form.Field>
+
         <Form.Field
           error={errors.addressLine1}
           label="Street Address"
@@ -176,7 +190,6 @@ function ClaimSwagPackForm() {
               required
             />
           </Form.Field>
-
           <Form.Field
             error={errors.addressState}
             label="State"

packages/core/src/modules/swag-pack/swag-pack.service.ts

@@ -80,7 +80,7 @@ export async function orderSwagPack(input: OrderSwagPackInput) {
       shipping_address1: input.contact.address.line1,
       shipping_address2: input.contact.address.line2,
       shipping_city: input.contact.address.city,
-      shipping_country: 'US',
+      shipping_country: input.contact.address.country,
       shipping_state: input.contact.address.state,
       shipping_zip: input.contact.address.zip,
     },

packages/core/src/modules/swag-pack/swag-pack.types.ts

@@ -4,6 +4,7 @@ import { Address, Student } from '@oyster/types';
 
 export const ClaimSwagPackInput = z.object({
   addressCity: Address.shape.city,
+  addressCountry: Address.shape.country,
   addressLine1: Address.shape.line1,
   addressLine2: Address.shape.line2,
   addressState: Address.shape.state,

packages/core/src/modules/swag-pack/use-cases/claim-swag-pack.ts

@@ -1,26 +1,72 @@
+import dedent from 'dedent';
+
 import { db } from '@oyster/db';
 
+import { job } from '@/infrastructure/bull/use-cases/job';
+import { fail, type Result, success } from '@/shared/utils/core.utils';
 import { orderSwagPack } from '../swag-pack.service';
 import { type ClaimSwagPackInput } from '../swag-pack.types';
 
 export async function claimSwagPack({
   addressCity,
+  addressCountry,
   addressLine1,
   addressLine2,
   addressState,
   addressZip,
   studentId,
-}: ClaimSwagPackInput) {
+}: ClaimSwagPackInput): Promise<Result> {
+  // We save the address regardless if the swag pack order failed or not so
+  // we'll be able to send them something in the future.
   const student = await db
-    .selectFrom('students')
-    .select(['email', 'firstName', 'lastName'])
+    .updateTable('students')
+    .set({
+      addressCity,
+      addressCountry,
+      addressLine1,
+      addressLine2,
+      addressState,
+      addressZip,
+    })
     .where('id', '=', studentId)
+    .returning(['email', 'firstName', 'lastName'])
     .executeTakeFirstOrThrow();
 
+  // Currently, SwagUp only supports the US, but not Puerto Rico.
+  // See: https://support.swagup.com/en/articles/6952397-international-shipments-restricted-items
+  const isAddressSupported = addressCountry === 'US' && addressState !== 'PR';
+
+  // If the address isn't supported, then we'll send a notification to our
+  // team to create a gift card manually for them.
+  if (!isAddressSupported) {
+    const notification = dedent`
+      ${student.firstName} ${student.lastName} (${student.email}) is attempting to claim a swag pack, but they're either from Puerto Rico or Canada, which is not supported for our product.
+
+      We let them know we'll send them a merch store gift card in the next "few days"!
+    `;
+
+    job('notification.slack.send', {
+      message: notification,
+      workspace: 'internal',
+    });
+
+    const error = dedent`
+      Unfortunately, our swag pack provider, SwagUp, does not support shipments to Puerto Rico and Canada. Instead, we will send you a gift card to our official merch store.
+
+      Our team has been notified, please give us a few days to complete this request!
+    `;
+
+    return fail({
+      code: 400,
+      error,
+    });
+  }
+
   const swagPackOrderId = await orderSwagPack({
     contact: {
       address: {
         city: addressCity,
+        country: addressCountry,
         line1: addressLine1,
         line2: addressLine2,
         state: addressState,
@@ -35,14 +81,11 @@ export async function claimSwagPack({
   await db
     .updateTable('students')
     .set({
-      addressCity,
-      addressLine1,
-      addressLine2,
-      addressState,
-      addressZip,
       claimedSwagPackAt: new Date(),
       swagUpOrderId: swagPackOrderId,
     })
     .where('id', '=', studentId)
     .execute();
+
+  return success({});
 }

packages/db/src/migrations/20240822172825_students_address_country.ts

@@ -0,0 +1,15 @@
+import { type Kysely } from 'kysely';
+
+export async function up(db: Kysely<any>) {
+  await db.schema
+    .alterTable('students')
+    .addColumn('address_country', 'text')
+    .execute();
+}
+
+export async function down(db: Kysely<any>) {
+  await db.schema
+    .alterTable('students')
+    .dropColumn('address_country')
+    .execute();
+}

packages/types/src/domain/types.ts

@@ -17,6 +17,7 @@ export type Entity = z.infer<typeof Entity>;
 
 export const Address = z.object({
   city: z.string().trim().min(1),
+  country: z.string().trim().min(2).max(3),
   line1: z.string().trim().min(1),
   line2: z.string().trim().optional(),
   state: z.string().trim().min(1),