@the-ai-company/cbio-node-runtime 1.42.0 → 1.45.2

package/docs/api/functions/readIdentityMetadata.md

@@ -0,0 +1,29 @@
+[**CBIO Node Runtime Agent API v1.45.2**](../README.md)
+
+***
+
+# Function: readIdentityMetadata()
+
+> **readIdentityMetadata**(`storage`, `identityId`, `privateKey?`): `Promise`\<`any`\>
+
+Metadata reader for identities.
+Discovery info (nickname) can be read with just identityId.
+Full profile requires privateKey.
+
+## Parameters
+
+### storage
+
+[`IStorageProvider`](../interfaces/IStorageProvider.md)
+
+### identityId
+
+`string`
+
+### privateKey?
+
+`string`
+
+## Returns
+
+`Promise`\<`any`\>

package/docs/api/functions/readIdentityPrivateVaultChildrenState.md

@@ -0,0 +1,21 @@
+[**CBIO Node Runtime Agent API v1.45.2**](../README.md)
+
+***
+
+# Function: readIdentityPrivateVaultChildrenState()
+
+> **readIdentityPrivateVaultChildrenState**(`storage`, `identityOrPrivateKey`): `Promise`\<[`IdentityPrivateVaultChildrenState`](../interfaces/IdentityPrivateVaultChildrenState.md)\>
+
+## Parameters
+
+### storage
+
+[`IStorageProvider`](../interfaces/IStorageProvider.md)
+
+### identityOrPrivateKey
+
+[`IdentityPrivateVaultAccess`](../type-aliases/IdentityPrivateVaultAccess.md)
+
+## Returns
+
+`Promise`\<[`IdentityPrivateVaultChildrenState`](../interfaces/IdentityPrivateVaultChildrenState.md)\>

package/docs/api/functions/readIdentityPrivateVaultProfile.md

@@ -0,0 +1,21 @@
+[**CBIO Node Runtime Agent API v1.45.2**](../README.md)
+
+***
+
+# Function: readIdentityPrivateVaultProfile()
+
+> **readIdentityPrivateVaultProfile**(`storage`, `identityOrPrivateKey`): `Promise`\<[`IdentityPrivateVaultProfile`](../interfaces/IdentityPrivateVaultProfile.md) \| `null`\>
+
+## Parameters
+
+### storage
+
+[`IStorageProvider`](../interfaces/IStorageProvider.md)
+
+### identityOrPrivateKey
+
+[`IdentityPrivateVaultAccess`](../type-aliases/IdentityPrivateVaultAccess.md)
+
+## Returns
+
+`Promise`\<[`IdentityPrivateVaultProfile`](../interfaces/IdentityPrivateVaultProfile.md) \| `null`\>

package/docs/api/functions/readVaultProfile.md

@@ -0,0 +1,25 @@
+[**CBIO Node Runtime Agent API v1.45.2**](../README.md)
+
+***
+
+# Function: readVaultProfile()
+
+> **readVaultProfile**(`storage`, `vaultWorkingKey`, `vaultId`): `Promise`\<[`VaultProfile`](../interfaces/VaultProfile.md) \| `null`\>
+
+## Parameters
+
+### storage
+
+[`IStorageProvider`](../interfaces/IStorageProvider.md)
+
+### vaultWorkingKey
+
+`string`
+
+### vaultId
+
+`string`
+
+## Returns
+
+`Promise`\<[`VaultProfile`](../interfaces/VaultProfile.md) \| `null`\>

package/docs/api/functions/readVaultPublicMetadata.md

@@ -0,0 +1,23 @@
+[**CBIO Node Runtime Agent API v1.45.2**](../README.md)
+
+***
+
+# Function: readVaultPublicMetadata()
+
+> **readVaultPublicMetadata**(`storage`, `vaultId`): `Promise`\<`Record`\<`string`, `any`\>\>
+
+Reads the 'public' metadata of a vault. Requires vaultId but no private key.
+
+## Parameters
+
+### storage
+
+[`IStorageProvider`](../interfaces/IStorageProvider.md)
+
+### vaultId
+
+`string`
+
+## Returns
+
+`Promise`\<`Record`\<`string`, `any`\>\>

package/docs/api/functions/recoverVault.md

