@yunzhanghu/sdk-nodejs 1.0.4 → 1.0.5

package/.eslintignore

@@ -1,4 +1,5 @@
 node_modules
 package.json
 .eslintrc.json
-yzh
+yzh
+example

package/example/custom.js

@@ -0,0 +1,53 @@
+const yzhAPI = require('../yzh/index.js');
+const config = require('./conf/config.js');
+
+// 通用请求函数
+const customClient = new yzhAPI.CustomClient(config);
+
+// 接口参数
+const req = {
+    /**
+     * @param {string} request-id：请求 ID，请求的唯一标识
+     * 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+     * 如未自定义 request-id，将使用 SDK 中的 random 方法自动生成。注意：random 方法生成的 request-id 不能保证全局唯一，推荐自定义 request-id
+     */
+    request_id: 'requestIdExample123456789',
+    order_id: '202009010016562012987',
+    dealer_id: config.dealer_id,
+    broker_id: config.broker_id,
+    real_name: '张三',
+    card_no: '6228888888888888888',
+    id_card: '11010519891231002X',
+    pay: '100.00',
+    pay_remark: '',
+    notify_url: 'https://www.example.com',
+};
+// 接口请求地址
+const url = '/api/payment/v1/order-bankpay';
+
+// 接口请求方式
+const method = 'post';
+
+/**
+ * 通用请求函数
+ * 适用于 SDK 暂未支持的接口
+ * 以“银行卡实时支付”接口为例
+ */
+customClient
+    .doRequest(req, url, method)
+    .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,6 +1,6 @@
 {
     "name": "@yunzhanghu/sdk-nodejs",
-    "version": "1.0.4",
+    "version": "1.0.5",
     "description": "云账户 SDK for Node.js",
     "main": "yzh/index.js",
     "scripts": {
@@ -27,8 +27,6 @@
         "@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",

package/src/common/client.ts

@@ -72,7 +72,7 @@ export class YZHClient {
     }
 
     // 基础请求：进行请求实例生成 Header，动态设置、请求体包装等偏底层操作
-    private doRequest(method: string, action: string, req: any): Promise<ResponseData> {
+    private doBaseRequest(method: string, action: string, req: any): Promise<ResponseData> {
         const { request_id, ...resReq } = req;
         // 请求参数加密
         const encryptParams = this.generatorRequestParams(resReq);
@@ -108,7 +108,7 @@ export class YZHClient {
             options = {} as any;
         }
         try {
-            const result = await this.doRequest(method, action, req ?? {});
+            const result = await this.doBaseRequest(method, action, req ?? {});
             // 错误码处理 > 验签 > 解密
             const responseData = await this.parseResponse(result, options?.encryption);
             cb && cb(null, responseData);

package/src/services/custom/index.ts

@@ -0,0 +1,36 @@
+import YZHClient from '../../common/client';
+
+export class CustomClient extends YZHClient {
+    // eslint-disable-next-line no-useless-constructor
+    constructor(conf: {
+        dealer_id: string;
+        broker_id: string;
+        app_key: string;
+        des3_key: string;
+        private_key: string;
+        yzh_public_key: string;
+        sign_type: 'rsa' | 'sha256';
+        base_url?: string;
+        timeout?: number;
+    }) {
+        super(conf);
+    }
+
+    /**
+     * 通用请求函数
+     * @param req 请求参数
+     * @param url 请求地址
+     * @param method 请求方式 'post' | 'get'
+     * @param cb
+     * @returns
+     */
+    public async doRequest<CustomRequest, CustomResponse>(
+        req: CustomRequest,
+        url: string,
+        method: string,
+        cb?: (error: null | string, rep: CustomResponse) => void
+    ): Promise<CustomResponse> {
+        const lower_method = method.toLowerCase();
+        return this.request(lower_method, url, req, { encryption: false }, cb);
+    }
+}

package/src/services/index.ts

@@ -3,6 +3,7 @@ export { ApiUserSignServiceClient } from './apiusersign';
 export { AuthenticationClient } from './authentication';
 export { BizlicXjjH5ServiceClient } from './bizlicxjjh5';
 export { BizlicXjjH5APIServiceClient } from './bizlicxjjh5api';
+export { CustomClient } from './custom';
 export { DataServiceClient } from './dataservice';
 export { H5UserSignServiceClient } from './h5usersign';
 export { InvoiceClient } from './invoice';

package/yzh/common/client.d.ts

@@ -7,7 +7,7 @@ export declare class YZHClient {
     des3_key: string;
     private_key: string;
     yzh_public_key: string;
-    sign_type: "rsa" | "sha256";
+    sign_type: 'rsa' | 'sha256';
     base_url?: string;
     timeout?: number;
     /**
@@ -29,11 +29,11 @@ export declare class YZHClient {
         des3_key: string;
         private_key: string;
         yzh_public_key: string;
-        sign_type: "rsa" | "sha256";
+        sign_type: 'rsa' | 'sha256';
         base_url?: string;
         timeout?: number;
     });
-    private doRequest;
+    private doBaseRequest;
     request(method: string, action: string, req?: any, options?: {
         encryption: boolean;
     }, cb?: ResponseCallback): Promise<ResponseData>;

package/yzh/common/client.js

@@ -5,8 +5,8 @@ exports.YZHClient = void 0;
 const crypto = require("crypto");
 const http_1 = require("../common/http");
 const yzhSDKHttpException_1 = require("./exception/yzhSDKHttpException");
-const clearEncoding = "utf8";
-const cipherEncoding = "base64";
+const clearEncoding = 'utf8';
+const cipherEncoding = 'base64';
 class YZHClient {
     /**
      * 构造函数参数
@@ -31,7 +31,7 @@ class YZHClient {
         this.signRSASHA256 = (data, mess, timestamp) => {
             try {
                 const plaintext = `data=${data}&mess=${mess}&timestamp=${timestamp}&key=${this.app_key}`;
-                const sign = crypto.createSign("RSA-SHA256");
+                const sign = crypto.createSign('RSA-SHA256');
                 sign.update(plaintext);
                 sign.end();
                 return sign.sign(this.private_key, cipherEncoding);
@@ -50,9 +50,9 @@ class YZHClient {
         this.signHmacSHA256 = (data, mess, timestamp) => {
             try {
                 const plaintext = `data=${data}&mess=${mess}&timestamp=${timestamp}&key=${this.app_key}`;
-                const hmac = crypto.createHmac("sha256", this.app_key);
+                const hmac = crypto.createHmac('sha256', this.app_key);
                 hmac.update(plaintext);
-                return hmac.digest("hex");
+                return hmac.digest('hex');
             }
             catch (err) {
                 throw new yzhSDKHttpException_1.default(`${err}`);
@@ -69,10 +69,10 @@ class YZHClient {
         this.sign = (data, mess, timestamp) => {
             try {
                 switch (this.sign_type) {
-                    case "rsa": {
+                    case 'rsa': {
                         return this.signRSASHA256(data, mess, timestamp);
                     }
-                    case "sha256": {
+                    case 'sha256': {
                         return this.signHmacSHA256(data, mess, timestamp);
                     }
                     default:
@@ -87,7 +87,7 @@ class YZHClient {
         // eslint-disable-next-line class-methods-use-this
         this.mess = () => {
             const buf = crypto.randomBytes(16);
-            const token = buf.toString("hex");
+            const token = buf.toString('hex');
             return token.toString();
         };
         /**
@@ -99,11 +99,11 @@ class YZHClient {
             try {
                 const iv = this.des3_key.slice(0, 8);
                 const cipherChunks = [];
-                const cipher = crypto.createCipheriv("des-ede3-cbc", this.des3_key, iv);
+                const cipher = crypto.createCipheriv('des-ede3-cbc', this.des3_key, iv);
                 cipher.setAutoPadding(true);
                 cipherChunks.push(cipher.update(plaintext, clearEncoding, cipherEncoding));
                 cipherChunks.push(cipher.final(cipherEncoding));
-                return cipherChunks.join("");
+                return cipherChunks.join('');
             }
             catch (err) {
                 throw new yzhSDKHttpException_1.default(`${err}`);
@@ -118,11 +118,11 @@ class YZHClient {
             try {
                 const iv = this.des3_key.slice(0, 8);
                 const cipherChunks = [];
-                const decipher = crypto.createDecipheriv("des-ede3-cbc", this.des3_key, iv);
+                const decipher = crypto.createDecipheriv('des-ede3-cbc', this.des3_key, iv);
                 decipher.setAutoPadding(true);
                 cipherChunks.push(decipher.update(ciphertext, cipherEncoding, clearEncoding));
                 cipherChunks.push(decipher.final(clearEncoding));
-                return JSON.parse(cipherChunks.join(""));
+                return JSON.parse(cipherChunks.join(''));
             }
             catch (err) {
                 throw new yzhSDKHttpException_1.default(`${err}`);
@@ -139,7 +139,7 @@ class YZHClient {
         this.verifyRSASHA256 = (data, mess, timestamp, sign) => {
             try {
                 const plaintext = `data=${data}&mess=${mess}&timestamp=${timestamp}&key=${this.app_key}`;
-                const verify = crypto.createVerify("RSA-SHA256");
+                const verify = crypto.createVerify('RSA-SHA256');
                 verify.update(plaintext);
                 return verify.verify(this.yzh_public_key, sign, cipherEncoding);
             }
@@ -150,9 +150,9 @@ class YZHClient {
         this.verifyHmacSHA256 = (data, mess, timestamp, sign) => {
             try {
                 const plaintext = `data=${data}&mess=${mess}&timestamp=${timestamp}&key=${this.app_key}`;
-                const hmac = crypto.createHmac("sha256", this.app_key);
+                const hmac = crypto.createHmac('sha256', this.app_key);
                 hmac.update(plaintext);
-                return hmac.digest("hex") === sign;
+                return hmac.digest('hex') === sign;
             }
             catch (err) {
                 throw new yzhSDKHttpException_1.default(`${err}`);
@@ -165,12 +165,12 @@ class YZHClient {
          */
         this.filePassWordDecryption = (ciphertextbase64) => {
             try {
-                const buff = Buffer.from(ciphertextbase64, "base64");
+                const buff = Buffer.from(ciphertextbase64, 'base64');
                 const decrypted = crypto.privateDecrypt({
                     key: this.private_key,
                     padding: crypto.constants.RSA_PKCS1_PADDING,
                 }, buff);
-                return decrypted.toString("utf8");
+                return decrypted.toString('utf8');
             }
             catch (err) {
                 throw new yzhSDKHttpException_1.default(`${err}`);
@@ -181,7 +181,7 @@ class YZHClient {
          * @param responseData 回调返回对象
          * @returns
          */
-        this.notifyDecoder = (responseData) => {
+        this.notifyDecoder = responseData => {
             const notifyDecoderResult = (data, mess, timestamp, sign) => {
                 const verifyMap = {
                     rsa: this.verifyRSASHA256,
@@ -202,17 +202,10 @@ class YZHClient {
             if (data && mess && timestamp && sign) {
                 return notifyDecoderResult(data, mess, timestamp, sign);
             }
-            return { result: false, plaintext: "" };
+            return { result: false, plaintext: '' };
         };
         const { dealer_id, broker_id, app_key, des3_key, private_key, yzh_public_key, sign_type } = conf || {};
-        if (conf &&
-            dealer_id &&
-            broker_id &&
-            app_key &&
-            des3_key &&
-            private_key &&
-            yzh_public_key &&
-            sign_type) {
+        if (conf && dealer_id && broker_id && app_key && des3_key && private_key && yzh_public_key && sign_type) {
             this.dealer_id = conf.dealer_id;
             this.broker_id = conf.broker_id;
             this.app_key = conf.app_key;
@@ -228,7 +221,7 @@ class YZHClient {
         }
     }
     // 基础请求：进行请求实例生成 Header，动态设置、请求体包装等偏底层操作
-    doRequest(method, action, req) {
+    doBaseRequest(method, action, req) {
         const { request_id, ...resReq } = req;
         // 请求参数加密
         const encryptParams = this.generatorRequestParams(resReq);
@@ -242,7 +235,7 @@ class YZHClient {
         // 返回请求实例
         const baseInstanceConf = { method, url: action };
         let instanceConf;
-        if (method === "get") {
+        if (method === 'get') {
             instanceConf = { ...baseInstanceConf, params: encryptParams };
         }
         else {
@@ -252,12 +245,12 @@ class YZHClient {
     }
     // 公共请求：调用封装好的基础请求方法 doRequest，进行发送请求与响应内容处理
     async request(method, action, req, options, cb) {
-        if (typeof options === "function") {
+        if (typeof options === 'function') {
             cb = options;
             options = {};
         }
         try {
-            const result = await this.doRequest(method, action, req !== null && req !== void 0 ? req : {});
+            const result = await this.doBaseRequest(method, action, req !== null && req !== void 0 ? req : {});
             // 错误码处理 > 验签 > 解密
             const responseData = await this.parseResponse(result, options === null || options === void 0 ? void 0 : options.encryption);
             cb && cb(null, responseData);

package/yzh/common/exception/yzhSDKHttpException.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 class YZHSDKHttpException extends Error {
-    constructor(error, request_id = "") {
+    constructor(error, request_id = '') {
         super(error);
-        this.request_id = request_id || "";
+        this.request_id = request_id || '';
     }
     getMessage() {
         return this.message;

package/yzh/common/http/index.js

@@ -3,17 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const axios_1 = require("axios");
 const urlencode = require("urlencode");
 const pkg = require("../../../package.json");
-const JsonBigString = require("json-bigint")({ storeAsString: true });
-const BASE_URL = "https://api-service.yunzhanghu.com/";
+const JsonBigString = require('json-bigint')({ storeAsString: true });
+const BASE_URL = 'https://api-service.yunzhanghu.com/';
 const getInstance = (config = {}) => {
     var _a;
     const instance = axios_1.default.create({
         baseURL: config.base_url || BASE_URL,
         headers: {
-            "request-id": config === null || config === void 0 ? void 0 : config.request_id,
-            "dealer-id": config === null || config === void 0 ? void 0 : config.dealer_id,
-            "Content-Type": "application/x-www-form-urlencoded;charset=UTF-8",
-            "User-Agent": `yunzhanghu-sdk-nodejs/${pkg.version}/${process.version}`,
+            'request-id': config === null || config === void 0 ? void 0 : config.request_id,
+            'dealer-id': config === null || config === void 0 ? void 0 : config.dealer_id,
+            'Content-Type': 'application/x-www-form-urlencoded;charset=UTF-8',
+            'User-Agent': `yunzhanghu-sdk-nodejs/${pkg.version}/${process.version}`,
         },
         timeout: (_a = config.timeout) !== null && _a !== void 0 ? _a : 30 * 1000,
         transformResponse: [
@@ -29,9 +29,9 @@ const getInstance = (config = {}) => {
         ],
     });
     // 拦截器
-    instance.interceptors.request.use((config) => {
+    instance.interceptors.request.use(config => {
         // URL Encode
-        if (config.method === "get") {
+        if (config.method === 'get') {
             const { params: urlData } = config;
             const { data, sign, ...resData } = urlData;
             // eslint-disable-next-line no-param-reassign
@@ -43,7 +43,7 @@ const getInstance = (config = {}) => {
         }
         return config;
     });
-    instance.interceptors.response.use((response) => {
+    instance.interceptors.response.use(response => {
         const { data } = response;
         if (data) {
             const { request_id, requestID, ...resResponse } = data;

package/yzh/common/utils/index.d.ts

@@ -1,4 +1,4 @@
-import YZHclient from "../client";
+import YZHclient from '../client';
 export declare class Util extends YZHclient {
     constructor(conf: {
         dealer_id: string;
@@ -7,7 +7,7 @@ export declare class Util extends YZHclient {
         des3_key: string;
         private_key: string;
         yzh_public_key: string;
-        sign_type: "rsa" | "sha256";
+        sign_type: 'rsa' | 'sha256';
         base_url?: string;
         timeout?: number;
     });

package/yzh/index.d.ts

@@ -1 +1 @@
-export * from "./services";
+export * from './services';

package/yzh/services/custom/index.d.ts

@@ -0,0 +1,28 @@
+import YZHClient from '../../common/client';
+export declare class CustomClient extends YZHClient {
+    constructor(conf: {
+        dealer_id: string;
+        broker_id: string;
+        app_key: string;
+        des3_key: string;
+        private_key: string;
+        yzh_public_key: string;
+        sign_type: 'rsa' | 'sha256';
+        base_url?: string;
+        timeout?: number;
+    });
+    /**
+     * 通用请求函数
+     * @param req 请求参数
+     * @param url 请求地址
+     * @param method 请求方式 'post' | 'get'
+     * @param cb
+     * @returns
+     */
+    doRequest<CustomRequest, CustomResponse>(
+        req: CustomRequest,
+        url: string,
+        method: string,
+        cb?: (error: null | string, rep: CustomResponse) => void
+    ): Promise<CustomResponse>;
+}

package/yzh/services/custom/index.js

@@ -0,0 +1,23 @@
+'use strict';
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.CustomClient = void 0;
+const client_1 = require('../../common/client');
+class CustomClient extends client_1.default {
+    // eslint-disable-next-line no-useless-constructor
+    constructor(conf) {
+        super(conf);
+    }
+    /**
+     * 通用请求函数
+     * @param req 请求参数
+     * @param url 请求地址
+     * @param method 请求方式 'post' | 'get'
+     * @param cb
+     * @returns
+     */
+    async doRequest(req, url, method, cb) {
+        const lower_method = method.toLowerCase();
+        return this.request(lower_method, url, req, { encryption: false }, cb);
+    }
+}
+exports.CustomClient = CustomClient;

package/yzh/services/index.d.ts

@@ -1,11 +1,12 @@
-export { Util } from "../common/utils";
-export { ApiUserSignServiceClient } from "./apiusersign";
-export { AuthenticationClient } from "./authentication";
-export { BizlicXjjH5ServiceClient } from "./bizlicxjjh5";
-export { BizlicXjjH5APIServiceClient } from "./bizlicxjjh5api";
-export { DataServiceClient } from "./dataservice";
-export { H5UserSignServiceClient } from "./h5usersign";
-export { InvoiceClient } from "./invoice";
-export { PaymentClient } from "./payment";
-export { TaxClient } from "./tax";
-export { UploadUserSignServiceClient } from "./uploadusersign";
+export { Util } from '../common/utils';
+export { ApiUserSignServiceClient } from './apiusersign';
+export { AuthenticationClient } from './authentication';
+export { BizlicXjjH5ServiceClient } from './bizlicxjjh5';
+export { BizlicXjjH5APIServiceClient } from './bizlicxjjh5api';
+export { CustomClient } from './custom';
+export { DataServiceClient } from './dataservice';
+export { H5UserSignServiceClient } from './h5usersign';
+export { InvoiceClient } from './invoice';
+export { PaymentClient } from './payment';
+export { TaxClient } from './tax';
+export { UploadUserSignServiceClient } from './uploadusersign';

package/yzh/services/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UploadUserSignServiceClient = exports.TaxClient = exports.PaymentClient = exports.InvoiceClient = exports.H5UserSignServiceClient = exports.DataServiceClient = exports.BizlicXjjH5APIServiceClient = exports.BizlicXjjH5ServiceClient = exports.AuthenticationClient = exports.ApiUserSignServiceClient = exports.Util = void 0;
+exports.UploadUserSignServiceClient = exports.TaxClient = exports.PaymentClient = exports.InvoiceClient = exports.H5UserSignServiceClient = exports.DataServiceClient = exports.CustomClient = exports.BizlicXjjH5APIServiceClient = exports.BizlicXjjH5ServiceClient = exports.AuthenticationClient = exports.ApiUserSignServiceClient = exports.Util = void 0;
 var utils_1 = require("../common/utils");
 Object.defineProperty(exports, "Util", { enumerable: true, get: function () { return utils_1.Util; } });
 var apiusersign_1 = require("./apiusersign");
@@ -11,6 +11,8 @@ var bizlicxjjh5_1 = require("./bizlicxjjh5");
 Object.defineProperty(exports, "BizlicXjjH5ServiceClient", { enumerable: true, get: function () { return bizlicxjjh5_1.BizlicXjjH5ServiceClient; } });
 var bizlicxjjh5api_1 = require("./bizlicxjjh5api");
 Object.defineProperty(exports, "BizlicXjjH5APIServiceClient", { enumerable: true, get: function () { return bizlicxjjh5api_1.BizlicXjjH5APIServiceClient; } });
+var custom_1 = require("./custom");
+Object.defineProperty(exports, "CustomClient", { enumerable: true, get: function () { return custom_1.CustomClient; } });
 var dataservice_1 = require("./dataservice");
 Object.defineProperty(exports, "DataServiceClient", { enumerable: true, get: function () { return dataservice_1.DataServiceClient; } });
 var h5usersign_1 = require("./h5usersign");