@credo-ts/core/build/modules/vc/W3cV2CredentialServiceOptions.d.mts

<p align="center"> <br /> <img alt="Credo Logo" src="https://github.com/openwallet-foundation/credo-ts/blob/c7886cb8377ceb8ee4efe8d264211e561a75072d/images/credo-logo.png" height="250px" /> </p> <h1 align="center"><b>Credo - Core</b></h1

import { KnownJwaSignatureAlgorithm } from "../kms/jwk/jwa.mjs";
import { HashName } from "../../crypto/hashes/Hasher.mjs";
import { IDisclosureFrame, IPresentationFrame, SdJwtVcHolderBinding } from "../sd-jwt-vc/SdJwtVcOptions.mjs";
import "../sd-jwt-vc/index.mjs";
import { ClaimFormat } from "./models/ClaimFormat.mjs";
import { W3cV2Credential } from "./models/credential/W3cV2Credential.mjs";
import { W3cV2JwtVerifiableCredential } from "./jwt-vc/W3cV2JwtVerifiableCredential.mjs";
import { W3cV2SdJwtVerifiableCredential } from "./sd-jwt-vc/W3cV2SdJwtVerifiableCredential.mjs";
import { W3cV2DataIntegrityVerifiableCredential } from "./data-integrity/W3cV2DataIntegrityVerifiableCredential.mjs";
import { W3cV2DataIntegrityVerifiablePresentation } from "./data-integrity/W3cV2DataIntegrityVerifiablePresentation.mjs";
import { W3cV2Presentation } from "./models/presentation/W3cV2Presentation.mjs";
import { W3cV2JwtVerifiablePresentation } from "./jwt-vc/W3cV2JwtVerifiablePresentation.mjs";
import { W3cV2SdJwtVerifiablePresentation } from "./sd-jwt-vc/W3cV2SdJwtVerifiablePresentation.mjs";
import "./models/index.mjs";
import { W3cV2CredentialRecord } from "./repository/W3cV2CredentialRecord.mjs";
import "./repository/index.mjs";
import "./sd-jwt-vc/index.mjs";
import "./jwt-vc/index.mjs";
import "./data-integrity/index.mjs";
import { TrustedIssuerDid } from "../../agent/TrustedIssuersForVerification.mjs";
import "../../crypto/index.mjs";
import "../kms/index.mjs";
//#region src/modules/vc/W3cV2CredentialServiceOptions.d.ts
type W3cV2CredentialSignOptionsByFormat = {
  [ClaimFormat.JwtW3cVc]: W3cV2JwtSignCredentialOptions;
  [ClaimFormat.SdJwtW3cVc]: W3cV2SdJwtSignCredentialOptions;
  [ClaimFormat.DiVc]: W3cV2DiSignCredentialOptions;
};
type W3cV2CredentialVerifyOptionsByFormat = {
  [ClaimFormat.JwtW3cVc]: W3cV2JwtVerifyCredentialOptions;
  [ClaimFormat.SdJwtW3cVc]: W3cV2SdJwtVerifyCredentialOptions;
  [ClaimFormat.DiVc]: W3cV2DiVerifyCredentialOptions;
};
type W3cV2PresentationSignOptionsByFormat = {
  [ClaimFormat.JwtW3cVp]: W3cV2JwtSignPresentationOptions;
  [ClaimFormat.SdJwtW3cVp]: W3cV2SdJwtSignPresentationOptions;
  [ClaimFormat.DiVp]: W3cV2DiSignPresentationOptions;
};
export type W3cV2SignCredentialOptions<Format extends keyof W3cV2CredentialSignOptionsByFormat | undefined = undefined> = Format extends keyof W3cV2CredentialSignOptionsByFormat ? W3cV2CredentialSignOptionsByFormat[Format] : W3cV2CredentialSignOptionsByFormat[keyof W3cV2CredentialSignOptionsByFormat];
export type W3cV2VerifyCredentialOptions<Format extends keyof W3cV2CredentialVerifyOptionsByFormat | undefined = undefined> = Format extends keyof W3cV2CredentialVerifyOptionsByFormat ? W3cV2CredentialVerifyOptionsByFormat[Format] : W3cV2CredentialVerifyOptionsByFormat[keyof W3cV2CredentialVerifyOptionsByFormat];
export type W3cV2SignPresentationOptions<Format extends keyof W3cV2PresentationSignOptionsByFormat | undefined = undefined> = Format extends keyof W3cV2PresentationSignOptionsByFormat ? W3cV2PresentationSignOptionsByFormat[Format] : W3cV2PresentationSignOptionsByFormat[keyof W3cV2PresentationSignOptionsByFormat];
export type W3cV2VerifyPresentationOptions = W3cV2JwtVerifyPresentationOptions | W3cV2SdJwtVerifyPresentationOptions | W3cV2DiVerifyPresentationOptions;
interface W3cV2SignCredentialOptionsBase<Format extends ClaimFormat = ClaimFormat> {
  /**
   * The format of the credential to be signed.
   *
   * @see https://identity.foundation/claim-format-registry
   */
  format: Format;
  /**
   * The credential to be signed.
   */
  credential: W3cV2Credential;
  /**
   * URI of the verificationMethod to be used for signing the credential.
   *
   * Must be a valid did url pointing to a key.
   */
  verificationMethod: string;
}
export interface W3cV2JwtSignCredentialOptions extends W3cV2SignCredentialOptionsBase<ClaimFormat.JwtW3cVc> {
  /**
   * The algorithm used to sign the JWT VC.
   */
  alg: KnownJwaSignatureAlgorithm;
  /**
   * The holder to bind the credential to. When an holder is provided, a `cnf`
   * claim will be added to the produced credential, binding it to the holder.
   */
  holder?: SdJwtVcHolderBinding;
}
export interface W3cV2SdJwtSignCredentialOptions extends W3cV2SignCredentialOptionsBase<ClaimFormat.SdJwtW3cVc> {
  /**
   * The algorithm used to sign the SD-JWT VC.
   */
  alg: KnownJwaSignatureAlgorithm;
  /**
   * The hashing algorithm to use for creating digests of the disclosures.
   *
   * @default 'sha-256'
   */
  hashingAlgorithm?: Exclude<HashName, 'sha-1'>;
  /**
   * The holder to bind the credential to. When an holder is provided, a `cnf`
   * claim will be added to the produced credential, binding it to the holder.
   */
  holder?: SdJwtVcHolderBinding;
  /**
   * Disclosure frame defining which claims should be selectively disclosable.
   * If not provided, all claims will be disclosable.
   */
  disclosureFrame?: IDisclosureFrame;
}
interface W3cV2VerifyCredentialOptionsBase<Credential = unknown> {
  credential: Credential;
  /**
   * Whether to verify credentialStatus, if present.
   *
   * When false/undefined, VC2 verification does not fail on credentialStatus presence.
   */
  verifyCredentialStatus?: boolean;
  /**
   * Trusted issuers for the verification.
   */
  trustedIssuers?: TrustedIssuerDid[];
}
export interface W3cV2JwtVerifyCredentialOptions extends W3cV2VerifyCredentialOptionsBase<W3cV2JwtVerifiableCredential | string> {}
export interface W3cV2SdJwtVerifyCredentialOptions extends W3cV2VerifyCredentialOptionsBase<W3cV2SdJwtVerifiableCredential | string> {}
interface W3cV2SignPresentationOptionsBase<Format extends ClaimFormat = ClaimFormat> {
  /**
   * The format of the presentation to be signed.
   *
   * @see https://identity.foundation/claim-format-registry
   */
  format: Format;
  /**
   * The presentation to be signed.
   */
  presentation: W3cV2Presentation;
  /**
   * The challenge / nonce to be used in the proof to prevent replay attacks.
   */
  challenge: string;
  /**
   * The domain / aud to be used in the proof to assert the intended recipient.
   */
  domain?: string;
}
export interface W3cV2JwtSignPresentationOptions extends W3cV2SignPresentationOptionsBase<ClaimFormat.JwtW3cVp> {}
export interface W3cV2SdJwtSignPresentationOptions extends W3cV2SignPresentationOptionsBase<ClaimFormat.SdJwtW3cVp> {
  /**
   * The hashing algorithm to use for creating digests of the disclosures.
   *
   * @default 'sha-256'
   */
  hashingAlgorithm?: Exclude<HashName, 'sha-1'>;
  /**
   * Disclosure frame defining which claims should be selectively disclosable.
   * If not provided, all claims will be disclosable.
   */
  disclosureFrame?: IDisclosureFrame;
}
interface W3cV2VerifyPresentationOptionsBase<Presentation = unknown> {
  /**
   * The presentation to be verified.
   */
  presentation: Presentation;
  /**
   * The challenge / nonce that must present in the presentation prevent replay attacks.
   */
  challenge: string;
  /**
   * The domain / aud to be used in the proof to assert the intended recipient.
   */
  domain?: string;
  /**
   * Trusted issuers for the verification.
   */
  trustedIssuers?: TrustedIssuerDid[];
}
export interface W3cV2JwtVerifyPresentationOptions extends W3cV2VerifyPresentationOptionsBase<W3cV2JwtVerifiablePresentation | string> {}
export interface W3cV2SdJwtVerifyPresentationOptions extends W3cV2VerifyPresentationOptionsBase<W3cV2SdJwtVerifiablePresentation | string> {}
export interface W3cV2StoreCredentialOptions {
  record: W3cV2CredentialRecord;
}
export interface W3cV2SdJwtVcPresentOptions {
  credential: W3cV2SdJwtVerifiableCredential | string;
  /**
   * Use true to disclose everything
   */
  presentationFrame?: IPresentationFrame | true;
}
/**
 * Data Integrity (di_vc) credential signing options
 */
