@zuplo/runtime 5.2362.0 → 5.2364.0

package/out/types/index.d.ts

@@ -1433,6 +1433,18 @@ export declare function getIdForRefSchema(oasFileName: string, ref: string): str
 
 export declare function getIdForRequestBodySchema(path: string, operation: string, contentType: string): string;
 
+/**
+ * The function to get the anchor date for the quota.
+ * @public
+ */
+export declare type GetQuotaAnchorDateFunction = (request: ZuploRequest, context: ZuploContext, policyName: string) => Promise<Date | undefined>;
+
+/**
+ * The function to get the quota details for the quota.
+ * @public
+ */
+export declare type GetQuotaDetailFunction = (request: ZuploRequest, context: ZuploContext, policyName: string) => Promise<QuotaDetail>;
+
 export declare function getRawOperationDataIdentifierName(oasFileName: string, path: string, operation: string): string;
 
 declare interface GoogleCloudLoggingOptions {
@@ -3969,6 +3981,75 @@ export declare interface PropelAuthJwtInboundPolicyOptions {
     verifierKey: string;
 }
 
+export declare interface QuotaDetail {
+    key: string;
+    allowances: {
+        [k: string]: number;
+    };
+}
+
+/**
+ * The Quota policy enables you to set monthly, weekly, daily or hourly quotas on your API.
+ *
+ * @title Quota
+ * @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 QuotaInboundPolicy extends InboundPolicy<QuotaInboundPolicyOptions> {
+    constructor(options: QuotaInboundPolicyOptions, policyName: string);
+    handler(request: ZuploRequest<RequestGeneric>, context: ZuploContext): Promise<ZuploRequest<RequestGeneric> | Response>;
+    static setMeters(context: ZuploContext, meters: Record<string, number>): void;
+}
+
+/**
+ * The options for this policy.
+ */
+export declare interface QuotaInboundPolicyOptions {
+    /**
+     * The period of the quota.
+     */
+    period: "hourly" | "daily" | "weekly" | "monthly";
+    /**
+     * The quota by.
+     */
+    quotaBy: "user" | "function";
+    /**
+     * How the policy determines the anchor date for ongoing quota cycles - defaults to `first-api-call` which uses the first API call for this key.
+     */
+    quotaAnchorMode?: "first-api-call" | "function";
+    /**
+     * The allowances for the quota.
+     */
+    allowances?: {
+        [k: string]: number;
+    };
+    /**
+     * A list of successful status codes and ranges "200-299, 304" that should trigger a quota increment.
+     */
+    quotaOnStatusCodes?: string | number[];
+    /**
+     * The module and functions to dynamically set the anchor date and/or the key/allowances for this request.
+     */
+    identifier?: {
+        /**
+         * Specifies the module to load your custom functions, in the format `$import(./modules/my-module)`.
+         */
+        module: string;
+        /**
+         * used when quotaAnchorMode is `function`. Specifies the export to load your custom function to get the anchor date.
+         */
+        getAnchorDateExport?: string;
+        /**
+         * used when quotaBy is `function`. Specifies the export to load your custom function to get the quota detail.
+         */
+        getQuotaDetailExport?: string;
+    };
+}
+
 /**
  * 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.
  */

package/package.json

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