Merge pull request #431 from hey-api/fix/template-bugs

fix: template bugs
hey-api · Apr 19, 2024 · 70222a2 · 70222a2
2 parents 0e1776b + 0b75192
commit 70222a2
Show file tree

Hide file tree

Showing 15 changed files with 280 additions and 6 deletions.
diff --git a/.changeset/heavy-pumas-bow.md b/.changeset/heavy-pumas-bow.md
@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": patch
+---
+
+fix: properly escape backticks in template literals
diff --git a/.changeset/slimy-wolves-relax.md b/.changeset/slimy-wolves-relax.md
@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": patch
+---
+
+fix: properly escape expressions in template literals
diff --git a/packages/openapi-ts/src/compiler/utils.ts b/packages/openapi-ts/src/compiler/utils.ts
@@ -98,7 +98,7 @@ export const ots = {
       (hasNewlines || hasBothQuotes || hasUnescapedBackticks) &&
       !isBacktickEscaped
     ) {
-      value = `\`${value.replace(/`/g, '\\`')}\``;
+      value = `\`${value.replace(/(?<!\\)`/g, '\\`').replace(/\${/g, '\\${')}\``;
     }
     const text = encodeURIComponent(value);
     if (value.startsWith('`')) {

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3/schemas.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3/schemas.gen.ts.snap
@@ -1670,3 +1670,40 @@ export const $ModelWithNumericEnumUnion = {
     },
   },
 } as const;
+
+export const $ModelWithBackticksInDescription = {
+  description: 'Some description with `back ticks`',
+  type: 'object',
+  properties: {
+    template: {
+      type: 'string',
+      description: `The template \`that\` should be used for parsing and importing the contents of the CSV file.
+
+<br/><p>There is one placeholder currently supported:<ul>     <li><b>\${x}</b> - refers to the n-th column in the CSV file, e.g. \${1}, \${2}, ...)</li></ul><p>Example of a correct JSON template:</p>
+<pre>
+[
+  {
+    "resourceType": "Asset",
+    "identifier": {
+      "name": "\${1}",
+      "domain": {
+        "name": "\${2}",
+        "community": {
+          "name": "Some Community"
+        }
+      }
+    },
+    "attributes" : {
+      "00000000-0000-0000-0000-000000003115" : [ {
+        "value" : "\${3}" 
+      } ],
+      "00000000-0000-0000-0000-000000000222" : [ {
+        "value" : "\${4}"
+      } ]
+    }
+  }
+]
+</pre>`,
+    },
+  },
+} as const;
diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3/services.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3/services.gen.ts.snap
@@ -783,7 +783,7 @@ export class ComplexService {
         parameterReference,
       },
       errors: {
-        400: '400 server error',
+        400: '400 `server` error',
         500: '500 server error',
       },
     });

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3/types.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3/types.gen.ts.snap
@@ -837,6 +837,42 @@ export type ModelWithNumericEnumUnion = {
   value?: 1 | 3 | 6 | 12;
 };
 
+/**
+ * Some description with `back ticks`
+ */
+export type ModelWithBackticksInDescription = {
+  /**
+   * The template `that` should be used for parsing and importing the contents of the CSV file.
+   *
+   * <br/><p>There is one placeholder currently supported:<ul>     <li><b>${x}</b> - refers to the n-th column in the CSV file, e.g. ${1}, ${2}, ...)</li></ul><p>Example of a correct JSON template:</p>
+   * <pre>
+   * [
+   * {
+   * "resourceType": "Asset",
+   * "identifier": {
+   * "name": "${1}",
+   * "domain": {
+   * "name": "${2}",
+   * "community": {
+   * "name": "Some Community"
+   * }
+   * }
+   * },
+   * "attributes" : {
+   * "00000000-0000-0000-0000-000000003115" : [ {
+   * "value" : "${3}"
+   * } ],
+   * "00000000-0000-0000-0000-000000000222" : [ {
+   * "value" : "${4}"
+   * } ]
+   * }
+   * }
+   * ]
+   * </pre>
+   */
+  template?: string;
+};
+
 /**
  * This is a reusable parameter
  */

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/services.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/services.gen.ts.snap
@@ -874,7 +874,7 @@ export class ComplexService {
         parameterReference,
       },
       errors: {
-        400: '400 server error',
+        400: '400 `server` error',
         500: '500 server error',
       },
     });

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/types.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/types.gen.ts.snap
@@ -837,6 +837,42 @@ export type ModelWithNumericEnumUnion = {
   value?: 1 | 3 | 6 | 12;
 };
 
