@spine-event-engine/core 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,151 @@
+# Core Protobuf tools for Spine TS
+
+`@spine-event-engine/core` provides the small Protobuf utilities shared by a
+Spine TS application. Use it when application code needs to validate a message,
+pack it into `google.protobuf.Any`, create a command or event envelope, or look
+up a generated message schema by its Spine type URL.
+
+## Message-interface tokens
+
+A generated interface export has one name in two TypeScript namespaces: use it
+as a type for message shape and as a value token in a repository `.route(...)`
+call. The To-Do `TaskEvent` token groups task events; its authored
+`TaskAssignmentEvent` counterpart groups assignment events. Start with the
+[To-Do walkthrough](../../examples/todo/USER_GUIDE.md) for the complete path.
+
+For the detailed contract and integration notes, see
+[REFERENCE documentation for agents](REFERENCE.md).
+
+## 💡 Why use it?
+
+- ✅ Reads validation rules directly from generated Protobuf schemas.
+- ✅ Packs and unpacks `google.protobuf.Any` with Spine type URLs.
+- ✅ Builds registries that understand framework and application messages.
+- ✅ Creates the common envelopes used by commands, events, and rejections.
+
+## 🚀 Build it in this workspace
+
+```sh
+pnpm typecheck:build
+```
+
+Run this workspace-wide TypeScript build from the repository root. For an
+experimental npm consumer, install
+`@spine-event-engine/core@2.0.0-snapshot.2` or the explicit
+`@spine-event-engine/core@snapshot` tag.
+
+## ✅ Validate a message
+
+Use `Validate.check()` when an invalid message should stop the current
+operation. It reads the validation options from the generated schema and throws
+`ValidationException` if a constraint is violated.
+
+```ts
+import { create } from "@bufbuild/protobuf";
+import { Validate } from "@spine-event-engine/core";
+import { UserIdSchema } from "@spine-event-engine/proto";
+
+const userId = create(UserIdSchema, { value: "ava" });
+Validate.check(UserIdSchema, userId);
+```
+
+Use `Validate.message()` when the caller needs the returned violations instead
+of an exception.
+
+## 📦 Pack and unpack a message
+
+`AnyMessages.pack()` derives the type URL from the schema's Protobuf file and
+validates the message by default. `unpack()` returns `undefined` when the URL
+or payload does not match the requested schema.
+
+```ts
+import { create } from "@bufbuild/protobuf";
+import { AnyMessages } from "@spine-event-engine/core";
+import { UserIdSchema } from "@spine-event-engine/proto";
+
+const userId = create(UserIdSchema, { value: "ava" });
+const packed = AnyMessages.pack(UserIdSchema, userId);
+const unpacked = AnyMessages.unpack(packed, UserIdSchema);
+```
+
+Only pass `{ validate: false }` for data a trusted caller has already
+validated.
+
+## 🗂️ Build a schema registry
+
+Applications normally give model modules to the server, which creates a
+registry. A standalone integration can create a registry directly.
+
+```ts
+import { TypeRegistry } from "@spine-event-engine/core";
+import { UserIdSchema } from "@spine-event-engine/proto";
+
+const registry = new TypeRegistry([UserIdSchema]);
+const user = registry.getByFullName("spine.core.UserId");
+console.log(user.typeUrl);
+```
+
+`spineCoreRegistry` is a read-only registry of the Spine schemas supplied by
+`@spine-event-engine/proto`. Use `TypeRegistry.spineCore()` if registrations
+must be added.
+
+## 🔤 Turn message IDs into storage values
+
+Storage providers cannot put a JavaScript message object directly into a
+database key or query parameter. `Identifiers` packs supported primitive and
+generated-message IDs into Spine's typed `Any` form. `Stringifiers` then gives
+a generated message one reversible text representation. The default is compact
+Proto JSON:
+
+```ts
+import { create } from "@bufbuild/protobuf";
+import { Stringifiers } from "@spine-event-engine/core";
+import { UserIdSchema } from "@spine-event-engine/proto";
+
+const id = create(UserIdSchema, { value: "ava" });
+const mapping = Stringifiers.forMessage(UserIdSchema);
+const stored = mapping.toString(id); // {"value":"ava"}
+const restored = mapping.fromString(stored);
+```
+
+MySQL and Datastore use the same mapping when they write an ID or `(column)`
+value and when they later build a Query operand. This symmetry is what makes
+`board == BoardId("general")` find a row whose `board` column was written from
+that generated `BoardId`. An application can register another reversible
+mapping in `StringifierRegistry`. If compact Proto JSON encounters an `Any`,
+also call `setTypeRegistry()` with the application's generated `TypeRegistry`.
+
+## 🚫 Throw a generated domain rejection
+
+The model generator creates typed rejection factories for top-level messages in
+an application's `*rejections.proto` files. Application code imports that
+generated companion and throws its factory result. This example is from a
+source file in the Todo model package's `src` directory.
+
+```ts
+// docs-snippet-path: examples/todo/src/index.ts
+import { create } from "@bufbuild/protobuf";
+import { TaskIdSchema } from "../generated/spine/examples/todo/task_id_pb.js";
+import { TaskAlreadyDone } from "../generated/spine/examples/todo/task_rejections.js";
+
+const id = create(TaskIdSchema, { value: "task-42" });
+throw TaskAlreadyDone.create({ id });
+```
+
+The generated factory validates the rejection message and returns a
+`RejectionThrowable`. The server package decides how a rejection is handled or
+published.
+
+## ⚠️ Keep framework behavior in framework packages
+
+Core provides message-level building blocks. It does not run bounded contexts,
+store entities, or send requests. Most applications use these helpers through
+the server, clients, and generated model code rather than assembling envelopes
+by hand.
+
+## 🔗 Learn more
+
+- [Protobuf package](../proto/README.md)
+- [Model-generation tools](../proto-tools/README.md)
+- [Server](../server/README.md)
+- [Reference for coding agents](REFERENCE.md)

