@sphereon/ssi-sdk.data-store 0.30.1-unstable.4 → 0.30.1

package/src/types/digitalCredential/digitalCredential.ts

@@ -1,102 +1,102 @@
-export type NonPersistedDigitalCredential = Omit<DigitalCredential, 'id' | 'regulationType'> & { regulationType?: RegulationType }
-
-export type DigitalCredential = {
-  id: string
-  parentId?: string
-  documentType: DocumentType
-  documentFormat: CredentialDocumentFormat
-  credentialRole: CredentialRole
-  regulationType: RegulationType
-  rawDocument: string
-  uniformDocument: string
-  credentialId?: string
-  hash: string
-  kmsKeyRef?: string
-  identifierMethod?: string
-  issuerCorrelationType: CredentialCorrelationType
-  subjectCorrelationType?: CredentialCorrelationType
-  rpCorrelationType?: CredentialCorrelationType
-  isIssuerSigned?: boolean
-  issuerCorrelationId: string
-  subjectCorrelationId?: string
-  rpCorrelationId?: string
-  verifiedState?: CredentialStateType
-  tenantId?: string
-  createdAt: Date
-  presentedAt?: Date
-  lastUpdatedAt: Date
-  validUntil?: Date
-  validFrom?: Date
-  verifiedAt?: Date
-  revokedAt?: Date
-}
-
-export enum DocumentType {
-  VC = 'VC',
-  VP = 'VP',
-  P = 'P',
-  C = 'C',
-}
-
-export enum RegulationType {
-  PID = 'PID',
-  QEAA = 'QEAA',
-  EAA = 'EAA',
-  NON_REGULATED = 'NON_REGULATED',
-}
-
-export enum CredentialDocumentFormat {
-  JSON_LD = 'JSON_LD',
-  JWT = 'JWT',
-  SD_JWT = 'SD_JWT',
-  MSO_MDOC = 'MSO_MDOC',
-}
-
-export namespace CredentialDocumentFormat {
-  export function fromSpecValue(credentialFormat: string) {
-    const format = credentialFormat.toLowerCase()
-    if (format.includes('sd')) {
-      return CredentialDocumentFormat.SD_JWT
-    } else if (format.includes('ldp')) {
-      return CredentialDocumentFormat.JSON_LD
-    } else if (format.includes('mso') || credentialFormat.includes('mdoc')) {
-      return CredentialDocumentFormat.MSO_MDOC
-    } else if (format.includes('jwt_')) {
-      return CredentialDocumentFormat.JWT
-    } else {
-      throw Error(`Could not map format ${format} to known format`)
-    }
-  }
-
-  export function toSpecValue(documentFormat: CredentialDocumentFormat, documentType: DocumentType) {
-    switch (documentFormat) {
-      case CredentialDocumentFormat.SD_JWT:
-        return 'vc+sd-jwt'
-      case CredentialDocumentFormat.MSO_MDOC:
-        return 'mso_mdoc'
-      case CredentialDocumentFormat.JSON_LD:
-        return documentType === DocumentType.C || documentType === DocumentType.VC ? 'ldp_vc' : 'ldp_vp'
-      case CredentialDocumentFormat.JWT:
-        return documentType === DocumentType.C || documentType === DocumentType.VC ? 'jwt_vc_json' : 'jwt_vp_json'
-    }
-  }
-}
-
-export enum CredentialCorrelationType {
-  DID = 'DID',
-  X509_SAN = 'X509_SAN',
-  KID = 'KID',
-  URL = 'URL',
-}
-
-export enum CredentialRole {
-  ISSUER = 'ISSUER',
-  VERIFIER = 'VERIFIER',
-  HOLDER = 'HOLDER',
-}
-
-export enum CredentialStateType {
-  REVOKED = 'REVOKED',
-  VERIFIED = 'VERIFIED',
-  EXPIRED = 'EXPIRED',
-}
+export type NonPersistedDigitalCredential = Omit<DigitalCredential, 'id' | 'regulationType'> & { regulationType?: RegulationType }
+
+export type DigitalCredential = {
+  id: string
+  parentId?: string
+  documentType: DocumentType
+  documentFormat: CredentialDocumentFormat
+  credentialRole: CredentialRole
+  regulationType: RegulationType
+  rawDocument: string
+  uniformDocument: string
+  credentialId?: string
+  hash: string
+  kmsKeyRef?: string
+  identifierMethod?: string
+  issuerCorrelationType: CredentialCorrelationType
+  subjectCorrelationType?: CredentialCorrelationType
+  rpCorrelationType?: CredentialCorrelationType
+  isIssuerSigned?: boolean
+  issuerCorrelationId: string
+  subjectCorrelationId?: string
+  rpCorrelationId?: string
+  verifiedState?: CredentialStateType
+  tenantId?: string
+  createdAt: Date
+  presentedAt?: Date
+  lastUpdatedAt: Date
+  validUntil?: Date
+  validFrom?: Date
+  verifiedAt?: Date
+  revokedAt?: Date
+}
+
+export enum DocumentType {
+  VC = 'VC',
+  VP = 'VP',
+  P = 'P',
+  C = 'C',
+}
+
+export enum RegulationType {
+  PID = 'PID',
+  QEAA = 'QEAA',
+  EAA = 'EAA',
+  NON_REGULATED = 'NON_REGULATED',
+}
+
+export enum CredentialDocumentFormat {
+  JSON_LD = 'JSON_LD',
+  JWT = 'JWT',
+  SD_JWT = 'SD_JWT',
+  MSO_MDOC = 'MSO_MDOC',
+}
+
+export namespace CredentialDocumentFormat {
+  export function fromSpecValue(credentialFormat: string) {
+    const format = credentialFormat.toLowerCase()
+    if (format.includes('sd')) {
+      return CredentialDocumentFormat.SD_JWT
+    } else if (format.includes('ldp')) {
+      return CredentialDocumentFormat.JSON_LD
+    } else if (format.includes('mso') || credentialFormat.includes('mdoc')) {
+      return CredentialDocumentFormat.MSO_MDOC
+    } else if (format.includes('jwt_')) {
+      return CredentialDocumentFormat.JWT
+    } else {
+      throw Error(`Could not map format ${format} to known format`)
+    }
+  }
+
+  export function toSpecValue(documentFormat: CredentialDocumentFormat, documentType: DocumentType) {
+    switch (documentFormat) {
+      case CredentialDocumentFormat.SD_JWT:
+        return 'vc+sd-jwt'
+      case CredentialDocumentFormat.MSO_MDOC:
+        return 'mso_mdoc'
+      case CredentialDocumentFormat.JSON_LD:
+        return documentType === DocumentType.C || documentType === DocumentType.VC ? 'ldp_vc' : 'ldp_vp'
+      case CredentialDocumentFormat.JWT:
+        return documentType === DocumentType.C || documentType === DocumentType.VC ? 'jwt_vc_json' : 'jwt_vp_json'
+    }
+  }
+}
+
+export enum CredentialCorrelationType {
+  DID = 'DID',
+  X509_SAN = 'X509_SAN',
+  KID = 'KID',
+  URL = 'URL',
+}
+
+export enum CredentialRole {
+  ISSUER = 'ISSUER',
+  VERIFIER = 'VERIFIER',
+  HOLDER = 'HOLDER',
+}
+
+export enum CredentialStateType {
+  REVOKED = 'REVOKED',
+  VERIFIED = 'VERIFIED',
+  EXPIRED = 'EXPIRED',
+}

