@sphereon/ssi-sdk.data-store 0.23.5-unstable.88 → 0.24.0

package/src/entities/issuanceBranding/IssuerBrandingEntity.ts

@@ -1,72 +1,72 @@
-import {
-  BaseEntity,
-  BeforeInsert,
-  BeforeUpdate,
-  Column,
-  CreateDateColumn,
-  Entity,
-  Index,
-  OneToMany,
-  PrimaryGeneratedColumn,
-  UpdateDateColumn,
-} from 'typeorm'
-import { ArrayMinSize, IsNotEmpty, validate, ValidationError } from 'class-validator'
-import { IssuerLocaleBrandingEntity, issuerLocaleBrandingEntityFrom } from './IssuerLocaleBrandingEntity'
-import { IBasicIssuerBranding, IBasicIssuerLocaleBranding } from '../../types'
-
-@Entity('IssuerBranding')
-@Index('IDX_IssuerBrandingEntity_issuerCorrelationId', ['issuerCorrelationId'])
-export class IssuerBrandingEntity extends BaseEntity {
-  @PrimaryGeneratedColumn('uuid')
-  id!: string
-
-  @Column({ name: 'issuerCorrelationId', length: 255, nullable: false, unique: true })
-  @IsNotEmpty({ message: 'Blank issuerCorrelationIds are not allowed' })
-  issuerCorrelationId!: string
-
-  @OneToMany(
-    () => IssuerLocaleBrandingEntity,
-    (issuerLocaleBrandingEntity: IssuerLocaleBrandingEntity) => issuerLocaleBrandingEntity.issuerBranding,
-    {
-      cascade: true,
-      onDelete: 'CASCADE',
-      eager: true,
-      nullable: false,
-    },
-  )
-  @ArrayMinSize(1, { message: 'localeBranding cannot be empty' })
-  localeBranding!: Array<IssuerLocaleBrandingEntity>
-
-  @CreateDateColumn({ name: 'created_at', nullable: false })
-  createdAt!: Date
-
-  @UpdateDateColumn({ name: 'last_updated_at', nullable: false })
-  lastUpdatedAt!: Date
-
-  // By default, @UpdateDateColumn in TypeORM updates the timestamp only when the entity's top-level properties change.
-  @BeforeInsert()
-  @BeforeUpdate()
-  updateUpdatedDate(): void {
-    this.lastUpdatedAt = new Date()
-  }
-
-  @BeforeInsert()
-  @BeforeUpdate()
-  async validate(): Promise<undefined> {
-    const validation: Array<ValidationError> = await validate(this)
-    if (validation.length > 0) {
-      return Promise.reject(Error(Object.values(validation[0].constraints!)[0]))
-    }
-    return
-  }
-}
-
-export const issuerBrandingEntityFrom = (args: IBasicIssuerBranding): IssuerBrandingEntity => {
-  const issuerBrandingEntity: IssuerBrandingEntity = new IssuerBrandingEntity()
-  issuerBrandingEntity.issuerCorrelationId = args.issuerCorrelationId
-  issuerBrandingEntity.localeBranding = args.localeBranding.map((localeBranding: IBasicIssuerLocaleBranding) =>
-    issuerLocaleBrandingEntityFrom(localeBranding),
-  )
-
-  return issuerBrandingEntity
-}
+import {
+  BaseEntity,
+  BeforeInsert,
+  BeforeUpdate,
+  Column,
+  CreateDateColumn,
+  Entity,
+  Index,
+  OneToMany,
+  PrimaryGeneratedColumn,
+  UpdateDateColumn,
+} from 'typeorm'
+import { ArrayMinSize, IsNotEmpty, validate, ValidationError } from 'class-validator'
+import { IssuerLocaleBrandingEntity, issuerLocaleBrandingEntityFrom } from './IssuerLocaleBrandingEntity'
+import { IBasicIssuerBranding, IBasicIssuerLocaleBranding } from '../../types'
+
+@Entity('IssuerBranding')
+@Index('IDX_IssuerBrandingEntity_issuerCorrelationId', ['issuerCorrelationId'])
+export class IssuerBrandingEntity extends BaseEntity {
+  @PrimaryGeneratedColumn('uuid')
+  id!: string
+
+  @Column({ name: 'issuerCorrelationId', length: 255, nullable: false, unique: true })
+  @IsNotEmpty({ message: 'Blank issuerCorrelationIds are not allowed' })
+  issuerCorrelationId!: string
+
+  @OneToMany(
+    () => IssuerLocaleBrandingEntity,
+    (issuerLocaleBrandingEntity: IssuerLocaleBrandingEntity) => issuerLocaleBrandingEntity.issuerBranding,
+    {
+      cascade: true,
+      onDelete: 'CASCADE',
+      eager: true,
+      nullable: false,
+    },
+  )
+  @ArrayMinSize(1, { message: 'localeBranding cannot be empty' })
+  localeBranding!: Array<IssuerLocaleBrandingEntity>
+
+  @CreateDateColumn({ name: 'created_at', nullable: false })
+  createdAt!: Date
+
+  @UpdateDateColumn({ name: 'last_updated_at', nullable: false })
+  lastUpdatedAt!: Date
+
+  // By default, @UpdateDateColumn in TypeORM updates the timestamp only when the entity's top-level properties change.
+  @BeforeInsert()
+  @BeforeUpdate()
+  updateUpdatedDate(): void {
+    this.lastUpdatedAt = new Date()
+  }
+
+  @BeforeInsert()
+  @BeforeUpdate()
+  async validate(): Promise<undefined> {
+    const validation: Array<ValidationError> = await validate(this)
+    if (validation.length > 0) {
+      return Promise.reject(Error(Object.values(validation[0].constraints!)[0]))
+    }
+    return
+  }
+}
+
+export const issuerBrandingEntityFrom = (args: IBasicIssuerBranding): IssuerBrandingEntity => {
+  const issuerBrandingEntity: IssuerBrandingEntity = new IssuerBrandingEntity()
+  issuerBrandingEntity.issuerCorrelationId = args.issuerCorrelationId
+  issuerBrandingEntity.localeBranding = args.localeBranding.map((localeBranding: IBasicIssuerLocaleBranding) =>
+    issuerLocaleBrandingEntityFrom(localeBranding),
+  )
+
+  return issuerBrandingEntity
+}

