@yunzhanghu/sdk-nodejs 1.0.1 → 1.0.3

package/example/payment.js

@@ -1,115 +1,186 @@
 const yzhAPI = require("../yzh/index.js")
 const config = require("./conf/config.js")
+
 // 实时支付
 const payment = new yzhAPI.PaymentClient(config)
 
 // 银行卡实时支付
 payment
   .CreateBankpayOrder({
+    // request-id：请求 ID，请求的唯一标识
+    // 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+    // 如平台企业未自定义 request-id，将使用 SDK 中的 random 方法自动生成。注意：random 方法生成的 request-id 不能保证全局唯一，推荐自定义
+    request_id: "requestIdExample123456789",
     order_id: "nodetest123",
     dealer_id: config.dealer_id,
     broker_id: config.broker_id,
     real_name: "张三",
-    card_no: "1111111",
-    id_card: "11111111",
+    card_no: "8888888888888888888",
+    id_card: "110121202202222222",
     pay: "0.01",
     pay_remark: "test",
-    notify_url: "https://xxx",
+    notify_url: "https://www.example.com",
     project_id: "",
   })
   .then((data) => {
-    console.log("响应内容：", data)
+    if (data.code === "0000") {
+      // 操作成功
+      console.log("操作成功 ", data.data)
+    } else {
+      // 失败返回
+      console.log("失败返回 ", "code：" + data.code + " message：" + data.message + " request_id：" + data.request_id)
+    } 
   })
   .catch((err) => {
+    // 发生异常
     console.log(err.toString())
   })
 
 // 支付宝实时支付
 payment
   .CreateAlipayOrder({
+    // request-id：请求 ID，请求的唯一标识
+    // 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+    // 如平台企业未自定义 request-id，将使用 SDK 中的 random 方法自动生成。注意：random 方法生成的 request-id 不能保证全局唯一，推荐自定义
+    request_id: "requestIdExample123456789",
     order_id: "nodetest123",
     dealer_id: config.dealer_id,
     broker_id: config.broker_id,
     real_name: "张三",
-    card_no: "1111111",
-    id_card: "11111111",
+    card_no: "username@example.com",
+    id_card: "110121202202222222",
     pay: "0.01",
     check_name: "Check",
     pay_remark: "test",
-    notify_url: "https://xxx",
+    notify_url: "https://www.example.com",
     project_id: "",
   })
   .then((data) => {
-    console.log("响应内容：", data)
+    if (data.code === "0000") {
+      // 操作成功
+      console.log("操作成功 ", data.data)
+    } else {
+      // 失败返回
+      console.log("失败返回 ", "code：" + data.code + " message：" + data.message + " request_id：" + data.request_id)
+    } 
   })
   .catch((err) => {
+    // 发生异常
     console.log(err.toString())
   })
 
 // 微信实时支付
 payment
   .CreateWxpayOrder({
+    // request-id：请求 ID，请求的唯一标识
+    // 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+    // 如平台企业未自定义 request-id，将使用 SDK 中的 random 方法自动生成。注意：random 方法生成的 request-id 不能保证全局唯一，推荐自定义
+    request_id: "requestIdExample123456789",
     order_id: "nodetest1234",
     dealer_id: config.dealer_id,
     broker_id: config.broker_id,
     real_name: "张三",
-    openid: "1111111",
-    id_card: "11111111",
+    openid: "wx11111111111",
+    id_card: "110121202202222222",
     pay: "0.3",
     wx_app_id: "",
     pay_remark: "test",
-    notify_url: "https://xxx",
+    notify_url: "https://www.example.com",
     project_id: "",
   })
   .then((data) => {
-    console.log("响应内容：", data)
+    if (data.code === "0000") {
+      // 操作成功
+      console.log("操作成功 ", data.data)
+    } else {
+      // 失败返回
+      console.log("失败返回 ", "code：" + data.code + " message：" + data.message + " request_id：" + data.request_id)
+    } 
   })
   .catch((err) => {
+    // 发生异常
     console.log(err.toString())
   })
 
 // 查询单笔订单信息
 payment
   .GetOrder({
-    order_id: "2222",
+    // request-id：请求 ID，请求的唯一标识
+    // 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+    // 如平台企业未自定义 request-id，将使用 SDK 中的 random 方法自动生成。注意：random 方法生成的 request-id 不能保证全局唯一，推荐自定义
+    request_id: "requestIdExample123456789",
+    order_id: "nodetest123",
     channel: "支付宝",
     data_type: "",
   })
   .then((data) => {
-    console.log("响应内容：", data)
+    if (data.code === "0000") {
+      // 操作成功
+      console.log("操作成功 ", data.data)
+    } else {
+      // 失败返回
+      console.log("失败返回 ", "code：" + data.code + " message：" + data.message + " request_id：" + data.request_id)
+    } 
   })
   .catch((err) => {
+    // 发生异常
     console.log(err.toString())
   })
 
 // 查询平台企业余额
 payment
   .ListAccount({
+    // request-id：请求 ID，请求的唯一标识
+    // 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+    // 如平台企业未自定义 request-id，将使用 SDK 中的 random 方法自动生成。注意：random 方法生成的 request-id 不能保证全局唯一，推荐自定义
+    request_id: "requestIdExample123456789",
     dealer_id: config.dealer_id,
   })
   .then((data) => {
-    console.log("响应内容：", data)
+    if (data.code === "0000") {
+      // 操作成功
+      console.log("操作成功 ", data.data)
+    } else {
+      // 失败返回
+      console.log("失败返回 ", "code：" + data.code + " message：" + data.message + " request_id：" + data.request_id)
+    } 
   })
   .catch((err) => {
+    // 发生异常
     console.log(err.toString())
   })
 
 // 查询电子回单
 payment
   .GetEleReceiptFile({
+    // request-id：请求 ID，请求的唯一标识
+    // 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+    // 如平台企业未自定义 request-id，将使用 SDK 中的 random 方法自动生成。注意：random 方法生成的 request-id 不能保证全局唯一，推荐自定义
+    request_id: "requestIdExample123456789",
     order_id: "120530112204453",
     ref: "",
   })
   .then((data) => {
-    console.log("响应内容：", data)
+    if (data.code === "0000") {
+      // 操作成功
+      console.log("操作成功 ", data.data)
+    } else {
+      // 失败返回
+      console.log("失败返回 ", "code：" + data.code + " message：" + data.message + " request_id：" + data.request_id)
+    } 
   })
   .catch((err) => {
+    // 发生异常
     console.log(err.toString())
   })
 
 // 取消待支付订单
 payment
   .CancelOrder({
+    // request-id：请求 ID，请求的唯一标识
+    // 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+    // 如平台企业未自定义 request-id，将使用 SDK 中的 random 方法自动生成。注意：random 方法生成的 request-id 不能保证全局唯一，推荐自定义
+    request_id: "requestIdExample123456789",
     dealer_id: config.dealer_id,
     order_id: "2222",
   })
