@sphereon/ssi-types 0.8.0 → 0.8.1-next.117

package/src/types/vc.ts

@@ -1,39 +1,40 @@
 import { PresentationSubmission } from './pex'
 import { IProofPurpose, IProofType } from './did'
 
+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
+  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
+  id?: string
   credentialStatus?: ICredentialStatus
-  credentialSchema?: undefined | ICredentialSchemaType | ICredentialSchemaType[]
   description?: string
   name?: string
-  type: string[]
 
-  [x: string]: unknown
+  [x: string]: any
 }
 
 export interface ICredentialSubject {
   id?: string
-
-  [x: string]: unknown
 }
 
-export type ICredentialContextType = ICredentialContext | string
+export type ICredentialContextType = (ICredentialContext & AdditionalClaims) | string
 
 export interface ICredentialContext {
   name?: string
   did?: string
-  [x: string]: unknown
 }
 
 export type ICredentialSchemaType = ICredentialSchema | string
@@ -55,7 +56,7 @@ export interface IProof {
   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 {
@@ -66,7 +67,7 @@ export interface ICredentialStatus {
 export interface IIssuer {
   id: string
 
-  [x: string]: unknown
+  [x: string]: any
 }
 
 export interface IHasProof {
@@ -75,50 +76,95 @@ 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[]
+  verifiableCredential: W3CVerifiableCredential[] // we relax to ICredential for internal decoded stable representations without proofs
   presentation_submission?: PresentationSubmission
   holder?: string
+
+  [x: string]: any
 }
 
 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
    */
-  original: string | JwtWrappedVerifiableCredential | IVerifiableCredential
+  original: OriginalVerifiableCredential
   /**
    * In case of JWT credential it will be the decoded version. In other cases it will be the same as original one
    */
-  decoded: JwtWrappedVerifiableCredential | IVerifiableCredential
+  decoded: JwtDecodedVerifiableCredential | IVerifiableCredential
   /**
-   * Type of this credential. Supported types are json-ld and jwt
+   * Type of this credential. Supported types are json-ld and jwt (decoded/encoded)
    */
-  type: VerifiableDataExchangeType
+  type: OriginalType
   /**
-   * created based on https://www.w3.org/TR/vc-data-model/#jwt-decoding
+   * The claim format, typically used during exchange transport protocols
    */
-  internalCredential: ICredential
+  format: CredentialFormat
+  /**
+   * Internal stable representation of a Credential without Proofs, created based on https://www.w3.org/TR/vc-data-model/#jwt-decoding
+   */
+  credential: ICredential
 }
 
 export interface WrappedVerifiablePresentation {
-  original: string | JwtWrappedVerifiablePresentation | IVerifiablePresentation
-  decoded: JwtWrappedVerifiablePresentation | IVerifiablePresentation
-  type: VerifiableDataExchangeType
-  internalPresentation: InternalPresentation
+  /**
+   * Original VP that we've received
+   */
+  original: OriginalVerifiablePresentation
+  /**
+   * In case of JWT VP it will be the decoded version. In other cases it will be the same as original one
+   */
+  decoded: JwtDecodedVerifiablePresentation | IVerifiablePresentation
+  /**
+   * Type of this Presentation. Supported types are json-ld and jwt (decoded/encoded)
+   */
+  type: OriginalType
+  /**
+   * The claim format, typically used during exchange transport protocols
+   */
+  format: PresentationFormat
+  /**
+   * Internal stable representation of a Presentation without proofs, created based on https://www.w3.org/TR/vc-data-model/#jwt-decoding
+   */
+  presentation: UniformVerifiablePresentation
+  /**
+   * Wrapped Verifiable Credentials belonging to the Presentation
+   */
   vcs: WrappedVerifiableCredential[]
 }
 
-export enum VerifiableDataExchangeType {
-  JSONLD,
-  JWT_ENCODED,
-  JWT_DECODED,
+export enum OriginalType {
+  JSONLD = 'json-ld',
+  JWT_ENCODED = 'jwt-encoded',
+  JWT_DECODED = 'jwt-decoded',
 }
 
-export interface InternalPresentation {
+export interface UniformVerifiablePresentation {
   '@context': ICredentialContextType | ICredentialContextType[]
   type: string[]
   verifiableCredential: WrappedVerifiableCredential[]
@@ -126,20 +172,32 @@ export interface InternalPresentation {
   holder?: string
 }
 
-export interface JwtWrappedVerifiableCredential {
+export interface JwtDecodedVerifiableCredential {
   vc: ICredential
   exp: string
   iss: string
   nbf: string
   sub: string
   jti: string
+
+  [x: string]: any
 }
 
-export interface JwtWrappedVerifiablePresentation {
+export interface JwtDecodedVerifiablePresentation {
   vp: IVerifiablePresentation
   exp: string
   iss: string
   nbf: string
   sub: string
   jti: string
+
+  [x: string]: any
 }
+
+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 = W3CVerifiableCredential | JwtDecodedVerifiableCredential
+export type OriginalVerifiablePresentation = W3CVerifiablePresentation | JwtDecodedVerifiablePresentation
+export type Original = OriginalVerifiablePresentation | OriginalVerifiableCredential

package/src/utils/index.ts

@@ -0,0 +1 @@
+export * from './object'

package/src/utils/object.ts

@@ -0,0 +1,19 @@
+export class ObjectUtils {
+  public static asArray(value: unknown) {
+    return Array.isArray(value) ? value : [value]
+  }
+
+  public static isObject(value: unknown) {
+    return Object.prototype.toString.call(value) === '[object Object]'
+  }
+
+  public static isUrlAbsolute(url: string) {
+    // regex to check for absolute IRI (starting scheme and ':') or blank node IRI
+    const isAbsoluteRegex = /^([A-Za-z][A-Za-z0-9+-.]*|_):[^\s]*$/
+    ObjectUtils.isString(url) && isAbsoluteRegex.test(url)
+  }
+
+  public static isString(value: unknown): boolean {
+    return typeof value === 'string' || Object.prototype.toString.call(value) === '[object String]'
+  }
+}