Fix property escaping for discriminators (#1166)

* Fix property escaping for discriminators

* Add changeset

---------

Co-authored-by: Piet van Agtmaal <[email protected]>

Author: pvanagtmaal

.changeset/five-eels-call.md

@@ -0,0 +1,5 @@
+---
+"openapi-typescript": patch
+---
+
+Fix property escaping for discriminators

packages/openapi-typescript/src/transform/schema-object.ts

@@ -178,7 +178,7 @@ export function defaultSchemaObjectTransform(schemaObject: SchemaObject | Refere
         const matchedValue = Object.entries(discriminator.mapping).find(([_, v]) => (!v.startsWith("#") && v === value) || (v.startsWith("#") && parseRef(v).path.pop() === value));
         if (matchedValue) value = matchedValue[0]; // why was this designed backwards!?
       }
-      coreType.unshift(indent(`${discriminator.propertyName}: ${escStr(value)};`, indentLv + 1));
+      coreType.unshift(indent(`${escObjKey(discriminator.propertyName)}: ${escStr(value)};`, indentLv + 1));
       break;
     }
   }

packages/openapi-typescript/test/schema-object.test.ts

@@ -364,6 +364,35 @@ describe("Schema Object", () => {
   operation: "test";
 } & Omit<components["schemas"]["parent"], "operation"> & {
   string?: string;
+}`);
+      });
+
+      test("discriminator escape", () => {
+        const schema: SchemaObject = {
+          type: "object",
+          allOf: [
+            { $ref: 'components["schemas"]["parent"]' },
+            { type: "object", properties: { string: { type: "string" } } },
+          ],
+        };
+        const generated = transformSchemaObject(schema, {
+          path: options.path,
+          ctx: {
+            ...options.ctx,
+            discriminators: {
+              'components["schemas"]["parent"]': {
+                propertyName: "@type",
+                mapping: {
+                  test: options.path,
+                },
+              },
+            },
+          },
+        });
+        expect(generated).toBe(`{
+  "@type": "test";
+} & Omit<components["schemas"]["parent"], "@type"> & {
+  string?: string;
 }`);
       });
     });

packages/openapi-typescript/test/utils.test.ts

@@ -1,5 +1,5 @@
 import { bench } from "vitest";
-import { parseRef, tsIntersectionOf, tsUnionOf } from "../src/utils.js";
+import { escObjKey, parseRef, tsIntersectionOf, tsUnionOf } from "../src/utils.js";
 
 describe("utils", () => {
   describe("tsUnionOf", () => {
@@ -80,4 +80,30 @@ describe("utils", () => {
       expect(parseRef('components["schemas"]["SchemaObject"]')).toStrictEqual({ filename: ".", path: ["components", "schemas", "SchemaObject"] });
     });
   });
+
+  describe("escObjKey", () => {
+    it("basic", () => {
+      expect(escObjKey("some-prop")).toStrictEqual("\"some-prop\"");
+    });
+
+    it("@ escapes", () => {
+      expect(escObjKey("@type")).toStrictEqual("\"@type\"");
+    });
+
+    it("number escapes", () => {
+      expect(escObjKey("123var")).toStrictEqual("\"123var\"");
+    });
+
+    it("only number no escapes", () => {
+      expect(escObjKey("123")).toStrictEqual("123");
+    });
+
+    it("$ no escapes", () => {
+      expect(escObjKey("$ref")).toStrictEqual("$ref");
+    });
+
+    it("_ no escapes", () => {
+      expect(escObjKey("_ref_")).toStrictEqual("_ref_");
+    })
+  })
 });