@epicdm/gateway-routes

Canonical gateway route table, smoke test specifications, and gateway config emitters for Epic FlowState.

What's in this package

• ROUTES — single source of truth for all gateway routes (path, upstream, scope, auth, CORS, rate limit, transport)
• SMOKE_SPECS — canonical smoke test specifications for local and cloud gateway parity
• CLOUD_BINDINGS / LOCAL_BINDINGS — logical service → binding maps
• UPSTREAM_TO_LOGICAL — upstream service ID → LogicalService union mapping
• emitCfRoutes(routes) — emits the Cloudflare Worker gateway route table (excludes local-only scope)
• emitKong(routes, opts) — emits the Kong kong.yml declarative config (excludes cloud-only scope)

Canonical source

⚠️ This package is vendored. The canonical source lives in the flowstate-platform monorepo at packages/gateway-routes. This copy exists so the epic-flowstate-community monorepo can consume it via workspace:* without a cross-repo registry dependency.

Sync policy

Per the P0 decisions document §9 (lives in the canonical flowstate-platform repo at docs/plans/2026-04-10-gateway-routes-decisions.md, not in this community repo):

1. The canonical package in flowstate-platform is frozen — no behavioural changes without a coordinated cross-repo task.
2. When the upstream package changes, a follow-up task must bump this vendored copy byte-for-byte from flowstate-platform@<sha> and update the "Last synced from" line below.
3. The vendored copy must remain byte-identical to upstream except for this README.md.
4. The P3.7 lint:kong CI check guards against drift in generated Kong YAML.

Last synced from

• Upstream commit: flowstate-platform@030b4da0 (dev)
• Sync date: 2026-04-11
• Synced as part of: task_rN6GL9aFBa (P3.1 — add @epicdm/gateway-routes dep to flowstate-cli)

Usage

import {
  ROUTES,
  SMOKE_SPECS,
  emitCfRoutes,
  emitKong,
  type GatewayRoute,
  type SmokeSpec,
} from '@epicdm/gateway-routes'

// Emit Kong declarative config for local dev
const kongYaml = emitKong(ROUTES, {
  gatewayPort: 7080,
  jwtIssuer: 'http://localhost:7080',
  jwtConsumer: 'flowstate-auth',
})

// Emit Cloudflare Worker route list for cloud gateway
const cfRoutes = emitCfRoutes(ROUTES, { includeDevOnly: false })

// Run smoke tests against a gateway
for (const spec of SMOKE_SPECS) {
  // GET/POST ${spec.path}, expect spec.expect status
}

License

Apache-2.0. Epic FlowState is a trademark of Epic Digital Interactive Media LLC.