@sphereon/ssi-sdk.data-store 0.17.6-unstable.8 → 0.18.1-next.2

package/src/migrations/generic/5-CreateAuditEvents.ts

@@ -0,0 +1,66 @@
+import { DatabaseType, MigrationInterface, QueryRunner } from 'typeorm'
+import Debug, { Debugger } from 'debug'
+import { CreateAuditEvents1701634819487 } from '../sqlite/1701634819487-CreateAuditEvents'
+import { CreateAuditEvents1701634812183 } from '../postgres/1701634812183-CreateAuditEvents'
+
+const debug: Debugger = Debug('sphereon:ssi-sdk:migrations')
+
+export class CreateAuditEvents1701635835330 implements MigrationInterface {
+  name: string = 'CreateAuditEvents1701635835330'
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    debug('migration: creating audit events tables')
+    const dbType: DatabaseType = queryRunner.connection.driver.options.type
+
+    switch (dbType) {
+      case 'postgres': {
+        debug('using postgres migration file')
+        const mig: CreateAuditEvents1701634812183 = new CreateAuditEvents1701634812183()
+        await mig.up(queryRunner)
+        debug('Migration statements executed')
+        return
+      }
+      case 'sqlite':
+      case 'expo':
+      case 'react-native': {
+        debug('using sqlite/react-native migration file')
+        const mig: CreateAuditEvents1701634819487 = new CreateAuditEvents1701634819487()
+        await mig.up(queryRunner)
+        debug('Migration statements executed')
+        return
+      }
+      default:
+        return Promise.reject(
+          `Migrations are currently only supported for sqlite, react-native, expo and postgres. Was ${dbType}. Please run your database without migrations and with 'migrationsRun: false' and 'synchronize: true' for now`
+        )
+    }
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    debug('migration: reverting audit events tables')
+    const dbType: DatabaseType = queryRunner.connection.driver.options.type
+
+    switch (dbType) {
+      case 'postgres': {
+        debug('using postgres migration file')
+        const mig: CreateAuditEvents1701634812183 = new CreateAuditEvents1701634812183()
+        await mig.down(queryRunner)
+        debug('Migration statements executed')
+        return
+      }
+      case 'sqlite':
+      case 'expo':
+      case 'react-native': {
+        debug('using sqlite/react-native migration file')
+        const mig: CreateAuditEvents1701634819487 = new CreateAuditEvents1701634819487()
+        await mig.down(queryRunner)
+        debug('Migration statements executed')
+        return
+      }
+      default:
+        return Promise.reject(
+          `Migrations are currently only supported for sqlite, react-native, expo and postgres. Was ${dbType}. Please run your database without migrations and with 'migrationsRun: false' and 'synchronize: true' for now`
+        )
+    }
+  }
+}

package/src/migrations/generic/index.ts

@@ -1,7 +1,8 @@
 import { CreateContacts1659463079429 } from './1-CreateContacts'
-import { CreateContacts1690925872318 } from './2-CreateContacts'
 import { CreateIssuanceBranding1659463079429 } from './2-CreateIssuanceBranding'
