@sphereon/ssi-sdk.data-store 0.11.1-next.106

package/src/types/contact/contact.ts

@@ -0,0 +1,101 @@
+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 {
+  id: string
+  name: string
+  alias: string
+  uri?: string
+  roles: Array<IdentityRoleEnum>
+  identities: Array<IIdentity>
+  createdAt: Date
+  lastUpdatedAt: Date
+}
+export interface IBasicContact {
+  name: string
+  alias: string
+  uri?: string
+  identities?: Array<IBasicIdentity>
+}
+
+export interface IIdentity {
+  id: string
+  alias: string
+  roles: Array<IdentityRoleEnum>
+  identifier: ICorrelationIdentifier
+  connection?: IConnection
+  metadata?: Array<IMetadataItem>
+  createdAt: Date
+  lastUpdatedAt: Date
+}
+export interface IBasicIdentity {
+  alias: string
+  roles: Array<IdentityRoleEnum>
+  identifier: BasicCorrelationIdentifier
+  connection?: IBasicConnection
+  metadata?: Array<BasicMetadataItem>
+}
+
+export interface IMetadataItem {
+  id: string
+  label: string
+  value: string
+}
+export declare type BasicMetadataItem = Omit<IMetadataItem, 'id'>
+
+export interface ICorrelationIdentifier {
+  id: string
+  type: CorrelationIdentifierEnum
+  correlationId: string
+}
+export declare type BasicCorrelationIdentifier = Omit<ICorrelationIdentifier, 'id'>
+
+export interface IConnection {
+  id: string
+  type: ConnectionTypeEnum
+  config: ConnectionConfig
+}
+export interface IBasicConnection {
+  type: ConnectionTypeEnum
+  config: BasicConnectionConfig
+}
+
+export interface IOpenIdConfig {
+  id: string
+  clientId: string
+  clientSecret: string
+  scopes: Array<string>
+  issuer: string
+  redirectUrl: string
+  dangerouslyAllowInsecureHttpRequests: boolean
+  clientAuthMethod: 'basic' | 'post' | undefined
+}
+export declare type BasicOpenIdConfig = Omit<IOpenIdConfig, 'id'>
+
+export interface IDidAuthConfig {
+  id: string
+  identifier: IIdentifier
+  stateId: string
+  redirectUrl: string
+  sessionId: string
+}
+export declare type BasicDidAuthConfig = Omit<IDidAuthConfig, 'id'>
+
+export declare type ConnectionConfig = IOpenIdConfig | IDidAuthConfig
+export declare type BasicConnectionConfig = BasicDidAuthConfig | BasicOpenIdConfig

package/src/types/index.ts

@@ -0,0 +1,4 @@
+export * from './issuanceBranding/issuanceBranding'
+export * from './issuanceBranding/IAbstractIssuanceBrandingStore'
+export * from './contact/contact'
+export * from './contact/IAbstractContactStore'

package/src/types/issuanceBranding/IAbstractIssuanceBrandingStore.ts

@@ -0,0 +1,85 @@
+import {
+  IBasicCredentialLocaleBranding,
+  IBasicIssuerLocaleBranding,
+  ICredentialBranding,
+  ICredentialLocaleBrandingFilter,
+  IIssuerBranding,
+  IIssuerBrandingFilter,
+  IIssuerLocaleBrandingFilter,
+  ILocaleBranding,
+  ICredentialBrandingFilter,
+} from './issuanceBranding'
+
+export type FindCredentialBrandingArgs = Array<ICredentialBrandingFilter>
+export type FindCredentialLocaleBrandingArgs = Array<ICredentialLocaleBrandingFilter>
+export type FindIssuerBrandingArgs = Array<IIssuerBrandingFilter>
+export type FindIssuerLocaleBrandingArgs = Array<IIssuerLocaleBrandingFilter>
+
+export interface IAddCredentialBrandingArgs {
+  vcHash: string
+  issuerCorrelationId: string
+  localeBranding: Array<IBasicCredentialLocaleBranding>
+}
+
+export interface IGetCredentialBrandingArgs {
+  filter?: FindCredentialBrandingArgs
+}
+
+export interface IUpdateCredentialBrandingArgs {
+  credentialBranding: Omit<ICredentialBranding, 'localeBranding' | 'createdAt' | 'lastUpdatedAt'>
+}
+
+export interface IRemoveCredentialBrandingArgs {
+  filter: FindCredentialBrandingArgs
+}
+
+export interface IAddCredentialLocaleBrandingArgs {
+  credentialBrandingId: string
+  localeBranding: Array<IBasicCredentialLocaleBranding>
+}
+
+export interface IUpdateCredentialLocaleBrandingArgs {
+  localeBranding: Omit<ILocaleBranding, 'createdAt' | 'lastUpdatedAt'>
+}
+
+export interface IRemoveCredentialLocaleBrandingArgs {
+  filter: FindCredentialLocaleBrandingArgs
+}
+
+export interface IGetCredentialLocaleBrandingArgs {
+  filter?: FindCredentialLocaleBrandingArgs
+}
+
+export interface IAddIssuerBrandingArgs {
+  issuerCorrelationId: string
+  localeBranding: Array<IBasicIssuerLocaleBranding>
+}
+
+export interface IGetIssuerBrandingArgs {
+  filter?: FindIssuerBrandingArgs
+}
+
+export interface IUpdateIssuerBrandingArgs {
+  issuerBranding: Omit<IIssuerBranding, 'localeBranding' | 'createdAt' | 'lastUpdatedAt'>
+}
+
+export interface IRemoveIssuerBrandingArgs {
+  filter: FindIssuerBrandingArgs
+}
+
+export interface IAddIssuerLocaleBrandingArgs {
+  issuerBrandingId: string
+  localeBranding: Array<IBasicIssuerLocaleBranding>
+}
+
+export interface IUpdateIssuerLocaleBrandingArgs {
+  localeBranding: Omit<ILocaleBranding, 'createdAt' | 'lastUpdatedAt'>
+}
+
+export interface IRemoveIssuerLocaleBrandingArgs {
+  filter: FindIssuerLocaleBrandingArgs
+}
+
+export interface IGetIssuerLocaleBrandingArgs {
+  filter?: FindIssuerLocaleBrandingArgs
+}

