@sphereon/ssi-sdk.data-store 0.15.2-next.6 → 0.15.2-next.77

package/src/types/contact/IAbstractContactStore.ts

@@ -1,52 +1,109 @@
-import { FindOptionsWhere } from 'typeorm'
-import { ContactEntity } from '../../entities/contact/ContactEntity'
-import { IdentityEntity } from '../../entities/contact/IdentityEntity'
-import { IBasicIdentity, IContact, IIdentity } from './contact'
+import {
+  NonPersistedPartyType,
+  NonPersistedContact,
+  NonPersistedIdentity,
+  Party,
+  Identity,
+  PartialParty,
+  PartialIdentity,
+  PartyTypeEnum,
+  PartyType,
+  PartyRelationship,
+  PartialPartyRelationship,
+  PartialPartyType,
+  NonPersistedElectronicAddress,
+} from './contact'
 
-// TODO WAL-625 refactor types to use interfaces and not the entities as the store should be replaceable
-export type FindContactArgs = FindOptionsWhere<ContactEntity>[]
-export type FindIdentityArgs = FindOptionsWhere<IdentityEntity>[]
+export type FindPartyArgs = Array<PartialParty>
+export type FindIdentityArgs = Array<PartialIdentity>
+export type FindPartyTypeArgs = Array<PartialPartyType>
+export type FindRelationshipArgs = Array<PartialPartyRelationship>
 