@@ -0,0 +1,58 @@
+[**CBIO Node Runtime Agent API v1.45.2**](../README.md)
+
+***
+
+# Function: recoverVault()
+
+## Call Signature
+
+> **recoverVault**(`storage`, `options`): `Promise`\<[`RecoveredVault`](../interfaces/RecoveredVault.md)\>
+
+Reopens an existing vault from storage.
+
+### Parameters
+
+#### storage
+
+`string` \| [`IStorageProvider`](../interfaces/IStorageProvider.md)
+
+Workspace storage where the vault was created.
+
+#### options
+
+[`RecoverVaultOptions`](../interfaces/RecoverVaultOptions.md)
+
+Recovery options (must include `vaultId` and `ownerIdentity`).
+
+### Returns
+
+`Promise`\<[`RecoveredVault`](../interfaces/RecoveredVault.md)\>
+
+A [RecoveredVault](../interfaces/RecoveredVault.md) instance.
+
+### Example
+
+```ts
+const vault = await recoverVault({
+  vaultId: 'vault_123',
+  ownerIdentity
+});
+```
+
+## Call Signature
+
+> **recoverVault**(`options`): `Promise`\<[`RecoveredVault`](../interfaces/RecoveredVault.md)\>
+
+Recovers an existing vault using the default workspace storage.
+
+### Parameters
+
+#### options
+
+[`RecoverVaultOptions`](../interfaces/RecoverVaultOptions.md)
+
+Recovery options including vaultId and owner identity.
+
+### Returns
+
+`Promise`\<[`RecoveredVault`](../interfaces/RecoveredVault.md)\>

package/docs/api/functions/recoverVaultWorkingKey.md

@@ -0,0 +1,25 @@
+[**CBIO Node Runtime Agent API v1.45.2**](../README.md)
+
+***
+
+# Function: recoverVaultWorkingKey()
+
+> **recoverVaultWorkingKey**(`storage`, `vaultRecoveryKey`, `storageKey?`): `Promise`\<`string`\>
+
+## Parameters
+
+### storage
+
+[`IStorageProvider`](../interfaces/IStorageProvider.md)
+
+### vaultRecoveryKey
+
+`string`
+
+### storageKey?
+
+`string` = `DEFAULT_VAULT_KEY_CUSTODY_BLOB_KEY`
+
+## Returns
+
+`Promise`\<`string`\>

package/docs/api/functions/restoreIdentity.md

@@ -0,0 +1,35 @@
+[**CBIO Node Runtime Agent API v1.45.2**](../README.md)
+
+***
+
+# Function: restoreIdentity()
+
+> **restoreIdentity**(`privateKey`, `options?`): `CreatedIdentity`
+
+Restores an identity from an existing private key.
+
+## Parameters
+
+### privateKey
+
+`string`
+
+The base64url-encoded PKCS#8 private key.
+
+### options?
+
+[`RestoreIdentityOptions`](../interfaces/RestoreIdentityOptions.md) = `{}`
+
+Optional metadata to attach to the restored object.
+
+## Returns
+
+`CreatedIdentity`
+
+The reconstructed CreatedIdentity.
+
+## Example
+
+```ts
+const identity = restoreIdentity('MIIB...');
+```

package/docs/api/functions/toOwnerHttpFlowBoundary.md

@@ -0,0 +1,17 @@
+[**CBIO Node Runtime Agent API v1.45.2**](../README.md)
+
+***
+
+# Function: toOwnerHttpFlowBoundary()
+
+> **toOwnerHttpFlowBoundary**(`flow`): [`OwnerHttpFlowBoundary`](../interfaces/OwnerHttpFlowBoundary.md)
+
+## Parameters
+
+### flow
+
+`Pick`\<[`CustomHttpFlowDefinition`](../interfaces/CustomHttpFlowDefinition.md), `"mode"` \| `"targetUrl"` \| `"method"` \| `"responseVisibility"` \| `"responseSecret"`\>
+
+## Returns
+
+[`OwnerHttpFlowBoundary`](../interfaces/OwnerHttpFlowBoundary.md)

package/docs/api/functions/updateVaultMetadata.md

