@sphereon/ssi-sdk.data-store 0.30.2-next.103 → 0.30.2-next.125

package/src/eventLogger/EventLoggerStore.ts

@@ -1,11 +1,20 @@
+import { ActivityLoggingEvent, AuditLoggingEvent } from '@sphereon/ssi-sdk.core'
+import { LoggingEventType, OrPromise } from '@sphereon/ssi-types'
 import Debug, { Debugger } from 'debug'
 import { DataSource } from 'typeorm'
-import { AuditLoggingEvent } from '@sphereon/ssi-sdk.core'
-import { OrPromise } from '@sphereon/ssi-types'
 import { AbstractEventLoggerStore } from './AbstractEventLoggerStore'
-import { AuditEventEntity, auditEventEntityFrom } from '../entities/eventLogger/AuditEventEntity'
-import { auditEventFrom } from '../utils/eventLogger/MappingUtils'
-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')
 
@@ -18,10 +27,17 @@ export class EventLoggerStore extends AbstractEventLoggerStore {
   }
 
   getAuditEvents = async (args?: GetAuditEventsArgs): Promise<Array<AuditLoggingEvent>> => {
-    const connection: DataSource = await this.dbConnection // TODO apply everywhere
+    const { filter = [] } = args ?? {}
+
+    const auditEventsFilter = filter.map((item) => ({ ...item, type: LoggingEventType.AUDIT }))
+    if (auditEventsFilter.length === 0) {
+      auditEventsFilter.push({ type: LoggingEventType.AUDIT })
+    }
+
+    const connection = await this.dbConnection
     debug('Getting audit events', args)
-    const result: Array<AuditEventEntity> = await connection.getRepository(AuditEventEntity).find({
-      ...(args?.filter && { where: args?.filter }),
+    const result = await connection.getRepository(AuditEventEntity).find({
+      where: auditEventsFilter
     })
 
     return result.map((event: AuditEventEntity) => auditEventFrom(event))
@@ -30,11 +46,39 @@ export class EventLoggerStore extends AbstractEventLoggerStore {
   storeAuditEvent = async (args: StoreAuditEventArgs): Promise<AuditLoggingEvent> => {
     const { event } = args
 
-    const auditEventEntity: AuditEventEntity = auditEventEntityFrom(event)
-    const connection: DataSource = await this.dbConnection
+    const auditEventEntity = auditEventEntityFrom(event)
+    const connection = await this.dbConnection
     debug('Storing audit event', auditEventEntity)
-    const createdResult: AuditEventEntity = await connection.getRepository(AuditEventEntity).save(auditEventEntity)
+    const createdResult = await connection.getRepository(AuditEventEntity).save(auditEventEntity)
 
     return auditEventFrom(createdResult)
   }
+
+  getActivityEvents = async (args?: GetActivityEventsArgs): Promise<Array<ActivityLoggingEvent>> => {
+    const { filter = [] } = args ?? {}
+
+    const activityEventsFilter = filter.map((item) => ({ ...item, type: LoggingEventType.ACTIVITY }))
+    if (activityEventsFilter.length === 0) {
+      activityEventsFilter.push({ type: LoggingEventType.ACTIVITY })
+    }
+
+    const connection = await this.dbConnection
+    debug('Getting activity events', args)
+    const result = await connection.getRepository(AuditEventEntity).find({
+      where: activityEventsFilter
+    })
+
+    return result.map((event: AuditEventEntity) => activityEventFrom(event))
+  }
+
+  storeActivityEvent = async (args: StoreActivityEventArgs): Promise<ActivityLoggingEvent> => {
+    const { event } = args
+
+    const activityEventEntity = activityEventEntityFrom(event)
+    const connection = await this.dbConnection
+    debug('Storing activity event', activityEventEntity)
+    const createdResult = await connection.getRepository(AuditEventEntity).save(activityEventEntity)
+
+    return activityEventFrom(createdResult)
+  }
 }

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

@@ -4,19 +4,47 @@ export class CreateAuditEvents1701634812183 implements MigrationInterface {
   name = 'CreateAuditEvents1701634812183'
 
   public async up(queryRunner: QueryRunner): Promise<void> {
-    await queryRunner.query(`CREATE TYPE "public"."Level_enum" AS ENUM('0', '1', '2', '3')`)
+    await queryRunner.query(`CREATE TYPE "public"."Level_enum" AS ENUM('0', '1', '2', '3', '4')`)
     await queryRunner.query(
-      `CREATE TYPE "public"."System_enum" AS ENUM('general', 'kms', 'identity', 'oid4vci', 'credentials', 'web3', 'profile', 'contact')`,
+      `CREATE TYPE "public"."System_enum" AS ENUM('general', 'kms', 'identity', 'oid4vci', 'oid4vp', 'siopv2', 'PE', 'credentials', 'web3', 'profile', 'contact')`,
     )
     await queryRunner.query(
-      `CREATE TYPE "public"."Subsystem_type_enum" AS ENUM('key', 'did_provider', 'did_resolver', 'oid4vp_op', 'oid4vci_client', 'siopv2_op', 'contact_manager', 'vc_issuer', 'vc_verifier', 'vc_persistence', 'transport', 'profile')`,
+      `CREATE TYPE "public"."Subsystem_type_enum" AS ENUM('key', 'did_provider', 'did_resolver', 'oid4vp_op', 'oid4vci_client', 'siopv2_op', 'contact_manager', 'vc_issuer', 'vc_verifier', 'vc_persistence', 'transport', 'profile', 'api')`,
     )
     await queryRunner.query(`CREATE TYPE "public"."Action_type_enum" AS ENUM('create', 'read', 'update', 'delete', 'execute')`)
     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"."System_correlation_id_type_enum" AS ENUM('did', 'url', 'email', 'hostname', 'phone', 'user')`)
+    await queryRunner.query(`CREATE TYPE "public"."Party_correlation_type_enum" AS ENUM('did', 'url', '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,33 @@ 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','4') ) NOT NULL, 
+                "correlationId" varchar NOT NULL, 
+                "system" varchar CHECK( "system" IN ('general','kms','identity','oid4vci','oid4vp','siopv2','PE','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','api') ) 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','url','email','hostname','phone','user') ), 
+                "systemCorrelationId" varchar, 
+                "systemAlias" varchar, 
+                "partyCorrelationType" varchar CHECK( "partyCorrelationType" IN ('did','url','email','hostname','phone') ), 
+                "partyCorrelationId" varchar, 
+                "partyAlias" varchar,
+                "credentialType" varchar CHECK( "credentialType" IN ('JSON_LD','JWT','SD_JWT','MSO_MDOC') ),
+                "credentialHash" varchar,
+                "parentCredentialHash" 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/eventLogger/MappingUtils.ts

@@ -1,10 +1,43 @@
 import { AuditEventEntity } from '../../entities/eventLogger/AuditEventEntity'
-import { AuditLoggingEvent } from '@sphereon/ssi-sdk.core'
+import { ActivityLoggingEvent, AuditLoggingEvent } from '@sphereon/ssi-sdk.core'
+import { LoggingEventType } from '@sphereon/ssi-types'
 import { replaceNullWithUndefined } from '../FormattingUtils'
 
 export const auditEventFrom = (event: AuditEventEntity): AuditLoggingEvent => {
   const result: AuditLoggingEvent = {
     id: event.id,
+    type: LoggingEventType.AUDIT,
+    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) }),
+  }
+
+  return replaceNullWithUndefined(result)
+}
+
+export const activityEventFrom = (event: AuditEventEntity): ActivityLoggingEvent => {
+
+  const result: ActivityLoggingEvent =  {
+    id: event.id,
+    type: LoggingEventType.ACTIVITY,
+    credentialType: event.credentialType!,
+    originalCredential: event.originalCredential,
+    credentialHash: event.credentialHash,
+    sharePurpose: event.sharePurpose,
     description: event.description,
     timestamp: event.timestamp,
     level: event.level,