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

package/src/machineState/IAbstractMachineStateStore.ts

@@ -1,65 +1,65 @@
-import {
-  StoreMachineStateDeleteExpiredArgs,
-  StoreMachineStateDeleteArgs,
-  StoreMachineStatesFindActiveArgs,
-  StoreFindMachineStatesArgs,
-  StoreMachineStatePersistArgs,
-  StoreMachineStateInfo,
-  StoreMachineStateGetArgs,
-} from '../types'
-
-/**
- * Represents an abstract class for storing machine states.
- * This class provides methods for persisting, retrieving, and deleting machine states.
- *
- * @interface
- */
-export abstract class IAbstractMachineStateStore {
-  /**
-   * Persists the machine state.
-   *
-   * @param {StoreMachineStatePersistArgs} state - The object containing the machine state to persist.
-   * @return {Promise<StoreMachineStateInfo>} - A Promise that resolves to the information about the persisted machine state.
-   */
-  abstract persistMachineState(state: StoreMachineStatePersistArgs): Promise<StoreMachineStateInfo>
-
-  /**
-   * Finds active machine states based on the given arguments.
-   *
-   * @param {StoreMachineStatesFindActiveArgs} args - The arguments for finding active machine states.
-   * @return {Promise<Array<StoreMachineStateInfo>>} - A promise that resolves with an array of active machine states.
-   */
-  abstract findActiveMachineStates(args: StoreMachineStatesFindActiveArgs): Promise<Array<StoreMachineStateInfo>>
-
-  /**
-   * Retrieves the state of a particular machine.
-   *
-   * @param {StoreMachineStateGetArgs} args - The arguments for retrieving the machine state.
-   * @returns {Promise<StoreMachineStateInfo>} - A promise that resolves to the machine state information.
-   */
-  abstract getMachineState(args: StoreMachineStateGetArgs): Promise<StoreMachineStateInfo>
-
-  /**
-   * Finds the machine states based on the given arguments.
-   *
-   * @param {StoreFindMachineStatesArgs} [args] - The arguments to filter the machine states.
-   * @returns {Promise<Array<StoreMachineStateInfo>>} - A promise that resolves to an array of machine state information.
-   */
-  abstract findMachineStates(args?: StoreFindMachineStatesArgs): Promise<Array<StoreMachineStateInfo>>
-
-  /**
-   * Deletes a machine state.
-   *
-   * @param {StoreMachineStateDeleteArgs} args - The arguments for deleting the machine state.
-   * @return {Promise<boolean>} - A promise that resolves to a boolean indicating if the machine state was successfully deleted or not.
-   */
-  abstract deleteMachineState(args: StoreMachineStateDeleteArgs): Promise<boolean>
-
-  /**
-   * Deletes expired machine states from the database.
-   *
-   * @param {StoreMachineStateDeleteExpiredArgs} args - The arguments for deleting expired machine states.
-   * @return {Promise<number>} - A promise that resolves to the number of deleted machine states.
-   */
-  abstract deleteExpiredMachineStates(args: StoreMachineStateDeleteExpiredArgs): Promise<number>
-}
+import {
+  StoreMachineStateDeleteExpiredArgs,
+  StoreMachineStateDeleteArgs,
+  StoreMachineStatesFindActiveArgs,
+  StoreFindMachineStatesArgs,
+  StoreMachineStatePersistArgs,
+  StoreMachineStateInfo,
+  StoreMachineStateGetArgs,
+} from '../types'
+
+/**
+ * Represents an abstract class for storing machine states.
+ * This class provides methods for persisting, retrieving, and deleting machine states.
+ *
+ * @interface
+ */
+export abstract class IAbstractMachineStateStore {
+  /**
+   * Persists the machine state.
+   *
+   * @param {StoreMachineStatePersistArgs} state - The object containing the machine state to persist.
+   * @return {Promise<StoreMachineStateInfo>} - A Promise that resolves to the information about the persisted machine state.
+   */
+  abstract persistMachineState(state: StoreMachineStatePersistArgs): Promise<StoreMachineStateInfo>
+
+  /**
+   * Finds active machine states based on the given arguments.
+   *
+   * @param {StoreMachineStatesFindActiveArgs} args - The arguments for finding active machine states.
+   * @return {Promise<Array<StoreMachineStateInfo>>} - A promise that resolves with an array of active machine states.
+   */
+  abstract findActiveMachineStates(args: StoreMachineStatesFindActiveArgs): Promise<Array<StoreMachineStateInfo>>
+
+  /**
+   * Retrieves the state of a particular machine.
+   *
+   * @param {StoreMachineStateGetArgs} args - The arguments for retrieving the machine state.
+   * @returns {Promise<StoreMachineStateInfo>} - A promise that resolves to the machine state information.
+   */
+  abstract getMachineState(args: StoreMachineStateGetArgs): Promise<StoreMachineStateInfo>
+
+  /**
+   * Finds the machine states based on the given arguments.
+   *
+   * @param {StoreFindMachineStatesArgs} [args] - The arguments to filter the machine states.
+   * @returns {Promise<Array<StoreMachineStateInfo>>} - A promise that resolves to an array of machine state information.
+   */
+  abstract findMachineStates(args?: StoreFindMachineStatesArgs): Promise<Array<StoreMachineStateInfo>>
+
+  /**
+   * Deletes a machine state.
+   *
+   * @param {StoreMachineStateDeleteArgs} args - The arguments for deleting the machine state.
+   * @return {Promise<boolean>} - A promise that resolves to a boolean indicating if the machine state was successfully deleted or not.
+   */
+  abstract deleteMachineState(args: StoreMachineStateDeleteArgs): Promise<boolean>
+
+  /**
+   * Deletes expired machine states from the database.
+   *
+   * @param {StoreMachineStateDeleteExpiredArgs} args - The arguments for deleting expired machine states.
+   * @return {Promise<number>} - A promise that resolves to the number of deleted machine states.
+   */
+  abstract deleteExpiredMachineStates(args: StoreMachineStateDeleteExpiredArgs): Promise<number>
+}

