- Notifications
You must be signed in to change notification settings - Fork3
A library to query and manipulate GraphQL Introspection Query results in some useful ways.
License
anvilco/graphql-introspection-tools
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
A library to query and manipulate GraphQL Introspection Query results in some useful ways. What ways you ask?
How about:
- Digging through your Introspection Query Results for a specific Query, Mutation, Type, Field, Argument or Subscription.
- Removing a specific Query, Mutation, Type, Field/InputField, Argument or Subscription from your Introspection Query Results.
- Removing Queries, Mutations, Fields/InputFields or Arguments that refer to Type that does not exist in - or has been removed from - your Introspection Query Results.
Yay!
It's calledmicrofiber because it is heavily used to do the cleaning and manipulation inSpectaQL...itcleans thespectacles, get it?!
But, we also wanted to have a more intuitive, literal name so that people could find it. Hence it's also known as@anvilco/graphql-introspection-tools.
Repository sponsored byAnvil
Anvil provides easy APIs for all things paperwork.
- PDF filling API - fill out a PDF template with a web request and structured JSON data.
- PDF generation API - send markdown or HTML and Anvil will render it to a PDF.
- Etch e-sign with API - customizable, embeddable, e-signature platform with an API to control the signing process end-to-end.
- Anvil Workflows (w/ API) - Webforms + PDF + e-sign with a powerful no-code builder. Easily collect structured data, generate PDFs, and request signatures.
Learn more on ourAnvil developer page.
- Install
microfiber
npm install microfiber# ORyarn add microfiber- Clean your GraphQL Introspection Query Results
import{Microfiber}from'microfiber'constintrospectionQueryResults={...}constmicrofiber=newMicrofiber(introspectionQueryResults)// ...do some things to your schema with `microfiber`constcleanedIntrospectonQueryResults=microfiber.getResponse()// ...do something with your cleaned Introspection Query Results.
Most of the useful stuff in this library is done through creating a new Microfiber class instance with your Introspection Query Results, and querying or manipulating it via that instance. Here are most of the interesting bits to know about class behavior.
constintrospectionQueryResponse={...}// Here are the publicly supported options and their sane defaults:constoptions={// Some GraphQL implementations have non-standard Query, Mutation and/or Subscription// type names. This option will fix them if they're messed up in the Introspection Query// ResultsfixQueryAndMutationAndSubscriptionTypes:true,// Remove Types that are not referenced anywhere by anythingremoveUnusedTypes:true,// Remove things whose Types are not found due to being removedremoveFieldsWithMissingTypes:true,removeArgsWithMissingTypes:true,removeInputFieldsWithMissingTypes:true,removePossibleTypesOfMissingTypes:true,// Remove all the types and things that are unreferenced immediately?cleanupSchemaImmediately:true,}constmicrofiber=newMicrofiber(introspectionQueryResponse,options)
Clean up the schema by removing:
- Fields or Input Fields whose Type does not exist in the schema.
- Args whose Type does not exist in the schema.
- Possible Types in a Union that do not exist in the schema.
- Queries or Mutations whose return Type does not exist in the schema.
This method is usually called after altering the schema in any way so as to not leave any dangling/orphaned things around the schema.
microfiber.cleanSchema()
Get out the Introspection Query Result that you have manipulated with Microfiber as an Object.
constcleanedResponse=microfiber.getResponse()
Get all the Types from your schema as an Array of Objects. Supported options and their sane defaults are shown.
constallTypes=microfiber.getAllTypes({// Include reserved GraphQL types?includeReserved:false,// Include the Query type?includeQuery:false,// Include the Mutation type?includeMutation:false,// Include the Subscription type?includeSubscription:false,}={})
Get a specific Type from your schema. Supported params and their sane defaults are shown.
consttype=microfiber.getType({kind:'OBJECT', name})
Get all the Directives from your schema.
constdirectives=microfiber.getDirectives()
Get a specific Directive from your schema. Supported params and their sane defaults are shown.
constdirective=microfiber.getDirective({ name})
Get the Query Type from your schema.
constqueryType=microfiber.getQueryType()
Get a specific Query from your schema.
constquery=microfiber.getQuery({ name})
Get the Mutation Type from your schema.
constmutationType=microfiber.getMutationType()
Get a specific Mutation from your schema.
constmutation=microfiber.getMutation({ name})
Get the Subscription Type from your schema.
constsubscriptionType=microfiber.getSubscription()
Get a specific Subscription from your schema.
constsubscription=microfiber.getSubscription({ name})
Get a specific Field from your schema. Supported params and their sane defaults are shown.
constfield=microfiber.getField({typeKind:'OBJECT', typeName, fieldName})
Get a specific Field from an Interface in your schema. A convenience wrapper aroundgetField({ typeKind: 'INTERFACE', ...})
constinterfaceField=microfiber.getInterfaceField({ typeName, fieldName})
Get a specific EnumValue from your schema. A convenience wrapper aroundgetField({ typeKind: 'ENUM', ...})
constinputField=microfiber.getEnumValue({ typeName, fieldName})
Get a specific InputField from your schema. A convenience wrapper aroundgetField({ typeKind: 'INPUT_OBJECT', ...})
constinputField=microfiber.getInputField({ typeName, fieldName})
Get a specific Arg from your schema. Supported params and their sane defaults are shown.
constarg=microfiber.getArg({typeKind:'OBJECT', typeName, fieldName, argName})
Get a specific Arg from a specifig Directive in your schema. Supported params and their sane defaults are shown.
constdirectiveArg=microfiber.getDirectiveArg({ directiveName, argName})
Get a specific Directive from your schema. Supported params and their sane defaults are shown.
constdirectiveArg=microfiber.removeDirective({ name,// Clean up the schema afterwards? cleanup=true,})
Remove a Type from your schema, and optionally the references to that Type elsewhere in your schema. Supported params and their sane defaults are shown.
microfiber.removeType({kind:'OBJECT', name,// Clean up the schema afterwards?cleanup:true,// Remove occurances of this Type from other places?removeFieldsOfType:constructorOptions.removeFieldsWithMissingTypes,removeInputFieldsOfType:constructorOptions.removeInputFieldsWithMissingTypes,removePossibleTypesOfType:constructorOptions.removePossibleTypesOfMissingTypes,removeArgsOfType:constructorOptions.removeArgsWithMissingTypes,})
Remove a specific Field from a specific Type in your schema. Supported params and their sane defaults are shown.
microfiber.removeField({typeKind:'OBJECT', typeName, fieldName,// Clean up the schema afterwards?cleanup:true,})
Remove a specific Input Field from a specific Input Object in your schema. Supported params and their sane defaults are shown.
microfiber.removeInputField({ typeName, fieldName,// Clean up the schema afterwards?cleanup:true,})
Remove a specific Arg from a specific Field or Input Field in your schema. Supported params and their sane defaults are shown.
microfiber.removeArg({ typeKind, typeName, fieldName, argName,// Clean up the schema afterwards?cleanup:true,})
Remove a specifc Enum value from an Enum Type in your schema. Supported params are shown.
microfiber.removeEnumValue({// The name of the Enum Type name,// The Enum value you want to remove value,})
Remove a Possible Type from a specific Union Type in your schema. Supported params and sane defaults are shown.
microfiber.removePossibleType({// The name of the Union Type typeName,// The Kind of the possible Type you want to remove possibleTypeKind,// The name of the possible Type you want to remove possibleTypeName,// Clean up the schema afterwards?cleanup:true,})
Remove a specific Query from your schema. Supported params and their sane defaults are shown.
microfiber.removeQuery({ name,// Clean up the schema afterwards?cleanup:true,})
Remove a specific Mutation from your schema. Supported params and their sane defaults are shown.
microfiber.removeMutation({ name,// Clean up the schema afterwards?cleanup:true,})
Remove a specific Subscription from your schema. Supported params and their sane defaults are shown.
microfiber.removeSubscription({ name,// Clean up the schema afterwards?cleanup:true,})
There are some other exports from this library, not just theMicrofiber class.
An Object containing all the GraphQL Kind values you may encounter.
import{KINDS}from'microfiber'console.log(KINDS)// {// SCALAR: 'SCALAR',// OBJECT: 'OBJECT',// INTERFACE: 'INTERFACE',// UNION: 'UNION',// ENUM: 'ENUM',// INPUT_OBJECT: 'INPUT_OBJECT',// LIST: 'LIST',// NON_NULL: 'NON_NULL'// }
A function that compares 2 types and determines if they have the same Kind and Name.
import{typesAreSame}from'microfiber'consttypeA={kind:'OBJECT',name:'Foo'}consttypeB={kind:'OBJECT',name:'Bar'}typesAreSame(typeA,typeB)// falsetypesAreSame(typeA,typeA)// true
A function that digs through any Non-Null and List nesting and returns the underlying Type.
import{digUnderlyingType}from'microfiber'constnonNullableString={name:null,kind:'NON_NULL',ofType:{name:null,kind:'LIST',ofType:{name:'String',kind:'SCALAR',}}}digUnderlyingType(nonNullableString)// { name: 'String', kind: 'SCALAR' }
A function that returns a Boolean indicating whether a Type is special GraphQL reserved Type.
import{isReservedType}from'microfiber'constmyType={name:'Foo', ...}constreservedType={name:'__Foo', ...}isReservedType(myType)// falseisReservedType(reservedType)// true
About
A library to query and manipulate GraphQL Introspection Query results in some useful ways.
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Releases
Packages0
Uh oh!
There was an error while loading.Please reload this page.
Contributors4
Uh oh!
There was an error while loading.Please reload this page.