@sphereon/ssi-sdk.data-store 0.30.2-feature.CWALL.254.basedon.from.funke.78 → 0.30.2-feature.FIDES.integration.225

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

@@ -80,17 +80,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 +109,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/eventLogger/MappingUtils.ts

@@ -1,10 +1,13 @@
-import { AuditEventEntity } from '../../entities/eventLogger/AuditEventEntity'
-import { AuditLoggingEvent } from '@sphereon/ssi-sdk.core'
+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,
@@ -26,3 +29,88 @@ export const auditEventFrom = (event: AuditEventEntity): AuditLoggingEvent => {
 
   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,
+    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

@@ -1,8 +1,27 @@
+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 { replaceNullWithUndefined } from '../FormattingUtils'
-import { ICredentialBranding, IIssuerBranding, ILocaleBranding } from '../../types'
+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 {
+  IBasicBackgroundAttributes,
+  IBasicCredentialBranding,
+  IBasicCredentialLocaleBranding,
+  IBasicImageAttributes,
+  IBasicImageDimensions,
+  IBasicIssuerBranding,
+  IBasicIssuerLocaleBranding,
+  IBasicTextAttributes,
+  ICredentialBranding,
+  IIssuerBranding,
+  ILocaleBranding
+} from '../../types'
 
 export const credentialBrandingFrom = (credentialBranding: CredentialBrandingEntity): ICredentialBranding => {
   const result: ICredentialBranding = {
@@ -30,3 +49,87 @@ export const localeBrandingFrom = (localeBranding: BaseLocaleBrandingEntity): IL
 
   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
+
+  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
+}