@jolocom/protocol-ts/lib/interactionTokens.ts

Jolocom SSI protocol typescript definitions - jolocom.io

export interface IJWTHeader {
  alg: string
  typ: string
}

interface IPayload {
  iss?: string
  iat?: number
  typ: string
  [x: string]: any
}

export interface IJSONWebTokenAttrs {
  header: IJWTHeader
  payload: IPayload
  signature: string
}

export enum InteractionType {
  CredentialRequest = 'credentialRequest',
  CredentialResponse = 'credentialResponse',
  CredentialsReceive = 'credentialsReceive',
  Authentication = 'authentication',
  AuthorizationRequest = 'AuthorizationRequest',
  AuthorizationResponse = 'AuthorizationResponse',
  CredentialOfferRequest = 'credentialOfferRequest',
  CredentialOfferResponse = 'credentialOfferResponse',
  PaymentRequest = 'paymentRequest',
  PaymentResponse = 'paymentResponse',
}

export interface IInteractionToken {
  type: InteractionType | string
}

import { TransactionOptions } from './contracts'
import { ISignedCredentialAttrs } from './signedCredential'
import { CredentialOffer } from './credential'

export interface IPaymentRequestAttrs {
  callbackURL: string
  description: string
  transactionOptions: TransactionOptions
}

export interface IPaymentResponseAttrs {
  txHash: string
}

// TODO @next this is here for backwards compatibility
export { CredentialOffer, CredentialOfferInputRequest, CredentialOfferRenderInfo, CredentialOfferMetadata } from "./credential"

export interface CredentialOfferRequestAttrs {
  callbackURL: string
  offeredCredentials: CredentialOffer[]
}

export interface CredentialOfferResponseSelection {
  type: string
  providedInput?: {
    [key: string]: string | null
  }
}

export interface CredentialOfferResponseAttrs {
  callbackURL: string
  selectedCredentials: CredentialOfferResponseSelection[]
}

export interface ICredentialRequestAttrs {
  callbackURL: string
  credentialRequirements: ICredentialRequest[]
}

export interface ICredentialResponseAttrs {
  callbackURL: string
  suppliedCredentials: ISignedCredentialAttrs[]
}

export interface ICredentialsReceiveAttrs {
  signedCredentials: ISignedCredentialAttrs[]
}

export interface ICredentialRequest {
  type: string[]
  constraints: IConstraint[]
}

export interface IAuthenticationAttrs {
  callbackURL: string
  description: string
}

export interface IAuthorizationAttrs {
  callbackURL: string
  description: string
  action?: string
  imageURL?: string
}

/* Related to constraint functions */

export type Operator = '==' | '!=' | '<' | '>'

export interface IConstraint {
  [operator: string]: boolean[] | Array<{ var: string } | string | Comparable>
}

export type Comparable = number | Date
type ConstraintFunc = (field: string, value: string) => IConstraint
type ComparableConstraintFunc = (
  field: string,
  value: Comparable,
) => IConstraint

export interface IExposedConstraintFunctions {
  is: ConstraintFunc
  not: ConstraintFunc
  greater: ComparableConstraintFunc
  smaller: ComparableConstraintFunc
}