package/src/machineState/MachineStateStore.ts

@@ -1,149 +1,149 @@
-import { OrPromise } from '@sphereon/ssi-types'
-import Debug from 'debug'
-import { Brackets, DataSource, FindOptionsWhere, IsNull, LessThan, Not } from 'typeorm'
-
-import { MachineStateInfoEntity } from '../entities/machineState/MachineStateInfoEntity'
-import {
-  StoreFindMachineStatesArgs,
-  StoreMachineStateDeleteArgs,
-  StoreMachineStateDeleteExpiredArgs,
-  StoreMachineStateGetArgs,
-  StoreMachineStateInfo,
-  StoreMachineStatePersistArgs,
-  StoreMachineStatesFindActiveArgs,
-} from '../types'
-import { IAbstractMachineStateStore } from './IAbstractMachineStateStore'
-
-const debug = Debug('sphereon:ssi-sdk:machine-state:store')
-
-/**
- * Represents a data store for managing machine states.
- */
-export class MachineStateStore extends IAbstractMachineStateStore {
-  private readonly _dbConnection: OrPromise<DataSource>
-
-  constructor(dbConnection: OrPromise<DataSource>) {
-    super()
-    this._dbConnection = dbConnection
-  }
-
-  async persistMachineState(state: StoreMachineStatePersistArgs): Promise<StoreMachineStateInfo> {
-    const connection: DataSource = await this._dbConnection
-    const { machineName, instanceId, tenantId } = state
-    debug(`Executing persistMachineState for machine ${machineName}, instance ${instanceId}, tenantId: ${tenantId}...`)
-    const entity = MachineStateStore.machineStateInfoEntityFrom(state)
-    const existing = await connection.getRepository(MachineStateInfoEntity).findOne({
-      where: {
-        instanceId: state.instanceId,
-      },
-    })
-    if (existing && existing.updatedCount > state.updatedCount) {
-      const error = `Updating machine state with an older version is not allowed. Machine ${existing.machineName}, last count: ${
-        existing.updatedCount
-      }, new count: ${existing.updatedCount}, last updated: ${existing.updatedAt}, current: ${new Date()}, instance: ${existing.instanceId}`
-      console.log(error)
-      return Promise.reject(new Error(error))
-    }
-    // No need for a transaction. This is a single entity. We don't want to be surprised by an isolation level hiding the state from others
-    const result = await connection.getRepository(MachineStateInfoEntity).save(entity, { transaction: false })
-    debug(`Done persistMachineState machine ${machineName}, instance ${instanceId}, tenantId: ${tenantId}`)
-    return MachineStateStore.machineInfoFrom(result)
-  }
-
-  async findActiveMachineStates(args: StoreMachineStatesFindActiveArgs): Promise<Array<StoreMachineStateInfo>> {
-    const { tenantId, machineName, instanceId } = args
-    const connection: DataSource = await this._dbConnection
-    debug(`Executing findActiveMachineStates query with machineName: ${machineName}, tenantId: ${tenantId}`)
-    const queryBuilder = connection
-      .getRepository(MachineStateInfoEntity)
-      .createQueryBuilder('state')
-      .where('state.completedAt IS NULL')
-      .andWhere(
-        new Brackets((qb) => {
-          qb.where('state.expiresAt IS NULL').orWhere('state.expiresAt > :now', { now: new Date() })
-        }),
-      )
-
-    if (instanceId) {
-      queryBuilder.andWhere('state.instanceId = :instanceId', { instanceId })
-    }
-    if (tenantId) {
-      queryBuilder.andWhere('state.tenantId = :tenantId', { tenantId })
-    }
-    if (machineName) {
-      queryBuilder.andWhere('state.machineName = :machineName', { machineName })
-    }
-
-    return (
-      (await queryBuilder
-        .orderBy('state.updatedAt', 'DESC')
-        .getMany()
-        .then((entities) => entities.map(MachineStateStore.machineInfoFrom))) ?? []
-    )
-  }
-
-  async findMachineStates(args?: StoreFindMachineStatesArgs): Promise<Array<StoreMachineStateInfo>> {
-    const connection: DataSource = await this._dbConnection
-    debug('findMachineStates', args)
-    const result: Array<MachineStateInfoEntity> = await connection.getRepository(MachineStateInfoEntity).find({
-      ...(args?.filter && { where: args?.filter }),
-      transaction: false,
-    })
-
-    return result.map((event: MachineStateInfoEntity) => MachineStateStore.machineInfoFrom(event))
-  }
-
-  async getMachineState(args: StoreMachineStateGetArgs): Promise<StoreMachineStateInfo> {
-    const connection: DataSource = await this._dbConnection
-    debug('getMachineState', args)
-    return connection.getRepository(MachineStateInfoEntity).findOneOrFail({ where: { instanceId: args.instanceId } })
-  }
-
-  async deleteMachineState(args: StoreMachineStateDeleteArgs): Promise<boolean> {
-    debug(`Executing deleteMachineState query with id: ${args.instanceId}`)
-    if (!args.instanceId) {
-      throw new Error('No instanceId parameter is provided.')
-    }
-    try {
-      const connection: DataSource = await this._dbConnection
-
-      const result = await connection.getRepository(MachineStateInfoEntity).delete(args.instanceId)
-      return result.affected != null && result.affected > 0
-    } catch (error) {
-      debug(`Error deleting state: ${error}`)
-      return false
-    }
-  }
-
-  async deleteExpiredMachineStates(args: StoreMachineStateDeleteExpiredArgs): Promise<number> {
-    const { machineName, tenantId, deleteDoneStates } = args
-    debug(`Executing deleteExpiredMachineStates query with params: ${JSON.stringify(args)}`)
-    try {
-      const connection: DataSource = await this._dbConnection
-
-      const deleteCriteria: FindOptionsWhere<MachineStateInfoEntity> = {
-        ...(machineName && { machineName }),
-        ...(tenantId && { tenantId }),
-        // When deleteOnDone state is set we only look at completedAt, in other cases we compare current time with expiresAt
-        ...(!deleteDoneStates && { expiresAt: LessThan(new Date()) }),
-        ...(deleteDoneStates && { completedAt: Not(IsNull()) }),
-      }
-      const result = await connection.getRepository(MachineStateInfoEntity).delete(deleteCriteria)
-      return result.affected ?? 0
-    } catch (error) {
-      debug(`Error deleting machine info: ${error}`)
-      return Promise.reject(new Error(`Error deleting expired machine states for machine type ${machineName}`))
-    }
-  }
-
-  protected static machineInfoFrom = (machineStateInfoEntity: MachineStateInfoEntity): StoreMachineStateInfo => {
-    // We are making sure no entity function get copied
-    return JSON.parse(JSON.stringify(machineStateInfoEntity))
-  }
-
-  static machineStateInfoEntityFrom = (machineStateInfo: StoreMachineStateInfo | StoreMachineStatePersistArgs): MachineStateInfoEntity => {
-    const entity = new MachineStateInfoEntity()
-    Object.assign(entity, machineStateInfo)
-    return entity
-  }
-}
+import { OrPromise } from '@sphereon/ssi-types'
+import Debug from 'debug'
+import { Brackets, DataSource, FindOptionsWhere, IsNull, LessThan, Not } from 'typeorm'
+
+import { MachineStateInfoEntity } from '../entities/machineState/MachineStateInfoEntity'
+import {
+  StoreFindMachineStatesArgs,
+  StoreMachineStateDeleteArgs,
+  StoreMachineStateDeleteExpiredArgs,
+  StoreMachineStateGetArgs,
+  StoreMachineStateInfo,
+  StoreMachineStatePersistArgs,
+  StoreMachineStatesFindActiveArgs,
+} from '../types'
+import { IAbstractMachineStateStore } from './IAbstractMachineStateStore'
+
+const debug = Debug('sphereon:ssi-sdk:machine-state:store')
+
+/**
+ * Represents a data store for managing machine states.
+ */
+export class MachineStateStore extends IAbstractMachineStateStore {
+  private readonly _dbConnection: OrPromise<DataSource>
+
+  constructor(dbConnection: OrPromise<DataSource>) {
+    super()
+    this._dbConnection = dbConnection
+  }
+
+  async persistMachineState(state: StoreMachineStatePersistArgs): Promise<StoreMachineStateInfo> {
+    const connection: DataSource = await this._dbConnection
+    const { machineName, instanceId, tenantId } = state
+    debug(`Executing persistMachineState for machine ${machineName}, instance ${instanceId}, tenantId: ${tenantId}...`)
+    const entity = MachineStateStore.machineStateInfoEntityFrom(state)
+    const existing = await connection.getRepository(MachineStateInfoEntity).findOne({
+      where: {
+        instanceId: state.instanceId,
+      },
+    })
+    if (existing && existing.updatedCount > state.updatedCount) {
+      const error = `Updating machine state with an older version is not allowed. Machine ${existing.machineName}, last count: ${
+        existing.updatedCount
+      }, new count: ${existing.updatedCount}, last updated: ${existing.updatedAt}, current: ${new Date()}, instance: ${existing.instanceId}`
+      console.log(error)
+      return Promise.reject(new Error(error))
+    }
+    // No need for a transaction. This is a single entity. We don't want to be surprised by an isolation level hiding the state from others
+    const result = await connection.getRepository(MachineStateInfoEntity).save(entity, { transaction: false })
+    debug(`Done persistMachineState machine ${machineName}, instance ${instanceId}, tenantId: ${tenantId}`)
+    return MachineStateStore.machineInfoFrom(result)
+  }
+
+  async findActiveMachineStates(args: StoreMachineStatesFindActiveArgs): Promise<Array<StoreMachineStateInfo>> {
+    const { tenantId, machineName, instanceId } = args
+    const connection: DataSource = await this._dbConnection
+    debug(`Executing findActiveMachineStates query with machineName: ${machineName}, tenantId: ${tenantId}`)
+    const queryBuilder = connection
+      .getRepository(MachineStateInfoEntity)
+      .createQueryBuilder('state')
+      .where('state.completedAt IS NULL')
+      .andWhere(
+        new Brackets((qb) => {
+          qb.where('state.expiresAt IS NULL').orWhere('state.expiresAt > :now', { now: new Date() })
+        }),
+      )
+
+    if (instanceId) {
+      queryBuilder.andWhere('state.instanceId = :instanceId', { instanceId })
+    }
+    if (tenantId) {
+      queryBuilder.andWhere('state.tenantId = :tenantId', { tenantId })
+    }
+    if (machineName) {
+      queryBuilder.andWhere('state.machineName = :machineName', { machineName })
+    }
+
+    return (
+      (await queryBuilder
+        .orderBy('state.updatedAt', 'DESC')
+        .getMany()
+        .then((entities) => entities.map(MachineStateStore.machineInfoFrom))) ?? []
+    )
+  }
+
+  async findMachineStates(args?: StoreFindMachineStatesArgs): Promise<Array<StoreMachineStateInfo>> {
+    const connection: DataSource = await this._dbConnection
+    debug('findMachineStates', args)
+    const result: Array<MachineStateInfoEntity> = await connection.getRepository(MachineStateInfoEntity).find({
+      ...(args?.filter && { where: args?.filter }),
+      transaction: false,
+    })
+
+    return result.map((event: MachineStateInfoEntity) => MachineStateStore.machineInfoFrom(event))
+  }
+
+  async getMachineState(args: StoreMachineStateGetArgs): Promise<StoreMachineStateInfo> {
+    const connection: DataSource = await this._dbConnection
+    debug('getMachineState', args)
+    return connection.getRepository(MachineStateInfoEntity).findOneOrFail({ where: { instanceId: args.instanceId } })
+  }
+
+  async deleteMachineState(args: StoreMachineStateDeleteArgs): Promise<boolean> {
+    debug(`Executing deleteMachineState query with id: ${args.instanceId}`)
+    if (!args.instanceId) {
+      throw new Error('No instanceId parameter is provided.')
+    }
+    try {
+      const connection: DataSource = await this._dbConnection
+
+      const result = await connection.getRepository(MachineStateInfoEntity).delete(args.instanceId)
+      return result.affected != null && result.affected > 0
+    } catch (error) {
+      debug(`Error deleting state: ${error}`)
+      return false
+    }
+  }
+
+  async deleteExpiredMachineStates(args: StoreMachineStateDeleteExpiredArgs): Promise<number> {
+    const { machineName, tenantId, deleteDoneStates } = args
+    debug(`Executing deleteExpiredMachineStates query with params: ${JSON.stringify(args)}`)
+    try {
+      const connection: DataSource = await this._dbConnection
+
+      const deleteCriteria: FindOptionsWhere<MachineStateInfoEntity> = {
+        ...(machineName && { machineName }),
+        ...(tenantId && { tenantId }),
+        // When deleteOnDone state is set we only look at completedAt, in other cases we compare current time with expiresAt
+        ...(!deleteDoneStates && { expiresAt: LessThan(new Date()) }),
+        ...(deleteDoneStates && { completedAt: Not(IsNull()) }),
+      }
+      const result = await connection.getRepository(MachineStateInfoEntity).delete(deleteCriteria)
+      return result.affected ?? 0
+    } catch (error) {
+      debug(`Error deleting machine info: ${error}`)
+      return Promise.reject(new Error(`Error deleting expired machine states for machine type ${machineName}`))
+    }
+  }
+
+  protected static machineInfoFrom = (machineStateInfoEntity: MachineStateInfoEntity): StoreMachineStateInfo => {
+    // We are making sure no entity function get copied
+    return JSON.parse(JSON.stringify(machineStateInfoEntity))
+  }
+
+  static machineStateInfoEntityFrom = (machineStateInfo: StoreMachineStateInfo | StoreMachineStatePersistArgs): MachineStateInfoEntity => {
+    const entity = new MachineStateInfoEntity()
+    Object.assign(entity, machineStateInfo)
+    return entity
+  }
+}

