@credo-ts/anoncreds 0.6.1-pr-2091-20241119140918 → 0.6.1

package/build/protocols/credentials/v1/DidCommCredentialV1Protocol.d.mts

@@ -0,0 +1,215 @@
+import { LegacyIndyDidCommCredentialFormatService } from "../../../formats/LegacyIndyDidCommCredentialFormatService.mjs";
+import "../../../formats/index.mjs";
+import { DidCommCredentialV1AckMessage } from "./messages/DidCommCredentialV1AckMessage.mjs";
+import { DidCommIssueCredentialV1Message } from "./messages/DidCommIssueCredentialV1Message.mjs";
+import { V1OfferCredentialMessage } from "./messages/DidCommOfferCredentialV1Message.mjs";
+import { DidCommProposeCredentialV1Message } from "./messages/DidCommProposeCredentialV1Message.mjs";
+import { DidCommRequestCredentialV1Message } from "./messages/DidCommRequestCredentialV1Message.mjs";
+import "./messages/index.mjs";
+import { AgentContext } from "@credo-ts/core";
+import { BaseDidCommCredentialProtocol, CredentialProtocolOptions, DidCommCredentialExchangeRecord, DidCommCredentialProtocol, DidCommFeatureRegistry, DidCommInboundMessageContext, DidCommMessage, DidCommMessageHandlerRegistry, DidCommProblemReportMessage, ExtractCredentialFormats } from "@credo-ts/didcomm";
+
+//#region src/protocols/credentials/v1/DidCommCredentialV1Protocol.d.ts
+interface DidCommCredentialV1ProtocolConfig {
+  indyCredentialFormat: LegacyIndyDidCommCredentialFormatService;
+}
+declare class DidCommCredentialV1Protocol extends BaseDidCommCredentialProtocol<[LegacyIndyDidCommCredentialFormatService]> implements DidCommCredentialProtocol<[LegacyIndyDidCommCredentialFormatService]> {
+  private indyCredentialFormat;
+  constructor({
+    indyCredentialFormat
+  }: DidCommCredentialV1ProtocolConfig);
+  /**
+   * The version of the issue credential protocol this protocol supports
+   */
+  readonly version = "v1";
+  /**
+   * Registers the protocol implementation (handlers, feature registry) on the agent.
+   */
+  register(messageHandlerRegistry: DidCommMessageHandlerRegistry, featureRegistry: DidCommFeatureRegistry): void;
+  /**
+   * Create a {@link ProposeCredentialMessage} not bound to an existing credential exchange.
+   * To create a proposal as response to an existing credential exchange, use {@link createProposalAsResponse}.
+   *
+   * @param options The object containing config options
+   * @returns Object containing proposal message and associated credential record
+   *
+   */
+  createProposal(agentContext: AgentContext, {
+    connectionRecord,
+    credentialFormats,
+    comment,
+    autoAcceptCredential
+  }: CredentialProtocolOptions.CreateCredentialProposalOptions<[LegacyIndyDidCommCredentialFormatService]>): Promise<CredentialProtocolOptions.CredentialProtocolMsgReturnType<DidCommMessage>>;
+  /**
+   * Process a received {@link ProposeCredentialMessage}. This will not accept the credential proposal
+   * or send a credential offer. It will only create a new, or update the existing credential record with
+   * the information from the credential proposal message. Use {@link createOfferAsResponse}
+   * after calling this method to create a credential offer.
+   *
+   * @param messageContext The message context containing a credential proposal message
+   * @returns credential record associated with the credential proposal message
+   *
+   */
+  processProposal(messageContext: DidCommInboundMessageContext<DidCommProposeCredentialV1Message>): Promise<DidCommCredentialExchangeRecord>;
+  /**
+   * Processing an incoming credential message and create a credential offer as a response
+   * @param options The object containing config options
+   * @returns Object containing proposal message and associated credential record
+   */
+  acceptProposal(agentContext: AgentContext, {
+    credentialExchangeRecord,
+    credentialFormats,
+    comment,
+    autoAcceptCredential
+  }: CredentialProtocolOptions.AcceptCredentialProposalOptions<[LegacyIndyDidCommCredentialFormatService]>): Promise<CredentialProtocolOptions.CredentialProtocolMsgReturnType<V1OfferCredentialMessage>>;
+  /**
+   * Negotiate a credential proposal as issuer (by sending a credential offer message) to the connection
+   * associated with the credential record.
+   *
+   * @param options configuration for the offer see {@link NegotiateCredentialProposalOptions}
+   * @returns Credential record associated with the credential offer and the corresponding new offer message
+   *
+   */
+  negotiateProposal(agentContext: AgentContext, {
+    credentialFormats,
+    credentialExchangeRecord,
+    comment,
+    autoAcceptCredential
+  }: CredentialProtocolOptions.NegotiateCredentialProposalOptions<[LegacyIndyDidCommCredentialFormatService]>): Promise<CredentialProtocolOptions.CredentialProtocolMsgReturnType<V1OfferCredentialMessage>>;
+  /**
+   * Create a {@link OfferCredentialMessage} not bound to an existing credential exchange.
+   * To create an offer as response to an existing credential exchange, use {@link DidCommCredentialV1Protocol#createOfferAsResponse}.
+   *
+   * @param options The options containing config params for creating the credential offer
+   * @returns Object containing offer message and associated credential record
+   *
+   */
+  createOffer(agentContext: AgentContext, {
+    credentialFormats,
+    autoAcceptCredential,
+    comment,
+    connectionRecord
+  }: CredentialProtocolOptions.CreateCredentialOfferOptions<[LegacyIndyDidCommCredentialFormatService]>): Promise<CredentialProtocolOptions.CredentialProtocolMsgReturnType<V1OfferCredentialMessage>>;
+  /**
+   * Process a received {@link OfferCredentialMessage}. This will not accept the credential offer
+   * or send a credential request. It will only create a new credential record with
+   * the information from the credential offer message. Use {@link createRequest}
+   * after calling this method to create a credential request.
+   *
+   * @param messageContext The message context containing a credential request message
+   * @returns credential record associated with the credential offer message
+   *
+   */
+  processOffer(messageContext: DidCommInboundMessageContext<V1OfferCredentialMessage>): Promise<DidCommCredentialExchangeRecord>;
+  /**
+   * Create a {@link RequestCredentialMessage} as response to a received credential offer.
+   *
+   * @param options configuration to use for the credential request
+   * @returns Object containing request message and associated credential record
+   *
+   */
+  acceptOffer(agentContext: AgentContext, {
+    credentialExchangeRecord,
+    credentialFormats,
+    comment,
+    autoAcceptCredential
+  }: CredentialProtocolOptions.AcceptCredentialOfferOptions<[LegacyIndyDidCommCredentialFormatService]>): Promise<CredentialProtocolOptions.CredentialProtocolMsgReturnType<DidCommRequestCredentialV1Message>>;
+  /**
+   * Process a received {@link RequestCredentialMessage}. This will not accept the credential request
+   * or send a credential. It will only update the existing credential record with
+   * the information from the credential request message. Use {@link createCredential}
+   * after calling this method to create a credential.
+   *
+   * @param messageContext The message context containing a credential request message
+   * @returns credential record associated with the credential request message
+   *
+   */
+  negotiateOffer(agentContext: AgentContext, {
+    credentialFormats,
+    credentialExchangeRecord,
+    autoAcceptCredential,
+    comment
+  }: CredentialProtocolOptions.NegotiateCredentialOfferOptions<[LegacyIndyDidCommCredentialFormatService]>): Promise<CredentialProtocolOptions.CredentialProtocolMsgReturnType<DidCommMessage>>;
+  /**
+   * Starting from a request is not supported in v1 of the issue credential protocol
+   * because indy doesn't allow to start from a request
+   */
+  createRequest(): Promise<CredentialProtocolOptions.CredentialProtocolMsgReturnType<DidCommRequestCredentialV1Message>>;
+  processRequest(messageContext: DidCommInboundMessageContext<DidCommRequestCredentialV1Message>): Promise<DidCommCredentialExchangeRecord>;
+  /**
+   * Create a {@link DidCommIssueCredentialV1Message} as response to a received credential request.
+   *
+   * @returns Object containing issue credential message and associated credential record
+   *
+   */
+  acceptRequest(agentContext: AgentContext, {
+    credentialExchangeRecord,
+    credentialFormats,
+    comment,
+    autoAcceptCredential
+  }: CredentialProtocolOptions.AcceptCredentialRequestOptions<[LegacyIndyDidCommCredentialFormatService]>): Promise<CredentialProtocolOptions.CredentialProtocolMsgReturnType<DidCommIssueCredentialV1Message>>;
+  /**
+   * Process an incoming {@link DidCommIssueCredentialV1Message}
+   *
+   * @param messageContext The message context containing a credential acknowledgement message
+   * @returns credential record associated with the credential acknowledgement message
+   *
+   */
+  processCredential(messageContext: DidCommInboundMessageContext<DidCommIssueCredentialV1Message>): Promise<DidCommCredentialExchangeRecord>;
+  /**
+   * Create a {@link CredentialAckMessage} as response to a received credential.
+   *
+   * @param credentialExchangeRecord The credential record for which to create the credential acknowledgement
+   * @returns Object containing credential acknowledgement message and associated credential record
+   *
+   */
+  acceptCredential(agentContext: AgentContext, {
+    credentialExchangeRecord
+  }: CredentialProtocolOptions.AcceptCredentialOptions): Promise<CredentialProtocolOptions.CredentialProtocolMsgReturnType<DidCommCredentialV1AckMessage>>;
+  /**
+   * Process a received {@link CredentialAckMessage}.
+   *
+   * @param messageContext The message context containing a credential acknowledgement message
+   * @returns credential record associated with the credential acknowledgement message
+   *
+   */
+  processAck(messageContext: DidCommInboundMessageContext<DidCommCredentialV1AckMessage>): Promise<DidCommCredentialExchangeRecord>;
+  /**
+   * Create a {@link DidCommCredentialV1ProblemReportMessage} to be sent.
+   *
+   * @param message message to send
+   * @returns a {@link DidCommCredentialV1ProblemReportMessage}
+   *
+   */
+  createProblemReport(_agentContext: AgentContext, {
+    credentialExchangeRecord,
+    description
+  }: CredentialProtocolOptions.CreateCredentialProblemReportOptions): Promise<CredentialProtocolOptions.CredentialProtocolMsgReturnType<DidCommProblemReportMessage>>;
+  shouldAutoRespondToProposal(agentContext: AgentContext, options: {
+    credentialExchangeRecord: DidCommCredentialExchangeRecord;
+    proposalMessage: DidCommProposeCredentialV1Message;
+  }): Promise<boolean>;
+  shouldAutoRespondToOffer(agentContext: AgentContext, options: {
+    credentialExchangeRecord: DidCommCredentialExchangeRecord;
+    offerMessage: V1OfferCredentialMessage;
+  }): Promise<boolean>;
+  shouldAutoRespondToRequest(agentContext: AgentContext, options: {
+    credentialExchangeRecord: DidCommCredentialExchangeRecord;
+    requestMessage: DidCommRequestCredentialV1Message;
+  }): Promise<boolean>;
+  shouldAutoRespondToCredential(agentContext: AgentContext, options: {
+    credentialExchangeRecord: DidCommCredentialExchangeRecord;
+    credentialMessage: DidCommIssueCredentialV1Message;
+  }): Promise<boolean>;
+  findProposalMessage(agentContext: AgentContext, credentialExchangeId: string): Promise<DidCommProposeCredentialV1Message | null>;
+  findOfferMessage(agentContext: AgentContext, credentialExchangeId: string): Promise<V1OfferCredentialMessage | null>;
+  findRequestMessage(agentContext: AgentContext, credentialExchangeId: string): Promise<DidCommRequestCredentialV1Message | null>;
+  findCredentialMessage(agentContext: AgentContext, credentialExchangeId: string): Promise<DidCommIssueCredentialV1Message | null>;
+  getFormatData(agentContext: AgentContext, credentialExchangeId: string): Promise<CredentialProtocolOptions.GetCredentialFormatDataReturn<ExtractCredentialFormats<[LegacyIndyDidCommCredentialFormatService]>>>;
+  private rfc0592ProposalFromV1ProposeMessage;
+  private assertOnlyIndyFormat;
+  getFormatServiceForRecordType(credentialRecordType: string): LegacyIndyDidCommCredentialFormatService;
+}
+//#endregion
+export { DidCommCredentialV1Protocol, DidCommCredentialV1ProtocolConfig };
+//# sourceMappingURL=DidCommCredentialV1Protocol.d.mts.map

