🗃️ pomelo: db schema and migration setup

.gitignore

@@ -5,6 +5,7 @@ node_modules/
 build/
 dist/
 web-build/
+drizzle/
 /android/
 /ios/
 

package.json

@@ -7,6 +7,7 @@
     "android": "expo run:android",
     "ios": "expo run:ios",
     "web": "expo start --web",
+    "pomelo": "bun run --cwd pomelo dev",
     "test": "concurrently 'npm:test:*' --group -c auto",
     "test:ts:expo": "tsc",
     "test:ts:node": "tsc -p tsconfig.node.json",

pomelo/README.md

@@ -0,0 +1,49 @@
+# Setup
+
+Project uses Vercel serverless functions to provide endpoints for Pomelo integration.
+All exposed endpoints are found under `/api`.
+
+## Local Development
+
+Install dependencies on parent directory (`mobile`) 
+
+```bash
+bun i
+```
+
+Spin up dev server
+
+```bash
+bun pomelo 
+```
+
+## Database
+
+Project uses Vercel Postgres DB and drizzle as an ORM.
+DB auth is handled by `@vercel/postgres` when running `vercel dev`
+
+### Migrations
+
+After changing the schema declaration in `db/schema.th` you can run
+
+```bash
+bun db:migrate
+```
+
+to apply schema changes directy to DB.
+
+### Advanced
+
+If needed, migration can be done in 2 steps, first generating the migration SQL query and then executing it.
+After changing the schema declaration in `db/schema.th` run:
+
+``` bash
+bun db:migration:generate
+```
+
+ The SQL migration file will be generated under `/drizzle` with a number and unique name.
+To execute it, run:
+
+``` bash
+bun db:migration:push
+```

pomelo/database/index.ts

@@ -0,0 +1,6 @@
+import { sql } from "@vercel/postgres";
+import { drizzle } from "drizzle-orm/vercel-postgres";
+
+import * as schema from "./schema.js";
+
+export default drizzle(sql, { schema });

pomelo/database/migrate.ts

@@ -0,0 +1,17 @@
+import debug from "debug";
+import { migrate } from "drizzle-orm/vercel-postgres/migrator";
+
+import database from "./index.js";
+
+const log = debug("pomelo");
+
+try {
+  log("🏗️ migration started");
+  await migrate(database, {
+    migrationsFolder: "drizzle",
+  });
+  log("✅ migration finished");
+} catch (error) {
+  log("❌ migration failed", error);
+  throw error;
+}

pomelo/database/schema.ts

@@ -0,0 +1,44 @@
+import { jsonb, pgEnum, pgTable, text, numeric } from "drizzle-orm/pg-core";
+
+import { CARD_STATUS, OPERATION_COUNTRIES, USER_STATUS } from "../utils/types";
+
+export const userStatusEnum = pgEnum("status", USER_STATUS);
+export const countryEnum = pgEnum("operation_country", OPERATION_COUNTRIES);
+export const cardStatusEnum = pgEnum("status", CARD_STATUS);
+export const transactionStatusEnum = pgEnum("transaction_status", ["APPROVED", "REJECTED"]);
+
+export const users = pgTable("users", {
+  id: text("id").primaryKey(),
+  client_id: text("client_id"),
+  email: text("email"),
+  status: userStatusEnum("status"),
+  operation_country: countryEnum("operation_country"),
+  name: text("name"),
+  surname: text("surname"),
+  payload: jsonb("payload").notNull(),
+});
+
+export const card = pgTable("cards", {
+  id: text("id").primaryKey(),
+  user_id: text("user_id")
+    .references(() => users.id)
+    .notNull(),
+  affinity_group_id: text("affinity_group_id").notNull(),
+  status: cardStatusEnum("status").notNull(),
+  last_four: text("last_four"),
+  payload: jsonb("payload").notNull(),
+});
+
+export const transaction = pgTable("transactions", {
+  id: text("id").primaryKey(),
+  card_id: text("card_id")
+    .references(() => card.id)
+    .notNull(),
+  user_id: text("user_id")
+    .references(() => users.id)
+    .notNull(),
+  settlement_amount: numeric("settlement_amount").notNull(),
+  txHash: text("txHash"),
+  transaction_status: transactionStatusEnum("transaction_status").notNull(),
+  payload: jsonb("payload").notNull(),
+});

pomelo/package.json

@@ -2,19 +2,27 @@
   "name": "@exactly/pomelo",
   "type": "module",
   "scripts": {
-    "test": "tsc"
+    "test": "tsc",
+    "db:migration:generate": "drizzle-kit generate:pg --schema=./database/schema.ts",
+    "db:migration:push": "bun run database/migrate.ts",
+    "db:migrate": "bun db:migration:generate && bun db:migration:push",
+    "dev": "bun run --cwd .. vercel dev"
   },
   "engines": {
     "node": ">=20.0.0"
   },
   "dependencies": {
     "@vercel/node": "^3.0.11",
+    "@vercel/postgres": "^0.5.1",
     "@wagmi/core": "2.0.0-beta.6",
+    "drizzle-orm": "^0.29.1",
     "viem": "2.0.0-beta.15",
-    "zod": "^3.22.4"
+    "zod": "^3.22.4",
+    "debug": "^4.3.4"
   },
   "devDependencies": {
     "@types/node": "^20.10.4",
+    "drizzle-kit": "^0.20.6",
     "typescript": "^5.3.3",
     "vercel": "^32.6.1"
   }

pomelo/tsconfig.json

@@ -2,8 +2,8 @@
   "compilerOptions": {
     "lib": ["ESNext"],
     "target": "ESNext",
-    "module": "NodeNext",
-    "moduleResolution": "NodeNext",
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
     "noUncheckedIndexedAccess": true,
     "resolveJsonModule": true,
     "esModuleInterop": true,

pomelo/utils/types.ts

@@ -1,6 +1,10 @@
 import { z } from "zod";
 
-const country = z.enum(["ARG", "BRA", "MEX", "COL", "PER", "CHL"]);
+export const OPERATION_COUNTRIES = ["ARG", "BRA", "MEX", "COL", "PER", "CHL"] as const;
+export const CARD_STATUS = ["ACTIVE", "BLOCKED", "DISABLED"] as const;
+export const USER_STATUS = ["ACTIVE", "BLOCKED"] as const;
+
+const country = z.enum(OPERATION_COUNTRIES);
 
 const date = z.string();
 
@@ -49,7 +53,7 @@ export const user = z.object({
   id: z.string().regex(/^usr-.*/),
   client_id: z.string().regex(/^cli-.*/),
   email: z.string().email(),
-  status: z.enum(["ACTIVE", "BLOCKED"]),
+  status: z.enum(USER_STATUS),
   operation_country: country,
   name: z.string().optional(),
   surname: z.string().optional(),
@@ -80,7 +84,7 @@ export const card = z.object({
   affinity_group_id: z.string().regex(/^afg-.*/),
   card_type: z.enum(["VIRTUAL", "PHYSICAL"]),
   product_type: z.enum(["PREPAID", "DEBIT", "CREDIT"]).optional(),
-  status: z.enum(["ACTIVE", "BLOCKED", "DISABLED"]).optional(),
+  status: z.enum(CARD_STATUS).optional(),
   shipment_id: z
     .string()
     .regex(/^shi-.*/)