diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml index 1826d640b..34b24e393 100644 --- a/.github/workflows/run-tests.yml +++ b/.github/workflows/run-tests.yml @@ -38,7 +38,7 @@ jobs: - name: setup git coordinates run: | - git remote set-url origin https://uport-project:$GH_TOKEN@github.com/uport-project/daf.git + git remote set-url origin https://uport-project:$GH_TOKEN@github.com/uport-project/veramo.git git config user.name $GH_USER git config user.email $GH_EMAIL diff --git a/.gitignore b/.gitignore index a6b98f905..bff5423dd 100644 --- a/.gitignore +++ b/.gitignore @@ -16,6 +16,8 @@ website/node_modules /packages/*/node_modules/ coverage +.npmrc + npm-debug.log npm-debug.log* lerna-debug.log diff --git a/README.md b/README.md index 044eed392..9e631727a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -[![uport-project](https://circleci.com/gh/uport-project/daf.svg?style=svg)](https://circleci.com/gh/uport-project/daf/tree/master) -[![codecov](https://codecov.io/gh/uport-project/daf/branch/master/graph/badge.svg)](https://codecov.io/gh/uport-project/daf) +[![codecov](https://codecov.io/gh/uport-project/veramo/branch/master/graph/badge.svg)](https://codecov.io/gh/uport-project/veramo) # Veramo DID Agent Framework diff --git a/lerna.json b/lerna.json index aa21b6c70..3c72991a0 100644 --- a/lerna.json +++ b/lerna.json @@ -5,7 +5,7 @@ ], "npmClient": "yarn", "changelog": { - "repo": "uport-project/daf", + "repo": "uport-project/veramo", "cacheDir": ".changelog" }, "command": { diff --git a/package.json b/package.json index 4e7c38169..65ca8bdbc 100644 --- a/package.json +++ b/package.json @@ -56,7 +56,7 @@ }, "repository": { "type": "git", - "url": "https://github.com/uport-project/daf.git" + "url": "https://github.com/uport-project/veramo.git" }, "publishConfig": { "access": "public" diff --git a/packages/cli/package.json b/packages/cli/package.json index e85c3292e..1ec0dc4f7 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -88,7 +88,7 @@ "publishConfig": { "access": "public" }, - "repository": "git@github.com:uport-project/daf.git", + "repository": "git@github.com:uport-project/veramo.git", "author": "Simonas Karuzas ", "contributors": [ { diff --git a/packages/core/api/core.api.md b/packages/core/api/core.api.md index 0b7dd509a..5fe3df6df 100644 --- a/packages/core/api/core.api.md +++ b/packages/core/api/core.api.md @@ -1,515 +1,515 @@ -## API Report File for "@veramo/core" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -import { DIDDocument } from 'did-resolver'; - -// @public -export class Agent implements IAgent { - constructor(options?: IAgentOptions); - availableMethods(): string[]; - emit(eventType: string, data: any): Promise; - execute

(method: string, args: P): Promise; - getSchema(): IAgentPluginSchema; - readonly methods: IPluginMethodMap; - } - -// @public -export const CoreEvents: { - error: string; - warning: string; -}; - -// @public -export function createAgent(options: IAgentOptions): TAgent; - -export { DIDDocument } - -// @public (undocumented) -export interface EcdsaSignature { - // (undocumented) - r: string; - // (undocumented) - recoveryParam: 1; - // (undocumented) - s: string; -} - -// @public -export interface IAgent extends IAgentBase { - // (undocumented) - emit: (eventType: string, data: any) => Promise; - // (undocumented) - execute: (method: string, args: A) => Promise; -} - -// @public -export interface IAgentBase { - // (undocumented) - availableMethods: () => string[]; - // (undocumented) - getSchema: () => IAgentPluginSchema; -} - -// @public -export interface IAgentContext { - agent: TAgent; -} - -// @public -export interface IAgentOptions { - authorizedMethods?: string[]; - context?: Record; - overrides?: IPluginMethodMap; - plugins?: IAgentPlugin[]; - schemaValidation?: boolean; -} - -// @public -export interface IAgentPlugin extends IEventListener { - // (undocumented) - readonly methods?: IPluginMethodMap; - // (undocumented) - readonly schema?: IAgentPluginSchema; -} - -// @public -export interface IAgentPluginSchema { - // (undocumented) - components: { - schemas: any; - methods: any; - }; -} - -// @public -export interface IDataStore extends IPluginMethodMap { - dataStoreGetMessage(args: IDataStoreGetMessageArgs): Promise; - dataStoreGetVerifiableCredential(args: IDataStoreGetVerifiableCredentialArgs): Promise; - dataStoreGetVerifiablePresentation(args: IDataStoreGetVerifiablePresentationArgs): Promise; - dataStoreSaveMessage(args: IDataStoreSaveMessageArgs): Promise; - dataStoreSaveVerifiableCredential(args: IDataStoreSaveVerifiableCredentialArgs): Promise; - dataStoreSaveVerifiablePresentation(args: IDataStoreSaveVerifiablePresentationArgs): Promise; -} - -// @public -export interface IDataStoreGetMessageArgs { - id: string; -} - -// @public -export interface IDataStoreGetVerifiableCredentialArgs { - hash: string; -} - -// @public -export interface IDataStoreGetVerifiablePresentationArgs { - hash: string; -} - -// @public -export interface IDataStoreSaveMessageArgs { - message: IMessage; -} - -// @public -export interface IDataStoreSaveVerifiableCredentialArgs { - verifiableCredential: VerifiableCredential; -} - -// @public -export interface IDataStoreSaveVerifiablePresentationArgs { - verifiablePresentation: VerifiablePresentation; -} - -// @public -export interface IDIDManager extends IPluginMethodMap { - didManagerAddKey(args: IDIDManagerAddKeyArgs, context: IAgentContext): Promise; - didManagerAddService(args: IDIDManagerAddServiceArgs, context: IAgentContext): Promise; - didManagerCreate(args: IDIDManagerCreateArgs, context: IAgentContext): Promise; - didManagerDelete(args: IDIDManagerDeleteArgs, context: IAgentContext): Promise; - didManagerFind(args: IDIDManagerFindArgs): Promise>; - didManagerGet(args: IDIDManagerGetArgs): Promise; - didManagerGetByAlias(args: IDIDManagerGetByAliasArgs): Promise; - didManagerGetOrCreate(args: IDIDManagerGetOrCreateArgs, context: IAgentContext): Promise; - didManagerGetProviders(): Promise>; - didManagerImport(args: IIdentifier, context: IAgentContext): Promise; - didManagerRemoveKey(args: IDIDManagerRemoveKeyArgs, context: IAgentContext): Promise; - didManagerRemoveService(args: IDIDManagerRemoveServiceArgs, context: IAgentContext): Promise; - didManagerSetAlias(args: IDIDManagerSetAliasArgs, context: IAgentContext): Promise; -} - -// @public -export interface IDIDManagerAddKeyArgs { - did: string; - key: IKey; - options?: object; -} - -// @public -export interface IDIDManagerAddServiceArgs { - did: string; - options?: object; - service: IService; -} - -// @public -export interface IDIDManagerCreateArgs { - alias?: string; - kms?: string; - options?: object; - provider?: string; -} - -// @public -export interface IDIDManagerDeleteArgs { - did: string; -} - -// @public -export interface IDIDManagerFindArgs { - alias?: string; - provider?: string; -} - -// @public -export interface IDIDManagerGetArgs { - did: string; -} - -// @public -export interface IDIDManagerGetByAliasArgs { - alias: string; - provider?: string; -} - -// @public -export interface IDIDManagerGetOrCreateArgs { - alias: string; - kms?: string; - options?: object; - provider?: string; -} - -// @public -export interface IDIDManagerRemoveKeyArgs { - did: string; - kid: string; - options?: object; -} - -// @public -export interface IDIDManagerRemoveServiceArgs { - did: string; - id: string; - options?: object; -} - -// @public -export interface IDIDManagerSetAliasArgs { - alias: string; - did: string; -} - -// @public -export interface IEventListener { - readonly eventTypes?: string[]; - onEvent?(event: { - type: string; - data: any; - }, context: IAgentContext<{}>): Promise; -} - -// @public -export interface IHandleMessageArgs { - metaData?: IMetaData[]; - raw: string; - save?: boolean; -} - -// @public -export interface IIdentifier { - alias?: string; - controllerKeyId?: string; - did: string; - keys: IKey[]; - provider: string; - services: IService[]; -} - -// @public -export interface IKey { - kid: string; - kms: string; - meta?: object | null; - privateKeyHex?: string; - publicKeyHex: string; - type: TKeyType; -} - -// @public -export interface IKeyManager extends IPluginMethodMap { - keyManagerCreate(args: IKeyManagerCreateArgs): Promise; - // @beta - keyManagerDecryptJWE(args: IKeyManagerDecryptJWEArgs): Promise; - keyManagerDelete(args: IKeyManagerDeleteArgs): Promise; - // @beta - keyManagerEncryptJWE(args: IKeyManagerEncryptJWEArgs): Promise; - keyManagerGet(args: IKeyManagerGetArgs): Promise; - keyManagerGetKeyManagementSystems(): Promise>; - keyManagerImport(args: IKey): Promise; - keyManagerSignEthTX(args: IKeyManagerSignEthTXArgs): Promise; - keyManagerSignJWT(args: IKeyManagerSignJWTArgs): Promise; -} - -// @public -export interface IKeyManagerCreateArgs { - kms: string; - meta?: object; - type: TKeyType; -} - -// @beta -export interface IKeyManagerDecryptJWEArgs { - data: string; - kid: string; -} - -// @public -export interface IKeyManagerDeleteArgs { - kid: string; -} - -// @beta -export interface IKeyManagerEncryptJWEArgs { - data: string; - kid: string; - to: Omit; -} - -// @public -export interface IKeyManagerGetArgs { - kid: string; -} - -// @public -export interface IKeyManagerSignEthTXArgs { - kid: string; - transaction: object; -} - -// @public -export interface IKeyManagerSignJWTArgs { - data: string; - kid: string; -} - -// @public -export interface IMessage { - createdAt?: string; - credentials?: VerifiableCredential[]; - data?: object | null; - expiresAt?: string; - from?: string; - id: string; - metaData?: IMetaData[] | null; - presentations?: VerifiablePresentation[]; - raw?: string; - replyTo?: string[]; - replyUrl?: string; - threadId?: string; - to?: string; - type: string; -} - -// @public -export interface IMessageHandler extends IPluginMethodMap { - handleMessage(args: IHandleMessageArgs, context: IAgentContext): Promise; -} - -// @public -export interface IMetaData { - type: string; - value?: string; -} - -// @public -export interface IPluginMethod { - // (undocumented) - (args: any, context: any): Promise; -} - -// @public -export interface IPluginMethodMap extends Record { -} - -// @public -export interface IResolver extends IPluginMethodMap { - resolveDid(args: ResolveDidArgs): Promise; -} - -// @public -export interface IService { - description?: string; - id: string; - serviceEndpoint: string; - type: string; -} - -// @public -export interface RemoveContext { - // (undocumented) - (args?: Parameters[0] | undefined): ReturnType; -} - -// @public -export interface ResolveDidArgs { - didUrl: string; -} - -// @public (undocumented) -export const schema: any; - -// @public -export type TAgent = { - [P in keyof T]: RemoveContext; -} & IAgent; - -// @public -export type TKeyType = 'Ed25519' | 'Secp256k1'; - -// @public (undocumented) -export class ValidationError extends Error { - constructor(message: string, method: string, code: string, path: string, description: string); - // (undocumented) - code: string; - // (undocumented) - description: string; - // (undocumented) - message: string; - // (undocumented) - method: string; - // (undocumented) - path: string; -} - -// @public -export interface VerifiableCredential { - // (undocumented) - '@context': string[]; - // (undocumented) - [x: string]: any; - // (undocumented) - credentialStatus?: { - id: string; - type: string; - }; - // (undocumented) - credentialSubject: { - id?: string; - [x: string]: any; - }; - // (undocumented) - expirationDate?: string; - // (undocumented) - id?: string; - // (undocumented) - issuanceDate: string; - // (undocumented) - issuer: { - id: string; - [x: string]: any; - }; - // (undocumented) - proof: { - type?: string; - [x: string]: any; - }; - // (undocumented) - type: string[]; -} - -// @public -export interface VerifiablePresentation { - // (undocumented) - '@context': string[]; - // (undocumented) - [x: string]: any; - // (undocumented) - expirationDate?: string; - // (undocumented) - holder: string; - // (undocumented) - id?: string; - // (undocumented) - issuanceDate?: string; - // (undocumented) - proof: { - type?: string; - [x: string]: any; - }; - // (undocumented) - type: string[]; - // (undocumented) - verifiableCredential: VerifiableCredential[]; - // (undocumented) - verifier: string[]; -} - -// @public -export interface W3CCredential { - // (undocumented) - '@context': string[]; - // (undocumented) - [x: string]: any; - // (undocumented) - credentialStatus?: { - id: string; - type: string; - }; - // (undocumented) - credentialSubject: { - id?: string; - [x: string]: any; - }; - // (undocumented) - expirationDate?: string; - // (undocumented) - id?: string; - // (undocumented) - issuanceDate: string; - // (undocumented) - issuer: { - id: string; - [x: string]: any; - }; - // (undocumented) - type: string[]; -} - -// @public -export interface W3CPresentation { - // (undocumented) - '@context': string[]; - // (undocumented) - [x: string]: any; - // (undocumented) - expirationDate?: string; - // (undocumented) - holder: string; - // (undocumented) - id?: string; - // (undocumented) - issuanceDate?: string; - // (undocumented) - type: string[]; - // (undocumented) - verifiableCredential: VerifiableCredential[]; - // (undocumented) - verifier: string[]; -} - - -``` +## API Report File for "@veramo/core" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { DIDDocument } from 'did-resolver'; + +// @public +export class Agent implements IAgent { + constructor(options?: IAgentOptions); + availableMethods(): string[]; + emit(eventType: string, data: any): Promise; + execute

