@esolve/ng-esolve-connect 0.16.2 → 0.17.0

package/fesm2020/esolve-ng-esolve-connect.mjs

@@ -1519,10 +1519,14 @@ class EsolveAuthService {
             return this.errorHandler.handleHttpPostError('set-login', errorRes);
         }));
     }
-    logout() {
+    async logout() {
         this.session.clearTimer();
         this.cookieService.delete('_ws_id');
-        return this.getAccessToken('', '', true).toPromise();
+        const response = await this.getAccessToken('', '', true).toPromise();
+        if (response) {
+            return response;
+        }
+        throw new Error('Invalid response');
     }
     checkAccessToken(session) {
         session = session || this.session.currentSession;
@@ -1531,7 +1535,7 @@ class EsolveAuthService {
             .get(`${this.config.api_url}/get-access-token.php`, {
             params: { key: token },
             headers: new HttpHeaders({
-                'Accept-Language': '*'
+                'Accept-Language': '*',
             }),
         })
             .pipe(map((responseData) => {
@@ -1549,14 +1553,15 @@ class EsolveAuthService {
                 user_id: additional_data.user_id,
             };
             return result;
-        }))
-            .toPromise();
+        }));
     }
     // Handlers
     handleExpiration() {
         return (session) => {
-            this.checkAccessToken(session).then((response) => {
-                this.handleAuthentication(response);
+            this.checkAccessToken(session).toPromise().then((response) => {
+                if (response) {
+                    this.handleAuthentication(response);
+                }
             }, () => {
                 this.logout();
             });
@@ -1576,7 +1581,7 @@ class EsolveAuthService {
         if ((!errorRes.type) ||
             (!errorRes.service_type) ||
             (!errorRes.message)) {
-            return throwError(error);
+            return throwError(() => error);
         }
         if (errorRes.message.trim() !== '') {
             error.message = errorRes.message;
@@ -1584,7 +1589,7 @@ class EsolveAuthService {
         if (errorRes.additional_data) {
             error.data = errorRes.additional_data;
         }
-        return throwError(error);
+        return throwError(() => error);
     }
 }
 EsolveAuthService.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "13.1.1", ngImport: i0, type: EsolveAuthService, deps: [{ token: ESOLVE_CONNECT_CONFIG }, { token: i1$2.HttpClient }, { token: EsolveSessionService }, { token: EsolveErrorHandlerService }, { token: EsolveCookieService }], target: i0.ɵɵFactoryTarget.Injectable });
@@ -3989,6 +3994,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.1.1", ngImpor
                     args: [ESOLVE_CONNECT_CONFIG]
                 }] }, { type: i1$2.HttpClient }, { type: EsolveErrorHandlerService }, { type: EsolveResponseHandlerService }]; } });
 
