@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.
- package/AGENTS_TEMPLATE.md +4 -0
- package/LICENSE +22 -0
- package/README.md +48 -2
- package/dist/account-cmd-Ddt8lGeL.mjs +45 -0
- package/dist/agents-BLiMq9E1.mjs +113 -0
- package/dist/application-analysis-C9Ck2Yeg.mjs +1498 -0
- package/dist/application-routing-DbR-W5lG.mjs +25 -0
- package/dist/atomic-write-DA6eD1Kp.mjs +17 -0
- package/dist/auth-BKsUmWbT.d.mts +77 -0
- package/dist/auth-DkvoW5hB.mjs +33 -0
- package/dist/auth-aKyIWkdS.mjs +1 -0
- package/dist/auth-client-6-Ft9i9T.d.mts +5 -0
- package/dist/auth-client-DwCdwKbw.mjs +5 -0
- package/dist/auth-client-react-CJdeErvM.mjs +5 -0
- package/dist/auth-client-react-DvQLe5Zb.d.mts +5 -0
- package/dist/auth-link-CCl-hJol.mjs +26 -0
- package/dist/auth-migrations-DDeifS3v.mjs +206 -0
- package/dist/auth-router-BG74WFUf.mjs +66 -0
- package/dist/auth-xnkmpZUl.mjs +311 -0
- package/dist/base64-ikl9yBy3.mjs +15 -0
- package/dist/better-auth-shared-Br6TNaYJ.mjs +473 -0
- package/dist/better-auth-shared-CsBNvPOU.d.mts +56 -0
- package/dist/build-cmd-BnZezraT.mjs +153 -0
- package/dist/build-output-dir-Clj_unKN.mjs +402 -0
- package/dist/cancel-deploy-DKAj5U1Z.mjs +57 -0
- package/dist/cf-access-Bhz9wX6p.mjs +131 -0
- package/dist/cf-access-CUP5L08W.mjs +67 -0
- package/dist/cf-build-output-DA6uJomQ.mjs +1 -0
- package/dist/cf-build-output-DNQTwMNU.mjs +438 -0
- package/dist/cf-command-values-2kOtxMo1.mjs +26 -0
- package/dist/cf-config-migrate-COOCi4Ge.mjs +330 -0
- package/dist/cf-worker-settings-CIh4t_yG.mjs +41 -0
- package/dist/cli/cli.d.mts +1 -0
- package/dist/cli/cli.mjs +88 -0
- package/dist/cli/cloudflare-operation-process.d.mts +1 -0
- package/dist/cli/cloudflare-operation-process.mjs +1284 -0
- package/dist/cli/env-schema-probe.d.mts +43 -0
- package/dist/cli/env-schema-probe.mjs +165 -0
- package/dist/cli-main-BfYf6fnB.mjs +1846 -0
- package/dist/client-D3D5RM5h.mjs +940 -0
- package/dist/client-VF2Nzc7Z.mjs +1 -0
- package/dist/cloudflare-auth-DzkU9H6r.mjs +152 -0
- package/dist/cloudflare-cmd-Bm6UhzAQ.mjs +59 -0
- package/dist/cloudflare-config-i8yanry0.mjs +186 -0
- package/dist/cloudflare-connect-B4ItSbJi.mjs +55 -0
- package/dist/cloudflare-operations-BcK849ue.mjs +1 -0
- package/dist/cloudflare-operations-DGF7xH7O.mjs +627 -0
- package/dist/cloudflare-process-tThIjEB2.mjs +309 -0
- package/dist/cloudflare-user-output-CqONaAbP.mjs +19 -0
- package/dist/collect-8i0wU63d.mjs +1 -0
- package/dist/collect-C6Blu9yw.mjs +48 -0
- package/dist/config-CN_RFRkS.mjs +86 -0
- package/dist/config-D5G-Tx6o.mjs +1 -0
- package/dist/config-DOaFIK3w.mjs +88 -0
- package/dist/config-entry.d.mts +202 -0
- package/dist/config-entry.mjs +6 -0
- package/dist/config-tNx0HlFv.mjs +516 -0
- package/dist/connect-CSNWKLzB.mjs +84 -0
- package/dist/create-project-B35ux-LA.mjs +126 -0
- package/dist/create-project-tJ1KwNss.mjs +1 -0
- package/dist/database-provider-DkZo4VwN.mjs +5 -0
- package/dist/database-provider.d.mts +25 -0
- package/dist/database-provider.mjs +1 -0
- package/dist/db-SOv4E9wr.mjs +1735 -0
- package/dist/delete-BSKI7V23.mjs +65 -0
- package/dist/deploy-BCSQoKC0.mjs +2 -0
- package/dist/deploy-CWJ3JJs_.mjs +6512 -0
- package/dist/deploy.d.mts +31 -0
- package/dist/deploy.mjs +118 -0
- package/dist/dev-inbox-I0nqTCdf.mjs +216 -0
- package/dist/discover-DJPmQcL5.mjs +36 -0
- package/dist/discover-EVuydEoM.mjs +1 -0
- package/dist/dist-B6eN80gc.mjs +1612 -0
- package/dist/dist-Cp4b1_T9.mjs +1 -0
- package/dist/dist-DMYe8CZJ.mjs +48 -0
- package/dist/dist-STQXl8ck.mjs +1878 -0
- package/dist/domain-BJaAbxuQ.mjs +149 -0
- package/dist/dotenv-4NdUCXbB.mjs +156 -0
- package/dist/drizzle-DqVFXtlc.mjs +306 -0
- package/dist/drizzle-Ds5P0n-S.mjs +1 -0
- package/dist/edge.d.mts +2 -0
- package/dist/edge.mjs +1 -0
- package/dist/email-C_ATvNIG.mjs +2865 -0
- package/dist/email-cloudflare-oXk2G1G3.mjs +854 -0
- package/dist/email-protocol-CZ0bAkI8.mjs +81 -0
- package/dist/email-rIfZgVAB.mjs +742 -0
- package/dist/env-BGTu3KWZ.mjs +73 -0
- package/dist/env-DUyTzroe.mjs +88 -0
- package/dist/env-Dl4Wggec.mjs +71 -0
- package/dist/env-helpers-BX0APszT.mjs +135 -0
- package/dist/env-helpers-U56xuFgL.d.mts +20 -0
- package/dist/env-mask-BsHxq3R8.mjs +46 -0
- package/dist/env-public-Cw_xPi1D.d.mts +119 -0
- package/dist/env-raw-Bo6TtrHU.mjs +41 -0
- package/dist/env-types-Bg-dTh8u.mjs +56 -0
- package/dist/env-validation-BlXzGgLZ.mjs +1 -0
- package/dist/env-validation-DeqFUSKg.mjs +488 -0
- package/dist/fetch-CBgyyhzm.d.mts +87 -0
- package/dist/fetch-error-DmlRM6e4.mjs +264 -0
- package/dist/fetch-stream-2GUN3YN1.mjs +102 -0
- package/dist/fetch-stream-bUXynOyZ.d.mts +32 -0
- package/dist/fetch-tpPiSK10.mjs +25 -0
- package/dist/gen-dc13IRXh.mjs +509 -0
- package/dist/gen-kQqhFyOP.mjs +1 -0
- package/dist/generate-BgtlYpKg.mjs +1 -0
- package/dist/generate-Da9mWKzU.mjs +80 -0
- package/dist/generated-wrangler-config-CoDaaFsA.mjs +17 -0
- package/dist/git-metadata-Cukp5kV5.mjs +82 -0
- package/dist/github-cmd-DT5Onu6E.mjs +690 -0
- package/dist/handler-B_ocHStk.d.mts +279 -0
- package/dist/handler-CNq7aSs1.mjs +161 -0
- package/dist/help-BK35YcRa.mjs +1946 -0
- package/dist/help-DaRezBj7.mjs +1 -0
- package/dist/inbound-CqubE-9T.d.mts +311 -0
- package/dist/inbound-lHugZPuK.mjs +509 -0
- package/dist/index.d.mts +64 -0
- package/dist/index.mjs +4163 -0
- package/dist/info-CLQoCenb.mjs +109 -0
- package/dist/init-CXanf5ck.mjs +2486 -0
- package/dist/limits-CMmYT2l8.d.mts +16 -0
- package/dist/limits-D27Lp6FP.mjs +46 -0
- package/dist/link-DinwJnon.mjs +52 -0
- package/dist/list-B1WAE9Wt.mjs +130 -0
- package/dist/live-KkEeda1Z.d.mts +105 -0
- package/dist/live-saC8barp.mjs +410 -0
- package/dist/load-user-env-g0ahkZcj.mjs +34 -0
- package/dist/local-d1-bUoAtFUe.mjs +103 -0
- package/dist/log-JDnPc0cF.mjs +23 -0
- package/dist/login-BUzyiyHV.mjs +1 -0
- package/dist/login-Dbv_T3Ru.mjs +87 -0
- package/dist/logs-BjMJooJQ.mjs +129 -0
- package/dist/migrate-DjW9_-sS.mjs +1 -0
- package/dist/migrate-DtcfKqPW.mjs +125 -0
- package/dist/migration-handler-22qiuWPq.mjs +469 -0
- package/dist/migration-handler-Bb2BJh6g.d.mts +38 -0
- package/dist/mime-BMUN_QKG.mjs +1004 -0
- package/dist/mysql-migration-sql-CNuBSqdx.mjs +239 -0
- package/dist/neon-CJzQSycr.mjs +52 -0
- package/dist/node-tfv-3v0V.mjs +64 -0
- package/dist/operator-ai-logging-Ay7M4KWw.mjs +121 -0
- package/dist/operator-args-BiGmSlZx.mjs +722 -0
- package/dist/operator-auth-DdYZYEkO.mjs +47 -0
- package/dist/operator-client-DBujdELO.mjs +82 -0
- package/dist/operator-cmd-BsHKYJYt.mjs +1 -0
- package/dist/operator-cmd-DTIkOAnP.mjs +443 -0
- package/dist/output-Bb34lF0w.mjs +173 -0
- package/dist/output-CVolXKC1.mjs +1 -0
- package/dist/package-BX_giUBX.mjs +1444 -0
- package/dist/package-json-DvS6IFRv.mjs +43 -0
- package/dist/pg-DoyPxa_X.mjs +15 -0
- package/dist/picocolors-D1NxSLw-.mjs +71 -0
- package/dist/plan-BHNt1QhK.mjs +1 -0
- package/dist/plan-DX4_-OM5.mjs +58 -0
- package/dist/platform-args-C-DyuCNX.mjs +1 -0
- package/dist/platform-args-CyeQWaZ7.mjs +538 -0
- package/dist/platform-auth-config-BfXqKSyZ.mjs +371 -0
- package/dist/platform-auth-protection-5FR6qoP_.mjs +231 -0
- package/dist/platform-auth-recovery-B5ZlqA8K.mjs +309 -0
- package/dist/platform-cmd-CcFDxtrl.mjs +1 -0
- package/dist/platform-cmd-ChXeBrRH.mjs +193 -0
- package/dist/platform-discovery-Bxg9aZXU.mjs +40 -0
- package/dist/platform-domain-CwatS3cz.mjs +256 -0
- package/dist/platform-lifecycle-0cXTmMsh.mjs +8928 -0
- package/dist/platform-lifecycle-BcoBAMux.mjs +1 -0
- package/dist/platform-management-6Wbdbob5.mjs +1607 -0
- package/dist/platform-management-hhnczOzr.mjs +1 -0
- package/dist/platform-plans-config-CkbUKFpm.mjs +447 -0
- package/dist/platform-recovery-DgIwlqB-.mjs +96 -0
- package/dist/platform-registry-x1m9HBxf.mjs +450 -0
- package/dist/platform-runtime-logs-kkoiYFpF.mjs +72 -0
- package/dist/platform-setup-DX8y_6Kh.mjs +306 -0
- package/dist/prepare-B9mB47T5.mjs +84 -0
- package/dist/prepare-DNIq07so.mjs +13 -0
- package/dist/prepare-LHkyJqxi.mjs +1 -0
- package/dist/project-CC7eN00D.mjs +141 -0
- package/dist/project-DcSd4BeI.mjs +1 -0
- package/dist/project-cmd-BydRwr-x.mjs +109 -0
- package/dist/project-paths-iXHKRTTQ.mjs +159 -0
- package/dist/project-slug-BUy0lmyR.mjs +1 -0
- package/dist/project-slug-CO6ci9XG.mjs +7 -0
- package/dist/project-team-CvdLhDF2.mjs +129 -0
- package/dist/project-token-CwZdUEGu.mjs +70 -0
- package/dist/project-tsconfig-P9X952KG.mjs +98 -0
- package/dist/project-zero-trust-CKDoPdN1.mjs +64 -0
- package/dist/providers-Cd3c7wi0.mjs +64 -0
- package/dist/providers-Df69hb_X.d.mts +5 -0
- package/dist/provision-BA59NCPO.mjs +1 -0
- package/dist/provision-C90fULHJ.mjs +1814 -0
- package/dist/queues-Bc3FsBQT.d.mts +5 -0
- package/dist/r2-conditions-DSLmkiR5.mjs +60 -0
- package/dist/requests-DNhfyF3l.mjs +52 -0
- package/dist/resolve-project-BCsAMDRA.mjs +47 -0
- package/dist/resolve-project-DhU9_lIo.mjs +1 -0
- package/dist/resource-name-DlJ9QXzg.mjs +10 -0
- package/dist/response-HmNjB30w.mjs +29 -0
- package/dist/rollback-wi6WK5T6.mjs +150 -0
- package/dist/rolldown-runtime-uD8oG6U2.mjs +24 -0
- package/dist/route-types-CRWhr93D.mjs +592 -0
- package/dist/route-url-BIDZT78M.mjs +58 -0
- package/dist/route-url-Bla3Upsy.d.mts +42 -0
- package/dist/routes-stub.d.mts +24 -0
- package/dist/routes-stub.mjs +1 -0
- package/dist/routing-assets-CSheDWWM.mjs +54 -0
- package/dist/rpc-DcByS_q0.d.mts +39 -0
- package/dist/rpc-DtxIN9Tv.mjs +19 -0
- package/dist/runner-CPerdjIl.mjs +163 -0
- package/dist/runner-CUNtS5x7.mjs +1 -0
- package/dist/runner-mysql-BjSoQ-mW.mjs +1 -0
- package/dist/runner-mysql-BmTI2EiF.mjs +145 -0
- package/dist/runner-pg-2pjltt0t.mjs +1 -0
- package/dist/runner-pg-mYc75KfH.mjs +61 -0
- package/dist/runtime/ai.d.mts +50 -0
- package/dist/runtime/ai.mjs +455 -0
- package/dist/runtime/auth-client-react.d.mts +2 -0
- package/dist/runtime/auth-client-react.mjs +1 -0
- package/dist/runtime/auth-client.d.mts +2 -0
- package/dist/runtime/auth-client.mjs +1 -0
- package/dist/runtime/auth.d.mts +2 -0
- package/dist/runtime/auth.mjs +1 -0
- package/dist/runtime/better-auth-mysql.d.mts +5 -0
- package/dist/runtime/better-auth-mysql.mjs +21 -0
- package/dist/runtime/better-auth-pg.d.mts +5 -0
- package/dist/runtime/better-auth-pg.mjs +21 -0
- package/dist/runtime/better-auth.d.mts +6 -0
- package/dist/runtime/better-auth.mjs +22 -0
- package/dist/runtime/client-react.d.mts +5 -0
- package/dist/runtime/client-react.mjs +5 -0
- package/dist/runtime/client.d.mts +5 -0
- package/dist/runtime/client.mjs +5 -0
- package/dist/runtime/db-mysql.d.mts +2 -0
- package/dist/runtime/db-mysql.mjs +1 -0
- package/dist/runtime/db-pg.d.mts +2 -0
- package/dist/runtime/db-pg.mjs +1 -0
- package/dist/runtime/db.d.mts +17 -0
- package/dist/runtime/db.mjs +36 -0
- package/dist/runtime/drizzle-arktype.d.mts +1 -0
- package/dist/runtime/drizzle-arktype.mjs +2 -0
- package/dist/runtime/drizzle-valibot.d.mts +1 -0
- package/dist/runtime/drizzle-valibot.mjs +2 -0
- package/dist/runtime/drizzle-zod.d.mts +1 -0
- package/dist/runtime/drizzle-zod.mjs +2 -0
- package/dist/runtime/durable.d.mts +64 -0
- package/dist/runtime/durable.mjs +165 -0
- package/dist/runtime/email/testing.d.mts +108 -0
- package/dist/runtime/email/testing.mjs +268 -0
- package/dist/runtime/email-protocol.d.mts +25 -0
- package/dist/runtime/email-protocol.mjs +1 -0
- package/dist/runtime/email.d.mts +26 -0
- package/dist/runtime/email.mjs +524 -0
- package/dist/runtime/env-public-client.d.mts +19 -0
- package/dist/runtime/env-public-client.mjs +55 -0
- package/dist/runtime/env-public.d.mts +4 -0
- package/dist/runtime/env-public.mjs +277 -0
- package/dist/runtime/env.d.mts +12 -0
- package/dist/runtime/env.mjs +1 -0
- package/dist/runtime/fetch-server.d.mts +6 -0
- package/dist/runtime/fetch-server.mjs +29 -0
- package/dist/runtime/fetch-stream.d.mts +3 -0
- package/dist/runtime/fetch-stream.mjs +3 -0
- package/dist/runtime/fetch.d.mts +2 -0
- package/dist/runtime/fetch.mjs +3 -0
- package/dist/runtime/handler.d.mts +3 -0
- package/dist/runtime/handler.mjs +1 -0
- package/dist/runtime/kv.d.mts +45 -0
- package/dist/runtime/kv.mjs +103 -0
- package/dist/runtime/limits.d.mts +2 -0
- package/dist/runtime/limits.mjs +1 -0
- package/dist/runtime/live-client.d.mts +40 -0
- package/dist/runtime/live-client.mjs +282 -0
- package/dist/runtime/live-server.d.mts +11 -0
- package/dist/runtime/live-server.mjs +419 -0
- package/dist/runtime/live.d.mts +3 -0
- package/dist/runtime/live.mjs +1 -0
- package/dist/runtime/log.d.mts +24 -0
- package/dist/runtime/log.mjs +57 -0
- package/dist/runtime/migration-handler-mysql.d.mts +2 -0
- package/dist/runtime/migration-handler-mysql.mjs +111 -0
- package/dist/runtime/migration-handler-pg.d.mts +2 -0
- package/dist/runtime/migration-handler-pg.mjs +94 -0
- package/dist/runtime/migration-handler.d.mts +2 -0
- package/dist/runtime/migration-handler.mjs +1 -0
- package/dist/runtime/procedure.d.mts +27 -0
- package/dist/runtime/procedure.mjs +36 -0
- package/dist/runtime/procedures.d.mts +24 -0
- package/dist/runtime/procedures.mjs +56 -0
- package/dist/runtime/queues.d.mts +2 -0
- package/dist/runtime/queues.mjs +8 -0
- package/dist/runtime/remote/binding-handler.d.mts +11 -0
- package/dist/runtime/remote/binding-handler.mjs +227 -0
- package/dist/runtime/remote/index.d.mts +12 -0
- package/dist/runtime/remote/index.mjs +467 -0
- package/dist/runtime/response.d.mts +11 -0
- package/dist/runtime/response.mjs +1 -0
- package/dist/runtime/route-url.d.mts +2 -0
- package/dist/runtime/route-url.mjs +1 -0
- package/dist/runtime/routing.d.mts +53 -0
- package/dist/runtime/routing.mjs +425 -0
- package/dist/runtime/rpc-react.d.mts +16 -0
- package/dist/runtime/rpc-react.mjs +50 -0
- package/dist/runtime/rpc.d.mts +2 -0
- package/dist/runtime/rpc.mjs +1 -0
- package/dist/runtime/sandbox-container.d.mts +3 -0
- package/dist/runtime/sandbox-container.mjs +1 -0
- package/dist/runtime/sandbox.d.mts +5 -0
- package/dist/runtime/sandbox.mjs +196 -0
- package/dist/runtime/schema-d1.d.mts +1 -0
- package/dist/runtime/schema-d1.mjs +2 -0
- package/dist/runtime/schema-mysql.d.mts +1 -0
- package/dist/runtime/schema-mysql.mjs +2 -0
- package/dist/runtime/schema-pg.d.mts +1 -0
- package/dist/runtime/schema-pg.mjs +2 -0
- package/dist/runtime/seed.d.mts +34 -0
- package/dist/runtime/seed.mjs +5 -0
- package/dist/runtime/sse-client.d.mts +31 -0
- package/dist/runtime/sse-client.mjs +42 -0
- package/dist/runtime/sse.d.mts +32 -0
- package/dist/runtime/sse.mjs +1 -0
- package/dist/runtime/storage.d.mts +4 -0
- package/dist/runtime/storage.mjs +13 -0
- package/dist/runtime/validator.d.mts +2 -0
- package/dist/runtime/validator.mjs +1 -0
- package/dist/runtime/ws-server.d.mts +26 -0
- package/dist/runtime/ws-server.mjs +297 -0
- package/dist/runtime/ws.d.mts +2 -0
- package/dist/runtime/ws.mjs +108 -0
- package/dist/sandbox-CWDjoEG2.d.mts +50 -0
- package/dist/sandbox-container-BqamdFCx.d.mts +73 -0
- package/dist/sandbox-container-d1AHLpgn.mjs +291 -0
- package/dist/secret-D5XrWshs.mjs +146 -0
- package/dist/skills-Dr3AjuBF.mjs +63 -0
- package/dist/sqlite-validation-CLJXXN93.mjs +24 -0
- package/dist/sse-CxR30yMF.mjs +174 -0
- package/dist/standard-schema-CuDawHOC.d.mts +40 -0
- package/dist/static-asset-marker-mWMX2dLa.mjs +38 -0
- package/dist/subcommand-prompt-B9yUo--u.mjs +370 -0
- package/dist/terminal-log-text-DNsWJREL.mjs +31 -0
- package/dist/types-D7-4tBu7.d.mts +1 -0
- package/dist/untrusted-env-lL7RkYiC.mjs +50 -0
- package/dist/validate-B-zsjhiz.mjs +162 -0
- package/dist/validate-DbqGdPPY.mjs +1 -0
- package/dist/validator-8-NZs2Xr.mjs +168 -0
- package/dist/version-metadata-DPhqnpaa.mjs +23 -0
- package/dist/wrangler-C3uyPadQ.mjs +1 -0
- package/dist/wrangler-TqTvJFWS.mjs +1452 -0
- package/dist/ws-DZRiIpYw.d.mts +137 -0
- package/dist/yarn-pnp-DgWbE7z5.mjs +91 -0
- package/docs/guide/ai.md +273 -0
- package/docs/guide/app-types.md +101 -0
- package/docs/guide/auth.md +255 -0
- package/docs/guide/database/d1.md +86 -0
- package/docs/guide/database/mysql.md +72 -0
- package/docs/guide/database/postgresql.md +94 -0
- package/docs/guide/database.md +454 -0
- package/docs/guide/deployment.md +124 -0
- package/docs/guide/durable-state.md +192 -0
- package/docs/guide/edge/headers.md +47 -0
- package/docs/guide/edge/redirects.md +85 -0
- package/docs/guide/edge/rewrites.md +119 -0
- package/docs/guide/edge/static-assets.md +94 -0
- package/docs/guide/email/domains.md +119 -0
- package/docs/guide/email/receiving.md +142 -0
- package/docs/guide/email/sending.md +262 -0
- package/docs/guide/email.md +23 -0
- package/docs/guide/env-vars.md +115 -0
- package/docs/guide/index.md +37 -0
- package/docs/guide/jobs.md +80 -0
- package/docs/guide/kv.md +100 -0
- package/docs/guide/live.md +181 -0
- package/docs/guide/platform/administration/access.md +165 -0
- package/docs/guide/platform/administration/connected-apps.md +84 -0
- package/docs/guide/platform/administration/email.md +169 -0
- package/docs/guide/platform/administration/operations.md +100 -0
- package/docs/guide/platform/administration/plans.md +156 -0
- package/docs/guide/platform/administration/projects.md +74 -0
- package/docs/guide/platform/administration/zero-trust.md +205 -0
- package/docs/guide/platform/development/local.md +122 -0
- package/docs/guide/platform/development/runtime.md +115 -0
- package/docs/guide/platform/development/schema-ci.md +44 -0
- package/docs/guide/platform/installation/ci.md +62 -0
- package/docs/guide/platform/installation/credentials.md +140 -0
- package/docs/guide/platform/installation/domains.md +120 -0
- package/docs/guide/platform/installation/first-deployment.md +95 -0
- package/docs/guide/platform/installation/maintenance.md +250 -0
- package/docs/guide/platform/installation/prerequisites.md +176 -0
- package/docs/guide/platform/installation/setup.md +300 -0
- package/docs/guide/platform/installation/uninstall.md +110 -0
- package/docs/guide/platform-administration.md +19 -0
- package/docs/guide/platform-development.md +16 -0
- package/docs/guide/procedures.md +48 -0
- package/docs/guide/project-collaboration.md +99 -0
- package/docs/guide/queues.md +149 -0
- package/docs/guide/quickstart.md +129 -0
- package/docs/guide/remote-dev.md +67 -0
- package/docs/guide/sandboxes.md +134 -0
- package/docs/guide/self-hosted-platform.md +45 -0
- package/docs/guide/server-routing.md +283 -0
- package/docs/guide/sse.md +174 -0
- package/docs/guide/storage.md +82 -0
- package/docs/guide/testing.md +64 -0
- package/docs/guide/type-safety.md +270 -0
- package/docs/guide/typed-fetch.md +98 -0
- package/docs/guide/websockets.md +230 -0
- package/docs/index.md +102 -0
- package/docs/integrations/agents.md +38 -0
- package/docs/integrations/cloudflare.md +241 -0
- package/docs/integrations/hono.md +127 -0
- package/docs/reference/api/auth.md +195 -0
- package/docs/reference/api/client.md +90 -0
- package/docs/reference/api/database.md +118 -0
- package/docs/reference/api/deploy.md +63 -0
- package/docs/reference/api/durable.md +47 -0
- package/docs/reference/api/env.md +51 -0
- package/docs/reference/api/handlers.md +189 -0
- package/docs/reference/api/plugin.md +40 -0
- package/docs/reference/api/resources.md +116 -0
- package/docs/reference/api/rewrites.md +111 -0
- package/docs/reference/api/types.md +126 -0
- package/docs/reference/api.md +71 -0
- package/docs/reference/cli/auth.md +87 -0
- package/docs/reference/cli/database.md +159 -0
- package/docs/reference/cli/deploy.md +117 -0
- package/docs/reference/cli/domains.md +42 -0
- package/docs/reference/cli/email.md +145 -0
- package/docs/reference/cli/generate.md +113 -0
- package/docs/reference/cli/github.md +181 -0
- package/docs/reference/cli/platform-config.md +93 -0
- package/docs/reference/cli/platform-email.md +81 -0
- package/docs/reference/cli/platform-installation.md +166 -0
- package/docs/reference/cli/platform-operations.md +90 -0
- package/docs/reference/cli/platform-users.md +159 -0
- package/docs/reference/cli/platform-zero-trust.md +60 -0
- package/docs/reference/cli/platform.md +78 -0
- package/docs/reference/cli/project.md +208 -0
- package/docs/reference/cli/secrets.md +79 -0
- package/docs/reference/cli/setup.md +88 -0
- package/docs/reference/cli.md +115 -0
- package/docs/reference/config.md +478 -0
- package/docs/reference/resource-inference.md +72 -0
- package/docs/reference/structure.md +138 -0
- package/package.json +389 -3
- package/sandbox.Dockerfile +4 -0
- package/schema.json +353 -0
- package/skills/bwf/SKILL.md +100 -0
- package/skills/migrate-vite-cloudflare-to-bwf/SKILL.md +53 -0
- package/templates/assets/bwf.svg +5 -0
- package/templates/assets/icons.svg +49 -0
- package/templates/assets/react.svg +1 -0
- package/templates/assets/stack.svg +35 -0
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
import { t as StandardSchemaV1 } from "./standard-schema-CuDawHOC.mjs";
|
|
2
|
+
import { i as AuthUser } from "./auth-BKsUmWbT.mjs";
|
|
3
|
+
import { o as CloudEnv } from "./handler-B_ocHStk.mjs";
|
|
4
|
+
import { WebSocketRouteMap } from "@builtbyfriends/bwf/routes";
|
|
5
|
+
type MaybePromise<T> = T | Promise<T>;
|
|
6
|
+
type ParamsRecord = Record<string, string>;
|
|
7
|
+
type WebSocketInstanceKey = (context: {
|
|
8
|
+
params: ParamsRecord;
|
|
9
|
+
}) => string;
|
|
10
|
+
type WsEntry<P extends keyof WebSocketRouteMap> = WebSocketRouteMap[P];
|
|
11
|
+
type ParamsOf<P extends keyof WebSocketRouteMap> = WsEntry<P> extends {
|
|
12
|
+
params: infer T;
|
|
13
|
+
} ? T : Record<string, never>;
|
|
14
|
+
type ClientEventOf<P extends keyof WebSocketRouteMap> = WsEntry<P> extends {
|
|
15
|
+
client: infer T;
|
|
16
|
+
} ? T : never;
|
|
17
|
+
type ServerEventOf<P extends keyof WebSocketRouteMap> = WsEntry<P> extends {
|
|
18
|
+
server: infer T;
|
|
19
|
+
} ? T : never;
|
|
20
|
+
type HasParams<P extends keyof WebSocketRouteMap> = ParamsOf<P> extends Record<string, never> ? false : [keyof ParamsOf<P>] extends [never] ? false : true;
|
|
21
|
+
type WebSocketConnection<ServerEvent = unknown> = {
|
|
22
|
+
readonly id: string;
|
|
23
|
+
readonly state: unknown;
|
|
24
|
+
send(event: ServerEvent): Promise<void>;
|
|
25
|
+
close(code?: number, reason?: string): void;
|
|
26
|
+
setState(data: unknown): void;
|
|
27
|
+
};
|
|
28
|
+
type RoomController<ServerEvent = unknown> = {
|
|
29
|
+
broadcast(event: ServerEvent, excludeIds?: Array<string>): Promise<void>;
|
|
30
|
+
getConnections(): Iterable<WebSocketConnection<ServerEvent>>;
|
|
31
|
+
getConnection(id: string): WebSocketConnection<ServerEvent> | undefined;
|
|
32
|
+
};
|
|
33
|
+
type WebSocketBaseContext = {
|
|
34
|
+
readonly id: string;
|
|
35
|
+
readonly params: ParamsRecord;
|
|
36
|
+
readonly user: AuthUser | null;
|
|
37
|
+
/**
|
|
38
|
+
* The HTTP request in `onBeforeConnect`, `onConnect` and `onRequest`. In `onMessage` and
|
|
39
|
+
* `onClose` the connection can resume after hibernation, so this is a placeholder without
|
|
40
|
+
* headers, cookies or query. Use `params`, `user` or the connection `state` there.
|
|
41
|
+
*/
|
|
42
|
+
readonly request: Request;
|
|
43
|
+
readonly env: CloudEnv["Bindings"];
|
|
44
|
+
readonly storage: DurableObjectStorage;
|
|
45
|
+
};
|
|
46
|
+
type RoomContext<ServerEvent = unknown> = WebSocketBaseContext & {
|
|
47
|
+
readonly room: RoomController<ServerEvent>;
|
|
48
|
+
readonly connection: WebSocketConnection<ServerEvent>;
|
|
49
|
+
};
|
|
50
|
+
type SocketContext<ServerEvent = unknown> = WebSocketBaseContext & {
|
|
51
|
+
readonly socket: WebSocketConnection<ServerEvent>;
|
|
52
|
+
};
|
|
53
|
+
type RoomDefinition<ClientSchema extends StandardSchemaV1 = StandardSchemaV1, ServerSchema extends StandardSchemaV1 = StandardSchemaV1> = {
|
|
54
|
+
readonly __kind: "room";
|
|
55
|
+
/** Optional persistent resource name. Pin the name reported by `bwf info` before moving this route. */
|
|
56
|
+
readonly name?: string;
|
|
57
|
+
/** Optional instance key; preserve existing keys when renaming route parameters. */
|
|
58
|
+
readonly key?: WebSocketInstanceKey;
|
|
59
|
+
readonly messages: {
|
|
60
|
+
client: ClientSchema;
|
|
61
|
+
server: ServerSchema;
|
|
62
|
+
};
|
|
63
|
+
onBeforeConnect?: (ctx: RoomContext<StandardSchemaV1.InferInput<ServerSchema>>) => MaybePromise<Response | void>;
|
|
64
|
+
onConnect?: (ctx: RoomContext<StandardSchemaV1.InferInput<ServerSchema>>) => MaybePromise<void>;
|
|
65
|
+
onMessage?: (ctx: RoomContext<StandardSchemaV1.InferInput<ServerSchema>>, event: StandardSchemaV1.InferOutput<ClientSchema>) => MaybePromise<void>;
|
|
66
|
+
onClose?: (ctx: RoomContext<StandardSchemaV1.InferInput<ServerSchema>>, details?: {
|
|
67
|
+
code: number;
|
|
68
|
+
reason: string;
|
|
69
|
+
wasClean: boolean;
|
|
70
|
+
}) => MaybePromise<void>;
|
|
71
|
+
onRequest?: (ctx: RoomContext<StandardSchemaV1.InferInput<ServerSchema>>) => MaybePromise<Response>;
|
|
72
|
+
};
|
|
73
|
+
type SocketDefinition<ClientSchema extends StandardSchemaV1 = StandardSchemaV1, ServerSchema extends StandardSchemaV1 = StandardSchemaV1> = {
|
|
74
|
+
readonly __kind: "socket";
|
|
75
|
+
/** Optional persistent resource name. Pin the name reported by `bwf info` before moving this route. */
|
|
76
|
+
readonly name?: string;
|
|
77
|
+
/** Optional instance key; preserve existing keys when renaming route parameters. */
|
|
78
|
+
readonly key?: WebSocketInstanceKey;
|
|
79
|
+
readonly messages: {
|
|
80
|
+
client: ClientSchema;
|
|
81
|
+
server: ServerSchema;
|
|
82
|
+
};
|
|
83
|
+
onBeforeConnect?: (ctx: SocketContext<StandardSchemaV1.InferInput<ServerSchema>>) => MaybePromise<Response | void>;
|
|
84
|
+
onConnect?: (ctx: SocketContext<StandardSchemaV1.InferInput<ServerSchema>>) => MaybePromise<void>;
|
|
85
|
+
onMessage?: (ctx: SocketContext<StandardSchemaV1.InferInput<ServerSchema>>, event: StandardSchemaV1.InferOutput<ClientSchema>) => MaybePromise<void>;
|
|
86
|
+
onClose?: (ctx: SocketContext<StandardSchemaV1.InferInput<ServerSchema>>, details?: {
|
|
87
|
+
code: number;
|
|
88
|
+
reason: string;
|
|
89
|
+
wasClean: boolean;
|
|
90
|
+
}) => MaybePromise<void>;
|
|
91
|
+
onRequest?: (ctx: SocketContext<StandardSchemaV1.InferInput<ServerSchema>>) => MaybePromise<Response>;
|
|
92
|
+
};
|
|
93
|
+
type AnyWebSocketDefinition = RoomDefinition | SocketDefinition;
|
|
94
|
+
declare function defineRoom<ClientSchema extends StandardSchemaV1, ServerSchema extends StandardSchemaV1>(definition: Omit<RoomDefinition<ClientSchema, ServerSchema>, "__kind">): RoomDefinition<ClientSchema, ServerSchema>;
|
|
95
|
+
declare function defineWebSocket<ClientSchema extends StandardSchemaV1, ServerSchema extends StandardSchemaV1>(definition: Omit<SocketDefinition<ClientSchema, ServerSchema>, "__kind">): SocketDefinition<ClientSchema, ServerSchema>;
|
|
96
|
+
type BwfSocketCloseEvent = {
|
|
97
|
+
code?: number;
|
|
98
|
+
reason?: string;
|
|
99
|
+
wasClean?: boolean;
|
|
100
|
+
};
|
|
101
|
+
type ConnectCommonOptions = {
|
|
102
|
+
baseURL?: string;
|
|
103
|
+
reconnect?: boolean;
|
|
104
|
+
reconnectDelayMs?: number;
|
|
105
|
+
maxReconnectAttempts?: number;
|
|
106
|
+
protocols?: string | Array<string>;
|
|
107
|
+
};
|
|
108
|
+
type ConnectOptions<P extends keyof WebSocketRouteMap> = ConnectCommonOptions & (HasParams<P> extends true ? {
|
|
109
|
+
params: ParamsOf<P>;
|
|
110
|
+
} : {
|
|
111
|
+
params?: never;
|
|
112
|
+
});
|
|
113
|
+
type ListenerMap<ServerEvent> = {
|
|
114
|
+
message: (event: ServerEvent) => void;
|
|
115
|
+
open: () => void;
|
|
116
|
+
close: (event: BwfSocketCloseEvent) => void;
|
|
117
|
+
error: (error: unknown) => void;
|
|
118
|
+
};
|
|
119
|
+
declare class BwfSocket<P extends keyof WebSocketRouteMap & string> {
|
|
120
|
+
private readonly url;
|
|
121
|
+
private readonly options;
|
|
122
|
+
private socket;
|
|
123
|
+
private readonly listeners;
|
|
124
|
+
private readonly buffer;
|
|
125
|
+
private reconnectAttempts;
|
|
126
|
+
private closedByUser;
|
|
127
|
+
private reconnectTimer;
|
|
128
|
+
constructor(url: string, options: ConnectCommonOptions);
|
|
129
|
+
private emit;
|
|
130
|
+
private connect;
|
|
131
|
+
send(event: ClientEventOf<P>): void;
|
|
132
|
+
close(code?: number, reason?: string): void;
|
|
133
|
+
on<K extends keyof ListenerMap<ServerEventOf<P>>>(type: K, handler: ListenerMap<ServerEventOf<P>>[K]): () => void;
|
|
134
|
+
}
|
|
135
|
+
declare function connect<P extends keyof WebSocketRouteMap & string>(path: HasParams<P> extends false ? P : never): BwfSocket<P>;
|
|
136
|
+
declare function connect<P extends keyof WebSocketRouteMap & string>(path: P, options: ConnectOptions<P>): BwfSocket<P>;
|
|
137
|
+
export { RoomContext as a, SocketContext as c, WebSocketConnection as d, WebSocketInstanceKey as f, defineWebSocket as h, ConnectCommonOptions as i, SocketDefinition as l, defineRoom as m, BwfSocket as n, RoomController as o, connect as p, BwfSocketCloseEvent as r, RoomDefinition as s, AnyWebSocketDefinition as t, WebSocketBaseContext as u };
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
import { a as join, n as dirname } from "./dist-DMYe8CZJ.mjs";
|
|
2
|
+
import { existsSync, readdirSync } from "node:fs";
|
|
3
|
+
import { fileURLToPath, pathToFileURL } from "node:url";
|
|
4
|
+
// src/cli/yarn-pnp.ts
|
|
5
|
+
const drizzleKitBin = join(fileURLToPath(import.meta.resolve("drizzle-kit")), "..", "bin.cjs");
|
|
6
|
+
/** Read the PnP runtime files in `dir` only, or `undefined` when neither exists. */
|
|
7
|
+
function readPnpRuntimeAt(dir) {
|
|
8
|
+
const cjs = join(dir, ".pnp.cjs");
|
|
9
|
+
const loader = join(dir, ".pnp.loader.mjs");
|
|
10
|
+
const cjsExists = existsSync(cjs);
|
|
11
|
+
const loaderExists = existsSync(loader);
|
|
12
|
+
if (!cjsExists && !loaderExists) return;
|
|
13
|
+
return {
|
|
14
|
+
pnpCjs: cjsExists ? cjs : void 0,
|
|
15
|
+
pnpLoader: loaderExists ? loader : void 0
|
|
16
|
+
};
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* Whether `dir` has its own package-manager lockfile, i.e. it is an install
|
|
20
|
+
* root: workspace members share the root lockfile. `packageManager` is not a
|
|
21
|
+
* signal, because a Yarn workspace member may pin it and still resolve through
|
|
22
|
+
* the root's `.pnp.cjs`.
|
|
23
|
+
*/
|
|
24
|
+
function hasLocalLockfile(dir) {
|
|
25
|
+
return existsSync(join(dir, "pnpm-lock.yaml")) || existsSync(join(dir, "package-lock.json")) || existsSync(join(dir, "yarn.lock")) || existsSync(join(dir, "bun.lock")) || existsSync(join(dir, "bun.lockb"));
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Find Yarn Berry PnP runtime files at `start` or its nearest ancestor, since a
|
|
29
|
+
* monorepo keeps `.pnp.cjs` at the workspace root. A lockfile at `start` stops
|
|
30
|
+
* the walk: an outer PnP graph lacks the local install's dependencies.
|
|
31
|
+
*/
|
|
32
|
+
function findYarnPnpRuntime(start) {
|
|
33
|
+
const local = readPnpRuntimeAt(start);
|
|
34
|
+
if (local !== void 0) return {
|
|
35
|
+
dir: start,
|
|
36
|
+
runtime: local
|
|
37
|
+
};
|
|
38
|
+
if (hasLocalLockfile(start)) return;
|
|
39
|
+
let dir = dirname(start);
|
|
40
|
+
if (dir === start) return;
|
|
41
|
+
while (true) {
|
|
42
|
+
const found = readPnpRuntimeAt(dir);
|
|
43
|
+
if (found !== void 0) return {
|
|
44
|
+
dir,
|
|
45
|
+
runtime: found
|
|
46
|
+
};
|
|
47
|
+
const parent = dirname(dir);
|
|
48
|
+
if (parent === dir) return;
|
|
49
|
+
dir = parent;
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* Like {@link findYarnPnpRuntime}, but only when Yarn has installed into that
|
|
54
|
+
* same directory. A committed `.pnp.cjs` alone does not prove an install: its
|
|
55
|
+
* ZIP archives may not be fetched yet.
|
|
56
|
+
*/
|
|
57
|
+
function findInstalledYarnPnpRuntime(start) {
|
|
58
|
+
const found = findYarnPnpRuntime(start);
|
|
59
|
+
return found && isYarnPnpInstalled(found.dir) ? found.runtime : void 0;
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* Yarn writes `.yarn/install-state.gz` on every install; a zero-install
|
|
63
|
+
* checkout instead commits a populated `.yarn/cache`.
|
|
64
|
+
*/
|
|
65
|
+
function isYarnPnpInstalled(dir) {
|
|
66
|
+
if (existsSync(join(dir, ".yarn", "install-state.gz"))) return true;
|
|
67
|
+
const cacheDir = join(dir, ".yarn", "cache");
|
|
68
|
+
if (!existsSync(cacheDir)) return false;
|
|
69
|
+
try {
|
|
70
|
+
return readdirSync(cacheDir).some((e) => e.endsWith(".zip"));
|
|
71
|
+
} catch {
|
|
72
|
+
return false;
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
/**
|
|
76
|
+
* Build a child env that loads the Yarn PnP runtime found at or above `root`,
|
|
77
|
+
* like `yarn node` does. Existing `NODE_OPTIONS` go after our flags so the PnP
|
|
78
|
+
* `--require` patches resolution first.
|
|
79
|
+
*/
|
|
80
|
+
function buildDrizzleKitSpawnEnv(root) {
|
|
81
|
+
const env = { ...process.env };
|
|
82
|
+
const pnp = findYarnPnpRuntime(root)?.runtime;
|
|
83
|
+
if (!pnp) return env;
|
|
84
|
+
const flags = [];
|
|
85
|
+
if (pnp.pnpCjs) flags.push(`--require ${JSON.stringify(pnp.pnpCjs)}`);
|
|
86
|
+
if (pnp.pnpLoader) flags.push(`--experimental-loader ${pathToFileURL(pnp.pnpLoader).href}`);
|
|
87
|
+
const injected = flags.join(" ");
|
|
88
|
+
env.NODE_OPTIONS = process.env.NODE_OPTIONS ? `${injected} ${process.env.NODE_OPTIONS}` : injected;
|
|
89
|
+
return env;
|
|
90
|
+
}
|
|
91
|
+
export { hasLocalLockfile as i, drizzleKitBin as n, findInstalledYarnPnpRuntime as r, buildDrizzleKitSpawnEnv as t };
|
package/docs/guide/ai.md
ADDED
|
@@ -0,0 +1,273 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: 'Run Workers AI models and provider APIs from server code. Provider requests go through Cloudflare AI Gateway.'
|
|
3
|
+
outline: deep
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# AI
|
|
7
|
+
|
|
8
|
+
Run Workers AI models and provider APIs from server code with `ai` from `@builtbyfriends/bwf/ai`. Provider requests use Cloudflare's [AI Gateway](https://developers.cloudflare.com/ai-gateway/).
|
|
9
|
+
|
|
10
|
+
## Local Development
|
|
11
|
+
|
|
12
|
+
For a direct Cloudflare project, connect your account and start development:
|
|
13
|
+
|
|
14
|
+
```sh
|
|
15
|
+
bwf connect --platform cloudflare
|
|
16
|
+
npm run dev
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
When the app imports `@builtbyfriends/bwf/ai`, bwf enables a remote Workers AI binding during
|
|
20
|
+
development and preview. Requests use your Cloudflare account and its allowance;
|
|
21
|
+
Workers AI has no local simulator. Development and preview use the same
|
|
22
|
+
Cloudflare login as `bwf connect`; sign in with `bwf cloudflare login`. A
|
|
23
|
+
`CLOUDFLARE_API_TOKEN` takes precedence; use one in an automated environment.
|
|
24
|
+
|
|
25
|
+
If development stops with a Cloudflare authentication error, run
|
|
26
|
+
`bwf cloudflare login` in a terminal as a user who can access the deployment
|
|
27
|
+
account shown by `bwf cloudflare status`, or set `CLOUDFLARE_API_TOKEN`.
|
|
28
|
+
`wrangler login` does not affect development.
|
|
29
|
+
|
|
30
|
+
For a team platform, use `bwf connect <platform-url>` and link your project.
|
|
31
|
+
Development requests use that platform's account and usage limits.
|
|
32
|
+
If the platform reports that AI is disabled, ask your administrator to enable it.
|
|
33
|
+
This also applies to model listing, Markdown conversion, and provider-native requests.
|
|
34
|
+
|
|
35
|
+
## Basic Usage
|
|
36
|
+
|
|
37
|
+
Call `ai.run()` with a model name and inputs. Model names and input types are fully typed from `@cloudflare/workers-types`.
|
|
38
|
+
|
|
39
|
+
```ts
|
|
40
|
+
import { defineHandler } from '@builtbyfriends/bwf';
|
|
41
|
+
import { ai } from '@builtbyfriends/bwf/ai';
|
|
42
|
+
|
|
43
|
+
export const POST = defineHandler(async (c) => {
|
|
44
|
+
const { prompt } = await c.req.json();
|
|
45
|
+
|
|
46
|
+
const result = await ai.run('@cf/meta/llama-3.3-70b-instruct-fp8-fast', {
|
|
47
|
+
messages: [{ role: 'user', content: prompt }],
|
|
48
|
+
});
|
|
49
|
+
return c.json(result);
|
|
50
|
+
});
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
AI methods return promises. Await them to receive the result, or return the promise directly from a handler. See [Usage Limits](#usage-limits) for limit errors.
|
|
54
|
+
|
|
55
|
+
You can use any model available through Cloudflare's AI binding, including Workers AI models such as `@cf/meta/llama-3.3-70b-instruct-fp8-fast` and Cloudflare Gateway models such as `google/gemini-2.5-flash` or `openai/gpt-4.1-mini`. The input object must match the selected Cloudflare model's schema. Models that return binary data, such as generated images, are returned as a `Blob` from `ai.run()`.
|
|
56
|
+
|
|
57
|
+
## Streaming
|
|
58
|
+
|
|
59
|
+
Use `ai.stream()` to get a streaming response with SSE headers that you can return directly from a route handler:
|
|
60
|
+
|
|
61
|
+
```ts
|
|
62
|
+
import { defineHandler } from '@builtbyfriends/bwf';
|
|
63
|
+
import { ai } from '@builtbyfriends/bwf/ai';
|
|
64
|
+
|
|
65
|
+
export const POST = defineHandler(async (c) => {
|
|
66
|
+
const { prompt } = await c.req.json();
|
|
67
|
+
|
|
68
|
+
return ai.stream('@cf/meta/llama-3.3-70b-instruct-fp8-fast', {
|
|
69
|
+
messages: [{ role: 'user', content: prompt }],
|
|
70
|
+
});
|
|
71
|
+
});
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
Streaming responses end with a `nosam:error` SSE event if generation is interrupted after the response starts, or `nosam:limit` for a usage limit. `fetchStream()` from `@builtbyfriends/bwf/client` throws `UsageLimit` for limits before or during streaming and `StreamError` for other terminal errors. Catch the error in your UI to stop its generating state, retain partial output, and offer retry. This also applies to streaming provider responses and `ai.run()` with `stream: true`.
|
|
75
|
+
|
|
76
|
+
## Listing Models
|
|
77
|
+
|
|
78
|
+
Use `ai.models()` to list available models:
|
|
79
|
+
|
|
80
|
+
```ts
|
|
81
|
+
const models = await ai.models();
|
|
82
|
+
|
|
83
|
+
// Filter by task
|
|
84
|
+
const textModels = await ai.models({ task: 'Text Generation' });
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
## Markdown Conversion
|
|
88
|
+
|
|
89
|
+
Use `ai.toMarkdown()` to convert documents to markdown:
|
|
90
|
+
|
|
91
|
+
```ts
|
|
92
|
+
const result = await ai.toMarkdown([{ name: 'document.pdf', blob: pdfBytes }]);
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
## Usage Limits
|
|
96
|
+
|
|
97
|
+
Workers AI usage is measured in [neurons](https://developers.cloudflare.com/workers-ai/platform/pricing/).
|
|
98
|
+
On a direct deployment, usage belongs to your Cloudflare account. Provider-native
|
|
99
|
+
requests also use your provider credentials and their billing terms.
|
|
100
|
+
|
|
101
|
+
A team platform uses its own Cloudflare account and may apply per-user limits. Ask your administrator about the available allowance.
|
|
102
|
+
|
|
103
|
+
Usage limits reject the operation's promise with `UsageLimit` from `@builtbyfriends/bwf/limits`. It includes `resource`, `reason`, and an optional `retryAt` timestamp. In bwf route handlers and Pages actions, an uncaught limit produces a structured HTTP 429 with retry information. In queues, scheduled jobs, and other server code, it remains a rejected promise.
|
|
104
|
+
|
|
105
|
+
Handling a limit is optional. Use `instanceof UsageLimit` when you want a fallback or a message tailored to your app:
|
|
106
|
+
|
|
107
|
+
```ts
|
|
108
|
+
import { defineHandler } from '@builtbyfriends/bwf';
|
|
109
|
+
import { ai } from '@builtbyfriends/bwf/ai';
|
|
110
|
+
import { UsageLimit } from '@builtbyfriends/bwf/limits';
|
|
111
|
+
|
|
112
|
+
export const POST = defineHandler(async (c) => {
|
|
113
|
+
const { prompt } = await c.req.json();
|
|
114
|
+
try {
|
|
115
|
+
const result = await ai.run('@cf/meta/llama-3.3-70b-instruct-fp8-fast', {
|
|
116
|
+
messages: [{ role: 'user', content: prompt }],
|
|
117
|
+
});
|
|
118
|
+
return c.json(result);
|
|
119
|
+
} catch (error) {
|
|
120
|
+
if (error instanceof UsageLimit) {
|
|
121
|
+
return error.response({ message: 'Try again shortly. Your prompt has been kept.' });
|
|
122
|
+
}
|
|
123
|
+
throw error;
|
|
124
|
+
}
|
|
125
|
+
});
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
`error.response()` creates the structured HTTP 429 and accepts an optional custom `message`. Other failures reject normally. When using `fetchStream()`, the same `instanceof UsageLimit` check gives your client access to the message and retry information.
|
|
129
|
+
|
|
130
|
+
## Cloudflare Gateway Models
|
|
131
|
+
|
|
132
|
+
`ai.run()` mirrors Cloudflare's `env.AI.run()` model naming and input schemas. Third-party models use Cloudflare model IDs and Cloudflare-managed credentials.
|
|
133
|
+
|
|
134
|
+
```ts
|
|
135
|
+
const result = await ai.run('google/gemini-2.5-flash', {
|
|
136
|
+
contents: [
|
|
137
|
+
{
|
|
138
|
+
role: 'user',
|
|
139
|
+
parts: [{ text: 'Explain Durable Objects in one paragraph.' }],
|
|
140
|
+
},
|
|
141
|
+
],
|
|
142
|
+
});
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
Pass AI Gateway options as the third argument: `ai.run(model, inputs, { gateway: { skipCache: true } })`. On a team platform, the platform chooses the gateway and sets its metadata and logging; options such as `skipCache` and `cacheTtl` still apply. The platform's logging setting also covers `bwf dev` in a linked project; an unlinked project uses your own Cloudflare account and its gateway settings.
|
|
146
|
+
|
|
147
|
+
For provider-native requests on a direct deployment, configure [`ai.gateway`](../integrations/cloudflare.md#ai-self-host).
|
|
148
|
+
|
|
149
|
+
## Provider-Native Requests
|
|
150
|
+
|
|
151
|
+
Use `ai.provider(provider).fetch(path, init)` for a provider-native API with your
|
|
152
|
+
own provider key. The request goes through the configured Cloudflare AI Gateway
|
|
153
|
+
and retains the provider's native HTTP shape. On a team platform, it also passes
|
|
154
|
+
through that installation's proxy. AI Gateway cache, timeout and retry headers,
|
|
155
|
+
such as `cf-aig-cache-ttl` and `cf-aig-max-attempts`, still apply there; the
|
|
156
|
+
platform ignores logging, metadata and cost headers.
|
|
157
|
+
|
|
158
|
+
### OpenAI
|
|
159
|
+
|
|
160
|
+
```ts
|
|
161
|
+
import { defineHandler } from '@builtbyfriends/bwf';
|
|
162
|
+
import { ai } from '@builtbyfriends/bwf/ai';
|
|
163
|
+
|
|
164
|
+
export const POST = defineHandler(async (c) => {
|
|
165
|
+
const { prompt } = await c.req.json();
|
|
166
|
+
|
|
167
|
+
return ai.provider('openai').fetch('/chat/completions', {
|
|
168
|
+
body: {
|
|
169
|
+
model: 'gpt-4o',
|
|
170
|
+
messages: [{ role: 'user', content: prompt }],
|
|
171
|
+
max_tokens: 512,
|
|
172
|
+
},
|
|
173
|
+
});
|
|
174
|
+
});
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
### Google AI Studio
|
|
178
|
+
|
|
179
|
+
```ts
|
|
180
|
+
const response = await ai
|
|
181
|
+
.provider('google-ai-studio')
|
|
182
|
+
.fetch('/v1/models/gemini-2.5-flash:generateContent', {
|
|
183
|
+
body: {
|
|
184
|
+
contents: [
|
|
185
|
+
{
|
|
186
|
+
role: 'user',
|
|
187
|
+
parts: [{ text: 'What is Cloudflare?' }],
|
|
188
|
+
},
|
|
189
|
+
],
|
|
190
|
+
},
|
|
191
|
+
});
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
### Custom Providers
|
|
195
|
+
|
|
196
|
+
For providers that are not in bwf's default key map, pass the secret name and API-key header:
|
|
197
|
+
|
|
198
|
+
```ts
|
|
199
|
+
const response = await ai
|
|
200
|
+
.provider('custom-provider', {
|
|
201
|
+
apiKeyEnv: 'CUSTOM_PROVIDER_API_KEY',
|
|
202
|
+
apiKeyHeader: 'x-api-key',
|
|
203
|
+
apiKeyPrefix: '',
|
|
204
|
+
})
|
|
205
|
+
.fetch('/v1/respond', {
|
|
206
|
+
body: { prompt: 'Hello' },
|
|
207
|
+
});
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
### Image Generation
|
|
211
|
+
|
|
212
|
+
Use `ai.run()` or `ai.image()` for Cloudflare-native image models:
|
|
213
|
+
|
|
214
|
+
```ts
|
|
215
|
+
export const POST = defineHandler(async (c) => {
|
|
216
|
+
const { prompt } = await c.req.json();
|
|
217
|
+
return ai.image('@cf/black-forest-labs/flux-1-schnell', { prompt });
|
|
218
|
+
});
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
Use `ai.provider().fetch()` for provider-native image APIs. Match the [provider's request schema](https://developers.openai.com/api/reference/resources/images/methods/generate):
|
|
222
|
+
|
|
223
|
+
```ts
|
|
224
|
+
export const POST = defineHandler(async (c) => {
|
|
225
|
+
const { prompt } = await c.req.json();
|
|
226
|
+
|
|
227
|
+
return ai.provider('openai').fetch('/images/generations', {
|
|
228
|
+
body: {
|
|
229
|
+
model: 'gpt-image-2.5-sunburst',
|
|
230
|
+
prompt,
|
|
231
|
+
size: '1024x1024',
|
|
232
|
+
},
|
|
233
|
+
});
|
|
234
|
+
});
|
|
235
|
+
```
|
|
236
|
+
|
|
237
|
+
For multipart provider APIs, pass `FormData`:
|
|
238
|
+
|
|
239
|
+
```ts
|
|
240
|
+
export const POST = defineHandler(async (c) => {
|
|
241
|
+
const body = await c.req.parseBody();
|
|
242
|
+
const form = new FormData();
|
|
243
|
+
form.set('model', 'gpt-image-2.5-sunburst');
|
|
244
|
+
form.set('prompt', String(body.prompt));
|
|
245
|
+
form.set('image', body.image as Blob, 'source.png');
|
|
246
|
+
|
|
247
|
+
return ai.provider('openai').fetch('/images/edits', { body: form });
|
|
248
|
+
});
|
|
249
|
+
```
|
|
250
|
+
|
|
251
|
+
### Provider Key Convention
|
|
252
|
+
|
|
253
|
+
Provider-native requests use a project secret, such as `OPENAI_API_KEY` for OpenAI or `GOOGLE_API_KEY` for Google AI Studio.
|
|
254
|
+
|
|
255
|
+
See the [provider key reference](../reference/api/resources.md#provider-keys) for supported providers and their secret names.
|
|
256
|
+
|
|
257
|
+
OpenAI-style providers use `Authorization: Bearer <key>`. Google AI Studio uses `x-goog-api-key`. Use `apiKeyHeader` and `apiKeyPrefix` for custom providers.
|
|
258
|
+
|
|
259
|
+
For production, add your API key as a project secret:
|
|
260
|
+
|
|
261
|
+
```bash
|
|
262
|
+
bwf secret put OPENAI_API_KEY=sk-...
|
|
263
|
+
```
|
|
264
|
+
|
|
265
|
+
For local development, add it to `.env` in your project root:
|
|
266
|
+
|
|
267
|
+
```dotenv
|
|
268
|
+
OPENAI_API_KEY=sk-...
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
### Streaming with Provider-Native APIs
|
|
272
|
+
|
|
273
|
+
Return the provider response directly. For example, add `stream: true` to the OpenAI request body shown above.
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: 'Build a bwf app (a React single-page app with an optional backend) or deploy a static SPA or static site.'
|
|
3
|
+
outline: deep
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Supported App Types
|
|
7
|
+
|
|
8
|
+
bwf supports two kinds of apps, both deployed to Cloudflare:
|
|
9
|
+
|
|
10
|
+
1. **bwf apps:** a React single-page app (`index.html` + `src/`) with an optional backend in `routes/`, plus [auth](./auth.md), [crons](./jobs.md), [queues](./queues.md), and the other bwf features
|
|
11
|
+
2. **Static apps:** a pre-built SPA, a site built with a tool like [VitePress](https://vitepress.dev/), or any directory of static files
|
|
12
|
+
|
|
13
|
+
The type is auto-detected from your project structure, or you can set it explicitly in [`bwf.config.ts`](../reference/config.md).
|
|
14
|
+
|
|
15
|
+
## bwf Apps
|
|
16
|
+
|
|
17
|
+
A bwf app is a React single-page app that Vite builds into static assets. The browser renders every page; bwf does not render HTML on the server. Add files to `routes/` when the app needs a backend:
|
|
18
|
+
|
|
19
|
+
<BwfAppFileTree annotations />
|
|
20
|
+
|
|
21
|
+
bwf serves the API routes from a Cloudflare Worker alongside the SPA's assets. Unknown paths serve `index.html`, so client-side routing works. Resources such as D1, KV, and R2 are [inferred from your code](../reference/resource-inference.md) and provisioned when you deploy.
|
|
22
|
+
|
|
23
|
+
A bwf app without `routes/`, middleware, or other server features is a plain SPA: it deploys as static assets with no Worker.
|
|
24
|
+
|
|
25
|
+
**Deploy:** `bwf deploy` builds the app, provisions resources, applies migrations, and uploads it to your saved Cloudflare or bwf target. See [Deployment](./deployment.md) for setup.
|
|
26
|
+
|
|
27
|
+
## Pre-built Static Apps
|
|
28
|
+
|
|
29
|
+
Any project that produces static files, whether that is an SPA, a static site, or a plain directory. bwf serves the assets without requiring application code.
|
|
30
|
+
|
|
31
|
+
**SPAs** (client-side single-page apps) serve `index.html` with a 200 status for paths that match no file, so client-side routing works out of the box. On a bwf platform, missing files under the hashed assets folder (`/assets/`) return 404 instead. Detected when `vite` is a dependency and no backend files exist.
|
|
32
|
+
|
|
33
|
+
**Static sites** (static site generators like VitePress, Docusaurus, or any pre-built directory) produce per-page HTML files. Detected when a known SSG is a dependency, or when using the `--dir` flag.
|
|
34
|
+
|
|
35
|
+
At the edge, the resolution order is:
|
|
36
|
+
|
|
37
|
+
1. Exact file path (`/styles.css` → `styles.css`)
|
|
38
|
+
2. Nested index (`/about` → `about/index.html`)
|
|
39
|
+
3. `404.html` with **status 404** (if the file exists)
|
|
40
|
+
4. Plain 404 response
|
|
41
|
+
|
|
42
|
+
**Deploy:** `bwf deploy` or `bwf deploy --dir <path>` uploads static files directly. Assets are served from the edge with automatic caching.
|
|
43
|
+
|
|
44
|
+
## Adding a backend to a static site
|
|
45
|
+
|
|
46
|
+
If you add API routes to a static site generator, tell bwf whether to deploy the backend too. Auto-detection sees both the SSG dependency and backend files, and stops until you set `inference.appType`.
|
|
47
|
+
|
|
48
|
+
To deploy both, set `appType` to `"nosam"` and build the static site before the bwf app:
|
|
49
|
+
|
|
50
|
+
```ts
|
|
51
|
+
import { defineConfig } from '@builtbyfriends/bwf/config';
|
|
52
|
+
|
|
53
|
+
export default defineConfig({
|
|
54
|
+
inference: {
|
|
55
|
+
appType: 'nosam',
|
|
56
|
+
build: 'vitepress build && vite build',
|
|
57
|
+
},
|
|
58
|
+
});
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
```ts
|
|
62
|
+
import { bwfPlugin } from '@builtbyfriends/bwf';
|
|
63
|
+
// vite.config.ts
|
|
64
|
+
import { defineConfig } from 'vite';
|
|
65
|
+
|
|
66
|
+
export default defineConfig({
|
|
67
|
+
plugins: [bwfPlugin()],
|
|
68
|
+
// The SSG's output becomes the static assets of the bwf build.
|
|
69
|
+
publicDir: '.vitepress/dist',
|
|
70
|
+
});
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
`vitepress build` emits the site, then `vite build` copies `publicDir` into `dist/client` and emits the worker into `dist/ssr`. Keep `bwfPlugin()` in the **root** `vite.config.ts` only — not in the generator's own config (e.g. `.vitepress/config.ts`).
|
|
74
|
+
|
|
75
|
+
The Worker handles unmatched requests. Set [`routing.notFound`](../reference/config.md#routing-notfound) to serve the generator's `404.html` for those requests:
|
|
76
|
+
|
|
77
|
+
```json
|
|
78
|
+
{ "routing": { "notFound": "404-page" } }
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
To deploy only the static output, set:
|
|
82
|
+
|
|
83
|
+
```json
|
|
84
|
+
{ "inference": { "appType": "static" } }
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
## Explicit Configuration
|
|
88
|
+
|
|
89
|
+
To lock the app type and skip auto-detection, set `inference.appType` in [`bwf.config.ts`](../reference/config.md):
|
|
90
|
+
|
|
91
|
+
```json
|
|
92
|
+
{
|
|
93
|
+
"inference": {
|
|
94
|
+
"appType": "static",
|
|
95
|
+
"outputDir": ".vitepress/dist"
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
- `inference.appType`: `"nosam"`, `"spa"`, or `"static"`
|
|
101
|
+
- `inference.outputDir`: output directory for static app types (relative to project root, defaults to `"dist"`)
|