@fungi.computer/oyster 0.50.5 → 0.52.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/dist/apps/catalog.d.ts +11 -0
- package/dist/apps/catalog.js +1 -0
- package/dist/apps/gate.d.ts +2 -2
- package/dist/apps/installation.d.ts +7 -7
- package/dist/apps/permissions.d.ts +5 -5
- package/dist/boot-host-script.js +1 -1
- package/dist/build/candidate-cli.mjs +1 -0
- package/dist/embed-metafiles.js +2 -2
- package/dist/embed-scripts.js +1 -1
- package/dist/installation-operations.d.ts +8 -8
- package/dist/pack.d.ts +4 -4
- package/dist/page-script.js +2 -2
- package/dist/standalone/workflow-host.d.ts +5 -5
- package/dist/standalone/workflow-trigger-host.d.ts +1 -1
- package/docs/api/apps.md +146 -128
- package/docs/api/build-contract.md +27 -21
- package/docs/api/build.md +66 -64
- package/docs/api/git.md +3 -3
- package/docs/api/host.md +56 -48
- package/docs/api/mcp.md +16 -16
- package/docs/api/pack.md +26 -20
- package/docs/api/workers.md +50 -47
- package/package.json +20 -17
package/docs/api/git.md
CHANGED
|
@@ -217,9 +217,9 @@ storage.
|
|
|
217
217
|
|
|
218
218
|
#### Parameters
|
|
219
219
|
|
|
220
|
-
| Parameter | Type
|
|
221
|
-
| --------- |
|
|
222
|
-
| `ports` | `Readonly`\<\{ `currentInstallation`: `Promise`\< \| `Readonly`\<\{ `installationId`: `string`; `instanceId`: [`InstanceId`](index.md#instanceid) \| `null`; `appId`: `AppId`; `release`: \{ `releaseId`: `Schema.refine`\<`ReleaseId`, `Schema.String`\>; `appId`: `Schema.refine`\<`AppId`, `Schema.String`\>; `artifact`: `Schema.Struct`\<\{ `artifactRef`: `Schema.refine`\<`ArtifactRef`, `Schema.String`\>; `artifactDigest`: `Schema.refine`\<`Sha256Digest`, `Schema.String`\>; `provenance`: `Schema.Struct`\<\{ `sourceRevision`: ...; `sourceTreeDigest`: ...; `buildRecipeDigest`: ...; \}\>; \}\>; \}; `releasePin`: `"pinned"` \| `"floating"`; `authority`: \{ `authorityVersion`: `number`; `declaredOperationsDigest`: `Sha256Digest`; `approvedGrants`: readonly `Readonly`\<\{ `capability`: \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ...; `capabilityApproved`: `true`; `operations`: readonly ...[]; `fingerprints`: `Readonly`\<...\>; `resources`: ... \| ...; \}\>[]; `approval`: \| `Readonly`\<\{ `by`: ... \| ... \| ...; `at`: `number`; `authorityVersion`: `number`; \}\> \| `null`; \}; `status`: `"enabled"` \| `"disabled"` \| `"deleted"`; \}\> \| `null`\>; `declaration`: `Promise`\< \| `Readonly`\<\{ `api?`: `AppApi`; `displayName?`: `string`; `capabilities`: readonly `AppCapabilityId`[]; `calls?`: readonly `Readonly`\<\{ `appId`: ...; `methods`: ...; \}\>[]; `guidance?`: `string`; `handlers`: readonly `AppHandler`[]; `receives?`: readonly `"git.push"`[]; `icon?`: `string`; `roles`: readonly `AppRole`[]; `storage?`: readonly `AppStorageKey`[]; `commands?`: readonly `AppDeclaredCommand`[]; `gills?`: readonly `AppDeclaredGill`[]; `backend?`: `Readonly`\<\{ `bindings`: readonly ...[]; `sync?`: `Readonly`\<\{ `method`: ...; \}\>; \}\>; \}\> \| `null`\>; \}\> |
|
|
220
|
+
| Parameter | Type |
|
|
221
|
+
| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
222
|
+
| `ports` | `Readonly`\<\{ `currentInstallation`: `Promise`\< \| `Readonly`\<\{ `installationId`: `string`; `instanceId`: [`InstanceId`](index.md#instanceid) \| `null`; `appId`: `AppId`; `release`: \{ `releaseId`: `Schema.refine`\<`ReleaseId`, `Schema.String`\>; `appId`: `Schema.refine`\<`AppId`, `Schema.String`\>; `artifact`: `Schema.Struct`\<\{ `artifactRef`: `Schema.refine`\<`ArtifactRef`, `Schema.String`\>; `artifactDigest`: `Schema.refine`\<`Sha256Digest`, `Schema.String`\>; `provenance`: `Schema.Struct`\<\{ `sourceRevision`: ...; `sourceTreeDigest`: ...; `buildRecipeDigest`: ...; \}\>; \}\>; \}; `releasePin`: `"pinned"` \| `"floating"`; `authority`: \{ `authorityVersion`: `number`; `declaredOperationsDigest`: `Sha256Digest`; `approvedGrants`: readonly `Readonly`\<\{ `capability`: \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ...; `capabilityApproved`: `true`; `operations`: readonly ...[]; `fingerprints`: `Readonly`\<...\>; `resources`: ... \| ...; \}\>[]; `approval`: \| `Readonly`\<\{ `by`: ... \| ... \| ...; `at`: `number`; `authorityVersion`: `number`; \}\> \| `null`; \}; `status`: `"enabled"` \| `"disabled"` \| `"deleted"`; \}\> \| `null`\>; `declaration`: `Promise`\< \| `Readonly`\<\{ `api?`: `AppApi`; `displayName?`: `string`; `capabilities`: readonly `AppCapabilityId`[]; `calls?`: readonly `Readonly`\<\{ `appId`: ...; `methods`: ...; \}\>[]; `guidance?`: `string`; `handlers`: readonly `AppHandler`[]; `receives?`: readonly `"git.push"`[]; `icon?`: `string`; `roles`: readonly `AppRole`[]; `storage?`: readonly `AppStorageKey`[]; `commands?`: readonly `AppDeclaredCommand`[]; `gills?`: readonly `AppDeclaredGill`[]; `backend?`: `Readonly`\<\{ `bindings`: readonly ...[]; `sync?`: `Readonly`\<\{ `method`: ...; \}\>; \}\>; \}\> \| `null`\>; \}\> |
|
|
223
223
|
|
|
224
224
|
#### Returns
|
|
225
225
|
|
package/docs/api/host.md
CHANGED
|
@@ -1393,6 +1393,7 @@ type InstallationOperations = Readonly<{
|
|
|
1393
1393
|
| ...
|
|
1394
1394
|
| ...
|
|
1395
1395
|
| ...
|
|
1396
|
+
| ...
|
|
1396
1397
|
| ...;
|
|
1397
1398
|
capabilityApproved: true;
|
|
1398
1399
|
operations: readonly ...[];
|
|
@@ -1905,6 +1906,7 @@ function verifyRelease(
|
|
|
1905
1906
|
| "agent.avatar"
|
|
1906
1907
|
| "agent.instructions"
|
|
1907
1908
|
| "agent.toolPolicy"
|
|
1909
|
+
| "agent.stop"
|
|
1908
1910
|
| "agent.read"
|
|
1909
1911
|
| "agent.send"
|
|
1910
1912
|
| "llm.generation"
|
|
@@ -1975,6 +1977,7 @@ function verifyRelease(
|
|
|
1975
1977
|
| "agent.avatar"
|
|
1976
1978
|
| "agent.instructions"
|
|
1977
1979
|
| "agent.toolPolicy"
|
|
1980
|
+
| "agent.stop"
|
|
1978
1981
|
| "agent.read"
|
|
1979
1982
|
| "agent.send"
|
|
1980
1983
|
| "llm.generation"
|
|
@@ -2038,6 +2041,7 @@ function verifyRelease(
|
|
|
2038
2041
|
| "agent.avatar"
|
|
2039
2042
|
| "agent.instructions"
|
|
2040
2043
|
| "agent.toolPolicy"
|
|
2044
|
+
| "agent.stop"
|
|
2041
2045
|
| "agent.read"
|
|
2042
2046
|
| "agent.send"
|
|
2043
2047
|
| "llm.generation"
|
|
@@ -2126,6 +2130,7 @@ function verifyRelease(
|
|
|
2126
2130
|
| "agent.avatar"
|
|
2127
2131
|
| "agent.instructions"
|
|
2128
2132
|
| "agent.toolPolicy"
|
|
2133
|
+
| "agent.stop"
|
|
2129
2134
|
| "agent.read"
|
|
2130
2135
|
| "agent.send"
|
|
2131
2136
|
| "llm.generation"
|
|
@@ -2223,12 +2228,12 @@ standalone HTML.
|
|
|
2223
2228
|
`"computer.list"` \| `"computer.readFile"` \| `"computer.writeFile"` \|
|
|
2224
2229
|
`"computer.execute"` \| `"approvals"` \| `"agent.list"` \| `"agent.manage"` \|
|
|
2225
2230
|
`"agent.rename"` \| `"agent.avatar"` \| `"agent.instructions"` \|
|
|
2226
|
-
`"agent.toolPolicy"` \| `"agent.
|
|
2227
|
-
|
|
2228
|
-
`"
|
|
2229
|
-
`"app.
|
|
2230
|
-
`"marketplace.
|
|
2231
|
-
`"workflow.arm"` \| `"world"` \| `"channels.read"` \|
|
|
2231
|
+
`"agent.toolPolicy"` \| `"agent.stop"` \| `"agent.read"` \| `"agent.send"` \|
|
|
2232
|
+
`"llm.generation"` \| `"media.generation"` \| `"media.share"` \|
|
|
2233
|
+
`"games:servers"` \| `"git.repository"` \| `"apps.open"` \| `"apps.call"` \|
|
|
2234
|
+
`"app.storage"` \| `"app.events.emit"` \| `"team.workbenchHost"` \|
|
|
2235
|
+
`"marketplace.browse"` \| `"marketplace.purchase"` \| `"workflow.run"` \|
|
|
2236
|
+
`"workflow.publish"` \| `"workflow.arm"` \| `"world"` \| `"channels.read"` \|
|
|
2232
2237
|
`"channels.personal.manage"`)[]; `calls?`: readonly `Readonly`\<...\>[];
|
|
2233
2238
|
`guidance?`: `string`; `handlers`: readonly `"file.open"`[]; `receives?`:
|
|
2234
2239
|
readonly `"git.push"`[]; `icon?`: `string`; `roles`: readonly (`"files"` \|
|
|
@@ -2247,27 +2252,28 @@ readonly `"git.push"`[]; `icon?`: `string`; `roles`: readonly (`"files"` \|
|
|
|
2247
2252
|
`"computer.readFile"` \| `"computer.writeFile"` \| `"computer.execute"` \|
|
|
2248
2253
|
`"approvals"` \| `"agent.list"` \| `"agent.manage"` \| `"agent.rename"` \|
|
|
2249
2254
|
`"agent.avatar"` \| `"agent.instructions"` \| `"agent.toolPolicy"` \|
|
|
2250
|
-
`"agent.
|
|
2251
|
-
|
|
2252
|
-
\| `"apps.
|
|
2253
|
-
`"
|
|
2254
|
-
`"
|
|
2255
|
-
`"
|
|
2256
|
-
`
|
|
2257
|
-
`
|
|
2258
|
-
|
|
2259
|
-
`"
|
|
2260
|
-
`
|
|
2261
|
-
`
|
|
2262
|
-
\}\>; \}\>; `format`:
|
|
2263
|
-
`"text/html; charset=utf-8"` \|
|
|
2264
|
-
`
|
|
2265
|
-
`byteLength`: `number`; \}; \} \|
|
|
2266
|
-
`Readonly`\<\{ `
|
|
2267
|
-
`
|
|
2268
|
-
`
|
|
2269
|
-
`"
|
|
2270
|
-
`"agent.
|
|
2255
|
+
`"agent.stop"` \| `"agent.read"` \| `"agent.send"` \| `"llm.generation"` \|
|
|
2256
|
+
`"media.generation"` \| `"media.share"` \| `"games:servers"` \|
|
|
2257
|
+
`"git.repository"` \| `"apps.open"` \| `"apps.call"` \| `"app.storage"` \|
|
|
2258
|
+
`"app.events.emit"` \| `"team.workbenchHost"` \| `"marketplace.browse"` \|
|
|
2259
|
+
`"marketplace.purchase"` \| `"workflow.run"` \| `"workflow.publish"` \|
|
|
2260
|
+
`"workflow.arm"` \| `"world"` \| `"channels.read"` \|
|
|
2261
|
+
`"channels.personal.manage"`)[]; `calls?`: readonly `Readonly`\<...\>[];
|
|
2262
|
+
`guidance?`: `string`; `handlers`: readonly `"file.open"`[]; `receives?`:
|
|
2263
|
+
readonly `"git.push"`[]; `icon?`: `string`; `roles`: readonly (`"files"` \|
|
|
2264
|
+
`"dashboard"` \| `"inbox"` \| `"media"` \| `"sessions"` \| `"terminal"`)[];
|
|
2265
|
+
`storage?`: readonly `Readonly`\<...\>[]; `commands?`: readonly
|
|
2266
|
+
`Readonly`\<...\>[]; `gills?`: readonly `AppDeclaredGill`[]; `backend?`:
|
|
2267
|
+
`Readonly`\<\{ `bindings`: ...; `sync?`: ...; \}\>; \}\>; `format`:
|
|
2268
|
+
`"fungi-app-v1"`; `ui`: \{ `mediaType`: `"text/html; charset=utf-8"` \|
|
|
2269
|
+
`"application/vnd.fungi.app-assets+json"`; `artifactRef`: `ArtifactRef`;
|
|
2270
|
+
`digest`: `Sha256Digest`; `version`: `string`; `byteLength`: `number`; \}; \} \|
|
|
2271
|
+
\{ `declaration?`: `Readonly`\<\{ `api?`: `Readonly`\<\{ `methods`: ...;
|
|
2272
|
+
`toolFamily?`: ...; `events?`: ...; \}\>; `displayName?`: `string`;
|
|
2273
|
+
`capabilities`: readonly ( \| `"computer.list"` \| `"computer.readFile"` \|
|
|
2274
|
+
`"computer.writeFile"` \| `"computer.execute"` \| `"approvals"` \|
|
|
2275
|
+
`"agent.list"` \| `"agent.manage"` \| `"agent.rename"` \| `"agent.avatar"` \|
|
|
2276
|
+
`"agent.instructions"` \| `"agent.toolPolicy"` \| `"agent.stop"` \|
|
|
2271
2277
|
`"agent.read"` \| `"agent.send"` \| `"llm.generation"` \| `"media.generation"`
|
|
2272
2278
|
\| `"media.share"` \| `"games:servers"` \| `"git.repository"` \| `"apps.open"`
|
|
2273
2279
|
\| `"apps.call"` \| `"app.storage"` \| `"app.events.emit"` \|
|
|
@@ -2296,12 +2302,12 @@ readonly ...; `pending?`: ... \| ...; `hidden?`: ... \| ...; `present?`: ... \|
|
|
|
2296
2302
|
`"computer.list"` \| `"computer.readFile"` \| `"computer.writeFile"` \|
|
|
2297
2303
|
`"computer.execute"` \| `"approvals"` \| `"agent.list"` \| `"agent.manage"` \|
|
|
2298
2304
|
`"agent.rename"` \| `"agent.avatar"` \| `"agent.instructions"` \|
|
|
2299
|
-
`"agent.toolPolicy"` \| `"agent.
|
|
2300
|
-
|
|
2301
|
-
`"
|
|
2302
|
-
`"app.
|
|
2303
|
-
`"marketplace.
|
|
2304
|
-
`"workflow.arm"` \| `"world"` \| `"channels.read"` \|
|
|
2305
|
+
`"agent.toolPolicy"` \| `"agent.stop"` \| `"agent.read"` \| `"agent.send"` \|
|
|
2306
|
+
`"llm.generation"` \| `"media.generation"` \| `"media.share"` \|
|
|
2307
|
+
`"games:servers"` \| `"git.repository"` \| `"apps.open"` \| `"apps.call"` \|
|
|
2308
|
+
`"app.storage"` \| `"app.events.emit"` \| `"team.workbenchHost"` \|
|
|
2309
|
+
`"marketplace.browse"` \| `"marketplace.purchase"` \| `"workflow.run"` \|
|
|
2310
|
+
`"workflow.publish"` \| `"workflow.arm"` \| `"world"` \| `"channels.read"` \|
|
|
2305
2311
|
`"channels.personal.manage"`)[]; `calls?`: readonly `Readonly`\<\{ `appId`:
|
|
2306
2312
|
`string`; `methods`: readonly ...[]; \}\>[]; `guidance?`: `string`; `handlers`:
|
|
2307
2313
|
readonly `"file.open"`[]; `receives?`: readonly `"git.push"`[]; `icon?`:
|
|
@@ -2347,6 +2353,7 @@ function resolveBackend(store, release): Promise<
|
|
|
2347
2353
|
| "agent.avatar"
|
|
2348
2354
|
| "agent.instructions"
|
|
2349
2355
|
| "agent.toolPolicy"
|
|
2356
|
+
| "agent.stop"
|
|
2350
2357
|
| "agent.read"
|
|
2351
2358
|
| "agent.send"
|
|
2352
2359
|
| "llm.generation"
|
|
@@ -2419,21 +2426,22 @@ root artifact, then the backend descriptor it names.
|
|
|
2419
2426
|
\| `"computer.readFile"` \| `"computer.writeFile"` \| `"computer.execute"` \|
|
|
2420
2427
|
`"approvals"` \| `"agent.list"` \| `"agent.manage"` \| `"agent.rename"` \|
|
|
2421
2428
|
`"agent.avatar"` \| `"agent.instructions"` \| `"agent.toolPolicy"` \|
|
|
2422
|
-
`"agent.
|
|
2423
|
-
|
|
2424
|
-
\| `"apps.
|
|
2425
|
-
`"
|
|
2426
|
-
`"
|
|
2427
|
-
`"
|
|
2428
|
-
`Readonly`\<\{ `appId`: ...;
|
|
2429
|
-
`
|
|
2430
|
-
`
|
|
2431
|
-
`"
|
|
2432
|
-
`
|
|
2433
|
-
|
|
2434
|
-
`
|
|
2435
|
-
readonly `AppDeclaredGill`[]; `backend?`:
|
|
2436
|
-
...[]; `sync?`: ... \| ...; \}\>; \}\> \|
|
|
2429
|
+
`"agent.stop"` \| `"agent.read"` \| `"agent.send"` \| `"llm.generation"` \|
|
|
2430
|
+
`"media.generation"` \| `"media.share"` \| `"games:servers"` \|
|
|
2431
|
+
`"git.repository"` \| `"apps.open"` \| `"apps.call"` \| `"app.storage"` \|
|
|
2432
|
+
`"app.events.emit"` \| `"team.workbenchHost"` \| `"marketplace.browse"` \|
|
|
2433
|
+
`"marketplace.purchase"` \| `"workflow.run"` \| `"workflow.publish"` \|
|
|
2434
|
+
`"workflow.arm"` \| `"world"` \| `"channels.read"` \|
|
|
2435
|
+
`"channels.personal.manage"`)[]; `calls?`: readonly `Readonly`\<\{ `appId`: ...;
|
|
2436
|
+
`methods`: ...; \}\>[]; `guidance?`: `string`; `handlers`: readonly
|
|
2437
|
+
`"file.open"`[]; `receives?`: readonly `"git.push"`[]; `icon?`: `string`;
|
|
2438
|
+
`roles`: readonly (`"files"` \| `"dashboard"` \| `"inbox"` \| `"media"` \|
|
|
2439
|
+
`"sessions"` \| `"terminal"`)[]; `storage?`: readonly `Readonly`\<\{ `key`: ...;
|
|
2440
|
+
`scopes`: ...; `maxBytes`: ...; \}\>[]; `commands?`: readonly `Readonly`\<\{
|
|
2441
|
+
`id`: ...; `title`: ...; `category`: ...; `description?`: ...; `sigil?`: ...;
|
|
2442
|
+
`projections?`: ...; \}\>[]; `gills?`: readonly `AppDeclaredGill`[]; `backend?`:
|
|
2443
|
+
`Readonly`\<\{ `bindings`: readonly ...[]; `sync?`: ... \| ...; \}\>; \}\> \|
|
|
2444
|
+
`null`; \}\> \| `null`\>
|
|
2437
2445
|
|
|
2438
2446
|
## References
|
|
2439
2447
|
|
package/docs/api/mcp.md
CHANGED
|
@@ -419,15 +419,15 @@ Derive the current principal's admitted App modules and grants.
|
|
|
419
419
|
|
|
420
420
|
#### Parameters
|
|
421
421
|
|
|
422
|
-
| Parameter | Type
|
|
423
|
-
| --------------- |
|
|
424
|
-
| `host` | `Pick`\<[`OysterHost`](host.md#oysterhost), \| `"tenantId"` \| `"installations"` \| `"instances"` \| `"artifacts"` \| `"guestLimits"` \| `"backgroundOriginKey"` \| `"computerId"` \| `"capabilities"` \| `"appToolPolicy"` \| `"keys"` \| `"approvals"`\>
|
|
425
|
-
| `surfaces` | [`AppSurfaceCache`](#appsurfacecache)
|
|
426
|
-
| `principal` | [`TenantPrincipal`](tenant.md#tenantprincipal)
|
|
427
|
-
| `installations` | readonly `Readonly`\<\{ `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"`; \}\>[] |
|
|
428
|
-
| `access` | [`OysterCallerAccess`](#oystercalleraccess)
|
|
429
|
-
| `sessionId` | `string` \| `null`
|
|
430
|
-
| `mode` | `"approval"` \| `"direct"`
|
|
422
|
+
| Parameter | Type |
|
|
423
|
+
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
424
|
+
| `host` | `Pick`\<[`OysterHost`](host.md#oysterhost), \| `"tenantId"` \| `"installations"` \| `"instances"` \| `"artifacts"` \| `"guestLimits"` \| `"backgroundOriginKey"` \| `"computerId"` \| `"capabilities"` \| `"appToolPolicy"` \| `"keys"` \| `"approvals"`\> |
|
|
425
|
+
| `surfaces` | [`AppSurfaceCache`](#appsurfacecache) |
|
|
426
|
+
| `principal` | [`TenantPrincipal`](tenant.md#tenantprincipal) |
|
|
427
|
+
| `installations` | readonly `Readonly`\<\{ `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.stop"` \| `"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"`; \}\>[] |
|
|
428
|
+
| `access` | [`OysterCallerAccess`](#oystercalleraccess) |
|
|
429
|
+
| `sessionId` | `string` \| `null` |
|
|
430
|
+
| `mode` | `"approval"` \| `"direct"` |
|
|
431
431
|
|
|
432
432
|
#### Returns
|
|
433
433
|
|
|
@@ -474,13 +474,13 @@ installation authority or the caller's own grants.
|
|
|
474
474
|
|
|
475
475
|
#### Parameters
|
|
476
476
|
|
|
477
|
-
| Parameter | Type
|
|
478
|
-
| ------------------------- |
|
|
479
|
-
| `host` | `Pick`\<[`OysterHost`](host.md#oysterhost), \| `"tenantId"` \| `"installations"` \| `"instances"` \| `"artifacts"` \| `"guestLimits"` \| `"backgroundOriginKey"` \| `"computerId"` \| `"capabilities"` \| `"appToolPolicy"` \| `"keys"` \| `"approvals"`\>
|
|
480
|
-
| `principal` | [`TenantPrincipal`](tenant.md#tenantprincipal)
|
|
481
|
-
| `access` | [`OysterCallerAccess`](#oystercalleraccess)
|
|
482
|
-
| `surfaces` | [`AppSurfaceCache`](#appsurfacecache)
|
|
483
|
-
| `preloadedInstallations?` | readonly `Readonly`\<\{ `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`\<...\>[]; \}\>[]; `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"`; \}\>[] |
|
|
477
|
+
| Parameter | Type |
|
|
478
|
+
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
479
|
+
| `host` | `Pick`\<[`OysterHost`](host.md#oysterhost), \| `"tenantId"` \| `"installations"` \| `"instances"` \| `"artifacts"` \| `"guestLimits"` \| `"backgroundOriginKey"` \| `"computerId"` \| `"capabilities"` \| `"appToolPolicy"` \| `"keys"` \| `"approvals"`\> |
|
|
480
|
+
| `principal` | [`TenantPrincipal`](tenant.md#tenantprincipal) |
|
|
481
|
+
| `access` | [`OysterCallerAccess`](#oystercalleraccess) |
|
|
482
|
+
| `surfaces` | [`AppSurfaceCache`](#appsurfacecache) |
|
|
483
|
+
| `preloadedInstallations?` | readonly `Readonly`\<\{ `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.stop"` \| `"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`\<...\>[]; \}\>[]; `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"`; \}\>[] |
|
|
484
484
|
|
|
485
485
|
#### Returns
|
|
486
486
|
|
package/docs/api/pack.md
CHANGED
|
@@ -344,6 +344,7 @@ function previewBuiltRelease(input): Promise<{
|
|
|
344
344
|
| "agent.avatar"
|
|
345
345
|
| "agent.instructions"
|
|
346
346
|
| "agent.toolPolicy"
|
|
347
|
+
| "agent.stop"
|
|
347
348
|
| "agent.read"
|
|
348
349
|
| "agent.send"
|
|
349
350
|
| "llm.generation"
|
|
@@ -379,6 +380,7 @@ function previewBuiltRelease(input): Promise<{
|
|
|
379
380
|
| "agent.avatar"
|
|
380
381
|
| "agent.instructions"
|
|
381
382
|
| "agent.toolPolicy"
|
|
383
|
+
| "agent.stop"
|
|
382
384
|
| "agent.read"
|
|
383
385
|
| "agent.send"
|
|
384
386
|
| "llm.generation"
|
|
@@ -419,16 +421,17 @@ whether it would update an existing installation.
|
|
|
419
421
|
\| `"computer.readFile"` \| `"computer.writeFile"` \| `"computer.execute"` \|
|
|
420
422
|
`"approvals"` \| `"agent.list"` \| `"agent.manage"` \| `"agent.rename"` \|
|
|
421
423
|
`"agent.avatar"` \| `"agent.instructions"` \| `"agent.toolPolicy"` \|
|
|
422
|
-
`"agent.
|
|
423
|
-
|
|
424
|
-
\| `"apps.
|
|
425
|
-
`"
|
|
426
|
-
`"
|
|
427
|
-
`"
|
|
428
|
-
`
|
|
429
|
-
`
|
|
430
|
-
`"
|
|
431
|
-
`"agent.
|
|
424
|
+
`"agent.stop"` \| `"agent.read"` \| `"agent.send"` \| `"llm.generation"` \|
|
|
425
|
+
`"media.generation"` \| `"media.share"` \| `"games:servers"` \|
|
|
426
|
+
`"git.repository"` \| `"apps.open"` \| `"apps.call"` \| `"app.storage"` \|
|
|
427
|
+
`"app.events.emit"` \| `"team.workbenchHost"` \| `"marketplace.browse"` \|
|
|
428
|
+
`"marketplace.purchase"` \| `"workflow.run"` \| `"workflow.publish"` \|
|
|
429
|
+
`"workflow.arm"` \| `"world"` \| `"channels.read"` \|
|
|
430
|
+
`"channels.personal.manage"`)[]; `update`: \| \{ `installationId`: `string`;
|
|
431
|
+
`needsApproval`: readonly ( \| `"computer.list"` \| `"computer.readFile"` \|
|
|
432
|
+
`"computer.writeFile"` \| `"computer.execute"` \| `"approvals"` \|
|
|
433
|
+
`"agent.list"` \| `"agent.manage"` \| `"agent.rename"` \| `"agent.avatar"` \|
|
|
434
|
+
`"agent.instructions"` \| `"agent.toolPolicy"` \| `"agent.stop"` \|
|
|
432
435
|
`"agent.read"` \| `"agent.send"` \| `"llm.generation"` \| `"media.generation"`
|
|
433
436
|
\| `"media.share"` \| `"games:servers"` \| `"git.repository"` \| `"apps.open"`
|
|
434
437
|
\| `"apps.call"` \| `"app.storage"` \| `"app.events.emit"` \|
|
|
@@ -455,6 +458,7 @@ function previewRelease(input): Promise<{
|
|
|
455
458
|
| "agent.avatar"
|
|
456
459
|
| "agent.instructions"
|
|
457
460
|
| "agent.toolPolicy"
|
|
461
|
+
| "agent.stop"
|
|
458
462
|
| "agent.read"
|
|
459
463
|
| "agent.send"
|
|
460
464
|
| "llm.generation"
|
|
@@ -490,6 +494,7 @@ function previewRelease(input): Promise<{
|
|
|
490
494
|
| "agent.avatar"
|
|
491
495
|
| "agent.instructions"
|
|
492
496
|
| "agent.toolPolicy"
|
|
497
|
+
| "agent.stop"
|
|
493
498
|
| "agent.read"
|
|
494
499
|
| "agent.send"
|
|
495
500
|
| "llm.generation"
|
|
@@ -543,16 +548,17 @@ Releases once before any install.
|
|
|
543
548
|
\| `"computer.readFile"` \| `"computer.writeFile"` \| `"computer.execute"` \|
|
|
544
549
|
`"approvals"` \| `"agent.list"` \| `"agent.manage"` \| `"agent.rename"` \|
|
|
545
550
|
`"agent.avatar"` \| `"agent.instructions"` \| `"agent.toolPolicy"` \|
|
|
546
|
-
`"agent.
|
|
547
|
-
|
|
548
|
-
\| `"apps.
|
|
549
|
-
`"
|
|
550
|
-
`"
|
|
551
|
-
`"
|
|
552
|
-
`
|
|
553
|
-
`
|
|
554
|
-
`"
|
|
555
|
-
`"agent.
|
|
551
|
+
`"agent.stop"` \| `"agent.read"` \| `"agent.send"` \| `"llm.generation"` \|
|
|
552
|
+
`"media.generation"` \| `"media.share"` \| `"games:servers"` \|
|
|
553
|
+
`"git.repository"` \| `"apps.open"` \| `"apps.call"` \| `"app.storage"` \|
|
|
554
|
+
`"app.events.emit"` \| `"team.workbenchHost"` \| `"marketplace.browse"` \|
|
|
555
|
+
`"marketplace.purchase"` \| `"workflow.run"` \| `"workflow.publish"` \|
|
|
556
|
+
`"workflow.arm"` \| `"world"` \| `"channels.read"` \|
|
|
557
|
+
`"channels.personal.manage"`)[]; `update`: \| \{ `installationId`: `string`;
|
|
558
|
+
`needsApproval`: readonly ( \| `"computer.list"` \| `"computer.readFile"` \|
|
|
559
|
+
`"computer.writeFile"` \| `"computer.execute"` \| `"approvals"` \|
|
|
560
|
+
`"agent.list"` \| `"agent.manage"` \| `"agent.rename"` \| `"agent.avatar"` \|
|
|
561
|
+
`"agent.instructions"` \| `"agent.toolPolicy"` \| `"agent.stop"` \|
|
|
556
562
|
`"agent.read"` \| `"agent.send"` \| `"llm.generation"` \| `"media.generation"`
|
|
557
563
|
\| `"media.share"` \| `"games:servers"` \| `"git.repository"` \| `"apps.open"`
|
|
558
564
|
\| `"apps.call"` \| `"app.storage"` \| `"app.events.emit"` \|
|