@laranex/myanmar-payments 4.0.0-dev.7 → 4.0.0-dev.9

package/CHANGELOG.md

@@ -31,3 +31,5 @@ Initial release. The version number matches the other Laranex Myanmar payments p
 - Yoma MMQR caches its access token under `myanmar-payments.yoma-mmqr.token.<sha256 of base URL and client id>` (was `node-myanmar-payments.…`), the same key as the PHP, Go and Python SDKs, and reads `expires_in` from its leading digits.
 - `Amount.equals()` compares by value, ignoring leading zeros too (`'01000'` equals `Amount.kyat(1000)`); text that is not plain digits with an optional fraction is never equal.
 - `CallbackRequest.rawBody` holds the exact bytes received (a string body is encoded as UTF-8), next to `body` as text, like Python's `raw_body` and Go's `Body`.
+- `WaveMoneyPaymentData` takes optional `merchantName` and `timeToLiveSeconds`, which override the configured `merchantName` and `timeToLiveSeconds` for one payment (request hash included); a blank `merchantName` or a `timeToLiveSeconds` that is not a whole number greater than 0 throws `InvalidPaymentDataError`, like the PHP SDK.
+- `KbzPayPaymentData.timeoutMinutes` is renamed to `timeToLiveSeconds` and takes seconds, like Wave Money: 60 to 7200, in whole minutes (a multiple of 60), because KBZ's `timeout_express` counts minutes (`1800` is sent as `30m`). Upgrading: multiply the old value by 60.

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

@@ -58,8 +58,11 @@ export interface KbzPayPaymentData {
     callbackUrl: string;
     /** The product name shown to the customer. */
     title?: string | undefined;
-    /** How long the order stays payable, 1 to 120 minutes. KBZ defaults to 120. */
-    timeoutMinutes?: number | undefined;
+    /**
+     * Seconds the customer has to pay before the order expires, 60 to 7200 in whole minutes (a multiple
+     * of 60). KBZ counts minutes, so 1800 is sent as `30m`. KBZ defaults to 7200 (120 minutes).
+     */
+    timeToLiveSeconds?: number | undefined;
     /** Free text KBZ sends back unchanged in the callback, at most 512 characters once URL-encoded. */
     callbackInfo?: string | undefined;
 }

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

@@ -93,7 +93,8 @@ 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('timeToLiveSeconds', data.timeToLiveSeconds, 60, 7200)
+            .when(Number.isInteger(data.timeToLiveSeconds) && data.timeToLiveSeconds % 60 !== 0, 'timeToLiveSeconds', 'The timeToLiveSeconds field must be a multiple of 60.')
             .string('callbackInfo', data.callbackInfo)
             .max('callbackInfo', typeof data.callbackInfo === 'string' ? (0, crypto_js_1.queryEscape)(data.callbackInfo) : undefined, 512)
             .validate();