+/**
+ * Some description with `back ticks`
+ */
+export type ModelWithBackticksInDescription = {
+  /**
+   * The template `that` should be used for parsing and importing the contents of the CSV file.
+   *
+   * <br/><p>There is one placeholder currently supported:<ul>     <li><b>${x}</b> - refers to the n-th column in the CSV file, e.g. ${1}, ${2}, ...)</li></ul><p>Example of a correct JSON template:</p>
+   * <pre>
+   * [
+   * {
+   * "resourceType": "Asset",
+   * "identifier": {
+   * "name": "${1}",
+   * "domain": {
+   * "name": "${2}",
+   * "community": {
+   * "name": "Some Community"
+   * }
+   * }
+   * },
+   * "attributes" : {
+   * "00000000-0000-0000-0000-000000003115" : [ {
+   * "value" : "${3}"
+   * } ],
+   * "00000000-0000-0000-0000-000000000222" : [ {
+   * "value" : "${4}"
+   * } ]
+   * }
+   * }
+   * ]
+   * </pre>
+   */
+  template?: string;
+};
+
 /**
  * This is a reusable parameter
  */

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_client/services.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_client/services.gen.ts.snap
@@ -820,7 +820,7 @@ export class ComplexService {
         parameterReference,
       },
       errors: {
-        400: '400 server error',
+        400: '400 `server` error',
         500: '500 server error',
       },
     });

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_client/types.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_client/types.gen.ts.snap
@@ -837,6 +837,42 @@ export type ModelWithNumericEnumUnion = {
   value?: 1 | 3 | 6 | 12;
 };
 
+/**
+ * Some description with `back ticks`
+ */
+export type ModelWithBackticksInDescription = {
+  /**
+   * The template `that` should be used for parsing and importing the contents of the CSV file.
+   *
+   * <br/><p>There is one placeholder currently supported:<ul>     <li><b>${x}</b> - refers to the n-th column in the CSV file, e.g. ${1}, ${2}, ...)</li></ul><p>Example of a correct JSON template:</p>
+   * <pre>
+   * [
+   * {
+   * "resourceType": "Asset",
+   * "identifier": {
+   * "name": "${1}",
+   * "domain": {
+   * "name": "${2}",
+   * "community": {
+   * "name": "Some Community"
+   * }
+   * }
+   * },
+   * "attributes" : {
+   * "00000000-0000-0000-0000-000000003115" : [ {
+   * "value" : "${3}"
+   * } ],
+   * "00000000-0000-0000-0000-000000000222" : [ {
+   * "value" : "${4}"
+   * } ]
+   * }
+   * }
+   * ]
+   * </pre>
+   */
+  template?: string;
+};
+
 /**
  * This is a reusable parameter
  */

diff --git a/...ges/openapi-ts/test/__snapshots__/test/generated/v3_enums_typescript/services.gen.ts.snap b/...ges/openapi-ts/test/__snapshots__/test/generated/v3_enums_typescript/services.gen.ts.snap
@@ -783,7 +783,7 @@ export class ComplexService {
         parameterReference,
       },
       errors: {
-        400: '400 server error',
+        400: '400 `server` error',
         500: '500 server error',
       },
     });

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_enums_typescript/types.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_enums_typescript/types.gen.ts.snap
@@ -837,6 +837,42 @@ export type ModelWithNumericEnumUnion = {
   value?: 1 | 3 | 6 | 12;
 };
 
+/**
+ * Some description with `back ticks`
+ */
+export type ModelWithBackticksInDescription = {
+  /**
+   * The template `that` should be used for parsing and importing the contents of the CSV file.
+   *
+   * <br/><p>There is one placeholder currently supported:<ul>     <li><b>${x}</b> - refers to the n-th column in the CSV file, e.g. ${1}, ${2}, ...)</li></ul><p>Example of a correct JSON template:</p>
+   * <pre>
+   * [
+   * {
+   * "resourceType": "Asset",
+   * "identifier": {
+   * "name": "${1}",
+   * "domain": {
+   * "name": "${2}",
+   * "community": {
+   * "name": "Some Community"
+   * }
+   * }
+   * },
+   * "attributes" : {
+   * "00000000-0000-0000-0000-000000003115" : [ {
+   * "value" : "${3}"
+   * } ],
+   * "00000000-0000-0000-0000-000000000222" : [ {
+   * "value" : "${4}"
+   * } ]
+   * }
+   * }
+   * ]
+   * </pre>
+   */
+  template?: string;
+};
+
 /**
  * This is a reusable parameter
  */

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_models/types.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_models/types.gen.ts.snap
@@ -837,6 +837,42 @@ export type ModelWithNumericEnumUnion = {
   value?: 1 | 3 | 6 | 12;
 };
 
