@hexclave/shared 1.0.0

package/dist/esm/interface/admin-metrics.d.ts

@@ -0,0 +1,597 @@
+import yup from "yup";
+
+//#region src/interface/admin-metrics.d.ts
+declare const MetricsDataPointSchema: yup.ObjectSchema<{
+  date: string;
+  activity: number;
+}, yup.AnyObject, {
+  date: undefined;
+  activity: undefined;
+}, "">;
+declare const MetricsDataPointsSchema: yup.ArraySchema<{
+  date: string;
+  activity: number;
+}[], yup.AnyObject, undefined, "">;
+declare const MetricsActivitySplitSchema: yup.ObjectSchema<{
+  total: {
+    date: string;
+    activity: number;
+  }[];
+  new: {
+    date: string;
+    activity: number;
+  }[];
+  retained: {
+    date: string;
+    activity: number;
+  }[];
+  reactivated: {
+    date: string;
+    activity: number;
+  }[];
+}, yup.AnyObject, {
+  total: undefined;
+  new: undefined;
+  retained: undefined;
+  reactivated: undefined;
+}, "">;
+declare const MetricsAuthOverviewSchema: yup.ObjectSchema<{
+  verified_users: number;
+  unverified_users: number;
+  anonymous_users: number;
+  total_teams: number;
+  mau: number;
+  daily_active_users_split: {
+    total: {
+      date: string;
+      activity: number;
+    }[];
+    new: {
+      date: string;
+      activity: number;
+    }[];
+    retained: {
+      date: string;
+      activity: number;
+    }[];
+    reactivated: {
+      date: string;
+      activity: number;
+    }[];
+  };
+  daily_active_teams_split: {
+    total: {
+      date: string;
+      activity: number;
+    }[];
+    new: {
+      date: string;
+      activity: number;
+    }[];
+    retained: {
+      date: string;
+      activity: number;
+    }[];
+    reactivated: {
+      date: string;
+      activity: number;
+    }[];
+  };
+  total_users_filtered: number;
+}, yup.AnyObject, {
+  verified_users: undefined;
+  unverified_users: undefined;
+  anonymous_users: undefined;
+  total_teams: undefined;
+  mau: undefined;
+  daily_active_users_split: {
+    total: undefined;
+    new: undefined;
+    retained: undefined;
+    reactivated: undefined;
+  };
+  daily_active_teams_split: {
+    total: undefined;
+    new: undefined;
+    retained: undefined;
+    reactivated: undefined;
+  };
+  total_users_filtered: undefined;
+}, "">;
+declare const MetricsPaymentsOverviewSchema: yup.ObjectSchema<{
+  subscriptions_by_status: Record<string, number>;
+  active_subscription_count: number;
+  total_one_time_purchases: number;
+  daily_subscriptions: {
+    date: string;
+    activity: number;
+  }[];
+  revenue_cents: number;
+  mrr_cents: number;
+  total_orders: number;
+  checkout_conversion_rate: number;
+}, yup.AnyObject, {
+  subscriptions_by_status: undefined;
+  active_subscription_count: undefined;
+  total_one_time_purchases: undefined;
+  daily_subscriptions: undefined;
+  revenue_cents: undefined;
+  mrr_cents: undefined;
+  total_orders: undefined;
+  checkout_conversion_rate: undefined;
+}, "">;
+declare const MetricsRecentEmailSchema: yup.ObjectSchema<{
+  id: string;
+  status: string;
+  subject: string;
+  created_at_millis: number;
+}, yup.AnyObject, {
+  id: undefined;
+  status: undefined;
+  subject: undefined;
+  created_at_millis: undefined;
+}, "">;
+declare const MetricsDailyEmailStatusBreakdownSchema: yup.ObjectSchema<{
+  date: string;
+  ok: number;
+  error: number;
+  in_progress: number;
+}, yup.AnyObject, {
+  date: undefined;
+  ok: undefined;
+  error: undefined;
+  in_progress: undefined;
+}, "">;
+declare const MetricsEmailOverviewSchema: yup.ObjectSchema<{
+  emails_by_status: Record<string, number>;
+  total_emails: number;
+  daily_emails: {
+    date: string;
+    activity: number;
+  }[];
+  daily_emails_by_status: {
+    date: string;
+    ok: number;
+    error: number;
+    in_progress: number;
+  }[];
+  emails_sent: number;
+  recent_emails: {
+    id: string;
+    subject: string;
+    status: string;
+    created_at_millis: number;
+  }[];
+  deliverability_status: {
+    error: number;
+    in_progress: number;
+    delivered: number;
+    bounced: number;
+  };
+  deliverability_rate: number;
+  bounce_rate: number;
+  click_rate: number;
+}, yup.AnyObject, {
+  emails_by_status: undefined;
+  total_emails: undefined;
+  daily_emails: undefined;
+  daily_emails_by_status: undefined;
+  emails_sent: undefined;
+  recent_emails: undefined;
+  deliverability_status: {
+    delivered: undefined;
+    bounced: undefined;
+    error: undefined;
+    in_progress: undefined;
+  };
+  deliverability_rate: undefined;
+  bounce_rate: undefined;
+  click_rate: undefined;
+}, "">;
+declare const MetricsDailyRevenuePointSchema: yup.ObjectSchema<{
+  date: string;
+  new_cents: number;
+  refund_cents: number;
+}, yup.AnyObject, {
+  date: undefined;
+  new_cents: undefined;
+  refund_cents: undefined;
+}, "">;
+declare const MetricsTopReferrerSchema: yup.ObjectSchema<{
+  referrer: string;
+  visitors: number;
+}, yup.AnyObject, {
+  referrer: undefined;
+  visitors: undefined;
+}, "">;
+declare const MetricsTopRegionSchema: yup.ObjectSchema<{
+  country_code: string | null;
+  region_code: string | null;
+  count: number;
+}, yup.AnyObject, {
+  country_code: undefined;
+  region_code: undefined;
+  count: undefined;
+}, "">;
+declare const MetricsAnalyticsOverviewSchema: yup.ObjectSchema<{
+  daily_page_views: {
+    date: string;
+    activity: number;
+  }[];
+  daily_clicks: {
+    date: string;
+    activity: number;
+  }[];
+  daily_visitors: {
+    date: string;
+    activity: number;
+  }[];
+  daily_anonymous_visitors_fallback: {
+    date: string;
+    activity: number;
+  }[];
+  daily_revenue: {
+    date: string;
+    new_cents: number;
+    refund_cents: number;
+  }[];
+  total_revenue_cents: number;
+  total_replays: number;
+  recent_replays: number;
+  visitors: number;
+  anonymous_visitors_fallback: number;
+  avg_session_seconds: number;
+  online_live: number;
+  revenue_per_visitor: number;
+  top_referrers: {
+    referrer: string;
+    visitors: number;
+  }[];
+  top_region: {
+    country_code: string | null;
+    region_code: string | null;
+    count: number;
+  } | null;
+  bounce_rate: number | undefined;
+  conversion_rate: number | undefined;
+  deltas: {} | undefined;
+}, yup.AnyObject, {
+  daily_page_views: undefined;
+  daily_clicks: undefined;
+  daily_visitors: undefined;
+  daily_anonymous_visitors_fallback: never[];
+  daily_revenue: undefined;
+  total_revenue_cents: undefined;
+  total_replays: undefined;
+  recent_replays: undefined;
+  visitors: undefined;
+  anonymous_visitors_fallback: 0;
+  avg_session_seconds: undefined;
+  online_live: undefined;
+  revenue_per_visitor: undefined;
+  top_referrers: undefined;
+  top_region: {
+    country_code: undefined;
+    region_code: undefined;
+    count: undefined;
+  };
+  bounce_rate: undefined;
+  conversion_rate: undefined;
+  deltas: undefined;
+}, "">;
+declare const MetricsLoginMethodEntrySchema: yup.ObjectSchema<{
+  method: string;
+  count: number;
+}, yup.AnyObject, {
+  method: undefined;
+  count: undefined;
+}, "">;
+declare const MetricsRecentUserSchema: yup.ObjectSchema<{
+  id: string;
+  display_name: string | null;
+  primary_email: string | null;
+  profile_image_url: string | null;
+  signed_up_at_millis: number;
+  last_active_at_millis: number | null;
+}, yup.AnyObject, {
+  id: undefined;
+  display_name: undefined;
+  primary_email: undefined;
+  profile_image_url: undefined;
+  signed_up_at_millis: undefined;
+  last_active_at_millis: undefined;
+}, "">;
+declare const UserActivityResponseBodySchema: yup.ObjectSchema<{
+  data_points: {
+    date: string;
+    activity: number;
+  }[];
+}, yup.AnyObject, {
+  data_points: undefined;
+}, "">;
+declare const MetricsActiveUsersByCountrySchema: yup.MixedSchema<Record<string, {
+  display_name: string | null;
+  id: string;
+  primary_email: string | null;
+  profile_image_url: string | null;
+  signed_up_at_millis: number;
+  last_active_at_millis: number | null;
+}[]> | undefined, yup.AnyObject, {}, "d">;
+declare const MetricsResponseBodySchema: yup.ObjectSchema<{
+  total_users: number;
+  live_users: number;
+  daily_users: {
+    date: string;
+    activity: number;
+  }[];
+  daily_active_users: {
+    date: string;
+    activity: number;
+  }[];
+  users_by_country: Record<string, number>;
+  active_users_by_country: Record<string, {
+    display_name: string | null;
+    id: string;
+    primary_email: string | null;
+    profile_image_url: string | null;
+    signed_up_at_millis: number;
+    last_active_at_millis: number | null;
+  }[]>;
+  recently_registered: {
+    display_name: string | null;
+    id: string;
+    primary_email: string | null;
+    profile_image_url: string | null;
+    signed_up_at_millis: number;
+    last_active_at_millis: number | null;
+  }[];
+  recently_active: {
+    display_name: string | null;
+    id: string;
+    primary_email: string | null;
+    profile_image_url: string | null;
+    signed_up_at_millis: number;
+    last_active_at_millis: number | null;
+  }[];
+  login_methods: {
+    count: number;
+    method: string;
+  }[];
+  auth_overview: {
+    daily_active_users_split: {
+      total: {
+        date: string;
+        activity: number;
+      }[];
+      new: {
+        date: string;
+        activity: number;
+      }[];
+      retained: {
+        date: string;
+        activity: number;
+      }[];
+      reactivated: {
+        date: string;
+        activity: number;
+      }[];
+    };
+    daily_active_teams_split: {
+      total: {
+        date: string;
+        activity: number;
+      }[];
+      new: {
+        date: string;
+        activity: number;
+      }[];
+      retained: {
+        date: string;
+        activity: number;
+      }[];
+      reactivated: {
+        date: string;
+        activity: number;
+      }[];
+    };
+    verified_users: number;
+    unverified_users: number;
+    anonymous_users: number;
+    total_teams: number;
+    mau: number;
+    total_users_filtered: number;
+  };
+  payments_overview: {
+    daily_subscriptions: {
+      date: string;
+      activity: number;
+    }[];
+    subscriptions_by_status: Record<string, number>;
+    active_subscription_count: number;
+    total_one_time_purchases: number;
+    revenue_cents: number;
+    mrr_cents: number;
+    total_orders: number;
+    checkout_conversion_rate: number;
+  };
+  email_overview: {
+    daily_emails: {
+      date: string;
+      activity: number;
+    }[];
+    emails_by_status: Record<string, number>;
+    total_emails: number;
+    daily_emails_by_status: {
+      date: string;
+      ok: number;
+      error: number;
+      in_progress: number;
+    }[];
+    emails_sent: number;
+    recent_emails: {
+      id: string;
+      subject: string;
+      status: string;
+      created_at_millis: number;
+    }[];
+    deliverability_status: {
+      error: number;
+      in_progress: number;
+      delivered: number;
+      bounced: number;
+    };
+    deliverability_rate: number;
+    bounce_rate: number;
+    click_rate: number;
+  };
+  analytics_overview: {
+    bounce_rate?: number | undefined;
+    conversion_rate?: number | undefined;
+    deltas?: {} | undefined;
+    visitors: number;
+    daily_page_views: {
+      date: string;
+      activity: number;
+    }[];
+    daily_clicks: {
+      date: string;
+      activity: number;
+    }[];
+    daily_visitors: {
+      date: string;
+      activity: number;
+    }[];
+    daily_anonymous_visitors_fallback: {
+      date: string;
+      activity: number;
+    }[];
+    daily_revenue: {
+      date: string;
+      new_cents: number;
+      refund_cents: number;
+    }[];
+    total_revenue_cents: number;
+    total_replays: number;
+    recent_replays: number;
+    anonymous_visitors_fallback: number;
+    avg_session_seconds: number;
+    online_live: number;
+    revenue_per_visitor: number;
+    top_referrers: {
+      referrer: string;
+      visitors: number;
+    }[];
+    top_region: {
+      country_code: string | null;
+      region_code: string | null;
+      count: number;
+    } | null;
+  };
+}, yup.AnyObject, {
+  total_users: undefined;
+  live_users: 0;
+  daily_users: undefined;
+  daily_active_users: undefined;
+  users_by_country: undefined;
+  active_users_by_country: {};
+  recently_registered: undefined;
+  recently_active: undefined;
+  login_methods: undefined;
+  auth_overview: {
+    verified_users: undefined;
+    unverified_users: undefined;
+    anonymous_users: undefined;
+    total_teams: undefined;
+    mau: undefined;
+    daily_active_users_split: {
+      total: undefined;
+      new: undefined;
+      retained: undefined;
+      reactivated: undefined;
+    };
+    daily_active_teams_split: {
+      total: undefined;
+      new: undefined;
+      retained: undefined;
+      reactivated: undefined;
+    };
+    total_users_filtered: undefined;
+  };
+  payments_overview: {
+    subscriptions_by_status: undefined;
+    active_subscription_count: undefined;
+    total_one_time_purchases: undefined;
+    daily_subscriptions: undefined;
+    revenue_cents: undefined;
+    mrr_cents: undefined;
+    total_orders: undefined;
+    checkout_conversion_rate: undefined;
+  };
+  email_overview: {
+    emails_by_status: undefined;
+    total_emails: undefined;
+    daily_emails: undefined;
+    daily_emails_by_status: undefined;
+    emails_sent: undefined;
+    recent_emails: undefined;
+    deliverability_status: {
+      delivered: undefined;
+      bounced: undefined;
+      error: undefined;
+      in_progress: undefined;
+    };
+    deliverability_rate: undefined;
+    bounce_rate: undefined;
+    click_rate: undefined;
+  };
+  analytics_overview: {
+    daily_page_views: undefined;
+    daily_clicks: undefined;
+    daily_visitors: undefined;
+    daily_anonymous_visitors_fallback: never[];
+    daily_revenue: undefined;
+    total_revenue_cents: undefined;
+    total_replays: undefined;
+    recent_replays: undefined;
+    visitors: undefined;
+    anonymous_visitors_fallback: 0;
+    avg_session_seconds: undefined;
+    online_live: undefined;
+    revenue_per_visitor: undefined;
+    top_referrers: undefined;
+    top_region: {
+      country_code: undefined;
+      region_code: undefined;
+      count: undefined;
+    };
+    bounce_rate: undefined;
+    conversion_rate: undefined;
+    deltas: undefined;
+  };
+}, "">;
+declare const MetricsUserCountsSchema: yup.ObjectSchema<{
+  total_users: number;
+  anonymous_users: number;
+}, yup.AnyObject, {
+  total_users: undefined;
+  anonymous_users: undefined;
+}, "">;
+type MetricsDataPoint = yup.InferType<typeof MetricsDataPointSchema>;
+type MetricsActivitySplit = yup.InferType<typeof MetricsActivitySplitSchema>;
+type MetricsAuthOverview = yup.InferType<typeof MetricsAuthOverviewSchema>;
+type MetricsPaymentsOverview = yup.InferType<typeof MetricsPaymentsOverviewSchema>;
+type MetricsRecentEmail = yup.InferType<typeof MetricsRecentEmailSchema>;
+type MetricsDailyEmailStatusBreakdown = yup.InferType<typeof MetricsDailyEmailStatusBreakdownSchema>;
+type MetricsEmailOverview = yup.InferType<typeof MetricsEmailOverviewSchema>;
+type MetricsDailyRevenuePoint = yup.InferType<typeof MetricsDailyRevenuePointSchema>;
+type MetricsTopReferrer = yup.InferType<typeof MetricsTopReferrerSchema>;
+type MetricsTopRegion = yup.InferType<typeof MetricsTopRegionSchema>;
+type MetricsAnalyticsOverview = yup.InferType<typeof MetricsAnalyticsOverviewSchema>;
+type MetricsLoginMethodEntry = yup.InferType<typeof MetricsLoginMethodEntrySchema>;
+type MetricsRecentUser = yup.InferType<typeof MetricsRecentUserSchema>;
+type MetricsResponse = yup.InferType<typeof MetricsResponseBodySchema>;
+type MetricsUserCounts = yup.InferType<typeof MetricsUserCountsSchema>;
+type UserActivityResponse = yup.InferType<typeof UserActivityResponseBodySchema>;
+//#endregion
+export { MetricsActiveUsersByCountrySchema, MetricsActivitySplit, MetricsActivitySplitSchema, MetricsAnalyticsOverview, MetricsAnalyticsOverviewSchema, MetricsAuthOverview, MetricsAuthOverviewSchema, MetricsDailyEmailStatusBreakdown, MetricsDailyEmailStatusBreakdownSchema, MetricsDailyRevenuePoint, MetricsDailyRevenuePointSchema, MetricsDataPoint, MetricsDataPointSchema, MetricsDataPointsSchema, MetricsEmailOverview, MetricsEmailOverviewSchema, MetricsLoginMethodEntry, MetricsLoginMethodEntrySchema, MetricsPaymentsOverview, MetricsPaymentsOverviewSchema, MetricsRecentEmail, MetricsRecentEmailSchema, MetricsRecentUser, MetricsRecentUserSchema, MetricsResponse, MetricsResponseBodySchema, MetricsTopReferrer, MetricsTopReferrerSchema, MetricsTopRegion, MetricsTopRegionSchema, MetricsUserCounts, MetricsUserCountsSchema, UserActivityResponse, UserActivityResponseBodySchema };
+//# sourceMappingURL=admin-metrics.d.ts.map

