fix(generator): do not use example values if the useExampleValues opt…

…ion is set to false

src/utils/generator.ts

@@ -1,11 +1,13 @@
 import jsf, { JSF, JSFOptions } from 'json-schema-faker';
+import { cloneDeep } from 'lodash';
 
 export { JSONSchema, JSFOptions, JSF } from 'json-schema-faker';
 
 export type JSFCallback = (jsfInstance: JSF) => void;
 
 const defaultOptions = {
   optionalsProbability: 0.5,
+  useExamplesValue: true,
 };
 
 /* eslint-disable @typescript-eslint/no-explicit-any */
@@ -24,19 +26,21 @@ export const createGenerator: (options?: Partial<JSFOptions>, callback?: JSFCall
   options = defaultOptions,
   callback = <JSFCallback>(() => {})
 ) => {
-  jsf.option({
+  const applyedOptions = {
     ...defaultOptions,
     ...options,
-  });
+  };
 
-  jsf.define('example', (value) => {
-    return value;
-  });
+  const generator = cloneDeep(jsf);
+  generator.option(applyedOptions);
 
-  jsf.define('examples', handleExamples);
+  if (applyedOptions.useExamplesValue) {
+    generator.define('example', (value: any) => value);
+    generator.define('examples', handleExamples);
+  }
 
-  callback(jsf);
+  callback(generator);
 
-  return jsf;
+  return generator;
 };
 /* eslint-enable @typescript-eslint/no-empty-function */

test/helpers/app-no-examples.ts

@@ -0,0 +1,18 @@
+import path from 'path';
+
+import express from 'express';
+
+import { createMockMiddleware } from '../../src';
+
+const app = express();
+
+const middleware = createMockMiddleware({
+  spec: path.resolve(__dirname, '../fixtures/petstore.yaml'),
+  options: {
+    useExamplesValue: false,
+  },
+});
+
+app.use('/api', middleware);
+
+export default app;

test/integration-no-example.spec.ts

@@ -0,0 +1,18 @@
+import supertest from 'supertest';
+
+import app from './helpers/app-no-examples';
+
+const request = supertest(app);
+
+describe('middleware', () => {
+  it('should not use example values if useExamplesValue is set to false', async () => {
+    const response = await request.get('/api/pet/2').set('api_key', 'someKey');
+
+    expect(response.status).toBe(200);
+    expect(response.body).not.toHaveProperty('name', 'doggie');
+    expect(response.body).not.toHaveProperty('photoUrls', [
+      'http://test.test',
+      'http://test1.test1',
+    ]);
+  });
+});