@yunzhanghu/sdk-nodejs 1.0.1 → 1.0.2

package/README.md

@@ -93,7 +93,8 @@ const client = new yunzhanghu.InvoiceClient({
   private_key: process.env.PRIVATE_KEY,
   // 云账户公钥，登录云账户综合服务平台，选择“业务中心 > 业务管理 > 对接信息”获取
   yzh_public_key: process.env.YZH_PUBLIC_KEY,
-  // 签名方式
+  // 签名方式，登录云账户综合服务平台，选择“业务中心 > 业务管理 > 对接信息”获取
+  // 签名方式为 RSA，参数固定为：rsa
   sign_type: process.env.SIGN_TYPE,
 })
 

package/example/conf/config.js

@@ -23,8 +23,8 @@ MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDe4ipz4/EGFZphz2rYy8T2hdCL
 *
 QqP7lt6FdvzGxehaHwIDAQAB
 -----END PUBLIC KEY-----`,
-  // 签名方式，登录云账户综合服务平台，选择“业务中心 > 业务管理 > 对接信息”获取，默认为 RSA 签名方式。
-  // rsa：RSA 签名方式   sha256：HMAC 签名方式
+  // 签名方式，登录云账户综合服务平台，选择“业务中心 > 业务管理 > 对接信息”获取
+  // 签名方式为 RSA，参数固定为：rsa
   sign_type: "rsa",
 }
 module.exports = config

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yunzhanghu/sdk-nodejs",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "云账户 SDK for Node.js",
   "main": "yzh/index.js",
   "scripts": {

package/src/common/client.ts

@@ -26,7 +26,7 @@ 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/
    */
   constructor(conf: {
@@ -144,7 +144,7 @@ export class YZHClient {
   }
 
   /**
-   * 生成签名（RSA-SHA256）
+   * 生成签名（RSA 签名算法）
    * @param {string} data 经过加密后的具体数据
    * @param {string} mess 自定义随机字符串，用于签名
    * @param {string} timestamp 时间戳，精确到秒
@@ -163,7 +163,7 @@ export class YZHClient {
   }
 
   /**
-   * 生成签名（HmacSHA256）
+   * 生成签名（HMAC 签名算法）
    * @param {string} data 经过加密后的具体数据
    * @param {string} mess 自定义随机字符串，用于签名
    * @param {string} timestamp 时间戳，精确到秒
@@ -185,7 +185,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) => {

package/yzh/common/client.d.ts

@@ -17,7 +17,7 @@ export declare 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/
      */
     constructor(conf: {
@@ -41,7 +41,7 @@ export declare class YZHClient {
      */
     private generatorRequestParams;
     /**
-     * 生成签名（RSA-SHA256）
+     * 生成签名（RSA 签名算法）
      * @param {string} data 经过加密后的具体数据
      * @param {string} mess 自定义随机字符串，用于签名
      * @param {string} timestamp 时间戳，精确到秒
@@ -49,7 +49,7 @@ export declare class YZHClient {
      */
     private signRSASHA256;
     /**
-     * 生成签名（HmacSHA256）
+     * 生成签名（HMAC 签名算法）
      * @param {string} data 经过加密后的具体数据
      * @param {string} mess 自定义随机字符串，用于签名
      * @param {string} timestamp 时间戳，精确到秒
@@ -61,7 +61,7 @@ export declare 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;

package/yzh/common/client.js

@@ -15,12 +15,12 @@ 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/
      */
     constructor(conf) {
         /**
-         * 生成签名（RSA-SHA256）
+         * 生成签名（RSA 签名算法）
          * @param {string} data 经过加密后的具体数据
          * @param {string} mess 自定义随机字符串，用于签名
          * @param {string} timestamp 时间戳，精确到秒
@@ -39,7 +39,7 @@ class YZHClient {
             }
         };
         /**
-         * 生成签名（HmacSHA256）
+         * 生成签名（HMAC 签名算法）
          * @param {string} data 经过加密后的具体数据
          * @param {string} mess 自定义随机字符串，用于签名
          * @param {string} timestamp 时间戳，精确到秒
@@ -61,7 +61,7 @@ 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} 签名内容
          */
         this.sign = (data, mess, timestamp) => {
@@ -74,7 +74,7 @@ class YZHClient {
                         return this.signHmacSHA256(data, mess, timestamp);
                     }
                     default:
-                        throw new yzhSDKHttpException_1.default(`sign_type 类型不存在`);
+                        throw new yzhSDKHttpException_1.default(`sign_type类型不存在`);
                 }
             }
             catch (err) {