inversify-graphql/interfaces.d.ts

Builds dependency-inverted GraphQL schemas with InversifyJS

import * as inv from 'inversify';
import * as gql from 'graphql';
import Maybe from 'graphql/tsutils/Maybe';
import { InversifyObjectTypeBuilder, InversifyObjectTypeBuilderBase } from './object-builder';
import { InversifyPartialMap } from './partial-map';
import { InversifyUnionTypeBuilder } from './union-builder';
import { PromiseOrValue } from 'graphql/jsutils/PromiseOrValue';
import { InversifyInterfaceTypeBuilder } from './interface-builder';
declare type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
export interface InversifySchemaConfig extends Omit<gql.GraphQLSchemaConfig, 'query' | 'mutation' | 'subscription'> {
    query?: gql.GraphQLObjectType | Maybe<inv.interfaces.Newable<InversifyObjectTypeBuilder<any, any>>>;
    mutation?: gql.GraphQLObjectType | Maybe<inv.interfaces.Newable<InversifyObjectTypeBuilder<any, any>>>;
    subscription?: gql.GraphQLObjectType | Maybe<inv.interfaces.Newable<InversifyObjectTypeBuilder<any, any>>>;
}
/**
 * Inversify equivalent of GraphQLFieldConfigMap
 */
export interface InversifyFieldConfigMap<TSource, TContext = any> {
    [key: string]: InversifyFieldConfig<TSource, TContext>;
}
export declare type InversifyInlineType<TContext> = InversifyObjectConfig<any, TContext>;
export declare type InversifyBuilder<TSource = any, TContext = any> = InversifyObjectTypeBuilder<any, TContext> | InversifyUnionTypeBuilder<any, TContext> | InversifyInterfaceTypeBuilder<any, TContext>;
/** Types allowed as inversified types */
export declare type InversifyType<TSource, TContext> = gql.GraphQLOutputType | InversifyInlineType<TContext> | inv.interfaces.Newable<InversifyBuilder<TSource, TContext>>;
export interface InversifyFieldConfig<TSource, TContext, TArgs = {
    [argName: string]: any;
}> extends Omit<gql.GraphQLFieldConfig<TSource, TContext, TArgs>, 'type'> {
    type: InversifyType<TSource, TContext>;
}
export declare type InversifyFieldList<TSource, TContext> = gql.Thunk<InversifyFieldConfigMap<TSource, TContext>> | inv.interfaces.Newable<InversifyPartialMap<TSource, TContext>>[];
export declare type InversifyUnionTypeList<TSource, TContext> = gql.Thunk<InversifyType<TSource, TContext>[]>;
export interface InversifyObjectConfig<TSource, TContext> extends Omit<gql.GraphQLObjectTypeConfig<TSource, TContext>, 'fields' | 'interfaces'> {
    /**
     * Fields can be either a map, or an array of partial map builder
     */
    interfaces?: InversifyUnionTypeList<TSource, TContext>;
    fields: InversifyFieldList<TSource, TContext>;
}
export interface InversifyUnionConfig<TSource, TContext> extends Omit<gql.GraphQLUnionTypeConfig<TSource, TContext>, 'types' | 'resolveType'> {
    types: InversifyUnionTypeList<TSource, TContext>;
    resolveType?: Maybe<InversifyTypeResolver<TSource, TContext>>;
}
export interface InversifyInterfaceConfig<TSource, TContext> extends Omit<gql.GraphQLInterfaceTypeConfig<TSource, TContext>, 'fields' | 'resolveType'> {
    fields: InversifyFieldList<TSource, TContext>;
    resolveType?: Maybe<InversifyTypeResolver<TSource, TContext>>;
}
export declare type InversifyTypeResolver<TSource, TContext, TArgs = {
    [key: string]: any;
}> = (value: TSource, context: TContext, info: gql.GraphQLResolveInfo) => PromiseOrValue<Maybe<InversifyType<TSource, TContext>>>;
export interface IInversifyExtensibleSchema<TContext = any> {
    /** The child container of this schema */
    readonly container: inv.Container;
    /** Enxtensible root query */
    readonly query: IInversifyExtensibleNode<void, TContext>;
    /** Enxtensible root mutation */
    readonly mutation: IInversifyExtensibleNode<void, TContext>;
    /** Enxtensible root subscription */
    readonly subscription: IInversifyExtensibleNode<void, TContext>;
    /** Get a type to extend by name */
    get<TSource = any>(typeToExtend: string | inv.interfaces.Newable<InversifyObjectTypeBuilderBase<TSource, TContext, any>>): IInversifyExtensibleNode<TSource, TContext>;
    /** Concatenate extensions */
    concat(...otherSchema: this[]): this;
    /** Add other orphan types */
    addTypes(...additionalTypes: gql.GraphQLNamedType[]): this;
    /** Build the generated schema */
    build(): gql.GraphQLSchema;
}
export interface IInversifyExtensibleNode<TSource = any, TContext = any> {
    /** Merge the given field list definitions in the current node */
    merge(...fields: inv.interfaces.Newable<InversifyPartialMap<TSource, TContext>>[]): this;
}
export {};