swagger-typescript-api 9.2.0 → 9.3.0

package/LICENSE

@@ -1,22 +1,22 @@
-MIT License
-
-Copyright (c) 2019-present acacode
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+MIT License
+
+Copyright (c) 2019-present acacode
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -63,6 +63,7 @@ Options:
   --default-response <type>     default type for empty response schema (default: "void")
   --type-prefix <string>        data contract name prefix (default: "")
   --type-suffix <string>        data contract name suffix (default: "")
+  --patch                       fix up small errors in the swagger source definition (default: false)
   -h, --help                    display help for command
 ```
 
@@ -99,7 +100,7 @@ generateApi({
   toJS: false,
   extractRequestParams: false,
   extractRequestBody: false,
-  prettier: {
+  prettier: { // By default prettier config is load from your project
     printWidth: 120,
     tabWidth: 2,
     trailingComma: "all",

package/index.d.ts

@@ -88,6 +88,10 @@ interface GenerateApiParams {
    * extract request params to data contract (Also combine path params and query params into one object)
    */
   extractRequestParams?: boolean;
+  /**
+   * extract request body type to data contract
+   */
+  extractRequestBody?: boolean;
   /**
    * prettier configuration
    */
@@ -112,6 +116,11 @@ interface GenerateApiParams {
    *  extra templates
    */
   extraTemplates?: { name: string; path: string }[];
+
+  /**
+   * fix up small errors in the swagger source definition
+   */
+  patch?: boolean;
 }
 
 export interface Hooks {
@@ -126,14 +135,9 @@ export interface Hooks {
   /** customize configuration object before sending it to ETA templates */
   onPrepareConfig?: <C extends GenerateApiConfiguration>(currentConfiguration: C) => C | void;
   /** customize route name as you need */
-  onCreateRouteName?: (
-    routeNameInfo: RouteNameInfo,
-    rawRouteInfo: RawRouteInfo,
-  ) => RouteNameInfo | void;
+  onCreateRouteName?: (routeNameInfo: RouteNameInfo, rawRouteInfo: RawRouteInfo) => RouteNameInfo | void;
   /** customize request params (path params, query params) */
-  onCreateRequestParams?: (
-    rawType: SchemaComponent["rawTypeData"],
-  ) => SchemaComponent["rawTypeData"] | void;
+  onCreateRequestParams?: (rawType: SchemaComponent["rawTypeData"]) => SchemaComponent["rawTypeData"] | void;
   /** customize name of model type */
   onFormatTypeName?: (typeName: string, rawTypeName?: string) => string | void;
   /** customize name of route (operationId), you can do it with using onCreateRouteName too */
@@ -210,14 +214,10 @@ export interface SchemaComponent {
     discriminator?: {
       propertyName?: string;
     };
-    $parsed: ParsedSchema<
-      SchemaTypeObjectContent | SchemaTypeEnumContent | SchemaTypePrimitiveContent
-    >;
+    $parsed: ParsedSchema<SchemaTypeObjectContent | SchemaTypeEnumContent | SchemaTypePrimitiveContent>;
   };
   componentName: string;
-  typeData: ParsedSchema<
-    SchemaTypeObjectContent | SchemaTypeEnumContent | SchemaTypePrimitiveContent
-  > | null;
+  typeData: ParsedSchema<SchemaTypeObjectContent | SchemaTypeEnumContent | SchemaTypePrimitiveContent> | null;
 }
 
 export enum RequestContentKind {
@@ -341,10 +341,7 @@ export interface GenerateApiConfiguration {
     formatDescription: (description: string, inline?: boolean) => string;
     internalCase: (value: string) => string;
     classNameCase: (value: string) => string;
-    getInlineParseContent: (
-      rawTypeData: SchemaComponent["rawTypeData"],
-      typeName?: string,
-    ) => string;
+    getInlineParseContent: (rawTypeData: SchemaComponent["rawTypeData"], typeName?: string) => string;
     getParseContent: (rawTypeData: SchemaComponent["rawTypeData"], typeName?: string) => ModelType;
     getComponentByRef: (ref: string) => SchemaComponent;
     parseSchema: (
@@ -352,14 +349,8 @@ export interface GenerateApiConfiguration {
       typeName?: string,
       formattersMap?: Record<MAIN_SCHEMA_TYPES, (content: ModelType) => string>,
     ) => ModelType;
-    formatters: Record<
-      MAIN_SCHEMA_TYPES,
-      (content: string | object | string[] | object[]) => string
-    >;
-    inlineExtraFormatters: Record<
-      Exclude<MAIN_SCHEMA_TYPES, SCHEMA_TYPES.PRIMITIVE>,
-      (schema: ModelType) => string
-    >;
+    formatters: Record<MAIN_SCHEMA_TYPES, (content: string | object | string[] | object[]) => string>;
+    inlineExtraFormatters: Record<Exclude<MAIN_SCHEMA_TYPES, SCHEMA_TYPES.PRIMITIVE>, (schema: ModelType) => string>;
     formatModelName: (name: string) => string;
     fmtToJSDocLine: (line: string, params?: { eol?: boolean }) => string;
     _: import("lodash").LoDashStatic;
@@ -370,12 +361,7 @@ export interface GenerateApiConfiguration {
 export interface GenerateApiOutput {
   configuration: GenerateApiConfiguration;
   files: { name: string; content: string; declaration: { name: string; content: string } | null }[];
-  createFile: (params: {
-    path: string;
-    fileName: string;
-    content: string;
-    withPrefix?: boolean;
-  }) => void;
+  createFile: (params: { path: string; fileName: string; content: string; withPrefix?: boolean }) => void;
   renderTemplate: (
     templateContent: string,
     data: Record<string, unknown>,
@@ -385,12 +371,6 @@ export interface GenerateApiOutput {
   formatTSContent: (content: string) => string;
 }
 
-export declare function generateApi(
-  params: Omit<GenerateApiParams, "url" | "spec">,
-): Promise<GenerateApiOutput>;
-export declare function generateApi(
-  params: Omit<GenerateApiParams, "input" | "spec">,
-): Promise<GenerateApiOutput>;
-export declare function generateApi(
-  params: Omit<GenerateApiParams, "input" | "url">,
-): Promise<GenerateApiOutput>;
+export declare function generateApi(params: Omit<GenerateApiParams, "url" | "spec">): Promise<GenerateApiOutput>;
+export declare function generateApi(params: Omit<GenerateApiParams, "input" | "spec">): Promise<GenerateApiOutput>;
+export declare function generateApi(params: Omit<GenerateApiParams, "input" | "url">): Promise<GenerateApiOutput>;

package/index.js

@@ -33,29 +33,20 @@ program
   )
   .option(
     "-r, --responses",
-    "generate additional information about request responses\n" +
-      "also add typings for bad responses",
+    "generate additional information about request responses\n" + "also add typings for bad responses",
     false,
   )
   .option("--union-enums", 'generate all "enum" types as union types (T1 | T2 | TN)', false)
   .option("--route-types", "generate type definitions for API routes", false)
   .option("--no-client", "do not generate an API class", false)
-  .option(
-    "--enum-names-as-values",
-    "use values in 'x-enumNames' as enum values (not only as keys)",
-    false,
-  )
+  .option("--enum-names-as-values", "use values in 'x-enumNames' as enum values (not only as keys)", false)
   .option(
     "--extract-request-params",
     "extract request params to data contract (Also combine path params and query params into one object)",
     false,
   )
   .option("--extract-request-body", "extract request body type to data contract", false)
-  .option(
-    "--modular",
-    "generate separated files for http client, data contracts, and routes",
-    false,
-  )
+  .option("--modular", "generate separated files for http client, data contracts, and routes", false)
   .option("--js", "generate js api module with declaration file", false)
   .option(
     "--module-name-index <number>",
@@ -67,16 +58,14 @@ program
   .option("--disableProxy", "disabled proxy", false)
   .option("--axios", "generate axios http client", false)
   .option("--unwrap-response-data", "unwrap the data item from the response", false)
+  .option("--disable-throw-on-error", "Do not throw an error when response.ok is not true", false)
   .option("--single-http-client", "Ability to send HttpClient instance to Api constructor", false)
   .option("--silent", "Output only errors to console", false)
   .option("--default-response <type>", "default type for empty response schema", TS_KEYWORDS.VOID)
   .option("--type-prefix <string>", "data contract name prefix", "")
   .option("--type-suffix <string>", "data contract name suffix", "")
-  .option(
-    "--clean-output",
-    "clean output folder before generate api. WARNING: May cause data loss",
-    false,
-  );
+  .option("--clean-output", "clean output folder before generate api. WARNING: May cause data loss", false)
+  .option("--patch", "fix up small errors in the swagger source definition", false);
 
 program.parse(process.argv);
 
@@ -102,11 +91,14 @@ const {
   cleanOutput,
   defaultResponse,
   unwrapResponseData,
+  disableThrowOnError,
+  sortTypes,
   singleHttpClient,
   axios,
   silent,
   typePrefix,
   typeSuffix,
+  patch,
 } = program;
 
 generateApi({
@@ -118,6 +110,8 @@ generateApi({
   defaultResponseAsSuccess: defaultAsSuccess,
   defaultResponseType: defaultResponse,
   unwrapResponseData: unwrapResponseData,
+  disableThrowOnError: disableThrowOnError,
+  sortTypes: sortTypes,
   generateUnionEnums: unionEnums,
   generateResponses: responses,
   extractRequestParams: !!extractRequestParams,
@@ -137,4 +131,10 @@ generateApi({
   silent: !!silent,
   typePrefix,
   typeSuffix,
+  patch: !!patch,
+}).catch((err) => {
+  // NOTE collect all errors on top level and shows to users in any case
+  console.error(err);
+
+  process.exit(1);
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger-typescript-api",
-  "version": "9.2.0",
+  "version": "9.3.0",
   "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",
@@ -39,24 +39,27 @@
     "test:--axios--single-http-client": "node tests/spec/axiosSingleHttpClient/test.js",
     "test:--type-suffix--type-prefix": "node tests/spec/typeSuffixPrefix/test.js",
     "test:partialBaseTemplate": "node tests/spec/partialBaseTemplate/test.js",
-    "test:partialDefaultTemplate": "node tests/spec/partialDefaultTemplate/test.js"
+    "test:partialDefaultTemplate": "node tests/spec/partialDefaultTemplate/test.js",
+    "test:--patch": "node tests/spec/patch/test.js"
   },
   "author": "acacode",
   "license": "MIT",
   "typings": "./index.d.ts",
   "main": "src/index.js",
   "devDependencies": {
+    "@types/axios": "^0.14.0",
     "@types/lodash": "^4.14.166",
     "@types/node": "^15.0.2",
     "@types/prettier": "^2.1.6",
     "all-contributors-cli": "^6.19.0",
+    "axios": "^0.21.4",
     "husky": "^4.3.6",
     "pretty-quick": "^3.1.0"
   },
   "dependencies": {
     "@types/swagger-schema-official": "2.0.21",
-    "axios": "^0.21.1",
     "commander": "^6.2.1",
+    "cosmiconfig": "^7.0.0",
     "eta": "^1.12.1",
     "js-yaml": "^4.0.0",
     "lodash": "^4.17.21",

package/src/config.js

@@ -59,6 +59,8 @@ const config = {
   singleHttpClient: false,
   httpClientType: HTTP_CLIENT.FETCH,
   unwrapResponseData: false,
+  disableThrowOnError: false,
+  sortTypes: false,
   templatePaths: {
     /** `templates/base` */
     base: "",
@@ -83,6 +85,7 @@ const config = {
   silent: false,
   typePrefix: "",
   typeSuffix: "",
+  patch: false,
   componentTypeNameResolver: new NameResolver([]),
 };
 

package/src/index.js

@@ -21,6 +21,7 @@ const { generateOutputFiles } = require("./output");
 const formatFileContent = require("./formatFileContent");
 const { logger } = require("./logger");
 const { ComponentTypeNameResolver } = require("./utils/resolveName");
+const { getPrettierOptions } = require("./prettierOptions");
 
 module.exports = {
   constants: constants,
@@ -45,8 +46,10 @@ module.exports = {
     extractRequestBody = config.extractRequestBody,
     defaultResponseType = config.defaultResponseType,
     unwrapResponseData = config.unwrapResponseData,
+    disableThrowOnError = config.disableThrowOnError,
+    sortTypes = config.sortTypes,
     singleHttpClient = config.singleHttpClient,
-    prettier: prettierOptions = constants.PRETTIER_OPTIONS,
+    prettier: prettierOptions = getPrettierOptions(),
     hooks: rawHooks,
     extraTemplates,
     enumNamesAsValues,
@@ -56,6 +59,7 @@ module.exports = {
     silent = config.silent,
     typePrefix = config.typePrefix,
     typeSuffix = config.typeSuffix,
+    patch = config.patch,
   }) =>
     new Promise((resolve, reject) => {
       addToConfig({
@@ -79,16 +83,19 @@ module.exports = {
         cleanOutput,
         defaultResponseType,
         unwrapResponseData,
+        disableThrowOnError,
+        sortTypes,
         singleHttpClient,
         constants,
         silent,
         toJS: translateToJavaScript,
         typePrefix,
         typeSuffix,
+        patch,
       });
       (spec
-        ? convertSwaggerObject(spec)
-        : getSwaggerObject(input, url, disableStrictSSL, disableProxy)
+        ? convertSwaggerObject(spec, { patch })
+        : getSwaggerObject(input, url, disableStrictSSL, disableProxy, { patch })
       )
         .then(({ usageSchema, originalSchema }) => {
           const templatePaths = getTemplatePaths(config);
@@ -138,11 +145,41 @@ module.exports = {
           const hasFormDataRoutes = routes.some((route) => route.hasFormDataParams);
 
           const usageComponentSchemas = filterComponentsMap(componentsMap, "schemas");
+          const sortByProperty = (o1, o2, propertyName) => {
+            if(o1[propertyName] > o2[propertyName]) {
+              return 1;
+            }
+            if(o1[propertyName] < o2[propertyName]) {
+              return -1;
+            }
+            return 0;
+          }
+          const sortByTypeName = (o1, o2) => sortByProperty(o1, o2, 'typeName');
+
+          const sortByName = (o1, o2) => sortByProperty(o1, o2, 'name');
+
+          const sortSchemas = (schemas) => {
+            if(config.sortTypes) {
+              return schemas.sort(sortByTypeName).map((schema) => {
+                if(schema.rawTypeData?.properties) {
+                  return {
+                    ...schema,
+                    rawTypeData: {
+                      ...schema.rawTypeData,
+                      '$parsed': {...schema.rawTypeData['$parsed'], content: schema.rawTypeData['$parsed'].content.sort(sortByName)}
+                    }
+                  }
+                }
+                return schema;
+              });
+            }
+            return schemas;
+          };
 
           const rawConfiguration = {
             apiConfig: createApiConfig(usageSchema),
             config,
-            modelTypes: _.map(usageComponentSchemas, prepareModelType),
+            modelTypes: _.map(sortSchemas(usageComponentSchemas), prepareModelType),
             rawModelTypes: usageComponentSchemas,
             hasFormDataRoutes,
             hasSecurityRoutes,

package/src/prettierOptions.js

@@ -0,0 +1,23 @@
+const { cosmiconfigSync } = require("cosmiconfig");
+const constants = require("./constants");
+
+/**
+ * Get prettier options from user's project or return the default one
+ * @return {import('prettier').Options} Prettier options
+ */
+function getPrettierOptions() {
+  const prettier = cosmiconfigSync("prettier").search();
+
+  if (prettier) {
+    return {
+      ...prettier.config,
+      parser: "typescript",
+    };
+  }
+
+  return constants.PRETTIER_OPTIONS;
+}
+
+module.exports = {
+  getPrettierOptions,
+};

package/src/schema.js

@@ -140,6 +140,7 @@ const getObjectTypeContent = (schema) => {
 
     return {
       $$raw: property,
+      title: property.title,
       description: _.compact([
         property.description ||
           _.compact(_.map(property[getComplexType(property)], "description"))[0] ||

package/src/swagger.js

@@ -18,7 +18,7 @@ const parseSwaggerFile = (file) => {
 };
 
 const getSwaggerFile = (pathToSwagger, urlToSwagger, disableStrictSSL, disableProxy) =>
-  new Promise((resolve) => {
+  new Promise((resolve, reject) => {
     if (pathIsExist(pathToSwagger)) {
       logger.log(`try to get swagger by path "${pathToSwagger}"`);
       resolve(getFileContent(pathToSwagger));
@@ -38,16 +38,28 @@ const getSwaggerFile = (pathToSwagger, urlToSwagger, disableStrictSSL, disablePr
       axios
         .get(urlToSwagger, axiosOptions)
         .then((res) => resolve(res.data))
-        .catch((err) => logger.error(`error while getting swagger by URL ${urlToSwagger}:`, err));
+        .catch(() => {
+          const message = `error while getting swagger by URL ${urlToSwagger}`;
+
+          logger.error(message);
+
+          reject(message);
+        });
     }
   });
 
-const getSwaggerObject = (pathToSwagger, urlToSwagger, disableStrictSSL, disableProxy) =>
+const getSwaggerObject = (
+  pathToSwagger,
+  urlToSwagger,
+  disableStrictSSL,
+  disableProxy,
+  converterOptions,
+) =>
   getSwaggerFile(pathToSwagger, urlToSwagger, disableStrictSSL, disableProxy).then((file) =>
-    convertSwaggerObject(parseSwaggerFile(file)),
+    convertSwaggerObject(parseSwaggerFile(file), converterOptions),
   );
 
-const convertSwaggerObject = (swaggerSchema) => {
+const convertSwaggerObject = (swaggerSchema, converterOptions) => {
   return new Promise((resolve) => {
     swaggerSchema.info = _.merge(
       {
@@ -63,6 +75,7 @@ const convertSwaggerObject = (swaggerSchema) => {
       converter.convertObj(
         swaggerSchema,
         {
+          ...converterOptions,
           warnOnly: true,
           refSiblings: "preserve",
           rbname: "requestBodyName",

package/src/typeFormatters.js

@@ -18,10 +18,10 @@ const formatters = {
       const extraSpace = "  ";
       const result = `${extraSpace}${part.field};\n`;
 
-      const comments = _.compact([part.title, part.description]).reduce(
+      const comments = _.uniq(_.compact([part.title, part.description]).reduce(
         (acc, comment) => [...acc, ...comment.split(/\n/g)],
         [],
-      );
+      ));
 
       const commonText = comments.length
         ? [

package/templates/base/http-clients/fetch-http-client.eta

@@ -209,7 +209,9 @@ export class HttpClient<SecurityDataType = unknown> {
                 this.abortControllers.delete(cancelToken);
             }
 
+<% if (!config.disableThrowOnError) { %>
             if (!response.ok) throw data;
+<% } %>
 <% if (config.unwrapResponseData) { %>
             return data.data;
 <% } else { %>

package/templates/modular/api.eta

@@ -8,7 +8,7 @@ const dataContracts = _.map(modelTypes, "name");
 
 <% if (config.httpClientType === config.constants.HTTP_CLIENT.AXIOS) { %> import { AxiosRequestConfig, AxiosResponse } from "axios"; <% } %>
 
-import { HttpClient, RequestParams, ContentType } from "./<%~ config.fileNames.httpClient %>";
+import { HttpClient, RequestParams, ContentType, HttpResponse } from "./<%~ config.fileNames.httpClient %>";
 <% if (dataContracts.length) { %>
 import { <%~ dataContracts.join(", ") %> } from "./<%~ config.fileNames.dataContracts %>"
 <% } %>