Merge pull request #5 from acacode/next

new version 1.2.5

Author: js2me

CHANGELOG.md

@@ -0,0 +1,64 @@
+# 1.2.5  
+Features: better naming of routes without `operationId`  
+![route naming](./assets/changelog_assets/1.2.5_route_naming.jpg)  
+Changes: rename `@security true` -> `@secure`, `@duplicate true` -> `@duplicate`  
+Fixes: Support generated swagger schemes from tsoa 3.x with complex types (Omit, Pick, etc)  
+
+# 1.2.4  
+Features: add .d.ts file into npm package  
+Changes: update help block in CLI  
+Internal: add greenkeeper, update npm keywords  
+
+# 1.2.3  
+Features: @summary, @description comments at each route  
+Fixes: parsing schema without routes  
+Changes: update documentation  
+Internal: add anyOf, allOf test schemas, slack notifications in CI  
+
+# 1.2.2  
+Fixes: fix complex types (oneOf, anyOf), required fields of object type was not required  
+
+# 1.2.0  
+Changes: rename `ApiParams` to `RequestParams`, secure module always exist in generated API module, update documentation  
+Fixes: Query params was all required, parse yaml files, typescript minor warnings (;)  
+Internal: test schemas + manual testing, add travis CI/CD  
+
+# 1.1.0  
+Fixes: catching http errors with use API module  
+
+# 1.0.9  
+Features: add description to interfaces and their fields  
+Changes: update documentation  
+
+# 1.0.8  
+Changes: update documentation  
+
+# 1.0.7  
+Changes: update documentation (+ add logo), add comment about author in generated module  
+
+# 1.0.6  
+Fixes: route naming, http(s) requests for getting swagger schema, integer enums  
+Changes: include only required files into npm pacakge  
+
+# 1.0.5  
+Changes: update documentation  
+
+# 1.0.4  
+Changes: disable linters rules for generated API module  
+Fixes: TS issues in template  
+
+# 1.0.3  
+Fixes: NodeJS main script cannot been called on Unix* machines  
+Changes: add LICENSE, update README  
+
+# 1.0.2  
+Changes(Internal): change dependencies  
+
+# 1.0.1  
+New features: query params, separating routes on submodules, common params in constructor, swagger v2 + yaml parsers  
+Enhancements: better type extracting.  
+Fixes: mustache escaping chars  
+Changes: order of request params, emojis messages in console  
+
+# 1.0.0  
+Initial project.  

README.md

