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

package/docs/api/functions/createVaultService.md

@@ -0,0 +1,31 @@
+[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
+
+***
+
+# Function: createVaultService()
+
+> **createVaultService**(`deps`, `options?`): [`VaultService`](../interfaces/VaultService.md)
+
+## Parameters
+
+### deps
+
+[`VaultCoreDependencies`](../interfaces/VaultCoreDependencies.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/createWorkspaceStorage.md

@@ -0,0 +1,17 @@
+[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
+
+***
+
+# Function: createWorkspaceStorage()
+
+> **createWorkspaceStorage**(`baseDir?`): `FsStorageProvider`
+
+## Parameters
+
+### baseDir?
+
+`string` = `...`
+
+## Returns
+
+`FsStorageProvider`

package/docs/api/functions/deriveChildIdentity.md

@@ -0,0 +1,41 @@
+[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
+
+***
+
+# Function: deriveChildIdentity()
+
+> **deriveChildIdentity**(`parent`, `childIndex`, `options?`): [`ChildIdentity`](../interfaces/ChildIdentity.md)
+
+Deterministically derives a child identity from a parent's private key and an index.
+
+## Parameters
+
+### parent
+
+`string` \| `CreatedIdentity`
+
+The parent identity object or its private key string.
+
+### childIndex
+
+`number`
+
+A non-negative integer for derivation.
+
+### options?
+
+[`DeriveIdentityOptions`](../interfaces/DeriveIdentityOptions.md) = `{}`
+
+Optional nickname for the child.
+
+## Returns
+
+[`ChildIdentity`](../interfaces/ChildIdentity.md)
+
+A [ChildIdentity](../interfaces/ChildIdentity.md) with derivation metadata.
+
+## Example
+
+```ts
+const child = deriveChildIdentity(parentIdentity, 0, { nickname: 'sub-agent-0' });
+```

package/docs/api/functions/deriveIdentityId.md

@@ -0,0 +1,17 @@
+[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
+
+***
+
+# Function: deriveIdentityId()
+
+> **deriveIdentityId**(`publicKey`): `string`
+
+## Parameters
+
+### publicKey
+
+`string`
+
+## Returns
+
+`string`

package/docs/api/functions/ensureIdentityPrivateVault.md

@@ -0,0 +1,21 @@
+[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
+
+***
+
+# Function: ensureIdentityPrivateVault()
+
+> **ensureIdentityPrivateVault**(`storage`, `identity`): `Promise`\<`void`\>
+
+## Parameters
+
+### storage
+
+[`IStorageProvider`](../interfaces/IStorageProvider.md)
+
+### identity
+
+`CreatedIdentity`
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/api/functions/getDefaultWorkspaceDir.md

@@ -0,0 +1,11 @@
+[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
+
+***
+
+# Function: getDefaultWorkspaceDir()
+
+> **getDefaultWorkspaceDir**(): `string`
+
+## Returns
+
+`string`

package/docs/api/functions/handleVaultHttpDispatch.md

@@ -0,0 +1,30 @@
+[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
+
+***
+
+# Function: handleVaultHttpDispatch()
+
+> **handleVaultHttpDispatch**(`service`, `body`): `Promise`\<[`VaultAgentDispatchResponse`](../interfaces/VaultAgentDispatchResponse.md) \| [`VaultAgentDispatchErrorResponse`](../interfaces/VaultAgentDispatchErrorResponse.md)\>
+
+Standard server-side helper to handle a vault agent dispatch request from an HTTP body.
+This can be used in any HTTP server framework (Express, Fastify, etc.).
+
+## Parameters
+
+### service
+
+[`VaultService`](../interfaces/VaultService.md)
+
+The VaultService instance to handle the request.
+
+### body
+
+`unknown`
+
+The parsed JSON body of the incoming HTTP request.
+
+## Returns
+
+`Promise`\<[`VaultAgentDispatchResponse`](../interfaces/VaultAgentDispatchResponse.md) \| [`VaultAgentDispatchErrorResponse`](../interfaces/VaultAgentDispatchErrorResponse.md)\>
+
+A JSON-serializable response object.

package/docs/api/functions/identityPrivateVaultChildrenKey.md

@@ -0,0 +1,17 @@
+[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
+
+***
+
+# Function: identityPrivateVaultChildrenKey()
+
+> **identityPrivateVaultChildrenKey**(`identityId`): `string`
+
+## Parameters
+
+### identityId
+
+`string`
+
+## Returns
+
+`string`

package/docs/api/functions/identityPrivateVaultPrefix.md

@@ -0,0 +1,17 @@
+[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
+
+***
+
+# Function: identityPrivateVaultPrefix()
+
+> **identityPrivateVaultPrefix**(`identityId`): `string`
+
+## Parameters
+
+### identityId
+
+`string`
+
+## Returns
+
+`string`

package/docs/api/functions/identityPrivateVaultProfileKey.md

@@ -0,0 +1,17 @@
+[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
+
+***
+
+# Function: identityPrivateVaultProfileKey()
+
+> **identityPrivateVaultProfileKey**(`identityId`): `string`
+
+## Parameters
+
+### identityId
+
+`string`
+
+## Returns
+
+`string`

package/docs/api/functions/identityPrivateVaultPublicSealedKey.md

@@ -0,0 +1,17 @@
+[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
+
+***
+
+# Function: identityPrivateVaultPublicSealedKey()
+
+> **identityPrivateVaultPublicSealedKey**(`identityId`): `string`
+
+## Parameters
+
+### identityId
+
+`string`
+
+## Returns
+
+`string`

package/docs/api/functions/initializeVaultCustody.md

@@ -0,0 +1,21 @@
+[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
+
+***
+
+# Function: initializeVaultCustody()
+
+> **initializeVaultCustody**(`storage`, `options?`): `Promise`\<[`InitializedVaultCustody`](../interfaces/InitializedVaultCustody.md)\>
+
+## Parameters
+
+### storage
+
+[`IStorageProvider`](../interfaces/IStorageProvider.md)
+
+### options?
+
+[`InitializeVaultCustodyOptions`](../interfaces/InitializeVaultCustodyOptions.md) = `{}`
+
+## Returns
+
+`Promise`\<[`InitializedVaultCustody`](../interfaces/InitializedVaultCustody.md)\>

package/docs/api/functions/listIdentities.md

@@ -0,0 +1,19 @@
+[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
+
+***
+
+# Function: listIdentities()
+
+> **listIdentities**(`storage`): `Promise`\<`any`[]\>
+
+Lists all identities in the workspace with their discovery metadata.
+
+## Parameters
+
+### storage
+
+[`IStorageProvider`](../interfaces/IStorageProvider.md)
+
+## Returns
+
+`Promise`\<`any`[]\>

package/docs/api/functions/listVaults.md

@@ -0,0 +1,23 @@
+[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
+
+***
+
+# Function: listVaults()
+
+> **listVaults**(`storage`): `Promise`\<`object`[]\>
+
+Lists all available vaults in the workspace by scanning for signed profiles.
+
+## Parameters
+
+### storage
+
+[`IStorageProvider`](../interfaces/IStorageProvider.md)
+
+The root workspace storage provider.
+
+## Returns
+
+`Promise`\<`object`[]\>
+
+A list of vault IDs and their public discovery metadata.

package/docs/api/functions/readIdentityMetadata.md

@@ -0,0 +1,29 @@
+[**CBIO Node Runtime Agent API v1.45.5**](../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.5**](../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.5**](../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.5**](../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.5**](../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.5**](../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.5**](../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.5**](../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.5**](../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.5**](../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.5**](../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.5**](../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`\>