@graphql-mesh/openapi 1.0.0-alpha-20220804093904-8e2e41f7f → 1.0.0-alpha-20230420181317-a95037648

package/openapi-to-graphql/auth_builder.d.ts

@@ -1,24 +0,0 @@
-/**
- * Functions to create viewers that allow users to pass credentials to resolve
- * functions used by OpenAPI-to-GraphQL.
- */
-import { GraphQLObjectType, GraphQLFieldResolver } from 'graphql';
-import { Args, GraphQLOperationType } from './types/graphql';
-import { PreprocessingData } from './types/preprocessing_data';
-import { Logger } from '@graphql-mesh/types';
-declare type Viewer<TSource, TContext, TArgs> = {
-    type: GraphQLObjectType;
-    resolve: GraphQLFieldResolver<TSource, TContext, TArgs>;
-    args: Args;
-    description: string;
-};
-/**
- * Load the field object in the appropriate root object
- *
- * i.e. inside either rootQueryFields/rootMutationFields or inside
- * rootQueryFields/rootMutationFields for further processing
- */
-export declare function createAndLoadViewer<TSource, TContext, TArgs>(queryFields: any, operationType: GraphQLOperationType, data: PreprocessingData<TSource, TContext, TArgs>, includeHttpDetails: boolean, logger: Logger): {
-    [key: string]: Viewer<TSource, TContext, TArgs>;
-};
-export {};

package/openapi-to-graphql/graphql_tools.d.ts

@@ -1,8 +0,0 @@
-/**
- * Utilities related to GraphQL.
- */
-import { GraphQLObjectType as GQObjectType } from 'graphql';
-/**
- * Returns empty GraphQLObjectType.
- */
-export declare function getEmptyObjectType(name: string): GQObjectType;

package/openapi-to-graphql/index.d.ts

@@ -1,39 +0,0 @@
-/**
- * Defines the functions exposed by OpenAPI-to-GraphQL.
- *
- * Some general notes:
- *
- * - GraphQL interfaces rely on sanitized strings for (input) object type names
- *   and fields. We perform sanitization only when assigning (field-) names, but
- *   keep keys in the OAS otherwise as-is, to ensure that inner-OAS references
- *   work as expected.
- *
- * - GraphQL (input) object types must have a unique name. Thus, sometimes Input
- *   object types and object types need separate names, despite them having the
- *   same structure. We thus append 'Input' to every input object type's name
- *   as a convention.
- *
- * - To pass data between resolve functions, OpenAPI-to-GraphQL uses a _openAPIToGraphQL object
- *   returned by every resolver in addition to its original data (OpenAPI-to-GraphQL does
- *   not use the context to do so, which is an anti-pattern according to
- *   https://github.com/graphql/graphql-js/issues/953).
- *
- * - OpenAPI-to-GraphQL can handle basic authentication and API key-based authentication
- *   through GraphQL. To do this, OpenAPI-to-GraphQL creates two new intermediate Object
- *   Types called QueryViewer and MutationViewer that take as input security
- *   credentials and pass them on using the _openAPIToGraphQL object to other resolve
- *   functions.
- */
-import { Options, Report } from './types/options';
-import { Oas3 } from './types/oas3';
-import { GraphQLSchema } from 'graphql';
-declare type Result = {
-    schema: GraphQLSchema;
-    report: Report;
-};
-/**
- * Creates a GraphQL interface from the given OpenAPI Specification (2 or 3).
- */
-export declare function createGraphQLSchema<TSource, TContext, TArgs>(oasOrOass: Oas3 | Oas3[], options?: Options<TSource, TContext, TArgs>): Promise<Result>;
-export { sanitize, CaseStyle } from './oas_3_tools';
-export { GraphQLOperationType } from './types/graphql';

package/openapi-to-graphql/oas_3_tools.d.ts

