ipaynow-nodejs-sdk 1.0.0

package/src/params.js

@@ -0,0 +1,366 @@
+/**
+ * 将 Params 实例（不含 extraParams）与 extraParams 合并为字符串字段表。
+ * null/undefined 跳过；其余值转字符串；extraParams 与命名字段同名时以 extraParams 为准
+ * （即后写覆盖前写，与 Java BeanMap 行为一致）。
+ * @param {object} instance
+ * @returns {Record<string, string>}
+ */
+function toFieldsOf(instance) {
+  const out = {};
+  for (const key of Object.keys(instance)) {
+    if (key === "extraParams") continue;
+    const value = instance[key];
+    if (value === undefined || value === null) continue;
+    out[key] = String(value);
+  }
+  if (instance.extraParams) {
+    for (const [key, value] of Object.entries(instance.extraParams)) {
+      if (value === undefined || value === null) continue;
+      out[key] = String(value);
+    }
+  }
+  return out;
+}
+
+/** JSAPI 统一下单入参（规范 §5.1） */
+export class JsapiUnifiedOrderParams {
+  /** @param {object} [fields] */
+  constructor(fields = {}) {
+    const {
+      consumerCreateIp,
+      consumerId,
+      deviceType = "0600",
+      frontNotifyUrl,
+      mhtCurrencyType = "156",
+      mhtGoodsTag,
+      mhtGoodsDetails,
+      mhtLimitPay,
+      mhtOrderAmt,
+      mhtOrderDetail,
+      mhtOrderName,
+      mhtOrderNo,
+      mhtOrderStartTime,
+      mhtOrderTimeOut = 120,
+      mhtOrderType = "05",
+      mhtReserved,
+      mhtSubAppId,
+      notifyUrl,
+      outputType,
+      payChannelType,
+      extraParams,
+    } = fields;
+    Object.assign(this, {
+      consumerCreateIp,
+      consumerId,
+      deviceType,
+      frontNotifyUrl,
+      mhtCurrencyType,
+      mhtGoodsTag,
+      mhtGoodsDetails,
+      mhtLimitPay,
+      mhtOrderAmt,
+      mhtOrderDetail,
+      mhtOrderName,
+      mhtOrderNo,
+      mhtOrderStartTime,
+      mhtOrderTimeOut,
+      mhtOrderType,
+      mhtReserved,
+      mhtSubAppId,
+      notifyUrl,
+      outputType,
+      payChannelType,
+    });
+    this.extraParams = extraParams;
+  }
+
+  toFields() {
+    return toFieldsOf(this);
+  }
+}
+
+/** 聚合码统一下单入参（规范 §5.2） */
+export class AggregateCodeUnifiedOrderParams {
+  /** @param {object} [fields] */
+  constructor(fields = {}) {
+    const {
+      deviceType = "20",
+      mhtCurrencyType = "156",
+      mhtLimitPay,
+      mhtOrderAmt,
+      mhtOrderDetail,
+      mhtOrderName,
+      mhtOrderNo,
+      mhtOrderStartTime,
+      mhtOrderTimeOut = 120,
+      mhtOrderType = "05",
+      mhtReserved,
+      notifyUrl,
+      outputType,
+      extraParams,
+    } = fields;
+    Object.assign(this, {
+      deviceType,
+      mhtCurrencyType,
+      mhtLimitPay,
+      mhtOrderAmt,
+      mhtOrderDetail,
+      mhtOrderName,
+      mhtOrderNo,
+      mhtOrderStartTime,
+      mhtOrderTimeOut,
+      mhtOrderType,
+      mhtReserved,
+      notifyUrl,
+      outputType,
+    });
+    this.extraParams = extraParams;
+  }
+
+  toFields() {
+    return toFieldsOf(this);
+  }
+}
+
+/** 小程序统一下单入参（规范 §5.3） */
+export class MiniProgramUnifiedOrderParams {
+  /** @param {object} [fields] */
+  constructor(fields = {}) {
+    const {
+      consumerId,
+      deviceType = "14",
+      discountAmt,
+      mhtCurrencyType = "156",
+      mhtGoodsTag,
+      mhtGoodsDetails,
+      mhtLimitPay,
+      mhtOrderAmt,
+      mhtOrderDetail,
+      mhtOrderName,
+      mhtOrderNo,
+      mhtOrderStartTime,
+      mhtOrderTimeOut = 120,
+      mhtOrderType = "05",
+      mhtReserved,
+      mhtSubAppId,
+      notifyUrl,
+      oriMhtOrderAmt,
+      outputType = "1",
+      payChannelType,
+      mhtStoreId,
+      extraParams,
+    } = fields;
+    Object.assign(this, {
+      consumerId,
+      deviceType,
+      discountAmt,
+      mhtCurrencyType,
+      mhtGoodsTag,
+      mhtGoodsDetails,
+      mhtLimitPay,
+      mhtOrderAmt,
+      mhtOrderDetail,
+      mhtOrderName,
+      mhtOrderNo,
+      mhtOrderStartTime,
+      mhtOrderTimeOut,
+      mhtOrderType,
+      mhtReserved,
+      mhtSubAppId,
+      notifyUrl,
+      oriMhtOrderAmt,
+      outputType,
+      payChannelType,
+      mhtStoreId,
+    });
+    this.extraParams = extraParams;
+  }
+
+  toFields() {
+    return toFieldsOf(this);
+  }
+}
+
+/** H5 统一下单入参（规范 §5.4） */
+export class H5UnifiedOrderParams {
+  /** @param {object} [fields] */
+  constructor(fields = {}) {
+    const {
+      consumerCreateIp,
+      consumerId,
+      deviceType = "0601",
+      frontNotifyUrl,
+      mhtCurrencyType = "156",
+      mhtLimitPay,
+      mhtOrderAmt,
+      mhtOrderDetail,
+      mhtOrderName,
+      mhtOrderNo,
+      mhtOrderStartTime,
+      mhtOrderTimeOut = 120,
+      mhtOrderType = "05",
+      mhtReserved,
+      notifyUrl,
+      outputType,
+      payChannelType,
+      specifiedChannel,
+      payAccNo,
+      guideId,
+      extraParams,
+    } = fields;
+    Object.assign(this, {
+      consumerCreateIp,
+      consumerId,
+      deviceType,
+      frontNotifyUrl,
+      mhtCurrencyType,
+      mhtLimitPay,
+      mhtOrderAmt,
+      mhtOrderDetail,
+      mhtOrderName,
+      mhtOrderNo,
+      mhtOrderStartTime,
+      mhtOrderTimeOut,
+      mhtOrderType,
+      mhtReserved,
+      notifyUrl,
+      outputType,
+      payChannelType,
+      specifiedChannel,
+      payAccNo,
+      guideId,
+    });
+    this.extraParams = extraParams;
+  }
+
+  toFields() {
+    return toFieldsOf(this);
+  }
+}
+
+/** APP 统一下单入参（规范 §5.5） */
+export class AppUnifiedOrderParams {
+  /** @param {object} [fields] */
+  constructor(fields = {}) {
+    const {
+      consumerCreateIp,
+      consumerId,
+      consumerName,
+      deviceType = "01",
+      mhtCurrencyType = "156",
+      mhtLimitPay,
+      mhtOrderAmt,
+      mhtOrderDetail,
+      mhtOrderName,
+      mhtOrderNo,
+      mhtOrderStartTime,
+      mhtOrderTimeOut = 120,
+      mhtOrderType = "05",
+      mhtReserved,
+      mhtSubAppId,
+      notifyUrl,
+      payChannelType,
+      outputType = "0",
+      frontNotifyUrl,
+      mhtStoreId,
+      extraParams,
+    } = fields;
+    Object.assign(this, {
+      consumerCreateIp,
+      consumerId,
+      consumerName,
+      deviceType,
+      mhtCurrencyType,
+      mhtLimitPay,
+      mhtOrderAmt,
+      mhtOrderDetail,
+      mhtOrderName,
+      mhtOrderNo,
+      mhtOrderStartTime,
+      mhtOrderTimeOut,
+      mhtOrderType,
+      mhtReserved,
+      mhtSubAppId,
+      notifyUrl,
+      payChannelType,
+      outputType,
+      frontNotifyUrl,
+      mhtStoreId,
+    });
+    this.extraParams = extraParams;
+  }
+
+  toFields() {
+    return toFieldsOf(this);
+  }
+}
+
+/** 订单查询入参（规范 §5.6） */
+export class OrderQueryParams {
+  /** @param {object} [fields] */
+  constructor(fields = {}) {
+    const { deviceType, mhtOrderNo, version, extraParams } = fields;
+    Object.assign(this, { deviceType, mhtOrderNo, version });
+    this.extraParams = extraParams;
+  }
+
+  toFields() {
+    return toFieldsOf(this);
+  }
+}
+
+/** 退款入参（规范 §5.7） */
+export class RefundParams {
+  /** @param {object} [fields] */
+  constructor(fields = {}) {
+    const { amount, mhtOrderNo, mhtRefundNo, notifyUrl, oriTransId, reason, extraParams } = fields;
+    Object.assign(this, { amount, mhtOrderNo, mhtRefundNo, notifyUrl, oriTransId, reason });
+    this.extraParams = extraParams;
+  }
+
+  toFields() {
+    return toFieldsOf(this);
+  }
+}
+
+/** 退款查询入参（规范 §5.8） */
+export class RefundQueryParams {
+  /** @param {object} [fields] */
+  constructor(fields = {}) {
+    const { mhtRefundNo, extraParams } = fields;
+    Object.assign(this, { mhtRefundNo });
+    this.extraParams = extraParams;
+  }
+
+  toFields() {
+    return toFieldsOf(this);
+  }
+}
+
+/** 撤销入参（规范 §5.9） */
+export class ReverseParams {
+  /** @param {object} [fields] */
+  constructor(fields = {}) {
+    const { mhtRefundNo, mhtOrderNo, oriTransId, reason, extraParams } = fields;
+    Object.assign(this, { mhtRefundNo, mhtOrderNo, oriTransId, reason });
+    this.extraParams = extraParams;
+  }
+
+  toFields() {
+    return toFieldsOf(this);
+  }
+}
+
+/** 撤销查询入参（规范 §5.10） */
+export class ReverseQueryParams {
+  /** @param {object} [fields] */
+  constructor(fields = {}) {
+    const { mhtRefundNo, extraParams } = fields;
+    Object.assign(this, { mhtRefundNo });
+    this.extraParams = extraParams;
+  }
+
+  toFields() {
+    return toFieldsOf(this);
+  }
+}

