Release 6.2.0 (#190)

* Split routes based on first tag (#188)

* bump: up version to 6.2.0

Co-authored-by: James Poyser <[email protected]>

Author: js2me

CHANGELOG.md

@@ -1,5 +1,10 @@
 # next release  
 
+# 6.2.0  
+
+Features:  
+- `--module-name-first-tag` option. Splits routes based on the first tag (thanks @jnpoyser)  
+
 # 6.1.2  
 
 Fixes:  

README.md

@@ -52,6 +52,7 @@ Options:
                                 Also combine path params and query params into one object
   --module-name-index <number>  determines which path index should be used for routes separation (default: 0)
                                 (example: GET:/fruites/getFruit -> index:0 -> moduleName -> fruites)
+  --module-name-first-tag       splits routes based on the first tag
   --modular                     generate separated files for http client, data contracts, and routes (default: false)
   --disableStrictSSL            disabled strict SSL (default: false)
   --clean-output                clean output folder before generate api. WARNING: May cause data loss (default: false)
@@ -173,6 +174,9 @@ Example:
 with `--module-name-index 0` Api class will have one property `api`  
 When we change it to `--module-name-index 1` then Api class have two properties `fruits` and `vegetables`  
 
+### **`--module-name-first-tag`**  
+This option will group your API operations based on their first tag - mirroring how the Swagger UI groups displayed operations
+
 
 ## 📄 Mass media  
 

index.d.ts

@@ -63,6 +63,10 @@ interface GenerateApiParams {
    * determines which path index should be used for routes separation
    */
   moduleNameIndex?: number;
+  /**
+   * users operation's first tag for route separation
+   */
+  moduleNameFirstTag?: boolean;
   /**
    * disabled SSL check
    */
@@ -254,6 +258,7 @@ export interface GenerateApiConfiguration {
     componentsMap: Record<string, SchemaComponent>;
     convertedFromSwagger2: boolean;
     moduleNameIndex: number;
+    moduleNameFirstTag: boolean;
     disableStrictSSL: boolean;
     extractRequestParams: boolean;
     fileNames: {

index.js

@@ -61,6 +61,7 @@ program
     "determines which path index should be used for routes separation (example: GET:/fruites/getFruit -> index:0 -> moduleName -> fruites)",
     0,
   )
+  .option("--module-name-first-tag", "splits routes based on the first tag", false)
   .option("--disableStrictSSL", "disabled strict SSL", false)
   .option("--axios", "generate axios http client", false)
   .option("--single-http-client", "Ability to send HttpClient instance to Api constructor", false)
@@ -87,6 +88,7 @@ const {
   modular,
   js,
   moduleNameIndex,
+  moduleNameFirstTag,
   extractRequestParams,
   enumNamesAsValues,
   disableStrictSSL,
@@ -115,6 +117,7 @@ generateApi({
   toJS: !!js,
   enumNamesAsValues: enumNamesAsValues,
   moduleNameIndex: +(moduleNameIndex || 0),
+  moduleNameFirstTag: moduleNameFirstTag,
   disableStrictSSL: !!disableStrictSSL,
   singleHttpClient: !!singleHttpClient,
   cleanOutput: !!cleanOutput,

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger-typescript-api",
-  "version": "6.1.2",
+  "version": "6.2.0",
   "description": "Create typescript api module from swagger schema",
   "scripts": {
     "cli:json": "node index.js -r -d -p ./swagger-test-cli.json -n swagger-test-cli.ts --extract-request-params --enum-names-as-values",
@@ -24,6 +24,7 @@
     "test:--responses": "node tests/spec/responses/test.js",
     "test:specProperty": "node tests/spec/specProperty/test.js",
     "test:--module-name-index": "node tests/spec/moduleNameIndex/test.js",
+    "test:--module-name-first-tag": "node tests/spec/moduleNameFirstTag/test.js",
     "test:--modular": "node tests/spec/modular/test.js",
     "test:--single-http-client": "node tests/spec/singleHttpClient/test.js",
     "test:--extract-request-params": "node tests/spec/extractRequestParams/test.js",

package.json

@@ -28,6 +28,9 @@ const config = {
 
   /** url index from paths used for merging into modules */
   moduleNameIndex: 0,
+
+  /** use the first tag for the module name */
+  moduleNameFirstTag: false,
   disableStrictSSL: false,
   extractRequestParams: false,
   fileNames: {

src/config.js

@@ -36,6 +36,7 @@ module.exports = {
     httpClientType = config.httpClientType,
     generateUnionEnums = config.generateUnionEnums,
     moduleNameIndex = config.moduleNameIndex,
+    moduleNameFirstTag = config.moduleNameFirstTag,
     extractRequestParams = config.extractRequestParams,
     defaultResponseType = config.defaultResponseType,
     singleHttpClient = config.singleHttpClient,
@@ -57,6 +58,7 @@ module.exports = {
         templates,
         generateUnionEnums,
         moduleNameIndex,
+        moduleNameFirstTag,
         prettierOptions,
         modular,
         extractRequestParams,
@@ -102,6 +104,7 @@ module.exports = {
             usageSchema,
             parsedSchemas,
             moduleNameIndex,
+            moduleNameFirstTag,
             extractRequestParams,
           });
 

src/index.js

@@ -451,7 +451,13 @@ const getResponseBodyInfo = (routeInfo, routeParams, parsedSchemas) => {
   };
 };
 
-const parseRoutes = ({ usageSchema, parsedSchemas, moduleNameIndex, extractRequestParams }) => {
+const parseRoutes = ({
+  usageSchema,
+  parsedSchemas,
+  moduleNameIndex,
+  moduleNameFirstTag,
+  extractRequestParams,
+}) => {
   const { paths, security: globalSecurity } = usageSchema;
   const pathsEntries = _.entries(paths);
 
@@ -480,7 +486,11 @@ const parseRoutes = ({ usageSchema, parsedSchemas, moduleNameIndex, extractReque
         const { route, pathParams } = parseRoute(rawRoute);
 
         const routeId = nanoid(12);
-        const moduleName = _.camelCase(_.compact(_.split(route, "/"))[moduleNameIndex]);
+        const firstTag = tags && tags.length > 0 ? tags[0] : null;
+        const moduleName =
+          moduleNameFirstTag && firstTag
+            ? _.camelCase(firstTag)
+            : _.camelCase(_.compact(_.split(route, "/"))[moduleNameIndex]);
         const hasSecurity = !!(
           (globalSecurity && globalSecurity.length) ||
           (security && security.length)