@lokalise/api-contracts 6.2.1 → 6.4.0

package/README.md

@@ -8,12 +8,86 @@ 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:
+
+| `method` | `requestBodySchema` | Result |
+|----------|---------------------|--------|
+| omitted/undefined | ❌ | GET route |
+| `'delete'` | ❌ | DELETE route |
+| `'post'`/`'put'`/`'patch'` | ✅ | Payload route |
+
 Usage examples:
 
 ```ts
-import { buildGetRoute, buildDeleteRoute, buildPayloadRoute } from '@lokalise/api-contracts'
+import { buildRestContract } from '@lokalise/api-contracts'
 
-const getContract = buildGetRoute({
+// GET route - method is inferred automatically
+const getContract = buildRestContract({
     successResponseBodySchema: RESPONSE_BODY_SCHEMA,
     requestPathParamsSchema: REQUEST_PATH_PARAMS_SCHEMA,
     requestQuerySchema: REQUEST_QUERY_SCHEMA,
@@ -24,8 +98,9 @@ const getContract = buildGetRoute({
     metadata: { allowedRoles: ['admin'] },
 })
 
-const postContract = buildPayloadRoute({
-    method: 'post', // can also be 'patch' or 'post'
+// POST route - requires method and requestBodySchema
+const postContract = buildRestContract({
+    method: 'post', // can also be 'put' or 'patch'
     successResponseBodySchema: RESPONSE_BODY_SCHEMA,
     requestBodySchema: REQUEST_BODY_SCHEMA,
     pathResolver: () => '/',
@@ -33,13 +108,35 @@ const postContract = buildPayloadRoute({
     metadata: { allowedPermission: ['edit'] },
 })
 
-const deleteContract = buildDeleteRoute({
+// DELETE route - method is 'delete', no body, defaults isEmptyResponseExpected to true
+const deleteContract = buildRestContract({
+    method: 'delete',
     successResponseBodySchema: RESPONSE_BODY_SCHEMA,
     requestPathParamsSchema: REQUEST_PATH_PARAMS_SCHEMA,
     pathResolver: (pathParams) => `/users/${pathParams.userId}`,
 })
 ```
 
+### Deprecated Builders
+
+The individual builders `buildGetRoute`, `buildPayloadRoute`, and `buildDeleteRoute` are deprecated. Use `buildRestContract` instead:
+
+```ts
+// Before (deprecated):
+import { buildGetRoute, buildPayloadRoute, buildDeleteRoute } from '@lokalise/api-contracts'
+
+const getContract = buildGetRoute({ ... })
+const postContract = buildPayloadRoute({ method: 'post', ... })
+const deleteContract = buildDeleteRoute({ ... })
+
+// After (recommended):
+import { buildRestContract } from '@lokalise/api-contracts'
+
+const getContract = buildRestContract({ ... })  // method inferred as 'get'
+const postContract = buildRestContract({ method: 'post', ... })
+const deleteContract = buildRestContract({ method: 'delete', ... })
+```
+
 In the previous example, the `metadata` property is an optional, free-form field that allows you to store any additional
 information related to the route. If you require more precise type definitions for the `metadata` field, you can utilize
 TypeScript's module augmentation mechanism to enforce stricter typing. This allows for more controlled and type-safe
@@ -72,10 +169,10 @@ In case you are using fastify on the backend, you can also use `@lokalise/fastif
 Use `requestHeaderSchema` to define and validate headers that the client must send with the request. This is useful for authentication headers, API keys, content negotiation, and other request-specific headers.
 
 ```ts
-import { buildGetRoute } from '@lokalise/api-contracts'
+import { buildRestContract } from '@lokalise/api-contracts'
 import { z } from 'zod'
 
