@esolve/ng-esolve-connect 0.108.0 → 0.109.1

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

@@ -675,7 +675,9 @@ class EsolveSessionService {
         this.updateClientsId(session.clients_id);
         // Update token last to make sure session is correctly checked
         this.updateToken(session.token);
-        this.startTimer(expiry_date);
+        if (this.is_browser) {
+            this.startTimer(expiry_date);
+        }
     }
     handleUpdateSession({ user_id, location_id, addresses_id, shipping_id, clients_id, token, }) {
         if (typeof user_id !== 'undefined') {
@@ -9104,6 +9106,264 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.6", ngImpor
                 }]
         }] });
 
+/**
+ * Represents an Esolve Affiliate with properties and a constructor to initialize from a record.
+ */
+class EsolveAffiliate {
+    /**
+     * Constructs a new EsolveAffiliate instance.
+     *
+     * @param record - An optional partial EsolveAffiliateRecord to initialize the instance from.
+     *
+     * @remarks
+     * If a record is provided, the instance properties are populated from the record.
+     * If a record property is missing or null, the corresponding instance property is set to its default value.
+     *
+     * @example
+     * ```typescript
+     * const record: Partial<EsolveAffiliateRecord> = {
+     *     id: '123',
+     *     affiliate_name: 'Example Affiliate',
+     *     affiliate_domain: 'example.com'
+     *     affiliate_key: 'example-key',
+     *     default: true
+     * };
+     *
+     * const affiliate = new EsolveAffiliate(record);
+     * console.log(affiliate.id); // Output: 123
+     * console.log(affiliate.name); // Output: Example Affiliate
+     * console.log(affiliate.key); // Output: example-key
+     * console.log(affiliate.is_default); // Output: true
+     * ```
+     */
+    constructor(record) {
+        this.id = 0;
+        this.name = '';
+        this.key = '';
+        this.domain = '';
+        if (record) {
+            this.id = +(record.id ?? 0);
+            this.name = record.affiliate_name ?? '';
+            this.key = record.affiliate_key ?? '';
+            this.domain = record.affiliate_domain ?? '';
+            if (typeof record.default !== 'undefined') {
+                this.is_default = !!+record.default;
+            }
+        }
+    }
+}
+
+/**
+ * Represents the result of an affiliate-related API call.
+ *
+ * @remarks
+ * This class is used to encapsulate the result of an affiliate-related API call,
+ * providing access to the affiliate, linked affiliates, and additional data.
+ */
+class EsolveAffiliateCheckResult {
+    constructor(record) {
+        /**
+         * Indicates whether user confirmation is required for the affiliate linking.
+         * @default false
+         */
+        this.confirmation_required = false;
+        /**
+         * An array of linked affiliates associated with the current user.
+         * @default []
+         */
+        this.linked_affiliates = [];
+        /**
+         * The total number of linked affiliates associated with the current user.
+         * @default 0
+         */
+        this.total_linked_affiliates = 0;
+        if (record) {
+            this.affiliate = new EsolveAffiliate(record.affiliate);
+            this.confirmation_required = !!record.confirmation_required;
+            this.linked_affiliates = this.processAffiliates(record.linked_affiliates ?? []);
+            this.total_linked_affiliates = +(record.total_linked_affiliates ?? 0);
+        }
+    }
+    /**
+     * Processes an array of affiliate records and returns an array of EsolveAffiliate instances.
+     *
+     * @param affiliate_records - The affiliate records to process.
+     * @returns An array of EsolveAffiliate instances.
+     */
+    processAffiliates(affiliate_records) {
+        return affiliate_records.map((record) => new EsolveAffiliate(record));
+    }
+}
+
+class EsolveAffiliateLinkResult extends EsolveResponseResult {
+    constructor(response) {
+        super(response);
+        this.id = 0;
+        this.id = +response.esolve_id;
+    }
+}
+
+class EsolveAffiliateService {
+    constructor() {
+        this.http = inject(HttpClient);
+        this.config = inject(EsolveConfigService);
+        this.errorHandler = inject(EsolveErrorHandlerService);
+        this.responseHandler = inject(EsolveResponseHandlerService);
+    }
+    /**
+     * Retrieves affiliate records based on the provided options.
+     *
+     * @param options - Optional parameters for filtering and pagination.
+     * @returns - An observable that emits an `EsolveList` containing the retrieved affiliate records and additional data.
+     *
+     * @remarks
+     * If the `options` parameter is provided, it is used to construct an HTTP GET request with query parameters for pagination.
+     * The response is validated and transformed into an `EsolveList` object.
+     * If the response does not contain any records, an error is thrown.
+     * The function utilizes the `HttpClient` to make the HTTP request and applies RxJS operators for handling the response.
+     *
+     * @example
+     * ```typescript
+     * const options: EsolveAffiliatesOptions = {
+     *     page: 1,
+     *     rows: 10,
+     * };
+     *
+     * this.affiliateService.getAffiliates(options).subscribe((affiliates) => {
+     *     console.log(affiliates.items); // Array of EsolveAffiliate objects
+     *     console.log(affiliates.page); // 1
+     *     console.log(affiliates.rows); // 10
+     *     console.log(affiliates.totalRecords); // Total number of affiliate records
+     * });
+     * ```
+     */
+    getAffiliates(options) {
+        let params = new HttpParams();
+        if (options) {
+            if (options.page) {
+                params = params.set('page', options.page);
+            }
+            if (options.rows) {
+                params = params.set('rows', options.rows);
+            }
+        }
+        return this.http
+            .get(`${this.config.api_url}/get-affiliates.php`, {
+            params,
+        })
+            .pipe(map((response) => {
+            if (response.records === undefined ||
+                response.records.length <= 0) {
+                throw response;
+            }
+            const items = this.processAffiliates(response.records);
+            return new EsolveList(items, options?.page, options?.rows, +response.additional_data.total_records);
+        }));
+    }
+    /**
+     * Retrieves affiliate information for user linking based on the provided affiliate key.
+     *
+     * @param affiliate_key - The unique identifier for the affiliate.
+     * @returns - An observable that emits an `EsolveAffiliateCheckResult` object containing the retrieved affiliate check record.
+     *
+     * @remarks
+     * If the `affiliate_key` parameter is an empty string, an error is emitted using the `EsolveErrorHandlerService`.
+     * The function constructs an HTTP GET request with the affiliate key as a query parameter.
+     * The response is validated and transformed into an `EsolveAffiliateCheckResult` object.
+     * If the response does not contain a valid record, an error is thrown.
+     * The function utilizes the `HttpClient` to make the HTTP request and applies RxJS operators for handling the response.
+     *
+     * @example
+     * ```typescript
+     * this.affiliateService.getAffiliateCheck('12345').subscribe((affiliateCheckResult) => {
+     *     console.log(affiliateCheckResult.record); // EsolveAffiliateCheckRecord object
+     * });
+     * ```
+     */
+    getAffiliateCheck(affiliate_key) {
+        if (affiliate_key === '') {
+            return this.errorHandler.emitError('affiliate_key_required', 'Affiliate key is required is required');
+        }
+        const params = new HttpParams({
+            fromObject: { affiliate_key },
+        });
+        return this.http
+            .get(`${this.config.api_url}/get-affiliate-check.php`, {
+            params,
+        })
+            .pipe(map((response) => {
+            let record = response.records;
+            if (Array.isArray(record)) {
+                record = undefined;
+            }
+            if (!record) {
+                throw response;
+            }
+            return new EsolveAffiliateCheckResult(record);
+        }));
+    }
+    /**
+     * Sets the affiliate link using the provided options.
+     *
+     * @param options - The options for setting the affiliate link.
+     * @returns - An observable that emits the result of the affiliate link set operation.
+     *
+     * @remarks
+     * This function constructs a FormData object with the affiliate key from the provided options.
+     * It then sends a POST request to the API endpoint `/set-affiliate-link.php` with the FormData.
+     * The response is validated and transformed into an `EsolveAffiliateLinkResult` object.
+     * If an error occurs during the HTTP request, it is handled and an appropriate error is emitted.
+     */
+    setAffiliateLink(options) {
+        const form_data = new FormData();
+        if (options.affiliate_id !== undefined && options.affiliate_id !== 0) {
+            form_data.append('affiliate_key', options.affiliate_id.toString());
+        }
+        else if (options.affiliate_key !== undefined &&
+            options.affiliate_key !== '') {
+            form_data.append('affiliate_key', options.affiliate_key);
+        }
+        else {
+            return this.errorHandler.emitError('affiliate_key_id_required', 'Affiliate key or id is required is required');
+        }
+        return this.http
+            .post(`${this.config.api_url}/set-affiliate-link.php`, form_data, {
+            responseType: 'json',
+            observe: 'body',
+        })
+            .pipe(map((http_response) => this.responseHandler.validateSingleHttpResponse(http_response, (response) => new EsolveAffiliateLinkResult(response))), catchError$1((errorRes) => {
+            return this.errorHandler.handleHttpPostError('set-enquiry', errorRes);
+        }));
+    }
+    /**
+     * Processes an array of `EsolveAffiliateRecord` objects and transforms them into an array of `EsolveAffiliate` objects.
+     *
+     * @param records - An array of `EsolveAffiliateRecord` objects to be processed.
+     * @returns - An array of `EsolveAffiliate` objects, where each object is created from a corresponding `EsolveAffiliateRecord` object.
+     *
+     * @remarks
+     * This function iterates over the input array of `EsolveAffiliateRecord` objects and creates a new `EsolveAffiliate` object for each record.
+     * If the input array is empty, an empty array is returned.
+     */
+    processAffiliates(records) {
+        const items = [];
+        if (records.length > 0) {
+            for (const record of records) {
+                items.push(new EsolveAffiliate(record));
+            }
+        }
+        return items;
+    }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "18.2.6", ngImport: i0, type: EsolveAffiliateService, deps: [], target: i0.ɵɵFactoryTarget.Injectable }); }
+    static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "18.2.6", ngImport: i0, type: EsolveAffiliateService, providedIn: 'root' }); }
+}
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.6", ngImport: i0, type: EsolveAffiliateService, decorators: [{
+            type: Injectable,
+            args: [{
+                    providedIn: 'root',
+                }]
+        }] });
+
 /*
  * Public API Surface of ng-esolve-connect
  */