package/build/protocols/credentials/v1/DidCommCredentialV1Protocol.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DidCommCredentialV1Protocol.d.mts","names":[],"sources":["../../../../src/protocols/credentials/v1/DidCommCredentialV1Protocol.ts"],"sourcesContent":[],"mappings":";;;;;;;;;;;;UAuDiB,iCAAA;wBACO;;cAGX,2BAAA,SACH,+BAA+B,sDAC5B,2BAA2B;;;;KAIO;;AAV/C;AAIA;EACyC,SAAA,OAAA,GAAA,IAAA;EACD;;;EAmBE,QAAA,CAAA,sBAAA,EAAA,6BAAA,EAAA,eAAA,EAAgD,sBAAhD,CAAA,EAAA,IAAA;EAAgD;;;;;;;;EAoCnB,cAAA,CAAA,YAAA,EAPrD,YAOqD,EAAA;IAAA,gBAAA;IAAA,iBAAA;IAAA,OAAA;IAAA;EAAA,CAAA,EADhE,yBAAA,CAA0B,+BACsC,CAAA,CADL,wCACK,CAAA,CAAA,CAAA,EAAlE,OAAkE,CAA1D,yBAAA,CAA0B,+BAAgC,CAAA,cAAA,CAAA,CAAA;EAA1D;;;;;;;;;;EAyKP,eAAA,CAAA,cAAA,EAtGc,4BAsGd,CAtG2C,iCAsG3C,CAAA,CAAA,EArGD,OAqGC,CArGO,+BAqGP,CAAA;EAC4D;;;;;EAuEhD,cAAA,CAAA,YAAA,EA7EA,YA6EA,EAAA;IAAA,wBAAA;IAAA,iBAAA;IAAA,OAAA;IAAA;EAAA,CAAA,EAvEX,yBAAA,CAA0B,+BAuEf,CAAA,CAvEgD,wCAuEhD,CAAA,CAAA,CAAA,EAtEb,OAsEa,CAtEL,yBAAA,CAA0B,+BAsErB,CAtEqD,wBAsErD,CAAA,CAAA;EAEZ;;;;;;;;EAKD,iBAAA,CAAA,YAAA,EAPa,YAOb,EAAA;IAAA,iBAAA;IAAA,wBAAA;IAAA,OAAA;IAAA;EAAA,CAAA,EADE,yBAAA,CAA0B,kCAC5B,CAAA,CADgE,wCAChE,CAAA,CAAA,CAAA,EAAA,OAAA,CAAQ,yBAAA,CAA0B,+BAAlC,CAAkE,wBAAlE,CAAA,CAAA;EAqDa;;;;;;;;EAOL,WAAA,CAAA,YAA0B,EAPrB,YAOqB,EAAA;IAAA,iBAAA;IAAA,oBAAA;IAAA,OAAA;IAAA;EAAA,CAAA,EADhC,yBAAA,CAA0B,4BACM,CAAA,CADwB,wCACxB,CAAA,CAAA,CAAA,EAAlC,OAAkC,CAA1B,yBAAA,CAA0B,+BAAA,CAAgC,wBAAhC,CAAA,CAAA;EAAlC;;;;;;;;;;EA4K0D,YAAA,CAAA,cAAA,EA3G3C,4BA2G2C,CA3Gd,wBA2Gc,CAAA,CAAA,EA1G1D,OA0G0D,CA1GlD,+BA0GkD,CAAA;EAAxD;;;;;;;EAgED,WAAA,CAAA,YAAA,EAtEY,YAsEZ,EAAA;IAAA,wBAAA;IAAA,iBAAA;IAAA,OAAA;IAAA;EAAA,CAAA,EAhEC,yBAAA,CAA0B,4BAgE3B,CAAA,CAhEyD,wCAgEzD,CAAA,CAAA,CAAA,EA/DD,OA+DC,CA/DO,yBAAA,CAA0B,+BA+DjC,CA/DiE,iCA+DjE,CAAA,CAAA;EACA;;;;;;;;;;EA0Ec,cAAA,CAAA,YAAA,EA/EF,YA+EE,EAAA;IAAA,iBAAA;IAAA,wBAAA;IAAA,oBAAA;IAAA;EAAA,CAAA,EAzEb,yBAAA,CAA0B,+BAyEb,CAAA,CAzE8C,wCAyE9C,CAAA,CAAA,CAAA,EAxEf,OAwEe,CAxEP,yBAAA,CAA0B,+BAwEnB,CAxEmD,cAwEnD,CAAA,CAAA;EACP;;;;EAuFP,aAAA,CAAA,CAAA,EA/F0B,OA+F1B,CA9FF,yBAAA,CAA0B,+BA8FxB,CA9FwD,iCA8FxD,CAAA,CAAA;EACA,cAAA,CAAA,cAAA,EAzFc,4BAyFd,CAzF2C,iCAyF3C,CAAA,CAAA,EAxFD,OAwFC,CAxFO,+BAwFP,CAAA;EACA;;;;;;EAsE2C,aAAA,CAAA,YAAA,EA3E/B,YA2E+B,EAAA;IAAA,wBAAA;IAAA,iBAAA;IAAA,OAAA;IAAA;EAAA,CAAA,EArE1C,yBAAA,CAA0B,8BAqEgB,CAAA,CArEgB,wCAqEhB,CAAA,CAAA,CAAA,EApE5C,OAoE4C,CApEpC,yBAAA,CAA0B,+BAoEU,CApEsB,+BAoEtB,CAAA,CAAA;EAA7B;;;;;;;EAqFP,iBAAA,CAAA,cAA0B,EArFnB,4BAqFmB,CArFU,+BAqFV,CAAA,CAAA,EApFlC,OAoFkC,CApF1B,+BAoF0B,CAAA;EAAlC;;;;;;;EAkF2B,gBAAA,CAAA,YAAA,EApFd,YAoFc,EAAA;IAAA;EAAA,CAAA,EAnFE,yBAAA,CAA0B,uBAmF5B,CAAA,EAlF3B,OAkF2B,CAlFnB,yBAAA,CAA0B,+BAkFP,CAlFuC,6BAkFvC,CAAA,CAAA;EAAe;;;;;;;EAkB1C,UAAA,CAAA,cAAA,EAxEe,4BAwEf,CAxE4C,6BAwE5C,CAAA,CAAA,EAvEA,OAuEA,CAvEQ,+BAuER,CAAA;EAmCa;;;;;;;EA2Cb,mBAAA,CAAA,aAAA,EAjGc,YAiGd,EAAA;IAAA,wBAAA;IAAA;EAAA,CAAA,EAhG0C,yBAAA,CAA0B,oCAgGpE,CAAA,EA/FA,OA+FA,CA/FQ,yBAAA,CAA0B,+BA+FlC,CA/FkE,2BA+FlE,CAAA,CAAA;EA+Ba,2BAAA,CAAA,YAAA,EAjHA,YAiHA,EAAA,OAAA,EAAA;IAEc,wBAAA,EAjHA,+BAiHA;IACP,eAAA,EAjHF,iCAiHE;EACpB,CAAA,CAAA,EAjHA,OAiHA,CAAA,OAAA,CAAA;EAkC4C,wBAAA,CAAA,YAAA,EAhH/B,YAgH+B,EAAA,OAAA,EAAA;IAA0C,wBAAA,EA9G3D,+BA8G2D;IAAA,YAAA,EA7GvE,wBA6GuE;EAS7C,CAAA,CAAA,EArHzC,OAqHyC,CAAA,OAAA,CAAA;EAA0C,0BAAA,CAAA,YAAA,EAlFtE,YAkFsE,EAAA,OAAA,EAAA;IAAA,wBAAA,EAhFxD,+BAgFwD;IASxC,cAAA,EAxF1B,iCAwF0B;EAA0C,CAAA,CAAA,EAvFrF,OAuFqF,CAAA,OAAA,CAAA;EAAA,6BAAA,CAAA,YAAA,EAxDxE,YAwDwE,EAAA,OAAA,EAAA;IASvC,wBAAA,EA/DnB,+BA+DmB;IAA0C,iBAAA,EA9DpE,+BA8DoE;EAAA,CAAA,CAAA,EA7DxF,OA6DwF,CAAA,OAAA,CAAA;EAU3E,mBAAA,CAAA,YAAA,EArC+B,YAqC/B,EAAA,oBAAA,EAAA,MAAA,CAAA,EArCyE,OAqCzE,CArCyE,iCAqCzE,GAAA,IAAA,CAAA;EAIc,gBAAA,CAAA,YAAA,EAhCc,YAgCd,EAAA,oBAAA,EAAA,MAAA,CAAA,EAhCwD,OAgCxD,CAhCwD,wBAgCxD,GAAA,IAAA,CAAA;EAA1B,kBAAA,CAAA,YAAA,EAvB0C,YAuB1C,EAAA,oBAAA,EAAA,MAAA,CAAA,EAvBoF,OAuBpF,CAvBoF,iCAuBpF,GAAA,IAAA,CAAA;EADF,qBAAA,CAAA,YAA0B,EAbqB,YAarB,EAAA,oBAAA,EAAA,MAAA,CAAA,EAb+D,OAa/D,CAb+D,+BAa/D,GAAA,IAAA,CAAA;EADzB,aAAA,CAAA,YAAA,EAFa,YAEb,EAAA,oBAAA,EAAA,MAAA,CAAA,EAAA,OAAA,CACD,yBAAA,CAA0B,6BADzB,CAEC,wBAFD,CAAA,CAE2B,wCAF3B,CAAA,CAAA,CAAA,CAAA;EAuE8D,QAAA,mCAAA;EA7vCzD,QAAA,oBAAA;EACG,6BAAA,CAAA,oBAAA,EAAA,MAAA,CAAA,EA4vCsD,wCA5vCtD"}