@fungi.computer/oyster 0.28.1 → 0.29.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -0
- package/dist/apps/catalog.js +1 -1
- package/dist/apps/gate.d.ts +2 -1
- package/dist/apps/gate.js +10 -7
- package/dist/apps/index.d.ts +1 -1
- package/dist/apps/index.js +1 -1
- package/dist/apps/installation.d.ts +27 -5
- package/dist/apps/installation.js +86 -29
- package/dist/apps/operations.d.ts +5 -0
- package/dist/apps/operations.js +49 -10
- package/dist/apps/permissions.d.ts +23 -7
- package/dist/apps/permissions.js +5 -1
- package/dist/authorization.d.ts +2 -1
- package/dist/boot-host-script.js +1 -1
- package/dist/build/candidate-cli.mjs +1823 -1833
- package/dist/embed-metafiles.js +2 -2
- package/dist/embed-scripts.js +1 -1
- package/dist/host.js +7 -2
- package/dist/installation-migration.d.ts +5 -0
- package/dist/installation-migration.js +78 -0
- package/dist/installation-operations.d.ts +8 -0
- package/dist/installation-operations.js +2 -0
- package/dist/invocation.d.ts +3 -3
- package/dist/page-script.js +2 -2
- package/dist/standalone/computer.d.ts +2 -2
- package/dist/standalone/registry.d.ts +2 -2
- package/dist/standalone/workflow-host.d.ts +6 -1
- package/dist/tenancy/cloudflare/registry.js +6 -2
- package/dist/tenancy/contracts.d.ts +4 -3
- package/dist/tenancy/index.js +2 -1
- package/dist/tenant.d.ts +2 -1
- package/dist/workers.js +2 -0
- package/docs/api/apps.md +108 -81
- package/docs/api/authorization.md +1 -1
- package/docs/api/git.md +4 -4
- package/docs/api/host.md +8 -2
- package/docs/api/invocation.md +87 -87
- package/docs/api/mcp.md +16 -16
- package/docs/api/tenancy.md +3 -3
- package/docs/api/tenant.md +1 -1
- package/docs/api/workers-git.md +157 -157
- package/docs/api/workers.md +231 -221
- package/package.json +17 -17
package/docs/api/git.md
CHANGED
|
@@ -124,7 +124,7 @@ type GitDoorHost = Readonly<{
|
|
|
124
124
|
| Readonly<{
|
|
125
125
|
kind: "actor";
|
|
126
126
|
actor: HostActor;
|
|
127
|
-
role?:
|
|
127
|
+
role?: TeamRole;
|
|
128
128
|
workflow?: WorkflowAttestation & object;
|
|
129
129
|
}>
|
|
130
130
|
| null>;
|
|
@@ -217,9 +217,9 @@ storage.
|
|
|
217
217
|
|
|
218
218
|
#### Parameters
|
|
219
219
|
|
|
220
|
-
| Parameter | Type
|
|
221
|
-
| --------- |
|
|
222
|
-
| `ports` | `Readonly`\<\{ `currentInstallation`: `Promise`\< \| `Readonly`\<\{ `installationId`: `string`; `instanceId`: [`InstanceId`](index.md#instanceid) \| `null`; `appId`: `AppId`; `release`: \{ `releaseId`: `Schema.refine`\<`ReleaseId`, `Schema.String`\>; `appId`: `Schema.refine`\<`AppId`, `Schema.String`\>; `artifact`: `Schema.Struct`\<\{ `artifactRef`: `Schema.refine`\<`ArtifactRef`, `Schema.String`\>; `artifactDigest`: `Schema.refine`\<`Sha256Digest`, `Schema.String`\>; `provenance`: `Schema.Struct`\<\{ `sourceRevision`: ...; `sourceTreeDigest`: ...; `buildRecipeDigest`: ...; \}\>; \}\>; \}; `releasePin`: `"pinned"` \| `"floating"`; `authority`: \{ `authorityVersion`: `number`; `declaredOperationsDigest`: `Sha256Digest`; `approvedGrants`: readonly `Readonly`\<\{ `capability`: \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ...; `capabilityApproved`: `true`; `operations`: readonly ...[]; `resources`: ... \| ...; \}\>[]; `approval`: \| `Readonly`\<\{ `by`: ... \| ... \| ...; `at`: `number`; `authorityVersion`: `number`; \}\> \| `null`; \}; `status`: `"enabled"` \| `"disabled"` \| `"deleted"`; \}\> \| `null`\>; `declaration`: `Promise`\< \| `Readonly`\<\{ `api?`: `AppApi`; `displayName?`: `string`; `capabilities`: readonly `AppCapabilityId`[]; `calls?`: readonly `Readonly`\<\{ `appId`: ...; `methods`: ...; \}\>[]; `guidance?`: `string`; `handlers`: readonly `AppHandler`[]; `receives?`: readonly `"git.push"`[]; `icon?`: `string`; `roles`: readonly `AppRole`[]; `storage?`: readonly `AppStorageKey`[]; `commands?`: readonly `AppDeclaredCommand`[]; `gills?`: readonly `AppDeclaredGill`[]; `backend?`: `Readonly`\<\{ `bindings`: readonly ...[]; `sync?`: `Readonly`\<\{ `method`: ...; \}\>; \}\>; \}\> \| `null`\>; \}\> |
|
|
220
|
+
| Parameter | Type |
|
|
221
|
+
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
222
|
+
| `ports` | `Readonly`\<\{ `currentInstallation`: `Promise`\< \| `Readonly`\<\{ `installationId`: `string`; `instanceId`: [`InstanceId`](index.md#instanceid) \| `null`; `appId`: `AppId`; `release`: \{ `releaseId`: `Schema.refine`\<`ReleaseId`, `Schema.String`\>; `appId`: `Schema.refine`\<`AppId`, `Schema.String`\>; `artifact`: `Schema.Struct`\<\{ `artifactRef`: `Schema.refine`\<`ArtifactRef`, `Schema.String`\>; `artifactDigest`: `Schema.refine`\<`Sha256Digest`, `Schema.String`\>; `provenance`: `Schema.Struct`\<\{ `sourceRevision`: ...; `sourceTreeDigest`: ...; `buildRecipeDigest`: ...; \}\>; \}\>; \}; `releasePin`: `"pinned"` \| `"floating"`; `authority`: \{ `authorityVersion`: `number`; `declaredOperationsDigest`: `Sha256Digest`; `approvedGrants`: readonly `Readonly`\<\{ `capability`: \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ... \| ...; `capabilityApproved`: `true`; `operations`: readonly ...[]; `fingerprints`: `Readonly`\<...\>; `resources`: ... \| ...; \}\>[]; `approval`: \| `Readonly`\<\{ `by`: ... \| ... \| ...; `at`: `number`; `authorityVersion`: `number`; \}\> \| `null`; \}; `status`: `"enabled"` \| `"disabled"` \| `"deleted"`; \}\> \| `null`\>; `declaration`: `Promise`\< \| `Readonly`\<\{ `api?`: `AppApi`; `displayName?`: `string`; `capabilities`: readonly `AppCapabilityId`[]; `calls?`: readonly `Readonly`\<\{ `appId`: ...; `methods`: ...; \}\>[]; `guidance?`: `string`; `handlers`: readonly `AppHandler`[]; `receives?`: readonly `"git.push"`[]; `icon?`: `string`; `roles`: readonly `AppRole`[]; `storage?`: readonly `AppStorageKey`[]; `commands?`: readonly `AppDeclaredCommand`[]; `gills?`: readonly `AppDeclaredGill`[]; `backend?`: `Readonly`\<\{ `bindings`: readonly ...[]; `sync?`: `Readonly`\<\{ `method`: ...; \}\>; \}\>; \}\> \| `null`\>; \}\> |
|
|
223
223
|
|
|
224
224
|
#### Returns
|
|
225
225
|
|
package/docs/api/host.md
CHANGED
|
@@ -270,13 +270,13 @@ type OysterGitHost = Readonly<{
|
|
|
270
270
|
workflowPass?: Promise<Readonly<{
|
|
271
271
|
kind: "actor";
|
|
272
272
|
actor: HostActor;
|
|
273
|
-
role?:
|
|
273
|
+
role?: TeamRole;
|
|
274
274
|
workflow?: WorkflowAttestation & object;
|
|
275
275
|
}> | null>;
|
|
276
276
|
buildPass?: Promise<Readonly<{
|
|
277
277
|
kind: "actor";
|
|
278
278
|
actor: HostActor;
|
|
279
|
-
role?:
|
|
279
|
+
role?: TeamRole;
|
|
280
280
|
workflow?: WorkflowAttestation & object;
|
|
281
281
|
}> | null>;
|
|
282
282
|
git: Promise<
|
|
@@ -624,6 +624,7 @@ type InstallationOperations = Readonly<{
|
|
|
624
624
|
capability: ...;
|
|
625
625
|
capabilityApproved: ...;
|
|
626
626
|
operations: ...;
|
|
627
|
+
fingerprints: ...;
|
|
627
628
|
resources: ...;
|
|
628
629
|
}>[];
|
|
629
630
|
approval: | Readonly<{
|
|
@@ -780,6 +781,7 @@ type InstallationOperations = Readonly<{
|
|
|
780
781
|
capability: ...;
|
|
781
782
|
capabilityApproved: ...;
|
|
782
783
|
operations: ...;
|
|
784
|
+
fingerprints: ...;
|
|
783
785
|
resources: ...;
|
|
784
786
|
}>[];
|
|
785
787
|
approval: | Readonly<{
|
|
@@ -937,6 +939,7 @@ type InstallationOperations = Readonly<{
|
|
|
937
939
|
capability: ...;
|
|
938
940
|
capabilityApproved: ...;
|
|
939
941
|
operations: ...;
|
|
942
|
+
fingerprints: ...;
|
|
940
943
|
resources: ...;
|
|
941
944
|
}>[];
|
|
942
945
|
approval: | Readonly<{
|
|
@@ -1031,6 +1034,7 @@ type InstallationOperations = Readonly<{
|
|
|
1031
1034
|
capability: ...;
|
|
1032
1035
|
capabilityApproved: ...;
|
|
1033
1036
|
operations: ...;
|
|
1037
|
+
fingerprints: ...;
|
|
1034
1038
|
resources: ...;
|
|
1035
1039
|
}>[];
|
|
1036
1040
|
approval: | Readonly<{
|
|
@@ -1213,6 +1217,7 @@ type InstallationOperations = Readonly<{
|
|
|
1213
1217
|
| ...;
|
|
1214
1218
|
capabilityApproved: true;
|
|
1215
1219
|
operations: readonly ...[];
|
|
1220
|
+
fingerprints: Readonly<...>;
|
|
1216
1221
|
resources: ... | ...;
|
|
1217
1222
|
}>[];
|
|
1218
1223
|
approval: | Readonly<{
|
|
@@ -1249,6 +1254,7 @@ type InstallationOperations = Readonly<{
|
|
|
1249
1254
|
capability: ...;
|
|
1250
1255
|
capabilityApproved: ...;
|
|
1251
1256
|
operations: ...;
|
|
1257
|
+
fingerprints: ...;
|
|
1252
1258
|
resources: ...;
|
|
1253
1259
|
}>[];
|
|
1254
1260
|
approval: | Readonly<{
|
package/docs/api/invocation.md
CHANGED
|
@@ -208,7 +208,7 @@ const invocationFactsSchema: Struct<{
|
|
|
208
208
|
method: string;
|
|
209
209
|
seal: string;
|
|
210
210
|
};
|
|
211
|
-
role?: "member" | "owner";
|
|
211
|
+
role?: "member" | "owner" | "admin";
|
|
212
212
|
soleMember?: true;
|
|
213
213
|
workflow?: {
|
|
214
214
|
workflowId: string;
|
|
@@ -236,7 +236,7 @@ const invocationFactsSchema: Struct<{
|
|
|
236
236
|
method: string;
|
|
237
237
|
seal: string;
|
|
238
238
|
};
|
|
239
|
-
role?: "member" | "owner";
|
|
239
|
+
role?: "member" | "owner" | "admin";
|
|
240
240
|
soleMember?: true;
|
|
241
241
|
workflow?: {
|
|
242
242
|
workflowId: string;
|
|
@@ -264,7 +264,7 @@ const invocationFactsSchema: Struct<{
|
|
|
264
264
|
method: string;
|
|
265
265
|
seal: string;
|
|
266
266
|
};
|
|
267
|
-
role?: "member" | "owner";
|
|
267
|
+
role?: "member" | "owner" | "admin";
|
|
268
268
|
soleMember?: true;
|
|
269
269
|
workflow?: {
|
|
270
270
|
workflowId: string;
|
|
@@ -467,7 +467,7 @@ projection.
|
|
|
467
467
|
| `backgroundOrigin?` | `object` |
|
|
468
468
|
| `backgroundOrigin.method` | `string` |
|
|
469
469
|
| `backgroundOrigin.seal` | `string` |
|
|
470
|
-
| `role?` | `"member"` \| `"owner"`
|
|
470
|
+
| `role?` | `"member"` \| `"owner"` \| `"admin"` |
|
|
471
471
|
| `soleMember?` | `true` |
|
|
472
472
|
| `workflow?` | `object` |
|
|
473
473
|
| `workflow.workflowId` | `string` |
|
|
@@ -524,58 +524,58 @@ Mint standalone facts only after host caller and Release admission.
|
|
|
524
524
|
|
|
525
525
|
#### Parameters
|
|
526
526
|
|
|
527
|
-
| Parameter | Type
|
|
528
|
-
| ---------------------------------- |
|
|
529
|
-
| `installation` | [`Installation`](apps.md#installation)
|
|
530
|
-
| `release` | [`VerifiedRelease`](host.md#verifiedrelease)
|
|
531
|
-
| `context` | \{ `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"`; `soleMember?`: `true`; `workflow?`: \{ `workflowId`: `string`; `runId`: `string`; `nodeId`: `string`; `armedBy`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; \}; `idempotencyKey?`: `string`; \} | `undefined` |
|
|
532
|
-
| `context.computerId` | `string` \| `null`
|
|
533
|
-
| `context.actor` | \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}
|
|
534
|
-
| `context.backgroundLane?` | `string`
|
|
535
|
-
| `context.backgroundOrigin?` | \{ `method`: `string`; `seal`: `string`; \}
|
|
536
|
-
| `context.backgroundOrigin.method?` | `string`
|
|
537
|
-
| `context.backgroundOrigin.seal?` | `string`
|
|
538
|
-
| `context.role?` | `"member"` \| `"owner"` | `undefined` |
|
|
539
|
-
| `context.soleMember?` | `true`
|
|
540
|
-
| `context.workflow?` | \{ `workflowId`: `string`; `runId`: `string`; `nodeId`: `string`; `armedBy`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; \}
|
|
541
|
-
| `context.workflow.workflowId?` | `string`
|
|
542
|
-
| `context.workflow.runId?` | `string`
|
|
543
|
-
| `context.workflow.nodeId?` | `string`
|
|
544
|
-
| `context.workflow.armedBy?` | \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}
|
|
545
|
-
| `context.idempotencyKey?` | `string`
|
|
546
|
-
| `grants?` | readonly `object`[]
|
|
547
|
-
| `ancestry?` | readonly [`InstanceId`](index.md#instanceid)[]
|
|
548
|
-
| `sessionId?` | `string`
|
|
549
|
-
| `agentPolicy?` | \{ `policyRevision`: `string`; `grantorMemberId`: `string`; \}
|
|
550
|
-
| `agentPolicy.policyRevision?` | `string`
|
|
551
|
-
| `agentPolicy.grantorMemberId?` | `string`
|
|
552
|
-
| `method?` | \{ `name`: `string`; `effect`: `"read"` \| `"write"` \| `"external"`; \}
|
|
553
|
-
| `method.name?` | `string`
|
|
554
|
-
| `method.effect?` | `"read"` \| `"write"` \| `"external"`
|
|
555
|
-
| `origin?` | \{ `method`: `string`; `seal`: `string`; \}
|
|
556
|
-
| `origin.method?` | `string`
|
|
557
|
-
| `origin.seal?` | `string`
|
|
527
|
+
| Parameter | Type | Default value |
|
|
528
|
+
| ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- |
|
|
529
|
+
| `installation` | [`Installation`](apps.md#installation) | `undefined` |
|
|
530
|
+
| `release` | [`VerifiedRelease`](host.md#verifiedrelease) | `undefined` |
|
|
531
|
+
| `context` | \{ `computerId`: `string` \| `null`; `actor`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; `backgroundLane?`: `string`; `backgroundOrigin?`: \{ `method`: `string`; `seal`: `string`; \}; `role?`: `"member"` \| `"owner"` \| `"admin"`; `soleMember?`: `true`; `workflow?`: \{ `workflowId`: `string`; `runId`: `string`; `nodeId`: `string`; `armedBy`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; \}; `idempotencyKey?`: `string`; \} | `undefined` |
|
|
532
|
+
| `context.computerId` | `string` \| `null` | `undefined` |
|
|
533
|
+
| `context.actor` | \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \} | `undefined` |
|
|
534
|
+
| `context.backgroundLane?` | `string` | `undefined` |
|
|
535
|
+
| `context.backgroundOrigin?` | \{ `method`: `string`; `seal`: `string`; \} | `undefined` |
|
|
536
|
+
| `context.backgroundOrigin.method?` | `string` | `undefined` |
|
|
537
|
+
| `context.backgroundOrigin.seal?` | `string` | `undefined` |
|
|
538
|
+
| `context.role?` | `"member"` \| `"owner"` \| `"admin"` | `undefined` |
|
|
539
|
+
| `context.soleMember?` | `true` | `undefined` |
|
|
540
|
+
| `context.workflow?` | \{ `workflowId`: `string`; `runId`: `string`; `nodeId`: `string`; `armedBy`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; \} | `undefined` |
|
|
541
|
+
| `context.workflow.workflowId?` | `string` | `undefined` |
|
|
542
|
+
| `context.workflow.runId?` | `string` | `undefined` |
|
|
543
|
+
| `context.workflow.nodeId?` | `string` | `undefined` |
|
|
544
|
+
| `context.workflow.armedBy?` | \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \} | `undefined` |
|
|
545
|
+
| `context.idempotencyKey?` | `string` | `undefined` |
|
|
546
|
+
| `grants?` | readonly `object`[] | `undefined` |
|
|
547
|
+
| `ancestry?` | readonly [`InstanceId`](index.md#instanceid)[] | `[]` |
|
|
548
|
+
| `sessionId?` | `string` | `undefined` |
|
|
549
|
+
| `agentPolicy?` | \{ `policyRevision`: `string`; `grantorMemberId`: `string`; \} | `undefined` |
|
|
550
|
+
| `agentPolicy.policyRevision?` | `string` | `appToolPolicySchema.fields.revision` |
|
|
551
|
+
| `agentPolicy.grantorMemberId?` | `string` | `appToolPolicySchema.fields.grantedBy` |
|
|
552
|
+
| `method?` | \{ `name`: `string`; `effect`: `"read"` \| `"write"` \| `"external"`; \} | `undefined` |
|
|
553
|
+
| `method.name?` | `string` | `appApiMethodNameSchema` |
|
|
554
|
+
| `method.effect?` | `"read"` \| `"write"` \| `"external"` | `...` |
|
|
555
|
+
| `origin?` | \{ `method`: `string`; `seal`: `string`; \} | `undefined` |
|
|
556
|
+
| `origin.method?` | `string` | `undefined` |
|
|
557
|
+
| `origin.seal?` | `string` | `undefined` |
|
|
558
558
|
|
|
559
559
|
#### Returns
|
|
560
560
|
|
|
561
561
|
`object`
|
|
562
562
|
|
|
563
|
-
| Name | Type
|
|
564
|
-
| ---------------------------- |
|
|
565
|
-
| `instanceId` | [`InstanceId`](index.md#instanceid)
|
|
566
|
-
| `selection` | `object`
|
|
567
|
-
| `selection.instanceId` | [`InstanceId`](index.md#instanceid)
|
|
568
|
-
| `selection.owner` | `object`
|
|
569
|
-
| `selection.owner.kind` | `"installation"` \| `"deployment"`
|
|
570
|
-
| `selection.owner.id` | `string`
|
|
571
|
-
| `selection.appId` | `AppId`
|
|
572
|
-
| `selection.releaseId` | `ReleaseId`
|
|
573
|
-
| `selection.authorityVersion` | `number`
|
|
574
|
-
| `artifactDigest` | `Sha256Digest`
|
|
575
|
-
| `subject` | \| \{ `kind`: `"call"`; `context`: \{ `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"`; `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"`; \} | - |
|
|
576
|
-
| `grants` | readonly `object`[]
|
|
577
|
-
| `deadlineAt` | `number`
|
|
578
|
-
| `ancestry` | readonly [`InstanceId`](index.md#instanceid)[]
|
|
563
|
+
| Name | Type | Default value |
|
|
564
|
+
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
|
|
565
|
+
| `instanceId` | [`InstanceId`](index.md#instanceid) | `instanceIdSchema` |
|
|
566
|
+
| `selection` | `object` | `selectionSchema` |
|
|
567
|
+
| `selection.instanceId` | [`InstanceId`](index.md#instanceid) | `instanceIdSchema` |
|
|
568
|
+
| `selection.owner` | `object` | `ownerSchema` |
|
|
569
|
+
| `selection.owner.kind` | `"installation"` \| `"deployment"` | - |
|
|
570
|
+
| `selection.owner.id` | `string` | `Schema.NonEmptyString` |
|
|
571
|
+
| `selection.appId` | `AppId` | `appIdSchema` |
|
|
572
|
+
| `selection.releaseId` | `ReleaseId` | `releaseIdSchema` |
|
|
573
|
+
| `selection.authorityVersion` | `number` | - |
|
|
574
|
+
| `artifactDigest` | `Sha256Digest` | `sha256DigestSchema` |
|
|
575
|
+
| `subject` | \| \{ `kind`: `"call"`; `context`: \{ `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"`; \} | - |
|
|
576
|
+
| `grants` | readonly `object`[] | `grantsSchema` |
|
|
577
|
+
| `deadlineAt` | `number` | - |
|
|
578
|
+
| `ancestry` | readonly [`InstanceId`](index.md#instanceid)[] | - |
|
|
579
579
|
|
|
580
580
|
---
|
|
581
581
|
|
|
@@ -628,7 +628,7 @@ function admittedMethodCallerFacts(
|
|
|
628
628
|
method: string;
|
|
629
629
|
seal: string;
|
|
630
630
|
};
|
|
631
|
-
role?: "member" | "owner";
|
|
631
|
+
role?: "member" | "owner" | "admin";
|
|
632
632
|
soleMember?: true;
|
|
633
633
|
workflow?: {
|
|
634
634
|
workflowId: string;
|
|
@@ -686,35 +686,35 @@ Seal the host-verified named method after its current admission checks.
|
|
|
686
686
|
|
|
687
687
|
#### Parameters
|
|
688
688
|
|
|
689
|
-
| Parameter | Type
|
|
690
|
-
| ---------------------------------- |
|
|
691
|
-
| `host` | `Pick`\<[`OysterHost`](host.md#oysterhost), `"backgroundOriginKey"`\>
|
|
692
|
-
| `installation` | [`Installation`](apps.md#installation)
|
|
693
|
-
| `release` | [`VerifiedRelease`](host.md#verifiedrelease)
|
|
694
|
-
| `context` | \{ `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"`; `soleMember?`: `true`; `workflow?`: \{ `workflowId`: `string`; `runId`: `string`; `nodeId`: `string`; `armedBy`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; \}; `idempotencyKey?`: `string`; \} | `undefined` |
|
|
695
|
-
| `context.computerId` | `string` \| `null`
|
|
696
|
-
| `context.actor` | \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}
|
|
697
|
-
| `context.backgroundLane?` | `string`
|
|
698
|
-
| `context.backgroundOrigin?` | \{ `method`: `string`; `seal`: `string`; \}
|
|
699
|
-
| `context.backgroundOrigin.method?` | `string`
|
|
700
|
-
| `context.backgroundOrigin.seal?` | `string`
|
|
701
|
-
| `context.role?` | `"member"` \| `"owner"` | `undefined` |
|
|
702
|
-
| `context.soleMember?` | `true`
|
|
703
|
-
| `context.workflow?` | \{ `workflowId`: `string`; `runId`: `string`; `nodeId`: `string`; `armedBy`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; \}
|
|
704
|
-
| `context.workflow.workflowId?` | `string`
|
|
705
|
-
| `context.workflow.runId?` | `string`
|
|
706
|
-
| `context.workflow.nodeId?` | `string`
|
|
707
|
-
| `context.workflow.armedBy?` | \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}
|
|
708
|
-
| `context.idempotencyKey?` | `string`
|
|
709
|
-
| `grants?` | readonly `object`[]
|
|
710
|
-
| `method?` | \{ `name`: `string`; `effect`: `"read"` \| `"write"` \| `"external"`; \}
|
|
711
|
-
| `method.name?` | `string`
|
|
712
|
-
| `method.effect?` | `"read"` \| `"write"` \| `"external"`
|
|
713
|
-
| `ancestry?` | readonly [`InstanceId`](index.md#instanceid)[]
|
|
714
|
-
| `sessionId?` | `string`
|
|
715
|
-
| `agentPolicy?` | \{ `policyRevision`: `string`; `grantorMemberId`: `string`; \}
|
|
716
|
-
| `agentPolicy.policyRevision?` | `string`
|
|
717
|
-
| `agentPolicy.grantorMemberId?` | `string`
|
|
689
|
+
| Parameter | Type | Default value |
|
|
690
|
+
| ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- |
|
|
691
|
+
| `host` | `Pick`\<[`OysterHost`](host.md#oysterhost), `"backgroundOriginKey"`\> | `undefined` |
|
|
692
|
+
| `installation` | [`Installation`](apps.md#installation) | `undefined` |
|
|
693
|
+
| `release` | [`VerifiedRelease`](host.md#verifiedrelease) | `undefined` |
|
|
694
|
+
| `context` | \{ `computerId`: `string` \| `null`; `actor`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; `backgroundLane?`: `string`; `backgroundOrigin?`: \{ `method`: `string`; `seal`: `string`; \}; `role?`: `"member"` \| `"owner"` \| `"admin"`; `soleMember?`: `true`; `workflow?`: \{ `workflowId`: `string`; `runId`: `string`; `nodeId`: `string`; `armedBy`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; \}; `idempotencyKey?`: `string`; \} | `undefined` |
|
|
695
|
+
| `context.computerId` | `string` \| `null` | `undefined` |
|
|
696
|
+
| `context.actor` | \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \} | `undefined` |
|
|
697
|
+
| `context.backgroundLane?` | `string` | `undefined` |
|
|
698
|
+
| `context.backgroundOrigin?` | \{ `method`: `string`; `seal`: `string`; \} | `undefined` |
|
|
699
|
+
| `context.backgroundOrigin.method?` | `string` | `undefined` |
|
|
700
|
+
| `context.backgroundOrigin.seal?` | `string` | `undefined` |
|
|
701
|
+
| `context.role?` | `"member"` \| `"owner"` \| `"admin"` | `undefined` |
|
|
702
|
+
| `context.soleMember?` | `true` | `undefined` |
|
|
703
|
+
| `context.workflow?` | \{ `workflowId`: `string`; `runId`: `string`; `nodeId`: `string`; `armedBy`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; \} | `undefined` |
|
|
704
|
+
| `context.workflow.workflowId?` | `string` | `undefined` |
|
|
705
|
+
| `context.workflow.runId?` | `string` | `undefined` |
|
|
706
|
+
| `context.workflow.nodeId?` | `string` | `undefined` |
|
|
707
|
+
| `context.workflow.armedBy?` | \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \} | `undefined` |
|
|
708
|
+
| `context.idempotencyKey?` | `string` | `undefined` |
|
|
709
|
+
| `grants?` | readonly `object`[] | `undefined` |
|
|
710
|
+
| `method?` | \{ `name`: `string`; `effect`: `"read"` \| `"write"` \| `"external"`; \} | `undefined` |
|
|
711
|
+
| `method.name?` | `string` | `appApiMethodNameSchema` |
|
|
712
|
+
| `method.effect?` | `"read"` \| `"write"` \| `"external"` | `...` |
|
|
713
|
+
| `ancestry?` | readonly [`InstanceId`](index.md#instanceid)[] | `[]` |
|
|
714
|
+
| `sessionId?` | `string` | `undefined` |
|
|
715
|
+
| `agentPolicy?` | \{ `policyRevision`: `string`; `grantorMemberId`: `string`; \} | `undefined` |
|
|
716
|
+
| `agentPolicy.policyRevision?` | `string` | `appToolPolicySchema.fields.revision` |
|
|
717
|
+
| `agentPolicy.grantorMemberId?` | `string` | `appToolPolicySchema.fields.grantedBy` |
|
|
718
718
|
|
|
719
719
|
#### Returns
|
|
720
720
|
|
|
@@ -726,12 +726,12 @@ Seal the host-verified named method after its current admission checks.
|
|
|
726
726
|
`string` \| `null`; `actor`: \| \{ `kind`: `"member"`; `memberId`: `string`; \}
|
|
727
727
|
\| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`;
|
|
728
728
|
`keyId`: `string`; \}; `backgroundLane?`: `string`; `backgroundOrigin?`: \{
|
|
729
|
-
`method`: `string`; `seal`: `string`; \}; `role?`: `"member"` \| `"owner"
|
|
730
|
-
`soleMember?`: `true`; `workflow?`: \{ `workflowId`: `string`;
|
|
731
|
-
`string`; `nodeId`: `string`; `armedBy`: \| \{ `kind`: `"member"`;
|
|
732
|
-
`string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{
|
|
733
|
-
`"team-key"`; `keyId`: `string`; \}; \}; `idempotencyKey?`: `string`;
|
|
734
|
-
`sessionId?`: `string`; `agentPolicy?`: \{ `policyRevision`: `string`;
|
|
729
|
+
`method`: `string`; `seal`: `string`; \}; `role?`: `"member"` \| `"owner"` \|
|
|
730
|
+
`"admin"`; `soleMember?`: `true`; `workflow?`: \{ `workflowId`: `string`;
|
|
731
|
+
`runId`: `string`; `nodeId`: `string`; `armedBy`: \| \{ `kind`: `"member"`;
|
|
732
|
+
`memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{
|
|
733
|
+
`kind`: `"team-key"`; `keyId`: `string`; \}; \}; `idempotencyKey?`: `string`;
|
|
734
|
+
\}; `sessionId?`: `string`; `agentPolicy?`: \{ `policyRevision`: `string`;
|
|
735
735
|
`grantorMemberId`: `string`; \}; `method?`: \{ `name`: `string`; `effect`:
|
|
736
736
|
`"read"` \| `"write"` \| `"external"`; \}; `replay?`: \{ `lane`: `string`;
|
|
737
737
|
`epoch`: `number`; `admitted`: readonly `string`[]; \}; \} \| \{ `kind`:
|