@salla.sa/analytics 2.14.548

package/src/storefront/product-list-filtered.js

@@ -0,0 +1,56 @@
+import ProductListViewed from './product-list-viewed';
+
+export default class ProductListFiltered extends ProductListViewed {
+
+    constructor(details) {
+        super(details);
+        const nextPageUrl = details?.nextPage || '';
+        this.filters = this.extractFilters(nextPageUrl);
+    }
+
+    extractFilters(url) {
+        if (!url) return null;
+        
+        try {
+            const urlObj = new URL(url);
+            const filters = [];
+            
+            Array.from(urlObj.searchParams.entries()).forEach(([param, value]) => {
+                if (param.startsWith('filters[')) {
+                    const match = param.match(/^filters\[(.*?)\]/);
+                    const type = match ? match[1] : param;
+                    
+                    filters.push({ 
+                        type: type, 
+                        value: value 
+                    });
+                }
+            });
+            
+            return filters.length > 0 ? filters : null;
+        } catch (e) {
+            console.warn('Error extracting filters from URL:', e);
+            return null;
+        }
+    }
+    
+    toSegment() {
+        const base = super.toSegment();
+        return {
+            event: 'Product List Filtered',
+            properties: {
+                ...base?.properties,
+                filters: this.filters
+            }
+        };
+    }
+
+    static shouldSend(details){
+        const nextPageUrl = details?.nextPage || '';
+        // On the search page, filtering is reported as "Product List Viewed" instead.
+        if (salla.config.get('page.slug') === 'product.index.search') {
+            return false;
+        }
+        return nextPageUrl.includes('filters');
+    }
+}

package/src/storefront/product-list-viewed.js

@@ -0,0 +1,80 @@
+export default class ProductListViewed {
+    constructor(details) {
+        const nextPageUrl = details?.nextPage;
+        this.listId = salla.config.get('page.slug');
+
+        if (Salla.config.get('page.id')) {
+            this.listId += `_${salla.config.get('page.id')}`;
+        }
+
+        this.sorts = null;
+        try {
+            if (nextPageUrl) {
+                const url = new URL(nextPageUrl);
+                const sortValue = url.searchParams.get('sort');
+                if (sortValue) {
+                    this.sorts = [
+                        {
+                            type: 'sort',
+                            value: sortValue
+                        }
+                    ];
+                }
+            }
+
+            if (details.source) {
+                this.listId = `${this.listId}_${details.source}`;
+            }
+
+            if (details.sourceValue) {
+                this.listId = `${this.listId}_${Array.isArray(details.sourceValue) ? details.sourceValue.join('_') : details.sourceValue}`;
+            }
+        } catch (error) {
+            salla.logger.error(error);
+        }
+
+        this.products = details?.data;
+    }
+
+    toSegment() {
+        const pageTitle = salla.config.get('page.title') || '';
+        const parts = pageTitle.split('|').map(s => s.trim());
+        const category = parts[0];
+        const sub_category = parts[1] || null;
+
+        return {
+            event: 'Product List Viewed',
+            properties: {
+                list_id: this.listId,
+                category,
+                sub_category,
+                sorts: this.sorts,
+                products: this.products.map((product) => ({
+                    product_id: product.id,
+                    category: product.category?.name,
+                    currency: Salla.config.currency()?.code,
+                    name: product.name,
+                    brand: product.brand?.name,
+                    variant: product.variant?.toString(),
+                    coupon: product.coupon?.toString(),
+                    price: product.price,
+                    quantity: Number(product.quantity),
+                    sku: product.sku,
+                    position: product.position,
+                    url: product.url,
+                    image_url: product.image?.url
+                }))
+            }
+        };
+    }
+
+    static shouldSend(details){
+        const nextPageUrl = details?.nextPage || '';
+        const pageSlug = salla.config.get('page.slug');
+        // On the search page, always report as "Product List Viewed", even when filters are applied.
+        if (pageSlug === 'product.index.search') {
+            return true;
+        }
+        return !nextPageUrl.includes('filters') && !['index', 'customer.wishlist'].includes(pageSlug);
+    }
+}