@@ -123,19 +194,34 @@ payment
 // 查询平台企业汇款信息
 payment
   .GetDealerVARechargeAccount({
+    // request-id：请求 ID，请求的唯一标识
+    // 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+    // 如平台企业未自定义 request-id，将使用 SDK 中的 random 方法自动生成。注意：random 方法生成的 request-id 不能保证全局唯一，推荐自定义
+    request_id: "requestIdExample123456789",
     dealer_id: config.dealer_id,
     broker_id: config.broker_id,
   })
   .then((data) => {
-    console.log("响应内容：", data)
+    if (data.code === "0000") {
+      // 操作成功
+      console.log("操作成功 ", data.data)
+    } else {
+      // 失败返回
+      console.log("失败返回 ", "code：" + data.code + " message：" + data.message + " request_id：" + data.request_id)
+    } 
   })
   .catch((err) => {
+    // 发生异常
     console.log(err.toString())
   })
 
 // 批次下单
 payment
   .CreateBatchOrder({
+    // request-id：请求 ID，请求的唯一标识
+    // 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+    // 如平台企业未自定义 request-id，将使用 SDK 中的 random 方法自动生成。注意：random 方法生成的 request-id 不能保证全局唯一，推荐自定义
+    request_id: "requestIdExample123456789",
     batch_id: "batchtest123456",
     dealer_id: config.dealer_id,
     broker_id: config.broker_id,
@@ -146,20 +232,20 @@ payment
       {
         order_id: "2013011801111",
         real_name: "张三",
-        card_no: "test333@163.com",
-        id_card: "11111",
+        card_no: "username1@example.com",
+        id_card: "110121202202222221",
         pay: "0.01",
         pay_remark: "测试订单1",
-        notify_url: "https://xxx",
+        notify_url: "https://www.example.com",
       },
       {
         order_id: "2013011802111",
         real_name: "李四",
-        card_no: "test123@123.com",
-        id_card: "22",
+        card_no: "username2@example.com",
+        id_card: "110121202202222222",
         pay: "0.01",
-        pay_remark: "测试订单2111",
-        notify_url: "https://xxx",
+        pay_remark: "测试订单2",
+        notify_url: "https://www.example.com",
       },
     ],
   })
