@sphereon/ssi-sdk.data-store 0.18.2-unstable.7 → 0.18.2-unstable.85

package/src/migrations/sqlite/1708525189002-CreateDigitalCredential.ts

@@ -0,0 +1,34 @@
+import { MigrationInterface, QueryRunner } from 'typeorm'
+
+export class CreateDigitalCredential1708525189002 implements MigrationInterface {
+  name = 'CreateDigitalCredential1708525189002'
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`
+            CREATE TABLE "DigitalCredential" (
+                "id" varchar PRIMARY KEY NOT NULL,
+                "credential_type" varchar CHECK( "credential_type" IN ('VC', 'VP', 'C', 'P') ) NOT NULL,
+                "document_format" varchar CHECK( "document_format" IN ('JSON_LD', 'JWT', 'SD_JWT', 'MDOC') ) NOT NULL,
+                "raw" text NOT NULL,
+                "uniform_document" text NOT NULL,
+                "hash" text NOT NULL UNIQUE,
+                "issuer_correlation_type" varchar CHECK( "issuer_correlation_type" IN ('DID') ) NOT NULL,
+                "subject_correlation_type" varchar CHECK( "subject_correlation_type" IN ('DID') ),
+                "issuer_correlation_id" text NOT NULL,
+                "subject_correlation_id" text,
+                "verified_state" varchar CHECK( "verified_state" IN ('REVOKED', 'VERIFIED', 'EXPIRED') ),
+                "tenant_id" text,
+                "created_at" datetime NOT NULL DEFAULT (datetime('now')),
+                "last_updated_at" datetime NOT NULL DEFAULT (datetime('now')),
+                "issued_at" datetime,
+                "expires_at" datetime,
+                "verification_date" datetime,
+                "revocation_date" datetime
+            )
+        `)
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`DROP TABLE "DigitalCredential"`)
+  }
+}

package/src/types/contact/IAbstractContactStore.ts

@@ -1,23 +1,30 @@
 import {
-  NonPersistedPartyType,
+  ElectronicAddress,
+  Identity,
   NonPersistedContact,
+  NonPersistedElectronicAddress,
   NonPersistedIdentity,
-  Party,
-  Identity,
-  PartialParty,
+  NonPersistedPartyType,
+  NonPersistedPhysicalAddress,
+  PartialElectronicAddress,
   PartialIdentity,
-  PartyTypeEnum,
-  PartyType,
-  PartyRelationship,
+  PartialParty,
   PartialPartyRelationship,
   PartialPartyType,
-  NonPersistedElectronicAddress,
+  PartialPhysicalAddress,
+  Party,
+  PartyRelationship,
+  PartyType,
+  PartyTypeEnum,
+  PhysicalAddress,
 } from './contact'
 
 export type FindPartyArgs = Array<PartialParty>
 export type FindIdentityArgs = Array<PartialIdentity>
 export type FindPartyTypeArgs = Array<PartialPartyType>
 export type FindRelationshipArgs = Array<PartialPartyRelationship>
