@sphereon/ssi-sdk.data-store 0.36.1-feature.integration.fides.88 → 0.36.1-feature.vdx24.einvoice.endpoints.122

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sphereon/ssi-sdk.data-store",
-  "version": "0.36.1-feature.integration.fides.88+5eba8a30",
+  "version": "0.36.1-feature.vdx24.einvoice.endpoints.122+88b3421b",
   "source": "src/index.ts",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -28,13 +28,14 @@
   "dependencies": {
     "@sphereon/kmp-mdoc-core": "0.2.0-SNAPSHOT.26",
     "@sphereon/pex": "5.0.0-unstable.28",
-    "@sphereon/ssi-sdk-ext.did-utils": "0.36.1-feature.integration.fides.88+5eba8a30",
-    "@sphereon/ssi-sdk-ext.identifier-resolution": "0.36.1-feature.integration.fides.88+5eba8a30",
-    "@sphereon/ssi-sdk.agent-config": "0.36.1-feature.integration.fides.88+5eba8a30",
-    "@sphereon/ssi-sdk.core": "0.36.1-feature.integration.fides.88+5eba8a30",
-    "@sphereon/ssi-sdk.data-store-types": "0.36.1-feature.integration.fides.88+5eba8a30",
-    "@sphereon/ssi-types": "0.36.1-feature.integration.fides.88+5eba8a30",
+    "@sphereon/ssi-sdk-ext.did-utils": "0.36.1-feature.vdx24.einvoice.endpoints.122+88b3421b",
+    "@sphereon/ssi-sdk-ext.identifier-resolution": "0.36.1-feature.vdx24.einvoice.endpoints.122+88b3421b",
+    "@sphereon/ssi-sdk.agent-config": "0.36.1-feature.vdx24.einvoice.endpoints.122+88b3421b",
+    "@sphereon/ssi-sdk.core": "0.36.1-feature.vdx24.einvoice.endpoints.122+88b3421b",
+    "@sphereon/ssi-sdk.data-store-types": "0.36.1-feature.vdx24.einvoice.endpoints.122+88b3421b",
+    "@sphereon/ssi-types": "0.36.1-feature.vdx24.einvoice.endpoints.122+88b3421b",
     "@veramo/core": "4.2.0",
+    "@veramo/data-store": "4.2.0",
     "@veramo/utils": "4.2.0",
     "blakejs": "^1.2.1",
     "class-validator": "0.14.1",
@@ -66,5 +67,5 @@
     "PostgreSQL",
     "Contact Store"
   ],
-  "gitHead": "5eba8a30455af768df2d4129f6934bf5c1246715"
+  "gitHead": "88b3421b6e5bc5f630bf5f877c8db095c5850444"
 }

package/src/__tests__/contact.entities.test.ts

@@ -18,7 +18,7 @@ import { PartyEntity } from '../entities/contact/PartyEntity'
 import { PartyRelationshipEntity } from '../entities/contact/PartyRelationshipEntity'
 import { PartyTypeEntity } from '../entities/contact/PartyTypeEntity'
 import { PhysicalAddressEntity } from '../entities/contact/PhysicalAddressEntity'
