@fungi.computer/oyster 0.37.2 → 0.38.1
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 +5 -4
- package/dist/agents.js +9 -2
- package/dist/app-builds.d.ts +1 -1
- package/dist/app-region.d.ts +94 -0
- package/dist/app-region.js +316 -0
- package/dist/authorization.d.ts +58 -9
- package/dist/authorization.js +56 -11
- package/dist/backend-request.d.ts +4 -0
- package/dist/backend-request.js +3 -10
- package/dist/boot-host-script.js +1 -1
- package/dist/build/candidate-builder.d.ts +1 -1
- package/dist/build/candidate-cli.mjs +284 -17
- package/dist/build/effect.d.ts +3 -3
- package/dist/build/submission-contract.d.ts +1 -1
- package/dist/build/workspace-build.d.ts +2 -2
- package/dist/channels/discord-replies.d.ts +8 -1
- package/dist/channels/discord-replies.js +80 -29
- package/dist/cloudflare.d.ts +1 -0
- package/dist/cloudflare.js +12 -2
- package/dist/credential-migration-001.d.ts +14 -0
- package/dist/credential-migration-001.js +13 -0
- package/dist/credential-migration-002.d.ts +38 -0
- package/dist/credential-migration-002.js +74 -0
- package/dist/embed-metafiles.js +2 -2
- package/dist/embed-scripts.js +1 -1
- package/dist/host.d.ts +2 -0
- package/dist/host.js +23 -13
- package/dist/index.d.ts +15 -1
- package/dist/index.js +19 -0
- package/dist/invocation.d.ts +165 -0
- package/dist/invocation.js +67 -0
- package/dist/keys.d.ts +4 -3
- package/dist/keys.js +5 -4
- package/dist/mcp-owner.d.ts +4 -3
- package/dist/mcp-owner.js +3 -2
- package/dist/page/mount.js +5 -1
- package/dist/page/region.d.ts +6 -0
- package/dist/page/region.js +12 -0
- package/dist/page-config.d.ts +2 -0
- package/dist/page-config.js +2 -0
- package/dist/page-script.js +2 -2
- package/dist/source/seed-receipt.d.ts +1 -1
- package/dist/source/template-seed.d.ts +1 -1
- package/dist/standalone/agent-connections.d.ts +49 -1
- package/dist/standalone/agent-connections.js +101 -12
- package/dist/standalone/agent-self.js +2 -1
- package/dist/standalone/agents.d.ts +7 -3
- package/dist/standalone/agents.js +42 -19
- package/dist/standalone/computer-fleet.d.ts +12 -6
- package/dist/standalone/computer-fleet.js +70 -29
- package/dist/standalone/computer.js +39 -14
- package/dist/standalone/instance.d.ts +3 -1
- package/dist/standalone/instance.js +8 -0
- package/dist/standalone/model-key-vault.d.ts +33 -4
- package/dist/standalone/model-key-vault.js +74 -17
- package/dist/standalone/preview.js +11 -10
- package/dist/standalone/try-cli.d.ts +12 -2
- package/dist/standalone/try-cli.js +170 -32
- package/dist/standalone/try-worker.d.ts +2 -0
- package/dist/standalone/try-worker.js +15 -0
- package/dist/standalone/worker.js +3 -3
- package/dist/standalone/workflow-host.d.ts +1 -1
- package/dist/standalone/workflows.d.ts +3 -3
- package/dist/standalone/workflows.js +7 -0
- package/dist/testing/capabilities.d.ts +2 -0
- package/dist/testing/capabilities.js +2 -0
- package/dist/webhook-custody.d.ts +14 -3
- package/dist/webhook-custody.js +165 -43
- package/dist/webhooks.d.ts +1 -1
- package/dist/webhooks.js +15 -3
- package/dist/workers-git.d.ts +24 -8
- package/dist/workers-git.js +105 -15
- package/dist/workers.d.ts +16 -0
- package/dist/workers.js +95 -5
- package/docs/api/apps.md +31 -31
- package/docs/api/authorization.md +119 -17
- package/docs/api/build-contract.md +8 -8
- package/docs/api/build.md +163 -174
- package/docs/api/cloudflare.md +171 -0
- package/docs/api/host.md +1 -0
- package/docs/api/index.md +23 -0
- package/docs/api/invocation.md +623 -23
- package/docs/api/keys.md +6 -6
- package/docs/api/pack.md +3 -3
- package/docs/api/page/mount.md +22 -20
- package/docs/api/workers-git.md +273 -157
- package/docs/api/workers.md +257 -175
- package/package.json +19 -18
package/docs/api/workers-git.md
CHANGED
|
@@ -236,7 +236,8 @@ unknown, revoked, expired or suspended key.
|
|
|
236
236
|
|
|
237
237
|
The tenant's App event delivery owner: webhook subscriptions with signed,
|
|
238
238
|
retried deliveries, and host recipients with durable per-recipient records. An
|
|
239
|
-
emit commits here and returns; every delivery happens on the alarm.
|
|
239
|
+
emit commits here and returns; every delivery happens on the alarm. Signing
|
|
240
|
+
secrets rest only in this object's S1 envelope.
|
|
240
241
|
|
|
241
242
|
#### Extends
|
|
242
243
|
|
|
@@ -306,7 +307,14 @@ Recent deliveries to one host recipient, newest first.
|
|
|
306
307
|
##### subscribe()
|
|
307
308
|
|
|
308
309
|
```ts
|
|
309
|
-
subscribe(input):
|
|
310
|
+
subscribe(input): Promise<
|
|
311
|
+
| Readonly<{
|
|
312
|
+
subscription: WebhookSubscription;
|
|
313
|
+
secret: string;
|
|
314
|
+
}>
|
|
315
|
+
| Readonly<{
|
|
316
|
+
error: "unavailable";
|
|
317
|
+
}>>;
|
|
310
318
|
```
|
|
311
319
|
|
|
312
320
|
Subscribe `url` to an installation's events; returns the secret once.
|
|
@@ -323,7 +331,9 @@ Subscribe `url` to an installation's events; returns the secret once.
|
|
|
323
331
|
|
|
324
332
|
###### Returns
|
|
325
333
|
|
|
326
|
-
|
|
334
|
+
`Promise`\< \| `Readonly`\<\{ `subscription`:
|
|
335
|
+
[`WebhookSubscription`](#webhooksubscription); `secret`: `string`; \}\> \|
|
|
336
|
+
`Readonly`\<\{ `error`: `"unavailable"`; \}\>\>
|
|
327
337
|
|
|
328
338
|
##### subscriptions()
|
|
329
339
|
|
|
@@ -1038,6 +1048,80 @@ Activate the exact committed selection under the host's tenant pin.
|
|
|
1038
1048
|
|
|
1039
1049
|
[`OysterInstance`](workers.md#oysterinstance).[`apply`](workers.md#apply)
|
|
1040
1050
|
|
|
1051
|
+
##### fetch()
|
|
1052
|
+
|
|
1053
|
+
```ts
|
|
1054
|
+
fetch(request): Promise<Response>;
|
|
1055
|
+
```
|
|
1056
|
+
|
|
1057
|
+
The Instance's private door for an admitted Region connect: only its own host
|
|
1058
|
+
reaches this stub, carrying connect facts it has just attested.
|
|
1059
|
+
|
|
1060
|
+
###### Parameters
|
|
1061
|
+
|
|
1062
|
+
| Parameter | Type |
|
|
1063
|
+
| --------- | --------- |
|
|
1064
|
+
| `request` | `Request` |
|
|
1065
|
+
|
|
1066
|
+
###### Returns
|
|
1067
|
+
|
|
1068
|
+
`Promise`\<`Response`\>
|
|
1069
|
+
|
|
1070
|
+
###### Inherited from
|
|
1071
|
+
|
|
1072
|
+
[`OysterInstance`](workers.md#oysterinstance).[`fetch`](workers.md#fetch)
|
|
1073
|
+
|
|
1074
|
+
##### webSocketMessage()
|
|
1075
|
+
|
|
1076
|
+
```ts
|
|
1077
|
+
webSocketMessage(socket, message): Promise<void>;
|
|
1078
|
+
```
|
|
1079
|
+
|
|
1080
|
+
Route a hibernated Region socket's frame to the supervisor.
|
|
1081
|
+
|
|
1082
|
+
###### Parameters
|
|
1083
|
+
|
|
1084
|
+
| Parameter | Type |
|
|
1085
|
+
| --------- | ------------------------- |
|
|
1086
|
+
| `socket` | `WebSocket` |
|
|
1087
|
+
| `message` | `string` \| `ArrayBuffer` |
|
|
1088
|
+
|
|
1089
|
+
###### Returns
|
|
1090
|
+
|
|
1091
|
+
`Promise`\<`void`\>
|
|
1092
|
+
|
|
1093
|
+
###### Inherited from
|
|
1094
|
+
|
|
1095
|
+
[`OysterInstance`](workers.md#oysterinstance).[`webSocketMessage`](workers.md#websocketmessage)
|
|
1096
|
+
|
|
1097
|
+
##### webSocketClose()
|
|
1098
|
+
|
|
1099
|
+
```ts
|
|
1100
|
+
webSocketClose(
|
|
1101
|
+
socket,
|
|
1102
|
+
code,
|
|
1103
|
+
reason
|
|
1104
|
+
): Promise<void>;
|
|
1105
|
+
```
|
|
1106
|
+
|
|
1107
|
+
Route a hibernated Region socket's close to the supervisor, which answers it.
|
|
1108
|
+
|
|
1109
|
+
###### Parameters
|
|
1110
|
+
|
|
1111
|
+
| Parameter | Type |
|
|
1112
|
+
| --------- | ----------- |
|
|
1113
|
+
| `socket` | `WebSocket` |
|
|
1114
|
+
| `code` | `number` |
|
|
1115
|
+
| `reason` | `string` |
|
|
1116
|
+
|
|
1117
|
+
###### Returns
|
|
1118
|
+
|
|
1119
|
+
`Promise`\<`void`\>
|
|
1120
|
+
|
|
1121
|
+
###### Inherited from
|
|
1122
|
+
|
|
1123
|
+
[`OysterInstance`](workers.md#oysterinstance).[`webSocketClose`](workers.md#websocketclose)
|
|
1124
|
+
|
|
1041
1125
|
##### backend()
|
|
1042
1126
|
|
|
1043
1127
|
```ts
|
|
@@ -1053,26 +1137,26 @@ Forward an admitted HTTP request to the App backend.
|
|
|
1053
1137
|
|
|
1054
1138
|
###### Parameters
|
|
1055
1139
|
|
|
1056
|
-
| Parameter | Type
|
|
1057
|
-
| ----------------------------------- |
|
|
1058
|
-
| `facts` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `selection`: \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \}; `artifactDigest`: `Sha256Digest`; `subject`: \| \{ `kind`: `"call"`; `context`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; `sessionId?`: `string`; `agentPolicy?`: \{ `policyRevision`: `string`; `grantorMemberId`: `string`; \}; `method?`: \{ `name`: `string`; `effect`: `"read"` \| `"write"` \| `"external"`; \}; `replay?`: \{ `lane`: `string`; `epoch`: `number`; `admitted`: readonly `string`[]; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onGitPush"`; `eventId`: `string`; \} \| \{ `kind`: `"lifecycle"`; `name`: `"syncRefused"`; `lane`: `string`; `code`: `"access_changed"` \| `"installation_unavailable"`; \}; `grants`: readonly `object`[]; `deadlineAt`: `number`; `ancestry`: readonly [`InstanceId`](index.md#instanceid)[]; \} | `undefined` |
|
|
1059
|
-
| `facts.instanceId` | [`InstanceId`](index.md#instanceid)
|
|
1060
|
-
| `facts.selection` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \}
|
|
1061
|
-
| `facts.selection.instanceId?` | [`InstanceId`](index.md#instanceid)
|
|
1062
|
-
| `facts.selection.owner?` | \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}
|
|
1063
|
-
| `facts.selection.owner.kind?` | `"installation"` \| `"deployment"`
|
|
1064
|
-
| `facts.selection.owner.id?` | `string`
|
|
1065
|
-
| `facts.selection.appId?` | `AppId`
|
|
1066
|
-
| `facts.selection.releaseId?` | `ReleaseId`
|
|
1067
|
-
| `facts.selection.authorityVersion?` | `number`
|
|
1068
|
-
| `facts.artifactDigest?` | `Sha256Digest`
|
|
1069
|
-
| `facts.subject?` | \| \{ `kind`: `"call"`; `context`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; `sessionId?`: `string`; `agentPolicy?`: \{ `policyRevision`: `string`; `grantorMemberId`: `string`; \}; `method?`: \{ `name`: `string`; `effect`: `"read"` \| `"write"` \| `"external"`; \}; `replay?`: \{ `lane`: `string`; `epoch`: `number`; `admitted`: readonly `string`[]; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onGitPush"`; `eventId`: `string`; \} \| \{ `kind`: `"lifecycle"`; `name`: `"syncRefused"`; `lane`: `string`; `code`: `"access_changed"` \| `"installation_unavailable"`; \} | `...` |
|
|
1070
|
-
| `facts.grants?` | readonly `object`[]
|
|
1071
|
-
| `facts.deadlineAt?` | `number`
|
|
1072
|
-
| `facts.ancestry?` | readonly [`InstanceId`](index.md#instanceid)[]
|
|
1073
|
-
| `request?` | `Request`
|
|
1074
|
-
| `limits?` | `Readonly`\<\{ `cpuMs`: `number`; `subRequests`: `number`; \}\>
|
|
1075
|
-
| `tenantId?` | `string` & `Brand`\<`"OysterTenantId"`\>
|
|
1140
|
+
| Parameter | Type | Default value |
|
|
1141
|
+
| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
|
|
1142
|
+
| `facts` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `selection`: \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \}; `artifactDigest`: `Sha256Digest`; `subject`: \| \{ `kind`: `"call"`; `context`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; `sessionId?`: `string`; `agentPolicy?`: \{ `policyRevision`: `string`; `grantorMemberId`: `string`; \}; `method?`: \{ `name`: `string`; `effect`: `"read"` \| `"write"` \| `"external"`; \}; `replay?`: \{ `lane`: `string`; `epoch`: `number`; `admitted`: readonly `string`[]; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onGitPush"`; `eventId`: `string`; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onRegion"`; `event`: `"message"` \| `"connect"` \| `"close"` \| `"alarm"`; `context?`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"syncRefused"`; `lane`: `string`; `code`: `"access_changed"` \| `"installation_unavailable"`; \}; `grants`: readonly `object`[]; `deadlineAt`: `number`; `ancestry`: readonly [`InstanceId`](index.md#instanceid)[]; \} | `undefined` |
|
|
1143
|
+
| `facts.instanceId` | [`InstanceId`](index.md#instanceid) | `instanceIdSchema` |
|
|
1144
|
+
| `facts.selection` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \} | `selectionSchema` |
|
|
1145
|
+
| `facts.selection.instanceId?` | [`InstanceId`](index.md#instanceid) | `instanceIdSchema` |
|
|
1146
|
+
| `facts.selection.owner?` | \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \} | `ownerSchema` |
|
|
1147
|
+
| `facts.selection.owner.kind?` | `"installation"` \| `"deployment"` | `...` |
|
|
1148
|
+
| `facts.selection.owner.id?` | `string` | `Schema.NonEmptyString` |
|
|
1149
|
+
| `facts.selection.appId?` | `AppId` | `appIdSchema` |
|
|
1150
|
+
| `facts.selection.releaseId?` | `ReleaseId` | `releaseIdSchema` |
|
|
1151
|
+
| `facts.selection.authorityVersion?` | `number` | `...` |
|
|
1152
|
+
| `facts.artifactDigest?` | `Sha256Digest` | `sha256DigestSchema` |
|
|
1153
|
+
| `facts.subject?` | \| \{ `kind`: `"call"`; `context`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; `sessionId?`: `string`; `agentPolicy?`: \{ `policyRevision`: `string`; `grantorMemberId`: `string`; \}; `method?`: \{ `name`: `string`; `effect`: `"read"` \| `"write"` \| `"external"`; \}; `replay?`: \{ `lane`: `string`; `epoch`: `number`; `admitted`: readonly `string`[]; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onGitPush"`; `eventId`: `string`; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onRegion"`; `event`: `"message"` \| `"connect"` \| `"close"` \| `"alarm"`; `context?`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"syncRefused"`; `lane`: `string`; `code`: `"access_changed"` \| `"installation_unavailable"`; \} | `...` |
|
|
1154
|
+
| `facts.grants?` | readonly `object`[] | `grantsSchema` |
|
|
1155
|
+
| `facts.deadlineAt?` | `number` | `...` |
|
|
1156
|
+
| `facts.ancestry?` | readonly [`InstanceId`](index.md#instanceid)[] | `...` |
|
|
1157
|
+
| `request?` | `Request` | `undefined` |
|
|
1158
|
+
| `limits?` | `Readonly`\<\{ `cpuMs`: `number`; `subRequests`: `number`; \}\> | `undefined` |
|
|
1159
|
+
| `tenantId?` | `string` & `Brand`\<`"OysterTenantId"`\> | `defaultTenant` |
|
|
1076
1160
|
|
|
1077
1161
|
###### Returns
|
|
1078
1162
|
|
|
@@ -1097,31 +1181,31 @@ Deliver a Git push through the same selected-Instance admission as methods.
|
|
|
1097
1181
|
|
|
1098
1182
|
###### Parameters
|
|
1099
1183
|
|
|
1100
|
-
| Parameter | Type
|
|
1101
|
-
| ----------------------------------- |
|
|
1102
|
-
| `facts` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `selection`: \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \}; `artifactDigest`: `Sha256Digest`; `subject`: \| \{ `kind`: `"call"`; `context`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; `sessionId?`: `string`; `agentPolicy?`: \{ `policyRevision`: `string`; `grantorMemberId`: `string`; \}; `method?`: \{ `name`: `string`; `effect`: `"read"` \| `"write"` \| `"external"`; \}; `replay?`: \{ `lane`: `string`; `epoch`: `number`; `admitted`: readonly `string`[]; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onGitPush"`; `eventId`: `string`; \} \| \{ `kind`: `"lifecycle"`; `name`: `"syncRefused"`; `lane`: `string`; `code`: `"access_changed"` \| `"installation_unavailable"`; \}; `grants`: readonly `object`[]; `deadlineAt`: `number`; `ancestry`: readonly [`InstanceId`](index.md#instanceid)[]; \} | `undefined` |
|
|
1103
|
-
| `facts.instanceId` | [`InstanceId`](index.md#instanceid)
|
|
1104
|
-
| `facts.selection` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \}
|
|
1105
|
-
| `facts.selection.instanceId?` | [`InstanceId`](index.md#instanceid)
|
|
1106
|
-
| `facts.selection.owner?` | \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}
|
|
1107
|
-
| `facts.selection.owner.kind?` | `"installation"` \| `"deployment"`
|
|
1108
|
-
| `facts.selection.owner.id?` | `string`
|
|
1109
|
-
| `facts.selection.appId?` | `AppId`
|
|
1110
|
-
| `facts.selection.releaseId?` | `ReleaseId`
|
|
1111
|
-
| `facts.selection.authorityVersion?` | `number`
|
|
1112
|
-
| `facts.artifactDigest?` | `Sha256Digest`
|
|
1113
|
-
| `facts.subject?` | \| \{ `kind`: `"call"`; `context`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; `sessionId?`: `string`; `agentPolicy?`: \{ `policyRevision`: `string`; `grantorMemberId`: `string`; \}; `method?`: \{ `name`: `string`; `effect`: `"read"` \| `"write"` \| `"external"`; \}; `replay?`: \{ `lane`: `string`; `epoch`: `number`; `admitted`: readonly `string`[]; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onGitPush"`; `eventId`: `string`; \} \| \{ `kind`: `"lifecycle"`; `name`: `"syncRefused"`; `lane`: `string`; `code`: `"access_changed"` \| `"installation_unavailable"`; \} | `...` |
|
|
1114
|
-
| `facts.grants?` | readonly `object`[]
|
|
1115
|
-
| `facts.deadlineAt?` | `number`
|
|
1116
|
-
| `facts.ancestry?` | readonly [`InstanceId`](index.md#instanceid)[]
|
|
1117
|
-
| `fact?` | \{ `repository`: `string`; `writer`: \| \{ `kind`: `"actor"`; `actor`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; `role?`: `"member"` \| `"owner"` \| `"admin"`; `workflow?`: \{ `armedBy`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; `branches`: `string`[]; `workflowId`: `string`; `runId`: `string`; `nodeId`: `string`; \}; \} \| \{ `kind`: `"installation"`; `installationId`: `string`; `onBehalfOf`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \} \| `null`; \}; `updates`: `object`[]; `unexplained?`: `object`[]; `eventId`: `string`; \}
|
|
1118
|
-
| `fact.repository?` | `string`
|
|
1119
|
-
| `fact.writer?` | \| \{ `kind`: `"actor"`; `actor`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; `role?`: `"member"` \| `"owner"` \| `"admin"`; `workflow?`: \{ `armedBy`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; `branches`: `string`[]; `workflowId`: `string`; `runId`: `string`; `nodeId`: `string`; \}; \} \| \{ `kind`: `"installation"`; `installationId`: `string`; `onBehalfOf`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \} \| `null`; \}
|
|
1120
|
-
| `fact.updates?` | `object`[]
|
|
1121
|
-
| `fact.unexplained?` | `object`[]
|
|
1122
|
-
| `fact.eventId?` | `string`
|
|
1123
|
-
| `limits?` | `Readonly`\<\{ `cpuMs`: `number`; `subRequests`: `number`; \}\>
|
|
1124
|
-
| `tenantId?` | `string` & `Brand`\<`"OysterTenantId"`\>
|
|
1184
|
+
| Parameter | Type | Default value |
|
|
1185
|
+
| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
|
|
1186
|
+
| `facts` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `selection`: \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \}; `artifactDigest`: `Sha256Digest`; `subject`: \| \{ `kind`: `"call"`; `context`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; `sessionId?`: `string`; `agentPolicy?`: \{ `policyRevision`: `string`; `grantorMemberId`: `string`; \}; `method?`: \{ `name`: `string`; `effect`: `"read"` \| `"write"` \| `"external"`; \}; `replay?`: \{ `lane`: `string`; `epoch`: `number`; `admitted`: readonly `string`[]; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onGitPush"`; `eventId`: `string`; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onRegion"`; `event`: `"message"` \| `"connect"` \| `"close"` \| `"alarm"`; `context?`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"syncRefused"`; `lane`: `string`; `code`: `"access_changed"` \| `"installation_unavailable"`; \}; `grants`: readonly `object`[]; `deadlineAt`: `number`; `ancestry`: readonly [`InstanceId`](index.md#instanceid)[]; \} | `undefined` |
|
|
1187
|
+
| `facts.instanceId` | [`InstanceId`](index.md#instanceid) | `instanceIdSchema` |
|
|
1188
|
+
| `facts.selection` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \} | `selectionSchema` |
|
|
1189
|
+
| `facts.selection.instanceId?` | [`InstanceId`](index.md#instanceid) | `instanceIdSchema` |
|
|
1190
|
+
| `facts.selection.owner?` | \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \} | `ownerSchema` |
|
|
1191
|
+
| `facts.selection.owner.kind?` | `"installation"` \| `"deployment"` | `...` |
|
|
1192
|
+
| `facts.selection.owner.id?` | `string` | `Schema.NonEmptyString` |
|
|
1193
|
+
| `facts.selection.appId?` | `AppId` | `appIdSchema` |
|
|
1194
|
+
| `facts.selection.releaseId?` | `ReleaseId` | `releaseIdSchema` |
|
|
1195
|
+
| `facts.selection.authorityVersion?` | `number` | `...` |
|
|
1196
|
+
| `facts.artifactDigest?` | `Sha256Digest` | `sha256DigestSchema` |
|
|
1197
|
+
| `facts.subject?` | \| \{ `kind`: `"call"`; `context`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; `sessionId?`: `string`; `agentPolicy?`: \{ `policyRevision`: `string`; `grantorMemberId`: `string`; \}; `method?`: \{ `name`: `string`; `effect`: `"read"` \| `"write"` \| `"external"`; \}; `replay?`: \{ `lane`: `string`; `epoch`: `number`; `admitted`: readonly `string`[]; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onGitPush"`; `eventId`: `string`; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onRegion"`; `event`: `"message"` \| `"connect"` \| `"close"` \| `"alarm"`; `context?`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"syncRefused"`; `lane`: `string`; `code`: `"access_changed"` \| `"installation_unavailable"`; \} | `...` |
|
|
1198
|
+
| `facts.grants?` | readonly `object`[] | `grantsSchema` |
|
|
1199
|
+
| `facts.deadlineAt?` | `number` | `...` |
|
|
1200
|
+
| `facts.ancestry?` | readonly [`InstanceId`](index.md#instanceid)[] | `...` |
|
|
1201
|
+
| `fact?` | \{ `repository`: `string`; `writer`: \| \{ `kind`: `"actor"`; `actor`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; `role?`: `"member"` \| `"owner"` \| `"admin"`; `workflow?`: \{ `armedBy`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; `branches`: `string`[]; `workflowId`: `string`; `runId`: `string`; `nodeId`: `string`; \}; \} \| \{ `kind`: `"installation"`; `installationId`: `string`; `onBehalfOf`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \} \| `null`; \}; `updates`: `object`[]; `unexplained?`: `object`[]; `eventId`: `string`; \} | `undefined` |
|
|
1202
|
+
| `fact.repository?` | `string` | `undefined` |
|
|
1203
|
+
| `fact.writer?` | \| \{ `kind`: `"actor"`; `actor`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; `role?`: `"member"` \| `"owner"` \| `"admin"`; `workflow?`: \{ `armedBy`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; `branches`: `string`[]; `workflowId`: `string`; `runId`: `string`; `nodeId`: `string`; \}; \} \| \{ `kind`: `"installation"`; `installationId`: `string`; `onBehalfOf`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \} \| `null`; \} | `undefined` |
|
|
1204
|
+
| `fact.updates?` | `object`[] | `undefined` |
|
|
1205
|
+
| `fact.unexplained?` | `object`[] | `undefined` |
|
|
1206
|
+
| `fact.eventId?` | `string` | `undefined` |
|
|
1207
|
+
| `limits?` | `Readonly`\<\{ `cpuMs`: `number`; `subRequests`: `number`; \}\> | `undefined` |
|
|
1208
|
+
| `tenantId?` | `string` & `Brand`\<`"OysterTenantId"`\> | `defaultTenant` |
|
|
1125
1209
|
|
|
1126
1210
|
###### Returns
|
|
1127
1211
|
|
|
@@ -1153,38 +1237,38 @@ Ask the App's declared authorizer through the same frame-bound connection.
|
|
|
1153
1237
|
|
|
1154
1238
|
###### Parameters
|
|
1155
1239
|
|
|
1156
|
-
| Parameter | Type
|
|
1157
|
-
| -------------------------------------- |
|
|
1158
|
-
| `facts` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `selection`: \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \}; `artifactDigest`: `Sha256Digest`; `subject`: \| \{ `kind`: `"call"`; `context`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; `sessionId?`: `string`; `agentPolicy?`: \{ `policyRevision`: `string`; `grantorMemberId`: `string`; \}; `method?`: \{ `name`: `string`; `effect`: `"read"` \| `"write"` \| `"external"`; \}; `replay?`: \{ `lane`: `string`; `epoch`: `number`; `admitted`: readonly `string`[]; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onGitPush"`; `eventId`: `string`; \} \| \{ `kind`: `"lifecycle"`; `name`: `"syncRefused"`; `lane`: `string`; `code`: `"access_changed"` \| `"installation_unavailable"`; \}; `grants`: readonly `object`[]; `deadlineAt`: `number`; `ancestry`: readonly [`InstanceId`](index.md#instanceid)[]; \} | `undefined` |
|
|
1159
|
-
| `facts.instanceId` | [`InstanceId`](index.md#instanceid)
|
|
1160
|
-
| `facts.selection` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \}
|
|
1161
|
-
| `facts.selection.instanceId?` | [`InstanceId`](index.md#instanceid)
|
|
1162
|
-
| `facts.selection.owner?` | \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}
|
|
1163
|
-
| `facts.selection.owner.kind?` | `"installation"` \| `"deployment"`
|
|
1164
|
-
| `facts.selection.owner.id?` | `string`
|
|
1165
|
-
| `facts.selection.appId?` | `AppId`
|
|
1166
|
-
| `facts.selection.releaseId?` | `ReleaseId`
|
|
1167
|
-
| `facts.selection.authorityVersion?` | `number`
|
|
1168
|
-
| `facts.artifactDigest?` | `Sha256Digest`
|
|
1169
|
-
| `facts.subject?` | \| \{ `kind`: `"call"`; `context`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; `sessionId?`: `string`; `agentPolicy?`: \{ `policyRevision`: `string`; `grantorMemberId`: `string`; \}; `method?`: \{ `name`: `string`; `effect`: `"read"` \| `"write"` \| `"external"`; \}; `replay?`: \{ `lane`: `string`; `epoch`: `number`; `admitted`: readonly `string`[]; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onGitPush"`; `eventId`: `string`; \} \| \{ `kind`: `"lifecycle"`; `name`: `"syncRefused"`; `lane`: `string`; `code`: `"access_changed"` \| `"installation_unavailable"`; \} | `...` |
|
|
1170
|
-
| `facts.grants?` | readonly `object`[]
|
|
1171
|
-
| `facts.deadlineAt?` | `number`
|
|
1172
|
-
| `facts.ancestry?` | readonly [`InstanceId`](index.md#instanceid)[]
|
|
1173
|
-
| `question?` | \{ `repository`: `string`; `writer`: \{ `kind`: `"actor"`; `actor`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; `role?`: `"member"` \| `"owner"` \| `"admin"`; `workflow?`: \{ `armedBy`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; `branches`: `string`[]; `workflowId`: `string`; `runId`: `string`; `nodeId`: `string`; \}; \}; `updates`: `object`[]; \}
|
|
1174
|
-
| `question.repository?` | `string`
|
|
1175
|
-
| `question.writer?` | \{ `kind`: `"actor"`; `actor`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; `role?`: `"member"` \| `"owner"` \| `"admin"`; `workflow?`: \{ `armedBy`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; `branches`: `string`[]; `workflowId`: `string`; `runId`: `string`; `nodeId`: `string`; \}; \}
|
|
1176
|
-
| `question.writer.kind?` | `"actor"`
|
|
1177
|
-
| `question.writer.actor?` | \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}
|
|
1178
|
-
| `question.writer.role?` | `"member"` \| `"owner"` \| `"admin"`
|
|
1179
|
-
| `question.writer.workflow?` | \{ `armedBy`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; `branches`: `string`[]; `workflowId`: `string`; `runId`: `string`; `nodeId`: `string`; \}
|
|
1180
|
-
| `question.writer.workflow.armedBy?` | \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}
|
|
1181
|
-
| `question.writer.workflow.branches?` | `string`[]
|
|
1182
|
-
| `question.writer.workflow.workflowId?` | `string`
|
|
1183
|
-
| `question.writer.workflow.runId?` | `string`
|
|
1184
|
-
| `question.writer.workflow.nodeId?` | `string`
|
|
1185
|
-
| `question.updates?` | `object`[]
|
|
1186
|
-
| `limits?` | `Readonly`\<\{ `cpuMs`: `number`; `subRequests`: `number`; \}\>
|
|
1187
|
-
| `tenantId?` | `string` & `Brand`\<`"OysterTenantId"`\>
|
|
1240
|
+
| Parameter | Type | Default value |
|
|
1241
|
+
| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
|
|
1242
|
+
| `facts` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `selection`: \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \}; `artifactDigest`: `Sha256Digest`; `subject`: \| \{ `kind`: `"call"`; `context`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; `sessionId?`: `string`; `agentPolicy?`: \{ `policyRevision`: `string`; `grantorMemberId`: `string`; \}; `method?`: \{ `name`: `string`; `effect`: `"read"` \| `"write"` \| `"external"`; \}; `replay?`: \{ `lane`: `string`; `epoch`: `number`; `admitted`: readonly `string`[]; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onGitPush"`; `eventId`: `string`; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onRegion"`; `event`: `"message"` \| `"connect"` \| `"close"` \| `"alarm"`; `context?`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"syncRefused"`; `lane`: `string`; `code`: `"access_changed"` \| `"installation_unavailable"`; \}; `grants`: readonly `object`[]; `deadlineAt`: `number`; `ancestry`: readonly [`InstanceId`](index.md#instanceid)[]; \} | `undefined` |
|
|
1243
|
+
| `facts.instanceId` | [`InstanceId`](index.md#instanceid) | `instanceIdSchema` |
|
|
1244
|
+
| `facts.selection` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \} | `selectionSchema` |
|
|
1245
|
+
| `facts.selection.instanceId?` | [`InstanceId`](index.md#instanceid) | `instanceIdSchema` |
|
|
1246
|
+
| `facts.selection.owner?` | \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \} | `ownerSchema` |
|
|
1247
|
+
| `facts.selection.owner.kind?` | `"installation"` \| `"deployment"` | `...` |
|
|
1248
|
+
| `facts.selection.owner.id?` | `string` | `Schema.NonEmptyString` |
|
|
1249
|
+
| `facts.selection.appId?` | `AppId` | `appIdSchema` |
|
|
1250
|
+
| `facts.selection.releaseId?` | `ReleaseId` | `releaseIdSchema` |
|
|
1251
|
+
| `facts.selection.authorityVersion?` | `number` | `...` |
|
|
1252
|
+
| `facts.artifactDigest?` | `Sha256Digest` | `sha256DigestSchema` |
|
|
1253
|
+
| `facts.subject?` | \| \{ `kind`: `"call"`; `context`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; `sessionId?`: `string`; `agentPolicy?`: \{ `policyRevision`: `string`; `grantorMemberId`: `string`; \}; `method?`: \{ `name`: `string`; `effect`: `"read"` \| `"write"` \| `"external"`; \}; `replay?`: \{ `lane`: `string`; `epoch`: `number`; `admitted`: readonly `string`[]; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onGitPush"`; `eventId`: `string`; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onRegion"`; `event`: `"message"` \| `"connect"` \| `"close"` \| `"alarm"`; `context?`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"syncRefused"`; `lane`: `string`; `code`: `"access_changed"` \| `"installation_unavailable"`; \} | `...` |
|
|
1254
|
+
| `facts.grants?` | readonly `object`[] | `grantsSchema` |
|
|
1255
|
+
| `facts.deadlineAt?` | `number` | `...` |
|
|
1256
|
+
| `facts.ancestry?` | readonly [`InstanceId`](index.md#instanceid)[] | `...` |
|
|
1257
|
+
| `question?` | \{ `repository`: `string`; `writer`: \{ `kind`: `"actor"`; `actor`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; `role?`: `"member"` \| `"owner"` \| `"admin"`; `workflow?`: \{ `armedBy`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; `branches`: `string`[]; `workflowId`: `string`; `runId`: `string`; `nodeId`: `string`; \}; \}; `updates`: `object`[]; \} | `undefined` |
|
|
1258
|
+
| `question.repository?` | `string` | `undefined` |
|
|
1259
|
+
| `question.writer?` | \{ `kind`: `"actor"`; `actor`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; `role?`: `"member"` \| `"owner"` \| `"admin"`; `workflow?`: \{ `armedBy`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; `branches`: `string`[]; `workflowId`: `string`; `runId`: `string`; `nodeId`: `string`; \}; \} | `undefined` |
|
|
1260
|
+
| `question.writer.kind?` | `"actor"` | `undefined` |
|
|
1261
|
+
| `question.writer.actor?` | \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \} | `undefined` |
|
|
1262
|
+
| `question.writer.role?` | `"member"` \| `"owner"` \| `"admin"` | `undefined` |
|
|
1263
|
+
| `question.writer.workflow?` | \{ `armedBy`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; `branches`: `string`[]; `workflowId`: `string`; `runId`: `string`; `nodeId`: `string`; \} | `undefined` |
|
|
1264
|
+
| `question.writer.workflow.armedBy?` | \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \} | `undefined` |
|
|
1265
|
+
| `question.writer.workflow.branches?` | `string`[] | `undefined` |
|
|
1266
|
+
| `question.writer.workflow.workflowId?` | `string` | `undefined` |
|
|
1267
|
+
| `question.writer.workflow.runId?` | `string` | `undefined` |
|
|
1268
|
+
| `question.writer.workflow.nodeId?` | `string` | `undefined` |
|
|
1269
|
+
| `question.updates?` | `object`[] | `undefined` |
|
|
1270
|
+
| `limits?` | `Readonly`\<\{ `cpuMs`: `number`; `subRequests`: `number`; \}\> | `undefined` |
|
|
1271
|
+
| `tenantId?` | `string` & `Brand`\<`"OysterTenantId"`\> | `defaultTenant` |
|
|
1188
1272
|
|
|
1189
1273
|
###### Returns
|
|
1190
1274
|
|
|
@@ -1211,28 +1295,28 @@ grants.
|
|
|
1211
1295
|
|
|
1212
1296
|
###### Parameters
|
|
1213
1297
|
|
|
1214
|
-
| Parameter | Type
|
|
1215
|
-
| ----------------------------------- |
|
|
1216
|
-
| `facts` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `selection`: \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \}; `artifactDigest`: `Sha256Digest`; `subject`: \| \{ `kind`: `"call"`; `context`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; `sessionId?`: `string`; `agentPolicy?`: \{ `policyRevision`: `string`; `grantorMemberId`: `string`; \}; `method?`: \{ `name`: `string`; `effect`: `"read"` \| `"write"` \| `"external"`; \}; `replay?`: \{ `lane`: `string`; `epoch`: `number`; `admitted`: readonly `string`[]; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onGitPush"`; `eventId`: `string`; \} \| \{ `kind`: `"lifecycle"`; `name`: `"syncRefused"`; `lane`: `string`; `code`: `"access_changed"` \| `"installation_unavailable"`; \}; `grants`: readonly `object`[]; `deadlineAt`: `number`; `ancestry`: readonly [`InstanceId`](index.md#instanceid)[]; \} | `undefined` |
|
|
1217
|
-
| `facts.instanceId` | [`InstanceId`](index.md#instanceid)
|
|
1218
|
-
| `facts.selection` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \}
|
|
1219
|
-
| `facts.selection.instanceId?` | [`InstanceId`](index.md#instanceid)
|
|
1220
|
-
| `facts.selection.owner?` | \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}
|
|
1221
|
-
| `facts.selection.owner.kind?` | `"installation"` \| `"deployment"`
|
|
1222
|
-
| `facts.selection.owner.id?` | `string`
|
|
1223
|
-
| `facts.selection.appId?` | `AppId`
|
|
1224
|
-
| `facts.selection.releaseId?` | `ReleaseId`
|
|
1225
|
-
| `facts.selection.authorityVersion?` | `number`
|
|
1226
|
-
| `facts.artifactDigest?` | `Sha256Digest`
|
|
1227
|
-
| `facts.subject?` | \| \{ `kind`: `"call"`; `context`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; `sessionId?`: `string`; `agentPolicy?`: \{ `policyRevision`: `string`; `grantorMemberId`: `string`; \}; `method?`: \{ `name`: `string`; `effect`: `"read"` \| `"write"` \| `"external"`; \}; `replay?`: \{ `lane`: `string`; `epoch`: `number`; `admitted`: readonly `string`[]; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onGitPush"`; `eventId`: `string`; \} \| \{ `kind`: `"lifecycle"`; `name`: `"syncRefused"`; `lane`: `string`; `code`: `"access_changed"` \| `"installation_unavailable"`; \} | `...` |
|
|
1228
|
-
| `facts.grants?` | readonly `object`[]
|
|
1229
|
-
| `facts.deadlineAt?` | `number`
|
|
1230
|
-
| `facts.ancestry?` | readonly [`InstanceId`](index.md#instanceid)[]
|
|
1231
|
-
| `refusal?` | \{ `lane`: `string`; `code`: `"access_changed"` \| `"installation_unavailable"`; \}
|
|
1232
|
-
| `refusal.lane?` | `string`
|
|
1233
|
-
| `refusal.code?` | `"access_changed"` \| `"installation_unavailable"`
|
|
1234
|
-
| `limits?` | `Readonly`\<\{ `cpuMs`: `number`; `subRequests`: `number`; \}\>
|
|
1235
|
-
| `tenantId?` | `string` & `Brand`\<`"OysterTenantId"`\>
|
|
1298
|
+
| Parameter | Type | Default value |
|
|
1299
|
+
| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
|
|
1300
|
+
| `facts` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `selection`: \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \}; `artifactDigest`: `Sha256Digest`; `subject`: \| \{ `kind`: `"call"`; `context`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; `sessionId?`: `string`; `agentPolicy?`: \{ `policyRevision`: `string`; `grantorMemberId`: `string`; \}; `method?`: \{ `name`: `string`; `effect`: `"read"` \| `"write"` \| `"external"`; \}; `replay?`: \{ `lane`: `string`; `epoch`: `number`; `admitted`: readonly `string`[]; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onGitPush"`; `eventId`: `string`; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onRegion"`; `event`: `"message"` \| `"connect"` \| `"close"` \| `"alarm"`; `context?`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"syncRefused"`; `lane`: `string`; `code`: `"access_changed"` \| `"installation_unavailable"`; \}; `grants`: readonly `object`[]; `deadlineAt`: `number`; `ancestry`: readonly [`InstanceId`](index.md#instanceid)[]; \} | `undefined` |
|
|
1301
|
+
| `facts.instanceId` | [`InstanceId`](index.md#instanceid) | `instanceIdSchema` |
|
|
1302
|
+
| `facts.selection` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \} | `selectionSchema` |
|
|
1303
|
+
| `facts.selection.instanceId?` | [`InstanceId`](index.md#instanceid) | `instanceIdSchema` |
|
|
1304
|
+
| `facts.selection.owner?` | \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \} | `ownerSchema` |
|
|
1305
|
+
| `facts.selection.owner.kind?` | `"installation"` \| `"deployment"` | `...` |
|
|
1306
|
+
| `facts.selection.owner.id?` | `string` | `Schema.NonEmptyString` |
|
|
1307
|
+
| `facts.selection.appId?` | `AppId` | `appIdSchema` |
|
|
1308
|
+
| `facts.selection.releaseId?` | `ReleaseId` | `releaseIdSchema` |
|
|
1309
|
+
| `facts.selection.authorityVersion?` | `number` | `...` |
|
|
1310
|
+
| `facts.artifactDigest?` | `Sha256Digest` | `sha256DigestSchema` |
|
|
1311
|
+
| `facts.subject?` | \| \{ `kind`: `"call"`; `context`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; `sessionId?`: `string`; `agentPolicy?`: \{ `policyRevision`: `string`; `grantorMemberId`: `string`; \}; `method?`: \{ `name`: `string`; `effect`: `"read"` \| `"write"` \| `"external"`; \}; `replay?`: \{ `lane`: `string`; `epoch`: `number`; `admitted`: readonly `string`[]; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onGitPush"`; `eventId`: `string`; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onRegion"`; `event`: `"message"` \| `"connect"` \| `"close"` \| `"alarm"`; `context?`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"syncRefused"`; `lane`: `string`; `code`: `"access_changed"` \| `"installation_unavailable"`; \} | `...` |
|
|
1312
|
+
| `facts.grants?` | readonly `object`[] | `grantsSchema` |
|
|
1313
|
+
| `facts.deadlineAt?` | `number` | `...` |
|
|
1314
|
+
| `facts.ancestry?` | readonly [`InstanceId`](index.md#instanceid)[] | `...` |
|
|
1315
|
+
| `refusal?` | \{ `lane`: `string`; `code`: `"access_changed"` \| `"installation_unavailable"`; \} | `undefined` |
|
|
1316
|
+
| `refusal.lane?` | `string` | `undefined` |
|
|
1317
|
+
| `refusal.code?` | `"access_changed"` \| `"installation_unavailable"` | `undefined` |
|
|
1318
|
+
| `limits?` | `Readonly`\<\{ `cpuMs`: `number`; `subRequests`: `number`; \}\> | `undefined` |
|
|
1319
|
+
| `tenantId?` | `string` & `Brand`\<`"OysterTenantId"`\> | `defaultTenant` |
|
|
1236
1320
|
|
|
1237
1321
|
###### Returns
|
|
1238
1322
|
|
|
@@ -1296,32 +1380,32 @@ Invoke a Release-declared Gill in a fresh immutable frame.
|
|
|
1296
1380
|
|
|
1297
1381
|
###### Parameters
|
|
1298
1382
|
|
|
1299
|
-
| Parameter | Type
|
|
1300
|
-
| ----------------------------------- |
|
|
1301
|
-
| `facts` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `selection`: \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \}; `artifactDigest`: `Sha256Digest`; `subject`: \| \{ `kind`: `"call"`; `context`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; `sessionId?`: `string`; `agentPolicy?`: \{ `policyRevision`: `string`; `grantorMemberId`: `string`; \}; `method?`: \{ `name`: `string`; `effect`: `"read"` \| `"write"` \| `"external"`; \}; `replay?`: \{ `lane`: `string`; `epoch`: `number`; `admitted`: readonly `string`[]; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onGitPush"`; `eventId`: `string`; \} \| \{ `kind`: `"lifecycle"`; `name`: `"syncRefused"`; `lane`: `string`; `code`: `"access_changed"` \| `"installation_unavailable"`; \}; `grants`: readonly `object`[]; `deadlineAt`: `number`; `ancestry`: readonly [`InstanceId`](index.md#instanceid)[]; \} | `undefined` |
|
|
1302
|
-
| `facts.instanceId` | [`InstanceId`](index.md#instanceid)
|
|
1303
|
-
| `facts.selection` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \}
|
|
1304
|
-
| `facts.selection.instanceId` | [`InstanceId`](index.md#instanceid)
|
|
1305
|
-
| `facts.selection.owner` | \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}
|
|
1306
|
-
| `facts.selection.owner.kind?` | `"installation"` \| `"deployment"`
|
|
1307
|
-
| `facts.selection.owner.id?` | `string`
|
|
1308
|
-
| `facts.selection.appId?` | `AppId`
|
|
1309
|
-
| `facts.selection.releaseId?` | `ReleaseId`
|
|
1310
|
-
| `facts.selection.authorityVersion?` | `number`
|
|
1311
|
-
| `facts.artifactDigest?` | `Sha256Digest`
|
|
1312
|
-
| `facts.subject?` | \| \{ `kind`: `"call"`; `context`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; `sessionId?`: `string`; `agentPolicy?`: \{ `policyRevision`: `string`; `grantorMemberId`: `string`; \}; `method?`: \{ `name`: `string`; `effect`: `"read"` \| `"write"` \| `"external"`; \}; `replay?`: \{ `lane`: `string`; `epoch`: `number`; `admitted`: readonly `string`[]; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onGitPush"`; `eventId`: `string`; \} \| \{ `kind`: `"lifecycle"`; `name`: `"syncRefused"`; `lane`: `string`; `code`: `"access_changed"` \| `"installation_unavailable"`; \} | `...` |
|
|
1313
|
-
| `facts.grants?` | readonly `object`[]
|
|
1314
|
-
| `facts.deadlineAt?` | `number`
|
|
1315
|
-
| `facts.ancestry?` | readonly [`InstanceId`](index.md#instanceid)[]
|
|
1316
|
-
| `_api?` | `AppApi`
|
|
1317
|
-
| `source?` | `string`
|
|
1318
|
-
| `input?` | \{ `id`: `string`; `params?`: \{ \[`key`: `string`\]: `string`; \}; `after?`: `string`; `options?`: `string`; \}
|
|
1319
|
-
| `input.id?` | `string`
|
|
1320
|
-
| `input.params?` | \{ \[`key`: `string`\]: `string`; \}
|
|
1321
|
-
| `input.after?` | `string`
|
|
1322
|
-
| `input.options?` | `string`
|
|
1323
|
-
| `limits?` | `Readonly`\<\{ `cpuMs`: `number`; `subRequests`: `number`; \}\>
|
|
1324
|
-
| `tenantId?` | `string` & `Brand`\<`"OysterTenantId"`\>
|
|
1383
|
+
| Parameter | Type | Default value |
|
|
1384
|
+
| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
|
|
1385
|
+
| `facts` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `selection`: \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \}; `artifactDigest`: `Sha256Digest`; `subject`: \| \{ `kind`: `"call"`; `context`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; `sessionId?`: `string`; `agentPolicy?`: \{ `policyRevision`: `string`; `grantorMemberId`: `string`; \}; `method?`: \{ `name`: `string`; `effect`: `"read"` \| `"write"` \| `"external"`; \}; `replay?`: \{ `lane`: `string`; `epoch`: `number`; `admitted`: readonly `string`[]; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onGitPush"`; `eventId`: `string`; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onRegion"`; `event`: `"message"` \| `"connect"` \| `"close"` \| `"alarm"`; `context?`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"syncRefused"`; `lane`: `string`; `code`: `"access_changed"` \| `"installation_unavailable"`; \}; `grants`: readonly `object`[]; `deadlineAt`: `number`; `ancestry`: readonly [`InstanceId`](index.md#instanceid)[]; \} | `undefined` |
|
|
1386
|
+
| `facts.instanceId` | [`InstanceId`](index.md#instanceid) | `instanceIdSchema` |
|
|
1387
|
+
| `facts.selection` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \} | `selectionSchema` |
|
|
1388
|
+
| `facts.selection.instanceId` | [`InstanceId`](index.md#instanceid) | `instanceIdSchema` |
|
|
1389
|
+
| `facts.selection.owner` | \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \} | `ownerSchema` |
|
|
1390
|
+
| `facts.selection.owner.kind?` | `"installation"` \| `"deployment"` | `...` |
|
|
1391
|
+
| `facts.selection.owner.id?` | `string` | `Schema.NonEmptyString` |
|
|
1392
|
+
| `facts.selection.appId?` | `AppId` | `appIdSchema` |
|
|
1393
|
+
| `facts.selection.releaseId?` | `ReleaseId` | `releaseIdSchema` |
|
|
1394
|
+
| `facts.selection.authorityVersion?` | `number` | `...` |
|
|
1395
|
+
| `facts.artifactDigest?` | `Sha256Digest` | `sha256DigestSchema` |
|
|
1396
|
+
| `facts.subject?` | \| \{ `kind`: `"call"`; `context`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; `sessionId?`: `string`; `agentPolicy?`: \{ `policyRevision`: `string`; `grantorMemberId`: `string`; \}; `method?`: \{ `name`: `string`; `effect`: `"read"` \| `"write"` \| `"external"`; \}; `replay?`: \{ `lane`: `string`; `epoch`: `number`; `admitted`: readonly `string`[]; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onGitPush"`; `eventId`: `string`; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onRegion"`; `event`: `"message"` \| `"connect"` \| `"close"` \| `"alarm"`; `context?`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"syncRefused"`; `lane`: `string`; `code`: `"access_changed"` \| `"installation_unavailable"`; \} | `...` |
|
|
1397
|
+
| `facts.grants?` | readonly `object`[] | `grantsSchema` |
|
|
1398
|
+
| `facts.deadlineAt?` | `number` | `...` |
|
|
1399
|
+
| `facts.ancestry?` | readonly [`InstanceId`](index.md#instanceid)[] | `...` |
|
|
1400
|
+
| `_api?` | `AppApi` | `undefined` |
|
|
1401
|
+
| `source?` | `string` | `undefined` |
|
|
1402
|
+
| `input?` | \{ `id`: `string`; `params?`: \{ \[`key`: `string`\]: `string`; \}; `after?`: `string`; `options?`: `string`; \} | `undefined` |
|
|
1403
|
+
| `input.id?` | `string` | `undefined` |
|
|
1404
|
+
| `input.params?` | \{ \[`key`: `string`\]: `string`; \} | `undefined` |
|
|
1405
|
+
| `input.after?` | `string` | `undefined` |
|
|
1406
|
+
| `input.options?` | `string` | `undefined` |
|
|
1407
|
+
| `limits?` | `Readonly`\<\{ `cpuMs`: `number`; `subRequests`: `number`; \}\> | `undefined` |
|
|
1408
|
+
| `tenantId?` | `string` & `Brand`\<`"OysterTenantId"`\> | `defaultTenant` |
|
|
1325
1409
|
|
|
1326
1410
|
###### Returns
|
|
1327
1411
|
|
|
@@ -1358,28 +1442,28 @@ host handle decodes.
|
|
|
1358
1442
|
|
|
1359
1443
|
###### Parameters
|
|
1360
1444
|
|
|
1361
|
-
| Parameter | Type
|
|
1362
|
-
| ----------------------------------- |
|
|
1363
|
-
| `facts` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `selection`: \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \}; `artifactDigest`: `Sha256Digest`; `subject`: \| \{ `kind`: `"call"`; `context`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; `sessionId?`: `string`; `agentPolicy?`: \{ `policyRevision`: `string`; `grantorMemberId`: `string`; \}; `method?`: \{ `name`: `string`; `effect`: `"read"` \| `"write"` \| `"external"`; \}; `replay?`: \{ `lane`: `string`; `epoch`: `number`; `admitted`: readonly `string`[]; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onGitPush"`; `eventId`: `string`; \} \| \{ `kind`: `"lifecycle"`; `name`: `"syncRefused"`; `lane`: `string`; `code`: `"access_changed"` \| `"installation_unavailable"`; \}; `grants`: readonly `object`[]; `deadlineAt`: `number`; `ancestry`: readonly [`InstanceId`](index.md#instanceid)[]; \} | `undefined` |
|
|
1364
|
-
| `facts.instanceId` | [`InstanceId`](index.md#instanceid)
|
|
1365
|
-
| `facts.selection` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \}
|
|
1366
|
-
| `facts.selection.instanceId` | [`InstanceId`](index.md#instanceid)
|
|
1367
|
-
| `facts.selection.owner` | \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}
|
|
1368
|
-
| `facts.selection.owner.kind?` | `"installation"` \| `"deployment"`
|
|
1369
|
-
| `facts.selection.owner.id?` | `string`
|
|
1370
|
-
| `facts.selection.appId?` | `AppId`
|
|
1371
|
-
| `facts.selection.releaseId?` | `ReleaseId`
|
|
1372
|
-
| `facts.selection.authorityVersion?` | `number`
|
|
1373
|
-
| `facts.artifactDigest?` | `Sha256Digest`
|
|
1374
|
-
| `facts.subject?` | \| \{ `kind`: `"call"`; `context`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; `sessionId?`: `string`; `agentPolicy?`: \{ `policyRevision`: `string`; `grantorMemberId`: `string`; \}; `method?`: \{ `name`: `string`; `effect`: `"read"` \| `"write"` \| `"external"`; \}; `replay?`: \{ `lane`: `string`; `epoch`: `number`; `admitted`: readonly `string`[]; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onGitPush"`; `eventId`: `string`; \} \| \{ `kind`: `"lifecycle"`; `name`: `"syncRefused"`; `lane`: `string`; `code`: `"access_changed"` \| `"installation_unavailable"`; \} | `...` |
|
|
1375
|
-
| `facts.grants?` | readonly `object`[]
|
|
1376
|
-
| `facts.deadlineAt?` | `number`
|
|
1377
|
-
| `facts.ancestry?` | readonly [`InstanceId`](index.md#instanceid)[]
|
|
1378
|
-
| `_api?` | `AppApi`
|
|
1379
|
-
| `name?` | `string`
|
|
1380
|
-
| `input?` | `Json`
|
|
1381
|
-
| `limits?` | `Readonly`\<\{ `cpuMs`: `number`; `subRequests`: `number`; \}\>
|
|
1382
|
-
| `tenantId?` | `string` & `Brand`\<`"OysterTenantId"`\>
|
|
1445
|
+
| Parameter | Type | Default value |
|
|
1446
|
+
| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
|
|
1447
|
+
| `facts` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `selection`: \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \}; `artifactDigest`: `Sha256Digest`; `subject`: \| \{ `kind`: `"call"`; `context`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; `sessionId?`: `string`; `agentPolicy?`: \{ `policyRevision`: `string`; `grantorMemberId`: `string`; \}; `method?`: \{ `name`: `string`; `effect`: `"read"` \| `"write"` \| `"external"`; \}; `replay?`: \{ `lane`: `string`; `epoch`: `number`; `admitted`: readonly `string`[]; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onGitPush"`; `eventId`: `string`; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onRegion"`; `event`: `"message"` \| `"connect"` \| `"close"` \| `"alarm"`; `context?`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"syncRefused"`; `lane`: `string`; `code`: `"access_changed"` \| `"installation_unavailable"`; \}; `grants`: readonly `object`[]; `deadlineAt`: `number`; `ancestry`: readonly [`InstanceId`](index.md#instanceid)[]; \} | `undefined` |
|
|
1448
|
+
| `facts.instanceId` | [`InstanceId`](index.md#instanceid) | `instanceIdSchema` |
|
|
1449
|
+
| `facts.selection` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \} | `selectionSchema` |
|
|
1450
|
+
| `facts.selection.instanceId` | [`InstanceId`](index.md#instanceid) | `instanceIdSchema` |
|
|
1451
|
+
| `facts.selection.owner` | \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \} | `ownerSchema` |
|
|
1452
|
+
| `facts.selection.owner.kind?` | `"installation"` \| `"deployment"` | `...` |
|
|
1453
|
+
| `facts.selection.owner.id?` | `string` | `Schema.NonEmptyString` |
|
|
1454
|
+
| `facts.selection.appId?` | `AppId` | `appIdSchema` |
|
|
1455
|
+
| `facts.selection.releaseId?` | `ReleaseId` | `releaseIdSchema` |
|
|
1456
|
+
| `facts.selection.authorityVersion?` | `number` | `...` |
|
|
1457
|
+
| `facts.artifactDigest?` | `Sha256Digest` | `sha256DigestSchema` |
|
|
1458
|
+
| `facts.subject?` | \| \{ `kind`: `"call"`; `context`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; `sessionId?`: `string`; `agentPolicy?`: \{ `policyRevision`: `string`; `grantorMemberId`: `string`; \}; `method?`: \{ `name`: `string`; `effect`: `"read"` \| `"write"` \| `"external"`; \}; `replay?`: \{ `lane`: `string`; `epoch`: `number`; `admitted`: readonly `string`[]; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onGitPush"`; `eventId`: `string`; \} \| \{ `kind`: `"lifecycle"`; `name`: `"onRegion"`; `event`: `"message"` \| `"connect"` \| `"close"` \| `"alarm"`; `context?`: \{ `scope`: \| \{ `kind`: `"team"`; `teamId`: `string`; \} \| \{ `kind`: `"standalone"`; `tenant`: `string`; \}; `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`; \}; \} \| \{ `kind`: `"lifecycle"`; `name`: `"syncRefused"`; `lane`: `string`; `code`: `"access_changed"` \| `"installation_unavailable"`; \} | `...` |
|
|
1459
|
+
| `facts.grants?` | readonly `object`[] | `grantsSchema` |
|
|
1460
|
+
| `facts.deadlineAt?` | `number` | `...` |
|
|
1461
|
+
| `facts.ancestry?` | readonly [`InstanceId`](index.md#instanceid)[] | `...` |
|
|
1462
|
+
| `_api?` | `AppApi` | `undefined` |
|
|
1463
|
+
| `name?` | `string` | `undefined` |
|
|
1464
|
+
| `input?` | `Json` | `undefined` |
|
|
1465
|
+
| `limits?` | `Readonly`\<\{ `cpuMs`: `number`; `subRequests`: `number`; \}\> | `undefined` |
|
|
1466
|
+
| `tenantId?` | `string` & `Brand`\<`"OysterTenantId"`\> | `defaultTenant` |
|
|
1383
1467
|
|
|
1384
1468
|
###### Returns
|
|
1385
1469
|
|
|
@@ -1499,6 +1583,18 @@ A new subscription and its signing secret, shown once.
|
|
|
1499
1583
|
|
|
1500
1584
|
---
|
|
1501
1585
|
|
|
1586
|
+
### SubscriptionRefused
|
|
1587
|
+
|
|
1588
|
+
```ts
|
|
1589
|
+
type SubscriptionRefused = Readonly<{
|
|
1590
|
+
error: "unavailable";
|
|
1591
|
+
}>;
|
|
1592
|
+
```
|
|
1593
|
+
|
|
1594
|
+
A host with no configured keyring stores no new signing secret.
|
|
1595
|
+
|
|
1596
|
+
---
|
|
1597
|
+
|
|
1502
1598
|
### WebhookDelivery
|
|
1503
1599
|
|
|
1504
1600
|
```ts
|
|
@@ -1571,7 +1667,7 @@ type OysterGitWorkerOptions<Env> = Readonly<{
|
|
|
1571
1667
|
env,
|
|
1572
1668
|
keysLive,
|
|
1573
1669
|
scope,
|
|
1574
|
-
|
|
1670
|
+
caller?,
|
|
1575
1671
|
) => OysterWorkspace | Promise<OysterWorkspace>;
|
|
1576
1672
|
capabilities?: (env, workspace) => readonly OysterCapability[];
|
|
1577
1673
|
workflowGitPass?: (
|
|
@@ -1625,6 +1721,24 @@ A tenant's whole Git host: the App server, `host.git` and the owner routes.
|
|
|
1625
1721
|
|
|
1626
1722
|
---
|
|
1627
1723
|
|
|
1724
|
+
### OysterWorkspaceCaller
|
|
1725
|
+
|
|
1726
|
+
```ts
|
|
1727
|
+
type OysterWorkspaceCaller =
|
|
1728
|
+
| Readonly<{
|
|
1729
|
+
request: Request;
|
|
1730
|
+
auth: OysterAuth;
|
|
1731
|
+
}>
|
|
1732
|
+
| Readonly<{
|
|
1733
|
+
principal: TenantPrincipal;
|
|
1734
|
+
}>;
|
|
1735
|
+
```
|
|
1736
|
+
|
|
1737
|
+
Who a workspace is selected for: an HTTP request it may authenticate, or a
|
|
1738
|
+
principal already admitted elsewhere (an MCP catalog).
|
|
1739
|
+
|
|
1740
|
+
---
|
|
1741
|
+
|
|
1628
1742
|
### OysterKeysLivePort
|
|
1629
1743
|
|
|
1630
1744
|
```ts
|
|
@@ -1932,6 +2046,7 @@ function oysterGitWorkerHost<Env>(
|
|
|
1932
2046
|
options,
|
|
1933
2047
|
selected,
|
|
1934
2048
|
request?,
|
|
2049
|
+
principal?,
|
|
1935
2050
|
): Promise<OysterGitWorkerHost>;
|
|
1936
2051
|
```
|
|
1937
2052
|
|
|
@@ -1947,12 +2062,13 @@ tenant.
|
|
|
1947
2062
|
|
|
1948
2063
|
#### Parameters
|
|
1949
2064
|
|
|
1950
|
-
| Parameter
|
|
1951
|
-
|
|
|
1952
|
-
| `env`
|
|
1953
|
-
| `options`
|
|
1954
|
-
| `selected`
|
|
1955
|
-
| `request?`
|
|
2065
|
+
| Parameter | Type |
|
|
2066
|
+
| ------------ | ------------------------------------------------------------ |
|
|
2067
|
+
| `env` | `Env` |
|
|
2068
|
+
| `options` | [`OysterGitWorkerOptions`](#oystergitworkeroptions)\<`Env`\> |
|
|
2069
|
+
| `selected` | [`ResolvedTenant`](tenant.md#resolvedtenant) |
|
|
2070
|
+
| `request?` | `Request`\<`unknown`, `CfProperties`\<`unknown`\>\> |
|
|
2071
|
+
| `principal?` | [`TenantPrincipal`](tenant.md#tenantprincipal) |
|
|
1956
2072
|
|
|
1957
2073
|
#### Returns
|
|
1958
2074
|
|