@sphereon/oid4vci-issuer/lib/types/index.ts

OpenID 4 Verifiable Credential Issuance issuer REST endpoints

import {
  AssertedUniformCredentialOffer,
  CNonceState,
  CredentialDataSupplierInput,
  CredentialRequest,
  CredentialSupplierConfig,
  JwtVerifyResult,
  OID4VCICredentialFormat,
  StatusListOpts,
  UniformCredentialRequest,
} from '@sphereon/oid4vci-common'
import {
  CompactSdJwtVc,
  ICredential,
  SdJwtDecodedVerifiableCredentialPayload,
  SdJwtDisclosureFrame,
  W3CVerifiableCredential,
} from '@sphereon/ssi-types'

export type CredentialSignerCallback = (opts: {
  credentialRequest: CredentialRequest
  credential: CredentialIssuanceInput
  format?: OID4VCICredentialFormat
  /**
   * We use object since we don't want to expose the DID Document TS type to too many interfaces.
   * An implementation that wants to look into the DIDDoc would have to do a cast in the signer callback implementation
   */
  jwtVerifyResult: JwtVerifyResult
  statusLists?: Array<StatusListOpts>
}) => Promise<W3CVerifiableCredential | CompactSdJwtVc>

export interface CredentialDataSupplierArgs extends CNonceState {
  credentialRequest: UniformCredentialRequest
  credentialOffer: AssertedUniformCredentialOffer
  clientId?: string
  credentialSupplierConfig?: CredentialSupplierConfig
  credentialDataSupplierInput?: CredentialDataSupplierInput
}

export type CredentialIssuanceInput = ICredential | (SdJwtDecodedVerifiableCredentialPayload & { __disclosureFrame?: SdJwtDisclosureFrame })

export interface CredentialDataSupplierResult {
  credential: CredentialIssuanceInput
  format?: OID4VCICredentialFormat
  signCallback?: CredentialSignerCallback // If the data supplier wants to actually sign directly
}

export type CredentialDataSupplier = (args: CredentialDataSupplierArgs) => Promise<CredentialDataSupplierResult>