+/**
+ * Some description with `back ticks`
+ */
+export type ModelWithBackticksInDescription = {
+  /**
+   * The template `that` should be used for parsing and importing the contents of the CSV file.
+   *
+   * <br/><p>There is one placeholder currently supported:<ul>     <li><b>${x}</b> - refers to the n-th column in the CSV file, e.g. ${1}, ${2}, ...)</li></ul><p>Example of a correct JSON template:</p>
+   * <pre>
+   * [
+   * {
+   * "resourceType": "Asset",
+   * "identifier": {
+   * "name": "${1}",
+   * "domain": {
+   * "name": "${2}",
+   * "community": {
+   * "name": "Some Community"
+   * }
+   * }
+   * },
+   * "attributes" : {
+   * "00000000-0000-0000-0000-000000003115" : [ {
+   * "value" : "${3}"
+   * } ],
+   * "00000000-0000-0000-0000-000000000222" : [ {
+   * "value" : "${4}"
+   * } ]
+   * }
+   * }
+   * ]
+   * </pre>
+   */
+  template?: string;
+};
+
 /**
  * This is a reusable parameter
  */

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_schemas_json/schemas.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_schemas_json/schemas.gen.ts.snap
@@ -1670,3 +1670,40 @@ export const $ModelWithNumericEnumUnion = {
     },
   },
 } as const;
+
+export const $ModelWithBackticksInDescription = {
+  description: 'Some description with `back ticks`',
+  type: 'object',
+  properties: {
+    template: {
+      type: 'string',
+      description: `The template \`that\` should be used for parsing and importing the contents of the CSV file.
+
+<br/><p>There is one placeholder currently supported:<ul>     <li><b>\${x}</b> - refers to the n-th column in the CSV file, e.g. \${1}, \${2}, ...)</li></ul><p>Example of a correct JSON template:</p>
+<pre>
+[
+  {
+    "resourceType": "Asset",
+    "identifier": {
+      "name": "\${1}",
+      "domain": {
+        "name": "\${2}",
+        "community": {
+          "name": "Some Community"
+        }
+      }
+    },
+    "attributes" : {
+      "00000000-0000-0000-0000-000000003115" : [ {
+        "value" : "\${3}" 
+      } ],
+      "00000000-0000-0000-0000-000000000222" : [ {
+        "value" : "\${4}"
+      } ]
+    }
+  }
+]
+</pre>`,
+    },
+  },
+} as const;
diff --git a/packages/openapi-ts/test/spec/v3.json b/packages/openapi-ts/test/spec/v3.json
@@ -1292,7 +1292,7 @@
             }
           },
           "400": {
-            "description": "400 server error"
+            "description": "400 `server` error"
           },
           "500": {
             "description": "500 server error"
@@ -3183,6 +3183,16 @@
             "enum": [1, 3, 6, 12]
           }
         }
+      },
+      "ModelWithBackticksInDescription": {
+        "description": "Some description with `back ticks`",
+        "type": "object",
+        "properties": {
+          "template": {
+            "type": "string",
+            "description": "The template `that` should be used for parsing and importing the contents of the CSV file.\n\n<br/><p>There is one placeholder currently supported:<ul>     <li><b>${x}</b> - refers to the n-th column in the CSV file, e.g. ${1}, ${2}, ...)</li></ul><p>Example of a correct JSON template:</p>\n<pre>\n[\n  {\n    \"resourceType\": \"Asset\",\n    \"identifier\": {\n      \"name\": \"${1}\",\n      \"domain\": {\n        \"name\": \"${2}\",\n        \"community\": {\n          \"name\": \"Some Community\"\n        }\n      }\n    },\n    \"attributes\" : {\n      \"00000000-0000-0000-0000-000000003115\" : [ {\n        \"value\" : \"${3}\" \n      } ],\n      \"00000000-0000-0000-0000-000000000222\" : [ {\n        \"value\" : \"${4}\"\n      } ]\n    }\n  }\n]\n</pre>"
+          }
+        }
       }
     }
   }