package/src/requests.js

@@ -0,0 +1,269 @@
+import {
+  JsapiUnifiedOrderParams,
+  AggregateCodeUnifiedOrderParams,
+  MiniProgramUnifiedOrderParams,
+  H5UnifiedOrderParams,
+  AppUnifiedOrderParams,
+  OrderQueryParams,
+  RefundParams,
+  RefundQueryParams,
+  ReverseParams,
+  ReverseQueryParams,
+} from "./params.js";
+import {
+  JsapiUnifiedOrderResponse,
+  AggregateCodeUnifiedOrderResponse,
+  MiniProgramUnifiedOrderResponse,
+  H5UnifiedOrderResponse,
+  AppUnifiedOrderResponse,
+  OrderQueryResponse,
+  RefundResponse,
+  RefundQueryResponse,
+  ReverseResponse,
+  ReverseQueryResponse,
+} from "./responses.js";
+
+/**
+ * 每操作一个 Request 类，携带 funcode/version/path/签名字段名/excludeSignType 元数据。
+ * 不使用集中式 Requests 工厂（已在设计评审中否决）。
+ */
+export class IpaynowRequest {
+  /**
+   * @param {{funcode: string, version: string, path?: string, signTypeField: string,
+   *   excludeSignType?: boolean, responseClass: Function, params: {toFields: () => Record<string, string>}}} options
+   */
+  constructor({ funcode, version, path = "/", signTypeField, excludeSignType = false, responseClass, params }) {
+    this.funcode = funcode;
+    this.version = version;
+    this.path = path;
+    this.signTypeField = signTypeField;
+    this.excludeSignType = excludeSignType;
+    this.responseClass = responseClass;
+    this.params = params;
+  }
+
+  get mhtCharset() {
+    return "UTF-8";
+  }
+
+  get signatureField() {
+    return "mhtSignature";
+  }
+
+  get responseSignatureField() {
+    return "signature";
+  }
+
+  /** @returns {Record<string, string>} */
+  toFields() {
+    return this.params.toFields();
+  }
+}
+
+/** @param {string|{version?: string}} [override] */
+function resolveVersion(defaultVersion, override) {
+  if (typeof override === "string") return override;
+  if (override && typeof override === "object" && override.version) return override.version;
+  return defaultVersion;
+}
+
+/** JSAPI 统一下单请求（funcode=WP001, version=1.0.0, path=/） */
+export class JsapiUnifiedOrderRequest extends IpaynowRequest {
+  /**
+   * @param {JsapiUnifiedOrderParams|object} params
+   * @param {string|{version?: string}} [versionOrOptions]
+   */
+  constructor(params, versionOrOptions) {
+    const p = params instanceof JsapiUnifiedOrderParams ? params : new JsapiUnifiedOrderParams(params);
+    super({
+      funcode: "WP001",
+      version: resolveVersion("1.0.0", versionOrOptions),
+      path: "/",
+      signTypeField: "mhtSignType",
+      excludeSignType: false,
+      responseClass: JsapiUnifiedOrderResponse,
+      params: p,
+    });
+  }
+}
+
+/** 聚合码统一下单请求（funcode=WP001, version=1.0.3, path=/） */
+export class AggregateCodeUnifiedOrderRequest extends IpaynowRequest {
+  /**
+   * @param {AggregateCodeUnifiedOrderParams|object} params
+   * @param {string|{version?: string}} [versionOrOptions]
+   */
+  constructor(params, versionOrOptions) {
+    const p = params instanceof AggregateCodeUnifiedOrderParams ? params : new AggregateCodeUnifiedOrderParams(params);
+    super({
+      funcode: "WP001",
+      version: resolveVersion("1.0.3", versionOrOptions),
+      path: "/",
+      signTypeField: "mhtSignType",
+      excludeSignType: false,
+      responseClass: AggregateCodeUnifiedOrderResponse,
+      params: p,
+    });
+  }
+}
+
+/** 小程序统一下单请求（funcode=WP001, version=1.0.0, path=/） */
+export class MiniProgramUnifiedOrderRequest extends IpaynowRequest {
+  /**
+   * @param {MiniProgramUnifiedOrderParams|object} params
+   * @param {string|{version?: string}} [versionOrOptions]
+   */
+  constructor(params, versionOrOptions) {
+    const p = params instanceof MiniProgramUnifiedOrderParams ? params : new MiniProgramUnifiedOrderParams(params);
+    super({
+      funcode: "WP001",
+      version: resolveVersion("1.0.0", versionOrOptions),
+      path: "/",
+      signTypeField: "mhtSignType",
+      excludeSignType: false,
+      responseClass: MiniProgramUnifiedOrderResponse,
+      params: p,
+    });
+  }
+}
+
+/** H5 统一下单请求（funcode=WP001, version=1.0.0, path=/） */
+export class H5UnifiedOrderRequest extends IpaynowRequest {
+  /**
+   * @param {H5UnifiedOrderParams|object} params
+   * @param {string|{version?: string}} [versionOrOptions]
+   */
+  constructor(params, versionOrOptions) {
+    const p = params instanceof H5UnifiedOrderParams ? params : new H5UnifiedOrderParams(params);
+    super({
+      funcode: "WP001",
+      version: resolveVersion("1.0.0", versionOrOptions),
+      path: "/",
+      signTypeField: "mhtSignType",
+      excludeSignType: false,
+      responseClass: H5UnifiedOrderResponse,
+      params: p,
+    });
+  }
+}
+
+/** APP 统一下单请求（funcode=WP001, version=1.0.3, path=/） */
+export class AppUnifiedOrderRequest extends IpaynowRequest {
+  /**
+   * @param {AppUnifiedOrderParams|object} params
+   * @param {string|{version?: string}} [versionOrOptions]
+   */
+  constructor(params, versionOrOptions) {
+    const p = params instanceof AppUnifiedOrderParams ? params : new AppUnifiedOrderParams(params);
+    super({
+      funcode: "WP001",
+      version: resolveVersion("1.0.3", versionOrOptions),
+      path: "/",
+      signTypeField: "mhtSignType",
+      excludeSignType: false,
+      responseClass: AppUnifiedOrderResponse,
+      params: p,
+    });
+  }
+}
+
+/** 订单查询请求（funcode=MQ002, version=1.0.0，可被 params.version 或构造覆盖，path=/） */
+export class OrderQueryRequest extends IpaynowRequest {
+  /**
+   * @param {OrderQueryParams|object} params
+   * @param {string|{version?: string}} [versionOrOptions]
+   */
+  constructor(params, versionOrOptions) {
+    const p = params instanceof OrderQueryParams ? params : new OrderQueryParams(params);
+    const version = resolveVersion(p.version || "1.0.0", versionOrOptions);
+    super({
+      funcode: "MQ002",
+      version,
+      path: "/",
+      signTypeField: "mhtSignType",
+      excludeSignType: false,
+      responseClass: OrderQueryResponse,
+      params: p,
+    });
+  }
+}
+
+/** 退款请求（funcode=R001, version=1.0.0, path=/refund/refundOrder, signType 不参与签名） */
+export class RefundRequest extends IpaynowRequest {
+  /**
+   * @param {RefundParams|object} params
+   * @param {string|{version?: string}} [versionOrOptions]
+   */
+  constructor(params, versionOrOptions) {
+    const p = params instanceof RefundParams ? params : new RefundParams(params);
+    super({
+      funcode: "R001",
+      version: resolveVersion("1.0.0", versionOrOptions),
+      path: "/refund/refundOrder",
+      signTypeField: "signType",
+      excludeSignType: true,
+      responseClass: RefundResponse,
+      params: p,
+    });
+  }
+}
+
+/** 退款查询请求（funcode=Q001, version=1.0.0, path=/refund/refundQuery, signType 不参与签名） */
+export class RefundQueryRequest extends IpaynowRequest {
+  /**
+   * @param {RefundQueryParams|object} params
+   * @param {string|{version?: string}} [versionOrOptions]
+   */
+  constructor(params, versionOrOptions) {
+    const p = params instanceof RefundQueryParams ? params : new RefundQueryParams(params);
+    super({
+      funcode: "Q001",
+      version: resolveVersion("1.0.0", versionOrOptions),
+      path: "/refund/refundQuery",
+      signTypeField: "signType",
+      excludeSignType: true,
+      responseClass: RefundQueryResponse,
+      params: p,
+    });
+  }
+}
+
+/** 撤销请求（funcode=R002, version=1.0.0, path=/refund/cancelOrder, signType 不参与签名） */
+export class ReverseRequest extends IpaynowRequest {
+  /**
+   * @param {ReverseParams|object} params
+   * @param {string|{version?: string}} [versionOrOptions]
+   */
+  constructor(params, versionOrOptions) {
+    const p = params instanceof ReverseParams ? params : new ReverseParams(params);
+    super({
+      funcode: "R002",
+      version: resolveVersion("1.0.0", versionOrOptions),
+      path: "/refund/cancelOrder",
+      signTypeField: "signType",
+      excludeSignType: true,
+      responseClass: ReverseResponse,
+      params: p,
+    });
+  }
+}
+
+/** 撤销查询请求（funcode=Q002, version=1.0.0, path=/refund/refundQuery, signType 不参与签名） */
+export class ReverseQueryRequest extends IpaynowRequest {
+  /**
+   * @param {ReverseQueryParams|object} params
+   * @param {string|{version?: string}} [versionOrOptions]
+   */
+  constructor(params, versionOrOptions) {
+    const p = params instanceof ReverseQueryParams ? params : new ReverseQueryParams(params);
+    super({
+      funcode: "Q002",
+      version: resolveVersion("1.0.0", versionOrOptions),
+      path: "/refund/refundQuery",
+      signTypeField: "signType",
+      excludeSignType: true,
+      responseClass: ReverseQueryResponse,
+      params: p,
+    });
+  }
+}