@@ -1,208 +0,0 @@
-/**
- * Utility functions around the OpenAPI Specification 3.
- */
-import { Oas2 } from './types/oas2';
-import { Operation } from './types/operation';
-import { Oas3, ServerObject, ParameterObject, SchemaObject, OperationObject, ResponseObject, PathItemObject, RequestBodyObject, ReferenceObject, LinkObject, SecuritySchemeObject } from './types/oas3';
-import { PreprocessingData, ProcessedSecurityScheme } from './types/preprocessing_data';
-import { InternalOptions } from './types/options';
-import { Logger } from '@graphql-mesh/types';
-export declare type SchemaNames = {
-    fromRef?: string;
-    fromSchema?: string;
-    fromPath?: string;
-    /**
-     * Used when the preferred name is known, i.e. a new data def does not need to
-     * be created
-     */
-    preferred?: string;
-};
-export declare type RequestSchemaAndNames = {
-    payloadContentType?: string;
-    payloadSchema?: SchemaObject | ReferenceObject;
-    payloadSchemaNames?: SchemaNames;
-    payloadRequired: boolean;
-};
-export declare type ResponseSchemaAndNames = {
-    responseContentType?: string;
-    responseSchema?: SchemaObject | ReferenceObject;
-    responseSchemaNames?: SchemaNames;
-    statusCode?: string;
-};
-export declare enum HTTP_METHODS {
-    'get' = "get",
-    'put' = "put",
-    'post' = "post",
-    'patch' = "patch",
-    'delete' = "delete",
-    'options' = "options",
-    'head' = "head"
-}
-export declare const SUCCESS_STATUS_RX: RegExp;
-export declare const CONTENT_TYPE_JSON_RX: RegExp;
-/**
- * Given an HTTP method, convert it to the HTTP_METHODS enum
- */
-export declare function methodToHttpMethod(method: string): HTTP_METHODS;
-/**
- * Resolves on a validated OAS 3 for the given spec (OAS 2 or OAS 3), or rejects
- * if errors occur.
- */
-export declare function getValidOAS3(spec: Oas2 | Oas3): Promise<Oas3>;
-/**
- * Counts the number of operations in an OAS.
- */
-export declare function countOperations(oas: Oas3): number;
-/**
- * Counts the number of operations that translate to queries in an OAS.
- */
-export declare function countOperationsQuery(oas: Oas3): number;
-/**
- * Counts the number of operations that translate to mutations in an OAS.
- */
-export declare function countOperationsMutation(oas: Oas3): number;
-/**
- * Counts the number of operations that translate to subscriptions in an OAS.
- */
-export declare function countOperationsSubscription(oas: Oas3): number;
-/**
- * Counts the number of operations with a payload definition in an OAS.
- */
-export declare function countOperationsWithPayload(oas: Oas3): number;
-/**
- * Resolves the given reference in the given object.
- */
-export declare function resolveRef(ref: string, oas: Oas3): any;
-/**
- * Returns the base URL to use for the given operation.
- */
-export declare function getBaseUrl(operation: Operation, logger: Logger): string;
-/**
- * Returns object/array/scalar where all object keys (if applicable) are
- * sanitized.
- */
-export declare function sanitizeObjectKeys(obj: any, // obj does not necessarily need to be an object
-caseStyle?: CaseStyle): any;
-/**
- * Desanitizes keys in given object by replacing them with the keys stored in
- * the given mapping.
- */
-export declare function desanitizeObjectKeys(obj: object | Array<any>, mapping?: object): object | Array<any>;
-/**
- * Returns the GraphQL type that the provided schema should be made into
- *
- * Does not consider allOf, anyOf, oneOf, or not (handled separately)
- */
-export declare function getSchemaTargetGraphQLType<TSource, TContext, TArgs>(schema: SchemaObject, data: PreprocessingData<TSource, TContext, TArgs>): string | null;
-/**
- * Infers a resource name from the given URL path.
- *
- * For example, turns "/users/{userId}/car" into "userCar".
- */
-export declare function inferResourceNameFromPath(path: string): string;
-/**
- * Returns JSON-compatible schema required by the given operation
- */
-export declare function getRequestBodyObject(operation: OperationObject, oas: Oas3): {
-    payloadContentType: string;
-    requestBodyObject: RequestBodyObject;
-} | null;
-/**
- * Returns the request schema (if any) for the given operation,
- * a dictionary of names from different sources (if available), and whether the
- * request schema is required for the operation.
- */
-export declare function getRequestSchemaAndNames(path: string, operation: OperationObject, oas: Oas3): RequestSchemaAndNames;
-/**
- * Returns JSON-compatible schema produced by the given operation
- */
-export declare function getResponseObject(operation: OperationObject, statusCode: string, oas: Oas3): {
-    responseContentType: string;
-    responseObject: ResponseObject;
-} | null;
-/**
- * Returns the response schema for the given operation,
- * a successful  status code, and a dictionary of names from different sources
- * (if available).
- */
-export declare function getResponseSchemaAndNames<TSource, TContext, TArgs>(path: string, method: HTTP_METHODS, operation: OperationObject, oas: Oas3, data: PreprocessingData<TSource, TContext, TArgs>, options: InternalOptions<TSource, TContext, TArgs>): ResponseSchemaAndNames;
-/**
- * Returns a success status code for the given operation
- */
-export declare function getResponseStatusCode<TSource, TContext, TArgs>(path: string, method: string, operation: OperationObject, oas: Oas3, data: PreprocessingData<TSource, TContext, TArgs>, logger: Logger): string | void;
-/**
- * Returns a hash containing the links in the given operation.
- */
-export declare function getLinks<TSource, TContext, TArgs>(path: string, method: HTTP_METHODS, operation: OperationObject, oas: Oas3, data: PreprocessingData<TSource, TContext, TArgs>, logger: Logger): {
-    [key: string]: LinkObject;
-};
-/**
- * Returns the list of parameters in the given operation.
- */
-export declare function getParameters(path: string, method: HTTP_METHODS, operation: OperationObject, pathItem: PathItemObject, oas: Oas3, logger: Logger): ParameterObject[];
-/**
- * Returns an array of server objects for the operation at the given path and
- * method. Considers in the following order: global server definitions,
- * definitions at the path item, definitions at the operation, or the OAS
- * default.
- */
-export declare function getServers(operation: OperationObject, pathItem: PathItemObject, oas: Oas3): ServerObject[];
-/**
- * Returns a map of Security Scheme definitions, identified by keys. Resolves
- * possible references.
- */
-export declare function getSecuritySchemes(oas: Oas3): {
-    [key: string]: SecuritySchemeObject;
-};
-/**
- * Returns the list of sanitized keys of non-OAuth2 security schemes
- * required by the operation at the given path and method.
- */
-export declare function getSecurityRequirements(operation: OperationObject, securitySchemes: {
-    [key: string]: ProcessedSecurityScheme;
-}, oas: Oas3): string[];
-export declare enum CaseStyle {
-    simple = 0,
-    PascalCase = 1,
-    camelCase = 2,
-    ALL_CAPS = 3
-}
-/**
- * First sanitizes given string and then also camel-cases it.
- */
-export declare function sanitize(str: string, caseStyle: CaseStyle): string;
-/**
- * Sanitizes the given string and stores the sanitized-to-original mapping in
- * the given mapping.
- */
-export declare function storeSaneName(saneStr: string, str: string, mapping: {
-    [key: string]: string;
-}, logger: Logger): string;
-/**
- * Stringifies and possibly trims the given string to the provided length.
- */
-export declare function trim(str: string, length: number): string;
-/**
- * Determines if the given "method" is indeed an operation. Alternatively, the
- * method could point to other types of information (e.g., parameters, servers).
- */
-export declare function isHttpMethod(method: string): boolean;
-/**
- * Formats a string that describes an operation in the form:
- * {name of OAS} {HTTP method in ALL_CAPS} {operation path}
- *
- * Also used in preprocessing.ts where Operation objects are being constructed
- */
-export declare function formatOperationString(method: string, path: string, title?: string): string;
-/**
- * Capitalizes a given string
- */
-export declare function capitalize(str: string): string;
-/**
- * Uncapitalizes a given string
- */
-export declare function uncapitalize(str: string): string;
-/**
- * For operations that do not have an operationId, generate one
- */
-export declare function generateOperationId(method: HTTP_METHODS, path: string): string;

