dcc-decoder/src/rules-runner/types.ts

<img alttext="COVID Green Logo" src="https://raw.githubusercontent.com/lfph/artwork/master/projects/covidgreen/stacked/color/covidgreen-stacked-color.png" width="300" />

import { CertLogicExpression } from 'certlogic-js'

export type RuleDesc = {
  lang: string
  desc: string
}

/**
 * Types representing rules and rule sets, as read in from a JSON file.
 */
export type Rule = {
  Identifier: string
  Country: string
  Logic: CertLogicExpression
  Description: RuleDesc[]
}

export type RuleSet = Rule[]

/**
 * A type representing the “compressed” value sets.
 */
export type ValueSetsComputed = { [valueSetId: string]: string[] }

/**
 * A type representing the external parameters object.
 */
export type ExternalParameters = {
  valueSets: ValueSetsComputed
  [key: string]: unknown // Allow any other property.
}

/**
 * A type representing the data context passed to every rule.
 */
export type RuleEvaluationDataContext = {
  // eslint-disable-next-line
  payload: any
  external: ExternalParameters
}

/**
 * A type representing the evaluation of a single rule.
 */
export type RuleEvaluationResult = boolean | Error

/**
 * A type representing the evaluation of all rules (individually) in a rule set.
 */
export type RuleEvaluations = { [ruleId: string]: RuleEvaluationResult }

/**
 * A type representing the evaluation of all rules in a rule set,
 * with derived properties for whether errors occurred,
 * and whether all rules passed.
 */
export type RuleSetEvaluationResult = {
  ruleEvaluations: RuleEvaluations
  hasErrors: boolean
  allSatisfied: boolean
}