@spare-technologies/spare-link 0.1.0-beta.0 → 1.0.0

package/lib/commonjs/core/services/hosted-flow-controller.js

@@ -0,0 +1,333 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.HostedFlowController = exports.DEFAULT_READY_TIMEOUT_MS = void 0;
+var _bankRedirect = require("../../internal/bank-redirect.js");
+var _bridgeMessage = require("../../internal/hosted/bridge-message.js");
+var _logger = require("../../internal/logger.js");
+var _paymentReturnParams = require("../models/payment-return-params.js");
+var _hostedFlowState = require("./hosted-flow-state.js");
+const log = (0, _logger.createLogger)('HostedFlowController');
+
+/** Opens a bank authorization URL outside the WebView. */
+
+/**
+ * How long the page has to become interactive, measured from when the webview
+ * mounts.
+ *
+ * A page can load and still never speak: its script can fail to fetch, or throw
+ * before it posts `spare.ready`. Nothing else would notice, and the payer would
+ * hold a blank frame for as long as they were willing to.
+ *
+ * Measured from the webview rather than from this controller, because a
+ * controller is built before the screen is: the sheet's animation and whatever
+ * the host waits on before rendering would otherwise be charged against the
+ * page's budget, and a page that merely loads slowly would be called unreachable.
+ */
+const DEFAULT_READY_TIMEOUT_MS = exports.DEFAULT_READY_TIMEOUT_MS = 20_000;
+/**
+ * Drives a hosted payment from the messages the page sends and the deep link
+ * the OS delivers when the payer comes back.
+ *
+ * The SDK makes no API calls of its own: the page creates the consent, and the
+ * merchant's backend reads the result. So this controller only ever reacts —
+ * which is why every transition here is guarded against arriving after the flow
+ * has already resolved.
+ */
+class HostedFlowController {
+  listeners = new Set();
+  constructor(options) {
+    this.reference = options.reference;
+    this.bankLauncher = options.bankLauncher ?? (url => (0, _bankRedirect.launchBankRedirect)({
+      authorizationUrl: url
+    }));
+    this.readyTimeoutMs = options.readyTimeoutMs ?? DEFAULT_READY_TIMEOUT_MS;
+    this.currentState = _hostedFlowState.HostedFlowStates.loading(options.reference);
+  }
+
+  /**
+   * Records that the webview carrying the page is on screen.
+   *
+   * Starts the clock the page has to become interactive. Called on mount rather
+   * than on load, so a document that never finishes arriving is covered too.
+   */
+  reportPageMounted() {
+    if (this.currentState.phase !== 'loading') return;
+    this.watchForReadiness();
+  }
+  get state() {
+    return this.currentState;
+  }
+
+  /** Subscribe to state changes. Returns an unsubscribe function. */
+  subscribe(listener) {
+    this.listeners.add(listener);
+    return () => {
+      this.listeners.delete(listener);
+    };
+  }
+
+  /**
+   * Reacts to a message from the hosted page.
+   *
+   * Resolves to whether the message was understood, so a caller can log what it
+   * dropped. An unrecognised message is not a failure: the page keeps working
+   * and the payer is unaffected.
+   */
+  async handleBridgeMessage(raw) {
+    const message = (0, _bridgeMessage.parseHostedBridgeMessage)(raw);
+    if (!message) {
+      log.info('dropped an unrecognised message from the hosted page');
+      return false;
+    }
+
+    // Only a page still on screen may drive the flow. The page posts on render,
+    // and a webview left behind a payer who has moved on can post again: a `ready`
+    // accepted while they are at their bank would drag the flow back to `hosted`,
+    // and the `openUrl` after it would open a second bank browser for a payment
+    // whose first authorization is already under way.
+    if (!this.isPagePresented()) {
+      log.info(`ignoring a '${message.type}' message from a page no longer on screen`);
+      return false;
+    }
+    switch (message.type) {
+      case 'ready':
+        this.stopWatchingForReadiness();
+        this.moveTo(_hostedFlowState.HostedFlowStates.hosted(this.reference, this.currentState.attempt));
+        break;
+      case 'openUrl':
+        await this.openBank(message.url);
+        break;
+      case 'cancel':
+        // The page spoke, so it is not unreachable whatever it went on to say.
+        this.stopWatchingForReadiness();
+        this.moveTo(_hostedFlowState.HostedFlowStates.cancelled(this.reference, this.currentState.attempt));
+        break;
+      case 'error':
+        this.stopWatchingForReadiness();
+        this.moveTo(_hostedFlowState.HostedFlowStates.failed({
+          reference: this.reference,
+          errorCode: message.code,
+          attempt: this.currentState.attempt
+        }));
+        break;
+    }
+    return true;
+  }
+
+  /**
+   * Resolves the flow from the deep link the payer returned through.
+   *
+   * The outcome is read from the link rather than inferred: it is the only
+   * report of what the bank and the payment actually did.
+   */
+  /** Whether the page is still the thing on screen and may still be believed. */
+  isPagePresented() {
+    const phase = this.currentState.phase;
+    return phase === 'loading' || phase === 'hosted';
+  }
+  handleReturn(uri) {
+    const {
+      outcome,
+      report
+    } = (0, _paymentReturnParams.readPaymentReturn)(uri);
+
+    // A return that names a different payment is not this payment's business. The
+    // link is handed over by the OS and any app can send one, and a delayed
+    // callback for an earlier payment would otherwise resolve whichever one is
+    // open — with the wrong outcome attached to the wrong reference.
+    if (report.reference !== undefined && report.reference !== this.reference) {
+      log.warning('ignoring a return that names a different payment');
+      return;
+    }
+    this.stopWatchingForReadiness();
+    if (outcome === 'processed') {
+      this.moveTo(_hostedFlowState.HostedFlowStates.succeeded({
+        reference: this.reference,
+        attempt: this.currentState.attempt,
+        report
+      }));
+      return;
+    }
+
+    // `unknown` is not a failure. The service has statuses this version has not
+    // been taught, and a payment still being decided must not be reported as one
+    // that failed — abandoned says "ask your backend", which is the truth.
+    if (outcome === 'unknown') {
+      log.info('the return did not say what happened — reporting it as unresolved');
+      this.moveTo(_hostedFlowState.HostedFlowStates.abandoned(this.reference, this.currentState.attempt));
+      return;
+    }
+    this.moveTo(_hostedFlowState.HostedFlowStates.failed({
+      reference: this.reference,
+      errorCode: report.errorCode ?? 'authorize_failed',
+      attempt: this.currentState.attempt,
+      report
+    }));
+  }
+
+  /**
+   * Records that the payment page could not be loaded.
+   *
+   * Only meaningful before the bank is opened. Once the payer is away, a load
+   * error is the WebView behind them and says nothing about their payment.
+   *
+   * Before the page has spoken this does not resolve the flow: nothing has been
+   * attempted, so the payer is offered the page again rather than told their
+   * payment failed.
+   *
+   * After it has spoken, it does. By then the payer may have chosen a bank and
+   * the page may have created a consent for it, and reloading from the start
+   * could create a second one while silently discarding what they entered.
+   */
+  failToLoad() {
+    const phase = this.currentState.phase;
+    if (phase !== 'loading' && phase !== 'hosted') {
+      log.info('ignoring a page load error raised behind the payer');
+      return;
+    }
+    this.stopWatchingForReadiness();
+    if (phase === 'hosted') {
+      log.severe('the page failed after it had already started — not offering a reload');
+      this.moveTo(_hostedFlowState.HostedFlowStates.failed({
+        reference: this.reference,
+        // Not `page_unavailable`: that means the page was never reached and
+        // nothing was attempted. This page was working, and the payer may have
+        // got as far as a consent before its frame died — a different thing for
+        // a merchant to look into, and a different thing to show the payer.
+        errorCode: 'page_lost',
+        attempt: this.currentState.attempt
+      }));
+      return;
+    }
+    this.moveTo(_hostedFlowState.HostedFlowStates.unreachable(this.reference, this.currentState.attempt));
+  }
+
+  /**
+   * Asks for the page again after it could not be reached.
+   *
+   * The attempt is counted so the screen mounts a fresh webview: reusing the one
+   * that failed would show the payer the same dead frame.
+   */
+  retry() {
+    if (this.currentState.phase !== 'unreachable') {
+      log.info('ignoring a retry for a payment that is not waiting on the page');
+      return;
+    }
+    const attempt = this.currentState.attempt + 1;
+    log.info(`asking for the payment page again (attempt ${attempt})`);
+    // The fresh webview reports itself mounted, which restarts the clock.
+    this.moveTo(_hostedFlowState.HostedFlowStates.loading(this.reference, attempt));
+  }
+
+  /**
+   * Records that the payer gave up on a page that could not be reached.
+   *
+   * Reported as a failure rather than abandonment: the payer did not leave a
+   * payment in progress, the SDK never managed to present one.
+   */
+  giveUp() {
+    if (this.currentState.phase !== 'unreachable') {
+      log.info('ignoring a give-up for a payment that is not waiting on the page');
+      return;
+    }
+    this.stopWatchingForReadiness();
+    this.moveTo(_hostedFlowState.HostedFlowStates.failed({
+      reference: this.reference,
+      errorCode: 'page_unavailable',
+      attempt: this.currentState.attempt
+    }));
+  }
+
+  /**
+   * Records that the payer left before the flow resolved.
+   *
+   * A payment already at the bank may still complete after this, so it is
+   * reported as abandoned rather than failed: the merchant's backend, not the
+   * app, is what knows.
+   */
+  abandon() {
+    this.stopWatchingForReadiness();
+    if (this.currentState.phase === 'unreachable') {
+      // Nothing was ever presented, so there is no payment that might still
+      // complete at the bank — which is what abandonment promises the merchant.
+      this.moveTo(_hostedFlowState.HostedFlowStates.failed({
+        reference: this.reference,
+        errorCode: 'page_unavailable',
+        attempt: this.currentState.attempt
+      }));
+      return;
+    }
+    this.moveTo(_hostedFlowState.HostedFlowStates.abandoned(this.reference, this.currentState.attempt));
+  }
+  dispose() {
+    this.stopWatchingForReadiness();
+    this.listeners.clear();
+  }
+  watchForReadiness() {
+    this.stopWatchingForReadiness();
+    this.readyTimer = setTimeout(() => {
+      this.readyTimer = undefined;
+      if (this.currentState.phase !== 'loading') return;
+      log.severe('the payment page never became interactive — treating it as unreachable');
+      this.moveTo(_hostedFlowState.HostedFlowStates.unreachable(this.reference, this.currentState.attempt));
+    }, this.readyTimeoutMs);
+  }
+  stopWatchingForReadiness() {
+    if (this.readyTimer === undefined) return;
+    clearTimeout(this.readyTimer);
+    this.readyTimer = undefined;
+  }
+
+  /**
+   * Opens the bank and waits for the payer to be sent back.
+   *
+   * The URL is opened exactly once, and never once the flow has resolved. The
+   * page posts on render, so a rebuild can repeat the message; opening a second
+   * browser — or one for a payment the payer has already left — would leave them
+   * authorizing in a window whose return nobody is waiting for.
+   */
+  async openBank(url) {
+    if ((0, _hostedFlowState.isTerminalPhase)(this.currentState.phase)) {
+      log.info('not opening the bank for a payment that already resolved');
+      return;
+    }
+    if (this.currentState.phase === 'redirecting' || this.currentState.phase === 'awaitingCallback') {
+      log.info('bank already opened for this payment — ignoring');
+      return;
+    }
+    this.stopWatchingForReadiness();
+    this.moveTo(_hostedFlowState.HostedFlowStates.redirecting(this.reference, this.currentState.attempt));
+    try {
+      await this.bankLauncher(url);
+      this.moveTo(_hostedFlowState.HostedFlowStates.awaitingCallback(this.reference, this.currentState.attempt));
+    } catch {
+      // The platform's message is not logged: a native launcher's error can carry
+      // the whole authorize URL back, `request_uri` and state included.
+      log.severe('could not open the bank');
+      this.moveTo(_hostedFlowState.HostedFlowStates.failed({
+        reference: this.reference,
+        errorCode: 'redirect_failed',
+        attempt: this.currentState.attempt
+      }));
+    }
+  }
+  moveTo(next) {
+    if ((0, _hostedFlowState.isTerminalPhase)(this.currentState.phase)) {
+      log.info('ignoring transition after the flow already resolved');
+      return;
+    }
+    this.currentState = next;
+    for (const listener of this.listeners) {
+      try {
+        listener();
+      } catch {
+        /* a listener that throws must not stop the others from hearing */
+      }
+    }
+  }
+}
+exports.HostedFlowController = HostedFlowController;
+//# sourceMappingURL=hosted-flow-controller.js.map

