From 49f717e93352108efc8a6c55231fcea4ee8b4e6b Mon Sep 17 00:00:00 2001 From: Simonas Karuzas Date: Thu, 13 Aug 2020 16:47:32 +0300 Subject: [PATCH] docs: Generated reports --- report/daf-core.api.md | 887 ++++++++++++------------- report/daf-did-comm.api.md | 60 ++ report/daf-selective-disclosure.api.md | 171 +++-- report/daf-typeorm.api.md | 668 +++++++++---------- report/daf-url.api.md | 17 +- report/daf-w3c.api.md | 105 ++- 6 files changed, 931 insertions(+), 977 deletions(-) create mode 100644 report/daf-did-comm.api.md diff --git a/report/daf-core.api.md b/report/daf-core.api.md index dfdcc18b2..650f858b2 100644 --- a/report/daf-core.api.md +++ b/report/daf-core.api.md @@ -3,655 +3,640 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { DIDDocument } from 'did-resolver' -import { EventEmitter } from 'events' -import { Verifiable } from 'did-jwt-vc' -import { W3CCredential } from 'did-jwt-vc' -import { W3CPresentation } from 'did-jwt-vc' + +import { DIDDocument } from 'did-resolver'; +import { EventEmitter } from 'events'; +import { Verifiable } from 'did-jwt-vc'; +import { W3CCredential } from 'did-jwt-vc'; +import { W3CPresentation } from 'did-jwt-vc'; // @public (undocumented) export abstract class AbstractIdentityProvider { - // (undocumented) - abstract addKey( - args: { - identity: IIdentity - key: IKey - options?: any - }, - context: IAgentContext, - ): Promise - // (undocumented) - abstract addService( - args: { - identity: IIdentity - service: IService - options?: any - }, - context: IAgentContext, - ): Promise - // (undocumented) - abstract createIdentity( - args: { - kms?: string - alias?: string - options?: any - }, - context: IAgentContext, - ): Promise> - // (undocumented) - abstract deleteIdentity(args: IIdentity, context: IAgentContext): Promise - // (undocumented) - abstract removeKey( - args: { - identity: IIdentity - kid: string - options?: any - }, - context: IAgentContext, - ): Promise - // (undocumented) - abstract removeService( - args: { - identity: IIdentity - id: string - options?: any - }, - context: IAgentContext, - ): Promise + // (undocumented) + abstract addKey(args: { + identity: IIdentity; + key: IKey; + options?: any; + }, context: IAgentContext): Promise; + // (undocumented) + abstract addService(args: { + identity: IIdentity; + service: IService; + options?: any; + }, context: IAgentContext): Promise; + // (undocumented) + abstract createIdentity(args: { + kms?: string; + alias?: string; + options?: any; + }, context: IAgentContext): Promise>; + // (undocumented) + abstract deleteIdentity(args: IIdentity, context: IAgentContext): Promise; + // (undocumented) + abstract removeKey(args: { + identity: IIdentity; + kid: string; + options?: any; + }, context: IAgentContext): Promise; + // (undocumented) + abstract removeService(args: { + identity: IIdentity; + id: string; + options?: any; + }, context: IAgentContext): Promise; } // @public (undocumented) export abstract class AbstractIdentityStore { - // (undocumented) - abstract delete(args: { did: string }): Promise - // (undocumented) - abstract get(args: { did: string }): Promise - // (undocumented) - abstract get(args: { alias: string }): Promise - // (undocumented) - abstract import(args: IIdentity): Promise - // (undocumented) - abstract list(): Promise + // (undocumented) + abstract delete(args: { + did: string; + }): Promise; + // (undocumented) + abstract get(args: { + did: string; + }): Promise; + // (undocumented) + abstract get(args: { + alias: string; + }): Promise; + // (undocumented) + abstract import(args: IIdentity): Promise; + // (undocumented) + abstract list(): Promise; } // @public (undocumented) export abstract class AbstractKeyManagementSystem { - // (undocumented) - abstract createKey(args: { type: TKeyType; meta?: any }): Promise> - // (undocumented) - abstract decryptJWE(args: { key: IKey; data: string }): Promise - // (undocumented) - abstract deleteKey(args: { kid: string }): Promise - // (undocumented) - abstract encryptJWE(args: { key: IKey; to: Omit; data: string }): Promise - // (undocumented) - abstract signEthTX(args: { key: IKey; transaction: object }): Promise - // (undocumented) - abstract signJWT(args: { key: IKey; data: string }): Promise + // (undocumented) + abstract createKey(args: { + type: TKeyType; + meta?: any; + }): Promise>; + // (undocumented) + abstract decryptJWE(args: { + key: IKey; + data: string; + }): Promise; + // (undocumented) + abstract deleteKey(args: { + kid: string; + }): Promise; + // (undocumented) + abstract encryptJWE(args: { + key: IKey; + to: Omit; + data: string; + }): Promise; + // (undocumented) + abstract signEthTX(args: { + key: IKey; + transaction: object; + }): Promise; + // (undocumented) + abstract signJWT(args: { + key: IKey; + data: string; + }): Promise; } // @public (undocumented) export abstract class AbstractKeyStore { - // (undocumented) - abstract delete(args: { kid: string }): Promise - // (undocumented) - abstract get(args: { kid: string }): Promise - // (undocumented) - abstract import(args: IKey): Promise + // (undocumented) + abstract delete(args: { + kid: string; + }): Promise; + // (undocumented) + abstract get(args: { + kid: string; + }): Promise; + // (undocumented) + abstract import(args: IKey): Promise; } // @public (undocumented) export abstract class AbstractMessageHandler { - // (undocumented) - handle(message: Message, context: IAgentContext<{}>): Promise - // (undocumented) - nextMessageHandler?: AbstractMessageHandler - // (undocumented) - setNext(messageHandler: AbstractMessageHandler): AbstractMessageHandler + // (undocumented) + handle(message: Message, context: IAgentContext<{}>): Promise; + // (undocumented) + nextMessageHandler?: AbstractMessageHandler; + // (undocumented) + setNext(messageHandler: AbstractMessageHandler): AbstractMessageHandler; } // @public (undocumented) export abstract class AbstractSecretBox { - // (undocumented) - abstract decrypt(encryptedMessageHex: string): Promise - // (undocumented) - abstract encrypt(message: string): Promise + // (undocumented) + abstract decrypt(encryptedMessageHex: string): Promise; + // (undocumented) + abstract encrypt(message: string): Promise; } // @public (undocumented) export class Agent implements IAgent { - constructor(options?: IAgentOptions) - // (undocumented) - availableMethods(): string[] - // (undocumented) - execute

(method: string, args: P): Promise - // (undocumented) - readonly methods: IPluginMethodMap -} + constructor(options?: IAgentOptions); + // (undocumented) + availableMethods(): string[]; + // (undocumented) + execute

