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

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

@@ -1,122 +0,0 @@
-/**
- * Type definitions for the objects created during preprocessing for every
- * operation in the OAS.
- */
-import { Oas3, LinkObject, ParameterObject, ServerObject, SchemaObject } from './oas3';
-import { GraphQLOperationType } from './graphql';
-import { GraphQLScalarType, GraphQLObjectType, GraphQLInputObjectType, GraphQLList, GraphQLEnumType, GraphQLUnionType } from 'graphql';
-import { HTTP_METHODS } from '../oas_3_tools';
-export declare type DataDefinition = {
-    preferredName: string;
-    schema: SchemaObject;
-    /**
-     * Similar to the required property in object schemas but because of certain
-     * keywords to combine schemas, e.g. "allOf", this resolves the required
-     * property in all member schemas
-     */
-    required: string[];
-    targetGraphQLType: string;
-    links: {
-        [key: string]: LinkObject;
-    };
-    /**
-     * Data definitions of subschemas in the schema
-     *
-     * I.e. If the dataDef is a list type, the subDefinition is a reference to the
-     * list item type
-     *
-     * Or if the dataDef is an object type, the subDefinitions are references to
-     * the field types
-     *
-     * Or if the dataDef is a union type, the subDefinitions are references to
-     * the member types
-     */
-    subDefinitions: DataDefinition | {
-        [fieldName: string]: DataDefinition;
-    } | DataDefinition[];
-    graphQLTypeName: string;
-    graphQLInputObjectTypeName: string;
-    graphQLType?: GraphQLObjectType | GraphQLList<any> | GraphQLUnionType | GraphQLEnumType | GraphQLScalarType;
-    graphQLInputObjectType?: GraphQLInputObjectType | GraphQLList<any>;
-};
-export declare type Operation = {
-    /**
-     * Identifier of the operation - may be created by concatenating method & path
-     */
-    operationId: string;
-    /**
-     * A combination of the operation method and path (and the title of the OAS
-     * where the operation originates from if multiple OASs are provided) in the
-     * form of:
-     *
-     * {title of OAS (if applicable)} {method in ALL_CAPS} {path}
-     *
-     * Used for documentation and logging
-     */
-    operationString: string;
-    /**
-     * Human-readable description of the operation
-     */
-    description: string;
-    /**
-     * URL path of this operation
-     */
-    path: string;
-    /**
-     * HTTP method for this operation
-     */
-    method: HTTP_METHODS;
-    /**
-     * Content-type of the request payload
-     */
-    payloadContentType?: string;
-    /**
-     * Information about the request payload (if any)
-     */
-    payloadDefinition?: DataDefinition;
-    /**
-     * Determines wheter request payload is required for the request
-     */
-    payloadRequired: boolean;
-    /**
-     * Content-type of the request payload
-     */
-    responseContentType?: string;
-    /**
-     * Information about the response payload
-     */
-    responseDefinition: DataDefinition;
-    /**
-     * List of parameters of the operation
-     */
-    parameters: ParameterObject[];
-    /**
-     * List of keys of security schemes required by this operation
-     *
-     * NOTE: Keys are sanitized
-     * NOTE: Does not contain OAuth 2.0-related security schemes
-     */
-    securityRequirements: string[];
-    /**
-     * (Local) server definitions of the operation.
-     */
-    servers: ServerObject[];
-    /**
-     * Whether this operation should be placed in an authentication viewer
-     * (cannot be true if "viewer" option passed to OpenAPI-to-GraphQL is false).
-     */
-    inViewer: boolean;
-    /**
-     * Type of root operation type, i.e. whether the generated field should be
-     * added to the Query, Mutation, or Subscription root operation
-     */
-    operationType: GraphQLOperationType;
-    /**
-     * The success HTTP code, 200-299, destined to become a GraphQL object type
-     */
-    statusCode: string;
-    /**
-     * The OAS which this operation originated from
-     */
-    oas: Oas3;
-};

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

