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

package/docs/api/classes/DefaultPolicyEngine.md

@@ -0,0 +1,117 @@
+[**CBIO Node Runtime Agent API v1.45.2**](../README.md)
+
+***
+
+# Class: DefaultPolicyEngine
+
+## Implements
+
+- [`PolicyEngine`](../interfaces/PolicyEngine.md)
+
+## Constructors
+
+### Constructor
+
+> **new DefaultPolicyEngine**(`_options?`): `DefaultPolicyEngine`
+
+#### Parameters
+
+##### \_options?
+
+[`DefaultPolicyEngineOptions`](../interfaces/DefaultPolicyEngineOptions.md) = `{}`
+
+#### Returns
+
+`DefaultPolicyEngine`
+
+## Methods
+
+### authorizeDefineSecretTargets()
+
+> **authorizeDefineSecretTargets**(`command`): `Promise`\<`void`\>
+
+#### Parameters
+
+##### command
+
+[`OwnerDefineSecretTargetsCommand`](../interfaces/OwnerDefineSecretTargetsCommand.md)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+[`PolicyEngine`](../interfaces/PolicyEngine.md).[`authorizeDefineSecretTargets`](../interfaces/PolicyEngine.md#authorizedefinesecrettargets)
+
+***
+
+### authorizeDispatch()
+
+> **authorizeDispatch**(`request`, `record?`): `Promise`\<`void`\>
+
+#### Parameters
+
+##### request
+
+[`DispatchRequest`](../interfaces/DispatchRequest.md)
+
+##### record?
+
+[`SecretRecord`](../interfaces/SecretRecord.md) \| `null`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+[`PolicyEngine`](../interfaces/PolicyEngine.md).[`authorizeDispatch`](../interfaces/PolicyEngine.md#authorizedispatch)
+
+***
+
+### authorizeWrite()
+
+> **authorizeWrite**(`command`): `Promise`\<`void`\>
+
+#### Parameters
+
+##### command
+
+[`VaultWriteSecretCommand`](../type-aliases/VaultWriteSecretCommand.md)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+[`PolicyEngine`](../interfaces/PolicyEngine.md).[`authorizeWrite`](../interfaces/PolicyEngine.md#authorizewrite)
+
+***
+
+### revokeCapability()
+
+> **revokeCapability**(`vaultId`, `agentId`, `capabilityId`): `Promise`\<`number`\>
+
+#### Parameters
+
+##### vaultId
+
+[`VaultId`](../interfaces/VaultId.md)
+
+##### agentId
+
+`string`
+
+##### capabilityId
+
+`string`
+
+#### Returns
+
+`Promise`\<`number`\>
+
+#### Implementation of
+
+[`PolicyEngine`](../interfaces/PolicyEngine.md).[`revokeCapability`](../interfaces/PolicyEngine.md#revokecapability)

package/docs/api/classes/DefaultVaultCore.md

@@ -0,0 +1,405 @@
+[**CBIO Node Runtime Agent API v1.45.2**](../README.md)
+
+***
+
+# Class: DefaultVaultCore
+
+## Implements
+
+- [`VaultCore`](../interfaces/VaultCore.md)
+
+## Constructors
+
+### Constructor
+
+> **new DefaultVaultCore**(`_deps`): `DefaultVaultCore`
+
+#### Parameters
+
+##### \_deps
+
+[`VaultCoreDependencies`](../interfaces/VaultCoreDependencies.md)
+
+#### Returns
+
+`DefaultVaultCore`
+
+## Accessors
+
+### vaultId
+
+#### Get Signature
+
+> **get** **vaultId**(): [`VaultId`](../interfaces/VaultId.md)
+
+##### Returns
+
+[`VaultId`](../interfaces/VaultId.md)
+
+#### Implementation of
+
+[`VaultCore`](../interfaces/VaultCore.md).[`vaultId`](../interfaces/VaultCore.md#vaultid)
+
+## Methods
+
+### authorizeDispatch()
+
+> **authorizeDispatch**(`request`): `Promise`\<[`DispatchAuthorization`](../interfaces/DispatchAuthorization.md)\>
+
+#### Parameters
+
+##### request
+
+[`DispatchRequest`](../interfaces/DispatchRequest.md)
+
+#### Returns
+
+`Promise`\<[`DispatchAuthorization`](../interfaces/DispatchAuthorization.md)\>
+
+#### Implementation of
+
+[`VaultCore`](../interfaces/VaultCore.md).[`authorizeDispatch`](../interfaces/VaultCore.md#authorizedispatch)
+
+***
+
+### bootstrapOwnerIdentity()
+
+> **bootstrapOwnerIdentity**(`identity`): `Promise`\<`void`\>
+
+#### Parameters
+
+##### identity
+
+[`OwnerIdentityRecord`](../interfaces/OwnerIdentityRecord.md)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+[`VaultCore`](../interfaces/VaultCore.md).[`bootstrapOwnerIdentity`](../interfaces/VaultCore.md#bootstrapowneridentity)
+
+***
+
+### defineSecretTargets()
+
+> **defineSecretTargets**(`command`): `Promise`\<[`SecretRecord`](../interfaces/SecretRecord.md)\>
+
+#### Parameters
+
+##### command
+
+[`OwnerDefineSecretTargetsCommand`](../interfaces/OwnerDefineSecretTargetsCommand.md)
+
+#### Returns
+
+`Promise`\<[`SecretRecord`](../interfaces/SecretRecord.md)\>
+
+#### Implementation of
+
+[`VaultCore`](../interfaces/VaultCore.md).[`defineSecretTargets`](../interfaces/VaultCore.md#definesecrettargets)
+
+***
+
+### deleteSecret()
+
+> **deleteSecret**(`command`): `Promise`\<`void`\>
+
+#### Parameters
+
+##### command
+
+[`OwnerDeleteSecretCommand`](../interfaces/OwnerDeleteSecretCommand.md)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+[`VaultCore`](../interfaces/VaultCore.md).[`deleteSecret`](../interfaces/VaultCore.md#deletesecret)
+
+***
+
+### dispatchSecret()
+
+> **dispatchSecret**(`request`): `Promise`\<[`DispatchResult`](../interfaces/DispatchResult.md)\>
+
+#### Parameters
+
+##### request
+
+[`DispatchRequest`](../interfaces/DispatchRequest.md)
+
+#### Returns
+
+`Promise`\<[`DispatchResult`](../interfaces/DispatchResult.md)\>
+
+#### Implementation of
+
+[`VaultCore`](../interfaces/VaultCore.md).[`dispatchSecret`](../interfaces/VaultCore.md#dispatchsecret)
+
+***
+
+### exportSecret()
+
+> **exportSecret**(`actor`, `alias`, `request?`): `Promise`\<[`OwnerSecretExport`](../interfaces/OwnerSecretExport.md)\>
+
+#### Parameters
+
+##### actor
+
+[`VaultPrincipal`](../interfaces/VaultPrincipal.md) & `object`
+
+##### alias
+
+`string`
+
+##### request?
+
+`Omit`\<[`OwnerExportSecretRequest`](../interfaces/OwnerExportSecretRequest.md), `"actor"` \| `"vaultId"` \| `"alias"`\>
+
+#### Returns
+
+`Promise`\<[`OwnerSecretExport`](../interfaces/OwnerSecretExport.md)\>
+
+#### Implementation of
+
+[`VaultCore`](../interfaces/VaultCore.md).[`exportSecret`](../interfaces/VaultCore.md#exportsecret)
+
+***
+
+### getAudit()
+
+> **getAudit**(`actor`, `query`, `request?`): `Promise`\<readonly [`AuditEntry`](../interfaces/AuditEntry.md)[]\>
+
+#### Parameters
+
+##### actor
+
+[`VaultPrincipal`](../interfaces/VaultPrincipal.md) & `object`
+
+##### query
+
+[`AuditQuery`](../interfaces/AuditQuery.md)
+
+##### request?
+
+`Omit`\<[`OwnerAuditRequest`](../interfaces/OwnerAuditRequest.md), `"actor"` \| `"query"` \| `"vaultId"`\>
+
+#### Returns
+
+`Promise`\<readonly [`AuditEntry`](../interfaces/AuditEntry.md)[]\>
+
+#### Implementation of
+
+[`VaultCore`](../interfaces/VaultCore.md).[`getAudit`](../interfaces/VaultCore.md#getaudit)
+
+***
+
+### getCapability()
+
+> **getCapability**(`vaultId`, `agentId`, `capabilityId`): `Promise`\<[`AgentCapability`](../interfaces/AgentCapability.md) \| `null`\>
+
+#### Parameters
+
+##### vaultId
+
+[`VaultId`](../interfaces/VaultId.md)
+
+##### agentId
+
+`string`
+
+##### capabilityId
+
+`string`
+
+#### Returns
+
+`Promise`\<[`AgentCapability`](../interfaces/AgentCapability.md) \| `null`\>
+
+#### Implementation of
+
+[`VaultCore`](../interfaces/VaultCore.md).[`getCapability`](../interfaces/VaultCore.md#getcapability)
+
+***
+
+### listAgents()
+
+> **listAgents**(`actor`, `request?`): `Promise`\<readonly [`AgentIdentityRecord`](../interfaces/AgentIdentityRecord.md)[]\>
+
+#### Parameters
+
+##### actor
+
+[`VaultPrincipal`](../interfaces/VaultPrincipal.md) & `object`
+
+##### request?
+
+`Omit`\<[`OwnerListAgentsRequest`](../interfaces/OwnerListAgentsRequest.md), `"actor"` \| `"vaultId"`\>
+
+#### Returns
+
+`Promise`\<readonly [`AgentIdentityRecord`](../interfaces/AgentIdentityRecord.md)[]\>
+
+#### Implementation of
+
+[`VaultCore`](../interfaces/VaultCore.md).[`listAgents`](../interfaces/VaultCore.md#listagents)
+
+***
+
+### listCapabilities()
+
+> **listCapabilities**(`actor`, `agentId?`, `request?`): `Promise`\<readonly [`AgentCapability`](../interfaces/AgentCapability.md)[]\>
+
+#### Parameters
+
+##### actor
+
+[`VaultPrincipal`](../interfaces/VaultPrincipal.md) & `object`
+
+##### agentId?
+
+`string`
+
+##### request?
+
+`Omit`\<[`OwnerListCapabilitiesRequest`](../interfaces/OwnerListCapabilitiesRequest.md), `"actor"` \| `"vaultId"` \| `"agentId"`\>
+
+#### Returns
+
+`Promise`\<readonly [`AgentCapability`](../interfaces/AgentCapability.md)[]\>
+
+#### Implementation of
+
+[`VaultCore`](../interfaces/VaultCore.md).[`listCapabilities`](../interfaces/VaultCore.md#listcapabilities)
+
+***
+
+### registerAgentIdentity()
+
+> **registerAgentIdentity**(`command`): `Promise`\<`void`\>
+
+#### Parameters
+
+##### command
+
+[`OwnerRegisterAgentIdentityCommand`](../interfaces/OwnerRegisterAgentIdentityCommand.md)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+[`VaultCore`](../interfaces/VaultCore.md).[`registerAgentIdentity`](../interfaces/VaultCore.md#registeragentidentity)
+
+***
+
+### registerCapability()
+
+> **registerCapability**(`command`): `Promise`\<`void`\>
+
+#### Parameters
+
+##### command
+
+[`OwnerRegisterCapabilityCommand`](../interfaces/OwnerRegisterCapabilityCommand.md)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+[`VaultCore`](../interfaces/VaultCore.md).[`registerCapability`](../interfaces/VaultCore.md#registercapability)
+
+***
+
+### registerCustomFlow()
+
+> **registerCustomFlow**(`command`): `Promise`\<`void`\>
+
+#### Parameters
+
+##### command
+
+[`OwnerRegisterCustomHttpFlowCommand`](../interfaces/OwnerRegisterCustomHttpFlowCommand.md)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+[`VaultCore`](../interfaces/VaultCore.md).[`registerCustomFlow`](../interfaces/VaultCore.md#registercustomflow)
+
+***
+
+### revokeCapability()
+
+> **revokeCapability**(`command`): `Promise`\<`void`\>
+
+#### Parameters
+
+##### command
+
+[`OwnerRevokeCapabilityCommand`](../interfaces/OwnerRevokeCapabilityCommand.md)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+[`VaultCore`](../interfaces/VaultCore.md).[`revokeCapability`](../interfaces/VaultCore.md#revokecapability)
+
+***
+
+### storeCustomFlowSecret()
+
+> **storeCustomFlowSecret**(`flow`, `alias`, `plaintext`): `Promise`\<[`SecretRecord`](../interfaces/SecretRecord.md)\>
+
+#### Parameters
+
+##### flow
+
+[`CustomHttpFlowDefinition`](../interfaces/CustomHttpFlowDefinition.md)
+
+##### alias
+
+`string`
+
+##### plaintext
+
+`string`
+
+#### Returns
+
+`Promise`\<[`SecretRecord`](../interfaces/SecretRecord.md)\>
+
+#### Implementation of
+
+[`VaultCore`](../interfaces/VaultCore.md).[`storeCustomFlowSecret`](../interfaces/VaultCore.md#storecustomflowsecret)
+
+***
+
+### writeSecret()
+
+> **writeSecret**(`command`): `Promise`\<[`SecretRecord`](../interfaces/SecretRecord.md)\>
+
+#### Parameters
+
+##### command
+
+[`VaultWriteSecretCommand`](../type-aliases/VaultWriteSecretCommand.md)
+
+#### Returns
+
+`Promise`\<[`SecretRecord`](../interfaces/SecretRecord.md)\>
+
+#### Implementation of
+
+[`VaultCore`](../interfaces/VaultCore.md).[`writeSecret`](../interfaces/VaultCore.md#writesecret)

package/docs/api/classes/FsStorageProvider.md

@@ -0,0 +1,192 @@
+[**CBIO Node Runtime Agent API v1.45.2**](../README.md)
+
+***
+
+# Class: FsStorageProvider
+
+Pluggable storage layer for vault persistence.
+Enables Cloud, Mobile, and Edge runtimes to use custom storage.
+
+## Implements
+
+- [`IStorageProvider`](../interfaces/IStorageProvider.md)
+
+## Constructors
+
+### Constructor
+
+> **new FsStorageProvider**(`baseDir?`): `FsStorageProvider`
+
+#### Parameters
+
+##### baseDir?
+
+`string`
+
+#### Returns
+
+`FsStorageProvider`
+
+## Methods
+
+### delete()
+
+> **delete**(`key`): `Promise`\<`void`\>
+
+#### Parameters
+
+##### key
+
+`string`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+[`IStorageProvider`](../interfaces/IStorageProvider.md).[`delete`](../interfaces/IStorageProvider.md#delete)
+
+***
+
+### has()
+
+> **has**(`key`): `Promise`\<`boolean`\>
+
+#### Parameters
+
+##### key
+
+`string`
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+#### Implementation of
+
+[`IStorageProvider`](../interfaces/IStorageProvider.md).[`has`](../interfaces/IStorageProvider.md#has)
+
+***
+
+### list()
+
+> **list**(`prefix`): `Promise`\<`string`[]\>
+
+Optional. Returns sub-keys (names) under a given prefix.
+
+#### Parameters
+
+##### prefix
+
+`string`
+
+#### Returns
+
+`Promise`\<`string`[]\>
+
+#### Implementation of
+
+[`IStorageProvider`](../interfaces/IStorageProvider.md).[`list`](../interfaces/IStorageProvider.md#list)
+
+***
+
+### read()
+
+> **read**(`key`): `Promise`\<`Buffer`\<`ArrayBufferLike`\> \| `null`\>
+
+#### Parameters
+
+##### key
+
+`string`
+
+#### Returns
+
+`Promise`\<`Buffer`\<`ArrayBufferLike`\> \| `null`\>
+
+#### Implementation of
+
+[`IStorageProvider`](../interfaces/IStorageProvider.md).[`read`](../interfaces/IStorageProvider.md#read)
+
+***
+
+### rename()
+
+> **rename**(`fromKey`, `toKey`): `Promise`\<`void`\>
+
+Optional. If present, used for atomic save. Otherwise vault does write+delete.
+
+#### Parameters
+
+##### fromKey
+
+`string`
+
+##### toKey
+
+`string`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+[`IStorageProvider`](../interfaces/IStorageProvider.md).[`rename`](../interfaces/IStorageProvider.md#rename)
+
+***
+
+### withLock()
+
+> **withLock**\<`T`\>(`key`, `task`): `Promise`\<`T`\>
+
+Optional. If present, used to serialize read-modify-write sequences across writers.
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### key
+
+`string`
+
+##### task
+
+() => `Promise`\<`T`\>
+
+#### Returns
+
+`Promise`\<`T`\>
+
+#### Implementation of
+
+[`IStorageProvider`](../interfaces/IStorageProvider.md).[`withLock`](../interfaces/IStorageProvider.md#withlock)
+
+***
+
+### write()
+
+> **write**(`key`, `data`): `Promise`\<`void`\>
+
+#### Parameters
+
+##### key
+
+`string`
+
+##### data
+
+`Buffer`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+[`IStorageProvider`](../interfaces/IStorageProvider.md).[`write`](../interfaces/IStorageProvider.md#write)