koishi-plugin-pay-tool
Version:
适用于Koishi框架的易支付工具插件,支持订单创建、查询、退款、分配等功能
77 lines (76 loc) • 2.5 kB
TypeScript
/**
* 生成MD5签名
* @param params 参数对象
* @param key 商户密钥
* @returns MD5签名
*/
export declare function generateSign(params: Record<string, any>, key: string): string;
/**
* 验证签名
* @param params 参数对象
* @param key 商户密钥
* @returns 是否验证成功
*/
export declare function verifySign(params: Record<string, any>, key: string): boolean;
/**
* 生成订单号
* @param userId 用户ID
* @returns 订单号
*/
export declare function generateOrderNo(userId: string): string;
/**
* 获取客户端IP地址
* @returns IP地址
*/
export declare function getClientIp(): string;
/**
* 格式化金额为保留两位小数的字符串
* @param amount 金额
* @returns 格式化后的金额字符串
*/
export declare function formatAmount(amount: number | string): string;
/**
* 验证管理员权限
* @param userId 用户ID
* @param adminQQ 管理员QQ号
* @returns 是否为管理员
*/
export declare function isAdmin(userId: string, adminQQ: string): boolean;
/**
* 格式化支付方式显示名称
* @param paymentType 支付方式代码
* @param paymentMethods 支付方式配置字典
* @returns 支付方式显示名称
*/
export declare function formatPaymentType(paymentType: string, paymentMethods: Record<string, string>): string;
/**
* 规范化QQ号,处理@用户和平台前缀
* @param userId 用户ID,可能包含平台前缀或@标记
* @returns 纯数字QQ号,无效时返回空字符串
*/
export declare function normalizeQQId(userId: string): string;
/**
* 验证订单号格式
* @param tradeNo 订单号
* @returns 是否为有效的订单号格式
*/
export declare function isValidTradeNo(tradeNo: string): boolean;
/**
* 验证金额格式
* @param amount 金额字符串
* @returns 是否为有效金额
*/
export declare function isValidAmount(amount: string): boolean;
/**
* 验证并转换支付方式
* @param payment 用户输入的支付方式(可能是代码或显示名称)
* @param paymentMethods 支付方式配置字典
* @returns 转换后的支付方式代码,无效时返回null
*/
export declare function validateAndConvertPaymentType(payment: string, paymentMethods: Record<string, string>): string | null;
/**
* 获取支持的支付方式列表字符串
* @param paymentMethods 支付方式配置字典
* @returns 格式化的支付方式列表
*/
export declare function getAvailablePaymentMethods(paymentMethods: Record<string, string>): string;