@sphereon/ssi-types 0.8.1-unstable.9 → 0.9.0

package/src/types/vc.ts

@@ -1,42 +1,40 @@
 import { PresentationSubmission } from './pex'
 import { IProofPurpose, IProofType } from './did'
 
-type AdditionalProperties = Record<string, any>
+export type AdditionalClaims = Record<string, any>
+
+export type IIssuerId = string
 
 export interface ICredential {
-  // If exp is present, the UNIX timestamp MUST be converted to an [XMLSCHEMA11-2] date-time, and MUST be used to set the value of the expirationDate property of credentialSubject of the new JSON object.
-  expirationDate?: string
+  '@context': ICredentialContextType | ICredentialContextType[]
+  type: string[]
+  credentialSchema?: undefined | ICredentialSchemaType | ICredentialSchemaType[]
   // If iss is present, the value MUST be used to set the issuer property of the new credential JSON object or the holder property of the new presentation JSON object.
-  issuer: string | IIssuer
+  issuer: IIssuerId | IIssuer
   // If nbf is present, the UNIX timestamp MUST be converted to an [XMLSCHEMA11-2] date-time, and MUST be used to set the value of the issuanceDate property of the new JSON object.
   issuanceDate: string
   // If sub is present, the value MUST be used to set the value of the id property of credentialSubject of the new credential JSON object.
-  credentialSubject: ICredentialSubject & AdditionalProperties
+  credentialSubject: (ICredentialSubject & AdditionalClaims) | (ICredentialSubject & AdditionalClaims)[]
+  // If exp is present, the UNIX timestamp MUST be converted to an [XMLSCHEMA11-2] date-time, and MUST be used to set the value of the expirationDate property of credentialSubject of the new JSON object.
+  expirationDate?: string
   // If jti is present, the value MUST be used to set the value of the id property of the new JSON object.
   id?: string
-  '@context': ICredentialContextType[] | ICredentialContextType
   credentialStatus?: ICredentialStatus
-  credentialSchema?: undefined | ICredentialSchemaType | ICredentialSchemaType[]
   description?: string
   name?: string
-  type: string[]
 
   [x: string]: any
 }
 
 export interface ICredentialSubject {
   id?: string
-
-  // [x: string]: string | string[] | object | object[] | unknown
 }
 
-export type ICredentialContextType = (ICredentialContext & AdditionalProperties) | string
+export type ICredentialContextType = (ICredentialContext & AdditionalClaims) | string
 
 export interface ICredentialContext {
   name?: string
   did?: string
-
-  // [x: string]: unknown
 }
 
 export type ICredentialSchemaType = ICredentialSchema | string
@@ -55,10 +53,11 @@ export interface IProof {
   domain?: string // A string restricting the (usage of a) proof to the domain and protects against replay attacks
   proofValue?: string // One of any number of valid representations of proof values
   jws?: string // JWS based proof
+  jwt?: string //Jwt 2020 proof. Used to map a JWT VC onto a uniform presentation, and retain access to the original JWT
   nonce?: string // Similar to challenge. A nonce to protect against replay attacks, used in some ZKP proofs
   requiredRevealStatements?: string[] // The parts of the proof that must be revealed in a derived proof
 
-  // [x: string]: string | string[] | undefined
+  [x: string]: any // Any because we want to be able to access value1.value2.value3, which unknown does not allow for without a cast
 }
 
 export interface ICredentialStatus {
@@ -78,11 +77,23 @@ export interface IHasProof {
 
 export type IVerifiableCredential = ICredential & IHasProof
 
+/**
+ * Represents a Json Web Token in compact form.
+ */
+export type CompactJWT = string
+
+/**
+ * Represents a signed Verifiable Credential (includes proof), in either JSON or compact JWT format.
+ * See {@link https://www.w3.org/TR/vc-data-model/#credentials | VC data model}
+ * See {@link https://www.w3.org/TR/vc-data-model/#proof-formats | proof formats}
+ */
+export type W3CVerifiableCredential = IVerifiableCredential | CompactJWT
+
 export interface IPresentation {
   id?: string
   '@context': ICredentialContextType | ICredentialContextType[]
-  type: string[]
-  verifiableCredential: IVerifiableCredential[] //| ICredential[] // we relax to ICredential for internal decoded stable representations without proofs
+  type?: string | string[]
+  verifiableCredential?: W3CVerifiableCredential[]
   presentation_submission?: PresentationSubmission
   holder?: string
 
@@ -91,6 +102,13 @@ export interface IPresentation {
 
 export type IVerifiablePresentation = IPresentation & IHasProof
 
+/**
+ * Represents a signed Verifiable Presentation (includes proof), in either JSON or compact JWT format.
+ * See {@link https://www.w3.org/TR/vc-data-model/#presentations | VC data model}
+ * See {@link https://www.w3.org/TR/vc-data-model/#proof-formats | proof formats}
+ */
+export type W3CVerifiablePresentation = IVerifiablePresentation | CompactJWT
+
 export interface WrappedVerifiableCredential {
   /**
    * Original VC that we've received
@@ -107,11 +125,11 @@ export interface WrappedVerifiableCredential {
   /**
    * The claim format, typically used during exchange transport protocols
    */
-  format: ClaimFormat
+  format: CredentialFormat
   /**
-   * Internal stable representation of a Credential without Proofs, created based on https://www.w3.org/TR/vc-data-model/#jwt-decoding
+   * Internal stable representation of a Credential
    */
-  credential: ICredential
+  credential: IVerifiableCredential
 }
 
 export interface WrappedVerifiablePresentation {
@@ -130,7 +148,7 @@ export interface WrappedVerifiablePresentation {
   /**
    * The claim format, typically used during exchange transport protocols
    */
-  format: ClaimFormat
+  format: PresentationFormat
   /**
    * Internal stable representation of a Presentation without proofs, created based on https://www.w3.org/TR/vc-data-model/#jwt-decoding
    */
@@ -149,14 +167,14 @@ export enum OriginalType {
 
 export interface UniformVerifiablePresentation {
   '@context': ICredentialContextType | ICredentialContextType[]
-  type: string[]
+  type: string | string[]
   verifiableCredential: WrappedVerifiableCredential[]
   presentation_submission?: PresentationSubmission
   holder?: string
 }
 
 export interface JwtDecodedVerifiableCredential {
-  vc: ICredential
+  vc: IVerifiableCredential
   exp: string
   iss: string
   nbf: string
@@ -177,8 +195,16 @@ export interface JwtDecodedVerifiablePresentation {
   [x: string]: any
 }
 
-export type ClaimFormat = 'jwt' | 'jwt_vc' | 'jwt_vp' | 'ldp' | 'ldp_vc' | 'ldp_vp' | string
+export type CredentialFormat = 'jwt' | 'ldp' | 'jwt_vc' | 'ldp_vc' | string
+export type PresentationFormat = 'jwt' | 'ldp' | 'jwt_vp' | 'ldp_vp' | string
+export type ClaimFormat = CredentialFormat | PresentationFormat
 
-export type OriginalVerifiableCredential = IVerifiableCredential | JwtDecodedVerifiableCredential | string
-export type OriginalVerifiablePresentation = IPresentation | JwtDecodedVerifiablePresentation | string
+export type OriginalVerifiableCredential = W3CVerifiableCredential | JwtDecodedVerifiableCredential
+export type OriginalVerifiablePresentation = W3CVerifiablePresentation | JwtDecodedVerifiablePresentation
 export type Original = OriginalVerifiablePresentation | OriginalVerifiableCredential
+
+export const enum DocumentFormat {
+  JWT,
+  JSONLD,
+  EIP712,
+}