@sphereon/ssi-sdk.data-store 0.24.0 → 0.24.1-next.100

package/src/types/index.ts

@@ -1,6 +1,8 @@
 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'

package/src/types/presentationDefinition/IAbstractPDStore.ts

@@ -0,0 +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

package/src/types/presentationDefinition/presentationDefinition.ts

@@ -0,0 +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?

package/src/utils/contact/MappingUtils.ts

@@ -1,4 +1,5 @@
 import {
+  MetadataTypes,
   Connection,
   ConnectionConfig,
   Contact,
@@ -28,7 +29,7 @@ import {
   Party,
   PartyRelationship,
   PartyType,
-  PhysicalAddress,
+  PhysicalAddress
 } from '../../types'
 import { PartyEntity } from '../../entities/contact/PartyEntity'
 import { IdentityEntity } from '../../entities/contact/IdentityEntity'
@@ -45,6 +46,7 @@ import { IdentityMetadataItemEntity } from '../../entities/contact/IdentityMetad
 import { OpenIdConfigEntity } from '../../entities/contact/OpenIdConfigEntity'
 import { PartyTypeEntity } from '../../entities/contact/PartyTypeEntity'
 import { PhysicalAddressEntity } from '../../entities/contact/PhysicalAddressEntity'
+import { ContactMetadataItemEntity } from '../../entities/contact/ContactMetadataItemEntity'
 
 export const partyEntityFrom = (party: NonPersistedParty): PartyEntity => {
   const partyEntity: PartyEntity = new PartyEntity()
@@ -58,6 +60,8 @@ export const partyEntityFrom = (party: NonPersistedParty): PartyEntity => {
     : []
   partyEntity.partyType = partyTypeEntityFrom(party.partyType)
   partyEntity.contact = contactEntityFrom(party.contact)
+  partyEntity.ownerId = party.ownerId
+  partyEntity.tenantId = party.tenantId
 
   return partyEntity
 }
@@ -77,6 +81,8 @@ export const partyFrom = (party: PartyEntity): Party => {
     relationships: party.relationships ? party.relationships.map((relationship: PartyRelationshipEntity) => partyRelationshipFrom(relationship)) : [],
     partyType: partyTypeFrom(party.partyType),
     contact: contactFrom(party.contact),
+    ownerId: party.ownerId,
+    tenantId: party.tenantId,
     createdAt: party.createdAt,
     lastUpdatedAt: party.lastUpdatedAt,
   }
@@ -112,6 +118,8 @@ export const connectionEntityFrom = (connection: NonPersistedConnection): Connec
   const connectionEntity: ConnectionEntity = new ConnectionEntity()
   connectionEntity.type = connection.type
   connectionEntity.config = configEntityFrom(connection.config)
+  connectionEntity.ownerId = connection.ownerId
+  connectionEntity.tenantId = connection.tenantId
 
   return connectionEntity
 }
@@ -120,6 +128,8 @@ export const connectionFrom = (connection: ConnectionEntity): Connection => {
   return {
     id: connection.id,
     type: connection.type,
+    ownerId: connection.ownerId,
+    tenantId: connection.tenantId,
     config: configFrom(connection.config),
   }
 }
@@ -138,6 +148,8 @@ export const correlationIdentifierEntityFrom = (identifier: NonPersistedCorrelat
   const identifierEntity: CorrelationIdentifierEntity = new CorrelationIdentifierEntity()
   identifierEntity.type = identifier.type
   identifierEntity.correlationId = identifier.correlationId
+  identifierEntity.ownerId = identifier.ownerId
+  identifierEntity.tenantId = identifier.tenantId
 
   return identifierEntity
 }
@@ -147,6 +159,8 @@ export const correlationIdentifierFrom = (identifier: CorrelationIdentifierEntit
     id: identifier.id,
     type: identifier.type,
     correlationId: identifier.correlationId,
+    ownerId: identifier.ownerId,
+    tenantId: identifier.tenantId,
   }
 }
 
@@ -155,7 +169,8 @@ export const didAuthConfigEntityFrom = (config: NonPersistedDidAuthConfig): DidA
   didAuthConfig.identifier = config.identifier.did
   didAuthConfig.redirectUrl = config.redirectUrl
   didAuthConfig.sessionId = config.sessionId
-
+  didAuthConfig.ownerId = config.ownerId
+  didAuthConfig.tenantId = config.tenantId
   return didAuthConfig
 }
 
