@the-ai-company/cbio-node-runtime 1.58.0 → 1.60.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 +55 -24
- package/dist/clients/agent/client.d.ts +9 -1
- package/dist/clients/agent/client.js +41 -11
- package/dist/clients/agent/client.js.map +1 -1
- package/dist/clients/agent/contracts.d.ts +5 -2
- package/dist/clients/owner/client.d.ts +15 -11
- package/dist/clients/owner/client.js +83 -30
- package/dist/clients/owner/client.js.map +1 -1
- package/dist/clients/owner/contracts.d.ts +32 -22
- package/dist/clients/owner/index.d.ts +1 -1
- package/dist/runtime/index.d.ts +1 -1
- package/dist/vault-core/contracts.d.ts +204 -26
- package/dist/vault-core/contracts.js +6 -2
- package/dist/vault-core/contracts.js.map +1 -1
- package/dist/vault-core/core.d.ts +23 -4
- package/dist/vault-core/core.js +480 -121
- package/dist/vault-core/core.js.map +1 -1
- package/dist/vault-core/defaults.d.ts +9 -2
- package/dist/vault-core/defaults.js +41 -14
- package/dist/vault-core/defaults.js.map +1 -1
- package/dist/vault-core/index.d.ts +1 -1
- package/dist/vault-core/index.js.map +1 -1
- package/dist/vault-core/persistence.d.ts +12 -2
- package/dist/vault-core/persistence.js +43 -4
- package/dist/vault-core/persistence.js.map +1 -1
- package/dist/vault-core/ports.d.ts +7 -1
- package/dist/vault-core/tool-metadata.js +27 -10
- package/dist/vault-core/tool-metadata.js.map +1 -1
- package/dist/vault-ingress/defaults.d.ts +2 -0
- package/dist/vault-ingress/defaults.js +6 -0
- package/dist/vault-ingress/defaults.js.map +1 -1
- package/dist/vault-ingress/index.d.ts +54 -9
- package/dist/vault-ingress/index.js +160 -46
- package/dist/vault-ingress/index.js.map +1 -1
- package/dist/vault-ingress/remote-transport.d.ts +2 -0
- package/dist/vault-ingress/remote-transport.js +33 -4
- package/dist/vault-ingress/remote-transport.js.map +1 -1
- package/docs/ARCHITECTURE.md +1 -1
- package/docs/REFERENCE.md +43 -30
- package/docs/WORKS_WITH_CUSTOM_FETCH.md +2 -2
- package/docs/api/README.md +5 -5
- package/docs/api/classes/IdentityError.md +1 -1
- package/docs/api/classes/OwnerClientError.md +1 -1
- package/docs/api/classes/VaultCore.md +176 -16
- package/docs/api/classes/VaultCoreError.md +1 -1
- package/docs/api/enumerations/IdentityErrorCode.md +1 -1
- package/docs/api/enumerations/OwnerClientErrorCode.md +1 -1
- package/docs/api/functions/createAgentClient.md +1 -1
- package/docs/api/functions/createIdentity.md +1 -1
- package/docs/api/functions/createOwnerHttpFlowBoundary.md +1 -1
- package/docs/api/functions/createOwnerSession.md +1 -1
- package/docs/api/functions/createPersistentVaultCoreDependencies.md +1 -1
- package/docs/api/functions/createStandardAcquireBoundary.md +1 -1
- package/docs/api/functions/createStandardDispatchBoundary.md +1 -1
- package/docs/api/functions/createVault.md +1 -1
- package/docs/api/functions/createVaultClient.md +1 -1
- package/docs/api/functions/createVaultCore.md +1 -1
- package/docs/api/functions/createVaultCoreDependencies.md +1 -1
- package/docs/api/functions/createVaultService.md +1 -1
- package/docs/api/functions/createWorkspaceStorage.md +1 -1
- package/docs/api/functions/deriveIdentityId.md +1 -1
- package/docs/api/functions/deriveVaultWorkingKeyFromPassword.md +1 -1
- package/docs/api/functions/getDefaultWorkspaceDir.md +1 -1
- package/docs/api/functions/handleVaultAgentControlHttp.md +1 -1
- package/docs/api/functions/handleVaultHttpDispatch.md +1 -1
- package/docs/api/functions/initializeVaultCustody.md +1 -1
- package/docs/api/functions/listVaults.md +1 -1
- package/docs/api/functions/readVaultProfile.md +1 -1
- package/docs/api/functions/recoverVault.md +1 -1
- package/docs/api/functions/recoverVaultWorkingKey.md +1 -1
- package/docs/api/functions/restoreIdentity.md +1 -1
- package/docs/api/functions/updateVaultMetadata.md +1 -1
- package/docs/api/functions/wrapVaultCoreAsVaultService.md +1 -1
- package/docs/api/functions/writeVaultProfile.md +1 -1
- package/docs/api/interfaces/AgentClient.md +33 -1
- package/docs/api/interfaces/AgentDispatchIntent.md +1 -1
- package/docs/api/interfaces/AgentDispatchTransport.md +33 -1
- package/docs/api/interfaces/AgentIdentity.md +1 -1
- package/docs/api/interfaces/AgentSigner.md +1 -1
- package/docs/api/interfaces/AgentSubmitCapabilityRequestInput.md +9 -9
- package/docs/api/interfaces/CbioRuntime.md +1 -1
- package/docs/api/interfaces/CreateAgentClientOptions.md +1 -1
- package/docs/api/interfaces/CreateIdentityOptions.md +1 -1
- package/docs/api/interfaces/CreateOwnerSessionOptions.md +1 -1
- package/docs/api/interfaces/CreatePersistentVaultCoreDependenciesOptions.md +1 -1
- package/docs/api/interfaces/CreateVaultClientOptions.md +1 -1
- package/docs/api/interfaces/CreateVaultOptions.md +1 -1
- package/docs/api/interfaces/CreatedVault.md +1 -1
- package/docs/api/interfaces/DefaultPolicyEngineOptions.md +1 -1
- package/docs/api/interfaces/IStorageProvider.md +1 -1
- package/docs/api/interfaces/InitializeVaultCustodyOptions.md +1 -1
- package/docs/api/interfaces/InitializedVaultCustody.md +1 -1
- package/docs/api/interfaces/OwnerAgentProvisionResult.md +1 -1
- package/docs/api/interfaces/{OwnerStoreSecretInput.md → OwnerCreateSecretInput.md} +2 -2
- package/docs/api/interfaces/{VaultDeleteSecretInput.md → OwnerRemoveSecretInput.md} +2 -2
- package/docs/api/interfaces/OwnerSensitiveActionConfirmation.md +1 -1
- package/docs/api/interfaces/OwnerSensitiveActionContext.md +1 -1
- package/docs/api/interfaces/OwnerSession.md +1 -1
- package/docs/api/interfaces/{OwnerWriteSecretInput.md → OwnerUpdateSecretInput.md} +2 -2
- package/docs/api/interfaces/RecoverVaultOptions.md +1 -1
- package/docs/api/interfaces/RecoveredVault.md +1 -1
- package/docs/api/interfaces/RestoreIdentityOptions.md +1 -1
- package/docs/api/interfaces/Signer.md +1 -1
- package/docs/api/interfaces/VaultApproveCapabilityRequestInput.md +1 -1
- package/docs/api/interfaces/VaultApproveDispatchInput.md +1 -1
- package/docs/api/interfaces/VaultAuditQueryInput.md +1 -1
- package/docs/api/interfaces/VaultClient.md +112 -48
- package/docs/api/interfaces/VaultCoreDependenciesOptions.md +1 -1
- package/docs/api/interfaces/VaultCreateAgentInput.md +1 -1
- package/docs/api/interfaces/VaultExportSecretInput.md +1 -1
- package/docs/api/interfaces/VaultGrantCapabilityInput.md +9 -21
- package/docs/api/interfaces/VaultGrantCapabilityRequest.md +1 -1
- package/docs/api/interfaces/VaultIdentity.md +1 -1
- package/docs/api/interfaces/VaultImportAgentInput.md +1 -1
- package/docs/api/interfaces/VaultIssueSessionTokenInput.md +1 -1
- package/docs/api/interfaces/VaultListAgentsInput.md +1 -1
- package/docs/api/interfaces/VaultListCapabilitiesInput.md +1 -1
- package/docs/api/interfaces/VaultListSecretsInput.md +1 -1
- package/docs/api/interfaces/VaultMetadata.md +1 -1
- package/docs/api/interfaces/VaultObject.md +1 -1
- package/docs/api/interfaces/VaultProfile.md +1 -1
- package/docs/api/interfaces/VaultReadAgentPrivateKeyInput.md +1 -1
- package/docs/api/interfaces/VaultReadSecretPlaintextInput.md +1 -1
- package/docs/api/interfaces/VaultRegisterFlowInput.md +1 -1
- package/docs/api/interfaces/VaultRevokeCapabilityInput.md +1 -1
- package/docs/api/interfaces/VaultRevokeSessionTokenInput.md +1 -1
- package/docs/api/interfaces/VaultSigner.md +1 -1
- package/docs/api/interfaces/VaultSubmitCapabilityRequestInput.md +11 -17
- package/docs/api/interfaces/VaultUpdateAgentInput.md +1 -1
- package/docs/api/type-aliases/AgentCapabilityEnvelope.md +1 -1
- package/docs/api/type-aliases/AgentVisibleSecretRecord.md +1 -1
- package/docs/api/type-aliases/CbioRuntimeModule.md +1 -1
- package/docs/api/type-aliases/OwnerGrantCapabilityInput.md +1 -1
- package/docs/api/variables/DEFAULT_VAULT_KEY_CUSTODY_BLOB_KEY.md +1 -1
- package/docs/zh/README.md +27 -9
- package/examples/process-isolation.ts +6 -4
- package/package.json +1 -1
package/docs/REFERENCE.md
CHANGED
|
@@ -65,7 +65,8 @@ The `VaultClient` provides the administrative interface for the vault.
|
|
|
65
65
|
|
|
66
66
|
The following owner-side methods are part of the supported public surface and are intended to be called through an owner session or a short-lived owner client:
|
|
67
67
|
|
|
68
|
-
- `
|
|
68
|
+
- `ownerCreateSecret(...)`
|
|
69
|
+
- `ownerUpdateSecret(...)`
|
|
69
70
|
- `ownerReadSecretPlaintext(...)`
|
|
70
71
|
- `ownerExportSecret(...)`
|
|
71
72
|
- `ownerCreateAgent(...)`
|
|
@@ -80,9 +81,11 @@ The following owner-side methods are part of the supported public surface and ar
|
|
|
80
81
|
- `ownerRegisterFlow(...)`
|
|
81
82
|
- `ownerSubmitCapabilityRequest(...)`
|
|
82
83
|
- `ownerListCapabilityStates(...)`
|
|
83
|
-
- `
|
|
84
|
-
- `
|
|
85
|
-
- `
|
|
84
|
+
- `ownerApproveCapabilityWrite(...)`
|
|
85
|
+
- `ownerApproveCapabilityRead(...)`
|
|
86
|
+
- `ownerAllowOnce(...)`
|
|
87
|
+
- `ownerAllowAlways(...)`
|
|
88
|
+
- `ownerDeny(...)`
|
|
86
89
|
- `ownerOnCapabilityState(...)`
|
|
87
90
|
- `ownerIssueSessionToken(...)`
|
|
88
91
|
- `ownerIssueAllSessionTokens()`
|
|
@@ -90,18 +93,21 @@ The following owner-side methods are part of the supported public surface and ar
|
|
|
90
93
|
- `ownerReadAudit(...)`
|
|
91
94
|
|
|
92
95
|
### Core Operations
|
|
93
|
-
- `
|
|
96
|
+
- `ownerCreateSecret(...)`: Insert a new active secret. The call fails if the alias already has an active record.
|
|
97
|
+
- `ownerUpdateSecret(...)`: Insert a new successor version for the active alias and mark the previous version as superseded.
|
|
94
98
|
- `ownerCreateAgent(...)`: Generate and host a new agent identity, then return its public record plus a session token.
|
|
95
99
|
- `ownerImportAgent(...)`: Import an existing private key into vault custody, then return its public record plus a session token.
|
|
96
100
|
- `ownerUpdateAgent(...)`: Update an agent's stored nickname and metadata.
|
|
97
101
|
- `ownerListAgents()`: Enumerate authorized agents. Private keys are redacted from the default list response.
|
|
98
102
|
- `ownerGrantCapability(...)`: Assign specific secret-use permissions to an agent. Capability IDs are generated internally.
|
|
99
|
-
- `ownerSubmitCapabilityRequest(...)`: Create a
|
|
100
|
-
- `ownerListCapabilityStates(...)`: Read
|
|
101
|
-
- `
|
|
102
|
-
- `
|
|
103
|
-
- `
|
|
104
|
-
- `
|
|
103
|
+
- `ownerSubmitCapabilityRequest(...)`: Create a capability carrier for later owner review.
|
|
104
|
+
- `ownerListCapabilityStates(...)`: Read capability carriers, optionally filtered by `agentId`, `writeStatus`, or `readStatus`.
|
|
105
|
+
- `ownerApproveCapabilityWrite({ requestId })`: Approve the outbound write action on a pending capability carrier.
|
|
106
|
+
- `ownerApproveCapabilityRead({ requestId })`: Approve the inbound read action separately on the same carrier after write approval.
|
|
107
|
+
- `ownerAllowOnce({ requestId })`: Execute a write-approved pending request once, then delete the carrier. This is only valid for dispatch-discovery carriers with a concrete blocked request.
|
|
108
|
+
- `ownerAllowAlways({ requestId })`: Persist the carrier as an active capability. For dispatch discovery this also executes the blocked request; for explicit requests it grants the capability without sending network traffic. Capability IDs are generated internally.
|
|
109
|
+
- `ownerDeny(requestId)`: Reject the currently pending action on the carrier.
|
|
110
|
+
- `ownerOnCapabilityState(callback)`: Register a real-time observer for capability-carrier changes.
|
|
105
111
|
- `ownerIssueSessionToken(input)`: Issue a session token for a specific agent.
|
|
106
112
|
- `ownerIssueAllSessionTokens()`: Batch-issue session tokens for ALL registered agents (Automatic during `createVaultClient` warmup).
|
|
107
113
|
- `ownerRevokeSessionToken({ token })`: Invalidate a specific session token.
|
|
@@ -117,9 +123,9 @@ The following owner operations are sensitive actions:
|
|
|
117
123
|
- `ownerReadSecretPlaintext(...)`
|
|
118
124
|
- `ownerExportSecret(...)`
|
|
119
125
|
- `ownerReadAgentPrivateKey(...)`
|
|
120
|
-
- `
|
|
126
|
+
- `ownerRemoveSecret(...)`
|
|
121
127
|
|
|
122
|
-
All
|
|
128
|
+
All four require:
|
|
123
129
|
|
|
124
130
|
- `password`
|
|
125
131
|
- optional `verificationCode`
|
|
@@ -154,36 +160,42 @@ The `AgentClient` is used by delegated processes (e.g., LLMs or background worke
|
|
|
154
160
|
### Core Operations
|
|
155
161
|
- `agentDispatch(...)`: Use a granted capability to send a secret to an authorized target.
|
|
156
162
|
- **Status**: Returns `SUCCEEDED`, `FAILED`, or `PENDING`.
|
|
163
|
+
- **Execution Semantics**: This is the method that attempts the real task immediately.
|
|
164
|
+
- **Result Delivery**: The full result is stored in a sealed request record; use `agentListRequests()` and `agentGetRequest(...)` to inspect it later.
|
|
157
165
|
- **Discovery Flow**: If an agent attempts an action not explicitly in its white-list, the request is automatically stalled as `PENDING` for owner review.
|
|
158
|
-
- `agentListCapabilities()`: Read the agent's
|
|
159
|
-
- Includes both `GRANTED` and `PENDING` entries.
|
|
160
|
-
- Pending rows cover both proactive requests and dispatch-discovery requests.
|
|
166
|
+
- `agentListCapabilities()`: Read the agent's capability carriers, including current `write` and `read` action states.
|
|
161
167
|
- `agentListSecrets()`: Read all secret metadata in the vault, with per-secret authorization markers showing which entries the agent can currently use.
|
|
162
|
-
- `
|
|
163
|
-
- `
|
|
168
|
+
- `agentListRequests()`: Read the agent's request history with partially redacted metadata.
|
|
169
|
+
- `agentGetRequest(...)`: Read one request record and receive the result body only if the corresponding read action has been approved.
|
|
170
|
+
- `ownerListRequests()`: Read request history as owner, including approval states.
|
|
171
|
+
- `ownerGetRequest(...)`: Read the full sealed request record as owner, including response content before read release.
|
|
172
|
+
- `agentIntrospect()`: Read the vault-known self context (`agentId`, `identityId`, `nickname`, `metadata`) plus capability carriers and the tool manifest.
|
|
173
|
+
- `agentSubmitCapabilityRequest(...)`: Ask the owner for a broader `scope + methods` grant without executing any request.
|
|
164
174
|
- **Security**: The agent never handles the vault's master password. Agent execution uses **Session Tokens** rather than raw private-key dispatch.
|
|
165
175
|
- **Auditing**: Dispatches are audited by default. Set `skipAudit: true` in the capability (or during approval) to disable logging for specific actions.
|
|
166
176
|
|
|
167
|
-
## Capability
|
|
177
|
+
## Capability Action Approval
|
|
168
178
|
|
|
169
|
-
The runtime uses
|
|
179
|
+
The runtime uses capability carriers with two independently approved actions:
|
|
170
180
|
|
|
171
|
-
- **Dispatch discovery**: A concrete dispatch misses existing capability coverage and creates a `PENDING
|
|
172
|
-
- **Capability request**: An external planner or controller creates a broader
|
|
181
|
+
- **Dispatch discovery**: A concrete dispatch misses existing capability coverage and creates a carrier with `write.status = PENDING`.
|
|
182
|
+
- **Capability request**: An external planner or controller creates a broader carrier before any dispatch is attempted.
|
|
173
183
|
|
|
174
184
|
This is useful for LLM-driven planners that can infer the needed scope ahead of time, for example:
|
|
175
185
|
- scope `https://api.example.com/users/*`
|
|
176
186
|
- methods `["GET"]`
|
|
177
187
|
|
|
178
|
-
The
|
|
179
|
-
- `ownerSubmitCapabilityRequest(...)` creates the
|
|
180
|
-
- `ownerListCapabilityStates({
|
|
181
|
-
- `
|
|
182
|
-
- `
|
|
183
|
-
- `
|
|
188
|
+
The carrier remains actionable until the owner approves or rejects its pending actions:
|
|
189
|
+
- `ownerSubmitCapabilityRequest(...)` creates the carrier.
|
|
190
|
+
- `ownerListCapabilityStates({ writeStatus: "PENDING" })` reads the current queue.
|
|
191
|
+
- `ownerApproveCapabilityWrite(...)` approves the outbound write action first.
|
|
192
|
+
- `ownerAllowOnce(...)` executes a write-approved discovery request once and removes the pending carrier.
|
|
193
|
+
- `ownerAllowAlways(...)` persists a real capability carrier and also executes the blocked request when the carrier came from dispatch discovery.
|
|
194
|
+
- `ownerApproveCapabilityRead(...)` can be applied later on the same carrier to release response visibility.
|
|
195
|
+
- `ownerDeny(...)` marks the currently pending action rejected.
|
|
184
196
|
- `ownerOnCapabilityState(...)` supports push-style owner interfaces.
|
|
185
197
|
|
|
186
|
-
The proactive request flow does not replace dispatch discovery. Both flows now produce the same
|
|
198
|
+
The proactive request flow does not replace dispatch discovery. Both flows now produce the same carrier shape with independent write/read action states.
|
|
187
199
|
|
|
188
200
|
## Storage Layout
|
|
189
201
|
|
|
@@ -192,7 +204,8 @@ The vault uses a unified encrypted partition:
|
|
|
192
204
|
- `vaults/<vaultId>_v1/secrets.sealed`: Secret registry.
|
|
193
205
|
- `vaults/<vaultId>_v1/agents.sealed`: Agent identity registry.
|
|
194
206
|
- `vaults/<vaultId>_v1/capabilities.sealed`: Capability registry.
|
|
195
|
-
- `vaults/<vaultId>_v1/
|
|
207
|
+
- `vaults/<vaultId>_v1/requests.sealed`: Sealed request-record registry.
|
|
208
|
+
- `vaults/<vaultId>_v1/custom-flows.sealed`: Owner-defined HTTP request template registry.
|
|
196
209
|
- `vaults/<vaultId>_v1/audit.jsonl`: Tamper-evident audit log.
|
|
197
210
|
- `vaults/<vaultId>_v1/working-key.sealed`: Sealed working-key custody blob.
|
|
198
211
|
- `vaults/<vaultId>_v1/secret-<secretId>.sealed`: Encrypted secret material.
|
|
@@ -9,9 +9,9 @@ In the current first version:
|
|
|
9
9
|
- `send_secret` dispatch may return response bodies to the agent
|
|
10
10
|
- `acquire_secret` does not return raw response values; it returns protocol metadata plus a redacted response shape
|
|
11
11
|
- `acquire_secret` currently supports only built-in standard extraction flows, not caller-defined extractors
|
|
12
|
-
- owner-defined HTTP
|
|
12
|
+
- owner-defined HTTP request templates are created through `createOwnerHttpFlowBoundary(...)`
|
|
13
13
|
- `createStandardAcquireBoundary(...)` and `createStandardDispatchBoundary(...)` derive the two built-in default boundaries
|
|
14
|
-
- `custom_http` exists as an owner-defined
|
|
14
|
+
- `custom_http` exists as an owner-defined request-template path with fixed mode/target/method/response visibility
|
|
15
15
|
|
|
16
16
|
That split is intentional:
|
|
17
17
|
|
package/docs/api/README.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
**CBIO Node Runtime Agent API v1.
|
|
1
|
+
**CBIO Node Runtime Agent API v1.60.0**
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
|
-
# CBIO Node Runtime Agent API v1.
|
|
5
|
+
# CBIO Node Runtime Agent API v1.60.0
|
|
6
6
|
|
|
7
7
|
## Enumerations
|
|
8
8
|
|
|
@@ -37,11 +37,12 @@
|
|
|
37
37
|
- [InitializeVaultCustodyOptions](interfaces/InitializeVaultCustodyOptions.md)
|
|
38
38
|
- [IStorageProvider](interfaces/IStorageProvider.md)
|
|
39
39
|
- [OwnerAgentProvisionResult](interfaces/OwnerAgentProvisionResult.md)
|
|
40
|
+
- [OwnerCreateSecretInput](interfaces/OwnerCreateSecretInput.md)
|
|
41
|
+
- [OwnerRemoveSecretInput](interfaces/OwnerRemoveSecretInput.md)
|
|
40
42
|
- [OwnerSensitiveActionConfirmation](interfaces/OwnerSensitiveActionConfirmation.md)
|
|
41
43
|
- [OwnerSensitiveActionContext](interfaces/OwnerSensitiveActionContext.md)
|
|
42
44
|
- [OwnerSession](interfaces/OwnerSession.md)
|
|
43
|
-
- [
|
|
44
|
-
- [OwnerWriteSecretInput](interfaces/OwnerWriteSecretInput.md)
|
|
45
|
+
- [OwnerUpdateSecretInput](interfaces/OwnerUpdateSecretInput.md)
|
|
45
46
|
- [RecoveredVault](interfaces/RecoveredVault.md)
|
|
46
47
|
- [RecoverVaultOptions](interfaces/RecoverVaultOptions.md)
|
|
47
48
|
- [RestoreIdentityOptions](interfaces/RestoreIdentityOptions.md)
|
|
@@ -52,7 +53,6 @@
|
|
|
52
53
|
- [VaultClient](interfaces/VaultClient.md)
|
|
53
54
|
- [VaultCoreDependenciesOptions](interfaces/VaultCoreDependenciesOptions.md)
|
|
54
55
|
- [VaultCreateAgentInput](interfaces/VaultCreateAgentInput.md)
|
|
55
|
-
- [VaultDeleteSecretInput](interfaces/VaultDeleteSecretInput.md)
|
|
56
56
|
- [VaultExportSecretInput](interfaces/VaultExportSecretInput.md)
|
|
57
57
|
- [VaultGrantCapabilityInput](interfaces/VaultGrantCapabilityInput.md)
|
|
58
58
|
- [VaultGrantCapabilityRequest](interfaces/VaultGrantCapabilityRequest.md)
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**CBIO Node Runtime Agent API v1.
|
|
1
|
+
[**CBIO Node Runtime Agent API v1.60.0**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -117,6 +117,22 @@ This is the primary implementation of the Vault logic.
|
|
|
117
117
|
|
|
118
118
|
***
|
|
119
119
|
|
|
120
|
+
### agentGetRequest()
|
|
121
|
+
|
|
122
|
+
> **agentGetRequest**(`request`): `Promise`\<`AgentRequestResult`\>
|
|
123
|
+
|
|
124
|
+
#### Parameters
|
|
125
|
+
|
|
126
|
+
##### request
|
|
127
|
+
|
|
128
|
+
`AgentGetRequestRequest`
|
|
129
|
+
|
|
130
|
+
#### Returns
|
|
131
|
+
|
|
132
|
+
`Promise`\<`AgentRequestResult`\>
|
|
133
|
+
|
|
134
|
+
***
|
|
135
|
+
|
|
120
136
|
### agentGetRuntimeManifest()
|
|
121
137
|
|
|
122
138
|
> **agentGetRuntimeManifest**(`command`): `Promise`\<`AgentRuntimeManifest`\>
|
|
@@ -149,6 +165,22 @@ This is the primary implementation of the Vault logic.
|
|
|
149
165
|
|
|
150
166
|
***
|
|
151
167
|
|
|
168
|
+
### agentListRequests()
|
|
169
|
+
|
|
170
|
+
> **agentListRequests**(`request`): `Promise`\<readonly `AgentVisibleRequestRecord`[]\>
|
|
171
|
+
|
|
172
|
+
#### Parameters
|
|
173
|
+
|
|
174
|
+
##### request
|
|
175
|
+
|
|
176
|
+
`AgentListRequestsRequest`
|
|
177
|
+
|
|
178
|
+
#### Returns
|
|
179
|
+
|
|
180
|
+
`Promise`\<readonly `AgentVisibleRequestRecord`[]\>
|
|
181
|
+
|
|
182
|
+
***
|
|
183
|
+
|
|
152
184
|
### agentListSecrets()
|
|
153
185
|
|
|
154
186
|
> **agentListSecrets**(`request`): `Promise`\<readonly `AgentVisibleSecretRecord`[]\>
|
|
@@ -181,31 +213,31 @@ This is the primary implementation of the Vault logic.
|
|
|
181
213
|
|
|
182
214
|
***
|
|
183
215
|
|
|
184
|
-
###
|
|
216
|
+
### ownerAllowAlways()
|
|
185
217
|
|
|
186
|
-
> **
|
|
218
|
+
> **ownerAllowAlways**(`command`): `Promise`\<`DispatchResult`\>
|
|
187
219
|
|
|
188
220
|
#### Parameters
|
|
189
221
|
|
|
190
222
|
##### command
|
|
191
223
|
|
|
192
|
-
`
|
|
224
|
+
`OwnerAllowAlwaysCommand`
|
|
193
225
|
|
|
194
226
|
#### Returns
|
|
195
227
|
|
|
196
|
-
`Promise`\<`
|
|
228
|
+
`Promise`\<`DispatchResult`\>
|
|
197
229
|
|
|
198
230
|
***
|
|
199
231
|
|
|
200
|
-
###
|
|
232
|
+
### ownerAllowOnce()
|
|
201
233
|
|
|
202
|
-
> **
|
|
234
|
+
> **ownerAllowOnce**(`command`): `Promise`\<`DispatchResult`\>
|
|
203
235
|
|
|
204
236
|
#### Parameters
|
|
205
237
|
|
|
206
238
|
##### command
|
|
207
239
|
|
|
208
|
-
`
|
|
240
|
+
`OwnerAllowOnceCommand`
|
|
209
241
|
|
|
210
242
|
#### Returns
|
|
211
243
|
|
|
@@ -213,19 +245,83 @@ This is the primary implementation of the Vault logic.
|
|
|
213
245
|
|
|
214
246
|
***
|
|
215
247
|
|
|
216
|
-
###
|
|
248
|
+
### ownerApproveCapabilityRead()
|
|
217
249
|
|
|
218
|
-
> **
|
|
250
|
+
> **ownerApproveCapabilityRead**(`command`): `Promise`\<`CapabilityStateRecord`\>
|
|
219
251
|
|
|
220
252
|
#### Parameters
|
|
221
253
|
|
|
222
254
|
##### command
|
|
223
255
|
|
|
224
|
-
`
|
|
256
|
+
`OwnerApproveCapabilityReadCommand`
|
|
225
257
|
|
|
226
258
|
#### Returns
|
|
227
259
|
|
|
228
|
-
`Promise`\<`
|
|
260
|
+
`Promise`\<`CapabilityStateRecord`\>
|
|
261
|
+
|
|
262
|
+
***
|
|
263
|
+
|
|
264
|
+
### ownerApproveCapabilityWrite()
|
|
265
|
+
|
|
266
|
+
> **ownerApproveCapabilityWrite**(`command`): `Promise`\<`CapabilityStateRecord`\>
|
|
267
|
+
|
|
268
|
+
#### Parameters
|
|
269
|
+
|
|
270
|
+
##### command
|
|
271
|
+
|
|
272
|
+
`OwnerApproveCapabilityWriteCommand`
|
|
273
|
+
|
|
274
|
+
#### Returns
|
|
275
|
+
|
|
276
|
+
`Promise`\<`CapabilityStateRecord`\>
|
|
277
|
+
|
|
278
|
+
***
|
|
279
|
+
|
|
280
|
+
### ownerCreateSecret()
|
|
281
|
+
|
|
282
|
+
> **ownerCreateSecret**(`command`): `Promise`\<`SecretRecord`\>
|
|
283
|
+
|
|
284
|
+
#### Parameters
|
|
285
|
+
|
|
286
|
+
##### command
|
|
287
|
+
|
|
288
|
+
`OwnerCreateSecretCommand`
|
|
289
|
+
|
|
290
|
+
#### Returns
|
|
291
|
+
|
|
292
|
+
`Promise`\<`SecretRecord`\>
|
|
293
|
+
|
|
294
|
+
***
|
|
295
|
+
|
|
296
|
+
### ownerDeleteSecret()
|
|
297
|
+
|
|
298
|
+
> **ownerDeleteSecret**(`command`): `Promise`\<`void`\>
|
|
299
|
+
|
|
300
|
+
#### Parameters
|
|
301
|
+
|
|
302
|
+
##### command
|
|
303
|
+
|
|
304
|
+
`OwnerDeleteSecretCommand`
|
|
305
|
+
|
|
306
|
+
#### Returns
|
|
307
|
+
|
|
308
|
+
`Promise`\<`void`\>
|
|
309
|
+
|
|
310
|
+
***
|
|
311
|
+
|
|
312
|
+
### ownerDeny()
|
|
313
|
+
|
|
314
|
+
> **ownerDeny**(`command`): `Promise`\<`CapabilityStateRecord`\>
|
|
315
|
+
|
|
316
|
+
#### Parameters
|
|
317
|
+
|
|
318
|
+
##### command
|
|
319
|
+
|
|
320
|
+
`OwnerDenyCommand`
|
|
321
|
+
|
|
322
|
+
#### Returns
|
|
323
|
+
|
|
324
|
+
`Promise`\<`CapabilityStateRecord`\>
|
|
229
325
|
|
|
230
326
|
***
|
|
231
327
|
|
|
@@ -253,6 +349,30 @@ This is the primary implementation of the Vault logic.
|
|
|
253
349
|
|
|
254
350
|
***
|
|
255
351
|
|
|
352
|
+
### ownerGetRequest()
|
|
353
|
+
|
|
354
|
+
> **ownerGetRequest**(`actor`, `targetRequestId`, `request?`): `Promise`\<`OwnerRequestRecord`\>
|
|
355
|
+
|
|
356
|
+
#### Parameters
|
|
357
|
+
|
|
358
|
+
##### actor
|
|
359
|
+
|
|
360
|
+
`VaultPrincipal` & `object`
|
|
361
|
+
|
|
362
|
+
##### targetRequestId
|
|
363
|
+
|
|
364
|
+
`string`
|
|
365
|
+
|
|
366
|
+
##### request?
|
|
367
|
+
|
|
368
|
+
`Omit`\<`OwnerGetRequestRequest`, `"vaultId"` \| `"actor"` \| `"targetRequestId"`\>
|
|
369
|
+
|
|
370
|
+
#### Returns
|
|
371
|
+
|
|
372
|
+
`Promise`\<`OwnerRequestRecord`\>
|
|
373
|
+
|
|
374
|
+
***
|
|
375
|
+
|
|
256
376
|
### ownerIssueAllAgentSessionTokens()
|
|
257
377
|
|
|
258
378
|
> **ownerIssueAllAgentSessionTokens**(`actor`): `Promise`\<`OwnerSessionToken`[]\>
|
|
@@ -345,6 +465,30 @@ This is the primary implementation of the Vault logic.
|
|
|
345
465
|
|
|
346
466
|
***
|
|
347
467
|
|
|
468
|
+
### ownerListRequests()
|
|
469
|
+
|
|
470
|
+
> **ownerListRequests**(`actor`, `agentId?`, `request?`): `Promise`\<readonly `OwnerVisibleRequestRecord`[]\>
|
|
471
|
+
|
|
472
|
+
#### Parameters
|
|
473
|
+
|
|
474
|
+
##### actor
|
|
475
|
+
|
|
476
|
+
`VaultPrincipal` & `object`
|
|
477
|
+
|
|
478
|
+
##### agentId?
|
|
479
|
+
|
|
480
|
+
`string`
|
|
481
|
+
|
|
482
|
+
##### request?
|
|
483
|
+
|
|
484
|
+
`Omit`\<`OwnerListRequestsRequest`, `"agentId"` \| `"vaultId"` \| `"actor"`\>
|
|
485
|
+
|
|
486
|
+
#### Returns
|
|
487
|
+
|
|
488
|
+
`Promise`\<readonly `OwnerVisibleRequestRecord`[]\>
|
|
489
|
+
|
|
490
|
+
***
|
|
491
|
+
|
|
348
492
|
### ownerListSecrets()
|
|
349
493
|
|
|
350
494
|
> **ownerListSecrets**(`actor`, `request?`): `Promise`\<readonly `AgentVisibleSecretRecord`[]\>
|
|
@@ -455,19 +599,19 @@ This is the primary implementation of the Vault logic.
|
|
|
455
599
|
|
|
456
600
|
***
|
|
457
601
|
|
|
458
|
-
###
|
|
602
|
+
### ownerRemoveSecret()
|
|
459
603
|
|
|
460
|
-
> **
|
|
604
|
+
> **ownerRemoveSecret**(`command`): `Promise`\<`void`\>
|
|
461
605
|
|
|
462
606
|
#### Parameters
|
|
463
607
|
|
|
464
608
|
##### command
|
|
465
609
|
|
|
466
|
-
`
|
|
610
|
+
`OwnerDeleteSecretCommand`
|
|
467
611
|
|
|
468
612
|
#### Returns
|
|
469
613
|
|
|
470
|
-
`Promise`\<`
|
|
614
|
+
`Promise`\<`void`\>
|
|
471
615
|
|
|
472
616
|
***
|
|
473
617
|
|
|
@@ -545,6 +689,22 @@ This is the primary implementation of the Vault logic.
|
|
|
545
689
|
|
|
546
690
|
***
|
|
547
691
|
|
|
692
|
+
### ownerUpdateSecret()
|
|
693
|
+
|
|
694
|
+
> **ownerUpdateSecret**(`command`): `Promise`\<`SecretRecord`\>
|
|
695
|
+
|
|
696
|
+
#### Parameters
|
|
697
|
+
|
|
698
|
+
##### command
|
|
699
|
+
|
|
700
|
+
`OwnerUpdateSecretCommand`
|
|
701
|
+
|
|
702
|
+
#### Returns
|
|
703
|
+
|
|
704
|
+
`Promise`\<`SecretRecord`\>
|
|
705
|
+
|
|
706
|
+
***
|
|
707
|
+
|
|
548
708
|
### ownerWriteSecret()
|
|
549
709
|
|
|
550
710
|
> **ownerWriteSecret**(`command`): `Promise`\<`SecretRecord`\>
|