@lokalise/api-contracts 6.3.0 → 6.5.0

package/README.md

@@ -8,6 +8,69 @@ This reduces amount of assumptions FE needs to make about the behaviour of BE, r
 written on FE, and makes the code more type-safe (as path parameter setting is handled by logic exposed by BE, in a
 type-safe way).
 
+## Universal Contract Builder
+
+Use `buildContract` as a single entry point for creating any type of API contract. It automatically delegates to the appropriate specialized builder based on the configuration:
+
+| `sseEvents` | Contract Type |
+|-------------|---------------|
+| ❌ | REST contract (GET, POST, PUT, PATCH, DELETE) |
+| ✅ | SSE or Dual-mode contract |
+
+```ts
+import { buildContract } from '@lokalise/api-contracts'
+import { z } from 'zod'
+
+// REST GET route
+const getUsers = buildContract({
+    successResponseBodySchema: z.array(userSchema),
+    pathResolver: () => '/api/users',
+})
+
+// REST POST route
+const createUser = buildContract({
+    method: 'post',
+    requestBodySchema: createUserSchema,
+    successResponseBodySchema: userSchema,
+    pathResolver: () => '/api/users',
+})
+
+// REST DELETE route
+const deleteUser = buildContract({
+    method: 'delete',
+    requestPathParamsSchema: z.object({ userId: z.string() }),
+    pathResolver: (params) => `/api/users/${params.userId}`,
+})
+
+// SSE-only streaming endpoint
+const notifications = buildContract({
+    pathResolver: () => '/api/notifications/stream',
+    params: z.object({}),
+    query: z.object({}),
+    requestHeaders: z.object({}),
+    sseEvents: {
+        notification: z.object({ id: z.string(), message: z.string() }),
+    },
+})
+
+// Dual-mode endpoint (supports both JSON and SSE)
+const chatCompletion = buildContract({
+    method: 'post',
+    pathResolver: () => '/api/chat/completions',
+    params: z.object({}),
+    query: z.object({}),
+    requestHeaders: z.object({}),
+    requestBody: z.object({ message: z.string() }),
+    syncResponseBody: z.object({ reply: z.string() }),
+    sseEvents: {
+        chunk: z.object({ delta: z.string() }),
+        done: z.object({ usage: z.object({ tokens: z.number() }) }),
+    },
+})
+```
+
+You can also use the specialized builders directly (`buildRestContract`, `buildSseContract`) if you prefer explicit control over contract types.
+
 ## REST Contracts
 
 Use `buildRestContract` to create REST API contracts. The contract type is automatically determined based on the configuration:

package/dist/contractBuilder.d.ts

