@graphql-inspector/core 0.0.0-canary.f71f99b → 0.0.0-canary.fec2df4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. package/README.md +11 -9
  2. package/ast/document.d.ts +12 -12
  3. package/coverage/index.d.ts +9 -0
  4. package/coverage/output/json.d.ts +1 -1
  5. package/diff/argument.d.ts +3 -13
  6. package/diff/changes/argument.d.ts +5 -25
  7. package/diff/changes/change.d.ts +2 -0
  8. package/diff/changes/directive.d.ts +10 -41
  9. package/diff/changes/enum.d.ts +8 -20
  10. package/diff/changes/field.d.ts +15 -64
  11. package/diff/changes/input.d.ts +9 -33
  12. package/diff/changes/object.d.ts +4 -10
  13. package/diff/changes/schema.d.ts +5 -14
  14. package/diff/changes/union.d.ts +4 -10
  15. package/diff/directive.d.ts +2 -2
  16. package/diff/enum.d.ts +2 -2
  17. package/diff/field.d.ts +2 -2
  18. package/diff/index.d.ts +5 -8
  19. package/diff/input.d.ts +2 -2
  20. package/diff/interface.d.ts +2 -2
  21. package/diff/object.d.ts +2 -2
  22. package/diff/rules/config.d.ts +2 -0
  23. package/diff/rules/consider-usage.d.ts +29 -0
  24. package/diff/rules/dangerous-breaking.d.ts +2 -0
  25. package/diff/rules/index.d.ts +3 -0
  26. package/diff/rules/safe-unreachable.d.ts +2 -0
  27. package/diff/rules/types.d.ts +8 -7
  28. package/diff/schema.d.ts +1 -0
  29. package/diff/union.d.ts +2 -2
  30. package/index.d.ts +11 -11
  31. package/index.js +1992 -0
  32. package/index.mjs +1978 -0
  33. package/package.json +16 -5
  34. package/utils/apollo.d.ts +4 -11
  35. package/utils/compare.d.ts +22 -0
  36. package/utils/graphql.d.ts +1 -0
  37. package/utils/isDeprecated.d.ts +2 -0
  38. package/{diff/common → utils}/path.d.ts +0 -0
  39. package/utils/string.d.ts +1 -0
  40. package/validate/alias-count.d.ts +10 -0
  41. package/validate/complexity.d.ts +16 -0
  42. package/validate/directive-count.d.ts +10 -0
  43. package/validate/index.d.ts +12 -2
  44. package/validate/query-depth.d.ts +2 -1
  45. package/validate/token-count.d.ts +5 -0
  46. package/diff/common/compare.d.ts +0 -3
  47. package/index.cjs.js +0 -1688
  48. package/index.cjs.js.map +0 -1
  49. package/index.esm.js +0 -1681
  50. package/index.esm.js.map +0 -1
  51. package/utils/arrays.d.ts +0 -2
package/package.json CHANGED
@@ -1,13 +1,14 @@
1
1
  {
2
2
  "name": "@graphql-inspector/core",
3
- "version": "0.0.0-canary.f71f99b",
3
+ "version": "0.0.0-canary.fec2df4",
4
4
  "description": "Tooling for GraphQL. Compare GraphQL Schemas, check documents, find breaking changes, find similar types.",
5
5
  "sideEffects": false,
6
6
  "peerDependencies": {
7
- "graphql": "^0.13.0 || ^14.0.0 || ^15.0.0"
7
+ "graphql": "^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"
8
8
  },
9
9
  "dependencies": {
10
- "dependency-graph": "0.9.0",
10
+ "dependency-graph": "0.11.0",
11
+ "object-inspect": "1.10.3",
11
12
  "tslib": "^2.0.0"
12
13
  },
13
14
  "repository": {
@@ -26,10 +27,20 @@
26
27
  "url": "https://github.com/kamilkisiela"
27
28
  },
28
29
  "license": "MIT",
29
- "main": "index.cjs.js",
30
- "module": "index.esm.js",
30
+ "main": "index.js",
31
+ "module": "index.mjs",
31
32
  "typings": "index.d.ts",
32
33
  "typescript": {
33
34
  "definition": "index.d.ts"
35
+ },
36
+ "exports": {
37
+ ".": {
38
+ "require": "./index.js",
39
+ "import": "./index.mjs"
40
+ },
41
+ "./*": {
42
+ "require": "./*.js",
43
+ "import": "./*.mjs"
44
+ }
34
45
  }
35
46
  }
