@zuplo/runtime 6.52.4 → 6.52.6

package/out/types/internal/index.d.ts

@@ -1,5 +1,8 @@
 /* Excluded from this release type: BuildEnvironment */
 
+/**
+ * @public
+ */
 declare interface BuildRouteConfiguration {
     path: string;
     methods: HttpMethod[];
@@ -93,8 +96,14 @@ declare interface CompatibilityFlags {
     useForwardRedirectsPropOnUrlForwardHandler: boolean;
 }
 
+/**
+ * @public
+ */
 declare type CorsPolicy = string | "anything-goes" | "none";
 
+/**
+ * @public
+ */
 declare interface CorsPolicyConfiguration {
     name: string;
     allowCredentials?: boolean;
@@ -107,20 +116,26 @@ declare interface CorsPolicyConfiguration {
 
 /* Excluded from this release type: DevPortalRuntimeConfig */
 
-export declare function getIdForParameterSchema(path: string, operation: string, type: string, name: string): string;
+/* Excluded from this release type: getIdForParameterSchema */
 
-export declare function getIdForRefSchema(oasFileName: string, ref: string): string;
+/* Excluded from this release type: getIdForRefSchema */
 
-export declare function getIdForRequestBodySchema(path: string, operation: string, contentType: string): string;
+/* Excluded from this release type: getIdForRequestBodySchema */
 
-export declare function getRawOperationDataIdentifierName(oasFileName: string, path: string, operation: string): string;
+/* Excluded from this release type: getRawOperationDataIdentifierName */
 
+/**
+ * @public
+ */
 declare interface HandlerDefinition {
     module: any;
     export: string;
     options?: unknown;
 }
 
+/**
+ * @public
+ */
 export declare type HttpMethod = "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "CONNECT" | "OPTIONS" | "TRACE" | "PATCH";
 
 /**
@@ -461,7 +476,7 @@ declare type HttpStatusCodeRangeDefinition = "1XX" | "2XX" | "3XX" | "4XX" | "5X
 
 /* Excluded from this release type: isRestrictedEnvVariableName */
 
-export declare function isZuploReadableEnvVariableName(name: string): boolean;
+/* Excluded from this release type: isZuploReadableEnvVariableName */
 
 declare type Modify<T, R> = Omit<T, keyof R> & R;
 
@@ -928,20 +943,25 @@ declare namespace OpenAPIV3_1 {
 }
 
 /**
- * @beta
+ * Base object for parameter definitions
+ * @public
  */
 declare type ParameterBaseObject = Modify<Omit<OpenAPIV3_1.ParameterBaseObject, "content" | "allowEmptyValue" | "style" | "allowReserved" | "explode" | "example" | "examples">, {
     schema: OpenAPIV3_1.SchemaObject;
 }>;
 
 /**
- * @beta
+ * Definition of a parameter
+ * @public
  */
 declare interface ParameterDefinition extends ParameterBaseObject {
     name: string;
     in: string;
 }
 
+/**
+ * @public
+ */
 declare interface PolicyConfiguration {
     name: string;
     policyType: string;
@@ -950,7 +970,8 @@ declare interface PolicyConfiguration {
 }
 
 /**
- * @beta
+ * Definition of responses for a route
+ * @public
  */
 export declare type ResponsesDefinition = Record<HttpStatusCode | HttpStatusCodeRangeDefinition, Modify<Omit<OpenAPIV3_1.ResponseObject, "links">, {
     headers?: {
@@ -958,6 +979,9 @@ export declare type ResponsesDefinition = Record<HttpStatusCode | HttpStatusCode
     };
 }>>;
 
+/**
+ * @public
+ */
 export declare interface RouteConfiguration extends Omit<BuildRouteConfiguration, "raw"> {
     /**
      * @deprecated Please switch to "raw().operationId"
@@ -985,6 +1009,9 @@ export declare interface RouteConfiguration extends Omit<BuildRouteConfiguration
     raw<T = any>(): T;
 }
 
+/**
+ * @public
+ */
 export declare interface RouteData {
     /**
      * @deprecated This property is not used and will be removed in future versions
@@ -995,7 +1022,7 @@ export declare interface RouteData {
     corsPolicies: CorsPolicyConfiguration[];
 }
 
-export declare function sanitizedIdentifierName(name: string): string;
+/* Excluded from this release type: sanitizedIdentifierName */
 
 /* Excluded from this release type: StandardEnv */
 

package/out/types/mocks/index.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @public
+ */
 declare interface BuildRouteConfiguration {
     path: string;
     methods: HttpMethod[];
@@ -39,11 +42,21 @@ declare interface BuildRouteConfiguration {
     /* Excluded from this release type: raw */
 }
 
-/** The 2-letter continent codes Cloudflare uses */
+/**
+ * The 2-letter continent codes Cloudflare uses
+ * @public
+ */
 declare type ContinentCode = "AF" | "AN" | "AS" | "EU" | "NA" | "OC" | "SA";
 
+/**
+ * @public
+ */
 declare type CorsPolicy = string | "anything-goes" | "none";
 
+/**
+ * Creates a mock Zuplo context for testing
+ * @public
+ */
 export declare function createMockContext(options?: {
     request?: Request;
     route?: RouteConfiguration;
@@ -52,12 +65,18 @@ export declare function createMockContext(options?: {
     invokeResponse: () => Promise<void>;
 };
 
+/**
+ * @public
+ */
 declare interface HandlerDefinition {
     module: any;
     export: string;
     options?: unknown;
 }
 
+/**
+ * @public
+ */
 declare type HttpMethod = "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "CONNECT" | "OPTIONS" | "TRACE" | "PATCH";
 
 /**
@@ -396,6 +415,9 @@ declare enum HttpStatusCode {
 
 declare type HttpStatusCodeRangeDefinition = "1XX" | "2XX" | "3XX" | "4XX" | "5XX";
 
+/**
+ * @public
+ */
 declare interface IncomingRequestProperties {
     /**
      * ASN of the incoming request, for example, 395747.
@@ -463,7 +485,10 @@ declare interface IncomingRequestProperties {
     readonly httpProtocol: string | undefined;
 }
 
-/** ISO 3166-1 Alpha-2 codes */
+/**
+ * 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";
 
 /**
@@ -477,6 +502,10 @@ declare interface Logger {
     error(...messages: unknown[]): void;
 }
 
+/**
+ * Mock implementation of ZuploContext for testing
+ * @public
+ */
 export declare class MockZuploContext extends EventTarget implements ZuploContext {
     #private;
     readonly contextId: string;
@@ -985,14 +1014,16 @@ declare namespace OpenAPIV3_1 {
 }
 
 /**
- * @beta
+ * Base object for parameter definitions
+ * @public
  */
 declare type ParameterBaseObject = Modify<Omit<OpenAPIV3_1.ParameterBaseObject, "content" | "allowEmptyValue" | "style" | "allowReserved" | "explode" | "example" | "examples">, {
     schema: OpenAPIV3_1.SchemaObject;
 }>;
 
 /**
- * @beta
+ * Definition of a parameter
+ * @public
  */
 declare interface ParameterDefinition extends ParameterBaseObject {
     name: string;
@@ -1000,7 +1031,8 @@ declare interface ParameterDefinition extends ParameterBaseObject {
 }
 
 /**
- * The types of the properties in a request
+ * Generic type parameters for a request.
+ * Extends RequestInitGeneric and adds query parameter typing.
  * @public
  */
 declare interface RequestGeneric extends RequestInitGeneric {
@@ -1008,7 +1040,8 @@ declare interface RequestGeneric extends RequestInitGeneric {
 }
 
 /**
- * The types of the properties in a request init object
+ * Generic type parameters for request initialization.
+ * Used to strongly type the user data and path parameters.
  * @public
  */
 declare interface RequestInitGeneric {
@@ -1021,8 +1054,24 @@ declare type RequestParamsDefault = Record<string, string>;
 declare type RequestQueryDefault = Record<string, string>;
 
 /**
- * The authorized identity on the incoming request
+ * 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;
@@ -1036,7 +1085,8 @@ declare type ResolveRequestQuery<TQuery extends RequestQueryDefault | undefined>
 declare type ResolveUserData<TUserData extends UserDataDefault | undefined> = TUserData extends UserDataDefault ? TUserData : UserDataDefault;
 
 /**
- * @beta
+ * Definition of responses for a route
+ * @public
  */
 declare type ResponsesDefinition = Record<HttpStatusCode | HttpStatusCodeRangeDefinition, Modify<Omit<OpenAPIV3_1.ResponseObject, "links">, {
     headers?: {
@@ -1044,6 +1094,9 @@ declare type ResponsesDefinition = Record<HttpStatusCode | HttpStatusCodeRangeDe
     };
 }>>;
 
+/**
+ * @public
+ */
 declare interface RouteConfiguration extends Omit<BuildRouteConfiguration, "raw"> {
     /**
      * @deprecated Please switch to "raw().operationId"
@@ -1080,6 +1133,10 @@ declare interface WaitUntilFunc {
     (promise: Promise<any>): void;
 }
 
+/**
+ * The ZuploContext provides information about the current request and helper methods.
+ * @public
+ */
 declare interface ZuploContext extends EventTarget {
     /**
      * The unique identifier of this context
@@ -1152,10 +1209,70 @@ declare interface ZuploContext extends EventTarget {
 /* Excluded from this release type: ZuploEventContext */
 
 /**
- * ZuploRequest includes various parsed objects from the
- * incoming Request. This object inherits from the web
- * standard {@link https://developer.mozilla.org/en-US/docs/Web/API/Request | Request}.
+ * 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;
@@ -1208,7 +1325,8 @@ declare class ZuploRequest<TOptions extends RequestGeneric = RequestGeneric> ext
 }
 
 /**
- * The initialization values of a request
+ * Options for creating a new ZuploRequest.
+ * Extends the standard RequestInit with Zuplo-specific properties.
  * @public
  */
 declare interface ZuploRequestInit<TOptions extends RequestInitGeneric = RequestInitGeneric> extends RequestInit {

package/package.json

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