@zuplo/runtime 5.2181.0 → 5.2182.0

package/out/esm/internal/index.js

@@ -22,5 +22,5 @@
  *  DEALINGS IN THE SOFTWARE.
  *--------------------------------------------------------------------------------------------*/
     
-import{b as e,c as t,e as a,f as o,g as r,h as i,i as n}from"../chunk-QSL25HFO.js";import"../chunk-HPMPWPKQ.js";import"../chunk-4DUPDUSC.js";export{o as getIdForParameterSchema,i as getIdForRefSchema,r as getIdForRequestBodySchema,a as getRawOperationDataIdentifierName,e as isRestrictedEnvVariableName,t as isZuploReadableEnvVariableName,n as sanitizedIdentifierName};
+import{b as e,c as t,e as a,f as o,g as r,h as i,i as n}from"../chunk-CRZT3N5H.js";import"../chunk-4NFZOV2A.js";import"../chunk-4DUPDUSC.js";export{o as getIdForParameterSchema,i as getIdForRefSchema,r as getIdForRequestBodySchema,a as getRawOperationDataIdentifierName,e as isRestrictedEnvVariableName,t as isZuploReadableEnvVariableName,n as sanitizedIdentifierName};
 /*! For license information please see index.js.LEGAL.txt */

package/out/esm/policies/axiomatics-authz-inbound/exports.js

@@ -22,5 +22,5 @@
  *  DEALINGS IN THE SOFTWARE.
  *--------------------------------------------------------------------------------------------*/
     
-import{g as o}from"../../chunk-CI735RIK.js";import"../../chunk-HPMPWPKQ.js";import"../../chunk-4DUPDUSC.js";export{o as PdpService};
+import{g as o}from"../../chunk-M2WV76HS.js";import"../../chunk-4NFZOV2A.js";import"../../chunk-4DUPDUSC.js";export{o as PdpService};
 /*! For license information please see exports.js.LEGAL.txt */

package/out/types/index.d.ts

@@ -904,6 +904,88 @@ declare interface CompatibilityFlags {
     removeAllVendorHeadersExceptListed: boolean;
 }
 
+export declare type ComplexRateLimitFunction = (request: ZuploRequest, context: ZuploContext, policyName: string) => CustomComplexRateLimitDetails | Promise<CustomComplexRateLimitDetails>;
+
+/**
+ * The Complex Rate Limiting policy is an advanced rate limiting policy that
+ * let's you set rate limits based on custom counters (not just requests)
+ *
+ * @remarks
+ * You can use the Complex Rate Limiting policy to limit the number of requests
+ * based on complex counters, based on details of the request or the response
+ *
+ * @title Monetization
+ * @beta
+ * @param request - The ZuploRequest
+ * @param context - The ZuploContext
+ * @param options - The policy options set in policies.json
+ * @param policyName - The name of the policy as set in policies.json
+ * @returns A Request or a Response
+ */
+export declare class ComplexRateLimitInboundPolicy extends InboundPolicy<ComplexRateLimitInboundPolicyOptions> {
+    #private;
+    /**
+     * Override the costs for limits in the current request.
+     *
+     * @remarks
+     * If your policy is has a limit set as follows:
+     *
+     * ```
+     * "limits": {
+     *   "compute": 10
+     * }
+     * ```
+     *
+     * You can use this function to override the cost of the `compute` limit
+     * by calling `setLimits(context, { compute: 5 })` on a custom policy.
+     * This can be useful if you want to dynamically change the cost of a limit
+     * based on data in the response (say a header).
+     *
+     * @param context - The ZuploContext
+     * @param limits - The limits to set.
+     */
+    static setLimits(context: ZuploContext, limits: Record<string, number>): void;
+    private ttlSeconds;
+    constructor(options: ComplexRateLimitInboundPolicyOptions, policyName: string);
+    handler(request: ZuploRequest, context: ZuploContext): Promise<ZuploRequest<RequestGeneric> | Response>;
+}
+
+/**
+ * The options for this policy.
+ */
+export declare interface ComplexRateLimitInboundPolicyOptions {
+    rateLimitBy: RateLimitByType;
+    /**
+     * A dictionary (string: number) of limits to be enforced across custom counters for this policy.
+     */
+    limits: {
+        [k: string]: number;
+    };
+    /**
+     * The time window in which the requests are rate-limited. The count restarts after each window expires.
+     */
+    timeWindowMinutes: number;
+    /**
+     * The function that returns dynamic configuration data. Used only with `rateLimitBy=function`.
+     */
+    identifier?: {
+        /**
+         * used only with rateLimitBy=function. Specifies the export to load your custom bucket function, e.g. `default`, `rateLimitIdentifier`.
+         */
+        export: string;
+        /**
+         * Specifies the module to load your custom bucket function, in the format `$import(./modules/my-module)`.
+         */
+        module: string;
+    };
+    headerMode?: RateLimitHeaderMode;
+    /**
+     * If true, the policy will throw an error in the event there is a problem connecting to the rate limit service.
+     */
+    throwOnFailure?: boolean;
+    mode?: RateLimitMode;
+}
+
 /**
  * Creates a composite, or group policy - composed of other policies. For reuse across routes.
  *
@@ -985,11 +1067,11 @@ export declare class ConfigurationError extends RuntimeError {
  */
 export declare class ContextData<T = any> {
     #private;
-    constructor(name: string);
+    constructor(name: string | symbol);
     set(context: ZuploContext, data: T): void;
     get(context: ZuploContext): T | undefined;
-    static set<T = any>(context: ZuploContext, name: string, data: T): void;
-    static get<T = any>(context: ZuploContext, name: string): T | undefined;
+    static set<T = any>(context: ZuploContext, name: string | symbol, data: T): void;
+    static get<T = any>(context: ZuploContext, name: string | symbol): T | undefined;
 }
 
 /** The 2-letter continent codes Cloudflare uses */