package/src/storefront/product-removed-from-wishlist.js

@@ -0,0 +1,29 @@
+export default class ProductRemovedFromWishlist {
+    constructor(details) {
+        this.product = details.data.product;
+    }
+
+    toSegment() {
+        return {
+            event: 'Product Removed from Wishlist',
+            properties: {
+                wishlist_id : salla.config.get('store.id') + '_' + salla.config.get('user.id'),
+                wishlist_name : salla.config.get('store.name'),
+                product_id : this.product.id?.toString(),
+                name: this.product.name,
+                brand: this.product.brand,
+                variant: this.product.variant,
+                price: this.product.price,
+                quantity: Math.max(1, Number(this.product.quantity)),
+                sku: this.product.sku || null,
+                coupon: this.product.coupon || null,
+                position: Number(this.product.position || 0),
+                currency: Salla.config.currency()?.code,
+                url: this.product.url,
+                image_url: this.product?.image || null,
+                category: this.product.category,
+                brand: this.product.brand,
+            }
+        };
+    }
+}

package/src/storefront/product-removed.js

@@ -0,0 +1,27 @@
+export default class ProductRemoved {
+    constructor(details) {
+        this.item = details[0];
+    }
+
+    toSegment() {
+        return {
+            event: 'Product Removed',
+            properties: {
+                cart_id: this.item?.cart_id?.toString(),
+                product_id: this.item?.id?.toString(),
+                category: this.item?.category,
+                currency: Salla.config.currency()?.code,
+                name: this.item?.name,
+                brand: this.item?.brand,
+                variant: this.item?.variant,
+                price: this.item?.price,
+                quantity: this.item?.quantity,
+                sku: this.item?.sku,
+                coupon: this.item?.coupon,
+                position: this.item?.position,
+                url: this.item?.url,
+                image_url: this.item?.image_url
+            }
+        };
+    }
+}

package/src/storefront/product-reordered.js

@@ -0,0 +1,19 @@
+export default class ProductReordered {
+    constructor(details) {
+        this.details = details;
+    }
+
+    toSegment() {
+        return {
+            event: 'Product Reordered',
+            properties: {
+                product_id: this.details?.data?.id?.toString(),
+            }
+        };
+    }
+
+    static shouldSend(details) {
+        const data = details?.data;
+        return data?.id && !isNaN(data?.id) && data?.type === 'reorder';
+    }
+}

package/src/storefront/product-reviewed.js

@@ -0,0 +1,28 @@
+class ProductReviewed {
+    constructor(details) {
+        this.details = details;
+    }
+
+    toSegment() {
+       return {
+            event: 'Product Reviewed',
+            properties: this.details,
+        }
+    }
+
+    static registerEvent(){
+        salla.event.rating.onProductsRated(function (response, data) {
+            const { products, order_id } = data;
+            Object.values(products).forEach(product => {
+                Salla.event.emit('Product Reviewed', {
+                    product_id: product.product_id?.toString(),
+                    review_id: order_id?.toString(),
+                    review_body: product.comment,
+                    rating: product.rating
+                });
+            });
+        });
+    }
+}
+
+export default ProductReviewed;

package/src/storefront/product-shared.js

@@ -0,0 +1,18 @@
+export default class ProductShared {
+    constructor(details) {
+        this.data = details;
+    }
+
+    toSegment() {
+        const product = Salla.analytics.history.find(({ eventName }) => eventName === 'Product Viewed')?.payload || {};
+        product.share_via = this.data.share_via;
+        return {
+            event: 'Product Shared',
+            properties: product
+        };
+    }
+
+    static shouldSend() {
+        return salla.config.get('page.slug') === 'product.single';
+    }
+}

