feat: allow defining min and max ranges for mocked numbers and strings (#2150)

* feat: allow defining min and max ranges for mocked numbers and strings

* Add same defaults also for bigInts

* Fix tests since int64 format should only work with integer type

Author: SampsaKaskela

docs/src/pages/reference/configuration/output.md

@@ -1666,6 +1666,86 @@ module.exports = {
 };
 ```
 
+##### stringMin
+
+Type: `Number`.
+
+Set the default minimum length of generated strings. Used if `minLength` is not defined for the property. (Default is `10`)
+
+```js
+module.exports = {
+  petstore: {
+    output: {
+      override: {
+        mock: {
+          stringMin: 5,
+        },
+      },
+    },
+  },
+};
+```
+
+##### stringMax
+
+Type: `Number`.
+
+Set the default maximum length of generated strings. Used if `maxLength` is not defined for the property. (Default is `20`)
+
+```js
+module.exports = {
+  petstore: {
+    output: {
+      override: {
+        mock: {
+          stringMax: 15,
+        },
+      },
+    },
+  },
+};
+```
+
+##### numberMin
+
+Type: `Number`.
+
+Set the default minimum value of generated numbers. Used if `minimum` is not defined for the property.
+
+```js
+module.exports = {
+  petstore: {
+    output: {
+      override: {
+        mock: {
+          numberMin: 5,
+        },
+      },
+    },
+  },
+};
+```
+
+##### numberMax
+
+Type: `Number`.
+
+Set the default maximum value of generated numbers. Used if `maximum` is not defined for the property.
+
+```js
+module.exports = {
+  petstore: {
+    output: {
+      override: {
+        mock: {
+          numberMax: 15,
+        },
+      },
+    },
+  },
+};
+```
+
 ##### fractionDigits
 
 Type: `Number`.

packages/core/src/types.ts

@@ -326,6 +326,10 @@ export type GlobalMockOptions = {
 export type OverrideMockOptions = Partial<GlobalMockOptions> & {
   arrayMin?: number;
   arrayMax?: number;
+  stringMin?: number;
+  stringMax?: number;
+  numberMin?: number;
+  numberMax?: number;
   required?: boolean;
   properties?: MockProperties;
   format?: Record<string, unknown>;

packages/mock/src/faker/getters/scalar.test.ts

@@ -1,10 +1,12 @@
 import { describe, it, expect } from 'vitest';
 import { getMockScalar } from './scalar';
 import type { ContextSpecs } from '@orval/core';
+import type { SchemaObjectType } from 'openapi3-ts/oas30';
 
 describe('getMockScalar (int64 format handling)', () => {
   const baseArg = {
     item: {
+      type: 'integer' as SchemaObjectType,
       format: 'int64',
       minimum: 1,
       maximum: 100,

packages/mock/src/faker/getters/scalar.ts

@@ -119,19 +119,6 @@ export const getMockScalar = ({
     };
   }
 
-  if (item.format && item.format === 'int64') {
-    const value = context.output.override.useBigInt
-      ? `faker.number.bigInt({min: ${item.minimum}, max: ${item.maximum}})`
-      : `faker.number.int({min: ${item.minimum}, max: ${item.maximum}})`;
-
-    return {
-      value: getNullable(value, item.nullable),
-      imports: [],
-      name: item.name,
-      overrided: false,
-    };
-  }
-
   const type = getItemType(item);
   const isFakerV9 =
     !!context.output.packageJson &&
@@ -140,13 +127,17 @@ export const getMockScalar = ({
   switch (type) {
     case 'number':
     case 'integer': {
+      const intFunction =
+        item.format === 'int64' && context.output.override.useBigInt
+          ? 'bigInt'
+          : 'int';
       let value = getNullable(
-        `faker.number.int({min: ${item.minimum}, max: ${item.maximum}${isFakerV9 ? `, multipleOf: ${item.multipleOf}` : ''}})`,
+        `faker.number.${intFunction}({min: ${item.minimum ?? mockOptions?.numberMin}, max: ${item.maximum ?? mockOptions?.numberMax}${isFakerV9 ? `, multipleOf: ${item.multipleOf}` : ''}})`,
         item.nullable,
       );
       if (type === 'number') {
         value = getNullable(
-          `faker.number.float({min: ${item.minimum}, max: ${item.maximum ?? 999999999}, ${item.multipleOf ? `multipleOf: ${item.multipleOf}` : `fractionDigits: ${mockOptions?.fractionDigits}`}})`,
+          `faker.number.float({min: ${item.minimum ?? mockOptions?.numberMin}, max: ${item.maximum ?? mockOptions?.numberMax}, ${item.multipleOf ? `multipleOf: ${item.multipleOf}` : `fractionDigits: ${mockOptions?.fractionDigits}`}})`,
           item.nullable,
         );
       }
@@ -244,10 +235,7 @@ export const getMockScalar = ({
     }
 
     case 'string': {
-      const length =
-        item.minLength !== undefined || item.maxLength !== undefined
-          ? `{length: {min: ${item.minLength ?? 0}, max: ${item.maxLength ?? (item.minLength ?? 0) + 20}}}`
-          : 20;
+      const length = `{length: {min: ${item.minLength ?? mockOptions?.stringMin}, max: ${item.maxLength ?? mockOptions?.stringMax}}}`;
       let value = `faker.string.alpha(${length})`;
       const stringImports: GeneratorImport[] = [];
 

packages/mock/src/msw/mocks.ts

@@ -34,6 +34,10 @@ const getMockWithoutFunc = (
 ): MockOptions => ({
   arrayMin: override?.mock?.arrayMin,
   arrayMax: override?.mock?.arrayMax,
+  stringMin: override?.mock?.stringMin,
+  stringMax: override?.mock?.stringMax,
+  numberMin: override?.mock?.numberMin,
+  numberMax: override?.mock?.numberMax,
   required: override?.mock?.required,
   fractionDigits: override?.mock?.fractionDigits,
   ...(override?.mock?.properties

packages/orval/src/utils/options.ts

@@ -207,6 +207,8 @@ export const normalizeOptions = async (
         mock: {
           arrayMin: outputOptions.override?.mock?.arrayMin ?? 1,
           arrayMax: outputOptions.override?.mock?.arrayMax ?? 10,
+          stringMin: outputOptions.override?.mock?.stringMin ?? 10,
+          stringMax: outputOptions.override?.mock?.stringMax ?? 20,
           fractionDigits: outputOptions.override?.mock?.fractionDigits ?? 2,
           ...outputOptions.override?.mock,
         },

samples/angular-app/src/api/endpoints/pets/pets.msw.ts

@@ -15,7 +15,11 @@ export const getListPetsResponseMock = (): Pets =>
     { length: faker.number.int({ min: 1, max: 10 }) },
     (_, i) => i + 1,
   ).map(() => ({
-    id: faker.number.int({ min: undefined, max: undefined }),
+    id: faker.number.int({
+      min: undefined,
+      max: undefined,
+      multipleOf: undefined,
+    }),
     name: (() => faker.person.lastName())(),
     tag: (() => faker.person.lastName())(),
   }));

samples/basic/api/endpoints/petstoreFromFileSpecWithTransformer.ts

@@ -81,7 +81,11 @@ export const getListPetsResponseMock = (): PetsArray =>
     { length: faker.number.int({ min: 1, max: 20 }) },
     (_, i) => i + 1,
   ).map(() => ({
-    id: faker.number.int({ min: undefined, max: undefined }),
+    id: faker.number.int({
+      min: undefined,
+      max: undefined,
+      multipleOf: undefined,
+    }),
     name: 'jon',
     age: faker.helpers.arrayElement([
       faker.number.int({ min: 0, max: 30, multipleOf: undefined }),
@@ -110,7 +114,11 @@ export const getListPetsNestedArrayResponseMock = (
       { length: faker.number.int({ min: 1, max: 10 }) },
       (_, i) => i + 1,
     ).map(() => ({
-      id: faker.number.int({ min: undefined, max: undefined }),
+      id: faker.number.int({
+        min: undefined,
+        max: undefined,
+        multipleOf: undefined,
+      }),
       name: 'jon',
       age: faker.helpers.arrayElement([
         faker.number.int({ min: 0, max: 30, multipleOf: undefined }),

samples/hono/hono-with-fetch-client/next-app/app/gen/pets/pets.msw.ts

@@ -16,34 +16,34 @@ export const getListPetsResponseMock = (): Pets =>
     (_, i) => i + 1,
   ).map(() => ({
     id: faker.number.int({ min: undefined, max: undefined }),
-    name: faker.string.alpha(20),
-    tag: faker.string.alpha(20),
+    name: faker.string.alpha({ length: { min: 10, max: 20 } }),
+    tag: faker.string.alpha({ length: { min: 10, max: 20 } }),
   }));
 
 export const getCreatePetsResponseMock = (
   overrideResponse: Partial<Pet> = {},
 ): Pet => ({
   id: faker.number.int({ min: undefined, max: undefined }),
-  name: faker.string.alpha(20),
-  tag: faker.string.alpha(20),
+  name: faker.string.alpha({ length: { min: 10, max: 20 } }),
+  tag: faker.string.alpha({ length: { min: 10, max: 20 } }),
   ...overrideResponse,
 });
 
 export const getUpdatePetsResponseMock = (
   overrideResponse: Partial<Pet> = {},
 ): Pet => ({
   id: faker.number.int({ min: undefined, max: undefined }),
-  name: faker.string.alpha(20),
-  tag: faker.string.alpha(20),
+  name: faker.string.alpha({ length: { min: 10, max: 20 } }),
+  tag: faker.string.alpha({ length: { min: 10, max: 20 } }),
   ...overrideResponse,
 });
 
 export const getShowPetByIdResponseMock = (
   overrideResponse: Partial<Pet> = {},
 ): Pet => ({
   id: faker.number.int({ min: undefined, max: undefined }),
-  name: faker.string.alpha(20),
-  tag: faker.string.alpha(20),
+  name: faker.string.alpha({ length: { min: 10, max: 20 } }),
+  tag: faker.string.alpha({ length: { min: 10, max: 20 } }),
   ...overrideResponse,
 });
 

samples/next-app-with-fetch/app/gen/pets/pets.msw.ts

@@ -69,10 +69,16 @@ export const getListPetsResponseMock = (): Pets =>
       { ...getListPetsResponseDogMock() },
       { ...getListPetsResponseCatMock() },
     ]),
-    '@id': faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
+    '@id': faker.helpers.arrayElement([
+      faker.string.alpha({ length: { min: 10, max: 20 } }),
+      undefined,
+    ]),
     id: faker.number.int({ min: undefined, max: undefined }),
-    name: faker.string.alpha(20),
-    tag: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
+    name: faker.string.alpha({ length: { min: 10, max: 20 } }),
+    tag: faker.helpers.arrayElement([
+      faker.string.alpha({ length: { min: 10, max: 20 } }),
+      undefined,
+    ]),
     email: faker.helpers.arrayElement([faker.internet.email(), undefined]),
     callingCode: faker.helpers.arrayElement([
       faker.helpers.arrayElement(['+33', '+420', '+33'] as const),
@@ -142,10 +148,16 @@ export const getCreatePetsResponseMock = (): Pet => ({
     { ...getCreatePetsResponseDogMock() },
     { ...getCreatePetsResponseCatMock() },
   ]),
-  '@id': faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
+  '@id': faker.helpers.arrayElement([
+    faker.string.alpha({ length: { min: 10, max: 20 } }),
+    undefined,
+  ]),
   id: faker.number.int({ min: undefined, max: undefined }),
-  name: faker.string.alpha(20),
-  tag: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
+  name: faker.string.alpha({ length: { min: 10, max: 20 } }),
+  tag: faker.helpers.arrayElement([
+    faker.string.alpha({ length: { min: 10, max: 20 } }),
+    undefined,
+  ]),
   email: faker.helpers.arrayElement([faker.internet.email(), undefined]),
   callingCode: faker.helpers.arrayElement([
     faker.helpers.arrayElement(['+33', '+420', '+33'] as const),
@@ -215,10 +227,16 @@ export const getUpdatePetsResponseMock = (): Pet => ({
     { ...getUpdatePetsResponseDogMock() },
     { ...getUpdatePetsResponseCatMock() },
   ]),
-  '@id': faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
+  '@id': faker.helpers.arrayElement([
+    faker.string.alpha({ length: { min: 10, max: 20 } }),
+    undefined,
+  ]),
   id: faker.number.int({ min: undefined, max: undefined }),
-  name: faker.string.alpha(20),
-  tag: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
+  name: faker.string.alpha({ length: { min: 10, max: 20 } }),
+  tag: faker.helpers.arrayElement([
+    faker.string.alpha({ length: { min: 10, max: 20 } }),
+    undefined,
+  ]),
   email: faker.helpers.arrayElement([faker.internet.email(), undefined]),
   callingCode: faker.helpers.arrayElement([
     faker.helpers.arrayElement(['+33', '+420', '+33'] as const),
@@ -288,10 +306,16 @@ export const getShowPetByIdResponseMock = (): Pet => ({
     { ...getShowPetByIdResponseDogMock() },
     { ...getShowPetByIdResponseCatMock() },
   ]),
-  '@id': faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
+  '@id': faker.helpers.arrayElement([
+    faker.string.alpha({ length: { min: 10, max: 20 } }),
+    undefined,
+  ]),
   id: faker.number.int({ min: undefined, max: undefined }),
-  name: faker.string.alpha(20),
-  tag: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
+  name: faker.string.alpha({ length: { min: 10, max: 20 } }),
+  tag: faker.helpers.arrayElement([
+    faker.string.alpha({ length: { min: 10, max: 20 } }),
+    undefined,
+  ]),
   email: faker.helpers.arrayElement([faker.internet.email(), undefined]),
   callingCode: faker.helpers.arrayElement([
     faker.helpers.arrayElement(['+33', '+420', '+33'] as const),