Merge pull request #2279 from hey-api/fix/typescript-property-names

fix(typescript): handle additionalProperties in propertyNames

Author: mrlubos

.changeset/honest-kings-juggle.md

@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+fix(typescript): handle additionalProperties in propertyNames

packages/openapi-ts-tests/test/__snapshots__/3.1.x/object-property-names/types.gen.ts

@@ -6,6 +6,10 @@ export type Bar = {
     [key in Foo]?: string;
 };
 
+export type Baz = {
+    [key in Foo]?: number;
+};
+
 export type ClientOptions = {
     baseUrl: `${string}://${string}` | (string & {});
 };

packages/openapi-ts-tests/test/openapi-ts.config.ts

@@ -37,12 +37,7 @@ export default defineConfig(() => {
       //   'invalid',
       //   'servers-entry.yaml',
       // ),
-      path: path.resolve(
-        __dirname,
-        'spec',
-        '3.1.x',
-        'array-items-one-of-length-1.yaml',
-      ),
+      path: path.resolve(__dirname, 'spec', '3.1.x', 'full.yaml'),
       // path: path.resolve(__dirname, 'spec', 'v3-transforms.json'),
       // path: path.resolve(__dirname, 'spec', 'v3.json'),
       // path: 'http://localhost:4000/',
@@ -113,7 +108,7 @@ export default defineConfig(() => {
           // name: '{{name}}',
         },
         readWrite: {
-          // enabled: false,
+          enabled: false,
           requests: '{{name}}Writable',
           responses: '{{name}}',
         },

packages/openapi-ts-tests/test/spec/3.1.x/object-property-names.yaml

@@ -15,3 +15,9 @@ components:
       propertyNames:
         $ref: '#/components/schemas/Foo'
       type: object
+    Baz:
+      additionalProperties:
+        type: integer
+      propertyNames:
+        $ref: '#/components/schemas/Foo'
+      type: object

packages/openapi-ts/src/compiler/typedef.ts

@@ -129,7 +129,8 @@ export const createTypeInterfaceNode = ({
     if (!properties.length && indexKey) {
       const indexSignature = createMappedTypeNode({
         questionToken: ts.factory.createToken(ts.SyntaxKind.QuestionToken),
-        type: createKeywordTypeNode({ keyword: 'string' }),
+        type:
+          indexProperty.type ?? createKeywordTypeNode({ keyword: 'string' }),
         typeParameter: createTypeParameterDeclaration({
           constraint: createTypeReferenceNode({ typeName: indexKey }),
           name: createIdentifier({ text: String(indexProperty.name) }),

packages/openapi-ts/src/plugins/@hey-api/typescript/plugin.ts

@@ -5,7 +5,7 @@ import { compiler } from '../../../compiler';
 import { operationResponsesMap } from '../../../ir/operation';
 import { deduplicateSchema } from '../../../ir/schema';
 import type { IR } from '../../../ir/types';
-import { irRef, isRefOpenApiComponent, refToName } from '../../../utils/ref';
+import { irRef, isRefOpenApiComponent } from '../../../utils/ref';
 import { numberRegExp } from '../../../utils/regexp';
 import { stringCase } from '../../../utils/stringCase';
 import { fieldName } from '../../shared/utils/case';
@@ -462,6 +462,8 @@ const objectTypeToIdentifier = ({
   schema: SchemaWithType<'object'>;
   state: State | undefined;
 }): ts.TypeNode | undefined => {
+  const file = plugin.context.file({ id: typesId })!;
+
   // TODO: parser - handle constants
   let indexKey: string | undefined;
   let indexProperty: Property | undefined;
@@ -533,9 +535,14 @@ const objectTypeToIdentifier = ({
       }),
     };
 
-    if (schema.propertyNames) {
-      if (schema.propertyNames.$ref) {
-        indexKey = refToName(schema.propertyNames.$ref);
+    if (schema.propertyNames?.$ref) {
+      const identifier = file.identifier({
+        $ref: schema.propertyNames.$ref,
+        create: true,
+        namespace: 'type',
+      });
+      if (identifier.name) {
+        indexKey = identifier.name;
       }
     }
   }