-import { CreateStatusList1693866470000 } from './3-CreateStatusList'
+import { CreateContacts1690925872318 } from './3-CreateContacts'
+import { CreateStatusList1693866470000 } from './4-CreateStatusList'
+import { CreateAuditEvents1701635835330 } from './5-CreateAuditEvents'
 
 /**
  * The migrations array that SHOULD be used when initializing a TypeORM database connection.
@@ -15,6 +16,12 @@ import { CreateStatusList1693866470000 } from './3-CreateStatusList'
 export const DataStoreContactMigrations = [CreateContacts1659463079429, CreateContacts1690925872318]
 export const DataStoreIssuanceBrandingMigrations = [CreateIssuanceBranding1659463079429]
 export const DataStoreStatusListMigrations = [CreateStatusList1693866470000]
+export const DataStoreEventLoggerMigrations = [CreateAuditEvents1701635835330]
 
 // All migrations together
-export const DataStoreMigrations = [...DataStoreContactMigrations, ...DataStoreIssuanceBrandingMigrations, ...DataStoreStatusListMigrations]
+export const DataStoreMigrations = [
+  ...DataStoreContactMigrations,
+  ...DataStoreIssuanceBrandingMigrations,
+  ...DataStoreStatusListMigrations,
+  ...DataStoreEventLoggerMigrations,
+]

package/src/migrations/index.ts

@@ -1,2 +1 @@
 export { DataStoreMigrations } from './generic'
-export { enableUuidv4 } from './postgres/uuid'

package/src/migrations/postgres/1659463079428-CreateContacts.ts

@@ -1,11 +1,11 @@
 import { MigrationInterface, QueryRunner } from 'typeorm'
-import { enableUuidv4 } from './uuid'
+import { enablePostgresUuidExtension } from '@sphereon/ssi-sdk.core'
 
 export class CreateContacts1659463079428 implements MigrationInterface {
   name = 'CreateContacts1659463079428'
 
   public async up(queryRunner: QueryRunner): Promise<void> {
-    await enableUuidv4(queryRunner)
+    await enablePostgresUuidExtension(queryRunner)
     await queryRunner.query(
       `CREATE TABLE "BaseConfigEntity" ("id" uuid NOT NULL DEFAULT uuid_generate_v4(), "client_id" character varying(255), "client_secret" character varying(255), "scopes" text, "issuer" character varying(255), "redirect_url" text, "dangerously_allow_insecure_http_requests" boolean, "client_auth_method" text, "identifier" character varying(255), "session_id" character varying(255), "type" character varying NOT NULL, "connectionId" uuid, CONSTRAINT "REL_BaseConfig_connectionId" UNIQUE ("connectionId"), CONSTRAINT "PK_BaseConfigEntity_id" PRIMARY KEY ("id"))`
     )

package/src/migrations/postgres/1685628974232-CreateIssuanceBranding.ts

@@ -1,11 +1,11 @@
 import { MigrationInterface, QueryRunner } from 'typeorm'
-import { enableUuidv4 } from './uuid'
+import { enablePostgresUuidExtension } from '@sphereon/ssi-sdk.core'
 
 export class CreateIssuanceBranding1685628974232 implements MigrationInterface {
   name = 'CreateIssuanceBranding1685628974232'
 
   public async up(queryRunner: QueryRunner): Promise<void> {
-    await enableUuidv4(queryRunner)
+    await enablePostgresUuidExtension(queryRunner)
     await queryRunner.query(
       `CREATE TABLE "ImageDimensions" ("id" uuid NOT NULL DEFAULT uuid_generate_v4(), "width" integer NOT NULL, "height" integer NOT NULL, CONSTRAINT "PK_ImageDimensions_id" PRIMARY KEY ("id"))`
     )

package/src/migrations/postgres/1690925872592-CreateContacts.ts

@@ -1,11 +1,11 @@
 import { MigrationInterface, QueryRunner } from 'typeorm'
-import { enableUuidv4 } from './uuid'
+import { enablePostgresUuidExtension } from '@sphereon/ssi-sdk.core'
 
 export class CreateContacts1690925872592 implements MigrationInterface {
   name = 'CreateContacts1690925872592'
 
   public async up(queryRunner: QueryRunner): Promise<void> {
-    await enableUuidv4(queryRunner)
+    await enablePostgresUuidExtension(queryRunner)
     await queryRunner.query(`ALTER TABLE "CorrelationIdentifier" DROP CONSTRAINT "FK_CorrelationIdentifier_identityId"`)
     await queryRunner.query(`ALTER TABLE "IdentityMetadata" DROP CONSTRAINT "FK_IdentityMetadata_identityId"`)
     await queryRunner.query(`ALTER TABLE "Identity" DROP CONSTRAINT "FK_Identity_contactId"`)

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

@@ -0,0 +1,33 @@
+import { MigrationInterface, QueryRunner } from 'typeorm'
+
+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"."System_enum" AS ENUM('general', 'kms', 'identity', 'oid4vci', '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')`
+    )
+    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 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 NOT NULL, "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"))`
+    )
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`DROP TABLE "AuditEvents"`)
+    await queryRunner.query(`DROP TYPE "public"."Party_correlation_type_enum`)
+    await queryRunner.query(`DROP TYPE "public"."System_correlation_id_type_enum`)
+    await queryRunner.query(`DROP TYPE "public"."Initiator_type_enum`)
+    await queryRunner.query(`DROP TYPE "public"."Action_type_enum`)
+    await queryRunner.query(`DROP TYPE "public"."Subsystem_type_enum`)
+    await queryRunner.query(`DROP TYPE "public"."System_enum`)
+    await queryRunner.query(`DROP TYPE "public"."Level_enum`)
+  }
+}

package/src/migrations/sqlite/1690925872693-CreateContacts.ts

@@ -141,7 +141,7 @@ export class CreateContacts1690925872693 implements MigrationInterface {
 
     // migrate existing data
     await queryRunner.query(
-      `INSERT INTO "BaseConfig"("id", "identifier", "redirect_url", "session_id", "client_id", "client_secret", "scopes", "issuer", "dangerously_allow_insecure_http_requests", "client_auth_method", "type", "connection_id") SELECT "id", "identifier", "redirect_url", "session_id", "client_id", "client_secret", "scopes", "issuer", "dangerously_allow_insecure_http_requests", "client_auth_method", "type", "connection_id" FROM "BaseConfigEntity"`
+      `INSERT INTO "BaseConfig"("id", "identifier", "redirect_url", "session_id", "client_id", "client_secret", "scopes", "issuer", "dangerously_allow_insecure_http_requests", "client_auth_method", "type", "connection_id") SELECT "id", "identifier", "redirect_url", "session_id", "client_id", "client_secret", "scopes", "issuer", "dangerously_allow_insecure_http_requests", "client_auth_method", "type", "connectionId" FROM "BaseConfigEntity"`
     )
     await queryRunner.query(`DROP TABLE "BaseConfigEntity"`)
     await queryRunner.query(

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

@@ -0,0 +1,15 @@
+import { MigrationInterface, QueryRunner } from 'typeorm'
+
+export class CreateAuditEvents1701634819487 implements MigrationInterface {
+  name = 'CreateAuditEvents1701634819487'
+
+  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 NOT NULL, "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')))`
+    )
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`DROP TABLE "AuditEvents"`)
+  }
+}

package/src/types/eventLogger/IAbstractEventLoggerStore.ts

@@ -0,0 +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
+}

package/src/types/eventLogger/eventLogger.ts

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

package/src/types/index.ts

@@ -2,7 +2,8 @@ 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/dist/migrations/postgres/CreateStatusList1693866470001-CreateStatusList.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"CreateStatusList1693866470001-CreateStatusList.d.ts","sourceRoot":"","sources":["../../../src/migrations/postgres/CreateStatusList1693866470001-CreateStatusList.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAEzD,qBAAa,6BAA8B,YAAW,kBAAkB;IACtE,IAAI,SAAkC;IAEzB,EAAE,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAiB3C,IAAI,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;CAC3D"}

package/dist/migrations/postgres/CreateStatusList1693866470001-CreateStatusList.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"CreateStatusList1693866470001-CreateStatusList.js","sourceRoot":"","sources":["../../../src/migrations/postgres/CreateStatusList1693866470001-CreateStatusList.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,MAAa,6BAA6B;IAA1C;QACE,SAAI,GAAG,+BAA+B,CAAA;IAoBxC,CAAC;IAlBc,EAAE,CAAC,WAAwB;;YACtC,MAAM,WAAW,CAAC,KAAK,CACrB,+VAA+V,CAChW,CAAA;YACD,MAAM,WAAW,CAAC,KAAK,CAAC,uEAAuE,CAAC,CAAA;YAChG,MAAM,WAAW,CAAC,KAAK,CACrB,4HAA4H,CAC7H,CAAA;YACD,MAAM,WAAW,CAAC,KAAK,CAAC,qGAAqG,CAAC,CAAA;YAC9H,MAAM,WAAW,CAAC,KAAK,CACrB,6tBAA6tB,CAC9tB,CAAA;YACD,MAAM,WAAW,CAAC,KAAK,CACrB,mLAAmL,CACpL,CAAA;QACH,CAAC;KAAA;IAEY,IAAI,CAAC,WAAwB;8DAAkB,CAAC;KAAA;CAC9D;AArBD,sEAqBC"}

package/dist/migrations/postgres/uuid.d.ts

@@ -1,3 +0,0 @@
-import { QueryRunner } from 'typeorm';
-export declare function enableUuidv4(queryRunner: QueryRunner): Promise<void>;
-//# sourceMappingURL=uuid.d.ts.map

package/dist/migrations/postgres/uuid.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"uuid.d.ts","sourceRoot":"","sources":["../../../src/migrations/postgres/uuid.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAErC,wBAAsB,YAAY,CAAC,WAAW,EAAE,WAAW,iBAS1D"}

package/dist/migrations/postgres/uuid.js

@@ -1,25 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.enableUuidv4 = void 0;
-function enableUuidv4(queryRunner) {
-    return __awaiter(this, void 0, void 0, function* () {
-        try {
-            yield queryRunner.query(`CREATE EXTENSION IF NOT EXISTS "uuid-ossp";`);
-        }
-        catch (error) {
-            console.log(`Please enable the uuid-ossp.control extension in your postgresql installation. It enables generating V4 UUID and can be found in the postgresql-contrib package`);
-            throw error;
-        }
-    });
-}
-exports.enableUuidv4 = enableUuidv4;
-//# sourceMappingURL=uuid.js.map

package/dist/migrations/postgres/uuid.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"uuid.js","sourceRoot":"","sources":["../../../src/migrations/postgres/uuid.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,SAAsB,YAAY,CAAC,WAAwB;;QACzD,IAAI;YACF,MAAM,WAAW,CAAC,KAAK,CAAC,6CAA6C,CAAC,CAAA;SACvE;QAAC,OAAO,KAAK,EAAE;YACd,OAAO,CAAC,GAAG,CACT,iKAAiK,CAClK,CAAA;YACD,MAAM,KAAK,CAAA;SACZ;IACH,CAAC;CAAA;AATD,oCASC"}

package/src/migrations/postgres/uuid.ts

@@ -1,12 +0,0 @@
-import { QueryRunner } from 'typeorm'
-
-export async function enableUuidv4(queryRunner: QueryRunner) {
-  try {
-    await queryRunner.query(`CREATE EXTENSION IF NOT EXISTS "uuid-ossp";`)
-  } catch (error) {
-    console.log(
-      `Please enable the uuid-ossp.control extension in your postgresql installation. It enables generating V4 UUID and can be found in the postgresql-contrib package`
-    )
-    throw error
-  }
-}