@graphql-inspector/validate-command 3.3.0 → 3.4.0

package/index.d.ts

@@ -2,7 +2,7 @@ import { GlobalArgs, CommandFactory } from '@graphql-inspector/commands';
 import { Source as DocumentSource } from '@graphql-tools/utils';
 import { GraphQLSchema } from 'graphql';
 export { CommandFactory };
-export declare function handler({ schema, documents, strictFragments, maxDepth, apollo, keepClientFields, failOnDeprecated, filter, onlyErrors, relativePaths, output, silent, }: {
+export declare function handler({ schema, documents, strictFragments, maxDepth, maxDirectiveCount, maxAliasCount, maxTokenCount, apollo, keepClientFields, failOnDeprecated, filter, onlyErrors, relativePaths, output, silent, }: {
     schema: GraphQLSchema;
     documents: DocumentSource[];
     failOnDeprecated: boolean;
@@ -10,6 +10,9 @@ export declare function handler({ schema, documents, strictFragments, maxDepth,
     apollo: boolean;
     keepClientFields: boolean;
     maxDepth?: number;
+    maxDirectiveCount?: number;
+    maxAliasCount?: number;
+    maxTokenCount?: number;
     filter?: string[];
     onlyErrors?: boolean;
     relativePaths?: boolean;
@@ -24,6 +27,9 @@ declare const _default: CommandFactory<{}, {
     apollo: boolean;
     keepClientFields: boolean;
     maxDepth?: number | undefined;
+    maxAliasCount?: number | undefined;
+    maxDirectiveCount?: number | undefined;
+    maxTokenCount?: number | undefined;
     filter?: string[] | undefined;
     onlyErrors?: boolean | undefined;
     relativePaths?: boolean | undefined;

package/index.js

@@ -10,10 +10,13 @@ const path = require('path');
 const fs = require('fs');
 const graphql = require('graphql');
 
-function handler({ schema, documents, strictFragments, maxDepth, apollo, keepClientFields, failOnDeprecated, filter, onlyErrors, relativePaths, output, silent, }) {
-    let invalidDocuments = core.validate(schema, documents.map((doc) => new graphql.Source(graphql.print(doc.document), doc.location)), {
+function handler({ schema, documents, strictFragments, maxDepth, maxDirectiveCount, maxAliasCount, maxTokenCount, apollo, keepClientFields, failOnDeprecated, filter, onlyErrors, relativePaths, output, silent, }) {
+    let invalidDocuments = core.validate(schema, documents.map(doc => new graphql.Source(graphql.print(doc.document), doc.location)), {
         strictFragments,
         maxDepth,
+        maxAliasCount,
+        maxDirectiveCount,
+        maxTokenCount,
         apollo,
         keepClientFields,
     });
@@ -59,7 +62,7 @@ function handler({ schema, documents, strictFragments, maxDepth, apollo, keepCli
     }
 }
 function moveDeprecatedToErrors(docs) {
-    return docs.map((doc) => {
+    return docs.map(doc => {
         var _a, _b;
         return ({
             source: doc.source,
@@ -69,7 +72,7 @@ function moveDeprecatedToErrors(docs) {
     });
 }
 function useRelativePaths(docs) {
-    return docs.map((doc) => {
+    return docs.map(doc => {
         doc.source.name = path.relative(process.cwd(), doc.source.name);
         return doc;
     });
@@ -78,9 +81,9 @@ function useFilter(docs, patterns) {
     if (!patterns || !patterns.length) {
         return docs;
     }
-    return docs.filter((doc) => patterns.some((filepath) => doc.source.name.includes(filepath)));
+    return docs.filter(doc => patterns.some(filepath => doc.source.name.includes(filepath)));
 }
-const index = commands.createCommand((api) => {
+const index = commands.createCommand(api => {
     const { loaders } = api;
     return {
         command: 'validate <documents> <schema>',
@@ -113,6 +116,18 @@ const index = commands.createCommand((api) => {
                     describe: 'Fail on deep operations',
                     type: 'number',
                 },
+                maxAliasCount: {
+                    describe: 'Fail on operations with too many aliases',
+                    type: 'number',
+                },
+                maxDirectiveCount: {
+                    describe: 'Fail on operations with too many directives',
+                    type: 'number',
+                },
+                maxTokenCount: {
+                    describe: 'Fail on operations with too many tokens',
+                    type: 'number',
+                },
                 apollo: {
                     describe: 'Support Apollo directives',
                     type: 'boolean',
@@ -162,7 +177,10 @@ const index = commands.createCommand((api) => {
                 const aws = args.aws || false;
                 const apolloFederation = args.federation || false;
                 const method = ((_a = args.method) === null || _a === void 0 ? void 0 : _a.toUpperCase()) || 'POST';
-                const maxDepth = args.maxDepth || undefined;
+                const maxDepth = args.maxDepth != null ? args.maxDepth : undefined;
+                const maxAliasCount = args.maxAliasCount != null ? args.maxAliasCount : undefined;
+                const maxDirectiveCount = args.maxDirectiveCount != null ? args.maxDirectiveCount : undefined;
+                const maxTokenCount = args.maxTokenCount != null ? args.maxTokenCount : undefined;
                 const strictFragments = !args.noStrictFragments;
                 const keepClientFields = args.keepClientFields || false;
                 const failOnDeprecated = args.deprecated;
@@ -184,6 +202,9 @@ const index = commands.createCommand((api) => {
                     documents,
                     apollo,
                     maxDepth,
+                    maxAliasCount,
+                    maxDirectiveCount,
+                    maxTokenCount,
                     strictFragments,
                     keepClientFields,
                     failOnDeprecated,
@@ -199,14 +220,13 @@ const index = commands.createCommand((api) => {
 });
 function countErrors(invalidDocuments) {
     if (invalidDocuments.length) {
-        return invalidDocuments.filter((doc) => doc.errors && doc.errors.length)
-            .length;
+        return invalidDocuments.filter(doc => doc.errors && doc.errors.length).length;
     }
     return 0;
 }
 function countDeprecated(invalidDocuments) {
     if (invalidDocuments.length) {
-        return invalidDocuments.filter((doc) => doc.deprecated && doc.deprecated.length).length;
+        return invalidDocuments.filter(doc => doc.deprecated && doc.deprecated.length).length;
     }
     return 0;
 }
@@ -214,18 +234,16 @@ function printInvalidDocuments(invalidDocuments, listKey, isError = false, silen
     if (silent) {
         return;
     }
-    invalidDocuments.forEach((doc) => {
+    invalidDocuments.forEach(doc => {
         if (doc.errors.length) {
-            renderErrors(doc.source.name, doc[listKey], isError).forEach((line) => {
+            renderErrors(doc.source.name, doc[listKey], isError).forEach(line => {
                 logger.Logger.log(line);
             });
         }
     });
 }
 function renderErrors(sourceName, errors, isError = false) {
-    const errorsAsString = errors
-        .map((e) => ` - ${logger.bolderize(e.message)}`)
-        .join('\n');
+    const errorsAsString = errors.map(e => ` - ${logger.bolderize(e.message)}`).join('\n');
     return [
         isError ? logger.chalk.redBright('error') : logger.chalk.yellowBright('warn'),
         `in ${sourceName}:\n\n`,

package/index.mjs

@@ -6,10 +6,13 @@ import { relative } from 'path';
 import { writeFileSync } from 'fs';
 import { Source, print } from 'graphql';
 
-function handler({ schema, documents, strictFragments, maxDepth, apollo, keepClientFields, failOnDeprecated, filter, onlyErrors, relativePaths, output, silent, }) {
-    let invalidDocuments = validate(schema, documents.map((doc) => new Source(print(doc.document), doc.location)), {
+function handler({ schema, documents, strictFragments, maxDepth, maxDirectiveCount, maxAliasCount, maxTokenCount, apollo, keepClientFields, failOnDeprecated, filter, onlyErrors, relativePaths, output, silent, }) {
+    let invalidDocuments = validate(schema, documents.map(doc => new Source(print(doc.document), doc.location)), {
         strictFragments,
         maxDepth,
+        maxAliasCount,
+        maxDirectiveCount,
+        maxTokenCount,
         apollo,
         keepClientFields,
     });
@@ -55,7 +58,7 @@ function handler({ schema, documents, strictFragments, maxDepth, apollo, keepCli
     }
 }
 function moveDeprecatedToErrors(docs) {
-    return docs.map((doc) => {
+    return docs.map(doc => {
         var _a, _b;
         return ({
             source: doc.source,
@@ -65,7 +68,7 @@ function moveDeprecatedToErrors(docs) {
     });
 }
 function useRelativePaths(docs) {
-    return docs.map((doc) => {
+    return docs.map(doc => {
         doc.source.name = relative(process.cwd(), doc.source.name);
         return doc;
     });
@@ -74,9 +77,9 @@ function useFilter(docs, patterns) {
     if (!patterns || !patterns.length) {
         return docs;
     }
-    return docs.filter((doc) => patterns.some((filepath) => doc.source.name.includes(filepath)));
+    return docs.filter(doc => patterns.some(filepath => doc.source.name.includes(filepath)));
 }
-const index = createCommand((api) => {
+const index = createCommand(api => {
     const { loaders } = api;
     return {
         command: 'validate <documents> <schema>',
@@ -109,6 +112,18 @@ const index = createCommand((api) => {
                     describe: 'Fail on deep operations',
                     type: 'number',
                 },
+                maxAliasCount: {
+                    describe: 'Fail on operations with too many aliases',
+                    type: 'number',
+                },
+                maxDirectiveCount: {
+                    describe: 'Fail on operations with too many directives',
+                    type: 'number',
+                },
+                maxTokenCount: {
+                    describe: 'Fail on operations with too many tokens',
+                    type: 'number',
+                },
                 apollo: {
                     describe: 'Support Apollo directives',
                     type: 'boolean',
@@ -158,7 +173,10 @@ const index = createCommand((api) => {
                 const aws = args.aws || false;
                 const apolloFederation = args.federation || false;
                 const method = ((_a = args.method) === null || _a === void 0 ? void 0 : _a.toUpperCase()) || 'POST';
-                const maxDepth = args.maxDepth || undefined;
+                const maxDepth = args.maxDepth != null ? args.maxDepth : undefined;
+                const maxAliasCount = args.maxAliasCount != null ? args.maxAliasCount : undefined;
+                const maxDirectiveCount = args.maxDirectiveCount != null ? args.maxDirectiveCount : undefined;
+                const maxTokenCount = args.maxTokenCount != null ? args.maxTokenCount : undefined;
                 const strictFragments = !args.noStrictFragments;
                 const keepClientFields = args.keepClientFields || false;
                 const failOnDeprecated = args.deprecated;
@@ -180,6 +198,9 @@ const index = createCommand((api) => {
                     documents,
                     apollo,
                     maxDepth,
+                    maxAliasCount,
+                    maxDirectiveCount,
+                    maxTokenCount,
                     strictFragments,
                     keepClientFields,
                     failOnDeprecated,
@@ -195,14 +216,13 @@ const index = createCommand((api) => {
 });
 function countErrors(invalidDocuments) {
     if (invalidDocuments.length) {
-        return invalidDocuments.filter((doc) => doc.errors && doc.errors.length)
-            .length;
+        return invalidDocuments.filter(doc => doc.errors && doc.errors.length).length;
     }
     return 0;
 }
 function countDeprecated(invalidDocuments) {
     if (invalidDocuments.length) {
-        return invalidDocuments.filter((doc) => doc.deprecated && doc.deprecated.length).length;
+        return invalidDocuments.filter(doc => doc.deprecated && doc.deprecated.length).length;
     }
     return 0;
 }
@@ -210,18 +230,16 @@ function printInvalidDocuments(invalidDocuments, listKey, isError = false, silen
     if (silent) {
         return;
     }
-    invalidDocuments.forEach((doc) => {
+    invalidDocuments.forEach(doc => {
         if (doc.errors.length) {
-            renderErrors(doc.source.name, doc[listKey], isError).forEach((line) => {
+            renderErrors(doc.source.name, doc[listKey], isError).forEach(line => {
                 Logger.log(line);
             });
         }
     });
 }
 function renderErrors(sourceName, errors, isError = false) {
-    const errorsAsString = errors
-        .map((e) => ` - ${bolderize(e.message)}`)
-        .join('\n');
+    const errorsAsString = errors.map(e => ` - ${bolderize(e.message)}`).join('\n');
     return [
         isError ? chalk.redBright('error') : chalk.yellowBright('warn'),
         `in ${sourceName}:\n\n`,

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@graphql-inspector/validate-command",
-  "version": "3.3.0",
+  "version": "3.4.0",
   "description": "Validate Documents in GraphQL Inspector",
   "sideEffects": false,
   "peerDependencies": {
     "graphql": "^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "dependencies": {
-    "@graphql-inspector/commands": "3.3.0",
-    "@graphql-inspector/core": "3.3.0",
-    "@graphql-inspector/logger": "3.3.0",
+    "@graphql-inspector/commands": "3.4.0",
+    "@graphql-inspector/core": "3.4.0",
+    "@graphql-inspector/logger": "3.4.0",
     "tslib": "^2.0.0"
   },
   "repository": {