@spine-event-engine/proto-tools 2.0.0-snapshot.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +102 -0
- package/REFERENCE.md +80 -0
- package/bin/spine-proto.mjs +2 -0
- package/dist/src/cli/spine-proto-bootstrap.d.ts +4 -0
- package/dist/src/cli/spine-proto-bootstrap.d.ts.map +1 -0
- package/dist/src/cli/spine-proto-bootstrap.js +52 -0
- package/dist/src/cli/spine-proto-bootstrap.js.map +1 -0
- package/dist/src/cli/spine-proto.d.ts +3 -0
- package/dist/src/cli/spine-proto.d.ts.map +1 -0
- package/dist/src/cli/spine-proto.js +32 -0
- package/dist/src/cli/spine-proto.js.map +1 -0
- package/dist/src/generation/authored-interface-provider.d.ts +28 -0
- package/dist/src/generation/authored-interface-provider.d.ts.map +1 -0
- package/dist/src/generation/authored-interface-provider.js +244 -0
- package/dist/src/generation/authored-interface-provider.js.map +1 -0
- package/dist/src/generation/generated-source-policy.d.ts +21 -0
- package/dist/src/generation/generated-source-policy.d.ts.map +1 -0
- package/dist/src/generation/generated-source-policy.js +126 -0
- package/dist/src/generation/generated-source-policy.js.map +1 -0
- package/dist/src/generation/generation-reuse.mjs +84 -0
- package/dist/src/generation/generator.d.ts +195 -0
- package/dist/src/generation/generator.d.ts.map +1 -0
- package/dist/src/generation/generator.js +566 -0
- package/dist/src/generation/generator.js.map +1 -0
- package/dist/src/generation/handler-generator.d.ts +7 -0
- package/dist/src/generation/handler-generator.d.ts.map +1 -0
- package/dist/src/generation/handler-generator.js +55 -0
- package/dist/src/generation/handler-generator.js.map +1 -0
- package/dist/src/generation/interface-generator.d.ts +21 -0
- package/dist/src/generation/interface-generator.d.ts.map +1 -0
- package/dist/src/generation/interface-generator.js +277 -0
- package/dist/src/generation/interface-generator.js.map +1 -0
- package/dist/src/generation/interface-provider.d.ts +30 -0
- package/dist/src/generation/interface-provider.d.ts.map +1 -0
- package/dist/src/generation/interface-provider.js +15 -0
- package/dist/src/generation/interface-provider.js.map +1 -0
- package/dist/src/generation/rejection-generator.d.ts +9 -0
- package/dist/src/generation/rejection-generator.d.ts.map +1 -0
- package/dist/src/generation/rejection-generator.js +62 -0
- package/dist/src/generation/rejection-generator.js.map +1 -0
- package/dist/src/generation/source-view.d.ts +103 -0
- package/dist/src/generation/source-view.d.ts.map +1 -0
- package/dist/src/generation/source-view.js +298 -0
- package/dist/src/generation/source-view.js.map +1 -0
- package/dist/src/index.d.ts +139 -0
- package/dist/src/index.d.ts.map +1 -0
- package/dist/src/index.js +546 -0
- package/dist/src/index.js.map +1 -0
- package/dist/src/io/atomic-manifest.d.ts +32 -0
- package/dist/src/io/atomic-manifest.d.ts.map +1 -0
- package/dist/src/io/atomic-manifest.js +56 -0
- package/dist/src/io/atomic-manifest.js.map +1 -0
- package/dist/src/io/manifest-reader.d.ts +8 -0
- package/dist/src/io/manifest-reader.d.ts.map +1 -0
- package/dist/src/io/manifest-reader.js +19 -0
- package/dist/src/io/manifest-reader.js.map +1 -0
- package/dist/src/model/model-graph.d.ts +68 -0
- package/dist/src/model/model-graph.d.ts.map +1 -0
- package/dist/src/model/model-graph.js +220 -0
- package/dist/src/model/model-graph.js.map +1 -0
- package/dist/src/model/npm-package-name.d.ts +7 -0
- package/dist/src/model/npm-package-name.d.ts.map +1 -0
- package/dist/src/model/npm-package-name.js +33 -0
- package/dist/src/model/npm-package-name.js.map +1 -0
- package/dist/src/model/registry-dependency.d.ts +10 -0
- package/dist/src/model/registry-dependency.d.ts.map +1 -0
- package/dist/src/model/registry-dependency.js +66 -0
- package/dist/src/model/registry-dependency.js.map +1 -0
- package/dist/tsconfig.tsbuildinfo +1 -0
- package/package.json +51 -0
- package/scripts/clean-dist.mjs +7 -0
- package/scripts/copy-runtime-modules.mjs +23 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
# Protobuf tooling for Spine applications
|
|
2
|
+
|
|
3
|
+
This package generates TypeScript from application Proto models and
|
|
4
|
+
assembles those models into an application registry. Those models can define
|
|
5
|
+
commands, events, and state used by Aggregates or Projections. It runs at build
|
|
6
|
+
time, not inside a server process.
|
|
7
|
+
|
|
8
|
+
## Generate interface artifacts
|
|
9
|
+
|
|
10
|
+
`pnpm proto:generate` discovers `ts_type` options and emits model-local
|
|
11
|
+
`generated/interfaces/*.ts` artifacts. Generated `TaskEvent` is a complete
|
|
12
|
+
generated declaration; generated `TaskAssignmentEvent` binds the token to an
|
|
13
|
+
authored interface in the same model module. Do not edit output: rerun the
|
|
14
|
+
generator instead.
|
|
15
|
+
|
|
16
|
+
For detailed contracts intended for coding agents, see the
|
|
17
|
+
[REFERENCE.md documentation for agents](REFERENCE.md).
|
|
18
|
+
|
|
19
|
+
## 💡 Why use it?
|
|
20
|
+
|
|
21
|
+
- ✅ Generates Protobuf-ES code for application models.
|
|
22
|
+
- ✅ Creates one importable `ProtoModule` per model package.
|
|
23
|
+
- ✅ Follows dependencies between model packages deterministically.
|
|
24
|
+
- ✅ Generates typed rejection helpers and handler registries.
|
|
25
|
+
|
|
26
|
+
## 🚀 Create a model package
|
|
27
|
+
|
|
28
|
+
A model package contains canonical `.proto` files, generated code, and one exported
|
|
29
|
+
`ProtoModule`. Use separate model packages for independently developed bounded
|
|
30
|
+
contexts; a small application may use one combined model package.
|
|
31
|
+
|
|
32
|
+
```json
|
|
33
|
+
{
|
|
34
|
+
"formatVersion": 1,
|
|
35
|
+
"mode": "model",
|
|
36
|
+
"packageName": "@acme/tasks-model",
|
|
37
|
+
"protoRoot": "proto",
|
|
38
|
+
"generatedRoot": "generated",
|
|
39
|
+
"exportRoot": "generated",
|
|
40
|
+
"dependencies": ["@spine-event-engine/proto"],
|
|
41
|
+
"moduleExport": "tasksProtoModule"
|
|
42
|
+
}
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Run generation from that package directory:
|
|
46
|
+
|
|
47
|
+
```sh
|
|
48
|
+
spine-proto generate
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Generation creates the generated Protobuf-ES sources, a `proto-module.ts`,
|
|
52
|
+
typed rejection companions for rejection Proto files in the package, and a deterministic
|
|
53
|
+
`spine-proto-manifest.json`. Do not edit generated output by hand.
|
|
54
|
+
|
|
55
|
+
## 🧩 Compose an application
|
|
56
|
+
|
|
57
|
+
An application lists its direct model packages and a source location for the
|
|
58
|
+
generated registry.
|
|
59
|
+
|
|
60
|
+
```json
|
|
61
|
+
{
|
|
62
|
+
"formatVersion": 1,
|
|
63
|
+
"mode": "application",
|
|
64
|
+
"modelPackages": ["@acme/tasks-model"],
|
|
65
|
+
"registryOutput": "src/model-registry.ts"
|
|
66
|
+
}
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
```sh
|
|
70
|
+
spine-proto compose
|
|
71
|
+
spine-proto handlers
|
|
72
|
+
tsc -b
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
`compose` follows declared model dependencies transitively. `handlers` creates
|
|
76
|
+
the generated handler registry for decorated application classes. Run both after
|
|
77
|
+
the related model or handler changes.
|
|
78
|
+
|
|
79
|
+
The public CLI is `spine-proto`. Its programmatic config and manifest readers
|
|
80
|
+
are for tooling that needs the same validated package contracts; application
|
|
81
|
+
code should import generated model modules instead.
|
|
82
|
+
|
|
83
|
+
```ts
|
|
84
|
+
// docs-snippet-path: packages/proto-tools/src/index.ts
|
|
85
|
+
import { ProtoConfig } from "@spine-event-engine/proto-tools";
|
|
86
|
+
|
|
87
|
+
const config = ProtoConfig.read(".");
|
|
88
|
+
void config;
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
## ⚠️ Build-time only
|
|
92
|
+
|
|
93
|
+
Run this tooling after changing Proto files or decorated handlers. Generated
|
|
94
|
+
files are outputs, not source: never edit them by hand. Application runtime code
|
|
95
|
+
imports the generated model module and registry; it does not invoke the CLI.
|
|
96
|
+
|
|
97
|
+
## 🔗 Learn more
|
|
98
|
+
|
|
99
|
+
- [Spine Protobuf package](../proto/README.md)
|
|
100
|
+
- [Core message tools](../core/README.md)
|
|
101
|
+
- [Message Board model example](../../examples/message-board/model/README.md)
|
|
102
|
+
- [Reference for coding agents](REFERENCE.md)
|
package/REFERENCE.md
ADDED
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
# @spine-event-engine/proto-tools reference
|
|
2
|
+
|
|
3
|
+
This reference describes the public build-time Proto tooling for coding agents.
|
|
4
|
+
|
|
5
|
+
## Interface discovery and provenance
|
|
6
|
+
|
|
7
|
+
The compiler resolves authored `is.ts_type` interfaces against the owning model
|
|
8
|
+
module after realpath resolution. Only the requested authored interface must be
|
|
9
|
+
a top-level named export. Its recursive `extends` parents must resolve to
|
|
10
|
+
interfaces in the same model module, but need not be top-level named exports;
|
|
11
|
+
property types may be external. Missing, unnamed, misplaced, or incompatible
|
|
12
|
+
declarations are rejected. Each generated output records source provenance and
|
|
13
|
+
intentionally omits copyright headers; authored sources retain their copyright.
|
|
14
|
+
Generation is deterministic through `pnpm proto:generate`.
|
|
15
|
+
|
|
16
|
+
## CLI
|
|
17
|
+
|
|
18
|
+
The `spine-proto` binary is the primary public API. Run it from the package
|
|
19
|
+
whose `spine-proto.json` it should read:
|
|
20
|
+
|
|
21
|
+
- `spine-proto generate` accepts only model configuration and generates model
|
|
22
|
+
outputs and the manifest;
|
|
23
|
+
- `spine-proto compose` accepts only application configuration and writes the
|
|
24
|
+
configured model registry source;
|
|
25
|
+
- `spine-proto handlers` accepts an application package and writes
|
|
26
|
+
`generated/handler/generated-handler-registry.ts`.
|
|
27
|
+
|
|
28
|
+
The package also exposes `manifestFormatVersion`, `ProtoConfig`, and
|
|
29
|
+
`ProtoManifest` for build tooling that needs to read or validate the same
|
|
30
|
+
configuration and manifest contracts. Model configuration is format version 1;
|
|
31
|
+
generated manifests are format version 2 and carry a nonempty opaque
|
|
32
|
+
`generationId`. Each generated root has the matching internal generation
|
|
33
|
+
marker. Readers reject missing, malformed, or mismatched IDs rather than using
|
|
34
|
+
a version-one fallback. Generator, filesystem, parser, and handler-discovery
|
|
35
|
+
implementation modules are not public APIs.
|
|
36
|
+
|
|
37
|
+
## Model configuration and package layout
|
|
38
|
+
|
|
39
|
+
`ModelConfig` requires `formatVersion: 1`, `mode: "model"`, `packageName`,
|
|
40
|
+
`protoRoot`, `generatedRoot`, `exportRoot`, direct model `dependencies`, and
|
|
41
|
+
`moduleExport`. Canonical Proto files live under `protoRoot`; generated imports
|
|
42
|
+
and the module export live under `generatedRoot`. The package must publish its
|
|
43
|
+
compiled generated output, canonical `proto` sources, `spine-proto.json`, and
|
|
44
|
+
`spine-proto-manifest.json` with matching exports.
|
|
45
|
+
|
|
46
|
+
`generate` produces a deterministic manifest containing package identity and
|
|
47
|
+
version, sorted Proto files in the package, generated exports, direct
|
|
48
|
+
dependencies, the module export, and a generation ID. Byte-identical staged
|
|
49
|
+
output reuses its committed ID; changed output receives a new opaque ID. A model
|
|
50
|
+
with a top-level `*rejections.proto` also gets a
|
|
51
|
+
typed same-directory rejection companion. When such a companion is produced,
|
|
52
|
+
the model must directly depend on `@spine-event-engine/core`.
|
|
53
|
+
|
|
54
|
+
For a cross-model Proto import, declare the other model in both `package.json`
|
|
55
|
+
and `spine-proto.json`; import the other model's canonical package path. The
|
|
56
|
+
tool keeps package boundaries explicit and does not duplicate the dependency's source or
|
|
57
|
+
generated output.
|
|
58
|
+
|
|
59
|
+
## Application configuration
|
|
60
|
+
|
|
61
|
+
`ApplicationConfig` requires `formatVersion: 1`, `mode: "application"`, direct
|
|
62
|
+
`modelPackages`, and a safe source `registryOutput`. `compose` resolves direct
|
|
63
|
+
manifests transitively and writes one registry source. A direct model module is
|
|
64
|
+
sufficient because `TypeRegistry.from()` follows declared dependencies.
|
|
65
|
+
|
|
66
|
+
`handlers` must run after a decorated handler or its generated command, event,
|
|
67
|
+
or state types change. Compile the generated registry with the application.
|
|
68
|
+
|
|
69
|
+
## Safety and atomicity
|
|
70
|
+
|
|
71
|
+
All package-relative paths must remain inside the package and may not use unsafe
|
|
72
|
+
symlink ancestors. Generation rejects invalid configuration, unowned or
|
|
73
|
+
undeclared imports, absent manifest/proto exports, graph cycles, duplicate fully
|
|
74
|
+
qualified generated messages, and missing required dependencies. It stages
|
|
75
|
+
output and manifest replacement: validation or Buf failure preserves the prior
|
|
76
|
+
output and manifest. It installs generated trees and their markers before
|
|
77
|
+
publishing manifests, so the manifest is the commit point. If rollback cannot
|
|
78
|
+
restore prior state, journal-owned recovery evidence is retained and readers
|
|
79
|
+
fail closed until a later recovery succeeds. The CLI does not start services
|
|
80
|
+
and is not a runtime server dependency.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"spine-proto-bootstrap.d.ts","sourceRoot":"","sources":["../../../src/cli/spine-proto-bootstrap.ts"],"names":[],"mappings":";AAmBA,OAAO,sCAAsC,CAAC;AAC9C,OAAO,sCAAsC,CAAC"}
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
/*
|
|
3
|
+
* Copyright 2026, CodeMatters. All rights reserved.
|
|
4
|
+
*
|
|
5
|
+
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
|
|
6
|
+
* in compliance with the License. You may obtain a copy of the License at
|
|
7
|
+
*
|
|
8
|
+
* https://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
*
|
|
10
|
+
* Unless required by applicable law or agreed to in writing, software distributed under the License
|
|
11
|
+
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
|
|
12
|
+
* or implied. See the License for the specific language governing permissions and limitations under
|
|
13
|
+
* the License.
|
|
14
|
+
*/
|
|
15
|
+
import { resolve } from "node:path";
|
|
16
|
+
import { ProtoGeneration } from "../generation/generator.js";
|
|
17
|
+
import { assertViewRecordCurrent, readViewRecord } from "../generation/source-view.js";
|
|
18
|
+
import "../generation/interface-generator.js";
|
|
19
|
+
import "../generation/rejection-generator.js";
|
|
20
|
+
const root = resolve(process.cwd());
|
|
21
|
+
const command = process.argv[2] ?? "generate";
|
|
22
|
+
if (command === "generate") {
|
|
23
|
+
const livePackageRoot = internalOption("--live-package-root");
|
|
24
|
+
ProtoGeneration.generate(root, livePackageRoot === undefined ? {} : { livePackageRoot: resolve(livePackageRoot) });
|
|
25
|
+
}
|
|
26
|
+
else if (command === "compose") {
|
|
27
|
+
ProtoGeneration.compose(root);
|
|
28
|
+
}
|
|
29
|
+
else if (command === "verify-source-view-record") {
|
|
30
|
+
const livePackageRoot = requiredInternalOption("--live-package-root");
|
|
31
|
+
const liveGeneratedRoot = requiredInternalOption("--live-generated-root");
|
|
32
|
+
assertViewRecordCurrent(readViewRecord(root, resolve(livePackageRoot), resolve(liveGeneratedRoot)));
|
|
33
|
+
}
|
|
34
|
+
else {
|
|
35
|
+
throw new Error(`spine-proto bootstrap: unsupported command ${command}`);
|
|
36
|
+
}
|
|
37
|
+
function internalOption(name) {
|
|
38
|
+
const index = process.argv.indexOf(name);
|
|
39
|
+
if (index < 0)
|
|
40
|
+
return undefined;
|
|
41
|
+
const value = process.argv[index + 1];
|
|
42
|
+
if (value === undefined || process.argv.slice(index + 1).includes(name))
|
|
43
|
+
throw new Error(`spine-proto bootstrap: missing ${name}`);
|
|
44
|
+
return value;
|
|
45
|
+
}
|
|
46
|
+
function requiredInternalOption(name) {
|
|
47
|
+
const value = internalOption(name);
|
|
48
|
+
if (value === undefined)
|
|
49
|
+
throw new Error(`spine-proto bootstrap: missing ${name}`);
|
|
50
|
+
return value;
|
|
51
|
+
}
|
|
52
|
+
//# sourceMappingURL=spine-proto-bootstrap.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"spine-proto-bootstrap.js","sourceRoot":"","sources":["../../../src/cli/spine-proto-bootstrap.ts"],"names":[],"mappings":";AACA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,uBAAuB,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AACvF,OAAO,sCAAsC,CAAC;AAC9C,OAAO,sCAAsC,CAAC;AAE9C,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;AACpC,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC;AAC9C,IAAI,OAAO,KAAK,UAAU,EAAE,CAAC;IAC3B,MAAM,eAAe,GAAG,cAAc,CAAC,qBAAqB,CAAC,CAAC;IAC9D,eAAe,CAAC,QAAQ,CACtB,IAAI,EACJ,eAAe,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,OAAO,CAAC,eAAe,CAAC,EAAE,CACnF,CAAC;AACJ,CAAC;KAAM,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;IACjC,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAChC,CAAC;KAAM,IAAI,OAAO,KAAK,2BAA2B,EAAE,CAAC;IACnD,MAAM,eAAe,GAAG,sBAAsB,CAAC,qBAAqB,CAAC,CAAC;IACtE,MAAM,iBAAiB,GAAG,sBAAsB,CAAC,uBAAuB,CAAC,CAAC;IAC1E,uBAAuB,CACrB,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,eAAe,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAC3E,CAAC;AACJ,CAAC;KAAM,CAAC;IACN,MAAM,IAAI,KAAK,CAAC,8CAA8C,OAAO,EAAE,CAAC,CAAC;AAC3E,CAAC;AAED,SAAS,cAAc,CAAC,IAAY;IAClC,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACzC,IAAI,KAAK,GAAG,CAAC;QAAE,OAAO,SAAS,CAAC;IAChC,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;IACtC,IAAI,KAAK,KAAK,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;QACrE,MAAM,IAAI,KAAK,CAAC,kCAAkC,IAAI,EAAE,CAAC,CAAC;IAC5D,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,sBAAsB,CAAC,IAAY;IAC1C,MAAM,KAAK,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;IACnC,IAAI,KAAK,KAAK,SAAS;QAAE,MAAM,IAAI,KAAK,CAAC,kCAAkC,IAAI,EAAE,CAAC,CAAC;IACnF,OAAO,KAAK,CAAC;AACf,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"spine-proto.d.ts","sourceRoot":"","sources":["../../../src/cli/spine-proto.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
/*
|
|
3
|
+
* Copyright 2026, CodeMatters. All rights reserved.
|
|
4
|
+
*
|
|
5
|
+
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
|
|
6
|
+
* in compliance with the License. You may obtain a copy of the License at
|
|
7
|
+
*
|
|
8
|
+
* https://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
*
|
|
10
|
+
* Unless required by applicable law or agreed to in writing, software distributed under the License
|
|
11
|
+
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
|
|
12
|
+
* or implied. See the License for the specific language governing permissions and limitations under
|
|
13
|
+
* the License.
|
|
14
|
+
*/
|
|
15
|
+
import { resolve } from "node:path";
|
|
16
|
+
import { ProtoGeneration } from "../generation/generator.js";
|
|
17
|
+
import { HandlerGeneration } from "../generation/handler-generator.js";
|
|
18
|
+
const root = resolve(process.cwd());
|
|
19
|
+
const command = process.argv[2] ?? "generate";
|
|
20
|
+
if (command === "generate") {
|
|
21
|
+
ProtoGeneration.generate(root);
|
|
22
|
+
}
|
|
23
|
+
else if (command === "compose") {
|
|
24
|
+
ProtoGeneration.compose(root);
|
|
25
|
+
}
|
|
26
|
+
else if (command === "handlers") {
|
|
27
|
+
HandlerGeneration.generate(root);
|
|
28
|
+
}
|
|
29
|
+
else {
|
|
30
|
+
throw new Error(`spine-proto: unsupported command ${command}`);
|
|
31
|
+
}
|
|
32
|
+
//# sourceMappingURL=spine-proto.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"spine-proto.js","sourceRoot":"","sources":["../../../src/cli/spine-proto.ts"],"names":[],"mappings":";AACA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AAEvE,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;AACpC,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC;AAC9C,IAAI,OAAO,KAAK,UAAU,EAAE,CAAC;IAC3B,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AACjC,CAAC;KAAM,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;IACjC,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAChC,CAAC;KAAM,IAAI,OAAO,KAAK,UAAU,EAAE,CAAC;IAClC,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AACnC,CAAC;KAAM,CAAC;IACN,MAAM,IAAI,KAAK,CAAC,oCAAoC,OAAO,EAAE,CAAC,CAAC;AACjE,CAAC"}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import type { DescMessage } from "@bufbuild/protobuf";
|
|
2
|
+
import type { AuthoredInterfaceDeclaration, InterfaceDeclarationProvider } from "./interface-provider.js";
|
|
3
|
+
import type { ModelSourceView } from "./source-view.js";
|
|
4
|
+
/**
|
|
5
|
+
* Resolves authored TypeScript interfaces from the validated model source view.
|
|
6
|
+
*/
|
|
7
|
+
export declare class AuthoredInterfaceProvider implements InterfaceDeclarationProvider {
|
|
8
|
+
private readonly programs;
|
|
9
|
+
/**
|
|
10
|
+
* Resolves one compatible authored interface from the staged model Program.
|
|
11
|
+
*
|
|
12
|
+
* @param name Requested TypeScript interface identifier.
|
|
13
|
+
* @param members Generated messages that must satisfy the interface.
|
|
14
|
+
* @param sourceView Validated authored/staged compiler input.
|
|
15
|
+
* @returns The authored declaration import, or undefined without a source view.
|
|
16
|
+
*/
|
|
17
|
+
resolve(name: string, members: readonly DescMessage[], sourceView: ModelSourceView | undefined): AuthoredInterfaceDeclaration | undefined;
|
|
18
|
+
private program;
|
|
19
|
+
private stagedFiles;
|
|
20
|
+
private assertSourceView;
|
|
21
|
+
private declaration;
|
|
22
|
+
private nestedInterface;
|
|
23
|
+
private assertNamedModuleExport;
|
|
24
|
+
private messageType;
|
|
25
|
+
private assertLocalParents;
|
|
26
|
+
private importPath;
|
|
27
|
+
}
|
|
28
|
+
//# sourceMappingURL=authored-interface-provider.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"authored-interface-provider.d.ts","sourceRoot":"","sources":["../../../src/generation/authored-interface-provider.ts"],"names":[],"mappings":"AA0BA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAGtD,OAAO,KAAK,EACV,4BAA4B,EAC5B,4BAA4B,EAC7B,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAoBxD;;GAEG;AACH,qBAAa,yBAA0B,YAAW,4BAA4B;IAG5E,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA8C;IAIvE;;;;;;;OAOG;IACH,OAAO,CACL,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,SAAS,WAAW,EAAE,EAC/B,UAAU,EAAE,eAAe,GAAG,SAAS,GACtC,4BAA4B,GAAG,SAAS;IA+B3C,OAAO,CAAC,OAAO;IAmDf,OAAO,CAAC,WAAW;IAInB,OAAO,CAAC,gBAAgB;IAsCxB,OAAO,CAAC,WAAW;IAyCnB,OAAO,CAAC,eAAe;IAWvB,OAAO,CAAC,uBAAuB;IAe/B,OAAO,CAAC,WAAW;IAgCnB,OAAO,CAAC,kBAAkB;IA8C1B,OAAO,CAAC,UAAU;CAMnB"}
|