@pact-foundation/pact/src/dsl/matchers.d.ts

Pact for all things Javascript

/** @module Matchers
 *
 * For specific matcher types (e.g. IpV6), the values generated are not random
 * but are fixed, to prevent contract invalidation after each run of the consumer test.
 */
import { AnyJson } from '../common/jsonTypes';
export declare const EMAIL_FORMAT = "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+.[a-zA-Z]{2,}$";
export declare const ISO8601_DATE_FORMAT = "^([\\+-]?\\d{4}(?!\\d{2}\\b))((-?)((0[1-9]|1[0-2])(\\3([12]\\d|0[1-9]|3[01]))?|W([0-4]\\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\\d|[12]\\d{2}|3([0-5]\\d|6[1-6])))?)$";
export declare const ISO8601_DATETIME_FORMAT = "^\\d{4}-[01]\\d-[0-3]\\dT[0-2]\\d:[0-5]\\d:[0-5]\\d([+-][0-2]\\d:[0-5]\\d|Z)$";
export declare const ISO8601_DATETIME_WITH_MILLIS_FORMAT = "^\\d{4}-[01]\\d-[0-3]\\dT[0-2]\\d:[0-5]\\d:[0-5]\\d\\.\\d+([+-][0-2]\\d(:?[0-5]\\d)?|Z)$";
export declare const ISO8601_TIME_FORMAT = "^(T\\d\\d:\\d\\d(:\\d\\d)?(\\.\\d+)?(([+-]\\d\\d:\\d\\d)|Z)?)?$";
export declare const RFC1123_TIMESTAMP_FORMAT = "^(Mon|Tue|Wed|Thu|Fri|Sat|Sun),\\s\\d{2}\\s(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\\s\\d{4}\\s\\d{2}:\\d{2}:\\d{2}\\s(\\+|-)\\d{4}$";
export declare const UUID_V4_FORMAT = "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$";
export declare const IPV4_FORMAT = "^(\\d{1,3}\\.)+\\d{1,3}$";
export declare const IPV6_FORMAT = "^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$";
export declare const HEX_FORMAT = "^[0-9a-fA-F]+$";
export interface Matcher<T> {
    value?: T;
    'pact:matcher:type': string;
    getValue(): T;
}
export interface ArrayMatcher<T> extends Matcher<T> {
    'pact:matcher:type': string;
    min?: number;
    max?: number;
}
export declare function isMatcher(x: unknown): x is Matcher<AnyTemplate>;
export type AnyTemplate = AnyJson | Matcher<AnyTemplate> | ArrayMatcher<AnyTemplate> | TemplateMap | ArrayTemplate;
export type InterfaceToTemplate<O> = {
    [K in keyof O]: AnyTemplate;
};
interface TemplateMap {
    [key: string]: AnyTemplate;
}
type ArrayTemplate = Array<AnyTemplate>;
/**
 * Validates the given example against the regex.
 *
 * @param example Example to use in the matcher.
 * @param matcher Regular expression to check.
 */
export declare function validateExample(example: string, matcher: string): boolean;
/**
 * The eachLike matcher
 * @param {any} template
 * @param {Object} opts
 * @param {Number} opts.min
 */
export declare function eachLike<T>(template: T, opts?: {
    min: number;
}): ArrayMatcher<T[]>;
/**
 * The somethingLike matcher
 * @param {any} value - the value to be somethingLike
 */
export declare function somethingLike<T>(value: T): Matcher<T>;
export interface RegexMatcher<T> extends Matcher<T> {
    regex: string;
}
/**
 * The term matcher. Also aliased to 'regex' for discoverability.
 * @param {Object} opts
 * @param {string} opts.generate - a value to represent the matched String
 * @param {string} opts.matcher - a Regex representing the value
 */
export declare function term(opts: {
    generate: string;
    matcher: string;
}): RegexMatcher<string>;
/**
 * Email address matcher.
 * @param {string} address - a email address to use as an example
 */
export declare function email(address?: string): Matcher<string>;
/**
 * UUID v4 matcher.
 * @param {string} id - a UUID to use as an example.
 */
export declare function uuid(id?: string): Matcher<string>;
/**
 * IPv4 matcher.
 * @param {string} ip - an IPv4 address to use as an example. Defaults to `127.0.0.13`
 */
export declare function ipv4Address(ip?: string): Matcher<string>;
/**
 * IPv6 matcher.
 * @param {string} ip - an IPv6 address to use as an example. Defaults to '::ffff:192.0.2.128'
 */
export declare function ipv6Address(ip?: string): Matcher<string>;
/**
 * ISO8601 DateTime matcher.
 * @param {string} date - an ISO8601 Date and Time string
 *                        e.g. 2015-08-06T16:53:10+01:00 are valid
 */
export declare function iso8601DateTime(date?: string): Matcher<string>;
/**
 * ISO8601 DateTime matcher with required millisecond precision
 * @param {string} date - an ISO8601 Date and Time string, e.g. 2015-08-06T16:53:10.123+01:00
 */
export declare function iso8601DateTimeWithMillis(date?: string): Matcher<string>;
/**
 * ISO8601 Date matcher.
 * @param {string} date - a basic yyyy-MM-dd date string e.g. 2000-09-31
 */
export declare function iso8601Date(date?: string): Matcher<string>;
/**
 *  ISO8601 Time Matcher, matches a pattern of the format "'T'HH:mm:ss".
 * @param {string} date - a ISO8601 formatted time string e.g. T22:44:30.652Z
 */
export declare function iso8601Time(time?: string): Matcher<string>;
/**
 * RFC1123 Timestamp matcher "DAY, DD MON YYY hh:mm:ss"
 *
 * @param {string} date - an RFC1123 Date and Time string, e.g. Mon, 31 Oct 2016 15:21:41 -0400
 */
export declare function rfc1123Timestamp(timestamp?: string): Matcher<string>;
/**
 * Hexadecimal Matcher.
 * @param {string} hex - a hex value.
 */
export declare function hexadecimal(hex?: string): Matcher<string>;
/**
 * Decimal Matcher.
 * @param {float} float - a decimal value.
 */
export declare function decimal(float?: number): Matcher<number>;
/**
 * Integer Matcher.
 * @param {integer} int - an int value.
 */
export declare function integer(int?: number): Matcher<number>;
/**
 * Boolean Matcher.
 */
export declare function boolean(value?: boolean): Matcher<boolean>;
/**
 * String Matcher.
 */
export declare function string(value?: string): Matcher<string>;
export { somethingLike as like };
export { term as regex };
export declare function extractPayload(value: AnyTemplate): AnyJson;
export declare function matcherValueOrString(obj: unknown): string;