@zuplo/runtime 6.66.12 → 6.66.14

package/out/types/index.d.ts

@@ -2994,6 +2994,41 @@ declare interface HeaderCredentialsConfig {
   headerName: string;
 }
 
+/**
+ * Sets HTTP deprecation headers on the outgoing response following the IETF
+ * HTTP Deprecation Header standard. Supports the Deprecation, Sunset, and Link
+ * headers.
+ *
+ * @title HTTP Deprecation
+ * @public
+ * @param response - The Response
+ * @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 Response with deprecation headers
+ */
+export declare const HttpDeprecationOutboundPolicy: OutboundPolicyHandler<HttpDeprecationOutboundPolicyOptions>;
+
+/**
+ * The options for the HTTP Deprecation outbound policy.
+ * @public
+ */
+export declare interface HttpDeprecationOutboundPolicyOptions {
+  /**
+   * The deprecation value. Use `true` for already deprecated, an ISO 8601 date string for a specific date, or a Unix timestamp number.
+   */
+  deprecation: true | string | number;
+  /**
+   * An ISO 8601 date string indicating when the endpoint will be removed. Sets the Sunset header.
+   */
+  sunset?: string;
+  /**
+   * A URL to documentation about the deprecation or migration guide. Sets the Link header.
+   */
+  link?: string;
+}
+
 /**
  * @public
  */
@@ -5744,6 +5779,25 @@ export declare interface MoesifInboundPolicyOptions {
  */
 export declare class MonetizationInboundPolicy extends InboundPolicy<MonetizationInboundPolicyOptions> {
   #private;
+  /**
+   * Set the monetization subscription data for the current request.
+   *
+   * @param context - The ZuploContext
+   * @param subscription - The subscription to set.
+   */
+  static setSubscriptionData(
+    context: ZuploContext,
+    subscription: MonetizationSubscription
+  ): void;
+  /**
+   * Get the monetization subscription data for the current request.
+   *
+   * @param context - The ZuploContext
+   * @returns The subscription data or undefined
+   */
+  static getSubscriptionData(
+    context: ZuploContext
+  ): MonetizationSubscription | undefined;
   constructor(options: MonetizationInboundPolicyOptions, policyName: string);
   handler(
     request: ZuploRequest,
@@ -5784,6 +5838,39 @@ export declare interface MonetizationInboundPolicyOptions {
   meterOnStatusCodes?: string | number[];
 }
 
+export declare interface MonetizationSubscription {
+  paymentStatus?: {
+    isFirstPayment: boolean;
+    lastPaymentFailedAt?: string;
+    lastPaymentSucceededAt?: string;
+    status: "paid" | "not_required" | "pending" | "failed" | "uncollectible";
+  };
+  id: string;
+  customerId: string;
+  name: string;
+  status: string;
+  currency: string;
+  billingCadence: string;
+  activeFrom: string;
+  activeTo?: string;
+  plan: {
+    id: string;
+    name: string;
+    description?: string;
+  };
+  entitlements: Record<
+    string,
+    {
+      balance: number;
+      hasAccess: boolean;
+      overage: number;
+      usage: number;
+    }
+  >;
+  createdAt: string;
+  updatedAt: string;
+}
+
 declare interface MultiRequests {
   RequestReference: RequestReference;
 }
@@ -7377,7 +7464,9 @@ declare type RateLimitFunction<T extends CustomRateLimitDetailsBase> = (
   policyName: string
 ) =>
   | (Partial<T> & CustomRateLimitDetailsBase)
-  | Promise<Partial<T> & CustomRateLimitDetailsBase>;
+  | undefined
+  | null
+  | Promise<(Partial<T> & CustomRateLimitDetailsBase) | undefined | null>;
 
 /**
  * Adds the retry-after header.
@@ -7476,6 +7565,24 @@ declare type RateLimitHeaderMode_2 = "none" | "retry-after";
  *   }
  * };
  * ```
+ *
+ * @example
+ * ```typescript
+ * // Skip rate limiting for specific conditions (return undefined)
+ * import { CustomRateLimitFunction, CustomRateLimitDetails } from "@zuplo/runtime";
+ *
+ * export const customRateLimitWithSkip: CustomRateLimitFunction = async (
+ *   request,
+ *   context
+ * ): Promise<CustomRateLimitDetails | undefined> => {
+ *   // Skip rate limiting for whitelisted IPs or internal services
+ *   const clientIp = request.headers.get("cf-connecting-ip");
+ *   if (isWhitelisted(clientIp)) {
+ *     return undefined;  // Skip rate limiting entirely - no Redis call
+ *   }
+ *   return { key: `user-${request.user?.sub}` };
+ * };
+ * ```
  */
 declare const RateLimitInboundPolicy: InboundPolicyHandler<RateLimitInboundPolicyOptions>;
 export { RateLimitInboundPolicy as BasicRateLimitInboundPolicy };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zuplo/runtime",
   "type": "module",
-  "version": "6.66.12",
+  "version": "6.66.14",
   "repository": "https://github.com/zuplo/zuplo",
   "author": "Zuplo, Inc.",
   "exports": {