@graphql-markdown/diff 1.0.14 → 1.1.0

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+import { type Change } from "@graphql-inspector/core";
+import type { FunctionCheckSchemaChanges, GraphQLSchema } from "@graphql-markdown/types";
+export declare const SCHEMA_HASH_FILE: ".schema";
+export declare const SCHEMA_REF: "schema.graphql";
+export declare enum CompareMethod {
+    DIFF = "SCHEMA-DIFF",
+    HASH = "SCHEMA-HASH",
+    FORCE = "FORCE",
+    NONE = "NONE"
+}
+export declare const getSchemaHash: (schema: GraphQLSchema) => string;
+export declare const getDiff: (schemaNew: GraphQLSchema, schemaOldLocation: string) => Promise<Change[]>;
+export declare const checkSchemaChanges: FunctionCheckSchemaChanges;

package/dist/index.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkSchemaChanges = exports.getDiff = exports.getSchemaHash = exports.CompareMethod = exports.SCHEMA_REF = exports.SCHEMA_HASH_FILE = void 0;
+const node_path_1 = require("node:path");
+const node_crypto_1 = require("node:crypto");
+const load_1 = require("@graphql-tools/load");
+const core_1 = require("@graphql-inspector/core");
+const graphql_file_loader_1 = require("@graphql-tools/graphql-file-loader");
+const graphql_1 = require("@graphql-markdown/graphql");
+const utils_1 = require("@graphql-markdown/utils");
+exports.SCHEMA_HASH_FILE = ".schema";
+exports.SCHEMA_REF = "schema.graphql";
+var CompareMethod;
+(function (CompareMethod) {
+    CompareMethod["DIFF"] = "SCHEMA-DIFF";
+    CompareMethod["HASH"] = "SCHEMA-HASH";
+    CompareMethod["FORCE"] = "FORCE";
+    CompareMethod["NONE"] = "NONE";
+})(CompareMethod || (exports.CompareMethod = CompareMethod = {}));
+const getSchemaHash = (schema) => {
+    const printedSchema = (0, graphql_1.printSchema)(schema);
+    return (0, node_crypto_1.createHash)("sha256").update(printedSchema).digest("hex");
+};
+exports.getSchemaHash = getSchemaHash;
+const getDiff = async (schemaNew, schemaOldLocation) => {
+    const schemaOld = await (0, load_1.loadSchema)(schemaOldLocation, {
+        loaders: [new graphql_file_loader_1.GraphQLFileLoader()],
+    });
+    return (0, core_1.diff)(schemaOld, schemaNew);
+};
+exports.getDiff = getDiff;
+const checkSchemaChanges = async (schema, outputDir, method = CompareMethod.DIFF) => {
+    if (method === CompareMethod.DIFF) {
+        const schemaRef = (0, node_path_1.join)(outputDir, exports.SCHEMA_REF);
+        if (await (0, utils_1.fileExists)(schemaRef)) {
+            const schemaDiff = await (0, exports.getDiff)(schema, schemaRef);
+            return schemaDiff.length > 0;
+        }
+        const schemaPrint = (0, graphql_1.printSchema)(schema);
+        await (0, utils_1.saveFile)(schemaRef, schemaPrint);
+    }
+    if (method === CompareMethod.HASH) {
+        const hashFile = (0, node_path_1.join)(outputDir, exports.SCHEMA_HASH_FILE);
+        const hashSchema = (0, exports.getSchemaHash)(schema);
+        if (await (0, utils_1.fileExists)(hashFile)) {
+            const hash = await (0, utils_1.readFile)(hashFile, { encoding: "utf8", flag: "r" });
+            return hashSchema !== hash;
+        }
+        await (0, utils_1.saveFile)(hashFile, hashSchema);
+    }
+    return true;
+};
+exports.checkSchemaChanges = checkSchemaChanges;

package/package.json

@@ -5,28 +5,65 @@
   "bugs": {
     "url": "https://github.com/graphql-markdown/graphql-markdown/issues"
   },
-  "version": "1.0.14",
+  "version": "1.1.0",
   "license": "MIT",
-  "main": "src/index.js",
   "repository": {
     "type": "git",
-    "url": "https://github.com/graphql-markdown/graphql-markdown.git"
+    "url": "git+https://github.com/graphql-markdown/graphql-markdown.git",
+    "directory": "packages/diff"
   },
   "author": {
     "name": "Gregory Heitz"
   },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "default": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./*": {
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "default": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
   "scripts": {
     "prepack": "pinst --disable",
     "postpack": "pinst --enable",
-    "test": "jest",
-    "stryker": "stryker run"
+    "stryker": "stryker run",
+    "clean": "rm -rf ./dist"
   },
   "dependencies": {
     "@graphql-inspector/core": "^5.0.0",
-    "@graphql-markdown/utils": "^1.5.1",
+    "@graphql-markdown/graphql": "^1.0.0",
+    "@graphql-markdown/utils": "^1.6.0",
     "@graphql-tools/graphql-file-loader": "^8.0.0",
     "@graphql-tools/load": "^8.0.0"
   },
+  "devDependencies": {
+    "@graphql-markdown/types": "^1.0.0"
+  },
   "directories": {
     "test": "tests"
   },
@@ -34,6 +71,13 @@
     "node": ">=16.14"
   },
   "publishConfig": {
+    "directory": "dist",
     "access": "public"
-  }
+  },
+  "typescript": {
+    "definition": "dist/index.d.ts"
+  },
+  "files": [
+    "dist"
+  ]
 }

package/src/index.js

@@ -1,67 +0,0 @@
-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 {
-  fs: { fileExists, readFile, saveFile },
-  graphql: { printSchema },
-} = require("@graphql-markdown/utils");
-
-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,
-};