@graphql-inspector/core 3.1.4 → 3.2.0

package/{dist/index.js → index.js}

@@ -129,7 +129,7 @@ function safeChangeForInputValue(oldType, newType) {
         return safeChangeForInputValue(oldType.ofType, newType.ofType);
     }
     if (graphql.isNonNullType(oldType)) {
-        const ofType = graphql.isNonNullType(newType) ? newType : newType;
+        const ofType = graphql.isNonNullType(newType) ? newType.ofType : newType;
         return safeChangeForInputValue(oldType.ofType, ofType);
     }
     return false;
@@ -703,7 +703,7 @@ function inputFieldRemoved(input, field) {
             reason: 'Removing an input field will cause existing queries that use this input field to error.',
         },
         type: exports.ChangeType.InputFieldRemoved,
-        message: `Input field '${field.name}' was removed from input object type '${input.name}'`,
+        message: `Input field '${field.name}' ${isDeprecated(field) ? '(deprecated) ' : ''}was removed from input object type '${input.name}'`,
         path: [input.name, field.name].join('.'),
     };
 }
@@ -1370,6 +1370,18 @@ const suppressRemovalOfDeprecatedField = ({ changes, oldSchema, }) => {
                 }
             }
         }
+        if (change.type === exports.ChangeType.InputFieldRemoved &&
+            change.criticality.level === exports.CriticalityLevel.Breaking &&
+            change.path) {
+            const [inputName, inputItem] = parsePath(change.path);
+            const type = oldSchema.getType(inputName);
+            if (graphql.isInputObjectType(type)) {
+                const item = type.getFields()[inputItem];
+                if (item && isDeprecated(item)) {
+                    return Object.assign(Object.assign({}, change), { criticality: Object.assign(Object.assign({}, change.criticality), { level: exports.CriticalityLevel.Dangerous }) });
+                }
+            }
+        }
         return change;
     });
 };

package/{dist/index.mjs → index.mjs}

@@ -123,7 +123,7 @@ function safeChangeForInputValue(oldType, newType) {
         return safeChangeForInputValue(oldType.ofType, newType.ofType);
     }
     if (isNonNullType(oldType)) {
-        const ofType = isNonNullType(newType) ? newType : newType;
+        const ofType = isNonNullType(newType) ? newType.ofType : newType;
         return safeChangeForInputValue(oldType.ofType, ofType);
     }
     return false;
@@ -699,7 +699,7 @@ function inputFieldRemoved(input, field) {
             reason: 'Removing an input field will cause existing queries that use this input field to error.',
         },
         type: ChangeType.InputFieldRemoved,
-        message: `Input field '${field.name}' was removed from input object type '${input.name}'`,
+        message: `Input field '${field.name}' ${isDeprecated(field) ? '(deprecated) ' : ''}was removed from input object type '${input.name}'`,
         path: [input.name, field.name].join('.'),
     };
 }
@@ -1366,6 +1366,18 @@ const suppressRemovalOfDeprecatedField = ({ changes, oldSchema, }) => {
                 }
             }
         }
+        if (change.type === ChangeType.InputFieldRemoved &&
+            change.criticality.level === CriticalityLevel.Breaking &&
+            change.path) {
+            const [inputName, inputItem] = parsePath(change.path);
+            const type = oldSchema.getType(inputName);
+            if (isInputObjectType(type)) {
+                const item = type.getFields()[inputItem];
+                if (item && isDeprecated(item)) {
+                    return Object.assign(Object.assign({}, change), { criticality: Object.assign(Object.assign({}, change.criticality), { level: CriticalityLevel.Dangerous }) });
+                }
+            }
+        }
         return change;
     });
 };

package/package.json

@@ -1,52 +1,46 @@
 {
   "name": "@graphql-inspector/core",
-  "version": "3.1.4",
+  "version": "3.2.0",
   "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 || ^16.0.0"
+  },
+  "dependencies": {
+    "dependency-graph": "0.11.0",
+    "object-inspect": "1.10.3",
+    "tslib": "^2.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "kamilkisiela/graphql-inspector",
+    "directory": "packages/core"
+  },
   "keywords": [
     "graphql",
     "graphql-inspector",
     "tools"
   ],
