swagger-typescript-api 10.0.2 → 10.0.3

package/src/index.js

@@ -1,271 +1,271 @@
-#!/usr/bin/env node
-
-// Copyright (c) 2019-present acacode
-// Node module: swagger-typescript-api
-// This file is licensed under the MIT License.
-// License text available at https://opensource.org/licenses/MIT
-// Repository https://github.com/acacode/swagger-typescript-api
-
-const _ = require("lodash");
-const { parseSchemas } = require("./schema");
-const { parseRoutes, groupRoutes } = require("./routes");
-const { createApiConfig } = require("./apiConfig");
-const { prepareModelType } = require("./modelTypes");
-const { getSwaggerObject, fixSwaggerScheme, convertSwaggerObject } = require("./swagger");
-const { createComponentsMap, filterComponentsMap } = require("./components");
-const { createFile, pathIsExist, pathIsDir, createDir, cleanDir } = require("./files");
-const { addToConfig, config } = require("./config");
-const { getTemplates, getTemplatePaths, renderTemplate, getTemplate } = require("./templates");
-const constants = require("./constants");
-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,
-  generateApi: ({
-    input,
-    output,
-    url,
-    spec,
-    name: fileName,
-    toJS: translateToJavaScript = config.toJS,
-    modular,
-    templates,
-    generateResponses = config.generateResponses,
-    defaultResponseAsSuccess = config.defaultResponseAsSuccess,
-    generateRouteTypes = config.generateRouteTypes,
-    generateClient = config.generateClient,
-    httpClientType = config.httpClientType,
-    generateUnionEnums = config.generateUnionEnums,
-    addReadonly = config.addReadonly,
-    moduleNameIndex = config.moduleNameIndex,
-    moduleNameFirstTag = config.moduleNameFirstTag,
-    extractRequestParams = config.extractRequestParams,
-    extractRequestBody = config.extractRequestBody,
-    extractResponseBody = config.extractResponseBody,
-    extractResponseError = config.extractResponseError,
-    defaultResponseType = config.defaultResponseType,
-    unwrapResponseData = config.unwrapResponseData,
-    disableThrowOnError = config.disableThrowOnError,
-    sortTypes = config.sortTypes,
-    singleHttpClient = config.singleHttpClient,
-    prettier: prettierOptions = getPrettierOptions(),
-    hooks: rawHooks,
-    extraTemplates,
-    enumNamesAsValues,
-    disableStrictSSL = config.disableStrictSSL,
-    disableProxy = config.disableProxy,
-    cleanOutput,
-    silent = config.silent,
-    typePrefix = config.typePrefix,
-    typeSuffix = config.typeSuffix,
-    patch = config.patch,
-    authorizationToken,
-    apiClassName = config.apiClassName,
-    debug = config.debug,
-  }) =>
-    new Promise((resolve, reject) => {
-      addToConfig({
-        defaultResponseAsSuccess,
-        generateRouteTypes,
-        generateClient,
-        httpClientType,
-        generateResponses,
-        templates,
-        generateUnionEnums,
-        addReadonly,
-        moduleNameIndex,
-        moduleNameFirstTag,
-        prettierOptions,
-        modular,
-        extractRequestParams,
-        extractRequestBody,
-        extractResponseBody,
-        extractResponseError,
-        hooks: _.merge(config.hooks, rawHooks || {}),
-        enumNamesAsValues,
-        disableStrictSSL,
-        disableProxy,
-        cleanOutput,
-        defaultResponseType,
-        unwrapResponseData,
-        disableThrowOnError,
-        sortTypes,
-        singleHttpClient,
-        constants,
-        silent,
-        toJS: translateToJavaScript,
-        typePrefix,
-        typeSuffix,
-        patch,
-        apiClassName,
-        debug,
-      });
-      (spec
-        ? convertSwaggerObject(spec, { patch })
-        : getSwaggerObject(input, url, disableStrictSSL, disableProxy, authorizationToken, { patch })
-      )
-        .then(({ usageSchema, originalSchema }) => {
-          const templatePaths = getTemplatePaths(config);
-
-          addToConfig({ templatePaths });
-
-          const templatesToRender = getTemplates(config);
-
-          logger.event("start generating your typescript api");
-
-          fixSwaggerScheme(usageSchema, originalSchema);
-
-          addToConfig({
-            swaggerSchema: usageSchema,
-            originalSchema,
-            templatesToRender,
-          });
-
-          const { components } = usageSchema;
-
-          addToConfig(config.hooks.onInit(config) || config);
-
-          const componentsMap = createComponentsMap(components);
-
-          const componentSchemasNames = filterComponentsMap(componentsMap, "schemas").map((c) => c.typeName);
-
-          addToConfig({
-            componentTypeNameResolver: new ComponentTypeNameResolver(componentSchemasNames),
-          });
-
-          const parsedSchemas = parseSchemas(components);
-
-          config.routeNameDuplicatesMap.clear();
-
-          const routes = parseRoutes({
-            usageSchema,
-            parsedSchemas,
-            moduleNameIndex,
-            moduleNameFirstTag,
-            extractRequestParams,
-          });
-
-          const hasSecurityRoutes = routes.some((route) => route.security);
-          const hasQueryRoutes = routes.some((route) => route.hasQuery);
-          const hasFormDataRoutes = routes.some((route) => route.hasFormDataParams);
-
-          const usageComponentSchemas = filterComponentsMap(componentsMap, "schemas");
-          const sortByProperty = (propertyName) => (o1, o2) => {
-            if (o1[propertyName] > o2[propertyName]) {
-              return 1;
-            }
-            if (o1[propertyName] < o2[propertyName]) {
-              return -1;
-            }
-            return 0;
-          };
-
-          const sortSchemas = (schemas) => {
-            if (config.sortTypes) {
-              return schemas.sort(sortByProperty("typeName")).map((schema) => {
-                if (schema.rawTypeData?.properties) {
-                  return {
-                    ...schema,
-                    rawTypeData: {
-                      ...schema.rawTypeData,
-                      $parsed: schema.rawTypeData["$parsed"] && {
-                        ...schema.rawTypeData["$parsed"],
-                        content: Array.isArray(schema.rawTypeData["$parsed"].content)
-                          ? schema.rawTypeData["$parsed"].content.sort(sortByProperty("name"))
-                          : schema.rawTypeData["$parsed"].content,
-                      },
-                    },
-                  };
-                }
-                return schema;
-              });
-            }
-            return schemas;
-          };
-
-          const rawConfiguration = {
-            apiConfig: createApiConfig(usageSchema),
-            config,
-            modelTypes: _.map(sortSchemas(usageComponentSchemas), prepareModelType),
-            rawModelTypes: usageComponentSchemas,
-            hasFormDataRoutes,
-            hasSecurityRoutes,
-            hasQueryRoutes,
-            generateResponses,
-            routes: groupRoutes(routes),
-            extraTemplates,
-            fileName,
-            translateToJavaScript,
-            utils: {
-              ...require("./render/utils"),
-              ...require("./common"),
-            },
-          };
-
-          const configuration = config.hooks.onPrepareConfig(rawConfiguration) || rawConfiguration;
-
-          if (pathIsExist(output)) {
-            if (cleanOutput) {
-              cleanDir(output);
-            }
-          } else {
-            createDir(output);
-          }
-
-          const files = generateOutputFiles({
-            modular,
-            templatesToRender,
-            configuration,
-          });
-
-          const isDirPath = pathIsDir(output);
-
-          const generatedFiles = files.map((file) => {
-            if (!isDirPath) return file;
-
-            if (translateToJavaScript) {
-              createFile({
-                path: output,
-                fileName: file.name,
-                content: file.content,
-                withPrefix: true,
-              });
-              createFile({
-                path: output,
-                fileName: file.declaration.name,
-                content: file.declaration.content,
-                withPrefix: true,
-              });
-              logger.success(`javascript api file`, file.name, `created in ${output}`);
-            } else {
-              createFile({
-                path: output,
-                fileName: file.name,
-                content: file.content,
-                withPrefix: true,
-              });
-              logger.success(`typescript api file`, file.name, `created in ${output}`);
-            }
-
-            return file;
-          });
-
-          resolve({
-            files: generatedFiles,
-            configuration,
-            getTemplate,
-            renderTemplate,
-            createFile,
-            formatTSContent: formatFileContent,
-          });
-        })
-        .catch((e) => {
-          reject(e);
-          throw new Error("Swagger schema parse error!\r\n " + e);
-        });
-    }),
-};
+#!/usr/bin/env node
+
+// Copyright (c) 2019-present acacode
+// Node module: swagger-typescript-api
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+// Repository https://github.com/acacode/swagger-typescript-api
+
+const _ = require("lodash");
+const { parseSchemas } = require("./schema");
+const { parseRoutes, groupRoutes } = require("./routes");
+const { createApiConfig } = require("./apiConfig");
+const { prepareModelType } = require("./modelTypes");
+const { getSwaggerObject, fixSwaggerScheme, convertSwaggerObject } = require("./swagger");
+const { createComponentsMap, filterComponentsMap } = require("./components");
+const { createFile, pathIsExist, pathIsDir, createDir, cleanDir } = require("./files");
+const { addToConfig, config } = require("./config");
+const { getTemplates, getTemplatePaths, renderTemplate, getTemplate } = require("./templates");
+const constants = require("./constants");
+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,
+  generateApi: ({
+    input,
+    output,
+    url,
+    spec,
+    name: fileName,
+    toJS: translateToJavaScript = config.toJS,
+    modular,
+    templates,
+    generateResponses = config.generateResponses,
+    defaultResponseAsSuccess = config.defaultResponseAsSuccess,
+    generateRouteTypes = config.generateRouteTypes,
+    generateClient = config.generateClient,
+    httpClientType = config.httpClientType,
+    generateUnionEnums = config.generateUnionEnums,
+    addReadonly = config.addReadonly,
+    moduleNameIndex = config.moduleNameIndex,
+    moduleNameFirstTag = config.moduleNameFirstTag,
+    extractRequestParams = config.extractRequestParams,
+    extractRequestBody = config.extractRequestBody,
+    extractResponseBody = config.extractResponseBody,
+    extractResponseError = config.extractResponseError,
+    defaultResponseType = config.defaultResponseType,
+    unwrapResponseData = config.unwrapResponseData,
+    disableThrowOnError = config.disableThrowOnError,
+    sortTypes = config.sortTypes,
+    singleHttpClient = config.singleHttpClient,
+    prettier: prettierOptions = getPrettierOptions(),
+    hooks: rawHooks,
+    extraTemplates,
+    enumNamesAsValues,
+    disableStrictSSL = config.disableStrictSSL,
+    disableProxy = config.disableProxy,
+    cleanOutput,
+    silent = config.silent,
+    typePrefix = config.typePrefix,
+    typeSuffix = config.typeSuffix,
+    patch = config.patch,
+    authorizationToken,
+    apiClassName = config.apiClassName,
+    debug = config.debug,
+  }) =>
+    new Promise((resolve, reject) => {
+      addToConfig({
+        defaultResponseAsSuccess,
+        generateRouteTypes,
+        generateClient,
+        httpClientType,
+        generateResponses,
+        templates,
+        generateUnionEnums,
+        addReadonly,
+        moduleNameIndex,
+        moduleNameFirstTag,
+        prettierOptions,
+        modular,
+        extractRequestParams,
+        extractRequestBody,
+        extractResponseBody,
+        extractResponseError,
+        hooks: _.merge(config.hooks, rawHooks || {}),
+        enumNamesAsValues,
+        disableStrictSSL,
+        disableProxy,
+        cleanOutput,
+        defaultResponseType,
+        unwrapResponseData,
+        disableThrowOnError,
+        sortTypes,
+        singleHttpClient,
+        constants,
+        silent,
+        toJS: translateToJavaScript,
+        typePrefix,
+        typeSuffix,
+        patch,
+        apiClassName,
+        debug,
+      });
+      (spec
+        ? convertSwaggerObject(spec, { patch })
+        : getSwaggerObject(input, url, disableStrictSSL, disableProxy, authorizationToken, { patch })
+      )
+        .then(({ usageSchema, originalSchema }) => {
+          const templatePaths = getTemplatePaths(config);
+
+          addToConfig({ templatePaths });
+
+          const templatesToRender = getTemplates(config);
+
+          logger.event("start generating your typescript api");
+
+          fixSwaggerScheme(usageSchema, originalSchema);
+
+          addToConfig({
+            swaggerSchema: usageSchema,
+            originalSchema,
+            templatesToRender,
+          });
+
+          const { components } = usageSchema;
+
+          addToConfig(config.hooks.onInit(config) || config);
+
+          const componentsMap = createComponentsMap(components);
+
+          const componentSchemasNames = filterComponentsMap(componentsMap, "schemas").map((c) => c.typeName);
+
+          addToConfig({
+            componentTypeNameResolver: new ComponentTypeNameResolver(componentSchemasNames),
+          });
+
+          const parsedSchemas = parseSchemas(components);
+
+          config.routeNameDuplicatesMap.clear();
+
+          const routes = parseRoutes({
+            usageSchema,
+            parsedSchemas,
+            moduleNameIndex,
+            moduleNameFirstTag,
+            extractRequestParams,
+          });
+
+          const hasSecurityRoutes = routes.some((route) => route.security);
+          const hasQueryRoutes = routes.some((route) => route.hasQuery);
+          const hasFormDataRoutes = routes.some((route) => route.hasFormDataParams);
+
+          const usageComponentSchemas = filterComponentsMap(componentsMap, "schemas");
+          const sortByProperty = (propertyName) => (o1, o2) => {
+            if (o1[propertyName] > o2[propertyName]) {
+              return 1;
+            }
+            if (o1[propertyName] < o2[propertyName]) {
+              return -1;
+            }
+            return 0;
+          };
+
+          const sortSchemas = (schemas) => {
+            if (config.sortTypes) {
+              return schemas.sort(sortByProperty("typeName")).map((schema) => {
+                if (schema.rawTypeData?.properties) {
+                  return {
+                    ...schema,
+                    rawTypeData: {
+                      ...schema.rawTypeData,
+                      $parsed: schema.rawTypeData["$parsed"] && {
+                        ...schema.rawTypeData["$parsed"],
+                        content: Array.isArray(schema.rawTypeData["$parsed"].content)
+                          ? schema.rawTypeData["$parsed"].content.sort(sortByProperty("name"))
+                          : schema.rawTypeData["$parsed"].content,
+                      },
+                    },
+                  };
+                }
+                return schema;
+              });
+            }
+            return schemas;
+          };
+
+          const rawConfiguration = {
+            apiConfig: createApiConfig(usageSchema),
+            config,
+            modelTypes: _.map(sortSchemas(usageComponentSchemas), prepareModelType),
+            rawModelTypes: usageComponentSchemas,
+            hasFormDataRoutes,
+            hasSecurityRoutes,
+            hasQueryRoutes,
+            generateResponses,
+            routes: groupRoutes(routes),
+            extraTemplates,
+            fileName,
+            translateToJavaScript,
+            utils: {
+              ...require("./render/utils"),
+              ...require("./common"),
+            },
+          };
+
+          const configuration = config.hooks.onPrepareConfig(rawConfiguration) || rawConfiguration;
+
+          if (pathIsExist(output)) {
+            if (cleanOutput) {
+              cleanDir(output);
+            }
+          } else {
+            createDir(output);
+          }
+
+          const files = generateOutputFiles({
+            modular,
+            templatesToRender,
+            configuration,
+          });
+
+          const isDirPath = pathIsDir(output);
+
+          const generatedFiles = files.map((file) => {
+            if (!isDirPath) return file;
+
+            if (translateToJavaScript) {
+              createFile({
+                path: output,
+                fileName: file.name,
+                content: file.content,
+                withPrefix: true,
+              });
+              createFile({
+                path: output,
+                fileName: file.declaration.name,
+                content: file.declaration.content,
+                withPrefix: true,
+              });
+              logger.success(`javascript api file`, file.name, `created in ${output}`);
+            } else {
+              createFile({
+                path: output,
+                fileName: file.name,
+                content: file.content,
+                withPrefix: true,
+              });
+              logger.success(`typescript api file`, file.name, `created in ${output}`);
+            }
+
+            return file;
+          });
+
+          resolve({
+            files: generatedFiles,
+            configuration,
+            getTemplate,
+            renderTemplate,
+            createFile,
+            formatTSContent: formatFileContent,
+          });
+        })
+        .catch((e) => {
+          reject(e);
+          throw new Error("Swagger schema parse error!\r\n " + e);
+        });
+    }),
+};

