@esolve/ng-esolve-connect 0.16.0 → 0.17.0

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

@@ -461,6 +461,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.1.1", ngImpor
                 }]
         }], ctorParameters: function () { return []; } });
 
+// Types
+
 /**
  * Search Engine Optimization information.
  */
@@ -1278,6 +1280,7 @@ class EsolveAsset {
         this.sort_priority = 0;
         this.topics = [];
         this.tags = [];
+        this.image_name = '';
         this.id = +record.id;
         this.src = record.src;
         this.name = record.name;
@@ -1289,6 +1292,7 @@ class EsolveAsset {
         this.asset_category = record.asset_category ?? '';
         this.asset_sub_category = record.asset_sub_category ?? '';
         this.sort_priority = +(record.sort_priority ?? '');
+        this.image_name = record.image_name ?? '';
         if (record.created) {
             this.created = record.created;
         }
@@ -1315,6 +1319,23 @@ class EsolveAsset {
             }
         }
     }
+    /**
+     * Shortcut to `getImagePath()`
+     */
+    get image_src() {
+        return this.getImagePath();
+    }
+    /**
+     * Retrieve image path
+     *
+     * @returns Image path on CDN, else empty string if no image exists
+     */
+    getImagePath() {
+        if (this.image_name !== '') {
+            return `/images/documents/${this.image_name}`;
+        }
+        return '';
+    }
 }
 
 class EsolveAssetsService {
@@ -1352,6 +1373,9 @@ class EsolveAssetsService {
     processAsset(record) {
         return new EsolveAsset(record);
     }
+    getAssetRecords(params) {
+        return this.http.get(`${this.config.api_url}/get-assets.php`, { params });
+    }
     parseOptions(options) {
         let params = new HttpParams();
         if (!options) {
@@ -1384,11 +1408,17 @@ class EsolveAssetsService {
         if (options.asset_sub_category) {
             params = params.set('asset_sub_category', options.asset_sub_category);
         }
+        if (options.document_number) {
+            params = params.set('document_number', options.document_number);
+        }
+        if (options.document_type) {
+            params = params.set('document_type', options.document_type);
+        }
+        if (options.area_of_application) {
+            params = params.set('area_of_application', options.area_of_application);
+        }
         return params;
     }
-    getAssetRecords(params) {
-        return this.http.get(`${this.config.api_url}/get-assets.php`, { params });
-    }
 }
 EsolveAssetsService.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "13.1.1", ngImport: i0, type: EsolveAssetsService, deps: [{ token: ESOLVE_CONNECT_CONFIG }, { token: i1$2.HttpClient }], target: i0.ɵɵFactoryTarget.Injectable });
 EsolveAssetsService.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "13.1.1", ngImport: i0, type: EsolveAssetsService, providedIn: 'root' });
@@ -1489,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;
@@ -1501,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) => {
@@ -1519,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();
             });
@@ -1546,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;
@@ -1554,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 });
@@ -2640,6 +2675,7 @@ class EsolveNewsArticle {
             this.article = record.article ?? '';
             this.txdate = record.txdate ?? '';
             this.image = record.image ?? '';
+            this.short_description = record.short_description ?? '';
             if (record.active) {
                 this.active = !!+record.active;
             }
@@ -2794,6 +2830,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.1.1", ngImpor
                     args: [ESOLVE_CONNECT_CONFIG]
                 }] }, { type: i1$2.HttpClient }]; } });
 
+// Types
+
 class EsolveColour {
     constructor(record) {
         this.id = record.id ?? 0;
@@ -2899,6 +2937,26 @@ class EsolveStockItemBase {
          * Featured state
          */
         this.featured = false;
+        /**
+         * Height measured in meters (m)
+         */
+        this.height = 0;
+        /**
+         * Width measured in meters (m)
+         */
+        this.width = 0;
+        /**
+         * Length / depth measured in meters (m)
+         */
+        this.length = 0;
+        /**
+         * Weight measured in kilograms (kg)
+         */
+        this.weight = 0;
+        /**
+         * Units used to measure the quantity
+         */
+        this.unit_of_measure = 'unit';
         /**
          * ID of default category linked to the stock item
          *
@@ -2963,6 +3021,13 @@ class EsolveStockItemBase {
             this.ranges_id = +(record.ranges_id ?? 0);
             this.active = !!+(record.is_active ?? false);
             this.featured = !!+(record.is_featured ?? false);
+            this.height = +(record.height ?? 0);
+            this.width = +(record.width ?? 0);
+            this.length = +(record.length ?? 0);
+            this.weight = +(record.weight ?? 0);
+            if (record.unit_of_measure) {
+                this.unit_of_measure = record.unit_of_measure;
+            }
             base_price = +(record.regular_sellprice ?? 0);
             base_price_with_tax = +(record.regular_sellprice_inclusive ?? 0);
             sell_price = +(record.sellprice ?? 0);
@@ -3208,8 +3273,12 @@ class EsolveStockImageCollection {
 }
 ;
 
+// Classes
+
 ;
 
+// Interfaces
+
 class EsolveStockService {
     constructor(config, http) {
         this.config = config;
@@ -3268,6 +3337,15 @@ class EsolveStockService {
         if (options.rows) {
             params = params.set('rows', options.rows);
         }
+        if (options.sort) {
+            const sort = options.sort;
+            if (sort.field) {
+                params = params.set('sort', sort.field);
+            }
+            if (sort.order) {
+                params = params.set('order', sort.order);
+            }
+        }
         if (options.search_phrase) {
             params = params.set('search_phrase', options.search_phrase);
         }
@@ -3335,9 +3413,27 @@ class EsolveStockService {
      *
      * @param code Stock item code
      */
-    getRecipeItems(code) {
+    getRecipeItems(code, options) {
+        let params = new HttpParams().set('code', code);
+        if (options) {
+            if (options.page) {
+                params = params.set('page', options.page);
+            }
+            if (options.rows) {
+                params = params.set('rows', options.rows);
+            }
+            if (options.sort) {
+                const sort = options.sort;
+                if (sort.field) {
+                    params = params.set('sort', sort.field);
+                }
+                if (sort.order) {
+                    params = params.set('order', sort.order);
+                }
+            }
+        }
         return this.http
-            .get(`${this.config.api_url}/get-recipe-items.php`, { params: { code } })
+            .get(`${this.config.api_url}/get-recipe-items.php`, { params })
             .pipe(map((response) => {
             if ((response.records === undefined) ||
                 (response.records.length <= 0)) {
@@ -3362,6 +3458,15 @@ class EsolveStockService {
                 is_active: options.is_active ?? true,
             },
         });
+        if (options.sort) {
+            const sort = options.sort;
+            if (sort.field) {
+                params = params.set('sort', sort.field);
+            }
+            if (sort.order) {
+                params = params.set('order', sort.order);
+            }
+        }
         if (options.media_identifier) {
             params = params.append('media_identifier', options.media_identifier);
         }
@@ -3465,8 +3570,6 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.1.1", ngImpor
                     args: [ESOLVE_CONNECT_CONFIG]
                 }] }, { type: i1$2.HttpClient }]; } });
 
