@the-ai-company/cbio-node-runtime 1.46.0 → 1.47.2
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 +85 -239
- package/dist/clients/agent/client.d.ts +1 -0
- package/dist/clients/agent/client.js +25 -9
- package/dist/clients/agent/client.js.map +1 -1
- package/dist/clients/owner/client.d.ts +6 -4
- package/dist/clients/owner/client.js +41 -0
- package/dist/clients/owner/client.js.map +1 -1
- package/dist/clients/owner/contracts.d.ts +36 -0
- package/dist/clients/owner/index.d.ts +1 -1
- package/dist/runtime/bootstrap.d.ts +7 -7
- package/dist/runtime/bootstrap.js +2 -2
- package/dist/runtime/index.d.ts +3 -3
- package/dist/runtime/index.js +1 -1
- package/dist/runtime/index.js.map +1 -1
- package/dist/runtime/vault-metadata.js +1 -1
- package/dist/runtime/vault-metadata.js.map +1 -1
- package/dist/vault-core/contracts.d.ts +28 -2
- package/dist/vault-core/contracts.js +2 -0
- package/dist/vault-core/contracts.js.map +1 -1
- package/dist/vault-core/core.d.ts +10 -2
- package/dist/vault-core/core.js +24 -0
- package/dist/vault-core/core.js.map +1 -1
- package/dist/vault-core/defaults.d.ts +15 -3
- package/dist/vault-core/defaults.js +53 -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.js +5 -2
- package/dist/vault-core/persistence.js.map +1 -1
- package/dist/vault-core/ports.d.ts +6 -0
- package/dist/vault-ingress/index.d.ts +11 -2
- package/dist/vault-ingress/index.js +8 -0
- package/dist/vault-ingress/index.js.map +1 -1
- package/dist/vault-ingress/remote-transport.js +4 -1
- package/dist/vault-ingress/remote-transport.js.map +1 -1
- package/docs/ARCHITECTURE.md +34 -107
- package/docs/CUSTODY_MODEL.md +27 -129
- package/docs/IDENTITY_MODEL.md +34 -112
- package/docs/REFERENCE.md +57 -404
- package/docs/api/README.md +4 -3
- package/docs/api/classes/IdentityError.md +2 -2
- package/docs/api/classes/VaultCore.md +43 -1
- package/docs/api/classes/VaultCoreError.md +1 -1
- package/docs/api/enumerations/IdentityErrorCode.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/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 +3 -3
- 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/handleVaultHttpDispatch.md +1 -1
- package/docs/api/functions/initializeVaultCustody.md +1 -1
- package/docs/api/functions/listVaults.md +3 -3
- package/docs/api/functions/readVaultProfile.md +1 -1
- package/docs/api/functions/recoverVault.md +4 -4
- 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 +1 -1
- package/docs/api/interfaces/AgentDispatchIntent.md +1 -1
- package/docs/api/interfaces/AgentDispatchTransport.md +1 -1
- package/docs/api/interfaces/AgentIdentity.md +1 -1
- package/docs/api/interfaces/AgentSigner.md +1 -1
- package/docs/api/interfaces/CbioRuntime.md +8 -8
- package/docs/api/interfaces/CreateAgentClientOptions.md +7 -1
- package/docs/api/interfaces/CreateIdentityOptions.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/OwnerDefineSecretTargetsInput.md +1 -1
- package/docs/api/interfaces/OwnerSecretTargetBinding.md +1 -1
- package/docs/api/interfaces/OwnerStoreSecretInput.md +1 -1
- package/docs/api/interfaces/OwnerWriteSecretInput.md +1 -1
- 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/VaultAuditQueryInput.md +1 -1
- package/docs/api/interfaces/VaultClient.md +20 -3
- package/docs/api/interfaces/VaultCoreDependenciesOptions.md +1 -1
- package/docs/api/interfaces/VaultCreateAgentInput.md +29 -0
- package/docs/api/interfaces/VaultDeleteSecretInput.md +1 -1
- package/docs/api/interfaces/VaultExportSecretInput.md +1 -1
- package/docs/api/interfaces/VaultGrantCapabilityInput.md +1 -1
- package/docs/api/interfaces/VaultIdentity.md +1 -1
- package/docs/api/interfaces/VaultListAgentsInput.md +1 -1
- package/docs/api/interfaces/VaultListCapabilitiesInput.md +1 -1
- package/docs/api/interfaces/{VaultPublicMetadata.md → VaultMetadata.md} +2 -2
- package/docs/api/interfaces/VaultObject.md +1 -1
- package/docs/api/interfaces/VaultProfile.md +1 -1
- package/docs/api/interfaces/VaultRegisterAgentInput.md +19 -1
- package/docs/api/interfaces/VaultRegisterFlowInput.md +1 -1
- package/docs/api/interfaces/VaultRevokeCapabilityInput.md +1 -1
- package/docs/api/interfaces/VaultSigner.md +1 -1
- package/docs/api/type-aliases/AgentCapabilityEnvelope.md +1 -1
- package/docs/api/type-aliases/CbioRuntimeModule.md +1 -1
- package/docs/api/variables/DEFAULT_VAULT_KEY_CUSTODY_BLOB_KEY.md +1 -1
- package/docs/zh/README.md +64 -39
- package/package.json +1 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**CBIO Node Runtime Agent API v1.
|
|
1
|
+
[**CBIO Node Runtime Agent API v1.47.2**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
> **listVaults**(`storage`): `Promise`\<`string`[]\>
|
|
8
8
|
|
|
9
|
-
Lists all available vaults in the workspace
|
|
9
|
+
Lists all available vaults in the workspace.
|
|
10
10
|
|
|
11
11
|
## Parameters
|
|
12
12
|
|
|
@@ -20,4 +20,4 @@ The root workspace storage provider.
|
|
|
20
20
|
|
|
21
21
|
`Promise`\<`string`[]\>
|
|
22
22
|
|
|
23
|
-
A list of vault IDs
|
|
23
|
+
A list of vault IDs.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**CBIO Node Runtime Agent API v1.
|
|
1
|
+
[**CBIO Node Runtime Agent API v1.47.2**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -22,7 +22,7 @@ Workspace storage where the vault was created.
|
|
|
22
22
|
|
|
23
23
|
[`RecoverVaultOptions`](../interfaces/RecoverVaultOptions.md)
|
|
24
24
|
|
|
25
|
-
Recovery options (must include `vaultId` and `
|
|
25
|
+
Recovery options (must include `vaultId` and `password`).
|
|
26
26
|
|
|
27
27
|
### Returns
|
|
28
28
|
|
|
@@ -35,7 +35,7 @@ A [RecoveredVault](../interfaces/RecoveredVault.md) instance.
|
|
|
35
35
|
```ts
|
|
36
36
|
const vault = await recoverVault({
|
|
37
37
|
vaultId: 'vault_123',
|
|
38
|
-
|
|
38
|
+
password: 'my-strong-password'
|
|
39
39
|
});
|
|
40
40
|
```
|
|
41
41
|
|
|
@@ -51,7 +51,7 @@ Recovers an existing vault using the default workspace storage.
|
|
|
51
51
|
|
|
52
52
|
[`RecoverVaultOptions`](../interfaces/RecoverVaultOptions.md)
|
|
53
53
|
|
|
54
|
-
Recovery options including vaultId and
|
|
54
|
+
Recovery options including vaultId and password.
|
|
55
55
|
|
|
56
56
|
### Returns
|
|
57
57
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**CBIO Node Runtime Agent API v1.
|
|
1
|
+
[**CBIO Node Runtime Agent API v1.47.2**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -165,7 +165,7 @@ Workspace storage (or path string) where vaults are stored.
|
|
|
165
165
|
|
|
166
166
|
[`CreateVaultOptions`](CreateVaultOptions.md)
|
|
167
167
|
|
|
168
|
-
Configuration including
|
|
168
|
+
Configuration including password and metadata.
|
|
169
169
|
|
|
170
170
|
##### Returns
|
|
171
171
|
|
|
@@ -177,7 +177,7 @@ A [CreatedVault](CreatedVault.md) instance.
|
|
|
177
177
|
|
|
178
178
|
```ts
|
|
179
179
|
const vault = await createVault({
|
|
180
|
-
|
|
180
|
+
password: 'my-strong-password',
|
|
181
181
|
nickname: 'production-secrets'
|
|
182
182
|
});
|
|
183
183
|
```
|
|
@@ -369,7 +369,7 @@ A JSON-serializable response object.
|
|
|
369
369
|
|
|
370
370
|
> **listVaults**: (`storage`) => `Promise`\<`string`[]\>
|
|
371
371
|
|
|
372
|
-
Lists all available vaults in the workspace
|
|
372
|
+
Lists all available vaults in the workspace.
|
|
373
373
|
|
|
374
374
|
#### Parameters
|
|
375
375
|
|
|
@@ -383,7 +383,7 @@ The root workspace storage provider.
|
|
|
383
383
|
|
|
384
384
|
`Promise`\<`string`[]\>
|
|
385
385
|
|
|
386
|
-
A list of vault IDs
|
|
386
|
+
A list of vault IDs.
|
|
387
387
|
|
|
388
388
|
***
|
|
389
389
|
|
|
@@ -433,7 +433,7 @@ Workspace storage where the vault was created.
|
|
|
433
433
|
|
|
434
434
|
[`RecoverVaultOptions`](RecoverVaultOptions.md)
|
|
435
435
|
|
|
436
|
-
Recovery options (must include `vaultId` and `
|
|
436
|
+
Recovery options (must include `vaultId` and `password`).
|
|
437
437
|
|
|
438
438
|
##### Returns
|
|
439
439
|
|
|
@@ -446,7 +446,7 @@ A [RecoveredVault](RecoveredVault.md) instance.
|
|
|
446
446
|
```ts
|
|
447
447
|
const vault = await recoverVault({
|
|
448
448
|
vaultId: 'vault_123',
|
|
449
|
-
|
|
449
|
+
password: 'my-strong-password'
|
|
450
450
|
});
|
|
451
451
|
```
|
|
452
452
|
|
|
@@ -462,7 +462,7 @@ Recovers an existing vault using the default workspace storage.
|
|
|
462
462
|
|
|
463
463
|
[`RecoverVaultOptions`](RecoverVaultOptions.md)
|
|
464
464
|
|
|
465
|
-
Recovery options including vaultId and
|
|
465
|
+
Recovery options including vaultId and password.
|
|
466
466
|
|
|
467
467
|
##### Returns
|
|
468
468
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**CBIO Node Runtime Agent API v1.
|
|
1
|
+
[**CBIO Node Runtime Agent API v1.47.2**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -30,6 +30,12 @@
|
|
|
30
30
|
|
|
31
31
|
***
|
|
32
32
|
|
|
33
|
+
### token?
|
|
34
|
+
|
|
35
|
+
> `optional` **token?**: `string`
|
|
36
|
+
|
|
37
|
+
***
|
|
38
|
+
|
|
33
39
|
### transport?
|
|
34
40
|
|
|
35
41
|
> `optional` **transport?**: [`AgentDispatchTransport`](AgentDispatchTransport.md)
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**CBIO Node Runtime Agent API v1.
|
|
1
|
+
[**CBIO Node Runtime Agent API v1.47.2**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -9,6 +9,25 @@ In Sovereign Vault model, administrative actions are implicitly authorized by th
|
|
|
9
9
|
|
|
10
10
|
## Methods
|
|
11
11
|
|
|
12
|
+
### createAgent()
|
|
13
|
+
|
|
14
|
+
> **createAgent**(`input`): `Promise`\<readonly \[`AgentIdentityRecord`, `string`\]\>
|
|
15
|
+
|
|
16
|
+
Generates a new identity and registers it as an agent in one step.
|
|
17
|
+
The private key is stored in the vault for managed custody.
|
|
18
|
+
|
|
19
|
+
#### Parameters
|
|
20
|
+
|
|
21
|
+
##### input
|
|
22
|
+
|
|
23
|
+
[`VaultCreateAgentInput`](VaultCreateAgentInput.md)
|
|
24
|
+
|
|
25
|
+
#### Returns
|
|
26
|
+
|
|
27
|
+
`Promise`\<readonly \[`AgentIdentityRecord`, `string`\]\>
|
|
28
|
+
|
|
29
|
+
***
|
|
30
|
+
|
|
12
31
|
### defineSecretTargets()
|
|
13
32
|
|
|
14
33
|
> **defineSecretTargets**(`input`): `Promise`\<`SecretRecord`\>
|
|
@@ -139,8 +158,6 @@ Reads the tamper-evident audit log for the vault.
|
|
|
139
158
|
|
|
140
159
|
> **registerAgent**(`input`): `Promise`\<`void`\>
|
|
141
160
|
|
|
142
|
-
Registers a new agent identity within the vault.
|
|
143
|
-
|
|
144
161
|
#### Parameters
|
|
145
162
|
|
|
146
163
|
##### input
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
[**CBIO Node Runtime Agent API v1.47.2**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
# Interface: VaultCreateAgentInput
|
|
6
|
+
|
|
7
|
+
## Properties
|
|
8
|
+
|
|
9
|
+
### agentId
|
|
10
|
+
|
|
11
|
+
> **agentId**: `string`
|
|
12
|
+
|
|
13
|
+
***
|
|
14
|
+
|
|
15
|
+
### metadata?
|
|
16
|
+
|
|
17
|
+
> `optional` **metadata?**: `Record`\<`string`, `any`\>
|
|
18
|
+
|
|
19
|
+
***
|
|
20
|
+
|
|
21
|
+
### nickname?
|
|
22
|
+
|
|
23
|
+
> `optional` **nickname?**: `string`
|
|
24
|
+
|
|
25
|
+
***
|
|
26
|
+
|
|
27
|
+
### requestedAt?
|
|
28
|
+
|
|
29
|
+
> `optional` **requestedAt?**: `string`
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**CBIO Node Runtime Agent API v1.
|
|
1
|
+
[**CBIO Node Runtime Agent API v1.47.2**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -12,6 +12,24 @@
|
|
|
12
12
|
|
|
13
13
|
***
|
|
14
14
|
|
|
15
|
+
### metadata?
|
|
16
|
+
|
|
17
|
+
> `optional` **metadata?**: `Record`\<`string`, `any`\>
|
|
18
|
+
|
|
19
|
+
***
|
|
20
|
+
|
|
21
|
+
### nickname?
|
|
22
|
+
|
|
23
|
+
> `optional` **nickname?**: `string`
|
|
24
|
+
|
|
25
|
+
***
|
|
26
|
+
|
|
27
|
+
### privateKey?
|
|
28
|
+
|
|
29
|
+
> `optional` **privateKey?**: `string`
|
|
30
|
+
|
|
31
|
+
***
|
|
32
|
+
|
|
15
33
|
### publicKey
|
|
16
34
|
|
|
17
35
|
> **publicKey**: `string`
|