(method: string, args: P): Promise; + // (undocumented) + readonly methods: IPluginMethodMap; + } // @public -export function createAgent(options: IAgentOptions): T +export function createAgent(options: IAgentOptions): T; export { DIDDocument } // @public (undocumented) export interface EcdsaSignature { - // (undocumented) - r: string - // (undocumented) - recoveryParam?: number - // (undocumented) - s: string + // (undocumented) + r: string; + // (undocumented) + recoveryParam?: number; + // (undocumented) + s: string; } // @public (undocumented) export interface IAgent extends IAgentBase { - // (undocumented) - execute: (method: string, args: A) => Promise + // (undocumented) + execute: (method: string, args: A) => Promise; } // @public (undocumented) export interface IAgentBase { - // (undocumented) - availableMethods: () => string[] + // (undocumented) + availableMethods: () => string[]; } // @public (undocumented) export interface IAgentContext { - // (undocumented) - agent: TAgent + // (undocumented) + agent: TAgent; } // @public (undocumented) export interface IAgentOptions { - // (undocumented) - authorizedMethods?: string[] - // (undocumented) - context?: Record - // (undocumented) - overrides?: IPluginMethodMap - // (undocumented) - plugins?: IAgentPlugin[] + // (undocumented) + authorizedMethods?: string[]; + // (undocumented) + context?: Record; + // (undocumented) + overrides?: IPluginMethodMap; + // (undocumented) + plugins?: IAgentPlugin[]; } // @public (undocumented) export interface IAgentPlugin { - // (undocumented) - readonly methods: IPluginMethodMap + // (undocumented) + readonly methods: IPluginMethodMap; } // @public (undocumented) export interface IDataStore extends IPluginMethodMap { - // (undocumented) - dataStoreSaveMessage(args: IMessage): Promise - // (undocumented) - dataStoreSaveVerifiableCredential(args: VerifiableCredential): Promise - // (undocumented) - dataStoreSaveVerifiablePresentation(args: VerifiablePresentation): Promise + // (undocumented) + dataStoreSaveMessage(args: IMessage): Promise; + // (undocumented) + dataStoreSaveVerifiableCredential(args: VerifiableCredential): Promise; + // (undocumented) + dataStoreSaveVerifiablePresentation(args: VerifiablePresentation): Promise; } // @public (undocumented) export class IdentityManager implements IAgentPlugin { - constructor(options: { - providers: Record - defaultProvider: string - store: AbstractIdentityStore - }) - // (undocumented) - identityManagerAddKey( - { did, key, options }: IIdentityManagerAddKeyArgs, - context: IAgentContext, - ): Promise - // (undocumented) - identityManagerAddService( - { did, service, options }: IIdentityManagerAddServiceArgs, - context: IAgentContext, - ): Promise - // (undocumented) - identityManagerCreateIdentity( - { provider, alias, kms, options }: IIdentityManagerCreateIdentityArgs, - context: IAgentContext, - ): Promise - // (undocumented) - identityManagerDeleteIdentity( - { did }: IIdentityManagerDeleteIdentityArgs, - context: IAgentContext, - ): Promise - // (undocumented) - identityManagerGetIdentities(): Promise - // (undocumented) - identityManagerGetIdentity({ did }: IIdentityManagerGetIdentityArgs): Promise - // (undocumented) - identityManagerGetOrCreateIdentity( - { provider, alias, kms, options }: IIdentityManagerGetOrCreateIdentityArgs, - context: IAgentContext, - ): Promise - // (undocumented) - identityManagerGetProviders(): Promise - // (undocumented) - identityManagerImportIdentity(identity: IIdentity): Promise - // (undocumented) - identityManagerRemoveKey( - { did, kid, options }: IIdentityManagerRemoveKeyArgs, - context: IAgentContext, - ): Promise - // (undocumented) - identityManagerRemoveService( - { did, id, options }: IIdentityManagerRemoveServiceArgs, - context: IAgentContext, - ): Promise - // (undocumented) - readonly methods: IIdentityManager -} + constructor(options: { + providers: Record; + defaultProvider: string; + store: AbstractIdentityStore; + }); + // (undocumented) + identityManagerAddKey({ did, key, options }: IIdentityManagerAddKeyArgs, context: IAgentContext): Promise; + // (undocumented) + identityManagerAddService({ did, service, options }: IIdentityManagerAddServiceArgs, context: IAgentContext): Promise; + // (undocumented) + identityManagerCreateIdentity({ provider, alias, kms, options }: IIdentityManagerCreateIdentityArgs, context: IAgentContext): Promise; + // (undocumented) + identityManagerDeleteIdentity({ did }: IIdentityManagerDeleteIdentityArgs, context: IAgentContext): Promise; + // (undocumented) + identityManagerGetIdentities(): Promise; + // (undocumented) + identityManagerGetIdentity({ did }: IIdentityManagerGetIdentityArgs): Promise; + // (undocumented) + identityManagerGetOrCreateIdentity({ provider, alias, kms, options }: IIdentityManagerGetOrCreateIdentityArgs, context: IAgentContext): Promise; + // (undocumented) + identityManagerGetProviders(): Promise; + // (undocumented) + identityManagerImportIdentity(identity: IIdentity): Promise; + // (undocumented) + identityManagerRemoveKey({ did, kid, options }: IIdentityManagerRemoveKeyArgs, context: IAgentContext): Promise; + // (undocumented) + identityManagerRemoveService({ did, id, options }: IIdentityManagerRemoveServiceArgs, context: IAgentContext): Promise; + // (undocumented) + readonly methods: IIdentityManager; + } // @public (undocumented) export interface IHandleMessage extends IPluginMethodMap { - // (undocumented) - handleMessage(args: IHandleMessageArgs, context: IAgentContext): Promise + // (undocumented) + handleMessage(args: IHandleMessageArgs, context: IAgentContext): Promise; } // @public (undocumented) export interface IHandleMessageArgs { - // (undocumented) - metaData?: IMetaData[] - // (undocumented) - raw: string - // (undocumented) - save?: boolean + // (undocumented) + metaData?: IMetaData[]; + // (undocumented) + raw: string; + // (undocumented) + save?: boolean; } // @public (undocumented) export interface IIdentity { - // (undocumented) - alias?: string - // (undocumented) - controllerKeyId: string - // (undocumented) - did: string - // (undocumented) - keys: IKey[] - // (undocumented) - provider: string - // (undocumented) - services: IService[] + // (undocumented) + alias?: string; + // (undocumented) + controllerKeyId: string; + // (undocumented) + did: string; + // (undocumented) + keys: IKey[]; + // (undocumented) + provider: string; + // (undocumented) + services: IService[]; } // @public (undocumented) export interface IIdentityManager extends IPluginMethodMap { - // (undocumented) - identityManagerAddKey(args: IIdentityManagerAddKeyArgs, context: IAgentContext): Promise - // (undocumented) - identityManagerAddService( - args: IIdentityManagerAddServiceArgs, - context: IAgentContext, - ): Promise - // (undocumented) - identityManagerCreateIdentity( - args: IIdentityManagerCreateIdentityArgs, - context: IAgentContext, - ): Promise - // (undocumented) - identityManagerDeleteIdentity( - args: IIdentityManagerDeleteIdentityArgs, - context: IAgentContext, - ): Promise - // (undocumented) - identityManagerGetIdentities(): Promise> - // (undocumented) - identityManagerGetIdentity(args: IIdentityManagerGetIdentityArgs): Promise - // (undocumented) - identityManagerGetOrCreateIdentity( - args: IIdentityManagerGetOrCreateIdentityArgs, - context: IAgentContext, - ): Promise - // (undocumented) - identityManagerGetProviders(): Promise> - // (undocumented) - identityManagerImportIdentity(args: IIdentity): Promise - // (undocumented) - identityManagerRemoveKey( - args: IIdentityManagerRemoveKeyArgs, - context: IAgentContext, - ): Promise - // (undocumented) - identityManagerRemoveService( - args: IIdentityManagerRemoveServiceArgs, - context: IAgentContext, - ): Promise + // (undocumented) + identityManagerAddKey(args: IIdentityManagerAddKeyArgs, context: IAgentContext): Promise; + // (undocumented) + identityManagerAddService(args: IIdentityManagerAddServiceArgs, context: IAgentContext): Promise; + // (undocumented) + identityManagerCreateIdentity(args: IIdentityManagerCreateIdentityArgs, context: IAgentContext): Promise; + // (undocumented) + identityManagerDeleteIdentity(args: IIdentityManagerDeleteIdentityArgs, context: IAgentContext): Promise; + // (undocumented) + identityManagerGetIdentities(): Promise>; + // (undocumented) + identityManagerGetIdentity(args: IIdentityManagerGetIdentityArgs): Promise; + // (undocumented) + identityManagerGetOrCreateIdentity(args: IIdentityManagerGetOrCreateIdentityArgs, context: IAgentContext): Promise; + // (undocumented) + identityManagerGetProviders(): Promise>; + // (undocumented) + identityManagerImportIdentity(args: IIdentity): Promise; + // (undocumented) + identityManagerRemoveKey(args: IIdentityManagerRemoveKeyArgs, context: IAgentContext): Promise; + // (undocumented) + identityManagerRemoveService(args: IIdentityManagerRemoveServiceArgs, context: IAgentContext): Promise; } // @public (undocumented) export interface IIdentityManagerAddKeyArgs { - // (undocumented) - did: string - // (undocumented) - key: IKey - // (undocumented) - options?: any + // (undocumented) + did: string; + // (undocumented) + key: IKey; + // (undocumented) + options?: any; } // @public (undocumented) export interface IIdentityManagerAddServiceArgs { - // (undocumented) - did: string - // (undocumented) - options?: any - // (undocumented) - service: IService + // (undocumented) + did: string; + // (undocumented) + options?: any; + // (undocumented) + service: IService; } // @public (undocumented) export interface IIdentityManagerCreateIdentityArgs { - // (undocumented) - alias?: string - // (undocumented) - kms?: string - // (undocumented) - options?: any - // (undocumented) - provider?: string + // (undocumented) + alias?: string; + // (undocumented) + kms?: string; + // (undocumented) + options?: any; + // (undocumented) + provider?: string; } // @public (undocumented) export interface IIdentityManagerDeleteIdentityArgs { - // (undocumented) - did: string + // (undocumented) + did: string; } // @public (undocumented) export interface IIdentityManagerGetIdentityArgs { - // (undocumented) - did: string + // (undocumented) + did: string; } // @public (undocumented) export interface IIdentityManagerGetOrCreateIdentityArgs { - // (undocumented) - alias: string - // (undocumented) - kms?: string - // (undocumented) - options?: any - // (undocumented) - provider?: string + // (undocumented) + alias: string; + // (undocumented) + kms?: string; + // (undocumented) + options?: any; + // (undocumented) + provider?: string; } // @public (undocumented) export interface IIdentityManagerRemoveKeyArgs { - // (undocumented) - did: string - // (undocumented) - kid: string - // (undocumented) - options?: any + // (undocumented) + did: string; + // (undocumented) + kid: string; + // (undocumented) + options?: any; } // @public (undocumented) export interface IIdentityManagerRemoveServiceArgs { - // (undocumented) - did: string - // (undocumented) - id: string - // (undocumented) - options?: any + // (undocumented) + did: string; + // (undocumented) + id: string; + // (undocumented) + options?: any; } // @public (undocumented) export interface IKey { - // (undocumented) - kid: string - // (undocumented) - kms: string - // (undocumented) - meta?: Record - // (undocumented) - privateKeyHex?: string - // (undocumented) - publicKeyHex: string - // (undocumented) - type: TKeyType + // (undocumented) + kid: string; + // (undocumented) + kms: string; + // (undocumented) + meta?: Record; + // (undocumented) + privateKeyHex?: string; + // (undocumented) + publicKeyHex: string; + // (undocumented) + type: TKeyType; } // @public (undocumented) export interface IKeyManager extends IPluginMethodMap { - // (undocumented) - keyManagerCreateKey(args: IKeyManagerCreateKeyArgs): Promise - // (undocumented) - keyManagerDecryptJWE(args: IKeyManagerDecryptJWEArgs): Promise - // (undocumented) - keyManagerDeleteKey(args: IKeyManagerDeleteKeyArgs): Promise - // (undocumented) - keyManagerEncryptJWE(args: IKeyManagerEncryptJWEArgs): Promise - // (undocumented) - keyManagerGetKey(args: IKeyManagerGetKeyArgs): Promise - // (undocumented) - keyManagerImportKey(args: IKey): Promise - // (undocumented) - keyManagerSignEthTX(args: IKeyManagerSignEthTXArgs): Promise - // (undocumented) - keyManagerSignJWT(args: IKeyManagerSignJWTArgs): Promise + // (undocumented) + keyManagerCreateKey(args: IKeyManagerCreateKeyArgs): Promise; + // (undocumented) + keyManagerDecryptJWE(args: IKeyManagerDecryptJWEArgs): Promise; + // (undocumented) + keyManagerDeleteKey(args: IKeyManagerDeleteKeyArgs): Promise; + // (undocumented) + keyManagerEncryptJWE(args: IKeyManagerEncryptJWEArgs): Promise; + // (undocumented) + keyManagerGetKey(args: IKeyManagerGetKeyArgs): Promise; + // (undocumented) + keyManagerImportKey(args: IKey): Promise; + // (undocumented) + keyManagerSignEthTX(args: IKeyManagerSignEthTXArgs): Promise; + // (undocumented) + keyManagerSignJWT(args: IKeyManagerSignJWTArgs): Promise; } // @public (undocumented) export interface IKeyManagerCreateKeyArgs { - // (undocumented) - kms: string - // (undocumented) - meta?: Record - // (undocumented) - type: TKeyType + // (undocumented) + kms: string; + // (undocumented) + meta?: Record; + // (undocumented) + type: TKeyType; } // @public (undocumented) export interface IKeyManagerDecryptJWEArgs { - // (undocumented) - data: string - // (undocumented) - kid: string + // (undocumented) + data: string; + // (undocumented) + kid: string; } // @public (undocumented) export interface IKeyManagerDeleteKeyArgs { - // (undocumented) - kid: string + // (undocumented) + kid: string; } // @public (undocumented) export interface IKeyManagerEncryptJWEArgs { - // (undocumented) - data: string - // (undocumented) - kid: string - // (undocumented) - to: Omit + // (undocumented) + data: string; + // (undocumented) + kid: string; + // (undocumented) + to: Omit; } // @public (undocumented) export interface IKeyManagerGetKeyArgs { - // (undocumented) - kid: string + // (undocumented) + kid: string; } // @public (undocumented) export interface IKeyManagerSignEthTXArgs { - // (undocumented) - kid: string - // (undocumented) - transaction: object + // (undocumented) + kid: string; + // (undocumented) + transaction: object; } // @public (undocumented) export interface IKeyManagerSignJWTArgs { - // (undocumented) - data: string - // (undocumented) - kid: string + // (undocumented) + data: string; + // (undocumented) + kid: string; } // @public (undocumented) export interface IMessage { - // (undocumented) - createdAt?: string - // (undocumented) - credentials?: VerifiableCredential[] - // (undocumented) - data?: any - // (undocumented) - expiresAt?: string - // (undocumented) - from?: string - // (undocumented) - id: string - // (undocumented) - metaData?: IMetaData[] - // (undocumented) - presentations?: VerifiablePresentation[] - // (undocumented) - raw?: string - // (undocumented) - replyTo?: string[] - // (undocumented) - replyUrl?: string - // (undocumented) - threadId?: string - // (undocumented) - to?: string - // (undocumented) - type: string + // (undocumented) + createdAt?: string; + // (undocumented) + credentials?: VerifiableCredential[]; + // (undocumented) + data?: any; + // (undocumented) + expiresAt?: string; + // (undocumented) + from?: string; + // (undocumented) + id: string; + // (undocumented) + metaData?: IMetaData[]; + // (undocumented) + presentations?: VerifiablePresentation[]; + // (undocumented) + raw?: string; + // (undocumented) + replyTo?: string[]; + // (undocumented) + replyUrl?: string; + // (undocumented) + threadId?: string; + // (undocumented) + to?: string; + // (undocumented) + type: string; } // @public (undocumented) export interface IMetaData { - // (undocumented) - type: string - // (undocumented) - value?: string + // (undocumented) + type: string; + // (undocumented) + value?: string; } // @public (undocumented) export interface IPluginMethod { - // (undocumented) - (args: any, context: any): Promise + // (undocumented) + (args: any, context: any): Promise; } // @public (undocumented) -export interface IPluginMethodMap extends Record {} +export interface IPluginMethodMap extends Record { +} // @public (undocumented) export interface IResolveDid extends IPluginMethodMap { - resolveDid(args: ResolveDidArgs): Promise + resolveDid(args: ResolveDidArgs): Promise; } // @public (undocumented) export interface IService { - // (undocumented) - description?: string - // (undocumented) - id: string - // (undocumented) - serviceEndpoint: string - // (undocumented) - type: string + // (undocumented) + description?: string; + // (undocumented) + id: string; + // (undocumented) + serviceEndpoint: string; + // (undocumented) + type: string; } // @public (undocumented) export class KeyManager implements IAgentPlugin { - constructor(options: { store: AbstractKeyStore; kms: Record }) - // (undocumented) - keyManagerCreateKey(args: IKeyManagerCreateKeyArgs): Promise - // (undocumented) - keyManagerDecryptJWE({ kid, data }: IKeyManagerDecryptJWEArgs): Promise - // (undocumented) - keyManagerDeleteKey({ kid }: IKeyManagerDeleteKeyArgs): Promise - // (undocumented) - keyManagerEncryptJWE({ kid, to, data }: IKeyManagerEncryptJWEArgs): Promise - // (undocumented) - keyManagerGetKey({ kid }: IKeyManagerGetKeyArgs): Promise - // (undocumented) - keyManagerImportKey(key: IKey): Promise - // (undocumented) - keyManagerSignEthTX({ kid, transaction }: IKeyManagerSignEthTXArgs): Promise - // (undocumented) - keyManagerSignJWT({ kid, data }: IKeyManagerSignJWTArgs): Promise - // (undocumented) - readonly methods: IKeyManager -} + constructor(options: { + store: AbstractKeyStore; + kms: Record; + }); + // (undocumented) + keyManagerCreateKey(args: IKeyManagerCreateKeyArgs): Promise; + // (undocumented) + keyManagerDecryptJWE({ kid, data }: IKeyManagerDecryptJWEArgs): Promise; + // (undocumented) + keyManagerDeleteKey({ kid }: IKeyManagerDeleteKeyArgs): Promise; + // (undocumented) + keyManagerEncryptJWE({ kid, to, data }: IKeyManagerEncryptJWEArgs): Promise; + // (undocumented) + keyManagerGetKey({ kid }: IKeyManagerGetKeyArgs): Promise; + // (undocumented) + keyManagerImportKey(key: IKey): Promise; + // (undocumented) + keyManagerSignEthTX({ kid, transaction }: IKeyManagerSignEthTXArgs): Promise; + // (undocumented) + keyManagerSignJWT({ kid, data }: IKeyManagerSignJWTArgs): Promise; + // (undocumented) + readonly methods: IKeyManager; + } // @public (undocumented) export class Message implements IMessage { - constructor(data?: { raw: string; metaData?: IMetaData[] }) - // (undocumented) - addMetaData(meta: IMetaData): void - // (undocumented) - createdAt?: string - // (undocumented) - credentials?: VerifiableCredential[] - // (undocumented) - data?: any - // (undocumented) - expiresAt?: string - // (undocumented) - from?: string - // (undocumented) - getLastMetaData(): IMetaData | null - // (undocumented) - id: string - // (undocumented) - isValid(): boolean - // (undocumented) - metaData?: IMetaData[] - // (undocumented) - presentations?: VerifiablePresentation[] - // (undocumented) - raw?: string - // (undocumented) - replyTo?: string[] - // (undocumented) - replyUrl?: string - // (undocumented) - threadId?: string - // (undocumented) - to?: string - // (undocumented) - type: string + constructor(data?: { + raw: string; + metaData?: IMetaData[]; + }); + // (undocumented) + addMetaData(meta: IMetaData): void; + // (undocumented) + createdAt?: string; + // (undocumented) + credentials?: VerifiableCredential[]; + // (undocumented) + data?: any; + // (undocumented) + expiresAt?: string; + // (undocumented) + from?: string; + // (undocumented) + getLastMetaData(): IMetaData | null; + // (undocumented) + id: string; + // (undocumented) + isValid(): boolean; + // (undocumented) + metaData?: IMetaData[]; + // (undocumented) + presentations?: VerifiablePresentation[]; + // (undocumented) + raw?: string; + // (undocumented) + replyTo?: string[]; + // (undocumented) + replyUrl?: string; + // (undocumented) + threadId?: string; + // (undocumented) + to?: string; + // (undocumented) + type: string; } // @public (undocumented) export class MessageHandler extends EventEmitter implements IAgentPlugin { - constructor(options: { messageHandlers: AbstractMessageHandler[] }) - // (undocumented) - handleMessage(args: IHandleMessageArgs, context: IAgentContext): Promise - // (undocumented) - readonly methods: IHandleMessage + constructor(options: { + messageHandlers: AbstractMessageHandler[]; + }); + // (undocumented) + handleMessage(args: IHandleMessageArgs, context: IAgentContext): Promise; + // (undocumented) + readonly methods: IHandleMessage; } // @public (undocumented) export interface RemoveContext { - // (undocumented) - (args?: Parameters[0] | undefined): ReturnType + // (undocumented) + (args?: Parameters[0] | undefined): ReturnType; } // @public export interface ResolveDidArgs { - didUrl: string + didUrl: string; } // @public (undocumented) export type TAgent = { - [P in keyof T]: RemoveContext -} & - Pick + [P in keyof T]: RemoveContext; +} & Pick; // @public (undocumented) -export type TKeyType = 'Ed25519' | 'Secp256k1' +export type TKeyType = 'Ed25519' | 'Secp256k1'; // @public (undocumented) -export type VerifiableCredential = Verifiable +export type VerifiableCredential = Verifiable; // @public (undocumented) -export type VerifiablePresentation = Verifiable +export type VerifiablePresentation = Verifiable; export { W3CCredential } export { W3CPresentation } + + ``` diff --git a/report/daf-did-comm.api.md b/report/daf-did-comm.api.md new file mode 100644 index 000000000..0a6bef69f --- /dev/null +++ b/report/daf-did-comm.api.md @@ -0,0 +1,60 @@ +## API Report File for "daf-did-comm" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { AbstractMessageHandler } from 'daf-core'; +import { IAgentContext } from 'daf-core'; +import { IAgentPlugin } from 'daf-core'; +import { IHandleMessage } from 'daf-core'; +import { IIdentityManager } from 'daf-core'; +import { IKeyManager } from 'daf-core'; +import { IPluginMethodMap } from 'daf-core'; +import { IResolveDid } from 'daf-core'; +import { Message } from 'daf-core'; + +// @public (undocumented) +export class DIDComm implements IAgentPlugin { + constructor(); + // (undocumented) + readonly methods: IDIDComm; + // (undocumented) + sendMessageDIDCommAlpha1(args: ISendMessageDIDCommAlpha1Args, context: IAgentContext): Promise; +} + +// @public (undocumented) +export class DIDCommMessageHandler extends AbstractMessageHandler { + constructor(); + // Warning: (ae-forgotten-export) The symbol "IContext" needs to be exported by the entry point index.d.ts + // + // (undocumented) + handle(message: Message, context: IContext): Promise; +} + +// @public (undocumented) +export interface IDIDComm extends IPluginMethodMap { + // (undocumented) + sendMessageDIDCommAlpha1(args: ISendMessageDIDCommAlpha1Args, context: IAgentContext): Promise; +} + +// @public (undocumented) +export interface ISendMessageDIDCommAlpha1Args { + // (undocumented) + data: { + id?: string; + from: string; + to: string; + type: string; + body: any; + }; + // (undocumented) + save?: boolean; + // (undocumented) + url?: string; +} + + +// (No @packageDocumentation comment for this package) + +``` diff --git a/report/daf-selective-disclosure.api.md b/report/daf-selective-disclosure.api.md index 1846f0d5a..67bc63f4d 100644 --- a/report/daf-selective-disclosure.api.md +++ b/report/daf-selective-disclosure.api.md @@ -3,133 +3,118 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { AbstractMessageHandler } from 'daf-core' -import { IAgentContext } from 'daf-core' -import { IAgentPlugin } from 'daf-core' -import { IDataStoreORM } from 'daf-typeorm' -import { IHandleMessage } from 'daf-core' -import { IIdentityManager } from 'daf-core' -import { IKeyManager } from 'daf-core' -import { IPluginMethodMap } from 'daf-core' -import { Message } from 'daf-core' -import { VerifiableCredential } from 'daf-core' -import { VerifiablePresentation } from 'daf-core' + +import { AbstractMessageHandler } from 'daf-core'; +import { IAgentContext } from 'daf-core'; +import { IAgentPlugin } from 'daf-core'; +import { IDataStoreORM } from 'daf-typeorm'; +import { IHandleMessage } from 'daf-core'; +import { IIdentityManager } from 'daf-core'; +import { IKeyManager } from 'daf-core'; +import { IPluginMethodMap } from 'daf-core'; +import { Message } from 'daf-core'; +import { VerifiableCredential } from 'daf-core'; +import { VerifiablePresentation } from 'daf-core'; // @public (undocumented) export interface ICredentialRequestInput { - // (undocumented) - claimType: string - // (undocumented) - claimValue?: string - // (undocumented) - credentialContext?: string - // (undocumented) - credentialType?: string - // (undocumented) - essential?: boolean - // (undocumented) - issuers?: Issuer[] - // (undocumented) - reason?: string + // (undocumented) + claimType: string; + // (undocumented) + claimValue?: string; + // (undocumented) + credentialContext?: string; + // (undocumented) + credentialType?: string; + // (undocumented) + essential?: boolean; + // (undocumented) + issuers?: Issuer[]; + // (undocumented) + reason?: string; } // @public (undocumented) export interface ICredentialsForSdr extends ICredentialRequestInput { - // (undocumented) - credentials: VerifiableCredential[] + // (undocumented) + credentials: VerifiableCredential[]; } // @public (undocumented) export interface IPresentationValidationResult { - // (undocumented) - claims: ICredentialsForSdr[] - // (undocumented) - valid: boolean + // (undocumented) + claims: ICredentialsForSdr[]; + // (undocumented) + valid: boolean; } // @public (undocumented) export interface ISdr extends IPluginMethodMap { - // Warning: (ae-forgotten-export) The symbol "ICreateSelectiveDisclosureRequestArgs" needs to be exported by the entry point index.d.ts - // - // (undocumented) - createSelectiveDisclosureRequest( - args: ICreateSelectiveDisclosureRequestArgs, - context: IAgentContext, - ): Promise - // Warning: (ae-forgotten-export) The symbol "IGetVerifiableCredentialsForSdrArgs" needs to be exported by the entry point index.d.ts - // - // (undocumented) - getVerifiableCredentialsForSdr( - args: IGetVerifiableCredentialsForSdrArgs, - context: IAgentContext, - ): Promise> - // Warning: (ae-forgotten-export) The symbol "IValidatePresentationAgainstSdrArgs" needs to be exported by the entry point index.d.ts - // - // (undocumented) - validatePresentationAgainstSdr( - args: IValidatePresentationAgainstSdrArgs, - context: IAgentContext<{}>, - ): Promise + // Warning: (ae-forgotten-export) The symbol "ICreateSelectiveDisclosureRequestArgs" needs to be exported by the entry point index.d.ts + // + // (undocumented) + createSelectiveDisclosureRequest(args: ICreateSelectiveDisclosureRequestArgs, context: IAgentContext): Promise; + // Warning: (ae-forgotten-export) The symbol "IGetVerifiableCredentialsForSdrArgs" needs to be exported by the entry point index.d.ts + // + // (undocumented) + getVerifiableCredentialsForSdr(args: IGetVerifiableCredentialsForSdrArgs, context: IAgentContext): Promise>; + // Warning: (ae-forgotten-export) The symbol "IValidatePresentationAgainstSdrArgs" needs to be exported by the entry point index.d.ts + // + // (undocumented) + validatePresentationAgainstSdr(args: IValidatePresentationAgainstSdrArgs, context: IAgentContext<{}>): Promise; } // @public (undocumented) export interface ISelectiveDisclosureRequest { - // (undocumented) - claims: ICredentialRequestInput[] - // (undocumented) - credentials?: string[] - // (undocumented) - issuer: string - // (undocumented) - replyUrl?: string - // (undocumented) - subject?: string - // (undocumented) - tag?: string + // (undocumented) + claims: ICredentialRequestInput[]; + // (undocumented) + credentials?: string[]; + // (undocumented) + issuer: string; + // (undocumented) + replyUrl?: string; + // (undocumented) + subject?: string; + // (undocumented) + tag?: string; } // @public (undocumented) export interface Issuer { - // (undocumented) - did: string - // (undocumented) - url: string + // (undocumented) + did: string; + // (undocumented) + url: string; } // @public (undocumented) export const MessageTypes: { - sdr: string -} + sdr: string; +}; // @public (undocumented) export class Sdr implements IAgentPlugin { - constructor() - // (undocumented) - createSelectiveDisclosureRequest( - args: ICreateSelectiveDisclosureRequestArgs, - context: IAgentContext, - ): Promise - // (undocumented) - getVerifiableCredentialsForSdr( - args: IGetVerifiableCredentialsForSdrArgs, - context: IAgentContext, - ): Promise - // (undocumented) - readonly methods: ISdr - // (undocumented) - validatePresentationAgainstSdr( - args: IValidatePresentationAgainstSdrArgs, - context: IAgentContext<{}>, - ): Promise + constructor(); + // (undocumented) + createSelectiveDisclosureRequest(args: ICreateSelectiveDisclosureRequestArgs, context: IAgentContext): Promise; + // (undocumented) + getVerifiableCredentialsForSdr(args: IGetVerifiableCredentialsForSdrArgs, context: IAgentContext): Promise; + // (undocumented) + readonly methods: ISdr; + // (undocumented) + validatePresentationAgainstSdr(args: IValidatePresentationAgainstSdrArgs, context: IAgentContext<{}>): Promise; } // @public (undocumented) export class SdrMessageHandler extends AbstractMessageHandler { - // Warning: (ae-forgotten-export) The symbol "IContext" needs to be exported by the entry point index.d.ts - // - // (undocumented) - handle(message: Message, context: IContext): Promise -} + // Warning: (ae-forgotten-export) The symbol "IContext" needs to be exported by the entry point index.d.ts + // + // (undocumented) + handle(message: Message, context: IContext): Promise; + } + // (No @packageDocumentation comment for this package) + ``` diff --git a/report/daf-typeorm.api.md b/report/daf-typeorm.api.md index b3288813e..97c0bb22d 100644 --- a/report/daf-typeorm.api.md +++ b/report/daf-typeorm.api.md @@ -3,467 +3,397 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { AbstractIdentityStore } from 'daf-core' -import { AbstractKeyStore } from 'daf-core' -import { AbstractSecretBox } from 'daf-core' -import { BaseEntity } from 'typeorm' -import { Connection } from 'typeorm' -import { IAgentPlugin } from 'daf-core' -import { IDataStore } from 'daf-core' -import { IIdentity } from 'daf-core' -import { IKey } from 'daf-core' -import { IMessage } from 'daf-core' -import { IPluginMethodMap } from 'daf-core' -import { VerifiableCredential } from 'daf-core' -import { VerifiablePresentation } from 'daf-core' + +import { AbstractIdentityStore } from 'daf-core'; +import { AbstractKeyStore } from 'daf-core'; +import { AbstractSecretBox } from 'daf-core'; +import { BaseEntity } from 'typeorm'; +import { Connection } from 'typeorm'; +import { IAgentPlugin } from 'daf-core'; +import { IDataStore } from 'daf-core'; +import { IIdentity } from 'daf-core'; +import { IKey } from 'daf-core'; +import { IMessage } from 'daf-core'; +import { IPluginMethodMap } from 'daf-core'; +import { VerifiableCredential } from 'daf-core'; +import { VerifiablePresentation } from 'daf-core'; // @public (undocumented) export class Claim extends BaseEntity { - // (undocumented) - context: string[] - // (undocumented) - credential: Credential_2 - // (undocumented) - credentialType: string[] - // (undocumented) - expirationDate?: Date - // (undocumented) - hash: string - // (undocumented) - isObj: boolean - // (undocumented) - issuanceDate: Date - // (undocumented) - issuer: Identity - // (undocumented) - subject?: Identity - // (undocumented) - type: string - // (undocumented) - value: string + // (undocumented) + context: string[]; + // (undocumented) + credential: Credential_2; + // (undocumented) + credentialType: string[]; + // (undocumented) + expirationDate?: Date; + // (undocumented) + hash: string; + // (undocumented) + isObj: boolean; + // (undocumented) + issuanceDate: Date; + // (undocumented) + issuer: Identity; + // (undocumented) + subject?: Identity; + // (undocumented) + type: string; + // (undocumented) + value: string; } // @public (undocumented) class Credential_2 extends BaseEntity { - // (undocumented) - claims: Claim[] - // (undocumented) - context: string[] - // (undocumented) - expirationDate?: Date - // (undocumented) - hash: string - // (undocumented) - id?: string - // (undocumented) - issuanceDate: Date - // (undocumented) - issuer: Identity - // (undocumented) - messages: Message[] - // (undocumented) - presentations: Presentation[] - set raw(raw: VerifiableCredential) - // (undocumented) - get raw(): VerifiableCredential - // (undocumented) - subject?: Identity - // (undocumented) - type: string[] + // (undocumented) + claims: Claim[]; + // (undocumented) + context: string[]; + // (undocumented) + expirationDate?: Date; + // (undocumented) + hash: string; + // (undocumented) + id?: string; + // (undocumented) + issuanceDate: Date; + // (undocumented) + issuer: Identity; + // (undocumented) + messages: Message[]; + // (undocumented) + presentations: Presentation[]; + set raw(raw: VerifiableCredential); + // (undocumented) + get raw(): VerifiableCredential; + // (undocumented) + subject?: Identity; + // (undocumented) + type: string[]; } export { Credential_2 as Credential } // @public (undocumented) export class DataStore implements IAgentPlugin { - constructor(dbConnection: Promise) - // (undocumented) - dataStoreSaveMessage(args: IMessage): Promise - // (undocumented) - dataStoreSaveVerifiableCredential(args: VerifiableCredential): Promise - // (undocumented) - dataStoreSaveVerifiablePresentation(args: VerifiablePresentation): Promise - // (undocumented) - readonly methods: IDataStore + constructor(dbConnection: Promise); + // (undocumented) + dataStoreSaveMessage(args: IMessage): Promise; + // (undocumented) + dataStoreSaveVerifiableCredential(args: VerifiableCredential): Promise; + // (undocumented) + dataStoreSaveVerifiablePresentation(args: VerifiablePresentation): Promise; + // (undocumented) + readonly methods: IDataStore; } // @public (undocumented) export class DataStoreORM implements IAgentPlugin { - constructor(dbConnection: Promise) - // Warning: (ae-forgotten-export) The symbol "IContext" needs to be exported by the entry point index.d.ts - // - // (undocumented) - dataStoreORMGetIdentities(args: FindArgs, context: IContext): Promise - // (undocumented) - dataStoreORMGetIdentitiesCount(args: FindArgs, context: IContext): Promise - // (undocumented) - dataStoreORMGetMessages(args: FindArgs, context: IContext): Promise - // (undocumented) - dataStoreORMGetMessagesCount(args: FindArgs, context: IContext): Promise - // (undocumented) - dataStoreORMGetVerifiableCredentials( - args: FindArgs, - context: IContext, - ): Promise - // (undocumented) - dataStoreORMGetVerifiableCredentialsByClaims( - args: FindArgs, - context: IContext, - ): Promise - // (undocumented) - dataStoreORMGetVerifiableCredentialsByClaimsCount( - args: FindArgs, - context: IContext, - ): Promise - // (undocumented) - dataStoreORMGetVerifiableCredentialsCount( - args: FindArgs, - context: IContext, - ): Promise - // (undocumented) - dataStoreORMGetVerifiablePresentations( - args: FindArgs, - context: IContext, - ): Promise - // (undocumented) - dataStoreORMGetVerifiablePresentationsCount( - args: FindArgs, - context: IContext, - ): Promise - // (undocumented) - readonly methods: IDataStoreORM -} + constructor(dbConnection: Promise); + // Warning: (ae-forgotten-export) The symbol "IContext" needs to be exported by the entry point index.d.ts + // + // (undocumented) + dataStoreORMGetIdentities(args: FindArgs, context: IContext): Promise; + // (undocumented) + dataStoreORMGetIdentitiesCount(args: FindArgs, context: IContext): Promise; + // (undocumented) + dataStoreORMGetMessages(args: FindArgs, context: IContext): Promise; + // (undocumented) + dataStoreORMGetMessagesCount(args: FindArgs, context: IContext): Promise; + // (undocumented) + dataStoreORMGetVerifiableCredentials(args: FindArgs, context: IContext): Promise; + // (undocumented) + dataStoreORMGetVerifiableCredentialsByClaims(args: FindArgs, context: IContext): Promise; + // (undocumented) + dataStoreORMGetVerifiableCredentialsByClaimsCount(args: FindArgs, context: IContext): Promise; + // (undocumented) + dataStoreORMGetVerifiableCredentialsCount(args: FindArgs, context: IContext): Promise; + // (undocumented) + dataStoreORMGetVerifiablePresentations(args: FindArgs, context: IContext): Promise; + // (undocumented) + dataStoreORMGetVerifiablePresentationsCount(args: FindArgs, context: IContext): Promise; + // (undocumented) + readonly methods: IDataStoreORM; + } // @public (undocumented) -export const Entities: ( - | typeof Key - | typeof Identity - | typeof Service - | typeof Claim - | typeof Credential_2 - | typeof Presentation - | typeof Message -)[] +export const Entities: (typeof Key | typeof Identity | typeof Service | typeof Claim | typeof Credential_2 | typeof Presentation | typeof Message)[]; // @public (undocumented) export interface FindArgs { - // (undocumented) - order?: Order[] - // (undocumented) - skip?: number - // (undocumented) - take?: number - // (undocumented) - where?: Where[] + // (undocumented) + order?: Order[]; + // (undocumented) + skip?: number; + // (undocumented) + take?: number; + // (undocumented) + where?: Where[]; } // @public (undocumented) -export type FindClaimsArgs = FindArgs +export type FindClaimsArgs = FindArgs; // @public (undocumented) -export type FindCredentialsArgs = FindArgs +export type FindCredentialsArgs = FindArgs; // @public (undocumented) -export type FindIdentitiesArgs = FindArgs +export type FindIdentitiesArgs = FindArgs; // @public (undocumented) -export type FindMessagesArgs = FindArgs +export type FindMessagesArgs = FindArgs; // @public (undocumented) -export type FindPresentationsArgs = FindArgs +export type FindPresentationsArgs = FindArgs; // @public (undocumented) export interface IDataStoreORM extends IPluginMethodMap { - // (undocumented) - dataStoreORMGetIdentities(args: FindIdentitiesArgs, context: IContext): Promise> - // (undocumented) - dataStoreORMGetIdentitiesCount(args: FindIdentitiesArgs, context: IContext): Promise - // (undocumented) - dataStoreORMGetMessages(args: FindMessagesArgs, context: IContext): Promise> - // (undocumented) - dataStoreORMGetMessagesCount(args: FindMessagesArgs, context: IContext): Promise - // (undocumented) - dataStoreORMGetVerifiableCredentials( - args: FindCredentialsArgs, - context: IContext, - ): Promise> - // (undocumented) - dataStoreORMGetVerifiableCredentialsByClaims( - args: FindClaimsArgs, - context: IContext, - ): Promise> - // (undocumented) - dataStoreORMGetVerifiableCredentialsByClaimsCount(args: FindClaimsArgs, context: IContext): Promise - // (undocumented) - dataStoreORMGetVerifiableCredentialsCount(args: FindCredentialsArgs, context: IContext): Promise - // (undocumented) - dataStoreORMGetVerifiablePresentations( - args: FindPresentationsArgs, - context: IContext, - ): Promise> - // (undocumented) - dataStoreORMGetVerifiablePresentationsCount(args: FindPresentationsArgs, context: IContext): Promise + // (undocumented) + dataStoreORMGetIdentities(args: FindIdentitiesArgs, context: IContext): Promise>; + // (undocumented) + dataStoreORMGetIdentitiesCount(args: FindIdentitiesArgs, context: IContext): Promise; + // (undocumented) + dataStoreORMGetMessages(args: FindMessagesArgs, context: IContext): Promise>; + // (undocumented) + dataStoreORMGetMessagesCount(args: FindMessagesArgs, context: IContext): Promise; + // (undocumented) + dataStoreORMGetVerifiableCredentials(args: FindCredentialsArgs, context: IContext): Promise>; + // (undocumented) + dataStoreORMGetVerifiableCredentialsByClaims(args: FindClaimsArgs, context: IContext): Promise>; + // (undocumented) + dataStoreORMGetVerifiableCredentialsByClaimsCount(args: FindClaimsArgs, context: IContext): Promise; + // (undocumented) + dataStoreORMGetVerifiableCredentialsCount(args: FindCredentialsArgs, context: IContext): Promise; + // (undocumented) + dataStoreORMGetVerifiablePresentations(args: FindPresentationsArgs, context: IContext): Promise>; + // (undocumented) + dataStoreORMGetVerifiablePresentationsCount(args: FindPresentationsArgs, context: IContext): Promise; } // @public (undocumented) export class Identity extends BaseEntity { - // (undocumented) - alias?: string - // (undocumented) - controllerKeyId: string - // (undocumented) - did: string - getLatestClaimValue( - dbConnection: Promise, - where: { - type: string - }, - ): Promise - // (undocumented) - issuedClaims: Claim[] - // (undocumented) - issuedCredentials: Credential_2[] - // (undocumented) - issuedPresentations: Presentation[] - // (undocumented) - keys: Key[] - // (undocumented) - provider: string - // (undocumented) - receivedClaims: Claim[] - // (undocumented) - receivedCredentials: Credential_2[] - // (undocumented) - receivedMessages: Message[] - // (undocumented) - receivedPresentations: Presentation[] - // (undocumented) - saveDate: Date - // (undocumented) - sentMessages: Message[] - // (undocumented) - services: Service[] - // (undocumented) - shortDid(): string - // (undocumented) - updateDate: Date + // (undocumented) + alias?: string; + // (undocumented) + controllerKeyId: string; + // (undocumented) + did: string; + getLatestClaimValue(dbConnection: Promise, where: { + type: string; + }): Promise; + // (undocumented) + issuedClaims: Claim[]; + // (undocumented) + issuedCredentials: Credential_2[]; + // (undocumented) + issuedPresentations: Presentation[]; + // (undocumented) + keys: Key[]; + // (undocumented) + provider: string; + // (undocumented) + receivedClaims: Claim[]; + // (undocumented) + receivedCredentials: Credential_2[]; + // (undocumented) + receivedMessages: Message[]; + // (undocumented) + receivedPresentations: Presentation[]; + // (undocumented) + saveDate: Date; + // (undocumented) + sentMessages: Message[]; + // (undocumented) + services: Service[]; + // (undocumented) + shortDid(): string; + // (undocumented) + updateDate: Date; } // @public (undocumented) export class IdentityStore extends AbstractIdentityStore { - constructor(dbConnection: Promise) - // (undocumented) - delete({ did }: { did: string }): Promise - // (undocumented) - get({ did, alias }: { did: string; alias: string }): Promise - // (undocumented) - import(args: IIdentity): Promise - // (undocumented) - list(): Promise + constructor(dbConnection: Promise); + // (undocumented) + delete({ did }: { + did: string; + }): Promise; + // (undocumented) + get({ did, alias }: { + did: string; + alias: string; + }): Promise; + // (undocumented) + import(args: IIdentity): Promise; + // (undocumented) + list(): Promise; } // @public (undocumented) export class Key extends BaseEntity { - // (undocumented) - identity: Identity - // (undocumented) - kid: string - // (undocumented) - kms: string - // (undocumented) - meta?: Record - // (undocumented) - privateKeyHex?: string - // (undocumented) - publicKeyHex: string - // (undocumented) - type: KeyType_2 + // (undocumented) + identity: Identity; + // (undocumented) + kid: string; + // (undocumented) + kms: string; + // (undocumented) + meta?: Record; + // (undocumented) + privateKeyHex?: string; + // (undocumented) + publicKeyHex: string; + // (undocumented) + type: KeyType_2; } // @public (undocumented) export class KeyStore extends AbstractKeyStore { - constructor(dbConnection: Promise, secretBox?: AbstractSecretBox | undefined) - // (undocumented) - delete({ kid }: { kid: string }): Promise - // (undocumented) - get({ kid }: { kid: string }): Promise - // (undocumented) - import(args: IKey): Promise -} + constructor(dbConnection: Promise, secretBox?: AbstractSecretBox | undefined); + // (undocumented) + delete({ kid }: { + kid: string; + }): Promise; + // (undocumented) + get({ kid }: { + kid: string; + }): Promise; + // (undocumented) + import(args: IKey): Promise; + } // @public (undocumented) -type KeyType_2 = 'Ed25519' | 'Secp256k1' +type KeyType_2 = 'Ed25519' | 'Secp256k1'; export { KeyType_2 as KeyType } // @public (undocumented) export class Message extends BaseEntity { - // (undocumented) - createdAt?: Date - // (undocumented) - credentials: Credential_2[] - // (undocumented) - data?: any - // (undocumented) - expiresAt?: Date - // (undocumented) - from?: Identity - // (undocumented) - id: string - // (undocumented) - metaData?: MetaData[] - // (undocumented) - presentations: Presentation[] - // (undocumented) - raw?: string - // (undocumented) - replyTo?: string[] - // (undocumented) - replyUrl?: string - // (undocumented) - saveDate: Date - // (undocumented) - setId(): void - // (undocumented) - threadId?: string - // (undocumented) - to?: Identity - // (undocumented) - type: string - // (undocumented) - updateDate: Date + // (undocumented) + createdAt?: Date; + // (undocumented) + credentials: Credential_2[]; + // (undocumented) + data?: any; + // (undocumented) + expiresAt?: Date; + // (undocumented) + from?: Identity; + // (undocumented) + id: string; + // (undocumented) + metaData?: MetaData[]; + // (undocumented) + presentations: Presentation[]; + // (undocumented) + raw?: string; + // (undocumented) + replyTo?: string[]; + // (undocumented) + replyUrl?: string; + // (undocumented) + saveDate: Date; + // (undocumented) + setId(): void; + // (undocumented) + threadId?: string; + // (undocumented) + to?: Identity; + // (undocumented) + type: string; + // (undocumented) + updateDate: Date; } // @public (undocumented) export interface MetaData { - // (undocumented) - type: string - // (undocumented) - value?: string + // (undocumented) + type: string; + // (undocumented) + value?: string; } // @public (undocumented) -export const migrations: never[] +export const migrations: never[]; // @public (undocumented) export interface Order { - // (undocumented) - column: TColumns - // (undocumented) - direction: 'ASC' | 'DESC' + // (undocumented) + column: TColumns; + // (undocumented) + direction: 'ASC' | 'DESC'; } // @public (undocumented) export class Presentation extends BaseEntity { - // (undocumented) - context: string[] - // (undocumented) - credentials: Credential_2[] - // (undocumented) - expirationDate?: Date - // (undocumented) - hash: string - // (undocumented) - holder: Identity - // (undocumented) - id?: String - // (undocumented) - issuanceDate: Date - // (undocumented) - messages: Message[] - set raw(raw: VerifiablePresentation) - // (undocumented) - get raw(): VerifiablePresentation - // (undocumented) - type: string[] - // (undocumented) - verifier?: Identity[] + // (undocumented) + context: string[]; + // (undocumented) + credentials: Credential_2[]; + // (undocumented) + expirationDate?: Date; + // (undocumented) + hash: string; + // (undocumented) + holder: Identity; + // (undocumented) + id?: String; + // (undocumented) + issuanceDate: Date; + // (undocumented) + messages: Message[]; + set raw(raw: VerifiablePresentation); + // (undocumented) + get raw(): VerifiablePresentation; + // (undocumented) + type: string[]; + // (undocumented) + verifier?: Identity[]; } // @public (undocumented) export class Service extends BaseEntity { - // (undocumented) - description?: string - // (undocumented) - id: string - // (undocumented) - identity: Identity - // (undocumented) - serviceEndpoint: string - // (undocumented) - type: string + // (undocumented) + description?: string; + // (undocumented) + id: string; + // (undocumented) + identity: Identity; + // (undocumented) + serviceEndpoint: string; + // (undocumented) + type: string; } // @public (undocumented) -export type TClaimsColumns = - | 'context' - | 'credentialType' - | 'type' - | 'value' - | 'isObj' - | 'id' - | 'issuer' - | 'subject' - | 'expirationDate' - | 'issuanceDate' +export type TClaimsColumns = 'context' | 'credentialType' | 'type' | 'value' | 'isObj' | 'id' | 'issuer' | 'subject' | 'expirationDate' | 'issuanceDate'; // @public (undocumented) -export type TCredentialColumns = - | 'context' - | 'type' - | 'id' - | 'issuer' - | 'subject' - | 'expirationDate' - | 'issuanceDate' +export type TCredentialColumns = 'context' | 'type' | 'id' | 'issuer' | 'subject' | 'expirationDate' | 'issuanceDate'; // @public (undocumented) -export type TIdentitiesColumns = 'did' | 'alias' | 'provider' +export type TIdentitiesColumns = 'did' | 'alias' | 'provider'; // @public (undocumented) -export type TMessageColumns = - | 'from' - | 'to' - | 'id' - | 'createdAt' - | 'expiresAt' - | 'threadId' - | 'type' - | 'raw' - | 'replyTo' - | 'replyUrl' +export type TMessageColumns = 'from' | 'to' | 'id' | 'createdAt' | 'expiresAt' | 'threadId' | 'type' | 'raw' | 'replyTo' | 'replyUrl'; // @public (undocumented) -export type TPresentationColumns = - | 'context' - | 'type' - | 'id' - | 'holder' - | 'verifier' - | 'expirationDate' - | 'issuanceDate' +export type TPresentationColumns = 'context' | 'type' | 'id' | 'holder' | 'verifier' | 'expirationDate' | 'issuanceDate'; // @public (undocumented) export interface Where { - // (undocumented) - column: TColumns - // (undocumented) - not?: boolean - // (undocumented) - op?: - | 'LessThan' - | 'LessThanOrEqual' - | 'MoreThan' - | 'MoreThanOrEqual' - | 'Equal' - | 'Like' - | 'Between' - | 'In' - | 'Any' - | 'IsNull' - // (undocumented) - value?: string[] + // (undocumented) + column: TColumns; + // (undocumented) + not?: boolean; + // (undocumented) + op?: 'LessThan' | 'LessThanOrEqual' | 'MoreThan' | 'MoreThanOrEqual' | 'Equal' | 'Like' | 'Between' | 'In' | 'Any' | 'IsNull'; + // (undocumented) + value?: string[]; } + // (No @packageDocumentation comment for this package) + ``` diff --git a/report/daf-url.api.md b/report/daf-url.api.md index c220031c0..660f00054 100644 --- a/report/daf-url.api.md +++ b/report/daf-url.api.md @@ -3,17 +3,20 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { AbstractMessageHandler } from 'daf-core' -import { IAgentContext } from 'daf-core' -import { Message } from 'daf-core' + +import { AbstractMessageHandler } from 'daf-core'; +import { IAgentContext } from 'daf-core'; +import { Message } from 'daf-core'; // @public (undocumented) export class UrlMessageHandler extends AbstractMessageHandler { - // Warning: (ae-forgotten-export) The symbol "IContext" needs to be exported by the entry point index.d.ts - // - // (undocumented) - handle(message: Message, context: IContext): Promise + // Warning: (ae-forgotten-export) The symbol "IContext" needs to be exported by the entry point index.d.ts + // + // (undocumented) + handle(message: Message, context: IContext): Promise; } + // (No @packageDocumentation comment for this package) + ``` diff --git a/report/daf-w3c.api.md b/report/daf-w3c.api.md index 58baeeb17..6e1227222 100644 --- a/report/daf-w3c.api.md +++ b/report/daf-w3c.api.md @@ -3,86 +3,77 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { AbstractMessageHandler } from 'daf-core' -import { IAgentContext } from 'daf-core' -import { IAgentPlugin } from 'daf-core' -import { IDataStore } from 'daf-core' -import { IIdentityManager } from 'daf-core' -import { IKeyManager } from 'daf-core' -import { IPluginMethodMap } from 'daf-core' -import { IResolveDid } from 'daf-core' -import { Message } from 'daf-core' -import { VerifiableCredential } from 'daf-core' -import { VerifiablePresentation } from 'daf-core' -import { W3CCredential } from 'daf-core' -import { W3CPresentation } from 'daf-core' + +import { AbstractMessageHandler } from 'daf-core'; +import { IAgentContext } from 'daf-core'; +import { IAgentPlugin } from 'daf-core'; +import { IDataStore } from 'daf-core'; +import { IIdentityManager } from 'daf-core'; +import { IKeyManager } from 'daf-core'; +import { IPluginMethodMap } from 'daf-core'; +import { IResolveDid } from 'daf-core'; +import { Message } from 'daf-core'; +import { VerifiableCredential } from 'daf-core'; +import { VerifiablePresentation } from 'daf-core'; +import { W3CCredential } from 'daf-core'; +import { W3CPresentation } from 'daf-core'; // @public (undocumented) export interface ICreateVerifiableCredentialArgs { - // (undocumented) - credential: W3CCredential - // (undocumented) - proofFormat: 'jwt' - // (undocumented) - save?: boolean + // (undocumented) + credential: W3CCredential; + // (undocumented) + proofFormat: 'jwt'; + // (undocumented) + save?: boolean; } // @public (undocumented) export interface ICreateVerifiablePresentationArgs { - // (undocumented) - presentation: W3CPresentation - // (undocumented) - proofFormat: 'jwt' - // (undocumented) - save?: boolean + // (undocumented) + presentation: W3CPresentation; + // (undocumented) + proofFormat: 'jwt'; + // (undocumented) + save?: boolean; } // @public (undocumented) export interface IW3c extends IPluginMethodMap { - // (undocumented) - createVerifiableCredential( - args: ICreateVerifiableCredentialArgs, - context: IContext_2, - ): Promise - // Warning: (ae-forgotten-export) The symbol "IContext" needs to be exported by the entry point index.d.ts - // - // (undocumented) - createVerifiablePresentation( - args: ICreateVerifiablePresentationArgs, - context: IContext_2, - ): Promise + // (undocumented) + createVerifiableCredential(args: ICreateVerifiableCredentialArgs, context: IContext_2): Promise; + // Warning: (ae-forgotten-export) The symbol "IContext" needs to be exported by the entry point index.d.ts + // + // (undocumented) + createVerifiablePresentation(args: ICreateVerifiablePresentationArgs, context: IContext_2): Promise; } // @public (undocumented) export const MessageTypes: { - vc: string - vp: string -} + vc: string; + vp: string; +}; // @public (undocumented) export class W3c implements IAgentPlugin { - constructor() - // (undocumented) - createVerifiableCredential( - args: ICreateVerifiableCredentialArgs, - context: IContext_2, - ): Promise - // (undocumented) - createVerifiablePresentation( - args: ICreateVerifiablePresentationArgs, - context: IContext_2, - ): Promise - // (undocumented) - readonly methods: IW3c + constructor(); + // (undocumented) + createVerifiableCredential(args: ICreateVerifiableCredentialArgs, context: IContext_2): Promise; + // (undocumented) + createVerifiablePresentation(args: ICreateVerifiablePresentationArgs, context: IContext_2): Promise; + // (undocumented) + readonly methods: IW3c; } // @public (undocumented) export class W3cMessageHandler extends AbstractMessageHandler { - // Warning: (ae-forgotten-export) The symbol "IContext" needs to be exported by the entry point index.d.ts - // - // (undocumented) - handle(message: Message, context: IContext): Promise + // Warning: (ae-forgotten-export) The symbol "IContext" needs to be exported by the entry point index.d.ts + // + // (undocumented) + handle(message: Message, context: IContext): Promise; } + // (No @packageDocumentation comment for this package) + ```