package/src/storefront/product-viewed.js

@@ -0,0 +1,44 @@
+export default class ProductViewed {
+    constructor(details) {
+        this.product = details[0];
+        // Read source from session storage
+        try {
+            this.source = sessionStorage.getItem('s-viewed-source') || null;
+            sessionStorage.removeItem('s-viewed-source');
+        } catch {
+            this.source = null;
+        }
+        // Read the clicked list position from session storage (same passing logic as
+        // s-viewed-source), falling back to any position carried on the product itself.
+        try {
+            const position = sessionStorage.getItem('s-viewed-position');
+            this.position = position !== null ? Number(position) : (this.product.position ?? null);
+            sessionStorage.removeItem('s-viewed-position');
+        } catch {
+            this.position = this.product.position ?? null;
+        }
+    }
+
+    toSegment() {
+        return {
+            event: 'Product Viewed',
+            properties: {
+                product_id: this.product.id?.toString(),
+                category: this.product.category,
+                name: this.product.name,
+                brand: this.product.brand,
+                variant: this.product.variant,
+                price: this.product.price,
+                quantity: this.product.quantity,
+                currency: this.product.currency,
+                coupon: this.product.coupon,
+                position: this.position,
+                value: this.product.value,
+                sku: this.product.sku,
+                url: this.product.url,
+                image_url: this.product.image_url,
+                source: this.source
+            }
+        };
+    }
+}

package/src/storefront/products-searched.js

@@ -0,0 +1,14 @@
+export default class ProductSearched {
+    constructor(details) {
+        this.query = details;
+    }
+
+    toSegment() {
+        return {
+            event: 'Products Searched',
+            properties: {
+                query: this.query
+            }
+        };
+    }
+}

package/src/storefront/promotion-clicked.js

@@ -0,0 +1,18 @@
+export default class PromotionClicked {
+    constructor(details) {
+        this.promotion = details[0];
+    }
+
+    toSegment() {
+        return {
+            event: 'Promotion Clicked',
+            properties: {
+                promotion_id: this.promotion.id?.toString(),
+                creative: this.promotion.creative,
+                name: this.promotion.name,
+                position: this.promotion.position
+            }
+        };
+    }
+
+} 

package/src/storefront/promotion-viewed.js

@@ -0,0 +1,18 @@
+export default class PromotionViewed {
+    constructor(details) {
+        this.promotion = details[0];
+    }
+
+    toSegment() {
+        return {
+            event: 'Promotion Viewed',
+            properties: {
+                promotion_id: this.promotion.id?.toString(),
+                creative: this.promotion.creative,
+                name: this.promotion.name,
+                position: this.promotion.position
+            }
+        };
+    }
+
+} 

package/src/storefront/recommendation-list-viewed.js

@@ -0,0 +1,22 @@
+import { mapProductFields } from './product-fields.js';
+
+export default class RecommendationListViewed {
+    constructor(details) {
+        this.products = details?.products ?? [];
+    }
+
+    toSegment() {
+        const currency = Salla.config.currency()?.code;
+        return {
+            event: 'Recommendation List Viewed',
+            properties: {
+                recommendation_type: 'fbt',
+                source: 'pdp_fbt',
+                products: this.products.map((p, i) => ({
+                    ...mapProductFields(p, i + 1, currency),
+                    variant: 'product',
+                })),
+            },
+        };
+    }
+}

package/src/storefront/signed-in.js

