@benzene/core/dist/types.d.ts

Fast, minimal, agnostic GraphQL Libraries

import { DocumentNode, ExecutionArgs, ExecutionResult, GraphQLError, GraphQLFormattedError, GraphQLSchema, SubscriptionArgs, validate, ValidationRule } from "graphql";
import Benzene from "./core";
export interface Options<TContext, TExtra> {
    /**
     * The GraphQL schema
     * @see {@link https://graphql.org/graphql-js/type/#graphqlschema}
     */
    schema: GraphQLSchema;
    /**
     * An optional function to format errors according to the Response format of the spec.
     * Can also be used for logging errors.
     * @see {@link https://graphql.org/graphql-js/error/#formaterror}
     */
    formatErrorFn?: (error: GraphQLError) => GraphQLFormattedError;
    /**
     * An optional function to create an object used by all the resolvers of a specific GraphQL execution
     * @param ctx An object contains the "extra" variable supplied by downstream packages
     */
    contextFn?: ContextFn<TContext, TExtra>;
    /**
     * A optional function called for each DocumentNode to create an "compiled" object that allows
     * its execution and subscription.
     * @param schema GraphQL schema
     * @param document DocumentNode
     * @param operationName An optional operation name for multi-operation query
     * @returns {object} An object that has the functions `execute`, `subscribe`, and optionally `stringify`
     */
    compileQuery?: CompileQuery;
    /**
     * An optional function which will be used to validate instead of default `validate`
     * from `graphql-js`.
     * @see {@link https://graphql.org/graphql-js/validation/}
     */
    validateFn?: typeof validate;
    /**
     * An optional array of validation rules that will be used to validate the document
     */
    validationRules?: ValidationRule[];
}
/**
 * The parameters used to execute a GraphQL query
 */
export interface GraphQLParams {
    query?: Maybe<string>;
    variables?: Maybe<Record<string, any>>;
    operationName?: Maybe<string>;
    extensions?: Maybe<Record<string, any>>;
}
export declare type ContextFn<TContext, TExtra> = (contextInput: {
    extra: TExtra;
}) => ValueOrPromise<TContext>;
export declare type ValueOrPromise<T> = T | Promise<T>;
export declare type ExtractExtraType<Type> = Type extends Benzene<any, infer TExtra> ? TExtra : never;
export declare type CompileQuery = (schema: GraphQLSchema, document: DocumentNode, operationName?: Maybe<string>) => CompiledQuery | ExecutionResult;
export interface CompiledQuery {
    execute(args: Omit<ExecutionArgs, "schema">): ValueOrPromise<ExecutionResult>;
    subscribe(args: Omit<SubscriptionArgs, "schema">): Promise<AsyncIterableIterator<ExecutionResult> | ExecutionResult>;
    stringify?(result: ExecutionResult): string;
}
export interface CompiledResult extends CompiledQuery {
    operation: string;
    document: DocumentNode;
}
export declare type BenzeneGraphQLArgs<T> = Omit<T, "schema" | "document"> & {
    compiled?: CompiledResult;
    document?: DocumentNode;
};
export declare type Maybe<T> = null | undefined | T;