@fungi.computer/oyster 0.33.0 → 0.35.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/README.md +62 -1
- package/dist/app-sandbox.d.ts +2 -2
- package/dist/app-sandbox.js +2 -2
- package/dist/approval-deadline.d.ts +2 -0
- package/dist/approval-deadline.js +7 -0
- package/dist/approval-home.d.ts +26 -3
- package/dist/approval-home.js +148 -18
- package/dist/apps/index.d.ts +1 -1
- package/dist/apps/index.js +1 -1
- package/dist/boot-host-script.js +1 -1
- package/dist/embed-metafiles.js +2 -2
- package/dist/embed-scripts.js +1 -1
- package/dist/hello-app-script.js +1 -1
- package/dist/host.d.ts +6 -4
- package/dist/host.js +8 -4
- package/dist/mcp.js +42 -13
- package/dist/page/app-permissions.js +8 -7
- package/dist/page/computer-handles.d.ts +0 -1
- package/dist/page/mount.js +1 -0
- package/dist/page-config.d.ts +1 -0
- package/dist/page-config.js +1 -0
- package/dist/page-script.js +2 -2
- package/dist/platform-skills.generated.d.ts +5 -2
- package/dist/platform-skills.generated.js +6 -2
- package/dist/standalone/agents.js +43 -7
- package/dist/standalone/computer-fleet.js +3 -0
- package/dist/standalone/computer.d.ts +6 -2
- package/dist/standalone/computer.js +27 -14
- package/dist/standalone/media.js +7 -2
- package/dist/standalone/preview.d.ts +21 -20
- package/dist/standalone/preview.js +147 -151
- package/dist/standalone/registry.d.ts +16 -21
- package/dist/standalone/registry.js +81 -28
- package/dist/standalone/worker.d.ts +1 -1
- package/dist/standalone/worker.js +23 -7
- package/dist/starter-agent.d.ts +6 -2
- package/dist/starter-agent.js +25 -4
- package/dist/workers.d.ts +31 -13
- package/dist/workers.js +86 -15
- package/docs/api/apps.md +21 -0
- package/docs/api/host.md +41 -11
- package/docs/api/page/mount.md +24 -22
- package/docs/api/workers.md +168 -81
- package/package.json +25 -24
package/docs/api/workers.md
CHANGED
|
@@ -45,11 +45,11 @@ new OysterMcpOwner<Env>(
|
|
|
45
45
|
|
|
46
46
|
###### Parameters
|
|
47
47
|
|
|
48
|
-
| Parameter | Type
|
|
49
|
-
| ------------ |
|
|
50
|
-
| `ctx` | `DurableObjectState`
|
|
51
|
-
| `env` | `Env`
|
|
52
|
-
| `createHost` | (`env`, `scope`) => \| `Readonly`\<\{ `approvals?`: `Readonly`\<\{ `submit`: `Promise`\<
|
|
48
|
+
| Parameter | Type |
|
|
49
|
+
| ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
50
|
+
| `ctx` | `DurableObjectState` |
|
|
51
|
+
| `env` | `Env` |
|
|
52
|
+
| `createHost` | (`env`, `scope`) => \| `Readonly`\<\{ `approvals?`: `Readonly`\<\{ `submit`: `Promise`\<[`OysterApprovalResult`](host.md#oysterapprovalresult)\>; \}\>; `workflows?`: (`principal`) => `Promise`\< \| `Readonly`\<\{ `status`: `Promise`\<...\>; `cancel`: `Promise`\<...\>; \}\> \| `null`\>; `computerControl?`: (`principal`) => \| `Readonly`\<\{ `list`: `Promise`\<\{ `computers`: ...; `nextOffset`: ...; \}\>; `state`: `Promise`\<... \| ...\>; `start`: `Promise`\<... \| ...\>; `create`: `Promise`\<... \| ...\>; `backends`: `Promise`\<...[]\>; `attachLocal`: `Promise`\<... \| ...\>; `detachLocal`: `Promise`\<... \| ...\>; \}\> \| `null`; `permissionResources?`: (`principal`) => `Promise`\<readonly [`ResourceOption`](apps.md#resourceoption)[]\>; `auth`: [`OysterAuth`](host.md#oysterauth); `backgroundOriginKey?`: () => `Promise`\<`CryptoKey`\>; `artifacts`: [`ArtifactStore`](host.md#artifactstore); `uiCache?`: `Readonly`\<\{ `match`: (`digest`) => `Promise`\<`ReadableStream`\<...\> \| `null`\>; `put`: (`digest`, `bytes`) => `Promise`\<`"stored"` \| `"unstored"`\>; \}\>; `installations`: [`InstallationStore`](host.md#installationstore); `instances`: [`InstanceDirectory`](host.md#instancedirectory); `bootUi`: (`release`) => `Promise`\< \| \{ `kind`: `"passed"`; \} \| \{ `kind`: `"failed"`; `code`: `"ui_mount_failed"`; `diagnostics?`: \{ `failedPredicate`: ... \| ... \| ... \| ... \| ...; `errorName?`: ... \| ... \| ... \| ... \| ... \| ... \| ... \| ...; `finalUrlPath`: `string`; `consoleErrors`: ...[]; `pageErrors`: ...[]; `failedRequests`: ...[]; `droppedCount`: `number`; \}; \} \| \{ `kind`: `"not_checked"`; `code`: \| `"boot_runner_unavailable"` \| `"boot_browser_binding_missing"` \| `"boot_clone_unavailable"` \| `"boot_timeout"` \| `"boot_cleanup_failed"` \| `"ui_check_not_run_on_host"`; \}\>; `computerId?`: `string`; `computerName?`: `string` \| `null`; `computer?`: (`principal`) => \| `Readonly`\<\{ `getCapabilities`: (`signal`) => `Promise`\<...\>; `call`: (`capabilityId`, `input`, `context`) => `Promise`\<...\>; \}\> \| `Promise`\< \| `Readonly`\<\{ `getCapabilities`: ...; `call`: ...; \}\> \| `null`\> \| `null`; `appToolPolicy?`: (`actor`) => \| \{ `level`: `"read"` \| `"write"`; `revision`: `string`; `grantedBy`: `string`; \} \| `Promise`\< \| \{ `level`: ... \| ...; `revision`: `string`; `grantedBy`: `string`; \} \| `null`\> \| `null`; `keys?`: `Readonly`\<\{ `live`: `Promise`\< \| `Readonly`\<\{ `keyId`: ...; `owner`: ...; `grantVersion`: ...; `grants`: ...; \}\> \| `null`\>; \}\>; `guestLimits?`: `Partial`\<`Readonly`\<\{ `cpuMs`: `number`; `subRequests`: `number`; \}\>\>; `mcp?`: `Readonly`\<\{ `handleRequest`: (`request`) => `Promise`\<`Response`\>; `close?`: () => `Promise`\<`void`\>; \}\>; `git?`: `Readonly`\<\{ `writerOf`: `Extract`\<`GitWriter`, \{ `kind`: `"actor"`; \}\>; `workflowPass?`: `Promise`\< \| `Readonly`\<\{ `kind`: ...; `actor`: ...; `role?`: ...; `workflow?`: ...; \}\> \| `null`\>; `buildPass?`: `Promise`\< \| `Readonly`\<\{ `kind`: ...; `actor`: ...; `role?`: ...; `workflow?`: ...; \}\> \| `null`\>; `git`: `Promise`\<`Readonly`\<\{ `push`: `Promise`\<...\>; `read`: `Promise`\<...\>; `binding`: `GitBinding`; \}\>\>; \}\>; `ownerRoutes?`: [`Routes`](authorization.md#routes)\<[`OysterEnv`](host.md#oysterenv)\>; `capabilities?`: readonly `Readonly`\<`object` & `object`\>[]; `workbench?`: `Readonly`\<\{ `directory`: `Promise`\<`Readonly`\<\{ `apps`: readonly ...[]; `roles`: [`OysterRootRoles`](root-data.md#oysterrootroles); `computer?`: ... \| ...; `installing?`: ... \| ...; \}\>\>; `storage`: `Pick`\<`AppStorageWire`, `"read"` \| `"write"` \| `"reset"`\> & `Readonly`\<\{ `events`: `Promise`\<...\>; \}\>; \}\>; `homeInstallationId?`: `string`; `pageScript?`: `string`; `pageAssets?`: () => `Promise`\<\{ `pageScript`: `string`; `fontStyles`: `string`; `loginFontStyles`: `string`; `shellStyles`: `string`; `grantConsentScript`: `string`; \}\>; `title?`: `string`; \}\> \| `Promise`\<`Readonly`\<\{ `approvals?`: `Readonly`\<\{ `submit`: `Promise`\<[`OysterApprovalResult`](host.md#oysterapprovalresult)\>; \}\>; `workflows?`: (`principal`) => `Promise`\< \| `Readonly`\<\{ `status`: ...; `cancel`: ...; \}\> \| `null`\>; `computerControl?`: (`principal`) => \| `Readonly`\<\{ `list`: `Promise`\<...\>; `state`: `Promise`\<...\>; `start`: `Promise`\<...\>; `create`: `Promise`\<...\>; `backends`: `Promise`\<...\>; `attachLocal`: `Promise`\<...\>; `detachLocal`: `Promise`\<...\>; \}\> \| `null`; `permissionResources?`: (`principal`) => `Promise`\<readonly [`ResourceOption`](apps.md#resourceoption)[]\>; `auth`: [`OysterAuth`](host.md#oysterauth); `backgroundOriginKey?`: () => `Promise`\<`CryptoKey`\>; `artifacts`: [`ArtifactStore`](host.md#artifactstore); `uiCache?`: `Readonly`\<\{ `match`: (`digest`) => `Promise`\<... \| ...\>; `put`: (`digest`, `bytes`) => `Promise`\<... \| ...\>; \}\>; `installations`: [`InstallationStore`](host.md#installationstore); `instances`: [`InstanceDirectory`](host.md#instancedirectory); `bootUi`: (`release`) => `Promise`\< \| \{ `kind`: `"passed"`; \} \| \{ `kind`: `"failed"`; `code`: `"ui_mount_failed"`; `diagnostics?`: \{ `failedPredicate`: ...; `errorName?`: ...; `finalUrlPath`: ...; `consoleErrors`: ...; `pageErrors`: ...; `failedRequests`: ...; `droppedCount`: ...; \}; \} \| \{ `kind`: `"not_checked"`; `code`: \| `"boot_runner_unavailable"` \| `"boot_browser_binding_missing"` \| `"boot_clone_unavailable"` \| `"boot_timeout"` \| `"boot_cleanup_failed"` \| `"ui_check_not_run_on_host"`; \}\>; `computerId?`: `string`; `computerName?`: `string` \| `null`; `computer?`: (`principal`) => \| `Readonly`\<\{ `getCapabilities`: (`signal`) => ...; `call`: (`capabilityId`, `input`, `context`) => ...; \}\> \| `Promise`\<`Readonly`\<...\> \| `null`\> \| `null`; `appToolPolicy?`: (`actor`) => \| \{ `level`: `"read"` \| `"write"`; `revision`: `string`; `grantedBy`: `string`; \} \| `Promise`\< \| \{ `level`: ...; `revision`: ...; `grantedBy`: ...; \} \| `null`\> \| `null`; `keys?`: `Readonly`\<\{ `live`: `Promise`\<`Readonly`\<...\> \| `null`\>; \}\>; `guestLimits?`: `Partial`\<`Readonly`\<\{ `cpuMs`: `number`; `subRequests`: `number`; \}\>\>; `mcp?`: `Readonly`\<\{ `handleRequest`: (`request`) => `Promise`\<`Response`\>; `close?`: () => `Promise`\<...\>; \}\>; `git?`: `Readonly`\<\{ `writerOf`: `Extract`\<`GitWriter`, \{ `kind`: `"actor"`; \}\>; `workflowPass?`: `Promise`\<`Readonly`\<...\> \| `null`\>; `buildPass?`: `Promise`\<`Readonly`\<...\> \| `null`\>; `git`: `Promise`\<`Readonly`\<\{ `push`: ...; `read`: ...; `binding`: ...; \}\>\>; \}\>; `ownerRoutes?`: [`Routes`](authorization.md#routes)\<[`OysterEnv`](host.md#oysterenv)\>; `capabilities?`: readonly `Readonly`\<`object` & `object`\>[]; `workbench?`: `Readonly`\<\{ `directory`: `Promise`\<`Readonly`\<\{ `apps`: ...; `roles`: ...; `computer?`: ...; `installing?`: ...; \}\>\>; `storage`: `Pick`\<`AppStorageWire`, ... \| ... \| ...\> & `Readonly`\<\{ `events`: ...; \}\>; \}\>; `homeInstallationId?`: `string`; `pageScript?`: `string`; `pageAssets?`: () => `Promise`\<\{ `pageScript`: `string`; `fontStyles`: `string`; `loginFontStyles`: `string`; `shellStyles`: `string`; `grantConsentScript`: `string`; \}\>; `title?`: `string`; \}\>\> |
|
|
53
53
|
|
|
54
54
|
###### Returns
|
|
55
55
|
|
|
@@ -86,7 +86,8 @@ Trusted host RPC: the namespace and pin are never selected by guest headers.
|
|
|
86
86
|
|
|
87
87
|
### OysterRegistry
|
|
88
88
|
|
|
89
|
-
|
|
89
|
+
Installation metadata and UI verdicts in one SQLite-backed Durable Object per
|
|
90
|
+
tenant.
|
|
90
91
|
|
|
91
92
|
#### Extends
|
|
92
93
|
|
|
@@ -128,41 +129,58 @@ DurableObject<Env>.constructor
|
|
|
128
129
|
##### approvalSubmit()
|
|
129
130
|
|
|
130
131
|
```ts
|
|
131
|
-
approvalSubmit(pin, call): Promise<
|
|
132
|
-
| {
|
|
133
|
-
kind: "pending_approval";
|
|
134
|
-
recordId: string;
|
|
135
|
-
description: {
|
|
136
|
-
title: string;
|
|
137
|
-
inputBytes: number;
|
|
138
|
-
inputSha256: string;
|
|
139
|
-
};
|
|
140
|
-
}
|
|
141
|
-
| ApprovalApplyResult>;
|
|
132
|
+
approvalSubmit(pin, call): Promise<OysterApprovalResult>;
|
|
142
133
|
```
|
|
143
134
|
|
|
144
135
|
Trusted host RPC; an operation input cannot select actor, namespace or tenant.
|
|
145
136
|
|
|
146
137
|
###### Parameters
|
|
147
138
|
|
|
148
|
-
| Parameter | Type
|
|
149
|
-
| --------------------- |
|
|
150
|
-
| `pin` | `Readonly`\<\{ `tenantId`: `string`; `origin`: `string`; \}\>
|
|
151
|
-
| `call` | \{ `actor`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; `installationId`: `string`; `sessionId`: `string` \| `null`; `operation`: `string`; `access`: `"write"` \| `"external"`; `authorityFence`: `string`; `idempotencyKey`: `string`; `input`: `JSONType`; \} |
|
|
152
|
-
| `call.actor` | \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}
|
|
153
|
-
| `call.installationId` | `string`
|
|
154
|
-
| `call.sessionId` | `string` \| `null`
|
|
155
|
-
| `call.operation` | `string`
|
|
156
|
-
| `call.access` | `"write"` \| `"external"`
|
|
157
|
-
| `call.authorityFence` | `string`
|
|
158
|
-
| `call.idempotencyKey` | `string`
|
|
159
|
-
| `call.input` | `JSONType`
|
|
139
|
+
| Parameter | Type |
|
|
140
|
+
| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
141
|
+
| `pin` | `Readonly`\<\{ `tenantId`: `string`; `origin`: `string`; \}\> |
|
|
142
|
+
| `call` | \{ `actor`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; `installationId`: `string`; `sessionId`: `string` \| `null`; `operation`: `string`; `access`: `"write"` \| `"external"`; `authorityFence`: `string`; `idempotencyKey`: `string`; `input`: `JSONType`; `deadlineAt`: `number`; \} |
|
|
143
|
+
| `call.actor` | \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \} |
|
|
144
|
+
| `call.installationId` | `string` |
|
|
145
|
+
| `call.sessionId` | `string` \| `null` |
|
|
146
|
+
| `call.operation` | `string` |
|
|
147
|
+
| `call.access` | `"write"` \| `"external"` |
|
|
148
|
+
| `call.authorityFence` | `string` |
|
|
149
|
+
| `call.idempotencyKey` | `string` |
|
|
150
|
+
| `call.input` | `JSONType` |
|
|
151
|
+
| `call.deadlineAt` | `number` |
|
|
160
152
|
|
|
161
153
|
###### Returns
|
|
162
154
|
|
|
163
|
-
`Promise`\<
|
|
164
|
-
|
|
165
|
-
|
|
155
|
+
`Promise`\<[`OysterApprovalResult`](host.md#oysterapprovalresult)\>
|
|
156
|
+
|
|
157
|
+
##### approvalCancel()
|
|
158
|
+
|
|
159
|
+
```ts
|
|
160
|
+
approvalCancel(pin, call): Promise<void>;
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
Cancellation has the same trusted host identity as submission, never App input.
|
|
164
|
+
|
|
165
|
+
###### Parameters
|
|
166
|
+
|
|
167
|
+
| Parameter | Type |
|
|
168
|
+
| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
169
|
+
| `pin` | `Readonly`\<\{ `tenantId`: `string`; `origin`: `string`; \}\> |
|
|
170
|
+
| `call` | \{ `actor`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; `installationId`: `string`; `sessionId`: `string` \| `null`; `operation`: `string`; `access`: `"write"` \| `"external"`; `authorityFence`: `string`; `idempotencyKey`: `string`; `input`: `JSONType`; `deadlineAt`: `number`; \} |
|
|
171
|
+
| `call.actor` | \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \} |
|
|
172
|
+
| `call.installationId` | `string` |
|
|
173
|
+
| `call.sessionId` | `string` \| `null` |
|
|
174
|
+
| `call.operation` | `string` |
|
|
175
|
+
| `call.access` | `"write"` \| `"external"` |
|
|
176
|
+
| `call.authorityFence` | `string` |
|
|
177
|
+
| `call.idempotencyKey` | `string` |
|
|
178
|
+
| `call.input` | `JSONType` |
|
|
179
|
+
| `call.deadlineAt` | `number` |
|
|
180
|
+
|
|
181
|
+
###### Returns
|
|
182
|
+
|
|
183
|
+
`Promise`\<`void`\>
|
|
166
184
|
|
|
167
185
|
##### approvalList()
|
|
168
186
|
|
|
@@ -217,6 +235,10 @@ approvalGet(
|
|
|
217
235
|
access: "write" | "external";
|
|
218
236
|
description: {
|
|
219
237
|
title: string;
|
|
238
|
+
app?: {
|
|
239
|
+
displayName: string;
|
|
240
|
+
operationLabel: string;
|
|
241
|
+
};
|
|
220
242
|
inputBytes: number;
|
|
221
243
|
inputSha256: string;
|
|
222
244
|
};
|
|
@@ -281,6 +303,7 @@ Read one member-scoped view; the native home resolves membership again.
|
|
|
281
303
|
`principalId`: `string`; `agentId`: `string` \| `null`; `sessionId`: `string` \|
|
|
282
304
|
`null`; `displayName`: `string`; \}; `module`: `string`; `operation`: `string`;
|
|
283
305
|
`access`: `"write"` \| `"external"`; `description`: \{ `title`: `string`;
|
|
306
|
+
`app?`: \{ `displayName`: `string`; `operationLabel`: `string`; \};
|
|
284
307
|
`inputBytes`: `number`; `inputSha256`: `string`; \}; `evidence?`: readonly
|
|
285
308
|
`object`[]; `authorityFence`: `string`; `reversibility`: `"reversible"` \|
|
|
286
309
|
`"irreversible-external"`; `state`: \| `"pending"` \| `"expired"` \| `"denied"`
|
|
@@ -302,6 +325,23 @@ approvalAnswer(
|
|
|
302
325
|
actor,
|
|
303
326
|
input
|
|
304
327
|
): Promise<
|
|
328
|
+
| Readonly<{
|
|
329
|
+
kind: "refused";
|
|
330
|
+
reason: | "pending"
|
|
331
|
+
| "expired"
|
|
332
|
+
| "not-found"
|
|
333
|
+
| "not-eligible"
|
|
334
|
+
| "already-answered"
|
|
335
|
+
| "stale-revision"
|
|
336
|
+
| "declined"
|
|
337
|
+
| "fenced"
|
|
338
|
+
| "not-granted"
|
|
339
|
+
| "read-only"
|
|
340
|
+
| "in-flight"
|
|
341
|
+
| "outcome-unknown"
|
|
342
|
+
| "identity-conflict";
|
|
343
|
+
denialNote?: string;
|
|
344
|
+
}>
|
|
305
345
|
| Readonly<{
|
|
306
346
|
kind: "answered";
|
|
307
347
|
view: {
|
|
@@ -318,6 +358,10 @@ approvalAnswer(
|
|
|
318
358
|
access: "write" | "external";
|
|
319
359
|
description: {
|
|
320
360
|
title: string;
|
|
361
|
+
app?: {
|
|
362
|
+
displayName: string;
|
|
363
|
+
operationLabel: string;
|
|
364
|
+
};
|
|
321
365
|
inputBytes: number;
|
|
322
366
|
inputSha256: string;
|
|
323
367
|
};
|
|
@@ -363,23 +407,6 @@ approvalAnswer(
|
|
|
363
407
|
canAnswer: boolean;
|
|
364
408
|
canSetAutoApprove: boolean;
|
|
365
409
|
};
|
|
366
|
-
}>
|
|
367
|
-
| Readonly<{
|
|
368
|
-
kind: "refused";
|
|
369
|
-
reason: | "pending"
|
|
370
|
-
| "expired"
|
|
371
|
-
| "not-found"
|
|
372
|
-
| "not-eligible"
|
|
373
|
-
| "already-answered"
|
|
374
|
-
| "stale-revision"
|
|
375
|
-
| "declined"
|
|
376
|
-
| "fenced"
|
|
377
|
-
| "not-granted"
|
|
378
|
-
| "read-only"
|
|
379
|
-
| "in-flight"
|
|
380
|
-
| "outcome-unknown"
|
|
381
|
-
| "identity-conflict";
|
|
382
|
-
denialNote?: string;
|
|
383
410
|
}>>;
|
|
384
411
|
```
|
|
385
412
|
|
|
@@ -399,14 +426,19 @@ Persist an eligible answer and attempt its native decision work once.
|
|
|
399
426
|
|
|
400
427
|
###### Returns
|
|
401
428
|
|
|
402
|
-
`Promise`\< \| `Readonly`\<\{ `kind`: `"
|
|
403
|
-
`
|
|
404
|
-
`
|
|
405
|
-
|
|
406
|
-
`
|
|
407
|
-
`
|
|
408
|
-
`string`; `
|
|
409
|
-
|
|
429
|
+
`Promise`\< \| `Readonly`\<\{ `kind`: `"refused"`; `reason`: \| `"pending"` \|
|
|
430
|
+
`"expired"` \| `"not-found"` \| `"not-eligible"` \| `"already-answered"` \|
|
|
431
|
+
`"stale-revision"` \| `"declined"` \| `"fenced"` \| `"not-granted"` \|
|
|
432
|
+
`"read-only"` \| `"in-flight"` \| `"outcome-unknown"` \| `"identity-conflict"`;
|
|
433
|
+
`denialNote?`: `string`; \}\> \| `Readonly`\<\{ `kind`: `"answered"`; `view`: \{
|
|
434
|
+
`record`: \{ `recordId`: `string`; `requester`: \{ `principalId`: `string`;
|
|
435
|
+
`agentId`: `string` \| `null`; `sessionId`: `string` \| `null`; `displayName`:
|
|
436
|
+
`string`; \}; `module`: `string`; `operation`: `string`; `access`: `"write"` \|
|
|
437
|
+
`"external"`; `description`: \{ `title`: `string`; `app?`: \{ `displayName`:
|
|
438
|
+
`string`; `operationLabel`: `string`; \}; `inputBytes`: `number`; `inputSha256`:
|
|
439
|
+
`string`; \}; `evidence?`: readonly `object`[]; `authorityFence`: `string`;
|
|
440
|
+
`reversibility`: `"reversible"` \| `"irreversible-external"`; `state`: \|
|
|
441
|
+
`"pending"` \| `"expired"` \| `"denied"` \| `"applied"` \| `"requested"` \|
|
|
410
442
|
`"approved"` \| `"claimed"` \| `"outcome_unknown"`; `by`: \| \{ `kind`:
|
|
411
443
|
`"human"`; `memberId`: `string`; \} \| \{ `kind`: `"policy"`; \} \| `null`;
|
|
412
444
|
`reason`: \| `"pending"` \| `"expired"` \| `"not-found"` \| `"not-eligible"` \|
|
|
@@ -414,12 +446,7 @@ Persist an eligible answer and attempt its native decision work once.
|
|
|
414
446
|
`"not-granted"` \| `"read-only"` \| `"in-flight"` \| `"outcome-unknown"` \|
|
|
415
447
|
`"identity-conflict"` \| `null`; `denialNote?`: `string`; `requestedAt`:
|
|
416
448
|
`number`; `expiresAt`: `number`; `updatedAt`: `number`; `revision`: `number`;
|
|
417
|
-
\}; `canAnswer`: `boolean`; `canSetAutoApprove`: `boolean`; \}; \}
|
|
418
|
-
`Readonly`\<\{ `kind`: `"refused"`; `reason`: \| `"pending"` \| `"expired"` \|
|
|
419
|
-
`"not-found"` \| `"not-eligible"` \| `"already-answered"` \| `"stale-revision"`
|
|
420
|
-
\| `"declined"` \| `"fenced"` \| `"not-granted"` \| `"read-only"` \|
|
|
421
|
-
`"in-flight"` \| `"outcome-unknown"` \| `"identity-conflict"`; `denialNote?`:
|
|
422
|
-
`string`; \}\>\>
|
|
449
|
+
\}; `canAnswer`: `boolean`; `canSetAutoApprove`: `boolean`; \}; \}\>\>
|
|
423
450
|
|
|
424
451
|
##### approvalSetAutoApprove()
|
|
425
452
|
|
|
@@ -1575,6 +1602,70 @@ Native RPC returns a closed result; callers never classify a transported Error.
|
|
|
1575
1602
|
|
|
1576
1603
|
`Promise`\<[`InstallationCommit`](host.md#installationcommit)\>
|
|
1577
1604
|
|
|
1605
|
+
##### bootUiResult()
|
|
1606
|
+
|
|
1607
|
+
```ts
|
|
1608
|
+
bootUiResult(input):
|
|
1609
|
+
| {
|
|
1610
|
+
kind: "passed";
|
|
1611
|
+
}
|
|
1612
|
+
| {
|
|
1613
|
+
kind: "failed";
|
|
1614
|
+
code: "ui_mount_failed";
|
|
1615
|
+
diagnostics?: {
|
|
1616
|
+
failedPredicate: | "unexpected_candidate_request"
|
|
1617
|
+
| "response_status"
|
|
1618
|
+
| "request_failed"
|
|
1619
|
+
| "page_error"
|
|
1620
|
+
| "candidate_not_mounted";
|
|
1621
|
+
errorName?: | "Error"
|
|
1622
|
+
| "TypeError"
|
|
1623
|
+
| "RangeError"
|
|
1624
|
+
| "SyntaxError"
|
|
1625
|
+
| "AbortError"
|
|
1626
|
+
| "TimeoutError"
|
|
1627
|
+
| "Other";
|
|
1628
|
+
finalUrlPath: string;
|
|
1629
|
+
consoleErrors: string[];
|
|
1630
|
+
pageErrors: string[];
|
|
1631
|
+
failedRequests: object[];
|
|
1632
|
+
droppedCount: number;
|
|
1633
|
+
};
|
|
1634
|
+
}
|
|
1635
|
+
| {
|
|
1636
|
+
kind: "not_checked";
|
|
1637
|
+
code: | "boot_runner_unavailable"
|
|
1638
|
+
| "boot_browser_binding_missing"
|
|
1639
|
+
| "boot_clone_unavailable"
|
|
1640
|
+
| "boot_timeout"
|
|
1641
|
+
| "boot_cleanup_failed"
|
|
1642
|
+
| "ui_check_not_run_on_host";
|
|
1643
|
+
}
|
|
1644
|
+
| null;
|
|
1645
|
+
```
|
|
1646
|
+
|
|
1647
|
+
Trusted host verdicts, local to this tenant, origin, Release and check version.
|
|
1648
|
+
|
|
1649
|
+
###### Parameters
|
|
1650
|
+
|
|
1651
|
+
| Parameter | Type |
|
|
1652
|
+
| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1653
|
+
| `input` | `Readonly`\<\{ `tenantId`: `string`; `origin`: `string`; `releaseId`: `string`; `artifactDigest`: `string`; `checkVersion`: `string`; \}\> & \| `Readonly`\<\{ `kind`: `"read"`; \}\> \| `Readonly`\<\{ `kind`: `"record"`; `outcome`: \| \{ `kind`: `"passed"`; \} \| \{ `kind`: `"failed"`; `code`: `"ui_mount_failed"`; `diagnostics?`: \{ `failedPredicate`: \| `"unexpected_candidate_request"` \| `"response_status"` \| `"request_failed"` \| `"page_error"` \| `"candidate_not_mounted"`; `errorName?`: \| `"Error"` \| `"TypeError"` \| `"RangeError"` \| `"SyntaxError"` \| `"AbortError"` \| `"TimeoutError"` \| `"Other"`; `finalUrlPath`: `string`; `consoleErrors`: `string`[]; `pageErrors`: `string`[]; `failedRequests`: `object`[]; `droppedCount`: `number`; \}; \}; \}\> |
|
|
1654
|
+
|
|
1655
|
+
###### Returns
|
|
1656
|
+
|
|
1657
|
+
\| \{ `kind`: `"passed"`; \} \| \{ `kind`: `"failed"`; `code`:
|
|
1658
|
+
`"ui_mount_failed"`; `diagnostics?`: \{ `failedPredicate`: \|
|
|
1659
|
+
`"unexpected_candidate_request"` \| `"response_status"` \| `"request_failed"` \|
|
|
1660
|
+
`"page_error"` \| `"candidate_not_mounted"`; `errorName?`: \| `"Error"` \|
|
|
1661
|
+
`"TypeError"` \| `"RangeError"` \| `"SyntaxError"` \| `"AbortError"` \|
|
|
1662
|
+
`"TimeoutError"` \| `"Other"`; `finalUrlPath`: `string`; `consoleErrors`:
|
|
1663
|
+
`string`[]; `pageErrors`: `string`[]; `failedRequests`: `object`[];
|
|
1664
|
+
`droppedCount`: `number`; \}; \} \| \{ `kind`: `"not_checked"`; `code`: \|
|
|
1665
|
+
`"boot_runner_unavailable"` \| `"boot_browser_binding_missing"` \|
|
|
1666
|
+
`"boot_clone_unavailable"` \| `"boot_timeout"` \| `"boot_cleanup_failed"` \|
|
|
1667
|
+
`"ui_check_not_run_on_host"`; \} \| `null`
|
|
1668
|
+
|
|
1578
1669
|
##### bootCapability()
|
|
1579
1670
|
|
|
1580
1671
|
```ts
|
|
@@ -2936,13 +3027,7 @@ type OysterBindingContext<Env> = Readonly<{
|
|
|
2936
3027
|
backgroundHost: Promise<
|
|
2937
3028
|
| Readonly<{
|
|
2938
3029
|
approvals?: Readonly<{
|
|
2939
|
-
submit: Promise<
|
|
2940
|
-
| {
|
|
2941
|
-
kind: ...;
|
|
2942
|
-
recordId: ...;
|
|
2943
|
-
description: ...;
|
|
2944
|
-
}
|
|
2945
|
-
| ApprovalApplyResult>;
|
|
3030
|
+
submit: Promise<OysterApprovalResult>;
|
|
2946
3031
|
}>;
|
|
2947
3032
|
workflows?: (principal) => Promise<
|
|
2948
3033
|
| {
|
|
@@ -2960,6 +3045,7 @@ type OysterBindingContext<Env> = Readonly<{
|
|
|
2960
3045
|
instances: InstanceDirectory;
|
|
2961
3046
|
bootUi: (release) => Promise<UiBootCheckOutcome>;
|
|
2962
3047
|
computerId?: string;
|
|
3048
|
+
computerName?: string | null;
|
|
2963
3049
|
computer?: (principal) => KnapsackComputer | null | Promise<KnapsackComputer | null>;
|
|
2964
3050
|
appToolPolicy?: (actor) =>
|
|
2965
3051
|
| AppToolPolicy
|
|
@@ -3062,6 +3148,7 @@ missing row is `binding_unavailable`.
|
|
|
3062
3148
|
```ts
|
|
3063
3149
|
type OysterWorkspace = Readonly<{
|
|
3064
3150
|
computerId: string;
|
|
3151
|
+
computerName?: string | null;
|
|
3065
3152
|
files: FileSource;
|
|
3066
3153
|
computer?: OysterHost["computer"];
|
|
3067
3154
|
}>;
|
|
@@ -3100,9 +3187,9 @@ A loopback export with ordinary Worker I/O, not another resource or HTTP API.
|
|
|
3100
3187
|
|
|
3101
3188
|
#### Parameters
|
|
3102
3189
|
|
|
3103
|
-
| Parameter | Type
|
|
3104
|
-
| --------- |
|
|
3105
|
-
| `hostFor` | (`env`, `scope`) => \| `Readonly`\<\{ `approvals?`: `Readonly`\<\{ `submit`: `Promise`\<
|
|
3190
|
+
| Parameter | Type |
|
|
3191
|
+
| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
3192
|
+
| `hostFor` | (`env`, `scope`) => \| `Readonly`\<\{ `approvals?`: `Readonly`\<\{ `submit`: `Promise`\<[`OysterApprovalResult`](host.md#oysterapprovalresult)\>; \}\>; `workflows?`: (`principal`) => `Promise`\< \| `Readonly`\<\{ `status`: `Promise`\<...\>; `cancel`: `Promise`\<...\>; \}\> \| `null`\>; `computerControl?`: (`principal`) => \| `Readonly`\<\{ `list`: `Promise`\<\{ `computers`: ...; `nextOffset`: ...; \}\>; `state`: `Promise`\<... \| ...\>; `start`: `Promise`\<... \| ...\>; `create`: `Promise`\<... \| ...\>; `backends`: `Promise`\<...[]\>; `attachLocal`: `Promise`\<... \| ...\>; `detachLocal`: `Promise`\<... \| ...\>; \}\> \| `null`; `permissionResources?`: (`principal`) => `Promise`\<readonly [`ResourceOption`](apps.md#resourceoption)[]\>; `auth`: [`OysterAuth`](host.md#oysterauth); `backgroundOriginKey?`: () => `Promise`\<`CryptoKey`\>; `artifacts`: [`ArtifactStore`](host.md#artifactstore); `uiCache?`: `Readonly`\<\{ `match`: (`digest`) => `Promise`\<`ReadableStream`\<...\> \| `null`\>; `put`: (`digest`, `bytes`) => `Promise`\<`"stored"` \| `"unstored"`\>; \}\>; `installations`: [`InstallationStore`](host.md#installationstore); `instances`: [`InstanceDirectory`](host.md#instancedirectory); `bootUi`: (`release`) => `Promise`\< \| \{ `kind`: `"passed"`; \} \| \{ `kind`: `"failed"`; `code`: `"ui_mount_failed"`; `diagnostics?`: \{ `failedPredicate`: ... \| ... \| ... \| ... \| ...; `errorName?`: ... \| ... \| ... \| ... \| ... \| ... \| ... \| ...; `finalUrlPath`: `string`; `consoleErrors`: ...[]; `pageErrors`: ...[]; `failedRequests`: ...[]; `droppedCount`: `number`; \}; \} \| \{ `kind`: `"not_checked"`; `code`: \| `"boot_runner_unavailable"` \| `"boot_browser_binding_missing"` \| `"boot_clone_unavailable"` \| `"boot_timeout"` \| `"boot_cleanup_failed"` \| `"ui_check_not_run_on_host"`; \}\>; `computerId?`: `string`; `computerName?`: `string` \| `null`; `computer?`: (`principal`) => \| `Readonly`\<\{ `getCapabilities`: (`signal`) => `Promise`\<...\>; `call`: (`capabilityId`, `input`, `context`) => `Promise`\<...\>; \}\> \| `Promise`\< \| `Readonly`\<\{ `getCapabilities`: ...; `call`: ...; \}\> \| `null`\> \| `null`; `appToolPolicy?`: (`actor`) => \| \{ `level`: `"read"` \| `"write"`; `revision`: `string`; `grantedBy`: `string`; \} \| `Promise`\< \| \{ `level`: ... \| ...; `revision`: `string`; `grantedBy`: `string`; \} \| `null`\> \| `null`; `keys?`: `Readonly`\<\{ `live`: `Promise`\< \| `Readonly`\<\{ `keyId`: ...; `owner`: ...; `grantVersion`: ...; `grants`: ...; \}\> \| `null`\>; \}\>; `guestLimits?`: `Partial`\<`Readonly`\<\{ `cpuMs`: `number`; `subRequests`: `number`; \}\>\>; `mcp?`: `Readonly`\<\{ `handleRequest`: (`request`) => `Promise`\<`Response`\>; `close?`: () => `Promise`\<`void`\>; \}\>; `git?`: `Readonly`\<\{ `writerOf`: `Extract`\<`GitWriter`, \{ `kind`: `"actor"`; \}\>; `workflowPass?`: `Promise`\< \| `Readonly`\<\{ `kind`: ...; `actor`: ...; `role?`: ...; `workflow?`: ...; \}\> \| `null`\>; `buildPass?`: `Promise`\< \| `Readonly`\<\{ `kind`: ...; `actor`: ...; `role?`: ...; `workflow?`: ...; \}\> \| `null`\>; `git`: `Promise`\<`Readonly`\<\{ `push`: `Promise`\<...\>; `read`: `Promise`\<...\>; `binding`: `GitBinding`; \}\>\>; \}\>; `ownerRoutes?`: [`Routes`](authorization.md#routes)\<[`OysterEnv`](host.md#oysterenv)\>; `capabilities?`: readonly `Readonly`\<`object` & `object`\>[]; `workbench?`: `Readonly`\<\{ `directory`: `Promise`\<`Readonly`\<\{ `apps`: readonly ...[]; `roles`: [`OysterRootRoles`](root-data.md#oysterrootroles); `computer?`: ... \| ...; `installing?`: ... \| ...; \}\>\>; `storage`: `Pick`\<`AppStorageWire`, `"read"` \| `"write"` \| `"reset"`\> & `Readonly`\<\{ `events`: `Promise`\<...\>; \}\>; \}\>; `homeInstallationId?`: `string`; `pageScript?`: `string`; `pageAssets?`: () => `Promise`\<\{ `pageScript`: `string`; `fontStyles`: `string`; `loginFontStyles`: `string`; `shellStyles`: `string`; `grantConsentScript`: `string`; \}\>; `title?`: `string`; \}\> \| `Promise`\<`Readonly`\<\{ `approvals?`: `Readonly`\<\{ `submit`: `Promise`\<[`OysterApprovalResult`](host.md#oysterapprovalresult)\>; \}\>; `workflows?`: (`principal`) => `Promise`\< \| `Readonly`\<\{ `status`: ...; `cancel`: ...; \}\> \| `null`\>; `computerControl?`: (`principal`) => \| `Readonly`\<\{ `list`: `Promise`\<...\>; `state`: `Promise`\<...\>; `start`: `Promise`\<...\>; `create`: `Promise`\<...\>; `backends`: `Promise`\<...\>; `attachLocal`: `Promise`\<...\>; `detachLocal`: `Promise`\<...\>; \}\> \| `null`; `permissionResources?`: (`principal`) => `Promise`\<readonly [`ResourceOption`](apps.md#resourceoption)[]\>; `auth`: [`OysterAuth`](host.md#oysterauth); `backgroundOriginKey?`: () => `Promise`\<`CryptoKey`\>; `artifacts`: [`ArtifactStore`](host.md#artifactstore); `uiCache?`: `Readonly`\<\{ `match`: (`digest`) => `Promise`\<... \| ...\>; `put`: (`digest`, `bytes`) => `Promise`\<... \| ...\>; \}\>; `installations`: [`InstallationStore`](host.md#installationstore); `instances`: [`InstanceDirectory`](host.md#instancedirectory); `bootUi`: (`release`) => `Promise`\< \| \{ `kind`: `"passed"`; \} \| \{ `kind`: `"failed"`; `code`: `"ui_mount_failed"`; `diagnostics?`: \{ `failedPredicate`: ...; `errorName?`: ...; `finalUrlPath`: ...; `consoleErrors`: ...; `pageErrors`: ...; `failedRequests`: ...; `droppedCount`: ...; \}; \} \| \{ `kind`: `"not_checked"`; `code`: \| `"boot_runner_unavailable"` \| `"boot_browser_binding_missing"` \| `"boot_clone_unavailable"` \| `"boot_timeout"` \| `"boot_cleanup_failed"` \| `"ui_check_not_run_on_host"`; \}\>; `computerId?`: `string`; `computerName?`: `string` \| `null`; `computer?`: (`principal`) => \| `Readonly`\<\{ `getCapabilities`: (`signal`) => ...; `call`: (`capabilityId`, `input`, `context`) => ...; \}\> \| `Promise`\<`Readonly`\<...\> \| `null`\> \| `null`; `appToolPolicy?`: (`actor`) => \| \{ `level`: `"read"` \| `"write"`; `revision`: `string`; `grantedBy`: `string`; \} \| `Promise`\< \| \{ `level`: ...; `revision`: ...; `grantedBy`: ...; \} \| `null`\> \| `null`; `keys?`: `Readonly`\<\{ `live`: `Promise`\<`Readonly`\<...\> \| `null`\>; \}\>; `guestLimits?`: `Partial`\<`Readonly`\<\{ `cpuMs`: `number`; `subRequests`: `number`; \}\>\>; `mcp?`: `Readonly`\<\{ `handleRequest`: (`request`) => `Promise`\<`Response`\>; `close?`: () => `Promise`\<...\>; \}\>; `git?`: `Readonly`\<\{ `writerOf`: `Extract`\<`GitWriter`, \{ `kind`: `"actor"`; \}\>; `workflowPass?`: `Promise`\<`Readonly`\<...\> \| `null`\>; `buildPass?`: `Promise`\<`Readonly`\<...\> \| `null`\>; `git`: `Promise`\<`Readonly`\<\{ `push`: ...; `read`: ...; `binding`: ...; \}\>\>; \}\>; `ownerRoutes?`: [`Routes`](authorization.md#routes)\<[`OysterEnv`](host.md#oysterenv)\>; `capabilities?`: readonly `Readonly`\<`object` & `object`\>[]; `workbench?`: `Readonly`\<\{ `directory`: `Promise`\<`Readonly`\<\{ `apps`: ...; `roles`: ...; `computer?`: ...; `installing?`: ...; \}\>\>; `storage`: `Pick`\<`AppStorageWire`, ... \| ... \| ...\> & `Readonly`\<\{ `events`: ...; \}\>; \}\>; `homeInstallationId?`: `string`; `pageScript?`: `string`; `pageAssets?`: () => `Promise`\<\{ `pageScript`: `string`; `fontStyles`: `string`; `loginFontStyles`: `string`; `shellStyles`: `string`; `grantConsentScript`: `string`; \}\>; `title?`: `string`; \}\>\> |
|
|
3106
3193
|
|
|
3107
3194
|
#### Returns
|
|
3108
3195
|
|
|
@@ -3126,9 +3213,9 @@ Bind the owner to the deployment's existing host factory and options.
|
|
|
3126
3213
|
|
|
3127
3214
|
#### Parameters
|
|
3128
3215
|
|
|
3129
|
-
| Parameter | Type
|
|
3130
|
-
| --------- |
|
|
3131
|
-
| `host` | (`env`, `scope`) => \| `Readonly`\<\{ `approvals?`: `Readonly`\<\{ `submit`: `Promise`\<
|
|
3216
|
+
| Parameter | Type |
|
|
3217
|
+
| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
3218
|
+
| `host` | (`env`, `scope`) => \| `Readonly`\<\{ `approvals?`: `Readonly`\<\{ `submit`: `Promise`\<[`OysterApprovalResult`](host.md#oysterapprovalresult)\>; \}\>; `workflows?`: (`principal`) => `Promise`\< \| `Readonly`\<\{ `status`: `Promise`\<...\>; `cancel`: `Promise`\<...\>; \}\> \| `null`\>; `computerControl?`: (`principal`) => \| `Readonly`\<\{ `list`: `Promise`\<\{ `computers`: ...; `nextOffset`: ...; \}\>; `state`: `Promise`\<... \| ...\>; `start`: `Promise`\<... \| ...\>; `create`: `Promise`\<... \| ...\>; `backends`: `Promise`\<...[]\>; `attachLocal`: `Promise`\<... \| ...\>; `detachLocal`: `Promise`\<... \| ...\>; \}\> \| `null`; `permissionResources?`: (`principal`) => `Promise`\<readonly [`ResourceOption`](apps.md#resourceoption)[]\>; `auth`: [`OysterAuth`](host.md#oysterauth); `backgroundOriginKey?`: () => `Promise`\<`CryptoKey`\>; `artifacts`: [`ArtifactStore`](host.md#artifactstore); `uiCache?`: `Readonly`\<\{ `match`: (`digest`) => `Promise`\<`ReadableStream`\<...\> \| `null`\>; `put`: (`digest`, `bytes`) => `Promise`\<`"stored"` \| `"unstored"`\>; \}\>; `installations`: [`InstallationStore`](host.md#installationstore); `instances`: [`InstanceDirectory`](host.md#instancedirectory); `bootUi`: (`release`) => `Promise`\< \| \{ `kind`: `"passed"`; \} \| \{ `kind`: `"failed"`; `code`: `"ui_mount_failed"`; `diagnostics?`: \{ `failedPredicate`: ... \| ... \| ... \| ... \| ...; `errorName?`: ... \| ... \| ... \| ... \| ... \| ... \| ... \| ...; `finalUrlPath`: `string`; `consoleErrors`: ...[]; `pageErrors`: ...[]; `failedRequests`: ...[]; `droppedCount`: `number`; \}; \} \| \{ `kind`: `"not_checked"`; `code`: \| `"boot_runner_unavailable"` \| `"boot_browser_binding_missing"` \| `"boot_clone_unavailable"` \| `"boot_timeout"` \| `"boot_cleanup_failed"` \| `"ui_check_not_run_on_host"`; \}\>; `computerId?`: `string`; `computerName?`: `string` \| `null`; `computer?`: (`principal`) => \| `Readonly`\<\{ `getCapabilities`: (`signal`) => `Promise`\<...\>; `call`: (`capabilityId`, `input`, `context`) => `Promise`\<...\>; \}\> \| `Promise`\< \| `Readonly`\<\{ `getCapabilities`: ...; `call`: ...; \}\> \| `null`\> \| `null`; `appToolPolicy?`: (`actor`) => \| \{ `level`: `"read"` \| `"write"`; `revision`: `string`; `grantedBy`: `string`; \} \| `Promise`\< \| \{ `level`: ... \| ...; `revision`: `string`; `grantedBy`: `string`; \} \| `null`\> \| `null`; `keys?`: `Readonly`\<\{ `live`: `Promise`\< \| `Readonly`\<\{ `keyId`: ...; `owner`: ...; `grantVersion`: ...; `grants`: ...; \}\> \| `null`\>; \}\>; `guestLimits?`: `Partial`\<`Readonly`\<\{ `cpuMs`: `number`; `subRequests`: `number`; \}\>\>; `mcp?`: `Readonly`\<\{ `handleRequest`: (`request`) => `Promise`\<`Response`\>; `close?`: () => `Promise`\<`void`\>; \}\>; `git?`: `Readonly`\<\{ `writerOf`: `Extract`\<`GitWriter`, \{ `kind`: `"actor"`; \}\>; `workflowPass?`: `Promise`\< \| `Readonly`\<\{ `kind`: ...; `actor`: ...; `role?`: ...; `workflow?`: ...; \}\> \| `null`\>; `buildPass?`: `Promise`\< \| `Readonly`\<\{ `kind`: ...; `actor`: ...; `role?`: ...; `workflow?`: ...; \}\> \| `null`\>; `git`: `Promise`\<`Readonly`\<\{ `push`: `Promise`\<...\>; `read`: `Promise`\<...\>; `binding`: `GitBinding`; \}\>\>; \}\>; `ownerRoutes?`: [`Routes`](authorization.md#routes)\<[`OysterEnv`](host.md#oysterenv)\>; `capabilities?`: readonly `Readonly`\<`object` & `object`\>[]; `workbench?`: `Readonly`\<\{ `directory`: `Promise`\<`Readonly`\<\{ `apps`: readonly ...[]; `roles`: [`OysterRootRoles`](root-data.md#oysterrootroles); `computer?`: ... \| ...; `installing?`: ... \| ...; \}\>\>; `storage`: `Pick`\<`AppStorageWire`, `"read"` \| `"write"` \| `"reset"`\> & `Readonly`\<\{ `events`: `Promise`\<...\>; \}\>; \}\>; `homeInstallationId?`: `string`; `pageScript?`: `string`; `pageAssets?`: () => `Promise`\<\{ `pageScript`: `string`; `fontStyles`: `string`; `loginFontStyles`: `string`; `shellStyles`: `string`; `grantConsentScript`: `string`; \}\>; `title?`: `string`; \}\> \| `Promise`\<`Readonly`\<\{ `approvals?`: `Readonly`\<\{ `submit`: `Promise`\<[`OysterApprovalResult`](host.md#oysterapprovalresult)\>; \}\>; `workflows?`: (`principal`) => `Promise`\< \| `Readonly`\<\{ `status`: ...; `cancel`: ...; \}\> \| `null`\>; `computerControl?`: (`principal`) => \| `Readonly`\<\{ `list`: `Promise`\<...\>; `state`: `Promise`\<...\>; `start`: `Promise`\<...\>; `create`: `Promise`\<...\>; `backends`: `Promise`\<...\>; `attachLocal`: `Promise`\<...\>; `detachLocal`: `Promise`\<...\>; \}\> \| `null`; `permissionResources?`: (`principal`) => `Promise`\<readonly [`ResourceOption`](apps.md#resourceoption)[]\>; `auth`: [`OysterAuth`](host.md#oysterauth); `backgroundOriginKey?`: () => `Promise`\<`CryptoKey`\>; `artifacts`: [`ArtifactStore`](host.md#artifactstore); `uiCache?`: `Readonly`\<\{ `match`: (`digest`) => `Promise`\<... \| ...\>; `put`: (`digest`, `bytes`) => `Promise`\<... \| ...\>; \}\>; `installations`: [`InstallationStore`](host.md#installationstore); `instances`: [`InstanceDirectory`](host.md#instancedirectory); `bootUi`: (`release`) => `Promise`\< \| \{ `kind`: `"passed"`; \} \| \{ `kind`: `"failed"`; `code`: `"ui_mount_failed"`; `diagnostics?`: \{ `failedPredicate`: ...; `errorName?`: ...; `finalUrlPath`: ...; `consoleErrors`: ...; `pageErrors`: ...; `failedRequests`: ...; `droppedCount`: ...; \}; \} \| \{ `kind`: `"not_checked"`; `code`: \| `"boot_runner_unavailable"` \| `"boot_browser_binding_missing"` \| `"boot_clone_unavailable"` \| `"boot_timeout"` \| `"boot_cleanup_failed"` \| `"ui_check_not_run_on_host"`; \}\>; `computerId?`: `string`; `computerName?`: `string` \| `null`; `computer?`: (`principal`) => \| `Readonly`\<\{ `getCapabilities`: (`signal`) => ...; `call`: (`capabilityId`, `input`, `context`) => ...; \}\> \| `Promise`\<`Readonly`\<...\> \| `null`\> \| `null`; `appToolPolicy?`: (`actor`) => \| \{ `level`: `"read"` \| `"write"`; `revision`: `string`; `grantedBy`: `string`; \} \| `Promise`\< \| \{ `level`: ...; `revision`: ...; `grantedBy`: ...; \} \| `null`\> \| `null`; `keys?`: `Readonly`\<\{ `live`: `Promise`\<`Readonly`\<...\> \| `null`\>; \}\>; `guestLimits?`: `Partial`\<`Readonly`\<\{ `cpuMs`: `number`; `subRequests`: `number`; \}\>\>; `mcp?`: `Readonly`\<\{ `handleRequest`: (`request`) => `Promise`\<`Response`\>; `close?`: () => `Promise`\<...\>; \}\>; `git?`: `Readonly`\<\{ `writerOf`: `Extract`\<`GitWriter`, \{ `kind`: `"actor"`; \}\>; `workflowPass?`: `Promise`\<`Readonly`\<...\> \| `null`\>; `buildPass?`: `Promise`\<`Readonly`\<...\> \| `null`\>; `git`: `Promise`\<`Readonly`\<\{ `push`: ...; `read`: ...; `binding`: ...; \}\>\>; \}\>; `ownerRoutes?`: [`Routes`](authorization.md#routes)\<[`OysterEnv`](host.md#oysterenv)\>; `capabilities?`: readonly `Readonly`\<`object` & `object`\>[]; `workbench?`: `Readonly`\<\{ `directory`: `Promise`\<`Readonly`\<\{ `apps`: ...; `roles`: ...; `computer?`: ...; `installing?`: ...; \}\>\>; `storage`: `Pick`\<`AppStorageWire`, ... \| ... \| ...\> & `Readonly`\<\{ `events`: ...; \}\>; \}\>; `homeInstallationId?`: `string`; `pageScript?`: `string`; `pageAssets?`: () => `Promise`\<\{ `pageScript`: `string`; `fontStyles`: `string`; `loginFontStyles`: `string`; `shellStyles`: `string`; `grantConsentScript`: `string`; \}\>; `title?`: `string`; \}\>\> |
|
|
3132
3219
|
|
|
3133
3220
|
#### Returns
|
|
3134
3221
|
|
|
@@ -3222,11 +3309,11 @@ Instances, and boot-check service.
|
|
|
3222
3309
|
|
|
3223
3310
|
#### Parameters
|
|
3224
3311
|
|
|
3225
|
-
| Parameter | Type
|
|
3226
|
-
| --------- |
|
|
3227
|
-
| `env` | [`OysterWorkerEnv`](#oysterworkerenv)
|
|
3228
|
-
| `auth` | [`OysterAuth`](host.md#oysterauth)
|
|
3229
|
-
| `options` | `Pick`\<`Readonly`\<\{ `approvals?`: `Readonly`\<\{ `submit`: `Promise`\<
|
|
3312
|
+
| Parameter | Type |
|
|
3313
|
+
| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
3314
|
+
| `env` | [`OysterWorkerEnv`](#oysterworkerenv) |
|
|
3315
|
+
| `auth` | [`OysterAuth`](host.md#oysterauth) |
|
|
3316
|
+
| `options` | `Pick`\<`Readonly`\<\{ `approvals?`: `Readonly`\<\{ `submit`: `Promise`\<[`OysterApprovalResult`](host.md#oysterapprovalresult)\>; \}\>; `workflows?`: (`principal`) => `Promise`\< \| `Readonly`\<\{ `status`: `Promise`\<...\>; `cancel`: `Promise`\<...\>; \}\> \| `null`\>; `computerControl?`: (`principal`) => \| `Readonly`\<\{ `list`: `Promise`\<\{ `computers`: ...; `nextOffset`: ...; \}\>; `state`: `Promise`\<... \| ...\>; `start`: `Promise`\<... \| ...\>; `create`: `Promise`\<... \| ...\>; `backends`: `Promise`\<...[]\>; `attachLocal`: `Promise`\<... \| ...\>; `detachLocal`: `Promise`\<... \| ...\>; \}\> \| `null`; `permissionResources?`: (`principal`) => `Promise`\<readonly [`ResourceOption`](apps.md#resourceoption)[]\>; `auth`: [`OysterAuth`](host.md#oysterauth); `backgroundOriginKey?`: () => `Promise`\<`CryptoKey`\>; `artifacts`: [`ArtifactStore`](host.md#artifactstore); `uiCache?`: `Readonly`\<\{ `match`: (`digest`) => `Promise`\<`ReadableStream`\<...\> \| `null`\>; `put`: (`digest`, `bytes`) => `Promise`\<`"stored"` \| `"unstored"`\>; \}\>; `installations`: [`InstallationStore`](host.md#installationstore); `instances`: [`InstanceDirectory`](host.md#instancedirectory); `bootUi`: (`release`) => `Promise`\< \| \{ `kind`: `"passed"`; \} \| \{ `kind`: `"failed"`; `code`: `"ui_mount_failed"`; `diagnostics?`: \{ `failedPredicate`: ... \| ... \| ... \| ... \| ...; `errorName?`: ... \| ... \| ... \| ... \| ... \| ... \| ... \| ...; `finalUrlPath`: `string`; `consoleErrors`: ...[]; `pageErrors`: ...[]; `failedRequests`: ...[]; `droppedCount`: `number`; \}; \} \| \{ `kind`: `"not_checked"`; `code`: \| `"boot_runner_unavailable"` \| `"boot_browser_binding_missing"` \| `"boot_clone_unavailable"` \| `"boot_timeout"` \| `"boot_cleanup_failed"` \| `"ui_check_not_run_on_host"`; \}\>; `computerId?`: `string`; `computerName?`: `string` \| `null`; `computer?`: (`principal`) => \| `Readonly`\<\{ `getCapabilities`: (`signal`) => `Promise`\<...\>; `call`: (`capabilityId`, `input`, `context`) => `Promise`\<...\>; \}\> \| `Promise`\< \| `Readonly`\<\{ `getCapabilities`: ...; `call`: ...; \}\> \| `null`\> \| `null`; `appToolPolicy?`: (`actor`) => \| \{ `level`: `"read"` \| `"write"`; `revision`: `string`; `grantedBy`: `string`; \} \| `Promise`\< \| \{ `level`: ... \| ...; `revision`: `string`; `grantedBy`: `string`; \} \| `null`\> \| `null`; `keys?`: `Readonly`\<\{ `live`: `Promise`\< \| `Readonly`\<\{ `keyId`: ...; `owner`: ...; `grantVersion`: ...; `grants`: ...; \}\> \| `null`\>; \}\>; `guestLimits?`: `Partial`\<`Readonly`\<\{ `cpuMs`: `number`; `subRequests`: `number`; \}\>\>; `mcp?`: `Readonly`\<\{ `handleRequest`: (`request`) => `Promise`\<`Response`\>; `close?`: () => `Promise`\<`void`\>; \}\>; `git?`: `Readonly`\<\{ `writerOf`: `Extract`\<`GitWriter`, \{ `kind`: `"actor"`; \}\>; `workflowPass?`: `Promise`\< \| `Readonly`\<\{ `kind`: ...; `actor`: ...; `role?`: ...; `workflow?`: ...; \}\> \| `null`\>; `buildPass?`: `Promise`\< \| `Readonly`\<\{ `kind`: ...; `actor`: ...; `role?`: ...; `workflow?`: ...; \}\> \| `null`\>; `git`: `Promise`\<`Readonly`\<\{ `push`: `Promise`\<...\>; `read`: `Promise`\<...\>; `binding`: `GitBinding`; \}\>\>; \}\>; `ownerRoutes?`: [`Routes`](authorization.md#routes)\<[`OysterEnv`](host.md#oysterenv)\>; `capabilities?`: readonly `Readonly`\<`object` & `object`\>[]; `workbench?`: `Readonly`\<\{ `directory`: `Promise`\<`Readonly`\<\{ `apps`: readonly ...[]; `roles`: [`OysterRootRoles`](root-data.md#oysterrootroles); `computer?`: ... \| ...; `installing?`: ... \| ...; \}\>\>; `storage`: `Pick`\<`AppStorageWire`, `"read"` \| `"write"` \| `"reset"`\> & `Readonly`\<\{ `events`: `Promise`\<...\>; \}\>; \}\>; `homeInstallationId?`: `string`; `pageScript?`: `string`; `pageAssets?`: () => `Promise`\<\{ `pageScript`: `string`; `fontStyles`: `string`; `loginFontStyles`: `string`; `shellStyles`: `string`; `grantConsentScript`: `string`; \}\>; `title?`: `string`; \}\>, `"appToolPolicy"` \| `"guestLimits"`\> & `Readonly`\<\{ `workspace?`: `Readonly`\<\{ `computerId`: `string`; `computerName?`: `string` \| `null`; `files`: [`FileSource`](files.md#filesource); `computer?`: (`principal`) => \| `Readonly`\<\{ `getCapabilities`: ...; `call`: ...; \}\> \| `Promise`\<... \| ...\> \| `null`; \}\>; `scope?`: `Readonly`\<\{ `tenantId`: `string` & `Brand`\<`"OysterTenantId"`\>; `origin`: `string`; `durableName`: `string`; `computerName`: `string`; `workspacePrefix`: `string`; `repositoryPrefix`: `string`; \}\>; \}\> |
|
|
3230
3317
|
|
|
3231
3318
|
#### Returns
|
|
3232
3319
|
|