void 0.20.3 → 0.21.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/agents-gni4eqBu.mjs +111 -0
- package/dist/auth-3sGB0zJ1.mjs +22 -0
- package/dist/{auth-DPl6kck4.mjs → auth-B9_D6ygs.mjs} +6 -241
- package/dist/auth-CAw7zHqj.mjs +2 -0
- package/dist/auth-client-BWBT8HLp.mjs +6 -0
- package/dist/auth-client-Bawdj38n.d.mts +7 -0
- package/dist/auth-client-react-7GFffu8R.d.mts +7 -0
- package/dist/auth-client-react-CMLwT2xI.mjs +6 -0
- package/dist/auth-client-solid-DyTFL4cq.d.mts +7 -0
- package/dist/auth-client-solid-UoreJWZG.mjs +6 -0
- package/dist/auth-client-svelte-Cv_WvrRk.mjs +6 -0
- package/dist/auth-client-svelte-zetW0KIH.d.mts +7 -0
- package/dist/auth-client-vue-CFk7Xbv3.mjs +6 -0
- package/dist/auth-client-vue-bChShbQP.d.mts +7 -0
- package/dist/{auth-cmd-CzwquNiP.mjs → auth-cmd-g_ymMkUe.mjs} +5 -5
- package/dist/{auth-link-ElDTgF7j.mjs → auth-link-DFvxIyZi.mjs} +5 -5
- package/dist/{better-auth-shared-DSCeohOK.d.mts → better-auth-shared-BoVwA5Vm.d.mts} +1 -6
- package/dist/{better-auth-shared-CYw1T3k4.mjs → better-auth-shared-syGYYmnY.mjs} +1 -1
- package/dist/{build-cmd-BpJe6boP.mjs → build-cmd-wJAv808h.mjs} +6 -4
- package/dist/{cache-D98YTqeE.mjs → cache-Be0Fu5Ka.mjs} +6 -4
- package/dist/{cancel-deploy-CPbEQLMG.mjs → cancel-deploy-BgmyOwhe.mjs} +5 -3
- package/dist/cf-access-rAZxzMkL.mjs +181 -0
- package/dist/cf-build-output-CTdlo6Rt.mjs +520 -0
- package/dist/cli/cf-compat.d.mts +1 -0
- package/dist/cli/cf-compat.mjs +944 -0
- package/dist/cli/cli.mjs +60 -38
- package/dist/cli/env-schema-probe.mjs +3 -3
- package/dist/client-DAAivdid.mjs +2 -0
- package/dist/{client-BQBrZoCX.mjs → client-PdAJ-F0t.mjs} +6 -12
- package/dist/{cloudflare-auth-6M5llVPC.mjs → cloudflare-auth-BCmTc1X_.mjs} +13 -44
- package/dist/{cloudflare-cmd-4RPGN3KB.mjs → cloudflare-cmd-D6PrKn7o.mjs} +4 -7
- package/dist/{cloudflare-connect-t1UU5svD.mjs → cloudflare-connect-DloREDlc.mjs} +6 -6
- package/dist/cloudflare-operations-BHNJVDbN.mjs +2 -0
- package/dist/{cloudflare-operations-BzWnlC1_.mjs → cloudflare-operations-CPEdHYhM.mjs} +37 -39
- package/dist/cloudflare-user-output-Q-k0QoNQ.mjs +20 -0
- package/dist/collect-DAUItMDS.mjs +2 -0
- package/dist/collect-DXHNWHcT.mjs +48 -0
- package/dist/config--T87TD8T.mjs +2 -0
- package/dist/{config-NOG_U1aK.mjs → config-BSe70f4T.mjs} +4 -6
- package/dist/config-DDIFxQYx.mjs +2 -0
- package/dist/{config-uNGuFsI2.mjs → config-Dxr6cTXn.mjs} +22 -37
- package/dist/config-DywxBLQC.d.mts +185 -0
- package/dist/config-entry.d.mts +6 -0
- package/dist/config-entry.mjs +7 -0
- package/dist/config-uP7ZDtVZ.mjs +21 -0
- package/dist/config-write-y3CBI_ux.mjs +60 -0
- package/dist/{connect-WCQZ_u3m.mjs → connect-LnvW4HKx.mjs} +8 -6
- package/dist/{create-project-D0oXA090.mjs → create-project-BZBl_gQ0.mjs} +8 -23
- package/dist/create-project-JV9-6ICF.mjs +2 -0
- package/dist/database-provider-Cx525bwX.mjs +6 -0
- package/dist/database-provider.mjs +1 -5
- package/dist/{db-DJ-9qs3S.mjs → db-Mzv88E1C.mjs} +48 -44
- package/dist/{delete-BZ4-WaGm.mjs → delete-Ri6JemSU.mjs} +6 -4
- package/dist/deploy-DAH2-m_-.mjs +2 -0
- package/dist/{deploy-BAhhcg5q.mjs → deploy-DEsMVrCY.mjs} +796 -198
- package/dist/discover-BBzDZe_o.mjs +2 -0
- package/dist/{discover-xvfrgJeo.mjs → discover-C4O6YxVS.mjs} +3 -8
- package/dist/{dist-BrsS7cai.mjs → dist-4WkAWhWx.mjs} +1 -15
- package/dist/{dist-m40_XgNh.mjs → dist-Bn8Kodjp.mjs} +1 -1
- package/dist/dist-C5fND3R0.mjs +2 -0
- package/dist/dist-D7-nEOXi.mjs +2 -0
- package/dist/{output-B0cfNSx5.mjs → dist-Dn6nn2IU.mjs} +3 -926
- package/dist/{domain-BxAyhxXN.mjs → domain-BA37Ye7T.mjs} +7 -5
- package/dist/{route-types-Da-DpyUp.mjs → drizzle-Beb2Am5S.mjs} +1 -280
- package/dist/{email-Bj7Cvdwp.mjs → email-C5NsxrQG.mjs} +14 -12
- package/dist/{email-Ce6SQq-i.mjs → email-C5kaZXzJ.mjs} +2 -2
- package/dist/{entry-DU3oDoQ3.mjs → entry-DdRFGK0y.mjs} +2 -2
- package/dist/{env-DBKmK4vc.mjs → env-DX_v-Q-v.mjs} +1 -1
- package/dist/{env-DP_EErve.mjs → env-U_ohASB0.mjs} +9 -7
- package/dist/env-Yz4HcvHs.mjs +78 -0
- package/dist/env-helpers--wFmQ_5Q.mjs +136 -0
- package/dist/{env-types-BNPhro-M.mjs → env-types-CWDtqHgw.mjs} +6 -2
- package/dist/{env-validation-CF6KvTRf.mjs → env-validation-BsFEXps5.mjs} +19 -28
- package/dist/env-validation-DIDGM7h4.mjs +2 -0
- package/dist/fetch-CXDChK7B.mjs +18 -0
- package/dist/fetch-_SeGZao9.d.mts +57 -0
- package/dist/fetch-stream-AOByI7Ki.mjs +81 -0
- package/dist/fetch-stream-Bjf0hoZb.d.mts +49 -0
- package/dist/gen-B87rlalt.mjs +2 -0
- package/dist/{gen-B_wPnVTK.mjs → gen-pg-Ojg8Y.mjs} +13 -11
- package/dist/{generate-RTK8_kK1.mjs → generate-C0VY6RVf.mjs} +2 -2
- package/dist/{github-cmd-C-z_xRrQ.mjs → github-cmd-DsrkweIl.mjs} +6 -4
- package/dist/{handler-D1hLsObx.d.mts → handler-BXJTXd02.d.mts} +6 -1
- package/dist/handler-DghKr6dU.mjs +150 -0
- package/dist/head-D_QRR5Yd.mjs +112 -0
- package/dist/head-client-DzmJGN4C.mjs +90 -0
- package/dist/{headers-BAHwgHdW.mjs → headers-B_HBMgi0.mjs} +2 -2
- package/dist/help-B403BLBB.mjs +2 -0
- package/dist/{help-CwOX-zmI.mjs → help-sBhFH6pi.mjs} +17 -12
- package/dist/index.d.mts +2 -20
- package/dist/index.mjs +116 -60
- package/dist/{init-BGktCXgA.mjs → init-C--Yyj1b.mjs} +49 -50
- package/dist/{link-D2kbqhWb.mjs → link-BC-mNG9-.mjs} +7 -5
- package/dist/{list-CvkK_G7k.mjs → list-DHU1Wj6c.mjs} +7 -5
- package/dist/live-CB1y5IuC.mjs +411 -0
- package/dist/live-CKiJilLr.d.mts +105 -0
- package/dist/local-d1-DzykTWY8.mjs +104 -0
- package/dist/login-BwiopVdg.mjs +2 -0
- package/dist/{login-WIjNc77c.mjs → login-jKe_0QZL.mjs} +6 -11
- package/dist/{logs-dLUFCapG.mjs → logs-BG11f5PR.mjs} +6 -4
- package/dist/migrate-BV8qHiCb.mjs +285 -0
- package/dist/migrate-BXY3B3m7.mjs +2 -0
- package/dist/migration-handler-DM4clYj5.d.mts +51 -0
- package/dist/{neon-DHwd2zvC.mjs → neon-n74ta1Pr.mjs} +1 -1
- package/dist/{node-Ez5KW5rn.mjs → node-Cupyf7-s.mjs} +6 -6
- package/dist/{operator-auth-B3e08unv.mjs → operator-auth-BkVgJqv-.mjs} +2 -2
- package/dist/{operator-client-LUZnlnYk.mjs → operator-client-A0iex2yi.mjs} +2 -1
- package/dist/{operator-cmd-CKJ7xIRs.mjs → operator-cmd-BwAS2XZt.mjs} +6 -6
- package/dist/output-CCH48AMM.mjs +146 -0
- package/dist/{package-json-CPoWX79C.mjs → package-json-iCbMg5XF.mjs} +1 -1
- package/dist/pages/client.d.mts +5 -2
- package/dist/pages/client.mjs +5 -3
- package/dist/pages/head-client.mjs +1 -89
- package/dist/pages/head.mjs +1 -111
- package/dist/pages/index.d.mts +2 -3
- package/dist/pages/index.mjs +7 -7
- package/dist/pages/islands-plugin.mjs +2 -2
- package/dist/pages/prefetch.d.mts +2 -30
- package/dist/pages/prefetch.mjs +1 -89
- package/dist/pages/protocol.d.mts +2 -2
- package/dist/pages/protocol.mjs +3 -3
- package/dist/pages/serialize.d.mts +2 -9
- package/dist/pages/serialize.mjs +1 -13
- package/dist/plan-BEZ8VJW0.mjs +256 -0
- package/dist/plan-DpuOr14e.mjs +2 -0
- package/dist/{platform-auth-config-CdVWRRJr.mjs → platform-auth-config-C-hv-_Ok.mjs} +6 -6
- package/dist/{platform-auth-protection-Drl0qhrn.mjs → platform-auth-protection-DjTE5Hj-.mjs} +7 -5
- package/dist/{platform-auth-recovery-CmKEWpDo.mjs → platform-auth-recovery-Cr0r8TEb.mjs} +6 -5
- package/dist/{platform-cmd-5q_k56xS.mjs → platform-cmd-0tEh2ZtA.mjs} +8 -5
- package/dist/platform-cmd-DE6dw45v.mjs +2 -0
- package/dist/{platform-domain-4GiDlcqx.mjs → platform-domain-B_7x6Iqx.mjs} +4 -3
- package/dist/platform-lifecycle-Dhx9Pnub.mjs +2 -0
- package/dist/{platform-lifecycle-R9xAxvtG.mjs → platform-lifecycle-Di0LbhPM.mjs} +208 -37
- package/dist/platform-management-B9LUtMt9.mjs +2 -0
- package/dist/{platform-management-BfWsXHEW.mjs → platform-management-eaiaU3uM.mjs} +8 -5
- package/dist/{platform-recovery-CbK-I1FB.mjs → platform-recovery-BxfA8E5C.mjs} +3 -3
- package/dist/platform-registry-BJbgZLS1.mjs +431 -0
- package/dist/{plugin-inference-BDRfZngg.mjs → plugin-inference-DsvtJLll.mjs} +4 -4
- package/dist/prefetch-Bsc_Pb6c.mjs +90 -0
- package/dist/prefetch-Ce6la4EI.d.mts +31 -0
- package/dist/prepare-D4CkM3_v.mjs +2 -0
- package/dist/{prepare-blNRQvQl.mjs → prepare-_T-Haxrr.mjs} +3 -2
- package/dist/{prepare-CtDJjoOj.mjs → prepare-pcWcxSCh.mjs} +13 -11
- package/dist/prerender-render-Cf_WDE9W.mjs +111 -0
- package/dist/prerender-render.mjs +1 -110
- package/dist/{preset-lAy0B0BQ.mjs → preset-Dowh9tTt.mjs} +16 -118
- package/dist/project-BEBFDFLz.mjs +2 -0
- package/dist/project-CWNIPoXc.mjs +209 -0
- package/dist/{project-cmd-CTdmnzvc.mjs → project-cmd-DrnRJdep.mjs} +18 -16
- package/dist/{project-paths-SK8nMHPp.mjs → project-paths-CKQ-Q5JS.mjs} +47 -14
- package/dist/project-slug-23TpquG4.mjs +8 -0
- package/dist/project-slug-DofjTFd-.mjs +2 -0
- package/dist/{project-team-CGxsQe3_.mjs → project-team-CzRbO_kA.mjs} +6 -4
- package/dist/{project-token-Cirx7uwZ.mjs → project-token-Bwxjf4y6.mjs} +6 -4
- package/dist/{project-tsconfig-Ql2XsSQp.mjs → project-tsconfig-CwfqUnVp.mjs} +2 -2
- package/dist/{protocol-C-pqYJjE.d.mts → protocol-ZH3jP4a7.d.mts} +1 -1
- package/dist/providers-BNKRacMr.d.mts +7 -0
- package/dist/provision-CNgEBkVA.mjs +3 -0
- package/dist/{provision-CSJOjjQk.mjs → provision-Cck2m3jJ.mjs} +11 -25
- package/dist/queues-BWKt1Xo4.d.mts +7 -0
- package/dist/{requests-4Nq59hOr.mjs → requests-DwrqUQZ8.mjs} +5 -3
- package/dist/resolve-project-BTotl8Nn.mjs +2 -0
- package/dist/{resolve-project--Vxawf7z.mjs → resolve-project-Xvis70DG.mjs} +2 -8
- package/dist/response-Tn7rU0MV.mjs +30 -0
- package/dist/{rollback-Dr7u0Ljx.mjs → rollback-B4tFWmkN.mjs} +6 -4
- package/dist/{rolldown-runtime-rQ84J-ij.mjs → rolldown-runtime-DXIUcv95.mjs} +1 -10
- package/dist/route-types-Id82-veQ.mjs +280 -0
- package/dist/{local-d1-D2I6Ox5F.mjs → runner-BGVsGgkb.mjs} +6 -114
- package/dist/runner-CQs_cDSG.mjs +2 -0
- package/dist/runner-mysql-1o47achK.mjs +2 -0
- package/dist/{runner-mysql-7BPUNGmL.mjs → runner-mysql-BhwMk2Bm.mjs} +2 -9
- package/dist/{runner-pg-BkEza-dX.mjs → runner-pg-CJ_JeGF6.mjs} +2 -9
- package/dist/runner-pg-D7z01mQS.mjs +2 -0
- package/dist/runtime/ai.mjs +1 -1
- package/dist/runtime/auth-client-react.d.mts +2 -6
- package/dist/runtime/auth-client-react.mjs +1 -5
- package/dist/runtime/auth-client-solid.d.mts +2 -6
- package/dist/runtime/auth-client-solid.mjs +1 -5
- package/dist/runtime/auth-client-svelte.d.mts +2 -6
- package/dist/runtime/auth-client-svelte.mjs +1 -5
- package/dist/runtime/auth-client-vue.d.mts +2 -6
- package/dist/runtime/auth-client-vue.mjs +1 -5
- package/dist/runtime/auth-client.d.mts +2 -6
- package/dist/runtime/auth-client.mjs +1 -5
- package/dist/runtime/auth.mjs +1 -21
- package/dist/runtime/better-auth-mysql.d.mts +1 -1
- package/dist/runtime/better-auth-mysql.mjs +1 -1
- package/dist/runtime/better-auth-pg.d.mts +1 -1
- package/dist/runtime/better-auth-pg.mjs +1 -1
- package/dist/runtime/better-auth.d.mts +1 -1
- package/dist/runtime/better-auth.mjs +1 -1
- package/dist/runtime/client-react.d.mts +3 -3
- package/dist/runtime/client-react.mjs +3 -3
- package/dist/runtime/client-solid.d.mts +3 -3
- package/dist/runtime/client-solid.mjs +3 -3
- package/dist/runtime/client-svelte.d.mts +3 -3
- package/dist/runtime/client-svelte.mjs +3 -3
- package/dist/runtime/client-vue.d.mts +3 -3
- package/dist/runtime/client-vue.mjs +3 -3
- package/dist/runtime/client.d.mts +3 -3
- package/dist/runtime/client.mjs +3 -3
- package/dist/runtime/db.mjs +1 -1
- package/dist/runtime/durable.mjs +1 -1
- package/dist/runtime/email/testing.mjs +1 -1
- package/dist/runtime/env-helpers.mjs +1 -135
- package/dist/runtime/env-public-client.mjs +1 -1
- package/dist/runtime/env-public.mjs +2 -2
- package/dist/runtime/env.mjs +1 -77
- package/dist/runtime/fetch-stream.d.mts +2 -49
- package/dist/runtime/fetch-stream.mjs +2 -80
- package/dist/runtime/fetch.d.mts +2 -57
- package/dist/runtime/fetch.mjs +2 -17
- package/dist/runtime/handler.d.mts +1 -1
- package/dist/runtime/handler.mjs +1 -149
- package/dist/runtime/kv.mjs +1 -1
- package/dist/runtime/live-client.d.mts +1 -1
- package/dist/runtime/live-server.mjs +2 -2
- package/dist/runtime/live.d.mts +2 -104
- package/dist/runtime/live.mjs +1 -410
- package/dist/runtime/migration-handler-mysql.d.mts +1 -1
- package/dist/runtime/migration-handler-pg.d.mts +1 -1
- package/dist/runtime/migration-handler.d.mts +2 -50
- package/dist/runtime/queues.d.mts +2 -6
- package/dist/runtime/queues.mjs +1 -1
- package/dist/runtime/response.mjs +1 -29
- package/dist/runtime/sandbox.mjs +1 -1
- package/dist/runtime/sse.mjs +1 -171
- package/dist/runtime/storage.mjs +1 -1
- package/dist/runtime/validator.d.mts +1 -1
- package/dist/runtime/validator.mjs +1 -71
- package/dist/runtime/ws-server.d.mts +2 -2
- package/dist/runtime/ws-server.mjs +2 -2
- package/dist/runtime/ws.d.mts +2 -121
- package/dist/{scan-CpK-57ug.mjs → scan-DJbooZm2.mjs} +3 -3
- package/dist/{scan-BMH4rzlv.mjs → scan-DdDvRCU1.mjs} +8 -26
- package/dist/{secret-AcPi-FoA.mjs → secret-UtrRjhEO.mjs} +8 -6
- package/dist/serialize-BPvnNQuA.mjs +14 -0
- package/dist/serialize-CfSwWfF2.d.mts +10 -0
- package/dist/{skills-C0RvGjeE.mjs → skills-B-690E7h.mjs} +3 -2
- package/dist/sse-BaC1jXko.mjs +172 -0
- package/dist/{subcommand-prompt-Bmyn5Rlc.mjs → subcommand-prompt-BuGYkAkC.mjs} +2 -1
- package/dist/sveltekit.d.mts +2 -1
- package/dist/sveltekit.mjs +3 -2
- package/dist/validate-DqJ33oHj.mjs +2 -0
- package/dist/validate-qNhV00PD.mjs +180 -0
- package/dist/validator-BTOu0fB0.mjs +72 -0
- package/dist/{wrangler--imS8n0d.mjs → wrangler-D01qs6VB.mjs} +259 -71
- package/dist/ws-BwcqizuH.d.mts +122 -0
- package/dist/{yarn-pnp-DxSInkzL.mjs → yarn-pnp-CVEc3gE7.mjs} +1 -1
- package/package.json +19 -8
- package/skills/void/SKILL.md +6 -4
- package/skills/void/docs/guide/ai.md +3 -3
- package/skills/void/docs/guide/app-types.md +12 -11
- package/skills/void/docs/guide/auth.md +2 -2
- package/skills/void/docs/guide/database/d1.md +1 -1
- package/skills/void/docs/guide/database/mysql.md +1 -1
- package/skills/void/docs/guide/database/postgresql.md +3 -3
- package/skills/void/docs/guide/deployment.md +8 -15
- package/skills/void/docs/guide/durable-state.md +2 -2
- package/skills/void/docs/guide/edge/headers.md +3 -3
- package/skills/void/docs/guide/edge/prerendering.md +1 -1
- package/skills/void/docs/guide/edge/redirects.md +4 -4
- package/skills/void/docs/guide/edge/revalidation.md +6 -6
- package/skills/void/docs/guide/edge/rewrites.md +28 -27
- package/skills/void/docs/guide/edge/static-assets.md +1 -1
- package/skills/void/docs/guide/email.md +60 -66
- package/skills/void/docs/guide/env-migration.md +1 -1
- package/skills/void/docs/guide/index.md +15 -41
- package/skills/void/docs/guide/pages-routing/head.md +1 -1
- package/skills/void/docs/guide/platform/administration/access.md +13 -5
- package/skills/void/docs/guide/platform/administration/projects.md +3 -1
- package/skills/void/docs/guide/platform/installation/ci.md +3 -0
- package/skills/void/docs/guide/platform/installation/credentials.md +15 -5
- package/skills/void/docs/guide/platform/installation/prerequisites.md +2 -0
- package/skills/void/docs/guide/platform/installation/setup.md +1 -1
- package/skills/void/docs/guide/quickstart.md +11 -78
- package/skills/void/docs/guide/remote-dev.md +2 -2
- package/skills/void/docs/guide/sandboxes.md +1 -1
- package/skills/void/docs/guide/ssg.md +1 -1
- package/skills/void/docs/guide/websockets.md +1 -1
- package/skills/void/docs/index.md +17 -17
- package/skills/void/docs/integrations/cloudflare.md +91 -96
- package/skills/void/docs/integrations/frameworks/analog.md +14 -9
- package/skills/void/docs/integrations/frameworks/astro.md +14 -10
- package/skills/void/docs/integrations/frameworks/nuxt.md +14 -9
- package/skills/void/docs/integrations/frameworks/overview.md +35 -29
- package/skills/void/docs/integrations/frameworks/react-router.md +1 -1
- package/skills/void/docs/integrations/frameworks/sveltekit.md +33 -30
- package/skills/void/docs/integrations/frameworks/tanstack-start.md +1 -1
- package/skills/void/docs/integrations/nodejs-bun-deno.md +5 -5
- package/skills/void/docs/reference/api.md +21 -4
- package/skills/void/docs/reference/cli.md +40 -25
- package/skills/void/docs/reference/config.md +58 -35
- package/skills/void/docs/reference/structure.md +2 -2
- package/dist/validate-tBBN_dXH.mjs +0 -505
|
@@ -30,26 +30,20 @@ if (!result.ok) {
|
|
|
30
30
|
}
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
|
|
34
|
-
unconditionally throws on the second — and the second is the one a new project
|
|
35
|
-
hits first, because a recipient you have not verified yet fails per-recipient.
|
|
33
|
+
Check both failure shapes: `result.error` reports a request failure, while `result.deliveries` reports failures for individual recipients. An unverified recipient fails in `deliveries`.
|
|
36
34
|
|
|
37
35
|
## Setup
|
|
38
36
|
|
|
39
|
-
On a platform with email enabled, your
|
|
40
|
-
`void deploy`. Ask your administrator for the platform's shared mail domain. A
|
|
41
|
-
self-hosted administrator [enables email during installation or upgrade](/guide/platform/installation/credentials#runtime-token-permissions); installations without it do not offer platform email. Void Cloud uses `mail.void.cloud`.
|
|
37
|
+
On a platform with email enabled, deploy without additional email configuration. Ask your administrator for its shared mail domain. Administrators [enable email during installation or upgrade](/guide/platform/installation/credentials#runtime-token-permissions); Void Cloud uses `mail.void.cloud`.
|
|
42
38
|
|
|
43
39
|
Each project on an email-enabled platform has:
|
|
44
40
|
|
|
45
|
-
- **
|
|
46
|
-
- **
|
|
47
|
-
platform `send_email` binding. Your worker never gets one, so there is nothing to configure.
|
|
48
|
-
- **Your own address as a recipient** — the email on your Void account is registered as a recipient when the project is created. It is verified at once when Cloudflare already holds it verified for the platform (you clicked its link for an earlier project of yours); otherwise Cloudflare mails it a verification link, and until you click that link and run `void email destinations` — the listing is what records the click — a send to yourself comes back `ok: false` with a per-recipient `UNVERIFIED_DESTINATION` in `result.deliveries`.
|
|
41
|
+
- **Default sender:** `<your-slug>+noreply@<mail-domain>`. Older projects with slugs longer than 56 characters must pass `from` explicitly.
|
|
42
|
+
- **Your account email as a recipient:** it is registered when the project is created. If Cloudflare has not verified it for the platform, follow the emailed verification link and run `void email destinations` before sending to it.
|
|
49
43
|
|
|
50
|
-
|
|
44
|
+
The shared sender can send only to verified recipients. Verify your own address or [add another recipient](#adding-recipients) before sending.
|
|
51
45
|
|
|
52
|
-
Deploying to your own Cloudflare account instead (`void deploy --platform cloudflare`) takes one line of `void.
|
|
46
|
+
Deploying to your own Cloudflare account instead (`void deploy --platform cloudflare`) takes one line of `void.config.ts` and one Enter on the first deploy — see [Your own Cloudflare account](#your-own-cloudflare-account).
|
|
53
47
|
|
|
54
48
|
## Adding recipients
|
|
55
49
|
|
|
@@ -68,9 +62,9 @@ void email destinations
|
|
|
68
62
|
The project owner's account email is added automatically when the project is created on an email-enabled platform, so it skips `void email allow` — not the verification. See [Setup](#setup) for when it is verified at once and when there is a link to click.
|
|
69
63
|
|
|
70
64
|
::: warning When this is the right fit
|
|
71
|
-
The shared sender
|
|
65
|
+
The shared sender suits team alerts, project notifications, and replies to inbound mail.
|
|
72
66
|
|
|
73
|
-
For
|
|
67
|
+
For mail to arbitrary users, [register your own domain](#your-own-domain-on-the-platform), use [Workers Paid on your own Cloudflare account](#your-own-cloudflare-account), or call another email provider from your handler.
|
|
74
68
|
:::
|
|
75
69
|
|
|
76
70
|
## Your own domain on the platform
|
|
@@ -120,13 +114,13 @@ On an administrator-managed platform, `add` prints the administrator command for
|
|
|
120
114
|
| `attachments` | `Attachment[]` | See [Attachments](#attachments). |
|
|
121
115
|
| `idempotencyKey` | `string` | Optional on the Void Platform: 1–128 printable, non-space ASCII characters. Reuse for retries of the same send. |
|
|
122
116
|
|
|
123
|
-
|
|
117
|
+
You can send to at most 50 recipients across `to`, `cc`, and `bcc`. Addresses must have an ASCII local part of at most 64 characters and a dotted domain; the whole address can be at most 254 characters. Quoted local parts, `user@localhost`, and malformed dots are rejected. Use punycode for internationalized domains. Void returns `INVALID_TO` for an invalid `to`, `INVALID_FROM` for `from`, and `MIME_ERROR` for `cc`, `bcc`, `replyTo`, or invalid custom header names.
|
|
124
118
|
|
|
125
119
|
`Address` accepts either a string (`"hello@acme.dev"` or `"Name <hello@acme.dev>"`) or an object (`{ email, name? }`). Display names with non-ASCII characters are RFC 2047 encoded automatically.
|
|
126
120
|
|
|
127
121
|
On the platform the sender is pinned to your project. `from` must be your project's own platform address — `<project-slug>@<mail-domain>` or `<project-slug>+<tag>@<mail-domain>`, optionally with a display name — or any address on a domain registered with `void email domain add` (see [Your own domain on the platform](#your-own-domain-on-the-platform)). For example, if your platform's mail domain is `mail.example.com`, you can use `Acme <acme+noreply@mail.example.com>`. Anything else is rejected with `INVALID_FROM`. Omit `from` and Void fills in `<project-slug>+noreply@<mail-domain>` for you.
|
|
128
122
|
|
|
129
|
-
On your own Cloudflare account, `from` defaults to `email.from` from `void.
|
|
123
|
+
On your own Cloudflare account, `from` defaults to `email.from` from `void.config.ts` and must be on a domain your account can send from; Cloudflare rejects any other sender and `sendEmail` reports it as `INVALID_FROM`.
|
|
130
124
|
|
|
131
125
|
## Attachments
|
|
132
126
|
|
|
@@ -164,7 +158,7 @@ await sendEmail({
|
|
|
164
158
|
});
|
|
165
159
|
```
|
|
166
160
|
|
|
167
|
-
`contentType`
|
|
161
|
+
Void infers `contentType` from the filename if you omit it. An explicit value must be a valid media type. `contentId` names the image referenced by `cid:<id>` in HTML; use an ID such as `logo` or `logo@acme.dev`. The encoded message is limited to 5 MiB and custom headers to 16 KiB. Invalid attachment fields or oversized messages return `MIME_ERROR`.
|
|
168
162
|
|
|
169
163
|
## Result and errors
|
|
170
164
|
|
|
@@ -207,7 +201,7 @@ For 30 days, repeating a key with the same payload returns its recorded outcome
|
|
|
207
201
|
| `OUTCOME_UNKNOWN` | The send may have reached the provider; do not blindly resend. |
|
|
208
202
|
| `UPSTREAM_ERROR` | The provider or platform refused the request. |
|
|
209
203
|
|
|
210
|
-
The default platform allowance is 200 recipient submissions per UTC
|
|
204
|
+
The default platform allowance is 200 recipient submissions per UTC month and 10 per rolling minute. Reserved and started submissions count toward the limits; a started attempt stays charged even if it fails or its outcome is unknown. Administrators can change these limits.
|
|
211
205
|
|
|
212
206
|
`void email usage` shows monthly recipient attempts, inbound receipts, and the remaining allowance. `void email logs --limit 50` shows up to 100 recent metadata entries retained for 30 days: operation, recipient, direction, state, provider reference, and error code. It does not store subjects, bodies, or attachments. Receiving a message and sending a reply are separate events.
|
|
213
207
|
|
|
@@ -233,13 +227,11 @@ curl -X DELETE http://localhost:5173/__void/inbox \
|
|
|
233
227
|
-H "x-void-dev-trigger: <printed-token>"
|
|
234
228
|
```
|
|
235
229
|
|
|
236
|
-
The
|
|
230
|
+
The inbox keeps the most recent 100 messages through HMR and clears on a full server restart.
|
|
237
231
|
|
|
238
|
-
|
|
232
|
+
The dev inbox works in native Void apps, TanStack Start, and React Router. It is unavailable in SvelteKit, Nuxt, Analog, and Astro; sends from those apps return `BINDING_MISSING`. Use `createEmailTestHarness` from `void/email/testing` to capture sends in tests. If a configured inbox cannot be reached, `sendEmail` returns `UPSTREAM_ERROR` without sending.
|
|
239
233
|
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
`sendInDev: true` bypasses the dev inbox for a single send. `void dev` binds no send transport at all — the platform's `__VOID_PROXY` service binding is added only on a deployed worker, and the own-account `SEND_EMAIL` binding is stripped under `serve` so miniflare cannot write stray `.eml` files or send real mail (only that entry: a `send_email` binding of your own under another name is left exactly as `wrangler.jsonc` declares it). With the inbox skipped there is nothing left to fall through to, so the call returns `BINDING_MISSING`: it proves the inbox was bypassed, it does not deliver. To verify real delivery, deploy and send from the deployed worker.
|
|
234
|
+
`sendInDev: true` skips the inbox for one call. It returns `BINDING_MISSING` in `void dev` because no live send transport is bound. Deploy the app to test real delivery.
|
|
243
235
|
|
|
244
236
|
```ts
|
|
245
237
|
const result = await sendEmail({
|
|
@@ -362,7 +354,7 @@ export default defineEmail(async (message, env, ctx, info) => {
|
|
|
362
354
|
|
|
363
355
|
`replyEmail` builds the reply MIME with `Subject: Re: <original>` (no double-prefix), `In-Reply-To: <Message-ID>`, and a continued `References` chain, then dispatches through the message's `reply()`. Defaults: `to = message.from`, `subject = "Re: <original>"`.
|
|
364
356
|
|
|
365
|
-
|
|
357
|
+
Void uses the inbound message's `Message-ID` and `References` when they fit in reply headers. It drops unusable values and falls back to a bare `Re:` for a subject it cannot safely reuse. Pass `subject` to set it explicitly.
|
|
366
358
|
|
|
367
359
|
On the platform, shared-domain replies default to
|
|
368
360
|
`<slug>+noreply@<mail domain>`. For mail received at a registered custom domain,
|
|
@@ -408,7 +400,7 @@ deployed `email/` handlers without per-project DNS setup. A
|
|
|
408
400
|
handlers once its inbound readiness is `ready`. Use `void email domain status`
|
|
409
401
|
to check current provider routing and any remaining setup steps.
|
|
410
402
|
|
|
411
|
-
On your own Cloudflare account there is no shared facility: the deploy derives one Email Routing rule per handler and
|
|
403
|
+
On your own Cloudflare account there is no shared facility: the deploy derives one Email Routing rule per handler and records it in `void.lock.json` for you — see [Your own Cloudflare account](#your-own-cloudflare-account).
|
|
412
404
|
|
|
413
405
|
There is no local inbound trigger yet — `void dev` serves the outbound dev inbox only, so test inbound handlers with `createInboundTestHarness` below.
|
|
414
406
|
|
|
@@ -474,31 +466,31 @@ The harness uses the same precedence rules as the production dispatcher. Reserve
|
|
|
474
466
|
|
|
475
467
|
## Your own Cloudflare account
|
|
476
468
|
|
|
477
|
-
|
|
469
|
+
For direct Cloudflare deployment, set a sender address on a zone you own. Void checks the zone and asks before changing its email settings.
|
|
470
|
+
|
|
471
|
+
### Setup
|
|
478
472
|
|
|
479
|
-
|
|
473
|
+
1. Set the default sender and mail domain in `void.config.ts`:
|
|
480
474
|
|
|
481
|
-
|
|
475
|
+
```ts
|
|
476
|
+
import { defineConfig } from 'void/config';
|
|
482
477
|
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
"from": "Acme <support@mail.acme.com>"
|
|
487
|
-
}
|
|
488
|
-
}
|
|
478
|
+
export default defineConfig({
|
|
479
|
+
email: { from: 'Acme <support@mail.acme.com>' },
|
|
480
|
+
});
|
|
489
481
|
```
|
|
490
482
|
|
|
491
|
-
The host (`mail.acme.com`) must be a zone in
|
|
483
|
+
The host (`mail.acme.com`) must be a zone in your selected Cloudflare account or a subdomain of one. If you omit `email.from`, Void deploys without email and tells you to set it. It does not choose a zone for you.
|
|
492
484
|
|
|
493
|
-
2.
|
|
485
|
+
2. Run `void cloudflare login`, or set `CLOUDFLARE_API_TOKEN` with **Email Routing Edit** and **Email Sending Edit** permissions in addition to deploy permissions. If an older browser session lacks email scopes, log out and sign in again. Void names missing token permissions in its checklist. Global API Keys are not supported for email setup.
|
|
494
486
|
|
|
495
487
|
### The first deploy
|
|
496
488
|
|
|
497
|
-
Before
|
|
489
|
+
Before building, Void checks the zone, DNS, routing rules, and sending status. It shows a checklist of the changes it would make:
|
|
498
490
|
|
|
499
491
|
```
|
|
500
492
|
Email in use email/support+[ticket].ts · email/_default.ts · sendEmail() in 2 files
|
|
501
|
-
domain mail.acme.com (void.
|
|
493
|
+
domain mail.acme.com (void.config.ts email.from)
|
|
502
494
|
zone acme.com account Acme (f721b8e5…) · session dev@acme.com
|
|
503
495
|
apex MX aspmx.l.google.com left alone — mail lives on the subdomain
|
|
504
496
|
routing mail.acme.com not enabled · subaddressing off
|
|
@@ -511,14 +503,14 @@ Before any of your project code runs, the deploy **reads** — the session, the
|
|
|
511
503
|
+ enable Email Routing on mail.acme.com Cloudflare writes and locks 3 MX + 1 SPF record there
|
|
512
504
|
+ turn on subaddressing for acme.com support+anything@ reaches support@
|
|
513
505
|
+ onboard mail.acme.com for Email Sending MX/SPF/DKIM on cf-bounce.mail.acme.com, _dmarc.mail.acme.com (p=reject)
|
|
514
|
-
+
|
|
506
|
+
+ Cloudflare config send_email: [{ name: "SEND_EMAIL" }], addresses: ["support@mail.acme.com"], vars.__VOID_EMAIL_FROM: "noreply@mail.acme.com"
|
|
515
507
|
+ routing rule (created on deploy) support@mail.acme.com → acme-support
|
|
516
508
|
! email/_default.ts a catch-all exists only on an apex; other @mail.acme.com mail bounces
|
|
517
509
|
|
|
518
510
|
◆ Set up email on mail.acme.com? ● Yes / ○ No
|
|
519
511
|
```
|
|
520
512
|
|
|
521
|
-
|
|
513
|
+
Accepting the prompt applies the missing setup, builds and deploys your app, then shows its email address map:
|
|
522
514
|
|
|
523
515
|
```
|
|
524
516
|
✔ deployed acme-support
|
|
@@ -526,13 +518,13 @@ Enter (Yes is the default) applies only the `+` rows that are not ready, then th
|
|
|
526
518
|
outbound sendEmail() from support@mail.acme.com
|
|
527
519
|
```
|
|
528
520
|
|
|
529
|
-
|
|
521
|
+
Later deploys skip the prompt when setup is ready. Declining before any setup is saved deploys without email.
|
|
530
522
|
|
|
531
523
|
DNS can take a few minutes to become visible to the resolver running the deploy. If `void email setup` has already written the exact `addresses` plan but that resolver still sees no subdomain MX, Void preserves the plan and stops before the build or upload. Run `void email status --platform cloudflare`, then retry the deploy after it sees Cloudflare's MX records.
|
|
532
524
|
|
|
533
|
-
|
|
525
|
+
Void updates the configured addresses when handlers change and keeps the default sender in sync with `email.from`. `void email setup` records the setup; the next deploy creates routing rules and may mark them as `(rule created by this deploy)` in the address map.
|
|
534
526
|
|
|
535
|
-
|
|
527
|
+
If Email Routing is off on the apex, Void does not enable it while setting up a subdomain; doing so could replace the apex's live mail records. The checklist directs you to **Email → Settings → Subdomains** in the Cloudflare dashboard. Deploy does not add addresses until the subdomain is ready.
|
|
536
528
|
|
|
537
529
|
### Subdomain or apex
|
|
538
530
|
|
|
@@ -546,26 +538,30 @@ The apex path (`email.from` on `acme.com` itself) is allowed with the same one E
|
|
|
546
538
|
|
|
547
539
|
**Subaddressing** is a per-zone Cloudflare setting, and it is off by default. Until it is on, a rule for `support@mail.acme.com` does not match `support+T-42@mail.acme.com`. The checklist's `turn on subaddressing for acme.com` row flips it for the whole zone — on the apex and every subdomain — so `email/support+[ticket].ts` works the way it does on the platform.
|
|
548
540
|
|
|
549
|
-
### What Void
|
|
541
|
+
### What Void records in `void.lock.json`
|
|
542
|
+
|
|
543
|
+
The relevant fields appear under `resolved`:
|
|
550
544
|
|
|
551
545
|
```jsonc
|
|
552
546
|
{
|
|
553
|
-
"
|
|
554
|
-
|
|
555
|
-
|
|
547
|
+
"resolved": {
|
|
548
|
+
"send_email": [{ "name": "SEND_EMAIL" }],
|
|
549
|
+
"vars": { "__VOID_EMAIL_FROM": "Acme <support@mail.acme.com>" },
|
|
550
|
+
"addresses": ["support@mail.acme.com"],
|
|
551
|
+
},
|
|
556
552
|
}
|
|
557
553
|
```
|
|
558
554
|
|
|
559
|
-
- **`send_email`** — the binding `sendEmail()
|
|
560
|
-
- **`__VOID_EMAIL_FROM`** —
|
|
561
|
-
- **`addresses`** — derived from your `email/`
|
|
555
|
+
- **`send_email`** — the binding used by `sendEmail()`. An existing binding under another name must be renamed before Void can use it.
|
|
556
|
+
- **`__VOID_EMAIL_FROM`** — the default sender from `email.from`.
|
|
557
|
+
- **`addresses`** — addresses derived from your `email/` handlers. Deploy creates the corresponding Email Routing rules for this Worker.
|
|
562
558
|
|
|
563
|
-
|
|
559
|
+
Void derives `addresses` from your handlers on each deploy. If routing is not ready, it withholds the array and explains why. It also protects rules it does not own:
|
|
564
560
|
|
|
565
|
-
- An address
|
|
566
|
-
- If the array
|
|
561
|
+
- An address routed to another Worker or a forwarding rule is excluded and reported; Void leaves that rule alone.
|
|
562
|
+
- If the array contains addresses Void did not derive, deploy skips email setup and lists them. Remove them, or manage `addresses` yourself and leave `email.from` unset.
|
|
567
563
|
|
|
568
|
-
|
|
564
|
+
If you delete a handler, the next deploy reports its stale address and skips email setup until you set the desired `cloudflare.addresses` in `void.config.ts`. Removing a routing rule requires confirmation in a terminal and fails in CI without it. If you remove all email use, deploy keeps the existing setup and warns about remaining routes. To detach it, remove `addresses`, `send_email`, and `vars.__VOID_EMAIL_FROM` from `resolved` in `void.lock.json`, remove any authored overrides in `void.config.ts`, then delete the routing rules in Cloudflare.
|
|
569
565
|
|
|
570
566
|
How handlers become addresses, with `email.from` on `mail.acme.com` under the zone `acme.com`:
|
|
571
567
|
|
|
@@ -581,9 +577,9 @@ Inside the worker, a message reaches your handlers exactly as addressed — `sup
|
|
|
581
577
|
|
|
582
578
|
### Sending
|
|
583
579
|
|
|
584
|
-
`sendEmail()` uses the
|
|
580
|
+
`sendEmail()` uses the Worker's `SEND_EMAIL` binding. Cloudflare's limits apply, with `QUOTA_EXCEEDED` on failure. The `void email usage`, `logs`, `destinations`, `allow`, and `disallow` commands are for Void platforms.
|
|
585
581
|
|
|
586
|
-
|
|
582
|
+
Email setup covers both inbound and outbound mail for the domain, even if your app uses only one. Cloudflare meters outbound messages; `replyEmail` uses Email Routing and does not need Email Sending onboarding.
|
|
587
583
|
|
|
588
584
|
Who you can send to depends on your Workers plan. Onboarding the mail domain for Email Sending is what allows **arbitrary recipients**, and it needs **Workers Paid** — billing is dashboard-only, so Void cannot do that for you. On Workers Free the onboarding row fails and the deploy prints:
|
|
589
585
|
|
|
@@ -593,35 +589,33 @@ Workers Paid needed for arbitrary recipients. Inbound works; sendEmail() to veri
|
|
|
593
589
|
|
|
594
590
|
Everything else — routing, rules, the binding — still goes through, and the address map ends with `outbound sendEmail() from support@mail.acme.com (verified destinations only)`. Verified destinations are the addresses under **Email Routing → Destination addresses** in your Cloudflare dashboard; a handler that `forward()`s to a new address needs the same verification click.
|
|
595
591
|
|
|
596
|
-
|
|
592
|
+
Void remembers when Email Sending onboarding was refused. Later deploys keep inbound mail and sends to verified destinations working; this state also satisfies `--require-email`. Void does not retry onboarding automatically. After upgrading to Workers Paid, run `void email setup --platform cloudflare` to enable arbitrary recipients. `void email status --platform cloudflare` shows whether sending is still limited to verified destinations.
|
|
597
593
|
|
|
598
594
|
If `_dmarc.mail.acme.com` or `cf-bounce.mail.acme.com` already has a TXT record, sending onboarding is refused — it writes its own `_dmarc` (`p=reject`) and DKIM records and Cloudflare would answer with a conflict. Inbound is unaffected; remove the records or keep sending off.
|
|
599
595
|
|
|
600
596
|
### CI
|
|
601
597
|
|
|
602
|
-
|
|
598
|
+
In CI or when input or output is redirected, Void cannot prompt. If email is not ready, it prints the checklist and:
|
|
603
599
|
|
|
604
600
|
```
|
|
605
601
|
deploy: email on mail.acme.com is not set up, and this shell cannot ask.
|
|
606
|
-
Run `void email setup --platform cloudflare` once locally, commit
|
|
602
|
+
Run `void email setup --platform cloudflare` once locally, commit void.lock.json, then redeploy — deploying without email.
|
|
607
603
|
```
|
|
608
604
|
|
|
609
|
-
then deploys
|
|
605
|
+
Void then deploys without email. Pass `--require-email` to fail instead. If setup has recorded the subdomain addresses but its MX records are not visible yet, deploy stops until DNS can be verified. Check progress with `void email status --platform cloudflare`.
|
|
610
606
|
|
|
611
|
-
|
|
607
|
+
For CI, run `void email setup --platform cloudflare` once locally and commit `void.lock.json`. Then run `void deploy --platform cloudflare --require-email` in CI. After DNS is ready, later deploys need no prompt. Workers Free can still send to verified destinations; see [Sending](#sending).
|
|
612
608
|
|
|
613
609
|
### If the subdomain step is refused
|
|
614
610
|
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
When either call is refused, or the token cannot be read, the deploy does not fail. It prints what Cloudflare answered and the one-time dashboard step:
|
|
611
|
+
If Cloudflare refuses subdomain routing or subaddressing, Void prints the response and the dashboard step to complete:
|
|
618
612
|
|
|
619
613
|
```
|
|
620
614
|
✘ routing mail.acme.com: Cloudflare answered 403 …
|
|
621
615
|
Cloudflare dashboard → your zone → Email → Settings → Subdomains → add the subdomain, then redeploy
|
|
622
616
|
```
|
|
623
617
|
|
|
624
|
-
|
|
618
|
+
Void withholds the addresses until routing is ready. Complete the dashboard step and deploy again.
|
|
625
619
|
|
|
626
620
|
### What stays manual
|
|
627
621
|
|
|
@@ -631,4 +625,4 @@ and **withholds `addresses` for that run** — no routing rule is created, so no
|
|
|
631
625
|
4. Workers Paid, if you need `sendEmail()` to arbitrary recipients.
|
|
632
626
|
5. A verification click when a handler `forward()`s to a new destination.
|
|
633
627
|
6. The Subdomains form in the dashboard, only if the subdomain step above is refused.
|
|
634
|
-
7.
|
|
628
|
+
7. Confirmation when a deploy would delete a routing rule.
|
|
@@ -80,7 +80,7 @@ void secret list
|
|
|
80
80
|
|
|
81
81
|
Remote stores return names only; plaintext values are validated during upload and again at worker startup. If an upload fails or a name is missing, retain the source values and retry before continuing.
|
|
82
82
|
|
|
83
|
-
For direct Cloudflare deployments, remove the migrated server keys from `vars` in `
|
|
83
|
+
For direct Cloudflare deployments, remove the migrated server keys from `cloudflare.vars` in `void.config.ts` after confirming the upload. Void now treats any schema-declared server key in Worker `vars` as an error.
|
|
84
84
|
|
|
85
85
|
## 4. Supply client values at build time
|
|
86
86
|
|
|
@@ -4,52 +4,32 @@ outline: deep
|
|
|
4
4
|
|
|
5
5
|
# What is Void?
|
|
6
6
|
|
|
7
|
-
Void
|
|
7
|
+
Void adds server routes, typed data access, and deployment to Vite apps. Native Void apps run on Cloudflare Workers. You can also use Void with a [supported framework](../integrations/frameworks/overview).
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Start with the [Quickstart](./quickstart) to create an app, run it locally, and deploy it.
|
|
10
10
|
|
|
11
11
|
The CLI and build tools require Node.js 24.21.0 or later.
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
npm install -D vite void
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
```ts
|
|
18
|
-
import { defineConfig } from 'vite';
|
|
19
|
-
import { voidPlugin } from 'void';
|
|
20
|
-
|
|
21
|
-
export default defineConfig({
|
|
22
|
-
plugins: [voidPlugin()],
|
|
23
|
-
});
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
```sh
|
|
27
|
-
void init # choose your framework and deployment target
|
|
28
|
-
void deploy
|
|
29
|
-
```
|
|
13
|
+
## Resources from your code
|
|
30
14
|
|
|
31
|
-
|
|
15
|
+
Import `db` from `void/db`, and Void provides a local database and provisions one for deployment. The same pattern applies to KV, object storage, queues, and AI. Configure resources explicitly when you need to use existing infrastructure.
|
|
32
16
|
|
|
33
|
-
Your
|
|
17
|
+
Your Drizzle schema defines database types. Route handlers infer return types, and the [typed fetch client](./typed-fetch.md) checks calls from the frontend. Changing a field shows you which callers need to change.
|
|
34
18
|
|
|
35
|
-
|
|
19
|
+
Void connects these parts of your app:
|
|
36
20
|
|
|
37
|
-
|
|
21
|
+
- [Server routes](./server-routing.md) and [pages](./pages-routing/overview.md) for your app's backend and UI
|
|
22
|
+
- [Database](./database.md), [KV](./kv.md), and [storage](./storage.md) that work locally and in production
|
|
23
|
+
- [Standard Schema](https://standardschema.dev/) validation for runtime values and TypeScript types
|
|
24
|
+
- `void deploy` to build, apply migrations, provision resources, and deploy
|
|
38
25
|
|
|
39
|
-
|
|
40
|
-
- **Types from database to frontend:** your Drizzle schema defines DB types, route handlers infer return types, and the [typed fetch client](./typed-fetch.md) checks calls at the usage site. One [Standard Schema](https://standardschema.dev/) validator can drive both runtime validation and compile-time types.
|
|
41
|
-
- **Local Cloudflare development:** native Void apps run server code in `workerd`, with local database, KV, and storage.
|
|
42
|
-
- **Deploy that understands the app:** `void deploy` reads your migrations, provisions the resources you actually use, and ships the result to the edge.
|
|
26
|
+
## Deployment targets
|
|
43
27
|
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
Void deploys to [Cloudflare Workers](https://developers.cloudflare.com/workers/). You can use your own Cloudflare account or connect to a Void platform managed by your team. Both use the same SDK and CLI.
|
|
28
|
+
Deploy to [your own Cloudflare account](../integrations/cloudflare.md#deploy-to-your-own-cloudflare-account) or to a [Void platform](./self-hosted-platform.md) run by your team. Both use the same SDK and CLI.
|
|
47
29
|
|
|
48
30
|
[Static assets](./edge/static-assets) are cached at the edge. [Prerendering](./edge/prerendering) builds pages ahead of time, while [incremental revalidation](./edge/revalidation) caches pages rendered on demand. Database, storage, secrets, and deployment commands are available through Void.
|
|
49
31
|
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
## How it works
|
|
32
|
+
## How resource detection works
|
|
53
33
|
|
|
54
34
|
```
|
|
55
35
|
vite.config.ts → voidPlugin() (works with any Vite app)
|
|
@@ -58,17 +38,11 @@ import { kv } → KV namespace (auto-provisioned)
|
|
|
58
38
|
import { storage } → R2 bucket (auto-provisioned)
|
|
59
39
|
import { ai } → Workers AI inference (metered)
|
|
60
40
|
db/schema.ts → Drizzle schema (source of truth for DB types)
|
|
61
|
-
db/migrations/*.sql → Applied to
|
|
41
|
+
db/migrations/*.sql → Applied to the selected database on deploy
|
|
62
42
|
void deploy → Deploy to the saved Cloudflare or Void target
|
|
63
43
|
```
|
|
64
44
|
|
|
65
|
-
The plugin
|
|
66
|
-
|
|
67
|
-
Void also works with existing frameworks. [TanStack Start](/integrations/frameworks/tanstack-start), [React Router](/integrations/frameworks/react-router), [SvelteKit](/integrations/frameworks/sveltekit), [Nuxt](/integrations/frameworks/nuxt), and [Astro](/integrations/frameworks/astro) can all deploy with the same `voidPlugin()`.
|
|
68
|
-
|
|
69
|
-
If you are building a full-stack app without a meta-framework, Void also gives you [file-based server routing](./server-routing) with method exports, dynamic params, middleware, and validation. It also includes [pages routing](./pages-routing/overview) for server-rendered UI, SPA navigation, co-located data loading, and typed forms across React, Vue, Svelte, and Solid.
|
|
70
|
-
|
|
71
|
-
Void detects your [app type](./app-types) and chooses the appropriate build and deployment flow.
|
|
45
|
+
The Vite plugin detects supported imports and adds the corresponding bindings. Void also detects your [app type](./app-types) to choose the build and deployment flow. Use `void.config.ts` when you need to control either choice.
|
|
72
46
|
|
|
73
47
|
## Next steps
|
|
74
48
|
|
|
@@ -112,10 +112,12 @@ dashboard. Sign in again first if prompted, then authenticate with the additiona
|
|
|
112
112
|
provider and confirm the identity shown. Matching email addresses alone do not
|
|
113
113
|
link accounts.
|
|
114
114
|
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
115
|
+
In the admin dashboard, open **People → Access** to choose who can join, invite
|
|
116
|
+
people, and manage individual signup grants. Choose **Company-approved or
|
|
117
|
+
individually approved users** to create accounts automatically for people who
|
|
118
|
+
meet your configured company rules while still allowing explicit invitations
|
|
119
|
+
and allowlist grants. Company protection at the platform edge still applies
|
|
120
|
+
before anyone reaches a login page.
|
|
119
121
|
|
|
120
122
|
With invited/allowlisted signup selected, let a teammate join with GitHub by adding their login to the allowlist:
|
|
121
123
|
|
|
@@ -148,7 +150,13 @@ To invite someone else by email, use:
|
|
|
148
150
|
void platform invitation send alex@example.org
|
|
149
151
|
```
|
|
150
152
|
|
|
151
|
-
An invitation grants signup access
|
|
153
|
+
An invitation grants signup access for that exact email address. The person must
|
|
154
|
+
sign in with a login method that supplies the same verified email address.
|
|
155
|
+
When platform email delivery is configured, Void also sends connection
|
|
156
|
+
instructions. If delivery is unavailable or fails, the grant still works:
|
|
157
|
+
share the platform's `/invite` page or `void connect '<platform URL>'` command
|
|
158
|
+
with the person yourself. The admin dashboard shows the delivery outcome
|
|
159
|
+
separately from the invitation's pending, accepted, or revoked status.
|
|
152
160
|
|
|
153
161
|
Inspect the current access settings and invitations with:
|
|
154
162
|
|
|
@@ -23,9 +23,11 @@ void platform project show <project-id>
|
|
|
23
23
|
|
|
24
24
|
Project details include resources, domains, and recent builds and deployments. The [command reference](/reference/cli#operator-commands) also covers suspending and restoring users, deleting projects, and removing accounts.
|
|
25
25
|
|
|
26
|
+
In the admin dashboard, open a project to view its team. Search for a platform user and choose a role to add them immediately; an email address is not required. You can also change or remove existing members. Pending invitations created through other project workflows remain visible until accepted or revoked. If email is unavailable for a pending invitation, share its ID so the user can accept it with `void project team accept <invitation-id>`. The owner cannot be removed from the team; transfer ownership first.
|
|
27
|
+
|
|
26
28
|
### Transferring Project Ownership
|
|
27
29
|
|
|
28
|
-
Only an installation administrator can change a project's owner. The new owner must already have an account on this platform.
|
|
30
|
+
Only an installation administrator can change a project's owner. The new owner must already have an account on this platform. In the dashboard, search for the new owner on the project page and preview the transfer before applying it. The CLI accepts a user ID:
|
|
29
31
|
|
|
30
32
|
```sh
|
|
31
33
|
void platform project owner <project-id> <new-owner-user-id> --plan
|
|
@@ -15,6 +15,9 @@ Inject the following values from protected CI secrets. Do not commit them in a w
|
|
|
15
15
|
| `CLOUDFLARE_API_TOKEN` | Management API token |
|
|
16
16
|
| `VOID_PLATFORM_RUNTIME_CLOUDFLARE_API_TOKEN` | Runtime API token |
|
|
17
17
|
| `VOID_PLATFORM_DATABASE_URL` | Dedicated PostgreSQL URL |
|
|
18
|
+
| `VOID_PLATFORM_HYPERDRIVE_ID` | Existing externally managed Hyperdrive ID, when applicable |
|
|
19
|
+
| `VOID_PLATFORM_HYPERDRIVE_ORIGIN_HOST` | Origin host of that Hyperdrive; set with its ID and user |
|
|
20
|
+
| `VOID_PLATFORM_HYPERDRIVE_ORIGIN_USER` | Runtime database user of that Hyperdrive; set with its ID and host |
|
|
18
21
|
| `VOID_PLATFORM_R2_ACCESS_KEY_ID` | R2 Access Key ID |
|
|
19
22
|
| `VOID_PLATFORM_R2_SECRET_ACCESS_KEY` | R2 Secret Access Key |
|
|
20
23
|
| `VOID_PLATFORM_JWT_SECRET` | Original JWT signing secret |
|
|
@@ -41,15 +41,25 @@ Use the following permissions for the core platform. Cloudflare may label write
|
|
|
41
41
|
|
|
42
42
|
The management token also needs **Zone Edit** with authority to create zones if you ask Void to create the zone. If it already exists, use the selected zone with Zone Read and DNS Edit. Nested application domains additionally need **SSL and Certificates: Read** on the management token. A custom runtime that enables custom project domains needs **SSL and Certificates: Edit** on the runtime token; the core runtime does not enable that feature.
|
|
43
43
|
|
|
44
|
-
|
|
44
|
+
Void checks access before provisioning. If it reports a missing permission, update the token's permissions for the selected account or zone and retry.
|
|
45
45
|
|
|
46
|
-
|
|
46
|
+
:::
|
|
47
47
|
|
|
48
|
-
|
|
48
|
+
## Enable Email {#enable-email}
|
|
49
49
|
|
|
50
|
-
|
|
50
|
+
Choose a shared sender domain and its Cloudflare zone ID. The mail zone may differ from the application zone, but it must belong to the platform's Cloudflare account. To enable email on an existing installation, run:
|
|
51
51
|
|
|
52
|
-
|
|
52
|
+
```sh
|
|
53
|
+
VOID_EMAIL_SENDER_DOMAIN=mail.example.com \
|
|
54
|
+
VOID_EMAIL_SHARED_ZONE_ID=your-zone-id \
|
|
55
|
+
void platform upgrade your-installation-id
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
Set the same two variables before `void platform install` to enable email during a new installation. Void records the pair for later upgrades; an ordinary upgrade cannot replace it.
|
|
59
|
+
|
|
60
|
+
Enabling email lets administrators [register email domains for projects](/guide/platform/administration/email#registering-email-domains-for-projects) and lets projects register destination addresses through the runtime token. That needs **Email Routing Addresses: Edit** and **Email Sending: Edit** on the account, plus **Zone: Read**, **Zone Settings: Edit** and **Email Routing Rules: Edit** on the zones that will carry mail. The runtime-token link preselects them when email is enabled. Email Sending onboarding for arbitrary recipients needs Workers Paid.
|
|
61
|
+
|
|
62
|
+
The installer deploys the email gateway, prepares the shared mail route, and verifies inbound readiness before opening platform traffic. If setup fails, correct the reported permission, mail-zone configuration, or routing conflict, then rerun the same install or upgrade command. A fresh install resumes with `void platform install --resume --name <installation-id>`.
|
|
53
63
|
|
|
54
64
|
## R2 Upload Credentials
|
|
55
65
|
|
|
@@ -84,3 +84,5 @@ Void does not require a particular database provider. Use an existing PostgreSQL
|
|
|
84
84
|
For a dedicated Supabase project, [disable the Data API](https://supabase.com/docs/guides/api/securing-your-api#disable-the-data-api) so the platform's tables are not exposed through Supabase's auto-generated endpoints. Void uses the PostgreSQL connection, not Supabase API keys.
|
|
85
85
|
|
|
86
86
|
Once installation claims the database, continue using that same database for resume and maintenance commands. Uninstall never deletes external PostgreSQL.
|
|
87
|
+
|
|
88
|
+
During interactive installation, choose whether Void creates Hyperdrive or uses one you manage separately. If you choose a separately managed Hyperdrive and none exists, Void gives you the required name and setup instructions, then stops so you can create it. Name it `void-<installation-name>-database`, point it at the same dedicated PostgreSQL database using a runtime user, and disable SQL result caching. See [Cloudflare's Hyperdrive setup guide](https://developers.cloudflare.com/hyperdrive/get-started/), or ask your organization's Hyperdrive administrator to create it. Rerun the installer; Void shows the matching Hyperdrive's database, host, port, and runtime user for confirmation. Paste a database owner connection into the PostgreSQL URL prompt for installation and migrations. Void verifies that Hyperdrive points to the same database and records its identity for later maintenance without taking ownership of it. For unattended installation, supply the existing Hyperdrive ID, origin host, and runtime user through the environment variables in [Install from CI](/guide/platform/installation/ci).
|
|
@@ -29,7 +29,7 @@ void platform install
|
|
|
29
29
|
|
|
30
30
|
:::
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
After `--plan`, run the install command printed at the end of the preview. Void recalculates the plan and asks you to confirm it; choose the same login methods again if you selected them interactively. Void then saves a local setup draft and opens the runtime-token page when that token is missing. Paste the token into the masked prompt. As you continue, it opens GitHub and R2 at their respective steps. Each page has a short checklist and a clickable fallback link in the terminal. Values already supplied through the environment or saved setup are reused without opening their pages again.
|
|
33
33
|
|
|
34
34
|
## Choose login methods
|
|
35
35
|
|