orval/core - factory method generated

Author: mironbalcerzak

packages/core/src/generators/imports.ts

@@ -47,7 +47,7 @@ export const generateImports = ({
         } } from \'./${upath.join(path, camel(name))}\';`;
       }
 
-      return `import ${!values ? 'type ' : ''}{ ${name}${
+      return `import { create${name}, ${name}${
         alias ? ` as ${alias}` : ''
       } } from \'./${camel(name)}\';`;
     })

packages/core/src/generators/interface.ts

@@ -53,6 +53,7 @@ export const generateInterface = ({
   } else {
     model += `export type ${name} = ${scalar.value};\n`;
   }
+  model += `export function create${name}(): ${name} ${scalar.factoryMethodValue}\n`;
 
   // Filter out imports that refer to the type defined in current file (OpenAPI recursive schema definitions)
   const externalModulesImportsOnly = scalar.imports.filter(

packages/core/src/getters/array.ts

@@ -44,6 +44,7 @@ export const getArray = ({
     }
     return {
       type: 'array',
+      factoryMethodValue: `[]`,
       isEnum: false,
       isRef: false,
       value: `[${resolvedObjects.map((o) => o.value).join(', ')}]`,
@@ -66,6 +67,7 @@ export const getArray = ({
           ? `(${resolvedObject.value})[]`
           : `${resolvedObject.value}[]`
       }`,
+      factoryMethodValue: `[]`,
       imports: resolvedObject.imports,
       schemas: resolvedObject.schemas,
       isEnum: false,

packages/core/src/getters/combine.ts

@@ -179,6 +179,7 @@ export const combineSchemas = ({
       value:
         `typeof ${pascal(name)}[keyof typeof ${pascal(name)}] ${nullable};` +
         newEnum,
+      factoryMethodValue: `{}`,
       imports: resolvedData.imports.map<GeneratorImport>((toImport) => ({
         ...toImport,
         values: true,
@@ -195,6 +196,7 @@ export const combineSchemas = ({
 
   return {
     value: value + nullable,
+    factoryMethodValue: `{}`,
     imports: resolvedValue
       ? [...resolvedData.imports, ...resolvedValue.imports]
       : resolvedData.imports,

packages/core/src/getters/object.ts

@@ -30,6 +30,7 @@ export const getObject = ({
     const { name, specKey } = getRefInfo(item.$ref, context);
     return {
       value: name + nullable,
+      factoryMethodValue: `''`,
       imports: [{ name, specKey }],
       schemas: [],
       isEnum: false,
@@ -114,12 +115,14 @@ export const getObject = ({
           const isReadOnly = item.readOnly || (schema as SchemaObject).readOnly;
           if (!index) {
             acc.value += '{';
+            acc.factoryMethodValue += '{\n  return {';
           }
 
           const doc = jsDoc(schema as SchemaObject, true);
 
           acc.hasReadonlyProps ||= isReadOnly || false;
           acc.imports.push(...resolvedValue.imports);
+          acc.factoryMethodValue += `\n    ${getKey(key)}: ${resolvedValue.factoryMethodValue},`;
           acc.value += `\n  ${doc ? `${doc}  ` : ''}${
             isReadOnly ? 'readonly ' : ''
           }${getKey(key)}${isRequired ? '' : '?'}: ${resolvedValue.value};`;
@@ -139,6 +142,7 @@ export const getObject = ({
               }
             } else {
               acc.value += '\n}';
+              acc.factoryMethodValue += '\n  };\n}';
             }
 
             acc.value += nullable;
@@ -150,6 +154,7 @@ export const getObject = ({
           imports: [],
           schemas: [],
           value: '',
+          factoryMethodValue: '',
           isEnum: false,
           type: 'object' as SchemaType,
           isRef: false,
@@ -165,6 +170,7 @@ export const getObject = ({
     if (isBoolean(item.additionalProperties)) {
       return {
         value: `{ [key: string]: any }` + nullable,
+        factoryMethodValue: `{}`,
         imports: [],
         schemas: [],
         isEnum: false,
@@ -180,6 +186,7 @@ export const getObject = ({
     });
     return {
       value: `{[key: string]: ${resolvedValue.value}}` + nullable,
+      factoryMethodValue: `{}`,
       imports: resolvedValue.imports ?? [],
       schemas: resolvedValue.schemas ?? [],
       isEnum: false,
@@ -193,6 +200,7 @@ export const getObject = ({
   if (itemWithConst.const) {
     return {
       value: `'${itemWithConst.const}'` + nullable,
+      factoryMethodValue: `null`,
       imports: [],
       schemas: [],
       isEnum: false,
@@ -206,6 +214,7 @@ export const getObject = ({
     value:
       (item.type === 'object' ? '{ [key: string]: any }' : 'unknown') +
       nullable,
+    factoryMethodValue: `${item.type === 'object' ? '{}' : 'null'}`,
     imports: [],
     schemas: [],
     isEnum: false,

packages/core/src/getters/res-req-types.ts

@@ -72,6 +72,7 @@ export const getResReqTypes = (
           return [
             {
               value: name,
+              factoryMethodValue: name,
               imports: [{ name, specKey, schemaName }],
               schemas: [],
               type: 'unknown',
@@ -115,6 +116,7 @@ export const getResReqTypes = (
         return [
           {
             value: name,
+            factoryMethodValue: name,
             imports: [{ name, specKey, schemaName }],
             schemas: [],
             type: 'unknown',
@@ -202,6 +204,7 @@ export const getResReqTypes = (
       return [
         {
           value: defaultType,
+          factoryMethodValue: `''`,
           imports: [],
           schemas: [],
           type: defaultType,

packages/core/src/getters/scalar.ts

@@ -48,6 +48,7 @@ export const getScalar = ({
 
       return {
         value: value + nullable,
+        factoryMethodValue: `0`,
         isEnum,
         type: 'number',
         schemas: [],
@@ -62,6 +63,7 @@ export const getScalar = ({
     case 'boolean':
       return {
         value: 'boolean' + nullable,
+        factoryMethodValue: `false`,
         type: 'boolean',
         isEnum: false,
         schemas: [],
@@ -111,6 +113,7 @@ export const getScalar = ({
 
       return {
         value: value + nullable,
+        factoryMethodValue: `''`,
         isEnum,
         type: 'string',
         imports: [],
@@ -125,6 +128,7 @@ export const getScalar = ({
     case 'null':
       return {
         value: 'null',
+        factoryMethodValue: `null`,
         isEnum: false,
         type: 'null',
         imports: [],
@@ -145,6 +149,7 @@ export const getScalar = ({
 
         return {
           value: value + nullable,
+          factoryMethodValue: enumItems[0],
           isEnum: true,
           type: 'string',
           imports: [],

packages/core/src/resolvers/object.ts

@@ -30,6 +30,7 @@ const resolveObjectOriginal = ({
   ) {
     return {
       value: propName,
+      factoryMethodValue: `{}`,
       imports: [{ name: propName }],
       schemas: [
         ...resolvedValue.schemas,
@@ -57,6 +58,7 @@ const resolveObjectOriginal = ({
 
     return {
       value: propName,
+      factoryMethodValue: `${propName}[${resolvedValue.value.split(' | ')[0]}]`,
       imports: [{ name: propName }],
       schemas: [
         ...resolvedValue.schemas,

packages/core/src/resolvers/value.ts

@@ -44,6 +44,7 @@ export const resolveValue = ({
 
     return {
       value: resolvedImport.name,
+      factoryMethodValue: `create${resolvedImport.name}()`,
       imports: [
         {
           name: resolvedImport.name,

packages/core/src/types.ts

@@ -879,6 +879,7 @@ export const SchemaType = {
 
 export type ScalarValue = {
   value: string;
+  factoryMethodValue: string;
   isEnum: boolean;
   hasReadonlyProps: boolean;
   type: SchemaType;