package/openapi-to-graphql/preprocessor.d.ts

@@ -1,18 +0,0 @@
-import { Oas3, LinkObject, SchemaObject } from './types/oas3';
-import { InternalOptions } from './types/options';
-import { DataDefinition } from './types/operation';
-import { PreprocessingData } from './types/preprocessing_data';
-import * as Oas3Tools from './oas_3_tools';
-import { Logger } from '@graphql-mesh/types';
-/**
- * Extract information from the OAS and put it inside a data structure that
- * is easier for OpenAPI-to-GraphQL to use
- */
-export declare function preprocessOas<TSource, TContext, TArgs>(oass: Oas3[], options: InternalOptions<TSource, TContext, TArgs>): PreprocessingData<TSource, TContext, TArgs>;
-/**
- * Method to either create a new or reuse an existing, centrally stored data
- * definition.
- */
-export declare function createDataDef<TSource, TContext, TArgs>(names: Oas3Tools.SchemaNames, schema: SchemaObject, isInputObjectType: boolean, data: PreprocessingData<TSource, TContext, TArgs>, oas: Oas3, logger: Logger, links?: {
-    [key: string]: LinkObject;
-}): DataDefinition;

package/openapi-to-graphql/resolver_builder.d.ts

@@ -1,60 +0,0 @@
-/**
- * Functions to create resolve functions.
- */
-import { ParameterObject } from './types/oas3';
-import { Operation } from './types/operation';
-import { ResolveFunction, SubscriptionContext } from './types/graphql';
-import { PreprocessingData } from './types/preprocessing_data';
-import { GraphQLFieldResolver } from 'graphql';
-import { ConnectOptions, RequestOptions } from './types/options';
-import { Logger, MeshPubSub } from '@graphql-mesh/types';
-declare type GetResolverParams<TSource, TContext, TArgs> = {
-    operation: Operation;
-    argsFromLink?: Record<string, string>;
-    payloadName?: string;
-    responseName?: string;
-    data: PreprocessingData<TSource, TContext, TArgs>;
-    baseUrl?: string;
-    requestOptions?: RequestOptions<TSource, TContext, TArgs>;
-    fetch?: (input: RequestInfo, init?: RequestInit, ctx?: TContext) => Promise<Response>;
-    qs?: Record<string, string>;
-    logger: Logger;
-};
-declare type GetSubscribeParams<TSource, TContext, TArgs> = {
-    operation: Operation;
-    argsFromLink?: {
-        [key: string]: string;
-    };
-    payloadName?: string;
-    data: PreprocessingData<TSource, TContext, TArgs>;
-    baseUrl?: string;
-    connectOptions?: ConnectOptions;
-    pubsub: MeshPubSub;
-    logger: Logger;
-};
-export declare function getSubscribe<TSource, TContext, TArgs>({ operation, payloadName, data, baseUrl, connectOptions, pubsub, logger, }: GetSubscribeParams<TSource, TContext, TArgs>): GraphQLFieldResolver<TSource, SubscriptionContext, TArgs>;
-export declare function getPublishResolver<TSource, TContext, TArgs>({ operation, responseName, data, logger, }: GetResolverParams<TSource, TContext, TArgs>): GraphQLFieldResolver<TSource, TContext, TArgs>;
-export declare type ResolverMiddleware<TSource, TContext, TArgs> = (getResolverParams: () => GetResolverParams<TSource, TContext, TArgs>, factory: ResolverFactory) => ResolveFunction;
-declare type ResolverFactory = typeof getResolver;
-/**
- * Creates and returns a resolver function that performs API requests for the
- * given GraphQL query
- */
-export declare function getResolver<TSource, TContext, TArgs>(getResolverParams: () => GetResolverParams<TSource, TContext, TArgs>, logger: Logger): ResolveFunction;
-/**
- * Extracts data from the GraphQL arguments of a particular field
- *
- * Replaces the path parameter in the given path with values in the given args.
- * Furthermore adds the query parameters for a request.
- */
-export declare function extractRequestDataFromArgs<TSource, TContext, TArgs>(path: string, parameters: ParameterObject[], args: TArgs, // NOTE: argument keys are sanitized!
-data: PreprocessingData<TSource, TContext, TArgs>, logger: Logger): {
-    path: string;
-    qs: {
-        [key: string]: string;
-    };
-    headers: {
-        [key: string]: string;
-    };
-};
-export {};

