@sphereon/ssi-types/src/types/vc.ts

SSI Common Types

import type {
  MdocDeviceResponse,
  MdocDocument,
  MdocOid4vpIssuerSigned,
  MdocOid4vpMdocVpToken,
  WrappedMdocCredential,
  WrappedMdocPresentation,
} from './mso_mdoc'
import type { SdJwtDecodedVerifiableCredential, WrappedSdJwtVerifiableCredential, WrappedSdJwtVerifiablePresentation } from './sd-jwt-vc'
import type {
  JwtDecodedVerifiableCredential,
  JwtDecodedVerifiablePresentation,
  W3CVerifiableCredential,
  W3CVerifiablePresentation,
  WrappedW3CVerifiableCredential,
  WrappedW3CVerifiablePresentation,
} from './w3c-vc'

export type WrappedVerifiableCredential = WrappedW3CVerifiableCredential | WrappedSdJwtVerifiableCredential | WrappedMdocCredential

export type WrappedVerifiablePresentation = WrappedW3CVerifiablePresentation | WrappedSdJwtVerifiablePresentation | WrappedMdocPresentation

export type CredentialProofFormat = 'jwt' | 'lds' | 'vc+jwt' /*| 'EthereumEip712Signature2021'*/ | 'cbor'

export type CredentialFormat =
  // W3C
  | 'jwt_vc'
  | 'ldp_vc'
  | 'vc+jwt'
  // SD-JWT
  | 'dc+sd-jwt'
  // Remaining
  | 'jwt'
  | 'ldp'
  | 'mso_mdoc'
  | string

export type PresentationFormat =
  // W3C
  | 'jwt_vp'
  | 'ldp_vp'
  | 'vp+jwt'
  // SD-JWT
  | 'vp+sd-jwt'
  | 'dc+sd-jwt'
  // Remaining
  | 'jwt'
  | 'ldp'
  | 'mso_mdoc'
  | string

export type ClaimFormat = CredentialFormat | PresentationFormat

export type OriginalVerifiableCredential =
  | W3CVerifiableCredential
  | JwtDecodedVerifiableCredential
  | SdJwtDecodedVerifiableCredential
  | MdocOid4vpIssuerSigned
  | MdocDocument
export type OriginalVerifiablePresentation =
  | W3CVerifiablePresentation
  | JwtDecodedVerifiablePresentation
  | SdJwtDecodedVerifiableCredential
  | MdocOid4vpMdocVpToken
  | MdocDeviceResponse
export type Original = OriginalVerifiablePresentation | OriginalVerifiableCredential

export type JwtObject = {
  alg_values: Array<string>
}

export type LdpObject = {
  proof_type_values: Array<string>
}

export type DiObject = {
  proof_type_values: Array<string>
  cryptosuite: Array<string>
}

export type SdJwtObject = {
  ['sd-jwt_alg_values']?: Array<string>
  ['kb-jwt_alg_values']?: Array<string>
}

export type MsoMdocObject = {
  ['issuerauth_alg_values']?: Array<number>
  ['deviceauth_alg_values']?: Array<number>
}

export type Format = {
  jwt?: JwtObject
  jwt_vc?: JwtObject
  jwt_vc_json?: JwtObject
  jwt_vp?: JwtObject
  jwt_vp_json?: JwtObject
  ldp?: LdpObject
  ldp_vc?: LdpObject
  ldp_vp?: LdpObject
  di?: DiObject
  di_vc?: DiObject
  di_vp?: DiObject
  ['vc+sd-jwt']?: SdJwtObject
  ['dc+sd-jwt']?: SdJwtObject
  mso_mdoc?: MsoMdocObject
}