Installation

npm install --save-prod @anvilco/apollo-server-plugin-introspection-metadata

yarn add @anvilco/apollo-server-plugin-introspection-metadata

Usage

typeMyType {myField(myArg:String  ):String}typeQuery {myQuery(myArg:String  ):String}typeMutation {myMutation(myArg:String  ):String}interfaceMyInterface {id:ID}enumMyEnum {  ONE  TWO  THREE}

import{ApolloServer}=from'apollo-server'importIntrospectionMetadataPluginfrom'@anvilco/apollo-server-plugin-introspection-metadata'// All keys are optional, all the way down the object.// Only build/include what you want to add metadata for :)constschemaMetadataByKind={// Metadata for things of the kind "OBJECT"OBJECT:{MyType:{// Arbitrary metadata about the MyType Objectmetadata:{foo:"bar",baz:"bop",}fields:{myField:{// Arbitrary metadata about the myField Fieldmetadata:{...}args:{myArg:{// Arbitrary metadata about the myArg Argumentmetadata:{...}}}}}},    MyOtherType:{...},Query:{// Queries you've defined end up as Fields in the Queries Type, so this// structure follows that patternfields:{myQuery:{// Arbitrary metadata about the myQuery Querymetadata:{...}args:{myArg:{// Arbitrary metadata about the myArg Argumentmetadata:{...}}}}}},Mutation:{// Mutations you've defined end up as Fields in the Mutation Type, so// this structure follows that patternfields:{myMutation:{// Arbitrary metadata about the myMutation Mutationmetadata:{...}args:{myArg:{// Arbitrary metadata about the myArg Argumentmetadata:{...}}}}}},    ...},// Metadata for things of the kind "INPUT_OBJECT"INPUT_OBJECT:{    ...},// Metadata for things of the kind "SCALAR"SCALAR:{    ...},// Metadata for things of the kind "ENUM"ENUM:{    ...},// Metadata for things of the kind "INTERFACE"INTERFACE:{    ...},}// If you want to only add this metadata in the Development// environment:constapolloPlugins=[];if(process.env.NODE_ENV==='development'){apolloPlugins.push(IntrospectionMetadataPlugin({schemaMetadata:schemaMetadataByKind}))}constapolloServer=newApolloServer({//...introspection:true,plugins:apolloPlugins,//...})

{data:{__schema:{//...types:[{kind:"OBJECT"name:"MyType"metadata:{foo:"bar",baz:"bop",},fields:[{//...name:"myField",// myField metadatametadata:{...}args:[{//...name:"myArg",// myField's myArg metadatametadata:{...}}]}]},{kind:"OBJECT"name:"Query"fields:[{//...name:"myQuery",// myQuery metadatametadata:{...}args:[{//...name:"myArg",// myQuery's myArg metadatametadata:{...}}]}]},{kind:"OBJECT"name:"Mutation"fields:[{//...name:"myMutation",// myMutation metadatametadata:{...}args:[{//...name:"myArg",// myMutation's myArg metadatametadata:{...}}]}]},//...]}}}

API

generateApolloPlugin (default export)

addMetadata

isIntrospectionQuery

REGEX_INTROSPECTION_QUERY

References