package/src/types/issuanceBranding/issuanceBranding.ts

@@ -0,0 +1,120 @@
+export interface ILocaleBranding {
+  id: string
+  alias?: string
+  locale?: string
+  logo?: IImageAttributes
+  description?: string
+  background?: IBackgroundAttributes
+  text?: ITextAttributes
+  createdAt: Date
+  lastUpdatedAt: Date
+}
+
+export interface IImageAttributes {
+  id: string
+  uri?: string
+  dataUri?: string
+  mediaType?: string
+  alt?: string
+  dimensions?: IImageDimensions
+}
+export interface IBasicImageAttributes extends Omit<IImageAttributes, 'id' | 'dimensions'> {
+  dimensions?: IBasicImageDimensions
+}
+export interface IPartialImageAttributes extends Partial<Omit<IImageAttributes, 'dimensions'>> {
+  dimensions?: IPartialImageDimensions
+}
+
+export interface IBackgroundAttributes {
+  id: string
+  color?: string
+  image?: IImageAttributes
+}
+export interface IBasicBackgroundAttributes extends Omit<IBackgroundAttributes, 'id' | 'image'> {
+  image?: IBasicImageAttributes
+}
+export interface IPartialBackgroundAttributes extends Partial<Omit<IBackgroundAttributes, 'image'>> {
+  image?: IPartialImageAttributes
+}
+
+export interface ITextAttributes {
+  id: string
+  color?: string
+}
+export interface IBasicTextAttributes extends Omit<ITextAttributes, 'id'> {}
+export interface IPartialTextAttributes extends Partial<ITextAttributes> {}
+
+export interface IImageDimensions {
+  id: string
+  width: number
+  height: number
+}
+export interface IBasicImageDimensions extends Omit<IImageDimensions, 'id'> {}
+export interface IPartialImageDimensions extends Partial<IImageDimensions> {}
+
+export interface ICredentialLocaleBranding extends ILocaleBranding {}
+export interface IBasicCredentialLocaleBranding
+  extends Omit<ICredentialLocaleBranding, 'id' | 'createdAt' | 'lastUpdatedAt' | 'logo' | 'background' | 'text'> {
+  logo?: IBasicImageAttributes
+  background?: IBasicBackgroundAttributes
+  text?: IBasicTextAttributes
+}
+export interface IPartialCredentialLocaleBranding extends Partial<Omit<ICredentialLocaleBranding, 'logo' | 'background' | 'text'>> {
+  logo?: IPartialImageAttributes
+  background?: IPartialBackgroundAttributes
+  text?: IPartialTextAttributes
+}
+
+export interface ICredentialBranding {
+  id: string
+  issuerCorrelationId: string
+  vcHash: string
+  localeBranding: Array<ICredentialLocaleBranding>
+  createdAt: Date
+  lastUpdatedAt: Date
+}
+export interface IBasicCredentialBranding extends Omit<ICredentialBranding, 'id' | 'createdAt' | 'lastUpdatedAt' | 'localeBranding'> {
+  localeBranding: Array<IBasicCredentialLocaleBranding>
+}
+export interface IPartialCredentialBranding extends Partial<Omit<ICredentialBranding, 'localeBranding'>> {
+  localeBranding?: IPartialCredentialLocaleBranding
+}
+
+export interface IIssuerLocaleBranding extends ILocaleBranding {}
+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'>> {
+  logo?: IPartialImageAttributes
+  background?: IPartialBackgroundAttributes
+  text?: IPartialTextAttributes
+}
+
+export interface IIssuerBranding {
+  id: string
+  issuerCorrelationId: string
+  localeBranding: Array<IIssuerLocaleBranding>
+  createdAt: Date
+  lastUpdatedAt: Date
+}
+export interface IBasicIssuerBranding extends Omit<IIssuerBranding, 'id' | 'createdAt' | 'lastUpdatedAt' | 'localeBranding'> {
+  localeBranding: Array<IBasicIssuerLocaleBranding>
+}
+export interface IPartialIssuerBranding extends Partial<Omit<ICredentialBranding, 'localeBranding'>> {
+  localeBranding?: IPartialIssuerLocaleBranding
+}
+
+export interface ICredentialBrandingFilter extends IPartialCredentialBranding {}
+
+export interface ICredentialLocaleBrandingFilter extends IPartialCredentialLocaleBranding {
+  credentialBranding?: IPartialCredentialBranding
+}
+
+export interface IIssuerBrandingFilter extends IPartialIssuerBranding {}
+
+export interface IIssuerLocaleBrandingFilter extends IPartialIssuerLocaleBranding {
+  issuerBranding?: IPartialIssuerBranding
+}