-const contract = buildGetRoute({
+const contract = buildRestContract({
     successResponseBodySchema: DATA_SCHEMA,
     requestHeaderSchema: z.object({
         'authorization': z.string(),
@@ -95,10 +192,10 @@ Use `responseHeaderSchema` to define and validate headers that the server will s
 - Custom API metadata headers
 
 ```ts
-import { buildGetRoute } from '@lokalise/api-contracts'
+import { buildRestContract } from '@lokalise/api-contracts'
 import { z } from 'zod'
 
-const contract = buildGetRoute({
+const contract = buildRestContract({
     successResponseBodySchema: DATA_SCHEMA,
     responseHeaderSchema: z.object({
         'x-ratelimit-limit': z.string(),
@@ -113,7 +210,7 @@ const contract = buildGetRoute({
 Both header schemas can be used together in a single contract:
 
 ```ts
-const contract = buildGetRoute({
+const contract = buildRestContract({
     successResponseBodySchema: DATA_SCHEMA,
     requestHeaderSchema: z.object({
         'authorization': z.string(),
@@ -139,9 +236,9 @@ These header schemas are primarily used for:
 Converts a route definition to its corresponding path pattern with parameter placeholders.
 
 ```ts
-import { mapRouteToPath, buildGetRoute } from '@lokalise/api-contracts'
+import { mapRouteToPath, buildRestContract } from '@lokalise/api-contracts'
 
-const userContract = buildGetRoute({
+const userContract = buildRestContract({
     requestPathParamsSchema: z.object({ userId: z.string() }),
     successResponseBodySchema: USER_SCHEMA,
     pathResolver: (pathParams) => `/users/${pathParams.userId}`,
@@ -163,19 +260,19 @@ The function replaces actual path parameters with placeholder syntax (`:paramNam
 Generates a human-readable description of a route contract, combining the HTTP method with the route path.
 
 ```ts
-import { describeContract, buildGetRoute, buildPayloadRoute } from '@lokalise/api-contracts'
+import { describeContract, buildRestContract } from '@lokalise/api-contracts'
 
-const getContract = buildGetRoute({
+const getContract = buildRestContract({
     requestPathParamsSchema: z.object({ userId: z.string() }),
     successResponseBodySchema: USER_SCHEMA,
     pathResolver: (pathParams) => `/users/${pathParams.userId}`,
 })
 
-const postContract = buildPayloadRoute({
+const postContract = buildRestContract({
     method: 'post',
-    requestPathParamsSchema: z.object({ 
+    requestPathParamsSchema: z.object({
         orgId: z.string(),
-        userId: z.string() 
+        userId: z.string()
     }),
     requestBodySchema: CREATE_USER_SCHEMA,
     successResponseBodySchema: USER_SCHEMA,

package/dist/apiContracts.d.ts

@@ -58,8 +58,64 @@ export type GetRouteDefinition<SuccessResponseBodySchema extends z.Schema | unde
 export type DeleteRouteDefinition<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> = CommonRouteDefinition<SuccessResponseBodySchema, PathParamsSchema, RequestQuerySchema, RequestHeaderSchema, ResponseHeaderSchema, IsNonJSONResponseExpected, IsEmptyResponseExpected, ResponseSchemasByStatusCode> & {
     method: 'delete';
 };
+/**
+ * @deprecated Use `buildRestContract` instead. This function will be removed in a future version.
+ * @example
+ * ```typescript
+ * // Before (deprecated):
+ * const route = buildPayloadRoute({
+ *   method: 'post',
+ *   requestBodySchema: bodySchema,
+ *   successResponseBodySchema: responseSchema,
+ *   pathResolver: () => '/api/users',
+ * })
+ *
+ * // After (recommended):
+ * const route = buildRestContract({
+ *   method: 'post',
+ *   requestBodySchema: bodySchema,
+ *   successResponseBodySchema: responseSchema,
+ *   pathResolver: () => '/api/users',
+ * })
+ * ```
+ */
 export declare function buildPayloadRoute<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>(params: PayloadRouteDefinition<RequestBodySchema, SuccessResponseBodySchema, PathParamsSchema, RequestQuerySchema, RequestHeaderSchema, ResponseHeaderSchema, IsNonJSONResponseExpected, IsEmptyResponseExpected, ResponseSchemasByStatusCode>): PayloadRouteDefinition<RequestBodySchema, SuccessResponseBodySchema, PathParamsSchema, RequestQuerySchema, RequestHeaderSchema, ResponseHeaderSchema, IsNonJSONResponseExpected, IsEmptyResponseExpected, ResponseSchemasByStatusCode>;
+/**
+ * @deprecated Use `buildRestContract` instead. This function will be removed in a future version.
+ * @example
+ * ```typescript
+ * // Before (deprecated):
+ * const route = buildGetRoute({
+ *   successResponseBodySchema: responseSchema,
+ *   pathResolver: () => '/api/users',
+ * })
+ *
+ * // After (recommended):
+ * const route = buildRestContract({
+ *   successResponseBodySchema: responseSchema,
+ *   pathResolver: () => '/api/users',
+ * })
+ * ```
+ */
 export declare function buildGetRoute<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>(params: Omit<GetRouteDefinition<SuccessResponseBodySchema, PathParamsSchema, RequestQuerySchema, RequestHeaderSchema, ResponseHeaderSchema, IsNonJSONResponseExpected, IsEmptyResponseExpected, ResponseSchemasByStatusCode>, 'method'>): GetRouteDefinition<SuccessResponseBodySchema, PathParamsSchema, RequestQuerySchema, RequestHeaderSchema, ResponseHeaderSchema, IsNonJSONResponseExpected, IsEmptyResponseExpected, ResponseSchemasByStatusCode>;
+/**
+ * @deprecated Use `buildRestContract` instead. This function will be removed in a future version.
+ * @example
+ * ```typescript
+ * // Before (deprecated):
+ * const route = buildDeleteRoute({
+ *   successResponseBodySchema: responseSchema,
+ *   pathResolver: () => '/api/users/123',
+ * })
+ *
+ * // After (recommended):
+ * const route = buildRestContract({
+ *   method: 'delete',
+ *   successResponseBodySchema: responseSchema,
+ *   pathResolver: () => '/api/users/123',
+ * })
+ * ```
+ */
 export declare function buildDeleteRoute<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>(params: Omit<DeleteRouteDefinition<SuccessResponseBodySchema, PathParamsSchema, RequestQuerySchema, RequestHeaderSchema, ResponseHeaderSchema, IsNonJSONResponseExpected, IsEmptyResponseExpected, ResponseSchemasByStatusCode>, 'method'>): DeleteRouteDefinition<SuccessResponseBodySchema, PathParamsSchema, RequestQuerySchema, RequestHeaderSchema, ResponseHeaderSchema, IsNonJSONResponseExpected, IsEmptyResponseExpected, ResponseSchemasByStatusCode>;
 /**
  * This method maps given route definition to a string of the format '/static-path-part/:path-param-value'

package/dist/apiContracts.js

@@ -1,4 +1,25 @@
 const EMPTY_PARAMS = {};
+/**
+ * @deprecated Use `buildRestContract` instead. This function will be removed in a future version.
+ * @example
+ * ```typescript
+ * // Before (deprecated):
+ * const route = buildPayloadRoute({
+ *   method: 'post',
+ *   requestBodySchema: bodySchema,
+ *   successResponseBodySchema: responseSchema,
+ *   pathResolver: () => '/api/users',
+ * })
+ *
+ * // After (recommended):
+ * const route = buildRestContract({
+ *   method: 'post',
+ *   requestBodySchema: bodySchema,
+ *   successResponseBodySchema: responseSchema,
+ *   pathResolver: () => '/api/users',
+ * })
+ * ```
+ */
 export function buildPayloadRoute(params) {
     return {
         isEmptyResponseExpected: params.isEmptyResponseExpected ?? false,
@@ -18,6 +39,23 @@ export function buildPayloadRoute(params) {
         tags: params.tags,
     };
 }
+/**
+ * @deprecated Use `buildRestContract` instead. This function will be removed in a future version.
+ * @example
+ * ```typescript
+ * // Before (deprecated):
+ * const route = buildGetRoute({
+ *   successResponseBodySchema: responseSchema,
+ *   pathResolver: () => '/api/users',
+ * })
+ *
+ * // After (recommended):
+ * const route = buildRestContract({
+ *   successResponseBodySchema: responseSchema,
+ *   pathResolver: () => '/api/users',
+ * })
+ * ```
+ */
 export function buildGetRoute(params) {
     return {
         isEmptyResponseExpected: params.isEmptyResponseExpected ?? false,
@@ -36,6 +74,24 @@ export function buildGetRoute(params) {
         tags: params.tags,
     };
 }
+/**
+ * @deprecated Use `buildRestContract` instead. This function will be removed in a future version.
+ * @example
+ * ```typescript
+ * // Before (deprecated):
+ * const route = buildDeleteRoute({
+ *   successResponseBodySchema: responseSchema,
+ *   pathResolver: () => '/api/users/123',
+ * })
+ *
+ * // After (recommended):
+ * const route = buildRestContract({
+ *   method: 'delete',
+ *   successResponseBodySchema: responseSchema,
+ *   pathResolver: () => '/api/users/123',
+ * })
+ * ```
+ */
 export function buildDeleteRoute(params) {
     return {
         isEmptyResponseExpected: params.isEmptyResponseExpected ?? true,

package/dist/apiContracts.js.map

@@ -1 +1 @@
-{"version":3,"file":"apiContracts.js","sourceRoot":"","sources":["../src/apiContracts.ts"],"names":[],"mappings":"AAGA,MAAM,YAAY,GAAG,EAAE,CAAA;AA8JvB,MAAM,UAAU,iBAAiB,CAa/B,MAUC;IAYD,OAAO;QACL,uBAAuB,EAAE,MAAM,CAAC,uBAAuB,IAAK,KAAiC;QAC7F,yBAAyB,EACvB,MAAM,CAAC,yBAAyB,IAAK,KAAmC;QAC1E,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,YAAY,EAAE,MAAM,CAAC,YAAY;QACjC,iBAAiB,EAAE,MAAM,CAAC,iBAAiB;QAC3C,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;AACH,CAAC;AAED,MAAM,UAAU,aAAa,CAY3B,MAYC;IAWD,OAAO;QACL,uBAAuB,EAAE,MAAM,CAAC,uBAAuB,IAAK,KAAiC;QAC7F,yBAAyB,EACvB,MAAM,CAAC,yBAAyB,IAAK,KAAmC;QAC1E,MAAM,EAAE,KAAK;QACb,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;AACH,CAAC;AAED,MAAM,UAAU,gBAAgB,CAY9B,MAYC;IAWD,OAAO;QACL,uBAAuB,EAAE,MAAM,CAAC,uBAAuB,IAAK,IAAgC;QAC5F,yBAAyB,EACvB,MAAM,CAAC,yBAAyB,IAAK,KAAmC;QAC1E,MAAM,EAAE,QAAQ;QAChB,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;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,cAAc;AAC5B,sGAAsG;AACtG,eAA8E;IAE9E,IAAI,CAAC,eAAe,CAAC,uBAAuB,EAAE,CAAC;QAC7C,OAAO,eAAe,CAAC,YAAY,CAAC,YAAY,CAAC,CAAA;IACnD,CAAC;IACD,MAAM,KAAK,GAAG,eAAe,CAAC,uBAAuB,CAAC,KAAK,CAAA;IAC3D,MAAM,cAAc,GAA2B,EAAE,CAAA;IACjD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACrC,cAAc,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,EAAE,CAAA;IACjC,CAAC;IAED,OAAO,eAAe,CAAC,YAAY,CAAC,cAAc,CAAC,CAAA;AACrD,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,QAKiE;IAEjE,OAAO,GAAG,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,IAAI,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAA;AACvE,CAAC"}
+{"version":3,"file":"apiContracts.js","sourceRoot":"","sources":["../src/apiContracts.ts"],"names":[],"mappings":"AAGA,MAAM,YAAY,GAAG,EAAE,CAAA;AA8JvB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,iBAAiB,CAa/B,MAUC;IAYD,OAAO;QACL,uBAAuB,EAAE,MAAM,CAAC,uBAAuB,IAAK,KAAiC;QAC7F,yBAAyB,EACvB,MAAM,CAAC,yBAAyB,IAAK,KAAmC;QAC1E,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,YAAY,EAAE,MAAM,CAAC,YAAY;QACjC,iBAAiB,EAAE,MAAM,CAAC,iBAAiB;QAC3C,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;AACH,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,aAAa,CAY3B,MAYC;IAWD,OAAO;QACL,uBAAuB,EAAE,MAAM,CAAC,uBAAuB,IAAK,KAAiC;QAC7F,yBAAyB,EACvB,MAAM,CAAC,yBAAyB,IAAK,KAAmC;QAC1E,MAAM,EAAE,KAAK;QACb,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;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,gBAAgB,CAY9B,MAYC;IAWD,OAAO;QACL,uBAAuB,EAAE,MAAM,CAAC,uBAAuB,IAAK,IAAgC;QAC5F,yBAAyB,EACvB,MAAM,CAAC,yBAAyB,IAAK,KAAmC;QAC1E,MAAM,EAAE,QAAQ;QAChB,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;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,cAAc;AAC5B,sGAAsG;AACtG,eAA8E;IAE9E,IAAI,CAAC,eAAe,CAAC,uBAAuB,EAAE,CAAC;QAC7C,OAAO,eAAe,CAAC,YAAY,CAAC,YAAY,CAAC,CAAA;IACnD,CAAC;IACD,MAAM,KAAK,GAAG,eAAe,CAAC,uBAAuB,CAAC,KAAK,CAAA;IAC3D,MAAM,cAAc,GAA2B,EAAE,CAAA;IACjD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACrC,cAAc,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,EAAE,CAAA;IACjC,CAAC;IAED,OAAO,eAAe,CAAC,YAAY,CAAC,cAAc,CAAC,CAAA;AACrD,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,QAKiE;IAEjE,OAAO,GAAG,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,IAAI,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAA;AACvE,CAAC"}

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 `sseEvents` is provided
+ * - `buildSseContract` when `sseEvents` is provided
+ *
+ * ## Contract Type Detection
+ *
+ * | `sseEvents` | `syncResponseBody` | `requestBody`/`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',
+ *   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() }) }),
+ *   },
+ * })
+ * ```
+ */
+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 = 'sseEvents' in config && config.sseEvents !== 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,GAAG,WAAW,IAAI,MAAM,IAAI,MAAM,CAAC,SAAS,KAAK,SAAS,CAAA;IAE5E,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,6 +1,8 @@
 export * from './apiContracts.ts';
+export * from './contractBuilder.ts';
 export * from './HttpStatusCodes.ts';
 export * from './pathUtils.ts';
+export * from './rest/restContractBuilder.ts';
 export * from './sse/dualModeContracts.ts';
 export * from './sse/sseContractBuilders.ts';
 export * from './sse/sseContracts.ts';

package/dist/index.js

@@ -1,6 +1,9 @@
 export * from "./apiContracts.js";
+// Universal contract builder
+export * from "./contractBuilder.js";
 export * from "./HttpStatusCodes.js";
 export * from "./pathUtils.js";
+export * from "./rest/restContractBuilder.js";
 // Dual-mode (hybrid) contracts
 export * from "./sse/dualModeContracts.js";
 // Contract builders

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,+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

@@ -0,0 +1,100 @@
+import type { z } from 'zod/v4';
+import type { CommonRouteDefinition, DeleteRouteDefinition, GetRouteDefinition, PayloadRouteDefinition } from '../apiContracts.ts';
+import type { HttpStatusCode } from '../HttpStatusCodes.ts';
+/**
+ * Configuration for building a GET route.
+ * GET routes have no request body and the method is inferred automatically.
+ */
+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 */
+    sseEvents?: never;
+};
+/**
+ * Configuration for building a DELETE route.
+ * DELETE routes have no request body and default to empty response expected.
+ */
+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 */
+    sseEvents?: never;
+};
+/**
+ * Configuration for building a payload route (POST, PUT, PATCH).
+ * Payload routes require a request body and an explicit method.
+ */
+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 */
+    sseEvents?: never;
+};
+/**
+ * Builds REST API contracts with automatic type inference.
+ *
+ * This unified builder replaces the individual `buildGetRoute`, `buildPayloadRoute`,
+ * and `buildDeleteRoute` functions, providing a single entry point for all REST contracts.
+ *
+ * The contract type is automatically determined based on the configuration:
+ *
+ * | `method` | `requestBodySchema` | Result |
+ * |----------|---------------------|--------|
+ * | omitted/undefined | ❌ | GET route |
+ * | `'delete'` | ❌ | DELETE route |
+ * | `'post'`/`'put'`/`'patch'` | ✅ | Payload route |
+ *
+ * @example
+ * ```typescript
+ * // GET route - method is inferred automatically
+ * const getUsers = buildRestContract({
+ *   pathResolver: () => '/api/users',
+ *   successResponseBodySchema: z.array(userSchema),
+ * })
+ *
+ * // GET route with path params
+ * const getUser = buildRestContract({
+ *   pathResolver: (params) => `/api/users/${params.userId}`,
+ *   requestPathParamsSchema: z.object({ userId: z.string() }),
+ *   successResponseBodySchema: userSchema,
+ * })
+ *
+ * // POST route - requires method and requestBodySchema
+ * const createUser = buildRestContract({
+ *   method: 'post',
+ *   pathResolver: () => '/api/users',
+ *   requestBodySchema: createUserSchema,
+ *   successResponseBodySchema: userSchema,
+ * })
+ *
+ * // PUT route
+ * const updateUser = buildRestContract({
+ *   method: 'put',
+ *   pathResolver: (params) => `/api/users/${params.userId}`,
+ *   requestPathParamsSchema: z.object({ userId: z.string() }),
+ *   requestBodySchema: updateUserSchema,
+ *   successResponseBodySchema: userSchema,
+ * })
+ *
+ * // PATCH route
+ * const patchUser = buildRestContract({
+ *   method: 'patch',
+ *   pathResolver: (params) => `/api/users/${params.userId}`,
+ *   requestPathParamsSchema: z.object({ userId: z.string() }),
+ *   requestBodySchema: patchUserSchema,
+ *   successResponseBodySchema: userSchema,
+ * })
+ *
+ * // DELETE route - method is 'delete', no body
+ * const deleteUser = buildRestContract({
+ *   method: 'delete',
+ *   pathResolver: (params) => `/api/users/${params.userId}`,
+ *   requestPathParamsSchema: z.object({ userId: z.string() }),
+ *   successResponseBodySchema: z.undefined(),
+ * })
+ * ```
+ */
+export declare function buildRestContract<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 buildRestContract<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 buildRestContract<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>;

package/dist/rest/restContractBuilder.js

@@ -0,0 +1,45 @@
+// Implementation
+export function buildRestContract(config) {
+    const method = config.method;
+    const hasBody = 'requestBodySchema' in config && config.requestBodySchema !== undefined;
+    // Determine default for isEmptyResponseExpected based on route type
+    const isDeleteRoute = method === 'delete';
+    const defaultIsEmptyResponseExpected = isDeleteRoute;
+    const baseFields = {
+        isEmptyResponseExpected: config.isEmptyResponseExpected ?? defaultIsEmptyResponseExpected,
+        isNonJSONResponseExpected: config.isNonJSONResponseExpected ?? false,
+        pathResolver: config.pathResolver,
+        requestHeaderSchema: config.requestHeaderSchema,
+        responseHeaderSchema: config.responseHeaderSchema,
+        requestPathParamsSchema: config.requestPathParamsSchema,
+        requestQuerySchema: config.requestQuerySchema,
+        successResponseBodySchema: config.successResponseBodySchema,
+        description: config.description,
+        summary: config.summary,
+        responseSchemasByStatusCode: config.responseSchemasByStatusCode,
+        metadata: config.metadata,
+        tags: config.tags,
+    };
+    if (hasBody) {
+        // Payload route (POST/PUT/PATCH)
+        return {
+            ...baseFields,
+            method: method,
+            // biome-ignore lint/suspicious/noExplicitAny: Type assertion needed for config union
+            requestBodySchema: config.requestBodySchema,
+        };
+    }
+    if (isDeleteRoute) {
+        // DELETE route
+        return {
+            ...baseFields,
+            method: 'delete',
+        };
+    }
+    // GET route (default)
+    return {
+        ...baseFields,
+        method: 'get',
+    };
+}
+//# sourceMappingURL=restContractBuilder.js.map

package/dist/rest/restContractBuilder.js.map

@@ -0,0 +1 @@
+{"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/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@lokalise/api-contracts",
-    "version": "6.2.1",
+    "version": "6.4.0",
     "files": [
         "dist"
     ],
@@ -48,10 +48,10 @@
         "@biomejs/biome": "^2.3.7",
         "@lokalise/biome-config": "^3.1.0",
         "@lokalise/tsconfig": "^3.1.0",
-        "@vitest/coverage-v8": "^4.0.15",
-        "rimraf": "^6.0.1",
+        "@vitest/coverage-v8": "^4.0.18",
+        "rimraf": "^6.1.2",
         "typescript": "5.9.3",
-        "vitest": "^4.0.15",
+        "vitest": "^4.0.18",
         "zod": "^4.3.6"
     },
     "dependencies": {}