@sphereon/ssi-sdk.data-store 0.30.2-unstable.9 → 0.31.0

package/src/types/contact/contact.ts

@@ -1,6 +1,6 @@
 import { ManagedIdentifierOptsOrResult } from '@sphereon/ssi-sdk-ext.identifier-resolution'
 import { IIdentifier } from '@veramo/core'
-import { ILocaleBranding } from '../issuanceBranding/issuanceBranding'
+import { IIssuerLocaleBranding } from '../issuanceBranding/issuanceBranding'
 import { CredentialRole } from '../digitalCredential/digitalCredential'
 
 export type MetadataTypes = string | number | Date | boolean | undefined
@@ -26,7 +26,7 @@ export type Party = {
   contact: Contact
   partyType: PartyType
   /**
-   * TODO: Integrate branding logic here in the future.
+   * TODO: Integrate branding logic here in the future. What we should do is make the issuance branding plugin part of the contact-manager and retrieve any branding there is.
    *
    * Currently, we are only defining the branding type within the SDK without implementing the associated logic. This is because:
    * 1. We are combining two types from the SSI-SDK to create a new type that will be used across multiple places in the wallets (web & mobile).
@@ -35,7 +35,7 @@ export type Party = {
    *
    * For now, we are defining the type here and will use it in the mobile wallet has the logic for it. This is a temporary solution until we have the resources to integrate the branding logic fully.
    */
-  branding?: ILocaleBranding
+  branding?: IIssuerLocaleBranding
   relationships: Array<PartyRelationship>
   createdAt: Date
   lastUpdatedAt: Date

package/src/types/digitalCredential/digitalCredential.ts

@@ -93,6 +93,7 @@ export enum CredentialRole {
   ISSUER = 'ISSUER',
   VERIFIER = 'VERIFIER',
   HOLDER = 'HOLDER',
+  FEDERATION_TRUST_ANCHOR = 'FEDERATION_TRUST_ANCHOR',
 }
 
 export enum CredentialStateType {

package/src/types/eventLogger/IAbstractEventLoggerStore.ts

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

package/src/types/eventLogger/eventLogger.ts

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

package/src/types/issuanceBranding/issuanceBranding.ts

@@ -52,17 +52,29 @@ export interface IImageDimensions {
 export interface IBasicImageDimensions extends Omit<IImageDimensions, 'id'> {}
 export interface IPartialImageDimensions extends Partial<IImageDimensions> {}
 
-export interface ICredentialLocaleBranding extends ILocaleBranding {}
+export interface ICredentialClaim {
+  id: string
+  key: string
+  name: string
+}
+export interface IBasicCredentialClaim extends Omit<ICredentialClaim, 'id'> {}
+export interface IPartialCredentialClaim extends Partial<ICredentialClaim> {}
+
+export interface ICredentialLocaleBranding extends ILocaleBranding {
+  claims?: Array<ICredentialClaim>
+}
 export interface IBasicCredentialLocaleBranding
-  extends Omit<ICredentialLocaleBranding, 'id' | 'createdAt' | 'lastUpdatedAt' | 'logo' | 'background' | 'text'> {
+  extends Omit<ICredentialLocaleBranding, 'id' | 'createdAt' | 'lastUpdatedAt' | 'logo' | 'background' | 'text' | 'claims'> {
   logo?: IBasicImageAttributes
   background?: IBasicBackgroundAttributes
   text?: IBasicTextAttributes
+  claims?: Array<IBasicCredentialClaim>
 }
-export interface IPartialCredentialLocaleBranding extends Partial<Omit<ICredentialLocaleBranding, 'logo' | 'background' | 'text'>> {
+export interface IPartialCredentialLocaleBranding extends Partial<Omit<ICredentialLocaleBranding, 'logo' | 'background' | 'text' | 'claims'>> {
   logo?: IPartialImageAttributes
   background?: IPartialBackgroundAttributes
   text?: IPartialTextAttributes
+  claims?: IPartialCredentialClaim
 }
 
 export interface ICredentialBranding {
@@ -80,17 +92,23 @@ export interface IPartialCredentialBranding extends Partial<Omit<ICredentialBran
   localeBranding?: IPartialCredentialLocaleBranding
 }
 
-export interface IIssuerLocaleBranding extends ILocaleBranding {}
+export interface IIssuerLocaleBranding extends ILocaleBranding {
+  clientUri?: string
+  tosUri?: string
+  policyUri?: string
+  contacts?: Array<string>
+}
 export interface IBasicIssuerLocaleBranding
   extends Omit<IIssuerLocaleBranding, 'id' | 'createdAt' | 'lastUpdatedAt' | 'logo' | 'background' | 'text'> {
   logo?: IBasicImageAttributes
   background?: IBasicBackgroundAttributes
   text?: IBasicTextAttributes
 }
-export interface IPartialIssuerLocaleBranding extends Partial<Omit<IIssuerLocaleBranding, 'logo' | 'background' | 'text'>> {
+export interface IPartialIssuerLocaleBranding extends Partial<Omit<IIssuerLocaleBranding, 'logo' | 'background' | 'text' | 'contacts'>> {
   logo?: IPartialImageAttributes
   background?: IPartialBackgroundAttributes
   text?: IPartialTextAttributes
+  contacts?: string
 }
 
 export interface IIssuerBranding {
@@ -103,7 +121,7 @@ export interface IIssuerBranding {
 export interface IBasicIssuerBranding extends Omit<IIssuerBranding, 'id' | 'createdAt' | 'lastUpdatedAt' | 'localeBranding'> {
   localeBranding: Array<IBasicIssuerLocaleBranding>
 }
-export interface IPartialIssuerBranding extends Partial<Omit<ICredentialBranding, 'localeBranding'>> {
+export interface IPartialIssuerBranding extends Partial<Omit<IIssuerBranding, 'localeBranding'>> {
   localeBranding?: IPartialIssuerLocaleBranding
 }
 

package/src/utils/FormattingUtils.ts

@@ -0,0 +1,21 @@
+export const replaceNullWithUndefined = (obj: any): any => {
+  if (obj === null) {
+    return undefined
+  }
+
+  if (typeof obj !== 'object' || obj instanceof Date) {
+    return obj
+  }
+
+  if (Array.isArray(obj)) {
+    return obj.map((value: any) => replaceNullWithUndefined(value))
+  }
+
+  const result: any = {}
+  for (const key in obj) {
+    if (obj.hasOwnProperty(key)) {
+      result[key] = replaceNullWithUndefined(obj[key])
+    }
+  }
+  return result
+}

package/src/utils/contact/MappingUtils.ts

@@ -47,6 +47,7 @@ import { OpenIdConfigEntity } from '../../entities/contact/OpenIdConfigEntity'
 import { PartyTypeEntity } from '../../entities/contact/PartyTypeEntity'
 import { PhysicalAddressEntity } from '../../entities/contact/PhysicalAddressEntity'
 import { ContactMetadataItemEntity } from '../../entities/contact/ContactMetadataItemEntity'
+import { replaceNullWithUndefined } from '../FormattingUtils'
 
 export const partyEntityFrom = (party: NonPersistedParty): PartyEntity => {
   const partyEntity: PartyEntity = new PartyEntity()
@@ -67,10 +68,10 @@ export const partyEntityFrom = (party: NonPersistedParty): PartyEntity => {
 }
 
 export const partyFrom = (party: PartyEntity): Party => {
-  return {
+  const result: Party = {
     id: party.id,
     uri: party.uri,
-    roles: [...new Set(party.identities?.flatMap((identity: IdentityEntity) => identity.roles))] ?? [],
+    roles: [...new Set(party.identities?.flatMap((identity: IdentityEntity) => identity.roles))],
     identities: party.identities ? party.identities.map((identity: IdentityEntity) => identityFrom(identity)) : [],
     electronicAddresses: party.electronicAddresses
       ? party.electronicAddresses.map((electronicAddress: ElectronicAddressEntity) => electronicAddressFrom(electronicAddress))
@@ -86,6 +87,8 @@ export const partyFrom = (party: PartyEntity): Party => {
     createdAt: party.createdAt,
     lastUpdatedAt: party.lastUpdatedAt,
   }
+
+  return replaceNullWithUndefined(result)
 }
 
 export const contactEntityFrom = (contact: NonPersistedContact): BaseContactEntity => {
@@ -125,13 +128,15 @@ export const connectionEntityFrom = (connection: NonPersistedConnection): Connec
 }
 
 export const connectionFrom = (connection: ConnectionEntity): Connection => {
-  return {
+  const result: Connection = {
     id: connection.id,
     type: connection.type,
     ownerId: connection.ownerId,
     tenantId: connection.tenantId,
     config: configFrom(connection.config),
   }
+
+  return replaceNullWithUndefined(result)
 }
 
 const configEntityFrom = (config: NonPersistedConnectionConfig): BaseConfigEntity => {
@@ -155,13 +160,15 @@ export const correlationIdentifierEntityFrom = (identifier: NonPersistedCorrelat
 }
 
 export const correlationIdentifierFrom = (identifier: CorrelationIdentifierEntity): CorrelationIdentifier => {
-  return {
+  const result: CorrelationIdentifier = {
     id: identifier.id,
     type: identifier.type,
     correlationId: identifier.correlationId,
     ownerId: identifier.ownerId,
     tenantId: identifier.tenantId,
   }
+
+  return replaceNullWithUndefined(result)
 }
 
 export const didAuthConfigEntityFrom = (config: NonPersistedDidAuthConfig): DidAuthConfigEntity => {
@@ -196,7 +203,7 @@ export const electronicAddressEntityFrom = (electronicAddress: NonPersistedElect
 }
 
 export const electronicAddressFrom = (electronicAddress: ElectronicAddressEntity): ElectronicAddress => {
-  return {
+  const result: ElectronicAddress = {
     id: electronicAddress.id,
     type: electronicAddress.type,
     electronicAddress: electronicAddress.electronicAddress,
@@ -205,6 +212,8 @@ export const electronicAddressFrom = (electronicAddress: ElectronicAddressEntity
     createdAt: electronicAddress.createdAt,
     lastUpdatedAt: electronicAddress.lastUpdatedAt,
   }
+
+  return replaceNullWithUndefined(result)
 }
 
 export const physicalAddressEntityFrom = (physicalAddress: NonPersistedPhysicalAddress): PhysicalAddressEntity => {
@@ -224,7 +233,7 @@ export const physicalAddressEntityFrom = (physicalAddress: NonPersistedPhysicalA
 }
 
 export const physicalAddressFrom = (physicalAddress: PhysicalAddressEntity): PhysicalAddress => {
-  return {
+  const result: PhysicalAddress = {
     id: physicalAddress.id,
     type: physicalAddress.type,
     streetName: physicalAddress.streetName,
@@ -239,6 +248,8 @@ export const physicalAddressFrom = (physicalAddress: PhysicalAddressEntity): Phy
     createdAt: physicalAddress.createdAt,
     lastUpdatedAt: physicalAddress.lastUpdatedAt,
   }
+
+  return replaceNullWithUndefined(result)
 }
 
 export const identityEntityFrom = (entity: NonPersistedIdentity): IdentityEntity => {
@@ -257,7 +268,7 @@ export const identityEntityFrom = (entity: NonPersistedIdentity): IdentityEntity
 }
 
 export const identityFrom = (identity: IdentityEntity): Identity => {
-  return {
+  const result: Identity = {
     id: identity.id,
     alias: identity.alias,
     origin: identity.origin,
@@ -270,6 +281,8 @@ export const identityFrom = (identity: IdentityEntity): Identity => {
     createdAt: identity.createdAt,
     lastUpdatedAt: identity.createdAt,
   }
+
+  return replaceNullWithUndefined(result)
 }
 
 const metadataItemEntityFrom = <T extends MetadataTypes, U extends { new (): any }>(
@@ -359,7 +372,7 @@ export const naturalPersonEntityFrom = (naturalPerson: NonPersistedNaturalPerson
 }
 
 export const naturalPersonFrom = (naturalPerson: NaturalPersonEntity): NaturalPerson => {
-  return {
+  const result: NaturalPerson = {
     id: naturalPerson.id,
     firstName: naturalPerson.firstName,
     middleName: naturalPerson.middleName,
@@ -371,6 +384,8 @@ export const naturalPersonFrom = (naturalPerson: NaturalPersonEntity): NaturalPe
     createdAt: naturalPerson.createdAt,
     lastUpdatedAt: naturalPerson.lastUpdatedAt,
   }
+
+  return replaceNullWithUndefined(result)
 }
 
 export const openIdConfigEntityFrom = (config: NonPersistedOpenIdConfig): OpenIdConfigEntity => {
@@ -402,7 +417,7 @@ export const organizationEntityFrom = (organization: NonPersistedOrganization):
 }
 
 export const organizationFrom = (organization: OrganizationEntity): Organization => {
-  return {
+  const result: Organization = {
     id: organization.id,
     legalName: organization.legalName,
     displayName: organization.displayName,
@@ -412,6 +427,8 @@ export const organizationFrom = (organization: OrganizationEntity): Organization
     createdAt: organization.createdAt,
     lastUpdatedAt: organization.lastUpdatedAt,
   }
+
+  return replaceNullWithUndefined(result)
 }
 
 export const partyRelationshipEntityFrom = (relationship: NonPersistedPartyRelationship): PartyRelationshipEntity => {
@@ -420,11 +437,12 @@ export const partyRelationshipEntityFrom = (relationship: NonPersistedPartyRelat
   partyRelationshipEntity.rightId = relationship.rightId
   partyRelationshipEntity.ownerId = relationship.ownerId
   partyRelationshipEntity.tenantId = relationship.tenantId
+
   return partyRelationshipEntity
 }
 
 export const partyRelationshipFrom = (relationship: PartyRelationshipEntity): PartyRelationship => {
-  return {
+  const result: PartyRelationship = {
     id: relationship.id,
     leftId: relationship.leftId,
     rightId: relationship.rightId,
@@ -433,6 +451,8 @@ export const partyRelationshipFrom = (relationship: PartyRelationshipEntity): Pa
     createdAt: relationship.createdAt,
     lastUpdatedAt: relationship.lastUpdatedAt,
   }
+
+  return replaceNullWithUndefined(result)
 }
 
 export const partyTypeEntityFrom = (args: NonPersistedPartyType): PartyTypeEntity => {
@@ -450,7 +470,7 @@ export const partyTypeEntityFrom = (args: NonPersistedPartyType): PartyTypeEntit
 }
 
 export const partyTypeFrom = (partyType: PartyTypeEntity): PartyType => {
-  return {
+  const result: PartyType = {
     id: partyType.id,
     type: partyType.type,
     origin: partyType.origin,
@@ -460,6 +480,8 @@ export const partyTypeFrom = (partyType: PartyTypeEntity): PartyType => {
     createdAt: partyType.createdAt,
     lastUpdatedAt: partyType.lastUpdatedAt,
   }
+
+  return replaceNullWithUndefined(result)
 }
 
 export const configFrom = (config: BaseConfigEntity): ConnectionConfig => {
@@ -473,7 +495,7 @@ export const configFrom = (config: BaseConfigEntity): ConnectionConfig => {
 }
 
 export const openIdConfigFrom = (config: OpenIdConfigEntity): OpenIdConfig => {
-  return {
+  const result: OpenIdConfig = {
     id: config.id,
     clientId: config.clientId,
     clientSecret: config.clientSecret,
@@ -485,10 +507,12 @@ export const openIdConfigFrom = (config: OpenIdConfigEntity): OpenIdConfig => {
     ownerId: config.ownerId,
     tenantId: config.tenantId,
   }
+
+  return replaceNullWithUndefined(result)
 }
 
 export const didAuthConfigFrom = (config: DidAuthConfigEntity): DidAuthConfig => {
-  return {
+  const result: DidAuthConfig = {
     id: config.id,
     idOpts: { identifier: config.identifier },
     stateId: '', // FIXME
@@ -497,6 +521,8 @@ export const didAuthConfigFrom = (config: DidAuthConfigEntity): DidAuthConfig =>
     ownerId: config.ownerId,
     tenantId: config.tenantId,
   }
+
+  return replaceNullWithUndefined(result)
 }
 
 export const isOpenIdConfig = (config: NonPersistedConnectionConfig | BaseConfigEntity): config is OpenIdConfig | OpenIdConfigEntity =>

package/src/utils/digitalCredential/MappingUtils.ts

@@ -18,6 +18,7 @@ import {
   NonPersistedDigitalCredential,
   RegulationType,
 } from '../../types'
+import { replaceNullWithUndefined } from '../FormattingUtils'
 
 function determineDocumentType(raw: string): DocumentType {
   const rawDocument = parseRawDocument(raw)
@@ -150,9 +151,11 @@ export const nonPersistedDigitalCredentialEntityFromAddArgs = (addCredentialArgs
 }
 
 export const digitalCredentialFrom = (credentialEntity: DigitalCredentialEntity): DigitalCredential => {
-  return {
+  const result: DigitalCredential = {
     ...credentialEntity,
   }
+
+  return replaceNullWithUndefined(result)
 }
 
 export const digitalCredentialsFrom = (credentialEntities: Array<DigitalCredentialEntity>): DigitalCredential[] => {

package/src/utils/eventLogger/MappingUtils.ts

@@ -0,0 +1,117 @@
+import { ActivityLoggingEvent, AuditLoggingEvent } from '@sphereon/ssi-sdk.core'
+import { LoggingEventType } from '@sphereon/ssi-types'
+import { replaceNullWithUndefined } from '../FormattingUtils'
+import { AuditEventEntity } from '../../entities/eventLogger/AuditEventEntity'
+import { NonPersistedActivityLoggingEvent, NonPersistedAuditLoggingEvent } from '../../types'
+
+export const auditEventFrom = (event: AuditEventEntity): AuditLoggingEvent => {
+  const result: AuditLoggingEvent = {
+    id: event.id,
+    type: LoggingEventType.AUDIT,
+    description: event.description,
+    timestamp: event.timestamp,
+    level: event.level,
+    correlationId: event.correlationId,
+    actionType: event.actionType,
+    actionSubType: event.actionSubType,
+    initiatorType: event.initiatorType,
+    partyAlias: event.partyAlias,
+    partyCorrelationId: event.partyCorrelationId,
+    partyCorrelationType: event.partyCorrelationType,
+    subSystemType: event.subSystemType,
+    system: event.system,
+    systemAlias: event.systemAlias,
+    systemCorrelationId: event.systemCorrelationId,
+    systemCorrelationIdType: event.systemCorrelationIdType,
+    ...(event.data && { data: JSON.parse(event.data) }),
+    ...(event.diagnosticData && { diagnosticData: JSON.parse(event.diagnosticData) }),
+  }
+
+  return replaceNullWithUndefined(result)
+}
+
+export const auditEventEntityFrom = (args: NonPersistedAuditLoggingEvent): AuditEventEntity => {
+  const auditEventEntity: AuditEventEntity = new AuditEventEntity()
+  auditEventEntity.type = LoggingEventType.AUDIT
+  auditEventEntity.timestamp = args.timestamp
+  auditEventEntity.level = args.level
+  auditEventEntity.correlationId = args.correlationId
+  auditEventEntity.system = args.system
+  auditEventEntity.subSystemType = args.subSystemType
+  auditEventEntity.actionType = args.actionType
+  auditEventEntity.actionSubType = args.actionSubType
+  auditEventEntity.initiatorType = args.initiatorType
+  auditEventEntity.systemCorrelationIdType = args.systemCorrelationIdType
+  auditEventEntity.systemCorrelationId = args.systemCorrelationId
+  auditEventEntity.systemAlias = args.systemAlias
+  auditEventEntity.partyCorrelationType = args.partyCorrelationType
+  auditEventEntity.partyCorrelationId = args.partyCorrelationId
+  auditEventEntity.partyAlias = args.partyAlias
+  auditEventEntity.description = args.description
+  auditEventEntity.partyCorrelationType = args.partyCorrelationType
+  auditEventEntity.data = JSON.stringify(args.data)
+  auditEventEntity.diagnosticData = JSON.stringify(args.diagnosticData)
+
+  return auditEventEntity
+}
+
+export const activityEventFrom = (event: AuditEventEntity): ActivityLoggingEvent => {
+  const result: ActivityLoggingEvent = {
+    id: event.id,
+    type: LoggingEventType.ACTIVITY,
+    credentialType: event.credentialType!,
+    originalCredential: event.originalCredential,
+    credentialHash: event.credentialHash,
+    parentCredentialHash: event.parentCredentialHash,
+    sharePurpose: event.sharePurpose,
+    description: event.description,
+    timestamp: event.timestamp,
+    level: event.level,
+    correlationId: event.correlationId,
+    actionType: event.actionType,
+    actionSubType: event.actionSubType,
+    initiatorType: event.initiatorType,
+    partyAlias: event.partyAlias,
+    partyCorrelationId: event.partyCorrelationId,
+    partyCorrelationType: event.partyCorrelationType,
+    subSystemType: event.subSystemType,
+    system: event.system,
+    systemAlias: event.systemAlias,
+    systemCorrelationId: event.systemCorrelationId,
+    systemCorrelationIdType: event.systemCorrelationIdType,
+    ...(event.data && { data: JSON.parse(event.data) }),
+    ...(event.diagnosticData && { diagnosticData: JSON.parse(event.diagnosticData) }),
+  }
+
+  return replaceNullWithUndefined(result)
+}
+
+export const activityEventEntityFrom = (args: NonPersistedActivityLoggingEvent): AuditEventEntity => {
+  const activityEventEntity: AuditEventEntity = new AuditEventEntity()
+  activityEventEntity.type = LoggingEventType.ACTIVITY
+  activityEventEntity.timestamp = args.timestamp
+  activityEventEntity.level = args.level
+  activityEventEntity.correlationId = args.correlationId
+  activityEventEntity.system = args.system
+  activityEventEntity.subSystemType = args.subSystemType
+  activityEventEntity.actionType = args.actionType
+  activityEventEntity.actionSubType = args.actionSubType
+  activityEventEntity.initiatorType = args.initiatorType
+  activityEventEntity.systemCorrelationIdType = args.systemCorrelationIdType
+  activityEventEntity.systemCorrelationId = args.systemCorrelationId
+  activityEventEntity.systemAlias = args.systemAlias
+  activityEventEntity.partyCorrelationType = args.partyCorrelationType
+  activityEventEntity.partyCorrelationId = args.partyCorrelationId
+  activityEventEntity.partyAlias = args.partyAlias
+  activityEventEntity.description = args.description
+  activityEventEntity.partyCorrelationType = args.partyCorrelationType
+  activityEventEntity.data = JSON.stringify(args.data)
+  activityEventEntity.sharePurpose = args.sharePurpose
+  activityEventEntity.credentialType = args.credentialType
+  activityEventEntity.originalCredential = args.originalCredential
+  activityEventEntity.credentialHash = args.credentialHash
+  activityEventEntity.parentCredentialHash = args.parentCredentialHash
+  activityEventEntity.diagnosticData = JSON.stringify(args.diagnosticData)
+
+  return activityEventEntity
+}

package/src/utils/issuanceBranding/MappingUtils.ts

@@ -0,0 +1,145 @@
+import { replaceNullWithUndefined } from '../FormattingUtils'
+import { isEmptyString } from '../../entities/validators'
+import { CredentialBrandingEntity } from '../../entities/issuanceBranding/CredentialBrandingEntity'
+import { BaseLocaleBrandingEntity } from '../../entities/issuanceBranding/BaseLocaleBrandingEntity'
+import { IssuerBrandingEntity } from '../../entities/issuanceBranding/IssuerBrandingEntity'
+import { ImageAttributesEntity } from '../../entities/issuanceBranding/ImageAttributesEntity'
+import { BackgroundAttributesEntity } from '../../entities/issuanceBranding/BackgroundAttributesEntity'
+import { TextAttributesEntity } from '../../entities/issuanceBranding/TextAttributesEntity'
+import { IssuerLocaleBrandingEntity } from '../../entities/issuanceBranding/IssuerLocaleBrandingEntity'
+import { CredentialLocaleBrandingEntity } from '../../entities/issuanceBranding/CredentialLocaleBrandingEntity'
+import { ImageDimensionsEntity } from '../../entities/issuanceBranding/ImageDimensionsEntity'
+import { CredentialClaimsEntity } from '../../entities/issuanceBranding/CredentialClaimsEntity'
+import {
+  IBasicBackgroundAttributes,
+  IBasicCredentialBranding,
+  IBasicCredentialClaim,
+  IBasicCredentialLocaleBranding,
+  IBasicImageAttributes,
+  IBasicImageDimensions,
+  IBasicIssuerBranding,
+  IBasicIssuerLocaleBranding,
+  IBasicTextAttributes,
+  ICredentialBranding,
+  IIssuerBranding,
+  ILocaleBranding,
+} from '../../types'
+
+export const credentialBrandingFrom = (credentialBranding: CredentialBrandingEntity): ICredentialBranding => {
+  const result: ICredentialBranding = {
+    ...credentialBranding,
+    localeBranding: credentialBranding.localeBranding.map((localeBranding: BaseLocaleBrandingEntity) => localeBrandingFrom(localeBranding)),
+  }
+
+  return replaceNullWithUndefined(result)
+}
+
+export const issuerBrandingFrom = (issuerBranding: IssuerBrandingEntity): IIssuerBranding => {
+  const result: IIssuerBranding = {
+    ...issuerBranding,
+    localeBranding: issuerBranding.localeBranding.map((localeBranding: BaseLocaleBrandingEntity) => localeBrandingFrom(localeBranding)),
+  }
+
+  return replaceNullWithUndefined(result)
+}
+
+export const localeBrandingFrom = (localeBranding: BaseLocaleBrandingEntity): ILocaleBranding => {
+  const result: ILocaleBranding = {
+    ...localeBranding,
+    locale: localeBranding.locale === '' ? undefined : localeBranding.locale,
+  }
+
+  return replaceNullWithUndefined(result)
+}
+
+export const issuerLocaleBrandingEntityFrom = (args: IBasicIssuerLocaleBranding): IssuerLocaleBrandingEntity => {
+  const issuerLocaleBrandingEntity: IssuerLocaleBrandingEntity = new IssuerLocaleBrandingEntity()
+  issuerLocaleBrandingEntity.alias = isEmptyString(args.alias) ? undefined : args.alias
+  issuerLocaleBrandingEntity.locale = args.locale ? args.locale : ''
+  issuerLocaleBrandingEntity.logo = args.logo ? imageAttributesEntityFrom(args.logo) : undefined
+  issuerLocaleBrandingEntity.description = isEmptyString(args.description) ? undefined : args.description
+  issuerLocaleBrandingEntity.background = args.background ? backgroundAttributesEntityFrom(args.background) : undefined
+  issuerLocaleBrandingEntity.text = args.text ? textAttributesEntityFrom(args.text) : undefined
+  issuerLocaleBrandingEntity.clientUri = isEmptyString(args.clientUri) ? undefined : args.clientUri
+  issuerLocaleBrandingEntity.tosUri = isEmptyString(args.tosUri) ? undefined : args.tosUri
+  issuerLocaleBrandingEntity.policyUri = isEmptyString(args.policyUri) ? undefined : args.policyUri
+  issuerLocaleBrandingEntity.contacts = args.contacts
+
+  return issuerLocaleBrandingEntity
+}
+
+export const backgroundAttributesEntityFrom = (args: IBasicBackgroundAttributes): BackgroundAttributesEntity => {
+  const backgroundAttributesEntity: BackgroundAttributesEntity = new BackgroundAttributesEntity()
+  backgroundAttributesEntity.color = isEmptyString(args.color) ? undefined : args.color
+  backgroundAttributesEntity.image = args.image ? imageAttributesEntityFrom(args.image) : undefined
+
+  return backgroundAttributesEntity
+}
+
+export const credentialBrandingEntityFrom = (args: IBasicCredentialBranding): CredentialBrandingEntity => {
+  const credentialBrandingEntity: CredentialBrandingEntity = new CredentialBrandingEntity()
+  credentialBrandingEntity.issuerCorrelationId = args.issuerCorrelationId
+  credentialBrandingEntity.vcHash = args.vcHash
+  credentialBrandingEntity.localeBranding = args.localeBranding.map((localeBranding: IBasicCredentialLocaleBranding) =>
+    credentialLocaleBrandingEntityFrom(localeBranding),
+  )
+
+  return credentialBrandingEntity
+}
+
+export const credentialLocaleBrandingEntityFrom = (args: IBasicCredentialLocaleBranding): CredentialLocaleBrandingEntity => {
+  const credentialLocaleBrandingEntity: CredentialLocaleBrandingEntity = new CredentialLocaleBrandingEntity()
+  credentialLocaleBrandingEntity.alias = isEmptyString(args.alias) ? undefined : args.alias
+  credentialLocaleBrandingEntity.locale = args.locale ? args.locale : ''
+  credentialLocaleBrandingEntity.logo = args.logo ? imageAttributesEntityFrom(args.logo) : undefined
+  credentialLocaleBrandingEntity.description = isEmptyString(args.description) ? undefined : args.description
+  credentialLocaleBrandingEntity.background = args.background ? backgroundAttributesEntityFrom(args.background) : undefined
+  credentialLocaleBrandingEntity.text = args.text ? textAttributesEntityFrom(args.text) : undefined
+  credentialLocaleBrandingEntity.claims = args.claims ? args.claims.map((claim) => credentialClaimsEntityFrom(claim)) : []
+
+  return credentialLocaleBrandingEntity
+}
+
+export const imageAttributesEntityFrom = (args: IBasicImageAttributes): ImageAttributesEntity => {
+  const imageAttributesEntity: ImageAttributesEntity = new ImageAttributesEntity()
+  imageAttributesEntity.uri = isEmptyString(args.uri) ? undefined : args.uri
+  imageAttributesEntity.dataUri = isEmptyString(args.dataUri) ? undefined : args.dataUri
+  imageAttributesEntity.mediaType = isEmptyString(args.mediaType) ? undefined : args.mediaType
+  imageAttributesEntity.alt = isEmptyString(args.alt) ? undefined : args.alt
+  imageAttributesEntity.dimensions = args.dimensions ? imageDimensionsEntityFrom(args.dimensions) : undefined
+
+  return imageAttributesEntity
+}
+
+export const imageDimensionsEntityFrom = (args: IBasicImageDimensions): ImageDimensionsEntity => {
+  const imageDimensionsEntity: ImageDimensionsEntity = new ImageDimensionsEntity()
+  imageDimensionsEntity.width = args.width
+  imageDimensionsEntity.height = args.height
+
+  return imageDimensionsEntity
+}
+
+export const issuerBrandingEntityFrom = (args: IBasicIssuerBranding): IssuerBrandingEntity => {
+  const issuerBrandingEntity: IssuerBrandingEntity = new IssuerBrandingEntity()
+  issuerBrandingEntity.issuerCorrelationId = args.issuerCorrelationId
+  issuerBrandingEntity.localeBranding = args.localeBranding.map((localeBranding: IBasicIssuerLocaleBranding) =>
+    issuerLocaleBrandingEntityFrom(localeBranding),
+  )
+
+  return issuerBrandingEntity
+}
+
+export const textAttributesEntityFrom = (args: IBasicTextAttributes): TextAttributesEntity => {
+  const textAttributesEntity: TextAttributesEntity = new TextAttributesEntity()
+  textAttributesEntity.color = isEmptyString(args.color) ? undefined : args.color
+
+  return textAttributesEntity
+}
+
+export const credentialClaimsEntityFrom = (args: IBasicCredentialClaim): CredentialClaimsEntity => {
+  const credentialClaimsEntity: CredentialClaimsEntity = new CredentialClaimsEntity()
+  credentialClaimsEntity.key = args.key
+  credentialClaimsEntity.name = args.name
+
+  return credentialClaimsEntity
+}