@@ -0,0 +1,84 @@
+import type { z } from 'zod/v4';
+import type { DeleteRouteDefinition, GetRouteDefinition, PayloadRouteDefinition } from './apiContracts.ts';
+import type { HttpStatusCode } from './HttpStatusCodes.ts';
+import { type DeleteContractConfig, type GetContractConfig, type PayloadContractConfig } from './rest/restContractBuilder.ts';
+import type { DualModeContractDefinition } from './sse/dualModeContracts.ts';
+import { type DualModeGetContractConfig, type DualModePayloadContractConfig, type SSEGetContractConfig, type SSEPayloadContractConfig } from './sse/sseContractBuilders.ts';
+import type { SSEContractDefinition } from './sse/sseContracts.ts';
+import type { SSEEventSchemas } from './sse/sseTypes.ts';
+/**
+ * Universal contract builder that creates either REST or SSE contracts based on configuration.
+ *
+ * This is a unified entry point that delegates to:
+ * - `buildRestContract` when no `serverSentEventSchemas` is provided
+ * - `buildSseContract` when `serverSentEventSchemas` is provided
+ *
+ * ## Contract Type Detection
+ *
+ * | `serverSentEventSchemas` | `successResponseBodySchema` | `requestBodySchema` | Result |
+ * |--------------------|----------------------------|---------------------|--------|
+ * | ❌ | - | ❌ | REST GET |
+ * | ❌ | - | ✅ (method: post/put/patch) | REST Payload |
+ * | ❌ | - | ❌ (method: delete) | REST DELETE |
+ * | ✅ | ❌ | ❌ | SSE-only GET |
+ * | ✅ | ❌ | ✅ | SSE-only POST/PUT/PATCH |
+ * | ✅ | ✅ | ❌ | Dual-mode GET |
+ * | ✅ | ✅ | ✅ | Dual-mode POST/PUT/PATCH |
+ *
+ * @example
+ * ```typescript
+ * // REST GET route
+ * const getUsers = buildContract({
+ *   successResponseBodySchema: z.array(userSchema),
+ *   pathResolver: () => '/api/users',
+ * })
+ *
+ * // REST POST route
+ * const createUser = buildContract({
+ *   method: 'post',
+ *   requestBodySchema: createUserSchema,
+ *   successResponseBodySchema: userSchema,
+ *   pathResolver: () => '/api/users',
+ * })
+ *
+ * // REST DELETE route
+ * const deleteUser = buildContract({
+ *   method: 'delete',
+ *   pathResolver: (params) => `/api/users/${params.userId}`,
+ *   requestPathParamsSchema: z.object({ userId: z.string() }),
+ * })
+ *
+ * // SSE-only streaming endpoint
+ * const notifications = buildContract({
+ *   pathResolver: () => '/api/notifications/stream',
+ *   requestPathParamsSchema: z.object({}),
+ *   requestQuerySchema: z.object({}),
+ *   requestHeaderSchema: z.object({}),
+ *   serverSentEventSchemas: {
+ *     notification: z.object({ id: z.string(), message: z.string() }),
+ *   },
+ * })
+ *
+ * // Dual-mode endpoint (supports both JSON and SSE)
+ * const chatCompletion = buildContract({
+ *   method: 'post',
+ *   pathResolver: () => '/api/chat/completions',
+ *   requestPathParamsSchema: z.object({}),
+ *   requestQuerySchema: z.object({}),
+ *   requestHeaderSchema: z.object({}),
+ *   requestBodySchema: z.object({ message: z.string() }),
+ *   successResponseBodySchema: z.object({ reply: z.string() }),
+ *   serverSentEventSchemas: {
+ *     chunk: z.object({ delta: z.string() }),
+ *     done: z.object({ usage: z.object({ tokens: z.number() }) }),
+ *   },
+ * })
+ * ```
+ */
+export declare function buildContract<SuccessResponseBodySchema extends z.Schema | undefined = undefined, PathParamsSchema extends z.Schema | undefined = undefined, RequestQuerySchema extends z.Schema | undefined = undefined, RequestHeaderSchema extends z.Schema | undefined = undefined, ResponseHeaderSchema extends z.Schema | undefined = undefined, IsNonJSONResponseExpected extends boolean = false, IsEmptyResponseExpected extends boolean = false, ResponseSchemasByStatusCode extends Partial<Record<HttpStatusCode, z.Schema>> | undefined = undefined>(config: GetContractConfig<SuccessResponseBodySchema, PathParamsSchema, RequestQuerySchema, RequestHeaderSchema, ResponseHeaderSchema, IsNonJSONResponseExpected, IsEmptyResponseExpected, ResponseSchemasByStatusCode>): GetRouteDefinition<SuccessResponseBodySchema, PathParamsSchema, RequestQuerySchema, RequestHeaderSchema, ResponseHeaderSchema, IsNonJSONResponseExpected, IsEmptyResponseExpected, ResponseSchemasByStatusCode>;
+export declare function buildContract<SuccessResponseBodySchema extends z.Schema | undefined = undefined, PathParamsSchema extends z.Schema | undefined = undefined, RequestQuerySchema extends z.Schema | undefined = undefined, RequestHeaderSchema extends z.Schema | undefined = undefined, ResponseHeaderSchema extends z.Schema | undefined = undefined, IsNonJSONResponseExpected extends boolean = false, IsEmptyResponseExpected extends boolean = true, ResponseSchemasByStatusCode extends Partial<Record<HttpStatusCode, z.Schema>> | undefined = undefined>(config: DeleteContractConfig<SuccessResponseBodySchema, PathParamsSchema, RequestQuerySchema, RequestHeaderSchema, ResponseHeaderSchema, IsNonJSONResponseExpected, IsEmptyResponseExpected, ResponseSchemasByStatusCode>): DeleteRouteDefinition<SuccessResponseBodySchema, PathParamsSchema, RequestQuerySchema, RequestHeaderSchema, ResponseHeaderSchema, IsNonJSONResponseExpected, IsEmptyResponseExpected, ResponseSchemasByStatusCode>;
+export declare function buildContract<RequestBodySchema extends z.Schema | undefined = undefined, SuccessResponseBodySchema extends z.Schema | undefined = undefined, PathParamsSchema extends z.Schema | undefined = undefined, RequestQuerySchema extends z.Schema | undefined = undefined, RequestHeaderSchema extends z.Schema | undefined = undefined, ResponseHeaderSchema extends z.Schema | undefined = undefined, IsNonJSONResponseExpected extends boolean = false, IsEmptyResponseExpected extends boolean = false, ResponseSchemasByStatusCode extends Partial<Record<HttpStatusCode, z.Schema>> | undefined = undefined>(config: PayloadContractConfig<RequestBodySchema, SuccessResponseBodySchema, PathParamsSchema, RequestQuerySchema, RequestHeaderSchema, ResponseHeaderSchema, IsNonJSONResponseExpected, IsEmptyResponseExpected, ResponseSchemasByStatusCode>): PayloadRouteDefinition<RequestBodySchema, SuccessResponseBodySchema, PathParamsSchema, RequestQuerySchema, RequestHeaderSchema, ResponseHeaderSchema, IsNonJSONResponseExpected, IsEmptyResponseExpected, ResponseSchemasByStatusCode>;
+export declare function buildContract<Params extends z.ZodTypeAny, Query extends z.ZodTypeAny, RequestHeaders extends z.ZodTypeAny, JsonResponse extends z.ZodTypeAny, Events extends SSEEventSchemas, ResponseHeaders extends z.ZodTypeAny | undefined = undefined, ResponseSchemasByStatusCode extends Partial<Record<HttpStatusCode, z.ZodTypeAny>> | undefined = undefined>(config: DualModeGetContractConfig<Params, Query, RequestHeaders, JsonResponse, Events, ResponseHeaders, ResponseSchemasByStatusCode>): DualModeContractDefinition<'get', Params, Query, RequestHeaders, undefined, JsonResponse, Events, ResponseHeaders, ResponseSchemasByStatusCode>;
+export declare function buildContract<Params extends z.ZodTypeAny, Query extends z.ZodTypeAny, RequestHeaders extends z.ZodTypeAny, Events extends SSEEventSchemas, ResponseSchemasByStatusCode extends Partial<Record<HttpStatusCode, z.ZodTypeAny>> | undefined = undefined>(config: SSEGetContractConfig<Params, Query, RequestHeaders, Events, ResponseSchemasByStatusCode>): SSEContractDefinition<'get', Params, Query, RequestHeaders, undefined, Events, ResponseSchemasByStatusCode>;
+export declare function buildContract<Params extends z.ZodTypeAny, Query extends z.ZodTypeAny, RequestHeaders extends z.ZodTypeAny, Body extends z.ZodTypeAny, JsonResponse extends z.ZodTypeAny, Events extends SSEEventSchemas, ResponseHeaders extends z.ZodTypeAny | undefined = undefined, ResponseSchemasByStatusCode extends Partial<Record<HttpStatusCode, z.ZodTypeAny>> | undefined = undefined>(config: DualModePayloadContractConfig<Params, Query, RequestHeaders, Body, JsonResponse, Events, ResponseHeaders, ResponseSchemasByStatusCode>): DualModeContractDefinition<'post' | 'put' | 'patch', Params, Query, RequestHeaders, Body, JsonResponse, Events, ResponseHeaders, ResponseSchemasByStatusCode>;
+export declare function buildContract<Params extends z.ZodTypeAny, Query extends z.ZodTypeAny, RequestHeaders extends z.ZodTypeAny, Body extends z.ZodTypeAny, Events extends SSEEventSchemas, ResponseSchemasByStatusCode extends Partial<Record<HttpStatusCode, z.ZodTypeAny>> | undefined = undefined>(config: SSEPayloadContractConfig<Params, Query, RequestHeaders, Body, Events, ResponseSchemasByStatusCode>): SSEContractDefinition<'post' | 'put' | 'patch', Params, Query, RequestHeaders, Body, Events, ResponseSchemasByStatusCode>;

package/dist/contractBuilder.js

@@ -0,0 +1,17 @@
+import { buildRestContract, } from "./rest/restContractBuilder.js";
+import { buildSseContract, } from "./sse/sseContractBuilders.js";
+// ============================================================================
+// Implementation
+// ============================================================================
+export function buildContract(
+// biome-ignore lint/suspicious/noExplicitAny: Union of all config types
+config) {
+    const hasSseEvents = 'serverSentEventSchemas' in config && config.serverSentEventSchemas !== undefined;
+    if (hasSseEvents) {
+        // Delegate to SSE contract builder
+        return buildSseContract(config);
+    }
+    // Delegate to REST contract builder
+    return buildRestContract(config);
+}
+//# sourceMappingURL=contractBuilder.js.map

