@graphql-inspector/core 0.0.0-canary.f71f99b → 0.0.0-canary.fec2df4

package/README.md

@@ -3,8 +3,9 @@
 [![CircleCI](https://circleci.com/gh/kamilkisiela/graphql-inspector.svg?style=shield&circle-token=d1cd06aba321ee2b7bf8bd2041104643639463b0)](https://circleci.com/gh/kamilkisiela/graphql-inspector)
 [![npm version](https://badge.fury.io/js/@graphql-inspector/core.svg)](https://npmjs.com/package/@graphql-inspector/core)
 
-**GraphQL Inspector** ouputs a list of changes between two GraphQL schemas. Every change is precisely explained and marked as breaking, non-breaking or dangerous.
-It helps you validate documents and fragments against a schema and even find similar or duplicated types.
+**GraphQL Inspector** ouputs a list of changes between two GraphQL schemas. Every change is precisely explained and
+marked as breaking, non-breaking or dangerous. It helps you validate documents and fragments against a schema and even
+find similar or duplicated types.
 
 ## Features
 
@@ -17,7 +18,8 @@ Major features:
 - **Schema coverage based on documents**
 - **Serves a GraphQL server with faked data and GraphQL Playground**
 
-GraphQL Inspector has a **CLI** and also a **programatic API**, so you can use it however you want to and even build tools on top of it.
+GraphQL Inspector has a **CLI** and also a **programatic API**, so you can use it however you want to and even build
+tools on top of it.
 
 ## Installation
 
@@ -36,17 +38,17 @@ import {
   Change,
   InvalidDocument,
   SimilarMap,
-  SchemaCoverage,
-} from '@graphql-inspector/core';
+  SchemaCoverage
+} from '@graphql-inspector/core'
 
 // diff
-const changes: Change[] = diff(schemaA, schemaB);
+const changes: Change[] = diff(schemaA, schemaB)
 // validate
-const invalid: InvalidDocument[] = validate(documentsGlob, schema);
+const invalid: InvalidDocument[] = validate(documentsGlob, schema)
 // similar
-const similar: SimilarMap = similar(schema, typename, threshold);
+const similar: SimilarMap = similar(schema, typename, threshold)
 // coverage
-const schemaCoverage: SchemaCoverage = coverage(schema, documents);
+const schemaCoverage: SchemaCoverage = coverage(schema, documents)
 // ...
 ```
 

package/ast/document.d.ts

@@ -1,15 +1,15 @@
-import {OperationDefinitionNode, FragmentDefinitionNode, Source} from 'graphql';
+import { OperationDefinitionNode, FragmentDefinitionNode, Source } from 'graphql';
 export interface Document {
-  source: Source;
-  fragments: {
-    node: FragmentDefinitionNode;
-    source: string;
-  }[];
-  operations: {
-    node: OperationDefinitionNode;
-    source: string;
-  }[];
-  hasFragments: boolean;
-  hasOperations: boolean;
+    source: Source;
+    fragments: {
+        node: FragmentDefinitionNode;
+        source: string;
+    }[];
+    operations: {
+        node: OperationDefinitionNode;
+        source: string;
+    }[];
+    hasFragments: boolean;
+    hasOperations: boolean;
 }
 export declare function readDocument(source: Source): Document;

package/coverage/index.d.ts

@@ -3,11 +3,20 @@ export interface Location {
     start: number;
     end: number;
 }
+export interface ArgumentCoverage {
+    hits: number;
+    locations: {
+        [name: string]: Array<Location>;
+    };
+}
 export interface TypeChildCoverage {
     hits: number;
     locations: {
         [name: string]: Array<Location>;
     };
+    children: {
+        [name: string]: ArgumentCoverage;
+    };
 }
 export interface TypeCoverage {
     hits: number;

package/coverage/output/json.d.ts

@@ -1,2 +1,2 @@
-import {SchemaCoverage} from '../index';
+import { SchemaCoverage } from '../index';
 export declare function outputJSON(coverage: SchemaCoverage): string;

package/diff/argument.d.ts

@@ -1,13 +1,3 @@
-import {
-  GraphQLArgument,
-  GraphQLObjectType,
-  GraphQLField,
-  GraphQLInterfaceType,
-} from 'graphql';
-import {Change} from './changes/change';
-export declare function changesInArgument(
-  type: GraphQLObjectType | GraphQLInterfaceType,
-  field: GraphQLField<any, any, any>,
-  oldArg: GraphQLArgument,
-  newArg: GraphQLArgument,
-): Change[];
+import { GraphQLArgument, GraphQLObjectType, GraphQLField, GraphQLInterfaceType } from 'graphql';
+import { AddChange } from './schema';
+export declare function changesInArgument(type: GraphQLObjectType | GraphQLInterfaceType, field: GraphQLField<any, any, any>, oldArg: GraphQLArgument, newArg: GraphQLArgument, addChange: AddChange): void;

package/diff/changes/argument.d.ts

@@ -1,25 +1,5 @@
-import {
-  GraphQLArgument,
-  GraphQLObjectType,
-  GraphQLField,
-  GraphQLInterfaceType,
-} from 'graphql';
-import {Change} from './change';
-export declare function fieldArgumentDescriptionChanged(
-  type: GraphQLObjectType | GraphQLInterfaceType,
-  field: GraphQLField<any, any, any>,
-  oldArg: GraphQLArgument,
-  newArg: GraphQLArgument,
-): Change;
-export declare function fieldArgumentDefaultChanged(
-  type: GraphQLObjectType | GraphQLInterfaceType,
-  field: GraphQLField<any, any, any>,
-  oldArg: GraphQLArgument,
-  newArg: GraphQLArgument,
-): Change;
-export declare function fieldArgumentTypeChanged(
-  type: GraphQLObjectType | GraphQLInterfaceType,
-  field: GraphQLField<any, any, any>,
-  oldArg: GraphQLArgument,
-  newArg: GraphQLArgument,
-): Change;
+import { GraphQLArgument, GraphQLObjectType, GraphQLField, GraphQLInterfaceType } from 'graphql';
+import { Change } from './change';
+export declare function fieldArgumentDescriptionChanged(type: GraphQLObjectType | GraphQLInterfaceType, field: GraphQLField<any, any, any>, oldArg: GraphQLArgument, newArg: GraphQLArgument): Change;
+export declare function fieldArgumentDefaultChanged(type: GraphQLObjectType | GraphQLInterfaceType, field: GraphQLField<any, any, any>, oldArg: GraphQLArgument, newArg: GraphQLArgument): Change;
+export declare function fieldArgumentTypeChanged(type: GraphQLObjectType | GraphQLInterfaceType, field: GraphQLField<any, any, any>, oldArg: GraphQLArgument, newArg: GraphQLArgument): Change;

package/diff/changes/change.d.ts

@@ -16,6 +16,8 @@ export declare enum ChangeType {
     EnumValueAdded = "ENUM_VALUE_ADDED",
     EnumValueDescriptionChanged = "ENUM_VALUE_DESCRIPTION_CHANGED",
     EnumValueDeprecationReasonChanged = "ENUM_VALUE_DEPRECATION_REASON_CHANGED",
+    EnumValueDeprecationReasonAdded = "ENUM_VALUE_DEPRECATION_REASON_ADDED",
+    EnumValueDeprecationReasonRemoved = "ENUM_VALUE_DEPRECATION_REASON_REMOVED",
     FieldRemoved = "FIELD_REMOVED",
     FieldAdded = "FIELD_ADDED",
     FieldDescriptionChanged = "FIELD_DESCRIPTION_CHANGED",

package/diff/changes/directive.d.ts

@@ -1,43 +1,12 @@
-import {
-  GraphQLDirective,
-  DirectiveLocationEnum,
-  GraphQLArgument,
-} from 'graphql';
-import {Change} from './change';
+import { GraphQLDirective, DirectiveLocationEnum, GraphQLArgument } from 'graphql';
+import { Change } from './change';
 export declare function directiveRemoved(directive: GraphQLDirective): Change;
 export declare function directiveAdded(directive: GraphQLDirective): Change;
-export declare function directiveDescriptionChanged(
-  oldDirective: GraphQLDirective,
-  newDirective: GraphQLDirective,
-): Change;
-export declare function directiveLocationAdded(
-  directive: GraphQLDirective,
-  location: DirectiveLocationEnum,
-): Change;
-export declare function directiveLocationRemoved(
-  directive: GraphQLDirective,
-  location: DirectiveLocationEnum,
-): Change;
-export declare function directiveArgumentAdded(
-  directive: GraphQLDirective,
-  arg: GraphQLArgument,
-): Change;
-export declare function directiveArgumentRemoved(
-  directive: GraphQLDirective,
-  arg: GraphQLArgument,
-): Change;
-export declare function directiveArgumentDescriptionChanged(
-  directive: GraphQLDirective,
-  oldArg: GraphQLArgument,
-  newArg: GraphQLArgument,
-): Change;
-export declare function directiveArgumentDefaultValueChanged(
-  directive: GraphQLDirective,
-  oldArg: GraphQLArgument,
-  newArg: GraphQLArgument,
-): Change;
-export declare function directiveArgumentTypeChanged(
-  directive: GraphQLDirective,
-  oldArg: GraphQLArgument,
-  newArg: GraphQLArgument,
-): Change;
+export declare function directiveDescriptionChanged(oldDirective: GraphQLDirective, newDirective: GraphQLDirective): Change;
+export declare function directiveLocationAdded(directive: GraphQLDirective, location: DirectiveLocationEnum): Change;
+export declare function directiveLocationRemoved(directive: GraphQLDirective, location: DirectiveLocationEnum): Change;
+export declare function directiveArgumentAdded(directive: GraphQLDirective, arg: GraphQLArgument): Change;
+export declare function directiveArgumentRemoved(directive: GraphQLDirective, arg: GraphQLArgument): Change;
+export declare function directiveArgumentDescriptionChanged(directive: GraphQLDirective, oldArg: GraphQLArgument, newArg: GraphQLArgument): Change;
+export declare function directiveArgumentDefaultValueChanged(directive: GraphQLDirective, oldArg: GraphQLArgument, newArg: GraphQLArgument): Change;
+export declare function directiveArgumentTypeChanged(directive: GraphQLDirective, oldArg: GraphQLArgument, newArg: GraphQLArgument): Change;

package/diff/changes/enum.d.ts

@@ -1,20 +1,8 @@
-import {GraphQLEnumType, GraphQLEnumValue} from 'graphql';
-import {Change} from './change';
-export declare function enumValueRemoved(
-  oldEnum: GraphQLEnumType,
-  value: GraphQLEnumValue,
-): Change;
-export declare function enumValueAdded(
-  newEnum: GraphQLEnumType,
-  value: GraphQLEnumValue,
-): Change;
-export declare function enumValueDescriptionChanged(
-  newEnum: GraphQLEnumType,
-  oldValue: GraphQLEnumValue,
-  newValue: GraphQLEnumValue,
-): Change;
-export declare function enumValueDeprecationReasonChanged(
-  newEnum: GraphQLEnumType,
-  oldValue: GraphQLEnumValue,
-  newValue: GraphQLEnumValue,
-): Change;
+import { GraphQLEnumType, GraphQLEnumValue } from 'graphql';
+import { Change } from './change';
+export declare function enumValueRemoved(oldEnum: GraphQLEnumType, value: GraphQLEnumValue): Change;
+export declare function enumValueAdded(newEnum: GraphQLEnumType, value: GraphQLEnumValue): Change;
+export declare function enumValueDescriptionChanged(newEnum: GraphQLEnumType, oldValue: GraphQLEnumValue, newValue: GraphQLEnumValue): Change;
+export declare function enumValueDeprecationReasonChanged(newEnum: GraphQLEnumType, oldValue: GraphQLEnumValue, newValue: GraphQLEnumValue): Change;
+export declare function enumValueDeprecationReasonAdded(newEnum: GraphQLEnumType, oldValue: GraphQLEnumValue, newValue: GraphQLEnumValue): Change;
+export declare function enumValueDeprecationReasonRemoved(newEnum: GraphQLEnumType, oldValue: GraphQLEnumValue, newValue: GraphQLEnumValue): Change;

package/diff/changes/field.d.ts

@@ -1,64 +1,15 @@
-import {
-  GraphQLObjectType,
-  GraphQLField,
-  GraphQLArgument,
-  GraphQLInterfaceType,
-} from 'graphql';
-import {Change} from './change';
-export declare function fieldRemoved(
-  type: GraphQLObjectType | GraphQLInterfaceType,
-  field: GraphQLField<any, any, any>,
-): Change;
-export declare function fieldAdded(
-  type: GraphQLObjectType | GraphQLInterfaceType,
-  field: GraphQLField<any, any, any>,
-): Change;
-export declare function fieldDescriptionChanged(
-  type: GraphQLObjectType | GraphQLInterfaceType,
-  oldField: GraphQLField<any, any>,
-  newField: GraphQLField<any, any>,
-): Change;
-export declare function fieldDescriptionAdded(
-  type: GraphQLObjectType | GraphQLInterfaceType,
-  field: GraphQLField<any, any>,
-): Change;
-export declare function fieldDescriptionRemoved(
-  type: GraphQLObjectType | GraphQLInterfaceType,
-  field: GraphQLField<any, any>,
-): Change;
-export declare function fieldDeprecationAdded(
-  type: GraphQLObjectType | GraphQLInterfaceType,
-  field: GraphQLField<any, any>,
-): Change;
-export declare function fieldDeprecationRemoved(
-  type: GraphQLObjectType | GraphQLInterfaceType,
-  field: GraphQLField<any, any>,
-): Change;
-export declare function fieldDeprecationReasonChanged(
-  type: GraphQLObjectType | GraphQLInterfaceType,
-  oldField: GraphQLField<any, any>,
-  newField: GraphQLField<any, any>,
-): Change;
-export declare function fieldDeprecationReasonAdded(
-  type: GraphQLObjectType | GraphQLInterfaceType,
-  field: GraphQLField<any, any>,
-): Change;
-export declare function fieldDeprecationReasonRemoved(
-  type: GraphQLObjectType | GraphQLInterfaceType,
-  field: GraphQLField<any, any>,
-): Change;
-export declare function fieldTypeChanged(
-  type: GraphQLObjectType | GraphQLInterfaceType,
-  oldField: GraphQLField<any, any, any>,
-  newField: GraphQLField<any, any, any>,
-): Change;
-export declare function fieldArgumentAdded(
-  type: GraphQLObjectType | GraphQLInterfaceType,
-  field: GraphQLField<any, any, any>,
-  arg: GraphQLArgument,
-): Change;
-export declare function fieldArgumentRemoved(
-  type: GraphQLObjectType | GraphQLInterfaceType,
-  field: GraphQLField<any, any, any>,
-  arg: GraphQLArgument,
-): Change;
+import { GraphQLObjectType, GraphQLField, GraphQLArgument, GraphQLInterfaceType } from 'graphql';
+import { Change } from './change';
+export declare function fieldRemoved(type: GraphQLObjectType | GraphQLInterfaceType, field: GraphQLField<any, any, any>): Change;
+export declare function fieldAdded(type: GraphQLObjectType | GraphQLInterfaceType, field: GraphQLField<any, any, any>): Change;
+export declare function fieldDescriptionChanged(type: GraphQLObjectType | GraphQLInterfaceType, oldField: GraphQLField<any, any>, newField: GraphQLField<any, any>): Change;
+export declare function fieldDescriptionAdded(type: GraphQLObjectType | GraphQLInterfaceType, field: GraphQLField<any, any>): Change;
+export declare function fieldDescriptionRemoved(type: GraphQLObjectType | GraphQLInterfaceType, field: GraphQLField<any, any>): Change;
+export declare function fieldDeprecationAdded(type: GraphQLObjectType | GraphQLInterfaceType, field: GraphQLField<any, any>): Change;
+export declare function fieldDeprecationRemoved(type: GraphQLObjectType | GraphQLInterfaceType, field: GraphQLField<any, any>): Change;
+export declare function fieldDeprecationReasonChanged(type: GraphQLObjectType | GraphQLInterfaceType, oldField: GraphQLField<any, any>, newField: GraphQLField<any, any>): Change;
+export declare function fieldDeprecationReasonAdded(type: GraphQLObjectType | GraphQLInterfaceType, field: GraphQLField<any, any>): Change;
+export declare function fieldDeprecationReasonRemoved(type: GraphQLObjectType | GraphQLInterfaceType, field: GraphQLField<any, any>): Change;
+export declare function fieldTypeChanged(type: GraphQLObjectType | GraphQLInterfaceType, oldField: GraphQLField<any, any, any>, newField: GraphQLField<any, any, any>): Change;
+export declare function fieldArgumentAdded(type: GraphQLObjectType | GraphQLInterfaceType, field: GraphQLField<any, any, any>, arg: GraphQLArgument): Change;
+export declare function fieldArgumentRemoved(type: GraphQLObjectType | GraphQLInterfaceType, field: GraphQLField<any, any, any>, arg: GraphQLArgument): Change;

package/diff/changes/input.d.ts

@@ -1,33 +1,9 @@
-import {GraphQLInputObjectType, GraphQLInputField} from 'graphql';
-import {Change} from './change';
-export declare function inputFieldRemoved(
-  input: GraphQLInputObjectType,
-  field: GraphQLInputField,
-): Change;
-export declare function inputFieldAdded(
-  input: GraphQLInputObjectType,
-  field: GraphQLInputField,
-): Change;
-export declare function inputFieldDescriptionAdded(
-  type: GraphQLInputObjectType,
-  field: GraphQLInputField,
-): Change;
-export declare function inputFieldDescriptionRemoved(
-  type: GraphQLInputObjectType,
-  field: GraphQLInputField,
-): Change;
-export declare function inputFieldDescriptionChanged(
-  input: GraphQLInputObjectType,
-  oldField: GraphQLInputField,
-  newField: GraphQLInputField,
-): Change;
-export declare function inputFieldDefaultValueChanged(
-  input: GraphQLInputObjectType,
-  oldField: GraphQLInputField,
-  newField: GraphQLInputField,
-): Change;
-export declare function inputFieldTypeChanged(
-  input: GraphQLInputObjectType,
-  oldField: GraphQLInputField,
-  newField: GraphQLInputField,
-): Change;
+import { GraphQLInputObjectType, GraphQLInputField } from 'graphql';
+import { Change } from './change';
+export declare function inputFieldRemoved(input: GraphQLInputObjectType, field: GraphQLInputField): Change;
+export declare function inputFieldAdded(input: GraphQLInputObjectType, field: GraphQLInputField): Change;
+export declare function inputFieldDescriptionAdded(type: GraphQLInputObjectType, field: GraphQLInputField): Change;
+export declare function inputFieldDescriptionRemoved(type: GraphQLInputObjectType, field: GraphQLInputField): Change;
+export declare function inputFieldDescriptionChanged(input: GraphQLInputObjectType, oldField: GraphQLInputField, newField: GraphQLInputField): Change;
+export declare function inputFieldDefaultValueChanged(input: GraphQLInputObjectType, oldField: GraphQLInputField, newField: GraphQLInputField): Change;
+export declare function inputFieldTypeChanged(input: GraphQLInputObjectType, oldField: GraphQLInputField, newField: GraphQLInputField): Change;

package/diff/changes/object.d.ts

@@ -1,10 +1,4 @@
-import {GraphQLInterfaceType, GraphQLObjectType} from 'graphql';
-import {Change} from './change';
-export declare function objectTypeInterfaceAdded(
-  iface: GraphQLInterfaceType,
-  type: GraphQLObjectType,
-): Change;
-export declare function objectTypeInterfaceRemoved(
-  iface: GraphQLInterfaceType,
-  type: GraphQLObjectType,
-): Change;
+import { GraphQLInterfaceType, GraphQLObjectType } from 'graphql';
+import { Change } from './change';
+export declare function objectTypeInterfaceAdded(iface: GraphQLInterfaceType, type: GraphQLObjectType): Change;
+export declare function objectTypeInterfaceRemoved(iface: GraphQLInterfaceType, type: GraphQLObjectType): Change;

package/diff/changes/schema.d.ts

@@ -1,14 +1,5 @@
-import {GraphQLSchema} from 'graphql';
-import {Change} from './change';
-export declare function schemaQueryTypeChanged(
-  oldSchema: GraphQLSchema,
-  newSchema: GraphQLSchema,
-): Change;
-export declare function schemaMutationTypeChanged(
-  oldSchema: GraphQLSchema,
-  newSchema: GraphQLSchema,
-): Change;
-export declare function schemaSubscriptionTypeChanged(
-  oldSchema: GraphQLSchema,
-  newSchema: GraphQLSchema,
-): Change;
+import { GraphQLSchema } from 'graphql';
+import { Change } from './change';
+export declare function schemaQueryTypeChanged(oldSchema: GraphQLSchema, newSchema: GraphQLSchema): Change;
+export declare function schemaMutationTypeChanged(oldSchema: GraphQLSchema, newSchema: GraphQLSchema): Change;
+export declare function schemaSubscriptionTypeChanged(oldSchema: GraphQLSchema, newSchema: GraphQLSchema): Change;

package/diff/changes/union.d.ts

@@ -1,10 +1,4 @@
-import {GraphQLUnionType, GraphQLObjectType} from 'graphql';
-import {Change} from './change';
-export declare function unionMemberRemoved(
-  union: GraphQLUnionType,
-  type: GraphQLObjectType,
-): Change;
-export declare function unionMemberAdded(
-  union: GraphQLUnionType,
-  type: GraphQLObjectType,
-): Change;
+import { GraphQLUnionType, GraphQLObjectType } from 'graphql';
+import { Change } from './change';
+export declare function unionMemberRemoved(union: GraphQLUnionType, type: GraphQLObjectType): Change;
+export declare function unionMemberAdded(union: GraphQLUnionType, type: GraphQLObjectType): Change;

package/diff/directive.d.ts

@@ -1,3 +1,3 @@
 import { GraphQLDirective } from 'graphql';
-import { Change } from './changes/change';
-export declare function changesInDirective(oldDirective: GraphQLDirective, newDirective: GraphQLDirective): Change[];
+import { AddChange } from './schema';
+export declare function changesInDirective(oldDirective: GraphQLDirective, newDirective: GraphQLDirective, addChange: AddChange): void;

package/diff/enum.d.ts

@@ -1,3 +1,3 @@
 import { GraphQLEnumType } from 'graphql';
-import { Change } from './changes/change';
-export declare function changesInEnum(oldEnum: GraphQLEnumType, newEnum: GraphQLEnumType): Change[];
+import { AddChange } from './schema';
+export declare function changesInEnum(oldEnum: GraphQLEnumType, newEnum: GraphQLEnumType, addChange: AddChange): void;

package/diff/field.d.ts

@@ -1,3 +1,3 @@
 import { GraphQLField, GraphQLObjectType, GraphQLInterfaceType } from 'graphql';
-import { Change } from './changes/change';
-export declare function changesInField(type: GraphQLObjectType | GraphQLInterfaceType, oldField: GraphQLField<any, any>, newField: GraphQLField<any, any>): Change[];
+import { AddChange } from './schema';
+export declare function changesInField(type: GraphQLObjectType | GraphQLInterfaceType, oldField: GraphQLField<any, any>, newField: GraphQLField<any, any>, addChange: AddChange): void;

package/diff/index.d.ts

@@ -1,12 +1,9 @@
-import {GraphQLSchema} from 'graphql';
-import {Change} from './changes/change';
-import {Rule} from './rules/types';
+import { GraphQLSchema } from 'graphql';
+import { Change } from './changes/change';
+import { Rule } from './rules/types';
 import * as rules from './rules';
 export * from './rules/types';
 export declare const DiffRule: typeof rules;
 export * from './onComplete/types';
-export declare function diff(
-  oldSchema: GraphQLSchema,
-  newSchema: GraphQLSchema,
-  rules?: Rule[],
-): Change[];
+export type { UsageHandler } from './rules/consider-usage';
+export declare function diff(oldSchema: GraphQLSchema, newSchema: GraphQLSchema, rules?: Rule[], config?: rules.ConsiderUsageConfig): Promise<Change[]>;

package/diff/input.d.ts

@@ -1,3 +1,3 @@
 import { GraphQLInputObjectType } from 'graphql';
-import { Change } from './changes/change';
-export declare function changesInInputObject(oldInput: GraphQLInputObjectType, newInput: GraphQLInputObjectType): Change[];
+import { AddChange } from './schema';
+export declare function changesInInputObject(oldInput: GraphQLInputObjectType, newInput: GraphQLInputObjectType, addChange: AddChange): void;

package/diff/interface.d.ts

@@ -1,3 +1,3 @@
 import { GraphQLInterfaceType } from 'graphql';
-import { Change } from './changes/change';
-export declare function changesInInterface(oldInterface: GraphQLInterfaceType, newInterface: GraphQLInterfaceType): Change[];
+import { AddChange } from './schema';
+export declare function changesInInterface(oldInterface: GraphQLInterfaceType, newInterface: GraphQLInterfaceType, addChange: AddChange): void;

package/diff/object.d.ts

@@ -1,3 +1,3 @@
 import { GraphQLObjectType } from 'graphql';
-import { Change } from './changes/change';
-export declare function changesInObject(oldType: GraphQLObjectType, newType: GraphQLObjectType): Change[];
+import { AddChange } from './schema';
+export declare function changesInObject(oldType: GraphQLObjectType, newType: GraphQLObjectType, addChange: AddChange): void;

package/diff/rules/config.d.ts

@@ -0,0 +1,2 @@
+import { ConsiderUsageConfig } from './consider-usage';
+export declare type Config = ConsiderUsageConfig;

package/diff/rules/consider-usage.d.ts

@@ -0,0 +1,29 @@
+import { Rule } from './types';
+export declare type UsageHandler = (input: Array<{
+    type: string;
+    field?: string;
+    argument?: string;
+}>) => Promise<boolean[]>;
+export interface ConsiderUsageConfig {
+    /**
+     * Checks if it's safe to introduce a breaking change on a field
+     *
+     * Because the function is async and resolves to a boolean value
+     * you can add pretty much anything here, many different conditions or
+     * even any source of data.
+     *
+     * In the CLI we use a GraphQL endpoint with a query
+     * that checks the usage and returns stats like:
+     * min/max count and min/max precentage
+     * So we know when to allow for a breaking change.
+     *
+     * Because it returns a boolean,
+     * we can't attach any data or even customize a message of an api change.
+     * This is the first iteration, we're going to improve it soon.
+     *
+     * true - NON_BREAKING
+     * false - BREAKING
+     */
+    checkUsage?: UsageHandler;
+}
+export declare const considerUsage: Rule<ConsiderUsageConfig>;

package/diff/rules/dangerous-breaking.d.ts

@@ -0,0 +1,2 @@
+import { Rule } from './types';
+export declare const dangerousBreaking: Rule;

package/diff/rules/index.d.ts

@@ -1,2 +1,5 @@
+export * from './dangerous-breaking';
 export * from './suppress-removal-of-deprecated-field';
 export * from './ignore-description-changes';
+export * from './consider-usage';
+export * from './safe-unreachable';

package/diff/rules/safe-unreachable.d.ts

@@ -0,0 +1,2 @@
+import { Rule } from './types';
+export declare const safeUnreachable: Rule;

package/diff/rules/types.d.ts

@@ -1,7 +1,8 @@
-import {GraphQLSchema} from 'graphql';
-import {Change} from '../changes/change';
-export declare type Rule = (input: {
-  changes: Change[];
-  oldSchema: GraphQLSchema;
-  newSchema: GraphQLSchema;
-}) => Change[];
+import { GraphQLSchema } from 'graphql';
+import { Change } from '../changes/change';
+export declare type Rule<TConfig = any> = (input: {
+    changes: Change[];
+    oldSchema: GraphQLSchema;
+    newSchema: GraphQLSchema;
+    config: TConfig;
+}) => Change[] | Promise<Change[]>;

package/diff/schema.d.ts

@@ -1,3 +1,4 @@
 import { GraphQLSchema } from 'graphql';
 import { Change } from './changes/change';
+export declare type AddChange = (change: Change) => void;
 export declare function diffSchema(oldSchema: GraphQLSchema, newSchema: GraphQLSchema): Change[];

package/diff/union.d.ts

@@ -1,3 +1,3 @@
 import { GraphQLUnionType } from 'graphql';
-import { Change } from './changes/change';
-export declare function changesInUnion(oldUnion: GraphQLUnionType, newUnion: GraphQLUnionType): Change[];
+import { AddChange } from './schema';
+export declare function changesInUnion(oldUnion: GraphQLUnionType, newUnion: GraphQLUnionType, addChange: AddChange): void;

package/index.d.ts

@@ -1,12 +1,12 @@
-export {diff, DiffRule, Rule, CompletionArgs, CompletionHandler} from './diff';
-export {validate, InvalidDocument} from './validate';
-export {similar, SimilarMap} from './similar';
+export { diff, DiffRule, Rule, CompletionArgs, CompletionHandler, UsageHandler } from './diff';
+export { validate, InvalidDocument } from './validate';
+export { similar, SimilarMap } from './similar';
 export * from './coverage';
-export {
-  Change,
-  CriticalityLevel,
-  Criticality,
-  ChangeType,
-} from './diff/changes/change';
-export {getTypePrefix} from './utils/graphql';
-export {Target, Rating, BestMatch} from './utils/string';
+export { Change, CriticalityLevel, Criticality, ChangeType } from './diff/changes/change';
+export { getTypePrefix } from './utils/graphql';
+export { Target, Rating, BestMatch } from './utils/string';
+export { countAliases } from './validate/alias-count';
+export { countDirectives } from './validate/directive-count';
+export { countDepth } from './validate/query-depth';
+export { calculateOperationComplexity, CalculateOperationComplexityConfig } from './validate/complexity';
+export { calculateTokenCount } from './validate/token-count';