openapi-ts-request 0.4.10 → 0.5.0

package/README.md

@@ -11,9 +11,9 @@
 - 支持 Swagger2.0/OpenAPI 3.0,3.1 定义
 - 生成 TS 类型, 请求客户端, 请求模拟服务, 枚举, 类型字段翻译, JSON Schemas
 - 支持通过 npx、CLI、Nodejs 的方式使用
-- 支持自定义请求工具函数, 支持 Fetch、Axios、UniApp-Request、Node.js、XHR 客户端
+- 支持自定义请求工具函数, 支持 Fetch、Axios、[UniApp-Request](https://github.com/openapi-ui/openapi-ts-request/issues/46)、Node.js、XHR 客户端
 - 支持通过 tags 过滤生成结果
-- 支持 JSON 定义文件
+- 支持 JSON/YAML 定义文件
 
 ## 使用
 
@@ -200,6 +200,10 @@ export declare function patchSchema<T extends object>(
 
 目前使用 [mockjs](http://mockjs.com) 生成 mock 数据，mocks 文件启动需要借助 [@umijs/server](https://umijs.org/docs/guides/mock)，后面会寻找其他方案以达到更好的 mock 体验
 
+## 适配uniapp
+
+适配 uniapp 推荐采用自定义 request 函数的方式，你也可以使用 `@uni-helper/axios-adapter` 适配器，详情见 [issue#46](https://github.com/openapi-ui/openapi-ts-request/issues/46)
+
 ## 贡献
 
 ### 环境要求

package/dist/generator/serviceGenarator.js

@@ -167,9 +167,10 @@ class ServiceGenerator {
                         type: this.getType(parameter.schema),
                     });
                 });
-                if (props.length > 0) {
+                const typeName = this.getTypeName(Object.assign(Object.assign({}, operationObject), { method, path: pathKey }));
+                if (props.length > 0 && typeName) {
                     lastTypes.push({
-                        typeName: this.getTypeName(Object.assign(Object.assign({}, operationObject), { method, path: pathKey })),
+                        typeName,
                         type: 'Record<string, unknown>',
                         props: [props],
                         isEnum: false,
@@ -212,16 +213,18 @@ class ServiceGenerator {
                 (schema === null || schema === void 0 ? void 0 : schema.isAllowed)) {
                 const isEnum = result.isEnum;
                 const typeName = (0, util_1.resolveTypeName)(schemaKey);
-                lastTypes.push({
-                    typeName,
-                    type: getDefinesType(),
-                    props: (result.props || []),
-                    isEnum,
-                    displayLabelFuncName: isEnum
-                        ? (0, lodash_1.camelCase)(`display-${typeName}-Enum`)
-                        : '',
-                    enumLabelType: isEnum ? result.enumLabelType : '',
-                });
+                if (typeName) {
+                    lastTypes.push({
+                        typeName,
+                        type: getDefinesType(),
+                        props: (result.props || []),
+                        isEnum,
+                        displayLabelFuncName: isEnum
+                            ? (0, lodash_1.camelCase)(`display-${typeName}-Enum`)
+                            : '',
+                        enumLabelType: isEnum ? result.enumLabelType : '',
+                    });
+                }
                 if (this.config.isGenJsonSchemas) {
                     this.schemaList.push({
                         typeName: `$${(0, util_1.resolveTypeName)(schemaKey)}`,
@@ -529,15 +532,16 @@ class ServiceGenerator {
                     .map((p) => this.resolveRefObject(p))
                     .filter((p) => p.in === source)
                     .map((p) => {
-                    var _a, _b, _c, _d;
-                    const isDirectObject = (((_a = p.schema) === null || _a === void 0 ? void 0 : _a.type) ||
+                    var _a, _b, _c, _d, _e;
+                    const isDirectObject = (((_a = p.schema) === null || _a === void 0 ? void 0 : _a.type) === 'object' ||
                         p.type) === 'object';
                     const refList = (((_b = p.schema) === null || _b === void 0 ? void 0 : _b.$ref) ||
                         p.$ref ||
                         '').split('/');
                     const ref = refList[refList.length - 1];
                     const deRefObj = (0, lodash_1.entries)((_c = this.openAPIData.components) === null || _c === void 0 ? void 0 : _c.schemas).find(([k]) => k === ref) || [];
-                    const isRefObject = ((_d = deRefObj[1]) === null || _d === void 0 ? void 0 : _d.type) === 'object';
+                    const isRefObject = ((_d = deRefObj[1]) === null || _d === void 0 ? void 0 : _d.type) === 'object' &&
+                        !(0, lodash_1.isEmpty)((_e = deRefObj[1]) === null || _e === void 0 ? void 0 : _e.properties);
                     return Object.assign(Object.assign({}, p), { isObject: isDirectObject || isRefObject, type: this.getType(p.schema || config_1.DEFAULT_SCHEMA, this.config.namespace) });
                 });
                 if (params.length) {

package/dist/util.d.ts

@@ -1,2 +1,4 @@
+import { OpenAPI } from 'openapi-types';
 export declare const getImportStatement: (requestLibPath: string) => string;
-export declare const getOpenAPIConfig: (schemaPath: string) => Promise<unknown>;
+export declare const getOpenAPIConfig: (schemaPath: string) => Promise<OpenAPI.Document<{}>>;
+export declare function parseSwaggerOrOpenapi(content: string | OpenAPI.Document): Promise<OpenAPI.Document<{}>>;

package/dist/util.js

@@ -1,10 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getOpenAPIConfig = exports.getImportStatement = void 0;
+exports.parseSwaggerOrOpenapi = exports.getOpenAPIConfig = exports.getImportStatement = void 0;
 const tslib_1 = require("tslib");
 const axios_1 = tslib_1.__importDefault(require("axios"));
 const http_1 = tslib_1.__importDefault(require("http"));
 const https_1 = tslib_1.__importDefault(require("https"));
+const yaml = tslib_1.__importStar(require("js-yaml"));
+const lodash_1 = require("lodash");
+const node_fs_1 = require("node:fs");
 const swagger2openapi_1 = tslib_1.__importDefault(require("swagger2openapi"));
 const log_1 = tslib_1.__importDefault(require("./log"));
 const getImportStatement = (requestLibPath) => {
@@ -40,14 +43,22 @@ function getSchema(schemaPath) {
         if (require.cache[schemaPath]) {
             delete require.cache[schemaPath];
         }
-        const schema = (yield require(schemaPath));
+        let schema = '';
+        try {
+            schema = (yield require(schemaPath));
+        }
+        catch (_a) {
+            try {
+                schema = (0, node_fs_1.readFileSync)(schemaPath, 'utf8');
+            }
+            catch (error) {
+                console.error('Error reading schema file:', error);
+            }
+        }
         return schema;
     });
 }
 function converterSwaggerToOpenApi(swagger) {
-    if (!swagger.swagger) {
-        return swagger;
-    }
     return new Promise((resolve, reject) => {
         const convertOptions = {
             patch: true,
@@ -69,9 +80,43 @@ function converterSwaggerToOpenApi(swagger) {
 const getOpenAPIConfig = (schemaPath) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
     const schema = yield getSchema(schemaPath);
     if (!schema) {
-        return null;
+        return;
     }
-    const openAPI = yield converterSwaggerToOpenApi(schema);
+    const openAPI = yield parseSwaggerOrOpenapi(schema);
     return openAPI;
 });
 exports.getOpenAPIConfig = getOpenAPIConfig;
+function parseSwaggerOrOpenapi(content) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        let openapi = {};
+        if ((0, lodash_1.isObject)(content)) {
+            openapi = content;
+            // if is swagger2.0 json, covert swagger2.0 to openapi3.0
+            if (openapi.swagger) {
+                openapi = yield converterSwaggerToOpenApi(openapi);
+            }
+        }
+        else {
+            if (isJSONString(content)) {
+                openapi = JSON.parse(content);
+            }
+            else {
+                openapi = yaml.load(content);
+            }
+            if (openapi.swagger) {
+                openapi = yield converterSwaggerToOpenApi(openapi);
+            }
+        }
+        return openapi;
+    });
+}
+exports.parseSwaggerOrOpenapi = parseSwaggerOrOpenapi;
+function isJSONString(str) {
+    try {
+        JSON.parse(str);
+        return true;
+    }
+    catch (error) {
+        return false;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-ts-request",
-  "version": "0.4.10",
+  "version": "0.5.0",
   "description": "Swagger2/OpenAPI3 to TypeScript, request client, request mock service, enum, type field label, JSON Schemas",
   "repository": {
     "type": "git",
@@ -28,6 +28,7 @@
     "cosmiconfig": "^9.0.0",
     "cosmiconfig-typescript-loader": "^5.0.0",
     "glob": "^10.4.2",
+    "js-yaml": "^4.1.0",
     "lodash": "^4.17.21",
     "memoizee": "^0.4.17",
     "mockjs": "^1.1.0",
@@ -44,6 +45,7 @@
     "@changesets/cli": "^2.27.6",
     "@commitlint/cli": "^19.2.1",
     "@commitlint/config-conventional": "^19.2.2",
+    "@types/js-yaml": "^4.0.9",
     "@types/lodash": "^4.17.5",
     "@types/memoizee": "^0.4.11",
     "@types/mockjs": "^1.0.10",