@sphereon/ssi-types/src/types/vcdm2-sdjwt/sd-jwt-vc-config.ts

SSI Common Types

import type { SDJWTConfig, Verifier } from '@sd-jwt/types'

export type StatusListFetcher = (uri: string) => Promise<string>
export type StatusValidator = (status: number) => Promise<void>

/**
 * Configuration for SD-JWT-VC
 */
export type SDJWTVCDM2Config = SDJWTConfig & {
  // A function that fetches the status list from the uri. If not provided, the library will assume that the response is a compact JWT.
  statusListFetcher?: StatusListFetcher
  // validte the status and decide if the status is valid or not. If not provided, the code will continue if it is 0, otherwise it will throw an error.
  statusValidator?: StatusValidator
  // a function that fetches the type metadata format from the uri. If not provided, the library will assume that the response is a TypeMetadataFormat. Caching has to be implemented in this function. If the integrity value is passed, it to be validated according to https://www.w3.org/TR/SRI/
  // vctFetcher?: VcTFetcher;
  // a function that verifies the status of the JWT. If not provided, the library will assume that the status is valid if it is 0.
  statusVerifier?: Verifier
  // if set to true, it will load the metadata format based on the vct value. If not provided, it will default to false.
  loadTypeMetadataFormat?: boolean
  // timeout value in milliseconds when to abort the fetch request. If not provided, it will default to 10000.
  timeout?: number
}