@lucaapp/service-utils 5.24.3 → 5.24.4

package/dist/lib/api/api.js

@@ -75,6 +75,7 @@ class Api {
                 description: this.apiDescription,
             },
         });
+        (0, openapi_1.forcePathParamsRequired)(spec);
         return spec;
     }
     mountSwaggerMiddlewares() {

package/dist/lib/api/openapi.d.ts

@@ -1,5 +1,11 @@
 import { OpenAPIRegistry } from '@asteasolutions/zod-to-openapi';
 import { EndpointOptions } from './types/endpoint';
 type HttpMethod = 'get' | 'post' | 'put' | 'delete' | 'patch';
+export declare const forcePathParamsRequired: (spec: {
+    paths?: Record<string, unknown>;
+    components?: {
+        parameters?: Record<string, unknown>;
+    };
+}) => void;
 export declare const registerEndpoint: (registry: OpenAPIRegistry, method: HttpMethod, prefixPath: string, path: string, summary: string, options: EndpointOptions<any, any, any, any, any, any>, tags: string[], debug: boolean) => void;
 export {};

package/dist/lib/api/openapi.js

@@ -1,12 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.registerEndpoint = void 0;
+exports.registerEndpoint = exports.forcePathParamsRequired = void 0;
 const zod_1 = require("zod");
 const http_1 = require("./types/http");
 const mapExpressParamsToOpenAPIParams = (path) => path.replaceAll(/\:([^\:\/]+)/g, '{$1}');
 const buildResponseConfig = (responseOptions) => {
     const responses = {};
     responseOptions.forEach(response => {
+        // raw responses end the request outside the schema layer and carry the
+        // placeholder status 0, which is not a valid OpenAPI response key
+        if (response.isRawResponseEnd) {
+            return;
+        }
         const isAlreadyPresent = !!responses[String(response.status)];
         if (!isAlreadyPresent) {
             responses[String(response.status)] = {
@@ -36,8 +41,46 @@ const buildResponseConfig = (responseOptions) => {
         existingResponse.content['application/json'].schema =
             existingResponse.content['application/json'].schema.or(response.schema);
     });
+    const hasRawResponse = responseOptions.some(response => response.isRawResponseEnd);
+    if (hasRawResponse && !responses['200']) {
+        responses['200'] = { description: 'OK (raw response)' };
+    }
     return responses;
 };
+// OpenAPI requires path parameters to be required, but zod effects (e.g.
+// z.preprocess) hide the underlying optionality from the generator
+const forcePathParamsRequired = (spec) => {
+    const markRequired = (parameters) => {
+        if (!Array.isArray(parameters)) {
+            return;
+        }
+        parameters.forEach(parameter => {
+            if (parameter?.in === 'path') {
+                parameter.required = true;
+            }
+        });
+    };
+    Object.values(spec.paths || {}).forEach(pathItem => {
+        if (!pathItem || typeof pathItem !== 'object') {
+            return;
+        }
+        Object.entries(pathItem).forEach(([key, value]) => {
+            if (key === 'parameters') {
+                markRequired(value);
+                return;
+            }
+            if (value && typeof value === 'object') {
+                markRequired(value.parameters);
+            }
+        });
+    });
+    Object.values(spec.components?.parameters || {}).forEach(parameter => {
+        if (parameter?.in === 'path') {
+            parameter.required = true;
+        }
+    });
+};
+exports.forcePathParamsRequired = forcePathParamsRequired;
 const registerEndpoint = (registry, method, prefixPath, path, summary, 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 options, tags, debug) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lucaapp/service-utils",
-  "version": "5.24.3",
+  "version": "5.24.4",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [