npm - @the-ai-company/cbio-node-runtime - Versions diffs - 1.45.5 → 1.46.0 - Mend

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

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.

Files changed (199) hide show

package/dist/clients/owner/client.d.ts +4 -10
package/dist/clients/owner/client.js +39 -182
package/dist/clients/owner/client.js.map +1 -1
package/dist/protocol/crypto.d.ts +5 -0
package/dist/protocol/crypto.js +11 -0
package/dist/protocol/crypto.js.map +1 -1
package/dist/runtime/bootstrap.d.ts +7 -20
package/dist/runtime/bootstrap.js +15 -61
package/dist/runtime/bootstrap.js.map +1 -1
package/dist/runtime/identity.d.ts +1 -23
package/dist/runtime/identity.js +2 -74
package/dist/runtime/identity.js.map +1 -1
package/dist/runtime/index.d.ts +8 -22
package/dist/runtime/index.js +6 -10
package/dist/runtime/index.js.map +1 -1
package/dist/runtime/vault-metadata.d.ts +4 -16
package/dist/runtime/vault-metadata.js +8 -43
package/dist/runtime/vault-metadata.js.map +1 -1
package/dist/vault-core/contracts.d.ts +0 -23
package/dist/vault-core/contracts.js +0 -1
package/dist/vault-core/contracts.js.map +1 -1
package/dist/vault-core/core.d.ts +4 -4
package/dist/vault-core/core.js +10 -76
package/dist/vault-core/core.js.map +1 -1
package/dist/vault-core/defaults.d.ts +4 -52
package/dist/vault-core/defaults.js +2 -300
package/dist/vault-core/defaults.js.map +1 -1
package/dist/vault-core/index.d.ts +5 -5
package/dist/vault-core/index.js +3 -3
package/dist/vault-core/index.js.map +1 -1
package/dist/vault-core/persistence.d.ts +5 -34
package/dist/vault-core/persistence.js +8 -38
package/dist/vault-core/persistence.js.map +1 -1
package/dist/vault-core/ports.d.ts +2 -51
package/dist/vault-ingress/index.d.ts +1 -2
package/dist/vault-ingress/index.js +0 -5
package/dist/vault-ingress/index.js.map +1 -1
package/docs/api/README.md +6 -91
package/docs/api/classes/IdentityError.md +1 -1
package/docs/api/classes/VaultCore.md +320 -0
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 +2 -2
package/docs/api/functions/createOwnerHttpFlowBoundary.md +4 -4
package/docs/api/functions/createPersistentVaultCoreDependencies.md +3 -67
package/docs/api/functions/createStandardAcquireBoundary.md +3 -3
package/docs/api/functions/createStandardDispatchBoundary.md +3 -3
package/docs/api/functions/createVault.md +1 -1
package/docs/api/functions/createVaultClient.md +2 -2
package/docs/api/functions/createVaultCore.md +4 -4
package/docs/api/functions/createVaultCoreDependencies.md +17 -0
package/docs/api/functions/createVaultService.md +6 -6
package/docs/api/functions/createWorkspaceStorage.md +1 -1
package/docs/api/functions/deriveIdentityId.md +1 -1
package/docs/api/functions/deriveVaultWorkingKeyFromPassword.md +24 -0
package/docs/api/functions/getDefaultWorkspaceDir.md +1 -1
package/docs/api/functions/handleVaultHttpDispatch.md +4 -4
package/docs/api/functions/initializeVaultCustody.md +1 -1
package/docs/api/functions/listVaults.md +3 -3
package/docs/api/functions/readVaultProfile.md +3 -3
package/docs/api/functions/recoverVault.md +1 -1
package/docs/api/functions/recoverVaultWorkingKey.md +1 -1
package/docs/api/functions/restoreIdentity.md +1 -1
package/docs/api/functions/updateVaultMetadata.md +7 -7
package/docs/api/functions/wrapVaultCoreAsVaultService.md +6 -6
package/docs/api/functions/writeVaultProfile.md +3 -3
package/docs/api/interfaces/AgentClient.md +3 -3
package/docs/api/interfaces/AgentDispatchIntent.md +1 -1
package/docs/api/interfaces/AgentDispatchTransport.md +4 -4
package/docs/api/interfaces/AgentIdentity.md +1 -1
package/docs/api/interfaces/AgentSigner.md +1 -1
package/docs/api/interfaces/CbioRuntime.md +48 -389
package/docs/api/interfaces/CreateAgentClientOptions.md +4 -4
package/docs/api/interfaces/CreateIdentityOptions.md +1 -5
package/docs/api/interfaces/CreatePersistentVaultCoreDependenciesOptions.md +9 -9
package/docs/api/interfaces/CreateVaultClientOptions.md +5 -5
package/docs/api/interfaces/CreateVaultOptions.md +16 -16
package/docs/api/interfaces/CreatedVault.md +3 -3
package/docs/api/interfaces/DefaultPolicyEngineOptions.md +3 -3
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 +10 -10
package/docs/api/interfaces/RecoveredVault.md +3 -3
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 +17 -27
package/docs/api/interfaces/{CreateDefaultVaultCoreDependenciesOptions.md → VaultCoreDependenciesOptions.md} +3 -3
package/docs/api/interfaces/VaultDeleteSecretInput.md +1 -1
package/docs/api/interfaces/VaultExportSecretInput.md +1 -1
package/docs/api/interfaces/VaultGrantCapabilityInput.md +2 -2
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/VaultObject.md +3 -3
package/docs/api/interfaces/VaultProfile.md +7 -11
package/docs/api/interfaces/VaultPublicMetadata.md +1 -1
package/docs/api/interfaces/VaultRegisterAgentInput.md +1 -1
package/docs/api/interfaces/VaultRegisterFlowInput.md +7 -7
package/docs/api/interfaces/VaultRevokeCapabilityInput.md +1 -1
package/docs/api/interfaces/VaultSigner.md +1 -1
package/docs/api/type-aliases/AgentCapabilityEnvelope.md +2 -2
package/docs/api/type-aliases/CbioRuntimeModule.md +1 -1
package/docs/api/variables/DEFAULT_VAULT_KEY_CUSTODY_BLOB_KEY.md +1 -1
package/package.json +1 -1
package/docs/api/classes/InMemoryReplayGuard.md +0 -45
package/docs/api/enumerations/AuditAction.md +0 -95
package/docs/api/enumerations/AuditOutcome.md +0 -29
package/docs/api/enumerations/DispatchStatus.md +0 -23
package/docs/api/functions/createChildIdentity.md +0 -25
package/docs/api/functions/createDefaultVaultCoreDependencies.md +0 -77
package/docs/api/functions/deriveChildIdentity.md +0 -41
package/docs/api/functions/ensureIdentityPrivateVault.md +0 -21
package/docs/api/functions/identityPrivateVaultChildrenKey.md +0 -17
package/docs/api/functions/identityPrivateVaultPrefix.md +0 -17
package/docs/api/functions/identityPrivateVaultProfileKey.md +0 -17
package/docs/api/functions/identityPrivateVaultPublicSealedKey.md +0 -17
package/docs/api/functions/listIdentities.md +0 -19
package/docs/api/functions/readIdentityMetadata.md +0 -29
package/docs/api/functions/readIdentityPrivateVaultChildrenState.md +0 -21
package/docs/api/functions/readIdentityPrivateVaultProfile.md +0 -21
package/docs/api/functions/readVaultPublicMetadata.md +0 -23
package/docs/api/functions/toOwnerHttpFlowBoundary.md +0 -17
package/docs/api/interfaces/AgentCapability.md +0 -103
package/docs/api/interfaces/AgentIdentityRecord.md +0 -23
package/docs/api/interfaces/AgentIdentityRegistry.md +0 -57
package/docs/api/interfaces/AgentProof.md +0 -29
package/docs/api/interfaces/AgentProofVerifier.md +0 -21
package/docs/api/interfaces/AuditEntry.md +0 -89
package/docs/api/interfaces/AuditLog.md +0 -37
package/docs/api/interfaces/AuditQuery.md +0 -29
package/docs/api/interfaces/CapabilityRegistry.md +0 -65
package/docs/api/interfaces/CapabilityRevocationRegistry.md +0 -53
package/docs/api/interfaces/ChildIdentity.md +0 -77
package/docs/api/interfaces/Clock.md +0 -15
package/docs/api/interfaces/CreateChildIdentityOptions.md +0 -19
package/docs/api/interfaces/CustomHttpFlowDefinition.md +0 -71
package/docs/api/interfaces/CustomHttpFlowRegistry.md +0 -41
package/docs/api/interfaces/DeriveIdentityOptions.md +0 -11
package/docs/api/interfaces/DispatchAuthorization.md +0 -35
package/docs/api/interfaces/DispatchInstruction.md +0 -47
package/docs/api/interfaces/DispatchRequest.md +0 -77
package/docs/api/interfaces/DispatchResult.md +0 -53
package/docs/api/interfaces/IdGenerator.md +0 -39
package/docs/api/interfaces/IdentityPrivateVaultChildRecord.md +0 -35
package/docs/api/interfaces/IdentityPrivateVaultChildrenState.md +0 -17
package/docs/api/interfaces/IdentityPrivateVaultProfile.md +0 -35
package/docs/api/interfaces/IssuerWriteSecretCommand.md +0 -59
package/docs/api/interfaces/OwnerAuditRequest.md +0 -47
package/docs/api/interfaces/OwnerDefineSecretTargetsCommand.md +0 -53
package/docs/api/interfaces/OwnerDeleteSecretCommand.md +0 -47
package/docs/api/interfaces/OwnerExportSecretRequest.md +0 -47
package/docs/api/interfaces/OwnerHttpFlowBoundary.md +0 -51
package/docs/api/interfaces/OwnerIdentityRecord.md +0 -23
package/docs/api/interfaces/OwnerIdentityRegistry.md +0 -57
package/docs/api/interfaces/OwnerListAgentsRequest.md +0 -41
package/docs/api/interfaces/OwnerListCapabilitiesRequest.md +0 -47
package/docs/api/interfaces/OwnerProof.md +0 -29
package/docs/api/interfaces/OwnerProofVerifier.md +0 -181
package/docs/api/interfaces/OwnerRegisterAgentIdentityCommand.md +0 -47
package/docs/api/interfaces/OwnerRegisterCapabilityCommand.md +0 -47
package/docs/api/interfaces/OwnerRegisterCustomHttpFlowCommand.md +0 -83
package/docs/api/interfaces/OwnerRevokeCapabilityCommand.md +0 -53
package/docs/api/interfaces/OwnerSecretExport.md +0 -35
package/docs/api/interfaces/OwnerWriteSecretCommand.md +0 -65
package/docs/api/interfaces/PolicyEngine.md +0 -81
package/docs/api/interfaces/RateLimitStore.md +0 -33
package/docs/api/interfaces/ReplayGuard.md +0 -21
package/docs/api/interfaces/SecretAlias.md +0 -11
package/docs/api/interfaces/SecretCustody.md +0 -57
package/docs/api/interfaces/SecretId.md +0 -11
package/docs/api/interfaces/SecretRecord.md +0 -53
package/docs/api/interfaces/SecretRepository.md +0 -69
package/docs/api/interfaces/SecretVersion.md +0 -11
package/docs/api/interfaces/SignatureAgentProofVerifierOptions.md +0 -21
package/docs/api/interfaces/TrustedExecutor.md +0 -31
package/docs/api/interfaces/VaultAcquireSecretInput.md +0 -53
package/docs/api/interfaces/VaultAcquireSecretResult.md +0 -41
package/docs/api/interfaces/VaultAgentDispatchErrorResponse.md +0 -25
package/docs/api/interfaces/VaultAgentDispatchRequest.md +0 -75
package/docs/api/interfaces/VaultAgentDispatchResponse.md +0 -17
package/docs/api/interfaces/VaultCore.md +0 -311
package/docs/api/interfaces/VaultCoreDependencies.md +0 -95
package/docs/api/interfaces/VaultCustomFlowResolver.md +0 -25
package/docs/api/interfaces/VaultId.md +0 -11
package/docs/api/interfaces/VaultPrincipal.md +0 -17
package/docs/api/interfaces/VaultService.md +0 -251
package/docs/api/interfaces/VaultTargetBinding.md +0 -35
package/docs/api/type-aliases/IdentityPrivateVaultAccess.md +0 -7
package/docs/api/type-aliases/RedactedResponseShape.md +0 -7
package/docs/api/type-aliases/VaultAcquireSecretFlow.md +0 -7
package/docs/api/type-aliases/VaultPrincipalKind.md +0 -7
package/docs/api/type-aliases/VaultWriteSecretCommand.md +0 -7

