@builtbyfriends/bwf 0.0.0-stage → 1.9.2

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.
Files changed (448) hide show
  1. package/AGENTS_TEMPLATE.md +4 -0
  2. package/LICENSE +22 -0
  3. package/README.md +48 -2
  4. package/dist/account-cmd-Ddt8lGeL.mjs +45 -0
  5. package/dist/agents-BLiMq9E1.mjs +113 -0
  6. package/dist/application-analysis-C9Ck2Yeg.mjs +1498 -0
  7. package/dist/application-routing-DbR-W5lG.mjs +25 -0
  8. package/dist/atomic-write-DA6eD1Kp.mjs +17 -0
  9. package/dist/auth-BKsUmWbT.d.mts +77 -0
  10. package/dist/auth-DkvoW5hB.mjs +33 -0
  11. package/dist/auth-aKyIWkdS.mjs +1 -0
  12. package/dist/auth-client-6-Ft9i9T.d.mts +5 -0
  13. package/dist/auth-client-DwCdwKbw.mjs +5 -0
  14. package/dist/auth-client-react-CJdeErvM.mjs +5 -0
  15. package/dist/auth-client-react-DvQLe5Zb.d.mts +5 -0
  16. package/dist/auth-link-CCl-hJol.mjs +26 -0
  17. package/dist/auth-migrations-DDeifS3v.mjs +206 -0
  18. package/dist/auth-router-BG74WFUf.mjs +66 -0
  19. package/dist/auth-xnkmpZUl.mjs +311 -0
  20. package/dist/base64-ikl9yBy3.mjs +15 -0
  21. package/dist/better-auth-shared-Br6TNaYJ.mjs +473 -0
  22. package/dist/better-auth-shared-CsBNvPOU.d.mts +56 -0
  23. package/dist/build-cmd-BnZezraT.mjs +153 -0
  24. package/dist/build-output-dir-Clj_unKN.mjs +402 -0
  25. package/dist/cancel-deploy-DKAj5U1Z.mjs +57 -0
  26. package/dist/cf-access-Bhz9wX6p.mjs +131 -0
  27. package/dist/cf-access-CUP5L08W.mjs +67 -0
  28. package/dist/cf-build-output-DA6uJomQ.mjs +1 -0
  29. package/dist/cf-build-output-DNQTwMNU.mjs +438 -0
  30. package/dist/cf-command-values-2kOtxMo1.mjs +26 -0
  31. package/dist/cf-config-migrate-COOCi4Ge.mjs +330 -0
  32. package/dist/cf-worker-settings-CIh4t_yG.mjs +41 -0
  33. package/dist/cli/cli.d.mts +1 -0
  34. package/dist/cli/cli.mjs +88 -0
  35. package/dist/cli/cloudflare-operation-process.d.mts +1 -0
  36. package/dist/cli/cloudflare-operation-process.mjs +1284 -0
  37. package/dist/cli/env-schema-probe.d.mts +43 -0
  38. package/dist/cli/env-schema-probe.mjs +165 -0
  39. package/dist/cli-main-BfYf6fnB.mjs +1846 -0
  40. package/dist/client-D3D5RM5h.mjs +940 -0
  41. package/dist/client-VF2Nzc7Z.mjs +1 -0
  42. package/dist/cloudflare-auth-DzkU9H6r.mjs +152 -0
  43. package/dist/cloudflare-cmd-Bm6UhzAQ.mjs +59 -0
  44. package/dist/cloudflare-config-i8yanry0.mjs +186 -0
  45. package/dist/cloudflare-connect-B4ItSbJi.mjs +55 -0
  46. package/dist/cloudflare-operations-BcK849ue.mjs +1 -0
  47. package/dist/cloudflare-operations-DGF7xH7O.mjs +627 -0
  48. package/dist/cloudflare-process-tThIjEB2.mjs +309 -0
  49. package/dist/cloudflare-user-output-CqONaAbP.mjs +19 -0
  50. package/dist/collect-8i0wU63d.mjs +1 -0
  51. package/dist/collect-C6Blu9yw.mjs +48 -0
  52. package/dist/config-CN_RFRkS.mjs +86 -0
  53. package/dist/config-D5G-Tx6o.mjs +1 -0
  54. package/dist/config-DOaFIK3w.mjs +88 -0
  55. package/dist/config-entry.d.mts +202 -0
  56. package/dist/config-entry.mjs +6 -0
  57. package/dist/config-tNx0HlFv.mjs +516 -0
  58. package/dist/connect-CSNWKLzB.mjs +84 -0
  59. package/dist/create-project-B35ux-LA.mjs +126 -0
  60. package/dist/create-project-tJ1KwNss.mjs +1 -0
  61. package/dist/database-provider-DkZo4VwN.mjs +5 -0
  62. package/dist/database-provider.d.mts +25 -0
  63. package/dist/database-provider.mjs +1 -0
  64. package/dist/db-SOv4E9wr.mjs +1735 -0
  65. package/dist/delete-BSKI7V23.mjs +65 -0
  66. package/dist/deploy-BCSQoKC0.mjs +2 -0
  67. package/dist/deploy-CWJ3JJs_.mjs +6512 -0
  68. package/dist/deploy.d.mts +31 -0
  69. package/dist/deploy.mjs +118 -0
  70. package/dist/dev-inbox-I0nqTCdf.mjs +216 -0
  71. package/dist/discover-DJPmQcL5.mjs +36 -0
  72. package/dist/discover-EVuydEoM.mjs +1 -0
  73. package/dist/dist-B6eN80gc.mjs +1612 -0
  74. package/dist/dist-Cp4b1_T9.mjs +1 -0
  75. package/dist/dist-DMYe8CZJ.mjs +48 -0
  76. package/dist/dist-STQXl8ck.mjs +1878 -0
  77. package/dist/domain-BJaAbxuQ.mjs +149 -0
  78. package/dist/dotenv-4NdUCXbB.mjs +156 -0
  79. package/dist/drizzle-DqVFXtlc.mjs +306 -0
  80. package/dist/drizzle-Ds5P0n-S.mjs +1 -0
  81. package/dist/edge.d.mts +2 -0
  82. package/dist/edge.mjs +1 -0
  83. package/dist/email-C_ATvNIG.mjs +2865 -0
  84. package/dist/email-cloudflare-oXk2G1G3.mjs +854 -0
  85. package/dist/email-protocol-CZ0bAkI8.mjs +81 -0
  86. package/dist/email-rIfZgVAB.mjs +742 -0
  87. package/dist/env-BGTu3KWZ.mjs +73 -0
  88. package/dist/env-DUyTzroe.mjs +88 -0
  89. package/dist/env-Dl4Wggec.mjs +71 -0
  90. package/dist/env-helpers-BX0APszT.mjs +135 -0
  91. package/dist/env-helpers-U56xuFgL.d.mts +20 -0
  92. package/dist/env-mask-BsHxq3R8.mjs +46 -0
  93. package/dist/env-public-Cw_xPi1D.d.mts +119 -0
  94. package/dist/env-raw-Bo6TtrHU.mjs +41 -0
  95. package/dist/env-types-Bg-dTh8u.mjs +56 -0
  96. package/dist/env-validation-BlXzGgLZ.mjs +1 -0
  97. package/dist/env-validation-DeqFUSKg.mjs +488 -0
  98. package/dist/fetch-CBgyyhzm.d.mts +87 -0
  99. package/dist/fetch-error-DmlRM6e4.mjs +264 -0
  100. package/dist/fetch-stream-2GUN3YN1.mjs +102 -0
  101. package/dist/fetch-stream-bUXynOyZ.d.mts +32 -0
  102. package/dist/fetch-tpPiSK10.mjs +25 -0
  103. package/dist/gen-dc13IRXh.mjs +509 -0
  104. package/dist/gen-kQqhFyOP.mjs +1 -0
  105. package/dist/generate-BgtlYpKg.mjs +1 -0
  106. package/dist/generate-Da9mWKzU.mjs +80 -0
  107. package/dist/generated-wrangler-config-CoDaaFsA.mjs +17 -0
  108. package/dist/git-metadata-Cukp5kV5.mjs +82 -0
  109. package/dist/github-cmd-DT5Onu6E.mjs +690 -0
  110. package/dist/handler-B_ocHStk.d.mts +279 -0
  111. package/dist/handler-CNq7aSs1.mjs +161 -0
  112. package/dist/help-BK35YcRa.mjs +1946 -0
  113. package/dist/help-DaRezBj7.mjs +1 -0
  114. package/dist/inbound-CqubE-9T.d.mts +311 -0
  115. package/dist/inbound-lHugZPuK.mjs +509 -0
  116. package/dist/index.d.mts +64 -0
  117. package/dist/index.mjs +4163 -0
  118. package/dist/info-CLQoCenb.mjs +109 -0
  119. package/dist/init-CXanf5ck.mjs +2486 -0
  120. package/dist/limits-CMmYT2l8.d.mts +16 -0
  121. package/dist/limits-D27Lp6FP.mjs +46 -0
  122. package/dist/link-DinwJnon.mjs +52 -0
  123. package/dist/list-B1WAE9Wt.mjs +130 -0
  124. package/dist/live-KkEeda1Z.d.mts +105 -0
  125. package/dist/live-saC8barp.mjs +410 -0
  126. package/dist/load-user-env-g0ahkZcj.mjs +34 -0
  127. package/dist/local-d1-bUoAtFUe.mjs +103 -0
  128. package/dist/log-JDnPc0cF.mjs +23 -0
  129. package/dist/login-BUzyiyHV.mjs +1 -0
  130. package/dist/login-Dbv_T3Ru.mjs +87 -0
  131. package/dist/logs-BjMJooJQ.mjs +129 -0
  132. package/dist/migrate-DjW9_-sS.mjs +1 -0
  133. package/dist/migrate-DtcfKqPW.mjs +125 -0
  134. package/dist/migration-handler-22qiuWPq.mjs +469 -0
  135. package/dist/migration-handler-Bb2BJh6g.d.mts +38 -0
  136. package/dist/mime-BMUN_QKG.mjs +1004 -0
  137. package/dist/mysql-migration-sql-CNuBSqdx.mjs +239 -0
  138. package/dist/neon-CJzQSycr.mjs +52 -0
  139. package/dist/node-tfv-3v0V.mjs +64 -0
  140. package/dist/operator-ai-logging-Ay7M4KWw.mjs +121 -0
  141. package/dist/operator-args-BiGmSlZx.mjs +722 -0
  142. package/dist/operator-auth-DdYZYEkO.mjs +47 -0
  143. package/dist/operator-client-DBujdELO.mjs +82 -0
  144. package/dist/operator-cmd-BsHKYJYt.mjs +1 -0
  145. package/dist/operator-cmd-DTIkOAnP.mjs +443 -0
  146. package/dist/output-Bb34lF0w.mjs +173 -0
  147. package/dist/output-CVolXKC1.mjs +1 -0
  148. package/dist/package-BX_giUBX.mjs +1444 -0
  149. package/dist/package-json-DvS6IFRv.mjs +43 -0
  150. package/dist/pg-DoyPxa_X.mjs +15 -0
  151. package/dist/picocolors-D1NxSLw-.mjs +71 -0
  152. package/dist/plan-BHNt1QhK.mjs +1 -0
  153. package/dist/plan-DX4_-OM5.mjs +58 -0
  154. package/dist/platform-args-C-DyuCNX.mjs +1 -0
  155. package/dist/platform-args-CyeQWaZ7.mjs +538 -0
  156. package/dist/platform-auth-config-BfXqKSyZ.mjs +371 -0
  157. package/dist/platform-auth-protection-5FR6qoP_.mjs +231 -0
  158. package/dist/platform-auth-recovery-B5ZlqA8K.mjs +309 -0
  159. package/dist/platform-cmd-CcFDxtrl.mjs +1 -0
  160. package/dist/platform-cmd-ChXeBrRH.mjs +193 -0
  161. package/dist/platform-discovery-Bxg9aZXU.mjs +40 -0
  162. package/dist/platform-domain-CwatS3cz.mjs +256 -0
  163. package/dist/platform-lifecycle-0cXTmMsh.mjs +8928 -0
  164. package/dist/platform-lifecycle-BcoBAMux.mjs +1 -0
  165. package/dist/platform-management-6Wbdbob5.mjs +1607 -0
  166. package/dist/platform-management-hhnczOzr.mjs +1 -0
  167. package/dist/platform-plans-config-CkbUKFpm.mjs +447 -0
  168. package/dist/platform-recovery-DgIwlqB-.mjs +96 -0
  169. package/dist/platform-registry-x1m9HBxf.mjs +450 -0
  170. package/dist/platform-runtime-logs-kkoiYFpF.mjs +72 -0
  171. package/dist/platform-setup-DX8y_6Kh.mjs +306 -0
  172. package/dist/prepare-B9mB47T5.mjs +84 -0
  173. package/dist/prepare-DNIq07so.mjs +13 -0
  174. package/dist/prepare-LHkyJqxi.mjs +1 -0
  175. package/dist/project-CC7eN00D.mjs +141 -0
  176. package/dist/project-DcSd4BeI.mjs +1 -0
  177. package/dist/project-cmd-BydRwr-x.mjs +109 -0
  178. package/dist/project-paths-iXHKRTTQ.mjs +159 -0
  179. package/dist/project-slug-BUy0lmyR.mjs +1 -0
  180. package/dist/project-slug-CO6ci9XG.mjs +7 -0
  181. package/dist/project-team-CvdLhDF2.mjs +129 -0
  182. package/dist/project-token-CwZdUEGu.mjs +70 -0
  183. package/dist/project-tsconfig-P9X952KG.mjs +98 -0
  184. package/dist/project-zero-trust-CKDoPdN1.mjs +64 -0
  185. package/dist/providers-Cd3c7wi0.mjs +64 -0
  186. package/dist/providers-Df69hb_X.d.mts +5 -0
  187. package/dist/provision-BA59NCPO.mjs +1 -0
  188. package/dist/provision-C90fULHJ.mjs +1814 -0
  189. package/dist/queues-Bc3FsBQT.d.mts +5 -0
  190. package/dist/r2-conditions-DSLmkiR5.mjs +60 -0
  191. package/dist/requests-DNhfyF3l.mjs +52 -0
  192. package/dist/resolve-project-BCsAMDRA.mjs +47 -0
  193. package/dist/resolve-project-DhU9_lIo.mjs +1 -0
  194. package/dist/resource-name-DlJ9QXzg.mjs +10 -0
  195. package/dist/response-HmNjB30w.mjs +29 -0
  196. package/dist/rollback-wi6WK5T6.mjs +150 -0
  197. package/dist/rolldown-runtime-uD8oG6U2.mjs +24 -0
  198. package/dist/route-types-CRWhr93D.mjs +592 -0
  199. package/dist/route-url-BIDZT78M.mjs +58 -0
  200. package/dist/route-url-Bla3Upsy.d.mts +42 -0
  201. package/dist/routes-stub.d.mts +24 -0
  202. package/dist/routes-stub.mjs +1 -0
  203. package/dist/routing-assets-CSheDWWM.mjs +54 -0
  204. package/dist/rpc-DcByS_q0.d.mts +39 -0
  205. package/dist/rpc-DtxIN9Tv.mjs +19 -0
  206. package/dist/runner-CPerdjIl.mjs +163 -0
  207. package/dist/runner-CUNtS5x7.mjs +1 -0
  208. package/dist/runner-mysql-BjSoQ-mW.mjs +1 -0
  209. package/dist/runner-mysql-BmTI2EiF.mjs +145 -0
  210. package/dist/runner-pg-2pjltt0t.mjs +1 -0
  211. package/dist/runner-pg-mYc75KfH.mjs +61 -0
  212. package/dist/runtime/ai.d.mts +50 -0
  213. package/dist/runtime/ai.mjs +455 -0
  214. package/dist/runtime/auth-client-react.d.mts +2 -0
  215. package/dist/runtime/auth-client-react.mjs +1 -0
  216. package/dist/runtime/auth-client.d.mts +2 -0
  217. package/dist/runtime/auth-client.mjs +1 -0
  218. package/dist/runtime/auth.d.mts +2 -0
  219. package/dist/runtime/auth.mjs +1 -0
  220. package/dist/runtime/better-auth-mysql.d.mts +5 -0
  221. package/dist/runtime/better-auth-mysql.mjs +21 -0
  222. package/dist/runtime/better-auth-pg.d.mts +5 -0
  223. package/dist/runtime/better-auth-pg.mjs +21 -0
  224. package/dist/runtime/better-auth.d.mts +6 -0
  225. package/dist/runtime/better-auth.mjs +22 -0
  226. package/dist/runtime/client-react.d.mts +5 -0
  227. package/dist/runtime/client-react.mjs +5 -0
  228. package/dist/runtime/client.d.mts +5 -0
  229. package/dist/runtime/client.mjs +5 -0
  230. package/dist/runtime/db-mysql.d.mts +2 -0
  231. package/dist/runtime/db-mysql.mjs +1 -0
  232. package/dist/runtime/db-pg.d.mts +2 -0
  233. package/dist/runtime/db-pg.mjs +1 -0
  234. package/dist/runtime/db.d.mts +17 -0
  235. package/dist/runtime/db.mjs +36 -0
  236. package/dist/runtime/drizzle-arktype.d.mts +1 -0
  237. package/dist/runtime/drizzle-arktype.mjs +2 -0
  238. package/dist/runtime/drizzle-valibot.d.mts +1 -0
  239. package/dist/runtime/drizzle-valibot.mjs +2 -0
  240. package/dist/runtime/drizzle-zod.d.mts +1 -0
  241. package/dist/runtime/drizzle-zod.mjs +2 -0
  242. package/dist/runtime/durable.d.mts +64 -0
  243. package/dist/runtime/durable.mjs +165 -0
  244. package/dist/runtime/email/testing.d.mts +108 -0
  245. package/dist/runtime/email/testing.mjs +268 -0
  246. package/dist/runtime/email-protocol.d.mts +25 -0
  247. package/dist/runtime/email-protocol.mjs +1 -0
  248. package/dist/runtime/email.d.mts +26 -0
  249. package/dist/runtime/email.mjs +524 -0
  250. package/dist/runtime/env-public-client.d.mts +19 -0
  251. package/dist/runtime/env-public-client.mjs +55 -0
  252. package/dist/runtime/env-public.d.mts +4 -0
  253. package/dist/runtime/env-public.mjs +277 -0
  254. package/dist/runtime/env.d.mts +12 -0
  255. package/dist/runtime/env.mjs +1 -0
  256. package/dist/runtime/fetch-server.d.mts +6 -0
  257. package/dist/runtime/fetch-server.mjs +29 -0
  258. package/dist/runtime/fetch-stream.d.mts +3 -0
  259. package/dist/runtime/fetch-stream.mjs +3 -0
  260. package/dist/runtime/fetch.d.mts +2 -0
  261. package/dist/runtime/fetch.mjs +3 -0
  262. package/dist/runtime/handler.d.mts +3 -0
  263. package/dist/runtime/handler.mjs +1 -0
  264. package/dist/runtime/kv.d.mts +45 -0
  265. package/dist/runtime/kv.mjs +103 -0
  266. package/dist/runtime/limits.d.mts +2 -0
  267. package/dist/runtime/limits.mjs +1 -0
  268. package/dist/runtime/live-client.d.mts +40 -0
  269. package/dist/runtime/live-client.mjs +282 -0
  270. package/dist/runtime/live-server.d.mts +11 -0
  271. package/dist/runtime/live-server.mjs +419 -0
  272. package/dist/runtime/live.d.mts +3 -0
  273. package/dist/runtime/live.mjs +1 -0
  274. package/dist/runtime/log.d.mts +24 -0
  275. package/dist/runtime/log.mjs +57 -0
  276. package/dist/runtime/migration-handler-mysql.d.mts +2 -0
  277. package/dist/runtime/migration-handler-mysql.mjs +111 -0
  278. package/dist/runtime/migration-handler-pg.d.mts +2 -0
  279. package/dist/runtime/migration-handler-pg.mjs +94 -0
  280. package/dist/runtime/migration-handler.d.mts +2 -0
  281. package/dist/runtime/migration-handler.mjs +1 -0
  282. package/dist/runtime/procedure.d.mts +27 -0
  283. package/dist/runtime/procedure.mjs +36 -0
  284. package/dist/runtime/procedures.d.mts +24 -0
  285. package/dist/runtime/procedures.mjs +56 -0
  286. package/dist/runtime/queues.d.mts +2 -0
  287. package/dist/runtime/queues.mjs +8 -0
  288. package/dist/runtime/remote/binding-handler.d.mts +11 -0
  289. package/dist/runtime/remote/binding-handler.mjs +227 -0
  290. package/dist/runtime/remote/index.d.mts +12 -0
  291. package/dist/runtime/remote/index.mjs +467 -0
  292. package/dist/runtime/response.d.mts +11 -0
  293. package/dist/runtime/response.mjs +1 -0
  294. package/dist/runtime/route-url.d.mts +2 -0
  295. package/dist/runtime/route-url.mjs +1 -0
  296. package/dist/runtime/routing.d.mts +53 -0
  297. package/dist/runtime/routing.mjs +425 -0
  298. package/dist/runtime/rpc-react.d.mts +16 -0
  299. package/dist/runtime/rpc-react.mjs +50 -0
  300. package/dist/runtime/rpc.d.mts +2 -0
  301. package/dist/runtime/rpc.mjs +1 -0
  302. package/dist/runtime/sandbox-container.d.mts +3 -0
  303. package/dist/runtime/sandbox-container.mjs +1 -0
  304. package/dist/runtime/sandbox.d.mts +5 -0
  305. package/dist/runtime/sandbox.mjs +196 -0
  306. package/dist/runtime/schema-d1.d.mts +1 -0
  307. package/dist/runtime/schema-d1.mjs +2 -0
  308. package/dist/runtime/schema-mysql.d.mts +1 -0
  309. package/dist/runtime/schema-mysql.mjs +2 -0
  310. package/dist/runtime/schema-pg.d.mts +1 -0
  311. package/dist/runtime/schema-pg.mjs +2 -0
  312. package/dist/runtime/seed.d.mts +34 -0
  313. package/dist/runtime/seed.mjs +5 -0
  314. package/dist/runtime/sse-client.d.mts +31 -0
  315. package/dist/runtime/sse-client.mjs +42 -0
  316. package/dist/runtime/sse.d.mts +32 -0
  317. package/dist/runtime/sse.mjs +1 -0
  318. package/dist/runtime/storage.d.mts +4 -0
  319. package/dist/runtime/storage.mjs +13 -0
  320. package/dist/runtime/validator.d.mts +2 -0
  321. package/dist/runtime/validator.mjs +1 -0
  322. package/dist/runtime/ws-server.d.mts +26 -0
  323. package/dist/runtime/ws-server.mjs +297 -0
  324. package/dist/runtime/ws.d.mts +2 -0
  325. package/dist/runtime/ws.mjs +108 -0
  326. package/dist/sandbox-CWDjoEG2.d.mts +50 -0
  327. package/dist/sandbox-container-BqamdFCx.d.mts +73 -0
  328. package/dist/sandbox-container-d1AHLpgn.mjs +291 -0
  329. package/dist/secret-D5XrWshs.mjs +146 -0
  330. package/dist/skills-Dr3AjuBF.mjs +63 -0
  331. package/dist/sqlite-validation-CLJXXN93.mjs +24 -0
  332. package/dist/sse-CxR30yMF.mjs +174 -0
  333. package/dist/standard-schema-CuDawHOC.d.mts +40 -0
  334. package/dist/static-asset-marker-mWMX2dLa.mjs +38 -0
  335. package/dist/subcommand-prompt-B9yUo--u.mjs +370 -0
  336. package/dist/terminal-log-text-DNsWJREL.mjs +31 -0
  337. package/dist/types-D7-4tBu7.d.mts +1 -0
  338. package/dist/untrusted-env-lL7RkYiC.mjs +50 -0
  339. package/dist/validate-B-zsjhiz.mjs +162 -0
  340. package/dist/validate-DbqGdPPY.mjs +1 -0
  341. package/dist/validator-8-NZs2Xr.mjs +168 -0
  342. package/dist/version-metadata-DPhqnpaa.mjs +23 -0
  343. package/dist/wrangler-C3uyPadQ.mjs +1 -0
  344. package/dist/wrangler-TqTvJFWS.mjs +1452 -0
  345. package/dist/ws-DZRiIpYw.d.mts +137 -0
  346. package/dist/yarn-pnp-DgWbE7z5.mjs +91 -0
  347. package/docs/guide/ai.md +273 -0
  348. package/docs/guide/app-types.md +101 -0
  349. package/docs/guide/auth.md +255 -0
  350. package/docs/guide/database/d1.md +86 -0
  351. package/docs/guide/database/mysql.md +72 -0
  352. package/docs/guide/database/postgresql.md +94 -0
  353. package/docs/guide/database.md +454 -0
  354. package/docs/guide/deployment.md +124 -0
  355. package/docs/guide/durable-state.md +192 -0
  356. package/docs/guide/edge/headers.md +47 -0
  357. package/docs/guide/edge/redirects.md +85 -0
  358. package/docs/guide/edge/rewrites.md +119 -0
  359. package/docs/guide/edge/static-assets.md +94 -0
  360. package/docs/guide/email/domains.md +119 -0
  361. package/docs/guide/email/receiving.md +142 -0
  362. package/docs/guide/email/sending.md +262 -0
  363. package/docs/guide/email.md +23 -0
  364. package/docs/guide/env-vars.md +115 -0
  365. package/docs/guide/index.md +37 -0
  366. package/docs/guide/jobs.md +80 -0
  367. package/docs/guide/kv.md +100 -0
  368. package/docs/guide/live.md +181 -0
  369. package/docs/guide/platform/administration/access.md +165 -0
  370. package/docs/guide/platform/administration/connected-apps.md +84 -0
  371. package/docs/guide/platform/administration/email.md +169 -0
  372. package/docs/guide/platform/administration/operations.md +100 -0
  373. package/docs/guide/platform/administration/plans.md +156 -0
  374. package/docs/guide/platform/administration/projects.md +74 -0
  375. package/docs/guide/platform/administration/zero-trust.md +205 -0
  376. package/docs/guide/platform/development/local.md +122 -0
  377. package/docs/guide/platform/development/runtime.md +115 -0
  378. package/docs/guide/platform/development/schema-ci.md +44 -0
  379. package/docs/guide/platform/installation/ci.md +62 -0
  380. package/docs/guide/platform/installation/credentials.md +140 -0
  381. package/docs/guide/platform/installation/domains.md +120 -0
  382. package/docs/guide/platform/installation/first-deployment.md +95 -0
  383. package/docs/guide/platform/installation/maintenance.md +250 -0
  384. package/docs/guide/platform/installation/prerequisites.md +176 -0
  385. package/docs/guide/platform/installation/setup.md +300 -0
  386. package/docs/guide/platform/installation/uninstall.md +110 -0
  387. package/docs/guide/platform-administration.md +19 -0
  388. package/docs/guide/platform-development.md +16 -0
  389. package/docs/guide/procedures.md +48 -0
  390. package/docs/guide/project-collaboration.md +99 -0
  391. package/docs/guide/queues.md +149 -0
  392. package/docs/guide/quickstart.md +129 -0
  393. package/docs/guide/remote-dev.md +67 -0
  394. package/docs/guide/sandboxes.md +134 -0
  395. package/docs/guide/self-hosted-platform.md +45 -0
  396. package/docs/guide/server-routing.md +283 -0
  397. package/docs/guide/sse.md +174 -0
  398. package/docs/guide/storage.md +82 -0
  399. package/docs/guide/testing.md +64 -0
  400. package/docs/guide/type-safety.md +270 -0
  401. package/docs/guide/typed-fetch.md +98 -0
  402. package/docs/guide/websockets.md +230 -0
  403. package/docs/index.md +102 -0
  404. package/docs/integrations/agents.md +38 -0
  405. package/docs/integrations/cloudflare.md +241 -0
  406. package/docs/integrations/hono.md +127 -0
  407. package/docs/reference/api/auth.md +195 -0
  408. package/docs/reference/api/client.md +90 -0
  409. package/docs/reference/api/database.md +118 -0
  410. package/docs/reference/api/deploy.md +63 -0
  411. package/docs/reference/api/durable.md +47 -0
  412. package/docs/reference/api/env.md +51 -0
  413. package/docs/reference/api/handlers.md +189 -0
  414. package/docs/reference/api/plugin.md +40 -0
  415. package/docs/reference/api/resources.md +116 -0
  416. package/docs/reference/api/rewrites.md +111 -0
  417. package/docs/reference/api/types.md +126 -0
  418. package/docs/reference/api.md +71 -0
  419. package/docs/reference/cli/auth.md +87 -0
  420. package/docs/reference/cli/database.md +159 -0
  421. package/docs/reference/cli/deploy.md +117 -0
  422. package/docs/reference/cli/domains.md +42 -0
  423. package/docs/reference/cli/email.md +145 -0
  424. package/docs/reference/cli/generate.md +113 -0
  425. package/docs/reference/cli/github.md +181 -0
  426. package/docs/reference/cli/platform-config.md +93 -0
  427. package/docs/reference/cli/platform-email.md +81 -0
  428. package/docs/reference/cli/platform-installation.md +166 -0
  429. package/docs/reference/cli/platform-operations.md +90 -0
  430. package/docs/reference/cli/platform-users.md +159 -0
  431. package/docs/reference/cli/platform-zero-trust.md +60 -0
  432. package/docs/reference/cli/platform.md +78 -0
  433. package/docs/reference/cli/project.md +208 -0
  434. package/docs/reference/cli/secrets.md +79 -0
  435. package/docs/reference/cli/setup.md +88 -0
  436. package/docs/reference/cli.md +115 -0
  437. package/docs/reference/config.md +478 -0
  438. package/docs/reference/resource-inference.md +72 -0
  439. package/docs/reference/structure.md +138 -0
  440. package/package.json +389 -3
  441. package/sandbox.Dockerfile +4 -0
  442. package/schema.json +353 -0
  443. package/skills/bwf/SKILL.md +100 -0
  444. package/skills/migrate-vite-cloudflare-to-bwf/SKILL.md +53 -0
  445. package/templates/assets/bwf.svg +5 -0
  446. package/templates/assets/icons.svg +49 -0
  447. package/templates/assets/react.svg +1 -0
  448. package/templates/assets/stack.svg +35 -0
