@graphql-inspector/core 3.0.2 → 3.1.2

package/README.md

@@ -36,17 +36,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/index.d.ts

@@ -1,4 +1,4 @@
-export { diff, DiffRule, Rule, CompletionArgs, CompletionHandler, UsageHandler } from './diff';
+export { diff, DiffRule, Rule, CompletionArgs, CompletionHandler, UsageHandler, } from './diff';
 export { validate, InvalidDocument } from './validate';
 export { similar, SimilarMap } from './similar';
 export * from './coverage';

package/index.js

@@ -78,6 +78,20 @@ function compareLists(oldList, newList, callbacks) {
     };
 }
 
+function isDeprecated(fieldOrEnumValue) {
+    var _a, _b;
+    if ('isDeprecated' in fieldOrEnumValue) {
+        return fieldOrEnumValue['isDeprecated'];
+    }
+    if (fieldOrEnumValue.deprecationReason != null) {
+        return true;
+    }
+    if ((_b = (_a = fieldOrEnumValue.astNode) === null || _a === void 0 ? void 0 : _a.directives) === null || _b === void 0 ? void 0 : _b.some((directive) => directive.name.value === 'deprecated')) {
+        return true;
+    }
+    return false;
+}
+
 function safeChangeForField(oldType, newType) {
     if (!graphql.isWrappingType(oldType) && !graphql.isWrappingType(newType)) {
         return oldType.toString() === newType.toString();
@@ -120,7 +134,7 @@ function getTypePrefix(type) {
         [graphql.Kind.ENUM_TYPE_DEFINITION]: 'enum',
         [graphql.Kind.INPUT_OBJECT_TYPE_DEFINITION]: 'input',
     };
-    return kindsMap[kind];
+    return kindsMap[kind.toString()];
 }
 function isPrimitive(type) {
     return (['String', 'Int', 'Float', 'Boolean', 'ID'].indexOf(typeof type === 'string' ? type : type.name) !== -1);
@@ -155,7 +169,7 @@ function findDeprecatedUsages(schema, ast) {
         },
         Field(node) {
             const fieldDef = typeInfo.getFieldDef();
-            if (fieldDef && fieldDef.isDeprecated) {
+            if (fieldDef && isDeprecated(fieldDef)) {
                 const parentType = typeInfo.getParentType();
                 if (parentType) {
                     const reason = fieldDef.deprecationReason;
@@ -165,7 +179,7 @@ function findDeprecatedUsages(schema, ast) {
         },
         EnumValue(node) {
             const enumVal = typeInfo.getEnumValue();
-            if (enumVal && enumVal.isDeprecated) {
+            if (enumVal && isDeprecated(enumVal)) {
                 const type = graphql.getNamedType(typeInfo.getInputType());
                 if (type) {
                     const reason = enumVal.deprecationReason;
@@ -476,7 +490,7 @@ function enumValueRemoved(oldEnum, value) {
             reason: `Removing an enum value will cause existing queries that use this enum value to error.`,
         },
         type: exports.ChangeType.EnumValueRemoved,
-        message: `Enum value '${value.name}' ${value.isDeprecated ? '(deprecated) ' : ''}was removed from enum '${oldEnum.name}'`,
+        message: `Enum value '${value.name}' ${isDeprecated(value) ? '(deprecated) ' : ''}was removed from enum '${oldEnum.name}'`,
         path: [oldEnum.name, value.name].join('.'),
     };
 }
@@ -559,7 +573,7 @@ function changesInEnum(oldEnum, newEnum, addChange) {
                     addChange(enumValueDeprecationReasonChanged(newEnum, oldValue, newValue));
                 }
             }
-        }
+        },
     });
 }
 
@@ -760,7 +774,7 @@ function fieldRemoved(type, field) {
                 : `Removing a field is a breaking change. It is preferable to deprecate the field before removing it.`,
         },
         type: exports.ChangeType.FieldRemoved,
-        message: `Field '${field.name}' ${field.isDeprecated ? '(deprecated) ' : ''}was removed from ${entity} '${type.name}'`,
+        message: `Field '${field.name}' ${isDeprecated(field) ? '(deprecated) ' : ''}was removed from ${entity} '${type.name}'`,
         path: [type.name, field.name].join('.'),
     };
 }
