open-matrix/hivecast-sdk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: update standalone SDK audit

Browse Source
This commit is contained in:
Ubuntu 2026-06-08 18:48:47 +00:00
parent ba04c18741
commit 211d36ac5f
1 changed files with 22 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
STANDALONE-AUDIT.md
View File

@ -11,24 +11,28 @@ Link, Host Link, system-auth, or gateway internals.
The SDK package surface is standalone enough for the current authoring proof: The SDK package surface is standalone enough for the current authoring proof:
- A fresh consumer installs the SDK CLI as a package-manager dependency. - A fresh consumer can install `@open-matrix/sdk` and `@open-matrix/cli` from an
- `matrix init` creates a fresh author package. npm-compatible registry.
- `matrix add actor` creates an actor importing `@open-matrix/core`. - `matrix broker setup` installs a project-local `nats-server` binary for demos.
- `matrix configure` writes package-local `.matrix` credentials/config. - `matrix broker start` starts that local broker without a HiveCast account or
- `matrix run` starts the actor directly. preinstalled Matrix binary.
- `matrix invoke` calls the actor through the SDK CLI. - `matrix actor run <entry> --check-op <op>` starts a direct actor and calls it
- The generated package can be packed, installed into a separate consumer, run, through the Matrix runtime/transport path.
and invoked again. - Actor handlers are validated before broker connection: `accepts.echo` must be
implemented as `onEcho(payload)`, not `echo(payload)`.
The proof script also checks that generated author-package files do not contain The fresh Docker proof checks that the package-manager install path has no
legacy monorepo paths or upper-layer package dependencies. Matrix/HiveCast preinstall dependency and that bad actor handlers fail loudly
instead of timing out.
Checked-in demos now cover the same boundary in user-facing form: Checked-in demos now cover the same boundary in user-facing form:
- `pnpm demo:standalone` runs `examples/standalone-greeter` without provider - `pnpm demo:standalone` runs `demos/standalone-greeter` without provider
credentials. credentials.
- `pnpm demo:hivecast-login` validates a user-supplied HiveCast API key and - `demos/fresh-server-actor` shows a server-side actor using HiveCast-exchanged
writes package-local SDK config/credentials in a temporary demo home. broker credentials.
- `demos/fresh-web-page` shows a browser actor/web page using HiveCast-exchanged
broker credentials.
## Cleanup Completed ## Cleanup Completed
@ -37,11 +41,11 @@ Checked-in demos now cover the same boundary in user-facing form:
- Core package README and metadata use `@open-matrix/*` names and this repo URL. - Core package README and metadata use `@open-matrix/*` names and this repo URL.
- Browser host strings describe generic managed HTTP/broker surfaces instead of - Browser host strings describe generic managed HTTP/broker surfaces instead of
HiveCast-specific local/dev URLs. HiveCast-specific local/dev URLs.
- CLI contracts describe standalone SDK boundaries and optional managed-host - CLI docs describe standalone SDK boundaries and optional provider-managed
integration without naming product-only packages as part of the SDK. broker credential files without naming product-only packages as part of the
- The SDK CLI UAT proof no longer defaults to a HiveCast binary or SDK.
`dev.hivecast.ai`; managed-host proof requires explicit - The SDK CLI proof no longer defaults to a HiveCast binary, `dev.hivecast.ai`,
`MATRIX_SDK_RUNTIME_HOST_BIN`. Host Service, or Device Link.
- The internal theme manifest uses `@open-matrix/theme`. - The internal theme manifest uses `@open-matrix/theme`.
## Intentional Guard Strings ## Intentional Guard Strings