@@ -0,0 +1,33 @@
+[**CBIO Node Runtime Agent API v1.45.2**](../README.md)
+
+***
+
+# Function: updateVaultMetadata()
+
+> **updateVaultMetadata**(`vault`, `options`): `Promise`\<`void`\>
+
+Updates the metadata (like nickname) of an existing vault.
+
+## Parameters
+
+### vault
+
+[`CreatedVault`](../interfaces/CreatedVault.md) \| [`RecoveredVault`](../interfaces/RecoveredVault.md)
+
+### options
+
+#### nickname?
+
+`string`
+
+#### ownerIdentity
+
+`CreatedIdentity`
+
+#### publicMetadata?
+
+`Record`\<`string`, `any`\>
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/api/functions/wrapVaultCoreAsVaultService.md

@@ -0,0 +1,31 @@
+[**CBIO Node Runtime Agent API v1.45.2**](../README.md)
+
+***
+
+# Function: wrapVaultCoreAsVaultService()
+
+> **wrapVaultCoreAsVaultService**(`core`, `options?`): [`VaultService`](../interfaces/VaultService.md)
+
+## Parameters
+
+### core
+
+[`VaultCore`](../interfaces/VaultCore.md)
+
+### options?
+
+#### clock?
+
+[`Clock`](../interfaces/Clock.md)
+
+#### customFlows?
+
+[`VaultCustomFlowResolver`](../interfaces/VaultCustomFlowResolver.md)
+
+#### fetchImpl?
+
+\{(`input`, `init?`): `Promise`\<`Response`\>; (`input`, `init?`): `Promise`\<`Response`\>; \}
+
+## Returns
+
+[`VaultService`](../interfaces/VaultService.md)

package/docs/api/functions/writeVaultProfile.md

@@ -0,0 +1,29 @@
+[**CBIO Node Runtime Agent API v1.45.2**](../README.md)
+
+***
+
+# Function: writeVaultProfile()
+
+> **writeVaultProfile**(`storage`, `profile`, `vaultWorkingKey`, `vaultId`): `Promise`\<`void`\>
+
+## Parameters
+
+### storage
+
+[`IStorageProvider`](../interfaces/IStorageProvider.md)
+
+### profile
+
+[`VaultProfile`](../interfaces/VaultProfile.md)
+
+### vaultWorkingKey
+
+`string`
+
+### vaultId
+
+`string`
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/api/interfaces/AgentCapability.md

@@ -0,0 +1,103 @@
+[**CBIO Node Runtime Agent API v1.45.2**](../README.md)
+
+***
+
+# Interface: AgentCapability
+
+## Properties
+
+### agentId
+
+> **agentId**: `string`
+
+***
+
+### allowedMethods
+
+> **allowedMethods**: readonly `string`[]
+
+***
+
+### allowedPaths?
+
+> `optional` **allowedPaths?**: readonly `string`[]
+
+***
+
+### allowedTargets
+
+> **allowedTargets**: readonly `string`[]
+
+***
+
+### auditRequired?
+
+> `optional` **auditRequired?**: `boolean`
+
+***
+
+### capabilityId
+
+> **capabilityId**: `string`
+
+***
+
+### customFlowId?
+
+> `optional` **customFlowId?**: `string`
+
+***
+
+### expiresAt?
+
+> `optional` **expiresAt?**: `string`
+
+***
+
+### issuedAt
+
+> **issuedAt**: `string`
+
+***
+
+### operation
+
+> **operation**: `"dispatch_http"` \| `"custom_http"`
+
+***
+
+### rateLimit?
+
+> `optional` **rateLimit?**: `object`
+
+#### maxRequests
+
+> **maxRequests**: `number`
+
+#### windowMs
+
+> **windowMs**: `number`
+
+***
+
+### revocationVersion?
+
+> `optional` **revocationVersion?**: `number`
+
+***
+
+### secretAliases?
+
+> `optional` **secretAliases?**: readonly `string`[]
+
+***
+
+### secretIds?
+
+> `optional` **secretIds?**: readonly `string`[]
+
+***
+
+### vaultId
+
+> **vaultId**: [`VaultId`](VaultId.md)

package/docs/api/interfaces/AgentClient.md

