adonisjs-server-stats 1.10.0 → 1.11.0

package/dist/core/types.d.ts

@@ -1,6 +1,8 @@
 import { ServerStats } from '../types.js';
 export type { ServerStats, MetricValue, ServerStatsConfig, ResolvedServerStatsConfig, DevToolbarOptions, ToolbarConfig, AdvancedConfig, } from '../types.js';
 export type { DebugPane, DebugPaneColumn, DebugPaneSearch, DebugPaneFormatType, BadgeColor, QueryRecord, EventRecord, EmailRecord, RouteRecord, TraceRecord, TraceSpan, } from '../debug/types.js';
+export type { OverviewMetrics, OverviewData, ChartDataPoint, GroupedQuery, DashboardCacheStats, DashboardCacheKeyEntry, DashboardCacheResponse, JobsApiResponse, JobStats, JobRecord, } from './types-dashboard.js';
+export type { DiagnosticsBufferInfo, DiagnosticsCollectorInfo, DiagnosticsTimerInfo, DiagnosticsResponse, } from './types-diagnostics.js';
 /**
  * Props / config for the `<ServerStatsBar />` component.
  */
@@ -18,63 +20,37 @@ export interface StatsBarProps {
     /** CSS class overrides for the root element. */
     className?: string;
 }
-/**
- * Props for the `<DebugPanel />` component.
- */
+/** Props for the `<DebugPanel />` component. */
 export interface DebugPanelProps {
-    /** Base URL for API calls. Defaults to `''` (same origin). */
     baseUrl?: string;
-    /** Debug API base path. Defaults to `'/admin/api/debug'`. */
     debugEndpoint?: string;
-    /** Optional auth token for Bearer auth. */
     authToken?: string;
-    /** CSS class overrides for panel container. */
     className?: string;
 }
-/**
- * Props for the `<DashboardPage />` component.
- */
+/** Props for the `<DashboardPage />` component. */
 export interface DashboardPageProps {
-    /** Base URL for API calls. Defaults to `''` (same origin). */
     baseUrl?: string;
-    /** Dashboard API base path. Defaults to `'/__stats/api'`. */
     dashboardEndpoint?: string;
-    /** Optional auth token for Bearer auth. */
     authToken?: string;
-    /** Transmit channel name for live updates. Defaults to `'server-stats/dashboard'`. */
     channelName?: string;
-    /** CSS class overrides for the root element. */
     className?: string;
 }
-/**
- * Alias for {@link StatsBarProps}. Used by Vue components as config type.
- */
+/** Alias for {@link StatsBarProps}. Used by Vue components as config type. */
 export interface StatsBarConfig extends StatsBarProps {
-    /** Debug API endpoint path (used for feature detection). */
     debugEndpoint?: string;
 }
-/**
- * Alias for {@link DebugPanelProps}. Used by Vue components as config type.
- */
+/** Alias for {@link DebugPanelProps}. Used by Vue components as config type. */
 export interface DebugPanelConfig extends DebugPanelProps {
-    /** Path to the full dashboard page. */
     dashboardPath?: string;
-    /** Whether tracing is enabled. */
     tracingEnabled?: boolean;
-    /** Whether the stats bar is connected via Transmit (SSE) for live updates. */
     isLive?: boolean;
 }