@@ -173,14 +259,50 @@ payment
 // 批次确认
 payment
   .ConfirmBatchOrder({
-    batch_id: "batchtest1234",
+    // request-id：请求 ID，请求的唯一标识
+    // 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+    // 如平台企业未自定义 request-id，将使用 SDK 中的 random 方法自动生成。注意：random 方法生成的 request-id 不能保证全局唯一，推荐自定义
+    request_id: "requestIdExample123456789",
+    batch_id: "batchtest123456",
     dealer_id: config.dealer_id,
     broker_id: config.broker_id,
     channel: "支付宝",
   })
   .then((data) => {
-    console.log("响应内容：", data)
+    if (data.code === "0000") {
+      // 操作成功
+      console.log("操作成功 ", data.data)
+    } else {
+      // 失败返回
+      console.log("失败返回 ", "code：" + data.code + " message：" + data.message + " request_id：" + data.request_id)
+    } 
+  })
+  .catch((err) => {
+    // 发生异常
+    console.log(err.toString())
+  })
+
+// 批次撤销
+payment
+  .CancelBatchOrder({
+    // request-id：请求 ID，请求的唯一标识
+    // 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+    // 如平台企业未自定义 request-id，将使用 SDK 中的 random 方法自动生成。注意：random 方法生成的 request-id 不能保证全局唯一，推荐自定义
+    request_id: "requestIdExample123456789",
+    batch_id: "batchtest123456",
+    dealer_id: config.dealer_id,
+    broker_id: config.broker_id,
+  })
+  .then((data) => {
+    if (data.code === "0000") {
+      // 操作成功
+      console.log("操作成功 ", data.data)
+    } else {
+      // 失败返回
+      console.log("失败返回 ", "code：" + data.code + " message：" + data.message + " request_id：" + data.request_id)
+    } 
   })
   .catch((err) => {
+    // 发生异常
     console.log(err.toString())
   })

package/example/tax.js