(method: string, args: P): Promise; + getSchema(): IAgentPluginSchema; + readonly methods: IPluginMethodMap; + } + +// @public +export const CoreEvents: { + error: string; + warning: string; +}; + +// @public +export function createAgent(options: IAgentOptions): TAgent; + +export { DIDDocument } + +// @public (undocumented) +export interface EcdsaSignature { + // (undocumented) + r: string; + // (undocumented) + recoveryParam: 1; + // (undocumented) + s: string; +} + +// @public +export interface IAgent extends IAgentBase { + // (undocumented) + emit: (eventType: string, data: any) => Promise; + // (undocumented) + execute: (method: string, args: A) => Promise; +} + +// @public +export interface IAgentBase { + // (undocumented) + availableMethods: () => string[]; + // (undocumented) + getSchema: () => IAgentPluginSchema; +} + +// @public +export interface IAgentContext { + agent: TAgent; +} + +// @public +export interface IAgentOptions { + authorizedMethods?: string[]; + context?: Record; + overrides?: IPluginMethodMap; + plugins?: IAgentPlugin[]; + schemaValidation?: boolean; +} + +// @public +export interface IAgentPlugin extends IEventListener { + // (undocumented) + readonly methods?: IPluginMethodMap; + // (undocumented) + readonly schema?: IAgentPluginSchema; +} + +// @public +export interface IAgentPluginSchema { + // (undocumented) + components: { + schemas: any; + methods: any; + }; +} + +// @public +export interface IDataStore extends IPluginMethodMap { + dataStoreGetMessage(args: IDataStoreGetMessageArgs): Promise; + dataStoreGetVerifiableCredential(args: IDataStoreGetVerifiableCredentialArgs): Promise; + dataStoreGetVerifiablePresentation(args: IDataStoreGetVerifiablePresentationArgs): Promise; + dataStoreSaveMessage(args: IDataStoreSaveMessageArgs): Promise; + dataStoreSaveVerifiableCredential(args: IDataStoreSaveVerifiableCredentialArgs): Promise; + dataStoreSaveVerifiablePresentation(args: IDataStoreSaveVerifiablePresentationArgs): Promise; +} + +// @public +export interface IDataStoreGetMessageArgs { + id: string; +} + +// @public +export interface IDataStoreGetVerifiableCredentialArgs { + hash: string; +} + +// @public +export interface IDataStoreGetVerifiablePresentationArgs { + hash: string; +} + +// @public +export interface IDataStoreSaveMessageArgs { + message: IMessage; +} + +// @public +export interface IDataStoreSaveVerifiableCredentialArgs { + verifiableCredential: VerifiableCredential; +} + +// @public +export interface IDataStoreSaveVerifiablePresentationArgs { + verifiablePresentation: VerifiablePresentation; +} + +// @public +export interface IDIDManager extends IPluginMethodMap { + didManagerAddKey(args: IDIDManagerAddKeyArgs, context: IAgentContext): Promise; + didManagerAddService(args: IDIDManagerAddServiceArgs, context: IAgentContext): Promise; + didManagerCreate(args: IDIDManagerCreateArgs, context: IAgentContext): Promise; + didManagerDelete(args: IDIDManagerDeleteArgs, context: IAgentContext): Promise; + didManagerFind(args: IDIDManagerFindArgs): Promise>; + didManagerGet(args: IDIDManagerGetArgs): Promise; + didManagerGetByAlias(args: IDIDManagerGetByAliasArgs): Promise; + didManagerGetOrCreate(args: IDIDManagerGetOrCreateArgs, context: IAgentContext): Promise; + didManagerGetProviders(): Promise>; + didManagerImport(args: IIdentifier, context: IAgentContext): Promise; + didManagerRemoveKey(args: IDIDManagerRemoveKeyArgs, context: IAgentContext): Promise; + didManagerRemoveService(args: IDIDManagerRemoveServiceArgs, context: IAgentContext): Promise; + didManagerSetAlias(args: IDIDManagerSetAliasArgs, context: IAgentContext): Promise; +} + +// @public +export interface IDIDManagerAddKeyArgs { + did: string; + key: IKey; + options?: object; +} + +// @public +export interface IDIDManagerAddServiceArgs { + did: string; + options?: object; + service: IService; +} + +// @public +export interface IDIDManagerCreateArgs { + alias?: string; + kms?: string; + options?: object; + provider?: string; +} + +// @public +export interface IDIDManagerDeleteArgs { + did: string; +} + +// @public +export interface IDIDManagerFindArgs { + alias?: string; + provider?: string; +} + +// @public +export interface IDIDManagerGetArgs { + did: string; +} + +// @public +export interface IDIDManagerGetByAliasArgs { + alias: string; + provider?: string; +} + +// @public +export interface IDIDManagerGetOrCreateArgs { + alias: string; + kms?: string; + options?: object; + provider?: string; +} + +// @public +export interface IDIDManagerRemoveKeyArgs { + did: string; + kid: string; + options?: object; +} + +// @public +export interface IDIDManagerRemoveServiceArgs { + did: string; + id: string; + options?: object; +} + +// @public +export interface IDIDManagerSetAliasArgs { + alias: string; + did: string; +} + +// @public +export interface IEventListener { + readonly eventTypes?: string[]; + onEvent?(event: { + type: string; + data: any; + }, context: IAgentContext<{}>): Promise; +} + +// @public +export interface IHandleMessageArgs { + metaData?: IMetaData[]; + raw: string; + save?: boolean; +} + +// @public +export interface IIdentifier { + alias?: string; + controllerKeyId?: string; + did: string; + keys: IKey[]; + provider: string; + services: IService[]; +} + +// @public +export interface IKey { + kid: string; + kms: string; + meta?: object | null; + privateKeyHex?: string; + publicKeyHex: string; + type: TKeyType; +} + +// @public +export interface IKeyManager extends IPluginMethodMap { + keyManagerCreate(args: IKeyManagerCreateArgs): Promise; + // @beta + keyManagerDecryptJWE(args: IKeyManagerDecryptJWEArgs): Promise; + keyManagerDelete(args: IKeyManagerDeleteArgs): Promise; + // @beta + keyManagerEncryptJWE(args: IKeyManagerEncryptJWEArgs): Promise; + keyManagerGet(args: IKeyManagerGetArgs): Promise; + keyManagerGetKeyManagementSystems(): Promise>; + keyManagerImport(args: IKey): Promise; + keyManagerSignEthTX(args: IKeyManagerSignEthTXArgs): Promise; + keyManagerSignJWT(args: IKeyManagerSignJWTArgs): Promise; +} + +// @public +export interface IKeyManagerCreateArgs { + kms: string; + meta?: object; + type: TKeyType; +} + +// @beta +export interface IKeyManagerDecryptJWEArgs { + data: string; + kid: string; +} + +// @public +export interface IKeyManagerDeleteArgs { + kid: string; +} + +// @beta +export interface IKeyManagerEncryptJWEArgs { + data: string; + kid: string; + to: Omit; +} + +// @public +export interface IKeyManagerGetArgs { + kid: string; +} + +// @public +export interface IKeyManagerSignEthTXArgs { + kid: string; + transaction: object; +} + +// @public +export interface IKeyManagerSignJWTArgs { + data: string; + kid: string; +} + +// @public +export interface IMessage { + createdAt?: string; + credentials?: VerifiableCredential[]; + data?: object | null; + expiresAt?: string; + from?: string; + id: string; + metaData?: IMetaData[] | null; + presentations?: VerifiablePresentation[]; + raw?: string; + replyTo?: string[]; + replyUrl?: string; + threadId?: string; + to?: string; + type: string; +} + +// @public +export interface IMessageHandler extends IPluginMethodMap { + handleMessage(args: IHandleMessageArgs, context: IAgentContext): Promise; +} + +// @public +export interface IMetaData { + type: string; + value?: string; +} + +// @public +export interface IPluginMethod { + // (undocumented) + (args: any, context: any): Promise; +} + +// @public +export interface IPluginMethodMap extends Record { +} + +// @public +export interface IResolver extends IPluginMethodMap { + resolveDid(args: ResolveDidArgs): Promise; +} + +// @public +export interface IService { + description?: string; + id: string; + serviceEndpoint: string; + type: string; +} + +// @public +export interface RemoveContext { + // (undocumented) + (args?: Parameters[0] | undefined): ReturnType; +} + +// @public +export interface ResolveDidArgs { + didUrl: string; +} + +// @public (undocumented) +export const schema: any; + +// @public +export type TAgent = { + [P in keyof T]: RemoveContext; +} & IAgent; + +// @public +export type TKeyType = 'Ed25519' | 'Secp256k1'; + +// @public (undocumented) +export class ValidationError extends Error { + constructor(message: string, method: string, code: string, path: string, description: string); + // (undocumented) + code: string; + // (undocumented) + description: string; + // (undocumented) + message: string; + // (undocumented) + method: string; + // (undocumented) + path: string; +} + +// @public +export interface VerifiableCredential { + // (undocumented) + '@context': string[]; + // (undocumented) + [x: string]: any; + // (undocumented) + credentialStatus?: { + id: string; + type: string; + }; + // (undocumented) + credentialSubject: { + id?: string; + [x: string]: any; + }; + // (undocumented) + expirationDate?: string; + // (undocumented) + id?: string; + // (undocumented) + issuanceDate: string; + // (undocumented) + issuer: { + id: string; + [x: string]: any; + }; + // (undocumented) + proof: { + type?: string; + [x: string]: any; + }; + // (undocumented) + type: string[]; +} + +// @public +export interface VerifiablePresentation { + // (undocumented) + '@context': string[]; + // (undocumented) + [x: string]: any; + // (undocumented) + expirationDate?: string; + // (undocumented) + holder: string; + // (undocumented) + id?: string; + // (undocumented) + issuanceDate?: string; + // (undocumented) + proof: { + type?: string; + [x: string]: any; + }; + // (undocumented) + type: string[]; + // (undocumented) + verifiableCredential: VerifiableCredential[]; + // (undocumented) + verifier: string[]; +} + +// @public +export interface W3CCredential { + // (undocumented) + '@context': string[]; + // (undocumented) + [x: string]: any; + // (undocumented) + credentialStatus?: { + id: string; + type: string; + }; + // (undocumented) + credentialSubject: { + id?: string; + [x: string]: any; + }; + // (undocumented) + expirationDate?: string; + // (undocumented) + id?: string; + // (undocumented) + issuanceDate: string; + // (undocumented) + issuer: { + id: string; + [x: string]: any; + }; + // (undocumented) + type: string[]; +} + +// @public +export interface W3CPresentation { + // (undocumented) + '@context': string[]; + // (undocumented) + [x: string]: any; + // (undocumented) + expirationDate?: string; + // (undocumented) + holder: string; + // (undocumented) + id?: string; + // (undocumented) + issuanceDate?: string; + // (undocumented) + type: string[]; + // (undocumented) + verifiableCredential: VerifiableCredential[]; + // (undocumented) + verifier: string[]; +} + + +``` diff --git a/packages/core/package.json b/packages/core/package.json index 8c3062476..29e269610 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -38,7 +38,7 @@ "publishConfig": { "access": "public" }, - "repository": "git@github.com:uport-project/daf.git", + "repository": "git@github.com:uport-project/veramo.git", "author": "Simonas Karuzas ", "contributors": [ { diff --git a/packages/credential-w3c/api/credential-w3c.api.md b/packages/credential-w3c/api/credential-w3c.api.md index e370347be..db5d554b2 100644 --- a/packages/credential-w3c/api/credential-w3c.api.md +++ b/packages/credential-w3c/api/credential-w3c.api.md @@ -1,103 +1,103 @@ -## API Report File for "@veramo/credential-w3c" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -import { AbstractMessageHandler } from '@veramo/message-handler'; -import { IAgentContext } from '@veramo/core'; -import { IAgentPlugin } from '@veramo/core'; -import { IDataStore } from '@veramo/core'; -import { IDIDManager } from '@veramo/core'; -import { IKeyManager } from '@veramo/core'; -import { IPluginMethodMap } from '@veramo/core'; -import { IResolver } from '@veramo/core'; -import { Message } from '@veramo/message-handler'; -import { VerifiableCredential } from '@veramo/core'; -import { VerifiablePresentation } from '@veramo/core'; - -// @public -export class CredentialIssuer implements IAgentPlugin { - constructor(); - 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 - createVerifiablePresentation(args: ICreateVerifiablePresentationArgs, context: IContext_2): Promise; - // (undocumented) - readonly methods: ICredentialIssuer; - // (undocumented) - readonly schema: any; -} - -// @public -export type EncodingFormat = 'jwt'; - -// @public -export interface ICreateVerifiableCredentialArgs { - credential: { - '@context'?: string[]; - id?: string; - type?: string[]; - issuer: { - id: string; - [x: string]: any; - }; - issuanceDate?: string; - expirationDate?: string; - credentialSubject: { - id?: string; - [x: string]: any; - }; - credentialStatus?: { - id: string; - type: string; - }; - [x: string]: any; - }; - proofFormat: EncodingFormat; - save?: boolean; -} - -// @public -export interface ICreateVerifiablePresentationArgs { - presentation: { - id?: string; - holder: string; - issuanceDate?: string; - expirationDate?: string; - '@context'?: string[]; - type?: string[]; - verifier: string[]; - verifiableCredential: VerifiableCredential[]; - [x: string]: any; - }; - proofFormat: EncodingFormat; - save?: boolean; -} - -// @public -export interface ICredentialIssuer extends IPluginMethodMap { - createVerifiableCredential(args: ICreateVerifiableCredentialArgs, context: IContext_2): Promise; - createVerifiablePresentation(args: ICreateVerifiablePresentationArgs, context: IContext_2): Promise; -} - -// Warning: (ae-internal-missing-underscore) The name "MessageTypes" should be prefixed with an underscore because the declaration is marked as @internal -// -// @internal -export const MessageTypes: { - vc: string; - vp: string; -}; - -// @public (undocumented) -export const schema: any; - -// @public -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; -} - - -``` +## API Report File for "@veramo/credential-w3c" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { AbstractMessageHandler } from '@veramo/message-handler'; +import { IAgentContext } from '@veramo/core'; +import { IAgentPlugin } from '@veramo/core'; +import { IDataStore } from '@veramo/core'; +import { IDIDManager } from '@veramo/core'; +import { IKeyManager } from '@veramo/core'; +import { IPluginMethodMap } from '@veramo/core'; +import { IResolver } from '@veramo/core'; +import { Message } from '@veramo/message-handler'; +import { VerifiableCredential } from '@veramo/core'; +import { VerifiablePresentation } from '@veramo/core'; + +// @public +export class CredentialIssuer implements IAgentPlugin { + constructor(); + 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 + createVerifiablePresentation(args: ICreateVerifiablePresentationArgs, context: IContext_2): Promise; + // (undocumented) + readonly methods: ICredentialIssuer; + // (undocumented) + readonly schema: any; +} + +// @public +export type EncodingFormat = 'jwt'; + +// @public +export interface ICreateVerifiableCredentialArgs { + credential: { + '@context'?: string[]; + id?: string; + type?: string[]; + issuer: { + id: string; + [x: string]: any; + }; + issuanceDate?: string; + expirationDate?: string; + credentialSubject: { + id?: string; + [x: string]: any; + }; + credentialStatus?: { + id: string; + type: string; + }; + [x: string]: any; + }; + proofFormat: EncodingFormat; + save?: boolean; +} + +// @public +export interface ICreateVerifiablePresentationArgs { + presentation: { + id?: string; + holder: string; + issuanceDate?: string; + expirationDate?: string; + '@context'?: string[]; + type?: string[]; + verifier: string[]; + verifiableCredential: VerifiableCredential[]; + [x: string]: any; + }; + proofFormat: EncodingFormat; + save?: boolean; +} + +// @public +export interface ICredentialIssuer extends IPluginMethodMap { + createVerifiableCredential(args: ICreateVerifiableCredentialArgs, context: IContext_2): Promise; + createVerifiablePresentation(args: ICreateVerifiablePresentationArgs, context: IContext_2): Promise; +} + +// Warning: (ae-internal-missing-underscore) The name "MessageTypes" should be prefixed with an underscore because the declaration is marked as @internal +// +// @internal +export const MessageTypes: { + vc: string; + vp: string; +}; + +// @public (undocumented) +export const schema: any; + +// @public +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; +} + + +``` diff --git a/packages/credential-w3c/package.json b/packages/credential-w3c/package.json index 638b01d75..723a39f5f 100644 --- a/packages/credential-w3c/package.json +++ b/packages/credential-w3c/package.json @@ -37,7 +37,7 @@ "publishConfig": { "access": "public" }, - "repository": "git@github.com:uport-project/daf.git", + "repository": "git@github.com:uport-project/veramo.git", "author": "Simonas Karuzas ", "contributors": [ { diff --git a/packages/data-store/api/data-store.api.md b/packages/data-store/api/data-store.api.md index 0d05f5a5a..b4fb091d6 100644 --- a/packages/data-store/api/data-store.api.md +++ b/packages/data-store/api/data-store.api.md @@ -1,437 +1,437 @@ -## API Report File for "@veramo/data-store" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -import { AbstractDIDStore } from '@veramo/did-manager'; -import { AbstractKeyStore } from '@veramo/key-manager'; -import { AbstractSecretBox } from '@veramo/key-manager'; -import { BaseEntity } from 'typeorm'; -import { Connection } from 'typeorm'; -import { IAgentPlugin } from '@veramo/core'; -import { IDataStore } from '@veramo/core'; -import { IDataStoreGetMessageArgs } from '@veramo/core'; -import { IDataStoreGetVerifiableCredentialArgs } from '@veramo/core'; -import { IDataStoreGetVerifiablePresentationArgs } from '@veramo/core'; -import { IDataStoreSaveMessageArgs } from '@veramo/core'; -import { IDataStoreSaveVerifiableCredentialArgs } from '@veramo/core'; -import { IDataStoreSaveVerifiablePresentationArgs } from '@veramo/core'; -import { IIdentifier } from '@veramo/core'; -import { IKey } from '@veramo/core'; -import { IMessage } from '@veramo/core'; -import { IPluginMethodMap } from '@veramo/core'; -import { VerifiableCredential } from '@veramo/core'; -import { VerifiablePresentation } from '@veramo/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: Identifier; - // (undocumented) - subject?: Identifier; - // (undocumented) - type: string; - // (undocumented) - value: string | null; -} - -// @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: Identifier; - // (undocumented) - messages: Message[]; - // (undocumented) - presentations: Presentation[]; - set raw(raw: VerifiableCredential); - // (undocumented) - get raw(): VerifiableCredential; - // (undocumented) - subject?: Identifier; - // (undocumented) - type: string[]; -} - -export { Credential_2 as Credential } - -// @public (undocumented) -export class DataStore implements IAgentPlugin { - constructor(dbConnection: Promise); - // (undocumented) - dataStoreGetMessage(args: IDataStoreGetMessageArgs): Promise; - // (undocumented) - dataStoreGetVerifiableCredential(args: IDataStoreGetVerifiableCredentialArgs): Promise; - // (undocumented) - dataStoreGetVerifiablePresentation(args: IDataStoreGetVerifiablePresentationArgs): Promise; - // (undocumented) - dataStoreSaveMessage(args: IDataStoreSaveMessageArgs): Promise; - // (undocumented) - dataStoreSaveVerifiableCredential(args: IDataStoreSaveVerifiableCredentialArgs): Promise; - // (undocumented) - dataStoreSaveVerifiablePresentation(args: IDataStoreSaveVerifiablePresentationArgs): Promise; - // (undocumented) - readonly methods: IDataStore; - // (undocumented) - readonly schema: any; -} - -// @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 - // Warning: (ae-forgotten-export) The symbol "PartialIdentifier" needs to be exported by the entry point index.d.ts - // - // (undocumented) - dataStoreORMGetIdentifiers(args: FindArgs, context: IContext): Promise; - // (undocumented) - dataStoreORMGetIdentifiersCount(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; - // (undocumented) - readonly schema: any; -} - -// @public (undocumented) -export class DIDStore extends AbstractDIDStore { - constructor(dbConnection: Promise); - // (undocumented) - delete({ did }: { - did: string; - }): Promise; - // (undocumented) - get({ did, alias, provider, }: { - did: string; - alias: string; - provider: string; - }): Promise; - // (undocumented) - import(args: IIdentifier): Promise; - // (undocumented) - list(args: { - alias?: string; - provider?: string; - }): Promise; -} - -// @public (undocumented) -export const Entities: (typeof Key | typeof Identifier | 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[]; -} - -// @public (undocumented) -export type FindClaimsArgs = FindArgs; - -// @public (undocumented) -export type FindCredentialsArgs = FindArgs; - -// @public (undocumented) -export type FindIdentifiersArgs = FindArgs; - -// @public (undocumented) -export type FindMessagesArgs = FindArgs; - -// @public (undocumented) -export type FindPresentationsArgs = FindArgs; - -// @public (undocumented) -export interface IDataStoreORM extends IPluginMethodMap { - // (undocumented) - dataStoreORMGetIdentifiers(args: FindIdentifiersArgs, context: IContext): Promise>; - // (undocumented) - dataStoreORMGetIdentifiersCount(args: FindIdentifiersArgs, 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 Identifier 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; -} - -// @public (undocumented) -export class Key extends BaseEntity { - // (undocumented) - identifier: Identifier; - // (undocumented) - kid: string; - // (undocumented) - kms: string; - // (undocumented) - meta?: object | null; - // (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; - } - -// @public (undocumented) -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?: object | null; - // (undocumented) - expiresAt?: Date; - // (undocumented) - from?: Identifier; - // (undocumented) - id: string; - // (undocumented) - metaData?: MetaData[] | null; - // (undocumented) - presentations: Presentation[]; - // (undocumented) - raw?: string; - // (undocumented) - replyTo?: string[]; - // (undocumented) - replyUrl?: string; - // (undocumented) - saveDate: Date; - // (undocumented) - setId(): void; - // (undocumented) - threadId?: string; - // (undocumented) - to?: Identifier; - // (undocumented) - type: string; - // (undocumented) - updateDate: Date; -} - -// @public (undocumented) -export interface MetaData { - // (undocumented) - type: string; - // (undocumented) - value?: string; -} - -// @public (undocumented) -export const migrations: never[]; - -// @public (undocumented) -export interface Order { - // (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: Identifier; - // (undocumented) - id?: String; - // (undocumented) - issuanceDate: Date; - // (undocumented) - messages: Message[]; - set raw(raw: VerifiablePresentation); - // (undocumented) - get raw(): VerifiablePresentation; - // (undocumented) - type: string[]; - // (undocumented) - verifier?: Identifier[]; -} - -// @public (undocumented) -export const schema: any; - -// @public (undocumented) -export class Service extends BaseEntity { - // (undocumented) - description?: string; - // (undocumented) - id: string; - // (undocumented) - identifier: Identifier; - // (undocumented) - serviceEndpoint: string; - // (undocumented) - type: string; -} - -// @public (undocumented) -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'; - -// @public (undocumented) -export type TIdentifiersColumns = 'did' | 'alias' | 'provider'; - -// @public (undocumented) -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'; - -// @public (undocumented) -export interface UniqueVerifiableCredential { - // (undocumented) - hash: string; - // (undocumented) - verifiableCredential: VerifiableCredential; -} - -// @public (undocumented) -export interface UniqueVerifiablePresentation { - // (undocumented) - hash: string; - // (undocumented) - verifiablePresentation: VerifiablePresentation; -} - -// @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[]; -} - - -``` +## API Report File for "@veramo/data-store" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { AbstractDIDStore } from '@veramo/did-manager'; +import { AbstractKeyStore } from '@veramo/key-manager'; +import { AbstractSecretBox } from '@veramo/key-manager'; +import { BaseEntity } from 'typeorm'; +import { Connection } from 'typeorm'; +import { IAgentPlugin } from '@veramo/core'; +import { IDataStore } from '@veramo/core'; +import { IDataStoreGetMessageArgs } from '@veramo/core'; +import { IDataStoreGetVerifiableCredentialArgs } from '@veramo/core'; +import { IDataStoreGetVerifiablePresentationArgs } from '@veramo/core'; +import { IDataStoreSaveMessageArgs } from '@veramo/core'; +import { IDataStoreSaveVerifiableCredentialArgs } from '@veramo/core'; +import { IDataStoreSaveVerifiablePresentationArgs } from '@veramo/core'; +import { IIdentifier } from '@veramo/core'; +import { IKey } from '@veramo/core'; +import { IMessage } from '@veramo/core'; +import { IPluginMethodMap } from '@veramo/core'; +import { VerifiableCredential } from '@veramo/core'; +import { VerifiablePresentation } from '@veramo/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: Identifier; + // (undocumented) + subject?: Identifier; + // (undocumented) + type: string; + // (undocumented) + value: string | null; +} + +// @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: Identifier; + // (undocumented) + messages: Message[]; + // (undocumented) + presentations: Presentation[]; + set raw(raw: VerifiableCredential); + // (undocumented) + get raw(): VerifiableCredential; + // (undocumented) + subject?: Identifier; + // (undocumented) + type: string[]; +} + +export { Credential_2 as Credential } + +// @public (undocumented) +export class DataStore implements IAgentPlugin { + constructor(dbConnection: Promise); + // (undocumented) + dataStoreGetMessage(args: IDataStoreGetMessageArgs): Promise; + // (undocumented) + dataStoreGetVerifiableCredential(args: IDataStoreGetVerifiableCredentialArgs): Promise; + // (undocumented) + dataStoreGetVerifiablePresentation(args: IDataStoreGetVerifiablePresentationArgs): Promise; + // (undocumented) + dataStoreSaveMessage(args: IDataStoreSaveMessageArgs): Promise; + // (undocumented) + dataStoreSaveVerifiableCredential(args: IDataStoreSaveVerifiableCredentialArgs): Promise; + // (undocumented) + dataStoreSaveVerifiablePresentation(args: IDataStoreSaveVerifiablePresentationArgs): Promise; + // (undocumented) + readonly methods: IDataStore; + // (undocumented) + readonly schema: any; +} + +// @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 + // Warning: (ae-forgotten-export) The symbol "PartialIdentifier" needs to be exported by the entry point index.d.ts + // + // (undocumented) + dataStoreORMGetIdentifiers(args: FindArgs, context: IContext): Promise; + // (undocumented) + dataStoreORMGetIdentifiersCount(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; + // (undocumented) + readonly schema: any; +} + +// @public (undocumented) +export class DIDStore extends AbstractDIDStore { + constructor(dbConnection: Promise); + // (undocumented) + delete({ did }: { + did: string; + }): Promise; + // (undocumented) + get({ did, alias, provider, }: { + did: string; + alias: string; + provider: string; + }): Promise; + // (undocumented) + import(args: IIdentifier): Promise; + // (undocumented) + list(args: { + alias?: string; + provider?: string; + }): Promise; +} + +// @public (undocumented) +export const Entities: (typeof Key | typeof Identifier | 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[]; +} + +// @public (undocumented) +export type FindClaimsArgs = FindArgs; + +// @public (undocumented) +export type FindCredentialsArgs = FindArgs; + +// @public (undocumented) +export type FindIdentifiersArgs = FindArgs; + +// @public (undocumented) +export type FindMessagesArgs = FindArgs; + +// @public (undocumented) +export type FindPresentationsArgs = FindArgs; + +// @public (undocumented) +export interface IDataStoreORM extends IPluginMethodMap { + // (undocumented) + dataStoreORMGetIdentifiers(args: FindIdentifiersArgs, context: IContext): Promise>; + // (undocumented) + dataStoreORMGetIdentifiersCount(args: FindIdentifiersArgs, 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 Identifier 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; +} + +// @public (undocumented) +export class Key extends BaseEntity { + // (undocumented) + identifier: Identifier; + // (undocumented) + kid: string; + // (undocumented) + kms: string; + // (undocumented) + meta?: object | null; + // (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; + } + +// @public (undocumented) +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?: object | null; + // (undocumented) + expiresAt?: Date; + // (undocumented) + from?: Identifier; + // (undocumented) + id: string; + // (undocumented) + metaData?: MetaData[] | null; + // (undocumented) + presentations: Presentation[]; + // (undocumented) + raw?: string; + // (undocumented) + replyTo?: string[]; + // (undocumented) + replyUrl?: string; + // (undocumented) + saveDate: Date; + // (undocumented) + setId(): void; + // (undocumented) + threadId?: string; + // (undocumented) + to?: Identifier; + // (undocumented) + type: string; + // (undocumented) + updateDate: Date; +} + +// @public (undocumented) +export interface MetaData { + // (undocumented) + type: string; + // (undocumented) + value?: string; +} + +// @public (undocumented) +export const migrations: never[]; + +// @public (undocumented) +export interface Order { + // (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: Identifier; + // (undocumented) + id?: String; + // (undocumented) + issuanceDate: Date; + // (undocumented) + messages: Message[]; + set raw(raw: VerifiablePresentation); + // (undocumented) + get raw(): VerifiablePresentation; + // (undocumented) + type: string[]; + // (undocumented) + verifier?: Identifier[]; +} + +// @public (undocumented) +export const schema: any; + +// @public (undocumented) +export class Service extends BaseEntity { + // (undocumented) + description?: string; + // (undocumented) + id: string; + // (undocumented) + identifier: Identifier; + // (undocumented) + serviceEndpoint: string; + // (undocumented) + type: string; +} + +// @public (undocumented) +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'; + +// @public (undocumented) +export type TIdentifiersColumns = 'did' | 'alias' | 'provider'; + +// @public (undocumented) +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'; + +// @public (undocumented) +export interface UniqueVerifiableCredential { + // (undocumented) + hash: string; + // (undocumented) + verifiableCredential: VerifiableCredential; +} + +// @public (undocumented) +export interface UniqueVerifiablePresentation { + // (undocumented) + hash: string; + // (undocumented) + verifiablePresentation: VerifiablePresentation; +} + +// @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[]; +} + + +``` diff --git a/packages/data-store/package.json b/packages/data-store/package.json index 0d51d70dc..6fbf830db 100644 --- a/packages/data-store/package.json +++ b/packages/data-store/package.json @@ -35,7 +35,7 @@ "publishConfig": { "access": "public" }, - "repository": "git@github.com:uport-project/daf.git", + "repository": "git@github.com:uport-project/veramo.git", "author": "Simonas Karuzas ", "contributors": [ { diff --git a/packages/did-comm/api/did-comm.api.md b/packages/did-comm/api/did-comm.api.md index 7150c7dc4..bd68fbd7f 100644 --- a/packages/did-comm/api/did-comm.api.md +++ b/packages/did-comm/api/did-comm.api.md @@ -1,63 +1,63 @@ -## API Report File for "@veramo/did-comm" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -import { AbstractMessageHandler } from '@veramo/message-handler'; -import { IAgentContext } from '@veramo/core'; -import { IAgentPlugin } from '@veramo/core'; -import { IDIDManager } from '@veramo/core'; -import { IKeyManager } from '@veramo/core'; -import { IMessage } from '@veramo/core'; -import { IMessageHandler } from '@veramo/core'; -import { IPluginMethodMap } from '@veramo/core'; -import { IResolver } from '@veramo/core'; -import { Message } from '@veramo/message-handler'; - -// @beta -export class DIDComm implements IAgentPlugin { - constructor(); - readonly methods: IDIDComm; - // (undocumented) - readonly schema: any; - sendMessageDIDCommAlpha1(args: ISendMessageDIDCommAlpha1Args, context: IAgentContext): Promise; -} - -// @beta -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; -} - -// @beta -export interface IDIDComm extends IPluginMethodMap { - sendMessageDIDCommAlpha1(args: ISendMessageDIDCommAlpha1Args, context: IAgentContext): Promise; -} - -// @beta -export interface ISendMessageDIDCommAlpha1Args { - // (undocumented) - data: { - id?: string; - from: string; - to: string; - type: string; - body: object | string; - }; - // (undocumented) - headers?: Record; - // (undocumented) - save?: boolean; - // (undocumented) - url?: string; -} - -// @public (undocumented) -export const schema: any; - - -``` +## API Report File for "@veramo/did-comm" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { AbstractMessageHandler } from '@veramo/message-handler'; +import { IAgentContext } from '@veramo/core'; +import { IAgentPlugin } from '@veramo/core'; +import { IDIDManager } from '@veramo/core'; +import { IKeyManager } from '@veramo/core'; +import { IMessage } from '@veramo/core'; +import { IMessageHandler } from '@veramo/core'; +import { IPluginMethodMap } from '@veramo/core'; +import { IResolver } from '@veramo/core'; +import { Message } from '@veramo/message-handler'; + +// @beta +export class DIDComm implements IAgentPlugin { + constructor(); + readonly methods: IDIDComm; + // (undocumented) + readonly schema: any; + sendMessageDIDCommAlpha1(args: ISendMessageDIDCommAlpha1Args, context: IAgentContext): Promise; +} + +// @beta +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; +} + +// @beta +export interface IDIDComm extends IPluginMethodMap { + sendMessageDIDCommAlpha1(args: ISendMessageDIDCommAlpha1Args, context: IAgentContext): Promise; +} + +// @beta +export interface ISendMessageDIDCommAlpha1Args { + // (undocumented) + data: { + id?: string; + from: string; + to: string; + type: string; + body: object | string; + }; + // (undocumented) + headers?: Record; + // (undocumented) + save?: boolean; + // (undocumented) + url?: string; +} + +// @public (undocumented) +export const schema: any; + + +``` diff --git a/packages/did-comm/package.json b/packages/did-comm/package.json index cba3f58f5..8daa9b9c1 100644 --- a/packages/did-comm/package.json +++ b/packages/did-comm/package.json @@ -35,7 +35,7 @@ "publishConfig": { "access": "public" }, - "repository": "git@github.com:uport-project/daf.git", + "repository": "git@github.com:uport-project/veramo.git", "author": "Simonas Karuzas ", "contributors": [ { diff --git a/packages/did-jwt/api/did-jwt.api.md b/packages/did-jwt/api/did-jwt.api.md index 6cb4f77b9..32c86fd37 100644 --- a/packages/did-jwt/api/did-jwt.api.md +++ b/packages/did-jwt/api/did-jwt.api.md @@ -1,21 +1,21 @@ -## API Report File for "@veramo/did-jwt" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -import { AbstractMessageHandler } from '@veramo/message-handler'; -import { IAgentContext } from '@veramo/core'; -import { IResolver } from '@veramo/core'; -import { Message } from '@veramo/message-handler'; - -// @public -export class JwtMessageHandler 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; -} - - -``` +## API Report File for "@veramo/did-jwt" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { AbstractMessageHandler } from '@veramo/message-handler'; +import { IAgentContext } from '@veramo/core'; +import { IResolver } from '@veramo/core'; +import { Message } from '@veramo/message-handler'; + +// @public +export class JwtMessageHandler 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; +} + + +``` diff --git a/packages/did-jwt/package.json b/packages/did-jwt/package.json index 076f784e4..fa2c522eb 100644 --- a/packages/did-jwt/package.json +++ b/packages/did-jwt/package.json @@ -28,7 +28,7 @@ "publishConfig": { "access": "public" }, - "repository": "git@github.com:uport-project/daf.git", + "repository": "git@github.com:uport-project/veramo.git", "author": "Simonas Karuzas ", "contributors": [ { diff --git a/packages/did-manager/api/did-manager.api.md b/packages/did-manager/api/did-manager.api.md index c9f3a064f..6d68388bf 100644 --- a/packages/did-manager/api/did-manager.api.md +++ b/packages/did-manager/api/did-manager.api.md @@ -1,125 +1,125 @@ -## API Report File for "@veramo/did-manager" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -import { IAgentContext } from '@veramo/core'; -import { IAgentPlugin } from '@veramo/core'; -import { IDIDManager } from '@veramo/core'; -import { IDIDManagerAddKeyArgs } from '@veramo/core'; -import { IDIDManagerAddServiceArgs } from '@veramo/core'; -import { IDIDManagerCreateArgs } from '@veramo/core'; -import { IDIDManagerDeleteArgs } from '@veramo/core'; -import { IDIDManagerFindArgs } from '@veramo/core'; -import { IDIDManagerGetArgs } from '@veramo/core'; -import { IDIDManagerGetByAliasArgs } from '@veramo/core'; -import { IDIDManagerGetOrCreateArgs } from '@veramo/core'; -import { IDIDManagerRemoveKeyArgs } from '@veramo/core'; -import { IDIDManagerRemoveServiceArgs } from '@veramo/core'; -import { IDIDManagerSetAliasArgs } from '@veramo/core'; -import { IIdentifier } from '@veramo/core'; -import { IKey } from '@veramo/core'; -import { IKeyManager } from '@veramo/core'; -import { IService } from '@veramo/core'; - -// @public -export abstract class AbstractDIDStore { - // (undocumented) - abstract delete(args: { - did: string; - }): Promise; - // (undocumented) - abstract get(args: { - did: string; - }): Promise; - // (undocumented) - abstract get(args: { - alias: string; - provider: string; - }): Promise; - // (undocumented) - abstract import(args: IIdentifier): Promise; - // (undocumented) - abstract list(args: { - alias?: string; - provider?: string; - }): Promise; -} - -// @public -export abstract class AbstractIdentifierProvider { - // (undocumented) - abstract addKey(args: { - identifier: IIdentifier; - key: IKey; - options?: any; - }, context: IAgentContext): Promise; - // (undocumented) - abstract addService(args: { - identifier: IIdentifier; - service: IService; - options?: any; - }, context: IAgentContext): Promise; - // (undocumented) - abstract createIdentifier(args: { - kms?: string; - alias?: string; - options?: any; - }, context: IAgentContext): Promise>; - // (undocumented) - abstract deleteIdentifier(args: IIdentifier, context: IAgentContext): Promise; - // (undocumented) - abstract removeKey(args: { - identifier: IIdentifier; - kid: string; - options?: any; - }, context: IAgentContext): Promise; - // (undocumented) - abstract removeService(args: { - identifier: IIdentifier; - id: string; - options?: any; - }, context: IAgentContext): Promise; -} - -// @public -export class DIDManager implements IAgentPlugin { - constructor(options: { - providers: Record; - defaultProvider: string; - store: AbstractDIDStore; - }); - // (undocumented) - didManagerAddKey({ did, key, options }: IDIDManagerAddKeyArgs, context: IAgentContext): Promise; - // (undocumented) - didManagerAddService({ did, service, options }: IDIDManagerAddServiceArgs, context: IAgentContext): Promise; - // (undocumented) - didManagerCreate(args: IDIDManagerCreateArgs, context: IAgentContext): Promise; - // (undocumented) - didManagerDelete({ did }: IDIDManagerDeleteArgs, context: IAgentContext): Promise; - // (undocumented) - didManagerFind(args: IDIDManagerFindArgs): Promise; - // (undocumented) - didManagerGet({ did }: IDIDManagerGetArgs): Promise; - // (undocumented) - didManagerGetByAlias({ alias, provider }: IDIDManagerGetByAliasArgs): Promise; - // (undocumented) - didManagerGetOrCreate({ provider, alias, kms, options }: IDIDManagerGetOrCreateArgs, context: IAgentContext): Promise; - // (undocumented) - didManagerGetProviders(): Promise; - // (undocumented) - didManagerImport(identifier: IIdentifier, context: IAgentContext): Promise; - // (undocumented) - didManagerRemoveKey({ did, kid, options }: IDIDManagerRemoveKeyArgs, context: IAgentContext): Promise; - // (undocumented) - didManagerRemoveService({ did, id, options }: IDIDManagerRemoveServiceArgs, context: IAgentContext): Promise; - // (undocumented) - didManagerSetAlias({ did, alias }: IDIDManagerSetAliasArgs, context: IAgentContext): Promise; - readonly methods: IDIDManager; - // (undocumented) - readonly schema: any; - } - - -``` +## API Report File for "@veramo/did-manager" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { IAgentContext } from '@veramo/core'; +import { IAgentPlugin } from '@veramo/core'; +import { IDIDManager } from '@veramo/core'; +import { IDIDManagerAddKeyArgs } from '@veramo/core'; +import { IDIDManagerAddServiceArgs } from '@veramo/core'; +import { IDIDManagerCreateArgs } from '@veramo/core'; +import { IDIDManagerDeleteArgs } from '@veramo/core'; +import { IDIDManagerFindArgs } from '@veramo/core'; +import { IDIDManagerGetArgs } from '@veramo/core'; +import { IDIDManagerGetByAliasArgs } from '@veramo/core'; +import { IDIDManagerGetOrCreateArgs } from '@veramo/core'; +import { IDIDManagerRemoveKeyArgs } from '@veramo/core'; +import { IDIDManagerRemoveServiceArgs } from '@veramo/core'; +import { IDIDManagerSetAliasArgs } from '@veramo/core'; +import { IIdentifier } from '@veramo/core'; +import { IKey } from '@veramo/core'; +import { IKeyManager } from '@veramo/core'; +import { IService } from '@veramo/core'; + +// @public +export abstract class AbstractDIDStore { + // (undocumented) + abstract delete(args: { + did: string; + }): Promise; + // (undocumented) + abstract get(args: { + did: string; + }): Promise; + // (undocumented) + abstract get(args: { + alias: string; + provider: string; + }): Promise; + // (undocumented) + abstract import(args: IIdentifier): Promise; + // (undocumented) + abstract list(args: { + alias?: string; + provider?: string; + }): Promise; +} + +// @public +export abstract class AbstractIdentifierProvider { + // (undocumented) + abstract addKey(args: { + identifier: IIdentifier; + key: IKey; + options?: any; + }, context: IAgentContext): Promise; + // (undocumented) + abstract addService(args: { + identifier: IIdentifier; + service: IService; + options?: any; + }, context: IAgentContext): Promise; + // (undocumented) + abstract createIdentifier(args: { + kms?: string; + alias?: string; + options?: any; + }, context: IAgentContext): Promise>; + // (undocumented) + abstract deleteIdentifier(args: IIdentifier, context: IAgentContext): Promise; + // (undocumented) + abstract removeKey(args: { + identifier: IIdentifier; + kid: string; + options?: any; + }, context: IAgentContext): Promise; + // (undocumented) + abstract removeService(args: { + identifier: IIdentifier; + id: string; + options?: any; + }, context: IAgentContext): Promise; +} + +// @public +export class DIDManager implements IAgentPlugin { + constructor(options: { + providers: Record; + defaultProvider: string; + store: AbstractDIDStore; + }); + // (undocumented) + didManagerAddKey({ did, key, options }: IDIDManagerAddKeyArgs, context: IAgentContext): Promise; + // (undocumented) + didManagerAddService({ did, service, options }: IDIDManagerAddServiceArgs, context: IAgentContext): Promise; + // (undocumented) + didManagerCreate(args: IDIDManagerCreateArgs, context: IAgentContext): Promise; + // (undocumented) + didManagerDelete({ did }: IDIDManagerDeleteArgs, context: IAgentContext): Promise; + // (undocumented) + didManagerFind(args: IDIDManagerFindArgs): Promise; + // (undocumented) + didManagerGet({ did }: IDIDManagerGetArgs): Promise; + // (undocumented) + didManagerGetByAlias({ alias, provider }: IDIDManagerGetByAliasArgs): Promise; + // (undocumented) + didManagerGetOrCreate({ provider, alias, kms, options }: IDIDManagerGetOrCreateArgs, context: IAgentContext): Promise; + // (undocumented) + didManagerGetProviders(): Promise; + // (undocumented) + didManagerImport(identifier: IIdentifier, context: IAgentContext): Promise; + // (undocumented) + didManagerRemoveKey({ did, kid, options }: IDIDManagerRemoveKeyArgs, context: IAgentContext): Promise; + // (undocumented) + didManagerRemoveService({ did, id, options }: IDIDManagerRemoveServiceArgs, context: IAgentContext): Promise; + // (undocumented) + didManagerSetAlias({ did, alias }: IDIDManagerSetAliasArgs, context: IAgentContext): Promise; + readonly methods: IDIDManager; + // (undocumented) + readonly schema: any; + } + + +``` diff --git a/packages/did-manager/package.json b/packages/did-manager/package.json index 5b31dbf05..8a09f2bf2 100644 --- a/packages/did-manager/package.json +++ b/packages/did-manager/package.json @@ -23,7 +23,7 @@ "publishConfig": { "access": "public" }, - "repository": "git@github.com:uport-project/daf.git", + "repository": "git@github.com:uport-project/veramo.git", "author": "Simonas Karuzas ", "contributors": [ { diff --git a/packages/did-provider-ethr/api/did-provider-ethr.api.md b/packages/did-provider-ethr/api/did-provider-ethr.api.md index e3927040f..e6b9cf0cb 100644 --- a/packages/did-provider-ethr/api/did-provider-ethr.api.md +++ b/packages/did-provider-ethr/api/did-provider-ethr.api.md @@ -1,61 +1,61 @@ -## API Report File for "@veramo/did-provider-ethr" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -import { AbstractIdentifierProvider } from '@veramo/did-manager'; -import { IAgentContext } from '@veramo/core'; -import { IIdentifier } from '@veramo/core'; -import { IKey } from '@veramo/core'; -import { IKeyManager } from '@veramo/core'; -import { IService } from '@veramo/core'; - -// @public -export class EthrDIDProvider extends AbstractIdentifierProvider { - constructor(options: { - defaultKms: string; - network: string; - rpcUrl?: string; - web3Provider?: object; - ttl?: number; - gas?: number; - registry?: string; - }); - // (undocumented) - addKey({ identifier, key, options }: { - identifier: IIdentifier; - key: IKey; - options?: any; - }, context: IContext): Promise; - // (undocumented) - addService({ identifier, service, options }: { - identifier: IIdentifier; - service: IService; - options?: any; - }, context: IContext): Promise; - // Warning: (ae-forgotten-export) The symbol "IContext" needs to be exported by the entry point index.d.ts - // - // (undocumented) - createIdentifier({ kms, options }: { - kms?: string; - options?: any; - }, context: IContext): Promise>; - // (undocumented) - deleteIdentifier(identifier: IIdentifier, context: IContext): Promise; - // (undocumented) - removeKey(args: { - identifier: IIdentifier; - kid: string; - options?: any; - }, context: IContext): Promise; - // (undocumented) - removeService(args: { - identifier: IIdentifier; - id: string; - options?: any; - }, context: IContext): Promise; - } - - -``` +## API Report File for "@veramo/did-provider-ethr" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { AbstractIdentifierProvider } from '@veramo/did-manager'; +import { IAgentContext } from '@veramo/core'; +import { IIdentifier } from '@veramo/core'; +import { IKey } from '@veramo/core'; +import { IKeyManager } from '@veramo/core'; +import { IService } from '@veramo/core'; + +// @public +export class EthrDIDProvider extends AbstractIdentifierProvider { + constructor(options: { + defaultKms: string; + network: string; + rpcUrl?: string; + web3Provider?: object; + ttl?: number; + gas?: number; + registry?: string; + }); + // (undocumented) + addKey({ identifier, key, options }: { + identifier: IIdentifier; + key: IKey; + options?: any; + }, context: IContext): Promise; + // (undocumented) + addService({ identifier, service, options }: { + identifier: IIdentifier; + service: IService; + options?: any; + }, context: IContext): Promise; + // Warning: (ae-forgotten-export) The symbol "IContext" needs to be exported by the entry point index.d.ts + // + // (undocumented) + createIdentifier({ kms, options }: { + kms?: string; + options?: any; + }, context: IContext): Promise>; + // (undocumented) + deleteIdentifier(identifier: IIdentifier, context: IContext): Promise; + // (undocumented) + removeKey(args: { + identifier: IIdentifier; + kid: string; + options?: any; + }, context: IContext): Promise; + // (undocumented) + removeService(args: { + identifier: IIdentifier; + id: string; + options?: any; + }, context: IContext): Promise; + } + + +``` diff --git a/packages/did-provider-ethr/package.json b/packages/did-provider-ethr/package.json index be4e0fb5a..6a3617637 100644 --- a/packages/did-provider-ethr/package.json +++ b/packages/did-provider-ethr/package.json @@ -29,7 +29,7 @@ "publishConfig": { "access": "public" }, - "repository": "git@github.com:uport-project/daf.git", + "repository": "git@github.com:uport-project/veramo.git", "author": "Simonas Karuzas ", "contributors": [ { diff --git a/packages/did-provider-web/api/did-provider-web.api.md b/packages/did-provider-web/api/did-provider-web.api.md index dc2b14a05..c61a7f9f2 100644 --- a/packages/did-provider-web/api/did-provider-web.api.md +++ b/packages/did-provider-web/api/did-provider-web.api.md @@ -1,55 +1,55 @@ -## API Report File for "@veramo/did-provider-web" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -import { AbstractIdentifierProvider } from '@veramo/did-manager'; -import { IAgentContext } from '@veramo/core'; -import { IIdentifier } from '@veramo/core'; -import { IKey } from '@veramo/core'; -import { IKeyManager } from '@veramo/core'; -import { IService } from '@veramo/core'; - -// @public -export class WebDIDProvider extends AbstractIdentifierProvider { - constructor(options: { - defaultKms: string; - }); - // (undocumented) - addKey({ identifier, key, options }: { - identifier: IIdentifier; - key: IKey; - options?: any; - }, context: IContext): Promise; - // (undocumented) - addService({ identifier, service, options }: { - identifier: IIdentifier; - service: IService; - options?: any; - }, context: IContext): Promise; - // Warning: (ae-forgotten-export) The symbol "IContext" needs to be exported by the entry point index.d.ts - // - // (undocumented) - createIdentifier({ kms, alias }: { - kms?: string; - alias?: string; - }, context: IContext): Promise>; - // (undocumented) - deleteIdentifier(identifier: IIdentifier, context: IContext): Promise; - // (undocumented) - removeKey(args: { - identifier: IIdentifier; - kid: string; - options?: any; - }, context: IContext): Promise; - // (undocumented) - removeService(args: { - identifier: IIdentifier; - id: string; - options?: any; - }, context: IContext): Promise; -} - - -``` +## API Report File for "@veramo/did-provider-web" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { AbstractIdentifierProvider } from '@veramo/did-manager'; +import { IAgentContext } from '@veramo/core'; +import { IIdentifier } from '@veramo/core'; +import { IKey } from '@veramo/core'; +import { IKeyManager } from '@veramo/core'; +import { IService } from '@veramo/core'; + +// @public +export class WebDIDProvider extends AbstractIdentifierProvider { + constructor(options: { + defaultKms: string; + }); + // (undocumented) + addKey({ identifier, key, options }: { + identifier: IIdentifier; + key: IKey; + options?: any; + }, context: IContext): Promise; + // (undocumented) + addService({ identifier, service, options }: { + identifier: IIdentifier; + service: IService; + options?: any; + }, context: IContext): Promise; + // Warning: (ae-forgotten-export) The symbol "IContext" needs to be exported by the entry point index.d.ts + // + // (undocumented) + createIdentifier({ kms, alias }: { + kms?: string; + alias?: string; + }, context: IContext): Promise>; + // (undocumented) + deleteIdentifier(identifier: IIdentifier, context: IContext): Promise; + // (undocumented) + removeKey(args: { + identifier: IIdentifier; + kid: string; + options?: any; + }, context: IContext): Promise; + // (undocumented) + removeService(args: { + identifier: IIdentifier; + id: string; + options?: any; + }, context: IContext): Promise; +} + + +``` diff --git a/packages/did-provider-web/package.json b/packages/did-provider-web/package.json index e816afa87..989cd71c4 100644 --- a/packages/did-provider-web/package.json +++ b/packages/did-provider-web/package.json @@ -26,7 +26,7 @@ "publishConfig": { "access": "public" }, - "repository": "git@github.com:uport-project/daf.git", + "repository": "git@github.com:uport-project/veramo.git", "author": "Simonas Karuzas ", "contributors": [ { diff --git a/packages/did-resolver/api/did-resolver.api.md b/packages/did-resolver/api/did-resolver.api.md index ad661a2b2..9286aa9b7 100644 --- a/packages/did-resolver/api/did-resolver.api.md +++ b/packages/did-resolver/api/did-resolver.api.md @@ -1,33 +1,33 @@ -## API Report File for "@veramo/did-resolver" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -import { DIDDocument } from 'did-resolver'; -import { IAgentPlugin } from '@veramo/core'; -import { IResolver } from '@veramo/core'; -import { Resolver } from 'did-resolver'; - -// @public (undocumented) -export class DIDResolverPlugin implements IAgentPlugin { - // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts - constructor(options: Options); - // (undocumented) - readonly methods: IResolver; - // (undocumented) - resolveDid({ didUrl }: { - didUrl: string; - }): Promise; - // (undocumented) - readonly schema: any; -} - -// @public (undocumented) -export class UniversalResolver { - // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts - constructor(options: Options_2); -} - - -``` +## API Report File for "@veramo/did-resolver" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { DIDDocument } from 'did-resolver'; +import { IAgentPlugin } from '@veramo/core'; +import { IResolver } from '@veramo/core'; +import { Resolver } from 'did-resolver'; + +// @public (undocumented) +export class DIDResolverPlugin implements IAgentPlugin { + // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts + constructor(options: Options); + // (undocumented) + readonly methods: IResolver; + // (undocumented) + resolveDid({ didUrl }: { + didUrl: string; + }): Promise; + // (undocumented) + readonly schema: any; +} + +// @public (undocumented) +export class UniversalResolver { + // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts + constructor(options: Options_2); +} + + +``` diff --git a/packages/did-resolver/package.json b/packages/did-resolver/package.json index 9b8b5fa8c..c0d6e4d37 100644 --- a/packages/did-resolver/package.json +++ b/packages/did-resolver/package.json @@ -29,7 +29,7 @@ "publishConfig": { "access": "public" }, - "repository": "git@github.com:uport-project/daf.git", + "repository": "git@github.com:uport-project/veramo.git", "author": "Simonas Karuzas ", "contributors": [ { diff --git a/packages/key-manager/api/key-manager.api.md b/packages/key-manager/api/key-manager.api.md index 6c6ca4438..242bd7613 100644 --- a/packages/key-manager/api/key-manager.api.md +++ b/packages/key-manager/api/key-manager.api.md @@ -1,106 +1,106 @@ -## API Report File for "@veramo/key-manager" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -import { EcdsaSignature } from '@veramo/core'; -import { IAgentPlugin } from '@veramo/core'; -import { IKey } from '@veramo/core'; -import { IKeyManager } from '@veramo/core'; -import { IKeyManagerCreateArgs } from '@veramo/core'; -import { IKeyManagerDecryptJWEArgs } from '@veramo/core'; -import { IKeyManagerDeleteArgs } from '@veramo/core'; -import { IKeyManagerEncryptJWEArgs } from '@veramo/core'; -import { IKeyManagerGetArgs } from '@veramo/core'; -import { IKeyManagerSignEthTXArgs } from '@veramo/core'; -import { IKeyManagerSignJWTArgs } from '@veramo/core'; -import { TKeyType } from '@veramo/core'; - -// @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; -} - -// @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; -} - -// @public (undocumented) -export abstract class AbstractSecretBox { - // (undocumented) - abstract decrypt(encryptedMessageHex: string): Promise; - // (undocumented) - abstract encrypt(message: string): Promise; -} - -// @public -export class KeyManager implements IAgentPlugin { - constructor(options: { - store: AbstractKeyStore; - kms: Record; - }); - // (undocumented) - keyManagerCreate(args: IKeyManagerCreateArgs): Promise; - // (undocumented) - keyManagerDecryptJWE({ kid, data }: IKeyManagerDecryptJWEArgs): Promise; - // (undocumented) - keyManagerDelete({ kid }: IKeyManagerDeleteArgs): Promise; - // (undocumented) - keyManagerEncryptJWE({ kid, to, data }: IKeyManagerEncryptJWEArgs): Promise; - // (undocumented) - keyManagerGet({ kid }: IKeyManagerGetArgs): Promise; - // (undocumented) - keyManagerGetKeyManagementSystems(): Promise>; - // (undocumented) - keyManagerImport(key: IKey): Promise; - // (undocumented) - keyManagerSignEthTX({ kid, transaction }: IKeyManagerSignEthTXArgs): Promise; - // (undocumented) - keyManagerSignJWT({ kid, data }: IKeyManagerSignJWTArgs): Promise; - readonly methods: IKeyManager; - // (undocumented) - readonly schema: any; - } - - -``` +## API Report File for "@veramo/key-manager" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { EcdsaSignature } from '@veramo/core'; +import { IAgentPlugin } from '@veramo/core'; +import { IKey } from '@veramo/core'; +import { IKeyManager } from '@veramo/core'; +import { IKeyManagerCreateArgs } from '@veramo/core'; +import { IKeyManagerDecryptJWEArgs } from '@veramo/core'; +import { IKeyManagerDeleteArgs } from '@veramo/core'; +import { IKeyManagerEncryptJWEArgs } from '@veramo/core'; +import { IKeyManagerGetArgs } from '@veramo/core'; +import { IKeyManagerSignEthTXArgs } from '@veramo/core'; +import { IKeyManagerSignJWTArgs } from '@veramo/core'; +import { TKeyType } from '@veramo/core'; + +// @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; +} + +// @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; +} + +// @public (undocumented) +export abstract class AbstractSecretBox { + // (undocumented) + abstract decrypt(encryptedMessageHex: string): Promise; + // (undocumented) + abstract encrypt(message: string): Promise; +} + +// @public +export class KeyManager implements IAgentPlugin { + constructor(options: { + store: AbstractKeyStore; + kms: Record; + }); + // (undocumented) + keyManagerCreate(args: IKeyManagerCreateArgs): Promise; + // (undocumented) + keyManagerDecryptJWE({ kid, data }: IKeyManagerDecryptJWEArgs): Promise; + // (undocumented) + keyManagerDelete({ kid }: IKeyManagerDeleteArgs): Promise; + // (undocumented) + keyManagerEncryptJWE({ kid, to, data }: IKeyManagerEncryptJWEArgs): Promise; + // (undocumented) + keyManagerGet({ kid }: IKeyManagerGetArgs): Promise; + // (undocumented) + keyManagerGetKeyManagementSystems(): Promise>; + // (undocumented) + keyManagerImport(key: IKey): Promise; + // (undocumented) + keyManagerSignEthTX({ kid, transaction }: IKeyManagerSignEthTXArgs): Promise; + // (undocumented) + keyManagerSignJWT({ kid, data }: IKeyManagerSignJWTArgs): Promise; + readonly methods: IKeyManager; + // (undocumented) + readonly schema: any; + } + + +``` diff --git a/packages/key-manager/package.json b/packages/key-manager/package.json index 5662771fa..dbebe5dab 100644 --- a/packages/key-manager/package.json +++ b/packages/key-manager/package.json @@ -23,7 +23,7 @@ "publishConfig": { "access": "public" }, - "repository": "git@github.com:uport-project/daf.git", + "repository": "git@github.com:uport-project/veramo.git", "author": "Simonas Karuzas ", "contributors": [ { diff --git a/packages/kms-local-react-native/api/kms-local-react-native.api.md b/packages/kms-local-react-native/api/kms-local-react-native.api.md index 5f76b8082..fcf9d99b5 100644 --- a/packages/kms-local-react-native/api/kms-local-react-native.api.md +++ b/packages/kms-local-react-native/api/kms-local-react-native.api.md @@ -1,58 +1,58 @@ -## API Report File for "@veramo/kms-local-react-native" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -import { AbstractKeyManagementSystem } from '@veramo/key-manager'; -import { AbstractSecretBox } from '@veramo/key-manager'; -import { EcdsaSignature } from '@veramo/core'; -import { IKey } from '@veramo/core'; -import { TKeyType } from '@veramo/core'; - -// @public (undocumented) -export class KeyManagementSystem extends AbstractKeyManagementSystem { - // (undocumented) - createKey({ type }: { - type: TKeyType; - }): Promise>; - // (undocumented) - decryptJWE({ key, data }: { - key: IKey; - data: string; - }): Promise; - // (undocumented) - deleteKey(args: { - kid: string; - }): Promise; - // (undocumented) - encryptJWE({ key, to, data }: { - key: IKey; - to: IKey; - data: string; - }): Promise; - // (undocumented) - signEthTX({ key, transaction }: { - key: IKey; - transaction: object; - }): Promise; - // (undocumented) - signJWT({ key, data }: { - key: IKey; - data: string; - }): Promise; -} - -// @public (undocumented) -export class SecretBox extends AbstractSecretBox { - constructor(secretKey: string); - // (undocumented) - static createSecretKey(): Promise; - // (undocumented) - decrypt(encryptedMessageHex: string): Promise; - // (undocumented) - encrypt(message: string): Promise; - } - - -``` +## API Report File for "@veramo/kms-local-react-native" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { AbstractKeyManagementSystem } from '@veramo/key-manager'; +import { AbstractSecretBox } from '@veramo/key-manager'; +import { EcdsaSignature } from '@veramo/core'; +import { IKey } from '@veramo/core'; +import { TKeyType } from '@veramo/core'; + +// @public (undocumented) +export class KeyManagementSystem extends AbstractKeyManagementSystem { + // (undocumented) + createKey({ type }: { + type: TKeyType; + }): Promise>; + // (undocumented) + decryptJWE({ key, data }: { + key: IKey; + data: string; + }): Promise; + // (undocumented) + deleteKey(args: { + kid: string; + }): Promise; + // (undocumented) + encryptJWE({ key, to, data }: { + key: IKey; + to: IKey; + data: string; + }): Promise; + // (undocumented) + signEthTX({ key, transaction }: { + key: IKey; + transaction: object; + }): Promise; + // (undocumented) + signJWT({ key, data }: { + key: IKey; + data: string; + }): Promise; +} + +// @public (undocumented) +export class SecretBox extends AbstractSecretBox { + constructor(secretKey: string); + // (undocumented) + static createSecretKey(): Promise; + // (undocumented) + decrypt(encryptedMessageHex: string): Promise; + // (undocumented) + encrypt(message: string): Promise; + } + + +``` diff --git a/packages/kms-local-react-native/package.json b/packages/kms-local-react-native/package.json index 665cf44ae..a914b796a 100644 --- a/packages/kms-local-react-native/package.json +++ b/packages/kms-local-react-native/package.json @@ -35,7 +35,7 @@ "publishConfig": { "access": "public" }, - "repository": "git@github.com:uport-project/daf.git", + "repository": "git@github.com:uport-project/veramo.git", "author": "Simonas Karuzas ", "contributors": [ { diff --git a/packages/kms-local/api/kms-local.api.md b/packages/kms-local/api/kms-local.api.md index 57d0d33f9..63187c16d 100644 --- a/packages/kms-local/api/kms-local.api.md +++ b/packages/kms-local/api/kms-local.api.md @@ -1,58 +1,58 @@ -## API Report File for "@veramo/kms-local" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -import { AbstractKeyManagementSystem } from '@veramo/key-manager'; -import { AbstractSecretBox } from '@veramo/key-manager'; -import { EcdsaSignature } from '@veramo/core'; -import { IKey } from '@veramo/core'; -import { TKeyType } from '@veramo/core'; - -// @public (undocumented) -export class KeyManagementSystem extends AbstractKeyManagementSystem { - // (undocumented) - createKey({ type }: { - type: TKeyType; - }): Promise>; - // (undocumented) - decryptJWE({ key, data }: { - key: IKey; - data: string; - }): Promise; - // (undocumented) - deleteKey(args: { - kid: string; - }): Promise; - // (undocumented) - encryptJWE({ key, to, data }: { - key: IKey; - to: IKey; - data: string; - }): Promise; - // (undocumented) - signEthTX({ key, transaction }: { - key: IKey; - transaction: object; - }): Promise; - // (undocumented) - signJWT({ key, data }: { - key: IKey; - data: string; - }): Promise; -} - -// @public (undocumented) -export class SecretBox extends AbstractSecretBox { - constructor(secretKey: string); - // (undocumented) - static createSecretKey(): Promise; - // (undocumented) - decrypt(encryptedMessageHex: string): Promise; - // (undocumented) - encrypt(message: string): Promise; - } - - -``` +## API Report File for "@veramo/kms-local" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { AbstractKeyManagementSystem } from '@veramo/key-manager'; +import { AbstractSecretBox } from '@veramo/key-manager'; +import { EcdsaSignature } from '@veramo/core'; +import { IKey } from '@veramo/core'; +import { TKeyType } from '@veramo/core'; + +// @public (undocumented) +export class KeyManagementSystem extends AbstractKeyManagementSystem { + // (undocumented) + createKey({ type }: { + type: TKeyType; + }): Promise>; + // (undocumented) + decryptJWE({ key, data }: { + key: IKey; + data: string; + }): Promise; + // (undocumented) + deleteKey(args: { + kid: string; + }): Promise; + // (undocumented) + encryptJWE({ key, to, data }: { + key: IKey; + to: IKey; + data: string; + }): Promise; + // (undocumented) + signEthTX({ key, transaction }: { + key: IKey; + transaction: object; + }): Promise; + // (undocumented) + signJWT({ key, data }: { + key: IKey; + data: string; + }): Promise; +} + +// @public (undocumented) +export class SecretBox extends AbstractSecretBox { + constructor(secretKey: string); + // (undocumented) + static createSecretKey(): Promise; + // (undocumented) + decrypt(encryptedMessageHex: string): Promise; + // (undocumented) + encrypt(message: string): Promise; + } + + +``` diff --git a/packages/kms-local/package.json b/packages/kms-local/package.json index 7637ad162..19d223268 100644 --- a/packages/kms-local/package.json +++ b/packages/kms-local/package.json @@ -33,7 +33,7 @@ "publishConfig": { "access": "public" }, - "repository": "git@github.com:uport-project/daf.git", + "repository": "git@github.com:uport-project/veramo.git", "author": "Simonas Karuzas ", "contributors": [ { diff --git a/packages/message-handler/api/message-handler.api.md b/packages/message-handler/api/message-handler.api.md index 7c683646f..fc6110c60 100644 --- a/packages/message-handler/api/message-handler.api.md +++ b/packages/message-handler/api/message-handler.api.md @@ -1,82 +1,82 @@ -## API Report File for "@veramo/message-handler" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -import { IAgentContext } from '@veramo/core'; -import { IAgentPlugin } from '@veramo/core'; -import { IDataStore } from '@veramo/core'; -import { IHandleMessageArgs } from '@veramo/core'; -import { IMessage } from '@veramo/core'; -import { IMessageHandler } from '@veramo/core'; -import { IMetaData } from '@veramo/core'; -import { VerifiableCredential } from '@veramo/core'; -import { VerifiablePresentation } from '@veramo/core'; - -// @public -export abstract class AbstractMessageHandler { - // (undocumented) - handle(message: Message, context: IAgentContext<{}>): Promise; - // (undocumented) - nextMessageHandler?: AbstractMessageHandler; - // (undocumented) - setNext(messageHandler: AbstractMessageHandler): AbstractMessageHandler; -} - -// @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; -} - -// @public -export class MessageHandler implements IAgentPlugin { - constructor(options: { - messageHandlers: AbstractMessageHandler[]; - }); - // (undocumented) - handleMessage(args: IHandleMessageArgs, context: IAgentContext): Promise; - readonly methods: IMessageHandler; - // (undocumented) - readonly schema: any; -} - - -``` +## API Report File for "@veramo/message-handler" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { IAgentContext } from '@veramo/core'; +import { IAgentPlugin } from '@veramo/core'; +import { IDataStore } from '@veramo/core'; +import { IHandleMessageArgs } from '@veramo/core'; +import { IMessage } from '@veramo/core'; +import { IMessageHandler } from '@veramo/core'; +import { IMetaData } from '@veramo/core'; +import { VerifiableCredential } from '@veramo/core'; +import { VerifiablePresentation } from '@veramo/core'; + +// @public +export abstract class AbstractMessageHandler { + // (undocumented) + handle(message: Message, context: IAgentContext<{}>): Promise; + // (undocumented) + nextMessageHandler?: AbstractMessageHandler; + // (undocumented) + setNext(messageHandler: AbstractMessageHandler): AbstractMessageHandler; +} + +// @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; +} + +// @public +export class MessageHandler implements IAgentPlugin { + constructor(options: { + messageHandlers: AbstractMessageHandler[]; + }); + // (undocumented) + handleMessage(args: IHandleMessageArgs, context: IAgentContext): Promise; + readonly methods: IMessageHandler; + // (undocumented) + readonly schema: any; +} + + +``` diff --git a/packages/message-handler/package.json b/packages/message-handler/package.json index c97d8318b..43d5f7eaf 100644 --- a/packages/message-handler/package.json +++ b/packages/message-handler/package.json @@ -23,7 +23,7 @@ "publishConfig": { "access": "public" }, - "repository": "git@github.com:uport-project/daf.git", + "repository": "git@github.com:uport-project/veramo.git", "author": "Simonas Karuzas ", "contributors": [ { diff --git a/packages/remote-client/api/remote-client.api.md b/packages/remote-client/api/remote-client.api.md index 45e52dc97..1fca9370b 100644 --- a/packages/remote-client/api/remote-client.api.md +++ b/packages/remote-client/api/remote-client.api.md @@ -1,31 +1,31 @@ -## API Report File for "@veramo/remote-client" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -import { IAgent } from '@veramo/core'; -import { IAgentPlugin } from '@veramo/core'; -import { IAgentPluginSchema } from '@veramo/core'; -import { IPluginMethodMap } from '@veramo/core'; -import { OpenAPIV3 } from 'openapi-types'; - -// @public (undocumented) -export class AgentRestClient implements IAgentPlugin { - constructor(options: { - url: string; - enabledMethods: string[]; - schema?: IAgentPluginSchema; - headers?: Record; - }); - // (undocumented) - readonly methods: IPluginMethodMap; - // (undocumented) - readonly schema?: IAgentPluginSchema; - } - -// @public (undocumented) -export const getOpenApiSchema: (agent: IAgent, basePath: string, exposedMethods: Array, name?: string | undefined, version?: string | undefined) => OpenAPIV3.Document; - - -``` +## API Report File for "@veramo/remote-client" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { IAgent } from '@veramo/core'; +import { IAgentPlugin } from '@veramo/core'; +import { IAgentPluginSchema } from '@veramo/core'; +import { IPluginMethodMap } from '@veramo/core'; +import { OpenAPIV3 } from 'openapi-types'; + +// @public (undocumented) +export class AgentRestClient implements IAgentPlugin { + constructor(options: { + url: string; + enabledMethods: string[]; + schema?: IAgentPluginSchema; + headers?: Record; + }); + // (undocumented) + readonly methods: IPluginMethodMap; + // (undocumented) + readonly schema?: IAgentPluginSchema; + } + +// @public (undocumented) +export const getOpenApiSchema: (agent: IAgent, basePath: string, exposedMethods: Array, name?: string | undefined, version?: string | undefined) => OpenAPIV3.Document; + + +``` diff --git a/packages/remote-client/package.json b/packages/remote-client/package.json index 923560ce7..24e78527b 100644 --- a/packages/remote-client/package.json +++ b/packages/remote-client/package.json @@ -27,7 +27,7 @@ "publishConfig": { "access": "public" }, - "repository": "git@github.com:uport-project/daf.git", + "repository": "git@github.com:uport-project/veramo.git", "author": "Simonas Karuzas ", "contributors": [ { diff --git a/packages/remote-server/api/remote-server.api.md b/packages/remote-server/api/remote-server.api.md index 97c014b94..0c2b5dc95 100644 --- a/packages/remote-server/api/remote-server.api.md +++ b/packages/remote-server/api/remote-server.api.md @@ -1,47 +1,47 @@ -## API Report File for "@veramo/remote-server" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -import { IAgent } from '@veramo/core'; -import { IDIDManager } from '@veramo/core'; -import { Request as Request_2 } from 'express'; -import { Router } from 'express'; -import { TAgent } from '@veramo/core'; - -// @public -export const AgentRouter: (options: AgentRouterOptions) => Router; - -// @public (undocumented) -export interface AgentRouterOptions { - exposedMethods: Array; - getAgentForRequest: (req: Request_2) => Promise; -} - -// @public -export const ApiSchemaRouter: (options: ApiSchemaRouterOptions) => Router; - -// @public (undocumented) -export interface ApiSchemaRouterOptions { - apiName?: string; - apiVersion?: string; - basePath: string; - exposedMethods: Array; - getAgentForRequest: (req: Request_2) => Promise; - securityScheme?: string; -} - -// @public (undocumented) -export const didDocEndpoint = "/.well-known/did.json"; - -// @public -export const WebDidDocRouter: (options: WebDidDocRouterOptions) => Router; - -// @public (undocumented) -export interface WebDidDocRouterOptions { - getAgentForRequest: (req: Request_2) => Promise>; -} - - -``` +## API Report File for "@veramo/remote-server" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { IAgent } from '@veramo/core'; +import { IDIDManager } from '@veramo/core'; +import { Request as Request_2 } from 'express'; +import { Router } from 'express'; +import { TAgent } from '@veramo/core'; + +// @public +export const AgentRouter: (options: AgentRouterOptions) => Router; + +// @public (undocumented) +export interface AgentRouterOptions { + exposedMethods: Array; + getAgentForRequest: (req: Request_2) => Promise; +} + +// @public +export const ApiSchemaRouter: (options: ApiSchemaRouterOptions) => Router; + +// @public (undocumented) +export interface ApiSchemaRouterOptions { + apiName?: string; + apiVersion?: string; + basePath: string; + exposedMethods: Array; + getAgentForRequest: (req: Request_2) => Promise; + securityScheme?: string; +} + +// @public (undocumented) +export const didDocEndpoint = "/.well-known/did.json"; + +// @public +export const WebDidDocRouter: (options: WebDidDocRouterOptions) => Router; + +// @public (undocumented) +export interface WebDidDocRouterOptions { + getAgentForRequest: (req: Request_2) => Promise>; +} + + +``` diff --git a/packages/remote-server/package.json b/packages/remote-server/package.json index bda943d44..f8564cf25 100644 --- a/packages/remote-server/package.json +++ b/packages/remote-server/package.json @@ -28,7 +28,7 @@ "publishConfig": { "access": "public" }, - "repository": "git@github.com:uport-project/daf.git", + "repository": "git@github.com:uport-project/veramo.git", "author": "Simonas Karuzas ", "contributors": [ { diff --git a/packages/selective-disclosure/api/selective-disclosure.api.md b/packages/selective-disclosure/api/selective-disclosure.api.md index be8a65ffe..72fbff7a2 100644 --- a/packages/selective-disclosure/api/selective-disclosure.api.md +++ b/packages/selective-disclosure/api/selective-disclosure.api.md @@ -1,133 +1,133 @@ -## API Report File for "@veramo/selective-disclosure" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -import { AbstractMessageHandler } from '@veramo/message-handler'; -import { IAgentContext } from '@veramo/core'; -import { IAgentPlugin } from '@veramo/core'; -import { ICredentialIssuer } from '@veramo/credential-w3c'; -import { IDataStoreORM } from '@veramo/data-store'; -import { IDIDManager } from '@veramo/core'; -import { IKeyManager } from '@veramo/core'; -import { IMessageHandler } from '@veramo/core'; -import { IPluginMethodMap } from '@veramo/core'; -import { Message } from '@veramo/message-handler'; -import { VerifiableCredential } from '@veramo/core'; -import { VerifiablePresentation } from '@veramo/core'; - -// @beta -export interface ICreateProfileCredentialsArgs { - holder: string; - name?: string; - picture?: string; - save: boolean; - send: boolean; - url?: string; - verifier?: string; -} - -// @beta -export interface ICreateSelectiveDisclosureRequestArgs { - // (undocumented) - data: ISelectiveDisclosureRequest; -} - -// @beta -export interface ICredentialRequestInput { - claimType: string; - claimValue?: string; - credentialContext?: string; - credentialType?: string; - essential?: boolean; - issuers?: Issuer[]; - reason?: string; -} - -// @beta -export interface ICredentialsForSdr extends ICredentialRequestInput { - // (undocumented) - credentials: VerifiableCredential[]; -} - -// @beta -export interface IGetVerifiableCredentialsForSdrArgs { - did?: string; - sdr: Omit; -} - -// @beta -export interface IPresentationValidationResult { - // (undocumented) - claims: ICredentialsForSdr[]; - // (undocumented) - valid: boolean; -} - -// @beta -export interface ISelectiveDisclosure extends IPluginMethodMap { - // (undocumented) - createProfilePresentation(args: ICreateProfileCredentialsArgs, context: IAgentContext): Promise; - // (undocumented) - createSelectiveDisclosureRequest(args: ICreateSelectiveDisclosureRequestArgs, context: IAgentContext): Promise; - // (undocumented) - getVerifiableCredentialsForSdr(args: IGetVerifiableCredentialsForSdrArgs, context: IAgentContext): Promise>; - // (undocumented) - validatePresentationAgainstSdr(args: IValidatePresentationAgainstSdrArgs, context: IAgentContext<{}>): Promise; -} - -// @beta -export interface ISelectiveDisclosureRequest { - claims: ICredentialRequestInput[]; - credentials?: string[]; - issuer: string; - replyUrl?: string; - subject?: string; - // (undocumented) - tag?: string; -} - -// @beta -export interface Issuer { - did: string; - url: string; -} - -// @beta -export interface IValidatePresentationAgainstSdrArgs { - // (undocumented) - presentation: VerifiablePresentation; - // (undocumented) - sdr: ISelectiveDisclosureRequest; -} - -// @beta -export const MessageTypes: { - sdr: string; -}; - -// @public (undocumented) -export const schema: any; - -// @beta -export class SdrMessageHandler extends AbstractMessageHandler { - // (undocumented) - handle(message: Message, context: IAgentContext): Promise; - } - -// @beta -export class SelectiveDisclosure implements IAgentPlugin { - constructor(); - createProfilePresentation(args: ICreateProfileCredentialsArgs, context: IAgentContext): Promise; - createSelectiveDisclosureRequest(args: ICreateSelectiveDisclosureRequestArgs, context: IAgentContext): Promise; - getVerifiableCredentialsForSdr(args: IGetVerifiableCredentialsForSdrArgs, context: IAgentContext): Promise; - // (undocumented) - readonly methods: ISelectiveDisclosure; - // (undocumented) - readonly schema: any; - validatePresentationAgainstSdr(args: IValidatePresentationAgainstSdrArgs, context: IAgentContext<{}>): Promise; -} - - -``` +## API Report File for "@veramo/selective-disclosure" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { AbstractMessageHandler } from '@veramo/message-handler'; +import { IAgentContext } from '@veramo/core'; +import { IAgentPlugin } from '@veramo/core'; +import { ICredentialIssuer } from '@veramo/credential-w3c'; +import { IDataStoreORM } from '@veramo/data-store'; +import { IDIDManager } from '@veramo/core'; +import { IKeyManager } from '@veramo/core'; +import { IMessageHandler } from '@veramo/core'; +import { IPluginMethodMap } from '@veramo/core'; +import { Message } from '@veramo/message-handler'; +import { VerifiableCredential } from '@veramo/core'; +import { VerifiablePresentation } from '@veramo/core'; + +// @beta +export interface ICreateProfileCredentialsArgs { + holder: string; + name?: string; + picture?: string; + save: boolean; + send: boolean; + url?: string; + verifier?: string; +} + +// @beta +export interface ICreateSelectiveDisclosureRequestArgs { + // (undocumented) + data: ISelectiveDisclosureRequest; +} + +// @beta +export interface ICredentialRequestInput { + claimType: string; + claimValue?: string; + credentialContext?: string; + credentialType?: string; + essential?: boolean; + issuers?: Issuer[]; + reason?: string; +} + +// @beta +export interface ICredentialsForSdr extends ICredentialRequestInput { + // (undocumented) + credentials: VerifiableCredential[]; +} + +// @beta +export interface IGetVerifiableCredentialsForSdrArgs { + did?: string; + sdr: Omit; +} + +// @beta +export interface IPresentationValidationResult { + // (undocumented) + claims: ICredentialsForSdr[]; + // (undocumented) + valid: boolean; +} + +// @beta +export interface ISelectiveDisclosure extends IPluginMethodMap { + // (undocumented) + createProfilePresentation(args: ICreateProfileCredentialsArgs, context: IAgentContext): Promise; + // (undocumented) + createSelectiveDisclosureRequest(args: ICreateSelectiveDisclosureRequestArgs, context: IAgentContext): Promise; + // (undocumented) + getVerifiableCredentialsForSdr(args: IGetVerifiableCredentialsForSdrArgs, context: IAgentContext): Promise>; + // (undocumented) + validatePresentationAgainstSdr(args: IValidatePresentationAgainstSdrArgs, context: IAgentContext<{}>): Promise; +} + +// @beta +export interface ISelectiveDisclosureRequest { + claims: ICredentialRequestInput[]; + credentials?: string[]; + issuer: string; + replyUrl?: string; + subject?: string; + // (undocumented) + tag?: string; +} + +// @beta +export interface Issuer { + did: string; + url: string; +} + +// @beta +export interface IValidatePresentationAgainstSdrArgs { + // (undocumented) + presentation: VerifiablePresentation; + // (undocumented) + sdr: ISelectiveDisclosureRequest; +} + +// @beta +export const MessageTypes: { + sdr: string; +}; + +// @public (undocumented) +export const schema: any; + +// @beta +export class SdrMessageHandler extends AbstractMessageHandler { + // (undocumented) + handle(message: Message, context: IAgentContext): Promise; + } + +// @beta +export class SelectiveDisclosure implements IAgentPlugin { + constructor(); + createProfilePresentation(args: ICreateProfileCredentialsArgs, context: IAgentContext): Promise; + createSelectiveDisclosureRequest(args: ICreateSelectiveDisclosureRequestArgs, context: IAgentContext): Promise; + getVerifiableCredentialsForSdr(args: IGetVerifiableCredentialsForSdrArgs, context: IAgentContext): Promise; + // (undocumented) + readonly methods: ISelectiveDisclosure; + // (undocumented) + readonly schema: any; + validatePresentationAgainstSdr(args: IValidatePresentationAgainstSdrArgs, context: IAgentContext<{}>): Promise; +} + + +``` diff --git a/packages/selective-disclosure/package.json b/packages/selective-disclosure/package.json index 5112af12b..f05370495 100644 --- a/packages/selective-disclosure/package.json +++ b/packages/selective-disclosure/package.json @@ -37,7 +37,7 @@ "publishConfig": { "access": "public" }, - "repository": "git@github.com:uport-project/daf.git", + "repository": "git@github.com:uport-project/veramo.git", "author": "Simonas Karuzas ", "contributors": [ { diff --git a/packages/url-handler/api/url-handler.api.md b/packages/url-handler/api/url-handler.api.md index a987fc290..d2c309b24 100644 --- a/packages/url-handler/api/url-handler.api.md +++ b/packages/url-handler/api/url-handler.api.md @@ -1,18 +1,18 @@ -## API Report File for "@veramo/url-handler" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -import { AbstractMessageHandler } from '@veramo/message-handler'; -import { IAgentContext } from '@veramo/core'; -import { Message } from '@veramo/message-handler'; - -// @public (undocumented) -export class UrlMessageHandler extends AbstractMessageHandler { - // (undocumented) - handle(message: Message, context: IAgentContext<{}>): Promise; -} - - -``` +## API Report File for "@veramo/url-handler" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { AbstractMessageHandler } from '@veramo/message-handler'; +import { IAgentContext } from '@veramo/core'; +import { Message } from '@veramo/message-handler'; + +// @public (undocumented) +export class UrlMessageHandler extends AbstractMessageHandler { + // (undocumented) + handle(message: Message, context: IAgentContext<{}>): Promise; +} + + +``` diff --git a/packages/url-handler/package.json b/packages/url-handler/package.json index da6718eab..33e8bfed6 100644 --- a/packages/url-handler/package.json +++ b/packages/url-handler/package.json @@ -28,7 +28,7 @@ "publishConfig": { "access": "public" }, - "repository": "git@github.com:uport-project/daf.git", + "repository": "git@github.com:uport-project/veramo.git", "author": "Simonas Karuzas ", "contributors": [ {