@spine-event-engine/server 2.0.0-snapshot.11

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,209 @@
+# Spine application server for Node.js
+
+`@spine-event-engine/server` is the native Node.js runtime for a Spine bounded
+context. Use it to assemble contexts and expose native Connect/gRPC-compatible
+services. Browser hosting is deliberately a separate entry point.
+
+> **Experimental prerelease.** Install an exact snapshot while this API evolves:
+> Snapshot releases may remove earlier prerelease import paths.
+
+## Install and prerequisites
+
+```bash
+pnpm add @spine-event-engine/server@snapshot
+```
+
+Use Node.js in ESM mode. Before adding entities, generate your application
+model and handler registry with `@spine-event-engine/proto-tools`. The small
+example below has no entity handlers, so it is useful for proving that native
+assembly, listener startup, and cleanup work locally.
+
+## First native server
+
+Build one context, start a loopback listener on an ephemeral port, and close
+the returned running server. `start()` installs no signal handlers, which makes
+this shape appropriate for tests and hosts that manage shutdown themselves.
+
+<!-- docs-snippet-path: packages/server/test/server/server-environment.test.ts -->
+
+```ts
+import { BoundedContext, Server } from "@spine-event-engine/server";
+
+const context = BoundedContext.singleTenant("Tasks").build();
+const running = await new Server({ contexts: [context], port: 0 }).start();
+try {
+  // Native Command, Query, and Subscription services are now listening.
+} finally {
+  await running.close();
+}
+```
+
+Add generated entities with `BoundedContext.add(...)` and use
+`buildAsync()` when framework-generated repository discovery is needed. A
+context is single-tenant or multitenant by construction; select that mode
+before registering application handlers and storage.
+
+## Async handlers and Process Manager queries
+
+An `@Assign`, `@Command`, `@React`, or `@Subscribe` handler may return its
+usual result directly or through exactly one built-in `Promise<T>` layer. Its
+transaction remains open until that promise settles. Nested `Promise<Promise<T>>`
+results and structural or imported thenable lookalikes are rejected during handler
+analysis. Rejection rolls back framework state and suppresses produced output; it
+cannot roll back an external HTTP request or other side effect.
+
+Declare each domain rejection a command handler may throw. This registers the
+rejection before the server starts, so a client can subscribe even when no
+server handler consumes that rejection:
+
+<!-- docs-snippet-path: examples/todo/src/index.ts -->
+
+```ts
+import { Assign, Throws } from "@spine-event-engine/server";
+import type { CompleteTask } from "../generated/spine/examples/todo/task_commands_pb.js";
+import type { TaskCompleted } from "../generated/spine/examples/todo/task_events_pb.js";
+import { TaskAlreadyDone } from "../generated/spine/examples/todo/task_rejections.js";
+
+class TaskAssignee {
+  @Assign
+  @Throws(TaskAlreadyDone)
+  completeTask(command: CompleteTask): TaskCompleted {
+    throw TaskAlreadyDone.create({ id: command.id });
+  }
+}
+```
+
+Place the primary handler decorator first for readability. Reversing the two
+decorators has the same behavior.
+
+Process Managers, but not Aggregates, have protected read-only `select()` during a handler:
+
+```ts
+import { EntityQuery, type EntityColumn } from "@spine-event-engine/core";
+import { ProcessManager } from "@spine-event-engine/server";
+
+type RequestView = import("@bufbuild/protobuf").Message<"RequestView"> & {
+  id: string;
+  status: string;
+  createdAt: number;
+};
+declare const RequestViewSchema: import("@bufbuild/protobuf/codegenv2").GenMessage<RequestView>;
+declare const RequestViewColumns: {
+  readonly status: EntityColumn<typeof RequestViewSchema, "status", string, "equal">;
+  readonly createdAt: EntityColumn<
+    typeof RequestViewSchema,
+    "createdAt",
+    number,
+    "equal" | "greaterThan"
+  >;
+};
+abstract class RequestCoordinator extends ProcessManager<string, typeof RequestViewSchema> {
+  protected async handleRequest(requestId: string): Promise<void> {
+    const pending = await this.select(RequestViewSchema, RequestViewColumns)
+      .where(EntityQuery.eq(RequestViewColumns.status, "pending"))
+      .orderBy(RequestViewColumns.createdAt, "asc")
+      .limit(10)
+      .read();
+    const one = await this.select(RequestViewSchema, RequestViewColumns).findById(requestId);
+    void [pending, one];
+  }
+}
+```
+
+These reads are eventually consistent. `limit()` may not exceed 1,000, and
+`all()` can be expensive for a large Projection; prefer a targeted, ordered,
+bounded query. Queries inherit the active handler's actor and tenant; there is
+no tenant override.
+
+Use `EntityQuery.all(...)` when every predicate must match and
+`EntityQuery.either(...)` when any branch may match.
+
+## Native lifecycle and routing
+
+`Server.run()` is the standalone process form: it handles `SIGINT`/`SIGTERM`
+cleanup. `Server.start()` returns a `RunningServer` for an embedding host to
+close. `ManagedServerApplication` is the Node-only complete-replica entrypoint;
+it does not infer process or Delivery-shard counts.
+
+Routes are declared by generated message schema or interface token. Exact
+schema routes take precedence. Query results from `Stand` are authoritative;
+subscriptions are live, best-effort notifications, so clients re-query after a
+reconnect or a possible gap. Configure a storage provider for durable
+application state and generated repository assembly; in-memory choices are
+for local development and tests.
+
+## Entity identifiers
+
+An Entity ID can be a primitive value or a complete generated Protobuf message.
+For a message-valued ID, the Entity state message declares that ID message as
+its first field. Every field declared by the ID message, including nested
+messages, is part of the identity.
+
+```proto
+message WorkItemId {
+  spine.core.UserId owner = 1;
+  int32 sequence = 2;
+}
+
+message WorkItem {
+  WorkItemId id = 1;
+  string title = 2;
+}
+```
+
+Generated messages can have any declared identifier fields. For example,
+`CommandId` is a generated message ID:
+
+```ts
+import { create } from "@bufbuild/protobuf";
+import { type MessageId } from "@spine-event-engine/server";
+import { CommandIdSchema } from "@spine-event-engine/proto";
+
+const id = create(CommandIdSchema, { uuid: "task-42" });
+const entityId: MessageId = id;
+```
+
+At routing, the generated ID is checked against the state field's declared
+schema and its generated validation rules before durable use. When default
+routing finds a message but the Entity ID type is primitive, define a custom
+route that returns the intended primitive ID.
+
+Without a custom route, Command routing uses the Command's declared first
+field. Event routing uses a compatible producer ID when available and otherwise
+uses the Event's declared first field. State-update routing selects the first
+state field compatible with the Entity ID.
+
+## Browser gateway migration
+
+The server root has no browser options and does not load auth. To host a
+browser-facing Gateway, install the optional auth peer and import the browser
+entry point explicitly:
+
+```bash
+pnpm add @spine-event-engine/server@snapshot @spine-event-engine/auth@snapshot
+```
+
+```ts
+import { BrowserServer, DurableSubscriptionBindings } from "@spine-event-engine/server/browser";
+```
+
+`BrowserServer.open(...)` composes a browser listener around a caller-managed
+native server; `BrowserServer.run(...)` starts and manages a standalone or
+combined browser host. Supply exact allowed origins, a session or intentional
+public admission, authorization and trusted-context resolvers, finite limits,
+and backend forwarding. Authenticated durable bindings are browser-host
+infrastructure, not native `Server` state. See the [browser/auth extension guide](https://github.com/SpineEventEngine/spine-ts/blob/master/docs/BROWSER_CLIENT_AUTH_EXTENSION_GUIDE.md)
+before exposing a backend to a browser.
+
+## Limits
+
+This package does not create an identity provider, browser session store,
+authorization policy, TLS configuration, or deployment topology. It does not
+guarantee replay, gap repair, exactly-once subscription effects, or
+cluster-complete notification delivery.
+
+## Next steps
+
+- [Detailed coding-agent reference](REFERENCE.md)
+- [Authentication gateway](https://github.com/SpineEventEngine/spine-ts/blob/master/packages/auth/README.md)
+- [Message Board application](https://github.com/SpineEventEngine/spine-ts/blob/master/examples/message-board/app/README.md)