@the-ai-company/cbio-node-runtime 1.43.0 → 1.45.5

package/docs/api/interfaces/VaultClient.md

@@ -0,0 +1,234 @@
+[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
+
+***
+
+# Interface: VaultClient
+
+A client for vault owners to manage secrets, agents, and capabilities.
+This client requires an owner signature for every operation.
+
+## Methods
+
+### defineSecretTargets()
+
+> **defineSecretTargets**(`input`): `Promise`\<[`SecretRecord`](SecretRecord.md)\>
+
+Refines the allowed targets for an existing secret.
+
+#### Parameters
+
+##### input
+
+[`OwnerDefineSecretTargetsInput`](OwnerDefineSecretTargetsInput.md)
+
+#### Returns
+
+`Promise`\<[`SecretRecord`](SecretRecord.md)\>
+
+***
+
+### deleteSecret()
+
+> **deleteSecret**(`input`): `Promise`\<`void`\>
+
+Permanently deletes a secret from the vault.
+
+#### Parameters
+
+##### input
+
+[`VaultDeleteSecretInput`](VaultDeleteSecretInput.md)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### exportSecret()
+
+> **exportSecret**(`input`): `Promise`\<[`OwnerSecretExport`](OwnerSecretExport.md)\>
+
+Exports a secret's plaintext (requires owner permission).
+
+#### Parameters
+
+##### input
+
+[`VaultExportSecretInput`](VaultExportSecretInput.md)
+
+#### Returns
+
+`Promise`\<[`OwnerSecretExport`](OwnerSecretExport.md)\>
+
+***
+
+### grantCapability()
+
+> **grantCapability**(`input`): `Promise`\<`void`\>
+
+Grants a specific capability to an agent.
+
+#### Parameters
+
+##### input
+
+[`VaultGrantCapabilityInput`](VaultGrantCapabilityInput.md)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### listAgents()
+
+> **listAgents**(`input?`): `Promise`\<readonly [`AgentIdentityRecord`](AgentIdentityRecord.md)[]\>
+
+Lists all agents registered in the vault.
+
+#### Parameters
+
+##### input?
+
+[`VaultListAgentsInput`](VaultListAgentsInput.md)
+
+#### Returns
+
+`Promise`\<readonly [`AgentIdentityRecord`](AgentIdentityRecord.md)[]\>
+
+***
+
+### listCapabilities()
+
+> **listCapabilities**(`input?`): `Promise`\<readonly [`AgentCapability`](AgentCapability.md)[]\>
+
+Lists all active capabilities granted to agents.
+
+#### Parameters
+
+##### input?
+
+[`VaultListCapabilitiesInput`](VaultListCapabilitiesInput.md)
+
+#### Returns
+
+`Promise`\<readonly [`AgentCapability`](AgentCapability.md)[]\>
+
+***
+
+### readAudit()
+
+> **readAudit**(`query?`): `Promise`\<readonly [`AuditEntry`](AuditEntry.md)[]\>
+
+Reads the tamper-evident audit log for the vault.
+
+#### Parameters
+
+##### query?
+
+[`VaultAuditQueryInput`](VaultAuditQueryInput.md)
+
+#### Returns
+
+`Promise`\<readonly [`AuditEntry`](AuditEntry.md)[]\>
+
+***
+
+### registerAgent()
+
+> **registerAgent**(`input`): `Promise`\<`void`\>
+
+Registers a new agent identity within the vault.
+
+#### Parameters
+
+##### input
+
+[`VaultRegisterAgentInput`](VaultRegisterAgentInput.md)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### registerFlow()
+
+> **registerFlow**(`input`): `Promise`\<`void`\>
+
+Registers a custom HTTP flow for complex secret usage.
+
+#### Parameters
+
+##### input
+
+[`VaultRegisterFlowInput`](VaultRegisterFlowInput.md)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### revokeCapability()
+
+> **revokeCapability**(`input`): `Promise`\<`void`\>
+
+Revokes a previously granted capability.
+
+#### Parameters
+
+##### input
+
+[`VaultRevokeCapabilityInput`](VaultRevokeCapabilityInput.md)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### storeSecret()
+
+> **storeSecret**(`input`): `Promise`\<[`SecretRecord`](SecretRecord.md)\>
+
+Securely stores a new secret in the vault.
+
+#### Parameters
+
+##### input
+
+[`OwnerStoreSecretInput`](OwnerStoreSecretInput.md)
+
+The secret alias and plaintext.
+
+#### Returns
+
+`Promise`\<[`SecretRecord`](SecretRecord.md)\>
+
+The record of the stored secret.
+
+#### Example
+
+```ts
+await client.storeSecret({ alias: 'db-pass', plaintext: 's3cret' });
+```
+
+***
+
+### writeSecret()
+
+> **writeSecret**(`input`): `Promise`\<[`SecretRecord`](SecretRecord.md)\>
+
+Atomic operation to store a secret and define its targets in one step.
+
+#### Parameters
+
+##### input
+
+[`OwnerWriteSecretInput`](OwnerWriteSecretInput.md)
+
+#### Returns
+
+`Promise`\<[`SecretRecord`](SecretRecord.md)\>

package/docs/api/interfaces/VaultCore.md

@@ -0,0 +1,311 @@
+[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
+
+***
+
+# Interface: VaultCore
+
+## Properties
+
+### vaultId
+
+> `readonly` **vaultId**: [`VaultId`](VaultId.md)
+
+## Methods
+
+### authorizeDispatch()
+
+> **authorizeDispatch**(`request`): `Promise`\<[`DispatchAuthorization`](DispatchAuthorization.md)\>
+
+#### Parameters
+
+##### request
+
+[`DispatchRequest`](DispatchRequest.md)
+
+#### Returns
+
+`Promise`\<[`DispatchAuthorization`](DispatchAuthorization.md)\>
+
+***
+
+### bootstrapOwnerIdentity()
+
+> **bootstrapOwnerIdentity**(`identity`): `Promise`\<`void`\>
+
+#### Parameters
+
+##### identity
+
+[`OwnerIdentityRecord`](OwnerIdentityRecord.md)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### defineSecretTargets()
+
+> **defineSecretTargets**(`command`): `Promise`\<[`SecretRecord`](SecretRecord.md)\>
+
+#### Parameters
+
+##### command
+
+[`OwnerDefineSecretTargetsCommand`](OwnerDefineSecretTargetsCommand.md)
+
+#### Returns
+
+`Promise`\<[`SecretRecord`](SecretRecord.md)\>
+
+***
+
+### deleteSecret()
+
+> **deleteSecret**(`command`): `Promise`\<`void`\>
+
+#### Parameters
+
+##### command
+
+[`OwnerDeleteSecretCommand`](OwnerDeleteSecretCommand.md)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### dispatchSecret()
+
+> **dispatchSecret**(`request`): `Promise`\<[`DispatchResult`](DispatchResult.md)\>
+
+#### Parameters
+
+##### request
+
+[`DispatchRequest`](DispatchRequest.md)
+
+#### Returns
+
+`Promise`\<[`DispatchResult`](DispatchResult.md)\>
+
+***
+
+### exportSecret()
+
+> **exportSecret**(`actor`, `alias`, `request?`): `Promise`\<[`OwnerSecretExport`](OwnerSecretExport.md)\>
+
+#### Parameters
+
+##### actor
+
+[`VaultPrincipal`](VaultPrincipal.md) & `object`
+
+##### alias
+
+`string`
+
+##### request?
+
+`Omit`\<[`OwnerExportSecretRequest`](OwnerExportSecretRequest.md), `"actor"` \| `"vaultId"` \| `"alias"`\>
+
+#### Returns
+
+`Promise`\<[`OwnerSecretExport`](OwnerSecretExport.md)\>
+
+***
+
+### getAudit()
+
+> **getAudit**(`actor`, `query`, `request?`): `Promise`\<readonly [`AuditEntry`](AuditEntry.md)[]\>
+
+#### Parameters
+
+##### actor
+
+[`VaultPrincipal`](VaultPrincipal.md) & `object`
+
+##### query
+
+[`AuditQuery`](AuditQuery.md)
+
+##### request?
+
+`Omit`\<[`OwnerAuditRequest`](OwnerAuditRequest.md), `"actor"` \| `"query"` \| `"vaultId"`\>
+
+#### Returns
+
+`Promise`\<readonly [`AuditEntry`](AuditEntry.md)[]\>
+
+***
+
+### getCapability()
+
+> **getCapability**(`vaultId`, `agentId`, `capabilityId`): `Promise`\<[`AgentCapability`](AgentCapability.md) \| `null`\>
+
+#### Parameters
+
+##### vaultId
+
+[`VaultId`](VaultId.md)
+
+##### agentId
+
+`string`
+
+##### capabilityId
+
+`string`
+
+#### Returns
+
+`Promise`\<[`AgentCapability`](AgentCapability.md) \| `null`\>
+
+***
+
+### listAgents()
+
+> **listAgents**(`actor`, `request?`): `Promise`\<readonly [`AgentIdentityRecord`](AgentIdentityRecord.md)[]\>
+
+#### Parameters
+
+##### actor
+
+[`VaultPrincipal`](VaultPrincipal.md) & `object`
+
+##### request?
+
+`Omit`\<[`OwnerListAgentsRequest`](OwnerListAgentsRequest.md), `"actor"` \| `"vaultId"`\>
+
+#### Returns
+
+`Promise`\<readonly [`AgentIdentityRecord`](AgentIdentityRecord.md)[]\>
+
+***
+
+### listCapabilities()
+
+> **listCapabilities**(`actor`, `agentId?`, `request?`): `Promise`\<readonly [`AgentCapability`](AgentCapability.md)[]\>
+
+#### Parameters
+
+##### actor
+
+[`VaultPrincipal`](VaultPrincipal.md) & `object`
+
+##### agentId?
+
+`string`
+
+##### request?
+
+`Omit`\<[`OwnerListCapabilitiesRequest`](OwnerListCapabilitiesRequest.md), `"actor"` \| `"vaultId"` \| `"agentId"`\>
+
+#### Returns
+
+`Promise`\<readonly [`AgentCapability`](AgentCapability.md)[]\>
+
+***
+
+### registerAgentIdentity()
+
+> **registerAgentIdentity**(`command`): `Promise`\<`void`\>
+
+#### Parameters
+
+##### command
+
+[`OwnerRegisterAgentIdentityCommand`](OwnerRegisterAgentIdentityCommand.md)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### registerCapability()
+
+> **registerCapability**(`command`): `Promise`\<`void`\>
+
+#### Parameters
+
+##### command
+
+[`OwnerRegisterCapabilityCommand`](OwnerRegisterCapabilityCommand.md)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### registerCustomFlow()
+
+> **registerCustomFlow**(`command`): `Promise`\<`void`\>
+
+#### Parameters
+
+##### command
+
+[`OwnerRegisterCustomHttpFlowCommand`](OwnerRegisterCustomHttpFlowCommand.md)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### revokeCapability()
+
+> **revokeCapability**(`command`): `Promise`\<`void`\>
+
+#### Parameters
+
+##### command
+
+[`OwnerRevokeCapabilityCommand`](OwnerRevokeCapabilityCommand.md)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### storeCustomFlowSecret()
+
+> **storeCustomFlowSecret**(`flow`, `alias`, `plaintext`): `Promise`\<[`SecretRecord`](SecretRecord.md)\>
+
+#### Parameters
+
+##### flow
+
+[`CustomHttpFlowDefinition`](CustomHttpFlowDefinition.md)
+
+##### alias
+
+`string`
+
+##### plaintext
+
+`string`
+
+#### Returns
+
+`Promise`\<[`SecretRecord`](SecretRecord.md)\>
+
+***
+
+### writeSecret()
+
+> **writeSecret**(`command`): `Promise`\<[`SecretRecord`](SecretRecord.md)\>
+
+#### Parameters
+
+##### command
+
+[`VaultWriteSecretCommand`](../type-aliases/VaultWriteSecretCommand.md)
+
+#### Returns
+
+`Promise`\<[`SecretRecord`](SecretRecord.md)\>

package/docs/api/interfaces/VaultCoreDependencies.md

@@ -0,0 +1,95 @@
+[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
+
+***
+
+# Interface: VaultCoreDependencies
+
+## Properties
+
+### agentIdentities
+
+> **agentIdentities**: [`AgentIdentityRegistry`](AgentIdentityRegistry.md)
+
+***
+
+### audit
+
+> **audit**: [`AuditLog`](AuditLog.md)
+
+***
+
+### capabilities
+
+> **capabilities**: [`CapabilityRegistry`](CapabilityRegistry.md)
+
+***
+
+### clock
+
+> **clock**: [`Clock`](Clock.md)
+
+***
+
+### custody
+
+> **custody**: [`SecretCustody`](SecretCustody.md)
+
+***
+
+### customFlows
+
+> **customFlows**: [`CustomHttpFlowRegistry`](CustomHttpFlowRegistry.md)
+
+***
+
+### executor
+
+> **executor**: [`TrustedExecutor`](TrustedExecutor.md)
+
+***
+
+### ids
+
+> **ids**: [`IdGenerator`](IdGenerator.md)
+
+***
+
+### ownerIdentities
+
+> **ownerIdentities**: [`OwnerIdentityRegistry`](OwnerIdentityRegistry.md)
+
+***
+
+### ownerProofVerifier
+
+> **ownerProofVerifier**: [`OwnerProofVerifier`](OwnerProofVerifier.md)
+
+***
+
+### policy
+
+> **policy**: [`PolicyEngine`](PolicyEngine.md)
+
+***
+
+### proofVerifier
+
+> **proofVerifier**: [`AgentProofVerifier`](AgentProofVerifier.md)
+
+***
+
+### replayGuard
+
+> **replayGuard**: [`ReplayGuard`](ReplayGuard.md)
+
+***
+
+### secrets
+
+> **secrets**: [`SecretRepository`](SecretRepository.md)
+
+***
+
+### vaultId
+
+> **vaultId**: [`VaultId`](VaultId.md)

package/docs/api/interfaces/VaultCustomFlowResolver.md

@@ -0,0 +1,25 @@
+[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
+
+***
+
+# Interface: VaultCustomFlowResolver
+
+## Methods
+
+### get()
+
+> **get**(`vaultId`, `flowId`): `Promise`\<[`CustomHttpFlowDefinition`](CustomHttpFlowDefinition.md) \| `null`\>
+
+#### Parameters
+
+##### vaultId
+
+[`VaultId`](VaultId.md)
+
+##### flowId
+
+`string`
+
+#### Returns
+
+`Promise`\<[`CustomHttpFlowDefinition`](CustomHttpFlowDefinition.md) \| `null`\>

package/docs/api/interfaces/VaultDeleteSecretInput.md

@@ -0,0 +1,17 @@
+[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
+
+***
+
+# Interface: VaultDeleteSecretInput
+
+## Properties
+
+### alias
+
+> **alias**: `string`
+
+***
+
+### requestedAt?
+
+> `optional` **requestedAt?**: `string`

package/docs/api/interfaces/VaultExportSecretInput.md

@@ -0,0 +1,17 @@
+[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
+
+***
+
+# Interface: VaultExportSecretInput
+
+## Properties
+
+### alias
+
+> **alias**: `string`
+
+***
+
+### requestedAt?
+
+> `optional` **requestedAt?**: `string`

package/docs/api/interfaces/VaultGrantCapabilityInput.md

@@ -0,0 +1,17 @@
+[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
+
+***
+
+# Interface: VaultGrantCapabilityInput
+
+## Properties
+
+### capability
+
+> **capability**: [`AgentCapability`](AgentCapability.md)
+
+***
+
+### requestedAt?
+
+> `optional` **requestedAt?**: `string`

package/docs/api/interfaces/VaultId.md

@@ -0,0 +1,11 @@
+[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
+
+***
+
+# Interface: VaultId
+
+## Properties
+
+### value
+
+> `readonly` **value**: `string`