@streamscloud/streams-analytics-collector 2.0.5 → 2.0.7

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

@@ -139,6 +139,48 @@ export declare class AppEventsTracker {
      * @param adId - The unique ad ID for this element
      */
     static trackAdImpressionWithVisibility(el: HTMLElement, adId: string): void;
+    /**
+     * Track when a short video is shown to the user (basic, immediate call)
+     * @param videoId - The ID of the short video
+     */
+    static trackShortVideoImpression(videoId: string): void;
+    /**
+     * Track when a short video 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 videoId per session/visit.
+     *
+     * @param el - The DOM element to observe (e.g., the video element)
+     * @param videoId - The unique video ID for this element
+     */
+    static trackShortVideoImpressionWithVisibility(el: HTMLElement, videoId: string): void;
+    /**
+     * Track when a short video is viewed by the user
+     * @param videoId - The ID of the short video
+     * @param playedPercents - The percentage of the video that was played (optional)
+     */
+    static trackShortVideoView(videoId: string): void;
+    /**
+     * Track when a product in a short video is clicked
+     * @param productId - The ID of the product
+     * @param videoId - The ID of the short video containing the product
+     */
+    static trackShortVideoProductClick(productId: string, videoId: string): void;
+    /**
+     * Track when a product in a short video is shown to the user (basic, immediate call)
+     * @param productId - The ID of the product
+     * @param videoId - The ID of the short video containing the product
+     */
+    static trackShortVideoProductImpression(productId: string, videoId: string): void;
+    /**
+     * Track when a product in a short video 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 videoId - The ID of the short video containing the product
+     */
+    static trackShortVideoProductImpressionWithVisibility(el: HTMLElement, productId: string, videoId: string): void;
     /**
      * Report an app event to the API
      * @private

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

@@ -234,6 +234,70 @@ class AppEventsTracker {
         });
         // The ViewportVisibilityTracker will call the callback when visible
     }
+    /**
+     * Track when a short video is shown to the user (basic, immediate call)
+     * @param videoId - The ID of the short video
+     */
+    static trackShortVideoImpression(videoId) {
+        this.reportAppEvent(videoId, AppEventType.ShortVideoImpression);
+    }
+    /**
+     * Track when a short video 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 videoId per session/visit.
+     *
+     * @param el - The DOM element to observe (e.g., the video element)
+     * @param videoId - The unique video ID for this element
+     */
+    static trackShortVideoImpressionWithVisibility(el, videoId) {
+        if (!el || !videoId)
+            return;
+        ViewportVisibilityTracker.registerTile(el, videoId, (vid) => {
+            this.reportAppEvent(vid, AppEventType.ShortVideoImpression);
+        });
+        // The ViewportVisibilityTracker will call the callback when visible
+    }
+    /**
+     * Track when a short video is viewed by the user
+     * @param videoId - The ID of the short video
+     * @param playedPercents - The percentage of the video that was played (optional)
+     */
+    static trackShortVideoView(videoId) {
+        this.reportAppEvent(videoId, AppEventType.ShortVideoView);
+    }
+    /**
+     * Track when a product in a short video is clicked
+     * @param productId - The ID of the product
+     * @param videoId - The ID of the short video containing the product
+     */
+    static trackShortVideoProductClick(productId, videoId) {
+        this.reportAppEvent(productId, AppEventType.ShortVideoProductClick, videoId);
+    }
+    /**
+     * Track when a product in a short video is shown to the user (basic, immediate call)
+     * @param productId - The ID of the product
+     * @param videoId - The ID of the short video containing the product
+     */
+    static trackShortVideoProductImpression(productId, videoId) {
+        this.reportAppEvent(productId, AppEventType.ShortVideoProductImpression, videoId);
+    }
+    /**
+     * Track when a product in a short video 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 videoId - The ID of the short video containing the product
+     */
+    static trackShortVideoProductImpressionWithVisibility(el, productId, videoId) {
+        if (!el || !productId || !videoId)
+            return;
+        ViewportVisibilityTracker.registerTile(el, productId, (pid) => {
+            this.reportAppEvent(pid, AppEventType.ShortVideoProductImpression, videoId);
+        });
+        // The ViewportVisibilityTracker will call the callback when visible
+    }
     /**
      * Report an app event to the API
      * @private

package/dist/analytics/types.d.ts

@@ -1,16 +1,21 @@
 export declare enum AppEventType {
+    AdClick = "AD_CLICK",
+    AdImpression = "AD_IMPRESSION",
+    CommunityMessageView = "COMMUNITY_MESSAGE_VIEW",
+    ContributionCreated = "CONTRIBUTION_CREATED",
     PostView = "POST_VIEW",
+    ShortVideoImpression = "SHORT_VIDEO_IMPRESSION",
+    ShortVideoProductClick = "SHORT_VIDEO_PRODUCT_CLICK",
+    ShortVideoProductImpression = "SHORT_VIDEO_PRODUCT_IMPRESSION",
     ShortVideoView = "SHORT_VIDEO_VIEW",
-    CommunityMessageView = "COMMUNITY_MESSAGE_VIEW",
-    StreamTileImpression = "STREAM_TILE_IMPRESSION",
-    StreamTileClick = "STREAM_TILE_CLICK",
-    StreamView = "STREAM_VIEW",
     StreamEngagementTime = "STREAM_ENGAGEMENT_TIME",
-    StreamScrollDepth = "STREAM_SCROLL_DEPTH",
     StreamPageView = "STREAM_PAGE_VIEW",
     StreamProductClick = "STREAM_PRODUCT_CLICK",
-    AdImpression = "AD_IMPRESSION",
-    AdClick = "AD_CLICK"
+    StreamProductImpression = "STREAM_PRODUCT_IMPRESSION",
+    StreamScrollDepth = "STREAM_SCROLL_DEPTH",
+    StreamTileClick = "STREAM_TILE_CLICK",
+    StreamTileImpression = "STREAM_TILE_IMPRESSION",
+    StreamView = "STREAM_VIEW"
 }
 export declare enum CommunityMessageStatus {
     Sent = "SENT",

package/dist/analytics/types.js

@@ -1,17 +1,22 @@
 var AppEventType;
 (function (AppEventType) {
+    AppEventType["AdClick"] = "AD_CLICK";
+    AppEventType["AdImpression"] = "AD_IMPRESSION";
+    AppEventType["CommunityMessageView"] = "COMMUNITY_MESSAGE_VIEW";
+    AppEventType["ContributionCreated"] = "CONTRIBUTION_CREATED";
     AppEventType["PostView"] = "POST_VIEW";
+    AppEventType["ShortVideoImpression"] = "SHORT_VIDEO_IMPRESSION";
+    AppEventType["ShortVideoProductClick"] = "SHORT_VIDEO_PRODUCT_CLICK";
+    AppEventType["ShortVideoProductImpression"] = "SHORT_VIDEO_PRODUCT_IMPRESSION";
     AppEventType["ShortVideoView"] = "SHORT_VIDEO_VIEW";
-    AppEventType["CommunityMessageView"] = "COMMUNITY_MESSAGE_VIEW";
-    AppEventType["StreamTileImpression"] = "STREAM_TILE_IMPRESSION";
-    AppEventType["StreamTileClick"] = "STREAM_TILE_CLICK";
-    AppEventType["StreamView"] = "STREAM_VIEW";
     AppEventType["StreamEngagementTime"] = "STREAM_ENGAGEMENT_TIME";
-    AppEventType["StreamScrollDepth"] = "STREAM_SCROLL_DEPTH";
     AppEventType["StreamPageView"] = "STREAM_PAGE_VIEW";
     AppEventType["StreamProductClick"] = "STREAM_PRODUCT_CLICK";
-    AppEventType["AdImpression"] = "AD_IMPRESSION";
-    AppEventType["AdClick"] = "AD_CLICK";
+    AppEventType["StreamProductImpression"] = "STREAM_PRODUCT_IMPRESSION";
+    AppEventType["StreamScrollDepth"] = "STREAM_SCROLL_DEPTH";
+    AppEventType["StreamTileClick"] = "STREAM_TILE_CLICK";
+    AppEventType["StreamTileImpression"] = "STREAM_TILE_IMPRESSION";
+    AppEventType["StreamView"] = "STREAM_VIEW";
 })(AppEventType || (AppEventType = {}));
 var CommunityMessageStatus;
 (function (CommunityMessageStatus) {

package/package.json

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