@@ -1130,6 +1212,12 @@ export declare interface CurityPhantomTokenInboundPolicyOptions {
     cacheDurationSeconds?: number;
 }
 
+export declare interface CustomComplexRateLimitDetails {
+    key: string;
+    limits?: Record<string, number>;
+    timeWindowMinutes?: number;
+}
+
 /**
  * @beta
  */
@@ -3790,11 +3878,21 @@ export declare interface PropelAuthJwtInboundPolicyOptions {
  */
 declare type RateLimitByType = "user" | "ip" | "function" | "all";
 
+/**
+ * The identifying element of the request that enforces distinct rate limits. For example, you can limit by `user`, `ip`, `function` or `all` - function allows you to specify a simple function to create a string identifier to create a rate-limit group.
+ */
+declare type RateLimitByType_2 = "user" | "ip" | "function" | "all";
+
 /**
  * Adds the retry-after header.
  */
 declare type RateLimitHeaderMode = "none" | "retry-after";
 
+/**
+ * Adds the retry-after header.
+ */
+declare type RateLimitHeaderMode_2 = "none" | "retry-after";
+
 /**
  * The rate-limiting policy is used to limit the number of requests that can be made against your API based on a key.
  *
@@ -3828,7 +3926,7 @@ export { RateLimitInboundPolicy }
  * The options for this policy.
  */
 declare interface RateLimitInboundPolicyOptions {
-    rateLimitBy: RateLimitByType;
+    rateLimitBy: RateLimitByType_2;
     /**
      * The max number of requests allowed in the given time window.
      */
@@ -3850,12 +3948,12 @@ declare interface RateLimitInboundPolicyOptions {
          */
         module: string;
     };
-    headerMode?: RateLimitHeaderMode;
+    headerMode?: RateLimitHeaderMode_2;
     /**
      * If true, the policy will throw an error in the event there is a problem connecting to the rate limit service.
      */
     throwOnFailure?: boolean;
-    mode?: RateLimitMode;
+    mode?: RateLimitMode_2;
 }
 export { RateLimitInboundPolicyOptions as BasicRateLimitInboundPolicyOptions }
 export { RateLimitInboundPolicyOptions }
@@ -3865,6 +3963,11 @@ export { RateLimitInboundPolicyOptions }
  */
 declare type RateLimitMode = "strict" | "async";
 
+/**
+ * The mode of the policy. If set to `async`, the policy will check if the request is over the rate limit without blocking. This can result in some requests allowed over the rate limit.
+ */
+declare type RateLimitMode_2 = "strict" | "async";
+
 /**
  * The options for this policy. Many of them can be overridden at the code level in a request using the `AmberfloMeteringPolicy.setRequestProperties` method.
  */

package/package.json

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