rxtutils 1.1.2-beta.1 → 1.1.2-beta.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +144 -1
- package/cjs/index.cjs +28 -0
- package/{dist/types → cjs}/index.d.ts +2 -0
- package/cjs/request/index.cjs +150 -0
- package/{dist/types → cjs}/request/index.d.ts +11 -8
- package/cjs/validator/decorators.cjs +246 -0
- package/cjs/validator/decorators.d.ts +159 -0
- package/cjs/validator/validator.cjs +179 -0
- package/cjs/validator/validator.d.ts +89 -0
- package/es/cache/index.d.ts +135 -0
- package/es/cache/indexDB.d.ts +52 -0
- package/es/index.d.ts +7 -0
- package/{dist/es → es}/index.mjs +2 -0
- package/es/request/error.d.ts +31 -0
- package/es/request/index.d.ts +139 -0
- package/es/request/index.mjs +148 -0
- package/es/store/createGetter/index.d.ts +30 -0
- package/es/store/createStateStore/index.d.ts +42 -0
- package/es/validator/decorators.d.ts +159 -0
- package/es/validator/decorators.mjs +234 -0
- package/es/validator/validator.d.ts +89 -0
- package/es/validator/validator.mjs +177 -0
- package/package.json +9 -7
- package/dist/cjs/index.cjs +0 -14
- package/dist/cjs/request/index.cjs +0 -129
- package/dist/es/request/index.mjs +0 -127
- /package/{dist/cjs → cjs}/cache/index.cjs +0 -0
- /package/{dist/types → cjs}/cache/index.d.ts +0 -0
- /package/{dist/cjs → cjs}/cache/indexDB.cjs +0 -0
- /package/{dist/types → cjs}/cache/indexDB.d.ts +0 -0
- /package/{dist/cjs → cjs}/defaultEquals.cjs +0 -0
- /package/{dist/cjs → cjs}/request/defaultHandlers.cjs +0 -0
- /package/{dist/cjs → cjs}/request/error.cjs +0 -0
- /package/{dist/types → cjs}/request/error.d.ts +0 -0
- /package/{dist/cjs → cjs}/store/createGetter/index.cjs +0 -0
- /package/{dist/types → cjs}/store/createGetter/index.d.ts +0 -0
- /package/{dist/cjs → cjs}/store/createStateStore/index.cjs +0 -0
- /package/{dist/types → cjs}/store/createStateStore/index.d.ts +0 -0
- /package/{dist/es → es}/cache/index.mjs +0 -0
- /package/{dist/es → es}/cache/indexDB.mjs +0 -0
- /package/{dist/es → es}/defaultEquals.mjs +0 -0
- /package/{dist/es → es}/request/defaultHandlers.mjs +0 -0
- /package/{dist/es → es}/request/error.mjs +0 -0
- /package/{dist/es → es}/store/createGetter/index.mjs +0 -0
- /package/{dist/es → es}/store/createStateStore/index.mjs +0 -0
package/README.md
CHANGED
|
@@ -17,6 +17,7 @@ pnpm add rxtutils
|
|
|
17
17
|
- **缓存管理** - 支持内存、localStorage、sessionStorage 和 IndexedDB 多种存储方式
|
|
18
18
|
- **HTTP 请求** - 基于 axios 的请求封装,支持错误处理和缓存
|
|
19
19
|
- **状态管理** - 轻量级的状态管理解决方案,支持 React Hook
|
|
20
|
+
- **数据验证** - 基于装饰器的数据验证系统,支持多种验证规则
|
|
20
21
|
- **TypeScript** - 完整的 TypeScript 类型支持
|
|
21
22
|
|
|
22
23
|
## 📚 模块介绍
|
|
@@ -198,7 +199,149 @@ const currentUser = userStore.get();
|
|
|
198
199
|
userStore.set({ name: 'Jane Doe', email: 'jane@example.com', isLoggedIn: true });
|
|
199
200
|
```
|
|
200
201
|
|
|
201
|
-
### 4.
|
|
202
|
+
### 4. 数据验证 (Validator)
|
|
203
|
+
|
|
204
|
+
基于装饰器的数据验证系统,提供多种验证规则和自定义验证能力。
|
|
205
|
+
|
|
206
|
+
#### 基本用法
|
|
207
|
+
|
|
208
|
+
```typescript
|
|
209
|
+
import { BaseValidator, VString, VNumber, VRequired, VEmail, VMinLength } from 'rxtutils';
|
|
210
|
+
|
|
211
|
+
// 创建验证模型
|
|
212
|
+
class User extends BaseValidator {
|
|
213
|
+
@VString('用户名必须为字符串')
|
|
214
|
+
@(VRequired()('用户名不能为空'))
|
|
215
|
+
name?: string;
|
|
216
|
+
|
|
217
|
+
@VNumber('年龄必须为数字')
|
|
218
|
+
@(VRequired()('年龄不能为空'))
|
|
219
|
+
age?: number;
|
|
220
|
+
|
|
221
|
+
@VEmail('邮箱格式不正确')
|
|
222
|
+
@(VRequired()('邮箱不能为空'))
|
|
223
|
+
email?: string;
|
|
224
|
+
|
|
225
|
+
@(VMinLength(6)('密码长度不能少于6位'))
|
|
226
|
+
@(VRequired()('密码不能为空'))
|
|
227
|
+
password?: string;
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
// 使用验证
|
|
231
|
+
const user = new User();
|
|
232
|
+
user.name = '张三';
|
|
233
|
+
user.age = 25;
|
|
234
|
+
user.email = 'invalid-email'; // 无效的邮箱格式
|
|
235
|
+
user.password = '123'; // 密码长度不足
|
|
236
|
+
|
|
237
|
+
// 验证单个字段
|
|
238
|
+
const emailErrors = user.validate('email');
|
|
239
|
+
console.log(emailErrors); // [{ status: false, message: '邮箱格式不正确' }]
|
|
240
|
+
|
|
241
|
+
// 验证所有字段
|
|
242
|
+
const allErrors = user.validateAll();
|
|
243
|
+
console.log(allErrors); // 返回所有验证错误
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
#### 内置验证装饰器
|
|
247
|
+
|
|
248
|
+
```typescript
|
|
249
|
+
// 基本类型验证
|
|
250
|
+
@VString('必须为字符串')
|
|
251
|
+
@VNumber('必须为数字')
|
|
252
|
+
@VBoolean('必须为布尔值')
|
|
253
|
+
@VArray('必须为数组')
|
|
254
|
+
|
|
255
|
+
// 必填验证
|
|
256
|
+
@(VRequired()('不能为空'))
|
|
257
|
+
|
|
258
|
+
// 范围验证
|
|
259
|
+
@(VMin(18)('必须大于等于18'))
|
|
260
|
+
@(VMax(100)('必须小于等于100'))
|
|
261
|
+
|
|
262
|
+
// 长度验证
|
|
263
|
+
@(VMinLength(6)('长度不能少于6位'))
|
|
264
|
+
@(VMaxLength(20)('长度不能超过20位'))
|
|
265
|
+
|
|
266
|
+
// 格式验证
|
|
267
|
+
@VEmail('邮箱格式不正确')
|
|
268
|
+
@(VPattern(/^1[3-9]\d{9}$/)('手机号格式不正确'))
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
#### 自定义验证装饰器
|
|
272
|
+
|
|
273
|
+
```typescript
|
|
274
|
+
import { BaseValidator } from 'rxtutils';
|
|
275
|
+
|
|
276
|
+
// 创建自定义验证装饰器
|
|
277
|
+
const VCustom = BaseValidator.decoratorCreator(
|
|
278
|
+
(val) => {
|
|
279
|
+
// 自定义验证逻辑
|
|
280
|
+
return typeof val === 'string' && val.startsWith('custom-');
|
|
281
|
+
}
|
|
282
|
+
);
|
|
283
|
+
|
|
284
|
+
// 使用自定义验证装饰器
|
|
285
|
+
class Product extends BaseValidator {
|
|
286
|
+
@VCustom('产品编码必须以 custom- 开头')
|
|
287
|
+
code?: string;
|
|
288
|
+
}
|
|
289
|
+
```
|
|
290
|
+
|
|
291
|
+
#### 验证方法
|
|
292
|
+
|
|
293
|
+
BaseValidator 类提供了两个主要的验证方法:
|
|
294
|
+
|
|
295
|
+
```typescript
|
|
296
|
+
// 验证单个字段
|
|
297
|
+
validate(itemKey: string, itemAll: boolean = false): { status: boolean; message?: string }[] | null;
|
|
298
|
+
|
|
299
|
+
// 验证多个或所有字段
|
|
300
|
+
validateAll(itemAll: boolean = false, everyItem: boolean = false, order?: string[]): { status: boolean; message?: string }[] | null;
|
|
301
|
+
```
|
|
302
|
+
|
|
303
|
+
参数说明:
|
|
304
|
+
|
|
305
|
+
- `itemKey`: 要验证的字段名
|
|
306
|
+
- `itemAll`: 是否验证该字段的所有规则,为 true 时会验证所有规则,为 false 时遇到第一个失败的规则就停止
|
|
307
|
+
- `everyItem`: 是否验证所有字段,为 true 时会验证所有字段,为 false 时遇到第一个失败的字段就停止
|
|
308
|
+
- `order`: 验证字段的顺序,可以指定验证的字段名数组及其顺序
|
|
309
|
+
|
|
310
|
+
使用示例:
|
|
311
|
+
|
|
312
|
+
```typescript
|
|
313
|
+
// 创建验证模型
|
|
314
|
+
class LoginForm extends BaseValidator {
|
|
315
|
+
@VString('用户名必须为字符串')
|
|
316
|
+
@(VRequired()('用户名不能为空'))
|
|
317
|
+
@(VMinLength(3)('用户名长度不能少于3位'))
|
|
318
|
+
@(VMaxLength(20)('用户名长度不能超过20位'))
|
|
319
|
+
username?: string;
|
|
320
|
+
|
|
321
|
+
@(VRequired()('密码不能为空'))
|
|
322
|
+
@(VMinLength(6)('密码长度不能少于6位'))
|
|
323
|
+
password?: string;
|
|
324
|
+
}
|
|
325
|
+
|
|
326
|
+
const form = new LoginForm();
|
|
327
|
+
form.username = 'ab'; // 长度不足
|
|
328
|
+
form.password = '123456';
|
|
329
|
+
|
|
330
|
+
// 验证单个字段的所有规则
|
|
331
|
+
const usernameErrors = form.validate('username', true);
|
|
332
|
+
console.log(usernameErrors);
|
|
333
|
+
// [{ status: false, message: '用户名长度不能少于3位' }]
|
|
334
|
+
|
|
335
|
+
// 验证所有字段,每个字段遇到第一个错误就停止
|
|
336
|
+
const allErrors = form.validateAll(false, true);
|
|
337
|
+
console.log(allErrors);
|
|
338
|
+
|
|
339
|
+
// 按指定顺序验证字段,并验证每个字段的所有规则
|
|
340
|
+
const orderedErrors = form.validateAll(true, true, ['password', 'username']);
|
|
341
|
+
console.log(orderedErrors);
|
|
342
|
+
```
|
|
343
|
+
|
|
344
|
+
### 5. 状态计算器 (createStoreGetter)
|
|
202
345
|
|
|
203
346
|
为状态存储提供计算属性和派生状态。
|
|
204
347
|
|
package/cjs/index.cjs
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var index = require('./cache/index.cjs');
|
|
4
|
+
var index$1 = require('./request/index.cjs');
|
|
5
|
+
var index$3 = require('./store/createGetter/index.cjs');
|
|
6
|
+
var index$2 = require('./store/createStateStore/index.cjs');
|
|
7
|
+
var validator = require('./validator/validator.cjs');
|
|
8
|
+
var decorators = require('./validator/decorators.cjs');
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
exports.Cache = index.default;
|
|
13
|
+
exports.createBaseRequest = index$1;
|
|
14
|
+
exports.createStoreGetter = index$3.createStoreGetter;
|
|
15
|
+
exports.createStoreGetterMemo = index$3.createStoreGetterMemo;
|
|
16
|
+
exports.createStateStore = index$2.default;
|
|
17
|
+
exports.BaseValidator = validator.BaseValidator;
|
|
18
|
+
exports.VArray = decorators.VArray;
|
|
19
|
+
exports.VBoolean = decorators.VBoolean;
|
|
20
|
+
exports.VEmail = decorators.VEmail;
|
|
21
|
+
exports.VMax = decorators.VMax;
|
|
22
|
+
exports.VMaxLength = decorators.VMaxLength;
|
|
23
|
+
exports.VMin = decorators.VMin;
|
|
24
|
+
exports.VMinLength = decorators.VMinLength;
|
|
25
|
+
exports.VNumber = decorators.VNumber;
|
|
26
|
+
exports.VPattern = decorators.VPattern;
|
|
27
|
+
exports.VRequired = decorators.VRequired;
|
|
28
|
+
exports.VString = decorators.VString;
|
|
@@ -2,4 +2,6 @@ export { default as Cache, ICache, ICacheOptions, StorageMap, StorageType } from
|
|
|
2
2
|
export { ErrorHandlerReturnType, Options, RequestOptions, default as createBaseRequest } from './request/index.js';
|
|
3
3
|
export { createStoreGetter, createStoreGetterMemo } from './store/createGetter/index.js';
|
|
4
4
|
export { IHookStateInitAction, IHookStateInitialSetter, IHookStateResolvable, IHookStateSetAction, IHookStateSetter, default as createStateStore } from './store/createStateStore/index.js';
|
|
5
|
+
export { BaseValidator } from './validator/validator.js';
|
|
6
|
+
export { VArray, VBoolean, VEmail, VMax, VMaxLength, VMin, VMinLength, VNumber, VPattern, VRequired, VString } from './validator/decorators.js';
|
|
5
7
|
export { default as RequestError, RequestErrorType } from './request/error.js';
|
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var tslib = require('tslib');
|
|
4
|
+
var axios = require('axios');
|
|
5
|
+
var lodash = require('lodash');
|
|
6
|
+
var defaultHandlers = require('./defaultHandlers.cjs');
|
|
7
|
+
var defaultEquals = require('../defaultEquals.cjs');
|
|
8
|
+
var index = require('../cache/index.cjs');
|
|
9
|
+
var error = require('./error.cjs');
|
|
10
|
+
|
|
11
|
+
/**
|
|
12
|
+
* 创建基础请求实例
|
|
13
|
+
* @param baseOptions 基础配置选项
|
|
14
|
+
* @returns 请求创建函数
|
|
15
|
+
*/
|
|
16
|
+
function createBaseRequest(baseOptions) {
|
|
17
|
+
var baseURL = Object(baseOptions).baseURL;
|
|
18
|
+
// 创建新的 Axios 实例并配置基础URL和跨域凭证
|
|
19
|
+
var instance = axios.create({
|
|
20
|
+
baseURL: baseURL,
|
|
21
|
+
withCredentials: true,
|
|
22
|
+
});
|
|
23
|
+
/**
|
|
24
|
+
* 创建请求函数
|
|
25
|
+
* @template Param 请求参数类型
|
|
26
|
+
* @template Data 响应数据类型,必须是对象类型
|
|
27
|
+
* @param requestOptions 请求配置
|
|
28
|
+
* @param createOptions 创建选项(覆盖基础配置)
|
|
29
|
+
* @returns 发送请求的函数
|
|
30
|
+
*/
|
|
31
|
+
return function createRequest(requestOptions, createOptions) {
|
|
32
|
+
var _a = tslib.__assign({}, requestOptions), method = _a.method, url = _a.url;
|
|
33
|
+
var _b = tslib.__assign(tslib.__assign({}, baseOptions), createOptions), baseURL = _b.baseURL, _c = _b.cacheDataKey, cacheDataKey = _c === void 0 ? "".concat(method, ":").concat(baseURL).concat(url) : _c, cacheDataInStorage = _b.cacheDataInStorage, _d = _b.cacheKeyEquals, cacheKeyEquals = _d === void 0 ? defaultEquals : _d, cacheTime = _b.cacheTime, _e = _b.indexDBName, indexDBName = _e === void 0 ? "__apiCacheDatabase__" : _e;
|
|
34
|
+
var cache = new index.default(cacheDataInStorage, cacheDataKey, cacheTime, indexDBName, cacheKeyEquals);
|
|
35
|
+
function request(requestParam, options) {
|
|
36
|
+
var _this = this;
|
|
37
|
+
var _a = tslib.__assign(tslib.__assign({}, requestOptions), requestParam), method = _a.method, url = _a.url, _b = _a.data, data = _b === void 0 ? {} : _b, _c = _a.params, params = _c === void 0 ? {} : _c;
|
|
38
|
+
var requestDataOrParams = params;
|
|
39
|
+
if (method.toLowerCase() === "post") {
|
|
40
|
+
requestDataOrParams = data;
|
|
41
|
+
}
|
|
42
|
+
var _d = tslib.__assign(tslib.__assign(tslib.__assign({}, baseOptions), createOptions), options).defaultMessageShower, defaultMessageShower = _d === void 0 ? console.error : _d;
|
|
43
|
+
var _e = tslib.__assign(tslib.__assign(tslib.__assign({}, baseOptions), createOptions), options), _f = _e.enableCache, enableCache = _f === void 0 ? false : _f, _g = _e.cacheData, cacheData = _g === void 0 ? false : _g, _h = _e.defaultErrorCodeHandler, defaultErrorCodeHandler = _h === void 0 ? defaultHandlers._defaultErrorCodeHandler.bind(null, defaultMessageShower) : _h, _j = _e.defaultHttpErrorCodeHandler, defaultHttpErrorCodeHandler = _j === void 0 ? defaultHandlers._defaultHttpErrorCodeHandler.bind(null, defaultMessageShower) : _j, _k = _e.otherErrorHandler, otherErrorHandler = _k === void 0 ? defaultHandlers._defaultOtherErrorCodeHandler.bind(null, defaultMessageShower) : _k, _l = _e.errorCodePath, errorCodePath = _l === void 0 ? "code" : _l, _m = _e.cacheTime, cacheTime = _m === void 0 ? 60 : _m, _o = _e.errorCodeMap, errorCodeMap = _o === void 0 ? {} : _o, _p = _e.successCodes, successCodes = _p === void 0 ? ["0", "200"] : _p, _q = _e.httpErrorCodeMap, httpErrorCodeMap = _q === void 0 ? {} : _q, _r = _e.axiosOptions, axiosOptions = _r === void 0 ? {} : _r, _s = _e.throwError, throwError = _s === void 0 ? true : _s;
|
|
44
|
+
if (enableCache) {
|
|
45
|
+
var cacheItem = cache.getCache(requestDataOrParams);
|
|
46
|
+
if (cacheItem) {
|
|
47
|
+
return Promise.resolve(cacheItem);
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
return instance
|
|
51
|
+
.request(tslib.__assign({ method: method, url: url, data: data, params: params }, axiosOptions))
|
|
52
|
+
.then(function (res) { return tslib.__awaiter(_this, void 0, void 0, function () {
|
|
53
|
+
var errorCode, _a, _b, _c, customHandler, err, _d, _e, replaceResData, _f, handlerThrowError, _g;
|
|
54
|
+
return tslib.__generator(this, function (_h) {
|
|
55
|
+
switch (_h.label) {
|
|
56
|
+
case 0:
|
|
57
|
+
errorCode = String(lodash.at(res.data, errorCodePath));
|
|
58
|
+
if (successCodes.includes(errorCode)) {
|
|
59
|
+
if (cacheData) {
|
|
60
|
+
cache.setCache(requestDataOrParams, res.data, { cacheTime: cacheTime });
|
|
61
|
+
}
|
|
62
|
+
return [2 /*return*/, res.data];
|
|
63
|
+
}
|
|
64
|
+
_a = errorCodeMap, _b = errorCode, _c = _a[_b], customHandler = _c === void 0 ? defaultErrorCodeHandler : _c;
|
|
65
|
+
err = new error("服务端错误", "server", res);
|
|
66
|
+
if (!(typeof customHandler === "string")) return [3 /*break*/, 1];
|
|
67
|
+
defaultMessageShower(customHandler);
|
|
68
|
+
return [3 /*break*/, 3];
|
|
69
|
+
case 1:
|
|
70
|
+
_g = Object;
|
|
71
|
+
return [4 /*yield*/, customHandler(errorCode, res.data, res, tslib.__assign(tslib.__assign({}, requestOptions), requestParam))];
|
|
72
|
+
case 2:
|
|
73
|
+
_d = _g.apply(void 0, [(_h.sent())]), _e = _d.replaceResData, replaceResData = _e === void 0 ? res.data : _e, _f = _d.throwError, handlerThrowError = _f === void 0 ? "default" : _f;
|
|
74
|
+
res.data = replaceResData;
|
|
75
|
+
switch (handlerThrowError) {
|
|
76
|
+
case true:
|
|
77
|
+
throw err;
|
|
78
|
+
case false:
|
|
79
|
+
return [2 /*return*/, res.data];
|
|
80
|
+
}
|
|
81
|
+
_h.label = 3;
|
|
82
|
+
case 3:
|
|
83
|
+
if (throwError) {
|
|
84
|
+
throw err;
|
|
85
|
+
}
|
|
86
|
+
return [2 /*return*/, res.data];
|
|
87
|
+
}
|
|
88
|
+
});
|
|
89
|
+
}); }, function (error$1) { return tslib.__awaiter(_this, void 0, void 0, function () {
|
|
90
|
+
var resData, _a, _b, _c, customHandler, err, _d, _e, replaceResData, _f, handlerThrowError, _g, resData, err, _h, _j, replaceResData, _k, handlerThrowError, _l;
|
|
91
|
+
return tslib.__generator(this, function (_m) {
|
|
92
|
+
switch (_m.label) {
|
|
93
|
+
case 0:
|
|
94
|
+
if (!error$1.response) return [3 /*break*/, 4];
|
|
95
|
+
resData = error$1;
|
|
96
|
+
_a = httpErrorCodeMap, _b = error$1.response.status, _c = _a[_b], customHandler = _c === void 0 ? defaultHttpErrorCodeHandler : _c;
|
|
97
|
+
err = new error("服务端错误", "http", error$1);
|
|
98
|
+
if (!(typeof customHandler === "string")) return [3 /*break*/, 1];
|
|
99
|
+
defaultMessageShower(customHandler);
|
|
100
|
+
return [3 /*break*/, 3];
|
|
101
|
+
case 1:
|
|
102
|
+
_g = Object;
|
|
103
|
+
return [4 /*yield*/, customHandler(error$1.response.status, error$1, tslib.__assign(tslib.__assign({}, requestOptions), requestParam))];
|
|
104
|
+
case 2:
|
|
105
|
+
_d = _g.apply(void 0, [(_m.sent())]), _e = _d.replaceResData, replaceResData = _e === void 0 ? error$1 : _e, _f = _d.throwError, handlerThrowError = _f === void 0 ? "default" : _f;
|
|
106
|
+
resData = replaceResData;
|
|
107
|
+
switch (handlerThrowError) {
|
|
108
|
+
case true:
|
|
109
|
+
throw err;
|
|
110
|
+
case false:
|
|
111
|
+
return [2 /*return*/, resData];
|
|
112
|
+
}
|
|
113
|
+
_m.label = 3;
|
|
114
|
+
case 3:
|
|
115
|
+
if (throwError) {
|
|
116
|
+
throw err;
|
|
117
|
+
}
|
|
118
|
+
return [2 /*return*/, resData];
|
|
119
|
+
case 4:
|
|
120
|
+
resData = error$1;
|
|
121
|
+
err = new error("服务端错误", "http", error$1);
|
|
122
|
+
err.type = "http";
|
|
123
|
+
err.data = error$1;
|
|
124
|
+
_l = Object;
|
|
125
|
+
return [4 /*yield*/, otherErrorHandler(error$1)];
|
|
126
|
+
case 5:
|
|
127
|
+
_h = (_l.apply(void 0, [(_m.sent())])), _j = _h.replaceResData, replaceResData = _j === void 0 ? error$1 : _j, _k = _h.throwError, handlerThrowError = _k === void 0 ? "default" : _k;
|
|
128
|
+
resData = replaceResData;
|
|
129
|
+
switch (handlerThrowError) {
|
|
130
|
+
case true:
|
|
131
|
+
throw err;
|
|
132
|
+
case false:
|
|
133
|
+
return [2 /*return*/, resData];
|
|
134
|
+
}
|
|
135
|
+
if (throwError) {
|
|
136
|
+
throw err;
|
|
137
|
+
}
|
|
138
|
+
return [2 /*return*/, resData];
|
|
139
|
+
}
|
|
140
|
+
});
|
|
141
|
+
}); });
|
|
142
|
+
}
|
|
143
|
+
request.clearCache = function () {
|
|
144
|
+
cache.clear();
|
|
145
|
+
};
|
|
146
|
+
return request;
|
|
147
|
+
};
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
module.exports = createBaseRequest;
|
|
@@ -14,7 +14,7 @@ type ErrorHandlerReturnType<D> = {
|
|
|
14
14
|
* - false: 不抛出错误
|
|
15
15
|
* - 'default': 使用默认错误处理逻辑
|
|
16
16
|
*/
|
|
17
|
-
throwError?: boolean |
|
|
17
|
+
throwError?: boolean | "default";
|
|
18
18
|
};
|
|
19
19
|
/**
|
|
20
20
|
* 请求配置选项接口
|
|
@@ -53,7 +53,8 @@ interface Options<Params = any, Data = any> {
|
|
|
53
53
|
* 缓存时间(秒)
|
|
54
54
|
* @default 60
|
|
55
55
|
*/
|
|
56
|
-
cacheTime?: number;
|
|
56
|
+
cacheTime?: number;
|
|
57
|
+
/**
|
|
57
58
|
* 缓存数据的存储类型
|
|
58
59
|
* - localStorage: 使用浏览器本地存储,数据永久保存
|
|
59
60
|
* - sessionStorage: 使用会话存储,关闭浏览器后清除
|
|
@@ -75,7 +76,8 @@ interface Options<Params = any, Data = any> {
|
|
|
75
76
|
* 错误码在响应数据中的路径
|
|
76
77
|
* @default 'code'
|
|
77
78
|
*/
|
|
78
|
-
errorCodePath?: string;
|
|
79
|
+
errorCodePath?: string;
|
|
80
|
+
/**
|
|
79
81
|
* 错误码映射表
|
|
80
82
|
* 可以配置错误码对应的错误信息或处理函数
|
|
81
83
|
* @default {} 空对象,使用默认处理函数
|
|
@@ -85,7 +87,8 @@ interface Options<Params = any, Data = any> {
|
|
|
85
87
|
* 默认错误码处理函数
|
|
86
88
|
* 当错误码不在 errorCodeMap 中时调用
|
|
87
89
|
*/
|
|
88
|
-
defaultErrorCodeHandler?: (code: string, data: Data, res: AxiosResponse<Data>) => ErrorHandlerReturnType<Data> | void
|
|
90
|
+
defaultErrorCodeHandler?: (code: string, data: Data, res: AxiosResponse<Data>) => Promise<ErrorHandlerReturnType<Data> | void>;
|
|
91
|
+
/**
|
|
89
92
|
* 成功状态的错误码列表
|
|
90
93
|
* @default ['0', '200']
|
|
91
94
|
*/
|
|
@@ -95,18 +98,18 @@ interface Options<Params = any, Data = any> {
|
|
|
95
98
|
* 可以配置 HTTP 状态码对应的错误信息或处理函数
|
|
96
99
|
* @default {} 空对象,使用默认处理函数
|
|
97
100
|
*/
|
|
98
|
-
httpErrorCodeMap?: Record<string, string | ((code: number, res: AxiosResponse<Data>, requestParam: RequestOptions<Params>) => ErrorHandlerReturnType<Data> | void)>;
|
|
101
|
+
httpErrorCodeMap?: Record<string, string | ((code: number, res: AxiosResponse<Data>, requestParam: RequestOptions<Params>) => Promise<ErrorHandlerReturnType<Data> | void>)>;
|
|
99
102
|
/**
|
|
100
103
|
* 默认 HTTP 错误码处理函数
|
|
101
104
|
* 当 HTTP 状态码不在 httpErrorCodeMap 中时调用
|
|
102
105
|
*/
|
|
103
|
-
defaultHttpErrorCodeHandler?: (code: number, error: any) => ErrorHandlerReturnType<Data> | void
|
|
106
|
+
defaultHttpErrorCodeHandler?: (code: number, error: any) => Promise<ErrorHandlerReturnType<Data> | void>;
|
|
104
107
|
/**
|
|
105
108
|
* 其他错误处理函数
|
|
106
109
|
* 处理非 HTTP 错误和非业务错误码的错误
|
|
107
110
|
*/
|
|
108
|
-
otherErrorHandler?: (error: any) => ErrorHandlerReturnType<Data> | void
|
|
109
|
-
axiosOptions?: Omit<AxiosRequestConfig<Params>,
|
|
111
|
+
otherErrorHandler?: (error: any) => Promise<ErrorHandlerReturnType<Data> | void>;
|
|
112
|
+
axiosOptions?: Omit<AxiosRequestConfig<Params>, "method" | "url" | "params" | "data">;
|
|
110
113
|
}
|
|
111
114
|
/**
|
|
112
115
|
* 请求参数接口
|
|
@@ -0,0 +1,246 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var validator = require('./validator.cjs');
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* 验证器装饰器模块
|
|
7
|
+
* 提供一系列用于数据验证的装饰器,可用于类属性的验证规则定义
|
|
8
|
+
* 这些装饰器基于 BaseValidator 的 decoratorCreator 方法创建
|
|
9
|
+
*/
|
|
10
|
+
/**
|
|
11
|
+
* 必填项验证装饰器
|
|
12
|
+
* 验证值是否存在且不在指定的无效值列表中
|
|
13
|
+
*
|
|
14
|
+
* @param noneVals 被视为无效的值数组,默认为 [undefined]
|
|
15
|
+
* @returns 装饰器工厂函数,可接收自定义错误消息
|
|
16
|
+
*
|
|
17
|
+
* @example
|
|
18
|
+
* class User extends BaseValidator {
|
|
19
|
+
* @(VRequired()('用户名不能为空'))
|
|
20
|
+
* username?: string;
|
|
21
|
+
* }
|
|
22
|
+
*/
|
|
23
|
+
function VRequired(noneVals) {
|
|
24
|
+
if (noneVals === void 0) { noneVals = [undefined]; }
|
|
25
|
+
return validator.BaseValidator.decoratorCreator(function (val) {
|
|
26
|
+
if (noneVals.includes(val)) {
|
|
27
|
+
return false;
|
|
28
|
+
}
|
|
29
|
+
return true;
|
|
30
|
+
});
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* 字符串类型验证装饰器
|
|
34
|
+
* 验证值是否为字符串类型
|
|
35
|
+
*
|
|
36
|
+
* @returns 装饰器工厂函数,可接收自定义错误消息
|
|
37
|
+
*
|
|
38
|
+
* @example
|
|
39
|
+
* class User extends BaseValidator {
|
|
40
|
+
* @VString('用户名必须为字符串')
|
|
41
|
+
* username?: string;
|
|
42
|
+
* }
|
|
43
|
+
*/
|
|
44
|
+
var VString = validator.BaseValidator.decoratorCreator(function (val) {
|
|
45
|
+
if (typeof val !== 'string') {
|
|
46
|
+
return false;
|
|
47
|
+
}
|
|
48
|
+
return true;
|
|
49
|
+
});
|
|
50
|
+
/**
|
|
51
|
+
* 数字类型验证装饰器
|
|
52
|
+
* 验证值是否为数字类型
|
|
53
|
+
*
|
|
54
|
+
* @returns 装饰器工厂函数,可接收自定义错误消息
|
|
55
|
+
*
|
|
56
|
+
* @example
|
|
57
|
+
* class User extends BaseValidator {
|
|
58
|
+
* @VNumber('年龄必须为数字')
|
|
59
|
+
* age?: number;
|
|
60
|
+
* }
|
|
61
|
+
*/
|
|
62
|
+
var VNumber = validator.BaseValidator.decoratorCreator(function (val) {
|
|
63
|
+
if (typeof val !== 'number') {
|
|
64
|
+
return false;
|
|
65
|
+
}
|
|
66
|
+
return true;
|
|
67
|
+
});
|
|
68
|
+
/**
|
|
69
|
+
* 数组类型验证装饰器
|
|
70
|
+
* 验证值是否为数组类型
|
|
71
|
+
*
|
|
72
|
+
* @returns 装饰器工厂函数,可接收自定义错误消息
|
|
73
|
+
*
|
|
74
|
+
* @example
|
|
75
|
+
* class User extends BaseValidator {
|
|
76
|
+
* @VArray('标签必须为数组')
|
|
77
|
+
* tags?: string[];
|
|
78
|
+
* }
|
|
79
|
+
*/
|
|
80
|
+
var VArray = validator.BaseValidator.decoratorCreator(function (val) {
|
|
81
|
+
if (!Array.isArray(val)) {
|
|
82
|
+
return false;
|
|
83
|
+
}
|
|
84
|
+
return true;
|
|
85
|
+
});
|
|
86
|
+
/**
|
|
87
|
+
* 布尔类型验证装饰器
|
|
88
|
+
* 验证值是否为布尔类型
|
|
89
|
+
*
|
|
90
|
+
* @returns 装饰器工厂函数,可接收自定义错误消息
|
|
91
|
+
*
|
|
92
|
+
* @example
|
|
93
|
+
* class User extends BaseValidator {
|
|
94
|
+
* @VBoolean('状态必须为布尔值')
|
|
95
|
+
* active?: boolean;
|
|
96
|
+
* }
|
|
97
|
+
*/
|
|
98
|
+
var VBoolean = validator.BaseValidator.decoratorCreator(function (val) {
|
|
99
|
+
if (typeof val !== 'boolean') {
|
|
100
|
+
return false;
|
|
101
|
+
}
|
|
102
|
+
return true;
|
|
103
|
+
});
|
|
104
|
+
/**
|
|
105
|
+
* 最小值验证装饰器
|
|
106
|
+
* 验证数字是否大于或等于指定的最小值
|
|
107
|
+
*
|
|
108
|
+
* @param min 最小值
|
|
109
|
+
* @returns 装饰器工厂函数,可接收自定义错误消息
|
|
110
|
+
*
|
|
111
|
+
* @example
|
|
112
|
+
* class User extends BaseValidator {
|
|
113
|
+
* @(VMin(18)('年龄必须大于或等于18岁'))
|
|
114
|
+
* age?: number;
|
|
115
|
+
* }
|
|
116
|
+
*/
|
|
117
|
+
var VMin = function (min) {
|
|
118
|
+
return validator.BaseValidator.decoratorCreator(function (val) {
|
|
119
|
+
if (typeof val !== 'number' || val < min) {
|
|
120
|
+
return false;
|
|
121
|
+
}
|
|
122
|
+
return true;
|
|
123
|
+
});
|
|
124
|
+
};
|
|
125
|
+
/**
|
|
126
|
+
* 最大值验证装饰器
|
|
127
|
+
* 验证数字是否小于或等于指定的最大值
|
|
128
|
+
*
|
|
129
|
+
* @param max 最大值
|
|
130
|
+
* @returns 装饰器工厂函数,可接收自定义错误消息
|
|
131
|
+
*
|
|
132
|
+
* @example
|
|
133
|
+
* class User extends BaseValidator {
|
|
134
|
+
* @(VMax(120)('年龄必须小于或等于120岁'))
|
|
135
|
+
* age?: number;
|
|
136
|
+
* }
|
|
137
|
+
*/
|
|
138
|
+
var VMax = function (max) {
|
|
139
|
+
return validator.BaseValidator.decoratorCreator(function (val) {
|
|
140
|
+
if (typeof val !== 'number' || val > max) {
|
|
141
|
+
return false;
|
|
142
|
+
}
|
|
143
|
+
return true;
|
|
144
|
+
});
|
|
145
|
+
};
|
|
146
|
+
/**
|
|
147
|
+
* 最小长度验证装饰器
|
|
148
|
+
* 验证字符串或数组的长度是否大于或等于指定的最小长度
|
|
149
|
+
*
|
|
150
|
+
* @param minLen 最小长度
|
|
151
|
+
* @returns 装饰器工厂函数,可接收自定义错误消息
|
|
152
|
+
*
|
|
153
|
+
* @example
|
|
154
|
+
* class User extends BaseValidator {
|
|
155
|
+
* @(VMinLength(6)('密码长度不能少于6位'))
|
|
156
|
+
* password?: string;
|
|
157
|
+
* }
|
|
158
|
+
*/
|
|
159
|
+
var VMinLength = function (minLen) {
|
|
160
|
+
return validator.BaseValidator.decoratorCreator(function (val) {
|
|
161
|
+
if (typeof val !== 'string' && !Array.isArray(val)) {
|
|
162
|
+
return false;
|
|
163
|
+
}
|
|
164
|
+
if (val.length < minLen) {
|
|
165
|
+
return false;
|
|
166
|
+
}
|
|
167
|
+
return true;
|
|
168
|
+
});
|
|
169
|
+
};
|
|
170
|
+
/**
|
|
171
|
+
* 最大长度验证装饰器
|
|
172
|
+
* 验证字符串或数组的长度是否小于或等于指定的最大长度
|
|
173
|
+
*
|
|
174
|
+
* @param maxLen 最大长度
|
|
175
|
+
* @returns 装饰器工厂函数,可接收自定义错误消息
|
|
176
|
+
*
|
|
177
|
+
* @example
|
|
178
|
+
* class User extends BaseValidator {
|
|
179
|
+
* @(VMaxLength(20)('用户名长度不能超过20位'))
|
|
180
|
+
* username?: string;
|
|
181
|
+
* }
|
|
182
|
+
*/
|
|
183
|
+
var VMaxLength = function (maxLen) {
|
|
184
|
+
return validator.BaseValidator.decoratorCreator(function (val) {
|
|
185
|
+
if (typeof val !== 'string' && !Array.isArray(val)) {
|
|
186
|
+
return false;
|
|
187
|
+
}
|
|
188
|
+
if (val.length > maxLen) {
|
|
189
|
+
return false;
|
|
190
|
+
}
|
|
191
|
+
return true;
|
|
192
|
+
});
|
|
193
|
+
};
|
|
194
|
+
/**
|
|
195
|
+
* 邮箱格式验证装饰器
|
|
196
|
+
* 验证字符串是否符合邮箱格式
|
|
197
|
+
*
|
|
198
|
+
* @returns 装饰器工厂函数,可接收自定义错误消息
|
|
199
|
+
*
|
|
200
|
+
* @example
|
|
201
|
+
* class User extends BaseValidator {
|
|
202
|
+
* @VEmail('邮箱格式不正确')
|
|
203
|
+
* email?: string;
|
|
204
|
+
* }
|
|
205
|
+
*/
|
|
206
|
+
var VEmail = validator.BaseValidator.decoratorCreator(function (val) {
|
|
207
|
+
if (typeof val !== 'string') {
|
|
208
|
+
return false;
|
|
209
|
+
}
|
|
210
|
+
// 简单邮箱正则
|
|
211
|
+
var emailReg = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
|
|
212
|
+
return emailReg.test(val);
|
|
213
|
+
});
|
|
214
|
+
/**
|
|
215
|
+
* 正则表达式验证装饰器
|
|
216
|
+
* 验证字符串是否匹配指定的正则表达式模式
|
|
217
|
+
*
|
|
218
|
+
* @param pattern 正则表达式
|
|
219
|
+
* @returns 装饰器工厂函数,可接收自定义错误消息
|
|
220
|
+
*
|
|
221
|
+
* @example
|
|
222
|
+
* class User extends BaseValidator {
|
|
223
|
+
* @(VPattern(/^1[3-9]\d{9}$/)('手机号格式不正确'))
|
|
224
|
+
* phone?: string;
|
|
225
|
+
* }
|
|
226
|
+
*/
|
|
227
|
+
var VPattern = function (pattern) {
|
|
228
|
+
return validator.BaseValidator.decoratorCreator(function (val) {
|
|
229
|
+
if (typeof val !== 'string') {
|
|
230
|
+
return false;
|
|
231
|
+
}
|
|
232
|
+
return pattern.test(val);
|
|
233
|
+
});
|
|
234
|
+
};
|
|
235
|
+
|
|
236
|
+
exports.VArray = VArray;
|
|
237
|
+
exports.VBoolean = VBoolean;
|
|
238
|
+
exports.VEmail = VEmail;
|
|
239
|
+
exports.VMax = VMax;
|
|
240
|
+
exports.VMaxLength = VMaxLength;
|
|
241
|
+
exports.VMin = VMin;
|
|
242
|
+
exports.VMinLength = VMinLength;
|
|
243
|
+
exports.VNumber = VNumber;
|
|
244
|
+
exports.VPattern = VPattern;
|
|
245
|
+
exports.VRequired = VRequired;
|
|
246
|
+
exports.VString = VString;
|