Update FuturePay interactions with config options

samples/vuejs/pages/index.vue

@@ -16,7 +16,11 @@ const initiateRegularAgreement = () => {
         option: RegularAgreementOption.Default,
         cartId: 'MerchantReference',
         testMode: 100
-    } as RegularAgreement);
+    } as RegularAgreement, {
+        openInNewTab: true,
+        callbackUrl: null,
+        additionalProperties: null
+    });
 };
 
 const cancelAgreement = () => {

src/FuturePayAgreementConfig.ts

@@ -0,0 +1,21 @@
+import { AgreementMap } from "./AgreementMap";
+
+/**
+ * Defines the configuration options used when interacting with FuturePay.
+ */
+export default interface FuturePayAgreementConfig {
+    /**
+     * The optional callback URL to be used by FuturePay to notify of the interaction status.
+     */
+    callbackUrl: string | null;
+
+    /**
+     * The optional additional properties to be used to construct the form inputs used when interacting with FuturePay.
+     */
+    additionalProperties: AgreementMap | null;
+
+    /**
+     * The optional flag to indicate whether the FuturePay interaction should be initiated in a new tab.
+     */
+    openInNewTab: boolean;
+}

src/FuturePayService.ts

@@ -1,6 +1,7 @@
 import { Agreement } from "./Agreement";
 import { AgreementMap } from "./AgreementMap";
 import { CancelAgreement } from "./CancelAgreement";
+import FuturePayAgreementConfig from "./FuturePayAgreementConfig";
 
 /**
  * Defines a class used to initiate recurring payments in FuturePay.
@@ -21,11 +22,14 @@ export class FuturePayService {
     /**
      * Initiates a payment in FuturePay.
      * @param agreement The agreement object to construct the form inputs used to initiate the payment in FuturePay.
-     * @param callbackUrl The optional callback URL to be used by FuturePay to notify the payment status.
-     * @param additionalProperties The optional additional properties to be used to construct the form inputs used to initiate the payment in FuturePay.
+     * @param options The configuration options for constructing the agreement cancellation interaction.
      * @returns A promise that resolves to the HTML form inputs used to initiate the payment in FuturePay.
      */
-    initiateAgreement(agreement: Agreement, callbackUrl: string | null = null, additionalProperties: AgreementMap | null = null): Promise<string> {
+    initiateAgreement(agreement: Agreement, options: FuturePayAgreementConfig = {
+        callbackUrl: null,
+        additionalProperties: null,
+        openInNewTab: false
+    }): Promise<string> {
         var formInputsHtml = "";
 
         for (var key in agreement) {
@@ -34,13 +38,14 @@ export class FuturePayService {
             }
         }
 
-        formInputsHtml += this.generateAdditionalPropertiesInputs(additionalProperties);
-        formInputsHtml += this.generateCallbackUrlInput(callbackUrl);
+        formInputsHtml += this.generateAdditionalPropertiesInputs(options.additionalProperties);
+        formInputsHtml += this.generateCallbackUrlInput(options.callbackUrl);
 
         if (document) {
             var form = document.createElement("form");
             form.setAttribute("method", "post");
             form.setAttribute("action", this.purchaseUrl);
+            form.setAttribute("target", options.openInNewTab ? "_blank" : "_self");
             form.innerHTML = formInputsHtml;
             document.body.appendChild(form);
 
@@ -57,11 +62,14 @@ export class FuturePayService {
     /**
      * Cancels an agreement in FuturePay.
      * @param cancelAgreement The cancel agreement object to construct the form inputs used to cancel the agreement in FuturePay.
-     * @param callbackUrl The optional callback URL to be used by FuturePay to notify the payment status.
-     * @param additionalProperties The optional additional properties to be used to construct the form inputs used to cancel the agreement in FuturePay.
+     * @param options The configuration options for constructing the agreement cancellation interaction.
      * @returns A promise that resolves to the HTML form inputs used to cancel the agreement in FuturePay.
      */
-    cancelAgreement(cancelAgreement: CancelAgreement, callbackUrl: string | null = null, additionalProperties: AgreementMap | null = null): Promise<string> {
+    cancelAgreement(cancelAgreement: CancelAgreement, options: FuturePayAgreementConfig = {
+        callbackUrl: null,
+        additionalProperties: null,
+        openInNewTab: false
+    }): Promise<string> {
         var formInputsHtml = "";
 
         for (var key in cancelAgreement) {
@@ -72,13 +80,14 @@ export class FuturePayService {
 
         formInputsHtml += `<input type='hidden' name='op-cancelFP'></input>`
 
-        formInputsHtml += this.generateAdditionalPropertiesInputs(additionalProperties);
-        formInputsHtml += this.generateCallbackUrlInput(callbackUrl);
+        formInputsHtml += this.generateAdditionalPropertiesInputs(options.additionalProperties);
+        formInputsHtml += this.generateCallbackUrlInput(options.callbackUrl);
 
         if (document) {
             var form = document.createElement("form");
             form.setAttribute("method", "post");
             form.setAttribute("action", this.adminUrl);
+            form.setAttribute("target", options.openInNewTab ? "_blank" : "_self");
             form.innerHTML = formInputsHtml;
             document.body.appendChild(form);
 

src/index.ts

@@ -3,6 +3,7 @@ export * from './AgreementMap';
 export * from './CancelAgreement';
 export * from './CurrencyCode';
 export * from './DelayUnit';
+export * from './FuturePayAgreementConfig';
 export * from './FuturePayService';
 export * from './FuturePayType';
 export * from './LimitedAgreement';