package/src/migrations/generic/1-CreateContacts.ts

@@ -1,66 +1,66 @@
-import { DatabaseType, MigrationInterface, QueryRunner } from 'typeorm'
-import Debug from 'debug'
-import { CreateContacts1659463079428 } from '../postgres/1659463079428-CreateContacts'
-import { CreateContacts1659463069549 } from '../sqlite/1659463069549-CreateContacts'
-
-const debug: Debug.Debugger = Debug('sphereon:ssi-sdk:migrations')
-
-export class CreateContacts1659463079429 implements MigrationInterface {
-  name = 'CreateContacts1659463079429'
-
-  public async up(queryRunner: QueryRunner): Promise<void> {
-    debug('migration: creating contacts tables')
-    const dbType: DatabaseType = queryRunner.connection.driver.options.type
-
-    switch (dbType) {
-      case 'postgres': {
-        debug('using postgres migration file')
-        const mig: CreateContacts1659463079428 = new CreateContacts1659463079428()
-        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: CreateContacts1659463069549 = new CreateContacts1659463069549()
-        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 contacts tables')
-    const dbType: DatabaseType = queryRunner.connection.driver.options.type
-
-    switch (dbType) {
-      case 'postgres': {
-        debug('using postgres migration file')
-        const mig: CreateContacts1659463079428 = new CreateContacts1659463079428()
-        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: CreateContacts1659463069549 = new CreateContacts1659463069549()
-        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`,
-        )
-    }
-  }
-}
+import { DatabaseType, MigrationInterface, QueryRunner } from 'typeorm'
+import Debug from 'debug'
+import { CreateContacts1659463079428 } from '../postgres/1659463079428-CreateContacts'
+import { CreateContacts1659463069549 } from '../sqlite/1659463069549-CreateContacts'
+
+const debug: Debug.Debugger = Debug('sphereon:ssi-sdk:migrations')
+
+export class CreateContacts1659463079429 implements MigrationInterface {
+  name = 'CreateContacts1659463079429'
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    debug('migration: creating contacts tables')
+    const dbType: DatabaseType = queryRunner.connection.driver.options.type
+
+    switch (dbType) {
+      case 'postgres': {
+        debug('using postgres migration file')
+        const mig: CreateContacts1659463079428 = new CreateContacts1659463079428()
+        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: CreateContacts1659463069549 = new CreateContacts1659463069549()
+        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 contacts tables')
+    const dbType: DatabaseType = queryRunner.connection.driver.options.type
+
+    switch (dbType) {
+      case 'postgres': {
+        debug('using postgres migration file')
+        const mig: CreateContacts1659463079428 = new CreateContacts1659463079428()
+        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: CreateContacts1659463069549 = new CreateContacts1659463069549()
+        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`,
+        )
+    }
+  }
+}