feat: better route naming when operationId not existed

Author: svolkov

src/routes.js

@@ -2,6 +2,14 @@ const _ = require("lodash");
 const { parseSchema } = require("./schema");
 const { inlineExtraFormatters } = require("./typeFormatters");
 
+const methodAliases = {
+  get: (pathName, hasPathInserts) => _.camelCase(`${pathName}_${hasPathInserts ? 'detail': 'list'}`),
+  post: (pathName, hasPathInserts) => _.camelCase(`${pathName}_create`),
+  put: (pathName, hasPathInserts) => _.camelCase(`${pathName}_update`),
+  patch: (pathName, hasPathInserts) => _.camelCase(`${pathName}_partial_update`),
+  delete: (pathName, hasPathInserts) => _.camelCase(`${pathName}_delete`)
+}
+
 const getTypeFromRequestInfo = (requestInfo, parsedSchemas, contentType) => {
   // TODO: make more flexible pick schema without content type
   const schema = _.get(requestInfo, `content["${contentType}"].schema`);
@@ -20,14 +28,17 @@ const findSuccessResponse = (responses) => {
   return _.find(responses, (v, status) => status === 'default' || (+status >= 200 && +status < 300))
 }
 
+const createCustomOperationId = (method, route, moduleName) => {
+  const hasPathInserts = /\{(\w){1,}\}/g.test(route);
+  const splitedRouteBySlash = _.replace(route, /\{(\w){1,}\}/g, '').split('/').filter(Boolean);
+  const routeParts = (splitedRouteBySlash.length > 1 ? splitedRouteBySlash.splice(1) : splitedRouteBySlash).join('_');
+  return routeParts.length > 3 && methodAliases[method] ? methodAliases[method](routeParts, hasPathInserts) : _.camelCase(_.lowerCase(method) + '_' + ([moduleName]).join('_')) || 'index'
+}
+
 const getRouteName = (operationId, method, route, moduleName) => {
   if (operationId) return operationId;
   if (route === '/') return `${_.lowerCase(method)}Root`;
-
-  const routeParts = _.replace(route, /\{(\w){1,}\}/g, '').split('/').filter(Boolean);
-
-  // create route name via method and route
-  return _.camelCase(_.lowerCase(method) + '_' + (moduleName ? routeParts.splice(1) : routeParts).join('_')) || 'index'
+  return createCustomOperationId(method, route, moduleName);
 }
 
 const parseRoutes = (routes, parsedSchemas) =>
@@ -159,7 +170,7 @@ const groupRoutes = routes => {
           `🥵  This method has been renamed to "${route.name + (duplicates[route.moduleName][route.name] + 1)}()" to solve conflict names.`
         )
         route.comments.push(`@originalName ${route.name}`)
-        route.comments.push(`@duplicate true`)
+        route.comments.push(`@duplicate`)
         route.name += ++duplicates[route.moduleName][route.name];
       }
 
@@ -171,21 +182,37 @@ const groupRoutes = routes => {
     return modules
   }, {
     $outOfModule: []
-  }), (shuffle, packRoutes, moduleName) => {
-
+  }), (acc, packRoutes, moduleName) => {
+
+    // if (moduleName === "$outOfModule") {
+    //   acc.outOfModule.push(...routes)
+    // } else {
+    //   if (routes.length === 1) {
+    //     const route = routes[0]
+    //     acc.outOfModule.push({
+    //       ...route,
+    //       name: route.name === _.lowerCase(route.name) ? moduleName : route.name,
+    //     })
+    //   } else {
+    //     acc.combined.push({
+    //       moduleName,
+    //       routes: routes,
+    //     })
+    //   }
+    // }
 
     if (moduleName === "$outOfModule") {
-      shuffle['outOfModule'] = packRoutes
+      acc.outOfModule = packRoutes
     } else {
-      if (!shuffle.combined) shuffle.combined = []
+      if (!acc.combined) acc.combined = []
 
-      shuffle.combined.push({
+      acc.combined.push({
         moduleName,
         routes: packRoutes,
       })
     }
 
-    return shuffle;
+    return acc;
   }, {})
 }
 

tests/generated/v2.0/petstore-minimal.ts

@@ -100,11 +100,11 @@ export class Api<SecurityDataType> {
 
 
     /**
-    * @name get
+    * @name petsList
     * @request GET:/pets
     * @description Returns all pets from the system that the user has access to
     */
-    get: (params?: RequestParams) =>
+    petsList: (params?: RequestParams) =>
       this.request<Pet[]>(`/pets`, "GET", params, null),
   }
 

tests/generated/v2.0/uber.ts

