feat: edge function docs (#150)

Author: kevcodez

README.md

@@ -40,6 +40,10 @@ Each package has its own README with installation, configuration, and usage inst
 
 ---
 
+## Supabase Edge Function
+
+To deploy the sync-engine to a Supabase edge function, follow this [guide](./edge-function.md).
+
 ## Webhook Support
 
 - [ ] `balance.available`

edge-function.md

@@ -0,0 +1,71 @@
+# Stripe-Sync inside Supabase Edge Function
+
+Create a new [Supabase](https://supabase.com) and create a new [Edge Function](https://supabase.com/docs/guides/functions/quickstart).
+
+Make sure to run the [migrations](./packages/sync-engine/src/database/migrations/), either by executing them manually, adding them into your CI or running this locally once:
+
+```ts
+import { runMigrations } from '@supabase/stripe-sync-engine'
+;(async () => {
+  await runMigrations({
+    databaseUrl: 'postgresql://postgres:..@db.<ref>.supabase.co:5432/postgre',
+    schema: 'stripe',
+    logger: console,
+  })
+})()
+```
+
+Sample code:
+
+```ts
+// Setup type definitions for built-in Supabase Runtime APIs
+import 'jsr:@supabase/functions-js/edge-runtime.d.ts'
+import { StripeSync } from 'npm:@supabase/[email protected]'
+
+// Load secrets from environment variables
+const databaseUrl = Deno.env.get('DATABASE_URL')!
+const stripeWebhookSecret = Deno.env.get('STRIPE_WEBHOOK_SECRET')!
+const stripeSecretKey = Deno.env.get('STRIPE_SECRET_KEY')!
+
+// Initialize StripeSync
+const stripeSync = new StripeSync({
+  databaseUrl,
+  stripeWebhookSecret,
+  stripeSecretKey,
+  backfillRelatedEntities: false,
+  autoExpandLists: true,
+  maxPostgresConnections: 5,
+})
+
+Deno.serve(async (req) => {
+  // Extract raw body as Uint8Array (buffer)
+  const rawBody = new Uint8Array(await req.arrayBuffer())
+
+  const stripeSignature = req.headers.get('stripe-signature')
+
+  await stripeSync.processWebhook(rawBody, stripeSignature)
+
+  return new Response(null, {
+    status: 202,
+    headers: { 'Content-Type': 'application/json' },
+  })
+})
+```
+
+Deploy your Edge Function initially.
+
+Set up a Stripe webhook with the newly deployed Supabase Edge Function url.
+
+Create a new .env file in the `supabase` directory.
+
+```.env
+DATABASE_URL="postgresql://postgres:..@db.<ref>.supabase.co:5432/postgres"
+STRIPE_WEBHOOK_SECRET="whsec_"
+STRIPE_SECRET_KEY="sk_test_..."
+```
+
+Load the secrets:
+
+`sh
+supabase secrets set --env-file ./supabase/.env
+`.