@graphql-inspector/core 3.3.0 → 3.4.0

package/package.json

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

package/validate/alias-count.d.ts

@@ -0,0 +1,10 @@
+import { DepGraph } from 'dependency-graph';
+import type { DocumentNode, FragmentDefinitionNode, Source, FieldNode, InlineFragmentNode, OperationDefinitionNode, FragmentSpreadNode } from 'graphql';
+import { GraphQLError } from 'graphql';
+export declare function validateAliasCount({ source, doc, maxAliasCount, fragmentGraph, }: {
+    source: Source;
+    doc: DocumentNode;
+    maxAliasCount: number;
+    fragmentGraph: DepGraph<FragmentDefinitionNode>;
+}): GraphQLError | void;
+export declare function countAliases(node: FieldNode | FragmentDefinitionNode | InlineFragmentNode | OperationDefinitionNode | FragmentSpreadNode, getFragmentByName: (fragmentName: string) => FragmentDefinitionNode | undefined): number;

package/validate/complexity.d.ts

@@ -0,0 +1,16 @@
+import { DepGraph } from 'dependency-graph';
+import type { DocumentNode, FragmentDefinitionNode, Source, FieldNode, InlineFragmentNode, OperationDefinitionNode, FragmentSpreadNode } from 'graphql';
+import { GraphQLError } from 'graphql';
+export declare type CalculateOperationComplexityConfig = {
+    scalarCost: number;
+    objectCost: number;
+    depthCostFactor: number;
+};
+export declare function validateComplexity({ source, doc, maxComplexityScore, config, fragmentGraph, }: {
+    source: Source;
+    doc: DocumentNode;
+    maxComplexityScore: number;
+    config: CalculateOperationComplexityConfig;
+    fragmentGraph: DepGraph<FragmentDefinitionNode>;
+}): GraphQLError | void;
+export declare function calculateOperationComplexity(node: FieldNode | FragmentDefinitionNode | InlineFragmentNode | OperationDefinitionNode | FragmentSpreadNode, config: CalculateOperationComplexityConfig, getFragmentByName: (fragmentName: string) => FragmentDefinitionNode | undefined, depth?: number): number;

package/validate/directive-count.d.ts

@@ -0,0 +1,10 @@
+import { DepGraph } from 'dependency-graph';
+import type { DocumentNode, FragmentDefinitionNode, Source, FieldNode, InlineFragmentNode, OperationDefinitionNode, FragmentSpreadNode } from 'graphql';
+import { GraphQLError } from 'graphql';
+export declare function validateDirectiveCount({ source, doc, maxDirectiveCount, fragmentGraph, }: {
+    source: Source;
+    doc: DocumentNode;
+    maxDirectiveCount: number;
+    fragmentGraph: DepGraph<FragmentDefinitionNode>;
+}): GraphQLError | void;
+export declare function countDirectives(node: FieldNode | FragmentDefinitionNode | InlineFragmentNode | OperationDefinitionNode | FragmentSpreadNode, getFragmentByName: (fragmentName: string) => FragmentDefinitionNode | undefined): number;

package/validate/index.d.ts

@@ -26,9 +26,24 @@ export interface ValidateOptions {
      */
     apollo?: boolean;
     /**
-     * Fails when operation depth exceeds maximum depth
-     * @default false
+     * Fails when operation depth exceeds maximum depth (including the referenced fragments).
+     * @default Infinity
      */
     maxDepth?: number;
+    /**
+     * Fails when alias count exceeds maximum count (including the referenced fragments).
+     * @default Infinity
+     */
+    maxAliasCount?: number;
+    /**
+     * Fails when the directive count exceeds maximum count for a single operation (including the referenced fragments).
+     * @default Infinity
+     */
+    maxDirectiveCount?: number;
+    /**
+     * Fails when the token count exceeds maximum count for a single operation (including the referenced fragments).
+     * @default Infinity
+     */
+    maxTokenCount?: number;
 }
 export declare function validate(schema: GraphQLSchema, sources: Source[], options?: ValidateOptions): InvalidDocument[];

package/validate/query-depth.d.ts

@@ -1,5 +1,5 @@
 import { DepGraph } from 'dependency-graph';
-import { DocumentNode, GraphQLError, ASTNode, FragmentDefinitionNode, Source } from 'graphql';
+import { DocumentNode, GraphQLError, ASTNode, FragmentDefinitionNode, Source, FieldNode, InlineFragmentNode, OperationDefinitionNode, FragmentSpreadNode } from 'graphql';
 export declare function validateQueryDepth({ source, doc, maxDepth, fragmentGraph, }: {
     source: Source;
     doc: DocumentNode;
@@ -12,3 +12,4 @@ export declare function calculateDepth({ node, currentDepth, maxDepth, getFragme
     maxDepth?: number;
     getFragment: (fragmentName: string) => FragmentDefinitionNode;
 }): number | never;
+export declare function countDepth(node: FieldNode | FragmentDefinitionNode | InlineFragmentNode | OperationDefinitionNode | FragmentSpreadNode, parentDepth: number, getFragmentReference: (name: string) => FragmentDefinitionNode | undefined): number;

package/validate/token-count.d.ts

@@ -0,0 +1,12 @@
+import { DocumentNode, GraphQLError } from 'graphql';
+import type { Source } from 'graphql';
+export declare function calculateTokenCount(args: {
+    source: Source | string;
+    getReferencedFragmentSource: (fragmentName: string) => Source | string | undefined;
+}): number;
+export declare function validateTokenCount(args: {
+    source: Source;
+    document: DocumentNode;
+    getReferencedFragmentSource: (fragmentName: string) => Source | string | undefined;
+    maxTokenCount: number;
+}): GraphQLError | void;