@sphereon/ssi-sdk.data-store 0.30.2-unstable.19 → 0.30.2-unstable.21

package/src/eventLogger/EventLoggerStore.ts

@@ -1,10 +1,11 @@
 import Debug, { Debugger } from 'debug'
 import { DataSource } from 'typeorm'
-import { AuditLoggingEvent } from '@sphereon/ssi-sdk.core'
+import { ActivityLoggingEvent, AuditLoggingEvent } from '@sphereon/ssi-sdk.core'
 import { OrPromise } from '@sphereon/ssi-types'
 import { AbstractEventLoggerStore } from './AbstractEventLoggerStore'
-import { AuditEventEntity, auditEventEntityFrom } from '../entities/eventLogger/AuditEventEntity'
-import { GetAuditEventsArgs, StoreAuditEventArgs } from '../types'
+import { activityEventEntityFrom, AuditEventEntity, auditEventEntityFrom } from '../entities/eventLogger/AuditEventEntity'
+import { activityEventFrom, auditEventFrom } from '../utils/eventLogger/MappingUtils'
+import {GetActivityEventsArgs, GetAuditEventsArgs, StoreActivityEventArgs, StoreAuditEventArgs} from '../types'
 
 const debug: Debugger = Debug('sphereon:ssi-sdk:event-store')
 
