fix: bug #1433

Author: js2me

.changeset/ninety-jeans-lay.md

@@ -0,0 +1,5 @@
+---
+"swagger-typescript-api": patch
+---
+
+fixed bug #1433 (multiline descriptions bug)

src/resolved-swagger-schema.ts

@@ -4,9 +4,9 @@ import type { resolve } from "@apidevtools/swagger-parser";
 import SwaggerParser from "@apidevtools/swagger-parser";
 import consola from "consola";
 import type { OpenAPI } from "openapi-types";
-import * as YAML from "yaml";
 import type { AnyObject, Maybe, Primitive } from "yummies/types";
 import type { CodeGenConfig } from "./configuration.js";
+import { parseSchemaContent } from "./util/parse-schema-content.js";
 
 export interface RefDetails {
   ref: string;
@@ -140,15 +140,12 @@ export class ResolvedSwaggerSchema {
       const content = await response.text();
 
       try {
-        const parsed = JSON.parse(content);
+        const parsed = parseSchemaContent(content);
         if (parsed && typeof parsed === "object") {
           return parsed as AnyObject;
         }
       } catch {
-        const parsed = YAML.parse(content);
-        if (parsed && typeof parsed === "object") {
-          return parsed as AnyObject;
-        }
+        return null;
       }
     } catch (e) {
       consola.debug(e);
@@ -498,20 +495,11 @@ export class ResolvedSwaggerSchema {
 
     try {
       const content = fs.readFileSync(filePath, "utf8");
-      const parsed = JSON.parse(content);
+      const parsed = parseSchemaContent(content);
       this.externalSchemaCache.set(filePath, parsed);
       return parsed;
     } catch {
-      try {
-        const content = fs.readFileSync(filePath, "utf8");
-        const parsed = YAML.parse(content);
-        if (parsed && typeof parsed === "object") {
-          this.externalSchemaCache.set(filePath, parsed as AnyObject);
-          return parsed as AnyObject;
-        }
-      } catch (e) {
-        consola.debug(e);
-      }
+      consola.debug("Failed to parse external schema", filePath);
     }
 
     return null;

src/swagger-schema-resolver.ts

@@ -2,11 +2,10 @@ import { consola } from "consola";
 import { compact, merge, uniq } from "es-toolkit";
 import { get } from "es-toolkit/compat";
 import type { OpenAPI, OpenAPIV2, OpenAPIV3 } from "openapi-types";
-import type { AnyObject } from "yummies/types";
 import * as swagger2openapi from "swagger2openapi";
-import * as YAML from "yaml";
 import type { CodeGenConfig } from "./configuration.js";
 import { ResolvedSwaggerSchema } from "./resolved-swagger-schema.js";
+import { parseSchemaContent } from "./util/parse-schema-content.js";
 import type { FileSystem } from "./util/file-system.js";
 import { Request } from "./util/request.js";
 
@@ -133,12 +132,7 @@ export class SwaggerSchemaResolver {
 
   processSwaggerSchemaFile(file: string) {
     if (typeof file !== "string") return file;
-
-    try {
-      return JSON.parse(file);
-    } catch {
-      return YAML.parse(file);
-    }
+    return parseSchemaContent(file);
   }
 
   private normalizeRefValue(ref: string): string {

src/util/parse-schema-content.ts

@@ -0,0 +1,67 @@
+import * as YAML from "yaml";
+import type { AnyObject } from "yummies/types";
+
+function normalizeYamlEscapedLineBreaks(content: string): string {
+  let normalized = "";
+  let inDoubleQuotedScalar = false;
+  let escaped = false;
+
+  for (let index = 0; index < content.length; index += 1) {
+    const currentChar = content[index];
+
+    if (!inDoubleQuotedScalar) {
+      if (currentChar === '"') {
+        inDoubleQuotedScalar = true;
+      }
+      normalized += currentChar;
+      continue;
+    }
+
+    if (escaped) {
+      normalized += currentChar;
+      escaped = false;
+      continue;
+    }
+
+    if (currentChar === "\\") {
+      const nextChar = content[index + 1];
+
+      if (nextChar === "\n" || nextChar === "\r") {
+        index += 1;
+
+        if (nextChar === "\r" && content[index + 1] === "\n") {
+          index += 1;
+        }
+
+        while (
+          content[index + 1] === " " ||
+          content[index + 1] === "\t"
+        ) {
+          index += 1;
+        }
+
+        continue;
+      }
+
+      normalized += currentChar;
+      escaped = true;
+      continue;
+    }
+
+    if (currentChar === '"') {
+      inDoubleQuotedScalar = false;
+    }
+
+    normalized += currentChar;
+  }
+
+  return normalized;
+}
+
+export function parseSchemaContent(content: string): AnyObject {
+  try {
+    return JSON.parse(content) as AnyObject;
+  } catch {
+    return YAML.parse(normalizeYamlEscapedLineBreaks(content)) as AnyObject;
+  }
+}

tests/parse-schema-content.test.ts

@@ -0,0 +1,86 @@
+import { describe, expect, test } from "vitest";
+import { parseSchemaContent } from "../src/util/parse-schema-content.js";
+
+describe("parseSchemaContent", () => {
+  test("parses regular JSON schemas without changes", () => {
+    const schema = parseSchemaContent(
+      JSON.stringify({
+        openapi: "3.0.3",
+        info: {
+          title: "Regular JSON schema",
+          version: "1.0.0",
+        },
+        paths: {},
+      }),
+    );
+
+    expect(schema).toEqual({
+      openapi: "3.0.3",
+      info: {
+        title: "Regular JSON schema",
+        version: "1.0.0",
+      },
+      paths: {},
+    });
+  });
+
+  test("parses regular YAML schemas with common escapes", () => {
+    const schema = parseSchemaContent(`
+openapi: "3.0.3"
+info:
+  title: "Regular YAML schema"
+  version: "1.0.0"
+  description: "Path C:\\\\temp\\\\file and quote: \\"ok\\""
+paths: {}
+`);
+
+    expect(schema).toMatchObject({
+      openapi: "3.0.3",
+      info: {
+        title: "Regular YAML schema",
+        version: "1.0.0",
+        description: 'Path C:\\temp\\file and quote: "ok"',
+      },
+      paths: {},
+    });
+  });
+
+  test("parses YAML double-quoted strings continued with escaped line breaks", () => {
+    const schema = parseSchemaContent(`
+openapi: "3.0.3"
+info:
+  title: "App NG"
+  version: "1.0.0"
+  description: "This is a multine\\
+  description"
+paths: {}
+`);
+
+    expect(schema).toMatchObject({
+      info: {
+        description: "This is a multinedescription",
+      },
+    });
+  });
+
+  test("parses escaped CRLF line continuations in YAML double-quoted strings", () => {
+    const schema = parseSchemaContent(
+      [
+        'openapi: "3.0.3"',
+        "info:",
+        '  title: "App NG"',
+        '  version: "1.0.0"',
+        '  description: "First line\\',
+        "    second line\"",
+        "paths: {}",
+        "",
+      ].join("\r\n"),
+    );
+
+    expect(schema).toMatchObject({
+      info: {
+        description: "First linesecond line",
+      },
+    });
+  });
+});

tests/spec/issue-1433/__snapshots__/basic.test.ts.snap

@@ -13,6 +13,8 @@ exports[`issue-1321 > to match snapshot 1`] = `
  * ---------------------------------------------------------------
  */
 
+export type Test = object;
+
 export interface Call1Params {
   pathParam1: string;
   pathParam2: string;
@@ -286,7 +288,7 @@ export class Api<
 > extends HttpClient<SecurityDataType> {
   call1 = {
     /**
-     * No description
+     * @description This is a multinedescription
      *
      * @name Call1
      * @request GET:/call1
@@ -303,7 +305,7 @@ export class Api<
   };
   call2 = {
     /**
-     * @description This is a multiline description
+     * No description
      *
      * @name Call2
      * @request GET:/call2
@@ -315,6 +317,22 @@ export class Api<
         ...params,
       }),
   };
+  call3 = {
+    /**
+     * No description
+     *
+     * @name Call3
+     * @request POST:/call3
+     */
+    call3: (data: Test, params: RequestParams = {}) =>
+      this.request<void, any>({
+        path: \`/call3\`,
+        method: "POST",
+        body: data,
+        type: ContentType.Json,
+        ...params,
+      }),
+  };
 }
 "
 `;

tests/spec/issue-1433/schema.yaml

@@ -18,14 +18,14 @@ paths:
           required: true
           schema:
             type: string
+      description: "This is a multine\
+      description"
       responses:
         204:
           description: "Accepted"
   /call2:
     get:
       operationId: "call2"
-      description: "This is a multiline
-        description"
       parameters:
         - in: path
           name: pathParam
@@ -34,4 +34,23 @@ paths:
             type: string
       responses:
         204:
-          description: "Accepted"
+          description: "Accepted"
+  /call3:
+    post:
+      operationId: "call3"
+      requestBody:
+        description: "Die benötigten Daten für die Benutzernamen Änderung: Verschlü\
+        sselte Daten des ersten Aufrufs und der neue Benutzername"
+        required: true
+        content:
+          application/json;charset=UTF-8:
+            schema:
+              $ref: "#/components/schemas/Test"
+      responses:
+        204:
+          description: "Accepted"
+
+components:
+  schemas:
+    Test:
+      type: "object"