-/**
- * Alias for {@link DashboardPageProps}. Used by Vue components as config type.
- */
+/** Alias for {@link DashboardPageProps}. Used by Vue components as config type. */
 export interface DashboardConfig extends DashboardPageProps {
-    /** Whether tracing is enabled. */
     tracingEnabled?: boolean;
 }
 /**
  * Shape returned by `GET {debugEndpoint}/config`.
- *
- * Tells the UI which sections to render and where to find endpoints.
  */
 export interface FeatureFlags {
     features: {
@@ -105,10 +81,6 @@ export interface FeatureFlags {
 }
 /**
  * Flattened feature config used by Vue composables.
- *
- * Provides a flat interface for feature flags plus custom panes,
- * simplifying access in Vue components (e.g. `features.tracing`
- * instead of `features.features.tracing`).
  */
 export interface FeatureConfig {
     tracing: boolean;
@@ -125,114 +97,40 @@ export interface FeatureConfig {
     dashboard: boolean;
     customPanes: import('../debug/types.js').DebugPane[];
 }
-/**
- * Threshold color result.
- */
+/** Threshold color result. */
 export type ThresholdColor = 'green' | 'amber' | 'red';
 /**
  * Definition for a single metric displayed in the stats bar.
- *
- * Each definition drives rendering in both React and Vue:
- * label for display, extract for reading the value from a snapshot,
- * format for string output, and threshold config for color coding.
  */
 export interface MetricDefinition {
-    /** Unique metric identifier (e.g. `'cpu'`, `'memory'`). */
     id: string;
-    /** Short display label (e.g. `'CPU'`, `'MEM'`). */
     label: string;
-    /**
-     * Longer display title for tooltips (e.g. `'CPU Usage'`, `'Memory'`).
-     * Falls back to `label` if not provided.
-     */
     title?: string;
-    /**
-     * Unit string for display and tooltip (e.g. `'%'`, `'ms'`, `'bytes'`).
-     * Empty string for unitless metrics.
-     */
     unit: string;
-    /**
-     * Metric group for layout grouping in the stats bar.
-     * Standard groups: `'core'`, `'db'`, `'redis'`, `'queue'`, `'log'`.
-     * Defaults to `'core'` if not specified.
-     */
     group?: string;
-    /**
-     * Value at or above which the metric turns amber.
-     * For inverse metrics (higher is better), this is the *below* threshold.
-     * `undefined` means no threshold coloring.
-     */
     warnThreshold?: number;
-    /**
-     * Value at or above which the metric turns red.
-     * For inverse metrics (higher is better), this is the *below* threshold.
-     * `undefined` means no threshold coloring.
-     */
     critThreshold?: number;
-    /**
-     * Whether the threshold logic is inverted (lower values are worse).
-     * Used for metrics like cache hit rate where <90% is amber and <70% is red.
-     */
     inverseThreshold?: boolean;
-    /**
-     * Extract the numeric value from a stats snapshot.
-     * Returns `undefined` if the metric is not available in this snapshot.
-     */
     extract: (stats: ServerStats) => number | undefined;
-    /**
-     * Format the extracted value for display (e.g. `"52.3%"`, `"128M"`).
-     * Alias: `value` (same function, alternate name for React).
-     */
     format: (stats: ServerStats) => string;
-    /**
-     * Alias for {@link format}. Returns the formatted display string.
-     */
     value?: (stats: ServerStats) => string;
-    /**
-     * Return a CSS class name for threshold coloring (e.g. `'ss-green'`).
-     * Used by React components. When not provided, the component should
-     * compute the color from `warnThreshold`/`critThreshold`.
-     */
     color?: (stats: ServerStats) => string;
-    /**
-     * Additional detail text (or a function returning detail text)
-     * shown in the tooltip below the main value.
-     */
     detail?: string | ((stats: ServerStats) => string | null);
-    /**
-     * Key on `ServerStats` to track in the sparkline history buffer.
-     * `undefined` means no sparkline for this metric.
-     * A leading `_` prefix indicates a computed value (e.g. `'_sysMemUsed'`).
-     */
     historyKey?: string | undefined;
-    /**
-     * Optional predicate to conditionally show/hide this metric
-     * based on the current stats snapshot.
-     */
     show?: (stats: ServerStats) => boolean;
 }
-/**
- * Options for SVG sparkline rendering.
- */
+/** Options for SVG sparkline rendering. */
 export interface SparklineOptions {
-    /** Stroke color (CSS color string). Defaults to `'#34d399'`. */
     color?: string;
-    /** Fill gradient top opacity (0-1). Defaults to `0.25`. */
     fillOpacityTop?: number;
-    /** Fill gradient bottom opacity (0-1). Defaults to `0.02`. */
     fillOpacityBottom?: number;
-    /** Line stroke width. Defaults to `1.5`. */
     strokeWidth?: number;
-    /** SVG viewBox width. Defaults to `120`. */
     width?: number;
-    /** SVG viewBox height. Defaults to `32`. */
     height?: number;
-    /** Inner padding in px. Defaults to `2`. */
     padding?: number;
 }
 /**
  * Options for the `useDashboardData` hook.
- * Extends {@link DashboardPageProps} with pagination, sort, filter, and time range options.
  */
 export interface DashboardHookOptions extends DashboardPageProps {
     page?: number;
@@ -242,28 +140,11 @@ export interface DashboardHookOptions extends DashboardPageProps {
     sortDir?: 'asc' | 'desc';
     filters?: Record<string, string>;
     timeRange?: TimeRange;
-    /** Incrementing key to trigger a refetch (used by live mode). */
     refreshKey?: number;
 }
-/**
- * Built-in debug panel tab identifiers.
- *
- * Known tabs are provided for autocomplete; any custom string is also accepted.
- */
 export type DebugTab = 'timeline' | 'queries' | 'events' | 'routes' | 'logs' | 'emails' | 'cache' | 'jobs' | (string & {});
-/**
- * Built-in dashboard section identifiers.
- *
- * Known sections are provided for autocomplete; any custom string is also accepted.
- */
 export type DashboardSection = 'overview' | 'requests' | 'queries' | 'events' | 'routes' | 'logs' | 'emails' | 'cache' | 'jobs' | 'config' | (string & {});
-/**
- * Pre-defined time range options for dashboard queries.
- */
 export type TimeRange = '5m' | '15m' | '30m' | '1h' | '6h' | '24h' | '7d';
-/**
- * Generic paginated API response shape.
- */
 export interface PaginatedResponse<T> {
     data: T[];
     meta: {
@@ -273,346 +154,33 @@ export interface PaginatedResponse<T> {
         lastPage: number;
     };
 }
-/**
- * Aggregate cache statistics returned by the debug cache endpoint.
- */
 export interface CacheStats {
     hitRate: number;
     totalHits: number;
     totalMisses: number;
     keys: CacheEntry[];
-    /** Number of cache keys (may differ from `keys.length` when paginated). */
     keyCount?: number;
-    /** Memory used by the cache store in megabytes. */
     memoryUsedMb?: number;
 }
-/**
- * Individual cache key metadata.
- */
 export interface CacheEntry {
     key: string;
     type: string;
     ttl: number;
     size: number;
-    /** Cached value (populated when inspecting a single key in the debug panel). */
     value?: string | number | boolean | Record<string, unknown> | unknown[] | null;
 }
-/**
- * Redis / cache store statistics returned by the dashboard cache endpoint.
- */
-export interface DashboardCacheStats {
-    connected: boolean;
-    hits: number;
-    misses: number;
-    hitRate: number;
-    memoryUsedBytes: number;
-    memoryUsedHuman: string;
-    connectedClients: number;
-    totalKeys: number;
-    keyCount?: number;
-}
-/**
- * Individual cache key entry in the dashboard cache inspector.
- */
-export interface DashboardCacheKeyEntry {
-    key: string;
-    type: string;
-    ttl: number;
-    size?: number | null;
-}
-/**
- * Full response from the dashboard cache API endpoint.
- */
-export interface DashboardCacheResponse {
-    available: boolean;
-    stats: DashboardCacheStats | null;
-    keys?: DashboardCacheKeyEntry[];
-    data?: DashboardCacheKeyEntry[];
-    cursor: string;
-}
-/**
- * Server response shape from the dashboard API `/api/jobs` endpoint.
- *
- * The server may return jobs under `jobs` or `data`, and stats under
- * `stats` or `overview`. We handle all variants to stay compatible
- * with different queue inspector implementations.
- */
-export interface JobsApiResponse {
-    available?: boolean;
-    overview?: JobStats;
-    stats?: JobStats;
-    data?: JobRecord[];
-    jobs?: JobRecord[];
-    total?: number;
-}
-/**
- * Aggregate queue statistics.
- */
-export interface JobStats {
-    active: number;
-    waiting: number;
-    delayed: number;
-    completed: number;
-    failed: number;
-}
-/**
- * Individual job record from the queue inspector.
- */
-export interface JobRecord {
-    id: string;
-    name: string;
-    status: string;
-    data: unknown;
-    payload: unknown;
-    attempts: number;
-    duration: number | null;
-    timestamp: number | string;
-    createdAt: number | string;
-    processedAt: number | string | null;
-    finishedAt: number | string | null;
-    failedReason: string | null;
-}
-/**
- * Aggregated overview metrics returned by the dashboard overview endpoint.
- */
-export interface OverviewMetrics {
-    avgResponseTime: number;
-    p95ResponseTime: number;
-    requestsPerMinute: number;
-    errorRate: number;
-    totalRequests: number;
-    slowestEndpoints: {
-        url?: string;
-        pattern?: string;
-        avgDuration: number;
-        count: number;
-    }[];
-    queryStats: {
-        total: number;
-        avgDuration: number;
-        perRequest: number;
-    };
-    recentErrors: {
-        id?: number;
-        level: string;
-        message: string;
-        timestamp?: number | string;
-    }[];
-    topEvents: {
-        eventName?: string;
-        name?: string;
-        event_name?: string;
-        event?: string;
-        count: number;
-    }[];
-    emailActivity: {
-        sent: number;
-        queued: number;
-        failed: number;
-    };
-    logLevelBreakdown: {
-        error: number;
-        warn: number;
-        info: number;
-        debug: number;
-    };
-    cacheStats: {
-        available: boolean;
-        totalKeys: number;
-        hitRate: number;
-        memoryUsedHuman: string;
-    } | null;
-    jobQueueStatus: {
-        available: boolean;
-        active: number;
-        waiting: number;
-        failed: number;
-        completed: number;
-    } | null;
-    statusDistribution: {
-        '2xx': number;
-        '3xx': number;
-        '4xx': number;
-        '5xx': number;
-    };
-    slowestQueries: {
-        sqlNormalized?: string;
-        normalizedSql?: string;
-        sql_normalized?: string;
-        sql?: string;
-        avgDuration: number;
-        count: number;
-    }[];
-    sparklines?: {
-        avgResponseTime?: number[];
-        p95ResponseTime?: number[];
-        requestsPerMinute?: number[];
-        errorRate?: number[];
-    };
-}
-/**
- * Extended overview data used by Vue dashboard components.
- * Extends {@link OverviewMetrics} with sparkline time-series data.
- */
-export interface OverviewData extends OverviewMetrics {
-    avgResponseTimeSeries?: number[];
-    p95ResponseTimeSeries?: number[];
-    requestsPerMinuteSeries?: number[];
-    errorRateSeries?: number[];
-    recentErrors: {
-        id?: number;
-        level: string;
-        message: string;
-        timestamp: number | string;
-    }[];
-}
-/**
- * Single data point for dashboard time-series charts.
- */
-export interface ChartDataPoint {
-    bucket: string;
-    total: number;
-    count2xx: number;
-    count3xx: number;
-    count4xx: number;
-    count5xx: number;
-    requestCount?: number;
-    errorCount?: number;
-    avgDuration?: number;
-    p95Duration?: number;
-}
-/**
- * A grouped/aggregated query pattern for the dashboard queries section.
- */
-export interface GroupedQuery {
-    pattern: string;
-    count: number;
-    avgDuration: number;
-    minDuration: number;
-    maxDuration: number;
-    totalDuration: number;
-    percentOfTotal: number;
-}
-export type { Theme } from './theme.js';
-/**
- * Pagination state for table components.
- */
 export interface PaginationState {
-    /** Current page number (1-based). */
     page: number;
-    /** Number of items per page. */
     perPage: number;
-    /** Total number of items across all pages. */
     total: number;
-    /** Total number of pages. */
     totalPages: number;
 }
-/**
- * Filter state for table components.
- */
 export interface FilterState {
-    /** Free-text search query. */
     search: string;
-    /** Key-value filter pairs (e.g. `{ status: '500', method: 'GET' }`). */
     filters: Record<string, string>;
 }
-/**
- * Sort state for table components.
- */
 export interface SortState {
-    /** Column field name to sort by. */
     field: string;
-    /** Sort direction. */
     direction: 'asc' | 'desc';
 }
-/**
- * Buffer usage info returned by the diagnostics endpoint.
- */
-export interface DiagnosticsBufferInfo {
-    current: number;
-    max: number;
-}
-/**
- * Collector metadata returned by the diagnostics endpoint.
- */
-export interface DiagnosticsCollectorInfo {
-    name: string;
-    label: string;
-    status: 'healthy' | 'errored' | 'stopped';
-    lastError: string | null;
-    lastErrorAt: number | null;
-    config: Record<string, unknown>;
-}
-/**
- * Timer state returned by the diagnostics endpoint.
- */
-export interface DiagnosticsTimerInfo {
-    active: boolean;
-    intervalMs?: number;
-    debounceMs?: number;
-}
-/**
- * Full diagnostics response from `GET {debugEndpoint}/diagnostics`.
- *
- * Used by both React `InternalsContent` and Vue `InternalsTab` / `InternalsSection`.
- */
-export interface DiagnosticsResponse {
-    package: {
-        version: string;
-        nodeVersion: string;
-        adonisVersion: string;
-        uptime?: number;
-    };
-    config: {
-        intervalMs: number;
-        transport: string;
-        channelName: string;
-        endpoint: string | false;
-        skipInTest: boolean;
-        hasOnStatsCallback: boolean;
-        hasShouldShowCallback: boolean;
-    };
-    devToolbar: {
-        enabled: boolean;
-        maxQueries: number;
-        maxEvents: number;
-        maxEmails: number;
-        maxTraces: number;
-        slowQueryThresholdMs: number;
-        tracing: boolean;
-        dashboard: boolean;
-        dashboardPath: string;
-        debugEndpoint: string;
-        retentionDays: number;
-        dbPath: string;
-        persistDebugData: boolean | string;
-        renderer: string;
-        excludeFromTracing: string[];
-        customPaneCount: number;
-    };
-    collectors: DiagnosticsCollectorInfo[];
-    buffers: Record<string, DiagnosticsBufferInfo>;
-    timers: Record<string, DiagnosticsTimerInfo>;
-    transmit: {
-        available: boolean;
-        channels: string[];
-    };
-    integrations: Record<string, {
-        active?: boolean;
-        available?: boolean;
-        mode?: string;
-    }>;
-    storage: {
-        ready: boolean;
-        dbPath: string;
-        fileSizeMb: number;
-        walSizeMb: number;
-        retentionDays: number;
-        tables: Array<{
-            name: string;
-            rowCount: number;
-        }>;
-        lastCleanupAt: number | null;
-    } | null;
-    uptime?: number;
-}
+export type { Theme } from './theme.js';

package/dist/react/CacheSection-BYN53kYO.js

@@ -0,0 +1,135 @@
+import { jsxs as o, jsx as t } from "react/jsx-runtime";
+import { useState as c, useCallback as k } from "react";
+import { formatCacheSize as x, formatTtl as D } from "adonisjs-server-stats/core";
+import { a as N, J as V } from "./index-DwDK-4oX.js";
+import { C as L } from "./CacheStatsBar-CRodCOeP.js";
+import { D as F } from "./DataTable-YyShr5B-.js";
+import { F as T } from "./FilterBar-CQ7bD669.js";
+function _({ options: v = {} }) {
+  const [d, b] = c(""), [l, i] = c(null), [w, n] = c(null), [C, h] = c(!1), [y, r] = c(null), { data: u, isLoading: g, mutate: m, getApi: p } = N("cache", {
+    ...v,
+    search: d
+  }), a = u, K = k(
+    async (e) => {
+      if (confirm(`Delete cache key "${e}"?`))
+        try {
+          await m(`cache/${encodeURIComponent(e)}`, "delete"), l === e && (i(null), n(null), r(null));
+        } catch {
+        }
+    },
+    [m, l]
+  ), S = k(
+    async (e) => {
+      if (l === e) {
+        i(null), n(null), r(null);
+        return;
+      }
+      i(e), n(null), r(null), h(!0);
+      try {
+        const s = await p().fetchCacheKey(e);
+        n(
+          s.value !== void 0 ? s.value : s.data !== void 0 ? s.data : s
+        ), r(null);
+      } catch {
+        n(null), r("Failed to fetch key value");
+      } finally {
+        h(!1);
+      }
+    },
+    [l, p]
+  );
+  return /* @__PURE__ */ o("div", { children: [
+    a?.available && a?.stats && /* @__PURE__ */ t(
+      L,
+      {
+        hitRate: a.stats.hitRate ?? 0,
+        hits: a.stats.hits ?? 0,
+        misses: a.stats.misses ?? 0,
+        keys: a.stats.totalKeys || a.stats.keyCount || a.keys?.length || 0
+      }
+    ),
+    /* @__PURE__ */ t(
+      T,
+      {
+        search: d,
+        onSearchChange: b,
+        placeholder: "Filter cache keys...",
+        summary: `${(a?.keys || a?.data || []).length} keys`
+      }
+    ),
+    g && !u ? /* @__PURE__ */ t("div", { className: "ss-dash-empty", children: "Loading cache..." }) : !a || !a.available ? /* @__PURE__ */ t("div", { className: "ss-dash-empty", children: "Cache inspector not available" }) : /* @__PURE__ */ t("div", { className: "ss-dash-table-wrap", children: /* @__PURE__ */ t(
+      F,
+      {
+        columns: [
+          {
+            key: "key",
+            label: "Key",
+            render: (e) => /* @__PURE__ */ t(
+              "span",
+              {
+                title: e,
+                style: {
+                  color: "var(--ss-sql-color)",
+                  overflow: "hidden",
+                  textOverflow: "ellipsis",
+                  whiteSpace: "nowrap",
+                  display: "block"
+                },
+                children: e
+              }
+            )
+          },
+          {
+            key: "type",
+            label: "Type",
+            width: "70px",
+            render: (e) => /* @__PURE__ */ t("span", { style: { color: "var(--ss-muted)" }, children: e })
+          },
+          {
+            key: "size",
+            label: "Size",
+            width: "60px",
+            render: (e) => e != null && e > 0 ? x(e) : "-"
+          },
+          {
+            key: "ttl",
+            label: "TTL",
+            width: "70px",
+            render: (e) => e > 0 ? D(e) : "-"
+          },
+          {
+            key: "_actions",
+            label: "",
+            width: "60px",
+            render: (e, f) => /* @__PURE__ */ t(
+              "button",
+              {
+                type: "button",
+                className: "ss-dash-retry-btn",
+                onClick: (s) => {
+                  s.stopPropagation(), K(f.key);
+                },
+                children: "Delete"
+              }
+            )
+          }
+        ],
+        data: a.keys || a.data || [],
+        keyField: "key",
+        onRowClick: (e) => S(e.key),
+        emptyMessage: "No cache keys found"
+      }
+    ) }),
+    l && /* @__PURE__ */ o("div", { className: "ss-dash-cache-detail", children: [
+      /* @__PURE__ */ o("h4", { children: [
+        "Key: ",
+        l
+      ] }),
+      C ? /* @__PURE__ */ t("div", { className: "ss-dash-empty", children: "Loading value..." }) : y ? /* @__PURE__ */ t("div", { className: "ss-dash-empty", style: { color: "var(--ss-red-fg)" }, children: y }) : /* @__PURE__ */ t(V, { data: w })
+    ] })
+  ] });
+}
+export {
+  _ as CacheSection,
+  _ as default
+};