@@ -7,28 +7,50 @@ const tax = new yzhAPI.TaxClient(config)
 // 下载个人所得税扣缴明细表
 tax
   .GetTaxFile({
+    // request-id：请求 ID，请求的唯一标识
+    // 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+    // 如平台企业未自定义 request-id，将使用 SDK 中的 random 方法自动生成。注意：random 方法生成的 request-id 不能保证全局唯一，推荐自定义
+    request_id: "requestIdExample123456789",
     dealer_id: config.dealer_id,
     ent_id: "accumulus_tj",
     year_month: "2022-10",
   })
   .then((data) => {
-    console.log("返回内容data", data)
+    if (data.code === "0000") {
+      // 操作成功
+      console.log("操作成功 ", data.data)
+    } else {
+      // 失败返回
+      console.log("失败返回 ", "code：" + data.code + " message：" + data.message + " request_id：" + data.request_id)
+    } 
   })
   .catch((err) => {
+    // 发生异常
     console.log(err.toString())
   })
 
 // 查询纳税人是否为跨集团用户
 tax
   .GetUserCross({
+    // request-id：请求 ID，请求的唯一标识
+    // 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+    // 如平台企业未自定义 request-id，将使用 SDK 中的 random 方法自动生成。注意：random 方法生成的 request-id 不能保证全局唯一，推荐自定义
+    request_id: "requestIdExample123456789",
     dealer_id: config.dealer_id,
     ent_id: "accumulus_tj",
-    id_card: "1201101199900000",
+    id_card: "110121202202222222",
     year: "2022",
   })
   .then((data) => {
-    console.log("返回内容data", data)
+    if (data.code === "0000") {
+      // 操作成功
+      console.log("操作成功 ", data.data)
+    } else {
+      // 失败返回
+      console.log("失败返回 ", "code：" + data.code + " message：" + data.message + " request_id：" + data.request_id)
+    } 
   })
   .catch((err) => {
+    // 发生异常
     console.log(err.toString())
   })

package/example/uploadusersign.js

@@ -0,0 +1,60 @@
+const yzhAPI = require("../yzh/index.js")
+const config = require("./conf/config.js")
+
+// 签约信息上传
+const uploaduserSign = new yzhAPI.UploadUserSignServiceClient(config)
+
+// 用户签约信息上传
+uploaduserSign
+  .UploadUserSign({
+    // request-id：请求 ID，请求的唯一标识
+    // 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+    // 如平台企业未自定义 request-id，将使用 SDK 中的 random 方法自动生成。注意：random 方法生成的 request-id 不能保证全局唯一，推荐自定义
+    request_id: "requestIdExample123456789",
+    dealer_id: config.dealer_id,
+    broker_id: config.broker_id,
+    real_name: "张三",
+    id_card: "110121202202222222",
+    phone: "188****8888",
+    is_abroad: false,
+    notify_url: "https://www.example.com",
+  })
+  .then((data) => {
+    if (data.code === "0000") {
+      // 操作成功
+      console.log("操作成功 ", data.data)
+    } else {
+      // 失败返回
+      console.log("失败返回 ", "code：" + data.code + " message：" + data.message + " request_id：" + data.request_id)
+    } 
+  })
+  .catch((err) => {
+    // 发生异常
+    console.log(err.toString())
+  })
+
+// 获取用户签约状态
+uploaduserSign
+  .GetUploadUserSignStatus({
+    // request-id：请求 ID，请求的唯一标识
+    // 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+    // 如平台企业未自定义 request-id，将使用 SDK 中的 random 方法自动生成。注意：random 方法生成的 request-id 不能保证全局唯一，推荐自定义
+    request_id: "requestIdExample123456789",
+    dealer_id: config.dealer_id,
+    broker_id: config.broker_id,
+    real_name: "张三",
+    id_card: "110121202202222222",
+  })
+  .then((data) => {
+    if (data.code === "0000") {
+      // 操作成功
+      console.log("操作成功 ", data.data)
+    } else {
+      // 失败返回
+      console.log("失败返回 ", "code：" + data.code + " message：" + data.message + " request_id：" + data.request_id)
+    } 
+  })
+  .catch((err) => {
+    // 发生异常
+    console.log(err.toString())
+  })

package/package.json

