@graphql-mesh/fusion-composition/typings/transforms/hoist-field.d.ts

Basic composition utility for Fusion spec

import { GraphQLDirective } from 'graphql';
import type { SubgraphTransform } from '../compose.js';
export interface CreateHoistFieldTransformOpts {
    mapping?: HoistFieldMappingObject[];
}
export interface HoistFieldMappingObject {
    /**
     * Type name that defines where field should be hoisted to
     */
    typeName: string;
    /**
     * Array of field names to reach the field to be hoisted
     */
    pathConfig: (string | HoistFieldTransformFieldPathConfigObject)[];
    /**
     * Name the hoisted field should have when hoisted to the type specified in typeName
     */
    newFieldName: string;
    alias?: string;
    /**
     * Defines if args in path are filtered (default = false)
     */
    filterArgsInPath?: boolean;
}
export interface HoistFieldTransformFieldPathConfigObject {
    fieldName: string;
    filterArgs?: string[];
}
export declare const hoistDirective: GraphQLDirective;
export declare function createHoistFieldTransform(opts: CreateHoistFieldTransformOpts): SubgraphTransform;