@pothos/plugin-sub-graph/src/global-types.ts

A Pothos plugin for creating multiple variants or sub-selections of the same graph

import type {
  FieldNullability,
  FieldRequiredness,
  InputFieldMap,
  InputShapeFromTypeParam,
  InputType,
  InterfaceParam,
  RootName,
  SchemaTypes,
  TypeParam,
} from '@pothos/core';

import type { GraphQLNamedType } from 'graphql';
import type { PothosSubGraphPlugin } from '.';

declare global {
  export namespace PothosSchemaTypes {
    export interface BaseTypeOptions<Types extends SchemaTypes = SchemaTypes> {
      subGraphs?: Types['SubGraphs'][];
    }

    export interface BuildSchemaOptions<Types extends SchemaTypes> {
      subGraph?: Types['SubGraphs'] | Types['SubGraphs'][] | { all: Types['SubGraphs'][] };
    }

    export interface ObjectTypeOptions<Types extends SchemaTypes = SchemaTypes, Shape = unknown>
      extends BaseTypeOptions<Types> {
      defaultSubGraphsForFields?: Types['SubGraphs'][];
    }

    export interface RootTypeOptions<Types extends SchemaTypes, Type extends RootName>
      extends BaseTypeOptions<Types> {
      defaultSubGraphsForFields?: Types['SubGraphs'][];
    }

    export interface InterfaceTypeOptions<
      Types extends SchemaTypes = SchemaTypes,
      Shape = unknown,
      Interfaces extends InterfaceParam<Types>[] = InterfaceParam<Types>[],
    > extends BaseTypeOptions<Types> {
      defaultSubGraphsForFields?: Types['SubGraphs'][];
    }

    export interface FieldOptions<
      Types extends SchemaTypes = SchemaTypes,
      ParentShape = unknown,
      Type extends TypeParam<Types> = TypeParam<Types>,
      Nullable extends FieldNullability<Type> = FieldNullability<Type>,
      Args extends InputFieldMap = InputFieldMap,
      ResolveShape = unknown,
      ResolveReturnShape = unknown,
    > {
      subGraphs?: Types['SubGraphs'][];
    }

    export interface ArgFieldOptions<
      Types extends SchemaTypes = SchemaTypes,
      Type extends InputType<Types> | [InputType<Types>] = InputType<Types> | [InputType<Types>],
      Req extends FieldRequiredness<Type> = FieldRequiredness<Type>,
    > extends InputFieldOptions<Types, Type, Req> {
      subGraphs?: undefined extends InputShapeFromTypeParam<Types, Type, Req>
        ? Types['SubGraphs'][]
        : never;
    }

    export interface InputObjectFieldOptions<
      Types extends SchemaTypes = SchemaTypes,
      Type extends InputType<Types> | [InputType<Types>] = InputType<Types> | [InputType<Types>],
      Req extends FieldRequiredness<Type> = FieldRequiredness<Type>,
    > extends InputFieldOptions<Types, Type, Req> {
      subGraphs?: undefined extends InputShapeFromTypeParam<Types, Type, Req>
        ? Types['SubGraphs'][]
        : never;
    }

    export interface Plugins<Types extends SchemaTypes> {
      subGraph: PothosSubGraphPlugin<Types>;
    }

    export interface SchemaBuilderOptions<Types extends SchemaTypes> {
      subGraphs?: {
        defaultForTypes?: Types['SubGraphs'][];
        defaultForFields?: Types['SubGraphs'][];
        fieldsInheritFromTypes?: boolean;
        explicitlyIncludeType?: (
          type: GraphQLNamedType,
          subGraphs: Types['SubGraphs'][],
        ) => boolean;
      };
    }

    export interface UserSchemaTypes {
      SubGraphs: string;
    }

    export interface ExtendDefaultTypes<PartialTypes extends Partial<UserSchemaTypes>> {
      SubGraphs: PartialTypes['SubGraphs'] & string;
    }
  }
}