@@ -1,251 +0,0 @@
-import { GraphQLOperationType, SubscriptionContext } from './graphql';
-import { GraphQLFieldResolver, GraphQLResolveInfo } from 'graphql';
-import { ResolverMiddleware } from '../resolver_builder';
-import { Logger, MeshPubSub } from '@graphql-mesh/types';
-/**
- * Type definition of the options that users can pass to OpenAPI-to-GraphQL.
- */
-export declare type Warning = {
-    type: string;
-    message: string;
-    mitigation: string;
-    path?: string[];
-};
-export declare type Report = {
-    warnings: Warning[];
-    numOps: number;
-    numOpsQuery: number;
-    numOpsMutation: number;
-    numOpsSubscription: number;
-    numQueriesCreated: number;
-    numMutationsCreated: number;
-    numSubscriptionsCreated: number;
-};
-export declare type ConnectOptions = {
-    [key: string]: boolean | number | string;
-};
-export declare type OasTitlePathMethodObject<T> = {
-    [title: string]: {
-        [path: string]: {
-            [method: string]: T;
-        };
-    };
-};
-export declare type Headers = {
-    [key: string]: string;
-};
-/**
- * Given a set parameters corresponding to a specific operation in the OAS,
- * provide the appropriate headers
- */
-export declare type RequestHeadersFunction<TSource, TContext, TArgs> = (method: string, path: string, title: string, resolverParams?: {
-    source: TSource;
-    args: TArgs;
-    context: TContext;
-    info: GraphQLResolveInfo;
-}) => Headers;
-export declare type RequestOptions<TSource, TContext, TArgs> = RequestInit;
-export declare type Options<TSource, TContext, TArgs> = Partial<InternalOptions<TSource, TContext, TArgs>>;
-export declare type InternalOptions<TSource, TContext, TArgs> = {
-    strict: boolean;
-    /**
-     * Holds information about the GraphQL schema generation process
-     */
-    report: Report;
-    /**
-     * Field names can only be sanitized operationIds
-     *
-     * By default, query field names are based on the return type type name and
-     * mutation field names are based on the operationId, which may be generated
-     * if it does not exist.
-     *
-     * This option forces OpenAPI-to-GraphQL to only create field names based on the
-     * operationId.
-     */
-    operationIdFieldNames: boolean;
-    /**
-     * Under certain circumstances (such as response code 204), some RESTful
-     * operations should not return any data. However, GraphQL objects must have
-     * a data structure. Normally, these operations would be ignored but for the
-     * sake of completeness, the following option will give these operations a
-     * placeholder data structure. Even though the data structure will not have
-     * any practical use, at least the operations will show up in the schema.
-     */
-    fillEmptyResponses: boolean;
-    /**
-     * Auto-generate a 'limit' argument for all fields that return lists of
-     * objects, including ones produced by links
-     *
-     * Allows to constrain the return size of lists of objects
-     *
-     * Returns the first n number of elements in the list
-     */
-    addLimitArgument: boolean;
-    /**
-     * If a schema is of type string and has format UUID, it will be translated
-     * into a GraphQL ID type. To allow for more customzation, this option allows
-     * users to specify other formats that should be interpreted as ID types.
-     */
-    idFormats?: string[];
-    /**
-     * Allows to define the root operation type (Query or Mutation type) of any
-     * OAS operation explicitly.
-     *
-     * OpenAPI-to-GraphQL will by default make all GET operations Query fields and all other
-     * operations into Mutation fields.
-     *
-     * The field is identifed first by the title of the OAS, then the path of the
-     * operation, and lastly the method of the operation.
-     */
-    selectQueryOrMutationField?: OasTitlePathMethodObject<GraphQLOperationType>;
-    /**
-     * Sets argument name for the payload of a mutation to 'requestBody'
-     */
-    genericPayloadArgName: boolean;
-    /**
-     * By default, field names are sanitized to conform with GraphQL conventions,
-     * i.e. types should be in PascalCase, fields should be in camelCase, and
-     * enum values should be in ALL_CAPS.
-     *
-     * This option will prevent OpenAPI-to-GraphQL from enforcing camelCase field names and
-     * PascalCase type names, only removing illegal characters and staying as true
-     * to the provided names in the OAS as possible.
-     */
-    simpleNames: boolean;
-    /**
-     * Experimental feature that will try to create more meaningful names from
-     * the operation path than the response object by leveraging common
-     * conventions.
-     *
-     * For example, given the operation 'GET /users/{userId}/car', OpenAPI-to-GraphQL will
-     * create a Query field 'userCar'. Note that because 'users' is followed by
-     * the parameter 'userId', it insinuates that this operation will get the car
-     * that belongs to a singular user. Hence, the name 'userCar' is more fitting
-     * than 'usersCar' so the pluralizing 's' is dropped.
-     *
-     * This option will also consider irregular plural forms.
-     */
-    singularNames: boolean;
-    /**
-     * Custom headers to send with every request made by a resolve function.
-     */
-    headers?: Headers | RequestHeadersFunction<TSource, TContext, TArgs>;
-    /**
-     * Custom query parameters to send with every reqeust by a resolve function.
-     */
-    qs?: {
-        [key: string]: string;
-    };
-    /**
-     * Allows to override or add options to the node's request object used to make
-     * calls to the API backend.
-     * e.g. Setup the web proxy to use.
-     */
-    requestOptions?: RequestOptions<TSource, TContext, TArgs>;
-    /**
-     * Allows to override or add options to the PubSub connect object used to make
-     * publish/subscribe to the API backend.
-     * e.g. Setup the web proxy to use.
-     */
-    connectOptions?: ConnectOptions;
-    /**
-     * Specifies the URL on which all paths will be based on.
-     * Overrides the server object in the OAS.
-     */
-    baseUrl?: string;
-    /**
-     * Allows to define custom resolvers for fields on the Query/Mutation root
-     * operation type.
-     *
-     * In other words, instead of resolving on an operation (REST call) defined in
-     * the OAS, the field will resolve on the custom resolver. Note that this will
-     * also affect the behavior of links.
-     *
-     * The field is identifed first by the title of the OAS, then the path of the
-     * operation, and lastly the method of the operation.
-     *
-     * Use cases include the resolution of complex relationships between types,
-     * implementing performance improvements like caching, or dealing with
-     * non-standard authentication requirements.
-     */
-    customResolvers?: OasTitlePathMethodObject<GraphQLFieldResolver<TSource, TContext, TArgs>>;
-    /**
-     * Allows to define custom resolvers and subscribe functions for fields on the
-     * Subscription root operation type.
-     *
-     * In other words, instead of resolving on an operation (REST call) defined in
-     * the OAS, the field will resolve on the custom resolver. Note that this will
-     * also affect the behavior of links.
-     *
-     * The field is identifed first by the title of the OAS, then the path of the
-     * operation, and lastly the method of the operation.
-     *
-     * Use cases include the resolution of complex relationships between types,
-     * implementing performance improvements like caching, or dealing with
-     * non-standard authentication requirements.
-     *
-     * Note: Subscription fields will only be generated if the
-     * createSubscriptionsFromCallbacks option is enabled.
-     */
-    customSubscriptionResolvers?: OasTitlePathMethodObject<{
-        subscribe: GraphQLFieldResolver<TSource, SubscriptionContext, TArgs>;
-        resolve: GraphQLFieldResolver<TSource, TContext, TArgs>;
-    }>;
-    /**
-     * Determines whether OpenAPI-to-GraphQL should create viewers that allow users to pass
-     * basic auth and API key credentials.
-     */
-    viewer: boolean;
-    /**
-     * JSON path to OAuth 2 token contained in GraphQL context. Tokens will per
-     * default be sent in "Authorization" header.
-     */
-    tokenJSONpath?: string;
-    /**
-     * Determines whether to send OAuth 2 token as query parameter instead of in
-     * header.
-     */
-    sendOAuthTokenInQuery: boolean;
-    /**
-     * The error extensions is part of the GraphQLErrors that will be returned if
-     * the query cannot be fulfilled. It provides information about the failed
-     * REST call(e.g. the method, path, status code, response
-     * headers, and response body). It can be useful for debugging but may
-     * unintentionally leak information.
-     *
-     * This option prevents the extensions from being created.
-     */
-    provideErrorExtensions: boolean;
-    /**
-     * Appends a small statement to the end of field description that clarifies
-     * the operation that the field will trigger.
-     *
-     * Will affect query and mutation fields as well as fields created from links
-     *
-     * In the form of: 'Equivalent to {title of OAS} {method in ALL_CAPS} {path}'
-     * Will forgo the title is only one OAS is provided
-     */
-    equivalentToMessages: boolean;
-    /**
-     * Custom fetch implementation
-     */
-    fetch: typeof import('@whatwg-node/fetch').fetch;
-    /**
-     * Middlewares for Resolver Factory
-     */
-    resolverMiddleware: ResolverMiddleware<TSource, TContext, TArgs>;
-    /**
-     * Includes HTTP Details to the result object
-     */
-    includeHttpDetails?: boolean;
-    pubsub: MeshPubSub;
-    logger: Logger;
-    /**
-     * Allow processing to continue if the swagger schema is missing a schema $ref.
-     */
-    allowUndefinedSchemaRefTags?: boolean;
-    /**
-     * Object type to use for missing swagger schemas refs default is object.
-     */
-    defaultUndefinedSchemaType?: 'string' | 'number' | 'object' | 'array' | 'boolean' | 'integer';
-};

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