-  "sideEffects": false,
-  "main": "dist/index.js",
-  "module": "dist/index.mjs",
-  "exports": {
-    ".": {
-      "require": "./dist/index.js",
-      "import": "./dist/index.mjs"
-    },
-    "./*": {
-      "require": "./dist/*.js",
-      "import": "./dist/*.mjs"
-    }
-  },
-  "typings": "dist/index.d.ts",
-  "typescript": {
-    "definition": "dist/index.d.ts"
-  },
   "author": {
     "name": "Kamil Kisiela",
     "email": "kamil.kisiela@gmail.com",
     "url": "https://github.com/kamilkisiela"
   },
   "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "kamilkisiela/graphql-inspector",
-    "directory": "packages/core"
-  },
-  "peerDependencies": {
-    "graphql": "^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"
-  },
-  "dependencies": {
-    "dependency-graph": "0.11.0",
-    "object-inspect": "1.10.3",
-    "tslib": "^2.0.0"
-  },
-  "devDependencies": {
-    "@types/object-inspect": "1.8.0"
+  "main": "index.js",
+  "module": "index.mjs",
+  "typings": "index.d.ts",
+  "typescript": {
+    "definition": "index.d.ts"
   },
-  "scripts": {
-    "prepack": "bob prepack"
+  "exports": {
+    ".": {
+      "require": "./index.js",
+      "import": "./index.mjs"
+    },
+    "./*": {
+      "require": "./*.js",
+      "import": "./*.mjs"
+    }
   }
 }

package/utils/isDeprecated.d.ts

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

package/dist/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2018 Kamil Kisiela
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/dist/README.md

@@ -1,55 +0,0 @@
-# GraphQL Inspector
-
-[![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.
-
-## Features
-
-Major features:
-
-- **Compares schemas**
-- **Finds breaking or dangerous changes**
-- **Validates documents against a schema**
-- **Finds similar / duplicated types**
-- **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.
-
-## Installation
-
-```bash
-yarn add @graphql-inspector/core
-```
-
-## Examples
-
-```typescript
-import {
-  diff,
-  validate,
-  similar,
-  coverage,
-  Change,
-  InvalidDocument,
-  SimilarMap,
-  SchemaCoverage
-} from '@graphql-inspector/core'
-
-// diff
-const changes: Change[] = diff(schemaA, schemaB)
-// validate
-const invalid: InvalidDocument[] = validate(documentsGlob, schema)
-// similar
-const similar: SimilarMap = similar(schema, typename, threshold)
-// coverage
-const schemaCoverage: SchemaCoverage = coverage(schema, documents)
-// ...
-```
-
-## License
-
-[MIT](https://github.com/kamilkisiela/graphql-inspector/blob/master/LICENSE) © Kamil Kisiela

package/dist/package.json

@@ -1,46 +0,0 @@
-{
-  "name": "@graphql-inspector/core",
-  "version": "3.1.4",
-  "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 || ^16.0.0"
-  },
-  "dependencies": {
-    "dependency-graph": "0.11.0",
-    "object-inspect": "1.10.3",
-    "tslib": "^2.0.0"
-  },
-  "repository": {
-    "type": "git",
-    "url": "kamilkisiela/graphql-inspector",
-    "directory": "packages/core"
-  },
-  "keywords": [
-    "graphql",
-    "graphql-inspector",
-    "tools"
-  ],
-  "author": {
-    "name": "Kamil Kisiela",
-    "email": "kamil.kisiela@gmail.com",
-    "url": "https://github.com/kamilkisiela"
-  },
-  "license": "MIT",
-  "main": "index.js",
-  "module": "index.mjs",
-  "typings": "index.d.ts",
-  "typescript": {
-    "definition": "index.d.ts"
-  },
-  "exports": {
-    ".": {
-      "require": "./index.js",
-      "import": "./index.mjs"
-    },
-    "./*": {
-      "require": "./*.js",
-      "import": "./*.mjs"
-    }
-  }
-}

package/dist/utils/isDeprecated.d.ts

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

package/utils/testing.ts

@@ -1,11 +0,0 @@
-// import { findDangerousChanges } from 'graphql';
-
-import { Change } from '../src/diff/changes/change';
-
-export function findChangesByPath(changes: Change[], path: string) {
-  return changes.filter((c) => c.path === path);
-}
-
-export function findFirstChangeByPath(changes: Change[], path: string) {
-  return findChangesByPath(changes, path)[0];
-}