Function: useDatabase()

typescript
1
useDatabase(): object

Defined in: packages/identus-react/src/hooks/useDatabase.ts:16

Hook for accessing database context and operations.

Provides comprehensive database functionality including DID management, message handling, credential storage, and application settings. This hook must be used within a DatabaseProvider.

Returns

Database context

createIssuanceFlow()

typescript
1
createIssuanceFlow: (issuanceFlow) => Promise<void>

Create a new issuance flow

Parameters

issuanceFlow

Doc<{ encrypted: string[]; primaryKey: string; properties: { automaticIssuance: { type: "boolean"; }; claims: { items: { properties: { name: { required: true; type: "string"; }; type: { required: true; type: "string"; }; value: { required: true; type: "string"; }; }; type: "object"; }; type: "array"; }; credentialFormat: { required: true; type: "string"; }; id: { required: true; type: "string"; }; issuingDID: { required: true; type: "string"; }; }; type: "object"; version: 0; }>

Returns

Promise<void>

db

typescript
1
db: RIDB<{ credential-metadata: Omit<{ encrypted: ("recoveryId" | "dataJson" | "name")[]; indexes?: string[]; primaryKey: string; properties: { dataJson: { required: true; type: "string"; }; name: { required: true; type: "string"; }; recoveryId: { required: true; type: "string"; }; uuid: { maxLength: 60; required: true; type: "string"; }; }; type: string; version: number; }, "version"> & object; credentials: Omit<{ encrypted: ("recoveryId" | "revoked" | "dataJson" | "issuer" | "subject" | "credentialCreated" | "credentialUpdated" | "credentialSchema" | "validUntil" | "id")[]; indexes?: string[]; primaryKey: string; properties: { credentialCreated: { type: "string"; }; credentialSchema: { type: "string"; }; credentialUpdated: { type: "string"; }; dataJson: { required: true; type: "string"; }; id: { required: true; type: "string"; }; issuer: { type: "string"; }; recoveryId: { required: true; type: "string"; }; revoked: { type: "boolean"; }; subject: { type: "string"; }; uuid: { maxLength: 60; required: true; type: "string"; }; validUntil: { type: "number"; }; }; type: string; version: number; }, "properties"> & object; did-link: Omit<{ encrypted: ("alias" | "role" | "hostId" | "targetId")[]; indexes?: string[]; primaryKey: string; properties: { alias: { type: "string"; }; hostId: { required: true; type: "string"; }; role: { required: true; type: "number"; }; targetId: { required: true; type: "string"; }; uuid: { maxLength: 60; required: true; type: "string"; }; }; type: string; version: number; }, "version"> & object; didkey-link: Omit<{ encrypted: ("alias" | "didId" | "keyId")[]; indexes?: string[]; primaryKey: string; properties: { alias: { type: "string"; }; didId: { required: true; type: "string"; }; keyId: { required: true; type: "string"; }; uuid: { maxLength: 60; required: true; type: "string"; }; }; type: string; version: number; }, "version"> & object; dids: Omit<{ encrypted: ("schema" | "alias" | "method")[]; indexes?: string[]; primaryKey: string; properties: { alias: { type: "string"; }; method: { required: true; type: "string"; }; schema: { required: true; type: "string"; }; uuid: { maxLength: 60; required: true; type: "string"; }; }; type: string; version: number; }, "properties"> & object; issuance: { encrypted: string[]; primaryKey: string; properties: { automaticIssuance: { type: "boolean"; }; claims: { items: { properties: { name: { required: true; type: "string"; }; type: { required: true; type: "string"; }; value: { required: true; type: "string"; }; }; type: "object"; }; type: "array"; }; credentialFormat: { required: true; type: "string"; }; id: { required: true; type: "string"; }; issuingDID: { required: true; type: "string"; }; }; type: "object"; version: 0; }; keys: Omit<{ encrypted: ("recoveryId" | "alias" | "index" | "rawHex")[]; indexes?: string[]; primaryKey: string; properties: { alias: { type: "string"; }; index: { type: "number"; }; rawHex: { required: true; type: "string"; }; recoveryId: { required: true; type: "string"; }; uuid: { maxLength: 60; required: true; type: "string"; }; }; type: string; version: number; }, "version"> & object; messages: Omit<{ encrypted: ("dataJson" | "id" | "to" | "createdTime" | "thid" | "piuri" | "from" | "isReceived")[]; indexes?: string[]; primaryKey: string; properties: { createdTime: { required: true; type: "number"; }; dataJson: { required: true; type: "string"; }; from: { type: "string"; }; id: { required: true; type: "string"; }; isReceived: { required: true; type: "number"; }; piuri: { required: true; type: "string"; }; thid: { type: "string"; }; to: { type: "string"; }; uuid: { maxLength: 60; required: true; type: "string"; }; }; type: string; version: number; }, "properties"> & object; settings: { encrypted: string[]; primaryKey: string; properties: { id: { required: true; type: "string"; }; key: { required: true; type: "string"; }; value: { required: true; type: "string"; }; }; type: "object"; version: 0; }; }>

