@sphereon/ssi-sdk.data-store 0.37.1 → 0.37.2-next.14

package/src/migrations/postgres/1773657426000-AddCredentialDesigns.ts

@@ -0,0 +1,208 @@
+import { MigrationInterface, QueryRunner } from 'typeorm'
+
+export class AddCredentialDesignsPostgres1773657426000 implements MigrationInterface {
+  name = 'AddCredentialDesignsPostgres1773657426000'
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+
+    await queryRunner.query(`
+      CREATE TYPE IF NOT EXISTS "value_type" AS ENUM ('Text', 'Number', 'Boolean', 'Date');
+    `)
+
+    await queryRunner.query(`
+      CREATE TABLE IF NOT EXISTS "meta_data_set"
+      (
+        "id"        uuid NOT NULL DEFAULT gen_random_uuid(),
+        "tenant_id" uuid,
+        "name"      text NOT NULL,
+        CONSTRAINT "meta_data_set_pkey" PRIMARY KEY ("id")
+      )
+    `)
+
+    await queryRunner.query(`
+      CREATE UNIQUE INDEX IF NOT EXISTS "meta_data_set_unique_tenant" ON "meta_data_set" ("name", "tenant_id")
+    `)
+
+    await queryRunner.query(`
+      CREATE TABLE IF NOT EXISTS "meta_data_keys"
+      (
+        "id"         uuid       NOT NULL DEFAULT gen_random_uuid(),
+        "set_id"     uuid       NOT NULL,
+        "key"        text       NOT NULL,
+        "value_type" value_type NOT NULL,
+        CONSTRAINT "meta_data_keys_pkey" PRIMARY KEY ("id"),
+        CONSTRAINT "fk_meta_data_set" FOREIGN KEY ("set_id")
+          REFERENCES "meta_data_set" ("id")
+      )
+    `)
+
+    await queryRunner.query(`
+      CREATE TABLE IF NOT EXISTS "meta_data_values"
+      (
+        "id"              uuid NOT NULL DEFAULT gen_random_uuid(),
+        "key_id"          uuid NOT NULL,
+        "index"           numeric,
+        "text_value"      text,
+        "number_value"    numeric,
+        "boolean_value"   boolean,
+        "timestamp_value" timestamp without time zone,
+        CONSTRAINT "meta_data_values_pkey" PRIMARY KEY ("id"),
+        CONSTRAINT "fk_meta_data_keys" FOREIGN KEY ("key_id")
+          REFERENCES "meta_data_keys" ("id")
+      )
+    `)
+
+    await queryRunner.query(`
+      CREATE TABLE IF NOT EXISTS "form_step"
+      (
+        "id"        uuid NOT NULL DEFAULT gen_random_uuid(),
+        "tenant_id" uuid,
+        "form_id"   text,
+        "step_nr"   numeric,
+        "order"     numeric,
+        CONSTRAINT "formstep_pkey" PRIMARY KEY ("id")
+      )
+    `)
+
+    await queryRunner.query(`
+      CREATE UNIQUE INDEX IF NOT EXISTS "formstep_unique_step" ON "form_step" ("step_nr", "form_id", "order")
+    `)
+
+    await queryRunner.query(`
+      CREATE TABLE IF NOT EXISTS "schema_definition"
+      (
+        "id"                uuid NOT NULL DEFAULT gen_random_uuid(),
+        "tenant_id"         uuid,
+        "extends_id"        uuid,
+        "correlation_id"    text,
+        "schema_type"       text,
+        "entity_type"       text,
+        "schema"            text NOT NULL,
+        "meta_data_set_id"  uuid,
+        CONSTRAINT "schemadef_pkey" PRIMARY KEY ("id"),
+        CONSTRAINT "fk_schemadef_metadata"
+          FOREIGN KEY ("meta_data_set_id")
+            REFERENCES "meta_data_set" ("id")
+      )
+    `)
+
+    await queryRunner.query(`
+      CREATE TABLE IF NOT EXISTS "form_step_to_schema_definition"
+      (
+        "form_step_id"         uuid NOT NULL,
+        "schema_definition_id" uuid NOT NULL,
+        CONSTRAINT "pk_form_step_to_schema_definition" PRIMARY KEY ("form_step_id", "schema_definition_id"),
+        CONSTRAINT "fk_form_step"
+          FOREIGN KEY ("form_step_id")
+            REFERENCES "form_step" ("id"),
+        CONSTRAINT "fk_schema_definition"
+          FOREIGN KEY ("schema_definition_id")
+            REFERENCES "schema_definition" ("id")
+      )
+    `)
+
+    // ── Credential design branding table ────────────────────────────
+    await queryRunner.query(`
+      CREATE TABLE IF NOT EXISTS "credential_design_branding"
+      (
+        "id"                uuid NOT NULL DEFAULT gen_random_uuid(),
+        "logo"              uuid,
+        "background_image"  uuid,
+        "text_color"        text,
+        "background_color"  text,
+        "meta_data_set_id"  uuid,
+        CONSTRAINT "credentialdesignbranding_pkey" PRIMARY KEY ("id"),
+        CONSTRAINT "fk_credentialdesignbranding_metadata" FOREIGN KEY ("meta_data_set_id") REFERENCES "meta_data_set" ("id") ON DELETE CASCADE,
+        CONSTRAINT "unique_meta_data_set_id" UNIQUE ("meta_data_set_id"),
+        CONSTRAINT "fk_branding_logo" FOREIGN KEY ("logo") REFERENCES "ImageAttributes" ("id"),
+        CONSTRAINT "fk_branding_background_image" FOREIGN KEY ("background_image") REFERENCES "ImageAttributes" ("id")
+      );
+    `)
+
+    // ── Cascade FK updates ──────────────────────────────────────────
+    await queryRunner.query(`
+      ALTER TABLE meta_data_keys DROP CONSTRAINT IF EXISTS fk_meta_data_set
+    `)
+    await queryRunner.query(`
+      ALTER TABLE meta_data_keys ADD CONSTRAINT fk_meta_data_set FOREIGN KEY (set_id) REFERENCES meta_data_set(id) ON DELETE CASCADE
+    `)
+
+    await queryRunner.query(`
+      ALTER TABLE schema_definition DROP CONSTRAINT IF EXISTS fk_schemadef_metadata
+    `)
+    await queryRunner.query(`
+      ALTER TABLE schema_definition ADD CONSTRAINT fk_schemadef_metadata FOREIGN KEY (meta_data_set_id) REFERENCES meta_data_set(id) ON DELETE CASCADE
+    `)
+
+    await queryRunner.query(`
+      ALTER TABLE meta_data_values DROP CONSTRAINT IF EXISTS fk_meta_data_keys
+    `)
+    await queryRunner.query(`
+      ALTER TABLE meta_data_values ADD CONSTRAINT fk_meta_data_keys FOREIGN KEY (key_id) REFERENCES meta_data_keys(id) ON DELETE CASCADE
+    `)
+
+    await queryRunner.query(`
+      ALTER TABLE form_step_to_schema_definition DROP CONSTRAINT IF EXISTS form_step_to_schema_definition_schema_definition_id_fkey;
+    `)
+    await queryRunner.query(`
+      ALTER TABLE form_step_to_schema_definition ADD CONSTRAINT form_step_to_schema_definition_schema_definition_id_fkey FOREIGN KEY (schema_definition_id) REFERENCES schema_definition(id) ON DELETE CASCADE;
+    `)
+
+    await queryRunner.query(`
+      ALTER TABLE form_step_to_schema_definition DROP CONSTRAINT IF EXISTS fk_schema_definition;
+    `)
+    await queryRunner.query(`
+      ALTER TABLE form_step_to_schema_definition ADD CONSTRAINT fk_schema_definition FOREIGN KEY (schema_definition_id) REFERENCES schema_definition(id) ON DELETE CASCADE;
+    `)
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    // Restore non-cascade FKs
+    await queryRunner.query(`
+      ALTER TABLE form_step_to_schema_definition DROP CONSTRAINT IF EXISTS fk_schema_definition;
+    `)
+    await queryRunner.query(`
+      ALTER TABLE form_step_to_schema_definition ADD CONSTRAINT fk_schema_definition FOREIGN KEY (schema_definition_id) REFERENCES schema_definition(id);
+    `)
+
+    await queryRunner.query(`
+      ALTER TABLE form_step_to_schema_definition DROP CONSTRAINT IF EXISTS form_step_to_schema_definition_schema_definition_id_fkey;
+    `)
+    await queryRunner.query(`
+      ALTER TABLE form_step_to_schema_definition ADD CONSTRAINT form_step_to_schema_definition_schema_definition_id_fkey FOREIGN KEY (schema_definition_id) REFERENCES schema_definition(id);
+    `)
+
+    await queryRunner.query(`
+      ALTER TABLE meta_data_values DROP CONSTRAINT IF EXISTS fk_meta_data_keys;
+    `)
+    await queryRunner.query(`
+      ALTER TABLE meta_data_values ADD CONSTRAINT fk_meta_data_keys FOREIGN KEY (key_id) REFERENCES meta_data_keys(id);
+    `)
+
+    await queryRunner.query(`
+      ALTER TABLE schema_definition DROP CONSTRAINT IF EXISTS fk_schemadef_metadata;
+    `)
+    await queryRunner.query(`
+      ALTER TABLE schema_definition ADD CONSTRAINT fk_schemadef_metadata FOREIGN KEY (meta_data_set_id) REFERENCES meta_data_set(id);
+    `)
+
+    await queryRunner.query(`
+      ALTER TABLE meta_data_keys DROP CONSTRAINT IF EXISTS fk_meta_data_set;
+    `)
+    await queryRunner.query(`
+      ALTER TABLE meta_data_keys ADD CONSTRAINT fk_meta_data_set FOREIGN KEY (set_id) REFERENCES meta_data_set(id);
+    `)
+
+    // Drop functions and tables
+    await queryRunner.query(`DROP TABLE IF EXISTS "credential_design_branding"`)
+    await queryRunner.query(`DROP TABLE IF EXISTS "form_step_to_schema_definition"`)
+    await queryRunner.query(`DROP TABLE IF EXISTS "schema_definition"`)
+    await queryRunner.query(`DROP INDEX IF EXISTS "formstep_unique_step"`)
+    await queryRunner.query(`DROP TABLE IF EXISTS "form_step"`)
+    await queryRunner.query(`DROP TABLE IF EXISTS "meta_data_values"`)
+    await queryRunner.query(`DROP TABLE IF EXISTS "meta_data_keys"`)
+    await queryRunner.query(`DROP INDEX IF EXISTS "meta_data_set_unique_tenant"`)
+    await queryRunner.query(`DROP TABLE IF EXISTS "meta_data_set"`)
+    await queryRunner.query(`DROP TYPE IF EXISTS "value_type"`)
+  }
+}

