diff --git a/README.md b/README.md index 5405d61..b6273a9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# HiveCast SDK +# Matrix SDK -HiveCast SDK is the package-author layer for building Matrix actors, browser +Matrix SDK is the package-author layer for building Matrix actors, browser surfaces, and broker-connected applications without depending on a managed platform repo. @@ -19,7 +19,7 @@ packed tarballs. - Browser host integrations for Matrix web surfaces - Package-author CLIs and project scaffolds -HiveCast SDK is provider-neutral. It does not require a managed platform account, +Matrix SDK is provider-neutral. It does not require a managed platform account, device-link ceremony, host-link implementation, managed host service, local platform install, Postgres database, or provider-owned broker authority. A provider overlay can issue broker credentials and host runtimes on top of the @@ -33,7 +33,7 @@ part of the package-author SDK proof. | Package | Purpose | | --- | --- | -| `@open-matrix/hivecast-sdk` | Public umbrella facade for actor/package authors | +| `@open-matrix/sdk` | Public umbrella facade for actor/package authors | | `@open-matrix/core` | Actor kernel, runtime, transports, serialization, browser actor base classes | | `@open-matrix/cli` | Package-author `matrix` CLI | | `@open-matrix/browser-kit` | Browser app shims, theme tokens, Vite helpers, shell components | @@ -51,14 +51,14 @@ import { MatrixActor } from '@open-matrix/core'; Use the umbrella package when you intentionally want the public SDK facade: ```ts -import { MatrixActor } from '@open-matrix/hivecast-sdk'; +import { MatrixActor } from '@open-matrix/sdk'; ``` ## Quick Start ```bash -git clone https://registry.hivecast.ai/open-matrix/hivecast-sdk.git -cd hivecast-sdk +git clone git@github.com:matrix-sdk/matrix-sdk.git +cd matrix-sdk pnpm install --frozen-lockfile pnpm prove ``` @@ -212,7 +212,7 @@ Done and proven: - The SDK packages build independently from their original source monorepo. - Package identities use final `@open-matrix/*` names. -- `@open-matrix/hivecast-sdk` re-exports the public actor facade. +- `@open-matrix/sdk` re-exports the public actor facade. - A fresh clone passes `pnpm install --frozen-lockfile && pnpm prove`. - A temporary external consumer can install packed SDK tarballs, compile, start a `MatrixActor`, and call it through Matrix runtime/transport. @@ -232,7 +232,7 @@ must be added as an explicit release policy before any npm publication. ## Relationship To Provider Overlays -HiveCast SDK is the provider-neutral actor SDK. +Matrix SDK is the provider-neutral actor SDK. Provider overlays can provide account management, namespaces, API keys, broker credential issuance, runtime hosting, package distribution, and operator UI. diff --git a/STANDALONE-AUDIT.md b/STANDALONE-AUDIT.md index 0344934..662949a 100644 --- a/STANDALONE-AUDIT.md +++ b/STANDALONE-AUDIT.md @@ -2,7 +2,7 @@ Date: 2026-06-07 -This repository is intended to be a standalone HiveCast SDK repository. The SDK +This repository is intended to be a standalone Matrix SDK repository. The SDK packages must be usable without the HiveCast application monorepo, without Matrix-3 path assumptions, and without platform-only concepts such as Device Link, Host Link, system-auth, or gateway internals. diff --git a/examples/hivecast-login/run-demo.mjs b/examples/hivecast-login/run-demo.mjs index 143fabe..63333c8 100644 --- a/examples/hivecast-login/run-demo.mjs +++ b/examples/hivecast-login/run-demo.mjs @@ -82,7 +82,7 @@ if (checkOnly) { const demoHome = process.env.MATRIX_DEMO_HOME ? resolve(process.env.MATRIX_DEMO_HOME) - : mkdtempSync(join(tmpdir(), 'hivecast-sdk-login.')); + : mkdtempSync(join(tmpdir(), 'matrix-sdk-hivecast-login.')); const keep = process.env.MATRIX_DEMO_KEEP === '1' || Boolean(process.env.MATRIX_DEMO_HOME); try { diff --git a/examples/standalone-greeter/matrix.json b/examples/standalone-greeter/matrix.json index 402172b..fd6bf2b 100644 --- a/examples/standalone-greeter/matrix.json +++ b/examples/standalone-greeter/matrix.json @@ -1,5 +1,5 @@ { - "name": "hivecast-sdk-example-standalone-greeter", + "name": "matrix-sdk-example-standalone-greeter", "version": "0.0.0", "runtime": { "language": "typescript", diff --git a/examples/standalone-greeter/package.json b/examples/standalone-greeter/package.json index 7039051..e6ff173 100644 --- a/examples/standalone-greeter/package.json +++ b/examples/standalone-greeter/package.json @@ -1,5 +1,5 @@ { - "name": "hivecast-sdk-example-standalone-greeter", + "name": "matrix-sdk-example-standalone-greeter", "version": "0.0.0", "private": true, "type": "module", diff --git a/examples/standalone-greeter/run-demo.mjs b/examples/standalone-greeter/run-demo.mjs index 3625017..a3bc63d 100644 --- a/examples/standalone-greeter/run-demo.mjs +++ b/examples/standalone-greeter/run-demo.mjs @@ -74,7 +74,7 @@ let runner; try { run('pnpm', ['run', 'build']); - run('pnpm', ['--filter', 'hivecast-sdk-example-standalone-greeter', 'run', 'build']); + run('pnpm', ['--filter', 'matrix-sdk-example-standalone-greeter', 'run', 'build']); runner = spawn(process.execPath, [ matrixCli, 'run', demoDir, diff --git a/package.json b/package.json index 43eb7ca..88f7677 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "hivecast-sdk-workspace", + "name": "matrix-sdk-workspace", "version": "0.0.0", "private": true, "type": "module", diff --git a/packages/cli/README.md b/packages/cli/README.md index 2fd7bb5..26301bc 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -1,6 +1,6 @@ # @open-matrix/cli -Package-author CLI for the HiveCast SDK layer. +Package-author CLI for the Matrix SDK layer. This package owns the SDK/package-author `matrix` binary. It does not depend on provider overlay packages, managed host packages, platform system actors, diff --git a/packages/cli/src/__tests__/cli.test.ts b/packages/cli/src/__tests__/cli.test.ts index 2801b39..3bd842b 100644 --- a/packages/cli/src/__tests__/cli.test.ts +++ b/packages/cli/src/__tests__/cli.test.ts @@ -6,7 +6,7 @@ import test from 'node:test'; import { main } from '../cli.js'; test('init, add actor, and configure write package-local SDK state', async () => { - const root = await mkdtemp(join(tmpdir(), 'hivecast-sdk-cli-test.')); + const root = await mkdtemp(join(tmpdir(), 'matrix-sdk-cli-test.')); await main(['init', root, '--name', 'demo-package']); await main(['add', 'actor', 'greeter', '--dir', root, '--mount', 'demo.greeter']); @@ -57,15 +57,15 @@ test('init, add actor, and configure write package-local SDK state', async () => }); test('up delegates a host-runnable package to an explicit managed host command', async () => { - const root = await mkdtemp(join(tmpdir(), 'hivecast-sdk-cli-up-test.')); - const testRuntimeHost = join(root, 'test-runtime-host.mjs'); + const root = await mkdtemp(join(tmpdir(), 'matrix-sdk-cli-up-test.')); + const fakeRuntimeHost = join(root, 'fake-runtime-host.mjs'); const calledPath = join(root, 'runtime-host-called.json'); await main(['init', root, '--name', 'demo-package']); await main(['add', 'actor', 'greeter', '--dir', root, '--mount', 'demo.greeter']); await mkdir(join(root, 'dist'), { recursive: true }); await writeFile(join(root, 'dist', 'index.js'), 'export function createStandaloneGreeterActor() {}\n', 'utf8'); - await writeFile(testRuntimeHost, ` + await writeFile(fakeRuntimeHost, ` import { writeFileSync } from 'node:fs'; writeFileSync(${JSON.stringify(calledPath)}, JSON.stringify({ argv: process.argv.slice(2), @@ -79,7 +79,7 @@ writeFileSync(${JSON.stringify(calledPath)}, JSON.stringify({ '--key', 'test-key', '--cloud', 'https://example.invalid', '--space', 'demo-space', - '--runtime-host-bin', testRuntimeHost, + '--runtime-host-bin', fakeRuntimeHost, '--runtime-host-routing', 'workspace-source', ]); await main(['up', '--dir', root, '--json']); @@ -91,7 +91,7 @@ writeFileSync(${JSON.stringify(calledPath)}, JSON.stringify({ }); test('add actor preserves explicit Actor class suffix', async () => { - const root = await mkdtemp(join(tmpdir(), 'hivecast-sdk-cli-actor-suffix-test.')); + const root = await mkdtemp(join(tmpdir(), 'matrix-sdk-cli-actor-suffix-test.')); await main(['init', root, '--name', 'demo-package']); await main(['add', 'actor', 'GreeterActor', '--dir', root, '--mount', 'demo.greeter']); diff --git a/packages/core/package.json b/packages/core/package.json index 0c37d42..5b201ce 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -7,7 +7,7 @@ "license": "MIT", "repository": { "type": "git", - "url": "https://registry.hivecast.ai/open-matrix/hivecast-sdk.git", + "url": "https://github.com/matrix-sdk/matrix-sdk.git", "directory": "packages/core" }, "keywords": [ diff --git a/packages/sdk/CONTRACT.md b/packages/sdk/CONTRACT.md index ff0529a..d01f284 100644 --- a/packages/sdk/CONTRACT.md +++ b/packages/sdk/CONTRACT.md @@ -1,6 +1,6 @@ -# @open-matrix/hivecast-sdk Contract +# @open-matrix/sdk Contract -`@open-matrix/hivecast-sdk` is a package-author facade over the public SDK package set. +`@open-matrix/sdk` is a package-author facade over the public SDK package set. It may export from the Node-safe root: diff --git a/packages/sdk/README.md b/packages/sdk/README.md index 457abf6..5e77567 100644 --- a/packages/sdk/README.md +++ b/packages/sdk/README.md @@ -1,6 +1,6 @@ -# @open-matrix/hivecast-sdk +# @open-matrix/sdk -Public HiveCast actor SDK facade for package authors. +Public Matrix actor SDK facade for package authors. Prefer narrow package imports when a package only needs one layer: @@ -12,5 +12,5 @@ Use this umbrella package when a package intentionally needs the combined actor, browser host, contracts, federation, and Omega kernel facade. Import browser app build utilities directly from `@open-matrix/browser-kit` so -headless actor packages can import `@open-matrix/hivecast-sdk` without loading +headless actor packages can import `@open-matrix/sdk` without loading browser-only custom element code. diff --git a/packages/sdk/package.json b/packages/sdk/package.json index 2715257..a6ef74b 100644 --- a/packages/sdk/package.json +++ b/packages/sdk/package.json @@ -1,7 +1,7 @@ { - "name": "@open-matrix/hivecast-sdk", + "name": "@open-matrix/sdk", "version": "0.1.0", - "description": "Public HiveCast actor SDK facade for package authors.", + "description": "Public Matrix actor SDK facade for package authors.", "type": "module", "private": true, "main": "./dist/index.js", diff --git a/scripts/clean.mjs b/scripts/clean.mjs index f6dd41c..ae49fe5 100644 --- a/scripts/clean.mjs +++ b/scripts/clean.mjs @@ -31,7 +31,7 @@ for (const pkg of packages) { 'open-matrix-browser-kit-0.1.0.tgz', 'open-matrix-cli-0.1.0.tgz', 'open-matrix-core-0.1.0.tgz', - 'open-matrix-hivecast-sdk-0.1.0.tgz', + 'open-matrix-sdk-0.1.0.tgz', ]; for (const tarball of tarballs) { rmSync(join(pkgRoot, tarball), { force: true }); diff --git a/scripts/prove-external-consumer.mjs b/scripts/prove-external-consumer.mjs index c827a3d..e0ccbbb 100644 --- a/scripts/prove-external-consumer.mjs +++ b/scripts/prove-external-consumer.mjs @@ -16,7 +16,7 @@ const packages = [ '@open-matrix/core', '@open-matrix/browser-host', '@open-matrix/browser-kit', - '@open-matrix/hivecast-sdk', + '@open-matrix/sdk', '@open-matrix/cli', ]; @@ -70,7 +70,7 @@ async function assertNoSymlinkToHarness(dir) { } async function main() { - const proofRoot = await mkdtemp(path.join(tmpdir(), 'hivecast-sdk-consumer-proof.')); + const proofRoot = await mkdtemp(path.join(tmpdir(), 'matrix-sdk-consumer-proof.')); const tarballDir = path.join(proofRoot, 'tarballs'); const consumerDir = path.join(proofRoot, 'consumer'); let keep = process.env.MATRIX_SDK_KEEP_CONSUMER_PROOF === '1'; @@ -94,7 +94,7 @@ async function main() { ); await writeFile(path.join(consumerDir, 'package.json'), JSON.stringify({ - name: 'hivecast-sdk-external-consumer-proof', + name: 'matrix-sdk-external-consumer-proof', version: '0.0.0', private: true, type: 'module', @@ -144,7 +144,7 @@ import { MatrixRuntime, TopicRouter, } from '@open-matrix/core'; -import { MatrixActor as SdkMatrixActor } from '@open-matrix/hivecast-sdk'; +import { MatrixActor as SdkMatrixActor } from '@open-matrix/sdk'; class EchoActor extends MatrixActor { static accepts = { diff --git a/scripts/prove-sdk-cli-uat.mjs b/scripts/prove-sdk-cli-uat.mjs index 3cdd5fb..5356fbd 100644 --- a/scripts/prove-sdk-cli-uat.mjs +++ b/scripts/prove-sdk-cli-uat.mjs @@ -18,7 +18,7 @@ const packages = [ '@open-matrix/core', '@open-matrix/browser-host', '@open-matrix/browser-kit', - '@open-matrix/hivecast-sdk', + '@open-matrix/sdk', '@open-matrix/cli', ]; @@ -157,7 +157,7 @@ async function createProofWorkspace(proofRoot) { copied: false, }; } - const copiedWorkspace = path.join(proofRoot, 'hivecast-sdk-workspace'); + const copiedWorkspace = path.join(proofRoot, 'matrix-sdk-workspace'); await cp(sourceWorkspaceDir, copiedWorkspace, { recursive: true, dereference: false, @@ -219,7 +219,7 @@ async function stopChild(child) { } async function main() { - const proofRoot = await mkdtemp(path.join(tmpdir(), 'hivecast-sdk-cli-uat.')); + const proofRoot = await mkdtemp(path.join(tmpdir(), 'matrix-sdk-cli-uat.')); const proofWorkspace = await createProofWorkspace(proofRoot); workspaceDir = proofWorkspace.workspaceDir; const tarballDir = path.join(proofRoot, 'tarballs'); @@ -271,7 +271,7 @@ async function main() { ); await writeFile(path.join(toolingDir, 'package.json'), JSON.stringify({ - name: 'hivecast-sdk-cli-uat-tooling', + name: 'matrix-sdk-cli-uat-tooling', version: '0.0.0', private: true, type: 'module', @@ -424,7 +424,7 @@ async function main() { run('pnpm', ['pack', '--pack-destination', packageTarballDir], { cwd: authorDir, stdio: 'pipe' }); const authorPackageTarball = await findOnlyTarball(packageTarballDir, 'generated author package'); await writeFile(path.join(packageConsumerDir, 'package.json'), JSON.stringify({ - name: 'hivecast-sdk-package-manager-consumer', + name: 'matrix-sdk-package-manager-consumer', version: '0.0.0', private: true, type: 'module',