fix: quote object mock key if it is an identifier name (orval-labs#186)

* chore: add esutils dependency * fix: quote key in object mock if it is not an identifier name * style: fix style in other files * test: add an iri-reference in petstore
OliverDudgeon · Jul 26, 2021 · 03e701a · 03e701a
1 parent da15e58
commit 03e701a
Show file tree

Hide file tree

Showing 16 changed files with 43 additions and 26 deletions.
diff --git a/package.json b/package.json
@@ -82,6 +82,7 @@
  "chalk": "^4.1.0",
  "commander": "^7.2.0",
  "cuid": "^2.1.8",
+ "esutils": "2.0.3",
  "fs-extra": "^9.1.0",
  "ibm-openapi-validator": "^0.40.1",
  "inquirer": "^8.0.0",

diff --git a/samples/react-app-with-react-query/petstore.yaml b/samples/react-app-with-react-query/petstore.yaml
@@ -110,6 +110,9 @@ components:
  - id
  - name
  properties:
+ '@id':
+ type: string
+ format: iri-reference
  id:
  type: integer
  format: int64

diff --git a/...s/react-app-with-react-query/src/api/endpoints/petstoreFromFileSpecWithTransformer.msw.ts b/...s/react-app-with-react-query/src/api/endpoints/petstoreFromFileSpecWithTransformer.msw.ts
@@ -1,5 +1,5 @@
 /*
- * Generated by orval v5.4.10 🍺
+ * Generated by orval v5.5.0 🍺
  * Do not edit manually.
  * Swagger Petstore
  * OpenAPI spec version: 1.0.0
@@ -13,9 +13,9 @@ import type {
  Pet
 } from '../model'
 
-export const getListPetsMock = () => ([...Array(faker.datatype.number({min: 1, max: 10}))].map(() => ({id: (() => faker.random.number({ min: 1, max: 99999 }))(), name: (() => faker.name.lastName())(), tag: (() => faker.name.lastName())(), email: faker.helpers.randomize([faker.internet.email(), undefined])})))
+export const getListPetsMock = () => ([...Array(faker.datatype.number({min: 1, max: 10}))].map(() => ({'@id': faker.helpers.randomize([faker.random.word(), undefined]), id: (() => faker.random.number({ min: 1, max: 99999 }))(), name: (() => faker.name.lastName())(), tag: (() => faker.name.lastName())(), email: faker.helpers.randomize([faker.internet.email(), undefined])})))
 
-export const getCreatePetsMock = () => ({id: faker.datatype.number(), name: (() => faker.name.lastName())(), tag: (() => faker.name.lastName())(), email: faker.helpers.randomize([faker.internet.email(), undefined])})
+export const getCreatePetsMock = () => ({'@id': faker.helpers.randomize([faker.random.word(), undefined]), id: faker.datatype.number(), name: (() => faker.name.lastName())(), tag: (() => faker.name.lastName())(), email: faker.helpers.randomize([faker.internet.email(), undefined])})
 
 export const getShowPetByIdMock = () => ((() => ({
  id: faker.random.number({ min: 1, max: 99 }),

diff --git a/samples/react-app-with-react-query/src/api/endpoints/petstoreFromFileSpecWithTransformer.ts b/samples/react-app-with-react-query/src/api/endpoints/petstoreFromFileSpecWithTransformer.ts
@@ -1,5 +1,5 @@
 /*
- * Generated by orval v5.4.10 🍺
+ * Generated by orval v5.5.0 🍺
  * Do not edit manually.
  * Swagger Petstore
  * OpenAPI spec version: 1.0.0

diff --git a/samples/react-app-with-react-query/src/api/model/createPetsBody.ts b/samples/react-app-with-react-query/src/api/model/createPetsBody.ts
@@ -1,5 +1,5 @@
 /*
- * Generated by orval v5.4.10 🍺
+ * Generated by orval v5.5.0 🍺
  * Do not edit manually.
  * Swagger Petstore
  * OpenAPI spec version: 1.0.0

diff --git a/samples/react-app-with-react-query/src/api/model/error.ts b/samples/react-app-with-react-query/src/api/model/error.ts
@@ -1,5 +1,5 @@
 /*
- * Generated by orval v5.4.10 🍺
+ * Generated by orval v5.5.0 🍺
  * Do not edit manually.
  * Swagger Petstore
  * OpenAPI spec version: 1.0.0

diff --git a/samples/react-app-with-react-query/src/api/model/listPetsParams.ts b/samples/react-app-with-react-query/src/api/model/listPetsParams.ts
@@ -1,5 +1,5 @@
 /*
- * Generated by orval v5.4.10 🍺
+ * Generated by orval v5.5.0 🍺
  * Do not edit manually.
  * Swagger Petstore
  * OpenAPI spec version: 1.0.0

diff --git a/samples/react-app-with-react-query/src/api/model/pet.ts b/samples/react-app-with-react-query/src/api/model/pet.ts
@@ -1,11 +1,12 @@
 /*
- * Generated by orval v5.4.10 🍺
+ * Generated by orval v5.5.0 🍺
  * Do not edit manually.
  * Swagger Petstore
  * OpenAPI spec version: 1.0.0
  */
 
 export interface Pet {
+ '@id'?: string;
  id: number;
  name: string;
  tag?: string;

diff --git a/samples/react-app-with-react-query/src/api/model/pets.ts b/samples/react-app-with-react-query/src/api/model/pets.ts
@@ -1,5 +1,5 @@
 /*
- * Generated by orval v5.4.10 🍺
+ * Generated by orval v5.5.0 🍺
  * Do not edit manually.
  * Swagger Petstore
  * OpenAPI spec version: 1.0.0

diff --git a/src/core/generators/angular.ts b/src/core/generators/angular.ts
@@ -107,7 +107,7 @@ const generateImplementation = (
  queryParams,
  response,
  verb,
- isFormData
+ isFormData,
  });
 
  const requestOptions = isRequestOptions
@@ -138,7 +138,7 @@ const generateImplementation = (
  response,
  verb,
  requestOptions: override?.requestOptions,
- isFormData
+ isFormData,
  });
 
  return ` ${operationName}<TData = ${

diff --git a/src/core/generators/axios.ts b/src/core/generators/axios.ts
@@ -46,7 +46,7 @@ const generateAxiosImplementation = (
  queryParams,
  response,
  verb,
- isFormData
+ isFormData,
  });
 
  const requestOptions = isRequestOptions
@@ -57,10 +57,9 @@ const generateAxiosImplementation = (
  : '// eslint-disable-next-line\n// @ts-ignore\n options'
  : '';
 
- return `const ${operationName} = <TData = ${response.definition.success || 'unknown'}>(\n ${toObjectString(
- props,
- 'implementation',
- )}\n ${
+ return `const ${operationName} = <TData = ${
+ response.definition.success || 'unknown'
+ }>(\n ${toObjectString(props, 'implementation')}\n ${
  isRequestOptions
  ? `options?: SecondParameter<typeof ${mutator.name}>`
  : ''
@@ -79,7 +78,7 @@ const generateAxiosImplementation = (
  response,
  verb,
  requestOptions: override?.requestOptions,
- isFormData
+ isFormData,
  });
 
  return `const ${operationName} = <TData = AxiosResponse<${

diff --git a/src/core/getters/object.mock.ts b/src/core/getters/object.mock.ts
@@ -1,5 +1,6 @@
 import cuid from 'cuid';
 import { ReferenceObject, SchemaObject } from 'openapi3-ts';
+import { keyword } from 'esutils';
 import { ContextSpecs, MockOptions } from '../../types';
 import { GeneratorImport } from '../../types/generator';
 import { MockDefinition } from '../../types/mocks';
@@ -86,11 +87,14 @@ export const getMockObject = async ({
  imports = [...imports, ...resolvedValue.imports];
  properties = [...properties, key];
 
+ const keyDefinition = keyword.isIdentifierNameES5(key)
+ ? key
+ : `'${key}'`;
  if (!isRequired && !resolvedValue.overrided) {
- return `${key}: faker.helpers.randomize([${resolvedValue.value}, undefined])`;
+ return `${keyDefinition}: faker.helpers.randomize([${resolvedValue.value}, undefined])`;
  }
 
- return `${key}: ${resolvedValue.value}`;
+ return `${keyDefinition}: ${resolvedValue.value}`;
  },
  ),
  )

diff --git a/src/core/getters/queryParams.ts b/src/core/getters/queryParams.ts
@@ -25,11 +25,13 @@ const getQueryParamsTypes = (
  schema: SchemaObject;
  };
 
- const { value, imports, isEnum, type, schemas, ref } = await resolveValue({
- schema: schema!,
- context,
- name: pascal(operationName) + pascal(name),
- });
+ const { value, imports, isEnum, type, schemas, ref } = await resolveValue(
+ {
+ schema: schema!,
+ context,
+ name: pascal(operationName) + pascal(name),
+ },
+ );
 
  const key = getKey(name);
 

diff --git a/src/core/writers/targetTags.ts b/src/core/writers/targetTags.ts
@@ -77,7 +77,9 @@ export const generateTargetForTags = (
  operations: GeneratorOperations,
  options?: OutputOptions,
 ) => {
- const operationNames = Object.values(operations).map(({operationName}) => operationName);
+ const operationNames = Object.values(operations).map(
+ ({ operationName }) => operationName,
+ );
  const allTargetTags = Object.values(operations)
  .map(addDefaultTagIfEmpty)
  .reduce((acc, operation, index, arr) => {

diff --git a/src/types/esutils.d.ts b/src/types/esutils.d.ts
@@ -0,0 +1,5 @@
+declare module 'esutils' {
+ export namespace keyword {
+ export function isIdentifierNameES5(str: string): boolean;
+ }
+}
diff --git a/yarn.lock b/yarn.lock
@@ -2287,7 +2287,7 @@ estraverse@^5.1.0, estraverse@^5.2.0:
  resolved "https://registry.yarnpkg.com/estraverse/-/estraverse-5.2.0.tgz#307df42547e6cc7324d3cf03c155d5cdb8c53880"
  integrity sha512-BxbNGGNm0RyRYvUdHpIwv9IWzeM9XClbOxwoATuFdOE7ZE6wHL+HQ5T8hoPM+zHvmKzzsEqhgy0GrQ5X13afiQ==
 
-esutils@^2.0.2:
+esutils@2.0.3, esutils@^2.0.2:
  version "2.0.3"
  resolved "https://registry.yarnpkg.com/esutils/-/esutils-2.0.3.tgz#74d2eb4de0b8da1293711910d50775b9b710ef64"
  integrity sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==