Skip to content

Commit 934bc42

Browse files
committed
docs(sdk): announce published TypeScript beta and npm installation
1 parent 08ea037 commit 934bc42

8 files changed

Lines changed: 43 additions & 24 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ All notable public-contract changes are recorded here. Meldbase remains alpha;
44
entries under **Unreleased** are not a published compatibility commitment until
55
they are assigned to a release.
66

7-
## TypeScript SDK 0.1.0-beta.1 (pending npm publication)
7+
## TypeScript SDK 0.1.0-beta.1 — 2026-10-10
88

99
- Establish reviewed public API reports for the client, local collection,
1010
shared types, React, and trusted-worker entry points. CI rejects unreviewed

‎docs/.vitepress/theme/components/MeldbaseHome.vue‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ async function copy() {
111111
</div>
112112
<pre role="tabpanel" :aria-label="`${tab} API excerpt`"><code>{{ snippets[tab] }}</code></pre>
113113
<a class="editor-footer" :href="withBase(guides[tab])"
114-
>{{ tab === "Go" ? "Run the complete Go example" : "Workspace SDK preview · Follow the setup guide" }}
114+
>{{ tab === "Go" ? "Run the complete Go example" : "TypeScript SDK beta · Follow the setup guide" }}
115115
<span>→</span></a
116116
>
117117
</div>

‎docs/browser.md‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,15 @@ Use the Meldbase client in a browser when a web application needs documents and
44
live queries. The browser connects to a running `meld serve`; it never opens a
55
`.meld` file directly.
66

7-
The SDK is currently a workspace preview and is not yet published to npm. Its
8-
public package name will be `@meldbase/client`. Until publication, use the
9-
included browser example from a Meldbase checkout:
7+
Install the SDK in your browser application:
8+
9+
```sh
10+
npm install @meldbase/client@beta
11+
```
12+
13+
The package is published as `0.1.0-beta.1`; see the
14+
[SDK compatibility policy](/sdk-status) before upgrading.
15+
To run the included browser example, use a Meldbase checkout:
1016

1117
```sh
1218
pnpm install --frozen-lockfile

‎docs/installation.md‎

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,25 @@ Keep this development server local. An externally reachable service requires
3636
an authentication and collection-policy configuration; inspect `meld serve --help`
3737
and the server configuration in the repository before deploying it.
3838

39-
## TypeScript workspace preview
39+
## TypeScript SDK beta
4040

41-
The SDK packages are not yet published to npm. Use the public workspace:
41+
Install the packages your application needs:
42+
43+
```sh
44+
npm install @meldbase/client@beta
45+
npm install @meldbase/react@beta react
46+
npm install @meldbase/worker@beta
47+
```
48+
49+
All three packages are published as `0.1.0-beta.1`. Pin that exact version for
50+
reproducible builds. Node.js 20 or later is required for Node applications.
51+
See [SDK compatibility and release status](/sdk-status) for the beta API policy.
52+
53+
Continue with the [Browser guide](/browser) or [Node.js guide](/node).
54+
55+
## Run the repository example
56+
57+
To explore the public browser example, use the repository workspace:
4258

4359
```sh
4460
git clone https://github.com/crapthings/meldbase.git
@@ -56,7 +72,7 @@ pnpm --filter @meldbase/example-realtime-todos dev
5672
```
5773

5874
Start the server in another terminal and follow the [Browser guide](/browser).
59-
For a runnable Node script importing the built workspace SDK, follow
75+
For a runnable Node script using the published SDK, follow
6076
[Node.js](/node).
6177

6278
## Next step

‎docs/node.md‎

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@ Use the Meldbase client in Node.js when another server process needs to work
44
with a running Meldbase service. Node connects over HTTP and WebSocket; it does
55
not open a `.meld` file directly.
66

7-
The SDK is currently a workspace preview and is not yet published to npm. Its
8-
public package name will be `@meldbase/client`. The API below is available from
9-
the Meldbase workspace today.
7+
The `@meldbase/client` SDK is available on npm under the `beta` tag.
8+
See [SDK compatibility and release status](/sdk-status) before upgrading.
109

1110
## Start a local service
1211

@@ -21,19 +20,17 @@ network.
2120

2221
## Create a client
2322

24-
Node.js 20 or later is required. In another terminal, from the checkout root:
23+
Node.js 20 or later is required. In another terminal, in your application directory:
2524

2625
```sh
27-
pnpm install --frozen-lockfile
28-
pnpm --filter @meldbase/client build
26+
npm install @meldbase/client@beta ws
2927
```
3028

31-
Save this as `node-tour.mjs` in the checkout root. It uses the built workspace
32-
SDK and the workspace's WebSocket dependency:
29+
Save this as `node-tour.mjs` in your application directory:
3330

3431
```js
3532
import WebSocket from "ws";
36-
import { MeldbaseClient } from "./sdk/client/dist/index.js";
33+
import { MeldbaseClient } from "@meldbase/client";
3734

3835
const client = new MeldbaseClient({
3936
baseUrl: "http://127.0.0.1:8080",

‎docs/overview.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ the server. Distributed replication and a multi-node cluster are outside the
3939
current product scope.
4040

4141
The Go module and CLI releases are available today. The TypeScript SDKs are
42-
workspace previews targeting `0.1.0-beta.1`; npm publication is pending.
42+
published as `0.1.0-beta.1` on npm under the `beta` tag.
4343
See [SDK compatibility and release status](/sdk-status) for the reviewed public
4444
API boundary and release evidence.
4545

‎docs/sdk-beta-release.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ retag a different version as `beta`; those practices weaken the release receipt.
3333
## First publication
3434

3535
The `@meldbase` npm organization must exist, and the publishing account must
36-
have permission to create public packages within it. The three packages do not
37-
yet exist, so a trusted publisher cannot be assumed to be configured.
36+
have permission to create public packages within it. For a new package,
37+
a trusted publisher cannot be assumed to be configured before its first publication.
3838

3939
Use `prepare_only` to produce verified archives and a source-commit/integrity
4040
receipt as the `meldbase-sdk-beta` workflow artifact without publishing.

‎docs/sdk-status.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# SDK compatibility and release status
22

3-
The workspace targets TypeScript SDK `0.1.0-beta.1`. npm publication is pending;
4-
a version number in source is not proof that a package can be installed.
3+
TypeScript SDK `0.1.0-beta.1` is published on npm under the `beta` tag.
4+
Install the client with `npm install @meldbase/client@beta`.
55
The Go database remains alpha.
66

77
## Public application entry points
@@ -47,5 +47,5 @@ version change. Update mode is a maintainer action and is not run in CI.
4747

4848
The [beta checklist](/sdk-beta-checklist) describes the required validation.
4949
The [publishing guide](/sdk-beta-release) covers initial npm authentication and
50-
subsequent trusted publishing. Continue using the workspace quickstarts until
51-
registry publication is confirmed.
50+
subsequent trusted publishing. The [SDK beta release](https://github.com/crapthings/meldbase/releases/tag/sdk-v0.1.0-beta.1)
51+
includes verified archives and a source-commit/integrity receipt.

0 commit comments

Comments
 (0)