package/dist/contractBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contractBuilder.js","sourceRoot":"","sources":["../src/contractBuilder.ts"],"names":[],"mappings":"AAOA,OAAO,EACL,iBAAiB,GAIlB,MAAM,+BAA+B,CAAA;AAEtC,OAAO,EACL,gBAAgB,GAKjB,MAAM,8BAA8B,CAAA;AAqTrC,+EAA+E;AAC/E,iBAAiB;AACjB,+EAA+E;AAE/E,MAAM,UAAU,aAAa;AAC3B,wEAAwE;AACxE,MAAW;IAGX,MAAM,YAAY,GAChB,wBAAwB,IAAI,MAAM,IAAI,MAAM,CAAC,sBAAsB,KAAK,SAAS,CAAA;IAEnF,IAAI,YAAY,EAAE,CAAC;QACjB,mCAAmC;QACnC,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAA;IACjC,CAAC;IAED,oCAAoC;IACpC,OAAO,iBAAiB,CAAC,MAAM,CAAC,CAAA;AAClC,CAAC"}

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from './apiContracts.ts';
+export * from './contractBuilder.ts';
 export * from './HttpStatusCodes.ts';
 export * from './pathUtils.ts';
 export * from './rest/restContractBuilder.ts';

package/dist/index.js

@@ -1,4 +1,6 @@
 export * from "./apiContracts.js";
+// Universal contract builder
+export * from "./contractBuilder.js";
 export * from "./HttpStatusCodes.js";
 export * from "./pathUtils.js";
 export * from "./rest/restContractBuilder.js";

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA;AACjC,cAAc,sBAAsB,CAAA;AACpC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,+BAA+B,CAAA;AAC7C,+BAA+B;AAC/B,cAAc,4BAA4B,CAAA;AAC1C,oBAAoB;AACpB,cAAc,8BAA8B,CAAA;AAC5C,gBAAgB;AAChB,cAAc,uBAAuB,CAAA;AACrC,cAAc,mBAAmB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA;AACjC,6BAA6B;AAC7B,cAAc,sBAAsB,CAAA;AACpC,cAAc,sBAAsB,CAAA;AACpC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,+BAA+B,CAAA;AAC7C,+BAA+B;AAC/B,cAAc,4BAA4B,CAAA;AAC1C,oBAAoB;AACpB,cAAc,8BAA8B,CAAA;AAC5C,gBAAgB;AAChB,cAAc,uBAAuB,CAAA;AACrC,cAAc,mBAAmB,CAAA"}

package/dist/rest/restContractBuilder.d.ts

