@graphql-tools/optimize 1.1.0 → 1.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-tools/optimize",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "A set of utils for faster development of GraphQL tools",
   "sideEffects": false,
   "peerDependencies": {

package/es5/README.md

@@ -1,45 +0,0 @@
-# GraphQL Tools: `DocumentNode` Optimizer
-
-This package is intended to allow developers to optimize `DocumentNode` objects created by `graphql` library.
-
-It's built as a set of small optimizers you can compose to get the most out of your GraphQL setup.
-
-The goal of this package is mostly around making optimizations for the way the data is stored in `DocumentNode`, and not to the essence of the `DocumentNode`.
-
-## Getting Started
-
-    yarn add -D @graphql-tools/optimize
-
-## API
-
-To get started with this tool, import it and run it over your `DocumentNode`.
-
-```ts
-import { optimizeDocumentNode } from '@graphql-tools/optimize';
-
-const myDocument: DocumentNode = { ... }
-const optimizedDocument = optimizeDocumentNode(myDocument);
-```
-
-### Customizing Optimizers
-
-By default, we apply all optimizers available in this repo over your document. It shouldn't effect any runtime since we just remove dead or unused areas.
-
-You can modify the list of optimizers this way:
-
-```ts
-import { optimizeDocumentNode, removeDescriptions } from '@graphql-tools/optimize';
-
-const myDocument: DocumentNode = { ... }
-const optimizedDocument = optimizeDocumentNode(myDocument, [removeDescriptions]);
-```
-
-### Writing your own optimizer
-
-You can create your own optimizer to manipulate `DocumentNode`, the API signature is pretty simple:
-
-```ts
-export type DocumentOptimizer = (input: DocumentNode) => DocumentNode;
-```
-
-Take a look at [./optimizers](this directory for inspiration and implementation reference).

package/es5/index.d.ts

@@ -1,5 +0,0 @@
-export * from './optimize';
-export * from './types';
-export * from './optimizers/remove-description';
-export * from './optimizers/remove-empty-nodes';
-export * from './optimizers/remove-loc';

package/es5/index.js

@@ -1,120 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-const tslib = require('tslib');
-const graphql = require('graphql');
-
-/**
- * This optimizer removes "description" field from schema AST definitions.
- * @param input
- */
-var removeDescriptions = function (input) {
-    function transformNode(node) {
-        if (node.description) {
-            node.description = undefined;
-        }
-        return node;
-    }
-    return graphql.visit(input, {
-        ScalarTypeDefinition: transformNode,
-        ObjectTypeDefinition: transformNode,
-        InterfaceTypeDefinition: transformNode,
-        UnionTypeDefinition: transformNode,
-        EnumTypeDefinition: transformNode,
-        EnumValueDefinition: transformNode,
-        InputObjectTypeDefinition: transformNode,
-        InputValueDefinition: transformNode,
-        FieldDefinition: transformNode,
-    });
-};
-
-/**
- * This optimizer removes empty nodes/arrays (directives/argument/variableDefinitions) from a given DocumentNode of operation/fragment.
- * @param input
- */
-var removeEmptyNodes = function (input) {
-    function transformNode(node) {
-        var resultNode = node;
-        if (resultNode.directives && Array.isArray(resultNode.directives) && resultNode.directives.length === 0) {
-            var directives = resultNode.directives, rest = tslib.__rest(resultNode, ["directives"]);
-            resultNode = rest;
-        }
-        if (resultNode.arguments && Array.isArray(resultNode.arguments) && resultNode.arguments.length === 0) {
-            var args = resultNode.arguments, rest = tslib.__rest(resultNode, ["arguments"]);
-            resultNode = rest;
-        }
-        if (resultNode.variableDefinitions &&
-            Array.isArray(resultNode.variableDefinitions) &&
-            resultNode.variableDefinitions.length === 0) {
-            var variableDefinitions = resultNode.variableDefinitions, rest = tslib.__rest(resultNode, ["variableDefinitions"]);
-            resultNode = rest;
-        }
-        return resultNode;
-    }
-    return graphql.visit(input, {
-        FragmentDefinition: transformNode,
-        OperationDefinition: transformNode,
-        VariableDefinition: transformNode,
-        Field: transformNode,
-        FragmentSpread: transformNode,
-        InlineFragment: transformNode,
-        Name: transformNode,
-        Directive: transformNode,
-    });
-};
-
-/**
- * This optimizer removes "loc" fields
- * @param input
- */
-var removeLoc = function (input) {
-    function transformNode(node) {
-        if (node.loc && typeof node.loc === 'object') {
-            var loc = node.loc, rest = tslib.__rest(node, ["loc"]);
-            return rest;
-        }
-        return node;
-    }
-    return graphql.visit(input, { enter: transformNode });
-};
-
-var DEFAULT_OPTIMIZERS = [removeDescriptions, removeEmptyNodes, removeLoc];
-/**
- * This method accept a DocumentNode and applies the optimizations you wish to use.
- * You can override the default ones or provide you own optimizers if you wish.
- *
- * @param node document to optimize
- * @param optimizers optional, list of optimizer to use
- */
-function optimizeDocumentNode(node, optimizers) {
-    var e_1, _a;
-    if (optimizers === void 0) { optimizers = DEFAULT_OPTIMIZERS; }
-    var resultNode = node;
-    try {
-        for (var optimizers_1 = tslib.__values(optimizers), optimizers_1_1 = optimizers_1.next(); !optimizers_1_1.done; optimizers_1_1 = optimizers_1.next()) {
-            var optimizer = optimizers_1_1.value;
-            if (typeof optimizer !== 'function') {
-                throw new Error("Optimizer provided for \"optimizeDocumentNode\" must be a function!");
-            }
-            var result = optimizer(resultNode);
-            if (!result) {
-                throw new Error("Optimizer provided for \"optimizeDocumentNode\" returned empty value instead of modified \"DocumentNode\"!");
-            }
-            resultNode = result;
-        }
-    }
-    catch (e_1_1) { e_1 = { error: e_1_1 }; }
-    finally {
-        try {
-            if (optimizers_1_1 && !optimizers_1_1.done && (_a = optimizers_1.return)) _a.call(optimizers_1);
-        }
-        finally { if (e_1) throw e_1.error; }
-    }
-    return resultNode;
-}
-
-exports.optimizeDocumentNode = optimizeDocumentNode;
-exports.removeDescriptions = removeDescriptions;
-exports.removeEmptyNodes = removeEmptyNodes;
-exports.removeLoc = removeLoc;

package/es5/index.mjs

@@ -1,113 +0,0 @@
-import { __rest, __values } from 'tslib';
-import { visit } from 'graphql';
-
-/**
- * This optimizer removes "description" field from schema AST definitions.
- * @param input
- */
-var removeDescriptions = function (input) {
-    function transformNode(node) {
-        if (node.description) {
-            node.description = undefined;
-        }
-        return node;
-    }
-    return visit(input, {
-        ScalarTypeDefinition: transformNode,
-        ObjectTypeDefinition: transformNode,
-        InterfaceTypeDefinition: transformNode,
-        UnionTypeDefinition: transformNode,
-        EnumTypeDefinition: transformNode,
-        EnumValueDefinition: transformNode,
-        InputObjectTypeDefinition: transformNode,
-        InputValueDefinition: transformNode,
-        FieldDefinition: transformNode,
-    });
-};
-
-/**
- * This optimizer removes empty nodes/arrays (directives/argument/variableDefinitions) from a given DocumentNode of operation/fragment.
- * @param input
- */
-var removeEmptyNodes = function (input) {
-    function transformNode(node) {
-        var resultNode = node;
-        if (resultNode.directives && Array.isArray(resultNode.directives) && resultNode.directives.length === 0) {
-            var directives = resultNode.directives, rest = __rest(resultNode, ["directives"]);
-            resultNode = rest;
-        }
-        if (resultNode.arguments && Array.isArray(resultNode.arguments) && resultNode.arguments.length === 0) {
-            var args = resultNode.arguments, rest = __rest(resultNode, ["arguments"]);
-            resultNode = rest;
-        }
-        if (resultNode.variableDefinitions &&
-            Array.isArray(resultNode.variableDefinitions) &&
-            resultNode.variableDefinitions.length === 0) {
-            var variableDefinitions = resultNode.variableDefinitions, rest = __rest(resultNode, ["variableDefinitions"]);
-            resultNode = rest;
-        }
-        return resultNode;
-    }
-    return visit(input, {
-        FragmentDefinition: transformNode,
-        OperationDefinition: transformNode,
-        VariableDefinition: transformNode,
-        Field: transformNode,
-        FragmentSpread: transformNode,
-        InlineFragment: transformNode,
-        Name: transformNode,
-        Directive: transformNode,
-    });
-};
-
-/**
- * This optimizer removes "loc" fields
- * @param input
- */
-var removeLoc = function (input) {
-    function transformNode(node) {
-        if (node.loc && typeof node.loc === 'object') {
-            var loc = node.loc, rest = __rest(node, ["loc"]);
-            return rest;
-        }
-        return node;
-    }
-    return visit(input, { enter: transformNode });
-};
-
-var DEFAULT_OPTIMIZERS = [removeDescriptions, removeEmptyNodes, removeLoc];
-/**
- * This method accept a DocumentNode and applies the optimizations you wish to use.
- * You can override the default ones or provide you own optimizers if you wish.
- *
- * @param node document to optimize
- * @param optimizers optional, list of optimizer to use
- */
-function optimizeDocumentNode(node, optimizers) {
-    var e_1, _a;
-    if (optimizers === void 0) { optimizers = DEFAULT_OPTIMIZERS; }
-    var resultNode = node;
-    try {
-        for (var optimizers_1 = __values(optimizers), optimizers_1_1 = optimizers_1.next(); !optimizers_1_1.done; optimizers_1_1 = optimizers_1.next()) {
-            var optimizer = optimizers_1_1.value;
-            if (typeof optimizer !== 'function') {
-                throw new Error("Optimizer provided for \"optimizeDocumentNode\" must be a function!");
-            }
-            var result = optimizer(resultNode);
-            if (!result) {
-                throw new Error("Optimizer provided for \"optimizeDocumentNode\" returned empty value instead of modified \"DocumentNode\"!");
-            }
-            resultNode = result;
-        }
-    }
-    catch (e_1_1) { e_1 = { error: e_1_1 }; }
-    finally {
-        try {
-            if (optimizers_1_1 && !optimizers_1_1.done && (_a = optimizers_1.return)) _a.call(optimizers_1);
-        }
-        finally { if (e_1) throw e_1.error; }
-    }
-    return resultNode;
-}
-
-export { optimizeDocumentNode, removeDescriptions, removeEmptyNodes, removeLoc };

package/es5/optimize.d.ts

@@ -1,10 +0,0 @@
-import { DocumentNode } from 'graphql';
-import { DocumentOptimizer } from './types';
-/**
- * This method accept a DocumentNode and applies the optimizations you wish to use.
- * You can override the default ones or provide you own optimizers if you wish.
- *
- * @param node document to optimize
- * @param optimizers optional, list of optimizer to use
- */
-export declare function optimizeDocumentNode(node: DocumentNode, optimizers?: DocumentOptimizer[]): DocumentNode;

package/es5/optimizers/remove-description.d.ts

@@ -1,6 +0,0 @@
-import { DocumentOptimizer } from '../types';
-/**
- * This optimizer removes "description" field from schema AST definitions.
- * @param input
- */
-export declare const removeDescriptions: DocumentOptimizer;

package/es5/optimizers/remove-empty-nodes.d.ts

@@ -1,6 +0,0 @@
-import { DocumentOptimizer } from '../types';
-/**
- * This optimizer removes empty nodes/arrays (directives/argument/variableDefinitions) from a given DocumentNode of operation/fragment.
- * @param input
- */
-export declare const removeEmptyNodes: DocumentOptimizer;

package/es5/optimizers/remove-loc.d.ts

@@ -1,6 +0,0 @@
-import { DocumentOptimizer } from '../types';
-/**
- * This optimizer removes "loc" fields
- * @param input
- */
-export declare const removeLoc: DocumentOptimizer;

package/es5/package.json

@@ -1,34 +0,0 @@
-{
-  "name": "@graphql-tools/optimize/es5",
-  "version": "1.1.0",
-  "description": "A set of utils for faster development of GraphQL tools",
-  "sideEffects": false,
-  "peerDependencies": {
-    "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0"
-  },
-  "dependencies": {
-    "tslib": "~2.3.0"
-  },
-  "repository": {
-    "type": "git",
-    "url": "ardatan/graphql-tools",
-    "directory": "packages/optimize"
-  },
-  "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/es5/types.d.ts

@@ -1,2 +0,0 @@
-import { DocumentNode } from 'graphql';
-export declare type DocumentOptimizer = (input: DocumentNode) => DocumentNode;