@nest-boot/graphql-rate-limit 7.0.3 → 7.1.0

package/dist/complexities/connection.complexity.d.ts

@@ -1,2 +1,12 @@
 import { type Complexity } from "@nest-boot/graphql";
+/**
+ * Complexity estimator for connection fields (Relay-style pagination).
+ *
+ * @remarks
+ * Multiplies `childComplexity` by the page size (`first` or `last` argument),
+ * defaulting to 1 if neither is specified.
+ *
+ * @param options - The complexity estimator arguments
+ * @returns The calculated complexity value
+ */
 export declare const connectionComplexity: Complexity;

package/dist/complexities/connection.complexity.js

@@ -1,6 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.connectionComplexity = void 0;
+/**
+ * Complexity estimator for connection fields (Relay-style pagination).
+ *
+ * @remarks
+ * Multiplies `childComplexity` by the page size (`first` or `last` argument),
+ * defaulting to 1 if neither is specified.
+ *
+ * @param options - The complexity estimator arguments
+ * @returns The calculated complexity value
+ */
 const connectionComplexity = (options) => {
     return (Number(options.args.first ?? options.args.last ?? 1) *
         options.childComplexity);

package/dist/complexities/connection.complexity.js.map

@@ -1 +1 @@
-{"version":3,"file":"connection.complexity.js","sourceRoot":"","sources":["../../src/complexities/connection.complexity.ts"],"names":[],"mappings":";;;AAKO,MAAM,oBAAoB,GAAe,CAC9C,OAAgC,EAChC,EAAE;IACF,OAAO,CACL,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC;QACpD,OAAO,CAAC,eAAe,CACxB,CAAC;AACJ,CAAC,CAAC;AAPW,QAAA,oBAAoB,wBAO/B"}
+{"version":3,"file":"connection.complexity.js","sourceRoot":"","sources":["../../src/complexities/connection.complexity.ts"],"names":[],"mappings":";;;AAKA;;;;;;;;;GASG;AACI,MAAM,oBAAoB,GAAe,CAC9C,OAAgC,EAChC,EAAE;IACF,OAAO,CACL,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC;QACpD,OAAO,CAAC,eAAe,CACxB,CAAC;AACJ,CAAC,CAAC;AAPW,QAAA,oBAAoB,wBAO/B"}

package/dist/decorators/complexity.decorator.d.ts

@@ -1,5 +1,13 @@
+/** Options for the `@Complexity` decorator. */
 export interface ComplexityOptions {
+    /** Base complexity value for the field or resolver. */
     value?: number;
+    /** Argument names whose values multiply the complexity (e.g. `["first"]`). */
     multipliers?: string[];
 }
+/**
+ * Decorator that applies a `@complexity` directive to a GraphQL field or type.
+ * @param options - Complexity configuration options
+ * @returns A combined method, property, and class decorator
+ */
 export declare function Complexity(options: ComplexityOptions): MethodDecorator & PropertyDecorator & ClassDecorator;

package/dist/decorators/complexity.decorator.js

@@ -2,6 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Complexity = Complexity;
 const graphql_1 = require("@nest-boot/graphql");
+/**
+ * Decorator that applies a `@complexity` directive to a GraphQL field or type.
+ * @param options - Complexity configuration options
+ * @returns A combined method, property, and class decorator
+ */
 function Complexity(options) {
     return (0, graphql_1.Directive)(`@complexity(value: ${String(options.value ?? 1)}, multipliers: ${JSON.stringify(options.multipliers ?? [])})`);
 }

package/dist/decorators/complexity.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"complexity.decorator.js","sourceRoot":"","sources":["../../src/decorators/complexity.decorator.ts"],"names":[],"mappings":";;AAOA,gCAQC;AAfD,gDAA+C;AAO/C,SAAgB,UAAU,CACxB,OAA0B;IAE1B,OAAO,IAAA,mBAAS,EACd,sBAAsB,MAAM,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,kBAAkB,IAAI,CAAC,SAAS,CAC9E,OAAO,CAAC,WAAW,IAAI,EAAE,CAC1B,GAAG,CACL,CAAC;AACJ,CAAC"}
+{"version":3,"file":"complexity.decorator.js","sourceRoot":"","sources":["../../src/decorators/complexity.decorator.ts"],"names":[],"mappings":";;AAeA,gCAQC;AAvBD,gDAA+C;AAU/C;;;;GAIG;AACH,SAAgB,UAAU,CACxB,OAA0B;IAE1B,OAAO,IAAA,mBAAS,EACd,sBAAsB,MAAM,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,kBAAkB,IAAI,CAAC,SAAS,CAC9E,OAAO,CAAC,WAAW,IAAI,EAAE,CAC1B,GAAG,CACL,CAAC;AACJ,CAAC"}

package/dist/graphql-rate-limit.module-definition.d.ts

@@ -1,3 +1,17 @@
+/** Redis command name used by the rate limiter. */
 export declare const REDIS_COMMAND = "GRAPHQL_RATE_LIMIT";
+/** Injection token for the resolved GraphQL rate limit options. */
 export declare const OPTIONS_TOKEN: unique symbol;