package/utils/apollo.d.ts CHANGED
@@ -1,12 +1,5 @@
1
- import {DocumentNode, GraphQLSchema} from 'graphql';
2
- export declare function transformDocumentWithApollo(
3
- doc: DocumentNode,
4
- {
5
- keepClientFields,
6
- }: {
1
+ import { DocumentNode, GraphQLSchema } from 'graphql';
2
+ export declare function transformDocumentWithApollo(doc: DocumentNode, { keepClientFields }: {
7
3
  keepClientFields: boolean;
8
- },
9
- ): DocumentNode;
10
- export declare function transformSchemaWithApollo(
11
- schema: GraphQLSchema,
12
- ): GraphQLSchema;
4
+ }): DocumentNode;
5
+ export declare function transformSchemaWithApollo(schema: GraphQLSchema): GraphQLSchema;
@@ -0,0 +1,22 @@
1
+ export declare function keyMap<T>(list: readonly T[], keyFn: (item: T) => string): Record<string, T>;
2
+ export declare function isEqual<T>(a: T, b: T): boolean;
3
+ export declare function isNotEqual<T>(a: T, b: T): boolean;
4
+ export declare function isVoid<T>(a: T): boolean;
5
+ export declare function diffArrays<T>(a: T[] | readonly T[], b: T[] | readonly T[]): T[];
6
+ export declare function compareLists<T extends {
7
+ name: string;
8
+ }>(oldList: readonly T[], newList: readonly T[], callbacks?: {
9
+ onAdded?(t: T): void;
10
+ onRemoved?(t: T): void;
11
+ onMutual?(t: {
12
+ newVersion: T;
13
+ oldVersion: T;
14
+ }): void;
15
+ }): {
16
+ added: T[];
17
+ removed: T[];
18
+ mutual: {
19
+ newVersion: T;
20
+ oldVersion: T;
21
+ }[];
22
+ };
@@ -8,3 +8,4 @@ export declare function isForIntrospection(type: GraphQLNamedType | string): boo
8
8
  export declare function findDeprecatedUsages(schema: GraphQLSchema, ast: DocumentNode): Array<GraphQLError>;
9
9
  export declare function removeFieldIfDirectives(node: FieldNode, directiveNames: string[]): FieldNode | null;
10
10
  export declare function removeDirectives(node: FieldNode, directiveNames: string[]): FieldNode;
11
+ export declare function getReachableTypes(schema: GraphQLSchema): Set<string>;
@@ -0,0 +1,2 @@
1
+ import { GraphQLInputField, GraphQLEnumValue, GraphQLField } from 'graphql';
2
+ export declare function isDeprecated(fieldOrEnumValue: GraphQLField<any, any> | GraphQLEnumValue | GraphQLInputField): boolean;
File without changes
package/utils/string.d.ts CHANGED
@@ -11,3 +11,4 @@ export interface BestMatch {
11
11
  bestMatch: Rating;
12
12
  }
13
13
  export declare function findBestMatch(mainString: string, targetStrings: Target[]): BestMatch;
