@envelop/rate-limiter 3.4.0-alpha-c0cc559.0 → 3.4.0-alpha-e9434aa.0

package/{index.mjs → cjs/index.js}

@@ -1,22 +1,18 @@
-import { getGraphQLRateLimiter } from 'graphql-rate-limit';
-
-function getDirective(info, name) {
-    var _a;
-    const { parentType, fieldName, schema } = info;
-    const schemaType = schema.getType(parentType.name);
-    const field = schemaType.getFields()[fieldName];
-    const astNode = field.astNode;
-    const rateLimitDirective = (_a = astNode === null || astNode === void 0 ? void 0 : astNode.directives) === null || _a === void 0 ? void 0 : _a.find(d => d.name.value === name);
-    return rateLimitDirective || null;
-}
-
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useRateLimiter = exports.DIRECTIVE_SDL = exports.UnauthenticatedError = void 0;
+const tslib_1 = require("tslib");
+const utils_js_1 = require("./utils.js");
+const graphql_rate_limit_1 = require("graphql-rate-limit");
+tslib_1.__exportStar(require("./utils.js"), exports);
 class UnauthenticatedError extends Error {
 }
-const DIRECTIVE_SDL = /* GraphQL */ `
+exports.UnauthenticatedError = UnauthenticatedError;
+exports.DIRECTIVE_SDL = `
   directive @rateLimit(max: Int, window: String, message: String) on FIELD_DEFINITION
 `;
 const useRateLimiter = (options) => {
-    const rateLimiterFn = getGraphQLRateLimiter({ identifyContext: options.identifyFn });
+    const rateLimiterFn = (0, graphql_rate_limit_1.getGraphQLRateLimiter)({ identifyContext: options.identifyFn });
     return {
         async onContextBuilding({ extendContext }) {
             extendContext({
@@ -25,7 +21,7 @@ const useRateLimiter = (options) => {
         },
         async onResolverCalled({ args, root, context, info }) {
             var _a, _b, _c;
-            const rateLimitDirectiveNode = getDirective(info, options.rateLimitDirectiveName || 'rateLimit');
+            const rateLimitDirectiveNode = (0, utils_js_1.getDirective)(info, options.rateLimitDirectiveName || 'rateLimit');
             if (rateLimitDirectiveNode && rateLimitDirectiveNode.arguments) {
                 const maxNode = (_a = rateLimitDirectiveNode.arguments.find(arg => arg.name.value === 'max')) === null || _a === void 0 ? void 0 : _a.value;
                 const windowNode = (_b = rateLimitDirectiveNode.arguments.find(arg => arg.name.value === 'window')) === null || _b === void 0 ? void 0 : _b.value;
@@ -59,8 +55,7 @@ const useRateLimiter = (options) => {
         },
     };
 };
+exports.useRateLimiter = useRateLimiter;
 function interpolate(message, args) {
     return message.replace(/\{{([^)]*)\}}/g, (_, key) => args[key.trim()]);
 }
-
-export { DIRECTIVE_SDL, UnauthenticatedError, getDirective, useRateLimiter };

package/cjs/package.json

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

package/cjs/utils.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDirective = void 0;
+function getDirective(info, name) {
+    var _a;
+    const { parentType, fieldName, schema } = info;
+    const schemaType = schema.getType(parentType.name);
+    const field = schemaType.getFields()[fieldName];
+    const astNode = field.astNode;
+    const rateLimitDirective = (_a = astNode === null || astNode === void 0 ? void 0 : astNode.directives) === null || _a === void 0 ? void 0 : _a.find(d => d.name.value === name);
+    return rateLimitDirective || null;
+}
+exports.getDirective = getDirective;

package/{index.js → esm/index.js}

@@ -1,26 +1,31 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-const graphqlRateLimit = require('graphql-rate-limit');
-
-function getDirective(info, name) {
-    var _a;
-    const { parentType, fieldName, schema } = info;
-    const schemaType = schema.getType(parentType.name);
-    const field = schemaType.getFields()[fieldName];
-    const astNode = field.astNode;
-    const rateLimitDirective = (_a = astNode === null || astNode === void 0 ? void 0 : astNode.directives) === null || _a === void 0 ? void 0 : _a.find(d => d.name.value === name);
-    return rateLimitDirective || null;
-}
-
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useRateLimiter = exports.DIRECTIVE_SDL = exports.UnauthenticatedError = void 0;
+const utils_js_1 = require("./utils.js");
+const graphql_rate_limit_1 = require("graphql-rate-limit");
+__exportStar(require("./utils.js"), exports);
 class UnauthenticatedError extends Error {
 }
-const DIRECTIVE_SDL = /* GraphQL */ `
+exports.UnauthenticatedError = UnauthenticatedError;
+exports.DIRECTIVE_SDL = `
   directive @rateLimit(max: Int, window: String, message: String) on FIELD_DEFINITION
 `;
 const useRateLimiter = (options) => {
-    const rateLimiterFn = graphqlRateLimit.getGraphQLRateLimiter({ identifyContext: options.identifyFn });
+    const rateLimiterFn = (0, graphql_rate_limit_1.getGraphQLRateLimiter)({ identifyContext: options.identifyFn });
     return {
         async onContextBuilding({ extendContext }) {
             extendContext({
@@ -29,7 +34,7 @@ const useRateLimiter = (options) => {
         },
         async onResolverCalled({ args, root, context, info }) {
             var _a, _b, _c;
-            const rateLimitDirectiveNode = getDirective(info, options.rateLimitDirectiveName || 'rateLimit');
+            const rateLimitDirectiveNode = (0, utils_js_1.getDirective)(info, options.rateLimitDirectiveName || 'rateLimit');
             if (rateLimitDirectiveNode && rateLimitDirectiveNode.arguments) {
                 const maxNode = (_a = rateLimitDirectiveNode.arguments.find(arg => arg.name.value === 'max')) === null || _a === void 0 ? void 0 : _a.value;
                 const windowNode = (_b = rateLimitDirectiveNode.arguments.find(arg => arg.name.value === 'window')) === null || _b === void 0 ? void 0 : _b.value;
@@ -63,11 +68,7 @@ const useRateLimiter = (options) => {
         },
     };
 };
+exports.useRateLimiter = useRateLimiter;
 function interpolate(message, args) {
     return message.replace(/\{{([^)]*)\}}/g, (_, key) => args[key.trim()]);
 }
-
-exports.DIRECTIVE_SDL = DIRECTIVE_SDL;
-exports.UnauthenticatedError = UnauthenticatedError;
-exports.getDirective = getDirective;
-exports.useRateLimiter = useRateLimiter;

package/esm/utils.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDirective = void 0;
+function getDirective(info, name) {
+    var _a;
+    const { parentType, fieldName, schema } = info;
+    const schemaType = schema.getType(parentType.name);
+    const field = schemaType.getFields()[fieldName];
+    const astNode = field.astNode;
+    const rateLimitDirective = (_a = astNode === null || astNode === void 0 ? void 0 : astNode.directives) === null || _a === void 0 ? void 0 : _a.find(d => d.name.value === name);
+    return rateLimitDirective || null;
+}
+exports.getDirective = getDirective;

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@envelop/rate-limiter",
-  "version": "3.4.0-alpha-c0cc559.0",
+  "version": "3.4.0-alpha-e9434aa.0",
   "sideEffects": false,
   "peerDependencies": {
-    "@envelop/core": "2.4.0-alpha-c0cc559.0",
+    "@envelop/core": "2.4.0-alpha-e9434aa.0",
     "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "dependencies": {
@@ -11,26 +11,47 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/dotansimha/envelop.git",
+    "url": "https://github.com/n1ru4l/envelop.git",
     "directory": "packages/plugins/rate-limiter"
   },
   "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,7 +1,7 @@
 import { Plugin } from '@envelop/core';
 import { GraphQLResolveInfo } from 'graphql';
 import { getGraphQLRateLimiter } from 'graphql-rate-limit';
-export * from './utils';
+export * from './utils.js';
 export declare class UnauthenticatedError extends Error {
 }
 export declare type IdentifyFn<ContextType = unknown> = (context: ContextType) => string;

package/README.md

@@ -1,62 +0,0 @@
-## `@envelop/rate-limiter`
-
-This plugins uses [`graphql-rate-limit`](https://github.com/teamplanes/graphql-rate-limit#readme) in order to limit the rate of calling queries and mutations.
-
-## Getting Started
-
-```
-yarn add @envelop/rate-limiter
-```
-
-## Usage Example
-
-```ts
-import { envelop } from '@envelop/core';
-import { useRateLimiter, IdentifyFn } from '@envelop/rate-limiter';
-
-const identifyFn: IdentifyFn = async context => {
-  return context.request.ip;
-};
-
-const getEnveloped = envelop({
-  plugins: [
-    // ... other plugins ...
-    useRateLimiter({
-      identifyFn,
-    }),
-  ],
-});
-```
-
-> By default, we assume that you have the GraphQL directive definition as part of your GraphQL schema (`directive @rateLimit(max: Int, window: String, message: String) on FIELD_DEFINITION`).
-
-Then, in your GraphQL schema SDL, you can add `@rateLimit` directive to your fields, and the limiter will get called only while resolving that specific field:
-
-```graphql
-type Query {
-  posts: [Post]! @rateLimit(
-    window: "5s", // time interval window for request limit quota
-    max: 10,  // maximum requests allowed in time window
-    message: "Too many calls!"  // quota reached error message
-  )
-  # unlimitedField: String
-}
-```
-
-> You can apply that directive to any GraphQL `field` definition, not only to root fields.
-
-### Error message interpolation
-
-The `message` argument of the `@rateLimit` directive can be dynamic. You `{{var}}` or `{{ var }}` syntax to interpolate variables.
-
-```graphql
-type Query {
-  posts: [Post]! @rateLimit(window: "5s", max: 10, message: "Too many calls made by {{ id }}")
-}
-```
-
-> The only available variable so far is `id`.
-
-## Notes
-
-You can find more details here: hhttps://github.com/teamplanes/graphql-rate-limit#readme