@zuplo/runtime 6.54.16 → 6.54.18

package/out/types/index.d.ts

@@ -4426,6 +4426,7 @@ export declare class JwtServicePlugin extends SystemRuntimePlugin {
   static signJwt({
     audience,
     subject,
+    expiresIn,
     ...payload
   }: JWTSignPayload): Promise<string>;
   constructor(options?: JwtServicePluginOptions);
@@ -4439,11 +4440,16 @@ export declare class JwtServicePlugin extends SystemRuntimePlugin {
 }
 
 declare interface JwtServicePluginOptions {
+  /**
+   * The base path for the JWT issuer endpoint.
+   * The default value is "/__zuplo/issuer".
+   */
   basePath?: string;
   /**
-   * Sets time for the "exp" (Expiration Time) Claim in the JWT.
+   * Sets the default time for the "exp" (Expiration Time) Claim in the JWT.
+   * This value can be overridden when signing a JWT.
    *
-   * - If a `number` is passed as an argument it is used as the claim directly.
+   * - If a `number` is passed as an argument it is treated as seconds and added to the current time.
    * - If a `string` is passed as an argument it is resolved to a time span, and then added to the
    *   current unix timestamp and used as the claim.
    *
@@ -4459,7 +4465,7 @@ declare interface JwtServicePluginOptions {
    * subtracted from the current unix timestamp. A "from now" suffix can also be used for
    * readability when adding to the current unix timestamp.
    */
-  tokenExpiration?: number | string;
+  expiresIn?: number | string;
 }
 
 declare interface JWTSignPayload {
@@ -4476,6 +4482,26 @@ declare interface JWTSignPayload {
    * If not provided, the JWT will not have an audience claim.
    */
   audience?: string;
+  /**
+   * Sets time for the "exp" (Expiration Time) Claim in the JWT.
+   *
+   * - If a `number` is passed as an argument it is treated as seconds and added to the current time.
+   * - If a `string` is passed as an argument it is resolved to a time span, and then added to the
+   *   current unix timestamp and used as the claim.
+   *
+   * Format used for time span should be a number followed by a unit, such as "5 minutes" or "1
+   * day".
+   *
+   * Valid units are: "sec", "secs", "second", "seconds", "s", "minute", "minutes", "min", "mins",
+   * "m", "hour", "hours", "hr", "hrs", "h", "day", "days", "d", "week", "weeks", "w", "year",
+   * "years", "yr", "yrs", and "y". It is not possible to specify months. 365.25 days is used as an
+   * alias for a year.
+   *
+   * If the string is suffixed with "ago", or prefixed with a "-", the resulting time span gets
+   * subtracted from the current unix timestamp. A "from now" suffix can also be used for
+   * readability when adding to the current unix timestamp.
+   */
+  expiresIn?: number | string;
   [key: string]: any;
 }
 
@@ -8204,6 +8230,66 @@ export declare interface UpstreamGcpServiceAuthInboundPolicyOptions {
   version?: 1 | 2;
 }
 
+/**
+ * Generates a Zuplo JWT token and attaches it to the outgoing request. This
+ * policy creates a self-signed JWT using the Zuplo JWT plugin and adds it
+ * to the specified header for upstream authentication.
+ *
+ * @title Upstream Zuplo JWT
+ * @enterprise
+ * @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 ZuploRequest
+ */
+export declare class UpstreamZuploJwtAuthInboundPolicy extends InboundPolicy<UpstreamZuploJwtAuthInboundPolicyOptions> {
+  constructor(
+    options: UpstreamZuploJwtAuthInboundPolicyOptions,
+    policyName: string
+  );
+  /**
+   * 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
+   */
+  handler(
+    request: ZuploRequest,
+    context: ZuploContext
+  ): Promise<ZuploRequest | Response>;
+}
+
+/**
+ * The options for the Upstream Zuplo JWT Auth Inbound policy.
+ * @public
+ */
+export declare interface UpstreamZuploJwtAuthInboundPolicyOptions {
+  /**
+   * The audience claim for the JWT.
+   */
+  audience?: string;
+  /**
+   * The header name where the JWT will be attached. Defaults to 'Authorization'.
+   */
+  headerName?: string;
+  /**
+   * The prefix to use before the JWT token. Defaults to 'Bearer'. Set to an empty string to send the token without a prefix.
+   */
+  tokenPrefix?: string;
+  /**
+   * Additional claims to include in the JWT. These will be merged with the default claims.
+   */
+  additionalClaims?: {
+    [k: string]: unknown;
+  };
+  /**
+   * JWT expiration time. Can be a number (seconds) or a string with units (e.g., '5m' for 5 minutes, '1h' for 1 hour, '7d' for 7 days). Defaults to 300 seconds (5 minutes).
+   */
+  expiresIn?: number | string;
+}
+
 declare interface UrlConfig {
   defaultUrl: string;
   urls: string[];

package/package.json

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