+export type FindElectronicAddressArgs = Array<PartialElectronicAddress>
+export type FindPhysicalAddressArgs = Array<PartialPhysicalAddress>
 
 export type GetPartyArgs = {
   partyId: string
@@ -33,6 +40,7 @@ export type AddPartyArgs = {
   contact: NonPersistedContact
   identities?: Array<NonPersistedIdentity>
   electronicAddresses?: Array<NonPersistedElectronicAddress>
+  physicalAddresses?: Array<NonPersistedPhysicalAddress>
 }
 
 export type UpdatePartyArgs = {
@@ -107,3 +115,45 @@ export type UpdatePartyTypeArgs = {
 export type RemovePartyTypeArgs = {
   partyTypeId: string
 }
+
+export type GetElectronicAddressArgs = {
+  electronicAddressId: string
+}
+
+export type GetElectronicAddressesArgs = {
+  filter?: FindElectronicAddressArgs
+}
+
+export type AddElectronicAddressArgs = {
+  partyId: string
+  electronicAddress: NonPersistedElectronicAddress
+}
+
+export type UpdateElectronicAddressArgs = {
+  electronicAddress: ElectronicAddress
+}
+
+export type RemoveElectronicAddressArgs = {
+  electronicAddressId: string
+}
+
+export type GetPhysicalAddressArgs = {
+  physicalAddressId: string
+}
+
+export type GetPhysicalAddressesArgs = {
+  filter?: FindPhysicalAddressArgs
+}
+
+export type AddPhysicalAddressArgs = {
+  partyId: string
+  physicalAddress: NonPersistedPhysicalAddress
+}
+
+export type UpdatePhysicalAddressArgs = {
+  physicalAddress: PhysicalAddress
+}
+
+export type RemovePhysicalAddressArgs = {
+  physicalAddressId: string
+}

package/src/types/contact/contact.ts

@@ -6,6 +6,7 @@ export type Party = {
   roles: Array<IdentityRoleEnum>
   identities: Array<Identity>
   electronicAddresses: Array<ElectronicAddress>
+  physicalAddresses: Array<PhysicalAddress>
   contact: Contact
   partyType: PartyType
   relationships: Array<PartyRelationship>
@@ -14,17 +15,19 @@ export type Party = {
 }
 export type NonPersistedParty = Omit<
   Party,
-  'id' | 'identities' | 'electronicAddresses' | 'contact' | 'roles' | 'partyType' | 'relationships' | 'createdAt' | 'lastUpdatedAt'
+  'id' | 'identities' | 'electronicAddresses' | 'physicalAddresses' | 'contact' | 'roles' | 'partyType' | 'relationships' | 'createdAt' | 'lastUpdatedAt'
 > & {
   identities?: Array<NonPersistedIdentity>
   electronicAddresses?: Array<NonPersistedElectronicAddress>
+  physicalAddresses?: Array<NonPersistedPhysicalAddress>
   contact: NonPersistedContact
   partyType: NonPersistedPartyType
   relationships?: Array<NonPersistedPartyRelationship>
 }
-export type PartialParty = Partial<Omit<Party, 'identities' | 'electronicAddresses' | 'contact' | 'partyType' | 'relationships'>> & {
+export type PartialParty = Partial<Omit<Party, 'identities' | 'electronicAddresses' | 'physicalAddresses' | 'contact' | 'partyType' | 'relationships'>> & {
   identities?: PartialIdentity
   electronicAddresses?: PartialElectronicAddress
+  physicalAddresses?: PartialPhysicalAddress
   contact?: PartialContact
   partyType?: PartialPartyType
   relationships?: PartialPartyRelationship
@@ -168,9 +171,31 @@ export type ElectronicAddress = {
   lastUpdatedAt: Date
 }
 export type NonPersistedElectronicAddress = Omit<ElectronicAddress, 'id' | 'createdAt' | 'lastUpdatedAt'>
-export type PartialElectronicAddress = Partial<ElectronicAddress>
+export type PartialElectronicAddress = Partial<ElectronicAddress> & {
+  partyId?: string
+}
+
+export type PhysicalAddress = {
+  id: string
+  type: PhysicalAddressType
+  streetName: string
+  streetNumber: string
+  postalCode: string
+  cityName: string
+  provinceName: string
+  countryCode: string
+  buildingName?: string
+  createdAt: Date
+  lastUpdatedAt: Date
+}
+export type NonPersistedPhysicalAddress = Omit<PhysicalAddress, 'id' | 'createdAt' | 'lastUpdatedAt'>
+export type PartialPhysicalAddress = Partial<PhysicalAddress> & {
+  partyId?: string
+}
+
+export type ElectronicAddressType = 'email' | 'phone'
 
-export type ElectronicAddressType = 'email'
+export type PhysicalAddressType = 'home' | 'visit' | 'postal'
 
 export enum IdentityRoleEnum {
   ISSUER = 'issuer',

package/src/types/digitalCredential/IAbstractDigitalCredentialStore.ts

@@ -0,0 +1,26 @@
+import { CredentialCorrelationType, CredentialStateType, DigitalCredential } from './digitalCredential'
+
+export type GetDigitalCredentialArgs = { id: string } | { hash: string }
+
+export type FindDigitalCredentialArgs = Array<Partial<DigitalCredential>>
+
+// TODO: discuss about what args we want here
+export type GetDigitalCredentialsArgs = {
+  filter?: FindDigitalCredentialArgs
+}
+
+export type AddDigitalCredentialArgs = {
+  raw: string
+  issuerCorrelationType: CredentialCorrelationType
+  subjectCorrelationType?: CredentialCorrelationType
+  issuerCorrelationId: string
+  subjectCorrelationId?: string
+  tenantId?: string
+  state?: CredentialStateType
+  verificationDate?: Date
+  revocationDate?: Date
+}
+
+export type UpdateDigitalCredentialStateArgs = GetDigitalCredentialArgs & { verifiedState: CredentialStateType; verificationDate?: Date }
+
+export type RemoveDigitalCredentialArgs = GetDigitalCredentialArgs

package/src/types/digitalCredential/digitalCredential.ts

@@ -0,0 +1,45 @@
+export type NonPersistedDigitalCredential = Omit<DigitalCredential, 'id'>
+
+export type DigitalCredential = {
+  id: string
+  credentialType: CredentialType
+  documentFormat: CredentialDocumentFormat
+  raw: string
+  hash: string
+  issuerCorrelationType: CredentialCorrelationType
+  subjectCorrelationType?: CredentialCorrelationType
+  issuerCorrelationId: string
+  subjectCorrelationId?: string
+  uniformDocument: string
+  verificationDate?: Date
+  verifiedState?: CredentialStateType
+  tenantId?: string
+  createdAt: Date
+  lastUpdatedAt: Date
+  issuedAt?: Date
+  expiresAt?: Date
+}
+
+export enum CredentialType {
+  VC = 'VC',
+  VP = 'VP',
+  P = 'P',
+  C = 'C',
+}
+
+export enum CredentialDocumentFormat {
+  JSON_LD = 'JSON_LD',
+  JWT = 'JWT',
+  SD_JWT = 'SD_JWT',
+  MDOC = 'MDOC',
+}
+
+export enum CredentialCorrelationType {
+  DID = 'DID',
+}
+
+export enum CredentialStateType {
+  REVOKED = 'REVOKED',
+  VERIFIED = 'VERIFIED',
+  EXPIRED = 'EXPIRED',
+}

package/src/types/eventLogger/IAbstractEventLoggerStore.ts

@@ -1,12 +1,12 @@
-import { PartialAuditLoggingEvent } from '@sphereon/ssi-sdk.core'
-import { NonPersistedAuditLoggingEvent } from './eventLogger'
-
-export type FindAuditLoggingEventArgs = Array<PartialAuditLoggingEvent>
-
-export type StoreAuditEventArgs = {
-  event: NonPersistedAuditLoggingEvent
-}
-
-export type GetAuditEventsArgs = {
-  filter?: FindAuditLoggingEventArgs
-}
+import { PartialAuditLoggingEvent } from '@sphereon/ssi-sdk.core'
+import { NonPersistedAuditLoggingEvent } from './eventLogger'
+
+export type FindAuditLoggingEventArgs = Array<PartialAuditLoggingEvent>
+
+export type StoreAuditEventArgs = {
+  event: NonPersistedAuditLoggingEvent
+}
+
+export type GetAuditEventsArgs = {
+  filter?: FindAuditLoggingEventArgs
+}

package/src/types/eventLogger/eventLogger.ts

@@ -1,3 +1,3 @@
-import { AuditLoggingEvent } from '@sphereon/ssi-sdk.core'
-
-export type NonPersistedAuditLoggingEvent = Omit<AuditLoggingEvent, 'id'>
+import { AuditLoggingEvent } from '@sphereon/ssi-sdk.core'
+
+export type NonPersistedAuditLoggingEvent = Omit<AuditLoggingEvent, 'id'>

package/src/types/index.ts

@@ -1,9 +1,9 @@
-export * from './issuanceBranding/issuanceBranding'
-export * from './issuanceBranding/IAbstractIssuanceBrandingStore'
-export * from './contact/contact'
-export * from './contact/IAbstractContactStore'
-export * from './validation/validation'
-export * from './statusList/statusList'
-export * from './statusList/IAbstractStatusListStore'
-export * from './eventLogger/IAbstractEventLoggerStore'
-export * from './eventLogger/eventLogger'
+export * from './issuanceBranding/issuanceBranding'
+export * from './issuanceBranding/IAbstractIssuanceBrandingStore'
+export * from './contact/contact'
+export * from './contact/IAbstractContactStore'
+export * from './validation/validation'
+export * from './statusList/statusList'
+export * from './statusList/IAbstractStatusListStore'
+export * from './eventLogger/IAbstractEventLoggerStore'
+export * from './eventLogger/eventLogger'

package/src/utils/contact/MappingUtils.ts

@@ -22,11 +22,12 @@ import {
   NonPersistedParty,
   NonPersistedPartyRelationship,
   NonPersistedPartyType,
+  NonPersistedPhysicalAddress,
   OpenIdConfig,
   Organization,
   Party,
   PartyRelationship,
-  PartyType,
+  PartyType, PhysicalAddress
 } from '../../types'
 import { PartyEntity } from '../../entities/contact/PartyEntity'
 import { IdentityEntity } from '../../entities/contact/IdentityEntity'
@@ -42,6 +43,7 @@ import { DidAuthConfigEntity } from '../../entities/contact/DidAuthConfigEntity'
 import { IdentityMetadataItemEntity } from '../../entities/contact/IdentityMetadataItemEntity'
 import { OpenIdConfigEntity } from '../../entities/contact/OpenIdConfigEntity'
 import { PartyTypeEntity } from '../../entities/contact/PartyTypeEntity'
+import { PhysicalAddressEntity } from '../../entities/contact/PhysicalAddressEntity'
 
 export const partyEntityFrom = (party: NonPersistedParty): PartyEntity => {
   const partyEntity: PartyEntity = new PartyEntity()
@@ -50,6 +52,9 @@ export const partyEntityFrom = (party: NonPersistedParty): PartyEntity => {
   partyEntity.electronicAddresses = party.electronicAddresses
     ? party.electronicAddresses.map((electronicAddress: NonPersistedElectronicAddress) => electronicAddressEntityFrom(electronicAddress))
     : []
+  partyEntity.physicalAddresses = party.physicalAddresses
+    ? party.physicalAddresses.map((physicalAddress: NonPersistedPhysicalAddress) => physicalAddressEntityFrom(physicalAddress))
+    : []
   partyEntity.partyType = partyTypeEntityFrom(party.partyType)
   partyEntity.contact = contactEntityFrom(party.contact)
 
@@ -65,6 +70,9 @@ export const partyFrom = (party: PartyEntity): Party => {
     electronicAddresses: party.electronicAddresses
       ? party.electronicAddresses.map((electronicAddress: ElectronicAddressEntity) => electronicAddressFrom(electronicAddress))
       : [],
+    physicalAddresses: party.physicalAddresses
+      ? party.physicalAddresses.map((physicalAddress: PhysicalAddressEntity) => physicalAddressFrom(physicalAddress))
+      : [],
     relationships: party.relationships ? party.relationships.map((relationship: PartyRelationshipEntity) => partyRelationshipFrom(relationship)) : [],
     partyType: partyTypeFrom(party.partyType),
     contact: contactFrom(party.contact),
@@ -168,6 +176,36 @@ export const electronicAddressFrom = (electronicAddress: ElectronicAddressEntity
   }
 }
 
+export const physicalAddressEntityFrom = (physicalAddress: NonPersistedPhysicalAddress): PhysicalAddressEntity => {
+  const physicalAddressEntity: PhysicalAddressEntity = new PhysicalAddressEntity()
+  physicalAddressEntity.type = physicalAddress.type
+  physicalAddressEntity.streetName = physicalAddress.streetName
+  physicalAddressEntity.streetNumber = physicalAddress.streetNumber
+  physicalAddressEntity.postalCode = physicalAddress.postalCode
+  physicalAddressEntity.cityName = physicalAddress.cityName
+  physicalAddressEntity.provinceName = physicalAddress.provinceName
+  physicalAddressEntity.countryCode = physicalAddress.countryCode
+  physicalAddressEntity.buildingName = physicalAddress.buildingName
+
+  return physicalAddressEntity
+}
+
+export const physicalAddressFrom = (physicalAddress: PhysicalAddressEntity): PhysicalAddress => {
+  return {
+    id: physicalAddress.id,
+    type: physicalAddress.type,
+    streetName: physicalAddress.streetName,
+    streetNumber: physicalAddress.streetNumber,
+    postalCode: physicalAddress.postalCode,
+    cityName: physicalAddress.cityName,
+    provinceName: physicalAddress.provinceName,
+    countryCode: physicalAddress.countryCode,
+    buildingName: physicalAddress.buildingName,
+    createdAt: physicalAddress.createdAt,
+    lastUpdatedAt: physicalAddress.lastUpdatedAt,
+  }
+}
+
 export const identityEntityFrom = (args: NonPersistedIdentity): IdentityEntity => {
   const identityEntity: IdentityEntity = new IdentityEntity()
   identityEntity.alias = args.alias

package/src/utils/digitalCredential/MappingUtils.ts

@@ -0,0 +1,112 @@
+import { AddDigitalCredentialArgs } from '../../types/digitalCredential/IAbstractDigitalCredentialStore'
+import { DigitalCredentialEntity } from '../../entities/digitalCredential/DigitalCredentialEntity'
+import {
+  CredentialMapper,
+  decodeSdJwtVc,
+  DocumentFormat,
+  IVerifiableCredential,
+  IVerifiablePresentation,
+  SdJwtDecodedVerifiableCredentialPayload,
+} from '@sphereon/ssi-types'
+import {
+  CredentialDocumentFormat,
+  CredentialType,
+  DigitalCredential,
+  NonPersistedDigitalCredential,
+} from '../../types/digitalCredential/digitalCredential'
+import { computeEntryHash } from '@veramo/utils'
+import { createHash } from 'crypto'
+
+function determineCredentialType(raw: string): CredentialType {
+  if (CredentialMapper.hasProof(raw)) {
+    if (CredentialMapper.isCredential(raw)) {
+      return CredentialType.VC
+    } else if (CredentialMapper.isPresentation(raw)) {
+      return CredentialType.VP
+    }
+  } else {
+    if (CredentialMapper.isCredential(raw)) {
+      return CredentialType.C
+    } else if (CredentialMapper.isPresentation(raw)) {
+      return CredentialType.P
+    }
+  }
+  throw new Error(`Couldn't determine the type of the credential: ${raw}`)
+}
+
+function determineCredentialDocumentFormat(documentFormat: DocumentFormat): CredentialDocumentFormat {
+  switch (documentFormat) {
+    case DocumentFormat.JSONLD:
+      return CredentialDocumentFormat.JSON_LD
+    case DocumentFormat.JWT:
+      return CredentialDocumentFormat.JWT
+    case DocumentFormat.SD_JWT_VC:
+      return CredentialDocumentFormat.SD_JWT
+    default:
+      throw new Error(`Not supported document format: ${documentFormat}`)
+  }
+}
+
+function getExpiresAt(uniformDocument: IVerifiableCredential | IVerifiablePresentation | SdJwtDecodedVerifiableCredentialPayload): Date | undefined {
+  if ('expirationDate' in uniformDocument) {
+    return new Date(uniformDocument.expirationDate)
+  } else if ('exp' in uniformDocument) {
+    return new Date(uniformDocument.exp)
+  }
+  return undefined
+}
+
+function getIssuedAt(uniformDocument: IVerifiableCredential | IVerifiablePresentation | SdJwtDecodedVerifiableCredentialPayload): Date | undefined {
+  if ('issuanceDate' in uniformDocument) {
+    return new Date(uniformDocument.issuanceDate)
+  } else if (uniformDocument.proof && CredentialMapper.getFirstProof(uniformDocument as IVerifiableCredential | IVerifiablePresentation)) {
+    return new Date(CredentialMapper.getFirstProof(uniformDocument as IVerifiableCredential | IVerifiablePresentation)!.created)
+  } else if ('validFrom' in uniformDocument) {
+    return new Date(uniformDocument['validFrom'])
+  } else if ('iat' in uniformDocument) {
+    return new Date(uniformDocument['iat'] * 1000)
+  }
+
+  return undefined
+}
+
+export const handleSdJwt = (rawCredential: string): SdJwtDecodedVerifiableCredentialPayload => {
+  // todo ask about the hasher
+  return CredentialMapper.isSdJwtEncoded(rawCredential)
+    ? decodeSdJwtVc(rawCredential, (data, algorithm) => createHash(algorithm).update(data).digest()).decodedPayload
+    : JSON.parse(rawCredential)
+}
+
+export const nonPersistedDigitalCredentialEntityFromAddArgs = (addCredentialArgs: AddDigitalCredentialArgs): NonPersistedDigitalCredential => {
+  const credentialType: CredentialType = determineCredentialType(addCredentialArgs.raw)
+  const documentFormat: DocumentFormat = CredentialMapper.detectDocumentType(addCredentialArgs.raw)
+  const uniformDocument =
+    documentFormat === DocumentFormat.SD_JWT_VC
+      ? handleSdJwt(addCredentialArgs.raw)
+      : credentialType === CredentialType.VC || credentialType === CredentialType.C
+      ? CredentialMapper.toUniformCredential(addCredentialArgs.raw)
+      : CredentialMapper.toUniformPresentation(addCredentialArgs.raw)
+  const issuedAt: Date | undefined = getIssuedAt(uniformDocument)
+  const expiresAt: Date | undefined = getExpiresAt(uniformDocument)
+  return {
+    ...addCredentialArgs,
+    credentialType,
+    documentFormat: determineCredentialDocumentFormat(documentFormat),
+    createdAt: new Date(),
+    hash: computeEntryHash(addCredentialArgs.raw),
+    uniformDocument: JSON.stringify(uniformDocument),
+    issuedAt,
+    expiresAt,
+    lastUpdatedAt: new Date(),
+  }
+}
+
+export const digitalCredentialFrom = (credentialEntity: DigitalCredentialEntity): DigitalCredential => {
+  return {
+    ...credentialEntity,
+  }
+}
+
+export const digitalCredentialsFrom = (credentialEntities: Array<DigitalCredentialEntity>): DigitalCredential[] => {
+  return credentialEntities.map((credentialEntity) => digitalCredentialFrom(credentialEntity))
+}

package/dist/entities/contact/ContactEntity.d.ts

@@ -1,16 +0,0 @@
-import { BaseEntity } from 'typeorm'
-import { IBasicContact } from '../../types'
-import { IdentityEntity } from './IdentityEntity'
-export declare class ContactEntity extends BaseEntity {
-  id: string
-  name: string
-  alias: string
-  uri?: string
-  identities: Array<IdentityEntity>
-  createdAt: Date
-  lastUpdatedAt: Date
-  updateUpdatedDate(): void
-  validate(): Promise<undefined>
-}
-export declare const contactEntityFrom: (args: IBasicContact) => ContactEntity
-//# sourceMappingURL=ContactEntity.d.ts.map

package/dist/entities/contact/ContactEntity.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ContactEntity.d.ts","sourceRoot":"","sources":["../../../src/entities/contact/ContactEntity.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EAUX,MAAM,SAAS,CAAA;AAChB,OAAO,EAAE,aAAa,EAAkB,MAAM,aAAa,CAAA;AAC3D,OAAO,EAAE,cAAc,EAAsB,MAAM,kBAAkB,CAAA;AAGrE,qBACa,aAAc,SAAQ,UAAU;IAE3C,EAAE,EAAG,MAAM,CAAA;IAIX,IAAI,EAAG,MAAM,CAAA;IAIb,KAAK,EAAG,MAAM,CAAA;IAGd,GAAG,CAAC,EAAE,MAAM,CAAA;IASZ,UAAU,EAAG,KAAK,CAAC,cAAc,CAAC,CAAA;IAGlC,SAAS,EAAG,IAAI,CAAA;IAGhB,aAAa,EAAG,IAAI,CAAA;IAKpB,iBAAiB;IAMX,QAAQ;CAOf;AAED,eAAO,MAAM,iBAAiB,SAAU,aAAa,KAAG,aAQvD,CAAA"}