package/src/types/eventLogger/IAbstractEventLoggerStore.ts

@@ -1,12 +1,12 @@
-import { PartialAuditLoggingEvent } from '@sphereon/ssi-sdk.core'
-import { NonPersistedAuditLoggingEvent } from './eventLogger'
-
-export type FindAuditLoggingEventArgs = Array<PartialAuditLoggingEvent>
-
-export type StoreAuditEventArgs = {
-  event: NonPersistedAuditLoggingEvent
-}
-
-export type GetAuditEventsArgs = {
-  filter?: FindAuditLoggingEventArgs
-}
+import { PartialAuditLoggingEvent } from '@sphereon/ssi-sdk.core'
+import { NonPersistedAuditLoggingEvent } from './eventLogger'
+
+export type FindAuditLoggingEventArgs = Array<PartialAuditLoggingEvent>
+
+export type StoreAuditEventArgs = {
+  event: NonPersistedAuditLoggingEvent
+}
+
+export type GetAuditEventsArgs = {
+  filter?: FindAuditLoggingEventArgs
+}

package/src/types/eventLogger/eventLogger.ts

@@ -1,3 +1,3 @@
-import { AuditLoggingEvent } from '@sphereon/ssi-sdk.core'
-
-export type NonPersistedAuditLoggingEvent = Omit<AuditLoggingEvent, 'id'>
+import { AuditLoggingEvent } from '@sphereon/ssi-sdk.core'
+
+export type NonPersistedAuditLoggingEvent = Omit<AuditLoggingEvent, 'id'>

