@streamscloud/streams-analytics-collector 1.0.6 → 1.0.8

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

@@ -6,6 +6,7 @@ import type { Client } from '@urql/core';
 export declare class AppEventsTracker {
     private static reported;
     private static playedPercentsByPost;
+    private static videosByPage;
     private static gqlEndpoint;
     private static client;
     private static organizationId;
@@ -31,6 +32,20 @@ export declare class AppEventsTracker {
      * @param profileId - The profile ID
      */
     static setProfileId(profileId: string): void;
+    /**
+     * Track the progress of a short video within a page
+     * @param pageId - The ID of the page containing the video
+     * @param videoId - The ID of the video
+     * @param playedPercents - The percentage of the video that has been played
+     * @param streamId - The ID of the stream containing the video (optional)
+     */
+    static trackShortVideoProgress(pageId: string, videoId: string, playedPercents: number, streamId?: string): void;
+    /**
+     * Report all video views for a page when it's deactivated
+     * @param pageId - The ID of the page that's being deactivated
+     * @param streamId - The ID of the stream containing the page (optional)
+     */
+    static reportPageVideoViews(pageId: string, streamId?: string): void;
     /**
      * Track when a post is opened
      * @param postId - The ID of the post
@@ -41,8 +56,9 @@ export declare class AppEventsTracker {
      * Track when a post is being played
      * @param postId - The ID of the post
      * @param playedPercents - The percentage of the post that has been played
+     * @deprecated Consider using trackShortVideoProgress for better tracking of multiple videos
      */
-    static trackPostPlaying(postId: string, playedPercents: number): void;
+    static reportVideoPostPlayingProgress(postId: string, playedPercents: number): void;
     /**
      * Track when a community message is opened
      * @param messageId - The ID of the message
@@ -92,6 +108,7 @@ export declare class AppEventsTracker {
      * Track when a post is closed
      * @param postId - The ID of the post
      * @param streamId - The ID of the stream
+     * @deprecated Consider using trackShortVideoProgress and reportPageVideoViews for better tracking of multiple videos
      */
     static trackClosed(postId: string, streamId: string): void;
     /**

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

@@ -8,6 +8,8 @@ import AnalyticsQuery from '../analytics.graphql.js';
 class AppEventsTracker {
     static reported = [];
     static playedPercentsByPost = new Map();
+    // Store video data by page ID to handle multiple videos per page
+    static videosByPage = new Map();
     static gqlEndpoint = '';
     static client;
     static organizationId;
@@ -43,6 +45,46 @@ class AppEventsTracker {
     static setProfileId(profileId) {
         this.profileId = profileId;
     }
+    /**
+     * Track the progress of a short video within a page
+     * @param pageId - The ID of the page containing the video
+     * @param videoId - The ID of the video
+     * @param playedPercents - The percentage of the video that has been played
+     * @param streamId - The ID of the stream containing the video (optional)
+     */
+    static trackShortVideoProgress(pageId, videoId, playedPercents, streamId) {
+        // Initialize page map if it doesn't exist
+        if (!this.videosByPage.has(pageId)) {
+            this.videosByPage.set(pageId, new Map());
+        }
+        // Update the played percentage for this video on this page
+        // Only store the maximum percentage in case of looping videos
+        const pageVideos = this.videosByPage.get(pageId);
+        if (pageVideos) {
+            const videoKey = `${videoId}|${streamId || ''}`;
+            const currentMaxPercent = pageVideos.get(videoKey) || 0;
+            // Store only the maximum played percentage value
+            // This ensures we don't decrease progress when video loops
+            pageVideos.set(videoKey, Math.max(currentMaxPercent, playedPercents));
+        }
+    }
+    /**
+     * Report all video views for a page when it's deactivated
+     * @param pageId - The ID of the page that's being deactivated
+     * @param streamId - The ID of the stream containing the page (optional)
+     */
+    static reportPageVideoViews(pageId, streamId) {
+        const pageVideos = this.videosByPage.get(pageId);
+        if (pageVideos) {
+            // Report all video views for this page
+            pageVideos.forEach((playedPercents, videoKey) => {
+                const [videoId, videoStreamId] = videoKey.split('|');
+                this.reportAppEvent(videoId, AppEventType.ShortVideoView, videoStreamId || streamId, playedPercents);
+            });
+            // Clean up the tracking data for this page
+            this.videosByPage.delete(pageId);
+        }
+    }
     /**
      * Track when a post is opened
      * @param postId - The ID of the post
@@ -55,14 +97,11 @@ class AppEventsTracker {
      * Track when a post is being played
      * @param postId - The ID of the post
      * @param playedPercents - The percentage of the post that has been played
+     * @deprecated Consider using trackShortVideoProgress for better tracking of multiple videos
      */
-    static trackPostPlaying(postId, playedPercents) {
+    static reportVideoPostPlayingProgress(postId, playedPercents) {
         // Store the latest played percentage for this post
         this.playedPercentsByPost.set(postId, playedPercents);
-        // Only report the event if not already reported and past the minimum threshold
-        if (playedPercents > 0.2 && this.reported.indexOf(postId) === -1) {
-            this.reported.push(postId);
-        }
     }
     /**
      * Track when a community message is opened
@@ -131,6 +170,7 @@ class AppEventsTracker {
      * Track when a post is closed
      * @param postId - The ID of the post
      * @param streamId - The ID of the stream
+     * @deprecated Consider using trackShortVideoProgress and reportPageVideoViews for better tracking of multiple videos
      */
     static trackClosed(postId, streamId) {
         // Get the stored played percentage for this post

package/package.json

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