@@ -1,71 +0,0 @@
-/**
- * Type definitions for the data created during preprocessing.
- */
-import { Operation, DataDefinition } from './operation';
-import { InternalOptions } from './options';
-import { SecuritySchemeObject, SchemaObject, Oas3 } from './oas3';
-export declare type ProcessedSecurityScheme = {
-    rawName: string;
-    def: SecuritySchemeObject;
-    /**
-     * Stores the names of the authentication credentials
-     * NOTE: Structure depends on the type of the protocol (basic, API key...)
-     * NOTE: Mainly used for the AnyAuth viewers
-     */
-    parameters: {
-        [key: string]: string;
-    };
-    /**
-     * JSON schema to create the viewer for this security scheme from.
-     */
-    schema: SchemaObject;
-    /**
-     * The OAS which this operation originated from
-     */
-    oas: Oas3;
-};
-export declare type PreprocessingData<TSource, TContext, TArgs> = {
-    /**
-     * List of operation objects
-     */
-    operations: {
-        [key: string]: Operation;
-    };
-    /**
-     * List of Operation objects
-     */
-    callbackOperations: {
-        [key: string]: Operation;
-    };
-    /**
-     * List of all the used object names to avoid collision
-     */
-    usedTypeNames: string[];
-    /**
-     * List of data definitions for JSON schemas already used.
-     */
-    defs: DataDefinition[];
-    /**
-     * The security definitions contained in the OAS. References are resolved.
-     *
-     * NOTE: Keys are sanitized
-     * NOTE: Does not contain OAuth 2.0-related security schemes
-     */
-    security: {
-        [key: string]: ProcessedSecurityScheme;
-    };
-    /**
-     * Mapping between sanitized strings and their original ones
-     */
-    saneMap: {
-        [key: string]: string;
-    };
-    /**
-     * Options passed to OpenAPI-to-GraphQL by the user
-     */
-    options: InternalOptions<TSource, TContext, TArgs>;
-    /**
-     * All of the provided OASs
-     */
-    oass: Oas3[];
-};

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

