@zuplo/runtime 5.2192.0 → 5.2194.0

package/out/types/index.d.ts

@@ -970,7 +970,14 @@ declare interface CompatibilityFlags {
     removeAllVendorHeadersExceptListed: boolean;
 }
 
-export declare type ComplexRateLimitFunction = (request: ZuploRequest, context: ZuploContext, policyName: string) => CustomComplexRateLimitDetails | Promise<CustomComplexRateLimitDetails>;
+/**
+ * @public
+ */
+export declare interface ComplexCustomRateLimitDetails extends CustomRateLimitDetailsBase {
+    limits?: Record<string, number>;
+}
+
+export declare type ComplexRateLimitFunction = RateLimitFunction<ComplexCustomRateLimitDetails>;
 
 /**
  * The Complex Rate Limiting policy is an advanced rate limiting policy that
@@ -982,6 +989,7 @@ export declare type ComplexRateLimitFunction = (request: ZuploRequest, context:
  *
  * @title Complex Rate Limiting
  * @beta
+ * @enterprise
  * @param request - The ZuploRequest
  * @param context - The ZuploContext
  * @param options - The policy options set in policies.json
@@ -1011,7 +1019,6 @@ export declare class ComplexRateLimitInboundPolicy extends InboundPolicy<Complex
      */
     static setIncrements(context: ZuploContext, increments: Record<string, number>): void;
     static getIncrements(context: ZuploContext): Record<string, number>;
-    private ttlSeconds;
     constructor(options: ComplexRateLimitInboundPolicyOptions, policyName: string);
     handler(request: ZuploRequest, context: ZuploContext): Promise<ZuploRequest<RequestGeneric> | Response>;
 }
@@ -1278,21 +1285,20 @@ export declare interface CurityPhantomTokenInboundPolicyOptions {
     cacheDurationSeconds?: number;
 }
 
-export declare interface CustomComplexRateLimitDetails {
-    key: string;
-    limits?: Record<string, number>;
-    timeWindowMinutes?: number;
-}
-
 /**
- * @beta
+ * @public
  */
-export declare interface CustomRateLimitDetails {
-    key: string;
+export declare interface CustomRateLimitDetails extends CustomRateLimitDetailsBase {
     requestsAllowed?: number;
+}
+
+declare interface CustomRateLimitDetailsBase {
+    key: string;
     timeWindowMinutes?: number;
 }
 
+export declare type CustomRateLimitFunction = RateLimitFunction<CustomRateLimitDetails>;
+
 declare interface DataDogLoggingOptions {
     url?: string;
     apiKey: string;
@@ -3949,6 +3955,8 @@ declare type RateLimitByType = "user" | "ip" | "function" | "all";
  */
 declare type RateLimitByType_2 = "user" | "ip" | "function" | "all";
 
+declare type RateLimitFunction<T extends CustomRateLimitDetailsBase> = (request: ZuploRequest, context: ZuploContext, policyName: string) => (Partial<T> & CustomRateLimitDetailsBase) | Promise<Partial<T> & CustomRateLimitDetailsBase>;
+
 /**
  * Adds the retry-after header.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zuplo/runtime",
-  "version": "5.2192.0",
+  "version": "5.2194.0",
   "repository": "https://github.com/zuplo/zuplo",
   "author": "Zuplo, Inc.",
   "exports": {