@@ -1,47 +1,52 @@
 {
-  "name": "@yunzhanghu/sdk-nodejs",
-  "version": "1.0.1",
-  "description": "云账户 SDK for Node.js",
-  "main": "yzh/index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "tsc",
-    "prettier": "prettier --config prettier.config.js --write 'src/**/*.{ts,js}'",
-    "lint:tsc": "tsc -p tsconfig.json --noEmit",
-    "lint:es": "eslint --ext .js,ts --cache src",
-    "prepare": "husky install"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/YunzhanghuOpen/sdk-nodejs"
-  },
-  "engines": {
-    "node": ">=12"
-  },
-  "author": "yunzhanghuapi",
-  "license": "Apache-2.0",
-  "devDependencies": {
-    "@types/crypto-js": "^4.1.1",
-    "@types/node": "^18.11.18",
-    "@types/urlencode": "^1.1.2",
-    "@typescript-eslint/eslint-plugin": "^5.50.0",
-    "@typescript-eslint/parser": "^5.50.0",
-    "eslint": "^8.33.0",
-    "husky": "^8.0.3",
-    "lint-staged": "^13.1.0",
-    "prettier": "^2.8.3",
-    "typescript": "^4.9.4"
-  },
-  "dependencies": {
-    "axios": "^1.2.1",
-    "crypto-js": "^4.1.1",
-    "tslib": "^2.4.1",
-    "urlencode": "^1.1.0"
-  },
-  "lint-staged": {
-    "*.{js,ts}": [
-      "eslint --fix --ext .js,ts --cache src",
-      "git add"
-    ]
-  }
+    "name": "@yunzhanghu/sdk-nodejs",
+    "version": "1.0.3",
+    "description": "云账户 SDK for Node.js",
+    "main": "yzh/index.js",
+    "scripts": {
+        "test": "echo \"Error: no test specified\" && exit 1",
+        "build": "tsc && node tdsformat.js && npm run format:dts",
+        "prettier": "prettier --config prettier.config.js --write 'src/**/*.{ts,js}'",
+        "lint:tsc": "tsc -p tsconfig.json --noEmit",
+        "lint:es": "eslint --ext .js,ts --cache src",
+        "format:dts": "prettier --write yzh/services/**/*.d.ts yzh/services/**/*.js",
+        "prepare": "husky install"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/YunzhanghuOpen/sdk-nodejs"
+    },
+    "engines": {
+        "node": ">=12"
+    },
+    "author": "yunzhanghuapi",
+    "license": "Apache-2.0",
+    "devDependencies": {
+        "@types/crypto-js": "^4.1.1",
+        "@types/json-bigint": "^1.0.2",
+        "@types/node": "^18.11.18",
+        "@types/urlencode": "^1.1.2",
+        "@types/vfile-message": "^2.0.0",
+        "@typescript-eslint/eslint-plugin": "^5.50.0",
+        "@typescript-eslint/parser": "^5.50.0",
+        "@yzh-devkit/eslint-config-lint": "^3.0.6",
+        "eslint": "^8.33.0",
+        "husky": "^8.0.3",
+        "lint-staged": "^13.1.0",
+        "prettier": "^2.8.3",
+        "typescript": "^4.9.4"
+    },
+    "dependencies": {
+        "axios": "^1.2.1",
+        "crypto-js": "^4.1.1",
+        "json-bigint": "^1.0.0",
+        "tslib": "^2.4.1",
+        "urlencode": "^1.1.0"
+    },
+    "lint-staged": {
+        "*.{js,ts}": [
+            "eslint --fix --ext .js,ts --cache src",
+            "git add"
+        ]
+    }
 }

package/src/common/client.ts

@@ -1,6 +1,9 @@
-import getInstance from "../common/http"
+/* eslint-disable no-param-reassign */
 import * as crypto from "crypto"
+
+import getInstance from "../common/http"
 import YZHSDKHttpException from "./exception/yzhSDKHttpException"
+
 const clearEncoding = "utf8"
 const cipherEncoding = "base64"
 