-// Types
-
 class EsolveSpecialImage {
     constructor(record) {
         this.id = +record.id;
@@ -3891,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;
@@ -3902,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);
@@ -3941,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;
@@ -4006,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) {
@@ -4019,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) {
@@ -4040,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) {
@@ -4066,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`, {
@@ -4091,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) {
@@ -4125,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) {
@@ -4140,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) {
@@ -4153,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');
@@ -4383,3 +4545,4 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.1.1", ngImpor
  */
 
 export { EsolveAccountService, EsolveAdditionalStockImage, EsolveAddress, EsolveAddressResult, EsolveAsset, EsolveAssetsService, EsolveAuthService, EsolveBankingDetails, EsolveBanner, EsolveBannerImage, EsolveBannerImageHotspot, EsolveBannerService, EsolveCartItem, EsolveCartService, EsolveCartStockItem, EsolveCartTotals, EsolveCategoryTreeItem, EsolveCategoryTreeService, EsolveChangePasswordResult, EsolveCheckoutResult, EsolveColour, EsolveCookieService, EsolveEnquiryResult, EsolveEnquiryService, EsolveErrorHandlerService, EsolveGeocodeAddressResult, EsolveGeocodeCoordsResult, EsolveGeocodeResult, EsolveGeocoderService, EsolveHeading, EsolveHttpError, EsolveLinkedAsset, EsolveLinkedStockItem, EsolveList, EsolveLocation, EsolveLocationAddress, EsolveLocationContactInfo, EsolveLocationPOBoxAddress, EsolveLocationTradingDay, EsolveLocationTradingTimes, EsolveLocationsService, EsolveManufacturer, EsolveManufacturersService, EsolveMediaArticle, EsolveMediaService, EsolveMediaStockItem, EsolveMenuItem, EsolveMenuService, EsolveNewsArticle, EsolveNewsArticleAuthor, EsolveNewsArticleList, EsolveNewsGroup, EsolveNewsService, EsolvePaymentMethod, EsolvePaymentResult, EsolvePaymentService, EsolveRange, EsolveRangesService, EsolveRecipeStockItem, EsolveRegistrationResult, EsolveResetPasswordResult, EsolveResponseHandlerService, EsolveResponseResult, EsolveResult, EsolveSeoInfo, EsolveSeoService, EsolveSession, EsolveSessionService, EsolveShippingCost, EsolveShippingMethod, EsolveShippingService, EsolveShippingTotals, EsolveSpecial, EsolveSpecialImage, EsolveSpecialImageCollection, EsolveSpecialsService, EsolveStockBadge, EsolveStockGroup, EsolveStockGroupItem, EsolveStockImage, EsolveStockImageCollection, EsolveStockItem, EsolveStockItemBase, EsolveStockItemList, EsolveStockLeadTimes, EsolveStockPrice, EsolveStockService, EsolveTag, EsolveTagsService, EsolveTopic, EsolveTopicService, EsolveTransaction, EsolveTransactionAddress, EsolveTransactionClient, EsolveTransactionItem, EsolveTransactionItemPrice, EsolveTransactionList, EsolveTransactionLocation, EsolveTransactionPaymentMethod, EsolveTransactionShippingMethod, EsolveTransactionUser, EsolveUserAccount, EsolveUserAccountBusiness, EsolveUserAccountContact, EsolveUserAccountResult, EsolveVaultItem, EsolveVaultItemResult, NgEsolveConnectModule };
+//# sourceMappingURL=esolve-ng-esolve-connect.mjs.map