@@ -0,0 +1,41 @@
+[**CBIO Node Runtime Agent API v1.45.2**](../README.md)
+
+***
+
+# Interface: AgentClient
+
+A client for agents to perform authorized operations (e.g., dispatch HTTP requests with secrets).
+This client uses a delegated capability granted by the owner.
+
+## Methods
+
+### dispatch()
+
+> **dispatch**(`intent`): `Promise`\<[`DispatchResult`](DispatchResult.md)\>
+
+Dispatches a signed request to a target using a vault secret.
+
+#### Parameters
+
+##### intent
+
+[`AgentDispatchIntent`](AgentDispatchIntent.md)
+
+The destination, method, and secret alias to use.
+
+#### Returns
+
+`Promise`\<[`DispatchResult`](DispatchResult.md)\>
+
+The result of the remote operation.
+
+#### Example
+
+```ts
+const result = await agent.dispatch({
+  targetUrl: 'https://api.example.com/data',
+  method: 'POST',
+  secretAlias: 'api-token',
+  body: JSON.stringify({ key: 'value' })
+});
+```

package/docs/api/interfaces/AgentDispatchIntent.md

@@ -0,0 +1,41 @@
+[**CBIO Node Runtime Agent API v1.45.2**](../README.md)
+
+***
+
+# Interface: AgentDispatchIntent
+
+## Properties
+
+### body?
+
+> `optional` **body?**: `string`
+
+***
+
+### headers?
+
+> `optional` **headers?**: `Record`\<`string`, `string`\>
+
+***
+
+### method
+
+> **method**: `string`
+
+***
+
+### requestedAt?
+
+> `optional` **requestedAt?**: `string`
+
+***
+
+### secretAlias?
+
+> `optional` **secretAlias?**: `string`
+
+***
+
+### targetUrl
+
+> **targetUrl**: `string`

package/docs/api/interfaces/AgentDispatchTransport.md

@@ -0,0 +1,21 @@
+[**CBIO Node Runtime Agent API v1.45.2**](../README.md)
+
+***
+
+# Interface: AgentDispatchTransport
+
+## Methods
+
+### dispatch()
+
+> **dispatch**(`request`): `Promise`\<[`DispatchResult`](DispatchResult.md)\>
+
+#### Parameters
+
+##### request
+
+[`DispatchRequest`](DispatchRequest.md)
+
+#### Returns
+
+`Promise`\<[`DispatchResult`](DispatchResult.md)\>

package/docs/api/interfaces/AgentIdentity.md

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

package/docs/api/interfaces/AgentIdentityRecord.md

@@ -0,0 +1,23 @@
+[**CBIO Node Runtime Agent API v1.45.2**](../README.md)
+
+***
+
+# Interface: AgentIdentityRecord
+
+## Properties
+
+### agentId
+
+> **agentId**: `string`
+
+***
+
+### publicKey
+
+> **publicKey**: `string`
+
+***
+
+### vaultId
+
+> **vaultId**: [`VaultId`](VaultId.md)

package/docs/api/interfaces/AgentIdentityRegistry.md

@@ -0,0 +1,57 @@
+[**CBIO Node Runtime Agent API v1.45.2**](../README.md)
+
+***
+
+# Interface: AgentIdentityRegistry
+
+## Methods
+
+### get()
+
+> **get**(`vaultId`, `agentId`): `Promise`\<[`AgentIdentityRecord`](AgentIdentityRecord.md) \| `null`\>
+
+#### Parameters
+
+##### vaultId
+
+[`VaultId`](VaultId.md)
+
+##### agentId
+
+`string`
+
+#### Returns
+
+`Promise`\<[`AgentIdentityRecord`](AgentIdentityRecord.md) \| `null`\>
+
+***
+
+### list()
+
+> **list**(`vaultId`): `Promise`\<readonly [`AgentIdentityRecord`](AgentIdentityRecord.md)[]\>
+
+#### Parameters
+
+##### vaultId
+
+[`VaultId`](VaultId.md)
+
+#### Returns
+
+`Promise`\<readonly [`AgentIdentityRecord`](AgentIdentityRecord.md)[]\>
+
+***
+
+### register()
+
+> **register**(`identity`): `Promise`\<`void`\>
+
+#### Parameters
+
+##### identity
+
+[`AgentIdentityRecord`](AgentIdentityRecord.md)
+
+#### Returns
+
+`Promise`\<`void`\>

package/docs/api/interfaces/AgentProof.md

@@ -0,0 +1,29 @@
+[**CBIO Node Runtime Agent API v1.45.2**](../README.md)
+
+***
+
+# Interface: AgentProof
+
+## Properties
+
+### agentId
+
+> **agentId**: `string`
+
+***
+
+### requestedAt
+
+> **requestedAt**: `string`
+
+***
+
+### requestId
+
+> **requestId**: `string`
+
+***
+
+### signature
+
+> **signature**: `string`