openapi-ts-request 0.1.0 → 0.1.2

package/README.md

@@ -4,13 +4,14 @@
 [![npm (scoped)](https://img.shields.io/npm/v/openapi-ts-request)](https://www.npmjs.com/package/openapi-ts-request)
 ![GitHub tag](https://img.shields.io/github/v/tag/openapi-ui/openapi-ts-request?include_prereleases)
 
-根据 [Swagger2/OpenAPI3](https://swagger.io/blog/news/whats-new-in-openapi-3-0/) 文档生成 ts 类型、request client 请求代码。
+根据 [Swagger2/OpenAPI3](https://swagger.io/blog/news/whats-new-in-openapi-3-0/) 文档生成 ts 类型、request client 请求代码、request mock 服务、枚举和 type 字段翻译
 
 ## Features
 
 * supports Swagger2.0/OpenAPI 3.0,3.1 specifications
-* generate TypeScript Interfaces, Reuquest clients, Display Babel
+* generate TypeScript Interfaces, Reuquest clients, Request Mock Service, Enum, Display Field Babel
 * supports Custom Request Function, Fetch、Axios、Uniapp-Request、Node.js、XHR client available
+* supports filter specifications by tags
 * supports JSON specifications
 
 ## Usage
@@ -104,9 +105,9 @@ npm run openapi
 | serversPath  | 否 | 生成的文件夹的路径 | string | './src/apis' |
 | requestLibPath  | 否 | 自定义请求方法路径 | string | - |
 | allowedTags  | 否 | 生成指定 tags 下面的 api | string[] | - |
-| requestOptionsType  | 否 | 自定义请求方法 options 参数类型 | string | '{ [key: string]: any }' |
+| requestOptionsType  | 否 | 自定义请求方法 options 参数类型 | string | '{ [key: string]: unknown }' |
 | requestImportStatement  | 否 | 自定义请求方法表达式，例如：'@/request' | string | - |
-| apiPrefix  | 否 | api 的前缀，例如："'api'" | string | - |
+| apiPrefix  | 否 | api 的前缀，例如：'api'(动态变量), 指定字符串("'api'") | string | - |
 | dataFields | 否 | 定义 response 中数据字段类型 | string[] | - |
 | mockFolder  | 否 | mock目录 | string | './mocks' |
 | nullable | 否 | 使用null代替可选 | boolean | false |
@@ -117,7 +118,7 @@ npm run openapi
 
 | 属性           | 类型 | 说明               |
 | -------------- | ---- | ------------------ |
-| afterOpenApiDataInited | (openAPIData: OpenAPIObject) => OpenAPIObject  | - |
+| afterOpenApiDataInited | (openAPIData: OpenAPIObject) => OpenAPIObject  | 自定义OpenAPI数据 |
 | customFunctionName | (data: APIDataType) => string   | 自定义请求方法函数名称 |
 | customTypeName | (data: APIDataType) => string | 自定义类型名称 |
 | customClassName | (tagName: string) => string  | 自定义类名 |

package/dist/generator/config.d.ts

@@ -10,7 +10,7 @@ export declare enum TypescriptFileType {
     displayEnumLabel = "displayEnumLabel"
 }
 export declare const DEFAULT_SCHEMA: SchemaObject;
-export declare const DEFAULT_PATH_PARAM: ParameterObject & Dictionary<any>;
+export declare const DEFAULT_PATH_PARAM: ParameterObject & Dictionary<unknown>;
 export declare enum methods {
     get = "get",
     put = "put",

package/dist/generator/serviceGenarator.d.ts

@@ -13,7 +13,7 @@ export default class ServiceGenerator {
     private getServiceTPConfigs;
     private genFileFromTemplate;
     private getTemplate;
-    private getFuncationName;
+    private getFunctionName;
     private getType;
     private getTypeName;
     private getBodyTP;

package/dist/generator/serviceGenarator.js

@@ -147,7 +147,7 @@ class ServiceGenerator {
                 if (props.length > 0) {
                     lastTypes.push({
                         typeName: this.getTypeName(Object.assign(Object.assign({}, operationObject), { method, path: pathKey })),
-                        type: 'Record<string, any>',
+                        type: 'Record<string, unknown>',
                         props: [props],
                         isEnum: false,
                     });
@@ -159,13 +159,14 @@ class ServiceGenerator {
             const result = this.resolveObject(schema);
             const getDefinesType = () => {
                 if (result === null || result === void 0 ? void 0 : result.type) {
+                    console.log('888', result);
                     return schema.type === 'object'
                         ? type_1.SchemaObjectType.object
                         : config_1.numberEnum.includes(result.type)
                             ? type_1.SchemaObjectType.number
                             : result.type;
                 }
-                return 'Record<string, any>';
+                return 'Record<string, unknown>';
             };
             // 解析 props 属性中的枚举
             if ((0, lodash_1.isArray)(result.props) && result.props.length > 0) {
@@ -187,6 +188,7 @@ class ServiceGenerator {
                 schema.isAllowed) {
                 const isEnum = result.isEnum;
                 const typeName = (0, util_1.resolveTypeName)(schemaKey);
+                console.log('name:', typeName, getDefinesType());
                 lastTypes.push({
                     typeName,
                     type: getDefinesType(),
@@ -223,7 +225,7 @@ class ServiceGenerator {
                     if (((_a = body === null || body === void 0 ? void 0 : body.mediaType) === null || _a === void 0 ? void 0 : _a.includes('form-data')) || file) {
                         formData = true;
                     }
-                    let functionName = this.getFuncationName(newApi);
+                    let functionName = this.getFunctionName(newApi);
                     if (functionName && tmpFunctionRD[functionName]) {
                         functionName = `${functionName}_${(tmpFunctionRD[functionName] += 1)}`;
                     }
@@ -335,7 +337,7 @@ class ServiceGenerator {
     getTemplate(type) {
         return (0, fs_1.readFileSync)((0, path_1.join)(this.config.templatesFolder, `${type}.njk`), 'utf8');
     }
-    getFuncationName(data) {
+    getFunctionName(data) {
         // 获取路径相同部分
         const pathBasePrefix = (0, util_1.getBasePrefix)((0, lodash_1.keys)(this.openAPIData.paths));
         return this.config.hook && this.config.hook.customFunctionName
@@ -364,10 +366,11 @@ class ServiceGenerator {
     getTypeName(data) {
         var _a, _b, _c;
         const namespace = this.config.namespace ? `${this.config.namespace}.` : '';
-        const typeName = ((_c = (_b = (_a = this.config) === null || _a === void 0 ? void 0 : _a.hook) === null || _b === void 0 ? void 0 : _b.customTypeName) === null || _c === void 0 ? void 0 : _c.call(_b, data)) || this.getFuncationName(data);
+        const typeName = ((_c = (_b = (_a = this.config) === null || _a === void 0 ? void 0 : _a.hook) === null || _b === void 0 ? void 0 : _b.customTypeName) === null || _c === void 0 ? void 0 : _c.call(_b, data)) || this.getFunctionName(data);
         return (0, util_1.resolveTypeName)(`${namespace}${typeName !== null && typeName !== void 0 ? typeName : data.operationId}Params`);
     }
     getBodyTP(requestBody) {
+        var _a;
         const reqBody = this.resolveRefObject(requestBody);
         if ((0, lodash_1.isEmpty)(reqBody)) {
             return null;
@@ -377,7 +380,7 @@ class ServiceGenerator {
             return null;
         }
         let mediaType = (0, lodash_1.keys)(reqContent)[0];
-        const schema = reqContent[mediaType].schema || config_1.DEFAULT_SCHEMA;
+        const schema = ((_a = reqContent[mediaType]) === null || _a === void 0 ? void 0 : _a.schema) || config_1.DEFAULT_SCHEMA;
         if (mediaType === '*/*') {
             mediaType = '';
         }
@@ -448,7 +451,7 @@ class ServiceGenerator {
             this.resolveRefObject(responses.default || responses['200'] || responses['201']);
         const defaultResponse = {
             mediaType: '*/*',
-            type: 'any',
+            type: 'unknown',
         };
         if (!response) {
             return defaultResponse;
@@ -558,8 +561,8 @@ class ServiceGenerator {
                 type: `${refPaths[refPaths.length - 1]}[]`,
             };
         }
-        // 这里需要解析出具体属性，但由于 parser 层还不确定，所以暂时先返回 any[]
-        return { type: 'any[]' };
+        // 这里需要解析出具体属性，但由于 parser 层还不确定，所以暂时先返回 unknown[]
+        return { type: 'unknown[]' };
     }
     resolveProperties(schemaObject) {
         return {

package/dist/generator/util.js

@@ -66,7 +66,7 @@ function getRefName(refObject) {
 function getDefaultType(schemaObject, namespace = '', schemas) {
     var _a, _b;
     if ((0, lodash_1.isUndefined)(schemaObject) || (0, lodash_1.isNull)(schemaObject)) {
-        return 'any';
+        return 'unknown';
     }
     if (!(0, lodash_1.isObject)(schemaObject)) {
         return schemaObject;
@@ -146,7 +146,7 @@ function getDefaultType(schemaObject, namespace = '', schemas) {
     }
     if (schemaObject.type === 'object' || schemaObject.properties) {
         if (!(0, lodash_1.keys)(schemaObject.properties).length) {
-            return 'Record<string, any>';
+            return 'Record<string, unknown>';
         }
         return `{ ${(0, lodash_1.keys)(schemaObject.properties)
             .map((key) => {
@@ -173,7 +173,7 @@ function getDefaultType(schemaObject, namespace = '', schemas) {
         })
             .join('')}}`;
     }
-    return 'any';
+    return 'unknown';
 }
 exports.getDefaultType = getDefaultType;
 function getDefaultFileTag(operationObject, apiPath) {

package/dist/index.js

@@ -17,7 +17,7 @@ function generateService(_a) {
             return;
         }
         const requestImportStatement = (0, util_1.getImportStatement)(requestLibPath);
-        const serviceGenerator = new serviceGenarator_1.default(Object.assign({ schemaPath, serversPath: './src/apis', requestImportStatement, requestOptionsType: '{[key: string]: any}', namespace: 'API', nullable: false, isCamelCase: true, allowedTags: allowedTags
+        const serviceGenerator = new serviceGenarator_1.default(Object.assign({ schemaPath, serversPath: './src/apis', requestImportStatement, requestOptionsType: '{[key: string]: unknown}', namespace: 'API', nullable: false, isCamelCase: true, allowedTags: allowedTags
                 ? (0, lodash_1.map)(allowedTags, (item) => item.toLowerCase())
                 : null }, rest), openAPI);
         serviceGenerator.genFile();

package/dist/type.d.ts

@@ -36,7 +36,7 @@ export type ParameterObject = Modify<OpenAPIV3.ParameterObject, {
 }>;
 export type ResponsesObject = OpenAPIV3.ResponsesObject;
 export type ResponseObject = OpenAPIV3.ResponseObject & {
-    example?: any;
+    example?: unknown;
 };
 export type RequestBodyObject = OpenAPIV3.RequestBodyObject;
 export type ContentObject = {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "openapi-ts-request",
-  "version": "0.1.0",
-  "description": "Swagger2/OpenAPI3 to TypeScript, Request Client, Display Label",
+  "version": "0.1.2",
+  "description": "Swagger2/OpenAPI3 to TypeScript, Request Client, Request Mock Service, Enum, Display Field Label",
   "packageManager": "pnpm@9.4.0",
   "repository": {
     "type": "git",
@@ -10,7 +10,7 @@
   "license": "MIT",
   "author": "rookie-luochao",
   "main": "dist/index.js",
-  "types": "index.d.ts",
+  "types": "dist/index.d.ts",
   "bin": {
     "openapi-ts-request": "dist/cli.js"
   },
@@ -23,6 +23,7 @@
     "start": "tsc -w",
     "build": "tsc",
     "changeset": "changeset",
+    "prepublish:test": "npm run build && np --no-cleanup --yolo --no-publish --any-branch",
     "lint": "eslint ./src --report-unused-disable-directives --max-warnings=0",
     "lint:fix": "eslint ./src --report-unused-disable-directives --max-warnings=0 --fix",
     "test": "rm -rf ./test/apis/ ./test/mocks && npm run build && cd ./test && node ./test.js && cd ..",

package/templates/serviceController.njk

@@ -98,7 +98,7 @@ export async function {{ api.functionName }}(
   {% if api.body %}
   Object.keys(body).forEach(ele => {
     {% if genType === "ts" %}
-    const item = (body as any)[ele];
+    const item = (body as { [key: string]: any })[ele];
     {% else %}
     const item = body[ele];
     {% endif %}