refactor: 所有业务线的接口调用添加TypeScript类型声明描述

This commit is contained in:
郝先瑞
2022-03-13 22:22:08 +08:00
parent 65035f584e
commit f2ca77992c
36 changed files with 1558 additions and 1214 deletions

6
src/types/api/index.d.ts vendored Normal file
View File

@@ -0,0 +1,6 @@
export * from './system'
export * from './pms'
export * from './sms'
export * from './ums'
export * from './oms'

58
src/types/api/oms/order.d.ts vendored Normal file
View File

@@ -0,0 +1,58 @@
import { PageQueryParam, PageResult } from "../base"
/**
* 订单查询参数类型声明
*/
export interface OrderQueryParam extends PageQueryParam {
orderSn: string | undefined;
status: number | undefined;
}
/**
* 订单分页列表项声明
*/
export interface Order {
id: string;
orderSn: string;
totalAmount: string;
payAmount: string;
payType: number;
status: number;
totalQuantity: number;
gmtCreate: string;
memberId: string;
sourceType: number;
orderItems: OrderItem[];
}
export interface OrderItem {
id: string;
orderId: string;
skuId: string;
skuName: string;
picUrl: string;
price: string;
count: number;
totalAmount: number;
}
/**
* 订单分页项类型声明
*/
export interface OrderPageResult extends PageResult<Order[]> {
}
/**
* 订单表单类型声明
*/
export interface OrderDetail {
id: number | undefined;
title: string;
picUrl: string;
beginTime: string;
endTime: string;
status: number;
sort: number;
url: string;
remark: string;
}

36
src/types/api/pms/brand.d.ts vendored Normal file
View File

@@ -0,0 +1,36 @@
import { PageQueryParam, PageResult } from "../base"
/**
* 品牌查询参数类型声明
*/
export interface BrandQueryParam extends PageQueryParam {
name: String | undefined
}
/**
* 品牌分页列表项声明
*/
export interface BrandItem {
id: string;
name: string;
logoUrl: string;
sort: number;
}
/**
* 品牌分页项类型声明
*/
export interface BrandPageResult extends PageResult<BrandItem[]> {
}
/**
* 品牌表单类型声明
*/
export interface BrandFormData {
id: number | undefined,
name: string,
logoUrl: string,
sort: number
}

73
src/types/api/pms/goods.d.ts vendored Normal file
View File

@@ -0,0 +1,73 @@
import { PageQueryParam, PageResult } from "../base"
/**
* 商品查询参数类型声明
*/
export interface GoodsQueryParam extends PageQueryParam {
name: stirng | undefined,
categoryId: number | undefined
}
/**
* 商品列表项类型声明
*/
export interface GoodsItem {
id: string;
name: string;
categoryId?: any;
brandId?: any;
originPrice: string;
price: string;
sales: number;
picUrl?: any;
album?: any;
unit?: any;
description: string;
detail: string;
status?: any;
categoryName: string;
brandName: string;
skuList: SkuItem[];
}
/**
* 商品规格项类型声明
*/
export interface SkuItem {
id: string;
skuSn?: any;
name: string;
spuId?: any;
specIds: string;
price: string;
stockNum: number;
lockedStockNum?: any;
picUrl?: any;
}
/**
* 商品分页项类型声明
*/
export interface GoodsPageResult extends PageResult<GoodsItem[]> {
}
/**
* 商品表单数据类型声明
*/
export interface GoodsFormData {
id: number|undefined,
deptId: number,
username: string,
nickname: string,
password: string,
mobile: string,
email: string,
gender: number,
status: number,
remark: string,
roleIds: number[]
}

40
src/types/api/sms/advert.d.ts vendored Normal file
View File

@@ -0,0 +1,40 @@
import { PageQueryParam, PageResult } from "../base"
/**
* 广告查询参数类型声明
*/
export interface AdvertQueryParam extends PageQueryParam {
name: String | undefined
}
/**
* 广告分页列表项声明
*/
export interface AdvertItem {
id: string;
name: string;
logoUrl: string;
sort: number;
}
/**
* 广告分页项类型声明
*/
export interface AdvertPageResult extends PageResult<AdvertItem[]> {
}
/**
* 广告表单类型声明
*/
export interface AdvertFormData {
id: number | undefined;
title: string;
picUrl: string;
beginTime: string;
endTime: string;
status: number;
sort: number;
url: string;
remark: string;
}

