@idyl-sh/sdk 0.0.0-stage → 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 +188 -2
- package/dist/computer-connection.d.ts +200 -0
- package/dist/computer-connection.js +1019 -0
- package/dist/computer-connection.js.map +1 -0
- package/dist/computer-connection.wasm +0 -0
- package/dist/index.cjs +14636 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +5146 -0
- package/dist/index.d.ts +5146 -0
- package/dist/index.js +14563 -0
- package/dist/index.js.map +1 -0
- package/package.json +105 -4
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
CHANGED
|
@@ -1,3 +1,189 @@
|
|
|
1
|
-
|
|
1
|
+
<!-- Copyright 2026 Idyl Labs. SPDX-License-Identifier: Apache-2.0 -->
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
# IDYL TypeScript SDK
|
|
4
|
+
|
|
5
|
+
[](https://github.com/idyl-labs/sdk-typescript/actions/workflows/ci.yml)
|
|
6
|
+
[](LICENSE)
|
|
7
|
+
[](https://nodejs.org)
|
|
8
|
+
|
|
9
|
+
The official TypeScript SDK for IDYL. Create IDYL Computers, durable
|
|
10
|
+
computers whose files and settings survive stop and start, then run commands
|
|
11
|
+
in them, move files in and out, and save, restore and fork them from code.
|
|
12
|
+
|
|
13
|
+
## Installation
|
|
14
|
+
|
|
15
|
+
```sh
|
|
16
|
+
npm install @idyl-sh/sdk
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
The package runs on Node.js 22.3 or later, in evergreen browsers and on
|
|
20
|
+
Workers-class edge runtimes such as Cloudflare Workers, from one build with
|
|
21
|
+
no runtime dependencies.
|
|
22
|
+
|
|
23
|
+
## Quickstart
|
|
24
|
+
|
|
25
|
+
Run an evaluation script in a fresh Computer and print what it reports:
|
|
26
|
+
|
|
27
|
+
```ts
|
|
28
|
+
import { readFile } from "node:fs/promises";
|
|
29
|
+
import { Idyl } from "@idyl-sh/sdk";
|
|
30
|
+
|
|
31
|
+
const idyl = new Idyl({ accessKey: process.env.IDYL_ACCESS_KEY });
|
|
32
|
+
|
|
33
|
+
const computer = await idyl.computers.create({
|
|
34
|
+
name: "eval",
|
|
35
|
+
image: "python-3.12-ubuntu-24.04",
|
|
36
|
+
});
|
|
37
|
+
|
|
38
|
+
await computer.files.upload("eval.py", await readFile("eval.py"));
|
|
39
|
+
const { stdout } = await computer.exec("python3 eval.py");
|
|
40
|
+
console.log(stdout);
|
|
41
|
+
|
|
42
|
+
await computer.delete();
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
`IDYL_ACCESS_KEY` holds the contents of an access key file; see
|
|
46
|
+
[Authentication](#authentication).
|
|
47
|
+
|
|
48
|
+
## Usage
|
|
49
|
+
|
|
50
|
+
### Run your tests
|
|
51
|
+
|
|
52
|
+
```ts
|
|
53
|
+
import { ExitError } from "@idyl-sh/sdk";
|
|
54
|
+
|
|
55
|
+
const ci = await idyl.computers.create({
|
|
56
|
+
name: "ci",
|
|
57
|
+
image: "ubuntu-24.04",
|
|
58
|
+
cpu: "4",
|
|
59
|
+
memory: "8Gi",
|
|
60
|
+
});
|
|
61
|
+
|
|
62
|
+
await ci.exec("git clone https://github.com/example/app.git");
|
|
63
|
+
try {
|
|
64
|
+
await ci.exec("cd app && make test");
|
|
65
|
+
} catch (error) {
|
|
66
|
+
if (!(error instanceof ExitError)) throw error;
|
|
67
|
+
console.error(`tests failed with exit code ${error.code}`);
|
|
68
|
+
console.error(error.stdout);
|
|
69
|
+
}
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
`exec` wakes a sleeping Computer, runs the command in `/workspace`, and
|
|
73
|
+
resolves once it has ended and its changes are saved. A command that exits
|
|
74
|
+
other than with 0 rejects with an `ExitError` carrying its output.
|
|
75
|
+
|
|
76
|
+
### Move files in and out
|
|
77
|
+
|
|
78
|
+
```ts
|
|
79
|
+
await computer.files.upload("data/test.csv", await readFile("test.csv"));
|
|
80
|
+
await computer.exec("python3 eval.py --data data/test.csv --out results.json");
|
|
81
|
+
|
|
82
|
+
const results = await computer.files.download("results.json");
|
|
83
|
+
console.log(await results.json());
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
### Set up once, fork for each experiment
|
|
87
|
+
|
|
88
|
+
A Computer keeps its files between commands, so install dependencies once
|
|
89
|
+
and fork a copy for each run:
|
|
90
|
+
|
|
91
|
+
```ts
|
|
92
|
+
await computer.exec("pip install -r requirements.txt");
|
|
93
|
+
|
|
94
|
+
for (const config of ["baseline", "tuned"]) {
|
|
95
|
+
const run = await computer.fork({ name: `eval-${config}` });
|
|
96
|
+
const { stdout } = await run.exec(["python3", "eval.py", "--config", config]);
|
|
97
|
+
console.log(config, stdout);
|
|
98
|
+
await run.delete();
|
|
99
|
+
}
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
### Save and restore
|
|
103
|
+
|
|
104
|
+
```ts
|
|
105
|
+
const { version } = await computer.save();
|
|
106
|
+
await computer.exec("rm -rf data");
|
|
107
|
+
await computer.restore(version); // data/ is back
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### Terminals in a browser
|
|
111
|
+
|
|
112
|
+
A browser page runs terminals and commands through a connector, whose
|
|
113
|
+
connection lives in a dedicated Worker:
|
|
114
|
+
|
|
115
|
+
```ts
|
|
116
|
+
// connection-worker.ts
|
|
117
|
+
import { serveComputerConnections } from "@idyl-sh/sdk/computer-connection";
|
|
118
|
+
|
|
119
|
+
serveComputerConnections(self);
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
```ts
|
|
123
|
+
const connector = idyl.computers.connector({
|
|
124
|
+
worker: new Worker(new URL("./connection-worker.js", import.meta.url), {
|
|
125
|
+
type: "module",
|
|
126
|
+
}),
|
|
127
|
+
module: await WebAssembly.compileStreaming(fetch(connectionWasmUrl)),
|
|
128
|
+
});
|
|
129
|
+
await connector.ready();
|
|
130
|
+
|
|
131
|
+
const terminal = await computer.terminal({ size: { cols: 120, rows: 40 } });
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
`connectionWasmUrl` is where the page serves
|
|
135
|
+
`@idyl-sh/sdk/computer-connection.wasm`.
|
|
136
|
+
[`examples/browser-terminal.ts`](examples/browser-terminal.ts) connects a
|
|
137
|
+
terminal to xterm.js.
|
|
138
|
+
|
|
139
|
+
### More
|
|
140
|
+
|
|
141
|
+
Every export is documented in its type declarations. The client also covers
|
|
142
|
+
Secrets (`idyl.secrets`), the record of every time a Secret's value was
|
|
143
|
+
opened (`idyl.secrets.decryptions(name)` and `computer.decryptions()`),
|
|
144
|
+
history (`computer.history()`), wake and sleep (`computer.wake()`, `computer.sleep()`) and billing (`idyl.billing`).
|
|
145
|
+
|
|
146
|
+
## Authentication
|
|
147
|
+
|
|
148
|
+
Programs and servers authenticate with an access key. Create one with
|
|
149
|
+
`idyl.accessKeys.create`, save the key file it returns, and pass the file's
|
|
150
|
+
contents as `accessKey`:
|
|
151
|
+
|
|
152
|
+
```ts
|
|
153
|
+
const idyl = new Idyl({ accessKey: process.env.IDYL_ACCESS_KEY });
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
People sign in with an email code through `idyl.identity`. Every token is
|
|
157
|
+
bound to a key its holder keeps (DPoP, RFC 9449), and the package signs a
|
|
158
|
+
proof for every request. To supply tokens yourself, pass a `credential`
|
|
159
|
+
built with `staticCredential` or `credentialSourceFunc`.
|
|
160
|
+
|
|
161
|
+
## Errors
|
|
162
|
+
|
|
163
|
+
Invalid input throws a `TypeError` before any request is sent. A request the
|
|
164
|
+
platform refuses rejects with an `ApiError`; classify it by its `code`,
|
|
165
|
+
never by its message:
|
|
166
|
+
|
|
167
|
+
```ts
|
|
168
|
+
import { ERROR_CODE_INSUFFICIENT_CAPACITY, isApiCode } from "@idyl-sh/sdk";
|
|
169
|
+
|
|
170
|
+
try {
|
|
171
|
+
await computer.wake();
|
|
172
|
+
} catch (error) {
|
|
173
|
+
if (!isApiCode(error, ERROR_CODE_INSUFFICIENT_CAPACITY)) throw error;
|
|
174
|
+
// No capacity to run it now; a later wake may succeed.
|
|
175
|
+
}
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
A request that does not complete rejects with a `TransportError`, and a
|
|
179
|
+
command that exits other than with 0 with an `ExitError`.
|
|
180
|
+
|
|
181
|
+
## Contributing
|
|
182
|
+
|
|
183
|
+
See [CONTRIBUTING.md](CONTRIBUTING.md) and, for how the package is built,
|
|
184
|
+
[ARCHITECTURE.md](ARCHITECTURE.md). Report security issues as
|
|
185
|
+
[SECURITY.md](SECURITY.md) describes.
|
|
186
|
+
|
|
187
|
+
## License
|
|
188
|
+
|
|
189
|
+
[Apache License 2.0](LICENSE)
|
|
@@ -0,0 +1,200 @@
|
|
|
1
|
+
/** What the page asks of the Worker. Every request names a `ref` the page chose. */
|
|
2
|
+
type PageToWorker = {
|
|
3
|
+
readonly type: "start";
|
|
4
|
+
readonly ref: number;
|
|
5
|
+
readonly module: WebAssembly.Module | ArrayBuffer;
|
|
6
|
+
} | {
|
|
7
|
+
readonly type: "dock";
|
|
8
|
+
readonly ref: number;
|
|
9
|
+
readonly url: string;
|
|
10
|
+
readonly serverName: string;
|
|
11
|
+
readonly edgeId: string;
|
|
12
|
+
readonly edgeRoots: readonly Uint8Array[];
|
|
13
|
+
readonly chain: readonly Uint8Array[];
|
|
14
|
+
readonly lease: Uint8Array;
|
|
15
|
+
readonly keepaliveMs: number;
|
|
16
|
+
} | {
|
|
17
|
+
readonly type: "close-dock";
|
|
18
|
+
readonly ref: number;
|
|
19
|
+
readonly dock: number;
|
|
20
|
+
} | {
|
|
21
|
+
readonly type: "open-lane";
|
|
22
|
+
readonly ref: number;
|
|
23
|
+
readonly dock: number;
|
|
24
|
+
readonly principal: string;
|
|
25
|
+
} | {
|
|
26
|
+
readonly type: "open-computer";
|
|
27
|
+
readonly ref: number;
|
|
28
|
+
readonly dock: number;
|
|
29
|
+
readonly lane: number;
|
|
30
|
+
readonly hostPod: string;
|
|
31
|
+
readonly sequence: string;
|
|
32
|
+
readonly epoch: string;
|
|
33
|
+
readonly roots: readonly Uint8Array[];
|
|
34
|
+
readonly chain: readonly Uint8Array[];
|
|
35
|
+
readonly trustDomain: string;
|
|
36
|
+
readonly account: string;
|
|
37
|
+
readonly computer: string;
|
|
38
|
+
readonly minEpoch: string;
|
|
39
|
+
} | {
|
|
40
|
+
readonly type: "close-computer";
|
|
41
|
+
readonly ref: number;
|
|
42
|
+
readonly dock: number;
|
|
43
|
+
readonly computer: number;
|
|
44
|
+
} | {
|
|
45
|
+
readonly type: "open-stream";
|
|
46
|
+
readonly ref: number;
|
|
47
|
+
readonly dock: number;
|
|
48
|
+
readonly computer: number;
|
|
49
|
+
} | {
|
|
50
|
+
readonly type: "write";
|
|
51
|
+
readonly ref: number;
|
|
52
|
+
readonly dock: number;
|
|
53
|
+
readonly computer: number;
|
|
54
|
+
readonly stream: number;
|
|
55
|
+
readonly bytes: Uint8Array;
|
|
56
|
+
} | {
|
|
57
|
+
readonly type: "finish";
|
|
58
|
+
readonly ref: number;
|
|
59
|
+
readonly dock: number;
|
|
60
|
+
readonly computer: number;
|
|
61
|
+
readonly stream: number;
|
|
62
|
+
} | {
|
|
63
|
+
readonly type: "abort";
|
|
64
|
+
readonly ref: number;
|
|
65
|
+
readonly dock: number;
|
|
66
|
+
readonly computer: number;
|
|
67
|
+
readonly stream: number;
|
|
68
|
+
};
|
|
69
|
+
/** What the Worker tells the page. */
|
|
70
|
+
type WorkerToPage =
|
|
71
|
+
/** The answer to a request: its value, or why it failed. */
|
|
72
|
+
{
|
|
73
|
+
readonly type: "reply";
|
|
74
|
+
readonly ref: number;
|
|
75
|
+
readonly value?: unknown;
|
|
76
|
+
readonly error?: string;
|
|
77
|
+
}
|
|
78
|
+
/** The key exists: its certificate request (DER) and public key. */
|
|
79
|
+
| {
|
|
80
|
+
readonly type: "key";
|
|
81
|
+
readonly certificateRequest: Uint8Array;
|
|
82
|
+
readonly publicKey: Uint8Array;
|
|
83
|
+
} | {
|
|
84
|
+
readonly type: "docked";
|
|
85
|
+
readonly dock: number;
|
|
86
|
+
} | {
|
|
87
|
+
readonly type: "drain";
|
|
88
|
+
readonly dock: number;
|
|
89
|
+
readonly reason: string;
|
|
90
|
+
} | {
|
|
91
|
+
readonly type: "dock-ended";
|
|
92
|
+
readonly dock: number;
|
|
93
|
+
readonly reason: string;
|
|
94
|
+
readonly retryAfterMs?: number;
|
|
95
|
+
} | {
|
|
96
|
+
readonly type: "lane-ready";
|
|
97
|
+
readonly dock: number;
|
|
98
|
+
readonly lane: number;
|
|
99
|
+
} | {
|
|
100
|
+
readonly type: "lane-ended";
|
|
101
|
+
readonly dock: number;
|
|
102
|
+
readonly lane: number;
|
|
103
|
+
readonly reason: string;
|
|
104
|
+
} | {
|
|
105
|
+
readonly type: "computer-established";
|
|
106
|
+
readonly dock: number;
|
|
107
|
+
readonly computer: number;
|
|
108
|
+
readonly epoch: string;
|
|
109
|
+
} | {
|
|
110
|
+
readonly type: "computer-ended";
|
|
111
|
+
readonly dock: number;
|
|
112
|
+
readonly computer: number;
|
|
113
|
+
readonly reason: string;
|
|
114
|
+
readonly refusal?: number;
|
|
115
|
+
} | {
|
|
116
|
+
readonly type: "data";
|
|
117
|
+
readonly dock: number;
|
|
118
|
+
readonly computer: number;
|
|
119
|
+
readonly stream: number;
|
|
120
|
+
readonly bytes: Uint8Array;
|
|
121
|
+
} | {
|
|
122
|
+
readonly type: "stream-ended";
|
|
123
|
+
readonly dock: number;
|
|
124
|
+
readonly computer: number;
|
|
125
|
+
readonly stream: number;
|
|
126
|
+
readonly broken: boolean;
|
|
127
|
+
};
|
|
128
|
+
|
|
129
|
+
/**
|
|
130
|
+
* The scope a Worker runs in, limited to the parts the connection uses: a
|
|
131
|
+
* dedicated Worker's global scope, `self`.
|
|
132
|
+
*/
|
|
133
|
+
interface WorkerScope {
|
|
134
|
+
/**
|
|
135
|
+
* Sends a message to the page, as `postMessage` does in a Worker.
|
|
136
|
+
*
|
|
137
|
+
* @param message an event or reply of the connection's own protocol
|
|
138
|
+
* @param transfer the buffers whose ownership passes to the page
|
|
139
|
+
*/
|
|
140
|
+
postMessage(message: WorkerToPage, transfer?: Transferable[]): void;
|
|
141
|
+
/**
|
|
142
|
+
* Calls `listener` with each message the page sends, as
|
|
143
|
+
* `addEventListener` does in a Worker.
|
|
144
|
+
*
|
|
145
|
+
* @param type always `message`
|
|
146
|
+
* @param listener called with each message, in the order the page sent
|
|
147
|
+
* them
|
|
148
|
+
*/
|
|
149
|
+
addEventListener(type: "message", listener: (event: MessageEvent<PageToWorker>) => void): void;
|
|
150
|
+
}
|
|
151
|
+
/**
|
|
152
|
+
* Serves the page's requests on `scope` until the Worker ends. Call it once,
|
|
153
|
+
* from the Worker's module.
|
|
154
|
+
*/
|
|
155
|
+
declare function serveComputerConnections(scope: WorkerScope): void;
|
|
156
|
+
|
|
157
|
+
/**
|
|
158
|
+
* The Worker a connector runs its connections through: a dedicated Worker
|
|
159
|
+
* whose module called `serveComputerConnections`, or the `worker` that
|
|
160
|
+
* `connectInThisThread` returns. The messages between them belong to the
|
|
161
|
+
* connection and are opaque to the caller.
|
|
162
|
+
*/
|
|
163
|
+
interface WorkerPort {
|
|
164
|
+
/**
|
|
165
|
+
* Sends a message to the Worker, as `Worker.postMessage` does.
|
|
166
|
+
*
|
|
167
|
+
* @param message a request of the connection's own protocol
|
|
168
|
+
* @param transfer the buffers whose ownership passes to the Worker
|
|
169
|
+
*/
|
|
170
|
+
postMessage(message: PageToWorker, transfer?: Transferable[]): void;
|
|
171
|
+
/**
|
|
172
|
+
* Calls `listener` with each message the Worker sends, as
|
|
173
|
+
* `Worker.addEventListener` does.
|
|
174
|
+
*
|
|
175
|
+
* @param type always `message`
|
|
176
|
+
* @param listener called with each message, in the order the Worker sent
|
|
177
|
+
* them
|
|
178
|
+
*/
|
|
179
|
+
addEventListener(type: "message", listener: (event: MessageEvent<WorkerToPage>) => void): void;
|
|
180
|
+
}
|
|
181
|
+
|
|
182
|
+
/** A connection served in this thread, and the module it runs. */
|
|
183
|
+
interface ThreadConnection {
|
|
184
|
+
/** The port a connector talks to the connection through. */
|
|
185
|
+
readonly worker: WorkerPort;
|
|
186
|
+
/** `computer-connection.wasm`, compiled. */
|
|
187
|
+
readonly module: WebAssembly.Module;
|
|
188
|
+
}
|
|
189
|
+
/**
|
|
190
|
+
* Serves a Computer connection in this thread and compiles the module beside
|
|
191
|
+
* this file. Each call serves a connection of its own, with a key of its own,
|
|
192
|
+
* which lives as long as the thread. On a runtime that cannot read the
|
|
193
|
+
* module beside this file, build a connector from a port and a module of
|
|
194
|
+
* your own.
|
|
195
|
+
*
|
|
196
|
+
* @throws TypeError the runtime cannot read the module beside this file
|
|
197
|
+
*/
|
|
198
|
+
declare function connectInThisThread(): Promise<ThreadConnection>;
|
|
199
|
+
|
|
200
|
+
export { type ThreadConnection, type WorkerScope, connectInThisThread, serveComputerConnections };
|