docs: embedding contract, stability statement, and IdP callout for the hosted substrate#253
Open
davidfarah2003 wants to merge 1 commit into
Open
docs: embedding contract, stability statement, and IdP callout for the hosted substrate#253davidfarah2003 wants to merge 1 commit into
davidfarah2003 wants to merge 1 commit into
Conversation
…r the hosted substrate Document how a separate closed repo consumes the published @cotal-ai/* packages as a hosted substrate (W2 of the hosted-substrate-readiness plan, plus W3's two non-seam verification bullets). - docs/embedding.md: the library-export audit (every daemon runner, provisioning and minting primitive, auth building block, and seam a closed composition root needs is a real published export), the three-daemon integration guide, the hazardous-primitives guardrails, the four not-yet-hosted-composable gaps (delivery membership/eviction file protocol, manager secret threading, many-spaces provisioning, non-Better-Auth IdP), and the durable-state boundary. - docs/stability.md: what wire v0.3 and packages 0.12.x guarantee, the pre-1.0 npm semver caveat, and the projected v0.4 break-family list. Notes that the protocolVersion marker is unset today, so a hosted broker gates out of band. - docs/identity-and-auth.md: a new "IdP callout contract" section (pinned-JWKS EdDSA bearer validation, frozen owner derivation, ledger authorization) and the Better Auth isolation (dev-only dependency). Also reconciles the now-inaccurate "signing key confined to the auth service" claim (a running manager also holds it) across identity-and-auth, security, and roadmap, and adds a broker-enforced-guarantee caveat to the security threat model.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
W2 of the hosted-substrate-readiness plan (pin down the embedding contract) plus W3's two non-seam verification bullets. Documents how a separate closed repo consumes the published
@cotal-ai/*packages as a hosted substrate. Docs-only.docs/embedding.md(new): the library-export audit, the three-daemon integration guide (auth-service, delivery, supervise), hazardous-primitives guardrails, the not-yet-hosted-composable gaps, and the durable-state boundary.docs/stability.md(new): what wire v0.3 and packages 0.12.x guarantee, the pre-1.0 npm semver caveat, and the projected v0.4 break-family list.docs/identity-and-auth.md: a new "IdP callout contract" section and the Better Auth isolation.identity-and-auth,security, androadmap, and adds a broker-enforced-guarantee caveat to the security threat model.Audit conclusion (three tiers)
Manageras a trusted per-tenant account-signer.W3 verified: Better Auth is a dev-only dependency (dev-idp + smokes; runtime coupling is
idp.ts+ the auth-provider extension, IdP-agnostic via config); hosting-critical durable state is enumerated, coordination state is JetStream-resident.Review
Mesh panel (engineer / security / critic, opencode gpt-5.6-sol high): 3/3 LGTM after a plan review and two artifact-review fold rounds. Independent freelance cold read folded (it caught the IdP auto-registration collision, the unset
protocolVersion, and aremintDaemonCredsthrow path, among others).Decision needed
The stability statement leaves open Decision 4: at what package version the embedding surface is "stable to build a paid product on", and whether to publish a pre-1.0 semver / support policy. Raising separately.
Flagged follow-ups (out of this PR)
deploy/README.mdand the publicstripSpaceAuthTSDoc (packages/core/src/provision.ts); left becauseprovision.tsis being churned by the secret-store seam work. Fold into the next secret-seam / deploy-doc refresh.docs/deploy.md's container-isolation intro ("no host file access") is a pre-existing self-contradiction for the deploy-doc owner.