package/src/migrations/sqlite/1773657426000-AddCredentialDesigns.ts

@@ -0,0 +1,55 @@
+import { MigrationInterface, QueryRunner } from 'typeorm'
+
+export class AddCredentialDesignsSqlite1773657426000 implements MigrationInterface {
+  name = 'AddCredentialDesignsSqlite1773657426000'
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `CREATE TABLE IF NOT EXISTS "meta_data_set" ("id" varchar PRIMARY KEY NOT NULL, "tenant_id" varchar, "name" text NOT NULL)`,
+    )
+
+    await queryRunner.query(
+      `CREATE UNIQUE INDEX IF NOT EXISTS "meta_data_set_unique_tenant" ON "meta_data_set" ("name", "tenant_id")`,
+    )
+
+    await queryRunner.query(
+      `CREATE TABLE IF NOT EXISTS "meta_data_keys" ("id" varchar PRIMARY KEY NOT NULL, "set_id" varchar NOT NULL, "key" text NOT NULL, "value_type" varchar CHECK( "value_type" IN ('Text','Number','Boolean','Date') ) NOT NULL, CONSTRAINT "fk_meta_data_set" FOREIGN KEY ("set_id") REFERENCES "meta_data_set" ("id") ON DELETE CASCADE ON UPDATE NO ACTION)`,
+    )
+
+    await queryRunner.query(
+      `CREATE TABLE IF NOT EXISTS "meta_data_values" ("id" varchar PRIMARY KEY NOT NULL, "key_id" varchar NOT NULL, "index" integer, "text_value" text, "number_value" real, "boolean_value" boolean, "timestamp_value" datetime, CONSTRAINT "fk_meta_data_keys" FOREIGN KEY ("key_id") REFERENCES "meta_data_keys" ("id") ON DELETE CASCADE ON UPDATE NO ACTION)`,
+    )
+
+    await queryRunner.query(
+      `CREATE TABLE IF NOT EXISTS "form_step" ("id" varchar PRIMARY KEY NOT NULL, "tenant_id" varchar, "form_id" text, "step_nr" integer, "order" integer)`,
+    )
+
+    await queryRunner.query(
+      `CREATE UNIQUE INDEX IF NOT EXISTS "formstep_unique_step" ON "form_step" ("step_nr", "form_id", "order")`,
+    )
+
+    await queryRunner.query(
+      `CREATE TABLE IF NOT EXISTS "schema_definition" ("id" varchar PRIMARY KEY NOT NULL, "tenant_id" varchar, "extends_id" varchar, "correlation_id" text, "schema_type" text, "entity_type" text, "schema" text NOT NULL, "meta_data_set_id" varchar, CONSTRAINT "fk_schemadef_metadata" FOREIGN KEY ("meta_data_set_id") REFERENCES "meta_data_set" ("id") ON DELETE CASCADE ON UPDATE NO ACTION)`,
+    )
+
+    await queryRunner.query(
+      `CREATE TABLE IF NOT EXISTS "form_step_to_schema_definition" ("form_step_id" varchar NOT NULL, "schema_definition_id" varchar NOT NULL, PRIMARY KEY ("form_step_id", "schema_definition_id"), CONSTRAINT "fk_form_step" FOREIGN KEY ("form_step_id") REFERENCES "form_step" ("id") ON DELETE NO ACTION ON UPDATE NO ACTION, CONSTRAINT "fk_schema_definition" FOREIGN KEY ("schema_definition_id") REFERENCES "schema_definition" ("id") ON DELETE CASCADE ON UPDATE NO ACTION)`,
+    )
+
+    await queryRunner.query(
+      `CREATE TABLE IF NOT EXISTS "credential_design_branding" ("id" varchar PRIMARY KEY NOT NULL, "logo" varchar, "background_image" varchar, "text_color" text, "background_color" text, "meta_data_set_id" varchar, CONSTRAINT "unique_meta_data_set_id" UNIQUE ("meta_data_set_id"), CONSTRAINT "fk_credentialdesignbranding_metadata" FOREIGN KEY ("meta_data_set_id") REFERENCES "meta_data_set" ("id") ON DELETE CASCADE ON UPDATE NO ACTION, CONSTRAINT "fk_branding_logo" FOREIGN KEY ("logo") REFERENCES "ImageAttributes" ("id") ON DELETE NO ACTION ON UPDATE NO ACTION, CONSTRAINT "fk_branding_background_image" FOREIGN KEY ("background_image") REFERENCES "ImageAttributes" ("id") ON DELETE NO ACTION ON UPDATE NO ACTION)`,
+    )
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`DROP TABLE IF EXISTS "credential_design_branding"`)
+    await queryRunner.query(`DROP TABLE IF EXISTS "form_step_to_schema_definition"`)
+    await queryRunner.query(`DROP TABLE IF EXISTS "schema_definition"`)
+    await queryRunner.query(`DROP INDEX IF EXISTS "formstep_unique_step"`)
+    await queryRunner.query(`DROP TABLE IF EXISTS "form_step"`)
+    await queryRunner.query(`DROP TABLE IF EXISTS "meta_data_values"`)
+    await queryRunner.query(`DROP TABLE IF EXISTS "meta_data_keys"`)
+    await queryRunner.query(`DROP INDEX IF EXISTS "meta_data_set_unique_tenant"`)
+    await queryRunner.query(`DROP TABLE IF EXISTS "meta_data_set"`)
+  }
+}