RIDB database instance

deleteCredential()

typescript
1
deleteCredential: (credential) => Promise<void>

Delete a credential

Parameters

credential

Credential

Returns

Promise<void>

deleteIssuanceFlow()

typescript
1
deleteIssuanceFlow: (id) => Promise<void>

Delete an issuance flow

Parameters

id

string

Returns

Promise<void>

deleteMessage()

typescript
1
deleteMessage: (message) => Promise<void>

Delete a message

Parameters

message

Message

Returns

Promise<void>

deleteSettingsByKey()

typescript
1
deleteSettingsByKey: (key) => Promise<void>

Delete application setting by key

Parameters

key

string

Returns

Promise<void>

error

typescript
1
error: null | Error

Current error, if any

features

typescript
1
features: string[]

Available database features

getCredentials()

typescript
1
getCredentials: () => Promise<Credential[]>

Get all credentials

Returns

Promise<Credential[]>

getExtendedDIDs()

typescript
1
getExtendedDIDs: () => Promise<object[]>

Get all DIDs with extended metadata

Returns

Promise<object[]>

getFeatures()

typescript
1
getFeatures: () => Promise<void>

Load available database features

Returns

Promise<void>

getGroupedDIDs()

typescript
1
getGroupedDIDs: () => Promise<GroupedDIDs>

Get DIDs grouped by status/type

Returns

Promise<GroupedDIDs>

getIssuanceFlow()

typescript
1
getIssuanceFlow: (id) => Promise<null | Doc<{ encrypted: string[]; primaryKey: string; properties: { automaticIssuance: { type: "boolean"; }; claims: { items: { properties: { name: { required: ...; type: ...; }; type: { required: ...; type: ...; }; value: { required: ...; type: ...; }; }; type: "object"; }; type: "array"; }; credentialFormat: { required: true; type: "string"; }; id: { required: true; type: "string"; }; issuingDID: { required: true; type: "string"; }; }; type: "object"; version: 0; }>>

Get a specific issuance flow by ID

Parameters

id

string

Returns

Promise<null | Doc<{ encrypted: string[]; primaryKey: string; properties: { automaticIssuance: { type: "boolean"; }; claims: { items: { properties: { name: { required: ...; type: ...; }; type: { required: ...; type: ...; }; value: { required: ...; type: ...; }; }; type: "object"; }; type: "array"; }; credentialFormat: { required: true; type: "string"; }; id: { required: true; type: "string"; }; issuingDID: { required: true; type: "string"; }; }; type: "object"; version: 0; }>>

getIssuanceFlows()

typescript
1
getIssuanceFlows: () => Promise<Doc<{ encrypted: string[]; primaryKey: string; properties: { automaticIssuance: { type: "boolean"; }; claims: { items: { properties: { name: { required: ...; type: ...; }; type: { required: ...; type: ...; }; value: { required: ...; type: ...; }; }; type: "object"; }; type: "array"; }; credentialFormat: { required: true; type: "string"; }; id: { required: true; type: "string"; }; issuingDID: { required: true; type: "string"; }; }; type: "object"; version: 0; }>[]>

