@esolve/ng-esolve-connect 0.141.0 → 0.142.0

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

@@ -1413,6 +1413,10 @@ class EsolveStockItemBase {
          * Material id
          */
         this.type_of_material_id = 0;
+        /**
+         * Item author
+         */
+        this.author = '';
         /**
          * Image filename
          */
@@ -1443,6 +1447,7 @@ class EsolveStockItemBase {
             this.extended_description = record.extended_description ?? '';
             this.image_name = record.image_name ?? '';
             this.image_last_modified = record.image_last_modified ?? '';
+            this.author = record.author ?? '';
             this.category_id = record.category_id ?? '';
             this.subcategory_id = +(record.subcategory_id ?? 0);
             this.manufacturers_id = +(record.manufacturers_id ?? 0);
@@ -2795,6 +2800,117 @@ class EsolveCartItem {
     }
 }
 
+/**
+ * One item that makes up a promotion, with progress toward qualifying.
+ */
+class EsolveCartPromotionProgressQualifyingItem {
+    constructor(record) {
+        this.type = 'code';
+        /**
+         * The raw identifier: stock `code` (string), `subcategory_id` (int),
+         * `category_id` (string), or `null` for `everything`.
+         */
+        this.value = null;
+        this.required = 0;
+        this.qualifying = 0;
+        this.remaining = 0;
+        /**
+         * `true` when this item's `remaining` is `0` (the cart has enough of it).
+         */
+        this.completed = false;
+        if (!record) {
+            return;
+        }
+        this.type = record.type ?? 'code';
+        this.value = record.value ?? null;
+        this.required = +(record.required ?? 0);
+        this.qualifying = +(record.qualifying ?? 0);
+        this.remaining = +(record.remaining ?? 0);
+        this.completed = record.completed ?? false;
+    }
+}
+
+/**
+ * One active promotion the cart has not yet qualified for, with progress
+ * toward qualifying (returned by `get-cart-promotion-progress`).
+ */
+class EsolveCartPromotionProgressItem {
+    constructor(record) {
+        /**
+         * How the remaining items relate to completing the promotion.
+         */
+        this.mode = 'qty';
+        /**
+         * Engine discount type the record originated from: `1` = code,
+         * `2` = subcategory, `3` = everything, `4` = category, `5` = group/"any-of".
+         */
+        this.type = 0;
+        /**
+         * Linked special ID (`0` if the discount is not tied to a special).
+         */
+        this.specials_id = 0;
+        /**
+         * Discount ID (`0` for group promotions, which are tracked per special).
+         */
+        this.discount_id = 0;
+        /**
+         * Headline quantity required.
+         */
+        this.required = 0;
+        /**
+         * Headline quantity the cart already has toward `required`.
+         */
+        this.qualifying = 0;
+        /**
+         * Headline quantity still needed (`required − qualifying`).
+         */
+        this.remaining = 0;
+        /**
+         * Items that make up the promotion. Authoritative.
+         */
+        this.qualifying_items = [];
+        /**
+         * Configured discount percentage that applies once qualified
+         * (meaningful when `discount_type` is `"percentage"`).
+         */
+        this.discount = 0;
+        /**
+         * Configured fixed discounted price (excluding tax) that applies once
+         * qualified (meaningful when `discount_type` is `"price"`).
+         */
+        this.discounted_price = 0;
+        this.discount_type = 'none';
+        /**
+         * Default, ready-to-show reward text. Contains no currency symbol.
+         */
+        this.offer = '';
+        /**
+         * Default, ready-to-show indicator text (the "what to add" nudge).
+         */
+        this.message = '';
+        if (!record) {
+            return;
+        }
+        this.mode = record.mode ?? 'qty';
+        this.type = +(record.type ?? 0);
+        this.specials_id = +(record.specials_id ?? 0);
+        this.discount_id = +(record.discount_id ?? 0);
+        this.required = +(record.required ?? 0);
+        this.qualifying = +(record.qualifying ?? 0);
+        this.remaining = +(record.remaining ?? 0);
+        this.discount = +(record.discount ?? 0);
+        this.discounted_price = +(record.discounted_price ?? 0);
+        this.discount_type = record.discount_type ?? 'none';
+        this.offer = record.offer ?? '';
+        this.message = record.message ?? '';
+        if (record.qualifying_items) {
+            for (const qualifying_item of record.qualifying_items) {
+                this.qualifying_items.push(new EsolveCartPromotionProgressQualifyingItem(qualifying_item));
+            }
+        }
+    }
+}
+
 class EsolveCartTaxBreakdown {
     constructor() {
         this.goods = 0;
@@ -3919,6 +4035,28 @@ class EsolveCartService {
             return this.processCartAlternatives(response.records);
         }));
     }