@@ -8,6 +8,8 @@ import type { HttpStatusCode } from '../HttpStatusCodes.ts';
 export type GetContractConfig<SuccessResponseBodySchema extends z.Schema | undefined = undefined, PathParamsSchema extends z.Schema | undefined = undefined, RequestQuerySchema extends z.Schema | undefined = undefined, RequestHeaderSchema extends z.Schema | undefined = undefined, ResponseHeaderSchema extends z.Schema | undefined = undefined, IsNonJSONResponseExpected extends boolean = false, IsEmptyResponseExpected extends boolean = false, ResponseSchemasByStatusCode extends Partial<Record<HttpStatusCode, z.Schema>> | undefined = undefined> = Omit<CommonRouteDefinition<SuccessResponseBodySchema, PathParamsSchema, RequestQuerySchema, RequestHeaderSchema, ResponseHeaderSchema, IsNonJSONResponseExpected, IsEmptyResponseExpected, ResponseSchemasByStatusCode>, 'method'> & {
     method?: never;
     requestBodySchema?: never;
+    /** Discriminator to distinguish from SSE contracts in buildContract */
+    serverSentEventSchemas?: never;
 };
 /**
  * Configuration for building a DELETE route.
@@ -16,6 +18,8 @@ export type GetContractConfig<SuccessResponseBodySchema extends z.Schema | undef
 export type DeleteContractConfig<SuccessResponseBodySchema extends z.Schema | undefined = undefined, PathParamsSchema extends z.Schema | undefined = undefined, RequestQuerySchema extends z.Schema | undefined = undefined, RequestHeaderSchema extends z.Schema | undefined = undefined, ResponseHeaderSchema extends z.Schema | undefined = undefined, IsNonJSONResponseExpected extends boolean = false, IsEmptyResponseExpected extends boolean = true, ResponseSchemasByStatusCode extends Partial<Record<HttpStatusCode, z.Schema>> | undefined = undefined> = Omit<CommonRouteDefinition<SuccessResponseBodySchema, PathParamsSchema, RequestQuerySchema, RequestHeaderSchema, ResponseHeaderSchema, IsNonJSONResponseExpected, IsEmptyResponseExpected, ResponseSchemasByStatusCode>, 'method'> & {
     method: 'delete';
     requestBodySchema?: never;
+    /** Discriminator to distinguish from SSE contracts in buildContract */
+    serverSentEventSchemas?: never;
 };
 /**
  * Configuration for building a payload route (POST, PUT, PATCH).
@@ -24,6 +28,8 @@ export type DeleteContractConfig<SuccessResponseBodySchema extends z.Schema | un
 export type PayloadContractConfig<RequestBodySchema extends z.Schema | undefined = undefined, SuccessResponseBodySchema extends z.Schema | undefined = undefined, PathParamsSchema extends z.Schema | undefined = undefined, RequestQuerySchema extends z.Schema | undefined = undefined, RequestHeaderSchema extends z.Schema | undefined = undefined, ResponseHeaderSchema extends z.Schema | undefined = undefined, IsNonJSONResponseExpected extends boolean = false, IsEmptyResponseExpected extends boolean = false, ResponseSchemasByStatusCode extends Partial<Record<HttpStatusCode, z.Schema>> | undefined = undefined> = CommonRouteDefinition<SuccessResponseBodySchema, PathParamsSchema, RequestQuerySchema, RequestHeaderSchema, ResponseHeaderSchema, IsNonJSONResponseExpected, IsEmptyResponseExpected, ResponseSchemasByStatusCode> & {
     method: 'post' | 'put' | 'patch';
     requestBodySchema: RequestBodySchema;
+    /** Discriminator to distinguish from SSE contracts in buildContract */
+    serverSentEventSchemas?: never;
 };
 /**
  * Builds REST API contracts with automatic type inference.

package/dist/rest/restContractBuilder.js.map

@@ -1 +1 @@
-{"version":3,"file":"restContractBuilder.js","sourceRoot":"","sources":["../../src/rest/restContractBuilder.ts"],"names":[],"mappings":"AAyRA,iBAAiB;AACjB,MAAM,UAAU,iBAAiB,CAC/B,MAKsE;IAGtE,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAA;IAC5B,MAAM,OAAO,GAAG,mBAAmB,IAAI,MAAM,IAAI,MAAM,CAAC,iBAAiB,KAAK,SAAS,CAAA;IAEvF,oEAAoE;IACpE,MAAM,aAAa,GAAG,MAAM,KAAK,QAAQ,CAAA;IACzC,MAAM,8BAA8B,GAAG,aAAa,CAAA;IAEpD,MAAM,UAAU,GAAG;QACjB,uBAAuB,EAAE,MAAM,CAAC,uBAAuB,IAAI,8BAA8B;QACzF,yBAAyB,EAAE,MAAM,CAAC,yBAAyB,IAAI,KAAK;QACpE,YAAY,EAAE,MAAM,CAAC,YAAY;QACjC,mBAAmB,EAAE,MAAM,CAAC,mBAAmB;QAC/C,oBAAoB,EAAE,MAAM,CAAC,oBAAoB;QACjD,uBAAuB,EAAE,MAAM,CAAC,uBAAuB;QACvD,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;QAC7C,yBAAyB,EAAE,MAAM,CAAC,yBAAyB;QAC3D,WAAW,EAAE,MAAM,CAAC,WAAW;QAC/B,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,2BAA2B,EAAE,MAAM,CAAC,2BAA2B;QAC/D,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,IAAI,EAAE,MAAM,CAAC,IAAI;KAClB,CAAA;IAED,IAAI,OAAO,EAAE,CAAC;QACZ,iCAAiC;QACjC,OAAO;YACL,GAAG,UAAU;YACb,MAAM,EAAE,MAAkC;YAC1C,qFAAqF;YACrF,iBAAiB,EAAG,MAAqC,CAAC,iBAAiB;SAC5E,CAAA;IACH,CAAC;IAED,IAAI,aAAa,EAAE,CAAC;QAClB,eAAe;QACf,OAAO;YACL,GAAG,UAAU;YACb,MAAM,EAAE,QAAiB;SAC1B,CAAA;IACH,CAAC;IAED,sBAAsB;IACtB,OAAO;QACL,GAAG,UAAU;QACb,MAAM,EAAE,KAAc;KACvB,CAAA;AACH,CAAC"}
+{"version":3,"file":"restContractBuilder.js","sourceRoot":"","sources":["../../src/rest/restContractBuilder.ts"],"names":[],"mappings":"AA+RA,iBAAiB;AACjB,MAAM,UAAU,iBAAiB,CAC/B,MAKsE;IAGtE,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAA;IAC5B,MAAM,OAAO,GAAG,mBAAmB,IAAI,MAAM,IAAI,MAAM,CAAC,iBAAiB,KAAK,SAAS,CAAA;IAEvF,oEAAoE;IACpE,MAAM,aAAa,GAAG,MAAM,KAAK,QAAQ,CAAA;IACzC,MAAM,8BAA8B,GAAG,aAAa,CAAA;IAEpD,MAAM,UAAU,GAAG;QACjB,uBAAuB,EAAE,MAAM,CAAC,uBAAuB,IAAI,8BAA8B;QACzF,yBAAyB,EAAE,MAAM,CAAC,yBAAyB,IAAI,KAAK;QACpE,YAAY,EAAE,MAAM,CAAC,YAAY;QACjC,mBAAmB,EAAE,MAAM,CAAC,mBAAmB;QAC/C,oBAAoB,EAAE,MAAM,CAAC,oBAAoB;QACjD,uBAAuB,EAAE,MAAM,CAAC,uBAAuB;QACvD,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;QAC7C,yBAAyB,EAAE,MAAM,CAAC,yBAAyB;QAC3D,WAAW,EAAE,MAAM,CAAC,WAAW;QAC/B,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,2BAA2B,EAAE,MAAM,CAAC,2BAA2B;QAC/D,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,IAAI,EAAE,MAAM,CAAC,IAAI;KAClB,CAAA;IAED,IAAI,OAAO,EAAE,CAAC;QACZ,iCAAiC;QACjC,OAAO;YACL,GAAG,UAAU;YACb,MAAM,EAAE,MAAkC;YAC1C,qFAAqF;YACrF,iBAAiB,EAAG,MAAqC,CAAC,iBAAiB;SAC5E,CAAA;IACH,CAAC;IAED,IAAI,aAAa,EAAE,CAAC;QAClB,eAAe;QACf,OAAO;YACL,GAAG,UAAU;YACb,MAAM,EAAE,QAAiB;SAC1B,CAAA;IACH,CAAC;IAED,sBAAsB;IACtB,OAAO;QACL,GAAG,UAAU;QACb,MAAM,EAAE,KAAc;KACvB,CAAA;AACH,CAAC"}

package/dist/sse/dualModeContracts.d.ts

@@ -5,13 +5,13 @@ import type { SSEMethod } from './sseContracts.ts';
 import type { SSEEventSchemas } from './sseTypes.ts';
 /**
  * Definition for a dual-mode route.
- * Use `syncResponseBody` for the non-streaming response schema.
+ * Use `successResponseBodySchema` for the non-streaming response schema.
  *
  * @template Method - HTTP method (GET, POST, PUT, PATCH)
  * @template Params - Path parameters schema
  * @template Query - Query string parameters schema
  * @template RequestHeaders - Request headers schema
- * @template Body - Request requestBody schema (for POST/PUT/PATCH)
+ * @template Body - Request body schema (for POST/PUT/PATCH)
  * @template SyncResponse - Sync response schema (for Accept: application/json)
  * @template Events - SSE event schemas (for Accept: text/event-stream)
  * @template ResponseHeaders - Response headers schema (for sync mode)
@@ -20,27 +20,27 @@ import type { SSEEventSchemas } from './sseTypes.ts';
 export type DualModeContractDefinition<Method extends SSEMethod = SSEMethod, Params extends z.ZodTypeAny = z.ZodTypeAny, Query extends z.ZodTypeAny = z.ZodTypeAny, RequestHeaders extends z.ZodTypeAny = z.ZodTypeAny, Body extends z.ZodTypeAny | undefined = undefined, SyncResponse extends z.ZodTypeAny = z.ZodTypeAny, Events extends SSEEventSchemas = SSEEventSchemas, ResponseHeaders extends z.ZodTypeAny | undefined = undefined, ResponseSchemasByStatusCode extends Partial<Record<HttpStatusCode, z.ZodTypeAny>> | undefined = undefined> = {
     method: Method;
     pathResolver: RoutePathResolver<z.infer<Params>>;
-    params: Params;
-    query: Query;
-    requestHeaders: RequestHeaders;
-    requestBody: Body;
+    requestPathParamsSchema: Params;
+    requestQuerySchema: Query;
+    requestHeaderSchema: RequestHeaders;
+    requestBodySchema: Body;
     /** Sync response schema - use with `sync` handler */
