@re-cinq/floor-contracts 0.1.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 +36 -0
- package/dist/definitions.d.ts +119 -0
- package/dist/definitions.js +3 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +2 -0
- package/dist/views.d.ts +102 -0
- package/dist/views.js +2 -0
- package/dist/wire.d.ts +107 -0
- package/dist/wire.js +2 -0
- package/package.json +55 -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 2026 re:cinq B.V.
|
|
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,36 @@
|
|
|
1
|
+
# @re-cinq/floor-contracts
|
|
2
|
+
|
|
3
|
+
The floor's wire, as types. What its HTTP routes and its live socket take and answer, and nothing else — no runtime, no dependencies. Installing it adds declarations and not one byte of code.
|
|
4
|
+
|
|
5
|
+
## Where this fits
|
|
6
|
+
|
|
7
|
+
One declaration, three readers: [`@floor/store`](../store/README.md) instantiates the row shapes and re-exports the rest, `apps/api` annotates its handlers with them, and [`@re-cinq/floor-client`](../client/README.md) reads them back off the wire. That is the point of the package — before it, the same shapes were written out four times, and the copies had already drifted apart: one omitted a git need's `access`, another omitted a visit's `iteration`, and a field the route renames on its way out was named nowhere at all.
|
|
8
|
+
|
|
9
|
+
It depends on nothing, which is what lets a published SDK depend on it. See [the map](../../README.md).
|
|
10
|
+
|
|
11
|
+
## The one rule
|
|
12
|
+
|
|
13
|
+
**A type belongs here only if its declaration is already valid JSON-after-parse.** No `Date`, no `Buffer`.
|
|
14
|
+
|
|
15
|
+
That rule is what keeps the package honest, and it is the thing to get wrong. A row the store keeps has `finishedAt: Date`; the same row on the wire has `finishedAt: string`, because hapi wrote it out. So a row is declared once, parameterised on its timestamp type, and read two ways:
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
export interface RunFields<Time> { /* … */ finishedAt: Time | null }
|
|
19
|
+
|
|
20
|
+
export type RunView = RunFields<string>; // here: what a client reads
|
|
21
|
+
export type Run = RunFields<Date>; // in @floor/store: what Postgres holds
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Never name a wire type `Run` or `Visit`. The `*View` suffix is the distinction, in the identifier where it cannot be missed. `apps/api/src/wire-contract.test-d.ts` holds the two sides together at compile time, asserting that jsonifying each row gives exactly its view — including every frame of the live socket.
|
|
25
|
+
|
|
26
|
+
## What is here
|
|
27
|
+
|
|
28
|
+
- `definitions.ts` — the bodies a floor is given: `LineBody`, `StationBody`, `AgentDefinitionBody`, `ScheduleBody`, and what they are made of (`Item`, `Report`, `NeedSpec`, `ProduceSpec`, `AgentSettings`, `ModelPrice`).
|
|
29
|
+
- `wire.ts` — what exists only on the wire: `Problem` (RFC 9457), `VisitBrief` and its `BriefNeed`, `BriefSettings` and `BriefConversation`, `ClaimedEvent`, `BlobRef`, `PutResult`, `GitCredential`, `MigrationBody`.
|
|
30
|
+
- `views.ts` — the row shapes and their views, and `LiveFrame`.
|
|
31
|
+
|
|
32
|
+
## Two names worth knowing
|
|
33
|
+
|
|
34
|
+
**`BriefConversation` says `sessionRef`; the store's `DispatchConversation` says `visitId`.** They are the same field. The route renames it on the way out, and until this package existed that rename was a translation buried in a handler with a name on neither side.
|
|
35
|
+
|
|
36
|
+
**`unsupported` is the one frame with no `seq`.** It is the floor's answer to anything a viewer says, and a client that says nothing never sees it.
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
export type ItemKind = "value" | "file" | "git";
|
|
2
|
+
export interface Item {
|
|
3
|
+
kind: ItemKind;
|
|
4
|
+
ref: string;
|
|
5
|
+
by: string;
|
|
6
|
+
sha?: string;
|
|
7
|
+
}
|
|
8
|
+
export interface Brief {
|
|
9
|
+
needs: Record<string, string>;
|
|
10
|
+
iteration: number;
|
|
11
|
+
}
|
|
12
|
+
export interface Report {
|
|
13
|
+
outcome: string;
|
|
14
|
+
produced?: Record<string, string>;
|
|
15
|
+
sessionRef?: string;
|
|
16
|
+
error?: string;
|
|
17
|
+
}
|
|
18
|
+
export interface LineArgSpec {
|
|
19
|
+
kind: ItemKind;
|
|
20
|
+
subject?: boolean;
|
|
21
|
+
}
|
|
22
|
+
/** What a `when` compares a payload field against: equality on its text form, nothing more. */
|
|
23
|
+
export type WhenValue = string | number | boolean;
|
|
24
|
+
export interface LineStart {
|
|
25
|
+
on: string[];
|
|
26
|
+
when?: Record<string, WhenValue>;
|
|
27
|
+
args: Record<string, string>;
|
|
28
|
+
}
|
|
29
|
+
export interface LineNodeReport {
|
|
30
|
+
on: string;
|
|
31
|
+
when?: Record<string, WhenValue>;
|
|
32
|
+
outcome: string;
|
|
33
|
+
}
|
|
34
|
+
export interface LineNode {
|
|
35
|
+
id: string;
|
|
36
|
+
/** Omitted for a marker; `name@hash` pins a version. */
|
|
37
|
+
station?: string;
|
|
38
|
+
/** Defaults to `node.<id>.start`. */
|
|
39
|
+
start?: string;
|
|
40
|
+
bind?: Record<string, string>;
|
|
41
|
+
reports?: LineNodeReport[];
|
|
42
|
+
}
|
|
43
|
+
export interface LineEdge {
|
|
44
|
+
from: string;
|
|
45
|
+
to: string;
|
|
46
|
+
on: string;
|
|
47
|
+
iterationMax?: number;
|
|
48
|
+
}
|
|
49
|
+
export interface LineBody {
|
|
50
|
+
entry: string;
|
|
51
|
+
exit: string;
|
|
52
|
+
start?: LineStart;
|
|
53
|
+
args: Record<string, LineArgSpec>;
|
|
54
|
+
/** Name -> blob hash, seeded into every run's bag at start. */
|
|
55
|
+
files?: Record<string, string>;
|
|
56
|
+
nodes: LineNode[];
|
|
57
|
+
edges: LineEdge[];
|
|
58
|
+
}
|
|
59
|
+
export type StationKind = "agent" | "service" | "human";
|
|
60
|
+
export interface NeedSpec {
|
|
61
|
+
name: string;
|
|
62
|
+
kind: ItemKind;
|
|
63
|
+
/** Agent kind only. */
|
|
64
|
+
path?: string;
|
|
65
|
+
/** `git` needs only; `read` is the default. */
|
|
66
|
+
access?: "read" | "write";
|
|
67
|
+
optional?: boolean;
|
|
68
|
+
}
|
|
69
|
+
export interface ProduceSpec {
|
|
70
|
+
name: string;
|
|
71
|
+
kind: "value" | "file";
|
|
72
|
+
path?: string;
|
|
73
|
+
/** Agent kind, `file` only: the file is what the agent said last, whole, and not something it wrote to `path`. How a prompt that answers in its output, as lore's do, hands that answer on. */
|
|
74
|
+
from?: "output";
|
|
75
|
+
}
|
|
76
|
+
export interface StationBody {
|
|
77
|
+
kind: StationKind;
|
|
78
|
+
/** Agent kind only. */
|
|
79
|
+
agentDefinition?: string;
|
|
80
|
+
conversation?: "new" | "continue";
|
|
81
|
+
conversationKey?: string;
|
|
82
|
+
outcomes: string[];
|
|
83
|
+
mustChange?: boolean;
|
|
84
|
+
needs: NeedSpec[];
|
|
85
|
+
produces: ProduceSpec[];
|
|
86
|
+
/** Service kind only. */
|
|
87
|
+
url?: string;
|
|
88
|
+
/** Human kind only. */
|
|
89
|
+
route?: string;
|
|
90
|
+
}
|
|
91
|
+
/** What a model costs, in US dollars for a million tokens. */
|
|
92
|
+
export interface ModelPrice {
|
|
93
|
+
inputPerMillion: number;
|
|
94
|
+
outputPerMillion: number;
|
|
95
|
+
/** For what was read from the cache, and written to it; the input price when not stated. */
|
|
96
|
+
cacheReadPerMillion?: number;
|
|
97
|
+
cacheWritePerMillion?: number;
|
|
98
|
+
}
|
|
99
|
+
export interface AgentSettings {
|
|
100
|
+
model?: string;
|
|
101
|
+
prompt: string;
|
|
102
|
+
image: string;
|
|
103
|
+
timeoutMinutes: number;
|
|
104
|
+
tags?: string[];
|
|
105
|
+
config?: Record<string, unknown>;
|
|
106
|
+
/** Model -> its price, for an agent that counts tokens and names no cost: the model it is given, and any it calls on the side. The floor holds no price of its own. */
|
|
107
|
+
prices?: Record<string, ModelPrice>;
|
|
108
|
+
}
|
|
109
|
+
export interface AgentDefinitionBody {
|
|
110
|
+
settings: AgentSettings;
|
|
111
|
+
/** `host/owner/name` -> a partial bundle merged over `settings`. */
|
|
112
|
+
variants?: Record<string, Partial<AgentSettings>>;
|
|
113
|
+
}
|
|
114
|
+
export interface ScheduleBody {
|
|
115
|
+
cron: string;
|
|
116
|
+
/** Defaults to UTC. */
|
|
117
|
+
timezone?: string;
|
|
118
|
+
payload: Record<string, unknown>;
|
|
119
|
+
}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
export type { AgentDefinitionBody, AgentSettings, Brief, Item, ItemKind, LineArgSpec, LineBody, LineEdge, LineNode, LineNodeReport, LineStart, ModelPrice, NeedSpec, ProduceSpec, Report, ScheduleBody, StationBody, StationKind, WhenValue, } from "./definitions.js";
|
|
2
|
+
export type { BlobRef, BriefConversation, BriefNeed, BriefSettings, ClaimedEvent, DefinitionKind, ExecutorSettings, FileNeed, GitCredential, GitNeed, McpServerSettings, MigrationBody, Problem, PutResult, ValueNeed, VisitBrief, } from "./wire.js";
|
|
3
|
+
export type { CostsRow, DefinitionRowFields, DefinitionRowView, FloorEventFields, FloorEventView, LiveFrame, RecordKind, RunFields, RunView, StationRunRecordFields, StationRunRecordView, VisitFields, VisitView, } from "./views.js";
|
package/dist/index.js
ADDED
package/dist/views.d.ts
ADDED
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
import type { AgentSettings, Brief, Item, Report } from "./definitions.js";
|
|
2
|
+
export interface RunFields<Time> {
|
|
3
|
+
id: string;
|
|
4
|
+
lineId: string;
|
|
5
|
+
lineHash: string;
|
|
6
|
+
repo: string;
|
|
7
|
+
subjectKey: string | null;
|
|
8
|
+
startItems: Record<string, Item>;
|
|
9
|
+
outcome: string | null;
|
|
10
|
+
reason: string | null;
|
|
11
|
+
finishedAt: Time | null;
|
|
12
|
+
}
|
|
13
|
+
export interface VisitFields<Time> {
|
|
14
|
+
id: string;
|
|
15
|
+
runId: string;
|
|
16
|
+
nodeId: string;
|
|
17
|
+
iteration: number;
|
|
18
|
+
stationHash: string | null;
|
|
19
|
+
agentDefinitionHash: string | null;
|
|
20
|
+
brief: Brief;
|
|
21
|
+
report: Report | null;
|
|
22
|
+
worker: string | null;
|
|
23
|
+
requestedBy: string | null;
|
|
24
|
+
deadline: Time | null;
|
|
25
|
+
/** The previous visit's sessionRef, for an executor restoring a conversation. Beyond the public Brief a station author sees: this is the executor's own lookup, resolved once so it is not repeated. */
|
|
26
|
+
resumedFrom: string | null;
|
|
27
|
+
/** The resolved agent settings bundle, for an executor building the CR. */
|
|
28
|
+
agentSettings: AgentSettings | null;
|
|
29
|
+
}
|
|
30
|
+
export interface FloorEventFields<Time> {
|
|
31
|
+
id: string;
|
|
32
|
+
name: string;
|
|
33
|
+
payload: unknown;
|
|
34
|
+
dedupeKey: string | null;
|
|
35
|
+
tags: string[];
|
|
36
|
+
runId: string | null;
|
|
37
|
+
availableAt: Time;
|
|
38
|
+
createdAt: Time;
|
|
39
|
+
claimedAt: Time | null;
|
|
40
|
+
claimedBy: string | null;
|
|
41
|
+
ackedAt: Time | null;
|
|
42
|
+
attempts: number;
|
|
43
|
+
lastError: string | null;
|
|
44
|
+
deadAt: Time | null;
|
|
45
|
+
droppedAt: Time | null;
|
|
46
|
+
}
|
|
47
|
+
/** `produced` and `session` are the sink's own notes on a visit still running; only the first three may be posted. */
|
|
48
|
+
export type RecordKind = "log" | "turn" | "llm_call" | "produced" | "session";
|
|
49
|
+
export interface StationRunRecordFields<Time> {
|
|
50
|
+
visitId: string;
|
|
51
|
+
kind: RecordKind;
|
|
52
|
+
seq: number;
|
|
53
|
+
body: unknown;
|
|
54
|
+
occurredAt: Time;
|
|
55
|
+
}
|
|
56
|
+
export interface DefinitionRowFields<Body, Time> {
|
|
57
|
+
kind: string;
|
|
58
|
+
id: string;
|
|
59
|
+
hash: string;
|
|
60
|
+
body: Body;
|
|
61
|
+
archivedAt: Time | null;
|
|
62
|
+
createdBy: string | null;
|
|
63
|
+
createdAt: Time;
|
|
64
|
+
}
|
|
65
|
+
export interface CostsRow {
|
|
66
|
+
key: string | null;
|
|
67
|
+
costUsd: number;
|
|
68
|
+
tokensIn: number;
|
|
69
|
+
tokensOut: number;
|
|
70
|
+
/** Grouped by model, a visit is counted under each model it called. */
|
|
71
|
+
visits: number;
|
|
72
|
+
visitsMissingCost: number;
|
|
73
|
+
/** The models that counted tokens in these visits and had no price stated, so their part is not in the cost. */
|
|
74
|
+
unpriced: string[];
|
|
75
|
+
}
|
|
76
|
+
export type RunView = RunFields<string>;
|
|
77
|
+
export type VisitView = VisitFields<string>;
|
|
78
|
+
export type FloorEventView = FloorEventFields<string>;
|
|
79
|
+
export type StationRunRecordView = StationRunRecordFields<string>;
|
|
80
|
+
export type DefinitionRowView<Body> = DefinitionRowFields<Body, string>;
|
|
81
|
+
/** One frame of `GET /assembly-runs/:id/live`. Every frame but `unsupported` carries the `seq` to come back with. */
|
|
82
|
+
export type LiveFrame = {
|
|
83
|
+
type: "record";
|
|
84
|
+
seq: number;
|
|
85
|
+
visitId: string;
|
|
86
|
+
nodeId: string;
|
|
87
|
+
iteration: number;
|
|
88
|
+
record: StationRunRecordView;
|
|
89
|
+
} | {
|
|
90
|
+
type: "visit_opened" | "visit_reported";
|
|
91
|
+
seq: number;
|
|
92
|
+
visit: VisitView;
|
|
93
|
+
} | {
|
|
94
|
+
type: "run_settled";
|
|
95
|
+
seq: number;
|
|
96
|
+
run: RunView;
|
|
97
|
+
} | {
|
|
98
|
+
type: "caught_up";
|
|
99
|
+
seq: number;
|
|
100
|
+
} | {
|
|
101
|
+
type: "unsupported";
|
|
102
|
+
};
|
package/dist/views.js
ADDED
package/dist/wire.d.ts
ADDED
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
import type { ProduceSpec } from "./definitions.js";
|
|
2
|
+
/** RFC 9457. Every error a floor answers is one of these, as `application/problem+json`. */
|
|
3
|
+
export interface Problem {
|
|
4
|
+
/** `about:blank` today. Typed wide so a floor may name its own problems later without breaking a client. */
|
|
5
|
+
type: string;
|
|
6
|
+
title: string;
|
|
7
|
+
status: number;
|
|
8
|
+
detail?: string;
|
|
9
|
+
/** What a 400 lists when a body failed to parse, one sentence a field. */
|
|
10
|
+
errors?: string[];
|
|
11
|
+
}
|
|
12
|
+
export interface ValueNeed {
|
|
13
|
+
name: string;
|
|
14
|
+
kind: "value";
|
|
15
|
+
value: string;
|
|
16
|
+
}
|
|
17
|
+
export interface FileNeed {
|
|
18
|
+
name: string;
|
|
19
|
+
kind: "file";
|
|
20
|
+
path: string;
|
|
21
|
+
url: string;
|
|
22
|
+
}
|
|
23
|
+
/** The floor states intent, never a credential: git asks the floor for one when it needs it. */
|
|
24
|
+
export interface GitNeed {
|
|
25
|
+
name: string;
|
|
26
|
+
kind: "git";
|
|
27
|
+
path: string;
|
|
28
|
+
repoUrl: string;
|
|
29
|
+
ref: string;
|
|
30
|
+
access: "read" | "write";
|
|
31
|
+
}
|
|
32
|
+
/** One thing a visit was promised, resolved: a value is its text, a file and a repository are places to read. */
|
|
33
|
+
export type BriefNeed = ValueNeed | FileNeed | GitNeed;
|
|
34
|
+
/** `sessionRef` names the conversation this visit continues. The store calls the same field `visitId`; the route renames it on the way out, and this is the name a client sees. */
|
|
35
|
+
export type BriefConversation = {
|
|
36
|
+
mode: "new";
|
|
37
|
+
save: boolean;
|
|
38
|
+
} | {
|
|
39
|
+
mode: "continue";
|
|
40
|
+
sessionRef: string;
|
|
41
|
+
};
|
|
42
|
+
export interface McpServerSettings {
|
|
43
|
+
name: string;
|
|
44
|
+
transport: "stdio" | "http" | "sse";
|
|
45
|
+
command?: string;
|
|
46
|
+
args?: string[];
|
|
47
|
+
url?: string;
|
|
48
|
+
headersSecret?: string;
|
|
49
|
+
}
|
|
50
|
+
/** An agent definition's `config`, under the names the wire uses rather than the snake_case a definition is authored in. */
|
|
51
|
+
export interface ExecutorSettings {
|
|
52
|
+
disallowedTools?: string[];
|
|
53
|
+
skills?: string[];
|
|
54
|
+
skillsSource?: string;
|
|
55
|
+
mcpServers?: McpServerSettings[];
|
|
56
|
+
env?: Record<string, string>;
|
|
57
|
+
permissionMode?: "auto" | "bypass";
|
|
58
|
+
maxTurns?: number;
|
|
59
|
+
}
|
|
60
|
+
export type BriefSettings = ExecutorSettings & {
|
|
61
|
+
model?: string;
|
|
62
|
+
prompt: string;
|
|
63
|
+
image: string;
|
|
64
|
+
};
|
|
65
|
+
/** `GET /station-runs/:id/brief`: everything an executor needs to run one visit, and a token that reaches only this visit. */
|
|
66
|
+
export interface VisitBrief {
|
|
67
|
+
visitId: string;
|
|
68
|
+
iteration: number;
|
|
69
|
+
floorBaseUrl: string;
|
|
70
|
+
token: string;
|
|
71
|
+
deadlineMinutes: number;
|
|
72
|
+
settings: BriefSettings | null;
|
|
73
|
+
needs: BriefNeed[];
|
|
74
|
+
produces: ProduceSpec[];
|
|
75
|
+
conversation: BriefConversation;
|
|
76
|
+
modelSecretKey?: string;
|
|
77
|
+
}
|
|
78
|
+
/** `POST /events/claim` answers only the two events a worker may take, and both name the visit they are about. */
|
|
79
|
+
export interface ClaimedEvent {
|
|
80
|
+
id: string;
|
|
81
|
+
name: "station_run.dispatch" | "station_run.abort";
|
|
82
|
+
payload: {
|
|
83
|
+
visitId: string;
|
|
84
|
+
};
|
|
85
|
+
tags: string[];
|
|
86
|
+
attempts: number;
|
|
87
|
+
}
|
|
88
|
+
/** What a floor answers for bytes it now keeps: `POST /blobs`, and a saved conversation. */
|
|
89
|
+
export interface BlobRef {
|
|
90
|
+
hash: string;
|
|
91
|
+
size: number;
|
|
92
|
+
}
|
|
93
|
+
export interface PutResult {
|
|
94
|
+
hash: string;
|
|
95
|
+
/** False when the same body was already there under the same hash. */
|
|
96
|
+
created: boolean;
|
|
97
|
+
}
|
|
98
|
+
export type DefinitionKind = "line" | "station" | "agent_definition" | "schedule" | "migration";
|
|
99
|
+
/** A migration is named by its file and known by what that file said, so the same name with different content is refused. */
|
|
100
|
+
export interface MigrationBody {
|
|
101
|
+
sha256: string;
|
|
102
|
+
}
|
|
103
|
+
/** What git's credential helper reads. The floor mints none of these itself; it asks the provider it was given. */
|
|
104
|
+
export interface GitCredential {
|
|
105
|
+
username: string;
|
|
106
|
+
password: string;
|
|
107
|
+
}
|
package/dist/wire.js
ADDED
package/package.json
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@re-cinq/floor-contracts",
|
|
3
|
+
"version": "0.1.2",
|
|
4
|
+
"description": "The floor's wire, as types: what its HTTP routes and its live socket take and answer, and nothing else. No runtime, no dependencies.",
|
|
5
|
+
"license": "Apache-2.0",
|
|
6
|
+
"repository": {
|
|
7
|
+
"type": "git",
|
|
8
|
+
"url": "git+https://github.com/re-cinq/floor.git",
|
|
9
|
+
"directory": "packages/contracts"
|
|
10
|
+
},
|
|
11
|
+
"homepage": "https://github.com/re-cinq/floor/tree/main/packages/contracts#readme",
|
|
12
|
+
"bugs": {
|
|
13
|
+
"url": "https://github.com/re-cinq/floor/issues"
|
|
14
|
+
},
|
|
15
|
+
"keywords": [
|
|
16
|
+
"floor",
|
|
17
|
+
"contracts",
|
|
18
|
+
"types",
|
|
19
|
+
"orchestration",
|
|
20
|
+
"agents"
|
|
21
|
+
],
|
|
22
|
+
"type": "module",
|
|
23
|
+
"main": "dist/index.js",
|
|
24
|
+
"types": "dist/index.d.ts",
|
|
25
|
+
"exports": {
|
|
26
|
+
".": {
|
|
27
|
+
"types": "./dist/index.d.ts",
|
|
28
|
+
"default": "./dist/index.js"
|
|
29
|
+
}
|
|
30
|
+
},
|
|
31
|
+
"files": [
|
|
32
|
+
"dist",
|
|
33
|
+
"!dist/**/*.map"
|
|
34
|
+
],
|
|
35
|
+
"sideEffects": false,
|
|
36
|
+
"engines": {
|
|
37
|
+
"node": ">=22"
|
|
38
|
+
},
|
|
39
|
+
"publishConfig": {
|
|
40
|
+
"access": "public"
|
|
41
|
+
},
|
|
42
|
+
"scripts": {
|
|
43
|
+
"build": "tsc -p tsconfig.build.json",
|
|
44
|
+
"dev": "tsc --watch -p tsconfig.build.json",
|
|
45
|
+
"test": "vitest run --passWithNoTests",
|
|
46
|
+
"test:watch": "vitest",
|
|
47
|
+
"typecheck": "tsc --noEmit"
|
|
48
|
+
},
|
|
49
|
+
"devDependencies": {
|
|
50
|
+
"@types/node": "^22.20.1",
|
|
51
|
+
"@vitest/coverage-v8": "^5.0.0",
|
|
52
|
+
"typescript": "^7.0.2",
|
|
53
|
+
"vitest": "^5.0.0"
|
|
54
|
+
}
|
|
55
|
+
}
|