-export declare const ConfigurableModuleClass: import("@nestjs/common").ConfigurableModuleCls<Partial<import("./interfaces").GraphQLRateLimitOptions>, "forRoot", "create", {}>, MODULE_OPTIONS_TOKEN: string | symbol, OPTIONS_TYPE: Partial<import("./interfaces").GraphQLRateLimitOptions> & Partial<{}>, ASYNC_OPTIONS_TYPE: import("@nestjs/common").ConfigurableModuleAsyncOptions<Partial<import("./interfaces").GraphQLRateLimitOptions>, "create"> & Partial<{}>;
+/**
+ * Module definition for the GraphQL rate limit module.
+ * @internal
+ */
+export declare const 
+/** @internal Base configurable module class. */
+ConfigurableModuleClass: import("@nestjs/common").ConfigurableModuleCls<Partial<import("./interfaces").GraphQLRateLimitOptions>, "forRoot", "create", {}>, 
+/** @internal Module options injection token. */
+MODULE_OPTIONS_TOKEN: string | symbol, 
+/** @internal Synchronous options type. */
+OPTIONS_TYPE: Partial<import("./interfaces").GraphQLRateLimitOptions> & Partial<{}>, 
+/** @internal Asynchronous options type. */
+ASYNC_OPTIONS_TYPE: import("@nestjs/common").ConfigurableModuleAsyncOptions<Partial<import("./interfaces").GraphQLRateLimitOptions>, "create"> & Partial<{}>;

package/dist/graphql-rate-limit.module-definition.js

@@ -3,9 +3,23 @@ var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ASYNC_OPTIONS_TYPE = exports.OPTIONS_TYPE = exports.MODULE_OPTIONS_TOKEN = exports.ConfigurableModuleClass = exports.OPTIONS_TOKEN = exports.REDIS_COMMAND = void 0;
 const common_1 = require("@nestjs/common");
+/** Redis command name used by the rate limiter. */
 exports.REDIS_COMMAND = "GRAPHQL_RATE_LIMIT";
+/** Injection token for the resolved GraphQL rate limit options. */
 exports.OPTIONS_TOKEN = Symbol("GraphQLRateLimitOptions");
+/**
+ * Module definition for the GraphQL rate limit module.
+ * @internal
+ */
 _a = new common_1.ConfigurableModuleBuilder()
     .setClassMethodName("forRoot")
-    .build(), exports.ConfigurableModuleClass = _a.ConfigurableModuleClass, exports.MODULE_OPTIONS_TOKEN = _a.MODULE_OPTIONS_TOKEN, exports.OPTIONS_TYPE = _a.OPTIONS_TYPE, exports.ASYNC_OPTIONS_TYPE = _a.ASYNC_OPTIONS_TYPE;
+    .build(), 
+/** @internal Base configurable module class. */
+exports.ConfigurableModuleClass = _a.ConfigurableModuleClass, 
+/** @internal Module options injection token. */
+exports.MODULE_OPTIONS_TOKEN = _a.MODULE_OPTIONS_TOKEN, 
+/** @internal Synchronous options type. */
+exports.OPTIONS_TYPE = _a.OPTIONS_TYPE, 
+/** @internal Asynchronous options type. */
+exports.ASYNC_OPTIONS_TYPE = _a.ASYNC_OPTIONS_TYPE;
 //# sourceMappingURL=graphql-rate-limit.module-definition.js.map

package/dist/graphql-rate-limit.module-definition.js.map

@@ -1 +1 @@
-{"version":3,"file":"graphql-rate-limit.module-definition.js","sourceRoot":"","sources":["../src/graphql-rate-limit.module-definition.ts"],"names":[],"mappings":";;;;AAAA,2CAA2D;AAI9C,QAAA,aAAa,GAAG,oBAAoB,CAAC;AAErC,QAAA,aAAa,GAAG,MAAM,CAAC,yBAAyB,CAAC,CAAC;AAElD,KAKT,IAAI,kCAAyB,EAAiC;KAC/D,kBAAkB,CAAC,SAAS,CAAC;KAC7B,KAAK,EAAE,EANR,+BAAuB,+BACvB,4BAAoB,4BACpB,oBAAY,oBACZ,0BAAkB,yBAGT"}
+{"version":3,"file":"graphql-rate-limit.module-definition.js","sourceRoot":"","sources":["../src/graphql-rate-limit.module-definition.ts"],"names":[],"mappings":";;;;AAAA,2CAA2D;AAI3D,mDAAmD;AACtC,QAAA,aAAa,GAAG,oBAAoB,CAAC;AAElD,mEAAmE;AACtD,QAAA,aAAa,GAAG,MAAM,CAAC,yBAAyB,CAAC,CAAC;AAE/D;;;GAGG;AACU,KAST,IAAI,kCAAyB,EAAiC;KAC/D,kBAAkB,CAAC,SAAS,CAAC;KAC7B,KAAK,EAAE;AAVR,gDAAgD;AAChD,+BAAuB;AACvB,gDAAgD;AAChD,4BAAoB;AACpB,0CAA0C;AAC1C,oBAAY;AACZ,2CAA2C;AAC3C,0BAAkB,yBAGT"}

package/dist/graphql-rate-limit.module.d.ts

