@graphql-tools/optimize 1.1.1 → 1.3.0-alpha-b76ec274.0

package/cjs/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./optimize.js"), exports);
+tslib_1.__exportStar(require("./types.js"), exports);
+tslib_1.__exportStar(require("./optimizers/remove-description.js"), exports);
+tslib_1.__exportStar(require("./optimizers/remove-empty-nodes.js"), exports);
+tslib_1.__exportStar(require("./optimizers/remove-loc.js"), exports);

package/cjs/optimize.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.optimizeDocumentNode = void 0;
+const remove_description_js_1 = require("./optimizers/remove-description.js");
+const remove_empty_nodes_js_1 = require("./optimizers/remove-empty-nodes.js");
+const remove_loc_js_1 = require("./optimizers/remove-loc.js");
+const DEFAULT_OPTIMIZERS = [remove_description_js_1.removeDescriptions, remove_empty_nodes_js_1.removeEmptyNodes, remove_loc_js_1.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 = DEFAULT_OPTIMIZERS) {
+    let resultNode = node;
+    for (const optimizer of optimizers) {
+        if (typeof optimizer !== 'function') {
+            throw new Error(`Optimizer provided for "optimizeDocumentNode" must be a function!`);
+        }
+        const result = optimizer(resultNode);
+        if (!result) {
+            throw new Error(`Optimizer provided for "optimizeDocumentNode" returned empty value instead of modified "DocumentNode"!`);
+        }
+        resultNode = result;
+    }
+    return resultNode;
+}
+exports.optimizeDocumentNode = optimizeDocumentNode;

package/cjs/optimizers/remove-description.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeDescriptions = void 0;
+const graphql_1 = require("graphql");
+/**
+ * This optimizer removes "description" field from schema AST definitions.
+ * @param input
+ */
+const removeDescriptions = input => {
+    function transformNode(node) {
+        if (node.description) {
+            node.description = undefined;
+        }
+        return node;
+    }
+    return (0, graphql_1.visit)(input, {
+        ScalarTypeDefinition: transformNode,
+        ObjectTypeDefinition: transformNode,
+        InterfaceTypeDefinition: transformNode,
+        UnionTypeDefinition: transformNode,
+        EnumTypeDefinition: transformNode,
+        EnumValueDefinition: transformNode,
+        InputObjectTypeDefinition: transformNode,
+        InputValueDefinition: transformNode,
+        FieldDefinition: transformNode,
+    });
+};
+exports.removeDescriptions = removeDescriptions;

package/cjs/optimizers/remove-empty-nodes.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeEmptyNodes = void 0;
+const graphql_1 = require("graphql");
+/**
+ * This optimizer removes empty nodes/arrays (directives/argument/variableDefinitions) from a given DocumentNode of operation/fragment.
+ * @param input
+ */
+const removeEmptyNodes = input => {
+    function transformNode(node) {
+        let resultNode = node;
+        if (resultNode.directives && Array.isArray(resultNode.directives) && resultNode.directives.length === 0) {
+            const { directives, ...rest } = resultNode;
+            resultNode = rest;
+        }
+        if (resultNode.arguments && Array.isArray(resultNode.arguments) && resultNode.arguments.length === 0) {
+            const { arguments: args, ...rest } = resultNode;
+            resultNode = rest;
+        }
+        if (resultNode.variableDefinitions &&
+            Array.isArray(resultNode.variableDefinitions) &&
+            resultNode.variableDefinitions.length === 0) {
+            const { variableDefinitions, ...rest } = resultNode;
+            resultNode = rest;
+        }
+        return resultNode;
+    }
+    return (0, graphql_1.visit)(input, {
+        // Request/Operation:
+        FragmentDefinition: transformNode,
+        OperationDefinition: transformNode,
+        VariableDefinition: transformNode,
+        Field: transformNode,
+        FragmentSpread: transformNode,
+        InlineFragment: transformNode,
+        Name: transformNode,
+        Directive: transformNode,
+        // Schema Definition:
+        SchemaDefinition: transformNode,
+        ScalarTypeDefinition: transformNode,
+        ObjectTypeDefinition: transformNode,
+        InterfaceTypeDefinition: transformNode,
+        UnionTypeDefinition: transformNode,
+        EnumTypeDefinition: transformNode,
+        EnumValueDefinition: transformNode,
+        InputObjectTypeDefinition: transformNode,
+        FieldDefinition: transformNode,
+        InputValueDefinition: transformNode,
+        // Schema Extension:
+        SchemaExtension: transformNode,
+        ScalarTypeExtension: transformNode,
+        ObjectTypeExtension: transformNode,
+        InterfaceTypeExtension: transformNode,
+        UnionTypeExtension: transformNode,
+        EnumTypeExtension: transformNode,
+        InputObjectTypeExtension: transformNode,
+    });
+};
+exports.removeEmptyNodes = removeEmptyNodes;

