Release 5.1.3 (#167)

* chore: add full github swagger scheme

* chore: add recursive schema

* fix: problem of numeric schema names

* chore: add exception for not found route name template

* feat: processing x-nullable field

* bump: up version to 5.1.3; docs: update CHANGELOG

Author: js2me

CHANGELOG.md

@@ -1,5 +1,11 @@
 # next release  
 
+# 5.1.3  
+
+Fixes:  
+- Ignored `x-nullable` field  
+- Schema type names which starts with number or special characters  
+
 # 5.1.2  
 
 Fixes:  

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger-typescript-api",
-  "version": "5.1.2",
+  "version": "5.1.3",
   "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",

package.json

@@ -20,6 +20,10 @@ const checkAndRenameModelName = (name) => {
   }
 
   if (!isValidName(name)) {
+    if (!/^[a-zA-Z_$]/g.test(name)) {
+      name = `Type ${name}`;
+    }
+
     // specific replaces for TSOA 3.x
     if (name.includes("."))
       name = name

src/modelNames.js

@@ -6,12 +6,14 @@ const getRouteName = (routeInfo) => {
   const { routeNameDuplicatesMap, templatesToRender } = config;
   const routeNameTemplate = templatesToRender.routeName;
 
-  const routeName = routeNameTemplate
-    ? renderTemplate(routeNameTemplate, {
-        routeInfo: routeInfo,
-        utils: require("./render/utils"),
-      })
-    : null;
+  if (!routeNameTemplate) {
+    throw new Error("🥵 route name template (route-name.eta) not found");
+  }
+
+  const routeName = renderTemplate(routeNameTemplate, {
+    routeInfo: routeInfo,
+    utils: require("./render/utils"),
+  });
 
   const duplicateIdentifier = `${moduleName}|${routeName}`;
 

src/routeNames.js

@@ -1,5 +1,11 @@
 const _ = require("lodash");
-const { types, parseSchema, getRefType, getInlineParseContent } = require("./schema");
+const {
+  types,
+  parseSchema,
+  getRefType,
+  getInlineParseContent,
+  checkAndAddNull,
+} = require("./schema");
 const { checkAndRenameModelName } = require("./modelNames");
 const {
   DEFAULT_BODY_ARG_NAME,
@@ -90,12 +96,15 @@ const getRequestInfoTypes = ({ requestInfos, parsedSchemas, operationId, default
           ...(requestInfo || {}),
           contentTypes: contentTypes,
           contentKind: getContentKind(contentTypes),
-          type: getTypeFromRequestInfo({
+          type: checkAndAddNull(
             requestInfo,
-            parsedSchemas,
-            operationId,
-            defaultType,
-          }),
+            getTypeFromRequestInfo({
+              requestInfo,
+              parsedSchemas,
+              operationId,
+              defaultType,
+            }),
+          ),
           description: formatDescription(requestInfo.description || "", true),
           status: _.isNaN(+status) ? status : +status,
           isSuccess: isSuccessStatus(status),
@@ -378,11 +387,14 @@ const getRequestBodyInfo = (routeInfo, routeParams, parsedSchemas) => {
     type = getInlineParseContent(schema);
   } else if (requestBody) {
     schema = requestBody;
-    type = getTypeFromRequestInfo({
-      requestInfo: requestBody,
-      parsedSchemas,
-      operationId,
-    });
+    type = checkAndAddNull(
+      requestBody,
+      getTypeFromRequestInfo({
+        requestInfo: requestBody,
+        parsedSchemas,
+        operationId,
+      }),
+    );
 
     // TODO: Refactor that.
     // It needed for cases when swagger schema is not declared request body type as form data

src/routes.js

@@ -76,7 +76,7 @@ const getInternalSchemaType = (schema) => {
 
 const checkAndAddNull = (schema, value) => {
   const { nullable, type } = schema || {};
-  return (nullable || type === TS_KEYWORDS.NULL) &&
+  return (nullable || !!_.get(schema, "x-nullable") || type === TS_KEYWORDS.NULL) &&
     _.isString(value) &&
     !value.includes(` ${TS_KEYWORDS.NULL}`) &&
     !value.includes(`${TS_KEYWORDS.NULL} `)
@@ -386,4 +386,5 @@ module.exports = {
   getType,
   getRefType,
   SCHEMA_TYPES,
+  checkAndAddNull,
 };

src/schema.js

@@ -11,4 +11,4 @@ As you see above here is two folders:
         - [**`v3.0`**](./generated/v3.0) - generated api modules for OA 3.0 schemas from above folder  
 
 
-Most schemas taken from [apis.guru](https://apis.guru/openapi-directory/), [swagger.io github repo](https://swagger.io/) and [up-banking](https://github.com/up-banking/api)  
+Most schemas taken from [apis.guru](https://apis.guru/openapi-directory/), [swagger.io github repo](https://swagger.io/), [Github api description](https://github.com/github/rest-api-description) and [up-banking](https://github.com/up-banking/api)  

tests/README.md

@@ -235,7 +235,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request GET:/api/Foo/GetBarDescriptions
      */
     fooGetBarDescriptions: (params: RequestParams = {}) =>
-      this.request<string[], any>({
+      this.request<string[] | null, any>({
         path: `/api/Foo/GetBarDescriptions`,
         method: "GET",
         format: "json",
@@ -250,7 +250,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request GET:/api/Foo/GetBar
      */
     fooGetBar: (query: { id: number }, params: RequestParams = {}) =>
-      this.request<Bar, any>({
+      this.request<Bar | null, any>({
         path: `/api/Foo/GetBar`,
         method: "GET",
         query: query,
@@ -265,7 +265,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @name FooSetBar
      * @request POST:/api/Foo/SetBar
      */
-    fooSetBar: (value: Bar, params: RequestParams = {}) =>
+    fooSetBar: (value: Bar | null, params: RequestParams = {}) =>
       this.request<void, any>({
         path: `/api/Foo/SetBar`,
         method: "POST",