@moostjs/swagger 0.6.53 → 0.7.0

package/dist/index.cjs

@@ -27,8 +27,8 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 
 //#endregion
 let moost = require("moost");
-let _moostjs_event_http = require("@moostjs/event-http");
 let _wooksjs_event_http = require("@wooksjs/event-http");
+let _moostjs_event_http = require("@moostjs/event-http");
 let _wooksjs_http_static = require("@wooksjs/http-static");
 let path = require("path");
 path = __toESM(path);
@@ -204,22 +204,23 @@ function mapToSwaggerSpec(metadata, options) {
 			if (!swaggerSpec.paths[handlerPath]) swaggerSpec.paths[handlerPath] = {};
 			let responses;
 			if (hmeta?.swaggerResponses) for (const [code, responseEntry] of Object.entries(hmeta.swaggerResponses)) {
-				const newCode = code === "0" ? getDefaultStatusCode(handlerMethod) : code;
-				for (const [contentType, conf] of Object.entries(responseEntry.content)) {
-					const { response, example } = conf;
-					const schema = resolveSwaggerSchemaFromConfig(response);
-					if (schema) {
-						responses = responses || {};
-						const schemaWithExample = example !== void 0 ? {
-							...schema,
-							example
-						} : schema;
-						if (!responses[newCode]) responses[newCode] = {
-							description: responseEntry.description || defaultStatusDescription(Number(newCode)),
-							content: {}
-						};
-						responses[newCode].content[contentType] = { schema: schemaWithExample };
-					}
+				const contents = Object.entries(responseEntry.content).map(([contentType, conf]) => ({
+					contentType,
+					example: conf.example,
+					schema: resolveSwaggerSchemaFromConfig(conf.response)
+				}));
+				const newCode = code === "0" ? getDefaultStatusCode(handlerMethod, contents.some((c) => c.schema)) : code;
+				for (const { contentType, example, schema } of contents) if (schema) {
+					responses = responses || {};
+					const schemaWithExample = example !== void 0 ? {
+						...schema,
+						example
+					} : schema;
+					if (!responses[newCode]) responses[newCode] = {
+						description: responseEntry.description || defaultStatusDescription(Number(newCode)),
+						content: {}
+					};
+					responses[newCode].content[contentType] = { schema: schemaWithExample };
 				}
 				if (responseEntry.headers) {
 					const resolvedHeaders = resolveResponseHeaders(responseEntry.headers);
@@ -396,7 +397,7 @@ function mapToSwaggerSpec(metadata, options) {
 			}
 		}
 		for (const { endpointSpec, httpMethod, config } of deferredLinks) {
-			const statusCode = config.statusCode === 0 ? String(getDefaultStatusCode(httpMethod)) : String(config.statusCode);
+			const statusCode = config.statusCode === 0 ? String(defaultLinkStatus(endpointSpec, httpMethod)) : String(config.statusCode);
 			const link = {};
 			if (config.handler) {
 				const [ctrlClass, methodName] = config.handler;
@@ -764,13 +765,17 @@ function resolveSchemaFromRef(schema) {
 function cloneSchema(schema) {
 	return JSON.parse(JSON.stringify(schema));
 }
-function getDefaultStatusCode(httpMethod) {
-	return {
-		GET: 200,
-		PUT: 200,
-		POST: 201,
-		DELETE: 204
-	}[httpMethod.toUpperCase()] || 200;
+/**
+* The status the runtime answers with when the handler sets none — wooks' own rule
+* (`getDefaultHttpStatus`): POST with a body → 201, any other method with a body → 200,
+* no body → 204.
+*/ function getDefaultStatusCode(httpMethod, hasBody = true) {
+	return (0, _wooksjs_event_http.getDefaultHttpStatus)(httpMethod.toUpperCase(), hasBody);
+}
+/** The default success response a link attaches to: the one the endpoint documents (with or without a body). */ function defaultLinkStatus(endpointSpec, httpMethod) {
+	const withBody = getDefaultStatusCode(httpMethod, true);
+	const noBody = getDefaultStatusCode(httpMethod, false);
+	return !endpointSpec.responses?.[withBody] && endpointSpec.responses?.[noBody] ? noBody : withBody;
 }
 const STATUS_DESCRIPTIONS = {
 	200: "OK",

package/dist/index.mjs

@@ -1,6 +1,6 @@
 import { Const, Controller, Moost, current, getMoostMate, useControllerContext } from "moost";
+import { getDefaultHttpStatus, useResponse } from "@wooksjs/event-http";
 import { Get, HeaderRef, SetHeader, StatusRef, Url } from "@moostjs/event-http";
-import { useResponse } from "@wooksjs/event-http";
 import { serveFile } from "@wooksjs/http-static";
 import Path from "path";
 import { getAbsoluteFSPath } from "swagger-ui-dist";
@@ -175,22 +175,23 @@ function mapToSwaggerSpec(metadata, options) {
 			if (!swaggerSpec.paths[handlerPath]) swaggerSpec.paths[handlerPath] = {};
 			let responses;
 			if (hmeta?.swaggerResponses) for (const [code, responseEntry] of Object.entries(hmeta.swaggerResponses)) {
-				const newCode = code === "0" ? getDefaultStatusCode(handlerMethod) : code;
-				for (const [contentType, conf] of Object.entries(responseEntry.content)) {
-					const { response, example } = conf;
-					const schema = resolveSwaggerSchemaFromConfig(response);
-					if (schema) {
-						responses = responses || {};
-						const schemaWithExample = example !== void 0 ? {
-							...schema,
-							example
-						} : schema;
-						if (!responses[newCode]) responses[newCode] = {
-							description: responseEntry.description || defaultStatusDescription(Number(newCode)),
-							content: {}
-						};
-						responses[newCode].content[contentType] = { schema: schemaWithExample };
-					}
+				const contents = Object.entries(responseEntry.content).map(([contentType, conf]) => ({
+					contentType,
+					example: conf.example,
+					schema: resolveSwaggerSchemaFromConfig(conf.response)
+				}));
+				const newCode = code === "0" ? getDefaultStatusCode(handlerMethod, contents.some((c) => c.schema)) : code;
+				for (const { contentType, example, schema } of contents) if (schema) {
+					responses = responses || {};
+					const schemaWithExample = example !== void 0 ? {
+						...schema,
+						example
+					} : schema;
+					if (!responses[newCode]) responses[newCode] = {
+						description: responseEntry.description || defaultStatusDescription(Number(newCode)),
+						content: {}
+					};
+					responses[newCode].content[contentType] = { schema: schemaWithExample };
 				}
 				if (responseEntry.headers) {
 					const resolvedHeaders = resolveResponseHeaders(responseEntry.headers);
@@ -367,7 +368,7 @@ function mapToSwaggerSpec(metadata, options) {
 			}
 		}
 		for (const { endpointSpec, httpMethod, config } of deferredLinks) {
-			const statusCode = config.statusCode === 0 ? String(getDefaultStatusCode(httpMethod)) : String(config.statusCode);
+			const statusCode = config.statusCode === 0 ? String(defaultLinkStatus(endpointSpec, httpMethod)) : String(config.statusCode);
 			const link = {};
 			if (config.handler) {
 				const [ctrlClass, methodName] = config.handler;
@@ -735,13 +736,17 @@ function resolveSchemaFromRef(schema) {
 function cloneSchema(schema) {
 	return JSON.parse(JSON.stringify(schema));
 }
-function getDefaultStatusCode(httpMethod) {
-	return {
-		GET: 200,
-		PUT: 200,
-		POST: 201,
-		DELETE: 204
-	}[httpMethod.toUpperCase()] || 200;
+/**
+* The status the runtime answers with when the handler sets none — wooks' own rule
+* (`getDefaultHttpStatus`): POST with a body → 201, any other method with a body → 200,
+* no body → 204.
+*/ function getDefaultStatusCode(httpMethod, hasBody = true) {
+	return getDefaultHttpStatus(httpMethod.toUpperCase(), hasBody);
+}
+/** The default success response a link attaches to: the one the endpoint documents (with or without a body). */ function defaultLinkStatus(endpointSpec, httpMethod) {
+	const withBody = getDefaultStatusCode(httpMethod, true);
+	const noBody = getDefaultStatusCode(httpMethod, false);
+	return !endpointSpec.responses?.[withBody] && endpointSpec.responses?.[noBody] ? noBody : withBody;
 }
 const STATUS_DESCRIPTIONS = {
 	200: "OK",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moostjs/swagger",
-  "version": "0.6.53",
+  "version": "0.7.0",
   "description": "@moostjs/swagger",
   "keywords": [
     "composables",
@@ -45,10 +45,10 @@
     "vitest": "3.2.7"
   },
   "peerDependencies": {
-    "@wooksjs/event-http": "^0.7.31",
-    "@wooksjs/http-static": "^0.7.31",
-    "@moostjs/event-http": "^0.6.53",
-    "moost": "^0.6.53"
+    "@wooksjs/event-http": "^0.8.0",
+    "@wooksjs/http-static": "^0.8.0",
+    "moost": "^0.7.0",
+    "@moostjs/event-http": "^0.7.0"
   },
   "scripts": {
     "pub": "pnpm publish --access public",