+    /**
+     * Retrieves the active promotions the cart has not yet qualified for, with a
+     * ready-to-display indicator message and the structured data behind it.
+     *
+     * The endpoint is read-only — it never applies discounts and never writes to
+     * the cart. Call it whenever the cart changes (the same trigger used for
+     * `getCart` / `getTotals`). A `no_records` soft-error (`records: []`) means
+     * there is nothing to display — not a real failure — and resolves to an
+     * empty array.
+     *
+     * @returns An `Observable` with an array of promotion progress entries
+     */
+    getCartPromotionProgress() {
+        return this.http
+            .get(`${this.config.api_url}/get-cart-promotion-progress.php`)
+            .pipe(map((response) => {
+            if (response.records === undefined) {
+                throw response;
+            }
+            return this.processCartPromotionProgress(response.records);
+        }));
+    }
     /**
      * Set an alternative stock item to current cart item
      *
@@ -3998,6 +4136,21 @@ class EsolveCartService {
     processCartTotals(record) {
         return new EsolveCartTotals(record);
     }
+    /**
+     * Processes the eSolve cart promotion progress records
+     *
+     * @param records Records to process
+     * @returns An array of processed promotion progress entries
+     */
+    processCartPromotionProgress(records) {
+        const progress = [];
+        if (records) {
+            for (const record of records) {
+                progress.push(new EsolveCartPromotionProgressItem(record));
+            }
+        }
+        return progress;
+    }
     static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.3.18", ngImport: i0, type: EsolveCartService, deps: [], target: i0.ɵɵFactoryTarget.Injectable }); }
     static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "20.3.18", ngImport: i0, type: EsolveCartService, providedIn: 'root' }); }
 }
