pact-foundation/pact-js

import * as express from 'express';
import { LogLevel } from '../../options';
import { JsonMap, AnyJson } from '../../../common/jsonTypes';
import { MessageProviders } from '../../message';

export type Hook = () => Promise<unknown>;

/**
 * State handlers map a state description to a function
 * that can setup the provider state
 */
export interface StateHandlers {
  [name: string]: StateHandler;
}
/**
 * Incoming provider state request
 */
export interface ProviderState {
  action: StateAction;
  params: JsonMap;
  state: string;
}

/**
 * Specifies whether the state handler being setup or shutdown
 */
export type StateAction = 'setup' | 'teardown';

/**
 * Respond to the state setup event, optionally returning a map of provider
 * values to dynamically inject into the incoming request to test
 */
export type StateFunc = (parameters?: AnyJson) => Promise<JsonMap | void>;

/**
 * Respond to the state setup event, with the ability to hook into the setup/teardown
 * phase of the state
 */
export type StateFuncWithSetup = {
  setup?: StateFunc;
  teardown?: StateFunc;
};

export type StateHandler = StateFuncWithSetup | StateFunc;

export interface ProxyOptions {
  logLevel?: LogLevel;
  requestFilter?: express.RequestHandler;
  stateHandlers?: StateHandlers;
  messageProviders?: MessageProviders;
  beforeEach?: Hook;
  afterEach?: Hook;
  validateSSL?: boolean;
  changeOrigin?: boolean;
  providerBaseUrl?: string;
  proxyHost?: string;
}