From faa8ad3f57bd62162bd4d9758eacf890dc46af67 Mon Sep 17 00:00:00 2001 From: uport-automation-bot Date: Tue, 2 Apr 2024 18:55:02 +0000 Subject: [PATCH] chore(release): :rocket: api docs v6.0.0 --- ...ypes.authorizeddidcontext.authorizeddid.md | 2 +- docs/api/core-types.authorizeddidcontext.md | 2 +- docs/api/core-types.compactjwt.md | 2 +- docs/api/core-types.contexttype.md | 2 +- ...core-types.credentialpayload.__context_.md | 2 +- ...ypes.credentialpayload.credentialstatus.md | 2 +- ...pes.credentialpayload.credentialsubject.md | 2 +- ...-types.credentialpayload.expirationdate.md | 2 +- docs/api/core-types.credentialpayload.id.md | 2 +- ...re-types.credentialpayload.issuancedate.md | 2 +- .../core-types.credentialpayload.issuer.md | 2 +- docs/api/core-types.credentialpayload.md | 2 +- docs/api/core-types.credentialpayload.type.md | 2 +- docs/api/core-types.credentialstatus.md | 2 +- ...core-types.credentialstatusgenerateargs.md | 2 +- ...types.credentialstatusgenerateargs.type.md | 2 +- .../core-types.credentialstatusreference.md | 2 +- .../core-types.credentialstatusupdateargs.md | 2 +- ...ypes.credentialstatusupdateargs.options.md | 2 +- ...ore-types.credentialstatusupdateargs.vc.md | 2 +- docs/api/core-types.credentialsubject.md | 2 +- docs/api/core-types.datetype.md | 2 +- docs/api/core-types.diddoccomponent.md | 2 +- docs/api/core-types.findargs.md | 2 +- docs/api/core-types.findargs.order.md | 2 +- docs/api/core-types.findargs.skip.md | 2 +- docs/api/core-types.findargs.take.md | 2 +- docs/api/core-types.findargs.where.md | 2 +- docs/api/core-types.findclaimsargs.md | 2 +- docs/api/core-types.findcredentialsargs.md | 2 +- docs/api/core-types.findidentifiersargs.md | 2 +- docs/api/core-types.findmessagesargs.md | 2 +- docs/api/core-types.findpresentationsargs.md | 2 +- ...e-types.getdidcomponentargs.diddocument.md | 2 +- .../core-types.getdidcomponentargs.didurl.md | 2 +- docs/api/core-types.getdidcomponentargs.md | 2 +- .../core-types.getdidcomponentargs.section.md | 2 +- ...s.icheckcredentialstatusargs.credential.md | 2 +- ...redentialstatusargs.diddocumentoverride.md | 2 +- .../core-types.icheckcredentialstatusargs.md | 6 +- ...e-types.icreateverifiablecredentialargs.md | 8 +- ...ateverifiablecredentialargs.proofformat.md | 2 +- ...es.icreateverifiablecredentialargs.save.md | 2 +- ...types.icreateverifiablepresentationargs.md | 4 +- ...credentialissuer.listusableproofformats.md | 2 +- docs/api/core-types.icredentialstatus.md | 2 +- ...lstatusmanager.credentialstatusgenerate.md | 2 +- ...tialstatusmanager.credentialstatustypes.md | 2 +- ...ialstatusmanager.credentialstatusupdate.md | 2 +- .../core-types.icredentialstatusmanager.md | 2 +- ...ialstatusverifier.checkcredentialstatus.md | 2 +- .../core-types.icredentialstatusverifier.md | 2 +- ...datastoreorm.datastoreormgetidentifiers.md | 2 +- ...toreorm.datastoreormgetidentifierscount.md | 2 +- ...s.idatastoreorm.datastoreormgetmessages.md | 2 +- ...tastoreorm.datastoreormgetmessagescount.md | 2 +- ...rm.datastoreormgetverifiablecredentials.md | 2 +- ...toreormgetverifiablecredentialsbyclaims.md | 2 +- ...rmgetverifiablecredentialsbyclaimscount.md | 2 +- ...tastoreormgetverifiablecredentialscount.md | 2 +- ....datastoreormgetverifiablepresentations.md | 2 +- ...storeormgetverifiablepresentationscount.md | 2 +- docs/api/core-types.idatastoreorm.md | 2 +- .../core-types.ididmanagerupdateargs.did.md | 2 +- ...re-types.ididmanagerupdateargs.document.md | 2 +- docs/api/core-types.ididmanagerupdateargs.md | 2 +- ...ore-types.ididmanagerupdateargs.options.md | 2 +- docs/api/core-types.ierror.errorcode.md | 2 +- docs/api/core-types.ierror.md | 2 +- docs/api/core-types.ierror.message.md | 2 +- ...-types.ikeymanager.keymanagerdecryptjwe.md | 2 +- ...-types.ikeymanager.keymanagerencryptjwe.md | 2 +- ...re-types.ikeymanagerdecryptjweargs.data.md | 2 +- ...ore-types.ikeymanagerdecryptjweargs.kid.md | 2 +- .../core-types.ikeymanagerdecryptjweargs.md | 2 +- ...re-types.ikeymanagerencryptjweargs.data.md | 2 +- ...ore-types.ikeymanagerencryptjweargs.kid.md | 2 +- .../core-types.ikeymanagerencryptjweargs.md | 2 +- ...core-types.ikeymanagerencryptjweargs.to.md | 2 +- ...ore-types.imessageattachmentdata.base64.md | 2 +- .../core-types.imessageattachmentdata.hash.md | 2 +- .../core-types.imessageattachmentdata.json.md | 2 +- .../core-types.imessageattachmentdata.jws.md | 2 +- ...core-types.imessageattachmentdata.links.md | 2 +- docs/api/core-types.imessageattachmentdata.md | 2 +- ...ore-types.iresolver.getdidcomponentbyid.md | 2 +- docs/api/core-types.issueragentcontext.md | 2 +- docs/api/core-types.issuertype.md | 2 +- docs/api/core-types.iverifycredentialargs.md | 4 +- .../api/core-types.iverifypresentationargs.md | 4 +- docs/api/core-types.iverifyresult.error.md | 2 +- docs/api/core-types.iverifyresult.md | 2 +- docs/api/core-types.iverifyresult.verified.md | 2 +- docs/api/core-types.md | 2 + docs/api/core-types.order.column.md | 2 +- docs/api/core-types.order.direction.md | 2 +- docs/api/core-types.order.md | 2 +- docs/api/core-types.partialidentifier.md | 2 +- ...re-types.presentationpayload.__context_.md | 2 +- ...ypes.presentationpayload.expirationdate.md | 2 +- .../core-types.presentationpayload.holder.md | 2 +- docs/api/core-types.presentationpayload.id.md | 2 +- ...-types.presentationpayload.issuancedate.md | 2 +- docs/api/core-types.presentationpayload.md | 2 +- .../core-types.presentationpayload.type.md | 2 +- ...resentationpayload.verifiablecredential.md | 2 +- ...core-types.presentationpayload.verifier.md | 2 +- docs/api/core-types.prooftype.md | 2 +- docs/api/core-types.prooftype.type.md | 2 +- docs/api/core-types.schema.md | 5166 +++++++++++++++++ docs/api/core-types.tclaimscolumns.md | 2 +- docs/api/core-types.tcredentialcolumns.md | 2 +- docs/api/core-types.tidentifierscolumns.md | 2 +- docs/api/core-types.tmessagecolumns.md | 2 +- docs/api/core-types.tpresentationcolumns.md | 2 +- ...e-types.uniqueverifiablecredential.hash.md | 2 +- .../core-types.uniqueverifiablecredential.md | 2 +- ...rifiablecredential.verifiablecredential.md | 2 +- ...types.uniqueverifiablepresentation.hash.md | 2 +- ...core-types.uniqueverifiablepresentation.md | 2 +- ...ablepresentation.verifiablepresentation.md | 2 +- ...ore-types.unsignedcredential.__context_.md | 2 +- ...pes.unsignedcredential.credentialstatus.md | 2 +- ...es.unsignedcredential.credentialsubject.md | 2 +- ...types.unsignedcredential.expirationdate.md | 2 +- docs/api/core-types.unsignedcredential.id.md | 2 +- ...e-types.unsignedcredential.issuancedate.md | 2 +- .../core-types.unsignedcredential.issuer.md | 2 +- docs/api/core-types.unsignedcredential.md | 2 +- .../api/core-types.unsignedcredential.type.md | 2 +- docs/api/core-types.usingresolutionoptions.md | 23 + ...singresolutionoptions.resolutionoptions.md | 19 + docs/api/core-types.verifiablecredential.md | 2 +- ...ore-types.verificationpolicies.audience.md | 2 +- ...s.verificationpolicies.credentialstatus.md | 2 +- ...pes.verificationpolicies.expirationdate.md | 2 +- ...types.verificationpolicies.issuancedate.md | 2 +- docs/api/core-types.verificationpolicies.md | 2 +- .../core-types.verificationpolicies.now.md | 2 +- docs/api/core-types.verifieragentcontext.md | 2 +- .../api/core-types.w3cverifiablecredential.md | 2 +- docs/api/core-types.where.column.md | 2 +- docs/api/core-types.where.md | 2 +- docs/api/core-types.where.not.md | 2 +- docs/api/core-types.where.op.md | 2 +- docs/api/core-types.where.value.md | 2 +- ...12.credentialissuereip712._constructor_.md | 2 +- ...eip712.createverifiablecredentialeip712.md | 2 +- ...p712.createverifiablepresentationeip712.md | 2 +- ...redential-eip712.credentialissuereip712.md | 10 +- ...l-eip712.credentialissuereip712.methods.md | 2 +- ...al-eip712.credentialissuereip712.schema.md | 50 +- ...rifiablecredentialeip712args.credential.md | 2 +- ...teverifiablecredentialeip712args.keyref.md | 2 +- ...2.icreateverifiablecredentialeip712args.md | 6 +- ...verifiablepresentationeip712args.keyref.md | 2 +- ...icreateverifiablepresentationeip712args.md | 6 +- ...ablepresentationeip712args.presentation.md | 2 +- ...eip712.createverifiablecredentialeip712.md | 2 +- ...p712.createverifiablepresentationeip712.md | 2 +- ...edential-eip712.icredentialissuereip712.md | 2 +- ...tialissuereip712.verifycredentialeip712.md | 2 +- ...alissuereip712.verifypresentationeip712.md | 2 +- .../api/credential-eip712.irequiredcontext.md | 2 +- ....iverifycredentialeip712args.credential.md | 2 +- ...tial-eip712.iverifycredentialeip712args.md | 6 +- ...al-eip712.iverifypresentationeip712args.md | 4 +- docs/api/credential-eip712.md | 6 + docs/api/credential-eip712.schema.md | 399 ++ docs/api/credential-ld.contextdoc.md | 2 +- ...ial-ld.credentialissuerld._constructor_.md | 6 +- docs/api/credential-ld.credentialissuerld.md | 8 +- ...credential-ld.credentialissuerld.schema.md | 48 + ...teverifiablecredentialldargs.credential.md | 2 +- ...blecredentialldargs.fetchremotecontexts.md | 2 +- ...createverifiablecredentialldargs.keyref.md | 2 +- ...al-ld.icreateverifiablecredentialldargs.md | 6 +- ...everifiablepresentationldargs.challenge.md | 2 +- ...eateverifiablepresentationldargs.domain.md | 2 +- ...epresentationldargs.fetchremotecontexts.md | 2 +- ...eateverifiablepresentationldargs.keyref.md | 2 +- ...-ld.icreateverifiablepresentationldargs.md | 6 +- ...rifiablepresentationldargs.presentation.md | 2 +- ...alissuerld.createverifiablecredentialld.md | 2 +- ...issuerld.createverifiablepresentationld.md | 2 +- docs/api/credential-ld.icredentialissuerld.md | 2 +- ....icredentialissuerld.verifycredentialld.md | 2 +- ...credentialissuerld.verifypresentationld.md | 2 +- docs/api/credential-ld.irequiredcontext.md | 2 +- ...l-ld.iverifycredentialldargs.credential.md | 2 +- ...ifycredentialldargs.fetchremotecontexts.md | 2 +- .../credential-ld.iverifycredentialldargs.md | 6 +- ...-ld.iverifypresentationldargs.challenge.md | 2 +- ...ial-ld.iverifypresentationldargs.domain.md | 2 +- ...ypresentationldargs.fetchremotecontexts.md | 2 +- ...credential-ld.iverifypresentationldargs.md | 6 +- ....iverifypresentationldargs.presentation.md | 2 +- docs/api/credential-ld.lddefaultcontexts.md | 2 +- docs/api/credential-ld.md | 17 +- docs/api/credential-ld.schema.md | 443 ++ ...ramoecdsasecp256k1recoverysignature2020.md | 23 + ...redential-ld.veramoed25519signature2018.md | 23 + ...redential-ld.veramoed25519signature2020.md | 23 + ...redential-ld.veramojsonwebsignature2020.md | 23 + docs/api/credential-ld.veramoldsignature.md | 21 + ...us.credentialstatusplugin._constructor_.md | 2 +- ...redential-status.credentialstatusplugin.md | 2 +- ...l-status.credentialstatusplugin.methods.md | 2 +- ...ial-w3c.credentialplugin.matchkeyforjwt.md | 30 + docs/api/credential-w3c.credentialplugin.md | 9 +- .../credential-w3c.credentialplugin.schema.md | 48 + ...data-store-json.claimtableentry.context.md | 2 +- ...ore-json.claimtableentry.credentialhash.md | 2 +- ...ore-json.claimtableentry.credentialtype.md | 2 +- ...ore-json.claimtableentry.expirationdate.md | 2 +- .../data-store-json.claimtableentry.hash.md | 2 +- ...store-json.claimtableentry.issuancedate.md | 2 +- .../data-store-json.claimtableentry.issuer.md | 2 +- docs/api/data-store-json.claimtableentry.md | 2 +- ...data-store-json.claimtableentry.subject.md | 2 +- .../data-store-json.claimtableentry.type.md | 2 +- .../data-store-json.claimtableentry.value.md | 2 +- ...redentialtableentry.canonicalcredential.md | 2 +- ...store-json.credentialtableentry.context.md | 2 +- ...son.credentialtableentry.expirationdate.md | 2 +- ...ta-store-json.credentialtableentry.hash.md | 2 +- ...data-store-json.credentialtableentry.id.md | 2 +- ...-json.credentialtableentry.issuancedate.md | 2 +- ...-store-json.credentialtableentry.issuer.md | 2 +- .../data-store-json.credentialtableentry.md | 2 +- ...n.credentialtableentry.parsedcredential.md | 2 +- ...store-json.credentialtableentry.subject.md | 2 +- ...ta-store-json.credentialtableentry.type.md | 2 +- ...-store-json.datastorejson._constructor_.md | 2 +- ...on.datastorejson.datastoredeletemessage.md | 2 +- ...son.datastoredeleteverifiablecredential.md | 2 +- ...-json.datastorejson.datastoregetmessage.md | 2 +- ...rejson.datastoregetverifiablecredential.md | 2 +- ...json.datastoregetverifiablepresentation.md | 2 +- ...atastorejson.datastoreormgetidentifiers.md | 2 +- ...orejson.datastoreormgetidentifierscount.md | 2 +- ...n.datastorejson.datastoreormgetmessages.md | 2 +- ...astorejson.datastoreormgetmessagescount.md | 2 +- ...on.datastoreormgetverifiablecredentials.md | 2 +- ...toreormgetverifiablecredentialsbyclaims.md | 2 +- ...rmgetverifiablecredentialsbyclaimscount.md | 2 +- ...tastoreormgetverifiablecredentialscount.md | 2 +- ....datastoreormgetverifiablepresentations.md | 2 +- ...storeormgetverifiablepresentationscount.md | 2 +- ...json.datastorejson.datastoresavemessage.md | 2 +- ...ejson.datastoresaveverifiablecredential.md | 2 +- ...son.datastoresaveverifiablepresentation.md | 2 +- docs/api/data-store-json.datastorejson.md | 2 +- .../data-store-json.datastorejson.methods.md | 2 +- .../data-store-json.datastorejson.schema.md | 2 +- ...a-store-json.didstorejson._constructor_.md | 2 +- .../data-store-json.didstorejson.deletedid.md | 2 +- .../data-store-json.didstorejson.getdid.md | 2 +- .../data-store-json.didstorejson.importdid.md | 2 +- .../data-store-json.didstorejson.listdids.md | 2 +- docs/api/data-store-json.didstorejson.md | 2 +- docs/api/data-store-json.diffcallback.md | 2 +- ...a-store-json.keystorejson._constructor_.md | 2 +- .../data-store-json.keystorejson.deletekey.md | 2 +- .../data-store-json.keystorejson.getkey.md | 2 +- .../data-store-json.keystorejson.importkey.md | 2 +- .../data-store-json.keystorejson.listkeys.md | 2 +- docs/api/data-store-json.keystorejson.md | 2 +- ...ntationtableentry.canonicalpresentation.md | 2 +- ...ore-json.presentationtableentry.context.md | 2 +- ...json.presentationtableentry.credentials.md | 2 +- ...n.presentationtableentry.expirationdate.md | 2 +- ...-store-json.presentationtableentry.hash.md | 2 +- ...tore-json.presentationtableentry.holder.md | 2 +- ...ta-store-json.presentationtableentry.id.md | 2 +- ...son.presentationtableentry.issuancedate.md | 2 +- .../data-store-json.presentationtableentry.md | 2 +- ...esentationtableentry.parsedpresentation.md | 2 +- ...-store-json.presentationtableentry.type.md | 2 +- ...re-json.presentationtableentry.verifier.md | 2 +- ...-json.privatekeystorejson._constructor_.md | 2 +- ...tore-json.privatekeystorejson.deletekey.md | 2 +- ...a-store-json.privatekeystorejson.getkey.md | 2 +- ...tore-json.privatekeystorejson.importkey.md | 2 +- ...store-json.privatekeystorejson.listkeys.md | 2 +- .../data-store-json.privatekeystorejson.md | 2 +- .../data-store-json.veramojsoncache.claims.md | 2 +- ...-store-json.veramojsoncache.credentials.md | 2 +- .../data-store-json.veramojsoncache.dids.md | 2 +- .../data-store-json.veramojsoncache.keys.md | 2 +- docs/api/data-store-json.veramojsoncache.md | 2 +- ...ata-store-json.veramojsoncache.messages.md | 2 +- ...tore-json.veramojsoncache.presentations.md | 2 +- ...-store-json.veramojsoncache.privatekeys.md | 2 +- docs/api/data-store-json.veramojsonstore.md | 2 +- ...store-json.veramojsonstore.notifyupdate.md | 2 +- docs/api/data-store.claim.context.md | 2 +- docs/api/data-store.claim.credential.md | 2 +- docs/api/data-store.claim.credentialtype.md | 2 +- docs/api/data-store.claim.expirationdate.md | 2 +- docs/api/data-store.claim.hash.md | 2 +- docs/api/data-store.claim.isobj.md | 2 +- docs/api/data-store.claim.issuancedate.md | 2 +- docs/api/data-store.claim.issuer.md | 2 +- docs/api/data-store.claim.md | 2 +- docs/api/data-store.claim.subject.md | 2 +- docs/api/data-store.claim.type.md | 2 +- docs/api/data-store.claim.value.md | 2 +- docs/api/data-store.credential_2.claims.md | 2 +- docs/api/data-store.credential_2.context.md | 2 +- .../data-store.credential_2.expirationdate.md | 2 +- docs/api/data-store.credential_2.hash.md | 2 +- docs/api/data-store.credential_2.id.md | 2 +- .../data-store.credential_2.issuancedate.md | 2 +- docs/api/data-store.credential_2.issuer.md | 2 +- docs/api/data-store.credential_2.md | 2 +- docs/api/data-store.credential_2.messages.md | 2 +- .../data-store.credential_2.presentations.md | 2 +- docs/api/data-store.credential_2.raw.md | 2 +- docs/api/data-store.credential_2.subject.md | 2 +- docs/api/data-store.credential_2.type.md | 2 +- .../api/data-store.datastore._constructor_.md | 2 +- ...-store.datastore.datastoredeletemessage.md | 2 +- ...ore.datastoredeleteverifiablecredential.md | 2 +- ...ata-store.datastore.datastoregetmessage.md | 2 +- ...astore.datastoregetverifiablecredential.md | 2 +- ...tore.datastoregetverifiablepresentation.md | 2 +- ...ta-store.datastore.datastoresavemessage.md | 2 +- ...store.datastoresaveverifiablecredential.md | 2 +- ...ore.datastoresaveverifiablepresentation.md | 2 +- docs/api/data-store.datastore.md | 2 +- docs/api/data-store.datastore.methods.md | 2 +- docs/api/data-store.datastore.schema.md | 2 +- ....datastorediscoveryprovider.discoverdid.md | 2 +- .../data-store.datastorediscoveryprovider.md | 2 +- ...a-store.datastorediscoveryprovider.name.md | 2 +- .../data-store.datastoreorm._constructor_.md | 2 +- ...datastoreorm.datastoreormgetidentifiers.md | 2 +- ...toreorm.datastoreormgetidentifierscount.md | 2 +- ...re.datastoreorm.datastoreormgetmessages.md | 2 +- ...tastoreorm.datastoreormgetmessagescount.md | 2 +- ...rm.datastoreormgetverifiablecredentials.md | 2 +- ...toreormgetverifiablecredentialsbyclaims.md | 2 +- ...rmgetverifiablecredentialsbyclaimscount.md | 2 +- ...tastoreormgetverifiablecredentialscount.md | 2 +- ....datastoreormgetverifiablepresentations.md | 2 +- ...storeormgetverifiablepresentationscount.md | 2 +- docs/api/data-store.datastoreorm.md | 2 +- docs/api/data-store.datastoreorm.methods.md | 2 +- docs/api/data-store.datastoreorm.schema.md | 2 +- docs/api/data-store.entitiesconcat.md | 14 +- docs/api/data-store.identifier.alias.md | 2 +- .../data-store.identifier.controllerkeyid.md | 2 +- docs/api/data-store.identifier.did.md | 2 +- ...ta-store.identifier.getlatestclaimvalue.md | 2 +- .../api/data-store.identifier.issuedclaims.md | 2 +- ...data-store.identifier.issuedcredentials.md | 2 +- ...ta-store.identifier.issuedpresentations.md | 2 +- docs/api/data-store.identifier.keys.md | 2 +- docs/api/data-store.identifier.md | 2 +- docs/api/data-store.identifier.provider.md | 2 +- .../data-store.identifier.receivedclaims.md | 2 +- ...ta-store.identifier.receivedcredentials.md | 2 +- .../data-store.identifier.receivedmessages.md | 2 +- ...-store.identifier.receivedpresentations.md | 2 +- docs/api/data-store.identifier.savedate.md | 2 +- .../api/data-store.identifier.sentmessages.md | 2 +- docs/api/data-store.identifier.services.md | 2 +- docs/api/data-store.identifier.setsavedate.md | 2 +- .../data-store.identifier.setupdatedate.md | 2 +- docs/api/data-store.identifier.shortdid.md | 2 +- docs/api/data-store.identifier.updatedate.md | 2 +- docs/api/data-store.key.identifier.md | 2 +- docs/api/data-store.key.kid.md | 2 +- docs/api/data-store.key.kms.md | 2 +- docs/api/data-store.key.md | 2 +- docs/api/data-store.key.meta.md | 2 +- docs/api/data-store.key.publickeyhex.md | 2 +- docs/api/data-store.key.type.md | 2 +- docs/api/data-store.keytype_2.md | 2 +- docs/api/data-store.md | 16 +- docs/api/data-store.message.createdat.md | 2 +- docs/api/data-store.message.credentials.md | 2 +- docs/api/data-store.message.data.md | 2 +- docs/api/data-store.message.expiresat.md | 2 +- docs/api/data-store.message.from.md | 2 +- docs/api/data-store.message.id.md | 2 +- docs/api/data-store.message.md | 2 +- docs/api/data-store.message.metadata.md | 2 +- docs/api/data-store.message.presentations.md | 2 +- docs/api/data-store.message.raw.md | 2 +- docs/api/data-store.message.replyto.md | 2 +- docs/api/data-store.message.replyurl.md | 2 +- docs/api/data-store.message.savedate.md | 2 +- docs/api/data-store.message.setid.md | 2 +- docs/api/data-store.message.setsavedate.md | 2 +- docs/api/data-store.message.setupdatedate.md | 2 +- docs/api/data-store.message.threadid.md | 2 +- docs/api/data-store.message.to.md | 2 +- docs/api/data-store.message.type.md | 2 +- docs/api/data-store.message.updatedate.md | 2 +- docs/api/data-store.metadata.md | 2 +- docs/api/data-store.metadata.type.md | 2 +- docs/api/data-store.metadata.value.md | 2 +- docs/api/data-store.premigrationkey.kid.md | 2 +- docs/api/data-store.premigrationkey.md | 2 +- ...ata-store.premigrationkey.privatekeyhex.md | 2 +- docs/api/data-store.presentation.context.md | 2 +- .../data-store.presentation.credentials.md | 2 +- .../data-store.presentation.expirationdate.md | 2 +- docs/api/data-store.presentation.hash.md | 2 +- docs/api/data-store.presentation.holder.md | 2 +- docs/api/data-store.presentation.id.md | 2 +- .../data-store.presentation.issuancedate.md | 2 +- docs/api/data-store.presentation.md | 2 +- docs/api/data-store.presentation.messages.md | 2 +- docs/api/data-store.presentation.raw.md | 2 +- docs/api/data-store.presentation.type.md | 2 +- docs/api/data-store.presentation.verifier.md | 2 +- docs/api/data-store.privatekey.alias.md | 2 +- docs/api/data-store.privatekey.md | 2 +- .../data-store.privatekey.privatekeyhex.md | 2 +- docs/api/data-store.privatekey.type.md | 2 +- docs/api/data-store.service.description.md | 2 +- docs/api/data-store.service.id.md | 2 +- docs/api/data-store.service.identifier.md | 2 +- docs/api/data-store.service.md | 2 +- .../api/data-store.service.serviceendpoint.md | 2 +- docs/api/data-store.service.type.md | 2 +- ....abstractdidcommtransport._constructor_.md | 2 +- .../did-comm.abstractdidcommtransport.id.md | 2 +- ...ractdidcommtransport.isservicesupported.md | 2 +- docs/api/did-comm.abstractdidcommtransport.md | 2 +- .../did-comm.abstractdidcommtransport.send.md | 2 +- docs/api/did-comm.coordinatemediation.md | 2 +- ...ionmediatormessagehandler._constructor_.md | 2 +- ...emediationmediatormessagehandler.handle.md | 2 +- ...ordinatemediationmediatormessagehandler.md | 2 +- ...onrecipientmessagehandler._constructor_.md | 2 +- ...mediationrecipientmessagehandler.handle.md | 2 +- ...rdinatemediationrecipientmessagehandler.md | 2 +- ...nv3mediatormessagehandler._constructor_.md | 2 +- ...ediationv3mediatormessagehandler.handle.md | 2 +- ...dinatemediationv3mediatormessagehandler.md | 2 +- ...handleroptions.ismediatedefaultgrantall.md | 2 +- ...ediationv3mediatormessagehandleroptions.md | 2 +- ...v3recipientmessagehandler._constructor_.md | 2 +- ...diationv3recipientmessagehandler.handle.md | 2 +- ...inatemediationv3recipientmessagehandler.md | 2 +- .../did-comm.createdeliveryrequestmessage.md | 2 +- .../api/did-comm.createmediategrantmessage.md | 2 +- .../did-comm.createmediaterequestmessage.md | 2 +- .../did-comm.createstatusrequestmessage.md | 2 +- ...did-comm.createv3deliveryrequestmessage.md | 17 +- .../did-comm.createv3mediatedenymessage.md | 18 +- .../did-comm.createv3mediategrantmessage.md | 2 +- .../did-comm.createv3mediaterequestmessage.md | 2 +- .../did-comm.createv3recipientquerymessage.md | 19 +- ...m.createv3recipientqueryresponsemessage.md | 19 +- ...did-comm.createv3recipientupdatemessage.md | 20 +- ....createv3recipientupdateresponsemessage.md | 2 +- .../did-comm.createv3statusrequestmessage.md | 17 +- .../did-comm.delivery_request_message_type.md | 2 +- docs/api/did-comm.didcomm._constructor_.md | 2 +- ...comm.didcomm.getdidcommmessagemediatype.md | 2 +- docs/api/did-comm.didcomm.md | 12 +- docs/api/did-comm.didcomm.methods.md | 2 +- .../did-comm.didcomm.packdidcommmessage.md | 2 +- docs/api/did-comm.didcomm.schema.md | 57 +- .../did-comm.didcomm.senddidcommmessage.md | 2 +- ...d-comm.didcomm.sendmessagedidcommalpha1.md | 2 +- docs/api/did-comm.didcomm.transports.md | 2 +- .../did-comm.didcomm.unpackdidcommmessage.md | 2 +- docs/api/did-comm.didcommconfig.md | 2 +- docs/api/did-comm.didcommconfig.transports.md | 2 +- ...comm.didcommhttptransport._constructor_.md | 2 +- ...id-comm.didcommhttptransport.httpmethod.md | 2 +- ...didcommhttptransport.isservicesupported.md | 2 +- docs/api/did-comm.didcommhttptransport.md | 2 +- .../api/did-comm.didcommhttptransport.send.md | 2 +- ...omm.didcommmessagehandler._constructor_.md | 2 +- .../did-comm.didcommmessagehandler.handle.md | 2 +- docs/api/did-comm.didcommmessagehandler.md | 2 +- docs/api/did-comm.didcommmessagemediatype.md | 2 +- docs/api/did-comm.didcommmessagepacking.md | 2 +- ...omm.ididcomm.getdidcommmessagemediatype.md | 2 +- docs/api/did-comm.ididcomm.md | 2 +- .../did-comm.ididcomm.packdidcommmessage.md | 2 +- .../did-comm.ididcomm.senddidcommmessage.md | 2 +- ...-comm.ididcomm.sendmessagedidcommalpha1.md | 2 +- .../did-comm.ididcomm.unpackdidcommmessage.md | 2 +- .../did-comm.ididcommmessage.attachments.md | 2 +- docs/api/did-comm.ididcommmessage.body.md | 4 +- .../did-comm.ididcommmessage.created_time.md | 2 +- .../did-comm.ididcommmessage.expires_time.md | 2 +- docs/api/did-comm.ididcommmessage.from.md | 2 +- .../did-comm.ididcommmessage.from_prior.md | 2 +- docs/api/did-comm.ididcommmessage.id.md | 2 +- docs/api/did-comm.ididcommmessage.md | 6 +- docs/api/did-comm.ididcommmessage.next.md | 2 +- docs/api/did-comm.ididcommmessage.pthid.md | 2 +- .../did-comm.ididcommmessage.return_route.md | 2 +- docs/api/did-comm.ididcommmessage.thid.md | 2 +- docs/api/did-comm.ididcommmessage.to.md | 4 +- docs/api/did-comm.ididcommmessage.type.md | 2 +- ...mm.ididcommmessageattachment.byte_count.md | 2 +- ...did-comm.ididcommmessageattachment.data.md | 2 +- ...m.ididcommmessageattachment.description.md | 2 +- ...comm.ididcommmessageattachment.filename.md | 2 +- ...d-comm.ididcommmessageattachment.format.md | 2 +- .../did-comm.ididcommmessageattachment.id.md | 2 +- ....ididcommmessageattachment.lastmod_time.md | 2 +- .../api/did-comm.ididcommmessageattachment.md | 2 +- ...mm.ididcommmessageattachment.media_type.md | 2 +- ...mm.ididcommmessageattachmentdata.base64.md | 2 +- ...comm.ididcommmessageattachmentdata.hash.md | 2 +- ...comm.ididcommmessageattachmentdata.json.md | 2 +- ...-comm.ididcommmessageattachmentdata.jws.md | 2 +- ...omm.ididcommmessageattachmentdata.links.md | 2 +- .../did-comm.ididcommmessageattachmentdata.md | 2 +- docs/api/did-comm.ididcommmessagemetadata.md | 2 +- ...id-comm.ididcommmessagemetadata.packing.md | 2 +- docs/api/did-comm.ididcommoptions.alg.md | 2 +- docs/api/did-comm.ididcommoptions.bcc.md | 2 +- docs/api/did-comm.ididcommoptions.enc.md | 2 +- docs/api/did-comm.ididcommoptions.md | 2 +- .../did-comm.ididcommoptions.recipientkids.md | 2 +- docs/api/did-comm.ididcommtransport.id.md | 2 +- ...mm.ididcommtransport.isservicesupported.md | 2 +- docs/api/did-comm.ididcommtransport.md | 2 +- docs/api/did-comm.ididcommtransport.send.md | 2 +- .../did-comm.ididcommtransportresult.error.md | 2 +- docs/api/did-comm.ididcommtransportresult.md | 2 +- ...did-comm.ididcommtransportresult.result.md | 2 +- ...m.ididcommtransportresult.returnmessage.md | 2 +- ...did-comm.ipackdidcommmessageargs.keyref.md | 2 +- docs/api/did-comm.ipackdidcommmessageargs.md | 6 +- ...id-comm.ipackdidcommmessageargs.message.md | 2 +- ...id-comm.ipackdidcommmessageargs.options.md | 2 +- ...id-comm.ipackdidcommmessageargs.packing.md | 2 +- docs/api/did-comm.ipackeddidcommmessage.md | 2 +- .../did-comm.ipackeddidcommmessage.message.md | 2 +- docs/api/did-comm.isenddidcommmessageargs.md | 6 +- ...-comm.isenddidcommmessageargs.messageid.md | 2 +- ...m.isenddidcommmessageargs.packedmessage.md | 2 +- ...isenddidcommmessageargs.recipientdidurl.md | 2 +- ...enddidcommmessageargs.returntransportid.md | 2 +- .../did-comm.isenddidcommmessageresponse.md | 2 +- ...enddidcommmessageresponse.returnmessage.md | 2 +- ...isenddidcommmessageresponse.transportid.md | 2 +- ...comm.isendmessagedidcommalpha1args.data.md | 2 +- ...m.isendmessagedidcommalpha1args.headers.md | 2 +- .../did-comm.isendmessagedidcommalpha1args.md | 2 +- ...comm.isendmessagedidcommalpha1args.save.md | 2 +- ...-comm.isendmessagedidcommalpha1args.url.md | 2 +- .../api/did-comm.iunpackdidcommmessageargs.md | 6 +- docs/api/did-comm.iunpackeddidcommmessage.md | 2 +- ...id-comm.iunpackeddidcommmessage.message.md | 2 +- ...d-comm.iunpackeddidcommmessage.metadata.md | 2 +- docs/api/did-comm.md | 27 +- .../api/did-comm.mediate_deny_message_type.md | 2 +- .../did-comm.mediate_grant_message_type.md | 2 +- .../did-comm.mediate_request_message_type.md | 2 +- docs/api/did-comm.messagepickup.md | 2 +- ...kupmediatormessagehandler._constructor_.md | 2 +- ...omm.pickupmediatormessagehandler.handle.md | 2 +- .../did-comm.pickupmediatormessagehandler.md | 2 +- ...uprecipientmessagehandler._constructor_.md | 2 +- ...mm.pickuprecipientmessagehandler.handle.md | 2 +- .../did-comm.pickuprecipientmessagehandler.md | 2 +- docs/api/did-comm.recipientupdateresult.md | 2 +- ...omm.routingmessagehandler._constructor_.md | 2 +- .../did-comm.routingmessagehandler.handle.md | 2 +- docs/api/did-comm.routingmessagehandler.md | 2 +- docs/api/did-comm.schema.md | 702 +++ .../did-comm.status_request_message_type.md | 2 +- ...m.trustpingmessagehandler._constructor_.md | 2 +- ...did-comm.trustpingmessagehandler.handle.md | 2 +- docs/api/did-comm.trustpingmessagehandler.md | 2 +- docs/api/did-comm.update.action.md | 2 +- docs/api/did-comm.update.md | 2 +- docs/api/did-comm.update.recipient_did.md | 2 +- docs/api/did-comm.updateaction.md | 2 +- docs/api/did-comm.updateresult.md | 2 +- docs/api/did-comm.updateresult.result.md | 2 +- ...id-discovery.diddiscovery._constructor_.md | 2 +- .../did-discovery.diddiscovery.discoverdid.md | 2 +- docs/api/did-discovery.diddiscovery.md | 2 +- .../api/did-discovery.diddiscovery.methods.md | 2 +- .../did-discovery.diddiscovery.providers.md | 2 +- docs/api/did-discovery.diddiscovery.schema.md | 2 +- .../did-discovery.ididdiscovermatch.did.md | 2 +- docs/api/did-discovery.ididdiscovermatch.md | 2 +- ...id-discovery.ididdiscovermatch.metadata.md | 2 +- ...did-discovery.ididdiscovery.discoverdid.md | 2 +- docs/api/did-discovery.ididdiscovery.md | 2 +- ...-discovery.ididdiscoverydiscoverdidargs.md | 2 +- ...ry.ididdiscoverydiscoverdidargs.options.md | 2 +- ...very.ididdiscoverydiscoverdidargs.query.md | 2 +- ...y.ididdiscoverydiscoverdidresult.errors.md | 2 +- ...iscovery.ididdiscoverydiscoverdidresult.md | 2 +- ....ididdiscoverydiscoverdidresult.results.md | 2 +- ...ery.ididdiscoveryproviderresult.matches.md | 2 +- ...d-discovery.ididdiscoveryproviderresult.md | 2 +- ...ry.ididdiscoveryproviderresult.provider.md | 2 +- docs/api/did-discovery.md | 6 + docs/api/did-discovery.schema.md | 110 + ...ager.aliasdiscoveryprovider.discoverdid.md | 2 +- .../api/did-manager.aliasdiscoveryprovider.md | 2 +- ...did-manager.aliasdiscoveryprovider.name.md | 2 +- .../did-manager.memorydidstore.deletedid.md | 2 +- docs/api/did-manager.memorydidstore.getdid.md | 2 +- .../did-manager.memorydidstore.importdid.md | 2 +- .../did-manager.memorydidstore.listdids.md | 2 +- docs/api/did-manager.memorydidstore.md | 2 +- ...ovider-jwk.jwkdidprovider._constructor_.md | 2 +- .../did-provider-jwk.jwkdidprovider.addkey.md | 2 +- ...-provider-jwk.jwkdidprovider.addservice.md | 2 +- ...der-jwk.jwkdidprovider.createidentifier.md | 2 +- ...der-jwk.jwkdidprovider.deleteidentifier.md | 2 +- docs/api/did-provider-jwk.jwkdidprovider.md | 2 +- ...d-provider-jwk.jwkdidprovider.removekey.md | 2 +- ...ovider-jwk.jwkdidprovider.removeservice.md | 2 +- ...der-jwk.jwkdidprovider.updateidentifier.md | 2 +- ...ovider-key.keydidprovider._constructor_.md | 2 +- .../did-provider-key.keydidprovider.addkey.md | 2 +- ...-provider-key.keydidprovider.addservice.md | 2 +- ...der-key.keydidprovider.createidentifier.md | 2 +- ...der-key.keydidprovider.deleteidentifier.md | 2 +- docs/api/did-provider-key.keydidprovider.md | 2 +- ...d-provider-key.keydidprovider.removekey.md | 2 +- ...ovider-key.keydidprovider.removeservice.md | 2 +- ...der-key.keydidprovider.updateidentifier.md | 2 +- ...ider-peer.peerdidprovider._constructor_.md | 2 +- ...id-provider-peer.peerdidprovider.addkey.md | 2 +- ...rovider-peer.peerdidprovider.addservice.md | 2 +- ...r-peer.peerdidprovider.createidentifier.md | 12 +- ...r-peer.peerdidprovider.deleteidentifier.md | 2 +- docs/api/did-provider-peer.peerdidprovider.md | 2 +- ...provider-peer.peerdidprovider.removekey.md | 2 +- ...ider-peer.peerdidprovider.removeservice.md | 2 +- ...r-peer.peerdidprovider.updateidentifier.md | 2 +- ...ovider-pkh.pkhdidprovider._constructor_.md | 2 +- .../did-provider-pkh.pkhdidprovider.addkey.md | 2 +- ...-provider-pkh.pkhdidprovider.addservice.md | 2 +- ...der-pkh.pkhdidprovider.createidentifier.md | 2 +- ...der-pkh.pkhdidprovider.deleteidentifier.md | 2 +- docs/api/did-provider-pkh.pkhdidprovider.md | 2 +- ...d-provider-pkh.pkhdidprovider.removekey.md | 2 +- ...ovider-pkh.pkhdidprovider.removeservice.md | 2 +- ...der-pkh.pkhdidprovider.updateidentifier.md | 2 +- docs/api/key-manager.eip712payload.md | 2 +- ...3.web3keymanagementsystem._constructor_.md | 2 +- ...-web3.web3keymanagementsystem.createkey.md | 2 +- ...-web3.web3keymanagementsystem.deletekey.md | 2 +- ...-web3.web3keymanagementsystem.importkey.md | 2 +- ...s-web3.web3keymanagementsystem.listkeys.md | 2 +- docs/api/kms-web3.web3keymanagementsystem.md | 2 +- ...b3.web3keymanagementsystem.sharedsecret.md | 2 +- .../kms-web3.web3keymanagementsystem.sign.md | 2 +- docs/api/remote-client.getopenapischema.md | 18 +- docs/api/remote-client.md | 8 +- docs/api/remote-server.agentrouter.md | 16 +- docs/api/remote-server.apischemarouter.md | 16 +- docs/api/remote-server.createdefaultdid.md | 2 +- docs/api/remote-server.md | 24 +- docs/api/remote-server.messagingrouter.md | 16 +- .../remote-server.requestwithagentrouter.md | 16 +- docs/api/remote-server.webdiddocrouter.md | 16 +- ...re.icreateprofilecredentialsargs.holder.md | 2 +- ...isclosure.icreateprofilecredentialsargs.md | 2 +- ...sure.icreateprofilecredentialsargs.name.md | 2 +- ...e.icreateprofilecredentialsargs.picture.md | 2 +- ...sure.icreateprofilecredentialsargs.save.md | 2 +- ...sure.icreateprofilecredentialsargs.send.md | 2 +- ...osure.icreateprofilecredentialsargs.url.md | 2 +- ....icreateprofilecredentialsargs.verifier.md | 2 +- ...eateselectivedisclosurerequestargs.data.md | 2 +- ...e.icreateselectivedisclosurerequestargs.md | 2 +- ...osure.icredentialrequestinput.claimtype.md | 2 +- ...sure.icredentialrequestinput.claimvalue.md | 2 +- ...redentialrequestinput.credentialcontext.md | 2 +- ....icredentialrequestinput.credentialtype.md | 2 +- ...osure.icredentialrequestinput.essential.md | 2 +- ...closure.icredentialrequestinput.issuers.md | 2 +- ...tive-disclosure.icredentialrequestinput.md | 2 +- ...sclosure.icredentialrequestinput.reason.md | 2 +- ...sclosure.icredentialsforsdr.credentials.md | 2 +- ...selective-disclosure.icredentialsforsdr.md | 2 +- ...igetverifiablecredentialsforsdrargs.did.md | 2 +- ...ure.igetverifiablecredentialsforsdrargs.md | 2 +- ...igetverifiablecredentialsforsdrargs.sdr.md | 2 +- ...re.ipresentationvalidationresult.claims.md | 2 +- ...isclosure.ipresentationvalidationresult.md | 2 +- ...ure.ipresentationvalidationresult.valid.md | 2 +- ...ivedisclosure.createprofilepresentation.md | 2 +- ...losure.createselectivedisclosurerequest.md | 2 +- ...sclosure.getverifiablecredentialsforsdr.md | 2 +- ...lective-disclosure.iselectivedisclosure.md | 2 +- ...sclosure.validatepresentationagainstsdr.md | 2 +- ...sure.iselectivedisclosurerequest.claims.md | 2 +- ...iselectivedisclosurerequest.credentials.md | 2 +- ...sure.iselectivedisclosurerequest.issuer.md | 2 +- ...-disclosure.iselectivedisclosurerequest.md | 2 +- ...re.iselectivedisclosurerequest.replyurl.md | 2 +- ...ure.iselectivedisclosurerequest.subject.md | 2 +- ...closure.iselectivedisclosurerequest.tag.md | 2 +- docs/api/selective-disclosure.issuer.did.md | 2 +- docs/api/selective-disclosure.issuer.md | 2 +- docs/api/selective-disclosure.issuer.url.md | 2 +- ...ure.ivalidatepresentationagainstsdrargs.md | 2 +- ...presentationagainstsdrargs.presentation.md | 2 +- ...ivalidatepresentationagainstsdrargs.sdr.md | 2 +- docs/api/selective-disclosure.md | 9 +- docs/api/selective-disclosure.messagetypes.md | 4 +- docs/api/selective-disclosure.schema.md | 487 ++ ...ive-disclosure.sdrmessagehandler.handle.md | 2 +- .../selective-disclosure.sdrmessagehandler.md | 6 +- ...osure.selectivedisclosure._constructor_.md | 2 +- ...ivedisclosure.createprofilepresentation.md | 2 +- ...losure.createselectivedisclosurerequest.md | 4 +- ...sclosure.getverifiablecredentialsforsdr.md | 2 +- ...elective-disclosure.selectivedisclosure.md | 18 +- ...-disclosure.selectivedisclosure.methods.md | 2 +- ...e-disclosure.selectivedisclosure.schema.md | 27 +- ...sclosure.validatepresentationagainstsdr.md | 4 +- docs/api/utils.asarray.md | 2 +- docs/api/utils.bytestohex.md | 2 +- .../utils.compressidentifiersecp256k1keys.md | 2 +- docs/api/utils.computeentryhash.md | 2 +- docs/api/utils.concat.md | 2 +- .../utils.converted25519privatekeytox25519.md | 2 +- .../utils.converted25519publickeytox25519.md | 2 +- .../utils.convertidentifierencryptionkeys.md | 4 +- docs/api/utils.createjwk.md | 31 + docs/api/utils.decodebase64url.md | 2 +- docs/api/utils.decodecredentialtoobject.md | 2 +- docs/api/utils.decodejoseblob.md | 2 +- docs/api/utils.decodepresentationtoobject.md | 2 +- docs/api/utils.dereferencedidkeys.md | 2 +- docs/api/utils.encodebase64url.md | 2 +- docs/api/utils.encodejoseblob.md | 2 +- docs/api/utils.extractissuer.md | 2 +- docs/api/utils.extractpublickeyhex.md | 14 +- ...ainidfordidethr.md => utils.getchainid.md} | 10 +- docs/api/utils.getethereumaddress.md | 2 +- docs/api/utils.hextobytes.md | 2 +- docs/api/utils.isdefined.md | 2 +- docs/api/utils.isiterable.md | 2 +- docs/api/utils.mapidentifierkeystodoc.md | 14 +- docs/api/utils.md | 71 +- docs/api/utils.processentrytoarray.md | 2 +- docs/api/utils.recordlike.md | 2 +- docs/api/utils.removedidparameters.md | 2 +- docs/api/utils.resolvedidorthrow.md | 12 +- package.json | 2 +- 756 files changed, 8847 insertions(+), 921 deletions(-) create mode 100644 docs/api/core-types.schema.md create mode 100644 docs/api/core-types.usingresolutionoptions.md create mode 100644 docs/api/core-types.usingresolutionoptions.resolutionoptions.md create mode 100644 docs/api/credential-eip712.schema.md create mode 100644 docs/api/credential-ld.schema.md create mode 100644 docs/api/credential-ld.veramoecdsasecp256k1recoverysignature2020.md create mode 100644 docs/api/credential-ld.veramoed25519signature2018.md create mode 100644 docs/api/credential-ld.veramoed25519signature2020.md create mode 100644 docs/api/credential-ld.veramojsonwebsignature2020.md create mode 100644 docs/api/credential-ld.veramoldsignature.md create mode 100644 docs/api/credential-w3c.credentialplugin.matchkeyforjwt.md create mode 100644 docs/api/did-comm.schema.md create mode 100644 docs/api/did-discovery.schema.md create mode 100644 docs/api/selective-disclosure.schema.md create mode 100644 docs/api/utils.createjwk.md rename docs/api/{utils.getchainidfordidethr.md => utils.getchainid.md} (66%) diff --git a/docs/api/core-types.authorizeddidcontext.authorizeddid.md b/docs/api/core-types.authorizeddidcontext.authorizeddid.md index 82a5fc90..b3db4d72 100644 --- a/docs/api/core-types.authorizeddidcontext.authorizeddid.md +++ b/docs/api/core-types.authorizeddidcontext.authorizeddid.md @@ -8,7 +8,7 @@ hide_title: true ## AuthorizedDIDContext.authorizedDID property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.authorizeddidcontext.md b/docs/api/core-types.authorizeddidcontext.md index 0fe67dc2..a9e6148e 100644 --- a/docs/api/core-types.authorizeddidcontext.md +++ b/docs/api/core-types.authorizeddidcontext.md @@ -8,7 +8,7 @@ hide_title: true ## AuthorizedDIDContext interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This context can be used for Veramo Agents that are created behind an authorization mechanism, that attaches a DID as the authorized executor of certain actions. This authorized DID is used to further filter the data that is available for querying. diff --git a/docs/api/core-types.compactjwt.md b/docs/api/core-types.compactjwt.md index c8e4abdf..6ab74c7e 100644 --- a/docs/api/core-types.compactjwt.md +++ b/docs/api/core-types.compactjwt.md @@ -8,7 +8,7 @@ hide_title: true ## CompactJWT type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Represents a Json Web Token in compact form. "header.payload.signature" diff --git a/docs/api/core-types.contexttype.md b/docs/api/core-types.contexttype.md index 5e337c3a..1dff4214 100644 --- a/docs/api/core-types.contexttype.md +++ b/docs/api/core-types.contexttype.md @@ -8,7 +8,7 @@ hide_title: true ## ContextType type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The data type for `@context` properties of credentials, presentations, etc. diff --git a/docs/api/core-types.credentialpayload.__context_.md b/docs/api/core-types.credentialpayload.__context_.md index 1d610144..e1a67483 100644 --- a/docs/api/core-types.credentialpayload.__context_.md +++ b/docs/api/core-types.credentialpayload.__context_.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialPayload."@context" property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.credentialpayload.credentialstatus.md b/docs/api/core-types.credentialpayload.credentialstatus.md index 25f1bfed..4d3fb484 100644 --- a/docs/api/core-types.credentialpayload.credentialstatus.md +++ b/docs/api/core-types.credentialpayload.credentialstatus.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialPayload.credentialStatus property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.credentialpayload.credentialsubject.md b/docs/api/core-types.credentialpayload.credentialsubject.md index 9a818953..4eaa5207 100644 --- a/docs/api/core-types.credentialpayload.credentialsubject.md +++ b/docs/api/core-types.credentialpayload.credentialsubject.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialPayload.credentialSubject property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.credentialpayload.expirationdate.md b/docs/api/core-types.credentialpayload.expirationdate.md index 63a13c03..7a3fe417 100644 --- a/docs/api/core-types.credentialpayload.expirationdate.md +++ b/docs/api/core-types.credentialpayload.expirationdate.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialPayload.expirationDate property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.credentialpayload.id.md b/docs/api/core-types.credentialpayload.id.md index 2c0b52fa..bf145cf8 100644 --- a/docs/api/core-types.credentialpayload.id.md +++ b/docs/api/core-types.credentialpayload.id.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialPayload.id property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.credentialpayload.issuancedate.md b/docs/api/core-types.credentialpayload.issuancedate.md index d2bf1d33..a3b99f7a 100644 --- a/docs/api/core-types.credentialpayload.issuancedate.md +++ b/docs/api/core-types.credentialpayload.issuancedate.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialPayload.issuanceDate property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.credentialpayload.issuer.md b/docs/api/core-types.credentialpayload.issuer.md index 410f73f5..672d264b 100644 --- a/docs/api/core-types.credentialpayload.issuer.md +++ b/docs/api/core-types.credentialpayload.issuer.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialPayload.issuer property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.credentialpayload.md b/docs/api/core-types.credentialpayload.md index 719892bd..04aaf181 100644 --- a/docs/api/core-types.credentialpayload.md +++ b/docs/api/core-types.credentialpayload.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialPayload interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Used as input when creating Verifiable Credentials diff --git a/docs/api/core-types.credentialpayload.type.md b/docs/api/core-types.credentialpayload.type.md index a226787d..8c836aec 100644 --- a/docs/api/core-types.credentialpayload.type.md +++ b/docs/api/core-types.credentialpayload.type.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialPayload.type property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.credentialstatus.md b/docs/api/core-types.credentialstatus.md index f45a7ed2..7f0c225e 100644 --- a/docs/api/core-types.credentialstatus.md +++ b/docs/api/core-types.credentialstatus.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialStatus type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Represents the result of a status check. diff --git a/docs/api/core-types.credentialstatusgenerateargs.md b/docs/api/core-types.credentialstatusgenerateargs.md index e9d2fc62..d94ac7ee 100644 --- a/docs/api/core-types.credentialstatusgenerateargs.md +++ b/docs/api/core-types.credentialstatusgenerateargs.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialStatusGenerateArgs interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Arguments for generating a `credentialStatus` property for a [VerifiableCredential](./core-types.verifiablecredential.md). diff --git a/docs/api/core-types.credentialstatusgenerateargs.type.md b/docs/api/core-types.credentialstatusgenerateargs.type.md index 39246f39..3607e6d6 100644 --- a/docs/api/core-types.credentialstatusgenerateargs.type.md +++ b/docs/api/core-types.credentialstatusgenerateargs.type.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialStatusGenerateArgs.type property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The credential status type (aka credential status method) to be used in the `credentialStatus` generation. diff --git a/docs/api/core-types.credentialstatusreference.md b/docs/api/core-types.credentialstatusreference.md index 116e246b..5547ffba 100644 --- a/docs/api/core-types.credentialstatusreference.md +++ b/docs/api/core-types.credentialstatusreference.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialStatusReference type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Used for the discovery of information about the current status of a verifiable credential, such as whether it is suspended or revoked. The precise contents of the credential status information is determined by the specific `credentialStatus` type definition, and varies depending on factors such as whether it is simple to implement or if it is privacy-enhancing. diff --git a/docs/api/core-types.credentialstatusupdateargs.md b/docs/api/core-types.credentialstatusupdateargs.md index 6cd59fc3..d5a6704e 100644 --- a/docs/api/core-types.credentialstatusupdateargs.md +++ b/docs/api/core-types.credentialstatusupdateargs.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialStatusUpdateArgs interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Input arguments for [credentialStatusUpdate](./core-types.icredentialstatusmanager.credentialstatusupdate.md) diff --git a/docs/api/core-types.credentialstatusupdateargs.options.md b/docs/api/core-types.credentialstatusupdateargs.options.md index c634c254..fe686be6 100644 --- a/docs/api/core-types.credentialstatusupdateargs.options.md +++ b/docs/api/core-types.credentialstatusupdateargs.options.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialStatusUpdateArgs.options property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Options that will be forwarded to the credentialStatus method specific manager. diff --git a/docs/api/core-types.credentialstatusupdateargs.vc.md b/docs/api/core-types.credentialstatusupdateargs.vc.md index 18654bb7..53762bb5 100644 --- a/docs/api/core-types.credentialstatusupdateargs.vc.md +++ b/docs/api/core-types.credentialstatusupdateargs.vc.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialStatusUpdateArgs.vc property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The verifiable credential whose status will be updated. diff --git a/docs/api/core-types.credentialsubject.md b/docs/api/core-types.credentialsubject.md index 3f8b6795..8a7c0c36 100644 --- a/docs/api/core-types.credentialsubject.md +++ b/docs/api/core-types.credentialsubject.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialSubject type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The value of the credentialSubject property is defined as a set of objects that contain one or more properties that are each related to a subject of the verifiable credential. Each object MAY contain an id. diff --git a/docs/api/core-types.datetype.md b/docs/api/core-types.datetype.md index 677034ca..77674ec9 100644 --- a/docs/api/core-types.datetype.md +++ b/docs/api/core-types.datetype.md @@ -8,7 +8,7 @@ hide_title: true ## DateType type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Represents an issuance or expiration date for Credentials / Presentations. This is used as input when creating them. diff --git a/docs/api/core-types.diddoccomponent.md b/docs/api/core-types.diddoccomponent.md index 8251ebcc..5901a3eb 100644 --- a/docs/api/core-types.diddoccomponent.md +++ b/docs/api/core-types.diddoccomponent.md @@ -8,7 +8,7 @@ hide_title: true ## DIDDocComponent type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Return type of [getDIDComponentById](./core-types.iresolver.getdidcomponentbyid.md) represents a `VerificationMethod` or a `ServiceEndpoint` entry from a This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/core-types.findargs.md b/docs/api/core-types.findargs.md index 9ff5b201..a20874f8 100644 --- a/docs/api/core-types.findargs.md +++ b/docs/api/core-types.findargs.md @@ -8,7 +8,7 @@ hide_title: true ## FindArgs interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Represents an [IDataStoreORM](./core-types.idatastoreorm.md) Query. diff --git a/docs/api/core-types.findargs.order.md b/docs/api/core-types.findargs.order.md index d5421c60..6b6dc8d8 100644 --- a/docs/api/core-types.findargs.order.md +++ b/docs/api/core-types.findargs.order.md @@ -8,7 +8,7 @@ hide_title: true ## FindArgs.order property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Sorts the results according to the given array of column priorities. diff --git a/docs/api/core-types.findargs.skip.md b/docs/api/core-types.findargs.skip.md index 3b0d491a..d552d22a 100644 --- a/docs/api/core-types.findargs.skip.md +++ b/docs/api/core-types.findargs.skip.md @@ -8,7 +8,7 @@ hide_title: true ## FindArgs.skip property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Ignores the first number of entries in a [IDataStoreORM](./core-types.idatastoreorm.md) query result. diff --git a/docs/api/core-types.findargs.take.md b/docs/api/core-types.findargs.take.md index 70d09936..36871e1c 100644 --- a/docs/api/core-types.findargs.take.md +++ b/docs/api/core-types.findargs.take.md @@ -8,7 +8,7 @@ hide_title: true ## FindArgs.take property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Returns at most this number of results from a [IDataStoreORM](./core-types.idatastoreorm.md) query. diff --git a/docs/api/core-types.findargs.where.md b/docs/api/core-types.findargs.where.md index df1e4929..b7093be6 100644 --- a/docs/api/core-types.findargs.where.md +++ b/docs/api/core-types.findargs.where.md @@ -8,7 +8,7 @@ hide_title: true ## FindArgs.where property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Imposes constraints on the values of the given columns. WHERE clauses are combined using AND. diff --git a/docs/api/core-types.findclaimsargs.md b/docs/api/core-types.findclaimsargs.md index 714f467e..73df0ff9 100644 --- a/docs/api/core-types.findclaimsargs.md +++ b/docs/api/core-types.findclaimsargs.md @@ -8,7 +8,7 @@ hide_title: true ## FindClaimsArgs type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The filter that can be used to find [VerifiableCredential](./core-types.verifiablecredential.md)s in the data store, based on the types and values of their claims. diff --git a/docs/api/core-types.findcredentialsargs.md b/docs/api/core-types.findcredentialsargs.md index 88ab949b..be7275ba 100644 --- a/docs/api/core-types.findcredentialsargs.md +++ b/docs/api/core-types.findcredentialsargs.md @@ -8,7 +8,7 @@ hide_title: true ## FindCredentialsArgs type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The filter that can be used to find [VerifiableCredential](./core-types.verifiablecredential.md)s in the data store. See [IDataStoreORM.dataStoreORMGetVerifiableCredentials()](./core-types.idatastoreorm.datastoreormgetverifiablecredentials.md) diff --git a/docs/api/core-types.findidentifiersargs.md b/docs/api/core-types.findidentifiersargs.md index b99777c1..3a05b2d4 100644 --- a/docs/api/core-types.findidentifiersargs.md +++ b/docs/api/core-types.findidentifiersargs.md @@ -8,7 +8,7 @@ hide_title: true ## FindIdentifiersArgs type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The filter that can be used to find [IIdentifier](./core-types.iidentifier.md)s in the data store. diff --git a/docs/api/core-types.findmessagesargs.md b/docs/api/core-types.findmessagesargs.md index b317555f..1ecdbf30 100644 --- a/docs/api/core-types.findmessagesargs.md +++ b/docs/api/core-types.findmessagesargs.md @@ -8,7 +8,7 @@ hide_title: true ## FindMessagesArgs type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The filter that can be used to find [IMessage](./core-types.imessage.md)s in the data store. See [IDataStoreORM.dataStoreORMGetMessages()](./core-types.idatastoreorm.datastoreormgetmessages.md) diff --git a/docs/api/core-types.findpresentationsargs.md b/docs/api/core-types.findpresentationsargs.md index 428e38fb..ad8d0b6d 100644 --- a/docs/api/core-types.findpresentationsargs.md +++ b/docs/api/core-types.findpresentationsargs.md @@ -8,7 +8,7 @@ hide_title: true ## FindPresentationsArgs type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The filter that can be used to find [VerifiablePresentation](./core-types.verifiablepresentation.md)s in the data store. See [IDataStoreORM.dataStoreORMGetVerifiablePresentations()](./core-types.idatastoreorm.datastoreormgetverifiablepresentations.md) diff --git a/docs/api/core-types.getdidcomponentargs.diddocument.md b/docs/api/core-types.getdidcomponentargs.diddocument.md index 06151ef7..826b813c 100644 --- a/docs/api/core-types.getdidcomponentargs.diddocument.md +++ b/docs/api/core-types.getdidcomponentargs.diddocument.md @@ -8,7 +8,7 @@ hide_title: true ## GetDIDComponentArgs.didDocument property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. the DID document from which to extract the fragment. This MUST be the document resolved by [IResolver.resolveDid()](./core-types.iresolver.resolvedid.md) diff --git a/docs/api/core-types.getdidcomponentargs.didurl.md b/docs/api/core-types.getdidcomponentargs.didurl.md index 6623d1e3..12739d7f 100644 --- a/docs/api/core-types.getdidcomponentargs.didurl.md +++ b/docs/api/core-types.getdidcomponentargs.didurl.md @@ -8,7 +8,7 @@ hide_title: true ## GetDIDComponentArgs.didUrl property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The DID URI that needs to be dereferenced. This should refer to the subsection by \#fragment. diff --git a/docs/api/core-types.getdidcomponentargs.md b/docs/api/core-types.getdidcomponentargs.md index 5a987638..4ba4b671 100644 --- a/docs/api/core-types.getdidcomponentargs.md +++ b/docs/api/core-types.getdidcomponentargs.md @@ -8,7 +8,7 @@ hide_title: true ## GetDIDComponentArgs interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Input arguments for [getDIDComponentById](./core-types.iresolver.getdidcomponentbyid.md) This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/core-types.getdidcomponentargs.section.md b/docs/api/core-types.getdidcomponentargs.section.md index 14c8f479..adb85be9 100644 --- a/docs/api/core-types.getdidcomponentargs.section.md +++ b/docs/api/core-types.getdidcomponentargs.section.md @@ -8,7 +8,7 @@ hide_title: true ## GetDIDComponentArgs.section property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Optional. The section of the DID document where to search for the fragment. Example 'keyAgreement', or 'assertionMethod', or 'authentication', etc diff --git a/docs/api/core-types.icheckcredentialstatusargs.credential.md b/docs/api/core-types.icheckcredentialstatusargs.credential.md index 548ae409..f5329071 100644 --- a/docs/api/core-types.icheckcredentialstatusargs.credential.md +++ b/docs/api/core-types.icheckcredentialstatusargs.credential.md @@ -8,7 +8,7 @@ hide_title: true ## ICheckCredentialStatusArgs.credential property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The credential whose status needs to be checked diff --git a/docs/api/core-types.icheckcredentialstatusargs.diddocumentoverride.md b/docs/api/core-types.icheckcredentialstatusargs.diddocumentoverride.md index a6fcfedd..767d2a99 100644 --- a/docs/api/core-types.icheckcredentialstatusargs.diddocumentoverride.md +++ b/docs/api/core-types.icheckcredentialstatusargs.diddocumentoverride.md @@ -8,7 +8,7 @@ hide_title: true ## ICheckCredentialStatusArgs.didDocumentOverride property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The DID document of the issuer. This can be used in case the DID Document is already resolver, to avoid a potentially expensive DID resolution operation. diff --git a/docs/api/core-types.icheckcredentialstatusargs.md b/docs/api/core-types.icheckcredentialstatusargs.md index 5162e735..e8da5723 100644 --- a/docs/api/core-types.icheckcredentialstatusargs.md +++ b/docs/api/core-types.icheckcredentialstatusargs.md @@ -8,7 +8,7 @@ hide_title: true ## ICheckCredentialStatusArgs interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Arguments for calling [checkCredentialStatus](./core-types.icredentialstatusverifier.checkcredentialstatus.md). @@ -21,9 +21,11 @@ This API may change without a BREAKING CHANGE notice. **Signature:** ```typescript -export interface ICheckCredentialStatusArgs +export interface ICheckCredentialStatusArgs extends UsingResolutionOptions ``` +**Extends:** [UsingResolutionOptions](./core-types.usingresolutionoptions.md) + ## Properties | Property | Modifiers | Type | Description | diff --git a/docs/api/core-types.icreateverifiablecredentialargs.md b/docs/api/core-types.icreateverifiablecredentialargs.md index 61a0dd67..81dfe286 100644 --- a/docs/api/core-types.icreateverifiablecredentialargs.md +++ b/docs/api/core-types.icreateverifiablecredentialargs.md @@ -13,9 +13,11 @@ Encapsulates the parameters required to create a [W3C Verifiable Credential](htt **Signature:** ```typescript -export interface ICreateVerifiableCredentialArgs +export interface ICreateVerifiableCredentialArgs extends UsingResolutionOptions ``` +**Extends:** [UsingResolutionOptions](./core-types.usingresolutionoptions.md) + ## Properties | Property | Modifiers | Type | Description | @@ -23,6 +25,6 @@ export interface ICreateVerifiableCredentialArgs | [credential](./core-types.icreateverifiablecredentialargs.credential.md) | | [CredentialPayload](./core-types.credentialpayload.md) |

The JSON payload of the Credential according to the [canonical model](https://www.w3.org/TR/vc-data-model/#credentials)

The signer of the Credential is chosen based on the issuer.id property of the credential

@context, type and issuanceDate will be added automatically if omitted

| | [fetchRemoteContexts?](./core-types.icreateverifiablecredentialargs.fetchremotecontexts.md) | | boolean |

_(Optional)_ When dealing with JSON-LD you also MUST provide the proper contexts. Set this to true ONLY if you want the @context URLs to be fetched in case they are not preloaded. The context definitions SHOULD rather be provided at startup instead of being fetched.

Defaults to false

| | [keyRef?](./core-types.icreateverifiablecredentialargs.keyref.md) | | string | _(Optional)_ \[Optional\] The ID of the key that should sign this credential. If this is not specified, the first matching key will be used. | -| [proofFormat](./core-types.icreateverifiablecredentialargs.proofformat.md) | | [ProofFormat](./core-types.proofformat.md) | The desired format for the VerifiablePresentation to be created. | +| [proofFormat](./core-types.icreateverifiablecredentialargs.proofformat.md) | | [ProofFormat](./core-types.proofformat.md) | The desired format for the VerifiableCredential to be created. | | [removeOriginalFields?](./core-types.icreateverifiablecredentialargs.removeoriginalfields.md) | | boolean | _(Optional)_ Remove payload members during JWT-JSON transformation. Defaults to true. See https://www.w3.org/TR/vc-data-model/\#jwt-encoding | -| [save?](./core-types.icreateverifiablecredentialargs.save.md) | | boolean | _(Optional)_ If this parameter is true, the resulting VerifiablePresentation is sent to the [storage plugin](./core-types.idatastore.md) to be saved. | +| [save?](./core-types.icreateverifiablecredentialargs.save.md) | | boolean | _(Optional)_ If this parameter is true, the resulting VerifiableCredential is sent to the [storage plugin](./core-types.idatastore.md) to be saved. | diff --git a/docs/api/core-types.icreateverifiablecredentialargs.proofformat.md b/docs/api/core-types.icreateverifiablecredentialargs.proofformat.md index 473384df..5e4d937a 100644 --- a/docs/api/core-types.icreateverifiablecredentialargs.proofformat.md +++ b/docs/api/core-types.icreateverifiablecredentialargs.proofformat.md @@ -8,7 +8,7 @@ hide_title: true ## ICreateVerifiableCredentialArgs.proofFormat property -The desired format for the VerifiablePresentation to be created. +The desired format for the VerifiableCredential to be created. **Signature:** diff --git a/docs/api/core-types.icreateverifiablecredentialargs.save.md b/docs/api/core-types.icreateverifiablecredentialargs.save.md index 639e167c..89f8cb27 100644 --- a/docs/api/core-types.icreateverifiablecredentialargs.save.md +++ b/docs/api/core-types.icreateverifiablecredentialargs.save.md @@ -12,7 +12,7 @@ hide_title: true > > Please call [dataStoreSaveVerifiableCredential()](./core-types.idatastore.datastoresaveverifiablecredential.md) to save the credential after creating it. -If this parameter is true, the resulting VerifiablePresentation is sent to the [storage plugin](./core-types.idatastore.md) to be saved. +If this parameter is true, the resulting VerifiableCredential is sent to the [storage plugin](./core-types.idatastore.md) to be saved. **Signature:** diff --git a/docs/api/core-types.icreateverifiablepresentationargs.md b/docs/api/core-types.icreateverifiablepresentationargs.md index a5a0564f..6c7aa9f8 100644 --- a/docs/api/core-types.icreateverifiablepresentationargs.md +++ b/docs/api/core-types.icreateverifiablepresentationargs.md @@ -13,9 +13,11 @@ Encapsulates the parameters required to create a [W3C Verifiable Presentation](h **Signature:** ```typescript -export interface ICreateVerifiablePresentationArgs +export interface ICreateVerifiablePresentationArgs extends UsingResolutionOptions ``` +**Extends:** [UsingResolutionOptions](./core-types.usingresolutionoptions.md) + ## Properties | Property | Modifiers | Type | Description | diff --git a/docs/api/core-types.icredentialissuer.listusableproofformats.md b/docs/api/core-types.icredentialissuer.listusableproofformats.md index 2c8ac5f4..1b397cce 100644 --- a/docs/api/core-types.icredentialissuer.listusableproofformats.md +++ b/docs/api/core-types.icredentialissuer.listusableproofformats.md @@ -8,7 +8,7 @@ hide_title: true ## ICredentialIssuer.listUsableProofFormats() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Returns a list of supported proof formats. diff --git a/docs/api/core-types.icredentialstatus.md b/docs/api/core-types.icredentialstatus.md index af2034dd..0f2e7643 100644 --- a/docs/api/core-types.icredentialstatus.md +++ b/docs/api/core-types.icredentialstatus.md @@ -8,7 +8,7 @@ hide_title: true ## ICredentialStatus type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Veramo plugin interface for plugins implementing both the [manager](./core-types.icredentialstatusmanager.md) and the [verifier](./core-types.icredentialstatusverifier.md) aspects of Credential Status flow. diff --git a/docs/api/core-types.icredentialstatusmanager.credentialstatusgenerate.md b/docs/api/core-types.icredentialstatusmanager.credentialstatusgenerate.md index c56f7dca..370e5b5c 100644 --- a/docs/api/core-types.icredentialstatusmanager.credentialstatusgenerate.md +++ b/docs/api/core-types.icredentialstatusmanager.credentialstatusgenerate.md @@ -8,7 +8,7 @@ hide_title: true ## ICredentialStatusManager.credentialStatusGenerate() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Generates a `credentialStatus` property for a future credential, not yet signed. diff --git a/docs/api/core-types.icredentialstatusmanager.credentialstatustypes.md b/docs/api/core-types.icredentialstatusmanager.credentialstatustypes.md index ec06d451..f2711611 100644 --- a/docs/api/core-types.icredentialstatusmanager.credentialstatustypes.md +++ b/docs/api/core-types.icredentialstatusmanager.credentialstatustypes.md @@ -8,7 +8,7 @@ hide_title: true ## ICredentialStatusManager.credentialStatusTypes() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. List all the credential status types (methods) available in the current agent instance. diff --git a/docs/api/core-types.icredentialstatusmanager.credentialstatusupdate.md b/docs/api/core-types.icredentialstatusmanager.credentialstatusupdate.md index 376572b6..f65021a2 100644 --- a/docs/api/core-types.icredentialstatusmanager.credentialstatusupdate.md +++ b/docs/api/core-types.icredentialstatusmanager.credentialstatusupdate.md @@ -8,7 +8,7 @@ hide_title: true ## ICredentialStatusManager.credentialStatusUpdate() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Changes the status of an existing [VerifiableCredential](./core-types.verifiablecredential.md). Commonly used to revoke an existing credential. diff --git a/docs/api/core-types.icredentialstatusmanager.md b/docs/api/core-types.icredentialstatusmanager.md index 1ba875bd..bdb69b6a 100644 --- a/docs/api/core-types.icredentialstatusmanager.md +++ b/docs/api/core-types.icredentialstatusmanager.md @@ -8,7 +8,7 @@ hide_title: true ## ICredentialStatusManager interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Credential status manager interface diff --git a/docs/api/core-types.icredentialstatusverifier.checkcredentialstatus.md b/docs/api/core-types.icredentialstatusverifier.checkcredentialstatus.md index 5015f3d7..3cc4bc5d 100644 --- a/docs/api/core-types.icredentialstatusverifier.checkcredentialstatus.md +++ b/docs/api/core-types.icredentialstatusverifier.checkcredentialstatus.md @@ -8,7 +8,7 @@ hide_title: true ## ICredentialStatusVerifier.checkCredentialStatus() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Checks the status of a [Verifiable Credential](./core-types.verifiablecredential.md). diff --git a/docs/api/core-types.icredentialstatusverifier.md b/docs/api/core-types.icredentialstatusverifier.md index 63848265..f3c8353f 100644 --- a/docs/api/core-types.icredentialstatusverifier.md +++ b/docs/api/core-types.icredentialstatusverifier.md @@ -8,7 +8,7 @@ hide_title: true ## ICredentialStatusVerifier interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This interface defines a plugin that can check the [status](https://www.w3.org/TR/vc-data-model/#status) of a [Verifiable Credential](./core-types.verifiablecredential.md). diff --git a/docs/api/core-types.idatastoreorm.datastoreormgetidentifiers.md b/docs/api/core-types.idatastoreorm.datastoreormgetidentifiers.md index 71e28fa0..4e84c6ba 100644 --- a/docs/api/core-types.idatastoreorm.datastoreormgetidentifiers.md +++ b/docs/api/core-types.idatastoreorm.datastoreormgetidentifiers.md @@ -8,7 +8,7 @@ hide_title: true ## IDataStoreORM.dataStoreORMGetIdentifiers() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. > Warning: This API is now obsolete. > diff --git a/docs/api/core-types.idatastoreorm.datastoreormgetidentifierscount.md b/docs/api/core-types.idatastoreorm.datastoreormgetidentifierscount.md index 4be0fbbe..d8717af9 100644 --- a/docs/api/core-types.idatastoreorm.datastoreormgetidentifierscount.md +++ b/docs/api/core-types.idatastoreorm.datastoreormgetidentifierscount.md @@ -8,7 +8,7 @@ hide_title: true ## IDataStoreORM.dataStoreORMGetIdentifiersCount() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. > Warning: This API is now obsolete. > diff --git a/docs/api/core-types.idatastoreorm.datastoreormgetmessages.md b/docs/api/core-types.idatastoreorm.datastoreormgetmessages.md index abe13534..97d56646 100644 --- a/docs/api/core-types.idatastoreorm.datastoreormgetmessages.md +++ b/docs/api/core-types.idatastoreorm.datastoreormgetmessages.md @@ -8,7 +8,7 @@ hide_title: true ## IDataStoreORM.dataStoreORMGetMessages() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Returns a list of [IMessage](./core-types.imessage.md)s that match the given filter. These are messages that were stored using [dataStoreSaveMessage](./core-types.idatastore.datastoresavemessage.md). diff --git a/docs/api/core-types.idatastoreorm.datastoreormgetmessagescount.md b/docs/api/core-types.idatastoreorm.datastoreormgetmessagescount.md index a1f47faa..27d8f402 100644 --- a/docs/api/core-types.idatastoreorm.datastoreormgetmessagescount.md +++ b/docs/api/core-types.idatastoreorm.datastoreormgetmessagescount.md @@ -8,7 +8,7 @@ hide_title: true ## IDataStoreORM.dataStoreORMGetMessagesCount() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Returns a count of [IMessage](./core-types.imessage.md)s that match the given filter. These are messages that were stored using [dataStoreSaveMessage](./core-types.idatastore.datastoresavemessage.md). diff --git a/docs/api/core-types.idatastoreorm.datastoreormgetverifiablecredentials.md b/docs/api/core-types.idatastoreorm.datastoreormgetverifiablecredentials.md index 18236e8f..99dd3b6a 100644 --- a/docs/api/core-types.idatastoreorm.datastoreormgetverifiablecredentials.md +++ b/docs/api/core-types.idatastoreorm.datastoreormgetverifiablecredentials.md @@ -8,7 +8,7 @@ hide_title: true ## IDataStoreORM.dataStoreORMGetVerifiableCredentials() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Returns a list of [UniqueVerifiableCredential](./core-types.uniqueverifiablecredential.md)s that match the given filter based on the top level properties of a credential. diff --git a/docs/api/core-types.idatastoreorm.datastoreormgetverifiablecredentialsbyclaims.md b/docs/api/core-types.idatastoreorm.datastoreormgetverifiablecredentialsbyclaims.md index 52d54b37..6b2ecbe8 100644 --- a/docs/api/core-types.idatastoreorm.datastoreormgetverifiablecredentialsbyclaims.md +++ b/docs/api/core-types.idatastoreorm.datastoreormgetverifiablecredentialsbyclaims.md @@ -8,7 +8,7 @@ hide_title: true ## IDataStoreORM.dataStoreORMGetVerifiableCredentialsByClaims() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Returns a list of [UniqueVerifiableCredential](./core-types.uniqueverifiablecredential.md)s that match the given filter based on the claims they contain. diff --git a/docs/api/core-types.idatastoreorm.datastoreormgetverifiablecredentialsbyclaimscount.md b/docs/api/core-types.idatastoreorm.datastoreormgetverifiablecredentialsbyclaimscount.md index 07007c13..5aef2d6f 100644 --- a/docs/api/core-types.idatastoreorm.datastoreormgetverifiablecredentialsbyclaimscount.md +++ b/docs/api/core-types.idatastoreorm.datastoreormgetverifiablecredentialsbyclaimscount.md @@ -8,7 +8,7 @@ hide_title: true ## IDataStoreORM.dataStoreORMGetVerifiableCredentialsByClaimsCount() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Returns a count of [UniqueVerifiableCredential](./core-types.uniqueverifiablecredential.md)s that match the given filter based on the claims they contain. diff --git a/docs/api/core-types.idatastoreorm.datastoreormgetverifiablecredentialscount.md b/docs/api/core-types.idatastoreorm.datastoreormgetverifiablecredentialscount.md index 3e8c9e32..8759c980 100644 --- a/docs/api/core-types.idatastoreorm.datastoreormgetverifiablecredentialscount.md +++ b/docs/api/core-types.idatastoreorm.datastoreormgetverifiablecredentialscount.md @@ -8,7 +8,7 @@ hide_title: true ## IDataStoreORM.dataStoreORMGetVerifiableCredentialsCount() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Returns a count of [UniqueVerifiableCredential](./core-types.uniqueverifiablecredential.md)s that match the given filter based on the top level properties of a credential. diff --git a/docs/api/core-types.idatastoreorm.datastoreormgetverifiablepresentations.md b/docs/api/core-types.idatastoreorm.datastoreormgetverifiablepresentations.md index d25b9abe..e783dcf7 100644 --- a/docs/api/core-types.idatastoreorm.datastoreormgetverifiablepresentations.md +++ b/docs/api/core-types.idatastoreorm.datastoreormgetverifiablepresentations.md @@ -8,7 +8,7 @@ hide_title: true ## IDataStoreORM.dataStoreORMGetVerifiablePresentations() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Returns a list of [UniqueVerifiablePresentation](./core-types.uniqueverifiablepresentation.md)s that match the given filter based on the top level properties of a presentation. diff --git a/docs/api/core-types.idatastoreorm.datastoreormgetverifiablepresentationscount.md b/docs/api/core-types.idatastoreorm.datastoreormgetverifiablepresentationscount.md index d06177b5..8893fd05 100644 --- a/docs/api/core-types.idatastoreorm.datastoreormgetverifiablepresentationscount.md +++ b/docs/api/core-types.idatastoreorm.datastoreormgetverifiablepresentationscount.md @@ -8,7 +8,7 @@ hide_title: true ## IDataStoreORM.dataStoreORMGetVerifiablePresentationsCount() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Returns a count of [UniqueVerifiablePresentation](./core-types.uniqueverifiablepresentation.md)s that match the given filter based on the top level properties of a presentation. diff --git a/docs/api/core-types.idatastoreorm.md b/docs/api/core-types.idatastoreorm.md index f167bfd1..e88c1eff 100644 --- a/docs/api/core-types.idatastoreorm.md +++ b/docs/api/core-types.idatastoreorm.md @@ -8,7 +8,7 @@ hide_title: true ## IDataStoreORM interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This is the default query interface for the credential data stored by a Veramo agent. diff --git a/docs/api/core-types.ididmanagerupdateargs.did.md b/docs/api/core-types.ididmanagerupdateargs.did.md index a82ca03d..e51eb104 100644 --- a/docs/api/core-types.ididmanagerupdateargs.did.md +++ b/docs/api/core-types.ididmanagerupdateargs.did.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDManagerUpdateArgs.did property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Required. DID diff --git a/docs/api/core-types.ididmanagerupdateargs.document.md b/docs/api/core-types.ididmanagerupdateargs.document.md index 5734cfe8..67a977b5 100644 --- a/docs/api/core-types.ididmanagerupdateargs.document.md +++ b/docs/api/core-types.ididmanagerupdateargs.document.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDManagerUpdateArgs.document property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Required diff --git a/docs/api/core-types.ididmanagerupdateargs.md b/docs/api/core-types.ididmanagerupdateargs.md index 3b64d0e3..444935ad 100644 --- a/docs/api/core-types.ididmanagerupdateargs.md +++ b/docs/api/core-types.ididmanagerupdateargs.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDManagerUpdateArgs interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The arguments necessary to perform a full DID document update for a DID. diff --git a/docs/api/core-types.ididmanagerupdateargs.options.md b/docs/api/core-types.ididmanagerupdateargs.options.md index acb27541..91d984c3 100644 --- a/docs/api/core-types.ididmanagerupdateargs.options.md +++ b/docs/api/core-types.ididmanagerupdateargs.options.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDManagerUpdateArgs.options property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Identifier provider specific options. diff --git a/docs/api/core-types.ierror.errorcode.md b/docs/api/core-types.ierror.errorcode.md index a08bea46..7e7140eb 100644 --- a/docs/api/core-types.ierror.errorcode.md +++ b/docs/api/core-types.ierror.errorcode.md @@ -8,7 +8,7 @@ hide_title: true ## IError.errorCode property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The code for the error being throw diff --git a/docs/api/core-types.ierror.md b/docs/api/core-types.ierror.md index 7a102ac7..0e715be2 100644 --- a/docs/api/core-types.ierror.md +++ b/docs/api/core-types.ierror.md @@ -8,7 +8,7 @@ hide_title: true ## IError interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. An error object, which can contain a code. diff --git a/docs/api/core-types.ierror.message.md b/docs/api/core-types.ierror.message.md index 4cd6df38..c8094342 100644 --- a/docs/api/core-types.ierror.message.md +++ b/docs/api/core-types.ierror.message.md @@ -8,7 +8,7 @@ hide_title: true ## IError.message property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The details of the error being throw or forwarded diff --git a/docs/api/core-types.ikeymanager.keymanagerdecryptjwe.md b/docs/api/core-types.ikeymanager.keymanagerdecryptjwe.md index 6ca888d5..7c0839b1 100644 --- a/docs/api/core-types.ikeymanager.keymanagerdecryptjwe.md +++ b/docs/api/core-types.ikeymanager.keymanagerdecryptjwe.md @@ -8,7 +8,7 @@ hide_title: true ## IKeyManager.keyManagerDecryptJWE() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Decrypts data This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/core-types.ikeymanager.keymanagerencryptjwe.md b/docs/api/core-types.ikeymanager.keymanagerencryptjwe.md index 6ecdc285..8adff92d 100644 --- a/docs/api/core-types.ikeymanager.keymanagerencryptjwe.md +++ b/docs/api/core-types.ikeymanager.keymanagerencryptjwe.md @@ -8,7 +8,7 @@ hide_title: true ## IKeyManager.keyManagerEncryptJWE() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Encrypts data This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/core-types.ikeymanagerdecryptjweargs.data.md b/docs/api/core-types.ikeymanagerdecryptjweargs.data.md index d2447081..5383c4f6 100644 --- a/docs/api/core-types.ikeymanagerdecryptjweargs.data.md +++ b/docs/api/core-types.ikeymanagerdecryptjweargs.data.md @@ -8,7 +8,7 @@ hide_title: true ## IKeyManagerDecryptJWEArgs.data property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Encrypted data diff --git a/docs/api/core-types.ikeymanagerdecryptjweargs.kid.md b/docs/api/core-types.ikeymanagerdecryptjweargs.kid.md index 37daedfb..5c09ecd1 100644 --- a/docs/api/core-types.ikeymanagerdecryptjweargs.kid.md +++ b/docs/api/core-types.ikeymanagerdecryptjweargs.kid.md @@ -8,7 +8,7 @@ hide_title: true ## IKeyManagerDecryptJWEArgs.kid property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Key ID diff --git a/docs/api/core-types.ikeymanagerdecryptjweargs.md b/docs/api/core-types.ikeymanagerdecryptjweargs.md index 0724660f..bdfef02b 100644 --- a/docs/api/core-types.ikeymanagerdecryptjweargs.md +++ b/docs/api/core-types.ikeymanagerdecryptjweargs.md @@ -8,7 +8,7 @@ hide_title: true ## IKeyManagerDecryptJWEArgs interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Input arguments for [keyManagerDecryptJWE](./core-types.ikeymanager.keymanagerdecryptjwe.md) This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/core-types.ikeymanagerencryptjweargs.data.md b/docs/api/core-types.ikeymanagerencryptjweargs.data.md index 80abbb14..33ea6487 100644 --- a/docs/api/core-types.ikeymanagerencryptjweargs.data.md +++ b/docs/api/core-types.ikeymanagerencryptjweargs.data.md @@ -8,7 +8,7 @@ hide_title: true ## IKeyManagerEncryptJWEArgs.data property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Data to encrypt diff --git a/docs/api/core-types.ikeymanagerencryptjweargs.kid.md b/docs/api/core-types.ikeymanagerencryptjweargs.kid.md index 4e4d2bb3..c9347036 100644 --- a/docs/api/core-types.ikeymanagerencryptjweargs.kid.md +++ b/docs/api/core-types.ikeymanagerencryptjweargs.kid.md @@ -8,7 +8,7 @@ hide_title: true ## IKeyManagerEncryptJWEArgs.kid property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Key ID to use for encryption diff --git a/docs/api/core-types.ikeymanagerencryptjweargs.md b/docs/api/core-types.ikeymanagerencryptjweargs.md index f4f773f6..20d8415f 100644 --- a/docs/api/core-types.ikeymanagerencryptjweargs.md +++ b/docs/api/core-types.ikeymanagerencryptjweargs.md @@ -8,7 +8,7 @@ hide_title: true ## IKeyManagerEncryptJWEArgs interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Input arguments for [keyManagerEncryptJWE](./core-types.ikeymanager.keymanagerencryptjwe.md) This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/core-types.ikeymanagerencryptjweargs.to.md b/docs/api/core-types.ikeymanagerencryptjweargs.to.md index fb44354b..c47d8138 100644 --- a/docs/api/core-types.ikeymanagerencryptjweargs.to.md +++ b/docs/api/core-types.ikeymanagerencryptjweargs.to.md @@ -8,7 +8,7 @@ hide_title: true ## IKeyManagerEncryptJWEArgs.to property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Recipient key object diff --git a/docs/api/core-types.imessageattachmentdata.base64.md b/docs/api/core-types.imessageattachmentdata.base64.md index 29d919bb..9bdd9acc 100644 --- a/docs/api/core-types.imessageattachmentdata.base64.md +++ b/docs/api/core-types.imessageattachmentdata.base64.md @@ -8,7 +8,7 @@ hide_title: true ## IMessageAttachmentData.base64 property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.imessageattachmentdata.hash.md b/docs/api/core-types.imessageattachmentdata.hash.md index 581a65a4..eb79ee1e 100644 --- a/docs/api/core-types.imessageattachmentdata.hash.md +++ b/docs/api/core-types.imessageattachmentdata.hash.md @@ -8,7 +8,7 @@ hide_title: true ## IMessageAttachmentData.hash property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.imessageattachmentdata.json.md b/docs/api/core-types.imessageattachmentdata.json.md index e80ca5c9..90ae818c 100644 --- a/docs/api/core-types.imessageattachmentdata.json.md +++ b/docs/api/core-types.imessageattachmentdata.json.md @@ -8,7 +8,7 @@ hide_title: true ## IMessageAttachmentData.json property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.imessageattachmentdata.jws.md b/docs/api/core-types.imessageattachmentdata.jws.md index 681c5336..f1daf8b5 100644 --- a/docs/api/core-types.imessageattachmentdata.jws.md +++ b/docs/api/core-types.imessageattachmentdata.jws.md @@ -8,7 +8,7 @@ hide_title: true ## IMessageAttachmentData.jws property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.imessageattachmentdata.links.md b/docs/api/core-types.imessageattachmentdata.links.md index 75bde693..0f253ea1 100644 --- a/docs/api/core-types.imessageattachmentdata.links.md +++ b/docs/api/core-types.imessageattachmentdata.links.md @@ -8,7 +8,7 @@ hide_title: true ## IMessageAttachmentData.links property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.imessageattachmentdata.md b/docs/api/core-types.imessageattachmentdata.md index ec6374dc..a4e0c9ba 100644 --- a/docs/api/core-types.imessageattachmentdata.md +++ b/docs/api/core-types.imessageattachmentdata.md @@ -8,7 +8,7 @@ hide_title: true ## IMessageAttachmentData interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The DIDComm message structure for data in an attachment. See https://identity.foundation/didcomm-messaging/spec/\#attachments diff --git a/docs/api/core-types.iresolver.getdidcomponentbyid.md b/docs/api/core-types.iresolver.getdidcomponentbyid.md index 0312ce60..94a9e835 100644 --- a/docs/api/core-types.iresolver.getdidcomponentbyid.md +++ b/docs/api/core-types.iresolver.getdidcomponentbyid.md @@ -8,7 +8,7 @@ hide_title: true ## IResolver.getDIDComponentById() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Dereferences a DID URL fragment and returns the corresponding DID document entry. diff --git a/docs/api/core-types.issueragentcontext.md b/docs/api/core-types.issueragentcontext.md index 703c7ce4..f7e0ddf8 100644 --- a/docs/api/core-types.issueragentcontext.md +++ b/docs/api/core-types.issueragentcontext.md @@ -8,7 +8,7 @@ hide_title: true ## IssuerAgentContext type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Represents the requirements that this plugin has. The agent that is using this plugin is expected to provide these methods. diff --git a/docs/api/core-types.issuertype.md b/docs/api/core-types.issuertype.md index a497bea0..531992ec 100644 --- a/docs/api/core-types.issuertype.md +++ b/docs/api/core-types.issuertype.md @@ -8,7 +8,7 @@ hide_title: true ## IssuerType type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The issuer of a [VerifiableCredential](./core-types.verifiablecredential.md) or the holder of a [VerifiablePresentation](./core-types.verifiablepresentation.md). diff --git a/docs/api/core-types.iverifycredentialargs.md b/docs/api/core-types.iverifycredentialargs.md index 13b5f586..d82aa5ae 100644 --- a/docs/api/core-types.iverifycredentialargs.md +++ b/docs/api/core-types.iverifycredentialargs.md @@ -13,9 +13,11 @@ Encapsulates the parameters required to verify a [W3C Verifiable Credential](htt **Signature:** ```typescript -export interface IVerifyCredentialArgs +export interface IVerifyCredentialArgs extends UsingResolutionOptions ``` +**Extends:** [UsingResolutionOptions](./core-types.usingresolutionoptions.md) + ## Properties | Property | Modifiers | Type | Description | diff --git a/docs/api/core-types.iverifypresentationargs.md b/docs/api/core-types.iverifypresentationargs.md index f174383c..d6a2d480 100644 --- a/docs/api/core-types.iverifypresentationargs.md +++ b/docs/api/core-types.iverifypresentationargs.md @@ -13,9 +13,11 @@ Encapsulates the parameters required to verify a [W3C Verifiable Presentation](h **Signature:** ```typescript -export interface IVerifyPresentationArgs +export interface IVerifyPresentationArgs extends UsingResolutionOptions ``` +**Extends:** [UsingResolutionOptions](./core-types.usingresolutionoptions.md) + ## Properties | Property | Modifiers | Type | Description | diff --git a/docs/api/core-types.iverifyresult.error.md b/docs/api/core-types.iverifyresult.error.md index 74b9319f..039062f9 100644 --- a/docs/api/core-types.iverifyresult.error.md +++ b/docs/api/core-types.iverifyresult.error.md @@ -8,7 +8,7 @@ hide_title: true ## IVerifyResult.error property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Optional Error object for the but currently the machine readable errors are not expored from DID-JWT package to be imported here diff --git a/docs/api/core-types.iverifyresult.md b/docs/api/core-types.iverifyresult.md index 4109acb0..cf640f93 100644 --- a/docs/api/core-types.iverifyresult.md +++ b/docs/api/core-types.iverifyresult.md @@ -8,7 +8,7 @@ hide_title: true ## IVerifyResult interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Encapsulates the response object to verifyPresentation method after verifying a [W3C Verifiable Presentation](https://www.w3.org/TR/vc-data-model/#presentations) diff --git a/docs/api/core-types.iverifyresult.verified.md b/docs/api/core-types.iverifyresult.verified.md index 933dc521..a80d9057 100644 --- a/docs/api/core-types.iverifyresult.verified.md +++ b/docs/api/core-types.iverifyresult.verified.md @@ -8,7 +8,7 @@ hide_title: true ## IVerifyResult.verified property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This value is used to transmit the result of verification. diff --git a/docs/api/core-types.md b/docs/api/core-types.md index 677e212e..9338a8db 100644 --- a/docs/api/core-types.md +++ b/docs/api/core-types.md @@ -93,6 +93,7 @@ Provides [Agent](./core.agent.md) implementation and defines [IResolver](./core- | [UniqueVerifiablePresentation](./core-types.uniqueverifiablepresentation.md) |

**_(BETA)_** Represents the result of a Query for [VerifiablePresentation](./core-types.verifiablepresentation.md)s

See [IDataStoreORM.dataStoreORMGetVerifiablePresentations()](./core-types.idatastoreorm.datastoreormgetverifiablepresentations.md)

This API may change without a BREAKING CHANGE notice.

| | [UnsignedCredential](./core-types.unsignedcredential.md) |

**_(BETA)_** Represents an unsigned W3C Credential payload. See [VC data model](https://www.w3.org/TR/vc-data-model/#credentials)

This API may change without a BREAKING CHANGE notice.

| | [UnsignedPresentation](./core-types.unsignedpresentation.md) | Represents an unsigned W3C Presentation payload. See [VP data model](https://www.w3.org/TR/vc-data-model/#presentations) | +| [UsingResolutionOptions](./core-types.usingresolutionoptions.md) | Options that are forwarded to the DID resolver. | | [VerificationPolicies](./core-types.verificationpolicies.md) | **_(BETA)_** These optional settings can be used to override some default checks that are performed on Presentations during verification. | | [Where](./core-types.where.md) |

**_(BETA)_** Represents a WHERE predicate for a [FindArgs](./core-types.findargs.md) query. In situations where multiple WHERE predicates are present, they are combined with AND.

This API may change without a BREAKING CHANGE notice.

| @@ -102,6 +103,7 @@ Provides [Agent](./core.agent.md) implementation and defines [IResolver](./core- | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | [CoreEvents](./core-types.coreevents.md) | This collection defines the core event types. | | [KEY_ALG_MAPPING](./core-types.key_alg_mapping.md) | Mapping of known key types([TKeyType](./core-types.tkeytype.md)) to the known algorithms([TAlg](./core-types.talg.md)) they should support. | +| [schema](./core-types.schema.md) | | ## Type Aliases diff --git a/docs/api/core-types.order.column.md b/docs/api/core-types.order.column.md index 45bce9a1..c63ceee1 100644 --- a/docs/api/core-types.order.column.md +++ b/docs/api/core-types.order.column.md @@ -8,7 +8,7 @@ hide_title: true ## Order.column property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.order.direction.md b/docs/api/core-types.order.direction.md index b3f079b4..b8fade4d 100644 --- a/docs/api/core-types.order.direction.md +++ b/docs/api/core-types.order.direction.md @@ -8,7 +8,7 @@ hide_title: true ## Order.direction property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.order.md b/docs/api/core-types.order.md index 126eb8e3..66d85953 100644 --- a/docs/api/core-types.order.md +++ b/docs/api/core-types.order.md @@ -8,7 +8,7 @@ hide_title: true ## Order interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Represents the sort order of results from a [FindArgs](./core-types.findargs.md) query. diff --git a/docs/api/core-types.partialidentifier.md b/docs/api/core-types.partialidentifier.md index 615f022e..341ac8d5 100644 --- a/docs/api/core-types.partialidentifier.md +++ b/docs/api/core-types.partialidentifier.md @@ -8,7 +8,7 @@ hide_title: true ## PartialIdentifier type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The result of a [IDataStoreORM.dataStoreORMGetIdentifiers()](./core-types.idatastoreorm.datastoreormgetidentifiers.md) query. diff --git a/docs/api/core-types.presentationpayload.__context_.md b/docs/api/core-types.presentationpayload.__context_.md index 4f6e7e27..21e4de24 100644 --- a/docs/api/core-types.presentationpayload.__context_.md +++ b/docs/api/core-types.presentationpayload.__context_.md @@ -8,7 +8,7 @@ hide_title: true ## PresentationPayload."@context" property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.presentationpayload.expirationdate.md b/docs/api/core-types.presentationpayload.expirationdate.md index 779a3f03..abe961ea 100644 --- a/docs/api/core-types.presentationpayload.expirationdate.md +++ b/docs/api/core-types.presentationpayload.expirationdate.md @@ -8,7 +8,7 @@ hide_title: true ## PresentationPayload.expirationDate property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.presentationpayload.holder.md b/docs/api/core-types.presentationpayload.holder.md index 4f5b548f..685762b5 100644 --- a/docs/api/core-types.presentationpayload.holder.md +++ b/docs/api/core-types.presentationpayload.holder.md @@ -8,7 +8,7 @@ hide_title: true ## PresentationPayload.holder property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.presentationpayload.id.md b/docs/api/core-types.presentationpayload.id.md index 1e16587a..270a290a 100644 --- a/docs/api/core-types.presentationpayload.id.md +++ b/docs/api/core-types.presentationpayload.id.md @@ -8,7 +8,7 @@ hide_title: true ## PresentationPayload.id property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.presentationpayload.issuancedate.md b/docs/api/core-types.presentationpayload.issuancedate.md index e2a2643c..1ece3c3f 100644 --- a/docs/api/core-types.presentationpayload.issuancedate.md +++ b/docs/api/core-types.presentationpayload.issuancedate.md @@ -8,7 +8,7 @@ hide_title: true ## PresentationPayload.issuanceDate property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.presentationpayload.md b/docs/api/core-types.presentationpayload.md index 74b2abaa..2f486ee6 100644 --- a/docs/api/core-types.presentationpayload.md +++ b/docs/api/core-types.presentationpayload.md @@ -8,7 +8,7 @@ hide_title: true ## PresentationPayload interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Used as input when creating Verifiable Presentations diff --git a/docs/api/core-types.presentationpayload.type.md b/docs/api/core-types.presentationpayload.type.md index 7957c7ca..c56c0e7a 100644 --- a/docs/api/core-types.presentationpayload.type.md +++ b/docs/api/core-types.presentationpayload.type.md @@ -8,7 +8,7 @@ hide_title: true ## PresentationPayload.type property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.presentationpayload.verifiablecredential.md b/docs/api/core-types.presentationpayload.verifiablecredential.md index 73516e95..24a61d5d 100644 --- a/docs/api/core-types.presentationpayload.verifiablecredential.md +++ b/docs/api/core-types.presentationpayload.verifiablecredential.md @@ -8,7 +8,7 @@ hide_title: true ## PresentationPayload.verifiableCredential property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.presentationpayload.verifier.md b/docs/api/core-types.presentationpayload.verifier.md index dbb44186..92030a7b 100644 --- a/docs/api/core-types.presentationpayload.verifier.md +++ b/docs/api/core-types.presentationpayload.verifier.md @@ -8,7 +8,7 @@ hide_title: true ## PresentationPayload.verifier property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.prooftype.md b/docs/api/core-types.prooftype.md index 1e16fda0..3d9542fb 100644 --- a/docs/api/core-types.prooftype.md +++ b/docs/api/core-types.prooftype.md @@ -8,7 +8,7 @@ hide_title: true ## ProofType interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. A proof property of a [VerifiableCredential](./core-types.verifiablecredential.md) or [VerifiablePresentation](./core-types.verifiablepresentation.md) diff --git a/docs/api/core-types.prooftype.type.md b/docs/api/core-types.prooftype.type.md index 57e6c676..59878279 100644 --- a/docs/api/core-types.prooftype.type.md +++ b/docs/api/core-types.prooftype.type.md @@ -8,7 +8,7 @@ hide_title: true ## ProofType.type property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.schema.md b/docs/api/core-types.schema.md new file mode 100644 index 00000000..5b9bdce0 --- /dev/null +++ b/docs/api/core-types.schema.md @@ -0,0 +1,5166 @@ +--- +id: core-types.schema +title: schema variable +hide_title: true +--- + + + +## schema variable + +**Signature:** + +```typescript +schema: { + IResolver: { + components: { + schemas: { + GetDIDComponentArgs: { + type: string; + properties: { + didDocument: { + $ref: string; + description: string; + }; + didUrl: { + type: string; + description: string; + }; + section: { + $ref: string; + description: string; + }; + }; + required: string[]; + description: string; + }; + DIDDocument: { + type: string; + properties: { + authentication: { + type: string; + items: { + anyOf: ({ + type: string; + $ref?: undefined; + } | { + $ref: string; + type?: undefined; + })[]; + }; + }; + assertionMethod: { + type: string; + items: { + anyOf: ({ + type: string; + $ref?: undefined; + } | { + $ref: string; + type?: undefined; + })[]; + }; + }; + keyAgreement: { + type: string; + items: { + anyOf: ({ + type: string; + $ref?: undefined; + } | { + $ref: string; + type?: undefined; + })[]; + }; + }; + capabilityInvocation: { + type: string; + items: { + anyOf: ({ + type: string; + $ref?: undefined; + } | { + $ref: string; + type?: undefined; + })[]; + }; + }; + capabilityDelegation: { + type: string; + items: { + anyOf: ({ + type: string; + $ref?: undefined; + } | { + $ref: string; + type?: undefined; + })[]; + }; + }; + "@context": { + anyOf: ({ + type: string; + const: string; + items?: undefined; + } | { + type: string; + const?: undefined; + items?: undefined; + } | { + type: string; + items: { + type: string; + }; + const?: undefined; + })[]; + }; + id: { + type: string; + }; + alsoKnownAs: { + type: string; + items: { + type: string; + }; + }; + controller: { + anyOf: ({ + type: string; + items?: undefined; + } | { + type: string; + items: { + type: string; + }; + })[]; + }; + verificationMethod: { + type: string; + items: { + $ref: string; + }; + }; + service: { + type: string; + items: { + $ref: string; + }; + }; + publicKey: { + type: string; + items: { + $ref: string; + }; + deprecated: boolean; + }; + }; + required: string[]; + description: string; + }; + VerificationMethod: { + type: string; + properties: { + id: { + type: string; + }; + type: { + type: string; + }; + controller: { + type: string; + }; + publicKeyBase58: { + type: string; + }; + publicKeyBase64: { + type: string; + }; + publicKeyJwk: { + $ref: string; + }; + publicKeyHex: { + type: string; + }; + publicKeyMultibase: { + type: string; + }; + blockchainAccountId: { + type: string; + }; + ethereumAddress: { + type: string; + }; + conditionOr: { + type: string; + items: { + $ref: string; + }; + }; + conditionAnd: { + type: string; + items: { + $ref: string; + }; + }; + threshold: { + type: string; + }; + conditionThreshold: { + type: string; + items: { + $ref: string; + }; + }; + conditionWeightedThreshold: { + type: string; + items: { + $ref: string; + }; + }; + conditionDelegated: { + type: string; + }; + relationshipParent: { + type: string; + items: { + type: string; + }; + }; + relationshipChild: { + type: string; + items: { + type: string; + }; + }; + relationshipSibling: { + type: string; + items: { + type: string; + }; + }; + }; + required: string[]; + description: string; + }; + JsonWebKey: { + type: string; + properties: { + alg: { + type: string; + }; + crv: { + type: string; + }; + e: { + type: string; + }; + ext: { + type: string; + }; + key_ops: { + type: string; + items: { + type: string; + }; + }; + kid: { + type: string; + }; + kty: { + type: string; + }; + n: { + type: string; + }; + use: { + type: string; + }; + x: { + type: string; + }; + y: { + type: string; + }; + }; + required: string[]; + description: string; + }; + ConditionWeightedThreshold: { + type: string; + properties: { + condition: { + $ref: string; + }; + weight: { + type: string; + }; + }; + required: string[]; + }; + Service: { + type: string; + properties: { + id: { + type: string; + }; + type: { + type: string; + }; + serviceEndpoint: { + anyOf: ({ + $ref: string; + type?: undefined; + items?: undefined; + } | { + type: string; + items: { + $ref: string; + }; + $ref?: undefined; + })[]; + }; + }; + required: string[]; + description: string; + }; + ServiceEndpoint: { + anyOf: { + type: string; + }[]; + description: string; + }; + DIDDocumentSection: { + anyOf: ({ + $ref: string; + type?: undefined; + const?: undefined; + } | { + type: string; + const: string; + $ref?: undefined; + })[]; + description: string; + }; + KeyCapabilitySection: { + type: string; + enum: string[]; + description: string; + }; + DIDDocComponent: { + anyOf: { + $ref: string; + }[]; + description: string; + }; + ResolveDidArgs: { + type: string; + properties: { + didUrl: { + type: string; + description: string; + }; + options: { + $ref: string; + description: string; + }; + }; + required: string[]; + description: string; + }; + DIDResolutionOptions: { + type: string; + properties: { + accept: { + type: string; + }; + }; + description: string; + }; + DIDResolutionResult: { + type: string; + properties: { + "@context": { + anyOf: ({ + type: string; + const: string; + items?: undefined; + } | { + type: string; + const?: undefined; + items?: undefined; + } | { + type: string; + items: { + type: string; + }; + const?: undefined; + })[]; + }; + didResolutionMetadata: { + $ref: string; + }; + didDocument: { + anyOf: ({ + $ref: string; + type?: undefined; + } | { + type: string; + $ref?: undefined; + })[]; + }; + didDocumentMetadata: { + $ref: string; + }; + }; + required: string[]; + description: string; + }; + DIDResolutionMetadata: { + type: string; + properties: { + contentType: { + type: string; + }; + error: { + type: string; + }; + }; + description: string; + }; + DIDDocumentMetadata: { + type: string; + properties: { + created: { + type: string; + }; + updated: { + type: string; + }; + deactivated: { + type: string; + }; + versionId: { + type: string; + }; + nextUpdate: { + type: string; + }; + nextVersionId: { + type: string; + }; + equivalentId: { + type: string; + }; + canonicalId: { + type: string; + }; + }; + description: string; + }; + }; + methods: { + getDIDComponentById: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + $ref: string; + }; + }; + resolveDid: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + $ref: string; + }; + }; + }; + }; + }; + IKeyManager: { + components: { + schemas: { + IKeyManagerCreateArgs: { + type: string; + properties: { + type: { + $ref: string; + description: string; + }; + kms: { + type: string; + description: string; + }; + meta: { + $ref: string; + description: string; + }; + }; + required: string[]; + description: string; + }; + TKeyType: { + type: string; + enum: string[]; + description: string; + }; + KeyMetadata: { + type: string; + properties: { + algorithms: { + type: string; + items: { + $ref: string; + }; + }; + }; + description: string; + }; + TAlg: { + type: string; + description: string; + }; + ManagedKeyInfo: { + type: string; + properties: { + kid: { + type: string; + description: string; + }; + kms: { + type: string; + description: string; + }; + type: { + $ref: string; + description: string; + }; + publicKeyHex: { + type: string; + description: string; + }; + meta: { + anyOf: ({ + $ref: string; + type?: undefined; + } | { + type: string; + $ref?: undefined; + })[]; + description: string; + }; + }; + required: string[]; + description: string; + }; + IKeyManagerDecryptJWEArgs: { + type: string; + properties: { + kid: { + type: string; + description: string; + }; + data: { + type: string; + description: string; + }; + }; + required: string[]; + description: string; + }; + IKeyManagerDeleteArgs: { + 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: ({ + $ref: string; + type?: undefined; + } | { + type: string; + $ref?: undefined; + })[]; + description: string; + }; + }; + required: string[]; + description: string; + }; + data: { + type: string; + description: string; + }; + }; + required: string[]; + description: string; + }; + IKeyManagerGetArgs: { + type: string; + properties: { + kid: { + 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: ({ + $ref: string; + type?: undefined; + } | { + type: string; + $ref?: undefined; + })[]; + description: string; + }; + }; + required: string[]; + description: string; + }; + MinimalImportableKey: { + $ref: string; + description: string; + }; + "RequireOnly": { + 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: ({ + $ref: string; + type?: undefined; + } | { + type: string; + $ref?: undefined; + })[]; + description: string; + }; + }; + description: string; + }; + IKeyManagerSharedSecretArgs: { + type: string; + properties: { + secretKeyRef: { + type: string; + description: string; + }; + publicKey: { + type: string; + properties: { + publicKeyHex: { + type: string; + description: string; + }; + type: { + $ref: string; + description: string; + }; + }; + required: string[]; + description: string; + }; + }; + required: string[]; + description: string; + }; + IKeyManagerSignArgs: { + type: string; + properties: { + keyRef: { + type: string; + description: string; + }; + algorithm: { + type: string; + description: string; + }; + data: { + type: string; + description: string; + }; + encoding: { + type: string; + enum: 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: { + anyOf: ({ + type: string; + properties?: undefined; + required?: undefined; + additionalProperties?: undefined; + } | { + type: string; + properties: { + BYTES_PER_ELEMENT: { + type: string; + }; + buffer: { + anyOf: ({ + type: string; + properties: { + byteLength: { + type: string; + }; + }; + required: string[]; + } | { + type?: undefined; + properties?: undefined; + required?: undefined; + })[]; + }; + byteLength: { + type: string; + }; + byteOffset: { + type: string; + }; + length: { + type: string; + }; + }; + required: string[]; + additionalProperties: { + type: string; + }; + })[]; + description: string; + }; + }; + required: string[]; + description: string; + }; + }; + methods: { + keyManagerCreate: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + $ref: string; + }; + }; + keyManagerDecryptJWE: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + type: string; + }; + }; + keyManagerDelete: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + type: string; + }; + }; + keyManagerEncryptJWE: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + type: string; + }; + }; + keyManagerGet: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + $ref: string; + }; + }; + keyManagerGetKeyManagementSystems: { + description: string; + arguments: { + type: string; + }; + returnType: { + type: string; + items: { + type: string; + }; + }; + }; + keyManagerImport: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + $ref: string; + }; + }; + keyManagerSharedSecret: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + type: string; + }; + }; + keyManagerSign: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + type: string; + }; + }; + keyManagerSignEthTX: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + type: string; + }; + }; + keyManagerSignJWT: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + type: string; + }; + }; + }; + }; + }; + IDIDManager: { + components: { + schemas: { + IDIDManagerAddKeyArgs: { + 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: ({ + $ref: string; + type?: undefined; + } | { + type: string; + $ref?: undefined; + })[]; + description: string; + }; + }; + required: string[]; + description: string; + }; + TKeyType: { + type: string; + enum: string[]; + description: string; + }; + KeyMetadata: { + type: string; + properties: { + algorithms: { + type: string; + items: { + $ref: string; + }; + }; + }; + description: string; + }; + TAlg: { + type: string; + description: string; + }; + IDIDManagerAddServiceArgs: { + 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: { + anyOf: ({ + $ref: string; + type?: undefined; + items?: undefined; + } | { + type: string; + items: { + $ref: string; + }; + $ref?: undefined; + })[]; + description: string; + }; + description: { + type: string; + description: string; + }; + }; + required: string[]; + description: string; + }; + IServiceEndpoint: { + anyOf: { + type: string; + }[]; + description: string; + }; + IDIDManagerCreateArgs: { + 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; + }; + IIdentifier: { + 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; + }; + }; + required: string[]; + description: string; + }; + IDIDManagerDeleteArgs: { + type: string; + properties: { + did: { + type: string; + description: string; + }; + }; + required: string[]; + description: string; + }; + IDIDManagerFindArgs: { + type: string; + properties: { + alias: { + type: string; + description: string; + }; + provider: { + type: string; + description: string; + }; + }; + description: string; + }; + IDIDManagerGetArgs: { + type: string; + properties: { + did: { + type: string; + description: string; + }; + }; + required: string[]; + description: string; + }; + IDIDManagerGetByAliasArgs: { + type: string; + properties: { + alias: { + type: string; + description: string; + }; + provider: { + type: string; + description: string; + }; + }; + required: string[]; + description: string; + }; + IDIDManagerGetOrCreateArgs: { + 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; + }; + MinimalImportableIdentifier: { + 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; + }; + }; + services: { + type: string; + items: { + $ref: string; + }; + }; + }; + required: string[]; + description: string; + }; + MinimalImportableKey: { + $ref: string; + description: string; + }; + "RequireOnly": { + 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: ({ + $ref: string; + type?: undefined; + } | { + type: string; + $ref?: undefined; + })[]; + description: string; + }; + }; + description: string; + }; + IDIDManagerRemoveKeyArgs: { + type: string; + properties: { + did: { + type: string; + description: string; + }; + kid: { + type: string; + description: string; + }; + options: { + type: string; + description: string; + }; + }; + required: string[]; + description: string; + }; + IDIDManagerRemoveServiceArgs: { + type: string; + properties: { + did: { + type: string; + description: string; + }; + id: { + type: string; + description: string; + }; + options: { + type: string; + description: string; + }; + }; + required: string[]; + description: string; + }; + IDIDManagerSetAliasArgs: { + type: string; + properties: { + did: { + type: string; + description: string; + }; + alias: { + type: string; + description: string; + }; + }; + required: string[]; + description: string; + }; + IDIDManagerUpdateArgs: { + type: string; + properties: { + did: { + type: string; + description: string; + }; + document: { + type: string; + properties: { + "@context": { + anyOf: ({ + type: string; + properties: {}; + allOf?: undefined; + } | { + type: string; + properties?: undefined; + allOf?: undefined; + } | { + allOf: ({ + type: string; + items: { + type: string; + }; + properties?: undefined; + } | { + type: string; + properties: {}; + items?: undefined; + })[]; + type?: undefined; + properties?: undefined; + })[]; + }; + id: { + type: string; + }; + alsoKnownAs: { + allOf: ({ + type: string; + items: { + type: string; + }; + properties?: undefined; + } | { + type: string; + properties: {}; + items?: undefined; + })[]; + }; + controller: { + anyOf: ({ + type: string; + allOf?: undefined; + } | { + allOf: ({ + type: string; + items: { + type: string; + }; + properties?: undefined; + } | { + type: string; + properties: {}; + items?: undefined; + })[]; + type?: undefined; + })[]; + }; + verificationMethod: { + allOf: ({ + type: string; + items: { + $ref: string; + }; + properties?: undefined; + } | { + type: string; + properties: {}; + items?: undefined; + })[]; + }; + service: { + allOf: ({ + type: string; + items: { + $ref: string; + }; + properties?: undefined; + } | { + type: string; + properties: {}; + items?: undefined; + })[]; + }; + publicKey: { + allOf: ({ + type: string; + items: { + $ref: string; + }; + properties?: undefined; + } | { + type: string; + properties: {}; + items?: undefined; + })[]; + deprecated: boolean; + }; + authentication: { + allOf: ({ + type: string; + items: { + anyOf: ({ + type: string; + $ref?: undefined; + } | { + $ref: string; + type?: undefined; + })[]; + }; + properties?: undefined; + } | { + type: string; + properties: {}; + items?: undefined; + })[]; + }; + assertionMethod: { + allOf: ({ + type: string; + items: { + anyOf: ({ + type: string; + $ref?: undefined; + } | { + $ref: string; + type?: undefined; + })[]; + }; + properties?: undefined; + } | { + type: string; + properties: {}; + items?: undefined; + })[]; + }; + keyAgreement: { + allOf: ({ + type: string; + items: { + anyOf: ({ + type: string; + $ref?: undefined; + } | { + $ref: string; + type?: undefined; + })[]; + }; + properties?: undefined; + } | { + type: string; + properties: {}; + items?: undefined; + })[]; + }; + capabilityInvocation: { + allOf: ({ + type: string; + items: { + anyOf: ({ + type: string; + $ref?: undefined; + } | { + $ref: string; + type?: undefined; + })[]; + }; + properties?: undefined; + } | { + type: string; + properties: {}; + items?: undefined; + })[]; + }; + capabilityDelegation: { + allOf: ({ + type: string; + items: { + anyOf: ({ + type: string; + $ref?: undefined; + } | { + $ref: string; + type?: undefined; + })[]; + }; + properties?: undefined; + } | { + type: string; + properties: {}; + items?: undefined; + })[]; + }; + }; + description: string; + }; + options: { + type: string; + description: string; + }; + }; + required: string[]; + description: string; + }; + VerificationMethod: { + type: string; + properties: { + id: { + type: string; + }; + type: { + type: string; + }; + controller: { + type: string; + }; + publicKeyBase58: { + type: string; + }; + publicKeyBase64: { + type: string; + }; + publicKeyJwk: { + $ref: string; + }; + publicKeyHex: { + type: string; + }; + publicKeyMultibase: { + type: string; + }; + blockchainAccountId: { + type: string; + }; + ethereumAddress: { + type: string; + }; + conditionOr: { + type: string; + items: { + $ref: string; + }; + }; + conditionAnd: { + type: string; + items: { + $ref: string; + }; + }; + threshold: { + type: string; + }; + conditionThreshold: { + type: string; + items: { + $ref: string; + }; + }; + conditionWeightedThreshold: { + type: string; + items: { + $ref: string; + }; + }; + conditionDelegated: { + type: string; + }; + relationshipParent: { + type: string; + items: { + type: string; + }; + }; + relationshipChild: { + type: string; + items: { + type: string; + }; + }; + relationshipSibling: { + type: string; + items: { + type: string; + }; + }; + }; + required: string[]; + description: string; + }; + JsonWebKey: { + type: string; + properties: { + alg: { + type: string; + }; + crv: { + type: string; + }; + e: { + type: string; + }; + ext: { + type: string; + }; + key_ops: { + type: string; + items: { + type: string; + }; + }; + kid: { + type: string; + }; + kty: { + type: string; + }; + n: { + type: string; + }; + use: { + type: string; + }; + x: { + type: string; + }; + y: { + type: string; + }; + }; + required: string[]; + description: string; + }; + ConditionWeightedThreshold: { + type: string; + properties: { + condition: { + $ref: string; + }; + weight: { + type: string; + }; + }; + required: string[]; + }; + Service: { + type: string; + properties: { + id: { + type: string; + }; + type: { + type: string; + }; + serviceEndpoint: { + anyOf: ({ + $ref: string; + type?: undefined; + items?: undefined; + } | { + type: string; + items: { + $ref: string; + }; + $ref?: undefined; + })[]; + }; + }; + required: string[]; + description: string; + }; + ServiceEndpoint: { + anyOf: { + type: string; + }[]; + description: string; + }; + }; + methods: { + didManagerAddKey: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + type: string; + }; + }; + didManagerAddService: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + type: string; + }; + }; + didManagerCreate: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + $ref: string; + }; + }; + didManagerDelete: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + type: string; + }; + }; + didManagerFind: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + type: string; + items: { + $ref: string; + }; + }; + }; + didManagerGet: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + $ref: string; + }; + }; + didManagerGetByAlias: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + $ref: string; + }; + }; + didManagerGetOrCreate: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + $ref: string; + }; + }; + didManagerGetProviders: { + description: string; + arguments: { + type: string; + }; + returnType: { + type: string; + items: { + type: string; + }; + }; + }; + didManagerImport: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + $ref: string; + }; + }; + didManagerRemoveKey: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + type: string; + }; + }; + didManagerRemoveService: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + type: string; + }; + }; + didManagerSetAlias: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + type: string; + }; + }; + didManagerUpdate: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + $ref: string; + }; + }; + }; + }; + }; + IDataStore: { + components: { + schemas: { + IDataStoreDeleteMessageArgs: { + type: string; + properties: { + id: { + type: string; + description: string; + }; + }; + required: string[]; + description: string; + }; + IDataStoreDeleteVerifiableCredentialArgs: { + type: string; + properties: { + hash: { + type: string; + description: string; + }; + }; + required: string[]; + description: string; + }; + 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; + }; + attachments: { + type: string; + items: { + $ref: string; + }; + description: string; + }; + returnRoute: { + 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; + }; + VerifiableCredential: { + type: string; + properties: { + proof: { + $ref: string; + }; + issuer: { + $ref: string; + }; + credentialSubject: { + $ref: string; + }; + type: { + anyOf: ({ + type: string; + items: { + type: string; + }; + } | { + type: string; + items?: undefined; + })[]; + }; + "@context": { + $ref: string; + }; + issuanceDate: { + type: string; + }; + expirationDate: { + type: string; + }; + credentialStatus: { + $ref: string; + }; + id: { + type: string; + }; + }; + required: string[]; + description: string; + }; + ProofType: { + type: string; + properties: { + type: { + type: string; + }; + }; + description: string; + }; + IssuerType: { + anyOf: ({ + type: string; + properties: { + id: { + type: string; + }; + }; + required: string[]; + } | { + type: string; + properties?: undefined; + required?: undefined; + })[]; + description: string; + }; + CredentialSubject: { + type: string; + properties: { + id: { + type: string; + }; + }; + description: string; + }; + ContextType: { + anyOf: ({ + type: string; + items?: undefined; + } | { + type: string; + items: { + anyOf: { + type: string; + }[]; + }; + })[]; + description: string; + }; + CredentialStatusReference: { + type: string; + properties: { + id: { + type: string; + }; + type: { + type: string; + }; + }; + required: string[]; + description: string; + }; + VerifiablePresentation: { + type: string; + properties: { + proof: { + $ref: string; + }; + holder: { + type: string; + }; + verifiableCredential: { + type: string; + items: { + $ref: string; + }; + }; + type: { + anyOf: ({ + type: string; + items: { + type: string; + }; + } | { + type: string; + items?: undefined; + })[]; + }; + "@context": { + $ref: string; + }; + verifier: { + type: string; + items: { + type: string; + }; + }; + issuanceDate: { + type: string; + }; + expirationDate: { + type: string; + }; + id: { + type: string; + }; + }; + required: string[]; + description: string; + }; + W3CVerifiableCredential: { + anyOf: { + $ref: string; + }[]; + description: string; + }; + CompactJWT: { + type: string; + description: string; + }; + IMessageAttachment: { + type: string; + properties: { + id: { + type: string; + }; + description: { + type: string; + }; + filename: { + type: string; + }; + media_type: { + type: string; + }; + format: { + type: string; + }; + lastmod_time: { + type: string; + }; + byte_count: { + type: string; + }; + data: { + $ref: string; + }; + }; + required: string[]; + description: string; + }; + IMessageAttachmentData: { + type: string; + properties: { + jws: {}; + hash: { + type: string; + }; + links: { + type: string; + items: { + type: string; + }; + }; + base64: { + type: string; + }; + json: {}; + }; + 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: { + dataStoreDeleteMessage: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + type: string; + }; + }; + dataStoreDeleteVerifiableCredential: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + type: string; + }; + }; + 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; + }; + }; + }; + }; + }; + IDataStoreORM: { + components: { + schemas: { + FindIdentifiersArgs: { + $ref: string; + description: string; + }; + "FindArgs-TIdentifiersColumns": { + type: string; + properties: { + where: { + type: string; + items: { + $ref: string; + }; + description: string; + }; + order: { + type: string; + items: { + $ref: string; + }; + description: string; + }; + skip: { + type: string; + description: string; + }; + take: { + type: string; + description: string; + }; + }; + description: string; + }; + "Where-TIdentifiersColumns": { + type: string; + properties: { + column: { + $ref: string; + }; + value: { + type: string; + items: { + type: string; + }; + }; + not: { + type: string; + }; + op: { + type: string; + enum: string[]; + }; + }; + required: string[]; + description: string; + }; + TIdentifiersColumns: { + type: string; + enum: string[]; + description: string; + deprecated: string; + }; + "Order-TIdentifiersColumns": { + type: string; + properties: { + column: { + $ref: string; + }; + direction: { + type: string; + enum: string[]; + }; + }; + required: string[]; + description: string; + }; + PartialIdentifier: { + 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; + }; + }; + 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: ({ + $ref: string; + type?: undefined; + } | { + type: string; + $ref?: undefined; + })[]; + description: string; + }; + }; + required: string[]; + description: string; + }; + TKeyType: { + type: string; + enum: string[]; + description: string; + }; + KeyMetadata: { + type: string; + properties: { + algorithms: { + type: string; + items: { + $ref: string; + }; + }; + }; + description: string; + }; + TAlg: { + type: string; + description: string; + }; + IService: { + type: string; + properties: { + id: { + type: string; + description: string; + }; + type: { + type: string; + description: string; + }; + serviceEndpoint: { + anyOf: ({ + $ref: string; + type?: undefined; + items?: undefined; + } | { + type: string; + items: { + $ref: string; + }; + $ref?: undefined; + })[]; + description: string; + }; + description: { + type: string; + description: string; + }; + }; + required: string[]; + description: string; + }; + IServiceEndpoint: { + anyOf: { + type: string; + }[]; + description: string; + }; + FindMessagesArgs: { + $ref: string; + description: string; + }; + "FindArgs-TMessageColumns": { + type: string; + properties: { + where: { + type: string; + items: { + $ref: string; + }; + description: string; + }; + order: { + type: string; + items: { + $ref: string; + }; + description: string; + }; + skip: { + type: string; + description: string; + }; + take: { + type: string; + description: string; + }; + }; + description: 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[]; + description: string; + }; + TMessageColumns: { + type: string; + enum: string[]; + description: string; + }; + "Order-TMessageColumns": { + type: string; + properties: { + column: { + $ref: string; + }; + direction: { + type: string; + enum: 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; + }; + attachments: { + type: string; + items: { + $ref: string; + }; + description: string; + }; + returnRoute: { + 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; + }; + VerifiableCredential: { + type: string; + properties: { + proof: { + $ref: string; + }; + issuer: { + $ref: string; + }; + credentialSubject: { + $ref: string; + }; + type: { + anyOf: ({ + type: string; + items: { + type: string; + }; + } | { + type: string; + items?: undefined; + })[]; + }; + "@context": { + $ref: string; + }; + issuanceDate: { + type: string; + }; + expirationDate: { + type: string; + }; + credentialStatus: { + $ref: string; + }; + id: { + type: string; + }; + }; + required: string[]; + description: string; + }; + ProofType: { + type: string; + properties: { + type: { + type: string; + }; + }; + description: string; + }; + IssuerType: { + anyOf: ({ + type: string; + properties: { + id: { + type: string; + }; + }; + required: string[]; + } | { + type: string; + properties?: undefined; + required?: undefined; + })[]; + description: string; + }; + CredentialSubject: { + type: string; + properties: { + id: { + type: string; + }; + }; + description: string; + }; + ContextType: { + anyOf: ({ + type: string; + items?: undefined; + } | { + type: string; + items: { + anyOf: { + type: string; + }[]; + }; + })[]; + description: string; + }; + CredentialStatusReference: { + type: string; + properties: { + id: { + type: string; + }; + type: { + type: string; + }; + }; + required: string[]; + description: string; + }; + VerifiablePresentation: { + type: string; + properties: { + proof: { + $ref: string; + }; + holder: { + type: string; + }; + verifiableCredential: { + type: string; + items: { + $ref: string; + }; + }; + type: { + anyOf: ({ + type: string; + items: { + type: string; + }; + } | { + type: string; + items?: undefined; + })[]; + }; + "@context": { + $ref: string; + }; + verifier: { + type: string; + items: { + type: string; + }; + }; + issuanceDate: { + type: string; + }; + expirationDate: { + type: string; + }; + id: { + type: string; + }; + }; + required: string[]; + description: string; + }; + W3CVerifiableCredential: { + anyOf: { + $ref: string; + }[]; + description: string; + }; + CompactJWT: { + type: string; + description: string; + }; + IMessageAttachment: { + type: string; + properties: { + id: { + type: string; + }; + description: { + type: string; + }; + filename: { + type: string; + }; + media_type: { + type: string; + }; + format: { + type: string; + }; + lastmod_time: { + type: string; + }; + byte_count: { + type: string; + }; + data: { + $ref: string; + }; + }; + required: string[]; + description: string; + }; + IMessageAttachmentData: { + type: string; + properties: { + jws: {}; + hash: { + type: string; + }; + links: { + type: string; + items: { + type: string; + }; + }; + base64: { + type: string; + }; + json: {}; + }; + description: string; + }; + FindCredentialsArgs: { + $ref: string; + description: string; + }; + "FindArgs-TCredentialColumns": { + type: string; + properties: { + where: { + type: string; + items: { + $ref: string; + }; + description: string; + }; + order: { + type: string; + items: { + $ref: string; + }; + description: string; + }; + skip: { + type: string; + description: string; + }; + take: { + type: string; + description: string; + }; + }; + description: 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[]; + description: string; + }; + TCredentialColumns: { + type: string; + enum: string[]; + description: string; + }; + "Order-TCredentialColumns": { + type: string; + properties: { + column: { + $ref: string; + }; + direction: { + type: string; + enum: string[]; + }; + }; + required: string[]; + description: string; + }; + UniqueVerifiableCredential: { + type: string; + properties: { + hash: { + type: string; + }; + verifiableCredential: { + $ref: string; + }; + }; + required: string[]; + description: string; + }; + FindClaimsArgs: { + $ref: string; + description: string; + }; + "FindArgs-TClaimsColumns": { + type: string; + properties: { + where: { + type: string; + items: { + $ref: string; + }; + description: string; + }; + order: { + type: string; + items: { + $ref: string; + }; + description: string; + }; + skip: { + type: string; + description: string; + }; + take: { + type: string; + description: string; + }; + }; + description: 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[]; + description: string; + }; + TClaimsColumns: { + type: string; + enum: string[]; + description: string; + }; + "Order-TClaimsColumns": { + type: string; + properties: { + column: { + $ref: string; + }; + direction: { + type: string; + enum: string[]; + }; + }; + required: string[]; + description: string; + }; + FindPresentationsArgs: { + $ref: string; + description: string; + }; + "FindArgs-TPresentationColumns": { + type: string; + properties: { + where: { + type: string; + items: { + $ref: string; + }; + description: string; + }; + order: { + type: string; + items: { + $ref: string; + }; + description: string; + }; + skip: { + type: string; + description: string; + }; + take: { + type: string; + description: string; + }; + }; + description: 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[]; + description: string; + }; + TPresentationColumns: { + type: string; + enum: string[]; + description: string; + }; + "Order-TPresentationColumns": { + type: string; + properties: { + column: { + $ref: string; + }; + direction: { + type: string; + enum: string[]; + }; + }; + required: string[]; + description: string; + }; + UniqueVerifiablePresentation: { + type: string; + properties: { + hash: { + type: string; + }; + verifiablePresentation: { + $ref: string; + }; + }; + required: string[]; + description: string; + }; + }; + methods: { + dataStoreORMGetIdentifiers: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + type: string; + items: { + $ref: string; + }; + }; + }; + dataStoreORMGetIdentifiersCount: { + 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; + }; + }; + }; + }; + }; + IMessageHandler: { + components: { + schemas: { + IHandleMessageArgs: { + type: string; + properties: { + raw: { + type: string; + description: string; + }; + metaData: { + type: string; + items: { + $ref: string; + }; + description: string; + }; + save: { + type: string; + description: string; + deprecated: 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; + 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; + }; + attachments: { + type: string; + items: { + $ref: string; + }; + description: string; + }; + returnRoute: { + type: string; + description: string; + }; + }; + required: string[]; + description: string; + }; + VerifiableCredential: { + type: string; + properties: { + proof: { + $ref: string; + }; + issuer: { + $ref: string; + }; + credentialSubject: { + $ref: string; + }; + type: { + anyOf: ({ + type: string; + items: { + type: string; + }; + } | { + type: string; + items?: undefined; + })[]; + }; + "@context": { + $ref: string; + }; + issuanceDate: { + type: string; + }; + expirationDate: { + type: string; + }; + credentialStatus: { + $ref: string; + }; + id: { + type: string; + }; + }; + required: string[]; + description: string; + }; + ProofType: { + type: string; + properties: { + type: { + type: string; + }; + }; + description: string; + }; + IssuerType: { + anyOf: ({ + type: string; + properties: { + id: { + type: string; + }; + }; + required: string[]; + } | { + type: string; + properties?: undefined; + required?: undefined; + })[]; + description: string; + }; + CredentialSubject: { + type: string; + properties: { + id: { + type: string; + }; + }; + description: string; + }; + ContextType: { + anyOf: ({ + type: string; + items?: undefined; + } | { + type: string; + items: { + anyOf: { + type: string; + }[]; + }; + })[]; + description: string; + }; + CredentialStatusReference: { + type: string; + properties: { + id: { + type: string; + }; + type: { + type: string; + }; + }; + required: string[]; + description: string; + }; + VerifiablePresentation: { + type: string; + properties: { + proof: { + $ref: string; + }; + holder: { + type: string; + }; + verifiableCredential: { + type: string; + items: { + $ref: string; + }; + }; + type: { + anyOf: ({ + type: string; + items: { + type: string; + }; + } | { + type: string; + items?: undefined; + })[]; + }; + "@context": { + $ref: string; + }; + verifier: { + type: string; + items: { + type: string; + }; + }; + issuanceDate: { + type: string; + }; + expirationDate: { + type: string; + }; + id: { + type: string; + }; + }; + required: string[]; + description: string; + }; + W3CVerifiableCredential: { + anyOf: { + $ref: string; + }[]; + description: string; + }; + CompactJWT: { + type: string; + description: string; + }; + IMessageAttachment: { + type: string; + properties: { + id: { + type: string; + }; + description: { + type: string; + }; + filename: { + type: string; + }; + media_type: { + type: string; + }; + format: { + type: string; + }; + lastmod_time: { + type: string; + }; + byte_count: { + type: string; + }; + data: { + $ref: string; + }; + }; + required: string[]; + description: string; + }; + IMessageAttachmentData: { + type: string; + properties: { + jws: {}; + hash: { + type: string; + }; + links: { + type: string; + items: { + type: string; + }; + }; + base64: { + type: string; + }; + json: {}; + }; + description: string; + }; + }; + methods: { + handleMessage: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + $ref: string; + }; + }; + }; + }; + }; + ICredentialIssuer: { + components: { + schemas: { + ICreateVerifiableCredentialArgs: { + type: string; + properties: { + resolutionOptions: { + type: string; + properties: { + publicKeyFormat: { + type: string; + }; + accept: { + type: string; + }; + }; + description: string; + }; + credential: { + $ref: string; + description: string; + }; + save: { + type: string; + description: string; + deprecated: string; + }; + proofFormat: { + $ref: string; + description: string; + }; + removeOriginalFields: { + type: string; + description: string; + }; + keyRef: { + type: string; + description: string; + }; + fetchRemoteContexts: { + type: string; + description: string; + }; + }; + required: string[]; + additionalProperties: { + description: string; + }; + description: string; + }; + CredentialPayload: { + type: string; + properties: { + issuer: { + $ref: string; + }; + credentialSubject: { + $ref: string; + }; + type: { + type: string; + items: { + type: string; + }; + }; + "@context": { + $ref: string; + }; + issuanceDate: { + $ref: string; + }; + expirationDate: { + $ref: string; + }; + credentialStatus: { + $ref: string; + }; + id: { + type: string; + }; + }; + required: string[]; + description: string; + }; + IssuerType: { + anyOf: ({ + type: string; + properties: { + id: { + type: string; + }; + }; + required: string[]; + } | { + type: string; + properties?: undefined; + required?: undefined; + })[]; + description: string; + }; + CredentialSubject: { + type: string; + properties: { + id: { + type: string; + }; + }; + description: string; + }; + ContextType: { + anyOf: ({ + type: string; + items?: undefined; + } | { + type: string; + items: { + anyOf: { + type: string; + }[]; + }; + })[]; + description: string; + }; + DateType: { + type: string; + description: string; + }; + CredentialStatusReference: { + type: string; + properties: { + id: { + type: string; + }; + type: { + type: string; + }; + }; + required: string[]; + description: string; + }; + ProofFormat: { + type: string; + enum: string[]; + description: string; + }; + VerifiableCredential: { + type: string; + properties: { + proof: { + $ref: string; + }; + issuer: { + $ref: string; + }; + credentialSubject: { + $ref: string; + }; + type: { + anyOf: ({ + type: string; + items: { + type: string; + }; + } | { + type: string; + items?: undefined; + })[]; + }; + "@context": { + $ref: string; + }; + issuanceDate: { + type: string; + }; + expirationDate: { + type: string; + }; + credentialStatus: { + $ref: string; + }; + id: { + type: string; + }; + }; + required: string[]; + description: string; + }; + ProofType: { + type: string; + properties: { + type: { + type: string; + }; + }; + description: string; + }; + ICreateVerifiablePresentationArgs: { + type: string; + properties: { + resolutionOptions: { + type: string; + properties: { + publicKeyFormat: { + type: string; + }; + accept: { + type: string; + }; + }; + description: string; + }; + presentation: { + $ref: string; + description: string; + }; + save: { + type: string; + description: string; + deprecated: string; + }; + challenge: { + type: string; + description: string; + }; + domain: { + type: string; + description: string; + }; + proofFormat: { + $ref: string; + description: string; + }; + removeOriginalFields: { + type: string; + description: string; + }; + keyRef: { + type: string; + description: string; + }; + fetchRemoteContexts: { + type: string; + description: string; + }; + }; + required: string[]; + additionalProperties: { + description: string; + }; + description: string; + }; + PresentationPayload: { + type: string; + properties: { + holder: { + type: string; + }; + verifiableCredential: { + type: string; + items: { + $ref: string; + }; + }; + type: { + type: string; + items: { + type: string; + }; + }; + "@context": { + $ref: string; + }; + verifier: { + type: string; + items: { + type: string; + }; + }; + issuanceDate: { + $ref: string; + }; + expirationDate: { + $ref: string; + }; + id: { + type: string; + }; + }; + required: string[]; + description: string; + }; + W3CVerifiableCredential: { + anyOf: { + $ref: string; + }[]; + description: string; + }; + CompactJWT: { + type: string; + description: string; + }; + VerifiablePresentation: { + type: string; + properties: { + proof: { + $ref: string; + }; + holder: { + type: string; + }; + verifiableCredential: { + type: string; + items: { + $ref: string; + }; + }; + type: { + anyOf: ({ + type: string; + items: { + type: string; + }; + } | { + type: string; + items?: undefined; + })[]; + }; + "@context": { + $ref: string; + }; + verifier: { + type: string; + items: { + type: string; + }; + }; + issuanceDate: { + type: string; + }; + expirationDate: { + type: string; + }; + id: { + type: string; + }; + }; + required: string[]; + description: string; + }; + IIdentifier: { + 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; + }; + }; + 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: ({ + $ref: string; + type?: undefined; + } | { + type: string; + $ref?: undefined; + })[]; + description: string; + }; + }; + required: string[]; + description: string; + }; + TKeyType: { + type: string; + enum: string[]; + description: string; + }; + KeyMetadata: { + type: string; + properties: { + algorithms: { + type: string; + items: { + $ref: string; + }; + }; + }; + description: string; + }; + TAlg: { + type: string; + description: string; + }; + IService: { + type: string; + properties: { + id: { + type: string; + description: string; + }; + type: { + type: string; + description: string; + }; + serviceEndpoint: { + anyOf: ({ + $ref: string; + type?: undefined; + items?: undefined; + } | { + type: string; + items: { + $ref: string; + }; + $ref?: undefined; + })[]; + description: string; + }; + description: { + type: string; + description: string; + }; + }; + required: string[]; + description: string; + }; + IServiceEndpoint: { + anyOf: { + type: string; + }[]; + description: string; + }; + }; + methods: { + createVerifiableCredential: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + $ref: string; + }; + }; + createVerifiablePresentation: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + $ref: string; + }; + }; + listUsableProofFormats: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + type: string; + items: { + $ref: string; + }; + }; + }; + }; + }; + }; + ICredentialVerifier: { + components: { + schemas: { + IVerifyCredentialArgs: { + type: string; + properties: { + resolutionOptions: { + type: string; + properties: { + publicKeyFormat: { + type: string; + }; + accept: { + type: string; + }; + }; + description: string; + }; + credential: { + $ref: string; + description: string; + }; + fetchRemoteContexts: { + type: string; + description: string; + }; + policies: { + $ref: string; + description: string; + }; + }; + required: string[]; + additionalProperties: { + description: string; + }; + description: string; + }; + W3CVerifiableCredential: { + anyOf: { + $ref: string; + }[]; + description: string; + }; + VerifiableCredential: { + type: string; + properties: { + proof: { + $ref: string; + }; + issuer: { + $ref: string; + }; + credentialSubject: { + $ref: string; + }; + type: { + anyOf: ({ + type: string; + items: { + type: string; + }; + } | { + type: string; + items?: undefined; + })[]; + }; + "@context": { + $ref: string; + }; + issuanceDate: { + type: string; + }; + expirationDate: { + type: string; + }; + credentialStatus: { + $ref: string; + }; + id: { + type: string; + }; + }; + required: string[]; + description: string; + }; + ProofType: { + type: string; + properties: { + type: { + type: string; + }; + }; + description: string; + }; + IssuerType: { + anyOf: ({ + type: string; + properties: { + id: { + type: string; + }; + }; + required: string[]; + } | { + type: string; + properties?: undefined; + required?: undefined; + })[]; + description: string; + }; + CredentialSubject: { + type: string; + properties: { + id: { + type: string; + }; + }; + description: string; + }; + ContextType: { + anyOf: ({ + type: string; + items?: undefined; + } | { + type: string; + items: { + anyOf: { + type: string; + }[]; + }; + })[]; + description: string; + }; + CredentialStatusReference: { + type: string; + properties: { + id: { + type: string; + }; + type: { + type: string; + }; + }; + required: string[]; + description: string; + }; + CompactJWT: { + type: string; + description: string; + }; + VerificationPolicies: { + type: string; + properties: { + now: { + type: string; + description: string; + }; + issuanceDate: { + type: string; + description: string; + }; + expirationDate: { + type: string; + description: string; + }; + audience: { + type: string; + description: string; + }; + credentialStatus: { + type: string; + description: string; + }; + }; + additionalProperties: { + description: string; + }; + description: string; + }; + IVerifyResult: { + type: string; + properties: { + verified: { + type: string; + description: string; + }; + error: { + $ref: string; + description: string; + }; + }; + required: string[]; + additionalProperties: { + description: string; + }; + description: string; + }; + IError: { + type: string; + properties: { + message: { + type: string; + description: string; + }; + errorCode: { + type: string; + description: string; + }; + }; + description: string; + }; + IVerifyPresentationArgs: { + type: string; + properties: { + resolutionOptions: { + type: string; + properties: { + publicKeyFormat: { + type: string; + }; + accept: { + type: string; + }; + }; + description: string; + }; + presentation: { + $ref: string; + description: string; + }; + challenge: { + type: string; + description: string; + }; + domain: { + type: string; + description: string; + }; + fetchRemoteContexts: { + type: string; + description: string; + }; + policies: { + $ref: string; + description: string; + }; + }; + required: string[]; + additionalProperties: { + description: string; + }; + description: string; + }; + W3CVerifiablePresentation: { + anyOf: { + $ref: string; + }[]; + description: string; + }; + VerifiablePresentation: { + type: string; + properties: { + proof: { + $ref: string; + }; + holder: { + type: string; + }; + verifiableCredential: { + type: string; + items: { + $ref: string; + }; + }; + type: { + anyOf: ({ + type: string; + items: { + type: string; + }; + } | { + type: string; + items?: undefined; + })[]; + }; + "@context": { + $ref: string; + }; + verifier: { + type: string; + items: { + type: string; + }; + }; + issuanceDate: { + type: string; + }; + expirationDate: { + type: string; + }; + id: { + type: string; + }; + }; + required: string[]; + description: string; + }; + }; + methods: { + verifyCredential: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + $ref: string; + }; + }; + verifyPresentation: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + $ref: string; + }; + }; + }; + }; + }; + ICredentialPlugin: { + components: { + schemas: {}; + methods: {}; + }; + }; + ICredentialStatus: { + components: { + schemas: {}; + methods: {}; + }; + }; + ICredentialStatusVerifier: { + components: { + schemas: { + ICheckCredentialStatusArgs: { + type: string; + properties: { + resolutionOptions: { + type: string; + properties: { + publicKeyFormat: { + type: string; + }; + accept: { + type: string; + }; + }; + description: string; + }; + credential: { + $ref: string; + description: string; + }; + didDocumentOverride: { + $ref: string; + description: string; + }; + }; + required: string[]; + description: string; + }; + VerifiableCredential: { + type: string; + properties: { + proof: { + $ref: string; + }; + issuer: { + $ref: string; + }; + credentialSubject: { + $ref: string; + }; + type: { + anyOf: ({ + type: string; + items: { + type: string; + }; + } | { + type: string; + items?: undefined; + })[]; + }; + "@context": { + $ref: string; + }; + issuanceDate: { + type: string; + }; + expirationDate: { + type: string; + }; + credentialStatus: { + $ref: string; + }; + id: { + type: string; + }; + }; + required: string[]; + description: string; + }; + ProofType: { + type: string; + properties: { + type: { + type: string; + }; + }; + description: string; + }; + IssuerType: { + anyOf: ({ + type: string; + properties: { + id: { + type: string; + }; + }; + required: string[]; + } | { + type: string; + properties?: undefined; + required?: undefined; + })[]; + description: string; + }; + CredentialSubject: { + type: string; + properties: { + id: { + type: string; + }; + }; + description: string; + }; + ContextType: { + anyOf: ({ + type: string; + items?: undefined; + } | { + type: string; + items: { + anyOf: { + type: string; + }[]; + }; + })[]; + description: string; + }; + CredentialStatusReference: { + type: string; + properties: { + id: { + type: string; + }; + type: { + type: string; + }; + }; + required: string[]; + description: string; + }; + DIDDocument: { + type: string; + properties: { + authentication: { + type: string; + items: { + anyOf: ({ + type: string; + $ref?: undefined; + } | { + $ref: string; + type?: undefined; + })[]; + }; + }; + assertionMethod: { + type: string; + items: { + anyOf: ({ + type: string; + $ref?: undefined; + } | { + $ref: string; + type?: undefined; + })[]; + }; + }; + keyAgreement: { + type: string; + items: { + anyOf: ({ + type: string; + $ref?: undefined; + } | { + $ref: string; + type?: undefined; + })[]; + }; + }; + capabilityInvocation: { + type: string; + items: { + anyOf: ({ + type: string; + $ref?: undefined; + } | { + $ref: string; + type?: undefined; + })[]; + }; + }; + capabilityDelegation: { + type: string; + items: { + anyOf: ({ + type: string; + $ref?: undefined; + } | { + $ref: string; + type?: undefined; + })[]; + }; + }; + "@context": { + anyOf: ({ + type: string; + const: string; + items?: undefined; + } | { + type: string; + const?: undefined; + items?: undefined; + } | { + type: string; + items: { + type: string; + }; + const?: undefined; + })[]; + }; + id: { + type: string; + }; + alsoKnownAs: { + type: string; + items: { + type: string; + }; + }; + controller: { + anyOf: ({ + type: string; + items?: undefined; + } | { + type: string; + items: { + type: string; + }; + })[]; + }; + verificationMethod: { + type: string; + items: { + $ref: string; + }; + }; + service: { + type: string; + items: { + $ref: string; + }; + }; + publicKey: { + type: string; + items: { + $ref: string; + }; + deprecated: boolean; + }; + }; + required: string[]; + description: string; + }; + VerificationMethod: { + type: string; + properties: { + id: { + type: string; + }; + type: { + type: string; + }; + controller: { + type: string; + }; + publicKeyBase58: { + type: string; + }; + publicKeyBase64: { + type: string; + }; + publicKeyJwk: { + $ref: string; + }; + publicKeyHex: { + type: string; + }; + publicKeyMultibase: { + type: string; + }; + blockchainAccountId: { + type: string; + }; + ethereumAddress: { + type: string; + }; + conditionOr: { + type: string; + items: { + $ref: string; + }; + }; + conditionAnd: { + type: string; + items: { + $ref: string; + }; + }; + threshold: { + type: string; + }; + conditionThreshold: { + type: string; + items: { + $ref: string; + }; + }; + conditionWeightedThreshold: { + type: string; + items: { + $ref: string; + }; + }; + conditionDelegated: { + type: string; + }; + relationshipParent: { + type: string; + items: { + type: string; + }; + }; + relationshipChild: { + type: string; + items: { + type: string; + }; + }; + relationshipSibling: { + type: string; + items: { + type: string; + }; + }; + }; + required: string[]; + description: string; + }; + JsonWebKey: { + type: string; + properties: { + alg: { + type: string; + }; + crv: { + type: string; + }; + e: { + type: string; + }; + ext: { + type: string; + }; + key_ops: { + type: string; + items: { + type: string; + }; + }; + kid: { + type: string; + }; + kty: { + type: string; + }; + n: { + type: string; + }; + use: { + type: string; + }; + x: { + type: string; + }; + y: { + type: string; + }; + }; + required: string[]; + description: string; + }; + ConditionWeightedThreshold: { + type: string; + properties: { + condition: { + $ref: string; + }; + weight: { + type: string; + }; + }; + required: string[]; + }; + Service: { + type: string; + properties: { + id: { + type: string; + }; + type: { + type: string; + }; + serviceEndpoint: { + anyOf: ({ + $ref: string; + type?: undefined; + items?: undefined; + } | { + type: string; + items: { + $ref: string; + }; + $ref?: undefined; + })[]; + }; + }; + required: string[]; + description: string; + }; + ServiceEndpoint: { + anyOf: { + type: string; + }[]; + description: string; + }; + CredentialStatus: { + type: string; + properties: { + revoked: { + type: string; + }; + }; + required: string[]; + description: string; + }; + }; + methods: { + checkCredentialStatus: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + $ref: string; + }; + }; + }; + }; + }; + ICredentialStatusManager: { + components: { + schemas: { + CredentialStatusGenerateArgs: { + type: string; + properties: { + type: { + type: string; + description: string; + }; + }; + required: string[]; + additionalProperties: { + description: string; + }; + description: string; + }; + CredentialStatusReference: { + type: string; + properties: { + id: { + type: string; + }; + type: { + type: string; + }; + }; + required: string[]; + description: string; + }; + CredentialStatusUpdateArgs: { + type: string; + properties: { + vc: { + $ref: string; + description: string; + }; + options: { + type: string; + description: string; + }; + }; + required: string[]; + description: string; + }; + VerifiableCredential: { + type: string; + properties: { + proof: { + $ref: string; + }; + issuer: { + $ref: string; + }; + credentialSubject: { + $ref: string; + }; + type: { + anyOf: ({ + type: string; + items: { + type: string; + }; + } | { + type: string; + items?: undefined; + })[]; + }; + "@context": { + $ref: string; + }; + issuanceDate: { + type: string; + }; + expirationDate: { + type: string; + }; + credentialStatus: { + $ref: string; + }; + id: { + type: string; + }; + }; + required: string[]; + description: string; + }; + ProofType: { + type: string; + properties: { + type: { + type: string; + }; + }; + description: string; + }; + IssuerType: { + anyOf: ({ + type: string; + properties: { + id: { + type: string; + }; + }; + required: string[]; + } | { + type: string; + properties?: undefined; + required?: undefined; + })[]; + description: string; + }; + CredentialSubject: { + type: string; + properties: { + id: { + type: string; + }; + }; + description: string; + }; + ContextType: { + anyOf: ({ + type: string; + items?: undefined; + } | { + type: string; + items: { + anyOf: { + type: string; + }[]; + }; + })[]; + description: string; + }; + }; + methods: { + credentialStatusGenerate: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + $ref: string; + }; + }; + credentialStatusTypes: { + description: string; + arguments: { + type: string; + }; + returnType: { + type: string; + items: { + type: string; + }; + }; + }; + credentialStatusUpdate: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + type: string; + }; + }; + }; + }; + }; +} +``` diff --git a/docs/api/core-types.tclaimscolumns.md b/docs/api/core-types.tclaimscolumns.md index c3121452..1e09a16e 100644 --- a/docs/api/core-types.tclaimscolumns.md +++ b/docs/api/core-types.tclaimscolumns.md @@ -8,7 +8,7 @@ hide_title: true ## TClaimsColumns type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The columns that can be searched for the claims of a [VerifiableCredential](./core-types.verifiablecredential.md) diff --git a/docs/api/core-types.tcredentialcolumns.md b/docs/api/core-types.tcredentialcolumns.md index ce6eb2f0..dca7f7be 100644 --- a/docs/api/core-types.tcredentialcolumns.md +++ b/docs/api/core-types.tcredentialcolumns.md @@ -8,7 +8,7 @@ hide_title: true ## TCredentialColumns type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The columns that can be searched for a [VerifiableCredential](./core-types.verifiablecredential.md) diff --git a/docs/api/core-types.tidentifierscolumns.md b/docs/api/core-types.tidentifierscolumns.md index 9db37ffd..4ed2dda0 100644 --- a/docs/api/core-types.tidentifierscolumns.md +++ b/docs/api/core-types.tidentifierscolumns.md @@ -8,7 +8,7 @@ hide_title: true ## TIdentifiersColumns type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. > Warning: This API is now obsolete. > diff --git a/docs/api/core-types.tmessagecolumns.md b/docs/api/core-types.tmessagecolumns.md index acbe3a43..4230d05a 100644 --- a/docs/api/core-types.tmessagecolumns.md +++ b/docs/api/core-types.tmessagecolumns.md @@ -8,7 +8,7 @@ hide_title: true ## TMessageColumns type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The columns that can be queried for an [IMessage](./core-types.imessage.md) diff --git a/docs/api/core-types.tpresentationcolumns.md b/docs/api/core-types.tpresentationcolumns.md index 61f93621..66fbdd7c 100644 --- a/docs/api/core-types.tpresentationcolumns.md +++ b/docs/api/core-types.tpresentationcolumns.md @@ -8,7 +8,7 @@ hide_title: true ## TPresentationColumns type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The columns that can be searched for a [VerifiablePresentation](./core-types.verifiablepresentation.md) diff --git a/docs/api/core-types.uniqueverifiablecredential.hash.md b/docs/api/core-types.uniqueverifiablecredential.hash.md index 61c9561e..d392c9b9 100644 --- a/docs/api/core-types.uniqueverifiablecredential.hash.md +++ b/docs/api/core-types.uniqueverifiablecredential.hash.md @@ -8,7 +8,7 @@ hide_title: true ## UniqueVerifiableCredential.hash property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.uniqueverifiablecredential.md b/docs/api/core-types.uniqueverifiablecredential.md index f67dce7a..191f0812 100644 --- a/docs/api/core-types.uniqueverifiablecredential.md +++ b/docs/api/core-types.uniqueverifiablecredential.md @@ -8,7 +8,7 @@ hide_title: true ## UniqueVerifiableCredential interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Represents the result of a Query for [VerifiableCredential](./core-types.verifiablecredential.md)s diff --git a/docs/api/core-types.uniqueverifiablecredential.verifiablecredential.md b/docs/api/core-types.uniqueverifiablecredential.verifiablecredential.md index da4b21c8..c86c8aaf 100644 --- a/docs/api/core-types.uniqueverifiablecredential.verifiablecredential.md +++ b/docs/api/core-types.uniqueverifiablecredential.verifiablecredential.md @@ -8,7 +8,7 @@ hide_title: true ## UniqueVerifiableCredential.verifiableCredential property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.uniqueverifiablepresentation.hash.md b/docs/api/core-types.uniqueverifiablepresentation.hash.md index bae3e692..0b021cbd 100644 --- a/docs/api/core-types.uniqueverifiablepresentation.hash.md +++ b/docs/api/core-types.uniqueverifiablepresentation.hash.md @@ -8,7 +8,7 @@ hide_title: true ## UniqueVerifiablePresentation.hash property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.uniqueverifiablepresentation.md b/docs/api/core-types.uniqueverifiablepresentation.md index e1d3c9f4..82192586 100644 --- a/docs/api/core-types.uniqueverifiablepresentation.md +++ b/docs/api/core-types.uniqueverifiablepresentation.md @@ -8,7 +8,7 @@ hide_title: true ## UniqueVerifiablePresentation interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Represents the result of a Query for [VerifiablePresentation](./core-types.verifiablepresentation.md)s diff --git a/docs/api/core-types.uniqueverifiablepresentation.verifiablepresentation.md b/docs/api/core-types.uniqueverifiablepresentation.verifiablepresentation.md index 84bf5a89..af5f9dd7 100644 --- a/docs/api/core-types.uniqueverifiablepresentation.verifiablepresentation.md +++ b/docs/api/core-types.uniqueverifiablepresentation.verifiablepresentation.md @@ -8,7 +8,7 @@ hide_title: true ## UniqueVerifiablePresentation.verifiablePresentation property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.unsignedcredential.__context_.md b/docs/api/core-types.unsignedcredential.__context_.md index 0a4693aa..ec775dc1 100644 --- a/docs/api/core-types.unsignedcredential.__context_.md +++ b/docs/api/core-types.unsignedcredential.__context_.md @@ -8,7 +8,7 @@ hide_title: true ## UnsignedCredential."@context" property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.unsignedcredential.credentialstatus.md b/docs/api/core-types.unsignedcredential.credentialstatus.md index 1d93d7a5..39ceafe3 100644 --- a/docs/api/core-types.unsignedcredential.credentialstatus.md +++ b/docs/api/core-types.unsignedcredential.credentialstatus.md @@ -8,7 +8,7 @@ hide_title: true ## UnsignedCredential.credentialStatus property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.unsignedcredential.credentialsubject.md b/docs/api/core-types.unsignedcredential.credentialsubject.md index fb4dfdf0..42441f7f 100644 --- a/docs/api/core-types.unsignedcredential.credentialsubject.md +++ b/docs/api/core-types.unsignedcredential.credentialsubject.md @@ -8,7 +8,7 @@ hide_title: true ## UnsignedCredential.credentialSubject property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.unsignedcredential.expirationdate.md b/docs/api/core-types.unsignedcredential.expirationdate.md index 4065b1f6..270d459c 100644 --- a/docs/api/core-types.unsignedcredential.expirationdate.md +++ b/docs/api/core-types.unsignedcredential.expirationdate.md @@ -8,7 +8,7 @@ hide_title: true ## UnsignedCredential.expirationDate property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.unsignedcredential.id.md b/docs/api/core-types.unsignedcredential.id.md index 7b4b06b3..61599734 100644 --- a/docs/api/core-types.unsignedcredential.id.md +++ b/docs/api/core-types.unsignedcredential.id.md @@ -8,7 +8,7 @@ hide_title: true ## UnsignedCredential.id property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.unsignedcredential.issuancedate.md b/docs/api/core-types.unsignedcredential.issuancedate.md index 81f412cc..0be95e30 100644 --- a/docs/api/core-types.unsignedcredential.issuancedate.md +++ b/docs/api/core-types.unsignedcredential.issuancedate.md @@ -8,7 +8,7 @@ hide_title: true ## UnsignedCredential.issuanceDate property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.unsignedcredential.issuer.md b/docs/api/core-types.unsignedcredential.issuer.md index de3d1322..3e1f5679 100644 --- a/docs/api/core-types.unsignedcredential.issuer.md +++ b/docs/api/core-types.unsignedcredential.issuer.md @@ -8,7 +8,7 @@ hide_title: true ## UnsignedCredential.issuer property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.unsignedcredential.md b/docs/api/core-types.unsignedcredential.md index 539fba22..7df36188 100644 --- a/docs/api/core-types.unsignedcredential.md +++ b/docs/api/core-types.unsignedcredential.md @@ -8,7 +8,7 @@ hide_title: true ## UnsignedCredential interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Represents an unsigned W3C Credential payload. See [VC data model](https://www.w3.org/TR/vc-data-model/#credentials) diff --git a/docs/api/core-types.unsignedcredential.type.md b/docs/api/core-types.unsignedcredential.type.md index 18746082..5c70307a 100644 --- a/docs/api/core-types.unsignedcredential.type.md +++ b/docs/api/core-types.unsignedcredential.type.md @@ -8,7 +8,7 @@ hide_title: true ## UnsignedCredential.type property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.usingresolutionoptions.md b/docs/api/core-types.usingresolutionoptions.md new file mode 100644 index 00000000..93d43ac3 --- /dev/null +++ b/docs/api/core-types.usingresolutionoptions.md @@ -0,0 +1,23 @@ +--- +id: core-types.usingresolutionoptions +title: UsingResolutionOptions interface +hide_title: true +--- + + + +## UsingResolutionOptions interface + +Options that are forwarded to the DID resolver. + +**Signature:** + +```typescript +export interface UsingResolutionOptions +``` + +## Properties + +| Property | Modifiers | Type | Description | +| ------------------------------------------------------------------------------ | --------- | -------------------------------------------------------- | ------------------------------------------------------ | +| [resolutionOptions?](./core-types.usingresolutionoptions.resolutionoptions.md) | | DIDResolutionOptions & { publicKeyFormat?: string; } | _(Optional)_ Options to be passed to the DID resolver. | diff --git a/docs/api/core-types.usingresolutionoptions.resolutionoptions.md b/docs/api/core-types.usingresolutionoptions.resolutionoptions.md new file mode 100644 index 00000000..7dd441d9 --- /dev/null +++ b/docs/api/core-types.usingresolutionoptions.resolutionoptions.md @@ -0,0 +1,19 @@ +--- +id: core-types.usingresolutionoptions.resolutionoptions +title: UsingResolutionOptions.resolutionOptions property +hide_title: true +--- + + + +## UsingResolutionOptions.resolutionOptions property + +Options to be passed to the DID resolver. + +**Signature:** + +```typescript +resolutionOptions?: DIDResolutionOptions & { + publicKeyFormat?: string; + }; +``` diff --git a/docs/api/core-types.verifiablecredential.md b/docs/api/core-types.verifiablecredential.md index 57f70d1d..eb1189c9 100644 --- a/docs/api/core-types.verifiablecredential.md +++ b/docs/api/core-types.verifiablecredential.md @@ -8,7 +8,7 @@ hide_title: true ## VerifiableCredential type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Represents a signed Verifiable Credential payload (includes proof), using a JSON representation. See [VC data model](https://www.w3.org/TR/vc-data-model/#credentials) diff --git a/docs/api/core-types.verificationpolicies.audience.md b/docs/api/core-types.verificationpolicies.audience.md index bad4e8fb..1e4f2d77 100644 --- a/docs/api/core-types.verificationpolicies.audience.md +++ b/docs/api/core-types.verificationpolicies.audience.md @@ -8,7 +8,7 @@ hide_title: true ## VerificationPolicies.audience property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. policy to skip the audience check when set to `false` diff --git a/docs/api/core-types.verificationpolicies.credentialstatus.md b/docs/api/core-types.verificationpolicies.credentialstatus.md index 91420360..08371b55 100644 --- a/docs/api/core-types.verificationpolicies.credentialstatus.md +++ b/docs/api/core-types.verificationpolicies.credentialstatus.md @@ -8,7 +8,7 @@ hide_title: true ## VerificationPolicies.credentialStatus property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. policy to skip the revocation check (credentialStatus) when set to `false` diff --git a/docs/api/core-types.verificationpolicies.expirationdate.md b/docs/api/core-types.verificationpolicies.expirationdate.md index 74d4e74b..0232ddc7 100644 --- a/docs/api/core-types.verificationpolicies.expirationdate.md +++ b/docs/api/core-types.verificationpolicies.expirationdate.md @@ -8,7 +8,7 @@ hide_title: true ## VerificationPolicies.expirationDate property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. policy to skip the expirationDate (exp) timestamp check when set to `false` diff --git a/docs/api/core-types.verificationpolicies.issuancedate.md b/docs/api/core-types.verificationpolicies.issuancedate.md index bda70f8a..142c5665 100644 --- a/docs/api/core-types.verificationpolicies.issuancedate.md +++ b/docs/api/core-types.verificationpolicies.issuancedate.md @@ -8,7 +8,7 @@ hide_title: true ## VerificationPolicies.issuanceDate property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. policy to skip the issuanceDate (nbf) timestamp check when set to `false` diff --git a/docs/api/core-types.verificationpolicies.md b/docs/api/core-types.verificationpolicies.md index c31b9300..b89a2646 100644 --- a/docs/api/core-types.verificationpolicies.md +++ b/docs/api/core-types.verificationpolicies.md @@ -8,7 +8,7 @@ hide_title: true ## VerificationPolicies interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. These optional settings can be used to override some default checks that are performed on Presentations during verification. diff --git a/docs/api/core-types.verificationpolicies.now.md b/docs/api/core-types.verificationpolicies.now.md index 51537c86..1ce071f6 100644 --- a/docs/api/core-types.verificationpolicies.now.md +++ b/docs/api/core-types.verificationpolicies.now.md @@ -8,7 +8,7 @@ hide_title: true ## VerificationPolicies.now property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. policy to over the now (current time) during the verification check (UNIX time in seconds) diff --git a/docs/api/core-types.verifieragentcontext.md b/docs/api/core-types.verifieragentcontext.md index 4d1f0d1f..ce9103dd 100644 --- a/docs/api/core-types.verifieragentcontext.md +++ b/docs/api/core-types.verifieragentcontext.md @@ -8,7 +8,7 @@ hide_title: true ## VerifierAgentContext type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Represents the requirements that this plugin has. The agent that is using this plugin is expected to provide these methods. diff --git a/docs/api/core-types.w3cverifiablecredential.md b/docs/api/core-types.w3cverifiablecredential.md index 6b02e5f6..55a01323 100644 --- a/docs/api/core-types.w3cverifiablecredential.md +++ b/docs/api/core-types.w3cverifiablecredential.md @@ -8,7 +8,7 @@ hide_title: true ## W3CVerifiableCredential type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Represents a signed Verifiable Credential (includes proof), in either JSON or compact JWT format. See [VC data model](https://www.w3.org/TR/vc-data-model/#credentials) See [proof formats](https://www.w3.org/TR/vc-data-model/#proof-formats) diff --git a/docs/api/core-types.where.column.md b/docs/api/core-types.where.column.md index 73fc6dec..b1d844fc 100644 --- a/docs/api/core-types.where.column.md +++ b/docs/api/core-types.where.column.md @@ -8,7 +8,7 @@ hide_title: true ## Where.column property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.where.md b/docs/api/core-types.where.md index 618c9af8..7dd66c6f 100644 --- a/docs/api/core-types.where.md +++ b/docs/api/core-types.where.md @@ -8,7 +8,7 @@ hide_title: true ## Where interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Represents a WHERE predicate for a [FindArgs](./core-types.findargs.md) query. In situations where multiple WHERE predicates are present, they are combined with AND. diff --git a/docs/api/core-types.where.not.md b/docs/api/core-types.where.not.md index 9416948d..8955e287 100644 --- a/docs/api/core-types.where.not.md +++ b/docs/api/core-types.where.not.md @@ -8,7 +8,7 @@ hide_title: true ## Where.not property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.where.op.md b/docs/api/core-types.where.op.md index 1ce9eb95..a64b673b 100644 --- a/docs/api/core-types.where.op.md +++ b/docs/api/core-types.where.op.md @@ -8,7 +8,7 @@ hide_title: true ## Where.op property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/core-types.where.value.md b/docs/api/core-types.where.value.md index b141a8f2..1b868247 100644 --- a/docs/api/core-types.where.value.md +++ b/docs/api/core-types.where.value.md @@ -8,7 +8,7 @@ hide_title: true ## Where.value property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/credential-eip712.credentialissuereip712._constructor_.md b/docs/api/credential-eip712.credentialissuereip712._constructor_.md index 9d89f6ff..2f512c8d 100644 --- a/docs/api/credential-eip712.credentialissuereip712._constructor_.md +++ b/docs/api/credential-eip712.credentialissuereip712._constructor_.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialIssuerEIP712.(constructor) -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Constructs a new instance of the `CredentialIssuerEIP712` class diff --git a/docs/api/credential-eip712.credentialissuereip712.createverifiablecredentialeip712.md b/docs/api/credential-eip712.credentialissuereip712.createverifiablecredentialeip712.md index f26be79c..f1ff5d3d 100644 --- a/docs/api/credential-eip712.credentialissuereip712.createverifiablecredentialeip712.md +++ b/docs/api/credential-eip712.credentialissuereip712.createverifiablecredentialeip712.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialIssuerEIP712.createVerifiableCredentialEIP712() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Creates a Verifiable Credential. The payload, signer and format are chosen based on the `args` parameter. diff --git a/docs/api/credential-eip712.credentialissuereip712.createverifiablepresentationeip712.md b/docs/api/credential-eip712.credentialissuereip712.createverifiablepresentationeip712.md index 3f1b20ad..d6977c2f 100644 --- a/docs/api/credential-eip712.credentialissuereip712.createverifiablepresentationeip712.md +++ b/docs/api/credential-eip712.credentialissuereip712.createverifiablepresentationeip712.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialIssuerEIP712.createVerifiablePresentationEIP712() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Creates a Verifiable Presentation. The payload and signer are chosen based on the `args` parameter. diff --git a/docs/api/credential-eip712.credentialissuereip712.md b/docs/api/credential-eip712.credentialissuereip712.md index 0d43f19a..a40cb4b3 100644 --- a/docs/api/credential-eip712.credentialissuereip712.md +++ b/docs/api/credential-eip712.credentialissuereip712.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialIssuerEIP712 class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. A Veramo plugin that implements the [ICredentialIssuerEIP712](./credential-eip712.icredentialissuereip712.md) methods. @@ -30,10 +30,10 @@ export declare class CredentialIssuerEIP712 implements IAgentPlugin ## Properties -| Property | Modifiers | Type | Description | -| ---------------------------------------------------------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | -| [methods](./credential-eip712.credentialissuereip712.methods.md) | readonly | [ICredentialIssuerEIP712](./credential-eip712.icredentialissuereip712.md) | **_(BETA)_** | -| [schema](./credential-eip712.credentialissuereip712.schema.md) | readonly | { components: { schemas: { ICreateVerifiableCredentialEIP712Args: { type: string; properties: { credential: { $ref: string; description: string; }; keyRef: { type: string; description: string; }; }; required: string\[\]; description: string; }; CredentialPayload: { type: string; properties: { issuer: { $ref: string; }; credentialSubject: { $ref: string; }; type: { type: string; items: { type: string; }; }; "@context": { $ref: string; }; issuanceDate: { $ref: string; }; expirationDate: { $ref: string; }; credentialStatus: { $ref: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; IssuerType: { anyOf: ({ type: string; properties: { id: { type: string; }; }; required: string\[\]; } | { type: string; properties?: undefined; required?: undefined; })\[\]; description: string; }; CredentialSubject: { type: string; properties: { id: { type: string; }; }; description: string; }; ContextType: { anyOf: ({ type: string; items?: undefined; } | { type: string; items: { anyOf: { type: string; }\[\]; }; })\[\]; description: string; }; DateType: { type: string; description: string; }; CredentialStatusReference: { type: string; properties: { id: { type: string; }; type: { type: string; }; }; required: string\[\]; description: string; }; VerifiableCredential: { type: string; properties: { proof: { $ref: string; }; issuer: { $ref: string; }; credentialSubject: { $ref: string; }; type: { anyOf: ({ type: string; items: { type: string; }; } | { type: string; items?: undefined; })\[\]; }; "@context": { $ref: string; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; credentialStatus: { $ref: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; ProofType: { type: string; properties: { type: { type: string; }; }; description: string; }; ICreateVerifiablePresentationEIP712Args: { type: string; properties: { presentation: { $ref: string; description: string; }; keyRef: { type: string; description: string; }; }; required: string\[\]; description: string; }; PresentationPayload: { type: string; properties: { holder: { type: string; }; verifiableCredential: { type: string; items: { $ref: string; }; }; type: { type: string; items: { type: string; }; }; "@context": { $ref: string; }; verifier: { type: string; items: { type: string; }; }; issuanceDate: { $ref: string; }; expirationDate: { $ref: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; W3CVerifiableCredential: { anyOf: { $ref: string; }\[\]; description: string; }; CompactJWT: { type: string; description: string; }; VerifiablePresentation: { type: string; properties: { proof: { $ref: string; }; holder: { type: string; }; verifiableCredential: { type: string; items: { $ref: string; }; }; type: { anyOf: ({ type: string; items: { type: string; }; } | { type: string; items?: undefined; })\[\]; }; "@context": { $ref: string; }; verifier: { type: string; items: { type: string; }; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; IVerifyCredentialEIP712Args: { type: string; properties: { credential: { $ref: string; description: string; }; }; required: string\[\]; description: string; }; IVerifyPresentationEIP712Args: { type: string; properties: { presentation: { $ref: string; description: string; }; }; required: string\[\]; description: string; }; }; methods: { createVerifiableCredentialEIP712: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; createVerifiablePresentationEIP712: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; verifyCredentialEIP712: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; verifyPresentationEIP712: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; }; }; } | **_(BETA)_** | +| Property | Modifiers | Type | Description | +| ---------------------------------------------------------------- | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | +| [methods](./credential-eip712.credentialissuereip712.methods.md) | readonly | [ICredentialIssuerEIP712](./credential-eip712.icredentialissuereip712.md) | **_(BETA)_** | +| [schema](./credential-eip712.credentialissuereip712.schema.md) | readonly | { components: { schemas: { ICreateVerifiableCredentialEIP712Args: { type: string; properties: { resolutionOptions: { type: string; properties: { publicKeyFormat: { type: string; }; accept: { type: string; }; }; description: string; }; credential: { $ref: string; description: string; }; keyRef: { type: string; description: string; }; }; required: string\[\]; description: string; }; CredentialPayload: { type: string; properties: { issuer: { $ref: string; }; credentialSubject: { $ref: string; }; type: { type: string; items: { type: string; }; }; "@context": { $ref: string; }; issuanceDate: { $ref: string; }; expirationDate: { $ref: string; }; credentialStatus: { $ref: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; IssuerType: { anyOf: ({ type: string; properties: { id: { type: string; }; }; required: string\[\]; } | { type: string; properties?: undefined; required?: undefined; })\[\]; description: string; }; CredentialSubject: { type: string; properties: { id: { type: string; }; }; description: string; }; ContextType: { anyOf: ({ type: string; items?: undefined; } | { type: string; items: { anyOf: { type: string; }\[\]; }; })\[\]; description: string; }; DateType: { type: string; description: string; }; CredentialStatusReference: { type: string; properties: { id: { type: string; }; type: { type: string; }; }; required: string\[\]; description: string; }; VerifiableCredential: { type: string; properties: { proof: { $ref: string; }; issuer: { $ref: string; }; credentialSubject: { $ref: string; }; type: { anyOf: ({ type: string; items: { type: string; }; } | { type: string; items?: undefined; })\[\]; }; "@context": { $ref: string; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; credentialStatus: { $ref: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; ProofType: { type: string; properties: { type: { type: string; }; }; description: string; }; ICreateVerifiablePresentationEIP712Args: { type: string; properties: { resolutionOptions: { type: string; properties: { publicKeyFormat: { type: string; }; accept: { type: string; }; }; description: string; }; presentation: { $ref: string; description: string; }; keyRef: { type: string; description: string; }; }; required: string\[\]; description: string; }; PresentationPayload: { type: string; properties: { holder: { type: string; }; verifiableCredential: { type: string; items: { $ref: string; }; }; type: { type: string; items: { type: string; }; }; "@context": { $ref: string; }; verifier: { type: string; items: { type: string; }; }; issuanceDate: { $ref: string; }; expirationDate: { $ref: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; W3CVerifiableCredential: { anyOf: { $ref: string; }\[\]; description: string; }; CompactJWT: { type: string; description: string; }; VerifiablePresentation: { type: string; properties: { proof: { $ref: string; }; holder: { type: string; }; verifiableCredential: { type: string; items: { $ref: string; }; }; type: { anyOf: ({ type: string; items: { type: string; }; } | { type: string; items?: undefined; })\[\]; }; "@context": { $ref: string; }; verifier: { type: string; items: { type: string; }; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; IVerifyCredentialEIP712Args: { type: string; properties: { resolutionOptions: { type: string; properties: { publicKeyFormat: { type: string; }; accept: { type: string; }; }; description: string; }; credential: { $ref: string; description: string; }; }; required: string\[\]; description: string; }; IVerifyPresentationEIP712Args: { type: string; properties: { resolutionOptions: { type: string; properties: { publicKeyFormat: { type: string; }; accept: { type: string; }; }; description: string; }; presentation: { $ref: string; description: string; }; }; required: string\[\]; description: string; }; }; methods: { createVerifiableCredentialEIP712: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; createVerifiablePresentationEIP712: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; verifyCredentialEIP712: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; verifyPresentationEIP712: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; }; }; } | **_(BETA)_** | ## Methods diff --git a/docs/api/credential-eip712.credentialissuereip712.methods.md b/docs/api/credential-eip712.credentialissuereip712.methods.md index f2a63dbe..c7a5fadf 100644 --- a/docs/api/credential-eip712.credentialissuereip712.methods.md +++ b/docs/api/credential-eip712.credentialissuereip712.methods.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialIssuerEIP712.methods property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/credential-eip712.credentialissuereip712.schema.md b/docs/api/credential-eip712.credentialissuereip712.schema.md index 34621e1d..4e8ffa1d 100644 --- a/docs/api/credential-eip712.credentialissuereip712.schema.md +++ b/docs/api/credential-eip712.credentialissuereip712.schema.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialIssuerEIP712.schema property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** @@ -19,6 +19,18 @@ readonly schema: { ICreateVerifiableCredentialEIP712Args: { type: string; properties: { + resolutionOptions: { + type: string; + properties: { + publicKeyFormat: { + type: string; + }; + accept: { + type: string; + }; + }; + description: string; + }; credential: { $ref: string; description: string; @@ -175,6 +187,18 @@ readonly schema: { ICreateVerifiablePresentationEIP712Args: { type: string; properties: { + resolutionOptions: { + type: string; + properties: { + publicKeyFormat: { + type: string; + }; + accept: { + type: string; + }; + }; + description: string; + }; presentation: { $ref: string; description: string; @@ -288,6 +312,18 @@ readonly schema: { IVerifyCredentialEIP712Args: { type: string; properties: { + resolutionOptions: { + type: string; + properties: { + publicKeyFormat: { + type: string; + }; + accept: { + type: string; + }; + }; + description: string; + }; credential: { $ref: string; description: string; @@ -299,6 +335,18 @@ readonly schema: { IVerifyPresentationEIP712Args: { type: string; properties: { + resolutionOptions: { + type: string; + properties: { + publicKeyFormat: { + type: string; + }; + accept: { + type: string; + }; + }; + description: string; + }; presentation: { $ref: string; description: string; diff --git a/docs/api/credential-eip712.icreateverifiablecredentialeip712args.credential.md b/docs/api/credential-eip712.icreateverifiablecredentialeip712args.credential.md index 9291b58b..d5b09676 100644 --- a/docs/api/credential-eip712.icreateverifiablecredentialeip712args.credential.md +++ b/docs/api/credential-eip712.icreateverifiablecredentialeip712args.credential.md @@ -8,7 +8,7 @@ hide_title: true ## ICreateVerifiableCredentialEIP712Args.credential property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The json payload of the Credential according to the [canonical model](https://www.w3.org/TR/vc-data-model/#credentials) diff --git a/docs/api/credential-eip712.icreateverifiablecredentialeip712args.keyref.md b/docs/api/credential-eip712.icreateverifiablecredentialeip712args.keyref.md index a92f948d..a3eb89bb 100644 --- a/docs/api/credential-eip712.icreateverifiablecredentialeip712args.keyref.md +++ b/docs/api/credential-eip712.icreateverifiablecredentialeip712args.keyref.md @@ -8,7 +8,7 @@ hide_title: true ## ICreateVerifiableCredentialEIP712Args.keyRef property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Specific key to use for signing diff --git a/docs/api/credential-eip712.icreateverifiablecredentialeip712args.md b/docs/api/credential-eip712.icreateverifiablecredentialeip712args.md index 4494acc3..4470a622 100644 --- a/docs/api/credential-eip712.icreateverifiablecredentialeip712args.md +++ b/docs/api/credential-eip712.icreateverifiablecredentialeip712args.md @@ -8,7 +8,7 @@ hide_title: true ## ICreateVerifiableCredentialEIP712Args interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Encapsulates the parameters required to create a [W3C Verifiable Credential](https://www.w3.org/TR/vc-data-model/#credentials) @@ -17,9 +17,11 @@ This API may change without a BREAKING CHANGE notice. **Signature:** ```typescript -export interface ICreateVerifiableCredentialEIP712Args +export interface ICreateVerifiableCredentialEIP712Args extends UsingResolutionOptions ``` +**Extends:** [UsingResolutionOptions](./core-types.usingresolutionoptions.md) + ## Properties | Property | Modifiers | Type | Description | diff --git a/docs/api/credential-eip712.icreateverifiablepresentationeip712args.keyref.md b/docs/api/credential-eip712.icreateverifiablepresentationeip712args.keyref.md index edd8c3a2..469110ed 100644 --- a/docs/api/credential-eip712.icreateverifiablepresentationeip712args.keyref.md +++ b/docs/api/credential-eip712.icreateverifiablepresentationeip712args.keyref.md @@ -8,7 +8,7 @@ hide_title: true ## ICreateVerifiablePresentationEIP712Args.keyRef property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. \[Optional\] The ID of the key that should sign this presentation. If this is not specified, the first matching key will be used. diff --git a/docs/api/credential-eip712.icreateverifiablepresentationeip712args.md b/docs/api/credential-eip712.icreateverifiablepresentationeip712args.md index 4d0770fd..aa82f4ba 100644 --- a/docs/api/credential-eip712.icreateverifiablepresentationeip712args.md +++ b/docs/api/credential-eip712.icreateverifiablepresentationeip712args.md @@ -8,7 +8,7 @@ hide_title: true ## ICreateVerifiablePresentationEIP712Args interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Encapsulates the parameters required to create a [W3C Verifiable Presentation](https://www.w3.org/TR/vc-data-model/#presentations) using the [EthereumEip712Signature2021](https://w3c-ccg.github.io/ethereum-eip712-signature-2021-spec/) proof format. @@ -17,9 +17,11 @@ This API may change without a BREAKING CHANGE notice. **Signature:** ```typescript -export interface ICreateVerifiablePresentationEIP712Args +export interface ICreateVerifiablePresentationEIP712Args extends UsingResolutionOptions ``` +**Extends:** [UsingResolutionOptions](./core-types.usingresolutionoptions.md) + ## Properties | Property | Modifiers | Type | Description | diff --git a/docs/api/credential-eip712.icreateverifiablepresentationeip712args.presentation.md b/docs/api/credential-eip712.icreateverifiablepresentationeip712args.presentation.md index ced8413c..79ac5e09 100644 --- a/docs/api/credential-eip712.icreateverifiablepresentationeip712args.presentation.md +++ b/docs/api/credential-eip712.icreateverifiablepresentationeip712args.presentation.md @@ -8,7 +8,7 @@ hide_title: true ## ICreateVerifiablePresentationEIP712Args.presentation property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The json payload of the Presentation according to the [canonical model](https://www.w3.org/TR/vc-data-model/#presentations). diff --git a/docs/api/credential-eip712.icredentialissuereip712.createverifiablecredentialeip712.md b/docs/api/credential-eip712.icredentialissuereip712.createverifiablecredentialeip712.md index a0a92335..be0bc627 100644 --- a/docs/api/credential-eip712.icredentialissuereip712.createverifiablecredentialeip712.md +++ b/docs/api/credential-eip712.icredentialissuereip712.createverifiablecredentialeip712.md @@ -8,7 +8,7 @@ hide_title: true ## ICredentialIssuerEIP712.createVerifiableCredentialEIP712() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Creates a Verifiable Credential. The payload, signer and format are chosen based on the `args` parameter. diff --git a/docs/api/credential-eip712.icredentialissuereip712.createverifiablepresentationeip712.md b/docs/api/credential-eip712.icredentialissuereip712.createverifiablepresentationeip712.md index 5cbaa4bf..66411135 100644 --- a/docs/api/credential-eip712.icredentialissuereip712.createverifiablepresentationeip712.md +++ b/docs/api/credential-eip712.icredentialissuereip712.createverifiablepresentationeip712.md @@ -8,7 +8,7 @@ hide_title: true ## ICredentialIssuerEIP712.createVerifiablePresentationEIP712() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Creates a Verifiable Presentation. The payload and signer are chosen based on the `args` parameter. diff --git a/docs/api/credential-eip712.icredentialissuereip712.md b/docs/api/credential-eip712.icredentialissuereip712.md index b9aef343..00b4c9e7 100644 --- a/docs/api/credential-eip712.icredentialissuereip712.md +++ b/docs/api/credential-eip712.icredentialissuereip712.md @@ -8,7 +8,7 @@ hide_title: true ## ICredentialIssuerEIP712 interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The interface definition for a plugin that can issue and verify Verifiable Credentials and Presentations that use EIP712 proof format. diff --git a/docs/api/credential-eip712.icredentialissuereip712.verifycredentialeip712.md b/docs/api/credential-eip712.icredentialissuereip712.verifycredentialeip712.md index 2c6dc4bc..3bd46a02 100644 --- a/docs/api/credential-eip712.icredentialissuereip712.verifycredentialeip712.md +++ b/docs/api/credential-eip712.icredentialissuereip712.verifycredentialeip712.md @@ -8,7 +8,7 @@ hide_title: true ## ICredentialIssuerEIP712.verifyCredentialEIP712() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Verifies a Verifiable Credential in EIP712 Format. diff --git a/docs/api/credential-eip712.icredentialissuereip712.verifypresentationeip712.md b/docs/api/credential-eip712.icredentialissuereip712.verifypresentationeip712.md index 26626ffb..72f4410e 100644 --- a/docs/api/credential-eip712.icredentialissuereip712.verifypresentationeip712.md +++ b/docs/api/credential-eip712.icredentialissuereip712.verifypresentationeip712.md @@ -8,7 +8,7 @@ hide_title: true ## ICredentialIssuerEIP712.verifyPresentationEIP712() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Verifies a Verifiable Presentation EIP712 Format. diff --git a/docs/api/credential-eip712.irequiredcontext.md b/docs/api/credential-eip712.irequiredcontext.md index cb56e987..27bc15aa 100644 --- a/docs/api/credential-eip712.irequiredcontext.md +++ b/docs/api/credential-eip712.irequiredcontext.md @@ -8,7 +8,7 @@ hide_title: true ## IRequiredContext type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Represents the requirements that this plugin has. The agent that is using this plugin is expected to provide these methods. diff --git a/docs/api/credential-eip712.iverifycredentialeip712args.credential.md b/docs/api/credential-eip712.iverifycredentialeip712args.credential.md index b6d7b675..b9b3fa2d 100644 --- a/docs/api/credential-eip712.iverifycredentialeip712args.credential.md +++ b/docs/api/credential-eip712.iverifycredentialeip712args.credential.md @@ -8,7 +8,7 @@ hide_title: true ## IVerifyCredentialEIP712Args.credential property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The json payload of the Credential according to the [canonical model](https://www.w3.org/TR/vc-data-model/#credentials) diff --git a/docs/api/credential-eip712.iverifycredentialeip712args.md b/docs/api/credential-eip712.iverifycredentialeip712args.md index 2b0cae2b..a8a25386 100644 --- a/docs/api/credential-eip712.iverifycredentialeip712args.md +++ b/docs/api/credential-eip712.iverifycredentialeip712args.md @@ -8,7 +8,7 @@ hide_title: true ## IVerifyCredentialEIP712Args interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Encapsulates the parameters required to verify a [W3C Verifiable Credential](https://www.w3.org/TR/vc-data-model/#credentials) @@ -17,9 +17,11 @@ This API may change without a BREAKING CHANGE notice. **Signature:** ```typescript -export interface IVerifyCredentialEIP712Args +export interface IVerifyCredentialEIP712Args extends UsingResolutionOptions ``` +**Extends:** [UsingResolutionOptions](./core-types.usingresolutionoptions.md) + ## Properties | Property | Modifiers | Type | Description | diff --git a/docs/api/credential-eip712.iverifypresentationeip712args.md b/docs/api/credential-eip712.iverifypresentationeip712args.md index d8aac203..de74029a 100644 --- a/docs/api/credential-eip712.iverifypresentationeip712args.md +++ b/docs/api/credential-eip712.iverifypresentationeip712args.md @@ -13,9 +13,11 @@ Encapsulates the parameters required to verify a [W3C Verifiable Presentation](h **Signature:** ```typescript -export interface IVerifyPresentationEIP712Args +export interface IVerifyPresentationEIP712Args extends UsingResolutionOptions ``` +**Extends:** [UsingResolutionOptions](./core-types.usingresolutionoptions.md) + ## Properties | Property | Modifiers | Type | Description | diff --git a/docs/api/credential-eip712.md b/docs/api/credential-eip712.md index dfd8af0b..4515bc8c 100644 --- a/docs/api/credential-eip712.md +++ b/docs/api/credential-eip712.md @@ -24,6 +24,12 @@ hide_title: true | [IVerifyCredentialEIP712Args](./credential-eip712.iverifycredentialeip712args.md) |

**_(BETA)_** Encapsulates the parameters required to verify a [W3C Verifiable Credential](https://www.w3.org/TR/vc-data-model/#credentials)

This API may change without a BREAKING CHANGE notice.

| | [IVerifyPresentationEIP712Args](./credential-eip712.iverifypresentationeip712args.md) | Encapsulates the parameters required to verify a [W3C Verifiable Presentation](https://www.w3.org/TR/vc-data-model/#presentations) | +## Variables + +| Variable | Description | +| --------------------------------------- | ----------- | +| [schema](./credential-eip712.schema.md) | | + ## Type Aliases | Type Alias | Description | diff --git a/docs/api/credential-eip712.schema.md b/docs/api/credential-eip712.schema.md new file mode 100644 index 00000000..9acda536 --- /dev/null +++ b/docs/api/credential-eip712.schema.md @@ -0,0 +1,399 @@ +--- +id: credential-eip712.schema +title: schema variable +hide_title: true +--- + + + +## schema variable + +**Signature:** + +```typescript +schema: { + ICredentialIssuerEIP712: { + components: { + schemas: { + ICreateVerifiableCredentialEIP712Args: { + type: string; + properties: { + resolutionOptions: { + type: string; + properties: { + publicKeyFormat: { + type: string; + }; + accept: { + type: string; + }; + }; + description: string; + }; + credential: { + $ref: string; + description: string; + }; + keyRef: { + type: string; + description: string; + }; + }; + required: string[]; + description: string; + }; + CredentialPayload: { + type: string; + properties: { + issuer: { + $ref: string; + }; + credentialSubject: { + $ref: string; + }; + type: { + type: string; + items: { + type: string; + }; + }; + "@context": { + $ref: string; + }; + issuanceDate: { + $ref: string; + }; + expirationDate: { + $ref: string; + }; + credentialStatus: { + $ref: string; + }; + id: { + type: string; + }; + }; + required: string[]; + description: string; + }; + IssuerType: { + anyOf: ({ + type: string; + properties: { + id: { + type: string; + }; + }; + required: string[]; + } | { + type: string; + properties?: undefined; + required?: undefined; + })[]; + description: string; + }; + CredentialSubject: { + type: string; + properties: { + id: { + type: string; + }; + }; + description: string; + }; + ContextType: { + anyOf: ({ + type: string; + items?: undefined; + } | { + type: string; + items: { + anyOf: { + type: string; + }[]; + }; + })[]; + description: string; + }; + DateType: { + type: string; + description: string; + }; + CredentialStatusReference: { + type: string; + properties: { + id: { + type: string; + }; + type: { + type: string; + }; + }; + required: string[]; + description: string; + }; + VerifiableCredential: { + type: string; + properties: { + proof: { + $ref: string; + }; + issuer: { + $ref: string; + }; + credentialSubject: { + $ref: string; + }; + type: { + anyOf: ({ + type: string; + items: { + type: string; + }; + } | { + type: string; + items?: undefined; + })[]; + }; + "@context": { + $ref: string; + }; + issuanceDate: { + type: string; + }; + expirationDate: { + type: string; + }; + credentialStatus: { + $ref: string; + }; + id: { + type: string; + }; + }; + required: string[]; + description: string; + }; + ProofType: { + type: string; + properties: { + type: { + type: string; + }; + }; + description: string; + }; + ICreateVerifiablePresentationEIP712Args: { + type: string; + properties: { + resolutionOptions: { + type: string; + properties: { + publicKeyFormat: { + type: string; + }; + accept: { + type: string; + }; + }; + description: string; + }; + presentation: { + $ref: string; + description: string; + }; + keyRef: { + type: string; + description: string; + }; + }; + required: string[]; + description: string; + }; + PresentationPayload: { + type: string; + properties: { + holder: { + type: string; + }; + verifiableCredential: { + type: string; + items: { + $ref: string; + }; + }; + type: { + type: string; + items: { + type: string; + }; + }; + "@context": { + $ref: string; + }; + verifier: { + type: string; + items: { + type: string; + }; + }; + issuanceDate: { + $ref: string; + }; + expirationDate: { + $ref: string; + }; + id: { + type: string; + }; + }; + required: string[]; + description: string; + }; + W3CVerifiableCredential: { + anyOf: { + $ref: string; + }[]; + description: string; + }; + CompactJWT: { + type: string; + description: string; + }; + VerifiablePresentation: { + type: string; + properties: { + proof: { + $ref: string; + }; + holder: { + type: string; + }; + verifiableCredential: { + type: string; + items: { + $ref: string; + }; + }; + type: { + anyOf: ({ + type: string; + items: { + type: string; + }; + } | { + type: string; + items?: undefined; + })[]; + }; + "@context": { + $ref: string; + }; + verifier: { + type: string; + items: { + type: string; + }; + }; + issuanceDate: { + type: string; + }; + expirationDate: { + type: string; + }; + id: { + type: string; + }; + }; + required: string[]; + description: string; + }; + IVerifyCredentialEIP712Args: { + type: string; + properties: { + resolutionOptions: { + type: string; + properties: { + publicKeyFormat: { + type: string; + }; + accept: { + type: string; + }; + }; + description: string; + }; + credential: { + $ref: string; + description: string; + }; + }; + required: string[]; + description: string; + }; + IVerifyPresentationEIP712Args: { + type: string; + properties: { + resolutionOptions: { + type: string; + properties: { + publicKeyFormat: { + type: string; + }; + accept: { + type: string; + }; + }; + description: string; + }; + presentation: { + $ref: string; + description: string; + }; + }; + required: string[]; + description: string; + }; + }; + methods: { + createVerifiableCredentialEIP712: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + $ref: string; + }; + }; + createVerifiablePresentationEIP712: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + $ref: string; + }; + }; + verifyCredentialEIP712: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + type: string; + }; + }; + verifyPresentationEIP712: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + type: string; + }; + }; + }; + }; + }; +} +``` diff --git a/docs/api/credential-ld.contextdoc.md b/docs/api/credential-ld.contextdoc.md index f2be089b..af42926c 100644 --- a/docs/api/credential-ld.contextdoc.md +++ b/docs/api/credential-ld.contextdoc.md @@ -8,7 +8,7 @@ hide_title: true ## ContextDoc type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Describes a document with a `@context` property. diff --git a/docs/api/credential-ld.credentialissuerld._constructor_.md b/docs/api/credential-ld.credentialissuerld._constructor_.md index 0d332586..69fa1c65 100644 --- a/docs/api/credential-ld.credentialissuerld._constructor_.md +++ b/docs/api/credential-ld.credentialissuerld._constructor_.md @@ -21,6 +21,6 @@ constructor(options: { ## Parameters -| Parameter | Type | Description | -| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- | -| options | { contextMaps: [RecordLike](./utils.recordlike.md)<OrPromise<[ContextDoc](./credential-ld.contextdoc.md)>>\[\]; suites: VeramoLdSignature\[\]; } | | +| Parameter | Type | Description | +| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | +| options | { contextMaps: [RecordLike](./utils.recordlike.md)<OrPromise<[ContextDoc](./credential-ld.contextdoc.md)>>\[\]; suites: [VeramoLdSignature](./credential-ld.veramoldsignature.md)\[\]; } | | diff --git a/docs/api/credential-ld.credentialissuerld.md b/docs/api/credential-ld.credentialissuerld.md index 87c73b01..6f5c144d 100644 --- a/docs/api/credential-ld.credentialissuerld.md +++ b/docs/api/credential-ld.credentialissuerld.md @@ -26,10 +26,10 @@ export declare class CredentialIssuerLD implements IAgentPlugin ## Properties -| Property | Modifiers | Type | Description | -| -------------------------------------------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | -| [methods](./credential-ld.credentialissuerld.methods.md) | readonly | [ICredentialIssuerLD](./credential-ld.icredentialissuerld.md) | | -| [schema](./credential-ld.credentialissuerld.schema.md) | readonly | { components: { schemas: { ICreateVerifiableCredentialLDArgs: { type: string; properties: { credential: { $ref: string; description: string; }; keyRef: { type: string; description: string; }; fetchRemoteContexts: { type: string; description: string; }; }; required: string\[\]; additionalProperties: { description: string; }; description: string; }; CredentialPayload: { type: string; properties: { issuer: { $ref: string; }; credentialSubject: { $ref: string; }; type: { type: string; items: { type: string; }; }; "@context": { $ref: string; }; issuanceDate: { $ref: string; }; expirationDate: { $ref: string; }; credentialStatus: { $ref: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; IssuerType: { anyOf: ({ type: string; properties: { id: { type: string; }; }; required: string\[\]; } | { type: string; properties?: undefined; required?: undefined; })\[\]; description: string; }; CredentialSubject: { type: string; properties: { id: { type: string; }; }; description: string; }; ContextType: { anyOf: ({ type: string; items?: undefined; } | { type: string; items: { anyOf: { type: string; }\[\]; }; })\[\]; description: string; }; DateType: { type: string; description: string; }; CredentialStatusReference: { type: string; properties: { id: { type: string; }; type: { type: string; }; }; required: string\[\]; description: string; }; VerifiableCredential: { type: string; properties: { proof: { $ref: string; }; issuer: { $ref: string; }; credentialSubject: { $ref: string; }; type: { anyOf: ({ type: string; items: { type: string; }; } | { type: string; items?: undefined; })\[\]; }; "@context": { $ref: string; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; credentialStatus: { $ref: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; ProofType: { type: string; properties: { type: { type: string; }; }; description: string; }; ICreateVerifiablePresentationLDArgs: { type: string; properties: { presentation: { $ref: string; description: string; }; challenge: { type: string; description: string; }; domain: { type: string; description: string; }; keyRef: { type: string; description: string; }; fetchRemoteContexts: { type: string; description: string; }; }; required: string\[\]; additionalProperties: { description: string; }; description: string; }; PresentationPayload: { type: string; properties: { holder: { type: string; }; verifiableCredential: { type: string; items: { $ref: string; }; }; type: { type: string; items: { type: string; }; }; "@context": { $ref: string; }; verifier: { type: string; items: { type: string; }; }; issuanceDate: { $ref: string; }; expirationDate: { $ref: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; W3CVerifiableCredential: { anyOf: { $ref: string; }\[\]; description: string; }; CompactJWT: { type: string; description: string; }; VerifiablePresentation: { type: string; properties: { proof: { $ref: string; }; holder: { type: string; }; verifiableCredential: { type: string; items: { $ref: string; }; }; type: { anyOf: ({ type: string; items: { type: string; }; } | { type: string; items?: undefined; })\[\]; }; "@context": { $ref: string; }; verifier: { type: string; items: { type: string; }; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; IVerifyCredentialLDArgs: { type: string; properties: { credential: { $ref: string; description: string; }; fetchRemoteContexts: { type: string; description: string; }; }; required: string\[\]; additionalProperties: { description: string; }; description: string; }; IVerifyPresentationLDArgs: { type: string; properties: { presentation: { $ref: string; description: string; }; challenge: { type: string; description: string; }; domain: { type: string; description: string; }; fetchRemoteContexts: { type: string; description: string; }; }; required: string\[\]; additionalProperties: { description: string; }; description: string; }; }; methods: { createVerifiableCredentialLD: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; createVerifiablePresentationLD: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; verifyCredentialLD: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; verifyPresentationLD: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; }; }; } | | +| Property | Modifiers | Type | Description | +| -------------------------------------------------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | +| [methods](./credential-ld.credentialissuerld.methods.md) | readonly | [ICredentialIssuerLD](./credential-ld.icredentialissuerld.md) | | +| [schema](./credential-ld.credentialissuerld.schema.md) | readonly | { components: { schemas: { ICreateVerifiableCredentialLDArgs: { type: string; properties: { resolutionOptions: { type: string; properties: { publicKeyFormat: { type: string; }; accept: { type: string; }; }; description: string; }; credential: { $ref: string; description: string; }; keyRef: { type: string; description: string; }; fetchRemoteContexts: { type: string; description: string; }; }; required: string\[\]; additionalProperties: { description: string; }; description: string; }; CredentialPayload: { type: string; properties: { issuer: { $ref: string; }; credentialSubject: { $ref: string; }; type: { type: string; items: { type: string; }; }; "@context": { $ref: string; }; issuanceDate: { $ref: string; }; expirationDate: { $ref: string; }; credentialStatus: { $ref: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; IssuerType: { anyOf: ({ type: string; properties: { id: { type: string; }; }; required: string\[\]; } | { type: string; properties?: undefined; required?: undefined; })\[\]; description: string; }; CredentialSubject: { type: string; properties: { id: { type: string; }; }; description: string; }; ContextType: { anyOf: ({ type: string; items?: undefined; } | { type: string; items: { anyOf: { type: string; }\[\]; }; })\[\]; description: string; }; DateType: { type: string; description: string; }; CredentialStatusReference: { type: string; properties: { id: { type: string; }; type: { type: string; }; }; required: string\[\]; description: string; }; VerifiableCredential: { type: string; properties: { proof: { $ref: string; }; issuer: { $ref: string; }; credentialSubject: { $ref: string; }; type: { anyOf: ({ type: string; items: { type: string; }; } | { type: string; items?: undefined; })\[\]; }; "@context": { $ref: string; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; credentialStatus: { $ref: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; ProofType: { type: string; properties: { type: { type: string; }; }; description: string; }; ICreateVerifiablePresentationLDArgs: { type: string; properties: { resolutionOptions: { type: string; properties: { publicKeyFormat: { type: string; }; accept: { type: string; }; }; description: string; }; presentation: { $ref: string; description: string; }; challenge: { type: string; description: string; }; domain: { type: string; description: string; }; keyRef: { type: string; description: string; }; fetchRemoteContexts: { type: string; description: string; }; }; required: string\[\]; additionalProperties: { description: string; }; description: string; }; PresentationPayload: { type: string; properties: { holder: { type: string; }; verifiableCredential: { type: string; items: { $ref: string; }; }; type: { type: string; items: { type: string; }; }; "@context": { $ref: string; }; verifier: { type: string; items: { type: string; }; }; issuanceDate: { $ref: string; }; expirationDate: { $ref: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; W3CVerifiableCredential: { anyOf: { $ref: string; }\[\]; description: string; }; CompactJWT: { type: string; description: string; }; VerifiablePresentation: { type: string; properties: { proof: { $ref: string; }; holder: { type: string; }; verifiableCredential: { type: string; items: { $ref: string; }; }; type: { anyOf: ({ type: string; items: { type: string; }; } | { type: string; items?: undefined; })\[\]; }; "@context": { $ref: string; }; verifier: { type: string; items: { type: string; }; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; IVerifyCredentialLDArgs: { type: string; properties: { resolutionOptions: { type: string; properties: { publicKeyFormat: { type: string; }; accept: { type: string; }; }; description: string; }; credential: { $ref: string; description: string; }; fetchRemoteContexts: { type: string; description: string; }; }; required: string\[\]; additionalProperties: { description: string; }; description: string; }; IVerifyPresentationLDArgs: { type: string; properties: { resolutionOptions: { type: string; properties: { publicKeyFormat: { type: string; }; accept: { type: string; }; }; description: string; }; presentation: { $ref: string; description: string; }; challenge: { type: string; description: string; }; domain: { type: string; description: string; }; fetchRemoteContexts: { type: string; description: string; }; }; required: string\[\]; additionalProperties: { description: string; }; description: string; }; }; methods: { createVerifiableCredentialLD: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; createVerifiablePresentationLD: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; verifyCredentialLD: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; verifyPresentationLD: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; }; }; } | | ## Methods diff --git a/docs/api/credential-ld.credentialissuerld.schema.md b/docs/api/credential-ld.credentialissuerld.schema.md index 1270a1a2..dc1a9c0e 100644 --- a/docs/api/credential-ld.credentialissuerld.schema.md +++ b/docs/api/credential-ld.credentialissuerld.schema.md @@ -17,6 +17,18 @@ readonly schema: { ICreateVerifiableCredentialLDArgs: { type: string; properties: { + resolutionOptions: { + type: string; + properties: { + publicKeyFormat: { + type: string; + }; + accept: { + type: string; + }; + }; + description: string; + }; credential: { $ref: string; description: string; @@ -180,6 +192,18 @@ readonly schema: { ICreateVerifiablePresentationLDArgs: { type: string; properties: { + resolutionOptions: { + type: string; + properties: { + publicKeyFormat: { + type: string; + }; + accept: { + type: string; + }; + }; + description: string; + }; presentation: { $ref: string; description: string; @@ -308,6 +332,18 @@ readonly schema: { IVerifyCredentialLDArgs: { type: string; properties: { + resolutionOptions: { + type: string; + properties: { + publicKeyFormat: { + type: string; + }; + accept: { + type: string; + }; + }; + description: string; + }; credential: { $ref: string; description: string; @@ -326,6 +362,18 @@ readonly schema: { IVerifyPresentationLDArgs: { type: string; properties: { + resolutionOptions: { + type: string; + properties: { + publicKeyFormat: { + type: string; + }; + accept: { + type: string; + }; + }; + description: string; + }; presentation: { $ref: string; description: string; diff --git a/docs/api/credential-ld.icreateverifiablecredentialldargs.credential.md b/docs/api/credential-ld.icreateverifiablecredentialldargs.credential.md index 9065dbd2..c63091e4 100644 --- a/docs/api/credential-ld.icreateverifiablecredentialldargs.credential.md +++ b/docs/api/credential-ld.icreateverifiablecredentialldargs.credential.md @@ -8,7 +8,7 @@ hide_title: true ## ICreateVerifiableCredentialLDArgs.credential property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The json payload of the Credential according to the [canonical model](https://www.w3.org/TR/vc-data-model/#credentials) diff --git a/docs/api/credential-ld.icreateverifiablecredentialldargs.fetchremotecontexts.md b/docs/api/credential-ld.icreateverifiablecredentialldargs.fetchremotecontexts.md index 36dec1f3..ba1a689e 100644 --- a/docs/api/credential-ld.icreateverifiablecredentialldargs.fetchremotecontexts.md +++ b/docs/api/credential-ld.icreateverifiablecredentialldargs.fetchremotecontexts.md @@ -8,7 +8,7 @@ hide_title: true ## ICreateVerifiableCredentialLDArgs.fetchRemoteContexts property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Set this to true if you want the `@context` URLs to be fetched in case they are not preloaded. diff --git a/docs/api/credential-ld.icreateverifiablecredentialldargs.keyref.md b/docs/api/credential-ld.icreateverifiablecredentialldargs.keyref.md index 22bb0e7a..8059ede5 100644 --- a/docs/api/credential-ld.icreateverifiablecredentialldargs.keyref.md +++ b/docs/api/credential-ld.icreateverifiablecredentialldargs.keyref.md @@ -8,7 +8,7 @@ hide_title: true ## ICreateVerifiableCredentialLDArgs.keyRef property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Optional. The key handle ([IKey.kid](./core-types.ikey.kid.md)) from the internal database. diff --git a/docs/api/credential-ld.icreateverifiablecredentialldargs.md b/docs/api/credential-ld.icreateverifiablecredentialldargs.md index e8e894cb..7062d9e9 100644 --- a/docs/api/credential-ld.icreateverifiablecredentialldargs.md +++ b/docs/api/credential-ld.icreateverifiablecredentialldargs.md @@ -8,7 +8,7 @@ hide_title: true ## ICreateVerifiableCredentialLDArgs interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Encapsulates the parameters required to create a [W3C Verifiable Credential](https://www.w3.org/TR/vc-data-model/#credentials) @@ -17,9 +17,11 @@ This API may change without a BREAKING CHANGE notice. **Signature:** ```typescript -export interface ICreateVerifiableCredentialLDArgs +export interface ICreateVerifiableCredentialLDArgs extends UsingResolutionOptions ``` +**Extends:** [UsingResolutionOptions](./core-types.usingresolutionoptions.md) + ## Properties | Property | Modifiers | Type | Description | diff --git a/docs/api/credential-ld.icreateverifiablepresentationldargs.challenge.md b/docs/api/credential-ld.icreateverifiablepresentationldargs.challenge.md index c9e741f0..6a61b6db 100644 --- a/docs/api/credential-ld.icreateverifiablepresentationldargs.challenge.md +++ b/docs/api/credential-ld.icreateverifiablepresentationldargs.challenge.md @@ -8,7 +8,7 @@ hide_title: true ## ICreateVerifiablePresentationLDArgs.challenge property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Optional (only JWT) string challenge parameter to add to the verifiable presentation. diff --git a/docs/api/credential-ld.icreateverifiablepresentationldargs.domain.md b/docs/api/credential-ld.icreateverifiablepresentationldargs.domain.md index 0294bfcc..aa348228 100644 --- a/docs/api/credential-ld.icreateverifiablepresentationldargs.domain.md +++ b/docs/api/credential-ld.icreateverifiablepresentationldargs.domain.md @@ -8,7 +8,7 @@ hide_title: true ## ICreateVerifiablePresentationLDArgs.domain property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Optional string domain parameter to add to the verifiable presentation. diff --git a/docs/api/credential-ld.icreateverifiablepresentationldargs.fetchremotecontexts.md b/docs/api/credential-ld.icreateverifiablepresentationldargs.fetchremotecontexts.md index 10677b70..8a831e00 100644 --- a/docs/api/credential-ld.icreateverifiablepresentationldargs.fetchremotecontexts.md +++ b/docs/api/credential-ld.icreateverifiablepresentationldargs.fetchremotecontexts.md @@ -8,7 +8,7 @@ hide_title: true ## ICreateVerifiablePresentationLDArgs.fetchRemoteContexts property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Set this to true if you want the `@context` URLs to be fetched in case they are not preloaded. diff --git a/docs/api/credential-ld.icreateverifiablepresentationldargs.keyref.md b/docs/api/credential-ld.icreateverifiablepresentationldargs.keyref.md index baa26866..50e8cc35 100644 --- a/docs/api/credential-ld.icreateverifiablepresentationldargs.keyref.md +++ b/docs/api/credential-ld.icreateverifiablepresentationldargs.keyref.md @@ -8,7 +8,7 @@ hide_title: true ## ICreateVerifiablePresentationLDArgs.keyRef property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Optional. The key handle ([IKey.kid](./core-types.ikey.kid.md)) from the internal database. diff --git a/docs/api/credential-ld.icreateverifiablepresentationldargs.md b/docs/api/credential-ld.icreateverifiablepresentationldargs.md index 0f3cf0db..ae313351 100644 --- a/docs/api/credential-ld.icreateverifiablepresentationldargs.md +++ b/docs/api/credential-ld.icreateverifiablepresentationldargs.md @@ -8,7 +8,7 @@ hide_title: true ## ICreateVerifiablePresentationLDArgs interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Encapsulates the parameters required to create a [W3C Verifiable Presentation](https://www.w3.org/TR/vc-data-model/#presentations) @@ -17,9 +17,11 @@ This API may change without a BREAKING CHANGE notice. **Signature:** ```typescript -export interface ICreateVerifiablePresentationLDArgs +export interface ICreateVerifiablePresentationLDArgs extends UsingResolutionOptions ``` +**Extends:** [UsingResolutionOptions](./core-types.usingresolutionoptions.md) + ## Properties | Property | Modifiers | Type | Description | diff --git a/docs/api/credential-ld.icreateverifiablepresentationldargs.presentation.md b/docs/api/credential-ld.icreateverifiablepresentationldargs.presentation.md index a8702475..b7f92f2e 100644 --- a/docs/api/credential-ld.icreateverifiablepresentationldargs.presentation.md +++ b/docs/api/credential-ld.icreateverifiablepresentationldargs.presentation.md @@ -8,7 +8,7 @@ hide_title: true ## ICreateVerifiablePresentationLDArgs.presentation property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The json payload of the Presentation according to the [canonical model](https://www.w3.org/TR/vc-data-model/#presentations). diff --git a/docs/api/credential-ld.icredentialissuerld.createverifiablecredentialld.md b/docs/api/credential-ld.icredentialissuerld.createverifiablecredentialld.md index 46d4fa74..9cc8e335 100644 --- a/docs/api/credential-ld.icredentialissuerld.createverifiablecredentialld.md +++ b/docs/api/credential-ld.icredentialissuerld.createverifiablecredentialld.md @@ -8,7 +8,7 @@ hide_title: true ## ICredentialIssuerLD.createVerifiableCredentialLD() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Creates a Verifiable Credential. The payload, signer and format are chosen based on the `args` parameter. diff --git a/docs/api/credential-ld.icredentialissuerld.createverifiablepresentationld.md b/docs/api/credential-ld.icredentialissuerld.createverifiablepresentationld.md index 08a2be4b..2a0c18a1 100644 --- a/docs/api/credential-ld.icredentialissuerld.createverifiablepresentationld.md +++ b/docs/api/credential-ld.icredentialissuerld.createverifiablepresentationld.md @@ -8,7 +8,7 @@ hide_title: true ## ICredentialIssuerLD.createVerifiablePresentationLD() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Creates a Verifiable Presentation. The payload, signer and format are chosen based on the `args` parameter. diff --git a/docs/api/credential-ld.icredentialissuerld.md b/docs/api/credential-ld.icredentialissuerld.md index 28b8fb6b..45b53bab 100644 --- a/docs/api/credential-ld.icredentialissuerld.md +++ b/docs/api/credential-ld.icredentialissuerld.md @@ -8,7 +8,7 @@ hide_title: true ## ICredentialIssuerLD interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The interface definition for a plugin that can issue and verify Verifiable Credentials and Presentations that use JSON-LD format (also called Data Integrity Proofs). diff --git a/docs/api/credential-ld.icredentialissuerld.verifycredentialld.md b/docs/api/credential-ld.icredentialissuerld.verifycredentialld.md index eccb06f1..614fdbcf 100644 --- a/docs/api/credential-ld.icredentialissuerld.verifycredentialld.md +++ b/docs/api/credential-ld.icredentialissuerld.verifycredentialld.md @@ -8,7 +8,7 @@ hide_title: true ## ICredentialIssuerLD.verifyCredentialLD() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Verifies a Verifiable Credential JWT or LDS Format. diff --git a/docs/api/credential-ld.icredentialissuerld.verifypresentationld.md b/docs/api/credential-ld.icredentialissuerld.verifypresentationld.md index 187be8c1..48875f4e 100644 --- a/docs/api/credential-ld.icredentialissuerld.verifypresentationld.md +++ b/docs/api/credential-ld.icredentialissuerld.verifypresentationld.md @@ -8,7 +8,7 @@ hide_title: true ## ICredentialIssuerLD.verifyPresentationLD() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Verifies a Verifiable Presentation JWT or LDS Format. diff --git a/docs/api/credential-ld.irequiredcontext.md b/docs/api/credential-ld.irequiredcontext.md index faa2b670..c933ae5a 100644 --- a/docs/api/credential-ld.irequiredcontext.md +++ b/docs/api/credential-ld.irequiredcontext.md @@ -8,7 +8,7 @@ hide_title: true ## IRequiredContext type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Represents the requirements that this plugin has. The agent that is using this plugin is expected to provide these methods. diff --git a/docs/api/credential-ld.iverifycredentialldargs.credential.md b/docs/api/credential-ld.iverifycredentialldargs.credential.md index ce44ebf4..527f0aee 100644 --- a/docs/api/credential-ld.iverifycredentialldargs.credential.md +++ b/docs/api/credential-ld.iverifycredentialldargs.credential.md @@ -8,7 +8,7 @@ hide_title: true ## IVerifyCredentialLDArgs.credential property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The json payload of the Credential according to the [canonical model](https://www.w3.org/TR/vc-data-model/#credentials) diff --git a/docs/api/credential-ld.iverifycredentialldargs.fetchremotecontexts.md b/docs/api/credential-ld.iverifycredentialldargs.fetchremotecontexts.md index 3b24a746..bf0e21c0 100644 --- a/docs/api/credential-ld.iverifycredentialldargs.fetchremotecontexts.md +++ b/docs/api/credential-ld.iverifycredentialldargs.fetchremotecontexts.md @@ -8,7 +8,7 @@ hide_title: true ## IVerifyCredentialLDArgs.fetchRemoteContexts property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Set this to true if you want the `@context` URLs to be fetched in case they are not preloaded. diff --git a/docs/api/credential-ld.iverifycredentialldargs.md b/docs/api/credential-ld.iverifycredentialldargs.md index 527b1400..0376312a 100644 --- a/docs/api/credential-ld.iverifycredentialldargs.md +++ b/docs/api/credential-ld.iverifycredentialldargs.md @@ -8,7 +8,7 @@ hide_title: true ## IVerifyCredentialLDArgs interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Encapsulates the parameters required to verify a [W3C Verifiable Credential](https://www.w3.org/TR/vc-data-model/#credentials) @@ -17,9 +17,11 @@ This API may change without a BREAKING CHANGE notice **Signature:** ```typescript -export interface IVerifyCredentialLDArgs +export interface IVerifyCredentialLDArgs extends UsingResolutionOptions ``` +**Extends:** [UsingResolutionOptions](./core-types.usingresolutionoptions.md) + ## Properties | Property | Modifiers | Type | Description | diff --git a/docs/api/credential-ld.iverifypresentationldargs.challenge.md b/docs/api/credential-ld.iverifypresentationldargs.challenge.md index 7ea4443a..b671ec63 100644 --- a/docs/api/credential-ld.iverifypresentationldargs.challenge.md +++ b/docs/api/credential-ld.iverifypresentationldargs.challenge.md @@ -8,7 +8,7 @@ hide_title: true ## IVerifyPresentationLDArgs.challenge property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Optional (only for JWT) string challenge parameter to verify the verifiable presentation against diff --git a/docs/api/credential-ld.iverifypresentationldargs.domain.md b/docs/api/credential-ld.iverifypresentationldargs.domain.md index 9272c7bc..e8d24897 100644 --- a/docs/api/credential-ld.iverifypresentationldargs.domain.md +++ b/docs/api/credential-ld.iverifypresentationldargs.domain.md @@ -8,7 +8,7 @@ hide_title: true ## IVerifyPresentationLDArgs.domain property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Optional (only for JWT) string domain parameter to verify the verifiable presentation against diff --git a/docs/api/credential-ld.iverifypresentationldargs.fetchremotecontexts.md b/docs/api/credential-ld.iverifypresentationldargs.fetchremotecontexts.md index 6ecfae41..c9fa4958 100644 --- a/docs/api/credential-ld.iverifypresentationldargs.fetchremotecontexts.md +++ b/docs/api/credential-ld.iverifypresentationldargs.fetchremotecontexts.md @@ -8,7 +8,7 @@ hide_title: true ## IVerifyPresentationLDArgs.fetchRemoteContexts property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Set this to true if you want the `@context` URLs to be fetched in case they are not preloaded. diff --git a/docs/api/credential-ld.iverifypresentationldargs.md b/docs/api/credential-ld.iverifypresentationldargs.md index f1a0ae07..b417c73f 100644 --- a/docs/api/credential-ld.iverifypresentationldargs.md +++ b/docs/api/credential-ld.iverifypresentationldargs.md @@ -8,7 +8,7 @@ hide_title: true ## IVerifyPresentationLDArgs interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Encapsulates the parameters required to verify a [W3C Verifiable Presentation](https://www.w3.org/TR/vc-data-model/#presentations) @@ -17,9 +17,11 @@ This API may change without a BREAKING CHANGE notice. **Signature:** ```typescript -export interface IVerifyPresentationLDArgs +export interface IVerifyPresentationLDArgs extends UsingResolutionOptions ``` +**Extends:** [UsingResolutionOptions](./core-types.usingresolutionoptions.md) + ## Properties | Property | Modifiers | Type | Description | diff --git a/docs/api/credential-ld.iverifypresentationldargs.presentation.md b/docs/api/credential-ld.iverifypresentationldargs.presentation.md index 90c12b9d..b3bd0393 100644 --- a/docs/api/credential-ld.iverifypresentationldargs.presentation.md +++ b/docs/api/credential-ld.iverifypresentationldargs.presentation.md @@ -8,7 +8,7 @@ hide_title: true ## IVerifyPresentationLDArgs.presentation property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The json payload of the Credential according to the [canonical model](https://www.w3.org/TR/vc-data-model/#credentials) diff --git a/docs/api/credential-ld.lddefaultcontexts.md b/docs/api/credential-ld.lddefaultcontexts.md index e1f1c586..9b7f9ad2 100644 --- a/docs/api/credential-ld.lddefaultcontexts.md +++ b/docs/api/credential-ld.lddefaultcontexts.md @@ -8,7 +8,7 @@ hide_title: true ## LdDefaultContexts variable -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Provides a hardcoded map of common Linked Data `@context` definitions. diff --git a/docs/api/credential-ld.md b/docs/api/credential-ld.md index 3a72d49e..1c644d12 100644 --- a/docs/api/credential-ld.md +++ b/docs/api/credential-ld.md @@ -14,9 +14,19 @@ This plugin adds support for working with JSON-LD credentials. When installed, t ## Classes -| Class | Description | -| ----------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| [CredentialIssuerLD](./credential-ld.credentialissuerld.md) | A Veramo plugin that implements the [ICredentialIssuerLD](./credential-ld.icredentialissuerld.md) methods. | +| Class | Description | +| --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [CredentialIssuerLD](./credential-ld.credentialissuerld.md) | A Veramo plugin that implements the [ICredentialIssuerLD](./credential-ld.icredentialissuerld.md) methods. | +| [VeramoEcdsaSecp256k1RecoverySignature2020](./credential-ld.veramoecdsasecp256k1recoverysignature2020.md) |

**_(ALPHA)_** Veramo wrapper for the EcdsaSecp256k1RecoverySignature2020 suite by Transmute Industries

This API is experimental and is very likely to change or disappear in future releases without notice.

| +| [VeramoEd25519Signature2018](./credential-ld.veramoed25519signature2018.md) |

**_(ALPHA)_** Veramo wrapper for the Ed25519Signature2018 suite by Transmute Industries

This API is experimental and is very likely to change or disappear in future releases without notice.

| +| [VeramoEd25519Signature2020](./credential-ld.veramoed25519signature2020.md) |

**_(ALPHA)_** Veramo wrapper for the Ed25519Signature2020 suite by digitalcredentials

This API is experimental and is very likely to change or disappear in future releases without notice.

| +| [VeramoJsonWebSignature2020](./credential-ld.veramojsonwebsignature2020.md) |

**_(ALPHA)_** Veramo wrapper for the JsonWebSignature2020 suite by Transmute Industries

This API is experimental and is very likely to change or disappear in future releases without notice.

| + +## Abstract Classes + +| Abstract Class | Description | +| --------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [VeramoLdSignature](./credential-ld.veramoldsignature.md) |

**_(ALPHA)_** Base class for Veramo adapters of LinkedDataSignature suites.

This API is experimental and is very likely to change or disappear in future releases without notice.

| ## Interfaces @@ -33,6 +43,7 @@ This plugin adds support for working with JSON-LD credentials. When installed, t | Variable | Description | | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | [LdDefaultContexts](./credential-ld.lddefaultcontexts.md) |

**_(BETA)_** Provides a hardcoded map of common Linked Data @context definitions.

You can use this to bootstrap the @context definitions used by [CredentialIssuerLD](./credential-ld.credentialissuerld.md) with these common context definitions.

This API may change without a BREAKING CHANGE notice.

| +| [schema](./credential-ld.schema.md) | | ## Type Aliases diff --git a/docs/api/credential-ld.schema.md b/docs/api/credential-ld.schema.md new file mode 100644 index 00000000..2eefa866 --- /dev/null +++ b/docs/api/credential-ld.schema.md @@ -0,0 +1,443 @@ +--- +id: credential-ld.schema +title: schema variable +hide_title: true +--- + + + +## schema variable + +**Signature:** + +```typescript +schema: { + ICredentialIssuerLD: { + components: { + schemas: { + ICreateVerifiableCredentialLDArgs: { + type: string; + properties: { + resolutionOptions: { + type: string; + properties: { + publicKeyFormat: { + type: string; + }; + accept: { + type: string; + }; + }; + description: string; + }; + credential: { + $ref: string; + description: string; + }; + keyRef: { + type: string; + description: string; + }; + fetchRemoteContexts: { + type: string; + description: string; + }; + }; + required: string[]; + additionalProperties: { + description: string; + }; + description: string; + }; + CredentialPayload: { + type: string; + properties: { + issuer: { + $ref: string; + }; + credentialSubject: { + $ref: string; + }; + type: { + type: string; + items: { + type: string; + }; + }; + "@context": { + $ref: string; + }; + issuanceDate: { + $ref: string; + }; + expirationDate: { + $ref: string; + }; + credentialStatus: { + $ref: string; + }; + id: { + type: string; + }; + }; + required: string[]; + description: string; + }; + IssuerType: { + anyOf: ({ + type: string; + properties: { + id: { + type: string; + }; + }; + required: string[]; + } | { + type: string; + properties?: undefined; + required?: undefined; + })[]; + description: string; + }; + CredentialSubject: { + type: string; + properties: { + id: { + type: string; + }; + }; + description: string; + }; + ContextType: { + anyOf: ({ + type: string; + items?: undefined; + } | { + type: string; + items: { + anyOf: { + type: string; + }[]; + }; + })[]; + description: string; + }; + DateType: { + type: string; + description: string; + }; + CredentialStatusReference: { + type: string; + properties: { + id: { + type: string; + }; + type: { + type: string; + }; + }; + required: string[]; + description: string; + }; + VerifiableCredential: { + type: string; + properties: { + proof: { + $ref: string; + }; + issuer: { + $ref: string; + }; + credentialSubject: { + $ref: string; + }; + type: { + anyOf: ({ + type: string; + items: { + type: string; + }; + } | { + type: string; + items?: undefined; + })[]; + }; + "@context": { + $ref: string; + }; + issuanceDate: { + type: string; + }; + expirationDate: { + type: string; + }; + credentialStatus: { + $ref: string; + }; + id: { + type: string; + }; + }; + required: string[]; + description: string; + }; + ProofType: { + type: string; + properties: { + type: { + type: string; + }; + }; + description: string; + }; + ICreateVerifiablePresentationLDArgs: { + type: string; + properties: { + resolutionOptions: { + type: string; + properties: { + publicKeyFormat: { + type: string; + }; + accept: { + type: string; + }; + }; + description: string; + }; + presentation: { + $ref: string; + description: string; + }; + challenge: { + type: string; + description: string; + }; + domain: { + type: string; + description: string; + }; + keyRef: { + type: string; + description: string; + }; + fetchRemoteContexts: { + type: string; + description: string; + }; + }; + required: string[]; + additionalProperties: { + description: string; + }; + description: string; + }; + PresentationPayload: { + type: string; + properties: { + holder: { + type: string; + }; + verifiableCredential: { + type: string; + items: { + $ref: string; + }; + }; + type: { + type: string; + items: { + type: string; + }; + }; + "@context": { + $ref: string; + }; + verifier: { + type: string; + items: { + type: string; + }; + }; + issuanceDate: { + $ref: string; + }; + expirationDate: { + $ref: string; + }; + id: { + type: string; + }; + }; + required: string[]; + description: string; + }; + W3CVerifiableCredential: { + anyOf: { + $ref: string; + }[]; + description: string; + }; + CompactJWT: { + type: string; + description: string; + }; + VerifiablePresentation: { + type: string; + properties: { + proof: { + $ref: string; + }; + holder: { + type: string; + }; + verifiableCredential: { + type: string; + items: { + $ref: string; + }; + }; + type: { + anyOf: ({ + type: string; + items: { + type: string; + }; + } | { + type: string; + items?: undefined; + })[]; + }; + "@context": { + $ref: string; + }; + verifier: { + type: string; + items: { + type: string; + }; + }; + issuanceDate: { + type: string; + }; + expirationDate: { + type: string; + }; + id: { + type: string; + }; + }; + required: string[]; + description: string; + }; + IVerifyCredentialLDArgs: { + type: string; + properties: { + resolutionOptions: { + type: string; + properties: { + publicKeyFormat: { + type: string; + }; + accept: { + type: string; + }; + }; + description: string; + }; + credential: { + $ref: string; + description: string; + }; + fetchRemoteContexts: { + type: string; + description: string; + }; + }; + required: string[]; + additionalProperties: { + description: string; + }; + description: string; + }; + IVerifyPresentationLDArgs: { + type: string; + properties: { + resolutionOptions: { + type: string; + properties: { + publicKeyFormat: { + type: string; + }; + accept: { + type: string; + }; + }; + description: string; + }; + presentation: { + $ref: string; + description: string; + }; + challenge: { + type: string; + description: string; + }; + domain: { + type: string; + description: string; + }; + fetchRemoteContexts: { + type: string; + description: string; + }; + }; + required: string[]; + additionalProperties: { + description: string; + }; + description: string; + }; + }; + methods: { + createVerifiableCredentialLD: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + $ref: string; + }; + }; + createVerifiablePresentationLD: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + $ref: string; + }; + }; + verifyCredentialLD: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + type: string; + }; + }; + verifyPresentationLD: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + type: string; + }; + }; + }; + }; + }; +} +``` diff --git a/docs/api/credential-ld.veramoecdsasecp256k1recoverysignature2020.md b/docs/api/credential-ld.veramoecdsasecp256k1recoverysignature2020.md new file mode 100644 index 00000000..85a68ca5 --- /dev/null +++ b/docs/api/credential-ld.veramoecdsasecp256k1recoverysignature2020.md @@ -0,0 +1,23 @@ +--- +id: credential-ld.veramoecdsasecp256k1recoverysignature2020 +title: VeramoEcdsaSecp256k1RecoverySignature2020 class +hide_title: true +--- + + + +## VeramoEcdsaSecp256k1RecoverySignature2020 class + +> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. + +Veramo wrapper for the EcdsaSecp256k1RecoverySignature2020 suite by Transmute Industries + +This API is experimental and is very likely to change or disappear in future releases without notice. + +**Signature:** + +```typescript +export declare class VeramoEcdsaSecp256k1RecoverySignature2020 extends VeramoLdSignature +``` + +**Extends:** [VeramoLdSignature](./credential-ld.veramoldsignature.md) diff --git a/docs/api/credential-ld.veramoed25519signature2018.md b/docs/api/credential-ld.veramoed25519signature2018.md new file mode 100644 index 00000000..2b0676f8 --- /dev/null +++ b/docs/api/credential-ld.veramoed25519signature2018.md @@ -0,0 +1,23 @@ +--- +id: credential-ld.veramoed25519signature2018 +title: VeramoEd25519Signature2018 class +hide_title: true +--- + + + +## VeramoEd25519Signature2018 class + +> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. + +Veramo wrapper for the Ed25519Signature2018 suite by Transmute Industries + +This API is experimental and is very likely to change or disappear in future releases without notice. + +**Signature:** + +```typescript +export declare class VeramoEd25519Signature2018 extends VeramoLdSignature +``` + +**Extends:** [VeramoLdSignature](./credential-ld.veramoldsignature.md) diff --git a/docs/api/credential-ld.veramoed25519signature2020.md b/docs/api/credential-ld.veramoed25519signature2020.md new file mode 100644 index 00000000..9fdb151a --- /dev/null +++ b/docs/api/credential-ld.veramoed25519signature2020.md @@ -0,0 +1,23 @@ +--- +id: credential-ld.veramoed25519signature2020 +title: VeramoEd25519Signature2020 class +hide_title: true +--- + + + +## VeramoEd25519Signature2020 class + +> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. + +Veramo wrapper for the Ed25519Signature2020 suite by digitalcredentials + +This API is experimental and is very likely to change or disappear in future releases without notice. + +**Signature:** + +```typescript +export declare class VeramoEd25519Signature2020 extends VeramoLdSignature +``` + +**Extends:** [VeramoLdSignature](./credential-ld.veramoldsignature.md) diff --git a/docs/api/credential-ld.veramojsonwebsignature2020.md b/docs/api/credential-ld.veramojsonwebsignature2020.md new file mode 100644 index 00000000..afa4007d --- /dev/null +++ b/docs/api/credential-ld.veramojsonwebsignature2020.md @@ -0,0 +1,23 @@ +--- +id: credential-ld.veramojsonwebsignature2020 +title: VeramoJsonWebSignature2020 class +hide_title: true +--- + + + +## VeramoJsonWebSignature2020 class + +> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. + +Veramo wrapper for the JsonWebSignature2020 suite by Transmute Industries + +This API is experimental and is very likely to change or disappear in future releases without notice. + +**Signature:** + +```typescript +export declare class VeramoJsonWebSignature2020 extends VeramoLdSignature +``` + +**Extends:** [VeramoLdSignature](./credential-ld.veramoldsignature.md) diff --git a/docs/api/credential-ld.veramoldsignature.md b/docs/api/credential-ld.veramoldsignature.md new file mode 100644 index 00000000..a16dea30 --- /dev/null +++ b/docs/api/credential-ld.veramoldsignature.md @@ -0,0 +1,21 @@ +--- +id: credential-ld.veramoldsignature +title: VeramoLdSignature class +hide_title: true +--- + + + +## VeramoLdSignature class + +> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. + +Base class for Veramo adapters of LinkedDataSignature suites. + +This API is experimental and is very likely to change or disappear in future releases without notice. + +**Signature:** + +```typescript +export declare abstract class VeramoLdSignature +``` diff --git a/docs/api/credential-status.credentialstatusplugin._constructor_.md b/docs/api/credential-status.credentialstatusplugin._constructor_.md index ddfcd3cd..dfbeae70 100644 --- a/docs/api/credential-status.credentialstatusplugin._constructor_.md +++ b/docs/api/credential-status.credentialstatusplugin._constructor_.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialStatusPlugin.(constructor) -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Constructs a new instance of the `CredentialStatusPlugin` class diff --git a/docs/api/credential-status.credentialstatusplugin.md b/docs/api/credential-status.credentialstatusplugin.md index 23f319c6..66bd92e7 100644 --- a/docs/api/credential-status.credentialstatusplugin.md +++ b/docs/api/credential-status.credentialstatusplugin.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialStatusPlugin class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This plugin implements the [ICredentialStatusVerifier](./core-types.icredentialstatusverifier.md) interface. diff --git a/docs/api/credential-status.credentialstatusplugin.methods.md b/docs/api/credential-status.credentialstatusplugin.methods.md index 062e86f0..724c54e9 100644 --- a/docs/api/credential-status.credentialstatusplugin.methods.md +++ b/docs/api/credential-status.credentialstatusplugin.methods.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialStatusPlugin.methods property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/credential-w3c.credentialplugin.matchkeyforjwt.md b/docs/api/credential-w3c.credentialplugin.matchkeyforjwt.md new file mode 100644 index 00000000..df786dee --- /dev/null +++ b/docs/api/credential-w3c.credentialplugin.matchkeyforjwt.md @@ -0,0 +1,30 @@ +--- +id: credential-w3c.credentialplugin.matchkeyforjwt +title: CredentialPlugin.matchKeyForJWT() method +hide_title: true +--- + + + +## CredentialPlugin.matchKeyForJWT() method + +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. + +Checks if a key is suitable for signing JWT payloads. + +**Signature:** + +```typescript +matchKeyForJWT(key: IKey, context: IssuerAgentContext): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --------- | -------------------------------------------------------- | ------------------------------------- | +| key | [IKey](./core-types.ikey.md) | the key to check | +| context | [IssuerAgentContext](./core-types.issueragentcontext.md) | the Veramo agent context, unused here | + +**Returns:** + +Promise<boolean> diff --git a/docs/api/credential-w3c.credentialplugin.md b/docs/api/credential-w3c.credentialplugin.md index dec93e11..b06025b6 100644 --- a/docs/api/credential-w3c.credentialplugin.md +++ b/docs/api/credential-w3c.credentialplugin.md @@ -26,10 +26,10 @@ export declare class CredentialPlugin implements IAgentPlugin ## Properties -| Property | Modifiers | Type | Description | -| ------------------------------------------------------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | -| [methods](./credential-w3c.credentialplugin.methods.md) | readonly | [ICredentialPlugin](./core-types.icredentialplugin.md) | | -| [schema](./credential-w3c.credentialplugin.schema.md) | readonly | { components: { schemas: { IVerifyCredentialArgs: { type: string; properties: { credential: { $ref: string; description: string; }; fetchRemoteContexts: { type: string; description: string; }; policies: { $ref: string; description: string; }; }; required: string\[\]; additionalProperties: { description: string; }; description: string; }; W3CVerifiableCredential: { anyOf: { $ref: string; }\[\]; description: string; }; VerifiableCredential: { type: string; properties: { proof: { $ref: string; }; issuer: { $ref: string; }; credentialSubject: { $ref: string; }; type: { anyOf: ({ type: string; items: { type: string; }; } | { type: string; items?: undefined; })\[\]; }; "@context": { $ref: string; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; credentialStatus: { $ref: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; ProofType: { type: string; properties: { type: { type: string; }; }; description: string; }; IssuerType: { anyOf: ({ type: string; properties: { id: { type: string; }; }; required: string\[\]; } | { type: string; properties?: undefined; required?: undefined; })\[\]; description: string; }; CredentialSubject: { type: string; properties: { id: { type: string; }; }; description: string; }; ContextType: { anyOf: ({ type: string; items?: undefined; } | { type: string; items: { anyOf: { type: string; }\[\]; }; })\[\]; description: string; }; CredentialStatusReference: { type: string; properties: { id: { type: string; }; type: { type: string; }; }; required: string\[\]; description: string; }; CompactJWT: { type: string; description: string; }; VerificationPolicies: { type: string; properties: { now: { type: string; description: string; }; issuanceDate: { type: string; description: string; }; expirationDate: { type: string; description: string; }; audience: { type: string; description: string; }; credentialStatus: { type: string; description: string; }; }; additionalProperties: { description: string; }; description: string; }; IVerifyResult: { type: string; properties: { verified: { type: string; description: string; }; error: { $ref: string; description: string; }; }; required: string\[\]; additionalProperties: { description: string; }; description: string; }; IError: { type: string; properties: { message: { type: string; description: string; }; errorCode: { type: string; description: string; }; }; description: string; }; IVerifyPresentationArgs: { type: string; properties: { presentation: { $ref: string; description: string; }; challenge: { type: string; description: string; }; domain: { type: string; description: string; }; fetchRemoteContexts: { type: string; description: string; }; policies: { $ref: string; description: string; }; }; required: string\[\]; additionalProperties: { description: string; }; description: string; }; W3CVerifiablePresentation: { anyOf: { $ref: string; }\[\]; description: string; }; VerifiablePresentation: { type: string; properties: { proof: { $ref: string; }; holder: { type: string; }; verifiableCredential: { type: string; items: { $ref: string; }; }; type: { anyOf: ({ type: string; items: { type: string; }; } | { type: string; items?: undefined; })\[\]; }; "@context": { $ref: string; }; verifier: { type: string; items: { type: string; }; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; ICreateVerifiableCredentialArgs: { type: string; properties: { credential: { $ref: string; description: string; }; save: { type: string; description: string; deprecated: string; }; proofFormat: { $ref: string; description: string; }; removeOriginalFields: { type: string; description: string; }; keyRef: { type: string; description: string; }; fetchRemoteContexts: { type: string; description: string; }; }; required: string\[\]; additionalProperties: { description: string; }; description: string; }; CredentialPayload: { type: string; properties: { issuer: { $ref: string; }; credentialSubject: { $ref: string; }; type: { type: string; items: { type: string; }; }; "@context": { $ref: string; }; issuanceDate: { $ref: string; }; expirationDate: { $ref: string; }; credentialStatus: { $ref: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; DateType: { type: string; description: string; }; ProofFormat: { type: string; enum: string\[\]; description: string; }; ICreateVerifiablePresentationArgs: { type: string; properties: { presentation: { $ref: string; description: string; }; save: { type: string; description: string; deprecated: string; }; challenge: { type: string; description: string; }; domain: { type: string; description: string; }; proofFormat: { $ref: string; description: string; }; removeOriginalFields: { type: string; description: string; }; keyRef: { type: string; description: string; }; fetchRemoteContexts: { type: string; description: string; }; }; required: string\[\]; additionalProperties: { description: string; }; description: string; }; PresentationPayload: { type: string; properties: { holder: { type: string; }; verifiableCredential: { type: string; items: { $ref: string; }; }; type: { type: string; items: { type: string; }; }; "@context": { $ref: string; }; verifier: { type: string; items: { type: string; }; }; issuanceDate: { $ref: string; }; expirationDate: { $ref: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; IIdentifier: { 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; }; }; 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: ({ $ref: string; type?: undefined; } | { type: string; $ref?: undefined; })\[\]; description: string; }; }; required: string\[\]; description: string; }; TKeyType: { type: string; enum: string\[\]; description: string; }; KeyMetadata: { type: string; properties: { algorithms: { type: string; items: { $ref: string; }; }; }; description: string; }; TAlg: { type: string; description: string; }; IService: { type: string; properties: { id: { type: string; description: string; }; type: { type: string; description: string; }; serviceEndpoint: { anyOf: ({ $ref: string; type?: undefined; items?: undefined; } | { type: string; items: { $ref: string; }; $ref?: undefined; })\[\]; description: string; }; description: { type: string; description: string; }; }; required: string\[\]; description: string; }; IServiceEndpoint: { anyOf: { type: string; }\[\]; description: string; }; }; methods: { verifyCredential: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; verifyPresentation: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; createVerifiableCredential: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; createVerifiablePresentation: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; listUsableProofFormats: { description: string; arguments: { $ref: string; }; returnType: { type: string; items: { $ref: string; }; }; }; }; }; } | | +| Property | Modifiers | Type | Description | +| ------------------------------------------------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | +| [methods](./credential-w3c.credentialplugin.methods.md) | readonly | [ICredentialPlugin](./core-types.icredentialplugin.md) | | +| [schema](./credential-w3c.credentialplugin.schema.md) | readonly | { components: { schemas: { IVerifyCredentialArgs: { type: string; properties: { resolutionOptions: { type: string; properties: { publicKeyFormat: { type: string; }; accept: { type: string; }; }; description: string; }; credential: { $ref: string; description: string; }; fetchRemoteContexts: { type: string; description: string; }; policies: { $ref: string; description: string; }; }; required: string\[\]; additionalProperties: { description: string; }; description: string; }; W3CVerifiableCredential: { anyOf: { $ref: string; }\[\]; description: string; }; VerifiableCredential: { type: string; properties: { proof: { $ref: string; }; issuer: { $ref: string; }; credentialSubject: { $ref: string; }; type: { anyOf: ({ type: string; items: { type: string; }; } | { type: string; items?: undefined; })\[\]; }; "@context": { $ref: string; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; credentialStatus: { $ref: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; ProofType: { type: string; properties: { type: { type: string; }; }; description: string; }; IssuerType: { anyOf: ({ type: string; properties: { id: { type: string; }; }; required: string\[\]; } | { type: string; properties?: undefined; required?: undefined; })\[\]; description: string; }; CredentialSubject: { type: string; properties: { id: { type: string; }; }; description: string; }; ContextType: { anyOf: ({ type: string; items?: undefined; } | { type: string; items: { anyOf: { type: string; }\[\]; }; })\[\]; description: string; }; CredentialStatusReference: { type: string; properties: { id: { type: string; }; type: { type: string; }; }; required: string\[\]; description: string; }; CompactJWT: { type: string; description: string; }; VerificationPolicies: { type: string; properties: { now: { type: string; description: string; }; issuanceDate: { type: string; description: string; }; expirationDate: { type: string; description: string; }; audience: { type: string; description: string; }; credentialStatus: { type: string; description: string; }; }; additionalProperties: { description: string; }; description: string; }; IVerifyResult: { type: string; properties: { verified: { type: string; description: string; }; error: { $ref: string; description: string; }; }; required: string\[\]; additionalProperties: { description: string; }; description: string; }; IError: { type: string; properties: { message: { type: string; description: string; }; errorCode: { type: string; description: string; }; }; description: string; }; IVerifyPresentationArgs: { type: string; properties: { resolutionOptions: { type: string; properties: { publicKeyFormat: { type: string; }; accept: { type: string; }; }; description: string; }; presentation: { $ref: string; description: string; }; challenge: { type: string; description: string; }; domain: { type: string; description: string; }; fetchRemoteContexts: { type: string; description: string; }; policies: { $ref: string; description: string; }; }; required: string\[\]; additionalProperties: { description: string; }; description: string; }; W3CVerifiablePresentation: { anyOf: { $ref: string; }\[\]; description: string; }; VerifiablePresentation: { type: string; properties: { proof: { $ref: string; }; holder: { type: string; }; verifiableCredential: { type: string; items: { $ref: string; }; }; type: { anyOf: ({ type: string; items: { type: string; }; } | { type: string; items?: undefined; })\[\]; }; "@context": { $ref: string; }; verifier: { type: string; items: { type: string; }; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; ICreateVerifiableCredentialArgs: { type: string; properties: { resolutionOptions: { type: string; properties: { publicKeyFormat: { type: string; }; accept: { type: string; }; }; description: string; }; credential: { $ref: string; description: string; }; save: { type: string; description: string; deprecated: string; }; proofFormat: { $ref: string; description: string; }; removeOriginalFields: { type: string; description: string; }; keyRef: { type: string; description: string; }; fetchRemoteContexts: { type: string; description: string; }; }; required: string\[\]; additionalProperties: { description: string; }; description: string; }; CredentialPayload: { type: string; properties: { issuer: { $ref: string; }; credentialSubject: { $ref: string; }; type: { type: string; items: { type: string; }; }; "@context": { $ref: string; }; issuanceDate: { $ref: string; }; expirationDate: { $ref: string; }; credentialStatus: { $ref: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; DateType: { type: string; description: string; }; ProofFormat: { type: string; enum: string\[\]; description: string; }; ICreateVerifiablePresentationArgs: { type: string; properties: { resolutionOptions: { type: string; properties: { publicKeyFormat: { type: string; }; accept: { type: string; }; }; description: string; }; presentation: { $ref: string; description: string; }; save: { type: string; description: string; deprecated: string; }; challenge: { type: string; description: string; }; domain: { type: string; description: string; }; proofFormat: { $ref: string; description: string; }; removeOriginalFields: { type: string; description: string; }; keyRef: { type: string; description: string; }; fetchRemoteContexts: { type: string; description: string; }; }; required: string\[\]; additionalProperties: { description: string; }; description: string; }; PresentationPayload: { type: string; properties: { holder: { type: string; }; verifiableCredential: { type: string; items: { $ref: string; }; }; type: { type: string; items: { type: string; }; }; "@context": { $ref: string; }; verifier: { type: string; items: { type: string; }; }; issuanceDate: { $ref: string; }; expirationDate: { $ref: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; IIdentifier: { 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; }; }; 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: ({ $ref: string; type?: undefined; } | { type: string; $ref?: undefined; })\[\]; description: string; }; }; required: string\[\]; description: string; }; TKeyType: { type: string; enum: string\[\]; description: string; }; KeyMetadata: { type: string; properties: { algorithms: { type: string; items: { $ref: string; }; }; }; description: string; }; TAlg: { type: string; description: string; }; IService: { type: string; properties: { id: { type: string; description: string; }; type: { type: string; description: string; }; serviceEndpoint: { anyOf: ({ $ref: string; type?: undefined; items?: undefined; } | { type: string; items: { $ref: string; }; $ref?: undefined; })\[\]; description: string; }; description: { type: string; description: string; }; }; required: string\[\]; description: string; }; IServiceEndpoint: { anyOf: { type: string; }\[\]; description: string; }; }; methods: { verifyCredential: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; verifyPresentation: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; createVerifiableCredential: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; createVerifiablePresentation: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; listUsableProofFormats: { description: string; arguments: { $ref: string; }; returnType: { type: string; items: { $ref: string; }; }; }; }; }; } | | ## Methods @@ -38,5 +38,6 @@ export declare class CredentialPlugin implements IAgentPlugin | [createVerifiableCredential(args, context)](./credential-w3c.credentialplugin.createverifiablecredential.md) | | Creates a Verifiable Credential. The payload, signer and format are chosen based on the args parameter. | | [createVerifiablePresentation(args, context)](./credential-w3c.credentialplugin.createverifiablepresentation.md) | | Creates a Verifiable Presentation. The payload, signer and format are chosen based on the args parameter. | | [listUsableProofFormats(did, context)](./credential-w3c.credentialplugin.listusableproofformats.md) | | | +| [matchKeyForJWT(key, context)](./credential-w3c.credentialplugin.matchkeyforjwt.md) | | **_(BETA)_** Checks if a key is suitable for signing JWT payloads. | | [verifyCredential(args, context)](./credential-w3c.credentialplugin.verifycredential.md) | | Verifies a Verifiable Credential JWT, LDS Format or EIP712. | | [verifyPresentation(args, context)](./credential-w3c.credentialplugin.verifypresentation.md) | | Verifies a Verifiable Presentation JWT or LDS Format. | diff --git a/docs/api/credential-w3c.credentialplugin.schema.md b/docs/api/credential-w3c.credentialplugin.schema.md index 757ea344..98f1a871 100644 --- a/docs/api/credential-w3c.credentialplugin.schema.md +++ b/docs/api/credential-w3c.credentialplugin.schema.md @@ -17,6 +17,18 @@ readonly schema: { IVerifyCredentialArgs: { type: string; properties: { + resolutionOptions: { + type: string; + properties: { + publicKeyFormat: { + type: string; + }; + accept: { + type: string; + }; + }; + description: string; + }; credential: { $ref: string; description: string; @@ -213,6 +225,18 @@ readonly schema: { IVerifyPresentationArgs: { type: string; properties: { + resolutionOptions: { + type: string; + properties: { + publicKeyFormat: { + type: string; + }; + accept: { + type: string; + }; + }; + description: string; + }; presentation: { $ref: string; description: string; @@ -297,6 +321,18 @@ readonly schema: { ICreateVerifiableCredentialArgs: { type: string; properties: { + resolutionOptions: { + type: string; + properties: { + publicKeyFormat: { + type: string; + }; + accept: { + type: string; + }; + }; + description: string; + }; credential: { $ref: string; description: string; @@ -375,6 +411,18 @@ readonly schema: { ICreateVerifiablePresentationArgs: { type: string; properties: { + resolutionOptions: { + type: string; + properties: { + publicKeyFormat: { + type: string; + }; + accept: { + type: string; + }; + }; + description: string; + }; presentation: { $ref: string; description: string; diff --git a/docs/api/data-store-json.claimtableentry.context.md b/docs/api/data-store-json.claimtableentry.context.md index 38bbd301..343a3273 100644 --- a/docs/api/data-store-json.claimtableentry.context.md +++ b/docs/api/data-store-json.claimtableentry.context.md @@ -8,7 +8,7 @@ hide_title: true ## ClaimTableEntry.context property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.claimtableentry.credentialhash.md b/docs/api/data-store-json.claimtableentry.credentialhash.md index ee15dada..708f1f14 100644 --- a/docs/api/data-store-json.claimtableentry.credentialhash.md +++ b/docs/api/data-store-json.claimtableentry.credentialhash.md @@ -8,7 +8,7 @@ hide_title: true ## ClaimTableEntry.credentialHash property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.claimtableentry.credentialtype.md b/docs/api/data-store-json.claimtableentry.credentialtype.md index d70fca55..b52fcaaa 100644 --- a/docs/api/data-store-json.claimtableentry.credentialtype.md +++ b/docs/api/data-store-json.claimtableentry.credentialtype.md @@ -8,7 +8,7 @@ hide_title: true ## ClaimTableEntry.credentialType property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.claimtableentry.expirationdate.md b/docs/api/data-store-json.claimtableentry.expirationdate.md index c2011cae..2ff3ea08 100644 --- a/docs/api/data-store-json.claimtableentry.expirationdate.md +++ b/docs/api/data-store-json.claimtableentry.expirationdate.md @@ -8,7 +8,7 @@ hide_title: true ## ClaimTableEntry.expirationDate property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.claimtableentry.hash.md b/docs/api/data-store-json.claimtableentry.hash.md index a94ef2d6..4dcb6ab8 100644 --- a/docs/api/data-store-json.claimtableentry.hash.md +++ b/docs/api/data-store-json.claimtableentry.hash.md @@ -8,7 +8,7 @@ hide_title: true ## ClaimTableEntry.hash property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.claimtableentry.issuancedate.md b/docs/api/data-store-json.claimtableentry.issuancedate.md index 067a7716..b182b5c4 100644 --- a/docs/api/data-store-json.claimtableentry.issuancedate.md +++ b/docs/api/data-store-json.claimtableentry.issuancedate.md @@ -8,7 +8,7 @@ hide_title: true ## ClaimTableEntry.issuanceDate property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.claimtableentry.issuer.md b/docs/api/data-store-json.claimtableentry.issuer.md index 65cabae1..0f43563c 100644 --- a/docs/api/data-store-json.claimtableentry.issuer.md +++ b/docs/api/data-store-json.claimtableentry.issuer.md @@ -8,7 +8,7 @@ hide_title: true ## ClaimTableEntry.issuer property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.claimtableentry.md b/docs/api/data-store-json.claimtableentry.md index be748998..ffd0d426 100644 --- a/docs/api/data-store-json.claimtableentry.md +++ b/docs/api/data-store-json.claimtableentry.md @@ -8,7 +8,7 @@ hide_title: true ## ClaimTableEntry interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This is used internally by [DataStoreJson](./data-store-json.datastorejson.md) to represent the claims contained in a Verifiable Credential in a way that facilitates querying using the [IDataStoreORM](./core-types.idatastoreorm.md) interface. diff --git a/docs/api/data-store-json.claimtableentry.subject.md b/docs/api/data-store-json.claimtableentry.subject.md index de9b044e..9490ba78 100644 --- a/docs/api/data-store-json.claimtableentry.subject.md +++ b/docs/api/data-store-json.claimtableentry.subject.md @@ -8,7 +8,7 @@ hide_title: true ## ClaimTableEntry.subject property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.claimtableentry.type.md b/docs/api/data-store-json.claimtableentry.type.md index 157e1139..ef70b772 100644 --- a/docs/api/data-store-json.claimtableentry.type.md +++ b/docs/api/data-store-json.claimtableentry.type.md @@ -8,7 +8,7 @@ hide_title: true ## ClaimTableEntry.type property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.claimtableentry.value.md b/docs/api/data-store-json.claimtableentry.value.md index ec6c0f1b..d20039dc 100644 --- a/docs/api/data-store-json.claimtableentry.value.md +++ b/docs/api/data-store-json.claimtableentry.value.md @@ -8,7 +8,7 @@ hide_title: true ## ClaimTableEntry.value property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.credentialtableentry.canonicalcredential.md b/docs/api/data-store-json.credentialtableentry.canonicalcredential.md index f80549a3..9bc77fba 100644 --- a/docs/api/data-store-json.credentialtableentry.canonicalcredential.md +++ b/docs/api/data-store-json.credentialtableentry.canonicalcredential.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialTableEntry.canonicalCredential property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.credentialtableentry.context.md b/docs/api/data-store-json.credentialtableentry.context.md index 5a4edd88..b1187ffd 100644 --- a/docs/api/data-store-json.credentialtableentry.context.md +++ b/docs/api/data-store-json.credentialtableentry.context.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialTableEntry.context property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.credentialtableentry.expirationdate.md b/docs/api/data-store-json.credentialtableentry.expirationdate.md index aad5110c..ad201b56 100644 --- a/docs/api/data-store-json.credentialtableentry.expirationdate.md +++ b/docs/api/data-store-json.credentialtableentry.expirationdate.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialTableEntry.expirationDate property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.credentialtableentry.hash.md b/docs/api/data-store-json.credentialtableentry.hash.md index ccef480b..2b1d04cc 100644 --- a/docs/api/data-store-json.credentialtableentry.hash.md +++ b/docs/api/data-store-json.credentialtableentry.hash.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialTableEntry.hash property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.credentialtableentry.id.md b/docs/api/data-store-json.credentialtableentry.id.md index c33b5412..bcee6da0 100644 --- a/docs/api/data-store-json.credentialtableentry.id.md +++ b/docs/api/data-store-json.credentialtableentry.id.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialTableEntry.id property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.credentialtableentry.issuancedate.md b/docs/api/data-store-json.credentialtableentry.issuancedate.md index 27327f25..1034e1c4 100644 --- a/docs/api/data-store-json.credentialtableentry.issuancedate.md +++ b/docs/api/data-store-json.credentialtableentry.issuancedate.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialTableEntry.issuanceDate property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.credentialtableentry.issuer.md b/docs/api/data-store-json.credentialtableentry.issuer.md index 564a2eb6..66e8ea0d 100644 --- a/docs/api/data-store-json.credentialtableentry.issuer.md +++ b/docs/api/data-store-json.credentialtableentry.issuer.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialTableEntry.issuer property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.credentialtableentry.md b/docs/api/data-store-json.credentialtableentry.md index cc66d910..cb60da0a 100644 --- a/docs/api/data-store-json.credentialtableentry.md +++ b/docs/api/data-store-json.credentialtableentry.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialTableEntry interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This is used internally by [DataStoreJson](./data-store-json.datastorejson.md) to represent a Verifiable Credential in a way that facilitates querying using the [IDataStoreORM](./core-types.idatastoreorm.md) interface. diff --git a/docs/api/data-store-json.credentialtableentry.parsedcredential.md b/docs/api/data-store-json.credentialtableentry.parsedcredential.md index 5067bb19..feaa0d4f 100644 --- a/docs/api/data-store-json.credentialtableentry.parsedcredential.md +++ b/docs/api/data-store-json.credentialtableentry.parsedcredential.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialTableEntry.parsedCredential property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.credentialtableentry.subject.md b/docs/api/data-store-json.credentialtableentry.subject.md index 84607288..ae269bc0 100644 --- a/docs/api/data-store-json.credentialtableentry.subject.md +++ b/docs/api/data-store-json.credentialtableentry.subject.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialTableEntry.subject property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.credentialtableentry.type.md b/docs/api/data-store-json.credentialtableentry.type.md index 2f6cf981..56450827 100644 --- a/docs/api/data-store-json.credentialtableentry.type.md +++ b/docs/api/data-store-json.credentialtableentry.type.md @@ -8,7 +8,7 @@ hide_title: true ## CredentialTableEntry.type property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.datastorejson._constructor_.md b/docs/api/data-store-json.datastorejson._constructor_.md index 98e8d44d..55379403 100644 --- a/docs/api/data-store-json.datastorejson._constructor_.md +++ b/docs/api/data-store-json.datastorejson._constructor_.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreJson.(constructor) -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Constructs a new instance of the `DataStoreJson` class diff --git a/docs/api/data-store-json.datastorejson.datastoredeletemessage.md b/docs/api/data-store-json.datastorejson.datastoredeletemessage.md index b0043507..b2690a43 100644 --- a/docs/api/data-store-json.datastorejson.datastoredeletemessage.md +++ b/docs/api/data-store-json.datastorejson.datastoredeletemessage.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreJson.dataStoreDeleteMessage() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.datastorejson.datastoredeleteverifiablecredential.md b/docs/api/data-store-json.datastorejson.datastoredeleteverifiablecredential.md index e82d62ce..a4d1a7af 100644 --- a/docs/api/data-store-json.datastorejson.datastoredeleteverifiablecredential.md +++ b/docs/api/data-store-json.datastorejson.datastoredeleteverifiablecredential.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreJson.dataStoreDeleteVerifiableCredential() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.datastorejson.datastoregetmessage.md b/docs/api/data-store-json.datastorejson.datastoregetmessage.md index 32b8493f..2b1d585b 100644 --- a/docs/api/data-store-json.datastorejson.datastoregetmessage.md +++ b/docs/api/data-store-json.datastorejson.datastoregetmessage.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreJson.dataStoreGetMessage() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.datastorejson.datastoregetverifiablecredential.md b/docs/api/data-store-json.datastorejson.datastoregetverifiablecredential.md index 0a1eb5dc..7a7e59b3 100644 --- a/docs/api/data-store-json.datastorejson.datastoregetverifiablecredential.md +++ b/docs/api/data-store-json.datastorejson.datastoregetverifiablecredential.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreJson.dataStoreGetVerifiableCredential() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.datastorejson.datastoregetverifiablepresentation.md b/docs/api/data-store-json.datastorejson.datastoregetverifiablepresentation.md index 8ed7b704..c97b9ec4 100644 --- a/docs/api/data-store-json.datastorejson.datastoregetverifiablepresentation.md +++ b/docs/api/data-store-json.datastorejson.datastoregetverifiablepresentation.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreJson.dataStoreGetVerifiablePresentation() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.datastorejson.datastoreormgetidentifiers.md b/docs/api/data-store-json.datastorejson.datastoreormgetidentifiers.md index d4089473..f01e3526 100644 --- a/docs/api/data-store-json.datastorejson.datastoreormgetidentifiers.md +++ b/docs/api/data-store-json.datastorejson.datastoreormgetidentifiers.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreJson.dataStoreORMGetIdentifiers() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.datastorejson.datastoreormgetidentifierscount.md b/docs/api/data-store-json.datastorejson.datastoreormgetidentifierscount.md index 4c8277bb..92fc3f6b 100644 --- a/docs/api/data-store-json.datastorejson.datastoreormgetidentifierscount.md +++ b/docs/api/data-store-json.datastorejson.datastoreormgetidentifierscount.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreJson.dataStoreORMGetIdentifiersCount() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.datastorejson.datastoreormgetmessages.md b/docs/api/data-store-json.datastorejson.datastoreormgetmessages.md index b1e8b2ce..7b604162 100644 --- a/docs/api/data-store-json.datastorejson.datastoreormgetmessages.md +++ b/docs/api/data-store-json.datastorejson.datastoreormgetmessages.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreJson.dataStoreORMGetMessages() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.datastorejson.datastoreormgetmessagescount.md b/docs/api/data-store-json.datastorejson.datastoreormgetmessagescount.md index 16aa3aa9..67e620b5 100644 --- a/docs/api/data-store-json.datastorejson.datastoreormgetmessagescount.md +++ b/docs/api/data-store-json.datastorejson.datastoreormgetmessagescount.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreJson.dataStoreORMGetMessagesCount() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.datastorejson.datastoreormgetverifiablecredentials.md b/docs/api/data-store-json.datastorejson.datastoreormgetverifiablecredentials.md index db0ec6c2..0d94cef3 100644 --- a/docs/api/data-store-json.datastorejson.datastoreormgetverifiablecredentials.md +++ b/docs/api/data-store-json.datastorejson.datastoreormgetverifiablecredentials.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreJson.dataStoreORMGetVerifiableCredentials() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.datastorejson.datastoreormgetverifiablecredentialsbyclaims.md b/docs/api/data-store-json.datastorejson.datastoreormgetverifiablecredentialsbyclaims.md index fec320e6..efadf3b1 100644 --- a/docs/api/data-store-json.datastorejson.datastoreormgetverifiablecredentialsbyclaims.md +++ b/docs/api/data-store-json.datastorejson.datastoreormgetverifiablecredentialsbyclaims.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreJson.dataStoreORMGetVerifiableCredentialsByClaims() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.datastorejson.datastoreormgetverifiablecredentialsbyclaimscount.md b/docs/api/data-store-json.datastorejson.datastoreormgetverifiablecredentialsbyclaimscount.md index 7e2502d6..c3b45a71 100644 --- a/docs/api/data-store-json.datastorejson.datastoreormgetverifiablecredentialsbyclaimscount.md +++ b/docs/api/data-store-json.datastorejson.datastoreormgetverifiablecredentialsbyclaimscount.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreJson.dataStoreORMGetVerifiableCredentialsByClaimsCount() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.datastorejson.datastoreormgetverifiablecredentialscount.md b/docs/api/data-store-json.datastorejson.datastoreormgetverifiablecredentialscount.md index 5eb9ee0d..422dea92 100644 --- a/docs/api/data-store-json.datastorejson.datastoreormgetverifiablecredentialscount.md +++ b/docs/api/data-store-json.datastorejson.datastoreormgetverifiablecredentialscount.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreJson.dataStoreORMGetVerifiableCredentialsCount() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.datastorejson.datastoreormgetverifiablepresentations.md b/docs/api/data-store-json.datastorejson.datastoreormgetverifiablepresentations.md index 30f901fb..08ca2bcc 100644 --- a/docs/api/data-store-json.datastorejson.datastoreormgetverifiablepresentations.md +++ b/docs/api/data-store-json.datastorejson.datastoreormgetverifiablepresentations.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreJson.dataStoreORMGetVerifiablePresentations() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.datastorejson.datastoreormgetverifiablepresentationscount.md b/docs/api/data-store-json.datastorejson.datastoreormgetverifiablepresentationscount.md index fcd51538..3e454fcb 100644 --- a/docs/api/data-store-json.datastorejson.datastoreormgetverifiablepresentationscount.md +++ b/docs/api/data-store-json.datastorejson.datastoreormgetverifiablepresentationscount.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreJson.dataStoreORMGetVerifiablePresentationsCount() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.datastorejson.datastoresavemessage.md b/docs/api/data-store-json.datastorejson.datastoresavemessage.md index c53aff18..f3b65dcd 100644 --- a/docs/api/data-store-json.datastorejson.datastoresavemessage.md +++ b/docs/api/data-store-json.datastorejson.datastoresavemessage.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreJson.dataStoreSaveMessage() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.datastorejson.datastoresaveverifiablecredential.md b/docs/api/data-store-json.datastorejson.datastoresaveverifiablecredential.md index c0a851ca..e70a8151 100644 --- a/docs/api/data-store-json.datastorejson.datastoresaveverifiablecredential.md +++ b/docs/api/data-store-json.datastorejson.datastoresaveverifiablecredential.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreJson.dataStoreSaveVerifiableCredential() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.datastorejson.datastoresaveverifiablepresentation.md b/docs/api/data-store-json.datastorejson.datastoresaveverifiablepresentation.md index 7f1ff910..d3455d72 100644 --- a/docs/api/data-store-json.datastorejson.datastoresaveverifiablepresentation.md +++ b/docs/api/data-store-json.datastorejson.datastoresaveverifiablepresentation.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreJson.dataStoreSaveVerifiablePresentation() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.datastorejson.md b/docs/api/data-store-json.datastorejson.md index 832259e3..ddc1b110 100644 --- a/docs/api/data-store-json.datastorejson.md +++ b/docs/api/data-store-json.datastorejson.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreJson class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. A Veramo agent storage plugin that implements the [IDataStore](./core-types.idatastore.md) and [IDataStoreORM](./core-types.idatastoreorm.md) methods using one big JSON object as a backend. diff --git a/docs/api/data-store-json.datastorejson.methods.md b/docs/api/data-store-json.datastorejson.methods.md index d7bf2e86..8d3bdeb2 100644 --- a/docs/api/data-store-json.datastorejson.methods.md +++ b/docs/api/data-store-json.datastorejson.methods.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreJson.methods property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.datastorejson.schema.md b/docs/api/data-store-json.datastorejson.schema.md index df2d2335..e296fdf6 100644 --- a/docs/api/data-store-json.datastorejson.schema.md +++ b/docs/api/data-store-json.datastorejson.schema.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreJson.schema property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.didstorejson._constructor_.md b/docs/api/data-store-json.didstorejson._constructor_.md index 7769102a..eab8084e 100644 --- a/docs/api/data-store-json.didstorejson._constructor_.md +++ b/docs/api/data-store-json.didstorejson._constructor_.md @@ -8,7 +8,7 @@ hide_title: true ## DIDStoreJson.(constructor) -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Constructs a new instance of the `DIDStoreJson` class diff --git a/docs/api/data-store-json.didstorejson.deletedid.md b/docs/api/data-store-json.didstorejson.deletedid.md index 7bc5ab8f..a4ea7c1c 100644 --- a/docs/api/data-store-json.didstorejson.deletedid.md +++ b/docs/api/data-store-json.didstorejson.deletedid.md @@ -8,7 +8,7 @@ hide_title: true ## DIDStoreJson.deleteDID() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.didstorejson.getdid.md b/docs/api/data-store-json.didstorejson.getdid.md index f3e57c79..04bf8d83 100644 --- a/docs/api/data-store-json.didstorejson.getdid.md +++ b/docs/api/data-store-json.didstorejson.getdid.md @@ -8,7 +8,7 @@ hide_title: true ## DIDStoreJson.getDID() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.didstorejson.importdid.md b/docs/api/data-store-json.didstorejson.importdid.md index cf9da6a1..9aa37bd7 100644 --- a/docs/api/data-store-json.didstorejson.importdid.md +++ b/docs/api/data-store-json.didstorejson.importdid.md @@ -8,7 +8,7 @@ hide_title: true ## DIDStoreJson.importDID() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.didstorejson.listdids.md b/docs/api/data-store-json.didstorejson.listdids.md index 15a6ad27..e0be7474 100644 --- a/docs/api/data-store-json.didstorejson.listdids.md +++ b/docs/api/data-store-json.didstorejson.listdids.md @@ -8,7 +8,7 @@ hide_title: true ## DIDStoreJson.listDIDs() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.didstorejson.md b/docs/api/data-store-json.didstorejson.md index 79d833c3..b1a75003 100644 --- a/docs/api/data-store-json.didstorejson.md +++ b/docs/api/data-store-json.didstorejson.md @@ -8,7 +8,7 @@ hide_title: true ## DIDStoreJson class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. An implementation of [AbstractDIDStore](./did-manager.abstractdidstore.md) that uses a JSON object to store the relationships between DIDs, their providers and controllers and their keys and services as they are known and managed by a Veramo agent. diff --git a/docs/api/data-store-json.diffcallback.md b/docs/api/data-store-json.diffcallback.md index 5270da27..de70900f 100644 --- a/docs/api/data-store-json.diffcallback.md +++ b/docs/api/data-store-json.diffcallback.md @@ -8,7 +8,7 @@ hide_title: true ## DiffCallback type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. A callback method that is called when the data stored in a [VeramoJsonCache](./data-store-json.veramojsoncache.md) is updated. diff --git a/docs/api/data-store-json.keystorejson._constructor_.md b/docs/api/data-store-json.keystorejson._constructor_.md index 48845ad5..7b6895d5 100644 --- a/docs/api/data-store-json.keystorejson._constructor_.md +++ b/docs/api/data-store-json.keystorejson._constructor_.md @@ -8,7 +8,7 @@ hide_title: true ## KeyStoreJson.(constructor) -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Constructs a new instance of the `KeyStoreJson` class diff --git a/docs/api/data-store-json.keystorejson.deletekey.md b/docs/api/data-store-json.keystorejson.deletekey.md index fb7c9062..423b908c 100644 --- a/docs/api/data-store-json.keystorejson.deletekey.md +++ b/docs/api/data-store-json.keystorejson.deletekey.md @@ -8,7 +8,7 @@ hide_title: true ## KeyStoreJson.deleteKey() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.keystorejson.getkey.md b/docs/api/data-store-json.keystorejson.getkey.md index 9cc91e06..4cec8b01 100644 --- a/docs/api/data-store-json.keystorejson.getkey.md +++ b/docs/api/data-store-json.keystorejson.getkey.md @@ -8,7 +8,7 @@ hide_title: true ## KeyStoreJson.getKey() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.keystorejson.importkey.md b/docs/api/data-store-json.keystorejson.importkey.md index 5c7384e0..cf6b765a 100644 --- a/docs/api/data-store-json.keystorejson.importkey.md +++ b/docs/api/data-store-json.keystorejson.importkey.md @@ -8,7 +8,7 @@ hide_title: true ## KeyStoreJson.importKey() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.keystorejson.listkeys.md b/docs/api/data-store-json.keystorejson.listkeys.md index 2865f13c..360cc90d 100644 --- a/docs/api/data-store-json.keystorejson.listkeys.md +++ b/docs/api/data-store-json.keystorejson.listkeys.md @@ -8,7 +8,7 @@ hide_title: true ## KeyStoreJson.listKeys() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.keystorejson.md b/docs/api/data-store-json.keystorejson.md index 24bff19b..91aef239 100644 --- a/docs/api/data-store-json.keystorejson.md +++ b/docs/api/data-store-json.keystorejson.md @@ -8,7 +8,7 @@ hide_title: true ## KeyStoreJson class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. An implementation of [AbstractKeyStore](./key-manager.abstractkeystore.md) that uses a JSON object to store the relationships between keys, their IDs, aliases and [KMS implementations](./key-manager.abstractkeymanagementsystem.md), as they are known and managed by a Veramo agent. diff --git a/docs/api/data-store-json.presentationtableentry.canonicalpresentation.md b/docs/api/data-store-json.presentationtableentry.canonicalpresentation.md index d13f4dfe..001f2b2b 100644 --- a/docs/api/data-store-json.presentationtableentry.canonicalpresentation.md +++ b/docs/api/data-store-json.presentationtableentry.canonicalpresentation.md @@ -8,7 +8,7 @@ hide_title: true ## PresentationTableEntry.canonicalPresentation property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.presentationtableentry.context.md b/docs/api/data-store-json.presentationtableentry.context.md index ad8f6837..bca45a92 100644 --- a/docs/api/data-store-json.presentationtableentry.context.md +++ b/docs/api/data-store-json.presentationtableentry.context.md @@ -8,7 +8,7 @@ hide_title: true ## PresentationTableEntry.context property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.presentationtableentry.credentials.md b/docs/api/data-store-json.presentationtableentry.credentials.md index a1a07243..edbe4166 100644 --- a/docs/api/data-store-json.presentationtableentry.credentials.md +++ b/docs/api/data-store-json.presentationtableentry.credentials.md @@ -8,7 +8,7 @@ hide_title: true ## PresentationTableEntry.credentials property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.presentationtableentry.expirationdate.md b/docs/api/data-store-json.presentationtableentry.expirationdate.md index d9e71063..f591255d 100644 --- a/docs/api/data-store-json.presentationtableentry.expirationdate.md +++ b/docs/api/data-store-json.presentationtableentry.expirationdate.md @@ -8,7 +8,7 @@ hide_title: true ## PresentationTableEntry.expirationDate property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.presentationtableentry.hash.md b/docs/api/data-store-json.presentationtableentry.hash.md index 5225fe10..8f931b5c 100644 --- a/docs/api/data-store-json.presentationtableentry.hash.md +++ b/docs/api/data-store-json.presentationtableentry.hash.md @@ -8,7 +8,7 @@ hide_title: true ## PresentationTableEntry.hash property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.presentationtableentry.holder.md b/docs/api/data-store-json.presentationtableentry.holder.md index ce9fe88e..e1aadcb4 100644 --- a/docs/api/data-store-json.presentationtableentry.holder.md +++ b/docs/api/data-store-json.presentationtableentry.holder.md @@ -8,7 +8,7 @@ hide_title: true ## PresentationTableEntry.holder property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.presentationtableentry.id.md b/docs/api/data-store-json.presentationtableentry.id.md index bf1f0643..1c561483 100644 --- a/docs/api/data-store-json.presentationtableentry.id.md +++ b/docs/api/data-store-json.presentationtableentry.id.md @@ -8,7 +8,7 @@ hide_title: true ## PresentationTableEntry.id property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.presentationtableentry.issuancedate.md b/docs/api/data-store-json.presentationtableentry.issuancedate.md index 05e205ab..15f3f03f 100644 --- a/docs/api/data-store-json.presentationtableentry.issuancedate.md +++ b/docs/api/data-store-json.presentationtableentry.issuancedate.md @@ -8,7 +8,7 @@ hide_title: true ## PresentationTableEntry.issuanceDate property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.presentationtableentry.md b/docs/api/data-store-json.presentationtableentry.md index b0ea03de..349c66f8 100644 --- a/docs/api/data-store-json.presentationtableentry.md +++ b/docs/api/data-store-json.presentationtableentry.md @@ -8,7 +8,7 @@ hide_title: true ## PresentationTableEntry interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This is used internally by [DataStoreJson](./data-store-json.datastorejson.md) to represent a Verifiable Presentation in a way that facilitates querying using the [IDataStoreORM](./core-types.idatastoreorm.md) interface. diff --git a/docs/api/data-store-json.presentationtableentry.parsedpresentation.md b/docs/api/data-store-json.presentationtableentry.parsedpresentation.md index 8b6e87a0..97a7a745 100644 --- a/docs/api/data-store-json.presentationtableentry.parsedpresentation.md +++ b/docs/api/data-store-json.presentationtableentry.parsedpresentation.md @@ -8,7 +8,7 @@ hide_title: true ## PresentationTableEntry.parsedPresentation property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.presentationtableentry.type.md b/docs/api/data-store-json.presentationtableentry.type.md index e7e7a650..6b4d04ec 100644 --- a/docs/api/data-store-json.presentationtableentry.type.md +++ b/docs/api/data-store-json.presentationtableentry.type.md @@ -8,7 +8,7 @@ hide_title: true ## PresentationTableEntry.type property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.presentationtableentry.verifier.md b/docs/api/data-store-json.presentationtableentry.verifier.md index ae9d2af7..5ff4791e 100644 --- a/docs/api/data-store-json.presentationtableentry.verifier.md +++ b/docs/api/data-store-json.presentationtableentry.verifier.md @@ -8,7 +8,7 @@ hide_title: true ## PresentationTableEntry.verifier property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.privatekeystorejson._constructor_.md b/docs/api/data-store-json.privatekeystorejson._constructor_.md index 122f1579..35437773 100644 --- a/docs/api/data-store-json.privatekeystorejson._constructor_.md +++ b/docs/api/data-store-json.privatekeystorejson._constructor_.md @@ -8,7 +8,7 @@ hide_title: true ## PrivateKeyStoreJson.(constructor) -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Constructs a new instance of the `PrivateKeyStoreJson` class diff --git a/docs/api/data-store-json.privatekeystorejson.deletekey.md b/docs/api/data-store-json.privatekeystorejson.deletekey.md index 4961ca8b..4a5cb432 100644 --- a/docs/api/data-store-json.privatekeystorejson.deletekey.md +++ b/docs/api/data-store-json.privatekeystorejson.deletekey.md @@ -8,7 +8,7 @@ hide_title: true ## PrivateKeyStoreJson.deleteKey() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.privatekeystorejson.getkey.md b/docs/api/data-store-json.privatekeystorejson.getkey.md index ac3c74e7..a12277af 100644 --- a/docs/api/data-store-json.privatekeystorejson.getkey.md +++ b/docs/api/data-store-json.privatekeystorejson.getkey.md @@ -8,7 +8,7 @@ hide_title: true ## PrivateKeyStoreJson.getKey() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.privatekeystorejson.importkey.md b/docs/api/data-store-json.privatekeystorejson.importkey.md index 158c9c4b..8efe36df 100644 --- a/docs/api/data-store-json.privatekeystorejson.importkey.md +++ b/docs/api/data-store-json.privatekeystorejson.importkey.md @@ -8,7 +8,7 @@ hide_title: true ## PrivateKeyStoreJson.importKey() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.privatekeystorejson.listkeys.md b/docs/api/data-store-json.privatekeystorejson.listkeys.md index 8e7fddb1..5c59872d 100644 --- a/docs/api/data-store-json.privatekeystorejson.listkeys.md +++ b/docs/api/data-store-json.privatekeystorejson.listkeys.md @@ -8,7 +8,7 @@ hide_title: true ## PrivateKeyStoreJson.listKeys() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.privatekeystorejson.md b/docs/api/data-store-json.privatekeystorejson.md index 971a3591..b121a1a2 100644 --- a/docs/api/data-store-json.privatekeystorejson.md +++ b/docs/api/data-store-json.privatekeystorejson.md @@ -8,7 +8,7 @@ hide_title: true ## PrivateKeyStoreJson class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. An implementation of [AbstractPrivateKeyStore](./key-manager.abstractprivatekeystore.md) that uses a JSON object to store the private key material needed by [KeyManagementSystem](./kms-local.keymanagementsystem.md). diff --git a/docs/api/data-store-json.veramojsoncache.claims.md b/docs/api/data-store-json.veramojsoncache.claims.md index 0b9e99a7..b0512d09 100644 --- a/docs/api/data-store-json.veramojsoncache.claims.md +++ b/docs/api/data-store-json.veramojsoncache.claims.md @@ -8,7 +8,7 @@ hide_title: true ## VeramoJsonCache.claims property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.veramojsoncache.credentials.md b/docs/api/data-store-json.veramojsoncache.credentials.md index 6f72287a..a4f3ae55 100644 --- a/docs/api/data-store-json.veramojsoncache.credentials.md +++ b/docs/api/data-store-json.veramojsoncache.credentials.md @@ -8,7 +8,7 @@ hide_title: true ## VeramoJsonCache.credentials property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.veramojsoncache.dids.md b/docs/api/data-store-json.veramojsoncache.dids.md index da447445..57fc2ec8 100644 --- a/docs/api/data-store-json.veramojsoncache.dids.md +++ b/docs/api/data-store-json.veramojsoncache.dids.md @@ -8,7 +8,7 @@ hide_title: true ## VeramoJsonCache.dids property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.veramojsoncache.keys.md b/docs/api/data-store-json.veramojsoncache.keys.md index 3fabb441..bb9e8e07 100644 --- a/docs/api/data-store-json.veramojsoncache.keys.md +++ b/docs/api/data-store-json.veramojsoncache.keys.md @@ -8,7 +8,7 @@ hide_title: true ## VeramoJsonCache.keys property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.veramojsoncache.md b/docs/api/data-store-json.veramojsoncache.md index 7e352d0c..3e7a44a2 100644 --- a/docs/api/data-store-json.veramojsoncache.md +++ b/docs/api/data-store-json.veramojsoncache.md @@ -8,7 +8,7 @@ hide_title: true ## VeramoJsonCache interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. A JSON data layout for data-store-json implementations. diff --git a/docs/api/data-store-json.veramojsoncache.messages.md b/docs/api/data-store-json.veramojsoncache.messages.md index 68cae09b..204dbfe5 100644 --- a/docs/api/data-store-json.veramojsoncache.messages.md +++ b/docs/api/data-store-json.veramojsoncache.messages.md @@ -8,7 +8,7 @@ hide_title: true ## VeramoJsonCache.messages property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.veramojsoncache.presentations.md b/docs/api/data-store-json.veramojsoncache.presentations.md index a5321a40..729952e6 100644 --- a/docs/api/data-store-json.veramojsoncache.presentations.md +++ b/docs/api/data-store-json.veramojsoncache.presentations.md @@ -8,7 +8,7 @@ hide_title: true ## VeramoJsonCache.presentations property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.veramojsoncache.privatekeys.md b/docs/api/data-store-json.veramojsoncache.privatekeys.md index 03c03f21..be95a855 100644 --- a/docs/api/data-store-json.veramojsoncache.privatekeys.md +++ b/docs/api/data-store-json.veramojsoncache.privatekeys.md @@ -8,7 +8,7 @@ hide_title: true ## VeramoJsonCache.privateKeys property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store-json.veramojsonstore.md b/docs/api/data-store-json.veramojsonstore.md index a7699497..ded0c37a 100644 --- a/docs/api/data-store-json.veramojsonstore.md +++ b/docs/api/data-store-json.veramojsonstore.md @@ -8,7 +8,7 @@ hide_title: true ## VeramoJsonStore interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. An extension to [VeramoJsonCache](./data-store-json.veramojsoncache.md) that bundles an update notification callback that allows implementors to persist the [VeramoJsonCache](./data-store-json.veramojsoncache.md) and any other data it may contain to another storage medium. diff --git a/docs/api/data-store-json.veramojsonstore.notifyupdate.md b/docs/api/data-store-json.veramojsonstore.notifyupdate.md index b214784f..c4e1f35c 100644 --- a/docs/api/data-store-json.veramojsonstore.notifyupdate.md +++ b/docs/api/data-store-json.veramojsonstore.notifyupdate.md @@ -8,7 +8,7 @@ hide_title: true ## VeramoJsonStore.notifyUpdate property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.claim.context.md b/docs/api/data-store.claim.context.md index b51d90fa..cbb0fe74 100644 --- a/docs/api/data-store.claim.context.md +++ b/docs/api/data-store.claim.context.md @@ -8,7 +8,7 @@ hide_title: true ## Claim.context property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.claim.credential.md b/docs/api/data-store.claim.credential.md index 2861e834..5f1c0c6c 100644 --- a/docs/api/data-store.claim.credential.md +++ b/docs/api/data-store.claim.credential.md @@ -8,7 +8,7 @@ hide_title: true ## Claim.credential property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.claim.credentialtype.md b/docs/api/data-store.claim.credentialtype.md index e0c06ac1..597c3bbc 100644 --- a/docs/api/data-store.claim.credentialtype.md +++ b/docs/api/data-store.claim.credentialtype.md @@ -8,7 +8,7 @@ hide_title: true ## Claim.credentialType property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.claim.expirationdate.md b/docs/api/data-store.claim.expirationdate.md index a17bba62..b7af1c35 100644 --- a/docs/api/data-store.claim.expirationdate.md +++ b/docs/api/data-store.claim.expirationdate.md @@ -8,7 +8,7 @@ hide_title: true ## Claim.expirationDate property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.claim.hash.md b/docs/api/data-store.claim.hash.md index 9ebc560a..d057327e 100644 --- a/docs/api/data-store.claim.hash.md +++ b/docs/api/data-store.claim.hash.md @@ -8,7 +8,7 @@ hide_title: true ## Claim.hash property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.claim.isobj.md b/docs/api/data-store.claim.isobj.md index 23bc58b5..322fa74d 100644 --- a/docs/api/data-store.claim.isobj.md +++ b/docs/api/data-store.claim.isobj.md @@ -8,7 +8,7 @@ hide_title: true ## Claim.isObj property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.claim.issuancedate.md b/docs/api/data-store.claim.issuancedate.md index 2b1d11bc..9ef6d589 100644 --- a/docs/api/data-store.claim.issuancedate.md +++ b/docs/api/data-store.claim.issuancedate.md @@ -8,7 +8,7 @@ hide_title: true ## Claim.issuanceDate property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.claim.issuer.md b/docs/api/data-store.claim.issuer.md index 64d9251a..b44d9a52 100644 --- a/docs/api/data-store.claim.issuer.md +++ b/docs/api/data-store.claim.issuer.md @@ -8,7 +8,7 @@ hide_title: true ## Claim.issuer property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.claim.md b/docs/api/data-store.claim.md index 8d6dc8c9..d97d3fab 100644 --- a/docs/api/data-store.claim.md +++ b/docs/api/data-store.claim.md @@ -8,7 +8,7 @@ hide_title: true ## Claim class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Represents the properties of a claim extracted from a Verifiable Credential `credentialSubject`, and stored in a TypeORM database for querying. diff --git a/docs/api/data-store.claim.subject.md b/docs/api/data-store.claim.subject.md index f5b66e8d..c7945747 100644 --- a/docs/api/data-store.claim.subject.md +++ b/docs/api/data-store.claim.subject.md @@ -8,7 +8,7 @@ hide_title: true ## Claim.subject property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.claim.type.md b/docs/api/data-store.claim.type.md index 5d1485ca..1ac61257 100644 --- a/docs/api/data-store.claim.type.md +++ b/docs/api/data-store.claim.type.md @@ -8,7 +8,7 @@ hide_title: true ## Claim.type property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.claim.value.md b/docs/api/data-store.claim.value.md index be8731f8..bd0b35ad 100644 --- a/docs/api/data-store.claim.value.md +++ b/docs/api/data-store.claim.value.md @@ -8,7 +8,7 @@ hide_title: true ## Claim.value property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.credential_2.claims.md b/docs/api/data-store.credential_2.claims.md index f2138754..30760927 100644 --- a/docs/api/data-store.credential_2.claims.md +++ b/docs/api/data-store.credential_2.claims.md @@ -8,7 +8,7 @@ hide_title: true ## Credential_2.claims property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.credential_2.context.md b/docs/api/data-store.credential_2.context.md index 48914d55..74c65040 100644 --- a/docs/api/data-store.credential_2.context.md +++ b/docs/api/data-store.credential_2.context.md @@ -8,7 +8,7 @@ hide_title: true ## Credential_2.context property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.credential_2.expirationdate.md b/docs/api/data-store.credential_2.expirationdate.md index f359ddd1..52a816d6 100644 --- a/docs/api/data-store.credential_2.expirationdate.md +++ b/docs/api/data-store.credential_2.expirationdate.md @@ -8,7 +8,7 @@ hide_title: true ## Credential_2.expirationDate property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.credential_2.hash.md b/docs/api/data-store.credential_2.hash.md index ec33f340..0bb9e7d0 100644 --- a/docs/api/data-store.credential_2.hash.md +++ b/docs/api/data-store.credential_2.hash.md @@ -8,7 +8,7 @@ hide_title: true ## Credential_2.hash property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.credential_2.id.md b/docs/api/data-store.credential_2.id.md index 18bb1d34..c8f5a92e 100644 --- a/docs/api/data-store.credential_2.id.md +++ b/docs/api/data-store.credential_2.id.md @@ -8,7 +8,7 @@ hide_title: true ## Credential_2.id property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.credential_2.issuancedate.md b/docs/api/data-store.credential_2.issuancedate.md index 471154f3..1dc20e9d 100644 --- a/docs/api/data-store.credential_2.issuancedate.md +++ b/docs/api/data-store.credential_2.issuancedate.md @@ -8,7 +8,7 @@ hide_title: true ## Credential_2.issuanceDate property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.credential_2.issuer.md b/docs/api/data-store.credential_2.issuer.md index b8f15643..4531f32c 100644 --- a/docs/api/data-store.credential_2.issuer.md +++ b/docs/api/data-store.credential_2.issuer.md @@ -8,7 +8,7 @@ hide_title: true ## Credential_2.issuer property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.credential_2.md b/docs/api/data-store.credential_2.md index cb2104eb..42604d7f 100644 --- a/docs/api/data-store.credential_2.md +++ b/docs/api/data-store.credential_2.md @@ -8,7 +8,7 @@ hide_title: true ## Credential_2 class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Represents some common properties of a Verifiable Credential that are stored in a TypeORM database for querying. diff --git a/docs/api/data-store.credential_2.messages.md b/docs/api/data-store.credential_2.messages.md index 9ddc943e..b26ed733 100644 --- a/docs/api/data-store.credential_2.messages.md +++ b/docs/api/data-store.credential_2.messages.md @@ -8,7 +8,7 @@ hide_title: true ## Credential_2.messages property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.credential_2.presentations.md b/docs/api/data-store.credential_2.presentations.md index cef2aaf4..7318348a 100644 --- a/docs/api/data-store.credential_2.presentations.md +++ b/docs/api/data-store.credential_2.presentations.md @@ -8,7 +8,7 @@ hide_title: true ## Credential_2.presentations property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.credential_2.raw.md b/docs/api/data-store.credential_2.raw.md index 4ae9d446..155a1909 100644 --- a/docs/api/data-store.credential_2.raw.md +++ b/docs/api/data-store.credential_2.raw.md @@ -8,7 +8,7 @@ hide_title: true ## Credential_2.raw property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.credential_2.subject.md b/docs/api/data-store.credential_2.subject.md index 5b264975..fe5d3c09 100644 --- a/docs/api/data-store.credential_2.subject.md +++ b/docs/api/data-store.credential_2.subject.md @@ -8,7 +8,7 @@ hide_title: true ## Credential_2.subject property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.credential_2.type.md b/docs/api/data-store.credential_2.type.md index b56ac84d..6e38a2bb 100644 --- a/docs/api/data-store.credential_2.type.md +++ b/docs/api/data-store.credential_2.type.md @@ -8,7 +8,7 @@ hide_title: true ## Credential_2.type property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.datastore._constructor_.md b/docs/api/data-store.datastore._constructor_.md index 15a47a21..c165c1fd 100644 --- a/docs/api/data-store.datastore._constructor_.md +++ b/docs/api/data-store.datastore._constructor_.md @@ -8,7 +8,7 @@ hide_title: true ## DataStore.(constructor) -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Constructs a new instance of the `DataStore` class diff --git a/docs/api/data-store.datastore.datastoredeletemessage.md b/docs/api/data-store.datastore.datastoredeletemessage.md index eb3aeab2..ba8767e0 100644 --- a/docs/api/data-store.datastore.datastoredeletemessage.md +++ b/docs/api/data-store.datastore.datastoredeletemessage.md @@ -8,7 +8,7 @@ hide_title: true ## DataStore.dataStoreDeleteMessage() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.datastore.datastoredeleteverifiablecredential.md b/docs/api/data-store.datastore.datastoredeleteverifiablecredential.md index f0aa72b2..c36426c5 100644 --- a/docs/api/data-store.datastore.datastoredeleteverifiablecredential.md +++ b/docs/api/data-store.datastore.datastoredeleteverifiablecredential.md @@ -8,7 +8,7 @@ hide_title: true ## DataStore.dataStoreDeleteVerifiableCredential() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.datastore.datastoregetmessage.md b/docs/api/data-store.datastore.datastoregetmessage.md index cf5caa5f..cef830ef 100644 --- a/docs/api/data-store.datastore.datastoregetmessage.md +++ b/docs/api/data-store.datastore.datastoregetmessage.md @@ -8,7 +8,7 @@ hide_title: true ## DataStore.dataStoreGetMessage() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.datastore.datastoregetverifiablecredential.md b/docs/api/data-store.datastore.datastoregetverifiablecredential.md index 1f76364e..6e33b6f1 100644 --- a/docs/api/data-store.datastore.datastoregetverifiablecredential.md +++ b/docs/api/data-store.datastore.datastoregetverifiablecredential.md @@ -8,7 +8,7 @@ hide_title: true ## DataStore.dataStoreGetVerifiableCredential() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.datastore.datastoregetverifiablepresentation.md b/docs/api/data-store.datastore.datastoregetverifiablepresentation.md index ff57e0a2..1eefb998 100644 --- a/docs/api/data-store.datastore.datastoregetverifiablepresentation.md +++ b/docs/api/data-store.datastore.datastoregetverifiablepresentation.md @@ -8,7 +8,7 @@ hide_title: true ## DataStore.dataStoreGetVerifiablePresentation() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.datastore.datastoresavemessage.md b/docs/api/data-store.datastore.datastoresavemessage.md index 85e01860..6b418381 100644 --- a/docs/api/data-store.datastore.datastoresavemessage.md +++ b/docs/api/data-store.datastore.datastoresavemessage.md @@ -8,7 +8,7 @@ hide_title: true ## DataStore.dataStoreSaveMessage() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.datastore.datastoresaveverifiablecredential.md b/docs/api/data-store.datastore.datastoresaveverifiablecredential.md index 4c7b307e..58c672a1 100644 --- a/docs/api/data-store.datastore.datastoresaveverifiablecredential.md +++ b/docs/api/data-store.datastore.datastoresaveverifiablecredential.md @@ -8,7 +8,7 @@ hide_title: true ## DataStore.dataStoreSaveVerifiableCredential() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.datastore.datastoresaveverifiablepresentation.md b/docs/api/data-store.datastore.datastoresaveverifiablepresentation.md index 77b4f541..271cc91f 100644 --- a/docs/api/data-store.datastore.datastoresaveverifiablepresentation.md +++ b/docs/api/data-store.datastore.datastoresaveverifiablepresentation.md @@ -8,7 +8,7 @@ hide_title: true ## DataStore.dataStoreSaveVerifiablePresentation() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.datastore.md b/docs/api/data-store.datastore.md index 514ddd9b..fb28e24f 100644 --- a/docs/api/data-store.datastore.md +++ b/docs/api/data-store.datastore.md @@ -8,7 +8,7 @@ hide_title: true ## DataStore class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This class implements the [IDataStore](./core-types.idatastore.md) interface using a TypeORM compatible database. diff --git a/docs/api/data-store.datastore.methods.md b/docs/api/data-store.datastore.methods.md index 4468f2da..ce39bc18 100644 --- a/docs/api/data-store.datastore.methods.md +++ b/docs/api/data-store.datastore.methods.md @@ -8,7 +8,7 @@ hide_title: true ## DataStore.methods property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.datastore.schema.md b/docs/api/data-store.datastore.schema.md index 0b07c5c2..7051bedc 100644 --- a/docs/api/data-store.datastore.schema.md +++ b/docs/api/data-store.datastore.schema.md @@ -8,7 +8,7 @@ hide_title: true ## DataStore.schema property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.datastorediscoveryprovider.discoverdid.md b/docs/api/data-store.datastorediscoveryprovider.discoverdid.md index 6200be78..d8e2287a 100644 --- a/docs/api/data-store.datastorediscoveryprovider.discoverdid.md +++ b/docs/api/data-store.datastorediscoveryprovider.discoverdid.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreDiscoveryProvider.discoverDid() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.datastorediscoveryprovider.md b/docs/api/data-store.datastorediscoveryprovider.md index 3e098d15..816f0bd3 100644 --- a/docs/api/data-store.datastorediscoveryprovider.md +++ b/docs/api/data-store.datastorediscoveryprovider.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreDiscoveryProvider class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This implementation of [AbstractDidDiscoveryProvider](./did-discovery.abstractdiddiscoveryprovider.md) helps you discover DIDs based on data that is stored by a local plugin that implements [IDataStoreORM](./core-types.idatastoreorm.md). diff --git a/docs/api/data-store.datastorediscoveryprovider.name.md b/docs/api/data-store.datastorediscoveryprovider.name.md index a5e63773..16e83f39 100644 --- a/docs/api/data-store.datastorediscoveryprovider.name.md +++ b/docs/api/data-store.datastorediscoveryprovider.name.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreDiscoveryProvider.name property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.datastoreorm._constructor_.md b/docs/api/data-store.datastoreorm._constructor_.md index 964bd2a3..36983e32 100644 --- a/docs/api/data-store.datastoreorm._constructor_.md +++ b/docs/api/data-store.datastoreorm._constructor_.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreORM.(constructor) -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Constructs a new instance of the `DataStoreORM` class diff --git a/docs/api/data-store.datastoreorm.datastoreormgetidentifiers.md b/docs/api/data-store.datastoreorm.datastoreormgetidentifiers.md index 08d1466f..7b59d588 100644 --- a/docs/api/data-store.datastoreorm.datastoreormgetidentifiers.md +++ b/docs/api/data-store.datastoreorm.datastoreormgetidentifiers.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreORM.dataStoreORMGetIdentifiers() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.datastoreorm.datastoreormgetidentifierscount.md b/docs/api/data-store.datastoreorm.datastoreormgetidentifierscount.md index d01c43d0..d41daac2 100644 --- a/docs/api/data-store.datastoreorm.datastoreormgetidentifierscount.md +++ b/docs/api/data-store.datastoreorm.datastoreormgetidentifierscount.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreORM.dataStoreORMGetIdentifiersCount() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.datastoreorm.datastoreormgetmessages.md b/docs/api/data-store.datastoreorm.datastoreormgetmessages.md index 1010f26e..4f0e00f2 100644 --- a/docs/api/data-store.datastoreorm.datastoreormgetmessages.md +++ b/docs/api/data-store.datastoreorm.datastoreormgetmessages.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreORM.dataStoreORMGetMessages() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.datastoreorm.datastoreormgetmessagescount.md b/docs/api/data-store.datastoreorm.datastoreormgetmessagescount.md index 4a7c4699..b8761158 100644 --- a/docs/api/data-store.datastoreorm.datastoreormgetmessagescount.md +++ b/docs/api/data-store.datastoreorm.datastoreormgetmessagescount.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreORM.dataStoreORMGetMessagesCount() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.datastoreorm.datastoreormgetverifiablecredentials.md b/docs/api/data-store.datastoreorm.datastoreormgetverifiablecredentials.md index 925bb2d2..e28b03b9 100644 --- a/docs/api/data-store.datastoreorm.datastoreormgetverifiablecredentials.md +++ b/docs/api/data-store.datastoreorm.datastoreormgetverifiablecredentials.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreORM.dataStoreORMGetVerifiableCredentials() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.datastoreorm.datastoreormgetverifiablecredentialsbyclaims.md b/docs/api/data-store.datastoreorm.datastoreormgetverifiablecredentialsbyclaims.md index 04c93a40..1a20465b 100644 --- a/docs/api/data-store.datastoreorm.datastoreormgetverifiablecredentialsbyclaims.md +++ b/docs/api/data-store.datastoreorm.datastoreormgetverifiablecredentialsbyclaims.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreORM.dataStoreORMGetVerifiableCredentialsByClaims() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.datastoreorm.datastoreormgetverifiablecredentialsbyclaimscount.md b/docs/api/data-store.datastoreorm.datastoreormgetverifiablecredentialsbyclaimscount.md index 18fe0359..483bae5e 100644 --- a/docs/api/data-store.datastoreorm.datastoreormgetverifiablecredentialsbyclaimscount.md +++ b/docs/api/data-store.datastoreorm.datastoreormgetverifiablecredentialsbyclaimscount.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreORM.dataStoreORMGetVerifiableCredentialsByClaimsCount() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.datastoreorm.datastoreormgetverifiablecredentialscount.md b/docs/api/data-store.datastoreorm.datastoreormgetverifiablecredentialscount.md index f7254839..d96b4d69 100644 --- a/docs/api/data-store.datastoreorm.datastoreormgetverifiablecredentialscount.md +++ b/docs/api/data-store.datastoreorm.datastoreormgetverifiablecredentialscount.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreORM.dataStoreORMGetVerifiableCredentialsCount() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.datastoreorm.datastoreormgetverifiablepresentations.md b/docs/api/data-store.datastoreorm.datastoreormgetverifiablepresentations.md index 0450d3f0..c404a7bf 100644 --- a/docs/api/data-store.datastoreorm.datastoreormgetverifiablepresentations.md +++ b/docs/api/data-store.datastoreorm.datastoreormgetverifiablepresentations.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreORM.dataStoreORMGetVerifiablePresentations() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.datastoreorm.datastoreormgetverifiablepresentationscount.md b/docs/api/data-store.datastoreorm.datastoreormgetverifiablepresentationscount.md index 26d1eb09..5455140b 100644 --- a/docs/api/data-store.datastoreorm.datastoreormgetverifiablepresentationscount.md +++ b/docs/api/data-store.datastoreorm.datastoreormgetverifiablepresentationscount.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreORM.dataStoreORMGetVerifiablePresentationsCount() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.datastoreorm.md b/docs/api/data-store.datastoreorm.md index 9e34d9b4..e867fe72 100644 --- a/docs/api/data-store.datastoreorm.md +++ b/docs/api/data-store.datastoreorm.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreORM class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This class implements the [IDataStoreORM](./core-types.idatastoreorm.md) query interface using a TypeORM compatible database. diff --git a/docs/api/data-store.datastoreorm.methods.md b/docs/api/data-store.datastoreorm.methods.md index 4bcadcf4..09982349 100644 --- a/docs/api/data-store.datastoreorm.methods.md +++ b/docs/api/data-store.datastoreorm.methods.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreORM.methods property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.datastoreorm.schema.md b/docs/api/data-store.datastoreorm.schema.md index d0367e2a..ea1f3e8b 100644 --- a/docs/api/data-store.datastoreorm.schema.md +++ b/docs/api/data-store.datastoreorm.schema.md @@ -8,7 +8,7 @@ hide_title: true ## DataStoreORM.schema property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.entitiesconcat.md b/docs/api/data-store.entitiesconcat.md index 3de0cded..56786ee7 100644 --- a/docs/api/data-store.entitiesconcat.md +++ b/docs/api/data-store.entitiesconcat.md @@ -1,12 +1,12 @@ --- id: data-store.entitiesconcat -title: entitiesConcat variable +title: entitiesConcat() function hide_title: true --- -## entitiesConcat variable +## entitiesConcat() function Helper function to concatenate multiple arrays of TypeORM entities. @@ -17,3 +17,13 @@ This array CAN be used when creating a TypeORM connection. ```typescript entitiesConcat: (...entityArrays: unknown[][]) => unknown[] ``` + +## Parameters + +| Parameter | Type | Description | +| ------------ | --------------- | ----------- | +| entityArrays | unknown\[\]\[\] | | + +**Returns:** + +unknown\[\] diff --git a/docs/api/data-store.identifier.alias.md b/docs/api/data-store.identifier.alias.md index 1e871664..cc4748c2 100644 --- a/docs/api/data-store.identifier.alias.md +++ b/docs/api/data-store.identifier.alias.md @@ -8,7 +8,7 @@ hide_title: true ## Identifier.alias property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.identifier.controllerkeyid.md b/docs/api/data-store.identifier.controllerkeyid.md index 06280034..f3cc8956 100644 --- a/docs/api/data-store.identifier.controllerkeyid.md +++ b/docs/api/data-store.identifier.controllerkeyid.md @@ -8,7 +8,7 @@ hide_title: true ## Identifier.controllerKeyId property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.identifier.did.md b/docs/api/data-store.identifier.did.md index f3347b87..18679aa3 100644 --- a/docs/api/data-store.identifier.did.md +++ b/docs/api/data-store.identifier.did.md @@ -8,7 +8,7 @@ hide_title: true ## Identifier.did property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.identifier.getlatestclaimvalue.md b/docs/api/data-store.identifier.getlatestclaimvalue.md index 812681a1..f01c7aee 100644 --- a/docs/api/data-store.identifier.getlatestclaimvalue.md +++ b/docs/api/data-store.identifier.getlatestclaimvalue.md @@ -8,7 +8,7 @@ hide_title: true ## Identifier.getLatestClaimValue() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Convenience method to get the most recent information about a subject DID as described by Verifiable Credential claims. diff --git a/docs/api/data-store.identifier.issuedclaims.md b/docs/api/data-store.identifier.issuedclaims.md index 4ebc8a46..b2a3f589 100644 --- a/docs/api/data-store.identifier.issuedclaims.md +++ b/docs/api/data-store.identifier.issuedclaims.md @@ -8,7 +8,7 @@ hide_title: true ## Identifier.issuedClaims property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.identifier.issuedcredentials.md b/docs/api/data-store.identifier.issuedcredentials.md index 8e2cea7d..a03d65e4 100644 --- a/docs/api/data-store.identifier.issuedcredentials.md +++ b/docs/api/data-store.identifier.issuedcredentials.md @@ -8,7 +8,7 @@ hide_title: true ## Identifier.issuedCredentials property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.identifier.issuedpresentations.md b/docs/api/data-store.identifier.issuedpresentations.md index 171e0093..aa28147a 100644 --- a/docs/api/data-store.identifier.issuedpresentations.md +++ b/docs/api/data-store.identifier.issuedpresentations.md @@ -8,7 +8,7 @@ hide_title: true ## Identifier.issuedPresentations property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.identifier.keys.md b/docs/api/data-store.identifier.keys.md index 09e8e438..ccf06893 100644 --- a/docs/api/data-store.identifier.keys.md +++ b/docs/api/data-store.identifier.keys.md @@ -8,7 +8,7 @@ hide_title: true ## Identifier.keys property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.identifier.md b/docs/api/data-store.identifier.md index 53d21b7c..56b314da 100644 --- a/docs/api/data-store.identifier.md +++ b/docs/api/data-store.identifier.md @@ -8,7 +8,7 @@ hide_title: true ## Identifier class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Represents some properties and relationships of an [IIdentifier](./core-types.iidentifier.md) that are stored in a TypeORM database for the purpose of keeping track of keys and services associated with a DID managed by a Veramo agent. diff --git a/docs/api/data-store.identifier.provider.md b/docs/api/data-store.identifier.provider.md index a3bfa6e7..3e300585 100644 --- a/docs/api/data-store.identifier.provider.md +++ b/docs/api/data-store.identifier.provider.md @@ -8,7 +8,7 @@ hide_title: true ## Identifier.provider property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.identifier.receivedclaims.md b/docs/api/data-store.identifier.receivedclaims.md index d447e4ad..a9487676 100644 --- a/docs/api/data-store.identifier.receivedclaims.md +++ b/docs/api/data-store.identifier.receivedclaims.md @@ -8,7 +8,7 @@ hide_title: true ## Identifier.receivedClaims property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.identifier.receivedcredentials.md b/docs/api/data-store.identifier.receivedcredentials.md index 84ff2ed8..695d8f5a 100644 --- a/docs/api/data-store.identifier.receivedcredentials.md +++ b/docs/api/data-store.identifier.receivedcredentials.md @@ -8,7 +8,7 @@ hide_title: true ## Identifier.receivedCredentials property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.identifier.receivedmessages.md b/docs/api/data-store.identifier.receivedmessages.md index 290f032d..ccf99244 100644 --- a/docs/api/data-store.identifier.receivedmessages.md +++ b/docs/api/data-store.identifier.receivedmessages.md @@ -8,7 +8,7 @@ hide_title: true ## Identifier.receivedMessages property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.identifier.receivedpresentations.md b/docs/api/data-store.identifier.receivedpresentations.md index c08c2f48..538d67f4 100644 --- a/docs/api/data-store.identifier.receivedpresentations.md +++ b/docs/api/data-store.identifier.receivedpresentations.md @@ -8,7 +8,7 @@ hide_title: true ## Identifier.receivedPresentations property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.identifier.savedate.md b/docs/api/data-store.identifier.savedate.md index 7c8bf166..936b9cda 100644 --- a/docs/api/data-store.identifier.savedate.md +++ b/docs/api/data-store.identifier.savedate.md @@ -8,7 +8,7 @@ hide_title: true ## Identifier.saveDate property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.identifier.sentmessages.md b/docs/api/data-store.identifier.sentmessages.md index f797615f..d3ed356d 100644 --- a/docs/api/data-store.identifier.sentmessages.md +++ b/docs/api/data-store.identifier.sentmessages.md @@ -8,7 +8,7 @@ hide_title: true ## Identifier.sentMessages property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.identifier.services.md b/docs/api/data-store.identifier.services.md index fab47628..550fa92a 100644 --- a/docs/api/data-store.identifier.services.md +++ b/docs/api/data-store.identifier.services.md @@ -8,7 +8,7 @@ hide_title: true ## Identifier.services property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.identifier.setsavedate.md b/docs/api/data-store.identifier.setsavedate.md index 6049436e..8845e92d 100644 --- a/docs/api/data-store.identifier.setsavedate.md +++ b/docs/api/data-store.identifier.setsavedate.md @@ -8,7 +8,7 @@ hide_title: true ## Identifier.setSaveDate() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.identifier.setupdatedate.md b/docs/api/data-store.identifier.setupdatedate.md index 7da0a76d..eff6479a 100644 --- a/docs/api/data-store.identifier.setupdatedate.md +++ b/docs/api/data-store.identifier.setupdatedate.md @@ -8,7 +8,7 @@ hide_title: true ## Identifier.setUpdateDate() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.identifier.shortdid.md b/docs/api/data-store.identifier.shortdid.md index a7212a2c..abd2f888 100644 --- a/docs/api/data-store.identifier.shortdid.md +++ b/docs/api/data-store.identifier.shortdid.md @@ -8,7 +8,7 @@ hide_title: true ## Identifier.shortDid() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.identifier.updatedate.md b/docs/api/data-store.identifier.updatedate.md index 40b82c99..d201e6ae 100644 --- a/docs/api/data-store.identifier.updatedate.md +++ b/docs/api/data-store.identifier.updatedate.md @@ -8,7 +8,7 @@ hide_title: true ## Identifier.updateDate property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.key.identifier.md b/docs/api/data-store.key.identifier.md index 4b296788..e1fbb9e7 100644 --- a/docs/api/data-store.key.identifier.md +++ b/docs/api/data-store.key.identifier.md @@ -8,7 +8,7 @@ hide_title: true ## Key.identifier property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.key.kid.md b/docs/api/data-store.key.kid.md index f7a46100..23098295 100644 --- a/docs/api/data-store.key.kid.md +++ b/docs/api/data-store.key.kid.md @@ -8,7 +8,7 @@ hide_title: true ## Key.kid property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.key.kms.md b/docs/api/data-store.key.kms.md index 88e0415d..259e9dfd 100644 --- a/docs/api/data-store.key.kms.md +++ b/docs/api/data-store.key.kms.md @@ -8,7 +8,7 @@ hide_title: true ## Key.kms property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.key.md b/docs/api/data-store.key.md index 7cae9543..3a9df867 100644 --- a/docs/api/data-store.key.md +++ b/docs/api/data-store.key.md @@ -8,7 +8,7 @@ hide_title: true ## Key class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Represents some properties of a [IKey](./core-types.ikey.md) that are stored in a TypeORM database for the purpose of keeping track of the [AbstractKeyManagementSystem](./key-manager.abstractkeymanagementsystem.md) implementations and the keys they are able to use. diff --git a/docs/api/data-store.key.meta.md b/docs/api/data-store.key.meta.md index 90ffe79b..b783880e 100644 --- a/docs/api/data-store.key.meta.md +++ b/docs/api/data-store.key.meta.md @@ -8,7 +8,7 @@ hide_title: true ## Key.meta property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.key.publickeyhex.md b/docs/api/data-store.key.publickeyhex.md index 93892359..1f9c19c9 100644 --- a/docs/api/data-store.key.publickeyhex.md +++ b/docs/api/data-store.key.publickeyhex.md @@ -8,7 +8,7 @@ hide_title: true ## Key.publicKeyHex property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.key.type.md b/docs/api/data-store.key.type.md index 27eec6d9..f0624171 100644 --- a/docs/api/data-store.key.type.md +++ b/docs/api/data-store.key.type.md @@ -8,7 +8,7 @@ hide_title: true ## Key.type property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.keytype_2.md b/docs/api/data-store.keytype_2.md index 580ae1c4..b75decee 100644 --- a/docs/api/data-store.keytype_2.md +++ b/docs/api/data-store.keytype_2.md @@ -8,7 +8,7 @@ hide_title: true ## KeyType_2 type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Mirrors [TKeyType](./core-types.tkeytype.md) diff --git a/docs/api/data-store.md b/docs/api/data-store.md index fd7eddfc..02bc0775 100644 --- a/docs/api/data-store.md +++ b/docs/api/data-store.md @@ -32,9 +32,10 @@ hide_title: true ## Functions -| Function | Description | -| ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | -| [migrationConcat(migrationArrays)](./data-store.migrationconcat.md) | The migrations helper that allows migrations from multiple sources to be combined into a single array. | +| Function | Description | +| ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | +| [entitiesConcat(entityArrays)](./data-store.entitiesconcat.md) |

Helper function to concatenate multiple arrays of TypeORM entities.

This array CAN be used when creating a TypeORM connection.

| +| [migrationConcat(migrationArrays)](./data-store.migrationconcat.md) | The migrations helper that allows migrations from multiple sources to be combined into a single array. | ## Interfaces @@ -44,11 +45,10 @@ hide_title: true ## Variables -| Variable | Description | -| ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [Entities](./data-store.entities.md) |

The TypeORM entities used by this package.

This array SHOULD be used when creating a TypeORM connection.

| -| [entitiesConcat](./data-store.entitiesconcat.md) |

Helper function to concatenate multiple arrays of TypeORM entities.

This array CAN be used when creating a TypeORM connection.

| -| [migrations](./data-store.migrations.md) |

The migrations array that SHOULD be used when initializing a TypeORM database connection.

These ensure the correct creation of tables and the proper migrations of data when tables change between versions.

| +| Variable | Description | +| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [Entities](./data-store.entities.md) |

The TypeORM entities used by this package.

This array SHOULD be used when creating a TypeORM connection.

| +| [migrations](./data-store.migrations.md) |

The migrations array that SHOULD be used when initializing a TypeORM database connection.

These ensure the correct creation of tables and the proper migrations of data when tables change between versions.

| ## Type Aliases diff --git a/docs/api/data-store.message.createdat.md b/docs/api/data-store.message.createdat.md index fe45b8bc..fdd181b9 100644 --- a/docs/api/data-store.message.createdat.md +++ b/docs/api/data-store.message.createdat.md @@ -8,7 +8,7 @@ hide_title: true ## Message.createdAt property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.message.credentials.md b/docs/api/data-store.message.credentials.md index e70bd56d..82a428d7 100644 --- a/docs/api/data-store.message.credentials.md +++ b/docs/api/data-store.message.credentials.md @@ -8,7 +8,7 @@ hide_title: true ## Message.credentials property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.message.data.md b/docs/api/data-store.message.data.md index 92064186..ba1660e5 100644 --- a/docs/api/data-store.message.data.md +++ b/docs/api/data-store.message.data.md @@ -8,7 +8,7 @@ hide_title: true ## Message.data property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.message.expiresat.md b/docs/api/data-store.message.expiresat.md index 8efe78c8..0b6344a6 100644 --- a/docs/api/data-store.message.expiresat.md +++ b/docs/api/data-store.message.expiresat.md @@ -8,7 +8,7 @@ hide_title: true ## Message.expiresAt property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.message.from.md b/docs/api/data-store.message.from.md index 540e2be8..458f4915 100644 --- a/docs/api/data-store.message.from.md +++ b/docs/api/data-store.message.from.md @@ -8,7 +8,7 @@ hide_title: true ## Message.from property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.message.id.md b/docs/api/data-store.message.id.md index 82ff0bab..989e518b 100644 --- a/docs/api/data-store.message.id.md +++ b/docs/api/data-store.message.id.md @@ -8,7 +8,7 @@ hide_title: true ## Message.id property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.message.md b/docs/api/data-store.message.md index a4ebc24f..78b025e5 100644 --- a/docs/api/data-store.message.md +++ b/docs/api/data-store.message.md @@ -8,7 +8,7 @@ hide_title: true ## Message class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Represents some common properties of an [IMessage](./core-types.imessage.md) that are stored in a TypeORM database for querying. diff --git a/docs/api/data-store.message.metadata.md b/docs/api/data-store.message.metadata.md index d8e86f73..312466b6 100644 --- a/docs/api/data-store.message.metadata.md +++ b/docs/api/data-store.message.metadata.md @@ -8,7 +8,7 @@ hide_title: true ## Message.metaData property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.message.presentations.md b/docs/api/data-store.message.presentations.md index 1512a86d..7879aa13 100644 --- a/docs/api/data-store.message.presentations.md +++ b/docs/api/data-store.message.presentations.md @@ -8,7 +8,7 @@ hide_title: true ## Message.presentations property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.message.raw.md b/docs/api/data-store.message.raw.md index 06f246c9..4c34fb14 100644 --- a/docs/api/data-store.message.raw.md +++ b/docs/api/data-store.message.raw.md @@ -8,7 +8,7 @@ hide_title: true ## Message.raw property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.message.replyto.md b/docs/api/data-store.message.replyto.md index 70ff5bc1..b386d30d 100644 --- a/docs/api/data-store.message.replyto.md +++ b/docs/api/data-store.message.replyto.md @@ -8,7 +8,7 @@ hide_title: true ## Message.replyTo property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.message.replyurl.md b/docs/api/data-store.message.replyurl.md index 51182689..7466433c 100644 --- a/docs/api/data-store.message.replyurl.md +++ b/docs/api/data-store.message.replyurl.md @@ -8,7 +8,7 @@ hide_title: true ## Message.replyUrl property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.message.savedate.md b/docs/api/data-store.message.savedate.md index 5be63a62..acdf9f35 100644 --- a/docs/api/data-store.message.savedate.md +++ b/docs/api/data-store.message.savedate.md @@ -8,7 +8,7 @@ hide_title: true ## Message.saveDate property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.message.setid.md b/docs/api/data-store.message.setid.md index 9c202053..c59afef6 100644 --- a/docs/api/data-store.message.setid.md +++ b/docs/api/data-store.message.setid.md @@ -8,7 +8,7 @@ hide_title: true ## Message.setId() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.message.setsavedate.md b/docs/api/data-store.message.setsavedate.md index f8f77f28..94398d01 100644 --- a/docs/api/data-store.message.setsavedate.md +++ b/docs/api/data-store.message.setsavedate.md @@ -8,7 +8,7 @@ hide_title: true ## Message.setSaveDate() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.message.setupdatedate.md b/docs/api/data-store.message.setupdatedate.md index f03ef7f1..30dc568e 100644 --- a/docs/api/data-store.message.setupdatedate.md +++ b/docs/api/data-store.message.setupdatedate.md @@ -8,7 +8,7 @@ hide_title: true ## Message.setUpdateDate() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.message.threadid.md b/docs/api/data-store.message.threadid.md index e37be588..5207679a 100644 --- a/docs/api/data-store.message.threadid.md +++ b/docs/api/data-store.message.threadid.md @@ -8,7 +8,7 @@ hide_title: true ## Message.threadId property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.message.to.md b/docs/api/data-store.message.to.md index cfa4663f..e0242ef2 100644 --- a/docs/api/data-store.message.to.md +++ b/docs/api/data-store.message.to.md @@ -8,7 +8,7 @@ hide_title: true ## Message.to property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.message.type.md b/docs/api/data-store.message.type.md index b4eccd4d..01513c67 100644 --- a/docs/api/data-store.message.type.md +++ b/docs/api/data-store.message.type.md @@ -8,7 +8,7 @@ hide_title: true ## Message.type property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.message.updatedate.md b/docs/api/data-store.message.updatedate.md index 7e0a3500..347c168c 100644 --- a/docs/api/data-store.message.updatedate.md +++ b/docs/api/data-store.message.updatedate.md @@ -8,7 +8,7 @@ hide_title: true ## Message.updateDate property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.metadata.md b/docs/api/data-store.metadata.md index 580efea7..0615dd0c 100644 --- a/docs/api/data-store.metadata.md +++ b/docs/api/data-store.metadata.md @@ -8,7 +8,7 @@ hide_title: true ## MetaData interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Represents message metadata as it is stored by [DataStore](./data-store.datastore.md). diff --git a/docs/api/data-store.metadata.type.md b/docs/api/data-store.metadata.type.md index 074e2624..1ba391c8 100644 --- a/docs/api/data-store.metadata.type.md +++ b/docs/api/data-store.metadata.type.md @@ -8,7 +8,7 @@ hide_title: true ## MetaData.type property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.metadata.value.md b/docs/api/data-store.metadata.value.md index cc0e7c8f..b3e00381 100644 --- a/docs/api/data-store.metadata.value.md +++ b/docs/api/data-store.metadata.value.md @@ -8,7 +8,7 @@ hide_title: true ## MetaData.value property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.premigrationkey.kid.md b/docs/api/data-store.premigrationkey.kid.md index ed75427f..cefe3f23 100644 --- a/docs/api/data-store.premigrationkey.kid.md +++ b/docs/api/data-store.premigrationkey.kid.md @@ -8,7 +8,7 @@ hide_title: true ## PreMigrationKey.kid property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.premigrationkey.md b/docs/api/data-store.premigrationkey.md index e37d911a..fe5aec5a 100644 --- a/docs/api/data-store.premigrationkey.md +++ b/docs/api/data-store.premigrationkey.md @@ -8,7 +8,7 @@ hide_title: true ## PreMigrationKey class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This represents the private key data of keys that were stored by [KeyStore](./data-store.keystore.md) before Veramo 3.0. During database migration this key material is moved to a different table and accessible by [PrivateKeyStore](./data-store.privatekeystore.md). diff --git a/docs/api/data-store.premigrationkey.privatekeyhex.md b/docs/api/data-store.premigrationkey.privatekeyhex.md index 00a0abf1..10a65ff5 100644 --- a/docs/api/data-store.premigrationkey.privatekeyhex.md +++ b/docs/api/data-store.premigrationkey.privatekeyhex.md @@ -8,7 +8,7 @@ hide_title: true ## PreMigrationKey.privateKeyHex property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.presentation.context.md b/docs/api/data-store.presentation.context.md index ee2ee496..68ffc8d7 100644 --- a/docs/api/data-store.presentation.context.md +++ b/docs/api/data-store.presentation.context.md @@ -8,7 +8,7 @@ hide_title: true ## Presentation.context property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.presentation.credentials.md b/docs/api/data-store.presentation.credentials.md index e6f4e257..c84e04eb 100644 --- a/docs/api/data-store.presentation.credentials.md +++ b/docs/api/data-store.presentation.credentials.md @@ -8,7 +8,7 @@ hide_title: true ## Presentation.credentials property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.presentation.expirationdate.md b/docs/api/data-store.presentation.expirationdate.md index de3ceb3d..4fddf2a0 100644 --- a/docs/api/data-store.presentation.expirationdate.md +++ b/docs/api/data-store.presentation.expirationdate.md @@ -8,7 +8,7 @@ hide_title: true ## Presentation.expirationDate property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.presentation.hash.md b/docs/api/data-store.presentation.hash.md index 7b3e28e4..ba9103f0 100644 --- a/docs/api/data-store.presentation.hash.md +++ b/docs/api/data-store.presentation.hash.md @@ -8,7 +8,7 @@ hide_title: true ## Presentation.hash property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.presentation.holder.md b/docs/api/data-store.presentation.holder.md index debb156c..ad5d5f17 100644 --- a/docs/api/data-store.presentation.holder.md +++ b/docs/api/data-store.presentation.holder.md @@ -8,7 +8,7 @@ hide_title: true ## Presentation.holder property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.presentation.id.md b/docs/api/data-store.presentation.id.md index 7ecf3056..ec9618de 100644 --- a/docs/api/data-store.presentation.id.md +++ b/docs/api/data-store.presentation.id.md @@ -8,7 +8,7 @@ hide_title: true ## Presentation.id property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.presentation.issuancedate.md b/docs/api/data-store.presentation.issuancedate.md index 21097a40..8dbbbd85 100644 --- a/docs/api/data-store.presentation.issuancedate.md +++ b/docs/api/data-store.presentation.issuancedate.md @@ -8,7 +8,7 @@ hide_title: true ## Presentation.issuanceDate property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.presentation.md b/docs/api/data-store.presentation.md index c7a430cf..fb767d9f 100644 --- a/docs/api/data-store.presentation.md +++ b/docs/api/data-store.presentation.md @@ -8,7 +8,7 @@ hide_title: true ## Presentation class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Represents some common properties of a Verifiable Presentation that are stored in a TypeORM database for querying. diff --git a/docs/api/data-store.presentation.messages.md b/docs/api/data-store.presentation.messages.md index dee08939..ae3587cd 100644 --- a/docs/api/data-store.presentation.messages.md +++ b/docs/api/data-store.presentation.messages.md @@ -8,7 +8,7 @@ hide_title: true ## Presentation.messages property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.presentation.raw.md b/docs/api/data-store.presentation.raw.md index 924b9adb..c2eb05be 100644 --- a/docs/api/data-store.presentation.raw.md +++ b/docs/api/data-store.presentation.raw.md @@ -8,7 +8,7 @@ hide_title: true ## Presentation.raw property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.presentation.type.md b/docs/api/data-store.presentation.type.md index b98e8f0f..cfdb16bc 100644 --- a/docs/api/data-store.presentation.type.md +++ b/docs/api/data-store.presentation.type.md @@ -8,7 +8,7 @@ hide_title: true ## Presentation.type property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.presentation.verifier.md b/docs/api/data-store.presentation.verifier.md index d3c20072..d646899d 100644 --- a/docs/api/data-store.presentation.verifier.md +++ b/docs/api/data-store.presentation.verifier.md @@ -8,7 +8,7 @@ hide_title: true ## Presentation.verifier property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.privatekey.alias.md b/docs/api/data-store.privatekey.alias.md index f430bf7d..d312e981 100644 --- a/docs/api/data-store.privatekey.alias.md +++ b/docs/api/data-store.privatekey.alias.md @@ -8,7 +8,7 @@ hide_title: true ## PrivateKey.alias property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.privatekey.md b/docs/api/data-store.privatekey.md index 2cfd5856..33081c7e 100644 --- a/docs/api/data-store.privatekey.md +++ b/docs/api/data-store.privatekey.md @@ -8,7 +8,7 @@ hide_title: true ## PrivateKey class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Represents some properties of a [ManagedPrivateKey](./key-manager.managedprivatekey.md) that are stored in a TypeORM database when using a [PrivateKeyStore](./data-store.privatekeystore.md) to store private key data. diff --git a/docs/api/data-store.privatekey.privatekeyhex.md b/docs/api/data-store.privatekey.privatekeyhex.md index 681f04a0..0234e31b 100644 --- a/docs/api/data-store.privatekey.privatekeyhex.md +++ b/docs/api/data-store.privatekey.privatekeyhex.md @@ -8,7 +8,7 @@ hide_title: true ## PrivateKey.privateKeyHex property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.privatekey.type.md b/docs/api/data-store.privatekey.type.md index 59f28553..34e93c57 100644 --- a/docs/api/data-store.privatekey.type.md +++ b/docs/api/data-store.privatekey.type.md @@ -8,7 +8,7 @@ hide_title: true ## PrivateKey.type property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.service.description.md b/docs/api/data-store.service.description.md index de8ae22d..5a79d09e 100644 --- a/docs/api/data-store.service.description.md +++ b/docs/api/data-store.service.description.md @@ -8,7 +8,7 @@ hide_title: true ## Service.description property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.service.id.md b/docs/api/data-store.service.id.md index 64ae8c9f..b37c7e34 100644 --- a/docs/api/data-store.service.id.md +++ b/docs/api/data-store.service.id.md @@ -8,7 +8,7 @@ hide_title: true ## Service.id property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.service.identifier.md b/docs/api/data-store.service.identifier.md index dfff4a52..ea262a82 100644 --- a/docs/api/data-store.service.identifier.md +++ b/docs/api/data-store.service.identifier.md @@ -8,7 +8,7 @@ hide_title: true ## Service.identifier property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.service.md b/docs/api/data-store.service.md index 475153e6..99111850 100644 --- a/docs/api/data-store.service.md +++ b/docs/api/data-store.service.md @@ -8,7 +8,7 @@ hide_title: true ## Service class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Represents some properties of a as it is stored in a TypeORM database. This is used by [DIDStore](./data-store.didstore.md) to provide information to [DIDManager](./did-manager.didmanager.md) when DID management information is stored in a local TypeORM database. diff --git a/docs/api/data-store.service.serviceendpoint.md b/docs/api/data-store.service.serviceendpoint.md index 4c45e0bc..2eb76448 100644 --- a/docs/api/data-store.service.serviceendpoint.md +++ b/docs/api/data-store.service.serviceendpoint.md @@ -8,7 +8,7 @@ hide_title: true ## Service.serviceEndpoint property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/data-store.service.type.md b/docs/api/data-store.service.type.md index e0a70dfb..ed95f9ec 100644 --- a/docs/api/data-store.service.type.md +++ b/docs/api/data-store.service.type.md @@ -8,7 +8,7 @@ hide_title: true ## Service.type property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.abstractdidcommtransport._constructor_.md b/docs/api/did-comm.abstractdidcommtransport._constructor_.md index f0e76dad..2271b621 100644 --- a/docs/api/did-comm.abstractdidcommtransport._constructor_.md +++ b/docs/api/did-comm.abstractdidcommtransport._constructor_.md @@ -8,7 +8,7 @@ hide_title: true ## AbstractDIDCommTransport.(constructor) -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Shared constructor that takes an optional identifier (for reusing) for this [IDIDCommTransport](./did-comm.ididcommtransport.md). diff --git a/docs/api/did-comm.abstractdidcommtransport.id.md b/docs/api/did-comm.abstractdidcommtransport.id.md index 89326a12..8dd02774 100644 --- a/docs/api/did-comm.abstractdidcommtransport.id.md +++ b/docs/api/did-comm.abstractdidcommtransport.id.md @@ -8,7 +8,7 @@ hide_title: true ## AbstractDIDCommTransport.id property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.abstractdidcommtransport.isservicesupported.md b/docs/api/did-comm.abstractdidcommtransport.isservicesupported.md index 1ca4a356..b28f079e 100644 --- a/docs/api/did-comm.abstractdidcommtransport.isservicesupported.md +++ b/docs/api/did-comm.abstractdidcommtransport.isservicesupported.md @@ -8,7 +8,7 @@ hide_title: true ## AbstractDIDCommTransport.isServiceSupported() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Returns `true` if this transport is suitable for the provided DID Document service section, otherwise `false`. diff --git a/docs/api/did-comm.abstractdidcommtransport.md b/docs/api/did-comm.abstractdidcommtransport.md index 6d21daef..acb7a984 100644 --- a/docs/api/did-comm.abstractdidcommtransport.md +++ b/docs/api/did-comm.abstractdidcommtransport.md @@ -8,7 +8,7 @@ hide_title: true ## AbstractDIDCommTransport class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Abstract implementation of [IDIDCommTransport](./did-comm.ididcommtransport.md). diff --git a/docs/api/did-comm.abstractdidcommtransport.send.md b/docs/api/did-comm.abstractdidcommtransport.send.md index ed62784f..059e91ae 100644 --- a/docs/api/did-comm.abstractdidcommtransport.send.md +++ b/docs/api/did-comm.abstractdidcommtransport.send.md @@ -8,7 +8,7 @@ hide_title: true ## AbstractDIDCommTransport.send() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Sends the provided raw message (without further processing) to the service endpoint defined in the provided DID Document service section. diff --git a/docs/api/did-comm.coordinatemediation.md b/docs/api/did-comm.coordinatemediation.md index 59b8b5bc..68b9d73d 100644 --- a/docs/api/did-comm.coordinatemediation.md +++ b/docs/api/did-comm.coordinatemediation.md @@ -8,7 +8,7 @@ hide_title: true ## CoordinateMediation enum -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/did-comm.coordinatemediationmediatormessagehandler._constructor_.md b/docs/api/did-comm.coordinatemediationmediatormessagehandler._constructor_.md index 3edc0725..27eb45aa 100644 --- a/docs/api/did-comm.coordinatemediationmediatormessagehandler._constructor_.md +++ b/docs/api/did-comm.coordinatemediationmediatormessagehandler._constructor_.md @@ -8,7 +8,7 @@ hide_title: true ## CoordinateMediationMediatorMessageHandler.(constructor) -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Constructs a new instance of the `CoordinateMediationMediatorMessageHandler` class diff --git a/docs/api/did-comm.coordinatemediationmediatormessagehandler.handle.md b/docs/api/did-comm.coordinatemediationmediatormessagehandler.handle.md index d1190c81..312cd6cc 100644 --- a/docs/api/did-comm.coordinatemediationmediatormessagehandler.handle.md +++ b/docs/api/did-comm.coordinatemediationmediatormessagehandler.handle.md @@ -8,7 +8,7 @@ hide_title: true ## CoordinateMediationMediatorMessageHandler.handle() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Handles a Mediator Coordinator messages for the mediator role https://didcomm.org/mediator-coordination/2.0/ diff --git a/docs/api/did-comm.coordinatemediationmediatormessagehandler.md b/docs/api/did-comm.coordinatemediationmediatormessagehandler.md index 591600e8..ebe39ce2 100644 --- a/docs/api/did-comm.coordinatemediationmediatormessagehandler.md +++ b/docs/api/did-comm.coordinatemediationmediatormessagehandler.md @@ -8,7 +8,7 @@ hide_title: true ## CoordinateMediationMediatorMessageHandler class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. A plugin for the [MessageHandler](./message-handler.messagehandler.md) that handles Mediator Coordinator messages for the mediator role. This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/did-comm.coordinatemediationrecipientmessagehandler._constructor_.md b/docs/api/did-comm.coordinatemediationrecipientmessagehandler._constructor_.md index de7d8bc5..4707acf6 100644 --- a/docs/api/did-comm.coordinatemediationrecipientmessagehandler._constructor_.md +++ b/docs/api/did-comm.coordinatemediationrecipientmessagehandler._constructor_.md @@ -8,7 +8,7 @@ hide_title: true ## CoordinateMediationRecipientMessageHandler.(constructor) -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Constructs a new instance of the `CoordinateMediationRecipientMessageHandler` class diff --git a/docs/api/did-comm.coordinatemediationrecipientmessagehandler.handle.md b/docs/api/did-comm.coordinatemediationrecipientmessagehandler.handle.md index 05d6eda5..fe55d9d3 100644 --- a/docs/api/did-comm.coordinatemediationrecipientmessagehandler.handle.md +++ b/docs/api/did-comm.coordinatemediationrecipientmessagehandler.handle.md @@ -8,7 +8,7 @@ hide_title: true ## CoordinateMediationRecipientMessageHandler.handle() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Handles a Mediator Coordinator messages for the recipient role https://didcomm.org/mediator-coordination/2.0/ diff --git a/docs/api/did-comm.coordinatemediationrecipientmessagehandler.md b/docs/api/did-comm.coordinatemediationrecipientmessagehandler.md index 03b3568f..41b7ed71 100644 --- a/docs/api/did-comm.coordinatemediationrecipientmessagehandler.md +++ b/docs/api/did-comm.coordinatemediationrecipientmessagehandler.md @@ -8,7 +8,7 @@ hide_title: true ## CoordinateMediationRecipientMessageHandler class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. A plugin for the [MessageHandler](./message-handler.messagehandler.md) that handles Mediator Coordinator messages for the recipient role. This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/did-comm.coordinatemediationv3mediatormessagehandler._constructor_.md b/docs/api/did-comm.coordinatemediationv3mediatormessagehandler._constructor_.md index a199538f..9d2644c7 100644 --- a/docs/api/did-comm.coordinatemediationv3mediatormessagehandler._constructor_.md +++ b/docs/api/did-comm.coordinatemediationv3mediatormessagehandler._constructor_.md @@ -8,7 +8,7 @@ hide_title: true ## CoordinateMediationV3MediatorMessageHandler.(constructor) -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Constructs a new instance of the `CoordinateMediationV3MediatorMessageHandler` class diff --git a/docs/api/did-comm.coordinatemediationv3mediatormessagehandler.handle.md b/docs/api/did-comm.coordinatemediationv3mediatormessagehandler.handle.md index fdb6404e..316dc664 100644 --- a/docs/api/did-comm.coordinatemediationv3mediatormessagehandler.handle.md +++ b/docs/api/did-comm.coordinatemediationv3mediatormessagehandler.handle.md @@ -8,7 +8,7 @@ hide_title: true ## CoordinateMediationV3MediatorMessageHandler.handle() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Handles a Mediator Coordinator messages for the mediator role https://didcomm.org/mediator-coordination/3.0/ diff --git a/docs/api/did-comm.coordinatemediationv3mediatormessagehandler.md b/docs/api/did-comm.coordinatemediationv3mediatormessagehandler.md index 393ca13f..c6d6bc88 100644 --- a/docs/api/did-comm.coordinatemediationv3mediatormessagehandler.md +++ b/docs/api/did-comm.coordinatemediationv3mediatormessagehandler.md @@ -8,7 +8,7 @@ hide_title: true ## CoordinateMediationV3MediatorMessageHandler class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. A plugin for the [MessageHandler](./message-handler.messagehandler.md) that handles Mediator Coordinator messages for the mediator role. This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/did-comm.coordinatemediationv3mediatormessagehandleroptions.ismediatedefaultgrantall.md b/docs/api/did-comm.coordinatemediationv3mediatormessagehandleroptions.ismediatedefaultgrantall.md index 050a31e0..98274ef0 100644 --- a/docs/api/did-comm.coordinatemediationv3mediatormessagehandleroptions.ismediatedefaultgrantall.md +++ b/docs/api/did-comm.coordinatemediationv3mediatormessagehandleroptions.ismediatedefaultgrantall.md @@ -8,7 +8,7 @@ hide_title: true ## CoordinateMediationV3MediatorMessageHandlerOptions.isMediateDefaultGrantAll property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.coordinatemediationv3mediatormessagehandleroptions.md b/docs/api/did-comm.coordinatemediationv3mediatormessagehandleroptions.md index 4219972d..03bd7cc7 100644 --- a/docs/api/did-comm.coordinatemediationv3mediatormessagehandleroptions.md +++ b/docs/api/did-comm.coordinatemediationv3mediatormessagehandleroptions.md @@ -8,7 +8,7 @@ hide_title: true ## CoordinateMediationV3MediatorMessageHandlerOptions interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/did-comm.coordinatemediationv3recipientmessagehandler._constructor_.md b/docs/api/did-comm.coordinatemediationv3recipientmessagehandler._constructor_.md index beaaa765..d0cbb097 100644 --- a/docs/api/did-comm.coordinatemediationv3recipientmessagehandler._constructor_.md +++ b/docs/api/did-comm.coordinatemediationv3recipientmessagehandler._constructor_.md @@ -8,7 +8,7 @@ hide_title: true ## CoordinateMediationV3RecipientMessageHandler.(constructor) -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Constructs a new instance of the `CoordinateMediationV3RecipientMessageHandler` class diff --git a/docs/api/did-comm.coordinatemediationv3recipientmessagehandler.handle.md b/docs/api/did-comm.coordinatemediationv3recipientmessagehandler.handle.md index d83b91f9..209cd141 100644 --- a/docs/api/did-comm.coordinatemediationv3recipientmessagehandler.handle.md +++ b/docs/api/did-comm.coordinatemediationv3recipientmessagehandler.handle.md @@ -8,7 +8,7 @@ hide_title: true ## CoordinateMediationV3RecipientMessageHandler.handle() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Handles a Mediator Coordinator messages for the recipient role https://didcomm.org/mediator-coordination/2.0/ diff --git a/docs/api/did-comm.coordinatemediationv3recipientmessagehandler.md b/docs/api/did-comm.coordinatemediationv3recipientmessagehandler.md index 0095168e..a1433241 100644 --- a/docs/api/did-comm.coordinatemediationv3recipientmessagehandler.md +++ b/docs/api/did-comm.coordinatemediationv3recipientmessagehandler.md @@ -8,7 +8,7 @@ hide_title: true ## CoordinateMediationV3RecipientMessageHandler class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. A plugin for the [MessageHandler](./message-handler.messagehandler.md) that handles Mediator Coordinator messages for the recipient role. This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/did-comm.createdeliveryrequestmessage.md b/docs/api/did-comm.createdeliveryrequestmessage.md index a29091ac..54bd22b6 100644 --- a/docs/api/did-comm.createdeliveryrequestmessage.md +++ b/docs/api/did-comm.createdeliveryrequestmessage.md @@ -8,7 +8,7 @@ hide_title: true ## createDeliveryRequestMessage() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/did-comm.createmediategrantmessage.md b/docs/api/did-comm.createmediategrantmessage.md index b7a2ba53..f3b0899c 100644 --- a/docs/api/did-comm.createmediategrantmessage.md +++ b/docs/api/did-comm.createmediategrantmessage.md @@ -8,7 +8,7 @@ hide_title: true ## createMediateGrantMessage() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/did-comm.createmediaterequestmessage.md b/docs/api/did-comm.createmediaterequestmessage.md index ddf90349..3ba68f81 100644 --- a/docs/api/did-comm.createmediaterequestmessage.md +++ b/docs/api/did-comm.createmediaterequestmessage.md @@ -8,7 +8,7 @@ hide_title: true ## createMediateRequestMessage() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/did-comm.createstatusrequestmessage.md b/docs/api/did-comm.createstatusrequestmessage.md index d4b4f095..61182e5b 100644 --- a/docs/api/did-comm.createstatusrequestmessage.md +++ b/docs/api/did-comm.createstatusrequestmessage.md @@ -8,7 +8,7 @@ hide_title: true ## createStatusRequestMessage() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/did-comm.createv3deliveryrequestmessage.md b/docs/api/did-comm.createv3deliveryrequestmessage.md index 2ff002bb..78772ca0 100644 --- a/docs/api/did-comm.createv3deliveryrequestmessage.md +++ b/docs/api/did-comm.createv3deliveryrequestmessage.md @@ -1,14 +1,14 @@ --- id: did-comm.createv3deliveryrequestmessage -title: createV3DeliveryRequestMessage variable +title: createV3DeliveryRequestMessage() function hide_title: true --- -## createV3DeliveryRequestMessage variable +## createV3DeliveryRequestMessage() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This API may change without a BREAKING CHANGE notice. @@ -17,3 +17,14 @@ This API may change without a BREAKING CHANGE notice. ```typescript createV3DeliveryRequestMessage: (recipientDidUrl: string, mediatorDidUrl: string) => IDIDCommMessage ``` + +## Parameters + +| Parameter | Type | Description | +| --------------- | ------ | ----------- | +| recipientDidUrl | string | | +| mediatorDidUrl | string | | + +**Returns:** + +[IDIDCommMessage](./did-comm.ididcommmessage.md) diff --git a/docs/api/did-comm.createv3mediatedenymessage.md b/docs/api/did-comm.createv3mediatedenymessage.md index 8c0001c8..a6a9c44d 100644 --- a/docs/api/did-comm.createv3mediatedenymessage.md +++ b/docs/api/did-comm.createv3mediatedenymessage.md @@ -1,14 +1,14 @@ --- id: did-comm.createv3mediatedenymessage -title: createV3MediateDenyMessage variable +title: createV3MediateDenyMessage() function hide_title: true --- -## createV3MediateDenyMessage variable +## createV3MediateDenyMessage() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This API may change without a BREAKING CHANGE notice. @@ -17,3 +17,15 @@ This API may change without a BREAKING CHANGE notice. ```typescript createV3MediateDenyMessage: (recipientDidUrl: string, mediatorDidUrl: string, thid: string) => IDIDCommMessage ``` + +## Parameters + +| Parameter | Type | Description | +| --------------- | ------ | ----------- | +| recipientDidUrl | string | | +| mediatorDidUrl | string | | +| thid | string | | + +**Returns:** + +[IDIDCommMessage](./did-comm.ididcommmessage.md) diff --git a/docs/api/did-comm.createv3mediategrantmessage.md b/docs/api/did-comm.createv3mediategrantmessage.md index b8b4fc03..2a9168b5 100644 --- a/docs/api/did-comm.createv3mediategrantmessage.md +++ b/docs/api/did-comm.createv3mediategrantmessage.md @@ -8,7 +8,7 @@ hide_title: true ## createV3MediateGrantMessage() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/did-comm.createv3mediaterequestmessage.md b/docs/api/did-comm.createv3mediaterequestmessage.md index f049e68c..153e84ec 100644 --- a/docs/api/did-comm.createv3mediaterequestmessage.md +++ b/docs/api/did-comm.createv3mediaterequestmessage.md @@ -8,7 +8,7 @@ hide_title: true ## createV3MediateRequestMessage() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/did-comm.createv3recipientquerymessage.md b/docs/api/did-comm.createv3recipientquerymessage.md index 54004704..cfb8176b 100644 --- a/docs/api/did-comm.createv3recipientquerymessage.md +++ b/docs/api/did-comm.createv3recipientquerymessage.md @@ -1,14 +1,14 @@ --- id: did-comm.createv3recipientquerymessage -title: createV3RecipientQueryMessage variable +title: createV3RecipientQueryMessage() function hide_title: true --- -## createV3RecipientQueryMessage variable +## createV3RecipientQueryMessage() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This API may change without a BREAKING CHANGE notice. @@ -17,3 +17,16 @@ This API may change without a BREAKING CHANGE notice. ```typescript createV3RecipientQueryMessage: (recipientDidUrl: string, mediatorDidUrl: string) => IDIDCommMessage ``` + +## Parameters + +| Parameter | Type | Description | +| --------------- | ------ | ----------- | +| recipientDidUrl | string | | +| mediatorDidUrl | string | | + +**Returns:** + +[IDIDCommMessage](./did-comm.ididcommmessage.md) + +a structured query message for the Mediator Coordinator protocol diff --git a/docs/api/did-comm.createv3recipientqueryresponsemessage.md b/docs/api/did-comm.createv3recipientqueryresponsemessage.md index 2cc7279d..72d7b584 100644 --- a/docs/api/did-comm.createv3recipientqueryresponsemessage.md +++ b/docs/api/did-comm.createv3recipientqueryresponsemessage.md @@ -1,14 +1,14 @@ --- id: did-comm.createv3recipientqueryresponsemessage -title: createV3RecipientQueryResponseMessage variable +title: createV3RecipientQueryResponseMessage() function hide_title: true --- -## createV3RecipientQueryResponseMessage variable +## createV3RecipientQueryResponseMessage() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This API may change without a BREAKING CHANGE notice. @@ -22,3 +22,16 @@ createV3RecipientQueryResponseMessage: ( dids: Record<'recipient_did', RecipientDid>[], ) => IDIDCommMessage ``` + +## Parameters + +| Parameter | Type | Description | +| --------------- | ----------------------------------------------- | ----------- | +| recipientDidUrl | string | | +| mediatorDidUrl | string | | +| thid | string | | +| dids | Record<'recipient_did', RecipientDid>\[\] | | + +**Returns:** + +[IDIDCommMessage](./did-comm.ididcommmessage.md) diff --git a/docs/api/did-comm.createv3recipientupdatemessage.md b/docs/api/did-comm.createv3recipientupdatemessage.md index 0e2d16f7..57e5f8bd 100644 --- a/docs/api/did-comm.createv3recipientupdatemessage.md +++ b/docs/api/did-comm.createv3recipientupdatemessage.md @@ -1,14 +1,14 @@ --- id: did-comm.createv3recipientupdatemessage -title: createV3RecipientUpdateMessage variable +title: createV3RecipientUpdateMessage() function hide_title: true --- -## createV3RecipientUpdateMessage variable +## createV3RecipientUpdateMessage() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This API may change without a BREAKING CHANGE notice. @@ -18,3 +18,17 @@ This API may change without a BREAKING CHANGE notice. createV3RecipientUpdateMessage: (recipientDidUrl: string, mediatorDidUrl: string, updates: Update[]) => IDIDCommMessage ``` + +## Parameters + +| Parameter | Type | Description | +| --------------- | ---------------------------------- | ----------- | +| recipientDidUrl | string | | +| mediatorDidUrl | string | | +| updates | [Update](./did-comm.update.md)\[\] | | + +**Returns:** + +[IDIDCommMessage](./did-comm.ididcommmessage.md) + +a structured upate message for the Mediator Coordinator protocol diff --git a/docs/api/did-comm.createv3recipientupdateresponsemessage.md b/docs/api/did-comm.createv3recipientupdateresponsemessage.md index 40594abd..fd1a7156 100644 --- a/docs/api/did-comm.createv3recipientupdateresponsemessage.md +++ b/docs/api/did-comm.createv3recipientupdateresponsemessage.md @@ -8,7 +8,7 @@ hide_title: true ## createV3RecipientUpdateResponseMessage() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/did-comm.createv3statusrequestmessage.md b/docs/api/did-comm.createv3statusrequestmessage.md index 0db4e7e6..e8debeae 100644 --- a/docs/api/did-comm.createv3statusrequestmessage.md +++ b/docs/api/did-comm.createv3statusrequestmessage.md @@ -1,14 +1,14 @@ --- id: did-comm.createv3statusrequestmessage -title: createV3StatusRequestMessage variable +title: createV3StatusRequestMessage() function hide_title: true --- -## createV3StatusRequestMessage variable +## createV3StatusRequestMessage() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This API may change without a BREAKING CHANGE notice. @@ -17,3 +17,14 @@ This API may change without a BREAKING CHANGE notice. ```typescript createV3StatusRequestMessage: (recipientDidUrl: string, mediatorDidUrl: string) => IDIDCommMessage ``` + +## Parameters + +| Parameter | Type | Description | +| --------------- | ------ | ----------- | +| recipientDidUrl | string | | +| mediatorDidUrl | string | | + +**Returns:** + +[IDIDCommMessage](./did-comm.ididcommmessage.md) diff --git a/docs/api/did-comm.delivery_request_message_type.md b/docs/api/did-comm.delivery_request_message_type.md index 20cc3bcd..c5ec2958 100644 --- a/docs/api/did-comm.delivery_request_message_type.md +++ b/docs/api/did-comm.delivery_request_message_type.md @@ -8,7 +8,7 @@ hide_title: true ## DELIVERY_REQUEST_MESSAGE_TYPE variable -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/did-comm.didcomm._constructor_.md b/docs/api/did-comm.didcomm._constructor_.md index 56a1d027..134ffda8 100644 --- a/docs/api/did-comm.didcomm._constructor_.md +++ b/docs/api/did-comm.didcomm._constructor_.md @@ -8,7 +8,7 @@ hide_title: true ## DIDComm.(constructor) -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Constructor that takes a list of [IDIDCommTransport](./did-comm.ididcommtransport.md) objects. diff --git a/docs/api/did-comm.didcomm.getdidcommmessagemediatype.md b/docs/api/did-comm.didcomm.getdidcommmessagemediatype.md index 6a7e9410..8041a776 100644 --- a/docs/api/did-comm.didcomm.getdidcommmessagemediatype.md +++ b/docs/api/did-comm.didcomm.getdidcommmessagemediatype.md @@ -8,7 +8,7 @@ hide_title: true ## DIDComm.getDidCommMessageMediaType() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Partially decodes a possible DIDComm message string to determine the [DIDCommMessageMediaType](./did-comm.didcommmessagemediatype.md) diff --git a/docs/api/did-comm.didcomm.md b/docs/api/did-comm.didcomm.md index 3f940d7c..92127b7d 100644 --- a/docs/api/did-comm.didcomm.md +++ b/docs/api/did-comm.didcomm.md @@ -8,7 +8,7 @@ hide_title: true ## DIDComm class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. DID Comm plugin for [Agent](./core.agent.md) @@ -36,11 +36,11 @@ This API may change without a BREAKING CHANGE notice. ## Properties -| Property | Modifiers | Type | Description | -| ---------------------------------------------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | -| [methods](./did-comm.didcomm.methods.md) | readonly | [IDIDComm](./did-comm.ididcomm.md) | **_(BETA)_** Plugin methods | -| [schema](./did-comm.didcomm.schema.md) | readonly | { components: { schemas: { IPackedDIDCommMessage: { type: string; properties: { message: { type: string; }; }; required: string\[\]; description: string; }; DIDCommMessageMediaType: { type: string; enum: string\[\]; description: string; }; IPackDIDCommMessageArgs: { type: string; properties: { message: { $ref: string; }; packing: { $ref: string; }; keyRef: { type: string; }; options: { $ref: string; }; }; required: string\[\]; description: string; }; IDIDCommMessage: { type: string; properties: { type: { type: string; }; from: { type: string; }; to: { type: string; }; thid: { type: string; }; pthid: { type: string; }; id: { type: string; }; expires_time: { type: string; }; created_time: { type: string; }; next: { type: string; }; from_prior: { type: string; }; body: {}; attachments: { type: string; items: { $ref: string; }; }; return_route: { type: string; }; }; required: string\[\]; description: string; }; IDIDCommMessageAttachment: { type: string; properties: { id: { type: string; }; description: { type: string; }; filename: { type: string; }; media_type: { type: string; }; format: { type: string; }; lastmod_time: { type: string; }; byte_count: { type: string; }; data: { $ref: string; }; }; required: string\[\]; description: string; }; IDIDCommMessageAttachmentData: { type: string; properties: { jws: {}; hash: { type: string; }; links: { type: string; items: { type: string; }; }; base64: { type: string; }; json: {}; }; description: string; }; DIDCommMessagePacking: { type: string; enum: string\[\]; description: string; }; IDIDCommOptions: { type: string; properties: { bcc: { type: string; items: { type: string; }; description: string; }; recipientKids: { type: string; items: { type: string; }; description: string; }; enc: { type: string; enum: string\[\]; description: string; }; alg: { type: string; enum: string\[\]; description: string; }; }; description: string; }; ISendDIDCommMessageArgs: { type: string; properties: { packedMessage: { $ref: string; }; messageId: { type: string; }; returnTransportId: { type: string; }; recipientDidUrl: { type: string; }; }; required: string\[\]; description: string; }; ISendDIDCommMessageResponse: { type: string; properties: { transportId: { type: string; }; returnMessage: { $ref: 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; }; attachments: { type: string; items: { $ref: string; }; description: string; }; returnRoute: { 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; }; VerifiableCredential: { type: string; properties: { proof: { $ref: string; }; issuer: { $ref: string; }; credentialSubject: { $ref: string; }; type: { anyOf: ({ type: string; items: { type: string; }; } | { type: string; items?: undefined; })\[\]; }; "@context": { $ref: string; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; credentialStatus: { $ref: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; ProofType: { type: string; properties: { type: { type: string; }; }; description: string; }; IssuerType: { anyOf: ({ type: string; properties: { id: { type: string; }; }; required: string\[\]; } | { type: string; properties?: undefined; required?: undefined; })\[\]; description: string; }; CredentialSubject: { type: string; properties: { id: { type: string; }; }; description: string; }; ContextType: { anyOf: ({ type: string; items?: undefined; } | { type: string; items: { anyOf: { type: string; }\[\]; }; })\[\]; description: string; }; CredentialStatusReference: { type: string; properties: { id: { type: string; }; type: { type: string; }; }; required: string\[\]; description: string; }; VerifiablePresentation: { type: string; properties: { proof: { $ref: string; }; holder: { type: string; }; verifiableCredential: { type: string; items: { $ref: string; }; }; type: { anyOf: ({ type: string; items: { type: string; }; } | { type: string; items?: undefined; })\[\]; }; "@context": { $ref: string; }; verifier: { type: string; items: { type: string; }; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; W3CVerifiableCredential: { anyOf: { $ref: string; }\[\]; description: string; }; CompactJWT: { type: string; description: string; }; IMessageAttachment: { type: string; properties: { id: { type: string; }; description: { type: string; }; filename: { type: string; }; media_type: { type: string; }; format: { type: string; }; lastmod_time: { type: string; }; byte_count: { type: string; }; data: { $ref: string; }; }; required: string\[\]; description: string; }; IMessageAttachmentData: { type: string; properties: { jws: {}; hash: { type: string; }; links: { type: string; items: { type: string; }; }; base64: { type: string; }; json: {}; }; description: string; }; 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\[\]; }; headers: { type: string; additionalProperties: { type: string; }; }; }; required: string\[\]; deprecated: string; }; IUnpackDIDCommMessageArgs: { $ref: string; description: string; }; IUnpackedDIDCommMessage: { type: string; properties: { metaData: { $ref: string; }; message: { $ref: string; }; }; required: string\[\]; description: string; }; IDIDCommMessageMetaData: { type: string; properties: { packing: { $ref: string; }; }; required: string\[\]; description: string; }; }; methods: { getDIDCommMessageMediaType: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; packDIDCommMessage: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; sendDIDCommMessage: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; sendMessageDIDCommAlpha1: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; unpackDIDCommMessage: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; }; }; } | **_(BETA)_** | -| [transports](./did-comm.didcomm.transports.md) | readonly | [IDIDCommTransport](./did-comm.ididcommtransport.md)\[\] | **_(BETA)_** | +| Property | Modifiers | Type | Description | +| ---------------------------------------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | +| [methods](./did-comm.didcomm.methods.md) | readonly | [IDIDComm](./did-comm.ididcomm.md) | **_(BETA)_** Plugin methods | +| [schema](./did-comm.didcomm.schema.md) | readonly | { components: { schemas: { IPackedDIDCommMessage: { type: string; properties: { message: { type: string; }; }; required: string\[\]; description: string; }; DIDCommMessageMediaType: { type: string; enum: string\[\]; description: string; }; IPackDIDCommMessageArgs: { type: string; properties: { resolutionOptions: { type: string; properties: { publicKeyFormat: { type: string; }; accept: { type: string; }; }; description: string; }; message: { $ref: string; }; packing: { $ref: string; }; keyRef: { type: string; }; options: { $ref: string; }; }; required: string\[\]; description: string; }; IDIDCommMessage: { type: string; properties: { id: { type: string; }; type: { type: string; }; from: { type: string; }; to: { type: string; items: { type: string; }; }; thid: { type: string; }; pthid: { type: string; }; expires_time: { type: string; }; created_time: { type: string; }; next: { type: string; }; from_prior: { type: string; }; body: {}; attachments: { type: string; items: { $ref: string; }; }; return_route: { type: string; }; }; required: string\[\]; description: string; }; IDIDCommMessageAttachment: { type: string; properties: { id: { type: string; }; description: { type: string; }; filename: { type: string; }; media_type: { type: string; }; format: { type: string; }; lastmod_time: { type: string; }; byte_count: { type: string; }; data: { $ref: string; }; }; /\*\* Plugin methods \*/ required: string\[\]; description: string; }; IDIDCommMessageAttachmentData: { type: string; properties: { jws: {}; hash: { type: string; }; links: { type: string; items: { type: string; }; }; base64: { type: string; }; json: {}; }; description: string; }; DIDCommMessagePacking: { type: string; enum: string\[\]; description: string; }; IDIDCommOptions: { type: string; properties: { bcc: { type: string; items: { type: string; }; description: string; }; recipientKids: { type: string; items: { type: string; }; description: string; }; enc: { type: string; enum: string\[\]; description: string; }; alg: { type: string; enum: string\[\]; description: string; }; }; description: string; }; ISendDIDCommMessageArgs: { type: string; properties: { resolutionOptions: { type: string; properties: { publicKeyFormat: { type: string; }; accept: { type: string; }; }; description: string; }; packedMessage: { $ref: string; }; messageId: { type: string; }; returnTransportId: { type: string; }; recipientDidUrl: { type: string; }; }; required: string\[\]; description: string; }; ISendDIDCommMessageResponse: { type: string; properties: { transportId: { type: string; }; returnMessage: { $ref: 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; }; attachments: { type: string; items: { $ref: string; }; description: string; }; returnRoute: { 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; }; VerifiableCredential: { type: string; properties: { proof: { $ref: string; }; issuer: { $ref: string; }; credentialSubject: { $ref: string; }; type: { anyOf: ({ type: string; items: { type: string; }; } | { type: string; items?: undefined; })\[\]; }; "@context": { $ref: string; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; credentialStatus: { $ref: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; ProofType: { type: string; properties: { type: { type: string; }; }; description: string; }; IssuerType: { anyOf: ({ type: string; properties: { id: { type: string; }; }; required: string\[\]; } | { type: string; properties?: undefined; required?: undefined; })\[\]; description: string; }; CredentialSubject: { type: string; properties: { id: { type: string; }; }; description: string; }; ContextType: { anyOf: ({ type: string; items?: undefined; } | { type: string; items: { anyOf: { type: string; }\[\]; }; })\[\]; description: string; }; CredentialStatusReference: { type: string; properties: { id: { type: string; }; type: { type: string; }; }; required: string\[\]; description: string; }; VerifiablePresentation: { type: string; properties: { proof: { $ref: string; }; holder: { type: string; }; verifiableCredential: { type: string; items: { $ref: string; }; }; type: { anyOf: ({ type: string; items: { type: string; }; } | { type: string; items?: undefined; })\[\]; }; "@context": { $ref: string; }; verifier: { type: string; items: { type: string; }; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; W3CVerifiableCredential: { anyOf: { $ref: string; }\[\]; description: string; }; CompactJWT: { type: string; description: string; }; IMessageAttachment: { type: string; properties: { id: { type: string; }; description: { type: string; }; filename: { type: string; }; media_type: { type: string; }; format: { type: string; }; lastmod_time: { type: string; }; byte_count: { type: string; }; data: { $ref: string; }; }; required: string\[\]; description: string; }; IMessageAttachmentData: { type: string; properties: { jws: {}; hash: { type: string; }; links: { type: string; items: { type: string; }; }; base64: { type: string; }; json: {}; }; description: string; }; 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\[\]; }; headers: { type: string; additionalProperties: { type: string; }; }; }; required: string\[\]; deprecated: string; }; IUnpackDIDCommMessageArgs: { type: string; properties: { resolutionOptions: { type: string; properties: { publicKeyFormat: { type: string; }; accept: { type: string; }; }; description: string; }; message: { type: string; }; }; required: string\[\]; description: string; }; IUnpackedDIDCommMessage: { type: string; properties: { metaData: { $ref: string; }; message: { $ref: string; }; }; required: string\[\]; description: string; }; IDIDCommMessageMetaData: { type: string; properties: { packing: { $ref: string; }; }; required: string\[\]; description: string; }; }; methods: { getDIDCommMessageMediaType: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; packDIDCommMessage: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; sendDIDCommMessage: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; sendMessageDIDCommAlpha1: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; unpackDIDCommMessage: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; }; }; } | **_(BETA)_** | +| [transports](./did-comm.didcomm.transports.md) | readonly | [IDIDCommTransport](./did-comm.ididcommtransport.md)\[\] | **_(BETA)_** | ## Methods diff --git a/docs/api/did-comm.didcomm.methods.md b/docs/api/did-comm.didcomm.methods.md index da10402a..73d2ff2d 100644 --- a/docs/api/did-comm.didcomm.methods.md +++ b/docs/api/did-comm.didcomm.methods.md @@ -8,7 +8,7 @@ hide_title: true ## DIDComm.methods property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Plugin methods diff --git a/docs/api/did-comm.didcomm.packdidcommmessage.md b/docs/api/did-comm.didcomm.packdidcommmessage.md index 91a84b6f..7ace3ba5 100644 --- a/docs/api/did-comm.didcomm.packdidcommmessage.md +++ b/docs/api/did-comm.didcomm.packdidcommmessage.md @@ -8,7 +8,7 @@ hide_title: true ## DIDComm.packDIDCommMessage() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Packs a [IDIDCommMessage](./did-comm.ididcommmessage.md) using one of the [DIDCommMessagePacking](./did-comm.didcommmessagepacking.md) options. diff --git a/docs/api/did-comm.didcomm.schema.md b/docs/api/did-comm.didcomm.schema.md index d4202a01..df5eca35 100644 --- a/docs/api/did-comm.didcomm.schema.md +++ b/docs/api/did-comm.didcomm.schema.md @@ -8,7 +8,7 @@ hide_title: true ## DIDComm.schema property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** @@ -34,6 +34,18 @@ readonly schema: { IPackDIDCommMessageArgs: { type: string; properties: { + resolutionOptions: { + type: string; + properties: { + publicKeyFormat: { + type: string; + }; + accept: { + type: string; + }; + }; + description: string; + }; message: { $ref: string; }; @@ -53,6 +65,9 @@ readonly schema: { IDIDCommMessage: { type: string; properties: { + id: { + type: string; + }; type: { type: string; }; @@ -61,6 +76,9 @@ readonly schema: { }; to: { type: string; + items: { + type: string; + }; }; thid: { type: string; @@ -68,9 +86,6 @@ readonly schema: { pthid: { type: string; }; - id: { - type: string; - }; expires_time: { type: string; }; @@ -124,7 +139,7 @@ readonly schema: { data: { $ref: string; }; - }; + }; /** Plugin methods */ required: string[]; description: string; }; @@ -186,6 +201,18 @@ readonly schema: { ISendDIDCommMessageArgs: { type: string; properties: { + resolutionOptions: { + type: string; + properties: { + publicKeyFormat: { + type: string; + }; + accept: { + type: string; + }; + }; + description: string; + }; packedMessage: { $ref: string; }; @@ -578,7 +605,25 @@ readonly schema: { deprecated: string; }; IUnpackDIDCommMessageArgs: { - $ref: string; + type: string; + properties: { + resolutionOptions: { + type: string; + properties: { + publicKeyFormat: { + type: string; + }; + accept: { + type: string; + }; + }; + description: string; + }; + message: { + type: string; + }; + }; + required: string[]; description: string; }; IUnpackedDIDCommMessage: { diff --git a/docs/api/did-comm.didcomm.senddidcommmessage.md b/docs/api/did-comm.didcomm.senddidcommmessage.md index 52da7171..59253c62 100644 --- a/docs/api/did-comm.didcomm.senddidcommmessage.md +++ b/docs/api/did-comm.didcomm.senddidcommmessage.md @@ -8,7 +8,7 @@ hide_title: true ## DIDComm.sendDIDCommMessage() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Sends the given message to the recipient. If a return-transport is provided it will be checked whether the parent thread allows reusing the route. You cannot reuse the transport if the message was forwarded from a DIDComm mediator. diff --git a/docs/api/did-comm.didcomm.sendmessagedidcommalpha1.md b/docs/api/did-comm.didcomm.sendmessagedidcommalpha1.md index 2166cc1e..b4f1ab11 100644 --- a/docs/api/did-comm.didcomm.sendmessagedidcommalpha1.md +++ b/docs/api/did-comm.didcomm.sendmessagedidcommalpha1.md @@ -8,7 +8,7 @@ hide_title: true ## DIDComm.sendMessageDIDCommAlpha1() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.didcomm.transports.md b/docs/api/did-comm.didcomm.transports.md index 1a2d7ca2..9be2d5e3 100644 --- a/docs/api/did-comm.didcomm.transports.md +++ b/docs/api/did-comm.didcomm.transports.md @@ -8,7 +8,7 @@ hide_title: true ## DIDComm.transports property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.didcomm.unpackdidcommmessage.md b/docs/api/did-comm.didcomm.unpackdidcommmessage.md index 924df93a..23d8972a 100644 --- a/docs/api/did-comm.didcomm.unpackdidcommmessage.md +++ b/docs/api/did-comm.didcomm.unpackdidcommmessage.md @@ -8,7 +8,7 @@ hide_title: true ## DIDComm.unpackDIDCommMessage() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Unpacks a possible DIDComm message and returns the [IDIDCommMessage](./did-comm.ididcommmessage.md) and [DIDCommMessagePacking](./did-comm.didcommmessagepacking.md) used to pack it. diff --git a/docs/api/did-comm.didcommconfig.md b/docs/api/did-comm.didcommconfig.md index 4c417826..9656da04 100644 --- a/docs/api/did-comm.didcommconfig.md +++ b/docs/api/did-comm.didcommconfig.md @@ -8,7 +8,7 @@ hide_title: true ## DIDCommConfig interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The config for the [DIDComm](./did-comm.didcomm.md) DIDComm plugin. diff --git a/docs/api/did-comm.didcommconfig.transports.md b/docs/api/did-comm.didcommconfig.transports.md index 2cfb6375..150de9b8 100644 --- a/docs/api/did-comm.didcommconfig.transports.md +++ b/docs/api/did-comm.didcommconfig.transports.md @@ -8,7 +8,7 @@ hide_title: true ## DIDCommConfig.transports property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.didcommhttptransport._constructor_.md b/docs/api/did-comm.didcommhttptransport._constructor_.md index 915a2b85..5ac77750 100644 --- a/docs/api/did-comm.didcommhttptransport._constructor_.md +++ b/docs/api/did-comm.didcommhttptransport._constructor_.md @@ -8,7 +8,7 @@ hide_title: true ## DIDCommHttpTransport.(constructor) -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Creates a new [DIDCommHttpTransport](./did-comm.didcommhttptransport.md). diff --git a/docs/api/did-comm.didcommhttptransport.httpmethod.md b/docs/api/did-comm.didcommhttptransport.httpmethod.md index d527465e..3556ce71 100644 --- a/docs/api/did-comm.didcommhttptransport.httpmethod.md +++ b/docs/api/did-comm.didcommhttptransport.httpmethod.md @@ -8,7 +8,7 @@ hide_title: true ## DIDCommHttpTransport.httpMethod property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Defines the default HTTP method to use if not specified in the DID Document service entry of the recipient. diff --git a/docs/api/did-comm.didcommhttptransport.isservicesupported.md b/docs/api/did-comm.didcommhttptransport.isservicesupported.md index 0bf8670e..949e41ee 100644 --- a/docs/api/did-comm.didcommhttptransport.isservicesupported.md +++ b/docs/api/did-comm.didcommhttptransport.isservicesupported.md @@ -8,7 +8,7 @@ hide_title: true ## DIDCommHttpTransport.isServiceSupported() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Returns `true` if this transport is suitable for the provided DID Document service section, otherwise `false`. diff --git a/docs/api/did-comm.didcommhttptransport.md b/docs/api/did-comm.didcommhttptransport.md index 1c69be0d..52e00282 100644 --- a/docs/api/did-comm.didcommhttptransport.md +++ b/docs/api/did-comm.didcommhttptransport.md @@ -8,7 +8,7 @@ hide_title: true ## DIDCommHttpTransport class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Implementation of [IDIDCommTransport](./did-comm.ididcommtransport.md) to provide a simple transport based on HTTP(S) requests. diff --git a/docs/api/did-comm.didcommhttptransport.send.md b/docs/api/did-comm.didcommhttptransport.send.md index 95dd4bba..3fa6871a 100644 --- a/docs/api/did-comm.didcommhttptransport.send.md +++ b/docs/api/did-comm.didcommhttptransport.send.md @@ -8,7 +8,7 @@ hide_title: true ## DIDCommHttpTransport.send() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Sends the provided raw message (without further processing) to the service endpoint defined in the provided DID Document service section. diff --git a/docs/api/did-comm.didcommmessagehandler._constructor_.md b/docs/api/did-comm.didcommmessagehandler._constructor_.md index 8c0320c2..759ff021 100644 --- a/docs/api/did-comm.didcommmessagehandler._constructor_.md +++ b/docs/api/did-comm.didcommmessagehandler._constructor_.md @@ -8,7 +8,7 @@ hide_title: true ## DIDCommMessageHandler.(constructor) -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Constructs a new instance of the `DIDCommMessageHandler` class diff --git a/docs/api/did-comm.didcommmessagehandler.handle.md b/docs/api/did-comm.didcommmessagehandler.handle.md index c7ecfa3d..3f42e377 100644 --- a/docs/api/did-comm.didcommmessagehandler.handle.md +++ b/docs/api/did-comm.didcommmessagehandler.handle.md @@ -8,7 +8,7 @@ hide_title: true ## DIDCommMessageHandler.handle() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Handles a new packed DIDCommV2 Message (also Alpha support but soon deprecated). - Tests whether raw message is a DIDCommV2 message - Unpacks raw message (JWM/JWE/JWS, or plain JSON). - diff --git a/docs/api/did-comm.didcommmessagehandler.md b/docs/api/did-comm.didcommmessagehandler.md index 785f22eb..88bc1e83 100644 --- a/docs/api/did-comm.didcommmessagehandler.md +++ b/docs/api/did-comm.didcommmessagehandler.md @@ -8,7 +8,7 @@ hide_title: true ## DIDCommMessageHandler class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. A plugin for the [MessageHandler](./message-handler.messagehandler.md) that decrypts DIDComm messages. This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/did-comm.didcommmessagemediatype.md b/docs/api/did-comm.didcommmessagemediatype.md index 9595598f..97876840 100644 --- a/docs/api/did-comm.didcommmessagemediatype.md +++ b/docs/api/did-comm.didcommmessagemediatype.md @@ -8,7 +8,7 @@ hide_title: true ## DIDCommMessageMediaType enum -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Represents different DIDComm v2 message encapsulation. diff --git a/docs/api/did-comm.didcommmessagepacking.md b/docs/api/did-comm.didcommmessagepacking.md index 3c064019..9dcbad49 100644 --- a/docs/api/did-comm.didcommmessagepacking.md +++ b/docs/api/did-comm.didcommmessagepacking.md @@ -8,7 +8,7 @@ hide_title: true ## DIDCommMessagePacking type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The possible types of message packing. diff --git a/docs/api/did-comm.ididcomm.getdidcommmessagemediatype.md b/docs/api/did-comm.ididcomm.getdidcommmessagemediatype.md index 966902b7..18b7b913 100644 --- a/docs/api/did-comm.ididcomm.getdidcommmessagemediatype.md +++ b/docs/api/did-comm.ididcomm.getdidcommmessagemediatype.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDComm.getDIDCommMessageMediaType() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Partially decodes a possible DIDComm message string to determine the [DIDCommMessageMediaType](./did-comm.didcommmessagemediatype.md) diff --git a/docs/api/did-comm.ididcomm.md b/docs/api/did-comm.ididcomm.md index c07163e5..6df2d515 100644 --- a/docs/api/did-comm.ididcomm.md +++ b/docs/api/did-comm.ididcomm.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDComm interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. DID Comm plugin interface for [Agent](./core.agent.md) diff --git a/docs/api/did-comm.ididcomm.packdidcommmessage.md b/docs/api/did-comm.ididcomm.packdidcommmessage.md index 12e0ad31..2e2ab215 100644 --- a/docs/api/did-comm.ididcomm.packdidcommmessage.md +++ b/docs/api/did-comm.ididcomm.packdidcommmessage.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDComm.packDIDCommMessage() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Packs a [IDIDCommMessage](./did-comm.ididcommmessage.md) using one of the [DIDCommMessagePacking](./did-comm.didcommmessagepacking.md) options. diff --git a/docs/api/did-comm.ididcomm.senddidcommmessage.md b/docs/api/did-comm.ididcomm.senddidcommmessage.md index 1e1faced..a30724a2 100644 --- a/docs/api/did-comm.ididcomm.senddidcommmessage.md +++ b/docs/api/did-comm.ididcomm.senddidcommmessage.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDComm.sendDIDCommMessage() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Sends the given message to the recipient. If a return-transport is provided it will be checked whether the parent thread allows reusing the route. You cannot reuse the transport if the message was forwarded from a DIDComm mediator. diff --git a/docs/api/did-comm.ididcomm.sendmessagedidcommalpha1.md b/docs/api/did-comm.ididcomm.sendmessagedidcommalpha1.md index c56be5e0..c452a014 100644 --- a/docs/api/did-comm.ididcomm.sendmessagedidcommalpha1.md +++ b/docs/api/did-comm.ididcomm.sendmessagedidcommalpha1.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDComm.sendMessageDIDCommAlpha1() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. > Warning: This API is now obsolete. > diff --git a/docs/api/did-comm.ididcomm.unpackdidcommmessage.md b/docs/api/did-comm.ididcomm.unpackdidcommmessage.md index 431abf84..42491089 100644 --- a/docs/api/did-comm.ididcomm.unpackdidcommmessage.md +++ b/docs/api/did-comm.ididcomm.unpackdidcommmessage.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDComm.unpackDIDCommMessage() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Unpacks a possible DIDComm message and returns the [IDIDCommMessage](./did-comm.ididcommmessage.md) and [DIDCommMessagePacking](./did-comm.didcommmessagepacking.md) used to pack it. diff --git a/docs/api/did-comm.ididcommmessage.attachments.md b/docs/api/did-comm.ididcommmessage.attachments.md index 7e94e585..5cf8a0f4 100644 --- a/docs/api/did-comm.ididcommmessage.attachments.md +++ b/docs/api/did-comm.ididcommmessage.attachments.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommMessage.attachments property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.ididcommmessage.body.md b/docs/api/did-comm.ididcommmessage.body.md index 163a8b5f..4335178d 100644 --- a/docs/api/did-comm.ididcommmessage.body.md +++ b/docs/api/did-comm.ididcommmessage.body.md @@ -8,10 +8,10 @@ hide_title: true ## IDIDCommMessage.body property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** ```typescript -body: any +body?: any; ``` diff --git a/docs/api/did-comm.ididcommmessage.created_time.md b/docs/api/did-comm.ididcommmessage.created_time.md index ed2c619a..a3dcf19b 100644 --- a/docs/api/did-comm.ididcommmessage.created_time.md +++ b/docs/api/did-comm.ididcommmessage.created_time.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommMessage.created_time property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.ididcommmessage.expires_time.md b/docs/api/did-comm.ididcommmessage.expires_time.md index b032c85c..4bd700cf 100644 --- a/docs/api/did-comm.ididcommmessage.expires_time.md +++ b/docs/api/did-comm.ididcommmessage.expires_time.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommMessage.expires_time property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.ididcommmessage.from.md b/docs/api/did-comm.ididcommmessage.from.md index 9ef850d0..c8a1c98b 100644 --- a/docs/api/did-comm.ididcommmessage.from.md +++ b/docs/api/did-comm.ididcommmessage.from.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommMessage.from property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.ididcommmessage.from_prior.md b/docs/api/did-comm.ididcommmessage.from_prior.md index c597f69c..e4b4e0be 100644 --- a/docs/api/did-comm.ididcommmessage.from_prior.md +++ b/docs/api/did-comm.ididcommmessage.from_prior.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommMessage.from_prior property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.ididcommmessage.id.md b/docs/api/did-comm.ididcommmessage.id.md index 126a85cb..23b7e1be 100644 --- a/docs/api/did-comm.ididcommmessage.id.md +++ b/docs/api/did-comm.ididcommmessage.id.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommMessage.id property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.ididcommmessage.md b/docs/api/did-comm.ididcommmessage.md index ed490d8d..5fe38e33 100644 --- a/docs/api/did-comm.ididcommmessage.md +++ b/docs/api/did-comm.ididcommmessage.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommMessage interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The DIDComm message structure. See https://identity.foundation/didcomm-messaging/spec/\#plaintext-message-structure @@ -25,7 +25,7 @@ export interface IDIDCommMessage | Property | Modifiers | Type | Description | | ----------------------------------------------------------- | --------- | ------------------------------------------------------------------------ | ------------------------- | | [attachments?](./did-comm.ididcommmessage.attachments.md) | | [IDIDCommMessageAttachment](./did-comm.ididcommmessageattachment.md)\[\] | **_(BETA)_** _(Optional)_ | -| [body](./did-comm.ididcommmessage.body.md) | | any | **_(BETA)_** | +| [body?](./did-comm.ididcommmessage.body.md) | | any | **_(BETA)_** _(Optional)_ | | [created_time?](./did-comm.ididcommmessage.created_time.md) | | string | **_(BETA)_** _(Optional)_ | | [expires_time?](./did-comm.ididcommmessage.expires_time.md) | | string | **_(BETA)_** _(Optional)_ | | [from_prior?](./did-comm.ididcommmessage.from_prior.md) | | string | **_(BETA)_** _(Optional)_ | @@ -35,5 +35,5 @@ export interface IDIDCommMessage | [pthid?](./did-comm.ididcommmessage.pthid.md) | | string | **_(BETA)_** _(Optional)_ | | [return_route?](./did-comm.ididcommmessage.return_route.md) | | string | **_(BETA)_** _(Optional)_ | | [thid?](./did-comm.ididcommmessage.thid.md) | | string | **_(BETA)_** _(Optional)_ | -| [to](./did-comm.ididcommmessage.to.md) | | string | **_(BETA)_** | +| [to?](./did-comm.ididcommmessage.to.md) | | string\[\] | **_(BETA)_** _(Optional)_ | | [type](./did-comm.ididcommmessage.type.md) | | string | **_(BETA)_** | diff --git a/docs/api/did-comm.ididcommmessage.next.md b/docs/api/did-comm.ididcommmessage.next.md index bb720d0e..74f5cc54 100644 --- a/docs/api/did-comm.ididcommmessage.next.md +++ b/docs/api/did-comm.ididcommmessage.next.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommMessage.next property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.ididcommmessage.pthid.md b/docs/api/did-comm.ididcommmessage.pthid.md index 3a913d3e..b69fc61b 100644 --- a/docs/api/did-comm.ididcommmessage.pthid.md +++ b/docs/api/did-comm.ididcommmessage.pthid.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommMessage.pthid property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.ididcommmessage.return_route.md b/docs/api/did-comm.ididcommmessage.return_route.md index dd91d10f..42717966 100644 --- a/docs/api/did-comm.ididcommmessage.return_route.md +++ b/docs/api/did-comm.ididcommmessage.return_route.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommMessage.return_route property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.ididcommmessage.thid.md b/docs/api/did-comm.ididcommmessage.thid.md index 8c675b71..c97e1017 100644 --- a/docs/api/did-comm.ididcommmessage.thid.md +++ b/docs/api/did-comm.ididcommmessage.thid.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommMessage.thid property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.ididcommmessage.to.md b/docs/api/did-comm.ididcommmessage.to.md index 27ba2946..d4bb79cf 100644 --- a/docs/api/did-comm.ididcommmessage.to.md +++ b/docs/api/did-comm.ididcommmessage.to.md @@ -8,10 +8,10 @@ hide_title: true ## IDIDCommMessage.to property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** ```typescript -to: string +to?: string[]; ``` diff --git a/docs/api/did-comm.ididcommmessage.type.md b/docs/api/did-comm.ididcommmessage.type.md index 6c0489eb..2a6e411c 100644 --- a/docs/api/did-comm.ididcommmessage.type.md +++ b/docs/api/did-comm.ididcommmessage.type.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommMessage.type property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.ididcommmessageattachment.byte_count.md b/docs/api/did-comm.ididcommmessageattachment.byte_count.md index 80abb7b8..5d608be1 100644 --- a/docs/api/did-comm.ididcommmessageattachment.byte_count.md +++ b/docs/api/did-comm.ididcommmessageattachment.byte_count.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommMessageAttachment.byte_count property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.ididcommmessageattachment.data.md b/docs/api/did-comm.ididcommmessageattachment.data.md index c687865e..c43e9c67 100644 --- a/docs/api/did-comm.ididcommmessageattachment.data.md +++ b/docs/api/did-comm.ididcommmessageattachment.data.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommMessageAttachment.data property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.ididcommmessageattachment.description.md b/docs/api/did-comm.ididcommmessageattachment.description.md index f80f10c8..4593ec81 100644 --- a/docs/api/did-comm.ididcommmessageattachment.description.md +++ b/docs/api/did-comm.ididcommmessageattachment.description.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommMessageAttachment.description property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.ididcommmessageattachment.filename.md b/docs/api/did-comm.ididcommmessageattachment.filename.md index 8c2c9ce8..54ecc1a7 100644 --- a/docs/api/did-comm.ididcommmessageattachment.filename.md +++ b/docs/api/did-comm.ididcommmessageattachment.filename.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommMessageAttachment.filename property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.ididcommmessageattachment.format.md b/docs/api/did-comm.ididcommmessageattachment.format.md index 2efb2ca4..e72e991d 100644 --- a/docs/api/did-comm.ididcommmessageattachment.format.md +++ b/docs/api/did-comm.ididcommmessageattachment.format.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommMessageAttachment.format property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.ididcommmessageattachment.id.md b/docs/api/did-comm.ididcommmessageattachment.id.md index d94e917c..94dc0cf1 100644 --- a/docs/api/did-comm.ididcommmessageattachment.id.md +++ b/docs/api/did-comm.ididcommmessageattachment.id.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommMessageAttachment.id property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.ididcommmessageattachment.lastmod_time.md b/docs/api/did-comm.ididcommmessageattachment.lastmod_time.md index ff6f4120..95a2c61c 100644 --- a/docs/api/did-comm.ididcommmessageattachment.lastmod_time.md +++ b/docs/api/did-comm.ididcommmessageattachment.lastmod_time.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommMessageAttachment.lastmod_time property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.ididcommmessageattachment.md b/docs/api/did-comm.ididcommmessageattachment.md index 370c46f9..0c214e4c 100644 --- a/docs/api/did-comm.ididcommmessageattachment.md +++ b/docs/api/did-comm.ididcommmessageattachment.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommMessageAttachment interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The DIDComm message structure for attachments. See https://identity.foundation/didcomm-messaging/spec/\#attachments diff --git a/docs/api/did-comm.ididcommmessageattachment.media_type.md b/docs/api/did-comm.ididcommmessageattachment.media_type.md index 693ea52f..10f2d62f 100644 --- a/docs/api/did-comm.ididcommmessageattachment.media_type.md +++ b/docs/api/did-comm.ididcommmessageattachment.media_type.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommMessageAttachment.media_type property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.ididcommmessageattachmentdata.base64.md b/docs/api/did-comm.ididcommmessageattachmentdata.base64.md index 83199754..d9cbfef2 100644 --- a/docs/api/did-comm.ididcommmessageattachmentdata.base64.md +++ b/docs/api/did-comm.ididcommmessageattachmentdata.base64.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommMessageAttachmentData.base64 property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.ididcommmessageattachmentdata.hash.md b/docs/api/did-comm.ididcommmessageattachmentdata.hash.md index 2b992457..0cd9b515 100644 --- a/docs/api/did-comm.ididcommmessageattachmentdata.hash.md +++ b/docs/api/did-comm.ididcommmessageattachmentdata.hash.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommMessageAttachmentData.hash property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.ididcommmessageattachmentdata.json.md b/docs/api/did-comm.ididcommmessageattachmentdata.json.md index 917a38aa..5f9d2746 100644 --- a/docs/api/did-comm.ididcommmessageattachmentdata.json.md +++ b/docs/api/did-comm.ididcommmessageattachmentdata.json.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommMessageAttachmentData.json property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.ididcommmessageattachmentdata.jws.md b/docs/api/did-comm.ididcommmessageattachmentdata.jws.md index bf78551d..884b8871 100644 --- a/docs/api/did-comm.ididcommmessageattachmentdata.jws.md +++ b/docs/api/did-comm.ididcommmessageattachmentdata.jws.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommMessageAttachmentData.jws property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.ididcommmessageattachmentdata.links.md b/docs/api/did-comm.ididcommmessageattachmentdata.links.md index d3cdd9d0..3b7e8087 100644 --- a/docs/api/did-comm.ididcommmessageattachmentdata.links.md +++ b/docs/api/did-comm.ididcommmessageattachmentdata.links.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommMessageAttachmentData.links property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.ididcommmessageattachmentdata.md b/docs/api/did-comm.ididcommmessageattachmentdata.md index 423734d7..4b47943b 100644 --- a/docs/api/did-comm.ididcommmessageattachmentdata.md +++ b/docs/api/did-comm.ididcommmessageattachmentdata.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommMessageAttachmentData interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The DIDComm message structure for data in an attachment. See https://identity.foundation/didcomm-messaging/spec/\#attachments diff --git a/docs/api/did-comm.ididcommmessagemetadata.md b/docs/api/did-comm.ididcommmessagemetadata.md index 02ca28ef..c7de256b 100644 --- a/docs/api/did-comm.ididcommmessagemetadata.md +++ b/docs/api/did-comm.ididcommmessagemetadata.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommMessageMetaData interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Metadata resulting from unpacking a DIDComm v2 message. diff --git a/docs/api/did-comm.ididcommmessagemetadata.packing.md b/docs/api/did-comm.ididcommmessagemetadata.packing.md index 13b1caf3..aed3bb58 100644 --- a/docs/api/did-comm.ididcommmessagemetadata.packing.md +++ b/docs/api/did-comm.ididcommmessagemetadata.packing.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommMessageMetaData.packing property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.ididcommoptions.alg.md b/docs/api/did-comm.ididcommoptions.alg.md index 5ee180f9..d700ff2b 100644 --- a/docs/api/did-comm.ididcommoptions.alg.md +++ b/docs/api/did-comm.ididcommoptions.alg.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommOptions.alg property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Optional key wrapping algorithm to use. Defaults to 'ECDH-ES+A256KW' diff --git a/docs/api/did-comm.ididcommoptions.bcc.md b/docs/api/did-comm.ididcommoptions.bcc.md index 3b79470a..68410987 100644 --- a/docs/api/did-comm.ididcommoptions.bcc.md +++ b/docs/api/did-comm.ididcommoptions.bcc.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommOptions.bcc property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Add extra recipients for the packed message. diff --git a/docs/api/did-comm.ididcommoptions.enc.md b/docs/api/did-comm.ididcommoptions.enc.md index 78cb3492..8f9cb905 100644 --- a/docs/api/did-comm.ididcommoptions.enc.md +++ b/docs/api/did-comm.ididcommoptions.enc.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommOptions.enc property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Optional content encryption algorithm to use. Defaults to 'A256GCM' diff --git a/docs/api/did-comm.ididcommoptions.md b/docs/api/did-comm.ididcommoptions.md index 12edcbb9..9a959cf1 100644 --- a/docs/api/did-comm.ididcommoptions.md +++ b/docs/api/did-comm.ididcommoptions.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommOptions interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Extra options when packing a DIDComm message. diff --git a/docs/api/did-comm.ididcommoptions.recipientkids.md b/docs/api/did-comm.ididcommoptions.recipientkids.md index 1deaef21..16eb76de 100644 --- a/docs/api/did-comm.ididcommoptions.recipientkids.md +++ b/docs/api/did-comm.ididcommoptions.recipientkids.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommOptions.recipientKids property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Restrict to a set of kids for recipient diff --git a/docs/api/did-comm.ididcommtransport.id.md b/docs/api/did-comm.ididcommtransport.id.md index e1c076e0..e5979332 100644 --- a/docs/api/did-comm.ididcommtransport.id.md +++ b/docs/api/did-comm.ididcommtransport.id.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommTransport.id property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Identifier of this transport that can be used in case the message thread supports reusing the transport connection. diff --git a/docs/api/did-comm.ididcommtransport.isservicesupported.md b/docs/api/did-comm.ididcommtransport.isservicesupported.md index ea436cd6..3603926a 100644 --- a/docs/api/did-comm.ididcommtransport.isservicesupported.md +++ b/docs/api/did-comm.ididcommtransport.isservicesupported.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommTransport.isServiceSupported() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Returns `true` if this transport is suitable for the provided DID Document service section, otherwise `false`. diff --git a/docs/api/did-comm.ididcommtransport.md b/docs/api/did-comm.ididcommtransport.md index dd42f09e..e689e090 100644 --- a/docs/api/did-comm.ididcommtransport.md +++ b/docs/api/did-comm.ididcommtransport.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommTransport interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Common interface for transports that can be used in the [DIDComm](./did-comm.didcomm.md) module. diff --git a/docs/api/did-comm.ididcommtransport.send.md b/docs/api/did-comm.ididcommtransport.send.md index 3406a1a8..f80d110f 100644 --- a/docs/api/did-comm.ididcommtransport.send.md +++ b/docs/api/did-comm.ididcommtransport.send.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommTransport.send() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Sends the provided raw message (without further processing) to the service endpoint defined in the provided DID Document service section. diff --git a/docs/api/did-comm.ididcommtransportresult.error.md b/docs/api/did-comm.ididcommtransportresult.error.md index c9583402..f93a4864 100644 --- a/docs/api/did-comm.ididcommtransportresult.error.md +++ b/docs/api/did-comm.ididcommtransportresult.error.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommTransportResult.error property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.ididcommtransportresult.md b/docs/api/did-comm.ididcommtransportresult.md index 715fd837..63f8f338 100644 --- a/docs/api/did-comm.ididcommtransportresult.md +++ b/docs/api/did-comm.ididcommtransportresult.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommTransportResult interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Result interface for sending DIDComm messages through [IDIDCommTransport.send()](./did-comm.ididcommtransport.send.md). diff --git a/docs/api/did-comm.ididcommtransportresult.result.md b/docs/api/did-comm.ididcommtransportresult.result.md index 0bc71459..a2620f2b 100644 --- a/docs/api/did-comm.ididcommtransportresult.result.md +++ b/docs/api/did-comm.ididcommtransportresult.result.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommTransportResult.result property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.ididcommtransportresult.returnmessage.md b/docs/api/did-comm.ididcommtransportresult.returnmessage.md index 2fa76498..ae22b85f 100644 --- a/docs/api/did-comm.ididcommtransportresult.returnmessage.md +++ b/docs/api/did-comm.ididcommtransportresult.returnmessage.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDCommTransportResult.returnMessage property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.ipackdidcommmessageargs.keyref.md b/docs/api/did-comm.ipackdidcommmessageargs.keyref.md index 70596889..14c16e46 100644 --- a/docs/api/did-comm.ipackdidcommmessageargs.keyref.md +++ b/docs/api/did-comm.ipackdidcommmessageargs.keyref.md @@ -8,7 +8,7 @@ hide_title: true ## IPackDIDCommMessageArgs.keyRef property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.ipackdidcommmessageargs.md b/docs/api/did-comm.ipackdidcommmessageargs.md index dfbbec88..0e0e6a96 100644 --- a/docs/api/did-comm.ipackdidcommmessageargs.md +++ b/docs/api/did-comm.ipackdidcommmessageargs.md @@ -8,7 +8,7 @@ hide_title: true ## IPackDIDCommMessageArgs interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The input to the [IDIDComm.packDIDCommMessage()](./did-comm.ididcomm.packdidcommmessage.md) method. When `packing` is `authcrypt` or `jws`, a `keyRef` MUST be provided. @@ -17,9 +17,11 @@ This API may change without a BREAKING CHANGE notice. **Signature:** ```typescript -export interface IPackDIDCommMessageArgs +export interface IPackDIDCommMessageArgs extends UsingResolutionOptions ``` +**Extends:** [UsingResolutionOptions](./core-types.usingresolutionoptions.md) + ## Properties | Property | Modifiers | Type | Description | diff --git a/docs/api/did-comm.ipackdidcommmessageargs.message.md b/docs/api/did-comm.ipackdidcommmessageargs.message.md index fe5ea098..9cc8e159 100644 --- a/docs/api/did-comm.ipackdidcommmessageargs.message.md +++ b/docs/api/did-comm.ipackdidcommmessageargs.message.md @@ -8,7 +8,7 @@ hide_title: true ## IPackDIDCommMessageArgs.message property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.ipackdidcommmessageargs.options.md b/docs/api/did-comm.ipackdidcommmessageargs.options.md index 699c455d..59651871 100644 --- a/docs/api/did-comm.ipackdidcommmessageargs.options.md +++ b/docs/api/did-comm.ipackdidcommmessageargs.options.md @@ -8,7 +8,7 @@ hide_title: true ## IPackDIDCommMessageArgs.options property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.ipackdidcommmessageargs.packing.md b/docs/api/did-comm.ipackdidcommmessageargs.packing.md index c47a0c50..8a8d8f0b 100644 --- a/docs/api/did-comm.ipackdidcommmessageargs.packing.md +++ b/docs/api/did-comm.ipackdidcommmessageargs.packing.md @@ -8,7 +8,7 @@ hide_title: true ## IPackDIDCommMessageArgs.packing property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.ipackeddidcommmessage.md b/docs/api/did-comm.ipackeddidcommmessage.md index 03ca266a..8afa21bb 100644 --- a/docs/api/did-comm.ipackeddidcommmessage.md +++ b/docs/api/did-comm.ipackeddidcommmessage.md @@ -8,7 +8,7 @@ hide_title: true ## IPackedDIDCommMessage interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The result of packing a DIDComm v2 message. The message is always serialized as string. diff --git a/docs/api/did-comm.ipackeddidcommmessage.message.md b/docs/api/did-comm.ipackeddidcommmessage.message.md index b4890c71..46665490 100644 --- a/docs/api/did-comm.ipackeddidcommmessage.message.md +++ b/docs/api/did-comm.ipackeddidcommmessage.message.md @@ -8,7 +8,7 @@ hide_title: true ## IPackedDIDCommMessage.message property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.isenddidcommmessageargs.md b/docs/api/did-comm.isenddidcommmessageargs.md index 58ac0e57..2ae71791 100644 --- a/docs/api/did-comm.isenddidcommmessageargs.md +++ b/docs/api/did-comm.isenddidcommmessageargs.md @@ -8,7 +8,7 @@ hide_title: true ## ISendDIDCommMessageArgs interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The input to the [IDIDComm.sendDIDCommMessage()](./did-comm.ididcomm.senddidcommmessage.md) method. The provided `messageId` will be used in the emitted event to allow event/message correlation. @@ -17,9 +17,11 @@ This API may change without a BREAKING CHANGE notice. **Signature:** ```typescript -export interface ISendDIDCommMessageArgs +export interface ISendDIDCommMessageArgs extends UsingResolutionOptions ``` +**Extends:** [UsingResolutionOptions](./core-types.usingresolutionoptions.md) + ## Properties | Property | Modifiers | Type | Description | diff --git a/docs/api/did-comm.isenddidcommmessageargs.messageid.md b/docs/api/did-comm.isenddidcommmessageargs.messageid.md index 4a8c16ad..12cfc9d4 100644 --- a/docs/api/did-comm.isenddidcommmessageargs.messageid.md +++ b/docs/api/did-comm.isenddidcommmessageargs.messageid.md @@ -8,7 +8,7 @@ hide_title: true ## ISendDIDCommMessageArgs.messageId property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.isenddidcommmessageargs.packedmessage.md b/docs/api/did-comm.isenddidcommmessageargs.packedmessage.md index b65a8d79..780ecfec 100644 --- a/docs/api/did-comm.isenddidcommmessageargs.packedmessage.md +++ b/docs/api/did-comm.isenddidcommmessageargs.packedmessage.md @@ -8,7 +8,7 @@ hide_title: true ## ISendDIDCommMessageArgs.packedMessage property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.isenddidcommmessageargs.recipientdidurl.md b/docs/api/did-comm.isenddidcommmessageargs.recipientdidurl.md index 7dd94cdf..721a5cfb 100644 --- a/docs/api/did-comm.isenddidcommmessageargs.recipientdidurl.md +++ b/docs/api/did-comm.isenddidcommmessageargs.recipientdidurl.md @@ -8,7 +8,7 @@ hide_title: true ## ISendDIDCommMessageArgs.recipientDidUrl property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.isenddidcommmessageargs.returntransportid.md b/docs/api/did-comm.isenddidcommmessageargs.returntransportid.md index 589700bd..03025dd4 100644 --- a/docs/api/did-comm.isenddidcommmessageargs.returntransportid.md +++ b/docs/api/did-comm.isenddidcommmessageargs.returntransportid.md @@ -8,7 +8,7 @@ hide_title: true ## ISendDIDCommMessageArgs.returnTransportId property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.isenddidcommmessageresponse.md b/docs/api/did-comm.isenddidcommmessageresponse.md index 08bdd98e..a1f6e07f 100644 --- a/docs/api/did-comm.isenddidcommmessageresponse.md +++ b/docs/api/did-comm.isenddidcommmessageresponse.md @@ -8,7 +8,7 @@ hide_title: true ## ISendDIDCommMessageResponse interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The response from the [IDIDComm.sendDIDCommMessage()](./did-comm.ididcomm.senddidcommmessage.md) method. diff --git a/docs/api/did-comm.isenddidcommmessageresponse.returnmessage.md b/docs/api/did-comm.isenddidcommmessageresponse.returnmessage.md index 49c99e50..7208b419 100644 --- a/docs/api/did-comm.isenddidcommmessageresponse.returnmessage.md +++ b/docs/api/did-comm.isenddidcommmessageresponse.returnmessage.md @@ -8,7 +8,7 @@ hide_title: true ## ISendDIDCommMessageResponse.returnMessage property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.isenddidcommmessageresponse.transportid.md b/docs/api/did-comm.isenddidcommmessageresponse.transportid.md index d9cd3764..fa1f24e0 100644 --- a/docs/api/did-comm.isenddidcommmessageresponse.transportid.md +++ b/docs/api/did-comm.isenddidcommmessageresponse.transportid.md @@ -8,7 +8,7 @@ hide_title: true ## ISendDIDCommMessageResponse.transportId property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.isendmessagedidcommalpha1args.data.md b/docs/api/did-comm.isendmessagedidcommalpha1args.data.md index 0b06b8a0..fd5e37fe 100644 --- a/docs/api/did-comm.isendmessagedidcommalpha1args.data.md +++ b/docs/api/did-comm.isendmessagedidcommalpha1args.data.md @@ -8,7 +8,7 @@ hide_title: true ## ISendMessageDIDCommAlpha1Args.data property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.isendmessagedidcommalpha1args.headers.md b/docs/api/did-comm.isendmessagedidcommalpha1args.headers.md index 4427d249..bd6002a1 100644 --- a/docs/api/did-comm.isendmessagedidcommalpha1args.headers.md +++ b/docs/api/did-comm.isendmessagedidcommalpha1args.headers.md @@ -8,7 +8,7 @@ hide_title: true ## ISendMessageDIDCommAlpha1Args.headers property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.isendmessagedidcommalpha1args.md b/docs/api/did-comm.isendmessagedidcommalpha1args.md index 6da1f979..142c1346 100644 --- a/docs/api/did-comm.isendmessagedidcommalpha1args.md +++ b/docs/api/did-comm.isendmessagedidcommalpha1args.md @@ -8,7 +8,7 @@ hide_title: true ## ISendMessageDIDCommAlpha1Args interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. > Warning: This API is now obsolete. > diff --git a/docs/api/did-comm.isendmessagedidcommalpha1args.save.md b/docs/api/did-comm.isendmessagedidcommalpha1args.save.md index eaab8a25..bd075dc3 100644 --- a/docs/api/did-comm.isendmessagedidcommalpha1args.save.md +++ b/docs/api/did-comm.isendmessagedidcommalpha1args.save.md @@ -8,7 +8,7 @@ hide_title: true ## ISendMessageDIDCommAlpha1Args.save property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.isendmessagedidcommalpha1args.url.md b/docs/api/did-comm.isendmessagedidcommalpha1args.url.md index ae89d4e7..28fd1bf9 100644 --- a/docs/api/did-comm.isendmessagedidcommalpha1args.url.md +++ b/docs/api/did-comm.isendmessagedidcommalpha1args.url.md @@ -8,7 +8,7 @@ hide_title: true ## ISendMessageDIDCommAlpha1Args.url property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.iunpackdidcommmessageargs.md b/docs/api/did-comm.iunpackdidcommmessageargs.md index b6ab87d2..a7fd1e34 100644 --- a/docs/api/did-comm.iunpackdidcommmessageargs.md +++ b/docs/api/did-comm.iunpackdidcommmessageargs.md @@ -8,7 +8,7 @@ hide_title: true ## IUnpackDIDCommMessageArgs type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The input to the [IDIDComm.unpackDIDCommMessage()](./did-comm.ididcomm.unpackdidcommmessage.md) method. @@ -17,7 +17,7 @@ This API may change without a BREAKING CHANGE notice. **Signature:** ```typescript -export type IUnpackDIDCommMessageArgs = IPackedDIDCommMessage +export type IUnpackDIDCommMessageArgs = IPackedDIDCommMessage & UsingResolutionOptions ``` -**References:** [IPackedDIDCommMessage](./did-comm.ipackeddidcommmessage.md) +**References:** [IPackedDIDCommMessage](./did-comm.ipackeddidcommmessage.md), [UsingResolutionOptions](./core-types.usingresolutionoptions.md) diff --git a/docs/api/did-comm.iunpackeddidcommmessage.md b/docs/api/did-comm.iunpackeddidcommmessage.md index fb6f43ed..1d23c30d 100644 --- a/docs/api/did-comm.iunpackeddidcommmessage.md +++ b/docs/api/did-comm.iunpackeddidcommmessage.md @@ -8,7 +8,7 @@ hide_title: true ## IUnpackedDIDCommMessage interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The result of unpacking a DIDComm v2 message. diff --git a/docs/api/did-comm.iunpackeddidcommmessage.message.md b/docs/api/did-comm.iunpackeddidcommmessage.message.md index 9caf2688..fc771edb 100644 --- a/docs/api/did-comm.iunpackeddidcommmessage.message.md +++ b/docs/api/did-comm.iunpackeddidcommmessage.message.md @@ -8,7 +8,7 @@ hide_title: true ## IUnpackedDIDCommMessage.message property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.iunpackeddidcommmessage.metadata.md b/docs/api/did-comm.iunpackeddidcommmessage.metadata.md index 91c1ea80..d5880000 100644 --- a/docs/api/did-comm.iunpackeddidcommmessage.metadata.md +++ b/docs/api/did-comm.iunpackeddidcommmessage.metadata.md @@ -8,7 +8,7 @@ hide_title: true ## IUnpackedDIDCommMessage.metaData property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.md b/docs/api/did-comm.md index 696f1d4f..31325572 100644 --- a/docs/api/did-comm.md +++ b/docs/api/did-comm.md @@ -50,9 +50,15 @@ Provides a [plugin](./did-comm.didcomm.md) for the [Agent](./core.agent.md) that | [createMediateGrantMessage(recipientDidUrl, mediatorDidUrl, thid)](./did-comm.createmediategrantmessage.md) | **_(BETA)_** This API may change without a BREAKING CHANGE notice. | | [createMediateRequestMessage(recipientDidUrl, mediatorDidUrl)](./did-comm.createmediaterequestmessage.md) | **_(BETA)_** This API may change without a BREAKING CHANGE notice. | | [createStatusRequestMessage(recipientDidUrl, mediatorDidUrl)](./did-comm.createstatusrequestmessage.md) | **_(BETA)_** This API may change without a BREAKING CHANGE notice. | +| [createV3DeliveryRequestMessage(recipientDidUrl, mediatorDidUrl)](./did-comm.createv3deliveryrequestmessage.md) | **_(BETA)_** This API may change without a BREAKING CHANGE notice. | +| [createV3MediateDenyMessage(recipientDidUrl, mediatorDidUrl, thid)](./did-comm.createv3mediatedenymessage.md) | **_(BETA)_** This API may change without a BREAKING CHANGE notice. | | [createV3MediateGrantMessage(recipientDidUrl, mediatorDidUrl, thid)](./did-comm.createv3mediategrantmessage.md) | **_(BETA)_** This API may change without a BREAKING CHANGE notice. | | [createV3MediateRequestMessage(recipientDidUrl, mediatorDidUrl)](./did-comm.createv3mediaterequestmessage.md) | **_(BETA)_** This API may change without a BREAKING CHANGE notice. | +| [createV3RecipientQueryMessage(recipientDidUrl, mediatorDidUrl)](./did-comm.createv3recipientquerymessage.md) | **_(BETA)_** This API may change without a BREAKING CHANGE notice. | +| [createV3RecipientQueryResponseMessage(recipientDidUrl, mediatorDidUrl, thid, dids)](./did-comm.createv3recipientqueryresponsemessage.md) | **_(BETA)_** This API may change without a BREAKING CHANGE notice. | +| [createV3RecipientUpdateMessage(recipientDidUrl, mediatorDidUrl, updates)](./did-comm.createv3recipientupdatemessage.md) | **_(BETA)_** This API may change without a BREAKING CHANGE notice. | | [createV3RecipientUpdateResponseMessage(recipientDidUrl, mediatorDidUrl, thid, updates)](./did-comm.createv3recipientupdateresponsemessage.md) | **_(BETA)_** This API may change without a BREAKING CHANGE notice. | +| [createV3StatusRequestMessage(recipientDidUrl, mediatorDidUrl)](./did-comm.createv3statusrequestmessage.md) | **_(BETA)_** This API may change without a BREAKING CHANGE notice. | ## Interfaces @@ -79,19 +85,14 @@ Provides a [plugin](./did-comm.didcomm.md) for the [Agent](./core.agent.md) that ## Variables -| Variable | Description | -| -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | -| [createV3DeliveryRequestMessage](./did-comm.createv3deliveryrequestmessage.md) | **_(BETA)_** This API may change without a BREAKING CHANGE notice. | -| [createV3MediateDenyMessage](./did-comm.createv3mediatedenymessage.md) | **_(BETA)_** This API may change without a BREAKING CHANGE notice. | -| [createV3RecipientQueryMessage](./did-comm.createv3recipientquerymessage.md) | **_(BETA)_** This API may change without a BREAKING CHANGE notice. | -| [createV3RecipientQueryResponseMessage](./did-comm.createv3recipientqueryresponsemessage.md) | **_(BETA)_** This API may change without a BREAKING CHANGE notice. | -| [createV3RecipientUpdateMessage](./did-comm.createv3recipientupdatemessage.md) | **_(BETA)_** This API may change without a BREAKING CHANGE notice. | -| [createV3StatusRequestMessage](./did-comm.createv3statusrequestmessage.md) | **_(BETA)_** This API may change without a BREAKING CHANGE notice. | -| [DELIVERY_REQUEST_MESSAGE_TYPE](./did-comm.delivery_request_message_type.md) | **_(BETA)_** This API may change without a BREAKING CHANGE notice. | -| [MEDIATE_DENY_MESSAGE_TYPE](./did-comm.mediate_deny_message_type.md) | **_(BETA)_** This API may change without a BREAKING CHANGE notice. | -| [MEDIATE_GRANT_MESSAGE_TYPE](./did-comm.mediate_grant_message_type.md) | **_(BETA)_** This API may change without a BREAKING CHANGE notice. | -| [MEDIATE_REQUEST_MESSAGE_TYPE](./did-comm.mediate_request_message_type.md) | **_(BETA)_** This API may change without a BREAKING CHANGE notice. | -| [STATUS_REQUEST_MESSAGE_TYPE](./did-comm.status_request_message_type.md) | **_(BETA)_** This API may change without a BREAKING CHANGE notice. | +| Variable | Description | +| ---------------------------------------------------------------------------- | ------------------------------------------------------------------ | +| [DELIVERY_REQUEST_MESSAGE_TYPE](./did-comm.delivery_request_message_type.md) | **_(BETA)_** This API may change without a BREAKING CHANGE notice. | +| [MEDIATE_DENY_MESSAGE_TYPE](./did-comm.mediate_deny_message_type.md) | **_(BETA)_** This API may change without a BREAKING CHANGE notice. | +| [MEDIATE_GRANT_MESSAGE_TYPE](./did-comm.mediate_grant_message_type.md) | **_(BETA)_** This API may change without a BREAKING CHANGE notice. | +| [MEDIATE_REQUEST_MESSAGE_TYPE](./did-comm.mediate_request_message_type.md) | **_(BETA)_** This API may change without a BREAKING CHANGE notice. | +| [schema](./did-comm.schema.md) | | +| [STATUS_REQUEST_MESSAGE_TYPE](./did-comm.status_request_message_type.md) | **_(BETA)_** This API may change without a BREAKING CHANGE notice. | ## Type Aliases diff --git a/docs/api/did-comm.mediate_deny_message_type.md b/docs/api/did-comm.mediate_deny_message_type.md index b44df54c..e4fbcaf2 100644 --- a/docs/api/did-comm.mediate_deny_message_type.md +++ b/docs/api/did-comm.mediate_deny_message_type.md @@ -8,7 +8,7 @@ hide_title: true ## MEDIATE_DENY_MESSAGE_TYPE variable -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/did-comm.mediate_grant_message_type.md b/docs/api/did-comm.mediate_grant_message_type.md index aa91e98b..a0938523 100644 --- a/docs/api/did-comm.mediate_grant_message_type.md +++ b/docs/api/did-comm.mediate_grant_message_type.md @@ -8,7 +8,7 @@ hide_title: true ## MEDIATE_GRANT_MESSAGE_TYPE variable -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/did-comm.mediate_request_message_type.md b/docs/api/did-comm.mediate_request_message_type.md index d8c80fef..0f4712f7 100644 --- a/docs/api/did-comm.mediate_request_message_type.md +++ b/docs/api/did-comm.mediate_request_message_type.md @@ -8,7 +8,7 @@ hide_title: true ## MEDIATE_REQUEST_MESSAGE_TYPE variable -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/did-comm.messagepickup.md b/docs/api/did-comm.messagepickup.md index 2e5adbc6..1e5f0d71 100644 --- a/docs/api/did-comm.messagepickup.md +++ b/docs/api/did-comm.messagepickup.md @@ -8,7 +8,7 @@ hide_title: true ## MessagePickup enum -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/did-comm.pickupmediatormessagehandler._constructor_.md b/docs/api/did-comm.pickupmediatormessagehandler._constructor_.md index fa55104d..07ea4879 100644 --- a/docs/api/did-comm.pickupmediatormessagehandler._constructor_.md +++ b/docs/api/did-comm.pickupmediatormessagehandler._constructor_.md @@ -8,7 +8,7 @@ hide_title: true ## PickupMediatorMessageHandler.(constructor) -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Constructs a new instance of the `PickupMediatorMessageHandler` class diff --git a/docs/api/did-comm.pickupmediatormessagehandler.handle.md b/docs/api/did-comm.pickupmediatormessagehandler.handle.md index 725a4e08..f4106b80 100644 --- a/docs/api/did-comm.pickupmediatormessagehandler.handle.md +++ b/docs/api/did-comm.pickupmediatormessagehandler.handle.md @@ -8,7 +8,7 @@ hide_title: true ## PickupMediatorMessageHandler.handle() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Handles messages for Pickup protocol and mediator role https://didcomm.org/pickup/3.0/ diff --git a/docs/api/did-comm.pickupmediatormessagehandler.md b/docs/api/did-comm.pickupmediatormessagehandler.md index 492f1d03..690df8fd 100644 --- a/docs/api/did-comm.pickupmediatormessagehandler.md +++ b/docs/api/did-comm.pickupmediatormessagehandler.md @@ -8,7 +8,7 @@ hide_title: true ## PickupMediatorMessageHandler class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. A plugin for the [MessageHandler](./message-handler.messagehandler.md) that handles Pickup messages for the mediator role. This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/did-comm.pickuprecipientmessagehandler._constructor_.md b/docs/api/did-comm.pickuprecipientmessagehandler._constructor_.md index ffc584a8..8b8b80f3 100644 --- a/docs/api/did-comm.pickuprecipientmessagehandler._constructor_.md +++ b/docs/api/did-comm.pickuprecipientmessagehandler._constructor_.md @@ -8,7 +8,7 @@ hide_title: true ## PickupRecipientMessageHandler.(constructor) -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Constructs a new instance of the `PickupRecipientMessageHandler` class diff --git a/docs/api/did-comm.pickuprecipientmessagehandler.handle.md b/docs/api/did-comm.pickuprecipientmessagehandler.handle.md index 335ea223..f5a1ad3b 100644 --- a/docs/api/did-comm.pickuprecipientmessagehandler.handle.md +++ b/docs/api/did-comm.pickuprecipientmessagehandler.handle.md @@ -8,7 +8,7 @@ hide_title: true ## PickupRecipientMessageHandler.handle() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Handles messages for Pickup protocol and recipient role https://didcomm.org/pickup/3.0/ diff --git a/docs/api/did-comm.pickuprecipientmessagehandler.md b/docs/api/did-comm.pickuprecipientmessagehandler.md index 584e55b2..d4e9f19c 100644 --- a/docs/api/did-comm.pickuprecipientmessagehandler.md +++ b/docs/api/did-comm.pickuprecipientmessagehandler.md @@ -8,7 +8,7 @@ hide_title: true ## PickupRecipientMessageHandler class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. A plugin for the [MessageHandler](./message-handler.messagehandler.md) that handles Pickup messages for the mediator role. This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/did-comm.recipientupdateresult.md b/docs/api/did-comm.recipientupdateresult.md index 19ac540f..8de28ea8 100644 --- a/docs/api/did-comm.recipientupdateresult.md +++ b/docs/api/did-comm.recipientupdateresult.md @@ -8,7 +8,7 @@ hide_title: true ## RecipientUpdateResult enum -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/did-comm.routingmessagehandler._constructor_.md b/docs/api/did-comm.routingmessagehandler._constructor_.md index a195eb40..d9091769 100644 --- a/docs/api/did-comm.routingmessagehandler._constructor_.md +++ b/docs/api/did-comm.routingmessagehandler._constructor_.md @@ -8,7 +8,7 @@ hide_title: true ## RoutingMessageHandler.(constructor) -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Constructs a new instance of the `RoutingMessageHandler` class diff --git a/docs/api/did-comm.routingmessagehandler.handle.md b/docs/api/did-comm.routingmessagehandler.handle.md index 6cf46d5e..7765115d 100644 --- a/docs/api/did-comm.routingmessagehandler.handle.md +++ b/docs/api/did-comm.routingmessagehandler.handle.md @@ -8,7 +8,7 @@ hide_title: true ## RoutingMessageHandler.handle() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Handles forward messages for Routing protocol https://didcomm.org/routing/2.0/ diff --git a/docs/api/did-comm.routingmessagehandler.md b/docs/api/did-comm.routingmessagehandler.md index 4dd44a31..049758ab 100644 --- a/docs/api/did-comm.routingmessagehandler.md +++ b/docs/api/did-comm.routingmessagehandler.md @@ -8,7 +8,7 @@ hide_title: true ## RoutingMessageHandler class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. A plugin for the [MessageHandler](./message-handler.messagehandler.md) that handles forward messages for the Routing protocol. This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/did-comm.schema.md b/docs/api/did-comm.schema.md new file mode 100644 index 00000000..9c599629 --- /dev/null +++ b/docs/api/did-comm.schema.md @@ -0,0 +1,702 @@ +--- +id: did-comm.schema +title: schema variable +hide_title: true +--- + + + +## schema variable + +**Signature:** + +```typescript +schema: { + IDIDComm: { + components: { + schemas: { + IPackedDIDCommMessage: { + type: string; + properties: { + message: { + type: string; + }; + }; + required: string[]; + description: string; + }; + DIDCommMessageMediaType: { + type: string; + enum: string[]; + description: string; + }; + IPackDIDCommMessageArgs: { + type: string; + properties: { + resolutionOptions: { + type: string; + properties: { + publicKeyFormat: { + type: string; + }; + accept: { + type: string; + }; + }; + description: string; + }; + message: { + $ref: string; + }; + packing: { + $ref: string; + }; + keyRef: { + type: string; + }; + options: { + $ref: string; + }; + }; + required: string[]; + description: string; + }; + IDIDCommMessage: { + type: string; + properties: { + id: { + type: string; + }; + type: { + type: string; + }; + from: { + type: string; + }; + to: { + type: string; + items: { + type: string; + }; + }; + thid: { + type: string; + }; + pthid: { + type: string; + }; + expires_time: { + type: string; + }; + created_time: { + type: string; + }; + next: { + type: string; + }; + from_prior: { + type: string; + }; + body: {}; + attachments: { + type: string; + items: { + $ref: string; + }; + }; + return_route: { + type: string; + }; + }; + required: string[]; + description: string; + }; + IDIDCommMessageAttachment: { + type: string; + properties: { + id: { + type: string; + }; + description: { + type: string; + }; + filename: { + type: string; + }; + media_type: { + type: string; + }; + format: { + type: string; + }; + lastmod_time: { + type: string; + }; + byte_count: { + type: string; + }; + data: { + $ref: string; + }; + }; + required: string[]; + description: string; + }; + IDIDCommMessageAttachmentData: { + type: string; + properties: { + jws: {}; + hash: { + type: string; + }; + links: { + type: string; + items: { + type: string; + }; + }; + base64: { + type: string; + }; + json: {}; + }; + description: string; + }; + DIDCommMessagePacking: { + type: string; + enum: string[]; + description: string; + }; + IDIDCommOptions: { + type: string; + properties: { + bcc: { + type: string; + items: { + type: string; + }; + description: string; + }; + recipientKids: { + type: string; + items: { + type: string; + }; + description: string; + }; + enc: { + type: string; + enum: string[]; + description: string; + }; + alg: { + type: string; + enum: string[]; + description: string; + }; + }; + description: string; + }; + ISendDIDCommMessageArgs: { + type: string; + properties: { + resolutionOptions: { + type: string; + properties: { + publicKeyFormat: { + type: string; + }; + accept: { + type: string; + }; + }; + description: string; + }; + packedMessage: { + $ref: string; + }; + messageId: { + type: string; + }; + returnTransportId: { + type: string; + }; + recipientDidUrl: { + type: string; + }; + }; + required: string[]; + description: string; + }; + ISendDIDCommMessageResponse: { + type: string; + properties: { + transportId: { + type: string; + }; + returnMessage: { + $ref: 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; + }; + attachments: { + type: string; + items: { + $ref: string; + }; + description: string; + }; + returnRoute: { + 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; + }; + VerifiableCredential: { + type: string; + properties: { + proof: { + $ref: string; + }; + issuer: { + $ref: string; + }; + credentialSubject: { + $ref: string; + }; + type: { + anyOf: ({ + type: string; + items: { + type: string; + }; + } | { + type: string; + items?: undefined; + })[]; + }; + "@context": { + $ref: string; + }; + issuanceDate: { + type: string; + }; + expirationDate: { + type: string; + }; + credentialStatus: { + $ref: string; + }; + id: { + type: string; + }; + }; + required: string[]; + description: string; + }; + ProofType: { + type: string; + properties: { + type: { + type: string; + }; + }; + description: string; + }; + IssuerType: { + anyOf: ({ + type: string; + properties: { + id: { + type: string; + }; + }; + required: string[]; + } | { + type: string; + properties?: undefined; + required?: undefined; + })[]; + description: string; + }; + CredentialSubject: { + type: string; + properties: { + id: { + type: string; + }; + }; + description: string; + }; + ContextType: { + anyOf: ({ + type: string; + items?: undefined; + } | { + type: string; + items: { + anyOf: { + type: string; + }[]; + }; + })[]; + description: string; + }; + CredentialStatusReference: { + type: string; + properties: { + id: { + type: string; + }; + type: { + type: string; + }; + }; + required: string[]; + description: string; + }; + VerifiablePresentation: { + type: string; + properties: { + proof: { + $ref: string; + }; + holder: { + type: string; + }; + verifiableCredential: { + type: string; + items: { + $ref: string; + }; + }; + type: { + anyOf: ({ + type: string; + items: { + type: string; + }; + } | { + type: string; + items?: undefined; + })[]; + }; + "@context": { + $ref: string; + }; + verifier: { + type: string; + items: { + type: string; + }; + }; + issuanceDate: { + type: string; + }; + expirationDate: { + type: string; + }; + id: { + type: string; + }; + }; + required: string[]; + description: string; + }; + W3CVerifiableCredential: { + anyOf: { + $ref: string; + }[]; + description: string; + }; + CompactJWT: { + type: string; + description: string; + }; + IMessageAttachment: { + type: string; + properties: { + id: { + type: string; + }; + description: { + type: string; + }; + filename: { + type: string; + }; + media_type: { + type: string; + }; + format: { + type: string; + }; + lastmod_time: { + type: string; + }; + byte_count: { + type: string; + }; + data: { + $ref: string; + }; + }; + required: string[]; + description: string; + }; + IMessageAttachmentData: { + type: string; + properties: { + jws: {}; + hash: { + type: string; + }; + links: { + type: string; + items: { + type: string; + }; + }; + base64: { + type: string; + }; + json: {}; + }; + description: string; + }; + 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[]; + }; + headers: { + type: string; + additionalProperties: { + type: string; + }; + }; + }; + required: string[]; + deprecated: string; + }; + IUnpackDIDCommMessageArgs: { + type: string; + properties: { + resolutionOptions: { + type: string; + properties: { + publicKeyFormat: { + type: string; + }; + accept: { + type: string; + }; + }; + description: string; + }; + message: { + type: string; + }; + }; + required: string[]; + description: string; + }; + IUnpackedDIDCommMessage: { + type: string; + properties: { + metaData: { + $ref: string; + }; + message: { + $ref: string; + }; + }; + required: string[]; + description: string; + }; + IDIDCommMessageMetaData: { + type: string; + properties: { + packing: { + $ref: string; + }; + }; + required: string[]; + description: string; + }; + }; + methods: { + getDIDCommMessageMediaType: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + $ref: string; + }; + }; + packDIDCommMessage: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + $ref: string; + }; + }; + sendDIDCommMessage: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + $ref: string; + }; + }; + sendMessageDIDCommAlpha1: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + $ref: string; + }; + }; + unpackDIDCommMessage: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + $ref: string; + }; + }; + }; + }; + }; +} +``` diff --git a/docs/api/did-comm.status_request_message_type.md b/docs/api/did-comm.status_request_message_type.md index 1f831d9d..067be83f 100644 --- a/docs/api/did-comm.status_request_message_type.md +++ b/docs/api/did-comm.status_request_message_type.md @@ -8,7 +8,7 @@ hide_title: true ## STATUS_REQUEST_MESSAGE_TYPE variable -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/did-comm.trustpingmessagehandler._constructor_.md b/docs/api/did-comm.trustpingmessagehandler._constructor_.md index 59b756e0..f35a1256 100644 --- a/docs/api/did-comm.trustpingmessagehandler._constructor_.md +++ b/docs/api/did-comm.trustpingmessagehandler._constructor_.md @@ -8,7 +8,7 @@ hide_title: true ## TrustPingMessageHandler.(constructor) -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Constructs a new instance of the `TrustPingMessageHandler` class diff --git a/docs/api/did-comm.trustpingmessagehandler.handle.md b/docs/api/did-comm.trustpingmessagehandler.handle.md index c8cbc6bd..b8a34a4f 100644 --- a/docs/api/did-comm.trustpingmessagehandler.handle.md +++ b/docs/api/did-comm.trustpingmessagehandler.handle.md @@ -8,7 +8,7 @@ hide_title: true ## TrustPingMessageHandler.handle() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Handles a Trust Ping Message https://identity.foundation/didcomm-messaging/spec/\#trust-ping-protocol-10 diff --git a/docs/api/did-comm.trustpingmessagehandler.md b/docs/api/did-comm.trustpingmessagehandler.md index ba487732..cf350ef0 100644 --- a/docs/api/did-comm.trustpingmessagehandler.md +++ b/docs/api/did-comm.trustpingmessagehandler.md @@ -8,7 +8,7 @@ hide_title: true ## TrustPingMessageHandler class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. A plugin for the [MessageHandler](./message-handler.messagehandler.md) that handles Trust Ping messages. This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/did-comm.update.action.md b/docs/api/did-comm.update.action.md index 79e23596..80506004 100644 --- a/docs/api/did-comm.update.action.md +++ b/docs/api/did-comm.update.action.md @@ -8,7 +8,7 @@ hide_title: true ## Update.action property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.update.md b/docs/api/did-comm.update.md index f9f22f86..be19248c 100644 --- a/docs/api/did-comm.update.md +++ b/docs/api/did-comm.update.md @@ -8,7 +8,7 @@ hide_title: true ## Update interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/did-comm.update.recipient_did.md b/docs/api/did-comm.update.recipient_did.md index 54fc421c..42ceefda 100644 --- a/docs/api/did-comm.update.recipient_did.md +++ b/docs/api/did-comm.update.recipient_did.md @@ -8,7 +8,7 @@ hide_title: true ## Update.recipient_did property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-comm.updateaction.md b/docs/api/did-comm.updateaction.md index 88bcca64..598ec202 100644 --- a/docs/api/did-comm.updateaction.md +++ b/docs/api/did-comm.updateaction.md @@ -8,7 +8,7 @@ hide_title: true ## UpdateAction enum -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/did-comm.updateresult.md b/docs/api/did-comm.updateresult.md index 0b831d28..36079cb8 100644 --- a/docs/api/did-comm.updateresult.md +++ b/docs/api/did-comm.updateresult.md @@ -8,7 +8,7 @@ hide_title: true ## UpdateResult interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/did-comm.updateresult.result.md b/docs/api/did-comm.updateresult.result.md index 4062450e..d2302054 100644 --- a/docs/api/did-comm.updateresult.result.md +++ b/docs/api/did-comm.updateresult.result.md @@ -8,7 +8,7 @@ hide_title: true ## UpdateResult.result property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-discovery.diddiscovery._constructor_.md b/docs/api/did-discovery.diddiscovery._constructor_.md index e96677e6..406fd182 100644 --- a/docs/api/did-discovery.diddiscovery._constructor_.md +++ b/docs/api/did-discovery.diddiscovery._constructor_.md @@ -8,7 +8,7 @@ hide_title: true ## DIDDiscovery.(constructor) -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Constructs a new instance of the `DIDDiscovery` class diff --git a/docs/api/did-discovery.diddiscovery.discoverdid.md b/docs/api/did-discovery.diddiscovery.discoverdid.md index 599bf1bd..a33de178 100644 --- a/docs/api/did-discovery.diddiscovery.discoverdid.md +++ b/docs/api/did-discovery.diddiscovery.discoverdid.md @@ -8,7 +8,7 @@ hide_title: true ## DIDDiscovery.discoverDid() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Queries data providers and returns DIDs with metadata diff --git a/docs/api/did-discovery.diddiscovery.md b/docs/api/did-discovery.diddiscovery.md index 58062478..d36a463d 100644 --- a/docs/api/did-discovery.diddiscovery.md +++ b/docs/api/did-discovery.diddiscovery.md @@ -8,7 +8,7 @@ hide_title: true ## DIDDiscovery class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This class adds support for discovering DIDs. diff --git a/docs/api/did-discovery.diddiscovery.methods.md b/docs/api/did-discovery.diddiscovery.methods.md index 27accbc2..75c735c5 100644 --- a/docs/api/did-discovery.diddiscovery.methods.md +++ b/docs/api/did-discovery.diddiscovery.methods.md @@ -8,7 +8,7 @@ hide_title: true ## DIDDiscovery.methods property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-discovery.diddiscovery.providers.md b/docs/api/did-discovery.diddiscovery.providers.md index fa26ccf2..82467250 100644 --- a/docs/api/did-discovery.diddiscovery.providers.md +++ b/docs/api/did-discovery.diddiscovery.providers.md @@ -8,7 +8,7 @@ hide_title: true ## DIDDiscovery.providers property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-discovery.diddiscovery.schema.md b/docs/api/did-discovery.diddiscovery.schema.md index fdb6808a..a7b8acf3 100644 --- a/docs/api/did-discovery.diddiscovery.schema.md +++ b/docs/api/did-discovery.diddiscovery.schema.md @@ -8,7 +8,7 @@ hide_title: true ## DIDDiscovery.schema property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-discovery.ididdiscovermatch.did.md b/docs/api/did-discovery.ididdiscovermatch.did.md index 96032be0..f5efee56 100644 --- a/docs/api/did-discovery.ididdiscovermatch.did.md +++ b/docs/api/did-discovery.ididdiscovermatch.did.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDDiscoverMatch.did property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. DID diff --git a/docs/api/did-discovery.ididdiscovermatch.md b/docs/api/did-discovery.ididdiscovermatch.md index b965ace8..0037911c 100644 --- a/docs/api/did-discovery.ididdiscovermatch.md +++ b/docs/api/did-discovery.ididdiscovermatch.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDDiscoverMatch interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. A single discovery match. diff --git a/docs/api/did-discovery.ididdiscovermatch.metadata.md b/docs/api/did-discovery.ididdiscovermatch.metadata.md index f5a1d34e..c8d11d25 100644 --- a/docs/api/did-discovery.ididdiscovermatch.metadata.md +++ b/docs/api/did-discovery.ididdiscovermatch.metadata.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDDiscoverMatch.metaData property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Provider specific related metadata about the match diff --git a/docs/api/did-discovery.ididdiscovery.discoverdid.md b/docs/api/did-discovery.ididdiscovery.discoverdid.md index cea2f434..263c561a 100644 --- a/docs/api/did-discovery.ididdiscovery.discoverdid.md +++ b/docs/api/did-discovery.ididdiscovery.discoverdid.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDDiscovery.discoverDid() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-discovery.ididdiscovery.md b/docs/api/did-discovery.ididdiscovery.md index bf62d13f..2dd20480 100644 --- a/docs/api/did-discovery.ididdiscovery.md +++ b/docs/api/did-discovery.ididdiscovery.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDDiscovery interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Describes the interface of DID discovery plugin. diff --git a/docs/api/did-discovery.ididdiscoverydiscoverdidargs.md b/docs/api/did-discovery.ididdiscoverydiscoverdidargs.md index aae1f527..59f33f74 100644 --- a/docs/api/did-discovery.ididdiscoverydiscoverdidargs.md +++ b/docs/api/did-discovery.ididdiscoverydiscoverdidargs.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDDiscoveryDiscoverDidArgs interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Contains the parameters of a DID Discovery Request. diff --git a/docs/api/did-discovery.ididdiscoverydiscoverdidargs.options.md b/docs/api/did-discovery.ididdiscoverydiscoverdidargs.options.md index 417ff1a1..a1970ebc 100644 --- a/docs/api/did-discovery.ididdiscoverydiscoverdidargs.options.md +++ b/docs/api/did-discovery.ididdiscoverydiscoverdidargs.options.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDDiscoveryDiscoverDidArgs.options property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Provider specific options diff --git a/docs/api/did-discovery.ididdiscoverydiscoverdidargs.query.md b/docs/api/did-discovery.ididdiscoverydiscoverdidargs.query.md index 91fc5e0c..491dd8a0 100644 --- a/docs/api/did-discovery.ididdiscoverydiscoverdidargs.query.md +++ b/docs/api/did-discovery.ididdiscoverydiscoverdidargs.query.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDDiscoveryDiscoverDidArgs.query property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Search string diff --git a/docs/api/did-discovery.ididdiscoverydiscoverdidresult.errors.md b/docs/api/did-discovery.ididdiscoverydiscoverdidresult.errors.md index f9fd835a..f37eeb0c 100644 --- a/docs/api/did-discovery.ididdiscoverydiscoverdidresult.errors.md +++ b/docs/api/did-discovery.ididdiscoverydiscoverdidresult.errors.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDDiscoveryDiscoverDidResult.errors property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. A record of encountered errors diff --git a/docs/api/did-discovery.ididdiscoverydiscoverdidresult.md b/docs/api/did-discovery.ididdiscoverydiscoverdidresult.md index 279b3e59..6fc7bac1 100644 --- a/docs/api/did-discovery.ididdiscoverydiscoverdidresult.md +++ b/docs/api/did-discovery.ididdiscoverydiscoverdidresult.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDDiscoveryDiscoverDidResult interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. DID Discovery results. diff --git a/docs/api/did-discovery.ididdiscoverydiscoverdidresult.results.md b/docs/api/did-discovery.ididdiscoverydiscoverdidresult.results.md index 5f4dbf42..0f8474ae 100644 --- a/docs/api/did-discovery.ididdiscoverydiscoverdidresult.results.md +++ b/docs/api/did-discovery.ididdiscoverydiscoverdidresult.results.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDDiscoveryDiscoverDidResult.results property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. List of discovery results from different providers diff --git a/docs/api/did-discovery.ididdiscoveryproviderresult.matches.md b/docs/api/did-discovery.ididdiscoveryproviderresult.matches.md index e2cee29b..fd3cfad3 100644 --- a/docs/api/did-discovery.ididdiscoveryproviderresult.matches.md +++ b/docs/api/did-discovery.ididdiscoveryproviderresult.matches.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDDiscoveryProviderResult.matches property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. List of discovery matches diff --git a/docs/api/did-discovery.ididdiscoveryproviderresult.md b/docs/api/did-discovery.ididdiscoveryproviderresult.md index 2aa924a1..8563a772 100644 --- a/docs/api/did-discovery.ididdiscoveryproviderresult.md +++ b/docs/api/did-discovery.ididdiscoveryproviderresult.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDDiscoveryProviderResult interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Discovery results from one provider. diff --git a/docs/api/did-discovery.ididdiscoveryproviderresult.provider.md b/docs/api/did-discovery.ididdiscoveryproviderresult.provider.md index 8d5273aa..e1f1433c 100644 --- a/docs/api/did-discovery.ididdiscoveryproviderresult.provider.md +++ b/docs/api/did-discovery.ididdiscoveryproviderresult.provider.md @@ -8,7 +8,7 @@ hide_title: true ## IDIDDiscoveryProviderResult.provider property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Provider name diff --git a/docs/api/did-discovery.md b/docs/api/did-discovery.md index dfc5ac0f..bc06fa79 100644 --- a/docs/api/did-discovery.md +++ b/docs/api/did-discovery.md @@ -31,3 +31,9 @@ Provides a [plugin](./did-discovery.ididdiscovery.md) for the [Agent](./core.age | [IDIDDiscoveryDiscoverDidArgs](./did-discovery.ididdiscoverydiscoverdidargs.md) |

**_(BETA)_** Contains the parameters of a DID Discovery Request.

This API may change without a BREAKING CHANGE notice.

| | [IDIDDiscoveryDiscoverDidResult](./did-discovery.ididdiscoverydiscoverdidresult.md) |

**_(BETA)_** DID Discovery results.

This API may change without a BREAKING CHANGE notice.

| | [IDIDDiscoveryProviderResult](./did-discovery.ididdiscoveryproviderresult.md) |

**_(BETA)_** Discovery results from one provider.

This API may change without a BREAKING CHANGE notice.

| + +## Variables + +| Variable | Description | +| ----------------------------------- | ----------- | +| [schema](./did-discovery.schema.md) | | diff --git a/docs/api/did-discovery.schema.md b/docs/api/did-discovery.schema.md new file mode 100644 index 00000000..6ca771d2 --- /dev/null +++ b/docs/api/did-discovery.schema.md @@ -0,0 +1,110 @@ +--- +id: did-discovery.schema +title: schema variable +hide_title: true +--- + + + +## schema variable + +**Signature:** + +```typescript +schema: { + IDIDDiscovery: { + components: { + schemas: { + IDIDDiscoveryDiscoverDidArgs: { + type: string; + properties: { + query: { + type: string; + description: string; + }; + options: { + type: string; + description: string; + }; + }; + required: string[]; + description: string; + }; + IDIDDiscoveryDiscoverDidResult: { + type: string; + properties: { + query: { + type: string; + description: string; + }; + options: { + type: string; + description: string; + }; + results: { + type: string; + items: { + $ref: string; + }; + description: string; + }; + errors: { + type: string; + additionalProperties: { + type: string; + }; + description: string; + }; + }; + required: string[]; + description: string; + }; + IDIDDiscoveryProviderResult: { + type: string; + properties: { + provider: { + type: string; + description: string; + }; + matches: { + type: string; + items: { + $ref: string; + }; + description: string; + }; + }; + required: string[]; + description: string; + }; + IDIDDiscoverMatch: { + type: string; + properties: { + did: { + type: string; + description: string; + }; + metaData: { + type: string; + description: string; + }; + }; + required: string[]; + description: string; + }; + }; + methods: { + discoverDid: { + description: string; + arguments: { + $ref: string; + }; + returnType: { + $ref: string; + }; + }; + }; + }; + }; +} +``` diff --git a/docs/api/did-manager.aliasdiscoveryprovider.discoverdid.md b/docs/api/did-manager.aliasdiscoveryprovider.discoverdid.md index 05a69e97..c2f29a2d 100644 --- a/docs/api/did-manager.aliasdiscoveryprovider.discoverdid.md +++ b/docs/api/did-manager.aliasdiscoveryprovider.discoverdid.md @@ -8,7 +8,7 @@ hide_title: true ## AliasDiscoveryProvider.discoverDid() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-manager.aliasdiscoveryprovider.md b/docs/api/did-manager.aliasdiscoveryprovider.md index 992852ea..e8b6f227 100644 --- a/docs/api/did-manager.aliasdiscoveryprovider.md +++ b/docs/api/did-manager.aliasdiscoveryprovider.md @@ -8,7 +8,7 @@ hide_title: true ## AliasDiscoveryProvider class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. A DID discovery provider that can filter DIDs by the `alias` used internally in [DIDManager](./did-manager.didmanager.md) diff --git a/docs/api/did-manager.aliasdiscoveryprovider.name.md b/docs/api/did-manager.aliasdiscoveryprovider.name.md index 1418b671..15088ed6 100644 --- a/docs/api/did-manager.aliasdiscoveryprovider.name.md +++ b/docs/api/did-manager.aliasdiscoveryprovider.name.md @@ -8,7 +8,7 @@ hide_title: true ## AliasDiscoveryProvider.name property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-manager.memorydidstore.deletedid.md b/docs/api/did-manager.memorydidstore.deletedid.md index 550c3098..1ad161e3 100644 --- a/docs/api/did-manager.memorydidstore.deletedid.md +++ b/docs/api/did-manager.memorydidstore.deletedid.md @@ -8,7 +8,7 @@ hide_title: true ## MemoryDIDStore.deleteDID() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-manager.memorydidstore.getdid.md b/docs/api/did-manager.memorydidstore.getdid.md index 4aad30f1..7e866796 100644 --- a/docs/api/did-manager.memorydidstore.getdid.md +++ b/docs/api/did-manager.memorydidstore.getdid.md @@ -8,7 +8,7 @@ hide_title: true ## MemoryDIDStore.getDID() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-manager.memorydidstore.importdid.md b/docs/api/did-manager.memorydidstore.importdid.md index 1ffa3285..49bdc5fd 100644 --- a/docs/api/did-manager.memorydidstore.importdid.md +++ b/docs/api/did-manager.memorydidstore.importdid.md @@ -8,7 +8,7 @@ hide_title: true ## MemoryDIDStore.importDID() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-manager.memorydidstore.listdids.md b/docs/api/did-manager.memorydidstore.listdids.md index f158bd06..5386155b 100644 --- a/docs/api/did-manager.memorydidstore.listdids.md +++ b/docs/api/did-manager.memorydidstore.listdids.md @@ -8,7 +8,7 @@ hide_title: true ## MemoryDIDStore.listDIDs() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-manager.memorydidstore.md b/docs/api/did-manager.memorydidstore.md index a103151e..75ba62f5 100644 --- a/docs/api/did-manager.memorydidstore.md +++ b/docs/api/did-manager.memorydidstore.md @@ -8,7 +8,7 @@ hide_title: true ## MemoryDIDStore class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. An implementation of [AbstractDIDStore](./did-manager.abstractdidstore.md) that stores everything in memory. diff --git a/docs/api/did-provider-jwk.jwkdidprovider._constructor_.md b/docs/api/did-provider-jwk.jwkdidprovider._constructor_.md index 005020b5..d0cb5fae 100644 --- a/docs/api/did-provider-jwk.jwkdidprovider._constructor_.md +++ b/docs/api/did-provider-jwk.jwkdidprovider._constructor_.md @@ -8,7 +8,7 @@ hide_title: true ## JwkDIDProvider.(constructor) -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Constructs a new instance of the `JwkDIDProvider` class diff --git a/docs/api/did-provider-jwk.jwkdidprovider.addkey.md b/docs/api/did-provider-jwk.jwkdidprovider.addkey.md index beaa1c92..c99f8699 100644 --- a/docs/api/did-provider-jwk.jwkdidprovider.addkey.md +++ b/docs/api/did-provider-jwk.jwkdidprovider.addkey.md @@ -8,7 +8,7 @@ hide_title: true ## JwkDIDProvider.addKey() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-provider-jwk.jwkdidprovider.addservice.md b/docs/api/did-provider-jwk.jwkdidprovider.addservice.md index 8e910431..9b67972a 100644 --- a/docs/api/did-provider-jwk.jwkdidprovider.addservice.md +++ b/docs/api/did-provider-jwk.jwkdidprovider.addservice.md @@ -8,7 +8,7 @@ hide_title: true ## JwkDIDProvider.addService() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-provider-jwk.jwkdidprovider.createidentifier.md b/docs/api/did-provider-jwk.jwkdidprovider.createidentifier.md index 5bd75a17..c4eebbd3 100644 --- a/docs/api/did-provider-jwk.jwkdidprovider.createidentifier.md +++ b/docs/api/did-provider-jwk.jwkdidprovider.createidentifier.md @@ -8,7 +8,7 @@ hide_title: true ## JwkDIDProvider.createIdentifier() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-provider-jwk.jwkdidprovider.deleteidentifier.md b/docs/api/did-provider-jwk.jwkdidprovider.deleteidentifier.md index ee8fa71d..05d528cd 100644 --- a/docs/api/did-provider-jwk.jwkdidprovider.deleteidentifier.md +++ b/docs/api/did-provider-jwk.jwkdidprovider.deleteidentifier.md @@ -8,7 +8,7 @@ hide_title: true ## JwkDIDProvider.deleteIdentifier() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-provider-jwk.jwkdidprovider.md b/docs/api/did-provider-jwk.jwkdidprovider.md index 8d05caab..130fafde 100644 --- a/docs/api/did-provider-jwk.jwkdidprovider.md +++ b/docs/api/did-provider-jwk.jwkdidprovider.md @@ -8,7 +8,7 @@ hide_title: true ## JwkDIDProvider class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. [DIDManager](./did-manager.didmanager.md) identifier provider for `did:jwk` identifiers diff --git a/docs/api/did-provider-jwk.jwkdidprovider.removekey.md b/docs/api/did-provider-jwk.jwkdidprovider.removekey.md index c101cf9e..8f84aea7 100644 --- a/docs/api/did-provider-jwk.jwkdidprovider.removekey.md +++ b/docs/api/did-provider-jwk.jwkdidprovider.removekey.md @@ -8,7 +8,7 @@ hide_title: true ## JwkDIDProvider.removeKey() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-provider-jwk.jwkdidprovider.removeservice.md b/docs/api/did-provider-jwk.jwkdidprovider.removeservice.md index cfa88939..5ce4ec69 100644 --- a/docs/api/did-provider-jwk.jwkdidprovider.removeservice.md +++ b/docs/api/did-provider-jwk.jwkdidprovider.removeservice.md @@ -8,7 +8,7 @@ hide_title: true ## JwkDIDProvider.removeService() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-provider-jwk.jwkdidprovider.updateidentifier.md b/docs/api/did-provider-jwk.jwkdidprovider.updateidentifier.md index 0ddde1be..bd57ec6f 100644 --- a/docs/api/did-provider-jwk.jwkdidprovider.updateidentifier.md +++ b/docs/api/did-provider-jwk.jwkdidprovider.updateidentifier.md @@ -8,7 +8,7 @@ hide_title: true ## JwkDIDProvider.updateIdentifier() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-provider-key.keydidprovider._constructor_.md b/docs/api/did-provider-key.keydidprovider._constructor_.md index d0e4b6ce..330901f3 100644 --- a/docs/api/did-provider-key.keydidprovider._constructor_.md +++ b/docs/api/did-provider-key.keydidprovider._constructor_.md @@ -8,7 +8,7 @@ hide_title: true ## KeyDIDProvider.(constructor) -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Constructs a new instance of the `KeyDIDProvider` class diff --git a/docs/api/did-provider-key.keydidprovider.addkey.md b/docs/api/did-provider-key.keydidprovider.addkey.md index 34abdd2a..fccf7678 100644 --- a/docs/api/did-provider-key.keydidprovider.addkey.md +++ b/docs/api/did-provider-key.keydidprovider.addkey.md @@ -8,7 +8,7 @@ hide_title: true ## KeyDIDProvider.addKey() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-provider-key.keydidprovider.addservice.md b/docs/api/did-provider-key.keydidprovider.addservice.md index 05bb6de6..b9916556 100644 --- a/docs/api/did-provider-key.keydidprovider.addservice.md +++ b/docs/api/did-provider-key.keydidprovider.addservice.md @@ -8,7 +8,7 @@ hide_title: true ## KeyDIDProvider.addService() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-provider-key.keydidprovider.createidentifier.md b/docs/api/did-provider-key.keydidprovider.createidentifier.md index 0e42c742..b2ec8852 100644 --- a/docs/api/did-provider-key.keydidprovider.createidentifier.md +++ b/docs/api/did-provider-key.keydidprovider.createidentifier.md @@ -8,7 +8,7 @@ hide_title: true ## KeyDIDProvider.createIdentifier() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-provider-key.keydidprovider.deleteidentifier.md b/docs/api/did-provider-key.keydidprovider.deleteidentifier.md index c9190490..ad04c7df 100644 --- a/docs/api/did-provider-key.keydidprovider.deleteidentifier.md +++ b/docs/api/did-provider-key.keydidprovider.deleteidentifier.md @@ -8,7 +8,7 @@ hide_title: true ## KeyDIDProvider.deleteIdentifier() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-provider-key.keydidprovider.md b/docs/api/did-provider-key.keydidprovider.md index ad7db30b..cf27bcd1 100644 --- a/docs/api/did-provider-key.keydidprovider.md +++ b/docs/api/did-provider-key.keydidprovider.md @@ -8,7 +8,7 @@ hide_title: true ## KeyDIDProvider class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. [DIDManager](./did-manager.didmanager.md) identifier provider for `did:key` identifiers diff --git a/docs/api/did-provider-key.keydidprovider.removekey.md b/docs/api/did-provider-key.keydidprovider.removekey.md index 08a86469..7170ac4d 100644 --- a/docs/api/did-provider-key.keydidprovider.removekey.md +++ b/docs/api/did-provider-key.keydidprovider.removekey.md @@ -8,7 +8,7 @@ hide_title: true ## KeyDIDProvider.removeKey() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-provider-key.keydidprovider.removeservice.md b/docs/api/did-provider-key.keydidprovider.removeservice.md index b83b5530..5c9ae079 100644 --- a/docs/api/did-provider-key.keydidprovider.removeservice.md +++ b/docs/api/did-provider-key.keydidprovider.removeservice.md @@ -8,7 +8,7 @@ hide_title: true ## KeyDIDProvider.removeService() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-provider-key.keydidprovider.updateidentifier.md b/docs/api/did-provider-key.keydidprovider.updateidentifier.md index 159898e7..aab97cb4 100644 --- a/docs/api/did-provider-key.keydidprovider.updateidentifier.md +++ b/docs/api/did-provider-key.keydidprovider.updateidentifier.md @@ -8,7 +8,7 @@ hide_title: true ## KeyDIDProvider.updateIdentifier() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-provider-peer.peerdidprovider._constructor_.md b/docs/api/did-provider-peer.peerdidprovider._constructor_.md index 426c13c6..5c890617 100644 --- a/docs/api/did-provider-peer.peerdidprovider._constructor_.md +++ b/docs/api/did-provider-peer.peerdidprovider._constructor_.md @@ -8,7 +8,7 @@ hide_title: true ## PeerDIDProvider.(constructor) -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Constructs a new instance of the `PeerDIDProvider` class diff --git a/docs/api/did-provider-peer.peerdidprovider.addkey.md b/docs/api/did-provider-peer.peerdidprovider.addkey.md index 8830d09b..2ecbb654 100644 --- a/docs/api/did-provider-peer.peerdidprovider.addkey.md +++ b/docs/api/did-provider-peer.peerdidprovider.addkey.md @@ -8,7 +8,7 @@ hide_title: true ## PeerDIDProvider.addKey() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-provider-peer.peerdidprovider.addservice.md b/docs/api/did-provider-peer.peerdidprovider.addservice.md index 936b09c7..6113a20b 100644 --- a/docs/api/did-provider-peer.peerdidprovider.addservice.md +++ b/docs/api/did-provider-peer.peerdidprovider.addservice.md @@ -8,7 +8,7 @@ hide_title: true ## PeerDIDProvider.addService() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-provider-peer.peerdidprovider.createidentifier.md b/docs/api/did-provider-peer.peerdidprovider.createidentifier.md index abcff3a0..2ec659e5 100644 --- a/docs/api/did-provider-peer.peerdidprovider.createidentifier.md +++ b/docs/api/did-provider-peer.peerdidprovider.createidentifier.md @@ -8,23 +8,23 @@ hide_title: true ## PeerDIDProvider.createIdentifier() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** ```typescript createIdentifier({ kms, options }: { kms?: string; - options?: any; + options?: CreatePeerDidOptions; }, context: IContext): Promise>; ``` ## Parameters -| Parameter | Type | Description | -| ---------------- | -------------------------------- | ----------- | -| { kms, options } | { kms?: string; options?: any; } | | -| context | IContext | | +| Parameter | Type | Description | +| ---------------- | ------------------------------------------------- | ----------- | +| { kms, options } | { kms?: string; options?: CreatePeerDidOptions; } | | +| context | IContext | | **Returns:** diff --git a/docs/api/did-provider-peer.peerdidprovider.deleteidentifier.md b/docs/api/did-provider-peer.peerdidprovider.deleteidentifier.md index 3a97404a..4964ebe7 100644 --- a/docs/api/did-provider-peer.peerdidprovider.deleteidentifier.md +++ b/docs/api/did-provider-peer.peerdidprovider.deleteidentifier.md @@ -8,7 +8,7 @@ hide_title: true ## PeerDIDProvider.deleteIdentifier() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-provider-peer.peerdidprovider.md b/docs/api/did-provider-peer.peerdidprovider.md index a411a125..80cc57b5 100644 --- a/docs/api/did-provider-peer.peerdidprovider.md +++ b/docs/api/did-provider-peer.peerdidprovider.md @@ -8,7 +8,7 @@ hide_title: true ## PeerDIDProvider class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. [DIDManager](./did-manager.didmanager.md) identifier provider for `did:key` identifiers diff --git a/docs/api/did-provider-peer.peerdidprovider.removekey.md b/docs/api/did-provider-peer.peerdidprovider.removekey.md index a0e1a298..d0cc36ec 100644 --- a/docs/api/did-provider-peer.peerdidprovider.removekey.md +++ b/docs/api/did-provider-peer.peerdidprovider.removekey.md @@ -8,7 +8,7 @@ hide_title: true ## PeerDIDProvider.removeKey() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-provider-peer.peerdidprovider.removeservice.md b/docs/api/did-provider-peer.peerdidprovider.removeservice.md index 47f0d110..94989492 100644 --- a/docs/api/did-provider-peer.peerdidprovider.removeservice.md +++ b/docs/api/did-provider-peer.peerdidprovider.removeservice.md @@ -8,7 +8,7 @@ hide_title: true ## PeerDIDProvider.removeService() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-provider-peer.peerdidprovider.updateidentifier.md b/docs/api/did-provider-peer.peerdidprovider.updateidentifier.md index 9c070f91..bc0dfcf6 100644 --- a/docs/api/did-provider-peer.peerdidprovider.updateidentifier.md +++ b/docs/api/did-provider-peer.peerdidprovider.updateidentifier.md @@ -8,7 +8,7 @@ hide_title: true ## PeerDIDProvider.updateIdentifier() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-provider-pkh.pkhdidprovider._constructor_.md b/docs/api/did-provider-pkh.pkhdidprovider._constructor_.md index 55e30f86..5c8d38b5 100644 --- a/docs/api/did-provider-pkh.pkhdidprovider._constructor_.md +++ b/docs/api/did-provider-pkh.pkhdidprovider._constructor_.md @@ -8,7 +8,7 @@ hide_title: true ## PkhDIDProvider.(constructor) -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Constructs a new instance of the `PkhDIDProvider` class diff --git a/docs/api/did-provider-pkh.pkhdidprovider.addkey.md b/docs/api/did-provider-pkh.pkhdidprovider.addkey.md index 32902e5e..450b859c 100644 --- a/docs/api/did-provider-pkh.pkhdidprovider.addkey.md +++ b/docs/api/did-provider-pkh.pkhdidprovider.addkey.md @@ -8,7 +8,7 @@ hide_title: true ## PkhDIDProvider.addKey() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-provider-pkh.pkhdidprovider.addservice.md b/docs/api/did-provider-pkh.pkhdidprovider.addservice.md index 64bd1aae..e05f3dfe 100644 --- a/docs/api/did-provider-pkh.pkhdidprovider.addservice.md +++ b/docs/api/did-provider-pkh.pkhdidprovider.addservice.md @@ -8,7 +8,7 @@ hide_title: true ## PkhDIDProvider.addService() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-provider-pkh.pkhdidprovider.createidentifier.md b/docs/api/did-provider-pkh.pkhdidprovider.createidentifier.md index 30c47c35..96507a00 100644 --- a/docs/api/did-provider-pkh.pkhdidprovider.createidentifier.md +++ b/docs/api/did-provider-pkh.pkhdidprovider.createidentifier.md @@ -8,7 +8,7 @@ hide_title: true ## PkhDIDProvider.createIdentifier() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-provider-pkh.pkhdidprovider.deleteidentifier.md b/docs/api/did-provider-pkh.pkhdidprovider.deleteidentifier.md index 7dd5db60..e407179d 100644 --- a/docs/api/did-provider-pkh.pkhdidprovider.deleteidentifier.md +++ b/docs/api/did-provider-pkh.pkhdidprovider.deleteidentifier.md @@ -8,7 +8,7 @@ hide_title: true ## PkhDIDProvider.deleteIdentifier() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-provider-pkh.pkhdidprovider.md b/docs/api/did-provider-pkh.pkhdidprovider.md index b82bb74e..08da0285 100644 --- a/docs/api/did-provider-pkh.pkhdidprovider.md +++ b/docs/api/did-provider-pkh.pkhdidprovider.md @@ -8,7 +8,7 @@ hide_title: true ## PkhDIDProvider class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. [DIDManager](./did-manager.didmanager.md) identifier provider for `did:pkh` identifiers diff --git a/docs/api/did-provider-pkh.pkhdidprovider.removekey.md b/docs/api/did-provider-pkh.pkhdidprovider.removekey.md index 993bda4c..ad0d0a48 100644 --- a/docs/api/did-provider-pkh.pkhdidprovider.removekey.md +++ b/docs/api/did-provider-pkh.pkhdidprovider.removekey.md @@ -8,7 +8,7 @@ hide_title: true ## PkhDIDProvider.removeKey() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-provider-pkh.pkhdidprovider.removeservice.md b/docs/api/did-provider-pkh.pkhdidprovider.removeservice.md index 97656d36..b29c62da 100644 --- a/docs/api/did-provider-pkh.pkhdidprovider.removeservice.md +++ b/docs/api/did-provider-pkh.pkhdidprovider.removeservice.md @@ -8,7 +8,7 @@ hide_title: true ## PkhDIDProvider.removeService() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/did-provider-pkh.pkhdidprovider.updateidentifier.md b/docs/api/did-provider-pkh.pkhdidprovider.updateidentifier.md index ecf9c405..ab52d71e 100644 --- a/docs/api/did-provider-pkh.pkhdidprovider.updateidentifier.md +++ b/docs/api/did-provider-pkh.pkhdidprovider.updateidentifier.md @@ -8,7 +8,7 @@ hide_title: true ## PkhDIDProvider.updateIdentifier() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/key-manager.eip712payload.md b/docs/api/key-manager.eip712payload.md index b0c9f685..61b38e1d 100644 --- a/docs/api/key-manager.eip712payload.md +++ b/docs/api/key-manager.eip712payload.md @@ -8,7 +8,7 @@ hide_title: true ## Eip712Payload type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The payload that is sent to be signed according to EIP712 diff --git a/docs/api/kms-web3.web3keymanagementsystem._constructor_.md b/docs/api/kms-web3.web3keymanagementsystem._constructor_.md index 994ec10a..03d11320 100644 --- a/docs/api/kms-web3.web3keymanagementsystem._constructor_.md +++ b/docs/api/kms-web3.web3keymanagementsystem._constructor_.md @@ -8,7 +8,7 @@ hide_title: true ## Web3KeyManagementSystem.(constructor) -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Constructs a new instance of the `Web3KeyManagementSystem` class diff --git a/docs/api/kms-web3.web3keymanagementsystem.createkey.md b/docs/api/kms-web3.web3keymanagementsystem.createkey.md index ac1c0829..140964d7 100644 --- a/docs/api/kms-web3.web3keymanagementsystem.createkey.md +++ b/docs/api/kms-web3.web3keymanagementsystem.createkey.md @@ -8,7 +8,7 @@ hide_title: true ## Web3KeyManagementSystem.createKey() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/kms-web3.web3keymanagementsystem.deletekey.md b/docs/api/kms-web3.web3keymanagementsystem.deletekey.md index b864e16e..0d412957 100644 --- a/docs/api/kms-web3.web3keymanagementsystem.deletekey.md +++ b/docs/api/kms-web3.web3keymanagementsystem.deletekey.md @@ -8,7 +8,7 @@ hide_title: true ## Web3KeyManagementSystem.deleteKey() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/kms-web3.web3keymanagementsystem.importkey.md b/docs/api/kms-web3.web3keymanagementsystem.importkey.md index 09371987..1022828c 100644 --- a/docs/api/kms-web3.web3keymanagementsystem.importkey.md +++ b/docs/api/kms-web3.web3keymanagementsystem.importkey.md @@ -8,7 +8,7 @@ hide_title: true ## Web3KeyManagementSystem.importKey() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/kms-web3.web3keymanagementsystem.listkeys.md b/docs/api/kms-web3.web3keymanagementsystem.listkeys.md index 70dc47d1..a350df50 100644 --- a/docs/api/kms-web3.web3keymanagementsystem.listkeys.md +++ b/docs/api/kms-web3.web3keymanagementsystem.listkeys.md @@ -8,7 +8,7 @@ hide_title: true ## Web3KeyManagementSystem.listKeys() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/kms-web3.web3keymanagementsystem.md b/docs/api/kms-web3.web3keymanagementsystem.md index c02f5923..9abb8ef3 100644 --- a/docs/api/kms-web3.web3keymanagementsystem.md +++ b/docs/api/kms-web3.web3keymanagementsystem.md @@ -8,7 +8,7 @@ hide_title: true ## Web3KeyManagementSystem class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This is a [KMS](./key-manager.abstractkeymanagementsystem.md) implementation that uses the addresses of a web3 wallet as key identifiers, and calls the respective wallet for signing operations. diff --git a/docs/api/kms-web3.web3keymanagementsystem.sharedsecret.md b/docs/api/kms-web3.web3keymanagementsystem.sharedsecret.md index 705392bf..c6bcce74 100644 --- a/docs/api/kms-web3.web3keymanagementsystem.sharedsecret.md +++ b/docs/api/kms-web3.web3keymanagementsystem.sharedsecret.md @@ -8,7 +8,7 @@ hide_title: true ## Web3KeyManagementSystem.sharedSecret() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/kms-web3.web3keymanagementsystem.sign.md b/docs/api/kms-web3.web3keymanagementsystem.sign.md index 932fc75d..f8d731ce 100644 --- a/docs/api/kms-web3.web3keymanagementsystem.sign.md +++ b/docs/api/kms-web3.web3keymanagementsystem.sign.md @@ -8,7 +8,7 @@ hide_title: true ## Web3KeyManagementSystem.sign() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/remote-client.getopenapischema.md b/docs/api/remote-client.getopenapischema.md index d1d8c32a..7480fc63 100644 --- a/docs/api/remote-client.getopenapischema.md +++ b/docs/api/remote-client.getopenapischema.md @@ -1,12 +1,12 @@ --- id: remote-client.getopenapischema -title: getOpenApiSchema variable +title: getOpenApiSchema() function hide_title: true --- -## getOpenApiSchema variable +## getOpenApiSchema() function This method can be used to generate an OpenAPIv3 schema to describe how the methods of a Veramo agent can be called remotely. @@ -21,3 +21,17 @@ getOpenApiSchema: ( version?: string, ) => OpenAPIV3.Document ``` + +## Parameters + +| Parameter | Type | Description | +| -------------- | -------------------------------- | ------------------------------------------------------ | +| agent | [IAgent](./core-types.iagent.md) | The agent whose schema needs to be interpreted. | +| basePath | string | The base URL | +| exposedMethods | Array<string> | The list of method names available through this schema | +| name | string | _(Optional)_ The name of the agent | +| version | string | _(Optional)_ The version of the agent | + +**Returns:** + +OpenAPIV3.Document diff --git a/docs/api/remote-client.md b/docs/api/remote-client.md index d13f96c5..4af24664 100644 --- a/docs/api/remote-client.md +++ b/docs/api/remote-client.md @@ -16,8 +16,8 @@ Provides a [plugin](./remote-client.agentrestclient.md) for the [Agent](./core.a | ----------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [AgentRestClient](./remote-client.agentrestclient.md) |

This plugin can be used to access the methods of a remote Veramo agent as if they were implemented locally.

The remote agent should be provided by [AgentRouter](./remote-server.agentrouter.md), or a similar implementation of this API.

The schema of the remote agent is usually provided by [ApiSchemaRouter](./remote-server.apischemarouter.md).

| -## Variables +## Functions -| Variable | Description | -| ------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| [getOpenApiSchema](./remote-client.getopenapischema.md) | This method can be used to generate an OpenAPIv3 schema to describe how the methods of a Veramo agent can be called remotely. | +| Function | Description | +| ------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | +| [getOpenApiSchema(agent, basePath, exposedMethods, name, version)](./remote-client.getopenapischema.md) | This method can be used to generate an OpenAPIv3 schema to describe how the methods of a Veramo agent can be called remotely. | diff --git a/docs/api/remote-server.agentrouter.md b/docs/api/remote-server.agentrouter.md index 3cae3312..10078688 100644 --- a/docs/api/remote-server.agentrouter.md +++ b/docs/api/remote-server.agentrouter.md @@ -1,12 +1,12 @@ --- id: remote-server.agentrouter -title: AgentRouter variable +title: AgentRouter() function hide_title: true --- -## AgentRouter variable +## AgentRouter() function Creates a router that exposes [Agent](./core.agent.md) methods remotely. @@ -17,3 +17,15 @@ This can be used by [AgentRestClient](./remote-client.agentrestclient.md) to ins ```typescript AgentRouter: (options: AgentRouterOptions) => Router ``` + +## Parameters + +| Parameter | Type | Description | +| --------- | ----------------------------------------------------------- | --------------------- | +| options | [AgentRouterOptions](./remote-server.agentrouteroptions.md) | Initialization option | + +**Returns:** + +Router + +Expressjs router diff --git a/docs/api/remote-server.apischemarouter.md b/docs/api/remote-server.apischemarouter.md index 12aded5d..3e88a087 100644 --- a/docs/api/remote-server.apischemarouter.md +++ b/docs/api/remote-server.apischemarouter.md @@ -1,12 +1,12 @@ --- id: remote-server.apischemarouter -title: ApiSchemaRouter variable +title: ApiSchemaRouter() function hide_title: true --- -## ApiSchemaRouter variable +## ApiSchemaRouter() function Creates a router that exposes [Agent](./core.agent.md) OpenAPI schema @@ -15,3 +15,15 @@ Creates a router that exposes [Agent](./core.agent.md) OpenAPI schema ```typescript ApiSchemaRouter: (options: ApiSchemaRouterOptions) => Router ``` + +## Parameters + +| Parameter | Type | Description | +| --------- | ------------------------------------------------------------------- | --------------------- | +| options | [ApiSchemaRouterOptions](./remote-server.apischemarouteroptions.md) | Initialization option | + +**Returns:** + +Router + +Expressjs router diff --git a/docs/api/remote-server.createdefaultdid.md b/docs/api/remote-server.createdefaultdid.md index def90938..8e6534fb 100644 --- a/docs/api/remote-server.createdefaultdid.md +++ b/docs/api/remote-server.createdefaultdid.md @@ -8,7 +8,7 @@ hide_title: true ## createDefaultDid() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. This can be used to automatically create a did:web with signing and encryption keys and listing messaging and DIDComm service endpoints. diff --git a/docs/api/remote-server.md b/docs/api/remote-server.md index 4b457824..4269c37c 100644 --- a/docs/api/remote-server.md +++ b/docs/api/remote-server.md @@ -46,10 +46,15 @@ app.listen(3002) ## Functions -| Function | Description | -| ---------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| [apiKeyAuth({ apiKey })](./remote-server.apikeyauth.md) | This provides a simple authorization mechanism based on a single pre-shared API key. | -| [createDefaultDid(options)](./remote-server.createdefaultdid.md) | **_(BETA)_** This can be used to automatically create a did:web with signing and encryption keys and listing messaging and DIDComm service endpoints. | +| Function | Description | +| ---------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [AgentRouter(options)](./remote-server.agentrouter.md) |

Creates a router that exposes [Agent](./core.agent.md) methods remotely.

This can be used by [AgentRestClient](./remote-client.agentrestclient.md) to instantiate the methods of this agent on the client.

| +| [apiKeyAuth({ apiKey })](./remote-server.apikeyauth.md) | This provides a simple authorization mechanism based on a single pre-shared API key. | +| [ApiSchemaRouter(options)](./remote-server.apischemarouter.md) | Creates a router that exposes [Agent](./core.agent.md) OpenAPI schema | +| [createDefaultDid(options)](./remote-server.createdefaultdid.md) | **_(BETA)_** This can be used to automatically create a did:web with signing and encryption keys and listing messaging and DIDComm service endpoints. | +| [MessagingRouter(options)](./remote-server.messagingrouter.md) |

Creates a router for handling incoming messages.

Messages posted to this router get sent to the handleMessage method of the associated agent where this is used.

| +| [RequestWithAgentRouter(options)](./remote-server.requestwithagentrouter.md) |

Creates an expressjs router that adds a Veramo agent to the request object.

This is needed by all other routers provided by this package to be able to perform their functions.

| +| [WebDidDocRouter(options)](./remote-server.webdiddocrouter.md) | Creates a router that serves did:web DID Documents | ## Interfaces @@ -60,11 +65,6 @@ app.listen(3002) ## Variables -| Variable | Description | -| ------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [AgentRouter](./remote-server.agentrouter.md) |

Creates a router that exposes [Agent](./core.agent.md) methods remotely.

This can be used by [AgentRestClient](./remote-client.agentrestclient.md) to instantiate the methods of this agent on the client.

| -| [ApiSchemaRouter](./remote-server.apischemarouter.md) | Creates a router that exposes [Agent](./core.agent.md) OpenAPI schema | -| [didDocEndpoint](./remote-server.diddocendpoint.md) | The URL path to the DID document, used by did:web when the identifier is a hostname. | -| [MessagingRouter](./remote-server.messagingrouter.md) |

Creates a router for handling incoming messages.

Messages posted to this router get sent to the handleMessage method of the associated agent where this is used.

| -| [RequestWithAgentRouter](./remote-server.requestwithagentrouter.md) |

Creates an expressjs router that adds a Veramo agent to the request object.

This is needed by all other routers provided by this package to be able to perform their functions.

| -| [WebDidDocRouter](./remote-server.webdiddocrouter.md) | Creates a router that serves did:web DID Documents | +| Variable | Description | +| --------------------------------------------------- | ------------------------------------------------------------------------------------ | +| [didDocEndpoint](./remote-server.diddocendpoint.md) | The URL path to the DID document, used by did:web when the identifier is a hostname. | diff --git a/docs/api/remote-server.messagingrouter.md b/docs/api/remote-server.messagingrouter.md index b48bab8d..d1cfe866 100644 --- a/docs/api/remote-server.messagingrouter.md +++ b/docs/api/remote-server.messagingrouter.md @@ -1,12 +1,12 @@ --- id: remote-server.messagingrouter -title: MessagingRouter variable +title: MessagingRouter() function hide_title: true --- -## MessagingRouter variable +## MessagingRouter() function Creates a router for handling incoming messages. @@ -17,3 +17,15 @@ Messages posted to this router get sent to the `handleMessage` method of the ass ```typescript MessagingRouter: (options: MessagingRouterOptions) => Router ``` + +## Parameters + +| Parameter | Type | Description | +| --------- | ---------------------- | --------------------- | +| options | MessagingRouterOptions | Initialization option | + +**Returns:** + +Router + +Expressjs router diff --git a/docs/api/remote-server.requestwithagentrouter.md b/docs/api/remote-server.requestwithagentrouter.md index 6fb20111..ec72b561 100644 --- a/docs/api/remote-server.requestwithagentrouter.md +++ b/docs/api/remote-server.requestwithagentrouter.md @@ -1,12 +1,12 @@ --- id: remote-server.requestwithagentrouter -title: RequestWithAgentRouter variable +title: RequestWithAgentRouter() function hide_title: true --- -## RequestWithAgentRouter variable +## RequestWithAgentRouter() function Creates an expressjs router that adds a Veramo agent to the request object. @@ -17,3 +17,15 @@ This is needed by all other routers provided by this package to be able to perfo ```typescript RequestWithAgentRouter: (options: RequestWithAgentRouterOptions) => Router ``` + +## Parameters + +| Parameter | Type | Description | +| --------- | ----------------------------- | --------------------- | +| options | RequestWithAgentRouterOptions | Initialization option | + +**Returns:** + +Router + +Expressjs router diff --git a/docs/api/remote-server.webdiddocrouter.md b/docs/api/remote-server.webdiddocrouter.md index 7e0db399..064704fa 100644 --- a/docs/api/remote-server.webdiddocrouter.md +++ b/docs/api/remote-server.webdiddocrouter.md @@ -1,12 +1,12 @@ --- id: remote-server.webdiddocrouter -title: WebDidDocRouter variable +title: WebDidDocRouter() function hide_title: true --- -## WebDidDocRouter variable +## WebDidDocRouter() function Creates a router that serves `did:web` DID Documents @@ -15,3 +15,15 @@ Creates a router that serves `did:web` DID Documents ```typescript WebDidDocRouter: (options: WebDidDocRouterOptions) => Router ``` + +## Parameters + +| Parameter | Type | Description | +| --------- | ---------------------- | --------------------- | +| options | WebDidDocRouterOptions | Initialization option | + +**Returns:** + +Router + +Expressjs router diff --git a/docs/api/selective-disclosure.icreateprofilecredentialsargs.holder.md b/docs/api/selective-disclosure.icreateprofilecredentialsargs.holder.md index f4d724ed..5ded3838 100644 --- a/docs/api/selective-disclosure.icreateprofilecredentialsargs.holder.md +++ b/docs/api/selective-disclosure.icreateprofilecredentialsargs.holder.md @@ -8,7 +8,7 @@ hide_title: true ## ICreateProfileCredentialsArgs.holder property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Holder DID diff --git a/docs/api/selective-disclosure.icreateprofilecredentialsargs.md b/docs/api/selective-disclosure.icreateprofilecredentialsargs.md index 02e62e36..d4a981bc 100644 --- a/docs/api/selective-disclosure.icreateprofilecredentialsargs.md +++ b/docs/api/selective-disclosure.icreateprofilecredentialsargs.md @@ -8,7 +8,7 @@ hide_title: true ## ICreateProfileCredentialsArgs interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Profile data diff --git a/docs/api/selective-disclosure.icreateprofilecredentialsargs.name.md b/docs/api/selective-disclosure.icreateprofilecredentialsargs.name.md index 9566bb23..7bccb7ae 100644 --- a/docs/api/selective-disclosure.icreateprofilecredentialsargs.name.md +++ b/docs/api/selective-disclosure.icreateprofilecredentialsargs.name.md @@ -8,7 +8,7 @@ hide_title: true ## ICreateProfileCredentialsArgs.name property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Optional. Name diff --git a/docs/api/selective-disclosure.icreateprofilecredentialsargs.picture.md b/docs/api/selective-disclosure.icreateprofilecredentialsargs.picture.md index 723b7e0a..457013da 100644 --- a/docs/api/selective-disclosure.icreateprofilecredentialsargs.picture.md +++ b/docs/api/selective-disclosure.icreateprofilecredentialsargs.picture.md @@ -8,7 +8,7 @@ hide_title: true ## ICreateProfileCredentialsArgs.picture property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Optional. Picture URL diff --git a/docs/api/selective-disclosure.icreateprofilecredentialsargs.save.md b/docs/api/selective-disclosure.icreateprofilecredentialsargs.save.md index 83f6a1ed..13102a33 100644 --- a/docs/api/selective-disclosure.icreateprofilecredentialsargs.save.md +++ b/docs/api/selective-disclosure.icreateprofilecredentialsargs.save.md @@ -8,7 +8,7 @@ hide_title: true ## ICreateProfileCredentialsArgs.save property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Save presentation diff --git a/docs/api/selective-disclosure.icreateprofilecredentialsargs.send.md b/docs/api/selective-disclosure.icreateprofilecredentialsargs.send.md index 8acc3ec6..96a0e852 100644 --- a/docs/api/selective-disclosure.icreateprofilecredentialsargs.send.md +++ b/docs/api/selective-disclosure.icreateprofilecredentialsargs.send.md @@ -8,7 +8,7 @@ hide_title: true ## ICreateProfileCredentialsArgs.send property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Send presentation diff --git a/docs/api/selective-disclosure.icreateprofilecredentialsargs.url.md b/docs/api/selective-disclosure.icreateprofilecredentialsargs.url.md index 9252dc8b..8861e772 100644 --- a/docs/api/selective-disclosure.icreateprofilecredentialsargs.url.md +++ b/docs/api/selective-disclosure.icreateprofilecredentialsargs.url.md @@ -8,7 +8,7 @@ hide_title: true ## ICreateProfileCredentialsArgs.url property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Optional. URL diff --git a/docs/api/selective-disclosure.icreateprofilecredentialsargs.verifier.md b/docs/api/selective-disclosure.icreateprofilecredentialsargs.verifier.md index c3fb6498..f850b688 100644 --- a/docs/api/selective-disclosure.icreateprofilecredentialsargs.verifier.md +++ b/docs/api/selective-disclosure.icreateprofilecredentialsargs.verifier.md @@ -8,7 +8,7 @@ hide_title: true ## ICreateProfileCredentialsArgs.verifier property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Optional. Verifier DID diff --git a/docs/api/selective-disclosure.icreateselectivedisclosurerequestargs.data.md b/docs/api/selective-disclosure.icreateselectivedisclosurerequestargs.data.md index 48c2fa78..4de34229 100644 --- a/docs/api/selective-disclosure.icreateselectivedisclosurerequestargs.data.md +++ b/docs/api/selective-disclosure.icreateselectivedisclosurerequestargs.data.md @@ -8,7 +8,7 @@ hide_title: true ## ICreateSelectiveDisclosureRequestArgs.data property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/selective-disclosure.icreateselectivedisclosurerequestargs.md b/docs/api/selective-disclosure.icreateselectivedisclosurerequestargs.md index 0a6c8c8c..4550b2b6 100644 --- a/docs/api/selective-disclosure.icreateselectivedisclosurerequestargs.md +++ b/docs/api/selective-disclosure.icreateselectivedisclosurerequestargs.md @@ -8,7 +8,7 @@ hide_title: true ## ICreateSelectiveDisclosureRequestArgs interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Contains the parameters of a Selective Disclosure Request. diff --git a/docs/api/selective-disclosure.icredentialrequestinput.claimtype.md b/docs/api/selective-disclosure.icredentialrequestinput.claimtype.md index 79b528ad..4b74d0f4 100644 --- a/docs/api/selective-disclosure.icredentialrequestinput.claimtype.md +++ b/docs/api/selective-disclosure.icredentialrequestinput.claimtype.md @@ -8,7 +8,7 @@ hide_title: true ## ICredentialRequestInput.claimType property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The name of the claim property that the credential should express. diff --git a/docs/api/selective-disclosure.icredentialrequestinput.claimvalue.md b/docs/api/selective-disclosure.icredentialrequestinput.claimvalue.md index 2e2bfcad..d6993bae 100644 --- a/docs/api/selective-disclosure.icredentialrequestinput.claimvalue.md +++ b/docs/api/selective-disclosure.icredentialrequestinput.claimvalue.md @@ -8,7 +8,7 @@ hide_title: true ## ICredentialRequestInput.claimValue property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The value of the claim that the credential should express. diff --git a/docs/api/selective-disclosure.icredentialrequestinput.credentialcontext.md b/docs/api/selective-disclosure.icredentialrequestinput.credentialcontext.md index 55cab317..726fe524 100644 --- a/docs/api/selective-disclosure.icredentialrequestinput.credentialcontext.md +++ b/docs/api/selective-disclosure.icredentialrequestinput.credentialcontext.md @@ -8,7 +8,7 @@ hide_title: true ## ICredentialRequestInput.credentialContext property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The credential context. See [W3C Credential Context](https://www.w3.org/TR/vc-data-model/#contexts) diff --git a/docs/api/selective-disclosure.icredentialrequestinput.credentialtype.md b/docs/api/selective-disclosure.icredentialrequestinput.credentialtype.md index 84f082d4..f9ce6f10 100644 --- a/docs/api/selective-disclosure.icredentialrequestinput.credentialtype.md +++ b/docs/api/selective-disclosure.icredentialrequestinput.credentialtype.md @@ -8,7 +8,7 @@ hide_title: true ## ICredentialRequestInput.credentialType property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The credential type. See [W3C Credential Types](https://www.w3.org/TR/vc-data-model/#types) diff --git a/docs/api/selective-disclosure.icredentialrequestinput.essential.md b/docs/api/selective-disclosure.icredentialrequestinput.essential.md index 985513f5..7667afc3 100644 --- a/docs/api/selective-disclosure.icredentialrequestinput.essential.md +++ b/docs/api/selective-disclosure.icredentialrequestinput.essential.md @@ -8,7 +8,7 @@ hide_title: true ## ICredentialRequestInput.essential property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. If it is essential. A response that does not include this credential is not sufficient. diff --git a/docs/api/selective-disclosure.icredentialrequestinput.issuers.md b/docs/api/selective-disclosure.icredentialrequestinput.issuers.md index 48649825..8d980322 100644 --- a/docs/api/selective-disclosure.icredentialrequestinput.issuers.md +++ b/docs/api/selective-disclosure.icredentialrequestinput.issuers.md @@ -8,7 +8,7 @@ hide_title: true ## ICredentialRequestInput.issuers property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. A list of accepted Issuers for this credential. diff --git a/docs/api/selective-disclosure.icredentialrequestinput.md b/docs/api/selective-disclosure.icredentialrequestinput.md index 26a17f23..413b27ba 100644 --- a/docs/api/selective-disclosure.icredentialrequestinput.md +++ b/docs/api/selective-disclosure.icredentialrequestinput.md @@ -8,7 +8,7 @@ hide_title: true ## ICredentialRequestInput interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Describes a particular credential that is being requested diff --git a/docs/api/selective-disclosure.icredentialrequestinput.reason.md b/docs/api/selective-disclosure.icredentialrequestinput.reason.md index 7c6abd78..5096c249 100644 --- a/docs/api/selective-disclosure.icredentialrequestinput.reason.md +++ b/docs/api/selective-disclosure.icredentialrequestinput.reason.md @@ -8,7 +8,7 @@ hide_title: true ## ICredentialRequestInput.reason property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Motive for requiring this credential. diff --git a/docs/api/selective-disclosure.icredentialsforsdr.credentials.md b/docs/api/selective-disclosure.icredentialsforsdr.credentials.md index d3e32d55..1d1f115c 100644 --- a/docs/api/selective-disclosure.icredentialsforsdr.credentials.md +++ b/docs/api/selective-disclosure.icredentialsforsdr.credentials.md @@ -8,7 +8,7 @@ hide_title: true ## ICredentialsForSdr.credentials property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/selective-disclosure.icredentialsforsdr.md b/docs/api/selective-disclosure.icredentialsforsdr.md index 81f9ca3d..3603a52a 100644 --- a/docs/api/selective-disclosure.icredentialsforsdr.md +++ b/docs/api/selective-disclosure.icredentialsforsdr.md @@ -8,7 +8,7 @@ hide_title: true ## ICredentialsForSdr interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The credentials that make up a response of a Selective Disclosure diff --git a/docs/api/selective-disclosure.igetverifiablecredentialsforsdrargs.did.md b/docs/api/selective-disclosure.igetverifiablecredentialsforsdrargs.did.md index 4fc5bc5c..dcdf8fcd 100644 --- a/docs/api/selective-disclosure.igetverifiablecredentialsforsdrargs.did.md +++ b/docs/api/selective-disclosure.igetverifiablecredentialsforsdrargs.did.md @@ -8,7 +8,7 @@ hide_title: true ## IGetVerifiableCredentialsForSdrArgs.did property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The DID of the subject diff --git a/docs/api/selective-disclosure.igetverifiablecredentialsforsdrargs.md b/docs/api/selective-disclosure.igetverifiablecredentialsforsdrargs.md index 30a55dff..f080f962 100644 --- a/docs/api/selective-disclosure.igetverifiablecredentialsforsdrargs.md +++ b/docs/api/selective-disclosure.igetverifiablecredentialsforsdrargs.md @@ -8,7 +8,7 @@ hide_title: true ## IGetVerifiableCredentialsForSdrArgs interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Encapsulates the params needed to gather credentials to fulfill a Selective disclosure request. diff --git a/docs/api/selective-disclosure.igetverifiablecredentialsforsdrargs.sdr.md b/docs/api/selective-disclosure.igetverifiablecredentialsforsdrargs.sdr.md index 7d872c25..903dfc54 100644 --- a/docs/api/selective-disclosure.igetverifiablecredentialsforsdrargs.sdr.md +++ b/docs/api/selective-disclosure.igetverifiablecredentialsforsdrargs.sdr.md @@ -8,7 +8,7 @@ hide_title: true ## IGetVerifiableCredentialsForSdrArgs.sdr property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The Selective Disclosure Request (issuer is omitted) diff --git a/docs/api/selective-disclosure.ipresentationvalidationresult.claims.md b/docs/api/selective-disclosure.ipresentationvalidationresult.claims.md index dd5ccb8b..fb925251 100644 --- a/docs/api/selective-disclosure.ipresentationvalidationresult.claims.md +++ b/docs/api/selective-disclosure.ipresentationvalidationresult.claims.md @@ -8,7 +8,7 @@ hide_title: true ## IPresentationValidationResult.claims property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/selective-disclosure.ipresentationvalidationresult.md b/docs/api/selective-disclosure.ipresentationvalidationresult.md index 82cf3fe8..8254ba76 100644 --- a/docs/api/selective-disclosure.ipresentationvalidationresult.md +++ b/docs/api/selective-disclosure.ipresentationvalidationresult.md @@ -8,7 +8,7 @@ hide_title: true ## IPresentationValidationResult interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The result of a selective disclosure response validation. diff --git a/docs/api/selective-disclosure.ipresentationvalidationresult.valid.md b/docs/api/selective-disclosure.ipresentationvalidationresult.valid.md index 06927daf..32afe3d1 100644 --- a/docs/api/selective-disclosure.ipresentationvalidationresult.valid.md +++ b/docs/api/selective-disclosure.ipresentationvalidationresult.valid.md @@ -8,7 +8,7 @@ hide_title: true ## IPresentationValidationResult.valid property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/selective-disclosure.iselectivedisclosure.createprofilepresentation.md b/docs/api/selective-disclosure.iselectivedisclosure.createprofilepresentation.md index 55e8e79e..6d47aec2 100644 --- a/docs/api/selective-disclosure.iselectivedisclosure.createprofilepresentation.md +++ b/docs/api/selective-disclosure.iselectivedisclosure.createprofilepresentation.md @@ -8,7 +8,7 @@ hide_title: true ## ISelectiveDisclosure.createProfilePresentation() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/selective-disclosure.iselectivedisclosure.createselectivedisclosurerequest.md b/docs/api/selective-disclosure.iselectivedisclosure.createselectivedisclosurerequest.md index e98e71e4..fdddf704 100644 --- a/docs/api/selective-disclosure.iselectivedisclosure.createselectivedisclosurerequest.md +++ b/docs/api/selective-disclosure.iselectivedisclosure.createselectivedisclosurerequest.md @@ -8,7 +8,7 @@ hide_title: true ## ISelectiveDisclosure.createSelectiveDisclosureRequest() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/selective-disclosure.iselectivedisclosure.getverifiablecredentialsforsdr.md b/docs/api/selective-disclosure.iselectivedisclosure.getverifiablecredentialsforsdr.md index 3c1ec624..964dd528 100644 --- a/docs/api/selective-disclosure.iselectivedisclosure.getverifiablecredentialsforsdr.md +++ b/docs/api/selective-disclosure.iselectivedisclosure.getverifiablecredentialsforsdr.md @@ -8,7 +8,7 @@ hide_title: true ## ISelectiveDisclosure.getVerifiableCredentialsForSdr() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/selective-disclosure.iselectivedisclosure.md b/docs/api/selective-disclosure.iselectivedisclosure.md index a7987e48..9034e28d 100644 --- a/docs/api/selective-disclosure.iselectivedisclosure.md +++ b/docs/api/selective-disclosure.iselectivedisclosure.md @@ -8,7 +8,7 @@ hide_title: true ## ISelectiveDisclosure interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Describes the interface of a Selective Disclosure plugin. diff --git a/docs/api/selective-disclosure.iselectivedisclosure.validatepresentationagainstsdr.md b/docs/api/selective-disclosure.iselectivedisclosure.validatepresentationagainstsdr.md index 7882c60a..b30dae4c 100644 --- a/docs/api/selective-disclosure.iselectivedisclosure.validatepresentationagainstsdr.md +++ b/docs/api/selective-disclosure.iselectivedisclosure.validatepresentationagainstsdr.md @@ -8,7 +8,7 @@ hide_title: true ## ISelectiveDisclosure.validatePresentationAgainstSdr() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/selective-disclosure.iselectivedisclosurerequest.claims.md b/docs/api/selective-disclosure.iselectivedisclosurerequest.claims.md index 6595eaf1..d6dc338d 100644 --- a/docs/api/selective-disclosure.iselectivedisclosurerequest.claims.md +++ b/docs/api/selective-disclosure.iselectivedisclosurerequest.claims.md @@ -8,7 +8,7 @@ hide_title: true ## ISelectiveDisclosureRequest.claims property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. A list of claims that are being requested diff --git a/docs/api/selective-disclosure.iselectivedisclosurerequest.credentials.md b/docs/api/selective-disclosure.iselectivedisclosurerequest.credentials.md index 1c80da48..c70a578e 100644 --- a/docs/api/selective-disclosure.iselectivedisclosurerequest.credentials.md +++ b/docs/api/selective-disclosure.iselectivedisclosurerequest.credentials.md @@ -8,7 +8,7 @@ hide_title: true ## ISelectiveDisclosureRequest.credentials property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. A list of issuer credentials that the target will use to establish trust diff --git a/docs/api/selective-disclosure.iselectivedisclosurerequest.issuer.md b/docs/api/selective-disclosure.iselectivedisclosurerequest.issuer.md index b411e299..ab11ea32 100644 --- a/docs/api/selective-disclosure.iselectivedisclosurerequest.issuer.md +++ b/docs/api/selective-disclosure.iselectivedisclosurerequest.issuer.md @@ -8,7 +8,7 @@ hide_title: true ## ISelectiveDisclosureRequest.issuer property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The issuer of the request diff --git a/docs/api/selective-disclosure.iselectivedisclosurerequest.md b/docs/api/selective-disclosure.iselectivedisclosurerequest.md index 5e12a7dd..314c7f3f 100644 --- a/docs/api/selective-disclosure.iselectivedisclosurerequest.md +++ b/docs/api/selective-disclosure.iselectivedisclosurerequest.md @@ -8,7 +8,7 @@ hide_title: true ## ISelectiveDisclosureRequest interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Represents the Selective Disclosure request parameters. diff --git a/docs/api/selective-disclosure.iselectivedisclosurerequest.replyurl.md b/docs/api/selective-disclosure.iselectivedisclosurerequest.replyurl.md index d1a42d00..960fbfbb 100644 --- a/docs/api/selective-disclosure.iselectivedisclosurerequest.replyurl.md +++ b/docs/api/selective-disclosure.iselectivedisclosurerequest.replyurl.md @@ -8,7 +8,7 @@ hide_title: true ## ISelectiveDisclosureRequest.replyUrl property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The URL where the response should be sent back diff --git a/docs/api/selective-disclosure.iselectivedisclosurerequest.subject.md b/docs/api/selective-disclosure.iselectivedisclosurerequest.subject.md index 1ae47d47..eefdb900 100644 --- a/docs/api/selective-disclosure.iselectivedisclosurerequest.subject.md +++ b/docs/api/selective-disclosure.iselectivedisclosurerequest.subject.md @@ -8,7 +8,7 @@ hide_title: true ## ISelectiveDisclosureRequest.subject property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The target of the request diff --git a/docs/api/selective-disclosure.iselectivedisclosurerequest.tag.md b/docs/api/selective-disclosure.iselectivedisclosurerequest.tag.md index 2dc2e7bf..3e8ca27c 100644 --- a/docs/api/selective-disclosure.iselectivedisclosurerequest.tag.md +++ b/docs/api/selective-disclosure.iselectivedisclosurerequest.tag.md @@ -8,7 +8,7 @@ hide_title: true ## ISelectiveDisclosureRequest.tag property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/selective-disclosure.issuer.did.md b/docs/api/selective-disclosure.issuer.did.md index 3cf79b3c..cced7daf 100644 --- a/docs/api/selective-disclosure.issuer.did.md +++ b/docs/api/selective-disclosure.issuer.did.md @@ -8,7 +8,7 @@ hide_title: true ## Issuer.did property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. The DID of the issuer of a requested credential. diff --git a/docs/api/selective-disclosure.issuer.md b/docs/api/selective-disclosure.issuer.md index 03869519..6af4b204 100644 --- a/docs/api/selective-disclosure.issuer.md +++ b/docs/api/selective-disclosure.issuer.md @@ -8,7 +8,7 @@ hide_title: true ## Issuer interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Used for requesting Credentials using Selective Disclosure. Represents an accepted issuer of a credential. diff --git a/docs/api/selective-disclosure.issuer.url.md b/docs/api/selective-disclosure.issuer.url.md index 25f83660..e92583a6 100644 --- a/docs/api/selective-disclosure.issuer.url.md +++ b/docs/api/selective-disclosure.issuer.url.md @@ -8,7 +8,7 @@ hide_title: true ## Issuer.url property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. A URL where a credential of that type can be obtained. diff --git a/docs/api/selective-disclosure.ivalidatepresentationagainstsdrargs.md b/docs/api/selective-disclosure.ivalidatepresentationagainstsdrargs.md index f6cc90cd..5997c9f4 100644 --- a/docs/api/selective-disclosure.ivalidatepresentationagainstsdrargs.md +++ b/docs/api/selective-disclosure.ivalidatepresentationagainstsdrargs.md @@ -8,7 +8,7 @@ hide_title: true ## IValidatePresentationAgainstSdrArgs interface -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. A tuple used to verify a Selective Disclosure Response. Encapsulates the response(`presentation`) and the corresponding request (`sdr`) that made it. diff --git a/docs/api/selective-disclosure.ivalidatepresentationagainstsdrargs.presentation.md b/docs/api/selective-disclosure.ivalidatepresentationagainstsdrargs.presentation.md index 53ae9109..ce076c95 100644 --- a/docs/api/selective-disclosure.ivalidatepresentationagainstsdrargs.presentation.md +++ b/docs/api/selective-disclosure.ivalidatepresentationagainstsdrargs.presentation.md @@ -8,7 +8,7 @@ hide_title: true ## IValidatePresentationAgainstSdrArgs.presentation property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/selective-disclosure.ivalidatepresentationagainstsdrargs.sdr.md b/docs/api/selective-disclosure.ivalidatepresentationagainstsdrargs.sdr.md index 8e4ccf0e..da64aad7 100644 --- a/docs/api/selective-disclosure.ivalidatepresentationagainstsdrargs.sdr.md +++ b/docs/api/selective-disclosure.ivalidatepresentationagainstsdrargs.sdr.md @@ -8,7 +8,7 @@ hide_title: true ## IValidatePresentationAgainstSdrArgs.sdr property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/selective-disclosure.md b/docs/api/selective-disclosure.md index b2dc2153..e8ab31f9 100644 --- a/docs/api/selective-disclosure.md +++ b/docs/api/selective-disclosure.md @@ -14,10 +14,10 @@ Provides a [plugin](./selective-disclosure.sdrmessagehandler.md) for the [Messag ## Classes -| Class | Description | -| -------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [SdrMessageHandler](./selective-disclosure.sdrmessagehandler.md) |

**_(BETA)_** A Veramo message handler plugin that can decode an incoming Selective Disclosure Response into the internal Message representation.

This API may change without a BREAKING CHANGE notice.

| -| [SelectiveDisclosure](./selective-disclosure.selectivedisclosure.md) |

**_(BETA)_** This class adds support for creating [Selective Disclosure](https://github.com/uport-project/specs/blob/develop/flows/selectivedisclosure.md) requests and interpret the responses received.

This implementation of the uPort protocol uses [W3C Presentation](https://www.w3.org/TR/vc-data-model/#presentations) as the response encoding instead of a shareReq.

This API may change without a BREAKING CHANGE notice.

| +| Class | Description | +| -------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [SdrMessageHandler](./selective-disclosure.sdrmessagehandler.md) |

**_(BETA)_** A Veramo message handler plugin that can decode an incoming Selective Disclosure Response into the internal Message representation.

This API may change without a BREAKING CHANGE notice.

| +| [SelectiveDisclosure](./selective-disclosure.selectivedisclosure.md) |

**_(BETA)_** This class adds support for creating [uPort Selective Disclosure](https://github.com/uport-project/specs/blob/develop/flows/selectivedisclosure.md) requests and interpret the responses received.

This implementation of the uPort protocol uses [W3C Presentation](https://www.w3.org/TR/vc-data-model/#presentations) as the response encoding instead of a shareReq.

This API may change without a BREAKING CHANGE notice.

| ## Interfaces @@ -39,3 +39,4 @@ Provides a [plugin](./selective-disclosure.sdrmessagehandler.md) for the [Messag | Variable | Description | | ------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- | | [MessageTypes](./selective-disclosure.messagetypes.md) | **_(BETA)_** Identifies a [IMessage](./core-types.imessage.md) that represents a Selective Disclosure Request | +| [schema](./selective-disclosure.schema.md) | | diff --git a/docs/api/selective-disclosure.messagetypes.md b/docs/api/selective-disclosure.messagetypes.md index ba834943..f3e2d8c4 100644 --- a/docs/api/selective-disclosure.messagetypes.md +++ b/docs/api/selective-disclosure.messagetypes.md @@ -8,7 +8,7 @@ hide_title: true ## MessageTypes variable -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Identifies a [IMessage](./core-types.imessage.md) that represents a Selective Disclosure Request @@ -22,4 +22,4 @@ MessageTypes: { ## Remarks -See [Selective Disclosure Request](https://github.com/uport-project/specs/blob/develop/messages/sharereq.md) This API may change without a BREAKING CHANGE notice. +See [uPort Selective Disclosure Request](https://github.com/uport-project/specs/blob/develop/messages/sharereq.md) This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/selective-disclosure.schema.md b/docs/api/selective-disclosure.schema.md new file mode 100644 index 00000000..623e2723 --- /dev/null +++ b/docs/api/selective-disclosure.schema.md @@ -0,0 +1,487 @@ +--- +id: selective-disclosure.schema +title: schema variable +hide_title: true +--- + + + +## schema variable + +**Signature:** + +```typescript +schema: { + ISelectiveDisclosure: { + 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: { + proof: { + $ref: string; + }; + holder: { + type: string; + }; + verifiableCredential: { + type: string; + items: { + $ref: string; + }; + }; + type: { + anyOf: ({ + type: string; + items: { + type: string; + }; + } | { + type: string; + items?: undefined; + })[]; + }; + "@context": { + $ref: string; + }; + verifier: { + type: string; + items: { + type: string; + }; + }; + issuanceDate: { + type: string; + }; + expirationDate: { + type: string; + }; + id: { + type: string; + }; + }; + required: string[]; + description: string; + }; + ProofType: { + type: string; + properties: { + type: { + type: string; + }; + }; + description: string; + }; + W3CVerifiableCredential: { + anyOf: { + $ref: string; + }[]; + description: string; + }; + VerifiableCredential: { + type: string; + properties: { + proof: { + $ref: string; + }; + issuer: { + $ref: string; + }; + credentialSubject: { + $ref: string; + }; + type: { + anyOf: ({ + type: string; + items: { + type: string; + }; + } | { + type: string; + items?: undefined; + })[]; + }; + "@context": { + $ref: string; + }; + issuanceDate: { + type: string; + }; + expirationDate: { + type: string; + }; + credentialStatus: { + $ref: string; + }; + id: { + type: string; + }; + }; + required: string[]; + description: string; + }; + IssuerType: { + anyOf: ({ + type: string; + properties: { + id: { + type: string; + }; + }; + required: string[]; + } | { + type: string; + properties?: undefined; + required?: undefined; + })[]; + description: string; + }; + CredentialSubject: { + type: string; + properties: { + id: { + type: string; + }; + }; + description: string; + }; + ContextType: { + anyOf: ({ + type: string; + items?: undefined; + } | { + type: string; + items: { + anyOf: { + type: string; + }[]; + }; + })[]; + description: string; + }; + CredentialStatusReference: { + type: string; + properties: { + id: { + type: string; + }; + type: { + type: string; + }; + }; + required: string[]; + description: string; + }; + CompactJWT: { + type: 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; + }; + UniqueVerifiableCredential: { + type: string; + properties: { + hash: { + type: string; + }; + verifiableCredential: { + $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; + }; + }; + }; + }; + }; +} +``` diff --git a/docs/api/selective-disclosure.sdrmessagehandler.handle.md b/docs/api/selective-disclosure.sdrmessagehandler.handle.md index 2bfbfb92..edfe9bb6 100644 --- a/docs/api/selective-disclosure.sdrmessagehandler.handle.md +++ b/docs/api/selective-disclosure.sdrmessagehandler.handle.md @@ -8,7 +8,7 @@ hide_title: true ## SdrMessageHandler.handle() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/selective-disclosure.sdrmessagehandler.md b/docs/api/selective-disclosure.sdrmessagehandler.md index d47999b4..ad40e20c 100644 --- a/docs/api/selective-disclosure.sdrmessagehandler.md +++ b/docs/api/selective-disclosure.sdrmessagehandler.md @@ -8,7 +8,11 @@ hide_title: true ## SdrMessageHandler class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. + +> Warning: This API is now obsolete. +> +> This plugin is deprecated as it implements a non-standard protocol created for the uPort project. It will be removed in a future release. A Veramo message handler plugin that can decode an incoming Selective Disclosure Response into the internal Message representation. diff --git a/docs/api/selective-disclosure.selectivedisclosure._constructor_.md b/docs/api/selective-disclosure.selectivedisclosure._constructor_.md index a89ca773..398337fd 100644 --- a/docs/api/selective-disclosure.selectivedisclosure._constructor_.md +++ b/docs/api/selective-disclosure.selectivedisclosure._constructor_.md @@ -8,7 +8,7 @@ hide_title: true ## SelectiveDisclosure.(constructor) -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Constructs a new instance of the `SelectiveDisclosure` class diff --git a/docs/api/selective-disclosure.selectivedisclosure.createprofilepresentation.md b/docs/api/selective-disclosure.selectivedisclosure.createprofilepresentation.md index d862f614..e2aa9c55 100644 --- a/docs/api/selective-disclosure.selectivedisclosure.createprofilepresentation.md +++ b/docs/api/selective-disclosure.selectivedisclosure.createprofilepresentation.md @@ -8,7 +8,7 @@ hide_title: true ## SelectiveDisclosure.createProfilePresentation() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Creates profile credentials diff --git a/docs/api/selective-disclosure.selectivedisclosure.createselectivedisclosurerequest.md b/docs/api/selective-disclosure.selectivedisclosure.createselectivedisclosurerequest.md index 109b56be..5263a2f4 100644 --- a/docs/api/selective-disclosure.selectivedisclosure.createselectivedisclosurerequest.md +++ b/docs/api/selective-disclosure.selectivedisclosure.createselectivedisclosurerequest.md @@ -8,7 +8,7 @@ hide_title: true ## SelectiveDisclosure.createSelectiveDisclosureRequest() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Creates a Selective disclosure request, encoded as a JWT. @@ -31,4 +31,4 @@ Promise<string> ## Remarks -See [Selective Disclosure](https://github.com/uport-project/specs/blob/develop/flows/selectivedisclosure.md) +See [uPort Selective Disclosure](https://github.com/uport-project/specs/blob/develop/flows/selectivedisclosure.md) diff --git a/docs/api/selective-disclosure.selectivedisclosure.getverifiablecredentialsforsdr.md b/docs/api/selective-disclosure.selectivedisclosure.getverifiablecredentialsforsdr.md index 9a9cd7f8..3021668d 100644 --- a/docs/api/selective-disclosure.selectivedisclosure.getverifiablecredentialsforsdr.md +++ b/docs/api/selective-disclosure.selectivedisclosure.getverifiablecredentialsforsdr.md @@ -8,7 +8,7 @@ hide_title: true ## SelectiveDisclosure.getVerifiableCredentialsForSdr() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Gathers the required credentials necessary to fulfill a Selective Disclosure Request. It uses a [IDataStoreORM](./core-types.idatastoreorm.md) plugin implementation to query the local database for the required credentials. diff --git a/docs/api/selective-disclosure.selectivedisclosure.md b/docs/api/selective-disclosure.selectivedisclosure.md index 3919245f..59b28a07 100644 --- a/docs/api/selective-disclosure.selectivedisclosure.md +++ b/docs/api/selective-disclosure.selectivedisclosure.md @@ -8,9 +8,13 @@ hide_title: true ## SelectiveDisclosure class -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. -This class adds support for creating [Selective Disclosure](https://github.com/uport-project/specs/blob/develop/flows/selectivedisclosure.md) requests and interpret the responses received. +> Warning: This API is now obsolete. +> +> This plugin is deprecated as it implements a non-standard protocol created for the uPort project. It will be removed in a future release. + +This class adds support for creating [uPort Selective Disclosure](https://github.com/uport-project/specs/blob/develop/flows/selectivedisclosure.md) requests and interpret the responses received. This implementation of the uPort protocol uses [W3C Presentation](https://www.w3.org/TR/vc-data-model/#presentations) as the response encoding instead of a `shareReq`. @@ -32,10 +36,10 @@ export declare class SelectiveDisclosure implements IAgentPlugin ## Properties -| Property | Modifiers | Type | Description | -| ---------------------------------------------------------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | -| [methods](./selective-disclosure.selectivedisclosure.methods.md) | readonly | [ISelectiveDisclosure](./selective-disclosure.iselectivedisclosure.md) | **_(BETA)_** | -| [schema](./selective-disclosure.selectivedisclosure.schema.md) | readonly | { 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; /\*\* \* 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. \* \* 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\`. \* \* @beta This API may change without a BREAKING CHANGE notice. \*/ description: string; }; send: { type: string; description: string; }; }; required: string\[\]; description: string; }; VerifiablePresentation: { type: string; properties: { proof: { $ref: string; }; holder: { type: string; }; verifiableCredential: { type: string; items: { $ref: string; }; }; type: { anyOf: ({ 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 This API may change without a BREAKING CHANGE notice. \*/ }; } | { type: string; items?: undefined; })\[\]; }; "@context": { $ref: string; }; verifier: { type: string; items: { type: string; }; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; ProofType: { type: string; properties: { type: { type: string; }; }; description: string; }; W3CVerifiableCredential: { anyOf: { $ref: string; }\[\]; description: string; }; VerifiableCredential: { type: string; properties: { proof: { $ref: string; }; issuer: { $ref: string; }; credentialSubject: { $ref: string; }; type: { anyOf: ({ type: string; items: { type: string; }; } | { type: string; items?: undefined; })\[\]; }; "@context": { $ref: string; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; credentialStatus: { $ref: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; IssuerType: { anyOf: ({ type: string; properties: { id: { type: string; }; }; required: string\[\]; } | { type: string; properties?: undefined; required?: undefined; })\[\]; description: string; }; CredentialSubject: { type: string; properties: { id: { type: string; }; }; description: string; }; ContextType: { anyOf: ({ type: string; items?: undefined; } | { type: string; items: { anyOf: { type: string; }\[\]; }; })\[\]; description: string; }; CredentialStatusReference: { type: string; properties: { id: { type: string; }; type: { type: string; }; }; required: string\[\]; description: string; }; CompactJWT: { type: 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; }; UniqueVerifiableCredential: { type: string; properties: { hash: { type: string; }; verifiableCredential: { $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; }; }; }; }; } | **_(BETA)_** | +| Property | Modifiers | Type | Description | +| ---------------------------------------------------------------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | +| [methods](./selective-disclosure.selectivedisclosure.methods.md) | readonly | [ISelectiveDisclosure](./selective-disclosure.iselectivedisclosure.md) | **_(BETA)_** | +| [schema](./selective-disclosure.selectivedisclosure.schema.md) | readonly | { 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: { proof: { $ref: string; }; holder: { type: string; }; verifiableCredential: { type: string; items: { $ref: string; }; }; type: { anyOf: ({ type: string; items: { type: string; }; } | { type: string; items?: undefined; })\[\]; }; "@context": { $ref: string; }; verifier: { type: string; items: { type: string; }; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; ProofType: { type: string; properties: { type: { type: string; }; }; description: string; }; W3CVerifiableCredential: { anyOf: { $ref: string; }\[\]; description: string; }; VerifiableCredential: { type: string; properties: { proof: { $ref: string; }; issuer: { $ref: string; }; credentialSubject: { $ref: string; }; type: { anyOf: ({ type: string; items: { type: string; }; } | { type: string; items?: undefined; })\[\]; }; "@context": { $ref: string; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; credentialStatus: { $ref: string; }; id: { type: string; }; }; required: string\[\]; description: string; }; IssuerType: { anyOf: ({ type: string; properties: { id: { type: string; }; }; required: string\[\]; } | { type: string; properties?: undefined; required?: undefined; })\[\]; description: string; }; CredentialSubject: { type: string; properties: { id: { type: string; }; }; description: string; }; ContextType: { anyOf: ({ type: string; items?: undefined; } | { type: string; items: { anyOf: { type: string; }\[\]; }; })\[\]; description: string; }; CredentialStatusReference: { type: string; properties: { id: { type: string; }; type: { type: string; }; }; required: string\[\]; description: string; }; CompactJWT: { type: 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; }; UniqueVerifiableCredential: { type: string; properties: { hash: { type: string; }; verifiableCredential: { $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; }; }; }; }; } | **_(BETA)_** | ## Methods @@ -44,4 +48,4 @@ export declare class SelectiveDisclosure implements IAgentPlugin | [createProfilePresentation(args, context)](./selective-disclosure.selectivedisclosure.createprofilepresentation.md) | |

**_(BETA)_** Creates profile credentials

This API may change without a BREAKING CHANGE notice.

| | [createSelectiveDisclosureRequest(args, context)](./selective-disclosure.selectivedisclosure.createselectivedisclosurerequest.md) | | **_(BETA)_** Creates a Selective disclosure request, encoded as a JWT. | | [getVerifiableCredentialsForSdr(args, context)](./selective-disclosure.selectivedisclosure.getverifiablecredentialsforsdr.md) | | **_(BETA)_** Gathers the required credentials necessary to fulfill a Selective Disclosure Request. It uses a [IDataStoreORM](./core-types.idatastoreorm.md) plugin implementation to query the local database for the required credentials. | -| [validatePresentationAgainstSdr(args, context)](./selective-disclosure.selectivedisclosure.validatepresentationagainstsdr.md) | | **_(BETA)_** Validates a [Selective Disclosure response](https://github.com/uport-project/specs/blob/develop/flows/selectivedisclosure.md) encoded as a Presentation | +| [validatePresentationAgainstSdr(args, context)](./selective-disclosure.selectivedisclosure.validatepresentationagainstsdr.md) | | **_(BETA)_** Validates a [uPort Selective Disclosure response](https://github.com/uport-project/specs/blob/develop/flows/selectivedisclosure.md) encoded as a Presentation | diff --git a/docs/api/selective-disclosure.selectivedisclosure.methods.md b/docs/api/selective-disclosure.selectivedisclosure.methods.md index 3457221e..8eae6ca6 100644 --- a/docs/api/selective-disclosure.selectivedisclosure.methods.md +++ b/docs/api/selective-disclosure.selectivedisclosure.methods.md @@ -8,7 +8,7 @@ hide_title: true ## SelectiveDisclosure.methods property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** diff --git a/docs/api/selective-disclosure.selectivedisclosure.schema.md b/docs/api/selective-disclosure.selectivedisclosure.schema.md index 325b2a0e..51ebbcae 100644 --- a/docs/api/selective-disclosure.selectivedisclosure.schema.md +++ b/docs/api/selective-disclosure.selectivedisclosure.schema.md @@ -8,7 +8,7 @@ hide_title: true ## SelectiveDisclosure.schema property -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. **Signature:** @@ -40,17 +40,7 @@ readonly schema: { description: string; }; save: { - type: string; /** - * 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. - * - * 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`. - * - * @beta This API may change without a BREAKING CHANGE notice. - */ + type: string; description: string; }; send: { @@ -80,18 +70,7 @@ readonly schema: { anyOf: ({ 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 This API may change without a BREAKING CHANGE notice. - */ + type: string; }; } | { type: string; diff --git a/docs/api/selective-disclosure.selectivedisclosure.validatepresentationagainstsdr.md b/docs/api/selective-disclosure.selectivedisclosure.validatepresentationagainstsdr.md index dd3fc414..1f0c1e03 100644 --- a/docs/api/selective-disclosure.selectivedisclosure.validatepresentationagainstsdr.md +++ b/docs/api/selective-disclosure.selectivedisclosure.validatepresentationagainstsdr.md @@ -8,9 +8,9 @@ hide_title: true ## SelectiveDisclosure.validatePresentationAgainstSdr() method -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. -Validates a [Selective Disclosure response](https://github.com/uport-project/specs/blob/develop/flows/selectivedisclosure.md) encoded as a `Presentation` +Validates a [uPort Selective Disclosure response](https://github.com/uport-project/specs/blob/develop/flows/selectivedisclosure.md) encoded as a `Presentation` **Signature:** diff --git a/docs/api/utils.asarray.md b/docs/api/utils.asarray.md index 9b2a8eae..43625acf 100644 --- a/docs/api/utils.asarray.md +++ b/docs/api/utils.asarray.md @@ -8,7 +8,7 @@ hide_title: true ## asArray() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Ensures that a given input is an array. If the input is a single item, it is converted to an array with a single entry. diff --git a/docs/api/utils.bytestohex.md b/docs/api/utils.bytestohex.md index f0cce2aa..528939df 100644 --- a/docs/api/utils.bytestohex.md +++ b/docs/api/utils.bytestohex.md @@ -8,7 +8,7 @@ hide_title: true ## bytesToHex() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Converts a Uint8Array input to a hex string diff --git a/docs/api/utils.compressidentifiersecp256k1keys.md b/docs/api/utils.compressidentifiersecp256k1keys.md index 009e3808..9ec695a5 100644 --- a/docs/api/utils.compressidentifiersecp256k1keys.md +++ b/docs/api/utils.compressidentifiersecp256k1keys.md @@ -8,7 +8,7 @@ hide_title: true ## compressIdentifierSecp256k1Keys() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Converts any Secp256k1 public keys of an [IIdentifier](./core-types.iidentifier.md) to their compressed form. diff --git a/docs/api/utils.computeentryhash.md b/docs/api/utils.computeentryhash.md index e858c51f..1c96e7ae 100644 --- a/docs/api/utils.computeentryhash.md +++ b/docs/api/utils.computeentryhash.md @@ -8,7 +8,7 @@ hide_title: true ## computeEntryHash() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Computes a hash for a given credential or presentation. This hash is usable as an internal ID for database indexing diff --git a/docs/api/utils.concat.md b/docs/api/utils.concat.md index c11e64e4..e2b400cf 100644 --- a/docs/api/utils.concat.md +++ b/docs/api/utils.concat.md @@ -8,7 +8,7 @@ hide_title: true ## concat() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Concatenates a bunch of arrays into one Uint8Array diff --git a/docs/api/utils.converted25519privatekeytox25519.md b/docs/api/utils.converted25519privatekeytox25519.md index ef2778ae..90f91437 100644 --- a/docs/api/utils.converted25519privatekeytox25519.md +++ b/docs/api/utils.converted25519privatekeytox25519.md @@ -8,7 +8,7 @@ hide_title: true ## convertEd25519PrivateKeyToX25519() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Converts Ed25519 private keys to X25519 diff --git a/docs/api/utils.converted25519publickeytox25519.md b/docs/api/utils.converted25519publickeytox25519.md index e040a8bb..41820519 100644 --- a/docs/api/utils.converted25519publickeytox25519.md +++ b/docs/api/utils.converted25519publickeytox25519.md @@ -8,7 +8,7 @@ hide_title: true ## convertEd25519PublicKeyToX25519() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Converts Ed25519 public keys to X25519 diff --git a/docs/api/utils.convertidentifierencryptionkeys.md b/docs/api/utils.convertidentifierencryptionkeys.md index 15975eaf..a3edfe3d 100644 --- a/docs/api/utils.convertidentifierencryptionkeys.md +++ b/docs/api/utils.convertidentifierencryptionkeys.md @@ -8,7 +8,7 @@ hide_title: true ## convertIdentifierEncryptionKeys() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Converts any Ed25519 keys of an [IIdentifier](./core-types.iidentifier.md) to X25519 to be usable for encryption. @@ -28,6 +28,6 @@ export declare function convertIdentifierEncryptionKeys(identifier: IIdentifier) [IKey](./core-types.ikey.md)\[\] -the array of converted keys filtered to contain only those usable for encryption. +the array of converted keys filtered to contain ONLY X25519 keys usable for encryption. This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/utils.createjwk.md b/docs/api/utils.createjwk.md new file mode 100644 index 00000000..ed227f76 --- /dev/null +++ b/docs/api/utils.createjwk.md @@ -0,0 +1,31 @@ +--- +id: utils.createjwk +title: createJWK() function +hide_title: true +--- + + + +## createJWK() function + +**Signature:** + +```typescript +export declare function createJWK( + keyType: JwkDidSupportedKeyTypes, + pubKey: string | Uint8Array, + passedKeyUse?: KeyUse, +): JsonWebKey | undefined +``` + +## Parameters + +| Parameter | Type | Description | +| ------------ | ------------------------------------------------------------- | ------------ | +| keyType | [JwkDidSupportedKeyTypes](./utils.jwkdidsupportedkeytypes.md) | | +| pubKey | string | Uint8Array | | +| passedKeyUse | [KeyUse](./utils.keyuse.md) | _(Optional)_ | + +**Returns:** + +JsonWebKey \| undefined diff --git a/docs/api/utils.decodebase64url.md b/docs/api/utils.decodebase64url.md index fd71b901..5648e272 100644 --- a/docs/api/utils.decodebase64url.md +++ b/docs/api/utils.decodebase64url.md @@ -8,7 +8,7 @@ hide_title: true ## decodeBase64url() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Decodes a base64url string to a utf8 string represented by the same bytes. diff --git a/docs/api/utils.decodecredentialtoobject.md b/docs/api/utils.decodecredentialtoobject.md index 3f6f2cbe..8d3cbb4a 100644 --- a/docs/api/utils.decodecredentialtoobject.md +++ b/docs/api/utils.decodecredentialtoobject.md @@ -8,7 +8,7 @@ hide_title: true ## decodeCredentialToObject() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Parses a [W3CVerifiableCredential](./core-types.w3cverifiablecredential.md) and converts it to a [VerifiableCredential](./core-types.verifiablecredential.md) so it is easier to use programmatically. diff --git a/docs/api/utils.decodejoseblob.md b/docs/api/utils.decodejoseblob.md index f5c8bd88..16ec3b2e 100644 --- a/docs/api/utils.decodejoseblob.md +++ b/docs/api/utils.decodejoseblob.md @@ -8,7 +8,7 @@ hide_title: true ## decodeJoseBlob() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Decodes a base64url string representing stringified JSON to a JSON object. diff --git a/docs/api/utils.decodepresentationtoobject.md b/docs/api/utils.decodepresentationtoobject.md index 139c346f..2a676aea 100644 --- a/docs/api/utils.decodepresentationtoobject.md +++ b/docs/api/utils.decodepresentationtoobject.md @@ -8,7 +8,7 @@ hide_title: true ## decodePresentationToObject() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Parses a [W3CVerifiablePresentation](./core-types.w3cverifiablepresentation.md) and converts it to a [VerifiablePresentation](./core-types.verifiablepresentation.md) so it is easier to use programmatically. diff --git a/docs/api/utils.dereferencedidkeys.md b/docs/api/utils.dereferencedidkeys.md index c5672275..d43fd1ba 100644 --- a/docs/api/utils.dereferencedidkeys.md +++ b/docs/api/utils.dereferencedidkeys.md @@ -8,7 +8,7 @@ hide_title: true ## dereferenceDidKeys() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Dereferences keys from DID document and normalizes them for easy comparison. diff --git a/docs/api/utils.encodebase64url.md b/docs/api/utils.encodebase64url.md index 2c79d4fd..cb146e3c 100644 --- a/docs/api/utils.encodebase64url.md +++ b/docs/api/utils.encodebase64url.md @@ -8,7 +8,7 @@ hide_title: true ## encodeBase64url() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Encodes the bytes of an input string to base64url diff --git a/docs/api/utils.encodejoseblob.md b/docs/api/utils.encodejoseblob.md index a5372644..7dcafda9 100644 --- a/docs/api/utils.encodejoseblob.md +++ b/docs/api/utils.encodejoseblob.md @@ -8,7 +8,7 @@ hide_title: true ## encodeJoseBlob() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Stringifies a JSON object and encodes the bytes of the resulting string to a base64url representation. diff --git a/docs/api/utils.extractissuer.md b/docs/api/utils.extractissuer.md index f7606a0b..70c925f3 100644 --- a/docs/api/utils.extractissuer.md +++ b/docs/api/utils.extractissuer.md @@ -8,7 +8,7 @@ hide_title: true ## extractIssuer() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Decodes a credential or presentation and returns the issuer ID `iss` from a JWT or `issuer`/`issuer.id` from a VC or `holder` from a VP diff --git a/docs/api/utils.extractpublickeyhex.md b/docs/api/utils.extractpublickeyhex.md index ee36bf84..86ce6bfa 100644 --- a/docs/api/utils.extractpublickeyhex.md +++ b/docs/api/utils.extractpublickeyhex.md @@ -8,14 +8,20 @@ hide_title: true ## extractPublicKeyHex() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Converts the publicKey of a VerificationMethod to hex encoding (publicKeyHex) **Signature:** ```typescript -export declare function extractPublicKeyHex(pk: _ExtendedVerificationMethod, convert?: boolean): string +export declare function extractPublicKeyHex( + pk: _ExtendedVerificationMethod, + convert?: boolean, +): { + publicKeyHex: string + keyType: string | undefined +} ``` ## Parameters @@ -27,8 +33,8 @@ export declare function extractPublicKeyHex(pk: _ExtendedVerificationMethod, con **Returns:** -string +{ publicKeyHex: string; keyType: string \| undefined; } -the hex encoding of the public key +the hex encoding of the public key along with the inferred key type This API may change without a BREAKING CHANGE notice. diff --git a/docs/api/utils.getchainidfordidethr.md b/docs/api/utils.getchainid.md similarity index 66% rename from docs/api/utils.getchainidfordidethr.md rename to docs/api/utils.getchainid.md index c4afb886..74139a40 100644 --- a/docs/api/utils.getchainidfordidethr.md +++ b/docs/api/utils.getchainid.md @@ -1,21 +1,21 @@ --- -id: utils.getchainidfordidethr -title: getChainIdForDidEthr() function +id: utils.getchainid +title: getChainId() function hide_title: true --- -## getChainIdForDidEthr() function +## getChainId() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Extracts the chain ID from a supporting legacy representations as well. **Signature:** ```typescript -export declare function getChainIdForDidEthr(verificationMethod: _NormalizedVerificationMethod): number +export declare function getChainId(verificationMethod: _NormalizedVerificationMethod): number ``` ## Parameters diff --git a/docs/api/utils.getethereumaddress.md b/docs/api/utils.getethereumaddress.md index f6d40782..b55f0390 100644 --- a/docs/api/utils.getethereumaddress.md +++ b/docs/api/utils.getethereumaddress.md @@ -8,7 +8,7 @@ hide_title: true ## getEthereumAddress() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Extracts an ethereum address from a supporting legacy representations. diff --git a/docs/api/utils.hextobytes.md b/docs/api/utils.hextobytes.md index 50287c46..b673d02d 100644 --- a/docs/api/utils.hextobytes.md +++ b/docs/api/utils.hextobytes.md @@ -8,7 +8,7 @@ hide_title: true ## hexToBytes() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Converts a hex string (with or without prefix) to a byte array (Uint8Array) diff --git a/docs/api/utils.isdefined.md b/docs/api/utils.isdefined.md index 75877d4f..1c7a8e5c 100644 --- a/docs/api/utils.isdefined.md +++ b/docs/api/utils.isdefined.md @@ -8,7 +8,7 @@ hide_title: true ## isDefined() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Checks if a variable is defined and not null. After this check, typescript sees the variable as defined. diff --git a/docs/api/utils.isiterable.md b/docs/api/utils.isiterable.md index 3a3291ab..f3db2ff3 100644 --- a/docs/api/utils.isiterable.md +++ b/docs/api/utils.isiterable.md @@ -8,7 +8,7 @@ hide_title: true ## isIterable() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Checks if an object is iterable (can be used for `for..of`) diff --git a/docs/api/utils.mapidentifierkeystodoc.md b/docs/api/utils.mapidentifierkeystodoc.md index 8d6dcfe9..17bc3b83 100644 --- a/docs/api/utils.mapidentifierkeystodoc.md +++ b/docs/api/utils.mapidentifierkeystodoc.md @@ -8,7 +8,7 @@ hide_title: true ## mapIdentifierKeysToDoc() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Maps the keys of a locally managed [IIdentifier](./core-types.iidentifier.md) to the corresponding entries from the DID document. @@ -19,16 +19,18 @@ export declare function mapIdentifierKeysToDoc( identifier: IIdentifier, section: DIDDocumentSection | undefined, context: IAgentContext, + resolutionOptions?: DIDResolutionOptions, ): Promise<_ExtendedIKey[]> ``` ## Parameters -| Parameter | Type | Description | -| ---------- | -------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| identifier | [IIdentifier](./core-types.iidentifier.md) | the identifier to be mapped | -| section | [DIDDocumentSection](./core-types.diddocumentsection.md) | undefined | the section of the DID document to be mapped (see [verification relationships](https://www.w3.org/TR/did-core/#verification-relationships)), but can also be verificationMethod to map all the keys. | -| context | [IAgentContext](./core-types.iagentcontext.md)<[IResolver](./core-types.iresolver.md)> | the veramo agent context, which must contain a [IResolver](./core-types.iresolver.md) implementation that can resolve the DID document of the identifier. | +| Parameter | Type | Description | +| ----------------- | -------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| identifier | [IIdentifier](./core-types.iidentifier.md) | the identifier to be mapped | +| section | [DIDDocumentSection](./core-types.diddocumentsection.md) | undefined | the section of the DID document to be mapped (see [verification relationships](https://www.w3.org/TR/did-core/#verification-relationships)), but can also be verificationMethod to map all the keys. | +| context | [IAgentContext](./core-types.iagentcontext.md)<[IResolver](./core-types.iresolver.md)> | the veramo agent context, which must contain a [IResolver](./core-types.iresolver.md) implementation that can resolve the DID document of the identifier. | +| resolutionOptions | DIDResolutionOptions | _(Optional)_ optional parameters to be passed to the DID resolver | **Returns:** diff --git a/docs/api/utils.md b/docs/api/utils.md index 439b58b1..df8fa47b 100644 --- a/docs/api/utils.md +++ b/docs/api/utils.md @@ -18,41 +18,42 @@ Contains helper methods for Veramo plugins. ## Functions -| Function | Description | -| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [asArray(arg)](./utils.asarray.md) | **_(BETA)_** Ensures that a given input is an array. If the input is a single item, it is converted to an array with a single entry. | -| [bytesToBase64(b)](./utils.bytestobase64.md) | Encodes a Uint8Array to a base64 string representation with padding. | -| [bytesToHex(byteArray, prefix)](./utils.bytestohex.md) | **_(BETA)_** Converts a Uint8Array input to a hex string | -| [bytesToUtf8String(b)](./utils.bytestoutf8string.md) | Builds a string from a Uint8Array using the utf-8 encoding. | -| [compressIdentifierSecp256k1Keys(identifier)](./utils.compressidentifiersecp256k1keys.md) | **_(BETA)_** Converts any Secp256k1 public keys of an [IIdentifier](./core-types.iidentifier.md) to their compressed form. | -| [computeEntryHash(input)](./utils.computeentryhash.md) | **_(BETA)_** Computes a hash for a given credential or presentation. This hash is usable as an internal ID for database indexing | -| [concat(arrays, length)](./utils.concat.md) | **_(BETA)_** Concatenates a bunch of arrays into one Uint8Array | -| [convertEd25519PrivateKeyToX25519(privateKey)](./utils.converted25519privatekeytox25519.md) | **_(BETA)_** Converts Ed25519 private keys to X25519 | -| [convertEd25519PublicKeyToX25519(publicKey)](./utils.converted25519publickeytox25519.md) | **_(BETA)_** Converts Ed25519 public keys to X25519 | -| [convertIdentifierEncryptionKeys(identifier)](./utils.convertidentifierencryptionkeys.md) | **_(BETA)_** Converts any Ed25519 keys of an [IIdentifier](./core-types.iidentifier.md) to X25519 to be usable for encryption. | -| [decodeBase64url(s)](./utils.decodebase64url.md) | **_(BETA)_** Decodes a base64url string to a utf8 string represented by the same bytes. | -| [decodeCredentialToObject(input)](./utils.decodecredentialtoobject.md) | **_(BETA)_** Parses a [W3CVerifiableCredential](./core-types.w3cverifiablecredential.md) and converts it to a [VerifiableCredential](./core-types.verifiablecredential.md) so it is easier to use programmatically. | -| [decodeJoseBlob(blob)](./utils.decodejoseblob.md) | **_(BETA)_** Decodes a base64url string representing stringified JSON to a JSON object. | -| [decodePresentationToObject(input)](./utils.decodepresentationtoobject.md) | **_(BETA)_** Parses a [W3CVerifiablePresentation](./core-types.w3cverifiablepresentation.md) and converts it to a [VerifiablePresentation](./core-types.verifiablepresentation.md) so it is easier to use programmatically. | -| [dereferenceDidKeys(didDocument, section, context)](./utils.dereferencedidkeys.md) |

**_(BETA)_** Dereferences keys from DID document and normalizes them for easy comparison.

When dereferencing keyAgreement keys, only Ed25519 and X25519 curves are supported. Other key types are omitted from the result and Ed25519 keys are converted to X25519

| -| [encodeBase64url(s)](./utils.encodebase64url.md) | **_(BETA)_** Encodes the bytes of an input string to base64url | -| [encodeJoseBlob(payload)](./utils.encodejoseblob.md) | **_(BETA)_** Stringifies a JSON object and encodes the bytes of the resulting string to a base64url representation. | -| [extractIssuer(input, options)](./utils.extractissuer.md) | **_(BETA)_** Decodes a credential or presentation and returns the issuer ID iss from a JWT or issuer/issuer.id from a VC or holder from a VP | -| [extractPublicKeyHex(pk, convert)](./utils.extractpublickeyhex.md) | **_(BETA)_** Converts the publicKey of a VerificationMethod to hex encoding (publicKeyHex) | -| [generateJwkFromVerificationMethod(keyType, key, keyUse)](./utils.generatejwkfromverificationmethod.md) | | -| [getChainIdForDidEthr(verificationMethod)](./utils.getchainidfordidethr.md) | **_(BETA)_** Extracts the chain ID from a supporting legacy representations as well. | -| [getEthereumAddress(verificationMethod)](./utils.getethereumaddress.md) | **_(BETA)_** Extracts an ethereum address from a supporting legacy representations. | -| [getKeyUse(keyType, passedKeyUse)](./utils.getkeyuse.md) | | -| [hexToBytes(hexString)](./utils.hextobytes.md) | **_(BETA)_** Converts a hex string (with or without prefix) to a byte array (Uint8Array) | -| [intersect(a, b)](./utils.intersect.md) | Compute the intersection of two arrays Elements are compared by reference so object types will appear as unique even if they contain the same data. | -| [isDefined(arg)](./utils.isdefined.md) | **_(BETA)_** Checks if a variable is defined and not null. After this check, typescript sees the variable as defined. | -| [isIterable(obj)](./utils.isiterable.md) | **_(BETA)_** Checks if an object is iterable (can be used for for..of) | -| [isJWK(data)](./utils.isjwk.md) | | -| [mapIdentifierKeysToDoc(identifier, section, context)](./utils.mapidentifierkeystodoc.md) | **_(BETA)_** Maps the keys of a locally managed [IIdentifier](./core-types.iidentifier.md) to the corresponding entries from the DID document. | -| [processEntryToArray(inputEntryOrArray, startWithEntry)](./utils.processentrytoarray.md) | **_(BETA)_** Processes an entry or an array of entries into an array of entries. If a startWithEntry param is provided, it is set as the first item in the result array. | -| [removeDIDParameters(did)](./utils.removedidparameters.md) | **_(BETA)_** Remove all DID parameters from a DID url | -| [resolveDidOrThrow(didUrl, context)](./utils.resolvedidorthrow.md) | **_(BETA)_** Resolve a DID document or throw an error if the resolution fails. | -| [stringToUtf8Bytes(s)](./utils.stringtoutf8bytes.md) | Encodes a string to a Uint8Array using the utf-8 encoding. | +| Function | Description | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [asArray(arg)](./utils.asarray.md) | **_(BETA)_** Ensures that a given input is an array. If the input is a single item, it is converted to an array with a single entry. | +| [bytesToBase64(b)](./utils.bytestobase64.md) | Encodes a Uint8Array to a base64 string representation with padding. | +| [bytesToHex(byteArray, prefix)](./utils.bytestohex.md) | **_(BETA)_** Converts a Uint8Array input to a hex string | +| [bytesToUtf8String(b)](./utils.bytestoutf8string.md) | Builds a string from a Uint8Array using the utf-8 encoding. | +| [compressIdentifierSecp256k1Keys(identifier)](./utils.compressidentifiersecp256k1keys.md) | **_(BETA)_** Converts any Secp256k1 public keys of an [IIdentifier](./core-types.iidentifier.md) to their compressed form. | +| [computeEntryHash(input)](./utils.computeentryhash.md) | **_(BETA)_** Computes a hash for a given credential or presentation. This hash is usable as an internal ID for database indexing | +| [concat(arrays, length)](./utils.concat.md) | **_(BETA)_** Concatenates a bunch of arrays into one Uint8Array | +| [convertEd25519PrivateKeyToX25519(privateKey)](./utils.converted25519privatekeytox25519.md) | **_(BETA)_** Converts Ed25519 private keys to X25519 | +| [convertEd25519PublicKeyToX25519(publicKey)](./utils.converted25519publickeytox25519.md) | **_(BETA)_** Converts Ed25519 public keys to X25519 | +| [convertIdentifierEncryptionKeys(identifier)](./utils.convertidentifierencryptionkeys.md) | **_(BETA)_** Converts any Ed25519 keys of an [IIdentifier](./core-types.iidentifier.md) to X25519 to be usable for encryption. | +| [createJWK(keyType, pubKey, passedKeyUse)](./utils.createjwk.md) | | +| [decodeBase64url(s)](./utils.decodebase64url.md) | **_(BETA)_** Decodes a base64url string to a utf8 string represented by the same bytes. | +| [decodeCredentialToObject(input)](./utils.decodecredentialtoobject.md) | **_(BETA)_** Parses a [W3CVerifiableCredential](./core-types.w3cverifiablecredential.md) and converts it to a [VerifiableCredential](./core-types.verifiablecredential.md) so it is easier to use programmatically. | +| [decodeJoseBlob(blob)](./utils.decodejoseblob.md) | **_(BETA)_** Decodes a base64url string representing stringified JSON to a JSON object. | +| [decodePresentationToObject(input)](./utils.decodepresentationtoobject.md) | **_(BETA)_** Parses a [W3CVerifiablePresentation](./core-types.w3cverifiablepresentation.md) and converts it to a [VerifiablePresentation](./core-types.verifiablepresentation.md) so it is easier to use programmatically. | +| [dereferenceDidKeys(didDocument, section, context)](./utils.dereferencedidkeys.md) |

**_(BETA)_** Dereferences keys from DID document and normalizes them for easy comparison.

When dereferencing keyAgreement keys, only Ed25519 and X25519 curves are supported. Other key types are omitted from the result and Ed25519 keys are converted to X25519

| +| [encodeBase64url(s)](./utils.encodebase64url.md) | **_(BETA)_** Encodes the bytes of an input string to base64url | +| [encodeJoseBlob(payload)](./utils.encodejoseblob.md) | **_(BETA)_** Stringifies a JSON object and encodes the bytes of the resulting string to a base64url representation. | +| [extractIssuer(input, options)](./utils.extractissuer.md) | **_(BETA)_** Decodes a credential or presentation and returns the issuer ID iss from a JWT or issuer/issuer.id from a VC or holder from a VP | +| [extractPublicKeyHex(pk, convert)](./utils.extractpublickeyhex.md) | **_(BETA)_** Converts the publicKey of a VerificationMethod to hex encoding (publicKeyHex) | +| [generateJwkFromVerificationMethod(keyType, key, keyUse)](./utils.generatejwkfromverificationmethod.md) | | +| [getChainId(verificationMethod)](./utils.getchainid.md) | **_(BETA)_** Extracts the chain ID from a supporting legacy representations as well. | +| [getEthereumAddress(verificationMethod)](./utils.getethereumaddress.md) | **_(BETA)_** Extracts an ethereum address from a supporting legacy representations. | +| [getKeyUse(keyType, passedKeyUse)](./utils.getkeyuse.md) | | +| [hexToBytes(hexString)](./utils.hextobytes.md) | **_(BETA)_** Converts a hex string (with or without prefix) to a byte array (Uint8Array) | +| [intersect(a, b)](./utils.intersect.md) | Compute the intersection of two arrays Elements are compared by reference so object types will appear as unique even if they contain the same data. | +| [isDefined(arg)](./utils.isdefined.md) | **_(BETA)_** Checks if a variable is defined and not null. After this check, typescript sees the variable as defined. | +| [isIterable(obj)](./utils.isiterable.md) | **_(BETA)_** Checks if an object is iterable (can be used for for..of) | +| [isJWK(data)](./utils.isjwk.md) | | +| [mapIdentifierKeysToDoc(identifier, section, context, resolutionOptions)](./utils.mapidentifierkeystodoc.md) | **_(BETA)_** Maps the keys of a locally managed [IIdentifier](./core-types.iidentifier.md) to the corresponding entries from the DID document. | +| [processEntryToArray(inputEntryOrArray, startWithEntry)](./utils.processentrytoarray.md) | **_(BETA)_** Processes an entry or an array of entries into an array of entries. If a startWithEntry param is provided, it is set as the first item in the result array. | +| [removeDIDParameters(did)](./utils.removedidparameters.md) | **_(BETA)_** Remove all DID parameters from a DID url | +| [resolveDidOrThrow(didUrl, context, resolutionOptions)](./utils.resolvedidorthrow.md) | **_(BETA)_** Resolve a DID document or throw an error if the resolution fails. | +| [stringToUtf8Bytes(s)](./utils.stringtoutf8bytes.md) | Encodes a string to a Uint8Array using the utf-8 encoding. | ## Variables diff --git a/docs/api/utils.processentrytoarray.md b/docs/api/utils.processentrytoarray.md index 16a90c38..238a102d 100644 --- a/docs/api/utils.processentrytoarray.md +++ b/docs/api/utils.processentrytoarray.md @@ -8,7 +8,7 @@ hide_title: true ## processEntryToArray() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Processes an entry or an array of entries into an array of entries. If a `startWithEntry` param is provided, it is set as the first item in the result array. diff --git a/docs/api/utils.recordlike.md b/docs/api/utils.recordlike.md index 94476a77..150f1e12 100644 --- a/docs/api/utils.recordlike.md +++ b/docs/api/utils.recordlike.md @@ -8,7 +8,7 @@ hide_title: true ## RecordLike type -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. A mapping of string to another type. Both Map and Record are accepted. diff --git a/docs/api/utils.removedidparameters.md b/docs/api/utils.removedidparameters.md index 83d67ab5..03a5aef3 100644 --- a/docs/api/utils.removedidparameters.md +++ b/docs/api/utils.removedidparameters.md @@ -8,7 +8,7 @@ hide_title: true ## removeDIDParameters() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Remove all DID parameters from a DID url diff --git a/docs/api/utils.resolvedidorthrow.md b/docs/api/utils.resolvedidorthrow.md index aa0b74ae..a291493b 100644 --- a/docs/api/utils.resolvedidorthrow.md +++ b/docs/api/utils.resolvedidorthrow.md @@ -8,7 +8,7 @@ hide_title: true ## resolveDidOrThrow() function -> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. Resolve a DID document or throw an error if the resolution fails. @@ -18,15 +18,17 @@ Resolve a DID document or throw an error if the resolution fails. export declare function resolveDidOrThrow( didUrl: string, context: IAgentContext, + resolutionOptions?: DIDResolutionOptions, ): Promise ``` ## Parameters -| Parameter | Type | Description | -| --------- | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| didUrl | string | the DID to be resolved | -| context | [IAgentContext](./core-types.iagentcontext.md)<[IResolver](./core-types.iresolver.md)> | the veramo agent context, which must contain a [IResolver](./core-types.iresolver.md) implementation that can resolve the DID document of the didUrl. | +| Parameter | Type | Description | +| ----------------- | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| didUrl | string | the DID to be resolved | +| context | [IAgentContext](./core-types.iagentcontext.md)<[IResolver](./core-types.iresolver.md)> | the veramo agent context, which must contain a [IResolver](./core-types.iresolver.md) implementation that can resolve the DID document of the didUrl. | +| resolutionOptions | DIDResolutionOptions | _(Optional)_ optional parameters to be passed to the DID resolver | **Returns:** diff --git a/package.json b/package.json index 99032400..26f38d2e 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "veramo-site-docs", - "version": "5.6.0", + "version": "6.0.0", "private": true, "scripts": { "start": "NODE_ENV=production HTTPS=true docusaurus serve --port $PORT",