@zuplo/runtime 5.1577.0 → 5.1579.0

package/index.d.ts

@@ -6,7 +6,7 @@ import type { ValidateFunction as ValidateFunction_2 } from 'ajv';
  * Amberflo is a usage metering and billing service. This policy allows you to send metering calls for each API to their meter ingest endpoint.
  *
  * @remarks
- * Amberflo ([amberflo.io](https://www.amberflo.io/)) is a usage metering and
+ * Amberflo {@link https://www.amberflo.io|amberflo.com} is a usage metering and
  * billing service. This policy allows you to meter API calls going through Zuplo
  * and send them to your Amberflo account using your Amberflo API key.
  *
@@ -87,16 +87,13 @@ declare interface AmberfloMeteringProperties extends Omit<AmberfloMeteringIngest
  * [here](https://zuplo.com/docs/articles/api-key-api#buckets)
  *
  * @remarks
- * **This policy is deprecated. Use the new
- * [API Key Authentication policy instead](https://zuplo.com/docs/policies/api-key-inbound)**
- *
  * This policy uses the managed API key storage provided by Zuplo.
  * `allowUnauthenticatedRequests` defaults to false and rejects any request without
  * a valid API key (returning a `401 - Unauthorized` response). You can override
  * (set `"allowUnauthenticatedRequests" : true`) this to support multiple
  * authentication methods or support both authenticated and anonymous requests.
  *
- * @deprecated Deprecated - Please use the new 'API Key Authentication' policy
+ * @deprecated Please use the new {@link https://zuplo.com/docs/policies/api-key-inbound|API Key Authentication} policy
  * instead. This policy will continue to work but will be removed in a future
  * version of Zuplo.
  *
@@ -132,8 +129,8 @@ export declare interface ApiAuthKeyInboundPolicyOptions {
  * For more information on Zuplo's API Key Management service and options enabling
  * self-serve API Key management see the following resources:
  *
- * - [API Key Authentication Overview](/docs/articles/api-key-management)
- * - [API Key Management API](/docs/articles/api-key-api)
+ * @see {@link https://zuplo.com/docs/articles/api-key-management|API Key Authentication Overview}
+ * @see {@link https://zuplo.com/docs/articles/api-key-api|API Key Management API}
  *
  * @title API Key Authentication
  * @public
@@ -247,7 +244,7 @@ declare interface AuditLogRequestFilter {
  *
  * @remarks
  * Authenticate requests with JWT tokens issued by Auth0. This is a customized
- * version of the [OpenId JWT Policy](./open-id-jwt-auth-inbound.md) specifically
+ * version of the {@link https://zuplo.com/docs/policies/open-id-jwt-auth-inbound|OpenId JWT Policy} specifically
  * for Auth0.
  *
  * @title Auth0 JWT Auth
@@ -459,7 +456,7 @@ declare interface BasicAuthAccount {
  * with different passwords and a different bucket of user 'data'.
  *
  * The API will expect a Basic Auth header (you can generate samples
- * [here](https://www.debugbear.com/basic-auth-header-generator)). Requests with
+ * {@link https://www.debugbear.com/basic-auth-header-generator|here}). Requests with
  * invalid credentials (or no header) will not be authenticated. Authenticated
  * requests will populate the `user` property of the `ZuploRequest` parameter on
  * your RequestHandler.
@@ -647,7 +644,7 @@ export declare interface ClearHeadersOutboundPolicyOptions {
  *
  * @remarks
  * Authenticate requests with JWT tokens issued by Clerk. This is a customized
- * version of the [OpenId JWT Policy](./open-id-jwt-auth-inbound.md) specifically
+ * version of the {@link https://zuplo.com/docs/policies/open-id-jwt-auth-inbound|OpenId JWT Policy} specifically
  * for Clerk.
  *
  * @title Clerk JWT Auth
@@ -679,10 +676,10 @@ export declare interface ClerkJwtInboundPolicyOptions {
  *
  * @remarks
  * Authenticate requests with JWT tokens issued by AWS Cognito. This is a
- * customized version of the [OpenId JWT Policy](./open-id-jwt-auth-inbound.md)
+ * customized version of the {@link https://zuplo.com/docs/policies/open-id-jwt-auth-inbound|OpenId JWT Policy}
  * specifically for AWS Cognito.
  *
- * See [this document](/docs/articles/oauth-authentication) for more information
+ * See {@link https://zuplo.com/docs/articles/oauth-authentication|this document} for more information
  * about OAuth authorization in Zuplo.
  *
  * @title AWS Cognito JWT Auth
@@ -725,13 +722,9 @@ export declare type CompatibilityDate = "2023-03-14";
  * The Composite policy allows you to create groups of other policies, for easy
  * reuse across multiple routes. Other policies are referenced by their `name`.
  *
- * :::warning
- *
  * Be careful not to create circular references which can cause your gateway to
  * fail.
  *
- * :::
- *
  * @title Composite Inbound (Group Policies)
  * @public
  * @param request - The ZuploRequest
@@ -921,7 +914,7 @@ export declare interface ErrorHandler {
  * token, if successfully authenticated, with be on the `request.user.data` object
  * accessible to the runtime.
  *
- * See [this document](/docs/articles/oauth-authentication) for more information
+ * See {@link https://zuplo.com/docs/articles/oauth-authentication|this document} for more information
  * about OAuth authorization in Zuplo.
  *
  * @title Firebase JWT Auth
@@ -2400,7 +2393,7 @@ declare interface MoesifContext {
  * Moesif is an API analytics and billing service. This policy allows you to send metering calls for each API to their events batch endpoint.
  *
  * @remarks
- * Moesif [moesif.com](https://moesif.com) is an API analytics and monetization
+ * Moesif {@link https://moesif.com|moesif.com} is an API analytics and monetization
  * platform. This policy allows you to measure (and meter) API calls flowing
  * through your Zuplo gateway.
  *
@@ -2444,10 +2437,10 @@ declare interface NotFoundOptions {
  *
  * @remarks
  * Authenticate requests with JWT tokens issued by Okta. This is a customized
- * version of the [OpenId JWT Policy](./open-id-jwt-auth-inbound.md) specifically
+ * version of the {@link https://zuplo.com/docs/policies/open-id-jwt-auth-inbound|OpenId JWT Policy} specifically
  * for Okta.
  *
- * See [this document](/docs/articles/oauth-authentication) for more information
+ * See {@link https://zuplo.com/docs/articles/oauth-authentication|this document} for more information
  * about OAuth authorization in Zuplo.
  *
  * @title Okta JWT Auth
@@ -2526,7 +2519,7 @@ export declare function openApiSpecHandler(request: ZuploRequest, context: Zuplo
  * token. It will also have a `data` property populated by other data returned in
  * the JWT token (including any claims).
  *
- * See [this document](/docs/articles/oauth-authentication) for more information
+ * See {@link https://zuplo.com/docs/articles/oauth-authentication|this document} for more information
  * about OAuth authorization in Zuplo.
  *
  * @title JWT Auth
@@ -2738,9 +2731,9 @@ export declare class ProblemResponseFormatter {
  * Authenticate users using PropelAuth issued JWT tokens.
  *
  * @remarks
- * Authenticate requests with JWT tokens issued by
- * [PropelAuth](https://propelauth.com). This is a customized version of the
- * [OpenId JWT Policy](./open-id-jwt-auth-inbound.md) specifically for PropelAuth.
+ * Authenticate requests with JWT tokens issued by {@link https://propelauth.com|PropelAuth}.
+ * This is a customized version of the {@link https://zuplo.com/docs/policies/open-id-jwt-auth-inbound|OpenId JWT Policy}
+ * specifically for PropelAuth.
  *
  * @title PropelAuth JWT Auth
  * @public
@@ -2886,12 +2879,10 @@ declare interface ReadmeMeteringInboundPolicyOptions {
  * Readme is a developer documentation and API metrics company. This policy pushes logs to their API calls dashboard.
  *
  * @remarks
- * Readme ([readme.com](https://readme.com)) is a developer Documentation and
+ * {@link https://readme.com|Readme} is a developer Documentation and
  * metrics service. This policy pushes the request/response data to their ingestion
  * endpoint so you can see your Zuplo API traffic in their API calls dashboard.
  *
- * ![Readme API Calls Dashboard](https://cdn.zuplo.com/assets/071b2ead-7769-413b-a66a-133ae6fd755d.png)
- *
  * @title Readme Metrics
  * @public
  * @param request - The ZuploRequest
@@ -3056,34 +3047,6 @@ export declare interface RequestUser<TUserData = any> {
  * rejected with a `400: Bad Request` response containing a detailed error message
  * (in JSON) explaining why the request was not accepted.
  *
- * Here's an example of how to specify a schema for validation in a request body in
- * OpenAPI.
- *
- * ```json
- *   "requestBody": {
- *     "description": "user to add to the system",
- *     "content": {
- *       "application/json": {
- *         "schema": {
- *           "type": "object",
- *           "properties": {
- *             "name": {
- *               "type": "string"
- *             },
- *             "age": {
- *               "type": "integer"
- *             }
- *           },
- *           "required": [
- *             "name",
- *             "age"
- *           ]
- *         }
- *       }
- *     }
- *   }
- * ```
- *
  * @title Request Validation
  * @public
  * @param request - The ZuploRequest
@@ -3306,10 +3269,10 @@ export declare interface ServiceProvider {
  *
  * @remarks
  * The Set Body policy allows you to set or override the incoming request body.
- * [GET or HEAD requests do not support bodies on Zuplo](/docs/articles/zp-body-removed),
- * so be sure to use the [Change Method](/docs/policies/change-method-inbound)
+ * {@link https://zuplo.com/docs/articles/zp-body-removed|GET or HEAD requests do not support bodies on Zuplo},
+ * so be sure to use the {@link https://zuplo.com/docs/policies/change-method-inbound|Change Method}
  * policy to update the method to a `POST` or whatever is appropriate. You might
- * also need to use the [Set Header](/docs/policies/set-headers-inbound) policy to
+ * also need to use the {@link https://zuplo.com/docs/policies/set-headers-inbound|Set Header} policy to
  * set a `content-type`.
  *
  * @title Set Body
@@ -3337,47 +3300,7 @@ export declare interface SetBodyInboundPolicyOptions {
  *
  * @remarks
  * The set header policy adds a header to the request in the inbound pipeline. This
- * can be used to set a security header required by the downstream service. For
- * example, if your backend service uses basic authentication you might use this
- * policy to attach the Basic auth header to the request:
- *
- * ```json
- * {
- *   "export": "SetHeadersInboundPolicy",
- *   "module": "$import(@zuplo/runtime)",
- *   "options": {
- *     "headers": [
- *       {
- *         "name": "Authorization",
- *         "value": "Basic DIGEST_HERE",
- *         "overwrite": true
- *       }
- *     ]
- *   }
- * }
- * ```
- *
- * When doing this, you most likely want to set the secret as an environment
- * variable, which can be accessed in the policy as follows
- *
- * ```json
- * {
- *   "export": "SetHeadersInboundPolicy",
- *   "module": "$import(@zuplo/runtime)",
- *   "options": {
- *     "headers": [
- *       {
- *         "name": "Authorization",
- *         "value": "$env(BASIC_AUTHORIZATION_HEADER_VALUE)",
- *         "overwrite": true
- *       }
- *     ]
- *   }
- * }
- * ```
- *
- * And you would set the environment variable `BASIC_AUTHORIZATION_HEADER_VALUE` to
- * `Basic DIGEST_HERE`.
+ * can be used to set a security header required by the downstream service.
  *
  * @title Add or Set Request Headers
  * @public
@@ -3555,7 +3478,7 @@ export declare class SumoLogicLoggingPlugin extends LogPlugin {
  *
  * @remarks
  * The Supabase JWT Authentication policy allows you to authenticate incoming
- * requests using a token created by [supabase.com](https://supabase.com).
+ * requests using a token created by {@link https://supabase.com|supabase.com}.
  *
  * When configured, you can have Zuplo check incoming requests for a JWT token and
  * automatically populate the `ZuploRequest`'s `user` property with a user object.
@@ -3605,7 +3528,6 @@ export declare interface SupabaseJwtInboundPolicyOptions {
 
 /**
  * Uses Azure Active Directory to add an Authorization header to the request in order to authenticate requests using Azure identity.
- * @see {@link https://learn.microsoft.com/en-us/azure/app-service/configure-authentication-provider-aad|Configure your App Service or Azure Functions app to use Azure AD login}
  *
  * @remarks
  * This policy adds a `Authorization` header to the upstream request that allows
@@ -3616,7 +3538,7 @@ export declare interface SupabaseJwtInboundPolicyOptions {
  * Using this policy allows you to delegate authentication and authorization to
  * your gateway without writing any code on your origin service. For instructions
  * on how to configure Azure AD authentication see
- * [Azure's documentation](https://learn.microsoft.com/en-us/azure/app-service/configure-authentication-provider-aad).
+ * {@link https://learn.microsoft.com/en-us/azure/app-service/configure-authentication-provider-aad | Configure your App Service or Azure Functions app to use Azure AD login}.
  *
  * @title Upstream Azure AD Service Auth
  * @public
@@ -3761,17 +3683,15 @@ export declare interface UpstreamFirebaseUserAuthInboundPolicyOptions {
  * Creates a self-signed JWT token (generated using a Google Service Account JSON) and attaches it to the outgoing request. Useful when calling GCP services like Cloud Endpoints / ESPv2
  *
  * @remarks
- * **CAUTION: This policy only works with
- * [certain Google APIs](https://developers.google.com/identity/protocols/oauth2/service-account#jwt-auth).
- * In most cases, the
- * [Upstream GCP Service Auth](/docs/policies/upstream-gcp-service-auth-inbound)
- * should be used.**
- *
  * This policy adds a JWT token to the headers, ready for us in an outgoing request
  * when calling a GCP service (e.g. Cloud Endpoints / ESPv2). We recommend reading
  * the `serviceAccountJson` from environment variables (so it is not checked in to
  * source control) using the `$env(ENV_VAR)` syntax.
  *
+ * CAUTION: This policy only works with {@link https://developers.google.com/identity/protocols/oauth2/service-account#jwt-auth | certain Google APIs}.
+ * In most cases, the {@link https://zuplo.com/docs/policies/upstream-gcp-service-auth-inbound | Upstream GCP Service Auth}
+ * should be used.
+ *
  * @title Upstream GCP Self-Signed JWT
  * @public
  * @param request - The ZuploRequest
@@ -3808,8 +3728,8 @@ export declare interface UpstreamGcpJwtInboundPolicyOptions {
  * gateway can make requests against it.
  *
  * This policy works with
- * [GCP Identity Aware Proxy](https://zuplo.com/docs/articles/gke-with-upstream-auth-policy)
- * or services like [Cloud Run](https://cloud.google.com/iap/docs/managing-access)
+ * {@link https://zuplo.com/docs/articles/gke-with-upstream-auth-policy|GCP Identity Aware Proxy}
+ * or services like {@link https://cloud.google.com/iap/docs/managing-access|Cloud Run}
  * that natively support IAM authorization.
  *
  * We recommend reading the `serviceAccountJson` from environment variables (so it
@@ -3834,7 +3754,7 @@ export declare interface UpstreamGcpServiceAuthInboundPolicyOptions {
      */
     audience: string;
     /**
-     * The Google Service Account key in JSON format. Note you can load this from environment variables using the $env(ENV_VAR) syntax.
+     * The Google Service Account key in JSON format. Note you can load this from environment variables using the `$env(ENV_VAR)` syntax.
      * @see {@link https://developers.google.com/workspace/guides/create-credentials|Create access credentials}
      */
     serviceAccountJson: string;
@@ -3877,11 +3797,6 @@ export declare const VALID_COMPATIBILITY_DATES: readonly CompatibilityDate[];
  * Validates the body of an incoming request based on a JSON schema.
  *
  * @remarks
- * **This policy is deprecated. Use the new
- * [Request Validation Policy](https://zuplo.com/docs/policies/request-validation-inbound).
- * The new policy validates JSON bodies like this policy, but also supports
- * validation of parameters, query strings, etc.**
- *
  * The Validate JSON Schema policy is used to validate the body of incoming
  * requests. It works using JSON Schemas defined in the `Schemas` folder of your
  * project.
@@ -3892,7 +3807,8 @@ export declare const VALID_COMPATIBILITY_DATES: readonly CompatibilityDate[];
  *
  * @title JSON Body Validation
  * @public
- * @deprecated Use the Request Validation policy (RequestValidationInboundPolicy) instead.
+ * @deprecated Use the new {@link https://zuplo.com/docs/policies/request-validation-inbound|Request Validation Policy}.
+ * The new policy validates JSON bodies like this policy, but also supports validation of parameters, query strings, etc.
  * @param request - The ZuploRequest
  * @param context - The ZuploContext
  * @param options - The policy options set in policies.json

package/package.json

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