Package exports
Every entry point of @heyo-sh/heyo-status and what it provides.
The package is split so that a browser bundle never pulls in a database driver, and a Worker bundle never pulls in React. Import from the narrowest path that has what you need.
Entry points
| Path | Provides |
|---|---|
@heyo-sh/heyo-status | The aggregate root export. |
@heyo-sh/heyo-status/config | heyoStatus, validateStatusPageConfig. |
@heyo-sh/heyo-status/types | Every public type. |
@heyo-sh/heyo-status/checks | runStatusCheck, runStatusChecks, evaluateCompositeMonitor. |
@heyo-sh/heyo-status/db | SQLite adapters, lazyStatusDatabase, Drizzle schema. |
@heyo-sh/heyo-status/db/d1 | d1, D1StatusDatabase. |
@heyo-sh/heyo-status/db/postgres | postgres, PostgresStatusDatabase. |
@heyo-sh/heyo-status/db/lazy | lazyStatusDatabase. |
@heyo-sh/heyo-status/api | createStatusApp. |
@heyo-sh/heyo-status/snapshot | buildStatusSnapshot, getStatusSnapshot. |
@heyo-sh/heyo-status/badge | createMonitorBadge, createOverallBadge. |
@heyo-sh/heyo-status/metrics | createPrometheusMetrics, prometheusContentType. |
@heyo-sh/heyo-status/feeds | createRssFeed, createAtomFeed. |
@heyo-sh/heyo-status/notifications | slack, discord, webhook, email and signature helpers. |
@heyo-sh/heyo-status/subscribers | Public-subscription helpers. |
@heyo-sh/heyo-status/telemetry | Telemetry payload and reporting. |
@heyo-sh/heyo-status/ui | StatusPage and the UI primitives. |
@heyo-sh/heyo-status/ui/subscribe-dialog | SubscribeDialog, kept out of the main chunk. |
@heyo-sh/heyo-status/next | statusHandler for the Next App Router. |
@heyo-sh/heyo-status/react-router | statusHandler returning loader and action. |
@heyo-sh/heyo-status/astro | statusHandler for an Astro endpoint. |
@heyo-sh/heyo-status/deployments/cloudflare | D1 re-exports, cloudflareWorker, cron helpers. |
@heyo-sh/heyo-status/deployments/vercel | PostgreSQL re-exports, vercelCronHandler, runVercelCron. |
@heyo-sh/heyo-status/deployments/node | scheduleStatusPage. |
@heyo-sh/heyo-status/theme/provider | StatusThemeProvider, useStatusTheme. |
@heyo-sh/heyo-status/theme/script | statusThemeBootstrapScript. |
@heyo-sh/heyo-status/theme/status.css | The stylesheet, containing every theme's tokens. |
theme/slate.css, theme/fern.css, theme/onyx.css, theme/dune.css and
theme/reed.css remain as compatibility aliases for theme/status.css.
Configuration
heyoStatus() validates and attaches the runtime.
validateStatusPageConfig() validates without attaching — useful when
inspecting configuration in a tool.
Checks
Both return results without persisting them, which makes them handy for a one-off probe or a test.
Snapshots
Notifications
Databases
Deployments
Types
Runtime boundaries
| Import | Safe in a browser bundle | Safe on Workers |
|---|---|---|
/config, /api, /types | yes | yes |
/ui, /theme/* | yes | yes (SSR) |
/db (SQLite) | no | no |
/db/d1, /deployments/cloudflare | no | yes |
/db/postgres | no | only with a compatible driver |
/checks | no | yes, minus tcp and ssl |
The package is built twice — once for Node and once for a browser/Worker
target — so the Workers bundle of config, api, db/d1 and the adapters
never contains Node built-ins.
Peer dependencies
react and react-dom 19 are peers, needed only for /ui and /theme/*.
drizzle-orm, hono, zod and tailwindcss are regular dependencies; no
database driver is bundled.