package/src/entities/machineState/MachineStateInfoEntity.ts

@@ -1,58 +1,58 @@
-import { BaseEntity, Column, CreateDateColumn, Entity, PrimaryColumn, UpdateDateColumn } from 'typeorm'
-
-/**
- * @class MachineStateInfoEntity
- * Represents a machine state. It allows to continue a machine at a later point in time at the point it was left of
- *
- * @param {string} instanceId - The instance ID of the machine state.
- * @param {string} [sessionId] - The session ID of the machine state. (optional)
- * @param {string} machineName - The name of the machine.
- * @param {string} [latestStateName] - The name of the latest state. (optional)
- * @param {string} latestEventType - The type of the latest event.
- * @param {string} state - The current state of the machine.
- * @param {Date} createdAt - The date and time when the machine state was created.
- * @param {Date} updatedAt - The date and time when the machine state was last updated.
- * @param {number} updatedCount - The number of times the machine state has been updated.
- * @param {Date} [expiresAt] - The date and time when the machine state expires. (optional)
- * @param {Date} [completedAt] - The date and time when the machine state was completed. (optional)
- * @param {string} [tenantId] - The ID of the tenant associated with the machine state. (optional)
- */
-@Entity('MachineStateInfoEntity')
-export class MachineStateInfoEntity extends BaseEntity {
-  @PrimaryColumn({ name: 'instance_id', type: 'varchar', nullable: false })
-  instanceId!: string
-
-  @Column({ name: 'session_id', type: 'varchar', nullable: true })
-  sessionId?: string
-
-  // Xstate moved to name instead of instanceId for V5. Also makes more sense
-  @Column({ name: 'machine_name', type: 'varchar', nullable: false })
-  machineName!: string
-
-  @Column({ name: 'latest_state_name', type: 'varchar', nullable: true })
-  latestStateName?: string
-
-  @Column({ name: 'latest_event_type', type: 'varchar', nullable: false })
-  latestEventType!: string
-
-  @Column({ name: 'state', type: 'text', nullable: false })
-  state!: string
-
-  @CreateDateColumn({ name: 'created_at', type: 'datetime', nullable: false })
-  createdAt!: Date
-
-  @UpdateDateColumn({ name: 'updated_at', type: 'datetime', nullable: false })
-  updatedAt!: Date
-
-  @Column({ name: 'updated_count', type: 'integer', nullable: false })
-  updatedCount!: number
-
-  @Column({ name: 'expires_at', type: 'datetime', nullable: true })
-  expiresAt?: Date
-
-  @Column({ name: 'completed_at', type: 'datetime', nullable: true })
-  completedAt?: Date
-
-  @Column({ name: 'tenant_id', type: 'varchar', nullable: true })
-  tenantId?: string
-}
+import { BaseEntity, Column, CreateDateColumn, Entity, PrimaryColumn, UpdateDateColumn } from 'typeorm'
+
+/**
+ * @class MachineStateInfoEntity
+ * Represents a machine state. It allows to continue a machine at a later point in time at the point it was left of
+ *
+ * @param {string} instanceId - The instance ID of the machine state.
+ * @param {string} [sessionId] - The session ID of the machine state. (optional)
+ * @param {string} machineName - The name of the machine.
+ * @param {string} [latestStateName] - The name of the latest state. (optional)
+ * @param {string} latestEventType - The type of the latest event.
+ * @param {string} state - The current state of the machine.
+ * @param {Date} createdAt - The date and time when the machine state was created.
+ * @param {Date} updatedAt - The date and time when the machine state was last updated.
+ * @param {number} updatedCount - The number of times the machine state has been updated.
+ * @param {Date} [expiresAt] - The date and time when the machine state expires. (optional)
+ * @param {Date} [completedAt] - The date and time when the machine state was completed. (optional)
+ * @param {string} [tenantId] - The ID of the tenant associated with the machine state. (optional)
+ */
+@Entity('MachineStateInfoEntity')
+export class MachineStateInfoEntity extends BaseEntity {
+  @PrimaryColumn({ name: 'instance_id', type: 'varchar', nullable: false })
+  instanceId!: string
+
+  @Column({ name: 'session_id', type: 'varchar', nullable: true })
+  sessionId?: string
+
+  // Xstate moved to name instead of instanceId for V5. Also makes more sense
+  @Column({ name: 'machine_name', type: 'varchar', nullable: false })
+  machineName!: string
+
+  @Column({ name: 'latest_state_name', type: 'varchar', nullable: true })
+  latestStateName?: string
+
+  @Column({ name: 'latest_event_type', type: 'varchar', nullable: false })
+  latestEventType!: string
+
+  @Column({ name: 'state', type: 'text', nullable: false })
+  state!: string
+
+  @CreateDateColumn({ name: 'created_at', type: 'datetime', nullable: false })
+  createdAt!: Date
+
+  @UpdateDateColumn({ name: 'updated_at', type: 'datetime', nullable: false })
+  updatedAt!: Date
+
+  @Column({ name: 'updated_count', type: 'integer', nullable: false })
+  updatedCount!: number
+
+  @Column({ name: 'expires_at', type: 'datetime', nullable: true })
+  expiresAt?: Date
+
+  @Column({ name: 'completed_at', type: 'datetime', nullable: true })
+  completedAt?: Date
+
+  @Column({ name: 'tenant_id', type: 'varchar', nullable: true })
+  tenantId?: string
+}

