@laranex/myanmar-payments 4.0.0-dev.1 → 4.0.0-dev.11

package/dist/cjs/kbz-pay/kbz-pay.js

@@ -12,44 +12,65 @@ const status_js_1 = require("../core/status.js");
 const validate_js_1 = require("../core/validate.js");
 const values_js_1 = require("../core/values.js");
 const signer_js_1 = require("./signer.js");
+/** What a valid KBZ Pay `time_to_live_in_minutes` is: KBZ counts whole minutes, up to 120. */
+const TIME_TO_LIVE_REQUIREMENT = 'a whole number from 1 to 120';
+function resolveTimeToLive(value) {
+    if (value === undefined || value === null || (typeof value === 'string' && value.trim() === '')) {
+        return undefined;
+    }
+    let minutes;
+    if (typeof value === 'number' && Number.isSafeInteger(value)) {
+        minutes = value;
+    }
+    else if (typeof value === 'string' && /^[+-]?\d+$/.test(value.trim())) {
+        minutes = Number.parseInt(value.trim(), 10);
+    }
+    if (minutes === undefined || minutes < 1 || minutes > 120) {
+        throw new errors_js_1.ConfigurationError('kbz_pay', 'time_to_live_in_minutes', true, TIME_TO_LIVE_REQUIREMENT);
+    }
+    return minutes;
+}
 /**
- * KBZ Pay credentials and endpoints. A missing credential throws a `ConfigurationError`.
+ * KBZ Pay credentials and endpoints. A missing setting throws a `ConfigurationError`. The URLs
+ * default to production; UAT and production issue separate credentials.
  */
 class KbzPayConfig {
-    static SANDBOX_API_URL = 'http://api-uat.kbzpay.com/payment/gateway/uat';
     static PRODUCTION_API_URL = 'https://api.kbzpay.com/payment/gateway';
-    static SANDBOX_PWA_URL = 'https://static.kbzpay.com/pgw/uat/pwa/#/';
     static PRODUCTION_PWA_URL = 'https://wap.kbzpay.com/pgw/pwa/#/';
     appId;
     appKey;
     merchantCode;
-    sandbox;
+    /** Seconds before the default HTTP client gives up on a request. */
+    timeoutSeconds;
     /** The API base URL in use. */
     apiUrl;
     /** The PWA checkout URL in use, always ending in `/`. */
     pwaUrl;
+    /** Minutes the customer has to pay each order unless the payment sets its own; `undefined` when unset. */
+    timeToLiveMinutes;
     constructor(options) {
         this.appId = (0, env_js_1.requireSetting)('kbz_pay', 'app_id', options.appId);
         this.appKey = (0, env_js_1.requireSetting)('kbz_pay', 'app_key', options.appKey);
         this.merchantCode = (0, env_js_1.requireSetting)('kbz_pay', 'merchant_code', options.merchantCode);
-        this.sandbox = options.sandbox ?? true;
-        this.apiUrl = (0, env_js_1.trimUrl)((0, env_js_1.optionalSetting)(options.apiUrl) ??
-            (this.sandbox ? KbzPayConfig.SANDBOX_API_URL : KbzPayConfig.PRODUCTION_API_URL));
-        this.pwaUrl = `${(0, env_js_1.trimUrl)((0, env_js_1.optionalSetting)(options.pwaUrl) ??
-            (this.sandbox ? KbzPayConfig.SANDBOX_PWA_URL : KbzPayConfig.PRODUCTION_PWA_URL))}/`;
+        this.timeoutSeconds = (0, env_js_1.resolveTimeout)('kbz_pay', options.timeoutSeconds);
+        this.apiUrl = (0, env_js_1.trimUrl)((0, env_js_1.optionalSetting)(options.apiUrl) ?? KbzPayConfig.PRODUCTION_API_URL);
+        this.pwaUrl = `${(0, env_js_1.trimUrl)((0, env_js_1.optionalSetting)(options.pwaUrl) ?? KbzPayConfig.PRODUCTION_PWA_URL)}/`;
+        this.timeToLiveMinutes = resolveTimeToLive(options.timeToLiveMinutes);
     }
     /**
-     * Reads `KBZ_PAY_APP_ID`, `KBZ_PAY_APP_KEY`, `KBZ_PAY_MERCHANT_CODE`, `KBZ_PAY_SANDBOX`,
-     * `KBZ_PAY_BASE_URL` and `KBZ_PAY_PWA_BASE_REDIRECT_URL`.
+     * Reads `KBZ_PAY_APP_ID`, `KBZ_PAY_APP_KEY`, `KBZ_PAY_MERCHANT_CODE`,
+     * `MYANMAR_PAYMENTS_HTTP_TIMEOUT`, `KBZ_PAY_BASE_URL`, `KBZ_PAY_PWA_BASE_REDIRECT_URL` and
+     * `KBZ_PAY_TIME_TO_LIVE_IN_MINUTES`.
      */
     static fromEnv(env = (0, env_js_1.defaultEnv)()) {
         return new KbzPayConfig({
             appId: (0, env_js_1.envFirst)(env, 'KBZ_PAY_APP_ID'),
             appKey: (0, env_js_1.envFirst)(env, 'KBZ_PAY_APP_KEY'),
             merchantCode: (0, env_js_1.envFirst)(env, 'KBZ_PAY_MERCHANT_CODE'),
-            sandbox: (0, env_js_1.envSandbox)(env, 'KBZ_PAY_SANDBOX'),
+            timeoutSeconds: (0, env_js_1.envFirst)(env, env_js_1.HTTP_TIMEOUT_VARIABLE),
             apiUrl: (0, env_js_1.envFirst)(env, 'KBZ_PAY_BASE_URL'),
             pwaUrl: (0, env_js_1.envFirst)(env, 'KBZ_PAY_PWA_BASE_REDIRECT_URL'),
+            timeToLiveMinutes: (0, env_js_1.envFirst)(env, 'KBZ_PAY_TIME_TO_LIVE_IN_MINUTES'),
         });
     }
 }
