@zuplo/runtime 5.1796.0 → 5.1797.0

package/index.d.ts

@@ -2166,6 +2166,34 @@ declare type HttpStatusCodeRangeDefinition = "1XX" | "2XX" | "3XX" | "4XX" | "5X
 
 /**
  * @beta
+ * A policy that can modify the incoming HTTP request before it is sent to
+ * the handler. If a response is returned, the request is short-circuited and
+ * the response is returned to the client. If a Request is returned, policies
+ * or a handler that follow are executed.
+ */
+export declare abstract class InboundPolicy<TOptions = any> extends PolicyBase<TOptions> {
+    /**
+     * The handler that is called each time this policy is invoked
+     *
+     * @param request - The incoming Request
+     * @param context - The current context of the Request
+     * @returns A Response or Request object
+     */
+    abstract handler(request: ZuploRequest, context: ZuploContext): Promise<ZuploRequest | Response>;
+}
+
+/**
+ * @public
+ * A policy that can modify the incoming HTTP request before it is sent to
+ * the handler. If a response is returned, the request is short-circuited and
+ * the response is returned to the client. If a Request is returned, policies
+ * or a handler that follow are executed.
+ *
+ * @param request - The incoming Request
+ * @param context - The current context of the Request
+ * @param options - The configuration options for the policy
+ * @param policyName - The name set on the policy in the configuration
+ * @returns A Response or Request object
  */
 export declare interface InboundPolicyHandler<TOptions = any> {
     (request: ZuploRequest, context: ZuploContext, options: TOptions, policyName: string): Promise<ZuploRequest | Response>;
@@ -2689,6 +2717,34 @@ export declare interface OpenIdJwtInboundPolicyOptions {
 
 export declare const originalFetch: typeof fetch;
 
+/**
+ * @beta
+ * A policy that can modify the outgoing HTTP response before it is returned
+ * to the client.
+ */
+export declare abstract class OutboundPolicy<TOptions = any> extends PolicyBase<TOptions> {
+    /**
+     * The handler that is called each time this policy is invoked
+     *
+     * @param response - The outgoing Response
+     * @param request - The incoming Request
+     * @param context - The current context of the Request
+     */
+    abstract handler(response: Response, request: ZuploRequest, context: ZuploContext): Promise<ZuploRequest | Response>;
+}
+
+/**
+ * @public
+ * A policy that can modify the outgoing HTTP response before it is returned
+ * to the client.
+ *
+ * @param response - The outgoing Response
+ * @param request - The incoming Request
+ * @param context - The current context of the Request
+ * @param options - The configuration options for the policy
+ * @param policyName - The name set on the policy in the configuration
+ * @returns A Response object
+ */
 export declare interface OutboundPolicyHandler<TOptions = any> {
     (response: Response, request: ZuploRequest, context: ZuploContext, options: TOptions, policyName: string): Promise<Response>;
 }
@@ -2727,6 +2783,8 @@ declare interface ParsedRouteData extends Omit<RouteData, "corsPolicies"> {
     corsPolicies: ParsedCorsPolicyConfiguration[];
 }
 
+/* Excluded from this release type: PolicyBase */
+
 export declare interface PolicyConfiguration {
     name: string;
     policyType: string;
@@ -3624,7 +3682,9 @@ export declare interface SleepInboundPolicyOptions {
  * @param policyName - The name of the policy as set in policies.json
  * @returns A Request or a Response
  */
-export declare const StripeWebhookVerificationInboundPolicy: InboundPolicyHandler<StripeWebhookVerificationInboundPolicyOptions>;
+export declare class StripeWebhookVerificationInboundPolicy extends InboundPolicy<StripeWebhookVerificationInboundPolicyOptions> {
+    handler(request: ZuploRequest, context: ZuploContext): Promise<ZuploRequest<RequestGeneric> | Response>;
+}
 
 /**
  * The options for this policy.