package/lib/commonjs/core/services/hosted-flow-controller.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_bankRedirect","require","_bridgeMessage","_logger","_paymentReturnParams","_hostedFlowState","log","createLogger","DEFAULT_READY_TIMEOUT_MS","exports","HostedFlowController","listeners","Set","constructor","options","reference","bankLauncher","url","defaultLaunchBankRedirect","authorizationUrl","readyTimeoutMs","currentState","HostedFlowStates","loading","reportPageMounted","phase","watchForReadiness","state","subscribe","listener","add","delete","handleBridgeMessage","raw","message","parseHostedBridgeMessage","info","isPagePresented","type","stopWatchingForReadiness","moveTo","hosted","attempt","openBank","cancelled","failed","errorCode","code","handleReturn","uri","outcome","report","readPaymentReturn","undefined","warning","succeeded","abandoned","failToLoad","severe","unreachable","retry","giveUp","abandon","dispose","clear","readyTimer","setTimeout","clearTimeout","isTerminalPhase","redirecting","awaitingCallback","next"],"sourceRoot":"../../../../src","sources":["core/services/hosted-flow-controller.ts"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,OAAA;AACA,IAAAC,cAAA,GAAAD,OAAA;AAIA,IAAAE,OAAA,GAAAF,OAAA;AACA,IAAAG,oBAAA,GAAAH,OAAA;AACA,IAAAI,gBAAA,GAAAJ,OAAA;AAEA,MAAMK,GAAG,GAAG,IAAAC,oBAAY,EAAC,sBAAsB,CAAC;;AAEhD;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMC,wBAAwB,GAAAC,OAAA,CAAAD,wBAAA,GAAG,MAAM;AAS9C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAME,oBAAoB,CAAC;EAIfC,SAAS,GAAG,IAAIC,GAAG,CAAa,CAAC;EAKlDC,WAAWA,CAACC,OAAoC,EAAE;IAChD,IAAI,CAACC,SAAS,GAAGD,OAAO,CAACC,SAAS;IAClC,IAAI,CAACC,YAAY,GACfF,OAAO,CAACE,YAAY,KAAMC,GAAG,IAAK,IAAAC,gCAAyB,EAAC;MAAEC,gBAAgB,EAAEF;IAAI,CAAC,CAAC,CAAC;IACzF,IAAI,CAACG,cAAc,GAAGN,OAAO,CAACM,cAAc,IAAIZ,wBAAwB;IACxE,IAAI,CAACa,YAAY,GAAGC,iCAAgB,CAACC,OAAO,CAACT,OAAO,CAACC,SAAS,CAAC;EACjE;;EAEA;AACF;AACA;AACA;AACA;AACA;EACES,iBAAiBA,CAAA,EAAS;IACxB,IAAI,IAAI,CAACH,YAAY,CAACI,KAAK,KAAK,SAAS,EAAE;IAC3C,IAAI,CAACC,iBAAiB,CAAC,CAAC;EAC1B;EAEA,IAAIC,KAAKA,CAAA,EAAoB;IAC3B,OAAO,IAAI,CAACN,YAAY;EAC1B;;EAEA;EACAO,SAASA,CAACC,QAAoB,EAAc;IAC1C,IAAI,CAAClB,SAAS,CAACmB,GAAG,CAACD,QAAQ,CAAC;IAC5B,OAAO,MAAM;MACX,IAAI,CAAClB,SAAS,CAACoB,MAAM,CAACF,QAAQ,CAAC;IACjC,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACE,MAAMG,mBAAmBA,CAACC,GAAY,EAAoB;IACxD,MAAMC,OAAmC,GAAG,IAAAC,uCAAwB,EAACF,GAAG,CAAC;IACzE,IAAI,CAACC,OAAO,EAAE;MACZ5B,GAAG,CAAC8B,IAAI,CAAC,sDAAsD,CAAC;MAChE,OAAO,KAAK;IACd;;IAEA;IACA;IACA;IACA;IACA;IACA,IAAI,CAAC,IAAI,CAACC,eAAe,CAAC,CAAC,EAAE;MAC3B/B,GAAG,CAAC8B,IAAI,CAAC,eAAeF,OAAO,CAACI,IAAI,2CAA2C,CAAC;MAChF,OAAO,KAAK;IACd;IAEA,QAAQJ,OAAO,CAACI,IAAI;MAClB,KAAK,OAAO;QACV,IAAI,CAACC,wBAAwB,CAAC,CAAC;QAC/B,IAAI,CAACC,MAAM,CAAClB,iCAAgB,CAACmB,MAAM,CAAC,IAAI,CAAC1B,SAAS,EAAE,IAAI,CAACM,YAAY,CAACqB,OAAO,CAAC,CAAC;QAC/E;MACF,KAAK,SAAS;QACZ,MAAM,IAAI,CAACC,QAAQ,CAACT,OAAO,CAACjB,GAAG,CAAC;QAChC;MACF,KAAK,QAAQ;QACX;QACA,IAAI,CAACsB,wBAAwB,CAAC,CAAC;QAC/B,IAAI,CAACC,MAAM,CAAClB,iCAAgB,CAACsB,SAAS,CAAC,IAAI,CAAC7B,SAAS,EAAE,IAAI,CAACM,YAAY,CAACqB,OAAO,CAAC,CAAC;QAClF;MACF,KAAK,OAAO;QACV,IAAI,CAACH,wBAAwB,CAAC,CAAC;QAC/B,IAAI,CAACC,MAAM,CACTlB,iCAAgB,CAACuB,MAAM,CAAC;UACtB9B,SAAS,EAAE,IAAI,CAACA,SAAS;UACzB+B,SAAS,EAAEZ,OAAO,CAACa,IAAI;UACvBL,OAAO,EAAE,IAAI,CAACrB,YAAY,CAACqB;QAC7B,CAAC,CACH,CAAC;QACD;IACJ;IACA,OAAO,IAAI;EACb;;EAEA;AACF;AACA;AACA;AACA;AACA;EACE;EACQL,eAAeA,CAAA,EAAY;IACjC,MAAMZ,KAAK,GAAG,IAAI,CAACJ,YAAY,CAACI,KAAK;IACrC,OAAOA,KAAK,KAAK,SAAS,IAAIA,KAAK,KAAK,QAAQ;EAClD;EAEAuB,YAAYA,CAACC,GAAiB,EAAQ;IACpC,MAAM;MAAEC,OAAO;MAAEC;IAAO,CAAC,GAAG,IAAAC,sCAAiB,EAACH,GAAG,CAAC;;IAElD;IACA;IACA;IACA;IACA,IAAIE,MAAM,CAACpC,SAAS,KAAKsC,SAAS,IAAIF,MAAM,CAACpC,SAAS,KAAK,IAAI,CAACA,SAAS,EAAE;MACzET,GAAG,CAACgD,OAAO,CAAC,kDAAkD,CAAC;MAC/D;IACF;IAEA,IAAI,CAACf,wBAAwB,CAAC,CAAC;IAE/B,IAAIW,OAAO,KAAK,WAAW,EAAE;MAC3B,IAAI,CAACV,MAAM,CACTlB,iCAAgB,CAACiC,SAAS,CAAC;QACzBxC,SAAS,EAAE,IAAI,CAACA,SAAS;QACzB2B,OAAO,EAAE,IAAI,CAACrB,YAAY,CAACqB,OAAO;QAClCS;MACF,CAAC,CACH,CAAC;MACD;IACF;;IAEA;IACA;IACA;IACA,IAAID,OAAO,KAAK,SAAS,EAAE;MACzB5C,GAAG,CAAC8B,IAAI,CAAC,mEAAmE,CAAC;MAC7E,IAAI,CAACI,MAAM,CAAClB,iCAAgB,CAACkC,SAAS,CAAC,IAAI,CAACzC,SAAS,EAAE,IAAI,CAACM,YAAY,CAACqB,OAAO,CAAC,CAAC;MAClF;IACF;IAEA,IAAI,CAACF,MAAM,CACTlB,iCAAgB,CAACuB,MAAM,CAAC;MACtB9B,SAAS,EAAE,IAAI,CAACA,SAAS;MACzB+B,SAAS,EAAEK,MAAM,CAACL,SAAS,IAAI,kBAAkB;MACjDJ,OAAO,EAAE,IAAI,CAACrB,YAAY,CAACqB,OAAO;MAClCS;IACF,CAAC,CACH,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEM,UAAUA,CAAA,EAAS;IACjB,MAAMhC,KAAK,GAAG,IAAI,CAACJ,YAAY,CAACI,KAAK;IACrC,IAAIA,KAAK,KAAK,SAAS,IAAIA,KAAK,KAAK,QAAQ,EAAE;MAC7CnB,GAAG,CAAC8B,IAAI,CAAC,oDAAoD,CAAC;MAC9D;IACF;IACA,IAAI,CAACG,wBAAwB,CAAC,CAAC;IAE/B,IAAId,KAAK,KAAK,QAAQ,EAAE;MACtBnB,GAAG,CAACoD,MAAM,CAAC,sEAAsE,CAAC;MAClF,IAAI,CAAClB,MAAM,CACTlB,iCAAgB,CAACuB,MAAM,CAAC;QACtB9B,SAAS,EAAE,IAAI,CAACA,SAAS;QACzB;QACA;QACA;QACA;QACA+B,SAAS,EAAE,WAAW;QACtBJ,OAAO,EAAE,IAAI,CAACrB,YAAY,CAACqB;MAC7B,CAAC,CACH,CAAC;MACD;IACF;IAEA,IAAI,CAACF,MAAM,CAAClB,iCAAgB,CAACqC,WAAW,CAAC,IAAI,CAAC5C,SAAS,EAAE,IAAI,CAACM,YAAY,CAACqB,OAAO,CAAC,CAAC;EACtF;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEkB,KAAKA,CAAA,EAAS;IACZ,IAAI,IAAI,CAACvC,YAAY,CAACI,KAAK,KAAK,aAAa,EAAE;MAC7CnB,GAAG,CAAC8B,IAAI,CAAC,gEAAgE,CAAC;MAC1E;IACF;IACA,MAAMM,OAAO,GAAG,IAAI,CAACrB,YAAY,CAACqB,OAAO,GAAG,CAAC;IAC7CpC,GAAG,CAAC8B,IAAI,CAAC,8CAA8CM,OAAO,GAAG,CAAC;IAClE;IACA,IAAI,CAACF,MAAM,CAAClB,iCAAgB,CAACC,OAAO,CAAC,IAAI,CAACR,SAAS,EAAE2B,OAAO,CAAC,CAAC;EAChE;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEmB,MAAMA,CAAA,EAAS;IACb,IAAI,IAAI,CAACxC,YAAY,CAACI,KAAK,KAAK,aAAa,EAAE;MAC7CnB,GAAG,CAAC8B,IAAI,CAAC,kEAAkE,CAAC;MAC5E;IACF;IACA,IAAI,CAACG,wBAAwB,CAAC,CAAC;IAC/B,IAAI,CAACC,MAAM,CACTlB,iCAAgB,CAACuB,MAAM,CAAC;MACtB9B,SAAS,EAAE,IAAI,CAACA,SAAS;MACzB+B,SAAS,EAAE,kBAAkB;MAC7BJ,OAAO,EAAE,IAAI,CAACrB,YAAY,CAACqB;IAC7B,CAAC,CACH,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEoB,OAAOA,CAAA,EAAS;IACd,IAAI,CAACvB,wBAAwB,CAAC,CAAC;IAE/B,IAAI,IAAI,CAAClB,YAAY,CAACI,KAAK,KAAK,aAAa,EAAE;MAC7C;MACA;MACA,IAAI,CAACe,MAAM,CACTlB,iCAAgB,CAACuB,MAAM,CAAC;QACtB9B,SAAS,EAAE,IAAI,CAACA,SAAS;QACzB+B,SAAS,EAAE,kBAAkB;QAC7BJ,OAAO,EAAE,IAAI,CAACrB,YAAY,CAACqB;MAC7B,CAAC,CACH,CAAC;MACD;IACF;IAEA,IAAI,CAACF,MAAM,CAAClB,iCAAgB,CAACkC,SAAS,CAAC,IAAI,CAACzC,SAAS,EAAE,IAAI,CAACM,YAAY,CAACqB,OAAO,CAAC,CAAC;EACpF;EAEAqB,OAAOA,CAAA,EAAS;IACd,IAAI,CAACxB,wBAAwB,CAAC,CAAC;IAC/B,IAAI,CAAC5B,SAAS,CAACqD,KAAK,CAAC,CAAC;EACxB;EAEQtC,iBAAiBA,CAAA,EAAS;IAChC,IAAI,CAACa,wBAAwB,CAAC,CAAC;IAC/B,IAAI,CAAC0B,UAAU,GAAGC,UAAU,CAAC,MAAM;MACjC,IAAI,CAACD,UAAU,GAAGZ,SAAS;MAC3B,IAAI,IAAI,CAAChC,YAAY,CAACI,KAAK,KAAK,SAAS,EAAE;MAC3CnB,GAAG,CAACoD,MAAM,CAAC,wEAAwE,CAAC;MACpF,IAAI,CAAClB,MAAM,CAAClB,iCAAgB,CAACqC,WAAW,CAAC,IAAI,CAAC5C,SAAS,EAAE,IAAI,CAACM,YAAY,CAACqB,OAAO,CAAC,CAAC;IACtF,CAAC,EAAE,IAAI,CAACtB,cAAc,CAAC;EACzB;EAEQmB,wBAAwBA,CAAA,EAAS;IACvC,IAAI,IAAI,CAAC0B,UAAU,KAAKZ,SAAS,EAAE;IACnCc,YAAY,CAAC,IAAI,CAACF,UAAU,CAAC;IAC7B,IAAI,CAACA,UAAU,GAAGZ,SAAS;EAC7B;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAcV,QAAQA,CAAC1B,GAAW,EAAiB;IACjD,IAAI,IAAAmD,gCAAe,EAAC,IAAI,CAAC/C,YAAY,CAACI,KAAK,CAAC,EAAE;MAC5CnB,GAAG,CAAC8B,IAAI,CAAC,0DAA0D,CAAC;MACpE;IACF;IACA,IACE,IAAI,CAACf,YAAY,CAACI,KAAK,KAAK,aAAa,IACzC,IAAI,CAACJ,YAAY,CAACI,KAAK,KAAK,kBAAkB,EAC9C;MACAnB,GAAG,CAAC8B,IAAI,CAAC,iDAAiD,CAAC;MAC3D;IACF;IAEA,IAAI,CAACG,wBAAwB,CAAC,CAAC;IAC/B,IAAI,CAACC,MAAM,CAAClB,iCAAgB,CAAC+C,WAAW,CAAC,IAAI,CAACtD,SAAS,EAAE,IAAI,CAACM,YAAY,CAACqB,OAAO,CAAC,CAAC;IAEpF,IAAI;MACF,MAAM,IAAI,CAAC1B,YAAY,CAACC,GAAG,CAAC;MAC5B,IAAI,CAACuB,MAAM,CAAClB,iCAAgB,CAACgD,gBAAgB,CAAC,IAAI,CAACvD,SAAS,EAAE,IAAI,CAACM,YAAY,CAACqB,OAAO,CAAC,CAAC;IAC3F,CAAC,CAAC,MAAM;MACN;MACA;MACApC,GAAG,CAACoD,MAAM,CAAC,yBAAyB,CAAC;MACrC,IAAI,CAAClB,MAAM,CACTlB,iCAAgB,CAACuB,MAAM,CAAC;QACtB9B,SAAS,EAAE,IAAI,CAACA,SAAS;QACzB+B,SAAS,EAAE,iBAAiB;QAC5BJ,OAAO,EAAE,IAAI,CAACrB,YAAY,CAACqB;MAC7B,CAAC,CACH,CAAC;IACH;EACF;EAEQF,MAAMA,CAAC+B,IAAqB,EAAQ;IAC1C,IAAI,IAAAH,gCAAe,EAAC,IAAI,CAAC/C,YAAY,CAACI,KAAK,CAAC,EAAE;MAC5CnB,GAAG,CAAC8B,IAAI,CAAC,qDAAqD,CAAC;MAC/D;IACF;IACA,IAAI,CAACf,YAAY,GAAGkD,IAAI;IACxB,KAAK,MAAM1C,QAAQ,IAAI,IAAI,CAAClB,SAAS,EAAE;MACrC,IAAI;QACFkB,QAAQ,CAAC,CAAC;MACZ,CAAC,CAAC,MAAM;QACN;MAAA;IAEJ;EACF;AACF;AAACpB,OAAA,CAAAC,oBAAA,GAAAA,oBAAA","ignoreList":[]}

