@1szx1/vite-plugin-swagger2ts 1.0.15 → 1.0.17

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2021 hannoeru
-
-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.
+MIT License
+
+Copyright (c) 2021 hannoeru
+
+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

@@ -1,95 +1,95 @@
-# vite-plugin-swagger2ts
-
-[![npm version](https://badgen.net/npm/v/vite-plugin-swagger2ts)](https://www.npmjs.com/package/vite-plugin-swagger2ts)
-[![monthly downloads](https://badgen.net/npm/dm/vite-plugin-swagger2ts)](https://www.npmjs.com/package/vite-plugin-swagger2ts)
-[![types](https://badgen.net/npm/types/vite-plugin-swagger2ts)](https://github.com/hannoeru/vite-plugin-swagger2ts/blob/main/src/types.ts)
-[![license](https://badgen.net/npm/license/vite-plugin-swagger2ts)](https://github.com/hannoeru/vite-plugin-swagger2ts/blob/main/LICENSE)
-
-## 使用流程
-
-1. 安装
-
-```sh
-# npm i vite-plugin-swagger2ts -D
-# or
-# yarn add vite-plugin-swagger2ts -D
-# or
-pnpm add vite-plugin-swagger2ts -D
-```
-
-2. 配置到 `vite.config.ts`
-
-```ts
-// vite.config.ts
-import ViteSwagger2ts from "vite-plugin-swagger2ts";
-
-export default {
-    plugins: [
-        ViteSwagger2ts({
-            swaggerUrl: "url", // swagger-resources URL
-            output: "pathToSave", // not require, default './src/swagger.ts'
-            formatSchema: (schema) => {
-                // not require, deal with schema. such as unwrapper common response
-                if ("properties" in schema) {
-                    const properties = schema["properties"];
-                    if ("code" in properties && ("msg" in properties || "message" in properties) && "data" in properties) {
-                        return properties["data"];
-                    }
-                }
-                return schema;
-            }
-        })
-    ]
-};
-```
-
-## 插件流程
-
-1. 通过配置的 url 请求 `${baseUrl}/swagger-resources` 地址，获取微服务的 resources 地址；
-2. 通过 resources 地址请求 swagger 具体文档；
-3. 将 swagger 接口生成具体的 typescript 类型:
-
-```ts
-interface SwaggerInterface {
-    // SwaggerInterface start
-    url: {
-        get: {
-            param: { path: { id: string }; query: { status: number }; body: { name: string } };
-            reponse: { id: string; name: string; status: number };
-        };
-    };
-}
-```
-
-4. 附加 typescrip 转换模版内容:
-
-```ts
-import { PathsSwaggerInterface } from "./swagger.ts";
-
-export type UrlKey = keyof PathsSwaggerInterface;
-export type MethodKey<U extends UrlKey> = string & keyof PathsSwaggerInterface[U];
-
-type SwaggerInterfaceSingle<U extends UrlKey, M extends MethodKey<U>> = PathsSwaggerInterface[U][M];
-type SwaggerField<U extends UrlKey, M extends MethodKey<U>> = keyof SwaggerInterfaceSingle<U, M>;
-type SwaggerFieldType<U extends UrlKey, M extends MethodKey<U>, F extends SwaggerField<U, M>> = SwaggerInterfaceSingle<U, M>[F];
-
-export type Param<U extends UrlKey, M extends MethodKey<U>> = SwaggerFieldType<U, M, "param" & SwaggerField<U, M>>;
-export type Response<U extends UrlKey, M extends MethodKey<U>> = SwaggerFieldType<U, M, "response" & SwaggerField<U, M>>;
-```
-
-5. 将生成的文件保存到项目指定位置，项目通过以下代码进行使用类型提示；
-
-```ts
-import type { PathKey, MethodKey, Param, Respone } from "configfile";
-
-export function customFetch<P extends PathKey, M extends MethodKey<P>>(path: P, method: M, params: Param<P, M>): Promise<Respone<P, M>> {
-    // custome code
-    return "" as any;
-}
-```
-
-6. 业务代码通过引用 `customFetch` 进行使用
-
-## License
-
-MIT License © 2021 [morelearn1990](https://github.com/morelearn1990)
+# vite-plugin-swagger2ts
+
+[![npm version](https://badgen.net/npm/v/vite-plugin-swagger2ts)](https://www.npmjs.com/package/vite-plugin-swagger2ts)
+[![monthly downloads](https://badgen.net/npm/dm/vite-plugin-swagger2ts)](https://www.npmjs.com/package/vite-plugin-swagger2ts)
+[![types](https://badgen.net/npm/types/vite-plugin-swagger2ts)](https://github.com/hannoeru/vite-plugin-swagger2ts/blob/main/src/types.ts)
+[![license](https://badgen.net/npm/license/vite-plugin-swagger2ts)](https://github.com/hannoeru/vite-plugin-swagger2ts/blob/main/LICENSE)
+
+## 使用流程
+
+1. 安装
+
+```sh
+# npm i vite-plugin-swagger2ts -D
+# or
+# yarn add vite-plugin-swagger2ts -D
+# or
+pnpm add vite-plugin-swagger2ts -D
+```
+
+2. 配置到 `vite.config.ts`
+
+```ts
+// vite.config.ts
+import ViteSwagger2ts from "vite-plugin-swagger2ts";
+
+export default {
+    plugins: [
+        ViteSwagger2ts({
+            swaggerUrl: "url", // swagger-resources URL
+            output: "pathToSave", // not require, default './src/swagger.ts'
+            formatSchema: (schema) => {
+                // not require, deal with schema. such as unwrapper common response
+                if ("properties" in schema) {
+                    const properties = schema["properties"];
+                    if ("code" in properties && ("msg" in properties || "message" in properties) && "data" in properties) {
+                        return properties["data"];
+                    }
+                }
+                return schema;
+            }
+        })
+    ]
+};
+```
+
+## 插件流程
+
+1. 通过配置的 url 请求 `${baseUrl}/swagger-resources` 地址，获取微服务的 resources 地址；
+2. 通过 resources 地址请求 swagger 具体文档；
+3. 将 swagger 接口生成具体的 typescript 类型:
+
+```ts
+interface SwaggerInterface {
+    // SwaggerInterface start
+    url: {
+        get: {
+            param: { path: { id: string }; query: { status: number }; body: { name: string } };
+            reponse: { id: string; name: string; status: number };
+        };
+    };
+}
+```
+
+4. 附加 typescrip 转换模版内容:
+
+```ts
+import { PathsSwaggerInterface } from "./swagger.ts";
+
+export type UrlKey = keyof PathsSwaggerInterface;
+export type MethodKey<U extends UrlKey> = string & keyof PathsSwaggerInterface[U];
+
+type SwaggerInterfaceSingle<U extends UrlKey, M extends MethodKey<U>> = PathsSwaggerInterface[U][M];
+type SwaggerField<U extends UrlKey, M extends MethodKey<U>> = keyof SwaggerInterfaceSingle<U, M>;
+type SwaggerFieldType<U extends UrlKey, M extends MethodKey<U>, F extends SwaggerField<U, M>> = SwaggerInterfaceSingle<U, M>[F];
+
+export type Param<U extends UrlKey, M extends MethodKey<U>> = SwaggerFieldType<U, M, "param" & SwaggerField<U, M>>;
+export type Response<U extends UrlKey, M extends MethodKey<U>> = SwaggerFieldType<U, M, "response" & SwaggerField<U, M>>;
+```
+
+5. 将生成的文件保存到项目指定位置，项目通过以下代码进行使用类型提示；
+
+```ts
+import type { PathKey, MethodKey, Param, Respone } from "configfile";
+
+export function customFetch<P extends PathKey, M extends MethodKey<P>>(path: P, method: M, params: Param<P, M>): Promise<Respone<P, M>> {
+    // custome code
+    return "" as any;
+}
+```
+
+6. 业务代码通过引用 `customFetch` 进行使用
+
+## License
+
+MIT License © 2021 [morelearn1990](https://github.com/morelearn1990)

package/dist/adapters.d.ts

@@ -0,0 +1,27 @@
+import { AxiosInstance, AxiosRequestConfig } from 'axios';
+import Request, { HttpRequestConfig } from 'luch-request';
+
+type Get<T, K> = T[K & keyof T];
+
+declare function axiosAdapter<T>(httpInstance: AxiosInstance): {
+    request: <U extends string & keyof T, M extends string & keyof T[U]>(url: U, method: M, param?: Get<T[U][M]["param" & keyof T[U][M]], M extends "get" ? "query" : "body"> | undefined, config?: (AxiosRequestConfig<any> & {
+        data?: Get<T[U][M]["param" & keyof T[U][M]], "body"> | undefined;
+        params?: Get<T[U][M]["param" & keyof T[U][M]], "query"> | undefined;
+        path?: Get<T[U][M]["param" & keyof T[U][M]], "path"> | undefined;
+    }) | undefined) => Promise<T[U][M]["response" & keyof T[U][M]]>;
+};
+
+declare function LuchAdapter<T extends Record<string, any>>(httpInstance: Request): {
+    request: <U extends keyof T, M extends string & keyof T[U]>(url: U & string, method: M, param?: Get<T[U][M]["param" & keyof T[U][M]], M extends "get" ? "query" : "body"> | undefined, config?: (HttpRequestConfig<UniApp.RequestTask | UniApp.UploadTask | UniApp.DownloadTask> & {
+        data?: Get<T[U][M]["param" & keyof T[U][M]], "body"> | undefined;
+        params?: Get<T[U][M]["param" & keyof T[U][M]], "query"> | undefined;
+    }) | undefined) => Promise<T[U][M]["response" & keyof T[U][M]]>;
+    upload: <U_1 extends { [K in keyof T]: T[K] extends {
+        post: any;
+    } ? K : never; }[keyof T], P extends Get<T[U_1]["post"]["param" & keyof T[U_1]["post"]], "body" | "query">, N extends keyof P>(url: U_1 & string, config: HttpRequestConfig<UniApp.UploadTask> & {
+        name?: N | undefined;
+        formData?: Omit<P, N> | undefined;
+    }) => Promise<T[U_1]["post"]["response" & keyof T[U_1]["post"]]>;
+};
+
+export { LuchAdapter, axiosAdapter };

package/dist/{adapters/index.js → adapters.js}

@@ -17,9 +17,10 @@ var __copyProps = (to, from, except, desc) => {
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// src/adapters/index.ts
+// src/adapters.ts
 var adapters_exports = {};
 __export(adapters_exports, {
+  LuchAdapter: () => LuchAdapter,
   axiosAdapter: () => axiosAdapter
 });
 module.exports = __toCommonJS(adapters_exports);
@@ -45,7 +46,27 @@ function axiosAdapter(httpInstance) {
   }
   return { request };
 }
+
+// src/adapters/luchRequest.ts
+function LuchAdapter(httpInstance) {
+  async function request(url, method, param, config) {
+    const response = await httpInstance.middleware({
+      url,
+      method: method.toUpperCase(),
+      params: method === "get" ? param : config?.params,
+      data: method !== "get" ? param : config?.data,
+      ...config
+    });
+    return response.data;
+  }
+  async function upload(url, config) {
+    const response = await httpInstance.upload(url, config);
+    return response.data;
+  }
+  return { request, upload };
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  LuchAdapter,
   axiosAdapter
 });

package/dist/{adapters/index.mjs → adapters.mjs}

@@ -19,6 +19,26 @@ function axiosAdapter(httpInstance) {
   }
   return { request };
 }
+
+// src/adapters/luchRequest.ts
+function LuchAdapter(httpInstance) {
+  async function request(url, method, param, config) {
+    const response = await httpInstance.middleware({
+      url,
+      method: method.toUpperCase(),
+      params: method === "get" ? param : config?.params,
+      data: method !== "get" ? param : config?.data,
+      ...config
+    });
+    return response.data;
+  }
+  async function upload(url, config) {
+    const response = await httpInstance.upload(url, config);
+    return response.data;
+  }
+  return { request, upload };
+}
 export {
+  LuchAdapter,
   axiosAdapter
 };

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@1szx1/vite-plugin-swagger2ts",
     "description": "fork for https://github.com/1SZX1/vite-plugin-swagger2ts",
-    "version": "1.0.15",
+    "version": "1.0.17",
     "license": "MIT",
     "author": "1SZX1 <2414126198@qq.com>",
     "repository": {
@@ -20,24 +20,24 @@
             "types": "./dist/index.d.ts"
         },
         "./adapters": {
-            "require": "./dist/adapters/index.js",
-            "import": "./dist/adapters/index.mjs",
-            "types": "./dist/adapters/index.d.ts"
+            "require": "./dist/adapters.js",
+            "import": "./dist/adapters.mjs",
+            "types": "./dist/adapters.d.ts"
         }
     },
     "main": "dist/index.js",
     "module": "dist/index.mjs",
     "types": "index.d.ts",
     "typesVersions": {
-      "*": {
-        "*": [
-          "./dist/*"
-        ]
-      }
+        "*": {
+            "*": [
+                "./dist/*"
+            ]
+        }
     },
     "scripts": {
         "dev": "pnpm run build -- --watch --ignore-watch examples",
-        "build": "tsup src/index.ts src/adapters/index.ts --dts --format cjs,esm",
+        "build": "tsup src/index.ts src/adapters.ts --dts --format cjs,esm",
         "prepublishOnly": "pnpm run build",
         "release": "pnpx git-ensure -a && pnpx bumpp --commit --tag --push",
         "demo:dev": "pnpm -C examples/demo run dev",
@@ -60,6 +60,7 @@
         "@antfu/eslint-config": "^0.6.6",
         "@commitlint/cli": "^12.1.4",
         "@commitlint/config-conventional": "^12.1.4",
+        "@dcloudio/types": "^3.2.11",
         "@types/jest": "^26.0.24",
         "@types/node": "^14.18.12",
         "@typescript-eslint/eslint-plugin": "^4.33.0",
@@ -72,6 +73,7 @@
         "jest": "^26.6.3",
         "jest-esbuild": "^0.1.6",
         "lint-staged": "^10.5.4",
+        "luch-request": "^3.0.8",
         "rollup": "^2.70.0",
         "ts-node": "^9.1.1",
         "tsup": "^6.6.3",

package/dist/adapters/index.d.ts

@@ -1,13 +0,0 @@
-import { AxiosInstance, AxiosRequestConfig } from 'axios';
-
-type Get<T, K> = T[K & keyof T];
-
-declare function axiosAdapter<T>(httpInstance: AxiosInstance): {
-    request: <U extends string & keyof T, M extends string & keyof T[U]>(url: U, method: M, param?: Get<T[U][M]["param" & keyof T[U][M]], M extends "get" ? "query" : "body"> | undefined, config?: (AxiosRequestConfig<any> & {
-        data?: Get<T[U][M]["param" & keyof T[U][M]], "body"> | undefined;
-        params?: Get<T[U][M]["param" & keyof T[U][M]], "query"> | undefined;
-        path?: Get<T[U][M]["param" & keyof T[U][M]], "path"> | undefined;
-    }) | undefined) => Promise<T[U][M]["response" & keyof T[U][M]]>;
-};
-
-export { axiosAdapter };