Research
Security News
Malicious npm Package Targets Solana Developers and Hijacks Funds
A malicious npm package targets Solana developers, rerouting funds in 2% of transactions to a hardcoded address.
@anvilco/apollo-server-plugin-introspection-metadata
Advanced tools
A plugin for Apollo Server that allows for adding metadata to GraphQL Introspection Query responses.
A plugin for Apollo Server that allows for adding metadata to GraphQL Introspection Query responses.
Using npm:
npm install --save-prod @anvilco/apollo-server-plugin-introspection-metadata
Using yarn:
yarn add @anvilco/apollo-server-plugin-introspection-metadata
Consider the following example GraphQL SDL:
type MyType {
myField(
myArg: String
): String
}
type Query {
myQuery(
myArg: String
): String
}
type Mutation {
myMutation(
myArg: String
): String
}
interface MyInterface {
id: ID
}
enum MyEnum {
ONE
TWO
THREE
}
When instantiating ApolloServer
, pass the following options:
import { ApolloServer } = from 'apollo-server'
import IntrospectionMetadataPlugin from '@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 :)
const schemaMetadataByKind = {
// Metadata for things of the kind "OBJECT"
OBJECT: {
MyType: {
// Arbitrary metadata about the MyType Object
metadata: {
foo: "bar",
baz: "bop",
}
fields: {
myField: {
// Arbitrary metadata about the myField Field
metadata: {...}
args: {
myArg: {
// Arbitrary metadata about the myArg Argument
metadata: {...}
}
}
}
}
},
MyOtherType: {...},
Query: {
// Queries you've defined end up as Fields in the Queries Type, so this
// structure follows that pattern
fields: {
myQuery: {
// Arbitrary metadata about the myQuery Query
metadata: {...}
args: {
myArg: {
// Arbitrary metadata about the myArg Argument
metadata: {...}
}
}
}
}
},
Mutation: {
// Mutations you've defined end up as Fields in the Mutation Type, so
// this structure follows that pattern
fields: {
myMutation: {
// Arbitrary metadata about the myMutation Mutation
metadata: {...}
args: {
myArg: {
// Arbitrary metadata about the myArg Argument
metadata: {...}
}
}
}
}
},
...
},
// 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:
const apolloPlugins = [];
if (process.env.NODE_ENV === 'development') {
apolloPlugins.push(
IntrospectionMetadataPlugin({
schemaMetadata: schemaMetadataByKind
})
)
}
const apolloServer = new ApolloServer({
//...
introspection: true,
plugins: apolloPlugins,
//...
})
Output of the Intropection Query will the become something like this:
{
data: {
__schema: {
//...
types: [
{
kind: "OBJECT"
name: "MyType"
metadata: {
foo: "bar",
baz: "bop",
},
fields: [{
//...
name: "myField",
// myField metadata
metadata: {...}
args: [{
//...
name: "myArg",
// myField's myArg metadata
metadata: {...}
}]
}]
},
{
kind: "OBJECT"
name: "Query"
fields: [{
//...
name: "myQuery",
// myQuery metadata
metadata: {...}
args: [{
//...
name: "myArg",
// myQuery's myArg metadata
metadata: {...}
}]
}]
},
{
kind: "OBJECT"
name: "Mutation"
fields: [{
//...
name: "myMutation",
// myMutation metadata
metadata: {...}
args: [{
//...
name: "myArg",
// myMutation's myArg metadata
metadata: {...}
}]
}]
},
//...
]
}
}
}
generateApolloPlugin
(default
export)This is what you most likely came here for. See Javadoc in index.js for more details.
addMetadata
If you're not actually using Apollo Server, or want to augment an Introspection Query response from somewhere else with your metadata, then this function may be what you're looking for. See Javadoc in index.js
isIntrospectionQuery
A function that takes the Apollo context as an argument and returns a Boolean indicating whether it appears to be an Introspection Query or not. Useful if you're considering implementing your own testFn
to provide to the generateApolloPlugin
call.
REGEX_INTROSPECTION_QUERY
A Javascript RegEx that can be used to test a query string to determine if it's an Introspection Query or not.
Inspired from @cleartax/apollo-server-plugin-introspection-auth.
2.2.3
FAQs
A plugin for Apollo Server that allows for adding metadata to GraphQL Introspection Query responses.
The npm package @anvilco/apollo-server-plugin-introspection-metadata receives a total of 34,185 weekly downloads. As such, @anvilco/apollo-server-plugin-introspection-metadata popularity was classified as popular.
We found that @anvilco/apollo-server-plugin-introspection-metadata demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 6 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
A malicious npm package targets Solana developers, rerouting funds in 2% of transactions to a hardcoded address.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.