zentao-api 0.3.1 → 0.3.2
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 +38 -2
- package/dist/browser/zentao-api.global.js +2 -2
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/modules/define.d.ts +63 -0
- package/dist/modules/define.js +119 -0
- package/dist/modules/override.d.ts +60 -0
- package/dist/modules/override.js +113 -0
- package/dist/modules/query.d.ts +44 -0
- package/dist/modules/query.js +68 -0
- package/dist/modules/registry-store.d.ts +31 -0
- package/dist/modules/registry-store.js +133 -0
- package/dist/modules/registry.d.ts +4 -82
- package/dist/modules/registry.js +16 -221
- package/dist/types/client.d.ts +38 -0
- package/dist/types/client.js +1 -0
- package/dist/types/data.d.ts +42 -0
- package/dist/types/data.js +1 -0
- package/dist/types/index.d.ts +17 -359
- package/dist/types/index.js +17 -1
- package/dist/types/module.d.ts +124 -0
- package/dist/types/module.js +1 -0
- package/dist/types/options.d.ts +35 -0
- package/dist/types/options.js +1 -0
- package/dist/types/profile.d.ts +54 -0
- package/dist/types/profile.js +1 -0
- package/dist/types/response.d.ts +70 -0
- package/dist/types/response.js +1 -0
- package/dist/version.js +2 -2
- package/package.json +1 -1
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
/** 高阶 `request()` 归一化后的返回数据。 */
|
|
2
|
+
export interface ResponseData<T = unknown> {
|
|
3
|
+
/** 禅道服务端状态;非标准响应会按成功响应包装到 `data`。 */
|
|
4
|
+
status: 'success' | 'fail';
|
|
5
|
+
/** 禅道服务端返回的消息。 */
|
|
6
|
+
message?: string;
|
|
7
|
+
/** 原始消息字段;当服务端返回对象/数组等非字符串消息时保留在这里。 */
|
|
8
|
+
rawMessage?: unknown;
|
|
9
|
+
/** 服务端返回的业务错误码或状态码字段。 */
|
|
10
|
+
apiCode?: string | number;
|
|
11
|
+
/** 失败响应的原始对象,便于上层展示服务端返回的完整上下文。 */
|
|
12
|
+
raw?: Record<string, unknown>;
|
|
13
|
+
/** 根据模块动作 `resultGetter` 提取后的业务数据。 */
|
|
14
|
+
data?: T;
|
|
15
|
+
/** 统一分页信息。 */
|
|
16
|
+
pager?: {
|
|
17
|
+
/** 总记录数。 */
|
|
18
|
+
total: number;
|
|
19
|
+
/** 当前页码。 */
|
|
20
|
+
page: number;
|
|
21
|
+
/** 每页记录数。 */
|
|
22
|
+
recPerPage: number;
|
|
23
|
+
};
|
|
24
|
+
}
|
|
25
|
+
/** 禅道 API 原始分页结构。 */
|
|
26
|
+
export interface Pager {
|
|
27
|
+
/** 总记录数。 */
|
|
28
|
+
recTotal: number;
|
|
29
|
+
/** 每页记录数。 */
|
|
30
|
+
recPerPage: number;
|
|
31
|
+
/** 总页数,部分接口不返回。 */
|
|
32
|
+
pageTotal?: number;
|
|
33
|
+
/** 当前页码。 */
|
|
34
|
+
pageID: number;
|
|
35
|
+
}
|
|
36
|
+
/** 禅道 API 通用响应结构,允许携带任意业务字段。 */
|
|
37
|
+
export interface ApiResponse {
|
|
38
|
+
/** 服务端返回状态。 */
|
|
39
|
+
status: 'success' | 'fail';
|
|
40
|
+
/** 服务端消息,可能是字符串、对象或数组。 */
|
|
41
|
+
message?: unknown;
|
|
42
|
+
/** 其他业务字段。 */
|
|
43
|
+
[key: string]: unknown;
|
|
44
|
+
}
|
|
45
|
+
/** 禅道 API 列表响应结构。 */
|
|
46
|
+
export interface ApiListResponse extends ApiResponse {
|
|
47
|
+
/** 原始分页信息。 */
|
|
48
|
+
pager?: Pager;
|
|
49
|
+
}
|
|
50
|
+
/** 登录接口响应结构。 */
|
|
51
|
+
export interface LoginResponse extends ApiResponse {
|
|
52
|
+
/** 登录成功后返回的 API Token。 */
|
|
53
|
+
token?: string;
|
|
54
|
+
/** 部分禅道环境会随登录响应返回用户信息。 */
|
|
55
|
+
user?: Record<string, unknown>;
|
|
56
|
+
/** 部分禅道环境会随登录响应返回服务端配置。 */
|
|
57
|
+
serverConfig?: ServerConfig;
|
|
58
|
+
}
|
|
59
|
+
/** 禅道 `?mode=getconfig` 返回的服务端配置。 */
|
|
60
|
+
export interface ServerConfig {
|
|
61
|
+
version: string;
|
|
62
|
+
systemMode: string;
|
|
63
|
+
sprintConcept: string;
|
|
64
|
+
requestType: string;
|
|
65
|
+
requestFix: string;
|
|
66
|
+
moduleVar: string;
|
|
67
|
+
methodVar: string;
|
|
68
|
+
viewVar: string;
|
|
69
|
+
sessionVar: string;
|
|
70
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
package/dist/version.js
CHANGED