14
+ export declare function safeString(obj: any): string;
@@ -0,0 +1,10 @@
1
+ import { DepGraph } from 'dependency-graph';
2
+ import type { DocumentNode, FragmentDefinitionNode, Source, FieldNode, InlineFragmentNode, OperationDefinitionNode, FragmentSpreadNode } from 'graphql';
3
+ import { GraphQLError } from 'graphql';
4
+ export declare function validateAliasCount({ source, doc, maxAliasCount, fragmentGraph, }: {
5
+ source: Source;
6
+ doc: DocumentNode;
7
+ maxAliasCount: number;
8
+ fragmentGraph: DepGraph<FragmentDefinitionNode>;
9
+ }): GraphQLError | void;
10
+ export declare function countAliases(node: FieldNode | FragmentDefinitionNode | InlineFragmentNode | OperationDefinitionNode | FragmentSpreadNode, getFragmentByName: (fragmentName: string) => FragmentDefinitionNode | undefined): number;
@@ -0,0 +1,16 @@
1
+ import { DepGraph } from 'dependency-graph';
2
+ import type { DocumentNode, FragmentDefinitionNode, Source, FieldNode, InlineFragmentNode, OperationDefinitionNode, FragmentSpreadNode } from 'graphql';
3
+ import { GraphQLError } from 'graphql';
4
+ export declare type CalculateOperationComplexityConfig = {
5
+ scalarCost: number;
6
+ objectCost: number;
7
+ depthCostFactor: number;
8
+ };
9
+ export declare function validateComplexity({ source, doc, maxComplexityScore, config, fragmentGraph, }: {
10
+ source: Source;
11
+ doc: DocumentNode;
12
+ maxComplexityScore: number;
13
+ config: CalculateOperationComplexityConfig;
14
+ fragmentGraph: DepGraph<FragmentDefinitionNode>;
15
+ }): GraphQLError | void;
16
+ export declare function calculateOperationComplexity(node: FieldNode | FragmentDefinitionNode | InlineFragmentNode | OperationDefinitionNode | FragmentSpreadNode, config: CalculateOperationComplexityConfig, getFragmentByName: (fragmentName: string) => FragmentDefinitionNode | undefined, depth?: number): number;
@@ -0,0 +1,10 @@
1
+ import { DepGraph } from 'dependency-graph';
2
+ import type { DocumentNode, FragmentDefinitionNode, Source, FieldNode, InlineFragmentNode, OperationDefinitionNode, FragmentSpreadNode } from 'graphql';
3
+ import { GraphQLError } from 'graphql';
4
+ export declare function validateDirectiveCount({ source, doc, maxDirectiveCount, fragmentGraph, }: {
5
+ source: Source;
6
+ doc: DocumentNode;
7
+ maxDirectiveCount: number;
8
+ fragmentGraph: DepGraph<FragmentDefinitionNode>;
9
+ }): GraphQLError | void;
10
+ export declare function countDirectives(node: FieldNode | FragmentDefinitionNode | InlineFragmentNode | OperationDefinitionNode | FragmentSpreadNode, getFragmentByName: (fragmentName: string) => FragmentDefinitionNode | undefined): number;
@@ -26,9 +26,19 @@ export interface ValidateOptions {
26
26
  */
27
27
  apollo?: boolean;
28
28
  /**
29
- * Fails when operation depth exceeds maximum depth
30
- * @default false
29
+ * Fails when operation depth exceeds maximum depth (including the referenced fragments).
30
+ * @default Infinity
31
31
  */
32
32
  maxDepth?: number;
33
+ /**
34
+ * Fails when alias count exceeds maximum count (including the referenced fragments).
35
+ * @default Infinity
36
+ */
37
+ maxAliasCount?: number;
38
+ /**
39
+ * Fails when the directive count exceeds maximum count for a single operation (including the referenced fragments).
40
+ * @default Infinity
41
+ */
42
+ maxDirectiveCount?: number;
33
43
  }
34
44
  export declare function validate(schema: GraphQLSchema, sources: Source[], options?: ValidateOptions): InvalidDocument[];
@@ -1,5 +1,5 @@
1
1
  import { DepGraph } from 'dependency-graph';
2
- import { DocumentNode, GraphQLError, ASTNode, FragmentDefinitionNode, Source } from 'graphql';
2
+ import { DocumentNode, GraphQLError, ASTNode, FragmentDefinitionNode, Source, FieldNode, InlineFragmentNode, OperationDefinitionNode, FragmentSpreadNode } from 'graphql';
3
3
  export declare function validateQueryDepth({ source, doc, maxDepth, fragmentGraph, }: {
4
4
  source: Source;
5
5
  doc: DocumentNode;
@@ -12,3 +12,4 @@ export declare function calculateDepth({ node, currentDepth, maxDepth, getFragme
12
12
  maxDepth?: number;
13
13
  getFragment: (fragmentName: string) => FragmentDefinitionNode;
14
14
  }): number | never;
15
+ export declare function countDepth(node: FieldNode | FragmentDefinitionNode | InlineFragmentNode | OperationDefinitionNode | FragmentSpreadNode, parentDepth: number, getFragmentReference: (name: string) => FragmentDefinitionNode | undefined): number;
@@ -0,0 +1,5 @@
1
+ import type { Source } from 'graphql';
2
+ export declare function calculateTokenCount(args: {
3
+ source: Source | string;
4
+ getReferencedFragmentSource: (fragmentName: string) => Source | string | undefined;
5
+ }): number;
@@ -1,3 +0,0 @@
1
- export declare function isEqual<T>(a: T, b: T): boolean;
2
- export declare function isNotEqual<T>(a: T, b: T): boolean;
3
- export declare function isVoid<T>(a: T): boolean;