@credo-ts/core/build/modules/sd-jwt-vc/SdJwtVcService.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 { Query, QueryOptions } from "../../storage/StorageService.mjs";
import { JsonObject } from "../../types.mjs";
import { ClaimPath } from "./disclosureFrame.mjs";
import { SdJwtVcHeader, SdJwtVcHolderBinding, SdJwtVcIssuer, SdJwtVcPayload, SdJwtVcPresentOptions, SdJwtVcSignOptions, SdJwtVcStoreOptions, SdJwtVcVerifyOptions } from "./SdJwtVcOptions.mjs";
import { SdJwtVcTypeMetadata } from "./typeMetadata.mjs";
import { SdJwtVcRecord } from "./repository/SdJwtVcRecord.mjs";
import { SdJwtVcRepository } from "./repository/SdJwtVcRepository.mjs";
import "./repository/index.mjs";
import { ClaimFormat } from "../vc/models/ClaimFormat.mjs";
import "../vc/index.mjs";
import { AgentContext } from "../../agent/context/AgentContext.mjs";
import "../../agent/index.mjs";
import { NonEmptyArray } from "@animo-id/pex";
//#region src/modules/sd-jwt-vc/SdJwtVcService.d.ts
export interface SdJwtVc<Header extends SdJwtVcHeader = SdJwtVcHeader, Payload extends SdJwtVcPayload = SdJwtVcPayload> {
  /**
   * claim format is convenience method added to all credential instances
   */
  claimFormat: ClaimFormat.SdJwtDc;
  /**
   * encoded is convenience method added to all credential instances
   */
  encoded: string;
  compact: string;
  header: Header;
  /**
   * The issuer of the credential
   */
  issuer: SdJwtVcIssuer;
  /**
   * The holder of the credential
   */
  holder?: SdJwtVcHolderBinding;
  payload: Payload;
  prettyClaims: Payload;
  kbJwt?: {
    header: Record<string, unknown>;
    payload: Record<string, unknown>;
  };
  /**
   * The key id in the KMS bound to this SD-JWT VC, used for presentations.
   *
   * This will only be set on the holder side if defined on the SdJwtVcRecord
   */
  kmsKeyId?: string;
  /**
   * The merged/resolved type metadata of the SD-JWT VC.
   */
  typeMetadata?: SdJwtVcTypeMetadata;
}
export interface VerificationResult {
  isValid: boolean;
  isValidJwtPayload?: boolean;
  isSignatureValid?: boolean;
  isStatusValid?: boolean;
  isNotBeforeValid?: boolean;
  isExpiryTimeValid?: boolean;
  areRequiredClaimsIncluded?: boolean;
  isKeyBindingValid?: boolean;
  containsExpectedKeyBinding?: boolean;
  containsRequiredVcProperties?: boolean;
}
/**
 * @internal
 */
export declare class SdJwtVcService {
  private sdJwtVcRepository;
  constructor(sdJwtVcRepository: SdJwtVcRepository);
  sign<Payload extends SdJwtVcPayload>(agentContext: AgentContext, options: SdJwtVcSignOptions<Payload>): Promise<SdJwtVc>;
  fromCompact<Header extends SdJwtVcHeader = SdJwtVcHeader, Payload extends SdJwtVcPayload = SdJwtVcPayload>(compactSdJwtVc: string, typeMetadata?: SdJwtVcTypeMetadata): SdJwtVc<Header, Payload>;
  /**
   * @deprecated use `applyDisclosuresForPaths` instead
   */
  applyDisclosuresForPayload(compactSdJwtVc: string, requestedPayload: JsonObject): SdJwtVc;
  applyDisclosuresForPaths(compactSdJwtVc: string, disclosedPaths: ClaimPath[]): SdJwtVc;
  present<Payload extends SdJwtVcPayload = SdJwtVcPayload>(agentContext: AgentContext, { sdJwtVc, presentationFrame, verifierMetadata, additionalPayload }: SdJwtVcPresentOptions<Payload>): Promise<string>;
  private assertValidX5cJwtIssuer;
  verify<Header extends SdJwtVcHeader = SdJwtVcHeader, Payload extends SdJwtVcPayload = SdJwtVcPayload>(agentContext: AgentContext, { compactSdJwtVc, keyBinding, requiredClaimKeys, fetchTypeMetadata, trustedCertificates, trustedIssuers: _trustedIssuers, disableStatusValidation, verifyCredentialStatus, now }: SdJwtVcVerifyOptions): Promise<{
    isValid: true;
    sdJwtVc: SdJwtVc<Header, Payload>;
    /**
     * The full type metadata chain, can be used for further processing the type metadata.
     *
     * Only populated if `fetchTypeMetadata` is set to true, and the resolver returned a type
     * metadata document.
     */
    typeMetadataChain?: NonEmptyArray<SdJwtVcTypeMetadata>;
  } | {
    isValid: false;
    sdJwtVc?: SdJwtVc<Header, Payload>;
    error: Error;
  }>;
  /**
   * Resolve the type metadata for an SD-JWT instance.
   *
   * This method resolves the `vct` value, and any `extends` values.
   */
  fetchTypeMetadata(agentContext: AgentContext, sdJwtVc: SdJwtVc, { throwErrorOnFetchError, throwErrorOnUnsupportedVctValue }?: {
    throwErrorOnFetchError?: boolean;
    throwErrorOnUnsupportedVctValue?: boolean;
  }): Promise<import("@sd-jwt/sd-jwt-vc").ResolvedTypeMetadata | undefined>;
  store(agentContext: AgentContext, options: SdJwtVcStoreOptions): Promise<SdJwtVcRecord>;
  getById(agentContext: AgentContext, id: string): Promise<SdJwtVcRecord>;
  getAll(agentContext: AgentContext): Promise<Array<SdJwtVcRecord>>;
  findByQuery(agentContext: AgentContext, query: Query<SdJwtVcRecord>, queryOptions?: QueryOptions): Promise<Array<SdJwtVcRecord>>;
  deleteById(agentContext: AgentContext, id: string): Promise<void>;
  update(agentContext: AgentContext, sdJwtVcRecord: SdJwtVcRecord): Promise<void>;
  private extractKeyFromIssuer;
  private verifyIssuer;
  private getBaseSdJwtConfig;
  private getStatusListFetcher;
  /**
   * Builds a `Verifier` for the status list JWT signature, gated by the trusted issuer that was matched
   * for the credential issuer (the status list signer is not always the credential issuer).
   *
   * The library's `Verifier` only receives the unsigned token (`<header>.<payload>`) and the signature,
   * so the status list JWT's own header (`x5c`/`kid`) is recovered by decoding the first segment.
   */
  private getStatusVerifier;
  private getVctFetcher;
  private httpsTypeMetadataResolver;
}
//#endregion
//# sourceMappingURL=SdJwtVcService.d.mts.map