-    syncResponseBody: SyncResponse;
-    responseHeaders?: ResponseHeaders;
+    successResponseBodySchema: SyncResponse;
+    responseHeaderSchema?: ResponseHeaders;
     /**
      * Alternative response schemas by HTTP status code.
      * Used to define different response shapes for error cases (e.g., 400, 404, 500).
      *
      * @example
      * ```ts
-     * responseSchemasByStatusCode: {
+     * responseBodySchemasByStatusCode: {
      *   400: z.object({ error: z.string(), details: z.array(z.string()) }),
      *   404: z.object({ error: z.string() }),
      * }
      * ```
      */
-    responseSchemasByStatusCode?: ResponseSchemasByStatusCode;
-    sseEvents: Events;
+    responseBodySchemasByStatusCode?: ResponseSchemasByStatusCode;
+    serverSentEventSchemas: Events;
     isDualMode: true;
 };
 /**
@@ -50,14 +50,14 @@ export type DualModeContractDefinition<Method extends SSEMethod = SSEMethod, Par
 export type AnyDualModeContractDefinition = {
     method: SSEMethod;
     pathResolver: RoutePathResolver<any>;
-    params: z.ZodTypeAny;
-    query: z.ZodTypeAny;
-    requestHeaders: z.ZodTypeAny;
-    requestBody: z.ZodTypeAny | undefined;
-    /** Sync response schema */
-    syncResponseBody: z.ZodTypeAny;
-    responseHeaders?: z.ZodTypeAny;
-    responseSchemasByStatusCode?: Partial<Record<HttpStatusCode, z.ZodTypeAny>>;
-    sseEvents: SSEEventSchemas;
+    requestPathParamsSchema: z.ZodTypeAny;
+    requestQuerySchema: z.ZodTypeAny;
+    requestHeaderSchema: z.ZodTypeAny;
+    requestBodySchema: z.ZodTypeAny | undefined;
+    /** Sync response schema - use with `sync` handler */
+    successResponseBodySchema: z.ZodTypeAny;
+    responseHeaderSchema?: z.ZodTypeAny;
+    responseBodySchemasByStatusCode?: Partial<Record<HttpStatusCode, z.ZodTypeAny>>;
+    serverSentEventSchemas: SSEEventSchemas;
     isDualMode: true;
 };

package/dist/sse/sseContractBuilders.d.ts

