testeranto/dist/types/src/Types.d.ts

the AI powered BDD test framework for typescript projects

import { Plugin } from "esbuild";
import { ITTestResourceConfiguration } from "./lib/index.js";
import { PM } from "./PM/index.js";
import { BaseWhen, BaseThen, BaseGiven, IGivens } from "./lib/abstractBase.js";
import { Ibdd_in_any, Ibdd_out_any } from "./CoreTypes.js";
import { BaseSuite } from "./lib/BaseSuite.js";
export type ISummary = Record<string, {
    runTimeErrors: number | "?" | undefined;
    typeErrors: number | "?" | undefined;
    staticErrors: number | "?" | undefined;
    prompt: string | "?" | undefined;
    failingFeatures: object | undefined;
}> & {
    nodeLogs?: string;
    webLogs?: string;
    pureLogs?: string;
};
export type SuiteSpecification<I extends Ibdd_in_any, O extends Ibdd_out_any> = {
    [K in keyof O["suites"]]: (name: string, givens: IGivens<I>) => BaseSuite<I, O>;
};
export type TestSummary = {
    testName: string;
    errors?: {
        runtime?: number;
        type?: number;
        static?: number;
    };
    prompt?: string;
    failedFeatures: string[];
};
export type TestLifecycle<Subject, State, Selection> = {
    beforeAll?: (input: any) => Promise<Subject>;
    beforeEach?: (subject: Subject) => Promise<State>;
    executeStep?: (state: State) => Promise<State>;
    verifyStep?: (state: State) => Promise<Selection>;
    afterEach?: (state: State) => Promise<void>;
    afterAll?: (state: State) => Promise<void>;
    assert?: (result: Selection) => void;
};
export type TestDefinition<Subject, State, Selection> = {
    subject: Subject;
    given?: (input: any) => State;
    when?: (state: State) => State | Promise<State>;
    then?: (state: State) => Selection | Promise<Selection>;
    resources?: ITTestResourceConfiguration;
    pm?: typeof PM;
};
export type TestSuite = {
    name: string;
    tests: TestDefinition<any, any, any>[];
    features?: string[];
};
export type RuntimeConfig = {
    type: "node" | "web" | "pure" | "spawn";
    ports?: number[];
    plugins?: Plugin[];
};
export type ProjectConfig = {
    name: string;
    sourceDir: string;
    testSuites: TestSuite[];
    runtime: RuntimeConfig;
    minify?: boolean;
    debug?: boolean;
};
export type GivenSpecification<I extends Ibdd_in_any, O extends Ibdd_out_any> = {
    [K in keyof O["givens"]]: (features: string[], whens: BaseWhen<I>[], thens: BaseThen<I>[], ...xtrasB: O["givens"][K]) => BaseGiven<I>;
};
export type WhenSpecification<I extends Ibdd_in_any, O extends Ibdd_out_any> = {
    [K in keyof O["whens"]]: (...xtrasC: O["whens"][K]) => BaseWhen<I>;
};
export type ThenSpecification<I extends Ibdd_in_any, O extends Ibdd_out_any> = {
    [K in keyof O["thens"]]: (...xtrasD: O["thens"][K]) => BaseThen<I>;
};
export type TestSuiteImplementation<O extends Ibdd_out_any> = {
    [K in keyof O["suites"]]: string;
};
export type TestGivenImplementation<I extends Ibdd_in_any, O extends Ibdd_out_any> = {
    [K in keyof O["givens"]]: (...Ig: O["givens"][K]) => I["given"];
};
export type TestWhenImplementation<I extends Ibdd_in_any, O extends Ibdd_out_any> = {
    [K in keyof O["whens"]]: (...Iw: O["whens"][K]) => (zel: I["iselection"], tr: ITTestResourceConfiguration, utils: PM) => Promise<I["when"]>;
};
export type TestThenImplementation<I extends Ibdd_in_any, O extends Ibdd_out_any> = {
    [K in keyof O["thens"]]: (...It: O["thens"][K]) => (ssel: I["iselection"], utils: PM) => I["then"];
};
export type Modify<T, R> = Omit<T, keyof R> & R;
export type TestSuiteShape = Record<string, any>;
export type TestGivenShape = Record<string, any>;
export type TestWhenShape = Record<string, any>;
export type TestThenShape = Record<string, any>;
export type IPluginFactory = (register?: (entrypoint: string, sources: string[]) => any, entrypoints?: string[]) => Plugin;
export type IRunTime = `node` | `web` | "pure" | `spawn`;
export type ITestTypes = [string, IRunTime, {
    ports: number;
}, ITestTypes[]];
export type ITestconfig = {
    clearScreen: boolean;
    debugger: boolean;
    externals: string[];
    featureIngestor: (s: string) => Promise<string>;
    importPlugins: IPluginFactory[];
    minify: boolean;
    nodePlugins: IPluginFactory[];
    ports: string[];
    src: string;
    tests: ITestTypes[];
    webPlugins: IPluginFactory[];
    webLoaders: Record<string, string>;
};
export type IBuiltConfig = {
    buildDir: string;
} & ITestconfig;
export type IProject = {
    projects: Record<string, ITestconfig>;
};