@gt6/sdk 1.0.12 → 1.0.14

package/README.md

@@ -1818,6 +1818,421 @@ const currentUser = sdk.getCurrentUser();
 }
 ```
 
+### 用户资金和订单管理
+
+用户模块还提供了资金信息、资金日志、零售订单和地址管理功能。
+
+#### 获取用户资金信息
+
+```javascript
+// 获取用户资金信息（完整响应）
+const fundsResponse = await sdk.getUserFunds();
+if (fundsResponse.success) {
+  console.log('可用余额:', fundsResponse.fund.fund);
+  console.log('冻结金额:', fundsResponse.fund.noFund);
+  console.log('租金:', fundsResponse.fund.rentFund);
+  console.log('保证金:', fundsResponse.fund.marginFund);
+  console.log('冻结保证金:', fundsResponse.fund.marginNoFund);
+  console.log('积分:', fundsResponse.fund.userIntegral);
+  console.log('信用等级:', fundsResponse.fund.creditLevel);
+} else {
+  console.error('获取资金信息失败:', fundsResponse.message);
+}
+
+// 获取用户资金信息（简化版本）
+const funds = await sdk.getFunds();
+if (funds) {
+  console.log('可用余额:', funds.fund);
+  console.log('冻结金额:', funds.noFund);
+} else {
+  console.log('获取资金信息失败');
+}
+```
+
+#### 获取资金日志列表
+
+```javascript
+// 获取资金日志列表（完整响应）
+const fundLogsResponse = await sdk.getFundLogs({
+  page: 1,
+  pageSize: 10
+});
+
+if (fundLogsResponse.success) {
+  console.log('资金日志总数:', fundLogsResponse.total);
+  fundLogsResponse.logs.forEach(log => {
+    console.log(`日志ID: ${log.logId}`);
+    console.log(`操作类型: ${log.fieldName}`);
+    console.log(`变动金额: ${log.changeAmount}`);
+    console.log(`新余额: ${log.newBalance}`);
+    console.log(`操作时间: ${log.operationTime}`);
+    console.log(`备注: ${log.remark || '-'}`);
+  });
+} else {
+  console.error('获取资金日志失败:', fundLogsResponse.message);
+}
+
+// 获取资金日志列表（简化版本）
+const fundLogs = await sdk.getFundLogsSimple(1, 10);
+if (fundLogs) {
+  console.log('资金日志总数:', fundLogs.total);
+  fundLogs.logs.forEach(log => {
+    console.log(`操作类型: ${log.fieldName}, 变动金额: ${log.changeAmount}`);
+  });
+} else {
+  console.log('获取资金日志失败');
+}
+```
+
+#### 获取零售订单列表
+
+```javascript
+// 获取零售订单列表（完整响应）
+const retailOrdersResponse = await sdk.getRetailOrders({
+  page: 1,
+  pageSize: 10
+});
+
+if (retailOrdersResponse.success) {
+  console.log('订单总数:', retailOrdersResponse.data.total);
+  retailOrdersResponse.data.orders.forEach(order => {
+    console.log(`订单ID: ${order.order_id}`);
+    console.log(`订单金额: $${order.total_amount}`);
+    console.log(`支付方式: ${order.pay_way}`);
+    console.log(`订单状态: ${order.status}`);
+    console.log(`创建时间: ${order.created_at}`);
+    
+    // 订单详情
+    if (order.details && order.details.length > 0) {
+      order.details.forEach(detail => {
+        console.log(`  商品ID: ${detail.product_id}`);
+        console.log(`  SKU: ${detail.sku}`);
+        console.log(`  数量: ${detail.quantity}`);
+        console.log(`  单价: $${detail.single_price}`);
+        console.log(`  总价: $${detail.total_price}`);
+      });
+    }
+  });
+} else {
+  console.error('获取零售订单失败:', retailOrdersResponse.message);
+}
+
+// 获取零售订单列表（简化版本）
+const retailOrders = await sdk.getRetailOrdersSimple(1, 10);
+if (retailOrders) {
+  console.log('订单总数:', retailOrders.total);
+  retailOrders.orders.forEach(order => {
+    console.log(`订单ID: ${order.order_id}, 金额: $${order.total_amount}, 状态: ${order.status}`);
+  });
+} else {
+  console.log('获取零售订单失败');
+}
+```
+
+#### 获取用户地址列表
+
+```javascript
+// 获取用户地址列表（完整响应）
+const addressesResponse = await sdk.getAddresses();
+if (addressesResponse.success && addressesResponse.addresses) {
+  addressesResponse.addresses.forEach(address => {
+    console.log(`地址ID: ${address.addressId}`);
+    console.log(`收货人: ${address.consignee}`);
+    console.log(`电话: ${address.phone}`);
+    console.log(`地址: ${address.address}`);
+    console.log(`区域ID: ${address.regionId}`);
+    console.log(`是否默认: ${address.isDefault}`);
+  });
+} else {
+  console.error('获取地址列表失败:', addressesResponse.message);
+}
+
+// 获取用户地址列表（简化版本）
+const addresses = await sdk.getAddressesSimple();
+if (addresses) {
+  addresses.forEach(address => {
+    console.log(`收货人: ${address.consignee}, 地址: ${address.address}`);
+  });
+} else {
+  console.log('获取地址列表失败');
+}
+
+// 根据地址ID获取地址信息
+const address = await sdk.getAddressById(123);
+if (address) {
+  console.log('地址信息:', address);
+} else {
+  console.log('地址不存在');
+}
+```
+
+#### 获取支付记录列表
+
+```javascript
+// 获取支付记录列表（完整响应）
+const paymentRecordsResponse = await sdk.getPaymentRecords({
+  page: 1,
+  pageSize: 10,
+  status: 'completed', // 可选：筛选状态
+  recordType: 1,       // 可选：筛选记录类型
+  methodId: 1          // 可选：筛选支付方式
+});
+
+if (paymentRecordsResponse.success) {
+  console.log('支付记录总数:', paymentRecordsResponse.total);
+  paymentRecordsResponse.records.forEach(record => {
+    console.log(`记录ID: ${record.id}`);
+    console.log(`订单ID: ${record.orderId}`);
+    console.log(`金额: $${record.amount}`);
+    console.log(`状态: ${record.status}`);
+    console.log(`创建时间: ${record.createTime}`);
+    console.log(`描述: ${record.description || '-'}`);
+  });
+} else {
+  console.error('获取支付记录失败:', paymentRecordsResponse.message);
+}
+
+// 获取支付记录列表（简化版本）
+const paymentRecords = await sdk.getPaymentRecordsSimple(1, 10);
+if (paymentRecords) {
+  console.log('支付记录总数:', paymentRecords.total);
+  paymentRecords.records.forEach(record => {
+    console.log(`订单ID: ${record.orderId}, 金额: $${record.amount}, 状态: ${record.status}`);
+  });
+} else {
+  console.log('获取支付记录失败');
+}
+```
+
+#### 在Astro组件中使用
+
+```astro
+---
+// dashboard.astro
+import { GT6SDK } from '@gt6/sdk';
+
+const sdk = new GT6SDK({
+  baseUrl: 'https://data.shopasb.io',
+  platformId: '1747558688'
+});
+
+// 检查用户登录状态
+const isLoggedIn = sdk.isLoggedIn();
+let userFunds = null;
+let fundLogs = null;
+let retailOrders = null;
+
+if (isLoggedIn) {
+  // 获取用户资金信息
+  userFunds = await sdk.getFunds();
+  
+  // 获取资金日志
+  fundLogs = await sdk.getFundLogsSimple(1, 5);
+  
+  // 获取零售订单
+  retailOrders = await sdk.getRetailOrdersSimple(1, 5);
+}
+---
+
+<html>
+  <head>
+    <title>用户仪表板</title>
+  </head>
+  <body>
+    {isLoggedIn ? (
+      <div>
+        <h1>用户仪表板</h1>
+        
+        <!-- 资金信息 -->
+        {userFunds && (
+          <div>
+            <h2>资金信息</h2>
+            <p>可用余额: ${userFunds.fund}</p>
+            <p>冻结金额: ${userFunds.noFund}</p>
+            <p>积分: {userFunds.userIntegral}</p>
+          </div>
+        )}
+        
+        <!-- 资金日志 -->
+        {fundLogs && (
+          <div>
+            <h2>最近资金日志</h2>
+            <ul>
+              {fundLogs.logs.map(log => (
+                <li>
+                  {log.fieldName}: {log.changeAmount} (余额: {log.newBalance})
+                  <br>
+                  <small>{new Date(log.operationTime).toLocaleString()}</small>
+                </li>
+              ))}
+            </ul>
+          </div>
+        )}
+        
+        <!-- 零售订单 -->
+        {retailOrders && (
+          <div>
+            <h2>最近订单</h2>
+            <ul>
+              {retailOrders.orders.map(order => (
+                <li>
+                  订单 #{order.order_id}: ${order.total_amount}
+                  <br>
+                  <small>状态: {order.status}</small>
+                </li>
+              ))}
+            </ul>
+          </div>
+        )}
+      </div>
+    ) : (
+      <div>
+        <h1>请先登录</h1>
+        <a href="/login">去登录</a>
+      </div>
+    )}
+  </body>
+</html>
+```
+
+#### 类型定义
+
+```typescript
+// 资金信息类型
+interface UserFunds {
+  id: number;
+  userId: number;
+  userType: number;
+  fund: string;           // 可用余额
+  noFund: string;         // 冻结金额
+  rentFund: string;       // 租金
+  marginFund: string;     // 保证金
+  marginNoFund: string;   // 冻结保证金
+  userIntegral: number;   // 积分
+  creditLevel: number;    // 信用等级
+}
+
+// 资金日志类型
+interface FundLog {
+  logId: number;
+  fundId: number | null;
+  userId: number;
+  fieldName: string;      // 操作类型
+  oldBalance: string;     // 旧余额
+  newBalance: string;     // 新余额
+  changeAmount: string;   // 变动金额
+  operatorId: number;     // 操作者ID
+  operationTime: string;  // 操作时间
+  remark: string | null;  // 备注
+}
+
+// 零售订单类型
+interface RetailOrder {
+  order_id: number;
+  user_id: number;
+  user_type: number;
+  total_amount: number;   // 订单总金额
+  pay_way: number;        // 支付方式
+  payment_record_id: number | null;
+  fund_log_id: number | null;
+  status: number;         // 订单状态
+  product_type: number;
+  created_at: string;     // 创建时间
+  updated_at: string;     // 更新时间
+  platform_id: number;
+  d1: number;
+  d2: number;
+  d3: number;
+  details: RetailOrderDetail[]; // 订单详情
+}
+
+// 零售订单详情类型
+interface RetailOrderDetail {
+  detail_id: number;
+  product_id: number;
+  product_name: string;
+  address_id: number;
+  sku: string;
+  shipping_fee: number;   // 运费
+  tax_fee: number;        // 税费
+  quantity: number;       // 数量
+  single_price: number;   // 单价
+  total_price: number;    // 总价
+  region_id: number;
+  remark: string;
+  created_at: string;
+  updated_at: string;
+}
+
+// 地址信息类型
+interface AddressInfo {
+  addressId: number;
+  consignee: string;      // 收货人
+  phone: string;          // 电话
+  address: string;        // 地址
+  regionId: number;       // 区域ID
+  isDefault: boolean;     // 是否默认地址
+}
+
+// 支付记录类型
+interface PaymentRecord {
+  id: number;
+  orderId: string;
+  userId: number;
+  userType: number;
+  methodId: number;       // 支付方式ID
+  recordType: number;     // 记录类型
+  amount: string;         // 金额
+  status: string;         // 状态
+  description?: string;   // 描述
+  adminDescription?: string;
+  img?: string;           // 图片
+  createTime: string;     // 创建时间
+  updateTime?: string;    // 更新时间
+}
+```
+
+### 错误处理
+
+用户认证方法返回统一的响应格式：
+
+```typescript
+// 登录成功响应
+{
+  success: true,
+  token: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
+  user: {
+    userId: 123,
+    username: "testuser",
+    userLevel: 1,
+    status: true,
+    platformId: 1,
+    d1: 0,
+    d2: 0,
+    d3: 0
+  }
+}
+
+// 登录失败响应
+{
+  success: false,
+  message: "用户名或密码错误"
+}
+
+// 注册成功响应
+{
+  success: true,
+  userId: 123,
+  message: "注册成功"
+}
+
+// 注册失败响应
+{
+  success: false,
+  message: "用户名已存在"
+}
+```
+
 ### 安全注意事项
 
 1. **密码安全**: 确保密码在传输前进行适当的加密