@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,142 @@
1
+ ---
2
+ description: 'Receive mail with handlers in email/. Inbound email is available in native bwf apps.'
3
+ outline: deep
4
+ ---
5
+
6
+ # Receiving Email {#inbound}
7
+
8
+ Receive mail with handlers in the top-level `email/` directory. Inbound handlers require a bwf app with a Worker.
9
+
10
+ ```ts
11
+ // email/_default.ts — fallback for any unmatched recipient
12
+ import { defineEmail, parseEmail } from '@builtbyfriends/bwf/email';
13
+
14
+ export default defineEmail(async (message, env, ctx) => {
15
+ const parsed = await parseEmail(message);
16
+
17
+ if (parsed.subject?.startsWith('STOP')) {
18
+ message.setReject('Use the unsubscribe link.');
19
+ return;
20
+ }
21
+
22
+ await message.forward('archive@example.com');
23
+ });
24
+ ```
25
+
26
+ The handler receives Cloudflare's native `ForwardableEmailMessage` plus an optional fourth `info` arg with `params` populated for dynamic / tagged route segments:
27
+
28
+ | Method | Purpose |
29
+ | ---------------------------------- | ------------------------------------------ |
30
+ | `message.setReject(reason)` | Reject the message with an SMTP error. |
31
+ | `message.forward(to, headers?)` | Forward to a verified destination. |
32
+ | `replyEmail(message, options)` | Send a threaded reply. |
33
+ | `message.reply({ from, to, raw })` | Reply using your own MIME bytes or stream. |
34
+
35
+ Returning without an action accepts the message. Use bare email addresses for `forward` and `message.reply`.
36
+
37
+ `parseEmail(message)` returns `from`, `to`, `subject`, `text`, `html`, `attachments`, and `headers`. Call it at most once per message — the underlying stream can only be read once.
38
+
39
+ ## Per-recipient routing {#per-recipient-routing}
40
+
41
+ ```
42
+ email/
43
+ support.ts — handles support@<your-domain>
44
+ billing.ts — handles billing@<your-domain>
45
+ support+[ticket].ts — handles support+ticket-123@... → info.params.ticket = "ticket-123"
46
+ support+vip.ts — handles exactly support+vip@..., ahead of support+[ticket].ts
47
+ [user].ts — dynamic local-part → info.params.user
48
+ [user]+[tag].ts — dynamic + subaddress → info.params.user, info.params.tag
49
+ _default.ts — fallback when no per-address pattern matches
50
+ ```
51
+
52
+ Files are matched against the local-part of the `To` address (the portion before `@`), case-insensitive. **Match precedence (most specific wins):**
53
+
54
+ 1. `support+vip.ts` (static + literal tag)
55
+ 2. `support+[ticket].ts` (static + captured tag)
56
+ 3. `support.ts` (static)
57
+ 4. `[user]+vip.ts` (dynamic + literal tag)
58
+ 5. `[user]+[tag].ts` (dynamic + captured tag)
59
+ 6. `[user].ts` (dynamic)
60
+ 7. `_default.ts` (fallback)
61
+
62
+ The first pattern that matches wins. Within a shape, a literal tag beats a captured tag — `support+vip@` reaches `support+vip.ts`, and every other `support+…@` reaches `support+[ticket].ts`. Handlers of the same shape are tried alphabetically.
63
+
64
+ If nothing matches and there's no `_default.ts`, control returns to Cloudflare and the sender receives a non-delivery report. Nested folders under `email/` are ignored — the recipient is a flat string, not a path.
65
+
66
+ ## Threaded replies {#threaded-replies}
67
+
68
+ ```ts
69
+ // email/support+[ticket].ts
70
+ import { defineEmail, parseEmail, replyEmail } from '@builtbyfriends/bwf/email';
71
+
72
+ export default defineEmail(async (message, env, ctx, info) => {
73
+ const parsed = await parseEmail(message);
74
+ await ticketStore.append(info!.params.ticket, parsed.text ?? '');
75
+
76
+ await replyEmail(message, {
77
+ text: `Got your message on ticket ${info!.params.ticket}.`,
78
+ });
79
+ });
80
+ ```
81
+
82
+ `replyEmail()` replies to the original sender with a threaded subject. You can override `subject`. To reply after the handler returns, use [`sendEmail` with `threading`](./sending.md#reply-later).
83
+
84
+ On a bwf platform, the default sender is your project's shared address, or the address that received mail on your registered domain. Use that default for shared mail; `message.to` has the project prefix removed. Sender overrides must belong to your project.
85
+
86
+ Replies follow your project's recipient policy. Verify shared-sender recipients with `bwf email allow <address>`. Check `bwf email logs` for the provider outcome after the handler finishes.
87
+
88
+ Forwarding requires a native Cloudflare email event. For custom domains relayed through the platform, use replies instead.
89
+
90
+ ## Configuring inbound delivery {#configuring-inbound-delivery}
91
+
92
+ On an email-enabled platform, `<slug>+anything@<mail domain>` reaches your
93
+ deployed `email/` handlers without per-project DNS setup once the platform has verified your recipient rule and enabled plus addressing. bwf sets up that rule when you deploy handlers; creating a project or only sending mail requires no inbound rule. Deployment reports a routing conflict or capacity limit if setup cannot complete. A
94
+ [registered custom domain](./domains.md#your-own-domain-on-the-platform) reaches those
95
+ handlers once its inbound readiness is `ready`. Use `bwf email domain status`
96
+ to check current provider routing and any remaining setup steps.
97
+
98
+ A project with an [email alias](../../reference/cli/email.md#nosam-email-alias) also receives at `<alias>+anything@<mail domain>`. For example, both `acme-store+support@…` and its alias `acme+support@…` reach `email/support.ts`.
99
+
100
+ For direct deployments, follow [Your own Cloudflare account](./domains.md#your-own-cloudflare-account) to configure inbound addresses.
101
+
102
+ Test inbound handlers locally with `createInboundTestHarness` below.
103
+
104
+ ## Testing inbound handlers {#testing-inbound-handlers}
105
+
106
+ Use `createInboundTestHarness` to capture replies, forwards, and rejections. For shared platform mail, pass the full address including the project prefix, such as `acme+support+abc-123@acme.dev`. For direct Cloudflare mail, set `slug: null` and use `support+abc-123@mail.acme.com`.
107
+
108
+ ```ts
109
+ import { createInboundTestHarness } from '@builtbyfriends/bwf/email/testing';
110
+ import { describe, it, expect } from 'vite-plus/test';
111
+ import defaultHandler from './email/_default';
112
+ import support from './email/support+[ticket]';
113
+
114
+ describe('email handlers', () => {
115
+ it('routes to support+[ticket] and extracts the tag', async () => {
116
+ const harness = createInboundTestHarness({
117
+ routes: { 'support+[ticket]': support, _default: defaultHandler },
118
+ });
119
+ const result = await harness.deliver({
120
+ from: 'user@example.com',
121
+ to: 'acme+support+abc-123@acme.dev',
122
+ subject: 'Help',
123
+ text: 'I have a problem',
124
+ });
125
+ expect(result.handler).toBe('support+[ticket]');
126
+ expect(result.params).toEqual({ ticket: 'abc-123' });
127
+ });
128
+
129
+ it('rejects STOP messages via _default', async () => {
130
+ const harness = createInboundTestHarness({ routes: { _default: defaultHandler } });
131
+ await harness.deliver({
132
+ from: 'user@example.com',
133
+ to: 'acme+unknown@acme.dev',
134
+ subject: 'STOP',
135
+ text: 'bye',
136
+ });
137
+ expect(harness.rejects).toEqual(['Use the unsubscribe link.']);
138
+ });
139
+ });
140
+ ```
141
+
142
+ The harness matches handlers in the same order as deployed email routes. [Testing](../testing.md) explains how to run tests and how to test code that uses other bindings.
@@ -0,0 +1,262 @@
1
+ ---
2
+ description: 'Send transactional email with sendEmail. bwf captures messages in a local inbox during development.'
3
+ outline: deep
4
+ ---
5
+
6
+ # Sending Email
7
+
8
+ Use `sendEmail` to send transactional email. During development, bwf captures messages in a local inbox.
9
+
10
+ ```ts
11
+ import { sendEmail } from '@builtbyfriends/bwf/email';
12
+
13
+ const result = await sendEmail({
14
+ from: 'Acme <acme+noreply@mail.example.com>', // use your project's sender address
15
+ to: 'user@example.com',
16
+ subject: 'Welcome',
17
+ text: 'Thanks for signing up!',
18
+ // html: '<p>Thanks for signing up!</p>', // optional — sent as multipart/alternative when paired with text
19
+ });
20
+
21
+ if (!result.ok) {
22
+ if ('error' in result) {
23
+ // A request-level failure; OUTCOME_UNKNOWN may already have been submitted.
24
+ console.error(result.error.code, result.error.message);
25
+ } else {
26
+ // Some recipients failed. `deliveries` says which.
27
+ for (const d of result.deliveries.filter((d) => !d.ok)) {
28
+ console.error(d.recipient, d.error.code, d.error.message);
29
+ }
30
+ }
31
+ }
32
+ ```
33
+
34
+ Check both failure shapes: `result.error` reports a request failure, while `result.deliveries` reports failures for individual recipients. An unverified recipient fails in `deliveries`.
35
+
36
+ ## Setup {#setup}
37
+
38
+ 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#enable-email).
39
+
40
+ Each project on an email-enabled platform has:
41
+
42
+ - **Default sender:** `<your-slug>+noreply@<mail-domain>`. Older projects with slugs longer than 56 characters must pass `from` explicitly.
43
+ - **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 `bwf email destinations` before sending to it.
44
+
45
+ The shared sender can send only to verified recipients. Verify your own address or [add another recipient](#adding-recipients) before sending.
46
+
47
+ Deploying to your own Cloudflare account instead (`bwf deploy --platform cloudflare`) requires a sender in `bwf.config.ts` and email setup — see [Your own Cloudflare account](./domains.md#your-own-cloudflare-account).
48
+
49
+ ## Adding recipients {#adding-recipients}
50
+
51
+ Cloudflare's `send_email` binding only delivers to addresses you've registered as recipients. Add them with the CLI:
52
+
53
+ ```sh
54
+ bwf email allow user@acme.com
55
+ ```
56
+
57
+ Cloudflare emails the recipient with a verification link. Once they click it and `bwf email destinations` has picked the click up, you can send to that address from your project. If the link did not arrive or has expired, run `bwf email allow <address>` again while the address is still pending — the CLI re-sends the link, or tells you how to get a fresh one. List the project's recipients:
58
+
59
+ ```sh
60
+ bwf email destinations
61
+ ```
62
+
63
+ ::: warning When this is the right fit
64
+ The shared sender suits team alerts, project notifications, and replies to inbound mail.
65
+
66
+ For mail to arbitrary users, [register your own domain](./domains.md#your-own-domain-on-the-platform), use [Workers Paid on your own Cloudflare account](./domains.md#your-own-cloudflare-account), or call another email provider from your handler.
67
+ :::
68
+
69
+ ## Options {#options}
70
+
71
+ | Option | Type | Notes |
72
+ | ---------------- | ----------------------------- | -------------------------------------------------------------------------------------------------------------- |
73
+ | `from` | `string \| { email, name? }` | Optional. Pinned to the project sender — see below. |
74
+ | `to` | `Address \| Address[]` | Required. One or more recipients. |
75
+ | `subject` | `string` | Required. UTF-8 supported (encoded as RFC 2047). |
76
+ | `text` | `string` | At least one of `text` / `html` is required. |
77
+ | `html` | `string` | Sent as `multipart/alternative` if both are provided. |
78
+ | `replyTo` | `Address` | Optional `Reply-To` header. |
79
+ | `cc`, `bcc` | `Address \| Address[]` | Optional. Each recipient is sent its own message envelope. |
80
+ | `headers` | `Record<string, string>` | Custom headers; reserved headers (From, Date, etc.) are ignored. |
81
+ | `threading` | `{ inReplyTo?, references? }` | Optional. Threads the email under an earlier message. See [Reply later](#reply-later). |
82
+ | `attachments` | `Attachment[]` | See [Attachments](#attachments). |
83
+ | `idempotencyKey` | `string` | Optional on the bwf Platform: 1–128 printable, non-space ASCII characters. Reuse for retries of the same send. |
84
+
85
+ You can send to at most 50 recipients across `to`, `cc`, and `bcc`. Use standard email addresses with ASCII local parts, and punycode for internationalized domains.
86
+
87
+ `Address` accepts either a string (`"hello@acme.dev"` or `"Name <hello@acme.dev>"`) or an object (`{ email, name? }`). Unicode display names are supported.
88
+
89
+ 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 `bwf email domain add` (see [Your own domain on the platform](./domains.md#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 bwf fills in `<project-slug>+noreply@<mail-domain>` for you. If the project owner set an [email alias](../../reference/cli/email.md#nosam-email-alias), `<alias>@<mail-domain>` and `<alias>+<tag>@<mail-domain>` are accepted too; the default stays the slug address.
90
+
91
+ On your own Cloudflare account, `from` defaults to `email.from` from `bwf.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`.
92
+
93
+ ## Reply later {#reply-later}
94
+
95
+ To reply from a queue job or another later task, save the incoming message's thread IDs and pass them to `sendEmail`:
96
+
97
+ ```ts
98
+ // email/support.ts
99
+ export default defineEmail(async (message) => {
100
+ await tickets.save({
101
+ from: message.from,
102
+ subject: message.headers.get('Subject') ?? '',
103
+ messageId: message.headers.get('Message-ID') ?? '',
104
+ references: message.headers.get('References') ?? '',
105
+ });
106
+ });
107
+
108
+ // Later, in a queue job
109
+ await sendEmail({
110
+ to: ticket.from,
111
+ subject: `Re: ${ticket.subject}`,
112
+ text: 'We fixed it.',
113
+ threading: {
114
+ inReplyTo: ticket.messageId,
115
+ references: `${ticket.references} ${ticket.messageId}`,
116
+ },
117
+ });
118
+ ```
119
+
120
+ Mail clients use `threading` to show the reply in the same conversation. Set `inReplyTo` to the parent's `Message-ID`. For a longer thread, set `references` to the earlier IDs in order, ending with the parent; otherwise it defaults to `inReplyTo`.
121
+
122
+ Use `threading` rather than custom `In-Reply-To` or `References` headers. Invalid thread IDs are omitted without stopping the send. For an immediate reply inside the inbound handler, use [`replyEmail()`](./receiving.md#threaded-replies).
123
+
124
+ ## Attachments {#attachments}
125
+
126
+ ```ts
127
+ await sendEmail({
128
+ to: 'user@example.com',
129
+ subject: 'Your receipt',
130
+ text: 'Receipt attached.',
131
+ attachments: [
132
+ {
133
+ filename: 'receipt.pdf',
134
+ content: pdfBytes, // string | Uint8Array | ArrayBuffer | Blob
135
+ contentType: 'application/pdf',
136
+ },
137
+ ],
138
+ });
139
+ ```
140
+
141
+ For inline images (e.g. logos referenced from HTML), set `disposition: 'inline'` and `contentId`:
142
+
143
+ ```ts
144
+ await sendEmail({
145
+ to: 'user@example.com',
146
+ subject: 'Hello',
147
+ html: '<img src="cid:logo" alt="Acme">',
148
+ attachments: [
149
+ {
150
+ filename: 'logo.png',
151
+ content: logoBytes,
152
+ contentType: 'image/png',
153
+ contentId: 'logo',
154
+ disposition: 'inline',
155
+ },
156
+ ],
157
+ });
158
+ ```
159
+
160
+ bwf 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`.
161
+
162
+ ## Result and errors {#result-and-errors}
163
+
164
+ `sendEmail` returns a result instead of throwing. A successful result means the provider accepted the send; it does not confirm delivery to the recipient's mailbox.
165
+
166
+ `ok: true` includes recipient IDs. A failed result has either a request-level `error` or per-recipient `deliveries`. Platform results include an `operationId` when available.
167
+
168
+ A timeout can return `OUTCOME_UNKNOWN`; the provider may still accept the message. Inspect the outcome before retrying.
169
+
170
+ Use an idempotency key for sends you may retry:
171
+
172
+ ```ts
173
+ const result = await sendEmail({
174
+ to: 'user@example.com',
175
+ subject: 'Invoice ready',
176
+ text: 'Your invoice is available in your account.',
177
+ idempotencyKey: 'invoice:42:ready',
178
+ });
179
+
180
+ if (result.ok) {
181
+ console.log('Accepted by the provider', result.operationId);
182
+ } else {
183
+ console.log('Inspect the outcome before retrying', result.operationId, result);
184
+ }
185
+ ```
186
+
187
+ For 30 days, repeating a key with the same payload returns its recorded outcome without another provider submission. Reusing it with a different payload returns `IDEMPOTENCY_CONFLICT`. A lost response or interrupted provider request can return `OUTCOME_UNKNOWN`; check `bwf email logs` or repeat the same key. A new key creates a new send and can produce a duplicate. Native Cloudflare binding sends do not support platform idempotency keys.
188
+
189
+ | Code | Meaning |
190
+ | ------------------------ | -------------------------------------------------------------- |
191
+ | `BINDING_MISSING` | No email transport is configured. |
192
+ | `INVALID_FROM` | The sender is invalid or not authorized for the project. |
193
+ | `INVALID_TO` | The recipient list is invalid or exceeds 50 recipients. |
194
+ | `UNVERIFIED_DESTINATION` | The recipient needs verification under the active policy. |
195
+ | `MIME_ERROR` | The message is invalid or exceeds a size limit. |
196
+ | `QUOTA_EXCEEDED` | A platform or provider quota has been reached. |
197
+ | `IDEMPOTENCY_CONFLICT` | The key was already used for another payload. |
198
+ | `OUTCOME_UNKNOWN` | The send may have reached the provider; do not blindly resend. |
199
+ | `UPSTREAM_ERROR` | The provider or platform refused the request. |
200
+
201
+ The default platform allowance is 200 recipient attempts per UTC month and 10 per rolling minute. Failed or uncertain attempts can count toward these limits. Check `bwf email usage` for your current allowance.
202
+
203
+ `bwf email usage` shows monthly recipient attempts, inbound receipts, and the remaining allowance. `bwf 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.
204
+
205
+ ## Local development {#local-development}
206
+
207
+ During local development, sends are captured to an in-memory inbox instead of going to Cloudflare. The dev server prints the inbox URL when it starts:
208
+
209
+ ```
210
+ [void] Email inbox: http://localhost:5173/__nosam/inbox?token=<printed-token>
211
+ ```
212
+
213
+ Open a message to preview its HTML, inspect attachments, or download it as an `.eml` file.
214
+
215
+ Every inbox route requires a local access token. bwf includes it in the printed inbox URL and browser links. For command-line requests, send it in the `x-nosam-dev-trigger` header as shown below; requests without it return `401`. The token is stored in `.bwf/dev-trigger-token`. Treat inbox URLs as credentials, especially when exposing your dev server to a network.
216
+
217
+ ```bash
218
+ # download a message as .eml
219
+ curl http://localhost:5173/__nosam/inbox/<id>/raw \
220
+ -H "x-nosam-dev-trigger: <printed-token>" -o message.eml
221
+
222
+ # clear the inbox
223
+ curl -X DELETE http://localhost:5173/__nosam/inbox \
224
+ -H "x-nosam-dev-trigger: <printed-token>"
225
+ ```
226
+
227
+ The inbox keeps the most recent 100 messages through HMR and clears on a full server restart.
228
+
229
+ The dev inbox works in bwf apps. Use `createEmailTestHarness` from `@builtbyfriends/bwf/email/testing` to capture sends in tests. If a configured inbox cannot be reached, `sendEmail` returns `UPSTREAM_ERROR` without sending.
230
+
231
+ Remove the deprecated `sendInDev` option to use the local inbox. Deploy the app to test real delivery.
232
+
233
+ ## Testing {#testing}
234
+
235
+ Use the test harness to assert on outgoing messages without mocking the binding:
236
+
237
+ ```ts
238
+ import { sendEmail } from '@builtbyfriends/bwf/email';
239
+ import { createEmailTestHarness } from '@builtbyfriends/bwf/email/testing';
240
+ import { describe, it, expect } from 'vite-plus/test';
241
+
242
+ describe('signup flow', () => {
243
+ it('sends a welcome email', async () => {
244
+ const inbox = createEmailTestHarness();
245
+
246
+ await sendEmail({
247
+ from: 'acme+noreply@mail.example.com', // use your project sender
248
+ to: 'user@example.com',
249
+ subject: 'Welcome',
250
+ text: 'Hi!',
251
+ });
252
+
253
+ expect(inbox.messages).toHaveLength(1);
254
+ expect(inbox.messages[0].subject).toBe('Welcome');
255
+ inbox.dispose();
256
+ });
257
+ });
258
+ ```
259
+
260
+ The harness intercepts every `sendEmail` call until `dispose()` is called. `clear()` empties the captured list without releasing the sink. [Testing](../testing.md) explains how to run tests and how to test code that uses other bindings.
261
+
262
+ To handle incoming messages, see [Receiving Email](./receiving.md).
@@ -0,0 +1,23 @@
1
+ ---
2
+ description: 'Send transactional email, receive messages in route handlers, and inspect outgoing mail in a local inbox.'
3
+ outline: deep
4
+ ---
5
+
6
+ <script setup>
7
+ import LegacyDocRedirect from '../.vitepress/theme/LegacyDocRedirect.vue';
8
+ import links from '../.vitepress/redirects/guide-email.json';
9
+ </script>
10
+
11
+ <LegacyDocRedirect page="guide/email.md" :links="links" />
12
+
13
+ # Email
14
+
15
+ Use bwf to send transactional email, receive messages in route handlers, and test outgoing mail in a local inbox.
16
+
17
+ | Guide | Use it for |
18
+ | --------------------------------------- | ---------------------------------------------------------------------------- |
19
+ | [Sending Email](./email/sending.md) | Send messages and attachments, handle errors, and test delivery locally. |
20
+ | [Receiving Email](./email/receiving.md) | Route incoming messages, reply, forward, and test handlers. |
21
+ | [Domains and Setup](./email/domains.md) | Register a domain on your platform or configure your own Cloudflare account. |
22
+
23
+ On an email-enabled bwf platform, start with its [shared sender](./email/sending.md#setup). For a direct Cloudflare deployment, [configure a sender and domain](./email/domains.md#your-own-cloudflare-account) first.
@@ -0,0 +1,115 @@
1
+ ---
2
+ description: 'Declare environment variables in env.ts and read the typed values from bwf/env. Use .env locally and secrets in production.'
3
+ ---
4
+
5
+ # Environment variables
6
+
7
+ Declare your environment variables in `env.ts`, then read them through `env` from `@builtbyfriends/bwf/env`. Use `.env` for local values and `bwf secret put` for production server values.
8
+
9
+ ## Define the schema
10
+
11
+ Create `env.ts` at the project root:
12
+
13
+ ```ts
14
+ import { defineEnv, number, string, url } from '@builtbyfriends/bwf/env';
15
+
16
+ export default defineEnv({
17
+ DATABASE_URL: url(),
18
+ STRIPE_KEY: string(),
19
+ PORT: number().default(3000),
20
+ VITE_API_ORIGIN: url(),
21
+ });
22
+ ```
23
+
24
+ Import the typed `env` object in your app:
25
+
26
+ ```ts
27
+ import { env } from '@builtbyfriends/bwf/env';
28
+
29
+ const databaseUrl = env.DATABASE_URL;
30
+ ```
31
+
32
+ The built-in helpers are `string()`, `number()`, `boolean()`, `url()`, `email()`, `oneOf([...])`, and `json<T>()`. They support `.optional()` and `.default(value)`. Any [Standard Schema](https://standardschema.dev/) validator can also be used directly.
33
+
34
+ Defaults are source-code constants. They are appropriate for non-sensitive fallback behavior; do not put credentials in a default.
35
+
36
+ ## Local development
37
+
38
+ Put local values in a single root `.env` file:
39
+
40
+ ```ini
41
+ DATABASE_URL=postgres://localhost/my-app
42
+ STRIPE_KEY=sk_test_example
43
+ VITE_API_ORIGIN=http://localhost:5173
44
+ ```
45
+
46
+ An unquoted value ends at `#`, which starts a comment. Quote a value that contains `#`, such as `DATABASE_URL="postgres://user:p#ss@localhost/my-app"`.
47
+
48
+ Keep `.env` out of Git. Other dotenv files, including `.env.local`, `.env.production`, `.env.example`, and Wrangler’s `.dev.vars*`, are not supported.
49
+
50
+ Names starting with `__NOSAM_` are reserved for bwf. bwf stops with an error if `.env` or `env.ts` defines one.
51
+
52
+ Run the local check at any time:
53
+
54
+ ```sh
55
+ bwf env check
56
+ ```
57
+
58
+ Local database, migration, auth, and dev-server tooling all read the same `.env` file. Shell values override it.
59
+
60
+ ## Production server values
61
+
62
+ Every schema key that is not client-prefixed is a server value. Set it remotely:
63
+
64
+ ```sh
65
+ bwf secret put DATABASE_URL
66
+ bwf secret put STRIPE_KEY
67
+ ```
68
+
69
+ For bulk upload, prepare a dotenv-formatted file containing only production server values:
70
+
71
+ ```sh
72
+ bwf secret sync production-secrets.txt
73
+ ```
74
+
75
+ Secret commands validate values against `env.ts` before upload. Production values are encrypted and validated again at Worker startup.
76
+
77
+ Client-prefixed keys are rejected by secret commands. Keep local development credentials and `VITE_*` values out of the production secrets file.
78
+
79
+ `bwf deploy` requires every required server key to exist remotely. It never uploads `.env` values.
80
+
81
+ The same secret commands work for direct Cloudflare deployments. Schema-declared server values must be Worker secrets, not plaintext `vars`.
82
+
83
+ ## Client values
84
+
85
+ Keys beginning with `VITE_` are client values, even if your framework customizes Vite's `envPrefix`.
86
+
87
+ Client values are embedded in browser JavaScript and are never secrets. Supply them through the build shell or use a schema default:
88
+
89
+ ```sh
90
+ VITE_API_ORIGIN=https://api.example.com bwf deploy
91
+ ```
92
+
93
+ ```ts
94
+ export default defineEnv({
95
+ VITE_API_ORIGIN: url().default('https://api.example.com'),
96
+ });
97
+ ```
98
+
99
+ Builds ignore client values from `.env`; this prevents a developer's local value from silently becoming production configuration.
100
+
101
+ Server rendering uses the same public build values as the browser.
102
+
103
+ ## Validation and redaction
104
+
105
+ ```sh
106
+ bwf env check # validate .env + shell for local development
107
+ bwf env check --remote # validate build-time client values and remote server names
108
+ bwf env types # regenerate .bwf/env.d.ts
109
+ ```
110
+
111
+ Invalid-value diagnostics redact the supplied value by default. Set `BWF_ENV_UNMASK=1` only for deliberate local debugging; bwf prints a notice when redaction is disabled.
112
+
113
+ ## Imports inside `env.ts`
114
+
115
+ Use relative imports or package names inside `env.ts`. TypeScript path aliases and imports that need Vite transforms are not supported.
@@ -0,0 +1,37 @@
1
+ ---
2
+ description: 'bwf builds React single-page apps with an optional backend on Cloudflare Workers, powered by Vite. It connects routing, data, and deployment in one project.'
3
+ outline: deep
4
+ ---
5
+
6
+ # What is bwf?
7
+
8
+ bwf builds React single-page apps with an optional backend on Cloudflare Workers, powered by Vite. Build your UI as a React SPA and write server code in the same project. bwf connects routing, data access, and deployment while keeping types shared across your app.
9
+
10
+ Start with the [Quickstart](./quickstart.md) to create and deploy an app.
11
+
12
+ ## A React app with server routes
13
+
14
+ The UI is a React single-page app: `index.html` loads `src/main.tsx`, Vite bundles it, and the browser renders every page. Use any client-side router you like.
15
+
16
+ The backend is optional. Files in `routes/` define [server routes](./server-routing.md): a handler in `routes/api/users.ts` serves `/api/users`. The app calls them with [typed fetch](./typed-fetch.md), so request and response types stay in sync.
17
+
18
+ ## Resources from your code
19
+
20
+ Import `db` from `@builtbyfriends/bwf/db` to query your database. bwf provides a local database during development and provisions one when you deploy. Imports also enable resources such as [KV](./kv.md), [object storage](./storage.md), and [queues](./queues.md). Use configuration when you need to connect existing resources.
21
+
22
+ Your Drizzle schema defines database types. Handlers infer response types, and typed fetch checks their callers. Changing a field shows you which parts of the app need to change.
23
+
24
+ ## From local development to production
25
+
26
+ Vite runs your app locally with Cloudflare's runtime. `bwf deploy` builds it, provisions resources, applies database migrations, and publishes it. [Environment variables](./env-vars.md) use a schema, local values, and production secrets.
27
+
28
+ Deploy to [your own Cloudflare account](./deployment.md#deploy-to-cloudflare), or connect to a [bwf platform](./self-hosted-platform.md) run by your team. Both use the same application APIs. A platform adds shared access, deployment history, and administration.
29
+
30
+ bwf also deploys [static SPAs and static sites](./app-types.md) without a backend.
31
+
32
+ ## Next steps
33
+
34
+ - [Quickstart](./quickstart.md): create your first app
35
+ - [Server Routing](./server-routing.md): API routes, validation, and middleware
36
+ - [Database](./database.md): schemas, queries, and migrations
37
+ - [Deployment](./deployment.md): Cloudflare, team platforms, and CI
@@ -0,0 +1,80 @@
1
+ ---
2
+ description: 'Schedule work in crons/. Each file sets a cron expression and a handler that bwf registers on deploy.'
3
+ outline: deep
4
+ ---
5
+
6
+ # Cron Jobs
7
+
8
+ Put scheduled jobs in `crons/`. Each file declares a cron expression and a handler, and bwf configures the schedule when you deploy.
9
+
10
+ ## Job files
11
+
12
+ Create files in `crons/**/*.ts` (`.mts`, `.js`, `.mjs` also supported).
13
+
14
+ Each job file must export:
15
+
16
+ - `export const cron = "<expression>"` (or an array of expressions)
17
+ - a default handler (recommended: wrapped with `defineScheduled`)
18
+
19
+ Example:
20
+
21
+ ```ts
22
+ // crons/hourly-heartbeat.ts
23
+ import { defineScheduled } from '@builtbyfriends/bwf';
24
+
25
+ export const cron = '0 * * * *';
26
+
27
+ export default defineScheduled(async (controller, env) => {
28
+ await env.KV.put('jobs:last-heartbeat', controller.scheduledTime.toString());
29
+ });
30
+ ```
31
+
32
+ ### Multiple schedules
33
+
34
+ A single job file can export an array of cron expressions:
35
+
36
+ ```ts
37
+ // crons/cleanup.ts
38
+ import { defineScheduled } from '@builtbyfriends/bwf';
39
+
40
+ export const cron = ['0 * * * *', '30 * * * *'];
41
+
42
+ export default defineScheduled(async (controller, env) => {
43
+ // Runs at :00 and :30 every hour
44
+ });
45
+ ```
46
+
47
+ ## `defineScheduled`
48
+
49
+ Wrap a handler with [`defineScheduled()`](../reference/api/handlers.md#definescheduled-handler) to type its scheduled event, environment, and execution context.
50
+
51
+ Jobs sharing a cron expression each run once per invocation. bwf waits for all matching jobs and reports any failures. Files and directories starting with `_` are ignored.
52
+
53
+ ## Local development
54
+
55
+ Schedules don't fire automatically in local development. Test a job by sending a request to bwf's development endpoint:
56
+
57
+ ```
58
+ POST /__nosam/scheduled
59
+ Content-Type: application/json
60
+ { "cron": "<expression>", "scheduledTime": <unix_ms> }
61
+ ```
62
+
63
+ Set `cron` to an expression exported by your job. A successful call returns `{ "ok": true }`.
64
+
65
+ The endpoint requires a local dev trigger token. bwf prints a paste-ready curl command with the current token when the dev server starts.
66
+
67
+ ```bash
68
+ curl -X POST http://localhost:5173/__nosam/scheduled \
69
+ -H "Content-Type: application/json" \
70
+ -H "x-nosam-dev-trigger: <printed-token>" \
71
+ -d '{"cron":"0 * * * *","scheduledTime":'"$(date +%s000)"'}'
72
+ ```
73
+
74
+ The endpoint works in bwf apps during development.
75
+
76
+ ## Deployment behavior
77
+
78
+ Deployed jobs run from Cloudflare's scheduled events and do not require a manual HTTP token.
79
+
80
+ On a bwf platform, each project can use up to 100 different cron expressions and 1,000 schedules (each expression a job exports counts as one schedule). Jobs that share an expression count once toward the expression limit. When you deploy to your own Cloudflare account, Cloudflare's [Cron Trigger limits](https://developers.cloudflare.com/workers/platform/limits/) apply instead.