package/src/types/index.ts

@@ -1,14 +1,14 @@
-export * from './issuanceBranding/issuanceBranding'
-export * from './issuanceBranding/IAbstractIssuanceBrandingStore'
-export * from './contact/contact'
-export * from './presentationDefinition/presentationDefinition'
-export * from './presentationDefinition/IAbstractPDStore'
-export * from './contact/IAbstractContactStore'
-export * from './validation/validation'
-export * from './statusList/statusList'
-export * from './statusList/IAbstractStatusListStore'
-export * from './eventLogger/IAbstractEventLoggerStore'
-export * from './eventLogger/eventLogger'
-export * from './machineState/IAbstractMachineStateStore'
-export * from './digitalCredential/digitalCredential'
-export * from './digitalCredential/IAbstractDigitalCredentialStore'
+export * from './issuanceBranding/issuanceBranding'
+export * from './issuanceBranding/IAbstractIssuanceBrandingStore'
+export * from './contact/contact'
+export * from './presentationDefinition/presentationDefinition'
+export * from './presentationDefinition/IAbstractPDStore'
+export * from './contact/IAbstractContactStore'
+export * from './validation/validation'
+export * from './statusList/statusList'
+export * from './statusList/IAbstractStatusListStore'
+export * from './eventLogger/IAbstractEventLoggerStore'
+export * from './eventLogger/eventLogger'
+export * from './machineState/IAbstractMachineStateStore'
+export * from './digitalCredential/digitalCredential'
+export * from './digitalCredential/IAbstractDigitalCredentialStore'

package/src/types/machineState/IAbstractMachineStateStore.ts

