mobx-tanstack-query-api 0.36.1 → 0.37.1

package/cli.js

@@ -53,38 +53,72 @@ ${contract2.content}}`;
   const contractType = `${"export "}${templateFn(contract)}`;
   return result + contractType;
 };
+function getResponseContentTypes(raw) {
+  const out = [];
+  if (Array.isArray(raw.produces)) out.push(...raw.produces);
+  const status = raw.responses && Object.keys(raw.responses).find((s) => {
+    const code = Number.parseInt(s, 10);
+    return code >= 200 && code < 300;
+  });
+  const content = status && raw.responses[status]?.content;
+  if (content && typeof content === "object") out.push(...Object.keys(content));
+  return [...new Set(out)];
+}
+function getRequestContentTypes(raw) {
+  const out = [];
+  if (Array.isArray(raw.consumes)) out.push(...raw.consumes);
+  const body = raw.requestBody?.content;
+  if (body && typeof body === "object") out.push(...Object.keys(body));
+  return [...new Set(out)];
+}
+function getSecuritySchemeNames(security) {
+  if (!Array.isArray(security)) return [];
+  return security.flatMap(
+    (s) => typeof s === "object" && s !== null ? Object.keys(s) : []
+  ).filter(Boolean);
+}
+function getExternalDocsLine(externalDocs, formatDescription) {
+  if (!externalDocs || typeof externalDocs !== "object" || !("url" in externalDocs))
+    return null;
+  const url = externalDocs.url;
+  if (!url) return null;
+  const desc = externalDocs.description;
+  const extDesc = desc ? ` ${formatDescription(String(desc).slice(0, 60), true)}` : "";
+  return { name: "see", content: `${url}${extDesc}`.trim() };
+}
+function getSummaryAndDescriptionLines(rawRoute, formatDescription) {
+  const out = [];
+  if (rawRoute.summary) {
+    const summaryLines = splitTextByLines(rawRoute.summary, 60).filter(Boolean).map((line) => ({ content: `**${formatDescription(line, true)}**` }));
+    if (summaryLines.length > 0) out.push(...summaryLines, { content: "" });
+  }
+  if (rawRoute.description) {
+    const descriptionLines = splitTextByLines(rawRoute.description, 60).filter(Boolean).map((line) => ({ content: formatDescription(line, true) }));
+    if (descriptionLines.length > 0)
+      out.push(...descriptionLines, { content: "" });
+  } else if (!rawRoute.summary) {
+    out.push({ content: "No description" });
+  }
+  return out;
+}
 const endpointJSDocTmpl = (params) => {
   const { route, configuration, offset = 0 } = params;
   const { routeName } = route;
   const rawRoute = route.raw;
   const routeRequest = route.request;
+  const path2 = routeRequest?.path;
+  const method = routeRequest?.method;
   const { utils } = configuration;
   const { _, formatDescription } = utils;
+  const schema = configuration.config?.swaggerSchema ?? configuration.swaggerSchema;
+  const pathKey = path2?.startsWith("/") ? path2 : `/${path2 || ""}`;
+  const methodKey = method?.toLowerCase?.() ?? method;
+  const schemaOp = pathKey && methodKey ? schema?.paths?.[pathKey]?.[methodKey] : null;
+  const rawWithSpec = schemaOp && typeof schemaOp === "object" ? { ...schemaOp, ...rawRoute } : rawRoute;
   const jsDocLines = [];
-  if (rawRoute.summary) {
-    const summaryLines = splitTextByLines(rawRoute.summary, 60).filter(Boolean).map((line) => ({
-      content: `**${formatDescription(line, true)}**`
-    }));
-    if (summaryLines.length > 0) {
-      jsDocLines.push(...summaryLines, { content: "" });
-    }
-  }
-  if (rawRoute.description) {
-    const descriptionLines = splitTextByLines(rawRoute.description, 60).filter(Boolean).map((line) => ({
-      content: formatDescription(line, true)
-    }));
-    if (descriptionLines.length > 0) {
-      jsDocLines.push(...descriptionLines, { content: "" });
-    } else {
-      jsDocLines.push({
-        content: "No description"
-      });
-    }
-  } else {
-    jsDocLines.push({
-      content: "No description"
-    });
-  }
+  jsDocLines.push(
+    ...getSummaryAndDescriptionLines(rawRoute, formatDescription)
+  );
   if (rawRoute.operationId) {
     jsDocLines.push({
       name: "operationId",
@@ -101,6 +135,20 @@ const endpointJSDocTmpl = (params) => {
     name: "request",
     content: `**${_.upperCase(routeRequest.method)}:${rawRoute.route}**`
   });
+  const responseTypes = getResponseContentTypes(rawWithSpec);
+  if (responseTypes.length > 0) {
+    jsDocLines.push({
+      name: "produces",
+      content: responseTypes.join(", ")
+    });
+  }
+  const requestTypes = getRequestContentTypes(rawWithSpec);
+  if (requestTypes.length > 0) {
+    jsDocLines.push({
+      name: "consumes",
+      content: requestTypes.join(", ")
+    });
+  }
   if (rawRoute.deprecated) {
     jsDocLines.push({
       name: "deprecated"
@@ -118,10 +166,17 @@ const endpointJSDocTmpl = (params) => {
     );
   }
   if (routeRequest.security) {
-    jsDocLines.push({
-      name: "secure"
-    });
+    jsDocLines.push({ name: "secure" });
+    const schemeNames = getSecuritySchemeNames(rawWithSpec.security);
+    if (schemeNames.length > 0) {
+      jsDocLines.push({ name: "security", content: schemeNames.join(", ") });
+    }
   }
+  const externalDocsLine = getExternalDocsLine(
+    rawWithSpec.externalDocs,
+    formatDescription
+  );
+  if (externalDocsLine) jsDocLines.push(externalDocsLine);
   if (rawRoute.responsesTypes.length > 0) {
     jsDocLines.push({
       name: "responses"
@@ -216,6 +271,94 @@ const responseContentKind = {
   FORM_DATA: '"formData"',
   BYTES: '"bytes"'
 };
+function inferResponseFormatFromRaw(raw) {
+  const contentTypes = [];
+  if (Array.isArray(raw.produces)) {
+    contentTypes.push(...raw.produces);
+  }
+  const successStatus = raw.responses && Object.keys(raw.responses).find((s) => {
+    const code = Number.parseInt(s, 10);
+    return code >= 200 && code < 300;
+  });
+  const content = successStatus && raw.responses[successStatus]?.content;
+  if (content && typeof content === "object") {
+    contentTypes.push(...Object.keys(content));
+  }
+  if (contentTypes.length === 0) return null;
+  const mimeToFormat = (mime) => {
+    if (mime.includes("application/json") || mime.includes("+json"))
+      return '"json"';
+    if (mime.startsWith("text/")) return '"text"';
+    if (mime.includes("form-data") || mime.includes("multipart"))
+      return '"formData"';
+    if (mime.includes("octet-stream") || mime.includes("spreadsheet") || mime.includes("vnd.") || mime.startsWith("application/") || mime.startsWith("image/") || mime.startsWith("audio/") || mime.startsWith("video/") || mime.startsWith("font/") || mime.startsWith("model/") || mime.startsWith("message/") || mime.startsWith("haptics/"))
+      return '"blob"';
+    return null;
+  };
+  const preferredOrder = ['"json"', '"text"', '"formData"', '"blob"'];
+  for (const fmt of preferredOrder) {
+    const found = contentTypes.map(mimeToFormat).find((f) => f === fmt);
+    if (found) return found;
+  }
+  return null;
+}
+function getResponseFormat(responseBodyInfo, raw, configuration, path2, method) {
+  const fromContentKind = responseContentKind[responseBodyInfo.success?.schema?.contentKind];
+  if (fromContentKind) return fromContentKind;
+  const swaggerSchema = configuration.config?.swaggerSchema ?? configuration.swaggerSchema;
+  const schemaPaths = swaggerSchema?.paths;
+  const pathKey = path2?.startsWith("/") ? path2 : `/${path2 || ""}`;
+  const methodKey = method?.toLowerCase?.() ?? method;
+  const schemaOperation = pathKey && methodKey ? schemaPaths?.[pathKey]?.[methodKey] : null;
+  const rawWithProduces = schemaOperation && typeof schemaOperation === "object" ? { ...schemaOperation, ...raw } : raw;
+  return inferResponseFormatFromRaw(rawWithProduces);
+}
+function inferRequestBodyContentTypeFromRaw(raw) {
+  const contentTypes = [];
+  if (Array.isArray(raw.consumes)) {
+    contentTypes.push(...raw.consumes);
+  }
+  const requestBody = raw.requestBody;
+  if (requestBody?.content && typeof requestBody.content === "object") {
+    contentTypes.push(...Object.keys(requestBody.content));
+  }
+  if (contentTypes.length === 0) return null;
+  const mimeToContentType = (mime) => {
+    if (mime.includes("application/json") || mime.includes("+json"))
+      return '"application/json"';
+    if (mime.includes("application/x-www-form-urlencoded"))
+      return '"application/x-www-form-urlencoded"';
+    if (mime.includes("multipart/form-data") || mime.includes("multipart/"))
+      return '"multipart/form-data"';
+    if (mime.startsWith("text/")) return '"text/plain"';
+    if (mime.includes("octet-stream") || mime.startsWith("application/") || mime.startsWith("image/") || mime.startsWith("audio/") || mime.startsWith("video/") || mime.startsWith("font/") || mime.startsWith("model/") || mime.includes("vnd."))
+      return '"application/octet-stream"';
+    return null;
+  };
+  const preferredOrder = [
+    '"application/json"',
+    '"application/x-www-form-urlencoded"',
+    '"multipart/form-data"',
+    '"text/plain"',
+    '"application/octet-stream"'
+  ];
+  for (const ct of preferredOrder) {
+    const found = contentTypes.map(mimeToContentType).find((c) => c === ct);
+    if (found) return found;
+  }
+  return null;
+}
+function getRequestBodyContentType(requestBodyInfo, raw, configuration, path2, method) {
+  const fromContentKind = requestContentKind[requestBodyInfo?.contentKind];
+  if (fromContentKind) return fromContentKind;
+  const swaggerSchema = configuration.config?.swaggerSchema ?? configuration.swaggerSchema;
+  const schemaPaths = swaggerSchema?.paths;
+  const pathKey = path2?.startsWith("/") ? path2 : `/${path2 || ""}`;
+  const methodKey = method?.toLowerCase?.() ?? method;
+  const schemaOperation = pathKey && methodKey ? schemaPaths?.[pathKey]?.[methodKey] : null;
+  const rawWithConsumes = schemaOperation && typeof schemaOperation === "object" ? { ...schemaOperation, ...raw } : raw;
+  return inferRequestBodyContentTypeFromRaw(rawWithConsumes);
+}
 const newEndpointTmpl = ({
   route,
   codegenParams,
@@ -282,8 +425,20 @@ const newEndpointTmpl = ({
   const requestInfoMeta = codegenParams.getEndpointMeta?.(route, utils);
   const requestMeta = codegenParams.getRequestMeta?.(route, utils);
   const resultPath = (codegenParams.requestPathPrefix ?? "") + path2 + (codegenParams.requestPathSuffix ?? "");
-  const bodyContentType = requestContentKind[requestBodyInfo.contentKind] || null;
-  const responseFormat = responseContentKind[responseBodyInfo.success?.schema?.contentKind] || null;
+  const bodyContentType = getRequestBodyContentType(
+    requestBodyInfo,
+    raw,
+    configuration,
+    path2,
+    method
+  ) || null;
+  const responseFormat = getResponseFormat(
+    responseBodyInfo,
+    raw,
+    configuration,
+    path2,
+    method
+  ) || null;
   const reservedDataContractNames = _.uniq([
     ...requestOutputDataTypes,
     requestOutputErrorType || "any",