-import { contactMetadataItemEntityFrom, DataStoreContactEntities, DataStoreMigrations, identityMetadataItemEntityFrom, partyTypeFrom } from '../index'
+import { contactMetadataItemEntityFrom, DataStoreContactEntities, DataStoreEntitiesWithVeramo, DataStoreMigrationsWithVeramo, identityMetadataItemEntityFrom, partyTypeFrom } from '../index'
 import {
   IdentityOrigin,
   MetadataTypes,
@@ -64,9 +64,9 @@ describe('Database entities tests', (): void => {
       database: ':memory:',
       logging: ['info'],
       migrationsRun: false,
-      migrations: DataStoreMigrations,
+      migrations: DataStoreMigrationsWithVeramo,
       synchronize: false,
-      entities: DataStoreContactEntities,
+      entities: DataStoreEntitiesWithVeramo,
     }).initialize()
     await dbConnection.runMigrations()
     expect(await dbConnection.showMigrations()).toBeFalsy()

package/src/__tests__/contact.store.test.ts

@@ -31,7 +31,7 @@ import { CredentialRole } from '@sphereon/ssi-types'
 import { DataSource } from 'typeorm'
 import { afterEach, beforeEach, describe, expect, it } from 'vitest'
 import { ContactStore } from '../contact/ContactStore'
-import { DataStoreContactEntities, DataStoreMigrations } from '../index'
+import { DataStoreContactEntities, DataStoreEntitiesWithVeramo, DataStoreMigrationsWithVeramo } from '../index'
 
 describe('Contact store tests', (): void => {
   let dbConnection: DataSource
@@ -44,9 +44,9 @@ describe('Contact store tests', (): void => {
       database: ':memory:',
       logging: ['info'],
       migrationsRun: false,
-      migrations: DataStoreMigrations,
+      migrations: DataStoreMigrationsWithVeramo,
       synchronize: false,
-      entities: DataStoreContactEntities,
+      entities: DataStoreEntitiesWithVeramo,
     }).initialize()
     await dbConnection.runMigrations()
     expect(await dbConnection.showMigrations()).toBeFalsy()

package/src/__tests__/issuanceBranding.entities.test.ts

@@ -6,7 +6,7 @@ import {
   credentialBrandingEntityFrom,
   CredentialLocaleBrandingEntity,
   credentialLocaleBrandingEntityFrom,
-  DataStoreIssuanceBrandingEntities,
+  DataStoreIssuanceBrandingEntities, DataStoreEntitiesWithVeramo,
   IBasicCredentialBranding,
   IBasicCredentialLocaleBranding,
   IBasicIssuerBranding,
@@ -16,7 +16,7 @@ import {
   IssuerLocaleBrandingEntity,
   issuerLocaleBrandingEntityFrom,
 } from '../index'
-import { DataStoreMigrations } from '../migrations'
+import { DataStoreMigrationsWithVeramo } from '../migrations'
 
 describe('Database entities tests', (): void => {
   let dbConnection: DataSource
@@ -28,9 +28,9 @@ describe('Database entities tests', (): void => {
       database: ':memory:',
       //logging: ['info'],
       migrationsRun: false,
-      migrations: DataStoreMigrations,
+      migrations: DataStoreMigrationsWithVeramo,
       synchronize: false,
-      entities: DataStoreIssuanceBrandingEntities,
+      entities: DataStoreEntitiesWithVeramo,
     }).initialize()
     await dbConnection.runMigrations()
     expect(await dbConnection.showMigrations()).toBeFalsy()

package/src/__tests__/issuanceBranding.store.test.ts

@@ -4,7 +4,7 @@ import { afterEach, beforeEach, describe, expect, it } from 'vitest'
 import {
   BackgroundAttributesEntity,
   CredentialLocaleBrandingEntity,
-  DataStoreIssuanceBrandingEntities,
+  DataStoreIssuanceBrandingEntities, DataStoreEntitiesWithVeramo,
   IAddCredentialLocaleBrandingArgs,
   IAddIssuerLocaleBrandingArgs,
   IBasicCredentialBranding,
@@ -26,7 +26,7 @@ import {
   TextAttributesEntity,
 } from '../index'
 import { IssuanceBrandingStore } from '../issuanceBranding/IssuanceBrandingStore'
-import { DataStoreMigrations } from '../migrations'
+import { DataStoreMigrationsWithVeramo } from '../migrations'
 
 describe('Issuance branding store tests', (): void => {
   let dbConnection: DataSource
@@ -39,9 +39,9 @@ describe('Issuance branding store tests', (): void => {
       database: ':memory:',
       //logging: ['info'],
       migrationsRun: false,
-      migrations: DataStoreMigrations,
+      migrations: DataStoreMigrationsWithVeramo,
       synchronize: false,
-      entities: DataStoreIssuanceBrandingEntities,
+      entities: DataStoreEntitiesWithVeramo,
     }).initialize()
     await dbConnection.runMigrations()
     expect(await dbConnection.showMigrations()).toBeFalsy()

package/src/index.ts

@@ -1,3 +1,4 @@
+import { Entities as VeramoDataStoreEntities } from '@veramo/data-store'
 import { BaseConfigEntity } from './entities/contact/BaseConfigEntity'
 import { BaseContactEntity } from './entities/contact/BaseContactEntity'
 import { ConnectionEntity } from './entities/contact/ConnectionEntity'
@@ -46,6 +47,7 @@ export { MachineStateStore } from './machineState/MachineStateStore'
 export { PDStore } from './presentationDefinition/PDStore'
 export {
   DataStoreMigrations,
+  DataStoreMigrationsWithVeramo,
   DataStoreEventLoggerMigrations,
   DataStoreContactMigrations,
   DataStoreDigitalCredentialMigrations,
@@ -53,6 +55,9 @@ export {
   DataStoreStatusListMigrations,
   DataStoreMachineStateMigrations,
   DataStorePresentationDefinitionMigrations,
+  DataStoreServiceMigrations,
+  VeramoDataStoreMigrations,
+  VeramoDataStoreEntities,
 } from './migrations'
 export * from './types'
 export * from './utils/contact/MappingUtils'
@@ -123,6 +128,12 @@ export const DataStoreEntities = [
   // ...DataStoreOid4vcStateEntities,
 ]
 
+// All entities combined with Veramo entities if a party wants to enable them all at once
+export const DataStoreEntitiesWithVeramo = [
+  ...VeramoDataStoreEntities,
+  ...DataStoreEntities,
+]
+
 export {
   BaseConfigEntity,
   ConnectionEntity,

package/src/migrations/generic/15-AddServiceMetadata.ts

@@ -0,0 +1,66 @@
+import Debug, { Debugger } from 'debug'
+import { DatabaseType, MigrationInterface, QueryRunner } from 'typeorm'
+import { AddServiceMetadata1764000000001 } from '../postgres/1764000000001-AddServiceMetadata'
+import { AddServiceMetadata1764000000002 } from '../sqlite/1764000000002-AddServiceMetadata'
+
+const debug: Debugger = Debug('sphereon:ssi-sdk:migrations')
+
+export class AddServiceMetadata1764000000000 implements MigrationInterface {
+  name: string = 'AddServiceMetadata1764000000000'
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    debug('migration: adding metadata column to service table')
+    const dbType: DatabaseType = queryRunner.connection.driver.options.type
+
+    switch (dbType) {
+      case 'postgres': {
+        debug('using postgres migration file for AddServiceMetadata')
+        const mig: AddServiceMetadata1764000000001 = new AddServiceMetadata1764000000001()
+        await mig.up(queryRunner)
+        debug('Postgres migration statements for AddServiceMetadata executed')
+        return
+      }
+      case 'sqlite':
+      case 'expo':
+      case 'react-native': {
+        debug('using sqlite/react-native migration file for AddServiceMetadata')
+        const mig: AddServiceMetadata1764000000002 = new AddServiceMetadata1764000000002()
+        await mig.up(queryRunner)
+        debug('SQLite migration statements for AddServiceMetadata executed')
+        return
+      }
+      default:
+        return Promise.reject(
+          `Migrations are currently only supported for sqlite, react-native, expo, and postgres for AddServiceMetadata. 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 metadata column from service table')
+    const dbType: DatabaseType = queryRunner.connection.driver.options.type
+
+    switch (dbType) {
+      case 'postgres': {
+        debug('using postgres migration file for AddServiceMetadata')
+        const mig: AddServiceMetadata1764000000001 = new AddServiceMetadata1764000000001()
+        await mig.down(queryRunner)
+        debug('Postgres migration statements for AddServiceMetadata reverted')
+        return
+      }
+      case 'sqlite':
+      case 'expo':
+      case 'react-native': {
+        debug('using sqlite/react-native migration file for AddServiceMetadata')
+        const mig: AddServiceMetadata1764000000002 = new AddServiceMetadata1764000000002()
+        await mig.down(queryRunner)
+        debug('SQLite migration statements for AddServiceMetadata reverted')
+        return
+      }
+      default:
+        return Promise.reject(
+          `Migrations are currently only supported for sqlite, react-native, expo, and postgres for AddServiceMetadata. Was ${dbType}. Please run your database without migrations and with 'migrationsRun: false' and 'synchronize: true' for now`,
+        )
+    }
+  }
+}

package/src/migrations/generic/index.ts

@@ -1,9 +1,11 @@
+import { migrations as VeramoDataStoreMigrations, Entities as VeramoDataStoreEntities } from '@veramo/data-store'
 import { CreateContacts1659463079429 } from './1-CreateContacts'
 import { CreatePresentationDefinitions1716533767523 } from './10-CreatePresentationDefinitions'
 import { FixCredentialClaimsReferencesUuid1741895822987 } from './11-FixCredentialClaimsReferenceUuid'
 import { AddBitstringStatusListEnum1741895823000, CreateBitstringStatusList1741895823000 } from './12-CreateBitstringStatusList'
 import { CreateDcqlQueryItem1726617600000 } from './13-CreateDcqlQueryItem'
 import { AddLinkedVpFields1763387280000 } from './14-AddLinkedVpFields'
+import { AddServiceMetadata1764000000000 } from './15-AddServiceMetadata'
 import { CreateIssuanceBranding1659463079429 } from './2-CreateIssuanceBranding'
 import { CreateContacts1690925872318 } from './3-CreateContacts'
 import { CreateStatusList1693866470000 } from './4-CreateStatusList'
@@ -38,6 +40,7 @@ export const DataStoreEventLoggerMigrations = [CreateAuditEvents1701635835330]
 export const DataStoreDigitalCredentialMigrations = [CreateDigitalCredential1708525189000, AddLinkedVpFields1763387280000]
 export const DataStoreMachineStateMigrations = [CreateMachineStateStore1708098041262]
 export const DataStorePresentationDefinitionMigrations = [CreatePresentationDefinitions1716533767523, CreateDcqlQueryItem1726617600000]
+export const DataStoreServiceMigrations = [AddServiceMetadata1764000000000]
 
 // All migrations together
 export const DataStoreMigrations = [
@@ -48,4 +51,14 @@ export const DataStoreMigrations = [
   ...DataStoreDigitalCredentialMigrations,
   ...DataStoreMachineStateMigrations,
   ...DataStorePresentationDefinitionMigrations,
+  ...DataStoreServiceMigrations,
 ]
+
+// All migrations combined with Veramo migrations first - use this when you need both
+export const DataStoreMigrationsWithVeramo = [
+  ...VeramoDataStoreMigrations,
+  ...DataStoreMigrations,
+]
+
+// Re-export Veramo migrations and entities for convenience
+export { VeramoDataStoreMigrations, VeramoDataStoreEntities }

package/src/migrations/index.ts

@@ -1,5 +1,6 @@
 export {
   DataStoreMigrations,
+  DataStoreMigrationsWithVeramo,
   DataStoreEventLoggerMigrations,
   DataStoreContactMigrations,
   DataStoreIssuanceBrandingMigrations,
@@ -7,4 +8,7 @@ export {
   DataStoreDigitalCredentialMigrations,
   DataStoreMachineStateMigrations,
   DataStorePresentationDefinitionMigrations,
+  DataStoreServiceMigrations,
+  VeramoDataStoreMigrations,
+  VeramoDataStoreEntities,
 } from './generic'

package/src/migrations/postgres/1764000000001-AddServiceMetadata.ts

@@ -0,0 +1,44 @@
+import Debug, { Debugger } from 'debug'
+import { MigrationInterface, QueryRunner } from 'typeorm'
+
+const debug: Debugger = Debug('sphereon:ssi-sdk:migrations')
+
+export class AddServiceMetadata1764000000001 implements MigrationInterface {
+  name = 'AddServiceMetadata1764000000001'
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    // Check if the service table exists (created by Veramo migrations)
+    const table = await queryRunner.getTable('service')
+    if (!table) {
+      // Service table doesn't exist - Veramo DID Manager is not in use
+      // Skip this migration as there's no service table to modify
+      debug(
+        'AddServiceMetadata: Skipping migration - service table does not exist. ' +
+        'This is expected if Veramo DID Manager is not being used. ' +
+        'If you need service metadata support, ensure Veramo migrations run before SSI-SDK migrations.'
+      )
+      console.warn(
+        '[SSI-SDK Migration] AddServiceMetadata: Skipping - service table does not exist (Veramo DID Manager not in use)'
+      )
+      return
+    }
+
+    await queryRunner.query(`
+      ALTER TABLE "service"
+      ADD COLUMN IF NOT EXISTS "metadata" jsonb
+    `)
+    debug('AddServiceMetadata: Added metadata column to service table')
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    const table = await queryRunner.getTable('service')
+    if (!table) {
+      return
+    }
+    
+    await queryRunner.query(`
+      ALTER TABLE "service"
+      DROP COLUMN IF EXISTS "metadata"
+    `)
+  }
+}

package/src/migrations/sqlite/1764000000002-AddServiceMetadata.ts

@@ -0,0 +1,41 @@
+import Debug, { Debugger } from 'debug'
+import { MigrationInterface, QueryRunner } from 'typeorm'
+
+const debug: Debugger = Debug('sphereon:ssi-sdk:migrations')
+
+export class AddServiceMetadata1764000000002 implements MigrationInterface {
+  name = 'AddServiceMetadata1764000000002'
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    // Check if the service table exists (created by Veramo migrations)
+    const table = await queryRunner.getTable('service')
+    if (!table) {
+      // Service table doesn't exist - Veramo DID Manager is not in use
+      // Skip this migration as there's no service table to modify
+      debug(
+        'AddServiceMetadata: Skipping migration - service table does not exist. ' +
+        'This is expected if Veramo DID Manager is not being used. ' +
+        'If you need service metadata support, ensure Veramo migrations run before SSI-SDK migrations.'
+      )
+      console.warn(
+        '[SSI-SDK Migration] AddServiceMetadata: Skipping - service table does not exist (Veramo DID Manager not in use)'
+      )
+      return
+    }
+
+    // Check if metadata column already exists
+    const hasMetadataColumn = table.columns.some((col) => col.name === 'metadata')
+    if (!hasMetadataColumn) {
+      await queryRunner.query(`
+        ALTER TABLE "service"
+        ADD COLUMN "metadata" text
+      `)
+      debug('AddServiceMetadata: Added metadata column to service table')
+    }
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    // SQLite doesn't support DROP COLUMN directly
+    // Also, if the service table doesn't exist, nothing to do
+  }
+}