@@ -196,63 +196,63 @@ export class Api<SecurityDataType> {
 
     /**
     * @tags Products
-    * @name get
+    * @name productsList
     * @summary Product Types
     * @request GET:/products
     * @secure
     * @description The Products endpoint returns information about the Uber products offered at a given location. The response includes the display name and other details about each product, and lists the products in the proper display order.
     */
-    get: (query: { latitude: number, longitude: number }, params?: RequestParams) =>
+    productsList: (query: { latitude: number, longitude: number }, params?: RequestParams) =>
       this.request<Product[]>(`/products${this.addQueryParams(query)}`, "GET", params, null, true),
   }
   estimates = {
 
 
     /**
     * @tags Estimates
-    * @name getPrice
+    * @name priceList
     * @summary Price Estimates
     * @request GET:/estimates/price
     * @description The Price Estimates endpoint returns an estimated price range for each product offered at a given location. The price estimate is provided as a formatted string with the full price range and the localized currency symbol.<br><br>The response also includes low and high estimates, and the [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) currency code for situations requiring currency conversion. When surge is active for a particular product, its surge_multiplier will be greater than 1, but the price estimate already factors in this multiplier.
     */
-    getPrice: (query: { start_latitude: number, start_longitude: number, end_latitude?: number, end_longitude: number }, params?: RequestParams) =>
+    priceList: (query: { start_latitude: number, start_longitude: number, end_latitude?: number, end_longitude: number }, params?: RequestParams) =>
       this.request<PriceEstimate[]>(`/estimates/price${this.addQueryParams(query)}`, "GET", params, null),
 
 
     /**
     * @tags Estimates
-    * @name getTime
+    * @name timeList
     * @summary Time Estimates
     * @request GET:/estimates/time
     * @description The Time Estimates endpoint returns ETAs for all products offered at a given location, with the responses expressed as integers in seconds. We recommend that this endpoint be called every minute to provide the most accurate, up-to-date ETAs.
     */
-    getTime: (query: { start_latitude: number, start_longitude: number, customer_uuid?: string, product_id?: string }, params?: RequestParams) =>
+    timeList: (query: { start_latitude: number, start_longitude: number, customer_uuid?: string, product_id?: string }, params?: RequestParams) =>
       this.request<Product[]>(`/estimates/time${this.addQueryParams(query)}`, "GET", params, null),
   }
   me = {
 
 
     /**
     * @tags User
-    * @name get
+    * @name getMe
     * @summary User Profile
     * @request GET:/me
     * @description The User Profile endpoint returns information about the Uber user that has authorized with the application.
     */
-    get: (params?: RequestParams) =>
+    getMe: (params?: RequestParams) =>
       this.request<Profile>(`/me`, "GET", params, null),
   }
   history = {
 
 
     /**
     * @tags User
-    * @name get
+    * @name historyList
     * @summary User Activity
     * @request GET:/history
     * @description The User Activity endpoint returns data about a user's lifetime activity with Uber. The response will include pickup locations and times, dropoff locations and times, the distance of past requests, and information about which products were requested.<br><br>The history array in the response will have a maximum length based on the limit parameter. The response value count may exceed limit, therefore subsequent API requests may be necessary.
     */
-    get: (query: { offset?: number, limit?: number }, params?: RequestParams) =>
+    historyList: (query: { offset?: number, limit?: number }, params?: RequestParams) =>
       this.request<Activities>(`/history${this.addQueryParams(query)}`, "GET", params, null),
   }
 

tests/generated/v3.0/allof-example.ts

@@ -102,10 +102,10 @@ export class Api<SecurityDataType> {
 
 
     /**
-    * @name patch
+    * @name petsPartialUpdate
     * @request PATCH:/pets
     */
-    patch: (data: Cat | Dog, params?: RequestParams) =>
+    petsPartialUpdate: (data: Cat | Dog, params?: RequestParams) =>
       this.request<any>(`/pets`, "PATCH", params, data),
   }
 

tests/generated/v3.0/anyof-example.ts

@@ -104,10 +104,10 @@ export class Api<SecurityDataType> {
 
 
     /**
-    * @name patch
+    * @name petsPartialUpdate
     * @request PATCH:/pets
     */
-    patch: (data: PetByAge | PetByType | (PetByAge & PetByType), params?: RequestParams) =>
+    petsPartialUpdate: (data: PetByAge | PetByType | (PetByAge & PetByType), params?: RequestParams) =>
       this.request<any>(`/pets`, "PATCH", params, data),
   }
 

tests/generated/v3.0/callback-example.ts

@@ -104,11 +104,11 @@ export class Api<SecurityDataType> {
 
 
     /**
-    * @name post
+    * @name streamsCreate
     * @request POST:/streams
     * @description subscribes a client to receive out-of-band data
     */
-    post: (query: { callbackUrl: string }, params?: RequestParams) =>
+    streamsCreate: (query: { callbackUrl: string }, params?: RequestParams) =>
       this.request<{ subscriptionId: string }>(`/streams${this.addQueryParams(query)}`, "POST", params, null),
   }
 

tests/generated/v3.0/oneof-example.ts

@@ -104,10 +104,10 @@ export class Api<SecurityDataType> {
 
 
     /**
-    * @name patch
+    * @name petsPartialUpdate
     * @request PATCH:/pets
     */
-    patch: (data: Cat | Dog, params?: RequestParams) =>
+    petsPartialUpdate: (data: Cat | Dog, params?: RequestParams) =>
       this.request<any>(`/pets`, "PATCH", params, data),
   }
 

tests/validate.js

@@ -13,6 +13,7 @@ const v3ApiPaths = createGeneratedApiInfos(path.resolve(__dirname, "./generated/
   ...v2ApiPaths,
   ...v3ApiPaths,
 ].forEach(path => {
+  process.stdout.write(`validating ${path}: `)
   var program = tsc.createProgram([path], {
     noEmitOnError: true,
     noImplicitAny: false,
@@ -32,7 +33,10 @@ const v3ApiPaths = createGeneratedApiInfos(path.resolve(__dirname, "./generated/
       console.log(`${diagnostic.file.fileName} (${line + 1},${character + 1}): ${message}`);
   });
 
+  process.stdout.write(`errors ${emitResult.diagnostics.length}\r\n`)
   if (emitResult.diagnostics.length){
     process.exit(1)
   }
 })
+
+console.log('everything is good:)')