package/src/entities/statusList2021/StatusList2021Entity.ts

@@ -1,96 +1,96 @@
-import {
-  IIssuer,
-  JwtDecodedVerifiableCredential,
-  StatusListCredentialIdMode,
-  StatusListDriverType,
-  StatusListIndexingDirection,
-  StatusListType,
-  StatusPurpose2021,
-  W3CVerifiableCredential,
-} from '@sphereon/ssi-types'
-import { ProofFormat } from '@veramo/core'
-import { BaseEntity, Column, Entity, OneToMany, PrimaryColumn, Unique } from 'typeorm'
-import { StatusListEntryEntity } from './StatusList2021EntryEntity'
-
-@Entity('StatusList')
-@Unique('UQ_correlationId', ['correlationId'])
-export class StatusListEntity extends BaseEntity {
-  @PrimaryColumn({ name: 'id', type: 'varchar' })
-  id!: string
-
-  @Column({ name: 'correlationId', type: 'varchar', nullable: false })
-  correlationId!: string
-
-  @Column({ name: 'length', nullable: false, unique: false })
-  length!: number
-
-  @Column({
-    name: 'issuer',
-    type: 'text',
-    nullable: false,
-    unique: false,
-    transformer: {
-      from(value: string): string | IIssuer {
-        if (value?.trim()?.startsWith('{')) {
-          return JSON.parse(value)
-        }
-        return value
-      },
-      to(value: string | IIssuer): string {
-        if (typeof value === 'string') {
-          return value
-        }
-        return JSON.stringify(value)
-      },
-    },
-  })
-  issuer!: string | IIssuer
-
-  @Column('simple-enum', { name: 'type', enum: StatusListType, nullable: false, default: StatusListType.StatusList2021 })
-  type!: StatusListType
-
-  @Column('simple-enum', { name: 'driverType', enum: StatusListDriverType, nullable: false, default: StatusListDriverType.AGENT_TYPEORM })
-  driverType!: StatusListDriverType
-
-  @Column('simple-enum', {
-    name: 'credentialIdMode',
-    enum: StatusListCredentialIdMode,
-    nullable: false,
-    default: StatusListCredentialIdMode.ISSUANCE,
-  })
-  credentialIdMode!: StatusListCredentialIdMode
-
-  @Column({ type: 'varchar', name: 'proofFormat', enum: ['lds', 'jwt'], nullable: false, default: 'lds' })
-  proofFormat!: ProofFormat
-
-  @Column({ type: 'varchar', name: 'indexingDirection', enum: ['rightToLeft'], nullable: false, default: 'rightToLeft' })
-  indexingDirection!: StatusListIndexingDirection
-
-  @Column({ type: 'varchar', name: 'statusPurpose', nullable: false, default: 'revocation' })
-  statusPurpose!: StatusPurpose2021
-
-  @Column({
-    name: 'statusListCredential',
-    type: 'text',
-    nullable: true,
-    unique: false,
-    transformer: {
-      from(value: string): W3CVerifiableCredential | JwtDecodedVerifiableCredential {
-        if (value?.startsWith('ey')) {
-          return value
-        }
-        return JSON.parse(value)
-      },
-      to(value: W3CVerifiableCredential | JwtDecodedVerifiableCredential): string {
-        if (typeof value === 'string') {
-          return value
-        }
-        return JSON.stringify(value)
-      },
-    },
-  })
-  statusListCredential?: W3CVerifiableCredential | JwtDecodedVerifiableCredential
-
-  @OneToMany((type) => StatusListEntryEntity, (entry) => entry.statusList)
-  statusListEntries!: StatusListEntryEntity[]
-}
+import {
+  IIssuer,
+  JwtDecodedVerifiableCredential,
+  StatusListCredentialIdMode,
+  StatusListDriverType,
+  StatusListIndexingDirection,
+  StatusListType,
+  StatusPurpose2021,
+  W3CVerifiableCredential,
+} from '@sphereon/ssi-types'
+import { ProofFormat } from '@veramo/core'
+import { BaseEntity, Column, Entity, OneToMany, PrimaryColumn, Unique } from 'typeorm'
+import { StatusListEntryEntity } from './StatusList2021EntryEntity'
+
+@Entity('StatusList')
+@Unique('UQ_correlationId', ['correlationId'])
+export class StatusListEntity extends BaseEntity {
+  @PrimaryColumn({ name: 'id', type: 'varchar' })
+  id!: string
+
+  @Column({ name: 'correlationId', type: 'varchar', nullable: false })
+  correlationId!: string
+
+  @Column({ name: 'length', nullable: false, unique: false })
+  length!: number
+
+  @Column({
+    name: 'issuer',
+    type: 'text',
+    nullable: false,
+    unique: false,
+    transformer: {
+      from(value: string): string | IIssuer {
+        if (value?.trim()?.startsWith('{')) {
+          return JSON.parse(value)
+        }
+        return value
+      },
+      to(value: string | IIssuer): string {
+        if (typeof value === 'string') {
+          return value
+        }
+        return JSON.stringify(value)
+      },
+    },
+  })
+  issuer!: string | IIssuer
+
+  @Column('simple-enum', { name: 'type', enum: StatusListType, nullable: false, default: StatusListType.StatusList2021 })
+  type!: StatusListType
+
+  @Column('simple-enum', { name: 'driverType', enum: StatusListDriverType, nullable: false, default: StatusListDriverType.AGENT_TYPEORM })
+  driverType!: StatusListDriverType
+
+  @Column('simple-enum', {
+    name: 'credentialIdMode',
+    enum: StatusListCredentialIdMode,
+    nullable: false,
+    default: StatusListCredentialIdMode.ISSUANCE,
+  })
+  credentialIdMode!: StatusListCredentialIdMode
+
+  @Column({ type: 'varchar', name: 'proofFormat', enum: ['lds', 'jwt'], nullable: false, default: 'lds' })
+  proofFormat!: ProofFormat
+
+  @Column({ type: 'varchar', name: 'indexingDirection', enum: ['rightToLeft'], nullable: false, default: 'rightToLeft' })
+  indexingDirection!: StatusListIndexingDirection
+
+  @Column({ type: 'varchar', name: 'statusPurpose', nullable: false, default: 'revocation' })
+  statusPurpose!: StatusPurpose2021
+
+  @Column({
+    name: 'statusListCredential',
+    type: 'text',
+    nullable: true,
+    unique: false,
+    transformer: {
+      from(value: string): W3CVerifiableCredential | JwtDecodedVerifiableCredential {
+        if (value?.startsWith('ey')) {
+          return value
+        }
+        return JSON.parse(value)
+      },
+      to(value: W3CVerifiableCredential | JwtDecodedVerifiableCredential): string {
+        if (typeof value === 'string') {
+          return value
+        }
+        return JSON.stringify(value)
+      },
+    },
+  })
+  statusListCredential?: W3CVerifiableCredential | JwtDecodedVerifiableCredential
+
+  @OneToMany((type) => StatusListEntryEntity, (entry) => entry.statusList)
+  statusListEntries!: StatusListEntryEntity[]
+}

