Merge pull request #502 from hey-api/fix/schemas-key-escape

hey-api · Apr 27, 2024 · 13ebddc · 13ebddc
2 parents ffd237d + 8112507
commit 13ebddc
Show file tree

Hide file tree

Showing 16 changed files with 47 additions and 31 deletions.
diff --git a/.changeset/few-chefs-tell.md b/.changeset/few-chefs-tell.md
@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": patch
+---
+
+fix: escape keys in schemas starting with digit but containing non-digit characters
diff --git a/examples/openapi-ts-axios/package.json b/examples/openapi-ts-axios/package.json
@@ -8,7 +8,8 @@
     "dev": "vite",
     "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
     "openapi-ts": "openapi-ts",
-    "preview": "vite preview"
+    "preview": "vite preview",
+    "typecheck": "tsc --noEmit"
   },
   "dependencies": {
     "@hey-api/client-axios": "workspace:*",

diff --git a/examples/openapi-ts-fetch/package.json b/examples/openapi-ts-fetch/package.json
@@ -8,7 +8,8 @@
     "dev": "vite",
     "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
     "openapi-ts": "openapi-ts",
-    "preview": "vite preview"
+    "preview": "vite preview",
+    "typecheck": "tsc --noEmit"
   },
   "dependencies": {
     "@hey-api/client-fetch": "workspace:*",

diff --git a/packages/openapi-ts/src/compiler/types.ts b/packages/openapi-ts/src/compiler/types.ts
@@ -111,6 +111,14 @@ export const createObjectType = <T extends object>({
       }
       // Check key value equality before possibly modifying it
       const hasShorthandSupport = key === value;
+      if (
+        key.match(/^[0-9]/) &&
+        key.match(/\D+/g) &&
+        !key.startsWith("'") &&
+        !key.endsWith("'")
+      ) {
+        key = `'${key}'`;
+      }
       if (key.match(/\W/g) && !key.startsWith("'") && !key.endsWith("'")) {
         key = `'${key}'`;
       }

diff --git a/packages/openapi-ts/src/utils/write/schemas.ts b/packages/openapi-ts/src/utils/write/schemas.ts
@@ -3,9 +3,11 @@ import type { OpenApi } from '../../openApi';
 import { ensureValidTypeScriptJavaScriptIdentifier } from '../../openApi/common/parser/sanitize';
 import { getConfig } from '../config';
 
-const schemaToFormSchema = (schema: unknown): object => {
+const ensureValidSchemaOutput = (schema: unknown): object => {
+  const config = getConfig();
+
   if (Array.isArray(schema)) {
-    return schema.map((item) => schemaToFormSchema(item));
+    return schema.map((item) => ensureValidSchemaOutput(item));
   }
 
   if (typeof schema !== 'object' || schema === null) {
@@ -14,22 +16,24 @@ const schemaToFormSchema = (schema: unknown): object => {
 
   const result = { ...schema };
   Object.entries(result).forEach(([key, value]) => {
-    if (
-      [
-        'description',
-        'x-enum-descriptions',
-        'x-enum-varnames',
-        'x-enumNames',
-      ].includes(key)
-    ) {
-      // @ts-ignore
-      delete result[key];
-      return;
+    if (config.schemas.type === 'form') {
+      if (
+        [
+          'description',
+          'x-enum-descriptions',
+          'x-enum-varnames',
+          'x-enumNames',
+        ].includes(key)
+      ) {
+        // @ts-ignore
+        delete result[key];
+        return;
+      }
     }
 
     if (value && typeof value === 'object') {
       // @ts-ignore
-      result[key] = schemaToFormSchema(value);
+      result[key] = ensureValidSchemaOutput(value);
     }
   });
   return result;
@@ -46,12 +50,9 @@ export const processSchemas = async ({
     return;
   }
 
-  const config = getConfig();
-
   const addSchema = (name: string, schema: object) => {
     const validName = `$${ensureValidTypeScriptJavaScriptIdentifier(name)}`;
-    const obj =
-      config.schemas.type === 'form' ? schemaToFormSchema(schema) : schema;
+    const obj = ensureValidSchemaOutput(schema);
     const expression = compiler.types.object({ obj });
     const statement = compiler.export.asConst(validName, expression);
     file.add(statement);

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
@@ -167,7 +167,7 @@ export const $ArrayWithProperties = {
     items: {
         type: 'object',
         properties: {
-            foo: {
+            '16x16': {
                 '$ref': '#/components/schemas/camelCaseCommentWithBreaks'
             },
             bar: {

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
@@ -134,7 +134,7 @@ export type ArrayWithArray = Array<Array<ModelWithString>>;
  * This is a simple array with properties
  */
 export type ArrayWithProperties = Array<{
-    foo?: camelCaseCommentWithBreaks;
+    '16x16'?: camelCaseCommentWithBreaks;
     bar?: string;
 }>;
 

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
@@ -134,7 +134,7 @@ export type ArrayWithArray = Array<Array<ModelWithString>>;
  * This is a simple array with properties
  */
 export type ArrayWithProperties = Array<{
-    foo?: camelCaseCommentWithBreaks;
+    '16x16'?: camelCaseCommentWithBreaks;
     bar?: string;
 }>;
 

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
@@ -134,7 +134,7 @@ export type ArrayWithArray = Array<Array<ModelWithString>>;
  * This is a simple array with properties
  */
 export type ArrayWithProperties = Array<{
-    foo?: camelCaseCommentWithBreaks;
+    '16x16'?: camelCaseCommentWithBreaks;
     bar?: string;
 }>;
 

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
@@ -134,7 +134,7 @@ export type ArrayWithArray = Array<Array<ModelWithString>>;
  * This is a simple array with properties
  */
 export type ArrayWithProperties = Array<{
-    foo?: camelCaseCommentWithBreaks;
+    '16x16'?: camelCaseCommentWithBreaks;
     bar?: string;
 }>;
 

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
@@ -134,7 +134,7 @@ export type ArrayWithArray = Array<Array<ModelWithString>>;
  * This is a simple array with properties
  */
 export type ArrayWithProperties = Array<{
-    foo?: camelCaseCommentWithBreaks;
+    '16x16'?: camelCaseCommentWithBreaks;
     bar?: string;
 }>;
 

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_pascalcase/types.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_pascalcase/types.gen.ts.snap
@@ -12,6 +12,6 @@ export type CamelCaseCommentWithBreaks = number;
  * This is a simple array with properties
  */
 export type ArrayWithProperties = Array<{
-    foo?: CamelCaseCommentWithBreaks;
+    '16x16'?: CamelCaseCommentWithBreaks;
     bar?: string;
 }>;
diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_schemas_form/schemas.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_schemas_form/schemas.gen.ts.snap
@@ -133,7 +133,7 @@ export const $ArrayWithProperties = {
     items: {
         type: 'object',
         properties: {
-            foo: {
+            '16x16': {
                 '$ref': '#/components/schemas/camelCaseCommentWithBreaks'
             },
             bar: {

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
@@ -167,7 +167,7 @@ export const $ArrayWithProperties = {
     items: {
         type: 'object',
         properties: {
-            foo: {
+            '16x16': {
                 '$ref': '#/components/schemas/camelCaseCommentWithBreaks'
             },
             bar: {

diff --git a/packages/openapi-ts/test/sample.cjs b/packages/openapi-ts/test/sample.cjs
@@ -8,7 +8,7 @@ const main = async () => {
     input: './test/spec/v3.json',
     output: './test/generated/v3/',
     schemas: {
-      export: false,
+      // export: false,
     },
     services: {
       // export: false,

diff --git a/packages/openapi-ts/test/spec/v3.json b/packages/openapi-ts/test/spec/v3.json
@@ -1797,7 +1797,7 @@
         "items": {
           "type": "object",
           "properties": {
-            "foo": {
+            "16x16": {
               "$ref": "#/components/schemas/camelCaseCommentWithBreaks"
             },
             "bar": {