Release 5.1.0 (#157)

* chore: make exportable ApiConfig interface; chore: change eslint-disable line at first line of generated file

* feat: --single-http-client option which allows to send HttpClient instance to Api constructor (issue #155)

* feat: onCreateRouteName hook; internal: clearing routeNameDuplicatesMap

* docs: update CHANGELOG

* chore: refresh tests schemas

* fix: nested object properties are generated are optional (issue #156, thanks @Fabiencdp)

* bump: up project version to 5.1.0

Author: js2me

CHANGELOG.md

@@ -1,5 +1,27 @@
 # next release  
 
+# 5.1.0  
+
+Fixes:  
+- Bug with optional nested properties of object schema type (issue #156, thanks @Fabiencdp)  
+
+Features:   
+- `onCreateRouteName(routeNameInfo: RouteNameInfo, rawRouteInfo: RawRouteInfo): RouteNameInfo | void` hook  
+  Which allows to customize route name without customizing `route-name.eta` template  
+- Improved content kinds for request infos  
+- `--single-http-client` option which allows to send HttpClient instance to Api constructor and not to create many count of HttpClient instances with `--modular` api (issue #155)   
+
+Minor:  
+- A bit improve type declaration file (index.d.ts) for this tool  
+- make exportable `ApiConfig` interface  
+
+Internal:  
+- clearing `routeNameDuplicatesMap` before each `parseRoutes()` function call  
+- Changed templates:  
+  - `http-client.eta`  
+  - `procedure-call.eta`  
+  - `api.eta`  
+
 # 5.0.0  
 
 Fixes:  

README.md

@@ -58,6 +58,7 @@ Options:
   --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)
+  --single-http-client          Ability to send HttpClient instance to Api constructor (default: false)
   --default-response <type>     default type for empty response schema (default: "void")
   -h, --help                    display help for command
 ```

index.d.ts

@@ -81,6 +81,10 @@ interface GenerateApiParams {
    * default type for empty response schema (default: "void")
    */
   defaultResponseType?: boolean;
+  /**
+   * Ability to send HttpClient instance to Api constructor
+   */
+  singleHttpClient?: boolean;
   cleanOutput?: boolean;
   enumNamesAsValues?: boolean;
 
@@ -92,6 +96,10 @@ interface GenerateApiParams {
     onInit?: <C extends GenerateApiConfiguration["config"]>(configuration: C) => C | void;
     /** customize configuration object before sending it to ETA templates */
     onPrepareConfig?: <C extends GenerateApiConfiguration>(currentConfiguration: C) => C | void;
+    onCreateRouteName?: (
+      routeNameInfo: RouteNameInfo,
+      rawRouteInfo: RawRouteInfo,
+    ) => RouteNameInfo | void;
     onCreateRequestParams?: (
       rawType: SchemaComponent["rawTypeData"],
     ) => SchemaComponent["rawTypeData"] | void;
@@ -102,6 +110,14 @@ interface GenerateApiParams {
   extraTemplates?: { name: string; path: string }[];
 }
 
+export interface RouteNameRouteInfo {}
+
+export type RouteNameInfo = {
+  usage: string;
+  original: string;
+  duplicate: boolean;
+};
+
 export type SchemaTypePrimitiveContent = {
   $parsedSchema: boolean;
   schemaType: string;
@@ -139,6 +155,13 @@ export interface ParsedSchema<C> {
   content: C;
 }
 
+export interface PathArgInfo {
+  name: string;
+  optional: boolean;
+  type: string;
+  description?: string;
+}
+
 export interface SchemaComponent {
   $ref: string;
   typeName: string;
@@ -167,41 +190,50 @@ export interface SchemaComponent {
   > | null;
 }
 
+export enum RequestContentKind {
+  JSON = "JSON",
+  URL_ENCODED = "URL_ENCODED",
+  FORM_DATA = "FORM_DATA",
+  IMAGE = "IMAGE",
+  OTHER = "OTHER",
+}
+
+export interface RequestResponseInfo {
+  contentTypes: string[];
+  contentKind: RequestContentKind;
+  type: string;
+  description: string;
+  status: string | number;
+  isSuccess: boolean;
+}
+
+export type RawRouteInfo = {
+  operationId: string;
+  method: string;
+  route: string;
+  moduleName: string;
+  responsesTypes: RequestResponseInfo[];
+  description?: string;
+  tags?: string[];
+  summary?: string;
+  responses?: import("swagger-schema-official").Spec["responses"];
+  produces?: string[];
+  requestBody?: object;
+  consumes?: string[];
+};
+
 export interface ParsedRoute {
   id: string;
   jsDocLines: string;
   namespace: string;
   request: Request;
   response: Response;
-  routeName: {
-    usage: string;
-    original: string;
-    duplicate: boolean;
-  };
-  raw: {
-    method: string;
-    route: string;
-    moduleName: string;
-    responsesTypes: {
-      type: string;
-      description: string;
-      status: number;
-      isSuccess: boolean;
-    }[];
-  };
+  routeName: RouteNameInfo;
+  raw: RawRouteInfo;
 }
 
 export interface GenerateApiConfiguration {
   apiConfig: {
-    props: {
-      name: string;
-      optional: boolean;
-      type: string;
-    }[];
-    generic: {
-      name: string;
-      defaultValue: string;
-    }[];
     baseUrl: string;
     title: string;
     version: string;

index.js

@@ -62,6 +62,7 @@ program
     0,
   )
   .option("--disableStrictSSL", "disabled strict SSL", false)
+  .option("--single-http-client", "Ability to send HttpClient instance to Api constructor", false)
   .option("--default-response <type>", "default type for empty response schema", TS_KEYWORDS.VOID)
   .option(
     "--clean-output",
@@ -89,6 +90,7 @@ const {
   disableStrictSSL,
   cleanOutput,
   defaultResponse,
+  singleHttpClient,
 } = program;
 
 generateApi({
@@ -109,5 +111,6 @@ generateApi({
   enumNamesAsValues: enumNamesAsValues,
   moduleNameIndex: +(moduleNameIndex || 0),
   disableStrictSSL: !!disableStrictSSL,
+  singleHttpClient: !!singleHttpClient,
   cleanOutput: !!cleanOutput,
 });

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger-typescript-api",
-  "version": "5.0.0",
+  "version": "5.1.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",
@@ -25,6 +25,7 @@
     "test:specProperty": "node tests/spec/specProperty/test.js",
     "test:--module-name-index": "node tests/spec/moduleNameIndex/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",
     "test:--enum-names-as-values": "node tests/spec/enumNamesAsValues/test.js",
     "test:--default-response": "node tests/spec/defaultResponse/test.js",

package.json

@@ -36,6 +36,7 @@ const config = {
     httpClient: "http-client",
     outOfModuleApi: "Common",
   },
+  routeNameDuplicatesMap: new Map(),
   prettierOptions: constants.PRETTIER_OPTIONS,
   hooks: {
     onCreateComponent: (schema) => schema,
@@ -44,8 +45,10 @@ const config = {
     onInit: (config) => config,
     onPrepareConfig: (apiConfig) => apiConfig,
     onCreateRequestParams: (rawType) => {},
+    onCreateRouteName: () => {},
   },
   defaultResponseType: constants.TS_KEYWORDS.VOID,
+  singleHttpClient: false,
 };
 
 /** needs to use data everywhere in project */

src/config.js

@@ -1,6 +1,6 @@
 module.exports = {
-  filePrefix: `/* tslint:disable */
-/* eslint-disable */
+  filePrefix: `/* eslint:disable */
+/* tslint-disable */
 /*
  * ---------------------------------------------------------------
  * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##

src/filePrefix.js

@@ -37,6 +37,7 @@ module.exports = {
     moduleNameIndex = config.moduleNameIndex,
     extractRequestParams = config.extractRequestParams,
     defaultResponseType = config.defaultResponseType,
+    singleHttpClient = config.singleHttpClient,
     prettier: prettierOptions = constants.PRETTIER_OPTIONS,
     hooks: rawHooks,
     extraTemplates,
@@ -61,6 +62,7 @@ module.exports = {
         disableStrictSSL,
         cleanOutput,
         defaultResponseType,
+        singleHttpClient,
       });
       (spec ? convertSwaggerObject(spec) : getSwaggerObject(input, url, disableStrictSSL))
         .then(({ usageSchema, originalSchema }) => {
@@ -83,6 +85,9 @@ module.exports = {
           const componentsMap = createComponentsMap(components);
 
           const parsedSchemas = parseSchemas(components);
+
+          config.routeNameDuplicatesMap.clear();
+
           const routes = parseRoutes({
             usageSchema,
             parsedSchemas,

src/index.js

@@ -32,11 +32,13 @@ const getRouteName = (routeInfo) => {
 
   const duplicates = routeNameDuplicatesMap.get(duplicateIdentifier);
 
-  return {
+  const routeNameInfo = {
     usage: routeName + (duplicates > 1 ? duplicates : ""),
     original: routeName,
     duplicate: duplicates > 1,
   };
+
+  return config.hooks.onCreateRouteName(routeNameInfo, routeInfo) || routeNameInfo;
 };
 
 module.exports = {