swagger-typescript-api 11.0.0--beta-6 → 11.0.1

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # next release  
 
+# 11.0.1  
+
+- fix: problems with --http-client option in `generate-templates` command  
+- fix: rewrite file content in `generate-templates` command  
+
 # 11.0.0  
 
 ## Breaking changes  
@@ -8,6 +13,10 @@
  - new codebase (class way)  
  - ability to change everything in codegen process configuration with using NodeJS Api  
  - ability to call `generateApi` function 2 and more times per 1 NodeJS process.  
+ - new command `generate-templates` to create source templates  
+
+## [feature] Ability to generate source templates  
+New command `generate-templates` which allow you to generate source templates which using with option `--templates`  
 
 ## [feature] Ability to modify internal codegen typescript structs     
 Everything which creates codegen about output typescript code now contains in `Ts` field in [`src/configuration`](src/configuration.js).

package/README.md

@@ -34,6 +34,7 @@ All examples you can find [**here**](https://github.com/acacode/swagger-typescri
 ```muse
 Usage: sta [options]
 Usage: swagger-typescript-api [options]
+Usage: swagger-typescript-api generate-templates [options]
 
 Options:
   -v, --version                 output the current version
@@ -73,7 +74,18 @@ Options:
   --patch                       fix up small errors in the swagger source definition (default: false)
   --debug                       additional information about processes inside this tool (default: false)
   --another-array-type          generate array types as Array<Type> (by default Type[]) (default: false)
+  --sort-types                  sort fields and types (default: false)
   -h, --help                    display help for command
+
+Commands:
+  generate-templates              Generate ".ejs" templates needed for generate api
+    -o, --output <string>         output path of generated templates
+    -m, --modular                 generate templates needed to separate files for http client, data contracts, and routes (default: false)
+    --http-client <string>        http client type (possible values: "fetch", "axios") (default: "fetch")
+    -c, --clean-output            clean output folder before generate template. WARNING: May cause data loss (default: false)
+    -r, --rewrite                 rewrite content in existing templates (default: false)
+    --silent                      Output only errors to console (default: false)
+    -h, --help                    display help for command
 ```
 
 Also you can use `npx`:  
@@ -83,7 +95,7 @@ Also you can use `npx`:
 
 You can use this package from nodejs:
 ```js
-const { generateApi } = require('swagger-typescript-api');
+const { generateApi, generateTemplates } = require('swagger-typescript-api');
 const path = require("path");
 const fs = require("fs");
 
@@ -158,6 +170,16 @@ generateApi({
   })
   .catch(e => console.error(e))
 
+
+generateTemplates({
+  cleanOutput: false,
+  output: PATH_TO_OUTPUT_DIR,
+  httpClientType: "fetch",
+  modular: false,
+  silent: false,
+  rewrite: false,
+})
+
 ```
 
 
@@ -220,6 +242,9 @@ When we change it to `--module-name-index 1` then Api class have two properties
 This option will group your API operations based on their first tag - mirroring how the Swagger UI groups displayed operations
 
 
+## `generate-templates` command    
+This command allows you to generate source templates which using with option `--templates`
+
 ## Modification internal codegen structs with NodeJS API:  
 
 You are able to modify TypeScript internal structs using for generating output with using `generateApi` options `codeGenConstructs` and `primitiveTypeConstructs`.  

package/index.js

@@ -290,7 +290,14 @@ const main = async () => {
         break;
       }
       case "generate-templates": {
-        await generateTemplates(options);
+        await generateTemplates({
+          cleanOutput: options.cleanOutput,
+          output: options.output,
+          httpClientType: options.httpClient,
+          modular: options.modular,
+          silent: options.silent,
+          rewrite: options.rewrite,
+        });
         break;
       }
       default: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger-typescript-api",
-  "version": "11.0.0--beta-6",
+  "version": "11.0.1",
   "description": "Generate typescript/javascript api from swagger schema",
   "scripts": {
     "cli:json": "node index.js -r -d -p ./swagger-test-cli.json -n swagger-test-cli.ts",

package/src/commands/generate-templates/templates-gen-process.js

@@ -56,17 +56,37 @@ class TemplatesGenProcess {
       }
 
       templates.forEach((template) => {
-        const templateExist = this.fileSystem.pathIsExist(path.resolve(outputPath, template.name));
-        if (!templateExist || this.config.rewrite) {
+        const templateName = this.fileSystem.cropExtension(template.name);
+        const templateEjsPath = path.resolve(outputPath, `${templateName}.ejs`);
+        const templateEtaPath = path.resolve(outputPath, `${templateName}.eta`);
+        const templateEjsPathExist = this.fileSystem.pathIsExist(templateEjsPath);
+        const templateEtaPathExist = this.fileSystem.pathIsExist(templateEtaPath);
+
+        if (this.config.rewrite || (!templateEjsPathExist && !templateEtaPathExist)) {
           this.fileSystem.createFile({
             path: outputPath,
             fileName: template.name,
             content: template.content,
             withPrefix: false,
           });
+        } else if (templateEjsPathExist) {
+          this.fileSystem.createFile({
+            path: outputPath,
+            fileName: `${templateName}.ejs`,
+            content: template.content,
+            withPrefix: false,
+          });
+        } else if (templateEtaPathExist) {
+          this.fileSystem.createFile({
+            path: outputPath,
+            fileName: `${templateName}.eta`,
+            content: template.content,
+            withPrefix: false,
+          });
         }
       });
-      this.logger.event(`source templates has been successfully created in "${outputPath}"`);
+
+      this.logger.success(`source templates has been successfully created in "${outputPath}"`);
     }
 
     return {
@@ -83,23 +103,26 @@ class TemplatesGenProcess {
     const apiTemplatesPath = this.config.modular ? this.paths.moduleApiTemplates : this.paths.defaultApiTemplates;
     const apiTemplates = this.getTemplateNamesFromDir(apiTemplatesPath);
 
-    for (const fileName of baseTemplates) {
-      outputFiles.push({
-        name: fileName,
-        content: this.fixTemplateContent(this.getTemplateContent(`${this.paths.baseTemplates}/${fileName}`)),
-      });
-    }
-
     const usingHttpClientTemplate = httpClientTemplates.find((template) =>
       template.startsWith(`${this.config.httpClientType}-`),
     );
 
+    let httpClientTemplateContent = "";
+
     if (usingHttpClientTemplate) {
+      httpClientTemplateContent = this.fixTemplateContent(
+        this.getTemplateContent(`${this.paths.httpClientTemplates}/${usingHttpClientTemplate}`),
+      );
+    }
+
+    for (const fileName of baseTemplates) {
+      const templateContent =
+        (fileName === "http-client.ejs" && httpClientTemplateContent) ||
+        this.fixTemplateContent(this.getTemplateContent(`${this.paths.baseTemplates}/${fileName}`));
+
       outputFiles.push({
-        name: usingHttpClientTemplate,
-        content: this.fixTemplateContent(
-          this.getTemplateContent(`${this.paths.httpClientTemplates}/${usingHttpClientTemplate}`),
-        ),
+        name: fileName,
+        content: templateContent,
       });
     }