Get all issuance flows

Returns

Promise<Doc<{ encrypted: string[]; primaryKey: string; properties: { automaticIssuance: { type: "boolean"; }; claims: { items: { properties: { name: { required: ...; type: ...; }; type: { required: ...; type: ...; }; value: { required: ...; type: ...; }; }; type: "object"; }; type: "array"; }; credentialFormat: { required: true; type: "string"; }; id: { required: true; type: "string"; }; issuingDID: { required: true; type: "string"; }; }; type: "object"; version: 0; }>[]>

getMediator()

typescript
1
getMediator: () => Promise<null | DID>

Get current mediator DID

Returns

Promise<null | DID>

getMessages()

typescript
1
getMessages: () => Promise<object[]>

Retrieve all messages with read status

Returns

Promise<object[]>

getResolverUrl()

typescript
1
getResolverUrl: () => Promise<null | string>

Get DID resolver URL

Returns

Promise<null | string>

getSeed()

typescript
1
getSeed: () => Promise<null | Seed>

Get wallet seed

Returns

Promise<null | Seed>

getSettingsByKey()

typescript
1
getSettingsByKey: (key) => Promise<null | string>

Get application setting by key

Parameters

key

string

Returns

Promise<null | string>

getWallet()

typescript
1
getWallet: () => Promise<null | string>

Get wallet identifier

Returns

Promise<null | string>

pluto

typescript
1
pluto: Pluto

Pluto storage instance

readMessage()

typescript
1
readMessage: (message) => Promise<void>

Mark a message as read

Parameters

message

Message

Returns

Promise<void>

setMediator()

typescript
1
setMediator: (mediator) => Promise<void>

Set mediator DID

Parameters

mediator

null | DID

Returns

Promise<void>

setResolverUrl()

typescript
1
setResolverUrl: (resolverUrl) => Promise<void>

Set DID resolver URL

Parameters

resolverUrl

null | string

Returns

Promise<void>

setSeed()

typescript
1
setSeed: (seed) => Promise<Seed>

Set wallet seed

Parameters

seed

Seed

Returns

Promise<Seed>

setWallet()

typescript
1
setWallet: (wallet) => Promise<void>

Set wallet identifier

Parameters

wallet

null | string

Returns

Promise<void>

start()

typescript
1
start: (options) => Promise<void>

Function to start/initialize the database

Parameters

options