@@ -1,68 +1,68 @@
-export type StoreMachineStatePersistArgs = Omit<StoreMachineStateInfo, 'createdAt' | 'updatedAt'>
-
-export type StoreMachineStatesFindActiveArgs = Partial<Pick<StoreMachineStateInfo, 'machineName' | 'tenantId' | 'instanceId'>>
-
-export type FindMachineStatesFilterArgs = Array<Partial<Omit<StoreMachineStateInfo, 'state'>>>
-
-export type StoreFindMachineStatesArgs = {
-  filter: FindMachineStatesFilterArgs
-}
-
-export type StoreMachineStateGetArgs = Pick<StoreMachineStateInfo, 'instanceId' | 'tenantId'>
-
-export type StoreMachineStateDeleteArgs = StoreMachineStateGetArgs
-export type StoreMachineStateDeleteExpiredArgs = { machineName?: string; tenantId?: string; deleteDoneStates?: boolean }
-
-export interface StoreMachineStateInfo {
-  /**
-   * Unique instance ID of the machine
-   */
-  instanceId: string
-
-  /**
-   * Session Id of the machine. Not necessarily unique
-   */
-  sessionId?: string
-
-  /**
-   * Machine name
-   */
-  machineName: string
-
-  /**
-   * The latest state name. Can be empty for a newly initialize machine
-   */
-  latestStateName?: string
-
-  /**
-   * event types like SET_TOC, SET_FIRSTNAME, .... Will be xstate.init on a newly initialized machine
-   */
-  latestEventType: string
-
-  /**
-   * Serialized Machine state
-   */
-  state: string
-
-  /**
-   * Represents the creation date
-   */
-  createdAt: Date
-
-  /**
-   * Represents the expiration date
-   */
-  expiresAt?: Date
-
-  /**
-   * Represents the update date
-   */
-  updatedAt: Date
-
-  /**
-   * Represents a counter for tracking updates.
-   */
-  updatedCount: number
-  completedAt?: Date
-  tenantId?: string
-}
+export type StoreMachineStatePersistArgs = Omit<StoreMachineStateInfo, 'createdAt' | 'updatedAt'>
+
+export type StoreMachineStatesFindActiveArgs = Partial<Pick<StoreMachineStateInfo, 'machineName' | 'tenantId' | 'instanceId'>>
+
+export type FindMachineStatesFilterArgs = Array<Partial<Omit<StoreMachineStateInfo, 'state'>>>
+
+export type StoreFindMachineStatesArgs = {
+  filter: FindMachineStatesFilterArgs
+}
+
+export type StoreMachineStateGetArgs = Pick<StoreMachineStateInfo, 'instanceId' | 'tenantId'>
+
+export type StoreMachineStateDeleteArgs = StoreMachineStateGetArgs
+export type StoreMachineStateDeleteExpiredArgs = { machineName?: string; tenantId?: string; deleteDoneStates?: boolean }
+
+export interface StoreMachineStateInfo {
+  /**
+   * Unique instance ID of the machine
+   */
+  instanceId: string
+
+  /**
+   * Session Id of the machine. Not necessarily unique
+   */
+  sessionId?: string
+
+  /**
+   * Machine name
+   */
+  machineName: string
+
+  /**
+   * The latest state name. Can be empty for a newly initialize machine
+   */
+  latestStateName?: string
+
+  /**
+   * event types like SET_TOC, SET_FIRSTNAME, .... Will be xstate.init on a newly initialized machine
+   */
+  latestEventType: string
+
+  /**
+   * Serialized Machine state
+   */
+  state: string
+
+  /**
+   * Represents the creation date
+   */
+  createdAt: Date
+
+  /**
+   * Represents the expiration date
+   */
+  expiresAt?: Date
+
+  /**
+   * Represents the update date
+   */
+  updatedAt: Date
+
+  /**
+   * Represents a counter for tracking updates.
+   */
+  updatedCount: number
+  completedAt?: Date
+  tenantId?: string
+}

package/src/types/presentationDefinition/IAbstractPDStore.ts

@@ -1,25 +1,25 @@
-import { NonPersistedPresentationDefinitionItem, PresentationDefinitionItem, PresentationDefinitionItemFilter } from './presentationDefinition'
-
-export type FindDefinitionArgs = Array<PresentationDefinitionItemFilter>
-
-export type GetDefinitionArgs = {
-  itemId: string
-}
-
-export type HasDefinitionArgs = GetDefinitionArgs
-
-export type GetDefinitionsArgs = {
-  filter?: FindDefinitionArgs
-}
-
-export type HasDefinitionsArgs = GetDefinitionsArgs
-
-export type AddDefinitionArgs = NonPersistedPresentationDefinitionItem
-
-export type UpdateDefinitionArgs = PresentationDefinitionItem
-
-export type DeleteDefinitionArgs = {
-  itemId: string
-}
-
-export type DeleteDefinitionsArgs = GetDefinitionsArgs
+import { NonPersistedPresentationDefinitionItem, PresentationDefinitionItem, PresentationDefinitionItemFilter } from './presentationDefinition'
+
+export type FindDefinitionArgs = Array<PresentationDefinitionItemFilter>
+
+export type GetDefinitionArgs = {
+  itemId: string
+}
+
+export type HasDefinitionArgs = GetDefinitionArgs
+
+export type GetDefinitionsArgs = {
+  filter?: FindDefinitionArgs
+}
+
+export type HasDefinitionsArgs = GetDefinitionsArgs
+
+export type AddDefinitionArgs = NonPersistedPresentationDefinitionItem
+
+export type UpdateDefinitionArgs = PresentationDefinitionItem
+
+export type DeleteDefinitionArgs = {
+  itemId: string
+}
+
+export type DeleteDefinitionsArgs = GetDefinitionsArgs