@@ -126,9 +127,9 @@ class KbzPay {
         return new results_js_1.QrPayment({
             orderId: data.orderId,
             qrString: qrCode,
-            expiresAt: data.timeoutMinutes === undefined
+            expiresAt: data.timeToLiveSeconds === undefined
                 ? undefined
-                : new Date(Date.now() + data.timeoutMinutes * 60_000),
+                : new Date(Date.now() + data.timeToLiveSeconds * 1000),
             reference: order.prepayId,
             raw: (0, json_js_1.toPlainObject)(order.response),
         });
@@ -199,8 +200,8 @@ class KbzPay {
         if (data.title) {
             biz.title = data.title;
         }
-        if (data.timeoutMinutes !== undefined) {
-            biz.timeout_express = `${data.timeoutMinutes}m`;
+        if (data.timeToLiveSeconds !== undefined) {
+            biz.timeout_express = `${data.timeToLiveSeconds / 60}m`;
         }
         if (data.callbackInfo) {
             biz.callback_info = (0, crypto_js_1.queryEscape)(data.callbackInfo);

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

@@ -79,6 +79,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.
+     */
+    timeToLiveSeconds?: number | null | undefined;
 }
 /**
  * Wave Money (WavePay payment gateway): redirect payments and callbacks. Wave has no status API,

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

@@ -127,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)
@@ -153,7 +157,7 @@ class WaveMoney {
             data.merchantReferenceId = (0, crypto_js_1.randomHex)();
         }
         const amount = WaveMoney.resolvedAmount(data).toString();
-        const ttl = String(this.config.timeToLiveSeconds);
+        const ttl = String(data.timeToLiveSeconds ?? this.config.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
@@ -168,7 +172,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,
@@ -226,6 +230,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/esm/kbz-pay/kbz-pay.d.ts

@@ -58,8 +58,11 @@ export interface KbzPayPaymentData {
     callbackUrl: string;
     /** The product name shown to the customer. */
     title?: string | undefined;
-    /** How long the order stays payable, 1 to 120 minutes. KBZ defaults to 120. */
-    timeoutMinutes?: number | undefined;
+    /**
+     * Seconds the customer has to pay before the order expires, 60 to 7200 in whole minutes (a multiple
+     * of 60). KBZ counts minutes, so 1800 is sent as `30m`. KBZ defaults to 7200 (120 minutes).
+     */
+    timeToLiveSeconds?: number | undefined;
     /** Free text KBZ sends back unchanged in the callback, at most 512 characters once URL-encoded. */
     callbackInfo?: string | undefined;
 }

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

@@ -90,7 +90,8 @@ export 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('timeToLiveSeconds', data.timeToLiveSeconds, 60, 7200)
+            .when(Number.isInteger(data.timeToLiveSeconds) && data.timeToLiveSeconds % 60 !== 0, 'timeToLiveSeconds', 'The timeToLiveSeconds field must be a multiple of 60.')
             .string('callbackInfo', data.callbackInfo)
             .max('callbackInfo', typeof data.callbackInfo === 'string' ? queryEscape(data.callbackInfo) : undefined, 512)
             .validate();
@@ -123,9 +124,9 @@ export class KbzPay {
         return new QrPayment({
             orderId: data.orderId,
             qrString: qrCode,
-            expiresAt: data.timeoutMinutes === undefined
+            expiresAt: data.timeToLiveSeconds === undefined
                 ? undefined
-                : new Date(Date.now() + data.timeoutMinutes * 60_000),
+                : new Date(Date.now() + data.timeToLiveSeconds * 1000),
             reference: order.prepayId,
             raw: toPlainObject(order.response),
         });
@@ -196,8 +197,8 @@ export class KbzPay {
         if (data.title) {
             biz.title = data.title;
         }
-        if (data.timeoutMinutes !== undefined) {
-            biz.timeout_express = `${data.timeoutMinutes}m`;
+        if (data.timeToLiveSeconds !== undefined) {
+            biz.timeout_express = `${data.timeToLiveSeconds / 60}m`;
         }
         if (data.callbackInfo) {
             biz.callback_info = queryEscape(data.callbackInfo);

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

@@ -79,6 +79,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.
+     */
+    timeToLiveSeconds?: number | null | undefined;
 }
 /**
  * Wave Money (WavePay payment gateway): redirect payments and callbacks. Wave has no status API,

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

@@ -123,7 +123,11 @@ export 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)
@@ -149,7 +153,7 @@ export class WaveMoney {
             data.merchantReferenceId = randomHex();
         }
         const amount = WaveMoney.resolvedAmount(data).toString();
-        const ttl = String(this.config.timeToLiveSeconds);
+        const ttl = String(data.timeToLiveSeconds ?? this.config.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
@@ -164,7 +168,7 @@ export 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,
@@ -221,6 +225,9 @@ export class WaveMoney {
         return hmacSha256Hex(this.config.secretKey, parts.join(''));
     }
 }
+function isSet(value) {
+    return value !== undefined && value !== null;
+}
 function errorMessage(body) {
     const errors = body.errors;
     if (isLosslessObject(errors)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@laranex/myanmar-payments",
-  "version": "4.0.0-dev.7",
+  "version": "4.0.0-dev.9",
   "description": "Node.js SDK for Myanmar payment gateways: KBZ Pay, Wave Money, AYA Pay, Yoma MMQR and CyberSource. Typed requests and results, exact amounts, no runtime dependencies.",
   "keywords": [
     "laranex",

package/skills/node-myanmar-payments/SKILL.md

@@ -58,7 +58,7 @@ const payment = await kbz.pwa({
 res.writeHead(302, { Location: payment.url }).end();
 ```
 
-- `RedirectPayment` (`url`) from `kbz.pwa(data)` and `wave.initiate(data)`. Wave fills `data.merchantReferenceId` when empty; store it.
+- `RedirectPayment` (`url`) from `kbz.pwa(data)` and `wave.initiate(data)`. Wave fills `data.merchantReferenceId` when empty; store it. Pass `merchantName` or `timeToLiveSeconds` in Wave's payment data to override the configured `WAVE_MONEY_MERCHANT_NAME` or `WAVE_MONEY_TIME_TO_LIVE_IN_SECONDS` for that one payment (the settings stay required).
 - `FormPayment` from `aya.initiate(data)` and `cyberSource.initiate(data)` (no network call): send `payment.toHtml()` as an auto-submitting page, or render `action`, `fields` and `enctype` yourself.
 - `QrPayment` from `kbz.qr(data)` (encode `qrString`) and `yoma.initiate(data)` (`qrImageDataUri()`, `expiresAt`, `reference`). A Yoma QR lives `YomaMmqr.QR_LIFETIME_SECONDS` (120); renew it with `yoma.renewQr(orderId)`.
 - `AppPayment` from `kbz.app(data)`: `res.json(payment)` sends `orderId`, `orderInfo`, `sign` and `signType` to your mobile app.