fix(parser): do not ignore additionalProperties when object with prop…

…erties

.changeset/heavy-tips-deliver.md

@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": patch
+---
+
+fix: do not ignore additionalProperties when object with properties object

packages/openapi-ts/src/openApi/v3/parser/getModel.ts

@@ -146,7 +146,7 @@ export const getModel = (
                 }
             });
 
-            if (definition.additionalProperties === true) {
+            if (definition.additionalProperties) {
                 const modelProperty = getAdditionalPropertiesModel(openApi, definition, getModel, model);
                 model.properties.push(modelProperty);
             }

packages/openapi-ts/src/openApi/v3/parser/getModelProperties.ts

@@ -20,14 +20,6 @@ export const getAdditionalPropertiesModel = (
     const ap = typeof definition.additionalProperties === 'object' ? definition.additionalProperties : {};
     const apModel = getModel(openApi, ap);
 
-    if (definition.additionalProperties === true && definition.properties) {
-        apModel.default = getDefault(definition, model);
-        apModel.export = 'generic';
-        apModel.isRequired = true;
-        apModel.name = '[key: string]';
-        return apModel;
-    }
-
     if (ap.$ref) {
         const apType = getType(ap.$ref);
         model.base = apType.base;
@@ -39,6 +31,14 @@ export const getAdditionalPropertiesModel = (
         return model;
     }
 
+    if (definition.additionalProperties && definition.properties) {
+        apModel.default = getDefault(definition, model);
+        apModel.export = 'generic';
+        apModel.isRequired = definition.additionalProperties === true;
+        apModel.name = '[key: string]';
+        return apModel;
+    }
+
     model.base = apModel.base;
     model.default = getDefault(definition, model);
     model.export = 'dictionary';

packages/openapi-ts/src/utils/write/models.ts

@@ -57,26 +57,24 @@ const processEnum = (config: Config, client: Client, model: Model, exportType: b
     return nodes;
 };
 
-const processInterface = processComposition;
-
 const processType = (config: Config, client: Client, model: Model) => {
     const comment: Comments = [
         model.description && ` * ${escapeComment(model.description)}`,
         model.deprecated && ' * @deprecated',
     ];
-    return compiler.typedef.alias(model.name, toType(model, config)!, comment);
+    const type = toType(model, config);
+    return compiler.typedef.alias(model.name, type!, comment);
 };
 
 const processModel = (config: Config, client: Client, model: Model) => {
     switch (model.export) {
         case 'all-of':
         case 'any-of':
         case 'one-of':
+        case 'interface':
             return processComposition(config, client, model);
         case 'enum':
             return processEnum(config, client, model, true);
-        case 'interface':
-            return processInterface(config, client, model);
         default:
             return processType(config, client, model);
     }

packages/openapi-ts/src/utils/write/type.ts

@@ -9,13 +9,13 @@ import { unique } from '../unique';
 const base = (model: Model, config: Config) => {
     if (model.base === 'binary') {
         return 'Blob | File';
-    } else {
-        if (config.useDateType && model.format === 'date-time') {
-            return 'Date';
-        } else {
-            return model.base;
-        }
     }
+
+    if (config.useDateType && model.format === 'date-time') {
+        return 'Date';
+    }
+
+    return model.base;
 };
 
 const typeReference = (model: Model, config: Config) => `${base(model, config)}${model.isNullable ? ' | null' : ''}`;
@@ -73,15 +73,22 @@ const typeInterface = (model: Model, config: Config) => {
 
     return `{
         ${model.properties
-            .map(m => {
+            .map(property => {
                 let s = '';
-                if (m.description || m.deprecated) {
+                if (property.description || property.deprecated) {
                     s += addLeadingJSDocComment(undefined, [
-                        m.description && ` * ${escapeComment(m.description)}`,
-                        m.deprecated && ` * @deprecated`,
+                        property.description && ` * ${escapeComment(property.description)}`,
+                        property.deprecated && ` * @deprecated`,
                     ]);
                 }
-                s += `${m.isReadOnly ? 'readonly ' : ''}${m.name}${modelIsRequired(config, m)}: ${toType(m, config)}`;
+                let maybeRequired = modelIsRequired(config, property);
+                let value = toType(property, config);
+                // special case for additional properties type
+                if (property.name === '[key: string]' && maybeRequired) {
+                    maybeRequired = '';
+                    value = `${value} | undefined`;
+                }
+                s += `${property.isReadOnly ? 'readonly ' : ''}${property.name}${maybeRequired}: ${value}`;
                 return s;
             })
             .join('\n')}

packages/openapi-ts/test/__snapshots__/test/generated/v3/models.ts.snap

@@ -217,6 +217,11 @@ export type AnyOfArrays = {
  */
 export type DictionaryWithString = Record<string, string>;
 
+export type DictionaryWithPropertiesAndAdditionalProperties = {
+    foo?: string;
+    [key: string]: string | undefined;
+};
+
 /**
  * This is a string reference
  */

packages/openapi-ts/test/__snapshots__/test/generated/v3/schemas.ts.snap

@@ -244,6 +244,18 @@ export const $DictionaryWithString = {
     },
 } as const;
 
+export const $DictionaryWithPropertiesAndAdditionalProperties = {
+    type: 'object',
+    properties: {
+        foo: {
+            type: 'string',
+        },
+    },
+    additionalProperties: {
+        type: 'string',
+    },
+} as const;
+
 export const $DictionaryWithReference = {
     description: 'This is a string reference',
     type: 'object',

packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/models.ts.snap

@@ -167,6 +167,11 @@ export type AnyOfArrays = {
  */
 export type DictionaryWithString = Record<string, string>;
 
+export type DictionaryWithPropertiesAndAdditionalProperties = {
+    foo?: string;
+    [key: string]: string | undefined;
+};
+
 /**
  * This is a string reference
  */

packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/schemas.ts.snap

@@ -244,6 +244,18 @@ export const $DictionaryWithString = {
     },
 } as const;
 
+export const $DictionaryWithPropertiesAndAdditionalProperties = {
+    type: 'object',
+    properties: {
+        foo: {
+            type: 'string',
+        },
+    },
+    additionalProperties: {
+        type: 'string',
+    },
+} as const;
+
 export const $DictionaryWithReference = {
     description: 'This is a string reference',
     type: 'object',

packages/openapi-ts/test/__snapshots__/test/generated/v3_client/models.ts.snap

@@ -217,6 +217,11 @@ export type AnyOfArrays = {
  */
 export type DictionaryWithString = Record<string, string>;
 
+export type DictionaryWithPropertiesAndAdditionalProperties = {
+    foo?: string;
+    [key: string]: string | undefined;
+};
+
 /**
  * This is a string reference
  */

packages/openapi-ts/test/__snapshots__/test/generated/v3_date/schemas.ts.snap

@@ -244,6 +244,18 @@ export const $DictionaryWithString = {
     },
 } as const;
 
+export const $DictionaryWithPropertiesAndAdditionalProperties = {
+    type: 'object',
+    properties: {
+        foo: {
+            type: 'string',
+        },
+    },
+    additionalProperties: {
+        type: 'string',
+    },
+} as const;
+
 export const $DictionaryWithReference = {
     description: 'This is a string reference',
     type: 'object',

packages/openapi-ts/test/__snapshots__/test/generated/v3_enums_typescript/models.ts.snap

@@ -203,6 +203,11 @@ export type AnyOfArrays = {
  */
 export type DictionaryWithString = Record<string, string>;
 
+export type DictionaryWithPropertiesAndAdditionalProperties = {
+    foo?: string;
+    [key: string]: string | undefined;
+};
+
 /**
  * This is a string reference
  */

packages/openapi-ts/test/__snapshots__/test/generated/v3_enums_typescript/schemas.ts.snap

@@ -244,6 +244,18 @@ export const $DictionaryWithString = {
     },
 } as const;
 
+export const $DictionaryWithPropertiesAndAdditionalProperties = {
+    type: 'object',
+    properties: {
+        foo: {
+            type: 'string',
+        },
+    },
+    additionalProperties: {
+        type: 'string',
+    },
+} as const;
+
 export const $DictionaryWithReference = {
     description: 'This is a string reference',
     type: 'object',

packages/openapi-ts/test/__snapshots__/test/generated/v3_experimental/models.ts.snap

@@ -167,6 +167,11 @@ export type AnyOfArrays = {
  */
 export type DictionaryWithString = Record<string, string>;
 
+export type DictionaryWithPropertiesAndAdditionalProperties = {
+    foo?: string;
+    [key: string]: string | undefined;
+};
+
 /**
  * This is a string reference
  */

packages/openapi-ts/test/__snapshots__/test/generated/v3_experimental/schemas.ts.snap

@@ -244,6 +244,18 @@ export const $DictionaryWithString = {
     },
 } as const;
 
+export const $DictionaryWithPropertiesAndAdditionalProperties = {
+    type: 'object',
+    properties: {
+        foo: {
+            type: 'string',
+        },
+    },
+    additionalProperties: {
+        type: 'string',
+    },
+} as const;
+
 export const $DictionaryWithReference = {
     description: 'This is a string reference',
     type: 'object',

packages/openapi-ts/test/__snapshots__/test/generated/v3_models/models.ts.snap

@@ -167,6 +167,11 @@ export type AnyOfArrays = {
  */
 export type DictionaryWithString = Record<string, string>;
 
+export type DictionaryWithPropertiesAndAdditionalProperties = {
+    foo?: string;
+    [key: string]: string | undefined;
+};
+
 /**
  * This is a string reference
  */

packages/openapi-ts/test/spec/v3.json

@@ -1976,6 +1976,17 @@
                     "type": "string"
                 }
             },
+            "DictionaryWithPropertiesAndAdditionalProperties": {
+                "type": "object",
+                "properties": {
+                    "foo": {
+                        "type": "string"
+                    }
+                },
+                "additionalProperties": {
+                    "type": "string"
+                }
+            },
             "DictionaryWithReference": {
                 "description": "This is a string reference",
                 "type": "object",