@streamlayer/sl-eslib 5.88.1 → 5.89.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamlayer/sl-eslib",
-  "version": "5.88.1",
+  "version": "5.89.0",
   "publishConfig": {
     "access": "public"
   },

package/streamlayer/analytics/v2/common/analytics.common_pb.d.ts

@@ -0,0 +1,47 @@
+// @generated by protoc-gen-es v1.6.0 with parameter "target=js+dts"
+// @generated from file streamlayer/analytics/v2/common/analytics.common.proto (package streamlayer.analytics.v2.common, syntax proto3)
+/* eslint-disable */
+// @ts-nocheck
+
+import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage } from "@bufbuild/protobuf";
+import { Message, proto3 } from "@bufbuild/protobuf";
+
+/**
+ * @generated from message streamlayer.analytics.v2.common.CardStatistics
+ */
+export declare class CardStatistics extends Message<CardStatistics> {
+  /**
+   * @generated from field: int32 total = 1;
+   */
+  total: number;
+
+  /**
+   * @generated from field: int32 viewed = 2;
+   */
+  viewed: number;
+
+  /**
+   * @generated from field: int32 opened = 3;
+   */
+  opened: number;
+
+  /**
+   * @generated from field: int32 answered = 4;
+   */
+  answered: number;
+
+  constructor(data?: PartialMessage<CardStatistics>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "streamlayer.analytics.v2.common.CardStatistics";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): CardStatistics;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): CardStatistics;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): CardStatistics;
+
+  static equals(a: CardStatistics | PlainMessage<CardStatistics> | undefined, b: CardStatistics | PlainMessage<CardStatistics> | undefined): boolean;
+}
+

package/streamlayer/analytics/v2/common/analytics.common_pb.js

@@ -0,0 +1,20 @@
+// @generated by protoc-gen-es v1.6.0 with parameter "target=js+dts"
+// @generated from file streamlayer/analytics/v2/common/analytics.common.proto (package streamlayer.analytics.v2.common, syntax proto3)
+/* eslint-disable */
+// @ts-nocheck
+
+import { proto3 } from "@bufbuild/protobuf";
+
+/**
+ * @generated from message streamlayer.analytics.v2.common.CardStatistics
+ */
+export const CardStatistics = proto3.makeMessageType(
+  "streamlayer.analytics.v2.common.CardStatistics",
+  () => [
+    { no: 1, name: "total", kind: "scalar", T: 5 /* ScalarType.INT32 */ },
+    { no: 2, name: "viewed", kind: "scalar", T: 5 /* ScalarType.INT32 */ },
+    { no: 3, name: "opened", kind: "scalar", T: 5 /* ScalarType.INT32 */ },
+    { no: 4, name: "answered", kind: "scalar", T: 5 /* ScalarType.INT32 */ },
+  ],
+);
+

package/streamlayer/analytics/v2/studio/dashboard_pb.d.ts

@@ -6,6 +6,27 @@
 import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage } from "@bufbuild/protobuf";
 import { Message, proto3 } from "@bufbuild/protobuf";
 import type { Period, TopicType } from "../../v1/common/analytics.common_pb.js";
+import type { CardStatistics } from "../common/analytics.common_pb.js";
+
+/**
+ * @generated from enum streamlayer.analytics.v2.studio.WpType
+ */
+export declare enum WpType {
+  /**
+   * @generated from enum value: WP_TYPE_UNSET = 0;
+   */
+  UNSET = 0,
+
+  /**
+   * @generated from enum value: WP_TYPE_WP = 1;
+   */
+  WP = 1,
+
+  /**
+   * @generated from enum value: WP_TYPE_FWP = 2;
+   */
+  FWP = 2,
+}
 
 /**
  * @generated from enum streamlayer.analytics.v2.studio.AggPeriod
@@ -115,7 +136,7 @@ export declare class DashboardOverviewResponseData extends Message<DashboardOver
   interactionsPerEngagedUser: number;
 
   /**
-   * WP metrics
+   * WP/FWP metrics
    *
    * Total Watch Parties Started (EMetric.TotalWpStarted)
    *
@@ -230,105 +251,6 @@ export declare class DashboardOverviewResponseData extends Message<DashboardOver
    */
   totalUsersStartedWp: number;
 
