@melite/engine-contract 0.0.0-stage → 0.1.5-pre-alpha
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 +557 -0
- package/README.md +54 -2
- package/lib/engines.d.ts +43 -0
- package/lib/engines.js +94 -0
- package/lib/index.d.ts +5 -0
- package/lib/index.js +3 -0
- package/lib/types.d.ts +83 -0
- package/lib/types.js +8 -0
- package/lib/vocabulary.d.ts +44 -0
- package/lib/vocabulary.js +11 -0
- package/package.json +44 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,557 @@
|
|
|
1
|
+
Server Side Public License
|
|
2
|
+
VERSION 1, OCTOBER 16, 2018
|
|
3
|
+
|
|
4
|
+
Copyright © 2018 MongoDB, Inc.
|
|
5
|
+
|
|
6
|
+
Everyone is permitted to copy and distribute verbatim copies of this
|
|
7
|
+
license document, but changing it is not allowed.
|
|
8
|
+
|
|
9
|
+
TERMS AND CONDITIONS
|
|
10
|
+
|
|
11
|
+
0. Definitions.
|
|
12
|
+
|
|
13
|
+
“This License” refers to Server Side Public License.
|
|
14
|
+
|
|
15
|
+
“Copyright” also means copyright-like laws that apply to other kinds of
|
|
16
|
+
works, such as semiconductor masks.
|
|
17
|
+
|
|
18
|
+
“The Program” refers to any copyrightable work licensed under this
|
|
19
|
+
License. Each licensee is addressed as “you”. “Licensees” and
|
|
20
|
+
“recipients” may be individuals or organizations.
|
|
21
|
+
|
|
22
|
+
To “modify” a work means to copy from or adapt all or part of the work in
|
|
23
|
+
a fashion requiring copyright permission, other than the making of an
|
|
24
|
+
exact copy. The resulting work is called a “modified version” of the
|
|
25
|
+
earlier work or a work “based on” the earlier work.
|
|
26
|
+
|
|
27
|
+
A “covered work” means either the unmodified Program or a work based on
|
|
28
|
+
the Program.
|
|
29
|
+
|
|
30
|
+
To “propagate” a work means to do anything with it that, without
|
|
31
|
+
permission, would make you directly or secondarily liable for
|
|
32
|
+
infringement under applicable copyright law, except executing it on a
|
|
33
|
+
computer or modifying a private copy. Propagation includes copying,
|
|
34
|
+
distribution (with or without modification), making available to the
|
|
35
|
+
public, and in some countries other activities as well.
|
|
36
|
+
|
|
37
|
+
To “convey” a work means any kind of propagation that enables other
|
|
38
|
+
parties to make or receive copies. Mere interaction with a user through a
|
|
39
|
+
computer network, with no transfer of a copy, is not conveying.
|
|
40
|
+
|
|
41
|
+
An interactive user interface displays “Appropriate Legal Notices” to the
|
|
42
|
+
extent that it includes a convenient and prominently visible feature that
|
|
43
|
+
(1) displays an appropriate copyright notice, and (2) tells the user that
|
|
44
|
+
there is no warranty for the work (except to the extent that warranties
|
|
45
|
+
are provided), that licensees may convey the work under this License, and
|
|
46
|
+
how to view a copy of this License. If the interface presents a list of
|
|
47
|
+
user commands or options, such as a menu, a prominent item in the list
|
|
48
|
+
meets this criterion.
|
|
49
|
+
|
|
50
|
+
1. Source Code.
|
|
51
|
+
|
|
52
|
+
The “source code” for a work means the preferred form of the work for
|
|
53
|
+
making modifications to it. “Object code” means any non-source form of a
|
|
54
|
+
work.
|
|
55
|
+
|
|
56
|
+
A “Standard Interface” means an interface that either is an official
|
|
57
|
+
standard defined by a recognized standards body, or, in the case of
|
|
58
|
+
interfaces specified for a particular programming language, one that is
|
|
59
|
+
widely used among developers working in that language. The “System
|
|
60
|
+
Libraries” of an executable work include anything, other than the work as
|
|
61
|
+
a whole, that (a) is included in the normal form of packaging a Major
|
|
62
|
+
Component, but which is not part of that Major Component, and (b) serves
|
|
63
|
+
only to enable use of the work with that Major Component, or to implement
|
|
64
|
+
a Standard Interface for which an implementation is available to the
|
|
65
|
+
public in source code form. A “Major Component”, in this context, means a
|
|
66
|
+
major essential component (kernel, window system, and so on) of the
|
|
67
|
+
specific operating system (if any) on which the executable work runs, or
|
|
68
|
+
a compiler used to produce the work, or an object code interpreter used
|
|
69
|
+
to run it.
|
|
70
|
+
|
|
71
|
+
The “Corresponding Source” for a work in object code form means all the
|
|
72
|
+
source code needed to generate, install, and (for an executable work) run
|
|
73
|
+
the object code and to modify the work, including scripts to control
|
|
74
|
+
those activities. However, it does not include the work's System
|
|
75
|
+
Libraries, or general-purpose tools or generally available free programs
|
|
76
|
+
which are used unmodified in performing those activities but which are
|
|
77
|
+
not part of the work. For example, Corresponding Source includes
|
|
78
|
+
interface definition files associated with source files for the work, and
|
|
79
|
+
the source code for shared libraries and dynamically linked subprograms
|
|
80
|
+
that the work is specifically designed to require, such as by intimate
|
|
81
|
+
data communication or control flow between those subprograms and other
|
|
82
|
+
parts of the work.
|
|
83
|
+
|
|
84
|
+
The Corresponding Source need not include anything that users can
|
|
85
|
+
regenerate automatically from other parts of the Corresponding Source.
|
|
86
|
+
|
|
87
|
+
The Corresponding Source for a work in source code form is that same work.
|
|
88
|
+
|
|
89
|
+
2. Basic Permissions.
|
|
90
|
+
|
|
91
|
+
All rights granted under this License are granted for the term of
|
|
92
|
+
copyright on the Program, and are irrevocable provided the stated
|
|
93
|
+
conditions are met. This License explicitly affirms your unlimited
|
|
94
|
+
permission to run the unmodified Program, subject to section 13. The
|
|
95
|
+
output from running a covered work is covered by this License only if the
|
|
96
|
+
output, given its content, constitutes a covered work. This License
|
|
97
|
+
acknowledges your rights of fair use or other equivalent, as provided by
|
|
98
|
+
copyright law. Subject to section 13, you may make, run and propagate
|
|
99
|
+
covered works that you do not convey, without conditions so long as your
|
|
100
|
+
license otherwise remains in force. You may convey covered works to
|
|
101
|
+
others for the sole purpose of having them make modifications exclusively
|
|
102
|
+
for you, or provide you with facilities for running those works, provided
|
|
103
|
+
that you comply with the terms of this License in conveying all
|
|
104
|
+
material for which you do not control copyright. Those thus making or
|
|
105
|
+
running the covered works for you must do so exclusively on your
|
|
106
|
+
behalf, under your direction and control, on terms that prohibit them
|
|
107
|
+
from making any copies of your copyrighted material outside their
|
|
108
|
+
relationship with you.
|
|
109
|
+
|
|
110
|
+
Conveying under any other circumstances is permitted solely under the
|
|
111
|
+
conditions stated below. Sublicensing is not allowed; section 10 makes it
|
|
112
|
+
unnecessary.
|
|
113
|
+
|
|
114
|
+
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
|
115
|
+
|
|
116
|
+
No covered work shall be deemed part of an effective technological
|
|
117
|
+
measure under any applicable law fulfilling obligations under article 11
|
|
118
|
+
of the WIPO copyright treaty adopted on 20 December 1996, or similar laws
|
|
119
|
+
prohibiting or restricting circumvention of such measures.
|
|
120
|
+
|
|
121
|
+
When you convey a covered work, you waive any legal power to forbid
|
|
122
|
+
circumvention of technological measures to the extent such circumvention is
|
|
123
|
+
effected by exercising rights under this License with respect to the
|
|
124
|
+
covered work, and you disclaim any intention to limit operation or
|
|
125
|
+
modification of the work as a means of enforcing, against the work's users,
|
|
126
|
+
your or third parties' legal rights to forbid circumvention of
|
|
127
|
+
technological measures.
|
|
128
|
+
|
|
129
|
+
4. Conveying Verbatim Copies.
|
|
130
|
+
|
|
131
|
+
You may convey verbatim copies of the Program's source code as you
|
|
132
|
+
receive it, in any medium, provided that you conspicuously and
|
|
133
|
+
appropriately publish on each copy an appropriate copyright notice; keep
|
|
134
|
+
intact all notices stating that this License and any non-permissive terms
|
|
135
|
+
added in accord with section 7 apply to the code; keep intact all notices
|
|
136
|
+
of the absence of any warranty; and give all recipients a copy of this
|
|
137
|
+
License along with the Program. You may charge any price or no price for
|
|
138
|
+
each copy that you convey, and you may offer support or warranty
|
|
139
|
+
protection for a fee.
|
|
140
|
+
|
|
141
|
+
5. Conveying Modified Source Versions.
|
|
142
|
+
|
|
143
|
+
You may convey a work based on the Program, or the modifications to
|
|
144
|
+
produce it from the Program, in the form of source code under the terms
|
|
145
|
+
of section 4, provided that you also meet all of these conditions:
|
|
146
|
+
|
|
147
|
+
a) The work must carry prominent notices stating that you modified it,
|
|
148
|
+
and giving a relevant date.
|
|
149
|
+
|
|
150
|
+
b) The work must carry prominent notices stating that it is released
|
|
151
|
+
under this License and any conditions added under section 7. This
|
|
152
|
+
requirement modifies the requirement in section 4 to “keep intact all
|
|
153
|
+
notices”.
|
|
154
|
+
|
|
155
|
+
c) You must license the entire work, as a whole, under this License to
|
|
156
|
+
anyone who comes into possession of a copy. This License will therefore
|
|
157
|
+
apply, along with any applicable section 7 additional terms, to the
|
|
158
|
+
whole of the work, and all its parts, regardless of how they are
|
|
159
|
+
packaged. This License gives no permission to license the work in any
|
|
160
|
+
other way, but it does not invalidate such permission if you have
|
|
161
|
+
separately received it.
|
|
162
|
+
|
|
163
|
+
d) If the work has interactive user interfaces, each must display
|
|
164
|
+
Appropriate Legal Notices; however, if the Program has interactive
|
|
165
|
+
interfaces that do not display Appropriate Legal Notices, your work
|
|
166
|
+
need not make them do so.
|
|
167
|
+
|
|
168
|
+
A compilation of a covered work with other separate and independent
|
|
169
|
+
works, which are not by their nature extensions of the covered work, and
|
|
170
|
+
which are not combined with it such as to form a larger program, in or on
|
|
171
|
+
a volume of a storage or distribution medium, is called an “aggregate” if
|
|
172
|
+
the compilation and its resulting copyright are not used to limit the
|
|
173
|
+
access or legal rights of the compilation's users beyond what the
|
|
174
|
+
individual works permit. Inclusion of a covered work in an aggregate does
|
|
175
|
+
not cause this License to apply to the other parts of the aggregate.
|
|
176
|
+
|
|
177
|
+
6. Conveying Non-Source Forms.
|
|
178
|
+
|
|
179
|
+
You may convey a covered work in object code form under the terms of
|
|
180
|
+
sections 4 and 5, provided that you also convey the machine-readable
|
|
181
|
+
Corresponding Source under the terms of this License, in one of these
|
|
182
|
+
ways:
|
|
183
|
+
|
|
184
|
+
a) Convey the object code in, or embodied in, a physical product
|
|
185
|
+
(including a physical distribution medium), accompanied by the
|
|
186
|
+
Corresponding Source fixed on a durable physical medium customarily
|
|
187
|
+
used for software interchange.
|
|
188
|
+
|
|
189
|
+
b) Convey the object code in, or embodied in, a physical product
|
|
190
|
+
(including a physical distribution medium), accompanied by a written
|
|
191
|
+
offer, valid for at least three years and valid for as long as you
|
|
192
|
+
offer spare parts or customer support for that product model, to give
|
|
193
|
+
anyone who possesses the object code either (1) a copy of the
|
|
194
|
+
Corresponding Source for all the software in the product that is
|
|
195
|
+
covered by this License, on a durable physical medium customarily used
|
|
196
|
+
for software interchange, for a price no more than your reasonable cost
|
|
197
|
+
of physically performing this conveying of source, or (2) access to
|
|
198
|
+
copy the Corresponding Source from a network server at no charge.
|
|
199
|
+
|
|
200
|
+
c) Convey individual copies of the object code with a copy of the
|
|
201
|
+
written offer to provide the Corresponding Source. This alternative is
|
|
202
|
+
allowed only occasionally and noncommercially, and only if you received
|
|
203
|
+
the object code with such an offer, in accord with subsection 6b.
|
|
204
|
+
|
|
205
|
+
d) Convey the object code by offering access from a designated place
|
|
206
|
+
(gratis or for a charge), and offer equivalent access to the
|
|
207
|
+
Corresponding Source in the same way through the same place at no
|
|
208
|
+
further charge. You need not require recipients to copy the
|
|
209
|
+
Corresponding Source along with the object code. If the place to copy
|
|
210
|
+
the object code is a network server, the Corresponding Source may be on
|
|
211
|
+
a different server (operated by you or a third party) that supports
|
|
212
|
+
equivalent copying facilities, provided you maintain clear directions
|
|
213
|
+
next to the object code saying where to find the Corresponding Source.
|
|
214
|
+
Regardless of what server hosts the Corresponding Source, you remain
|
|
215
|
+
obligated to ensure that it is available for as long as needed to
|
|
216
|
+
satisfy these requirements.
|
|
217
|
+
|
|
218
|
+
e) Convey the object code using peer-to-peer transmission, provided you
|
|
219
|
+
inform other peers where the object code and Corresponding Source of
|
|
220
|
+
the work are being offered to the general public at no charge under
|
|
221
|
+
subsection 6d.
|
|
222
|
+
|
|
223
|
+
A separable portion of the object code, whose source code is excluded
|
|
224
|
+
from the Corresponding Source as a System Library, need not be included
|
|
225
|
+
in conveying the object code work.
|
|
226
|
+
|
|
227
|
+
A “User Product” is either (1) a “consumer product”, which means any
|
|
228
|
+
tangible personal property which is normally used for personal, family,
|
|
229
|
+
or household purposes, or (2) anything designed or sold for incorporation
|
|
230
|
+
into a dwelling. In determining whether a product is a consumer product,
|
|
231
|
+
doubtful cases shall be resolved in favor of coverage. For a particular
|
|
232
|
+
product received by a particular user, “normally used” refers to a
|
|
233
|
+
typical or common use of that class of product, regardless of the status
|
|
234
|
+
of the particular user or of the way in which the particular user
|
|
235
|
+
actually uses, or expects or is expected to use, the product. A product
|
|
236
|
+
is a consumer product regardless of whether the product has substantial
|
|
237
|
+
commercial, industrial or non-consumer uses, unless such uses represent
|
|
238
|
+
the only significant mode of use of the product.
|
|
239
|
+
|
|
240
|
+
“Installation Information” for a User Product means any methods,
|
|
241
|
+
procedures, authorization keys, or other information required to install
|
|
242
|
+
and execute modified versions of a covered work in that User Product from
|
|
243
|
+
a modified version of its Corresponding Source. The information must
|
|
244
|
+
suffice to ensure that the continued functioning of the modified object
|
|
245
|
+
code is in no case prevented or interfered with solely because
|
|
246
|
+
modification has been made.
|
|
247
|
+
|
|
248
|
+
If you convey an object code work under this section in, or with, or
|
|
249
|
+
specifically for use in, a User Product, and the conveying occurs as part
|
|
250
|
+
of a transaction in which the right of possession and use of the User
|
|
251
|
+
Product is transferred to the recipient in perpetuity or for a fixed term
|
|
252
|
+
(regardless of how the transaction is characterized), the Corresponding
|
|
253
|
+
Source conveyed under this section must be accompanied by the
|
|
254
|
+
Installation Information. But this requirement does not apply if neither
|
|
255
|
+
you nor any third party retains the ability to install modified object
|
|
256
|
+
code on the User Product (for example, the work has been installed in
|
|
257
|
+
ROM).
|
|
258
|
+
|
|
259
|
+
The requirement to provide Installation Information does not include a
|
|
260
|
+
requirement to continue to provide support service, warranty, or updates
|
|
261
|
+
for a work that has been modified or installed by the recipient, or for
|
|
262
|
+
the User Product in which it has been modified or installed. Access
|
|
263
|
+
to a network may be denied when the modification itself materially
|
|
264
|
+
and adversely affects the operation of the network or violates the
|
|
265
|
+
rules and protocols for communication across the network.
|
|
266
|
+
|
|
267
|
+
Corresponding Source conveyed, and Installation Information provided, in
|
|
268
|
+
accord with this section must be in a format that is publicly documented
|
|
269
|
+
(and with an implementation available to the public in source code form),
|
|
270
|
+
and must require no special password or key for unpacking, reading or
|
|
271
|
+
copying.
|
|
272
|
+
|
|
273
|
+
7. Additional Terms.
|
|
274
|
+
|
|
275
|
+
“Additional permissions” are terms that supplement the terms of this
|
|
276
|
+
License by making exceptions from one or more of its conditions.
|
|
277
|
+
Additional permissions that are applicable to the entire Program shall be
|
|
278
|
+
treated as though they were included in this License, to the extent that
|
|
279
|
+
they are valid under applicable law. If additional permissions apply only
|
|
280
|
+
to part of the Program, that part may be used separately under those
|
|
281
|
+
permissions, but the entire Program remains governed by this License
|
|
282
|
+
without regard to the additional permissions. When you convey a copy of
|
|
283
|
+
a covered work, you may at your option remove any additional permissions
|
|
284
|
+
from that copy, or from any part of it. (Additional permissions may be
|
|
285
|
+
written to require their own removal in certain cases when you modify the
|
|
286
|
+
work.) You may place additional permissions on material, added by you to
|
|
287
|
+
a covered work, for which you have or can give appropriate copyright
|
|
288
|
+
permission.
|
|
289
|
+
|
|
290
|
+
Notwithstanding any other provision of this License, for material you add
|
|
291
|
+
to a covered work, you may (if authorized by the copyright holders of
|
|
292
|
+
that material) supplement the terms of this License with terms:
|
|
293
|
+
|
|
294
|
+
a) Disclaiming warranty or limiting liability differently from the
|
|
295
|
+
terms of sections 15 and 16 of this License; or
|
|
296
|
+
|
|
297
|
+
b) Requiring preservation of specified reasonable legal notices or
|
|
298
|
+
author attributions in that material or in the Appropriate Legal
|
|
299
|
+
Notices displayed by works containing it; or
|
|
300
|
+
|
|
301
|
+
c) Prohibiting misrepresentation of the origin of that material, or
|
|
302
|
+
requiring that modified versions of such material be marked in
|
|
303
|
+
reasonable ways as different from the original version; or
|
|
304
|
+
|
|
305
|
+
d) Limiting the use for publicity purposes of names of licensors or
|
|
306
|
+
authors of the material; or
|
|
307
|
+
|
|
308
|
+
e) Declining to grant rights under trademark law for use of some trade
|
|
309
|
+
names, trademarks, or service marks; or
|
|
310
|
+
|
|
311
|
+
f) Requiring indemnification of licensors and authors of that material
|
|
312
|
+
by anyone who conveys the material (or modified versions of it) with
|
|
313
|
+
contractual assumptions of liability to the recipient, for any
|
|
314
|
+
liability that these contractual assumptions directly impose on those
|
|
315
|
+
licensors and authors.
|
|
316
|
+
|
|
317
|
+
All other non-permissive additional terms are considered “further
|
|
318
|
+
restrictions” within the meaning of section 10. If the Program as you
|
|
319
|
+
received it, or any part of it, contains a notice stating that it is
|
|
320
|
+
governed by this License along with a term that is a further restriction,
|
|
321
|
+
you may remove that term. If a license document contains a further
|
|
322
|
+
restriction but permits relicensing or conveying under this License, you
|
|
323
|
+
may add to a covered work material governed by the terms of that license
|
|
324
|
+
document, provided that the further restriction does not survive such
|
|
325
|
+
relicensing or conveying.
|
|
326
|
+
|
|
327
|
+
If you add terms to a covered work in accord with this section, you must
|
|
328
|
+
place, in the relevant source files, a statement of the additional terms
|
|
329
|
+
that apply to those files, or a notice indicating where to find the
|
|
330
|
+
applicable terms. Additional terms, permissive or non-permissive, may be
|
|
331
|
+
stated in the form of a separately written license, or stated as
|
|
332
|
+
exceptions; the above requirements apply either way.
|
|
333
|
+
|
|
334
|
+
8. Termination.
|
|
335
|
+
|
|
336
|
+
You may not propagate or modify a covered work except as expressly
|
|
337
|
+
provided under this License. Any attempt otherwise to propagate or modify
|
|
338
|
+
it is void, and will automatically terminate your rights under this
|
|
339
|
+
License (including any patent licenses granted under the third paragraph
|
|
340
|
+
of section 11).
|
|
341
|
+
|
|
342
|
+
However, if you cease all violation of this License, then your license
|
|
343
|
+
from a particular copyright holder is reinstated (a) provisionally,
|
|
344
|
+
unless and until the copyright holder explicitly and finally terminates
|
|
345
|
+
your license, and (b) permanently, if the copyright holder fails to
|
|
346
|
+
notify you of the violation by some reasonable means prior to 60 days
|
|
347
|
+
after the cessation.
|
|
348
|
+
|
|
349
|
+
Moreover, your license from a particular copyright holder is reinstated
|
|
350
|
+
permanently if the copyright holder notifies you of the violation by some
|
|
351
|
+
reasonable means, this is the first time you have received notice of
|
|
352
|
+
violation of this License (for any work) from that copyright holder, and
|
|
353
|
+
you cure the violation prior to 30 days after your receipt of the notice.
|
|
354
|
+
|
|
355
|
+
Termination of your rights under this section does not terminate the
|
|
356
|
+
licenses of parties who have received copies or rights from you under
|
|
357
|
+
this License. If your rights have been terminated and not permanently
|
|
358
|
+
reinstated, you do not qualify to receive new licenses for the same
|
|
359
|
+
material under section 10.
|
|
360
|
+
|
|
361
|
+
9. Acceptance Not Required for Having Copies.
|
|
362
|
+
|
|
363
|
+
You are not required to accept this License in order to receive or run a
|
|
364
|
+
copy of the Program. Ancillary propagation of a covered work occurring
|
|
365
|
+
solely as a consequence of using peer-to-peer transmission to receive a
|
|
366
|
+
copy likewise does not require acceptance. However, nothing other than
|
|
367
|
+
this License grants you permission to propagate or modify any covered
|
|
368
|
+
work. These actions infringe copyright if you do not accept this License.
|
|
369
|
+
Therefore, by modifying or propagating a covered work, you indicate your
|
|
370
|
+
acceptance of this License to do so.
|
|
371
|
+
|
|
372
|
+
10. Automatic Licensing of Downstream Recipients.
|
|
373
|
+
|
|
374
|
+
Each time you convey a covered work, the recipient automatically receives
|
|
375
|
+
a license from the original licensors, to run, modify and propagate that
|
|
376
|
+
work, subject to this License. You are not responsible for enforcing
|
|
377
|
+
compliance by third parties with this License.
|
|
378
|
+
|
|
379
|
+
An “entity transaction” is a transaction transferring control of an
|
|
380
|
+
organization, or substantially all assets of one, or subdividing an
|
|
381
|
+
organization, or merging organizations. If propagation of a covered work
|
|
382
|
+
results from an entity transaction, each party to that transaction who
|
|
383
|
+
receives a copy of the work also receives whatever licenses to the work
|
|
384
|
+
the party's predecessor in interest had or could give under the previous
|
|
385
|
+
paragraph, plus a right to possession of the Corresponding Source of the
|
|
386
|
+
work from the predecessor in interest, if the predecessor has it or can
|
|
387
|
+
get it with reasonable efforts.
|
|
388
|
+
|
|
389
|
+
You may not impose any further restrictions on the exercise of the rights
|
|
390
|
+
granted or affirmed under this License. For example, you may not impose a
|
|
391
|
+
license fee, royalty, or other charge for exercise of rights granted
|
|
392
|
+
under this License, and you may not initiate litigation (including a
|
|
393
|
+
cross-claim or counterclaim in a lawsuit) alleging that any patent claim
|
|
394
|
+
is infringed by making, using, selling, offering for sale, or importing
|
|
395
|
+
the Program or any portion of it.
|
|
396
|
+
|
|
397
|
+
11. Patents.
|
|
398
|
+
|
|
399
|
+
A “contributor” is a copyright holder who authorizes use under this
|
|
400
|
+
License of the Program or a work on which the Program is based. The work
|
|
401
|
+
thus licensed is called the contributor's “contributor version”.
|
|
402
|
+
|
|
403
|
+
A contributor's “essential patent claims” are all patent claims owned or
|
|
404
|
+
controlled by the contributor, whether already acquired or hereafter
|
|
405
|
+
acquired, that would be infringed by some manner, permitted by this
|
|
406
|
+
License, of making, using, or selling its contributor version, but do not
|
|
407
|
+
include claims that would be infringed only as a consequence of further
|
|
408
|
+
modification of the contributor version. For purposes of this definition,
|
|
409
|
+
“control” includes the right to grant patent sublicenses in a manner
|
|
410
|
+
consistent with the requirements of this License.
|
|
411
|
+
|
|
412
|
+
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
|
413
|
+
patent license under the contributor's essential patent claims, to make,
|
|
414
|
+
use, sell, offer for sale, import and otherwise run, modify and propagate
|
|
415
|
+
the contents of its contributor version.
|
|
416
|
+
|
|
417
|
+
In the following three paragraphs, a “patent license” is any express
|
|
418
|
+
agreement or commitment, however denominated, not to enforce a patent
|
|
419
|
+
(such as an express permission to practice a patent or covenant not to
|
|
420
|
+
sue for patent infringement). To “grant” such a patent license to a party
|
|
421
|
+
means to make such an agreement or commitment not to enforce a patent
|
|
422
|
+
against the party.
|
|
423
|
+
|
|
424
|
+
If you convey a covered work, knowingly relying on a patent license, and
|
|
425
|
+
the Corresponding Source of the work is not available for anyone to copy,
|
|
426
|
+
free of charge and under the terms of this License, through a publicly
|
|
427
|
+
available network server or other readily accessible means, then you must
|
|
428
|
+
either (1) cause the Corresponding Source to be so available, or (2)
|
|
429
|
+
arrange to deprive yourself of the benefit of the patent license for this
|
|
430
|
+
particular work, or (3) arrange, in a manner consistent with the
|
|
431
|
+
requirements of this License, to extend the patent license to downstream
|
|
432
|
+
recipients. “Knowingly relying” means you have actual knowledge that, but
|
|
433
|
+
for the patent license, your conveying the covered work in a country, or
|
|
434
|
+
your recipient's use of the covered work in a country, would infringe
|
|
435
|
+
one or more identifiable patents in that country that you have reason
|
|
436
|
+
to believe are valid.
|
|
437
|
+
|
|
438
|
+
If, pursuant to or in connection with a single transaction or
|
|
439
|
+
arrangement, you convey, or propagate by procuring conveyance of, a
|
|
440
|
+
covered work, and grant a patent license to some of the parties receiving
|
|
441
|
+
the covered work authorizing them to use, propagate, modify or convey a
|
|
442
|
+
specific copy of the covered work, then the patent license you grant is
|
|
443
|
+
automatically extended to all recipients of the covered work and works
|
|
444
|
+
based on it.
|
|
445
|
+
|
|
446
|
+
A patent license is “discriminatory” if it does not include within the
|
|
447
|
+
scope of its coverage, prohibits the exercise of, or is conditioned on
|
|
448
|
+
the non-exercise of one or more of the rights that are specifically
|
|
449
|
+
granted under this License. You may not convey a covered work if you are
|
|
450
|
+
a party to an arrangement with a third party that is in the business of
|
|
451
|
+
distributing software, under which you make payment to the third party
|
|
452
|
+
based on the extent of your activity of conveying the work, and under
|
|
453
|
+
which the third party grants, to any of the parties who would receive the
|
|
454
|
+
covered work from you, a discriminatory patent license (a) in connection
|
|
455
|
+
with copies of the covered work conveyed by you (or copies made from
|
|
456
|
+
those copies), or (b) primarily for and in connection with specific
|
|
457
|
+
products or compilations that contain the covered work, unless you
|
|
458
|
+
entered into that arrangement, or that patent license was granted, prior
|
|
459
|
+
to 28 March 2007.
|
|
460
|
+
|
|
461
|
+
Nothing in this License shall be construed as excluding or limiting any
|
|
462
|
+
implied license or other defenses to infringement that may otherwise be
|
|
463
|
+
available to you under applicable patent law.
|
|
464
|
+
|
|
465
|
+
12. No Surrender of Others' Freedom.
|
|
466
|
+
|
|
467
|
+
If conditions are imposed on you (whether by court order, agreement or
|
|
468
|
+
otherwise) that contradict the conditions of this License, they do not
|
|
469
|
+
excuse you from the conditions of this License. If you cannot use,
|
|
470
|
+
propagate or convey a covered work so as to satisfy simultaneously your
|
|
471
|
+
obligations under this License and any other pertinent obligations, then
|
|
472
|
+
as a consequence you may not use, propagate or convey it at all. For
|
|
473
|
+
example, if you agree to terms that obligate you to collect a royalty for
|
|
474
|
+
further conveying from those to whom you convey the Program, the only way
|
|
475
|
+
you could satisfy both those terms and this License would be to refrain
|
|
476
|
+
entirely from conveying the Program.
|
|
477
|
+
|
|
478
|
+
13. Offering the Program as a Service.
|
|
479
|
+
|
|
480
|
+
If you make the functionality of the Program or a modified version
|
|
481
|
+
available to third parties as a service, you must make the Service Source
|
|
482
|
+
Code available via network download to everyone at no charge, under the
|
|
483
|
+
terms of this License. Making the functionality of the Program or
|
|
484
|
+
modified version available to third parties as a service includes,
|
|
485
|
+
without limitation, enabling third parties to interact with the
|
|
486
|
+
functionality of the Program or modified version remotely through a
|
|
487
|
+
computer network, offering a service the value of which entirely or
|
|
488
|
+
primarily derives from the value of the Program or modified version, or
|
|
489
|
+
offering a service that accomplishes for users the primary purpose of the
|
|
490
|
+
Program or modified version.
|
|
491
|
+
|
|
492
|
+
“Service Source Code” means the Corresponding Source for the Program or
|
|
493
|
+
the modified version, and the Corresponding Source for all programs that
|
|
494
|
+
you use to make the Program or modified version available as a service,
|
|
495
|
+
including, without limitation, management software, user interfaces,
|
|
496
|
+
application program interfaces, automation software, monitoring software,
|
|
497
|
+
backup software, storage software and hosting software, all such that a
|
|
498
|
+
user could run an instance of the service using the Service Source Code
|
|
499
|
+
you make available.
|
|
500
|
+
|
|
501
|
+
14. Revised Versions of this License.
|
|
502
|
+
|
|
503
|
+
MongoDB, Inc. may publish revised and/or new versions of the Server Side
|
|
504
|
+
Public License from time to time. Such new versions will be similar in
|
|
505
|
+
spirit to the present version, but may differ in detail to address new
|
|
506
|
+
problems or concerns.
|
|
507
|
+
|
|
508
|
+
Each version is given a distinguishing version number. If the Program
|
|
509
|
+
specifies that a certain numbered version of the Server Side Public
|
|
510
|
+
License “or any later version” applies to it, you have the option of
|
|
511
|
+
following the terms and conditions either of that numbered version or of
|
|
512
|
+
any later version published by MongoDB, Inc. If the Program does not
|
|
513
|
+
specify a version number of the Server Side Public License, you may
|
|
514
|
+
choose any version ever published by MongoDB, Inc.
|
|
515
|
+
|
|
516
|
+
If the Program specifies that a proxy can decide which future versions of
|
|
517
|
+
the Server Side Public License can be used, that proxy's public statement
|
|
518
|
+
of acceptance of a version permanently authorizes you to choose that
|
|
519
|
+
version for the Program.
|
|
520
|
+
|
|
521
|
+
Later license versions may give you additional or different permissions.
|
|
522
|
+
However, no additional obligations are imposed on any author or copyright holder
|
|
523
|
+
as a result of your choosing to follow a later version.
|
|
524
|
+
|
|
525
|
+
15. Disclaimer of Warranty.
|
|
526
|
+
|
|
527
|
+
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
|
528
|
+
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS
|
|
529
|
+
AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY
|
|
530
|
+
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
|
531
|
+
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
532
|
+
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
|
533
|
+
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
|
534
|
+
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
|
535
|
+
|
|
536
|
+
16. Limitation of Liability.
|
|
537
|
+
|
|
538
|
+
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
|
539
|
+
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
|
540
|
+
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING
|
|
541
|
+
ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF
|
|
542
|
+
THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO
|
|
543
|
+
LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU
|
|
544
|
+
OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
|
545
|
+
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
|
546
|
+
POSSIBILITY OF SUCH DAMAGES.
|
|
547
|
+
|
|
548
|
+
17. Interpretation of Sections 15 and 16.
|
|
549
|
+
|
|
550
|
+
If the disclaimer of warranty and limitation of liability provided above
|
|
551
|
+
cannot be given local legal effect according to their terms, reviewing
|
|
552
|
+
courts shall apply local law that most closely approximates an absolute
|
|
553
|
+
waiver of all civil liability in connection with the Program, unless a
|
|
554
|
+
warranty or assumption of liability accompanies a copy of the Program in
|
|
555
|
+
return for a fee.
|
|
556
|
+
|
|
557
|
+
END OF TERMS AND CONDITIONS
|
package/README.md
CHANGED
|
@@ -1,3 +1,55 @@
|
|
|
1
|
-
|
|
1
|
+
---
|
|
2
|
+
description: The engine Service Definition — the engines seat, engine-agnostic stage types, and the pinned engine-id vocabulary every engine adapter and the runs lane share.
|
|
3
|
+
kind: package-library
|
|
4
|
+
---
|
|
2
5
|
|
|
3
|
-
|
|
6
|
+
# @melite/engine-contract
|
|
7
|
+
|
|
8
|
+
`@melite/engine-contract` declares the one contract every run-path engine
|
|
9
|
+
implements: the `engines` seat registry, the stage-row and executor types,
|
|
10
|
+
and the engine-id grammar. It calls nothing — it is the typed seam the
|
|
11
|
+
ComfyUI, craft, agent, and MCP adapters register into and the runs lane
|
|
12
|
+
resolves through. The estate bundle mounts `enginesContract` before every
|
|
13
|
+
engine adapter row.
|
|
14
|
+
|
|
15
|
+
## Contract
|
|
16
|
+
|
|
17
|
+
- Engine ids: `comfyui`, `craft`, `agent`, or `mcp:<server>` with the server
|
|
18
|
+
name matching dsh-mcp-client's `[A-Za-z0-9_-]{1,32}`. `register` refuses
|
|
19
|
+
ungrammatical ids and duplicates loud; `resolve` refuses unknown ids loud,
|
|
20
|
+
naming every registered id.
|
|
21
|
+
- One registered engine is `{ executor, probe? }` — the control arm
|
|
22
|
+
`executeStages(rows, runDir, inputNames, options, initials?)` plus an
|
|
23
|
+
optional reachability probe. Connection lifecycle stays with each engine's
|
|
24
|
+
own owner; the probe only reports.
|
|
25
|
+
- Registrations are effects: `register` returns the disposer; providers wrap
|
|
26
|
+
it in `ctx.effect`.
|
|
27
|
+
- Declared exports: `.` (barrel), `./engines` (EnginesService + provider +
|
|
28
|
+
id grammar), `./types` (EngineStageRow, EngineStageOutcome,
|
|
29
|
+
EngineExecutor), `./vocabulary` (the engine-agnostic ParamSpec grammar),
|
|
30
|
+
`./package.json`.
|
|
31
|
+
|
|
32
|
+
## Model Experience
|
|
33
|
+
|
|
34
|
+
### Request context and condition
|
|
35
|
+
|
|
36
|
+
#### What the model sees
|
|
37
|
+
|
|
38
|
+
None — the package contributes no model-visible input.
|
|
39
|
+
|
|
40
|
+
#### Token effect
|
|
41
|
+
|
|
42
|
+
Zero-direct token effect.
|
|
43
|
+
|
|
44
|
+
#### KV Cache effect
|
|
45
|
+
|
|
46
|
+
Independent — the seat holds no conversation state.
|
|
47
|
+
|
|
48
|
+
## Known Limitations and Deferred Work
|
|
49
|
+
|
|
50
|
+
- **No capability-listing face** — the seat resolves ids; it does not
|
|
51
|
+
enumerate per-engine params. Served forms come from each engine's own doc
|
|
52
|
+
module.
|
|
53
|
+
- **initials is optional and dialect-bound** — engines whose param dialect
|
|
54
|
+
has no `$spells` ignore run initials; nothing enforces a uniform
|
|
55
|
+
treatment.
|
package/lib/engines.d.ts
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import { Context, Service } from "@deepseek-ai/cordis";
|
|
2
|
+
import type { Plugin } from "@deepseek-ai/cordis";
|
|
3
|
+
import type { EngineRecord } from "./types.js";
|
|
4
|
+
/** Whether an engine id is grammatical (the pinned grammar — see
|
|
5
|
+
* the module header). Exported for the door's pre-flight: the runs
|
|
6
|
+
* door refuses ungrammatical ids with its own voice BEFORE the
|
|
7
|
+
* registry is consulted. */
|
|
8
|
+
/** THE BARE ENGINE IDS (the owner's names): every site that names
|
|
9
|
+
* an engine takes it from here — a card's inject row, a stage's
|
|
10
|
+
* engine field, a gate's default. One owner per token (the closure
|
|
11
|
+
* gate's rule 2b). */
|
|
12
|
+
export declare const COMFYUI_ENGINE_ID = "comfyui";
|
|
13
|
+
export declare const CRAFT_ENGINE_ID = "craft";
|
|
14
|
+
export declare const AGENT_ENGINE_ID = "agent";
|
|
15
|
+
export declare function engineIdOk(id: string): boolean;
|
|
16
|
+
export declare class EnginesService extends Service {
|
|
17
|
+
private readonly engines;
|
|
18
|
+
constructor(ctx: Context);
|
|
19
|
+
/** Register one engine. LOUD on a non-grammatical id (drift, not
|
|
20
|
+
* a fallback case) and on a duplicate id (one id, one provider —
|
|
21
|
+
* the scope-aware tools registry's same-law simplification: THIS
|
|
22
|
+
* seat is per-fiber, so a second registration under the same id
|
|
23
|
+
* on one fiber is a wiring bug). Returns the disposer (the
|
|
24
|
+
* provider wraps it in ctx.effect — the fiber owns the row's
|
|
25
|
+
* lifetime). */
|
|
26
|
+
register(id: string, record: EngineRecord): () => void;
|
|
27
|
+
/** Resolve one engine. LOUD on an unknown id (an engine call
|
|
28
|
+
* without an engine is never a silent module fallback —
|
|
29
|
+
* needComfyUI's law, generalized): the error names every
|
|
30
|
+
* registered id so the miswire is diagnosable at the door. */
|
|
31
|
+
resolve(id: string): EngineRecord;
|
|
32
|
+
/** Whether an engine id is registered (the door's membership
|
|
33
|
+
* check — grammar first, then this). */
|
|
34
|
+
has(id: string): boolean;
|
|
35
|
+
/** The registered ids, sorted (diagnostic + door voice). */
|
|
36
|
+
ids(): string[];
|
|
37
|
+
}
|
|
38
|
+
/** The contract's provider plugin: mounts the 'engines' seat. Ride
|
|
39
|
+
* BEFORE every engine adapter row (the estate bundle's mount order
|
|
40
|
+
* is load order). */
|
|
41
|
+
export declare const enginesContract: Plugin;
|
|
42
|
+
export default enginesContract;
|
|
43
|
+
//# sourceMappingURL=engines.d.ts.map
|
package/lib/engines.js
ADDED
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
// engines.ts — the 'engines' seat: one registry every engine
|
|
2
|
+
// provider registers into and every run-path consumer resolves
|
|
3
|
+
// through (stroke 53, the engine-generics seam). The ComfyUI
|
|
4
|
+
// adapter (comfyui-cordis's engine row) is the first provider; MCP
|
|
5
|
+
// engines register as 'mcp:<serverName>' (blender, unity, godot)
|
|
6
|
+
// next. DSH law held here: registrations are effects (register
|
|
7
|
+
// returns its disposer, HMR disposal removes the row), duplicates
|
|
8
|
+
// refuse LOUD, unknown ids resolve LOUD with the registered list,
|
|
9
|
+
// and misconfiguration never silently skips a referent.
|
|
10
|
+
//
|
|
11
|
+
// ENGINE ID GRAMMAR (pinned): the bare words 'comfyui', 'craft'
|
|
12
|
+
// (the loop engine — stroke 55) and 'agent' (the spawner — stroke
|
|
13
|
+
// 60, plan §5), or 'mcp:<serverName>'
|
|
14
|
+
// where serverName matches dsh-mcp-client's namespace rule
|
|
15
|
+
// [A-Za-z0-9_-]{1,32} — the MCP engine ids are the MCP server
|
|
16
|
+
// namespaces verbatim, so a stage row's engine and the tool
|
|
17
|
+
// bridge's mcp__<serverName>__ names share one vocabulary.
|
|
18
|
+
import { Service } from "@deepseek-ai/cordis";
|
|
19
|
+
/** The MCP server-name rule, copied verbatim from dsh-mcp-client's
|
|
20
|
+
* serverName contract (`[A-Za-z0-9_-]{1,32}`). */
|
|
21
|
+
const MCP_SERVER_NAME = /^[A-Za-z0-9_-]{1,32}$/;
|
|
22
|
+
/** Whether an engine id is grammatical (the pinned grammar — see
|
|
23
|
+
* the module header). Exported for the door's pre-flight: the runs
|
|
24
|
+
* door refuses ungrammatical ids with its own voice BEFORE the
|
|
25
|
+
* registry is consulted. */
|
|
26
|
+
/** THE BARE ENGINE IDS (the owner's names): every site that names
|
|
27
|
+
* an engine takes it from here — a card's inject row, a stage's
|
|
28
|
+
* engine field, a gate's default. One owner per token (the closure
|
|
29
|
+
* gate's rule 2b). */
|
|
30
|
+
export const COMFYUI_ENGINE_ID = "comfyui";
|
|
31
|
+
export const CRAFT_ENGINE_ID = "craft";
|
|
32
|
+
export const AGENT_ENGINE_ID = "agent";
|
|
33
|
+
export function engineIdOk(id) {
|
|
34
|
+
return id === COMFYUI_ENGINE_ID || id === CRAFT_ENGINE_ID || id === AGENT_ENGINE_ID || (id.startsWith("mcp:") && MCP_SERVER_NAME.test(id.slice(4)));
|
|
35
|
+
}
|
|
36
|
+
export class EnginesService extends Service {
|
|
37
|
+
engines = new Map();
|
|
38
|
+
constructor(ctx) {
|
|
39
|
+
super(ctx, "engines");
|
|
40
|
+
}
|
|
41
|
+
/** Register one engine. LOUD on a non-grammatical id (drift, not
|
|
42
|
+
* a fallback case) and on a duplicate id (one id, one provider —
|
|
43
|
+
* the scope-aware tools registry's same-law simplification: THIS
|
|
44
|
+
* seat is per-fiber, so a second registration under the same id
|
|
45
|
+
* on one fiber is a wiring bug). Returns the disposer (the
|
|
46
|
+
* provider wraps it in ctx.effect — the fiber owns the row's
|
|
47
|
+
* lifetime). */
|
|
48
|
+
register(id, record) {
|
|
49
|
+
if (!engineIdOk(id)) {
|
|
50
|
+
throw new Error("[engines] engine id '" + id + "' is not grammatical — 'comfyui', 'craft', 'agent' or 'mcp:<server>' ([A-Za-z0-9_-]{1,32})");
|
|
51
|
+
}
|
|
52
|
+
if (this.engines.has(id)) {
|
|
53
|
+
throw new Error("[engines] engine '" + id + "' registered twice — one id, one provider");
|
|
54
|
+
}
|
|
55
|
+
this.engines.set(id, record);
|
|
56
|
+
return () => {
|
|
57
|
+
this.engines.delete(id);
|
|
58
|
+
};
|
|
59
|
+
}
|
|
60
|
+
/** Resolve one engine. LOUD on an unknown id (an engine call
|
|
61
|
+
* without an engine is never a silent module fallback —
|
|
62
|
+
* needComfyUI's law, generalized): the error names every
|
|
63
|
+
* registered id so the miswire is diagnosable at the door. */
|
|
64
|
+
resolve(id) {
|
|
65
|
+
const record = this.engines.get(id);
|
|
66
|
+
if (record === undefined) {
|
|
67
|
+
const known = this.engines.size === 0
|
|
68
|
+
? "none registered on this fiber"
|
|
69
|
+
: [...this.engines.keys()].sort().join(", ");
|
|
70
|
+
throw new Error("[engines] no engine '" + id + "' — registered: " + known);
|
|
71
|
+
}
|
|
72
|
+
return record;
|
|
73
|
+
}
|
|
74
|
+
/** Whether an engine id is registered (the door's membership
|
|
75
|
+
* check — grammar first, then this). */
|
|
76
|
+
has(id) {
|
|
77
|
+
return this.engines.has(id);
|
|
78
|
+
}
|
|
79
|
+
/** The registered ids, sorted (diagnostic + door voice). */
|
|
80
|
+
ids() {
|
|
81
|
+
return [...this.engines.keys()].sort();
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
/** The contract's provider plugin: mounts the 'engines' seat. Ride
|
|
85
|
+
* BEFORE every engine adapter row (the estate bundle's mount order
|
|
86
|
+
* is load order). */
|
|
87
|
+
export const enginesContract = {
|
|
88
|
+
name: "engine-contract",
|
|
89
|
+
apply(ctx) {
|
|
90
|
+
new EnginesService(ctx);
|
|
91
|
+
},
|
|
92
|
+
};
|
|
93
|
+
export default enginesContract;
|
|
94
|
+
//# sourceMappingURL=engines.js.map
|
package/lib/index.d.ts
ADDED
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
export type { EngineParamValue, EngineStageRow, EngineStageOutcome, EngineRunOutcome, EngineRunOptions, EngineExecutor, EngineRecord, } from "./types.js";
|
|
2
|
+
export type { PortSpec, ParamSpec, ActionSpec } from "./vocabulary.js";
|
|
3
|
+
export { AGENT_ENGINE_ID, COMFYUI_ENGINE_ID, CRAFT_ENGINE_ID, EnginesService, engineIdOk, enginesContract, } from "./engines.js";
|
|
4
|
+
export { enginesContract as default } from "./engines.js";
|
|
5
|
+
//# sourceMappingURL=index.d.ts.map
|
package/lib/index.js
ADDED
package/lib/types.d.ts
ADDED
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
/** A JSON value as the runs plane already carries it (the
|
|
2
|
+
* stage-row params/outputs element type — EngineJson's structural
|
|
3
|
+
* twin, declared here so the contract depends on no engine
|
|
4
|
+
* package). */
|
|
5
|
+
export type EngineParamValue = null | boolean | number | string | EngineParamValue[] | {
|
|
6
|
+
[key: string]: EngineParamValue;
|
|
7
|
+
};
|
|
8
|
+
/** One stage of a run, engine-agnostic: the door-validated id, the
|
|
9
|
+
* stage's declared outputs, and the stage's raw params. Graph
|
|
10
|
+
* surgery (ComfyUI's spliceWorkflow) belongs to the owning
|
|
11
|
+
* engine's executor — never to the consumer. */
|
|
12
|
+
export interface EngineStageRow {
|
|
13
|
+
readonly stageId: string;
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
readonly card?: string;
|
|
22
|
+
readonly outputs: Readonly<Record<string, EngineParamValue>>;
|
|
23
|
+
readonly params: Readonly<Record<string, EngineParamValue>>;
|
|
24
|
+
}
|
|
25
|
+
/** One stage's outcome: the harvested outputs plus the run-dir
|
|
26
|
+
* relative artifact paths the engine wrote (the collect arm — the
|
|
27
|
+
* runs tree is the estate's artifact law, viewable by melite_view). */
|
|
28
|
+
export interface EngineStageOutcome {
|
|
29
|
+
readonly stageId: string;
|
|
30
|
+
readonly outputs: Readonly<Record<string, EngineParamValue>>;
|
|
31
|
+
readonly artifacts: readonly string[];
|
|
32
|
+
}
|
|
33
|
+
/** A whole submit's outcome. `engineRef` is the engine's own
|
|
34
|
+
* handle for the submitted work (ComfyUI's promptId) — opaque to
|
|
35
|
+
* the consumer, carried for the ledger. */
|
|
36
|
+
export interface EngineRunOutcome {
|
|
37
|
+
readonly stages: readonly EngineStageOutcome[];
|
|
38
|
+
readonly engineRef?: string;
|
|
39
|
+
/** THE REPLAY VERDICT (D11): true when the executor's seated tap
|
|
40
|
+
* folded zero engine events before settlement — the engine served
|
|
41
|
+
* memo'd outputs without executing. Optional so existing
|
|
42
|
+
* executors stay assignable (absent = unknown, never clean). */
|
|
43
|
+
readonly replaySuspect?: boolean;
|
|
44
|
+
}
|
|
45
|
+
/** The run-path's signals into the executor: the stop flag (the
|
|
46
|
+
* user's stop press) and the progress tap (stage activity /
|
|
47
|
+
* progress folds — the same callback shape the ComfyUI progress
|
|
48
|
+
* webhooks ride today). */
|
|
49
|
+
export interface EngineRunOptions {
|
|
50
|
+
shouldStop(): boolean;
|
|
51
|
+
report(updates: Record<string, unknown>): void;
|
|
52
|
+
/** §23 cross-roots manifest extras (J12: config-named by the
|
|
53
|
+
* queue seat — the trees a chained-input estate URL may
|
|
54
|
+
* resolve under beyond the run's own output root; optional so
|
|
55
|
+
* existing executors stay assignable). */
|
|
56
|
+
readonly stateRoots?: readonly string[];
|
|
57
|
+
}
|
|
58
|
+
/** The control arm: execute stages of one run. The ComfyUI
|
|
59
|
+
* executor keeps the MERGED single-graph law internally (rows
|
|
60
|
+
* splice + merge into ONE prompt); an MCP executor executes
|
|
61
|
+
* per-stage wire commands. `inputNames` is the run's stage-input
|
|
62
|
+
* wiring (stage-local name -> upstream artifact ref), identical in
|
|
63
|
+
* shape to the merged path's. `initials` is the run's request
|
|
64
|
+
* initials — the flow's declared initial values the start body
|
|
65
|
+
* carried, gate-validated at the door — the values a stage's
|
|
66
|
+
* `$spell` params resolve against at merge; an engine whose param
|
|
67
|
+
* dialect has no `$spells` ignores it. Optional so existing
|
|
68
|
+
* shorter-signature executors stay assignable (absent = no
|
|
69
|
+
* initials to resolve). */
|
|
70
|
+
export interface EngineExecutor {
|
|
71
|
+
executeStages(rows: readonly EngineStageRow[], runDir: string, inputNames: Readonly<Record<string, Readonly<Record<string, string>>>>, options: EngineRunOptions, initials?: Readonly<Record<string, EngineParamValue>>): Promise<EngineRunOutcome>;
|
|
72
|
+
}
|
|
73
|
+
/** One registered engine: the executor plus an optional
|
|
74
|
+
* reachability probe (the supervisor face — ComfyUI's
|
|
75
|
+
* /system_stats probe; an MCP engine's cheap tool health call).
|
|
76
|
+
* Connection lifecycle is NOT here: the MCP client plugin owns
|
|
77
|
+
* connect/reconnect (the DSH pattern), ComfyUI's supervisor owns
|
|
78
|
+
* its own — the probe only reports. */
|
|
79
|
+
export interface EngineRecord {
|
|
80
|
+
readonly executor: EngineExecutor;
|
|
81
|
+
readonly probe?: () => Promise<void>;
|
|
82
|
+
}
|
|
83
|
+
//# sourceMappingURL=types.d.ts.map
|
package/lib/types.js
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
// types.ts — the engine Service Definition's pure types (the
|
|
2
|
+
// engine-generics seam). One contract covers every run-path engine — ComfyUI today, MCP
|
|
3
|
+
// servers next — with the runs lane as the sole Consumer. Engine
|
|
4
|
+
// ids are NAMED vocabulary (like tool names), grammar-pinned in
|
|
5
|
+
// engines.ts, never opaque (no Branded carrier: the id crosses the
|
|
6
|
+
// stage-row JSON the door already validates).
|
|
7
|
+
export {};
|
|
8
|
+
//# sourceMappingURL=types.js.map
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
/** A typed port on an action boundary. `kind` names the engine's own
|
|
2
|
+
* slot vocabulary (the ComfyUI instance spells IMAGE, LATENT, MASK,
|
|
3
|
+
* ...); the set is the engine's, never averaged across engines. */
|
|
4
|
+
export interface PortSpec<K extends string = string> {
|
|
5
|
+
readonly name: string;
|
|
6
|
+
readonly kind: K;
|
|
7
|
+
}
|
|
8
|
+
/** A declared parameter of an action — the write plane's unit. The
|
|
9
|
+
* declared surface is data: `type` names the value tier, `bounds`
|
|
10
|
+
* the numeric envelope, `options` the enum's closed set (engine
|
|
11
|
+
* vocabularies land here), and `rule` names a managed affair the
|
|
12
|
+
* instantiator executes before the segment factory runs:
|
|
13
|
+
* "seed-sentinel" is GATE S — the param is the seed, -1 means
|
|
14
|
+
* random, and the one minter resolves it so every node sharing the
|
|
15
|
+
* seed shares the minted value. A variant preset pinning a param
|
|
16
|
+
* the surface does not offer, or a value outside the envelope,
|
|
17
|
+
* refuses at the family door. */
|
|
18
|
+
export interface ParamSpec {
|
|
19
|
+
readonly name: string;
|
|
20
|
+
readonly type: "number" | "string" | "boolean" | "enum" | "image_list";
|
|
21
|
+
readonly bounds?: readonly [number, number];
|
|
22
|
+
readonly options?: readonly string[];
|
|
23
|
+
readonly rule?: "seed-sentinel";
|
|
24
|
+
}
|
|
25
|
+
/** The action shell the atom declares: what it offers upward — the
|
|
26
|
+
* boundary input ports it accepts, the boundary output ports, the
|
|
27
|
+
* declared params, and the segment factory behind them. The engine
|
|
28
|
+
* instance widens `build`'s context (the typed facts, the engine's
|
|
29
|
+
* builder) and its return (the engine's terminal handle); cards
|
|
30
|
+
* compose actions, never nodes. A self-contained action (its own
|
|
31
|
+
* loaders inside the segment) declares `inputs: []`. */
|
|
32
|
+
export interface ActionSpec<C, R> {
|
|
33
|
+
readonly id: string;
|
|
34
|
+
readonly inputs: readonly PortSpec[];
|
|
35
|
+
readonly outputs: readonly PortSpec[];
|
|
36
|
+
readonly params: readonly ParamSpec[];
|
|
37
|
+
/** Present-only-when-true: the action reads nothing off a
|
|
38
|
+
* resolved model row, so a flow row may name it and the flow
|
|
39
|
+
* plane composes against the model-less facts shape. Absent =
|
|
40
|
+
* lane-bound — only a card's resolved row may dispatch it. */
|
|
41
|
+
readonly laneIndependent?: boolean;
|
|
42
|
+
readonly build: (ctx: C) => R;
|
|
43
|
+
}
|
|
44
|
+
//# sourceMappingURL=vocabulary.d.ts.map
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
// vocabulary.ts — the action-contract grammar (the atom vocabulary's
|
|
2
|
+
// engine-parameterized core).
|
|
3
|
+
// This module carries only the shapes every engine shares: boundary
|
|
4
|
+
// ports, declared params with their managed affairs, and the action
|
|
5
|
+
// shell an atom declares and the interpreter instantiates. The
|
|
6
|
+
// per-engine instance — the slot-kind set, the facts door, the
|
|
7
|
+
// builder — lives at the engine plane (the ComfyUI one:
|
|
8
|
+
// comfyui-card-kit's action.ts). Source-plane TS (erasable syntax —
|
|
9
|
+
// no enums, no namespaces).
|
|
10
|
+
export {};
|
|
11
|
+
//# sourceMappingURL=vocabulary.js.map
|
package/package.json
CHANGED
|
@@ -1,6 +1,46 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@melite/engine-contract",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"
|
|
5
|
-
"
|
|
6
|
-
|
|
3
|
+
"version": "0.1.5-pre-alpha",
|
|
4
|
+
"license": "SSPL-1.0",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"description": "The engine Service Definition (stroke 53, the engine-generics seam): one registry seat every engine provider registers into and every run-path consumer resolves through — ComfyUI today, MCP servers (blender/unity/godot) next. Stage rows are engine-agnostic; graph surgery (spliceWorkflow) stays inside the owning engine's executor. Source-plane TS (erasable syntax, no build step).",
|
|
7
|
+
"exports": {
|
|
8
|
+
".": {
|
|
9
|
+
"types": "./lib/index.d.ts",
|
|
10
|
+
"default": "./lib/index.js"
|
|
11
|
+
},
|
|
12
|
+
"./engines": {
|
|
13
|
+
"types": "./lib/engines.d.ts",
|
|
14
|
+
"default": "./lib/engines.js"
|
|
15
|
+
},
|
|
16
|
+
"./types": {
|
|
17
|
+
"types": "./lib/types.d.ts",
|
|
18
|
+
"default": "./lib/types.js"
|
|
19
|
+
},
|
|
20
|
+
"./vocabulary": {
|
|
21
|
+
"types": "./lib/vocabulary.d.ts",
|
|
22
|
+
"default": "./lib/vocabulary.js"
|
|
23
|
+
},
|
|
24
|
+
"./package.json": "./package.json"
|
|
25
|
+
},
|
|
26
|
+
"devDependencies": {
|
|
27
|
+
"@types/node": "^22.20.0",
|
|
28
|
+
"typescript": "^5.9.3",
|
|
29
|
+
"@deepseek-ai/cordis": "^4.0.4"
|
|
30
|
+
},
|
|
31
|
+
"files": [
|
|
32
|
+
"lib/index.js",
|
|
33
|
+
"lib/**/*.js",
|
|
34
|
+
"lib/**/*.d.ts"
|
|
35
|
+
],
|
|
36
|
+
"peerDependencies": {
|
|
37
|
+
"@deepseek-ai/cordis": "^4.0.4"
|
|
38
|
+
},
|
|
39
|
+
"scripts": {
|
|
40
|
+
"build": "tsc -p tsconfig.build.json",
|
|
41
|
+
"typecheck": "tsc --noEmit"
|
|
42
|
+
},
|
|
43
|
+
"publishConfig": {
|
|
44
|
+
"access": "public"
|
|
45
|
+
}
|
|
46
|
+
}
|