@sphereon/ssi-sdk.data-store 0.36.1-next.153 → 0.36.1-next.155

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sphereon/ssi-sdk.data-store",
-  "version": "0.36.1-next.153+e4f2b9e7",
+  "version": "0.36.1-next.155+32138ae6",
   "source": "src/index.ts",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -28,12 +28,12 @@
   "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-next.153+e4f2b9e7",
-    "@sphereon/ssi-sdk-ext.identifier-resolution": "0.36.1-next.153+e4f2b9e7",
-    "@sphereon/ssi-sdk.agent-config": "0.36.1-next.153+e4f2b9e7",
-    "@sphereon/ssi-sdk.core": "0.36.1-next.153+e4f2b9e7",
-    "@sphereon/ssi-sdk.data-store-types": "0.36.1-next.153+e4f2b9e7",
-    "@sphereon/ssi-types": "0.36.1-next.153+e4f2b9e7",
+    "@sphereon/ssi-sdk-ext.did-utils": "0.36.1-next.155+32138ae6",
+    "@sphereon/ssi-sdk-ext.identifier-resolution": "0.36.1-next.155+32138ae6",
+    "@sphereon/ssi-sdk.agent-config": "0.36.1-next.155+32138ae6",
+    "@sphereon/ssi-sdk.core": "0.36.1-next.155+32138ae6",
+    "@sphereon/ssi-sdk.data-store-types": "0.36.1-next.155+32138ae6",
+    "@sphereon/ssi-types": "0.36.1-next.155+32138ae6",
     "@veramo/core": "4.2.0",
     "@veramo/data-store": "4.2.0",
     "@veramo/utils": "4.2.0",
@@ -67,5 +67,5 @@
     "PostgreSQL",
     "Contact Store"
   ],
-  "gitHead": "e4f2b9e7fb8fac668483633c8604f863357107fa"
+  "gitHead": "32138ae6119b77cc823033097aa0912dd905cf07"
 }

package/src/entities/issuanceBranding/CredentialClaimsEntity.ts

