@graphql-markdown/diff 1.1.10 → 1.1.12

package/dist/index.d.ts

@@ -1,13 +1,49 @@
+/**
+ * Schema comparison module for GraphQL Markdown.
+ * Provides utilities to compare GraphQL schemas and detect changes.
+ * @module \@graphql-markdown/diff
+ */
 import { type Change } from "@graphql-inspector/core";
 import type { FunctionCheckSchemaChanges, GraphQLSchema } from "@graphql-markdown/types";
+/** File name for storing schema hash */
 export declare const SCHEMA_HASH_FILE: ".schema";
+/** File name for storing schema reference */
 export declare const SCHEMA_REF: "schema.graphql";
+/**
+ * Comparison methods used to determine if a schema has changed.
+ */
 export declare enum CompareMethod {
+    /** Compare schemas by diffing the content */
     DIFF = "SCHEMA-DIFF",
+    /** Compare schemas by comparing hash values */
     HASH = "SCHEMA-HASH",
+    /** Force regeneration regardless of changes */
     FORCE = "FORCE",
+    /** Skip comparison and assume no changes */
     NONE = "NONE"
 }
+/**
+ * Generates a SHA-256 hash for a GraphQL schema.
+ *
+ * @param schema - The GraphQL schema to generate a hash for
+ * @returns A SHA-256 hash string representing the schema
+ */
 export declare const getSchemaHash: (schema: GraphQLSchema) => string;
+/**
+ * Compares a new schema against an existing schema file and returns the differences.
+ *
+ * @param schemaNew - The new GraphQL schema to compare
+ * @param schemaOldLocation - File path to the old schema
+ * @returns A promise resolving to an array of schema changes
+ */
 export declare const getDiff: (schemaNew: GraphQLSchema, schemaOldLocation: string) => Promise<Change[]>;
+/**
+ * Checks if a schema has changed compared to a previous version.
+ * Uses either diff or hash-based comparison methods based on the method parameter.
+ *
+ * @param schema - The current GraphQL schema
+ * @param outputDir - Directory where schema or hash files will be saved
+ * @param method - Comparison method to use (defaults to DIFF)
+ * @returns A promise resolving to a boolean indicating whether the schema has changed
+ */
 export declare const checkSchemaChanges: FunctionCheckSchemaChanges;

package/dist/index.js

@@ -1,4 +1,9 @@
 "use strict";
+/**
+ * Schema comparison module for GraphQL Markdown.
+ * Provides utilities to compare GraphQL schemas and detect changes.
+ * @module \@graphql-markdown/diff
+ */
 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");
@@ -8,20 +13,42 @@ 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");
+/** File name for storing schema hash */
 exports.SCHEMA_HASH_FILE = ".schema";
+/** File name for storing schema reference */
 exports.SCHEMA_REF = "schema.graphql";
+/**
+ * Comparison methods used to determine if a schema has changed.
+ */
 var CompareMethod;
 (function (CompareMethod) {
+    /** Compare schemas by diffing the content */
     CompareMethod["DIFF"] = "SCHEMA-DIFF";
+    /** Compare schemas by comparing hash values */
     CompareMethod["HASH"] = "SCHEMA-HASH";
+    /** Force regeneration regardless of changes */
     CompareMethod["FORCE"] = "FORCE";
+    /** Skip comparison and assume no changes */
     CompareMethod["NONE"] = "NONE";
 })(CompareMethod || (exports.CompareMethod = CompareMethod = {}));
+/**
+ * Generates a SHA-256 hash for a GraphQL schema.
+ *
+ * @param schema - The GraphQL schema to generate a hash for
+ * @returns A SHA-256 hash string representing the schema
+ */
 const getSchemaHash = (schema) => {
     const printedSchema = (0, graphql_1.printSchema)(schema);
     return (0, node_crypto_1.createHash)("sha256").update(printedSchema).digest("hex");
 };
 exports.getSchemaHash = getSchemaHash;
+/**
+ * Compares a new schema against an existing schema file and returns the differences.
+ *
+ * @param schemaNew - The new GraphQL schema to compare
+ * @param schemaOldLocation - File path to the old schema
+ * @returns A promise resolving to an array of schema changes
+ */
 const getDiff = async (schemaNew, schemaOldLocation) => {
     const schemaOld = await (0, load_1.loadSchema)(schemaOldLocation, {
         loaders: [new graphql_file_loader_1.GraphQLFileLoader()],
@@ -29,6 +56,15 @@ const getDiff = async (schemaNew, schemaOldLocation) => {
     return (0, core_1.diff)(schemaOld, schemaNew);
 };
 exports.getDiff = getDiff;
+/**
+ * Checks if a schema has changed compared to a previous version.
+ * Uses either diff or hash-based comparison methods based on the method parameter.
+ *
+ * @param schema - The current GraphQL schema
+ * @param outputDir - Directory where schema or hash files will be saved
+ * @param method - Comparison method to use (defaults to DIFF)
+ * @returns A promise resolving to a boolean indicating whether the schema has changed
+ */
 const checkSchemaChanges = async (schema, outputDir, method = CompareMethod.DIFF) => {
     if (method.valueOf() === CompareMethod.DIFF.valueOf()) {
         const schemaRef = (0, node_path_1.join)(outputDir, exports.SCHEMA_REF);

package/package.json

@@ -5,7 +5,7 @@
   "bugs": {
     "url": "https://github.com/graphql-markdown/graphql-markdown/issues"
   },
-  "version": "1.1.10",
+  "version": "1.1.12",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -57,13 +57,13 @@
   },
   "dependencies": {
     "@graphql-inspector/core": "^6.1.0",
-    "@graphql-markdown/graphql": "^1.1.6",
-    "@graphql-markdown/utils": "^1.8.0",
+    "@graphql-markdown/graphql": "^1.1.8",
+    "@graphql-markdown/utils": "^1.9.0",
     "@graphql-tools/graphql-file-loader": "^8.0.1",
     "@graphql-tools/load": "^8.0.2"
   },
   "devDependencies": {
-    "@graphql-markdown/types": "^1.7.0"
+    "@graphql-markdown/types": "^1.8.0"
   },
   "resolutions": {
     "braces": "3.0.3"