@sphereon/ssi-sdk.data-store 0.28.1-next.5 → 0.28.1-next.50

package/src/entities/digitalCredential/DigitalCredentialEntity.ts

@@ -5,6 +5,7 @@ import {
   CredentialStateType,
   DocumentType,
 } from '../../types/digitalCredential/digitalCredential'
+import { CredentialRole } from '../../types'
 
 @Entity('DigitalCredential')
 export class DigitalCredentialEntity extends BaseEntity {
@@ -17,12 +18,18 @@ export class DigitalCredentialEntity extends BaseEntity {
   @Column('simple-enum', { name: 'document_format', enum: CredentialDocumentFormat, nullable: false })
   documentFormat!: CredentialDocumentFormat
 
+  @Column('simple-enum', { name: 'credential_role', enum: CredentialRole, nullable: false })
+  credentialRole!: CredentialRole
+
   @Column('text', { name: 'raw_document', nullable: false })
   rawDocument!: string
 
   @Column('text', { name: 'uniform_document', nullable: false })
   uniformDocument!: string
 
+  @Column('text', { name: 'credential_id', nullable: true, unique: false })
+  credentialId!: string
+
   @Column('text', { name: 'hash', nullable: false, unique: true })
   hash!: string
 

package/src/entities/eventLogger/AuditEventEntity.ts

@@ -14,7 +14,7 @@ export class AuditEventEntity extends BaseEntity {
   @Column('simple-enum', { name: 'level', enum: LogLevel, nullable: false, unique: false })
   level!: LogLevel
 
-  @Column({ name: 'correlationId', nullable: false, unique: false })
+  @Column('text', { name: 'correlationId', nullable: false, unique: false })
   correlationId!: string
 
   @Column('simple-enum', { name: 'system', enum: System, nullable: false, unique: false })
@@ -26,7 +26,7 @@ export class AuditEventEntity extends BaseEntity {
   @Column('simple-enum', { name: 'actionType', enum: ActionType, nullable: false, unique: false })
   actionType!: ActionType
 
-  @Column({ name: 'actionSubType', nullable: false, unique: false })
+  @Column({ name: 'actionSubType', type: 'varchar', nullable: false, unique: false })
   actionSubType!: ActionSubType
 
   @Column('simple-enum', { name: 'initiatorType', enum: InitiatorType, nullable: false, unique: false })
@@ -35,28 +35,28 @@ export class AuditEventEntity extends BaseEntity {
   @Column('simple-enum', { name: 'systemCorrelationIdType', enum: SystemCorrelationIdType, nullable: true, unique: false })
   systemCorrelationIdType?: SystemCorrelationIdType
 
-  @Column({ name: 'systemCorrelationId', nullable: true, unique: false })
+  @Column('text', { name: 'systemCorrelationId', nullable: true, unique: false })
   systemCorrelationId?: string
 
-  @Column({ name: 'systemAlias', nullable: true, unique: false })
+  @Column('text', { name: 'systemAlias', nullable: true, unique: false })
   systemAlias?: string
 
   @Column('simple-enum', { name: 'partyCorrelationType', enum: PartyCorrelationType, nullable: true, unique: false })
   partyCorrelationType?: PartyCorrelationType
 
-  @Column({ name: 'partyCorrelationId', nullable: true, unique: false })
+  @Column('text', { name: 'partyCorrelationId', nullable: true, unique: false })
   partyCorrelationId?: string
 
-  @Column({ name: 'partyAlias', nullable: true, unique: false })
+  @Column('text', { name: 'partyAlias', nullable: true, unique: false })
   partyAlias?: string
 
-  @Column({ name: 'description', nullable: false, unique: false })
+  @Column('text', { name: 'description', nullable: false, unique: false })
   description!: string
 
-  @Column({ name: 'data', nullable: true, unique: false })
+  @Column('text', { name: 'data', nullable: true, unique: false })
   data?: string
 
-  @Column({ name: 'diagnosticData', nullable: true, unique: false })
+  @Column('text', { name: 'diagnosticData', nullable: true, unique: false })
   diagnosticData?: string
 
   @CreateDateColumn({ name: 'created_at', nullable: false })

package/src/entities/issuanceBranding/BackgroundAttributesEntity.ts

@@ -9,7 +9,7 @@ export class BackgroundAttributesEntity extends BaseEntity {
   @PrimaryGeneratedColumn('uuid')
   id!: string
 
-  @Column({ name: 'color', length: 255, nullable: true, unique: false })
+  @Column('varchar', { name: 'color', length: 255, nullable: true, unique: false })
   @Validate(IsNonEmptyStringConstraint, { message: 'Blank background colors are not allowed' })
   color?: string
 

package/src/entities/issuanceBranding/BaseLocaleBrandingEntity.ts

@@ -23,11 +23,11 @@ export class BaseLocaleBrandingEntity extends BaseEntity {
   @PrimaryGeneratedColumn('uuid')
   id!: string
 
-  @Column({ name: 'alias', length: 255, nullable: true, unique: false })
+  @Column('varchar', { name: 'alias', length: 255, nullable: true, unique: false })
   @Validate(IsNonEmptyStringConstraint, { message: 'Blank aliases are not allowed' })
   alias?: string
 
-  @Column({ name: 'locale', length: 255, nullable: false, unique: false })
+  @Column('varchar', { name: 'locale', length: 255, nullable: false, unique: false })
   locale?: string
 
   @OneToOne(() => ImageAttributesEntity, {
@@ -39,7 +39,7 @@ export class BaseLocaleBrandingEntity extends BaseEntity {
   @JoinColumn({ name: 'logoId' })
   logo?: ImageAttributesEntity
 
-  @Column({ name: 'description', length: 255, nullable: true, unique: false })
+  @Column('varchar', { name: 'description', length: 255, nullable: true, unique: false })
   @Validate(IsNonEmptyStringConstraint, { message: 'Blank descriptions are not allowed' })
   description?: string
 

package/src/entities/issuanceBranding/CredentialBrandingEntity.ts

@@ -21,11 +21,11 @@ export class CredentialBrandingEntity extends BaseEntity {
   @PrimaryGeneratedColumn('uuid')
   id!: string
 
-  @Column({ name: 'vcHash', length: 255, nullable: false, unique: true })
+  @Column('varchar', { name: 'vcHash', length: 255, nullable: false, unique: true })
   @IsNotEmpty({ message: 'Blank vcHashes are not allowed' })
   vcHash!: string
 
-  @Column({ name: 'issuerCorrelationId', length: 255, nullable: false, unique: false })
+  @Column('varchar', { name: 'issuerCorrelationId', length: 255, nullable: false, unique: false })
   @IsNotEmpty({ message: 'Blank issuerCorrelationIds are not allowed' })
   issuerCorrelationId!: string
 

package/src/entities/issuanceBranding/CredentialLocaleBrandingEntity.ts

@@ -16,7 +16,7 @@ export class CredentialLocaleBrandingEntity extends BaseLocaleBrandingEntity {
   @JoinColumn({ name: 'credentialBrandingId' })
   credentialBranding!: CredentialBrandingEntity
 
-  @Column({ name: 'credentialBrandingId', nullable: false })
+  @Column('text', { name: 'credentialBrandingId', nullable: false })
   credentialBrandingId!: string
 }
 

package/src/entities/issuanceBranding/ImageAttributesEntity.ts

@@ -9,19 +9,19 @@ export class ImageAttributesEntity extends BaseEntity {
   @PrimaryGeneratedColumn('uuid')
   id!: string
 
-  @Column({ name: 'uri', nullable: true, unique: false })
+  @Column('text', { name: 'uri', nullable: true, unique: false })
   @Validate(IsNonEmptyStringConstraint, { message: 'Blank image uri are not allowed' })
   uri?: string
 
-  @Column({ name: 'dataUri', nullable: true, unique: false })
+  @Column('text', { name: 'dataUri', nullable: true, unique: false })
   @Validate(IsNonEmptyStringConstraint, { message: 'Blank image data uri are not allowed' })
   dataUri?: string
 
-  @Column({ name: 'mediaType', length: 255, nullable: true, unique: false })
+  @Column('varchar', { name: 'mediaType', length: 255, nullable: true, unique: false })
   @Validate(IsNonEmptyStringConstraint, { message: 'Blank image types are not allowed' })
   mediaType?: string
 
-  @Column({ name: 'alt', length: 255, nullable: true, unique: false })
+  @Column('varchar', { name: 'alt', length: 255, nullable: true, unique: false })
   @Validate(IsNonEmptyStringConstraint, { message: 'Blank image alts are not allowed' })
   alt?: string
 

package/src/entities/issuanceBranding/ImageDimensionsEntity.ts

@@ -6,10 +6,10 @@ export class ImageDimensionsEntity extends BaseEntity {
   @PrimaryGeneratedColumn('uuid')
   id!: string
 
-  @Column({ name: 'width', nullable: false, unique: false })
+  @Column('integer', { name: 'width', nullable: false, unique: false })
   width!: number
 
-  @Column({ name: 'height', nullable: false, unique: false })
+  @Column('integer', { name: 'height', nullable: false, unique: false })
   height!: number
 }
 

package/src/entities/issuanceBranding/IssuerBrandingEntity.ts

@@ -20,7 +20,7 @@ export class IssuerBrandingEntity extends BaseEntity {
   @PrimaryGeneratedColumn('uuid')
   id!: string
 
-  @Column({ name: 'issuerCorrelationId', length: 255, nullable: false, unique: true })
+  @Column('varchar', { name: 'issuerCorrelationId', length: 255, nullable: false, unique: true })
   @IsNotEmpty({ message: 'Blank issuerCorrelationIds are not allowed' })
   issuerCorrelationId!: string
 

package/src/entities/issuanceBranding/IssuerLocaleBrandingEntity.ts

@@ -16,7 +16,7 @@ export class IssuerLocaleBrandingEntity extends BaseLocaleBrandingEntity {
   @JoinColumn({ name: 'issuerBrandingId' })
   issuerBranding!: IssuerBrandingEntity
 
-  @Column({ name: 'issuerBrandingId', nullable: false })
+  @Column('text', { name: 'issuerBrandingId', nullable: false })
   issuerBrandingId!: string
 }
 

package/src/entities/issuanceBranding/TextAttributesEntity.ts

@@ -8,7 +8,7 @@ export class TextAttributesEntity extends BaseEntity {
   @PrimaryGeneratedColumn('uuid')
   id!: string
 
-  @Column({ name: 'color', length: 255, nullable: true, unique: false })
+  @Column('varchar', { name: 'color', length: 255, nullable: true, unique: false })
   @Validate(IsNonEmptyStringConstraint, { message: 'Blank text colors are not allowed' })
   color?: string
 

package/src/entities/machineState/MachineStateInfoEntity.ts

@@ -38,19 +38,19 @@ export class MachineStateInfoEntity extends BaseEntity {
   @Column({ name: 'state', type: 'text', nullable: false })
   state!: string
 
-  @CreateDateColumn({ name: 'created_at', type: 'datetime', nullable: false })
+  @CreateDateColumn({ name: 'created_at', nullable: false })
   createdAt!: Date
 
-  @UpdateDateColumn({ name: 'updated_at', type: 'datetime', nullable: false })
+  @UpdateDateColumn({ name: 'updated_at', nullable: false })
   updatedAt!: Date
 
   @Column({ name: 'updated_count', type: 'integer', nullable: false })
   updatedCount!: number
 
-  @Column({ name: 'expires_at', type: 'datetime', nullable: true })
+  @Column({ name: 'expires_at', nullable: true })
   expiresAt?: Date
 
-  @Column({ name: 'completed_at', type: 'datetime', nullable: true })
+  @Column({ name: 'completed_at', nullable: true })
   completedAt?: Date
 
   @Column({ name: 'tenant_id', type: 'varchar', nullable: true })

package/src/entities/presentationDefinition/PresentationDefinitionItemEntity.ts

@@ -7,21 +7,21 @@ export class PresentationDefinitionItemEntity extends BaseEntity {
   @PrimaryGeneratedColumn('uuid')
   id!: string
 
-  @Column({ name: 'definition_id', length: 255, nullable: false, unique: false })
+  @Column({ name: 'definition_id', length: 255, type: 'varchar', nullable: false, unique: false })
   @IsNotEmpty({ message: 'A blank definition id field is not allowed' })
   definitionId!: string
 
-  @Column({ name: 'version', length: 255, nullable: false, unique: false })
+  @Column({ name: 'version', length: 255, type: 'varchar', nullable: false, unique: false })
   @IsNotEmpty({ message: 'A blank version field is not allowed' })
   version!: string
 
-  @Column({ name: 'tenant_id', length: 255, nullable: true, unique: false })
+  @Column({ name: 'tenant_id', length: 255, type: 'varchar', nullable: true, unique: false })
   tenantId?: string
 
-  @Column({ name: 'purpose', length: 255, nullable: true, unique: false })
+  @Column({ name: 'purpose', length: 255, type: 'varchar', nullable: true, unique: false })
   purpose?: string
 
-  @Column({ name: 'name', length: 255, nullable: true, unique: false })
+  @Column({ name: 'name', length: 255, type: 'varchar', nullable: true, unique: false })
   name?: string
 
   @Column({ name: 'definition_payload', type: 'text', nullable: false, unique: false })

package/src/entities/statusList2021/StatusList2021Entity.ts

@@ -21,7 +21,7 @@ export class StatusListEntity extends BaseEntity {
   @Column({ name: 'correlationId', type: 'varchar', nullable: false })
   correlationId!: string
 
-  @Column({ name: 'length', nullable: false, unique: false })
+  @Column({ name: 'length', type: 'integer', nullable: false, unique: false })
   length!: number
 
   @Column({

package/src/entities/statusList2021/StatusList2021EntryEntity.ts

@@ -11,19 +11,19 @@ export class StatusListEntryEntity extends BaseEntity {
   @ManyToOne(() => StatusListEntity, (statusList) => statusList.statusListEntries)
   statusList!: StatusListEntity
 
-  @PrimaryColumn({ name: 'statusListIndex', nullable: false, unique: false })
+  @PrimaryColumn({ name: 'statusListIndex', type: 'integer', nullable: false, unique: false })
   @Validate(IsNonEmptyStringConstraint, { message: 'Status list index is required' })
   statusListIndex!: number
 
-  @Column({ name: 'credentialId', nullable: true })
+  @Column({ name: 'credentialId', type: 'text', nullable: true })
   credentialId?: string
 
-  @Column({ name: 'credentialHash', length: 128, nullable: true, unique: false })
+  @Column({ name: 'credentialHash', length: 128, type: 'varchar', nullable: true, unique: false })
   credentialHash?: string
 
-  @Column({ name: 'correlationId', length: 255, nullable: true, unique: false })
+  @Column({ name: 'correlationId', length: 255, type: 'varchar', nullable: true, unique: false })
   correlationId?: string
 
-  @Column({ name: 'value', length: 50, nullable: true, unique: false })
+  @Column({ name: 'value', length: 50, type: 'varchar', nullable: true, unique: false })
   value?: string
 }

package/src/index.ts

@@ -28,6 +28,8 @@ import { ElectronicAddressEntity } from './entities/contact/ElectronicAddressEnt
 import { PhysicalAddressEntity } from './entities/contact/PhysicalAddressEntity'
 export { ContactStore } from './contact/ContactStore'
 export { AbstractContactStore } from './contact/AbstractContactStore'
+export { AbstractDigitalCredentialStore } from './digitalCredential/AbstractDigitalCredentialStore'
+export { DigitalCredentialStore } from './digitalCredential/DigitalCredentialStore'
 export { AbstractIssuanceBrandingStore } from './issuanceBranding/AbstractIssuanceBrandingStore'
 export { IssuanceBrandingStore } from './issuanceBranding/IssuanceBrandingStore'
 export { StatusListStore } from './statusList/StatusListStore'
@@ -48,6 +50,7 @@ export {
   DataStoreMigrations,
   DataStoreEventLoggerMigrations,
   DataStoreContactMigrations,
+  DataStoreDigitalCredentialMigrations,
   DataStoreIssuanceBrandingMigrations,
   DataStoreStatusListMigrations,
   DataStoreMachineStateMigrations,
@@ -55,6 +58,7 @@ export {
 } from './migrations'
 export * from './types'
 export * from './utils/contact/MappingUtils'
+export * from './utils/digitalCredential/MappingUtils'
 
 export const DataStoreContactEntities = [
   BaseConfigEntity,

package/src/migrations/postgres/1708525189001-CreateDigitalCredential.ts

@@ -6,6 +6,7 @@ export class CreateDigitalCredential1708525189001 implements MigrationInterface
   public async up(queryRunner: QueryRunner): Promise<void> {
     await queryRunner.query(`CREATE TYPE "digital_document_type" AS ENUM('VC', 'VP', 'C', 'P')`)
     await queryRunner.query(`CREATE TYPE "digital_credential_document_format" AS ENUM('JSON_LD', 'JWT', 'SD_JWT', 'MDOC')`)
+    await queryRunner.query(`CREATE TYPE "digital_credential_credential_role" AS ENUM('ISSUER', 'VERIFIER', 'HOLDER')`)
     await queryRunner.query(`CREATE TYPE "digital_credential_correlation_type" AS ENUM('DID')`)
     await queryRunner.query(`CREATE TYPE "digital_credential_state_type" AS ENUM('REVOKED', 'VERIFIED', 'EXPIRED')`)
 
@@ -14,8 +15,10 @@ export class CreateDigitalCredential1708525189001 implements MigrationInterface
         "id" uuid NOT NULL DEFAULT uuid_generate_v4(),
         "document_type" "digital_document_type" NOT NULL,
         "document_format" "digital_credential_document_format" NOT NULL,
+        "credential_role" "digital_credential_credential_role" NOT NULL,
         "raw_document" text NOT NULL,
         "uniform_document" text NOT NULL,
+        "credential_id" text,
         "hash" text NOT NULL UNIQUE,
         "issuer_correlation_type" "digital_credential_correlation_type" NOT NULL,
         "subject_correlation_type" "digital_credential_correlation_type",
@@ -39,6 +42,7 @@ export class CreateDigitalCredential1708525189001 implements MigrationInterface
     await queryRunner.query(`DROP TYPE "digital_credential_state_type"`)
     await queryRunner.query(`DROP TYPE "digital_credential_correlation_type"`)
     await queryRunner.query(`DROP TYPE "digital_credential_document_format"`)
+    await queryRunner.query(`DROP TYPE "digital_credential_credential_role"`)
     await queryRunner.query(`DROP TYPE "digital_document_type"`)
   }
 }

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

@@ -9,8 +9,10 @@ export class CreateDigitalCredential1708525189002 implements MigrationInterface
                 "id" varchar PRIMARY KEY NOT NULL,
                 "document_type" varchar CHECK( "document_type" IN ('VC', 'VP', 'C', 'P') ) NOT NULL,
                 "document_format" varchar CHECK( "document_format" IN ('JSON_LD', 'JWT', 'SD_JWT', 'MDOC') ) NOT NULL,
+                "credential_role" varchar CHECK( "credential_role" IN ('ISSUER', 'VERIFIER', 'HOLDER') ) NOT NULL,
                 "raw_document" text NOT NULL,
                 "uniform_document" text NOT NULL,
+                "credential_id" text,
                 "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') ),

package/src/types/contact/contact.ts

@@ -1,6 +1,7 @@
 import { IIdentifierOpts } from '@sphereon/ssi-sdk-ext.did-utils'
 import { IIdentifier } from '@veramo/core'
 import { ILocaleBranding } from '../issuanceBranding/issuanceBranding'
+import { CredentialRole } from '../digitalCredential/digitalCredential'
 
 export type MetadataTypes = string | number | Date | boolean | undefined
 
@@ -258,12 +259,6 @@ export type ElectronicAddressType = 'email' | 'phone'
 
 export type PhysicalAddressType = 'home' | 'visit' | 'postal'
 
-export enum CredentialRole {
-  ISSUER = 'issuer',
-  VERIFIER = 'verifier',
-  HOLDER = 'holder',
-}
-
 export enum ConnectionType {
   OPENID_CONNECT = 'OIDC',
   SIOPv2 = 'SIOPv2',

package/src/types/digitalCredential/IAbstractDigitalCredentialStore.ts

@@ -1,4 +1,4 @@
-import { CredentialCorrelationType, CredentialStateType, DigitalCredential } from './digitalCredential'
+import { CredentialCorrelationType, CredentialRole, CredentialStateType, DigitalCredential } from './digitalCredential'
 import { Hasher } from '@sphereon/ssi-types'
 import { FindOptionsOrder } from 'typeorm'
 import { DigitalCredentialEntity } from '../../entities/digitalCredential/DigitalCredentialEntity'
@@ -25,6 +25,7 @@ export type AddCredentialArgs = {
   subjectCorrelationType?: CredentialCorrelationType
   issuerCorrelationId: string
   subjectCorrelationId?: string
+  credentialRole: CredentialRole
   tenantId?: string
   state?: CredentialStateType
   verifiedAt?: Date

package/src/types/digitalCredential/digitalCredential.ts

@@ -4,8 +4,10 @@ export type DigitalCredential = {
   id: string
   documentType: DocumentType
   documentFormat: CredentialDocumentFormat
+  credentialRole: CredentialRole
   rawDocument: string
   uniformDocument: string
+  credentialId?: string
   hash: string
   issuerCorrelationType: CredentialCorrelationType
   subjectCorrelationType?: CredentialCorrelationType
@@ -39,6 +41,12 @@ export enum CredentialCorrelationType {
   DID = 'DID',
 }
 
+export enum CredentialRole {
+  ISSUER = 'ISSUER',
+  VERIFIER = 'VERIFIER',
+  HOLDER = 'HOLDER',
+}
+
 export enum CredentialStateType {
   REVOKED = 'REVOKED',
   VERIFIED = 'VERIFIED',

package/src/types/index.ts

@@ -10,3 +10,5 @@ export * from './statusList/IAbstractStatusListStore'
 export * from './eventLogger/IAbstractEventLoggerStore'
 export * from './eventLogger/eventLogger'
 export * from './machineState/IAbstractMachineStateStore'
+export * from './digitalCredential/digitalCredential'
+export * from './digitalCredential/IAbstractDigitalCredentialStore'

package/src/utils/digitalCredential/MappingUtils.ts

@@ -103,6 +103,7 @@ export const nonPersistedDigitalCredentialEntityFromAddArgs = (addCredentialArgs
     documentType,
     documentFormat: determineCredentialDocumentFormat(documentFormat),
     createdAt: new Date(),
+    credentialId: uniformDocument.id as string | undefined, // uniformDocument.id is being inferred as JsonValue somehow
     hash: computeEntryHash(addCredentialArgs.rawDocument),
     uniformDocument: JSON.stringify(uniformDocument),
     validFrom,