@@ -17,6 +17,9 @@ export class CredentialClaimsEntity extends BaseEntity {
   @Validate(IsNonEmptyStringConstraint, { message: 'Blank claim names are not allowed' })
   name!: string
 
+  @Column('integer', { name: 'order', nullable: true })
+  order?: number
+
   @ManyToOne(() => CredentialLocaleBrandingEntity, (credentialLocaleBranding: CredentialLocaleBrandingEntity) => credentialLocaleBranding.claims, {
     cascade: ['insert', 'update'],
     onDelete: 'CASCADE',

package/src/migrations/generic/17-AddCredentialClaimOrder.ts

@@ -0,0 +1,64 @@
+import Debug from 'debug'
+import { DatabaseType, MigrationInterface, QueryRunner } from 'typeorm'
+import { AddCredentialClaimOrderPostgres1768000000000 } from '../postgres/1768000000000-AddCredentialClaimOrder'
+import { AddCredentialClaimOrderSqlite1768000000000 } from '../sqlite/1768000000000-AddCredentialClaimOrder'
+
+const debug: Debug.Debugger = Debug('sphereon:ssi-sdk:migrations')
+
+export class AddCredentialClaimOrder1768000000000 implements MigrationInterface {
+  name = 'AddCredentialClaimOrder1768000000000'
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    debug('migration: adding credential claim order column')
+    const dbType: DatabaseType = queryRunner.connection.driver.options.type
+    switch (dbType) {
+      case 'postgres': {
+        debug('using postgres migration file')
+        const mig: AddCredentialClaimOrderPostgres1768000000000 = new AddCredentialClaimOrderPostgres1768000000000()
+        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: AddCredentialClaimOrderSqlite1768000000000 = new AddCredentialClaimOrderSqlite1768000000000()
+        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: removing credential claim order column')
+    const dbType: DatabaseType = queryRunner.connection.driver.options.type
+    switch (dbType) {
+      case 'postgres': {
+        debug('using postgres migration file')
+        const mig: AddCredentialClaimOrderPostgres1768000000000 = new AddCredentialClaimOrderPostgres1768000000000()
+        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: AddCredentialClaimOrderSqlite1768000000000 = new AddCredentialClaimOrderSqlite1768000000000()
+        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

@@ -8,6 +8,7 @@ import { AddLinkedVpFields1763387280000 } from './14-AddLinkedVpFields'
 import { AddBrandingState1766000000000 } from './15-AddBrandingState'
 import { AddServiceMetadata1764000000000 } from './15-AddServiceMetadata'
 import { MakeOpenIdClientSecretNullable1767000000000 } from './16-MakeOpenIdClientSecretNullable'
+import { AddCredentialClaimOrder1768000000000 } from './17-AddCredentialClaimOrder'
 import { CreateIssuanceBranding1659463079429 } from './2-CreateIssuanceBranding'
 import { CreateContacts1690925872318 } from './3-CreateContacts'
 import { CreateStatusList1693866470000 } from './4-CreateStatusList'
@@ -37,6 +38,7 @@ export const DataStoreIssuanceBrandingMigrations = [
   CreateIssuanceBranding1659463079429,
   FixCredentialClaimsReferencesUuid1741895822987,
   AddBrandingState1766000000000,
+  AddCredentialClaimOrder1768000000000,
 ]
 export const DataStoreStatusListMigrations = [
   CreateStatusList1693866470000,

package/src/migrations/postgres/1768000000000-AddCredentialClaimOrder.ts

@@ -0,0 +1,13 @@
+import { MigrationInterface, QueryRunner } from 'typeorm'
+
+export class AddCredentialClaimOrderPostgres1768000000000 implements MigrationInterface {
+  name = 'AddCredentialClaimOrder1768000000000'
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`ALTER TABLE "CredentialClaims" ADD "order" integer`)
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`ALTER TABLE "CredentialClaims" DROP COLUMN "order"`)
+  }
+}

package/src/migrations/sqlite/1768000000000-AddCredentialClaimOrder.ts

@@ -0,0 +1,34 @@
+import { MigrationInterface, QueryRunner } from 'typeorm'
+
+export class AddCredentialClaimOrderSqlite1768000000000 implements MigrationInterface {
+  name = 'AddCredentialClaimOrder1768000000000'
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`ALTER TABLE "CredentialClaims" ADD COLUMN "order" integer`)
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    // SQLite doesn't support DROP COLUMN directly; recreate table without order
+    await queryRunner.query(`PRAGMA foreign_keys = OFF`)
+    await queryRunner.query(`
+      CREATE TABLE "CredentialClaims_old" (
+        "id" varchar PRIMARY KEY NOT NULL,
+        "key" varchar(255) NOT NULL,
+        "name" varchar(255) NOT NULL,
+        "credentialLocaleBrandingId" varchar,
+        CONSTRAINT "FK_CredentialClaims_credentialLocaleBrandingId" FOREIGN KEY ("credentialLocaleBrandingId") REFERENCES "BaseLocaleBranding" ("id") ON DELETE CASCADE ON UPDATE NO ACTION
+      )
+    `)
+    await queryRunner.query(`
+      INSERT INTO "CredentialClaims_old" ("id", "key", "name", "credentialLocaleBrandingId")
+      SELECT "id", "key", "name", "credentialLocaleBrandingId"
+      FROM "CredentialClaims"
+    `)
+    await queryRunner.query(`DROP TABLE "CredentialClaims"`)
+    await queryRunner.query(`ALTER TABLE "CredentialClaims_old" RENAME TO "CredentialClaims"`)
+    await queryRunner.query(
+      `CREATE UNIQUE INDEX "IDX_CredentialClaimsEntity_credentialLocaleBranding_locale" ON "CredentialClaims" ("credentialLocaleBrandingId", "key")`,
+    )
+    await queryRunner.query(`PRAGMA foreign_keys = ON`)
+  }
+}

package/src/utils/issuanceBranding/MappingUtils.ts

@@ -65,6 +65,7 @@ export const credentialLocaleBrandingFromEntity = (localeBranding: CredentialLoc
           id: claim.id,
           key: claim.key,
           name: claim.name,
+          ...(claim.order != null && { order: claim.order }),
         }))
       : undefined,
   } as ICredentialLocaleBranding
@@ -160,6 +161,7 @@ export const credentialClaimsEntityFrom = (args: IBasicCredentialClaim): Credent
   const credentialClaimsEntity: CredentialClaimsEntity = new CredentialClaimsEntity()
   credentialClaimsEntity.key = args.key
   credentialClaimsEntity.name = args.name
+  credentialClaimsEntity.order = args.order
 
   return credentialClaimsEntity
 }