@yunzhanghu/sdk-nodejs 1.0.2 → 1.0.4

package/src/common/exception/yzhSDKHttpException.ts

@@ -1,32 +1,35 @@
 export default class YZHSDKHttpException extends Error {
-  // 请求 ID
-  request_id: string
-  // HTTP 状态码
-  httpCode?: number
-  // 接口返回状态码
-  code?: string
+    // 请求 ID
+    request_id: string;
 
-  constructor(error: string, request_id = "") {
-    super(error)
-    this.request_id = request_id || ""
-  }
+    // HTTP 状态码
+    httpCode?: number;
 
-  getMessage(): string {
-    return this.message
-  }
+    // 接口返回状态码
+    code?: string;
 
-  getRequestId(): string {
-    return this.request_id
-  }
+    constructor(error: string, request_id = '') {
+        super(error);
+        this.request_id = request_id || '';
+    }
 
-  toString(): string {
-    return `[yzh_sdk_exception]  ${
-      this.code && `code:${this.code}`
-    }  requestId:${this.getRequestId()}  message:${this.getMessage()}`
-  }
-  toLocaleString(): string {
-    return `[yzh_sdk_exception]  ${
-      this.code && `code:${this.code}`
-    }  requestId:${this.getRequestId()}  message:${this.getMessage()}`
-  }
+    getMessage(): string {
+        return this.message;
+    }
+
+    getRequestId(): string {
+        return this.request_id;
+    }
+
+    toString(): string {
+        return `[yzh_sdk_exception]  ${
+            this.code && `code:${this.code}`
+        }  requestId:${this.getRequestId()}  message:${this.getMessage()}`;
+    }
+
+    toLocaleString(): string {
+        return `[yzh_sdk_exception]  ${
+            this.code && `code:${this.code}`
+        }  requestId:${this.getRequestId()}  message:${this.getMessage()}`;
+    }
 }

package/src/common/http/index.ts

@@ -1,57 +1,66 @@
-import axios from "axios"
-import * as urlencode from "urlencode"
-import * as pkg from "../../../package.json"
-import * as child_process from "child_process"
-const BASE_URL = "https://api-service.yunzhanghu.com/"
-
-const getInstance = (
-  config: { request_id?: string; dealer_id?: string; base_url?: string } = {}
-) => {
-  const instance = axios.create({
-    baseURL: config.base_url || BASE_URL,
-    headers: {
-      "request-id": config?.request_id,
-      "dealer-id": config?.dealer_id,
-      "Content-Type": "application/x-www-form-urlencoded;charset=UTF-8",
-      "User-Agent": `yunzhanghu-sdk-nodejs/${pkg.version}/${child_process
-        .execSync("uname -m -r -s")
-        .toString("utf-8")
-        .replace("\n", "")}/${process.version}`,
-    },
-    timeout: 30 * 1000,
-  })
-
-  // 拦截器
-  instance.interceptors.request.use(function (config) {
-    // URL Encode
-    if (config.method === "get") {
-      const { params: urlData } = config
-      const { data, sign, ...resData } = urlData
-      config.data = {
-        data: urlencode(data),
-        sign: urlencode(sign),
-        ...resData,
-      }
-    }
-    return config
-  })
-
-  instance.interceptors.response.use(function (response) {
-    const { data } = response
-    if (data) {
-      const { request_id, requestID, ...resResponse } = data
-      if (request_id || requestID) {
-        response.data = {
-          ...resResponse,
-          request_id: request_id || requestID,
+import axios from 'axios';
+import * as urlencode from 'urlencode';
+
+import * as pkg from '../../../package.json';
+
+const JsonBigString = require('json-bigint')({ storeAsString: true });
+
+const BASE_URL = 'https://api-service.yunzhanghu.com/';
+
+const getInstance = (config: { request_id?: string; dealer_id?: string; base_url?: string; timeout?: number } = {}) => {
+    const instance = axios.create({
+        baseURL: config.base_url || BASE_URL,
+        headers: {
+            'request-id': config?.request_id,
+            'dealer-id': config?.dealer_id,
+            'Content-Type': 'application/x-www-form-urlencoded;charset=UTF-8',
+            'User-Agent': `yunzhanghu-sdk-nodejs/${pkg.version}/${process.version}`,
+        },
+        timeout: config.timeout ?? 30 * 1000,
+        transformResponse: [
+            function toJson(data) {
+                try {
+                    return JsonBigString.parse(data);
+                } catch (e) {
+                    // data 返回的内容不是合法的json字符串时会报错，此时直接返回原 data 数据
+                    return data;
+                }
+            },
+        ],
+    });
+
+    // 拦截器
+    instance.interceptors.request.use(config => {
+        // URL Encode
+        if (config.method === 'get') {
+            const { params: urlData } = config;
+            const { data, sign, ...resData } = urlData;
+            // eslint-disable-next-line no-param-reassign
+            config.data = {
+                data: urlencode(data),
+                sign: urlencode(sign),
+                ...resData,
+            };
+        }
+        return config;
+    });
+
+    instance.interceptors.response.use(response => {
+        const { data } = response;
+        if (data) {
+            const { request_id, requestID, ...resResponse } = data;
+            if (request_id || requestID) {
+                response.data = {
+                    ...resResponse,
+                    request_id: request_id || requestID,
+                };
+            }
         }
-      }
-    }
 
-    return response
-  })
+        return response;
+    });
 
-  return instance
-}
+    return instance;
+};
 
-export default getInstance
+export default getInstance;

package/src/common/utils/index.ts

@@ -1,18 +1,20 @@
-import YZHclient from "../client"
+import YZHclient from '../client';
 
 export class Util 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
-  }) {
-    super(conf)
-  }
+    // 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);
+    }
 }
 