export interface W3cV2DiSignCredentialOptions extends W3cV2SignCredentialOptionsBase<ClaimFormat.DiVc> {
  /**
   * The cryptosuite to use for signing (e.g., 'eddsa-jcs-2022')
   */
  cryptosuite: string;
}
/**
 * Data Integrity (di_vc) credential verification options
 */
export interface W3cV2DiVerifyCredentialOptions extends W3cV2VerifyCredentialOptionsBase<W3cV2DataIntegrityVerifiableCredential> {}
/**
 * Data Integrity (di_vp) presentation signing options
 */
export interface W3cV2DiSignPresentationOptions extends W3cV2SignPresentationOptionsBase<ClaimFormat.DiVp> {
  /**
   * URI of the verificationMethod to be used for signing the presentation proof.
   *
   * Must be a valid did url pointing to a key.
   */
  verificationMethod: string;
  /**
   * The cryptosuite to use for signing (e.g., 'eddsa-jcs-2022')
   */
  cryptosuite: string;
}
/**
 * Data Integrity (di_vp) presentation verification options
 */
export interface W3cV2DiVerifyPresentationOptions extends W3cV2VerifyPresentationOptionsBase<W3cV2DataIntegrityVerifiablePresentation> {}
//#endregion
//# sourceMappingURL=W3cV2CredentialServiceOptions.d.mts.map