@@ -0,0 +1,29 @@
+export default class SignedIn {
+    constructor() {
+        this.user = JSON.parse(localStorage.getItem('user'));
+    }
+
+    toSegment() {
+        return {
+            event: 'Signed In',
+            properties: {
+                'first_name' : this.user?.first_name,
+                'last_name' : this.user?.last_name,
+                'type' : this.user?.type,
+                'mobile' : this.user?.mobile,
+                'email' : this.user?.email,
+            }
+        };
+    }
+
+    static shouldSend(){
+        if (Salla.config.get('user.type') === 'user') {
+            //TODO:: It's only workaround
+            return !Salla.analytics.history.find(({ eventName }) => eventName === 'Signed In');
+        }
+        //this is dynamic check to make sure the next time the user is fetched, the event is sent
+        //this is bad workaround because it's too much magic, we need to find a better way to handle this
+        Salla.profile.event.onInfoFetched(() => Salla.event.emit('Signed In'));
+        return false;
+    }
+}

package/src/storefront/signed-out.js

@@ -0,0 +1,10 @@
+export default class SignedOut {
+
+    toSegment() {
+        return {
+            event: 'Signed Out',
+            properties: {
+            }
+        };
+    }
+}

package/src/storefront/signed-up.js

@@ -0,0 +1,21 @@
+import SignedIn from './signed-in';
+export default class SignedUp extends SignedIn {
+
+    toSegment() {
+        const base = super.toSegment();
+        return {
+            event: 'Signed Up',
+            properties: base?.properties
+        };
+    }
+
+    static shouldSend() {
+        if (Salla.config.get('user.type') === 'user') {
+            return true;
+        }
+        //this is dynamic check to make sure the next time the user is fetched, the event is sent
+        //this is bad workaround because it's too much magic, we need to find a better way to handle this
+        Salla.profile.event.onInfoFetched(() => Salla.event.emit('Signed Up'));
+        return false;
+    }
+}

package/src/storefront/user-profile-updated.js

@@ -0,0 +1,44 @@
+export default class UserProfileUpdated {
+    static user = {};
+    
+    constructor(details) {
+        this.details = details?.data;
+    }
+
+    toSegment() {
+        const fieldsToCheck = ['first_name', 'last_name', 'birthday', 'gender'];
+        const updateFields = fieldsToCheck.filter(key => 
+            UserProfileUpdated.user[key] !== this.details?.[key] &&
+            (UserProfileUpdated.user[key] !== undefined || this.details?.[key] !== undefined)
+        );
+        UserProfileUpdated.setUser(this.details);
+        return {
+            event: 'User Profile Updated',
+            properties: {
+                updated_fields: updateFields
+            }
+        };
+    }
+
+    static registerEvent() {
+        Salla.onReady(() => {
+            if(salla.url.is_page('customer.profile')) {
+                UserProfileUpdated.setUser(Salla.config.get('user'));
+            }
+        });
+    }
+
+    static setUser(user){
+        UserProfileUpdated.user = {
+            first_name: user?.first_name,
+            last_name: user?.last_name,
+            gender: user?.gender,
+            birthday: user?.birthday,
+            avatar: user?.avatar
+        };
+    }
+
+    static shouldSend(){
+        return Salla.config.get('user.type') === 'user';
+    }
+}

package/src/storefront/wishlist-product-added-to-cart.js

@@ -0,0 +1,32 @@
+export default class WishlistProductAddedToCart {
+    constructor(details) {
+        this.item = details[0];
+    }
+
+    toSegment() {
+        return {
+            event: 'Wishlist Product Added to Cart',
+            properties: {
+                wishlist_id : salla.config.get('store.id') + '_' + salla.config.get('user.id'),
+                wishlist_name : salla.config.get('store.name'),
+                cart_id: this.item.cart_id?.toString(),
+                product_id: this.item.id?.toString(),
+                category: this.item.category,
+                name: this.item.name,
+                brand: this.item.brand,
+                variant: this.item.variant,
+                price: this.item.price,
+                quantity: this.item.quantity,
+                sku: this.item.sku,
+                coupon: this.item.coupon,
+                position: this.item.position,
+                url: this.item.url,
+                image_url: this.item.image_url
+            }
+        };
+    }
+
+    static shouldSend() {
+        return salla.config.get('page.slug') === 'customer.wishlist';
+    }
+}