@@ -163,6 +178,8 @@ export const electronicAddressEntityFrom = (electronicAddress: NonPersistedElect
   const electronicAddressEntity: ElectronicAddressEntity = new ElectronicAddressEntity()
   electronicAddressEntity.type = electronicAddress.type
   electronicAddressEntity.electronicAddress = electronicAddress.electronicAddress
+  electronicAddressEntity.ownerId = electronicAddress.ownerId
+  electronicAddressEntity.tenantId = electronicAddress.tenantId
 
   return electronicAddressEntity
 }
@@ -172,6 +189,8 @@ export const electronicAddressFrom = (electronicAddress: ElectronicAddressEntity
     id: electronicAddress.id,
     type: electronicAddress.type,
     electronicAddress: electronicAddress.electronicAddress,
+    ownerId: electronicAddress.ownerId,
+    tenantId: electronicAddress.tenantId,
     createdAt: electronicAddress.createdAt,
     lastUpdatedAt: electronicAddress.lastUpdatedAt,
   }
@@ -187,6 +206,8 @@ export const physicalAddressEntityFrom = (physicalAddress: NonPersistedPhysicalA
   physicalAddressEntity.provinceName = physicalAddress.provinceName
   physicalAddressEntity.countryCode = physicalAddress.countryCode
   physicalAddressEntity.buildingName = physicalAddress.buildingName
+  physicalAddressEntity.ownerId = physicalAddress.ownerId
+  physicalAddressEntity.tenantId = physicalAddress.tenantId
 
   return physicalAddressEntity
 }
@@ -202,19 +223,27 @@ export const physicalAddressFrom = (physicalAddress: PhysicalAddressEntity): Phy
     provinceName: physicalAddress.provinceName,
     countryCode: physicalAddress.countryCode,
     buildingName: physicalAddress.buildingName,
+    ownerId: physicalAddress.ownerId,
+    tenantId: physicalAddress.tenantId,
     createdAt: physicalAddress.createdAt,
     lastUpdatedAt: physicalAddress.lastUpdatedAt,
   }
 }
 
