@apideck/portman/dist/types/PortmanConfig.d.ts

Port OpenAPI Spec to Postman Collection, with contract & variation tests included

import { PortmanOptions } from './PortmanOptions';
import { OpenApiParser } from '../oas';
import { PostmanParser } from '../postman';
type ContractTest = {
    enabled: boolean;
    excludeForOperations?: string[];
};
type StatusSuccess = ContractTest;
type ContentType = ContractTest;
type JsonBody = ContractTest;
type SchemaValidation = ContractTest;
type HeadersPresent = ContractTest;
export type ResponseTime = ContractTest & {
    maxMs: number;
};
export type StatusCode = ContractTest & {
    code?: number;
};
export type additionalProperties = ContractTest & {
    additionalProperties?: boolean;
};
export type ContractTestConfig = {
    openApiOperationIds?: string[];
    openApiOperationId?: string;
    openApiOperation?: string;
    openApiRequest?: string;
    openApiResponse?: string;
    excludeForOperations?: string[];
    statusSuccess?: StatusSuccess;
    statusCode?: StatusCode;
    contentType?: ContentType;
    jsonBody?: JsonBody;
    schemaValidation?: SchemaValidation;
    additionalProperties?: additionalProperties;
    headersPresent?: HeadersPresent;
    responseTime?: ResponseTime;
};
export type ContentTestConfig = {
    openApiOperationIds?: string[];
    openApiOperationId?: string;
    openApiOperation?: string;
    openApiRequest?: string;
    openApiResponse?: string;
    excludeForOperations?: string[];
    responseBodyTests?: ResponseBodyTest[];
    responseHeaderTests?: ResponseHeaderTest[];
};
export type IntegrationTestConfig = {
    name: string;
    operations: IntegrationTest[];
};
export type IntegrationTest = {
    openApiOperationId: string;
    openApiResponse?: string;
    variations: VariationConfig[];
};
export type VariationTestConfig = {
    openApiOperationIds?: string[];
    openApiOperationId?: string;
    openApiOperation?: string;
    excludeForOperations?: string[];
    openApiRequest?: string;
    openApiResponse?: string;
    variations: VariationConfig[];
};
export type VariationConfig = {
    name: string;
    openApiRequest?: string;
    openApiResponse?: string;
    overwrites?: any;
    fuzzing?: fuzzingConfig[];
    tests: any;
    assignVariables?: AssignVariablesConfig[];
    extendTests?: ExtendTestsConfig[];
    operationPreRequestScripts?: OperationPreRequestScriptConfig[];
};
export type ResponseBodyTest = {
    key: string;
    value?: string | number | boolean | null;
    contains?: string;
    oneOf?: string[] | number[] | boolean[];
    length?: string | number;
    minLength?: string | number;
    maxLength?: string | number;
    notExist?: boolean;
    assert?: string;
};
export type ResponseHeaderTest = {
    key: string;
    value?: string | number | boolean;
    contains?: string;
    oneOf?: string[];
    length?: string | number;
    minLength?: string | number;
    maxLength?: string | number;
    notExist?: boolean;
    assert?: string;
};
type OverwriteConfig = {
    key: string;
    value?: string;
    overwrite?: boolean;
    remove?: boolean;
};
export type OverwriteRequestBaseUrlConfig = {
    value?: string;
    remove?: boolean;
    overwrite?: boolean;
};
export type OverwriteQueryParamConfig = OverwriteConfig & {
    disable?: boolean;
    insert?: boolean;
    description?: string;
};
export type OverwriteRequestBodyConfig = Omit<OverwriteConfig, 'value'> & {
    value?: any;
    disable?: boolean;
    insert?: boolean;
    description?: string;
};
export type OverwritePathVariableConfig = OverwriteConfig & {
    disable?: boolean;
    insert?: boolean;
    description?: string;
};
export type OverwriteRequestHeadersConfig = OverwriteConfig & {
    disable?: boolean;
    insert?: boolean;
    description?: string;
};
export type OverwriteRequestConfig = {
    openApiOperationIds?: string[];
    openApiOperationId?: string;
    openApiOperation?: string;
    excludeForOperations?: string[];
    overwriteRequestQueryParams?: OverwriteQueryParamConfig[];
    overwriteRequestPathVariables?: OverwritePathVariableConfig[];
    overwriteRequestBody?: OverwriteRequestBodyConfig[];
    overwriteRequestHeaders?: OverwriteRequestHeadersConfig[];
    overwriteRequestBaseUrl?: OverwriteRequestBaseUrlConfig;
    overwriteRequestSecurity?: OverwriteRequestSecurityConfig;
};
export type OverwriteRequestSecurityConfig = SecurityOverwrite;
export type CollectionVariableConfig = {
    requestBodyProp?: string;
    responseBodyProp?: string;
    responseHeaderProp?: string;
    name?: string;
    value?: any;
};
export type AssignVariablesConfig = {
    openApiOperationIds?: string[];
    openApiOperationId?: string;
    openApiOperation?: string;
    excludeForOperations?: string[];
    collectionVariables: CollectionVariableConfig[];
};
export type ExtendTestsConfig = {
    openApiOperationIds?: string[];
    openApiOperationId?: string;
    openApiOperation?: string;
    excludeForOperations?: string[];
    tests: string[];
    overwrite?: boolean;
    append?: boolean;
};
export type OperationPreRequestScriptConfig = {
    openApiOperationIds?: string[];
    openApiOperationId?: string;
    openApiOperation?: string;
    excludeForOperations?: string[];
    scripts: string[];
};
export interface AuthAttribute {
    key: string;
    value?: unknown;
    type?: string;
}
export type SecurityOverwrite = {
    apikey?: SecurityApiKey;
    apiKey?: SecurityApiKey;
    bearer?: SecurityBearer;
    basic?: SecurityBasicAuth;
    awsv4?: AuthAttribute[];
    digest?: AuthAttribute[];
    edgegrid?: AuthAttribute[];
    hawk?: AuthAttribute[];
    ntlm?: AuthAttribute[];
    oauth1?: AuthAttribute[];
    oauth2?: AuthAttribute[];
    other?: {
        type: string;
        [key: string]: unknown | unknown[];
    };
    remove?: boolean;
};
export type SecurityApiKey = {
    key?: string;
    value: string;
    in?: string;
};
export type SecurityBearer = {
    token: string;
};
export type SecurityBasicAuth = {
    username: string;
    password: string;
};
export type GlobalReplacement = {
    searchFor: string;
    replaceWith: string;
};
export type GlobalConfig = {
    collectionPreRequestScripts?: string[];
    collectionTestScripts?: string[];
    collectionVariables?: Record<string, unknown>;
    securityOverwrites?: SecurityOverwrite;
    keyValueReplacements?: Record<string, unknown>;
    valueReplacements?: Record<string, unknown>;
    rawReplacements?: GlobalReplacement[];
    portmanReplacements?: GlobalReplacement[];
    orderOfOperations?: string[];
    orderOfFolders?: string[];
    stripResponseExamples?: boolean;
    variableCasing?: 'camelCase' | 'pascalCase' | 'kebabCase' | 'trainCase' | 'snakeCase' | 'adaCase' | 'constantCase' | 'cobolCase' | 'dotNotation' | 'lowerCase' | 'upperCase';
    separatorSymbol?: string | '::';
};
export interface TestSuiteOptions {
    config: PortmanConfig;
    oasParser: OpenApiParser;
    postmanParser: PostmanParser;
    options?: PortmanOptions;
}
export type TestConfig = {
    contractTests?: ContractTestConfig[];
    contentTests?: ContentTestConfig[];
    extendTests?: ExtendTestsConfig[];
    variationTests?: VariationTestConfig[];
    integrationTests?: IntegrationTestConfig[];
};
type fuzzingSchemaItem = {
    path: string;
    field?: string;
    value: any;
};
export declare const PortmanFuzzTypes: {
    readonly requestBody: "requestBody";
    readonly requestQueryParam: "requestQueryParam";
    readonly requestHeader: "requestHeader";
};
export type PortmanFuzzType = (typeof PortmanFuzzTypes)[keyof typeof PortmanFuzzTypes];
export type FuzzingSchemaItems = {
    fuzzType: PortmanFuzzType;
    requiredFields: string[];
    minimumNumberFields?: fuzzingSchemaItem[];
    maximumNumberFields?: fuzzingSchemaItem[];
    minLengthFields?: fuzzingSchemaItem[];
    maxLengthFields?: fuzzingSchemaItem[];
};
type fuzzingOptions = {
    enabled: boolean;
};
export type fuzzRequestBody = {
    requiredFields?: fuzzingOptions;
    minimumNumberFields?: fuzzingOptions;
    maximumNumberFields?: fuzzingOptions;
    minLengthFields?: fuzzingOptions;
    maxLengthFields?: fuzzingOptions;
};
export type fuzzRequestQueryParam = {
    requiredFields?: fuzzingOptions;
    minimumNumberFields?: fuzzingOptions;
    maximumNumberFields?: fuzzingOptions;
    minLengthFields?: fuzzingOptions;
    maxLengthFields?: fuzzingOptions;
};
export type fuzzRequestHeader = {
    requiredFields?: fuzzingOptions;
    minimumNumberFields?: fuzzingOptions;
    maximumNumberFields?: fuzzingOptions;
    minLengthFields?: fuzzingOptions;
    maxLengthFields?: fuzzingOptions;
};
export type fuzzingConfig = {
    requestBody?: fuzzRequestBody[];
    requestQueryParams?: fuzzRequestQueryParam[];
    requestHeaders?: fuzzRequestHeader[];
};
export interface PortmanConfig {
    version?: number;
    $schema?: string;
    globals?: GlobalConfig;
    tests?: TestConfig;
    overwrites?: OverwriteRequestConfig[];
    assignVariables?: AssignVariablesConfig[];
    operationPreRequestScripts?: OperationPreRequestScriptConfig[];
}
export {};