@case-contract-testing/case/dist/src/entities/context/types.d.ts

Next-generation contract testing suite

import type { MatcherExecutor, AnyCaseNodeOrData, AnyCaseNodeType, AnyLeafOrStructure, CaseNodeFor, LookupableMatcher, AnyData } from '../../entities/nodes/types';
import type { Logger, LogLevel } from '../../entities/logger/types';
import type { ResultPrinter } from '../../entities/results/types';
export declare const MATCH_BY_TYPE: "type";
export declare const MATCH_BY_EXACT: "exact";
export declare const SERIALISABLE_TO_JSON: "json";
export interface RawLookupFns {
    lookupMatcher: (uniqueName: string, context: MatchContextWithoutLookup) => AnyCaseNodeOrData;
    saveLookupableMatcher: (matcher: LookupableMatcher, context: MatchContextWithoutLookup) => void;
    addVariable: (name: string, type: 'default' | 'state', stateName: string, value: AnyCaseNodeOrData, context: MatchContextWithoutLookup) => [name: string, value: AnyCaseNodeOrData];
    lookupVariable: (name: string, context: MatchContextWithoutLookup) => AnyCaseNodeOrData;
}
export interface ContractLookupFns {
    lookupMatcher: (uniqueName: string) => AnyCaseNodeOrData;
    saveLookupableMatcher: (matcher: LookupableMatcher) => void;
    addDefaultVariable: (name: string, stateName: string, value: AnyCaseNodeOrData) => [name: string, value: AnyCaseNodeOrData];
    addStateVariable: (name: string, stateName: string, value: AnyCaseNodeOrData) => [name: string, value: AnyCaseNodeOrData];
    lookupVariable: (name: string) => AnyCaseNodeOrData;
}
interface HasMakeLookupFn {
    makeLookup: (c: MatchContextWithoutLookup) => ContractLookupFns;
}
export interface TraversalFns {
    descendAndCheck: <T extends AnyCaseNodeType>(matcherOrData: CaseNodeFor<T> | AnyLeafOrStructure, parentMatchContext: MatchContext, actual: unknown) => ReturnType<MatcherExecutor<T>['check']>;
    descendAndStrip: <T extends AnyCaseNodeType>(matcherOrData: CaseNodeFor<T> | AnyLeafOrStructure, parentMatchContext: MatchContext) => ReturnType<MatcherExecutor<T>['strip']>;
    descendAndDescribe: <T extends AnyCaseNodeType>(matcherOrData: CaseNodeFor<T> | AnyLeafOrStructure, parentMatchContext: MatchContext) => string;
    selfVerify: <T extends AnyCaseNodeType>(matcherOrData: CaseNodeFor<T> | AnyLeafOrStructure, parentMatchContext: MatchContext) => ReturnType<MatcherExecutor<T>['check']>;
}
export type LogLevelContext = {
    'case:currentRun:context:logLevel': LogLevel;
    'case:currentRun:context:location': Array<string>;
};
export type MatchContextWithoutLookup = Omit<MatchContext, keyof ContractLookupFns | keyof HasMakeLookupFn>;
export interface ContractFileConfig {
    'case:currentRun:context:testRunId': string;
    'case:currentRun:context:contractDir': string;
    'case:currentRun:context:contractFilename'?: string;
    'case:currentRun:context:overwriteFile'?: boolean;
}
export type HasContractFileConfig = DataContext & ContractFileConfig;
export type DefaultContext = LogLevelContext & {
    'case:context:matchBy': typeof MATCH_BY_TYPE | typeof MATCH_BY_EXACT;
    'case:context:serialisableTo': typeof SERIALISABLE_TO_JSON;
    'case:currentRun:context:contractMode': 'write' | 'read';
    'case:currentRun:context:printResults': boolean;
};
interface InjectableContext {
    'case:currentRun:context:baseUrlUnderTest'?: string;
    'case:currentRun:context:contractMode': 'write' | 'read';
}
export interface HasBaseUrlUnderTest {
    'case:currentRun:context:baseUrlUnderTest': string;
}
/**
 * RunContext exists distinct from CaseConfig, as it allows us to have internal configuration properties that aren't exposed
 *
 * @internal
 */
export interface RunContext extends Partial<InjectableContext & LogLevelContext & HasBaseUrlUnderTest & ContractFileConfig> {
    'case:currentRun:context:testName': string | 'OUTSIDE_TESTS';
    'case:currentRun:context:printResults': boolean;
    'case:currentRun:context:variables': Record<string, AnyCaseNodeOrData>;
    'case:currentRun:context:defaultConfig': Record<string, AnyData>;
    'case:currentRun:context:throwOnFail'?: boolean;
    'case:currentRun:context:brokerCiAccessToken'?: string;
    'case:currentRun:context:publish'?: false | true | 'ONLY_IN_CI' | 'NEVER' | 'ALWAYS';
    'case:currentRun:context:brokerBasicAuth'?: {
        username: string;
        password: string;
    };
    'case:currentRun:context:brokerBaseUrl'?: string;
}
export interface MatchContextByType {
    'case:context:matchBy': 'type';
}
export interface MatchContextByExact {
    'case:context:matchBy': 'exact';
}
export interface HttpTestContext {
    baseUrl: string;
}
export interface LogContext {
    logger: Logger;
    resultPrinter: ResultPrinter;
    makeLogger: (m: LogLevelContext) => Logger;
}
export type DataContext = DefaultContext & Partial<InjectableContext> & Partial<ContractFileConfig> & RunContext & LogLevelContext & LogContext;
export type MatchContext = DataContext & TraversalFns & ContractLookupFns & HasMakeLookupFn;
export {};