-export const identityEntityFrom = (args: NonPersistedIdentity): IdentityEntity => {
+export const identityEntityFrom = (entity: NonPersistedIdentity): IdentityEntity => {
   const identityEntity: IdentityEntity = new IdentityEntity()
-  identityEntity.alias = args.alias
-  identityEntity.roles = args.roles
-  identityEntity.identifier = correlationIdentifierEntityFrom(args.identifier)
-  identityEntity.connection = args.connection ? connectionEntityFrom(args.connection) : undefined
-  identityEntity.metadata = args.metadata ? args.metadata.map((item: NonPersistedMetadataItem) => metadataItemEntityFrom(item)) : []
-
+  identityEntity.alias = entity.alias
+  identityEntity.origin = entity.origin
+  identityEntity.ownerId = entity.ownerId
+  identityEntity.tenantId = entity.tenantId
+  identityEntity.roles = entity.roles
+  identityEntity.identifier = correlationIdentifierEntityFrom(entity.identifier)
+  identityEntity.connection = entity.connection ? connectionEntityFrom(entity.connection) : undefined
+  identityEntity.metadata = entity.metadata
+    ? entity.metadata
+        .map(identityMetadataItemEntityFrom)
+        .filter((entity): entity is IdentityMetadataItemEntity => entity !== undefined)
+    : []
   return identityEntity
 }
 
@@ -222,7 +251,10 @@ export const identityFrom = (identity: IdentityEntity): Identity => {
   return {
     id: identity.id,
     alias: identity.alias,
+    origin: identity.origin,
     roles: identity.roles,
+    tenantId: identity.tenantId,
+    ownerId: identity.ownerId,
     identifier: correlationIdentifierFrom(identity.identifier),
     ...(identity.connection && { connection: connectionFrom(identity.connection) }),
     metadata: identity.metadata ? identity.metadata.map((item: IdentityMetadataItemEntity) => metadataItemFrom(item)) : [],
@@ -231,20 +263,75 @@ export const identityFrom = (identity: IdentityEntity): Identity => {
   }
 }
 
-export const metadataItemEntityFrom = (item: NonPersistedMetadataItem): IdentityMetadataItemEntity => {
-  const metadataItemEntity: IdentityMetadataItemEntity = new IdentityMetadataItemEntity()
-  metadataItemEntity.label = item.label
-  metadataItemEntity.value = item.value
+const metadataItemEntityFrom = <T extends MetadataTypes, U extends { new (): any }>(
+  item: NonPersistedMetadataItem<T>,
+  EntityClass: U,
+): InstanceType<U> | undefined => {
+  const { label, value } = item
+
+  if (value === null || value === undefined) {
+    return undefined
+  }
 
+  const metadataItemEntity = new EntityClass()
+  metadataItemEntity.label = label
+  metadataItemEntity.valueType = typeof value
+
+  switch (typeof value) {
+    case 'undefined':
+      return undefined
+    case 'string':
+      metadataItemEntity.stringValue = value
+      break
+    case 'number':
+      metadataItemEntity.numberValue = value
+      break
+    case 'boolean':
+      metadataItemEntity.boolValue = value
+      break
+    case 'object':
+      metadataItemEntity.valueType = Object.prototype.toString.call(value).slice(8, -1)
+      if (value instanceof Date) {
+        metadataItemEntity.dateValue = value
+      } else {
+        // For now, we only support / implement not-primitive type Date in the entity
+        throw new Error(`Unsupported object type: ${metadataItemEntity.valueType} for value ${value}`)
+      }
+      break
+  }
   return metadataItemEntity
 }
 
-export const metadataItemFrom = (item: IdentityMetadataItemEntity): MetadataItem => {
-  return {
-    id: item.id,
-    label: item.label,
-    value: item.value,
+export const identityMetadataItemEntityFrom = (item: NonPersistedMetadataItem<MetadataTypes>): IdentityMetadataItemEntity | undefined => {
+  return metadataItemEntityFrom(item, IdentityMetadataItemEntity)
+}
+
+export const contactMetadataItemEntityFrom = (item: NonPersistedMetadataItem<MetadataTypes>): ContactMetadataItemEntity | undefined => {
+  return metadataItemEntityFrom(item, ContactMetadataItemEntity)
+}
+
+export const metadataItemFrom = (entity: IdentityMetadataItemEntity | ContactMetadataItemEntity): MetadataItem<MetadataTypes> => {
+  const item: Partial<MetadataItem<MetadataTypes>> = {
+    id: entity.id,
+    label: entity.label,
+  }
+  switch (entity.valueType) {
+    case 'string':
+      item.value = entity.stringValue
+      break
+    case 'number':
+      item.value = entity.numberValue
+      break
+    case 'Date':
+      item.value = entity.dateValue
+      break
+    case 'boolean':
+      item.value = entity.boolValue
+      break
+    default:
+      throw new Error(`Unsupported valueType ${entity.valueType}`)
   }
+  return item as MetadataItem<MetadataTypes>
 }
 
 export const naturalPersonEntityFrom = (naturalPerson: NonPersistedNaturalPerson): NaturalPersonEntity => {
@@ -253,6 +340,13 @@ export const naturalPersonEntityFrom = (naturalPerson: NonPersistedNaturalPerson
   naturalPersonEntity.middleName = naturalPerson.middleName
   naturalPersonEntity.lastName = naturalPerson.lastName
   naturalPersonEntity.displayName = naturalPerson.displayName
+  naturalPersonEntity.ownerId = naturalPerson.ownerId
+  naturalPersonEntity.tenantId = naturalPerson.tenantId
+  naturalPersonEntity.metadata = naturalPerson.metadata
+    ? naturalPerson.metadata
+        .map(contactMetadataItemEntityFrom)
+        .filter((entity): entity is ContactMetadataItemEntity => entity !== undefined)
+    : []
 
   return naturalPersonEntity
 }
@@ -264,6 +358,9 @@ export const naturalPersonFrom = (naturalPerson: NaturalPersonEntity): NaturalPe
     middleName: naturalPerson.middleName,
     lastName: naturalPerson.lastName,
     displayName: naturalPerson.displayName,
+    metadata: naturalPerson.metadata ? naturalPerson.metadata.map((item: ContactMetadataItemEntity) => metadataItemFrom(item)) : [],
+    ownerId: naturalPerson.ownerId,
+    tenantId: naturalPerson.tenantId,
     createdAt: naturalPerson.createdAt,
     lastUpdatedAt: naturalPerson.lastUpdatedAt,
   }
@@ -278,6 +375,8 @@ export const openIdConfigEntityFrom = (config: NonPersistedOpenIdConfig): OpenId
   openIdConfig.redirectUrl = config.redirectUrl
   openIdConfig.dangerouslyAllowInsecureHttpRequests = config.dangerouslyAllowInsecureHttpRequests
   openIdConfig.clientAuthMethod = config.clientAuthMethod
+  openIdConfig.ownerId = config.ownerId
+  openIdConfig.tenantId = config.tenantId
 
   return openIdConfig
 }
@@ -286,6 +385,13 @@ export const organizationEntityFrom = (organization: NonPersistedOrganization):
   const organizationEntity: OrganizationEntity = new OrganizationEntity()
   organizationEntity.legalName = organization.legalName
   organizationEntity.displayName = organization.displayName
+  organizationEntity.ownerId = organization.ownerId
+  organizationEntity.tenantId = organization.tenantId
+  organizationEntity.metadata = organization.metadata
+    ? organization.metadata
+        .map(contactMetadataItemEntityFrom)
+        .filter((entity): entity is ContactMetadataItemEntity => entity !== undefined)
+    : []
 
   return organizationEntity
 }
@@ -295,6 +401,9 @@ export const organizationFrom = (organization: OrganizationEntity): Organization
     id: organization.id,
     legalName: organization.legalName,
     displayName: organization.displayName,
+    metadata: organization.metadata ? organization.metadata.map((item: ContactMetadataItemEntity) => metadataItemFrom(item)) : [],
+    ownerId: organization.ownerId,
+    tenantId: organization.tenantId,
     createdAt: organization.createdAt,
     lastUpdatedAt: organization.lastUpdatedAt,
   }
@@ -304,7 +413,8 @@ export const partyRelationshipEntityFrom = (relationship: NonPersistedPartyRelat
   const partyRelationshipEntity: PartyRelationshipEntity = new PartyRelationshipEntity()
   partyRelationshipEntity.leftId = relationship.leftId
   partyRelationshipEntity.rightId = relationship.rightId
-
+  partyRelationshipEntity.ownerId = relationship.ownerId
+  partyRelationshipEntity.tenantId = relationship.tenantId
   return partyRelationshipEntity
 }
 
@@ -313,6 +423,8 @@ export const partyRelationshipFrom = (relationship: PartyRelationshipEntity): Pa
     id: relationship.id,
     leftId: relationship.leftId,
     rightId: relationship.rightId,
+    ownerId: relationship.ownerId,
+    tenantId: relationship.tenantId,
     createdAt: relationship.createdAt,
     lastUpdatedAt: relationship.lastUpdatedAt,
   }
@@ -365,6 +477,8 @@ export const openIdConfigFrom = (config: OpenIdConfigEntity): OpenIdConfig => {
     redirectUrl: config.redirectUrl,
     dangerouslyAllowInsecureHttpRequests: config.dangerouslyAllowInsecureHttpRequests,
     clientAuthMethod: config.clientAuthMethod,
+    ownerId: config.ownerId,
+    tenantId: config.tenantId,
   }
 }
 