package/dist/esm/interface/admin-metrics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"admin-metrics.d.ts","names":[],"sources":["../../../src/interface/admin-metrics.ts"],"mappings":";;;cAWa,sBAAA,EAAsB,GAAA,CAAA,YAAA;;;GAGvB,GAAA,CAAA,SAAA;;;;cAEC,uBAAA,EAAuB,GAAA,CAAA,WAAA;;;KAA6C,GAAA,CAAA,SAAA;AAAA,cAEpE,0BAAA,EAA0B,GAAA,CAAA,YAAA;;;;;;;;;;;;;;;;;GAK3B,GAAA,CAAA,SAAA;;;;;;cAEC,yBAAA,EAAyB,GAAA,CAAA,YAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAS1B,GAAA,CAAA,SAAA;;;;;;;;;;;;;;;;;;;;cAEC,6BAAA,EAA6B,GAAA,CAAA,YAAA;;;;;;;;;;;;;;;;;;;;;;cAW7B,wBAAA,EAAwB,GAAA,CAAA,YAAA;;;;;GAKzB,GAAA,CAAA,SAAA;;;;;;cAEC,sCAAA,EAAsC,GAAA,CAAA,YAAA;;;;;GAKvC,GAAA,CAAA,SAAA;;;;;;cAEC,0BAAA,EAA0B,GAAA,CAAA,YAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAkB1B,8BAAA,EAA8B,GAAA,CAAA,YAAA;;;;GAI/B,GAAA,CAAA,SAAA;;;;;cAEC,wBAAA,EAAwB,GAAA,CAAA,YAAA;;;GAGzB,GAAA,CAAA,SAAA;;;;cAEC,sBAAA,EAAsB,GAAA,CAAA,YAAA;;;;GAIvB,GAAA,CAAA,SAAA;;;;;cAEC,8BAAA,EAA8B,GAAA,CAAA,YAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2B/B,GAAA,CAAA,SAAA;;;;;;;;;;;;;;;;;;;;;;;;cAEC,6BAAA,EAA6B,GAAA,CAAA,YAAA;;;GAG9B,GAAA,CAAA,SAAA;;;;cAUC,uBAAA,EAAuB,GAAA,CAAA,YAAA;;;;;;;GAOP,GAAA,CAAA,SAAA;;;;;;;;cAKhB,8BAAA,EAA8B,GAAA,CAAA,YAAA;;;;;GAE/B,GAAA,CAAA,SAAA;;;cAQC,iCAAA,EAAiC,GAAA,CAAA,WAAA,CAAA,MAAA;;;;;;;;cAKjC,yBAAA,EAAyB,GAAA,CAAA,YAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cA2BzB,uBAAA,EAAuB,GAAA,CAAA,YAAA;;;GAGxB,GAAA,CAAA,SAAA;;;;KAGA,gBAAA,GAAmB,GAAA,CAAI,SAAA,QAAiB,sBAAA;AAAA,KACxC,oBAAA,GAAuB,GAAA,CAAI,SAAA,QAAiB,0BAAA;AAAA,KAC5C,mBAAA,GAAsB,GAAA,CAAI,SAAA,QAAiB,yBAAA;AAAA,KAC3C,uBAAA,GAA0B,GAAA,CAAI,SAAA,QAAiB,6BAAA;AAAA,KAC/C,kBAAA,GAAqB,GAAA,CAAI,SAAA,QAAiB,wBAAA;AAAA,KAC1C,gCAAA,GAAmC,GAAA,CAAI,SAAA,QAAiB,sCAAA;AAAA,KACxD,oBAAA,GAAuB,GAAA,CAAI,SAAA,QAAiB,0BAAA;AAAA,KAC5C,wBAAA,GAA2B,GAAA,CAAI,SAAA,QAAiB,8BAAA;AAAA,KAChD,kBAAA,GAAqB,GAAA,CAAI,SAAA,QAAiB,wBAAA;AAAA,KAC1C,gBAAA,GAAmB,GAAA,CAAI,SAAA,QAAiB,sBAAA;AAAA,KACxC,wBAAA,GAA2B,GAAA,CAAI,SAAA,QAAiB,8BAAA;AAAA,KAChD,uBAAA,GAA0B,GAAA,CAAI,SAAA,QAAiB,6BAAA;AAAA,KAC/C,iBAAA,GAAoB,GAAA,CAAI,SAAA,QAAiB,uBAAA;AAAA,KACzC,eAAA,GAAkB,GAAA,CAAI,SAAA,QAAiB,yBAAA;AAAA,KACvC,iBAAA,GAAoB,GAAA,CAAI,SAAA,QAAiB,uBAAA;AAAA,KACzC,oBAAA,GAAuB,GAAA,CAAI,SAAA,QAAiB,8BAAA"}