Merge pull request #2153 from hey-api/feat/object-property-names

fix(parser): handle propertyNames keyword

Author: mrlubos

.changeset/selfish-vans-heal.md

@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+fix(parser): handle `propertyNames` keyword

packages/openapi-ts-tests/test/3.1.x.test.ts

@@ -508,6 +508,14 @@ describe(`OpenAPI ${version}`, () => {
       description:
         'sets correct logical operator and brackets on object with properties and oneOf composition',
     },
+    {
+      config: createConfig({
+        input: 'object-property-names.yaml',
+        output: 'object-property-names',
+      }),
+      description:
+        'sets correct index signature type on object with property names',
+    },
     {
       config: createConfig({
         input: 'operation-204.json',

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

@@ -0,0 +1,2 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export * from './types.gen';

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

@@ -0,0 +1,11 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type Foo = 'foo' | 'bar';
+
+export type Bar = {
+    [key in Foo]?: string;
+};
+
+export type ClientOptions = {
+    baseUrl: `${string}://${string}` | (string & {});
+};

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

@@ -51,7 +51,12 @@ export default defineConfig(() => {
       //   'invalid',
       //   'servers-entry.yaml',
       // ),
-      path: path.resolve(__dirname, 'spec', '3.1.x', 'type-format.yaml'),
+      path: path.resolve(
+        __dirname,
+        'spec',
+        '3.1.x',
+        'object-property-names.yaml',
+      ),
       // path: 'http://localhost:4000/',
       // path: 'https://get.heyapi.dev/',
       // path: 'https://get.heyapi.dev/hey-api/backend?branch=main&version=1.0.0',
@@ -114,9 +119,9 @@ export default defineConfig(() => {
         // operationId: false,
         // responseStyle: 'data',
         // throwOnError: true,
-        transformer: '@hey-api/transformers',
+        // transformer: '@hey-api/transformers',
         // transformer: true,
-        validator: 'zod',
+        // validator: 'zod',
       },
       {
         // bigInt: true,
@@ -140,17 +145,17 @@ export default defineConfig(() => {
       },
       {
         exportFromIndex: true,
-        name: '@tanstack/react-query',
+        // name: '@tanstack/react-query',
       },
       {
         // comments: false,
         // exportFromIndex: true,
-        name: 'valibot',
+        // name: 'valibot',
       },
       {
         // comments: false,
         // exportFromIndex: true,
-        name: 'zod',
+        // name: 'zod',
       },
     ],
     // useOptions: false,

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

@@ -0,0 +1,17 @@
+openapi: 3.1.1
+info:
+  title: OpenAPI 3.1.1 object property names example
+  version: 1
+components:
+  schemas:
+    Foo:
+      enum:
+        - foo
+        - bar
+      type: string
+    Bar:
+      additionalProperties:
+        type: string
+      propertyNames:
+        $ref: '#/components/schemas/Foo'
+      type: object

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

@@ -3,9 +3,11 @@ import ts from 'typescript';
 import { validTypescriptIdentifierRegExp } from '../utils/regexp';
 import {
   createKeywordTypeNode,
+  createMappedTypeNode,
   createParameterDeclaration,
   createStringLiteral,
   createTypeNode,
+  createTypeParameterDeclaration,
   createTypeReferenceNode,
 } from './types';
 import {
@@ -51,13 +53,26 @@ const maybeNullable = ({
  * @returns ts.TypeLiteralNode | ts.TypeUnionNode
  */
 export const createTypeInterfaceNode = ({
+  indexKey,
   indexProperty,
   isNullable,
   properties,
   useLegacyResolution,
 }: {
+  /**
+   * Adds an index key type.
+   *
+   * @example
+   * ```ts
+   * type IndexKey = {
+   *   [key in Foo]: string
+   * }
+   * ```
+   */
+  indexKey?: string;
   /**
    * Adds an index signature if defined.
+   *
    * @example
    * ```ts
    * type IndexProperty = {
@@ -72,59 +87,84 @@ export const createTypeInterfaceNode = ({
 }) => {
   const propertyTypes: Array<ts.TypeNode> = [];
 
-  const members: Array<ts.TypeElement> = properties.map((property) => {
-    const modifiers: readonly ts.Modifier[] | undefined = property.isReadOnly
-      ? [createModifier({ keyword: 'readonly' })]
-      : undefined;
-
-    const questionToken: ts.QuestionToken | undefined =
-      property.isRequired !== false
-        ? undefined
-        : ts.factory.createToken(ts.SyntaxKind.QuestionToken);
-
-    const type: ts.TypeNode | undefined = createTypeNode(property.type);
-    propertyTypes.push(type);
-
-    const signature = ts.factory.createPropertySignature(
-      modifiers,
-      useLegacyResolution ||
-        (typeof property.name === 'string' &&
-          property.name.match(validTypescriptIdentifierRegExp)) ||
-        (typeof property.name !== 'string' && ts.isPropertyName(property.name))
-        ? property.name
-        : createStringLiteral({ text: property.name }),
-      questionToken,
-      type,
-    );
-
-    addLeadingComments({
-      comments: property.comment,
-      node: signature,
-    });
-
-    return signature;
-  });
-
-  if (indexProperty) {
-    const modifiers: readonly ts.Modifier[] | undefined =
-      indexProperty.isReadOnly
+  const members: Array<ts.TypeElement | ts.MappedTypeNode> = properties.map(
+    (property) => {
+      const modifiers: readonly ts.Modifier[] | undefined = property.isReadOnly
         ? [createModifier({ keyword: 'readonly' })]
         : undefined;
-    const indexSignature = ts.factory.createIndexSignature(
-      modifiers,
-      [
-        createParameterDeclaration({
+
+      const questionToken: ts.QuestionToken | undefined =
+        property.isRequired !== false
+          ? undefined
+          : ts.factory.createToken(ts.SyntaxKind.QuestionToken);
+
+      const type: ts.TypeNode | undefined = createTypeNode(property.type);
+      propertyTypes.push(type);
+
+      const signature = ts.factory.createPropertySignature(
+        modifiers,
+        useLegacyResolution ||
+          (typeof property.name === 'string' &&
+            property.name.match(validTypescriptIdentifierRegExp)) ||
+          (typeof property.name !== 'string' &&
+            ts.isPropertyName(property.name))
+          ? property.name
+          : createStringLiteral({ text: property.name }),
+        questionToken,
+        type,
+      );
+
+      addLeadingComments({
+        comments: property.comment,
+        node: signature,
+      });
+
+      return signature;
+    },
+  );
+
+  let isIndexMapped = false;
+
+  if (indexProperty) {
+    if (!properties.length && indexKey) {
+      const indexSignature = createMappedTypeNode({
+        questionToken: ts.factory.createToken(ts.SyntaxKind.QuestionToken),
+        type: createKeywordTypeNode({ keyword: 'string' }),
+        typeParameter: createTypeParameterDeclaration({
+          constraint: createTypeReferenceNode({ typeName: indexKey }),
           name: createIdentifier({ text: String(indexProperty.name) }),
-          type: createKeywordTypeNode({ keyword: 'string' }),
         }),
-      ],
-      createTypeNode(indexProperty.type),
-    );
-    members.push(indexSignature);
+      });
+      members.push(indexSignature);
+      isIndexMapped = true;
+    } else {
+      const modifiers: ReadonlyArray<ts.Modifier> | undefined =
+        indexProperty.isReadOnly
+          ? [createModifier({ keyword: 'readonly' })]
+          : undefined;
+      const indexSignature = ts.factory.createIndexSignature(
+        modifiers,
+        [
+          createParameterDeclaration({
+            name: createIdentifier({ text: String(indexProperty.name) }),
+            type: createKeywordTypeNode({ keyword: 'string' }),
+          }),
+        ],
+        createTypeNode(indexProperty.type),
+      );
+      members.push(indexSignature);
+    }
   }
 
-  const node = ts.factory.createTypeLiteralNode(members);
-  return maybeNullable({ isNullable, node });
+  const node = isIndexMapped
+    ? members[0]!
+    : // @ts-expect-error
+      ts.factory.createTypeLiteralNode(members);
+  return maybeNullable({
+    isNullable,
+    // @ts-expect-error
+    node,
+  });
 };
 
 /**

packages/openapi-ts/src/ir/types.d.ts

@@ -177,6 +177,13 @@ interface IRSchemaObject
    * When type is `object`, `properties` will contain a map of its properties.
    */
   properties?: Record<string, IRSchemaObject>;
+  /**
+   * The names of `properties` can be validated against a schema, irrespective
+   * of their values. This can be useful if you don't want to enforce specific
+   * properties, but you want to make sure that the names of those properties
+   * follow a specific convention.
+   */
+  propertyNames?: IRSchemaObject;
   /**
    * Each schema eventually resolves into `type`.
    */

packages/openapi-ts/src/openApi/3.1.x/parser/graph.ts

@@ -80,6 +80,10 @@ const collectSchemaDependencies = (
       collectSchemaDependencies(item, dependencies);
     }
   }
+
+  if (schema.propertyNames && typeof schema.propertyNames === 'object') {
+    collectSchemaDependencies(schema.propertyNames, dependencies);
+  }
 };
 
 export const createGraph = ({

packages/openapi-ts/src/openApi/3.1.x/parser/schema.ts

@@ -324,6 +324,14 @@ const parseObject = ({
     irSchema.additionalProperties = irAdditionalPropertiesSchema;
   }
 
+  if (schema.propertyNames) {
+    irSchema.propertyNames = schemaToIrSchema({
+      context,
+      schema: schema.propertyNames,
+      state,
+    });
+  }
+
   if (schema.required) {
     irSchema.required = schema.required;
   }