openapi-ts-request 0.4.5 → 0.4.7

package/README.md

@@ -33,14 +33,18 @@ pnpm i openapi-ts-request -D
 > 配置文件还支持 ***.openapi-ts-request.ts***, ***openapi-ts-request.config.cjs*** 等格式，参考 [cosmiconfig](https://github.com/cosmiconfig/cosmiconfig?tab=readme-ov-file#cosmiconfig)
 
 ```ts
+import type { GenerateServiceProps } from 'openapi-ts-request'
+
 export default {
   schemaPath: 'http://petstore.swagger.io/v2/swagger.json',
-}
+} as GenerateServiceProps
 ```
 
 支持传入数组配置进行生成
 
 ```ts
+import type { GenerateServiceProps } from 'openapi-ts-request'
+
 export default [
   {
     schemaPath: 'http://app.swagger.io/v2/swagger.json',
@@ -50,7 +54,7 @@ export default [
     schemaPath: 'http://auth.swagger.io/v2/swagger.json',
     serversPath: './src/apis/auth',
   }
-]
+] as GenerateServiceProps[]
 ```
 
 在 ```package.json``` 的 ```script``` 中添加命令: ```"openapi": "openapi-ts",```
@@ -129,21 +133,20 @@ $ openapi --help
   Options:
     -V, --version                      output the version number
     -i, --input <string>               OpenAPI specification, can be a path, url (required)
-    -o, --output <string>              Output directory (required)
+    -o, --output <string>              output directory (required)
     --requestLibPath <string>          custom request lib path, for example: "@/request", "node-fetch"
-    --allowedTags <string[]>           Generate results from allowed tags
-    --requestOptionsType <string>      Custom request method options parameter type (default: "{ [key:
+    --allowedTags <string[]>           generate results from allowed tags
+    --requestOptionsType <string>      custom request method options parameter type (default: "{ [key:
                                       string]: unknown }")
     --requestImportStatement <string>  custom request import statement, for example: "const request =
-                                      require(`@/request`)"
-    --apiPrefix <string>               Custom the prefix of the api path, for example: "api"(variable),
-                                      `"api"`(string)
-    --isDisplayTypeLabel <boolean>     Generate label matching type field (default: false) (default: false)
-    --isGenJsonSchemas <boolean>       Generate JSON Schemas (default: false) (default: false)
-    --mockFolder <string>              Mock file path, (default: "./mocks")
-    --nullable <boolean>               null instead of optional (default: false) (default: false)
-    --isCamelCase <boolean>            CamelCase naming of controller files and request client (default: true)
-                                      (default: true)
+                                      require('@/request')"
+    --apiPrefix <string>               custom the prefix of the api path, for example: "api"(variable),
+                                      "'api'"(string)
+    --isDisplayTypeLabel <boolean>     generate label matching type field (default: false)
+    --isGenJsonSchemas <boolean>       generate JSON Schemas (default: false)
+    --mockFolder <string>              mock file path (default: "./mocks")
+    --nullable <boolean>               null instead of optional (default: false)
+    --isCamelCase <boolean>            camelCase naming of controller files and request client (default: true)
     -h, --help                         display help for command
 ```
 

package/dist/bin/openapi.js

@@ -11,17 +11,17 @@ const params = commander_1.program
     .usage('[options]')
     .version(pkg.version)
     .requiredOption('-i, --input <string>', 'OpenAPI specification, can be a path, url (required)')
-    .requiredOption('-o, --output <string>', 'Output directory (required)')
+    .requiredOption('-o, --output <string>', 'output directory (required)')
     .option('--requestLibPath <string>', 'custom request lib path, for example: "@/request", "node-fetch"')
-    .option('--allowedTags <string[]>', 'Generate results from allowed tags')
-    .option('--requestOptionsType <string>', 'Custom request method options parameter type (default: "{ [key: string]: unknown }")')
-    .option('--requestImportStatement <string>', 'custom request import statement, for example: "const request = require(`@/request`)"')
-    .option('--apiPrefix <string>', 'Custom the prefix of the api path, for example: "api"(variable), `"api"`(string)')
-    .option('--isDisplayTypeLabel <boolean>', 'Generate label matching type field (default: false)', false)
-    .option('--isGenJsonSchemas <boolean>', 'Generate JSON Schemas (default: false)', false)
-    .option('--mockFolder <string>', 'Mock file path, (default: "./mocks")')
-    .option('--nullable <boolean>', 'null instead of optional (default: false)', false)
-    .option('--isCamelCase <boolean>', 'CamelCase naming of controller files and request client (default: true)', true)
+    .option('--allowedTags <string[]>', 'generate results from allowed tags')
+    .option('--requestOptionsType <string>', 'custom request method options parameter type (default: "{ [key: string]: unknown }")')
+    .option('--requestImportStatement <string>', `custom request import statement, for example: "const request = require('@/request')"`)
+    .option('--apiPrefix <string>', `custom the prefix of the api path, for example: "api"(variable), "'api'"(string)`)
+    .option('--isDisplayTypeLabel <boolean>', 'generate label matching type field', false)
+    .option('--isGenJsonSchemas <boolean>', 'generate JSON Schemas', false)
+    .option('--mockFolder <string>', 'Mock file path (default: "./mocks")')
+    .option('--nullable <boolean>', 'null instead of optional', false)
+    .option('--isCamelCase <boolean>', 'camelCase naming of controller files and request client', true)
     .parse(process.argv)
     .opts();
 function getPath(path) {

package/dist/generator/serviceGenarator.js

@@ -79,11 +79,14 @@ class ServiceGenerator {
             list: interfaceTPConfigs,
         });
         // 生成枚举翻译
-        this.genFileFromTemplate(`${config_1.displayEnumLabelFileName}.ts`, config_1.TypescriptFileType.displayEnumLabel, {
-            list: (0, lodash_1.filter)(interfaceTPConfigs, (item) => item.isEnum),
-            namespace: this.config.namespace,
-            interfaceFileName: config_1.interfaceFileName,
-        });
+        const enums = (0, lodash_1.filter)(interfaceTPConfigs, (item) => item.isEnum);
+        if (!(0, lodash_1.isEmpty)(enums)) {
+            this.genFileFromTemplate(`${config_1.displayEnumLabelFileName}.ts`, config_1.TypescriptFileType.displayEnumLabel, {
+                list: enums,
+                namespace: this.config.namespace,
+                interfaceFileName: config_1.interfaceFileName,
+            });
+        }
         // 生成 type 翻译
         if (this.config.isDisplayTypeLabel) {
             this.genFileFromTemplate(`${config_1.displayTypeLabelFileName}.ts`, config_1.TypescriptFileType.displayTypeLabel, {
@@ -206,7 +209,7 @@ class ServiceGenerator {
             }
             // 判断哪些 schema 需要添加进 type, schemas 渲染数组
             if ((0, lodash_1.isEmpty)(this.config.allowedTags) ||
-                schema.isAllowed) {
+                (schema === null || schema === void 0 ? void 0 : schema.isAllowed)) {
                 const isEnum = result.isEnum;
                 const typeName = (0, util_1.resolveTypeName)(schemaKey);
                 lastTypes.push({

package/dist/generator/util.js

@@ -279,7 +279,7 @@ function markAllowSchema(schemaStr, schemas) {
     (0, lodash_1.forEach)(refs, (ref) => {
         const refPaths = ref.split('/');
         const schema = schemas === null || schemas === void 0 ? void 0 : schemas[refPaths[refPaths.length - 1]];
-        if (!(schema === null || schema === void 0 ? void 0 : schema.isAllowed)) {
+        if (schema && !schema.isAllowed) {
             schema.isAllowed = true;
             markAllowSchema(JSON.stringify(schema), schemas);
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-ts-request",
-  "version": "0.4.5",
+  "version": "0.4.7",
   "description": "Swagger2/OpenAPI3 to TypeScript, request client, request mock service, enum, type field label, JSON Schemas",
   "repository": {
     "type": "git",