@@ -1,8 +1,9 @@
 # swagger-typescript-api  
 
 [![Greenkeeper badge](https://badges.greenkeeper.io/acacode/swagger-typescript-api.svg)](https://greenkeeper.io/)
+[![NPM badge](https://img.shields.io/npm/v/swagger-typescript-api.svg)](https://www.npmjs.com/package/swagger-typescript-api)
 
-<img src="https://raw.githubusercontent.com/acacode/swagger-typescript-api/master/assets/swagger-typescript-api-logo1.png" align="left"
+<img src="https://raw.githubusercontent.com/acacode/swagger-typescript-api/master/assets/swagger-typescript-api-logo.png" align="left"
      title="swagger-typescript-api logo by js2me" width="93" height="180">
 
 Generate api via swagger scheme.  
@@ -16,6 +17,8 @@ Any questions you can ask [**here**](https://github.com/acacode/swagger-typescri
 
 <br>  
 
+![](./assets/components-converter-example.jpg)  
+
 ## 👀 Examples  
 
 All examples you can find [**here**](https://github.com/acacode/swagger-typescript-api/tree/master/tests)  

assets/changelog_assets/1.2.5_route_naming.jpg

@@ -0,0 +1,21 @@
+
+const checkAndRenameModelName = name => {
+
+  if (!/^([A-Za-z$_]{1,})$/g.test(name)) {
+    // specific replaces for TSOA 3.x
+
+    if (name.includes('.'))
+      name = name
+        .replace(/Exclude_keyof[A-Za-z]{1,}/g, match => 'ExcludeKeys')
+        .replace(/%22\~AND\~%22/g, 'And')
+        .replace(/%22\~OR\~%22/g, 'Or')
+        .replace(/(\.?%22)|\./g, '_')
+        .replace(/__+$/, '');
+  }
+
+  return name;
+}
+
+module.exports = {
+  checkAndRenameModelName
+}

assets/components-converter-example.jpg

@@ -1,5 +1,6 @@
 const _ = require('lodash');
 const { formatters } = require("./typeFormatters");
+const { checkAndRenameModelName } = require("./modelNames");
 
 const CONTENT_KEYWORD = '__CONTENT__';
 
@@ -10,12 +11,13 @@ const contentWrapersByTypeIdentifier = {
 }
 
 // { typeIdentifier, name, content, type }
-const getModelType = ({ typeIdentifier, name, content, type, description }) => {
+const getModelType = ({ typeIdentifier, name: originalName, content, type, description }) => {
   if (!contentWrapersByTypeIdentifier[typeIdentifier]) {
     throw new Error(`${typeIdentifier} - type identifier is unknown for this utility`)
   }
 
   const resultContent = formatters[type] ? formatters[type](content) : content;
+  const name = checkAndRenameModelName(originalName);
 
   return {
     typeIdentifier,
@@ -26,7 +28,7 @@ const getModelType = ({ typeIdentifier, name, content, type, description }) => {
   }
 }
 
-
 module.exports = {
   getModelType,
-}
+  checkAndRenameModelName,
+}

assets/swagger-typescript-api-logo.png

@@ -1,7 +1,16 @@
 const _ = require("lodash");
 const { parseSchema } = require("./schema");
+const { checkAndRenameModelName } = require("./modelNames");
 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`);
@@ -10,7 +19,8 @@ const getTypeFromRequestInfo = (requestInfo, parsedSchemas, contentType) => {
     const extractedSchema = _.get(schema, 'additionalProperties', schema);
     const { content } = parseSchema(extractedSchema, 'none', inlineExtraFormatters);
     const foundSchema = _.find(parsedSchemas, parsedSchema => _.isEqual(parsedSchema.content, content))
-    return foundSchema ? foundSchema.name : content;
+
+    return foundSchema ? foundSchema.name : checkAndRenameModelName(content);
   }
 
   return 'any';
@@ -20,14 +30,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 +172,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 +184,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;
   }, {})
 }
 

assets/swagger-typescript-api-logo1.png

@@ -15,7 +15,7 @@ const findSchemaType = schema => {
 const typeAliases = {
   "integer": "number",
 }
-const getTypeAlias = type => typeAliases[type] || type || 'any'
+const getPrimitiveType = type => typeAliases[type] || type || 'any'
 
 const specificObjectTypes = {
   'array': ({ items }) => {
@@ -25,7 +25,7 @@ const specificObjectTypes = {
 }
 const getRefType = (ref) => _.last(_.split(ref, '/'))
 const getType = (property) => {
-  const func = specificObjectTypes[property.type] || (() => getTypeAlias(property.type))
+  const func = specificObjectTypes[property.type] || (() => getPrimitiveType(property.type))
   return property["$ref"] ? getRefType(property["$ref"]) : func(property)
 }
 const getObjectTypeContent = (properties) => {
@@ -73,7 +73,7 @@ const getComplexType = (schema) => {
 
 const schemaParsers = {
   'enum': (schema, typeName) => {
-    const type = getTypeAlias(schema.type);
+    const type = getPrimitiveType(schema.type);
     const isIntegerEnum = type === "number";
     return {
       type: isIntegerEnum ? "intEnum" : 'enum',
@@ -136,4 +136,5 @@ const parseSchema = (schema, typeName, formattersMap) => {
 module.exports = {
   parseSchema,
   getType,
+  getPrimitiveType,
 }