package/src/eventLogger/AbstractEventLoggerStore.ts

@@ -1,7 +1,7 @@
-import { GetAuditEventsArgs, StoreAuditEventArgs } from '../types'
-import { AuditLoggingEvent } from '@sphereon/ssi-sdk.core'
-
-export abstract class AbstractEventLoggerStore {
-  abstract getAuditEvents(args: GetAuditEventsArgs): Promise<Array<AuditLoggingEvent>>
-  abstract storeAuditEvent(args: StoreAuditEventArgs): Promise<AuditLoggingEvent>
-}
+import { GetAuditEventsArgs, StoreAuditEventArgs } from '../types'
+import { AuditLoggingEvent } from '@sphereon/ssi-sdk.core'
+
+export abstract class AbstractEventLoggerStore {
+  abstract getAuditEvents(args: GetAuditEventsArgs): Promise<Array<AuditLoggingEvent>>
+  abstract storeAuditEvent(args: StoreAuditEventArgs): Promise<AuditLoggingEvent>
+}

package/src/eventLogger/EventLoggerStore.ts

@@ -1,62 +1,62 @@
-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 { GetAuditEventsArgs, StoreAuditEventArgs } from '../types'
-
-const debug: Debugger = Debug('sphereon:ssi-sdk:event-store')
-
-export class EventLoggerStore extends AbstractEventLoggerStore {
-  private readonly dbConnection: OrPromise<DataSource>
-
-  constructor(dbConnection: OrPromise<DataSource>) {
-    super()
-    this.dbConnection = dbConnection
-  }
-
-  getAuditEvents = async (args?: GetAuditEventsArgs): Promise<Array<AuditLoggingEvent>> => {
-    const connection: DataSource = await this.dbConnection // TODO apply everywhere
-    debug('Getting audit events', args)
-    const result: Array<AuditEventEntity> = await connection.getRepository(AuditEventEntity).find({
-      ...(args?.filter && { where: args?.filter }),
-    })
-
-    return result.map((event: AuditEventEntity) => this.auditEventFrom(event))
-  }
-
-  storeAuditEvent = async (args: StoreAuditEventArgs): Promise<AuditLoggingEvent> => {
-    const { event } = args
-
-    const auditEventEntity: AuditEventEntity = auditEventEntityFrom(event)
-    const connection: DataSource = await this.dbConnection
-    debug('Storing audit event', auditEventEntity)
-    const createdResult: AuditEventEntity = await connection.getRepository(AuditEventEntity).save(auditEventEntity)
-
-    return this.auditEventFrom(createdResult)
-  }
-
-  private auditEventFrom = (event: AuditEventEntity): AuditLoggingEvent => {
-    return {
-      id: event.id,
-      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) }),
-    }
-  }
-}
+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 { GetAuditEventsArgs, StoreAuditEventArgs } from '../types'
+
+const debug: Debugger = Debug('sphereon:ssi-sdk:event-store')
+
+export class EventLoggerStore extends AbstractEventLoggerStore {
+  private readonly dbConnection: OrPromise<DataSource>
+
+  constructor(dbConnection: OrPromise<DataSource>) {
+    super()
+    this.dbConnection = dbConnection
+  }
+
+  getAuditEvents = async (args?: GetAuditEventsArgs): Promise<Array<AuditLoggingEvent>> => {
+    const connection: DataSource = await this.dbConnection // TODO apply everywhere
+    debug('Getting audit events', args)
+    const result: Array<AuditEventEntity> = await connection.getRepository(AuditEventEntity).find({
+      ...(args?.filter && { where: args?.filter }),
+    })
+
+    return result.map((event: AuditEventEntity) => this.auditEventFrom(event))
+  }
+
+  storeAuditEvent = async (args: StoreAuditEventArgs): Promise<AuditLoggingEvent> => {
+    const { event } = args
+
+    const auditEventEntity: AuditEventEntity = auditEventEntityFrom(event)
+    const connection: DataSource = await this.dbConnection
+    debug('Storing audit event', auditEventEntity)
+    const createdResult: AuditEventEntity = await connection.getRepository(AuditEventEntity).save(auditEventEntity)
+
+    return this.auditEventFrom(createdResult)
+  }
+
+  private auditEventFrom = (event: AuditEventEntity): AuditLoggingEvent => {
+    return {
+      id: event.id,
+      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) }),
+    }
+  }
+}