KeyRepository

@hyperledger/identus-sdk v8.1.3

---

@hyperledger/identus-sdk / overview / KeyRepository

Class: KeyRepository

Defined in: packages/lib/sdk/src/pluto/repositories/KeyRepository.ts:8

MapperRepository

Extends BaseRepository to handle Store interactions while mapping between a Domain class and a Model object

Extends

• MapperRepository<"keys", PrivateKey>

Constructors

Constructor

new KeyRepository(store: Store, keyRestoration: KeyRestoration): KeyRepository

Defined in: packages/lib/sdk/src/pluto/repositories/KeyRepository.ts:9

Parameters

Parameter	Type
store	Store
keyRestoration	KeyRestoration

Returns

KeyRepository

Overrides

MapperRepository.constructor

Methods

byUUID()

byUUID(uuid: string): Promise<PrivateKey | null>

Defined in: packages/lib/sdk/src/pluto/repositories/builders/MapperRepository.ts:75

Utility fn for common use of find with uuid

Parameters

Parameter	Type	Description
uuid	string	-

Returns

Promise<PrivateKey | null>

first found Domain instance or undefined

Throws

Domain.PlutoError.StoreQueryFailed if the query fails

Inherited from

MapperRepository.byUUID

---

delete()

delete(uuid: string): Promise<void>

Defined in: packages/lib/sdk/src/pluto/repositories/builders/BaseRepository.ts:53

Parameters

Parameter	Type
uuid	string

Returns

Promise<void>

Inherited from

MapperRepository.delete

---

find()

find(selector?: Partial<Key>): Promise<PrivateKey[]>

Defined in: packages/lib/sdk/src/pluto/repositories/builders/MapperRepository.ts:48

Search for instances based on given values

Parameters

Parameter	Type	Description
selector?	Partial<Key>	object with matchable properties

Returns

Promise<PrivateKey[]>

all found Domain instances

Throws

Domain.PlutoError.StoreQueryFailed if the query fails

Inherited from

MapperRepository.find

---

findOne()

findOne(selector?: Partial<Key>): Promise<PrivateKey | null>

Defined in: packages/lib/sdk/src/pluto/repositories/builders/MapperRepository.ts:61

Search for single instance based on given values

Parameters

Parameter	Type	Description
selector?	Partial<Key>	object with matchable properties

Returns

Promise<PrivateKey | null>

first found Domain instance or null

Throws

Domain.PlutoError.StoreQueryFailed if the query fails

Inherited from

MapperRepository.findOne

---

get()

get(query?: Query<TypedSchema<Key>>): Promise<PrivateKey[]>

Defined in: packages/lib/sdk/src/pluto/repositories/builders/MapperRepository.ts:36

Search the Store, mapping any found to Domain

Parameters

Parameter	Type	Description
query?	Query<TypedSchema<Key>>	either an object or array of objects with matchable properties

Returns

Promise<PrivateKey[]>

Array of matched Domain instances

Throws

Domain.PlutoError.StoreQueryFailed if the query fails

Inherited from

MapperRepository.get

---

getModels()

getModels(query?: Query<TypedSchema<Key>>): Promise<Key[]>

Defined in: packages/lib/sdk/src/pluto/repositories/KeyRepository.ts:16

Search the Store for Models

Parameters

Parameter	Type	Description
query?	Query<TypedSchema<Key>>	a Query object, a set of values and operators defining the query

Returns

Promise<Key[]>

Array of matched Models

See

../types.ts

Examples

search for a model with uuid and name

  repo.getModels({ selector: { uuid: "1", name: "eg" }})

search for models with uuid of 1 or 2

  repo.getModels({ selector: { $or: [{ uuid: "1" }, { uuid: "2" }] }})

search for all models

  repo.getModels()

Throws

Domain.Models if the query fails

Overrides

MapperRepository.getModels

---

insert()

insert(model: Key): Promise<Key>

Defined in: packages/lib/sdk/src/pluto/repositories/builders/BaseRepository.ts:32

Persist the Model in the Store.

Parameters

Parameter	Type	Description
model	Key	-

Returns

Promise<Key>

Throws

Domain.PlutoError.StoreInsertError if insert fails

Inherited from

MapperRepository.insert

---

save()

save(domain: PrivateKey): Promise<void>

Defined in: packages/lib/sdk/src/pluto/repositories/builders/MapperRepository.ts:88

Persist the Domain instance in the Store.

Parameters

Parameter	Type	Description
domain	PrivateKey	Will be mapped to relevant Model for persistance

Returns

Promise<void>

See

BaseRepository.insert

Throws

Domain.PlutoError.StoreInsertError if insert fails

Inherited from

MapperRepository.save

---

toDomain()

toDomain(model: Key): PrivateKey

Defined in: packages/lib/sdk/src/pluto/repositories/KeyRepository.ts:23

Map from a Model to the Domain class

Parameters

Parameter	Type	Description
model	Key	the stored Model with a uuid

Returns

PrivateKey

Domain with uuid set

Overrides

MapperRepository.toDomain

---

toModel()

toModel(domain: PrivateKey): Key

Defined in: packages/lib/sdk/src/pluto/repositories/KeyRepository.ts:34

Map from a Domain class to a Model

Parameters

Parameter	Type	Description
domain	PrivateKey	may be missing uuid

Returns

Key

Model potentially without uuid

Overrides

MapperRepository.toModel

---

update()

update(model: Key): Promise<void>

Defined in: packages/lib/sdk/src/pluto/repositories/builders/BaseRepository.ts:44

Parameters

Parameter	Type
model	Key

Returns

Promise<void>

Inherited from

MapperRepository.update