@envelop/validation-cache 4.4.0-alpha-db79afa.0 → 4.4.0-alpha-05dbec7.0

package/cjs/index.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useValidationCache = void 0;
+const tslib_1 = require("tslib");
+const graphql_1 = require("graphql");
+const tiny_lru_1 = tslib_1.__importDefault(require("tiny-lru"));
+const DEFAULT_MAX = 1000;
+const DEFAULT_TTL = 3600000;
+const rawDocumentSymbol = Symbol('rawDocument');
+const useValidationCache = (pluginOptions = {}) => {
+    const resultCache = typeof pluginOptions.cache !== 'undefined' ? pluginOptions.cache : (0, tiny_lru_1.default)(DEFAULT_MAX, DEFAULT_TTL);
+    return {
+        onSchemaChange() {
+            resultCache.clear();
+        },
+        onParse({ params, extendContext }) {
+            extendContext({ [rawDocumentSymbol]: params.source.toString() });
+        },
+        onValidate({ params, context, setResult }) {
+            var _a;
+            const key = (_a = context[rawDocumentSymbol]) !== null && _a !== void 0 ? _a : (0, graphql_1.print)(params.documentAST);
+            const cachedResult = resultCache.get(key);
+            if (cachedResult !== undefined) {
+                setResult(cachedResult);
+            }
+            return ({ result }) => {
+                resultCache.set(key, result);
+            };
+        },
+    };
+};
+exports.useValidationCache = useValidationCache;

package/cjs/package.json

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

package/esm/index.js

@@ -0,0 +1,27 @@
+import { print } from 'graphql';
+import lru from 'tiny-lru';
+const DEFAULT_MAX = 1000;
+const DEFAULT_TTL = 3600000;
+const rawDocumentSymbol = Symbol('rawDocument');
+export const useValidationCache = (pluginOptions = {}) => {
+    const resultCache = typeof pluginOptions.cache !== 'undefined' ? pluginOptions.cache : lru(DEFAULT_MAX, DEFAULT_TTL);
+    return {
+        onSchemaChange() {
+            resultCache.clear();
+        },
+        onParse({ params, extendContext }) {
+            extendContext({ [rawDocumentSymbol]: params.source.toString() });
+        },
+        onValidate({ params, context, setResult }) {
+            var _a;
+            const key = (_a = context[rawDocumentSymbol]) !== null && _a !== void 0 ? _a : print(params.documentAST);
+            const cachedResult = resultCache.get(key);
+            if (cachedResult !== undefined) {
+                setResult(cachedResult);
+            }
+            return ({ result }) => {
+                resultCache.set(key, result);
+            };
+        },
+    };
+};

package/package.json

@@ -1,33 +1,57 @@
 {
   "name": "@envelop/validation-cache",
-  "version": "4.4.0-alpha-db79afa.0",
+  "version": "4.4.0-alpha-05dbec7.0",
   "sideEffects": false,
   "peerDependencies": {
-    "@envelop/core": "2.4.0-alpha-db79afa.0",
+    "@envelop/core": "2.4.0-alpha-05dbec7.0",
     "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0"
   },
+  "dependencies": {
+    "tiny-lru": "7.0.6"
+  },
   "repository": {
     "type": "git",
-    "url": "https://github.com/dotansimha/envelop.git",
+    "url": "https://github.com/n1ru4l/envelop.git",
     "directory": "packages/plugins/validation-cache"
   },
   "author": "Dotan Simha <dotansimha@gmail.com>",
   "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/{index.d.ts → typings/index.d.ts}

@@ -1,8 +1,10 @@
-import { BasicCache, Plugin } from '@envelop/core';
+import { Plugin } from '@envelop/core';
 import { GraphQLError } from 'graphql';
-export declare type ValidationCache = BasicCache<readonly GraphQLError[]> & {
+export interface ValidationCache {
+    get(key: string): readonly GraphQLError[] | undefined;
+    set(key: string, value: readonly GraphQLError[]): void;
     clear(): void;
-};
+}
 export declare type ValidationCacheOptions = {
     cache?: ValidationCache;
 };

package/README.md

@@ -1,33 +0,0 @@
-## `@envelop/validation-cache`
-
-This plugins adds simple LRU caching to your `validate`, to improve performance by caching the validation result.
-
-This plugins improves performance of validating by ~50% (based on benchmarks).
-
-## Getting Started
-
-```
-yarn add @envelop/validation-cache
-```
-
-## Usage Example
-
-```ts
-import { envelop } from '@envelop/core';
-import { useValidationCache } from '@envelop/validation-cache';
-
-const getEnveloped = envelop({
-  plugins: [
-    // ... other plugins ...
-    useValidationCache({
-      // options goes here
-    }),
-  ],
-});
-```
-
-### API Reference
-
-#### `cache`
-
-Set this to pass in a cache instance. By default a new LRU cache is created using default `max` and `ttl`.

package/index.js

@@ -1,34 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-const core = require('@envelop/core');
-const graphql = require('graphql');
-
-const rawDocumentMap = new WeakMap();
-const useValidationCache = (pluginOptions = {}) => {
-    const resultCache = pluginOptions.cache != null ? pluginOptions.cache : core.getInMemoryLRUCache();
-    return {
-        onSchemaChange() {
-            resultCache.clear();
-        },
-        onParse({ params, context }) {
-            var _a;
-            rawDocumentMap.set(context, core.isSourceObject(params.source) ? params.source.body : (_a = params.source) === null || _a === void 0 ? void 0 : _a.toString());
-        },
-        onValidate({ params, context, setResult }) {
-            var _a;
-            const key = (_a = rawDocumentMap.get(context)) !== null && _a !== void 0 ? _a : graphql.print(params.documentAST);
-            const cachedResult = resultCache.get(key);
-            if (cachedResult !== undefined) {
-                setResult(cachedResult);
-                return;
-            }
-            return ({ result }) => {
-                resultCache.set(key, result);
-            };
-        },
-    };
-};
-
-exports.useValidationCache = useValidationCache;

package/index.mjs

@@ -1,30 +0,0 @@
-import { getInMemoryLRUCache, isSourceObject } from '@envelop/core';
-import { print } from 'graphql';
-
-const rawDocumentMap = new WeakMap();
-const useValidationCache = (pluginOptions = {}) => {
-    const resultCache = pluginOptions.cache != null ? pluginOptions.cache : getInMemoryLRUCache();
-    return {
-        onSchemaChange() {
-            resultCache.clear();
-        },
-        onParse({ params, context }) {
-            var _a;
-            rawDocumentMap.set(context, isSourceObject(params.source) ? params.source.body : (_a = params.source) === null || _a === void 0 ? void 0 : _a.toString());
-        },
-        onValidate({ params, context, setResult }) {
-            var _a;
-            const key = (_a = rawDocumentMap.get(context)) !== null && _a !== void 0 ? _a : print(params.documentAST);
-            const cachedResult = resultCache.get(key);
-            if (cachedResult !== undefined) {
-                setResult(cachedResult);
-                return;
-            }
-            return ({ result }) => {
-                resultCache.set(key, result);
-            };
-        },
-    };
-};
-
-export { useValidationCache };