-export default Util
+export default Util;

package/src/index.ts

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

package/src/services/apiusersign/index.ts

@@ -1,148 +1,150 @@
-import YZHclient from "../../common/client"
+import YZHclient from '../../common/client';
 
 /** ApiUseSignContractRequest 获取协议预览 URL 请求 */
 interface ApiUseSignContractRequest {
-  /** 平台企业 ID */
-  dealer_id: string
-  /** 综合服务主体 ID */
-  broker_id: string
+    /** 平台企业 ID */
+    dealer_id: string;
+    /** 综合服务主体 ID */
+    broker_id: string;
 }
 
 /** ApiUseSignContractResponse 获取协议预览 URL 返回 */
 interface ApiUseSignContractResponse {
-  /** 预览跳转 URL */
-  url: string
-  /** 协议名称 */
-  title: string
+    /** 预览跳转 URL */
+    url: string;
+    /** 协议名称 */
+    title: string;
 }
 
 /** ApiUserSignContractRequest 获取协议预览 URL 请求 V2 */
 interface ApiUserSignContractRequest {
-  /** 平台企业 ID */
-  dealer_id: string
-  /** 综合服务主体 ID */
-  broker_id: string
+    /** 平台企业 ID */
+    dealer_id: string;
+    /** 综合服务主体 ID */
+    broker_id: string;
 }
 
 /** ApiUserSignContractResponse 获取协议预览 URL 返回 V2 */
 interface ApiUserSignContractResponse {
-  /** 预览跳转 URL */
-  url: string
-  /** 协议名称 */
-  title: string
+    /** 预览跳转 URL */
+    url: string;
+    /** 协议名称 */
+    title: string;
 }
 
 /** ApiUserSignRequest 用户签约请求 */
 interface ApiUserSignRequest {
-  /** 综合服务主体 ID */
-  broker_id: string
-  /** 平台企业 ID */
-  dealer_id: string
-  /** 姓名 */
-  real_name: string
-  /** 证件号码 */
-  id_card: string
-  /** 证件类型 idcard：身份证 passport：护照 mtphkm：港澳居民来往内地通行证  mtpt：台湾居民往来大陆通行证 rphkm：中华人民共和国港澳居民居住证 rpt：中华人民共和国台湾居民居住证 fpr：外国人永久居留身份证 ffwp：中华人民共和国外国人就业许可证书 */
-  card_type: string
+    /** 综合服务主体 ID */
+    broker_id: string;
+    /** 平台企业 ID */
+    dealer_id: string;
+    /** 姓名 */
+    real_name: string;
+    /** 证件号码 */
+    id_card: string;
+    /** 证件类型 idcard：身份证 passport：护照 mtphkm：港澳居民来往内地通行证  mtpt：台湾居民往来大陆通行证 rphkm：中华人民共和国港澳居民居住证 rpt：中华人民共和国台湾居民居住证 fpr：外国人永久居留身份证 ffwp：中华人民共和国外国人就业许可证书 */
+    card_type: string;
 }
 
 /** ApiUserSignResponse 用户签约返回 */
 interface ApiUserSignResponse {
-  /** 是否签约成功 */
-  status: string
+    /** 是否签约成功 */
+    status: string;
 }
 
 /** GetApiUserSignStatusRequest 获取用户签约状态请求 */
 interface GetApiUserSignStatusRequest {
-  /** 平台企业 ID */
-  dealer_id: string
-  /** 综合服务主体 ID */
-  broker_id: string
-  /** 姓名 */
-  real_name: string
-  /** 证件号码 */
-  id_card: string
+    /** 平台企业 ID */
+    dealer_id: string;
+    /** 综合服务主体 ID */
+    broker_id: string;
+    /** 姓名 */
+    real_name: string;
+    /** 证件号码 */
+    id_card: string;
 }
 
 /** GetApiUserSignStatusResponse 获取用户签约状态返回 */
 interface GetApiUserSignStatusResponse {
-  /** 签约时间 */
-  signed_at: string
-  /** 用户签约状态 */
-  status: string
+    /** 签约时间 */
+    signed_at: string;
+    /** 用户签约状态 */
+    status: string;
 }
 
 /** ApiUserSignReleaseRequest 用户解约（测试账号专用接口）请求 */
 interface ApiUserSignReleaseRequest {
-  /** 综合服务主体 ID */
-  broker_id: string
-  /** 平台企业 ID */
-  dealer_id: string
-  /** 姓名 */
-  real_name: string
-  /** 证件号码 */
-  id_card: string
-  /** 证件类型 idcard：身份证 passport：护照 mtphkm：港澳居民来往内地通行证  mtpt：台湾居民往来大陆通行证 rphkm：中华人民共和国港澳居民居住证 rpt：中华人民共和国台湾居民居住证 fpr：外国人永久居留身份证 ffwp：中华人民共和国外国人就业许可证书 */
-  card_type: string
+    /** 综合服务主体 ID */
+    broker_id: string;
+    /** 平台企业 ID */
+    dealer_id: string;
+    /** 姓名 */
+    real_name: string;
+    /** 证件号码 */
+    id_card: string;
+    /** 证件类型 idcard：身份证 passport：护照 mtphkm：港澳居民来往内地通行证  mtpt：台湾居民往来大陆通行证 rphkm：中华人民共和国港澳居民居住证 rpt：中华人民共和国台湾居民居住证 fpr：外国人永久居留身份证 ffwp：中华人民共和国外国人就业许可证书 */
+    card_type: string;
 }
 
 /** ApiUserSignReleaseResponse 用户解约（测试账号专用接口）返回 */
 interface ApiUserSignReleaseResponse {
-  /** 是否解约成功 */
-  status: string
+    /** 是否解约成功 */
+    status: string;
 }
 
 export class ApiUserSignServiceClient 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