@@ -9112,5 +9372,5 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.6", ngImpor
  * Generated bundle index. Do not edit.
  */
 
-export { ESOLVE_CONNECT_CONFIG, ESOLVE_EURUS_AUTO_LOGIN, EsolveAccountConfirmationResult, EsolveAccountPayment, EsolveAccountService, EsolveAdditionalStockImage, EsolveAddress, EsolveAddressResult, EsolveAlbum, EsolveAlbumImage, EsolveAlbumImageList, EsolveAlbumList, EsolveAlbumsService, EsolveAsset, EsolveAssetsService, EsolveAuthInterceptorService, EsolveAuthService, EsolveBankingDetails, EsolveBanner, EsolveBannerImage, EsolveBannerImageHotspot, EsolveBannerService, EsolveCaptcha, EsolveCaptchaService, EsolveCartAlternative, EsolveCartItem, EsolveCartService, EsolveCartStockItem, EsolveCartTotals, EsolveCategoryTreeItem, EsolveCategoryTreeService, EsolveCdnSrcDirective, EsolveChangePasswordResult, EsolveCheckoutResult, EsolveColour, EsolveCompetition, EsolveCompetitionDates, EsolveCompetitionEntryResult, EsolveCompetitionWinner, EsolveCompetitionsService, EsolveConfigService, EsolveCookieService, EsolveCoupon, EsolveCouponsService, EsolveDeliveriesService, EsolveDelivery, EsolveDeliveryCategoryTotals, EsolveDeliveryList, EsolveDeliveryStatus, EsolveDependantItem, EsolveDeviceService, EsolveEmptyCartResult, EsolveEmptyWishlistResult, EsolveEnquiryResult, EsolveEnquiryService, EsolveErpDocumentRequest, EsolveErpDocumentsRequestResult, EsolveErrorHandlerService, EsolveFilterFactory, EsolveGenericFilter, EsolveGeocodeAddressResult, EsolveGeocodeCoordsResult, EsolveGeocodeResult, EsolveGeocoderService, EsolveHttpError, EsolveLinkedAsset, EsolveLinkedStockItem, EsolveList, EsolveLocation, EsolveLocationAddress, EsolveLocationContactInfo, EsolveLocationGEO, EsolveLocationList, EsolveLocationPOBoxAddress, EsolveLocationTradingDay, EsolveLocationTradingTimes, EsolveLocationUpdateResult, EsolveLocationsService, EsolveManufacturer, EsolveManufacturersService, EsolveMediaStockItem, EsolveMenuItem, EsolveMenuService, EsolveMultipleSelectFilter, EsolveNewsArticle, EsolveNewsArticleAuthor, EsolveNewsArticleList, EsolveNewsGroup, EsolveNewsService, EsolveNewsletterResult, EsolveOtp, EsolveOtpService, EsolveOtpValidation, EsolvePaymentMethod, EsolvePaymentResult, EsolvePaymentService, EsolveRange, EsolveRangeFilter, EsolveRangesService, EsolveRecipeStockItem, EsolveRegistrationResult, EsolveResetPasswordResult, EsolveResponseHandlerService, EsolveResponseResult, EsolveResult, EsolveReview, EsolveReviewList, EsolveReviewResult, EsolveReviewsService, EsolveSeoInfo, EsolveSeoService, EsolveSessionAddressUpdateResult, EsolveSessionClientUpdateResult, EsolveSessionMetadataService, EsolveSessionService, EsolveSessionShippingUpdateResult, EsolveSetDeviceResult, EsolveSetNotifyResult, EsolveShippingCost, EsolveShippingMethod, EsolveShippingService, EsolveShippingTotals, EsolveSingleSelectFilter, EsolveSpecial, EsolveSpecialDates, EsolveSpecialImage, EsolveSpecialImageCollection, EsolveSpecialsService, EsolveStatement, EsolveStatementAgeing, EsolveStatementBalances, EsolveStatementTransaction, EsolveStockBadge, EsolveStockGroup, EsolveStockGroupItem, EsolveStockImage, EsolveStockImageCollection, EsolveStockItem, EsolveStockItemBase, EsolveStockItemList, EsolveStockLeadTimes, EsolveStockPrice, EsolveStockReviewsReport, EsolveStockService, EsolveSuggestedStockItem, EsolveSupplier, EsolveSuppliersService, EsolveTag, EsolveTagsService, EsolveTimeSlot, EsolveTimeSlotConfig, EsolveTimeSlotDate, EsolveTimeSlotDays, EsolveTimeSlotTimes, EsolveToggleFilter, EsolveTopic, EsolveTopicService, EsolveTransaction, EsolveTransactionAddress, EsolveTransactionAnalyticsData, 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, esolveHexHash, 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, EsolveAuthInterceptorService, EsolveAuthService, EsolveBankingDetails, EsolveBanner, EsolveBannerImage, EsolveBannerImageHotspot, EsolveBannerService, EsolveCaptcha, EsolveCaptchaService, EsolveCartAlternative, EsolveCartItem, EsolveCartService, EsolveCartStockItem, EsolveCartTotals, EsolveCategoryTreeItem, EsolveCategoryTreeService, EsolveCdnSrcDirective, EsolveChangePasswordResult, EsolveCheckoutResult, EsolveColour, EsolveCompetition, EsolveCompetitionDates, EsolveCompetitionEntryResult, EsolveCompetitionWinner, EsolveCompetitionsService, EsolveConfigService, EsolveCookieService, EsolveCoupon, EsolveCouponsService, EsolveDeliveriesService, EsolveDelivery, EsolveDeliveryCategoryTotals, EsolveDeliveryList, EsolveDeliveryStatus, EsolveDependantItem, EsolveDeviceService, EsolveEmptyCartResult, EsolveEmptyWishlistResult, EsolveEnquiryResult, EsolveEnquiryService, EsolveErpDocumentRequest, EsolveErpDocumentsRequestResult, EsolveErrorHandlerService, EsolveFilterFactory, EsolveGenericFilter, EsolveGeocodeAddressResult, EsolveGeocodeCoordsResult, EsolveGeocodeResult, EsolveGeocoderService, EsolveHttpError, EsolveLinkedAsset, EsolveLinkedStockItem, EsolveList, EsolveLocation, EsolveLocationAddress, EsolveLocationContactInfo, EsolveLocationGEO, EsolveLocationList, EsolveLocationPOBoxAddress, EsolveLocationTradingDay, EsolveLocationTradingTimes, EsolveLocationUpdateResult, EsolveLocationsService, EsolveManufacturer, EsolveManufacturersService, EsolveMediaStockItem, EsolveMenuItem, EsolveMenuService, EsolveMultipleSelectFilter, EsolveNewsArticle, EsolveNewsArticleAuthor, EsolveNewsArticleList, EsolveNewsGroup, EsolveNewsService, EsolveNewsletterResult, EsolveOtp, EsolveOtpService, EsolveOtpValidation, EsolvePaymentMethod, EsolvePaymentResult, EsolvePaymentService, EsolveRange, EsolveRangeFilter, EsolveRangesService, EsolveRecipeStockItem, EsolveRegistrationResult, EsolveResetPasswordResult, EsolveResponseHandlerService, EsolveResponseResult, EsolveResult, EsolveReview, EsolveReviewList, EsolveReviewResult, EsolveReviewsService, EsolveSeoInfo, EsolveSeoService, EsolveSessionAddressUpdateResult, EsolveSessionClientUpdateResult, EsolveSessionMetadataService, EsolveSessionService, EsolveSessionShippingUpdateResult, EsolveSetDeviceResult, EsolveSetNotifyResult, EsolveShippingCost, EsolveShippingMethod, EsolveShippingService, EsolveShippingTotals, EsolveSingleSelectFilter, EsolveSpecial, EsolveSpecialDates, EsolveSpecialImage, EsolveSpecialImageCollection, EsolveSpecialsService, EsolveStatement, EsolveStatementAgeing, EsolveStatementBalances, EsolveStatementTransaction, EsolveStockBadge, EsolveStockGroup, EsolveStockGroupItem, EsolveStockImage, EsolveStockImageCollection, EsolveStockItem, EsolveStockItemBase, EsolveStockItemList, EsolveStockLeadTimes, EsolveStockPrice, EsolveStockReviewsReport, EsolveStockService, EsolveSuggestedStockItem, EsolveSupplier, EsolveSuppliersService, EsolveTag, EsolveTagsService, EsolveTimeSlot, EsolveTimeSlotConfig, EsolveTimeSlotDate, EsolveTimeSlotDays, EsolveTimeSlotTimes, EsolveToggleFilter, EsolveTopic, EsolveTopicService, EsolveTransaction, EsolveTransactionAddress, EsolveTransactionAnalyticsData, 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, esolveHexHash, isEsolveCdnPath, isFtgCdnPath, isLegacyEsolveCdnPath, processEsolveImageSrc, provideEsolveImageLoader, provideNgEsolveConnect };
 //# sourceMappingURL=esolve-ng-esolve-connect.mjs.map