package/cjs/optimizers/remove-loc.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeLoc = void 0;
+const graphql_1 = require("graphql");
+/**
+ * This optimizer removes "loc" fields
+ * @param input
+ */
+const removeLoc = input => {
+    function transformNode(node) {
+        if (node.loc && typeof node.loc === 'object') {
+            const { loc, ...rest } = node;
+            return rest;
+        }
+        return node;
+    }
+    return (0, graphql_1.visit)(input, { enter: transformNode });
+};
+exports.removeLoc = removeLoc;

package/cjs/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}

package/cjs/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/esm/index.js

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

package/esm/optimize.js

@@ -0,0 +1,25 @@
+import { removeDescriptions } from './optimizers/remove-description.js';
+import { removeEmptyNodes } from './optimizers/remove-empty-nodes.js';
+import { removeLoc } from './optimizers/remove-loc.js';
+const 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
+ */
+export function optimizeDocumentNode(node, optimizers = DEFAULT_OPTIMIZERS) {
+    let resultNode = node;
+    for (const optimizer of optimizers) {
+        if (typeof optimizer !== 'function') {
+            throw new Error(`Optimizer provided for "optimizeDocumentNode" must be a function!`);
+        }
+        const result = optimizer(resultNode);
+        if (!result) {
+            throw new Error(`Optimizer provided for "optimizeDocumentNode" returned empty value instead of modified "DocumentNode"!`);
+        }
+        resultNode = result;
+    }
+    return resultNode;
+}

package/esm/optimizers/remove-description.js

@@ -0,0 +1,24 @@
+import { visit } from 'graphql';
+/**
+ * This optimizer removes "description" field from schema AST definitions.
+ * @param input
+ */
+export const removeDescriptions = 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,
+    });
+};

package/{index.mjs → esm/optimizers/remove-empty-nodes.js}

@@ -1,34 +1,9 @@
 import { visit } from 'graphql';
-
-/**
- * This optimizer removes "description" field from schema AST definitions.
- * @param input
- */
-const removeDescriptions = 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
  */
-const removeEmptyNodes = input => {
+export const removeEmptyNodes = input => {
     function transformNode(node) {
         let resultNode = node;
         if (resultNode.directives && Array.isArray(resultNode.directives) && resultNode.directives.length === 0) {
@@ -48,6 +23,7 @@ const removeEmptyNodes = input => {
         return resultNode;
     }
     return visit(input, {
+        // Request/Operation:
         FragmentDefinition: transformNode,
         OperationDefinition: transformNode,
         VariableDefinition: transformNode,
@@ -56,45 +32,24 @@ const removeEmptyNodes = input => {
         InlineFragment: transformNode,
         Name: transformNode,
         Directive: transformNode,
+        // Schema Definition:
+        SchemaDefinition: transformNode,
+        ScalarTypeDefinition: transformNode,
+        ObjectTypeDefinition: transformNode,
+        InterfaceTypeDefinition: transformNode,
+        UnionTypeDefinition: transformNode,
+        EnumTypeDefinition: transformNode,
+        EnumValueDefinition: transformNode,
+        InputObjectTypeDefinition: transformNode,
+        FieldDefinition: transformNode,
+        InputValueDefinition: transformNode,
+        // Schema Extension:
+        SchemaExtension: transformNode,
+        ScalarTypeExtension: transformNode,
+        ObjectTypeExtension: transformNode,
+        InterfaceTypeExtension: transformNode,
+        UnionTypeExtension: transformNode,
+        EnumTypeExtension: transformNode,
+        InputObjectTypeExtension: transformNode,
     });
 };
-
-/**
- * This optimizer removes "loc" fields
- * @param input
- */
-const removeLoc = input => {
-    function transformNode(node) {
-        if (node.loc && typeof node.loc === 'object') {
-            const { loc, ...rest } = node;
-            return rest;
-        }
-        return node;
-    }
-    return visit(input, { enter: transformNode });
-};
-
-const 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 = DEFAULT_OPTIMIZERS) {
-    let resultNode = node;
-    for (const optimizer of optimizers) {
-        if (typeof optimizer !== 'function') {
-            throw new Error(`Optimizer provided for "optimizeDocumentNode" must be a function!`);
-        }
-        const result = optimizer(resultNode);
-        if (!result) {
-            throw new Error(`Optimizer provided for "optimizeDocumentNode" returned empty value instead of modified "DocumentNode"!`);
-        }
-        resultNode = result;
-    }
-    return resultNode;
-}
-
-export { optimizeDocumentNode, removeDescriptions, removeEmptyNodes, removeLoc };

package/esm/optimizers/remove-loc.js

@@ -0,0 +1,15 @@
+import { visit } from 'graphql';
+/**
+ * This optimizer removes "loc" fields
+ * @param input
+ */
+export const removeLoc = input => {
+    function transformNode(node) {
+        if (node.loc && typeof node.loc === 'object') {
+            const { loc, ...rest } = node;
+            return rest;
+        }
+        return node;
+    }
+    return visit(input, { enter: transformNode });
+};

package/esm/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@graphql-tools/optimize",
-  "version": "1.1.1",
+  "version": "1.3.0-alpha-b76ec274.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"
+    "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0"
   },
   "dependencies": {
-    "tslib": "~2.3.0"
+    "tslib": "^2.4.0"
   },
   "repository": {
     "type": "git",
@@ -15,20 +15,42 @@
     "directory": "packages/optimize"
   },
   "license": "MIT",
-  "main": "index.js",
-  "module": "index.mjs",
-  "typings": "index.d.ts",
+  "main": "cjs/index.js",
+  "module": "esm/index.js",
+  "typings": "typings/index.d.ts",
   "typescript": {
-    "definition": "index.d.ts"
+    "definition": "typings/index.d.ts"
   },
+  "type": "module",
   "exports": {
     ".": {
-      "require": "./index.js",
-      "import": "./index.mjs"
+      "require": {
+        "types": "./typings/index.d.ts",
+        "default": "./cjs/index.js"
+      },
+      "import": {
+        "types": "./typings/index.d.ts",
+        "default": "./esm/index.js"
+      },
+      "default": {
+        "types": "./typings/index.d.ts",
+        "default": "./esm/index.js"
+      }
     },
     "./*": {
-      "require": "./*.js",
-      "import": "./*.mjs"
-    }
+      "require": {
+        "types": "./typings/*.d.ts",
+        "default": "./cjs/*.js"
+      },
+      "import": {
+        "types": "./typings/*.d.ts",
+        "default": "./esm/*.js"
+      },
+      "default": {
+        "types": "./typings/*.d.ts",
+        "default": "./esm/*.js"
+      }
+    },
+    "./package.json": "./package.json"
   }
-}
+}

