@sphereon/ssi-sdk.data-store 0.34.1-next.3 → 0.34.1-next.322

package/src/utils/statusList/MappingUtils.ts

@@ -1,41 +1,70 @@
-import { IOAuthStatusListEntity, IStatusList2021Entity, IStatusListEntity } from '../../types'
-import { OAuthStatusListEntity, StatusList2021Entity, StatusListEntity } from '../../entities/statusList/StatusListEntities'
+import { IBitstringStatusListEntity, IOAuthStatusListEntity, IStatusList2021Entity, IStatusListEntity } from '../../types'
 import { StatusListType } from '@sphereon/ssi-types'
+import {
+  BitstringStatusListEntity,
+  OAuthStatusListEntity,
+  StatusList2021Entity,
+  StatusListEntity,
+} from '../../entities/statusList/StatusListEntities'
 import { replaceNullWithUndefined } from '../FormattingUtils'
 
 export const statusListEntityFrom = (args: IStatusListEntity): StatusListEntity => {
-  if (args.type === StatusListType.StatusList2021) {
-    const entity = new StatusList2021Entity()
-    const sl2021 = args as IStatusList2021Entity
-    entity.indexingDirection = sl2021.indexingDirection
-    entity.statusPurpose = sl2021.statusPurpose
-    setBaseFields(entity, args)
-    Object.defineProperty(entity, 'type', {
-      value: StatusListType.StatusList2021,
-      enumerable: true,
-      configurable: true,
-    })
-    return entity
-  }
+  switch (args.type) {
+    case StatusListType.StatusList2021: {
+      const entity = new StatusList2021Entity()
+      const sl2021 = args as IStatusList2021Entity
+      entity.indexingDirection = sl2021.indexingDirection
+      entity.statusPurpose = sl2021.statusPurpose
+      setBaseFields(entity, args)
+      Object.defineProperty(entity, 'type', {
+        value: StatusListType.StatusList2021,
+        enumerable: true,
+        configurable: true,
+      })
+      return entity
+    }
 
-  if (args.type === StatusListType.OAuthStatusList) {
-    const entity = new OAuthStatusListEntity()
-    const oauthSl = args as IOAuthStatusListEntity
-    entity.bitsPerStatus = oauthSl.bitsPerStatus
-    entity.expiresAt = oauthSl.expiresAt
-    setBaseFields(entity, args)
-    Object.defineProperty(entity, 'type', {
-      value: StatusListType.OAuthStatusList,
-      enumerable: true,
-      configurable: true,
-    })
-    return entity
-  }
+    case StatusListType.OAuthStatusList: {
+      const entity = new OAuthStatusListEntity()
+      const oauthSl = args as IOAuthStatusListEntity
+      entity.bitsPerStatus = oauthSl.bitsPerStatus
+      entity.expiresAt = oauthSl.expiresAt
+      setBaseFields(entity, args)
+      Object.defineProperty(entity, 'type', {
+        value: StatusListType.OAuthStatusList,
+        enumerable: true,
+        configurable: true,
+      })
+      return entity
+    }
+
+    case StatusListType.BitstringStatusList: {
+      const entity = new BitstringStatusListEntity()
+      const bitstringsl = args as IBitstringStatusListEntity
+      if (!bitstringsl.bitsPerStatus) {
+        throw Error('bitsPerStatus must be set for BitstringStatusList')
+      }
+
+      entity.statusPurpose = bitstringsl.statusPurpose
+      entity.bitsPerStatus = bitstringsl.bitsPerStatus
+      entity.validFrom = bitstringsl.validFrom
+      entity.validUntil = bitstringsl.validUntil
+      entity.ttl = bitstringsl.ttl
+      setBaseFields(entity, args)
+      Object.defineProperty(entity, 'type', {
+        value: StatusListType.BitstringStatusList,
+        enumerable: true,
+        configurable: true,
+      })
+      return entity
+    }
 
-  throw new Error(`Invalid status list type ${args.type}`)
+    default:
+      throw new Error(`Invalid status list type ${args.type}`)
+  }
 }
 
