@credo-ts/anoncreds 0.6.1-pr-2091-20241119140918 → 0.6.2-alpha-20251210145840

package/build/formats/DataIntegrityDidCommCredentialFormatService.d.mts

@@ -0,0 +1,118 @@
+import { AgentContext } from "@credo-ts/core";
+import { DidCommAttachment, DidCommCredentialFormatAcceptOfferOptions, DidCommCredentialFormatAcceptProposalOptions, DidCommCredentialFormatAcceptRequestOptions, DidCommCredentialFormatAutoRespondCredentialOptions, DidCommCredentialFormatAutoRespondOfferOptions, DidCommCredentialFormatAutoRespondProposalOptions, DidCommCredentialFormatAutoRespondRequestOptions, DidCommCredentialFormatCreateOfferOptions, DidCommCredentialFormatCreateOfferReturn, DidCommCredentialFormatCreateProposalOptions, DidCommCredentialFormatCreateProposalReturn, DidCommCredentialFormatCreateReturn, DidCommCredentialFormatProcessCredentialOptions, DidCommCredentialFormatProcessOptions, DidCommCredentialFormatService, DidCommCredentialFormatSpec, DidCommDataIntegrityCredentialFormat } from "@credo-ts/didcomm";
+
+//#region src/formats/DataIntegrityDidCommCredentialFormatService.d.ts
+declare class DataIntegrityDidCommCredentialFormatService implements DidCommCredentialFormatService<DidCommDataIntegrityCredentialFormat> {
+  /** formatKey is the key used when calling agent.credentials.xxx with credentialFormats.anoncreds */
+  readonly formatKey: "dataIntegrity";
+  /**
+   * credentialRecordType is the type of record that stores the credential. It is stored in the credential
+   * record binding in the credential exchange record.
+   */
+  readonly credentialRecordType: "w3c";
+  /**
+   * Create a {@link AttachmentFormats} object dependent on the message type.
+   *
+   * @param options The object containing all the options for the proposed credential
+   * @returns object containing associated attachment, format and optionally the credential preview
+   *
+   */
+  createProposal(_agentContext: AgentContext, options: DidCommCredentialFormatCreateProposalOptions<DidCommDataIntegrityCredentialFormat>): Promise<DidCommCredentialFormatCreateProposalReturn>;
+  processProposal(_agentContext: AgentContext, options: DidCommCredentialFormatProcessOptions): Promise<void>;
+  acceptProposal(_agentContext: AgentContext, _input: DidCommCredentialFormatAcceptProposalOptions<DidCommDataIntegrityCredentialFormat>): Promise<DidCommCredentialFormatCreateOfferReturn>;
+  /**
+   * Create a credential attachment format for a credential request.
+   *
+   * @param options The object containing all the options for the credential offer
+   * @returns object containing associated attachment, formats and offersAttach elements
+   *
+   */
+  createOffer(agentContext: AgentContext, {
+    credentialFormats,
+    credentialExchangeRecord,
+    attachmentId
+  }: DidCommCredentialFormatCreateOfferOptions<DidCommDataIntegrityCredentialFormat>): Promise<DidCommCredentialFormatCreateOfferReturn>;
+  private getCredentialVersion;
+  processOffer(agentContext: AgentContext, {
+    attachment,
+    credentialExchangeRecord
+  }: DidCommCredentialFormatProcessOptions): Promise<void>;
+  private createSignedAttachment;
+  private getSignedAttachmentPayload;
+  acceptOffer(agentContext: AgentContext, {
+    credentialExchangeRecord,
+    attachmentId,
+    offerAttachment,
+    credentialFormats
+  }: DidCommCredentialFormatAcceptOfferOptions<DidCommDataIntegrityCredentialFormat>): Promise<DidCommCredentialFormatCreateReturn>;
+  /**
+   * Starting from a request is not supported for anoncreds credentials, this method only throws an error.
+   */
+  createRequest(): Promise<DidCommCredentialFormatCreateReturn>;
+  /**
+   * We don't have any models to validate an anoncreds request object, for now this method does nothing
+   */
+  processRequest(_agentContext: AgentContext, _options: DidCommCredentialFormatProcessOptions): Promise<void>;
+  private createCredentialWithAnonCredsDataIntegrityProof;
+  private getSignatureMetadata;
+  private assertAndSetCredentialSubjectId;
+  private signCredential;
+  acceptRequest(agentContext: AgentContext, {
+    credentialFormats,
+    credentialExchangeRecord,
+    attachmentId,
+    offerAttachment,
+    requestAttachment,
+    requestAppendAttachments
+  }: DidCommCredentialFormatAcceptRequestOptions<DidCommDataIntegrityCredentialFormat>): Promise<DidCommCredentialFormatCreateReturn>;
+  private storeAnonCredsCredential;
+  /**
+   * Processes an incoming credential - retrieve metadata, retrieve payload and store it in wallet
+   * @param options the issue credential message wrapped inside this object
+   * @param credentialExchangeRecord the credential exchange record for this credential
+   */
+  processCredential(agentContext: AgentContext, {
+    credentialExchangeRecord,
+    attachment,
+    requestAttachment,
+    offerAttachment
+  }: DidCommCredentialFormatProcessCredentialOptions): Promise<void>;
+  supportsFormat(format: string): boolean;
+  /**
+   * Gets the attachment object for a given attachmentId. We need to get out the correct attachmentId for
+   * anoncreds and then find the corresponding attachment (if there is one)
+   * @param formats the formats object containing the attachmentId
+   * @param messageAttachments the attachments containing the payload
+   * @returns The DidCommAttachment if found or undefined
+   *
+   */
+  getAttachment(formats: DidCommCredentialFormatSpec[], messageAttachments: DidCommAttachment[]): DidCommAttachment | undefined;
+  deleteCredentialById(agentContext: AgentContext, credentialRecordId: string): Promise<void>;
+  shouldAutoRespondToProposal(_agentContext: AgentContext, options: DidCommCredentialFormatAutoRespondProposalOptions): Promise<boolean>;
+  shouldAutoRespondToOffer(_agentContext: AgentContext, {
+    offerAttachment
+  }: DidCommCredentialFormatAutoRespondOfferOptions): Promise<boolean>;
+  shouldAutoRespondToRequest(_agentContext: AgentContext, {
+    offerAttachment,
+    requestAttachment
+  }: DidCommCredentialFormatAutoRespondRequestOptions): Promise<boolean>;
+  shouldAutoRespondToCredential(_agentContext: AgentContext, options: DidCommCredentialFormatAutoRespondCredentialOptions): Promise<boolean>;
+  private createDataIntegrityCredentialOffer;
+  private previewAttributesFromCredential;
+  private assertCredentialAttributesMatchSchemaAttributes;
+  /**
+   * Returns an object of type {@link DidCommAttachment} for use in credential exchange messages.
+   * It looks up the correct format identifier and encodes the data as a base64 attachment.
+   *
+   * @param data The data to include in the attach object
+   * @param id the attach id from the formats component of the message
+   */
+  getFormatData(data: unknown, id: string): DidCommAttachment;
+  /**
+   * Returns the JWA Signature Algorithms that are supported by the agent.
+   */
+  private getSupportedJwaSignatureAlgorithms;
+}
+//#endregion
+export { DataIntegrityDidCommCredentialFormatService };
+//# sourceMappingURL=DataIntegrityDidCommCredentialFormatService.d.mts.map

