feat: support for const types (#1180)

Author: Eric Butler

packages/core/src/generators/interface.ts

@@ -43,7 +43,7 @@ export const generateInterface = ({
   }
 
   if (
-    !generalJSTypesWithArray.includes(scalar.value) &&
+    scalar.type === 'object' &&
     !context?.output.override?.useTypeOverInterfaces
   ) {
     model += `export interface ${name} ${scalar.value}\n`;

packages/core/src/getters/object.ts

@@ -6,6 +6,10 @@ import { combineSchemas } from './combine';
 import { getKey } from './keys';
 import { getRefInfo } from './ref';
 
+interface SchemaWithConst extends SchemaObject {
+  const: string;
+}
+
 /**
  * Return the output type from an object
  *
@@ -185,6 +189,19 @@ export const getObject = ({
     };
   }
 
+  const itemWithConst = item as SchemaWithConst;
+  if (itemWithConst.const) {
+    return {
+      value: `'${itemWithConst.const}'` + nullable,
+      imports: [],
+      schemas: [],
+      isEnum: false,
+      type: 'string',
+      isRef: false,
+      hasReadonlyProps: item.readOnly || false,
+    };
+  }
+
   return {
     value:
       (item.type === 'object' ? '{ [key: string]: any }' : 'unknown') +

tests/specifications/example-v3-1.yaml

@@ -26,5 +26,12 @@ components:
             type: string
           type: array
           title: Example tuple
+        example_const:
+          const: this_is_a_const
+        example_enum:
+          type: string
+          enum:
+            - enum1
+            - enum2
       title: Test
       type: object