@bunizao/contracts 0.23.0 → 0.24.0

package/dist/analytics.d.ts

@@ -359,3 +359,106 @@ export interface SiteAnalyticsReportResult {
     }> | null;
     notices: string[];
 }
+export declare const SITE_EXPLORE_ENDPOINT: '/api/analytics/explore';
+export declare const SITE_EXPLORE_VIEWS: readonly ['traffic', 'decoy'];
+export type SiteExploreView = typeof SITE_EXPLORE_VIEWS[number];
+export declare const SITE_EXPLORE_RANGES: readonly ['24h', '7d', '30d', '90d'];
+export type SiteExploreRange = typeof SITE_EXPLORE_RANGES[number];
+export declare const SITE_EXPLORE_CLASSES: readonly ['human', 'bot', 'owner', 'all'];
+export type SiteExploreClass = typeof SITE_EXPLORE_CLASSES[number];
+export declare const SITE_EXPLORE_PARTS: readonly ['summary', 'panel', 'clicks', 'log'];
+export type SiteExplorePart = typeof SITE_EXPLORE_PARTS[number];
+export declare const SITE_EXPLORE_DIMS: {
+    readonly traffic: readonly ['page', 'section', 'referrer', 'channel', 'utm', 'country', 'city', 'device', 'browser', 'os', 'visitor'];
+    readonly decoy: readonly ['client', 'kind', 'reason', 'ua', 'path', 'network', 'country'];
+};
+export type SiteExploreDim<V extends SiteExploreView = SiteExploreView> = typeof SITE_EXPLORE_DIMS[V][number];
+export declare const SITE_EXPLORE_METRICS: {
+    readonly traffic: readonly ['visitors', 'views', 'engagement', 'dwell'];
+    readonly decoy: readonly ['hits', 'clients', 'networks', 'named'];
+};
+export type SiteExploreMetric<V extends SiteExploreView = SiteExploreView> = typeof SITE_EXPLORE_METRICS[V][number];
+export declare const SITE_EXPLORE_PANEL_LIMIT = 100;
+export declare const SITE_EXPLORE_EMPTY = "(none)";
+export interface SiteExploreSeries {
+    totals: Record<string, number>;
+    points: Record<string, number[]>;
+}
+export interface SiteExploreSummary {
+    view: SiteExploreView;
+    range: SiteExploreRange;
+    timezone: 'Australia/Melbourne';
+    bucket: 'hour' | 'day';
+    buckets: string[];
+    from: string;
+    to: string;
+    previousFrom: string | null;
+    current: SiteExploreSeries;
+    previous: SiteExploreSeries | null;
+    notices: Array<'compare_beyond_retention'>;
+}
+export interface SiteExploreRow {
+    key: string;
+    label: string;
+    count: number;
+    visitors: number;
+}
+export interface SiteExplorePanel {
+    dim: SiteExploreDim;
+    rows: SiteExploreRow[];
+    more: boolean;
+}
+export interface SiteExploreClickRow {
+    name: string;
+    label: string;
+    href: string;
+    clicks: number;
+    visitors: number;
+}
+export interface SiteExploreClicks {
+    rows: SiteExploreClickRow[];
+    more: boolean;
+    ignored: SiteExploreDim<'traffic'>[];
+}
+export interface SiteExploreVisit {
+    at: string;
+    until: string;
+    visitor: string;
+    session: string;
+    class: SiteAnalyticsTrafficClass;
+    country: string;
+    city: string;
+    network: string;
+    org: string;
+    device: string;
+    browser: string;
+    os: string;
+    entry: string;
+    referrer: string;
+    channel: string;
+    pages: number;
+    dwellMs: number;
+    interactions: number;
+}
+export interface SiteExploreDecoyHit {
+    at: string;
+    reason: string;
+    kind: string;
+    client: string;
+    ua: string;
+    path: string;
+    network: string;
+    org: string;
+    country: string;
+    method: string;
+}
+export type SiteExploreLog = {
+    view: 'traffic';
+    rows: SiteExploreVisit[];
+    more: boolean;
+    next: string | null;
+} | {
+    view: 'decoy';
+    rows: SiteExploreDecoyHit[];
+    more: boolean;
+};

package/dist/analytics.js

@@ -36,6 +36,21 @@ var SITE_ANALYTICS_SURFACES = [
   "other"
 ];
 var SITE_ANALYTICS_REPORTS = ["overview", "pages", "clicks", "sources", "audience", "quality", "log", "visitor"];
