@envelop/resource-limitations 2.4.0-alpha-aca44e1.0 → 2.4.0-alpha-385b86b.0

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

@@ -1,19 +1,17 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-const core = require('@envelop/core');
-const extendedValidation = require('@envelop/extended-validation');
-const graphql = require('graphql');
-const utils = require('@graphql-tools/utils');
-
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useResourceLimitations = exports.ResourceLimitationValidationRule = exports.defaultPaginationArgumentMinimum = exports.defaultPaginationArgumentMaximum = exports.defaultNodeCostLimit = void 0;
+const core_1 = require("@envelop/core");
+const extended_validation_1 = require("@envelop/extended-validation");
+const graphql_1 = require("graphql");
+const utils_1 = require("@graphql-tools/utils");
 const getWrappedType = (graphqlType) => {
-    if (graphqlType instanceof graphql.GraphQLList || graphqlType instanceof graphql.GraphQLNonNull) {
+    if (graphqlType instanceof graphql_1.GraphQLList || graphqlType instanceof graphql_1.GraphQLNonNull) {
         return getWrappedType(graphqlType.ofType);
     }
     return graphqlType;
 };
-const isValidArgType = (type, paginationArgumentTypes) => type === graphql.GraphQLInt || (graphql.isScalarType(type) && !!paginationArgumentTypes && paginationArgumentTypes.includes(type.name));
+const isValidArgType = (type, paginationArgumentTypes) => type === graphql_1.GraphQLInt || ((0, graphql_1.isScalarType)(type) && !!paginationArgumentTypes && paginationArgumentTypes.includes(type.name));
 const hasFieldDefConnectionArgs = (field, argumentTypes) => {
     let hasFirst = false;
     let hasLast = false;
@@ -36,9 +34,9 @@ const buildMissingPaginationFieldErrorMessage = (params) => `Missing pagination
     ' field argument.';
 const buildInvalidPaginationRangeErrorMessage = (params) => `Invalid pagination argument for field ${params.fieldName}. ` +
     `The value for the '${params.argumentName}' argument must be an integer within ${params.paginationArgumentMinimum}-${params.paginationArgumentMaximum}.`;
-const defaultNodeCostLimit = 500000;
-const defaultPaginationArgumentMaximum = 100;
-const defaultPaginationArgumentMinimum = 1;
+exports.defaultNodeCostLimit = 500000;
+exports.defaultPaginationArgumentMaximum = 100;
+exports.defaultPaginationArgumentMinimum = 1;
 /**
  * Validate whether a user is allowed to execute a certain GraphQL operation.
  */
@@ -53,9 +51,9 @@ const ResourceLimitationValidationRule = (params) => (context, executionArgs) =>
                 const fieldDef = context.getFieldDef();
                 // if it is not found the query is invalid and graphql validation will complain
                 if (fieldDef != null) {
-                    const argumentValues = utils.getArgumentValues(fieldDef, fieldNode, executionArgs.variableValues || undefined);
+                    const argumentValues = (0, utils_1.getArgumentValues)(fieldDef, fieldNode, executionArgs.variableValues || undefined);
                     const type = getWrappedType(fieldDef.type);
-                    if (type instanceof graphql.GraphQLObjectType && type.name.endsWith('Connection')) {
+                    if (type instanceof graphql_1.GraphQLObjectType && type.name.endsWith('Connection')) {
                         let nodeCost = 1;
                         connectionFieldMap.add(fieldNode);
                         const { hasFirst, hasLast } = hasFieldDefConnectionArgs(fieldDef, params.paginationArgumentTypes);
@@ -65,7 +63,7 @@ const ResourceLimitationValidationRule = (params) => (context, executionArgs) =>
                         }
                         else if (hasFirst === true || hasLast === true) {
                             if ('first' in argumentValues === false && 'last' in argumentValues === false) {
-                                context.reportError(new graphql.GraphQLError(buildMissingPaginationFieldErrorMessage({
+                                context.reportError(new graphql_1.GraphQLError(buildMissingPaginationFieldErrorMessage({
                                     fieldName: fieldDef.name,
                                     hasFirst,
                                     hasLast,
@@ -73,7 +71,7 @@ const ResourceLimitationValidationRule = (params) => (context, executionArgs) =>
                             }
                             else if ('first' in argumentValues === true && 'last' in argumentValues === false) {
                                 if (argumentValues.first < paginationArgumentMinimum || argumentValues.first > paginationArgumentMaximum) {
-                                    context.reportError(new graphql.GraphQLError(buildInvalidPaginationRangeErrorMessage({
+                                    context.reportError(new graphql_1.GraphQLError(buildInvalidPaginationRangeErrorMessage({
                                         paginationArgumentMaximum,
                                         paginationArgumentMinimum,
                                         argumentName: 'first',
@@ -87,7 +85,7 @@ const ResourceLimitationValidationRule = (params) => (context, executionArgs) =>
                             }
                             else if ('last' in argumentValues === true && 'false' in argumentValues === false) {
                                 if (argumentValues.last < paginationArgumentMinimum || argumentValues.last > paginationArgumentMaximum) {
-                                    context.reportError(new graphql.GraphQLError(buildInvalidPaginationRangeErrorMessage({
+                                    context.reportError(new graphql_1.GraphQLError(buildInvalidPaginationRangeErrorMessage({
                                         paginationArgumentMaximum,
                                         paginationArgumentMinimum,
                                         argumentName: 'last',
@@ -100,7 +98,7 @@ const ResourceLimitationValidationRule = (params) => (context, executionArgs) =>
                                 }
                             }
                             else {
-                                context.reportError(new graphql.GraphQLError(buildMissingPaginationFieldErrorMessage({
+                                context.reportError(new graphql_1.GraphQLError(buildMissingPaginationFieldErrorMessage({
                                     fieldName: fieldDef.name,
                                     hasFirst,
                                     hasLast,
@@ -125,18 +123,19 @@ const ResourceLimitationValidationRule = (params) => (context, executionArgs) =>
                     totalNodeCost = 1;
                 }
                 if (totalNodeCost > params.nodeCostLimit) {
-                    context.reportError(new graphql.GraphQLError(`Cannot request more than ${params.nodeCostLimit} nodes in a single document. Please split your operation into multiple sub operations or reduce the amount of requested nodes.`, documentNode));
+                    context.reportError(new graphql_1.GraphQLError(`Cannot request more than ${params.nodeCostLimit} nodes in a single document. Please split your operation into multiple sub operations or reduce the amount of requested nodes.`, documentNode));
                 }
                 (_a = params.reportNodeCost) === null || _a === void 0 ? void 0 : _a.call(params, totalNodeCost, executionArgs);
             },
         },
     };
 };
+exports.ResourceLimitationValidationRule = ResourceLimitationValidationRule;
 const useResourceLimitations = (params) => {
     var _a, _b, _c, _d;
-    const paginationArgumentMaximum = (_a = params === null || params === void 0 ? void 0 : params.paginationArgumentMaximum) !== null && _a !== void 0 ? _a : defaultPaginationArgumentMaximum;
-    const paginationArgumentMinimum = (_b = params === null || params === void 0 ? void 0 : params.paginationArgumentMinimum) !== null && _b !== void 0 ? _b : defaultPaginationArgumentMinimum;
-    const nodeCostLimit = (_c = params === null || params === void 0 ? void 0 : params.nodeCostLimit) !== null && _c !== void 0 ? _c : defaultNodeCostLimit;
+    const paginationArgumentMaximum = (_a = params === null || params === void 0 ? void 0 : params.paginationArgumentMaximum) !== null && _a !== void 0 ? _a : exports.defaultPaginationArgumentMaximum;
+    const paginationArgumentMinimum = (_b = params === null || params === void 0 ? void 0 : params.paginationArgumentMinimum) !== null && _b !== void 0 ? _b : exports.defaultPaginationArgumentMinimum;
+    const nodeCostLimit = (_c = params === null || params === void 0 ? void 0 : params.nodeCostLimit) !== null && _c !== void 0 ? _c : exports.defaultNodeCostLimit;
     const extensions = (_d = params === null || params === void 0 ? void 0 : params.extensions) !== null && _d !== void 0 ? _d : false;
     const nodeCostMap = new WeakMap();
     const handleResult = ({ result, args }) => {
@@ -152,9 +151,9 @@ const useResourceLimitations = (params) => {
     };
     return {
         onPluginInit({ addPlugin }) {
-            addPlugin(extendedValidation.useExtendedValidation({
+            addPlugin((0, extended_validation_1.useExtendedValidation)({
                 rules: [
-                    ResourceLimitationValidationRule({
+                    (0, exports.ResourceLimitationValidationRule)({
                         nodeCostLimit,
                         paginationArgumentMaximum,
                         paginationArgumentMinimum,
@@ -172,15 +171,10 @@ const useResourceLimitations = (params) => {
         onExecute({ args }) {
             return {
                 onExecuteDone(payload) {
-                    return core.handleStreamOrSingleExecutionResult(payload, ({ result }) => handleResult({ result, args }));
+                    return (0, core_1.handleStreamOrSingleExecutionResult)(payload, ({ result }) => handleResult({ result, args }));
                 },
             };
         },
     };
 };
-
-exports.ResourceLimitationValidationRule = ResourceLimitationValidationRule;
-exports.defaultNodeCostLimit = defaultNodeCostLimit;
-exports.defaultPaginationArgumentMaximum = defaultPaginationArgumentMaximum;
-exports.defaultPaginationArgumentMinimum = defaultPaginationArgumentMinimum;
 exports.useResourceLimitations = useResourceLimitations;

package/cjs/package.json

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

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

@@ -1,8 +1,7 @@
 import { handleStreamOrSingleExecutionResult } from '@envelop/core';
 import { useExtendedValidation } from '@envelop/extended-validation';
-import { GraphQLObjectType, GraphQLError, GraphQLList, GraphQLNonNull, GraphQLInt, isScalarType } from 'graphql';
+import { GraphQLError, GraphQLInt, GraphQLList, GraphQLNonNull, GraphQLObjectType, isScalarType, } from 'graphql';
 import { getArgumentValues } from '@graphql-tools/utils';
-
 const getWrappedType = (graphqlType) => {
     if (graphqlType instanceof GraphQLList || graphqlType instanceof GraphQLNonNull) {
         return getWrappedType(graphqlType.ofType);
@@ -32,13 +31,13 @@ const buildMissingPaginationFieldErrorMessage = (params) => `Missing pagination
     ' field argument.';
 const buildInvalidPaginationRangeErrorMessage = (params) => `Invalid pagination argument for field ${params.fieldName}. ` +
     `The value for the '${params.argumentName}' argument must be an integer within ${params.paginationArgumentMinimum}-${params.paginationArgumentMaximum}.`;
-const defaultNodeCostLimit = 500000;
-const defaultPaginationArgumentMaximum = 100;
-const defaultPaginationArgumentMinimum = 1;
+export const defaultNodeCostLimit = 500000;
+export const defaultPaginationArgumentMaximum = 100;
+export const defaultPaginationArgumentMinimum = 1;
 /**
  * Validate whether a user is allowed to execute a certain GraphQL operation.
  */
-const ResourceLimitationValidationRule = (params) => (context, executionArgs) => {
+export const ResourceLimitationValidationRule = (params) => (context, executionArgs) => {
     const { paginationArgumentMaximum, paginationArgumentMinimum } = params;
     const nodeCostStack = [];
     let totalNodeCost = 0;
@@ -128,7 +127,7 @@ const ResourceLimitationValidationRule = (params) => (context, executionArgs) =>
         },
     };
 };
-const useResourceLimitations = (params) => {
+export const useResourceLimitations = (params) => {
     var _a, _b, _c, _d;
     const paginationArgumentMaximum = (_a = params === null || params === void 0 ? void 0 : params.paginationArgumentMaximum) !== null && _a !== void 0 ? _a : defaultPaginationArgumentMaximum;
     const paginationArgumentMinimum = (_b = params === null || params === void 0 ? void 0 : params.paginationArgumentMinimum) !== null && _b !== void 0 ? _b : defaultPaginationArgumentMinimum;
@@ -174,5 +173,3 @@ const useResourceLimitations = (params) => {
         },
     };
 };
-
-export { ResourceLimitationValidationRule, defaultNodeCostLimit, defaultPaginationArgumentMaximum, defaultPaginationArgumentMinimum, useResourceLimitations };

package/package.json

@@ -1,38 +1,59 @@
 {
   "name": "@envelop/resource-limitations",
-  "version": "2.4.0-alpha-aca44e1.0",
+  "version": "2.4.0-alpha-385b86b.0",
   "description": "A rate-limit implementation based on resource limitations and static calculation of the score (similar to GitHub GraphQL API)",
   "sideEffects": false,
   "peerDependencies": {
-    "@envelop/core": "2.4.0-alpha-aca44e1.0",
+    "@envelop/core": "2.4.0-alpha-385b86b.0",
     "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "dependencies": {
-    "@envelop/extended-validation": "1.7.0-alpha-aca44e1.0",
+    "@envelop/extended-validation": "1.7.0-alpha-385b86b.0",
     "@graphql-tools/utils": "^8.6.1"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/dotansimha/envelop.git",
+    "url": "https://github.com/n1ru4l/envelop.git",
     "directory": "packages/plugins/resource-limitations"
   },
   "author": "Laurin Quast <laurinquast@googlemail.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}

@@ -41,5 +41,5 @@ declare type UseResourceLimitationsParams = {
      */
     extensions?: boolean;
 };
-export declare const useResourceLimitations: (params?: UseResourceLimitationsParams | undefined) => Plugin;
+export declare const useResourceLimitations: (params?: UseResourceLimitationsParams) => Plugin;
 export {};

package/README.md

@@ -1,29 +0,0 @@
-## `@envelop/resource-limitations`
-
-This plugins uses `extended-valiations` concept ([details here](https://github.com/dotansimha/envelop/tree/main/packages/plugins/extended-validation#envelopextended-validation)) for implemeting a resource-limitations rate-limit similar to GitHub GraphQL API (see https://docs.github.com/en/graphql/overview/resource-limitations for more details)
-
-## Getting Started
-
-```
-yarn add @envelop/resource-limitations
-```
-
-## Usage Example
-
-```ts
-import { envelop } from '@envelop/core';
-import { useResourceLimitations } from '@envelop/resource-limitations';
-
-const getEnveloped = envelop({
-  plugins: [
-    // ... other plugins ...
-    useResourceLimitations({
-      nodeCostLimit: 500000, // optional, default to 500000
-      paginationArgumentMaximum: 100, // optional, default to 100
-      paginationArgumentMinimum: 1, // optional, default to 1
-      paginationArgumentScalars: ['ConnectionInt'], // optional, use if connections use a different scalar type as the argument instead of `Int`
-      extensions: false, // set this to `true` in order to add the calculated const to the response of queries
-    }),
-  ],
-});
-```