package/typings/index.d.ts

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

package/{optimize.d.ts → typings/optimize.d.ts}

@@ -1,5 +1,5 @@
 import { DocumentNode } from 'graphql';
-import { DocumentOptimizer } from './types';
+import { DocumentOptimizer } from './types.js';
 /**
  * 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.

package/{optimizers → typings/optimizers}/remove-description.d.ts

@@ -1,4 +1,4 @@
-import { DocumentOptimizer } from '../types';
+import { DocumentOptimizer } from '../types.js';
 /**
  * This optimizer removes "description" field from schema AST definitions.
  * @param input

package/{optimizers → typings/optimizers}/remove-empty-nodes.d.ts

@@ -1,4 +1,4 @@
-import { DocumentOptimizer } from '../types';
+import { DocumentOptimizer } from '../types.js';
 /**
  * This optimizer removes empty nodes/arrays (directives/argument/variableDefinitions) from a given DocumentNode of operation/fragment.
  * @param input

package/{optimizers → typings/optimizers}/remove-loc.d.ts

@@ -1,4 +1,4 @@
-import { DocumentOptimizer } from '../types';
+import { DocumentOptimizer } from '../types.js';
 /**
  * This optimizer removes "loc" fields
  * @param input

package/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/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/index.js

@@ -1,107 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-const graphql = require('graphql');
-
-/**
- * This optimizer removes "description" field from schema AST definitions.
- * @param input
- */
-const removeDescriptions = 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
- */
-const removeEmptyNodes = input => {
-    function transformNode(node) {
-        let resultNode = node;
-        if (resultNode.directives && Array.isArray(resultNode.directives) && resultNode.directives.length === 0) {
-            const { directives, ...rest } = resultNode;
-            resultNode = rest;
-        }
-        if (resultNode.arguments && Array.isArray(resultNode.arguments) && resultNode.arguments.length === 0) {
-            const { arguments: args, ...rest } = resultNode;
-            resultNode = rest;
-        }
-        if (resultNode.variableDefinitions &&
-            Array.isArray(resultNode.variableDefinitions) &&
-            resultNode.variableDefinitions.length === 0) {
-            const { variableDefinitions, ...rest } = resultNode;
-            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
- */
-const removeLoc = input => {
-    function transformNode(node) {
-        if (node.loc && typeof node.loc === 'object') {
-            const { loc, ...rest } = node;
-            return rest;
-        }
-        return node;
-    }
-    return graphql.visit(input, { enter: transformNode });
-};
-
-const 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 = DEFAULT_OPTIMIZERS) {
-    let resultNode = node;
-    for (const optimizer of optimizers) {
-        if (typeof optimizer !== 'function') {
-            throw new Error(`Optimizer provided for "optimizeDocumentNode" must be a function!`);
-        }
-        const result = optimizer(resultNode);
-        if (!result) {
-            throw new Error(`Optimizer provided for "optimizeDocumentNode" returned empty value instead of modified "DocumentNode"!`);
-        }
-        resultNode = result;
-    }
-    return resultNode;
-}
-
-exports.optimizeDocumentNode = optimizeDocumentNode;
-exports.removeDescriptions = removeDescriptions;
-exports.removeEmptyNodes = removeEmptyNodes;
-exports.removeLoc = removeLoc;