package/src/logger.js

@@ -1,59 +1,68 @@
-const _ = require("lodash");
-const { config } = require("./config");
-const { emojify, emoji } = require("node-emoji");
-
-/**
- *
- * @param {{ type: "warn" | "log" | "error", emojiName: keyof emoji, messages: unknown[] }} payload
- * @returns {void}
- */
-const createLogMessage = ({ type, emojiName, messages }) => {
-  if (config.silent) return;
-
-  const emoji = emojify(emojiName);
-
-  console[type](
-    emoji,
-    " ",
-    ..._.map(messages, (message) =>
-      _.startsWith(message, "\n") ? `\n${emoji}   ${message.replace(/\n/, "")}` : message,
-    ),
-  );
-};
-
-const logger = {
-  log: (...messages) =>
-    createLogMessage({
-      type: "log",
-      emojiName: ":sparkles:",
-      messages,
-    }),
-  event: (...messages) =>
-    createLogMessage({
-      type: "log",
-      emojiName: ":comet: ",
-      messages,
-    }),
-  success: (...messages) =>
-    createLogMessage({
-      type: "log",
-      emojiName: ":white_check_mark:",
-      messages,
-    }),
-  warn: (...messages) =>
-    createLogMessage({
-      type: "warn",
-      emojiName: ":warning: ",
-      messages,
-    }),
-  error: (...messages) =>
-    createLogMessage({
-      type: "error",
-      emojiName: ":exclamation:",
-      messages,
-    }),
-};
-
-module.exports = {
-  logger,
-};
+const _ = require("lodash");
+const { config } = require("./config");
+const { emojify, emoji } = require("node-emoji");
+
+let firstLog = true;
+
+/**
+ *
+ * @param {{ type: "warn" | "log" | "error", emojiName: keyof emoji, messages: unknown[] }} payload
+ * @returns {void}
+ */
+const createLogMessage = ({ type, emojiName, messages }) => {
+  if (config.silent) return;
+
+  const emoji = emojify(emojiName);
+
+  if (firstLog) {
+    firstLog = false;
+    logger.log(
+      `swagger-typescript-api(${config.version}),${process.env.npm_config_user_agent || `nodejs(${process.version})`}`,
+    );
+  }
+
+  console[type](
+    emoji,
+    " ",
+    ..._.map(messages, (message) =>
+      _.startsWith(message, "\n") ? `\n${emoji}   ${message.replace(/\n/, "")}` : message,
+    ),
+  );
+};
+
+const logger = {
+  log: (...messages) =>
+    createLogMessage({
+      type: "log",
+      emojiName: ":sparkles:",
+      messages,
+    }),
+  event: (...messages) =>
+    createLogMessage({
+      type: "log",
+      emojiName: ":comet: ",
+      messages,
+    }),
+  success: (...messages) =>
+    createLogMessage({
+      type: "log",
+      emojiName: ":white_check_mark:",
+      messages,
+    }),
+  warn: (...messages) =>
+    createLogMessage({
+      type: "warn",
+      emojiName: ":warning: ",
+      messages,
+    }),
+  error: (...messages) =>
+    createLogMessage({
+      type: "error",
+      emojiName: ":exclamation:",
+      messages,
+    }),
+};
+
+module.exports = {
+  logger,
+};