package/src/utils/credentialDesign/MappingUtils.ts

@@ -0,0 +1,147 @@
+import type {
+  CredentialDesign,
+  CredentialDesignBranding,
+  IImageAttributes,
+  MetaDataKey,
+  MetaDataValue,
+  NonPersistedCredentialDesignBranding,
+  NonPersistedMetaDataKey,
+  NonPersistedMetaDataValue,
+  NonPersistedSchemaDefinition,
+  SchemaDefinition,
+} from '@sphereon/ssi-sdk.data-store-types'
+import { CredentialDesignBrandingEntity } from '../../entities/credentialDesign'
+import { MetaDataKeyEntity, ValueType } from '../../entities/credentialDesign'
+import { MetaDataSetEntity } from '../../entities/credentialDesign'
+import { MetaDataValueEntity } from '../../entities/credentialDesign'
+import { SchemaDefinitionEntity } from '../../entities/credentialDesign'
+import { ImageAttributesEntity } from '../../entities/issuanceBranding/ImageAttributesEntity'
+import { replaceNullWithUndefined } from '../FormattingUtils'
+import { imageAttributesEntityFrom } from '../issuanceBranding/MappingUtils'
+
+export const credentialDesignFrom = (entity: MetaDataSetEntity): CredentialDesign => {
+  const result: CredentialDesign = {
+    id: entity.id,
+    label: entity.name,
+    tenantId: entity.tenantId,
+    metaDataKeys: entity.metaDataKeys?.map((key) => metaDataKeyFrom(key)) ?? [],
+    schemaDefinitions: entity.schemaDefinitions?.map((schema) => schemaDefinitionFrom(schema)) ?? [],
+    branding: entity.credentialDesignBranding ? credentialDesignBrandingFrom(entity.credentialDesignBranding) : undefined,
+  }
+
+  return replaceNullWithUndefined(result)
+}
+
+export const metaDataKeyFrom = (entity: MetaDataKeyEntity): MetaDataKey => {
+  const result: MetaDataKey = {
+    id: entity.id,
+    key: entity.key,
+    valueType: entity.valueType,
+    metaDataValues: entity.metaDataValues?.map((value) => metaDataValueFrom(value)) ?? [],
+  }
+
+  return replaceNullWithUndefined(result)
+}
+
+export const metaDataValueFrom = (entity: MetaDataValueEntity): MetaDataValue => {
+  const result: MetaDataValue = {
+    id: entity.id,
+    index: entity.index,
+    textValue: entity.textValue,
+    numberValue: entity.numberValue,
+    booleanValue: entity.booleanValue,
+    timestampValue: entity.timestampValue,
+  }
+
+  return replaceNullWithUndefined(result)
+}
+
+export const schemaDefinitionFrom = (entity: SchemaDefinitionEntity): SchemaDefinition => {
+  const result: SchemaDefinition = {
+    id: entity.id,
+    tenantId: entity.tenantId,
+    extendsId: entity.extendsId,
+    correlationId: entity.correlationId,
+    schemaType: entity.schemaType,
+    entityType: entity.entityType,
+    schema: entity.schema,
+  }
+
+  return replaceNullWithUndefined(result)
+}
+
+export const credentialDesignBrandingFrom = (entity: CredentialDesignBrandingEntity): CredentialDesignBranding => {
+  const result: CredentialDesignBranding = {
+    id: entity.id,
+    textColor: entity.textColor,
+    backgroundColor: entity.backgroundColor,
+    logo: entity.logo ? imageAttributesFrom(entity.logo) : undefined,
+    backgroundImage: entity.backgroundImage ? imageAttributesFrom(entity.backgroundImage) : undefined,
+  }
+
+  return replaceNullWithUndefined(result)
+}
+
+export const imageAttributesFrom = (entity: ImageAttributesEntity): IImageAttributes => {
+  const result: IImageAttributes = {
+    id: entity.id,
+    uri: entity.uri,
+    dataUri: entity.dataUri,
+    mediaType: entity.mediaType,
+    alt: entity.alt,
+    dimensions: entity.dimensions
+      ? {
+          id: entity.dimensions.id,
+          width: entity.dimensions.width,
+          height: entity.dimensions.height,
+        }
+      : undefined,
+  }
+
+  return replaceNullWithUndefined(result)
+}
+
+export const metaDataKeyEntityFrom = (input: NonPersistedMetaDataKey): MetaDataKeyEntity => {
+  const keyEntity = new MetaDataKeyEntity()
+  keyEntity.key = input.key
+  keyEntity.valueType = input.valueType as ValueType
+  keyEntity.metaDataValues = input.metaDataValues.map((valInput) => metaDataValueEntityFrom(valInput))
+  return keyEntity
+}
+
+export const metaDataValueEntityFrom = (input: NonPersistedMetaDataValue): MetaDataValueEntity => {
+  const valEntity = new MetaDataValueEntity()
+  valEntity.index = input.index
+  valEntity.textValue = input.textValue
+  valEntity.numberValue = input.numberValue
+  valEntity.booleanValue = input.booleanValue
+  valEntity.timestampValue = input.timestampValue
+  return valEntity
+}
+
+export const schemaDefinitionEntityFrom = (input: NonPersistedSchemaDefinition): SchemaDefinitionEntity => {
+  const schemaEntity = new SchemaDefinitionEntity()
+  schemaEntity.tenantId = input.tenantId
+  schemaEntity.extendsId = input.extendsId
+  schemaEntity.correlationId = input.correlationId
+  schemaEntity.schemaType = input.schemaType
+  schemaEntity.entityType = input.entityType
+  schemaEntity.schema = input.schema
+  return schemaEntity
+}
+
+export const credentialDesignBrandingEntityFrom = (input: NonPersistedCredentialDesignBranding): CredentialDesignBrandingEntity => {
+  const brandingEntity = new CredentialDesignBrandingEntity()
+  brandingEntity.textColor = input.textColor
+  brandingEntity.backgroundColor = input.backgroundColor
+
+  if (input.logo) {
+    brandingEntity.logo = imageAttributesEntityFrom(input.logo)
+  }
+
+  if (input.backgroundImage) {
+    brandingEntity.backgroundImage = imageAttributesEntityFrom(input.backgroundImage)
+  }
+
+  return brandingEntity
+}