@@ -19,11 +20,33 @@ export class EventLoggerStore extends AbstractEventLoggerStore {
   getAuditEvents = async (args?: GetAuditEventsArgs): Promise<Array<AuditLoggingEvent>> => {
     const connection: DataSource = await this.dbConnection // TODO apply everywhere
     debug('Getting audit events', args)
+    const where: any = {}
+    if (args?.filter) {
+      args.filter.forEach((filterCondition) => {
+        Object.assign(where, filterCondition)
+      })
+    }
     const result: Array<AuditEventEntity> = await connection.getRepository(AuditEventEntity).find({
-      ...(args?.filter && { where: args?.filter }),
+      where,
     })
 
-    return result.map((event: AuditEventEntity) => this.auditEventFrom(event))
+    return result.map((event: AuditEventEntity) => auditEventFrom(event))
+  }
+
+  getActivityEvents = async (args?: GetActivityEventsArgs): Promise<Array<ActivityLoggingEvent>> => {
+    const connection: DataSource = await this.dbConnection
+    debug('Getting activity events', args)
+    const where: any = {}
+    if (args?.filter) {
+      args.filter.forEach((filterCondition) => {
+        Object.assign(where, filterCondition)
+      })
+    }
+    const result: Array<AuditEventEntity> = await connection.getRepository(AuditEventEntity).find({
+      where,
+    })
+
+    return result.map((event: AuditEventEntity) => activityEventFrom(event))
   }
 
   storeAuditEvent = async (args: StoreAuditEventArgs): Promise<AuditLoggingEvent> => {
@@ -34,29 +57,17 @@ export class EventLoggerStore extends AbstractEventLoggerStore {
     debug('Storing audit event', auditEventEntity)
     const createdResult: AuditEventEntity = await connection.getRepository(AuditEventEntity).save(auditEventEntity)
 
-    return this.auditEventFrom(createdResult)
+    return auditEventFrom(createdResult)
   }
 
-  private auditEventFrom = (event: AuditEventEntity): AuditLoggingEvent => {
-    return {
-      id: event.id,
-      description: event.description,
-      timestamp: event.timestamp,
-      level: event.level,
-      correlationId: event.correlationId,
-      actionType: event.actionType,
-      actionSubType: event.actionSubType,
-      initiatorType: event.initiatorType,
-      partyAlias: event.partyAlias,
-      partyCorrelationId: event.partyCorrelationId,
-      partyCorrelationType: event.partyCorrelationType,
-      subSystemType: event.subSystemType,
-      system: event.system,
-      systemAlias: event.systemAlias,
-      systemCorrelationId: event.systemCorrelationId,
-      systemCorrelationIdType: event.systemCorrelationIdType,
-      ...(event.data && { data: JSON.parse(event.data) }),
-      ...(event.diagnosticData && { diagnosticData: JSON.parse(event.diagnosticData) }),
-    }
+  storeActivityEvent = async (args: StoreActivityEventArgs): Promise<ActivityLoggingEvent> => {
+    const { event } = args
+
+    const activityEventEntity: AuditEventEntity = activityEventEntityFrom(event)
+    const connection: DataSource = await this.dbConnection
+    debug('Storing activity event', activityEventEntity)
+    const createdResult: AuditEventEntity = await connection.getRepository(AuditEventEntity).save(activityEventEntity)
+
+    return activityEventFrom(createdResult)
   }
 }

package/src/issuanceBranding/IssuanceBrandingStore.ts

@@ -11,6 +11,7 @@ import { IssuerLocaleBrandingEntity, issuerLocaleBrandingEntityFrom } from '../e
 import { BaseLocaleBrandingEntity } from '../entities/issuanceBranding/BaseLocaleBrandingEntity'
 import { TextAttributesEntity } from '../entities/issuanceBranding/TextAttributesEntity'
 import { AbstractIssuanceBrandingStore } from './AbstractIssuanceBrandingStore'
+import { credentialBrandingFrom, issuerBrandingFrom, localeBrandingFrom } from '../utils/issuanceBranding/MappingUtils'
 import {
   IAddCredentialBrandingArgs,
   IAddCredentialLocaleBrandingArgs,
@@ -30,7 +31,6 @@ import {
   IIssuerBrandingFilter,
   IIssuerLocaleBranding,
   IIssuerLocaleBrandingFilter,
-  ILocaleBranding,
   IRemoveCredentialBrandingArgs,
   IRemoveCredentialLocaleBrandingArgs,
   IRemoveIssuerBrandingArgs,
@@ -42,6 +42,7 @@ import {
   ICredentialBrandingFilter,
 } from '../types'
 
+
 const debug: Debug.Debugger = Debug('sphereon:ssi-sdk:issuance-branding-store')
 
 export class IssuanceBrandingStore extends AbstractIssuanceBrandingStore {
@@ -71,7 +72,7 @@ export class IssuanceBrandingStore extends AbstractIssuanceBrandingStore {
     debug('Adding credential branding', credentialBrandingEntity)
     const createdResult: CredentialBrandingEntity = await repository.save(credentialBrandingEntity)
 
-    return this.credentialBrandingFrom(createdResult)
+    return credentialBrandingFrom(createdResult)
   }
 
   public getCredentialBranding = async (args?: IGetCredentialBrandingArgs): Promise<Array<ICredentialBranding>> => {
@@ -89,7 +90,7 @@ export class IssuanceBrandingStore extends AbstractIssuanceBrandingStore {
       ...(filter && { where: filter }),
     })
 
-    return result.map((credentialBranding: CredentialBrandingEntity) => this.credentialBrandingFrom(credentialBranding))
+    return result.map((credentialBranding: CredentialBrandingEntity) => credentialBrandingFrom(credentialBranding))
   }
 
   public removeCredentialBranding = async (args: IRemoveCredentialBrandingArgs): Promise<void> => {
@@ -133,7 +134,7 @@ export class IssuanceBrandingStore extends AbstractIssuanceBrandingStore {
     debug('Updating credential branding', branding)
     const result: CredentialBrandingEntity = await repository.save(branding, { transaction: true })
 
-    return this.credentialBrandingFrom(result)
+    return credentialBrandingFrom(result)
   }
 
   public addCredentialLocaleBranding = async (args: IAddCredentialLocaleBrandingArgs): Promise<ICredentialBranding> => {
@@ -188,7 +189,7 @@ export class IssuanceBrandingStore extends AbstractIssuanceBrandingStore {
       return Promise.reject(Error('Unable to get updated credential branding'))
     }
 
-    return this.credentialBrandingFrom(result)
+    return credentialBrandingFrom(result)
   }
 
   public getCredentialLocaleBranding = async (args?: IGetCredentialLocaleBrandingArgs): Promise<Array<ICredentialLocaleBranding>> => {
@@ -211,7 +212,7 @@ export class IssuanceBrandingStore extends AbstractIssuanceBrandingStore {
     return credentialBrandingLocale
       ? credentialBrandingLocale.map(
           (credentialLocaleBranding: CredentialLocaleBrandingEntity) =>
-            this.localeBrandingFrom(credentialLocaleBranding) as ICredentialLocaleBranding,
+            localeBrandingFrom(credentialLocaleBranding) as ICredentialLocaleBranding,
         )
       : []
   }
@@ -259,7 +260,7 @@ export class IssuanceBrandingStore extends AbstractIssuanceBrandingStore {
     debug('Updating credential locale branding', localeBranding)
     const updatedResult: CredentialLocaleBrandingEntity = await repository.save(localeBranding, { transaction: true })
 
-    return this.localeBrandingFrom(updatedResult) as ICredentialLocaleBranding
+    return localeBrandingFrom(updatedResult) as ICredentialLocaleBranding
   }
 
   public addIssuerBranding = async (args: IAddIssuerBrandingArgs): Promise<IIssuerBranding> => {
@@ -281,7 +282,7 @@ export class IssuanceBrandingStore extends AbstractIssuanceBrandingStore {
     debug('Adding issuer branding', issuerBrandingEntity)
     const createdResult: IssuerBrandingEntity = await repository.save(issuerBrandingEntity)
 
-    return this.issuerBrandingFrom(createdResult)
+    return issuerBrandingFrom(createdResult)
   }
 
   public getIssuerBranding = async (args?: IGetIssuerBrandingArgs): Promise<Array<IIssuerBranding>> => {
@@ -299,7 +300,7 @@ export class IssuanceBrandingStore extends AbstractIssuanceBrandingStore {
       ...(filter && { where: filter }),
     })
 
-    return result.map((issuerBranding: IssuerBrandingEntity) => this.issuerBrandingFrom(issuerBranding))
+    return result.map((issuerBranding: IssuerBrandingEntity) => issuerBrandingFrom(issuerBranding))
   }
 
   public removeIssuerBranding = async (args: IRemoveIssuerBrandingArgs): Promise<void> => {
@@ -343,7 +344,7 @@ export class IssuanceBrandingStore extends AbstractIssuanceBrandingStore {
     debug('Updating issuer branding', branding)
     const result: IssuerBrandingEntity = await repository.save(branding, { transaction: true })
 
-    return this.issuerBrandingFrom(result)
+    return issuerBrandingFrom(result)
   }
 
   public addIssuerLocaleBranding = async (args: IAddIssuerLocaleBrandingArgs): Promise<IIssuerBranding> => {
@@ -394,7 +395,7 @@ export class IssuanceBrandingStore extends AbstractIssuanceBrandingStore {
       return Promise.reject(Error('Unable to get updated issuer branding'))
     }
 
-    return this.issuerBrandingFrom(result)
+    return issuerBrandingFrom(result)
   }
 
   public getIssuerLocaleBranding = async (args?: IGetIssuerLocaleBrandingArgs): Promise<Array<IIssuerLocaleBranding>> => {
@@ -416,7 +417,7 @@ export class IssuanceBrandingStore extends AbstractIssuanceBrandingStore {
 
     return issuerLocaleBranding
       ? issuerLocaleBranding.map(
-          (issuerLocaleBranding: IssuerLocaleBrandingEntity) => this.localeBrandingFrom(issuerLocaleBranding) as IIssuerLocaleBranding,
+          (issuerLocaleBranding: IssuerLocaleBrandingEntity) => localeBrandingFrom(issuerLocaleBranding) as IIssuerLocaleBranding,
         )
       : []
   }
@@ -462,56 +463,7 @@ export class IssuanceBrandingStore extends AbstractIssuanceBrandingStore {
     debug('Updating issuer locale branding', localeBranding)
     const updatedResult: IssuerLocaleBrandingEntity = await repository.save(localeBranding, { transaction: true })
 
-    return this.localeBrandingFrom(updatedResult) as IIssuerLocaleBranding
-  }
-
-  private credentialBrandingFrom = (credentialBranding: CredentialBrandingEntity): ICredentialBranding => {
-    const result: ICredentialBranding = {
-      ...credentialBranding,
-      localeBranding: credentialBranding.localeBranding.map((localeBranding: BaseLocaleBrandingEntity) => this.localeBrandingFrom(localeBranding)),
-    }
-
-    return this.replaceNullWithUndefined(result)
-  }
-
-  private issuerBrandingFrom = (issuerBranding: IssuerBrandingEntity): IIssuerBranding => {
-    const result: IIssuerBranding = {
-      ...issuerBranding,
-      localeBranding: issuerBranding.localeBranding.map((localeBranding: BaseLocaleBrandingEntity) => this.localeBrandingFrom(localeBranding)),
-    }
-
-    return this.replaceNullWithUndefined(result)
-  }
-
-  private localeBrandingFrom = (localeBranding: BaseLocaleBrandingEntity): ILocaleBranding => {
-    const result: ILocaleBranding = {
-      ...localeBranding,
-      locale: localeBranding.locale === '' ? undefined : localeBranding.locale,
-    }
-
-    return this.replaceNullWithUndefined(result)
-  }
-
-  private replaceNullWithUndefined(obj: any): any {
-    if (obj === null) {
-      return undefined
-    }
-
-    if (typeof obj !== 'object' || obj instanceof Date) {
-      return obj
-    }
-
-    if (Array.isArray(obj)) {
-      return obj.map((value: any) => this.replaceNullWithUndefined(value))
-    }
-
-    const result: any = {}
-    for (const key in obj) {
-      if (obj.hasOwnProperty(key)) {
-        result[key] = this.replaceNullWithUndefined(obj[key])
-      }
-    }
-    return result
+    return localeBrandingFrom(updatedResult) as IIssuerLocaleBranding
   }
 
   private hasDuplicateLocales = async (localeBranding: Array<IBasicCredentialLocaleBranding | IBasicIssuerLocaleBranding>): Promise<boolean> => {

package/src/migrations/postgres/1701634812183-CreateAuditEvents.ts

@@ -15,8 +15,36 @@ export class CreateAuditEvents1701634812183 implements MigrationInterface {
     await queryRunner.query(`CREATE TYPE "public"."Initiator_type_enum" AS ENUM('user', 'system', 'external')`)
     await queryRunner.query(`CREATE TYPE "public"."System_correlation_id_type_enum" AS ENUM('did', 'email', 'hostname', 'phone', 'user')`)
     await queryRunner.query(`CREATE TYPE "public"."Party_correlation_type_enum" AS ENUM('did', 'email', 'hostname', 'phone')`)
+    await queryRunner.query(`CREATE TYPE "public"."Event_type_enum" AS ENUM('audit', 'activity', 'general')`)
+    await queryRunner.query(`CREATE TYPE "public"."Event_credential_type_enum" AS ENUM('JSON_LD', 'JWT', 'SD_JWT', 'MSO_MDOC')`)
     await queryRunner.query(
-      `CREATE TABLE "AuditEvents" ("id" uuid NOT NULL DEFAULT uuid_generate_v4(), "timestamp" TIMESTAMP NOT NULL, "level" "public"."Level_enum" NOT NULL, "correlationId" TEXT NOT NULL, "system" "public"."System_enum" NOT NULL, "subSystemType" "public"."Subsystem_type_enum" NOT NULL, "actionType" "public"."Action_type_enum" NOT NULL, "actionSubType" TEXT NOT NULL, "initiatorType" "public"."Initiator_type_enum" NOT NULL, "systemCorrelationIdType" "public"."System_correlation_id_type_enum", "systemCorrelationId" TEXT, "systemAlias" TEXT, "partyCorrelationType" "public"."Party_correlation_type_enum", "partyCorrelationId" TEXT, "partyAlias" TEXT, "description" TEXT NOT NULL, "data" TEXT, "diagnosticData" TEXT, "created_at" TIMESTAMP NOT NULL DEFAULT now(), "last_updated_at" TIMESTAMP NOT NULL DEFAULT now(), CONSTRAINT "PK_AuditEvents_id" PRIMARY KEY ("id"))`,
+      `CREATE TABLE "AuditEvents" (
+                "id" uuid NOT NULL DEFAULT uuid_generate_v4(),
+                "eventType" "public"."Event_type_enum" NOT NULL,
+                "timestamp" TIMESTAMP NOT NULL, 
+                "level" "public"."Level_enum" NOT NULL, 
+                "correlationId" TEXT NOT NULL, 
+                "system" "public"."System_enum" NOT NULL, 
+                "subSystemType" "public"."Subsystem_type_enum" NOT NULL,  
+                "actionType" "public"."Action_type_enum" NOT NULL, 
+                "actionSubType" TEXT NOT NULL, 
+                "initiatorType" "public"."Initiator_type_enum" NOT NULL, 
+                "systemCorrelationIdType" "public"."System_correlation_id_type_enum", 
+                "systemCorrelationId" TEXT, 
+                "systemAlias" TEXT, 
+                "partyCorrelationType" "public"."Party_correlation_type_enum", 
+                "partyCorrelationId" TEXT, 
+                "partyAlias" TEXT, 
+                "credentialType" "public"."Event_credential_type_enum",
+                "credentialHash" TEXT,
+                "originalCredential" TEXT,
+                "sharePurpose" TEXT,
+                "description" TEXT NOT NULL, 
+                "data" TEXT, 
+                "diagnosticData" TEXT, 
+                "created_at" TIMESTAMP NOT NULL DEFAULT now(), 
+                "last_updated_at" TIMESTAMP NOT NULL DEFAULT now(), 
+                CONSTRAINT "PK_AuditEvents_id" PRIMARY KEY ("id"))`,
     )
   }
 

package/src/migrations/sqlite/1701634819487-CreateAuditEvents.ts

@@ -5,7 +5,31 @@ export class CreateAuditEvents1701634819487 implements MigrationInterface {
 
   public async up(queryRunner: QueryRunner): Promise<void> {
     await queryRunner.query(
-      `CREATE TABLE "AuditEvents" ("id" varchar PRIMARY KEY NOT NULL, "timestamp" datetime NOT NULL, "level" varchar CHECK( "level" IN ('0','1','2','3') ) NOT NULL, "correlationId" varchar NOT NULL, "system" varchar CHECK( "system" IN ('general','kms','identity','oid4vci','credentials','web3','profile','contact') ) NOT NULL, "subSystemType" varchar CHECK( "subSystemType" IN ('key','did_provider','did_resolver','oid4vp_op','oid4vci_client','siopv2_op','contact_manager','vc_issuer','vc_verifier','vc_persistence','transport','profile') ) NOT NULL, "actionType" varchar CHECK( "actionType" IN ('create','read','update','delete','execute') ) NOT NULL, "actionSubType" varchar NOT NULL, "initiatorType" varchar CHECK( "initiatorType" IN ('user','system','external') ) NOT NULL, "systemCorrelationIdType" varchar CHECK( "systemCorrelationIdType" IN ('did','email','hostname','phone','user') ), "systemCorrelationId" varchar, "systemAlias" varchar, "partyCorrelationType" varchar CHECK( "partyCorrelationType" IN ('did','email','hostname','phone') ), "partyCorrelationId" varchar, "partyAlias" varchar, "description" varchar NOT NULL, "data" varchar, "diagnosticData" varchar, "created_at" datetime NOT NULL DEFAULT (datetime('now')), "last_updated_at" datetime NOT NULL DEFAULT (datetime('now')))`,
+      `CREATE TABLE "AuditEvents" (
+                "id" varchar PRIMARY KEY NOT NULL,
+                "eventType" varchar CHECK( "eventType" IN ('audit', 'activity', 'general') ) NOT NULL,
+                "timestamp" datetime NOT NULL, 
+                "level" varchar CHECK( "level" IN ('0','1','2','3') ) NOT NULL, 
+                "correlationId" varchar NOT NULL, 
+                "system" varchar CHECK( "system" IN ('general','kms','identity','oid4vci','credentials','web3','profile','contact') ) NOT NULL, 
+                "subSystemType" varchar CHECK( "subSystemType" IN ('key','did_provider','did_resolver','oid4vp_op','oid4vci_client','siopv2_op','contact_manager','vc_issuer','vc_verifier','vc_persistence','transport','profile') ) NOT NULL, 
+                "actionType" varchar CHECK( "actionType" IN ('create','read','update','delete','execute') ) NOT NULL, 
+                "actionSubType" varchar NOT NULL, "initiatorType" varchar CHECK( "initiatorType" IN ('user','system','external') ) NOT NULL, 
+                "systemCorrelationIdType" varchar CHECK( "systemCorrelationIdType" IN ('did','email','hostname','phone','user') ), 
+                "systemCorrelationId" varchar, 
+                "systemAlias" varchar, 
+                "partyCorrelationType" varchar CHECK( "partyCorrelationType" IN ('did','email','hostname','phone') ), 
+                "partyCorrelationId" varchar, 
+                "partyAlias" varchar,
+                "credentialType" varchar CHECK( "credentialType" IN ('JSON_LD', 'JWT', 'SD_JWT', 'MSO_MDOC') ),
+                "credentialHash" varchar,
+                "originalCredential" varchar,
+                "sharePurpose" varchar,
+                "description" varchar NOT NULL, 
+                "data" varchar, 
+                "diagnosticData" varchar, 
+                "created_at" datetime NOT NULL DEFAULT (datetime('now')), 
+                "last_updated_at" datetime NOT NULL DEFAULT (datetime('now')))`,
     )
   }
 

package/src/types/eventLogger/IAbstractEventLoggerStore.ts

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

package/src/types/eventLogger/eventLogger.ts

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

package/src/utils/FormattingUtils.ts

@@ -0,0 +1,21 @@
+export const replaceNullWithUndefined = (obj: any): any => {
+  if (obj === null) {
+    return undefined
+  }
+
+  if (typeof obj !== 'object' || obj instanceof Date) {
+    return obj
+  }
+
+  if (Array.isArray(obj)) {
+    return obj.map((value: any) => replaceNullWithUndefined(value))
+  }
+
+  const result: any = {}
+  for (const key in obj) {
+    if (obj.hasOwnProperty(key)) {
+      result[key] = replaceNullWithUndefined(obj[key])
+    }
+  }
+  return result
+}

package/src/utils/contact/MappingUtils.ts

@@ -47,6 +47,7 @@ import { OpenIdConfigEntity } from '../../entities/contact/OpenIdConfigEntity'
 import { PartyTypeEntity } from '../../entities/contact/PartyTypeEntity'
 import { PhysicalAddressEntity } from '../../entities/contact/PhysicalAddressEntity'
 import { ContactMetadataItemEntity } from '../../entities/contact/ContactMetadataItemEntity'
+import { replaceNullWithUndefined } from '../FormattingUtils'
 
 export const partyEntityFrom = (party: NonPersistedParty): PartyEntity => {
   const partyEntity: PartyEntity = new PartyEntity()
@@ -67,7 +68,7 @@ export const partyEntityFrom = (party: NonPersistedParty): PartyEntity => {
 }
 
 export const partyFrom = (party: PartyEntity): Party => {
-  return {
+  const result: Party = {
     id: party.id,
     uri: party.uri,
     roles: [...new Set(party.identities?.flatMap((identity: IdentityEntity) => identity.roles))] ?? [],
@@ -86,6 +87,8 @@ export const partyFrom = (party: PartyEntity): Party => {
     createdAt: party.createdAt,
     lastUpdatedAt: party.lastUpdatedAt,
   }
+
+  return replaceNullWithUndefined(result)
 }
 
 export const contactEntityFrom = (contact: NonPersistedContact): BaseContactEntity => {
@@ -125,13 +128,15 @@ export const connectionEntityFrom = (connection: NonPersistedConnection): Connec
 }
 
 export const connectionFrom = (connection: ConnectionEntity): Connection => {
-  return {
+  const result: Connection = {
     id: connection.id,
     type: connection.type,
     ownerId: connection.ownerId,
     tenantId: connection.tenantId,
     config: configFrom(connection.config),
   }
+
+  return replaceNullWithUndefined(result)
 }
 
 const configEntityFrom = (config: NonPersistedConnectionConfig): BaseConfigEntity => {
@@ -155,13 +160,15 @@ export const correlationIdentifierEntityFrom = (identifier: NonPersistedCorrelat
 }
 
 export const correlationIdentifierFrom = (identifier: CorrelationIdentifierEntity): CorrelationIdentifier => {
-  return {
+  const result: CorrelationIdentifier = {
     id: identifier.id,
     type: identifier.type,
     correlationId: identifier.correlationId,
     ownerId: identifier.ownerId,
     tenantId: identifier.tenantId,
   }
+
+  return replaceNullWithUndefined(result)
 }
 
 export const didAuthConfigEntityFrom = (config: NonPersistedDidAuthConfig): DidAuthConfigEntity => {
@@ -196,7 +203,7 @@ export const electronicAddressEntityFrom = (electronicAddress: NonPersistedElect
 }
 
 export const electronicAddressFrom = (electronicAddress: ElectronicAddressEntity): ElectronicAddress => {
-  return {
+  const result: ElectronicAddress = {
     id: electronicAddress.id,
     type: electronicAddress.type,
     electronicAddress: electronicAddress.electronicAddress,
@@ -205,6 +212,8 @@ export const electronicAddressFrom = (electronicAddress: ElectronicAddressEntity
     createdAt: electronicAddress.createdAt,
     lastUpdatedAt: electronicAddress.lastUpdatedAt,
   }
+
+  return replaceNullWithUndefined(result)
 }
 
 export const physicalAddressEntityFrom = (physicalAddress: NonPersistedPhysicalAddress): PhysicalAddressEntity => {
@@ -224,7 +233,7 @@ export const physicalAddressEntityFrom = (physicalAddress: NonPersistedPhysicalA
 }
 
 export const physicalAddressFrom = (physicalAddress: PhysicalAddressEntity): PhysicalAddress => {
-  return {
+  const result: PhysicalAddress = {
     id: physicalAddress.id,
     type: physicalAddress.type,
     streetName: physicalAddress.streetName,
@@ -239,6 +248,8 @@ export const physicalAddressFrom = (physicalAddress: PhysicalAddressEntity): Phy
     createdAt: physicalAddress.createdAt,
     lastUpdatedAt: physicalAddress.lastUpdatedAt,
   }
+
+  return replaceNullWithUndefined(result)
 }
 
 export const identityEntityFrom = (entity: NonPersistedIdentity): IdentityEntity => {
@@ -257,7 +268,7 @@ export const identityEntityFrom = (entity: NonPersistedIdentity): IdentityEntity
 }
 
 export const identityFrom = (identity: IdentityEntity): Identity => {
-  return {
+  const result: Identity = {
     id: identity.id,
     alias: identity.alias,
     origin: identity.origin,
@@ -270,12 +281,11 @@ export const identityFrom = (identity: IdentityEntity): Identity => {
     createdAt: identity.createdAt,
     lastUpdatedAt: identity.createdAt,
   }
+
+  return replaceNullWithUndefined(result)
 }
 
-const metadataItemEntityFrom = <T extends MetadataTypes, U extends { new (): any }>(
-  item: NonPersistedMetadataItem<T>,
-  EntityClass: U,
-): InstanceType<U> | undefined => {
+const metadataItemEntityFrom = <T extends MetadataTypes, U extends { new (): any }>(item: NonPersistedMetadataItem<T>, EntityClass: U): InstanceType<U> | undefined => {
   const { label, value } = item
 
   if (value === null || value === undefined) {
@@ -359,7 +369,7 @@ export const naturalPersonEntityFrom = (naturalPerson: NonPersistedNaturalPerson
 }
 
 export const naturalPersonFrom = (naturalPerson: NaturalPersonEntity): NaturalPerson => {
-  return {
+  const result: NaturalPerson = {
     id: naturalPerson.id,
     firstName: naturalPerson.firstName,
     middleName: naturalPerson.middleName,
@@ -371,6 +381,8 @@ export const naturalPersonFrom = (naturalPerson: NaturalPersonEntity): NaturalPe
     createdAt: naturalPerson.createdAt,
     lastUpdatedAt: naturalPerson.lastUpdatedAt,
   }
+
+  return replaceNullWithUndefined(result)
 }
 
 export const openIdConfigEntityFrom = (config: NonPersistedOpenIdConfig): OpenIdConfigEntity => {
@@ -402,7 +414,7 @@ export const organizationEntityFrom = (organization: NonPersistedOrganization):
 }
 
 export const organizationFrom = (organization: OrganizationEntity): Organization => {
-  return {
+  const result: Organization = {
     id: organization.id,
     legalName: organization.legalName,
     displayName: organization.displayName,
@@ -412,6 +424,8 @@ export const organizationFrom = (organization: OrganizationEntity): Organization
     createdAt: organization.createdAt,
     lastUpdatedAt: organization.lastUpdatedAt,
   }
+
+  return replaceNullWithUndefined(result)
 }
 
 export const partyRelationshipEntityFrom = (relationship: NonPersistedPartyRelationship): PartyRelationshipEntity => {
@@ -420,11 +434,12 @@ export const partyRelationshipEntityFrom = (relationship: NonPersistedPartyRelat
   partyRelationshipEntity.rightId = relationship.rightId
   partyRelationshipEntity.ownerId = relationship.ownerId
   partyRelationshipEntity.tenantId = relationship.tenantId
+
   return partyRelationshipEntity
 }
 
 export const partyRelationshipFrom = (relationship: PartyRelationshipEntity): PartyRelationship => {
-  return {
+  const result: PartyRelationship = {
     id: relationship.id,
     leftId: relationship.leftId,
     rightId: relationship.rightId,
@@ -433,6 +448,8 @@ export const partyRelationshipFrom = (relationship: PartyRelationshipEntity): Pa
     createdAt: relationship.createdAt,
     lastUpdatedAt: relationship.lastUpdatedAt,
   }
+
+  return replaceNullWithUndefined(result)
 }
 
 export const partyTypeEntityFrom = (args: NonPersistedPartyType): PartyTypeEntity => {
@@ -450,7 +467,7 @@ export const partyTypeEntityFrom = (args: NonPersistedPartyType): PartyTypeEntit
 }
 
 export const partyTypeFrom = (partyType: PartyTypeEntity): PartyType => {
-  return {
+  const result: PartyType = {
     id: partyType.id,
     type: partyType.type,
     origin: partyType.origin,
@@ -460,6 +477,8 @@ export const partyTypeFrom = (partyType: PartyTypeEntity): PartyType => {
     createdAt: partyType.createdAt,
     lastUpdatedAt: partyType.lastUpdatedAt,
   }
+
+  return replaceNullWithUndefined(result)
 }
 
 export const configFrom = (config: BaseConfigEntity): ConnectionConfig => {
@@ -473,7 +492,7 @@ export const configFrom = (config: BaseConfigEntity): ConnectionConfig => {
 }
 
 export const openIdConfigFrom = (config: OpenIdConfigEntity): OpenIdConfig => {
-  return {
+  const result: OpenIdConfig = {
     id: config.id,
     clientId: config.clientId,
     clientSecret: config.clientSecret,
@@ -485,10 +504,12 @@ export const openIdConfigFrom = (config: OpenIdConfigEntity): OpenIdConfig => {
     ownerId: config.ownerId,
     tenantId: config.tenantId,
   }
+
+  return replaceNullWithUndefined(result)
 }
 
 export const didAuthConfigFrom = (config: DidAuthConfigEntity): DidAuthConfig => {
-  return {
+  const result: DidAuthConfig = {
     id: config.id,
     idOpts: { identifier: config.identifier },
     stateId: '', // FIXME
@@ -497,6 +518,8 @@ export const didAuthConfigFrom = (config: DidAuthConfigEntity): DidAuthConfig =>
     ownerId: config.ownerId,
     tenantId: config.tenantId,
   }
+
+  return replaceNullWithUndefined(result)
 }
 
 export const isOpenIdConfig = (config: NonPersistedConnectionConfig | BaseConfigEntity): config is OpenIdConfig | OpenIdConfigEntity =>

package/src/utils/digitalCredential/MappingUtils.ts

@@ -18,6 +18,7 @@ import {
   NonPersistedDigitalCredential,
   RegulationType,
 } from '../../types'
+import { replaceNullWithUndefined } from '../FormattingUtils'
 
 function determineDocumentType(raw: string): DocumentType {
   const rawDocument = parseRawDocument(raw)
@@ -150,9 +151,11 @@ export const nonPersistedDigitalCredentialEntityFromAddArgs = (addCredentialArgs
 }
 
 export const digitalCredentialFrom = (credentialEntity: DigitalCredentialEntity): DigitalCredential => {
-  return {
+  const result: DigitalCredential = {
     ...credentialEntity,
   }
+
+  return replaceNullWithUndefined(result)
 }
 
 export const digitalCredentialsFrom = (credentialEntities: Array<DigitalCredentialEntity>): DigitalCredential[] => {