-  /**
-   * FWP metrics
-   *
-   * Total Users Engaged with FWP chat (w/o using consecutive Sessions)
-   *
-   * @generated from field: int32 total_fwp_chat_participants = 30;
-   */
-  totalFwpChatParticipants: number;
-
-  /**
-   * --- FWP room (chat + WP) ---
-   *
-   * [28. Total time spent in Fantasy League Rooms (h)] (totalTimeSpentInFantasyRooms)
-   *
-   * @generated from field: int32 total_users_engaged_with_fwp_room = 31;
-   */
-  totalUsersEngagedWithFwpRoom: number;
-
-  /**
-   * [29. Average time spent in Fantasy League room per Viewer (min)] // Average Minutes at FWP2+ (active FWP) room
-   *
-   * @generated from field: double avg_active_fwp_room_session_duration = 32;
-   */
-  avgActiveFwpRoomSessionDuration: number;
-
-  /**
-   * --- FWP WP ---
-   *
-   * Total Fantasy Watch Parties Started
-   *
-   * @generated from field: int32 total_fwp_started = 33;
-   */
-  totalFwpStarted: number;
-
-  /**
-   * EMetric.TotalActiveFwps
-   *
-   * @generated from field: int32 active_fwps = 34;
-   */
-  activeFwps: number;
-
-  /**
-   * EMetric.TotalUsersEngagedWithFwp2plus
-   *
-   * @generated from field: int32 users_engaged_with_active_fwp = 35;
-   */
-  usersEngagedWithActiveFwp: number;
-
-  /**
-   * EMetric.AvgParticipantsFwp2plus
-   *
-   * @generated from field: double avg_users_active_fwp = 36;
-   */
-  avgUsersActiveFwp: number;
-
-  /**
-   * Total minutes in FWP 2+ with X Participants
-   *
-   * totalMinFwp2Users (EMetric.TotalMinInFwp2plus2participants)
-   *
-   * @generated from field: double total_min_fwp2_users = 37;
-   */
-  totalMinFwp2Users: number;
-
-  /**
-   * @generated from field: double total_min_fwp3_users = 38;
-   */
-  totalMinFwp3Users: number;
-
-  /**
-   * @generated from field: double total_min_fwp4_users = 39;
-   */
-  totalMinFwp4Users: number;
-
-  /**
-   * @generated from field: double total_min_fwp5_users = 40;
-   */
-  totalMinFwp5Users: number;
-
-  /**
-   * @generated from field: double total_min_fwp6_users = 41;
-   */
-  totalMinFwp6Users: number;
-
-  /**
-   * @generated from field: double total_min_fwp7_users = 42;
-   */
-  totalMinFwp7Users: number;
-
-  /**
-   * @generated from field: double total_min_fwp8_users = 43;
-   */
-  totalMinFwp8Users: number;
-
-  /**
-   * @generated from field: double total_min_fwp9_users = 44;
-   */
-  totalMinFwp9Users: number;
-
   constructor(data?: PartialMessage<DashboardOverviewResponseData>);
 
   static readonly runtime: typeof proto3;
