@fungi.computer/oyster 0.32.0 → 0.34.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 +59 -0
- package/dist/app-sandbox.d.ts +2 -2
- package/dist/app-sandbox.js +2 -2
- package/dist/app-test-copies.d.ts +87 -0
- package/dist/app-test-copies.js +170 -0
- package/dist/app-test-copy-page.d.ts +4 -0
- package/dist/app-test-copy-page.js +89 -0
- 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/browser/operations.d.ts +1 -1
- package/dist/cloudflare.d.ts +68 -3
- package/dist/cloudflare.js +214 -3
- package/dist/embed-metafiles.js +2 -2
- package/dist/embed-scripts.js +1 -1
- package/dist/host.d.ts +20 -4
- package/dist/host.js +314 -3
- package/dist/installation-operations.d.ts +247 -8
- package/dist/installation-operations.js +145 -7
- package/dist/installation-recovery-page.d.ts +24 -0
- package/dist/installation-recovery-page.js +168 -0
- package/dist/mcp.js +42 -13
- package/dist/older-oyster-store.d.ts +1 -1
- package/dist/older-oyster-store.js +2 -4
- package/dist/page/app-permissions.js +8 -7
- package/dist/page/computer-handles.d.ts +0 -1
- package/dist/page/mount.d.ts +2 -101
- package/dist/page/mount.js +1 -22
- package/dist/page-config.d.ts +102 -0
- package/dist/page-config.js +24 -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/recovery-style.d.ts +5 -0
- package/dist/recovery-style.js +32 -0
- package/dist/standalone/agents.d.ts +1 -1
- 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 +14 -21
- package/dist/standalone/registry.js +74 -28
- package/dist/standalone/worker.js +6 -3
- package/dist/starter-agent.d.ts +6 -2
- package/dist/starter-agent.js +25 -4
- package/dist/upgrade/old-worker-http.d.ts +2 -0
- package/dist/upgrade/old-worker-http.js +22 -0
- package/dist/upgrade/old-worker-readonly.d.ts +14 -0
- package/dist/upgrade/old-worker-readonly.js +22 -0
- package/dist/upgrade/old-worker-sql.d.ts +10 -0
- package/dist/upgrade/old-worker-sql.js +68 -0
- package/dist/upgrade/old-worker-stream.d.ts +12 -0
- package/dist/upgrade/old-worker-stream.js +54 -0
- package/dist/upgrade/private-stage.d.ts +23 -0
- package/dist/upgrade/private-stage.js +109 -0
- package/dist/upgrade/standalone-001.d.ts +16 -0
- package/dist/upgrade/standalone-001.js +31 -0
- package/dist/upgrade/standalone-01.d.ts +37 -0
- package/dist/upgrade/standalone-01.js +55 -0
- package/dist/upgrade/standalone-02.d.ts +37 -0
- package/dist/upgrade/standalone-02.js +55 -0
- package/dist/workers.d.ts +45 -14
- package/dist/workers.js +198 -21
- package/docs/api/README.md +8 -3
- package/docs/api/apps.md +21 -0
- package/docs/api/cloudflare.md +57 -0
- package/docs/api/host.md +263 -25
- package/docs/api/page/mount.md +13 -81
- package/docs/api/workers-git.md +246 -1
- package/docs/api/workers.md +518 -95
- package/package.json +38 -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`; `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`; `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` |
|
|
152
|
+
|
|
153
|
+
###### Returns
|
|
154
|
+
|
|
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` |
|
|
160
180
|
|
|
161
181
|
###### Returns
|
|
162
182
|
|
|
163
|
-
`Promise
|
|
164
|
-
`description`: \{ `title`: `string`; `inputBytes`: `number`; `inputSha256`:
|
|
165
|
-
`string`; \}; \} \| `ApprovalApplyResult`\>
|
|
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
|
|
|
@@ -493,6 +520,62 @@ it.
|
|
|
493
520
|
|
|
494
521
|
```ts
|
|
495
522
|
installationOperation(input): Promise<
|
|
523
|
+
| {
|
|
524
|
+
kind: "recovery";
|
|
525
|
+
recovery: | {
|
|
526
|
+
authorityVersion: number;
|
|
527
|
+
storeGeneration: string;
|
|
528
|
+
release: {
|
|
529
|
+
releaseId: ReleaseId;
|
|
530
|
+
appId: AppId;
|
|
531
|
+
artifact: {
|
|
532
|
+
artifactRef: ArtifactRef;
|
|
533
|
+
artifactDigest: Sha256Digest;
|
|
534
|
+
provenance: {
|
|
535
|
+
sourceRevision: SourceRevision;
|
|
536
|
+
sourceTreeDigest: Sha256Digest;
|
|
537
|
+
buildRecipeDigest: Sha256Digest;
|
|
538
|
+
};
|
|
539
|
+
};
|
|
540
|
+
};
|
|
541
|
+
uiCheck: | {
|
|
542
|
+
kind: "passed";
|
|
543
|
+
}
|
|
544
|
+
| {
|
|
545
|
+
kind: "failed";
|
|
546
|
+
code: "ui_mount_failed";
|
|
547
|
+
diagnostics?: {
|
|
548
|
+
failedPredicate: | "unexpected_candidate_request"
|
|
549
|
+
| "response_status"
|
|
550
|
+
| "request_failed"
|
|
551
|
+
| "page_error"
|
|
552
|
+
| "candidate_not_mounted";
|
|
553
|
+
errorName?: | "Error"
|
|
554
|
+
| "TypeError"
|
|
555
|
+
| "RangeError"
|
|
556
|
+
| "SyntaxError"
|
|
557
|
+
| "AbortError"
|
|
558
|
+
| "TimeoutError"
|
|
559
|
+
| "Other";
|
|
560
|
+
finalUrlPath: string;
|
|
561
|
+
consoleErrors: string[];
|
|
562
|
+
pageErrors: string[];
|
|
563
|
+
failedRequests: object[];
|
|
564
|
+
droppedCount: number;
|
|
565
|
+
};
|
|
566
|
+
}
|
|
567
|
+
| {
|
|
568
|
+
kind: "not_checked";
|
|
569
|
+
code: | "boot_runner_unavailable"
|
|
570
|
+
| "boot_browser_binding_missing"
|
|
571
|
+
| "boot_clone_unavailable"
|
|
572
|
+
| "boot_timeout"
|
|
573
|
+
| "boot_cleanup_failed"
|
|
574
|
+
| "ui_check_not_run_on_host";
|
|
575
|
+
};
|
|
576
|
+
}
|
|
577
|
+
| null;
|
|
578
|
+
}
|
|
496
579
|
| {
|
|
497
580
|
kind: "refused";
|
|
498
581
|
code: | "request_conflict"
|
|
@@ -668,7 +751,7 @@ installationOperation(input): Promise<
|
|
|
668
751
|
| {
|
|
669
752
|
kind: "command";
|
|
670
753
|
command: | {
|
|
671
|
-
admission: {
|
|
754
|
+
admission: | {
|
|
672
755
|
requestId: string;
|
|
673
756
|
installationId: string;
|
|
674
757
|
release: {
|
|
@@ -698,7 +781,40 @@ installationOperation(input): Promise<
|
|
|
698
781
|
};
|
|
699
782
|
intent: "install-or-select" | "install-or-remint" | "create-only";
|
|
700
783
|
origin: "workflow" | "owner-direct";
|
|
701
|
-
|
|
784
|
+
}
|
|
785
|
+
| {
|
|
786
|
+
authorityVersion: number;
|
|
787
|
+
storeGeneration: string;
|
|
788
|
+
requestId: string;
|
|
789
|
+
installationId: string;
|
|
790
|
+
actor: | {
|
|
791
|
+
kind: "member";
|
|
792
|
+
memberId: string;
|
|
793
|
+
}
|
|
794
|
+
| {
|
|
795
|
+
kind: "agent";
|
|
796
|
+
agentId: string;
|
|
797
|
+
}
|
|
798
|
+
| {
|
|
799
|
+
kind: "team-key";
|
|
800
|
+
keyId: string;
|
|
801
|
+
};
|
|
802
|
+
intent: "rollback";
|
|
803
|
+
origin: "owner-direct";
|
|
804
|
+
release: {
|
|
805
|
+
releaseId: ReleaseId;
|
|
806
|
+
appId: AppId;
|
|
807
|
+
artifact: {
|
|
808
|
+
artifactRef: ArtifactRef;
|
|
809
|
+
artifactDigest: Sha256Digest;
|
|
810
|
+
provenance: {
|
|
811
|
+
sourceRevision: SourceRevision;
|
|
812
|
+
sourceTreeDigest: Sha256Digest;
|
|
813
|
+
buildRecipeDigest: Sha256Digest;
|
|
814
|
+
};
|
|
815
|
+
};
|
|
816
|
+
};
|
|
817
|
+
};
|
|
702
818
|
scope: {
|
|
703
819
|
tenantId: string & Brand<"OysterTenantId">;
|
|
704
820
|
origin: string;
|
|
@@ -842,19 +958,35 @@ command for the caller's tenant scope.
|
|
|
842
958
|
|
|
843
959
|
###### Parameters
|
|
844
960
|
|
|
845
|
-
| Parameter | Type
|
|
846
|
-
| --------- |
|
|
847
|
-
| `input` | \| \{ `action`: `"admit"`; `scope`: \{ `tenantId`: `string` & `Brand`\<`"OysterTenantId"`\>; `origin`: `string`; \}; `input`: \{ `requestId`: `string`; `installationId`: `string`; `release`: \{ `releaseId`: `ReleaseId`; `appId`: `AppId`; `artifact`: \{ `artifactRef`: `ArtifactRef`; `artifactDigest`: `Sha256Digest`; `provenance`: \{ `sourceRevision`: `SourceRevision`; `sourceTreeDigest`: `Sha256Digest`; `buildRecipeDigest`: `Sha256Digest`; \}; \}; \}; `actor`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; `intent`: `"install-or-select"` \| `"install-or-remint"` \| `"create-only"`; `origin`: `"workflow"` \| `"owner-direct"`; \}; \} \| \{ `action`: `"read"`; `scope`: \{ `tenantId`: `string` & `Brand`\<`"OysterTenantId"`\>; `origin`: `string`; \}; `requestId`: `string`; `installationId`: `string`; \} \| \{ `action`: `"await"`; `scope`: \{ `tenantId`: `string` & `Brand`\<`"OysterTenantId"`\>; `origin`: `string`; \}; `requestId`: `string`; `installationId`: `string`; `waitMs`: `number`; \} \| \{ `action`: `"load"`; `scope`: \{ `tenantId`: `string` & `Brand`\<`"OysterTenantId"`\>; `origin`: `string`; \}; `requestId`: `string`; \} \| \{ `action`: `"plan"`; `scope`: \{ `tenantId`: `string` & `Brand`\<`"OysterTenantId"`\>; `origin`: `string`; \}; `requestId`: `string`; `installation`: \{ `installationId`: `string`; `instanceId`: [`InstanceId`](index.md#instanceid) \| `null`; `appId`: `AppId`; `release`: \{ `releaseId`: `ReleaseId`; `appId`: `AppId`; `artifact`: \{ `artifactRef`: `ArtifactRef`; `artifactDigest`: `Sha256Digest`; `provenance`: \{ `sourceRevision`: `SourceRevision`; `sourceTreeDigest`: `Sha256Digest`; `buildRecipeDigest`: `Sha256Digest`; \}; \}; \}; `releasePin`: `"pinned"` \| `"floating"`; `authority`: \{ `authorityVersion`: `number`; `declaredOperationsDigest`: `Sha256Digest`; `approvedGrants`: readonly `Readonly`\<\{ `capability`: \| `"computer.list"` \| `"computer.readFile"` \| `"computer.writeFile"` \| `"computer.execute"` \| `"approvals"` \| `"agent.list"` \| `"agent.manage"` \| `"agent.rename"` \| `"agent.avatar"` \| `"agent.instructions"` \| `"agent.toolPolicy"` \| `"agent.read"` \| `"agent.send"` \| `"llm.generation"` \| `"media.generation"` \| `"media.share"` \| `"games:servers"` \| `"git.repository"` \| `"apps.open"` \| `"apps.call"` \| `"app.storage"` \| `"app.events.emit"` \| `"team.workbenchHost"` \| `"marketplace.browse"` \| `"marketplace.purchase"` \| `"workflow.run"` \| `"workflow.publish"` \| `"workflow.arm"` \| `"world"` \| `"channels.read"` \| `"channels.personal.manage"`; `capabilityApproved`: `true`; `operations`: readonly `string`[]; `fingerprints`: `Readonly`\<`Record`\<`string`, `string`\>\>; `resources`: \| `"tenant-scope"` \| readonly `Readonly`\<\{ `kind`: ...; `id`: ...; \}\>[]; \}\>[]; `approval`: \| `Readonly`\<\{ `by`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; `at`: `number`; `authorityVersion`: `number`; \}\> \| `null`; \}; `status`: `"enabled"` \| `"disabled"` \| `"deleted"`; \}; `hasBackend`: `boolean`; \} \| \{ `action`: `"commit"`; `scope`: \{ `tenantId`: `string` & `Brand`\<`"OysterTenantId"`\>; `origin`: `string`; \}; `requestId`: `string`; `uiCheck`: \| \{ `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`; \}; \} \| \{ `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"`; \} \| `null`; \} |
|
|
961
|
+
| Parameter | Type |
|
|
962
|
+
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
963
|
+
| `input` | \| \{ `action`: `"recovery"`; `scope`: \{ `tenantId`: `string` & `Brand`\<`"OysterTenantId"`\>; `origin`: `string`; \}; `installationId`: `string`; \} \| \{ `action`: `"admit"`; `scope`: \{ `tenantId`: `string` & `Brand`\<`"OysterTenantId"`\>; `origin`: `string`; \}; `input`: \| \{ `requestId`: `string`; `installationId`: `string`; `release`: \{ `releaseId`: `ReleaseId`; `appId`: `AppId`; `artifact`: \{ `artifactRef`: `ArtifactRef`; `artifactDigest`: `Sha256Digest`; `provenance`: \{ `sourceRevision`: `SourceRevision`; `sourceTreeDigest`: `Sha256Digest`; `buildRecipeDigest`: `Sha256Digest`; \}; \}; \}; `actor`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; `intent`: `"install-or-select"` \| `"install-or-remint"` \| `"create-only"`; `origin`: `"workflow"` \| `"owner-direct"`; \} \| \{ `authorityVersion`: `number`; `storeGeneration`: `string`; `requestId`: `string`; `installationId`: `string`; `actor`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; `intent`: `"rollback"`; `origin`: `"owner-direct"`; \}; \} \| \{ `action`: `"read"`; `scope`: \{ `tenantId`: `string` & `Brand`\<`"OysterTenantId"`\>; `origin`: `string`; \}; `requestId`: `string`; `installationId`: `string`; \} \| \{ `action`: `"await"`; `scope`: \{ `tenantId`: `string` & `Brand`\<`"OysterTenantId"`\>; `origin`: `string`; \}; `requestId`: `string`; `installationId`: `string`; `waitMs`: `number`; \} \| \{ `action`: `"load"`; `scope`: \{ `tenantId`: `string` & `Brand`\<`"OysterTenantId"`\>; `origin`: `string`; \}; `requestId`: `string`; \} \| \{ `action`: `"plan"`; `scope`: \{ `tenantId`: `string` & `Brand`\<`"OysterTenantId"`\>; `origin`: `string`; \}; `requestId`: `string`; `installation`: \{ `installationId`: `string`; `instanceId`: [`InstanceId`](index.md#instanceid) \| `null`; `appId`: `AppId`; `release`: \{ `releaseId`: `ReleaseId`; `appId`: `AppId`; `artifact`: \{ `artifactRef`: `ArtifactRef`; `artifactDigest`: `Sha256Digest`; `provenance`: \{ `sourceRevision`: `SourceRevision`; `sourceTreeDigest`: `Sha256Digest`; `buildRecipeDigest`: `Sha256Digest`; \}; \}; \}; `releasePin`: `"pinned"` \| `"floating"`; `authority`: \{ `authorityVersion`: `number`; `declaredOperationsDigest`: `Sha256Digest`; `approvedGrants`: readonly `Readonly`\<\{ `capability`: \| `"computer.list"` \| `"computer.readFile"` \| `"computer.writeFile"` \| `"computer.execute"` \| `"approvals"` \| `"agent.list"` \| `"agent.manage"` \| `"agent.rename"` \| `"agent.avatar"` \| `"agent.instructions"` \| `"agent.toolPolicy"` \| `"agent.read"` \| `"agent.send"` \| `"llm.generation"` \| `"media.generation"` \| `"media.share"` \| `"games:servers"` \| `"git.repository"` \| `"apps.open"` \| `"apps.call"` \| `"app.storage"` \| `"app.events.emit"` \| `"team.workbenchHost"` \| `"marketplace.browse"` \| `"marketplace.purchase"` \| `"workflow.run"` \| `"workflow.publish"` \| `"workflow.arm"` \| `"world"` \| `"channels.read"` \| `"channels.personal.manage"`; `capabilityApproved`: `true`; `operations`: readonly `string`[]; `fingerprints`: `Readonly`\<`Record`\<`string`, `string`\>\>; `resources`: \| `"tenant-scope"` \| readonly `Readonly`\<\{ `kind`: ...; `id`: ...; \}\>[]; \}\>[]; `approval`: \| `Readonly`\<\{ `by`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; `at`: `number`; `authorityVersion`: `number`; \}\> \| `null`; \}; `status`: `"enabled"` \| `"disabled"` \| `"deleted"`; \}; `hasBackend`: `boolean`; \} \| \{ `action`: `"commit"`; `scope`: \{ `tenantId`: `string` & `Brand`\<`"OysterTenantId"`\>; `origin`: `string`; \}; `requestId`: `string`; `uiCheck`: \| \{ `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`; \}; \} \| \{ `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"`; \} \| `null`; \} |
|
|
848
964
|
|
|
849
965
|
###### Returns
|
|
850
966
|
|
|
851
|
-
`Promise`\< \| \{ `kind`: `"
|
|
852
|
-
`
|
|
853
|
-
`
|
|
854
|
-
`
|
|
855
|
-
`
|
|
856
|
-
\{ `
|
|
857
|
-
|
|
967
|
+
`Promise`\< \| \{ `kind`: `"recovery"`; `recovery`: \| \{ `authorityVersion`:
|
|
968
|
+
`number`; `storeGeneration`: `string`; `release`: \{ `releaseId`: `ReleaseId`;
|
|
969
|
+
`appId`: `AppId`; `artifact`: \{ `artifactRef`: `ArtifactRef`; `artifactDigest`:
|
|
970
|
+
`Sha256Digest`; `provenance`: \{ `sourceRevision`: `SourceRevision`;
|
|
971
|
+
`sourceTreeDigest`: `Sha256Digest`; `buildRecipeDigest`: `Sha256Digest`; \}; \};
|
|
972
|
+
\}; `uiCheck`: \| \{ `kind`: `"passed"`; \} \| \{ `kind`: `"failed"`; `code`:
|
|
973
|
+
`"ui_mount_failed"`; `diagnostics?`: \{ `failedPredicate`: \|
|
|
974
|
+
`"unexpected_candidate_request"` \| `"response_status"` \| `"request_failed"` \|
|
|
975
|
+
`"page_error"` \| `"candidate_not_mounted"`; `errorName?`: \| `"Error"` \|
|
|
976
|
+
`"TypeError"` \| `"RangeError"` \| `"SyntaxError"` \| `"AbortError"` \|
|
|
977
|
+
`"TimeoutError"` \| `"Other"`; `finalUrlPath`: `string`; `consoleErrors`:
|
|
978
|
+
`string`[]; `pageErrors`: `string`[]; `failedRequests`: `object`[];
|
|
979
|
+
`droppedCount`: `number`; \}; \} \| \{ `kind`: `"not_checked"`; `code`: \|
|
|
980
|
+
`"boot_runner_unavailable"` \| `"boot_browser_binding_missing"` \|
|
|
981
|
+
`"boot_clone_unavailable"` \| `"boot_timeout"` \| `"boot_cleanup_failed"` \|
|
|
982
|
+
`"ui_check_not_run_on_host"`; \}; \} \| `null`; \} \| \{ `kind`: `"refused"`;
|
|
983
|
+
`code`: \| `"request_conflict"` \| `"unavailable"` \| `"stale_authority"` \|
|
|
984
|
+
`"needs_consent"` \| `"stored_operation_invalid"`; \} \| \{ `kind`:
|
|
985
|
+
`"operation"`; `operation`: \| \{ `requestId`: `string`;
|
|
986
|
+
`requestedInstallationId`: `string`; `installationId`: `string`; `release`: \{
|
|
987
|
+
`releaseId`: `ReleaseId`; `appId`: `AppId`; `artifact`: \{ `artifactRef`:
|
|
988
|
+
`ArtifactRef`; `artifactDigest`: `Sha256Digest`; `provenance`: \{
|
|
989
|
+
`sourceRevision`: `SourceRevision`; `sourceTreeDigest`: `Sha256Digest`;
|
|
858
990
|
`buildRecipeDigest`: `Sha256Digest`; \}; \}; \}; `state`: `"refused"`; `status`:
|
|
859
991
|
`number`; `code`: `string`; \} \| \{ `requestId`: `string`;
|
|
860
992
|
`requestedInstallationId`: `string`; `installationId`: `string`; `release`: \{
|
|
@@ -899,7 +1031,7 @@ command for the caller's tenant scope.
|
|
|
899
1031
|
`ArtifactRef`; `artifactDigest`: `Sha256Digest`; `provenance`: \{
|
|
900
1032
|
`sourceRevision`: `SourceRevision`; `sourceTreeDigest`: `Sha256Digest`;
|
|
901
1033
|
`buildRecipeDigest`: `Sha256Digest`; \}; \}; \}; `state`: `"pending"`; \} \|
|
|
902
|
-
`null`; \} \| \{ `kind`: `"command"`; `command`: \| \{ `admission`: \{
|
|
1034
|
+
`null`; \} \| \{ `kind`: `"command"`; `command`: \| \{ `admission`: \| \{
|
|
903
1035
|
`requestId`: `string`; `installationId`: `string`; `release`: \{ `releaseId`:
|
|
904
1036
|
`ReleaseId`; `appId`: `AppId`; `artifact`: \{ `artifactRef`: `ArtifactRef`;
|
|
905
1037
|
`artifactDigest`: `Sha256Digest`; `provenance`: \{ `sourceRevision`:
|
|
@@ -908,7 +1040,15 @@ command for the caller's tenant scope.
|
|
|
908
1040
|
`string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`:
|
|
909
1041
|
`"team-key"`; `keyId`: `string`; \}; `intent`: `"install-or-select"` \|
|
|
910
1042
|
`"install-or-remint"` \| `"create-only"`; `origin`: `"workflow"` \|
|
|
911
|
-
`"owner-direct"`; \}
|
|
1043
|
+
`"owner-direct"`; \} \| \{ `authorityVersion`: `number`; `storeGeneration`:
|
|
1044
|
+
`string`; `requestId`: `string`; `installationId`: `string`; `actor`: \| \{
|
|
1045
|
+
`kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`:
|
|
1046
|
+
`string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; `intent`:
|
|
1047
|
+
`"rollback"`; `origin`: `"owner-direct"`; `release`: \{ `releaseId`:
|
|
1048
|
+
`ReleaseId`; `appId`: `AppId`; `artifact`: \{ `artifactRef`: `ArtifactRef`;
|
|
1049
|
+
`artifactDigest`: `Sha256Digest`; `provenance`: \{ `sourceRevision`:
|
|
1050
|
+
`SourceRevision`; `sourceTreeDigest`: `Sha256Digest`; `buildRecipeDigest`:
|
|
1051
|
+
`Sha256Digest`; \}; \}; \}; \}; `scope`: \{ `tenantId`: `string` &
|
|
912
1052
|
`Brand`\<`"OysterTenantId"`\>; `origin`: `string`; \}; `installationId`:
|
|
913
1053
|
`string`; `instanceId`: [`InstanceId`](index.md#instanceid); `generation`:
|
|
914
1054
|
`string`; `baseline`: \| \{ `installationId`: `string`; `instanceId`:
|
|
@@ -1462,6 +1602,70 @@ Native RPC returns a closed result; callers never classify a transported Error.
|
|
|
1462
1602
|
|
|
1463
1603
|
`Promise`\<[`InstallationCommit`](host.md#installationcommit)\>
|
|
1464
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
|
+
|
|
1465
1669
|
##### bootCapability()
|
|
1466
1670
|
|
|
1467
1671
|
```ts
|
|
@@ -1598,6 +1802,231 @@ DurableObject<Env>.constructor
|
|
|
1598
1802
|
|
|
1599
1803
|
#### Methods
|
|
1600
1804
|
|
|
1805
|
+
##### openTestCopy()
|
|
1806
|
+
|
|
1807
|
+
```ts
|
|
1808
|
+
openTestCopy(
|
|
1809
|
+
authority,
|
|
1810
|
+
requestId,
|
|
1811
|
+
tenantId?
|
|
1812
|
+
): Promise<InstanceResult<{
|
|
1813
|
+
selection: {
|
|
1814
|
+
instanceId: InstanceId;
|
|
1815
|
+
owner: {
|
|
1816
|
+
kind: "installation" | "deployment";
|
|
1817
|
+
id: string;
|
|
1818
|
+
};
|
|
1819
|
+
appId: AppId;
|
|
1820
|
+
releaseId: ReleaseId;
|
|
1821
|
+
authorityVersion: number;
|
|
1822
|
+
};
|
|
1823
|
+
storeGeneration: string;
|
|
1824
|
+
copyId: string;
|
|
1825
|
+
expiresAt: number;
|
|
1826
|
+
}>>;
|
|
1827
|
+
```
|
|
1828
|
+
|
|
1829
|
+
Open only under the existing Instance serialization and pinned tenant.
|
|
1830
|
+
|
|
1831
|
+
###### Parameters
|
|
1832
|
+
|
|
1833
|
+
| Parameter | Type | Default value |
|
|
1834
|
+
| -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
|
|
1835
|
+
| `authority` | \{ `selection`: \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \}; `storeGeneration`: `string`; \} | `undefined` |
|
|
1836
|
+
| `authority.selection` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \} | `...` |
|
|
1837
|
+
| `authority.selection.instanceId` | [`InstanceId`](index.md#instanceid) | `instanceIdSchema` |
|
|
1838
|
+
| `authority.selection.owner` | \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \} | `ownerSchema` |
|
|
1839
|
+
| `authority.selection.owner.kind` | `"installation"` \| `"deployment"` | `...` |
|
|
1840
|
+
| `authority.selection.owner.id` | `string` | `Schema.NonEmptyString` |
|
|
1841
|
+
| `authority.selection.appId` | `AppId` | `appIdSchema` |
|
|
1842
|
+
| `authority.selection.releaseId` | `ReleaseId` | `releaseIdSchema` |
|
|
1843
|
+
| `authority.selection.authorityVersion` | `number` | `...` |
|
|
1844
|
+
| `authority.storeGeneration` | `string` | `...` |
|
|
1845
|
+
| `requestId` | `string` | `undefined` |
|
|
1846
|
+
| `tenantId` | `string` & `Brand`\<`"OysterTenantId"`\> | `defaultTenant` |
|
|
1847
|
+
|
|
1848
|
+
###### Returns
|
|
1849
|
+
|
|
1850
|
+
`Promise`\<[`InstanceResult`](host.md#instanceresult)\<\{ `selection`: \{
|
|
1851
|
+
`instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`:
|
|
1852
|
+
`"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`;
|
|
1853
|
+
`releaseId`: `ReleaseId`; `authorityVersion`: `number`; \}; `storeGeneration`:
|
|
1854
|
+
`string`; `copyId`: `string`; `expiresAt`: `number`; \}\>\>
|
|
1855
|
+
|
|
1856
|
+
##### inspectTestCopy()
|
|
1857
|
+
|
|
1858
|
+
```ts
|
|
1859
|
+
inspectTestCopy(authority, tenantId?): Promise<InstanceResult<
|
|
1860
|
+
| {
|
|
1861
|
+
selection: {
|
|
1862
|
+
instanceId: InstanceId;
|
|
1863
|
+
owner: {
|
|
1864
|
+
kind: "installation" | "deployment";
|
|
1865
|
+
id: string;
|
|
1866
|
+
};
|
|
1867
|
+
appId: AppId;
|
|
1868
|
+
releaseId: ReleaseId;
|
|
1869
|
+
authorityVersion: number;
|
|
1870
|
+
};
|
|
1871
|
+
storeGeneration: string;
|
|
1872
|
+
copyId: string;
|
|
1873
|
+
expiresAt: number;
|
|
1874
|
+
}
|
|
1875
|
+
| null>>;
|
|
1876
|
+
```
|
|
1877
|
+
|
|
1878
|
+
Observation rechecks both applied selection and current registry incarnation.
|
|
1879
|
+
|
|
1880
|
+
###### Parameters
|
|
1881
|
+
|
|
1882
|
+
| Parameter | Type | Default value |
|
|
1883
|
+
| -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
|
|
1884
|
+
| `authority` | \{ `selection`: \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \}; `storeGeneration`: `string`; \} | `undefined` |
|
|
1885
|
+
| `authority.selection` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \} | `...` |
|
|
1886
|
+
| `authority.selection.instanceId` | [`InstanceId`](index.md#instanceid) | `instanceIdSchema` |
|
|
1887
|
+
| `authority.selection.owner` | \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \} | `ownerSchema` |
|
|
1888
|
+
| `authority.selection.owner.kind` | `"installation"` \| `"deployment"` | `...` |
|
|
1889
|
+
| `authority.selection.owner.id` | `string` | `Schema.NonEmptyString` |
|
|
1890
|
+
| `authority.selection.appId` | `AppId` | `appIdSchema` |
|
|
1891
|
+
| `authority.selection.releaseId` | `ReleaseId` | `releaseIdSchema` |
|
|
1892
|
+
| `authority.selection.authorityVersion` | `number` | `...` |
|
|
1893
|
+
| `authority.storeGeneration` | `string` | `...` |
|
|
1894
|
+
| `tenantId` | `string` & `Brand`\<`"OysterTenantId"`\> | `defaultTenant` |
|
|
1895
|
+
|
|
1896
|
+
###### Returns
|
|
1897
|
+
|
|
1898
|
+
`Promise`\<[`InstanceResult`](host.md#instanceresult)\< \| \{ `selection`: \{
|
|
1899
|
+
`instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`:
|
|
1900
|
+
`"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`;
|
|
1901
|
+
`releaseId`: `ReleaseId`; `authorityVersion`: `number`; \}; `storeGeneration`:
|
|
1902
|
+
`string`; `copyId`: `string`; `expiresAt`: `number`; \} \| `null`\>\>
|
|
1903
|
+
|
|
1904
|
+
##### discardTestCopy()
|
|
1905
|
+
|
|
1906
|
+
```ts
|
|
1907
|
+
discardTestCopy(
|
|
1908
|
+
authority,
|
|
1909
|
+
copyId,
|
|
1910
|
+
tenantId?
|
|
1911
|
+
): Promise<InstanceResult<boolean>>;
|
|
1912
|
+
```
|
|
1913
|
+
|
|
1914
|
+
A delayed discard cannot target a later sibling.
|
|
1915
|
+
|
|
1916
|
+
###### Parameters
|
|
1917
|
+
|
|
1918
|
+
| Parameter | Type | Default value |
|
|
1919
|
+
| -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
|
|
1920
|
+
| `authority` | \{ `selection`: \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \}; `storeGeneration`: `string`; \} | `undefined` |
|
|
1921
|
+
| `authority.selection` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \} | `...` |
|
|
1922
|
+
| `authority.selection.instanceId` | [`InstanceId`](index.md#instanceid) | `instanceIdSchema` |
|
|
1923
|
+
| `authority.selection.owner` | \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \} | `ownerSchema` |
|
|
1924
|
+
| `authority.selection.owner.kind` | `"installation"` \| `"deployment"` | `...` |
|
|
1925
|
+
| `authority.selection.owner.id` | `string` | `Schema.NonEmptyString` |
|
|
1926
|
+
| `authority.selection.appId` | `AppId` | `appIdSchema` |
|
|
1927
|
+
| `authority.selection.releaseId` | `ReleaseId` | `releaseIdSchema` |
|
|
1928
|
+
| `authority.selection.authorityVersion` | `number` | `...` |
|
|
1929
|
+
| `authority.storeGeneration` | `string` | `...` |
|
|
1930
|
+
| `copyId` | `string` | `undefined` |
|
|
1931
|
+
| `tenantId` | `string` & `Brand`\<`"OysterTenantId"`\> | `defaultTenant` |
|
|
1932
|
+
|
|
1933
|
+
###### Returns
|
|
1934
|
+
|
|
1935
|
+
`Promise`\<[`InstanceResult`](host.md#instanceresult)\<`boolean`\>\>
|
|
1936
|
+
|
|
1937
|
+
##### testCopyBackend()
|
|
1938
|
+
|
|
1939
|
+
```ts
|
|
1940
|
+
testCopyBackend(
|
|
1941
|
+
authority,
|
|
1942
|
+
copyId,
|
|
1943
|
+
request,
|
|
1944
|
+
limits?,
|
|
1945
|
+
tenantId?
|
|
1946
|
+
): Promise<Response>;
|
|
1947
|
+
```
|
|
1948
|
+
|
|
1949
|
+
Uses the ordinary invocation facade, without live bindings or host context.
|
|
1950
|
+
|
|
1951
|
+
###### Parameters
|
|
1952
|
+
|
|
1953
|
+
| Parameter | Type | Default value |
|
|
1954
|
+
| --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
|
|
1955
|
+
| `authority` | \{ `selection`: \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \}; `storeGeneration`: `string`; \} | `undefined` |
|
|
1956
|
+
| `authority.selection` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \} | `...` |
|
|
1957
|
+
| `authority.selection.instanceId` | [`InstanceId`](index.md#instanceid) | `instanceIdSchema` |
|
|
1958
|
+
| `authority.selection.owner` | \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \} | `ownerSchema` |
|
|
1959
|
+
| `authority.selection.owner.kind?` | `"installation"` \| `"deployment"` | `...` |
|
|
1960
|
+
| `authority.selection.owner.id?` | `string` | `Schema.NonEmptyString` |
|
|
1961
|
+
| `authority.selection.appId?` | `AppId` | `appIdSchema` |
|
|
1962
|
+
| `authority.selection.releaseId?` | `ReleaseId` | `releaseIdSchema` |
|
|
1963
|
+
| `authority.selection.authorityVersion?` | `number` | `...` |
|
|
1964
|
+
| `authority.storeGeneration?` | `string` | `...` |
|
|
1965
|
+
| `copyId?` | `string` | `undefined` |
|
|
1966
|
+
| `request?` | `Request` | `undefined` |
|
|
1967
|
+
| `limits?` | `Readonly`\<\{ `cpuMs`: `number`; `subRequests`: `number`; \}\> | `undefined` |
|
|
1968
|
+
| `tenantId?` | `string` & `Brand`\<`"OysterTenantId"`\> | `defaultTenant` |
|
|
1969
|
+
|
|
1970
|
+
###### Returns
|
|
1971
|
+
|
|
1972
|
+
`Promise`\<`Response`\>
|
|
1973
|
+
|
|
1974
|
+
##### callTestCopy()
|
|
1975
|
+
|
|
1976
|
+
```ts
|
|
1977
|
+
callTestCopy(
|
|
1978
|
+
authority,
|
|
1979
|
+
copyId,
|
|
1980
|
+
name,
|
|
1981
|
+
input,
|
|
1982
|
+
caller,
|
|
1983
|
+
limits?,
|
|
1984
|
+
tenantId?
|
|
1985
|
+
): Promise<InstanceResult<unknown>>;
|
|
1986
|
+
```
|
|
1987
|
+
|
|
1988
|
+
Declared methods share copy isolation, never a live invocation frame or binding
|
|
1989
|
+
env.
|
|
1990
|
+
|
|
1991
|
+
###### Parameters
|
|
1992
|
+
|
|
1993
|
+
| Parameter | Type | Default value |
|
|
1994
|
+
| --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
|
|
1995
|
+
| `authority` | \{ `selection`: \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \}; `storeGeneration`: `string`; \} | `undefined` |
|
|
1996
|
+
| `authority.selection` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \} | `...` |
|
|
1997
|
+
| `authority.selection.instanceId` | [`InstanceId`](index.md#instanceid) | `instanceIdSchema` |
|
|
1998
|
+
| `authority.selection.owner` | \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \} | `ownerSchema` |
|
|
1999
|
+
| `authority.selection.owner.kind` | `"installation"` \| `"deployment"` | `...` |
|
|
2000
|
+
| `authority.selection.owner.id` | `string` | `Schema.NonEmptyString` |
|
|
2001
|
+
| `authority.selection.appId?` | `AppId` | `appIdSchema` |
|
|
2002
|
+
| `authority.selection.releaseId?` | `ReleaseId` | `releaseIdSchema` |
|
|
2003
|
+
| `authority.selection.authorityVersion?` | `number` | `...` |
|
|
2004
|
+
| `authority.storeGeneration?` | `string` | `...` |
|
|
2005
|
+
| `copyId?` | `string` | `undefined` |
|
|
2006
|
+
| `name?` | `string` | `undefined` |
|
|
2007
|
+
| `input?` | `Json` | `undefined` |
|
|
2008
|
+
| `caller?` | \{ `computerId`: `string` \| `null`; `actor`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; `backgroundLane?`: `string`; `backgroundOrigin?`: \{ `method`: `string`; `seal`: `string`; \}; `role?`: `"member"` \| `"owner"` \| `"admin"`; `soleMember?`: `true`; `workflow?`: \{ `workflowId`: `string`; `runId`: `string`; `nodeId`: `string`; `armedBy`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; \}; `idempotencyKey?`: `string`; \} | `undefined` |
|
|
2009
|
+
| `caller.computerId?` | `string` \| `null` | `undefined` |
|
|
2010
|
+
| `caller.actor?` | \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \} | `undefined` |
|
|
2011
|
+
| `caller.backgroundLane?` | `string` | `undefined` |
|
|
2012
|
+
| `caller.backgroundOrigin?` | \{ `method`: `string`; `seal`: `string`; \} | `undefined` |
|
|
2013
|
+
| `caller.backgroundOrigin.method?` | `string` | `undefined` |
|
|
2014
|
+
| `caller.backgroundOrigin.seal?` | `string` | `undefined` |
|
|
2015
|
+
| `caller.role?` | `"member"` \| `"owner"` \| `"admin"` | `undefined` |
|
|
2016
|
+
| `caller.soleMember?` | `true` | `undefined` |
|
|
2017
|
+
| `caller.workflow?` | \{ `workflowId`: `string`; `runId`: `string`; `nodeId`: `string`; `armedBy`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; \} | `undefined` |
|
|
2018
|
+
| `caller.workflow.workflowId?` | `string` | `undefined` |
|
|
2019
|
+
| `caller.workflow.runId?` | `string` | `undefined` |
|
|
2020
|
+
| `caller.workflow.nodeId?` | `string` | `undefined` |
|
|
2021
|
+
| `caller.workflow.armedBy?` | \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \} | `undefined` |
|
|
2022
|
+
| `caller.idempotencyKey?` | `string` | `undefined` |
|
|
2023
|
+
| `limits?` | `Readonly`\<\{ `cpuMs`: `number`; `subRequests`: `number`; \}\> | `undefined` |
|
|
2024
|
+
| `tenantId?` | `string` & `Brand`\<`"OysterTenantId"`\> | `defaultTenant` |
|
|
2025
|
+
|
|
2026
|
+
###### Returns
|
|
2027
|
+
|
|
2028
|
+
`Promise`\<[`InstanceResult`](host.md#instanceresult)\<`unknown`\>\>
|
|
2029
|
+
|
|
1601
2030
|
##### bindingCall()
|
|
1602
2031
|
|
|
1603
2032
|
```ts
|
|
@@ -2598,13 +3027,7 @@ type OysterBindingContext<Env> = Readonly<{
|
|
|
2598
3027
|
backgroundHost: Promise<
|
|
2599
3028
|
| Readonly<{
|
|
2600
3029
|
approvals?: Readonly<{
|
|
2601
|
-
submit: Promise<
|
|
2602
|
-
| {
|
|
2603
|
-
kind: ...;
|
|
2604
|
-
recordId: ...;
|
|
2605
|
-
description: ...;
|
|
2606
|
-
}
|
|
2607
|
-
| ApprovalApplyResult>;
|
|
3030
|
+
submit: Promise<OysterApprovalResult>;
|
|
2608
3031
|
}>;
|
|
2609
3032
|
workflows?: (principal) => Promise<
|
|
2610
3033
|
| {
|
|
@@ -2762,9 +3185,9 @@ A loopback export with ordinary Worker I/O, not another resource or HTTP API.
|
|
|
2762
3185
|
|
|
2763
3186
|
#### Parameters
|
|
2764
3187
|
|
|
2765
|
-
| Parameter | Type
|
|
2766
|
-
| --------- |
|
|
2767
|
-
| `hostFor` | (`env`, `scope`) => \| `Readonly`\<\{ `approvals?`: `Readonly`\<\{ `submit`: `Promise`\<
|
|
3188
|
+
| Parameter | Type |
|
|
3189
|
+
| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
3190
|
+
| `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`; `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`; `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`; \}\>\> |
|
|
2768
3191
|
|
|
2769
3192
|
#### Returns
|
|
2770
3193
|
|
|
@@ -2788,9 +3211,9 @@ Bind the owner to the deployment's existing host factory and options.
|
|
|
2788
3211
|
|
|
2789
3212
|
#### Parameters
|
|
2790
3213
|
|
|
2791
|
-
| Parameter | Type
|
|
2792
|
-
| --------- |
|
|
2793
|
-
| `host` | (`env`, `scope`) => \| `Readonly`\<\{ `approvals?`: `Readonly`\<\{ `submit`: `Promise`\<
|
|
3214
|
+
| Parameter | Type |
|
|
3215
|
+
| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
3216
|
+
| `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`; `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`; `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`; \}\>\> |
|
|
2794
3217
|
|
|
2795
3218
|
#### Returns
|
|
2796
3219
|
|
|
@@ -2884,11 +3307,11 @@ Instances, and boot-check service.
|
|
|
2884
3307
|
|
|
2885
3308
|
#### Parameters
|
|
2886
3309
|
|
|
2887
|
-
| Parameter | Type
|
|
2888
|
-
| --------- |
|
|
2889
|
-
| `env` | [`OysterWorkerEnv`](#oysterworkerenv)
|
|
2890
|
-
| `auth` | [`OysterAuth`](host.md#oysterauth)
|
|
2891
|
-
| `options` | `Pick`\<`Readonly`\<\{ `approvals?`: `Readonly`\<\{ `submit`: `Promise`\<
|
|
3310
|
+
| Parameter | Type |
|
|
3311
|
+
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
3312
|
+
| `env` | [`OysterWorkerEnv`](#oysterworkerenv) |
|
|
3313
|
+
| `auth` | [`OysterAuth`](host.md#oysterauth) |
|
|
3314
|
+
| `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`; `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`; `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`; \}\>; \}\> |
|
|
2892
3315
|
|
|
2893
3316
|
#### Returns
|
|
2894
3317
|
|