Initial Commit

openspec/changes/enterprise-api-plugin-payment/proposal.md

@@ -0,0 +1,98 @@
+# OpenSpec Change: enterprise-api-plugin-payment
+
+- **Change ID**: enterprise-api-plugin-payment
+- **Package**: `@suaveplan/api-plugin-payment`
+- **Category**: api/commerce
+- **Target path**: `api/commerce/api-plugin-payment`
+- **Status**: PROPOSED
+- **Date**: 2026-04-24
+- **Reference spec**: `/mnt/s/web/suaveplan/enterprise/api-plugin-payment.md`
+
+---
+
+## Summary
+
+Deliver `@suaveplan/api-plugin-payment` on the genesis branch from scratch at enterprise quality. HTTP surface over `@suaveplan/payment`: mounts `/payments` (intent lifecycle + refunds + list) and `/webhooks/payment` (HMAC-verified ingestion). Wraps a caller-supplied `PaymentProvider` in a `PaymentEngine`. Per-table SurrealQL migrations. Typed event bus — no `as any` casts. Full `onTenantCreate`/`onTenantDelete` lifecycle. Idempotency on mutations, rate limiting, and audit logging on all write paths. PCI-DSS SAQ-A posture documented.
+
+---
+
+## Available workspace deps on genesis
+
+| Package | Role |
+|---|---|
+| `@suaveplan/api` (`workspace:^`) | `definePlugin` |
+| `@suaveplan/api-shared` (`workspace:^`) | Response helpers |
+| `@suaveplan/api-plugin-auth` (`workspace:^`) | `requireAuth` |
+| `@suaveplan/api-plugin-database` (`workspace:^`) | SurrealDB |
+| `@suaveplan/payment` (`workspace:^`) | `PaymentEngine`, `PaymentProvider` |
+| `@suaveplan/events` (`workspace:^`) | Typed event bus |
+| `@suaveplan/error` (`workspace:^`) | Typed errors |
+| `@suaveplan/idempotency` (`workspace:^`) | Mutation guard |
+| `@suaveplan/audit-logging` (`workspace:^`) | Write-path audit |
+| `@suaveplan/rate-limiter` (`workspace:^`) | Rate limiting |
+| `hono` + `@hono/zod-openapi` + `zod` | Routes |
+| `@opentelemetry/api` | OTel |
+
+---
+
+## Public API surface
+
+```ts
+function createPaymentPlugin(provider: PaymentProvider, config?: PaymentPluginConfig): PluginDescriptor<PaymentPluginConfig>
+class PaymentService { createIntent, confirm, capture, cancel, refund, list }
+
+// Schemas
+CreatePaymentIntentSchema, MoneySchema, PaymentIntentIdParamSchema
+PaymentIntentResponseSchema, PaymentListQuerySchema, RefundRequestSchema, RefundResponseSchema
+
+// Types
+PaymentPluginConfig, PaymentDomainEventMap, SerializedIntent, SerializedRefund
+```
+
+### Error codes
+
+```ts
+type PaymentErrorCode =
+  | "PAYMENT_INTENT_NOT_FOUND"
+  | "PAYMENT_ALREADY_CAPTURED"
+  | "PAYMENT_REFUND_EXCEEDS"
+  | "PAYMENT_WEBHOOK_SIGNATURE"
+  | "PAYMENT_WEBHOOK_STALE"
+  | "PAYMENT_PROVIDER_ERROR"
+```
+
+---
+
+## Genesis additions vs main-branch
+
+1. **`PaymentBusEventMap`** declared via `src/events.ts` module augmentation — replaces all `(ctx.eventBus as any)?.emit?.()` calls.
+2. **Per-table SurrealQL** — `intent.surql`, `refund.surql`, `webhook_event.surql`.
+3. **Real `onTenantCreate`/`onTenantDelete`** — SurrealDB namespacing + provider configuration.
+4. **`onClose`** detaches all engine listeners registered in `onInit`.
+5. **`onInit` reads `ctx.getPluginConfig`** for `webhookSecret` / `webhookToleranceMs` overrides.
+6. **Idempotency** on `POST /payments` and `POST /payments/:id/refund`.
+7. **Rate limiting** on create-intent and refund.
+8. **Audit logging** on every state-changing operation and accepted webhook.
+
+---
+
+## File layout
+
+```text
+api/commerce/api-plugin-payment/
+  package.json  tsconfig.json  vitest.config.ts
+  surql/intent.surql  surql/refund.surql  surql/webhook_event.surql
+  src/
+    index.ts  events.ts
+    types/  errors/
+    services/payment/
+    schemas/
+    routes/payment/  routes/webhook/  routes/problem-json.ts
+  tests/integration.test.ts
+```
+
+---
+
+## Impact
+
+Prerequisites: `@suaveplan/api`, `@suaveplan/api-plugin-auth`, `@suaveplan/api-plugin-database`, `@suaveplan/payment`, `@suaveplan/events`, `@suaveplan/idempotency`, `@suaveplan/audit-logging`, `@suaveplan/rate-limiter`, `@suaveplan/error`.