@@ -349,9 +271,9 @@ export declare class DashboardOverviewResponseData extends Message<DashboardOver
  */
 export declare class DashboardOverviewRequestFilter extends Message<DashboardOverviewRequestFilter> {
   /**
-   * @generated from field: string organization_id = 1;
+   * @generated from field: optional string organization_id = 1;
    */
-  organizationId: string;
+  organizationId?: string;
 
   /**
    * @generated from field: repeated uint64 event_ids = 2;
@@ -364,9 +286,9 @@ export declare class DashboardOverviewRequestFilter extends Message<DashboardOve
   period?: Period;
 
   /**
-   * @generated from field: string date = 4;
+   * @generated from field: optional string date = 4;
    */
-  date: string;
+  date?: string;
 
   /**
    * @generated from field: repeated string countries = 5;
@@ -374,14 +296,20 @@ export declare class DashboardOverviewRequestFilter extends Message<DashboardOve
   countries: string[];
 
   /**
-   * @generated from field: bool live_metrics = 6;
+   * @generated from field: optional bool live_metrics = 6;
+   */
+  liveMetrics?: boolean;
+
+  /**
+   * @generated from field: optional bool fwp = 7 [deprecated = true];
+   * @deprecated
    */
-  liveMetrics: boolean;
+  fwp?: boolean;
 
   /**
-   * @generated from field: bool fwp = 7;
+   * @generated from field: optional streamlayer.analytics.v2.studio.WpType wp_type = 8;
    */
-  fwp: boolean;
+  wpType?: WpType;
 
   constructor(data?: PartialMessage<DashboardOverviewRequestFilter>);
 
@@ -475,9 +403,9 @@ export declare class DashboardOverviewResponse_DashboardOverviewResponseMeta ext
  */
 export declare class FeaturedGroupsRequestFilter extends Message<FeaturedGroupsRequestFilter> {
   /**
-   * @generated from field: string organization_id = 1;
+   * @generated from field: optional string organization_id = 1;
    */
-  organizationId: string;
+  organizationId?: string;
 
   /**
    * @generated from field: repeated uint64 event_ids = 2;
@@ -562,6 +490,41 @@ export declare class FeaturedGroupsResponseData extends Message<FeaturedGroupsRe
    */
   averagePromptsOpenedPerEngagedViewer: number;
 
+  /**
+   * @generated from field: int32 total_prompts_opened = 7;
+   */
+  totalPromptsOpened: number;
+
+  /**
+   * @generated from field: int32 total_interactions = 8;
+   */
+  totalInteractions: number;
+
+  /**
+   * @generated from field: streamlayer.analytics.v2.common.CardStatistics poll_card = 9;
+   */
+  pollCard?: CardStatistics;
+
+  /**
+   * @generated from field: streamlayer.analytics.v2.common.CardStatistics trivia_card = 10;
+   */
+  triviaCard?: CardStatistics;
+
+  /**
+   * @generated from field: streamlayer.analytics.v2.common.CardStatistics prediction_card = 11;
+   */
+  predictionCard?: CardStatistics;
+
+  /**
+   * @generated from field: streamlayer.analytics.v2.common.CardStatistics factoid_card = 12;
+   */
+  factoidCard?: CardStatistics;
+
+  /**
+   * @generated from field: streamlayer.analytics.v2.common.CardStatistics twitter_card = 13;
+   */
+  twitterCard?: CardStatistics;
+
   constructor(data?: PartialMessage<FeaturedGroupsResponseData>);
 
   static readonly runtime: typeof proto3;
@@ -630,9 +593,9 @@ export declare class FeaturedGroupsResponse_FeaturedGroupsResponseMeta extends M
  */
 export declare class MetricsByTimeLineRequestFilter extends Message<MetricsByTimeLineRequestFilter> {
   /**
-   * @generated from field: string organization_id = 1;
+   * @generated from field: optional string organization_id = 1;
    */
-  organizationId: string;
+  organizationId?: string;
 
   /**
    * @generated from field: repeated uint64 event_ids = 2;
@@ -645,14 +608,14 @@ export declare class MetricsByTimeLineRequestFilter extends Message<MetricsByTim
   countries: string[];
 
   /**
-   * @generated from field: streamlayer.analytics.v1.common.Period period = 4;
+   * @generated from field: optional streamlayer.analytics.v1.common.Period period = 4;
    */
   period?: Period;
 
   /**
-   * @generated from field: string date = 5;
+   * @generated from field: optional string date = 5;
    */
-  date: string;
+  date?: string;
 
   /**
    * @generated from field: streamlayer.analytics.v2.studio.AggPeriod agg_period = 6;
@@ -859,9 +822,9 @@ export declare class UsersByTimeLineRequest extends Message<UsersByTimeLineReque
  */
 export declare class PollsStatsByTimeLineRequestFilter extends Message<PollsStatsByTimeLineRequestFilter> {
   /**
-   * @generated from field: string organization_id = 1;
+   * @generated from field: optional string organization_id = 1;
    */
-  organizationId: string;
+  organizationId?: string;
 
   /**
    * @generated from field: uint64 event_id = 2;
@@ -874,7 +837,9 @@ export declare class PollsStatsByTimeLineRequestFilter extends Message<PollsStat
   countries: string[];
 
   /**
-   * @generated from field: streamlayer.analytics.v1.common.Period period = 4;
+   * dafault now() - interval 1H
+   *
+   * @generated from field: optional streamlayer.analytics.v1.common.Period period = 4;
    */
   period?: Period;
 
@@ -884,9 +849,9 @@ export declare class PollsStatsByTimeLineRequestFilter extends Message<PollsStat
   aggPeriod: AggPeriod;
 
   /**
-   * @generated from field: streamlayer.analytics.v1.common.TopicType topic_type = 6;
+   * @generated from field: optional streamlayer.analytics.v1.common.TopicType topic_type = 6;
    */
-  topicType: TopicType;
+  topicType?: TopicType;
 
   constructor(data?: PartialMessage<PollsStatsByTimeLineRequestFilter>);
 
@@ -1287,9 +1252,9 @@ export declare class DeviceInteractionsByTimeLineResponse_DeviceInteractionsByTi
  */
 export declare class ListCountriesRequestFilter extends Message<ListCountriesRequestFilter> {
   /**
-   * @generated from field: string organization_id = 1;
+   * @generated from field: optional string organization_id = 1;
    */
-  organizationId: string;
+  organizationId?: string;
 
   constructor(data?: PartialMessage<ListCountriesRequestFilter>);
 

package/streamlayer/analytics/v2/studio/dashboard_pb.js

@@ -5,6 +5,19 @@
 
 import { proto3 } from "@bufbuild/protobuf";
 import { Period, TopicType } from "../../v1/common/analytics.common_pb.js";
+import { CardStatistics } from "../common/analytics.common_pb.js";
+
+/**
+ * @generated from enum streamlayer.analytics.v2.studio.WpType
+ */
+export const WpType = proto3.makeEnum(
+  "streamlayer.analytics.v2.studio.WpType",
+  [
+    {no: 0, name: "WP_TYPE_UNSET", localName: "UNSET"},
+    {no: 1, name: "WP_TYPE_WP", localName: "WP"},
+    {no: 2, name: "WP_TYPE_FWP", localName: "FWP"},
+  ],
+);
 
 /**
  * @generated from enum streamlayer.analytics.v2.studio.AggPeriod
@@ -51,21 +64,6 @@ export const DashboardOverviewResponseData = proto3.makeMessageType(
     { no: 22, name: "total_min_wp8_users", kind: "scalar", T: 1 /* ScalarType.DOUBLE */ },
     { no: 23, name: "total_min_wp9_users", kind: "scalar", T: 1 /* ScalarType.DOUBLE */ },
     { no: 24, name: "total_users_started_wp", kind: "scalar", T: 5 /* ScalarType.INT32 */ },
-    { no: 30, name: "total_fwp_chat_participants", kind: "scalar", T: 5 /* ScalarType.INT32 */ },
-    { no: 31, name: "total_users_engaged_with_fwp_room", kind: "scalar", T: 5 /* ScalarType.INT32 */ },
-    { no: 32, name: "avg_active_fwp_room_session_duration", kind: "scalar", T: 1 /* ScalarType.DOUBLE */ },
-    { no: 33, name: "total_fwp_started", kind: "scalar", T: 5 /* ScalarType.INT32 */ },
-    { no: 34, name: "active_fwps", kind: "scalar", T: 5 /* ScalarType.INT32 */ },
-    { no: 35, name: "users_engaged_with_active_fwp", kind: "scalar", T: 5 /* ScalarType.INT32 */ },
-    { no: 36, name: "avg_users_active_fwp", kind: "scalar", T: 1 /* ScalarType.DOUBLE */ },
-    { no: 37, name: "total_min_fwp2_users", kind: "scalar", T: 1 /* ScalarType.DOUBLE */ },
-    { no: 38, name: "total_min_fwp3_users", kind: "scalar", T: 1 /* ScalarType.DOUBLE */ },
-    { no: 39, name: "total_min_fwp4_users", kind: "scalar", T: 1 /* ScalarType.DOUBLE */ },
-    { no: 40, name: "total_min_fwp5_users", kind: "scalar", T: 1 /* ScalarType.DOUBLE */ },
-    { no: 41, name: "total_min_fwp6_users", kind: "scalar", T: 1 /* ScalarType.DOUBLE */ },
-    { no: 42, name: "total_min_fwp7_users", kind: "scalar", T: 1 /* ScalarType.DOUBLE */ },
-    { no: 43, name: "total_min_fwp8_users", kind: "scalar", T: 1 /* ScalarType.DOUBLE */ },
-    { no: 44, name: "total_min_fwp9_users", kind: "scalar", T: 1 /* ScalarType.DOUBLE */ },
   ],
 );
 
@@ -75,13 +73,14 @@ export const DashboardOverviewResponseData = proto3.makeMessageType(
 export const DashboardOverviewRequestFilter = proto3.makeMessageType(
   "streamlayer.analytics.v2.studio.DashboardOverviewRequestFilter",
   () => [
-    { no: 1, name: "organization_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 1, name: "organization_id", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
     { no: 2, name: "event_ids", kind: "scalar", T: 4 /* ScalarType.UINT64 */, repeated: true },
     { no: 3, name: "period", kind: "message", T: Period },
-    { no: 4, name: "date", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 4, name: "date", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
     { no: 5, name: "countries", kind: "scalar", T: 9 /* ScalarType.STRING */, repeated: true },
-    { no: 6, name: "live_metrics", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
-    { no: 7, name: "fwp", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
+    { no: 6, name: "live_metrics", kind: "scalar", T: 8 /* ScalarType.BOOL */, opt: true },
+    { no: 7, name: "fwp", kind: "scalar", T: 8 /* ScalarType.BOOL */, opt: true },
+    { no: 8, name: "wp_type", kind: "enum", T: proto3.getEnumType(WpType), opt: true },
   ],
 );
 
@@ -121,7 +120,7 @@ export const DashboardOverviewResponse_DashboardOverviewResponseMeta = proto3.ma
 export const FeaturedGroupsRequestFilter = proto3.makeMessageType(
   "streamlayer.analytics.v2.studio.FeaturedGroupsRequestFilter",
   () => [
-    { no: 1, name: "organization_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 1, name: "organization_id", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
     { no: 2, name: "event_ids", kind: "scalar", T: 4 /* ScalarType.UINT64 */, repeated: true },
     { no: 3, name: "period", kind: "message", T: Period },
   ],
@@ -149,6 +148,13 @@ export const FeaturedGroupsResponseData = proto3.makeMessageType(
     { no: 4, name: "total_unique_viewers_open_prompt", kind: "scalar", T: 5 /* ScalarType.INT32 */ },
     { no: 5, name: "total_unique_viewers_answered_prompt", kind: "scalar", T: 5 /* ScalarType.INT32 */ },
     { no: 6, name: "average_prompts_opened_per_engaged_viewer", kind: "scalar", T: 1 /* ScalarType.DOUBLE */ },
+    { no: 7, name: "total_prompts_opened", kind: "scalar", T: 5 /* ScalarType.INT32 */ },
+    { no: 8, name: "total_interactions", kind: "scalar", T: 5 /* ScalarType.INT32 */ },
+    { no: 9, name: "poll_card", kind: "message", T: CardStatistics },
+    { no: 10, name: "trivia_card", kind: "message", T: CardStatistics },
+    { no: 11, name: "prediction_card", kind: "message", T: CardStatistics },
+    { no: 12, name: "factoid_card", kind: "message", T: CardStatistics },
+    { no: 13, name: "twitter_card", kind: "message", T: CardStatistics },
   ],
 );
 
@@ -178,11 +184,11 @@ export const FeaturedGroupsResponse_FeaturedGroupsResponseMeta = proto3.makeMess
 export const MetricsByTimeLineRequestFilter = proto3.makeMessageType(
   "streamlayer.analytics.v2.studio.MetricsByTimeLineRequestFilter",
   () => [
-    { no: 1, name: "organization_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 1, name: "organization_id", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
     { no: 2, name: "event_ids", kind: "scalar", T: 4 /* ScalarType.UINT64 */, repeated: true },
     { no: 3, name: "countries", kind: "scalar", T: 9 /* ScalarType.STRING */, repeated: true },
-    { no: 4, name: "period", kind: "message", T: Period },
-    { no: 5, name: "date", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 4, name: "period", kind: "message", T: Period, opt: true },
+    { no: 5, name: "date", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
     { no: 6, name: "agg_period", kind: "enum", T: proto3.getEnumType(AggPeriod) },
   ],
 );
@@ -251,12 +257,12 @@ export const UsersByTimeLineRequest = proto3.makeMessageType(
 export const PollsStatsByTimeLineRequestFilter = proto3.makeMessageType(
   "streamlayer.analytics.v2.studio.PollsStatsByTimeLineRequestFilter",
   () => [
-    { no: 1, name: "organization_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 1, name: "organization_id", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
     { no: 2, name: "event_id", kind: "scalar", T: 4 /* ScalarType.UINT64 */ },
     { no: 3, name: "countries", kind: "scalar", T: 9 /* ScalarType.STRING */, repeated: true },
-    { no: 4, name: "period", kind: "message", T: Period },
+    { no: 4, name: "period", kind: "message", T: Period, opt: true },
     { no: 5, name: "agg_period", kind: "enum", T: proto3.getEnumType(AggPeriod) },
-    { no: 6, name: "topic_type", kind: "enum", T: proto3.getEnumType(TopicType) },
+    { no: 6, name: "topic_type", kind: "enum", T: proto3.getEnumType(TopicType), opt: true },
   ],
 );
 
@@ -403,7 +409,7 @@ export const DeviceInteractionsByTimeLineResponse_DeviceInteractionsByTimeLineRe
 export const ListCountriesRequestFilter = proto3.makeMessageType(
   "streamlayer.analytics.v2.studio.ListCountriesRequestFilter",
   () => [
-    { no: 1, name: "organization_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 1, name: "organization_id", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
   ],
 );