Skip to main content

@hyperledger/identus-sdk / Exports / Domain

Namespace: Domain

Table of contents​

References​

Namespaces​

Enumerations​

Classes​

Interfaces​

Type Aliases​

Functions​

References​

KeyRestoration​

Re-exports KeyRestoration

Startable​

Re-exports Startable

Type Aliases​

AttachmentData​

Ƭ AttachmentData: AttachmentJsonData | AttachmentLinkData | AttachmentBase64 | AttachmentJwsData | AttachmentJws | AttachmentHeader

Defined in​

src/domain/models/MessageAttachment.ts:32

AttachmentJsonData​

Ƭ AttachmentJsonData: Object

Type declaration​

NameType
jsonany

Defined in​

src/domain/models/MessageAttachment.ts:28

DIDDocumentCoreProperty​

Ƭ DIDDocumentCoreProperty: Service | AlsoKnownAs | Controller | VerificationMethods | Services | Authentication | AssertionMethod | KeyAgreement | CapabilityInvocation | CapabilityDelegation

Defined in​

src/domain/models/DIDDocument.ts:99

ExportableKey​

Ƭ ExportableKey: All

ExportableKey defines the formats a crypographic key can be converted to Default is all

Defined in​

src/domain/models/keyManagement/exportable/ExportableKey.ts:12

src/domain/models/keyManagement/exportable/ExportableKey.ts:24

HttpMethod​

Ƭ HttpMethod: "DELETE" | "GET" | "POST" | "PUT"

Defined in​

src/domain/models/Api.ts:1

JWK​

Ƭ JWK: EC | OCT | OKP | RSA

JWK

Defined in​

src/domain/models/keyManagement/exportable/JWK.ts:11

src/domain/models/keyManagement/exportable/JWK.ts:17

JsonString​

Ƭ JsonString: string

Defined in​

src/domain/models/index.ts:23

MnemonicWordList​

Ƭ MnemonicWordList: [string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string]

Defined in​

src/domain/models/WordList.ts:1

PresentationClaims​

Ƭ PresentationClaims<T>: T extends JWT ? OEA.JWTPresentationClaims : T extends SDJWT ? OEA.SDJWTPresentationClaims : T extends AnonCreds ? ACClaims : never

Type parameters​

NameType
Textends CredentialType = JWT

Defined in​

src/domain/models/VerifiableCredential.ts:5

W3CVerifiableCredential​

Ƭ W3CVerifiableCredential: Object

Type declaration​

NameType
@context[credential]
credentialSchema?{ id: string ; type: string }
credentialSchema.idstring
credentialSchema.typestring
credentialStatus?unknown
credentialSubjectRecord<string, any>
evidence?{ id: string ; type: string }
evidence.idstring
evidence.typestring
expirationDate?string
issuanceDatestring
issued?string
issuerstring
refreshService?{ id: string ; type: string }
refreshService.idstring
refreshService.typestring
termsOfUse?{ id: string ; type: string }
termsOfUse.idstring
termsOfUse.typestring
type[credential]
validFrom?{ id: string ; type: string }
validFrom.idstring
validFrom.typestring
validUntil?{ id: string ; type: string }
validUntil.idstring
validUntil.typestring

Defined in​

src/domain/models/VerifiableCredential.ts:38

W3CVerifiablePresentation​

Ƭ W3CVerifiablePresentation: Object

Type declaration​

NameType
@context[credential]
proof?W3CVerifiablePresentationProof
type[presentation]
verifiableCredentialstring[]

Defined in​

src/domain/models/VerifiableCredential.ts:74

W3CVerifiablePresentationProof​

Ƭ W3CVerifiablePresentationProof: Object

Type declaration​

NameType
challengestring
domainstring

Defined in​

src/domain/models/VerifiableCredential.ts:85

Functions​

curveToAlg​

▸ curveToAlg(curve): JWT_ALG

Parameters​

NameType
curvestring

Returns​

JWT_ALG

Defined in​

src/domain/models/keyManagement/Key.ts:190

getKeyCurveByNameAndIndex​

▸ getKeyCurveByNameAndIndex(name, index?): KeyCurve

Parameters​

NameType
namestring
index?number

Returns​

KeyCurve

Defined in​

src/domain/models/keyManagement/Key.ts:199

getProtosUsage​

▸ getProtosUsage(usage): KeyUsage

Parameters​

NameType
usageUsage

Returns​

KeyUsage

Defined in​

src/domain/models/keyManagement/Key.ts:24

getUsage​

▸ getUsage(protosUsage): Usage

Parameters​

NameType
protosUsageKeyUsage

Returns​

Usage

Defined in​

src/domain/models/keyManagement/Key.ts:144

getUsageFromId​

▸ getUsageFromId(id): Object

Return usage from a verification method id

Parameters​

NameType
idstring

Returns​

Object

NameType
indexnumber
usageUsage

Defined in​

src/domain/models/keyManagement/Key.ts:57

getUsageId​

▸ getUsageId(keyUsage, index?): string

create an identifier for keys within a DID Document should be unique within the Document

Parameters​

NameTypeDefault valueDescription
keyUsageUsageundefinedmaps to a prefix word
indexnumber0occurrence of this keyUsage

Returns​

string

Defined in​

src/domain/models/keyManagement/Key.ts:123