@@ -0,0 +1,192 @@
1
+ ---
2
+ description: 'Share typed state across requests with a Durable Object, such as a cart, room, or rate limiter.'
3
+ outline: deep
4
+ ---
5
+
6
+ # Durable State
7
+
8
+ Use a Durable Object when requests need to share state under one name, such as a shopping cart, room, or rate limiter. bwf gives you typed methods and stores the object's state between calls.
9
+
10
+ Create a module in `durable-objects/` with `defineDurableState()`. bwf provides a SQLite-backed Cloudflare Durable Object for it. This feature supports native bwf apps on bwf platforms and direct Cloudflare deployments.
11
+
12
+ Commit `bwf.lock.json` when bwf adds a resource. Keep its deployed migration entries in their original order.
13
+
14
+ ## Define state and methods
15
+
16
+ ```ts
17
+ // durable-objects/counter.ts
18
+ import { defineDurableState } from '@builtbyfriends/bwf/durable';
19
+
20
+ export const Counter = defineDurableState({
21
+ initialState: { count: 0 },
22
+ methods: {
23
+ increment(context, amount: number) {
24
+ context.state.count += amount;
25
+ return context.state.count;
26
+ },
27
+ read(context) {
28
+ return context.state.count;
29
+ },
30
+ },
31
+ });
32
+
33
+ export default Counter;
34
+ ```
35
+
36
+ Default-export the object returned by `defineDurableState()`.
37
+
38
+ ## Call it from a route
39
+
40
+ Import your definition and call `get()` with a name to select an object. Method arguments and return values are typed:
41
+
42
+ ```ts
43
+ // routes/api/counter.ts
44
+ import { defineHandler } from '@builtbyfriends/bwf';
45
+ import { Counter } from '../../durable-objects/counter';
46
+
47
+ export const POST = defineHandler(async () => {
48
+ const counter = Counter.get('global');
49
+ const count = await counter.increment(1);
50
+ return { count };
51
+ });
52
+ ```
53
+
54
+ The same name always resolves to the same Durable Object. Use `getById(id)` when you already have a `DurableObjectId`. For advanced cases, both helpers also accept an explicit `DurableObjectNamespace` as their first argument.
55
+
56
+ ## Execution and persistence
57
+
58
+ bwf loads state before the first operation and runs RPC methods one at a time. After a method, `fetch`, or `alarm` handler succeeds, it saves the updated state.
59
+
60
+ If the handler or save fails, bwf restores `context.state` to its previous value. Direct writes to `context.storage` aren't included in that rollback.
61
+
62
+ Each method receives:
63
+
64
+ - `context.state`, which can be mutated or replaced
65
+ - `context.env`, the Durable Object environment
66
+ - `context.id` and `context.storage`
67
+ - `context.setAlarm()` and `context.deleteAlarm()`
68
+
69
+ Methods named `fetch`, `alarm`, or `constructor` are reserved. Define `fetch` and `alarm` as top-level hooks instead:
70
+
71
+ ```ts
72
+ export const Room = defineDurableState({
73
+ initialState: { wakeups: 0 },
74
+ methods: {},
75
+ fetch(context) {
76
+ return Response.json(context.state);
77
+ },
78
+ async alarm(context) {
79
+ context.state.wakeups += 1;
80
+ await context.setAlarm(Date.now() + 60_000);
81
+ },
82
+ });
83
+
84
+ export default Room;
85
+ ```
86
+
87
+ ## State migrations
88
+
89
+ Version the persisted value when its shape changes. Versions start at `1`, must be contiguous, and run in order before an operation handles the migrated state.
90
+
91
+ ```ts
92
+ export const Counter = defineDurableState({
93
+ initialState: { count: 0, label: 'Counter' },
94
+ version: 2,
95
+ migrations: [
96
+ {
97
+ version: 1,
98
+ migrate(old) {
99
+ return { count: (old as { count: number }).count, label: 'Counter' };
100
+ },
101
+ },
102
+ {
103
+ version: 2,
104
+ migrate(old) {
105
+ return { ...(old as { count: number; label: string }), label: 'Total' };
106
+ },
107
+ },
108
+ ],
109
+ methods: {
110
+ read(context) {
111
+ return context.state;
112
+ },
113
+ },
114
+ });
115
+
116
+ export default Counter;
117
+ ```
118
+
119
+ State migrations update your saved values. bwf manages Cloudflare’s separate class migrations in `bwf.lock.json`.
120
+
121
+ For direct Cloudflare deployments, do not delete or reorder generated Durable Object migrations in `bwf.lock.json` after deployment. For a class addition, rename, or removal on an existing Worker, review the migration and run `bwf deploy --platform cloudflare --atomic`. If this Worker needs atomic publication on every deploy, set `deploy: { cloudflare: { mode: 'atomic' } }` in `bwf.config.ts`. Cloudflare applies class lifecycle changes in one deployment. The Worker receives traffic before bwf checks readiness, and you cannot roll back across that migration boundary. Staged deploys keep pre-traffic readiness verification.
122
+
123
+ ## Rename a file while keeping its state
124
+
125
+ Before renaming a deployed definition, run:
126
+
127
+ ```sh
128
+ bwf info
129
+ ```
130
+
131
+ For `durable-objects/counter.ts`, bwf prints:
132
+
133
+ ```text
134
+ To preserve this resource when moving its code, add this to 'defineDurableState':
135
+ name: "counter",
136
+ ```
137
+
138
+ Add that property to the existing definition:
139
+
140
+ ```ts
141
+ export const Counter = defineDurableState({
142
+ name: 'counter',
143
+ initialState: { count: 0 },
144
+ methods: {
145
+ read(context) {
146
+ return context.state.count;
147
+ },
148
+ },
149
+ });
150
+
151
+ export default Counter;
152
+ ```
153
+
154
+ Rename the file within `durable-objects/`, update its imports, and deploy. Keep `name: 'counter'` and the names passed to `Counter.get()` unchanged to preserve the stored state.
155
+
156
+ `name` is optional. Use a static string, either inline or in a local `const`, containing words that start with a letter, such as `'shopping-cart'`. Names must produce distinct Worker classes and bindings. Changing an existing resource's `name` selects a different resource.
157
+
158
+ If you already moved the file, `bwf info` also shows resources recorded in `bwf.lock.json` without a matching definition. Identify the original resource and use its suggested name. If no name can be suggested, restore the original file from source history and run `bwf info` before moving it again. Keep the existing lock and migration history.
159
+
160
+ ## Deployment support
161
+
162
+ Typed state works in local development, on bwf platforms, and in direct Cloudflare deploys of native bwf apps. Use `bwf deploy` for a bwf platform or `bwf deploy --platform cloudflare` for your own Cloudflare account.
163
+
164
+ On a bwf platform, each class keeps its storage across deployments and rollbacks. A rollback restores the class code and keeps the current stored data. Removing a definition makes the class inactive; adding it again with the same resource name restores access to its data. Deleting the project deletes its Durable Object storage.
165
+
166
+ A project supports up to 32 distinct custom classes, including removed classes whose storage is retained. Keep resource names and instance names stable to preserve data. Upgrade an older bwf installation before deploying an app that uses custom Durable Objects.
167
+
168
+ This is separate from [typed WebSocket routes](./websockets.md), which also use SQLite-backed Durable Objects and work on both direct Cloudflare and hosted bwf deployments.
169
+
170
+ ## Native Durable Object classes
171
+
172
+ Use `defineDurableObject` to keep a native Cloudflare class, including classes extending Cloudflare Agents. bwf discovers its binding and exports the class without replacing its constructor, lifecycle, or RPC methods. Like Durable State, this supports bwf platforms and direct Cloudflare deployments.
173
+
174
+ ```ts
175
+ import { defineDurableObject } from '@builtbyfriends/bwf/durable';
176
+ // durable-objects/workspace.ts
177
+ import { DurableObject } from 'cloudflare:workers';
178
+
179
+ class WorkspaceObject extends DurableObject {
180
+ async fetch() {
181
+ return new Response('Workspace');
182
+ }
183
+ }
184
+
185
+ export const Workspace = defineDurableObject({
186
+ name: 'workspace',
187
+ class: WorkspaceObject,
188
+ });
189
+ export default Workspace;
190
+ ```
191
+
192
+ Call `Workspace.get('project-id')` from a server handler to obtain its typed stub. Keep the resource name and instance name stable across deployments to retain storage.
@@ -0,0 +1,47 @@
1
+ ---
2
+ description: 'Set custom response headers from bwf.config.ts. Match URL patterns to header names and values.'
3
+ outline: deep
4
+ ---
5
+
6
+ # Custom Headers
7
+
8
+ Define custom response headers in [`bwf.config.ts`](../../reference/config) using the `routing.headers` field. Keys are URL patterns, values are arrays of `"Name: value"` strings.
9
+
10
+ ```json
11
+ {
12
+ "routing": {
13
+ "headers": {
14
+ "/assets/*": ["Cache-Control: public, max-age=31536000, immutable"],
15
+ "/*": ["X-Frame-Options: DENY", "X-Content-Type-Options: nosniff"],
16
+ "/*.html": ["Cache-Control: no-cache"]
17
+ }
18
+ }
19
+ }
20
+ ```
21
+
22
+ ## Rules
23
+
24
+ - **Pattern keys** start with `/`. `*` matches any characters including `/`.
25
+ - **Header values** use `Name: value` format. The value may contain colons.
26
+ - All matching rules are merged. When multiple rules set the same header name, the **last match wins**.
27
+ - User-defined `Cache-Control` overrides the built-in default. The default still applies when no rule matches.
28
+ - With [authentication](../auth.md), responses to requests with cookies or credentials stay private, and auth endpoints stay uncached, in development and on direct Cloudflare deployments. On a [bwf platform](../deployment.md#deploy-to-a-team-platform), header rules can replace those cache settings. Keep public cache rules away from signed-in pages and `/api/auth/*`.
29
+ - Rules also apply to errors, including 404s. Use immutable caching only for URLs that change with their content, so a missing file isn't cached under a permanent URL.
30
+
31
+ ## Scope
32
+
33
+ Header rules apply to static assets and API responses, including hashed assets served from cache.
34
+
35
+ For hashed assets, you can add headers, but the platform keeps control of caching and response encoding. Rules cannot replace `Cache-Control`, `Content-Type`, `Content-Encoding`, `Content-Length`, `Content-Range`, `Accept-Ranges`, or `Transfer-Encoding` on these files.
36
+
37
+ ### Cookie headers
38
+
39
+ On a [bwf platform](../deployment.md#deploy-to-a-team-platform), set cookies in your app's response. Header rules ignore `Set-Cookie`, remove `"cookies"` from `Clear-Site-Data`, and ignore `Clear-Site-Data` rules containing `"*"`. You can use directives such as `"cache"` and `"storage"` in header rules.
40
+
41
+ These limits apply on all of your app's hostnames, including custom domains, to protect cookies for other apps on the shared domain. Your app's own cookie headers can still affect those apps, so scope cookies carefully. See [Domains and Resources](../platform/installation/domains.md#adding-a-domain).
42
+
43
+ During local development and with `bwf deploy --platform cloudflare`, header rules apply both headers as written.
44
+
45
+ ## `_headers` files
46
+
47
+ On a bwf platform, bwf reads `_headers` files produced by your build, such as a static site generator's output. Your `routing.headers` rules run afterward, so they can override framework defaults.
@@ -0,0 +1,85 @@
1
+ ---
2
+ description: 'Redirect requests from bwf.config.ts. Map a source pattern to a destination and an optional status code.'
3
+ outline: deep
4
+ ---
5
+
6
+ # Redirects
7
+
8
+ Define URL redirects in [`bwf.config.ts`](../../reference/config) using the `routing.redirects` field. Keys are source URL patterns, values are destination strings or objects with an explicit status.
9
+
10
+ ```json
11
+ {
12
+ "routing": {
13
+ "redirects": {
14
+ "/old": "/new",
15
+ "/blog/*": { "to": "/posts/:splat", "status": 301 }
16
+ }
17
+ }
18
+ }
19
+ ```
20
+
21
+ ## Rules
22
+
23
+ - **Source patterns** start with `/`. `*` matches any characters including `/`.
24
+ - **Destinations** can be strings (default `302`) or objects with `to` and optional `status`. Supported statuses: `301`, `302`, `303`, `307`, `308`.
25
+ - `:splat` in the destination is replaced with the portion of the path matched by `*` in the source pattern.
26
+ - Destination query strings are merged into the `Location` header (the destination's parameters take precedence on per-key conflict). To drop the incoming query, write an explicit reset like `?`.
27
+ - For redirects from a handler or middleware, use [`c.redirect()`](../../reference/api/rewrites.md#c-rewrite-destination). It sends the location you provide without adding the request query.
28
+ - When multiple rules match, the **first match wins**. Put specific patterns before catch-all patterns.
29
+ - Redirects are evaluated **before** the request reaches the worker, so they short-circuit static asset serving and route handlers.
30
+
31
+ ## Domain-level redirects
32
+
33
+ Prefix a source with `https://host` to redirect only requests to that domain:
34
+
35
+ ```json
36
+ {
37
+ "routing": {
38
+ "redirects": {
39
+ "https://www.example.com/*": "https://example.com/:splat",
40
+ "https://old-marketing.com/*": "https://example.com/:splat"
41
+ }
42
+ }
43
+ }
44
+ ```
45
+
46
+ The `_redirects` file accepts the same syntax:
47
+
48
+ ```
49
+ https://www.example.com/* https://example.com/:splat 301
50
+ ```
51
+
52
+ Path-only sources apply to every domain on the project. Host-prefixed sources apply only to the named domain.
53
+
54
+ The source must use `https://` and a literal hostname without wildcards or a port. Add the domain to your project with `bwf domain add` before deploying the rule. A domain awaiting certificate verification starts redirecting once it becomes active.
55
+
56
+ ## HTTP to HTTPS
57
+
58
+ Set `routing.alwaysUseHttps` to redirect HTTP requests to HTTPS:
59
+
60
+ ```ts
61
+ import { defineConfig } from '@builtbyfriends/bwf/config';
62
+
63
+ export default defineConfig({
64
+ routing: {
65
+ alwaysUseHttps: true,
66
+ },
67
+ });
68
+ ```
69
+
70
+ bwf returns a permanent `308` redirect that preserves the path, query string, and request method. The option defaults to `false`. Localhost and loopback addresses stay on HTTP for local development and previews.
71
+
72
+ This option requires the Cloudflare target and works for bwf apps and static sites on either deployment platform.
73
+
74
+ For direct Cloudflare deployments, also enable [Always Use HTTPS](https://developers.cloudflare.com/ssl/edge-certificates/additional-options/always-use-https/) on your zone to cover assets served directly by Cloudflare.
75
+
76
+ ## `_redirects` files
77
+
78
+ bwf reads `_redirects` files produced by your build, such as a static site generator's output. You can also place one in Vite's `publicDir`:
79
+
80
+ ```text
81
+ /old-page /new-page 301
82
+ /blog/* /posts/:splat 301
83
+ ```
84
+
85
+ Rules in `bwf.config.ts` take precedence over file rules. Use `200` for a fallback or `200!` for a [rewrite](./rewrites#redirects-file). Redirects don't need the `!` suffix.
@@ -0,0 +1,119 @@
1
+ ---
2
+ description: 'Serve one route at another URL without changing the address in the browser.'
3
+ outline: deep
4
+ ---
5
+
6
+ # Rewrites
7
+
8
+ A rewrite serves a route at a different URL without changing the browser's address. For example, `/docs` can serve `/en/docs`. Use a [redirect](./redirects) when the browser should move to the destination instead.
9
+
10
+ Define rewrites in [`bwf.config.ts`](../../reference/config):
11
+
12
+ ```ts
13
+ import { defineConfig } from '@builtbyfriends/bwf/config';
14
+
15
+ export default defineConfig({
16
+ routing: {
17
+ rewrites: {
18
+ '/': '/en',
19
+ '/docs': '/en/docs',
20
+ '/docs/*': '/en/docs/:splat',
21
+ },
22
+ },
23
+ });
24
+ ```
25
+
26
+ A request to `/docs/getting-started` serves `/en/docs/getting-started`. Other locales, such as `/ja/docs/getting-started`, keep their own routes.
27
+
28
+ ## Rules
29
+
30
+ - Sources and destinations start with `/`. Destinations must be paths within the app.
31
+ - `*` matches any characters, including `/`. Use `:splat` in the destination for the matched portion.
32
+ - The first matching rule wins. Put specific patterns before catch-all patterns.
33
+ - Rewrites run before static assets and application routes.
34
+
35
+ ## Programmatic rewrites in middleware
36
+
37
+ Use `c.rewrite()` when the destination depends on the request, such as a locale chosen from a cookie:
38
+
39
+ ```ts
40
+ import { defineMiddleware } from '@builtbyfriends/bwf';
41
+
42
+ export default defineMiddleware(async (c, next) => {
43
+ if (c.req.path.match(/^\/(en|ja)(\/|$)/)) return next();
44
+
45
+ const locale = detectLocale(c.req);
46
+ return c.rewrite(`/${locale}${c.req.path}`);
47
+ });
48
+ ```
49
+
50
+ Return the result of `c.rewrite()`. Middleware runs again at the destination, so skip paths that are already rewritten to avoid a loop. Use `c.isRewritten()` to skip work that should happen only once:
51
+
52
+ ```ts
53
+ if (c.isRewritten()) return next();
54
+ ```
55
+
56
+ Keep access checks on any destination that needs them.
57
+
58
+ A destination without `?` preserves the incoming query string. `c.rewrite('/search')` keeps `?q=...`, while `c.rewrite('/search?q=all')` replaces it.
59
+
60
+ Your editor suggests known routes through [`RewriteDestination`](../../reference/api/rewrites.md#rewritedestination). Enable [`routing.typedRoutes`](../../reference/config.md#routing-typedroutes) to reject strings that don't match a route. For a path you build at runtime, import `RouteUrl` from `@builtbyfriends/bwf/routes` and use a cast, such as ``c.rewrite(`/en${c.req.path}` as RouteUrl)``.
61
+
62
+ ### Runtime rewrites cannot reach static assets
63
+
64
+ `c.rewrite()` targets application routes. To serve an asset such as `/hero.png` at another URL, use `routing.rewrites` or a `_redirects` rule instead. A middleware rewrite to a recognized asset extension throws `BwfAssetRewriteError`.
65
+
66
+ ## Original URL access
67
+
68
+ `c.originalUrl()` returns the URL requested before a static or middleware rewrite, or `null` when no rewrite occurred. Use it for canonical links or locale detection:
69
+
70
+ ```ts
71
+ import { defineHandler } from '@builtbyfriends/bwf';
72
+
73
+ export default defineHandler((c) => {
74
+ const original = c.originalUrl();
75
+ return c.json({ pathname: original?.pathname ?? c.req.path });
76
+ });
77
+ ```
78
+
79
+ ## Fallbacks
80
+
81
+ `routing.fallbacks` uses the same patterns as rewrites, but applies only when no asset or route matches:
82
+
83
+ ```ts
84
+ import { defineConfig } from '@builtbyfriends/bwf/config';
85
+
86
+ export default defineConfig({
87
+ routing: {
88
+ fallbacks: { '/*': '/index.html' },
89
+ },
90
+ });
91
+ ```
92
+
93
+ Use a fallback for a client-side router or a default-locale catch-all. An intentional `404` from a bwf route remains a `404`. For third-party frameworks, fallbacks can also replace the framework's `404` response.
94
+
95
+ SPA apps already fall back to `/index.html`. Custom fallback rules run first; unmatched paths still use the SPA shell. You don't need to add `'/*': '/index.html'` yourself.
96
+
97
+ ## `_redirects` file
98
+
99
+ You can also place rules in Vite's `publicDir`, which defaults to `public/`:
100
+
101
+ ```text
102
+ # Fallback: only when no asset or route matches
103
+ /* /index.html 200
104
+
105
+ # Rewrite: before assets and routes
106
+ /docs/* /en/docs/:splat 200!
107
+ ```
108
+
109
+ The file can include [3xx redirects](./redirects) too. Rules in `bwf.config.ts` take precedence over file rules; within each group, the first match wins.
110
+
111
+ ## Debugging with `X-Nosam-Routing`
112
+
113
+ During development, inspect the `X-Nosam-Routing` response header in your browser's Network tab. It shows the matching rule and where it was declared:
114
+
115
+ ```text
116
+ X-Nosam-Routing: rewrite[/docs/*] -> /en/docs/:splat (bwf.config.ts#routing.rewrites)
117
+ X-Nosam-Routing: c.rewrite -> /new-path (middleware)
118
+ X-Nosam-Routing: pass-through
119
+ ```
@@ -0,0 +1,94 @@
1
+ ---
2
+ description: "Cache static assets on Cloudflare's edge. Hashed build files stay reusable across deploys."
3
+ outline: deep
4
+ ---
5
+
6
+ # Static Assets Caching
7
+
8
+ bwf caches static assets on Cloudflare's edge network. Hashed build files can be reused across deploys, while other files use cache keys tied to the deployment.
9
+
10
+ ## Hashed assets
11
+
12
+ Files in Vite's `build.assetsDir` (default `assets/`) are produced with content hashes in the filename, such as `assets/app-Ab3xK9.js`. These files are immutable because the filename changes whenever the content changes, so they get aggressive caching:
13
+
14
+ ```
15
+ Cache-Control: public, max-age=31536000, immutable
16
+ ```
17
+
18
+ Browsers and the edge can cache these files for one year and reuse them across deploys.
19
+
20
+ If your Vite config customizes `build.assetsDir`, bwf automatically detects this and applies the immutable optimization to the configured directory:
21
+
22
+ ```ts
23
+ // vite.config.ts
24
+ export default defineConfig({
25
+ build: {
26
+ assetsDir: 'static', // hashed assets go to dist/client/static/
27
+ },
28
+ });
29
+ ```
30
+
31
+ If `build.assetsDir` is set to `""`, meaning hashed files live at the root, the optimization is skipped because there is no directory-based way to distinguish hashed from non-hashed files.
32
+
33
+ ### Native Cloudflare deployments
34
+
35
+ For bwf apps, `bwf deploy --platform cloudflare` gives generated JavaScript bundles with content fingerprints immutable caching. Files copied from `public/` and custom build outputs with stable filenames keep normal revalidation, even when they live in the assets directory. CSS and other assets keep Cloudflare's default or your configured `Cache-Control`.
36
+
37
+ Use [Custom Headers](./headers) to choose a cache policy for other files. Apply immutable caching only to URLs that change whenever their content changes.
38
+
39
+ ## Non-hashed assets
40
+
41
+ Other static files, such as `index.html` and `favicon.ico`, are cached until the next deploy. You do not need to purge them manually.
42
+
43
+ ```
44
+ Cache-Control: public, s-maxage=31536000, max-age=0, must-revalidate
45
+ ```
46
+
47
+ Browsers revalidate these files on each request.
48
+
49
+ **What gets cached:**
50
+
51
+ - All `GET` requests for static projects such as SPAs and static sites
52
+ - GET requests with file extensions (`.ico`, `.png`, `.css`, etc.) in bwf apps with a Worker
53
+
54
+ **What does NOT get cached:**
55
+
56
+ - `/api/*` routes, which always hit the worker
57
+ - Paths without file extensions in bwf apps with a Worker
58
+ - Non-GET requests
59
+ - Requests carrying `Cookie`, `Authorization`, or `Cf-Access-Jwt-Assertion` credentials
60
+ - Responses other than a complete `200`
61
+
62
+ ### Opting out
63
+
64
+ If your worker serves dynamic content at a URL that looks static (e.g., a dynamically generated image at `/avatar.jpg`), you can prevent caching by setting `Cache-Control: private` or `Cache-Control: no-store` in your response headers. Any response with `Cache-Control` containing `private`, `no-store`, or `no-cache`, or with a `Set-Cookie` header, bypasses the edge cache.
65
+
66
+ ## ETags and 304 Not Modified
67
+
68
+ Static assets include an `ETag` header. When a browser revalidates an unchanged file, bwf returns `304 Not Modified` without downloading it again. No configuration is needed.
69
+
70
+ ## Custom headers
71
+
72
+ You can override caching headers or add your own for any static asset path using [Custom Headers](./headers).
73
+
74
+ ## Navigation and middleware
75
+
76
+ bwf serves static files directly unless application code needs to handle the request first. API requests reach your Worker. Apps with middleware or routes outside `/api` run application code before serving fallback HTML.
77
+
78
+ SPAs serve `index.html` for unmatched HTML navigation so client-side routing works. For a static site with a `404.html` page, set [`routing.notFound`](../../reference/config.md#routing-notfound):
79
+
80
+ ```ts
81
+ import { defineConfig } from '@builtbyfriends/bwf/config';
82
+
83
+ export default defineConfig({
84
+ routing: { notFound: '404-page' },
85
+ });
86
+ ```
87
+
88
+ Choose `single-page-application`, `404-page`, or `none`. These settings preserve which requests reach middleware and API handlers. Intentional API `404` responses keep their status and body.
89
+
90
+ To run server code before serving an asset, set [`run_worker_first`](https://developers.cloudflare.com/workers/static-assets/binding/#run_worker_first) under `cloudflare.assets` in `bwf.config.ts`. Setting it to `true` runs the Worker on every request and counts toward Worker request usage.
91
+
92
+ ## API routes
93
+
94
+ API responses are not cached as static assets. Set `Cache-Control` in the handler to let browsers cache them.
@@ -0,0 +1,119 @@
1
+ ---
2
+ description: 'Register an email domain on a bwf platform, or configure sending and receiving in your own Cloudflare account.'
3
+ outline: deep
4
+ ---
5
+
6
+ # Email Domains and Setup
7
+
8
+ Choose the setup for your deployment: register a domain on a bwf platform, or configure email in your own Cloudflare account. For the platform’s shared sender, follow [Sending Email](./sending.md#setup).
9
+
10
+ ## Your own domain on the platform {#your-own-domain-on-the-platform}
11
+
12
+ The shared sender uses the platform's configured mail domain. To send — and receive — at a domain you own, register its Cloudflare zone with the project:
13
+
14
+ ```sh
15
+ bwf email domain add acme.com
16
+ ```
17
+
18
+ `add` opens a Cloudflare API-token template. Restrict the token to the selected account and mail zone before creating it; Workers Scripts permission applies across that account. The CLI accepts a masked paste or a newly copied token and asks you to confirm those restrictions. The platform encrypts the credential for the zone connection, so projects sharing that zone do not need separate ingress Workers.
19
+
20
+ For inbound mail, use a Cloudflare zone apex with no existing mail service, such as `example.com`. Each apex belongs to one project, and a project can register several. Existing MX records or a catch-all pointing elsewhere block registration to protect your current mail service.
21
+
22
+ To keep receiving mail through another provider, ask your platform administrator to register the domain as [outbound-only](../platform/administration/email.md#sending-from-a-domain-that-already-receives-mail). You can also use the platform's shared mail address.
23
+
24
+ If setup is interrupted, use `bwf email domain status <domain>` to inspect the saved operation before retrying.
25
+
26
+ `bwf email domain status <domain>` reports three independent results:
27
+
28
+ - **Inbound**: whether mail can reach the project's handlers.
29
+ - **Outbound**: whether sending is ready, restricted to verified destinations, pending, or blocked.
30
+ - **Management**: whether the stored Cloudflare credential can manage the connection.
31
+
32
+ Use `bwf email domain sync <domain>` to finish setup and refresh readiness. The status lists any dashboard or credential steps still needed. Use `rotate-secret` to rotate the connection secret after inbound is ready, or `remove` to detach the domain. Revoke unused API tokens in Cloudflare. See [Email domain commands](../../reference/cli/email.md#nosam-email-domain).
33
+
34
+ Once inbound is ready, mail to any address on that domain reaches your `email/` handlers. Sending to arbitrary recipients also needs outbound readiness; a domain limited to verified destinations still requires recipient verification. Platform quotas and suspension apply to both shared and custom senders.
35
+
36
+ On an administrator-managed platform, `add` prints the administrator command for new domains. Existing owner-managed connections remain available to their owner. Your administrator may permit shared-sender mail to specific recipient domains or any recipient; destinations on the platform's shared mail domain still require explicit verification.
37
+
38
+ ## Your own Cloudflare account {#your-own-cloudflare-account}
39
+
40
+ Set a sender on a Cloudflare zone you own:
41
+
42
+ ```ts
43
+ import { defineConfig } from '@builtbyfriends/bwf/config';
44
+
45
+ export default defineConfig({
46
+ email: { from: 'Acme <support@mail.acme.com>' },
47
+ });
48
+ ```
49
+
50
+ Use a mail subdomain to keep existing mail on `acme.com` with its current provider. bwf refuses to replace another provider's MX records.
51
+
52
+ ### Setup {#setup-1}
53
+
54
+ Sign in with `bwf cloudflare login`, or use a `CLOUDFLARE_API_TOKEN` with **Email Routing Edit** and **Email Sending Edit** in addition to deploy permissions. If your browser session lacks email permissions, log out and sign in again. Global API Keys aren't supported.
55
+
56
+ Run `bwf deploy --platform cloudflare`. bwf shows the domain, routing, sending, DNS, and handler addresses it would configure. Accept to set up email and deploy. Later deploys reuse the setup. If you decline the initial setup, the app deploys without email.
57
+
58
+ Without `email.from`, bwf skips automatic setup and preserves authored `cloudflare.send_email` bindings and `cloudflare.addresses`; check their readiness yourself. `--require-email` still refuses deployment when automatic setup cannot be verified.
59
+
60
+ If subdomain setup needs a dashboard step, follow the checklist under **Email → Settings → Subdomains**, then retry. After DNS changes, check readiness with:
61
+
62
+ ```sh
63
+ bwf email status --platform cloudflare
64
+ ```
65
+
66
+ ### Inbound addresses {#inbound-addresses}
67
+
68
+ With `email.from` on `mail.acme.com`, handlers receive:
69
+
70
+ | Handler | Subdomain address | Zone apex address |
71
+ | ----------------------------------- | ----------------------- | ------------------ |
72
+ | `support.ts`, `support+[ticket].ts` | `support@mail.acme.com` | `support@acme.com` |
73
+ | `_default.ts` | No catch-all rule | `*@acme.com` |
74
+ | `[user].ts`, `[user]+[tag].ts` | Not supported | `*@acme.com` |
75
+
76
+ Cloudflare catch-alls cover only a zone apex. On a subdomain, `_default.ts` can handle mail admitted by an explicit rule, but cannot receive arbitrary addresses.
77
+
78
+ Setup enables the zone's plus addressing so `support+T-42@mail.acme.com` reaches `support+[ticket].ts`. This setting also applies to the apex and other subdomains.
79
+
80
+ `replyEmail()` defaults its sender to the address that received the message. Forwarding requires a verified Cloudflare destination.
81
+
82
+ ### Sending {#sending}
83
+
84
+ On Workers Free, `sendEmail()` can send to verified destinations listed under **Email Routing → Destination addresses** in Cloudflare.
85
+
86
+ Configure your sender domain's SPF, DKIM, and DMARC records using [Cloudflare's email authentication guidance](https://developers.cloudflare.com/email-service/concepts/email-authentication/), then check the authentication results in a received message's original headers. A successful `sendEmail()` result confirms provider acceptance; it does not confirm delivery or authentication readiness.
87
+
88
+ Sending to arbitrary recipients requires [Workers Paid](https://dash.cloudflare.com/?to=/:account/workers/plans) and Email Sending onboarding. After upgrading, run `bwf email setup --platform cloudflare`. bwf doesn't retry onboarding during ordinary deploys.
89
+
90
+ Existing DMARC or bounce-domain records can block onboarding; the checklist identifies conflicts to resolve. Inbound mail remains available.
91
+
92
+ The `bwf email usage`, `logs`, `destinations`, `allow`, and `disallow` commands apply to bwf platforms.
93
+
94
+ ### Configuration changes {#configuration-changes}
95
+
96
+ Commit `bwf.lock.json` after setup. bwf derives routing addresses from your handlers and creates their rules during deployment.
97
+
98
+ Existing rules owned by another Worker or forwarding service are left in place. If you manage `cloudflare.addresses` yourself, follow the checklist rather than combining it with automatic email setup.
99
+
100
+ After deleting a handler, review the reported stale address and set the desired `cloudflare.addresses`. Deleting a routing rule requires confirmation in an interactive terminal.
101
+
102
+ To remove all email setup, remove `addresses`, `send_email`, and `vars.__NOSAM_EMAIL_FROM` from `resolved` in `bwf.lock.json`, remove corresponding overrides in `bwf.config.ts`, and delete the routing rules in Cloudflare.
103
+
104
+ ### CI {#ci}
105
+
106
+ Set up email locally first:
107
+
108
+ ```sh
109
+ bwf email setup --platform cloudflare
110
+ bwf email status --platform cloudflare
111
+ ```
112
+
113
+ Commit `bwf.lock.json`, then deploy in CI with:
114
+
115
+ ```sh
116
+ bwf deploy --platform cloudflare --require-email
117
+ ```
118
+
119
+ CI cannot answer setup prompts. Without `--require-email`, an unconfigured app can deploy without email. If setup is saved but DNS hasn't propagated, deployment waits for a later retry. Workers Free setup for verified recipients satisfies `--require-email`.