@zuplo/cli 6.73.24 → 6.73.25

package/node_modules/@zuplo/runtime/out/types/internal/index.d.ts

@@ -1,7 +1,21 @@
+/* Excluded from this release type: AIGatewayConfiguration */
+
 export declare interface ApiRuntimeConfig {
   urls: UrlConfig | undefined;
 }
 
+/**
+ * Base logger interface with methods for each log level.
+ * @beta
+ */
+declare interface BaseLogger {
+  debug(...messages: unknown[]): void;
+  info(...messages: unknown[]): void;
+  log(...messages: unknown[]): void;
+  warn(...messages: unknown[]): void;
+  error(...messages: unknown[]): void;
+}
+
 /* Excluded from this release type: BuildEnvironment */
 
 /**
@@ -130,6 +144,12 @@ declare interface CompatibilityFlags {
   return501ForUnsupportedHttpMethods: boolean;
 }
 
+/**
+ * The 2-letter continent codes Cloudflare uses
+ * @public
+ */
+declare type ContinentCode = "AF" | "AN" | "AS" | "EU" | "NA" | "OC" | "SA";
+
 /**
  * @public
  */
@@ -152,6 +172,46 @@ declare interface CorsPolicyConfiguration {
 
 export declare type DevPortalType = "legacy" | "zudoku";
 
+declare const EventType: {
+  readonly AI_GATEWAY_COST_SUM: "ai_gateway_cost_sum";
+  readonly AI_GATEWAY_REQUEST_COUNT: "ai_gateway_request_count";
+  readonly AI_GATEWAY_TOKEN_SUM: "ai_gateway_token_sum";
+  readonly AI_GATEWAY_LATENCY_HISTOGRAM: "ai_gateway_latency_histogram";
+  readonly AI_GATEWAY_WARNING_COUNT: "ai_gateway_warning_count";
+  readonly AI_GATEWAY_BLOCKED_COUNT: "ai_gateway_blocked_count";
+  readonly AI_GATEWAY_FALLBACK_COUNT: "ai_gateway_fallback_count";
+  readonly MCP_REQUEST_RECEIVED: "mcp_request_received";
+  readonly MCP_REQUEST_COMPLETED: "mcp_request_completed";
+  readonly MCP_REQUEST_REJECTED: "mcp_request_rejected";
+  readonly MCP_INITIALIZE_NEGOTIATED: "mcp_initialize_negotiated";
+  readonly MCP_CLIENT_UNSUPPORTED_BEHAVIOR: "mcp_client_unsupported_behavior";
+  readonly MCP_CAPABILITY_LISTED: "mcp_capability_listed";
+  readonly MCP_CAPABILITY_INVOKED: "mcp_capability_invoked";
+  readonly MCP_CAPABILITY_COMPLETED: "mcp_capability_completed";
+  readonly MCP_CAPABILITY_FAILED: "mcp_capability_failed";
+  readonly MCP_CAPABILITY_CONNECT_REQUIRED: "mcp_capability_connect_required";
+  readonly MCP_AUTH_DOWNSTREAM_TOKEN_VALIDATED: "mcp_auth_downstream_token_validated";
+  readonly MCP_AUTH_DOWNSTREAM_TOKEN_REJECTED: "mcp_auth_downstream_token_rejected";
+  readonly MCP_OAUTH_CLIENT_REGISTERED: "mcp_oauth_client_registered";
+  readonly MCP_OAUTH_AUTHORIZE_STARTED: "mcp_oauth_authorize_started";
+  readonly MCP_OAUTH_AUTHORIZE_AWAITING_SETUP: "mcp_oauth_authorize_awaiting_setup";
+  readonly MCP_OAUTH_TOKEN_ISSUED: "mcp_oauth_token_issued";
+  readonly MCP_OAUTH_TOKEN_REFRESH_ROTATED: "mcp_oauth_token_refresh_rotated";
+  readonly MCP_OAUTH_TOKEN_REVOKED: "mcp_oauth_token_revoked";
+  readonly MCP_AUTH_UPSTREAM_CONNECT_REQUIRED: "mcp_auth_upstream_connect_required";
+  readonly MCP_AUTH_UPSTREAM_CONNECT_STARTED: "mcp_auth_upstream_connect_started";
+  readonly MCP_AUTH_UPSTREAM_CALLBACK_RECEIVED: "mcp_auth_upstream_callback_received";
+  readonly MCP_AUTH_UPSTREAM_TOKEN_EXCHANGE_SUCCEEDED: "mcp_auth_upstream_token_exchange_succeeded";
+  readonly MCP_AUTH_UPSTREAM_TOKEN_EXCHANGE_FAILED: "mcp_auth_upstream_token_exchange_failed";
+  readonly MCP_AUTH_UPSTREAM_CREDENTIAL_RESOLVED: "mcp_auth_upstream_credential_resolved";
+  readonly MCP_AUTH_UPSTREAM_CREDENTIAL_MISSING: "mcp_auth_upstream_credential_missing";
+  readonly MCP_AUTH_UPSTREAM_RECONSENT_REQUIRED: "mcp_auth_upstream_reconsent_required";
+  readonly GRAPHQL_OPERATION: "graphql_operation";
+  readonly CACHE_OPERATION: "cache_operation";
+};
+
+declare type EventType = (typeof EventType)[keyof typeof EventType];
+
 /* Excluded from this release type: getIdForParameterSchema */
 
 /* Excluded from this release type: getIdForRefSchema */
@@ -524,12 +584,417 @@ declare type HttpStatusCodeRangeDefinition =
   | "4XX"
   | "5XX";
 
+/**
+ * @public
+ */
+declare interface IncomingRequestProperties {
+  /**
+   * ASN of the incoming request, for example, 395747.
+   */
+  readonly asn: number | undefined;
+  /**
+   * The organization which owns the ASN of the incoming request,
+   * for example, Google Cloud.
+   */
+  readonly asOrganization: string | undefined;
+  /**
+   * City of the incoming request, for example, "Austin".
+   */
+  readonly city: string | undefined;
+  /**
+   * Continent of the incoming request, for example, "NA".
+   */
+  readonly continent: ContinentCode | undefined;
+  /**
+   * The two-letter country code in the request.
+   * @see {@link https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2|ISO 3166-1 alpha-2}
+   */
+  readonly country: Iso3166Alpha2Code | undefined;
+  /**
+   * Latitude of the incoming request, for example, "30.27130".
+   */
+  readonly latitude: string | undefined;
+  /**
+   * Longitude of the incoming request, for example, "-97.74260".
+   */
+  readonly longitude: string | undefined;
+  /**
+   * The three-letter IATA airport code of the data center that the request hit,
+   * for example, "DFW".
+   * @see {@link https://en.wikipedia.org/wiki/IATA_airport_code|IATA airport code}
+   */
+  readonly colo: string | undefined;
+  /**
+   * Postal code of the incoming request, for example, "78701".
+   */
+  readonly postalCode: string | undefined;
+  /**
+   * Metro code (DMA) of the incoming request, for example, "635".
+   */
+  readonly metroCode: string | undefined;
+  /**
+   * If known, the ISO 3166-2 name for the first level region associated with
+   * the IP address of the incoming request, for example, "Texas".
+   * @see {@link https://en.wikipedia.org/wiki/ISO_3166-2|ISO 3166-2}
+   */
+  readonly region: string | undefined;
+  /**
+   * If known, the ISO 3166-2 code for the first-level region associated with
+   * the IP address of the incoming request, for example, "TX".
+   * @see {@link https://en.wikipedia.org/wiki/ISO_3166-2|ISO 3166-2}
+   */
+  readonly regionCode: string | undefined;
+  /**
+   * Timezone of the incoming request, for example, "America/Chicago".
+   */
+  readonly timezone: string | undefined;
+  /**
+   * If available, the HTTP protocol of the incoming request, for example, "HTTP/1.1".
+   */
+  readonly httpProtocol: string | undefined;
+  /* Excluded from this release type: clientCert */
+  /* Excluded from this release type: clientMtlsVerificationStatus */
+  /* Excluded from this release type: clientMtlsVerificationReason */
+  /* Excluded from this release type: clientCertFingerprintSha256 */
+  /* Excluded from this release type: clientCertNotBefore */
+  /* Excluded from this release type: clientCertNotAfter */
+  /* Excluded from this release type: clientCertIssuerDn */
+  /* Excluded from this release type: clientCertSubjectDn */
+}
+
+/**
+ * ISO 3166-1 Alpha-2 codes
+ * @public
+ */
+declare type Iso3166Alpha2Code =
+  | "AD"
+  | "AE"
+  | "AF"
+  | "AG"
+  | "AI"
+  | "AL"
+  | "AM"
+  | "AO"
+  | "AQ"
+  | "AR"
+  | "AS"
+  | "AT"
+  | "AU"
+  | "AW"
+  | "AX"
+  | "AZ"
+  | "BA"
+  | "BB"
+  | "BD"
+  | "BE"
+  | "BF"
+  | "BG"
+  | "BH"
+  | "BI"
+  | "BJ"
+  | "BL"
+  | "BM"
+  | "BN"
+  | "BO"
+  | "BQ"
+  | "BR"
+  | "BS"
+  | "BT"
+  | "BV"
+  | "BW"
+  | "BY"
+  | "BZ"
+  | "CA"
+  | "CC"
+  | "CD"
+  | "CF"
+  | "CG"
+  | "CH"
+  | "CI"
+  | "CK"
+  | "CL"
+  | "CM"
+  | "CN"
+  | "CO"
+  | "CR"
+  | "CU"
+  | "CV"
+  | "CW"
+  | "CX"
+  | "CY"
+  | "CZ"
+  | "DE"
+  | "DJ"
+  | "DK"
+  | "DM"
+  | "DO"
+  | "DZ"
+  | "EC"
+  | "EE"
+  | "EG"
+  | "EH"
+  | "ER"
+  | "ES"
+  | "ET"
+  | "FI"
+  | "FJ"
+  | "FK"
+  | "FM"
+  | "FO"
+  | "FR"
+  | "GA"
+  | "GB"
+  | "GD"
+  | "GE"
+  | "GF"
+  | "GG"
+  | "GH"
+  | "GI"
+  | "GL"
+  | "GM"
+  | "GN"
+  | "GP"
+  | "GQ"
+  | "GR"
+  | "GS"
+  | "GT"
+  | "GU"
+  | "GW"
+  | "GY"
+  | "HK"
+  | "HM"
+  | "HN"
+  | "HR"
+  | "HT"
+  | "HU"
+  | "ID"
+  | "IE"
+  | "IL"
+  | "IM"
+  | "IN"
+  | "IO"
+  | "IQ"
+  | "IR"
+  | "IS"
+  | "IT"
+  | "JE"
+  | "JM"
+  | "JO"
+  | "JP"
+  | "KE"
+  | "KG"
+  | "KH"
+  | "KI"
+  | "KM"
+  | "KN"
+  | "KP"
+  | "KR"
+  | "KW"
+  | "KY"
+  | "KZ"
+  | "LA"
+  | "LB"
+  | "LC"
+  | "LI"
+  | "LK"
+  | "LR"
+  | "LS"
+  | "LT"
+  | "LU"
+  | "LV"
+  | "LY"
+  | "MA"
+  | "MC"
+  | "MD"
+  | "ME"
+  | "MF"
+  | "MG"
+  | "MH"
+  | "MK"
+  | "ML"
+  | "MM"
+  | "MN"
+  | "MO"
+  | "MP"
+  | "MQ"
+  | "MR"
+  | "MS"
+  | "MT"
+  | "MU"
+  | "MV"
+  | "MW"
+  | "MX"
+  | "MY"
+  | "MZ"
+  | "NA"
+  | "NC"
+  | "NE"
+  | "NF"
+  | "NG"
+  | "NI"
+  | "NL"
+  | "NO"
+  | "NP"
+  | "NR"
+  | "NU"
+  | "NZ"
+  | "OM"
+  | "PA"
+  | "PE"
+  | "PF"
+  | "PG"
+  | "PH"
+  | "PK"
+  | "PL"
+  | "PM"
+  | "PN"
+  | "PR"
+  | "PS"
+  | "PT"
+  | "PW"
+  | "PY"
+  | "QA"
+  | "RE"
+  | "RO"
+  | "RS"
+  | "RU"
+  | "RW"
+  | "SA"
+  | "SB"
+  | "SC"
+  | "SD"
+  | "SE"
+  | "SG"
+  | "SH"
+  | "SI"
+  | "SJ"
+  | "SK"
+  | "SL"
+  | "SM"
+  | "SN"
+  | "SO"
+  | "SR"
+  | "SS"
+  | "ST"
+  | "SV"
+  | "SX"
+  | "SY"
+  | "SZ"
+  | "TC"
+  | "TD"
+  | "TF"
+  | "TG"
+  | "TH"
+  | "TJ"
+  | "TK"
+  | "TL"
+  | "TM"
+  | "TN"
+  | "TO"
+  | "TR"
+  | "TT"
+  | "TV"
+  | "TW"
+  | "TZ"
+  | "UA"
+  | "UG"
+  | "UM"
+  | "US"
+  | "UY"
+  | "UZ"
+  | "VA"
+  | "VC"
+  | "VE"
+  | "VG"
+  | "VI"
+  | "VN"
+  | "VU"
+  | "WF"
+  | "WS"
+  | "YE"
+  | "YT"
+  | "ZA"
+  | "ZM"
+  | "ZW";
+
 /* Excluded from this release type: isRestrictedEnvVariableName */
 
 /* Excluded from this release type: isZuploReadableEnvVariableName */
 
+declare type JsonArray = JsonValue[] | readonly JsonValue[];
+
+/**
+ Matches a JSON object.
+ This type can be useful to enforce some input to be JSON-compatible or as a super-type to be extended from. Don't use this as a direct return type as the user would have to double-cast it: `jsonObject as unknown as CustomResponse`. Instead, you could extend your CustomResponse type from it to ensure your type only uses JSON-compatible types: `interface CustomResponse extends JsonObject { … }`.
+ */
+declare type JsonObject = {
+  [Key in string]: JsonValue;
+} & {
+  [Key in string]?: JsonValue | undefined;
+};
+
+declare type JsonPrimitive = string | number | boolean | null;
+
+/**
+ Matches any valid JSON value.
+ @see `Jsonify` if you need to transform a type to one that is assignable to `JsonValue`.
+ */
+declare type JsonValue = JsonPrimitive | JsonObject | JsonArray;
+
+/**
+ * Logger to be used in the runtime via context.log.
+ * You can set per-request properties that will be included in all log entries for this request.
+ * @beta
+ */
+declare interface Logger extends BaseLogger {
+  /**
+   * Set properties that will be included in all subsequent log entries for this request.
+   * Properties are merged with existing properties and any static fields configured in the logging plugin.
+   * Per-request properties take precedence over static fields with the same name.
+   *
+   * @param properties - Key-value pairs to include in log entries. Values must be string, number, or boolean.
+   *
+   * @example
+   * ```ts
+   * export default async function (request: ZuploRequest, context: ZuploContext) {
+   *   // Set properties that will be included in all logs for this request
+   *   context.log.setLogProperties({ http_status_code: 400, user_id: "123" });
+   *
+   *   context.log.error("Request failed"); // Will include http_status_code and user_id
+   *
+   *   return new Response("Error", { status: 400 });
+   * }
+   * ```
+   */
+  setLogProperties?(
+    properties: Record<string, string | number | boolean>
+  ): void;
+}
+
 declare type Modify<T, R> = Omit<T, keyof R> & R;
 
+/**
+ * @public
+ */
+declare interface OnResponseSendingFinalHook {
+  (
+    response: Response,
+    request: ZuploRequest,
+    context: ZuploContext
+  ): Promise<void> | void;
+}
+
+/**
+ * @public
+ */
+declare interface OnResponseSendingHook {
+  (
+    response: Response,
+    request: ZuploRequest,
+    context: ZuploContext
+  ): Promise<Response> | Response;
+}
+
 declare namespace OpenAPIV3 {
   interface Document<T extends {} = {}> {
     openapi: string;
@@ -1099,6 +1564,65 @@ declare interface PolicyConfiguration {
   options?: unknown;
 }
 
+/**
+ * Generic type parameters for a request.
+ * Extends RequestInitGeneric and adds query parameter typing.
+ * @public
+ */
+declare interface RequestGeneric extends RequestInitGeneric {
+  Query?: RequestQueryDefault;
+}
+
+/**
+ * Generic type parameters for request initialization.
+ * Used to strongly type the user data and path parameters.
+ * @public
+ */
+declare interface RequestInitGeneric {
+  UserData?: UserDataDefault;
+  Params?: RequestParamsDefault;
+}
+
+declare type RequestParamsDefault = Record<string, string>;
+
+declare type RequestQueryDefault = Record<string, string>;
+
+/**
+ * Represents an authenticated user on the request.
+ * Set by authentication policies like API key, JWT, or OAuth.
+ *
+ * @public
+ * @example
+ * ```typescript
+ * // Access user info in a handler
+ * export function myHandler(request: ZuploRequest, context: ZuploContext) {
+ *   if (!request.user) {
+ *     return new Response("Unauthorized", { status: 401 });
+ *   }
+ *
+ *   const userId = request.user.sub;
+ *   const customData = request.user.data as { role: string; tenantId: string };
+ *
+ *   context.log.info(`Request from user ${userId} with role ${customData.role}`);
+ * }
+ * ```
+ */
+declare interface RequestUser<TUserData> {
+  sub: string;
+  data: TUserData;
+}
+
+declare type ResolveRequestParams<
+  TParams extends RequestParamsDefault | undefined,
+> = TParams extends RequestParamsDefault ? TParams : RequestParamsDefault;
+
+declare type ResolveRequestQuery<
+  TQuery extends RequestQueryDefault | undefined,
+> = TQuery extends RequestQueryDefault ? TQuery : RequestQueryDefault;
+
+declare type ResolveUserData<TUserData extends UserDataDefault | undefined> =
+  TUserData extends UserDataDefault ? TUserData : UserDataDefault;
+
 /**
  * Definition of responses for a route
  * @public
@@ -1172,4 +1696,267 @@ declare interface UrlConfig {
   urls: string[];
 }
 
+declare type UserDataDefault = any;
+
+/**
+ * @public
+ */
+declare interface WaitUntilFunc {
+  (promise: Promise<any>): void;
+}
+
+declare interface ZuploAnalyticsContext {
+  addAnalyticsEvent(
+    value: number,
+    eventType: EventType,
+    metadata: JsonObject,
+    unit?: string,
+    eventId?: string
+  ): void;
+  flushAnalyticsEvents(): ZuploAnalyticsEvent[];
+  getAnalyticsEvents(): ZuploAnalyticsEvent[];
+}
+
+declare interface ZuploAnalyticsEvent<T extends JsonObject = JsonObject> {
+  eventId: string;
+  requestId: string;
+  timestamp: Date;
+  accountName: string;
+  projectName: string;
+  deploymentName: string;
+  eventType: EventType;
+  metadata: T;
+  unit?: string;
+  value: number;
+}
+
+/**
+ * The ZuploContext provides information about the current request and helper methods.
+ * @public
+ */
+declare interface ZuploContext extends EventTarget {
+  /**
+   * The unique identifier of this context
+   */
+  readonly contextId: Readonly<string>;
+  /**
+   * The unique identifier of the incoming request
+   */
+  readonly requestId: Readonly<string>;
+  /**
+   * Request based logger
+   */
+  readonly log: Readonly<Logger>;
+  /**
+   * The route that is being processed
+   */
+  readonly route: Readonly<RouteConfiguration>;
+  /**
+   * Custom data stored on the ZuploContext
+   */
+  readonly custom: Record<string, any>;
+  readonly incomingRequestProperties: IncomingRequestProperties;
+  /**
+   * The parent context that spawned this context
+   * @beta
+   */
+  readonly parentContext: ZuploContext | undefined;
+  /* Excluded from this release type: analyticsContext */
+  readonly invokeInboundPolicy: (
+    policyName: string,
+    request: ZuploRequest
+  ) => Promise<Response | ZuploRequest>;
+  readonly invokeOutboundPolicy: (
+    policyName: string,
+    response: Response,
+    request: ZuploRequest
+  ) => Promise<Response>;
+  /**
+   * Invokes a route based on a Request without going back out to HTTP.
+   * Can take a relative route path to invoke on the Gateway
+   * Example: "/my/route" will invoke http://localhost/my/route on the Gateway
+   * without having to rebuild the Request's protocol and host.
+   * @beta
+   */
+  readonly invokeRoute: <TOptions extends RequestGeneric = RequestGeneric>(
+    input: string | URL | Request,
+    init?: ZuploRequestInit<TOptions>
+  ) => Promise<Response>;
+  readonly waitUntil: WaitUntilFunc;
+  /**
+   * Fires just before the response is sent. Response can be modified.
+   */
+  readonly addResponseSendingHook: (hook: OnResponseSendingHook) => void;
+  /**
+   * Fires immediately after the response is sent. Response cannot be modified.
+   */
+  readonly addResponseSendingFinalHook: (
+    hook: OnResponseSendingFinalHook
+  ) => void;
+  /**
+   * Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.
+   *
+   * The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.
+   *
+   * When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.
+   *
+   * When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.
+   *
+   * When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.
+   *
+   * If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.
+   *
+   * The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.
+   * @deprecated This will be removed in the future. Use hooks instead. See {@link https://zuplo.com/docs/programmable-api/runtime-extensions}
+   */
+  addEventListener<Type extends keyof Record<string, Event>>(
+    type: Type,
+    handler: EventListenerOrEventListenerObject,
+    options?: AddEventListenerOptions | boolean
+  ): void;
+  /**
+   * @deprecated This will be removed in the future. See {@link https://zuplo.com/docs/programmable-api/runtime-extensions}
+   */
+  removeEventListener<Type extends keyof Record<string, Event>>(
+    type: Type,
+    handler: EventListenerOrEventListenerObject,
+    options?: AddEventListenerOptions | boolean
+  ): void;
+}
+
+/**
+ * Enhanced Request class that extends the standard Web Request API with
+ * convenient properties for accessing path parameters, query strings, and user data.
+ * This is the request type passed to all handlers and policies in Zuplo.
+ *
+ * @public
+ * @example
+ * ```typescript
+ * import { ZuploRequest, ZuploContext } from "@zuplo/runtime";
+ *
+ * export function myHandler(request: ZuploRequest, context: ZuploContext) {
+ *   // Access query parameters
+ *   const page = request.query.page || "1";
+ *   const limit = request.query.limit || "10";
+ *
+ *   // Access path parameters (e.g., from /users/:userId)
+ *   const userId = request.params.userId;
+ *
+ *   // Access authenticated user
+ *   const user = request.user;
+ *
+ *   // Standard Request properties still available
+ *   const contentType = request.headers.get("content-type");
+ *   const method = request.method;
+ *
+ *   return Response.json({
+ *     userId,
+ *     page,
+ *     limit,
+ *     authenticated: !!user
+ *   });
+ * }
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Strongly typed request parameters
+ * interface MyParams {
+ *   userId: string;
+ *   orderId: string;
+ * }
+ *
+ * interface MyQuery {
+ *   include?: string;
+ *   format?: "json" | "xml";
+ * }
+ *
+ * interface MyUserData {
+ *   role: "admin" | "user";
+ *   tenantId: string;
+ * }
+ *
+ * type MyRequest = ZuploRequest<{
+ *   Params: MyParams;
+ *   Query: MyQuery;
+ *   UserData: MyUserData;
+ * }>;
+ *
+ * export function typedHandler(request: MyRequest, context: ZuploContext) {
+ *   // All properties are now strongly typed
+ *   const userId = request.params.userId; // string
+ *   const format = request.query.format; // "json" | "xml" | undefined
+ *   const role = request.user?.data.role; // "admin" | "user" | undefined
+ * }
+ * ```
+ */
+declare class ZuploRequest<
+  TOptions extends RequestGeneric = RequestGeneric,
+> extends Request {
+  #private;
+  constructor(
+    input: string | URL | Request,
+    init?: ZuploRequestInit<TOptions>,
+    originalRequest?: Request
+  );
+  /* Excluded from this release type: originalRequest */
+  /**
+   * A dictionary of query-string values
+   *
+   * @example
+   * The url `https://example.com?foo=bar` would return
+   * the following query object:
+   *
+   * ```
+   * const foo = request.query.foo;
+   * ```
+   *
+   * @readonly
+   */
+  get query(): Readonly<ResolveRequestQuery<TOptions["Query"]>>;
+  /**
+   * If you use tokens in your route’s URL, they are
+   * automatically parsed into properties on the params
+   * property of your request.
+   *
+   * @example
+   * The route `/products/:productId/vendors/:vendorId`
+   * would include two params:
+   *
+   * ```
+   * const productId = request.params.productId;
+   * const vendorId = request.params.vendorId;
+   * ```
+   * @readonly
+   */
+  get params(): Readonly<ResolveRequestParams<TOptions["Params"]>>;
+  /**
+   * An optional object identifying a ‘user’.
+   *
+   * @remarks
+   * If undefined this typically means the request is
+   * anonymous. If present, the user object will have
+   * a sub property that is a unique identifier for
+   * that user. There is also an optional data property
+   * that is of any type that typically contains other
+   * information about the user. When using JWT tokens
+   * you’ll usually find all the claims here.
+   *
+   * @readonly
+   */
+  user?: RequestUser<ResolveUserData<TOptions["UserData"]>>;
+}
+
+/**
+ * Options for creating a new ZuploRequest.
+ * Extends the standard RequestInit with Zuplo-specific properties.
+ * @public
+ */
+declare interface ZuploRequestInit<
+  TOptions extends RequestInitGeneric = RequestInitGeneric,
+> extends RequestInit {
+  params?: ResolveRequestParams<TOptions["Params"]>;
+  user?: ResolveUserData<TOptions["UserData"]>;
+}
+
 export {};