-export const statusListFrom = (entity: StatusListEntity): IStatusListEntity => {
+export const statusListFrom = (entity: StatusListEntity): IStatusListEntity | IBitstringStatusListEntity => {
   if (entity instanceof StatusList2021Entity) {
     const result: IStatusList2021Entity = {
       ...getBaseFields(entity),
@@ -56,6 +85,18 @@ export const statusListFrom = (entity: StatusListEntity): IStatusListEntity => {
     return replaceNullWithUndefined(result)
   }
 
+  if (entity instanceof BitstringStatusListEntity) {
+    const result: IBitstringStatusListEntity = {
+      ...getBaseFields(entity),
+      type: StatusListType.BitstringStatusList,
+      statusPurpose: entity.statusPurpose,
+      bitsPerStatus: entity.bitsPerStatus,
+      validFrom: entity.validFrom,
+      validUntil: entity.validUntil,
+      ttl: entity.ttl,
+    }
+    return replaceNullWithUndefined(result)
+  }
   throw new Error(`Invalid status list type ${typeof entity}`)
 }
 

package/src/contact/AbstractContactStore.ts

@@ -1,71 +0,0 @@
-import {
-  AddElectronicAddressArgs,
-  AddIdentityArgs,
-  AddPartyArgs,
-  AddPartyTypeArgs,
-  AddPhysicalAddressArgs,
-  AddRelationshipArgs,
-  ElectronicAddress,
-  GetElectronicAddressArgs,
-  GetElectronicAddressesArgs,
-  GetIdentitiesArgs,
-  GetIdentityArgs,
-  GetPartiesArgs,
-  GetPartyArgs,
-  GetPartyTypeArgs,
-  GetPartyTypesArgs,
-  GetPhysicalAddressArgs,
-  GetPhysicalAddressesArgs,
-  GetRelationshipArgs,
-  GetRelationshipsArgs,
-  Identity,
-  Party,
-  PartyRelationship,
-  PartyType,
-  PhysicalAddress,
-  RemoveElectronicAddressArgs,
-  RemoveIdentityArgs,
-  RemovePartyArgs,
-  RemovePartyTypeArgs,
-  RemovePhysicalAddressArgs,
-  RemoveRelationshipArgs,
-  UpdateElectronicAddressArgs,
-  UpdateIdentityArgs,
-  UpdatePartyArgs,
-  UpdatePartyTypeArgs,
-  UpdatePhysicalAddressArgs,
-  UpdateRelationshipArgs,
-} from '../types'
-
-export abstract class AbstractContactStore {
-  abstract getParty(args: GetPartyArgs): Promise<Party>
-  abstract getParties(args?: GetPartiesArgs): Promise<Array<Party>>
-  abstract addParty(args: AddPartyArgs): Promise<Party>
-  abstract updateParty(args: UpdatePartyArgs): Promise<Party>
-  abstract removeParty(args: RemovePartyArgs): Promise<void>
-  abstract getIdentity(args: GetIdentityArgs): Promise<Identity>
-  abstract getIdentities(args?: GetIdentitiesArgs): Promise<Array<Identity>>
-  abstract addIdentity(args: AddIdentityArgs): Promise<Identity>
-  abstract updateIdentity(args: UpdateIdentityArgs): Promise<Identity>
-  abstract removeIdentity(args: RemoveIdentityArgs): Promise<void>
-  abstract getRelationship(args: GetRelationshipArgs): Promise<PartyRelationship>
-  abstract getRelationships(args?: GetRelationshipsArgs): Promise<Array<PartyRelationship>>
-  abstract addRelationship(args: AddRelationshipArgs): Promise<PartyRelationship>
-  abstract updateRelationship(args: UpdateRelationshipArgs): Promise<PartyRelationship>
-  abstract removeRelationship(args: RemoveRelationshipArgs): Promise<void>
-  abstract getPartyType(args: GetPartyTypeArgs): Promise<PartyType>
-  abstract getPartyTypes(args?: GetPartyTypesArgs): Promise<Array<PartyType>>
-  abstract addPartyType(args: AddPartyTypeArgs): Promise<PartyType>
-  abstract updatePartyType(args: UpdatePartyTypeArgs): Promise<PartyType>
-  abstract removePartyType(args: RemovePartyTypeArgs): Promise<void>
-  abstract getElectronicAddress(args: GetElectronicAddressArgs): Promise<ElectronicAddress>
-  abstract getElectronicAddresses(args?: GetElectronicAddressesArgs): Promise<Array<ElectronicAddress>>
-  abstract addElectronicAddress(args: AddElectronicAddressArgs): Promise<ElectronicAddress>
-  abstract updateElectronicAddress(args: UpdateElectronicAddressArgs): Promise<ElectronicAddress>
-  abstract removeElectronicAddress(args: RemoveElectronicAddressArgs): Promise<void>
-  abstract getPhysicalAddress(args: GetPhysicalAddressArgs): Promise<PhysicalAddress>
-  abstract getPhysicalAddresses(args?: GetPhysicalAddressesArgs): Promise<Array<PhysicalAddress>>
-  abstract addPhysicalAddress(args: AddPhysicalAddressArgs): Promise<PhysicalAddress>
-  abstract updatePhysicalAddress(args: UpdatePhysicalAddressArgs): Promise<PhysicalAddress>
-  abstract removePhysicalAddress(args: RemovePhysicalAddressArgs): Promise<void>
-}

package/src/digitalCredential/AbstractDigitalCredentialStore.ts

@@ -1,21 +0,0 @@
-import {
-  AddCredentialArgs,
-  DigitalCredential,
-  GetCredentialArgs,
-  GetCredentialsArgs,
-  GetCredentialsResponse,
-  RemoveCredentialArgs,
-  UpdateCredentialStateArgs,
-} from '../types'
-
-export abstract class AbstractDigitalCredentialStore {
-  abstract getCredential(args: GetCredentialArgs): Promise<DigitalCredential>
-
-  abstract getCredentials(args?: GetCredentialsArgs): Promise<GetCredentialsResponse>
-
-  abstract addCredential(args: AddCredentialArgs): Promise<DigitalCredential>
-
-  abstract updateCredentialState(args: UpdateCredentialStateArgs): Promise<DigitalCredential>
-
-  abstract removeCredential(args: RemoveCredentialArgs): Promise<boolean>
-}

package/src/eventLogger/AbstractEventLoggerStore.ts

@@ -1,9 +0,0 @@
-import type { ActivityLoggingEvent, AuditLoggingEvent } from '@sphereon/ssi-sdk.core'
-import type { GetActivityEventsArgs, GetAuditEventsArgs, StoreActivityEventArgs, StoreAuditEventArgs } from '../types'
-
-export abstract class AbstractEventLoggerStore {
-  abstract getAuditEvents(args: GetAuditEventsArgs): Promise<Array<AuditLoggingEvent>>
-  abstract getActivityEvents(args: GetActivityEventsArgs): Promise<Array<ActivityLoggingEvent>>
-  abstract storeAuditEvent(args: StoreAuditEventArgs): Promise<AuditLoggingEvent>
-  abstract storeActivityEvent(args: StoreActivityEventArgs): Promise<ActivityLoggingEvent>
-}

package/src/issuanceBranding/AbstractIssuanceBrandingStore.ts

@@ -1,41 +0,0 @@
-import type {
-  IAddCredentialBrandingArgs,
-  IAddCredentialLocaleBrandingArgs,
-  IAddIssuerBrandingArgs,
-  IAddIssuerLocaleBrandingArgs,
-  ICredentialBranding,
-  ICredentialLocaleBranding,
-  IGetCredentialBrandingArgs,
-  IGetCredentialLocaleBrandingArgs,
-  IGetIssuerBrandingArgs,
-  IGetIssuerLocaleBrandingArgs,
-  IIssuerBranding,
-  IIssuerLocaleBranding,
-  IRemoveCredentialBrandingArgs,
-  IRemoveCredentialLocaleBrandingArgs,
-  IRemoveIssuerBrandingArgs,
-  IRemoveIssuerLocaleBrandingArgs,
-  IUpdateCredentialBrandingArgs,
-  IUpdateCredentialLocaleBrandingArgs,
-  IUpdateIssuerBrandingArgs,
-  IUpdateIssuerLocaleBrandingArgs,
-} from '../types'
-
-export abstract class AbstractIssuanceBrandingStore {
-  public abstract addCredentialBranding(args: IAddCredentialBrandingArgs): Promise<ICredentialBranding>
-  public abstract getCredentialBranding(args?: IGetCredentialBrandingArgs): Promise<Array<ICredentialBranding>>
-  public abstract updateCredentialBranding(args: IUpdateCredentialBrandingArgs): Promise<ICredentialBranding>
-  public abstract removeCredentialBranding(args: IRemoveCredentialBrandingArgs): Promise<void>
-  public abstract addCredentialLocaleBranding(args: IAddCredentialLocaleBrandingArgs): Promise<ICredentialBranding>
-  public abstract getCredentialLocaleBranding(args?: IGetCredentialLocaleBrandingArgs): Promise<Array<ICredentialLocaleBranding>>
-  public abstract updateCredentialLocaleBranding(args: IUpdateCredentialLocaleBrandingArgs): Promise<ICredentialLocaleBranding>
-  public abstract removeCredentialLocaleBranding(args: IRemoveCredentialLocaleBrandingArgs): Promise<void>
-  public abstract addIssuerBranding(args: IAddIssuerBrandingArgs): Promise<IIssuerBranding>
-  public abstract getIssuerBranding(args?: IGetIssuerBrandingArgs): Promise<Array<IIssuerBranding>>
-  public abstract updateIssuerBranding(args: IUpdateIssuerBrandingArgs): Promise<IIssuerBranding>
-  public abstract removeIssuerBranding(args: IRemoveIssuerBrandingArgs): Promise<void>
-  public abstract addIssuerLocaleBranding(args: IAddIssuerLocaleBrandingArgs): Promise<IIssuerBranding>
-  public abstract getIssuerLocaleBranding(args?: IGetIssuerLocaleBrandingArgs): Promise<Array<IIssuerLocaleBranding>>
-  public abstract updateIssuerLocaleBranding(args: IUpdateIssuerLocaleBrandingArgs): Promise<IIssuerLocaleBranding>
-  public abstract removeIssuerLocaleBranding(args: IRemoveIssuerLocaleBrandingArgs): Promise<void>
-}

package/src/machineState/IAbstractMachineStateStore.ts

@@ -1,65 +0,0 @@
-import type {
-  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/presentationDefinition/AbstractPDStore.ts

@@ -1,20 +0,0 @@
-import type {
-  GetDefinitionArgs,
-  GetDefinitionsArgs,
-  DeleteDefinitionArgs,
-  PresentationDefinitionItem,
-  AddDefinitionArgs,
-  UpdateDefinitionArgs,
-  DeleteDefinitionsArgs,
-} from '../types'
-
-export abstract class AbstractPDStore {
-  abstract hasDefinition(args: GetDefinitionArgs): Promise<boolean>
-  abstract hasDefinitions(args: GetDefinitionsArgs): Promise<boolean>
-  abstract getDefinition(args: GetDefinitionArgs): Promise<PresentationDefinitionItem>
-  abstract getDefinitions(args: GetDefinitionsArgs): Promise<Array<PresentationDefinitionItem>>
-  abstract addDefinition(args: AddDefinitionArgs): Promise<PresentationDefinitionItem>
-  abstract updateDefinition(args: UpdateDefinitionArgs): Promise<PresentationDefinitionItem>
-  abstract deleteDefinition(args: DeleteDefinitionArgs): Promise<void>
-  abstract deleteDefinitions(args: DeleteDefinitionsArgs): Promise<number>
-}

package/src/types/contact/IAbstractContactStore.ts

@@ -1,161 +0,0 @@
-import {
-  ElectronicAddress,
-  Identity,
-  NonPersistedContact,
-  NonPersistedElectronicAddress,
-  NonPersistedIdentity,
-  NonPersistedPartyType,
-  NonPersistedPhysicalAddress,
-  PartialElectronicAddress,
-  PartialIdentity,
-  PartialParty,
-  PartialPartyRelationship,
-  PartialPartyType,
-  PartialPhysicalAddress,
-  Party,
-  PartyOrigin,
-  PartyRelationship,
-  PartyType,
-  PartyTypeType,
-  PhysicalAddress,
-} from './contact'
-
-export type FindPartyArgs = Array<PartialParty>
-export type FindIdentityArgs = Array<PartialIdentity>
-export type FindPartyTypeArgs = Array<PartialPartyType>
-export type FindRelationshipArgs = Array<PartialPartyRelationship>
-export type FindElectronicAddressArgs = Array<PartialElectronicAddress>
-export type FindPhysicalAddressArgs = Array<PartialPhysicalAddress>
-
-export type GetPartyArgs = {
-  partyId: string
-}
-
-export type GetPartiesArgs = {
-  filter?: FindPartyArgs
-}
-
-export type AddPartyArgs = {
-  uri?: string
-  partyType: NonPersistedPartyType
-  contact: NonPersistedContact
-  identities?: Array<NonPersistedIdentity>
-  electronicAddresses?: Array<NonPersistedElectronicAddress>
-  physicalAddresses?: Array<NonPersistedPhysicalAddress>
-}
-
-export type UpdatePartyArgs = {
-  party: Omit<Party, 'identities' | 'electronicAddresses' | 'partyType' | 'createdAt' | 'lastUpdatedAt'>
-}
-
-export type RemovePartyArgs = {
-  partyId: string
-}
-
-export type GetIdentityArgs = {
-  identityId: string
-}
-
-export type GetIdentitiesArgs = {
-  filter?: FindIdentityArgs
-}
-
-export type AddIdentityArgs = {
-  partyId: string
-  identity: NonPersistedIdentity
-}
-
-export type UpdateIdentityArgs = {
-  identity: Identity
-}
-
-export type RemoveIdentityArgs = {
-  identityId: string
-}
-
-export type RemoveRelationshipArgs = {
-  relationshipId: string
-}
-
-export type AddRelationshipArgs = {
-  leftId: string
-  rightId: string
-}
-
-export type GetRelationshipArgs = {
-  relationshipId: string
-}
-
-export type GetRelationshipsArgs = {
-  filter: FindRelationshipArgs
-}
-
-export type UpdateRelationshipArgs = {
-  relationship: Omit<PartyRelationship, 'createdAt' | 'lastUpdatedAt'>
-}
-
-export type AddPartyTypeArgs = {
-  type: PartyTypeType
-  origin: PartyOrigin
-  name: string
-  tenantId: string
-  description?: string
-}
-
-export type GetPartyTypeArgs = {
-  partyTypeId: string
-}
-
-export type GetPartyTypesArgs = {
-  filter?: FindPartyTypeArgs
-}
-
-export type UpdatePartyTypeArgs = {
-  partyType: Omit<PartyType, 'createdAt' | 'lastUpdatedAt'>
-}
-
-export type RemovePartyTypeArgs = {
-  partyTypeId: string
-}
-
-export type GetElectronicAddressArgs = {
-  electronicAddressId: string
-}
-
-export type GetElectronicAddressesArgs = {
-  filter?: FindElectronicAddressArgs
-}
-
-export type AddElectronicAddressArgs = {
-  partyId: string
-  electronicAddress: NonPersistedElectronicAddress
-}
-
-export type UpdateElectronicAddressArgs = {
-  electronicAddress: ElectronicAddress
-}
-
-export type RemoveElectronicAddressArgs = {
-  electronicAddressId: string
-}
-
-export type GetPhysicalAddressArgs = {
-  physicalAddressId: string
-}
-
-export type GetPhysicalAddressesArgs = {
-  filter?: FindPhysicalAddressArgs
-}
-
-export type AddPhysicalAddressArgs = {
-  partyId: string
-  physicalAddress: NonPersistedPhysicalAddress
-}
-
-export type UpdatePhysicalAddressArgs = {
-  physicalAddress: PhysicalAddress
-}
-
-export type RemovePhysicalAddressArgs = {
-  physicalAddressId: string
-}