-  }) {
-    super(conf)
-  }
-
-  // ApiUseSignContract 获取协议预览 URL
-  async ApiUseSignContract(
-    req: ApiUseSignContractRequest,
-    cb?: (error: null | string, rep: ApiUseSignContractResponse) => void
-  ): Promise<ApiUseSignContractResponse> {
-    return this.request("get", "/api/sign/v1/user/contract", req, { encryption: false }, cb)
-  }
-
-  // ApiUserSignContract 获取协议预览 URL V2
-  async ApiUserSignContract(
-    req: ApiUserSignContractRequest,
-    cb?: (error: null | string, rep: ApiUserSignContractResponse) => void
-  ): Promise<ApiUserSignContractResponse> {
-    return this.request("get", "/api/sign/v1/user/contract", req, { encryption: false }, cb)
-  }
-
-  // ApiUserSign 用户签约
-  async ApiUserSign(
-    req: ApiUserSignRequest,
-    cb?: (error: null | string, rep: ApiUserSignResponse) => void
-  ): Promise<ApiUserSignResponse> {
-    return this.request("post", "/api/sign/v1/user/sign", req, { encryption: false }, cb)
-  }
-
-  // GetApiUserSignStatus 获取用户签约状态
-  async GetApiUserSignStatus(
-    req: GetApiUserSignStatusRequest,
-    cb?: (error: null | string, rep: GetApiUserSignStatusResponse) => void
-  ): Promise<GetApiUserSignStatusResponse> {
-    return this.request("get", "/api/sign/v1/user/status", req, { encryption: false }, cb)
-  }
-
-  // ApiUserSignRelease 用户解约（测试账号专用接口）
-  async ApiUserSignRelease(
-    req: ApiUserSignReleaseRequest,
-    cb?: (error: null | string, rep: ApiUserSignReleaseResponse) => void
-  ): Promise<ApiUserSignReleaseResponse> {
-    return this.request("post", "/api/sign/v1/user/release", req, { encryption: false }, cb)
-  }
+    // 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);
+    }
+
+    // ApiUseSignContract 获取协议预览 URL
+    async ApiUseSignContract(
+        req: ApiUseSignContractRequest,
+        cb?: (error: null | string, rep: ApiUseSignContractResponse) => void
+    ): Promise<ApiUseSignContractResponse> {
+        return this.request('get', '/api/sign/v1/user/contract', req, { encryption: false }, cb);
+    }
+
+    // ApiUserSignContract 获取协议预览 URL V2
+    async ApiUserSignContract(
+        req: ApiUserSignContractRequest,
+        cb?: (error: null | string, rep: ApiUserSignContractResponse) => void
+    ): Promise<ApiUserSignContractResponse> {
+        return this.request('get', '/api/sign/v1/user/contract', req, { encryption: false }, cb);
+    }
+
+    // ApiUserSign 用户签约
+    async ApiUserSign(
+        req: ApiUserSignRequest,
+        cb?: (error: null | string, rep: ApiUserSignResponse) => void
+    ): Promise<ApiUserSignResponse> {
+        return this.request('post', '/api/sign/v1/user/sign', req, { encryption: false }, cb);
+    }
+
+    // GetApiUserSignStatus 获取用户签约状态
+    async GetApiUserSignStatus(
+        req: GetApiUserSignStatusRequest,
+        cb?: (error: null | string, rep: GetApiUserSignStatusResponse) => void
+    ): Promise<GetApiUserSignStatusResponse> {
+        return this.request('get', '/api/sign/v1/user/status', req, { encryption: false }, cb);
+    }
+
+    // ApiUserSignRelease 用户解约（测试账号专用接口）
+    async ApiUserSignRelease(
+        req: ApiUserSignReleaseRequest,
+        cb?: (error: null | string, rep: ApiUserSignReleaseResponse) => void
+    ): Promise<ApiUserSignReleaseResponse> {
+        return this.request('post', '/api/sign/v1/user/release', req, { encryption: false }, cb);
+    }
 }