@graphql-inspector/core 4.1.1 → 4.2.0

package/cjs/validate/index.js

@@ -7,6 +7,7 @@ const document_js_1 = require("../ast/document.js");
 const apollo_js_1 = require("../utils/apollo.js");
 const graphql_js_1 = require("../utils/graphql.js");
 const alias_count_js_1 = require("./alias-count.js");
+const complexity_1 = require("./complexity");
 const directive_count_js_1 = require("./directive-count.js");
 const query_depth_js_1 = require("./query-depth.js");
 const token_count_js_1 = require("./token-count.js");
@@ -70,6 +71,22 @@ function validate(schema, sources, options) {
                 errors.push(depthError);
             }
         }
+        if (config.validateComplexityConfig) {
+            const complexityScoreError = (0, complexity_1.validateComplexity)({
+                source: doc.source,
+                doc: transformedDoc,
+                maxComplexityScore: config.validateComplexityConfig.maxComplexityScore,
+                config: {
+                    scalarCost: config.validateComplexityConfig.complexityScalarCost,
+                    objectCost: config.validateComplexityConfig.complexityObjectCost,
+                    depthCostFactor: config.validateComplexityConfig.complexityDepthCostFactor,
+                },
+                fragmentGraph: graph,
+            });
+            if (complexityScoreError) {
+                errors.push(complexityScoreError);
+            }
+        }
         if (config.maxAliasCount) {
             const aliasError = (0, alias_count_js_1.validateAliasCount)({
                 source: doc.source,

package/esm/validate/index.js

@@ -4,6 +4,7 @@ import { readDocument } from '../ast/document.js';
 import { transformDocumentWithApollo, transformSchemaWithApollo } from '../utils/apollo.js';
 import { findDeprecatedUsages } from '../utils/graphql.js';
 import { validateAliasCount } from './alias-count.js';
+import { validateComplexity } from './complexity';
 import { validateDirectiveCount } from './directive-count.js';
 import { validateQueryDepth } from './query-depth.js';
 import { validateTokenCount } from './token-count.js';
@@ -67,6 +68,22 @@ export function validate(schema, sources, options) {
                 errors.push(depthError);
             }
         }
+        if (config.validateComplexityConfig) {
+            const complexityScoreError = validateComplexity({
+                source: doc.source,
+                doc: transformedDoc,
+                maxComplexityScore: config.validateComplexityConfig.maxComplexityScore,
+                config: {
+                    scalarCost: config.validateComplexityConfig.complexityScalarCost,
+                    objectCost: config.validateComplexityConfig.complexityObjectCost,
+                    depthCostFactor: config.validateComplexityConfig.complexityDepthCostFactor,
+                },
+                fragmentGraph: graph,
+            });
+            if (complexityScoreError) {
+                errors.push(complexityScoreError);
+            }
+        }
         if (config.maxAliasCount) {
             const aliasError = validateAliasCount({
                 source: doc.source,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-inspector/core",
-  "version": "4.1.1",
+  "version": "4.2.0",
   "description": "Tooling for GraphQL. Compare GraphQL Schemas, check documents, find breaking changes, find similar types.",
   "sideEffects": false,
   "peerDependencies": {

package/typings/validate/complexity.d.cts

@@ -6,6 +6,12 @@ export type CalculateOperationComplexityConfig = {
     objectCost: number;
     depthCostFactor: number;
 };
+export type ValidateOperationComplexityConfig = {
+    maxComplexityScore: number;
+    complexityScalarCost: number;
+    complexityObjectCost: number;
+    complexityDepthCostFactor: number;
+};
 export declare function validateComplexity({ source, doc, maxComplexityScore, config, fragmentGraph, }: {
     source: Source;
     doc: DocumentNode;

package/typings/validate/complexity.d.ts

@@ -6,6 +6,12 @@ export type CalculateOperationComplexityConfig = {
     objectCost: number;
     depthCostFactor: number;
 };
+export type ValidateOperationComplexityConfig = {
+    maxComplexityScore: number;
+    complexityScalarCost: number;
+    complexityObjectCost: number;
+    complexityDepthCostFactor: number;
+};
 export declare function validateComplexity({ source, doc, maxComplexityScore, config, fragmentGraph, }: {
     source: Source;
     doc: DocumentNode;

package/typings/validate/index.d.cts

@@ -1,4 +1,5 @@
 import { GraphQLError, GraphQLSchema, Source } from 'graphql';
+import { ValidateOperationComplexityConfig } from './complexity';
 export interface InvalidDocument {
     source: Source;
     errors: GraphQLError[];
@@ -45,5 +46,10 @@ export interface ValidateOptions {
      * @default Infinity
      */
     maxTokenCount?: number;
+    /**
+     * Fails when complexity score exceeds maximum complexity score (including the referenced fragments).
+     * @default Infinity
+     */
+    validateComplexityConfig?: ValidateOperationComplexityConfig;
 }
 export declare function validate(schema: GraphQLSchema, sources: Source[], options?: ValidateOptions): InvalidDocument[];

package/typings/validate/index.d.ts

@@ -1,4 +1,5 @@
 import { GraphQLError, GraphQLSchema, Source } from 'graphql';
+import { ValidateOperationComplexityConfig } from './complexity';
 export interface InvalidDocument {
     source: Source;
     errors: GraphQLError[];
@@ -45,5 +46,10 @@ export interface ValidateOptions {
      * @default Infinity
      */
     maxTokenCount?: number;
+    /**
+     * Fails when complexity score exceeds maximum complexity score (including the referenced fragments).
+     * @default Infinity
+     */
+    validateComplexityConfig?: ValidateOperationComplexityConfig;
 }
 export declare function validate(schema: GraphQLSchema, sources: Source[], options?: ValidateOptions): InvalidDocument[];