package/src/types/presentationDefinition/presentationDefinition.ts

@@ -1,17 +1,17 @@
-import { IPresentationDefinition } from '@sphereon/pex'
-
-export type PresentationDefinitionItem = {
-  id: string
-  definitionId: string
-  tenantId?: string
-  version: string
-  name?: string
-  purpose?: string
-  definitionPayload: IPresentationDefinition
-  createdAt: Date
-  lastUpdatedAt: Date
-}
-
-export type NonPersistedPresentationDefinitionItem = Omit<PresentationDefinitionItem, 'id' | 'createdAt' | 'lastUpdatedAt'>
-export type PartialPresentationDefinitionItem = Partial<PresentationDefinitionItem>
-export type PresentationDefinitionItemFilter = Partial<Omit<PresentationDefinitionItem, 'definitionPayload'>> // TODO add logic to linearize & hash definitionPayload into a separate column so we can filter on it?
+import { IPresentationDefinition } from '@sphereon/pex'
+
+export type PresentationDefinitionItem = {
+  id: string
+  definitionId: string
+  tenantId?: string
+  version: string
+  name?: string
+  purpose?: string
+  definitionPayload: IPresentationDefinition
+  createdAt: Date
+  lastUpdatedAt: Date
+}
+
+export type NonPersistedPresentationDefinitionItem = Omit<PresentationDefinitionItem, 'id' | 'createdAt' | 'lastUpdatedAt'>
+export type PartialPresentationDefinitionItem = Partial<PresentationDefinitionItem>
+export type PresentationDefinitionItemFilter = Partial<Omit<PresentationDefinitionItem, 'definitionPayload'>> // TODO add logic to linearize & hash definitionPayload into a separate column so we can filter on it?

package/src/utils/SortingUtils.ts

@@ -1,16 +1,16 @@
-import { BaseEntity, FindOptionsOrder } from 'typeorm'
-
-export const parseAndValidateOrderOptions = <T extends BaseEntity>(order: string): FindOptionsOrder<T> => {
-  const orderPairs = order.split(',').map((pair) => pair.trim().split('.'))
-  const orderOptions: FindOptionsOrder<T> = {}
-
-  orderPairs.forEach(([field, direction]) => {
-    const dir = direction.toUpperCase()
-    if (dir !== 'ASC' && dir !== 'DESC') {
-      throw new Error(`Invalid order direction: '${direction}'. Must be 'asc' or 'desc'.`)
-    }
-    ;(orderOptions as any)[field] = dir
-  })
-
-  return orderOptions
-}
+import { BaseEntity, FindOptionsOrder } from 'typeorm'
+
+export const parseAndValidateOrderOptions = <T extends BaseEntity>(order: string): FindOptionsOrder<T> => {
+  const orderPairs = order.split(',').map((pair) => pair.trim().split('.'))
+  const orderOptions: FindOptionsOrder<T> = {}
+
+  orderPairs.forEach(([field, direction]) => {
+    const dir = direction.toUpperCase()
+    if (dir !== 'ASC' && dir !== 'DESC') {
+      throw new Error(`Invalid order direction: '${direction}'. Must be 'asc' or 'desc'.`)
+    }
+    ;(orderOptions as any)[field] = dir
+  })
+
+  return orderOptions
+}