@streamscloud/streams-analytics-collector 2.0.8 → 2.0.10

package/dist/analytics/app-events-tracker.d.ts

@@ -113,6 +113,34 @@ export declare class AppEventsTracker {
      * @param streamId - The ID of the stream
      */
     static trackStreamProductClicked(productId: string, streamId: string): void;
+    /**
+     * Track when a product in a stream is shown to the user (basic, immediate call)
+     * @param productId - The ID of the product
+     * @param streamId - The ID of the stream
+     */
+    static trackStreamProductImpression(productId: string, streamId: string): void;
+    /**
+     * Track when a product in a stream is shown to the user, using viewport visibility tracking.
+     * The impression event will only be fired if the element becomes visible (at least 50% in viewport).
+     * The event is only fired once per productId per session/visit.
+     *
+     * @param el - The DOM element to observe (e.g., the product element)
+     * @param productId - The unique product ID for this element
+     * @param streamId - The ID of the stream
+     */
+    static trackStreamProductImpressionWithVisibility(el: HTMLElement, productId: string, streamId: string): void;
+    /**
+     * Track when a product in a stream is added to cart
+     * @param productId - The ID of the product
+     * @param streamId - The ID of the stream
+     */
+    static trackStreamProductAddToCart(productId: string, streamId: string): void;
+    /**
+     * Track when a product in a stream is checked out
+     * @param productId - The ID of the product
+     * @param streamId - The ID of the stream
+     */
+    static trackStreamProductCheckout(productId: string, streamId: string): void;
     /**
      * Track when a post is closed
      * @param postId - The ID of the post
@@ -181,6 +209,18 @@ export declare class AppEventsTracker {
      * @param videoId - The ID of the short video containing the product
      */
     static trackShortVideoProductImpressionWithVisibility(el: HTMLElement, productId: string, videoId: string): void;
+    /**
+     * Track when a product in a short video is added to cart
+     * @param productId - The ID of the product
+     * @param videoId - The ID of the short video containing the product
+     */
+    static trackShortVideoProductAddToCart(productId: string, videoId: string): void;
+    /**
+     * Track when a product in a short video is checked out
+     * @param productId - The ID of the product
+     * @param videoId - The ID of the short video containing the product
+     */
+    static trackShortVideoProductCheckout(productId: string, videoId: string): void;
     /**
      * Report an app event to the API
      * @private

package/dist/analytics/app-events-tracker.js

@@ -184,6 +184,47 @@ class AppEventsTracker {
     static trackStreamProductClicked(productId, streamId) {
         this.reportAppEvent(productId, AppEventType.StreamProductClick, streamId);
     }
+    /**
+     * Track when a product in a stream is shown to the user (basic, immediate call)
+     * @param productId - The ID of the product
+     * @param streamId - The ID of the stream
+     */
+    static trackStreamProductImpression(productId, streamId) {
+        this.reportAppEvent(productId, AppEventType.StreamProductImpression, streamId);
+    }
+    /**
+     * Track when a product in a stream is shown to the user, using viewport visibility tracking.
+     * The impression event will only be fired if the element becomes visible (at least 50% in viewport).
+     * The event is only fired once per productId per session/visit.
+     *
+     * @param el - The DOM element to observe (e.g., the product element)
+     * @param productId - The unique product ID for this element
+     * @param streamId - The ID of the stream
+     */
+    static trackStreamProductImpressionWithVisibility(el, productId, streamId) {
+        if (!el || !productId || !streamId)
+            return;
+        ViewportVisibilityTracker.registerTile(el, productId, (pid) => {
+            this.reportAppEvent(pid, AppEventType.StreamProductImpression, streamId);
+        });
+        // The ViewportVisibilityTracker will call the callback when visible
+    }
+    /**
+     * Track when a product in a stream is added to cart
+     * @param productId - The ID of the product
+     * @param streamId - The ID of the stream
+     */
+    static trackStreamProductAddToCart(productId, streamId) {
+        this.reportAppEvent(productId, AppEventType.StreamProductAddToCart, streamId);
+    }
+    /**
+     * Track when a product in a stream is checked out
+     * @param productId - The ID of the product
+     * @param streamId - The ID of the stream
+     */
+    static trackStreamProductCheckout(productId, streamId) {
+        this.reportAppEvent(productId, AppEventType.StreamProductCheckout, streamId);
+    }
     /**
      * Track when a post is closed
      * @param postId - The ID of the post
@@ -298,6 +339,22 @@ class AppEventsTracker {
         });
         // The ViewportVisibilityTracker will call the callback when visible
     }
+    /**
+     * Track when a product in a short video is added to cart
+     * @param productId - The ID of the product
+     * @param videoId - The ID of the short video containing the product
+     */
+    static trackShortVideoProductAddToCart(productId, videoId) {
+        this.reportAppEvent(productId, AppEventType.ShortVideoProductAddToCart, videoId);
+    }
+    /**
+     * Track when a product in a short video is checked out
+     * @param productId - The ID of the product
+     * @param videoId - The ID of the short video containing the product
+     */
+    static trackShortVideoProductCheckout(productId, videoId) {
+        this.reportAppEvent(productId, AppEventType.ShortVideoProductCheckout, videoId);
+    }
     /**
      * Report an app event to the API
      * @private

package/dist/analytics/types.d.ts

@@ -5,11 +5,15 @@ export declare enum AppEventType {
     ContributionCreated = "CONTRIBUTION_CREATED",
     PostView = "POST_VIEW",
     ShortVideoImpression = "SHORT_VIDEO_IMPRESSION",
+    ShortVideoProductAddToCart = "SHORT_VIDEO_PRODUCT_ADD_TO_CART",
+    ShortVideoProductCheckout = "SHORT_VIDEO_PRODUCT_CHECKOUT",
     ShortVideoProductClick = "SHORT_VIDEO_PRODUCT_CLICK",
     ShortVideoProductImpression = "SHORT_VIDEO_PRODUCT_IMPRESSION",
     ShortVideoView = "SHORT_VIDEO_VIEW",
     StreamEngagementTime = "STREAM_ENGAGEMENT_TIME",
     StreamPageView = "STREAM_PAGE_VIEW",
+    StreamProductAddToCart = "STREAM_PRODUCT_ADD_TO_CART",
+    StreamProductCheckout = "STREAM_PRODUCT_CHECKOUT",
     StreamProductClick = "STREAM_PRODUCT_CLICK",
     StreamProductImpression = "STREAM_PRODUCT_IMPRESSION",
     StreamScrollDepth = "STREAM_SCROLL_DEPTH",

package/dist/analytics/types.js

@@ -6,11 +6,15 @@ var AppEventType;
     AppEventType["ContributionCreated"] = "CONTRIBUTION_CREATED";
     AppEventType["PostView"] = "POST_VIEW";
     AppEventType["ShortVideoImpression"] = "SHORT_VIDEO_IMPRESSION";
+    AppEventType["ShortVideoProductAddToCart"] = "SHORT_VIDEO_PRODUCT_ADD_TO_CART";
+    AppEventType["ShortVideoProductCheckout"] = "SHORT_VIDEO_PRODUCT_CHECKOUT";
     AppEventType["ShortVideoProductClick"] = "SHORT_VIDEO_PRODUCT_CLICK";
     AppEventType["ShortVideoProductImpression"] = "SHORT_VIDEO_PRODUCT_IMPRESSION";
     AppEventType["ShortVideoView"] = "SHORT_VIDEO_VIEW";
     AppEventType["StreamEngagementTime"] = "STREAM_ENGAGEMENT_TIME";
     AppEventType["StreamPageView"] = "STREAM_PAGE_VIEW";
+    AppEventType["StreamProductAddToCart"] = "STREAM_PRODUCT_ADD_TO_CART";
+    AppEventType["StreamProductCheckout"] = "STREAM_PRODUCT_CHECKOUT";
     AppEventType["StreamProductClick"] = "STREAM_PRODUCT_CLICK";
     AppEventType["StreamProductImpression"] = "STREAM_PRODUCT_IMPRESSION";
     AppEventType["StreamScrollDepth"] = "STREAM_SCROLL_DEPTH";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamscloud/streams-analytics-collector",
-  "version": "2.0.8",
+  "version": "2.0.10",
   "type": "module",
   "main": "dist/index.js",
   "module": "dist/index.js",