@graphql-inspector/core 0.0.0-PLACEHOLDER

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@graphql-inspector/core",
+  "version": "0.0.0-PLACEHOLDER",
+  "description": "Tooling for GraphQL. Compare GraphQL Schemas, check documents, find breaking changes, find similar types.",
+  "sideEffects": false,
+  "peerDependencies": {
+    "graphql": "^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"
+  },
+  "dependencies": {
+    "dependency-graph": "0.11.0",
+    "object-inspect": "1.10.3",
+    "tslib": "^2.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "kamilkisiela/graphql-inspector",
+    "directory": "packages/core"
+  },
+  "keywords": [
+    "graphql",
+    "graphql-inspector",
+    "tools"
+  ],
+  "author": {
+    "name": "Kamil Kisiela",
+    "email": "kamil.kisiela@gmail.com",
+    "url": "https://github.com/kamilkisiela"
+  },
+  "license": "MIT",
+  "main": "index.js",
+  "module": "index.mjs",
+  "typings": "index.d.ts",
+  "typescript": {
+    "definition": "index.d.ts"
+  },
+  "exports": {
+    ".": {
+      "require": "./index.js",
+      "import": "./index.mjs"
+    },
+    "./*": {
+      "require": "./*.js",
+      "import": "./*.mjs"
+    }
+  }
+}

package/similar/index.d.ts

@@ -0,0 +1,6 @@
+import { GraphQLSchema } from 'graphql';
+import { BestMatch } from '../utils/string';
+export interface SimilarMap {
+    [name: string]: BestMatch;
+}
+export declare function similar(schema: GraphQLSchema, typeName: string | undefined, threshold?: number): SimilarMap;

package/utils/apollo.d.ts

@@ -0,0 +1,5 @@
+import { DocumentNode, GraphQLSchema } from 'graphql';
+export declare function transformDocumentWithApollo(doc: DocumentNode, { keepClientFields }: {
+    keepClientFields: boolean;
+}): DocumentNode;
+export declare function transformSchemaWithApollo(schema: GraphQLSchema): GraphQLSchema;

package/utils/compare.d.ts

@@ -0,0 +1,22 @@
+export declare function keyMap<T>(list: readonly T[], keyFn: (item: T) => string): Record<string, T>;
+export declare function isEqual<T>(a: T, b: T): boolean;
+export declare function isNotEqual<T>(a: T, b: T): boolean;
+export declare function isVoid<T>(a: T): boolean;
+export declare function diffArrays<T>(a: T[] | readonly T[], b: T[] | readonly T[]): T[];
+export declare function compareLists<T extends {
+    name: string;
+}>(oldList: readonly T[], newList: readonly T[], callbacks?: {
+    onAdded?(t: T): void;
+    onRemoved?(t: T): void;
+    onMutual?(t: {
+        newVersion: T;
+        oldVersion: T;
+    }): void;
+}): {
+    added: T[];
+    removed: T[];
+    mutual: {
+        newVersion: T;
+        oldVersion: T;
+    }[];
+};

package/utils/graphql.d.ts

@@ -0,0 +1,11 @@
+import { GraphQLInputType, GraphQLOutputType, GraphQLNamedType, KindEnum, GraphQLSchema, GraphQLError, DocumentNode, FieldNode } from 'graphql';
+export declare function safeChangeForField(oldType: GraphQLOutputType, newType: GraphQLOutputType): boolean;
+export declare function safeChangeForInputValue(oldType: GraphQLInputType, newType: GraphQLInputType): boolean;
+export declare function getKind(type: GraphQLNamedType): KindEnum;
+export declare function getTypePrefix(type: GraphQLNamedType): string;
+export declare function isPrimitive(type: GraphQLNamedType | string): boolean;
+export declare function isForIntrospection(type: GraphQLNamedType | string): boolean;
+export declare function findDeprecatedUsages(schema: GraphQLSchema, ast: DocumentNode): Array<GraphQLError>;
+export declare function removeFieldIfDirectives(node: FieldNode, directiveNames: string[]): FieldNode | null;
+export declare function removeDirectives(node: FieldNode, directiveNames: string[]): FieldNode;
+export declare function getReachableTypes(schema: GraphQLSchema): Set<string>;

package/utils/isDeprecated.d.ts

@@ -0,0 +1,2 @@
+import { GraphQLInputField, GraphQLEnumValue, GraphQLField } from 'graphql';
+export declare function isDeprecated(fieldOrEnumValue: GraphQLField<any, any> | GraphQLEnumValue | GraphQLInputField): boolean;

package/utils/path.d.ts

@@ -0,0 +1 @@
+export declare function parsePath(path: string): string[];

package/utils/string.d.ts

@@ -0,0 +1,14 @@
+export interface Target {
+    typeId: string;
+    value: string;
+}
+export interface Rating {
+    target: Target;
+    rating: number;
+}
+export interface BestMatch {
+    ratings: Rating[];
+    bestMatch: Rating;
+}
+export declare function findBestMatch(mainString: string, targetStrings: Target[]): BestMatch;
+export declare function safeString(obj: any): string;

package/validate/index.d.ts

@@ -0,0 +1,34 @@
+import { GraphQLSchema, GraphQLError, Source } from 'graphql';
+export interface InvalidDocument {
+    source: Source;
+    errors: GraphQLError[];
+    deprecated: GraphQLError[];
+}
+export interface ValidateOptions {
+    /**
+     * Fails on duplicated fragment names
+     * @default true
+     */
+    strictFragments?: boolean;
+    /**
+     * Fails on deprecated usage
+     * @default true
+     */
+    strictDeprecated?: boolean;
+    /**
+     * Works only with combination of `apollo`
+     * @default false
+     */
+    keepClientFields?: boolean;
+    /**
+     * Supports Apollo directives (`@client` and `@connection`)
+     * @default false
+     */
+    apollo?: boolean;
+    /**
+     * Fails when operation depth exceeds maximum depth
+     * @default false
+     */
+    maxDepth?: number;
+}
+export declare function validate(schema: GraphQLSchema, sources: Source[], options?: ValidateOptions): InvalidDocument[];

package/validate/query-depth.d.ts

@@ -0,0 +1,14 @@
+import { DepGraph } from 'dependency-graph';
+import { DocumentNode, GraphQLError, ASTNode, FragmentDefinitionNode, Source } from 'graphql';
+export declare function validateQueryDepth({ source, doc, maxDepth, fragmentGraph, }: {
+    source: Source;
+    doc: DocumentNode;
+    maxDepth: number;
+    fragmentGraph: DepGraph<FragmentDefinitionNode>;
+}): GraphQLError | void;
+export declare function calculateDepth({ node, currentDepth, maxDepth, getFragment, }: {
+    node: ASTNode;
+    currentDepth: number;
+    maxDepth?: number;
+    getFragment: (fragmentName: string) => FragmentDefinitionNode;
+}): number | never;