feat: bump deps and add httpLib in tsdk.config.js

tsdk-monorepo · Feb 20, 2024 · 81736c1 · 81736c1
1 parent f91c383
commit 81736c1
Show file tree

Hide file tree

Showing 10 changed files with 115 additions and 16 deletions.
diff --git a/CHANGELOG.mdx b/CHANGELOG.mdx
@@ -2,6 +2,13 @@
 
 This is the log of notable changes to the `tsdk` that are developer-facing.
 
+
+### 0.1.6 2024/2/21
+
+- Feat: add **httpLib** config in `tsdk.config.js`, More detail https://tsdk.dev/docs/guide/tsdk.config
+- Chore: bump webpack version
+- Chore: add `XiorRequestConfig` in generate code
+
 ### 0.1.5 2024/2/20
 
 - Feat: add fetch support (use xior, similar axios API: https://www.npmjs.com/package/xior)

diff --git a/packages/tsdk-server-adapters/package.json b/packages/tsdk-server-adapters/package.json
@@ -1,6 +1,6 @@
 {
   "name": "tsdk-server-adapters",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "main": "lib/index.js",
   "repository": "tsdk-monorepo/tsdk",
   "bugs": "https://github.com/tsdk-monorepo/tsdk/issues",

diff --git a/packages/tsdk/fe-sdk-template/config/tsdk.config.js b/packages/tsdk/fe-sdk-template/config/tsdk.config.js
@@ -10,4 +10,6 @@ module.exports = {
   shareExt: 'shared',
   sharedDirs: ['./src/shared'],
   removeFields: [],
+  /** 'xior' | 'axios'. More: https://tsdk.dev/docs/guide/tsdk.config#httplib */
+  // httpLib: 'xior',
 };
diff --git a/packages/tsdk/package.json b/packages/tsdk/package.json
@@ -1,6 +1,6 @@
 {
   "name": "tsdk",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "description": "Type-safe API development and code share tool for TypeScript projects.",
   "repository": "tsdk-monorepo/tsdk",
   "bugs": "https://github.com/tsdk-monorepo/tsdk/issues",
@@ -57,7 +57,7 @@
     "@configs/ts-config": "workspace:*",
     "@types/fs-extra": "^11.0.4",
     "@types/webpack-node-externals": "^3.0.0",
-    "webpack": "^5.90.1",
+    "webpack": "^5.90.3",
     "webpack-node-externals": "^3.0.0"
   },
   "eslintConfig": {

diff --git a/packages/tsdk/src/config.ts b/packages/tsdk/src/config.ts
@@ -14,6 +14,8 @@ export interface TSDKConfig {
   shareExt?: string;
   sharedDirs: string[];
   monorepoRoot?: string;
+  /** default: axios */
+  httpLib?: 'xior' | 'axios';
   dataHookLib?: 'SWR' | 'ReactQuery';
   /** custom dependencies */
   dependencies?: { [key: string]: string };

diff --git a/packages/tsdk/src/sync-api.ts b/packages/tsdk/src/sync-api.ts
@@ -35,7 +35,11 @@ export async function syncAPI() {
         ? ''
         : `import useSWR, { SWRConfiguration } from "swr";
       import useSWRMutation, { SWRMutationConfiguration } from "swr/mutation";
-      import { AxiosRequestConfig } from "axios";
+      ${
+        config.httpLib !== 'xior'
+          ? `import type { AxiosRequestConfig } from "axios";`
+          : `import type { XiorRequestConfig as AxiosRequestConfig } from "xior";`
+      }
     `
     }
     ${
@@ -48,7 +52,11 @@ export async function syncAPI() {
       UndefinedInitialDataOptions,
       UseMutationOptions,
     } from "@tanstack/react-query";
-    import { AxiosRequestConfig } from "axios";
+    ${
+      config.httpLib !== 'xior'
+        ? `import type { AxiosRequestConfig } from "axios";`
+        : `import type { XiorRequestConfig as AxiosRequestConfig } from "xior";`
+    }
     `
     }
     `;

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/website/package.json b/website/package.json
@@ -25,8 +25,8 @@
     "nextra-theme-docs": "2.13.2",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "next-videos": "^1.4.1",
-    "react-wrap-balancer": "^1.1.0",
+    "next-videos": "1.4.1",
+    "react-wrap-balancer": "1.1.0",
     "next-sitemap": "4.2.3"
   },
   "devDependencies": {

diff --git a/website/pages/docs/guide/tsdk.config.en-US.mdx b/website/pages/docs/guide/tsdk.config.en-US.mdx
@@ -11,6 +11,7 @@ module.exports = {
   entityLibName: 'typeorm',
   entityExt: 'entity',
   apiconfExt: 'apiconf',
+  httpLib: 'axios',
   shareExt: 'shared',
   sharedDirs: ['./src/shared'],
   removeFields: [],
@@ -25,9 +26,10 @@ module.exports = {
 - `entityLibName` - ORM library, current support `TypeORM`, `kysely` 和 `DrizzleORM`
 - `entityExt` - ORM model extension name, default is `*.entity.ts`
 - `apiconfExt` - API config extension name, default is `*.apiconf.ts`
-- `shareExt` -  shared file extension name, default is `*.shared.ts`
-- `sharedDirs` -  shared dir, default is `["./src/shared"]`
+- `shareExt` - shared file extension name, default is `*.shared.ts`
+- `sharedDirs` - shared dir, default is `["./src/shared"]`
 - `monorepoRoot` - monorepo root folder, default is `./`
+- `httpLib` - `xior` | `axios`, default is `axios`; `xior` use fetch, and have similiar API with axios
 - `dataHookLib` - `SWR` | `ReactQuery`，Generate `SWR` or `React Query` hooks;dependencies version: `swr@^2.2.5`; `@tanstack/react-query@^5.10.0`
 - `dependencies` - custom dependencies，will combine to `fe-sdk/package.json ` dependencies. This can custom dependencies and override fe-sdk's default version
 - `devDependencies` - custom devDependencies.
@@ -64,6 +66,12 @@ module.exports = {
 
 `monorepoRoot` - monorepo root folder, default is `./`
 
+### httpLib
+
+Generate API SDK which request library to use.
+
+`xior` | `axios`, default is `axios`; And `xior` use fetch, and similiar API with axios
+
 ### dataHookLib
 
 `dataHookLib` - `SWR` | `ReactQuery`; Generate `SWR` or `React Query` hooks;dependencies version: `swr@^2.2.5`; `@tanstack/react-query@^5.10.0`
@@ -74,7 +82,6 @@ Custom dependencies，will combine to `fe-sdk/package.json` dependencies. This c
 
 For example, update `tsdk.config.js` to change axios to latest version:
 
-
 ```js filename="tsdk.config.js" {4-6}
 /** @type {import('tsdk').TSDKConfig} */
 module.exports = {
@@ -87,4 +94,4 @@ module.exports = {
 
 ### `devDependencies`
 
-Like `dependencies`, but for `devDependencies`.
+Like `dependencies`, but for `devDependencies`.
diff --git a/website/pages/docs/guide/tsdk.config.zh-CN.mdx b/website/pages/docs/guide/tsdk.config.zh-CN.mdx
@@ -12,6 +12,7 @@ module.exports = {
   entityExt: 'entity',
   apiconfExt: 'apiconf',
   shareExt: 'shared',
+  httpLib: 'axios',
   sharedDirs: ['./src/shared'],
   removeFields: [],
   monorepoRoot: './',
@@ -28,6 +29,7 @@ module.exports = {
 - `shareExt` - 共享文件名扩展，默认 `*.shared.ts`
 - `sharedDirs` - 共享文件夹，默认 `["./src/shared"]`
 - `monorepoRoot` - monorepo 根路径，默认当前路径 `./`
+- `httpLib` - 可选值有 `xior` | `axios`，默认 `axios`; `xior` 和 `axios` 什么区别？`xior` 使用 fetch，API 和 `axios` 类似
 - `dataHookLib` - 可选值有 `SWR` | `ReactQuery`，生成 `SWR` 或者 `React Query` 钩子；get 方法的接口将生成获取钩子，非 get 的将生成更新钩子。默认不生成。依赖版本：swr@^2.2.4；@tanstack/react-query@^5.10.0
 - `dependencies` - 自定义依赖，将会和 **fe-sdk/package.json** dependencies 进行合并。作用：添加自定义依赖，以及覆盖默认的依赖版本号
 - `devDependencies` - 自定义依赖，将会和 **fe-sdk/package.json** devDependencies 进行合并。
@@ -64,6 +66,13 @@ module.exports = {
 
 `monorepoRoot` - monorepo 根路径，默认当前路径 `./`
 
+
+### `httpLib` 
+
+可选值有 `xior` | `axios`，默认 `axios`；
+
+`xior` 和 `axios` 什么区别？`xior` 使用 fetch，API 和 `axios` 类似
+
 ### dataHookLib
 
 `dataHookLib` - 可选值有 `SWR` | `ReactQuery`，生成 `SWR` 或者 `React Query` 钩子；get 方法的接口将生成获取钩子，非 get 的将生成更新钩子。默认不生成。依赖版本：swr@^2.2.4；@tanstack/react-query@^5.10.0