@sphereon/ssi-sdk.data-store-types 0.34.1-feat.SSISDK.55.243

package/dist/index.d.ts

@@ -0,0 +1,916 @@
+import { ManagedIdentifierOptsOrResult } from '@sphereon/ssi-sdk-ext.identifier-resolution';
+import { IIdentifier } from '@veramo/core';
+import { CredentialRole, HasherSync } from '@sphereon/ssi-types';
+import { AuditLoggingEvent, ActivityLoggingEvent, PartialAuditLoggingEvent, PartialActivityLoggingEvent } from '@sphereon/ssi-sdk.core';
+import { DcqlQuery } from 'dcql';
+
+interface ILocaleBranding {
+    id: string;
+    alias?: string;
+    locale?: string;
+    logo?: IImageAttributes;
+    description?: string;
+    background?: IBackgroundAttributes;
+    text?: ITextAttributes;
+    createdAt: Date;
+    lastUpdatedAt: Date;
+}
+interface IImageAttributes {
+    id: string;
+    uri?: string;
+    dataUri?: string;
+    mediaType?: string;
+    alt?: string;
+    dimensions?: IImageDimensions;
+}
+interface IBasicImageAttributes extends Omit<IImageAttributes, 'id' | 'dimensions'> {
+    dimensions?: IBasicImageDimensions;
+}
+interface IPartialImageAttributes extends Partial<Omit<IImageAttributes, 'dimensions'>> {
+    dimensions?: IPartialImageDimensions;
+}
+interface IBackgroundAttributes {
+    id: string;
+    color?: string;
+    image?: IImageAttributes;
+}
+interface IBasicBackgroundAttributes extends Omit<IBackgroundAttributes, 'id' | 'image'> {
+    image?: IBasicImageAttributes;
+}
+interface IPartialBackgroundAttributes extends Partial<Omit<IBackgroundAttributes, 'image'>> {
+    image?: IPartialImageAttributes;
+}
+interface ITextAttributes {
+    id: string;
+    color?: string;
+}
+interface IBasicTextAttributes extends Omit<ITextAttributes, 'id'> {
+}
+interface IPartialTextAttributes extends Partial<ITextAttributes> {
+}
+interface IImageDimensions {
+    id: string;
+    width: number;
+    height: number;
+}
+interface IBasicImageDimensions extends Omit<IImageDimensions, 'id'> {
+}
+interface IPartialImageDimensions extends Partial<IImageDimensions> {
+}
+interface ICredentialClaim {
+    id: string;
+    key: string;
+    name: string;
+}
+interface IBasicCredentialClaim extends Omit<ICredentialClaim, 'id'> {
+}
+interface IPartialCredentialClaim extends Partial<ICredentialClaim> {
+}
+interface ICredentialLocaleBranding extends ILocaleBranding {
+    claims?: Array<ICredentialClaim>;
+}
+interface IBasicCredentialLocaleBranding extends Omit<ICredentialLocaleBranding, 'id' | 'createdAt' | 'lastUpdatedAt' | 'logo' | 'background' | 'text' | 'claims'> {
+    logo?: IBasicImageAttributes;
+    background?: IBasicBackgroundAttributes;
+    text?: IBasicTextAttributes;
+    claims?: Array<IBasicCredentialClaim>;
+}
+interface IPartialCredentialLocaleBranding extends Partial<Omit<ICredentialLocaleBranding, 'logo' | 'background' | 'text' | 'claims'>> {
+    logo?: IPartialImageAttributes;
+    background?: IPartialBackgroundAttributes;
+    text?: IPartialTextAttributes;
+    claims?: IPartialCredentialClaim;
+}
+interface ICredentialBranding {
+    id: string;
+    issuerCorrelationId: string;
+    vcHash: string;
+    localeBranding: Array<ICredentialLocaleBranding>;
+    createdAt: Date;
+    lastUpdatedAt: Date;
+}
+interface IBasicCredentialBranding extends Omit<ICredentialBranding, 'id' | 'createdAt' | 'lastUpdatedAt' | 'localeBranding'> {
+    localeBranding: Array<IBasicCredentialLocaleBranding>;
+}
+interface IPartialCredentialBranding extends Partial<Omit<ICredentialBranding, 'localeBranding'>> {
+    localeBranding?: IPartialCredentialLocaleBranding;
+}
+interface IIssuerLocaleBranding extends ILocaleBranding {
+    clientUri?: string;
+    tosUri?: string;
+    policyUri?: string;
+    contacts?: Array<string>;
+}
+interface IBasicIssuerLocaleBranding extends Omit<IIssuerLocaleBranding, 'id' | 'createdAt' | 'lastUpdatedAt' | 'logo' | 'background' | 'text'> {
+    logo?: IBasicImageAttributes;
+    background?: IBasicBackgroundAttributes;
+    text?: IBasicTextAttributes;
+}
+interface IPartialIssuerLocaleBranding extends Partial<Omit<IIssuerLocaleBranding, 'logo' | 'background' | 'text' | 'contacts'>> {
+    logo?: IPartialImageAttributes;
+    background?: IPartialBackgroundAttributes;
+    text?: IPartialTextAttributes;
+    contacts?: string;
+}
+interface IIssuerBranding {
+    id: string;
+    issuerCorrelationId: string;
+    localeBranding: Array<IIssuerLocaleBranding>;
+    createdAt: Date;
+    lastUpdatedAt: Date;
+}
+interface IBasicIssuerBranding extends Omit<IIssuerBranding, 'id' | 'createdAt' | 'lastUpdatedAt' | 'localeBranding'> {
+    localeBranding: Array<IBasicIssuerLocaleBranding>;
+}
+interface IPartialIssuerBranding extends Partial<Omit<IIssuerBranding, 'localeBranding'>> {
+    localeBranding?: IPartialIssuerLocaleBranding;
+}
+interface ICredentialBrandingFilter extends IPartialCredentialBranding {
+}
+interface ICredentialLocaleBrandingFilter extends IPartialCredentialLocaleBranding {
+    credentialBranding?: IPartialCredentialBranding;
+}
+interface IIssuerBrandingFilter extends IPartialIssuerBranding {
+}
+interface IIssuerLocaleBrandingFilter extends IPartialIssuerLocaleBranding {
+    issuerBranding?: IPartialIssuerBranding;
+}
+
+type FindCredentialBrandingArgs = Array<ICredentialBrandingFilter>;
+type FindCredentialLocaleBrandingArgs = Array<ICredentialLocaleBrandingFilter>;
+type FindIssuerBrandingArgs = Array<IIssuerBrandingFilter>;
+type FindIssuerLocaleBrandingArgs = Array<IIssuerLocaleBrandingFilter>;
+interface IAddCredentialBrandingArgs {
+    vcHash: string;
+    issuerCorrelationId: string;
+    localeBranding: Array<IBasicCredentialLocaleBranding>;
+}
+interface IGetCredentialBrandingArgs {
+    filter?: FindCredentialBrandingArgs;
+}
+interface IUpdateCredentialBrandingArgs {
+    credentialBranding: Omit<ICredentialBranding, 'localeBranding' | 'createdAt' | 'lastUpdatedAt'>;
+}
+interface IRemoveCredentialBrandingArgs {
+    filter: FindCredentialBrandingArgs;
+}
+interface IAddCredentialLocaleBrandingArgs {
+    credentialBrandingId: string;
+    localeBranding: Array<IBasicCredentialLocaleBranding>;
+}
+interface IUpdateCredentialLocaleBrandingArgs {
+    localeBranding: Omit<ILocaleBranding, 'createdAt' | 'lastUpdatedAt'>;
+}
+interface IRemoveCredentialLocaleBrandingArgs {
+    filter: FindCredentialLocaleBrandingArgs;
+}
+interface IGetCredentialLocaleBrandingArgs {
+    filter?: FindCredentialLocaleBrandingArgs;
+}
+interface IAddIssuerBrandingArgs {
+    issuerCorrelationId: string;
+    localeBranding: Array<IBasicIssuerLocaleBranding>;
+}
+interface IGetIssuerBrandingArgs {
+    filter?: FindIssuerBrandingArgs;
+}
+interface IUpdateIssuerBrandingArgs {
+    issuerBranding: Omit<IIssuerBranding, 'localeBranding' | 'createdAt' | 'lastUpdatedAt'>;
+}
+interface IRemoveIssuerBrandingArgs {
+    filter: FindIssuerBrandingArgs;
+}
+interface IAddIssuerLocaleBrandingArgs {
+    issuerBrandingId: string;
+    localeBranding: Array<IBasicIssuerLocaleBranding>;
+}
+interface IUpdateIssuerLocaleBrandingArgs {
+    localeBranding: Omit<ILocaleBranding, 'createdAt' | 'lastUpdatedAt'>;
+}
+interface IRemoveIssuerLocaleBrandingArgs {
+    filter: FindIssuerLocaleBrandingArgs;
+}
+interface IGetIssuerLocaleBrandingArgs {
+    filter?: FindIssuerLocaleBrandingArgs;
+}
+
+type MetadataTypes = string | number | Date | boolean | undefined;
+interface IMetadataEntity {
+    label: string;
+    stringValue?: string;
+    numberValue?: number;
+    dateValue?: Date;
+    boolValue?: boolean;
+}
+type Party = {
+    id: string;
+    uri?: string;
+    roles: Array<CredentialRole>;
+    ownerId?: string;
+    tenantId?: string;
+    identities: Array<Identity>;
+    electronicAddresses: Array<ElectronicAddress>;
+    physicalAddresses: Array<PhysicalAddress>;
+    contact: Contact;
+    partyType: PartyType;
+    /**
+     * 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).
+     * 2. While it makes sense to have this combined type in the SDK, the logic to support database connections for these types is complex. The types belong to different modules, and we don't use them together currently.
+     * 3. Implementing the full logic now would require significant changes and cross-module interactions, which we don't have the time to address at present.
+     *
+     * 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?: IIssuerLocaleBranding;
+    relationships: Array<PartyRelationship>;
+    createdAt: Date;
+    lastUpdatedAt: Date;
+};
+type NonPersistedParty = Omit<Party, 'id' | 'identities' | 'electronicAddresses' | 'physicalAddresses' | 'contact' | 'roles' | 'partyType' | 'relationships' | 'createdAt' | 'lastUpdatedAt'> & {
+    identities?: Array<NonPersistedIdentity>;
+    electronicAddresses?: Array<NonPersistedElectronicAddress>;
+    physicalAddresses?: Array<NonPersistedPhysicalAddress>;
+    contact: NonPersistedContact;
+    partyType: NonPersistedPartyType;
+    relationships?: Array<NonPersistedPartyRelationship>;
+};
+type PartialParty = Partial<Omit<Party, 'identities' | 'electronicAddresses' | 'physicalAddresses' | 'contact' | 'partyType' | 'relationships'>> & {
+    identities?: PartialIdentity;
+    electronicAddresses?: PartialElectronicAddress;
+    physicalAddresses?: PartialPhysicalAddress;
+    contact?: PartialContact;
+    partyType?: PartialPartyType;
+    relationships?: PartialPartyRelationship;
+};
+type Identity = {
+    id: string;
+    alias: string;
+    ownerId?: string;
+    tenantId?: string;
+    origin: IdentityOrigin;
+    roles: Array<CredentialRole>;
+    identifier: CorrelationIdentifier;
+    connection?: Connection;
+    metadata?: Array<MetadataItem<MetadataTypes>>;
+    createdAt: Date;
+    lastUpdatedAt: Date;
+};
+type NonPersistedIdentity = Omit<Identity, 'id' | 'identifier' | 'connection' | 'metadata' | 'origin' | 'createdAt' | 'lastUpdatedAt'> & {
+    origin: IdentityOrigin;
+    identifier: NonPersistedCorrelationIdentifier;
+    connection?: NonPersistedConnection;
+    metadata?: Array<NonPersistedMetadataItem<MetadataTypes>>;
+};
+type PartialIdentity = Partial<Omit<Identity, 'identifier' | 'connection' | 'metadata' | 'origin' | 'roles'>> & {
+    identifier?: PartialCorrelationIdentifier;
+    connection?: PartialConnection;
+    metadata?: PartialMetadataItem<MetadataTypes>;
+    origin?: IdentityOrigin;
+    roles?: CredentialRole;
+    partyId?: string;
+};
+type MetadataItem<T extends MetadataTypes> = {
+    id: string;
+    label: string;
+    value: T;
+};
+type NonPersistedMetadataItem<T extends MetadataTypes> = Omit<MetadataItem<T>, 'id'>;
+type PartialMetadataItem<T extends MetadataTypes> = Partial<MetadataItem<T>>;
+type CorrelationIdentifier = {
+    id: string;
+    ownerId?: string;
+    tenantId?: string;
+    type: CorrelationIdentifierType;
+    correlationId: string;
+};
+type NonPersistedCorrelationIdentifier = Omit<CorrelationIdentifier, 'id'>;
+type PartialCorrelationIdentifier = Partial<CorrelationIdentifier>;
+type Connection = {
+    id: string;
+    ownerId?: string;
+    tenantId?: string;
+    type: ConnectionType;
+    config: ConnectionConfig;
+};
+type NonPersistedConnection = Omit<Connection, 'id' | 'config'> & {
+    config: NonPersistedConnectionConfig;
+};
+type PartialConnection = Partial<Omit<Connection, 'config'>> & {
+    config: PartialConnectionConfig;
+};
+type OpenIdConfig = {
+    id: string;
+    clientId: string;
+    clientSecret: string;
+    ownerId?: string;
+    tenantId?: string;
+    scopes: Array<string>;
+    issuer: string;
+    redirectUrl: string;
+    dangerouslyAllowInsecureHttpRequests: boolean;
+    clientAuthMethod: 'basic' | 'post' | undefined;
+};
+type NonPersistedOpenIdConfig = Omit<OpenIdConfig, 'id'>;
+type PartialOpenIdConfig = Partial<OpenIdConfig>;
+type DidAuthConfig = {
+    id: string;
+    idOpts: ManagedIdentifierOptsOrResult;
+    stateId: string;
+    ownerId?: string;
+    tenantId?: string;
+    redirectUrl: string;
+    sessionId: string;
+};
+type NonPersistedDidAuthConfig = Omit<DidAuthConfig, 'id'>;
+type PartialDidAuthConfig = Partial<Omit<DidAuthConfig, 'identifier'>> & {
+    identifier: Partial<IIdentifier>;
+};
+type ConnectionConfig = OpenIdConfig | DidAuthConfig;
+type NonPersistedConnectionConfig = NonPersistedDidAuthConfig | NonPersistedOpenIdConfig;
+type PartialConnectionConfig = PartialOpenIdConfig | PartialDidAuthConfig;
+type NaturalPerson = {
+    id: string;
+    firstName: string;
+    lastName: string;
+    middleName?: string;
+    displayName: string;
+    metadata?: Array<MetadataItem<MetadataTypes>>;
+    ownerId?: string;
+    tenantId?: string;
+    createdAt: Date;
+    lastUpdatedAt: Date;
+};
+type NonPersistedNaturalPerson = Omit<NaturalPerson, 'id' | 'createdAt' | 'lastUpdatedAt'>;
+type PartialNaturalPerson = Partial<Omit<NaturalPerson, 'metadata'>> & {
+    metadata?: PartialMetadataItem<MetadataTypes>;
+};
+type Organization = {
+    id: string;
+    legalName: string;
+    displayName: string;
+    metadata?: Array<MetadataItem<MetadataTypes>>;
+    ownerId?: string;
+    tenantId?: string;
+    createdAt: Date;
+    lastUpdatedAt: Date;
+};
+type NonPersistedOrganization = Omit<Organization, 'id' | 'createdAt' | 'lastUpdatedAt'>;
+type PartialOrganization = Partial<Omit<Organization, 'metadata'>> & {
+    metadata?: PartialMetadataItem<MetadataTypes>;
+};
+type Contact = NaturalPerson | Organization;
+type NonPersistedContact = NonPersistedNaturalPerson | NonPersistedOrganization;
+type PartialContact = PartialNaturalPerson | PartialOrganization;
+type PartyType = {
+    id: string;
+    type: PartyTypeType;
+    origin: PartyOrigin;
+    name: string;
+    tenantId: string;
+    description?: string;
+    createdAt: Date;
+    lastUpdatedAt: Date;
+};
+type NonPersistedPartyType = Omit<PartyType, 'id' | 'createdAt' | 'lastUpdatedAt'> & {
+    id?: string;
+};
+type PartialPartyType = Partial<PartyType>;
+type PartyRelationship = {
+    id: string;
+    leftId: string;
+    rightId: string;
+    ownerId?: string;
+    tenantId?: string;
+    createdAt: Date;
+    lastUpdatedAt: Date;
+};
+type NonPersistedPartyRelationship = Omit<PartyRelationship, 'id' | 'createdAt' | 'lastUpdatedAt'>;
+type PartialPartyRelationship = Partial<PartyRelationship>;
+type ElectronicAddress = {
+    id: string;
+    type: ElectronicAddressType;
+    electronicAddress: string;
+    ownerId?: string;
+    tenantId?: string;
+    createdAt: Date;
+    lastUpdatedAt: Date;
+};
+type NonPersistedElectronicAddress = Omit<ElectronicAddress, 'id' | 'createdAt' | 'lastUpdatedAt'>;
+type PartialElectronicAddress = Partial<ElectronicAddress> & {
+    partyId?: string;
+};
+type PhysicalAddress = {
+    id: string;
+    type: PhysicalAddressType;
+    streetName: string;
+    streetNumber: string;
+    postalCode: string;
+    cityName: string;
+    provinceName: string;
+    countryCode: string;
+    buildingName?: string;
+    ownerId?: string;
+    tenantId?: string;
+    createdAt: Date;
+    lastUpdatedAt: Date;
+};
+type NonPersistedPhysicalAddress = Omit<PhysicalAddress, 'id' | 'createdAt' | 'lastUpdatedAt'>;
+type PartialPhysicalAddress = Partial<PhysicalAddress> & {
+    partyId?: string;
+};
+type ElectronicAddressType = 'email' | 'phone';
+type PhysicalAddressType = 'home' | 'visit' | 'postal';
+declare enum ConnectionType {
+    OPENID_CONNECT = "OIDC",
+    SIOPv2 = "SIOPv2",
+    SIOPv2_OpenID4VP = "SIOPv2+OpenID4VP"
+}
+declare enum CorrelationIdentifierType {
+    DID = "did",
+    URL = "url"
+}
+declare enum PartyTypeType {
+    NATURAL_PERSON = "naturalPerson",
+    ORGANIZATION = "organization"
+}
+declare enum PartyOrigin {
+    INTERNAL = "INTERNAL",
+    EXTERNAL = "EXTERNAL"
+}
+declare enum IdentityOrigin {
+    INTERNAL = "INTERNAL",
+    EXTERNAL = "EXTERNAL"
+}
+
+type FindPartyArgs = Array<PartialParty>;
+type FindIdentityArgs = Array<PartialIdentity>;
+type FindPartyTypeArgs = Array<PartialPartyType>;
+type FindRelationshipArgs = Array<PartialPartyRelationship>;
+type FindElectronicAddressArgs = Array<PartialElectronicAddress>;
+type FindPhysicalAddressArgs = Array<PartialPhysicalAddress>;
+type GetPartyArgs = {
+    partyId: string;
+};
+type GetPartiesArgs = {
+    filter?: FindPartyArgs;
+};
+type AddPartyArgs = {
+    uri?: string;
+    partyType: NonPersistedPartyType;
+    contact: NonPersistedContact;
+    identities?: Array<NonPersistedIdentity>;
+    electronicAddresses?: Array<NonPersistedElectronicAddress>;
+    physicalAddresses?: Array<NonPersistedPhysicalAddress>;
+};
+type UpdatePartyArgs = {
+    party: Omit<Party, 'identities' | 'electronicAddresses' | 'partyType' | 'createdAt' | 'lastUpdatedAt'>;
+};
+type RemovePartyArgs = {
+    partyId: string;
+};
+type GetIdentityArgs = {
+    identityId: string;
+};
+type GetIdentitiesArgs = {
+    filter?: FindIdentityArgs;
+};
+type AddIdentityArgs = {
+    partyId: string;
+    identity: NonPersistedIdentity;
+};
+type UpdateIdentityArgs = {
+    identity: Identity;
+};
+type RemoveIdentityArgs = {
+    identityId: string;
+};
+type RemoveRelationshipArgs = {
+    relationshipId: string;
+};
+type AddRelationshipArgs = {
+    leftId: string;
+    rightId: string;
+};
+type GetRelationshipArgs = {
+    relationshipId: string;
+};
+type GetRelationshipsArgs = {
+    filter: FindRelationshipArgs;
+};
+type UpdateRelationshipArgs = {
+    relationship: Omit<PartyRelationship, 'createdAt' | 'lastUpdatedAt'>;
+};
+type AddPartyTypeArgs = {
+    type: PartyTypeType;
+    origin: PartyOrigin;
+    name: string;
+    tenantId: string;
+    description?: string;
+};
+type GetPartyTypeArgs = {
+    partyTypeId: string;
+};
+type GetPartyTypesArgs = {
+    filter?: FindPartyTypeArgs;
+};
+type UpdatePartyTypeArgs = {
+    partyType: Omit<PartyType, 'createdAt' | 'lastUpdatedAt'>;
+};
+type RemovePartyTypeArgs = {
+    partyTypeId: string;
+};
+type GetElectronicAddressArgs = {
+    electronicAddressId: string;
+};
+type GetElectronicAddressesArgs = {
+    filter?: FindElectronicAddressArgs;
+};
+type AddElectronicAddressArgs = {
+    partyId: string;
+    electronicAddress: NonPersistedElectronicAddress;
+};
+type UpdateElectronicAddressArgs = {
+    electronicAddress: ElectronicAddress;
+};
+type RemoveElectronicAddressArgs = {
+    electronicAddressId: string;
+};
+type GetPhysicalAddressArgs = {
+    physicalAddressId: string;
+};
+type GetPhysicalAddressesArgs = {
+    filter?: FindPhysicalAddressArgs;
+};
+type AddPhysicalAddressArgs = {
+    partyId: string;
+    physicalAddress: NonPersistedPhysicalAddress;
+};
+type UpdatePhysicalAddressArgs = {
+    physicalAddress: PhysicalAddress;
+};
+type RemovePhysicalAddressArgs = {
+    physicalAddressId: string;
+};
+
+type DcqlQueryItem = {
+    id: string;
+    queryId: string;
+    tenantId?: string;
+    version: string;
+    name?: string;
+    purpose?: string;
+    query: DcqlQuery;
+    createdAt: Date;
+    lastUpdatedAt: Date;
+};
+type ImportDcqlQueryItem = Omit<DcqlQueryItem, 'id' | 'tenantId' | 'version' | 'createdAt' | 'lastUpdatedAt'>;
+type NonPersistedDcqlQueryItem = Omit<DcqlQueryItem, 'id' | 'createdAt' | 'lastUpdatedAt'>;
+type PartialDcqlQueryItem = Partial<DcqlQueryItem>;
+type DcqlQueryItemFilter = Partial<Omit<DcqlQueryItem, 'query'>>;
+
+type FindDcqlQueryArgs = Array<DcqlQueryItemFilter>;
+type GetDefinitionArgs = {
+    itemId: string;
+};
+type HasDefinitionArgs = GetDefinitionArgs;
+type GetDefinitionsArgs = {
+    filter?: FindDcqlQueryArgs;
+};
+type HasDefinitionsArgs = GetDefinitionsArgs;
+type AddDefinitionArgs = NonPersistedDcqlQueryItem;
+type UpdateDefinitionArgs = DcqlQueryItem;
+type DeleteDefinitionArgs = {
+    itemId: string;
+};
+type DeleteDefinitionsArgs = GetDefinitionsArgs;
+
+type ValidationConstraint = {
+    [x: string]: string;
+};
+
+type NonPersistedAuditLoggingEvent = Omit<AuditLoggingEvent, 'id' | 'type'>;
+type NonPersistedActivityLoggingEvent = Omit<ActivityLoggingEvent, 'id' | 'type'>;
+
+type FindAuditLoggingEventArgs = Array<PartialAuditLoggingEvent>;
+type FindActivityLoggingEventArgs = Array<PartialActivityLoggingEvent>;
+type StoreAuditEventArgs = {
+    event: NonPersistedAuditLoggingEvent;
+};
+type StoreActivityEventArgs = {
+    event: NonPersistedActivityLoggingEvent;
+};
+type GetAuditEventsArgs = {
+    filter?: FindAuditLoggingEventArgs;
+};
+type GetActivityEventsArgs = {
+    filter?: FindActivityLoggingEventArgs;
+};
+
+type StoreMachineStatePersistArgs = Omit<StoreMachineStateInfo, 'createdAt' | 'updatedAt'>;
+type StoreMachineStatesFindActiveArgs = Partial<Pick<StoreMachineStateInfo, 'machineName' | 'tenantId' | 'instanceId'>>;
+type FindMachineStatesFilterArgs = Array<Partial<Omit<StoreMachineStateInfo, 'state'>>>;
+type StoreFindMachineStatesArgs = {
+    filter: FindMachineStatesFilterArgs;
+};
+type StoreMachineStateGetArgs = Pick<StoreMachineStateInfo, 'instanceId' | 'tenantId'>;
+type StoreMachineStateDeleteArgs = StoreMachineStateGetArgs;
+type StoreMachineStateDeleteExpiredArgs = {
+    machineName?: string;
+    tenantId?: string;
+    deleteDoneStates?: boolean;
+};
+interface StoreMachineStateInfo {
+    /**
+     * Unique instance ID of the machine
+     */
+    instanceId: string;
+    /**
+     * Session Id of the machine. Not necessarily unique
+     */
+    sessionId?: string;
+    /**
+     * Machine name
+     */
+    machineName: string;
+    /**
+     * The latest state name. Can be empty for a newly initialize machine
+     */
+    latestStateName?: string;
+    /**
+     * event types like SET_TOC, SET_FIRSTNAME, .... Will be xstate.init on a newly initialized machine
+     */
+    latestEventType: string;
+    /**
+     * Serialized Machine state
+     */
+    state: string;
+    /**
+     * Represents the creation date
+     */
+    createdAt: Date;
+    /**
+     * Represents the expiration date
+     */
+    expiresAt?: Date;
+    /**
+     * Represents the update date
+     */
+    updatedAt: Date;
+    /**
+     * Represents a counter for tracking updates.
+     */
+    updatedCount: number;
+    completedAt?: Date;
+    tenantId?: string;
+}
+
+declare enum DocumentType {
+    VC = "VC",
+    VP = "VP",
+    P = "P",
+    C = "C"
+}
+declare enum RegulationType {
+    PID = "PID",
+    QEAA = "QEAA",
+    EAA = "EAA",
+    NON_REGULATED = "NON_REGULATED"
+}
+declare enum CredentialDocumentFormat {
+    JSON_LD = "JSON_LD",
+    JWT = "JWT",
+    SD_JWT = "SD_JWT",
+    MSO_MDOC = "MSO_MDOC"
+}
+declare namespace CredentialDocumentFormat {
+    function fromSpecValue(credentialFormat: string): CredentialDocumentFormat;
+    function toSpecValue(documentFormat: CredentialDocumentFormat, documentType: DocumentType): "mso_mdoc" | "dc+sd-jwt" | "jwt_vc_json" | "ldp_vc" | "ldp_vp" | "jwt_vp_json";
+}
+declare enum CredentialCorrelationType {
+    DID = "DID",
+    X509_SAN = "X509_SAN",
+    KID = "KID",
+    URL = "URL"
+}
+declare enum CredentialStateType {
+    REVOKED = "REVOKED",
+    VERIFIED = "VERIFIED",
+    EXPIRED = "EXPIRED"
+}
+
+/**
+ * DigitalCredential
+ *
+ * @public
+ */
+type DigitalCredential = {
+    id: string;
+    parentId?: string;
+    documentType: DocumentType;
+    documentFormat: CredentialDocumentFormat;
+    credentialRole: CredentialRole;
+    regulationType: RegulationType;
+    rawDocument: string;
+    uniformDocument: string;
+    credentialId?: string;
+    hash: string;
+    kmsKeyRef?: string;
+    identifierMethod?: string;
+    issuerCorrelationType: CredentialCorrelationType;
+    subjectCorrelationType?: CredentialCorrelationType;
+    rpCorrelationType?: CredentialCorrelationType;
+    isIssuerSigned?: boolean;
+    issuerCorrelationId: string;
+    subjectCorrelationId?: string;
+    rpCorrelationId?: string;
+    verifiedState?: CredentialStateType;
+    tenantId?: string;
+    createdAt: Date;
+    presentedAt?: Date;
+    lastUpdatedAt: Date;
+    validUntil?: Date;
+    validFrom?: Date;
+    verifiedAt?: Date;
+    revokedAt?: Date;
+};
+type NonPersistedDigitalCredential = Omit<DigitalCredential, 'id' | 'regulationType'> & {
+    regulationType?: RegulationType;
+};
+
+type GetCredentialArgs = {
+    id: string;
+} | {
+    hash: string;
+};
+type FindDigitalCredentialArgs = Array<Partial<DigitalCredential>>;
+type GetCredentialsArgs = {
+    filter?: FindDigitalCredentialArgs;
+    offset?: number;
+    limit?: number;
+    order?: string;
+};
+type GetCredentialsResponse = {
+    data: Array<DigitalCredential>;
+    total: number;
+};
+type AddCredentialArgs = {
+    rawDocument: string;
+    kmsKeyRef?: string;
+    identifierMethod?: string;
+    regulationType?: RegulationType;
+    parentId?: string;
+    issuerCorrelationType: CredentialCorrelationType;
+    subjectCorrelationType?: CredentialCorrelationType;
+    issuerCorrelationId: string;
+    subjectCorrelationId?: string;
+    credentialRole: CredentialRole;
+    tenantId?: string;
+    state?: CredentialStateType;
+    verifiedAt?: Date;
+    revokedAt?: Date;
+    opts?: {
+        maxTimeSkewInMS?: number;
+        hasher?: HasherSync;
+    };
+};
+type UpdateCredentialStateArgs = GetCredentialArgs & {
+    verifiedState: CredentialStateType;
+    verifiedAt?: Date;
+    revokedAt?: Date;
+};
+type RemoveCredentialArgs = GetCredentialArgs;
+
+declare abstract class AbstractContactStore {
+    abstract getParty(args: GetPartyArgs): Promise<Party>;
+    abstract getParties(args?: GetPartiesArgs): Promise<Array<Party>>;
+    abstract addParty(args: AddPartyArgs): Promise<Party>;
+    abstract updateParty(args: UpdatePartyArgs): Promise<Party>;
+    abstract removeParty(args: RemovePartyArgs): Promise<void>;
+    abstract getIdentity(args: GetIdentityArgs): Promise<Identity>;
+    abstract getIdentities(args?: GetIdentitiesArgs): Promise<Array<Identity>>;
+    abstract addIdentity(args: AddIdentityArgs): Promise<Identity>;
+    abstract updateIdentity(args: UpdateIdentityArgs): Promise<Identity>;
+    abstract removeIdentity(args: RemoveIdentityArgs): Promise<void>;
+    abstract getRelationship(args: GetRelationshipArgs): Promise<PartyRelationship>;
+    abstract getRelationships(args?: GetRelationshipsArgs): Promise<Array<PartyRelationship>>;
+    abstract addRelationship(args: AddRelationshipArgs): Promise<PartyRelationship>;
+    abstract updateRelationship(args: UpdateRelationshipArgs): Promise<PartyRelationship>;
+    abstract removeRelationship(args: RemoveRelationshipArgs): Promise<void>;
+    abstract getPartyType(args: GetPartyTypeArgs): Promise<PartyType>;
+    abstract getPartyTypes(args?: GetPartyTypesArgs): Promise<Array<PartyType>>;
+    abstract addPartyType(args: AddPartyTypeArgs): Promise<PartyType>;
+    abstract updatePartyType(args: UpdatePartyTypeArgs): Promise<PartyType>;
+    abstract removePartyType(args: RemovePartyTypeArgs): Promise<void>;
+    abstract getElectronicAddress(args: GetElectronicAddressArgs): Promise<ElectronicAddress>;
+    abstract getElectronicAddresses(args?: GetElectronicAddressesArgs): Promise<Array<ElectronicAddress>>;
+    abstract addElectronicAddress(args: AddElectronicAddressArgs): Promise<ElectronicAddress>;
+    abstract updateElectronicAddress(args: UpdateElectronicAddressArgs): Promise<ElectronicAddress>;
+    abstract removeElectronicAddress(args: RemoveElectronicAddressArgs): Promise<void>;
+    abstract getPhysicalAddress(args: GetPhysicalAddressArgs): Promise<PhysicalAddress>;
+    abstract getPhysicalAddresses(args?: GetPhysicalAddressesArgs): Promise<Array<PhysicalAddress>>;
+    abstract addPhysicalAddress(args: AddPhysicalAddressArgs): Promise<PhysicalAddress>;
+    abstract updatePhysicalAddress(args: UpdatePhysicalAddressArgs): Promise<PhysicalAddress>;
+    abstract removePhysicalAddress(args: RemovePhysicalAddressArgs): Promise<void>;
+}
+
+declare abstract class AbstractDigitalCredentialStore {
+    abstract getCredential(args: GetCredentialArgs): Promise<DigitalCredential>;
+    abstract getCredentials(args?: GetCredentialsArgs): Promise<GetCredentialsResponse>;
+    abstract addCredential(args: AddCredentialArgs): Promise<DigitalCredential>;
+    abstract updateCredentialState(args: UpdateCredentialStateArgs): Promise<DigitalCredential>;
+    abstract removeCredential(args: RemoveCredentialArgs): Promise<boolean>;
+}
+
+declare abstract class AbstractIssuanceBrandingStore {
+    abstract addCredentialBranding(args: IAddCredentialBrandingArgs): Promise<ICredentialBranding>;
+    abstract getCredentialBranding(args?: IGetCredentialBrandingArgs): Promise<Array<ICredentialBranding>>;
+    abstract updateCredentialBranding(args: IUpdateCredentialBrandingArgs): Promise<ICredentialBranding>;
+    abstract removeCredentialBranding(args: IRemoveCredentialBrandingArgs): Promise<void>;
+    abstract addCredentialLocaleBranding(args: IAddCredentialLocaleBrandingArgs): Promise<ICredentialBranding>;
+    abstract getCredentialLocaleBranding(args?: IGetCredentialLocaleBrandingArgs): Promise<Array<ICredentialLocaleBranding>>;
+    abstract updateCredentialLocaleBranding(args: IUpdateCredentialLocaleBrandingArgs): Promise<ICredentialLocaleBranding>;
+    abstract removeCredentialLocaleBranding(args: IRemoveCredentialLocaleBrandingArgs): Promise<void>;
+    abstract addIssuerBranding(args: IAddIssuerBrandingArgs): Promise<IIssuerBranding>;
+    abstract getIssuerBranding(args?: IGetIssuerBrandingArgs): Promise<Array<IIssuerBranding>>;
+    abstract updateIssuerBranding(args: IUpdateIssuerBrandingArgs): Promise<IIssuerBranding>;
+    abstract removeIssuerBranding(args: IRemoveIssuerBrandingArgs): Promise<void>;
+    abstract addIssuerLocaleBranding(args: IAddIssuerLocaleBrandingArgs): Promise<IIssuerBranding>;
+    abstract getIssuerLocaleBranding(args?: IGetIssuerLocaleBrandingArgs): Promise<Array<IIssuerLocaleBranding>>;
+    abstract updateIssuerLocaleBranding(args: IUpdateIssuerLocaleBrandingArgs): Promise<IIssuerLocaleBranding>;
+    abstract removeIssuerLocaleBranding(args: IRemoveIssuerLocaleBrandingArgs): Promise<void>;
+}
+
+declare abstract class AbstractEventLoggerStore {
+    abstract getAuditEvents(args: GetAuditEventsArgs): Promise<Array<AuditLoggingEvent>>;
+    abstract getActivityEvents(args: GetActivityEventsArgs): Promise<Array<ActivityLoggingEvent>>;
+    abstract storeAuditEvent(args: StoreAuditEventArgs): Promise<AuditLoggingEvent>;
+    abstract storeActivityEvent(args: StoreActivityEventArgs): Promise<ActivityLoggingEvent>;
+}
+
+/**
+ * Represents an abstract class for storing machine states.
+ * This class provides methods for persisting, retrieving, and deleting machine states.
+ *
+ * @interface
+ */
+declare abstract class IAbstractMachineStateStore {
+    /**
+     * Persists the machine state.
+     *
+     * @param {StoreMachineStatePersistArgs} state - The object containing the machine state to persist.
+     * @return {Promise<StoreMachineStateInfo>} - A Promise that resolves to the information about the persisted machine state.
+     */
+    abstract persistMachineState(state: StoreMachineStatePersistArgs): Promise<StoreMachineStateInfo>;
+    /**
+     * Finds active machine states based on the given arguments.
+     *
+     * @param {StoreMachineStatesFindActiveArgs} args - The arguments for finding active machine states.
+     * @return {Promise<Array<StoreMachineStateInfo>>} - A promise that resolves with an array of active machine states.
+     */
+    abstract findActiveMachineStates(args: StoreMachineStatesFindActiveArgs): Promise<Array<StoreMachineStateInfo>>;
+    /**
+     * Retrieves the state of a particular machine.
+     *
+     * @param {StoreMachineStateGetArgs} args - The arguments for retrieving the machine state.
+     * @returns {Promise<StoreMachineStateInfo>} - A promise that resolves to the machine state information.
+     */
+    abstract getMachineState(args: StoreMachineStateGetArgs): Promise<StoreMachineStateInfo>;
+    /**
+     * Finds the machine states based on the given arguments.
+     *
+     * @param {StoreFindMachineStatesArgs} [args] - The arguments to filter the machine states.
+     * @returns {Promise<Array<StoreMachineStateInfo>>} - A promise that resolves to an array of machine state information.
+     */
+    abstract findMachineStates(args?: StoreFindMachineStatesArgs): Promise<Array<StoreMachineStateInfo>>;
+    /**
+     * Deletes a machine state.
+     *
+     * @param {StoreMachineStateDeleteArgs} args - The arguments for deleting the machine state.
+     * @return {Promise<boolean>} - A promise that resolves to a boolean indicating if the machine state was successfully deleted or not.
+     */
+    abstract deleteMachineState(args: StoreMachineStateDeleteArgs): Promise<boolean>;
+    /**
+     * Deletes expired machine states from the database.
+     *
+     * @param {StoreMachineStateDeleteExpiredArgs} args - The arguments for deleting expired machine states.
+     * @return {Promise<number>} - A promise that resolves to the number of deleted machine states.
+     */
+    abstract deleteExpiredMachineStates(args: StoreMachineStateDeleteExpiredArgs): Promise<number>;
+}
+
+declare abstract class AbstractPDStore {
+    abstract hasDefinition(args: GetDefinitionArgs): Promise<boolean>;
+    abstract hasDefinitions(args: GetDefinitionsArgs): Promise<boolean>;
+    abstract getDefinition(args: GetDefinitionArgs): Promise<DcqlQueryItem>;
+    abstract getDefinitions(args: GetDefinitionsArgs): Promise<Array<DcqlQueryItem>>;
+    abstract addDefinition(args: AddDefinitionArgs): Promise<DcqlQueryItem>;
+    abstract updateDefinition(args: UpdateDefinitionArgs): Promise<DcqlQueryItem>;
+    abstract deleteDefinition(args: DeleteDefinitionArgs): Promise<void>;
+    abstract deleteDefinitions(args: DeleteDefinitionsArgs): Promise<number>;
+}
+
+declare function ensureRawDocument(input: string | object): string;
+
+export { AbstractContactStore, AbstractDigitalCredentialStore, AbstractEventLoggerStore, AbstractIssuanceBrandingStore, AbstractPDStore, type AddCredentialArgs, type AddDefinitionArgs, type AddElectronicAddressArgs, type AddIdentityArgs, type AddPartyArgs, type AddPartyTypeArgs, type AddPhysicalAddressArgs, type AddRelationshipArgs, type Connection, type ConnectionConfig, ConnectionType, type Contact, type CorrelationIdentifier, CorrelationIdentifierType, CredentialCorrelationType, CredentialDocumentFormat, CredentialStateType, type DcqlQueryItem, type DcqlQueryItemFilter, type DeleteDefinitionArgs, type DeleteDefinitionsArgs, type DidAuthConfig, type DigitalCredential, DocumentType, type ElectronicAddress, type ElectronicAddressType, type FindActivityLoggingEventArgs, type FindAuditLoggingEventArgs, type FindCredentialBrandingArgs, type FindCredentialLocaleBrandingArgs, type FindDcqlQueryArgs, type FindDigitalCredentialArgs, type FindElectronicAddressArgs, type FindIdentityArgs, type FindIssuerBrandingArgs, type FindIssuerLocaleBrandingArgs, type FindMachineStatesFilterArgs, type FindPartyArgs, type FindPartyTypeArgs, type FindPhysicalAddressArgs, type FindRelationshipArgs, type GetActivityEventsArgs, type GetAuditEventsArgs, type GetCredentialArgs, type GetCredentialsArgs, type GetCredentialsResponse, type GetDefinitionArgs, type GetDefinitionsArgs, type GetElectronicAddressArgs, type GetElectronicAddressesArgs, type GetIdentitiesArgs, type GetIdentityArgs, type GetPartiesArgs, type GetPartyArgs, type GetPartyTypeArgs, type GetPartyTypesArgs, type GetPhysicalAddressArgs, type GetPhysicalAddressesArgs, type GetRelationshipArgs, type GetRelationshipsArgs, type HasDefinitionArgs, type HasDefinitionsArgs, IAbstractMachineStateStore, type IAddCredentialBrandingArgs, type IAddCredentialLocaleBrandingArgs, type IAddIssuerBrandingArgs, type IAddIssuerLocaleBrandingArgs, type IBackgroundAttributes, type IBasicBackgroundAttributes, type IBasicCredentialBranding, type IBasicCredentialClaim, type IBasicCredentialLocaleBranding, type IBasicImageAttributes, type IBasicImageDimensions, type IBasicIssuerBranding, type IBasicIssuerLocaleBranding, type IBasicTextAttributes, type ICredentialBranding, type ICredentialBrandingFilter, type ICredentialClaim, type ICredentialLocaleBranding, type ICredentialLocaleBrandingFilter, type IGetCredentialBrandingArgs, type IGetCredentialLocaleBrandingArgs, type IGetIssuerBrandingArgs, type IGetIssuerLocaleBrandingArgs, type IImageAttributes, type IImageDimensions, type IIssuerBranding, type IIssuerBrandingFilter, type IIssuerLocaleBranding, type IIssuerLocaleBrandingFilter, type ILocaleBranding, type IMetadataEntity, type IPartialBackgroundAttributes, type IPartialCredentialBranding, type IPartialCredentialClaim, type IPartialCredentialLocaleBranding, type IPartialImageAttributes, type IPartialImageDimensions, type IPartialIssuerBranding, type IPartialIssuerLocaleBranding, type IPartialTextAttributes, type IRemoveCredentialBrandingArgs, type IRemoveCredentialLocaleBrandingArgs, type IRemoveIssuerBrandingArgs, type IRemoveIssuerLocaleBrandingArgs, type ITextAttributes, type IUpdateCredentialBrandingArgs, type IUpdateCredentialLocaleBrandingArgs, type IUpdateIssuerBrandingArgs, type IUpdateIssuerLocaleBrandingArgs, type Identity, IdentityOrigin, type ImportDcqlQueryItem, type MetadataItem, type MetadataTypes, type NaturalPerson, type NonPersistedActivityLoggingEvent, type NonPersistedAuditLoggingEvent, type NonPersistedConnection, type NonPersistedConnectionConfig, type NonPersistedContact, type NonPersistedCorrelationIdentifier, type NonPersistedDcqlQueryItem, type NonPersistedDidAuthConfig, type NonPersistedDigitalCredential, type NonPersistedElectronicAddress, type NonPersistedIdentity, type NonPersistedMetadataItem, type NonPersistedNaturalPerson, type NonPersistedOpenIdConfig, type NonPersistedOrganization, type NonPersistedParty, type NonPersistedPartyRelationship, type NonPersistedPartyType, type NonPersistedPhysicalAddress, type OpenIdConfig, type Organization, type PartialConnection, type PartialConnectionConfig, type PartialContact, type PartialCorrelationIdentifier, type PartialDcqlQueryItem, type PartialDidAuthConfig, type PartialElectronicAddress, type PartialIdentity, type PartialMetadataItem, type PartialNaturalPerson, type PartialOpenIdConfig, type PartialOrganization, type PartialParty, type PartialPartyRelationship, type PartialPartyType, type PartialPhysicalAddress, type Party, PartyOrigin, type PartyRelationship, type PartyType, PartyTypeType, type PhysicalAddress, type PhysicalAddressType, RegulationType, type RemoveCredentialArgs, type RemoveElectronicAddressArgs, type RemoveIdentityArgs, type RemovePartyArgs, type RemovePartyTypeArgs, type RemovePhysicalAddressArgs, type RemoveRelationshipArgs, type StoreActivityEventArgs, type StoreAuditEventArgs, type StoreFindMachineStatesArgs, type StoreMachineStateDeleteArgs, type StoreMachineStateDeleteExpiredArgs, type StoreMachineStateGetArgs, type StoreMachineStateInfo, type StoreMachineStatePersistArgs, type StoreMachineStatesFindActiveArgs, type UpdateCredentialStateArgs, type UpdateDefinitionArgs, type UpdateElectronicAddressArgs, type UpdateIdentityArgs, type UpdatePartyArgs, type UpdatePartyTypeArgs, type UpdatePhysicalAddressArgs, type UpdateRelationshipArgs, type ValidationConstraint, ensureRawDocument };