UNPKG

2.06 kBTypeScriptView Raw
1import type { GraphQLSchema } from '../type/schema';
2declare enum BreakingChangeType {
3 TYPE_REMOVED = 'TYPE_REMOVED',
4 TYPE_CHANGED_KIND = 'TYPE_CHANGED_KIND',
5 TYPE_REMOVED_FROM_UNION = 'TYPE_REMOVED_FROM_UNION',
6 VALUE_REMOVED_FROM_ENUM = 'VALUE_REMOVED_FROM_ENUM',
7 REQUIRED_INPUT_FIELD_ADDED = 'REQUIRED_INPUT_FIELD_ADDED',
8 IMPLEMENTED_INTERFACE_REMOVED = 'IMPLEMENTED_INTERFACE_REMOVED',
9 FIELD_REMOVED = 'FIELD_REMOVED',
10 FIELD_CHANGED_KIND = 'FIELD_CHANGED_KIND',
11 REQUIRED_ARG_ADDED = 'REQUIRED_ARG_ADDED',
12 ARG_REMOVED = 'ARG_REMOVED',
13 ARG_CHANGED_KIND = 'ARG_CHANGED_KIND',
14 DIRECTIVE_REMOVED = 'DIRECTIVE_REMOVED',
15 DIRECTIVE_ARG_REMOVED = 'DIRECTIVE_ARG_REMOVED',
16 REQUIRED_DIRECTIVE_ARG_ADDED = 'REQUIRED_DIRECTIVE_ARG_ADDED',
17 DIRECTIVE_REPEATABLE_REMOVED = 'DIRECTIVE_REPEATABLE_REMOVED',
18 DIRECTIVE_LOCATION_REMOVED = 'DIRECTIVE_LOCATION_REMOVED',
19}
20export { BreakingChangeType };
21declare enum DangerousChangeType {
22 VALUE_ADDED_TO_ENUM = 'VALUE_ADDED_TO_ENUM',
23 TYPE_ADDED_TO_UNION = 'TYPE_ADDED_TO_UNION',
24 OPTIONAL_INPUT_FIELD_ADDED = 'OPTIONAL_INPUT_FIELD_ADDED',
25 OPTIONAL_ARG_ADDED = 'OPTIONAL_ARG_ADDED',
26 IMPLEMENTED_INTERFACE_ADDED = 'IMPLEMENTED_INTERFACE_ADDED',
27 ARG_DEFAULT_VALUE_CHANGE = 'ARG_DEFAULT_VALUE_CHANGE',
28}
29export { DangerousChangeType };
30export interface BreakingChange {
31 type: BreakingChangeType;
32 description: string;
33}
34export interface DangerousChange {
35 type: DangerousChangeType;
36 description: string;
37}
38/**
39 * Given two schemas, returns an Array containing descriptions of all the types
40 * of breaking changes covered by the other functions down below.
41 */
42export declare function findBreakingChanges(
43 oldSchema: GraphQLSchema,
44 newSchema: GraphQLSchema,
45): Array<BreakingChange>;
46/**
47 * Given two schemas, returns an Array containing descriptions of all the types
48 * of potentially dangerous changes covered by the other functions down below.
49 */
50export declare function findDangerousChanges(
51 oldSchema: GraphQLSchema,
52 newSchema: GraphQLSchema,
53): Array<DangerousChange>;