package/lib/commonjs/core/services/hosted-flow-state.js

@@ -0,0 +1,96 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.HostedFlowStates = void 0;
+exports.isTerminalPhase = isTerminalPhase;
+/**
+ * Where a hosted payment has got to.
+ *
+ * The phases the payer spends most of their time in — choosing a bank, reading
+ * the consent, confirming the payee — are all `hosted`: they happen inside the
+ * page, which does not report them, and the SDK has nothing to decide there.
+ */
+
+/** Immutable snapshot of a hosted payment. */
+
+const TERMINAL_PHASES = new Set(['succeeded', 'failed', 'cancelled', 'abandoned']);
+function isTerminalPhase(phase) {
+  return TERMINAL_PHASES.has(phase);
+}
+
+/** Factories for each phase, so no caller assembles a state by hand. */
+const HostedFlowStates = exports.HostedFlowStates = {
+  loading(reference, attempt = 1) {
+    return {
+      phase: 'loading',
+      reference,
+      attempt
+    };
+  },
+  hosted(reference, attempt = 1) {
+    return {
+      phase: 'hosted',
+      reference,
+      attempt
+    };
+  },
+  unreachable(reference, attempt = 1) {
+    return {
+      phase: 'unreachable',
+      reference,
+      attempt
+    };
+  },
+  redirecting(reference, attempt = 1) {
+    return {
+      phase: 'redirecting',
+      reference,
+      attempt
+    };
+  },
+  awaitingCallback(reference, attempt = 1) {
+    return {
+      phase: 'awaitingCallback',
+      reference,
+      attempt
+    };
+  },
+  succeeded(args) {
+    return {
+      phase: 'succeeded',
+      reference: args.reference,
+      attempt: args.attempt ?? 1,
+      ...(args.report ? {
+        report: args.report
+      } : {})
+    };
+  },
+  failed(args) {
+    return {
+      phase: 'failed',
+      reference: args.reference,
+      errorCode: args.errorCode,
+      attempt: args.attempt ?? 1,
+      ...(args.report ? {
+        report: args.report
+      } : {})
+    };
+  },
+  cancelled(reference, attempt = 1) {
+    return {
+      phase: 'cancelled',
+      reference,
+      attempt
+    };
+  },
+  abandoned(reference, attempt = 1) {
+    return {
+      phase: 'abandoned',
+      reference,
+      attempt
+    };
+  }
+};
+//# sourceMappingURL=hosted-flow-state.js.map

