BreakingChangesFinder
in package
Utility for finding breaking/dangerous changes between two schemas.
Tags
Table of Contents
- BREAKING_CHANGE_ARG_CHANGED_KIND = 'ARG_CHANGED_KIND'
- BREAKING_CHANGE_ARG_REMOVED = 'ARG_REMOVED'
- BREAKING_CHANGE_DIRECTIVE_ARG_REMOVED = 'DIRECTIVE_ARG_REMOVED'
- BREAKING_CHANGE_DIRECTIVE_LOCATION_REMOVED = 'DIRECTIVE_LOCATION_REMOVED'
- BREAKING_CHANGE_DIRECTIVE_REMOVED = 'DIRECTIVE_REMOVED'
- BREAKING_CHANGE_FIELD_CHANGED_KIND = 'FIELD_CHANGED_KIND'
- BREAKING_CHANGE_FIELD_REMOVED = 'FIELD_REMOVED'
- BREAKING_CHANGE_IMPLEMENTED_INTERFACE_REMOVED = 'IMPLEMENTED_INTERFACE_REMOVED'
- BREAKING_CHANGE_REQUIRED_ARG_ADDED = 'REQUIRED_ARG_ADDED'
- BREAKING_CHANGE_REQUIRED_DIRECTIVE_ARG_ADDED = 'REQUIRED_DIRECTIVE_ARG_ADDED'
- BREAKING_CHANGE_REQUIRED_INPUT_FIELD_ADDED = 'REQUIRED_INPUT_FIELD_ADDED'
- BREAKING_CHANGE_TYPE_CHANGED_KIND = 'TYPE_CHANGED_KIND'
- BREAKING_CHANGE_TYPE_REMOVED = 'TYPE_REMOVED'
- BREAKING_CHANGE_TYPE_REMOVED_FROM_UNION = 'TYPE_REMOVED_FROM_UNION'
- BREAKING_CHANGE_VALUE_REMOVED_FROM_ENUM = 'VALUE_REMOVED_FROM_ENUM'
- DANGEROUS_CHANGE_ARG_DEFAULT_VALUE_CHANGED = 'ARG_DEFAULT_VALUE_CHANGE'
- DANGEROUS_CHANGE_IMPLEMENTED_INTERFACE_ADDED = 'IMPLEMENTED_INTERFACE_ADDED'
- DANGEROUS_CHANGE_OPTIONAL_ARG_ADDED = 'OPTIONAL_ARG_ADDED'
- DANGEROUS_CHANGE_OPTIONAL_INPUT_FIELD_ADDED = 'OPTIONAL_INPUT_FIELD_ADDED'
- DANGEROUS_CHANGE_TYPE_ADDED_TO_UNION = 'TYPE_ADDED_TO_UNION'
- DANGEROUS_CHANGE_VALUE_ADDED_TO_ENUM = 'VALUE_ADDED_TO_ENUM'
- findAddedArgsForDirective() : array<int, Argument>
- findAddedNonNullDirectiveArgs() : array<int, Change>
- findArgChanges() : Changes
- Given two schemas, returns an Array containing descriptions of any breaking or dangerous changes in the newSchema related to arguments (such as removal or change of type of an argument, or a change in an argument's default value).
- findBreakingChanges() : array<int, Change>
- Given two schemas, returns an Array containing descriptions of all the types of breaking changes covered by the other functions down below.
- findDangerousChanges() : array<int, Change>
- Given two schemas, returns an Array containing descriptions of all the types of potentially dangerous changes covered by the other functions down below.
- findFieldsThatChangedTypeOnInputObjectTypes() : Changes
- findFieldsThatChangedTypeOnObjectOrInterfaceTypes() : array<int, Change>
- findInterfacesAddedToObjectTypes() : array<int, Change>
- findInterfacesRemovedFromObjectTypes() : array<int, Change>
- findRemovedArgsForDirectives() : array<int, Argument>
- findRemovedDirectiveArgs() : array<int, Change>
- findRemovedDirectiveLocations() : array<int, Change>
- findRemovedDirectives() : array<int, Change>
- findRemovedLocationsForDirective() : array<int, string>
- findRemovedTypes() : array<int, Change>
- Given two schemas, returns an Array containing descriptions of any breaking changes in the newSchema related to removing an entire type.
- findTypesAddedToUnions() : array<int, Change>
- Given two schemas, returns an Array containing descriptions of any dangerous changes in the newSchema related to adding types to a union type.
- findTypesRemovedFromUnions() : array<int, Change>
- Given two schemas, returns an Array containing descriptions of any breaking changes in the newSchema related to removing types from a union type.
- findTypesThatChangedKind() : array<int, Change>
- Given two schemas, returns an Array containing descriptions of any breaking changes in the newSchema related to changing the type of a type.
- findValuesAddedToEnums() : array<int, Change>
- Given two schemas, returns an Array containing descriptions of any dangerous changes in the newSchema related to adding values to an enum type.
- findValuesRemovedFromEnums() : array<int, Change>
- Given two schemas, returns an Array containing descriptions of any breaking changes in the newSchema related to removing values from an enum type.
- getArgumentMapForDirective() : array<string, Argument>
- getDirectiveMapForSchema() : array<string, Directive>
- isChangeSafeForInputObjectFieldOrFieldArg() : bool
- isChangeSafeForObjectOrInterfaceField() : bool
- typeKindName() : string
Constants
BREAKING_CHANGE_ARG_CHANGED_KIND
public
mixed
BREAKING_CHANGE_ARG_CHANGED_KIND
= 'ARG_CHANGED_KIND'
BREAKING_CHANGE_ARG_REMOVED
public
mixed
BREAKING_CHANGE_ARG_REMOVED
= 'ARG_REMOVED'
BREAKING_CHANGE_DIRECTIVE_ARG_REMOVED
public
mixed
BREAKING_CHANGE_DIRECTIVE_ARG_REMOVED
= 'DIRECTIVE_ARG_REMOVED'
BREAKING_CHANGE_DIRECTIVE_LOCATION_REMOVED
public
mixed
BREAKING_CHANGE_DIRECTIVE_LOCATION_REMOVED
= 'DIRECTIVE_LOCATION_REMOVED'
BREAKING_CHANGE_DIRECTIVE_REMOVED
public
mixed
BREAKING_CHANGE_DIRECTIVE_REMOVED
= 'DIRECTIVE_REMOVED'
BREAKING_CHANGE_FIELD_CHANGED_KIND
public
mixed
BREAKING_CHANGE_FIELD_CHANGED_KIND
= 'FIELD_CHANGED_KIND'
BREAKING_CHANGE_FIELD_REMOVED
public
mixed
BREAKING_CHANGE_FIELD_REMOVED
= 'FIELD_REMOVED'
BREAKING_CHANGE_IMPLEMENTED_INTERFACE_REMOVED
public
mixed
BREAKING_CHANGE_IMPLEMENTED_INTERFACE_REMOVED
= 'IMPLEMENTED_INTERFACE_REMOVED'
BREAKING_CHANGE_REQUIRED_ARG_ADDED
public
mixed
BREAKING_CHANGE_REQUIRED_ARG_ADDED
= 'REQUIRED_ARG_ADDED'
BREAKING_CHANGE_REQUIRED_DIRECTIVE_ARG_ADDED
public
mixed
BREAKING_CHANGE_REQUIRED_DIRECTIVE_ARG_ADDED
= 'REQUIRED_DIRECTIVE_ARG_ADDED'
BREAKING_CHANGE_REQUIRED_INPUT_FIELD_ADDED
public
mixed
BREAKING_CHANGE_REQUIRED_INPUT_FIELD_ADDED
= 'REQUIRED_INPUT_FIELD_ADDED'
BREAKING_CHANGE_TYPE_CHANGED_KIND
public
mixed
BREAKING_CHANGE_TYPE_CHANGED_KIND
= 'TYPE_CHANGED_KIND'
BREAKING_CHANGE_TYPE_REMOVED
public
mixed
BREAKING_CHANGE_TYPE_REMOVED
= 'TYPE_REMOVED'
BREAKING_CHANGE_TYPE_REMOVED_FROM_UNION
public
mixed
BREAKING_CHANGE_TYPE_REMOVED_FROM_UNION
= 'TYPE_REMOVED_FROM_UNION'
BREAKING_CHANGE_VALUE_REMOVED_FROM_ENUM
public
mixed
BREAKING_CHANGE_VALUE_REMOVED_FROM_ENUM
= 'VALUE_REMOVED_FROM_ENUM'
DANGEROUS_CHANGE_ARG_DEFAULT_VALUE_CHANGED
public
mixed
DANGEROUS_CHANGE_ARG_DEFAULT_VALUE_CHANGED
= 'ARG_DEFAULT_VALUE_CHANGE'
DANGEROUS_CHANGE_IMPLEMENTED_INTERFACE_ADDED
public
mixed
DANGEROUS_CHANGE_IMPLEMENTED_INTERFACE_ADDED
= 'IMPLEMENTED_INTERFACE_ADDED'
DANGEROUS_CHANGE_OPTIONAL_ARG_ADDED
public
mixed
DANGEROUS_CHANGE_OPTIONAL_ARG_ADDED
= 'OPTIONAL_ARG_ADDED'
DANGEROUS_CHANGE_OPTIONAL_INPUT_FIELD_ADDED
public
mixed
DANGEROUS_CHANGE_OPTIONAL_INPUT_FIELD_ADDED
= 'OPTIONAL_INPUT_FIELD_ADDED'
DANGEROUS_CHANGE_TYPE_ADDED_TO_UNION
public
mixed
DANGEROUS_CHANGE_TYPE_ADDED_TO_UNION
= 'TYPE_ADDED_TO_UNION'
DANGEROUS_CHANGE_VALUE_ADDED_TO_ENUM
public
mixed
DANGEROUS_CHANGE_VALUE_ADDED_TO_ENUM
= 'VALUE_ADDED_TO_ENUM'
Methods
findAddedArgsForDirective()
public
static findAddedArgsForDirective(Directive $oldDirective, Directive $newDirective) : array<int, Argument>
Parameters
Return values
array<int, Argument> —findAddedNonNullDirectiveArgs()
public
static findAddedNonNullDirectiveArgs(Schema $oldSchema, Schema $newSchema) : array<int, Change>
Parameters
Tags
Return values
array<int, Change> —findArgChanges()
Given two schemas, returns an Array containing descriptions of any breaking or dangerous changes in the newSchema related to arguments (such as removal or change of type of an argument, or a change in an argument's default value).
public
static findArgChanges(Schema $oldSchema, Schema $newSchema) : Changes
Parameters
Tags
Return values
Changes —findBreakingChanges()
Given two schemas, returns an Array containing descriptions of all the types of breaking changes covered by the other functions down below.
public
static findBreakingChanges(Schema $oldSchema, Schema $newSchema) : array<int, Change>
Parameters
Tags
Return values
array<int, Change> —findDangerousChanges()
Given two schemas, returns an Array containing descriptions of all the types of potentially dangerous changes covered by the other functions down below.
public
static findDangerousChanges(Schema $oldSchema, Schema $newSchema) : array<int, Change>
Parameters
Tags
Return values
array<int, Change> —findFieldsThatChangedTypeOnInputObjectTypes()
public
static findFieldsThatChangedTypeOnInputObjectTypes(Schema $oldSchema, Schema $newSchema) : Changes
Parameters
Tags
Return values
Changes —findFieldsThatChangedTypeOnObjectOrInterfaceTypes()
public
static findFieldsThatChangedTypeOnObjectOrInterfaceTypes(Schema $oldSchema, Schema $newSchema) : array<int, Change>
Parameters
Tags
Return values
array<int, Change> —findInterfacesAddedToObjectTypes()
public
static findInterfacesAddedToObjectTypes(Schema $oldSchema, Schema $newSchema) : array<int, Change>
Parameters
Tags
Return values
array<int, Change> —findInterfacesRemovedFromObjectTypes()
public
static findInterfacesRemovedFromObjectTypes(Schema $oldSchema, Schema $newSchema) : array<int, Change>
Parameters
Tags
Return values
array<int, Change> —findRemovedArgsForDirectives()
public
static findRemovedArgsForDirectives(Directive $oldDirective, Directive $newDirective) : array<int, Argument>
Parameters
Return values
array<int, Argument> —findRemovedDirectiveArgs()
public
static findRemovedDirectiveArgs(Schema $oldSchema, Schema $newSchema) : array<int, Change>
Parameters
Tags
Return values
array<int, Change> —findRemovedDirectiveLocations()
public
static findRemovedDirectiveLocations(Schema $oldSchema, Schema $newSchema) : array<int, Change>
Parameters
Tags
Return values
array<int, Change> —findRemovedDirectives()
public
static findRemovedDirectives(Schema $oldSchema, Schema $newSchema) : array<int, Change>
Parameters
Tags
Return values
array<int, Change> —findRemovedLocationsForDirective()
public
static findRemovedLocationsForDirective(Directive $oldDirective, Directive $newDirective) : array<int, string>
Parameters
Return values
array<int, string> —findRemovedTypes()
Given two schemas, returns an Array containing descriptions of any breaking changes in the newSchema related to removing an entire type.
public
static findRemovedTypes(Schema $oldSchema, Schema $newSchema) : array<int, Change>
Parameters
Tags
Return values
array<int, Change> —findTypesAddedToUnions()
Given two schemas, returns an Array containing descriptions of any dangerous changes in the newSchema related to adding types to a union type.
public
static findTypesAddedToUnions(Schema $oldSchema, Schema $newSchema) : array<int, Change>
Parameters
Tags
Return values
array<int, Change> —findTypesRemovedFromUnions()
Given two schemas, returns an Array containing descriptions of any breaking changes in the newSchema related to removing types from a union type.
public
static findTypesRemovedFromUnions(Schema $oldSchema, Schema $newSchema) : array<int, Change>
Parameters
Tags
Return values
array<int, Change> —findTypesThatChangedKind()
Given two schemas, returns an Array containing descriptions of any breaking changes in the newSchema related to changing the type of a type.
public
static findTypesThatChangedKind(Schema $schemaA, Schema $schemaB) : array<int, Change>
Parameters
Tags
Return values
array<int, Change> —findValuesAddedToEnums()
Given two schemas, returns an Array containing descriptions of any dangerous changes in the newSchema related to adding values to an enum type.
public
static findValuesAddedToEnums(Schema $oldSchema, Schema $newSchema) : array<int, Change>
Parameters
Tags
Return values
array<int, Change> —findValuesRemovedFromEnums()
Given two schemas, returns an Array containing descriptions of any breaking changes in the newSchema related to removing values from an enum type.
public
static findValuesRemovedFromEnums(Schema $oldSchema, Schema $newSchema) : array<int, Change>
Parameters
Tags
Return values
array<int, Change> —getArgumentMapForDirective()
private
static getArgumentMapForDirective(Directive $directive) : array<string, Argument>
Parameters
- $directive : Directive
Return values
array<string, Argument> —getDirectiveMapForSchema()
private
static getDirectiveMapForSchema(Schema $schema) : array<string, Directive>
Parameters
- $schema : Schema
Tags
Return values
array<string, Directive> —isChangeSafeForInputObjectFieldOrFieldArg()
private
static isChangeSafeForInputObjectFieldOrFieldArg(Type $oldType, Type $newType) : bool
Parameters
Tags
Return values
bool —isChangeSafeForObjectOrInterfaceField()
private
static isChangeSafeForObjectOrInterfaceField(Type $oldType, Type $newType) : bool
Parameters
Return values
bool —typeKindName()
private
static typeKindName(Type|NamedType $type) : string