@@ -6,14 +6,14 @@ import type { SSEContractDefinition } from './sseContracts.ts';
 import type { SSEEventSchemas } from './sseTypes.ts';
 /**
  * Configuration for building a GET SSE route.
- * Forbids requestBody for GET variants.
+ * Forbids requestBodySchema for GET variants.
  */
 export type SSEGetContractConfig<Params extends z.ZodTypeAny, Query extends z.ZodTypeAny, RequestHeaders extends z.ZodTypeAny, Events extends SSEEventSchemas, ResponseSchemasByStatusCode extends Partial<Record<HttpStatusCode, z.ZodTypeAny>> | undefined = undefined> = {
     pathResolver: RoutePathResolver<z.infer<Params>>;
-    params: Params;
-    query: Query;
-    requestHeaders: RequestHeaders;
-    sseEvents: Events;
+    requestPathParamsSchema: Params;
+    requestQuerySchema: Query;
+    requestHeaderSchema: RequestHeaders;
+    serverSentEventSchemas: Events;
     /**
      * Error response schemas by HTTP status code.
      * Used to define response shapes for errors that occur before streaming starts
@@ -21,28 +21,28 @@ export type SSEGetContractConfig<Params extends z.ZodTypeAny, Query extends z.Zo
      *
      * @example
      * ```ts
-     * responseSchemasByStatusCode: {
+     * responseBodySchemasByStatusCode: {
      *   401: z.object({ error: z.literal('Unauthorized') }),
      *   404: z.object({ error: z.string() }),
      * }
      * ```
      */
-    responseSchemasByStatusCode?: ResponseSchemasByStatusCode;
-    requestBody?: never;
-    syncResponseBody?: never;
+    responseBodySchemasByStatusCode?: ResponseSchemasByStatusCode;
+    requestBodySchema?: never;
+    successResponseBodySchema?: never;
 };
 /**
- * Configuration for building a POST/PUT/PATCH SSE route with request requestBody.
- * Requires requestBody for payload variants.
+ * Configuration for building a POST/PUT/PATCH SSE route with request body.
+ * Requires requestBodySchema for payload variants.
  */
 export type SSEPayloadContractConfig<Params extends z.ZodTypeAny, Query extends z.ZodTypeAny, RequestHeaders extends z.ZodTypeAny, Body extends z.ZodTypeAny, Events extends SSEEventSchemas, ResponseSchemasByStatusCode extends Partial<Record<HttpStatusCode, z.ZodTypeAny>> | undefined = undefined> = {
     method?: 'post' | 'put' | 'patch';
     pathResolver: RoutePathResolver<z.infer<Params>>;
-    params: Params;
-    query: Query;
-    requestHeaders: RequestHeaders;
-    requestBody: Body;
-    sseEvents: Events;
+    requestPathParamsSchema: Params;
+    requestQuerySchema: Query;
+    requestHeaderSchema: RequestHeaders;
+    requestBodySchema: Body;
+    serverSentEventSchemas: Events;
     /**
      * Error response schemas by HTTP status code.
      * Used to define response shapes for errors that occur before streaming starts
@@ -50,95 +50,95 @@ export type SSEPayloadContractConfig<Params extends z.ZodTypeAny, Query extends
      *
      * @example
      * ```ts
-     * responseSchemasByStatusCode: {
+     * responseBodySchemasByStatusCode: {
      *   401: z.object({ error: z.literal('Unauthorized') }),
      *   404: z.object({ error: z.string() }),
      * }
      * ```
      */
-    responseSchemasByStatusCode?: ResponseSchemasByStatusCode;
-    syncResponseBody?: never;
+    responseBodySchemasByStatusCode?: ResponseSchemasByStatusCode;
+    successResponseBodySchema?: never;
 };
 /**
  * Configuration for building a GET dual-mode route.
- * Requires syncResponseBody, forbids requestBody.
+ * Requires successResponseBodySchema, forbids requestBodySchema.
  */
 export type DualModeGetContractConfig<Params extends z.ZodTypeAny, Query extends z.ZodTypeAny, RequestHeaders extends z.ZodTypeAny, JsonResponse extends z.ZodTypeAny, Events extends SSEEventSchemas, ResponseHeaders extends z.ZodTypeAny | undefined = undefined, ResponseSchemasByStatusCode extends Partial<Record<HttpStatusCode, z.ZodTypeAny>> | undefined = undefined> = {
     pathResolver: RoutePathResolver<z.infer<Params>>;
-    params: Params;
-    query: Query;
-    requestHeaders: RequestHeaders;
+    requestPathParamsSchema: Params;
+    requestQuerySchema: Query;
+    requestHeaderSchema: RequestHeaders;
     /** Single sync response schema */
-    syncResponseBody: JsonResponse;
+    successResponseBodySchema: JsonResponse;
     /**
      * Schema for validating response headers (sync mode only).
      * Used to define and validate headers that the server will send in the response.
      *
      * @example
      * ```ts
-     * responseHeaders: z.object({
+     * responseHeaderSchema: z.object({
      *   'x-ratelimit-limit': z.string(),
      *   'x-ratelimit-remaining': z.string(),
      * })
      * ```
      */
-    responseHeaders?: ResponseHeaders;
+    responseHeaderSchema?: ResponseHeaders;
     /**
      * Alternative response schemas by HTTP status code.
      * Used to define different response shapes for error cases.
      *
      * @example
      * ```ts
-     * responseSchemasByStatusCode: {
+     * responseBodySchemasByStatusCode: {
      *   400: z.object({ error: z.string(), details: z.array(z.string()) }),
      *   404: z.object({ error: z.string() }),
      * }
      * ```
      */
-    responseSchemasByStatusCode?: ResponseSchemasByStatusCode;
-    sseEvents: Events;
-    requestBody?: never;
+    responseBodySchemasByStatusCode?: ResponseSchemasByStatusCode;
+    serverSentEventSchemas: Events;
+    requestBodySchema?: never;
 };
 /**
- * Configuration for building a POST/PUT/PATCH dual-mode route with request requestBody.
- * Requires both requestBody and syncResponseBody.
+ * Configuration for building a POST/PUT/PATCH dual-mode route with request body.
+ * Requires both requestBodySchema and successResponseBodySchema.
  */
 export type DualModePayloadContractConfig<Params extends z.ZodTypeAny, Query extends z.ZodTypeAny, RequestHeaders extends z.ZodTypeAny, Body extends z.ZodTypeAny, JsonResponse extends z.ZodTypeAny, Events extends SSEEventSchemas, ResponseHeaders extends z.ZodTypeAny | undefined = undefined, ResponseSchemasByStatusCode extends Partial<Record<HttpStatusCode, z.ZodTypeAny>> | undefined = undefined> = {
     method?: 'post' | 'put' | 'patch';
     pathResolver: RoutePathResolver<z.infer<Params>>;
-    params: Params;
-    query: Query;
-    requestHeaders: RequestHeaders;
-    requestBody: Body;
+    requestPathParamsSchema: Params;
+    requestQuerySchema: Query;
+    requestHeaderSchema: RequestHeaders;
+    requestBodySchema: Body;
     /** Single sync response schema */
-    syncResponseBody: JsonResponse;
+    successResponseBodySchema: JsonResponse;
     /**
      * Schema for validating response headers (sync mode only).
      * Used to define and validate headers that the server will send in the response.
      *
      * @example
      * ```ts
-     * responseHeaders: z.object({
+     * responseHeaderSchema: z.object({
      *   'x-ratelimit-limit': z.string(),
      *   'x-ratelimit-remaining': z.string(),
      * })
      * ```
      */
-    responseHeaders?: ResponseHeaders;
+    responseHeaderSchema?: ResponseHeaders;
     /**
      * Alternative response schemas by HTTP status code.
      * Used to define different response shapes for error cases.
      *
      * @example
      * ```ts
-     * responseSchemasByStatusCode: {
+     * responseBodySchemasByStatusCode: {
      *   400: z.object({ error: z.string(), details: z.array(z.string()) }),
      *   404: z.object({ error: z.string() }),
      * }
      * ```
      */
-    responseSchemasByStatusCode?: ResponseSchemasByStatusCode;
-    sseEvents: Events;
+    responseBodySchemasByStatusCode?: ResponseSchemasByStatusCode;
+    serverSentEventSchemas: Events;
 };
 export declare function buildSseContract<Params extends z.ZodTypeAny, Query extends z.ZodTypeAny, RequestHeaders extends z.ZodTypeAny, JsonResponse extends z.ZodTypeAny, Events extends SSEEventSchemas, ResponseHeaders extends z.ZodTypeAny | undefined = undefined, ResponseSchemasByStatusCode extends Partial<Record<HttpStatusCode, z.ZodTypeAny>> | undefined = undefined>(config: DualModeGetContractConfig<Params, Query, RequestHeaders, JsonResponse, Events, ResponseHeaders, ResponseSchemasByStatusCode>): DualModeContractDefinition<'get', Params, Query, RequestHeaders, undefined, JsonResponse, Events, ResponseHeaders, ResponseSchemasByStatusCode>;
 export declare function buildSseContract<Params extends z.ZodTypeAny, Query extends z.ZodTypeAny, RequestHeaders extends z.ZodTypeAny, Events extends SSEEventSchemas, ResponseSchemasByStatusCode extends Partial<Record<HttpStatusCode, z.ZodTypeAny>> | undefined = undefined>(config: SSEGetContractConfig<Params, Query, RequestHeaders, Events, ResponseSchemasByStatusCode>): SSEContractDefinition<'get', Params, Query, RequestHeaders, undefined, Events, ResponseSchemasByStatusCode>;

package/dist/sse/sseContractBuilders.js

@@ -12,10 +12,10 @@
  * This is ideal for AI/LLM APIs (like OpenAI) where clients can choose between
  * getting the full response at once or streaming it token-by-token.
  *
- * The contract type is automatically determined based on the presence of `syncResponseBody`:
+ * The contract type is automatically determined based on the presence of `successResponseBodySchema`:
  *
- * | `syncResponseBody` | `requestBody` | Result |
- * |--------------------|---------------|--------|
+ * | `successResponseBodySchema` | `requestBodySchema` | Result |
+ * |----------------------------|---------------------|--------|
  * | ❌ | ❌ | SSE-only GET |
  * | ❌ | ✅ | SSE-only POST/PUT/PATCH |
  * | ✅ | ❌ | Dual-mode GET |
