@graphql-markdown/diff 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Grégory Heitz
+
+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/README.md

@@ -0,0 +1,4 @@
+# @graphql-markdown/diff
+
+[![Latest Version](https://img.shields.io/npm/v/@graphql-markdown/diff?style=flat-square)](https://www.npmjs.com/package/@graphql-markdown/diff)
+[![GitHub License](https://img.shields.io/github/license/graphql-markdown/graphql-markdown?style=flat-square)](https://raw.githubusercontent.com/graphql-markdown/graphql-markdown/main/LICENSE)

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@graphql-markdown/diff",
+  "homepage": "https://graphql-markdown.github.io",
+  "description": "GraphQL-Markdown diff package.",
+  "bugs": {
+    "url": "https://github.com/graphql-markdown/graphql-markdown/issues"
+  },
+  "version": "1.0.0",
+  "license": "MIT",
+  "main": "src/index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/graphql-markdown/graphql-markdown.git"
+  },
+  "author": {
+    "name": "Gregory Heitz"
+  },
+  "scripts": {
+    "prepack": "pinst --disable",
+    "postpack": "pinst --enable",
+    "test": "jest",
+    "stryker": "stryker run"
+  },
+  "dependencies": {
+    "@graphql-inspector/core": "^3.4.0",
+    "@graphql-markdown/utils": "^1.0.0",
+    "@graphql-tools/graphql-file-loader": "^7.5.5",
+    "@graphql-tools/load": "^7.7.7"
+  },
+  "directories": {
+    "test": "tests"
+  },
+  "engines": {
+    "node": ">=16.14"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/index.js

@@ -0,0 +1,67 @@
+const path = require("path");
+const crypto = require("crypto");
+
+const { loadSchema } = require("@graphql-tools/load");
+const { diff } = require("@graphql-inspector/core");
+const { GraphQLFileLoader } = require("@graphql-tools/graphql-file-loader");
+
+const { printSchema } = require("@graphql-markdown/utils").graphql;
+const {
+  fs: { fileExists, readFile, saveFile },
+} = require("@graphql-markdown/utils").helpers;
+
+const SCHEMA_HASH_FILE = ".schema";
+const SCHEMA_REF = "schema.graphql";
+const COMPARE_METHOD = {
+  DIFF: "SCHEMA-DIFF",
+  HASH: "SCHEMA-HASH",
+  FORCE: "FORCE",
+  NONE: "NONE",
+};
+
+function getSchemaHash(schema) {
+  const printedSchema = printSchema(schema, { commentDescriptions: true });
+  return crypto.createHash("sha256").update(printedSchema).digest("hex");
+}
+
+async function getDiff(schemaNew, schemaOldLocation) {
+  const schemaOld = await loadSchema(schemaOldLocation, {
+    loaders: [new GraphQLFileLoader()],
+  });
+  return diff(schemaOld, schemaNew);
+}
+
+async function checkSchemaChanges(
+  schema,
+  outputDir,
+  method = COMPARE_METHOD.DIFF,
+) {
+  if (method === COMPARE_METHOD.DIFF) {
+    const schemaRef = path.join(outputDir, SCHEMA_REF);
+    if (await fileExists(schemaRef)) {
+      const schemaDiff = await getDiff(schema, schemaRef);
+      return schemaDiff.length > 0;
+    }
+    const schemaPrint = printSchema(schema);
+    await saveFile(schemaRef, schemaPrint);
+  }
+
+  if (method === COMPARE_METHOD.HASH) {
+    const hashFile = path.join(outputDir, SCHEMA_HASH_FILE);
+    const hashSchema = getSchemaHash(schema);
+    if (await fileExists(hashFile)) {
+      const hash = await readFile(hashFile, { encoding: "utf8", flag: "r" });
+      return hashSchema !== hash;
+    }
+    await saveFile(hashFile, hashSchema);
+  }
+
+  return true;
+}
+
+module.exports = {
+  checkSchemaChanges,
+  COMPARE_METHOD,
+  SCHEMA_HASH_FILE,
+  SCHEMA_REF,
+};