Release 4.2.0 (#140)

* feat: new hook onCreateRequestParams; feat: response content types

* bump: up version to 4.2.0

Author: js2me

CHANGELOG.md

@@ -1,5 +1,31 @@
 # next release  
 
+# 4.2.0  
+Features:  
+- new hook `onCreateRequestParams` which allows modify request params (`--extract-request-params` option) before sending it to route info   
+  ![onCreateRequestParams](./assets/changelog_assets/onCreateRequestParamsHook.jpg)  
+  How to use:  
+  ```ts
+    generateApi({
+      // ... your config,
+      hooks: {
+        onCreateRequestParams: (rawType) => {
+          if (Object.keys(rawType.properties).length > 1) return rawType;
+
+          return rawType;
+        }
+      }
+    })
+  ```   
+- response content types (array of string like `application/json`, `image/png`) which allows to customize declaration of request response  
+  Exist in `procedure-call.eta` template `it.route.response.contentTypes`  
+
+Internal:  
+- Difference in templates:  
+  - `procedure-call.eta`  
+  ![procedureCallEta1](./assets/changelog_assets/changes_procedure_call_1.jpg)  
+
+
 # 4.1.0  
 
 Features:  

assets/changelog_assets/changes_procedure_call_1.jpg

@@ -77,6 +77,7 @@ interface GenerateApiParams {
    * prettier configuration
    */
   prettier?: object;
+  cleanOutput?: boolean;
   enumNamesAsValues?: boolean;
 
   hooks?: Partial<{
@@ -87,6 +88,9 @@ 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;
+    onCreateRequestParams?: (
+      rawType: SchemaComponent["rawTypeData"],
+    ) => SchemaComponent["rawTypeData"] | void;
   }>;
   /**
    *  extra templates

assets/changelog_assets/onCreateRequestParamsHook.jpg

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

index.d.ts

@@ -43,6 +43,7 @@ const config = {
     onCreateRoute: (routeData) => routeData,
     onInit: (config) => config,
     onPrepareConfig: (apiConfig) => apiConfig,
+    onCreateRequestParams: (rawType) => {},
   },
 };
 

package-lock.json

@@ -232,6 +232,10 @@ const createRequestParamsSchema = ({
     },
   };
 
+  const fixedSchema = config.hooks.onCreateRequestParams(schema);
+
+  if (fixedSchema) return fixedSchema;
+
   if (extractRequestParams) {
     return createComponent("schemas", classNameCase(`${routeName.usage} Params`), { ...schema });
   }
@@ -264,12 +268,17 @@ const parseRoutes = ({ usageSchema, parsedSchemas, moduleNameIndex, extractReque
           tags,
           responses,
           requestBodyName,
+          produces,
+          ...otherInfo
         } = requestInfo;
         const routeId = nanoid(12);
         const hasSecurity = !!(
           (globalSecurity && globalSecurity.length) ||
           (security && security.length)
         );
+        const responseContentTypes =
+          produces ||
+          _.flatten(_.map(responses, (response) => response && _.keys(response.content)));
 
         const formDataParams = getRouteParams(parameters, "formData");
         const pathParams = getRouteParams(parameters, "path");
@@ -419,7 +428,7 @@ const parseRoutes = ({ usageSchema, parsedSchemas, moduleNameIndex, extractReque
           hasSecurity && ` * @secure`,
           ...(config.generateResponses && responsesTypes.length
             ? responsesTypes.map(
-                ({ type, status, description, isSuccess }) =>
+                ({ type, status, description }) =>
                   ` * @response \`${status}\` \`${type}\` ${description}`,
               )
             : []),
@@ -428,6 +437,7 @@ const parseRoutes = ({ usageSchema, parsedSchemas, moduleNameIndex, extractReque
         const path = route.replace(/{/g, "${");
 
         const response = {
+          contentTypes: responseContentTypes,
           type: getReturnType(responses, parsedSchemas, operationId),
           errorType: getErrorReturnType(responses, parsedSchemas, operationId),
         };
@@ -459,6 +469,10 @@ const parseRoutes = ({ usageSchema, parsedSchemas, moduleNameIndex, extractReque
             description,
             tags,
             summary,
+            responses,
+            produces,
+            requestBody,
+            ...otherInfo,
           },
         };
 

package.json

@@ -2,7 +2,7 @@
 const { utils, route, config } = it;
 const { _, getInlineParseContent, getParseContent, parseSchema, getComponentByRef, require } = utils;
 const { parameters, path, method, payload, params, query, formData, security, requestParams } = route.request;
-const { type, errorType } = route.response;
+const { type, errorType, contentTypes } = route.response;
 const routeDocs = includeFile("./route-docs", { config, route, utils });
 const queryName = (query && query.name) || "query";
 const pathParams = _.values(parameters);
@@ -14,7 +14,7 @@ const rawWrapperArgs = config.extractRequestParams ?
         requestParams && {
           name: pathParams.length ? `{ ${_.join(_.map(pathParams, "name"), ", ")}, ...${queryName} }` : queryName,
           optional: false,
-          type: getParseContent(requestParams),
+          type: getInlineParseContent(requestParams),
         },
         ...(!requestParams ? pathParams : []),
         payload,

src/config.js

@@ -2,7 +2,7 @@
 const { utils, route, config } = it;
 const { _, getInlineParseContent, getParseContent, parseSchema, getComponentByRef, require } = utils;
 const { parameters, path, method, payload, params, query, formData, security, requestParams } = route.request;
-const { type, errorType } = route.response;
+const { type, errorType, contentTypes } = route.response;
 const routeDocs = includeFile("./route-docs", { config, route, utils });
 const queryName = (query && query.name) || "query";
 const pathParams = _.values(parameters);
@@ -14,7 +14,7 @@ const rawWrapperArgs = config.extractRequestParams ?
         requestParams && {
           name: pathParams.length ? `{ ${_.join(_.map(pathParams, "name"), ", ")}, ...${queryName} }` : queryName,
           optional: false,
-          type: getParseContent(requestParams),
+          type: getInlineParseContent(requestParams),
         },
         ...(!requestParams ? pathParams : []),
         payload,