@@ -1,3 +1,42 @@
-import { ConfigurableModuleClass } from "./graphql-rate-limit.module-definition";
-export declare class GraphQLRateLimitModule extends ConfigurableModuleClass {
+import { type DynamicModule, type OnApplicationShutdown } from "@nestjs/common";
+import Redis from "ioredis";
+import { ASYNC_OPTIONS_TYPE, ConfigurableModuleClass, OPTIONS_TYPE } from "./graphql-rate-limit.module-definition";
+/**
+ * GraphQL rate limiting module using Redis-backed leaky bucket algorithm.
+ *
+ * @remarks
+ * Provides query complexity analysis and rate limiting for GraphQL operations.
+ * Uses Redis for distributed rate limit state and supports custom ID extraction.
+ *
+ * The module automatically loads Redis connection from environment variables if not provided:
+ * - `REDIS_URL`: Full Redis connection URL (e.g., `redis://user:pass@host:6379/0`)
+ * - `REDIS_HOST`: Redis server hostname
+ * - `REDIS_PORT`: Redis server port
+ * - `REDIS_DB` or `REDIS_DATABASE`: Redis database number
+ * - `REDIS_USER` or `REDIS_USERNAME`: Redis username
+ * - `REDIS_PASS` or `REDIS_PASSWORD`: Redis password
+ * - `REDIS_TLS`: Enable TLS connection
+ */
+export declare class GraphQLRateLimitModule extends ConfigurableModuleClass implements OnApplicationShutdown {
+    private readonly redis;
+    /**
+     * Registers the GraphQLRateLimitModule with the given options.
+     * @param options - Configuration options including rate limit thresholds and Redis connection
+     * @returns Dynamic module configuration
+     */
+    static forRoot(options: typeof OPTIONS_TYPE): DynamicModule;
+    /**
+     * Registers the GraphQLRateLimitModule asynchronously with factory functions.
+     * @param options - Async configuration options
+     * @returns Dynamic module configuration
+     */
+    static forRootAsync(options: typeof ASYNC_OPTIONS_TYPE): DynamicModule;
+    /** Creates a new GraphQLRateLimitModule instance.
+     * @param redis - The ioredis client instance
+     */
+    constructor(redis: Redis);
+    /**
+     * Gracefully closes the Redis connection when the application shuts down.
+     */
+    onApplicationShutdown(): Promise<void>;
 }

package/dist/graphql-rate-limit.module.js

@@ -5,33 +5,88 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GraphQLRateLimitModule = void 0;
-const redis_1 = require("@nest-boot/redis");
 const common_1 = require("@nestjs/common");
+const ioredis_1 = __importDefault(require("ioredis"));
 const graphql_rate_limit_module_definition_1 = require("./graphql-rate-limit.module-definition");
 const graphql_rate_limit_plugin_1 = require("./graphql-rate-limit.plugin");
 const graphql_rate_limit_storage_1 = require("./graphql-rate-limit.storage");
+const load_config_from_env_util_1 = require("./utils/load-config-from-env.util");
+/**
+ * GraphQL rate limiting module using Redis-backed leaky bucket algorithm.
+ *
+ * @remarks
+ * Provides query complexity analysis and rate limiting for GraphQL operations.
+ * Uses Redis for distributed rate limit state and supports custom ID extraction.
+ *
+ * The module automatically loads Redis connection from environment variables if not provided:
+ * - `REDIS_URL`: Full Redis connection URL (e.g., `redis://user:pass@host:6379/0`)
+ * - `REDIS_HOST`: Redis server hostname
+ * - `REDIS_PORT`: Redis server port
+ * - `REDIS_DB` or `REDIS_DATABASE`: Redis database number
+ * - `REDIS_USER` or `REDIS_USERNAME`: Redis username
+ * - `REDIS_PASS` or `REDIS_PASSWORD`: Redis password
+ * - `REDIS_TLS`: Enable TLS connection
+ */
 let GraphQLRateLimitModule = class GraphQLRateLimitModule extends graphql_rate_limit_module_definition_1.ConfigurableModuleClass {
+    /**
+     * Registers the GraphQLRateLimitModule with the given options.
+     * @param options - Configuration options including rate limit thresholds and Redis connection
+     * @returns Dynamic module configuration
+     */
+    static forRoot(options) {
+        return super.forRoot(options);
+    }
+    /**
+     * Registers the GraphQLRateLimitModule asynchronously with factory functions.
+     * @param options - Async configuration options
+     * @returns Dynamic module configuration
+     */
+    static forRootAsync(options) {
+        return super.forRootAsync(options);
+    }
+    /** Creates a new GraphQLRateLimitModule instance.
+     * @param redis - The ioredis client instance
+     */
+    constructor(redis) {
+        super();
+        this.redis = redis;
+    }
+    /**
+     * Gracefully closes the Redis connection when the application shuts down.
+     */
+    async onApplicationShutdown() {
+        await this.redis.quit();
+    }
 };
 exports.GraphQLRateLimitModule = GraphQLRateLimitModule;
 exports.GraphQLRateLimitModule = GraphQLRateLimitModule = __decorate([
     (0, common_1.Global)(),
     (0, common_1.Module)({
-        imports: [
-            redis_1.RedisModule.registerAsync({
-                inject: [graphql_rate_limit_module_definition_1.OPTIONS_TOKEN],
-                useFactory: (options) => options.connection ?? {},
-            }),
-        ],
         providers: [
             graphql_rate_limit_plugin_1.GraphQLRateLimitPlugin,
             graphql_rate_limit_storage_1.GraphQLRateLimitStorage,
+            {
+                provide: ioredis_1.default,
+                inject: [graphql_rate_limit_module_definition_1.OPTIONS_TOKEN],
+                useFactory: (options) => new ioredis_1.default({
+                    ...(0, load_config_from_env_util_1.loadConfigFromEnv)(),
+                    ...options.connection,
+                }),
+            },
             {
                 provide: graphql_rate_limit_module_definition_1.OPTIONS_TOKEN,
                 inject: [{ token: graphql_rate_limit_module_definition_1.MODULE_OPTIONS_TOKEN, optional: true }],
                 useFactory: (options) => {
                     return {
+                        connection: options?.connection,
                         maxComplexity: options?.maxComplexity ?? 1000,
                         defaultComplexity: options?.defaultComplexity ?? 0,
                         keyPrefix: options?.keyPrefix ?? "graphql-rate-limit",
@@ -51,6 +106,7 @@ exports.GraphQLRateLimitModule = GraphQLRateLimitModule = __decorate([
             },
         ],
         exports: [graphql_rate_limit_module_definition_1.OPTIONS_TOKEN],
-    })
+    }),
+    __metadata("design:paramtypes", [ioredis_1.default])
 ], GraphQLRateLimitModule);
 //# sourceMappingURL=graphql-rate-limit.module.js.map

package/dist/graphql-rate-limit.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"graphql-rate-limit.module.js","sourceRoot":"","sources":["../src/graphql-rate-limit.module.ts"],"names":[],"mappings":";;;;;;;;;AACA,4CAA+C;AAC/C,2CAAgD;AAGhD,iGAIgD;AAChD,2EAAqE;AACrE,6EAAuE;AAkDhE,IAAM,sBAAsB,GAA5B,MAAM,sBAAuB,SAAQ,8DAAuB;CAAG,CAAA;AAAzD,wDAAsB;iCAAtB,sBAAsB;IA5ClC,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC;QACN,OAAO,EAAE;YACP,mBAAW,CAAC,aAAa,CAAC;gBACxB,MAAM,EAAE,CAAC,oDAAa,CAAC;gBACvB,UAAU,EAAE,CAAC,OAAgC,EAAE,EAAE,CAC/C,OAAO,CAAC,UAAU,IAAI,EAAE;aAC3B,CAAC;SACH;QACD,SAAS,EAAE;YACT,kDAAsB;YACtB,oDAAuB;YACvB;gBACE,OAAO,EAAE,oDAAa;gBACtB,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,2DAAoB,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;gBACzD,UAAU,EAAE,CACV,OAAuC,EACd,EAAE;oBAC3B,OAAO;wBACL,aAAa,EAAE,OAAO,EAAE,aAAa,IAAI,IAAI;wBAC7C,iBAAiB,EAAE,OAAO,EAAE,iBAAiB,IAAI,CAAC;wBAClD,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,oBAAoB;wBACrD,WAAW,EAAE,OAAO,EAAE,WAAW,IAAI,EAAE;wBACvC,gBAAgB,EAAE,OAAO,EAAE,gBAAgB,IAAI,IAAI;wBACnD,KAAK,EACH,OAAO,EAAE,KAAK;4BACd,CAAC,CAAC,IAAwC,EAAE,EAAE;gCAC5C,MAAM,GAAG,GAAI,IAAI,CAAC,YAAiC,CAAC,GAAG,CAAC;gCACxD,MAAM,EAAE,GAAG,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;gCAEhD,IAAI,OAAO,EAAE,KAAK,WAAW,EAAE,CAAC;oCAC9B,MAAM,IAAI,KAAK,CACb,8LAA8L,CAC/L,CAAC;gCACJ,CAAC;gCAED,OAAO,EAAE,CAAC;4BACZ,CAAC,CAAC;qBACL,CAAC;gBACJ,CAAC;aACF;SACF;QACD,OAAO,EAAE,CAAC,oDAAa,CAAC;KACzB,CAAC;GACW,sBAAsB,CAAmC"}
+{"version":3,"file":"graphql-rate-limit.module.js","sourceRoot":"","sources":["../src/graphql-rate-limit.module.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,2CAKwB;AAExB,sDAA4B;AAE5B,iGAMgD;AAChD,2EAAqE;AACrE,6EAAuE;AAKvE,iFAAsE;AAEtE;;;;;;;;;;;;;;;GAeG;AAgDI,IAAM,sBAAsB,GAA5B,MAAM,sBACX,SAAQ,8DAAuB;IAG/B;;;;OAIG;IACH,MAAM,CAAU,OAAO,CAAC,OAA4B;QAClD,OAAO,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAU,YAAY,CAC1B,OAAkC;QAElC,OAAO,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC;IAED;;OAEG;IACH,YAA6B,KAAY;QACvC,KAAK,EAAE,CAAC;QADmB,UAAK,GAAL,KAAK,CAAO;IAEzC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,qBAAqB;QACzB,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IAC1B,CAAC;CACF,CAAA;AArCY,wDAAsB;iCAAtB,sBAAsB;IA/ClC,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC;QACN,SAAS,EAAE;YACT,kDAAsB;YACtB,oDAAuB;YACvB;gBACE,OAAO,EAAE,iBAAK;gBACd,MAAM,EAAE,CAAC,oDAAa,CAAC;gBACvB,UAAU,EAAE,CAAC,OAAgC,EAAE,EAAE,CAC/C,IAAI,iBAAK,CAAC;oBACR,GAAG,IAAA,6CAAiB,GAAE;oBACtB,GAAG,OAAO,CAAC,UAAU;iBACtB,CAAC;aACL;YACD;gBACE,OAAO,EAAE,oDAAa;gBACtB,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,2DAAoB,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;gBACzD,UAAU,EAAE,CACV,OAAuC,EACd,EAAE;oBAC3B,OAAO;wBACL,UAAU,EAAE,OAAO,EAAE,UAAU;wBAC/B,aAAa,EAAE,OAAO,EAAE,aAAa,IAAI,IAAI;wBAC7C,iBAAiB,EAAE,OAAO,EAAE,iBAAiB,IAAI,CAAC;wBAClD,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,oBAAoB;wBACrD,WAAW,EAAE,OAAO,EAAE,WAAW,IAAI,EAAE;wBACvC,gBAAgB,EAAE,OAAO,EAAE,gBAAgB,IAAI,IAAI;wBACnD,KAAK,EACH,OAAO,EAAE,KAAK;4BACd,CAAC,CAAC,IAAwC,EAAE,EAAE;gCAC5C,MAAM,GAAG,GAAI,IAAI,CAAC,YAAiC,CAAC,GAAG,CAAC;gCACxD,MAAM,EAAE,GAAG,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;gCAEhD,IAAI,OAAO,EAAE,KAAK,WAAW,EAAE,CAAC;oCAC9B,MAAM,IAAI,KAAK,CACb,8LAA8L,CAC/L,CAAC;gCACJ,CAAC;gCAED,OAAO,EAAE,CAAC;4BACZ,CAAC,CAAC;qBACL,CAAC;gBACJ,CAAC;aACF;SACF;QACD,OAAO,EAAE,CAAC,oDAAa,CAAC;KACzB,CAAC;qCA4BoC,iBAAK;GA3B9B,sBAAsB,CAqClC"}

package/dist/graphql-rate-limit.plugin.js

@@ -23,19 +23,19 @@ function shopifyEstimator(args, type) {
     if (type instanceof graphql_2.GraphQLNonNull || type instanceof graphql_2.GraphQLList) {
         return shopifyEstimator(args, type.ofType);
     }
-    // GraphQL 的 Connection 表示的是一对多的关系，Connection 的消耗是两点加上要返回的对象数量。
+    // A GraphQL Connection represents a one-to-many relationship. The cost is two points plus the number of objects to return.
     if (type instanceof graphql_2.GraphQLObjectType && type.name.endsWith("Connection")) {
         return 2 + args.childComplexity * (args.args.first ?? args.args.last ?? 0);
     }
-    // Object 是查询的基本单位，一般代码一个单次的 server 端操作，可以是一次数据库查询，也可以一次内部服务的访问。
-    // Interface 和 Union 和 Object 类似，只不过是能返回不同类型的 object，所以算一点。
+    // An Object is the basic unit of a query, generally representing a single server-side operation such as a database query or an internal service call.
+    // Interface and Union are similar to Object but can return different types of objects, so they cost one point.
     if (type instanceof graphql_2.GraphQLObjectType ||
         type instanceof graphql_2.GraphQLInterfaceType ||
         type instanceof graphql_2.GraphQLUnionType) {
         return 1 + args.childComplexity;
     }
-    // Scalar 和 Enum 是 Object 本身的一部分，在 Object 里我们已经算过消耗了。
-    // Scalar 和 Enum 其实就是 Object 上的某个字段，一个 Object 上多返回几个字段消耗是比较少的。
+    // Scalar and Enum are part of the Object itself; we've already counted their cost in the Object.
+    // They are just fields on an Object, and returning a few extra fields costs relatively little.
     if (type instanceof graphql_2.GraphQLScalarType || type instanceof graphql_2.GraphQLEnumType) {
         return 0;
     }

package/dist/graphql-rate-limit.plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"graphql-rate-limit.plugin.js","sourceRoot":"","sources":["../src/graphql-rate-limit.plugin.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;;;;;;;;;;AAQrD,gDAAuD;AACvD,2CAAwC;AACxC,2CAA+C;AAE/C,qCASiB;AACjB,uEAOkC;AAElC,6EAAuE;AAGvE,sFAAsF;AACtF,SAAS,gBAAgB,CACvB,IAA6B,EAC7B,IAAkB;IAElB,IAAI,GAAG,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;IAE/B,IAAI,IAAI,YAAY,wBAAc,IAAI,IAAI,YAAY,qBAAW,EAAE,CAAC;QAClE,OAAO,gBAAgB,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC;IAED,+DAA+D;IAC/D,IAAI,IAAI,YAAY,2BAAiB,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;QAC1E,OAAO,CAAC,GAAG,IAAI,CAAC,eAAe,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC;IAC7E,CAAC;IAED,gEAAgE;IAChE,2DAA2D;IAC3D,IACE,IAAI,YAAY,2BAAiB;QACjC,IAAI,YAAY,8BAAoB;QACpC,IAAI,YAAY,0BAAgB,EAChC,CAAC;QACD,OAAO,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC;IAClC,CAAC;IAED,qDAAqD;IACrD,8DAA8D;IAC9D,IAAI,IAAI,YAAY,2BAAiB,IAAI,IAAI,YAAY,yBAAe,EAAE,CAAC;QACzE,OAAO,CAAC,CAAC;IACX,CAAC;AACH,CAAC;AAGM,IAAM,sBAAsB,GAA5B,MAAM,sBAAsB;IAajC,YACmB,OAAgC,EAChC,aAAgC;QADhC,YAAO,GAAP,OAAO,CAAyB;QAChC,kBAAa,GAAb,aAAa,CAAmB;QAdlC,yBAAoB,GAA0B,EAAE,CAAC;QAEjD,kBAAa,GAAW,IAAI,CAAC;QAC7B,sBAAiB,GAAW,CAAC,CAAC;QAE9B,mBAAc,GAAG,CAChC,IAAwC,EACxC,EAAE;YACF,MAAM,GAAG,GAAI,IAAI,CAAC,YAAiC,CAAC,GAAG,CAAC;YACxD,OAAO,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;QAC9C,CAAC,CAAC;QAMA,IAAI,CAAC,oBAAoB,GAAG;YAC1B,IAAA,6CAAkB,GAAE;YACpB,IAAA,mDAAwB,GAAE;YAC1B,gBAAgB;YAChB,IAAA,0CAAe,EAAC,EAAE,iBAAiB,EAAE,IAAI,CAAC,iBAAiB,EAAE,CAAC;SAC/D,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,eAAe;QACnB,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC;QAEtC,MAAM,IAAI,GAAiB;YACzB,kBAAkB,EAAE,CAAC;YACrB,eAAe,EAAE,CAAC;SACnB,CAAC;QAEF,OAAO;YACL,mBAAmB,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;gBAClC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;gBAEnC,IAAI,CAAC,kBAAkB,GAAG,IAAA,wCAAa,EAAC;oBACtC,MAAM;oBACN,aAAa,EAAE,OAAO,CAAC,aAAa;oBACpC,KAAK,EAAE,QAAQ;oBACf,SAAS,EAAE,OAAO,CAAC,SAAS;oBAC5B,UAAU,EAAE,IAAI,CAAC,oBAAoB;iBACtC,CAAC,CAAC;gBAEH,IAAI,IAAI,CAAC,kBAAkB,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;oBAClD,MAAM,IAAI,sBAAa,CACrB,yBAAyB,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,iCAAiC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,EACrH,GAAG,CACJ,CAAC;gBACJ,CAAC;gBAED,MAAM,EAAE,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,WAAW,EAAE,GAClE,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;gBAE7D,IAAI,CAAC,cAAc,GAAG;oBACpB,OAAO;oBACP,gBAAgB;oBAChB,kBAAkB;oBAClB,WAAW;iBACZ,CAAC;gBAEF,IAAI,OAAO,EAAE,CAAC;oBACZ,MAAM,IAAI,sBAAa,CAAC,mBAAmB,EAAE,GAAG,CAAC,CAAC;gBACpD,CAAC;YACH,CAAC;YACD,iBAAiB,EAAE,KAAK,IAAI,EAAE;gBAC5B,OAAO;oBACL,gBAAgB,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE;wBAC7B,MAAM,gBAAgB,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,CAAC;wBACrD,MAAM,KAAK,GAAG,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;wBAE/C,MAAM,aAAa,GAA4B;4BAC7C,eAAe,EAAE,CAAC;4BAClB,IAAI,EAAE,EAAE;4BACR,KAAK;4BACL,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;4BACxB,IAAI,EAAE,IAAI,CAAC,UAAU;yBACtB,CAAC;wBAEF,OAAO,CAAC,KAAK,EAAE,EAAE;4BACf,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gCACnB,mEAAmE;gCACnE,IAAI,SAAwB,CAAC;gCAE7B,KAAK,MAAM,mBAAmB,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;oCAC5D,SAAS,GAAG,mBAAmB,CAAC,aAAa,CAAC,CAAC;oCAE/C,IAAI,OAAO,SAAS,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;wCACvD,IAAI,CAAC,eAAe,IAAI,SAAS,CAAC;wCAClC,MAAM;oCACR,CAAC;gCACH,CAAC;4BACH,CAAC;wBACH,CAAC,CAAC;oBACJ,CAAC;iBACF,CAAC;YACJ,CAAC;YACD,gBAAgB,EAAE,KAAK,EAAE,OAAO,EAAiB,EAAE;gBACjD,IACE,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ;oBACvC,MAAM,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,EAC5C,CAAC;oBACD,MAAM,EAAE,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,WAAW,EAAE,GAClE,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CACzB,OAAO,EACP,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,eAAe,CAC/C,CAAC;oBAEJ,IAAI,CAAC,cAAc,GAAG;wBACpB,OAAO;wBACP,gBAAgB;wBAChB,kBAAkB;wBAClB,WAAW;qBACZ,CAAC;oBAEF,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU,GAAG;wBAC9C,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU;wBAChD,IAAI;qBACL,CAAC;gBACJ,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAA;AA5HY,wDAAsB;iCAAtB,sBAAsB;IADlC,IAAA,eAAM,GAAE;qCAeqB,oDAAuB;QACjB,2BAAiB;GAfxC,sBAAsB,CA4HlC"}
+{"version":3,"file":"graphql-rate-limit.plugin.js","sourceRoot":"","sources":["../src/graphql-rate-limit.plugin.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;;;;;;;;;;AAQrD,gDAAuD;AACvD,2CAAwC;AACxC,2CAA+C;AAE/C,qCASiB;AACjB,uEAOkC;AAElC,6EAAuE;AAGvE,sFAAsF;AACtF,SAAS,gBAAgB,CACvB,IAA6B,EAC7B,IAAkB;IAElB,IAAI,GAAG,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;IAE/B,IAAI,IAAI,YAAY,wBAAc,IAAI,IAAI,YAAY,qBAAW,EAAE,CAAC;QAClE,OAAO,gBAAgB,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC;IAED,2HAA2H;IAC3H,IAAI,IAAI,YAAY,2BAAiB,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;QAC1E,OAAO,CAAC,GAAG,IAAI,CAAC,eAAe,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC;IAC7E,CAAC;IAED,sJAAsJ;IACtJ,+GAA+G;IAC/G,IACE,IAAI,YAAY,2BAAiB;QACjC,IAAI,YAAY,8BAAoB;QACpC,IAAI,YAAY,0BAAgB,EAChC,CAAC;QACD,OAAO,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC;IAClC,CAAC;IAED,iGAAiG;IACjG,+FAA+F;IAC/F,IAAI,IAAI,YAAY,2BAAiB,IAAI,IAAI,YAAY,yBAAe,EAAE,CAAC;QACzE,OAAO,CAAC,CAAC;IACX,CAAC;AACH,CAAC;AAGM,IAAM,sBAAsB,GAA5B,MAAM,sBAAsB;IAajC,YACmB,OAAgC,EAChC,aAAgC;QADhC,YAAO,GAAP,OAAO,CAAyB;QAChC,kBAAa,GAAb,aAAa,CAAmB;QAdlC,yBAAoB,GAA0B,EAAE,CAAC;QAEjD,kBAAa,GAAW,IAAI,CAAC;QAC7B,sBAAiB,GAAW,CAAC,CAAC;QAE9B,mBAAc,GAAG,CAChC,IAAwC,EACxC,EAAE;YACF,MAAM,GAAG,GAAI,IAAI,CAAC,YAAiC,CAAC,GAAG,CAAC;YACxD,OAAO,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;QAC9C,CAAC,CAAC;QAMA,IAAI,CAAC,oBAAoB,GAAG;YAC1B,IAAA,6CAAkB,GAAE;YACpB,IAAA,mDAAwB,GAAE;YAC1B,gBAAgB;YAChB,IAAA,0CAAe,EAAC,EAAE,iBAAiB,EAAE,IAAI,CAAC,iBAAiB,EAAE,CAAC;SAC/D,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,eAAe;QACnB,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC;QAEtC,MAAM,IAAI,GAAiB;YACzB,kBAAkB,EAAE,CAAC;YACrB,eAAe,EAAE,CAAC;SACnB,CAAC;QAEF,OAAO;YACL,mBAAmB,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;gBAClC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;gBAEnC,IAAI,CAAC,kBAAkB,GAAG,IAAA,wCAAa,EAAC;oBACtC,MAAM;oBACN,aAAa,EAAE,OAAO,CAAC,aAAa;oBACpC,KAAK,EAAE,QAAQ;oBACf,SAAS,EAAE,OAAO,CAAC,SAAS;oBAC5B,UAAU,EAAE,IAAI,CAAC,oBAAoB;iBACtC,CAAC,CAAC;gBAEH,IAAI,IAAI,CAAC,kBAAkB,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;oBAClD,MAAM,IAAI,sBAAa,CACrB,yBAAyB,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,iCAAiC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,EACrH,GAAG,CACJ,CAAC;gBACJ,CAAC;gBAED,MAAM,EAAE,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,WAAW,EAAE,GAClE,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;gBAE7D,IAAI,CAAC,cAAc,GAAG;oBACpB,OAAO;oBACP,gBAAgB;oBAChB,kBAAkB;oBAClB,WAAW;iBACZ,CAAC;gBAEF,IAAI,OAAO,EAAE,CAAC;oBACZ,MAAM,IAAI,sBAAa,CAAC,mBAAmB,EAAE,GAAG,CAAC,CAAC;gBACpD,CAAC;YACH,CAAC;YACD,iBAAiB,EAAE,KAAK,IAAI,EAAE;gBAC5B,OAAO;oBACL,gBAAgB,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE;wBAC7B,MAAM,gBAAgB,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,CAAC;wBACrD,MAAM,KAAK,GAAG,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;wBAE/C,MAAM,aAAa,GAA4B;4BAC7C,eAAe,EAAE,CAAC;4BAClB,IAAI,EAAE,EAAE;4BACR,KAAK;4BACL,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;4BACxB,IAAI,EAAE,IAAI,CAAC,UAAU;yBACtB,CAAC;wBAEF,OAAO,CAAC,KAAK,EAAE,EAAE;4BACf,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gCACnB,mEAAmE;gCACnE,IAAI,SAAwB,CAAC;gCAE7B,KAAK,MAAM,mBAAmB,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;oCAC5D,SAAS,GAAG,mBAAmB,CAAC,aAAa,CAAC,CAAC;oCAE/C,IAAI,OAAO,SAAS,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;wCACvD,IAAI,CAAC,eAAe,IAAI,SAAS,CAAC;wCAClC,MAAM;oCACR,CAAC;gCACH,CAAC;4BACH,CAAC;wBACH,CAAC,CAAC;oBACJ,CAAC;iBACF,CAAC;YACJ,CAAC;YACD,gBAAgB,EAAE,KAAK,EAAE,OAAO,EAAiB,EAAE;gBACjD,IACE,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ;oBACvC,MAAM,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,EAC5C,CAAC;oBACD,MAAM,EAAE,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,WAAW,EAAE,GAClE,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CACzB,OAAO,EACP,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,eAAe,CAC/C,CAAC;oBAEJ,IAAI,CAAC,cAAc,GAAG;wBACpB,OAAO;wBACP,gBAAgB;wBAChB,kBAAkB;wBAClB,WAAW;qBACZ,CAAC;oBAEF,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU,GAAG;wBAC9C,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU;wBAChD,IAAI;qBACL,CAAC;gBACJ,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAA;AA5HY,wDAAsB;iCAAtB,sBAAsB;IADlC,IAAA,eAAM,GAAE;qCAeqB,oDAAuB;QACjB,2BAAiB;GAfxC,sBAAsB,CA4HlC"}

package/dist/graphql-rate-limit.storage.js

@@ -26,47 +26,47 @@ let GraphQLRateLimitStorage = class GraphQLRateLimitStorage {
         this.redis.defineCommand(graphql_rate_limit_module_definition_1.REDIS_COMMAND, {
             numberOfKeys: 5,
             lua: /* lua */ `
-        -- 获取当前时间戳
+        -- Get current timestamp
         local currentTimestamp = redis.call("TIME")[1]
         
-        -- 获取参数
+        -- Get arguments
         local bucketKeyPrefix = KEYS[1]
         local maximumAvailable = tonumber(KEYS[2])
         local restoreRate = tonumber(KEYS[3])
         local id = KEYS[4]
         local complexity = tonumber(KEYS[5])
         
-        -- 定义存储桶的键
+        -- Define the bucket key
         local bucketKey = bucketKeyPrefix .. ":" .. id
         
         local keyExpireSeconds = math.ceil(maximumAvailable / restoreRate)
         
-        -- 获取存储桶中当前的令牌数量，如果不存在，则设置为最大可用令牌数
+        -- Get the current number of tokens in the bucket; if it doesn't exist, set to max available
         local currentlyAvailable = redis.call("HGET", bucketKey, "currentlyAvailable")
         if not currentlyAvailable then
           currentlyAvailable = maximumAvailable
         end
         
-        -- 如果存储桶为空，设置上次更新时间戳为当前时间戳
+        -- If the bucket is empty, set the last updated timestamp to the current timestamp
         local updatedTimestamp = redis.call("HGET", bucketKey, "updatedTimestamp")
         if not updatedTimestamp then
           updatedTimestamp = currentTimestamp
         end
         
-        -- 更新上次更新的时间戳
+        -- Update the last updated timestamp
         redis.call("HSET", bucketKey, "updatedTimestamp", currentTimestamp)
         
-        -- 更新存储桶的过期时间
+        -- Update the bucket's expiration time
         redis.call("EXPIRE", bucketKey, keyExpireSeconds)
         
-        -- 计算自上次更新以来要恢复的令牌数量，并恢复存储桶中的令牌数量
+        -- Calculate the number of tokens to restore since the last update, and restore tokens in the bucket
         local intervalSeconds = currentTimestamp - updatedTimestamp;
         if intervalSeconds > 0 then
           currentlyAvailable = math.min((restoreRate * intervalSeconds) + currentlyAvailable, maximumAvailable);
           redis.call("HSET", bucketKey, "currentlyAvailable", currentlyAvailable)
         end
         
-        -- 检查是否有足够的令牌供扣减，如果有，则扣减并返回剩余令牌数
+        -- Check if there are enough tokens to deduct; if so, deduct and return the remaining tokens
         local newCurrentlyAvailable = currentlyAvailable - complexity
         if newCurrentlyAvailable >= 0 then
           currentlyAvailable = newCurrentlyAvailable

package/dist/interfaces/cost-response.interface.d.ts

@@ -1,11 +1,20 @@
+/** Throttle status information for rate-limited queries. */
 export interface CostThrottleStatus {
+    /** Whether the request is currently blocked due to rate limiting. */
     blocked: boolean;
+    /** Maximum cost budget available. */
     maximumAvailable: number;
+    /** Remaining cost budget currently available. */
     currentlyAvailable: number;
+    /** Rate at which cost budget restores (points per second). */
     restoreRate: number;
 }
+/** Response containing query cost and throttle status information. */
 export interface CostResponse {
+    /** The estimated cost of the query before execution. */
     requestedQueryCost: number;
+    /** The actual cost of the query after execution. */
     actualQueryCost: number;
+    /** Current throttle status, if rate limiting is active. */
     throttleStatus?: CostThrottleStatus;
 }

package/dist/interfaces/graphql-rate-limit-module-options.interface.d.ts

@@ -1,2 +1,3 @@
 import { GraphQLRateLimitOptions } from "./graphql-rate-limit-options.interface";
+/** Module-level configuration options for GraphQL rate limiting (all fields optional). */
 export type GraphQLRateLimitModuleOptions = Partial<GraphQLRateLimitOptions>;

package/dist/interfaces/graphql-rate-limit-options.interface.d.ts

@@ -1,11 +1,19 @@
 import { BaseContext, GraphQLRequestContext } from "@apollo/server";
 import { RedisOptions } from "ioredis";
+/** Configuration options for GraphQL rate limiting. */
 export interface GraphQLRateLimitOptions {
+    /** Redis connection options for rate limit state storage. */
     connection?: RedisOptions;
+    /** Maximum allowed query complexity per request. */
     maxComplexity: number;
+    /** Default complexity assigned to fields without explicit `@complexity` directives. */
     defaultComplexity: number;
+    /** Redis key prefix for rate limit state. */
     keyPrefix: string;
+    /** Rate at which cost budget restores (points per second). */
     restoreRate: number;
+    /** Maximum cost budget available per client. */
     maximumAvailable: number;
+    /** Function to extract a unique client identifier from the request context. */
     getId: (args: GraphQLRequestContext<BaseContext>) => string;
 }