@@ -956,10 +970,7 @@ function wordLetterPairs(str) {
     return flattenDeep(pairs);
 }
 function safeString(obj) {
-    if (obj != null && typeof obj.toString === 'function') {
-        return `${obj}`;
-    }
-    return inspect(obj);
+    return inspect(obj).replace(/\[Object\: null prototype\] /g, '');
 }
 
 function fieldArgumentDescriptionChanged(type, field, oldArg, newArg) {
@@ -1036,8 +1047,8 @@ function changesInField(type, oldField, newField, addChange) {
             addChange(fieldDescriptionChanged(type, oldField, newField));
         }
     }
-    if (isNotEqual(oldField.isDeprecated, newField.isDeprecated)) {
-        if (newField.isDeprecated) {
+    if (isNotEqual(isDeprecated(oldField), isDeprecated(newField))) {
+        if (isDeprecated(newField)) {
             addChange(fieldDeprecationAdded(type, newField));
         }
         else {
@@ -1067,7 +1078,7 @@ function changesInField(type, oldField, newField, addChange) {
         },
         onMutual(arg) {
             changesInArgument(type, oldField, arg.oldVersion, arg.newVersion, addChange);
-        }
+        },
     });
 }
 
@@ -1259,7 +1270,7 @@ const suppressRemovalOfDeprecatedField = ({ changes, oldSchema, }) => {
             const type = oldSchema.getType(typeName);
             if (graphql.isObjectType(type) || graphql.isInterfaceType(type)) {
                 const field = type.getFields()[fieldName];
-                if (field.isDeprecated) {
+                if (isDeprecated(field)) {
                     return Object.assign(Object.assign({}, change), { criticality: Object.assign(Object.assign({}, change.criticality), { level: exports.CriticalityLevel.Dangerous }) });
                 }
             }
@@ -1271,7 +1282,7 @@ const suppressRemovalOfDeprecatedField = ({ changes, oldSchema, }) => {
             const type = oldSchema.getType(enumName);
             if (graphql.isEnumType(type)) {
                 const item = type.getValue(enumItem);
-                if (item && item.isDeprecated) {
+                if (item && isDeprecated(item)) {
                     return Object.assign(Object.assign({}, change), { criticality: Object.assign(Object.assign({}, change.criticality), { level: exports.CriticalityLevel.Dangerous }) });
                 }
             }
@@ -1513,7 +1524,7 @@ function validate(schema, sources, options) {
         .filter((doc) => doc.hasOperations)
         .forEach((doc) => {
         const docWithOperations = {
-            kind: 'Document',
+            kind: graphql.Kind.DOCUMENT,
             definitions: doc.operations.map((d) => d.node),
         };
         const extractedFragments = (extractFragments(graphql.print(docWithOperations)) || [])
@@ -1524,7 +1535,7 @@ function validate(schema, sources, options) {
             // remove duplicates
             .filter((def, i, all) => all.findIndex((item) => item.name.value === def.name.value) === i);
         const merged = {
-            kind: 'Document',
+            kind: graphql.Kind.DOCUMENT,
             definitions: [...docWithOperations.definitions, ...extractedFragments],
         };
         let transformedSchema = config.apollo

package/index.mjs

@@ -72,6 +72,20 @@ function compareLists(oldList, newList, callbacks) {
     };
 }
 
+function isDeprecated(fieldOrEnumValue) {
+    var _a, _b;
+    if ('isDeprecated' in fieldOrEnumValue) {
+        return fieldOrEnumValue['isDeprecated'];
+    }
+    if (fieldOrEnumValue.deprecationReason != null) {
+        return true;
+    }
+    if ((_b = (_a = fieldOrEnumValue.astNode) === null || _a === void 0 ? void 0 : _a.directives) === null || _b === void 0 ? void 0 : _b.some((directive) => directive.name.value === 'deprecated')) {
+        return true;
+    }
+    return false;
+}
+
 function safeChangeForField(oldType, newType) {
     if (!isWrappingType(oldType) && !isWrappingType(newType)) {
         return oldType.toString() === newType.toString();
@@ -114,7 +128,7 @@ function getTypePrefix(type) {
         [Kind.ENUM_TYPE_DEFINITION]: 'enum',
         [Kind.INPUT_OBJECT_TYPE_DEFINITION]: 'input',
     };
-    return kindsMap[kind];
+    return kindsMap[kind.toString()];
 }
 function isPrimitive(type) {
     return (['String', 'Int', 'Float', 'Boolean', 'ID'].indexOf(typeof type === 'string' ? type : type.name) !== -1);
@@ -149,7 +163,7 @@ function findDeprecatedUsages(schema, ast) {
         },
         Field(node) {
             const fieldDef = typeInfo.getFieldDef();
-            if (fieldDef && fieldDef.isDeprecated) {
+            if (fieldDef && isDeprecated(fieldDef)) {
                 const parentType = typeInfo.getParentType();
                 if (parentType) {
                     const reason = fieldDef.deprecationReason;
@@ -159,7 +173,7 @@ function findDeprecatedUsages(schema, ast) {
         },
         EnumValue(node) {
             const enumVal = typeInfo.getEnumValue();
-            if (enumVal && enumVal.isDeprecated) {
+            if (enumVal && isDeprecated(enumVal)) {
                 const type = getNamedType(typeInfo.getInputType());
                 if (type) {
                     const reason = enumVal.deprecationReason;
@@ -472,7 +486,7 @@ function enumValueRemoved(oldEnum, value) {
             reason: `Removing an enum value will cause existing queries that use this enum value to error.`,
         },
         type: ChangeType.EnumValueRemoved,
-        message: `Enum value '${value.name}' ${value.isDeprecated ? '(deprecated) ' : ''}was removed from enum '${oldEnum.name}'`,
+        message: `Enum value '${value.name}' ${isDeprecated(value) ? '(deprecated) ' : ''}was removed from enum '${oldEnum.name}'`,
         path: [oldEnum.name, value.name].join('.'),
     };
 }
@@ -555,7 +569,7 @@ function changesInEnum(oldEnum, newEnum, addChange) {
                     addChange(enumValueDeprecationReasonChanged(newEnum, oldValue, newValue));
                 }
             }
-        }
+        },
     });
 }
 
@@ -756,7 +770,7 @@ function fieldRemoved(type, field) {
                 : `Removing a field is a breaking change. It is preferable to deprecate the field before removing it.`,
         },
         type: ChangeType.FieldRemoved,
-        message: `Field '${field.name}' ${field.isDeprecated ? '(deprecated) ' : ''}was removed from ${entity} '${type.name}'`,
+        message: `Field '${field.name}' ${isDeprecated(field) ? '(deprecated) ' : ''}was removed from ${entity} '${type.name}'`,
         path: [type.name, field.name].join('.'),
     };
 }
@@ -952,10 +966,7 @@ function wordLetterPairs(str) {
     return flattenDeep(pairs);
 }
 function safeString(obj) {
-    if (obj != null && typeof obj.toString === 'function') {
-        return `${obj}`;
-    }
-    return inspect(obj);
+    return inspect(obj).replace(/\[Object\: null prototype\] /g, '');
 }
 
 function fieldArgumentDescriptionChanged(type, field, oldArg, newArg) {
@@ -1032,8 +1043,8 @@ function changesInField(type, oldField, newField, addChange) {
             addChange(fieldDescriptionChanged(type, oldField, newField));
         }
     }
-    if (isNotEqual(oldField.isDeprecated, newField.isDeprecated)) {
-        if (newField.isDeprecated) {
+    if (isNotEqual(isDeprecated(oldField), isDeprecated(newField))) {
+        if (isDeprecated(newField)) {
             addChange(fieldDeprecationAdded(type, newField));
         }
         else {
@@ -1063,7 +1074,7 @@ function changesInField(type, oldField, newField, addChange) {
         },
         onMutual(arg) {
             changesInArgument(type, oldField, arg.oldVersion, arg.newVersion, addChange);
-        }
+        },
     });
 }
 
@@ -1255,7 +1266,7 @@ const suppressRemovalOfDeprecatedField = ({ changes, oldSchema, }) => {
             const type = oldSchema.getType(typeName);
             if (isObjectType(type) || isInterfaceType(type)) {
                 const field = type.getFields()[fieldName];
-                if (field.isDeprecated) {
+                if (isDeprecated(field)) {
                     return Object.assign(Object.assign({}, change), { criticality: Object.assign(Object.assign({}, change.criticality), { level: CriticalityLevel.Dangerous }) });
                 }
             }
@@ -1267,7 +1278,7 @@ const suppressRemovalOfDeprecatedField = ({ changes, oldSchema, }) => {
             const type = oldSchema.getType(enumName);
             if (isEnumType(type)) {
                 const item = type.getValue(enumItem);
-                if (item && item.isDeprecated) {
+                if (item && isDeprecated(item)) {
                     return Object.assign(Object.assign({}, change), { criticality: Object.assign(Object.assign({}, change.criticality), { level: CriticalityLevel.Dangerous }) });
                 }
             }
@@ -1509,7 +1520,7 @@ function validate(schema, sources, options) {
         .filter((doc) => doc.hasOperations)
         .forEach((doc) => {
         const docWithOperations = {
-            kind: 'Document',
+            kind: Kind.DOCUMENT,
             definitions: doc.operations.map((d) => d.node),
         };
         const extractedFragments = (extractFragments(print(docWithOperations)) || [])
@@ -1520,7 +1531,7 @@ function validate(schema, sources, options) {
             // remove duplicates
             .filter((def, i, all) => all.findIndex((item) => item.name.value === def.name.value) === i);
         const merged = {
-            kind: 'Document',
+            kind: Kind.DOCUMENT,
             definitions: [...docWithOperations.definitions, ...extractedFragments],
         };
         let transformedSchema = config.apollo

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@graphql-inspector/core",
-  "version": "3.0.2",
+  "version": "3.1.2",
   "description": "Tooling for GraphQL. Compare GraphQL Schemas, check documents, find breaking changes, find similar types.",
   "sideEffects": false,
   "peerDependencies": {
-    "graphql": "^0.13.0 || ^14.0.0 || ^15.0.0"
+    "graphql": "^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "dependencies": {
     "dependency-graph": "0.11.0",

package/utils/compare.d.ts

@@ -2,8 +2,8 @@ export declare function keyMap<T>(list: readonly T[], keyFn: (item: T) => string
 export declare function isEqual<T>(a: T, b: T): boolean;
 export declare function isNotEqual<T>(a: T, b: T): boolean;
 export declare function isVoid<T>(a: T): boolean;
-export declare function diffArrays(a: string[], b: string[]): string[];
-export declare function unionArrays(a: string[], b: string[]): string[];
+export declare function diffArrays<T>(a: T[] | readonly T[], b: T[] | readonly T[]): T[];
+export declare function unionArrays<T>(a: T[] | readonly T[], b: T[] | readonly T[]): T[];
 export declare function compareLists<T extends {
     name: string;
 }>(oldList: readonly T[], newList: readonly T[], callbacks?: {

package/utils/isDeprecated.d.ts

@@ -0,0 +1,2 @@
+import { GraphQLEnumValue, GraphQLField } from 'graphql';
+export declare function isDeprecated(fieldOrEnumValue: GraphQLField<any, any> | GraphQLEnumValue): boolean;