@@ -10,14 +13,23 @@ type ResponseData = any
 
 export class YZHClient {
   public dealer_id: string
+
   public broker_id: string
+
   public app_key: string
+
   public des3_key: string
+
   public private_key: string
+
   public yzh_public_key: string
+
   public sign_type: "rsa" | "sha256"
+
   public base_url?: string
 
+  public timeout?: number
+
   /**
    * 构造函数参数
    * @param {string} dealer_id 平台企业 ID
@@ -26,8 +38,9 @@ export class YZHClient {
    * @param {string} des3_key 3DES Key
    * @param {string} private_key 平台企业私钥
    * @param {string} yzh_public_key 云账户公钥
-   * @param {string} sign_type 签名方式"rsa" | "sha256"
+   * @param {string} sign_type 签名算法，支持 RSA、HMAC，枚举分别为 rsa、sha256
    * @param {string} base_url 可选，默认为 https://api-service.yunzhanghu.com/
+   * @param {number} timeout  请求超时时间。可选，默认30*1000ms。0为永不超时。
    */
   constructor(conf: {
     dealer_id: string
@@ -38,6 +51,7 @@ export class YZHClient {
     yzh_public_key: string
     sign_type: "rsa" | "sha256"
     base_url?: string
+    timeout?: number
   }) {
     const { dealer_id, broker_id, app_key, des3_key, private_key, yzh_public_key, sign_type } =
       conf || {}
@@ -59,6 +73,7 @@ export class YZHClient {
       this.yzh_public_key = conf.yzh_public_key
       this.sign_type = conf.sign_type
       this.base_url = conf?.base_url
+      this.timeout = conf?.timeout
     } else {
       throw new YZHSDKHttpException(
         `实例初始化失败，请检查以下配置是否缺失：\ndealer_id、broker_id、app_key、des3_key、private_key、yzh_public_key、sign_type`
@@ -76,9 +91,11 @@ export class YZHClient {
       request_id: request_id ?? this.mess(),
       dealer_id: this.dealer_id,
       base_url: this.base_url,
+      timeout: this.timeout,
     })
+
     // 返回请求实例
-    const baseInstanceConf = { method: method, url: action }
+    const baseInstanceConf = { method, url: action }
     let instanceConf
     if (method === "get") {
       instanceConf = { ...baseInstanceConf, params: encryptParams }
@@ -144,7 +161,7 @@ export class YZHClient {
   }
 
   /**
-   * 生成签名（RSA-SHA256）
+   * 生成签名（RSA 签名算法）
    * @param {string} data 经过加密后的具体数据
    * @param {string} mess 自定义随机字符串，用于签名
    * @param {string} timestamp 时间戳，精确到秒
@@ -163,7 +180,7 @@ export class YZHClient {
   }
 
   /**
-   * 生成签名（HmacSHA256）
+   * 生成签名（HMAC 签名算法）
    * @param {string} data 经过加密后的具体数据
    * @param {string} mess 自定义随机字符串，用于签名
    * @param {string} timestamp 时间戳，精确到秒
@@ -185,7 +202,7 @@ export class YZHClient {
    * @param {string} data 经过加密后的具体数据
    * @param {string} mess 自定义随机字符串，用于签名
    * @param {string} timestamp 时间戳，精确到秒
-   * @param {string} sign_type 签名方式
+   * @param {string} sign_type 签名算法，支持 RSA、HMAC，枚举分别为 rsa、sha256
    * @returns {string} 签名内容
    */
   private sign = (data: string, mess: string, timestamp: string) => {
@@ -198,7 +215,7 @@ export class YZHClient {
           return this.signHmacSHA256(data, mess, timestamp)
         }
         default:
-          throw new YZHSDKHttpException(`sign_type类型不存在`)
+          throw new YZHSDKHttpException(`sign_type 类型不存在`)
       }
     } catch (err) {
       throw new YZHSDKHttpException(`${err}`)
@@ -206,6 +223,7 @@ export class YZHClient {
   }
 
   // 自定义随机字符串
+  // eslint-disable-next-line class-methods-use-this
   private mess = () => {
     const buf = crypto.randomBytes(16)
     const token = buf.toString("hex")
@@ -233,6 +251,7 @@ export class YZHClient {
   }
 
   // 返回处理结果
+  // eslint-disable-next-line @typescript-eslint/require-await
   private async parseResponse(result: ResponseData, encryption?: boolean) {
     if (result.status !== 200) {
       const yzhError = new YZHSDKHttpException(result.statusText)