@@ -26,10 +26,10 @@
  * // SSE-only: Pure streaming endpoint (e.g., live notifications)
  * const notificationsStream = buildSseContract({
  *   pathResolver: () => '/api/notifications/stream',
- *   params: z.object({}),
- *   query: z.object({ userId: z.string().optional() }),
- *   requestHeaders: z.object({}),
- *   sseEvents: {
+ *   requestPathParamsSchema: z.object({}),
+ *   requestQuerySchema: z.object({ userId: z.string().optional() }),
+ *   requestHeaderSchema: z.object({}),
+ *   serverSentEventSchemas: {
  *     notification: z.object({ id: z.string(), message: z.string() }),
  *   },
  * })
@@ -40,12 +40,12 @@
  * const chatCompletion = buildSseContract({
  *   method: 'POST',
  *   pathResolver: () => '/api/chat/completions',
- *   params: z.object({}),
- *   query: z.object({}),
- *   requestHeaders: z.object({}),
- *   requestBody: z.object({ message: z.string() }),
- *   syncResponseBody: z.object({ reply: z.string(), usage: z.object({ tokens: z.number() }) }),
- *   sseEvents: {
+ *   requestPathParamsSchema: z.object({}),
+ *   requestQuerySchema: z.object({}),
+ *   requestHeaderSchema: z.object({}),
+ *   requestBodySchema: z.object({ message: z.string() }),
+ *   successResponseBodySchema: z.object({ reply: z.string(), usage: z.object({ tokens: z.number() }) }),
+ *   serverSentEventSchemas: {
  *     chunk: z.object({ delta: z.string() }),
  *     done: z.object({ usage: z.object({ total: z.number() }) }),
  *   },
@@ -57,11 +57,11 @@
 function buildBaseFields(config, hasBody) {
     return {
         pathResolver: config.pathResolver,
-        params: config.params,
-        query: config.query,
-        requestHeaders: config.requestHeaders,
-        requestBody: hasBody ? config.requestBody : undefined,
-        sseEvents: config.sseEvents,
+        requestPathParamsSchema: config.requestPathParamsSchema,
+        requestQuerySchema: config.requestQuerySchema,
+        requestHeaderSchema: config.requestHeaderSchema,
+        requestBodySchema: hasBody ? config.requestBodySchema : undefined,
+        serverSentEventSchemas: config.serverSentEventSchemas,
     };
 }
 // Helper to determine method
@@ -70,18 +70,19 @@ function determineMethod(config, hasBody, defaultMethod) {
 }
 // Implementation
 export function buildSseContract(config) {
-    const hasSyncResponseBody = 'syncResponseBody' in config && config.syncResponseBody !== undefined;
-    const hasBody = 'requestBody' in config && config.requestBody !== undefined;
+    const hasSyncResponseBody = 'successResponseBodySchema' in config && config.successResponseBodySchema !== undefined;
+    const hasBody = 'requestBodySchema' in config && config.requestBodySchema !== undefined;
     const base = buildBaseFields(config, hasBody);
     if (hasSyncResponseBody) {
         // Dual-mode contract
         return {
             ...base,
             method: determineMethod(config, hasBody, 'post'),
-            syncResponseBody: config.syncResponseBody,
-            responseHeaders: config.responseHeaders,
-            responseSchemasByStatusCode: config
-                .responseSchemasByStatusCode,
+            successResponseBodySchema: config
+                .successResponseBodySchema,
+            responseHeaderSchema: config.responseHeaderSchema,
+            responseBodySchemasByStatusCode: config
+                .responseBodySchemasByStatusCode,
             isDualMode: true,
         };
     }
@@ -89,8 +90,8 @@ export function buildSseContract(config) {
     return {
         ...base,
         method: determineMethod(config, hasBody, 'post'),
-        responseSchemasByStatusCode: config
-            .responseSchemasByStatusCode,
+        responseBodySchemasByStatusCode: config
+            .responseBodySchemasByStatusCode,
         isSSE: true,
     };
 }

package/dist/sse/sseContractBuilders.js.map

@@ -1 +1 @@
-{"version":3,"file":"sseContractBuilders.js","sourceRoot":"","sources":["../../src/sse/sseContractBuilders.ts"],"names":[],"mappings":"AAyLA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AAEH,uCAAuC;AACvC,gEAAgE;AAChE,SAAS,eAAe,CAAC,MAAW,EAAE,OAAgB;IACpD,OAAO;QACL,YAAY,EAAE,MAAM,CAAC,YAAY;QACjC,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,cAAc,EAAE,MAAM,CAAC,cAAc;QACrC,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS;QACrD,SAAS,EAAE,MAAM,CAAC,SAAS;KAC5B,CAAA;AACH,CAAC;AAED,6BAA6B;AAC7B,SAAS,eAAe,CAAC,MAA2B,EAAE,OAAgB,EAAE,aAAqB;IAC3F,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,IAAI,aAAa,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;AAC3D,CAAC;AAwHD,iBAAiB;AACjB,MAAM,UAAU,gBAAgB,CAC9B,MAOiD;IAGjD,MAAM,mBAAmB,GAAG,kBAAkB,IAAI,MAAM,IAAI,MAAM,CAAC,gBAAgB,KAAK,SAAS,CAAA;IACjG,MAAM,OAAO,GAAG,aAAa,IAAI,MAAM,IAAI,MAAM,CAAC,WAAW,KAAK,SAAS,CAAA;IAC3E,MAAM,IAAI,GAAG,eAAe,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAE7C,IAAI,mBAAmB,EAAE,CAAC;QACxB,qBAAqB;QACrB,OAAO;YACL,GAAG,IAAI;YACP,MAAM,EAAE,eAAe,CAAC,MAA6B,EAAE,OAAO,EAAE,MAAM,CAAC;YACvE,gBAAgB,EAAG,MAAwC,CAAC,gBAAgB;YAC5E,eAAe,EAAG,MAAwC,CAAC,eAAe;YAC1E,2BAA2B,EAAG,MAAoD;iBAC/E,2BAA2B;YAC9B,UAAU,EAAE,IAAI;SACjB,CAAA;IACH,CAAC;IAED,oBAAoB;IACpB,OAAO;QACL,GAAG,IAAI;QACP,MAAM,EAAE,eAAe,CAAC,MAA6B,EAAE,OAAO,EAAE,MAAM,CAAC;QACvE,2BAA2B,EAAG,MAAoD;aAC/E,2BAA2B;QAC9B,KAAK,EAAE,IAAI;KACZ,CAAA;AACH,CAAC"}
+{"version":3,"file":"sseContractBuilders.js","sourceRoot":"","sources":["../../src/sse/sseContractBuilders.ts"],"names":[],"mappings":"AAyLA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AAEH,uCAAuC;AACvC,gEAAgE;AAChE,SAAS,eAAe,CAAC,MAAW,EAAE,OAAgB;IACpD,OAAO;QACL,YAAY,EAAE,MAAM,CAAC,YAAY;QACjC,uBAAuB,EAAE,MAAM,CAAC,uBAAuB;QACvD,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;QAC7C,mBAAmB,EAAE,MAAM,CAAC,mBAAmB;QAC/C,iBAAiB,EAAE,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,SAAS;QACjE,sBAAsB,EAAE,MAAM,CAAC,sBAAsB;KACtD,CAAA;AACH,CAAC;AAED,6BAA6B;AAC7B,SAAS,eAAe,CAAC,MAA2B,EAAE,OAAgB,EAAE,aAAqB;IAC3F,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,IAAI,aAAa,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;AAC3D,CAAC;AAwHD,iBAAiB;AACjB,MAAM,UAAU,gBAAgB,CAC9B,MAOiD;IAGjD,MAAM,mBAAmB,GACvB,2BAA2B,IAAI,MAAM,IAAI,MAAM,CAAC,yBAAyB,KAAK,SAAS,CAAA;IACzF,MAAM,OAAO,GAAG,mBAAmB,IAAI,MAAM,IAAI,MAAM,CAAC,iBAAiB,KAAK,SAAS,CAAA;IACvF,MAAM,IAAI,GAAG,eAAe,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAE7C,IAAI,mBAAmB,EAAE,CAAC;QACxB,qBAAqB;QACrB,OAAO;YACL,GAAG,IAAI;YACP,MAAM,EAAE,eAAe,CAAC,MAA6B,EAAE,OAAO,EAAE,MAAM,CAAC;YACvE,yBAAyB,EAAG,MAAiD;iBAC1E,yBAAyB;YAC5B,oBAAoB,EAAG,MAA6C,CAAC,oBAAoB;YACzF,+BAA+B,EAAG,MAAwD;iBACvF,+BAA+B;YAClC,UAAU,EAAE,IAAI;SACjB,CAAA;IACH,CAAC;IAED,oBAAoB;IACpB,OAAO;QACL,GAAG,IAAI;QACP,MAAM,EAAE,eAAe,CAAC,MAA6B,EAAE,OAAO,EAAE,MAAM,CAAC;QACvE,+BAA+B,EAAG,MAAwD;aACvF,+BAA+B;QAClC,KAAK,EAAE,IAAI;KACZ,CAAA;AACH,CAAC"}

package/dist/sse/sseContracts.d.ts

@@ -15,7 +15,7 @@ export type SSEMethod = 'get' | 'post' | 'put' | 'patch';
  * @template Params - Path parameters schema
  * @template Query - Query string parameters schema
  * @template RequestHeaders - Request headers schema
- * @template Body - Request requestBody schema (for POST/PUT/PATCH)
+ * @template Body - Request body schema (for POST/PUT/PATCH)
  * @template Events - Map of event name to event data schema
  * @template ResponseSchemasByStatusCode - Error response schemas by HTTP status code
  */
@@ -26,11 +26,11 @@ export type SSEContractDefinition<Method extends SSEMethod = SSEMethod, Params e
      * Receives typed params and returns the URL path string.
      */
     pathResolver: RoutePathResolver<z.infer<Params>>;
-    params: Params;
-    query: Query;
-    requestHeaders: RequestHeaders;
-    requestBody: Body;
-    sseEvents: Events;
+    requestPathParamsSchema: Params;
+    requestQuerySchema: Query;
+    requestHeaderSchema: RequestHeaders;
+    requestBodySchema: Body;
+    serverSentEventSchemas: Events;
     /**
      * Error response schemas by HTTP status code.
      * Used to define response shapes for errors that occur before streaming starts
@@ -38,13 +38,13 @@ export type SSEContractDefinition<Method extends SSEMethod = SSEMethod, Params e
      *
      * @example
      * ```ts
-     * responseSchemasByStatusCode: {
+     * responseBodySchemasByStatusCode: {
      *   401: z.object({ error: z.literal('Unauthorized') }),
      *   404: z.object({ error: z.string() }),
      * }
      * ```
      */
-    responseSchemasByStatusCode?: ResponseSchemasByStatusCode;
+    responseBodySchemasByStatusCode?: ResponseSchemasByStatusCode;
     isSSE: true;
 };
 /**
@@ -54,11 +54,11 @@ export type SSEContractDefinition<Method extends SSEMethod = SSEMethod, Params e
 export type AnySSEContractDefinition = {
     method: SSEMethod;
     pathResolver: RoutePathResolver<any>;
-    params: z.ZodTypeAny;
-    query: z.ZodTypeAny;
-    requestHeaders: z.ZodTypeAny;
-    requestBody: z.ZodTypeAny | undefined;
-    sseEvents: SSEEventSchemas;
-    responseSchemasByStatusCode?: Partial<Record<HttpStatusCode, z.ZodTypeAny>>;
+    requestPathParamsSchema: z.ZodTypeAny;
+    requestQuerySchema: z.ZodTypeAny;
+    requestHeaderSchema: z.ZodTypeAny;
+    requestBodySchema: z.ZodTypeAny | undefined;
+    serverSentEventSchemas: SSEEventSchemas;
+    responseBodySchemasByStatusCode?: Partial<Record<HttpStatusCode, z.ZodTypeAny>>;
     isSSE: true;
 };

package/dist/sse/sseTypes.d.ts

@@ -11,19 +11,19 @@ export type SSEEventSchemas = Record<string, z.ZodTypeAny>;
  * @example
  * ```typescript
  * type Contracts = {
- *   notifications: { sseEvents: { alert: z.ZodObject<...> } }
- *   chat: { sseEvents: { message: z.ZodObject<...>, done: z.ZodObject<...> } }
+ *   notifications: { serverSentEventSchemas: { alert: z.ZodObject<...> } }
+ *   chat: { serverSentEventSchemas: { message: z.ZodObject<...>, done: z.ZodObject<...> } }
  * }
  * // AllContractEventNames<Contracts> = 'alert' | 'message' | 'done'
  * ```
  */
-export type AllContractEventNames<Contracts extends Record<string, AnySSEContractDefinition>> = Contracts[keyof Contracts]['sseEvents'] extends infer E ? E extends SSEEventSchemas ? keyof E & string : never : never;
+export type AllContractEventNames<Contracts extends Record<string, AnySSEContractDefinition>> = Contracts[keyof Contracts]['serverSentEventSchemas'] extends infer E ? E extends SSEEventSchemas ? keyof E & string : never : never;
 /**
  * Extract the schema for a specific event name across all contracts.
  * Returns the Zod schema for the event, or never if not found.
  */
 export type ExtractEventSchema<Contracts extends Record<string, AnySSEContractDefinition>, EventName extends string> = {
-    [K in keyof Contracts]: EventName extends keyof Contracts[K]['sseEvents'] ? Contracts[K]['sseEvents'][EventName] : never;
+    [K in keyof Contracts]: EventName extends keyof Contracts[K]['serverSentEventSchemas'] ? Contracts[K]['serverSentEventSchemas'][EventName] : never;
 }[keyof Contracts];
 /**
  * Flatten all events from all contracts into a single record.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@lokalise/api-contracts",
-    "version": "6.3.0",
+    "version": "6.5.0",
     "files": [
         "dist"
     ],