StartOptions<{ credential-metadata: Omit<{ encrypted: ("recoveryId" | "dataJson" | "name")[]; indexes?: string[]; primaryKey: string; properties: { dataJson: { required: true; type: "string"; }; name: { required: true; type: "string"; }; recoveryId: { required: true; type: "string"; }; uuid: { maxLength: 60; required: true; type: "string"; }; }; type: string; version: number; }, "version"> & object; credentials: Omit<{ encrypted: ("recoveryId" | "revoked" | "dataJson" | "issuer" | "subject" | "credentialCreated" | "credentialUpdated" | "credentialSchema" | "validUntil" | "id")[]; indexes?: string[]; primaryKey: string; properties: { credentialCreated: { type: "string"; }; credentialSchema: { type: "string"; }; credentialUpdated: { type: "string"; }; dataJson: { required: true; type: "string"; }; id: { required: true; type: "string"; }; issuer: { type: "string"; }; recoveryId: { required: true; type: "string"; }; revoked: { type: "boolean"; }; subject: { type: "string"; }; uuid: { maxLength: 60; required: true; type: "string"; }; validUntil: { type: "number"; }; }; type: string; version: number; }, "properties"> & object; did-link: Omit<{ encrypted: ("alias" | "role" | "hostId" | "targetId")[]; indexes?: string[]; primaryKey: string; properties: { alias: { type: "string"; }; hostId: { required: true; type: "string"; }; role: { required: true; type: "number"; }; targetId: { required: true; type: "string"; }; uuid: { maxLength: 60; required: true; type: "string"; }; }; type: string; version: number; }, "version"> & object; didkey-link: Omit<{ encrypted: ("alias" | "didId" | "keyId")[]; indexes?: string[]; primaryKey: string; properties: { alias: { type: "string"; }; didId: { required: true; type: "string"; }; keyId: { required: true; type: "string"; }; uuid: { maxLength: 60; required: true; type: "string"; }; }; type: string; version: number; }, "version"> & object; dids: Omit<{ encrypted: ("schema" | "alias" | "method")[]; indexes?: string[]; primaryKey: string; properties: { alias: { type: "string"; }; method: { required: true; type: "string"; }; schema: { required: true; type: "string"; }; uuid: { maxLength: 60; required: true; type: "string"; }; }; type: string; version: number; }, "properties"> & object; issuance: { encrypted: string[]; primaryKey: string; properties: { automaticIssuance: { type: "boolean"; }; claims: { items: { properties: { name: { required: true; type: "string"; }; type: { required: true; type: "string"; }; value: { required: true; type: "string"; }; }; type: "object"; }; type: "array"; }; credentialFormat: { required: true; type: "string"; }; id: { required: true; type: "string"; }; issuingDID: { required: true; type: "string"; }; }; type: "object"; version: 0; }; keys: Omit<{ encrypted: ("recoveryId" | "alias" | "index" | "rawHex")[]; indexes?: string[]; primaryKey: string; properties: { alias: { type: "string"; }; index: { type: "number"; }; rawHex: { required: true; type: "string"; }; recoveryId: { required: true; type: "string"; }; uuid: { maxLength: 60; required: true; type: "string"; }; }; type: string; version: number; }, "version"> & object; messages: Omit<{ encrypted: ("dataJson" | "id" | "to" | "createdTime" | "thid" | "piuri" | "from" | "isReceived")[]; indexes?: string[]; primaryKey: string; properties: { createdTime: { required: true; type: "number"; }; dataJson: { required: true; type: "string"; }; from: { type: "string"; }; id: { required: true; type: "string"; }; isReceived: { required: true; type: "number"; }; piuri: { required: true; type: "string"; }; thid: { type: "string"; }; to: { type: "string"; }; uuid: { maxLength: 60; required: true; type: "string"; }; }; type: string; version: number; }, "properties"> & object; settings: { encrypted: string[]; primaryKey: string; properties: { id: { required: true; type: "string"; }; key: { required: true; type: "string"; }; value: { required: true; type: "string"; }; }; type: "object"; version: 0; }; }>

Returns

Promise<void>

state

typescript
1
state: DatabaseState

Current database connection state

storeDID()

typescript
1
storeDID: (did, keys, alias) => Promise<void>

Store a DID with associated keys and alias

Parameters

did

DID

keys

PrivateKey[]

alias

string

Returns

Promise<void>

storeSettingsByKey()

typescript
1
storeSettingsByKey: (key, value) => Promise<void>

Store application setting by key

Parameters

key

string

value

string

Returns

Promise<void>

updateDIDStatus()

typescript
1
updateDIDStatus: (did, status) => Promise<void>

Update the status of a DID

Parameters

did

DID

status

string

Returns

Promise<void>

updateIssuanceFlow()

typescript
1
updateIssuanceFlow: (issuanceFlow) => Promise<void>

Update an existing issuance flow

Parameters

issuanceFlow

Doc<{ encrypted: string[]; primaryKey: string; properties: { automaticIssuance: { type: "boolean"; }; claims: { items: { properties: { name: { required: true; type: "string"; }; type: { required: true; type: "string"; }; value: { required: true; type: "string"; }; }; type: "object"; }; type: "array"; }; credentialFormat: { required: true; type: "string"; }; id: { required: true; type: "string"; }; issuingDID: { required: true; type: "string"; }; }; type: "object"; version: 0; }>

Returns

Promise<void>

wallet

typescript
1
wallet: null | string

Current wallet identifier

Throws

When used outside of DatabaseProvider