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

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,115 @@
+# Spine client for web browsers
+
+Use this browser-safe package to post commands, send queries, and create Spine
+subscriptions for query-side views. It is framework-neutral: React support is
+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)
+explains application sign-in and gateway composition.
+
+## 💡 Why use it?
+
+- ✅ Uses browser-compatible gRPC-Web or Connect transports.
+- ✅ Posts commands and sends entity queries without a UI-framework dependency.
+- ✅ Creates subscriptions with explicit activation and cancellation.
+- ✅ Supports cookie or bearer session metadata supplied by the application.
+
+## 🚀 Create a browser client
+
+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.
+
+```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", {
+  tenant: "tasks",
+  credentials: session.credentials,
+  onRequestMetadata: () => session.requestMetadata(),
+});
+
+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.
+
+## 📬 Post commands and send queries
+
+Use an actor or guest request scope. Commands return an application outcome;
+queries return the raw Spine response.
+
+```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";
+import { ActorContextSchema } from "@spine-event-engine/proto";
+import {
+  QueryIdSchema,
+  QuerySchema,
+  TargetSchema,
+  TopicIdSchema,
+  TopicSchema,
+} 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 request = client.onBehalfOf("alice");
+const target = create(TargetSchema, {
+  type: TypeUrls.derive(BoardMessageViewSchema),
+  criterion: { case: "includeAll", value: true },
+});
+const query = create(QuerySchema, { id: create(QueryIdSchema, { value: "messages" }), target });
+const topic = create(TopicSchema, {
+  id: create(TopicIdSchema, { value: "messages" }),
+  target,
+  context: create(ActorContextSchema, { actor: { value: "alice" } }),
+});
+const response = await request.send(query);
+const subscription = await request.createSubscription(topic, {
+  kind: "entity",
+  authoritativeQuery: () => query,
+});
+await subscription.activate();
+await subscription.cancel();
+console.log(response.message.length);
+await client.close();
+```
+
+Commands are not retried. Pass an `AbortSignal` when application code needs to
+cancel an admitted call.
+
+Command validation belongs to the server. The browser client serializes the
+submitted Proto value without enforcing its validation options locally, then
+returns the server's `error` outcome. This lets a form display the same
+validation messages as every other client instead of maintaining browser-only
+rules.
+
+## 🔄 Handle reconnects
+
+Subscriptions are useful notifications, not complete history. After an Entity
+reconnect, provide `authoritativeQuery` so the client can re-read current
+state. Event subscriptions report that a gap may have occurred; they do not
+replay missing events.
+
+## ⚠️ Security and delivery limits
+
+Connect the browser to an authenticated gateway, never directly to a trusted
+backend. This package does not implement sign-in, choose an identity provider,
+or store durable sessions. Commands are not retried, and subscription updates
+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)
+- [Detailed coding-agent reference](REFERENCE.md)

package/REFERENCE.md

@@ -0,0 +1,32 @@
+# @spine-event-engine/client-web reference
+
+This reference records the exact public contract of `@spine-event-engine/client-web`.
+Start with the [browser client overview](README.md) for a first connection.
+
+## Transports and request scopes
+
+`Client.forGrpcWeb(baseUrl, options)` always uses gRPC-Web. `Client.forConnect` always uses binary Connect (`application/proto`). Connect is optional only when the selected gateway already supports it; neither factory probes or falls back to the other protocol. `Client.usingTransport(source, options)` accepts an application or platform `ClientTransport`, including a request-ID factory and optional close hook.
+
+`ClientOptions` select tenant, zone, bounded subscription settings, and an optional `onReauthenticateBeforeReconnect` callback. `BrowserClientOptions` also accept per-call synchronous metadata and Fetch credential mode. The application supplies metadata; the client does not log it. `asGuest()` and `onBehalfOf(user)` return immutable request scopes. An empty actor is rejected.
+
+`post(schema, value, options)` returns `ClientOutcome`: `ok`, `error` with an application error message, or `rejection` with a rejection message. Command-envelope packing deliberately skips client-side Proto validation so the authoritative server can return its configured validation details. Commands are never retried. `send(query, options)` returns the raw validated `QueryResponse`. Caller cancellation and `client.close()` abort admitted work; transport, deadline, and wire-contract failures remain errors.
+
+## Browser sessions
+
+`BrowserSession.cookie(options)` uses browser-managed cookies with Fetch credentials `include`; cookie values never enter JavaScript metadata. `BrowserSession.bearer({ token, ...options })` holds one bearer value only in memory with Fetch credentials `omit`. `replaceBearer` and `clearBearer` alter that memory value. Neither mode uses browser storage.
+
+`session.fetch()` applies credentials and a finite deadline. Its default is ten seconds and the maximum is one minute. `reauthenticate()` asks an application-supplied callback for informational actor, tenant, and expiry facts; they are not credentials. `close()` aborts session work and clears bearer and informational context. Provider redirect, token exchange, storage policy, and authorization are application responsibilities.
+
+## Subscriptions
+
+`createSubscription(topic, options)` returns an inactive handle. `activate()` performs Subscribe; `cancel()` is terminal, ends local iteration, and performs at most one bounded remote Cancel per accepted wire. `updates` and `lifecycle` are independent single-consumer async streams with no cross-stream ordering guarantee. `client.close()` terminally closes every subscription it created.
+
+For Entity subscriptions, `authoritativeQuery` is evaluated only after reconnect. Its target must be byte-equivalent to the Topic target. The returned query response is delivered as `resynchronization` before held updates. For event subscriptions, reconnection reports `gapPossible`; events can be missing, duplicated, or differently ordered, and no replay, completeness, or cluster-complete guarantee is made.
+
+The defaults are 64 queued updates, 1,048,576 queued update bytes, 32 lifecycle notices, five retry attempts, and 30,000 milliseconds of elapsed recovery. Every capacity, retry value, scheduler value, and custom delay is a positive safe integer. The default retry delay starts at 250 milliseconds with bounded jitter, caps at 5,000 milliseconds, and never falls below one millisecond. A stream connected for at least the configured elapsed-recovery window starts a fresh finite retry episode when it later fails; rapid failures remain in one episode and exhaust its limits. Overflow is terminal and never silently drops an update. `connecting`, `connected`, `resynchronizing`, `gapPossible`, `failed`, and `closed` lifecycle notices describe that local subscription state.
+
+## Errors and extension
+
+`ClientProtocolError` identifies an invalid response under the public wire contract. Browser Web Crypto must be available for browser request identifiers; otherwise a request fails before transport work. An injected transport closes only when it supplies `close()`.
+
+Use the [browser client and gateway guide](../../docs/BROWSER_CLIENT_AUTH_EXTENSION_GUIDE.md) for gateway, Envoy, authentication extension, and deployment guidance. The guide is customizable guidance, not an enforced policy.

package/dist/client/browser-session.d.ts

@@ -0,0 +1,113 @@
+/**
+ * Informational session facts returned by an application gateway; never credentials.
+ */
+export interface BrowserSessionContext {
+    /**
+     * Holds the resolved actor identifier.
+     */
+    readonly actor?: string;
+    /**
+     * Holds the resolved tenant identifier.
+     */
+    readonly tenant?: string;
+    /**
+     * Holds the session expiry time.
+     */
+    readonly expiresAt?: Date;
+}
+/**
+ * Resolves finite, abortable application-owned reauthentication context.
+ * @param request Supplies the cancellation signal for reauthentication.
+ * @returns Resolves to the latest informational context, if available.
+ */
+export type OnBrowserSessionContext = (request: Readonly<{
+    signal: AbortSignal;
+}>) => Promise<BrowserSessionContext | undefined>;
+/**
+ * Shared bounded HTTP configuration for an application-owned browser session.
+ */
+export interface BrowserSessionOptions {
+    /**
+     * Supplies the browser-compatible fetch implementation.
+     */
+    readonly fetch?: typeof globalThis.fetch;
+    /**
+     * A positive request deadline in milliseconds, capped at one minute.
+     */
+    readonly maxRequestMs?: number;
+}
+/**
+ * Construction options for an in-memory bearer session.
+ */
+export interface BearerBrowserSessionOptions extends BrowserSessionOptions {
+    /**
+     * Supplies the memory-only bearer token.
+     */
+    readonly token: string;
+}
+/**
+ * Browser-managed cookie or memory-only bearer session resource.
+ */
+export declare class BrowserSession {
+    #private;
+    private constructor();
+    /**
+     * Gets the browser Fetch credential mode selected by this immutable session.
+     * @returns Returns the selected credential mode.
+     */
+    get credentials(): "include" | "omit";
+    /**
+     * Creates a browser-managed cookie session. Cookies never enter JavaScript metadata.
+     * @param options Configures fetch and the request deadline.
+     * @returns Returns the new cookie session.
+     */
+    static cookie(options?: BrowserSessionOptions): BrowserSession;
+    /**
+     * Creates a memory-only bearer session. The token is never persisted by this resource.
+     * @param options Supplies the bearer token and session configuration.
+     * @returns Returns the new bearer session.
+     */
+    static bearer(options: BearerBrowserSessionOptions): BrowserSession;
+    /**
+     * Gets the latest application gateway facts, which are informational and never credentials.
+     * @returns Returns a copied context, if one is available.
+     */
+    get context(): BrowserSessionContext | undefined;
+    /**
+     * Creates metadata for one request without exposing cookie values.
+     * @returns Returns the request metadata.
+     */
+    requestMetadata(): Headers;
+    /**
+     * Updates the memory-only bearer value.
+     * @param token Supplies the new bearer token.
+     */
+    replaceBearer(token: string): void;
+    /**
+     * Removes the memory-only bearer value. Cookie sessions remain browser-managed.
+     */
+    clearBearer(): void;
+    /**
+     * Executes an application-owned HTTP request with session transport behavior and
+     * a finite deadline. It does not implement a provider sign-in flow.
+     * @param input Supplies the request URL or request object.
+     * @param init Supplies optional request initialization.
+     * @returns Resolves to the HTTP response.
+     */
+    fetch(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
+    /**
+     * Updates informational context before a reconnect without treating it as credentials.
+     * @param onContext Resolves the latest application context.
+     * @param options Supplies optional cancellation.
+     * @returns Completes after the latest context is retained.
+     */
+    reauthenticate(onContext: OnBrowserSessionContext, options?: Readonly<{
+        signal?: AbortSignal;
+    }>): Promise<void>;
+    /**
+     * Closes session-owned HTTP or reauthentication work and clears memory-only credentials.
+     * @returns Completes after cancellation is requested.
+     */
+    close(): Promise<void>;
+}
+//# sourceMappingURL=browser-session.d.ts.map

package/dist/client/browser-session.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser-session.d.ts","sourceRoot":"","sources":["../../src/client/browser-session.ts"],"names":[],"mappings":"AAcA;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAGpC;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG,CACpC,OAAO,EAAE,QAAQ,CAAC;IAAE,MAAM,EAAE,WAAW,CAAA;CAAE,CAAC,KACvC,OAAO,CAAC,qBAAqB,GAAG,SAAS,CAAC,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAGpC;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAC;IAEzC;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,qBAAqB;IAGxE;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,qBAAa,cAAc;;IAUzB,OAAO;IAaP;;;OAGG;IACH,IAAI,WAAW,IAAI,SAAS,GAAG,MAAM,CAEpC;IAED;;;;OAIG;IACH,MAAM,CAAC,MAAM,CAAC,OAAO,GAAE,qBAA0B,GAAG,cAAc;IAIlE;;;;OAIG;IACH,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,2BAA2B,GAAG,cAAc;IAInE;;;OAGG;IACH,IAAI,OAAO,IAAI,qBAAqB,GAAG,SAAS,CAI/C;IAED;;;OAGG;IACH,eAAe,IAAI,OAAO;IAM1B;;;OAGG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAOlC;;OAEG;IACH,WAAW,IAAI,IAAI;IAInB;;;;;;OAMG;IACG,KAAK,CAAC,KAAK,EAAE,WAAW,GAAG,GAAG,EAAE,IAAI,GAAE,WAAgB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAmBhF;;;;;OAKG;IACG,cAAc,CAClB,SAAS,EAAE,uBAAuB,EAClC,OAAO,GAAE,QAAQ,CAAC;QAAE,MAAM,CAAC,EAAE,WAAW,CAAA;KAAE,CAAM,GAC/C,OAAO,CAAC,IAAI,CAAC;IAShB;;;OAGG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAgDvB"}