@@ -7357,7 +7510,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.18", ngImpo
         }], ctorParameters: () => [] });
 
 class EsolveBanner {
-    constructor(id, banner_display_container, identifier, type, title, sub_title, catch_phrase, background_colour, button_caption, article, sort_priority, link, images) {
+    constructor(id, banner_display_container, identifier, type, title, sub_title, catch_phrase, background_colour, button_caption, article, sort_priority, link, images, videos = []) {
         this.id = id;
         this.banner_display_container = banner_display_container;
         this.identifier = identifier;
@@ -7370,9 +7523,11 @@ class EsolveBanner {
         this.article = article;
         this.sort_priority = sort_priority;
         this.link = link;
+        this.videos = videos;
         this.desktop_images = [];
         this.mobile_images = [];
         this.sub_images = [];
+        this.video_posters = [];
         if (images.desktop) {
             this.desktop_images = images.desktop;
         }
@@ -7382,6 +7537,9 @@ class EsolveBanner {
         if (images.sub) {
             this.sub_images = images.sub;
         }
+        if (images.video_poster) {
+            this.video_posters = images.video_poster;
+        }
     }
 }
 
@@ -7408,6 +7566,20 @@ class EsolveBannerImageHotspot {
     }
 }
 
+class EsolveBannerVideo {
+    constructor(record) {
+        this.id = 0;
+        this.filename = '';
+        if (record) {
+            this.id = +record.id;
+            this.filename = record.filename;
+        }
+    }
+    get src() {
+        return '/videos/banners/' + this.filename;
+    }
+}
+
 class EsolveBannerService {
     constructor() {
         this.config = inject(EsolveConfigService);
@@ -7473,6 +7645,7 @@ class EsolveBannerService {
         if (records && records.length > 0) {
             for (const record of records) {
                 const image_sets = {};
+                const videos = [];
                 if (record.images.desktop) {
                     image_sets.desktop = this.processBannerImages(record.images.desktop, record.type);
                 }
@@ -7482,10 +7655,18 @@ class EsolveBannerService {
                 if (record.images.sub) {
                     image_sets.sub = this.processBannerImages(record.images.sub, record.type);
                 }
+                if (record.images.video_poster) {
+                    image_sets.video_poster = this.processBannerImages(record.images.video_poster, record.type);
+                }
+                if (record.images.video && record.images.video.length > 0) {
+                    for (const video of record.images.video) {
+                        videos.push(new EsolveBannerVideo(video));
+                    }
+                }
                 const banner = new EsolveBanner(+record.id, record.banner_display_container, record.identifier, record.type, record.title, record.sub_title, record.catch_phrase, record.background_colour, record.button_caption, record.article, +record.sort_priority, {
                     url: record.link.url,
                     target: record.link.target,
-                }, image_sets);
+                }, image_sets, videos);
                 banners.push(banner);
             }
         }
@@ -10826,5 +11007,5 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.18", ngImpo
  * Generated bundle index. Do not edit.
  */
 
-export { ESOLVE_CONNECT_CONFIG, ESOLVE_EURUS_AUTO_LOGIN, EsolveAccountConfirmationResult, EsolveAccountPayment, EsolveAccountService, EsolveAdditionalStockImage, EsolveAddress, EsolveAddressResult, EsolveAffiliate, EsolveAffiliateCheckResult, EsolveAffiliateLinkResult, EsolveAffiliateService, EsolveAlbum, EsolveAlbumImage, EsolveAlbumImageList, EsolveAlbumList, EsolveAlbumsService, EsolveAsset, EsolveAssetsService, EsolveAuthService, EsolveBankingDetails, EsolveBanner, EsolveBannerImage, EsolveBannerImageHotspot, EsolveBannerService, EsolveCaptcha, EsolveCaptchaService, EsolveCareer, EsolveCareersService, EsolveCartAlternative, EsolveCartErrorHandlerService, EsolveCartItem, EsolveCartItemError, EsolveCartService, EsolveCartStockItem, EsolveCartTaxBreakdown, EsolveCartTotals, EsolveCategoryTreeItem, EsolveCategoryTreeService, EsolveCdnSrcDirective, EsolveChangePasswordResult, EsolveCheckoutResult, EsolveClientAsset, EsolveClientAssetList, EsolveColour, EsolveColoursService, EsolveCompetition, EsolveCompetitionDates, EsolveCompetitionEntryResult, EsolveCompetitionWinner, EsolveCompetitionsService, EsolveConfigService, EsolveCookieService, EsolveCountry, EsolveCountryService, EsolveCoupon, EsolveCouponsService, EsolveDeliveriesService, EsolveDelivery, EsolveDeliveryCategoryTotals, EsolveDeliveryList, EsolveDeliveryStatus, EsolveDependantItem, EsolveDeviceService, EsolveEmptyCartResult, EsolveEmptyWishlistResult, EsolveEnquiryResult, EsolveEnquiryService, EsolveErpDocumentRequest, EsolveErpDocumentsRequestResult, EsolveErrorHandlerService, EsolveEvent, EsolveEventTargetService, EsolveEventType, EsolveFilterFactory, EsolveGenericFilter, EsolveGeocodeAddressResult, EsolveGeocodeCoordsResult, EsolveGeocodeResult, EsolveGeocoderService, EsolveHttpError, EsolveLinkedAsset, EsolveLinkedStockItem, EsolveList, EsolveLocation, EsolveLocationAddress, EsolveLocationContactInfo, EsolveLocationGEO, EsolveLocationList, EsolveLocationPOBoxAddress, EsolveLocationTradingDay, EsolveLocationTradingTimes, EsolveLocationUpdateResult, EsolveLocationsService, EsolveManufacturer, EsolveManufacturersService, EsolveMaterial, EsolveMaterialsService, EsolveMediaStockItem, EsolveMenuItem, EsolveMenuService, EsolveMultipleSelectFilter, EsolveNewsArticle, EsolveNewsArticleAuthor, EsolveNewsArticleList, EsolveNewsGroup, EsolveNewsService, EsolveNewsletterResult, EsolveNotificationButtonAction, EsolveNotificationDates, EsolveNotificationsService, EsolveOtp, EsolveOtpService, EsolveOtpValidation, EsolvePaymentMethod, EsolvePaymentResult, EsolvePaymentService, EsolveRange, EsolveRangeFilter, EsolveRangesService, EsolveRecipeStockItem, EsolveRegistrationResult, EsolveResetPasswordResult, EsolveResponseHandlerService, EsolveResponseResult, EsolveResult, EsolveReview, EsolveReviewList, EsolveReviewResult, EsolveReviewsService, EsolveSearchCleanResult, EsolveSearchResult, EsolveSearchResultItem, EsolveSearchService, EsolveSearchVectorizeResult, EsolveSeoInfo, EsolveSeoService, EsolveSessionAddressUpdateResult, EsolveSessionClientUpdateResult, EsolveSessionMetadataService, EsolveSessionService, EsolveSessionShippingUpdateResult, EsolveSetDeviceResult, EsolveSetNotifyResult, EsolveSettings, EsolveSettingsService, EsolveShippingCost, EsolveShippingCostItem, EsolveShippingMethod, EsolveShippingService, EsolveShippingTotals, EsolveSingleSelectFilter, EsolveSpecial, EsolveSpecialDates, EsolveSpecialImage, EsolveSpecialImageCollection, EsolveSpecialsService, EsolveStatement, EsolveStatementAgeing, EsolveStatementBalances, EsolveStatementTransaction, EsolveStockBadge, EsolveStockBarcode, EsolveStockGroup, EsolveStockGroupItem, EsolveStockImage, EsolveStockImageCollection, EsolveStockItem, EsolveStockItemBase, EsolveStockItemList, EsolveStockItemLocationLevel, EsolveStockLeadTimes, EsolveStockPrice, EsolveStockReviewsReport, EsolveStockService, EsolveStockTransactionSales, EsolveSuggestedStockItem, EsolveSupplier, EsolveSuppliersService, EsolveSystemNotification, EsolveSystemNotificationType, EsolveTag, EsolveTagsService, EsolveTimeSlot, EsolveTimeSlotConfig, EsolveTimeSlotDate, EsolveTimeSlotDays, EsolveTimeSlotTimes, EsolveToggleFilter, EsolveTopic, EsolveTopicService, EsolveTransaction, EsolveTransactionAddress, EsolveTransactionAnalyticsData, EsolveTransactionApprovalResult, EsolveTransactionClient, EsolveTransactionDelivery, EsolveTransactionItem, EsolveTransactionItemPrice, EsolveTransactionList, EsolveTransactionLocation, EsolveTransactionPaymentMethod, EsolveTransactionPick, EsolveTransactionShippingMethod, EsolveTransactionTimeSlot, EsolveTransactionUser, EsolveTransactionsService, EsolveUserAccount, EsolveUserAccountBusiness, EsolveUserAccountContact, EsolveUserAccountResult, EsolveUserClientAccount, EsolveUserClientAccountBalances, EsolveUserDevice, EsolveVaultItem, EsolveVaultItemResult, EsolveVoucher, EsolveVouchersService, EsolveWalletBalances, EsolveWalletService, EsolveWalletTransaction, EsolveWalletTransactionsList, EsolveWishlistItem, EsolveWishlistService, NgEsolveConnectModule, esolveAuthInterceptor, esolveHexHash, esolveUnauthorizedErrorInterceptor, isEsolveCdnPath, isFtgCdnPath, isLegacyEsolveCdnPath, processEsolveImageSrc, provideEsolveImageLoader, provideNgEsolveConnect };
+export { ESOLVE_CONNECT_CONFIG, ESOLVE_EURUS_AUTO_LOGIN, EsolveAccountConfirmationResult, EsolveAccountPayment, EsolveAccountService, EsolveAdditionalStockImage, EsolveAddress, EsolveAddressResult, EsolveAffiliate, EsolveAffiliateCheckResult, EsolveAffiliateLinkResult, EsolveAffiliateService, EsolveAlbum, EsolveAlbumImage, EsolveAlbumImageList, EsolveAlbumList, EsolveAlbumsService, EsolveAsset, EsolveAssetsService, EsolveAuthService, EsolveBankingDetails, EsolveBanner, EsolveBannerImage, EsolveBannerImageHotspot, EsolveBannerService, EsolveBannerVideo, EsolveCaptcha, EsolveCaptchaService, EsolveCareer, EsolveCareersService, EsolveCartAlternative, EsolveCartErrorHandlerService, EsolveCartItem, EsolveCartItemError, EsolveCartPromotionProgressItem, EsolveCartPromotionProgressQualifyingItem, EsolveCartService, EsolveCartStockItem, EsolveCartTaxBreakdown, EsolveCartTotals, EsolveCategoryTreeItem, EsolveCategoryTreeService, EsolveCdnSrcDirective, EsolveChangePasswordResult, EsolveCheckoutResult, EsolveClientAsset, EsolveClientAssetList, EsolveColour, EsolveColoursService, EsolveCompetition, EsolveCompetitionDates, EsolveCompetitionEntryResult, EsolveCompetitionWinner, EsolveCompetitionsService, EsolveConfigService, EsolveCookieService, EsolveCountry, EsolveCountryService, EsolveCoupon, EsolveCouponsService, EsolveDeliveriesService, EsolveDelivery, EsolveDeliveryCategoryTotals, EsolveDeliveryList, EsolveDeliveryStatus, EsolveDependantItem, EsolveDeviceService, EsolveEmptyCartResult, EsolveEmptyWishlistResult, EsolveEnquiryResult, EsolveEnquiryService, EsolveErpDocumentRequest, EsolveErpDocumentsRequestResult, EsolveErrorHandlerService, EsolveEvent, EsolveEventTargetService, EsolveEventType, EsolveFilterFactory, EsolveGenericFilter, EsolveGeocodeAddressResult, EsolveGeocodeCoordsResult, EsolveGeocodeResult, EsolveGeocoderService, EsolveHttpError, EsolveLinkedAsset, EsolveLinkedStockItem, EsolveList, EsolveLocation, EsolveLocationAddress, EsolveLocationContactInfo, EsolveLocationGEO, EsolveLocationList, EsolveLocationPOBoxAddress, EsolveLocationTradingDay, EsolveLocationTradingTimes, EsolveLocationUpdateResult, EsolveLocationsService, EsolveManufacturer, EsolveManufacturersService, EsolveMaterial, EsolveMaterialsService, EsolveMediaStockItem, EsolveMenuItem, EsolveMenuService, EsolveMultipleSelectFilter, EsolveNewsArticle, EsolveNewsArticleAuthor, EsolveNewsArticleList, EsolveNewsGroup, EsolveNewsService, EsolveNewsletterResult, EsolveNotificationButtonAction, EsolveNotificationDates, EsolveNotificationsService, EsolveOtp, EsolveOtpService, EsolveOtpValidation, EsolvePaymentMethod, EsolvePaymentResult, EsolvePaymentService, EsolveRange, EsolveRangeFilter, EsolveRangesService, EsolveRecipeStockItem, EsolveRegistrationResult, EsolveResetPasswordResult, EsolveResponseHandlerService, EsolveResponseResult, EsolveResult, EsolveReview, EsolveReviewList, EsolveReviewResult, EsolveReviewsService, EsolveSearchCleanResult, EsolveSearchResult, EsolveSearchResultItem, EsolveSearchService, EsolveSearchVectorizeResult, EsolveSeoInfo, EsolveSeoService, EsolveSessionAddressUpdateResult, EsolveSessionClientUpdateResult, EsolveSessionMetadataService, EsolveSessionService, EsolveSessionShippingUpdateResult, EsolveSetDeviceResult, EsolveSetNotifyResult, EsolveSettings, EsolveSettingsService, EsolveShippingCost, EsolveShippingCostItem, EsolveShippingMethod, EsolveShippingService, EsolveShippingTotals, EsolveSingleSelectFilter, EsolveSpecial, EsolveSpecialDates, EsolveSpecialImage, EsolveSpecialImageCollection, EsolveSpecialsService, EsolveStatement, EsolveStatementAgeing, EsolveStatementBalances, EsolveStatementTransaction, EsolveStockBadge, EsolveStockBarcode, EsolveStockGroup, EsolveStockGroupItem, EsolveStockImage, EsolveStockImageCollection, EsolveStockItem, EsolveStockItemBase, EsolveStockItemList, EsolveStockItemLocationLevel, EsolveStockLeadTimes, EsolveStockPrice, EsolveStockReviewsReport, EsolveStockService, EsolveStockTransactionSales, EsolveSuggestedStockItem, EsolveSupplier, EsolveSuppliersService, EsolveSystemNotification, EsolveSystemNotificationType, EsolveTag, EsolveTagsService, EsolveTimeSlot, EsolveTimeSlotConfig, EsolveTimeSlotDate, EsolveTimeSlotDays, EsolveTimeSlotTimes, EsolveToggleFilter, EsolveTopic, EsolveTopicService, EsolveTransaction, EsolveTransactionAddress, EsolveTransactionAnalyticsData, EsolveTransactionApprovalResult, EsolveTransactionClient, EsolveTransactionDelivery, EsolveTransactionItem, EsolveTransactionItemPrice, EsolveTransactionList, EsolveTransactionLocation, EsolveTransactionPaymentMethod, EsolveTransactionPick, EsolveTransactionShippingMethod, EsolveTransactionTimeSlot, EsolveTransactionUser, EsolveTransactionsService, EsolveUserAccount, EsolveUserAccountBusiness, EsolveUserAccountContact, EsolveUserAccountResult, EsolveUserClientAccount, EsolveUserClientAccountBalances, EsolveUserDevice, EsolveVaultItem, EsolveVaultItemResult, EsolveVoucher, EsolveVouchersService, EsolveWalletBalances, EsolveWalletService, EsolveWalletTransaction, EsolveWalletTransactionsList, EsolveWishlistItem, EsolveWishlistService, NgEsolveConnectModule, esolveAuthInterceptor, esolveHexHash, esolveUnauthorizedErrorInterceptor, isEsolveCdnPath, isFtgCdnPath, isLegacyEsolveCdnPath, processEsolveImageSrc, provideEsolveImageLoader, provideNgEsolveConnect };
 //# sourceMappingURL=esolve-ng-esolve-connect.mjs.map