From c90473a67731eb0cfcaf545afe0d64dfee77809c Mon Sep 17 00:00:00 2001 From: Simonas Karuzas Date: Tue, 24 Nov 2020 12:47:37 +0200 Subject: [PATCH] feat: Generate plugin schema (#277) * feat: Creating VC for plugin schema * feat: Agent config can require relative paths * feat: Creating plugin credentials * feat: Extract examples * feat: Generating plugin schema --- .prettierignore | 6 +- docs/methods.md | 11 +- package.json | 6 +- packages/daf-cli/src/lib/objectCreator.ts | 7 +- packages/daf-cli/src/schema.ts | 75 +- packages/daf-core/api/daf-core.api.json | 21 + packages/daf-core/api/daf-core.api.md | 590 +- packages/daf-core/package.json | 4 +- packages/daf-core/plugin.schema.json | 1640 ++ packages/daf-core/src/index.ts | 2 + packages/daf-core/src/schemas/IDataStore.ts | 384 - .../daf-core/src/schemas/IIdentityManager.ts | 461 - packages/daf-core/src/schemas/IKeyManager.ts | 322 - .../daf-core/src/schemas/IMessageHandler.ts | 285 - packages/daf-core/src/schemas/IResolver.ts | 186 - .../daf-did-comm/api/daf-did-comm.api.json | 23 +- packages/daf-did-comm/api/daf-did-comm.api.md | 270 +- packages/daf-did-comm/package.json | 4 +- packages/daf-did-comm/plugin.schema.json | 311 + packages/daf-did-comm/src/action-handler.ts | 4 +- packages/daf-did-comm/src/index.ts | 2 + packages/daf-did-comm/src/schemas/IDIDComm.ts | 309 - packages/daf-did-jwt/package.json | 2 +- packages/daf-elem-did/package.json | 2 +- packages/daf-ethr-did/package.json | 2 +- packages/daf-express/package.json | 2 +- .../api/daf-identity-manager.api.json | 2 +- .../api/daf-identity-manager.api.md | 417 +- packages/daf-identity-manager/package.json | 2 +- .../src/identity-manager.ts | 5 +- .../api/daf-key-manager.api.json | 2 +- .../api/daf-key-manager.api.md | 277 +- packages/daf-key-manager/package.json | 2 +- packages/daf-key-manager/src/key-manager.ts | 6 +- packages/daf-libsodium/package.json | 2 +- .../api/daf-message-handler.api.json | 1906 +-- .../api/daf-message-handler.api.md | 410 +- packages/daf-message-handler/package.json | 2 +- .../src/message-handler.ts | 13 +- .../daf-react-native-libsodium/package.json | 2 +- .../api/daf-resolver-universal.api.json | 2 +- .../api/daf-resolver-universal.api.md | 163 +- packages/daf-resolver-universal/package.json | 2 +- .../daf-resolver-universal/src/resolver.ts | 5 +- .../daf-resolver/api/daf-resolver.api.json | 2 +- packages/daf-resolver/api/daf-resolver.api.md | 163 +- packages/daf-resolver/package.json | 2 +- packages/daf-resolver/src/resolver.ts | 5 +- packages/daf-rest/api/daf-rest.api.json | 394 +- packages/daf-rest/api/daf-rest.api.md | 63 +- packages/daf-rest/package.json | 2 +- .../api/daf-selective-disclosure.api.json | 3901 ++--- .../api/daf-selective-disclosure.api.md | 706 +- .../daf-selective-disclosure/package.json | 4 +- .../plugin.schema.json | 461 + .../src/action-handler.ts | 4 +- .../daf-selective-disclosure/src/index.ts | 2 + .../src/schemas/ISelectiveDisclosure.ts | 422 - packages/daf-typeorm/api/daf-typeorm.api.json | 12583 ++++++++-------- packages/daf-typeorm/api/daf-typeorm.api.md | 2055 +-- packages/daf-typeorm/package.json | 4 +- packages/daf-typeorm/plugin.schema.json | 964 ++ packages/daf-typeorm/schema.config.json | 6 - packages/daf-typeorm/src/data-store-orm.ts | 6 +- packages/daf-typeorm/src/data-store.ts | 6 +- packages/daf-typeorm/src/index.ts | 2 + .../daf-typeorm/src/schemas/IDataStoreORM.ts | 962 -- packages/daf-url/package.json | 2 +- packages/daf-w3c/api/daf-w3c.api.json | 23 +- packages/daf-w3c/api/daf-w3c.api.md | 292 +- packages/daf-w3c/package.json | 4 +- packages/daf-w3c/plugin.schema.json | 329 + packages/daf-w3c/src/action-handler.ts | 4 +- packages/daf-w3c/src/index.ts | 4 +- .../daf-w3c/src/schemas/ICredentialIssuer.ts | 327 - packages/daf-web-did/package.json | 2 +- scripts/extract-examples.ts | 119 + scripts/generate-schemas.ts | 259 - 78 files changed, 14412 insertions(+), 17823 deletions(-) create mode 100644 packages/daf-core/plugin.schema.json delete mode 100644 packages/daf-core/src/schemas/IDataStore.ts delete mode 100644 packages/daf-core/src/schemas/IIdentityManager.ts delete mode 100644 packages/daf-core/src/schemas/IKeyManager.ts delete mode 100644 packages/daf-core/src/schemas/IMessageHandler.ts delete mode 100644 packages/daf-core/src/schemas/IResolver.ts create mode 100644 packages/daf-did-comm/plugin.schema.json delete mode 100644 packages/daf-did-comm/src/schemas/IDIDComm.ts create mode 100644 packages/daf-selective-disclosure/plugin.schema.json delete mode 100644 packages/daf-selective-disclosure/src/schemas/ISelectiveDisclosure.ts create mode 100644 packages/daf-typeorm/plugin.schema.json delete mode 100644 packages/daf-typeorm/schema.config.json delete mode 100644 packages/daf-typeorm/src/schemas/IDataStoreORM.ts create mode 100644 packages/daf-w3c/plugin.schema.json delete mode 100644 packages/daf-w3c/src/schemas/ICredentialIssuer.ts create mode 100644 scripts/extract-examples.ts delete mode 100644 scripts/generate-schemas.ts diff --git a/.prettierignore b/.prettierignore index bd4817243..d54e58679 100644 --- a/.prettierignore +++ b/.prettierignore @@ -3,7 +3,5 @@ examples build/**/* docs report -packages/daf-rest/src/openApiSchema.ts -.vscode/settings.json -lerna.json -CHANGELOG.md \ No newline at end of file +*.json +*.md \ No newline at end of file diff --git a/docs/methods.md b/docs/methods.md index b444cf8f9..7b1f0445a 100644 --- a/docs/methods.md +++ b/docs/methods.md @@ -16,16 +16,16 @@ expect(doc).toEqual({ id: 'did:ethr:rinkeby:0xb09b66026ba5909a7cfe99b76875431d2b8d5190', publicKey: [ { - id: 'did:ethr:rinkeby:0xb09b66026ba5909a7cfe99b76875431d2b8d5190#owner', + id: 'did:ethr:rinkeby:0xb09b66026ba5909a7cfe99b76875431d2b8d5190#controller', type: 'Secp256k1VerificationKey2018', - owner: 'did:ethr:rinkeby:0xb09b66026ba5909a7cfe99b76875431d2b8d5190', + controller: 'did:ethr:rinkeby:0xb09b66026ba5909a7cfe99b76875431d2b8d5190', ethereumAddress: '0xb09b66026ba5909a7cfe99b76875431d2b8d5190' } ], authentication: [ { type: 'Secp256k1SignatureAuthentication2018', - publicKey: 'did:ethr:rinkeby:0xb09b66026ba5909a7cfe99b76875431d2b8d5190#owner' + publicKey: 'did:ethr:rinkeby:0xb09b66026ba5909a7cfe99b76875431d2b8d5190#controller' } ] }) @@ -227,6 +227,11 @@ Creates a Verifiable Presentation. The payload, signer and format are chosen bas ## [ISelectiveDisclosure](./api/daf-selective-disclosure.iselectivedisclosure.md) +### [createProfilePresentation](./api/daf-selective-disclosure.iselectivedisclosure.createprofilepresentation.md) + + + + ### [createSelectiveDisclosureRequest](./api/daf-selective-disclosure.iselectivedisclosure.createselectivedisclosurerequest.md) diff --git a/package.json b/package.json index cc25f8f57..b33dd0afc 100644 --- a/package.json +++ b/package.json @@ -2,12 +2,12 @@ "name": "daf", "private": true, "scripts": { - "build": "yarn lerna run build && yarn extract-api && yarn generate-schema && yarn docs:api && yarn docs:reference && yarn docs:clean-temp && yarn prettier:examples", + "build": "yarn lerna run build && yarn extract-api && yarn generate-plugin-schema && yarn docs:api && yarn docs:examples && yarn docs:clean-temp && yarn prettier:examples", "publish": "lerna publish", "bootstrap": "lerna bootstrap", "extract-api": "lerna run extract-api", - "generate-schema": "lerna run generate-schema", - "docs:examples": "ts-node --project packages/tsconfig.settings.json ./scripts/generate-schemas.ts", + "generate-plugin-schema": "lerna run generate-plugin-schema", + "docs:examples": "ts-node --project packages/tsconfig.settings.json ./scripts/extract-examples.ts", "docs:api": "ts-node ./scripts/generate-docs.ts", "docs:reference": "api-documenter markdown -i ./temp -o ./docs/api", "docs:clean-temp": "rm -rf ./temp", diff --git a/packages/daf-cli/src/lib/objectCreator.ts b/packages/daf-cli/src/lib/objectCreator.ts index 8740f29fa..10a37d509 100644 --- a/packages/daf-cli/src/lib/objectCreator.ts +++ b/packages/daf-cli/src/lib/objectCreator.ts @@ -1,5 +1,6 @@ import { set, get } from 'jsonpointer' import parse from 'url-parse' +const { resolve } = require('path') export function createObjects(config: object, pointers: Record): any { const objects = {} @@ -39,12 +40,16 @@ export function createObjects(config: object, pointers: Record): let object // console.log('Requiring', objectConfig['$require']) const parsed = parse(objectConfig['$require'], {}, true) - const module = parsed.pathname + let module = parsed.pathname const member = parsed.hash.length > 1 ? parsed.hash.slice(1) : 'default' const type = parsed.query['t'] || 'class' const args = objectConfig['$args'] // console.log({module, member, type, query: parsed.query}) + if (module.slice(0, 2) === './') { + module = resolve(module) + } + const resolvedArgs = args !== undefined ? resolveRefs(args) : [] let required = require(module)[member] if (type === 'class') { diff --git a/packages/daf-cli/src/schema.ts b/packages/daf-cli/src/schema.ts index 27319da4d..f1635b640 100644 --- a/packages/daf-cli/src/schema.ts +++ b/packages/daf-cli/src/schema.ts @@ -1,10 +1,10 @@ import { getAgent } from './setup' import program from 'commander' const fs = require('fs') -import { resolve, dirname } from "path" +import { resolve, dirname } from 'path' import { writeFileSync, readFileSync } from 'fs' -import * as TJS from "ts-json-schema-generator" -import { JSONSchema7 } from "json-schema" +import * as TJS from 'ts-json-schema-generator' +import { JSONSchema7 } from 'json-schema' import { OpenAPIV3 } from 'openapi-types' import { Extractor, ExtractorConfig, ExtractorResult } from '@microsoft/api-extractor' import { @@ -15,6 +15,7 @@ import { ApiReturnTypeMixin, ApiMethodSignature, } from '@microsoft/api-extractor-model' +import { IIdentity } from 'daf-core' interface Method { packageName: string @@ -83,19 +84,36 @@ function getReference(response: string): OpenAPIV3.ReferenceObject | OpenAPIV3.S } program - .command('generatePluginSchema') - .description('Generate DAF plugin schema') - .option('-p, --packageConfig ', 'package.json file containing DAF plugin interface config', './package.json') - .option('-o, --outputFolder ', 'Generated schema typescript file', './src/schemas') + .command('generate-plugin-schema') + .description('Generate plugin schema') + .option('-c, --extractorConfig ', 'API Extractor config file', './api-extractor.json') + .option( + '-p, --packageConfig ', + 'package.json file containing DAF plugin interface config', + './package.json', + ) .action(async (options) => { + const apiExtractorJsonPath: string = resolve(options.extractorConfig) + const extractorConfig: ExtractorConfig = ExtractorConfig.loadFileAndPrepare(apiExtractorJsonPath) + + const extractorResult: ExtractorResult = Extractor.invoke(extractorConfig, { + localBuild: true, + showVerboseMessages: true, + }) + + if (!extractorResult.succeeded) { + console.error( + `API Extractor completed with ${extractorResult.errorCount} errors` + + ` and ${extractorResult.warningCount} warnings`, + ) + process.exitCode = 1 + } const packageConfig = require(resolve(options.packageConfig)) + const interfaces: any = {} for (const pluginInterfaceName in packageConfig.daf.pluginInterfaces) { - const outputFile = resolve(options.outputFolder, pluginInterfaceName + '.ts') - console.log('Writing', outputFile) - const entryFile = packageConfig.daf.pluginInterfaces[pluginInterfaceName] const api = { components: { @@ -107,12 +125,12 @@ program const generator = TJS.createGenerator({ path: resolve(entryFile), encodeRefs: false, - additionalProperties: true + additionalProperties: true, }) const apiModel: ApiModel = new ApiModel() - const apiPackage = apiModel.loadPackage(resolve('./api', packageConfig.name + '.api.json')) - + const apiPackage = apiModel.loadPackage(extractorConfig.apiJsonFilePath) + const entry = apiPackage.entryPoints[0] const pluginInterface = entry.findMembersByName(pluginInterfaceName)[0] @@ -133,7 +151,6 @@ program //@ts-ignore ?.getChildNodes()[0]?.text - method.description = method.description || '' if (method.parameters) { @@ -144,44 +161,36 @@ program ...createSchema(generator, method.parameters).components.schemas, } } - + //@ts-ignore api.components.schemas = { //@ts-ignore ...api.components.schemas, ...createSchema(generator, method.response).components.schemas, } - + //@ts-ignore api.components.methods[method.operationId] = { description: method.description, arguments: getReference(method.parameters), - returnType: getReference(method.response) + returnType: getReference(method.response), } - } - if (!fs.existsSync(resolve(options.outputFolder))) { - fs.mkdirSync(resolve(options.outputFolder)) - } - writeFileSync(outputFile, 'export default ' + JSON.stringify(api, null, 2)) - + interfaces[pluginInterfaceName] = api } - - + writeFileSync(resolve('./plugin.schema.json'), JSON.stringify(interfaces, null, 2)) }) - - program - .command('extractPluginApi') - .description('Extract DAF plugin api ') - .option('-c, --extractorConfig ', 'API Extractor config file') - +program + .command('extract-api') + .description('Extract API') + .option('-c, --extractorConfig ', 'API Extractor config file', './api-extractor.json') .action(async (options) => { - const apiExtractorJsonPath: string = resolve(options.extractorConfig) const extractorConfig: ExtractorConfig = ExtractorConfig.loadFileAndPrepare(apiExtractorJsonPath) + const extractorResult: ExtractorResult = Extractor.invoke(extractorConfig, { localBuild: true, showVerboseMessages: true, @@ -194,6 +203,4 @@ program ) process.exitCode = 1 } - - }) diff --git a/packages/daf-core/api/daf-core.api.json b/packages/daf-core/api/daf-core.api.json index 6ab7bad09..71ba56f47 100644 --- a/packages/daf-core/api/daf-core.api.json +++ b/packages/daf-core/api/daf-core.api.json @@ -5993,6 +5993,27 @@ ], "extendsTokenRanges": [] }, + { + "kind": "Variable", + "canonicalReference": "daf-core!schema:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "schema: " + }, + { + "kind": "Content", + "text": "any" + } + ], + "releaseTag": "Public", + "name": "schema", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, { "kind": "TypeAlias", "canonicalReference": "daf-core!TAgent:type", diff --git a/packages/daf-core/api/daf-core.api.md b/packages/daf-core/api/daf-core.api.md index 0dd1579a2..b7cb2bca2 100644 --- a/packages/daf-core/api/daf-core.api.md +++ b/packages/daf-core/api/daf-core.api.md @@ -3,527 +3,507 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { DIDDocument } from 'did-resolver' + +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 -} + constructor(options?: IAgentOptions); + availableMethods(): string[]; + emit(eventType: string, data: any): Promise; + execute

(method: string, args: P): Promise; + getSchema(): IAgentPluginSchema; + readonly methods: IPluginMethodMap; + } // @public -export function createAgent(options: IAgentOptions): TAgent +export function createAgent(options: IAgentOptions): TAgent; export { DIDDocument } // @public (undocumented) export interface EcdsaSignature { - // (undocumented) - r: string - // (undocumented) - recoveryParam: 1 - // (undocumented) - s: string + // (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 + // (undocumented) + emit: (eventType: string, data: any) => Promise; + // (undocumented) + execute: (method: string, args: A) => Promise; } // @public export interface IAgentBase { - // (undocumented) - availableMethods: () => string[] - // (undocumented) - getSchema: () => IAgentPluginSchema + // (undocumented) + availableMethods: () => string[]; + // (undocumented) + getSchema: () => IAgentPluginSchema; } // @public export interface IAgentContext { - agent: TAgent + agent: TAgent; } // @public export interface IAgentOptions { - authorizedMethods?: string[] - context?: Record - overrides?: IPluginMethodMap - plugins?: IAgentPlugin[] - schemaValidation?: boolean + authorizedMethods?: string[]; + context?: Record; + overrides?: IPluginMethodMap; + plugins?: IAgentPlugin[]; + schemaValidation?: boolean; } // @public export interface IAgentPlugin extends IEventListener { - // (undocumented) - readonly methods?: IPluginMethodMap - // (undocumented) - readonly schema?: IAgentPluginSchema + // (undocumented) + readonly methods?: IPluginMethodMap; + // (undocumented) + readonly schema?: IAgentPluginSchema; } // @public export interface IAgentPluginSchema { - // (undocumented) - components: { - schemas: any - methods: any - } + // (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 + 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 + id: string; } // @public export interface IDataStoreGetVerifiableCredentialArgs { - hash: string + hash: string; } // @public export interface IDataStoreGetVerifiablePresentationArgs { - hash: string + hash: string; } // @public export interface IDataStoreSaveMessageArgs { - message: IMessage + message: IMessage; } // @public export interface IDataStoreSaveVerifiableCredentialArgs { - verifiableCredential: VerifiableCredential + verifiableCredential: VerifiableCredential; } // @public export interface IDataStoreSaveVerifiablePresentationArgs { - verifiablePresentation: VerifiablePresentation + verifiablePresentation: VerifiablePresentation; } // @public export interface IEventListener { - readonly eventTypes?: string[] - onEvent?( - event: { - type: string - data: any - }, - context: IAgentContext<{}>, - ): Promise + readonly eventTypes?: string[]; + onEvent?(event: { + type: string; + data: any; + }, context: IAgentContext<{}>): Promise; } // @public export interface IHandleMessageArgs { - metaData?: IMetaData[] - raw: string - save?: boolean + metaData?: IMetaData[]; + raw: string; + save?: boolean; } // @public export interface IIdentity { - alias?: string - controllerKeyId?: string - did: string - keys: IKey[] - provider: string - services: IService[] + alias?: string; + controllerKeyId?: string; + did: string; + keys: IKey[]; + provider: string; + services: IService[]; } // @public export interface IIdentityManager extends IPluginMethodMap { - identityManagerAddKey(args: IIdentityManagerAddKeyArgs, context: IAgentContext): Promise - identityManagerAddService( - args: IIdentityManagerAddServiceArgs, - context: IAgentContext, - ): Promise - identityManagerCreateIdentity( - args: IIdentityManagerCreateIdentityArgs, - context: IAgentContext, - ): Promise - identityManagerDeleteIdentity( - args: IIdentityManagerDeleteIdentityArgs, - context: IAgentContext, - ): Promise - identityManagerGetIdentities(args: IIdentityManagerGetIdentitiesArgs): Promise> - identityManagerGetIdentity(args: IIdentityManagerGetIdentityArgs): Promise - identityManagerGetIdentityByAlias(args: IIdentityManagerGetIdentityByAliasArgs): Promise - identityManagerGetOrCreateIdentity( - args: IIdentityManagerGetOrCreateIdentityArgs, - context: IAgentContext, - ): Promise - identityManagerGetProviders(): Promise> - identityManagerImportIdentity(args: IIdentity, context: IAgentContext): Promise - identityManagerRemoveKey( - args: IIdentityManagerRemoveKeyArgs, - context: IAgentContext, - ): Promise - identityManagerRemoveService( - args: IIdentityManagerRemoveServiceArgs, - context: IAgentContext, - ): Promise - identityManagerSetAlias( - args: IIdentityManagerSetAliasArgs, - context: IAgentContext, - ): Promise + identityManagerAddKey(args: IIdentityManagerAddKeyArgs, context: IAgentContext): Promise; + identityManagerAddService(args: IIdentityManagerAddServiceArgs, context: IAgentContext): Promise; + identityManagerCreateIdentity(args: IIdentityManagerCreateIdentityArgs, context: IAgentContext): Promise; + identityManagerDeleteIdentity(args: IIdentityManagerDeleteIdentityArgs, context: IAgentContext): Promise; + identityManagerGetIdentities(args: IIdentityManagerGetIdentitiesArgs): Promise>; + identityManagerGetIdentity(args: IIdentityManagerGetIdentityArgs): Promise; + identityManagerGetIdentityByAlias(args: IIdentityManagerGetIdentityByAliasArgs): Promise; + identityManagerGetOrCreateIdentity(args: IIdentityManagerGetOrCreateIdentityArgs, context: IAgentContext): Promise; + identityManagerGetProviders(): Promise>; + identityManagerImportIdentity(args: IIdentity, context: IAgentContext): Promise; + identityManagerRemoveKey(args: IIdentityManagerRemoveKeyArgs, context: IAgentContext): Promise; + identityManagerRemoveService(args: IIdentityManagerRemoveServiceArgs, context: IAgentContext): Promise; + identityManagerSetAlias(args: IIdentityManagerSetAliasArgs, context: IAgentContext): Promise; } // @public export interface IIdentityManagerAddKeyArgs { - did: string - key: IKey - options?: object + did: string; + key: IKey; + options?: object; } // @public export interface IIdentityManagerAddServiceArgs { - did: string - options?: object - service: IService + did: string; + options?: object; + service: IService; } // @public export interface IIdentityManagerCreateIdentityArgs { - alias?: string - kms?: string - options?: object - provider?: string + alias?: string; + kms?: string; + options?: object; + provider?: string; } // @public export interface IIdentityManagerDeleteIdentityArgs { - did: string + did: string; } // @public export interface IIdentityManagerGetIdentitiesArgs { - alias?: string - provider?: string + alias?: string; + provider?: string; } // @public export interface IIdentityManagerGetIdentityArgs { - did: string + did: string; } // @public export interface IIdentityManagerGetIdentityByAliasArgs { - alias: string - provider?: string + alias: string; + provider?: string; } // @public export interface IIdentityManagerGetOrCreateIdentityArgs { - alias: string - kms?: string - options?: object - provider?: string + alias: string; + kms?: string; + options?: object; + provider?: string; } // @public export interface IIdentityManagerRemoveKeyArgs { - did: string - kid: string - options?: object + did: string; + kid: string; + options?: object; } // @public export interface IIdentityManagerRemoveServiceArgs { - did: string - id: string - options?: object + did: string; + id: string; + options?: object; } // @public export interface IIdentityManagerSetAliasArgs { - alias: string - did: string + alias: string; + did: string; } // @public export interface IKey { - kid: string - kms: string - meta?: object | null - privateKeyHex?: string - publicKeyHex: string - type: TKeyType + kid: string; + kms: string; + meta?: object | null; + privateKeyHex?: string; + publicKeyHex: string; + type: TKeyType; } // @public export interface IKeyManager extends IPluginMethodMap { - keyManagerCreateKey(args: IKeyManagerCreateKeyArgs): Promise - // @beta - keyManagerDecryptJWE(args: IKeyManagerDecryptJWEArgs): Promise - keyManagerDeleteKey(args: IKeyManagerDeleteKeyArgs): Promise - // @beta - keyManagerEncryptJWE(args: IKeyManagerEncryptJWEArgs): Promise - keyManagerGetKey(args: IKeyManagerGetKeyArgs): Promise - keyManagerGetKeyManagementSystems(): Promise> - keyManagerImportKey(args: IKey): Promise - keyManagerSignEthTX(args: IKeyManagerSignEthTXArgs): Promise - keyManagerSignJWT(args: IKeyManagerSignJWTArgs): Promise + keyManagerCreateKey(args: IKeyManagerCreateKeyArgs): Promise; + // @beta + keyManagerDecryptJWE(args: IKeyManagerDecryptJWEArgs): Promise; + keyManagerDeleteKey(args: IKeyManagerDeleteKeyArgs): Promise; + // @beta + keyManagerEncryptJWE(args: IKeyManagerEncryptJWEArgs): Promise; + keyManagerGetKey(args: IKeyManagerGetKeyArgs): Promise; + keyManagerGetKeyManagementSystems(): Promise>; + keyManagerImportKey(args: IKey): Promise; + keyManagerSignEthTX(args: IKeyManagerSignEthTXArgs): Promise; + keyManagerSignJWT(args: IKeyManagerSignJWTArgs): Promise; } // @public export interface IKeyManagerCreateKeyArgs { - kms: string - meta?: object - type: TKeyType + kms: string; + meta?: object; + type: TKeyType; } // @beta export interface IKeyManagerDecryptJWEArgs { - data: string - kid: string + data: string; + kid: string; } // @public export interface IKeyManagerDeleteKeyArgs { - kid: string + kid: string; } // @beta export interface IKeyManagerEncryptJWEArgs { - data: string - kid: string - to: Omit + data: string; + kid: string; + to: Omit; } // @public export interface IKeyManagerGetKeyArgs { - kid: string + kid: string; } // @public export interface IKeyManagerSignEthTXArgs { - kid: string - transaction: object + kid: string; + transaction: object; } // @public export interface IKeyManagerSignJWTArgs { - data: string - kid: string + 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 + 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 + handleMessage(args: IHandleMessageArgs, context: IAgentContext): Promise; } // @public export interface IMetaData { - type: string - value?: string + type: string; + value?: string; } // @public export interface IPluginMethod { - // (undocumented) - (args: any, context: any): Promise + // (undocumented) + (args: any, context: any): Promise; } // @public -export interface IPluginMethodMap extends Record {} +export interface IPluginMethodMap extends Record { +} // @public export interface IResolver extends IPluginMethodMap { - resolveDid(args: ResolveDidArgs): Promise + resolveDid(args: ResolveDidArgs): Promise; } // @public export interface IService { - description?: string - id: string - serviceEndpoint: string - type: string + description?: string; + id: string; + serviceEndpoint: string; + type: string; } // @public export interface RemoveContext { - // (undocumented) - (args?: Parameters[0] | undefined): ReturnType + // (undocumented) + (args?: Parameters[0] | undefined): ReturnType; } // @public export interface ResolveDidArgs { - didUrl: string + didUrl: string; } +// @public (undocumented) +export const schema: any; + // @public export type TAgent = { - [P in keyof T]: RemoveContext -} & - IAgent + [P in keyof T]: RemoveContext; +} & IAgent; // @public -export type TKeyType = 'Ed25519' | 'Secp256k1' +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 + 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[] + // (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[] + // (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[] + // (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[] + // (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/daf-core/package.json b/packages/daf-core/package.json index 0c6bf722e..c405ed8d7 100644 --- a/packages/daf-core/package.json +++ b/packages/daf-core/package.json @@ -6,8 +6,7 @@ "types": "build/index.d.ts", "scripts": { "build": "tsc", - "extract-api": "daf extractPluginApi -c ./api-extractor.json", - "generate-schema": "daf generatePluginSchema" + "generate-plugin-schema": "yarn daf generate-plugin-schema" }, "daf": { "pluginInterfaces": { @@ -32,6 +31,7 @@ "files": [ "build/**/*", "src/**/*", + "plugin.schema.json", "README.md", "LICENSE" ], diff --git a/packages/daf-core/plugin.schema.json b/packages/daf-core/plugin.schema.json new file mode 100644 index 000000000..a2932ad11 --- /dev/null +++ b/packages/daf-core/plugin.schema.json @@ -0,0 +1,1640 @@ +{ + "IResolver": { + "components": { + "schemas": { + "ResolveDidArgs": { + "type": "object", + "properties": { + "didUrl": { + "type": "string", + "description": "DID URL" + } + }, + "required": [ + "didUrl" + ], + "description": "Input arguments for {@link IResolver.resolveDid | resolveDid}" + }, + "DIDDocument": { + "type": "object", + "properties": { + "@context": { + "type": "string", + "const": "https://w3id.org/did/v1" + }, + "id": { + "type": "string" + }, + "publicKey": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PublicKey" + } + }, + "authentication": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Authentication" + } + }, + "uportProfile": {}, + "service": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServiceEndpoint" + } + }, + "created": { + "type": "string" + }, + "updated": { + "type": "string" + }, + "proof": { + "$ref": "#/components/schemas/LinkedDataProof" + }, + "keyAgreement": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/PublicKey" + } + ] + } + } + }, + "required": [ + "@context", + "id", + "publicKey" + ] + }, + "PublicKey": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "controller": { + "type": "string" + }, + "ethereumAddress": { + "type": "string" + }, + "publicKeyBase64": { + "type": "string" + }, + "publicKeyBase58": { + "type": "string" + }, + "publicKeyHex": { + "type": "string" + }, + "publicKeyPem": { + "type": "string" + } + }, + "required": [ + "id", + "type", + "controller" + ] + }, + "Authentication": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "publicKey": { + "type": "string" + } + }, + "required": [ + "type", + "publicKey" + ] + }, + "ServiceEndpoint": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "serviceEndpoint": { + "type": "string" + }, + "description": { + "type": "string" + } + }, + "required": [ + "id", + "type", + "serviceEndpoint" + ] + }, + "LinkedDataProof": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "created": { + "type": "string" + }, + "creator": { + "type": "string" + }, + "nonce": { + "type": "string" + }, + "signatureValue": { + "type": "string" + } + }, + "required": [ + "type", + "created", + "creator", + "nonce", + "signatureValue" + ] + } + }, + "methods": { + "resolveDid": { + "description": "Resolves DID and returns DID Document", + "arguments": { + "$ref": "#/components/schemas/ResolveDidArgs" + }, + "returnType": { + "$ref": "#/components/schemas/DIDDocument" + } + } + } + } + }, + "IKeyManager": { + "components": { + "schemas": { + "IKeyManagerCreateKeyArgs": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/TKeyType", + "description": "Key type" + }, + "kms": { + "type": "string", + "description": "Key Management System" + }, + "meta": { + "type": "object", + "description": "Optional. Key meta data" + } + }, + "required": [ + "type", + "kms" + ], + "description": "Input arguments for {@link IKeyManager.keyManagerCreateKey | keyManagerCreateKey}" + }, + "TKeyType": { + "type": "string", + "enum": [ + "Ed25519", + "Secp256k1" + ], + "description": "Cryptographic key type" + }, + "IKey": { + "type": "object", + "properties": { + "kid": { + "type": "string", + "description": "Key ID" + }, + "kms": { + "type": "string", + "description": "Key Management System" + }, + "type": { + "$ref": "#/components/schemas/TKeyType", + "description": "Key type" + }, + "publicKeyHex": { + "type": "string", + "description": "Public key" + }, + "privateKeyHex": { + "type": "string", + "description": "Optional. Private key" + }, + "meta": { + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "description": "Optional. Key metadata. Can be used to store auth data to access remote kms" + } + }, + "required": [ + "kid", + "kms", + "type", + "publicKeyHex" + ], + "description": "Cryptographic key" + }, + "IKeyManagerDecryptJWEArgs": { + "type": "object", + "properties": { + "kid": { + "type": "string", + "description": "Key ID" + }, + "data": { + "type": "string", + "description": "Encrypted data" + } + }, + "required": [ + "kid", + "data" + ], + "description": "Input arguments for {@link IKeyManager.keyManagerDecryptJWE | keyManagerDecryptJWE}" + }, + "IKeyManagerDeleteKeyArgs": { + "type": "object", + "properties": { + "kid": { + "type": "string", + "description": "Key ID" + } + }, + "required": [ + "kid" + ], + "description": "Input arguments for {@link IKeyManager.keyManagerDeleteKey | keyManagerDeleteKey}" + }, + "IKeyManagerEncryptJWEArgs": { + "type": "object", + "properties": { + "kid": { + "type": "string", + "description": "Key ID to use for encryption" + }, + "to": { + "type": "object", + "properties": { + "kid": { + "type": "string", + "description": "Key ID" + }, + "type": { + "$ref": "#/components/schemas/TKeyType", + "description": "Key type" + }, + "publicKeyHex": { + "type": "string", + "description": "Public key" + }, + "privateKeyHex": { + "type": "string", + "description": "Optional. Private key" + }, + "meta": { + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "description": "Optional. Key metadata. Can be used to store auth data to access remote kms" + } + }, + "required": [ + "kid", + "type", + "publicKeyHex" + ], + "description": "Recipient key object" + }, + "data": { + "type": "string", + "description": "Data to encrypt" + } + }, + "required": [ + "kid", + "to", + "data" + ], + "description": "Input arguments for {@link IKeyManager.keyManagerEncryptJWE | keyManagerEncryptJWE}" + }, + "IKeyManagerGetKeyArgs": { + "type": "object", + "properties": { + "kid": { + "type": "string", + "description": "Key ID" + } + }, + "required": [ + "kid" + ], + "description": "Input arguments for {@link IKeyManager.keyManagerGetKey | keyManagerGetKey}" + }, + "IKeyManagerSignEthTXArgs": { + "type": "object", + "properties": { + "kid": { + "type": "string", + "description": "Key ID" + }, + "transaction": { + "type": "object", + "description": "Ethereum transaction object" + } + }, + "required": [ + "kid", + "transaction" + ], + "description": "Input arguments for {@link IKeyManager.keyManagerSignEthTX | keyManagerSignEthTX}" + }, + "IKeyManagerSignJWTArgs": { + "type": "object", + "properties": { + "kid": { + "type": "string", + "description": "Key ID" + }, + "data": { + "type": "string", + "description": "Data to sign" + } + }, + "required": [ + "kid", + "data" + ], + "description": "Input arguments for {@link IKeyManager.keyManagerSignJWT | keyManagerSignJWT}" + }, + "EcdsaSignature": { + "type": "object", + "properties": { + "r": { + "type": "string" + }, + "s": { + "type": "string" + }, + "recoveryParam": { + "type": "number", + "const": 1 + } + }, + "required": [ + "r", + "s", + "recoveryParam" + ] + } + }, + "methods": { + "keyManagerCreateKey": { + "description": "Creates and returns a new key", + "arguments": { + "$ref": "#/components/schemas/IKeyManagerCreateKeyArgs" + }, + "returnType": { + "$ref": "#/components/schemas/IKey" + } + }, + "keyManagerDecryptJWE": { + "description": "Decrypts data", + "arguments": { + "$ref": "#/components/schemas/IKeyManagerDecryptJWEArgs" + }, + "returnType": { + "type": "string" + } + }, + "keyManagerDeleteKey": { + "description": "Deletes a key", + "arguments": { + "$ref": "#/components/schemas/IKeyManagerDeleteKeyArgs" + }, + "returnType": { + "type": "boolean" + } + }, + "keyManagerEncryptJWE": { + "description": "Encrypts data", + "arguments": { + "$ref": "#/components/schemas/IKeyManagerEncryptJWEArgs" + }, + "returnType": { + "type": "string" + } + }, + "keyManagerGetKey": { + "description": "Returns an existing key", + "arguments": { + "$ref": "#/components/schemas/IKeyManagerGetKeyArgs" + }, + "returnType": { + "$ref": "#/components/schemas/IKey" + } + }, + "keyManagerGetKeyManagementSystems": { + "description": "Lists available key management systems", + "arguments": { + "type": "object" + }, + "returnType": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "keyManagerImportKey": { + "description": "Imports a created key", + "arguments": { + "$ref": "#/components/schemas/IKey" + }, + "returnType": { + "type": "boolean" + } + }, + "keyManagerSignEthTX": { + "description": "Signs Ethereum transaction", + "arguments": { + "$ref": "#/components/schemas/IKeyManagerSignEthTXArgs" + }, + "returnType": { + "type": "string" + } + }, + "keyManagerSignJWT": { + "description": "Signs JWT", + "arguments": { + "$ref": "#/components/schemas/IKeyManagerSignJWTArgs" + }, + "returnType": { + "$ref": "#/components/schemas/EcdsaSignature" + } + } + } + } + }, + "IIdentityManager": { + "components": { + "schemas": { + "IIdentityManagerAddKeyArgs": { + "type": "object", + "properties": { + "did": { + "type": "string", + "description": "DID" + }, + "key": { + "$ref": "#/components/schemas/IKey", + "description": "Key object" + }, + "options": { + "type": "object", + "description": "Optional. Identity provider specific options" + } + }, + "required": [ + "did", + "key" + ], + "description": "Input arguments for {@link IIdentityManager.identityManagerAddKey | identityManagerAddKey}" + }, + "IKey": { + "type": "object", + "properties": { + "kid": { + "type": "string", + "description": "Key ID" + }, + "kms": { + "type": "string", + "description": "Key Management System" + }, + "type": { + "$ref": "#/components/schemas/TKeyType", + "description": "Key type" + }, + "publicKeyHex": { + "type": "string", + "description": "Public key" + }, + "privateKeyHex": { + "type": "string", + "description": "Optional. Private key" + }, + "meta": { + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "description": "Optional. Key metadata. Can be used to store auth data to access remote kms" + } + }, + "required": [ + "kid", + "kms", + "type", + "publicKeyHex" + ], + "description": "Cryptographic key" + }, + "TKeyType": { + "type": "string", + "enum": [ + "Ed25519", + "Secp256k1" + ], + "description": "Cryptographic key type" + }, + "IIdentityManagerAddServiceArgs": { + "type": "object", + "properties": { + "did": { + "type": "string", + "description": "DID" + }, + "service": { + "$ref": "#/components/schemas/IService", + "description": "Service object" + }, + "options": { + "type": "object", + "description": "Optional. Identity provider specific options" + } + }, + "required": [ + "did", + "service" + ], + "description": "Input arguments for {@link IIdentityManager.identityManagerAddService | identityManagerAddService}" + }, + "IService": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID" + }, + "type": { + "type": "string", + "description": "Service type" + }, + "serviceEndpoint": { + "type": "string", + "description": "Endpoint URL" + }, + "description": { + "type": "string", + "description": "Optional. Description" + } + }, + "required": [ + "id", + "type", + "serviceEndpoint" + ], + "description": "Identity service" + }, + "IIdentityManagerCreateIdentityArgs": { + "type": "object", + "properties": { + "alias": { + "type": "string", + "description": "Optional. Identity alias. Can be used to reference an object in an external system" + }, + "provider": { + "type": "string", + "description": "Optional. Identity provider" + }, + "kms": { + "type": "string", + "description": "Optional. Key Management System" + }, + "options": { + "type": "object", + "description": "Optional. Identity provider specific options" + } + }, + "description": "Input arguments for {@link IIdentityManager.identityManagerCreateIdentity | identityManagerCreateIdentity}" + }, + "IIdentity": { + "type": "object", + "properties": { + "did": { + "type": "string", + "description": "Decentralized identifier" + }, + "alias": { + "type": "string", + "description": "Optional. Identity alias. Can be used to reference an object in an external system" + }, + "provider": { + "type": "string", + "description": "Identity provider name" + }, + "controllerKeyId": { + "type": "string", + "description": "Controller key id" + }, + "keys": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IKey" + }, + "description": "Array of managed keys" + }, + "services": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IService" + }, + "description": "Array of services" + } + }, + "required": [ + "did", + "provider", + "keys", + "services" + ], + "description": "Identity interface" + }, + "IIdentityManagerDeleteIdentityArgs": { + "type": "object", + "properties": { + "did": { + "type": "string", + "description": "DID" + } + }, + "required": [ + "did" + ], + "description": "Input arguments for {@link IIdentityManager.identityManagerDeleteIdentity | identityManagerDeleteIdentity}" + }, + "IIdentityManagerGetIdentitiesArgs": { + "type": "object", + "properties": { + "alias": { + "type": "string", + "description": "Optional. Alias" + }, + "provider": { + "type": "string", + "description": "Optional. Provider" + } + }, + "description": "Input arguments for {@link IIdentityManager.identityManagerGetIdentities | identityManagerGetIdentities}" + }, + "IIdentityManagerGetIdentityArgs": { + "type": "object", + "properties": { + "did": { + "type": "string", + "description": "DID" + } + }, + "required": [ + "did" + ], + "description": "Input arguments for {@link IIdentityManager.identityManagerGetIdentity | identityManagerGetIdentity}" + }, + "IIdentityManagerGetIdentityByAliasArgs": { + "type": "object", + "properties": { + "alias": { + "type": "string", + "description": "Alias" + }, + "provider": { + "type": "string", + "description": "Optional provider" + } + }, + "required": [ + "alias" + ], + "description": "Input arguments for {@link IIdentityManager.identityManagerGetIdentityByAlias | identityManagerGetIdentityByAlias}" + }, + "IIdentityManagerGetOrCreateIdentityArgs": { + "type": "object", + "properties": { + "alias": { + "type": "string", + "description": "Identity alias. Can be used to reference an object in an external system" + }, + "provider": { + "type": "string", + "description": "Optional. Identity provider" + }, + "kms": { + "type": "string", + "description": "Optional. Key Management System" + }, + "options": { + "type": "object", + "description": "Optional. Identity provider specific options" + } + }, + "required": [ + "alias" + ], + "description": "Input arguments for {@link IIdentityManager.identityManagerGetOrCreateIdentity | identityManagerGetOrCreateIdentity}" + }, + "IIdentityManagerRemoveKeyArgs": { + "type": "object", + "properties": { + "did": { + "type": "string", + "description": "DID" + }, + "kid": { + "type": "string", + "description": "Key ID" + }, + "options": { + "type": "object", + "description": "Optional. Identity provider specific options" + } + }, + "required": [ + "did", + "kid" + ], + "description": "Input arguments for {@link IIdentityManager.identityManagerRemoveKey | identityManagerRemoveKey}" + }, + "IIdentityManagerRemoveServiceArgs": { + "type": "object", + "properties": { + "did": { + "type": "string", + "description": "DID" + }, + "id": { + "type": "string", + "description": "Service ID" + }, + "options": { + "type": "object", + "description": "Optional. Identity provider specific options" + } + }, + "required": [ + "did", + "id" + ], + "description": "Input arguments for {@link IIdentityManager.identityManagerRemoveService | identityManagerRemoveService}" + }, + "IIdentityManagerSetAliasArgs": { + "type": "object", + "properties": { + "did": { + "type": "string", + "description": "Required. DID" + }, + "alias": { + "type": "string", + "description": "Required. Identity alias" + } + }, + "required": [ + "did", + "alias" + ], + "description": "Input arguments for {@link IIdentityManager.identityManagerSetAlias | identityManagerSetAlias}" + } + }, + "methods": { + "identityManagerAddKey": { + "description": "Adds a key to a DID Document", + "arguments": { + "$ref": "#/components/schemas/IIdentityManagerAddKeyArgs" + }, + "returnType": { + "type": "object" + } + }, + "identityManagerAddService": { + "description": "Adds a service to a DID Document", + "arguments": { + "$ref": "#/components/schemas/IIdentityManagerAddServiceArgs" + }, + "returnType": { + "type": "object" + } + }, + "identityManagerCreateIdentity": { + "description": "Creates and returns a new identity", + "arguments": { + "$ref": "#/components/schemas/IIdentityManagerCreateIdentityArgs" + }, + "returnType": { + "$ref": "#/components/schemas/IIdentity" + } + }, + "identityManagerDeleteIdentity": { + "description": "Deletes identity", + "arguments": { + "$ref": "#/components/schemas/IIdentityManagerDeleteIdentityArgs" + }, + "returnType": { + "type": "boolean" + } + }, + "identityManagerGetIdentities": { + "description": "Returns a list of managed identities", + "arguments": { + "$ref": "#/components/schemas/IIdentityManagerGetIdentitiesArgs" + }, + "returnType": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IIdentity" + } + } + }, + "identityManagerGetIdentity": { + "description": "Returns a specific identity", + "arguments": { + "$ref": "#/components/schemas/IIdentityManagerGetIdentityArgs" + }, + "returnType": { + "$ref": "#/components/schemas/IIdentity" + } + }, + "identityManagerGetIdentityByAlias": { + "description": "Returns a specific identity by alias", + "arguments": { + "$ref": "#/components/schemas/IIdentityManagerGetIdentityByAliasArgs" + }, + "returnType": { + "$ref": "#/components/schemas/IIdentity" + } + }, + "identityManagerGetOrCreateIdentity": { + "description": "Returns an existing identity or creates a new one for a specific alias", + "arguments": { + "$ref": "#/components/schemas/IIdentityManagerGetOrCreateIdentityArgs" + }, + "returnType": { + "$ref": "#/components/schemas/IIdentity" + } + }, + "identityManagerGetProviders": { + "description": "Returns a list of available identity providers", + "arguments": { + "type": "object" + }, + "returnType": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "identityManagerImportIdentity": { + "description": "Imports identity", + "arguments": { + "$ref": "#/components/schemas/IIdentity" + }, + "returnType": { + "$ref": "#/components/schemas/IIdentity" + } + }, + "identityManagerRemoveKey": { + "description": "Removes a key from a DID Document", + "arguments": { + "$ref": "#/components/schemas/IIdentityManagerRemoveKeyArgs" + }, + "returnType": { + "type": "object" + } + }, + "identityManagerRemoveService": { + "description": "Removes a service from a DID Document", + "arguments": { + "$ref": "#/components/schemas/IIdentityManagerRemoveServiceArgs" + }, + "returnType": { + "type": "object" + } + }, + "identityManagerSetAlias": { + "description": "Sets identity alias", + "arguments": { + "$ref": "#/components/schemas/IIdentityManagerSetAliasArgs" + }, + "returnType": { + "type": "boolean" + } + } + } + } + }, + "IDataStore": { + "components": { + "schemas": { + "IDataStoreGetMessageArgs": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Required. Message ID" + } + }, + "required": [ + "id" + ], + "description": "Input arguments for {@link IDataStore.dataStoreGetMessage | dataStoreGetMessage}" + }, + "IMessage": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique message ID" + }, + "type": { + "type": "string", + "description": "Message type" + }, + "createdAt": { + "type": "string", + "description": "Optional. Creation date (ISO 8601)" + }, + "expiresAt": { + "type": "string", + "description": "Optional. Expiration date (ISO 8601)" + }, + "threadId": { + "type": "string", + "description": "Optional. Thread ID" + }, + "raw": { + "type": "string", + "description": "Optional. Original message raw data" + }, + "data": { + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "description": "Optional. Parsed data" + }, + "replyTo": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional. List of DIDs to reply to" + }, + "replyUrl": { + "type": "string", + "description": "Optional. URL to post a reply message to" + }, + "from": { + "type": "string", + "description": "Optional. Sender DID" + }, + "to": { + "type": "string", + "description": "Optional. Recipient DID" + }, + "metaData": { + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/IMetaData" + } + }, + { + "type": "null" + } + ], + "description": "Optional. Array of message metadata" + }, + "credentials": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VerifiableCredential" + }, + "description": "Optional. Array of attached verifiable credentials" + }, + "presentations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VerifiablePresentation" + }, + "description": "Optional. Array of attached verifiable presentations" + } + }, + "required": [ + "id", + "type" + ], + "description": "DIDComm message" + }, + "IMetaData": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type" + }, + "value": { + "type": "string", + "description": "Optional. Value" + } + }, + "required": [ + "type" + ], + "description": "Message meta data" + }, + "VerifiableCredential": { + "type": "object", + "properties": { + "@context": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string" + }, + "type": { + "type": "array", + "items": { + "type": "string" + } + }, + "issuer": { + "type": "object", + "properties": { + "id": { + "type": "string" + } + }, + "required": [ + "id" + ] + }, + "issuanceDate": { + "type": "string" + }, + "expirationDate": { + "type": "string" + }, + "credentialSubject": { + "type": "object", + "properties": { + "id": { + "type": "string" + } + } + }, + "credentialStatus": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + }, + "proof": { + "type": "object", + "properties": { + "type": { + "type": "string" + } + } + } + }, + "required": [ + "@context", + "type", + "issuer", + "issuanceDate", + "credentialSubject", + "proof" + ], + "description": "Verifiable Credential {@link https://github.com/decentralized-identity/did-jwt-vc}" + }, + "VerifiablePresentation": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "holder": { + "type": "string" + }, + "issuanceDate": { + "type": "string" + }, + "expirationDate": { + "type": "string" + }, + "@context": { + "type": "array", + "items": { + "type": "string" + } + }, + "type": { + "type": "array", + "items": { + "type": "string" + } + }, + "verifier": { + "type": "array", + "items": { + "type": "string" + } + }, + "verifiableCredential": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VerifiableCredential" + } + }, + "proof": { + "type": "object", + "properties": { + "type": { + "type": "string" + } + } + } + }, + "required": [ + "holder", + "@context", + "type", + "verifier", + "verifiableCredential", + "proof" + ], + "description": "Verifiable Presentation {@link https://github.com/decentralized-identity/did-jwt-vc}" + }, + "IDataStoreGetVerifiableCredentialArgs": { + "type": "object", + "properties": { + "hash": { + "type": "string", + "description": "Required. VerifiableCredential hash" + } + }, + "required": [ + "hash" + ], + "description": "Input arguments for {@link IDataStore.dataStoreGetVerifiableCredential | dataStoreGetVerifiableCredential}" + }, + "IDataStoreGetVerifiablePresentationArgs": { + "type": "object", + "properties": { + "hash": { + "type": "string", + "description": "Required. VerifiablePresentation hash" + } + }, + "required": [ + "hash" + ], + "description": "Input arguments for {@link IDataStore.dataStoreGetVerifiablePresentation | dataStoreGetVerifiablePresentation}" + }, + "IDataStoreSaveMessageArgs": { + "type": "object", + "properties": { + "message": { + "$ref": "#/components/schemas/IMessage", + "description": "Required. Message" + } + }, + "required": [ + "message" + ], + "description": "Input arguments for {@link IDataStore.dataStoreSaveMessage | dataStoreSaveMessage}" + }, + "IDataStoreSaveVerifiableCredentialArgs": { + "type": "object", + "properties": { + "verifiableCredential": { + "$ref": "#/components/schemas/VerifiableCredential", + "description": "Required. VerifiableCredential" + } + }, + "required": [ + "verifiableCredential" + ], + "description": "Input arguments for {@link IDataStore.dataStoreSaveVerifiableCredential | dataStoreSaveVerifiableCredential}" + }, + "IDataStoreSaveVerifiablePresentationArgs": { + "type": "object", + "properties": { + "verifiablePresentation": { + "$ref": "#/components/schemas/VerifiablePresentation", + "description": "Required. VerifiablePresentation" + } + }, + "required": [ + "verifiablePresentation" + ], + "description": "Input arguments for {@link IDataStore.dataStoreSaveVerifiablePresentation | dataStoreSaveVerifiablePresentation}" + } + }, + "methods": { + "dataStoreGetMessage": { + "description": "Gets message from the data store", + "arguments": { + "$ref": "#/components/schemas/IDataStoreGetMessageArgs" + }, + "returnType": { + "$ref": "#/components/schemas/IMessage" + } + }, + "dataStoreGetVerifiableCredential": { + "description": "Gets verifiable credential from the data store", + "arguments": { + "$ref": "#/components/schemas/IDataStoreGetVerifiableCredentialArgs" + }, + "returnType": { + "$ref": "#/components/schemas/VerifiableCredential" + } + }, + "dataStoreGetVerifiablePresentation": { + "description": "Gets verifiable presentation from the data store", + "arguments": { + "$ref": "#/components/schemas/IDataStoreGetVerifiablePresentationArgs" + }, + "returnType": { + "$ref": "#/components/schemas/VerifiablePresentation" + } + }, + "dataStoreSaveMessage": { + "description": "Saves message to the data store", + "arguments": { + "$ref": "#/components/schemas/IDataStoreSaveMessageArgs" + }, + "returnType": { + "type": "string" + } + }, + "dataStoreSaveVerifiableCredential": { + "description": "Saves verifiable credential to the data store", + "arguments": { + "$ref": "#/components/schemas/IDataStoreSaveVerifiableCredentialArgs" + }, + "returnType": { + "type": "string" + } + }, + "dataStoreSaveVerifiablePresentation": { + "description": "Saves verifiable presentation to the data store", + "arguments": { + "$ref": "#/components/schemas/IDataStoreSaveVerifiablePresentationArgs" + }, + "returnType": { + "type": "string" + } + } + } + } + }, + "IMessageHandler": { + "components": { + "schemas": { + "IHandleMessageArgs": { + "type": "object", + "properties": { + "raw": { + "type": "string", + "description": "Raw message data" + }, + "metaData": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IMetaData" + }, + "description": "Optional. Message meta data" + }, + "save": { + "type": "boolean", + "description": "Optional. If set to `true`, the message will be saved using {@link IDataStore.dataStoreSaveMessage | dataStoreSaveMessage}" + } + }, + "required": [ + "raw" + ], + "description": "Input arguments for {@link IMessageHandler.handleMessage | handleMessage}" + }, + "IMetaData": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type" + }, + "value": { + "type": "string", + "description": "Optional. Value" + } + }, + "required": [ + "type" + ], + "description": "Message meta data" + }, + "IMessage": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique message ID" + }, + "type": { + "type": "string", + "description": "Message type" + }, + "createdAt": { + "type": "string", + "description": "Optional. Creation date (ISO 8601)" + }, + "expiresAt": { + "type": "string", + "description": "Optional. Expiration date (ISO 8601)" + }, + "threadId": { + "type": "string", + "description": "Optional. Thread ID" + }, + "raw": { + "type": "string", + "description": "Optional. Original message raw data" + }, + "data": { + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "description": "Optional. Parsed data" + }, + "replyTo": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional. List of DIDs to reply to" + }, + "replyUrl": { + "type": "string", + "description": "Optional. URL to post a reply message to" + }, + "from": { + "type": "string", + "description": "Optional. Sender DID" + }, + "to": { + "type": "string", + "description": "Optional. Recipient DID" + }, + "metaData": { + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/IMetaData" + } + }, + { + "type": "null" + } + ], + "description": "Optional. Array of message metadata" + }, + "credentials": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VerifiableCredential" + }, + "description": "Optional. Array of attached verifiable credentials" + }, + "presentations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VerifiablePresentation" + }, + "description": "Optional. Array of attached verifiable presentations" + } + }, + "required": [ + "id", + "type" + ], + "description": "DIDComm message" + }, + "VerifiableCredential": { + "type": "object", + "properties": { + "@context": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string" + }, + "type": { + "type": "array", + "items": { + "type": "string" + } + }, + "issuer": { + "type": "object", + "properties": { + "id": { + "type": "string" + } + }, + "required": [ + "id" + ] + }, + "issuanceDate": { + "type": "string" + }, + "expirationDate": { + "type": "string" + }, + "credentialSubject": { + "type": "object", + "properties": { + "id": { + "type": "string" + } + } + }, + "credentialStatus": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + }, + "proof": { + "type": "object", + "properties": { + "type": { + "type": "string" + } + } + } + }, + "required": [ + "@context", + "type", + "issuer", + "issuanceDate", + "credentialSubject", + "proof" + ], + "description": "Verifiable Credential {@link https://github.com/decentralized-identity/did-jwt-vc}" + }, + "VerifiablePresentation": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "holder": { + "type": "string" + }, + "issuanceDate": { + "type": "string" + }, + "expirationDate": { + "type": "string" + }, + "@context": { + "type": "array", + "items": { + "type": "string" + } + }, + "type": { + "type": "array", + "items": { + "type": "string" + } + }, + "verifier": { + "type": "array", + "items": { + "type": "string" + } + }, + "verifiableCredential": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VerifiableCredential" + } + }, + "proof": { + "type": "object", + "properties": { + "type": { + "type": "string" + } + } + } + }, + "required": [ + "holder", + "@context", + "type", + "verifier", + "verifiableCredential", + "proof" + ], + "description": "Verifiable Presentation {@link https://github.com/decentralized-identity/did-jwt-vc}" + } + }, + "methods": { + "handleMessage": { + "description": "Parses and optionally saves a message", + "arguments": { + "$ref": "#/components/schemas/IHandleMessageArgs" + }, + "returnType": { + "$ref": "#/components/schemas/IMessage" + } + } + } + } + } +} \ No newline at end of file diff --git a/packages/daf-core/src/index.ts b/packages/daf-core/src/index.ts index 0b6fa8ca0..793126de0 100644 --- a/packages/daf-core/src/index.ts +++ b/packages/daf-core/src/index.ts @@ -13,3 +13,5 @@ export * from './types/IKeyManager' export * from './types/IMessage' export * from './types/IMessageHandler' export * from './types/IResolver' +const schema = require('../plugin.schema.json') +export { schema } diff --git a/packages/daf-core/src/schemas/IDataStore.ts b/packages/daf-core/src/schemas/IDataStore.ts deleted file mode 100644 index 8069369f8..000000000 --- a/packages/daf-core/src/schemas/IDataStore.ts +++ /dev/null @@ -1,384 +0,0 @@ -export default { - "components": { - "schemas": { - "IDataStoreGetMessageArgs": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Required. Message ID" - } - }, - "required": [ - "id" - ], - "description": "Input arguments for {@link IDataStore.dataStoreGetMessage | dataStoreGetMessage}" - }, - "IMessage": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique message ID" - }, - "type": { - "type": "string", - "description": "Message type" - }, - "createdAt": { - "type": "string", - "description": "Optional. Creation date (ISO 8601)" - }, - "expiresAt": { - "type": "string", - "description": "Optional. Expiration date (ISO 8601)" - }, - "threadId": { - "type": "string", - "description": "Optional. Thread ID" - }, - "raw": { - "type": "string", - "description": "Optional. Original message raw data" - }, - "data": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "description": "Optional. Parsed data" - }, - "replyTo": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Optional. List of DIDs to reply to" - }, - "replyUrl": { - "type": "string", - "description": "Optional. URL to post a reply message to" - }, - "from": { - "type": "string", - "description": "Optional. Sender DID" - }, - "to": { - "type": "string", - "description": "Optional. Recipient DID" - }, - "metaData": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/IMetaData" - } - }, - { - "type": "null" - } - ], - "description": "Optional. Array of message metadata" - }, - "credentials": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VerifiableCredential" - }, - "description": "Optional. Array of attached verifiable credentials" - }, - "presentations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VerifiablePresentation" - }, - "description": "Optional. Array of attached verifiable presentations" - } - }, - "required": [ - "id", - "type" - ], - "description": "DIDComm message" - }, - "IMetaData": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Type" - }, - "value": { - "type": "string", - "description": "Optional. Value" - } - }, - "required": [ - "type" - ], - "description": "Message meta data" - }, - "VerifiableCredential": { - "type": "object", - "properties": { - "@context": { - "type": "array", - "items": { - "type": "string" - } - }, - "id": { - "type": "string" - }, - "type": { - "type": "array", - "items": { - "type": "string" - } - }, - "issuer": { - "type": "object", - "properties": { - "id": { - "type": "string" - } - }, - "required": [ - "id" - ] - }, - "issuanceDate": { - "type": "string" - }, - "expirationDate": { - "type": "string" - }, - "credentialSubject": { - "type": "object", - "properties": { - "id": { - "type": "string" - } - } - }, - "credentialStatus": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "id", - "type" - ] - }, - "proof": { - "type": "object", - "properties": { - "type": { - "type": "string" - } - } - } - }, - "required": [ - "@context", - "type", - "issuer", - "issuanceDate", - "credentialSubject", - "proof" - ], - "description": "Verifiable Credential {@link https://github.com/decentralized-identity/did-jwt-vc}" - }, - "VerifiablePresentation": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "holder": { - "type": "string" - }, - "issuanceDate": { - "type": "string" - }, - "expirationDate": { - "type": "string" - }, - "@context": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "array", - "items": { - "type": "string" - } - }, - "verifier": { - "type": "array", - "items": { - "type": "string" - } - }, - "verifiableCredential": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VerifiableCredential" - } - }, - "proof": { - "type": "object", - "properties": { - "type": { - "type": "string" - } - } - } - }, - "required": [ - "holder", - "@context", - "type", - "verifier", - "verifiableCredential", - "proof" - ], - "description": "Verifiable Presentation {@link https://github.com/decentralized-identity/did-jwt-vc}" - }, - "IDataStoreGetVerifiableCredentialArgs": { - "type": "object", - "properties": { - "hash": { - "type": "string", - "description": "Required. VerifiableCredential hash" - } - }, - "required": [ - "hash" - ], - "description": "Input arguments for {@link IDataStore.dataStoreGetVerifiableCredential | dataStoreGetVerifiableCredential}" - }, - "IDataStoreGetVerifiablePresentationArgs": { - "type": "object", - "properties": { - "hash": { - "type": "string", - "description": "Required. VerifiablePresentation hash" - } - }, - "required": [ - "hash" - ], - "description": "Input arguments for {@link IDataStore.dataStoreGetVerifiablePresentation | dataStoreGetVerifiablePresentation}" - }, - "IDataStoreSaveMessageArgs": { - "type": "object", - "properties": { - "message": { - "$ref": "#/components/schemas/IMessage", - "description": "Required. Message" - } - }, - "required": [ - "message" - ], - "description": "Input arguments for {@link IDataStore.dataStoreSaveMessage | dataStoreSaveMessage}" - }, - "IDataStoreSaveVerifiableCredentialArgs": { - "type": "object", - "properties": { - "verifiableCredential": { - "$ref": "#/components/schemas/VerifiableCredential", - "description": "Required. VerifiableCredential" - } - }, - "required": [ - "verifiableCredential" - ], - "description": "Input arguments for {@link IDataStore.dataStoreSaveVerifiableCredential | dataStoreSaveVerifiableCredential}" - }, - "IDataStoreSaveVerifiablePresentationArgs": { - "type": "object", - "properties": { - "verifiablePresentation": { - "$ref": "#/components/schemas/VerifiablePresentation", - "description": "Required. VerifiablePresentation" - } - }, - "required": [ - "verifiablePresentation" - ], - "description": "Input arguments for {@link IDataStore.dataStoreSaveVerifiablePresentation | dataStoreSaveVerifiablePresentation}" - } - }, - "methods": { - "dataStoreGetMessage": { - "description": "Gets message from the data store", - "arguments": { - "$ref": "#/components/schemas/IDataStoreGetMessageArgs" - }, - "returnType": { - "$ref": "#/components/schemas/IMessage" - } - }, - "dataStoreGetVerifiableCredential": { - "description": "Gets verifiable credential from the data store", - "arguments": { - "$ref": "#/components/schemas/IDataStoreGetVerifiableCredentialArgs" - }, - "returnType": { - "$ref": "#/components/schemas/VerifiableCredential" - } - }, - "dataStoreGetVerifiablePresentation": { - "description": "Gets verifiable presentation from the data store", - "arguments": { - "$ref": "#/components/schemas/IDataStoreGetVerifiablePresentationArgs" - }, - "returnType": { - "$ref": "#/components/schemas/VerifiablePresentation" - } - }, - "dataStoreSaveMessage": { - "description": "Saves message to the data store", - "arguments": { - "$ref": "#/components/schemas/IDataStoreSaveMessageArgs" - }, - "returnType": { - "type": "string" - } - }, - "dataStoreSaveVerifiableCredential": { - "description": "Saves verifiable credential to the data store", - "arguments": { - "$ref": "#/components/schemas/IDataStoreSaveVerifiableCredentialArgs" - }, - "returnType": { - "type": "string" - } - }, - "dataStoreSaveVerifiablePresentation": { - "description": "Saves verifiable presentation to the data store", - "arguments": { - "$ref": "#/components/schemas/IDataStoreSaveVerifiablePresentationArgs" - }, - "returnType": { - "type": "string" - } - } - } - } -} \ No newline at end of file diff --git a/packages/daf-core/src/schemas/IIdentityManager.ts b/packages/daf-core/src/schemas/IIdentityManager.ts deleted file mode 100644 index 63481c0ba..000000000 --- a/packages/daf-core/src/schemas/IIdentityManager.ts +++ /dev/null @@ -1,461 +0,0 @@ -export default { - "components": { - "schemas": { - "IIdentityManagerAddKeyArgs": { - "type": "object", - "properties": { - "did": { - "type": "string", - "description": "DID" - }, - "key": { - "$ref": "#/components/schemas/IKey", - "description": "Key object" - }, - "options": { - "type": "object", - "description": "Optional. Identity provider specific options" - } - }, - "required": [ - "did", - "key" - ], - "description": "Input arguments for {@link IIdentityManager.identityManagerAddKey | identityManagerAddKey}" - }, - "IKey": { - "type": "object", - "properties": { - "kid": { - "type": "string", - "description": "Key ID" - }, - "kms": { - "type": "string", - "description": "Key Management System" - }, - "type": { - "$ref": "#/components/schemas/TKeyType", - "description": "Key type" - }, - "publicKeyHex": { - "type": "string", - "description": "Public key" - }, - "privateKeyHex": { - "type": "string", - "description": "Optional. Private key" - }, - "meta": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "description": "Optional. Key metadata. Can be used to store auth data to access remote kms" - } - }, - "required": [ - "kid", - "kms", - "type", - "publicKeyHex" - ], - "description": "Cryptographic key" - }, - "TKeyType": { - "type": "string", - "enum": [ - "Ed25519", - "Secp256k1" - ], - "description": "Cryptographic key type" - }, - "IIdentityManagerAddServiceArgs": { - "type": "object", - "properties": { - "did": { - "type": "string", - "description": "DID" - }, - "service": { - "$ref": "#/components/schemas/IService", - "description": "Service object" - }, - "options": { - "type": "object", - "description": "Optional. Identity provider specific options" - } - }, - "required": [ - "did", - "service" - ], - "description": "Input arguments for {@link IIdentityManager.identityManagerAddService | identityManagerAddService}" - }, - "IService": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "ID" - }, - "type": { - "type": "string", - "description": "Service type" - }, - "serviceEndpoint": { - "type": "string", - "description": "Endpoint URL" - }, - "description": { - "type": "string", - "description": "Optional. Description" - } - }, - "required": [ - "id", - "type", - "serviceEndpoint" - ], - "description": "Identity service" - }, - "IIdentityManagerCreateIdentityArgs": { - "type": "object", - "properties": { - "alias": { - "type": "string", - "description": "Optional. Identity alias. Can be used to reference an object in an external system" - }, - "provider": { - "type": "string", - "description": "Optional. Identity provider" - }, - "kms": { - "type": "string", - "description": "Optional. Key Management System" - }, - "options": { - "type": "object", - "description": "Optional. Identity provider specific options" - } - }, - "description": "Input arguments for {@link IIdentityManager.identityManagerCreateIdentity | identityManagerCreateIdentity}" - }, - "IIdentity": { - "type": "object", - "properties": { - "did": { - "type": "string", - "description": "Decentralized identifier" - }, - "alias": { - "type": "string", - "description": "Optional. Identity alias. Can be used to reference an object in an external system" - }, - "provider": { - "type": "string", - "description": "Identity provider name" - }, - "controllerKeyId": { - "type": "string", - "description": "Controller key id" - }, - "keys": { - "type": "array", - "items": { - "$ref": "#/components/schemas/IKey" - }, - "description": "Array of managed keys" - }, - "services": { - "type": "array", - "items": { - "$ref": "#/components/schemas/IService" - }, - "description": "Array of services" - } - }, - "required": [ - "did", - "provider", - "keys", - "services" - ], - "description": "Identity interface" - }, - "IIdentityManagerDeleteIdentityArgs": { - "type": "object", - "properties": { - "did": { - "type": "string", - "description": "DID" - } - }, - "required": [ - "did" - ], - "description": "Input arguments for {@link IIdentityManager.identityManagerDeleteIdentity | identityManagerDeleteIdentity}" - }, - "IIdentityManagerGetIdentitiesArgs": { - "type": "object", - "properties": { - "alias": { - "type": "string", - "description": "Optional. Alias" - }, - "provider": { - "type": "string", - "description": "Optional. Provider" - } - }, - "description": "Input arguments for {@link IIdentityManager.identityManagerGetIdentities | identityManagerGetIdentities}" - }, - "IIdentityManagerGetIdentityArgs": { - "type": "object", - "properties": { - "did": { - "type": "string", - "description": "DID" - } - }, - "required": [ - "did" - ], - "description": "Input arguments for {@link IIdentityManager.identityManagerGetIdentity | identityManagerGetIdentity}" - }, - "IIdentityManagerGetIdentityByAliasArgs": { - "type": "object", - "properties": { - "alias": { - "type": "string", - "description": "Alias" - }, - "provider": { - "type": "string", - "description": "Optional provider" - } - }, - "required": [ - "alias" - ], - "description": "Input arguments for {@link IIdentityManager.identityManagerGetIdentityByAlias | identityManagerGetIdentityByAlias}" - }, - "IIdentityManagerGetOrCreateIdentityArgs": { - "type": "object", - "properties": { - "alias": { - "type": "string", - "description": "Identity alias. Can be used to reference an object in an external system" - }, - "provider": { - "type": "string", - "description": "Optional. Identity provider" - }, - "kms": { - "type": "string", - "description": "Optional. Key Management System" - }, - "options": { - "type": "object", - "description": "Optional. Identity provider specific options" - } - }, - "required": [ - "alias" - ], - "description": "Input arguments for {@link IIdentityManager.identityManagerGetOrCreateIdentity | identityManagerGetOrCreateIdentity}" - }, - "IIdentityManagerRemoveKeyArgs": { - "type": "object", - "properties": { - "did": { - "type": "string", - "description": "DID" - }, - "kid": { - "type": "string", - "description": "Key ID" - }, - "options": { - "type": "object", - "description": "Optional. Identity provider specific options" - } - }, - "required": [ - "did", - "kid" - ], - "description": "Input arguments for {@link IIdentityManager.identityManagerRemoveKey | identityManagerRemoveKey}" - }, - "IIdentityManagerRemoveServiceArgs": { - "type": "object", - "properties": { - "did": { - "type": "string", - "description": "DID" - }, - "id": { - "type": "string", - "description": "Service ID" - }, - "options": { - "type": "object", - "description": "Optional. Identity provider specific options" - } - }, - "required": [ - "did", - "id" - ], - "description": "Input arguments for {@link IIdentityManager.identityManagerRemoveService | identityManagerRemoveService}" - }, - "IIdentityManagerSetAliasArgs": { - "type": "object", - "properties": { - "did": { - "type": "string", - "description": "Required. DID" - }, - "alias": { - "type": "string", - "description": "Required. Identity alias" - } - }, - "required": [ - "did", - "alias" - ], - "description": "Input arguments for {@link IIdentityManager.identityManagerSetAlias | identityManagerSetAlias}" - } - }, - "methods": { - "identityManagerAddKey": { - "description": "Adds a key to a DID Document", - "arguments": { - "$ref": "#/components/schemas/IIdentityManagerAddKeyArgs" - }, - "returnType": { - "type": "object" - } - }, - "identityManagerAddService": { - "description": "Adds a service to a DID Document", - "arguments": { - "$ref": "#/components/schemas/IIdentityManagerAddServiceArgs" - }, - "returnType": { - "type": "object" - } - }, - "identityManagerCreateIdentity": { - "description": "Creates and returns a new identity", - "arguments": { - "$ref": "#/components/schemas/IIdentityManagerCreateIdentityArgs" - }, - "returnType": { - "$ref": "#/components/schemas/IIdentity" - } - }, - "identityManagerDeleteIdentity": { - "description": "Deletes identity", - "arguments": { - "$ref": "#/components/schemas/IIdentityManagerDeleteIdentityArgs" - }, - "returnType": { - "type": "boolean" - } - }, - "identityManagerGetIdentities": { - "description": "Returns a list of managed identities", - "arguments": { - "$ref": "#/components/schemas/IIdentityManagerGetIdentitiesArgs" - }, - "returnType": { - "type": "array", - "items": { - "$ref": "#/components/schemas/IIdentity" - } - } - }, - "identityManagerGetIdentity": { - "description": "Returns a specific identity", - "arguments": { - "$ref": "#/components/schemas/IIdentityManagerGetIdentityArgs" - }, - "returnType": { - "$ref": "#/components/schemas/IIdentity" - } - }, - "identityManagerGetIdentityByAlias": { - "description": "Returns a specific identity by alias", - "arguments": { - "$ref": "#/components/schemas/IIdentityManagerGetIdentityByAliasArgs" - }, - "returnType": { - "$ref": "#/components/schemas/IIdentity" - } - }, - "identityManagerGetOrCreateIdentity": { - "description": "Returns an existing identity or creates a new one for a specific alias", - "arguments": { - "$ref": "#/components/schemas/IIdentityManagerGetOrCreateIdentityArgs" - }, - "returnType": { - "$ref": "#/components/schemas/IIdentity" - } - }, - "identityManagerGetProviders": { - "description": "Returns a list of available identity providers", - "arguments": { - "type": "object" - }, - "returnType": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "identityManagerImportIdentity": { - "description": "Imports identity", - "arguments": { - "$ref": "#/components/schemas/IIdentity" - }, - "returnType": { - "$ref": "#/components/schemas/IIdentity" - } - }, - "identityManagerRemoveKey": { - "description": "Removes a key from a DID Document", - "arguments": { - "$ref": "#/components/schemas/IIdentityManagerRemoveKeyArgs" - }, - "returnType": { - "type": "object" - } - }, - "identityManagerRemoveService": { - "description": "Removes a service from a DID Document", - "arguments": { - "$ref": "#/components/schemas/IIdentityManagerRemoveServiceArgs" - }, - "returnType": { - "type": "object" - } - }, - "identityManagerSetAlias": { - "description": "Sets identity alias", - "arguments": { - "$ref": "#/components/schemas/IIdentityManagerSetAliasArgs" - }, - "returnType": { - "type": "boolean" - } - } - } - } -} \ No newline at end of file diff --git a/packages/daf-core/src/schemas/IKeyManager.ts b/packages/daf-core/src/schemas/IKeyManager.ts deleted file mode 100644 index 13429c464..000000000 --- a/packages/daf-core/src/schemas/IKeyManager.ts +++ /dev/null @@ -1,322 +0,0 @@ -export default { - "components": { - "schemas": { - "IKeyManagerCreateKeyArgs": { - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/TKeyType", - "description": "Key type" - }, - "kms": { - "type": "string", - "description": "Key Management System" - }, - "meta": { - "type": "object", - "description": "Optional. Key meta data" - } - }, - "required": [ - "type", - "kms" - ], - "description": "Input arguments for {@link IKeyManager.keyManagerCreateKey | keyManagerCreateKey}" - }, - "TKeyType": { - "type": "string", - "enum": [ - "Ed25519", - "Secp256k1" - ], - "description": "Cryptographic key type" - }, - "IKey": { - "type": "object", - "properties": { - "kid": { - "type": "string", - "description": "Key ID" - }, - "kms": { - "type": "string", - "description": "Key Management System" - }, - "type": { - "$ref": "#/components/schemas/TKeyType", - "description": "Key type" - }, - "publicKeyHex": { - "type": "string", - "description": "Public key" - }, - "privateKeyHex": { - "type": "string", - "description": "Optional. Private key" - }, - "meta": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "description": "Optional. Key metadata. Can be used to store auth data to access remote kms" - } - }, - "required": [ - "kid", - "kms", - "type", - "publicKeyHex" - ], - "description": "Cryptographic key" - }, - "IKeyManagerDecryptJWEArgs": { - "type": "object", - "properties": { - "kid": { - "type": "string", - "description": "Key ID" - }, - "data": { - "type": "string", - "description": "Encrypted data" - } - }, - "required": [ - "kid", - "data" - ], - "description": "Input arguments for {@link IKeyManager.keyManagerDecryptJWE | keyManagerDecryptJWE}" - }, - "IKeyManagerDeleteKeyArgs": { - "type": "object", - "properties": { - "kid": { - "type": "string", - "description": "Key ID" - } - }, - "required": [ - "kid" - ], - "description": "Input arguments for {@link IKeyManager.keyManagerDeleteKey | keyManagerDeleteKey}" - }, - "IKeyManagerEncryptJWEArgs": { - "type": "object", - "properties": { - "kid": { - "type": "string", - "description": "Key ID to use for encryption" - }, - "to": { - "type": "object", - "properties": { - "kid": { - "type": "string", - "description": "Key ID" - }, - "type": { - "$ref": "#/components/schemas/TKeyType", - "description": "Key type" - }, - "publicKeyHex": { - "type": "string", - "description": "Public key" - }, - "privateKeyHex": { - "type": "string", - "description": "Optional. Private key" - }, - "meta": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "description": "Optional. Key metadata. Can be used to store auth data to access remote kms" - } - }, - "required": [ - "kid", - "type", - "publicKeyHex" - ], - "description": "Recipient key object" - }, - "data": { - "type": "string", - "description": "Data to encrypt" - } - }, - "required": [ - "kid", - "to", - "data" - ], - "description": "Input arguments for {@link IKeyManager.keyManagerEncryptJWE | keyManagerEncryptJWE}" - }, - "IKeyManagerGetKeyArgs": { - "type": "object", - "properties": { - "kid": { - "type": "string", - "description": "Key ID" - } - }, - "required": [ - "kid" - ], - "description": "Input arguments for {@link IKeyManager.keyManagerGetKey | keyManagerGetKey}" - }, - "IKeyManagerSignEthTXArgs": { - "type": "object", - "properties": { - "kid": { - "type": "string", - "description": "Key ID" - }, - "transaction": { - "type": "object", - "description": "Ethereum transaction object" - } - }, - "required": [ - "kid", - "transaction" - ], - "description": "Input arguments for {@link IKeyManager.keyManagerSignEthTX | keyManagerSignEthTX}" - }, - "IKeyManagerSignJWTArgs": { - "type": "object", - "properties": { - "kid": { - "type": "string", - "description": "Key ID" - }, - "data": { - "type": "string", - "description": "Data to sign" - } - }, - "required": [ - "kid", - "data" - ], - "description": "Input arguments for {@link IKeyManager.keyManagerSignJWT | keyManagerSignJWT}" - }, - "EcdsaSignature": { - "type": "object", - "properties": { - "r": { - "type": "string" - }, - "s": { - "type": "string" - }, - "recoveryParam": { - "type": "number", - "const": 1 - } - }, - "required": [ - "r", - "s", - "recoveryParam" - ] - } - }, - "methods": { - "keyManagerCreateKey": { - "description": "Creates and returns a new key", - "arguments": { - "$ref": "#/components/schemas/IKeyManagerCreateKeyArgs" - }, - "returnType": { - "$ref": "#/components/schemas/IKey" - } - }, - "keyManagerDecryptJWE": { - "description": "Decrypts data", - "arguments": { - "$ref": "#/components/schemas/IKeyManagerDecryptJWEArgs" - }, - "returnType": { - "type": "string" - } - }, - "keyManagerDeleteKey": { - "description": "Deletes a key", - "arguments": { - "$ref": "#/components/schemas/IKeyManagerDeleteKeyArgs" - }, - "returnType": { - "type": "boolean" - } - }, - "keyManagerEncryptJWE": { - "description": "Encrypts data", - "arguments": { - "$ref": "#/components/schemas/IKeyManagerEncryptJWEArgs" - }, - "returnType": { - "type": "string" - } - }, - "keyManagerGetKey": { - "description": "Returns an existing key", - "arguments": { - "$ref": "#/components/schemas/IKeyManagerGetKeyArgs" - }, - "returnType": { - "$ref": "#/components/schemas/IKey" - } - }, - "keyManagerGetKeyManagementSystems": { - "description": "Lists available key management systems", - "arguments": { - "type": "object" - }, - "returnType": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "keyManagerImportKey": { - "description": "Imports a created key", - "arguments": { - "$ref": "#/components/schemas/IKey" - }, - "returnType": { - "type": "boolean" - } - }, - "keyManagerSignEthTX": { - "description": "Signs Ethereum transaction", - "arguments": { - "$ref": "#/components/schemas/IKeyManagerSignEthTXArgs" - }, - "returnType": { - "type": "string" - } - }, - "keyManagerSignJWT": { - "description": "Signs JWT", - "arguments": { - "$ref": "#/components/schemas/IKeyManagerSignJWTArgs" - }, - "returnType": { - "$ref": "#/components/schemas/EcdsaSignature" - } - } - } - } -} \ No newline at end of file diff --git a/packages/daf-core/src/schemas/IMessageHandler.ts b/packages/daf-core/src/schemas/IMessageHandler.ts deleted file mode 100644 index 5be65b215..000000000 --- a/packages/daf-core/src/schemas/IMessageHandler.ts +++ /dev/null @@ -1,285 +0,0 @@ -export default { - "components": { - "schemas": { - "IHandleMessageArgs": { - "type": "object", - "properties": { - "raw": { - "type": "string", - "description": "Raw message data" - }, - "metaData": { - "type": "array", - "items": { - "$ref": "#/components/schemas/IMetaData" - }, - "description": "Optional. Message meta data" - }, - "save": { - "type": "boolean", - "description": "Optional. If set to `true`, the message will be saved using {@link IDataStore.dataStoreSaveMessage | dataStoreSaveMessage}" - } - }, - "required": [ - "raw" - ], - "description": "Input arguments for {@link IMessageHandler.handleMessage | handleMessage}" - }, - "IMetaData": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Type" - }, - "value": { - "type": "string", - "description": "Optional. Value" - } - }, - "required": [ - "type" - ], - "description": "Message meta data" - }, - "IMessage": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique message ID" - }, - "type": { - "type": "string", - "description": "Message type" - }, - "createdAt": { - "type": "string", - "description": "Optional. Creation date (ISO 8601)" - }, - "expiresAt": { - "type": "string", - "description": "Optional. Expiration date (ISO 8601)" - }, - "threadId": { - "type": "string", - "description": "Optional. Thread ID" - }, - "raw": { - "type": "string", - "description": "Optional. Original message raw data" - }, - "data": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "description": "Optional. Parsed data" - }, - "replyTo": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Optional. List of DIDs to reply to" - }, - "replyUrl": { - "type": "string", - "description": "Optional. URL to post a reply message to" - }, - "from": { - "type": "string", - "description": "Optional. Sender DID" - }, - "to": { - "type": "string", - "description": "Optional. Recipient DID" - }, - "metaData": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/IMetaData" - } - }, - { - "type": "null" - } - ], - "description": "Optional. Array of message metadata" - }, - "credentials": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VerifiableCredential" - }, - "description": "Optional. Array of attached verifiable credentials" - }, - "presentations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VerifiablePresentation" - }, - "description": "Optional. Array of attached verifiable presentations" - } - }, - "required": [ - "id", - "type" - ], - "description": "DIDComm message" - }, - "VerifiableCredential": { - "type": "object", - "properties": { - "@context": { - "type": "array", - "items": { - "type": "string" - } - }, - "id": { - "type": "string" - }, - "type": { - "type": "array", - "items": { - "type": "string" - } - }, - "issuer": { - "type": "object", - "properties": { - "id": { - "type": "string" - } - }, - "required": [ - "id" - ] - }, - "issuanceDate": { - "type": "string" - }, - "expirationDate": { - "type": "string" - }, - "credentialSubject": { - "type": "object", - "properties": { - "id": { - "type": "string" - } - } - }, - "credentialStatus": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "id", - "type" - ] - }, - "proof": { - "type": "object", - "properties": { - "type": { - "type": "string" - } - } - } - }, - "required": [ - "@context", - "type", - "issuer", - "issuanceDate", - "credentialSubject", - "proof" - ], - "description": "Verifiable Credential {@link https://github.com/decentralized-identity/did-jwt-vc}" - }, - "VerifiablePresentation": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "holder": { - "type": "string" - }, - "issuanceDate": { - "type": "string" - }, - "expirationDate": { - "type": "string" - }, - "@context": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "array", - "items": { - "type": "string" - } - }, - "verifier": { - "type": "array", - "items": { - "type": "string" - } - }, - "verifiableCredential": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VerifiableCredential" - } - }, - "proof": { - "type": "object", - "properties": { - "type": { - "type": "string" - } - } - } - }, - "required": [ - "holder", - "@context", - "type", - "verifier", - "verifiableCredential", - "proof" - ], - "description": "Verifiable Presentation {@link https://github.com/decentralized-identity/did-jwt-vc}" - } - }, - "methods": { - "handleMessage": { - "description": "Parses and optionally saves a message", - "arguments": { - "$ref": "#/components/schemas/IHandleMessageArgs" - }, - "returnType": { - "$ref": "#/components/schemas/IMessage" - } - } - } - } -} \ No newline at end of file diff --git a/packages/daf-core/src/schemas/IResolver.ts b/packages/daf-core/src/schemas/IResolver.ts deleted file mode 100644 index 8adebb19e..000000000 --- a/packages/daf-core/src/schemas/IResolver.ts +++ /dev/null @@ -1,186 +0,0 @@ -export default { - "components": { - "schemas": { - "ResolveDidArgs": { - "type": "object", - "properties": { - "didUrl": { - "type": "string", - "description": "DID URL" - } - }, - "required": [ - "didUrl" - ], - "description": "Input arguments for {@link IResolver.resolveDid | resolveDid}" - }, - "DIDDocument": { - "type": "object", - "properties": { - "@context": { - "type": "string", - "const": "https://w3id.org/did/v1" - }, - "id": { - "type": "string" - }, - "publicKey": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PublicKey" - } - }, - "authentication": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Authentication" - } - }, - "uportProfile": {}, - "service": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ServiceEndpoint" - } - }, - "created": { - "type": "string" - }, - "updated": { - "type": "string" - }, - "proof": { - "$ref": "#/components/schemas/LinkedDataProof" - }, - "keyAgreement": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "$ref": "#/components/schemas/PublicKey" - } - ] - } - } - }, - "required": [ - "@context", - "id", - "publicKey" - ] - }, - "PublicKey": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "controller": { - "type": "string" - }, - "ethereumAddress": { - "type": "string" - }, - "publicKeyBase64": { - "type": "string" - }, - "publicKeyBase58": { - "type": "string" - }, - "publicKeyHex": { - "type": "string" - }, - "publicKeyPem": { - "type": "string" - } - }, - "required": [ - "id", - "type", - "controller" - ] - }, - "Authentication": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "publicKey": { - "type": "string" - } - }, - "required": [ - "type", - "publicKey" - ] - }, - "ServiceEndpoint": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "serviceEndpoint": { - "type": "string" - }, - "description": { - "type": "string" - } - }, - "required": [ - "id", - "type", - "serviceEndpoint" - ] - }, - "LinkedDataProof": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "created": { - "type": "string" - }, - "creator": { - "type": "string" - }, - "nonce": { - "type": "string" - }, - "signatureValue": { - "type": "string" - } - }, - "required": [ - "type", - "created", - "creator", - "nonce", - "signatureValue" - ] - } - }, - "methods": { - "resolveDid": { - "description": "Resolves DID and returns DID Document", - "arguments": { - "$ref": "#/components/schemas/ResolveDidArgs" - }, - "returnType": { - "$ref": "#/components/schemas/DIDDocument" - } - } - } - } -} \ No newline at end of file diff --git a/packages/daf-did-comm/api/daf-did-comm.api.json b/packages/daf-did-comm/api/daf-did-comm.api.json index f40bb3a4a..e16ec149a 100644 --- a/packages/daf-did-comm/api/daf-did-comm.api.json +++ b/packages/daf-did-comm/api/daf-did-comm.api.json @@ -89,7 +89,7 @@ }, { "kind": "Content", - "text": "{\n components: {\n schemas: {\n ISendMessageDIDCommAlpha1Args: {\n type: string;\n properties: {\n url: {\n type: string;\n };\n save: {\n type: string;\n };\n data: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n from: {\n type: string;\n };\n to: {\n type: string;\n };\n type: {\n type: string;\n };\n body: {\n anyOf: {\n type: string;\n }[];\n };\n };\n required: string[];\n };\n };\n required: string[];\n description: string;\n };\n IMessage: {\n type: string;\n properties: {\n id: {\n type: string;\n description: string;\n };\n type: {\n type: string;\n description: string;\n };\n createdAt: {\n type: string;\n description: string;\n };\n expiresAt: {\n type: string;\n description: string;\n };\n threadId: {\n type: string; /** Plugin methods */\n description: string;\n };\n raw: {\n type: string;\n description: string;\n };\n data: {\n anyOf: {\n type: string;\n }[];\n description: string;\n };\n replyTo: {\n type: string;\n items: {\n type: string;\n };\n description: string;\n };\n replyUrl: {\n type: string;\n description: string;\n };\n from: {\n type: string;\n description: string;\n };\n to: {\n type: string;\n description: string;\n };\n metaData: {\n anyOf: ({\n type: string;\n items: {\n $ref: string;\n };\n } | {\n type: string;\n items?: undefined;\n })[];\n description: string;\n };\n credentials: {\n type: string;\n items: {\n $ref: string;\n };\n description: string;\n };\n presentations: {\n type: string;\n items: {\n $ref: string;\n };\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n IMetaData: {\n type: string;\n properties: {\n type: {\n type: string;\n description: string;\n };\n value: {\n type: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n VerifiableCredential: {\n type: string;\n properties: {\n \"@context\": {\n type: string;\n items: {\n type: string;\n };\n };\n id: {\n type: string;\n };\n type: {\n type: string;\n items: {\n type: string;\n };\n };\n issuer: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n };\n required: string[];\n };\n issuanceDate: {\n type: string;\n };\n expirationDate: {\n type: string;\n };\n credentialSubject: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n };\n };\n credentialStatus: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n type: {\n type: string;\n };\n };\n required: string[];\n };\n proof: {\n type: string;\n properties: {\n type: {\n type: string;\n };\n };\n };\n };\n required: string[];\n description: string;\n };\n VerifiablePresentation: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n holder: {\n type: string;\n };\n issuanceDate: {\n type: string;\n };\n expirationDate: {\n type: string;\n };\n \"@context\": {\n type: string;\n items: {\n type: string;\n };\n };\n type: {\n type: string;\n items: {\n type: string;\n };\n };\n verifier: {\n type: string;\n items: {\n type: string;\n };\n };\n verifiableCredential: {\n type: string;\n items: {\n $ref: string;\n };\n };\n proof: {\n type: string;\n properties: {\n type: {\n type: string;\n };\n };\n };\n };\n required: string[];\n description: string;\n };\n };\n methods: {\n sendMessageDIDCommAlpha1: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n $ref: string;\n };\n };\n };\n };\n }" + "text": "any" }, { "kind": "Content", @@ -579,6 +579,27 @@ } ], "extendsTokenRanges": [] + }, + { + "kind": "Variable", + "canonicalReference": "daf-did-comm!schema:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "schema: " + }, + { + "kind": "Content", + "text": "any" + } + ], + "releaseTag": "Public", + "name": "schema", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } } ] } diff --git a/packages/daf-did-comm/api/daf-did-comm.api.md b/packages/daf-did-comm/api/daf-did-comm.api.md index 29f24b3d7..a41fc7e48 100644 --- a/packages/daf-did-comm/api/daf-did-comm.api.md +++ b/packages/daf-did-comm/api/daf-did-comm.api.md @@ -20,272 +20,7 @@ export class DIDComm implements IAgentPlugin { constructor(); readonly methods: IDIDComm; // (undocumented) - readonly schema: { - components: { - schemas: { - ISendMessageDIDCommAlpha1Args: { - type: string; - properties: { - url: { - type: string; - }; - save: { - type: string; - }; - data: { - type: string; - properties: { - id: { - type: string; - }; - from: { - type: string; - }; - to: { - type: string; - }; - type: { - type: string; - }; - body: { - anyOf: { - type: string; - }[]; - }; - }; - required: string[]; - }; - }; - required: string[]; - description: string; - }; - IMessage: { - type: string; - properties: { - id: { - type: string; - description: string; - }; - type: { - type: string; - description: string; - }; - createdAt: { - type: string; - description: string; - }; - expiresAt: { - type: string; - description: string; - }; - threadId: { - type: string; /** Plugin methods */ - description: string; - }; - raw: { - type: string; - description: string; - }; - data: { - anyOf: { - type: string; - }[]; - description: string; - }; - replyTo: { - type: string; - items: { - type: string; - }; - description: string; - }; - replyUrl: { - type: string; - description: string; - }; - from: { - type: string; - description: string; - }; - to: { - type: string; - description: string; - }; - metaData: { - anyOf: ({ - type: string; - items: { - $ref: string; - }; - } | { - type: string; - items?: undefined; - })[]; - description: string; - }; - credentials: { - type: string; - items: { - $ref: string; - }; - description: string; - }; - presentations: { - type: string; - items: { - $ref: string; - }; - description: string; - }; - }; - required: string[]; - description: string; - }; - IMetaData: { - type: string; - properties: { - type: { - type: string; - description: string; - }; - value: { - type: string; - description: string; - }; - }; - required: string[]; - description: string; - }; - VerifiableCredential: { - type: string; - properties: { - "@context": { - type: string; - items: { - type: string; - }; - }; - id: { - type: string; - }; - type: { - type: string; - items: { - type: string; - }; - }; - issuer: { - type: string; - properties: { - id: { - type: string; - }; - }; - required: string[]; - }; - issuanceDate: { - type: string; - }; - expirationDate: { - type: string; - }; - credentialSubject: { - type: string; - properties: { - id: { - type: string; - }; - }; - }; - credentialStatus: { - type: string; - properties: { - id: { - type: string; - }; - type: { - type: string; - }; - }; - required: string[]; - }; - proof: { - type: string; - properties: { - type: { - type: string; - }; - }; - }; - }; - required: string[]; - description: string; - }; - VerifiablePresentation: { - type: string; - properties: { - id: { - type: string; - }; - holder: { - type: string; - }; - issuanceDate: { - type: string; - }; - expirationDate: { - type: string; - }; - "@context": { - type: string; - items: { - type: string; - }; - }; - type: { - type: string; - items: { - type: string; - }; - }; - verifier: { - type: string; - items: { - type: string; - }; - }; - verifiableCredential: { - type: string; - items: { - $ref: string; - }; - }; - proof: { - type: string; - properties: { - type: { - type: string; - }; - }; - }; - }; - required: string[]; - description: string; - }; - }; - methods: { - sendMessageDIDCommAlpha1: { - description: string; - arguments: { - $ref: string; - }; - returnType: { - $ref: string; - }; - }; - }; - }; - }; + readonly schema: any; sendMessageDIDCommAlpha1(args: ISendMessageDIDCommAlpha1Args, context: IAgentContext): Promise; } @@ -319,5 +54,8 @@ export interface ISendMessageDIDCommAlpha1Args { url?: string; } +// @public (undocumented) +export const schema: any; + ``` diff --git a/packages/daf-did-comm/package.json b/packages/daf-did-comm/package.json index a85330dce..f2beddd30 100644 --- a/packages/daf-did-comm/package.json +++ b/packages/daf-did-comm/package.json @@ -6,8 +6,7 @@ "types": "build/index.d.ts", "scripts": { "build": "tsc", - "extract-api": "daf extractPluginApi -c ./api-extractor.json", - "generate-schema": "daf generatePluginSchema" + "generate-plugin-schema": "yarn daf generate-plugin-schema" }, "daf": { "pluginInterfaces": { @@ -29,6 +28,7 @@ "files": [ "build/**/*", "src/**/*", + "plugin.schema.json", "README.md", "LICENSE" ], diff --git a/packages/daf-did-comm/plugin.schema.json b/packages/daf-did-comm/plugin.schema.json new file mode 100644 index 000000000..8226e5b1b --- /dev/null +++ b/packages/daf-did-comm/plugin.schema.json @@ -0,0 +1,311 @@ +{ + "IDIDComm": { + "components": { + "schemas": { + "ISendMessageDIDCommAlpha1Args": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "save": { + "type": "boolean" + }, + "data": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "from": { + "type": "string" + }, + "to": { + "type": "string" + }, + "type": { + "type": "string" + }, + "body": { + "anyOf": [ + { + "type": "object" + }, + { + "type": "string" + } + ] + } + }, + "required": [ + "from", + "to", + "type", + "body" + ] + } + }, + "required": [ + "data" + ], + "description": "Input arguments for {@link IDIDComm.sendMessageDIDCommAlpha1}" + }, + "IMessage": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique message ID" + }, + "type": { + "type": "string", + "description": "Message type" + }, + "createdAt": { + "type": "string", + "description": "Optional. Creation date (ISO 8601)" + }, + "expiresAt": { + "type": "string", + "description": "Optional. Expiration date (ISO 8601)" + }, + "threadId": { + "type": "string", + "description": "Optional. Thread ID" + }, + "raw": { + "type": "string", + "description": "Optional. Original message raw data" + }, + "data": { + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "description": "Optional. Parsed data" + }, + "replyTo": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional. List of DIDs to reply to" + }, + "replyUrl": { + "type": "string", + "description": "Optional. URL to post a reply message to" + }, + "from": { + "type": "string", + "description": "Optional. Sender DID" + }, + "to": { + "type": "string", + "description": "Optional. Recipient DID" + }, + "metaData": { + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/IMetaData" + } + }, + { + "type": "null" + } + ], + "description": "Optional. Array of message metadata" + }, + "credentials": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VerifiableCredential" + }, + "description": "Optional. Array of attached verifiable credentials" + }, + "presentations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VerifiablePresentation" + }, + "description": "Optional. Array of attached verifiable presentations" + } + }, + "required": [ + "id", + "type" + ], + "description": "DIDComm message" + }, + "IMetaData": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type" + }, + "value": { + "type": "string", + "description": "Optional. Value" + } + }, + "required": [ + "type" + ], + "description": "Message meta data" + }, + "VerifiableCredential": { + "type": "object", + "properties": { + "@context": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string" + }, + "type": { + "type": "array", + "items": { + "type": "string" + } + }, + "issuer": { + "type": "object", + "properties": { + "id": { + "type": "string" + } + }, + "required": [ + "id" + ] + }, + "issuanceDate": { + "type": "string" + }, + "expirationDate": { + "type": "string" + }, + "credentialSubject": { + "type": "object", + "properties": { + "id": { + "type": "string" + } + } + }, + "credentialStatus": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + }, + "proof": { + "type": "object", + "properties": { + "type": { + "type": "string" + } + } + } + }, + "required": [ + "@context", + "type", + "issuer", + "issuanceDate", + "credentialSubject", + "proof" + ], + "description": "Verifiable Credential {@link https://github.com/decentralized-identity/did-jwt-vc}" + }, + "VerifiablePresentation": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "holder": { + "type": "string" + }, + "issuanceDate": { + "type": "string" + }, + "expirationDate": { + "type": "string" + }, + "@context": { + "type": "array", + "items": { + "type": "string" + } + }, + "type": { + "type": "array", + "items": { + "type": "string" + } + }, + "verifier": { + "type": "array", + "items": { + "type": "string" + } + }, + "verifiableCredential": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VerifiableCredential" + } + }, + "proof": { + "type": "object", + "properties": { + "type": { + "type": "string" + } + } + } + }, + "required": [ + "holder", + "@context", + "type", + "verifier", + "verifiableCredential", + "proof" + ], + "description": "Verifiable Presentation {@link https://github.com/decentralized-identity/did-jwt-vc}" + } + }, + "methods": { + "sendMessageDIDCommAlpha1": { + "description": "This is used to create a message according to the initial ", + "arguments": { + "$ref": "#/components/schemas/ISendMessageDIDCommAlpha1Args" + }, + "returnType": { + "$ref": "#/components/schemas/IMessage" + } + } + } + } + } +} \ No newline at end of file diff --git a/packages/daf-did-comm/src/action-handler.ts b/packages/daf-did-comm/src/action-handler.ts index 6a8db4192..7ea6a0969 100644 --- a/packages/daf-did-comm/src/action-handler.ts +++ b/packages/daf-did-comm/src/action-handler.ts @@ -9,7 +9,7 @@ import { IPluginMethodMap, IAgentPlugin, } from 'daf-core' -import schema from './schemas/IDIDComm' +import { schema } from './' import { v4 as uuidv4 } from 'uuid' import Debug from 'debug' @@ -62,7 +62,7 @@ export interface IDIDComm extends IPluginMethodMap { export class DIDComm implements IAgentPlugin { /** Plugin methods */ readonly methods: IDIDComm - readonly schema = schema + readonly schema = schema.IDIDComm constructor() { this.methods = { diff --git a/packages/daf-did-comm/src/index.ts b/packages/daf-did-comm/src/index.ts index 3fe3e98e8..a2b5cb67d 100644 --- a/packages/daf-did-comm/src/index.ts +++ b/packages/daf-did-comm/src/index.ts @@ -5,3 +5,5 @@ */ export { DIDComm, IDIDComm, ISendMessageDIDCommAlpha1Args } from './action-handler' export { DIDCommMessageHandler } from './message-handler' +const schema = require('../plugin.schema.json') +export { schema } diff --git a/packages/daf-did-comm/src/schemas/IDIDComm.ts b/packages/daf-did-comm/src/schemas/IDIDComm.ts deleted file mode 100644 index ca32d7744..000000000 --- a/packages/daf-did-comm/src/schemas/IDIDComm.ts +++ /dev/null @@ -1,309 +0,0 @@ -export default { - "components": { - "schemas": { - "ISendMessageDIDCommAlpha1Args": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "save": { - "type": "boolean" - }, - "data": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "from": { - "type": "string" - }, - "to": { - "type": "string" - }, - "type": { - "type": "string" - }, - "body": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "string" - } - ] - } - }, - "required": [ - "from", - "to", - "type", - "body" - ] - } - }, - "required": [ - "data" - ], - "description": "Input arguments for {@link IDIDComm.sendMessageDIDCommAlpha1}" - }, - "IMessage": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique message ID" - }, - "type": { - "type": "string", - "description": "Message type" - }, - "createdAt": { - "type": "string", - "description": "Optional. Creation date (ISO 8601)" - }, - "expiresAt": { - "type": "string", - "description": "Optional. Expiration date (ISO 8601)" - }, - "threadId": { - "type": "string", - "description": "Optional. Thread ID" - }, - "raw": { - "type": "string", - "description": "Optional. Original message raw data" - }, - "data": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "description": "Optional. Parsed data" - }, - "replyTo": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Optional. List of DIDs to reply to" - }, - "replyUrl": { - "type": "string", - "description": "Optional. URL to post a reply message to" - }, - "from": { - "type": "string", - "description": "Optional. Sender DID" - }, - "to": { - "type": "string", - "description": "Optional. Recipient DID" - }, - "metaData": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/IMetaData" - } - }, - { - "type": "null" - } - ], - "description": "Optional. Array of message metadata" - }, - "credentials": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VerifiableCredential" - }, - "description": "Optional. Array of attached verifiable credentials" - }, - "presentations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VerifiablePresentation" - }, - "description": "Optional. Array of attached verifiable presentations" - } - }, - "required": [ - "id", - "type" - ], - "description": "DIDComm message" - }, - "IMetaData": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Type" - }, - "value": { - "type": "string", - "description": "Optional. Value" - } - }, - "required": [ - "type" - ], - "description": "Message meta data" - }, - "VerifiableCredential": { - "type": "object", - "properties": { - "@context": { - "type": "array", - "items": { - "type": "string" - } - }, - "id": { - "type": "string" - }, - "type": { - "type": "array", - "items": { - "type": "string" - } - }, - "issuer": { - "type": "object", - "properties": { - "id": { - "type": "string" - } - }, - "required": [ - "id" - ] - }, - "issuanceDate": { - "type": "string" - }, - "expirationDate": { - "type": "string" - }, - "credentialSubject": { - "type": "object", - "properties": { - "id": { - "type": "string" - } - } - }, - "credentialStatus": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "id", - "type" - ] - }, - "proof": { - "type": "object", - "properties": { - "type": { - "type": "string" - } - } - } - }, - "required": [ - "@context", - "type", - "issuer", - "issuanceDate", - "credentialSubject", - "proof" - ], - "description": "Verifiable Credential {@link https://github.com/decentralized-identity/did-jwt-vc}" - }, - "VerifiablePresentation": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "holder": { - "type": "string" - }, - "issuanceDate": { - "type": "string" - }, - "expirationDate": { - "type": "string" - }, - "@context": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "array", - "items": { - "type": "string" - } - }, - "verifier": { - "type": "array", - "items": { - "type": "string" - } - }, - "verifiableCredential": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VerifiableCredential" - } - }, - "proof": { - "type": "object", - "properties": { - "type": { - "type": "string" - } - } - } - }, - "required": [ - "holder", - "@context", - "type", - "verifier", - "verifiableCredential", - "proof" - ], - "description": "Verifiable Presentation {@link https://github.com/decentralized-identity/did-jwt-vc}" - } - }, - "methods": { - "sendMessageDIDCommAlpha1": { - "description": "This is used to create a message according to the initial ", - "arguments": { - "$ref": "#/components/schemas/ISendMessageDIDCommAlpha1Args" - }, - "returnType": { - "$ref": "#/components/schemas/IMessage" - } - } - } - } -} \ No newline at end of file diff --git a/packages/daf-did-jwt/package.json b/packages/daf-did-jwt/package.json index bb5df542d..387ed4912 100644 --- a/packages/daf-did-jwt/package.json +++ b/packages/daf-did-jwt/package.json @@ -6,7 +6,7 @@ "types": "build/index.d.ts", "scripts": { "build": "tsc", - "extract-api": "daf extractPluginApi -c ./api-extractor.json" + "extract-api": "yarn daf extract-api" }, "dependencies": { "daf-core": "^7.0.0-beta.49", diff --git a/packages/daf-elem-did/package.json b/packages/daf-elem-did/package.json index 927d9cc99..a780dfce1 100644 --- a/packages/daf-elem-did/package.json +++ b/packages/daf-elem-did/package.json @@ -6,7 +6,7 @@ "types": "build/index.d.ts", "scripts": { "build": "tsc", - "extract-api": "daf extractPluginApi -c ./api-extractor.json" + "extract-api": "yarn daf extract-api" }, "dependencies": { "@transmute/element-lib": "0.8.4", diff --git a/packages/daf-ethr-did/package.json b/packages/daf-ethr-did/package.json index d3d34d250..0cb023008 100644 --- a/packages/daf-ethr-did/package.json +++ b/packages/daf-ethr-did/package.json @@ -6,7 +6,7 @@ "types": "build/index.d.ts", "scripts": { "build": "tsc", - "extract-api": "daf extractPluginApi -c ./api-extractor.json" + "extract-api": "yarn daf extract-api" }, "dependencies": { "daf-core": "^7.0.0-beta.49", diff --git a/packages/daf-express/package.json b/packages/daf-express/package.json index 32f0c7470..b483827bf 100644 --- a/packages/daf-express/package.json +++ b/packages/daf-express/package.json @@ -6,7 +6,7 @@ "types": "build/index.d.ts", "scripts": { "build": "tsc", - "extract-api": "daf extractPluginApi -c ./api-extractor.json" + "extract-api": "yarn daf extract-api" }, "dependencies": { "daf-core": "^7.0.0-beta.49", diff --git a/packages/daf-identity-manager/api/daf-identity-manager.api.json b/packages/daf-identity-manager/api/daf-identity-manager.api.json index 4759e021c..11a46109c 100644 --- a/packages/daf-identity-manager/api/daf-identity-manager.api.json +++ b/packages/daf-identity-manager/api/daf-identity-manager.api.json @@ -1926,7 +1926,7 @@ }, { "kind": "Content", - "text": "{\n components: {\n schemas: {\n IIdentityManagerAddKeyArgs: {\n type: string;\n properties: {\n did: {\n type: string;\n description: string;\n };\n key: {\n $ref: string;\n description: string;\n };\n options: {\n type: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n IKey: {\n type: string;\n properties: {\n kid: {\n type: string;\n description: string;\n };\n kms: {\n type: string;\n description: string;\n };\n type: {\n $ref: string;\n description: string;\n };\n publicKeyHex: {\n type: string;\n description: string;\n };\n privateKeyHex: {\n type: string;\n description: string;\n };\n meta: {\n anyOf: {\n type: string;\n }[];\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n TKeyType: {\n type: string;\n enum: string[];\n description: string;\n };\n IIdentityManagerAddServiceArgs: {\n type: string;\n properties: {\n did: {\n type: string;\n description: string;\n };\n service: {\n $ref: string;\n description: string;\n };\n options: {\n type: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n IService: {\n type: string;\n properties: {\n id: {\n type: string;\n description: string;\n };\n type: {\n type: string;\n description: string;\n };\n serviceEndpoint: {\n type: string;\n description: string;\n };\n description: {\n type: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n IIdentityManagerCreateIdentityArgs: {\n type: string;\n properties: {\n alias: {\n type: string;\n description: string;\n };\n provider: {\n type: string;\n description: string;\n };\n kms: {\n type: string;\n description: string;\n };\n options: {\n type: string;\n description: string;\n };\n };\n description: string;\n };\n IIdentity: {\n type: string;\n properties: {\n did: {\n type: string;\n description: string;\n };\n alias: {\n type: string;\n description: string;\n };\n provider: {\n type: string;\n description: string;\n };\n controllerKeyId: {\n type: string;\n description: string;\n };\n keys: {\n type: string; /** {@inheritDoc daf-core#IIdentityManager.identityManagerGetOrCreateIdentity} */\n items: {\n $ref: string;\n };\n description: string;\n };\n services: {\n type: string;\n items: {\n $ref: string;\n };\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n IIdentityManagerDeleteIdentityArgs: {\n type: string;\n properties: {\n did: {\n type: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n IIdentityManagerGetIdentitiesArgs: {\n type: string;\n properties: {\n alias: {\n type: string;\n description: string;\n };\n provider: {\n type: string;\n description: string;\n };\n };\n description: string;\n };\n IIdentityManagerGetIdentityArgs: {\n type: string;\n properties: {\n did: {\n type: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n IIdentityManagerGetIdentityByAliasArgs: {\n type: string;\n properties: {\n alias: {\n type: string;\n description: string;\n };\n provider: {\n type: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n IIdentityManagerGetOrCreateIdentityArgs: {\n type: string;\n properties: {\n alias: {\n type: string;\n description: string;\n };\n provider: {\n type: string;\n description: string;\n };\n kms: {\n type: string;\n description: string;\n };\n options: {\n type: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n IIdentityManagerRemoveKeyArgs: {\n type: string;\n properties: {\n did: {\n type: string;\n description: string;\n };\n kid: {\n type: string;\n description: string;\n };\n options: {\n type: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n IIdentityManagerRemoveServiceArgs: {\n type: string;\n properties: {\n did: {\n type: string;\n description: string;\n };\n id: {\n type: string;\n description: string;\n };\n options: {\n type: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n IIdentityManagerSetAliasArgs: {\n type: string;\n properties: {\n did: {\n type: string;\n description: string;\n };\n alias: {\n type: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n };\n methods: {\n identityManagerAddKey: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n type: string;\n };\n };\n identityManagerAddService: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n type: string;\n };\n };\n identityManagerCreateIdentity: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n $ref: string;\n };\n };\n identityManagerDeleteIdentity: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n type: string;\n };\n };\n identityManagerGetIdentities: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n type: string;\n items: {\n $ref: string;\n };\n };\n };\n identityManagerGetIdentity: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n $ref: string;\n };\n };\n identityManagerGetIdentityByAlias: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n $ref: string;\n };\n };\n identityManagerGetOrCreateIdentity: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n $ref: string;\n };\n };\n identityManagerGetProviders: {\n description: string;\n arguments: {\n type: string;\n };\n returnType: {\n type: string;\n items: {\n type: string;\n };\n };\n };\n identityManagerImportIdentity: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n $ref: string;\n };\n };\n identityManagerRemoveKey: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n type: string;\n };\n };\n identityManagerRemoveService: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n type: string;\n };\n };\n identityManagerSetAlias: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n type: string;\n };\n };\n };\n };\n }" + "text": "any" }, { "kind": "Content", diff --git a/packages/daf-identity-manager/api/daf-identity-manager.api.md b/packages/daf-identity-manager/api/daf-identity-manager.api.md index 1691a72d8..82800dfc4 100644 --- a/packages/daf-identity-manager/api/daf-identity-manager.api.md +++ b/packages/daf-identity-manager/api/daf-identity-manager.api.md @@ -118,422 +118,7 @@ export class IdentityManager implements IAgentPlugin { identityManagerSetAlias({ did, alias }: IIdentityManagerSetAliasArgs, context: IAgentContext): Promise; readonly methods: IIdentityManager; // (undocumented) - readonly schema: { - components: { - schemas: { - IIdentityManagerAddKeyArgs: { - type: string; - properties: { - did: { - type: string; - description: string; - }; - key: { - $ref: string; - description: string; - }; - options: { - type: string; - description: string; - }; - }; - required: string[]; - description: string; - }; - IKey: { - type: string; - properties: { - kid: { - type: string; - description: string; - }; - kms: { - type: string; - description: string; - }; - type: { - $ref: string; - description: string; - }; - publicKeyHex: { - type: string; - description: string; - }; - privateKeyHex: { - type: string; - description: string; - }; - meta: { - anyOf: { - type: string; - }[]; - description: string; - }; - }; - required: string[]; - description: string; - }; - TKeyType: { - type: string; - enum: string[]; - description: string; - }; - IIdentityManagerAddServiceArgs: { - type: string; - properties: { - did: { - type: string; - description: string; - }; - service: { - $ref: string; - description: string; - }; - options: { - type: string; - description: string; - }; - }; - required: string[]; - description: string; - }; - IService: { - type: string; - properties: { - id: { - type: string; - description: string; - }; - type: { - type: string; - description: string; - }; - serviceEndpoint: { - type: string; - description: string; - }; - description: { - type: string; - description: string; - }; - }; - required: string[]; - description: string; - }; - IIdentityManagerCreateIdentityArgs: { - type: string; - properties: { - alias: { - type: string; - description: string; - }; - provider: { - type: string; - description: string; - }; - kms: { - type: string; - description: string; - }; - options: { - type: string; - description: string; - }; - }; - description: string; - }; - IIdentity: { - type: string; - properties: { - did: { - type: string; - description: string; - }; - alias: { - type: string; - description: string; - }; - provider: { - type: string; - description: string; - }; - controllerKeyId: { - type: string; - description: string; - }; - keys: { - type: string; /** {@inheritDoc daf-core#IIdentityManager.identityManagerGetOrCreateIdentity} */ - items: { - $ref: string; - }; - description: string; - }; - services: { - type: string; - items: { - $ref: string; - }; - description: string; - }; - }; - required: string[]; - description: string; - }; - IIdentityManagerDeleteIdentityArgs: { - type: string; - properties: { - did: { - type: string; - description: string; - }; - }; - required: string[]; - description: string; - }; - IIdentityManagerGetIdentitiesArgs: { - type: string; - properties: { - alias: { - type: string; - description: string; - }; - provider: { - type: string; - description: string; - }; - }; - description: string; - }; - IIdentityManagerGetIdentityArgs: { - type: string; - properties: { - did: { - type: string; - description: string; - }; - }; - required: string[]; - description: string; - }; - IIdentityManagerGetIdentityByAliasArgs: { - type: string; - properties: { - alias: { - type: string; - description: string; - }; - provider: { - type: string; - description: string; - }; - }; - required: string[]; - description: string; - }; - IIdentityManagerGetOrCreateIdentityArgs: { - type: string; - properties: { - alias: { - type: string; - description: string; - }; - provider: { - type: string; - description: string; - }; - kms: { - type: string; - description: string; - }; - options: { - type: string; - description: string; - }; - }; - required: string[]; - description: string; - }; - IIdentityManagerRemoveKeyArgs: { - type: string; - properties: { - did: { - type: string; - description: string; - }; - kid: { - type: string; - description: string; - }; - options: { - type: string; - description: string; - }; - }; - required: string[]; - description: string; - }; - IIdentityManagerRemoveServiceArgs: { - type: string; - properties: { - did: { - type: string; - description: string; - }; - id: { - type: string; - description: string; - }; - options: { - type: string; - description: string; - }; - }; - required: string[]; - description: string; - }; - IIdentityManagerSetAliasArgs: { - type: string; - properties: { - did: { - type: string; - description: string; - }; - alias: { - type: string; - description: string; - }; - }; - required: string[]; - description: string; - }; - }; - methods: { - identityManagerAddKey: { - description: string; - arguments: { - $ref: string; - }; - returnType: { - type: string; - }; - }; - identityManagerAddService: { - description: string; - arguments: { - $ref: string; - }; - returnType: { - type: string; - }; - }; - identityManagerCreateIdentity: { - description: string; - arguments: { - $ref: string; - }; - returnType: { - $ref: string; - }; - }; - identityManagerDeleteIdentity: { - description: string; - arguments: { - $ref: string; - }; - returnType: { - type: string; - }; - }; - identityManagerGetIdentities: { - description: string; - arguments: { - $ref: string; - }; - returnType: { - type: string; - items: { - $ref: string; - }; - }; - }; - identityManagerGetIdentity: { - description: string; - arguments: { - $ref: string; - }; - returnType: { - $ref: string; - }; - }; - identityManagerGetIdentityByAlias: { - description: string; - arguments: { - $ref: string; - }; - returnType: { - $ref: string; - }; - }; - identityManagerGetOrCreateIdentity: { - description: string; - arguments: { - $ref: string; - }; - returnType: { - $ref: string; - }; - }; - identityManagerGetProviders: { - description: string; - arguments: { - type: string; - }; - returnType: { - type: string; - items: { - type: string; - }; - }; - }; - identityManagerImportIdentity: { - description: string; - arguments: { - $ref: string; - }; - returnType: { - $ref: string; - }; - }; - identityManagerRemoveKey: { - description: string; - arguments: { - $ref: string; - }; - returnType: { - type: string; - }; - }; - identityManagerRemoveService: { - description: string; - arguments: { - $ref: string; - }; - returnType: { - type: string; - }; - }; - identityManagerSetAlias: { - description: string; - arguments: { - $ref: string; - }; - returnType: { - type: string; - }; - }; - }; - }; - }; + readonly schema: any; } diff --git a/packages/daf-identity-manager/package.json b/packages/daf-identity-manager/package.json index 59b6a0023..89e0a97de 100644 --- a/packages/daf-identity-manager/package.json +++ b/packages/daf-identity-manager/package.json @@ -6,7 +6,7 @@ "types": "build/index.d.ts", "scripts": { "build": "tsc", - "extract-api": "daf extractPluginApi -c ./api-extractor.json" + "extract-api": "yarn daf extract-api" }, "dependencies": { "daf-core": "^7.0.0-beta.49" diff --git a/packages/daf-identity-manager/src/identity-manager.ts b/packages/daf-identity-manager/src/identity-manager.ts index abd55b941..006a4cbfb 100644 --- a/packages/daf-identity-manager/src/identity-manager.ts +++ b/packages/daf-identity-manager/src/identity-manager.ts @@ -16,9 +16,10 @@ import { IIdentityManagerRemoveServiceArgs, IIdentityManagerGetIdentitiesArgs, IIdentityManagerSetAliasArgs, + schema, } from 'daf-core' import { AbstractIdentityStore } from './abstract-identity-store' -import schema from 'daf-core/build/schemas/IIdentityManager' + /** * Agent plugin that implements {@link daf-core#IIdentityManager} interface * @public @@ -29,7 +30,7 @@ export class IdentityManager implements IAgentPlugin { * @public */ readonly methods: IIdentityManager - readonly schema = schema + readonly schema = schema.IIdentityManager private providers: Record private defaultProvider: string diff --git a/packages/daf-key-manager/api/daf-key-manager.api.json b/packages/daf-key-manager/api/daf-key-manager.api.json index 8ec147ed7..1a896f089 100644 --- a/packages/daf-key-manager/api/daf-key-manager.api.json +++ b/packages/daf-key-manager/api/daf-key-manager.api.json @@ -1288,7 +1288,7 @@ }, { "kind": "Content", - "text": "{\n components: {\n schemas: {\n IKeyManagerCreateKeyArgs: {\n type: string;\n properties: {\n type: {\n $ref: string;\n description: string;\n };\n kms: {\n type: string;\n description: string;\n };\n meta: {\n type: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n TKeyType: {\n type: string;\n enum: string[];\n description: string;\n };\n IKey: {\n type: string;\n properties: {\n kid: {\n type: string;\n description: string;\n };\n kms: {\n type: string;\n description: string;\n };\n type: {\n $ref: string;\n description: string;\n };\n publicKeyHex: {\n type: string;\n description: string;\n };\n privateKeyHex: {\n type: string;\n description: string;\n };\n meta: {\n anyOf: {\n type: string;\n }[];\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n IKeyManagerDecryptJWEArgs: {\n type: string;\n properties: {\n kid: {\n type: string;\n description: string;\n };\n data: {\n type: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n IKeyManagerDeleteKeyArgs: {\n type: string;\n properties: {\n kid: {\n type: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n IKeyManagerEncryptJWEArgs: {\n type: string;\n properties: {\n kid: {\n type: string;\n description: string;\n };\n to: {\n type: string;\n properties: {\n kid: {\n type: string;\n description: string;\n };\n type: {\n $ref: string;\n description: string;\n };\n publicKeyHex: {\n type: string;\n description: string;\n };\n privateKeyHex: {\n type: string;\n description: string;\n };\n meta: {\n anyOf: {\n type: string;\n }[];\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n data: {\n type: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n IKeyManagerGetKeyArgs: {\n type: string;\n properties: {\n kid: {\n type: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n IKeyManagerSignEthTXArgs: {\n type: string;\n properties: {\n kid: {\n type: string;\n description: string;\n };\n transaction: {\n type: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n IKeyManagerSignJWTArgs: {\n type: string;\n properties: {\n kid: {\n type: string;\n description: string;\n };\n data: {\n type: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n EcdsaSignature: {\n type: string;\n properties: {\n r: {\n type: string;\n };\n s: {\n type: string;\n };\n recoveryParam: {\n type: string;\n const: number;\n };\n };\n required: string[];\n };\n };\n methods: {\n keyManagerCreateKey: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n $ref: string;\n };\n };\n keyManagerDecryptJWE: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n type: string;\n };\n };\n keyManagerDeleteKey: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n type: string;\n };\n };\n keyManagerEncryptJWE: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n type: string;\n };\n };\n keyManagerGetKey: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n $ref: string;\n };\n };\n keyManagerGetKeyManagementSystems: {\n description: string;\n arguments: {\n type: string;\n };\n returnType: {\n type: string;\n items: {\n type: string;\n };\n };\n };\n keyManagerImportKey: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n type: string;\n };\n };\n keyManagerSignEthTX: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n type: string;\n };\n };\n keyManagerSignJWT: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n $ref: string;\n };\n };\n };\n };\n }" + "text": "any" }, { "kind": "Content", diff --git a/packages/daf-key-manager/api/daf-key-manager.api.md b/packages/daf-key-manager/api/daf-key-manager.api.md index 313fa9900..10fbd026c 100644 --- a/packages/daf-key-manager/api/daf-key-manager.api.md +++ b/packages/daf-key-manager/api/daf-key-manager.api.md @@ -99,282 +99,7 @@ export class KeyManager implements IAgentPlugin { keyManagerSignJWT({ kid, data }: IKeyManagerSignJWTArgs): Promise; readonly methods: IKeyManager; // (undocumented) - readonly schema: { - components: { - schemas: { - IKeyManagerCreateKeyArgs: { - type: string; - properties: { - type: { - $ref: string; - description: string; - }; - kms: { - type: string; - description: string; - }; - meta: { - type: string; - description: string; - }; - }; - required: string[]; - description: string; - }; - TKeyType: { - type: string; - enum: string[]; - description: string; - }; - IKey: { - type: string; - properties: { - kid: { - type: string; - description: string; - }; - kms: { - type: string; - description: string; - }; - type: { - $ref: string; - description: string; - }; - publicKeyHex: { - type: string; - description: string; - }; - privateKeyHex: { - type: string; - description: string; - }; - meta: { - anyOf: { - type: string; - }[]; - description: string; - }; - }; - required: string[]; - description: string; - }; - IKeyManagerDecryptJWEArgs: { - type: string; - properties: { - kid: { - type: string; - description: string; - }; - data: { - type: string; - description: string; - }; - }; - required: string[]; - description: string; - }; - IKeyManagerDeleteKeyArgs: { - type: string; - properties: { - kid: { - type: string; - description: string; - }; - }; - required: string[]; - description: string; - }; - IKeyManagerEncryptJWEArgs: { - type: string; - properties: { - kid: { - type: string; - description: string; - }; - to: { - type: string; - properties: { - kid: { - type: string; - description: string; - }; - type: { - $ref: string; - description: string; - }; - publicKeyHex: { - type: string; - description: string; - }; - privateKeyHex: { - type: string; - description: string; - }; - meta: { - anyOf: { - type: string; - }[]; - description: string; - }; - }; - required: string[]; - description: string; - }; - data: { - type: string; - description: string; - }; - }; - required: string[]; - description: string; - }; - IKeyManagerGetKeyArgs: { - type: string; - properties: { - kid: { - type: string; - description: string; - }; - }; - required: string[]; - description: string; - }; - IKeyManagerSignEthTXArgs: { - type: string; - properties: { - kid: { - type: string; - description: string; - }; - transaction: { - type: string; - description: string; - }; - }; - required: string[]; - description: string; - }; - IKeyManagerSignJWTArgs: { - type: string; - properties: { - kid: { - type: string; - description: string; - }; - data: { - type: string; - description: string; - }; - }; - required: string[]; - description: string; - }; - EcdsaSignature: { - type: string; - properties: { - r: { - type: string; - }; - s: { - type: string; - }; - recoveryParam: { - type: string; - const: number; - }; - }; - required: string[]; - }; - }; - methods: { - keyManagerCreateKey: { - description: string; - arguments: { - $ref: string; - }; - returnType: { - $ref: string; - }; - }; - keyManagerDecryptJWE: { - description: string; - arguments: { - $ref: string; - }; - returnType: { - type: string; - }; - }; - keyManagerDeleteKey: { - description: string; - arguments: { - $ref: string; - }; - returnType: { - type: string; - }; - }; - keyManagerEncryptJWE: { - description: string; - arguments: { - $ref: string; - }; - returnType: { - type: string; - }; - }; - keyManagerGetKey: { - description: string; - arguments: { - $ref: string; - }; - returnType: { - $ref: string; - }; - }; - keyManagerGetKeyManagementSystems: { - description: string; - arguments: { - type: string; - }; - returnType: { - type: string; - items: { - type: string; - }; - }; - }; - keyManagerImportKey: { - description: string; - arguments: { - $ref: string; - }; - returnType: { - type: string; - }; - }; - keyManagerSignEthTX: { - description: string; - arguments: { - $ref: string; - }; - returnType: { - type: string; - }; - }; - keyManagerSignJWT: { - description: string; - arguments: { - $ref: string; - }; - returnType: { - $ref: string; - }; - }; - }; - }; - }; + readonly schema: any; } diff --git a/packages/daf-key-manager/package.json b/packages/daf-key-manager/package.json index bf4f30539..a29dff2cc 100644 --- a/packages/daf-key-manager/package.json +++ b/packages/daf-key-manager/package.json @@ -6,7 +6,7 @@ "types": "build/index.d.ts", "scripts": { "build": "tsc", - "extract-api": "daf extractPluginApi -c ./api-extractor.json" + "extract-api": "yarn daf extract-api" }, "dependencies": { "daf-core": "^7.0.0-beta.49" diff --git a/packages/daf-key-manager/src/key-manager.ts b/packages/daf-key-manager/src/key-manager.ts index 2365bf071..c98655771 100644 --- a/packages/daf-key-manager/src/key-manager.ts +++ b/packages/daf-key-manager/src/key-manager.ts @@ -12,8 +12,8 @@ import { IKeyManagerSignJWTArgs, IKeyManagerSignEthTXArgs, EcdsaSignature, + schema, } from 'daf-core' -import schema from 'daf-core/build/schemas/IKeyManager' /** * Agent plugin that provides {@link daf-core#IKeyManager} methods @@ -25,8 +25,8 @@ export class KeyManager implements IAgentPlugin { * @public */ readonly methods: IKeyManager - - readonly schema = schema + + readonly schema = schema.IKeyManager private store: AbstractKeyStore private kms: Record diff --git a/packages/daf-libsodium/package.json b/packages/daf-libsodium/package.json index be09d95fe..e02146933 100644 --- a/packages/daf-libsodium/package.json +++ b/packages/daf-libsodium/package.json @@ -6,7 +6,7 @@ "types": "build/index.d.ts", "scripts": { "build": "tsc", - "extract-api": "daf extractPluginApi -c ./api-extractor.json" + "extract-api": "yarn daf extract-api" }, "dependencies": { "base-58": "^0.0.1", diff --git a/packages/daf-message-handler/api/daf-message-handler.api.json b/packages/daf-message-handler/api/daf-message-handler.api.json index 89a913d88..51b6d5a70 100644 --- a/packages/daf-message-handler/api/daf-message-handler.api.json +++ b/packages/daf-message-handler/api/daf-message-handler.api.json @@ -1,953 +1,953 @@ -{ - "metadata": { - "toolPackage": "@microsoft/api-extractor", - "toolVersion": "7.9.22", - "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 - }, - "kind": "Package", - "canonicalReference": "daf-message-handler!", - "docComment": "/**\n * Provides a {@link daf-message-handler#MessageHandler | plugin} for the {@link daf-core#Agent} that implements {@link daf-core#IMessageHandler} interface\n *\n * @packageDocumentation\n */\n", - "name": "daf-message-handler", - "members": [ - { - "kind": "EntryPoint", - "canonicalReference": "daf-message-handler!", - "name": "", - "members": [ - { - "kind": "Class", - "canonicalReference": "daf-message-handler!AbstractMessageHandler:class", - "docComment": "/**\n * An abstract class for creating {@link daf-message-handler#MessageHandler} plugins\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare abstract class AbstractMessageHandler " - } - ], - "releaseTag": "Public", - "name": "AbstractMessageHandler", - "members": [ - { - "kind": "Method", - "canonicalReference": "daf-message-handler!AbstractMessageHandler#handle:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "handle(message: " - }, - { - "kind": "Reference", - "text": "Message", - "canonicalReference": "daf-message-handler!Message:class" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "IAgentContext", - "canonicalReference": "daf-core!IAgentContext:interface" - }, - { - "kind": "Content", - "text": "<{}>" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Message", - "canonicalReference": "daf-message-handler!Message:class" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 10 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "message", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 - } - } - ], - "name": "handle" - }, - { - "kind": "Property", - "canonicalReference": "daf-message-handler!AbstractMessageHandler#nextMessageHandler:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "nextMessageHandler?: " - }, - { - "kind": "Reference", - "text": "AbstractMessageHandler", - "canonicalReference": "daf-message-handler!AbstractMessageHandler:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "nextMessageHandler", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Method", - "canonicalReference": "daf-message-handler!AbstractMessageHandler#setNext:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "setNext(messageHandler: " - }, - { - "kind": "Reference", - "text": "AbstractMessageHandler", - "canonicalReference": "daf-message-handler!AbstractMessageHandler:class" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "AbstractMessageHandler", - "canonicalReference": "daf-message-handler!AbstractMessageHandler:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "messageHandler", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "setNext" - } - ], - "implementsTokenRanges": [] - }, - { - "kind": "Class", - "canonicalReference": "daf-message-handler!Message:class", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class Message implements " - }, - { - "kind": "Reference", - "text": "IMessage", - "canonicalReference": "daf-core!IMessage:interface" - }, - { - "kind": "Content", - "text": " " - } - ], - "releaseTag": "Public", - "name": "Message", - "members": [ - { - "kind": "Constructor", - "canonicalReference": "daf-message-handler!Message:constructor(1)", - "docComment": "/**\n * Constructs a new instance of the `Message` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(data?: " - }, - { - "kind": "Content", - "text": "{\n raw: string;\n metaData?: " - }, - { - "kind": "Reference", - "text": "IMetaData", - "canonicalReference": "daf-core!IMetaData:interface" - }, - { - "kind": "Content", - "text": "[];\n }" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "data", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - } - ] - }, - { - "kind": "Method", - "canonicalReference": "daf-message-handler!Message#addMetaData:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "addMetaData(meta: " - }, - { - "kind": "Reference", - "text": "IMetaData", - "canonicalReference": "daf-core!IMetaData:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "meta", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "addMetaData" - }, - { - "kind": "Property", - "canonicalReference": "daf-message-handler!Message#createdAt:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "createdAt?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "createdAt", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-message-handler!Message#credentials:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "credentials?: " - }, - { - "kind": "Reference", - "text": "VerifiableCredential", - "canonicalReference": "daf-core!VerifiableCredential:interface" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "credentials", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-message-handler!Message#data:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "data?: " - }, - { - "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "data", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-message-handler!Message#expiresAt:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "expiresAt?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "expiresAt", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-message-handler!Message#from:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "from?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "from", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Method", - "canonicalReference": "daf-message-handler!Message#getLastMetaData:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "getLastMetaData(): " - }, - { - "kind": "Reference", - "text": "IMetaData", - "canonicalReference": "daf-core!IMetaData:interface" - }, - { - "kind": "Content", - "text": " | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [], - "name": "getLastMetaData" - }, - { - "kind": "Property", - "canonicalReference": "daf-message-handler!Message#id:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "id: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Method", - "canonicalReference": "daf-message-handler!Message#isValid:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "isValid(): " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [], - "name": "isValid" - }, - { - "kind": "Property", - "canonicalReference": "daf-message-handler!Message#metaData:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "metaData?: " - }, - { - "kind": "Reference", - "text": "IMetaData", - "canonicalReference": "daf-core!IMetaData:interface" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "metaData", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-message-handler!Message#presentations:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "presentations?: " - }, - { - "kind": "Reference", - "text": "VerifiablePresentation", - "canonicalReference": "daf-core!VerifiablePresentation:interface" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "presentations", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-message-handler!Message#raw:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "raw?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "raw", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-message-handler!Message#replyTo:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "replyTo?: " - }, - { - "kind": "Content", - "text": "string[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "replyTo", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-message-handler!Message#replyUrl:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "replyUrl?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "replyUrl", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-message-handler!Message#threadId:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "threadId?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "threadId", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-message-handler!Message#to:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "to?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "to", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-message-handler!Message#type:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "type: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "type", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - } - ], - "implementsTokenRanges": [ - { - "startIndex": 1, - "endIndex": 3 - } - ] - }, - { - "kind": "Class", - "canonicalReference": "daf-message-handler!MessageHandler:class", - "docComment": "/**\n * Agent plugin that provides {@link daf-core#IMessageHandler} methods\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class MessageHandler implements " - }, - { - "kind": "Reference", - "text": "IAgentPlugin", - "canonicalReference": "daf-core!IAgentPlugin:interface" - }, - { - "kind": "Content", - "text": " " - } - ], - "releaseTag": "Public", - "name": "MessageHandler", - "members": [ - { - "kind": "Constructor", - "canonicalReference": "daf-message-handler!MessageHandler:constructor(1)", - "docComment": "/**\n * Constructs a new instance of the `MessageHandler` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(options: " - }, - { - "kind": "Content", - "text": "{\n messageHandlers: " - }, - { - "kind": "Reference", - "text": "AbstractMessageHandler", - "canonicalReference": "daf-message-handler!AbstractMessageHandler:class" - }, - { - "kind": "Content", - "text": "[];\n }" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - } - ] - }, - { - "kind": "Method", - "canonicalReference": "daf-message-handler!MessageHandler#handleMessage:member(1)", - "docComment": "/**\n * {@inheritDoc daf-core#IMessageHandler.handleMessage}\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "handleMessage(args: " - }, - { - "kind": "Reference", - "text": "IHandleMessageArgs", - "canonicalReference": "daf-core!IHandleMessageArgs:interface" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "IAgentContext", - "canonicalReference": "daf-core!IAgentContext:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "IDataStore", - "canonicalReference": "daf-core!IDataStore:interface" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Message", - "canonicalReference": "daf-message-handler!Message:class" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 8, - "endIndex": 12 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 - } - } - ], - "name": "handleMessage" - }, - { - "kind": "Property", - "canonicalReference": "daf-message-handler!MessageHandler#methods:member", - "docComment": "/**\n * Plugin methods\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly methods: " - }, - { - "kind": "Reference", - "text": "IMessageHandler", - "canonicalReference": "daf-core!IMessageHandler:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "methods", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-message-handler!MessageHandler#schema:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly schema: " - }, - { - "kind": "Content", - "text": "{\n components: {\n schemas: {\n IHandleMessageArgs: {\n type: string;\n properties: {\n raw: {\n type: string;\n description: string;\n };\n metaData: {\n type: string;\n items: {\n $ref: string;\n };\n description: string;\n };\n save: {\n type: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n IMetaData: {\n type: string;\n properties: {\n type: {\n type: string;\n description: string;\n };\n value: {\n type: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n IMessage: {\n type: string;\n properties: {\n id: {\n type: string; /** {@inheritDoc daf-core#IMessageHandler.handleMessage} */\n description: string;\n };\n type: {\n type: string;\n description: string;\n };\n createdAt: {\n type: string;\n description: string;\n };\n expiresAt: {\n type: string;\n description: string;\n };\n threadId: {\n type: string;\n description: string;\n };\n raw: {\n type: string;\n description: string;\n };\n data: {\n anyOf: {\n type: string;\n }[];\n description: string;\n };\n replyTo: {\n type: string;\n items: {\n type: string;\n };\n description: string;\n };\n replyUrl: {\n type: string;\n description: string;\n };\n from: {\n type: string;\n description: string;\n };\n to: {\n type: string;\n description: string;\n };\n metaData: {\n anyOf: ({\n type: string;\n items: {\n $ref: string;\n };\n } | {\n type: string;\n items?: undefined;\n })[];\n description: string;\n };\n credentials: {\n type: string;\n items: {\n $ref: string;\n };\n description: string;\n };\n presentations: {\n type: string;\n items: {\n $ref: string;\n };\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n VerifiableCredential: {\n type: string;\n properties: {\n \"@context\": {\n type: string;\n items: {\n type: string;\n };\n };\n id: {\n type: string;\n };\n type: {\n type: string;\n items: {\n type: string;\n };\n };\n issuer: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n };\n required: string[];\n };\n issuanceDate: {\n type: string;\n };\n expirationDate: {\n type: string;\n };\n credentialSubject: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n };\n };\n credentialStatus: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n type: {\n type: string;\n };\n };\n required: string[];\n };\n proof: {\n type: string;\n properties: {\n type: {\n type: string;\n };\n };\n };\n };\n required: string[];\n description: string;\n };\n VerifiablePresentation: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n holder: {\n type: string;\n };\n issuanceDate: {\n type: string;\n };\n expirationDate: {\n type: string;\n };\n \"@context\": {\n type: string;\n items: {\n type: string;\n };\n };\n type: {\n type: string;\n items: {\n type: string;\n };\n };\n verifier: {\n type: string;\n items: {\n type: string;\n };\n };\n verifiableCredential: {\n type: string;\n items: {\n $ref: string;\n };\n };\n proof: {\n type: string;\n properties: {\n type: {\n type: string;\n };\n };\n };\n };\n required: string[];\n description: string;\n };\n };\n methods: {\n handleMessage: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n $ref: string;\n };\n };\n };\n };\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "schema", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - } - ], - "implementsTokenRanges": [ - { - "startIndex": 1, - "endIndex": 3 - } - ] - } - ] - } - ] -} +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.9.22", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 + }, + "kind": "Package", + "canonicalReference": "daf-message-handler!", + "docComment": "/**\n * Provides a {@link daf-message-handler#MessageHandler | plugin} for the {@link daf-core#Agent} that implements {@link daf-core#IMessageHandler} interface\n *\n * @packageDocumentation\n */\n", + "name": "daf-message-handler", + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "daf-message-handler!", + "name": "", + "members": [ + { + "kind": "Class", + "canonicalReference": "daf-message-handler!AbstractMessageHandler:class", + "docComment": "/**\n * An abstract class for creating {@link daf-message-handler#MessageHandler} plugins\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare abstract class AbstractMessageHandler " + } + ], + "releaseTag": "Public", + "name": "AbstractMessageHandler", + "members": [ + { + "kind": "Method", + "canonicalReference": "daf-message-handler!AbstractMessageHandler#handle:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "handle(message: " + }, + { + "kind": "Reference", + "text": "Message", + "canonicalReference": "daf-message-handler!Message:class" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "IAgentContext", + "canonicalReference": "daf-core!IAgentContext:interface" + }, + { + "kind": "Content", + "text": "<{}>" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Message", + "canonicalReference": "daf-message-handler!Message:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 10 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + } + } + ], + "name": "handle" + }, + { + "kind": "Property", + "canonicalReference": "daf-message-handler!AbstractMessageHandler#nextMessageHandler:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "nextMessageHandler?: " + }, + { + "kind": "Reference", + "text": "AbstractMessageHandler", + "canonicalReference": "daf-message-handler!AbstractMessageHandler:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "nextMessageHandler", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "daf-message-handler!AbstractMessageHandler#setNext:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "setNext(messageHandler: " + }, + { + "kind": "Reference", + "text": "AbstractMessageHandler", + "canonicalReference": "daf-message-handler!AbstractMessageHandler:class" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "AbstractMessageHandler", + "canonicalReference": "daf-message-handler!AbstractMessageHandler:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "messageHandler", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "setNext" + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "daf-message-handler!Message:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class Message implements " + }, + { + "kind": "Reference", + "text": "IMessage", + "canonicalReference": "daf-core!IMessage:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "Message", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "daf-message-handler!Message:constructor(1)", + "docComment": "/**\n * Constructs a new instance of the `Message` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(data?: " + }, + { + "kind": "Content", + "text": "{\n raw: string;\n metaData?: " + }, + { + "kind": "Reference", + "text": "IMetaData", + "canonicalReference": "daf-core!IMetaData:interface" + }, + { + "kind": "Content", + "text": "[];\n }" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "data", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + } + ] + }, + { + "kind": "Method", + "canonicalReference": "daf-message-handler!Message#addMetaData:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "addMetaData(meta: " + }, + { + "kind": "Reference", + "text": "IMetaData", + "canonicalReference": "daf-core!IMetaData:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "meta", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "addMetaData" + }, + { + "kind": "Property", + "canonicalReference": "daf-message-handler!Message#createdAt:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "createdAt?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "createdAt", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-message-handler!Message#credentials:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "credentials?: " + }, + { + "kind": "Reference", + "text": "VerifiableCredential", + "canonicalReference": "daf-core!VerifiableCredential:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "credentials", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-message-handler!Message#data:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "data?: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "data", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-message-handler!Message#expiresAt:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "expiresAt?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "expiresAt", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-message-handler!Message#from:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "from?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "from", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "daf-message-handler!Message#getLastMetaData:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "getLastMetaData(): " + }, + { + "kind": "Reference", + "text": "IMetaData", + "canonicalReference": "daf-core!IMetaData:interface" + }, + { + "kind": "Content", + "text": " | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getLastMetaData" + }, + { + "kind": "Property", + "canonicalReference": "daf-message-handler!Message#id:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "id: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "daf-message-handler!Message#isValid:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "isValid(): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "isValid" + }, + { + "kind": "Property", + "canonicalReference": "daf-message-handler!Message#metaData:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "metaData?: " + }, + { + "kind": "Reference", + "text": "IMetaData", + "canonicalReference": "daf-core!IMetaData:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "metaData", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-message-handler!Message#presentations:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "presentations?: " + }, + { + "kind": "Reference", + "text": "VerifiablePresentation", + "canonicalReference": "daf-core!VerifiablePresentation:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "presentations", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-message-handler!Message#raw:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "raw?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "raw", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-message-handler!Message#replyTo:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "replyTo?: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "replyTo", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-message-handler!Message#replyUrl:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "replyUrl?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "replyUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-message-handler!Message#threadId:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "threadId?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "threadId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-message-handler!Message#to:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "to?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "to", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-message-handler!Message#type:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "type", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "Class", + "canonicalReference": "daf-message-handler!MessageHandler:class", + "docComment": "/**\n * Agent plugin that provides {@link daf-core#IMessageHandler} methods\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class MessageHandler implements " + }, + { + "kind": "Reference", + "text": "IAgentPlugin", + "canonicalReference": "daf-core!IAgentPlugin:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "MessageHandler", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "daf-message-handler!MessageHandler:constructor(1)", + "docComment": "/**\n * Constructs a new instance of the `MessageHandler` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(options: " + }, + { + "kind": "Content", + "text": "{\n messageHandlers: " + }, + { + "kind": "Reference", + "text": "AbstractMessageHandler", + "canonicalReference": "daf-message-handler!AbstractMessageHandler:class" + }, + { + "kind": "Content", + "text": "[];\n }" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + } + ] + }, + { + "kind": "Method", + "canonicalReference": "daf-message-handler!MessageHandler#handleMessage:member(1)", + "docComment": "/**\n * {@inheritDoc daf-core#IMessageHandler.handleMessage}\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "handleMessage(args: " + }, + { + "kind": "Reference", + "text": "IHandleMessageArgs", + "canonicalReference": "daf-core!IHandleMessageArgs:interface" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "IAgentContext", + "canonicalReference": "daf-core!IAgentContext:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IDataStore", + "canonicalReference": "daf-core!IDataStore:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Message", + "canonicalReference": "daf-message-handler!Message:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 8, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + } + } + ], + "name": "handleMessage" + }, + { + "kind": "Property", + "canonicalReference": "daf-message-handler!MessageHandler#methods:member", + "docComment": "/**\n * Plugin methods\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly methods: " + }, + { + "kind": "Reference", + "text": "IMessageHandler", + "canonicalReference": "daf-core!IMessageHandler:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "methods", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-message-handler!MessageHandler#schema:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly schema: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "schema", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + } + ] + } + ] +} diff --git a/packages/daf-message-handler/api/daf-message-handler.api.md b/packages/daf-message-handler/api/daf-message-handler.api.md index a20ed6267..52da35573 100644 --- a/packages/daf-message-handler/api/daf-message-handler.api.md +++ b/packages/daf-message-handler/api/daf-message-handler.api.md @@ -1,328 +1,82 @@ -## API Report File for "daf-message-handler" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts -import { IAgentContext } from 'daf-core' -import { IAgentPlugin } from 'daf-core' -import { IDataStore } from 'daf-core' -import { IHandleMessageArgs } from 'daf-core' -import { IMessage } from 'daf-core' -import { IMessageHandler } from 'daf-core' -import { IMetaData } from 'daf-core' -import { VerifiableCredential } from 'daf-core' -import { VerifiablePresentation } from 'daf-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: { - components: { - schemas: { - IHandleMessageArgs: { - type: string - properties: { - raw: { - type: string - description: string - } - metaData: { - type: string - items: { - $ref: string - } - description: string - } - save: { - type: string - description: string - } - } - required: string[] - description: string - } - IMetaData: { - type: string - properties: { - type: { - type: string - description: string - } - value: { - type: string - description: string - } - } - required: string[] - description: string - } - IMessage: { - type: string - properties: { - id: { - type: string /** {@inheritDoc daf-core#IMessageHandler.handleMessage} */ - description: string - } - type: { - type: string - description: string - } - createdAt: { - type: string - description: string - } - expiresAt: { - type: string - description: string - } - threadId: { - type: string - description: string - } - raw: { - type: string - description: string - } - data: { - anyOf: { - type: string - }[] - description: string - } - replyTo: { - type: string - items: { - type: string - } - description: string - } - replyUrl: { - type: string - description: string - } - from: { - type: string - description: string - } - to: { - type: string - description: string - } - metaData: { - anyOf: ( - | { - type: string - items: { - $ref: string - } - } - | { - type: string - items?: undefined - } - )[] - description: string - } - credentials: { - type: string - items: { - $ref: string - } - description: string - } - presentations: { - type: string - items: { - $ref: string - } - description: string - } - } - required: string[] - description: string - } - VerifiableCredential: { - type: string - properties: { - '@context': { - type: string - items: { - type: string - } - } - id: { - type: string - } - type: { - type: string - items: { - type: string - } - } - issuer: { - type: string - properties: { - id: { - type: string - } - } - required: string[] - } - issuanceDate: { - type: string - } - expirationDate: { - type: string - } - credentialSubject: { - type: string - properties: { - id: { - type: string - } - } - } - credentialStatus: { - type: string - properties: { - id: { - type: string - } - type: { - type: string - } - } - required: string[] - } - proof: { - type: string - properties: { - type: { - type: string - } - } - } - } - required: string[] - description: string - } - VerifiablePresentation: { - type: string - properties: { - id: { - type: string - } - holder: { - type: string - } - issuanceDate: { - type: string - } - expirationDate: { - type: string - } - '@context': { - type: string - items: { - type: string - } - } - type: { - type: string - items: { - type: string - } - } - verifier: { - type: string - items: { - type: string - } - } - verifiableCredential: { - type: string - items: { - $ref: string - } - } - proof: { - type: string - properties: { - type: { - type: string - } - } - } - } - required: string[] - description: string - } - } - methods: { - handleMessage: { - description: string - arguments: { - $ref: string - } - returnType: { - $ref: string - } - } - } - } - } -} -``` +## API Report File for "daf-message-handler" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { IAgentContext } from 'daf-core'; +import { IAgentPlugin } from 'daf-core'; +import { IDataStore } from 'daf-core'; +import { IHandleMessageArgs } from 'daf-core'; +import { IMessage } from 'daf-core'; +import { IMessageHandler } from 'daf-core'; +import { IMetaData } from 'daf-core'; +import { VerifiableCredential } from 'daf-core'; +import { VerifiablePresentation } from 'daf-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/daf-message-handler/package.json b/packages/daf-message-handler/package.json index 9ccc1ff09..6bbd9fd6a 100644 --- a/packages/daf-message-handler/package.json +++ b/packages/daf-message-handler/package.json @@ -6,7 +6,7 @@ "types": "build/index.d.ts", "scripts": { "build": "tsc", - "extract-api": "daf extractPluginApi -c ./api-extractor.json" + "extract-api": "yarn daf extract-api" }, "dependencies": { "daf-core": "^7.0.0-beta.49" diff --git a/packages/daf-message-handler/src/message-handler.ts b/packages/daf-message-handler/src/message-handler.ts index f387ccf1e..a195d2822 100644 --- a/packages/daf-message-handler/src/message-handler.ts +++ b/packages/daf-message-handler/src/message-handler.ts @@ -1,8 +1,13 @@ -import { EventEmitter } from 'events' -import { IDataStore, IAgentPlugin, IAgentContext, IMessageHandler, IHandleMessageArgs } from 'daf-core' +import { + IDataStore, + IAgentPlugin, + IAgentContext, + IMessageHandler, + IHandleMessageArgs, + schema, +} from 'daf-core' import { Message } from './message' import { AbstractMessageHandler } from './abstract-message-handler' -import schema from 'daf-core/build/schemas/IMessageHandler' import Debug from 'debug' const debug = Debug('daf:message-handler') @@ -22,7 +27,7 @@ export class MessageHandler implements IAgentPlugin { * @public */ readonly methods: IMessageHandler - readonly schema = schema + readonly schema = schema.IMessageHandler private messageHandler?: AbstractMessageHandler constructor(options: { messageHandlers: AbstractMessageHandler[] }) { diff --git a/packages/daf-react-native-libsodium/package.json b/packages/daf-react-native-libsodium/package.json index 79661ac87..01b1cd1f7 100644 --- a/packages/daf-react-native-libsodium/package.json +++ b/packages/daf-react-native-libsodium/package.json @@ -6,7 +6,7 @@ "types": "build/index.d.ts", "scripts": { "build": "tsc", - "extract-api": "daf extractPluginApi -c ./api-extractor.json" + "extract-api": "yarn daf extract-api" }, "dependencies": { "base-58": "^0.0.1", diff --git a/packages/daf-resolver-universal/api/daf-resolver-universal.api.json b/packages/daf-resolver-universal/api/daf-resolver-universal.api.json index 52735284e..ec203988b 100644 --- a/packages/daf-resolver-universal/api/daf-resolver-universal.api.json +++ b/packages/daf-resolver-universal/api/daf-resolver-universal.api.json @@ -164,7 +164,7 @@ }, { "kind": "Content", - "text": "{\n components: {\n schemas: {\n ResolveDidArgs: {\n type: string;\n properties: {\n didUrl: {\n type: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n DIDDocument: {\n type: string;\n properties: {\n \"@context\": {\n type: string;\n const: string;\n };\n id: {\n type: string;\n };\n publicKey: {\n type: string;\n items: {\n $ref: string;\n };\n };\n authentication: {\n type: string;\n items: {\n $ref: string;\n };\n };\n uportProfile: {};\n service: {\n type: string;\n items: {\n $ref: string;\n };\n };\n created: {\n type: string;\n };\n updated: {\n type: string;\n };\n proof: {\n $ref: string;\n };\n keyAgreement: {\n type: string;\n items: {\n anyOf: ({\n type: string;\n $ref?: undefined;\n } | {\n $ref: string;\n type?: undefined;\n })[];\n };\n };\n };\n required: string[];\n };\n PublicKey: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n type: {\n type: string;\n };\n controller: {\n type: string;\n };\n ethereumAddress: {\n type: string;\n };\n publicKeyBase64: {\n type: string;\n };\n publicKeyBase58: {\n type: string;\n };\n publicKeyHex: {\n type: string;\n };\n publicKeyPem: {\n type: string;\n };\n };\n required: string[];\n };\n Authentication: {\n type: string;\n properties: {\n type: {\n type: string;\n };\n publicKey: {\n type: string;\n };\n };\n required: string[];\n };\n ServiceEndpoint: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n type: {\n type: string;\n };\n serviceEndpoint: {\n type: string;\n };\n description: {\n type: string;\n };\n };\n required: string[];\n };\n LinkedDataProof: {\n type: string;\n properties: {\n type: {\n type: string;\n };\n created: {\n type: string;\n };\n creator: {\n type: string;\n };\n nonce: {\n type: string;\n };\n signatureValue: {\n type: string;\n };\n };\n required: string[];\n };\n };\n methods: {\n resolveDid: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n $ref: string;\n };\n };\n };\n };\n }" + "text": "any" }, { "kind": "Content", diff --git a/packages/daf-resolver-universal/api/daf-resolver-universal.api.md b/packages/daf-resolver-universal/api/daf-resolver-universal.api.md index 8859ae19a..25773458f 100644 --- a/packages/daf-resolver-universal/api/daf-resolver-universal.api.md +++ b/packages/daf-resolver-universal/api/daf-resolver-universal.api.md @@ -19,168 +19,7 @@ export class DafUniversalResolver implements IAgentPlugin { didUrl: string; }): Promise; // (undocumented) - readonly schema: { - components: { - schemas: { - ResolveDidArgs: { - type: string; - properties: { - didUrl: { - type: string; - description: string; - }; - }; - required: string[]; - description: string; - }; - DIDDocument: { - type: string; - properties: { - "@context": { - type: string; - const: string; - }; - id: { - type: string; - }; - publicKey: { - type: string; - items: { - $ref: string; - }; - }; - authentication: { - type: string; - items: { - $ref: string; - }; - }; - uportProfile: {}; - service: { - type: string; - items: { - $ref: string; - }; - }; - created: { - type: string; - }; - updated: { - type: string; - }; - proof: { - $ref: string; - }; - keyAgreement: { - type: string; - items: { - anyOf: ({ - type: string; - $ref?: undefined; - } | { - $ref: string; - type?: undefined; - })[]; - }; - }; - }; - required: string[]; - }; - PublicKey: { - type: string; - properties: { - id: { - type: string; - }; - type: { - type: string; - }; - controller: { - type: string; - }; - ethereumAddress: { - type: string; - }; - publicKeyBase64: { - type: string; - }; - publicKeyBase58: { - type: string; - }; - publicKeyHex: { - type: string; - }; - publicKeyPem: { - type: string; - }; - }; - required: string[]; - }; - Authentication: { - type: string; - properties: { - type: { - type: string; - }; - publicKey: { - type: string; - }; - }; - required: string[]; - }; - ServiceEndpoint: { - type: string; - properties: { - id: { - type: string; - }; - type: { - type: string; - }; - serviceEndpoint: { - type: string; - }; - description: { - type: string; - }; - }; - required: string[]; - }; - LinkedDataProof: { - type: string; - properties: { - type: { - type: string; - }; - created: { - type: string; - }; - creator: { - type: string; - }; - nonce: { - type: string; - }; - signatureValue: { - type: string; - }; - }; - required: string[]; - }; - }; - methods: { - resolveDid: { - description: string; - arguments: { - $ref: string; - }; - returnType: { - $ref: string; - }; - }; - }; - }; - }; + readonly schema: any; } diff --git a/packages/daf-resolver-universal/package.json b/packages/daf-resolver-universal/package.json index b5c7f4dde..67ba245d4 100644 --- a/packages/daf-resolver-universal/package.json +++ b/packages/daf-resolver-universal/package.json @@ -6,7 +6,7 @@ "types": "build/index.d.ts", "scripts": { "build": "tsc", - "extract-api": "daf extractPluginApi -c ./api-extractor.json" + "extract-api": "yarn daf extract-api" }, "dependencies": { "cross-fetch": "^3.0.5", diff --git a/packages/daf-resolver-universal/src/resolver.ts b/packages/daf-resolver-universal/src/resolver.ts index 31a6492a9..5c07ad6fa 100644 --- a/packages/daf-resolver-universal/src/resolver.ts +++ b/packages/daf-resolver-universal/src/resolver.ts @@ -1,6 +1,5 @@ import 'cross-fetch/polyfill' -import { IAgentPlugin, IResolver } from 'daf-core' -import schema from 'daf-core/build/schemas/IResolver' +import { IAgentPlugin, IResolver, schema } from 'daf-core' import { DIDDocument } from 'did-resolver' export { DIDDocument } import Debug from 'debug' @@ -12,7 +11,7 @@ interface Options { export class DafUniversalResolver implements IAgentPlugin { readonly methods: IResolver - readonly schema = schema + readonly schema = schema.IResolver private url: string constructor(options: Options) { diff --git a/packages/daf-resolver/api/daf-resolver.api.json b/packages/daf-resolver/api/daf-resolver.api.json index 0cca26947..b143366d2 100644 --- a/packages/daf-resolver/api/daf-resolver.api.json +++ b/packages/daf-resolver/api/daf-resolver.api.json @@ -164,7 +164,7 @@ }, { "kind": "Content", - "text": "{\n components: {\n schemas: {\n ResolveDidArgs: {\n type: string;\n properties: {\n didUrl: {\n type: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n DIDDocument: {\n type: string;\n properties: {\n \"@context\": {\n type: string;\n const: string;\n };\n id: {\n type: string;\n };\n publicKey: {\n type: string;\n items: {\n $ref: string;\n };\n };\n authentication: {\n type: string;\n items: {\n $ref: string;\n };\n };\n uportProfile: {};\n service: {\n type: string;\n items: {\n $ref: string;\n };\n };\n created: {\n type: string;\n };\n updated: {\n type: string;\n };\n proof: {\n $ref: string;\n };\n keyAgreement: {\n type: string;\n items: {\n anyOf: ({\n type: string;\n $ref?: undefined;\n } | {\n $ref: string;\n type?: undefined;\n })[];\n };\n };\n };\n required: string[];\n };\n PublicKey: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n type: {\n type: string;\n };\n controller: {\n type: string;\n };\n ethereumAddress: {\n type: string;\n };\n publicKeyBase64: {\n type: string;\n };\n publicKeyBase58: {\n type: string;\n };\n publicKeyHex: {\n type: string;\n };\n publicKeyPem: {\n type: string;\n };\n };\n required: string[];\n };\n Authentication: {\n type: string;\n properties: {\n type: {\n type: string;\n };\n publicKey: {\n type: string;\n };\n };\n required: string[];\n };\n ServiceEndpoint: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n type: {\n type: string;\n };\n serviceEndpoint: {\n type: string;\n };\n description: {\n type: string;\n };\n };\n required: string[];\n };\n LinkedDataProof: {\n type: string;\n properties: {\n type: {\n type: string;\n };\n created: {\n type: string;\n };\n creator: {\n type: string;\n };\n nonce: {\n type: string;\n };\n signatureValue: {\n type: string;\n };\n };\n required: string[];\n };\n };\n methods: {\n resolveDid: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n $ref: string;\n };\n };\n };\n };\n }" + "text": "any" }, { "kind": "Content", diff --git a/packages/daf-resolver/api/daf-resolver.api.md b/packages/daf-resolver/api/daf-resolver.api.md index a4660a18f..57c6c7af0 100644 --- a/packages/daf-resolver/api/daf-resolver.api.md +++ b/packages/daf-resolver/api/daf-resolver.api.md @@ -19,168 +19,7 @@ export class DafResolver implements IAgentPlugin { didUrl: string; }): Promise; // (undocumented) - readonly schema: { - components: { - schemas: { - ResolveDidArgs: { - type: string; - properties: { - didUrl: { - type: string; - description: string; - }; - }; - required: string[]; - description: string; - }; - DIDDocument: { - type: string; - properties: { - "@context": { - type: string; - const: string; - }; - id: { - type: string; - }; - publicKey: { - type: string; - items: { - $ref: string; - }; - }; - authentication: { - type: string; - items: { - $ref: string; - }; - }; - uportProfile: {}; - service: { - type: string; - items: { - $ref: string; - }; - }; - created: { - type: string; - }; - updated: { - type: string; - }; - proof: { - $ref: string; - }; - keyAgreement: { - type: string; - items: { - anyOf: ({ - type: string; - $ref?: undefined; - } | { - $ref: string; - type?: undefined; - })[]; - }; - }; - }; - required: string[]; - }; - PublicKey: { - type: string; - properties: { - id: { - type: string; - }; - type: { - type: string; - }; - controller: { - type: string; - }; - ethereumAddress: { - type: string; - }; - publicKeyBase64: { - type: string; - }; - publicKeyBase58: { - type: string; - }; - publicKeyHex: { - type: string; - }; - publicKeyPem: { - type: string; - }; - }; - required: string[]; - }; - Authentication: { - type: string; - properties: { - type: { - type: string; - }; - publicKey: { - type: string; - }; - }; - required: string[]; - }; - ServiceEndpoint: { - type: string; - properties: { - id: { - type: string; - }; - type: { - type: string; - }; - serviceEndpoint: { - type: string; - }; - description: { - type: string; - }; - }; - required: string[]; - }; - LinkedDataProof: { - type: string; - properties: { - type: { - type: string; - }; - created: { - type: string; - }; - creator: { - type: string; - }; - nonce: { - type: string; - }; - signatureValue: { - type: string; - }; - }; - required: string[]; - }; - }; - methods: { - resolveDid: { - description: string; - arguments: { - $ref: string; - }; - returnType: { - $ref: string; - }; - }; - }; - }; - }; + readonly schema: any; } diff --git a/packages/daf-resolver/package.json b/packages/daf-resolver/package.json index 8b497a7b9..feac96d26 100644 --- a/packages/daf-resolver/package.json +++ b/packages/daf-resolver/package.json @@ -6,7 +6,7 @@ "types": "build/index.d.ts", "scripts": { "build": "tsc", - "extract-api": "daf extractPluginApi -c ./api-extractor.json" + "extract-api": "yarn daf extract-api" }, "dependencies": { "daf-core": "^7.0.0-beta.49", diff --git a/packages/daf-resolver/src/resolver.ts b/packages/daf-resolver/src/resolver.ts index bafc19baf..32691b8af 100644 --- a/packages/daf-resolver/src/resolver.ts +++ b/packages/daf-resolver/src/resolver.ts @@ -1,5 +1,4 @@ -import { IAgentPlugin, IResolver } from 'daf-core' -import schema from 'daf-core/build/schemas/IResolver' +import { IAgentPlugin, IResolver, schema } from 'daf-core' import { Resolver, DIDDocument } from 'did-resolver' import { getResolver as ethrDidResolver } from 'ethr-did-resolver' import { resolver as naclDidResolver } from 'nacl-did' @@ -22,7 +21,7 @@ interface Options { export class DafResolver implements IAgentPlugin { readonly methods: IResolver - readonly schema = schema + readonly schema = schema.IResolver private didResolver: Resolver private networks: NetworkConfig[] diff --git a/packages/daf-rest/api/daf-rest.api.json b/packages/daf-rest/api/daf-rest.api.json index 158c6608d..5e1823146 100644 --- a/packages/daf-rest/api/daf-rest.api.json +++ b/packages/daf-rest/api/daf-rest.api.json @@ -1,197 +1,197 @@ -{ - "metadata": { - "toolPackage": "@microsoft/api-extractor", - "toolVersion": "7.9.22", - "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 - }, - "kind": "Package", - "canonicalReference": "daf-rest!", - "docComment": "/**\n * Provides a {@link daf-rest#AgentRestClient | plugin} for the {@link daf-core#Agent} that can proxy method execution over HTTPS\n *\n * @packageDocumentation\n */\n", - "name": "daf-rest", - "members": [ - { - "kind": "EntryPoint", - "canonicalReference": "daf-rest!", - "name": "", - "members": [ - { - "kind": "Class", - "canonicalReference": "daf-rest!AgentRestClient:class", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class AgentRestClient implements " - }, - { - "kind": "Reference", - "text": "IAgentPlugin", - "canonicalReference": "daf-core!IAgentPlugin:interface" - }, - { - "kind": "Content", - "text": " " - } - ], - "releaseTag": "Public", - "name": "AgentRestClient", - "members": [ - { - "kind": "Constructor", - "canonicalReference": "daf-rest!AgentRestClient:constructor(1)", - "docComment": "/**\n * Constructs a new instance of the `AgentRestClient` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(options: " - }, - { - "kind": "Content", - "text": "{\n url: string;\n enabledMethods: string[];\n schema?: " - }, - { - "kind": "Reference", - "text": "IAgentPluginSchema", - "canonicalReference": "daf-core!IAgentPluginSchema:interface" - }, - { - "kind": "Content", - "text": ";\n headers?: " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": ";\n }" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 6 - } - } - ] - }, - { - "kind": "Property", - "canonicalReference": "daf-rest!AgentRestClient#methods:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly methods: " - }, - { - "kind": "Reference", - "text": "IPluginMethodMap", - "canonicalReference": "daf-core!IPluginMethodMap:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "methods", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-rest!AgentRestClient#schema:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly schema?: " - }, - { - "kind": "Reference", - "text": "IAgentPluginSchema", - "canonicalReference": "daf-core!IAgentPluginSchema:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "schema", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - } - ], - "implementsTokenRanges": [ - { - "startIndex": 1, - "endIndex": 3 - } - ] - }, - { - "kind": "Variable", - "canonicalReference": "daf-rest!getOpenApiSchema:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "getOpenApiSchema: " - }, - { - "kind": "Content", - "text": "(agent: " - }, - { - "kind": "Reference", - "text": "IAgent", - "canonicalReference": "daf-core!IAgent:interface" - }, - { - "kind": "Content", - "text": ", basePath: string, exposedMethods: " - }, - { - "kind": "Reference", - "text": "Array", - "canonicalReference": "!Array:interface" - }, - { - "kind": "Content", - "text": ") => " - }, - { - "kind": "Reference", - "text": "OpenAPIV3.Document", - "canonicalReference": "openapi-types!OpenAPIV3.Document:interface" - } - ], - "releaseTag": "Public", - "name": "getOpenApiSchema", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 7 - } - } - ] - } - ] -} +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.9.22", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 + }, + "kind": "Package", + "canonicalReference": "daf-rest!", + "docComment": "/**\n * Provides a {@link daf-rest#AgentRestClient | plugin} for the {@link daf-core#Agent} that can proxy method execution over HTTPS\n *\n * @packageDocumentation\n */\n", + "name": "daf-rest", + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "daf-rest!", + "name": "", + "members": [ + { + "kind": "Class", + "canonicalReference": "daf-rest!AgentRestClient:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class AgentRestClient implements " + }, + { + "kind": "Reference", + "text": "IAgentPlugin", + "canonicalReference": "daf-core!IAgentPlugin:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "AgentRestClient", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "daf-rest!AgentRestClient:constructor(1)", + "docComment": "/**\n * Constructs a new instance of the `AgentRestClient` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(options: " + }, + { + "kind": "Content", + "text": "{\n url: string;\n enabledMethods: string[];\n schema?: " + }, + { + "kind": "Reference", + "text": "IAgentPluginSchema", + "canonicalReference": "daf-core!IAgentPluginSchema:interface" + }, + { + "kind": "Content", + "text": ";\n headers?: " + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": ";\n }" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 6 + } + } + ] + }, + { + "kind": "Property", + "canonicalReference": "daf-rest!AgentRestClient#methods:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly methods: " + }, + { + "kind": "Reference", + "text": "IPluginMethodMap", + "canonicalReference": "daf-core!IPluginMethodMap:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "methods", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-rest!AgentRestClient#schema:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly schema?: " + }, + { + "kind": "Reference", + "text": "IAgentPluginSchema", + "canonicalReference": "daf-core!IAgentPluginSchema:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "schema", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "Variable", + "canonicalReference": "daf-rest!getOpenApiSchema:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "getOpenApiSchema: " + }, + { + "kind": "Content", + "text": "(agent: " + }, + { + "kind": "Reference", + "text": "IAgent", + "canonicalReference": "daf-core!IAgent:interface" + }, + { + "kind": "Content", + "text": ", basePath: string, exposedMethods: " + }, + { + "kind": "Reference", + "text": "Array", + "canonicalReference": "!Array:interface" + }, + { + "kind": "Content", + "text": ") => " + }, + { + "kind": "Reference", + "text": "OpenAPIV3.Document", + "canonicalReference": "openapi-types!OpenAPIV3.Document:interface" + } + ], + "releaseTag": "Public", + "name": "getOpenApiSchema", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 7 + } + } + ] + } + ] +} diff --git a/packages/daf-rest/api/daf-rest.api.md b/packages/daf-rest/api/daf-rest.api.md index 5cc25415d..b9902f118 100644 --- a/packages/daf-rest/api/daf-rest.api.md +++ b/packages/daf-rest/api/daf-rest.api.md @@ -1,32 +1,31 @@ -## API Report File for "daf-rest" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts -import { IAgent } from 'daf-core' -import { IAgentPlugin } from 'daf-core' -import { IAgentPluginSchema } from 'daf-core' -import { IPluginMethodMap } from 'daf-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, -) => OpenAPIV3.Document -``` +## API Report File for "daf-rest" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { IAgent } from 'daf-core'; +import { IAgentPlugin } from 'daf-core'; +import { IAgentPluginSchema } from 'daf-core'; +import { IPluginMethodMap } from 'daf-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) => OpenAPIV3.Document; + + +``` diff --git a/packages/daf-rest/package.json b/packages/daf-rest/package.json index 758743e64..09c25f264 100644 --- a/packages/daf-rest/package.json +++ b/packages/daf-rest/package.json @@ -6,7 +6,7 @@ "types": "build/index.d.ts", "scripts": { "build": "tsc", - "extract-api": "daf extractPluginApi -c ./api-extractor.json" + "extract-api": "yarn daf extract-api" }, "dependencies": { "cross-fetch": "^3.0.5", diff --git a/packages/daf-selective-disclosure/api/daf-selective-disclosure.api.json b/packages/daf-selective-disclosure/api/daf-selective-disclosure.api.json index 65dfe9f65..dcaeb62bf 100644 --- a/packages/daf-selective-disclosure/api/daf-selective-disclosure.api.json +++ b/packages/daf-selective-disclosure/api/daf-selective-disclosure.api.json @@ -1,1940 +1,1961 @@ -{ - "metadata": { - "toolPackage": "@microsoft/api-extractor", - "toolVersion": "7.9.22", - "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 - }, - "kind": "Package", - "canonicalReference": "daf-selective-disclosure!", - "docComment": "/**\n * Provides a {@link daf-selective-disclosure#ISelectiveDisclosure | plugin} for the {@link daf-core#Agent} that implements {@link daf-selective-disclosure#SelectiveDisclosure} interface. Provides a {@link daf-selective-disclosure#SdrMessageHandler | plugin} for the {@link daf-message-handler#MessageHandler} that detects Selective Disclosure Request in a message\n *\n * @packageDocumentation\n */\n", - "name": "daf-selective-disclosure", - "members": [ - { - "kind": "EntryPoint", - "canonicalReference": "daf-selective-disclosure!", - "name": "", - "members": [ - { - "kind": "Interface", - "canonicalReference": "daf-selective-disclosure!ICreateProfileCredentialsArgs:interface", - "docComment": "/**\n * Profile data\n *\n * @beta\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface ICreateProfileCredentialsArgs " - } - ], - "releaseTag": "Beta", - "name": "ICreateProfileCredentialsArgs", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "daf-selective-disclosure!ICreateProfileCredentialsArgs#holder:member", - "docComment": "/**\n * Holder DID\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "holder: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "holder", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "daf-selective-disclosure!ICreateProfileCredentialsArgs#name:member", - "docComment": "/**\n * Optional. Name\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "name?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "name", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "daf-selective-disclosure!ICreateProfileCredentialsArgs#picture:member", - "docComment": "/**\n * Optional. Picture URL\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "picture?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "picture", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "daf-selective-disclosure!ICreateProfileCredentialsArgs#save:member", - "docComment": "/**\n * Save presentation\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "save: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "save", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "daf-selective-disclosure!ICreateProfileCredentialsArgs#send:member", - "docComment": "/**\n * Send presentation\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "send: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "send", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "daf-selective-disclosure!ICreateProfileCredentialsArgs#url:member", - "docComment": "/**\n * Optional. URL\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "url?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "url", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "daf-selective-disclosure!ICreateProfileCredentialsArgs#verifier:member", - "docComment": "/**\n * Optional. Verifier DID\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "verifier?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "verifier", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "daf-selective-disclosure!ICreateSelectiveDisclosureRequestArgs:interface", - "docComment": "/**\n * Contains the parameters of a Selective Disclosure Request.\n *\n * @remarks\n *\n * See {@link https://github.com/uport-project/specs/blob/develop/messages/sharereq.md | Selective Disclosure Request} specs\n *\n * @beta\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface ICreateSelectiveDisclosureRequestArgs " - } - ], - "releaseTag": "Beta", - "name": "ICreateSelectiveDisclosureRequestArgs", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "daf-selective-disclosure!ICreateSelectiveDisclosureRequestArgs#data:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "data: " - }, - { - "kind": "Reference", - "text": "ISelectiveDisclosureRequest", - "canonicalReference": "daf-selective-disclosure!ISelectiveDisclosureRequest:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "data", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "daf-selective-disclosure!ICredentialRequestInput:interface", - "docComment": "/**\n * Describes a particular credential that is being requested\n *\n * @remarks\n *\n * See {@link https://github.com/uport-project/specs/blob/develop/messages/sharereq.md | Selective Disclosure Request}\n *\n * @beta\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface ICredentialRequestInput " - } - ], - "releaseTag": "Beta", - "name": "ICredentialRequestInput", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "daf-selective-disclosure!ICredentialRequestInput#claimType:member", - "docComment": "/**\n * The name of the claim property that the credential should express.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "claimType: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "claimType", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "daf-selective-disclosure!ICredentialRequestInput#claimValue:member", - "docComment": "/**\n * The value of the claim that the credential should express.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "claimValue?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "claimValue", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "daf-selective-disclosure!ICredentialRequestInput#credentialContext:member", - "docComment": "/**\n * The credential context. See {@link https://www.w3.org/TR/vc-data-model/#contexts | W3C Credential Context}\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "credentialContext?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "credentialContext", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "daf-selective-disclosure!ICredentialRequestInput#credentialType:member", - "docComment": "/**\n * The credential type. See {@link https://www.w3.org/TR/vc-data-model/#types | W3C Credential Types}\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "credentialType?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "credentialType", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "daf-selective-disclosure!ICredentialRequestInput#essential:member", - "docComment": "/**\n * If it is essential. A response that does not include this credential is not sufficient.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "essential?: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "essential", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "daf-selective-disclosure!ICredentialRequestInput#issuers:member", - "docComment": "/**\n * A list of accepted Issuers for this credential.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "issuers?: " - }, - { - "kind": "Reference", - "text": "Issuer", - "canonicalReference": "daf-selective-disclosure!Issuer:interface" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "issuers", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "daf-selective-disclosure!ICredentialRequestInput#reason:member", - "docComment": "/**\n * Motive for requiring this credential.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "reason?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "reason", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "daf-selective-disclosure!ICredentialsForSdr:interface", - "docComment": "/**\n * The credentials that make up a response of a Selective Disclosure\n *\n * @remarks\n *\n * See {@link https://github.com/uport-project/specs/blob/develop/messages/sharereq.md | Selective Disclosure Request}\n *\n * @beta\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface ICredentialsForSdr extends " - }, - { - "kind": "Reference", - "text": "ICredentialRequestInput", - "canonicalReference": "daf-selective-disclosure!ICredentialRequestInput:interface" - }, - { - "kind": "Content", - "text": " " - } - ], - "releaseTag": "Beta", - "name": "ICredentialsForSdr", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "daf-selective-disclosure!ICredentialsForSdr#credentials:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "credentials: " - }, - { - "kind": "Reference", - "text": "VerifiableCredential", - "canonicalReference": "daf-core!VerifiableCredential:interface" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "credentials", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - } - ], - "extendsTokenRanges": [ - { - "startIndex": 1, - "endIndex": 3 - } - ] - }, - { - "kind": "Interface", - "canonicalReference": "daf-selective-disclosure!IGetVerifiableCredentialsForSdrArgs:interface", - "docComment": "/**\n * Encapsulates the params needed to gather credentials to fulfill a Selective disclosure request.\n *\n * @remarks\n *\n * See {@link https://github.com/uport-project/specs/blob/develop/messages/sharereq.md | Selective Disclosure Request} specs\n *\n * @beta\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface IGetVerifiableCredentialsForSdrArgs " - } - ], - "releaseTag": "Beta", - "name": "IGetVerifiableCredentialsForSdrArgs", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "daf-selective-disclosure!IGetVerifiableCredentialsForSdrArgs#did:member", - "docComment": "/**\n * The DID of the subject\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "did?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "did", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "daf-selective-disclosure!IGetVerifiableCredentialsForSdrArgs#sdr:member", - "docComment": "/**\n * The Selective Disclosure Request (issuer is omitted)\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "sdr: " - }, - { - "kind": "Reference", - "text": "Omit", - "canonicalReference": "!Omit:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "ISelectiveDisclosureRequest", - "canonicalReference": "daf-selective-disclosure!ISelectiveDisclosureRequest:interface" - }, - { - "kind": "Content", - "text": ", 'issuer'>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "sdr", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "daf-selective-disclosure!IPresentationValidationResult:interface", - "docComment": "/**\n * The result of a selective disclosure response validation.\n *\n * @beta\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface IPresentationValidationResult " - } - ], - "releaseTag": "Beta", - "name": "IPresentationValidationResult", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "daf-selective-disclosure!IPresentationValidationResult#claims:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "claims: " - }, - { - "kind": "Reference", - "text": "ICredentialsForSdr", - "canonicalReference": "daf-selective-disclosure!ICredentialsForSdr:interface" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "claims", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "daf-selective-disclosure!IPresentationValidationResult#valid:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "valid: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "valid", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "daf-selective-disclosure!ISelectiveDisclosure:interface", - "docComment": "/**\n * Describes the interface of a Selective Disclosure plugin.\n *\n * @remarks\n *\n * See {@link https://github.com/uport-project/specs/blob/develop/messages/sharereq.md | Selective Disclosure Request}\n *\n * @beta\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface ISelectiveDisclosure extends " - }, - { - "kind": "Reference", - "text": "IPluginMethodMap", - "canonicalReference": "daf-core!IPluginMethodMap:interface" - }, - { - "kind": "Content", - "text": " " - } - ], - "releaseTag": "Beta", - "name": "ISelectiveDisclosure", - "members": [ - { - "kind": "MethodSignature", - "canonicalReference": "daf-selective-disclosure!ISelectiveDisclosure#createProfilePresentation:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "createProfilePresentation(args: " - }, - { - "kind": "Reference", - "text": "ICreateProfileCredentialsArgs", - "canonicalReference": "daf-selective-disclosure!ICreateProfileCredentialsArgs:interface" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "IAgentContext", - "canonicalReference": "daf-core!IAgentContext:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "ICredentialIssuer", - "canonicalReference": "daf-w3c!ICredentialIssuer:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "IIdentityManager", - "canonicalReference": "daf-core!IIdentityManager:interface" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "VerifiablePresentation", - "canonicalReference": "daf-core!VerifiablePresentation:interface" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 10, - "endIndex": 14 - }, - "releaseTag": "Beta", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 9 - } - } - ], - "name": "createProfilePresentation" - }, - { - "kind": "MethodSignature", - "canonicalReference": "daf-selective-disclosure!ISelectiveDisclosure#createSelectiveDisclosureRequest:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "createSelectiveDisclosureRequest(args: " - }, - { - "kind": "Reference", - "text": "ICreateSelectiveDisclosureRequestArgs", - "canonicalReference": "daf-selective-disclosure!ICreateSelectiveDisclosureRequestArgs:interface" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "IAgentContext", - "canonicalReference": "daf-core!IAgentContext:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "IIdentityManager", - "canonicalReference": "daf-core!IIdentityManager:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "IKeyManager", - "canonicalReference": "daf-core!IKeyManager:interface" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 10, - "endIndex": 12 - }, - "releaseTag": "Beta", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 9 - } - } - ], - "name": "createSelectiveDisclosureRequest" - }, - { - "kind": "MethodSignature", - "canonicalReference": "daf-selective-disclosure!ISelectiveDisclosure#getVerifiableCredentialsForSdr:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "getVerifiableCredentialsForSdr(args: " - }, - { - "kind": "Reference", - "text": "IGetVerifiableCredentialsForSdrArgs", - "canonicalReference": "daf-selective-disclosure!IGetVerifiableCredentialsForSdrArgs:interface" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "IAgentContext", - "canonicalReference": "daf-core!IAgentContext:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "IDataStoreORM", - "canonicalReference": "daf-typeorm!IDataStoreORM:interface" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Array", - "canonicalReference": "!Array:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "ICredentialsForSdr", - "canonicalReference": "daf-selective-disclosure!ICredentialsForSdr:interface" - }, - { - "kind": "Content", - "text": ">>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 8, - "endIndex": 14 - }, - "releaseTag": "Beta", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 - } - } - ], - "name": "getVerifiableCredentialsForSdr" - }, - { - "kind": "MethodSignature", - "canonicalReference": "daf-selective-disclosure!ISelectiveDisclosure#validatePresentationAgainstSdr:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "validatePresentationAgainstSdr(args: " - }, - { - "kind": "Reference", - "text": "IValidatePresentationAgainstSdrArgs", - "canonicalReference": "daf-selective-disclosure!IValidatePresentationAgainstSdrArgs:interface" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "IAgentContext", - "canonicalReference": "daf-core!IAgentContext:interface" - }, - { - "kind": "Content", - "text": "<{}>" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "IPresentationValidationResult", - "canonicalReference": "daf-selective-disclosure!IPresentationValidationResult:interface" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 10 - }, - "releaseTag": "Beta", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 - } - } - ], - "name": "validatePresentationAgainstSdr" - } - ], - "extendsTokenRanges": [ - { - "startIndex": 1, - "endIndex": 3 - } - ] - }, - { - "kind": "Interface", - "canonicalReference": "daf-selective-disclosure!ISelectiveDisclosureRequest:interface", - "docComment": "/**\n * Represents the Selective Disclosure request parameters.\n *\n * @remarks\n *\n * See {@link https://github.com/uport-project/specs/blob/develop/messages/sharereq.md | Selective Disclosure Request}\n *\n * @beta\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface ISelectiveDisclosureRequest " - } - ], - "releaseTag": "Beta", - "name": "ISelectiveDisclosureRequest", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "daf-selective-disclosure!ISelectiveDisclosureRequest#claims:member", - "docComment": "/**\n * A list of claims that are being requested\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "claims: " - }, - { - "kind": "Reference", - "text": "ICredentialRequestInput", - "canonicalReference": "daf-selective-disclosure!ICredentialRequestInput:interface" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "claims", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "daf-selective-disclosure!ISelectiveDisclosureRequest#credentials:member", - "docComment": "/**\n * A list of issuer credentials that the target will use to establish trust\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "credentials?: " - }, - { - "kind": "Content", - "text": "string[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "credentials", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "daf-selective-disclosure!ISelectiveDisclosureRequest#issuer:member", - "docComment": "/**\n * The issuer of the request\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "issuer: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "issuer", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "daf-selective-disclosure!ISelectiveDisclosureRequest#replyUrl:member", - "docComment": "/**\n * The URL where the response should be sent back\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "replyUrl?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "replyUrl", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "daf-selective-disclosure!ISelectiveDisclosureRequest#subject:member", - "docComment": "/**\n * The target of the request\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "subject?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "subject", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "daf-selective-disclosure!ISelectiveDisclosureRequest#tag:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "tag?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "tag", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "daf-selective-disclosure!Issuer:interface", - "docComment": "/**\n * Used for requesting Credentials using Selective Disclosure. Represents an accepted issuer of a credential.\n *\n * @beta\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface Issuer " - } - ], - "releaseTag": "Beta", - "name": "Issuer", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "daf-selective-disclosure!Issuer#did:member", - "docComment": "/**\n * The DID of the issuer of a requested credential.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "did: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "did", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "daf-selective-disclosure!Issuer#url:member", - "docComment": "/**\n * A URL where a credential of that type can be obtained.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "url: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "url", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "daf-selective-disclosure!IValidatePresentationAgainstSdrArgs:interface", - "docComment": "/**\n * A tuple used to verify a Selective Disclosure Response. Encapsulates the response(`presentation`) and the corresponding request (`sdr`) that made it.\n *\n * @beta\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface IValidatePresentationAgainstSdrArgs " - } - ], - "releaseTag": "Beta", - "name": "IValidatePresentationAgainstSdrArgs", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "daf-selective-disclosure!IValidatePresentationAgainstSdrArgs#presentation:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "presentation: " - }, - { - "kind": "Reference", - "text": "VerifiablePresentation", - "canonicalReference": "daf-core!VerifiablePresentation:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "presentation", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "daf-selective-disclosure!IValidatePresentationAgainstSdrArgs#sdr:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "sdr: " - }, - { - "kind": "Reference", - "text": "ISelectiveDisclosureRequest", - "canonicalReference": "daf-selective-disclosure!ISelectiveDisclosureRequest:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "sdr", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Variable", - "canonicalReference": "daf-selective-disclosure!MessageTypes:var", - "docComment": "/**\n * Identifies a {@link daf-core#IMessage} that represents a Selective Disclosure Request\n *\n * @remarks\n *\n * See {@link https://github.com/uport-project/specs/blob/develop/messages/sharereq.md | Selective Disclosure Request}\n *\n * @beta\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "MessageTypes: " - }, - { - "kind": "Content", - "text": "{\n sdr: string;\n}" - } - ], - "releaseTag": "Beta", - "name": "MessageTypes", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Class", - "canonicalReference": "daf-selective-disclosure!SdrMessageHandler:class", - "docComment": "/**\n * A DAF message handler plugin that can decode an incoming Selective Disclosure Response into the internal Message representation.\n *\n * @beta\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class SdrMessageHandler extends " - }, - { - "kind": "Reference", - "text": "AbstractMessageHandler", - "canonicalReference": "daf-message-handler!AbstractMessageHandler:class" - }, - { - "kind": "Content", - "text": " " - } - ], - "releaseTag": "Beta", - "name": "SdrMessageHandler", - "members": [ - { - "kind": "Method", - "canonicalReference": "daf-selective-disclosure!SdrMessageHandler#handle:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "handle(message: " - }, - { - "kind": "Reference", - "text": "Message", - "canonicalReference": "daf-message-handler!Message:class" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "IAgentContext", - "canonicalReference": "daf-core!IAgentContext:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "IMessageHandler", - "canonicalReference": "daf-core!IMessageHandler:interface" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Message", - "canonicalReference": "daf-message-handler!Message:class" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 8, - "endIndex": 12 - }, - "releaseTag": "Beta", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "message", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 - } - } - ], - "name": "handle" - } - ], - "extendsTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "implementsTokenRanges": [] - }, - { - "kind": "Class", - "canonicalReference": "daf-selective-disclosure!SelectiveDisclosure:class", - "docComment": "/**\n * This class adds support for creating {@link https://github.com/uport-project/specs/blob/develop/flows/selectivedisclosure.md | Selective Disclosure} requests and interpret the responses received.\n *\n * This implementation of the uPort protocol uses {@link https://www.w3.org/TR/vc-data-model/#presentations | W3C Presentation} as the response encoding instead of a `shareReq`.\n *\n * @beta\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class SelectiveDisclosure implements " - }, - { - "kind": "Reference", - "text": "IAgentPlugin", - "canonicalReference": "daf-core!IAgentPlugin:interface" - }, - { - "kind": "Content", - "text": " " - } - ], - "releaseTag": "Beta", - "name": "SelectiveDisclosure", - "members": [ - { - "kind": "Constructor", - "canonicalReference": "daf-selective-disclosure!SelectiveDisclosure:constructor(1)", - "docComment": "/**\n * Constructs a new instance of the `SelectiveDisclosure` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor();" - } - ], - "releaseTag": "Beta", - "overloadIndex": 1, - "parameters": [] - }, - { - "kind": "Method", - "canonicalReference": "daf-selective-disclosure!SelectiveDisclosure#createProfilePresentation:member(1)", - "docComment": "/**\n * Creates profile credentials\n *\n * @beta\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "createProfilePresentation(args: " - }, - { - "kind": "Reference", - "text": "ICreateProfileCredentialsArgs", - "canonicalReference": "daf-selective-disclosure!ICreateProfileCredentialsArgs:interface" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "IAgentContext", - "canonicalReference": "daf-core!IAgentContext:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "ICredentialIssuer", - "canonicalReference": "daf-w3c!ICredentialIssuer:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "IIdentityManager", - "canonicalReference": "daf-core!IIdentityManager:interface" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "VerifiablePresentation", - "canonicalReference": "daf-core!VerifiablePresentation:interface" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 10, - "endIndex": 14 - }, - "releaseTag": "Beta", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 9 - } - } - ], - "name": "createProfilePresentation" - }, - { - "kind": "Method", - "canonicalReference": "daf-selective-disclosure!SelectiveDisclosure#createSelectiveDisclosureRequest:member(1)", - "docComment": "/**\n * Creates a Selective disclosure request, encoded as a JWT.\n *\n * @remarks\n *\n * See {@link https://github.com/uport-project/specs/blob/develop/flows/selectivedisclosure.md | Selective Disclosure}\n *\n * @param args - The param object with the properties necessary to create the request. See {@link ISelectiveDisclosureRequest}\n *\n * @param context - *RESERVED* This is filled by the framework when the method is called.\n *\n * @beta\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "createSelectiveDisclosureRequest(args: " - }, - { - "kind": "Reference", - "text": "ICreateSelectiveDisclosureRequestArgs", - "canonicalReference": "daf-selective-disclosure!ICreateSelectiveDisclosureRequestArgs:interface" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "IAgentContext", - "canonicalReference": "daf-core!IAgentContext:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "IIdentityManager", - "canonicalReference": "daf-core!IIdentityManager:interface" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "IKeyManager", - "canonicalReference": "daf-core!IKeyManager:interface" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 10, - "endIndex": 12 - }, - "releaseTag": "Beta", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 9 - } - } - ], - "name": "createSelectiveDisclosureRequest" - }, - { - "kind": "Method", - "canonicalReference": "daf-selective-disclosure!SelectiveDisclosure#getVerifiableCredentialsForSdr:member(1)", - "docComment": "/**\n * Gathers the required credentials necessary to fulfill a Selective Disclosure Request. It uses the {@link daf-typeorm#IDataStoreORM} plugin to query the local database for the required credentials.\n *\n * @param args - Contains the Request to be fulfilled and the DID of the subject\n *\n * @param context - *RESERVED* This is filled by the framework when the method is called.\n *\n * @beta\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getVerifiableCredentialsForSdr(args: " - }, - { - "kind": "Reference", - "text": "IGetVerifiableCredentialsForSdrArgs", - "canonicalReference": "daf-selective-disclosure!IGetVerifiableCredentialsForSdrArgs:interface" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "IAgentContext", - "canonicalReference": "daf-core!IAgentContext:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "IDataStoreORM", - "canonicalReference": "daf-typeorm!IDataStoreORM:interface" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "ICredentialsForSdr", - "canonicalReference": "daf-selective-disclosure!ICredentialsForSdr:interface" - }, - { - "kind": "Content", - "text": "[]>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 8, - "endIndex": 12 - }, - "releaseTag": "Beta", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 - } - } - ], - "name": "getVerifiableCredentialsForSdr" - }, - { - "kind": "Property", - "canonicalReference": "daf-selective-disclosure!SelectiveDisclosure#methods:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly methods: " - }, - { - "kind": "Reference", - "text": "ISelectiveDisclosure", - "canonicalReference": "daf-selective-disclosure!ISelectiveDisclosure:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "methods", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-selective-disclosure!SelectiveDisclosure#schema:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly schema: " - }, - { - "kind": "Content", - "text": "{\n components: {\n schemas: {\n ICreateProfileCredentialsArgs: {\n type: string;\n properties: {\n holder: {\n type: string;\n description: string;\n };\n verifier: {\n type: string;\n description: string;\n };\n name: {\n type: string;\n description: string;\n };\n picture: {\n type: string;\n description: string;\n };\n url: {\n type: string;\n description: string;\n };\n save: {\n type: string;\n description: string;\n };\n send: {\n type: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n VerifiablePresentation: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n holder: {\n type: string;\n };\n issuanceDate: {\n type: string;\n };\n expirationDate: {\n type: string;\n };\n '@context': {\n type: string;\n items: {\n type: string;\n };\n };\n type: {\n type: string;\n items: {\n type: string;\n }; /**\n * Creates a Selective disclosure request, encoded as a JWT.\n *\n * @remarks See {@link https://github.com/uport-project/specs/blob/develop/flows/selectivedisclosure.md | Selective Disclosure}\n *\n * @param args - The param object with the properties necessary to create the request. See {@link ISelectiveDisclosureRequest}\n * @param context - *RESERVED* This is filled by the framework when the method is called.\n *\n * @beta\n */\n };\n verifier: {\n type: string;\n items: {\n type: string;\n };\n };\n verifiableCredential: {\n type: string;\n items: {\n $ref: string;\n };\n };\n proof: {\n type: string;\n properties: {\n type: {\n type: string;\n };\n };\n };\n };\n required: string[];\n description: string;\n };\n VerifiableCredential: {\n type: string;\n properties: {\n '@context': {\n type: string;\n items: {\n type: string;\n };\n };\n id: {\n type: string;\n };\n type: {\n type: string;\n items: {\n type: string;\n };\n };\n issuer: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n };\n required: string[];\n };\n issuanceDate: {\n type: string;\n };\n expirationDate: {\n type: string;\n };\n credentialSubject: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n };\n };\n credentialStatus: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n type: {\n type: string;\n };\n };\n required: string[];\n };\n proof: {\n type: string;\n properties: {\n type: {\n type: string;\n };\n };\n };\n };\n required: string[];\n description: string;\n };\n ICreateSelectiveDisclosureRequestArgs: {\n type: string;\n properties: {\n data: {\n $ref: string;\n };\n };\n required: string[];\n description: string;\n };\n ISelectiveDisclosureRequest: {\n type: string;\n properties: {\n issuer: {\n type: string;\n description: string;\n };\n subject: {\n type: string;\n description: string;\n };\n replyUrl: {\n type: string;\n description: string;\n };\n tag: {\n type: string;\n };\n claims: {\n type: string;\n items: {\n $ref: string;\n };\n description: string;\n };\n credentials: {\n type: string;\n items: {\n type: string;\n };\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n ICredentialRequestInput: {\n type: string;\n properties: {\n reason: {\n type: string;\n description: string;\n };\n essential: {\n type: string;\n description: string;\n };\n credentialType: {\n type: string;\n description: string;\n };\n credentialContext: {\n type: string;\n description: string;\n };\n claimType: {\n type: string;\n description: string;\n };\n claimValue: {\n type: string;\n description: string;\n };\n issuers: {\n type: string;\n items: {\n $ref: string;\n };\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n Issuer: {\n type: string;\n properties: {\n did: {\n type: string;\n description: string;\n };\n url: {\n type: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n IGetVerifiableCredentialsForSdrArgs: {\n type: string;\n properties: {\n sdr: {\n type: string;\n properties: {\n subject: {\n type: string;\n description: string;\n };\n replyUrl: {\n type: string;\n description: string;\n };\n tag: {\n type: string;\n };\n claims: {\n type: string;\n items: {\n $ref: string;\n };\n description: string;\n };\n credentials: {\n type: string;\n items: {\n type: string;\n };\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n did: {\n type: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n ICredentialsForSdr: {\n type: string;\n properties: {\n reason: {\n type: string;\n description: string;\n };\n essential: {\n type: string;\n description: string;\n };\n credentialType: {\n type: string;\n description: string;\n };\n credentialContext: {\n type: string;\n description: string;\n };\n claimType: {\n type: string;\n description: string;\n };\n claimValue: {\n type: string;\n description: string;\n };\n issuers: {\n type: string;\n items: {\n $ref: string;\n };\n description: string;\n };\n credentials: {\n type: string;\n items: {\n $ref: string;\n };\n };\n };\n required: string[];\n description: string;\n };\n IValidatePresentationAgainstSdrArgs: {\n type: string;\n properties: {\n presentation: {\n $ref: string;\n };\n sdr: {\n $ref: string;\n };\n };\n required: string[];\n description: string;\n };\n IPresentationValidationResult: {\n type: string;\n properties: {\n valid: {\n type: string;\n };\n claims: {\n type: string;\n items: {\n $ref: string;\n };\n };\n };\n required: string[];\n description: string;\n };\n };\n methods: {\n createProfilePresentation: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n $ref: string;\n };\n };\n createSelectiveDisclosureRequest: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n type: string;\n };\n };\n getVerifiableCredentialsForSdr: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n type: string;\n items: {\n $ref: string;\n };\n };\n };\n validatePresentationAgainstSdr: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n $ref: string;\n };\n };\n };\n };\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Beta", - "name": "schema", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Method", - "canonicalReference": "daf-selective-disclosure!SelectiveDisclosure#validatePresentationAgainstSdr:member(1)", - "docComment": "/**\n * Validates a {@link https://github.com/uport-project/specs/blob/develop/flows/selectivedisclosure.md | Selective Disclosure response} encoded as a `Presentation`\n *\n * @param args - Contains the request and the response `Presentation` that needs to be checked.\n *\n * @param context - *RESERVED* This is filled by the framework when the method is called.\n *\n * @beta\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "validatePresentationAgainstSdr(args: " - }, - { - "kind": "Reference", - "text": "IValidatePresentationAgainstSdrArgs", - "canonicalReference": "daf-selective-disclosure!IValidatePresentationAgainstSdrArgs:interface" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "IAgentContext", - "canonicalReference": "daf-core!IAgentContext:interface" - }, - { - "kind": "Content", - "text": "<{}>" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "IPresentationValidationResult", - "canonicalReference": "daf-selective-disclosure!IPresentationValidationResult:interface" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 6, - "endIndex": 10 - }, - "releaseTag": "Beta", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 - } - } - ], - "name": "validatePresentationAgainstSdr" - } - ], - "implementsTokenRanges": [ - { - "startIndex": 1, - "endIndex": 3 - } - ] - } - ] - } - ] -} +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.9.22", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 + }, + "kind": "Package", + "canonicalReference": "daf-selective-disclosure!", + "docComment": "/**\n * Provides a {@link daf-selective-disclosure#ISelectiveDisclosure | plugin} for the {@link daf-core#Agent} that implements {@link daf-selective-disclosure#SelectiveDisclosure} interface. Provides a {@link daf-selective-disclosure#SdrMessageHandler | plugin} for the {@link daf-message-handler#MessageHandler} that detects Selective Disclosure Request in a message\n *\n * @packageDocumentation\n */\n", + "name": "daf-selective-disclosure", + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "daf-selective-disclosure!", + "name": "", + "members": [ + { + "kind": "Interface", + "canonicalReference": "daf-selective-disclosure!ICreateProfileCredentialsArgs:interface", + "docComment": "/**\n * Profile data\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface ICreateProfileCredentialsArgs " + } + ], + "releaseTag": "Beta", + "name": "ICreateProfileCredentialsArgs", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "daf-selective-disclosure!ICreateProfileCredentialsArgs#holder:member", + "docComment": "/**\n * Holder DID\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "holder: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "holder", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "daf-selective-disclosure!ICreateProfileCredentialsArgs#name:member", + "docComment": "/**\n * Optional. Name\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "name?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "daf-selective-disclosure!ICreateProfileCredentialsArgs#picture:member", + "docComment": "/**\n * Optional. Picture URL\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "picture?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "picture", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "daf-selective-disclosure!ICreateProfileCredentialsArgs#save:member", + "docComment": "/**\n * Save presentation\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "save: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "save", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "daf-selective-disclosure!ICreateProfileCredentialsArgs#send:member", + "docComment": "/**\n * Send presentation\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "send: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "send", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "daf-selective-disclosure!ICreateProfileCredentialsArgs#url:member", + "docComment": "/**\n * Optional. URL\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "url?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "url", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "daf-selective-disclosure!ICreateProfileCredentialsArgs#verifier:member", + "docComment": "/**\n * Optional. Verifier DID\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "verifier?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "verifier", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "daf-selective-disclosure!ICreateSelectiveDisclosureRequestArgs:interface", + "docComment": "/**\n * Contains the parameters of a Selective Disclosure Request.\n *\n * @remarks\n *\n * See {@link https://github.com/uport-project/specs/blob/develop/messages/sharereq.md | Selective Disclosure Request} specs\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface ICreateSelectiveDisclosureRequestArgs " + } + ], + "releaseTag": "Beta", + "name": "ICreateSelectiveDisclosureRequestArgs", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "daf-selective-disclosure!ICreateSelectiveDisclosureRequestArgs#data:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "data: " + }, + { + "kind": "Reference", + "text": "ISelectiveDisclosureRequest", + "canonicalReference": "daf-selective-disclosure!ISelectiveDisclosureRequest:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "data", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "daf-selective-disclosure!ICredentialRequestInput:interface", + "docComment": "/**\n * Describes a particular credential that is being requested\n *\n * @remarks\n *\n * See {@link https://github.com/uport-project/specs/blob/develop/messages/sharereq.md | Selective Disclosure Request}\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface ICredentialRequestInput " + } + ], + "releaseTag": "Beta", + "name": "ICredentialRequestInput", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "daf-selective-disclosure!ICredentialRequestInput#claimType:member", + "docComment": "/**\n * The name of the claim property that the credential should express.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "claimType: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "claimType", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "daf-selective-disclosure!ICredentialRequestInput#claimValue:member", + "docComment": "/**\n * The value of the claim that the credential should express.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "claimValue?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "claimValue", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "daf-selective-disclosure!ICredentialRequestInput#credentialContext:member", + "docComment": "/**\n * The credential context. See {@link https://www.w3.org/TR/vc-data-model/#contexts | W3C Credential Context}\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "credentialContext?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "credentialContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "daf-selective-disclosure!ICredentialRequestInput#credentialType:member", + "docComment": "/**\n * The credential type. See {@link https://www.w3.org/TR/vc-data-model/#types | W3C Credential Types}\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "credentialType?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "credentialType", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "daf-selective-disclosure!ICredentialRequestInput#essential:member", + "docComment": "/**\n * If it is essential. A response that does not include this credential is not sufficient.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "essential?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "essential", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "daf-selective-disclosure!ICredentialRequestInput#issuers:member", + "docComment": "/**\n * A list of accepted Issuers for this credential.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "issuers?: " + }, + { + "kind": "Reference", + "text": "Issuer", + "canonicalReference": "daf-selective-disclosure!Issuer:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "issuers", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "daf-selective-disclosure!ICredentialRequestInput#reason:member", + "docComment": "/**\n * Motive for requiring this credential.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "reason?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "reason", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "daf-selective-disclosure!ICredentialsForSdr:interface", + "docComment": "/**\n * The credentials that make up a response of a Selective Disclosure\n *\n * @remarks\n *\n * See {@link https://github.com/uport-project/specs/blob/develop/messages/sharereq.md | Selective Disclosure Request}\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface ICredentialsForSdr extends " + }, + { + "kind": "Reference", + "text": "ICredentialRequestInput", + "canonicalReference": "daf-selective-disclosure!ICredentialRequestInput:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Beta", + "name": "ICredentialsForSdr", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "daf-selective-disclosure!ICredentialsForSdr#credentials:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "credentials: " + }, + { + "kind": "Reference", + "text": "VerifiableCredential", + "canonicalReference": "daf-core!VerifiableCredential:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "credentials", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "daf-selective-disclosure!IGetVerifiableCredentialsForSdrArgs:interface", + "docComment": "/**\n * Encapsulates the params needed to gather credentials to fulfill a Selective disclosure request.\n *\n * @remarks\n *\n * See {@link https://github.com/uport-project/specs/blob/develop/messages/sharereq.md | Selective Disclosure Request} specs\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IGetVerifiableCredentialsForSdrArgs " + } + ], + "releaseTag": "Beta", + "name": "IGetVerifiableCredentialsForSdrArgs", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "daf-selective-disclosure!IGetVerifiableCredentialsForSdrArgs#did:member", + "docComment": "/**\n * The DID of the subject\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "did?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "did", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "daf-selective-disclosure!IGetVerifiableCredentialsForSdrArgs#sdr:member", + "docComment": "/**\n * The Selective Disclosure Request (issuer is omitted)\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "sdr: " + }, + { + "kind": "Reference", + "text": "Omit", + "canonicalReference": "!Omit:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ISelectiveDisclosureRequest", + "canonicalReference": "daf-selective-disclosure!ISelectiveDisclosureRequest:interface" + }, + { + "kind": "Content", + "text": ", 'issuer'>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "sdr", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "daf-selective-disclosure!IPresentationValidationResult:interface", + "docComment": "/**\n * The result of a selective disclosure response validation.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IPresentationValidationResult " + } + ], + "releaseTag": "Beta", + "name": "IPresentationValidationResult", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "daf-selective-disclosure!IPresentationValidationResult#claims:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "claims: " + }, + { + "kind": "Reference", + "text": "ICredentialsForSdr", + "canonicalReference": "daf-selective-disclosure!ICredentialsForSdr:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "claims", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "daf-selective-disclosure!IPresentationValidationResult#valid:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "valid: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "valid", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "daf-selective-disclosure!ISelectiveDisclosure:interface", + "docComment": "/**\n * Describes the interface of a Selective Disclosure plugin.\n *\n * @remarks\n *\n * See {@link https://github.com/uport-project/specs/blob/develop/messages/sharereq.md | Selective Disclosure Request}\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface ISelectiveDisclosure extends " + }, + { + "kind": "Reference", + "text": "IPluginMethodMap", + "canonicalReference": "daf-core!IPluginMethodMap:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Beta", + "name": "ISelectiveDisclosure", + "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "daf-selective-disclosure!ISelectiveDisclosure#createProfilePresentation:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "createProfilePresentation(args: " + }, + { + "kind": "Reference", + "text": "ICreateProfileCredentialsArgs", + "canonicalReference": "daf-selective-disclosure!ICreateProfileCredentialsArgs:interface" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "IAgentContext", + "canonicalReference": "daf-core!IAgentContext:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ICredentialIssuer", + "canonicalReference": "daf-w3c!ICredentialIssuer:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "IIdentityManager", + "canonicalReference": "daf-core!IIdentityManager:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "VerifiablePresentation", + "canonicalReference": "daf-core!VerifiablePresentation:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 10, + "endIndex": 14 + }, + "releaseTag": "Beta", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 9 + } + } + ], + "name": "createProfilePresentation" + }, + { + "kind": "MethodSignature", + "canonicalReference": "daf-selective-disclosure!ISelectiveDisclosure#createSelectiveDisclosureRequest:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "createSelectiveDisclosureRequest(args: " + }, + { + "kind": "Reference", + "text": "ICreateSelectiveDisclosureRequestArgs", + "canonicalReference": "daf-selective-disclosure!ICreateSelectiveDisclosureRequestArgs:interface" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "IAgentContext", + "canonicalReference": "daf-core!IAgentContext:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IIdentityManager", + "canonicalReference": "daf-core!IIdentityManager:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "IKeyManager", + "canonicalReference": "daf-core!IKeyManager:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 10, + "endIndex": 12 + }, + "releaseTag": "Beta", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 9 + } + } + ], + "name": "createSelectiveDisclosureRequest" + }, + { + "kind": "MethodSignature", + "canonicalReference": "daf-selective-disclosure!ISelectiveDisclosure#getVerifiableCredentialsForSdr:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "getVerifiableCredentialsForSdr(args: " + }, + { + "kind": "Reference", + "text": "IGetVerifiableCredentialsForSdrArgs", + "canonicalReference": "daf-selective-disclosure!IGetVerifiableCredentialsForSdrArgs:interface" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "IAgentContext", + "canonicalReference": "daf-core!IAgentContext:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IDataStoreORM", + "canonicalReference": "daf-typeorm!IDataStoreORM:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Array", + "canonicalReference": "!Array:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ICredentialsForSdr", + "canonicalReference": "daf-selective-disclosure!ICredentialsForSdr:interface" + }, + { + "kind": "Content", + "text": ">>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 8, + "endIndex": 14 + }, + "releaseTag": "Beta", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + } + } + ], + "name": "getVerifiableCredentialsForSdr" + }, + { + "kind": "MethodSignature", + "canonicalReference": "daf-selective-disclosure!ISelectiveDisclosure#validatePresentationAgainstSdr:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "validatePresentationAgainstSdr(args: " + }, + { + "kind": "Reference", + "text": "IValidatePresentationAgainstSdrArgs", + "canonicalReference": "daf-selective-disclosure!IValidatePresentationAgainstSdrArgs:interface" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "IAgentContext", + "canonicalReference": "daf-core!IAgentContext:interface" + }, + { + "kind": "Content", + "text": "<{}>" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPresentationValidationResult", + "canonicalReference": "daf-selective-disclosure!IPresentationValidationResult:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 10 + }, + "releaseTag": "Beta", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + } + } + ], + "name": "validatePresentationAgainstSdr" + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "daf-selective-disclosure!ISelectiveDisclosureRequest:interface", + "docComment": "/**\n * Represents the Selective Disclosure request parameters.\n *\n * @remarks\n *\n * See {@link https://github.com/uport-project/specs/blob/develop/messages/sharereq.md | Selective Disclosure Request}\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface ISelectiveDisclosureRequest " + } + ], + "releaseTag": "Beta", + "name": "ISelectiveDisclosureRequest", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "daf-selective-disclosure!ISelectiveDisclosureRequest#claims:member", + "docComment": "/**\n * A list of claims that are being requested\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "claims: " + }, + { + "kind": "Reference", + "text": "ICredentialRequestInput", + "canonicalReference": "daf-selective-disclosure!ICredentialRequestInput:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "claims", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "daf-selective-disclosure!ISelectiveDisclosureRequest#credentials:member", + "docComment": "/**\n * A list of issuer credentials that the target will use to establish trust\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "credentials?: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "credentials", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "daf-selective-disclosure!ISelectiveDisclosureRequest#issuer:member", + "docComment": "/**\n * The issuer of the request\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "issuer: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "issuer", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "daf-selective-disclosure!ISelectiveDisclosureRequest#replyUrl:member", + "docComment": "/**\n * The URL where the response should be sent back\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "replyUrl?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "replyUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "daf-selective-disclosure!ISelectiveDisclosureRequest#subject:member", + "docComment": "/**\n * The target of the request\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "subject?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "subject", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "daf-selective-disclosure!ISelectiveDisclosureRequest#tag:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "tag?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "tag", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "daf-selective-disclosure!Issuer:interface", + "docComment": "/**\n * Used for requesting Credentials using Selective Disclosure. Represents an accepted issuer of a credential.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface Issuer " + } + ], + "releaseTag": "Beta", + "name": "Issuer", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "daf-selective-disclosure!Issuer#did:member", + "docComment": "/**\n * The DID of the issuer of a requested credential.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "did: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "did", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "daf-selective-disclosure!Issuer#url:member", + "docComment": "/**\n * A URL where a credential of that type can be obtained.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "url: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "url", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "daf-selective-disclosure!IValidatePresentationAgainstSdrArgs:interface", + "docComment": "/**\n * A tuple used to verify a Selective Disclosure Response. Encapsulates the response(`presentation`) and the corresponding request (`sdr`) that made it.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IValidatePresentationAgainstSdrArgs " + } + ], + "releaseTag": "Beta", + "name": "IValidatePresentationAgainstSdrArgs", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "daf-selective-disclosure!IValidatePresentationAgainstSdrArgs#presentation:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "presentation: " + }, + { + "kind": "Reference", + "text": "VerifiablePresentation", + "canonicalReference": "daf-core!VerifiablePresentation:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "presentation", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "daf-selective-disclosure!IValidatePresentationAgainstSdrArgs#sdr:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "sdr: " + }, + { + "kind": "Reference", + "text": "ISelectiveDisclosureRequest", + "canonicalReference": "daf-selective-disclosure!ISelectiveDisclosureRequest:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "sdr", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Variable", + "canonicalReference": "daf-selective-disclosure!MessageTypes:var", + "docComment": "/**\n * Identifies a {@link daf-core#IMessage} that represents a Selective Disclosure Request\n *\n * @remarks\n *\n * See {@link https://github.com/uport-project/specs/blob/develop/messages/sharereq.md | Selective Disclosure Request}\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "MessageTypes: " + }, + { + "kind": "Content", + "text": "{\n sdr: string;\n}" + } + ], + "releaseTag": "Beta", + "name": "MessageTypes", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Variable", + "canonicalReference": "daf-selective-disclosure!schema:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "schema: " + }, + { + "kind": "Content", + "text": "any" + } + ], + "releaseTag": "Public", + "name": "schema", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Class", + "canonicalReference": "daf-selective-disclosure!SdrMessageHandler:class", + "docComment": "/**\n * A DAF message handler plugin that can decode an incoming Selective Disclosure Response into the internal Message representation.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class SdrMessageHandler extends " + }, + { + "kind": "Reference", + "text": "AbstractMessageHandler", + "canonicalReference": "daf-message-handler!AbstractMessageHandler:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Beta", + "name": "SdrMessageHandler", + "members": [ + { + "kind": "Method", + "canonicalReference": "daf-selective-disclosure!SdrMessageHandler#handle:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "handle(message: " + }, + { + "kind": "Reference", + "text": "Message", + "canonicalReference": "daf-message-handler!Message:class" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "IAgentContext", + "canonicalReference": "daf-core!IAgentContext:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IMessageHandler", + "canonicalReference": "daf-core!IMessageHandler:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Message", + "canonicalReference": "daf-message-handler!Message:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 8, + "endIndex": 12 + }, + "releaseTag": "Beta", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + } + } + ], + "name": "handle" + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "daf-selective-disclosure!SelectiveDisclosure:class", + "docComment": "/**\n * This class adds support for creating {@link https://github.com/uport-project/specs/blob/develop/flows/selectivedisclosure.md | Selective Disclosure} requests and interpret the responses received.\n *\n * This implementation of the uPort protocol uses {@link https://www.w3.org/TR/vc-data-model/#presentations | W3C Presentation} as the response encoding instead of a `shareReq`.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class SelectiveDisclosure implements " + }, + { + "kind": "Reference", + "text": "IAgentPlugin", + "canonicalReference": "daf-core!IAgentPlugin:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Beta", + "name": "SelectiveDisclosure", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "daf-selective-disclosure!SelectiveDisclosure:constructor(1)", + "docComment": "/**\n * Constructs a new instance of the `SelectiveDisclosure` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor();" + } + ], + "releaseTag": "Beta", + "overloadIndex": 1, + "parameters": [] + }, + { + "kind": "Method", + "canonicalReference": "daf-selective-disclosure!SelectiveDisclosure#createProfilePresentation:member(1)", + "docComment": "/**\n * Creates profile credentials\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "createProfilePresentation(args: " + }, + { + "kind": "Reference", + "text": "ICreateProfileCredentialsArgs", + "canonicalReference": "daf-selective-disclosure!ICreateProfileCredentialsArgs:interface" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "IAgentContext", + "canonicalReference": "daf-core!IAgentContext:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ICredentialIssuer", + "canonicalReference": "daf-w3c!ICredentialIssuer:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "IIdentityManager", + "canonicalReference": "daf-core!IIdentityManager:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "VerifiablePresentation", + "canonicalReference": "daf-core!VerifiablePresentation:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 10, + "endIndex": 14 + }, + "releaseTag": "Beta", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 9 + } + } + ], + "name": "createProfilePresentation" + }, + { + "kind": "Method", + "canonicalReference": "daf-selective-disclosure!SelectiveDisclosure#createSelectiveDisclosureRequest:member(1)", + "docComment": "/**\n * Creates a Selective disclosure request, encoded as a JWT.\n *\n * @remarks\n *\n * See {@link https://github.com/uport-project/specs/blob/develop/flows/selectivedisclosure.md | Selective Disclosure}\n *\n * @param args - The param object with the properties necessary to create the request. See {@link ISelectiveDisclosureRequest}\n *\n * @param context - *RESERVED* This is filled by the framework when the method is called.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "createSelectiveDisclosureRequest(args: " + }, + { + "kind": "Reference", + "text": "ICreateSelectiveDisclosureRequestArgs", + "canonicalReference": "daf-selective-disclosure!ICreateSelectiveDisclosureRequestArgs:interface" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "IAgentContext", + "canonicalReference": "daf-core!IAgentContext:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IIdentityManager", + "canonicalReference": "daf-core!IIdentityManager:interface" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "IKeyManager", + "canonicalReference": "daf-core!IKeyManager:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 10, + "endIndex": 12 + }, + "releaseTag": "Beta", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 9 + } + } + ], + "name": "createSelectiveDisclosureRequest" + }, + { + "kind": "Method", + "canonicalReference": "daf-selective-disclosure!SelectiveDisclosure#getVerifiableCredentialsForSdr:member(1)", + "docComment": "/**\n * Gathers the required credentials necessary to fulfill a Selective Disclosure Request. It uses the {@link daf-typeorm#IDataStoreORM} plugin to query the local database for the required credentials.\n *\n * @param args - Contains the Request to be fulfilled and the DID of the subject\n *\n * @param context - *RESERVED* This is filled by the framework when the method is called.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getVerifiableCredentialsForSdr(args: " + }, + { + "kind": "Reference", + "text": "IGetVerifiableCredentialsForSdrArgs", + "canonicalReference": "daf-selective-disclosure!IGetVerifiableCredentialsForSdrArgs:interface" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "IAgentContext", + "canonicalReference": "daf-core!IAgentContext:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IDataStoreORM", + "canonicalReference": "daf-typeorm!IDataStoreORM:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ICredentialsForSdr", + "canonicalReference": "daf-selective-disclosure!ICredentialsForSdr:interface" + }, + { + "kind": "Content", + "text": "[]>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 8, + "endIndex": 12 + }, + "releaseTag": "Beta", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + } + } + ], + "name": "getVerifiableCredentialsForSdr" + }, + { + "kind": "Property", + "canonicalReference": "daf-selective-disclosure!SelectiveDisclosure#methods:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly methods: " + }, + { + "kind": "Reference", + "text": "ISelectiveDisclosure", + "canonicalReference": "daf-selective-disclosure!ISelectiveDisclosure:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "methods", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-selective-disclosure!SelectiveDisclosure#schema:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly schema: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "schema", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "daf-selective-disclosure!SelectiveDisclosure#validatePresentationAgainstSdr:member(1)", + "docComment": "/**\n * Validates a {@link https://github.com/uport-project/specs/blob/develop/flows/selectivedisclosure.md | Selective Disclosure response} encoded as a `Presentation`\n *\n * @param args - Contains the request and the response `Presentation` that needs to be checked.\n *\n * @param context - *RESERVED* This is filled by the framework when the method is called.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "validatePresentationAgainstSdr(args: " + }, + { + "kind": "Reference", + "text": "IValidatePresentationAgainstSdrArgs", + "canonicalReference": "daf-selective-disclosure!IValidatePresentationAgainstSdrArgs:interface" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "IAgentContext", + "canonicalReference": "daf-core!IAgentContext:interface" + }, + { + "kind": "Content", + "text": "<{}>" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPresentationValidationResult", + "canonicalReference": "daf-selective-disclosure!IPresentationValidationResult:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 10 + }, + "releaseTag": "Beta", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + } + } + ], + "name": "validatePresentationAgainstSdr" + } + ], + "implementsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + } + ] + } + ] +} diff --git a/packages/daf-selective-disclosure/api/daf-selective-disclosure.api.md b/packages/daf-selective-disclosure/api/daf-selective-disclosure.api.md index 874a48c28..5be98394e 100644 --- a/packages/daf-selective-disclosure/api/daf-selective-disclosure.api.md +++ b/packages/daf-selective-disclosure/api/daf-selective-disclosure.api.md @@ -1,573 +1,133 @@ -## API Report File for "daf-selective-disclosure" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts -import { AbstractMessageHandler } from 'daf-message-handler' -import { IAgentContext } from 'daf-core' -import { IAgentPlugin } from 'daf-core' -import { ICredentialIssuer } from 'daf-w3c' -import { IDataStoreORM } from 'daf-typeorm' -import { IIdentityManager } from 'daf-core' -import { IKeyManager } from 'daf-core' -import { IMessageHandler } from 'daf-core' -import { IPluginMethodMap } from 'daf-core' -import { Message } from 'daf-message-handler' -import { VerifiableCredential } from 'daf-core' -import { VerifiablePresentation } from 'daf-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 -} - -// @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: { - components: { - schemas: { - ICreateProfileCredentialsArgs: { - type: string - properties: { - holder: { - type: string - description: string - } - verifier: { - type: string - description: string - } - name: { - type: string - description: string - } - picture: { - type: string - description: string - } - url: { - type: string - description: string - } - save: { - type: string - description: string - } - send: { - type: string - description: string - } - } - required: string[] - description: string - } - VerifiablePresentation: { - type: string - properties: { - id: { - type: string - } - holder: { - type: string - } - issuanceDate: { - type: string - } - expirationDate: { - type: string - } - '@context': { - type: string - items: { - type: string - } - } - type: { - type: string - items: { - type: string - } - /** - * Creates a Selective disclosure request, encoded as a JWT. - * - * @remarks See {@link https://github.com/uport-project/specs/blob/develop/flows/selectivedisclosure.md | Selective Disclosure} - * - * @param args - The param object with the properties necessary to create the request. See {@link ISelectiveDisclosureRequest} - * @param context - *RESERVED* This is filled by the framework when the method is called. - * - * @beta - */ - } - verifier: { - type: string - items: { - type: string - } - } - verifiableCredential: { - type: string - items: { - $ref: string - } - } - proof: { - type: string - properties: { - type: { - type: string - } - } - } - } - required: string[] - description: string - } - VerifiableCredential: { - type: string - properties: { - '@context': { - type: string - items: { - type: string - } - } - id: { - type: string - } - type: { - type: string - items: { - type: string - } - } - issuer: { - type: string - properties: { - id: { - type: string - } - } - required: string[] - } - issuanceDate: { - type: string - } - expirationDate: { - type: string - } - credentialSubject: { - type: string - properties: { - id: { - type: string - } - } - } - credentialStatus: { - type: string - properties: { - id: { - type: string - } - type: { - type: string - } - } - required: string[] - } - proof: { - type: string - properties: { - type: { - type: string - } - } - } - } - required: string[] - description: string - } - ICreateSelectiveDisclosureRequestArgs: { - type: string - properties: { - data: { - $ref: string - } - } - required: string[] - description: string - } - ISelectiveDisclosureRequest: { - type: string - properties: { - issuer: { - type: string - description: string - } - subject: { - type: string - description: string - } - replyUrl: { - type: string - description: string - } - tag: { - type: string - } - claims: { - type: string - items: { - $ref: string - } - description: string - } - credentials: { - type: string - items: { - type: string - } - description: string - } - } - required: string[] - description: string - } - ICredentialRequestInput: { - type: string - properties: { - reason: { - type: string - description: string - } - essential: { - type: string - description: string - } - credentialType: { - type: string - description: string - } - credentialContext: { - type: string - description: string - } - claimType: { - type: string - description: string - } - claimValue: { - type: string - description: string - } - issuers: { - type: string - items: { - $ref: string - } - description: string - } - } - required: string[] - description: string - } - Issuer: { - type: string - properties: { - did: { - type: string - description: string - } - url: { - type: string - description: string - } - } - required: string[] - description: string - } - IGetVerifiableCredentialsForSdrArgs: { - type: string - properties: { - sdr: { - type: string - properties: { - subject: { - type: string - description: string - } - replyUrl: { - type: string - description: string - } - tag: { - type: string - } - claims: { - type: string - items: { - $ref: string - } - description: string - } - credentials: { - type: string - items: { - type: string - } - description: string - } - } - required: string[] - description: string - } - did: { - type: string - description: string - } - } - required: string[] - description: string - } - ICredentialsForSdr: { - type: string - properties: { - reason: { - type: string - description: string - } - essential: { - type: string - description: string - } - credentialType: { - type: string - description: string - } - credentialContext: { - type: string - description: string - } - claimType: { - type: string - description: string - } - claimValue: { - type: string - description: string - } - issuers: { - type: string - items: { - $ref: string - } - description: string - } - credentials: { - type: string - items: { - $ref: string - } - } - } - required: string[] - description: string - } - IValidatePresentationAgainstSdrArgs: { - type: string - properties: { - presentation: { - $ref: string - } - sdr: { - $ref: string - } - } - required: string[] - description: string - } - IPresentationValidationResult: { - type: string - properties: { - valid: { - type: string - } - claims: { - type: string - items: { - $ref: string - } - } - } - required: string[] - description: string - } - } - methods: { - createProfilePresentation: { - description: string - arguments: { - $ref: string - } - returnType: { - $ref: string - } - } - createSelectiveDisclosureRequest: { - description: string - arguments: { - $ref: string - } - returnType: { - type: string - } - } - getVerifiableCredentialsForSdr: { - description: string - arguments: { - $ref: string - } - returnType: { - type: string - items: { - $ref: string - } - } - } - validatePresentationAgainstSdr: { - description: string - arguments: { - $ref: string - } - returnType: { - $ref: string - } - } - } - } - } - validatePresentationAgainstSdr( - args: IValidatePresentationAgainstSdrArgs, - context: IAgentContext<{}>, - ): Promise -} -``` +## API Report File for "daf-selective-disclosure" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { AbstractMessageHandler } from 'daf-message-handler'; +import { IAgentContext } from 'daf-core'; +import { IAgentPlugin } from 'daf-core'; +import { ICredentialIssuer } from 'daf-w3c'; +import { IDataStoreORM } from 'daf-typeorm'; +import { IIdentityManager } from 'daf-core'; +import { IKeyManager } from 'daf-core'; +import { IMessageHandler } from 'daf-core'; +import { IPluginMethodMap } from 'daf-core'; +import { Message } from 'daf-message-handler'; +import { VerifiableCredential } from 'daf-core'; +import { VerifiablePresentation } from 'daf-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/daf-selective-disclosure/package.json b/packages/daf-selective-disclosure/package.json index a24e9f526..2e3d60240 100644 --- a/packages/daf-selective-disclosure/package.json +++ b/packages/daf-selective-disclosure/package.json @@ -6,8 +6,7 @@ "types": "build/index.d.ts", "scripts": { "build": "tsc", - "extract-api": "daf extractPluginApi -c ./api-extractor.json", - "generate-schema": "daf generatePluginSchema" + "generate-plugin-schema": "yarn daf generate-plugin-schema" }, "daf": { "pluginInterfaces": { @@ -31,6 +30,7 @@ "files": [ "build/**/*", "src/**/*", + "plugin.schema.json", "README.md", "LICENSE" ], diff --git a/packages/daf-selective-disclosure/plugin.schema.json b/packages/daf-selective-disclosure/plugin.schema.json new file mode 100644 index 000000000..ec13564f7 --- /dev/null +++ b/packages/daf-selective-disclosure/plugin.schema.json @@ -0,0 +1,461 @@ +{ + "ISelectiveDisclosure": { + "components": { + "schemas": { + "ICreateProfileCredentialsArgs": { + "type": "object", + "properties": { + "holder": { + "type": "string", + "description": "Holder DID" + }, + "verifier": { + "type": "string", + "description": "Optional. Verifier DID" + }, + "name": { + "type": "string", + "description": "Optional. Name" + }, + "picture": { + "type": "string", + "description": "Optional. Picture URL" + }, + "url": { + "type": "string", + "description": "Optional. URL" + }, + "save": { + "type": "boolean", + "description": "Save presentation" + }, + "send": { + "type": "boolean", + "description": "Send presentation" + } + }, + "required": [ + "holder", + "save", + "send" + ], + "description": "Profile data" + }, + "VerifiablePresentation": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "holder": { + "type": "string" + }, + "issuanceDate": { + "type": "string" + }, + "expirationDate": { + "type": "string" + }, + "@context": { + "type": "array", + "items": { + "type": "string" + } + }, + "type": { + "type": "array", + "items": { + "type": "string" + } + }, + "verifier": { + "type": "array", + "items": { + "type": "string" + } + }, + "verifiableCredential": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VerifiableCredential" + } + }, + "proof": { + "type": "object", + "properties": { + "type": { + "type": "string" + } + } + } + }, + "required": [ + "holder", + "@context", + "type", + "verifier", + "verifiableCredential", + "proof" + ], + "description": "Verifiable Presentation {@link https://github.com/decentralized-identity/did-jwt-vc}" + }, + "VerifiableCredential": { + "type": "object", + "properties": { + "@context": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string" + }, + "type": { + "type": "array", + "items": { + "type": "string" + } + }, + "issuer": { + "type": "object", + "properties": { + "id": { + "type": "string" + } + }, + "required": [ + "id" + ] + }, + "issuanceDate": { + "type": "string" + }, + "expirationDate": { + "type": "string" + }, + "credentialSubject": { + "type": "object", + "properties": { + "id": { + "type": "string" + } + } + }, + "credentialStatus": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + }, + "proof": { + "type": "object", + "properties": { + "type": { + "type": "string" + } + } + } + }, + "required": [ + "@context", + "type", + "issuer", + "issuanceDate", + "credentialSubject", + "proof" + ], + "description": "Verifiable Credential {@link https://github.com/decentralized-identity/did-jwt-vc}" + }, + "ICreateSelectiveDisclosureRequestArgs": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ISelectiveDisclosureRequest" + } + }, + "required": [ + "data" + ], + "description": "Contains the parameters of a Selective Disclosure Request." + }, + "ISelectiveDisclosureRequest": { + "type": "object", + "properties": { + "issuer": { + "type": "string", + "description": "The issuer of the request" + }, + "subject": { + "type": "string", + "description": "The target of the request" + }, + "replyUrl": { + "type": "string", + "description": "The URL where the response should be sent back" + }, + "tag": { + "type": "string" + }, + "claims": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ICredentialRequestInput" + }, + "description": "A list of claims that are being requested" + }, + "credentials": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of issuer credentials that the target will use to establish trust" + } + }, + "required": [ + "issuer", + "claims" + ], + "description": "Represents the Selective Disclosure request parameters." + }, + "ICredentialRequestInput": { + "type": "object", + "properties": { + "reason": { + "type": "string", + "description": "Motive for requiring this credential." + }, + "essential": { + "type": "boolean", + "description": "If it is essential. A response that does not include this credential is not sufficient." + }, + "credentialType": { + "type": "string", + "description": "The credential type. See {@link https://www.w3.org/TR/vc-data-model/#types | W3C Credential Types}" + }, + "credentialContext": { + "type": "string", + "description": "The credential context. See {@link https://www.w3.org/TR/vc-data-model/#contexts | W3C Credential Context}" + }, + "claimType": { + "type": "string", + "description": "The name of the claim property that the credential should express." + }, + "claimValue": { + "type": "string", + "description": "The value of the claim that the credential should express." + }, + "issuers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Issuer" + }, + "description": "A list of accepted Issuers for this credential." + } + }, + "required": [ + "claimType" + ], + "description": "Describes a particular credential that is being requested" + }, + "Issuer": { + "type": "object", + "properties": { + "did": { + "type": "string", + "description": "The DID of the issuer of a requested credential." + }, + "url": { + "type": "string", + "description": "A URL where a credential of that type can be obtained." + } + }, + "required": [ + "did", + "url" + ], + "description": "Used for requesting Credentials using Selective Disclosure. Represents an accepted issuer of a credential." + }, + "IGetVerifiableCredentialsForSdrArgs": { + "type": "object", + "properties": { + "sdr": { + "type": "object", + "properties": { + "subject": { + "type": "string", + "description": "The target of the request" + }, + "replyUrl": { + "type": "string", + "description": "The URL where the response should be sent back" + }, + "tag": { + "type": "string" + }, + "claims": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ICredentialRequestInput" + }, + "description": "A list of claims that are being requested" + }, + "credentials": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of issuer credentials that the target will use to establish trust" + } + }, + "required": [ + "claims" + ], + "description": "The Selective Disclosure Request (issuer is omitted)" + }, + "did": { + "type": "string", + "description": "The DID of the subject" + } + }, + "required": [ + "sdr" + ], + "description": "Encapsulates the params needed to gather credentials to fulfill a Selective disclosure request." + }, + "ICredentialsForSdr": { + "type": "object", + "properties": { + "reason": { + "type": "string", + "description": "Motive for requiring this credential." + }, + "essential": { + "type": "boolean", + "description": "If it is essential. A response that does not include this credential is not sufficient." + }, + "credentialType": { + "type": "string", + "description": "The credential type. See {@link https://www.w3.org/TR/vc-data-model/#types | W3C Credential Types}" + }, + "credentialContext": { + "type": "string", + "description": "The credential context. See {@link https://www.w3.org/TR/vc-data-model/#contexts | W3C Credential Context}" + }, + "claimType": { + "type": "string", + "description": "The name of the claim property that the credential should express." + }, + "claimValue": { + "type": "string", + "description": "The value of the claim that the credential should express." + }, + "issuers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Issuer" + }, + "description": "A list of accepted Issuers for this credential." + }, + "credentials": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VerifiableCredential" + } + } + }, + "required": [ + "claimType", + "credentials" + ], + "description": "The credentials that make up a response of a Selective Disclosure" + }, + "IValidatePresentationAgainstSdrArgs": { + "type": "object", + "properties": { + "presentation": { + "$ref": "#/components/schemas/VerifiablePresentation" + }, + "sdr": { + "$ref": "#/components/schemas/ISelectiveDisclosureRequest" + } + }, + "required": [ + "presentation", + "sdr" + ], + "description": "A tuple used to verify a Selective Disclosure Response. Encapsulates the response(`presentation`) and the corresponding request (`sdr`) that made it." + }, + "IPresentationValidationResult": { + "type": "object", + "properties": { + "valid": { + "type": "boolean" + }, + "claims": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ICredentialsForSdr" + } + } + }, + "required": [ + "valid", + "claims" + ], + "description": "The result of a selective disclosure response validation." + } + }, + "methods": { + "createProfilePresentation": { + "description": "", + "arguments": { + "$ref": "#/components/schemas/ICreateProfileCredentialsArgs" + }, + "returnType": { + "$ref": "#/components/schemas/VerifiablePresentation" + } + }, + "createSelectiveDisclosureRequest": { + "description": "", + "arguments": { + "$ref": "#/components/schemas/ICreateSelectiveDisclosureRequestArgs" + }, + "returnType": { + "type": "string" + } + }, + "getVerifiableCredentialsForSdr": { + "description": "", + "arguments": { + "$ref": "#/components/schemas/IGetVerifiableCredentialsForSdrArgs" + }, + "returnType": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ICredentialsForSdr" + } + } + }, + "validatePresentationAgainstSdr": { + "description": "", + "arguments": { + "$ref": "#/components/schemas/IValidatePresentationAgainstSdrArgs" + }, + "returnType": { + "$ref": "#/components/schemas/IPresentationValidationResult" + } + } + } + } + } +} \ No newline at end of file diff --git a/packages/daf-selective-disclosure/src/action-handler.ts b/packages/daf-selective-disclosure/src/action-handler.ts index bc4b1adb7..193f9d0ad 100644 --- a/packages/daf-selective-disclosure/src/action-handler.ts +++ b/packages/daf-selective-disclosure/src/action-handler.ts @@ -18,7 +18,7 @@ import { ISelectiveDisclosureRequest, ICreateProfileCredentialsArgs, } from './types' -import schema from './schemas/ISelectiveDisclosure' +import { schema } from './' import { createJWT } from 'did-jwt' import Debug from 'debug' @@ -35,7 +35,7 @@ import Debug from 'debug' */ export class SelectiveDisclosure implements IAgentPlugin { readonly methods: ISelectiveDisclosure - readonly schema = schema + readonly schema = schema.ISelectiveDisclosure constructor() { this.methods = { diff --git a/packages/daf-selective-disclosure/src/index.ts b/packages/daf-selective-disclosure/src/index.ts index bfda4179a..4ab38f418 100644 --- a/packages/daf-selective-disclosure/src/index.ts +++ b/packages/daf-selective-disclosure/src/index.ts @@ -6,3 +6,5 @@ export { SdrMessageHandler, MessageTypes } from './message-handler' export { SelectiveDisclosure } from './action-handler' export * from './types' +const schema = require('../plugin.schema.json') +export { schema } diff --git a/packages/daf-selective-disclosure/src/schemas/ISelectiveDisclosure.ts b/packages/daf-selective-disclosure/src/schemas/ISelectiveDisclosure.ts deleted file mode 100644 index 9e2260345..000000000 --- a/packages/daf-selective-disclosure/src/schemas/ISelectiveDisclosure.ts +++ /dev/null @@ -1,422 +0,0 @@ -export default { - components: { - schemas: { - ICreateProfileCredentialsArgs: { - type: 'object', - properties: { - holder: { - type: 'string', - description: 'Holder DID', - }, - verifier: { - type: 'string', - description: 'Optional. Verifier DID', - }, - name: { - type: 'string', - description: 'Optional. Name', - }, - picture: { - type: 'string', - description: 'Optional. Picture URL', - }, - url: { - type: 'string', - description: 'Optional. URL', - }, - save: { - type: 'boolean', - description: 'Save presentation', - }, - send: { - type: 'boolean', - description: 'Send presentation', - }, - }, - required: ['holder', 'save', 'send'], - description: 'Profile data', - }, - VerifiablePresentation: { - type: 'object', - properties: { - id: { - type: 'string', - }, - holder: { - type: 'string', - }, - issuanceDate: { - type: 'string', - }, - expirationDate: { - type: 'string', - }, - '@context': { - type: 'array', - items: { - type: 'string', - }, - }, - type: { - type: 'array', - items: { - type: 'string', - }, - }, - verifier: { - type: 'array', - items: { - type: 'string', - }, - }, - verifiableCredential: { - type: 'array', - items: { - $ref: '#/components/schemas/VerifiableCredential', - }, - }, - proof: { - type: 'object', - properties: { - type: { - type: 'string', - }, - }, - }, - }, - required: ['holder', '@context', 'type', 'verifier', 'verifiableCredential', 'proof'], - description: 'Verifiable Presentation {@link https://github.com/decentralized-identity/did-jwt-vc}', - }, - VerifiableCredential: { - type: 'object', - properties: { - '@context': { - type: 'array', - items: { - type: 'string', - }, - }, - id: { - type: 'string', - }, - type: { - type: 'array', - items: { - type: 'string', - }, - }, - issuer: { - type: 'object', - properties: { - id: { - type: 'string', - }, - }, - required: ['id'], - }, - issuanceDate: { - type: 'string', - }, - expirationDate: { - type: 'string', - }, - credentialSubject: { - type: 'object', - properties: { - id: { - type: 'string', - }, - }, - }, - credentialStatus: { - type: 'object', - properties: { - id: { - type: 'string', - }, - type: { - type: 'string', - }, - }, - required: ['id', 'type'], - }, - proof: { - type: 'object', - properties: { - type: { - type: 'string', - }, - }, - }, - }, - required: ['@context', 'type', 'issuer', 'issuanceDate', 'credentialSubject', 'proof'], - description: 'Verifiable Credential {@link https://github.com/decentralized-identity/did-jwt-vc}', - }, - ICreateSelectiveDisclosureRequestArgs: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/ISelectiveDisclosureRequest', - }, - }, - required: ['data'], - description: 'Contains the parameters of a Selective Disclosure Request.', - }, - ISelectiveDisclosureRequest: { - type: 'object', - properties: { - issuer: { - type: 'string', - description: 'The issuer of the request', - }, - subject: { - type: 'string', - description: 'The target of the request', - }, - replyUrl: { - type: 'string', - description: 'The URL where the response should be sent back', - }, - tag: { - type: 'string', - }, - claims: { - type: 'array', - items: { - $ref: '#/components/schemas/ICredentialRequestInput', - }, - description: 'A list of claims that are being requested', - }, - credentials: { - type: 'array', - items: { - type: 'string', - }, - description: 'A list of issuer credentials that the target will use to establish trust', - }, - }, - required: ['issuer', 'claims'], - description: 'Represents the Selective Disclosure request parameters.', - }, - ICredentialRequestInput: { - type: 'object', - properties: { - reason: { - type: 'string', - description: 'Motive for requiring this credential.', - }, - essential: { - type: 'boolean', - description: - 'If it is essential. A response that does not include this credential is not sufficient.', - }, - credentialType: { - type: 'string', - description: - 'The credential type. See {@link https://www.w3.org/TR/vc-data-model/#types | W3C Credential Types}', - }, - credentialContext: { - type: 'string', - description: - 'The credential context. See {@link https://www.w3.org/TR/vc-data-model/#contexts | W3C Credential Context}', - }, - claimType: { - type: 'string', - description: 'The name of the claim property that the credential should express.', - }, - claimValue: { - type: 'string', - description: 'The value of the claim that the credential should express.', - }, - issuers: { - type: 'array', - items: { - $ref: '#/components/schemas/Issuer', - }, - description: 'A list of accepted Issuers for this credential.', - }, - }, - required: ['claimType'], - description: 'Describes a particular credential that is being requested', - }, - Issuer: { - type: 'object', - properties: { - did: { - type: 'string', - description: 'The DID of the issuer of a requested credential.', - }, - url: { - type: 'string', - description: 'A URL where a credential of that type can be obtained.', - }, - }, - required: ['did', 'url'], - description: - 'Used for requesting Credentials using Selective Disclosure. Represents an accepted issuer of a credential.', - }, - IGetVerifiableCredentialsForSdrArgs: { - type: 'object', - properties: { - sdr: { - type: 'object', - properties: { - subject: { - type: 'string', - description: 'The target of the request', - }, - replyUrl: { - type: 'string', - description: 'The URL where the response should be sent back', - }, - tag: { - type: 'string', - }, - claims: { - type: 'array', - items: { - $ref: '#/components/schemas/ICredentialRequestInput', - }, - description: 'A list of claims that are being requested', - }, - credentials: { - type: 'array', - items: { - type: 'string', - }, - description: 'A list of issuer credentials that the target will use to establish trust', - }, - }, - required: ['claims'], - description: 'The Selective Disclosure Request (issuer is omitted)', - }, - did: { - type: 'string', - description: 'The DID of the subject', - }, - }, - required: ['sdr'], - description: - 'Encapsulates the params needed to gather credentials to fulfill a Selective disclosure request.', - }, - ICredentialsForSdr: { - type: 'object', - properties: { - reason: { - type: 'string', - description: 'Motive for requiring this credential.', - }, - essential: { - type: 'boolean', - description: - 'If it is essential. A response that does not include this credential is not sufficient.', - }, - credentialType: { - type: 'string', - description: - 'The credential type. See {@link https://www.w3.org/TR/vc-data-model/#types | W3C Credential Types}', - }, - credentialContext: { - type: 'string', - description: - 'The credential context. See {@link https://www.w3.org/TR/vc-data-model/#contexts | W3C Credential Context}', - }, - claimType: { - type: 'string', - description: 'The name of the claim property that the credential should express.', - }, - claimValue: { - type: 'string', - description: 'The value of the claim that the credential should express.', - }, - issuers: { - type: 'array', - items: { - $ref: '#/components/schemas/Issuer', - }, - description: 'A list of accepted Issuers for this credential.', - }, - credentials: { - type: 'array', - items: { - $ref: '#/components/schemas/VerifiableCredential', - }, - }, - }, - required: ['claimType', 'credentials'], - description: 'The credentials that make up a response of a Selective Disclosure', - }, - IValidatePresentationAgainstSdrArgs: { - type: 'object', - properties: { - presentation: { - $ref: '#/components/schemas/VerifiablePresentation', - }, - sdr: { - $ref: '#/components/schemas/ISelectiveDisclosureRequest', - }, - }, - required: ['presentation', 'sdr'], - description: - 'A tuple used to verify a Selective Disclosure Response. Encapsulates the response(`presentation`) and the corresponding request (`sdr`) that made it.', - }, - IPresentationValidationResult: { - type: 'object', - properties: { - valid: { - type: 'boolean', - }, - claims: { - type: 'array', - items: { - $ref: '#/components/schemas/ICredentialsForSdr', - }, - }, - }, - required: ['valid', 'claims'], - description: 'The result of a selective disclosure response validation.', - }, - }, - methods: { - createProfilePresentation: { - description: '', - arguments: { - $ref: '#/components/schemas/ICreateProfileCredentialsArgs', - }, - returnType: { - $ref: '#/components/schemas/VerifiablePresentation', - }, - }, - createSelectiveDisclosureRequest: { - description: '', - arguments: { - $ref: '#/components/schemas/ICreateSelectiveDisclosureRequestArgs', - }, - returnType: { - type: 'string', - }, - }, - getVerifiableCredentialsForSdr: { - description: '', - arguments: { - $ref: '#/components/schemas/IGetVerifiableCredentialsForSdrArgs', - }, - returnType: { - type: 'array', - items: { - $ref: '#/components/schemas/ICredentialsForSdr', - }, - }, - }, - validatePresentationAgainstSdr: { - description: '', - arguments: { - $ref: '#/components/schemas/IValidatePresentationAgainstSdrArgs', - }, - returnType: { - $ref: '#/components/schemas/IPresentationValidationResult', - }, - }, - }, - }, -} diff --git a/packages/daf-typeorm/api/daf-typeorm.api.json b/packages/daf-typeorm/api/daf-typeorm.api.json index fb171e9fd..e9d1068ec 100644 --- a/packages/daf-typeorm/api/daf-typeorm.api.json +++ b/packages/daf-typeorm/api/daf-typeorm.api.json @@ -1,6281 +1,6302 @@ -{ - "metadata": { - "toolPackage": "@microsoft/api-extractor", - "toolVersion": "7.9.22", - "schemaVersion": 1003, - "oldestForwardsCompatibleVersion": 1001 - }, - "kind": "Package", - "canonicalReference": "daf-typeorm!", - "docComment": "/**\n * {@link https://typeorm.io/ | TypeORM} backed plugins. {@link daf-core#Agent} {@link daf-typeorm#DataStore | plugin} that implements {@link daf-core#IDataStore} interface. {@link daf-core#Agent} {@link daf-typeorm#DataStoreORM | plugin} that implements {@link daf-typeorm#IDataStoreORM} interface. Provides {@link daf-typeorm#KeyStore} for {@link daf-key-manager#KeyManager} and {@link daf-typeorm#IdentityStore} for {@link daf-identity-manager#IdentityManager}\n *\n * @packageDocumentation\n */\n", - "name": "daf-typeorm", - "members": [ - { - "kind": "EntryPoint", - "canonicalReference": "daf-typeorm!", - "name": "", - "members": [ - { - "kind": "Class", - "canonicalReference": "daf-typeorm!Claim:class", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class Claim extends " - }, - { - "kind": "Reference", - "text": "BaseEntity", - "canonicalReference": "typeorm!BaseEntity:class" - }, - { - "kind": "Content", - "text": " " - } - ], - "releaseTag": "Public", - "name": "Claim", - "members": [ - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Claim#context:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "context: " - }, - { - "kind": "Content", - "text": "string[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "context", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Claim#credential:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "credential: " - }, - { - "kind": "Reference", - "text": "Credential", - "canonicalReference": "daf-typeorm!Credential:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "credential", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Claim#credentialType:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "credentialType: " - }, - { - "kind": "Content", - "text": "string[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "credentialType", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Claim#expirationDate:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "expirationDate?: " - }, - { - "kind": "Reference", - "text": "Date", - "canonicalReference": "!Date:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "expirationDate", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Claim#hash:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "hash: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "hash", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Claim#isObj:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "isObj: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "isObj", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Claim#issuanceDate:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "issuanceDate: " - }, - { - "kind": "Reference", - "text": "Date", - "canonicalReference": "!Date:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "issuanceDate", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Claim#issuer:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "issuer: " - }, - { - "kind": "Reference", - "text": "Identity", - "canonicalReference": "daf-typeorm!Identity:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "issuer", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Claim#subject:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "subject?: " - }, - { - "kind": "Reference", - "text": "Identity", - "canonicalReference": "daf-typeorm!Identity:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "subject", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Claim#type:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "type: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "type", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Claim#value:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "value: " - }, - { - "kind": "Content", - "text": "string | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "value", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - } - ], - "extendsTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "implementsTokenRanges": [] - }, - { - "kind": "Class", - "canonicalReference": "daf-typeorm!Credential_2:class", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class Credential extends " - }, - { - "kind": "Reference", - "text": "BaseEntity", - "canonicalReference": "typeorm!BaseEntity:class" - }, - { - "kind": "Content", - "text": " " - } - ], - "releaseTag": "Public", - "name": "Credential_2", - "members": [ - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Credential_2#claims:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "claims: " - }, - { - "kind": "Reference", - "text": "Claim", - "canonicalReference": "daf-typeorm!Claim:class" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "claims", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Credential_2#context:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "context: " - }, - { - "kind": "Content", - "text": "string[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "context", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Credential_2#expirationDate:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "expirationDate?: " - }, - { - "kind": "Reference", - "text": "Date", - "canonicalReference": "!Date:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "expirationDate", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Credential_2#hash:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "hash: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "hash", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Credential_2#id:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "id?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Credential_2#issuanceDate:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "issuanceDate: " - }, - { - "kind": "Reference", - "text": "Date", - "canonicalReference": "!Date:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "issuanceDate", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Credential_2#issuer:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "issuer: " - }, - { - "kind": "Reference", - "text": "Identity", - "canonicalReference": "daf-typeorm!Identity:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "issuer", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Credential_2#messages:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "messages: " - }, - { - "kind": "Reference", - "text": "Message", - "canonicalReference": "daf-typeorm!Message:class" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "messages", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Credential_2#presentations:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "presentations: " - }, - { - "kind": "Reference", - "text": "Presentation", - "canonicalReference": "daf-typeorm!Presentation:class" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "presentations", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Credential_2#raw:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "get raw(): " - }, - { - "kind": "Reference", - "text": "VerifiableCredential", - "canonicalReference": "daf-core!VerifiableCredential:interface" - }, - { - "kind": "Content", - "text": ";" - }, - { - "kind": "Content", - "text": "\n\nset raw(raw: " - }, - { - "kind": "Reference", - "text": "VerifiableCredential", - "canonicalReference": "daf-core!VerifiableCredential:interface" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "name": "raw", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Credential_2#subject:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "subject?: " - }, - { - "kind": "Reference", - "text": "Identity", - "canonicalReference": "daf-typeorm!Identity:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "subject", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Credential_2#type:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "type: " - }, - { - "kind": "Content", - "text": "string[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "type", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - } - ], - "extendsTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "implementsTokenRanges": [] - }, - { - "kind": "Class", - "canonicalReference": "daf-typeorm!DataStore:class", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class DataStore implements " - }, - { - "kind": "Reference", - "text": "IAgentPlugin", - "canonicalReference": "daf-core!IAgentPlugin:interface" - }, - { - "kind": "Content", - "text": " " - } - ], - "releaseTag": "Public", - "name": "DataStore", - "members": [ - { - "kind": "Constructor", - "canonicalReference": "daf-typeorm!DataStore:constructor(1)", - "docComment": "/**\n * Constructs a new instance of the `DataStore` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(dbConnection: " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Connection", - "canonicalReference": "typeorm!Connection:class" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "dbConnection", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - } - ] - }, - { - "kind": "Method", - "canonicalReference": "daf-typeorm!DataStore#dataStoreGetMessage:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "dataStoreGetMessage(args: " - }, - { - "kind": "Reference", - "text": "IDataStoreGetMessageArgs", - "canonicalReference": "daf-core!IDataStoreGetMessageArgs:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "IMessage", - "canonicalReference": "daf-core!IMessage:interface" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "dataStoreGetMessage" - }, - { - "kind": "Method", - "canonicalReference": "daf-typeorm!DataStore#dataStoreGetVerifiableCredential:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "dataStoreGetVerifiableCredential(args: " - }, - { - "kind": "Reference", - "text": "IDataStoreGetVerifiableCredentialArgs", - "canonicalReference": "daf-core!IDataStoreGetVerifiableCredentialArgs:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "VerifiableCredential", - "canonicalReference": "daf-core!VerifiableCredential:interface" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "dataStoreGetVerifiableCredential" - }, - { - "kind": "Method", - "canonicalReference": "daf-typeorm!DataStore#dataStoreGetVerifiablePresentation:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "dataStoreGetVerifiablePresentation(args: " - }, - { - "kind": "Reference", - "text": "IDataStoreGetVerifiablePresentationArgs", - "canonicalReference": "daf-core!IDataStoreGetVerifiablePresentationArgs:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "VerifiablePresentation", - "canonicalReference": "daf-core!VerifiablePresentation:interface" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "dataStoreGetVerifiablePresentation" - }, - { - "kind": "Method", - "canonicalReference": "daf-typeorm!DataStore#dataStoreSaveMessage:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "dataStoreSaveMessage(args: " - }, - { - "kind": "Reference", - "text": "IDataStoreSaveMessageArgs", - "canonicalReference": "daf-core!IDataStoreSaveMessageArgs:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "dataStoreSaveMessage" - }, - { - "kind": "Method", - "canonicalReference": "daf-typeorm!DataStore#dataStoreSaveVerifiableCredential:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "dataStoreSaveVerifiableCredential(args: " - }, - { - "kind": "Reference", - "text": "IDataStoreSaveVerifiableCredentialArgs", - "canonicalReference": "daf-core!IDataStoreSaveVerifiableCredentialArgs:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "dataStoreSaveVerifiableCredential" - }, - { - "kind": "Method", - "canonicalReference": "daf-typeorm!DataStore#dataStoreSaveVerifiablePresentation:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "dataStoreSaveVerifiablePresentation(args: " - }, - { - "kind": "Reference", - "text": "IDataStoreSaveVerifiablePresentationArgs", - "canonicalReference": "daf-core!IDataStoreSaveVerifiablePresentationArgs:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "dataStoreSaveVerifiablePresentation" - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!DataStore#methods:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly methods: " - }, - { - "kind": "Reference", - "text": "IDataStore", - "canonicalReference": "daf-core!IDataStore:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "methods", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!DataStore#schema:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly schema: " - }, - { - "kind": "Content", - "text": "{\n components: {\n schemas: {\n IDataStoreGetMessageArgs: {\n type: string;\n properties: {\n id: {\n type: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n IMessage: {\n type: string;\n properties: {\n id: {\n type: string;\n description: string;\n };\n type: {\n type: string;\n description: string;\n };\n createdAt: {\n type: string;\n description: string;\n };\n expiresAt: {\n type: string;\n description: string;\n };\n threadId: {\n type: string;\n description: string;\n };\n raw: {\n type: string;\n description: string;\n };\n data: {\n anyOf: {\n type: string;\n }[];\n description: string;\n };\n replyTo: {\n type: string;\n items: {\n type: string;\n };\n description: string;\n };\n replyUrl: {\n type: string;\n description: string;\n };\n from: {\n type: string;\n description: string;\n };\n to: {\n type: string;\n description: string;\n };\n metaData: {\n anyOf: ({\n type: string;\n items: {\n $ref: string;\n };\n } | {\n type: string;\n items?: undefined;\n })[];\n description: string;\n };\n credentials: {\n type: string;\n items: {\n $ref: string;\n };\n description: string;\n };\n presentations: {\n type: string;\n items: {\n $ref: string;\n };\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n IMetaData: {\n type: string;\n properties: {\n type: {\n type: string;\n description: string;\n };\n value: {\n type: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n VerifiableCredential: {\n type: string;\n properties: {\n \"@context\": {\n type: string;\n items: {\n type: string;\n };\n };\n id: {\n type: string;\n };\n type: {\n type: string;\n items: {\n type: string;\n };\n };\n issuer: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n };\n required: string[];\n };\n issuanceDate: {\n type: string;\n };\n expirationDate: {\n type: string;\n };\n credentialSubject: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n };\n };\n credentialStatus: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n type: {\n type: string;\n };\n };\n required: string[];\n };\n proof: {\n type: string;\n properties: {\n type: {\n type: string;\n };\n };\n };\n };\n required: string[];\n description: string;\n };\n VerifiablePresentation: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n holder: {\n type: string;\n };\n issuanceDate: {\n type: string;\n };\n expirationDate: {\n type: string;\n };\n \"@context\": {\n type: string;\n items: {\n type: string;\n };\n };\n type: {\n type: string;\n items: {\n type: string;\n };\n };\n verifier: {\n type: string;\n items: {\n type: string;\n };\n };\n verifiableCredential: {\n type: string;\n items: {\n $ref: string;\n };\n };\n proof: {\n type: string;\n properties: {\n type: {\n type: string;\n };\n };\n };\n };\n required: string[];\n description: string;\n };\n IDataStoreGetVerifiableCredentialArgs: {\n type: string;\n properties: {\n hash: {\n type: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n IDataStoreGetVerifiablePresentationArgs: {\n type: string;\n properties: {\n hash: {\n type: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n IDataStoreSaveMessageArgs: {\n type: string;\n properties: {\n message: {\n $ref: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n IDataStoreSaveVerifiableCredentialArgs: {\n type: string;\n properties: {\n verifiableCredential: {\n $ref: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n IDataStoreSaveVerifiablePresentationArgs: {\n type: string;\n properties: {\n verifiablePresentation: {\n $ref: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n };\n methods: {\n dataStoreGetMessage: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n $ref: string;\n };\n };\n dataStoreGetVerifiableCredential: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n $ref: string;\n };\n };\n dataStoreGetVerifiablePresentation: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n $ref: string;\n };\n };\n dataStoreSaveMessage: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n type: string;\n };\n };\n dataStoreSaveVerifiableCredential: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n type: string;\n };\n };\n dataStoreSaveVerifiablePresentation: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n type: string;\n };\n };\n };\n };\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "schema", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - } - ], - "implementsTokenRanges": [ - { - "startIndex": 1, - "endIndex": 3 - } - ] - }, - { - "kind": "Class", - "canonicalReference": "daf-typeorm!DataStoreORM:class", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class DataStoreORM implements " - }, - { - "kind": "Reference", - "text": "IAgentPlugin", - "canonicalReference": "daf-core!IAgentPlugin:interface" - }, - { - "kind": "Content", - "text": " " - } - ], - "releaseTag": "Public", - "name": "DataStoreORM", - "members": [ - { - "kind": "Constructor", - "canonicalReference": "daf-typeorm!DataStoreORM:constructor(1)", - "docComment": "/**\n * Constructs a new instance of the `DataStoreORM` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(dbConnection: " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Connection", - "canonicalReference": "typeorm!Connection:class" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "dbConnection", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - } - ] - }, - { - "kind": "Method", - "canonicalReference": "daf-typeorm!DataStoreORM#dataStoreORMGetIdentities:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "dataStoreORMGetIdentities(args: " - }, - { - "kind": "Reference", - "text": "FindArgs", - "canonicalReference": "daf-typeorm!FindArgs:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "TIdentitiesColumns", - "canonicalReference": "daf-typeorm!TIdentitiesColumns:type" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "IContext", - "canonicalReference": "daf-typeorm!~IContext:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "PartialIdentity", - "canonicalReference": "daf-typeorm!PartialIdentity:type" - }, - { - "kind": "Content", - "text": "[]>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 8, - "endIndex": 12 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 - } - } - ], - "name": "dataStoreORMGetIdentities" - }, - { - "kind": "Method", - "canonicalReference": "daf-typeorm!DataStoreORM#dataStoreORMGetIdentitiesCount:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "dataStoreORMGetIdentitiesCount(args: " - }, - { - "kind": "Reference", - "text": "FindArgs", - "canonicalReference": "daf-typeorm!FindArgs:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "TIdentitiesColumns", - "canonicalReference": "daf-typeorm!TIdentitiesColumns:type" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "IContext", - "canonicalReference": "daf-typeorm!~IContext:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 8, - "endIndex": 10 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 - } - } - ], - "name": "dataStoreORMGetIdentitiesCount" - }, - { - "kind": "Method", - "canonicalReference": "daf-typeorm!DataStoreORM#dataStoreORMGetMessages:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "dataStoreORMGetMessages(args: " - }, - { - "kind": "Reference", - "text": "FindArgs", - "canonicalReference": "daf-typeorm!FindArgs:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "TMessageColumns", - "canonicalReference": "daf-typeorm!TMessageColumns:type" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "IContext", - "canonicalReference": "daf-typeorm!~IContext:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "IMessage", - "canonicalReference": "daf-core!IMessage:interface" - }, - { - "kind": "Content", - "text": "[]>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 8, - "endIndex": 12 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 - } - } - ], - "name": "dataStoreORMGetMessages" - }, - { - "kind": "Method", - "canonicalReference": "daf-typeorm!DataStoreORM#dataStoreORMGetMessagesCount:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "dataStoreORMGetMessagesCount(args: " - }, - { - "kind": "Reference", - "text": "FindArgs", - "canonicalReference": "daf-typeorm!FindArgs:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "TMessageColumns", - "canonicalReference": "daf-typeorm!TMessageColumns:type" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "IContext", - "canonicalReference": "daf-typeorm!~IContext:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 8, - "endIndex": 10 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 - } - } - ], - "name": "dataStoreORMGetMessagesCount" - }, - { - "kind": "Method", - "canonicalReference": "daf-typeorm!DataStoreORM#dataStoreORMGetVerifiableCredentials:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "dataStoreORMGetVerifiableCredentials(args: " - }, - { - "kind": "Reference", - "text": "FindArgs", - "canonicalReference": "daf-typeorm!FindArgs:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "TCredentialColumns", - "canonicalReference": "daf-typeorm!TCredentialColumns:type" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "IContext", - "canonicalReference": "daf-typeorm!~IContext:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Array", - "canonicalReference": "!Array:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "UniqueVerifiableCredential", - "canonicalReference": "daf-typeorm!UniqueVerifiableCredential:interface" - }, - { - "kind": "Content", - "text": ">>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 8, - "endIndex": 14 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 - } - } - ], - "name": "dataStoreORMGetVerifiableCredentials" - }, - { - "kind": "Method", - "canonicalReference": "daf-typeorm!DataStoreORM#dataStoreORMGetVerifiableCredentialsByClaims:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "dataStoreORMGetVerifiableCredentialsByClaims(args: " - }, - { - "kind": "Reference", - "text": "FindArgs", - "canonicalReference": "daf-typeorm!FindArgs:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "TClaimsColumns", - "canonicalReference": "daf-typeorm!TClaimsColumns:type" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "IContext", - "canonicalReference": "daf-typeorm!~IContext:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Array", - "canonicalReference": "!Array:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "UniqueVerifiableCredential", - "canonicalReference": "daf-typeorm!UniqueVerifiableCredential:interface" - }, - { - "kind": "Content", - "text": ">>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 8, - "endIndex": 14 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 - } - } - ], - "name": "dataStoreORMGetVerifiableCredentialsByClaims" - }, - { - "kind": "Method", - "canonicalReference": "daf-typeorm!DataStoreORM#dataStoreORMGetVerifiableCredentialsByClaimsCount:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "dataStoreORMGetVerifiableCredentialsByClaimsCount(args: " - }, - { - "kind": "Reference", - "text": "FindArgs", - "canonicalReference": "daf-typeorm!FindArgs:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "TClaimsColumns", - "canonicalReference": "daf-typeorm!TClaimsColumns:type" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "IContext", - "canonicalReference": "daf-typeorm!~IContext:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 8, - "endIndex": 10 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 - } - } - ], - "name": "dataStoreORMGetVerifiableCredentialsByClaimsCount" - }, - { - "kind": "Method", - "canonicalReference": "daf-typeorm!DataStoreORM#dataStoreORMGetVerifiableCredentialsCount:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "dataStoreORMGetVerifiableCredentialsCount(args: " - }, - { - "kind": "Reference", - "text": "FindArgs", - "canonicalReference": "daf-typeorm!FindArgs:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "TCredentialColumns", - "canonicalReference": "daf-typeorm!TCredentialColumns:type" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "IContext", - "canonicalReference": "daf-typeorm!~IContext:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 8, - "endIndex": 10 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 - } - } - ], - "name": "dataStoreORMGetVerifiableCredentialsCount" - }, - { - "kind": "Method", - "canonicalReference": "daf-typeorm!DataStoreORM#dataStoreORMGetVerifiablePresentations:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "dataStoreORMGetVerifiablePresentations(args: " - }, - { - "kind": "Reference", - "text": "FindArgs", - "canonicalReference": "daf-typeorm!FindArgs:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "TPresentationColumns", - "canonicalReference": "daf-typeorm!TPresentationColumns:type" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "IContext", - "canonicalReference": "daf-typeorm!~IContext:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Array", - "canonicalReference": "!Array:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "UniqueVerifiablePresentation", - "canonicalReference": "daf-typeorm!UniqueVerifiablePresentation:interface" - }, - { - "kind": "Content", - "text": ">>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 8, - "endIndex": 14 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 - } - } - ], - "name": "dataStoreORMGetVerifiablePresentations" - }, - { - "kind": "Method", - "canonicalReference": "daf-typeorm!DataStoreORM#dataStoreORMGetVerifiablePresentationsCount:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "dataStoreORMGetVerifiablePresentationsCount(args: " - }, - { - "kind": "Reference", - "text": "FindArgs", - "canonicalReference": "daf-typeorm!FindArgs:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "TPresentationColumns", - "canonicalReference": "daf-typeorm!TPresentationColumns:type" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "IContext", - "canonicalReference": "daf-typeorm!~IContext:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 8, - "endIndex": 10 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 - } - } - ], - "name": "dataStoreORMGetVerifiablePresentationsCount" - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!DataStoreORM#methods:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly methods: " - }, - { - "kind": "Reference", - "text": "IDataStoreORM", - "canonicalReference": "daf-typeorm!IDataStoreORM:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "methods", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!DataStoreORM#schema:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly schema: " - }, - { - "kind": "Content", - "text": "{\n components: {\n schemas: {\n FindIdentitiesArgs: {\n $ref: string;\n };\n \"FindArgs-TIdentitiesColumns\": {\n type: string;\n properties: {\n where: {\n type: string;\n items: {\n $ref: string;\n };\n };\n order: {\n type: string;\n items: {\n $ref: string;\n };\n };\n take: {\n type: string;\n };\n skip: {\n type: string;\n };\n };\n };\n \"Where-TIdentitiesColumns\": {\n type: string;\n properties: {\n column: {\n $ref: string;\n };\n value: {\n type: string;\n items: {\n type: string;\n };\n };\n not: {\n type: string;\n };\n op: {\n type: string;\n enum: string[];\n };\n };\n required: string[];\n };\n TIdentitiesColumns: {\n type: string;\n enum: string[];\n };\n \"Order-TIdentitiesColumns\": {\n type: string;\n properties: {\n column: {\n $ref: string;\n };\n direction: {\n type: string;\n enum: string[];\n };\n };\n required: string[];\n };\n PartialIdentity: {\n type: string;\n properties: {\n did: {\n type: string;\n description: string;\n };\n alias: {\n type: string;\n description: string;\n };\n provider: {\n type: string;\n description: string;\n };\n controllerKeyId: {\n type: string;\n description: string;\n };\n keys: {\n type: string;\n items: {\n $ref: string;\n };\n description: string;\n };\n services: {\n type: string;\n items: {\n $ref: string;\n };\n description: string;\n };\n };\n };\n IKey: {\n type: string;\n properties: {\n kid: {\n type: string;\n description: string;\n };\n kms: {\n type: string;\n description: string;\n };\n type: {\n $ref: string;\n description: string;\n };\n publicKeyHex: {\n type: string;\n description: string;\n };\n privateKeyHex: {\n type: string;\n description: string;\n };\n meta: {\n anyOf: {\n type: string;\n }[];\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n TKeyType: {\n type: string;\n enum: string[];\n description: string;\n };\n IService: {\n type: string;\n properties: {\n id: {\n type: string;\n description: string;\n };\n type: {\n type: string;\n description: string;\n };\n serviceEndpoint: {\n type: string;\n description: string;\n };\n description: {\n type: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n FindMessagesArgs: {\n $ref: string;\n };\n \"FindArgs-TMessageColumns\": {\n type: string;\n properties: {\n where: {\n type: string;\n items: {\n $ref: string;\n };\n };\n order: {\n type: string;\n items: {\n $ref: string;\n };\n };\n take: {\n type: string;\n };\n skip: {\n type: string;\n };\n };\n };\n \"Where-TMessageColumns\": {\n type: string;\n properties: {\n column: {\n $ref: string;\n };\n value: {\n type: string;\n items: {\n type: string;\n };\n };\n not: {\n type: string;\n };\n op: {\n type: string;\n enum: string[];\n };\n };\n required: string[];\n };\n TMessageColumns: {\n type: string;\n enum: string[];\n };\n \"Order-TMessageColumns\": {\n type: string;\n properties: {\n column: {\n $ref: string;\n };\n direction: {\n type: string;\n enum: string[];\n };\n };\n required: string[];\n };\n IMessage: {\n type: string;\n properties: {\n id: {\n type: string;\n description: string;\n };\n type: {\n type: string;\n description: string;\n };\n createdAt: {\n type: string;\n description: string;\n };\n expiresAt: {\n type: string;\n description: string;\n };\n threadId: {\n type: string;\n description: string;\n };\n raw: {\n type: string;\n description: string;\n };\n data: {\n anyOf: {\n type: string;\n }[];\n description: string;\n };\n replyTo: {\n type: string;\n items: {\n type: string;\n };\n description: string;\n };\n replyUrl: {\n type: string;\n description: string;\n };\n from: {\n type: string;\n description: string;\n };\n to: {\n type: string;\n description: string;\n };\n metaData: {\n anyOf: ({\n type: string;\n items: {\n $ref: string;\n };\n } | {\n type: string;\n items?: undefined;\n })[];\n description: string;\n };\n credentials: {\n type: string;\n items: {\n $ref: string;\n };\n description: string;\n };\n presentations: {\n type: string;\n items: {\n $ref: string;\n };\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n IMetaData: {\n type: string;\n properties: {\n type: {\n type: string;\n description: string;\n };\n value: {\n type: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n VerifiableCredential: {\n type: string;\n properties: {\n \"@context\": {\n type: string;\n items: {\n type: string;\n };\n };\n id: {\n type: string;\n };\n type: {\n type: string;\n items: {\n type: string;\n };\n };\n issuer: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n };\n required: string[];\n };\n issuanceDate: {\n type: string;\n };\n expirationDate: {\n type: string;\n };\n credentialSubject: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n };\n };\n credentialStatus: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n type: {\n type: string;\n };\n };\n required: string[];\n };\n proof: {\n type: string;\n properties: {\n type: {\n type: string;\n };\n };\n };\n };\n required: string[];\n description: string;\n };\n VerifiablePresentation: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n holder: {\n type: string;\n };\n issuanceDate: {\n type: string;\n };\n expirationDate: {\n type: string;\n };\n \"@context\": {\n type: string;\n items: {\n type: string;\n };\n };\n type: {\n type: string;\n items: {\n type: string;\n };\n };\n verifier: {\n type: string;\n items: {\n type: string;\n };\n };\n verifiableCredential: {\n type: string;\n items: {\n $ref: string;\n };\n };\n proof: {\n type: string;\n properties: {\n type: {\n type: string;\n };\n };\n };\n };\n required: string[];\n description: string;\n };\n FindCredentialsArgs: {\n $ref: string;\n };\n \"FindArgs-TCredentialColumns\": {\n type: string;\n properties: {\n where: {\n type: string;\n items: {\n $ref: string;\n };\n };\n order: {\n type: string;\n items: {\n $ref: string;\n };\n };\n take: {\n type: string;\n };\n skip: {\n type: string;\n };\n };\n };\n \"Where-TCredentialColumns\": {\n type: string;\n properties: {\n column: {\n $ref: string;\n };\n value: {\n type: string;\n items: {\n type: string;\n };\n };\n not: {\n type: string;\n };\n op: {\n type: string;\n enum: string[];\n };\n };\n required: string[];\n };\n TCredentialColumns: {\n type: string;\n enum: string[];\n };\n \"Order-TCredentialColumns\": {\n type: string;\n properties: {\n column: {\n $ref: string;\n };\n direction: {\n type: string;\n enum: string[];\n };\n };\n required: string[];\n };\n UniqueVerifiableCredential: {\n type: string;\n properties: {\n hash: {\n type: string;\n };\n verifiableCredential: {\n $ref: string;\n };\n };\n required: string[];\n };\n FindClaimsArgs: {\n $ref: string;\n };\n \"FindArgs-TClaimsColumns\": {\n type: string;\n properties: {\n where: {\n type: string;\n items: {\n $ref: string;\n };\n };\n order: {\n type: string;\n items: {\n $ref: string;\n };\n };\n take: {\n type: string;\n };\n skip: {\n type: string;\n };\n };\n };\n \"Where-TClaimsColumns\": {\n type: string;\n properties: {\n column: {\n $ref: string;\n };\n value: {\n type: string;\n items: {\n type: string;\n };\n };\n not: {\n type: string;\n };\n op: {\n type: string;\n enum: string[];\n };\n };\n required: string[];\n };\n TClaimsColumns: {\n type: string;\n enum: string[];\n };\n \"Order-TClaimsColumns\": {\n type: string;\n properties: {\n column: {\n $ref: string;\n };\n direction: {\n type: string;\n enum: string[];\n };\n };\n required: string[];\n };\n FindPresentationsArgs: {\n $ref: string;\n };\n \"FindArgs-TPresentationColumns\": {\n type: string;\n properties: {\n where: {\n type: string;\n items: {\n $ref: string;\n };\n };\n order: {\n type: string;\n items: {\n $ref: string;\n };\n };\n take: {\n type: string;\n };\n skip: {\n type: string;\n };\n };\n };\n \"Where-TPresentationColumns\": {\n type: string;\n properties: {\n column: {\n $ref: string;\n };\n value: {\n type: string;\n items: {\n type: string;\n };\n };\n not: {\n type: string;\n };\n op: {\n type: string;\n enum: string[];\n };\n };\n required: string[];\n };\n TPresentationColumns: {\n type: string;\n enum: string[];\n };\n \"Order-TPresentationColumns\": {\n type: string;\n properties: {\n column: {\n $ref: string;\n };\n direction: {\n type: string;\n enum: string[];\n };\n };\n required: string[];\n };\n UniqueVerifiablePresentation: {\n type: string;\n properties: {\n hash: {\n type: string;\n };\n verifiablePresentation: {\n $ref: string;\n };\n };\n required: string[];\n };\n };\n methods: {\n dataStoreORMGetIdentities: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n type: string;\n items: {\n $ref: string;\n };\n };\n };\n dataStoreORMGetIdentitiesCount: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n type: string;\n };\n };\n dataStoreORMGetMessages: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n type: string;\n items: {\n $ref: string;\n };\n };\n };\n dataStoreORMGetMessagesCount: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n type: string;\n };\n };\n dataStoreORMGetVerifiableCredentials: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n type: string;\n items: {\n $ref: string;\n };\n };\n };\n dataStoreORMGetVerifiableCredentialsByClaims: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n type: string;\n items: {\n $ref: string;\n };\n };\n };\n dataStoreORMGetVerifiableCredentialsByClaimsCount: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n type: string;\n };\n };\n dataStoreORMGetVerifiableCredentialsCount: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n type: string;\n };\n };\n dataStoreORMGetVerifiablePresentations: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n type: string;\n items: {\n $ref: string;\n };\n };\n };\n dataStoreORMGetVerifiablePresentationsCount: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n type: string;\n };\n };\n };\n };\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "schema", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - } - ], - "implementsTokenRanges": [ - { - "startIndex": 1, - "endIndex": 3 - } - ] - }, - { - "kind": "Variable", - "canonicalReference": "daf-typeorm!Entities:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "Entities: " - }, - { - "kind": "Content", - "text": "(typeof " - }, - { - "kind": "Reference", - "text": "Key", - "canonicalReference": "daf-typeorm!Key:class" - }, - { - "kind": "Content", - "text": " | typeof " - }, - { - "kind": "Reference", - "text": "Identity", - "canonicalReference": "daf-typeorm!Identity:class" - }, - { - "kind": "Content", - "text": " | typeof " - }, - { - "kind": "Reference", - "text": "Service", - "canonicalReference": "daf-typeorm!Service:class" - }, - { - "kind": "Content", - "text": " | typeof " - }, - { - "kind": "Reference", - "text": "Claim", - "canonicalReference": "daf-typeorm!Claim:class" - }, - { - "kind": "Content", - "text": " | typeof " - }, - { - "kind": "Reference", - "text": "Credential", - "canonicalReference": "daf-typeorm!Credential:class" - }, - { - "kind": "Content", - "text": " | typeof " - }, - { - "kind": "Reference", - "text": "Presentation", - "canonicalReference": "daf-typeorm!Presentation:class" - }, - { - "kind": "Content", - "text": " | typeof " - }, - { - "kind": "Reference", - "text": "Message", - "canonicalReference": "daf-typeorm!Message:class" - }, - { - "kind": "Content", - "text": ")[]" - } - ], - "releaseTag": "Public", - "name": "Entities", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 16 - } - }, - { - "kind": "Interface", - "canonicalReference": "daf-typeorm!FindArgs:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface FindArgs " - } - ], - "releaseTag": "Public", - "typeParameters": [ - { - "typeParameterName": "TColumns", - "constraintTokenRange": { - "startIndex": 0, - "endIndex": 0 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "name": "FindArgs", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "daf-typeorm!FindArgs#order:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "order?: " - }, - { - "kind": "Reference", - "text": "Order", - "canonicalReference": "daf-typeorm!Order:interface" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "order", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "daf-typeorm!FindArgs#skip:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "skip?: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "skip", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "daf-typeorm!FindArgs#take:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "take?: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "take", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "daf-typeorm!FindArgs#where:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "where?: " - }, - { - "kind": "Reference", - "text": "Where", - "canonicalReference": "daf-typeorm!Where:interface" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "where", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "daf-typeorm!FindClaimsArgs:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type FindClaimsArgs = " - }, - { - "kind": "Reference", - "text": "FindArgs", - "canonicalReference": "daf-typeorm!FindArgs:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "TClaimsColumns", - "canonicalReference": "daf-typeorm!TClaimsColumns:type" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "FindClaimsArgs", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "daf-typeorm!FindCredentialsArgs:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type FindCredentialsArgs = " - }, - { - "kind": "Reference", - "text": "FindArgs", - "canonicalReference": "daf-typeorm!FindArgs:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "TCredentialColumns", - "canonicalReference": "daf-typeorm!TCredentialColumns:type" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "FindCredentialsArgs", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "daf-typeorm!FindIdentitiesArgs:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type FindIdentitiesArgs = " - }, - { - "kind": "Reference", - "text": "FindArgs", - "canonicalReference": "daf-typeorm!FindArgs:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "TIdentitiesColumns", - "canonicalReference": "daf-typeorm!TIdentitiesColumns:type" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "FindIdentitiesArgs", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "daf-typeorm!FindMessagesArgs:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type FindMessagesArgs = " - }, - { - "kind": "Reference", - "text": "FindArgs", - "canonicalReference": "daf-typeorm!FindArgs:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "TMessageColumns", - "canonicalReference": "daf-typeorm!TMessageColumns:type" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "FindMessagesArgs", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "daf-typeorm!FindPresentationsArgs:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type FindPresentationsArgs = " - }, - { - "kind": "Reference", - "text": "FindArgs", - "canonicalReference": "daf-typeorm!FindArgs:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "TPresentationColumns", - "canonicalReference": "daf-typeorm!TPresentationColumns:type" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "FindPresentationsArgs", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "kind": "Interface", - "canonicalReference": "daf-typeorm!IDataStoreORM:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface IDataStoreORM extends " - }, - { - "kind": "Reference", - "text": "IPluginMethodMap", - "canonicalReference": "daf-core!IPluginMethodMap:interface" - }, - { - "kind": "Content", - "text": " " - } - ], - "releaseTag": "Public", - "name": "IDataStoreORM", - "members": [ - { - "kind": "MethodSignature", - "canonicalReference": "daf-typeorm!IDataStoreORM#dataStoreORMGetIdentities:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "dataStoreORMGetIdentities(args: " - }, - { - "kind": "Reference", - "text": "FindIdentitiesArgs", - "canonicalReference": "daf-typeorm!FindIdentitiesArgs:type" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "IContext", - "canonicalReference": "daf-typeorm!~IContext:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Array", - "canonicalReference": "!Array:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "PartialIdentity", - "canonicalReference": "daf-typeorm!PartialIdentity:type" - }, - { - "kind": "Content", - "text": ">>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 11 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "name": "dataStoreORMGetIdentities" - }, - { - "kind": "MethodSignature", - "canonicalReference": "daf-typeorm!IDataStoreORM#dataStoreORMGetIdentitiesCount:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "dataStoreORMGetIdentitiesCount(args: " - }, - { - "kind": "Reference", - "text": "FindIdentitiesArgs", - "canonicalReference": "daf-typeorm!FindIdentitiesArgs:type" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "IContext", - "canonicalReference": "daf-typeorm!~IContext:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 7 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "name": "dataStoreORMGetIdentitiesCount" - }, - { - "kind": "MethodSignature", - "canonicalReference": "daf-typeorm!IDataStoreORM#dataStoreORMGetMessages:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "dataStoreORMGetMessages(args: " - }, - { - "kind": "Reference", - "text": "FindMessagesArgs", - "canonicalReference": "daf-typeorm!FindMessagesArgs:type" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "IContext", - "canonicalReference": "daf-typeorm!~IContext:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Array", - "canonicalReference": "!Array:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "IMessage", - "canonicalReference": "daf-core!IMessage:interface" - }, - { - "kind": "Content", - "text": ">>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 11 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "name": "dataStoreORMGetMessages" - }, - { - "kind": "MethodSignature", - "canonicalReference": "daf-typeorm!IDataStoreORM#dataStoreORMGetMessagesCount:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "dataStoreORMGetMessagesCount(args: " - }, - { - "kind": "Reference", - "text": "FindMessagesArgs", - "canonicalReference": "daf-typeorm!FindMessagesArgs:type" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "IContext", - "canonicalReference": "daf-typeorm!~IContext:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 7 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "name": "dataStoreORMGetMessagesCount" - }, - { - "kind": "MethodSignature", - "canonicalReference": "daf-typeorm!IDataStoreORM#dataStoreORMGetVerifiableCredentials:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "dataStoreORMGetVerifiableCredentials(args: " - }, - { - "kind": "Reference", - "text": "FindCredentialsArgs", - "canonicalReference": "daf-typeorm!FindCredentialsArgs:type" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "IContext", - "canonicalReference": "daf-typeorm!~IContext:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Array", - "canonicalReference": "!Array:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "UniqueVerifiableCredential", - "canonicalReference": "daf-typeorm!UniqueVerifiableCredential:interface" - }, - { - "kind": "Content", - "text": ">>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 11 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "name": "dataStoreORMGetVerifiableCredentials" - }, - { - "kind": "MethodSignature", - "canonicalReference": "daf-typeorm!IDataStoreORM#dataStoreORMGetVerifiableCredentialsByClaims:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "dataStoreORMGetVerifiableCredentialsByClaims(args: " - }, - { - "kind": "Reference", - "text": "FindClaimsArgs", - "canonicalReference": "daf-typeorm!FindClaimsArgs:type" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "IContext", - "canonicalReference": "daf-typeorm!~IContext:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Array", - "canonicalReference": "!Array:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "UniqueVerifiableCredential", - "canonicalReference": "daf-typeorm!UniqueVerifiableCredential:interface" - }, - { - "kind": "Content", - "text": ">>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 11 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "name": "dataStoreORMGetVerifiableCredentialsByClaims" - }, - { - "kind": "MethodSignature", - "canonicalReference": "daf-typeorm!IDataStoreORM#dataStoreORMGetVerifiableCredentialsByClaimsCount:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "dataStoreORMGetVerifiableCredentialsByClaimsCount(args: " - }, - { - "kind": "Reference", - "text": "FindClaimsArgs", - "canonicalReference": "daf-typeorm!FindClaimsArgs:type" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "IContext", - "canonicalReference": "daf-typeorm!~IContext:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 7 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "name": "dataStoreORMGetVerifiableCredentialsByClaimsCount" - }, - { - "kind": "MethodSignature", - "canonicalReference": "daf-typeorm!IDataStoreORM#dataStoreORMGetVerifiableCredentialsCount:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "dataStoreORMGetVerifiableCredentialsCount(args: " - }, - { - "kind": "Reference", - "text": "FindCredentialsArgs", - "canonicalReference": "daf-typeorm!FindCredentialsArgs:type" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "IContext", - "canonicalReference": "daf-typeorm!~IContext:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 7 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "name": "dataStoreORMGetVerifiableCredentialsCount" - }, - { - "kind": "MethodSignature", - "canonicalReference": "daf-typeorm!IDataStoreORM#dataStoreORMGetVerifiablePresentations:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "dataStoreORMGetVerifiablePresentations(args: " - }, - { - "kind": "Reference", - "text": "FindPresentationsArgs", - "canonicalReference": "daf-typeorm!FindPresentationsArgs:type" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "IContext", - "canonicalReference": "daf-typeorm!~IContext:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Array", - "canonicalReference": "!Array:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "UniqueVerifiablePresentation", - "canonicalReference": "daf-typeorm!UniqueVerifiablePresentation:interface" - }, - { - "kind": "Content", - "text": ">>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 11 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "name": "dataStoreORMGetVerifiablePresentations" - }, - { - "kind": "MethodSignature", - "canonicalReference": "daf-typeorm!IDataStoreORM#dataStoreORMGetVerifiablePresentationsCount:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "dataStoreORMGetVerifiablePresentationsCount(args: " - }, - { - "kind": "Reference", - "text": "FindPresentationsArgs", - "canonicalReference": "daf-typeorm!FindPresentationsArgs:type" - }, - { - "kind": "Content", - "text": ", context: " - }, - { - "kind": "Reference", - "text": "IContext", - "canonicalReference": "daf-typeorm!~IContext:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 7 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "parameterName": "context", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "name": "dataStoreORMGetVerifiablePresentationsCount" - } - ], - "extendsTokenRanges": [ - { - "startIndex": 1, - "endIndex": 3 - } - ] - }, - { - "kind": "Class", - "canonicalReference": "daf-typeorm!Identity:class", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class Identity extends " - }, - { - "kind": "Reference", - "text": "BaseEntity", - "canonicalReference": "typeorm!BaseEntity:class" - }, - { - "kind": "Content", - "text": " " - } - ], - "releaseTag": "Public", - "name": "Identity", - "members": [ - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Identity#alias:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "alias?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "alias", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Identity#controllerKeyId:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "controllerKeyId: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "controllerKeyId", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Identity#did:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "did: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "did", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Method", - "canonicalReference": "daf-typeorm!Identity#getLatestClaimValue:member(1)", - "docComment": "/**\n * Convenience method\n *\n * const name = await identity.getLatestClaimValue({type: 'name'})\n *\n * @param where - \n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "getLatestClaimValue(dbConnection: " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Connection", - "canonicalReference": "typeorm!Connection:class" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ", where: " - }, - { - "kind": "Content", - "text": "{\n type: string;\n }" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 8, - "endIndex": 10 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "dbConnection", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "parameterName": "where", - "parameterTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 - } - } - ], - "name": "getLatestClaimValue" - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Identity#issuedClaims:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "issuedClaims: " - }, - { - "kind": "Reference", - "text": "Claim", - "canonicalReference": "daf-typeorm!Claim:class" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "issuedClaims", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Identity#issuedCredentials:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "issuedCredentials: " - }, - { - "kind": "Reference", - "text": "Credential", - "canonicalReference": "daf-typeorm!Credential:class" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "issuedCredentials", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Identity#issuedPresentations:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "issuedPresentations: " - }, - { - "kind": "Reference", - "text": "Presentation", - "canonicalReference": "daf-typeorm!Presentation:class" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "issuedPresentations", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Identity#keys:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "keys: " - }, - { - "kind": "Reference", - "text": "Key", - "canonicalReference": "daf-typeorm!Key:class" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "keys", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Identity#provider:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "provider: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "provider", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Identity#receivedClaims:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "receivedClaims: " - }, - { - "kind": "Reference", - "text": "Claim", - "canonicalReference": "daf-typeorm!Claim:class" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "receivedClaims", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Identity#receivedCredentials:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "receivedCredentials: " - }, - { - "kind": "Reference", - "text": "Credential", - "canonicalReference": "daf-typeorm!Credential:class" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "receivedCredentials", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Identity#receivedMessages:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "receivedMessages: " - }, - { - "kind": "Reference", - "text": "Message", - "canonicalReference": "daf-typeorm!Message:class" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "receivedMessages", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Identity#receivedPresentations:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "receivedPresentations: " - }, - { - "kind": "Reference", - "text": "Presentation", - "canonicalReference": "daf-typeorm!Presentation:class" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "receivedPresentations", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Identity#saveDate:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "saveDate: " - }, - { - "kind": "Reference", - "text": "Date", - "canonicalReference": "!Date:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "saveDate", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Identity#sentMessages:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "sentMessages: " - }, - { - "kind": "Reference", - "text": "Message", - "canonicalReference": "daf-typeorm!Message:class" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "sentMessages", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Identity#services:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "services: " - }, - { - "kind": "Reference", - "text": "Service", - "canonicalReference": "daf-typeorm!Service:class" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "services", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "isStatic": false - }, - { - "kind": "Method", - "canonicalReference": "daf-typeorm!Identity#shortDid:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "shortDid(): " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [], - "name": "shortDid" - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Identity#updateDate:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "updateDate: " - }, - { - "kind": "Reference", - "text": "Date", - "canonicalReference": "!Date:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "updateDate", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - } - ], - "extendsTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "implementsTokenRanges": [] - }, - { - "kind": "Class", - "canonicalReference": "daf-typeorm!IdentityStore:class", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class IdentityStore extends " - }, - { - "kind": "Reference", - "text": "AbstractIdentityStore", - "canonicalReference": "daf-identity-manager!AbstractIdentityStore:class" - }, - { - "kind": "Content", - "text": " " - } - ], - "releaseTag": "Public", - "name": "IdentityStore", - "members": [ - { - "kind": "Constructor", - "canonicalReference": "daf-typeorm!IdentityStore:constructor(1)", - "docComment": "/**\n * Constructs a new instance of the `IdentityStore` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(dbConnection: " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Connection", - "canonicalReference": "typeorm!Connection:class" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "dbConnection", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - } - ] - }, - { - "kind": "Method", - "canonicalReference": "daf-typeorm!IdentityStore#delete:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "delete({ did }: " - }, - { - "kind": "Content", - "text": "{\n did: string;\n }" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "{ did }", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "delete" - }, - { - "kind": "Method", - "canonicalReference": "daf-typeorm!IdentityStore#get:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "get({ did, alias, provider }: " - }, - { - "kind": "Content", - "text": "{\n did: string;\n alias: string;\n provider: string;\n }" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "IIdentity", - "canonicalReference": "daf-core!IIdentity:interface" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "{ did, alias, provider }", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "get" - }, - { - "kind": "Method", - "canonicalReference": "daf-typeorm!IdentityStore#import:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "import(args: " - }, - { - "kind": "Reference", - "text": "IIdentity", - "canonicalReference": "daf-core!IIdentity:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "import" - }, - { - "kind": "Method", - "canonicalReference": "daf-typeorm!IdentityStore#list:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "list(args: " - }, - { - "kind": "Content", - "text": "{\n alias?: string;\n provider?: string;\n }" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "IIdentity", - "canonicalReference": "daf-core!IIdentity:interface" - }, - { - "kind": "Content", - "text": "[]>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "list" - } - ], - "extendsTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "implementsTokenRanges": [] - }, - { - "kind": "Class", - "canonicalReference": "daf-typeorm!Key:class", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class Key extends " - }, - { - "kind": "Reference", - "text": "BaseEntity", - "canonicalReference": "typeorm!BaseEntity:class" - }, - { - "kind": "Content", - "text": " " - } - ], - "releaseTag": "Public", - "name": "Key", - "members": [ - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Key#identity:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "identity: " - }, - { - "kind": "Reference", - "text": "Identity", - "canonicalReference": "daf-typeorm!Identity:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "identity", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Key#kid:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "kid: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "kid", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Key#kms:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "kms: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "kms", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Key#meta:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "meta?: " - }, - { - "kind": "Content", - "text": "object | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "meta", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Key#privateKeyHex:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "privateKeyHex?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "privateKeyHex", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Key#publicKeyHex:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "publicKeyHex: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "publicKeyHex", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Key#type:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "type: " - }, - { - "kind": "Reference", - "text": "KeyType", - "canonicalReference": "daf-typeorm!KeyType:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "type", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - } - ], - "extendsTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "implementsTokenRanges": [] - }, - { - "kind": "Class", - "canonicalReference": "daf-typeorm!KeyStore:class", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class KeyStore extends " - }, - { - "kind": "Reference", - "text": "AbstractKeyStore", - "canonicalReference": "daf-key-manager!AbstractKeyStore:class" - }, - { - "kind": "Content", - "text": " " - } - ], - "releaseTag": "Public", - "name": "KeyStore", - "members": [ - { - "kind": "Constructor", - "canonicalReference": "daf-typeorm!KeyStore:constructor(1)", - "docComment": "/**\n * Constructs a new instance of the `KeyStore` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(dbConnection: " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Connection", - "canonicalReference": "typeorm!Connection:class" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ", secretBox?: " - }, - { - "kind": "Reference", - "text": "AbstractSecretBox", - "canonicalReference": "daf-key-manager!AbstractSecretBox:class" - }, - { - "kind": "Content", - "text": " | undefined" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "dbConnection", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "parameterName": "secretBox", - "parameterTypeTokenRange": { - "startIndex": 6, - "endIndex": 8 - } - } - ] - }, - { - "kind": "Method", - "canonicalReference": "daf-typeorm!KeyStore#delete:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "delete({ kid }: " - }, - { - "kind": "Content", - "text": "{\n kid: string;\n }" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "{ kid }", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "delete" - }, - { - "kind": "Method", - "canonicalReference": "daf-typeorm!KeyStore#get:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "get({ kid }: " - }, - { - "kind": "Content", - "text": "{\n kid: string;\n }" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "IKey", - "canonicalReference": "daf-core!IKey:interface" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 7 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "{ kid }", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "get" - }, - { - "kind": "Method", - "canonicalReference": "daf-typeorm!KeyStore#import:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "import(args: " - }, - { - "kind": "Reference", - "text": "IKey", - "canonicalReference": "daf-core!IKey:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "args", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "name": "import" - } - ], - "extendsTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "implementsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "daf-typeorm!KeyType_2:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type KeyType = " - }, - { - "kind": "Content", - "text": "'Ed25519' | 'Secp256k1'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "KeyType_2", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Class", - "canonicalReference": "daf-typeorm!Message:class", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class Message extends " - }, - { - "kind": "Reference", - "text": "BaseEntity", - "canonicalReference": "typeorm!BaseEntity:class" - }, - { - "kind": "Content", - "text": " " - } - ], - "releaseTag": "Public", - "name": "Message", - "members": [ - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Message#createdAt:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "createdAt?: " - }, - { - "kind": "Reference", - "text": "Date", - "canonicalReference": "!Date:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "createdAt", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Message#credentials:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "credentials: " - }, - { - "kind": "Reference", - "text": "Credential", - "canonicalReference": "daf-typeorm!Credential:class" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "credentials", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Message#data:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "data?: " - }, - { - "kind": "Content", - "text": "object | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "data", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Message#expiresAt:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "expiresAt?: " - }, - { - "kind": "Reference", - "text": "Date", - "canonicalReference": "!Date:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "expiresAt", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Message#from:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "from?: " - }, - { - "kind": "Reference", - "text": "Identity", - "canonicalReference": "daf-typeorm!Identity:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "from", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Message#id:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "id: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Message#metaData:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "metaData?: " - }, - { - "kind": "Reference", - "text": "MetaData", - "canonicalReference": "daf-typeorm!MetaData:interface" - }, - { - "kind": "Content", - "text": "[] | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "metaData", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Message#presentations:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "presentations: " - }, - { - "kind": "Reference", - "text": "Presentation", - "canonicalReference": "daf-typeorm!Presentation:class" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "presentations", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Message#raw:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "raw?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "raw", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Message#replyTo:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "replyTo?: " - }, - { - "kind": "Content", - "text": "string[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "replyTo", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Message#replyUrl:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "replyUrl?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "replyUrl", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Message#saveDate:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "saveDate: " - }, - { - "kind": "Reference", - "text": "Date", - "canonicalReference": "!Date:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "saveDate", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Method", - "canonicalReference": "daf-typeorm!Message#setId:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "setId(): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [], - "name": "setId" - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Message#threadId:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "threadId?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "threadId", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Message#to:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "to?: " - }, - { - "kind": "Reference", - "text": "Identity", - "canonicalReference": "daf-typeorm!Identity:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "to", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Message#type:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "type: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "type", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Message#updateDate:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "updateDate: " - }, - { - "kind": "Reference", - "text": "Date", - "canonicalReference": "!Date:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "updateDate", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - } - ], - "extendsTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "implementsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "daf-typeorm!MetaData:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface MetaData " - } - ], - "releaseTag": "Public", - "name": "MetaData", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "daf-typeorm!MetaData#type:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "type: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "type", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "daf-typeorm!MetaData#value:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "value?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "value", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Variable", - "canonicalReference": "daf-typeorm!migrations:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "migrations: " - }, - { - "kind": "Content", - "text": "never[]" - } - ], - "releaseTag": "Public", - "name": "migrations", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Interface", - "canonicalReference": "daf-typeorm!Order:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface Order " - } - ], - "releaseTag": "Public", - "typeParameters": [ - { - "typeParameterName": "TColumns", - "constraintTokenRange": { - "startIndex": 0, - "endIndex": 0 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "name": "Order", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "daf-typeorm!Order#column:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "column: " - }, - { - "kind": "Content", - "text": "TColumns" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "column", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "daf-typeorm!Order#direction:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "direction: " - }, - { - "kind": "Content", - "text": "'ASC' | 'DESC'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "direction", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Class", - "canonicalReference": "daf-typeorm!Presentation:class", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class Presentation extends " - }, - { - "kind": "Reference", - "text": "BaseEntity", - "canonicalReference": "typeorm!BaseEntity:class" - }, - { - "kind": "Content", - "text": " " - } - ], - "releaseTag": "Public", - "name": "Presentation", - "members": [ - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Presentation#context:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "context: " - }, - { - "kind": "Content", - "text": "string[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "context", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Presentation#credentials:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "credentials: " - }, - { - "kind": "Reference", - "text": "Credential", - "canonicalReference": "daf-typeorm!Credential:class" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "credentials", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Presentation#expirationDate:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "expirationDate?: " - }, - { - "kind": "Reference", - "text": "Date", - "canonicalReference": "!Date:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "expirationDate", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Presentation#hash:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "hash: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "hash", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Presentation#holder:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "holder: " - }, - { - "kind": "Reference", - "text": "Identity", - "canonicalReference": "daf-typeorm!Identity:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "holder", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Presentation#id:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "id?: " - }, - { - "kind": "Reference", - "text": "String", - "canonicalReference": "!String:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Presentation#issuanceDate:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "issuanceDate: " - }, - { - "kind": "Reference", - "text": "Date", - "canonicalReference": "!Date:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "issuanceDate", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Presentation#messages:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "messages: " - }, - { - "kind": "Reference", - "text": "Message", - "canonicalReference": "daf-typeorm!Message:class" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "messages", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Presentation#raw:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "get raw(): " - }, - { - "kind": "Reference", - "text": "VerifiablePresentation", - "canonicalReference": "daf-core!VerifiablePresentation:interface" - }, - { - "kind": "Content", - "text": ";" - }, - { - "kind": "Content", - "text": "\n\nset raw(raw: " - }, - { - "kind": "Reference", - "text": "VerifiablePresentation", - "canonicalReference": "daf-core!VerifiablePresentation:interface" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "name": "raw", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Presentation#type:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "type: " - }, - { - "kind": "Content", - "text": "string[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "type", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Presentation#verifier:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "verifier?: " - }, - { - "kind": "Reference", - "text": "Identity", - "canonicalReference": "daf-typeorm!Identity:class" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "verifier", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "isStatic": false - } - ], - "extendsTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "implementsTokenRanges": [] - }, - { - "kind": "Class", - "canonicalReference": "daf-typeorm!Service:class", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class Service extends " - }, - { - "kind": "Reference", - "text": "BaseEntity", - "canonicalReference": "typeorm!BaseEntity:class" - }, - { - "kind": "Content", - "text": " " - } - ], - "releaseTag": "Public", - "name": "Service", - "members": [ - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Service#description:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "description?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "description", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Service#id:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "id: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Service#identity:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "identity: " - }, - { - "kind": "Reference", - "text": "Identity", - "canonicalReference": "daf-typeorm!Identity:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "identity", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Service#serviceEndpoint:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "serviceEndpoint: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "serviceEndpoint", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - }, - { - "kind": "Property", - "canonicalReference": "daf-typeorm!Service#type:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "type: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "type", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false - } - ], - "extendsTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "implementsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "daf-typeorm!TClaimsColumns:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type TClaimsColumns = " - }, - { - "kind": "Content", - "text": "'context' | 'credentialType' | 'type' | 'value' | 'isObj' | 'id' | 'issuer' | 'subject' | 'expirationDate' | 'issuanceDate'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "TClaimsColumns", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "daf-typeorm!TCredentialColumns:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type TCredentialColumns = " - }, - { - "kind": "Content", - "text": "'context' | 'type' | 'id' | 'issuer' | 'subject' | 'expirationDate' | 'issuanceDate'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "TCredentialColumns", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "daf-typeorm!TIdentitiesColumns:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type TIdentitiesColumns = " - }, - { - "kind": "Content", - "text": "'did' | 'alias' | 'provider'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "TIdentitiesColumns", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "daf-typeorm!TMessageColumns:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type TMessageColumns = " - }, - { - "kind": "Content", - "text": "'from' | 'to' | 'id' | 'createdAt' | 'expiresAt' | 'threadId' | 'type' | 'raw' | 'replyTo' | 'replyUrl'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "TMessageColumns", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "daf-typeorm!TPresentationColumns:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type TPresentationColumns = " - }, - { - "kind": "Content", - "text": "'context' | 'type' | 'id' | 'holder' | 'verifier' | 'expirationDate' | 'issuanceDate'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "TPresentationColumns", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Interface", - "canonicalReference": "daf-typeorm!UniqueVerifiableCredential:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface UniqueVerifiableCredential " - } - ], - "releaseTag": "Public", - "name": "UniqueVerifiableCredential", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "daf-typeorm!UniqueVerifiableCredential#hash:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "hash: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "hash", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "daf-typeorm!UniqueVerifiableCredential#verifiableCredential:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "verifiableCredential: " - }, - { - "kind": "Reference", - "text": "VerifiableCredential", - "canonicalReference": "daf-core!VerifiableCredential:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "verifiableCredential", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "daf-typeorm!UniqueVerifiablePresentation:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface UniqueVerifiablePresentation " - } - ], - "releaseTag": "Public", - "name": "UniqueVerifiablePresentation", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "daf-typeorm!UniqueVerifiablePresentation#hash:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "hash: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "hash", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "daf-typeorm!UniqueVerifiablePresentation#verifiablePresentation:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "verifiablePresentation: " - }, - { - "kind": "Reference", - "text": "VerifiablePresentation", - "canonicalReference": "daf-core!VerifiablePresentation:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "verifiablePresentation", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "daf-typeorm!Where:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export interface Where " - } - ], - "releaseTag": "Public", - "typeParameters": [ - { - "typeParameterName": "TColumns", - "constraintTokenRange": { - "startIndex": 0, - "endIndex": 0 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "name": "Where", - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "daf-typeorm!Where#column:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "column: " - }, - { - "kind": "Content", - "text": "TColumns" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "column", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "daf-typeorm!Where#not:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "not?: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "not", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "daf-typeorm!Where#op:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "op?: " - }, - { - "kind": "Content", - "text": "'LessThan' | 'LessThanOrEqual' | 'MoreThan' | 'MoreThanOrEqual' | 'Equal' | 'Like' | 'Between' | 'In' | 'Any' | 'IsNull'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "op", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "daf-typeorm!Where#value:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "value?: " - }, - { - "kind": "Content", - "text": "string[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "releaseTag": "Public", - "name": "value", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - } - ] - } - ] -} +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.9.22", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 + }, + "kind": "Package", + "canonicalReference": "daf-typeorm!", + "docComment": "/**\n * {@link https://typeorm.io/ | TypeORM} backed plugins. {@link daf-core#Agent} {@link daf-typeorm#DataStore | plugin} that implements {@link daf-core#IDataStore} interface. {@link daf-core#Agent} {@link daf-typeorm#DataStoreORM | plugin} that implements {@link daf-typeorm#IDataStoreORM} interface. Provides {@link daf-typeorm#KeyStore} for {@link daf-key-manager#KeyManager} and {@link daf-typeorm#IdentityStore} for {@link daf-identity-manager#IdentityManager}\n *\n * @packageDocumentation\n */\n", + "name": "daf-typeorm", + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "daf-typeorm!", + "name": "", + "members": [ + { + "kind": "Class", + "canonicalReference": "daf-typeorm!Claim:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class Claim extends " + }, + { + "kind": "Reference", + "text": "BaseEntity", + "canonicalReference": "typeorm!BaseEntity:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "Claim", + "members": [ + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Claim#context:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "context: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Claim#credential:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "credential: " + }, + { + "kind": "Reference", + "text": "Credential", + "canonicalReference": "daf-typeorm!Credential:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "credential", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Claim#credentialType:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "credentialType: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "credentialType", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Claim#expirationDate:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "expirationDate?: " + }, + { + "kind": "Reference", + "text": "Date", + "canonicalReference": "!Date:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "expirationDate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Claim#hash:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "hash: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "hash", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Claim#isObj:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "isObj: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isObj", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Claim#issuanceDate:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "issuanceDate: " + }, + { + "kind": "Reference", + "text": "Date", + "canonicalReference": "!Date:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "issuanceDate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Claim#issuer:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "issuer: " + }, + { + "kind": "Reference", + "text": "Identity", + "canonicalReference": "daf-typeorm!Identity:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "issuer", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Claim#subject:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "subject?: " + }, + { + "kind": "Reference", + "text": "Identity", + "canonicalReference": "daf-typeorm!Identity:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "subject", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Claim#type:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "type", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Claim#value:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "value: " + }, + { + "kind": "Content", + "text": "string | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "value", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "daf-typeorm!Credential_2:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class Credential extends " + }, + { + "kind": "Reference", + "text": "BaseEntity", + "canonicalReference": "typeorm!BaseEntity:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "Credential_2", + "members": [ + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Credential_2#claims:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "claims: " + }, + { + "kind": "Reference", + "text": "Claim", + "canonicalReference": "daf-typeorm!Claim:class" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "claims", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Credential_2#context:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "context: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Credential_2#expirationDate:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "expirationDate?: " + }, + { + "kind": "Reference", + "text": "Date", + "canonicalReference": "!Date:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "expirationDate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Credential_2#hash:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "hash: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "hash", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Credential_2#id:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "id?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Credential_2#issuanceDate:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "issuanceDate: " + }, + { + "kind": "Reference", + "text": "Date", + "canonicalReference": "!Date:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "issuanceDate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Credential_2#issuer:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "issuer: " + }, + { + "kind": "Reference", + "text": "Identity", + "canonicalReference": "daf-typeorm!Identity:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "issuer", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Credential_2#messages:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "messages: " + }, + { + "kind": "Reference", + "text": "Message", + "canonicalReference": "daf-typeorm!Message:class" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "messages", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Credential_2#presentations:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "presentations: " + }, + { + "kind": "Reference", + "text": "Presentation", + "canonicalReference": "daf-typeorm!Presentation:class" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "presentations", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Credential_2#raw:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "get raw(): " + }, + { + "kind": "Reference", + "text": "VerifiableCredential", + "canonicalReference": "daf-core!VerifiableCredential:interface" + }, + { + "kind": "Content", + "text": ";" + }, + { + "kind": "Content", + "text": "\n\nset raw(raw: " + }, + { + "kind": "Reference", + "text": "VerifiableCredential", + "canonicalReference": "daf-core!VerifiableCredential:interface" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "name": "raw", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Credential_2#subject:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "subject?: " + }, + { + "kind": "Reference", + "text": "Identity", + "canonicalReference": "daf-typeorm!Identity:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "subject", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Credential_2#type:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "type", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "daf-typeorm!DataStore:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class DataStore implements " + }, + { + "kind": "Reference", + "text": "IAgentPlugin", + "canonicalReference": "daf-core!IAgentPlugin:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "DataStore", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "daf-typeorm!DataStore:constructor(1)", + "docComment": "/**\n * Constructs a new instance of the `DataStore` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(dbConnection: " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Connection", + "canonicalReference": "typeorm!Connection:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "dbConnection", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + } + ] + }, + { + "kind": "Method", + "canonicalReference": "daf-typeorm!DataStore#dataStoreGetMessage:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "dataStoreGetMessage(args: " + }, + { + "kind": "Reference", + "text": "IDataStoreGetMessageArgs", + "canonicalReference": "daf-core!IDataStoreGetMessageArgs:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IMessage", + "canonicalReference": "daf-core!IMessage:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "dataStoreGetMessage" + }, + { + "kind": "Method", + "canonicalReference": "daf-typeorm!DataStore#dataStoreGetVerifiableCredential:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "dataStoreGetVerifiableCredential(args: " + }, + { + "kind": "Reference", + "text": "IDataStoreGetVerifiableCredentialArgs", + "canonicalReference": "daf-core!IDataStoreGetVerifiableCredentialArgs:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "VerifiableCredential", + "canonicalReference": "daf-core!VerifiableCredential:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "dataStoreGetVerifiableCredential" + }, + { + "kind": "Method", + "canonicalReference": "daf-typeorm!DataStore#dataStoreGetVerifiablePresentation:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "dataStoreGetVerifiablePresentation(args: " + }, + { + "kind": "Reference", + "text": "IDataStoreGetVerifiablePresentationArgs", + "canonicalReference": "daf-core!IDataStoreGetVerifiablePresentationArgs:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "VerifiablePresentation", + "canonicalReference": "daf-core!VerifiablePresentation:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "dataStoreGetVerifiablePresentation" + }, + { + "kind": "Method", + "canonicalReference": "daf-typeorm!DataStore#dataStoreSaveMessage:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "dataStoreSaveMessage(args: " + }, + { + "kind": "Reference", + "text": "IDataStoreSaveMessageArgs", + "canonicalReference": "daf-core!IDataStoreSaveMessageArgs:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "dataStoreSaveMessage" + }, + { + "kind": "Method", + "canonicalReference": "daf-typeorm!DataStore#dataStoreSaveVerifiableCredential:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "dataStoreSaveVerifiableCredential(args: " + }, + { + "kind": "Reference", + "text": "IDataStoreSaveVerifiableCredentialArgs", + "canonicalReference": "daf-core!IDataStoreSaveVerifiableCredentialArgs:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "dataStoreSaveVerifiableCredential" + }, + { + "kind": "Method", + "canonicalReference": "daf-typeorm!DataStore#dataStoreSaveVerifiablePresentation:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "dataStoreSaveVerifiablePresentation(args: " + }, + { + "kind": "Reference", + "text": "IDataStoreSaveVerifiablePresentationArgs", + "canonicalReference": "daf-core!IDataStoreSaveVerifiablePresentationArgs:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "dataStoreSaveVerifiablePresentation" + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!DataStore#methods:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly methods: " + }, + { + "kind": "Reference", + "text": "IDataStore", + "canonicalReference": "daf-core!IDataStore:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "methods", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!DataStore#schema:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly schema: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "schema", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "Class", + "canonicalReference": "daf-typeorm!DataStoreORM:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class DataStoreORM implements " + }, + { + "kind": "Reference", + "text": "IAgentPlugin", + "canonicalReference": "daf-core!IAgentPlugin:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "DataStoreORM", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "daf-typeorm!DataStoreORM:constructor(1)", + "docComment": "/**\n * Constructs a new instance of the `DataStoreORM` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(dbConnection: " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Connection", + "canonicalReference": "typeorm!Connection:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "dbConnection", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + } + ] + }, + { + "kind": "Method", + "canonicalReference": "daf-typeorm!DataStoreORM#dataStoreORMGetIdentities:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "dataStoreORMGetIdentities(args: " + }, + { + "kind": "Reference", + "text": "FindArgs", + "canonicalReference": "daf-typeorm!FindArgs:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TIdentitiesColumns", + "canonicalReference": "daf-typeorm!TIdentitiesColumns:type" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "IContext", + "canonicalReference": "daf-typeorm!~IContext:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "PartialIdentity", + "canonicalReference": "daf-typeorm!PartialIdentity:type" + }, + { + "kind": "Content", + "text": "[]>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 8, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + } + } + ], + "name": "dataStoreORMGetIdentities" + }, + { + "kind": "Method", + "canonicalReference": "daf-typeorm!DataStoreORM#dataStoreORMGetIdentitiesCount:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "dataStoreORMGetIdentitiesCount(args: " + }, + { + "kind": "Reference", + "text": "FindArgs", + "canonicalReference": "daf-typeorm!FindArgs:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TIdentitiesColumns", + "canonicalReference": "daf-typeorm!TIdentitiesColumns:type" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "IContext", + "canonicalReference": "daf-typeorm!~IContext:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 8, + "endIndex": 10 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + } + } + ], + "name": "dataStoreORMGetIdentitiesCount" + }, + { + "kind": "Method", + "canonicalReference": "daf-typeorm!DataStoreORM#dataStoreORMGetMessages:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "dataStoreORMGetMessages(args: " + }, + { + "kind": "Reference", + "text": "FindArgs", + "canonicalReference": "daf-typeorm!FindArgs:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TMessageColumns", + "canonicalReference": "daf-typeorm!TMessageColumns:type" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "IContext", + "canonicalReference": "daf-typeorm!~IContext:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IMessage", + "canonicalReference": "daf-core!IMessage:interface" + }, + { + "kind": "Content", + "text": "[]>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 8, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + } + } + ], + "name": "dataStoreORMGetMessages" + }, + { + "kind": "Method", + "canonicalReference": "daf-typeorm!DataStoreORM#dataStoreORMGetMessagesCount:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "dataStoreORMGetMessagesCount(args: " + }, + { + "kind": "Reference", + "text": "FindArgs", + "canonicalReference": "daf-typeorm!FindArgs:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TMessageColumns", + "canonicalReference": "daf-typeorm!TMessageColumns:type" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "IContext", + "canonicalReference": "daf-typeorm!~IContext:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 8, + "endIndex": 10 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + } + } + ], + "name": "dataStoreORMGetMessagesCount" + }, + { + "kind": "Method", + "canonicalReference": "daf-typeorm!DataStoreORM#dataStoreORMGetVerifiableCredentials:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "dataStoreORMGetVerifiableCredentials(args: " + }, + { + "kind": "Reference", + "text": "FindArgs", + "canonicalReference": "daf-typeorm!FindArgs:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TCredentialColumns", + "canonicalReference": "daf-typeorm!TCredentialColumns:type" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "IContext", + "canonicalReference": "daf-typeorm!~IContext:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Array", + "canonicalReference": "!Array:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "UniqueVerifiableCredential", + "canonicalReference": "daf-typeorm!UniqueVerifiableCredential:interface" + }, + { + "kind": "Content", + "text": ">>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 8, + "endIndex": 14 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + } + } + ], + "name": "dataStoreORMGetVerifiableCredentials" + }, + { + "kind": "Method", + "canonicalReference": "daf-typeorm!DataStoreORM#dataStoreORMGetVerifiableCredentialsByClaims:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "dataStoreORMGetVerifiableCredentialsByClaims(args: " + }, + { + "kind": "Reference", + "text": "FindArgs", + "canonicalReference": "daf-typeorm!FindArgs:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TClaimsColumns", + "canonicalReference": "daf-typeorm!TClaimsColumns:type" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "IContext", + "canonicalReference": "daf-typeorm!~IContext:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Array", + "canonicalReference": "!Array:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "UniqueVerifiableCredential", + "canonicalReference": "daf-typeorm!UniqueVerifiableCredential:interface" + }, + { + "kind": "Content", + "text": ">>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 8, + "endIndex": 14 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + } + } + ], + "name": "dataStoreORMGetVerifiableCredentialsByClaims" + }, + { + "kind": "Method", + "canonicalReference": "daf-typeorm!DataStoreORM#dataStoreORMGetVerifiableCredentialsByClaimsCount:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "dataStoreORMGetVerifiableCredentialsByClaimsCount(args: " + }, + { + "kind": "Reference", + "text": "FindArgs", + "canonicalReference": "daf-typeorm!FindArgs:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TClaimsColumns", + "canonicalReference": "daf-typeorm!TClaimsColumns:type" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "IContext", + "canonicalReference": "daf-typeorm!~IContext:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 8, + "endIndex": 10 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + } + } + ], + "name": "dataStoreORMGetVerifiableCredentialsByClaimsCount" + }, + { + "kind": "Method", + "canonicalReference": "daf-typeorm!DataStoreORM#dataStoreORMGetVerifiableCredentialsCount:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "dataStoreORMGetVerifiableCredentialsCount(args: " + }, + { + "kind": "Reference", + "text": "FindArgs", + "canonicalReference": "daf-typeorm!FindArgs:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TCredentialColumns", + "canonicalReference": "daf-typeorm!TCredentialColumns:type" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "IContext", + "canonicalReference": "daf-typeorm!~IContext:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 8, + "endIndex": 10 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + } + } + ], + "name": "dataStoreORMGetVerifiableCredentialsCount" + }, + { + "kind": "Method", + "canonicalReference": "daf-typeorm!DataStoreORM#dataStoreORMGetVerifiablePresentations:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "dataStoreORMGetVerifiablePresentations(args: " + }, + { + "kind": "Reference", + "text": "FindArgs", + "canonicalReference": "daf-typeorm!FindArgs:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TPresentationColumns", + "canonicalReference": "daf-typeorm!TPresentationColumns:type" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "IContext", + "canonicalReference": "daf-typeorm!~IContext:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Array", + "canonicalReference": "!Array:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "UniqueVerifiablePresentation", + "canonicalReference": "daf-typeorm!UniqueVerifiablePresentation:interface" + }, + { + "kind": "Content", + "text": ">>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 8, + "endIndex": 14 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + } + } + ], + "name": "dataStoreORMGetVerifiablePresentations" + }, + { + "kind": "Method", + "canonicalReference": "daf-typeorm!DataStoreORM#dataStoreORMGetVerifiablePresentationsCount:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "dataStoreORMGetVerifiablePresentationsCount(args: " + }, + { + "kind": "Reference", + "text": "FindArgs", + "canonicalReference": "daf-typeorm!FindArgs:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TPresentationColumns", + "canonicalReference": "daf-typeorm!TPresentationColumns:type" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "IContext", + "canonicalReference": "daf-typeorm!~IContext:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 8, + "endIndex": 10 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + } + } + ], + "name": "dataStoreORMGetVerifiablePresentationsCount" + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!DataStoreORM#methods:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly methods: " + }, + { + "kind": "Reference", + "text": "IDataStoreORM", + "canonicalReference": "daf-typeorm!IDataStoreORM:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "methods", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!DataStoreORM#schema:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly schema: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "schema", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "Variable", + "canonicalReference": "daf-typeorm!Entities:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "Entities: " + }, + { + "kind": "Content", + "text": "(typeof " + }, + { + "kind": "Reference", + "text": "Key", + "canonicalReference": "daf-typeorm!Key:class" + }, + { + "kind": "Content", + "text": " | typeof " + }, + { + "kind": "Reference", + "text": "Identity", + "canonicalReference": "daf-typeorm!Identity:class" + }, + { + "kind": "Content", + "text": " | typeof " + }, + { + "kind": "Reference", + "text": "Service", + "canonicalReference": "daf-typeorm!Service:class" + }, + { + "kind": "Content", + "text": " | typeof " + }, + { + "kind": "Reference", + "text": "Claim", + "canonicalReference": "daf-typeorm!Claim:class" + }, + { + "kind": "Content", + "text": " | typeof " + }, + { + "kind": "Reference", + "text": "Credential", + "canonicalReference": "daf-typeorm!Credential:class" + }, + { + "kind": "Content", + "text": " | typeof " + }, + { + "kind": "Reference", + "text": "Presentation", + "canonicalReference": "daf-typeorm!Presentation:class" + }, + { + "kind": "Content", + "text": " | typeof " + }, + { + "kind": "Reference", + "text": "Message", + "canonicalReference": "daf-typeorm!Message:class" + }, + { + "kind": "Content", + "text": ")[]" + } + ], + "releaseTag": "Public", + "name": "Entities", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 16 + } + }, + { + "kind": "Interface", + "canonicalReference": "daf-typeorm!FindArgs:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface FindArgs " + } + ], + "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "TColumns", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "FindArgs", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "daf-typeorm!FindArgs#order:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "order?: " + }, + { + "kind": "Reference", + "text": "Order", + "canonicalReference": "daf-typeorm!Order:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "order", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "daf-typeorm!FindArgs#skip:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "skip?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "skip", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "daf-typeorm!FindArgs#take:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "take?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "take", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "daf-typeorm!FindArgs#where:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "where?: " + }, + { + "kind": "Reference", + "text": "Where", + "canonicalReference": "daf-typeorm!Where:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "where", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "daf-typeorm!FindClaimsArgs:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type FindClaimsArgs = " + }, + { + "kind": "Reference", + "text": "FindArgs", + "canonicalReference": "daf-typeorm!FindArgs:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TClaimsColumns", + "canonicalReference": "daf-typeorm!TClaimsColumns:type" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "FindClaimsArgs", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "daf-typeorm!FindCredentialsArgs:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type FindCredentialsArgs = " + }, + { + "kind": "Reference", + "text": "FindArgs", + "canonicalReference": "daf-typeorm!FindArgs:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TCredentialColumns", + "canonicalReference": "daf-typeorm!TCredentialColumns:type" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "FindCredentialsArgs", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "daf-typeorm!FindIdentitiesArgs:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type FindIdentitiesArgs = " + }, + { + "kind": "Reference", + "text": "FindArgs", + "canonicalReference": "daf-typeorm!FindArgs:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TIdentitiesColumns", + "canonicalReference": "daf-typeorm!TIdentitiesColumns:type" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "FindIdentitiesArgs", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "daf-typeorm!FindMessagesArgs:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type FindMessagesArgs = " + }, + { + "kind": "Reference", + "text": "FindArgs", + "canonicalReference": "daf-typeorm!FindArgs:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TMessageColumns", + "canonicalReference": "daf-typeorm!TMessageColumns:type" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "FindMessagesArgs", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "daf-typeorm!FindPresentationsArgs:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type FindPresentationsArgs = " + }, + { + "kind": "Reference", + "text": "FindArgs", + "canonicalReference": "daf-typeorm!FindArgs:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TPresentationColumns", + "canonicalReference": "daf-typeorm!TPresentationColumns:type" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "FindPresentationsArgs", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "kind": "Interface", + "canonicalReference": "daf-typeorm!IDataStoreORM:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IDataStoreORM extends " + }, + { + "kind": "Reference", + "text": "IPluginMethodMap", + "canonicalReference": "daf-core!IPluginMethodMap:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IDataStoreORM", + "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "daf-typeorm!IDataStoreORM#dataStoreORMGetIdentities:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "dataStoreORMGetIdentities(args: " + }, + { + "kind": "Reference", + "text": "FindIdentitiesArgs", + "canonicalReference": "daf-typeorm!FindIdentitiesArgs:type" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "IContext", + "canonicalReference": "daf-typeorm!~IContext:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Array", + "canonicalReference": "!Array:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "PartialIdentity", + "canonicalReference": "daf-typeorm!PartialIdentity:type" + }, + { + "kind": "Content", + "text": ">>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 11 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "dataStoreORMGetIdentities" + }, + { + "kind": "MethodSignature", + "canonicalReference": "daf-typeorm!IDataStoreORM#dataStoreORMGetIdentitiesCount:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "dataStoreORMGetIdentitiesCount(args: " + }, + { + "kind": "Reference", + "text": "FindIdentitiesArgs", + "canonicalReference": "daf-typeorm!FindIdentitiesArgs:type" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "IContext", + "canonicalReference": "daf-typeorm!~IContext:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "dataStoreORMGetIdentitiesCount" + }, + { + "kind": "MethodSignature", + "canonicalReference": "daf-typeorm!IDataStoreORM#dataStoreORMGetMessages:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "dataStoreORMGetMessages(args: " + }, + { + "kind": "Reference", + "text": "FindMessagesArgs", + "canonicalReference": "daf-typeorm!FindMessagesArgs:type" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "IContext", + "canonicalReference": "daf-typeorm!~IContext:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Array", + "canonicalReference": "!Array:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IMessage", + "canonicalReference": "daf-core!IMessage:interface" + }, + { + "kind": "Content", + "text": ">>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 11 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "dataStoreORMGetMessages" + }, + { + "kind": "MethodSignature", + "canonicalReference": "daf-typeorm!IDataStoreORM#dataStoreORMGetMessagesCount:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "dataStoreORMGetMessagesCount(args: " + }, + { + "kind": "Reference", + "text": "FindMessagesArgs", + "canonicalReference": "daf-typeorm!FindMessagesArgs:type" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "IContext", + "canonicalReference": "daf-typeorm!~IContext:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "dataStoreORMGetMessagesCount" + }, + { + "kind": "MethodSignature", + "canonicalReference": "daf-typeorm!IDataStoreORM#dataStoreORMGetVerifiableCredentials:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "dataStoreORMGetVerifiableCredentials(args: " + }, + { + "kind": "Reference", + "text": "FindCredentialsArgs", + "canonicalReference": "daf-typeorm!FindCredentialsArgs:type" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "IContext", + "canonicalReference": "daf-typeorm!~IContext:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Array", + "canonicalReference": "!Array:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "UniqueVerifiableCredential", + "canonicalReference": "daf-typeorm!UniqueVerifiableCredential:interface" + }, + { + "kind": "Content", + "text": ">>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 11 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "dataStoreORMGetVerifiableCredentials" + }, + { + "kind": "MethodSignature", + "canonicalReference": "daf-typeorm!IDataStoreORM#dataStoreORMGetVerifiableCredentialsByClaims:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "dataStoreORMGetVerifiableCredentialsByClaims(args: " + }, + { + "kind": "Reference", + "text": "FindClaimsArgs", + "canonicalReference": "daf-typeorm!FindClaimsArgs:type" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "IContext", + "canonicalReference": "daf-typeorm!~IContext:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Array", + "canonicalReference": "!Array:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "UniqueVerifiableCredential", + "canonicalReference": "daf-typeorm!UniqueVerifiableCredential:interface" + }, + { + "kind": "Content", + "text": ">>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 11 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "dataStoreORMGetVerifiableCredentialsByClaims" + }, + { + "kind": "MethodSignature", + "canonicalReference": "daf-typeorm!IDataStoreORM#dataStoreORMGetVerifiableCredentialsByClaimsCount:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "dataStoreORMGetVerifiableCredentialsByClaimsCount(args: " + }, + { + "kind": "Reference", + "text": "FindClaimsArgs", + "canonicalReference": "daf-typeorm!FindClaimsArgs:type" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "IContext", + "canonicalReference": "daf-typeorm!~IContext:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "dataStoreORMGetVerifiableCredentialsByClaimsCount" + }, + { + "kind": "MethodSignature", + "canonicalReference": "daf-typeorm!IDataStoreORM#dataStoreORMGetVerifiableCredentialsCount:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "dataStoreORMGetVerifiableCredentialsCount(args: " + }, + { + "kind": "Reference", + "text": "FindCredentialsArgs", + "canonicalReference": "daf-typeorm!FindCredentialsArgs:type" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "IContext", + "canonicalReference": "daf-typeorm!~IContext:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "dataStoreORMGetVerifiableCredentialsCount" + }, + { + "kind": "MethodSignature", + "canonicalReference": "daf-typeorm!IDataStoreORM#dataStoreORMGetVerifiablePresentations:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "dataStoreORMGetVerifiablePresentations(args: " + }, + { + "kind": "Reference", + "text": "FindPresentationsArgs", + "canonicalReference": "daf-typeorm!FindPresentationsArgs:type" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "IContext", + "canonicalReference": "daf-typeorm!~IContext:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Array", + "canonicalReference": "!Array:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "UniqueVerifiablePresentation", + "canonicalReference": "daf-typeorm!UniqueVerifiablePresentation:interface" + }, + { + "kind": "Content", + "text": ">>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 11 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "dataStoreORMGetVerifiablePresentations" + }, + { + "kind": "MethodSignature", + "canonicalReference": "daf-typeorm!IDataStoreORM#dataStoreORMGetVerifiablePresentationsCount:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "dataStoreORMGetVerifiablePresentationsCount(args: " + }, + { + "kind": "Reference", + "text": "FindPresentationsArgs", + "canonicalReference": "daf-typeorm!FindPresentationsArgs:type" + }, + { + "kind": "Content", + "text": ", context: " + }, + { + "kind": "Reference", + "text": "IContext", + "canonicalReference": "daf-typeorm!~IContext:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "context", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "dataStoreORMGetVerifiablePresentationsCount" + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "Class", + "canonicalReference": "daf-typeorm!Identity:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class Identity extends " + }, + { + "kind": "Reference", + "text": "BaseEntity", + "canonicalReference": "typeorm!BaseEntity:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "Identity", + "members": [ + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Identity#alias:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "alias?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "alias", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Identity#controllerKeyId:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "controllerKeyId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "controllerKeyId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Identity#did:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "did: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "did", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "daf-typeorm!Identity#getLatestClaimValue:member(1)", + "docComment": "/**\n * Convenience method\n *\n * const name = await identity.getLatestClaimValue({type: 'name'})\n *\n * @param where - \n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getLatestClaimValue(dbConnection: " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Connection", + "canonicalReference": "typeorm!Connection:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ", where: " + }, + { + "kind": "Content", + "text": "{\n type: string;\n }" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 8, + "endIndex": 10 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "dbConnection", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "parameterName": "where", + "parameterTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + } + } + ], + "name": "getLatestClaimValue" + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Identity#issuedClaims:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "issuedClaims: " + }, + { + "kind": "Reference", + "text": "Claim", + "canonicalReference": "daf-typeorm!Claim:class" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "issuedClaims", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Identity#issuedCredentials:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "issuedCredentials: " + }, + { + "kind": "Reference", + "text": "Credential", + "canonicalReference": "daf-typeorm!Credential:class" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "issuedCredentials", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Identity#issuedPresentations:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "issuedPresentations: " + }, + { + "kind": "Reference", + "text": "Presentation", + "canonicalReference": "daf-typeorm!Presentation:class" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "issuedPresentations", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Identity#keys:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "keys: " + }, + { + "kind": "Reference", + "text": "Key", + "canonicalReference": "daf-typeorm!Key:class" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "keys", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Identity#provider:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "provider: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "provider", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Identity#receivedClaims:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "receivedClaims: " + }, + { + "kind": "Reference", + "text": "Claim", + "canonicalReference": "daf-typeorm!Claim:class" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "receivedClaims", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Identity#receivedCredentials:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "receivedCredentials: " + }, + { + "kind": "Reference", + "text": "Credential", + "canonicalReference": "daf-typeorm!Credential:class" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "receivedCredentials", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Identity#receivedMessages:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "receivedMessages: " + }, + { + "kind": "Reference", + "text": "Message", + "canonicalReference": "daf-typeorm!Message:class" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "receivedMessages", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Identity#receivedPresentations:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "receivedPresentations: " + }, + { + "kind": "Reference", + "text": "Presentation", + "canonicalReference": "daf-typeorm!Presentation:class" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "receivedPresentations", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Identity#saveDate:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "saveDate: " + }, + { + "kind": "Reference", + "text": "Date", + "canonicalReference": "!Date:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "saveDate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Identity#sentMessages:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "sentMessages: " + }, + { + "kind": "Reference", + "text": "Message", + "canonicalReference": "daf-typeorm!Message:class" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "sentMessages", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Identity#services:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "services: " + }, + { + "kind": "Reference", + "text": "Service", + "canonicalReference": "daf-typeorm!Service:class" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "services", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "daf-typeorm!Identity#shortDid:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "shortDid(): " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "shortDid" + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Identity#updateDate:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "updateDate: " + }, + { + "kind": "Reference", + "text": "Date", + "canonicalReference": "!Date:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "updateDate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "daf-typeorm!IdentityStore:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class IdentityStore extends " + }, + { + "kind": "Reference", + "text": "AbstractIdentityStore", + "canonicalReference": "daf-identity-manager!AbstractIdentityStore:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IdentityStore", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "daf-typeorm!IdentityStore:constructor(1)", + "docComment": "/**\n * Constructs a new instance of the `IdentityStore` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(dbConnection: " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Connection", + "canonicalReference": "typeorm!Connection:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "dbConnection", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + } + ] + }, + { + "kind": "Method", + "canonicalReference": "daf-typeorm!IdentityStore#delete:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "delete({ did }: " + }, + { + "kind": "Content", + "text": "{\n did: string;\n }" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "{ did }", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "delete" + }, + { + "kind": "Method", + "canonicalReference": "daf-typeorm!IdentityStore#get:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "get({ did, alias, provider }: " + }, + { + "kind": "Content", + "text": "{\n did: string;\n alias: string;\n provider: string;\n }" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IIdentity", + "canonicalReference": "daf-core!IIdentity:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "{ did, alias, provider }", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "get" + }, + { + "kind": "Method", + "canonicalReference": "daf-typeorm!IdentityStore#import:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "import(args: " + }, + { + "kind": "Reference", + "text": "IIdentity", + "canonicalReference": "daf-core!IIdentity:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "import" + }, + { + "kind": "Method", + "canonicalReference": "daf-typeorm!IdentityStore#list:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "list(args: " + }, + { + "kind": "Content", + "text": "{\n alias?: string;\n provider?: string;\n }" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IIdentity", + "canonicalReference": "daf-core!IIdentity:interface" + }, + { + "kind": "Content", + "text": "[]>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "list" + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "daf-typeorm!Key:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class Key extends " + }, + { + "kind": "Reference", + "text": "BaseEntity", + "canonicalReference": "typeorm!BaseEntity:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "Key", + "members": [ + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Key#identity:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "identity: " + }, + { + "kind": "Reference", + "text": "Identity", + "canonicalReference": "daf-typeorm!Identity:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "identity", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Key#kid:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "kid: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "kid", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Key#kms:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "kms: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "kms", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Key#meta:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "meta?: " + }, + { + "kind": "Content", + "text": "object | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "meta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Key#privateKeyHex:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "privateKeyHex?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "privateKeyHex", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Key#publicKeyHex:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "publicKeyHex: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "publicKeyHex", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Key#type:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type: " + }, + { + "kind": "Reference", + "text": "KeyType", + "canonicalReference": "daf-typeorm!KeyType:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "type", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "daf-typeorm!KeyStore:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class KeyStore extends " + }, + { + "kind": "Reference", + "text": "AbstractKeyStore", + "canonicalReference": "daf-key-manager!AbstractKeyStore:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "KeyStore", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "daf-typeorm!KeyStore:constructor(1)", + "docComment": "/**\n * Constructs a new instance of the `KeyStore` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(dbConnection: " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Connection", + "canonicalReference": "typeorm!Connection:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ", secretBox?: " + }, + { + "kind": "Reference", + "text": "AbstractSecretBox", + "canonicalReference": "daf-key-manager!AbstractSecretBox:class" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "dbConnection", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "parameterName": "secretBox", + "parameterTypeTokenRange": { + "startIndex": 6, + "endIndex": 8 + } + } + ] + }, + { + "kind": "Method", + "canonicalReference": "daf-typeorm!KeyStore#delete:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "delete({ kid }: " + }, + { + "kind": "Content", + "text": "{\n kid: string;\n }" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "{ kid }", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "delete" + }, + { + "kind": "Method", + "canonicalReference": "daf-typeorm!KeyStore#get:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "get({ kid }: " + }, + { + "kind": "Content", + "text": "{\n kid: string;\n }" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IKey", + "canonicalReference": "daf-core!IKey:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "{ kid }", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "get" + }, + { + "kind": "Method", + "canonicalReference": "daf-typeorm!KeyStore#import:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "import(args: " + }, + { + "kind": "Reference", + "text": "IKey", + "canonicalReference": "daf-core!IKey:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "import" + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "daf-typeorm!KeyType_2:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type KeyType = " + }, + { + "kind": "Content", + "text": "'Ed25519' | 'Secp256k1'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "KeyType_2", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Class", + "canonicalReference": "daf-typeorm!Message:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class Message extends " + }, + { + "kind": "Reference", + "text": "BaseEntity", + "canonicalReference": "typeorm!BaseEntity:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "Message", + "members": [ + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Message#createdAt:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "createdAt?: " + }, + { + "kind": "Reference", + "text": "Date", + "canonicalReference": "!Date:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "createdAt", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Message#credentials:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "credentials: " + }, + { + "kind": "Reference", + "text": "Credential", + "canonicalReference": "daf-typeorm!Credential:class" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "credentials", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Message#data:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "data?: " + }, + { + "kind": "Content", + "text": "object | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "data", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Message#expiresAt:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "expiresAt?: " + }, + { + "kind": "Reference", + "text": "Date", + "canonicalReference": "!Date:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "expiresAt", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Message#from:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "from?: " + }, + { + "kind": "Reference", + "text": "Identity", + "canonicalReference": "daf-typeorm!Identity:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "from", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Message#id:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "id: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Message#metaData:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "metaData?: " + }, + { + "kind": "Reference", + "text": "MetaData", + "canonicalReference": "daf-typeorm!MetaData:interface" + }, + { + "kind": "Content", + "text": "[] | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "metaData", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Message#presentations:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "presentations: " + }, + { + "kind": "Reference", + "text": "Presentation", + "canonicalReference": "daf-typeorm!Presentation:class" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "presentations", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Message#raw:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "raw?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "raw", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Message#replyTo:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "replyTo?: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "replyTo", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Message#replyUrl:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "replyUrl?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "replyUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Message#saveDate:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "saveDate: " + }, + { + "kind": "Reference", + "text": "Date", + "canonicalReference": "!Date:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "saveDate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "daf-typeorm!Message#setId:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "setId(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "setId" + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Message#threadId:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "threadId?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "threadId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Message#to:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "to?: " + }, + { + "kind": "Reference", + "text": "Identity", + "canonicalReference": "daf-typeorm!Identity:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "to", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Message#type:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "type", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Message#updateDate:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "updateDate: " + }, + { + "kind": "Reference", + "text": "Date", + "canonicalReference": "!Date:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "updateDate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "daf-typeorm!MetaData:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface MetaData " + } + ], + "releaseTag": "Public", + "name": "MetaData", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "daf-typeorm!MetaData#type:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "type", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "daf-typeorm!MetaData#value:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "value?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "value", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Variable", + "canonicalReference": "daf-typeorm!migrations:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "migrations: " + }, + { + "kind": "Content", + "text": "never[]" + } + ], + "releaseTag": "Public", + "name": "migrations", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "daf-typeorm!Order:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface Order " + } + ], + "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "TColumns", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "Order", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "daf-typeorm!Order#column:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "column: " + }, + { + "kind": "Content", + "text": "TColumns" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "column", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "daf-typeorm!Order#direction:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "direction: " + }, + { + "kind": "Content", + "text": "'ASC' | 'DESC'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "direction", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "daf-typeorm!Presentation:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class Presentation extends " + }, + { + "kind": "Reference", + "text": "BaseEntity", + "canonicalReference": "typeorm!BaseEntity:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "Presentation", + "members": [ + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Presentation#context:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "context: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Presentation#credentials:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "credentials: " + }, + { + "kind": "Reference", + "text": "Credential", + "canonicalReference": "daf-typeorm!Credential:class" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "credentials", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Presentation#expirationDate:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "expirationDate?: " + }, + { + "kind": "Reference", + "text": "Date", + "canonicalReference": "!Date:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "expirationDate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Presentation#hash:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "hash: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "hash", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Presentation#holder:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "holder: " + }, + { + "kind": "Reference", + "text": "Identity", + "canonicalReference": "daf-typeorm!Identity:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "holder", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Presentation#id:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "id?: " + }, + { + "kind": "Reference", + "text": "String", + "canonicalReference": "!String:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Presentation#issuanceDate:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "issuanceDate: " + }, + { + "kind": "Reference", + "text": "Date", + "canonicalReference": "!Date:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "issuanceDate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Presentation#messages:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "messages: " + }, + { + "kind": "Reference", + "text": "Message", + "canonicalReference": "daf-typeorm!Message:class" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "messages", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Presentation#raw:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "get raw(): " + }, + { + "kind": "Reference", + "text": "VerifiablePresentation", + "canonicalReference": "daf-core!VerifiablePresentation:interface" + }, + { + "kind": "Content", + "text": ";" + }, + { + "kind": "Content", + "text": "\n\nset raw(raw: " + }, + { + "kind": "Reference", + "text": "VerifiablePresentation", + "canonicalReference": "daf-core!VerifiablePresentation:interface" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "name": "raw", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Presentation#type:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "type", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Presentation#verifier:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "verifier?: " + }, + { + "kind": "Reference", + "text": "Identity", + "canonicalReference": "daf-typeorm!Identity:class" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "verifier", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "Variable", + "canonicalReference": "daf-typeorm!schema:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "schema: " + }, + { + "kind": "Content", + "text": "any" + } + ], + "releaseTag": "Public", + "name": "schema", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Class", + "canonicalReference": "daf-typeorm!Service:class", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare class Service extends " + }, + { + "kind": "Reference", + "text": "BaseEntity", + "canonicalReference": "typeorm!BaseEntity:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "Service", + "members": [ + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Service#description:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "description?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "description", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Service#id:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "id: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Service#identity:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "identity: " + }, + { + "kind": "Reference", + "text": "Identity", + "canonicalReference": "daf-typeorm!Identity:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "identity", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Service#serviceEndpoint:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "serviceEndpoint: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serviceEndpoint", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "daf-typeorm!Service#type:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "type", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "daf-typeorm!TClaimsColumns:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type TClaimsColumns = " + }, + { + "kind": "Content", + "text": "'context' | 'credentialType' | 'type' | 'value' | 'isObj' | 'id' | 'issuer' | 'subject' | 'expirationDate' | 'issuanceDate'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "TClaimsColumns", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "daf-typeorm!TCredentialColumns:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type TCredentialColumns = " + }, + { + "kind": "Content", + "text": "'context' | 'type' | 'id' | 'issuer' | 'subject' | 'expirationDate' | 'issuanceDate'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "TCredentialColumns", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "daf-typeorm!TIdentitiesColumns:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type TIdentitiesColumns = " + }, + { + "kind": "Content", + "text": "'did' | 'alias' | 'provider'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "TIdentitiesColumns", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "daf-typeorm!TMessageColumns:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type TMessageColumns = " + }, + { + "kind": "Content", + "text": "'from' | 'to' | 'id' | 'createdAt' | 'expiresAt' | 'threadId' | 'type' | 'raw' | 'replyTo' | 'replyUrl'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "TMessageColumns", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "daf-typeorm!TPresentationColumns:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type TPresentationColumns = " + }, + { + "kind": "Content", + "text": "'context' | 'type' | 'id' | 'holder' | 'verifier' | 'expirationDate' | 'issuanceDate'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "TPresentationColumns", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "daf-typeorm!UniqueVerifiableCredential:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface UniqueVerifiableCredential " + } + ], + "releaseTag": "Public", + "name": "UniqueVerifiableCredential", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "daf-typeorm!UniqueVerifiableCredential#hash:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "hash: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "hash", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "daf-typeorm!UniqueVerifiableCredential#verifiableCredential:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "verifiableCredential: " + }, + { + "kind": "Reference", + "text": "VerifiableCredential", + "canonicalReference": "daf-core!VerifiableCredential:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "verifiableCredential", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "daf-typeorm!UniqueVerifiablePresentation:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface UniqueVerifiablePresentation " + } + ], + "releaseTag": "Public", + "name": "UniqueVerifiablePresentation", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "daf-typeorm!UniqueVerifiablePresentation#hash:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "hash: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "hash", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "daf-typeorm!UniqueVerifiablePresentation#verifiablePresentation:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "verifiablePresentation: " + }, + { + "kind": "Reference", + "text": "VerifiablePresentation", + "canonicalReference": "daf-core!VerifiablePresentation:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "verifiablePresentation", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "daf-typeorm!Where:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface Where " + } + ], + "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "TColumns", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "Where", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "daf-typeorm!Where#column:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "column: " + }, + { + "kind": "Content", + "text": "TColumns" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "column", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "daf-typeorm!Where#not:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "not?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "not", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "daf-typeorm!Where#op:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "op?: " + }, + { + "kind": "Content", + "text": "'LessThan' | 'LessThanOrEqual' | 'MoreThan' | 'MoreThanOrEqual' | 'Equal' | 'Like' | 'Between' | 'In' | 'Any' | 'IsNull'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "op", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "daf-typeorm!Where#value:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "value?: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "value", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + } + ] + } + ] +} diff --git a/packages/daf-typeorm/api/daf-typeorm.api.md b/packages/daf-typeorm/api/daf-typeorm.api.md index cc2e6dbd3..5a4306700 100644 --- a/packages/daf-typeorm/api/daf-typeorm.api.md +++ b/packages/daf-typeorm/api/daf-typeorm.api.md @@ -1,1618 +1,437 @@ -## API Report File for "daf-typeorm" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts -import { AbstractIdentityStore } from 'daf-identity-manager' -import { AbstractKeyStore } from 'daf-key-manager' -import { AbstractSecretBox } from 'daf-key-manager' -import { BaseEntity } from 'typeorm' -import { Connection } from 'typeorm' -import { IAgentPlugin } from 'daf-core' -import { IDataStore } from 'daf-core' -import { IDataStoreGetMessageArgs } from 'daf-core' -import { IDataStoreGetVerifiableCredentialArgs } from 'daf-core' -import { IDataStoreGetVerifiablePresentationArgs } from 'daf-core' -import { IDataStoreSaveMessageArgs } from 'daf-core' -import { IDataStoreSaveVerifiableCredentialArgs } from 'daf-core' -import { IDataStoreSaveVerifiablePresentationArgs } from 'daf-core' -import { IIdentity } from 'daf-core' -import { IKey } from 'daf-core' -import { IMessage } from 'daf-core' -import { IPluginMethodMap } from 'daf-core' -import { VerifiableCredential } from 'daf-core' -import { VerifiablePresentation } from 'daf-core' - -// @public (undocumented) -export class Claim extends BaseEntity { - // (undocumented) - context: string[] - // (undocumented) - credential: Credential_2 - // (undocumented) - credentialType: string[] - // (undocumented) - expirationDate?: Date - // (undocumented) - hash: string - // (undocumented) - isObj: boolean - // (undocumented) - issuanceDate: Date - // (undocumented) - issuer: Identity - // (undocumented) - subject?: Identity - // (undocumented) - type: string - // (undocumented) - value: string | 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: Identity - // (undocumented) - messages: Message[] - // (undocumented) - presentations: Presentation[] - set raw(raw: VerifiableCredential) - // (undocumented) - get raw(): VerifiableCredential - // (undocumented) - subject?: Identity - // (undocumented) - type: string[] -} - -export { Credential_2 as Credential } - -// @public (undocumented) -export class DataStore implements IAgentPlugin { - constructor(dbConnection: Promise) - // (undocumented) - 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: { - components: { - schemas: { - IDataStoreGetMessageArgs: { - type: string - properties: { - id: { - type: string - description: string - } - } - required: string[] - description: string - } - IMessage: { - type: string - properties: { - id: { - type: string - description: string - } - type: { - type: string - description: string - } - createdAt: { - type: string - description: string - } - expiresAt: { - type: string - description: string - } - threadId: { - type: string - description: string - } - raw: { - type: string - description: string - } - data: { - anyOf: { - type: string - }[] - description: string - } - replyTo: { - type: string - items: { - type: string - } - description: string - } - replyUrl: { - type: string - description: string - } - from: { - type: string - description: string - } - to: { - type: string - description: string - } - metaData: { - anyOf: ( - | { - type: string - items: { - $ref: string - } - } - | { - type: string - items?: undefined - } - )[] - description: string - } - credentials: { - type: string - items: { - $ref: string - } - description: string - } - presentations: { - type: string - items: { - $ref: string - } - description: string - } - } - required: string[] - description: string - } - IMetaData: { - type: string - properties: { - type: { - type: string - description: string - } - value: { - type: string - description: string - } - } - required: string[] - description: string - } - VerifiableCredential: { - type: string - properties: { - '@context': { - type: string - items: { - type: string - } - } - id: { - type: string - } - type: { - type: string - items: { - type: string - } - } - issuer: { - type: string - properties: { - id: { - type: string - } - } - required: string[] - } - issuanceDate: { - type: string - } - expirationDate: { - type: string - } - credentialSubject: { - type: string - properties: { - id: { - type: string - } - } - } - credentialStatus: { - type: string - properties: { - id: { - type: string - } - type: { - type: string - } - } - required: string[] - } - proof: { - type: string - properties: { - type: { - type: string - } - } - } - } - required: string[] - description: string - } - VerifiablePresentation: { - type: string - properties: { - id: { - type: string - } - holder: { - type: string - } - issuanceDate: { - type: string - } - expirationDate: { - type: string - } - '@context': { - type: string - items: { - type: string - } - } - type: { - type: string - items: { - type: string - } - } - verifier: { - type: string - items: { - type: string - } - } - verifiableCredential: { - type: string - items: { - $ref: string - } - } - proof: { - type: string - properties: { - type: { - type: string - } - } - } - } - required: string[] - description: string - } - IDataStoreGetVerifiableCredentialArgs: { - type: string - properties: { - hash: { - type: string - description: string - } - } - required: string[] - description: string - } - IDataStoreGetVerifiablePresentationArgs: { - type: string - properties: { - hash: { - type: string - description: string - } - } - required: string[] - description: string - } - IDataStoreSaveMessageArgs: { - type: string - properties: { - message: { - $ref: string - description: string - } - } - required: string[] - description: string - } - IDataStoreSaveVerifiableCredentialArgs: { - type: string - properties: { - verifiableCredential: { - $ref: string - description: string - } - } - required: string[] - description: string - } - IDataStoreSaveVerifiablePresentationArgs: { - type: string - properties: { - verifiablePresentation: { - $ref: string - description: string - } - } - required: string[] - description: string - } - } - methods: { - dataStoreGetMessage: { - description: string - arguments: { - $ref: string - } - returnType: { - $ref: string - } - } - dataStoreGetVerifiableCredential: { - description: string - arguments: { - $ref: string - } - returnType: { - $ref: string - } - } - dataStoreGetVerifiablePresentation: { - description: string - arguments: { - $ref: string - } - returnType: { - $ref: string - } - } - dataStoreSaveMessage: { - description: string - arguments: { - $ref: string - } - returnType: { - type: string - } - } - dataStoreSaveVerifiableCredential: { - description: string - arguments: { - $ref: string - } - returnType: { - type: string - } - } - dataStoreSaveVerifiablePresentation: { - description: string - arguments: { - $ref: string - } - returnType: { - type: string - } - } - } - } - } -} - -// @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 "PartialIdentity" needs to be exported by the entry point index.d.ts - // - // (undocumented) - dataStoreORMGetIdentities(args: FindArgs, context: IContext): Promise - // (undocumented) - dataStoreORMGetIdentitiesCount(args: FindArgs, context: IContext): Promise - // (undocumented) - dataStoreORMGetMessages(args: FindArgs, context: IContext): Promise - // (undocumented) - dataStoreORMGetMessagesCount(args: FindArgs, context: IContext): Promise - // (undocumented) - dataStoreORMGetVerifiableCredentials( - args: FindArgs, - context: IContext, - ): Promise> - // (undocumented) - dataStoreORMGetVerifiableCredentialsByClaims( - args: FindArgs, - context: IContext, - ): Promise> - // (undocumented) - dataStoreORMGetVerifiableCredentialsByClaimsCount( - args: FindArgs, - context: IContext, - ): Promise - // (undocumented) - dataStoreORMGetVerifiableCredentialsCount( - args: FindArgs, - context: IContext, - ): Promise - // (undocumented) - dataStoreORMGetVerifiablePresentations( - args: FindArgs, - context: IContext, - ): Promise> - // (undocumented) - dataStoreORMGetVerifiablePresentationsCount( - args: FindArgs, - context: IContext, - ): Promise - // (undocumented) - readonly methods: IDataStoreORM - // (undocumented) - readonly schema: { - components: { - schemas: { - FindIdentitiesArgs: { - $ref: string - } - 'FindArgs-TIdentitiesColumns': { - type: string - properties: { - where: { - type: string - items: { - $ref: string - } - } - order: { - type: string - items: { - $ref: string - } - } - take: { - type: string - } - skip: { - type: string - } - } - } - 'Where-TIdentitiesColumns': { - type: string - properties: { - column: { - $ref: string - } - value: { - type: string - items: { - type: string - } - } - not: { - type: string - } - op: { - type: string - enum: string[] - } - } - required: string[] - } - TIdentitiesColumns: { - type: string - enum: string[] - } - 'Order-TIdentitiesColumns': { - type: string - properties: { - column: { - $ref: string - } - direction: { - type: string - enum: string[] - } - } - required: string[] - } - PartialIdentity: { - type: string - properties: { - did: { - type: string - description: string - } - alias: { - type: string - description: string - } - provider: { - type: string - description: string - } - controllerKeyId: { - type: string - description: string - } - keys: { - type: string - items: { - $ref: string - } - description: string - } - services: { - type: string - items: { - $ref: string - } - description: string - } - } - } - IKey: { - type: string - properties: { - kid: { - type: string - description: string - } - kms: { - type: string - description: string - } - type: { - $ref: string - description: string - } - publicKeyHex: { - type: string - description: string - } - privateKeyHex: { - type: string - description: string - } - meta: { - anyOf: { - type: string - }[] - description: string - } - } - required: string[] - description: string - } - TKeyType: { - type: string - enum: string[] - description: string - } - IService: { - type: string - properties: { - id: { - type: string - description: string - } - type: { - type: string - description: string - } - serviceEndpoint: { - type: string - description: string - } - description: { - type: string - description: string - } - } - required: string[] - description: string - } - FindMessagesArgs: { - $ref: string - } - 'FindArgs-TMessageColumns': { - type: string - properties: { - where: { - type: string - items: { - $ref: string - } - } - order: { - type: string - items: { - $ref: string - } - } - take: { - type: string - } - skip: { - type: string - } - } - } - 'Where-TMessageColumns': { - type: string - properties: { - column: { - $ref: string - } - value: { - type: string - items: { - type: string - } - } - not: { - type: string - } - op: { - type: string - enum: string[] - } - } - required: string[] - } - TMessageColumns: { - type: string - enum: string[] - } - 'Order-TMessageColumns': { - type: string - properties: { - column: { - $ref: string - } - direction: { - type: string - enum: string[] - } - } - required: string[] - } - IMessage: { - type: string - properties: { - id: { - type: string - description: string - } - type: { - type: string - description: string - } - createdAt: { - type: string - description: string - } - expiresAt: { - type: string - description: string - } - threadId: { - type: string - description: string - } - raw: { - type: string - description: string - } - data: { - anyOf: { - type: string - }[] - description: string - } - replyTo: { - type: string - items: { - type: string - } - description: string - } - replyUrl: { - type: string - description: string - } - from: { - type: string - description: string - } - to: { - type: string - description: string - } - metaData: { - anyOf: ( - | { - type: string - items: { - $ref: string - } - } - | { - type: string - items?: undefined - } - )[] - description: string - } - credentials: { - type: string - items: { - $ref: string - } - description: string - } - presentations: { - type: string - items: { - $ref: string - } - description: string - } - } - required: string[] - description: string - } - IMetaData: { - type: string - properties: { - type: { - type: string - description: string - } - value: { - type: string - description: string - } - } - required: string[] - description: string - } - VerifiableCredential: { - type: string - properties: { - '@context': { - type: string - items: { - type: string - } - } - id: { - type: string - } - type: { - type: string - items: { - type: string - } - } - issuer: { - type: string - properties: { - id: { - type: string - } - } - required: string[] - } - issuanceDate: { - type: string - } - expirationDate: { - type: string - } - credentialSubject: { - type: string - properties: { - id: { - type: string - } - } - } - credentialStatus: { - type: string - properties: { - id: { - type: string - } - type: { - type: string - } - } - required: string[] - } - proof: { - type: string - properties: { - type: { - type: string - } - } - } - } - required: string[] - description: string - } - VerifiablePresentation: { - type: string - properties: { - id: { - type: string - } - holder: { - type: string - } - issuanceDate: { - type: string - } - expirationDate: { - type: string - } - '@context': { - type: string - items: { - type: string - } - } - type: { - type: string - items: { - type: string - } - } - verifier: { - type: string - items: { - type: string - } - } - verifiableCredential: { - type: string - items: { - $ref: string - } - } - proof: { - type: string - properties: { - type: { - type: string - } - } - } - } - required: string[] - description: string - } - FindCredentialsArgs: { - $ref: string - } - 'FindArgs-TCredentialColumns': { - type: string - properties: { - where: { - type: string - items: { - $ref: string - } - } - order: { - type: string - items: { - $ref: string - } - } - take: { - type: string - } - skip: { - type: string - } - } - } - 'Where-TCredentialColumns': { - type: string - properties: { - column: { - $ref: string - } - value: { - type: string - items: { - type: string - } - } - not: { - type: string - } - op: { - type: string - enum: string[] - } - } - required: string[] - } - TCredentialColumns: { - type: string - enum: string[] - } - 'Order-TCredentialColumns': { - type: string - properties: { - column: { - $ref: string - } - direction: { - type: string - enum: string[] - } - } - required: string[] - } - UniqueVerifiableCredential: { - type: string - properties: { - hash: { - type: string - } - verifiableCredential: { - $ref: string - } - } - required: string[] - } - FindClaimsArgs: { - $ref: string - } - 'FindArgs-TClaimsColumns': { - type: string - properties: { - where: { - type: string - items: { - $ref: string - } - } - order: { - type: string - items: { - $ref: string - } - } - take: { - type: string - } - skip: { - type: string - } - } - } - 'Where-TClaimsColumns': { - type: string - properties: { - column: { - $ref: string - } - value: { - type: string - items: { - type: string - } - } - not: { - type: string - } - op: { - type: string - enum: string[] - } - } - required: string[] - } - TClaimsColumns: { - type: string - enum: string[] - } - 'Order-TClaimsColumns': { - type: string - properties: { - column: { - $ref: string - } - direction: { - type: string - enum: string[] - } - } - required: string[] - } - FindPresentationsArgs: { - $ref: string - } - 'FindArgs-TPresentationColumns': { - type: string - properties: { - where: { - type: string - items: { - $ref: string - } - } - order: { - type: string - items: { - $ref: string - } - } - take: { - type: string - } - skip: { - type: string - } - } - } - 'Where-TPresentationColumns': { - type: string - properties: { - column: { - $ref: string - } - value: { - type: string - items: { - type: string - } - } - not: { - type: string - } - op: { - type: string - enum: string[] - } - } - required: string[] - } - TPresentationColumns: { - type: string - enum: string[] - } - 'Order-TPresentationColumns': { - type: string - properties: { - column: { - $ref: string - } - direction: { - type: string - enum: string[] - } - } - required: string[] - } - UniqueVerifiablePresentation: { - type: string - properties: { - hash: { - type: string - } - verifiablePresentation: { - $ref: string - } - } - required: string[] - } - } - methods: { - dataStoreORMGetIdentities: { - description: string - arguments: { - $ref: string - } - returnType: { - type: string - items: { - $ref: string - } - } - } - dataStoreORMGetIdentitiesCount: { - description: string - arguments: { - $ref: string - } - returnType: { - type: string - } - } - dataStoreORMGetMessages: { - description: string - arguments: { - $ref: string - } - returnType: { - type: string - items: { - $ref: string - } - } - } - dataStoreORMGetMessagesCount: { - description: string - arguments: { - $ref: string - } - returnType: { - type: string - } - } - dataStoreORMGetVerifiableCredentials: { - description: string - arguments: { - $ref: string - } - returnType: { - type: string - items: { - $ref: string - } - } - } - dataStoreORMGetVerifiableCredentialsByClaims: { - description: string - arguments: { - $ref: string - } - returnType: { - type: string - items: { - $ref: string - } - } - } - dataStoreORMGetVerifiableCredentialsByClaimsCount: { - description: string - arguments: { - $ref: string - } - returnType: { - type: string - } - } - dataStoreORMGetVerifiableCredentialsCount: { - description: string - arguments: { - $ref: string - } - returnType: { - type: string - } - } - dataStoreORMGetVerifiablePresentations: { - description: string - arguments: { - $ref: string - } - returnType: { - type: string - items: { - $ref: string - } - } - } - dataStoreORMGetVerifiablePresentationsCount: { - description: string - arguments: { - $ref: string - } - returnType: { - type: string - } - } - } - } - } -} - -// @public (undocumented) -export const Entities: ( - | typeof Key - | typeof Identity - | typeof Service - | typeof Claim - | typeof Credential_2 - | typeof Presentation - | typeof Message -)[] - -// @public (undocumented) -export interface FindArgs { - // (undocumented) - order?: Order[] - // (undocumented) - skip?: number - // (undocumented) - take?: number - // (undocumented) - where?: Where[] -} - -// @public (undocumented) -export type FindClaimsArgs = FindArgs - -// @public (undocumented) -export type FindCredentialsArgs = FindArgs - -// @public (undocumented) -export type FindIdentitiesArgs = FindArgs - -// @public (undocumented) -export type FindMessagesArgs = FindArgs - -// @public (undocumented) -export type FindPresentationsArgs = FindArgs - -// @public (undocumented) -export interface IDataStoreORM extends IPluginMethodMap { - // (undocumented) - dataStoreORMGetIdentities(args: FindIdentitiesArgs, context: IContext): Promise> - // (undocumented) - dataStoreORMGetIdentitiesCount(args: FindIdentitiesArgs, context: IContext): Promise - // (undocumented) - dataStoreORMGetMessages(args: FindMessagesArgs, context: IContext): Promise> - // (undocumented) - dataStoreORMGetMessagesCount(args: FindMessagesArgs, context: IContext): Promise - // (undocumented) - dataStoreORMGetVerifiableCredentials( - args: FindCredentialsArgs, - context: IContext, - ): Promise> - // (undocumented) - dataStoreORMGetVerifiableCredentialsByClaims( - args: FindClaimsArgs, - context: IContext, - ): Promise> - // (undocumented) - dataStoreORMGetVerifiableCredentialsByClaimsCount(args: FindClaimsArgs, context: IContext): Promise - // (undocumented) - dataStoreORMGetVerifiableCredentialsCount(args: FindCredentialsArgs, context: IContext): Promise - // (undocumented) - dataStoreORMGetVerifiablePresentations( - args: FindPresentationsArgs, - context: IContext, - ): Promise> - // (undocumented) - dataStoreORMGetVerifiablePresentationsCount(args: FindPresentationsArgs, context: IContext): Promise -} - -// @public (undocumented) -export class Identity extends BaseEntity { - // (undocumented) - alias?: string - // (undocumented) - controllerKeyId: string - // (undocumented) - did: string - getLatestClaimValue( - dbConnection: Promise, - where: { - type: string - }, - ): Promise - // (undocumented) - issuedClaims: Claim[] - // (undocumented) - issuedCredentials: Credential_2[] - // (undocumented) - issuedPresentations: Presentation[] - // (undocumented) - keys: Key[] - // (undocumented) - provider: string - // (undocumented) - receivedClaims: Claim[] - // (undocumented) - receivedCredentials: Credential_2[] - // (undocumented) - receivedMessages: Message[] - // (undocumented) - receivedPresentations: Presentation[] - // (undocumented) - saveDate: Date - // (undocumented) - sentMessages: Message[] - // (undocumented) - services: Service[] - // (undocumented) - shortDid(): string - // (undocumented) - updateDate: Date -} - -// @public (undocumented) -export class IdentityStore extends AbstractIdentityStore { - constructor(dbConnection: Promise) - // (undocumented) - delete({ did }: { did: string }): Promise - // (undocumented) - get({ did, alias, provider }: { did: string; alias: string; provider: string }): Promise - // (undocumented) - import(args: IIdentity): Promise - // (undocumented) - list(args: { alias?: string; provider?: string }): Promise -} - -// @public (undocumented) -export class Key extends BaseEntity { - // (undocumented) - identity: Identity - // (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?: Identity - // (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?: Identity - // (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: Identity - // (undocumented) - id?: String - // (undocumented) - issuanceDate: Date - // (undocumented) - messages: Message[] - set raw(raw: VerifiablePresentation) - // (undocumented) - get raw(): VerifiablePresentation - // (undocumented) - type: string[] - // (undocumented) - verifier?: Identity[] -} - -// @public (undocumented) -export class Service extends BaseEntity { - // (undocumented) - description?: string - // (undocumented) - id: string - // (undocumented) - identity: Identity - // (undocumented) - serviceEndpoint: string - // (undocumented) - type: string -} - -// @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 TIdentitiesColumns = '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 "daf-typeorm" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { AbstractIdentityStore } from 'daf-identity-manager'; +import { AbstractKeyStore } from 'daf-key-manager'; +import { AbstractSecretBox } from 'daf-key-manager'; +import { BaseEntity } from 'typeorm'; +import { Connection } from 'typeorm'; +import { IAgentPlugin } from 'daf-core'; +import { IDataStore } from 'daf-core'; +import { IDataStoreGetMessageArgs } from 'daf-core'; +import { IDataStoreGetVerifiableCredentialArgs } from 'daf-core'; +import { IDataStoreGetVerifiablePresentationArgs } from 'daf-core'; +import { IDataStoreSaveMessageArgs } from 'daf-core'; +import { IDataStoreSaveVerifiableCredentialArgs } from 'daf-core'; +import { IDataStoreSaveVerifiablePresentationArgs } from 'daf-core'; +import { IIdentity } from 'daf-core'; +import { IKey } from 'daf-core'; +import { IMessage } from 'daf-core'; +import { IPluginMethodMap } from 'daf-core'; +import { VerifiableCredential } from 'daf-core'; +import { VerifiablePresentation } from 'daf-core'; + +// @public (undocumented) +export class Claim extends BaseEntity { + // (undocumented) + context: string[]; + // (undocumented) + credential: Credential_2; + // (undocumented) + credentialType: string[]; + // (undocumented) + expirationDate?: Date; + // (undocumented) + hash: string; + // (undocumented) + isObj: boolean; + // (undocumented) + issuanceDate: Date; + // (undocumented) + issuer: Identity; + // (undocumented) + subject?: Identity; + // (undocumented) + type: string; + // (undocumented) + value: string | 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: Identity; + // (undocumented) + messages: Message[]; + // (undocumented) + presentations: Presentation[]; + set raw(raw: VerifiableCredential); + // (undocumented) + get raw(): VerifiableCredential; + // (undocumented) + subject?: Identity; + // (undocumented) + type: string[]; +} + +export { Credential_2 as Credential } + +// @public (undocumented) +export class DataStore implements IAgentPlugin { + constructor(dbConnection: Promise); + // (undocumented) + 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 "PartialIdentity" needs to be exported by the entry point index.d.ts + // + // (undocumented) + dataStoreORMGetIdentities(args: FindArgs, context: IContext): Promise; + // (undocumented) + dataStoreORMGetIdentitiesCount(args: FindArgs, context: IContext): Promise; + // (undocumented) + dataStoreORMGetMessages(args: FindArgs, context: IContext): Promise; + // (undocumented) + dataStoreORMGetMessagesCount(args: FindArgs, context: IContext): Promise; + // (undocumented) + dataStoreORMGetVerifiableCredentials(args: FindArgs, context: IContext): Promise>; + // (undocumented) + dataStoreORMGetVerifiableCredentialsByClaims(args: FindArgs, context: IContext): Promise>; + // (undocumented) + dataStoreORMGetVerifiableCredentialsByClaimsCount(args: FindArgs, context: IContext): Promise; + // (undocumented) + dataStoreORMGetVerifiableCredentialsCount(args: FindArgs, context: IContext): Promise; + // (undocumented) + dataStoreORMGetVerifiablePresentations(args: FindArgs, context: IContext): Promise>; + // (undocumented) + dataStoreORMGetVerifiablePresentationsCount(args: FindArgs, context: IContext): Promise; + // (undocumented) + readonly methods: IDataStoreORM; + // (undocumented) + readonly schema: any; +} + +// @public (undocumented) +export const Entities: (typeof Key | typeof Identity | typeof Service | typeof Claim | typeof Credential_2 | typeof Presentation | typeof Message)[]; + +// @public (undocumented) +export interface FindArgs { + // (undocumented) + order?: Order[]; + // (undocumented) + skip?: number; + // (undocumented) + take?: number; + // (undocumented) + where?: Where[]; +} + +// @public (undocumented) +export type FindClaimsArgs = FindArgs; + +// @public (undocumented) +export type FindCredentialsArgs = FindArgs; + +// @public (undocumented) +export type FindIdentitiesArgs = FindArgs; + +// @public (undocumented) +export type FindMessagesArgs = FindArgs; + +// @public (undocumented) +export type FindPresentationsArgs = FindArgs; + +// @public (undocumented) +export interface IDataStoreORM extends IPluginMethodMap { + // (undocumented) + dataStoreORMGetIdentities(args: FindIdentitiesArgs, context: IContext): Promise>; + // (undocumented) + dataStoreORMGetIdentitiesCount(args: FindIdentitiesArgs, context: IContext): Promise; + // (undocumented) + dataStoreORMGetMessages(args: FindMessagesArgs, context: IContext): Promise>; + // (undocumented) + dataStoreORMGetMessagesCount(args: FindMessagesArgs, context: IContext): Promise; + // (undocumented) + dataStoreORMGetVerifiableCredentials(args: FindCredentialsArgs, context: IContext): Promise>; + // (undocumented) + dataStoreORMGetVerifiableCredentialsByClaims(args: FindClaimsArgs, context: IContext): Promise>; + // (undocumented) + dataStoreORMGetVerifiableCredentialsByClaimsCount(args: FindClaimsArgs, context: IContext): Promise; + // (undocumented) + dataStoreORMGetVerifiableCredentialsCount(args: FindCredentialsArgs, context: IContext): Promise; + // (undocumented) + dataStoreORMGetVerifiablePresentations(args: FindPresentationsArgs, context: IContext): Promise>; + // (undocumented) + dataStoreORMGetVerifiablePresentationsCount(args: FindPresentationsArgs, context: IContext): Promise; +} + +// @public (undocumented) +export class Identity extends BaseEntity { + // (undocumented) + alias?: string; + // (undocumented) + controllerKeyId: string; + // (undocumented) + did: string; + getLatestClaimValue(dbConnection: Promise, where: { + type: string; + }): Promise; + // (undocumented) + issuedClaims: Claim[]; + // (undocumented) + issuedCredentials: Credential_2[]; + // (undocumented) + issuedPresentations: Presentation[]; + // (undocumented) + keys: Key[]; + // (undocumented) + provider: string; + // (undocumented) + receivedClaims: Claim[]; + // (undocumented) + receivedCredentials: Credential_2[]; + // (undocumented) + receivedMessages: Message[]; + // (undocumented) + receivedPresentations: Presentation[]; + // (undocumented) + saveDate: Date; + // (undocumented) + sentMessages: Message[]; + // (undocumented) + services: Service[]; + // (undocumented) + shortDid(): string; + // (undocumented) + updateDate: Date; +} + +// @public (undocumented) +export class IdentityStore extends AbstractIdentityStore { + constructor(dbConnection: Promise); + // (undocumented) + delete({ did }: { + did: string; + }): Promise; + // (undocumented) + get({ did, alias, provider }: { + did: string; + alias: string; + provider: string; + }): Promise; + // (undocumented) + import(args: IIdentity): Promise; + // (undocumented) + list(args: { + alias?: string; + provider?: string; + }): Promise; +} + +// @public (undocumented) +export class Key extends BaseEntity { + // (undocumented) + identity: Identity; + // (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?: Identity; + // (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?: Identity; + // (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: Identity; + // (undocumented) + id?: String; + // (undocumented) + issuanceDate: Date; + // (undocumented) + messages: Message[]; + set raw(raw: VerifiablePresentation); + // (undocumented) + get raw(): VerifiablePresentation; + // (undocumented) + type: string[]; + // (undocumented) + verifier?: Identity[]; +} + +// @public (undocumented) +export const schema: any; + +// @public (undocumented) +export class Service extends BaseEntity { + // (undocumented) + description?: string; + // (undocumented) + id: string; + // (undocumented) + identity: Identity; + // (undocumented) + serviceEndpoint: string; + // (undocumented) + type: string; +} + +// @public (undocumented) +export type TClaimsColumns = 'context' | 'credentialType' | 'type' | 'value' | 'isObj' | 'id' | 'issuer' | 'subject' | 'expirationDate' | 'issuanceDate'; + +// @public (undocumented) +export type TCredentialColumns = 'context' | 'type' | 'id' | 'issuer' | 'subject' | 'expirationDate' | 'issuanceDate'; + +// @public (undocumented) +export type TIdentitiesColumns = '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/daf-typeorm/package.json b/packages/daf-typeorm/package.json index 78367a2bf..c7eb519f8 100644 --- a/packages/daf-typeorm/package.json +++ b/packages/daf-typeorm/package.json @@ -6,8 +6,7 @@ "types": "build/index.d.ts", "scripts": { "build": "tsc", - "extract-api": "daf extractPluginApi -c ./api-extractor.json", - "generate-schema": "daf generatePluginSchema" + "generate-plugin-schema": "yarn daf generate-plugin-schema" }, "daf": { "pluginInterfaces": { @@ -29,6 +28,7 @@ "files": [ "build/**/*", "src/**/*", + "plugin.schema.json", "README.md", "LICENSE" ], diff --git a/packages/daf-typeorm/plugin.schema.json b/packages/daf-typeorm/plugin.schema.json new file mode 100644 index 000000000..7b16f53a4 --- /dev/null +++ b/packages/daf-typeorm/plugin.schema.json @@ -0,0 +1,964 @@ +{ + "IDataStoreORM": { + "components": { + "schemas": { + "FindIdentitiesArgs": { + "$ref": "#/components/schemas/FindArgs-TIdentitiesColumns" + }, + "FindArgs-TIdentitiesColumns": { + "type": "object", + "properties": { + "where": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Where-TIdentitiesColumns" + } + }, + "order": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order-TIdentitiesColumns" + } + }, + "take": { + "type": "number" + }, + "skip": { + "type": "number" + } + } + }, + "Where-TIdentitiesColumns": { + "type": "object", + "properties": { + "column": { + "$ref": "#/components/schemas/TIdentitiesColumns" + }, + "value": { + "type": "array", + "items": { + "type": "string" + } + }, + "not": { + "type": "boolean" + }, + "op": { + "type": "string", + "enum": [ + "LessThan", + "LessThanOrEqual", + "MoreThan", + "MoreThanOrEqual", + "Equal", + "Like", + "Between", + "In", + "Any", + "IsNull" + ] + } + }, + "required": [ + "column" + ] + }, + "TIdentitiesColumns": { + "type": "string", + "enum": [ + "did", + "alias", + "provider" + ] + }, + "Order-TIdentitiesColumns": { + "type": "object", + "properties": { + "column": { + "$ref": "#/components/schemas/TIdentitiesColumns" + }, + "direction": { + "type": "string", + "enum": [ + "ASC", + "DESC" + ] + } + }, + "required": [ + "column", + "direction" + ] + }, + "PartialIdentity": { + "type": "object", + "properties": { + "did": { + "type": "string", + "description": "Decentralized identifier" + }, + "alias": { + "type": "string", + "description": "Optional. Identity alias. Can be used to reference an object in an external system" + }, + "provider": { + "type": "string", + "description": "Identity provider name" + }, + "controllerKeyId": { + "type": "string", + "description": "Controller key id" + }, + "keys": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IKey" + }, + "description": "Array of managed keys" + }, + "services": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IService" + }, + "description": "Array of services" + } + } + }, + "IKey": { + "type": "object", + "properties": { + "kid": { + "type": "string", + "description": "Key ID" + }, + "kms": { + "type": "string", + "description": "Key Management System" + }, + "type": { + "$ref": "#/components/schemas/TKeyType", + "description": "Key type" + }, + "publicKeyHex": { + "type": "string", + "description": "Public key" + }, + "privateKeyHex": { + "type": "string", + "description": "Optional. Private key" + }, + "meta": { + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "description": "Optional. Key metadata. Can be used to store auth data to access remote kms" + } + }, + "required": [ + "kid", + "kms", + "type", + "publicKeyHex" + ], + "description": "Cryptographic key" + }, + "TKeyType": { + "type": "string", + "enum": [ + "Ed25519", + "Secp256k1" + ], + "description": "Cryptographic key type" + }, + "IService": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID" + }, + "type": { + "type": "string", + "description": "Service type" + }, + "serviceEndpoint": { + "type": "string", + "description": "Endpoint URL" + }, + "description": { + "type": "string", + "description": "Optional. Description" + } + }, + "required": [ + "id", + "type", + "serviceEndpoint" + ], + "description": "Identity service" + }, + "FindMessagesArgs": { + "$ref": "#/components/schemas/FindArgs-TMessageColumns" + }, + "FindArgs-TMessageColumns": { + "type": "object", + "properties": { + "where": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Where-TMessageColumns" + } + }, + "order": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order-TMessageColumns" + } + }, + "take": { + "type": "number" + }, + "skip": { + "type": "number" + } + } + }, + "Where-TMessageColumns": { + "type": "object", + "properties": { + "column": { + "$ref": "#/components/schemas/TMessageColumns" + }, + "value": { + "type": "array", + "items": { + "type": "string" + } + }, + "not": { + "type": "boolean" + }, + "op": { + "type": "string", + "enum": [ + "LessThan", + "LessThanOrEqual", + "MoreThan", + "MoreThanOrEqual", + "Equal", + "Like", + "Between", + "In", + "Any", + "IsNull" + ] + } + }, + "required": [ + "column" + ] + }, + "TMessageColumns": { + "type": "string", + "enum": [ + "from", + "to", + "id", + "createdAt", + "expiresAt", + "threadId", + "type", + "raw", + "replyTo", + "replyUrl" + ] + }, + "Order-TMessageColumns": { + "type": "object", + "properties": { + "column": { + "$ref": "#/components/schemas/TMessageColumns" + }, + "direction": { + "type": "string", + "enum": [ + "ASC", + "DESC" + ] + } + }, + "required": [ + "column", + "direction" + ] + }, + "IMessage": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique message ID" + }, + "type": { + "type": "string", + "description": "Message type" + }, + "createdAt": { + "type": "string", + "description": "Optional. Creation date (ISO 8601)" + }, + "expiresAt": { + "type": "string", + "description": "Optional. Expiration date (ISO 8601)" + }, + "threadId": { + "type": "string", + "description": "Optional. Thread ID" + }, + "raw": { + "type": "string", + "description": "Optional. Original message raw data" + }, + "data": { + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "description": "Optional. Parsed data" + }, + "replyTo": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional. List of DIDs to reply to" + }, + "replyUrl": { + "type": "string", + "description": "Optional. URL to post a reply message to" + }, + "from": { + "type": "string", + "description": "Optional. Sender DID" + }, + "to": { + "type": "string", + "description": "Optional. Recipient DID" + }, + "metaData": { + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/IMetaData" + } + }, + { + "type": "null" + } + ], + "description": "Optional. Array of message metadata" + }, + "credentials": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VerifiableCredential" + }, + "description": "Optional. Array of attached verifiable credentials" + }, + "presentations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VerifiablePresentation" + }, + "description": "Optional. Array of attached verifiable presentations" + } + }, + "required": [ + "id", + "type" + ], + "description": "DIDComm message" + }, + "IMetaData": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type" + }, + "value": { + "type": "string", + "description": "Optional. Value" + } + }, + "required": [ + "type" + ], + "description": "Message meta data" + }, + "VerifiableCredential": { + "type": "object", + "properties": { + "@context": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string" + }, + "type": { + "type": "array", + "items": { + "type": "string" + } + }, + "issuer": { + "type": "object", + "properties": { + "id": { + "type": "string" + } + }, + "required": [ + "id" + ] + }, + "issuanceDate": { + "type": "string" + }, + "expirationDate": { + "type": "string" + }, + "credentialSubject": { + "type": "object", + "properties": { + "id": { + "type": "string" + } + } + }, + "credentialStatus": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + }, + "proof": { + "type": "object", + "properties": { + "type": { + "type": "string" + } + } + } + }, + "required": [ + "@context", + "type", + "issuer", + "issuanceDate", + "credentialSubject", + "proof" + ], + "description": "Verifiable Credential {@link https://github.com/decentralized-identity/did-jwt-vc}" + }, + "VerifiablePresentation": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "holder": { + "type": "string" + }, + "issuanceDate": { + "type": "string" + }, + "expirationDate": { + "type": "string" + }, + "@context": { + "type": "array", + "items": { + "type": "string" + } + }, + "type": { + "type": "array", + "items": { + "type": "string" + } + }, + "verifier": { + "type": "array", + "items": { + "type": "string" + } + }, + "verifiableCredential": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VerifiableCredential" + } + }, + "proof": { + "type": "object", + "properties": { + "type": { + "type": "string" + } + } + } + }, + "required": [ + "holder", + "@context", + "type", + "verifier", + "verifiableCredential", + "proof" + ], + "description": "Verifiable Presentation {@link https://github.com/decentralized-identity/did-jwt-vc}" + }, + "FindCredentialsArgs": { + "$ref": "#/components/schemas/FindArgs-TCredentialColumns" + }, + "FindArgs-TCredentialColumns": { + "type": "object", + "properties": { + "where": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Where-TCredentialColumns" + } + }, + "order": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order-TCredentialColumns" + } + }, + "take": { + "type": "number" + }, + "skip": { + "type": "number" + } + } + }, + "Where-TCredentialColumns": { + "type": "object", + "properties": { + "column": { + "$ref": "#/components/schemas/TCredentialColumns" + }, + "value": { + "type": "array", + "items": { + "type": "string" + } + }, + "not": { + "type": "boolean" + }, + "op": { + "type": "string", + "enum": [ + "LessThan", + "LessThanOrEqual", + "MoreThan", + "MoreThanOrEqual", + "Equal", + "Like", + "Between", + "In", + "Any", + "IsNull" + ] + } + }, + "required": [ + "column" + ] + }, + "TCredentialColumns": { + "type": "string", + "enum": [ + "context", + "type", + "id", + "issuer", + "subject", + "expirationDate", + "issuanceDate" + ] + }, + "Order-TCredentialColumns": { + "type": "object", + "properties": { + "column": { + "$ref": "#/components/schemas/TCredentialColumns" + }, + "direction": { + "type": "string", + "enum": [ + "ASC", + "DESC" + ] + } + }, + "required": [ + "column", + "direction" + ] + }, + "UniqueVerifiableCredential": { + "type": "object", + "properties": { + "hash": { + "type": "string" + }, + "verifiableCredential": { + "$ref": "#/components/schemas/VerifiableCredential" + } + }, + "required": [ + "hash", + "verifiableCredential" + ] + }, + "FindClaimsArgs": { + "$ref": "#/components/schemas/FindArgs-TClaimsColumns" + }, + "FindArgs-TClaimsColumns": { + "type": "object", + "properties": { + "where": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Where-TClaimsColumns" + } + }, + "order": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order-TClaimsColumns" + } + }, + "take": { + "type": "number" + }, + "skip": { + "type": "number" + } + } + }, + "Where-TClaimsColumns": { + "type": "object", + "properties": { + "column": { + "$ref": "#/components/schemas/TClaimsColumns" + }, + "value": { + "type": "array", + "items": { + "type": "string" + } + }, + "not": { + "type": "boolean" + }, + "op": { + "type": "string", + "enum": [ + "LessThan", + "LessThanOrEqual", + "MoreThan", + "MoreThanOrEqual", + "Equal", + "Like", + "Between", + "In", + "Any", + "IsNull" + ] + } + }, + "required": [ + "column" + ] + }, + "TClaimsColumns": { + "type": "string", + "enum": [ + "context", + "credentialType", + "type", + "value", + "isObj", + "id", + "issuer", + "subject", + "expirationDate", + "issuanceDate" + ] + }, + "Order-TClaimsColumns": { + "type": "object", + "properties": { + "column": { + "$ref": "#/components/schemas/TClaimsColumns" + }, + "direction": { + "type": "string", + "enum": [ + "ASC", + "DESC" + ] + } + }, + "required": [ + "column", + "direction" + ] + }, + "FindPresentationsArgs": { + "$ref": "#/components/schemas/FindArgs-TPresentationColumns" + }, + "FindArgs-TPresentationColumns": { + "type": "object", + "properties": { + "where": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Where-TPresentationColumns" + } + }, + "order": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order-TPresentationColumns" + } + }, + "take": { + "type": "number" + }, + "skip": { + "type": "number" + } + } + }, + "Where-TPresentationColumns": { + "type": "object", + "properties": { + "column": { + "$ref": "#/components/schemas/TPresentationColumns" + }, + "value": { + "type": "array", + "items": { + "type": "string" + } + }, + "not": { + "type": "boolean" + }, + "op": { + "type": "string", + "enum": [ + "LessThan", + "LessThanOrEqual", + "MoreThan", + "MoreThanOrEqual", + "Equal", + "Like", + "Between", + "In", + "Any", + "IsNull" + ] + } + }, + "required": [ + "column" + ] + }, + "TPresentationColumns": { + "type": "string", + "enum": [ + "context", + "type", + "id", + "holder", + "verifier", + "expirationDate", + "issuanceDate" + ] + }, + "Order-TPresentationColumns": { + "type": "object", + "properties": { + "column": { + "$ref": "#/components/schemas/TPresentationColumns" + }, + "direction": { + "type": "string", + "enum": [ + "ASC", + "DESC" + ] + } + }, + "required": [ + "column", + "direction" + ] + }, + "UniqueVerifiablePresentation": { + "type": "object", + "properties": { + "hash": { + "type": "string" + }, + "verifiablePresentation": { + "$ref": "#/components/schemas/VerifiablePresentation" + } + }, + "required": [ + "hash", + "verifiablePresentation" + ] + } + }, + "methods": { + "dataStoreORMGetIdentities": { + "description": "", + "arguments": { + "$ref": "#/components/schemas/FindIdentitiesArgs" + }, + "returnType": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartialIdentity" + } + } + }, + "dataStoreORMGetIdentitiesCount": { + "description": "", + "arguments": { + "$ref": "#/components/schemas/FindIdentitiesArgs" + }, + "returnType": { + "type": "number" + } + }, + "dataStoreORMGetMessages": { + "description": "", + "arguments": { + "$ref": "#/components/schemas/FindMessagesArgs" + }, + "returnType": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IMessage" + } + } + }, + "dataStoreORMGetMessagesCount": { + "description": "", + "arguments": { + "$ref": "#/components/schemas/FindMessagesArgs" + }, + "returnType": { + "type": "number" + } + }, + "dataStoreORMGetVerifiableCredentials": { + "description": "", + "arguments": { + "$ref": "#/components/schemas/FindCredentialsArgs" + }, + "returnType": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UniqueVerifiableCredential" + } + } + }, + "dataStoreORMGetVerifiableCredentialsByClaims": { + "description": "", + "arguments": { + "$ref": "#/components/schemas/FindClaimsArgs" + }, + "returnType": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UniqueVerifiableCredential" + } + } + }, + "dataStoreORMGetVerifiableCredentialsByClaimsCount": { + "description": "", + "arguments": { + "$ref": "#/components/schemas/FindClaimsArgs" + }, + "returnType": { + "type": "number" + } + }, + "dataStoreORMGetVerifiableCredentialsCount": { + "description": "", + "arguments": { + "$ref": "#/components/schemas/FindCredentialsArgs" + }, + "returnType": { + "type": "number" + } + }, + "dataStoreORMGetVerifiablePresentations": { + "description": "", + "arguments": { + "$ref": "#/components/schemas/FindPresentationsArgs" + }, + "returnType": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UniqueVerifiablePresentation" + } + } + }, + "dataStoreORMGetVerifiablePresentationsCount": { + "description": "", + "arguments": { + "$ref": "#/components/schemas/FindPresentationsArgs" + }, + "returnType": { + "type": "number" + } + } + } + } + } +} \ No newline at end of file diff --git a/packages/daf-typeorm/schema.config.json b/packages/daf-typeorm/schema.config.json deleted file mode 100644 index 2c9714017..000000000 --- a/packages/daf-typeorm/schema.config.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "entryPoint": "src/index.ts", - "schemasPath": "schemas/", - "api": "api/daf-typeorm.api.json", - "interfaces": ["IDataStoreORM"] -} \ No newline at end of file diff --git a/packages/daf-typeorm/src/data-store-orm.ts b/packages/daf-typeorm/src/data-store-orm.ts index b1b86f0af..b564a362d 100644 --- a/packages/daf-typeorm/src/data-store-orm.ts +++ b/packages/daf-typeorm/src/data-store-orm.ts @@ -37,7 +37,7 @@ import { FindArgs, } from './types' -import schema from './schemas/IDataStoreORM' +import { schema } from './' interface IContext { authenticatedDid?: string @@ -84,7 +84,7 @@ export interface IDataStoreORM extends IPluginMethodMap { export class DataStoreORM implements IAgentPlugin { readonly methods: IDataStoreORM - readonly schema = schema + readonly schema = schema.IDataStoreORM private dbConnection: Promise constructor(dbConnection: Promise) { @@ -132,7 +132,7 @@ export class DataStoreORM implements IAgentPlugin { context: IContext, ): Promise { const identities = await (await this.identitiesQuery(args, context)).getMany() - return identities.map(i => { + return identities.map((i) => { const identity: PartialIdentity = i if (identity.controllerKeyId === null) { delete identity.controllerKeyId diff --git a/packages/daf-typeorm/src/data-store.ts b/packages/daf-typeorm/src/data-store.ts index d644a5064..a82c584a7 100644 --- a/packages/daf-typeorm/src/data-store.ts +++ b/packages/daf-typeorm/src/data-store.ts @@ -10,8 +10,8 @@ import { IMessage, VerifiableCredential, VerifiablePresentation, + schema, } from 'daf-core' -import schema from 'daf-core/build/schemas/IDataStore' import { Message, createMessageEntity, createMessage } from './entities/message' import { Credential, createCredentialEntity } from './entities/credential' import { Presentation, createPresentationEntity } from './entities/presentation' @@ -19,7 +19,7 @@ import { Connection } from 'typeorm' export class DataStore implements IAgentPlugin { readonly methods: IDataStore - readonly schema = schema + readonly schema = schema.IDataStore private dbConnection: Promise constructor(dbConnection: Promise) { @@ -45,7 +45,7 @@ export class DataStore implements IAgentPlugin { async dataStoreGetMessage(args: IDataStoreGetMessageArgs): Promise { try { const messageEntity = await (await this.dbConnection).getRepository(Message).findOneOrFail(args.id, { - relations: ['credentials', 'presentations'] + relations: ['credentials', 'presentations'], }) return createMessage(messageEntity) } catch (e) { diff --git a/packages/daf-typeorm/src/index.ts b/packages/daf-typeorm/src/index.ts index e6b9f6686..393b9340c 100644 --- a/packages/daf-typeorm/src/index.ts +++ b/packages/daf-typeorm/src/index.ts @@ -29,3 +29,5 @@ import { Message, MetaData } from './entities/message' export const Entities = [Key, Identity, Message, Claim, Credential, Presentation, Service] export { KeyType, Key, Identity, Message, Claim, Credential, Presentation, MetaData, Service } export { migrations } from './migrations' +const schema = require('../plugin.schema.json') +export { schema } diff --git a/packages/daf-typeorm/src/schemas/IDataStoreORM.ts b/packages/daf-typeorm/src/schemas/IDataStoreORM.ts deleted file mode 100644 index cd8bbbf2b..000000000 --- a/packages/daf-typeorm/src/schemas/IDataStoreORM.ts +++ /dev/null @@ -1,962 +0,0 @@ -export default { - "components": { - "schemas": { - "FindIdentitiesArgs": { - "$ref": "#/components/schemas/FindArgs-TIdentitiesColumns" - }, - "FindArgs-TIdentitiesColumns": { - "type": "object", - "properties": { - "where": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Where-TIdentitiesColumns" - } - }, - "order": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Order-TIdentitiesColumns" - } - }, - "take": { - "type": "number" - }, - "skip": { - "type": "number" - } - } - }, - "Where-TIdentitiesColumns": { - "type": "object", - "properties": { - "column": { - "$ref": "#/components/schemas/TIdentitiesColumns" - }, - "value": { - "type": "array", - "items": { - "type": "string" - } - }, - "not": { - "type": "boolean" - }, - "op": { - "type": "string", - "enum": [ - "LessThan", - "LessThanOrEqual", - "MoreThan", - "MoreThanOrEqual", - "Equal", - "Like", - "Between", - "In", - "Any", - "IsNull" - ] - } - }, - "required": [ - "column" - ] - }, - "TIdentitiesColumns": { - "type": "string", - "enum": [ - "did", - "alias", - "provider" - ] - }, - "Order-TIdentitiesColumns": { - "type": "object", - "properties": { - "column": { - "$ref": "#/components/schemas/TIdentitiesColumns" - }, - "direction": { - "type": "string", - "enum": [ - "ASC", - "DESC" - ] - } - }, - "required": [ - "column", - "direction" - ] - }, - "PartialIdentity": { - "type": "object", - "properties": { - "did": { - "type": "string", - "description": "Decentralized identifier" - }, - "alias": { - "type": "string", - "description": "Optional. Identity alias. Can be used to reference an object in an external system" - }, - "provider": { - "type": "string", - "description": "Identity provider name" - }, - "controllerKeyId": { - "type": "string", - "description": "Controller key id" - }, - "keys": { - "type": "array", - "items": { - "$ref": "#/components/schemas/IKey" - }, - "description": "Array of managed keys" - }, - "services": { - "type": "array", - "items": { - "$ref": "#/components/schemas/IService" - }, - "description": "Array of services" - } - } - }, - "IKey": { - "type": "object", - "properties": { - "kid": { - "type": "string", - "description": "Key ID" - }, - "kms": { - "type": "string", - "description": "Key Management System" - }, - "type": { - "$ref": "#/components/schemas/TKeyType", - "description": "Key type" - }, - "publicKeyHex": { - "type": "string", - "description": "Public key" - }, - "privateKeyHex": { - "type": "string", - "description": "Optional. Private key" - }, - "meta": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "description": "Optional. Key metadata. Can be used to store auth data to access remote kms" - } - }, - "required": [ - "kid", - "kms", - "type", - "publicKeyHex" - ], - "description": "Cryptographic key" - }, - "TKeyType": { - "type": "string", - "enum": [ - "Ed25519", - "Secp256k1" - ], - "description": "Cryptographic key type" - }, - "IService": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "ID" - }, - "type": { - "type": "string", - "description": "Service type" - }, - "serviceEndpoint": { - "type": "string", - "description": "Endpoint URL" - }, - "description": { - "type": "string", - "description": "Optional. Description" - } - }, - "required": [ - "id", - "type", - "serviceEndpoint" - ], - "description": "Identity service" - }, - "FindMessagesArgs": { - "$ref": "#/components/schemas/FindArgs-TMessageColumns" - }, - "FindArgs-TMessageColumns": { - "type": "object", - "properties": { - "where": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Where-TMessageColumns" - } - }, - "order": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Order-TMessageColumns" - } - }, - "take": { - "type": "number" - }, - "skip": { - "type": "number" - } - } - }, - "Where-TMessageColumns": { - "type": "object", - "properties": { - "column": { - "$ref": "#/components/schemas/TMessageColumns" - }, - "value": { - "type": "array", - "items": { - "type": "string" - } - }, - "not": { - "type": "boolean" - }, - "op": { - "type": "string", - "enum": [ - "LessThan", - "LessThanOrEqual", - "MoreThan", - "MoreThanOrEqual", - "Equal", - "Like", - "Between", - "In", - "Any", - "IsNull" - ] - } - }, - "required": [ - "column" - ] - }, - "TMessageColumns": { - "type": "string", - "enum": [ - "from", - "to", - "id", - "createdAt", - "expiresAt", - "threadId", - "type", - "raw", - "replyTo", - "replyUrl" - ] - }, - "Order-TMessageColumns": { - "type": "object", - "properties": { - "column": { - "$ref": "#/components/schemas/TMessageColumns" - }, - "direction": { - "type": "string", - "enum": [ - "ASC", - "DESC" - ] - } - }, - "required": [ - "column", - "direction" - ] - }, - "IMessage": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique message ID" - }, - "type": { - "type": "string", - "description": "Message type" - }, - "createdAt": { - "type": "string", - "description": "Optional. Creation date (ISO 8601)" - }, - "expiresAt": { - "type": "string", - "description": "Optional. Expiration date (ISO 8601)" - }, - "threadId": { - "type": "string", - "description": "Optional. Thread ID" - }, - "raw": { - "type": "string", - "description": "Optional. Original message raw data" - }, - "data": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "description": "Optional. Parsed data" - }, - "replyTo": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Optional. List of DIDs to reply to" - }, - "replyUrl": { - "type": "string", - "description": "Optional. URL to post a reply message to" - }, - "from": { - "type": "string", - "description": "Optional. Sender DID" - }, - "to": { - "type": "string", - "description": "Optional. Recipient DID" - }, - "metaData": { - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/IMetaData" - } - }, - { - "type": "null" - } - ], - "description": "Optional. Array of message metadata" - }, - "credentials": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VerifiableCredential" - }, - "description": "Optional. Array of attached verifiable credentials" - }, - "presentations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VerifiablePresentation" - }, - "description": "Optional. Array of attached verifiable presentations" - } - }, - "required": [ - "id", - "type" - ], - "description": "DIDComm message" - }, - "IMetaData": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Type" - }, - "value": { - "type": "string", - "description": "Optional. Value" - } - }, - "required": [ - "type" - ], - "description": "Message meta data" - }, - "VerifiableCredential": { - "type": "object", - "properties": { - "@context": { - "type": "array", - "items": { - "type": "string" - } - }, - "id": { - "type": "string" - }, - "type": { - "type": "array", - "items": { - "type": "string" - } - }, - "issuer": { - "type": "object", - "properties": { - "id": { - "type": "string" - } - }, - "required": [ - "id" - ] - }, - "issuanceDate": { - "type": "string" - }, - "expirationDate": { - "type": "string" - }, - "credentialSubject": { - "type": "object", - "properties": { - "id": { - "type": "string" - } - } - }, - "credentialStatus": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "id", - "type" - ] - }, - "proof": { - "type": "object", - "properties": { - "type": { - "type": "string" - } - } - } - }, - "required": [ - "@context", - "type", - "issuer", - "issuanceDate", - "credentialSubject", - "proof" - ], - "description": "Verifiable Credential {@link https://github.com/decentralized-identity/did-jwt-vc}" - }, - "VerifiablePresentation": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "holder": { - "type": "string" - }, - "issuanceDate": { - "type": "string" - }, - "expirationDate": { - "type": "string" - }, - "@context": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "array", - "items": { - "type": "string" - } - }, - "verifier": { - "type": "array", - "items": { - "type": "string" - } - }, - "verifiableCredential": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VerifiableCredential" - } - }, - "proof": { - "type": "object", - "properties": { - "type": { - "type": "string" - } - } - } - }, - "required": [ - "holder", - "@context", - "type", - "verifier", - "verifiableCredential", - "proof" - ], - "description": "Verifiable Presentation {@link https://github.com/decentralized-identity/did-jwt-vc}" - }, - "FindCredentialsArgs": { - "$ref": "#/components/schemas/FindArgs-TCredentialColumns" - }, - "FindArgs-TCredentialColumns": { - "type": "object", - "properties": { - "where": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Where-TCredentialColumns" - } - }, - "order": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Order-TCredentialColumns" - } - }, - "take": { - "type": "number" - }, - "skip": { - "type": "number" - } - } - }, - "Where-TCredentialColumns": { - "type": "object", - "properties": { - "column": { - "$ref": "#/components/schemas/TCredentialColumns" - }, - "value": { - "type": "array", - "items": { - "type": "string" - } - }, - "not": { - "type": "boolean" - }, - "op": { - "type": "string", - "enum": [ - "LessThan", - "LessThanOrEqual", - "MoreThan", - "MoreThanOrEqual", - "Equal", - "Like", - "Between", - "In", - "Any", - "IsNull" - ] - } - }, - "required": [ - "column" - ] - }, - "TCredentialColumns": { - "type": "string", - "enum": [ - "context", - "type", - "id", - "issuer", - "subject", - "expirationDate", - "issuanceDate" - ] - }, - "Order-TCredentialColumns": { - "type": "object", - "properties": { - "column": { - "$ref": "#/components/schemas/TCredentialColumns" - }, - "direction": { - "type": "string", - "enum": [ - "ASC", - "DESC" - ] - } - }, - "required": [ - "column", - "direction" - ] - }, - "UniqueVerifiableCredential": { - "type": "object", - "properties": { - "hash": { - "type": "string" - }, - "verifiableCredential": { - "$ref": "#/components/schemas/VerifiableCredential" - } - }, - "required": [ - "hash", - "verifiableCredential" - ] - }, - "FindClaimsArgs": { - "$ref": "#/components/schemas/FindArgs-TClaimsColumns" - }, - "FindArgs-TClaimsColumns": { - "type": "object", - "properties": { - "where": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Where-TClaimsColumns" - } - }, - "order": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Order-TClaimsColumns" - } - }, - "take": { - "type": "number" - }, - "skip": { - "type": "number" - } - } - }, - "Where-TClaimsColumns": { - "type": "object", - "properties": { - "column": { - "$ref": "#/components/schemas/TClaimsColumns" - }, - "value": { - "type": "array", - "items": { - "type": "string" - } - }, - "not": { - "type": "boolean" - }, - "op": { - "type": "string", - "enum": [ - "LessThan", - "LessThanOrEqual", - "MoreThan", - "MoreThanOrEqual", - "Equal", - "Like", - "Between", - "In", - "Any", - "IsNull" - ] - } - }, - "required": [ - "column" - ] - }, - "TClaimsColumns": { - "type": "string", - "enum": [ - "context", - "credentialType", - "type", - "value", - "isObj", - "id", - "issuer", - "subject", - "expirationDate", - "issuanceDate" - ] - }, - "Order-TClaimsColumns": { - "type": "object", - "properties": { - "column": { - "$ref": "#/components/schemas/TClaimsColumns" - }, - "direction": { - "type": "string", - "enum": [ - "ASC", - "DESC" - ] - } - }, - "required": [ - "column", - "direction" - ] - }, - "FindPresentationsArgs": { - "$ref": "#/components/schemas/FindArgs-TPresentationColumns" - }, - "FindArgs-TPresentationColumns": { - "type": "object", - "properties": { - "where": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Where-TPresentationColumns" - } - }, - "order": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Order-TPresentationColumns" - } - }, - "take": { - "type": "number" - }, - "skip": { - "type": "number" - } - } - }, - "Where-TPresentationColumns": { - "type": "object", - "properties": { - "column": { - "$ref": "#/components/schemas/TPresentationColumns" - }, - "value": { - "type": "array", - "items": { - "type": "string" - } - }, - "not": { - "type": "boolean" - }, - "op": { - "type": "string", - "enum": [ - "LessThan", - "LessThanOrEqual", - "MoreThan", - "MoreThanOrEqual", - "Equal", - "Like", - "Between", - "In", - "Any", - "IsNull" - ] - } - }, - "required": [ - "column" - ] - }, - "TPresentationColumns": { - "type": "string", - "enum": [ - "context", - "type", - "id", - "holder", - "verifier", - "expirationDate", - "issuanceDate" - ] - }, - "Order-TPresentationColumns": { - "type": "object", - "properties": { - "column": { - "$ref": "#/components/schemas/TPresentationColumns" - }, - "direction": { - "type": "string", - "enum": [ - "ASC", - "DESC" - ] - } - }, - "required": [ - "column", - "direction" - ] - }, - "UniqueVerifiablePresentation": { - "type": "object", - "properties": { - "hash": { - "type": "string" - }, - "verifiablePresentation": { - "$ref": "#/components/schemas/VerifiablePresentation" - } - }, - "required": [ - "hash", - "verifiablePresentation" - ] - } - }, - "methods": { - "dataStoreORMGetIdentities": { - "description": "", - "arguments": { - "$ref": "#/components/schemas/FindIdentitiesArgs" - }, - "returnType": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PartialIdentity" - } - } - }, - "dataStoreORMGetIdentitiesCount": { - "description": "", - "arguments": { - "$ref": "#/components/schemas/FindIdentitiesArgs" - }, - "returnType": { - "type": "number" - } - }, - "dataStoreORMGetMessages": { - "description": "", - "arguments": { - "$ref": "#/components/schemas/FindMessagesArgs" - }, - "returnType": { - "type": "array", - "items": { - "$ref": "#/components/schemas/IMessage" - } - } - }, - "dataStoreORMGetMessagesCount": { - "description": "", - "arguments": { - "$ref": "#/components/schemas/FindMessagesArgs" - }, - "returnType": { - "type": "number" - } - }, - "dataStoreORMGetVerifiableCredentials": { - "description": "", - "arguments": { - "$ref": "#/components/schemas/FindCredentialsArgs" - }, - "returnType": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UniqueVerifiableCredential" - } - } - }, - "dataStoreORMGetVerifiableCredentialsByClaims": { - "description": "", - "arguments": { - "$ref": "#/components/schemas/FindClaimsArgs" - }, - "returnType": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UniqueVerifiableCredential" - } - } - }, - "dataStoreORMGetVerifiableCredentialsByClaimsCount": { - "description": "", - "arguments": { - "$ref": "#/components/schemas/FindClaimsArgs" - }, - "returnType": { - "type": "number" - } - }, - "dataStoreORMGetVerifiableCredentialsCount": { - "description": "", - "arguments": { - "$ref": "#/components/schemas/FindCredentialsArgs" - }, - "returnType": { - "type": "number" - } - }, - "dataStoreORMGetVerifiablePresentations": { - "description": "", - "arguments": { - "$ref": "#/components/schemas/FindPresentationsArgs" - }, - "returnType": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UniqueVerifiablePresentation" - } - } - }, - "dataStoreORMGetVerifiablePresentationsCount": { - "description": "", - "arguments": { - "$ref": "#/components/schemas/FindPresentationsArgs" - }, - "returnType": { - "type": "number" - } - } - } - } -} \ No newline at end of file diff --git a/packages/daf-url/package.json b/packages/daf-url/package.json index 4f907f297..60df3a4e8 100644 --- a/packages/daf-url/package.json +++ b/packages/daf-url/package.json @@ -6,7 +6,7 @@ "types": "build/index.d.ts", "scripts": { "build": "tsc", - "extract-api": "daf extractPluginApi -c ./api-extractor.json" + "extract-api": "yarn daf extract-api" }, "dependencies": { "daf-core": "^7.0.0-beta.49", diff --git a/packages/daf-w3c/api/daf-w3c.api.json b/packages/daf-w3c/api/daf-w3c.api.json index 9fd6f8563..3d567df6e 100644 --- a/packages/daf-w3c/api/daf-w3c.api.json +++ b/packages/daf-w3c/api/daf-w3c.api.json @@ -239,7 +239,7 @@ }, { "kind": "Content", - "text": "{\n components: {\n schemas: {\n ICreateVerifiableCredentialArgs: {\n type: string;\n properties: {\n credential: {\n $ref: string;\n description: string;\n };\n save: {\n type: string;\n description: string;\n };\n proofFormat: {\n $ref: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n W3CCredential: {\n type: string;\n properties: {\n \"@context\": {\n type: string;\n items: {\n type: string;\n };\n }; /**\n * The desired format for the VerifiablePresentation to be created.\n * Currently, only JWT is supported\n */\n id: {\n type: string;\n };\n type: {\n type: string;\n items: {\n type: string;\n };\n };\n issuer: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n };\n required: string[];\n };\n issuanceDate: {\n type: string;\n };\n expirationDate: {\n type: string;\n };\n credentialSubject: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n };\n };\n credentialStatus: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n type: {\n type: string;\n };\n };\n required: string[];\n };\n };\n required: string[];\n description: string;\n };\n EncodingFormat: {\n type: string;\n const: string;\n description: string;\n };\n VerifiableCredential: {\n type: string;\n properties: {\n \"@context\": {\n type: string;\n items: {\n type: string;\n };\n };\n id: {\n type: string;\n };\n type: {\n type: string;\n items: {\n type: string;\n };\n };\n issuer: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n };\n required: string[];\n };\n issuanceDate: {\n type: string;\n };\n expirationDate: {\n type: string;\n };\n credentialSubject: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n };\n };\n credentialStatus: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n type: {\n type: string;\n };\n };\n required: string[];\n };\n proof: {\n type: string;\n properties: {\n type: {\n type: string;\n };\n };\n };\n };\n required: string[];\n description: string;\n };\n ICreateVerifiablePresentationArgs: {\n type: string;\n properties: {\n presentation: {\n $ref: string;\n description: string;\n };\n save: {\n type: string;\n description: string;\n };\n proofFormat: {\n $ref: string;\n description: string;\n };\n };\n required: string[];\n description: string;\n };\n W3CPresentation: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n holder: {\n type: string;\n };\n issuanceDate: {\n type: string;\n };\n expirationDate: {\n type: string;\n };\n \"@context\": {\n type: string;\n items: {\n type: string;\n };\n };\n type: {\n type: string;\n items: {\n type: string;\n };\n };\n verifier: {\n type: string;\n items: {\n type: string;\n };\n };\n verifiableCredential: {\n type: string;\n items: {\n $ref: string;\n };\n };\n };\n required: string[];\n description: string;\n };\n VerifiablePresentation: {\n type: string;\n properties: {\n id: {\n type: string;\n };\n holder: {\n type: string;\n };\n issuanceDate: {\n type: string;\n };\n expirationDate: {\n type: string;\n };\n \"@context\": {\n type: string;\n items: {\n type: string;\n };\n };\n type: {\n type: string;\n items: {\n type: string;\n };\n };\n verifier: {\n type: string;\n items: {\n type: string;\n };\n };\n verifiableCredential: {\n type: string;\n items: {\n $ref: string;\n };\n };\n proof: {\n type: string;\n properties: {\n type: {\n type: string;\n };\n };\n };\n };\n required: string[];\n description: string;\n };\n };\n methods: {\n createVerifiableCredential: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n $ref: string;\n };\n };\n createVerifiablePresentation: {\n description: string;\n arguments: {\n $ref: string;\n };\n returnType: {\n $ref: string;\n };\n };\n };\n };\n }" + "text": "any" }, { "kind": "Content", @@ -626,6 +626,27 @@ } ] }, + { + "kind": "Variable", + "canonicalReference": "daf-w3c!schema:var", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "schema: " + }, + { + "kind": "Content", + "text": "any" + } + ], + "releaseTag": "Public", + "name": "schema", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, { "kind": "Class", "canonicalReference": "daf-w3c!W3cMessageHandler:class", diff --git a/packages/daf-w3c/api/daf-w3c.api.md b/packages/daf-w3c/api/daf-w3c.api.md index 70e1d7bd1..8376f9387 100644 --- a/packages/daf-w3c/api/daf-w3c.api.md +++ b/packages/daf-w3c/api/daf-w3c.api.md @@ -27,294 +27,7 @@ export class CredentialIssuer implements IAgentPlugin { // (undocumented) readonly methods: ICredentialIssuer; // (undocumented) - readonly schema: { - components: { - schemas: { - ICreateVerifiableCredentialArgs: { - type: string; - properties: { - credential: { - $ref: string; - description: string; - }; - save: { - type: string; - description: string; - }; - proofFormat: { - $ref: string; - description: string; - }; - }; - required: string[]; - description: string; - }; - W3CCredential: { - type: string; - properties: { - "@context": { - type: string; - items: { - type: string; - }; - }; /** - * The desired format for the VerifiablePresentation to be created. - * Currently, only JWT is supported - */ - id: { - type: string; - }; - type: { - type: string; - items: { - type: string; - }; - }; - issuer: { - type: string; - properties: { - id: { - type: string; - }; - }; - required: string[]; - }; - issuanceDate: { - type: string; - }; - expirationDate: { - type: string; - }; - credentialSubject: { - type: string; - properties: { - id: { - type: string; - }; - }; - }; - credentialStatus: { - type: string; - properties: { - id: { - type: string; - }; - type: { - type: string; - }; - }; - required: string[]; - }; - }; - required: string[]; - description: string; - }; - EncodingFormat: { - type: string; - const: string; - description: string; - }; - VerifiableCredential: { - type: string; - properties: { - "@context": { - type: string; - items: { - type: string; - }; - }; - id: { - type: string; - }; - type: { - type: string; - items: { - type: string; - }; - }; - issuer: { - type: string; - properties: { - id: { - type: string; - }; - }; - required: string[]; - }; - issuanceDate: { - type: string; - }; - expirationDate: { - type: string; - }; - credentialSubject: { - type: string; - properties: { - id: { - type: string; - }; - }; - }; - credentialStatus: { - type: string; - properties: { - id: { - type: string; - }; - type: { - type: string; - }; - }; - required: string[]; - }; - proof: { - type: string; - properties: { - type: { - type: string; - }; - }; - }; - }; - required: string[]; - description: string; - }; - ICreateVerifiablePresentationArgs: { - type: string; - properties: { - presentation: { - $ref: string; - description: string; - }; - save: { - type: string; - description: string; - }; - proofFormat: { - $ref: string; - description: string; - }; - }; - required: string[]; - description: string; - }; - W3CPresentation: { - type: string; - properties: { - id: { - type: string; - }; - holder: { - type: string; - }; - issuanceDate: { - type: string; - }; - expirationDate: { - type: string; - }; - "@context": { - type: string; - items: { - type: string; - }; - }; - type: { - type: string; - items: { - type: string; - }; - }; - verifier: { - type: string; - items: { - type: string; - }; - }; - verifiableCredential: { - type: string; - items: { - $ref: string; - }; - }; - }; - required: string[]; - description: string; - }; - VerifiablePresentation: { - type: string; - properties: { - id: { - type: string; - }; - holder: { - type: string; - }; - issuanceDate: { - type: string; - }; - expirationDate: { - type: string; - }; - "@context": { - type: string; - items: { - type: string; - }; - }; - type: { - type: string; - items: { - type: string; - }; - }; - verifier: { - type: string; - items: { - type: string; - }; - }; - verifiableCredential: { - type: string; - items: { - $ref: string; - }; - }; - proof: { - type: string; - properties: { - type: { - type: string; - }; - }; - }; - }; - required: string[]; - description: string; - }; - }; - methods: { - createVerifiableCredential: { - description: string; - arguments: { - $ref: string; - }; - returnType: { - $ref: string; - }; - }; - createVerifiablePresentation: { - description: string; - arguments: { - $ref: string; - }; - returnType: { - $ref: string; - }; - }; - }; - }; - }; + readonly schema: any; } // @public @@ -346,6 +59,9 @@ export const MessageTypes: { 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 diff --git a/packages/daf-w3c/package.json b/packages/daf-w3c/package.json index 9c4ba68a5..c4a9fd50b 100644 --- a/packages/daf-w3c/package.json +++ b/packages/daf-w3c/package.json @@ -6,8 +6,7 @@ "types": "build/index.d.ts", "scripts": { "build": "tsc", - "extract-api": "daf extractPluginApi -c ./api-extractor.json", - "generate-schema": "daf generatePluginSchema" + "generate-plugin-schema": "yarn daf generate-plugin-schema" }, "daf": { "pluginInterfaces": { @@ -31,6 +30,7 @@ "files": [ "build/**/*", "src/**/*", + "plugin.schema.json", "README.md", "LICENSE" ], diff --git a/packages/daf-w3c/plugin.schema.json b/packages/daf-w3c/plugin.schema.json new file mode 100644 index 000000000..b539fefb8 --- /dev/null +++ b/packages/daf-w3c/plugin.schema.json @@ -0,0 +1,329 @@ +{ + "ICredentialIssuer": { + "components": { + "schemas": { + "ICreateVerifiableCredentialArgs": { + "type": "object", + "properties": { + "credential": { + "$ref": "#/components/schemas/W3CCredential", + "description": "The json payload of the Credential according to the {@link https://www.w3.org/TR/vc-data-model/#credentials | canonical model}\n\nThe signer of the Credential is chosen based on the `issuer.id` property of the `credential`" + }, + "save": { + "type": "boolean", + "description": "If this parameter is true, the resulting VerifiablePresentation is sent to the {@link daf-core#IDataStore | storage plugin} to be saved" + }, + "proofFormat": { + "$ref": "#/components/schemas/EncodingFormat", + "description": "The desired format for the VerifiablePresentation to be created. Currently, only JWT is supported" + } + }, + "required": [ + "credential", + "proofFormat" + ], + "description": "Encapsulates the parameters required to create a {@link https://www.w3.org/TR/vc-data-model/#credentials | W3C Verifiable Credential}" + }, + "W3CCredential": { + "type": "object", + "properties": { + "@context": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string" + }, + "type": { + "type": "array", + "items": { + "type": "string" + } + }, + "issuer": { + "type": "object", + "properties": { + "id": { + "type": "string" + } + }, + "required": [ + "id" + ] + }, + "issuanceDate": { + "type": "string" + }, + "expirationDate": { + "type": "string" + }, + "credentialSubject": { + "type": "object", + "properties": { + "id": { + "type": "string" + } + } + }, + "credentialStatus": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "@context", + "type", + "issuer", + "issuanceDate", + "credentialSubject" + ], + "description": "W3CCredential {@link https://github.com/decentralized-identity/did-jwt-vc}" + }, + "EncodingFormat": { + "type": "string", + "const": "jwt", + "description": "The type of encoding to be used for the Verifiable Credential or Presentation to be generated.\n\nOnly `jwt` is supported at the moment." + }, + "VerifiableCredential": { + "type": "object", + "properties": { + "@context": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string" + }, + "type": { + "type": "array", + "items": { + "type": "string" + } + }, + "issuer": { + "type": "object", + "properties": { + "id": { + "type": "string" + } + }, + "required": [ + "id" + ] + }, + "issuanceDate": { + "type": "string" + }, + "expirationDate": { + "type": "string" + }, + "credentialSubject": { + "type": "object", + "properties": { + "id": { + "type": "string" + } + } + }, + "credentialStatus": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + }, + "proof": { + "type": "object", + "properties": { + "type": { + "type": "string" + } + } + } + }, + "required": [ + "@context", + "type", + "issuer", + "issuanceDate", + "credentialSubject", + "proof" + ], + "description": "Verifiable Credential {@link https://github.com/decentralized-identity/did-jwt-vc}" + }, + "ICreateVerifiablePresentationArgs": { + "type": "object", + "properties": { + "presentation": { + "$ref": "#/components/schemas/W3CPresentation", + "description": "The json payload of the Presentation according to the {@link https://www.w3.org/TR/vc-data-model/#presentations | canonical model}.\n\nThe signer of the Presentation is chosen based on the `holder` property of the `presentation`" + }, + "save": { + "type": "boolean", + "description": "If this parameter is true, the resulting VerifiablePresentation is sent to the {@link daf-core#IDataStore | storage plugin} to be saved" + }, + "proofFormat": { + "$ref": "#/components/schemas/EncodingFormat", + "description": "The desired format for the VerifiablePresentation to be created. Currently, only JWT is supported" + } + }, + "required": [ + "presentation", + "proofFormat" + ], + "description": "Encapsulates the parameters required to create a {@link https://www.w3.org/TR/vc-data-model/#presentations | W3C Verifiable Presentation}" + }, + "W3CPresentation": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "holder": { + "type": "string" + }, + "issuanceDate": { + "type": "string" + }, + "expirationDate": { + "type": "string" + }, + "@context": { + "type": "array", + "items": { + "type": "string" + } + }, + "type": { + "type": "array", + "items": { + "type": "string" + } + }, + "verifier": { + "type": "array", + "items": { + "type": "string" + } + }, + "verifiableCredential": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VerifiableCredential" + } + } + }, + "required": [ + "holder", + "@context", + "type", + "verifier", + "verifiableCredential" + ], + "description": "W3CPresentation {@link https://github.com/decentralized-identity/did-jwt-vc}" + }, + "VerifiablePresentation": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "holder": { + "type": "string" + }, + "issuanceDate": { + "type": "string" + }, + "expirationDate": { + "type": "string" + }, + "@context": { + "type": "array", + "items": { + "type": "string" + } + }, + "type": { + "type": "array", + "items": { + "type": "string" + } + }, + "verifier": { + "type": "array", + "items": { + "type": "string" + } + }, + "verifiableCredential": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VerifiableCredential" + } + }, + "proof": { + "type": "object", + "properties": { + "type": { + "type": "string" + } + } + } + }, + "required": [ + "holder", + "@context", + "type", + "verifier", + "verifiableCredential", + "proof" + ], + "description": "Verifiable Presentation {@link https://github.com/decentralized-identity/did-jwt-vc}" + } + }, + "methods": { + "createVerifiableCredential": { + "description": "Creates a Verifiable Credential. The payload, signer and format are chosen based on the ", + "arguments": { + "$ref": "#/components/schemas/ICreateVerifiableCredentialArgs" + }, + "returnType": { + "$ref": "#/components/schemas/VerifiableCredential" + } + }, + "createVerifiablePresentation": { + "description": "Creates a Verifiable Presentation. The payload, signer and format are chosen based on the ", + "arguments": { + "$ref": "#/components/schemas/ICreateVerifiablePresentationArgs" + }, + "returnType": { + "$ref": "#/components/schemas/VerifiablePresentation" + } + } + } + } + } +} \ No newline at end of file diff --git a/packages/daf-w3c/src/action-handler.ts b/packages/daf-w3c/src/action-handler.ts index aa037d3a6..ae33de1ea 100644 --- a/packages/daf-w3c/src/action-handler.ts +++ b/packages/daf-w3c/src/action-handler.ts @@ -19,7 +19,7 @@ import { normalizePresentation, } from 'did-jwt-vc' -import schema from './schemas/ICredentialIssuer' +import { schema } from './' import Debug from 'debug' const debug = Debug('daf:w3c:action-handler') @@ -154,7 +154,7 @@ export type IContext = IAgentContext< */ export class CredentialIssuer implements IAgentPlugin { readonly methods: ICredentialIssuer - readonly schema = schema + readonly schema = schema.ICredentialIssuer constructor() { this.methods = { diff --git a/packages/daf-w3c/src/index.ts b/packages/daf-w3c/src/index.ts index 52c4e70cc..100e60570 100644 --- a/packages/daf-w3c/src/index.ts +++ b/packages/daf-w3c/src/index.ts @@ -9,4 +9,6 @@ export { ICredentialIssuer, ICreateVerifiableCredentialArgs, ICreateVerifiablePresentationArgs, -} from './action-handler' \ No newline at end of file +} from './action-handler' +const schema = require('../plugin.schema.json') +export { schema } diff --git a/packages/daf-w3c/src/schemas/ICredentialIssuer.ts b/packages/daf-w3c/src/schemas/ICredentialIssuer.ts deleted file mode 100644 index 86916950a..000000000 --- a/packages/daf-w3c/src/schemas/ICredentialIssuer.ts +++ /dev/null @@ -1,327 +0,0 @@ -export default { - "components": { - "schemas": { - "ICreateVerifiableCredentialArgs": { - "type": "object", - "properties": { - "credential": { - "$ref": "#/components/schemas/W3CCredential", - "description": "The json payload of the Credential according to the {@link https://www.w3.org/TR/vc-data-model/#credentials | canonical model}\n\nThe signer of the Credential is chosen based on the `issuer.id` property of the `credential`" - }, - "save": { - "type": "boolean", - "description": "If this parameter is true, the resulting VerifiablePresentation is sent to the {@link daf-core#IDataStore | storage plugin} to be saved" - }, - "proofFormat": { - "$ref": "#/components/schemas/EncodingFormat", - "description": "The desired format for the VerifiablePresentation to be created. Currently, only JWT is supported" - } - }, - "required": [ - "credential", - "proofFormat" - ], - "description": "Encapsulates the parameters required to create a {@link https://www.w3.org/TR/vc-data-model/#credentials | W3C Verifiable Credential}" - }, - "W3CCredential": { - "type": "object", - "properties": { - "@context": { - "type": "array", - "items": { - "type": "string" - } - }, - "id": { - "type": "string" - }, - "type": { - "type": "array", - "items": { - "type": "string" - } - }, - "issuer": { - "type": "object", - "properties": { - "id": { - "type": "string" - } - }, - "required": [ - "id" - ] - }, - "issuanceDate": { - "type": "string" - }, - "expirationDate": { - "type": "string" - }, - "credentialSubject": { - "type": "object", - "properties": { - "id": { - "type": "string" - } - } - }, - "credentialStatus": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "id", - "type" - ] - } - }, - "required": [ - "@context", - "type", - "issuer", - "issuanceDate", - "credentialSubject" - ], - "description": "W3CCredential {@link https://github.com/decentralized-identity/did-jwt-vc}" - }, - "EncodingFormat": { - "type": "string", - "const": "jwt", - "description": "The type of encoding to be used for the Verifiable Credential or Presentation to be generated.\n\nOnly `jwt` is supported at the moment." - }, - "VerifiableCredential": { - "type": "object", - "properties": { - "@context": { - "type": "array", - "items": { - "type": "string" - } - }, - "id": { - "type": "string" - }, - "type": { - "type": "array", - "items": { - "type": "string" - } - }, - "issuer": { - "type": "object", - "properties": { - "id": { - "type": "string" - } - }, - "required": [ - "id" - ] - }, - "issuanceDate": { - "type": "string" - }, - "expirationDate": { - "type": "string" - }, - "credentialSubject": { - "type": "object", - "properties": { - "id": { - "type": "string" - } - } - }, - "credentialStatus": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "id", - "type" - ] - }, - "proof": { - "type": "object", - "properties": { - "type": { - "type": "string" - } - } - } - }, - "required": [ - "@context", - "type", - "issuer", - "issuanceDate", - "credentialSubject", - "proof" - ], - "description": "Verifiable Credential {@link https://github.com/decentralized-identity/did-jwt-vc}" - }, - "ICreateVerifiablePresentationArgs": { - "type": "object", - "properties": { - "presentation": { - "$ref": "#/components/schemas/W3CPresentation", - "description": "The json payload of the Presentation according to the {@link https://www.w3.org/TR/vc-data-model/#presentations | canonical model}.\n\nThe signer of the Presentation is chosen based on the `holder` property of the `presentation`" - }, - "save": { - "type": "boolean", - "description": "If this parameter is true, the resulting VerifiablePresentation is sent to the {@link daf-core#IDataStore | storage plugin} to be saved" - }, - "proofFormat": { - "$ref": "#/components/schemas/EncodingFormat", - "description": "The desired format for the VerifiablePresentation to be created. Currently, only JWT is supported" - } - }, - "required": [ - "presentation", - "proofFormat" - ], - "description": "Encapsulates the parameters required to create a {@link https://www.w3.org/TR/vc-data-model/#presentations | W3C Verifiable Presentation}" - }, - "W3CPresentation": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "holder": { - "type": "string" - }, - "issuanceDate": { - "type": "string" - }, - "expirationDate": { - "type": "string" - }, - "@context": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "array", - "items": { - "type": "string" - } - }, - "verifier": { - "type": "array", - "items": { - "type": "string" - } - }, - "verifiableCredential": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VerifiableCredential" - } - } - }, - "required": [ - "holder", - "@context", - "type", - "verifier", - "verifiableCredential" - ], - "description": "W3CPresentation {@link https://github.com/decentralized-identity/did-jwt-vc}" - }, - "VerifiablePresentation": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "holder": { - "type": "string" - }, - "issuanceDate": { - "type": "string" - }, - "expirationDate": { - "type": "string" - }, - "@context": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "array", - "items": { - "type": "string" - } - }, - "verifier": { - "type": "array", - "items": { - "type": "string" - } - }, - "verifiableCredential": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VerifiableCredential" - } - }, - "proof": { - "type": "object", - "properties": { - "type": { - "type": "string" - } - } - } - }, - "required": [ - "holder", - "@context", - "type", - "verifier", - "verifiableCredential", - "proof" - ], - "description": "Verifiable Presentation {@link https://github.com/decentralized-identity/did-jwt-vc}" - } - }, - "methods": { - "createVerifiableCredential": { - "description": "Creates a Verifiable Credential. The payload, signer and format are chosen based on the ", - "arguments": { - "$ref": "#/components/schemas/ICreateVerifiableCredentialArgs" - }, - "returnType": { - "$ref": "#/components/schemas/VerifiableCredential" - } - }, - "createVerifiablePresentation": { - "description": "Creates a Verifiable Presentation. The payload, signer and format are chosen based on the ", - "arguments": { - "$ref": "#/components/schemas/ICreateVerifiablePresentationArgs" - }, - "returnType": { - "$ref": "#/components/schemas/VerifiablePresentation" - } - } - } - } -} \ No newline at end of file diff --git a/packages/daf-web-did/package.json b/packages/daf-web-did/package.json index d434a16a5..e69c58cad 100644 --- a/packages/daf-web-did/package.json +++ b/packages/daf-web-did/package.json @@ -6,7 +6,7 @@ "types": "build/index.d.ts", "scripts": { "build": "tsc", - "extract-api": "daf extractPluginApi -c ./api-extractor.json" + "extract-api": "yarn daf extract-api" }, "dependencies": { "daf-core": "^7.0.0-beta.49", diff --git a/scripts/extract-examples.ts b/scripts/extract-examples.ts new file mode 100644 index 000000000..91147b842 --- /dev/null +++ b/scripts/extract-examples.ts @@ -0,0 +1,119 @@ +import { resolve } from 'path' +import { writeFileSync, readFileSync } from 'fs' +import * as TJS from 'ts-json-schema-generator' +import { + ApiModel, + ApiPackage, + ApiParameterListMixin, + ApiDocumentedItem, + ApiReturnTypeMixin, + ApiMethodSignature, +} from '@microsoft/api-extractor-model' + +import { DocFencedCode } from '@microsoft/tsdoc' + +const apiExtractorConfig = require('../api-extractor-base.json') + +const agentPlugins: Record> = { + 'daf-core': ['IResolver', 'IIdentityManager', 'IMessageHandler', 'IDataStore', 'IKeyManager'], + 'daf-w3c': ['ICredentialIssuer'], + 'daf-selective-disclosure': ['ISelectiveDisclosure'], + 'daf-did-comm': ['IDIDComm'], + 'daf-typeorm': ['IDataStoreORM'], +} + +interface RestMethod { + packageName: string + pluginInterfaceName: string + operationId: string + description?: string + example?: DocFencedCode + parameters?: string + response: string +} + +let allMethods: Array = [] + +for (const packageName of Object.keys(agentPlugins)) { + const generator = TJS.createGenerator({ + path: resolve('packages/' + packageName + '/src/index.ts'), + encodeRefs: false, + }) + + const apiModel: ApiModel = new ApiModel() + const apiPackage = apiModel.loadPackage( + (apiExtractorConfig.docModel.apiJsonFilePath as string).replace('', packageName), + ) + + const entry = apiPackage.entryPoints[0] + + for (const pluginInterfaceName of agentPlugins[packageName]) { + console.log(packageName, pluginInterfaceName) + const pluginInterface = entry.findMembersByName(pluginInterfaceName)[0] + + // Collecting method information + const methods: RestMethod[] = [] + for (const member of pluginInterface.members) { + const method: Partial = {} + method.packageName = packageName + method.pluginInterfaceName = pluginInterfaceName + method.operationId = member.displayName + // console.log(member) + method.parameters = (member as ApiParameterListMixin).parameters[0]?.parameterTypeExcerpt?.text + method.response = (member as ApiReturnTypeMixin).returnTypeExcerpt.text + .replace('Promise<', '') + .replace('>', '') + + const methodSignature = member as ApiMethodSignature + method.description = methodSignature.tsdocComment?.summarySection + ?.getChildNodes()[0] + //@ts-ignore + ?.getChildNodes()[0]?.text + + method.example = methodSignature.tsdocComment?.customBlocks[0]?.content?.getChildNodes()[1] as DocFencedCode + + method.description = method.description || '' + + methods.push(method as RestMethod) + } + + allMethods = allMethods.concat(methods) + } +} + +let summary = '# Available agent methods\n' +for (const packageName of Object.keys(agentPlugins)) { + // summary += `## [${packageName}](./api/${packageName}.md) \n\n` + for (const pluginInterfaceName of agentPlugins[packageName]) { + summary += `## [${pluginInterfaceName}](./api/${packageName}.${pluginInterfaceName.toLowerCase()}.md) \n\n` + + for (const method of allMethods.filter( + (m) => m.packageName === packageName && m.pluginInterfaceName == pluginInterfaceName, + )) { + summary += `\n### [${method.operationId}](./api/${ + method.packageName + }.${method.pluginInterfaceName.toLowerCase()}.${method.operationId.toLowerCase()}.md)` + summary += `\n\n${method.description}\n\n` + if (method.example) { + summary += '```' + method.example.language + '\n' + summary += method.example.code + summary += '```\n' + } + } + } +} + +writeFileSync('docs/methods.md', summary) + +let tests = '' +for (const method of allMethods) { + if (method.example) { + tests += `\nit('${method.packageName}-${method.pluginInterfaceName}-${method.operationId} example', async () => {\n${method.example.code}\n})\n` + } +} +tests = `DO NOT EDIT MANUALLY START\n ${tests}\n//DO NOT EDIT MANUALLY END` + +const testsFile = '__tests__/shared/documentationExamples.ts' +const source = readFileSync(testsFile).toString() +const newSource = source.replace(/DO NOT EDIT MANUALLY START(.+?)DO NOT EDIT MANUALLY END/s, tests) +writeFileSync(testsFile, newSource) diff --git a/scripts/generate-schemas.ts b/scripts/generate-schemas.ts deleted file mode 100644 index 6042aa5fe..000000000 --- a/scripts/generate-schemas.ts +++ /dev/null @@ -1,259 +0,0 @@ -import { resolve } from 'path' -import { writeFileSync, readFileSync } from 'fs' -import * as TJS from 'ts-json-schema-generator' -import { OpenAPIV3 } from 'openapi-types' -const OasResolver = require('oas-resolver') -import { - ApiModel, - ApiPackage, - ApiParameterListMixin, - ApiDocumentedItem, - ApiReturnTypeMixin, - ApiMethodSignature, -} from '@microsoft/api-extractor-model' - -import { DocFencedCode } from '@microsoft/tsdoc' - -const apiExtractorConfig = require('../api-extractor-base.json') - -const outputFile = 'packages/daf-rest/src/openApiSchema.ts' - -const agentPlugins: Record> = { - 'daf-core': ['IResolver', 'IIdentityManager', 'IMessageHandler', 'IDataStore', 'IKeyManager'], - 'daf-w3c': ['ICredentialIssuer'], - 'daf-selective-disclosure': ['ISelectiveDisclosure'], - 'daf-did-comm': ['IDIDComm'], - 'daf-typeorm': ['IDataStoreORM'], -} - -interface RestMethod { - packageName: string - pluginInterfaceName: string - operationId: string - description?: string - example?: DocFencedCode - parameters?: string - response: string -} - -const openApi: OpenAPIV3.Document = { - openapi: '3.0.0', - info: { - title: 'DAF OpenAPI', - version: '', - }, - components: { - schemas: {}, - }, - paths: {}, -} - -const genericTypes = ['boolean', 'string', 'number', 'any', 'Array'] - -function createSchema(generator: TJS.SchemaGenerator, symbol: string) { - if (genericTypes.includes(symbol)) { - return { components: { schemas: {} } } - } - - let fixedSymbol = symbol.replace('Array<', '').replace('>', '') - - const schema = generator.createSchema(fixedSymbol) - // console.dir({ fixedSymbol, schema }, {depth: 10}) - - const newSchema = { - components: { - schemas: schema.definitions, - }, - } - - let schemaStr = JSON.stringify(newSchema, null, 2) - - schemaStr = schemaStr.replace(/#\/definitions\//gm, '#/components/schemas/') - schemaStr = schemaStr.replace(/\"patternProperties\":{([^:]*):{[^}]*}}/gm, '"pattern": $1') - schemaStr = schemaStr.replace(/Verifiable\<(.*)\>/gm, 'Verifiable-$1') - schemaStr = schemaStr.replace(/Where\<(.*)\>/gm, 'Where-$1') - schemaStr = schemaStr.replace(/Order\<(.*)\>/gm, 'Order-$1') - schemaStr = schemaStr.replace(/FindArgs\<(.*)\>/gm, 'FindArgs-$1') - return JSON.parse(schemaStr) -} - -function getRequestBodySchema(parameters?: string): OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject { - if (!parameters) { - return { type: 'object' } - } else { - return { - $ref: '#/components/schemas/' + parameters, - } - } -} - -function getResponseSchema(response: string): OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject { - if (response.slice(0, 6) === 'Array<') { - const symbol = response.replace('Array<', '').replace('>', '') as - | 'string' - | 'number' - | 'boolean' - | 'object' - | 'integer' - return { - type: 'array', - items: genericTypes.includes(symbol) ? { type: symbol } : { $ref: '#/components/schemas/' + symbol }, - } - } - if (response === 'any') { - return { type: 'object' } - } - - if (['string', 'number', 'boolean', 'object', 'integer'].includes(response)) { - //@ts-ignore - return { type: response } - } else { - return { $ref: '#/components/schemas/' + response } - } -} - -let allMethods: Array = [] - -for (const packageName of Object.keys(agentPlugins)) { - const generator = TJS.createGenerator({ - path: resolve('packages/' + packageName + '/src/index.ts'), - encodeRefs: false, - }) - - const apiModel: ApiModel = new ApiModel() - const apiPackage = apiModel.loadPackage( - (apiExtractorConfig.docModel.apiJsonFilePath as string).replace('', packageName), - ) - - const entry = apiPackage.entryPoints[0] - - for (const pluginInterfaceName of agentPlugins[packageName]) { - console.log(packageName, pluginInterfaceName) - const pluginInterface = entry.findMembersByName(pluginInterfaceName)[0] - - // Collecting method information - const methods: RestMethod[] = [] - for (const member of pluginInterface.members) { - const method: Partial = {} - method.packageName = packageName - method.pluginInterfaceName = pluginInterfaceName - method.operationId = member.displayName - // console.log(member) - method.parameters = (member as ApiParameterListMixin).parameters[0]?.parameterTypeExcerpt?.text - method.response = (member as ApiReturnTypeMixin).returnTypeExcerpt.text - .replace('Promise<', '') - .replace('>', '') - - const methodSignature = member as ApiMethodSignature - method.description = methodSignature.tsdocComment?.summarySection - ?.getChildNodes()[0] - //@ts-ignore - ?.getChildNodes()[0]?.text - - method.example = methodSignature.tsdocComment?.customBlocks[0]?.content?.getChildNodes()[1] as DocFencedCode - - method.description = method.description || '' - - if (method.parameters) { - //@ts-ignore - openApi.components.schemas = { - //@ts-ignore - ...openApi.components.schemas, - ...createSchema(generator, method.parameters).components.schemas, - } - } - - //@ts-ignore - openApi.components.schemas = { - //@ts-ignore - ...openApi.components.schemas, - ...createSchema(generator, method.response).components.schemas, - } - methods.push(method as RestMethod) - } - - allMethods = allMethods.concat(methods) - - for (const method of methods) { - console.log(` - ${method.operationId}(args: ${method.parameters}) => Promise<${method.response}>`) - //@ts-ignore - openApi.paths['/' + method.operationId] = { - post: { - description: method.description, - operationId: method.operationId, - requestBody: { - content: { - 'application/json': { - schema: getRequestBodySchema(method.parameters), - }, - }, - }, - responses: { - 200: { - description: method.description || '', - content: { - 'application/json': { - schema: getResponseSchema(method.response), - }, - }, - }, - }, - }, - } - } - } -} - -OasResolver.resolve(openApi, null, { - resolveInternal: false, - patch: true, -}) - .then((validatedOpenApi: any) => { - console.log('Writing ' + outputFile) - const fixedOpenApi = validatedOpenApi - // fixedOpenApi['openapi']['components']['schemas'] = {} - fixedOpenApi['openapi']['components']['schemas']['DIDDocument']['properties']['uportProfile'] = { type: 'object' } - writeFileSync( - outputFile, - "import { OpenAPIV3 } from 'openapi-types'\nexport const openApiSchema: OpenAPIV3.Document = " + - JSON.stringify(fixedOpenApi['openapi'], null, 2), - ) - }) - .catch(console.log) - -let summary = '# Available agent methods\n' -for (const packageName of Object.keys(agentPlugins)) { - // summary += `## [${packageName}](./api/${packageName}.md) \n\n` - for (const pluginInterfaceName of agentPlugins[packageName]) { - summary += `## [${pluginInterfaceName}](./api/${packageName}.${pluginInterfaceName.toLowerCase()}.md) \n\n` - - for (const method of allMethods.filter( - (m) => m.packageName === packageName && m.pluginInterfaceName == pluginInterfaceName, - )) { - summary += `\n### [${method.operationId}](./api/${ - method.packageName - }.${method.pluginInterfaceName.toLowerCase()}.${method.operationId.toLowerCase()}.md)` - summary += `\n\n${method.description}\n\n` - if (method.example) { - summary += '```' + method.example.language + '\n' - summary += method.example.code - summary += '```\n' - } - } - } -} - -writeFileSync('docs/methods.md', summary) - -let tests = '' -for (const method of allMethods) { - if (method.example) { - tests += `\nit('${method.packageName}-${method.pluginInterfaceName}-${method.operationId} example', async () => {\n${method.example.code}\n})\n` - } -} -tests = `DO NOT EDIT MANUALLY START\n ${tests}\n//DO NOT EDIT MANUALLY END` - -const testsFile = '__tests__/shared/documentationExamples.ts' -const source = readFileSync(testsFile).toString() -const newSource = source.replace(/DO NOT EDIT MANUALLY START(.+?)DO NOT EDIT MANUALLY END/s, tests) -writeFileSync(testsFile, newSource)