@@ -1,61 +0,0 @@
-import { PreprocessingData, ProcessedSecurityScheme } from './types/preprocessing_data';
-import { Logger } from '@graphql-mesh/types';
-export declare enum MitigationTypes {
-    /**
-     * Problems with the OAS
-     *
-     * Should be caught by the module oas-validator
-     */
-    INVALID_OAS = "INVALID_OAS",
-    UNNAMED_PARAMETER = "UNNAMED_PARAMETER",
-    AMBIGUOUS_UNION_MEMBERS = "AMBIGUOUS_UNION_MEMBERS",
-    CANNOT_GET_FIELD_TYPE = "CANNOT_GET_FIELD_TYPE",
-    COMBINE_SCHEMAS = "COMBINE_SCHEMAS",
-    DUPLICATE_FIELD_NAME = "DUPLICATE_FIELD_NAME",
-    DUPLICATE_LINK_KEY = "DUPLICATE_LINK_KEY",
-    INVALID_HTTP_METHOD = "INVALID_HTTP_METHOD",
-    INPUT_UNION = "INPUT_UNION",
-    MISSING_RESPONSE_SCHEMA = "MISSING_RESPONSE_SCHEMA",
-    MISSING_SCHEMA = "MISSING_SCHEMA",
-    MULTIPLE_RESPONSES = "MULTIPLE_RESPONSES",
-    NON_APPLICATION_JSON_SCHEMA = "NON_APPLICATION_JSON_SCHEMA",
-    OBJECT_MISSING_PROPERTIES = "OBJECT_MISSING_PROPERTIES",
-    UNKNOWN_TARGET_TYPE = "UNKNOWN_TARGET_TYPE",
-    UNRESOLVABLE_SCHEMA = "UNRESOLVABLE_SCHEMA",
-    UNSUPPORTED_HTTP_SECURITY_SCHEME = "UNSUPPORTED_HTTP_SECURITY_SCHEME",
-    UNSUPPORTED_JSON_SCHEMA_KEYWORD = "UNSUPPORTED_JSON_SCHEMA_KEYWORD",
-    CALLBACKS_MULTIPLE_OPERATION_OBJECTS = "CALLBACKS_MULTIPLE_OPERATION_OBJECTS",
-    AMBIGUOUS_LINK = "AMBIGUOUS_LINK",
-    LINK_NAME_COLLISION = "LINK_NAME_COLLISION",
-    UNRESOLVABLE_LINK = "UNRESOLVABLE_LINK",
-    DUPLICATE_OPERATIONID = "DUPLICATE_OPERATIONID",
-    DUPLICATE_SECURITY_SCHEME = "DUPLICATE_SECURITY_SCHEME",
-    MULTIPLE_OAS_SAME_TITLE = "MULTIPLE_OAS_SAME_TITLE",
-    CUSTOM_RESOLVER_UNKNOWN_OAS = "CUSTOM_RESOLVER_UNKNOWN_OAS",
-    CUSTOM_RESOLVER_UNKNOWN_PATH_METHOD = "CUSTOM_RESOLVER_UNKNOWN_PATH_METHOD",
-    LIMIT_ARGUMENT_NAME_COLLISION = "LIMIT_ARGUMENT_NAME_COLLISION",
-    OAUTH_SECURITY_SCHEME = "OAUTH_SECURITY_SCHEME"
-}
-export declare const mitigations: {
-    [mitigationType in MitigationTypes]: string;
-};
-/**
- * Utilities that are specific to OpenAPI-to-GraphQL
- */
-export declare function handleWarning<TSource, TContext, TArgs>({ mitigationType, message, mitigationAddendum, path, data, logger, }: {
-    mitigationType: MitigationTypes;
-    message: string;
-    mitigationAddendum?: string;
-    path?: string[];
-    data: PreprocessingData<TSource, TContext, TArgs>;
-    logger: Logger;
-}): void;
-export declare function sortObject<T>(o: T): T;
-/**
- * Finds the common property names between two objects
- */
-export declare function getCommonPropertyNames(object1: {
-    [key: string]: ProcessedSecurityScheme;
-}, object2: {
-    [key: string]: ProcessedSecurityScheme;
-}): (string | number)[];