package/lib/commonjs/core/services/hosted-flow-state.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["TERMINAL_PHASES","Set","isTerminalPhase","phase","has","HostedFlowStates","exports","loading","reference","attempt","hosted","unreachable","redirecting","awaitingCallback","succeeded","args","report","failed","errorCode","cancelled","abandoned"],"sourceRoot":"../../../../src","sources":["core/services/hosted-flow-state.ts"],"mappings":";;;;;;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;;AAwBA;;AA8BA,MAAMA,eAA6C,GAAG,IAAIC,GAAG,CAAkB,CAC7E,WAAW,EACX,QAAQ,EACR,WAAW,EACX,WAAW,CACZ,CAAC;AAEK,SAASC,eAAeA,CAACC,KAAsB,EAAW;EAC/D,OAAOH,eAAe,CAACI,GAAG,CAACD,KAAK,CAAC;AACnC;;AAEA;AACO,MAAME,gBAAgB,GAAAC,OAAA,CAAAD,gBAAA,GAAG;EAC9BE,OAAOA,CAACC,SAAiB,EAAEC,OAAO,GAAG,CAAC,EAAmB;IACvD,OAAO;MAAEN,KAAK,EAAE,SAAS;MAAEK,SAAS;MAAEC;IAAQ,CAAC;EACjD,CAAC;EACDC,MAAMA,CAACF,SAAiB,EAAEC,OAAO,GAAG,CAAC,EAAmB;IACtD,OAAO;MAAEN,KAAK,EAAE,QAAQ;MAAEK,SAAS;MAAEC;IAAQ,CAAC;EAChD,CAAC;EACDE,WAAWA,CAACH,SAAiB,EAAEC,OAAO,GAAG,CAAC,EAAmB;IAC3D,OAAO;MAAEN,KAAK,EAAE,aAAa;MAAEK,SAAS;MAAEC;IAAQ,CAAC;EACrD,CAAC;EACDG,WAAWA,CAACJ,SAAiB,EAAEC,OAAO,GAAG,CAAC,EAAmB;IAC3D,OAAO;MAAEN,KAAK,EAAE,aAAa;MAAEK,SAAS;MAAEC;IAAQ,CAAC;EACrD,CAAC;EACDI,gBAAgBA,CAACL,SAAiB,EAAEC,OAAO,GAAG,CAAC,EAAmB;IAChE,OAAO;MAAEN,KAAK,EAAE,kBAAkB;MAAEK,SAAS;MAAEC;IAAQ,CAAC;EAC1D,CAAC;EACDK,SAASA,CAACC,IAIT,EAAmB;IAClB,OAAO;MACLZ,KAAK,EAAE,WAAW;MAClBK,SAAS,EAAEO,IAAI,CAACP,SAAS;MACzBC,OAAO,EAAEM,IAAI,CAACN,OAAO,IAAI,CAAC;MAC1B,IAAIM,IAAI,CAACC,MAAM,GAAG;QAAEA,MAAM,EAAED,IAAI,CAACC;MAAO,CAAC,GAAG,CAAC,CAAC;IAChD,CAAC;EACH,CAAC;EACDC,MAAMA,CAACF,IAKN,EAAmB;IAClB,OAAO;MACLZ,KAAK,EAAE,QAAQ;MACfK,SAAS,EAAEO,IAAI,CAACP,SAAS;MACzBU,SAAS,EAAEH,IAAI,CAACG,SAAS;MACzBT,OAAO,EAAEM,IAAI,CAACN,OAAO,IAAI,CAAC;MAC1B,IAAIM,IAAI,CAACC,MAAM,GAAG;QAAEA,MAAM,EAAED,IAAI,CAACC;MAAO,CAAC,GAAG,CAAC,CAAC;IAChD,CAAC;EACH,CAAC;EACDG,SAASA,CAACX,SAAiB,EAAEC,OAAO,GAAG,CAAC,EAAmB;IACzD,OAAO;MAAEN,KAAK,EAAE,WAAW;MAAEK,SAAS;MAAEC;IAAQ,CAAC;EACnD,CAAC;EACDW,SAASA,CAACZ,SAAiB,EAAEC,OAAO,GAAG,CAAC,EAAmB;IACzD,OAAO;MAAEN,KAAK,EAAE,WAAW;MAAEK,SAAS;MAAEC;IAAQ,CAAC;EACnD;AACF,CAAU","ignoreList":[]}