stellate 3.0.4 → 3.2.0

package/dist/index.d.ts

@@ -231,7 +231,7 @@ declare const inputSchema: z.ZodObject<{
         definition?: string | ((args_0: {
             headers: Record<string, string | string[]>;
             cookies: Record<string, string>;
-        }, ...args_1: unknown[]) => string | null) | null | undefined;
+        }, ...args: unknown[]) => string | null) | null | undefined;
         jwt?: {
             claim?: string | null | undefined;
             algorithm?: "HS256" | "HS384" | "HS512" | "RS256" | "RS384" | "RS512" | "ES256" | "ES384" | "ES256k" | "EdDSA" | "PS256" | "PS384" | "PS512" | null | undefined;
@@ -241,7 +241,7 @@ declare const inputSchema: z.ZodObject<{
         definition?: string | ((args_0: {
             headers: Record<string, string | string[]>;
             cookies: Record<string, string>;
-        }, ...args_1: unknown[]) => string | null) | null | undefined;
+        }, ...args: unknown[]) => string | null) | null | undefined;
         jwt?: {
             claim?: string | null | undefined;
             algorithm?: "HS256" | "HS384" | "HS512" | "RS256" | "RS384" | "RS512" | "ES256" | "ES384" | "ES256k" | "EdDSA" | "PS256" | "PS384" | "PS512" | null | undefined;
@@ -1014,11 +1014,11 @@ declare const inputSchema: z.ZodObject<{
     scopes?: Record<string, string | ((args_0: {
         headers: Record<string, string | string[]>;
         cookies: Record<string, string>;
-    }, ...args_1: unknown[]) => string | null) | {
+    }, ...args: unknown[]) => string | null) | {
         definition?: string | ((args_0: {
             headers: Record<string, string | string[]>;
             cookies: Record<string, string>;
-        }, ...args_1: unknown[]) => string | null) | null | undefined;
+        }, ...args: unknown[]) => string | null) | null | undefined;
         jwt?: {
             claim?: string | null | undefined;
             algorithm?: "HS256" | "HS384" | "HS512" | "RS256" | "RS384" | "RS512" | "ES256" | "ES384" | "ES256k" | "EdDSA" | "PS256" | "PS384" | "PS512" | null | undefined;
@@ -1251,11 +1251,11 @@ declare const inputSchema: z.ZodObject<{
     scopes?: Record<string, string | ((args_0: {
         headers: Record<string, string | string[]>;
         cookies: Record<string, string>;
-    }, ...args_1: unknown[]) => string | null) | {
+    }, ...args: unknown[]) => string | null) | {
         definition?: string | ((args_0: {
             headers: Record<string, string | string[]>;
             cookies: Record<string, string>;
-        }, ...args_1: unknown[]) => string | null) | null | undefined;
+        }, ...args: unknown[]) => string | null) | null | undefined;
         jwt?: {
             claim?: string | null | undefined;
             algorithm?: "HS256" | "HS384" | "HS512" | "RS256" | "RS384" | "RS512" | "ES256" | "ES384" | "ES256k" | "EdDSA" | "PS256" | "PS384" | "PS512" | null | undefined;
@@ -2091,4 +2091,4 @@ type Config = {
 };
 declare const createConfig: (input: Partial<Input>) => Input;
 
-export { ComplexityConfig, ComplexityLimit, Config, ConfigFunction, EdgeRequest, Input, RateLimitConfig, RateLimitRule, RateLimitRules, RequestLimit, ScopeContext, ScopeFunctionDefinition, TimeWindow, createConfig as default };
+export { type ComplexityConfig, type ComplexityLimit, type Config, type ConfigFunction, type EdgeRequest, type Input, type RateLimitConfig, type RateLimitRule, type RateLimitRules, type RequestLimit, type ScopeContext, type ScopeFunctionDefinition, type TimeWindow, createConfig as default };

package/dist/index.js

@@ -1 +1 @@
-"use strict";var o=Object.defineProperty;var m=Object.getOwnPropertyDescriptor;var p=Object.getOwnPropertyNames;var g=Object.prototype.hasOwnProperty;var a=(i,t)=>{for(var e in t)o(i,e,{get:t[e],enumerable:!0})},f=(i,t,e,r)=>{if(t&&typeof t=="object"||typeof t=="function")for(let n of p(t))!g.call(i,n)&&n!==e&&o(i,n,{get:()=>t[n],enumerable:!(r=m(t,n))||r.enumerable});return i};var u=i=>f(o({},"__esModule",{value:!0}),i);var l={};a(l,{default:()=>s});module.exports=u(l);var c=i=>i,s=c;0&&(module.exports={});
+"use strict";var o=Object.defineProperty;var m=Object.getOwnPropertyDescriptor;var p=Object.getOwnPropertyNames;var g=Object.prototype.hasOwnProperty;var a=(i,t)=>{for(var e in t)o(i,e,{get:t[e],enumerable:!0})},f=(i,t,e,r)=>{if(t&&typeof t=="object"||typeof t=="function")for(let n of p(t))!g.call(i,n)&&n!==e&&o(i,n,{get:()=>t[n],enumerable:!(r=m(t,n))||r.enumerable});return i};var u=i=>f(o({},"__esModule",{value:!0}),i);var l={};a(l,{default:()=>s});module.exports=u(l);var c=i=>i,s=c;

package/dist/rate-limiting.d.mts

@@ -0,0 +1,69 @@
+type TimeWindow = `${number}${'s' | 'm' | 'h'}` | {
+    value: number;
+    unit: 'seconds' | 'minutes' | 'hours';
+};
+interface EdgeRequest {
+    method: string;
+    path: string;
+    queryString: string;
+    queryParams: Record<string, string | string[]>;
+    headers: Record<string, string | string[]>;
+    ip: string;
+    jwt: Record<string, unknown> | null;
+    operation: 'query' | 'mutation' | 'subscription';
+    rootFields: {
+        name: string;
+        alias: string | null;
+        args: Record<string, unknown>;
+    }[];
+}
+interface ComplexityLimit {
+    type: 'QueryComplexity';
+    budget: number;
+    warning?: number;
+    window: TimeWindow;
+}
+interface RequestLimit {
+    type: 'RequestCount';
+    budget: number;
+    warning?: number;
+    window: TimeWindow;
+}
+type RateLimitGroupBy = 'ip' | {
+    header: string;
+} | {
+    cookie: string;
+} | {
+    jwt: string;
+} | {
+    consumerIdentifier: string;
+};
+interface BaseRateLimitRule {
+    name: string;
+    description?: string;
+    state?: 'enabled' | 'disabled' | 'dryRun';
+    allowList?: readonly string[];
+    limit: ComplexityLimit | RequestLimit;
+}
+type DynamicRateLimitRule = BaseRateLimitRule & ({
+    groupBy: RateLimitGroupBy;
+} | {
+    group: string | number;
+});
+
+declare function isQuery(req: EdgeRequest): boolean;
+declare function isMutation(req: EdgeRequest): boolean;
+declare function hasRootField(req: EdgeRequest, rootField: string): boolean;
+type FieldConfigMap = {
+    [rootFieldName: string]: Omit<RequestLimit, 'type'>;
+};
+type OmitLimitKey<Type> = {
+    [Key in keyof Type as Exclude<Key, 'limit'>]: Type[Key];
+};
+type ByFieldConfig = OmitLimitKey<DynamicRateLimitRule> & {
+    queryFields?: FieldConfigMap;
+    mutationFields?: FieldConfigMap;
+};
+declare function byField(req: EdgeRequest, { queryFields, mutationFields, ...baseConfig }: ByFieldConfig): DynamicRateLimitRule[];
+
+export { byField, hasRootField, isMutation, isQuery };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stellate",
-  "version": "3.0.4",
+  "version": "3.2.0",
   "engines": {
     "node": ">=18"
   },
@@ -38,10 +38,10 @@
     "table": "^6.0.7",
     "terminal-link": "^2.1.1",
     "timeago.js": "^4.0.2",
-    "tsup": "6.7.0",
-    "tsx": "^3.12.1",
-    "typescript": "^5.4.5",
-    "vitest": "^1.4.0",
+    "tsup": "8.5.0",
+    "tsx": "4.20.0",
+    "typescript": "5.8.3",
+    "vitest": "3.2.3",
     "ws": "8.17.1",
     "yaml": "^1.10.2",
     "@gcdn/configuration": "1.39.7"
@@ -123,6 +123,7 @@
     "build": "tsup && rm dist/bin.mjs",
     "stellate": "tsx src/bin.ts",
     "test": "FORCE_COLOR=0 vitest run",
-    "test:watch": "vitest"
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit"
   }
 }