@@ -375,6 +489,8 @@ export const didAuthConfigFrom = (config: DidAuthConfigEntity): DidAuthConfig =>
     stateId: '', // FIXME
     redirectUrl: config.redirectUrl,
     sessionId: config.sessionId,
+    ownerId: config.ownerId,
+    tenantId: config.tenantId,
   }
 }
 

package/src/utils/presentationDefinition/MappingUtils.ts

@@ -0,0 +1,52 @@
+import { PresentationDefinitionItemEntity } from '../../entities/presentationDefinition/PresentationDefinitionItemEntity'
+import { IPresentationDefinition } from '@sphereon/pex'
+import { NonPersistedPresentationDefinitionItem, PartialPresentationDefinitionItem, PresentationDefinitionItem } from '../../types'
+import { blake2bHex } from 'blakejs'
+
+export const presentationDefinitionItemFrom = (entity: PresentationDefinitionItemEntity): PresentationDefinitionItem => {
+  return {
+    id: entity.id,
+    tenantId: entity.tenantId,
+    definitionId: entity.definitionId,
+    version: entity.version,
+    name: entity.name,
+    purpose: entity.purpose,
+    definitionPayload: JSON.parse(entity.definitionPayload) as IPresentationDefinition,
+    createdAt: entity.createdAt,
+    lastUpdatedAt: entity.lastUpdatedAt,
+  }
+}
+
+export const presentationDefinitionEntityItemFrom = (item: NonPersistedPresentationDefinitionItem): PresentationDefinitionItemEntity => {
+  const entity = new PresentationDefinitionItemEntity()
+
+  entity.tenantId = item.tenantId
+  entity.definitionId = item.definitionId!
+  entity.version = item.version
+  entity.name = item.name
+  entity.purpose = item.purpose
+  entity.definitionPayload = JSON.stringify(item.definitionPayload!)
+  return entity
+}
+
+function hashPayload(payload: IPresentationDefinition): string {
+  return blake2bHex(JSON.stringify(payload))
+}
+
+export function isPresentationDefinitionEqual(base: PartialPresentationDefinitionItem, compare: PartialPresentationDefinitionItem): boolean {
+  if (
+    base.definitionId !== compare.definitionId ||
+    base.tenantId != compare.tenantId ||
+    base.version !== compare.version ||
+    base.name != compare.name ||
+    base.purpose != compare.purpose
+  ) {
+    return false
+  }
+
+  if (base.definitionPayload && compare.definitionPayload) {
+    return hashPayload(base.definitionPayload) === hashPayload(compare.definitionPayload)
+  }
+
+  return false
+}