Merge pull request #197 from hey-api/feat/additional-schema-properties

feat(schema): additional schema properties
hey-api · Apr 2, 2024 · ca2847f · ca2847f
2 parents 7a19cf3 + 80967f8
commit ca2847f
Show file tree

Hide file tree

Showing 24 changed files with 179 additions and 84 deletions.
diff --git a/.changeset/fresh-timers-train.md b/.changeset/fresh-timers-train.md
@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": minor
+---
+
+feat(schema): add support for default values
diff --git a/.changeset/swift-candles-melt.md b/.changeset/swift-candles-melt.md
@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": minor
+---
+
+feat(schema): add array of enum values for enums
diff --git a/src/openApi/common/interfaces/client.ts b/src/openApi/common/interfaces/client.ts
@@ -56,6 +56,7 @@ export interface Operation extends OperationParameters {
 }
 
 export interface Schema {
+    default?: unknown;
     exclusiveMaximum?: boolean;
     exclusiveMinimum?: boolean;
     format?:
@@ -95,7 +96,6 @@ export interface Model extends Schema {
      */
     $refs: string[];
     base: string;
-    default?: string;
     deprecated?: boolean;
     description: string | null;
     enum: Enum[];

diff --git a/src/openApi/v3/parser/getModelDefault.ts → src/openApi/common/parser/getDefault.ts b/src/openApi/v3/parser/getModelDefault.ts → src/openApi/common/parser/getDefault.ts
@@ -1,7 +1,12 @@
 import type { Model } from '../../common/interfaces/client';
-import type { OpenApiSchema } from '../interfaces/OpenApiSchema';
-
-export const getModelDefault = (definition: OpenApiSchema, model?: Model): string | undefined => {
+import type { OpenApiParameter } from '../../v2/interfaces/OpenApiParameter';
+import type { OpenApiSchema } from '../../v3/interfaces/OpenApiSchema';
+import type { OperationParameter } from '../interfaces/client';
+
+export const getDefault = (
+    definition: OpenApiSchema | OpenApiParameter,
+    model?: Model | OperationParameter
+): string | undefined => {
     if (definition.default === undefined) {
         return undefined;
     }
@@ -16,25 +21,21 @@ export const getModelDefault = (definition: OpenApiSchema, model?: Model): strin
         case 'int':
         case 'integer':
         case 'number':
-            if (model?.export === 'enum' && model.enum?.[definition.default]) {
-                const { value } = model.enum[definition.default];
+            if (model?.export === 'enum' && model.enum?.[definition.default as number]) {
+                const { value } = model.enum[definition.default as number];
                 return typeof value === 'string' ? `'${value}'` : String(value);
             }
             return String(definition.default);
-
-        case 'boolean':
-            return JSON.stringify(definition.default);
-
         case 'string':
             return `'${definition.default}'`;
-
+        case 'array':
+        case 'boolean':
         case 'object':
             try {
                 return JSON.stringify(definition.default, null, 4);
             } catch (e) {
                 // Ignore
             }
     }
-
     return undefined;
 };
diff --git a/src/openApi/common/parser/sort.ts b/src/openApi/common/parser/sort.ts
@@ -2,7 +2,7 @@
  * Sort list of values and ensure that required parameters are first so that we do not generate
  * invalid types. Optional parameters cannot be positioned after required ones.
  */
-export function toSortedByRequired<T extends { isRequired: boolean; default?: string }>(values: T[]): T[] {
+export function toSortedByRequired<T extends { isRequired: boolean; default?: unknown }>(values: T[]): T[] {
     return values.sort((a, b) => {
         const aNeedsValue = a.isRequired && a.default === undefined;
         const bNeedsValue = b.isRequired && b.default === undefined;

diff --git a/src/openApi/v2/interfaces/OpenApiParameter.ts b/src/openApi/v2/interfaces/OpenApiParameter.ts
@@ -29,7 +29,7 @@ export interface OpenApiParameter extends OpenApiReference, WithEnumExtension, W
     allowEmptyValue?: boolean;
     items?: OpenApiItems;
     collectionFormat?: 'csv' | 'ssv' | 'tsv' | 'pipes' | 'multi';
-    default?: number;
+    default?: unknown;
     maximum?: number;
     exclusiveMaximum?: boolean;
     minimum?: number;

diff --git a/src/openApi/v2/parser/getOperationParameter.ts b/src/openApi/v2/parser/getOperationParameter.ts
@@ -1,4 +1,5 @@
 import type { OperationParameter } from '../../common/interfaces/client';
+import { getDefault } from '../../common/parser/getDefault';
 import { getEnums } from '../../common/parser/getEnums';
 import { getPattern } from '../../common/parser/getPattern';
 import { getRef } from '../../common/parser/getRef';
@@ -8,7 +9,6 @@ import type { OpenApi } from '../interfaces/OpenApi';
 import type { OpenApiParameter } from '../interfaces/OpenApiParameter';
 import type { OpenApiSchema } from '../interfaces/OpenApiSchema';
 import { getModel } from './getModel';
-import { getOperationParameterDefault } from './getOperationParameterDefault';
 
 export const getOperationParameter = (openApi: OpenApi, parameter: OpenApiParameter): OperationParameter => {
     const operationParameter: OperationParameter = {
@@ -52,7 +52,7 @@ export const getOperationParameter = (openApi: OpenApi, parameter: OpenApiParame
         operationParameter.base = definitionRef.base;
         operationParameter.template = definitionRef.template;
         operationParameter.imports.push(...definitionRef.imports);
-        operationParameter.default = getOperationParameterDefault(parameter, operationParameter);
+        operationParameter.default = getDefault(parameter, operationParameter);
         return operationParameter;
     }
 
@@ -63,7 +63,7 @@ export const getOperationParameter = (openApi: OpenApi, parameter: OpenApiParame
             operationParameter.enum.push(...enums);
             operationParameter.export = 'enum';
             operationParameter.type = 'string';
-            operationParameter.default = getOperationParameterDefault(parameter, operationParameter);
+            operationParameter.default = getDefault(parameter, operationParameter);
             return operationParameter;
         }
     }
@@ -75,7 +75,7 @@ export const getOperationParameter = (openApi: OpenApi, parameter: OpenApiParame
         operationParameter.base = items.base;
         operationParameter.template = items.template;
         operationParameter.imports.push(...items.imports);
-        operationParameter.default = getOperationParameterDefault(parameter, operationParameter);
+        operationParameter.default = getDefault(parameter, operationParameter);
         return operationParameter;
     }
 
@@ -86,7 +86,7 @@ export const getOperationParameter = (openApi: OpenApi, parameter: OpenApiParame
         operationParameter.base = items.base;
         operationParameter.template = items.template;
         operationParameter.imports.push(...items.imports);
-        operationParameter.default = getOperationParameterDefault(parameter, operationParameter);
+        operationParameter.default = getDefault(parameter, operationParameter);
         return operationParameter;
     }
 
@@ -102,7 +102,7 @@ export const getOperationParameter = (openApi: OpenApi, parameter: OpenApiParame
             operationParameter.base = model.base;
             operationParameter.template = model.template;
             operationParameter.imports.push(...model.imports);
-            operationParameter.default = getOperationParameterDefault(parameter, operationParameter);
+            operationParameter.default = getDefault(parameter, operationParameter);
             return operationParameter;
         } else {
             const model = getModel(openApi, schema);
@@ -115,7 +115,7 @@ export const getOperationParameter = (openApi: OpenApi, parameter: OpenApiParame
             operationParameter.enum.push(...model.enum);
             operationParameter.enums.push(...model.enums);
             operationParameter.properties.push(...model.properties);
-            operationParameter.default = getOperationParameterDefault(parameter, operationParameter);
+            operationParameter.default = getDefault(parameter, operationParameter);
             return operationParameter;
         }
     }
@@ -128,7 +128,7 @@ export const getOperationParameter = (openApi: OpenApi, parameter: OpenApiParame
         operationParameter.base = definitionType.base;
         operationParameter.template = definitionType.template;
         operationParameter.imports.push(...definitionType.imports);
-        operationParameter.default = getOperationParameterDefault(parameter, operationParameter);
+        operationParameter.default = getDefault(parameter, operationParameter);
         return operationParameter;
     }
 

diff --git a/src/openApi/v2/parser/getOperationParameterDefault.ts b/src/openApi/v2/parser/getOperationParameterDefault.ts
diff --git a/src/openApi/v3/interfaces/OpenApiSchema.ts b/src/openApi/v3/interfaces/OpenApiSchema.ts
@@ -13,7 +13,7 @@ export interface OpenApiSchema extends OpenApiReference, WithEnumExtension {
     allOf?: OpenApiSchema[];
     anyOf?: OpenApiSchema[];
     const?: string | number | boolean | null;
-    default?: number;
+    default?: unknown;
     deprecated?: boolean;
     description?: string;
     discriminator?: OpenApiDiscriminator;

diff --git a/src/openApi/v3/parser/getModel.ts b/src/openApi/v3/parser/getModel.ts
@@ -1,11 +1,11 @@
 import type { Model } from '../../common/interfaces/client';
+import { getDefault } from '../../common/parser/getDefault';
 import { getEnums } from '../../common/parser/getEnums';
 import { getPattern } from '../../common/parser/getPattern';
 import { getType } from '../../common/parser/type';
 import type { OpenApi } from '../interfaces/OpenApi';
 import type { OpenApiSchema } from '../interfaces/OpenApiSchema';
 import { findModelComposition, getModelComposition } from './getModelComposition';
-import { getModelDefault } from './getModelDefault';
 import { getAdditionalPropertiesModel, getModelProperties } from './getModelProperties';
 import { inferType } from './inferType';
 
@@ -59,7 +59,7 @@ export const getModel = (
         model.imports = [...model.imports, ...definitionRef.imports];
         model.template = definitionRef.template;
         model.type = definitionRef.type;
-        model.default = getModelDefault(definition, model);
+        model.default = getDefault(definition, model);
         return model;
     }
 
@@ -70,7 +70,7 @@ export const getModel = (
             model.enum = [...model.enum, ...enums];
             model.export = 'enum';
             model.type = 'string';
-            model.default = getModelDefault(definition, model);
+            model.default = getDefault(definition, model);
             return model;
         }
     }
@@ -84,7 +84,7 @@ export const getModel = (
             model.imports = [...model.imports, ...arrayItems.imports];
             model.template = arrayItems.template;
             model.type = arrayItems.type;
-            model.default = getModelDefault(definition, model);
+            model.default = getDefault(definition, model);
             return model;
         }
 
@@ -112,7 +112,7 @@ export const getModel = (
         model.link = arrayItems;
         model.template = arrayItems.template;
         model.type = arrayItems.type;
-        model.default = getModelDefault(definition, model);
+        model.default = getDefault(definition, model);
         return model;
     }
 
@@ -133,7 +133,7 @@ export const getModel = (
             model.base = 'any';
             model.export = 'interface';
             model.type = 'any';
-            model.default = getModelDefault(definition, model);
+            model.default = getDefault(definition, model);
 
             const modelProperties = getModelProperties(openApi, definition, getModel, model);
             modelProperties.forEach(modelProperty => {
@@ -176,7 +176,7 @@ export const getModel = (
         model.isNullable = definitionType.isNullable || model.isNullable;
         model.template = definitionType.template;
         model.type = definitionType.type;
-        model.default = getModelDefault(definition, model);
+        model.default = getDefault(definition, model);
         return model;
     }
 

diff --git a/src/openApi/v3/parser/getModelProperties.ts b/src/openApi/v3/parser/getModelProperties.ts
@@ -1,12 +1,12 @@
 import { escapeName } from '../../../utils/escapeName';
 import type { Model } from '../../common/interfaces/client';
+import { getDefault } from '../../common/parser/getDefault';
 import { getPattern } from '../../common/parser/getPattern';
 import { getType } from '../../common/parser/type';
 import type { OpenApi } from '../interfaces/OpenApi';
 import type { OpenApiSchema } from '../interfaces/OpenApiSchema';
 import { findOneOfParentDiscriminator, mapPropertyValue } from './discriminator';
 import type { getModel } from './getModel';
-import { getModelDefault } from './getModelDefault';
 
 // Fix for circular dependency
 export type GetModelFn = typeof getModel;
@@ -21,7 +21,7 @@ export const getAdditionalPropertiesModel = (
     const apModel = getModel(openApi, ap);
 
     if (definition.additionalProperties === true && definition.properties) {
-        apModel.default = getModelDefault(definition, model);
+        apModel.default = getDefault(definition, model);
         apModel.export = 'generic';
         apModel.isRequired = true;
         apModel.name = '[key: string]';
@@ -31,7 +31,7 @@ export const getAdditionalPropertiesModel = (
     if (ap.$ref) {
         const apType = getType(ap.$ref);
         model.base = apType.base;
-        model.default = getModelDefault(definition, model);
+        model.default = getDefault(definition, model);
         model.export = 'dictionary';
         model.imports.push(...apType.imports);
         model.template = apType.template;
@@ -40,7 +40,7 @@ export const getAdditionalPropertiesModel = (
     }
 
     model.base = apModel.base;
-    model.default = getModelDefault(definition, model);
+    model.default = getDefault(definition, model);
     model.export = 'dictionary';
     model.imports.push(...apModel.imports);
     model.link = apModel;
@@ -78,6 +78,7 @@ export const getModelProperties = (
             > = {
                 deprecated: property.deprecated === true,
                 description: property.description || null,
+                default: property.default,
                 exclusiveMaximum: property.exclusiveMaximum,
                 exclusiveMinimum: property.exclusiveMinimum,
                 format: property.format,
@@ -138,6 +139,7 @@ export const getModelProperties = (
                     enum: model.enum,
                     enums: model.enums,
                     export: model.export,
+                    default: model.default,
                     imports: model.imports,
                     isNullable: model.isNullable || property.nullable === true,
                     link: model.link,

diff --git a/src/openApi/v3/parser/getOperationParameter.ts b/src/openApi/v3/parser/getOperationParameter.ts
@@ -1,4 +1,5 @@
 import type { OperationParameter } from '../../common/interfaces/client';
+import { getDefault } from '../../common/parser/getDefault';
 import { getPattern } from '../../common/parser/getPattern';
 import { getRef } from '../../common/parser/getRef';
 import { getOperationParameterName } from '../../common/parser/operation';
@@ -7,7 +8,6 @@ import type { OpenApi } from '../interfaces/OpenApi';
 import type { OpenApiParameter } from '../interfaces/OpenApiParameter';
 import type { OpenApiSchema } from '../interfaces/OpenApiSchema';
 import { getModel } from './getModel';
-import { getModelDefault } from './getModelDefault';
 
 export const getOperationParameter = (openApi: OpenApi, parameter: OpenApiParameter): OperationParameter => {
     const operationParameter: OperationParameter = {
@@ -57,7 +57,7 @@ export const getOperationParameter = (openApi: OpenApi, parameter: OpenApiParame
             operationParameter.template = model.template;
             operationParameter.$refs = [...operationParameter.$refs, ...model.$refs];
             operationParameter.imports = [...operationParameter.imports, ...model.imports];
-            operationParameter.default = getModelDefault(schema);
+            operationParameter.default = getDefault(schema);
             return operationParameter;
         } else {
             const model = getModel(openApi, schema);

diff --git a/src/templates/partials/schemaArray.hbs b/src/templates/partials/schemaArray.hbs
@@ -7,6 +7,9 @@
 		type: '{{{base}}}',
 	},
 {{/if}}
+{{#notEquals default undefined}}
+	default: {{{default}}},
+{{/notEquals}}
 {{#if isReadOnly}}
 	isReadOnly: {{{isReadOnly}}},
 {{/if}}

diff --git a/src/templates/partials/schemaComposition.hbs b/src/templates/partials/schemaComposition.hbs
@@ -4,6 +4,9 @@
 	description: `{{{escapeDescription description}}}`,
 {{/if}}
 	contains: [{{#each properties}}{{>schema}}{{#unless @last}}, {{/unless}}{{/each}}],
+{{#notEquals default undefined}}
+	default: {{{default}}},
+{{/notEquals}}
 {{#if isReadOnly}}
 	isReadOnly: {{{isReadOnly}}},
 {{/if}}

diff --git a/src/templates/partials/schemaDictionary.hbs b/src/templates/partials/schemaDictionary.hbs
@@ -7,6 +7,9 @@
 		type: '{{{base}}}',
 	},
 {{/if}}
+{{#notEquals default undefined}}
+	default: {{{default}}},
+{{/notEquals}}
 {{#if isReadOnly}}
 	isReadOnly: {{{isReadOnly}}},
 {{/if}}