View File

@@ -1,4 +1,4 @@
import { PageQueryParam, PageResult } from "./base"
import { PageQueryParam, PageResult } from "../base"
/**
*

View File

@@ -28,7 +28,7 @@ export interface DeptItem {
*
*/
export interface DeptFormData {
id: number,
id: number|undefined,
parentId: number,
name: string,
sort: number,

View File

@@ -1,4 +1,4 @@
import { PageQueryParam, PageResult } from "./base"
import { PageQueryParam, PageResult } from "../base"
/**
*

View File

@@ -1,4 +1,4 @@
import { PageQueryParam, PageResult } from "./base"
import { PageQueryParam, PageResult } from "../base"
/**
*
@@ -31,7 +31,7 @@ export interface PermPageResult extends PageResult<PermItem[]> {
*
*/
export interface PermFormData {
id: number,
id: number|undefined,
name: string,
urlPerm: string,
btnPerm: string,

View File

@@ -1,4 +1,4 @@
import { PageQueryParam, PageResult } from "./base"
import { PageQueryParam, PageResult } from "../base"
/**
*
@@ -33,7 +33,7 @@ export interface RolePageResult extends PageResult<RoleItem[]> {
*
*/
export interface RoleFormData {
id: number,
id: number|undefined,
name: string,
code: string,
sort: number,

View File

@@ -1,4 +1,4 @@
import { PageQueryParam, PageResult } from "./base"
import { PageQueryParam, PageResult } from "../base"
/**
*
@@ -48,7 +48,7 @@ export interface UserPageResult extends PageResult<UserItem[]> {
*
*/
export interface UserFormData {
id: number,
id: number | undefined,
deptId: number,
username: string,
nickname: string,

1
src/types/api/ums/index.d.ts vendored Normal file
View File

@@ -0,0 +1 @@
export * from './member'

66
src/types/api/ums/member.d.ts vendored Normal file
View File

@@ -0,0 +1,66 @@
import { PageQueryParam, PageResult } from "../base"
/**
* 会员查询参数类型声明
*/
export interface MemberQueryParam extends PageQueryParam {
nickName: String | undefined
}
/**
* 会员分页列表项声明
*/
export interface MemberItem {
id: string;
gender: number;
nickName: string;
mobile: string;
birthday?: any;
avatarUrl: string;
openid: string;
sessionKey?: any;
city: string;
country: string;
language: string;
province: string;
status: number;
balance: string;
deleted: number;
point: number;
addressList: AddressItem[];
}
export interface AddressItem {
id: string;
memberId: string;
consigneeName: string;
consigneeMobile: string;
province: string;
city: string;
area: string;
detailAddress: string;
zipCode?: any;
defaulted: number;
}
/**
* 会员分页项类型声明
*/
export interface MemberPageResult extends PageResult<MemberItem[]> {
}
/**
* 会员表单类型声明
*/
export interface MemberFormData {
id: number | undefined;
title: string;
picUrl: string;
beginTime: string;
endTime: string;
status: number;
sort: number;
url: string;
remark: string;
}

27
src/types/index.d.ts vendored
View File

@@ -1,12 +1,21 @@
export * from './api/login'
export * from './api/user'
export * from './api/role'
export * from './api/menu'
export * from './api/dept'
export * from './api/dict'
export * from './api/perm'
export * from './api/client'
export * from './api/system/login'
export * from './api/system/user'
export * from './api/system/role'
export * from './api/system/menu'
export * from './api/system/dept'
export * from './api/system/dict'
export * from './api/system/perm'
export * from './api/system/client'
export * from './component'
export * from './api/pms/goods'
export * from './api/pms/goods'
export * from './api/sms/advert'
export * from './api/oms/order'
export * from './common'