优化文档

README.md

@@ -1,2 +1,64 @@
 # coa-wx-pay-isv
+
+[![GitHub license](https://img.shields.io/badge/license-MIT-green.svg?style=flat-square)](LICENSE)
+[![npm version](https://img.shields.io/npm/v/coa-wx-pay-isv.svg?style=flat-square)](https://www.npmjs.org/package/coa-wx-pay-isv)
+[![npm downloads](https://img.shields.io/npm/dm/coa-wx-pay-isv.svg?style=flat-square)](http://npm-stat.com/charts.html?package=coa-wx-pay-isv)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/coajs/coa-wx-pay-isv/pulls)
+
 轻量的微信支付SDK服务商版 for Node.js
+
+## 特点
+
+根据日常实际项目使用情况：
+
+- 覆盖了绝大多数使用场景
+- 统一了异步表现形式，全部返回 Promise
+- 内置类型引用，无需额外查看文档，开箱即用，IDE友好
+
+## 快速开始
+
+### 安装
+
+```shell
+yarn add coa-wx-pay-isv
+```
+
+### 直接使用
+
+```typescript
+import { CoaWxPayIsvBin, CoaWxPayIsvService } from 'coa-wx-pay-isv'
+
+// 微信支付配置
+const config = {
+  appId: 'wx00000000001',
+  mchId: '1550000001',
+  key: '1125XXXXXXXXXXXXXXXXXXX6E20DE9',
+  pfx: Buffer.from('XXXXXXX'),
+  notifyPay: 'https://example.com/api/notify/pay',
+  notifyRefund: 'https://example.com/api/notify/refund'
+}
+
+// 创建BIN实例
+const bin = new CoaWxPayIsvBin(config)
+
+// 创建服务
+const service = new CoaWxPayIsvService(bin)
+
+// 统一下单
+await service.unifiedOrder({ orderId: 'order000001', appWxaId: 'wx000000002', subMchId: '1660000001', openId: 'openIdxxxxxxx', price: 100 })
+
+// 根据预支付单号，获得支付参数
+await service.getPaymentParams({ appWxaId: 'wx000000002', prepayId: 'prepay00001' })
+
+// 查询订单
+await service.queryOrder({ orderId: 'order000001', appWxaId: 'wx000000002', subMchId: '1660000001' })
+
+// 退款
+await service.payRefund({ refundId: 'refund000001', orderId: 'order000001', price: 100, rawData: {} })
+
+// 查询退款订单
+await service.queryRefund({ refundId: 'refund000001', orderId: 'order000001', appWxaId: 'wx000000002', subMchId: '1660000001' })
+
+// 下载日对账单
+await service.downloadBill({ date: '20210331' })
+```

package.json

@@ -21,9 +21,9 @@
   },
   "scripts": {
     "dev": "tsc -w",
-    "build": "rm -rf dist && tsc && cp package.json *.md dist",
+    "build": "rm -rf dist && tsc && cp package.json *.md dist && rm -rf dist/test",
     "sync": "curl -X PUT 'https://npm.taobao.org/sync/coa-wx-pay-isv?sync_upstream=true'",
-    "publish-prerelease": "yarn build && yarn version --prerelease && cp package.json README.md dist && cd dist && npm publish"
+    "publish-prerelease": "yarn build && yarn version --prerelease && cp package.json *.md dist && cd dist && rm -rf test && npm publish"
   },
   "dependencies": {
     "coa-error": "^1.1.3",
@@ -35,4 +35,4 @@
     "@types/node": "^14.14.41",
     "typescript": "^4.2.3"
   }
-}
+}

src/test/demo.ts

@@ -0,0 +1,36 @@
+// @ts-nocheck
+import { CoaWxPayIsvBin, CoaWxPayIsvService } from '..'
+
+// 微信支付配置
+const config = {
+  appId: 'wx00000000001',
+  mchId: '1550000001',
+  key: '1125XXXXXXXXXXXXXXXXXXX6E20DE9',
+  pfx: Buffer.from('XXXXXXX'),
+  notifyPay: 'https://example.com/api/notify/pay',
+  notifyRefund: 'https://example.com/api/notify/refund'
+}
+
+// 创建BIN实例
+const bin = new CoaWxPayIsvBin(config)
+
+// 创建服务
+const service = new CoaWxPayIsvService(bin)
+
+// 统一下单
+await service.unifiedOrder({ orderId: 'order000001', appWxaId: 'wx000000002', subMchId: '1660000001', openId: 'openIdxxxxxxx', price: 100 })
+
+// 根据预支付单号，获得支付参数
+await service.getPaymentParams({ appWxaId: 'wx000000002', prepayId: 'prepay00001' })
+
+// 查询订单
+await service.queryOrder({ orderId: 'order000001', appWxaId: 'wx000000002', subMchId: '1660000001' })
+
+// 退款
+await service.payRefund({ refundId: 'refund000001', orderId: 'order000001', price: 100, rawData: {} })
+
+// 查询退款订单
+await service.queryRefund({ refundId: 'refund000001', orderId: 'order000001', appWxaId: 'wx000000002', subMchId: '1660000001' })
+
+// 下载日对账单
+await service.downloadBill({ date: '20210331' })