+// Only export the types that are accessible to the public API
+
 class EsolveBankingDetails {
     constructor(bank_name, account_holder, account, account_type, swift_number, branch_code) {
         this.bank_name = bank_name;
@@ -4000,6 +4007,77 @@ class EsolveBankingDetails {
     }
 }
 
+class EsolvePaymentMethod {
+    constructor(record) {
+        this.id = +record.id;
+        this.location_id = +record.location_id;
+        this.paymethod_name = record.paymethod_name;
+        this.description = record.description;
+        this.display_banking_details = record.display_banking_details;
+        this.currency_code = record.currency_code;
+        this.merchant_id = record.merchant_id;
+        this.application_id = record.application_id;
+        this.api_signature = record.api_signature;
+        this.is_gateway = record.is_gateway;
+        this.must_store_card_details = record.must_store_card_details;
+        this.allow_budget = record.allow_budget;
+        this.integration_type = record.integration_type;
+        this.bank_gateway_id = record.bank_gateway_id;
+        this.accepted_card_types = record.accepted_card_types;
+        this.post_transactions_to_gateway = record.post_transactions_to_gateway;
+        this.three_d_secure_url = record.three_d_secure_url;
+        this.gateway_url = record.gateway_url;
+        this.generate_token_url = record.generate_token_url;
+        this.widget_url = record.widget_url;
+        this.successful_url = record.successful_url;
+        this.failed_url = record.failed_url;
+        this.enable_callback = record.enable_callback;
+        this.live = record.live;
+        this.default_module_id = +record.default_module_id;
+        this.service_provider = record.service_provider;
+        this.on_account = record.on_account;
+        this.sort_priority = +record.sort_priority;
+        this.image_url = record.image_url;
+        this.banking_details = new EsolveBankingDetails(record.bank_name, record.account_holder, record.account, record.account_type, record.swift_number, record.branch_code);
+    }
+}
+
+class EsolvePaymentResult extends EsolveResponseResult {
+    constructor(response) {
+        super(response);
+        this.redirect_required = false;
+        if (typeof response.service_provider !== 'undefined') {
+            this.service_provider = response.service_provider;
+        }
+        if (typeof response.redirect_required !== 'undefined') {
+            this.redirect_required = response.redirect_required;
+        }
+        this.gateway_error_message = response.gateway_error_message ?? '';
+        // Check if redirect settings need to be set
+        if (this.redirect_required && this.service_provider) {
+            if (typeof response.redirect_url !== 'undefined') {
+                this.redirect_url = response.redirect_url;
+            }
+            // Check integration specific settings
+            if (this.service_provider === 'snapscan') {
+                // QR code scan is required
+                if (typeof response.qr_code_url !== 'undefined') {
+                    this.qr_code_url = response.qr_code_url;
+                }
+            }
+            else {
+                // Normal form posting redirect
+                if (typeof response.form_inputs !== 'undefined') {
+                    this.form_inputs = response.form_inputs;
+                }
+                if (typeof response.form_enctype !== 'undefined') {
+                    this.form_enctype = response.form_enctype;
+                }
+            }
+        }
+    }
+}
+
 class EsolveVaultItemResult extends EsolveResponseResult {
     constructor(response) {
         super(response);
@@ -4039,62 +4117,6 @@ class EsolveVaultItem {
     }
 }
 
-class EsolvePaymentResult extends EsolveResponseResult {
-    constructor(response) {
-        super(response);
-        if (typeof response.gateway_error_message !== 'undefined') {
-            this.gateway_error_message = response.gateway_error_message;
-        }
-        if (typeof response.three_d_secure !== 'undefined') {
-            this.three_d_secure = response.three_d_secure;
-        }
-        if (typeof response.redirect_url !== 'undefined') {
-            this.redirect_url = response.redirect_url;
-        }
-        if (typeof response.form_inputs !== 'undefined') {
-            this.form_inputs = response.form_inputs;
-        }
-        if (typeof response.form_html !== 'undefined') {
-            this.form_html = response.form_html;
-        }
-    }
-}
-
-class EsolvePaymentMethod {
-    constructor(record) {
-        this.id = +record.id;
-        this.location_id = +record.location_id;
-        this.paymethod_name = record.paymethod_name;
-        this.description = record.description;
-        this.display_banking_details = record.display_banking_details;
-        this.currency_code = record.currency_code;
-        this.merchant_id = record.merchant_id;
-        this.application_id = record.application_id;
-        this.api_signature = record.api_signature;
-        this.is_gateway = record.is_gateway;
-        this.must_store_card_details = record.must_store_card_details;
-        this.allow_budget = record.allow_budget;
-        this.integration_type = record.integration_type;
-        this.bank_gateway_id = record.bank_gateway_id;
-        this.accepted_card_types = record.accepted_card_types;
-        this.post_transactions_to_gateway = record.post_transactions_to_gateway;
-        this.three_d_secure_url = record.three_d_secure_url;
-        this.gateway_url = record.gateway_url;
-        this.generate_token_url = record.generate_token_url;
-        this.widget_url = record.widget_url;
-        this.successful_url = record.successful_url;
-        this.failed_url = record.failed_url;
-        this.enable_callback = record.enable_callback;
-        this.live = record.live;
-        this.default_module_id = +record.default_module_id;
-        this.service_provider = record.service_provider;
-        this.on_account = record.on_account;
-        this.sort_priority = +record.sort_priority;
-        this.image_url = record.image_url;
-        this.banking_details = new EsolveBankingDetails(record.bank_name, record.account_holder, record.account, record.account_type, record.swift_number, record.branch_code);
-    }
-}
-
 class EsolvePaymentService {
     constructor(config, http, errorHandler, responseHandler) {
         this.config = config;
@@ -4104,7 +4126,9 @@ class EsolvePaymentService {
     }
     /**
      * Retrieves a list of payment methods.
+     *
      * @param options Filter options
+     *
      * @returns An `Observable` with an array of payment methods
      */
     getPaymentMethods(options) {
@@ -4117,9 +4141,28 @@ class EsolvePaymentService {
             return this.processPaymentMethods(response.records);
         }));
     }
+    /**
+     * Retrieve the payment status of the specified transaction
+     *
+     * @param transaction_id ID of the transaction
+     *
+     * @returns An `Observable` with the success status of the payment
+     */
+    getPaymentStatus(transaction_id) {
+        return this.http
+            .get(`${this.config.api_url}/get-payment-status.php`, { params: { cart_id: transaction_id } })
+            .pipe(map((response) => {
+            if (response.records === undefined) {
+                throw response;
+            }
+            return response.records.success;
+        }));
+    }
     /**
      * Retrieves a list of saved cards from the vault.
+     *
      * @param payment_methods_id eSolve ID of a payment method
+     *
      * @returns An `Observable` with an array of saved bank cards
      */
     getVault(payment_methods_id) {
@@ -4138,8 +4181,10 @@ class EsolvePaymentService {
     }
     /**
      * Sets a new card in the vault OR updates an existing one.
+     *
      * @param payment_methods_id Selected payment method
      * @param card_data Information of bank card
+     *
      * @returns An `Observable` with the result of the vault set.
      */
     setVaultItem(payment_methods_id, card_data) {
@@ -4164,6 +4209,13 @@ class EsolvePaymentService {
             return this.errorHandler.handleHttpPostError('set-vault', errorRes);
         }));
     }
+    /**
+     * Delete a card in the vault
+     *
+     * @param id ID of the vault item
+     *
+     * @returns An `Observable` with the result of the vault delete.
+     */
     deleteVaultItem(id) {
         return this.http
             .delete(`${this.config.api_url}/delete-vault.php`, {
@@ -4189,6 +4241,7 @@ class EsolvePaymentService {
      * @param transaction_id eSolve ID to the transaction
      * @param payment_methods_id eSolve ID to the selected payment method
      * @param card ID of selected card from the vault or information to a brand new card
+     *
      * @returns An `Observable` with the result of the payment
      */
     setPayment(transaction_id, payment_methods_id, card) {
@@ -4223,7 +4276,9 @@ class EsolvePaymentService {
     }
     /**
      * Processes the eSolve payment method records.
+     *
      * @param records Records to process
+     *
      * @returns An array of processed payment methods.
      */
     processPaymentMethods(records) {
@@ -4238,7 +4293,9 @@ class EsolvePaymentService {
     }
     /**
      * Processes the eSolve vault records.
+     *
      * @param records Records to process
+     *
      * @returns An array of processed vault items (a.k.a. cards)
      */
     processVaultItems(records) {
@@ -4251,6 +4308,13 @@ class EsolvePaymentService {
         }
         return vault;
     }
+    /**
+     * Generate a concatenated string with the expiry month and year
+     *
+     * @param card_data Credit card data
+     *
+     *  @returns Expiry string
+     */
     generateExpiry(card_data) {
         const month_string = card_data.expiry_month.padStart(2, '0');
         const year_string = card_data.expiry_year.padStart(4, '0');