@zuplo/runtime 5.1582.0 → 5.1584.0

package/index.d.ts

@@ -28,15 +28,15 @@ export declare function AmberfloMeteringInboundPolicy(request: ZuploRequest, con
  */
 export declare interface AmberfloMeteringInboundPolicyOptions {
     /**
-     * The API key to use when sending metering calls to Amberflo
+     * The API key to use when sending metering calls to Amberflo.
      */
     apiKey: string;
     /**
-     * The name of the meter to use when sending metering calls to Amberflo (overridable in code)
+     * The name of the meter to use when sending metering calls to Amberflo (overridable in code).
      */
     meterApiName?: string;
     /**
-     * The value to use when sending metering calls to Amberflo (overridable in code)
+     * The value to use when sending metering calls to Amberflo (overridable in code).
      */
     meterValue?: number;
     /**
@@ -44,21 +44,21 @@ export declare interface AmberfloMeteringInboundPolicyOptions {
      */
     customerIdPropertyPath?: string;
     /**
-     * The default customerId for all metering calls - overridable in code and by `customerIdPropertyPath`
+     * The default customerId for all metering calls - overridable in code and by `customerIdPropertyPath`.
      */
     customerId?: string;
     /**
-     * A dictionary of dimensions to be sent to Amberflo (extensible in code)
+     * A dictionary of dimensions to be sent to Amberflo (extensible in code).
      */
     dimensions?: {
         [k: string]: string;
     };
     /**
-     * A list of successful status codes and ranges "200-299, 304" that should trigger a metering call to Amberflo - defaults to `result.ok` (200-299) if not set.
+     * A list of successful status codes and ranges "200-299, 304" that should trigger a metering call to Amberflo.
      */
     statusCodes?: string | number[];
     /**
-     * Optional, the URL to send metering events to (defaults to https://app.amberflo.io/ingest). This is useful for testing purposes.
+     * The URL to send metering events. This is useful for testing purposes.
      */
     url?: string;
 }
@@ -99,6 +99,7 @@ declare interface AmberfloMeteringProperties extends Omit<AmberfloMeteringIngest
  *
  * @title API Key Authentication
  * @public
+ * @unlisted
  * @param request - The ZuploRequest
  * @param context - The ZuploContext
  * @param unparsedOptions - The policy options set in policies.json
@@ -129,8 +130,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:
  *
- * @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}
+ * - {@link https://zuplo.com/docs/articles/api-key-management|API Key Authentication Overview}
+ * - {@link https://zuplo.com/docs/articles/api-key-api|API Key Management API}
  *
  * @title API Key Authentication
  * @public
@@ -147,15 +148,15 @@ export declare function ApiKeyInboundPolicy(request: ZuploRequest, context: Zupl
  */
 export declare interface ApiKeyInboundPolicyOptions {
     /**
-     * The name of the header with the key. Defaults to `Authorization`
+     * The name of the header with the key.
      */
     authHeader?: string;
     /**
-     * The scheme used on the header. Defaults to `Bearer`
+     * The scheme used on the header.
      */
     authScheme?: string;
     /**
-     * Optional - The name of the API Key service bucket. Defaults to the autogenerated bucket name for your project. You can contact `support@zuplo.com` to create a new bucket.
+     * The name of the API Key service bucket. Defaults to the autogenerated bucket name for your project.
      */
     bucketName?: string;
     /**
@@ -545,7 +546,7 @@ export declare function CachingInboundPolicy(request: ZuploRequest, context: Zup
  */
 export declare interface CachingInboundPolicyOptions {
     /**
-     * Optional, specifies an id or 'key' for this policy to store cache. This is useful for cache-busting. For example, set this property to an env var and if you change that env var value, you invalidate the cache.
+     * Specifies an id or 'key' for this policy to store cache. This is useful for cache-busting. For example, set this property to an env var and if you change that env var value, you invalidate the cache.
      */
     cacheId?: string;
     /**
@@ -557,15 +558,15 @@ export declare interface CachingInboundPolicyOptions {
      */
     headers?: string[];
     /**
-     * HTTP Methods to be cached - defaults to GET if none specified. Valid methods are: GET, POST, PUT, PATCH, DELETE, HEAD
+     * HTTP Methods to be cached. Valid methods are: GET, POST, PUT, PATCH, DELETE, HEAD.
      */
-    cacheHttpMethods?: string[];
+    cacheHttpMethods?: ("GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD")[];
     /**
      * The timeout of the cache in seconds
      */
     expirationSecondsTtl?: number;
     /**
-     * Response status codes to be cached - defaults to 200, 206, 301, 302, 303, 404, 410 if none specified
+     * Response status codes to be cached.
      */
     statusCodes?: number[];
 }
@@ -990,7 +991,7 @@ export declare interface GeoFilterInboundPolicyOptions {
     block?: GeoSpec;
     allow?: GeoSpec;
     /**
-     * Optional, defaults to true. Specifies whether unknown geo-location parameters should be ignored (allowed through).
+     * Specifies whether unknown geo-location parameters should be ignored (allowed through).
      */
     ignoreUnknown?: boolean;
 }
@@ -2349,19 +2350,19 @@ declare interface MetricsType {
  */
 export declare interface MockApiInboundOptions {
     /**
-     * Optional. Indicates whether the response should be selected randomly, from the available examples (that match any filter criteria). If `false` the first matching example is used.
+     * Indicates whether the response should be selected randomly, from the available examples (that match any filter criteria). If `false` the first matching example is used.
      */
     random?: boolean;
     /**
-     * Optional. Specifies a prefix to match the responses to select from. Typically this is a status code like "200" or "2XX". If you want the policy to select randomly from all 2XX codes, set this property to "2" and random to `true`.
+     * Specifies a prefix to match the responses to select from. Typically this is a status code like "200" or "2XX". If you want the policy to select randomly from all 2XX codes, set this property to "2" and random to `true`.
      */
     responsePrefixFilter?: string;
     /**
-     * Optional. Specify the content-type of the response to select from. If not specified, the first matching response is used (or random).
+     * Specify the content-type of the response to select from. If not specified, the first matching response is used (or random).
      */
     contentType?: string;
     /**
-     * Optional. Specify the name of the example to select. If not specified, the first matching response is used (or random).
+     * Specify the name of the example to select. If not specified, the first matching response is used (or random).
      */
     exampleName?: string;
 }
@@ -2415,15 +2416,15 @@ export declare function MoesifInboundPolicy(request: ZuploRequest, context: Zupl
  */
 export declare interface MoesifInboundPolicyOptions {
     /**
-     * Your Moesif application ID (required)
+     * Your Moesif application ID.
      */
     applicationId: string;
     /**
-     * Set to false to disable sending the request body to Moesif (optional)
+     * Set to false to disable sending the request body to Moesif.
      */
     logRequestBody?: boolean;
     /**
-     * Set to false to disable sending the response body to Moesif (optional)
+     * Set to false to disable sending the response body to Moesif.
      */
     logResponseBody?: boolean;
 }
@@ -2545,7 +2546,7 @@ export declare interface OpenIdJwtInboundPolicyOptions {
      */
     issuer?: string;
     /**
-     * The expected audience claim in the JWT token (optional).
+     * The expected audience claim in the JWT token.
      */
     audience?: string;
     /**
@@ -2561,7 +2562,7 @@ export declare interface OpenIdJwtInboundPolicyOptions {
      */
     allowUnauthenticatedRequests?: boolean;
     /**
-     * The name of the property in the JWT token that contains the user's unique identifier. Defaults to `sub`.
+     * The name of the property in the JWT token that contains the user's unique identifier.
      */
     subPropertyName?: string;
     /**
@@ -2854,23 +2855,23 @@ declare interface ReadmeMeteringInboundPolicyOptions {
      */
     apiKey: string;
     /**
-     * Optional - defaults to '.sub'. This is the path to the property on `request.user` that contains the label you want to use. For example `.data.accountNumber` would read the `request.user.data.accountNumber` property.
+     * This is the path to the property on `request.user` that contains the label you want to use. For example `.data.accountNumber` would read the `request.user.data.accountNumber` property.
      */
     userLabelPropertyPath?: string;
     /**
-     * Optional - defaults to empty. This is the path to the property on `request.user` that contains the e-mail of the user. For example `.data.email` would read the `request.user.data.email` property.
+     * This is the path to the property on `request.user` that contains the e-mail of the user. For example `.data.email` would read the `request.user.data.email` property.
      */
     userEmailPropertyPath?: string;
     /**
-     * Optional. Whether the data should be ingested as 'development' mode or not. Defaults to true for working-copy and false for all other environments.
+     * Whether the data should be ingested as 'development' mode or not. Defaults to true for working-copy and false for all other environments.
      */
     development?: boolean;
     /**
-     * Optional - defaults to false. When true, Zuplo sends the full request path (which might contain sensitive information). By default, we only send the route path which should not contain sensitive information.
+     * When true, Zuplo sends the full request path (which might contain sensitive information). By default, we only send the route path which should not contain sensitive information.
      */
     useFullRequestPath?: boolean;
     /**
-     * Optional, the URL to send metering events to (defaults to https://metrics.readme.io/request). This is useful for testing purposes.
+     * The URL to send metering events. This is useful for testing purposes.
      */
     url?: string;
 }
@@ -2919,7 +2920,7 @@ export declare const RemoveHeadersInboundPolicy: InboundPolicyHandler<RemoveHead
  */
 export declare interface RemoveHeadersInboundPolicyOptions {
     /**
-     * A list of headers to be removed from the incoming request
+     * An array of headers to remove from the incoming request.
      */
     headers: string[];
 }
@@ -2942,7 +2943,7 @@ export declare const RemoveHeadersOutboundPolicy: OutboundPolicyHandler<RemoveHe
  */
 export declare interface RemoveHeadersOutboundPolicyOptions {
     /**
-     * A list of headers to be removed from the incoming request
+     * An array of headers to be removed from the outgoing response.
      */
     headers: string[];
 }
@@ -2965,7 +2966,7 @@ export declare const RemoveQueryParamsInboundPolicy: InboundPolicyHandler<Remove
  */
 export declare interface RemoveQueryParamsInboundPolicyOptions {
     /**
-     * Array of query parameters to be removed
+     * An array of query parameters to be removed from the incoming request.
      */
     params: string[];
 }
@@ -3062,15 +3063,15 @@ export declare const RequestValidationInboundPolicy: InboundPolicyHandler<Reques
  */
 export declare interface RequestValidationInboundPolicyOptions {
     /**
-     * Optional. Specify one of the log levels: 'error | warn | info | debug'. Default: info
+     * The log level to use when logging validation errors.
      */
-    logLevel?: string;
+    logLevel?: "error" | "warn" | "info" | "debug";
     validateBody?: ValidationOptions;
     validateQueryParameters?: ValidationOptions1;
     validatePathParameters?: ValidationOptions2;
     validateHeaders?: ValidationOptions3;
     /**
-     * Optional. Specify whether to include the request in the logs. Default: false
+     * Whether to include the request in the logs.
      */
     includeRequestInLogs?: boolean;
 }
@@ -3317,7 +3318,7 @@ export declare const SetHeadersInboundPolicy: InboundPolicyHandler<SetHeadersInb
  */
 export declare interface SetHeadersInboundPolicyOptions {
     /**
-     * An array of name and value objects (with an optional `overwrite` boolean)
+     * An array of headers to set in the request. By default, headers will be overwritten if they already exists in the request, specify the overwrite property to change this behavior.
      */
     headers: {
         /**
@@ -3353,19 +3354,19 @@ export declare const SetHeadersOutboundPolicy: OutboundPolicyHandler<SetHeadersO
  */
 export declare interface SetHeadersOutboundPolicyOptions {
     /**
-     * An array of name and value objects (with an optional `overwrite` boolean)
+     * An array of headers to set on the response. By default, headers will be overwritten if they already exists in the response, specify the overwrite property to change this behavior.
      */
     headers: {
         /**
-         * The name of the header
+         * The name of the header.
          */
         name: string;
         /**
-         * The value of the header
+         * The value of the header.
          */
         value: string;
         /**
-         * Overwrite the value if the header is already present in the request
+         * Overwrite the value if the header is already present in the response.
          */
         overwrite?: boolean;
     }[];
@@ -3391,7 +3392,7 @@ export declare const SetQueryParamsInboundPolicy: InboundPolicyHandler<SetQueryP
  */
 export declare interface SetQueryParamsInboundPolicyOptions {
     /**
-     * An array of name and value objects (with an optional `overwrite` boolean)
+     * An array of query params to set in the request. By default, query parameters will be overwritten if they already exist in the request, specify the overwrite property to change this behavior.
      */
     params: {
         /**
@@ -3403,7 +3404,7 @@ export declare interface SetQueryParamsInboundPolicyOptions {
          */
         value: string;
         /**
-         * Overwrite the value if the param is already present in the request
+         * Overwrite the value if the param is already present in the request.
          */
         overwrite?: boolean;
     }[];
@@ -3431,7 +3432,7 @@ export declare interface SetStatusOutboundPolicyOptions {
      */
     status?: number;
     /**
-     * The statusText to be used in the response (optional)
+     * The statusText to be used in the response.
      */
     statusText?: string;
 }
@@ -3567,11 +3568,11 @@ export declare interface UpstreamAzureAdServiceAuthInboundPolicyOptions {
      */
     activeDirectoryClientSecret: string;
     /**
-     * The number of times to retry fetching the token in the event of a failure. Defaults to 3.
+     * The number of times to retry fetching the token in the event of a failure..
      */
     tokenRetries?: number;
     /**
-     * The number of seconds less than the token expiration to cache the token. Defaults to 300 seconds.
+     * The number of seconds less than the token expiration to cache the token.
      */
     expirationOffsetSeconds?: number;
 }
@@ -3610,11 +3611,11 @@ export declare interface UpstreamFirebaseAdminAuthInboundPolicyOptions {
      */
     serviceAccountJson: string;
     /**
-     * The number of times to retry fetching the token in the event of a failure. Defaults to 3.
+     * The number of times to retry fetching the token in the event of a failure.
      */
     tokenRetries?: number;
     /**
-     * The number of seconds less than the token expiration to cache the token. Defaults to 300 seconds.
+     * The number of seconds less than the token expiration to cache the token.
      */
     expirationOffsetSeconds?: number;
 }
@@ -3661,20 +3662,20 @@ export declare interface UpstreamFirebaseUserAuthInboundPolicyOptions {
      */
     userIdPropertyPath?: string;
     /**
-     * Optional additional claims to include in the custom token's payload.
+     * Additional claims to include in the custom token's payload.
      */
     developerClaims?: Record<string, string | number | boolean | null>;
     /**
      * The Firebase Web API Key (found in project settings)
-     * @see {@link https://firebase.google.com/docs/projects/api-keys|Firebase API Keys}
+     * @see {@link https://firebase.google.com/docs/projects/api-keys|Firebase API Keys}.
      */
     webApiKey: string;
     /**
-     * The number of times to retry fetching the token in the event of a failure. Defaults to 3.
+     * The number of times to retry fetching the token in the event of a failure.
      */
     tokenRetries?: number;
     /**
-     * The number of seconds less than the token expiration to cache the token. Defaults to 300 seconds.
+     * The number of seconds less than the token expiration to cache the token.
      */
     expirationOffsetSeconds?: number;
 }
@@ -3707,7 +3708,7 @@ export declare const UpstreamGcpJwtInboundPolicy: InboundPolicyHandler<UpstreamG
  */
 export declare interface UpstreamGcpJwtInboundPolicyOptions {
     /**
-     * The audience for the minted JWT. Refer to https://cloud.google.com/endpoints/docs/grpc-service-config/reference/rpc/google.api#google.api.AuthRequirement.
+     * The audience for the minted JWT. See the document {@link https://cloud.google.com/endpoints/docs/grpc-service-config/reference/rpc/google.api#google.api.AuthRequirement|AuthRequirement} for details.
      */
     audience: string;
     /**
@@ -3718,7 +3719,6 @@ export declare interface UpstreamGcpJwtInboundPolicyOptions {
 
 /**
  * Creates an ID Token from Google's OAuth service and attaches it to the outgoing request. Useful when calling GCP services that are secured with GCP IAM.
- * @see {@link https://cloud.google.com/functions/docs/securing/authenticating|Authenticating for invocation}
  *
  * @remarks
  * This policy allows you to delegate authentication and authorization to your
@@ -3735,6 +3735,8 @@ export declare interface UpstreamGcpJwtInboundPolicyOptions {
  * We recommend reading the `serviceAccountJson` from environment variables (so it
  * is not checked in to source control) using the `$env(ENV_VAR)` syntax.
  *
+ * For information on how Google's service based auth works see {@link https://cloud.google.com/functions/docs/securing/authenticating|Authenticating for invocation}
+ *
  * @title Upstream GCP Service Auth
  * @public
  * @param request - The ZuploRequest
@@ -3759,11 +3761,11 @@ export declare interface UpstreamGcpServiceAuthInboundPolicyOptions {
      */
     serviceAccountJson: string;
     /**
-     * The number of times to retry fetching the token in the event of a failure. Defaults to 3.
+     * The number of times to retry fetching the token in the event of a failure.
      */
     tokenRetries?: number;
     /**
-     * The number of seconds less than the token expiration to cache the token. Defaults to 300 seconds.
+     * The number of seconds less than the token expiration to cache the token.
      */
     expirationOffsetSeconds?: number;
     /**
@@ -3835,22 +3837,22 @@ export declare interface ValidateJsonSchemaInboundOptions {
 }
 
 /**
- * Optional. Specify one of the options: 'none, log-only, reject-and-log, reject-only'. Default: none
+ * The action to perform when validation fails.
  */
 declare type ValidationOptions = "none" | "log-only" | "reject-and-log" | "reject-only";
 
 /**
- * Optional. Specify one of the options: 'none, log-only, reject-and-log, reject-only'. Default: none
+ * The action to perform when validation fails.
  */
 declare type ValidationOptions1 = "none" | "log-only" | "reject-and-log" | "reject-only";
 
 /**
- * Optional. Specify one of the options: 'none, log-only, reject-and-log, reject-only'. Default: none
+ * The action to perform when validation fails.
  */
 declare type ValidationOptions2 = "none" | "log-only" | "reject-and-log" | "reject-only";
 
 /**
- * Optional. Specify one of the options: 'none, log-only, reject-and-log, reject-only'. Default: none
+ * The action to perform when validation fails.
  */
 declare type ValidationOptions3 = "none" | "log-only" | "reject-and-log" | "reject-only";
 

package/package.json

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