package/openapi-to-graphql/schema_builder.d.ts

@@ -1,36 +0,0 @@
-/**
- * Functions to translate JSON schema to GraphQL (input) object types.
- */
-import { PreprocessingData } from './types/preprocessing_data';
-import { Operation, DataDefinition } from './types/operation';
-import { ParameterObject } from './types/oas3';
-import { Args, GraphQLType } from './types/graphql';
-import { Logger } from '@graphql-mesh/types';
-declare type GetArgsParams<TSource, TContext, TArgs> = {
-    requestPayloadDef?: DataDefinition;
-    parameters: ParameterObject[];
-    operation?: Operation;
-    data: PreprocessingData<TSource, TContext, TArgs>;
-    includeHttpDetails: boolean;
-    logger: Logger;
-};
-declare type CreateOrReuseComplexTypeParams<TSource, TContext, TArgs> = {
-    def: DataDefinition;
-    operation?: Operation;
-    iteration?: number;
-    isInputObjectType?: boolean;
-    data: PreprocessingData<TSource, TContext, TArgs>;
-    includeHttpDetails: boolean;
-    logger: Logger;
-};
-/**
- * Creates and returns a GraphQL type for the given JSON schema.
- */
-export declare function getGraphQLType<TSource, TContext, TArgs>({ def, operation, data, iteration, isInputObjectType, includeHttpDetails, logger, }: CreateOrReuseComplexTypeParams<TSource, TContext, TArgs>): GraphQLType;
-/**
- * Creates the arguments for resolving a field
- *
- * Arguments that are provided via options will be ignored
- */
-export declare function getArgs<TSource, TContext, TArgs>({ requestPayloadDef, parameters, operation, data, includeHttpDetails, logger, }: GetArgsParams<TSource, TContext, TArgs>): Args;
-export {};