+var SITE_EXPLORE_ENDPOINT = "/api/analytics/explore";
+var SITE_EXPLORE_VIEWS = ["traffic", "decoy"];
+var SITE_EXPLORE_RANGES = ["24h", "7d", "30d", "90d"];
+var SITE_EXPLORE_CLASSES = ["human", "bot", "owner", "all"];
+var SITE_EXPLORE_PARTS = ["summary", "panel", "clicks", "log"];
+var SITE_EXPLORE_DIMS = {
+  traffic: ["page", "section", "referrer", "channel", "utm", "country", "city", "device", "browser", "os", "visitor"],
+  decoy: ["client", "kind", "reason", "ua", "path", "network", "country"]
+};
+var SITE_EXPLORE_METRICS = {
+  traffic: ["visitors", "views", "engagement", "dwell"],
+  decoy: ["hits", "clients", "networks", "named"]
+};
+var SITE_EXPLORE_PANEL_LIMIT = 100;
+var SITE_EXPLORE_EMPTY = "(none)";
 export {
   BLOG_ANALYTICS_ARTICLE_ENDPOINT,
   BLOG_ANALYTICS_COMPLETION_SCROLL_DEPTH,
@@ -53,5 +68,14 @@ export {
   SITE_ANALYTICS_REPORTS,
   SITE_ANALYTICS_REPORT_ENDPOINT,
   SITE_ANALYTICS_SESSION_IDLE_MS,
-  SITE_ANALYTICS_SURFACES
+  SITE_ANALYTICS_SURFACES,
+  SITE_EXPLORE_CLASSES,
+  SITE_EXPLORE_DIMS,
+  SITE_EXPLORE_EMPTY,
+  SITE_EXPLORE_ENDPOINT,
+  SITE_EXPLORE_METRICS,
+  SITE_EXPLORE_PANEL_LIMIT,
+  SITE_EXPLORE_PARTS,
+  SITE_EXPLORE_RANGES,
+  SITE_EXPLORE_VIEWS
 };

package/dist/index.js

@@ -36,6 +36,21 @@ var SITE_ANALYTICS_SURFACES = [
   "other"
 ];
 var SITE_ANALYTICS_REPORTS = ["overview", "pages", "clicks", "sources", "audience", "quality", "log", "visitor"];
+var SITE_EXPLORE_ENDPOINT = "/api/analytics/explore";
+var SITE_EXPLORE_VIEWS = ["traffic", "decoy"];
+var SITE_EXPLORE_RANGES = ["24h", "7d", "30d", "90d"];
+var SITE_EXPLORE_CLASSES = ["human", "bot", "owner", "all"];
+var SITE_EXPLORE_PARTS = ["summary", "panel", "clicks", "log"];
+var SITE_EXPLORE_DIMS = {
+  traffic: ["page", "section", "referrer", "channel", "utm", "country", "city", "device", "browser", "os", "visitor"],
+  decoy: ["client", "kind", "reason", "ua", "path", "network", "country"]
+};
+var SITE_EXPLORE_METRICS = {
+  traffic: ["visitors", "views", "engagement", "dwell"],
+  decoy: ["hits", "clients", "networks", "named"]
+};
+var SITE_EXPLORE_PANEL_LIMIT = 100;
+var SITE_EXPLORE_EMPTY = "(none)";
 // src/admin.ts
 var ADMIN_COMMENT_REJECT_REASONS = ["spam", "promotional", "abuse", "off_topic", "personal_info"];
 var ADMIN_ACTIVITY_EVENTS = [
@@ -408,6 +423,15 @@ export {
   SITE_ANALYTICS_REPORT_ENDPOINT,
   SITE_ANALYTICS_SESSION_IDLE_MS,
   SITE_ANALYTICS_SURFACES,
+  SITE_EXPLORE_CLASSES,
+  SITE_EXPLORE_DIMS,
+  SITE_EXPLORE_EMPTY,
+  SITE_EXPLORE_ENDPOINT,
+  SITE_EXPLORE_METRICS,
+  SITE_EXPLORE_PANEL_LIMIT,
+  SITE_EXPLORE_PARTS,
+  SITE_EXPLORE_RANGES,
+  SITE_EXPLORE_VIEWS,
   SUBSCRIPTION_SOURCES,
   TELEGRAM_OPS_BASE_PATH,
   TELEGRAM_OPS_BROADCASTS_PATH,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bunizao/contracts",
-  "version": "0.23.0",
+  "version": "0.24.0",
   "description": "Shared TypeScript contracts for buxx.me services and clients.",
   "type": "module",
   "sideEffects": false,