package/docs/api/interfaces/PolicyEngine.md DELETED Viewed

@@ -1,81 +0,0 @@
-[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
-***
-# Interface: PolicyEngine
-## Methods
-### authorizeDefineSecretTargets()
-> **authorizeDefineSecretTargets**(`command`): `Promise`\<`void`\>
-#### Parameters
-##### command
-[`OwnerDefineSecretTargetsCommand`](OwnerDefineSecretTargetsCommand.md)
-#### Returns
-`Promise`\<`void`\>
-***
-### authorizeDispatch()
-> **authorizeDispatch**(`request`, `record?`): `Promise`\<`void`\>
-#### Parameters
-##### request
-[`DispatchRequest`](DispatchRequest.md)
-##### record?
-[`SecretRecord`](SecretRecord.md) \| `null`
-#### Returns
-`Promise`\<`void`\>
-***
-### authorizeWrite()
-> **authorizeWrite**(`command`): `Promise`\<`void`\>
-#### Parameters
-##### command
-[`VaultWriteSecretCommand`](../type-aliases/VaultWriteSecretCommand.md)
-#### Returns
-`Promise`\<`void`\>
-***
-### revokeCapability()
-> **revokeCapability**(`vaultId`, `agentId`, `capabilityId`): `Promise`\<`number`\>
-#### Parameters
-##### vaultId
-[`VaultId`](VaultId.md)
-##### agentId
-`string`
-##### capabilityId
-`string`
-#### Returns
-`Promise`\<`number`\>

package/docs/api/interfaces/RateLimitStore.md DELETED Viewed

@@ -1,33 +0,0 @@
-[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
-***
-# Interface: RateLimitStore
-## Methods
-### consume()
-> **consume**(`key`, `maxRequests`, `windowMs`, `nowMs`): `Promise`\<`void`\>
-#### Parameters
-##### key
-`string`
-##### maxRequests
-`number`
-##### windowMs
-`number`
-##### nowMs
-`number`
-#### Returns
-`Promise`\<`void`\>

package/docs/api/interfaces/ReplayGuard.md DELETED Viewed

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

package/docs/api/interfaces/SecretAlias.md DELETED Viewed

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

package/docs/api/interfaces/SecretCustody.md DELETED Viewed

@@ -1,57 +0,0 @@
-[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
-***
-# Interface: SecretCustody
-## Methods
-### delete()
-> **delete**(`secretId`): `Promise`\<`void`\>
-#### Parameters
-##### secretId
-[`SecretId`](SecretId.md)
-#### Returns
-`Promise`\<`void`\>
-***
-### load()
-> **load**(`secretId`): `Promise`\<`string` \| `null`\>
-#### Parameters
-##### secretId
-[`SecretId`](SecretId.md)
-#### Returns
-`Promise`\<`string` \| `null`\>
-***
-### store()
-> **store**(`secretId`, `plaintext`): `Promise`\<`void`\>
-#### Parameters
-##### secretId
-[`SecretId`](SecretId.md)
-##### plaintext
-`string`
-#### Returns
-`Promise`\<`void`\>

package/docs/api/interfaces/SecretId.md DELETED Viewed

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

package/docs/api/interfaces/SecretRecord.md DELETED Viewed

@@ -1,53 +0,0 @@
-[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
-***
-# Interface: SecretRecord
-## Properties
-### alias
-> **alias**: [`SecretAlias`](SecretAlias.md)
-***
-### createdAt
-> **createdAt**: `string`
-***
-### issuerId
-> **issuerId**: `string` \| `null`
-***
-### secretId
-> **secretId**: [`SecretId`](SecretId.md)
-***
-### targetBindings
-> **targetBindings**: [`VaultTargetBinding`](VaultTargetBinding.md)[]
-***
-### updatedAt
-> **updatedAt**: `string`
-***
-### vaultId
-> **vaultId**: [`VaultId`](VaultId.md)
-***
-### version
-> **version**: [`SecretVersion`](SecretVersion.md)

package/docs/api/interfaces/SecretRepository.md DELETED Viewed

@@ -1,69 +0,0 @@
-[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
-***
-# Interface: SecretRepository
-## Methods
-### delete()
-> **delete**(`secretId`): `Promise`\<`void`\>
-#### Parameters
-##### secretId
-[`SecretId`](SecretId.md)
-#### Returns
-`Promise`\<`void`\>
-***
-### getByAlias()
-> **getByAlias**(`alias`): `Promise`\<[`SecretRecord`](SecretRecord.md) \| `null`\>
-#### Parameters
-##### alias
-[`SecretAlias`](SecretAlias.md)
-#### Returns
-`Promise`\<[`SecretRecord`](SecretRecord.md) \| `null`\>
-***
-### getById()
-> **getById**(`secretId`): `Promise`\<[`SecretRecord`](SecretRecord.md) \| `null`\>
-#### Parameters
-##### secretId
-[`SecretId`](SecretId.md)
-#### Returns
-`Promise`\<[`SecretRecord`](SecretRecord.md) \| `null`\>
-***
-### save()
-> **save**(`record`): `Promise`\<`void`\>
-#### Parameters
-##### record
-[`SecretRecord`](SecretRecord.md)
-#### Returns
-`Promise`\<`void`\>

package/docs/api/interfaces/SecretVersion.md DELETED Viewed

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

package/docs/api/interfaces/SignatureAgentProofVerifierOptions.md DELETED Viewed

@@ -1,21 +0,0 @@
-[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
-***
-# Interface: SignatureAgentProofVerifierOptions
-## Properties
-### maxSkewMs?
-> `optional` **maxSkewMs?**: `number`
-***
-### now?
-> `optional` **now?**: () => `Date`
-#### Returns
-`Date`

package/docs/api/interfaces/TrustedExecutor.md DELETED Viewed

@@ -1,31 +0,0 @@
-[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
-***
-# Interface: TrustedExecutor
-## Methods
-### dispatch()
-> **dispatch**(`instruction`, `secret`): `Promise`\<[`DispatchResult`](DispatchResult.md)\>
-#### Parameters
-##### instruction
-[`DispatchInstruction`](DispatchInstruction.md)
-##### secret
-###### plaintext
-`string`
-###### record
-[`SecretRecord`](SecretRecord.md)
-#### Returns
-`Promise`\<[`DispatchResult`](DispatchResult.md)\>

package/docs/api/interfaces/VaultAcquireSecretInput.md DELETED Viewed

@@ -1,53 +0,0 @@
-[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
-***
-# Interface: VaultAcquireSecretInput
-## Properties
-### alias
-> **alias**: `string`
-***
-### body?
-> `optional` **body?**: `string`
-***
-### flow
-> **flow**: [`VaultAcquireSecretFlow`](../type-aliases/VaultAcquireSecretFlow.md)
-***
-### headers?
-> `optional` **headers?**: `Record`\<`string`, `string`\>
-***
-### issuerId
-> **issuerId**: `string`
-***
-### method?
-> `optional` **method?**: `string`
-***
-### requestedAt?
-> `optional` **requestedAt?**: `string`
-***
-### url
-> **url**: `string`

package/docs/api/interfaces/VaultAcquireSecretResult.md DELETED Viewed

@@ -1,41 +0,0 @@
-[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
-***
-# Interface: VaultAcquireSecretResult
-## Properties
-### alias
-> **alias**: `string`
-***
-### contentType
-> **contentType**: `string` \| `null`
-***
-### responseShape
-> **responseShape**: [`RedactedResponseShape`](../type-aliases/RedactedResponseShape.md)
-***
-### responseStatus
-> **responseStatus**: `number`
-***
-### status
-> **status**: `"stored"`
-***
-### vaultId
-> **vaultId**: [`VaultId`](VaultId.md)

package/docs/api/interfaces/VaultAgentDispatchErrorResponse.md DELETED Viewed

@@ -1,25 +0,0 @@
-[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
-***
-# Interface: VaultAgentDispatchErrorResponse
-## Properties
-### error
-> **error**: `object`
-#### code
-> **code**: `string`
-#### message
-> **message**: `string`
-***
-### ok
-> **ok**: `false`

package/docs/api/interfaces/VaultAgentDispatchRequest.md DELETED Viewed

@@ -1,75 +0,0 @@
-[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
-***
-# Interface: VaultAgentDispatchRequest
-## Properties
-### agentId
-> **agentId**: `string`
-***
-### body?
-> `optional` **body?**: `string`
-***
-### capabilityId
-> **capabilityId**: `string`
-***
-### headers?
-> `optional` **headers?**: `Record`\<`string`, `string`\>
-***
-### method
-> **method**: `string`
-***
-### proof
-> **proof**: `object`
-#### signature
-> **signature**: `string`
-***
-### requestedAt
-> **requestedAt**: `string`
-***
-### requestId
-> **requestId**: `string`
-***
-### secretAlias?
-> `optional` **secretAlias?**: `string`
-***
-### targetUrl
-> **targetUrl**: `string`
-***
-### vaultId
-> **vaultId**: `string`

package/docs/api/interfaces/VaultAgentDispatchResponse.md DELETED Viewed

@@ -1,17 +0,0 @@
-[**CBIO Node Runtime Agent API v1.45.5**](../README.md)
-***
-# Interface: VaultAgentDispatchResponse
-## Properties
-### ok
-> **ok**: `true`
-***
-### result
-> **result**: [`DispatchResult`](DispatchResult.md)