package/openapi-to-graphql/types/graphql.d.ts

@@ -1,31 +0,0 @@
-/**
- * Custom type definitions for GraphQL.
- */
-import { GraphQLObjectType, GraphQLScalarType, GraphQLInputObjectType, GraphQLList, GraphQLEnumType, GraphQLUnionType, GraphQLFieldResolver, GraphQLResolveInfo } from 'graphql';
-export declare enum GraphQLOperationType {
-    Query = 0,
-    Mutation = 1,
-    Subscription = 2
-}
-export declare type GraphQLType = GraphQLObjectType | GraphQLInputObjectType | GraphQLList<any> | GraphQLUnionType | GraphQLEnumType | GraphQLScalarType;
-declare type Arg = {
-    type: any;
-    description?: string;
-};
-export declare type Args = {
-    [key: string]: Arg;
-};
-export declare type SubscriptionContext = {
-    pubsub: any;
-    [key: string]: any;
-};
-export declare type SubscriptionIterator = (root: object, args: object, context: SubscriptionContext, info?: object) => AsyncIterable<string | string[]>;
-export declare type Field<TSource, TContext, TArgs> = {
-    type: GraphQLType;
-    resolve?: GraphQLFieldResolver<TSource, TContext, TArgs>;
-    subscribe?: GraphQLFieldResolver<TSource, SubscriptionContext, TArgs>;
-    args?: Args;
-    description: string;
-};
-export declare type ResolveFunction = (root: any, args: any, ctx: any, info: GraphQLResolveInfo) => Promise<any> | any;
-export {};

