@spine-event-engine/client-web 2.0.0-snapshot.2 → 2.0.0-snapshot.5

package/README.md

@@ -7,9 +7,31 @@ in `@spine-event-engine/client-react`.
 For protocol, browser-session, reconnect, and security limits, read the
 [reference](REFERENCE.md).
 
-The [browser client and gateway guide](../../docs/BROWSER_CLIENT_AUTH_EXTENSION_GUIDE.md)
+The [browser client and gateway guide](https://github.com/SpineEventEngine/spine-ts/blob/main/docs/BROWSER_CLIENT_AUTH_EXTENSION_GUIDE.md)
 explains application sign-in and gateway composition.
 
+## Install and prepare an application
+
+This is an experimental snapshot. In a browser application with its generated
+Proto model already available, install every package imported by the browser
+examples explicitly:
+
+```sh
+pnpm add @bufbuild/protobuf@2.12.1 @spine-event-engine/core@snapshot @spine-event-engine/proto@snapshot @spine-event-engine/client-web@snapshot
+```
+
+Generate your application's model from its authored Proto sources with the
+[Proto tools guide](https://github.com/SpineEventEngine/spine-ts/tree/main/packages/proto-tools#readme), then import its published
+schemas from your own model package. The Message Board schema used below is a
+repository example of that application-owned output, not a package to install.
+
+Before the first request, provide an application Gateway endpoint that permits
+the browser origin, selects either gRPC-Web or binary Connect, and establishes
+the application's cookie or bearer session. The Gateway resolves credentials
+and authorizes requests; this package does not create it, sign users in, or
+provide a model package. See the [reference](REFERENCE.md) for the complete
+public contract.
+
 ## 💡 Why use it?
 
 - ✅ Uses browser-compatible gRPC-Web or Connect transports.
@@ -23,12 +45,13 @@ Choose the protocol deliberately. gRPC-Web is the portable browser choice.
 Connect is an optional binary optimization for a gateway already configured to
 accept it; the client does not probe or fall back between protocols.
 
+<!-- docs-snippet-path: examples/message-board/web/src/docs/client-web-create-client.ts -->
+
 ```ts
-// docs-snippet-path: examples/message-board/web/src/index.tsx
 import { BrowserSession, Client } from "@spine-event-engine/client-web";
 
 const session = BrowserSession.cookie({ maxRequestMs: 10_000 });
-const client = Client.forGrpcWeb("https://api.example.test", {
+const client = Client.forGrpcWeb("http://127.0.0.1:8080", {
   tenant: "tasks",
   credentials: session.credentials,
   onRequestMetadata: () => session.requestMetadata(),
@@ -38,16 +61,20 @@ await client.close();
 await session.close();
 ```
 
-The endpoint should be an application gateway. Applications provide sign-in,
-identity-provider redirects, session exchange, and authorization policy.
+Use `forGrpcWeb()` for a gRPC-Web Gateway. Use `forConnect()` only when that
+Gateway is separately configured for binary Connect (`application/proto`);
+neither factory probes or falls back to the other protocol. The endpoint above
+is illustrative: the local application must actually expose the chosen browser
+protocol and allow its origin.
 
 ## 📬 Post commands and send queries
 
 Use an actor or guest request scope. Commands return an application outcome;
 queries return the raw Spine response.
 
+<!-- docs-snippet-path: examples/message-board/web/src/docs/client-web-request-subscription.ts -->
+
 ```ts
-// docs-snippet-path: examples/message-board/web/src/index.tsx
 import { create } from "@bufbuild/protobuf";
 import { TypeUrls } from "@spine-event-engine/core";
 import { Client } from "@spine-event-engine/client-web";
@@ -61,7 +88,7 @@ import {
 } from "@spine-event-engine/proto/client";
 import { BoardMessageViewSchema } from "@spine-event-engine/example-message-board-model/generated/spine/examples/messageboard/message_board_pb.js";
 
-const client = Client.forGrpcWeb("https://api.example.test");
+const client = Client.forGrpcWeb("http://127.0.0.1:8080");
 const request = client.onBehalfOf("alice");
 const target = create(TargetSchema, {
   type: TypeUrls.derive(BoardMessageViewSchema),
@@ -109,7 +136,7 @@ may be duplicated, reordered, or missed while disconnected.
 
 ## 🔗 Learn more
 
-- [React adapter](../client-react/README.md)
-- [Authentication package](../auth/README.md)
-- [Browser authentication and extension guide](../../docs/BROWSER_CLIENT_AUTH_EXTENSION_GUIDE.md)
+- [React adapter](https://github.com/SpineEventEngine/spine-ts/blob/main/packages/client-react/README.md)
+- [Authentication package](https://github.com/SpineEventEngine/spine-ts/blob/main/packages/auth/README.md)
+- [Browser authentication and extension guide](https://github.com/SpineEventEngine/spine-ts/blob/main/docs/BROWSER_CLIENT_AUTH_EXTENSION_GUIDE.md)
 - [Detailed coding-agent reference](REFERENCE.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spine-event-engine/client-web",
-  "version": "2.0.0-snapshot.2",
+  "version": "2.0.0-snapshot.5",
   "license": "Apache-2.0",
   "type": "module",
   "repository": {
@@ -10,8 +10,7 @@
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
-    "access": "public",
-    "tag": "snapshot"
+    "access": "public"
   },
   "description": "Browser-safe Spine client transport kernel.",
   "exports": {
@@ -29,8 +28,8 @@
     "@bufbuild/protobuf": "2.12.1",
     "@connectrpc/connect": "2.1.2",
     "@connectrpc/connect-web": "2.1.2",
-    "@spine-event-engine/core": "2.0.0-snapshot.2",
-    "@spine-event-engine/proto": "2.0.0-snapshot.2"
+    "@spine-event-engine/core": "2.0.0-snapshot.5",
+    "@spine-event-engine/proto": "2.0.0-snapshot.5"
   },
   "scripts": {
     "check:dependencies": "node ../../scripts/check-client-web-dependencies.mjs"