package/REFERENCE.md

@@ -0,0 +1,85 @@
+# @spine-event-engine/core reference
+
+This reference is for agents integrating the public core package.
+
+## Message interfaces
+
+`MessageInterfaces.define()` creates the nominal runtime token corresponding to
+a structural TypeScript interface and its member schemas. A route accepts that token
+as well as an exact schema. Tokens are checked at declaration time; matching is
+ordered after exact schemas and before replacement/default routing. They are not
+transport semantic tags.
+
+## Public entry point
+
+Import from `@spine-event-engine/core`. The package exports `Validate`,
+`ValidationException`, `RejectionThrowable`, `AnyMessages`, `SignalEnvelopes`,
+`TypeUrls`, `TypeRegistry`, `spineCoreRegistry`, `Identifiers`, `Stringifiers`,
+`StringifierRegistry`, the `Stringifier` contract, and their exported input,
+result, and metadata types.
+
+## Storage value helpers
+
+`Identifiers` packs and unpacks the generated-message and supported primitive
+identifier kinds used by storage contracts. `Stringifiers.forMessage()` maps a
+generated message reversibly to compact Proto JSON by default.
+`StringifierRegistry` lets an application register another reversible mapping
+for a particular message schema. Providers snapshot the registry they accept;
+use the same mapping for stored IDs or columns and their query operands.
+Call `setTypeRegistry(applicationTypes)` before provider construction when
+default Proto JSON may encounter `Any`. The generated type registry supplies
+the descriptor needed to expand and restore the packed application message;
+without it, an `Any` cannot be converted to interoperable Proto JSON.
+
+## Validation
+
+`Validate.message(schema, message)` returns a `MessageValidationResult` whose
+`valid` discriminator controls access to either an empty violation list or a
+non-empty list and a `ValidationError`. It sanitizes validation details and
+turns a validation-runtime failure into a structured invalid result.
+
+`Validate.check(schema, message)` returns the supplied message when valid and
+throws `ValidationException` otherwise. `ValidationException.asMessage()`
+returns the structured validation message. `Validate.transition(request,
+rules)` applies only the supplied state-transition rules; it does not perform
+single-message validation. A throwing transition rule contributes a sanitized
+violation and does not stop later rules.
+
+## Rejections
+
+`RejectionThrowable.create(schema, input)` is the public factory used by the
+generated rejection companion. It validates the input and snapshots it.
+`schema`, `messageData`, and `messageThrown()` expose the schema or defensive
+message clones. Rejection throwables are ordinary `Error` values; they do not
+route, persist, or publish themselves.
+
+## Any and envelopes
+
+`TypeUrls.derive(schema)` uses the file's `type_url_prefix` option, or
+`type.googleapis.com` when no prefix is present. A fallback prefix must be
+non-empty and whitespace-free. `AnyMessages.pack()` validates unless
+`validate: false` is given, serializes without unknown fields, and returns a
+Spine-aware `Any`. `unpack()` and `unpackUsing()` return `undefined` for an
+unknown/mismatched URL or malformed bytes.
+
+`SignalEnvelopes.command()` and `.event()` clone caller-supplied IDs and
+contexts and pack the supplied domain message. They do not create IDs,
+timestamps, actor context, tenant context, storage records, or routing data.
+
+## Registry
+
+`TypeRegistry` maintains registrations by full Protobuf name, type URL, and
+schema identity. Duplicate full names, URLs, or conflicting schema identities
+throw during `register()`. `getBy*()` throws for a missing registration;
+`findBy*()` returns `undefined`; `list()` preserves registration order.
+`TypeRegistry.from(...modules)` composes `ProtoModule` dependencies in
+dependency order. `spineCoreRegistry` is lookup-only; callers needing a mutable
+copy use `TypeRegistry.spineCore()`. Copied Proto `(is)` and `(every_is)` options
+are wire metadata, not TypeRegistry data or repository-routing/runtime-topic
+input.
+
+## Boundaries
+
+This package has no buses, repository lifecycle, storage implementation,
+handlers, decorators, transport, or authentication policy. Those belong to
+other Spine TS packages.