@builtbyfriends/bwf 0.0.0-stage → 1.9.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS_TEMPLATE.md +4 -0
- package/LICENSE +22 -0
- package/README.md +48 -2
- package/dist/account-cmd-Cj0I2_bJ.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-D-DddkCQ.mjs +26 -0
- package/dist/auth-migrations-DDeifS3v.mjs +206 -0
- package/dist/auth-router-tWzIwf8f.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-HeXRQml6.mjs +1846 -0
- package/dist/client-D3D5RM5h.mjs +940 -0
- package/dist/client-VF2Nzc7Z.mjs +1 -0
- package/dist/cloudflare-auth-jb-1e43r.mjs +152 -0
- package/dist/cloudflare-cmd-B62t8Fm-.mjs +59 -0
- package/dist/cloudflare-config-i8yanry0.mjs +186 -0
- package/dist/cloudflare-connect-x7IsYghw.mjs +55 -0
- package/dist/cloudflare-operations-BeK7bhnP.mjs +627 -0
- package/dist/cloudflare-operations-C3Uu0Emj.mjs +1 -0
- package/dist/cloudflare-process-Cc6oiJqk.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-hLPNppu3.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-BH_md90k.mjs +1735 -0
- package/dist/delete-BSKI7V23.mjs +65 -0
- package/dist/deploy-C8KHBNsh.mjs +6512 -0
- package/dist/deploy-DCZBr7Ey.mjs +2 -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-C4ZhEiFG.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-B3TWga7x.mjs +742 -0
- package/dist/email-C_ATvNIG.mjs +2865 -0
- package/dist/email-cloudflare-DuAc9zny.mjs +854 -0
- package/dist/email-protocol-CZ0bAkI8.mjs +81 -0
- package/dist/env-CTAo8ifZ.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-BufZConV.mjs +488 -0
- package/dist/env-validation-DPqDo4DU.mjs +1 -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-CJ7DiiRF.mjs +161 -0
- package/dist/handler-CVsIfRv7.d.mts +279 -0
- package/dist/help-Bpv6Qeqn.mjs +1946 -0
- package/dist/help-CfZ4Bsw5.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-DRUR0j8C.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-B84t4BhW.mjs +130 -0
- package/dist/live-Dui0-aj_.d.mts +105 -0
- package/dist/live-saC8barp.mjs +410 -0
- package/dist/load-user-env-g0ahkZcj.mjs +34 -0
- package/dist/local-d1-C3EeOV7-.mjs +103 -0
- package/dist/log-JDnPc0cF.mjs +23 -0
- package/dist/login-Bl5lH8nH.mjs +87 -0
- package/dist/login-DoI7AsbY.mjs +1 -0
- package/dist/logs-CaT2N2f7.mjs +129 -0
- package/dist/migrate-CbGscX-V.mjs +125 -0
- package/dist/migrate-Ce3JKLVs.mjs +1 -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-BFg32YyY.mjs +722 -0
- package/dist/operator-auth-DdYZYEkO.mjs +47 -0
- package/dist/operator-client-DBujdELO.mjs +82 -0
- package/dist/operator-cmd-C73WWJBl.mjs +443 -0
- package/dist/operator-cmd-CdZytuAF.mjs +1 -0
- package/dist/output-Bb34lF0w.mjs +173 -0
- package/dist/output-CVolXKC1.mjs +1 -0
- package/dist/package-DO4d3Qz5.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-NI_vfWvD.mjs +538 -0
- package/dist/platform-args-ZC1-A1N9.mjs +1 -0
- package/dist/platform-auth-config-d-lY5-aY.mjs +371 -0
- package/dist/platform-auth-protection-Dhw7lUCk.mjs +231 -0
- package/dist/platform-auth-recovery-DaCc0tlx.mjs +309 -0
- package/dist/platform-cmd-5Ry-C9im.mjs +193 -0
- package/dist/platform-cmd-5oZq91lI.mjs +1 -0
- package/dist/platform-discovery-Bxg9aZXU.mjs +40 -0
- package/dist/platform-domain-DLVdGvGG.mjs +256 -0
- package/dist/platform-lifecycle-CUgjipXO.mjs +1 -0
- package/dist/platform-lifecycle-fRt5VMls.mjs +8928 -0
- package/dist/platform-management-5hEsRfR2.mjs +1 -0
- package/dist/platform-management-Djh1hzLP.mjs +1607 -0
- package/dist/platform-plans-config-CkbUKFpm.mjs +447 -0
- package/dist/platform-recovery-Cghx7FCR.mjs +96 -0
- package/dist/platform-registry-x1m9HBxf.mjs +450 -0
- package/dist/platform-runtime-logs-kkoiYFpF.mjs +72 -0
- package/dist/platform-setup-SfwCwnZg.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-DTF19-fC.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-DGlFJ3T9.mjs +1 -0
- package/dist/provision-mYVLuQiy.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-BvCHol52.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-7aA5hGoM.mjs +145 -0
- package/dist/runner-mysql-DrMKw203.mjs +1 -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-DCF9RXTc.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-DsSoNsKJ.mjs +23 -0
- package/dist/wrangler-DU784Dkf.mjs +1452 -0
- package/dist/wrangler-Rr9_76DQ.mjs +1 -0
- package/dist/ws-Q_osq9VK.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
package/docs/guide/kv.md
ADDED
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: 'Read and write JSON in Cloudflare Workers KV. Give each collection its own key prefix and value type.'
|
|
3
|
+
outline: deep
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Key-Value Storage
|
|
7
|
+
|
|
8
|
+
Read and write data in [Cloudflare Workers KV](https://developers.cloudflare.com/kv/) with `kv` from `@builtbyfriends/bwf/kv`. Values are stored as JSON, and `kv.map()` gives a collection its own key prefix and value type.
|
|
9
|
+
|
|
10
|
+
## Basic Operations
|
|
11
|
+
|
|
12
|
+
### Get
|
|
13
|
+
|
|
14
|
+
```ts
|
|
15
|
+
import { kv } from '@builtbyfriends/bwf/kv';
|
|
16
|
+
|
|
17
|
+
const user = await kv.get<User>('user:123');
|
|
18
|
+
// User | null
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Values are automatically parsed as JSON. If the stored value isn't valid JSON, the raw string is returned.
|
|
22
|
+
|
|
23
|
+
### Put
|
|
24
|
+
|
|
25
|
+
```ts
|
|
26
|
+
await kv.put('user:123', { name: 'Alice', role: 'admin' });
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Values, including strings, are JSON-serialized. Reads preserve their types, so a string such as `"123"` or `"null"` comes back as a string.
|
|
30
|
+
|
|
31
|
+
Add a TTL (in seconds) or absolute expiration (Unix timestamp):
|
|
32
|
+
|
|
33
|
+
```ts
|
|
34
|
+
await kv.put('session:abc', sessionData, { ttl: 3600 });
|
|
35
|
+
await kv.put('token:xyz', tokenData, { expiration: 1700000000 });
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Attach metadata to a key:
|
|
39
|
+
|
|
40
|
+
```ts
|
|
41
|
+
await kv.put('user:123', userData, {
|
|
42
|
+
metadata: { updatedBy: 'admin' },
|
|
43
|
+
});
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### Delete
|
|
47
|
+
|
|
48
|
+
```ts
|
|
49
|
+
await kv.delete('user:123');
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### List
|
|
53
|
+
|
|
54
|
+
```ts
|
|
55
|
+
const result = await kv.list({ prefix: 'user:' });
|
|
56
|
+
// { keys: [{ name: "user:1" }, { name: "user:2" }], list_complete: true }
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Paginate with `limit` and `cursor`:
|
|
60
|
+
|
|
61
|
+
```ts
|
|
62
|
+
const page = await kv.list({ prefix: 'user:', limit: 100 });
|
|
63
|
+
if (!page.list_complete) {
|
|
64
|
+
const next = await kv.list({ prefix: 'user:', limit: 100, cursor: page.cursor });
|
|
65
|
+
}
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### Get with Metadata
|
|
69
|
+
|
|
70
|
+
```ts
|
|
71
|
+
const result = await kv.getWithMetadata<User, { updatedBy: string }>('user:123');
|
|
72
|
+
// { value: User | null, metadata: { updatedBy: string } | null }
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
## Typed Maps
|
|
76
|
+
|
|
77
|
+
For collections of the same type, use `kv.map()` to create a scoped, typed client with automatic key prefixing:
|
|
78
|
+
|
|
79
|
+
```ts
|
|
80
|
+
const sessions = kv.map<Session>('sessions');
|
|
81
|
+
|
|
82
|
+
await sessions.put('abc', { userId: 1, token: '...' }, { ttl: 3600 });
|
|
83
|
+
// KV key: "sessions:abc"
|
|
84
|
+
|
|
85
|
+
const session = await sessions.get('abc');
|
|
86
|
+
// Session | null
|
|
87
|
+
|
|
88
|
+
await sessions.delete('abc');
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
The map automatically prefixes all keys with `"sessions:"` and strips the prefix when listing:
|
|
92
|
+
|
|
93
|
+
```ts
|
|
94
|
+
const result = await sessions.list();
|
|
95
|
+
// keys: [{ name: "abc" }, { name: "def" }] (prefix stripped)
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
Maps have the same methods as the base client (`get`, `put`, `delete`, `list`, `getWithMetadata`) but with a typed value and automatic prefixing.
|
|
99
|
+
|
|
100
|
+
For operations beyond this client, access the raw `KVNamespace` through `c.env.KV` in a route handler.
|
|
@@ -0,0 +1,181 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: 'Subscribe a browser to several topics over one SSE connection, and publish events from routes, jobs, or queues.'
|
|
3
|
+
outline: deep
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Live Event Streams
|
|
7
|
+
|
|
8
|
+
`@builtbyfriends/bwf/live` lets a browser subscribe to several topics over one SSE connection. Publish an event from a route, scheduled job, or queue consumer, and bwf delivers it to connected subscribers using Durable Objects.
|
|
9
|
+
|
|
10
|
+
For example, a page can subscribe to updates for a post and its comments, then change those subscriptions as the user navigates. If a single request produces the whole stream, such as an AI response, [`@builtbyfriends/bwf/sse`](./sse.md) is enough.
|
|
11
|
+
|
|
12
|
+
## Define A Stream
|
|
13
|
+
|
|
14
|
+
Define a stream in a server-only module:
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
// src/live.ts
|
|
18
|
+
import { defineLiveStream } from '@builtbyfriends/bwf/live';
|
|
19
|
+
|
|
20
|
+
export const live = defineLiveStream({
|
|
21
|
+
id: 'app',
|
|
22
|
+
allowAnonymousControl: true,
|
|
23
|
+
});
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
This example accepts visitors who are not signed in. Without `onSubscribe`, any connection can subscribe to any topic, so read [Authorization](#authorization) before you publish private data.
|
|
27
|
+
|
|
28
|
+
bwf enables live streams when a [scanned file](../reference/resource-inference.md#scanned-directories) imports `@builtbyfriends/bwf/live`, so keep this module in `src/` or another scanned directory. To keep it in an unscanned directory such as `lib/`, add that directory to [`inference.scanDirs`](../reference/resource-inference.md#custom-scan-directories) and list the default directories you still use, because `scanDirs` replaces them.
|
|
29
|
+
|
|
30
|
+
Expose it from a normal route:
|
|
31
|
+
|
|
32
|
+
```ts
|
|
33
|
+
// routes/live.ts
|
|
34
|
+
import { defineHandler } from '@builtbyfriends/bwf';
|
|
35
|
+
import { live } from '../src/live';
|
|
36
|
+
|
|
37
|
+
export const GET = defineHandler((c) => live.connect(c));
|
|
38
|
+
export const POST = defineHandler((c) => live.control(c));
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
`GET` opens the SSE connection. `POST` accepts subscribe and unsubscribe control
|
|
42
|
+
operations for that connection.
|
|
43
|
+
|
|
44
|
+
## Subscribe From The Browser
|
|
45
|
+
|
|
46
|
+
Use the browser helper from `@builtbyfriends/bwf/live/client`:
|
|
47
|
+
|
|
48
|
+
```ts
|
|
49
|
+
import { connectLiveStream } from '@builtbyfriends/bwf/live/client';
|
|
50
|
+
|
|
51
|
+
const stream = connectLiveStream('/live', {
|
|
52
|
+
withCredentials: true,
|
|
53
|
+
retryDelay: 1_000,
|
|
54
|
+
onError(error) {
|
|
55
|
+
console.error(error);
|
|
56
|
+
},
|
|
57
|
+
});
|
|
58
|
+
|
|
59
|
+
const unsubscribePost = await stream.subscribe({
|
|
60
|
+
id: 'post-card',
|
|
61
|
+
topic: 'post:12',
|
|
62
|
+
onEvent(event) {
|
|
63
|
+
if (event.type === 'updated') {
|
|
64
|
+
console.log(event.data);
|
|
65
|
+
}
|
|
66
|
+
},
|
|
67
|
+
});
|
|
68
|
+
|
|
69
|
+
const unsubscribeComments = await stream.subscribe({
|
|
70
|
+
id: 'comments',
|
|
71
|
+
topic: 'comment:2323',
|
|
72
|
+
});
|
|
73
|
+
|
|
74
|
+
await unsubscribeComments();
|
|
75
|
+
await unsubscribePost();
|
|
76
|
+
stream.close();
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
Subscription IDs are scoped to a connection. Reusing an ID replaces its subscription. After reconnecting, the helper restores active subscriptions and sends their latest `eventId` as `lastEventId`.
|
|
80
|
+
|
|
81
|
+
With [`routing.typedRoutes`](../reference/config.md#routing-typedroutes), TypeScript checks the URL against your routes. External `http://` and `https://` URLs also work. For a URL you validate at runtime, use `as RouteUrl` from `@builtbyfriends/bwf/routes` to skip the type check.
|
|
82
|
+
|
|
83
|
+
## Publish
|
|
84
|
+
|
|
85
|
+
Publish from any server-side code that has a bwf runtime env:
|
|
86
|
+
|
|
87
|
+
```ts
|
|
88
|
+
import { live } from '../src/live';
|
|
89
|
+
|
|
90
|
+
await live.publish(
|
|
91
|
+
'post:12',
|
|
92
|
+
{ title: 'Updated title' },
|
|
93
|
+
{ type: 'updated', eventId: 'post-12-v8' },
|
|
94
|
+
);
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
Choose your own topic names and JSON payloads. bwf includes `type` and `eventId` in the event envelope without interpreting or storing them. It doesn't use native SSE `id` fields.
|
|
98
|
+
|
|
99
|
+
If you are outside an active request/runtime context, pass env explicitly:
|
|
100
|
+
|
|
101
|
+
```ts
|
|
102
|
+
await live.withEnv(env).publish('post:12', { title: 'Updated title' });
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
## Authorization
|
|
106
|
+
|
|
107
|
+
Only a connection's owner can change its subscriptions. The example above allows anonymous connections; authenticated streams use the current bwf user by default.
|
|
108
|
+
|
|
109
|
+
The owner decides who can change a connection's subscriptions, not which topics the connection can read.
|
|
110
|
+
|
|
111
|
+
For authenticated streams, pass the same owner key to `connect()` and
|
|
112
|
+
`control()`:
|
|
113
|
+
|
|
114
|
+
```ts
|
|
115
|
+
return live.connect(c, { owner: `user:${session.userId}` });
|
|
116
|
+
return live.control(c, { owner: `user:${session.userId}` });
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
If every route should derive ownership the same way, define it once with
|
|
120
|
+
`identifyConnection`:
|
|
121
|
+
|
|
122
|
+
```ts
|
|
123
|
+
export const live = defineLiveStream({
|
|
124
|
+
id: 'app',
|
|
125
|
+
async identifyConnection(ctx) {
|
|
126
|
+
const session = await getSession(ctx.request);
|
|
127
|
+
return session ? `user:${session.userId}` : null;
|
|
128
|
+
},
|
|
129
|
+
});
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
When `identifyConnection` returns `null` or `undefined`, bwf falls back to the
|
|
133
|
+
current authenticated user and uses `user:${user.id}` when the user has a string
|
|
134
|
+
`id`. If neither path produces an owner and `allowAnonymousControl` is not set,
|
|
135
|
+
the request is rejected with `403`.
|
|
136
|
+
|
|
137
|
+
Without `onSubscribe`, any connection that passes the owner check (any signed-in user, or any visitor when `allowAnonymousControl` is set) can subscribe to any topic and receives everything published to it. Topic names are easy to guess. Use `onSubscribe` to decide who can read each topic: return a `Response` to reject the subscription, or return nothing to allow it.
|
|
138
|
+
|
|
139
|
+
```ts
|
|
140
|
+
export const live = defineLiveStream({
|
|
141
|
+
id: 'app',
|
|
142
|
+
async onSubscribe(ctx) {
|
|
143
|
+
const post = /^post:(.+)$/.exec(ctx.topic);
|
|
144
|
+
if (post && (await canReadPost(ctx.env, ctx.user, post[1]))) return;
|
|
145
|
+
const inbox = /^user:(.+):inbox$/.exec(ctx.topic);
|
|
146
|
+
if (inbox && ctx.owner === `user:${inbox[1]}`) return;
|
|
147
|
+
return new Response('Forbidden', { status: 403 });
|
|
148
|
+
},
|
|
149
|
+
});
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
## Limits
|
|
153
|
+
|
|
154
|
+
`@builtbyfriends/bwf/live` is designed for small and medium fanout. By default, a stream allows:
|
|
155
|
+
|
|
156
|
+
- `256` active subscriptions per browser connection
|
|
157
|
+
- `256` active subscriptions per topic
|
|
158
|
+
- `100` subscribe or unsubscribe operations per control request
|
|
159
|
+
- `100` queued events per connection
|
|
160
|
+
- `64 KiB` per encoded event envelope
|
|
161
|
+
|
|
162
|
+
Each active topic supports up to 256 subscriptions, regardless of how many topic names your app uses. For example, `post:${postId}` gives each post its own subscriber limit. A user with two open tabs can count twice.
|
|
163
|
+
|
|
164
|
+
You can lower limits per stream:
|
|
165
|
+
|
|
166
|
+
```ts
|
|
167
|
+
export const live = defineLiveStream({
|
|
168
|
+
id: 'app',
|
|
169
|
+
limits: {
|
|
170
|
+
maxSubscriptionsPerTopic: 64,
|
|
171
|
+
},
|
|
172
|
+
});
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
`maxSubscriptionsPerTopic` cannot be raised above `256`. For larger broadcasts, split subscribers across application topics or use a dedicated realtime system.
|
|
176
|
+
|
|
177
|
+
## Delivery Semantics
|
|
178
|
+
|
|
179
|
+
Events are ordered within a topic and delivered at most once. Deploys, rollbacks, restarts, and reconnects can drop live state, so clients may miss events. Raw HTTP clients must resubscribe after reconnecting.
|
|
180
|
+
|
|
181
|
+
For replay, store events in your application and use `eventId` and `lastEventId` to resume. bwf does not store events or manage client state.
|
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: 'Sign in to the admin UI, create the first administrator, and control who can access the platform.'
|
|
3
|
+
outline: deep
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Sign-in and Access
|
|
7
|
+
|
|
8
|
+
## Signing In
|
|
9
|
+
|
|
10
|
+
For the browser admin UI, open `<API URL>/admin` and use the administrator login method selected during setup. On a new installation, follow the printed administrator setup instructions to create the first admin user. You do not need to create an app or sign in through the CLI first.
|
|
11
|
+
|
|
12
|
+
Connect to your platform's API URL, then sign in as an administrator:
|
|
13
|
+
|
|
14
|
+
```sh
|
|
15
|
+
bwf connect platform.example.com --no-login
|
|
16
|
+
bwf platform auth login
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
The first command saves the connection. The second opens your browser to sign in and saves an administrator session in your system keychain. Sessions last for one hour and are stored separately for each platform.
|
|
20
|
+
|
|
21
|
+
You can check which account is signed in at any time:
|
|
22
|
+
|
|
23
|
+
```sh
|
|
24
|
+
bwf platform auth status
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
This shows your account, the session's expiry, and the features available on the platform. To end the session, run `bwf platform auth logout`.
|
|
28
|
+
|
|
29
|
+
If the platform is protected by Cloudflare Access, `bwf connect <url>` handles
|
|
30
|
+
the company sign-in before bwf login. Interactive Access authentication uses a
|
|
31
|
+
locally installed `cloudflared` and saves its short-lived credential in your
|
|
32
|
+
system keychain for that platform origin. You do not need to copy browser cookies.
|
|
33
|
+
|
|
34
|
+
For CI, use a [project deploy token](/guide/platform/installation/first-deployment) alongside your Access credentials in origin-keyed `NOSAM_ACCESS_CREDENTIALS`. An Access service token does not authorize a bwf deployment. See [CI deployment setup](/guide/platform/installation/first-deployment) for the required origins and shape.
|
|
35
|
+
|
|
36
|
+
## Choosing a Platform
|
|
37
|
+
|
|
38
|
+
If you manage more than one platform, list your connections and choose a default:
|
|
39
|
+
|
|
40
|
+
```sh
|
|
41
|
+
bwf platform list
|
|
42
|
+
bwf platform use <connection-id>
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
You can also select a platform for a single command with `--connection`:
|
|
46
|
+
|
|
47
|
+
```sh
|
|
48
|
+
bwf platform user list --connection <connection-id>
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Use an ID or URL from the connection list. Administrative commands use this selection even when you run them inside an app with a different deployment destination.
|
|
52
|
+
|
|
53
|
+
## Recovering Administrator Login
|
|
54
|
+
|
|
55
|
+
If no administrator can use the configured identity provider, the installation
|
|
56
|
+
owner can recover an existing administrator with Cloudflare management access,
|
|
57
|
+
direct database access, and the original encrypted recovery credentials:
|
|
58
|
+
|
|
59
|
+
```sh
|
|
60
|
+
bwf platform config auth recover company --installation <id> --file recovery.json
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
The file identifies the existing account, for example
|
|
64
|
+
`{"administratorUserId":"existing-admin-id"}`. Recovery opens a real login test
|
|
65
|
+
and asks you to confirm the exact identity before restoring access. It does not
|
|
66
|
+
create a new administrator. To use a replacement provider, include its nonsecret
|
|
67
|
+
`configuration` with a new connection ID and supply the secret through
|
|
68
|
+
`--client-secret-env <name>`. To rotate an existing provider's secret, keep its
|
|
69
|
+
connection ID and identity configuration.
|
|
70
|
+
|
|
71
|
+
For `--yes`, also pin `expectedIdentity` with the exact `issuer` and `subject` in
|
|
72
|
+
the file. A successful browser login is still required. Use `--plan` to preview
|
|
73
|
+
the affected administrator and connection before starting recovery.
|
|
74
|
+
|
|
75
|
+
## Giving People Access
|
|
76
|
+
|
|
77
|
+
Open **Settings** in the administrator UI, or run `bwf platform config auth`,
|
|
78
|
+
to add, test, enable, or disable login methods. Access protection and login
|
|
79
|
+
methods are separate settings. A provider test shows the authenticated account
|
|
80
|
+
before you explicitly link it or enable the configuration.
|
|
81
|
+
|
|
82
|
+
To change the company gate after installation, use the installing workstation
|
|
83
|
+
with its saved recovery credentials:
|
|
84
|
+
|
|
85
|
+
```sh
|
|
86
|
+
bwf platform config auth protection show
|
|
87
|
+
bwf platform config auth protection enable --installation <id>
|
|
88
|
+
bwf platform config auth protection disable --installation <id>
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
Enabling offers application creation or connection to an existing application.
|
|
92
|
+
It checks every API, proxy, and configured dashboard origin and requires a company
|
|
93
|
+
user sign-in. Changing protection ends all current human sessions; sign in again
|
|
94
|
+
afterwards. Before removing a gate used for company signup, select another
|
|
95
|
+
verified company rule or restricted signup. Removing protection retains the
|
|
96
|
+
Cloudflare applications for deliberate cleanup. Disabling an Access login method
|
|
97
|
+
does not remove the gate.
|
|
98
|
+
|
|
99
|
+
Users can add another enabled login to their existing account with
|
|
100
|
+
`bwf account link <connection-id>` or **Account** in the optional
|
|
101
|
+
dashboard. Sign in again first if prompted, then authenticate with the additional
|
|
102
|
+
provider and confirm the identity shown. Matching email addresses alone do not
|
|
103
|
+
link accounts.
|
|
104
|
+
|
|
105
|
+
In the admin dashboard, open **People → Access** to choose who can join, invite
|
|
106
|
+
people, and manage individual signup grants. Choose **Company-approved or
|
|
107
|
+
individually approved users** to create accounts automatically for people who
|
|
108
|
+
meet your configured company rules while still allowing explicit invitations
|
|
109
|
+
and allowlist grants. Company protection at the platform edge still applies
|
|
110
|
+
before anyone reaches a login page.
|
|
111
|
+
|
|
112
|
+
With invited/allowlisted signup selected, let a teammate join with GitHub by adding their login to the allowlist:
|
|
113
|
+
|
|
114
|
+
```sh
|
|
115
|
+
bwf platform signup allow github teammate
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
bwf shows the change and asks you to confirm it. The teammate can then run `bwf connect` with the platform's URL and sign in.
|
|
119
|
+
|
|
120
|
+
You can allow an email address or a whole email domain in the same way:
|
|
121
|
+
|
|
122
|
+
```sh
|
|
123
|
+
bwf platform signup allow email teammate@example.com
|
|
124
|
+
bwf platform signup allow email '*@example.com'
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
Email patterns apply across the platform's sign-in providers. Quote a domain pattern so your shell passes the `*` to bwf.
|
|
128
|
+
|
|
129
|
+
For an OIDC login without a verified email, allow the identity by its login connection and stable provider subject instead:
|
|
130
|
+
|
|
131
|
+
```sh
|
|
132
|
+
bwf platform signup allow identity company-sso 'Employee-42'
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
Use the connection ID shown by `bwf platform config auth list` and the exact subject reported by your identity provider. The match is case-sensitive and does not infer an email address or link another account. Any domain or group restrictions configured for that login method still apply, and the account joins as an ordinary user. Remove the grant with `bwf platform signup disallow identity company-sso 'Employee-42'`.
|
|
136
|
+
|
|
137
|
+
To invite someone else by email, use:
|
|
138
|
+
|
|
139
|
+
```sh
|
|
140
|
+
bwf platform invitation send alex@example.org
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
An invitation grants signup access for that exact email address. The person must
|
|
144
|
+
sign in with a login method that supplies the same verified email address.
|
|
145
|
+
When platform email delivery is configured, bwf also sends connection
|
|
146
|
+
instructions. If delivery is unavailable or fails, the grant still works:
|
|
147
|
+
share the platform's `/invite` page or `bwf connect '<platform URL>'` command
|
|
148
|
+
with the person yourself. The admin dashboard shows the delivery outcome
|
|
149
|
+
separately from the invitation's pending, accepted, or revoked status.
|
|
150
|
+
|
|
151
|
+
Inspect the current access settings and invitations with:
|
|
152
|
+
|
|
153
|
+
```sh
|
|
154
|
+
bwf platform signup show
|
|
155
|
+
bwf platform invitation list
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
Invitation history remains available after an involved account is removed. The stored actor ID
|
|
159
|
+
remains visible when that account's login no longer exists.
|
|
160
|
+
|
|
161
|
+
`bwf platform signup open` allows anyone to sign up. Everyone who signs up can deploy apps on your application domain, so check how those apps [share cookies](/guide/platform/installation/domains#adding-a-domain) before opening signup. Use `bwf platform signup restrict` to require an allowlist match again. Disallowing an entry affects future signup; it does not suspend an existing account.
|
|
162
|
+
|
|
163
|
+
## Connected apps
|
|
164
|
+
|
|
165
|
+
Register separate applications as OAuth clients through [Connected apps](./connected-apps.md). Users connect their identity and approve each publish on bwf.
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: 'Let users sign in to another app with their bwf account and approve deployments to their projects.'
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Connected apps
|
|
6
|
+
|
|
7
|
+
A connected app is a separate application registered as an OAuth client on your bwf installation. Users sign in on bwf and decide whether to connect it. The application operator may be different from the platform administrator.
|
|
8
|
+
|
|
9
|
+
## Register an application
|
|
10
|
+
|
|
11
|
+
Open **Admin → Connected apps**. Enter the app name, its operator, and each exact HTTPS callback URL on a separate line. Wildcards and callback query strings are not supported. Enable individual publish approvals if the app builds and deploys projects. Enable private previews to run checkpoints before publishing. Existing clients have an **Enable private previews** button; users must connect again to consent to that permission.
|
|
12
|
+
|
|
13
|
+
Save the returned client ID and secret on the app's server. bwf shows the secret once. The client secret authenticates that application; it does not grant access to users' accounts. Register a new client if you need replacement credentials, then disable the old one.
|
|
14
|
+
|
|
15
|
+
**Disable and revoke access** invalidates the client's grants, pending sign-ins, and publish approvals. Registration and disablement appear in the operator audit.
|
|
16
|
+
|
|
17
|
+
Local development permits exact HTTP callbacks on localhost when the platform's development authentication bypass is explicitly enabled. Production clients require HTTPS.
|
|
18
|
+
|
|
19
|
+
## Connect and disconnect
|
|
20
|
+
|
|
21
|
+
The app sends users to bwf's authorization page, where bwf displays its registered name, operator, callback origin, and requested permission. Sign-in permits reading the user's ID and username. It does not provide an account token or project management access.
|
|
22
|
+
|
|
23
|
+
Users can disconnect apps at `<platform API URL>/oauth/connections`. Access tokens last one hour; apps can renew them with a refresh token for up to 30 days after the user's original sign-in. Revoking that sign-in or suspending the account ends access sooner. The app must then ask the user to sign in again.
|
|
24
|
+
|
|
25
|
+
## Private previews
|
|
26
|
+
|
|
27
|
+
Sign-in can request `scope=profile preview:deploy` when the administrator has enabled it. After user consent, the app can build private previews without approval for each checkpoint. Production publishing still requires individual approval.
|
|
28
|
+
|
|
29
|
+
Use the granted bearer token to:
|
|
30
|
+
|
|
31
|
+
1. POST `{ workspace: externalWorkspaceId }` to `/oauth/previews`. The response contains a stable `project_id` and preview `url` for that client, owner and workspace.
|
|
32
|
+
2. POST `{ project_id, checkpoint, artifact: prepared.artifact }` to `/oauth/preview-deployment-requests`. Use its `access_token` and `approval_id` with the same asset upload and deployment protocol as publishing.
|
|
33
|
+
3. Once deployment finishes, POST to `/oauth/previews/:id/launch` and open the returned URL. Launch URLs expire after one minute and can be used once. Reload the preview's origin after opening it.
|
|
34
|
+
|
|
35
|
+
Each workspace has a separate preview origin and resources, with no production secrets. Previews support HTTP apps with isolated D1, KV, R2, AI and native Durable Objects. Authentication, external databases, email, schedules, queues and containers require production publishing. Viewing requires the current user grant; disconnecting or disabling the app denies subsequent requests. Preview writes must originate from that preview's own origin.
|
|
36
|
+
|
|
37
|
+
Account Access policies must allow requests to generated preview origins to reach bwf. A policy that blocks new Workers hostnames also blocks previews. bwf still requires a valid preview grant when the hostname is reachable.
|
|
38
|
+
|
|
39
|
+
Each owner can have ten preview workspaces. Each workspace permits sixty builds per hour and shares the owner's platform resource and usage limits. Inactive previews expire after seven days and bwf removes their resources. Opening the workspace through `/oauth/previews` renews that expiry. Disabling preview permission expires its previews.
|
|
40
|
+
|
|
41
|
+
## Approve a publish
|
|
42
|
+
|
|
43
|
+
The app builds first, then sends the user to bwf with the prepared artifact. bwf displays the project name, checkpoint label, resources, manifest, and artifact digest. The user must explicitly approve on bwf.
|
|
44
|
+
|
|
45
|
+
Approval permits one deployment to that user's chosen project. bwf creates a missing project during approval; existing projects require ownership. The app receives a credential valid for up to fifteen minutes, restricted to that artifact's asset uploads, deployment, and receipt. Retries use the same receipt.
|
|
46
|
+
|
|
47
|
+
Published code can use that project's existing secrets and resources. Review the app operator and deployment details before approving code for an existing project. Migrations and resource changes in the approved manifest take effect during deployment.
|
|
48
|
+
|
|
49
|
+
Disabling the app or disconnecting its grant stops authorization for subsequent actions and is checked again before a queued deployment publishes. Disconnecting does not remove an app that has already been published; manage that project through bwf.
|
|
50
|
+
|
|
51
|
+
## Build an OAuth client
|
|
52
|
+
|
|
53
|
+
Discover endpoints at `/.well-known/oauth-authorization-server` on the platform API origin. Use authorization code flow with `scope=profile`, a random `state`, and S256 PKCE. Authenticate token exchanges using HTTP Basic client authentication. Send access tokens as Bearer credentials to `/oauth/userinfo`; its response contains `sub`, `preferred_username`, and the consented `scope`.
|
|
54
|
+
|
|
55
|
+
The code exchange also returns a refresh token. To renew access:
|
|
56
|
+
|
|
57
|
+
1. POST `grant_type=refresh_token` and the `refresh_token` to `/oauth/token`, using client Basic authentication.
|
|
58
|
+
2. Save the returned access token and refresh token securely, replacing the old pair.
|
|
59
|
+
|
|
60
|
+
Send one refresh at a time per connection. Each refresh token works once; reusing it revokes the connection and requires the user to reconnect.
|
|
61
|
+
|
|
62
|
+
To request fewer permissions, pass a space-separated `scope`. Later refreshes cannot restore permissions you dropped. Publish tokens (`deploy:approve`) have no refresh token: each publish needs its own approval.
|
|
63
|
+
|
|
64
|
+
For publishing, package the built app with [`prepareDeployArtifact`](/reference/api/deploy). POST to `/oauth/deployment-requests` using the profile token:
|
|
65
|
+
|
|
66
|
+
```ts
|
|
67
|
+
{
|
|
68
|
+
redirect_uri: registeredCallback,
|
|
69
|
+
state: publishState,
|
|
70
|
+
code_challenge: publishChallenge,
|
|
71
|
+
code_challenge_method: 'S256',
|
|
72
|
+
slug: projectSlug,
|
|
73
|
+
checkpoint: checkpointLabel,
|
|
74
|
+
artifact: prepared.artifact
|
|
75
|
+
}
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
Redirect the browser to the returned `authorization_url`. Exchange its code with the publish verifier and the same registered callback. The response includes `project_id`, `approval_id`, and a `deploy:approve` access token. This publish flow is a bwf extension; requesting that scope in an ordinary sign-in does not authorize deployment.
|
|
79
|
+
|
|
80
|
+
Use the token to request URLs from the `deploy.uploadUrls` procedure (`POST /rpc/deploy.uploadUrls`), upload the declared assets, and send the artifact to `deploy.finalize` (`POST /rpc/deploy.finalize`) as `{ projectId, body, idempotencyKey }`. Set `idempotencyKey` to `approval_id`. Deployment uses bwf's managed deployment protocol and requires the platform deployment Queue. The credential cannot read secrets, mint project tokens, delete projects, or deploy different bytes.
|
|
81
|
+
|
|
82
|
+
Revoke a connection with `POST /oauth/revoke`, authenticated as the client, using either its access token or its refresh token. bwf does not issue an OpenID Connect ID token.
|
|
83
|
+
|
|
84
|
+
If the API is protected by Cloudflare Access, the application operator must also configure a service identity permitted by that Access application's policy. Server OAuth endpoints and approved deployment requests still validate their own client, grant, and project authority; browser consent requires the user's company identity.
|