-export interface IGetContactArgs {
-  contactId: string
+export type GetPartyArgs = {
+  partyId: string
 }
 
-export interface IGetContactsArgs {
-  filter?: FindContactArgs
+export type GetPartiesArgs = {
+  filter?: FindPartyArgs
 }
 
-export interface IAddContactArgs {
-  name: string
-  alias: string
+export type AddPartyArgs = {
   uri?: string
-  identities?: Array<IBasicIdentity>
+  partyType: NonPersistedPartyType
+  contact: NonPersistedContact
+  identities?: Array<NonPersistedIdentity>
+  electronicAddresses?: Array<NonPersistedElectronicAddress>
 }
 
-export interface IUpdateContactArgs {
-  contact: Omit<IContact, 'identities' | 'createdAt' | 'lastUpdatedAt'>
+export type UpdatePartyArgs = {
+  party: Omit<Party, 'identities' | 'electronicAddresses' | 'partyType' | 'createdAt' | 'lastUpdatedAt'>
 }
 
-export interface IRemoveContactArgs {
-  contactId: string
+export type RemovePartyArgs = {
+  partyId: string
 }
 
-export interface IGetIdentityArgs {
+export type GetIdentityArgs = {
   identityId: string
 }
 
-export interface IGetIdentitiesArgs {
+export type GetIdentitiesArgs = {
   filter?: FindIdentityArgs
 }
 
-export interface IAddIdentityArgs {
-  contactId: string
-  identity: IBasicIdentity
+export type AddIdentityArgs = {
+  partyId: string
+  identity: NonPersistedIdentity
 }
 
-export interface IUpdateIdentityArgs {
-  identity: IIdentity
+export type UpdateIdentityArgs = {
+  identity: Identity
 }
 
-export interface IRemoveIdentityArgs {
+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: PartyTypeEnum
+  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
+}

package/src/types/contact/contact.ts

@@ -1,82 +1,87 @@
 import { IIdentifier } from '@veramo/core'
 
-export enum IdentityRoleEnum {
-  ISSUER = 'issuer',
-  VERIFIER = 'verifier',
-  HOLDER = 'holder',
-}
-
-export enum ConnectionTypeEnum {
-  OPENID_CONNECT = 'OIDC',
-  SIOPv2 = 'SIOPv2',
-  SIOPv2_OpenID4VP = 'SIOPv2+OpenID4VP',
-}
-
-export enum CorrelationIdentifierEnum {
-  DID = 'did',
-  URL = 'url',
-}
-
-export interface IContact {
+export type Party = {
   id: string
-  name: string
-  alias: string
   uri?: string
   roles: Array<IdentityRoleEnum>
-  identities: Array<IIdentity>
+  identities: Array<Identity>
+  electronicAddresses: Array<ElectronicAddress>
+  contact: Contact
+  partyType: PartyType
+  relationships: Array<PartyRelationship>
   createdAt: Date
   lastUpdatedAt: Date
 }
-export interface IBasicContact {
-  name: string
-  alias: string
-  uri?: string
-  identities?: Array<IBasicIdentity>
+export type NonPersistedParty = Omit<
+  Party,
+  'id' | 'identities' | 'electronicAddresses' | 'contact' | 'roles' | 'partyType' | 'relationships' | 'createdAt' | 'lastUpdatedAt'
+> & {
+  identities?: Array<NonPersistedIdentity>
+  electronicAddresses?: Array<NonPersistedElectronicAddress>
+  contact: NonPersistedContact
+  partyType: NonPersistedPartyType
+  relationships?: Array<NonPersistedPartyRelationship>
+}
+export type PartialParty = Partial<Omit<Party, 'identities' | 'electronicAddresses' | 'contact' | 'partyType' | 'relationships'>> & {
+  identities?: PartialIdentity
+  electronicAddresses?: PartialElectronicAddress
+  contact?: PartialContact
+  partyType?: PartialPartyType
+  relationships?: PartialPartyRelationship
 }
 
-export interface IIdentity {
+export type Identity = {
   id: string
   alias: string
   roles: Array<IdentityRoleEnum>
-  identifier: ICorrelationIdentifier
-  connection?: IConnection
-  metadata?: Array<IMetadataItem>
+  identifier: CorrelationIdentifier
+  connection?: Connection
+  metadata?: Array<MetadataItem>
   createdAt: Date
   lastUpdatedAt: Date
 }
-export interface IBasicIdentity {
-  alias: string
-  roles: Array<IdentityRoleEnum>
-  identifier: BasicCorrelationIdentifier
-  connection?: IBasicConnection
-  metadata?: Array<BasicMetadataItem>
+export type NonPersistedIdentity = Omit<Identity, 'id' | 'identifier' | 'connection' | 'metadata' | 'createdAt' | 'lastUpdatedAt'> & {
+  identifier: NonPersistedCorrelationIdentifier
+  connection?: NonPersistedConnection
+  metadata?: Array<NonPersistedMetadataItem>
+}
+export type PartialIdentity = Partial<Omit<Identity, 'identifier' | 'connection' | 'metadata' | 'roles'>> & {
+  identifier?: PartialCorrelationIdentifier
+  connection?: PartialConnection
+  metadata?: PartialMetadataItem
+  roles?: IdentityRoleEnum
+  partyId?: string
 }
 
-export interface IMetadataItem {
+export type MetadataItem = {
   id: string
   label: string
   value: string
 }
-export declare type BasicMetadataItem = Omit<IMetadataItem, 'id'>
+export type NonPersistedMetadataItem = Omit<MetadataItem, 'id'>
+export type PartialMetadataItem = Partial<MetadataItem>
 
-export interface ICorrelationIdentifier {
+export type CorrelationIdentifier = {
   id: string
   type: CorrelationIdentifierEnum
   correlationId: string
 }
-export declare type BasicCorrelationIdentifier = Omit<ICorrelationIdentifier, 'id'>
+export type NonPersistedCorrelationIdentifier = Omit<CorrelationIdentifier, 'id'>
+export type PartialCorrelationIdentifier = Partial<CorrelationIdentifier>
 
-export interface IConnection {
+export type Connection = {
   id: string
   type: ConnectionTypeEnum
   config: ConnectionConfig
 }
-export interface IBasicConnection {
-  type: ConnectionTypeEnum
-  config: BasicConnectionConfig
+export type NonPersistedConnection = Omit<Connection, 'id' | 'config'> & {
+  config: NonPersistedConnectionConfig
+}
+export type PartialConnection = Partial<Omit<Connection, 'config'>> & {
+  config: PartialConnectionConfig
 }
 
-export interface IOpenIdConfig {
+export type OpenIdConfig = {
   id: string
   clientId: string
   clientSecret: string
@@ -86,16 +91,105 @@ export interface IOpenIdConfig {
   dangerouslyAllowInsecureHttpRequests: boolean
   clientAuthMethod: 'basic' | 'post' | undefined
 }
-export declare type BasicOpenIdConfig = Omit<IOpenIdConfig, 'id'>
+export type NonPersistedOpenIdConfig = Omit<OpenIdConfig, 'id'>
+export type PartialOpenIdConfig = Partial<OpenIdConfig>
 
-export interface IDidAuthConfig {
+export type DidAuthConfig = {
   id: string
   identifier: IIdentifier
   stateId: string
   redirectUrl: string
   sessionId: string
 }
-export declare type BasicDidAuthConfig = Omit<IDidAuthConfig, 'id'>
+export type NonPersistedDidAuthConfig = Omit<DidAuthConfig, 'id'>
+export type PartialDidAuthConfig = Partial<Omit<DidAuthConfig, 'identifier'>> & {
+  identifier: Partial<IIdentifier> // TODO, we need to create partials for sub types in IIdentifier
+}
+
+export type ConnectionConfig = OpenIdConfig | DidAuthConfig
+export type NonPersistedConnectionConfig = NonPersistedDidAuthConfig | NonPersistedOpenIdConfig
+export type PartialConnectionConfig = PartialOpenIdConfig | PartialDidAuthConfig
 
-export declare type ConnectionConfig = IOpenIdConfig | IDidAuthConfig
-export declare type BasicConnectionConfig = BasicDidAuthConfig | BasicOpenIdConfig
+export type NaturalPerson = {
+  id: string
+  firstName: string
+  lastName: string
+  middleName?: string
+  displayName: string
+  createdAt: Date
+  lastUpdatedAt: Date
+}
+export type NonPersistedNaturalPerson = Omit<NaturalPerson, 'id' | 'createdAt' | 'lastUpdatedAt'>
+export type PartialNaturalPerson = Partial<NaturalPerson>
+
+export type Organization = {
+  id: string
+  legalName: string
+  displayName: string
+  createdAt: Date
+  lastUpdatedAt: Date
+}
+export type NonPersistedOrganization = Omit<Organization, 'id' | 'createdAt' | 'lastUpdatedAt'>
+export type PartialOrganization = Partial<Organization>
+
+export type Contact = NaturalPerson | Organization
+export type NonPersistedContact = NonPersistedNaturalPerson | NonPersistedOrganization
+export type PartialContact = PartialNaturalPerson | PartialOrganization
+
+export type PartyType = {
+  id: string
+  type: PartyTypeEnum
+  name: string
+  tenantId: string
+  description?: string
+  createdAt: Date
+  lastUpdatedAt: Date
+}
+export type NonPersistedPartyType = Omit<PartyType, 'id' | 'createdAt' | 'lastUpdatedAt'> & {
+  id?: string
+}
+export type PartialPartyType = Partial<PartyType>
+
+export type PartyRelationship = {
+  id: string
+  leftId: string
+  rightId: string
+  createdAt: Date
+  lastUpdatedAt: Date
+}
+export type NonPersistedPartyRelationship = Omit<PartyRelationship, 'id' | 'createdAt' | 'lastUpdatedAt'>
+export type PartialPartyRelationship = Partial<PartyRelationship>
+
+export type ElectronicAddress = {
+  id: string
+  type: ElectronicAddressType
+  electronicAddress: string
+  createdAt: Date
+  lastUpdatedAt: Date
+}
+export type NonPersistedElectronicAddress = Omit<ElectronicAddress, 'id' | 'createdAt' | 'lastUpdatedAt'>
+export type PartialElectronicAddress = Partial<ElectronicAddress>
+
+export type ElectronicAddressType = 'email'
+
+export enum IdentityRoleEnum {
+  ISSUER = 'issuer',
+  VERIFIER = 'verifier',
+  HOLDER = 'holder',
+}
+
+export enum ConnectionTypeEnum {
+  OPENID_CONNECT = 'OIDC',
+  SIOPv2 = 'SIOPv2',
+  SIOPv2_OpenID4VP = 'SIOPv2+OpenID4VP',
+}
+
+export enum CorrelationIdentifierEnum {
+  DID = 'did',
+  URL = 'url',
+}
+
+export enum PartyTypeEnum {
+  NATURAL_PERSON = 'naturalPerson',
+  ORGANIZATION = 'organization',
+}

package/src/types/index.ts

@@ -2,3 +2,7 @@ export * from './issuanceBranding/issuanceBranding'
 export * from './issuanceBranding/IAbstractIssuanceBrandingStore'
 export * from './contact/contact'
 export * from './contact/IAbstractContactStore'
+
+export * from './validation/validation'
+export * from './statusList/statusList'
+export * from './statusList/IAbstractStatusListStore'

package/src/types/statusList/IAbstractStatusListStore.ts

@@ -0,0 +1,47 @@
+import { FindOptionsWhere } from 'typeorm'
+import { IStatusListEntity, IStatusListEntryEntity } from './statusList'
+
+export type FindStatusListArgs = FindOptionsWhere<IStatusListEntity>[]
+export type FindStatusListEntryArgs = FindOptionsWhere<IStatusListEntryEntity>[] | FindOptionsWhere<IStatusListEntryEntity>
+
+export interface IStatusListEntryAvailableArgs {
+  statusListId?: string
+  correlationId?: string
+  statusListIndex: number | number[]
+}
+
+export interface IGetStatusListEntryByIndexArgs {
+  statusListId?: string
+  correlationId?: string
+  statusListIndex: number
+  errorOnNotFound?: boolean
+}
+
+export interface IGetStatusListEntryByCredentialIdArgs {
+  statusListId?: string
+  statusListCorrelationId?: string
+  entryCorrelationId?: string
+  credentialId: string
+  errorOnNotFound?: boolean
+}
+export interface IGetStatusListEntriesArgs {
+  statusListId: string
+  filter?: FindStatusListEntryArgs
+}
+
+export type IAddStatusListEntryArgs = IStatusListEntryEntity
+
+export interface IGetStatusListArgs {
+  id?: string
+  correlationId?: string
+}
+
+export type IRemoveStatusListArgs = IGetStatusListArgs
+
+export interface IGetStatusListsArgs {
+  filter?: FindStatusListArgs
+}
+
+export type IAddStatusListArgs = IStatusListEntity
+
+export type IUpdateStatusListIndexArgs = IStatusListEntity

package/src/types/statusList/statusList.ts

@@ -0,0 +1,39 @@
+import {
+  IIssuer,
+  OriginalVerifiableCredential,
+  StatusListCredentialIdMode,
+  StatusListDriverType,
+  StatusListIndexingDirection,
+  StatusListType,
+  StatusPurpose2021,
+} from '@sphereon/ssi-types'
+import { ProofFormat } from '@veramo/core'
+import { StatusListEntity } from '../../entities/statusList2021/StatusList2021Entity'
+
+export interface IStatusListEntity {
+  id: string
+  correlationId: string
+  driverType: StatusListDriverType
+  credentialIdMode: StatusListCredentialIdMode
+  length: number
+  issuer: string | IIssuer
+  type: StatusListType
+  proofFormat: ProofFormat
+  indexingDirection: StatusListIndexingDirection
+  statusPurpose: StatusPurpose2021
+  statusListCredential?: OriginalVerifiableCredential
+}
+
+export interface IStatusListEntryEntity {
+  statusList: StatusListEntity | string // string is here to accept the id, so we can query it easily with typeorm
+
+  value?: string
+
+  statusListIndex: number
+
+  credentialHash?: string
+
+  credentialId?: string
+
+  correlationId?: string
+}

package/src/types/validation/validation.ts

@@ -0,0 +1,3 @@
+export type ValidationConstraint = {
+  [x: string]: string
+}

package/src/utils/ValidatorUtils.ts

@@ -0,0 +1,10 @@
+import { ValidationError } from 'class-validator'
+import { ValidationConstraint } from '../types'
+
+export const getConstraint = (validation: ValidationError): ValidationConstraint | undefined => {
+  if (validation.children && validation.children.length > 0) {
+    return getConstraint(validation.children[0])
+  } else {
+    return validation.constraints
+  }
+}