@@ -60,7 +81,7 @@ const STATUSES = {
     WAIT_PAY: 'pending',
     PAYING: 'pending',
     PAY_FAILED: 'failed',
-    ORDER_CLOSED: 'cancelled',
+    ORDER_CLOSED: 'canceled',
     ORDER_EXPIRED: 'expired',
 };
 /**
@@ -76,7 +97,7 @@ class KbzPay {
     constructor(config, options = {}) {
         this.config = config instanceof KbzPayConfig ? config : new KbzPayConfig(config);
         this.signer = new signer_js_1.KbzPaySigner(this.config.appKey);
-        this.transport = new http_js_1.Transport((0, http_js_1.httpClientFrom)(options));
+        this.transport = new http_js_1.Transport((0, http_js_1.httpClientFrom)(options, this.config.timeoutSeconds));
     }
     /** A gateway configured from the `KBZ_PAY_*` environment variables. */
     static fromEnv(env = (0, env_js_1.defaultEnv)(), options = {}) {
@@ -95,7 +116,7 @@ class KbzPay {
             .max('callbackUrl', callbackUrl, 512)
             .when(callbackUrl.includes('?'), 'callbackUrl', 'The callbackUrl field must not contain a query string.')
             .string('title', data.title)
-            .between('timeoutMinutes', data.timeoutMinutes, 1, 120)
+            .between('timeToLiveMinutes', data.timeToLiveMinutes, 1, 120)
             .string('callbackInfo', data.callbackInfo)
             .max('callbackInfo', typeof data.callbackInfo === 'string' ? (0, crypto_js_1.queryEscape)(data.callbackInfo) : undefined, 512)
             .validate();
@@ -105,6 +126,8 @@ class KbzPay {
      *
      * The redirect only works on a phone with the KBZ Pay app installed, and its Referer must match
      * the URL registered with KBZ.
+     * Throws `InvalidPaymentDataError` before any request when neither the payment nor the config sets
+     * a time to live.
      */
     async pwa(data, options = {}) {
         const order = await this.precreate(data, 'PWAAPP', options);
@@ -116,7 +139,11 @@ class KbzPay {
             raw: (0, json_js_1.toPlainObject)(order.response),
         });
     }
-    /** Creates an order and returns a QR payload for the customer to scan with the KBZ Pay app. */
+    /**
+     * Creates an order and returns a QR payload for the customer to scan with the KBZ Pay app.
+     * Throws `InvalidPaymentDataError` before any request when neither the payment nor the config sets
+     * a time to live.
+     */
     async qr(data, options = {}) {
         const order = await this.precreate(data, 'PAY_BY_QRCODE', options);
         const qrCode = (0, values_js_1.get)(order.response, 'qrCode');
@@ -128,9 +155,7 @@ class KbzPay {
         return new results_js_1.QrPayment({
             orderId: data.orderId,
             qrString: qrCode,
-            expiresAt: data.timeoutMinutes === undefined
-                ? undefined
-                : new Date(Date.now() + data.timeoutMinutes * 60_000),
+            expiresAt: new Date(Date.now() + order.timeToLiveMinutes * 60_000),
             reference: order.prepayId,
             raw: (0, json_js_1.toPlainObject)(order.response),
         });
@@ -138,6 +163,8 @@ class KbzPay {
     /**
      * Creates an order and returns the signed values your mobile app passes to `KBZPay.startPay()`.
      * The SDK's own result only means the payment screen closed; rely on the callback or `status()`.
+     * Throws `InvalidPaymentDataError` before any request when neither the payment nor the config sets
+     * a time to live.
      */
     async app(data, options = {}) {
         const order = await this.precreate(data, 'APP', options);
@@ -190,6 +217,12 @@ class KbzPay {
     }
     async precreate(data, tradeType, options) {
         KbzPay.validate(data);
+        const timeToLiveMinutes = data.timeToLiveMinutes ?? this.config.timeToLiveMinutes;
+        if (timeToLiveMinutes === undefined) {
+            throw new errors_js_1.InvalidPaymentDataError({
+                timeToLiveMinutes: 'The timeToLiveMinutes field is required when the kbz_pay configuration has no [time_to_live_in_minutes].',
+            });
+        }
         const biz = {
             appid: this.config.appId,
             merch_code: this.config.merchantCode,
@@ -201,9 +234,7 @@ class KbzPay {
         if (data.title) {
             biz.title = data.title;
         }
-        if (data.timeoutMinutes !== undefined) {
-            biz.timeout_express = `${data.timeoutMinutes}m`;
-        }
+        biz.timeout_express = `${timeToLiveMinutes}m`;
         if (data.callbackInfo) {
             biz.callback_info = (0, crypto_js_1.queryEscape)(data.callbackInfo);
         }
@@ -214,7 +245,7 @@ class KbzPay {
         if (prepayId === '') {
             throw new errors_js_1.ApiError('KBZ Pay did not return a prepay_id.', { raw: (0, json_js_1.toPlainObject)(response) });
         }
-        return { prepayId, nonce, timestamp: time, response };
+        return { prepayId, nonce, timestamp: time, timeToLiveMinutes, response };
     }
     /** Sends a signed request and returns the `Response` object, throwing when KBZ reports an error. */
     async call(endpoint, method, version, biz, extra, nonce, time, signal) {

package/dist/cjs/kbz-pay/signer.d.ts

@@ -10,6 +10,9 @@ export declare class KbzPaySigner {
     signString(fields: Readonly<Record<string, unknown>>): string;
     /** The uppercase SHA-256 signature of `fields`. */
     sign(fields: Readonly<Record<string, unknown>>): string;
-    /** Whether `fields.sign` matches, compared in constant time. */
+    /**
+     * Whether `fields.sign` matches, compared in constant time. Nested values are never signed, so
+     * fields holding an object or array fail rather than being partly trusted.
+     */
     verify(fields: Readonly<Record<string, unknown>>): boolean;
 }

package/dist/cjs/kbz-pay/signer.js

@@ -27,10 +27,15 @@ class KbzPaySigner {
     sign(fields) {
         return (0, crypto_js_1.sha256Hex)(`${this.signString(fields)}&key=${this.appKey}`).toUpperCase();
     }
-    /** Whether `fields.sign` matches, compared in constant time. */
+    /**
+     * Whether `fields.sign` matches, compared in constant time. Nested values are never signed, so
+     * fields holding an object or array fail rather than being partly trusted.
+     */
     verify(fields) {
         const sign = fields.sign;
-        return typeof sign === 'string' && (0, crypto_js_1.safeEqual)(this.sign(fields), sign.toUpperCase());
+        return (typeof sign === 'string' &&
+            !Object.values(fields).some(values_js_1.isNested) &&
+            (0, crypto_js_1.safeEqual)(this.sign(fields), sign.toUpperCase()));
     }
 }
 exports.KbzPaySigner = KbzPaySigner;

package/dist/cjs/wave-money/wave-money.d.ts

@@ -11,38 +11,45 @@ export interface WaveMoneyConfigOptions {
     secretKey: string;
     /** Your business name, shown on Wave's payment page. */
     merchantName: string;
-    /** How long the customer has to pay, in seconds (default 300). */
-    timeToLiveSeconds?: number | undefined;
-    /** Use the test environment (default `true`). */
-    sandbox?: boolean | undefined;
-    /** Overrides the API base URL. */
+    /**
+     * How long the customer has to pay, in seconds: a whole number greater than 0 (or its text). A
+     * payment's own `timeToLiveSeconds` overrides it. Unset or blank is allowed, but then every
+     * payment must set its own.
+     */
+    timeToLiveSeconds?: number | string | null | undefined;
+    /**
+     * Seconds before the default HTTP client gives up on a request, a whole number greater than 0
+     * (or its text). Defaults to 30 (`DEFAULT_TIMEOUT_SECONDS`) when unset or blank. A
+     * client you pass keeps its own timeout.
+     */
+    timeoutSeconds?: number | string | null | undefined;
+    /** Overrides the API base URL, e.g. to point at UAT. */
     baseUrl?: string | undefined;
     /** Overrides the host the customer is redirected to. Wave serves it without the API port. */
     authenticateUrl?: string | undefined;
 }
 /**
- * Wave Money credentials and endpoints. A missing credential throws a `ConfigurationError`.
+ * Wave Money credentials and endpoints. A missing setting throws a `ConfigurationError`. The URLs
+ * default to production.
  */
 export declare class WaveMoneyConfig {
-    static readonly SANDBOX_URL = "https://preprodpayments.wavemoney.io:8107";
     static readonly PRODUCTION_URL = "https://payments.wavemoney.io";
-    static readonly SANDBOX_AUTHENTICATE_URL = "https://preprodpayments.wavemoney.io";
     static readonly PRODUCTION_AUTHENTICATE_URL = "https://payments.wavemoney.io";
-    static readonly DEFAULT_TIME_TO_LIVE_SECONDS = 300;
     readonly merchantId: string;
     readonly secretKey: string;
     readonly merchantName: string;
-    /** Seconds the customer has to pay. */
-    readonly timeToLiveSeconds: number;
-    readonly sandbox: boolean;
+    /** Seconds the customer has to pay unless the payment sets its own; `undefined` when unset. */
+    readonly timeToLiveSeconds: number | undefined;
+    /** Seconds before the default HTTP client gives up on a request. */
+    readonly timeoutSeconds: number;
     /** The API base URL in use. */
     readonly baseUrl: string;
     /** The host the customer is redirected to. */
     readonly authenticateUrl: string;
     constructor(options: WaveMoneyConfigOptions);
     /**
-     * Reads `WAVE_MONEY_MERCHANT_ID`, `WAVE_MONEY_SECRET_KEY`, `WAVE_MONEY_MERCHANT_NAME` (falling back
-     * to `APP_NAME`), `WAVE_MONEY_TIME_TO_LIVE_IN_SECONDS`, `WAVE_MONEY_SANDBOX`, `WAVE_MONEY_BASE_URL`
+     * Reads `WAVE_MONEY_MERCHANT_ID`, `WAVE_MONEY_SECRET_KEY`, `WAVE_MONEY_MERCHANT_NAME`,
+     * `WAVE_MONEY_TIME_TO_LIVE_IN_SECONDS`, `MYANMAR_PAYMENTS_HTTP_TIMEOUT`, `WAVE_MONEY_BASE_URL`
      * and `WAVE_MONEY_AUTHENTICATE_URL`.
      */
     static fromEnv(env?: EnvSource): WaveMoneyConfig;
@@ -76,6 +83,16 @@ export interface WaveMoneyPaymentData {
      * this.
      */
     merchantReferenceId?: string | undefined;
+    /**
+     * The business name shown on Wave's page for this payment. Defaults to the configured
+     * `merchantName` when unset.
+     */
+    merchantName?: string | null | undefined;
+    /**
+     * How long the customer has to pay this payment, in seconds: a whole number greater than 0.
+     * Defaults to the configured `timeToLiveSeconds` when unset; one of the two is required.
+     */
+    timeToLiveSeconds?: number | null | undefined;
 }
 /**
  * Wave Money (WavePay payment gateway): redirect payments and callbacks. Wave has no status API,
@@ -98,13 +115,14 @@ export declare class WaveMoney {
     /**
      * Creates a payment request and returns Wave's page to redirect the customer to. Once `data`
      * passes validation it fills `data.merchantReferenceId` with a random id when empty, so store it
-     * afterwards. Invalid data is left untouched.
+     * afterwards. Invalid data is left untouched. Throws `InvalidPaymentDataError` before any request
+     * when neither the payment nor the config sets a time to live.
      */
     initiate(data: WaveMoneyPaymentData, options?: RequestOptions): Promise<RedirectPayment>;
     /**
      * Verifies Wave's callback. Only `PAYMENT_CONFIRMED` means the customer paid. `orderId` falls
      * back to `merchantReferenceId` when it is missing, null or empty, because Wave marks `orderId` as
-     * optional.
+     * optional. A hashed field holding an object or array fails verification.
      */
     handleCallback(request: CallbackRequest): PaymentCallback;
     private hash;

package/dist/cjs/wave-money/wave-money.js

@@ -13,20 +13,19 @@ const status_js_1 = require("../core/status.js");
 const validate_js_1 = require("../core/validate.js");
 const values_js_1 = require("../core/values.js");
 /**
- * Wave Money credentials and endpoints. A missing credential throws a `ConfigurationError`.
+ * Wave Money credentials and endpoints. A missing setting throws a `ConfigurationError`. The URLs
+ * default to production.
  */
 class WaveMoneyConfig {
-    static SANDBOX_URL = 'https://preprodpayments.wavemoney.io:8107';
     static PRODUCTION_URL = 'https://payments.wavemoney.io';
-    static SANDBOX_AUTHENTICATE_URL = 'https://preprodpayments.wavemoney.io';
     static PRODUCTION_AUTHENTICATE_URL = 'https://payments.wavemoney.io';
-    static DEFAULT_TIME_TO_LIVE_SECONDS = 300;
     merchantId;
     secretKey;
     merchantName;
-    /** Seconds the customer has to pay. */
+    /** Seconds the customer has to pay unless the payment sets its own; `undefined` when unset. */
     timeToLiveSeconds;
-    sandbox;
+    /** Seconds before the default HTTP client gives up on a request. */
+    timeoutSeconds;
     /** The API base URL in use. */
     baseUrl;
     /** The host the customer is redirected to. */
@@ -35,31 +34,23 @@ class WaveMoneyConfig {
         this.merchantId = (0, env_js_1.requireSetting)('wave_money', 'merchant_id', options.merchantId);
         this.secretKey = (0, env_js_1.requireSetting)('wave_money', 'secret_key', options.secretKey);
         this.merchantName = (0, env_js_1.requireSetting)('wave_money', 'merchant_name', options.merchantName);
-        const ttl = options.timeToLiveSeconds;
-        this.timeToLiveSeconds =
-            ttl !== undefined && Number.isInteger(ttl) && ttl > 0
-                ? ttl
-                : WaveMoneyConfig.DEFAULT_TIME_TO_LIVE_SECONDS;
-        this.sandbox = options.sandbox ?? true;
-        this.baseUrl = (0, env_js_1.trimUrl)((0, env_js_1.optionalSetting)(options.baseUrl) ??
-            (this.sandbox ? WaveMoneyConfig.SANDBOX_URL : WaveMoneyConfig.PRODUCTION_URL));
-        this.authenticateUrl = (0, env_js_1.trimUrl)((0, env_js_1.optionalSetting)(options.authenticateUrl) ??
-            (this.sandbox
-                ? WaveMoneyConfig.SANDBOX_AUTHENTICATE_URL
-                : WaveMoneyConfig.PRODUCTION_AUTHENTICATE_URL));
+        this.timeToLiveSeconds = (0, env_js_1.optionalSeconds)('wave_money', 'time_to_live_in_seconds', options.timeToLiveSeconds);
+        this.timeoutSeconds = (0, env_js_1.resolveTimeout)('wave_money', options.timeoutSeconds);
+        this.baseUrl = (0, env_js_1.trimUrl)((0, env_js_1.optionalSetting)(options.baseUrl) ?? WaveMoneyConfig.PRODUCTION_URL);
+        this.authenticateUrl = (0, env_js_1.trimUrl)((0, env_js_1.optionalSetting)(options.authenticateUrl) ?? WaveMoneyConfig.PRODUCTION_AUTHENTICATE_URL);
     }
     /**
-     * Reads `WAVE_MONEY_MERCHANT_ID`, `WAVE_MONEY_SECRET_KEY`, `WAVE_MONEY_MERCHANT_NAME` (falling back
-     * to `APP_NAME`), `WAVE_MONEY_TIME_TO_LIVE_IN_SECONDS`, `WAVE_MONEY_SANDBOX`, `WAVE_MONEY_BASE_URL`
+     * Reads `WAVE_MONEY_MERCHANT_ID`, `WAVE_MONEY_SECRET_KEY`, `WAVE_MONEY_MERCHANT_NAME`,
+     * `WAVE_MONEY_TIME_TO_LIVE_IN_SECONDS`, `MYANMAR_PAYMENTS_HTTP_TIMEOUT`, `WAVE_MONEY_BASE_URL`
      * and `WAVE_MONEY_AUTHENTICATE_URL`.
      */
     static fromEnv(env = (0, env_js_1.defaultEnv)()) {
         return new WaveMoneyConfig({
             merchantId: (0, env_js_1.envFirst)(env, 'WAVE_MONEY_MERCHANT_ID'),
             secretKey: (0, env_js_1.envFirst)(env, 'WAVE_MONEY_SECRET_KEY'),
-            merchantName: (0, env_js_1.envFirst)(env, 'WAVE_MONEY_MERCHANT_NAME', 'APP_NAME'),
-            timeToLiveSeconds: (0, env_js_1.envInt)(env, 'WAVE_MONEY_TIME_TO_LIVE_IN_SECONDS'),
-            sandbox: (0, env_js_1.envSandbox)(env, 'WAVE_MONEY_SANDBOX'),
+            merchantName: (0, env_js_1.envFirst)(env, 'WAVE_MONEY_MERCHANT_NAME'),
+            timeToLiveSeconds: (0, env_js_1.envFirst)(env, 'WAVE_MONEY_TIME_TO_LIVE_IN_SECONDS'),
+            timeoutSeconds: (0, env_js_1.envFirst)(env, env_js_1.HTTP_TIMEOUT_VARIABLE),
             baseUrl: (0, env_js_1.envFirst)(env, 'WAVE_MONEY_BASE_URL'),
             authenticateUrl: (0, env_js_1.envFirst)(env, 'WAVE_MONEY_AUTHENTICATE_URL'),
         });
@@ -71,7 +62,7 @@ const STATUSES = {
     INSUFFICIENT_BALANCE: 'pending',
     ACCOUNT_LOCKED: 'failed',
     BILL_COLLECTION_FAILED: 'failed',
-    PAYMENT_REQUEST_CANCELLED: 'cancelled',
+    PAYMENT_REQUEST_CANCELLED: 'canceled',
     TRANSACTION_TIMED_OUT: 'expired',
     SCHEDULER_TRANSACTION_TIMED_OUT: 'expired',
 };
@@ -98,7 +89,7 @@ class WaveMoney {
     transport;
     constructor(config, options = {}) {
         this.config = config instanceof WaveMoneyConfig ? config : new WaveMoneyConfig(config);
-        this.transport = new http_js_1.Transport((0, http_js_1.httpClientFrom)(options));
+        this.transport = new http_js_1.Transport((0, http_js_1.httpClientFrom)(options, this.config.timeoutSeconds));
     }
     /** A gateway configured from the `WAVE_MONEY_*` environment variables. */
     static fromEnv(env = (0, env_js_1.defaultEnv)(), options = {}) {
@@ -136,7 +127,11 @@ class WaveMoney {
             .url('returnUrl', data.returnUrl)
             .required('description', data.description)
             .when(items.length === 0, 'items', 'The items field must have at least one item.')
-            .string('merchantReferenceId', data.merchantReferenceId);
+            .string('merchantReferenceId', data.merchantReferenceId)
+            .string('merchantName', data.merchantName)
+            .when(typeof data.merchantName === 'string' && data.merchantName.trim() === '', 'merchantName', 'The merchantName field is required.')
+            .when(isSet(data.timeToLiveSeconds) && !Number.isInteger(data.timeToLiveSeconds), 'timeToLiveSeconds', 'The timeToLiveSeconds field must be an integer.')
+            .when(isSet(data.timeToLiveSeconds) && data.timeToLiveSeconds < 1, 'timeToLiveSeconds', 'The timeToLiveSeconds field must be greater than 0.');
         items.forEach((item, index) => {
             validator
                 .required(`items.${index}.name`, item?.name)
@@ -154,15 +149,22 @@ class WaveMoney {
     /**
      * Creates a payment request and returns Wave's page to redirect the customer to. Once `data`
      * passes validation it fills `data.merchantReferenceId` with a random id when empty, so store it
-     * afterwards. Invalid data is left untouched.
+     * afterwards. Invalid data is left untouched. Throws `InvalidPaymentDataError` before any request
+     * when neither the payment nor the config sets a time to live.
      */
     async initiate(data, options = {}) {
         WaveMoney.validate(data);
+        const timeToLiveSeconds = data.timeToLiveSeconds ?? this.config.timeToLiveSeconds;
+        if (timeToLiveSeconds === undefined) {
+            throw new errors_js_1.InvalidPaymentDataError({
+                timeToLiveSeconds: 'The timeToLiveSeconds field is required when the wave_money configuration has no [time_to_live_in_seconds].',
+            });
+        }
         if (!data.merchantReferenceId) {
             data.merchantReferenceId = (0, crypto_js_1.randomHex)();
         }
         const amount = WaveMoney.resolvedAmount(data).toString();
-        const ttl = String(this.config.timeToLiveSeconds);
+        const ttl = String(timeToLiveSeconds);
         // Wave documents items as [{"name": "...", "amount": 1000}] with a numeric amount; the amount
         // text is written as a JSON number without passing through a float.
         const items = `[${data.items
@@ -177,7 +179,7 @@ class WaveMoney {
             backend_result_url: data.callbackUrl,
             amount,
             payment_description: data.description,
-            merchant_name: this.config.merchantName,
+            merchant_name: data.merchantName ?? this.config.merchantName,
             items,
             hash: this.hash([
                 ttl,
@@ -209,13 +211,15 @@ class WaveMoney {
     /**
      * Verifies Wave's callback. Only `PAYMENT_CONFIRMED` means the customer paid. `orderId` falls
      * back to `merchantReferenceId` when it is missing, null or empty, because Wave marks `orderId` as
-     * optional.
+     * optional. A hashed field holding an object or array fails verification.
      */
     handleCallback(request) {
         const payload = (0, callback_js_1.losslessBody)(request);
         const expected = this.hash(CALLBACK_FIELDS.map((field) => (0, values_js_1.scalarString)(payload[field]) ?? 'null'));
         const hashValue = payload.hashValue;
-        if (typeof hashValue !== 'string' || !(0, crypto_js_1.safeEqual)(expected, hashValue.toLowerCase())) {
+        if (typeof hashValue !== 'string' ||
+            CALLBACK_FIELDS.some((field) => (0, values_js_1.isNested)(payload[field])) ||
+            !(0, crypto_js_1.safeEqual)(expected, hashValue.toLowerCase())) {
             throw new errors_js_1.SignatureVerificationError('Wave Money callback hash verification failed.', (0, json_js_1.toPlainObject)(payload));
         }
         const gatewayStatus = (0, values_js_1.trimmed)(payload, 'status');
@@ -233,6 +237,9 @@ class WaveMoney {
     }
 }
 exports.WaveMoney = WaveMoney;
+function isSet(value) {
+    return value !== undefined && value !== null;
+}
 function errorMessage(body) {
     const errors = body.errors;
     if ((0, json_js_1.isLosslessObject)(errors)) {

package/dist/cjs/yoma-mmqr/yoma-mmqr.d.ts

@@ -16,35 +16,39 @@ export interface YomaMmqrConfigOptions {
     webhookHashKey: string;
     /** The secret you shared with Yoma; when set, callbacks must carry it in `X-Webhook-Secret`. */
     webhookSecret?: string | undefined;
-    /** Use the UAT payment hub (default `true`). */
-    sandbox?: boolean | undefined;
-    /** Overrides the API base URL. */
+    /** The `{version}` segment of the API paths, e.g. `v1rc`. */
+    apiVersion: string;
+    /**
+     * Seconds before the default HTTP client gives up on a request, a whole number greater than 0
+     * (or its text). Defaults to 30 (`DEFAULT_TIMEOUT_SECONDS`) when unset or blank. A
+     * client you pass keeps its own timeout.
+     */
+    timeoutSeconds?: number | string | null | undefined;
+    /** Overrides the API base URL, e.g. to point at UAT. */
     baseUrl?: string | undefined;
-    /** The `{version}` segment of the API paths (default `v1rc`). */
-    apiVersion?: string | undefined;
 }
 /**
- * Yoma MMQR credentials and endpoints. A missing credential throws a `ConfigurationError`.
+ * Yoma MMQR credentials and endpoints. A missing setting throws a `ConfigurationError`. The URL
+ * defaults to production.
  */
 export declare class YomaMmqrConfig {
-    static readonly SANDBOX_URL = "https://devapi.yomabank.net";
     static readonly PRODUCTION_URL = "https://paymenthubapi.yomabank.com";
-    static readonly DEFAULT_API_VERSION = "v1rc";
     readonly merchantId: string;
     readonly clientId: string;
     readonly clientSecret: string;
     readonly webhookHashKey: string;
     readonly webhookSecret: string | undefined;
-    readonly sandbox: boolean;
+    /** The `{version}` segment of the API paths. */
+    readonly apiVersion: string;
+    /** Seconds before the default HTTP client gives up on a request. */
+    readonly timeoutSeconds: number;
     /** The base URL in use. */
     readonly baseUrl: string;
-    /** The API version in use. */
-    readonly apiVersion: string;
     constructor(options: YomaMmqrConfigOptions);
     /**
      * Reads `YOMA_MMQR_MERCHANT_ID`, `YOMA_MMQR_CLIENT_ID`, `YOMA_MMQR_CLIENT_SECRET`,
-     * `YOMA_MMQR_WEBHOOK_HASHKEY`, `YOMA_MMQR_WEBHOOK_SECRET`, `YOMA_MMQR_SANDBOX`,
-     * `YOMA_MMQR_BASE_URL` and `YOMA_MMQR_API_VERSION`.
+     * `YOMA_MMQR_WEBHOOK_HASHKEY`, `YOMA_MMQR_API_VERSION`, `MYANMAR_PAYMENTS_HTTP_TIMEOUT`,
+     * `YOMA_MMQR_WEBHOOK_SECRET` and `YOMA_MMQR_BASE_URL`.
      */
     static fromEnv(env?: EnvSource): YomaMmqrConfig;
 }

package/dist/cjs/yoma-mmqr/yoma-mmqr.js

@@ -13,37 +13,36 @@ const status_js_1 = require("../core/status.js");
 const validate_js_1 = require("../core/validate.js");
 const values_js_1 = require("../core/values.js");
 /**
- * Yoma MMQR credentials and endpoints. A missing credential throws a `ConfigurationError`.
+ * Yoma MMQR credentials and endpoints. A missing setting throws a `ConfigurationError`. The URL
+ * defaults to production.
  */
 class YomaMmqrConfig {
-    static SANDBOX_URL = 'https://devapi.yomabank.net';
     static PRODUCTION_URL = 'https://paymenthubapi.yomabank.com';
-    static DEFAULT_API_VERSION = 'v1rc';
     merchantId;
     clientId;
     clientSecret;
     webhookHashKey;
     webhookSecret;
-    sandbox;
+    /** The `{version}` segment of the API paths. */
+    apiVersion;
+    /** Seconds before the default HTTP client gives up on a request. */
+    timeoutSeconds;
     /** The base URL in use. */
     baseUrl;
-    /** The API version in use. */
-    apiVersion;
     constructor(options) {
         this.merchantId = (0, env_js_1.requireSetting)('yoma_mmqr', 'merchant_id', options.merchantId);
         this.clientId = (0, env_js_1.requireSetting)('yoma_mmqr', 'client_id', options.clientId);
         this.clientSecret = (0, env_js_1.requireSetting)('yoma_mmqr', 'client_secret', options.clientSecret);
         this.webhookHashKey = (0, env_js_1.requireSetting)('yoma_mmqr', 'webhook_hashkey', options.webhookHashKey);
+        this.apiVersion = (0, env_js_1.requireSetting)('yoma_mmqr', 'api_version', options.apiVersion);
+        this.timeoutSeconds = (0, env_js_1.resolveTimeout)('yoma_mmqr', options.timeoutSeconds);
         this.webhookSecret = (0, env_js_1.optionalSetting)(options.webhookSecret);
-        this.sandbox = options.sandbox ?? true;
-        this.baseUrl = (0, env_js_1.trimUrl)((0, env_js_1.optionalSetting)(options.baseUrl) ??
-            (this.sandbox ? YomaMmqrConfig.SANDBOX_URL : YomaMmqrConfig.PRODUCTION_URL));
-        this.apiVersion = (0, env_js_1.optionalSetting)(options.apiVersion) ?? YomaMmqrConfig.DEFAULT_API_VERSION;
+        this.baseUrl = (0, env_js_1.trimUrl)((0, env_js_1.optionalSetting)(options.baseUrl) ?? YomaMmqrConfig.PRODUCTION_URL);
     }
     /**
      * Reads `YOMA_MMQR_MERCHANT_ID`, `YOMA_MMQR_CLIENT_ID`, `YOMA_MMQR_CLIENT_SECRET`,
-     * `YOMA_MMQR_WEBHOOK_HASHKEY`, `YOMA_MMQR_WEBHOOK_SECRET`, `YOMA_MMQR_SANDBOX`,
-     * `YOMA_MMQR_BASE_URL` and `YOMA_MMQR_API_VERSION`.
+     * `YOMA_MMQR_WEBHOOK_HASHKEY`, `YOMA_MMQR_API_VERSION`, `MYANMAR_PAYMENTS_HTTP_TIMEOUT`,
+     * `YOMA_MMQR_WEBHOOK_SECRET` and `YOMA_MMQR_BASE_URL`.
      */
     static fromEnv(env = (0, env_js_1.defaultEnv)()) {
         return new YomaMmqrConfig({
@@ -51,10 +50,10 @@ class YomaMmqrConfig {
             clientId: (0, env_js_1.envFirst)(env, 'YOMA_MMQR_CLIENT_ID'),
             clientSecret: (0, env_js_1.envFirst)(env, 'YOMA_MMQR_CLIENT_SECRET'),
             webhookHashKey: (0, env_js_1.envFirst)(env, 'YOMA_MMQR_WEBHOOK_HASHKEY'),
+            apiVersion: (0, env_js_1.envFirst)(env, 'YOMA_MMQR_API_VERSION'),
+            timeoutSeconds: (0, env_js_1.envFirst)(env, env_js_1.HTTP_TIMEOUT_VARIABLE),
             webhookSecret: (0, env_js_1.envFirst)(env, 'YOMA_MMQR_WEBHOOK_SECRET'),
-            sandbox: (0, env_js_1.envSandbox)(env, 'YOMA_MMQR_SANDBOX'),
             baseUrl: (0, env_js_1.envFirst)(env, 'YOMA_MMQR_BASE_URL'),
-            apiVersion: (0, env_js_1.envFirst)(env, 'YOMA_MMQR_API_VERSION'),
         });
     }
 }
@@ -79,7 +78,7 @@ class YomaMmqr {
     pendingToken;
     constructor(config, options = {}) {
         this.config = config instanceof YomaMmqrConfig ? config : new YomaMmqrConfig(config);
-        this.transport = new http_js_1.Transport((0, http_js_1.httpClientFrom)(options));
+        this.transport = new http_js_1.Transport((0, http_js_1.httpClientFrom)(options, this.config.timeoutSeconds));
         this.cache = options.tokenCache ?? new cache_js_1.MemoryTokenCache();
     }
     /** A gateway configured from the `YOMA_MMQR_*` environment variables. */
@@ -161,7 +160,9 @@ class YomaMmqr {
         const orderNumber = (0, values_js_1.get)(payload, 'orderNumber');
         const status = (0, values_js_1.trimmed)(payload, 'status');
         const expected = (0, crypto_js_1.hmacSha256Hex)(orderNumber + this.config.webhookHashKey, `orderNumber=${orderNumber}&status=${status}`);
-        if (orderNumber === '' || !(0, crypto_js_1.safeEqual)(expected, (0, values_js_1.get)(payload, 'hashValue').toLowerCase())) {
+        if (orderNumber === '' ||
+            (0, values_js_1.isNested)(payload.status) ||
+            !(0, crypto_js_1.safeEqual)(expected, (0, values_js_1.get)(payload, 'hashValue').toLowerCase())) {
             throw new errors_js_1.SignatureVerificationError('Yoma MMQR callback hash verification failed.', (0, json_js_1.toPlainObject)(payload));
         }
         return new callback_js_1.PaymentCallback({
@@ -210,13 +211,14 @@ class YomaMmqr {
         if (!response.successful() || token === '') {
             throw apiError('token', response.status, body, (0, values_js_1.get)(body, 'error'));
         }
-        const expiresIn = Number.parseInt((0, values_js_1.get)(body, 'expires_in'), 10);
-        const ttl = Math.max(60, (Number.isFinite(expiresIn) && expiresIn > 0 ? expiresIn : 3600) - 60);
+        // The leading digits of `expires_in`; missing, non-numeric or 0 means an hour.
+        const expiresIn = Number(/^\d+/.exec((0, values_js_1.get)(body, 'expires_in'))?.[0] ?? 0);
+        const ttl = Math.max(60, (expiresIn > 0 ? expiresIn : 3600) - 60);
         await this.cache.set(this.tokenCacheKey(), token, ttl);
         return token;
     }
     tokenCacheKey() {
-        return `node-myanmar-payments.yoma-mmqr.token.${(0, crypto_js_1.sha256Hex)(`${this.config.baseUrl}|${this.config.clientId}`)}`;
+        return `myanmar-payments.yoma-mmqr.token.${(0, crypto_js_1.sha256Hex)(`${this.config.baseUrl}|${this.config.clientId}`)}`;
     }
 }
 exports.YomaMmqr = YomaMmqr;