wip - config introduction

Author: mironbalcerzak

packages/core/src/generators/interface.ts

@@ -53,7 +53,12 @@ export const generateInterface = ({
   } else {
     model += `export type ${name} = ${scalar.value};\n`;
   }
-  model += `export function create${name}(): ${name} ${scalar.factoryMethodValue}\n`;
+  if (context?.output.override.modelFactoryMethods?.outputMode == 'inline') {
+    let factoryMethodPrefix = context?.output.override.modelFactoryMethods?.factoryMethodPrefix!;
+    model += `export function ${factoryMethodPrefix}${name}(): ${name} ${scalar.factoryMethodValue}\n`;
+  } else {
+    model += '// export to separate file\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/types.ts

@@ -49,6 +49,7 @@ export type NormalizedOutputOptions = {
   override: NormalizedOverrideOutput;
   client: OutputClient | OutputClientFunc;
   httpClient: OutputHttpClient;
+  modelFactoryMethods?: boolean;
   clean: boolean | string[];
   prettier: boolean;
   tslint: boolean;
@@ -68,6 +69,16 @@ export type NormalizedParamsSerializerOptions = {
   qs?: Record<string, any>;
 };
 
+export const OutputModelFactoryMethodsMode = {
+  INLINE: 'inline',
+  ISOLATED: 'isolated',
+} as const;
+
+export type NormalizedModelFactoryMethodsOptions = {
+  factoryMethodPrefix?: string;
+  outputMode?: (typeof OutputModelFactoryMethodsMode)[keyof typeof OutputModelFactoryMethodsMode];
+};
+
 export type NormalizedOverrideOutput = {
   title?: (title: string) => string;
   transformer?: OutputTransformer;
@@ -81,6 +92,7 @@ export type NormalizedOverrideOutput = {
   formUrlEncoded: boolean | NormalizedMutator;
   paramsSerializer?: NormalizedMutator;
   paramsSerializerOptions?: NormalizedParamsSerializerOptions;
+  modelFactoryMethods?: NormalizedModelFactoryMethodsOptions;
   components: {
     schemas: {
       suffix: string;
@@ -173,6 +185,7 @@ export type OutputOptions = {
   override?: OverrideOutput;
   client?: OutputClient | OutputClientFunc;
   httpClient?: OutputHttpClient;
+  modelFactoryMethods?: boolean;
   clean?: boolean | string[];
   prettier?: boolean;
   tslint?: boolean;
@@ -321,6 +334,11 @@ export type ParamsSerializerOptions = {
   qs?: Record<string, any>;
 };
 
+export type ModelFactoryMethodsOptions = {
+  factoryMethodPrefix?: string;
+  outputMode?: (typeof OutputModelFactoryMethodsMode)[keyof typeof OutputModelFactoryMethodsMode];
+};
+
 export type OverrideOutput = {
   title?: (title: string) => string;
   transformer?: OutputTransformer;
@@ -334,6 +352,7 @@ export type OverrideOutput = {
   formUrlEncoded?: boolean | Mutator;
   paramsSerializer?: Mutator;
   paramsSerializerOptions?: ParamsSerializerOptions;
+  modelFactoryMethods?: ModelFactoryMethodsOptions;
   components?: {
     schemas?: {
       suffix?: string;
@@ -596,6 +615,7 @@ export interface GlobalOptions {
   mock?: boolean | GlobalMockOptions;
   client?: OutputClient;
   httpClient?: OutputHttpClient;
+  modelFactoryMethods?: boolean;
   mode?: OutputMode;
   tsconfig?: string | Tsconfig;
   packageJson?: string;

packages/orval/src/utils/options.ts

@@ -78,7 +78,7 @@ export const normalizeOptions = async (
     workspace,
   );
 
-  const { clean, prettier, client, httpClient, mode, tslint, biome } =
+  const { clean, prettier, client, httpClient, modelFactoryMethods, mode, tslint, biome } =
     globalOptions;
 
   const tsconfig = await loadTsconfig(
@@ -143,6 +143,8 @@ export const normalizeOptions = async (
       fileExtension: outputOptions.fileExtension || defaultFileExtension,
       workspace: outputOptions.workspace ? outputWorkspace : undefined,
       client: outputOptions.client ?? client ?? OutputClient.AXIOS_FUNCTIONS,
+      modelFactoryMethods:
+        outputOptions.modelFactoryMethods ?? modelFactoryMethods ?? false,
       httpClient:
         outputOptions.httpClient ?? httpClient ?? OutputHttpClient.AXIOS,
       mode: normalizeOutputMode(outputOptions.mode ?? mode),
@@ -208,6 +210,14 @@ export const normalizeOptions = async (
               ? outputOptions.override?.header!
               : getDefaultFilesHeader,
         requestOptions: outputOptions.override?.requestOptions ?? true,
+        modelFactoryMethods: {
+          factoryMethodPrefix:
+            outputOptions.override?.modelFactoryMethods?.factoryMethodPrefix
+            ?? 'new',
+          outputMode:
+            outputOptions.override?.modelFactoryMethods?.outputMode
+            ?? 'isolated'
+        },
         components: {
           schemas: {
             suffix: RefComponentSuffix.schemas,