package/openapi-to-graphql/types/oas2.d.ts

@@ -1,10 +0,0 @@
-/**
- * Type definitions for the OpenAPI specification 2.0 (Swagger).
- *
- * NOTE: We do not really care about OpenAPI specification 2.0 / Swagger, as we
- * translate it to Oas3 immediately anyways.
- */
-export declare type Oas2 = {
-    swagger: string;
-    [key: string]: any;
-};

package/openapi-to-graphql/types/oas3.d.ts

@@ -1,243 +0,0 @@
-/**
- * Type definitions for the OpenAPI Specification 3.
- */
-declare type ExternalDocumentationObject = {
-    description?: string;
-    url: string;
-};
-export declare type SchemaObject = {
-    $ref?: string;
-    title?: string;
-    type?: 'string' | 'number' | 'object' | 'array' | 'boolean' | 'integer';
-    format?: string;
-    nullable?: boolean;
-    description?: string;
-    properties?: {
-        [key: string]: SchemaObject | ReferenceObject;
-    };
-    required?: string[];
-    default?: any;
-    additionalProperties?: SchemaObject | ReferenceObject;
-    items?: SchemaObject | ReferenceObject;
-    additionalItems?: boolean | string[];
-    enum?: string[];
-    allOf?: (SchemaObject | ReferenceObject)[];
-    anyOf?: (SchemaObject | ReferenceObject)[];
-    oneOf?: (SchemaObject | ReferenceObject)[];
-    not?: (SchemaObject | ReferenceObject)[];
-};
-export declare type ReferenceObject = {
-    $ref: string;
-};
-declare type ExampleObject = {
-    summary?: string;
-    description?: string;
-    value?: any;
-    externalValue?: string;
-};
-declare type HeaderObject = {
-    name?: string;
-    in?: 'query' | 'header' | 'path' | 'cookie';
-    description?: string;
-    required?: boolean;
-    deprecated?: boolean;
-    allowEmptyValue?: boolean;
-};
-declare type EncodingObject = {
-    contentType?: string;
-    headers?: {
-        [key: string]: HeaderObject | ReferenceObject;
-    };
-    style?: string;
-    explode?: boolean;
-    allowReserved?: boolean;
-};
-export declare type MediaTypeObject = {
-    schema?: SchemaObject | ReferenceObject;
-    example?: any;
-    examples?: {
-        [key: string]: ExampleObject | ReferenceObject;
-    };
-    encoding?: {
-        [key: string]: EncodingObject;
-    };
-};
-export declare type ParameterObject = {
-    name: string;
-    in: 'query' | 'header' | 'path' | 'cookie';
-    description?: string;
-    required?: boolean;
-    deprecated?: boolean;
-    allowEmptyValue?: boolean;
-    style?: 'form' | 'simple';
-    explode?: boolean;
-    allowReserved?: boolean;
-    schema?: SchemaObject | ReferenceObject;
-    example?: any;
-    examples?: {
-        [key: string]: ExampleObject | ReferenceObject;
-    };
-    content?: {
-        [key: string]: MediaTypeObject;
-    };
-};
-export declare type MediaTypesObject = {
-    [key: string]: MediaTypeObject;
-};
-export declare type ServerObject = {
-    url: string;
-    description?: string;
-    variables?: object;
-};
-export declare type RequestBodyObject = {
-    description?: string;
-    content: {
-        [key: string]: MediaTypeObject;
-    };
-    required?: boolean;
-};
-export declare type LinkObject = {
-    operationRef?: string;
-    operationId?: string;
-    parameters?: {
-        [key: string]: any;
-    };
-    requestBody?: any;
-    description?: string;
-    server?: ServerObject;
-};
-export declare type LinksObject = {
-    [key: string]: LinkObject | ReferenceObject;
-};
-export declare type ResponseObject = {
-    description: string;
-    headers?: {
-        [key: string]: HeaderObject | ReferenceObject;
-    };
-    content?: MediaTypesObject;
-    links?: LinksObject;
-};
-export declare type ResponsesObject = {
-    [key: string]: ResponseObject | ReferenceObject;
-};
-export declare type SecurityRequirementObject = {
-    [key: string]: string[];
-};
-export declare type OperationObject = {
-    tags?: string[];
-    summary?: string;
-    description?: string;
-    externalDocs?: ExternalDocumentationObject;
-    operationId?: string;
-    parameters?: Array<ParameterObject | ReferenceObject>;
-    requestBody?: RequestBodyObject | ReferenceObject;
-    responses?: ResponsesObject;
-    callbacks?: CallbacksObject;
-    deprecated?: boolean;
-    security?: SecurityRequirementObject[];
-    servers?: ServerObject[];
-};
-export declare type PathItemObject = {
-    $ref?: string;
-    summary?: string;
-    description: string;
-    get: OperationObject;
-    put: OperationObject;
-    post: OperationObject;
-    delete: OperationObject;
-    options: OperationObject;
-    head: OperationObject;
-    patch: OperationObject;
-    trace: OperationObject;
-    servers?: ServerObject[];
-    parameters?: [ParameterObject | ReferenceObject];
-};
-declare type PathsObject = {
-    [key: string]: PathItemObject;
-};
-export declare type CallbackObject = {
-    [key: string]: PathItemObject;
-};
-export declare type CallbacksObject = {
-    [key: string]: CallbackObject | ReferenceObject;
-};
-declare type OAuthFlowObject = {
-    authorizationUrl?: string;
-    tokenUrl?: string;
-    refreshUrl?: string;
-    scopes?: {
-        [key: string]: string;
-    };
-};
-declare type OAuthFlowsObject = {
-    implicit?: OAuthFlowObject;
-    password?: OAuthFlowObject;
-    clientCredentials?: OAuthFlowObject;
-    authorizationCode?: OAuthFlowObject;
-};
-export declare type SecuritySchemeObject = {
-    type: 'apiKey' | 'http' | 'oauth2' | 'openIdConnect';
-    description?: string;
-    name?: string;
-    in?: string;
-    scheme?: string;
-    bearerFormat?: string;
-    flows?: OAuthFlowsObject;
-    openIdConnectUrl?: string;
-};
-export declare type SecuritySchemesObject = {
-    [key: string]: SecuritySchemeObject | ReferenceObject;
-};
-declare type ComponentsObject = {
-    schemas?: {
-        [key: string]: SchemaObject | ReferenceObject;
-    };
-    responses?: ResponsesObject;
-    parameters?: {
-        [key: string]: ParameterObject | ReferenceObject;
-    };
-    examples?: {
-        [key: string]: ExampleObject | ReferenceObject;
-    };
-    requestBodies?: {
-        [key: string]: RequestBodyObject | ReferenceObject;
-    };
-    headers?: {
-        [key: string]: HeaderObject | ReferenceObject;
-    };
-    securitySchemes?: SecuritySchemesObject;
-    links?: LinksObject;
-    callbacks?: {
-        [key: string]: CallbackObject | ReferenceObject;
-    };
-};
-declare type TagObject = {
-    name: string;
-    description?: string;
-    externalDocs?: ExternalDocumentationObject;
-};
-export declare type Oas3 = {
-    openapi: string;
-    info: {
-        title: string;
-        description?: string;
-        termsOfService?: string;
-        contact?: {
-            name?: string;
-            url?: string;
-            email?: string;
-        };
-        license?: {
-            name: string;
-            url?: string;
-        };
-        version: string;
-    };
-    servers?: ServerObject[];
-    paths: PathsObject;
-    components?: ComponentsObject;
-    security?: SecurityRequirementObject[];
-    tags?: TagObject[];
-    externalDocs?: ExternalDocumentationObject;
-};
-export {};