CIF-2659 - GraphQL Schema Checker Tool (#172)

* Add schema checker tool
* Update readme

Author: herzog31

README.md

@@ -127,6 +127,8 @@ This will build and deploy the GraphQl functions and web frontend. The CLI will
 
 To test the GraphQL endpoint directly open the GraphiQL to test some GraphQL queries. The URL for your GraphiQL instance is printed out by the AIO CLI during the deployment. Any other GraphQL client will work as well.
 
+Please also make sure your implementation is compatible with the queries CIF is using. You can use the GraphQL schema checker tool in the [schemas](schemas/README.md) folder.
+
 ## Developing a real 3rd-party integration
 
 This repository provides a reference implementation that can be used as a starting point to develop a real integration with a 3rd-party commerce system. In order to implement a real integration, one will have to:

package-lock.json

@@ -28,7 +28,9 @@
     },
     "devDependencies": {
         "@openwhisk/wskdebug": "1.3.0",
+        "axios": "^0.27.2",
         "chai": "4.3.5",
+        "chalk": "^4.1.2",
         "eslint": "7.32.0",
         "eslint-plugin-header": "3.1.1",
         "eslint-plugin-react": "7.28.0",

package.json

@@ -1,7 +1,18 @@
-# Pruned Schema Generation
+# CIF Schemas
 
-To define the scope of a third-party integrations, you can generate a minimal or pruned schema based on the full Adobe Commerce / Magento schema and the queries that are actually used by CIF.
+Make sure to run `npm install` in the root of the project before using any of the tools below.
 
-In this folder, you can find the queries and schemas used by the latest versions of the CIF Core Components and the CIF Add-on. Those are regularly updated. If you need to generate a schema based on older versions, please utilize the git history.
+## Pruned Schema Generation
 
-Make sure, you ran `npm install` in the root of the project. To generate a pruned schema, run `./generate.js` and follow the steps. Please use the generated schema as reference for your third-party integration.
+To define the scope of a third-party integration, you can generate a minimal or pruned schema based on the full Adobe Commerce / Magento schema and the queries that are actually used by CIF.
+
+In this folder, you can find the queries and schemas used by the latest versions of the CIF Core Components and the CIF Add-on. Those are regularly updated. Schemas of previous versions of the CIF Core Components are available in the git history and are tagged.
+
+To generate a pruned schema, run `./generate.js` and follow the steps. Please use the generated schema as reference for your third-party integration.
+
+## Compatibility Check
+
+The GraphQL schema checker tool allows you to test the schema of your implemented GraphQL endpoint for compatibility with CIF. This includes the CIF Core Components and the CIF Add-on.
+The tool will provide detailed information about possible incompatibilities.
+
+Please run `./check.js` and follow the steps provided.

schemas/README.md

@@ -4,9 +4,7 @@
             "queryType": {
                 "name": "Query"
             },
-            "mutationType": {
-                "name": "Mutation"
-            },
+            "mutationType": null,
             "subscriptionType": null,
             "types": [
                 {

schemas/addon-ui/cif-schema-addon-ui-2.3.5.pruned.json

@@ -4,9 +4,7 @@
             "queryType": {
                 "name": "Query"
             },
-            "mutationType": {
-                "name": "Mutation"
-            },
+            "mutationType": null,
             "subscriptionType": null,
             "types": [
                 {