koishi-plugin-monetary-bank 2.2.0 → 2.3.0-Alpha.1
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/lib/index.d.ts +173 -30
- package/lib/index.js +1636 -258
- package/lib/templates.d.ts +36 -7
- package/package.json +9 -5
- package/readme.md +5 -5
- package/src/index.ts +1527 -302
- package/src/templates.ts +597 -56
package/lib/index.d.ts
CHANGED
|
@@ -15,19 +15,104 @@ export interface Config {
|
|
|
15
15
|
rate?: number;
|
|
16
16
|
cycle?: 'day' | 'week' | 'month';
|
|
17
17
|
}>;
|
|
18
|
+
header?: {
|
|
19
|
+
showAvatar?: boolean;
|
|
20
|
+
showUsername?: boolean;
|
|
21
|
+
bankTitle?: string;
|
|
22
|
+
showTime?: boolean;
|
|
23
|
+
};
|
|
24
|
+
transfer?: {
|
|
25
|
+
enabled?: boolean;
|
|
26
|
+
allowCash?: boolean;
|
|
27
|
+
fee?: {
|
|
28
|
+
rate?: number;
|
|
29
|
+
fixed?: number;
|
|
30
|
+
minFee?: number;
|
|
31
|
+
maxFee?: number;
|
|
32
|
+
};
|
|
33
|
+
creditCheck?: {
|
|
34
|
+
enabled?: boolean;
|
|
35
|
+
minPayerScore?: number;
|
|
36
|
+
minPayeeScore?: number;
|
|
37
|
+
};
|
|
38
|
+
freeze?: {
|
|
39
|
+
autoFreeze?: boolean;
|
|
40
|
+
accrual?: boolean;
|
|
41
|
+
durationMode?: 'fixed' | 'tiered';
|
|
42
|
+
fixedSeconds?: number;
|
|
43
|
+
tieredRules?: Array<{
|
|
44
|
+
threshold: number;
|
|
45
|
+
seconds: number;
|
|
46
|
+
}>;
|
|
47
|
+
};
|
|
48
|
+
};
|
|
49
|
+
numberFormat?: {
|
|
50
|
+
unit?: 'none' | 'zh' | 'en' | 'auto';
|
|
51
|
+
threshold?: number;
|
|
52
|
+
precision?: number;
|
|
53
|
+
};
|
|
18
54
|
}
|
|
19
55
|
export declare const Config: Schema<Config>;
|
|
20
56
|
export declare const inject: {
|
|
21
57
|
required: string[];
|
|
22
58
|
optional: string[];
|
|
23
59
|
};
|
|
60
|
+
/**
|
|
61
|
+
* 资产明细结构体
|
|
62
|
+
*/
|
|
63
|
+
export interface BankBalance {
|
|
64
|
+
total: number;
|
|
65
|
+
demand: number;
|
|
66
|
+
fixed: number;
|
|
67
|
+
availableDemand: number;
|
|
68
|
+
availableFixed: number;
|
|
69
|
+
frozen: {
|
|
70
|
+
total: number;
|
|
71
|
+
demand: number;
|
|
72
|
+
fixed: number;
|
|
73
|
+
demandAccrual: number;
|
|
74
|
+
demandNonAccrual: number;
|
|
75
|
+
};
|
|
76
|
+
}
|
|
77
|
+
/**
|
|
78
|
+
* 转账调用入参选项(供 API 及指令共用,不修改全局配置)
|
|
79
|
+
*/
|
|
80
|
+
export interface TransferApiOptions {
|
|
81
|
+
fromCash?: boolean;
|
|
82
|
+
feeRate?: number;
|
|
83
|
+
feeFixed?: number;
|
|
84
|
+
minFee?: number;
|
|
85
|
+
maxFee?: number;
|
|
86
|
+
innerFee?: boolean;
|
|
87
|
+
freeze?: boolean;
|
|
88
|
+
freezeDuration?: number;
|
|
89
|
+
freezeAccrual?: boolean;
|
|
90
|
+
reason?: string;
|
|
91
|
+
}
|
|
92
|
+
/**
|
|
93
|
+
* 转账执行结果
|
|
94
|
+
*/
|
|
95
|
+
export interface TransferResult {
|
|
96
|
+
success: boolean;
|
|
97
|
+
amount?: number;
|
|
98
|
+
fee?: number;
|
|
99
|
+
netAmount?: number;
|
|
100
|
+
innerFee?: boolean;
|
|
101
|
+
fromCash?: boolean;
|
|
102
|
+
frozen?: boolean;
|
|
103
|
+
unfreezeAt?: Date;
|
|
104
|
+
error?: string;
|
|
105
|
+
newPayerBalance?: BankBalance;
|
|
106
|
+
newPayerCash?: number;
|
|
107
|
+
newPayeeBalance?: BankBalance;
|
|
108
|
+
}
|
|
24
109
|
/**
|
|
25
110
|
* 数据库表结构声明
|
|
26
|
-
* monetary_bank_int 表用于记录所有存款(活期和定期)
|
|
27
111
|
*/
|
|
28
112
|
declare module 'koishi' {
|
|
29
113
|
interface Tables {
|
|
30
114
|
monetary_bank_int: MonetaryBankInterest;
|
|
115
|
+
monetary_bank_freeze: MonetaryBankFreeze;
|
|
31
116
|
}
|
|
32
117
|
interface Context {
|
|
33
118
|
monetaryBank: MonetaryBankAPI;
|
|
@@ -46,54 +131,95 @@ export declare class MonetaryBankAPI {
|
|
|
46
131
|
private config;
|
|
47
132
|
constructor(ctx: Context, config: Config);
|
|
48
133
|
/**
|
|
49
|
-
*
|
|
50
|
-
* @param uid 用户ID
|
|
51
|
-
* @param currency 货币类型
|
|
52
|
-
* @returns 包含总资产、活期、定期的余额信息
|
|
134
|
+
* 查询用户银行资产与冻结明细
|
|
53
135
|
*/
|
|
54
|
-
getBalance(uid: number, currency: string): Promise<
|
|
55
|
-
total: number;
|
|
56
|
-
demand: number;
|
|
57
|
-
fixed: number;
|
|
58
|
-
}>;
|
|
136
|
+
getBalance(uid: number, currency: string): Promise<BankBalance>;
|
|
59
137
|
/**
|
|
60
138
|
* 存款(从用户现金存入银行,自动转为活期)
|
|
61
|
-
* @param uid 用户ID
|
|
62
|
-
* @param currency 货币类型
|
|
63
|
-
* @param amount 存款金额
|
|
64
|
-
* @returns 成功返回 { success: true, newCash, newBalance },失败返回 { success: false, error }
|
|
65
139
|
*/
|
|
66
140
|
deposit(uid: number, currency: string, amount: number): Promise<{
|
|
67
141
|
success: boolean;
|
|
68
142
|
newCash?: number;
|
|
69
|
-
newBalance?:
|
|
70
|
-
total: number;
|
|
71
|
-
demand: number;
|
|
72
|
-
fixed: number;
|
|
73
|
-
};
|
|
143
|
+
newBalance?: BankBalance;
|
|
74
144
|
error?: string;
|
|
75
145
|
}>;
|
|
76
146
|
/**
|
|
77
|
-
*
|
|
78
|
-
* @param uid 用户ID
|
|
79
|
-
* @param currency 货币类型
|
|
80
|
-
* @param amount 取款金额
|
|
81
|
-
* @returns 成功返回 { success: true, newCash, newBalance },失败返回 { success: false, error }
|
|
147
|
+
* 取款(从银行取出到用户现金,仅可取活期可用余额)
|
|
82
148
|
*/
|
|
83
149
|
withdraw(uid: number, currency: string, amount: number): Promise<{
|
|
84
150
|
success: boolean;
|
|
85
151
|
newCash?: number;
|
|
86
|
-
newBalance?:
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
152
|
+
newBalance?: BankBalance;
|
|
153
|
+
error?: string;
|
|
154
|
+
}>;
|
|
155
|
+
/**
|
|
156
|
+
* 打款接口(直接向活期账户注入资金,只能操作活期存款)
|
|
157
|
+
*/
|
|
158
|
+
creditDemand(uid: number, currency: string, amount: number, options?: {
|
|
159
|
+
reason?: string;
|
|
160
|
+
}): Promise<{
|
|
161
|
+
success: boolean;
|
|
162
|
+
newBalance?: BankBalance;
|
|
163
|
+
error?: string;
|
|
164
|
+
}>;
|
|
165
|
+
/**
|
|
166
|
+
* 扣款接口(直接从活期账户扣减资金,只能操作活期存款,严格限制不可扣减冻结资金)
|
|
167
|
+
*/
|
|
168
|
+
debitDemand(uid: number, currency: string, amount: number, options?: {
|
|
169
|
+
reason?: string;
|
|
170
|
+
}): Promise<{
|
|
171
|
+
success: boolean;
|
|
172
|
+
newBalance?: BankBalance;
|
|
91
173
|
error?: string;
|
|
92
174
|
}>;
|
|
175
|
+
/**
|
|
176
|
+
* 冻结接口(支持活期与定期存款冻结,可指定结息属性、时长与原因)
|
|
177
|
+
*/
|
|
178
|
+
freeze(uid: number, currency: string, amount: number, type: 'demand' | 'fixed', options?: {
|
|
179
|
+
duration?: number;
|
|
180
|
+
unfreezeAt?: Date;
|
|
181
|
+
accrual?: boolean;
|
|
182
|
+
reason?: string;
|
|
183
|
+
sourceRecordId?: number;
|
|
184
|
+
}): Promise<{
|
|
185
|
+
success: boolean;
|
|
186
|
+
freezeId?: number;
|
|
187
|
+
newBalance?: BankBalance;
|
|
188
|
+
error?: string;
|
|
189
|
+
}>;
|
|
190
|
+
/**
|
|
191
|
+
* 解冻接口
|
|
192
|
+
*/
|
|
193
|
+
unfreeze(freezeId: number): Promise<{
|
|
194
|
+
success: boolean;
|
|
195
|
+
newBalance?: BankBalance;
|
|
196
|
+
error?: string;
|
|
197
|
+
}>;
|
|
198
|
+
/**
|
|
199
|
+
* 定期抵债没收接口(意外情况处置:定期未满利息不再发放,扣除定期本金)
|
|
200
|
+
*/
|
|
201
|
+
forfeitFixedFreeze(freezeId: number, options?: {
|
|
202
|
+
reason?: string;
|
|
203
|
+
}): Promise<{
|
|
204
|
+
success: boolean;
|
|
205
|
+
error?: string;
|
|
206
|
+
}>;
|
|
207
|
+
/**
|
|
208
|
+
* 查询用户冻结资产明细
|
|
209
|
+
*/
|
|
210
|
+
getFrozenBalance(uid: number, currency: string): Promise<{
|
|
211
|
+
total: number;
|
|
212
|
+
demand: number;
|
|
213
|
+
fixed: number;
|
|
214
|
+
records: MonetaryBankFreeze[];
|
|
215
|
+
}>;
|
|
216
|
+
/**
|
|
217
|
+
* 转账接口(支持自定义转账可配置项,不污染银行全局配置)
|
|
218
|
+
*/
|
|
219
|
+
transfer(fromUid: number, toUid: number, currency: string, amount: number, options?: TransferApiOptions): Promise<TransferResult>;
|
|
93
220
|
}
|
|
94
221
|
/**
|
|
95
222
|
* 利息记录表结构
|
|
96
|
-
* 用于记录每笔存款的利息计算信息(活期和定期)
|
|
97
223
|
*/
|
|
98
224
|
export interface MonetaryBankInterest {
|
|
99
225
|
id: number;
|
|
@@ -108,6 +234,23 @@ export interface MonetaryBankInterest {
|
|
|
108
234
|
nextRate?: number;
|
|
109
235
|
nextCycle?: 'day' | 'week' | 'month';
|
|
110
236
|
}
|
|
237
|
+
/**
|
|
238
|
+
* 冻结记录表结构
|
|
239
|
+
*/
|
|
240
|
+
export interface MonetaryBankFreeze {
|
|
241
|
+
id: number;
|
|
242
|
+
uid: number;
|
|
243
|
+
currency: string;
|
|
244
|
+
amount: number;
|
|
245
|
+
sourceType: 'demand' | 'fixed';
|
|
246
|
+
sourceRecordId?: number | null;
|
|
247
|
+
senderUid?: number | null;
|
|
248
|
+
accrual: boolean;
|
|
249
|
+
reason: string;
|
|
250
|
+
frozenAt: Date;
|
|
251
|
+
unfreezeAt?: Date | null;
|
|
252
|
+
status: 'frozen' | 'unfrozen' | 'forfeited';
|
|
253
|
+
}
|
|
111
254
|
/**
|
|
112
255
|
* 插件主函数
|
|
113
256
|
*/
|