@paystack/checkout-js 1.57.0-beta.2 → 1.57.0-beta.3

package/dist/checkout.js

@@ -6508,7 +6508,7 @@ var Paystack = (function (exports) {
       if (response.status === 'incorrect-amount-sent' || response.message_type === 'INCORRECT_AMOUNT') {
         return this.getCleanResponse(response, 'Incorrect amount sent');
       }
-      if (response.status === 'awaiting_registration_token') {
+      if (['awaiting_registration_token', 'awaiting_ussd_confirmation'].includes(response.status)) {
         return this.getCleanResponse(response);
       }
       if (response.auth && response.auth !== 'none') {
@@ -6562,6 +6562,58 @@ var Paystack = (function (exports) {
     });
   };
 
+  // Duplicated from `subscribeToChargeEvents` on purpose. Hoisting that function's locals
+  // to module scope so both could share them would modify the shared path, which
+  // RAILS-12006 AC5 requires to stay byte-identical. Do not "clean this up".
+  var confirmationUndefinedError = {
+    status: 'error',
+    message: 'We could not listen for charge response.'
+  };
+  var confirmationSubscriptionError = {
+    status: 'error',
+    message: 'We could not listen for charge response. Use transaction.requery() to check the status.'
+  };
+
+  // Dedicated listener for the Ghana mobile money USSD confirmation channel.
+  // Deliberately separate from `subscribeToChargeEvents`: that function is the shared
+  // path for every channel and market, and this flow needs an unsubscribe available
+  // before any event arrives. `context` is used only for logAPIResponse -- unlike the
+  // shared path this never writes `context.isListening`, because the confirmation
+  // channel runs alongside the main charge subscription and the two would otherwise
+  // fight over a single flag on the same transaction.
+  var subscribeToConfirmationEvents = function subscribeToConfirmationEvents(options, context, callback) {
+    var channel = options.channel,
+      paymentMethod = options.paymentMethod;
+    if (!window || !window.Pusher) {
+      callback(confirmationUndefinedError, noOp);
+      return noOp;
+    }
+    var pusher = new window.Pusher(configToUse.pusherKey, {
+      cluster: 'eu',
+      disableStats: true
+    });
+    var hasUnsubscribed = false;
+    var unsubscribe = function unsubscribe() {
+      if (hasUnsubscribed) {
+        return;
+      }
+      hasUnsubscribed = true;
+      pusher.unsubscribe(channel);
+      pusher.disconnect();
+    };
+    var pusherSubscription = pusher.subscribe(channel);
+    pusherSubscription.bind('pusher:subscription_error', function () {
+      unsubscribe();
+      callback(confirmationSubscriptionError, unsubscribe);
+    });
+    pusherSubscription.bind('response', function (response) {
+      var formattedResponse = ChargeResponses.parse(response);
+      context.logAPIResponse(formattedResponse, paymentMethod);
+      callback(formattedResponse, unsubscribe);
+    });
+    return unsubscribe;
+  };
+
   var uncurryThis$7 = functionUncurryThis;
   var PROPER_FUNCTION_NAME$2 = functionName.PROPER;
   var redefine$4 = redefine$a.exports;
@@ -20386,6 +20438,10 @@ var Paystack = (function (exports) {
     }
   };
 
+  // Charge statuses that leave the transaction with a Pusher channel worth listening on.
+  // `awaiting_ussd_confirmation` is mid-flight, not settled, but it still carries the
+  // `channel_name` the outcome will arrive on.
+  var LISTENABLE_CHARGE_STATUSES = ['success', 'awaiting_ussd_confirmation'];
   function validate$1(phoneNumber) {
     return new Promise(function (resolve, reject) {
       var validation = PhoneNumber.validate(phoneNumber);
@@ -20425,11 +20481,11 @@ var Paystack = (function (exports) {
     mobileMoneyChargeAPI: function mobileMoneyChargeAPI(params) {
       var _this = this;
       return MobileMoneyAPI.charge(params).then(function (response) {
-        if (response.status === 'success') {
+        if (LISTENABLE_CHARGE_STATUSES.includes(response.status)) {
           _this.mobileMoney = response;
-          if (response.data && response.data.display && response.data.display.otpSentCount === 1) {
-            _this.logTokenRequest('mobile money');
-          }
+        }
+        if (response.status === 'success' && response.data && response.data.display && response.data.display.otpSentCount === 1) {
+          _this.logTokenRequest('mobile money');
         }
         return response;
       });
@@ -20502,17 +20558,33 @@ var Paystack = (function (exports) {
       });
     },
     listenForMobileMoneyCharge: function listenForMobileMoneyCharge(callback) {
-      if (this.mobileMoney.status !== 'success') {
+      if (!LISTENABLE_CHARGE_STATUSES.includes(this.mobileMoney.status)) {
+        return Promise.reject(Error('Please start a mobile money charge with Transaction.chargeMobileMoney()'));
+      }
+      var _ref2 = this.mobileMoney.data || {},
+        channel = _ref2.channel,
+        channelName = _ref2.channel_name;
+      var listenerChannel = channel || channelName;
+      if (!listenerChannel) {
         return Promise.reject(Error('Please start a mobile money charge with Transaction.chargeMobileMoney()'));
       }
-      var _this$mobileMoney$dat = this.mobileMoney.data,
-        channel = _this$mobileMoney$dat.channel,
-        channelName = _this$mobileMoney$dat.channel_name;
       var listenerOptions = {
-        channel: channel || channelName,
+        channel: listenerChannel,
         paymentMethod: 'mobile_money'
       };
       return this.listenForCharge(listenerOptions, callback);
+    },
+    listenForMobileMoneyConfirmation: function listenForMobileMoneyConfirmation(callback, pusherChannel) {
+      var data = this.mobileMoney.data;
+      var confirmationChannel = pusherChannel || data && data.confirm_channel_name;
+      if (!confirmationChannel) {
+        throw new Error('Please provide the confirm_channel_name returned by Transaction.chargeMobileMoney()');
+      }
+      var listenerOptions = {
+        channel: confirmationChannel,
+        paymentMethod: 'mobile_money'
+      };
+      return subscribeToConfirmationEvents(listenerOptions, this, callback);
     }
   };
 
@@ -21255,6 +21327,11 @@ var Paystack = (function (exports) {
           return this.logError(response.message);
         case 'auth':
           return this.logAuth(response.data.auth);
+        case 'awaiting_ussd_confirmation':
+          // The customer has been shown the USSD prompt but has not dialled yet. Logging
+          // it gives the funnel denominator for the `pending` entry the confirmation
+          // event writes when they do.
+          return this.logAPIResponseMessage(response.message);
         default:
           return false;
       }

package/es/checkout.js

@@ -6505,7 +6505,7 @@ var ChargeResponses = {
     if (response.status === 'incorrect-amount-sent' || response.message_type === 'INCORRECT_AMOUNT') {
       return this.getCleanResponse(response, 'Incorrect amount sent');
     }
-    if (response.status === 'awaiting_registration_token') {
+    if (['awaiting_registration_token', 'awaiting_ussd_confirmation'].includes(response.status)) {
       return this.getCleanResponse(response);
     }
     if (response.auth && response.auth !== 'none') {
@@ -6559,6 +6559,58 @@ var subscribeToChargeEvents = function subscribeToChargeEvents(options, context,
   });
 };
 
+// Duplicated from `subscribeToChargeEvents` on purpose. Hoisting that function's locals
+// to module scope so both could share them would modify the shared path, which
+// RAILS-12006 AC5 requires to stay byte-identical. Do not "clean this up".
+var confirmationUndefinedError = {
+  status: 'error',
+  message: 'We could not listen for charge response.'
+};
+var confirmationSubscriptionError = {
+  status: 'error',
+  message: 'We could not listen for charge response. Use transaction.requery() to check the status.'
+};
+
+// Dedicated listener for the Ghana mobile money USSD confirmation channel.
+// Deliberately separate from `subscribeToChargeEvents`: that function is the shared
+// path for every channel and market, and this flow needs an unsubscribe available
+// before any event arrives. `context` is used only for logAPIResponse -- unlike the
+// shared path this never writes `context.isListening`, because the confirmation
+// channel runs alongside the main charge subscription and the two would otherwise
+// fight over a single flag on the same transaction.
+var subscribeToConfirmationEvents = function subscribeToConfirmationEvents(options, context, callback) {
+  var channel = options.channel,
+    paymentMethod = options.paymentMethod;
+  if (!window || !window.Pusher) {
+    callback(confirmationUndefinedError, noOp);
+    return noOp;
+  }
+  var pusher = new window.Pusher(configToUse.pusherKey, {
+    cluster: 'eu',
+    disableStats: true
+  });
+  var hasUnsubscribed = false;
+  var unsubscribe = function unsubscribe() {
+    if (hasUnsubscribed) {
+      return;
+    }
+    hasUnsubscribed = true;
+    pusher.unsubscribe(channel);
+    pusher.disconnect();
+  };
+  var pusherSubscription = pusher.subscribe(channel);
+  pusherSubscription.bind('pusher:subscription_error', function () {
+    unsubscribe();
+    callback(confirmationSubscriptionError, unsubscribe);
+  });
+  pusherSubscription.bind('response', function (response) {
+    var formattedResponse = ChargeResponses.parse(response);
+    context.logAPIResponse(formattedResponse, paymentMethod);
+    callback(formattedResponse, unsubscribe);
+  });
+  return unsubscribe;
+};
+
 var uncurryThis$7 = functionUncurryThis;
 var PROPER_FUNCTION_NAME$2 = functionName.PROPER;
 var redefine$4 = redefine$a.exports;
@@ -20383,6 +20435,10 @@ var MobileMoneyAPI = {
   }
 };
 
+// Charge statuses that leave the transaction with a Pusher channel worth listening on.
+// `awaiting_ussd_confirmation` is mid-flight, not settled, but it still carries the
+// `channel_name` the outcome will arrive on.
+var LISTENABLE_CHARGE_STATUSES = ['success', 'awaiting_ussd_confirmation'];
 function validate$1(phoneNumber) {
   return new Promise(function (resolve, reject) {
     var validation = PhoneNumber.validate(phoneNumber);
@@ -20422,11 +20478,11 @@ var MobileMoneyCharge = {
   mobileMoneyChargeAPI: function mobileMoneyChargeAPI(params) {
     var _this = this;
     return MobileMoneyAPI.charge(params).then(function (response) {
-      if (response.status === 'success') {
+      if (LISTENABLE_CHARGE_STATUSES.includes(response.status)) {
         _this.mobileMoney = response;
-        if (response.data && response.data.display && response.data.display.otpSentCount === 1) {
-          _this.logTokenRequest('mobile money');
-        }
+      }
+      if (response.status === 'success' && response.data && response.data.display && response.data.display.otpSentCount === 1) {
+        _this.logTokenRequest('mobile money');
       }
       return response;
     });
@@ -20499,17 +20555,33 @@ var MobileMoneyCharge = {
     });
   },
   listenForMobileMoneyCharge: function listenForMobileMoneyCharge(callback) {
-    if (this.mobileMoney.status !== 'success') {
+    if (!LISTENABLE_CHARGE_STATUSES.includes(this.mobileMoney.status)) {
+      return Promise.reject(Error('Please start a mobile money charge with Transaction.chargeMobileMoney()'));
+    }
+    var _ref2 = this.mobileMoney.data || {},
+      channel = _ref2.channel,
+      channelName = _ref2.channel_name;
+    var listenerChannel = channel || channelName;
+    if (!listenerChannel) {
       return Promise.reject(Error('Please start a mobile money charge with Transaction.chargeMobileMoney()'));
     }
-    var _this$mobileMoney$dat = this.mobileMoney.data,
-      channel = _this$mobileMoney$dat.channel,
-      channelName = _this$mobileMoney$dat.channel_name;
     var listenerOptions = {
-      channel: channel || channelName,
+      channel: listenerChannel,
       paymentMethod: 'mobile_money'
     };
     return this.listenForCharge(listenerOptions, callback);
+  },
+  listenForMobileMoneyConfirmation: function listenForMobileMoneyConfirmation(callback, pusherChannel) {
+    var data = this.mobileMoney.data;
+    var confirmationChannel = pusherChannel || data && data.confirm_channel_name;
+    if (!confirmationChannel) {
+      throw new Error('Please provide the confirm_channel_name returned by Transaction.chargeMobileMoney()');
+    }
+    var listenerOptions = {
+      channel: confirmationChannel,
+      paymentMethod: 'mobile_money'
+    };
+    return subscribeToConfirmationEvents(listenerOptions, this, callback);
   }
 };
 
@@ -21252,6 +21324,11 @@ var AnalyticsFunctions$1 = _objectSpread2(_objectSpread2({}, CapitecPayAnalytics
         return this.logError(response.message);
       case 'auth':
         return this.logAuth(response.data.auth);
+      case 'awaiting_ussd_confirmation':
+        // The customer has been shown the USSD prompt but has not dialled yet. Logging
+        // it gives the funnel denominator for the `pending` entry the confirmation
+        // event writes when they do.
+        return this.logAPIResponseMessage(response.message);
       default:
         return false;
     }

package/lib/checkout.js

@@ -6509,7 +6509,7 @@ var ChargeResponses = {
     if (response.status === 'incorrect-amount-sent' || response.message_type === 'INCORRECT_AMOUNT') {
       return this.getCleanResponse(response, 'Incorrect amount sent');
     }
-    if (response.status === 'awaiting_registration_token') {
+    if (['awaiting_registration_token', 'awaiting_ussd_confirmation'].includes(response.status)) {
       return this.getCleanResponse(response);
     }
     if (response.auth && response.auth !== 'none') {
@@ -6563,6 +6563,58 @@ var subscribeToChargeEvents = function subscribeToChargeEvents(options, context,
   });
 };
 
+// Duplicated from `subscribeToChargeEvents` on purpose. Hoisting that function's locals
+// to module scope so both could share them would modify the shared path, which
+// RAILS-12006 AC5 requires to stay byte-identical. Do not "clean this up".
+var confirmationUndefinedError = {
+  status: 'error',
+  message: 'We could not listen for charge response.'
+};
+var confirmationSubscriptionError = {
+  status: 'error',
+  message: 'We could not listen for charge response. Use transaction.requery() to check the status.'
+};
+
+// Dedicated listener for the Ghana mobile money USSD confirmation channel.
+// Deliberately separate from `subscribeToChargeEvents`: that function is the shared
+// path for every channel and market, and this flow needs an unsubscribe available
+// before any event arrives. `context` is used only for logAPIResponse -- unlike the
+// shared path this never writes `context.isListening`, because the confirmation
+// channel runs alongside the main charge subscription and the two would otherwise
+// fight over a single flag on the same transaction.
+var subscribeToConfirmationEvents = function subscribeToConfirmationEvents(options, context, callback) {
+  var channel = options.channel,
+    paymentMethod = options.paymentMethod;
+  if (!window || !window.Pusher) {
+    callback(confirmationUndefinedError, noOp);
+    return noOp;
+  }
+  var pusher = new window.Pusher(configToUse.pusherKey, {
+    cluster: 'eu',
+    disableStats: true
+  });
+  var hasUnsubscribed = false;
+  var unsubscribe = function unsubscribe() {
+    if (hasUnsubscribed) {
+      return;
+    }
+    hasUnsubscribed = true;
+    pusher.unsubscribe(channel);
+    pusher.disconnect();
+  };
+  var pusherSubscription = pusher.subscribe(channel);
+  pusherSubscription.bind('pusher:subscription_error', function () {
+    unsubscribe();
+    callback(confirmationSubscriptionError, unsubscribe);
+  });
+  pusherSubscription.bind('response', function (response) {
+    var formattedResponse = ChargeResponses.parse(response);
+    context.logAPIResponse(formattedResponse, paymentMethod);
+    callback(formattedResponse, unsubscribe);
+  });
+  return unsubscribe;
+};
+
 var uncurryThis$7 = functionUncurryThis;
 var PROPER_FUNCTION_NAME$2 = functionName.PROPER;
 var redefine$4 = redefine$a.exports;
@@ -20387,6 +20439,10 @@ var MobileMoneyAPI = {
   }
 };
 
+// Charge statuses that leave the transaction with a Pusher channel worth listening on.
+// `awaiting_ussd_confirmation` is mid-flight, not settled, but it still carries the
+// `channel_name` the outcome will arrive on.
+var LISTENABLE_CHARGE_STATUSES = ['success', 'awaiting_ussd_confirmation'];
 function validate$1(phoneNumber) {
   return new Promise(function (resolve, reject) {
     var validation = PhoneNumber.validate(phoneNumber);
@@ -20426,11 +20482,11 @@ var MobileMoneyCharge = {
   mobileMoneyChargeAPI: function mobileMoneyChargeAPI(params) {
     var _this = this;
     return MobileMoneyAPI.charge(params).then(function (response) {
-      if (response.status === 'success') {
+      if (LISTENABLE_CHARGE_STATUSES.includes(response.status)) {
         _this.mobileMoney = response;
-        if (response.data && response.data.display && response.data.display.otpSentCount === 1) {
-          _this.logTokenRequest('mobile money');
-        }
+      }
+      if (response.status === 'success' && response.data && response.data.display && response.data.display.otpSentCount === 1) {
+        _this.logTokenRequest('mobile money');
       }
       return response;
     });
@@ -20503,17 +20559,33 @@ var MobileMoneyCharge = {
     });
   },
   listenForMobileMoneyCharge: function listenForMobileMoneyCharge(callback) {
-    if (this.mobileMoney.status !== 'success') {
+    if (!LISTENABLE_CHARGE_STATUSES.includes(this.mobileMoney.status)) {
+      return Promise.reject(Error('Please start a mobile money charge with Transaction.chargeMobileMoney()'));
+    }
+    var _ref2 = this.mobileMoney.data || {},
+      channel = _ref2.channel,
+      channelName = _ref2.channel_name;
+    var listenerChannel = channel || channelName;
+    if (!listenerChannel) {
       return Promise.reject(Error('Please start a mobile money charge with Transaction.chargeMobileMoney()'));
     }
-    var _this$mobileMoney$dat = this.mobileMoney.data,
-      channel = _this$mobileMoney$dat.channel,
-      channelName = _this$mobileMoney$dat.channel_name;
     var listenerOptions = {
-      channel: channel || channelName,
+      channel: listenerChannel,
       paymentMethod: 'mobile_money'
     };
     return this.listenForCharge(listenerOptions, callback);
+  },
+  listenForMobileMoneyConfirmation: function listenForMobileMoneyConfirmation(callback, pusherChannel) {
+    var data = this.mobileMoney.data;
+    var confirmationChannel = pusherChannel || data && data.confirm_channel_name;
+    if (!confirmationChannel) {
+      throw new Error('Please provide the confirm_channel_name returned by Transaction.chargeMobileMoney()');
+    }
+    var listenerOptions = {
+      channel: confirmationChannel,
+      paymentMethod: 'mobile_money'
+    };
+    return subscribeToConfirmationEvents(listenerOptions, this, callback);
   }
 };
 
@@ -21256,6 +21328,11 @@ var AnalyticsFunctions$1 = _objectSpread2(_objectSpread2({}, CapitecPayAnalytics
         return this.logError(response.message);
       case 'auth':
         return this.logAuth(response.data.auth);
+      case 'awaiting_ussd_confirmation':
+        // The customer has been shown the USSD prompt but has not dialled yet. Logging
+        // it gives the funnel denominator for the `pending` entry the confirmation
+        // event writes when they do.
+        return this.logAPIResponseMessage(response.message);
       default:
         return false;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paystack/checkout-js",
-  "version": "1.57.0-beta.2",
+  "version": "1.57.0-beta.3",
   "description": "Client-side JS library for billing on Paystack",
   "main": "lib/checkout.js",
   "module": "es/checkout.js",