@volter/twin-runhuman 0.1.0
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 +202 -0
- package/README.md +81 -0
- package/dist/src/cli.d.ts +2 -0
- package/dist/src/cli.js +25 -0
- package/dist/src/index.d.ts +8 -0
- package/dist/src/index.js +44 -0
- package/dist/src/runhuman-budget.d.ts +23 -0
- package/dist/src/runhuman-budget.js +45 -0
- package/dist/src/runhuman-capabilities.d.ts +7 -0
- package/dist/src/runhuman-capabilities.js +451 -0
- package/dist/src/runhuman-conformance.d.ts +10 -0
- package/dist/src/runhuman-conformance.js +11 -0
- package/dist/src/runhuman-connector.d.ts +32 -0
- package/dist/src/runhuman-connector.js +58 -0
- package/dist/src/runhuman-server.d.ts +13 -0
- package/dist/src/runhuman-server.js +25 -0
- package/dist/src/runhuman-twin.d.ts +16 -0
- package/dist/src/runhuman-twin.js +1162 -0
- package/dist/src/runhuman-validate.d.ts +40 -0
- package/dist/src/runhuman-validate.js +161 -0
- package/package.json +51 -0
- package/src/cli.ts +24 -0
- package/src/index.ts +61 -0
- package/src/runhuman-budget.ts +66 -0
- package/src/runhuman-capabilities.ts +470 -0
- package/src/runhuman-conformance.ts +14 -0
- package/src/runhuman-connector.ts +67 -0
- package/src/runhuman-server.ts +32 -0
- package/src/runhuman-twin.ts +1078 -0
- package/src/runhuman-validate.ts +185 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
# @volter/twin-runhuman
|
|
2
|
+
|
|
3
|
+
Local twin of **Runhuman 1** (RH1, `runhuman.com/api`), the human-QA marketplace: a customer posts a
|
|
4
|
+
job, a tester claims it, tests, submits, and the job completes with a cost. Built on the shared
|
|
5
|
+
`@volter/world-core` kernel; every write is an action in the kernel log.
|
|
6
|
+
|
|
7
|
+
The vendor is our own product, so RH1's source is the specification: `volter-ai/runhuman`,
|
|
8
|
+
read at `2f2fcb2c5` (`packages/api/src/routes/jobs/**`, `routes/projects.routes.ts`,
|
|
9
|
+
`middleware/*auth*.ts`, `packages/shared/src/contracts/{job,tester-job}.schema.ts`). The file header
|
|
10
|
+
of `src/runhuman-twin.ts` maps every route to its RH1 source file.
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
bun packages/twin/runhuman/src/cli.ts serve --port 47311 --root <world-dir>
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
A world points RH1 clients at the twin through `RUNHUMAN_API_URL` (the RH1 CLI's base-URL
|
|
17
|
+
override). RH2 reads its `human-marketplace` provider's `spec.url` instead; set it to the same URL.
|
|
18
|
+
|
|
19
|
+
## Seeding a world
|
|
20
|
+
|
|
21
|
+
RH1 creates organizations, projects, API keys and tester profiles outside the job API (dashboard,
|
|
22
|
+
Clerk webhooks, admin approval). The twin seeds them through twin-only routes a real client never
|
|
23
|
+
calls:
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
curl -X POST $URL/_twin/organizations -d '{"id":"org-1","name":"Acme"}'
|
|
27
|
+
curl -X POST $URL/_twin/projects -d '{"id":"proj-1","organizationId":"org-1","name":"Web"}'
|
|
28
|
+
curl -X POST $URL/_twin/api-keys -d '{"organizationId":"org-1","key":"rh_…"}' # key minted when omitted
|
|
29
|
+
curl -X POST $URL/_twin/testers -d '{"email":"tess@x.test","alias":"tess"}' # → "Bearer clerk_tess@x.test"
|
|
30
|
+
curl -X POST $URL/_twin/settings -d '{"jwtSecret":"…"}' # testerToken signing secret; minted from entropy when never seeded
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
A seed makes a subject and never replaces one: an organization, project or API key whose `id` (or key) is already held
|
|
34
|
+
answers 409 `{error}`.
|
|
35
|
+
|
|
36
|
+
Web users (the tester side) authenticate in RH1's Clerk mock-mode form `Bearer clerk_<email>`.
|
|
37
|
+
|
|
38
|
+
## Coverage
|
|
39
|
+
|
|
40
|
+
`src/runhuman-capabilities.ts` enumerates RH1's surface at `2f2fcb2c5`: the public REST reference
|
|
41
|
+
(`packages/static-site/src/content/docs/api.mdx`), the jobs router, the customer-API allowlist and
|
|
42
|
+
the project job list. **92 capabilities: 16 done, 76 todo.** Every `done` has a `verify()` that
|
|
43
|
+
drives the twin on a fresh root and checks RH1's statuses, bodies and refusals.
|
|
44
|
+
|
|
45
|
+
Modelled, with RH1's exact shapes, statuses and refusal bodies:
|
|
46
|
+
|
|
47
|
+
- `POST /api/jobs` — body validation (RH1's zod schema, Fastify `FST_ERR_VALIDATION` envelope),
|
|
48
|
+
API-key / web-user auth, project resolution and access, URL and session-limit checks, the
|
|
49
|
+
external-capture desktop rule, the per-org active-job cap (12), `201 {jobId, message}`.
|
|
50
|
+
- `GET /api/jobs/:jobId` (enriched + result-gated) and `GET /api/jobs/:jobId/status`.
|
|
51
|
+
- `GET /api/projects/:projectId/jobs` (limit/offset pagination, customer list columns).
|
|
52
|
+
- The tester lifecycle: `POST /api/jobs/:jobId/claim` (claim gate, pool requirements, surface
|
|
53
|
+
rules, HS256 testerToken), `GET|PATCH /api/tester/jobs/:jobId`,
|
|
54
|
+
`POST …/process-results`, `GET …/processing/:processingJobId`, `POST …/issue-review`
|
|
55
|
+
(`continue`), `POST …/end` (release / cancel / platform issue), completion with RH1's cost
|
|
56
|
+
(`$0.0085/s` over the tester window, capped at the allotted time).
|
|
57
|
+
|
|
58
|
+
Where RH1 runs a worker or a model:
|
|
59
|
+
|
|
60
|
+
- **Results pipeline.** RH1 queues an AI run on BullMQ. The twin runs it when the status is
|
|
61
|
+
first polled: extract keeps the tester's submitted `result` and extracts no issues or
|
|
62
|
+
feedback; finalize sets `passStatus` from `result.data.success` (true → `pass`, false → `fail`,
|
|
63
|
+
otherwise `not_applicable`).
|
|
64
|
+
- **Timers.** The release throttle (`pending → queued → waiting`), claim-window expiry,
|
|
65
|
+
no-response timeout and `overdue` run on timers in RH1. The twin runs none, so a job stays
|
|
66
|
+
`pending` until claimed.
|
|
67
|
+
- **Billing.** Funds are never reserved at creation. RH1's billing queue settles a completed
|
|
68
|
+
job's charge and records `billedAt`, `billedAmountCents` and `billingIdempotencyKey` on the job.
|
|
69
|
+
The twin runs no queue, so the charge settles when the job completes.
|
|
70
|
+
- Instruction validation (an LLM) and the URL safety check accept every input.
|
|
71
|
+
|
|
72
|
+
Not modelled. These answer RH1's JSON 404 `{"error":"Not found"}` with an `x-twin-gap` header,
|
|
73
|
+
never a fabricated success: templates, PR/issue test plans, KB enhancement, GitHub repos,
|
|
74
|
+
`outputSchema`, attachments, sideload/social-video tiers, issue-tracker integrations,
|
|
75
|
+
`issue-review` `reprocess`, and every other RH1 route (job list, rerun, share, artifacts, …).
|
|
76
|
+
|
|
77
|
+
### No UI mirror
|
|
78
|
+
|
|
79
|
+
RH1's customers post jobs from code (the CLI, the GitHub Action, RH2's marketplace performer).
|
|
80
|
+
The tester web app is RH1's own worker product. Its core loop is the tester API this twin
|
|
81
|
+
serves, so there is no dashboard mirror.
|
package/dist/src/cli.js
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import { keepProcessAlive } from '@volter/world-core/lifecycle';
|
|
3
|
+
// world-runhuman CLI: serve the KERNEL-BACKED Runhuman 1 API twin, or run conformance. State lives
|
|
4
|
+
// in the @volter/world-core action log under --root. Conformance is dev-only + lazy-imported.
|
|
5
|
+
import { hasFlag, optionValue } from '@volter/world-core/args';
|
|
6
|
+
import { createRunhumanTwinServer } from "./runhuman-server.js";
|
|
7
|
+
const [cmd, ...rest] = process.argv.slice(2);
|
|
8
|
+
const port = Number(optionValue(rest, '--port', String(process.env.PORT ?? '0'))) || undefined;
|
|
9
|
+
const root = optionValue(rest, '--root') || process.env.VOLTER_STATE_DIR || undefined;
|
|
10
|
+
const readOnly = hasFlag(rest, '--read-only');
|
|
11
|
+
if (cmd === 'serve' || cmd === undefined) {
|
|
12
|
+
const s = await createRunhumanTwinServer({ readOnly, ...(root ? { root } : {}), ...(port ? { port } : {}) });
|
|
13
|
+
process.stdout.write(`runhuman twin (Runhuman 1 jobs API + tester lifecycle)${readOnly ? ' [read-only]' : ''} at http://127.0.0.1:${s.port}\n`);
|
|
14
|
+
await keepProcessAlive();
|
|
15
|
+
}
|
|
16
|
+
else if (cmd === 'conformance') {
|
|
17
|
+
const { checkRunhumanConformance } = await import("./runhuman-conformance.js");
|
|
18
|
+
const report = await checkRunhumanConformance(root ? { root } : {});
|
|
19
|
+
process.stdout.write(`${JSON.stringify(report, null, 2)}\n`);
|
|
20
|
+
if (!report.ok)
|
|
21
|
+
process.exitCode = 1;
|
|
22
|
+
}
|
|
23
|
+
else {
|
|
24
|
+
process.stdout.write('Usage: world-runhuman serve|conformance [--port N] [--root DIR] [--read-only]\n');
|
|
25
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type { TwinPack } from '@volter/world-core';
|
|
2
|
+
export { handleRunhumanTwinRequest, RUNHUMAN_RESOURCE_TYPES } from './runhuman-twin.js';
|
|
3
|
+
export type { RunhumanTwinRequest, RunhumanTwinResponse } from './runhuman-twin.js';
|
|
4
|
+
export { createRunhumanTwinFetch, createRunhumanTwinServer } from './runhuman-server.js';
|
|
5
|
+
export { liveRunhumanExecute, syncRunhumanFromReal, RUNHUMAN_API_BASE } from './runhuman-connector.js';
|
|
6
|
+
export { RUNHUMAN_BUDGET_CEILING, RUNHUMAN_BUDGET_MAX_RETRY_AFTER_S, RUNHUMAN_BUDGET_WINDOW_MS, RUNHUMAN_CALL_WEIGHTS, RUNHUMAN_RATE_BUDGET, RunhumanBudget, RunhumanBudgetError, runhumanBudgetPath, runhumanCallWeight, } from './runhuman-budget.js';
|
|
7
|
+
export type { RunhumanBudgetErrorKind, RunhumanBudgetOptions, RunhumanBudgetReservation, RunhumanBudgetSnapshot } from './runhuman-budget.js';
|
|
8
|
+
export declare const pack: TwinPack;
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
export { handleRunhumanTwinRequest, RUNHUMAN_RESOURCE_TYPES } from "./runhuman-twin.js";
|
|
2
|
+
export { createRunhumanTwinFetch, createRunhumanTwinServer } from "./runhuman-server.js";
|
|
3
|
+
export { liveRunhumanExecute, syncRunhumanFromReal, RUNHUMAN_API_BASE } from "./runhuman-connector.js";
|
|
4
|
+
export { RUNHUMAN_BUDGET_CEILING, RUNHUMAN_BUDGET_MAX_RETRY_AFTER_S, RUNHUMAN_BUDGET_WINDOW_MS, RUNHUMAN_CALL_WEIGHTS, RUNHUMAN_RATE_BUDGET, RunhumanBudget, RunhumanBudgetError, runhumanBudgetPath, runhumanCallWeight, } from "./runhuman-budget.js";
|
|
5
|
+
import { RUNHUMAN_RATE_BUDGET as RATE_BUDGET } from "./runhuman-budget.js";
|
|
6
|
+
// Registry descriptor (TwinPack) — the pack self-describes so tooling can discover it, and it is
|
|
7
|
+
// the SINGLE HOME for this vendor's world-facing facts. `bun scripts/pack-facts.ts` compiles
|
|
8
|
+
// `adoption` / `hosts` / `endpointEnv` into packages/world-core/generated/pack-facts.json;
|
|
9
|
+
// re-run it after ANY edit below or the drift gate (scripts/pack-facts.test.ts) goes RED.
|
|
10
|
+
export const pack = {
|
|
11
|
+
vendor: 'runhuman',
|
|
12
|
+
transport: 'rest',
|
|
13
|
+
protocol: '2', // the platform protocol major this package targets (runtime contract R16)
|
|
14
|
+
// The branch round trip: an organization, its project and an API key seeded (RH1 has no public API that makes them;
|
|
15
|
+
// the seeds refuse an id already held, so the branch's re-seed is refused and changes nothing), then a job created
|
|
16
|
+
// through RH1's own API, the write a branch repeats (each create is a new job).
|
|
17
|
+
roundTrip: [
|
|
18
|
+
{ method: 'POST', path: '/_twin/organizations', body: { id: 'roundtrip-org', name: 'Round Trip' } },
|
|
19
|
+
{ method: 'POST', path: '/_twin/projects', body: { id: 'roundtrip-proj', organizationId: 'roundtrip-org', name: 'Round Trip' } },
|
|
20
|
+
{ method: 'POST', path: '/_twin/api-keys', body: { id: 'roundtrip-key', organizationId: 'roundtrip-org', key: 'rh_roundtripkey' } },
|
|
21
|
+
{ method: 'POST', path: '/api/jobs', body: { projectId: 'roundtrip-proj', url: 'https://round.trip.test/', description: 'round trip' }, headers: { authorization: 'Bearer rh_roundtripkey' } },
|
|
22
|
+
],
|
|
23
|
+
archetype: 'crud',
|
|
24
|
+
bin: 'world-runhuman',
|
|
25
|
+
rateBudget: RATE_BUDGET,
|
|
26
|
+
resources: ['organization', 'project', 'api_key', 'user', 'tester_profile', 'job', 'pipeline_run'],
|
|
27
|
+
specSource: 'RH1 source at volter-ai/runhuman origin/main 2f2fcb2c5 — packages/api/src/routes/jobs/** (create/get/claim/tester handlers), routes/projects.routes.ts, middleware/{auth,dual-auth,clerk-auth}.ts, packages/shared/src/contracts/{job,tester-job}.schema.ts; the vendor is our own product, so its source is the specification (no published OpenAPI).',
|
|
28
|
+
description: 'Runhuman 1 (runhuman.com/api) jobs twin — POST /api/jobs, GET /api/jobs/:id(/status), GET /api/projects/:id/jobs, the tester lifecycle (claim → testerToken PATCH → process-results → issue-review → complete, or end), RH1-exact refusals; the AI pipeline is folded into the status poll, timers and integrations are unmodelled (JSON 404 with x-twin-gap). Kernel-backed, no mirror.',
|
|
29
|
+
// ADOPTION — the RH1 CLI (npm `runhuman`, packages/cli) is the first-party client of this surface.
|
|
30
|
+
// No envStem and no scope: RH2 ships under the same brand (`RUNHUMAN`, `@runhuman/`), so a
|
|
31
|
+
// stem here would attribute RH2's code to RH1.
|
|
32
|
+
adoption: {
|
|
33
|
+
sdks: ['runhuman'],
|
|
34
|
+
},
|
|
35
|
+
// INTERCEPTION — RH1 serves its API under runhuman.com/api (the CLI's default apiUrl is
|
|
36
|
+
// https://runhuman.com; packages/cli/src/commands/auth/login.ts). Only /api/* is this twin's.
|
|
37
|
+
hosts: [{ host: 'runhuman.com', pathPattern: '^/api/' }],
|
|
38
|
+
// WORLD WIRING — the RH1 CLI reads RUNHUMAN_API_URL as its base URL
|
|
39
|
+
// (packages/cli/src/lib/config.ts: `if (process.env.RUNHUMAN_API_URL) config.apiUrl = …`).
|
|
40
|
+
endpointEnv: {
|
|
41
|
+
name: 'RUNHUMAN_API_URL',
|
|
42
|
+
note: 'grounded in volter-ai/runhuman packages/cli/src/lib/config.ts, which overrides the CLI apiUrl from RUNHUMAN_API_URL; RH2 reads its human-marketplace base URL from the provider row spec.url instead, which a rehearsal World sets to this same twin URL.',
|
|
43
|
+
},
|
|
44
|
+
};
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { RateBudget, type RateBudgetDeclaration, type RateBudgetOptions, type RateBudgetReservation, type RateBudgetSnapshot } from '@volter/world-core';
|
|
2
|
+
export declare const RUNHUMAN_BUDGET_WINDOW_MS = 60000;
|
|
3
|
+
export declare const RUNHUMAN_BUDGET_CEILING = 60;
|
|
4
|
+
export declare const RUNHUMAN_BUDGET_MAX_RETRY_AFTER_S = 300;
|
|
5
|
+
export declare const RUNHUMAN_CALL_WEIGHTS: {
|
|
6
|
+
readonly createJob: 5;
|
|
7
|
+
readonly mutation: 3;
|
|
8
|
+
readonly read: 2;
|
|
9
|
+
};
|
|
10
|
+
export declare const RUNHUMAN_RATE_BUDGET: RateBudgetDeclaration;
|
|
11
|
+
export declare function runhumanCallWeight(method: string, path: string): number;
|
|
12
|
+
export declare function runhumanBudgetPath(opts?: {
|
|
13
|
+
root?: string;
|
|
14
|
+
token?: string;
|
|
15
|
+
} | string): string;
|
|
16
|
+
export type RunhumanBudgetOptions = Omit<RateBudgetOptions, 'vendor'>;
|
|
17
|
+
export declare class RunhumanBudget extends RateBudget {
|
|
18
|
+
constructor(opts?: RunhumanBudgetOptions);
|
|
19
|
+
}
|
|
20
|
+
export type { RateBudgetErrorKind as RunhumanBudgetErrorKind } from '@volter/world-core';
|
|
21
|
+
export { RateBudgetError as RunhumanBudgetError } from '@volter/world-core';
|
|
22
|
+
export type RunhumanBudgetReservation = RateBudgetReservation;
|
|
23
|
+
export type RunhumanBudgetSnapshot = RateBudgetSnapshot;
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
// Runhuman client-side rate budget. The mechanism is the kernel's shared RateBudget; only
|
|
2
|
+
// Runhuman's declaration lives here.
|
|
3
|
+
//
|
|
4
|
+
// Vendor source (Runhuman is our own product; read-only checkout of volter-ai/runhuman):
|
|
5
|
+
// packages/static-site/src/content/docs/api.mdx "Rate Limiting" and docs/rate-limiting.md. The API
|
|
6
|
+
// enforces two PER-IP tiers: 200 requests/minute per route pattern and 500 requests/minute across
|
|
7
|
+
// all routes, answering 429 with Retry-After past either. Both are per-IP, not per-API-key, so
|
|
8
|
+
// callers behind one egress IP share them — a per-key ledger cannot see that sharing. This
|
|
9
|
+
// declaration therefore stays AT the kernel fallback, far under both published tiers: 60 weighted
|
|
10
|
+
// units per minute; reads cost 2 (30/min), writes 3 (20/min), and job creation 5 (12/min) because
|
|
11
|
+
// every POST /api/jobs dispatches a PAID human tester.
|
|
12
|
+
import { declareRateBudget, rateBudgetPath, rateBudgetWeight, RateBudget, } from '@volter/world-core';
|
|
13
|
+
const VENDOR = 'runhuman';
|
|
14
|
+
export const RUNHUMAN_BUDGET_WINDOW_MS = 60_000;
|
|
15
|
+
export const RUNHUMAN_BUDGET_CEILING = 60;
|
|
16
|
+
export const RUNHUMAN_BUDGET_MAX_RETRY_AFTER_S = 300;
|
|
17
|
+
export const RUNHUMAN_CALL_WEIGHTS = { createJob: 5, mutation: 3, read: 2 };
|
|
18
|
+
export const RUNHUMAN_RATE_BUDGET = {
|
|
19
|
+
windowMs: RUNHUMAN_BUDGET_WINDOW_MS,
|
|
20
|
+
ceiling: RUNHUMAN_BUDGET_CEILING,
|
|
21
|
+
defaultWeight: RUNHUMAN_CALL_WEIGHTS.read,
|
|
22
|
+
maxRetryAfterSeconds: RUNHUMAN_BUDGET_MAX_RETRY_AFTER_S,
|
|
23
|
+
rules: [
|
|
24
|
+
{ match: '^POST /api/jobs$', weight: RUNHUMAN_CALL_WEIGHTS.createJob },
|
|
25
|
+
{ match: '^(POST|PUT|PATCH|DELETE) ', weight: RUNHUMAN_CALL_WEIGHTS.mutation },
|
|
26
|
+
],
|
|
27
|
+
reason: 'Runhuman documents two per-IP limits (volter-ai/runhuman api.mdx "Rate Limiting", docs/rate-limiting.md): ' +
|
|
28
|
+
'200 requests/minute per route and 500 requests/minute aggregate, 429 + Retry-After past them. Per-IP, not ' +
|
|
29
|
+
'per-key, so a per-key ledger stays at the kernel fallback, well under both: 60 weighted units per minute; ' +
|
|
30
|
+
'reads 2, writes 3, job creation 5 (each dispatches a paid human tester).',
|
|
31
|
+
};
|
|
32
|
+
declareRateBudget(VENDOR, RUNHUMAN_RATE_BUDGET);
|
|
33
|
+
export function runhumanCallWeight(method, path) {
|
|
34
|
+
return rateBudgetWeight(VENDOR, `${method.toUpperCase()} ${path.split('?')[0] ?? path}`);
|
|
35
|
+
}
|
|
36
|
+
export function runhumanBudgetPath(opts = {}) {
|
|
37
|
+
const value = typeof opts === 'string' ? { root: opts } : opts;
|
|
38
|
+
return rateBudgetPath({ ...value, vendor: VENDOR });
|
|
39
|
+
}
|
|
40
|
+
export class RunhumanBudget extends RateBudget {
|
|
41
|
+
constructor(opts = {}) {
|
|
42
|
+
super({ ...opts, vendor: VENDOR });
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
export { RateBudgetError as RunhumanBudgetError } from '@volter/world-core';
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { type CapabilityReport, type CapabilitySpec } from '@volter/world-tooling';
|
|
2
|
+
export declare const RUNHUMAN_CAPABILITIES: CapabilitySpec[];
|
|
3
|
+
/** RH1's product areas, top-down from the public REST reference's sections (jobs, organizations,
|
|
4
|
+
* projects, API keys, PATs, templates, schedules, GitHub, auth, billing), the jobs router's tester
|
|
5
|
+
* side, the customer allowlist's tester notes, and the connector. */
|
|
6
|
+
export declare const RUNHUMAN_AREAS: readonly ["auth", "billing", "connector", "github", "jobs", "keys", "notes", "organizations", "pats", "projects", "schedules", "templates", "tester"];
|
|
7
|
+
export declare function runhumanCapabilities(): Promise<CapabilityReport>;
|