package/build/formats/DataIntegrityDidCommCredentialFormatService.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataIntegrityDidCommCredentialFormatService.d.mts","names":[],"sources":["../../src/formats/DataIntegrityDidCommCredentialFormatService.ts"],"sourcesContent":[],"mappings":";;;;cA0Fa,2CAAA,YACA,+BAA+B;EAD/B;EAC+B,SAAA,SAAA,EAAA,eAAA;EAmBzB;;;;EAEd,SAAA,oBAAA,EAAA,KAAA;EAKc;;;;;;;EASd,cAAA,CAAA,aAAA,EAhBc,YAgBd,EAAA,OAAA,EAfQ,4CAeR,CAfqD,oCAerD,CAAA,CAAA,EAdA,OAcA,CAdQ,2CAcR,CAAA;EAYa,eAAA,CAAA,aAAA,EArBC,YAqBD,EAAA,OAAA,EApBL,qCAoBK,CAAA,EAnBb,OAmBa,CAAA,IAAA,CAAA;EAEZ,cAAA,CAAA,aAAA,EAhBa,YAgBb,EAAA,MAAA,EAfM,4CAeN,CAfmD,oCAenD,CAAA,CAAA,EAdD,OAcC,CAdO,wCAcP,CAAA;EACA;;;;;;;EAuCA,WAAA,CAAA,YAAA,EA1CY,YA0CZ,EAAA;IAAA,iBAAA;IAAA,wBAAA;IAAA;EAAA,CAAA,EArCC,yCAqCD,CArC2C,oCAqC3C,CAAA,CAAA,EApCD,OAoCC,CApCO,wCAoCP,CAAA;EAAY,QAAA,oBAAA;EAA4B,YAAA,CAAA,YAAA,EAD5B,YAC4B,EAAA;IAAA,UAAA;IAAA;EAAA,CAAA,EAAA,qCAAA,CAAA,EAAqC,OAArC,CAAA,IAAA,CAAA;EAAqC,QAAA,sBAAA;EAyIjE,QAAA,0BAAA;EAEZ,WAAA,CAAA,YAAA,EAFY,YAEZ,EAAA;IAAA,wBAAA;IAAA,YAAA;IAAA,eAAA;IAAA;EAAA,CAAA,EAIC,yCAJD,CAI2C,oCAJ3C,CAAA,CAAA,EAKD,OALC,CAKO,mCALP,CAAA;EACA;;;EAG2C,aAAA,CAAA,CAAA,EAoGjB,OApGiB,CAoGT,mCApGS,CAAA;EAA1C;;;EAoGiC,cAAA,CAAA,aAAA,EAQrB,YARqB,EAAA,QAAA,EAS1B,qCAT0B,CAAA,EAUnC,OAVmC,CAAA,IAAA,CAAA;EAAR,QAAA,+CAAA;EAQb,QAAA,oBAAA;EACL,QAAA,+BAAA;EACT,QAAA,cAAA;EA2Ma,aAAA,CAAA,YAAA,EAAA,YAAA,EAAA;IAAA,iBAAA;IAAA,wBAAA;IAAA,YAAA;IAAA,eAAA;IAAA,iBAAA;IAAA;EAAA,CAAA,EAQX,2CARW,CAQiC,oCARjC,CAAA,CAAA,EASb,OATa,CASL,mCATK,CAAA;EAEZ,QAAA,wBAAA;EACA;;;;;EAK6C,iBAAA,CAAA,YAAA,EA0JjC,YA1JiC,EAAA;IAAA,wBAAA;IAAA,UAAA;IAAA,iBAAA;IAAA;EAAA,CAAA,EAgK5C,+CAhK4C,CAAA,EAiK9C,OAjK8C,CAAA,IAAA,CAAA;EAA5C,cAAA,CAAA,MAAA,EAAA,MAAA,CAAA,EAAA,OAAA;EACM;;;;;;;;EAgKR,aAAA,CAAA,OAAA,EAsHQ,2BAtHR,EAAA,EAAA,kBAAA,EAuHmB,iBAvHnB,EAAA,CAAA,EAwHA,iBAxHA,GAAA,SAAA;EAsHQ,oBAAA,CAAA,YAAA,EASqC,YATrC,EAAA,kBAAA,EAAA,MAAA,CAAA,EASgF,OAThF,CAAA,IAAA,CAAA;EACW,2BAAA,CAAA,aAAA,EAgBL,YAhBK,EAAA,OAAA,EAiBX,iDAjBW,CAAA,EAkBnB,OAlBmB,CAAA,OAAA,CAAA;EACnB,wBAAA,CAAA,aAAA,EAsBc,YAtBd,EAAA;IAAA;EAAA,CAAA,EAuBoB,8CAvBpB,CAAA,EAuBkE,OAvBlE,CAAA,OAAA,CAAA;EAO6C,0BAAA,CAAA,aAAA,EAwB/B,YAxB+B,EAAA;IAAA,eAAA;IAAA;EAAA,CAAA,EAyBN,gDAzBM,CAAA,EAyB0C,OAzB1C,CAAA,OAAA,CAAA;EAA2C,6BAAA,CAAA,aAAA,EAsE1E,YAtE0E,EAAA,OAAA,EAuEhF,mDAvEgF,CAAA,EAuE7B,OAvE6B,CAAA,OAAA,CAAA;EAQ1E,QAAA,kCAAA;EACN,QAAA,+BAAA;EACR,QAAA,+CAAA;EAKc;;;;;;;EAUyB,aAAA,CAAA,IAAA,EAAA,OAAA,EAAA,EAAA,EAAA,MAAA,CAAA,EA6MO,iBA7MP;EAAgD;;;EA8C5B,QAAA,kCAAA"}