@streamscloud/streams-analytics-collector 1.0.5 → 1.0.7

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

@@ -5,6 +5,8 @@ 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;
@@ -30,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
@@ -40,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
@@ -90,8 +107,10 @@ 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): void;
+    static trackClosed(postId: string, streamId: string): void;
     /**
      * Report an app event to the API
      * @private

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

@@ -7,6 +7,9 @@ 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;
@@ -42,6 +45,41 @@ 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
+        const pageVideos = this.videosByPage.get(pageId);
+        if (pageVideos) {
+            pageVideos.set(`${videoId}|${streamId || ''}`, 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
@@ -54,11 +92,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) {
-        if (playedPercents > 0.2 && this.reported.indexOf(postId) === -1) {
-            this.reportAppEvent(postId, AppEventType.PostView);
-        }
+    static reportVideoPostPlayingProgress(postId, playedPercents) {
+        // Store the latest played percentage for this post
+        this.playedPercentsByPost.set(postId, playedPercents);
     }
     /**
      * Track when a community message is opened
@@ -126,8 +164,18 @@ 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) {
+    static trackClosed(postId, streamId) {
+        // Get the stored played percentage for this post
+        const playedPercents = this.playedPercentsByPost.get(postId);
+        // Report the final ShortVideoView event with the final played percentage when video is stopped
+        if (playedPercents !== undefined) {
+            this.reportAppEvent(postId, AppEventType.ShortVideoView, streamId, playedPercents);
+        }
+        // Clean up stored data for this post
+        this.playedPercentsByPost.delete(postId);
         const postIndex = this.reported.indexOf(postId);
         if (postIndex >= 0) {
             this.reported.splice(postIndex, 1);
@@ -175,13 +223,6 @@ class AppEventsTracker {
                 console.warn('An attempt to save app event without initializing GraphQL client detected');
                 return;
             }
-            //   const mutation = `
-            //     mutation TrackAppEvent($input: TrackAppEventInput!) {
-            //       trackAppEvent(input: $input) {
-            //         void
-            //       }
-            //     }
-            //   `;
             await this.client
                 .mutation(AnalyticsQuery, { input })
                 .toPromise();
@@ -191,13 +232,6 @@ class AppEventsTracker {
                 console.warn('An attempt to save app event without initializing GraphQL endpoint detected');
                 return;
             }
-            //   const query = `
-            //     mutation TrackAppEvent($input: TrackAppEventInput!) {
-            //       trackAppEvent(input: $input) {
-            //         void
-            //       }
-            //     }
-            //   `;
             await this.queryGql(AnalyticsQuery, { input });
         }
     }

package/dist/analytics/types.d.ts

@@ -1,5 +1,6 @@
 export declare enum AppEventType {
     PostView = "POST_VIEW",
+    ShortVideoView = "SHORT_VIDEO_VIEW",
     CommunityMessageView = "COMMUNITY_MESSAGE_VIEW",
     StreamTileImpression = "STREAM_TILE_IMPRESSION",
     StreamTileClick = "STREAM_TILE_CLICK",

package/dist/analytics/types.js

@@ -1,6 +1,7 @@
 var AppEventType;
 (function (AppEventType) {
     AppEventType["PostView"] = "POST_VIEW";
+    AppEventType["ShortVideoView"] = "SHORT_VIDEO_VIEW";
     AppEventType["CommunityMessageView"] = "COMMUNITY_MESSAGE_VIEW";
     AppEventType["StreamTileImpression"] = "STREAM_TILE_IMPRESSION";
     AppEventType["StreamTileClick"] = "STREAM_TILE_CLICK";

package/package.json

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