@frogbotai/plugin-usage-reports 0.12.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 FrogBot
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,22 @@
+# @frogbotai/plugin-usage-reports
+
+Add adapter-neutral usage analytics to FrogBot.
+
+```ts
+import { usageReportsPlugin } from '@frogbotai/plugin-usage-reports';
+import { buildConfig } from 'frogbot';
+
+export default buildConfig({
+  secret: process.env.FROGBOT_SECRET!,
+  db: databaseAdapter,
+  collections: [{ slug: 'users', auth: true, fields: [] }],
+  ai: { providers },
+  plugins: [usageReportsPlugin()],
+});
+```
+
+The plugin adds a Usage Analytics admin view with the Firmware date range control and sortable Models and Users tables. Reports page through the marker-resolved usage collection with Payload's local API and aggregate in memory, so SQLite, PostgreSQL, and MongoDB use the same path.
+
+The usage-log list gains Payload's experimental visual grouping and export-only CSV support from `@payloadcms/plugin-import-export`. Set `rawExport: false` to omit import/export integration. Set `pageSize` to change the local API batch size from its default of `5000`.
+
+The authenticated `GET /api/usage/report` endpoint accepts `groupBy=model|user|day|apiKey`, `from`, and `to`. API-key groups contain data only when an attribution plugin, such as `@frogbotai/plugin-api-keys`, populated the `apiKey` relationship before usage was logged.

package/dist/client/UsageReports.d.ts

@@ -0,0 +1,4 @@
+import './styles.css';
+export declare function UsageReportsNavLink(): import("react/jsx-runtime").JSX.Element;
+export declare function UsageReports(): import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=UsageReports.d.ts.map

package/dist/client/UsageReports.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UsageReports.d.ts","sourceRoot":"","sources":["../../src/client/UsageReports.tsx"],"names":[],"mappings":"AAMA,OAAO,cAAc,CAAC;AAqCtB,wBAAgB,mBAAmB,4CAGlC;AAED,wBAAgB,YAAY,4CA+F3B"}

package/dist/client/UsageReports.js

@@ -0,0 +1,101 @@
+'use client';
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { useConfig } from '@payloadcms/ui';
+import { useEffect, useState } from 'react';
+import './styles.css';
+const presets = [
+    { label: 'Last 7 days', days: 7 },
+    { label: 'Last 30 days', days: 30 },
+    { label: 'Last 90 days', days: 90 },
+];
+function rangeForDays(days, label) {
+    const to = new Date();
+    const from = new Date(to);
+    from.setUTCDate(from.getUTCDate() - days);
+    return { from: from.toISOString(), to: to.toISOString(), label };
+}
+function dateInput(value) {
+    return value.slice(0, 10);
+}
+function customRange(from, to) {
+    return {
+        from: new Date(`${from}T00:00:00.000Z`).toISOString(),
+        to: new Date(`${to}T23:59:59.999Z`).toISOString(),
+        label: `${from} - ${to}`,
+    };
+}
+function formatTokens(value) {
+    if (value >= 1_000_000_000)
+        return `${(value / 1_000_000_000).toFixed(1)}B`;
+    if (value >= 1_000_000)
+        return `${(value / 1_000_000).toFixed(1)}M`;
+    if (value >= 1_000)
+        return `${(value / 1_000).toFixed(1)}K`;
+    return value.toLocaleString();
+}
+export function UsageReportsNavLink() {
+    const { config } = useConfig();
+    return _jsx("a", { className: "usage-reports-nav-link", href: `${config.routes.admin}/usage-analytics`, children: "Usage Analytics" });
+}
+export function UsageReports() {
+    const { config } = useConfig();
+    const [groupBy, setGroupBy] = useState('model');
+    const [range, setRange] = useState(() => rangeForDays(30, 'Last 30 days'));
+    const [showCustom, setShowCustom] = useState(false);
+    const [customFrom, setCustomFrom] = useState(dateInput(range.from));
+    const [customTo, setCustomTo] = useState(dateInput(range.to));
+    const [report, setReport] = useState();
+    const [error, setError] = useState();
+    const [loading, setLoading] = useState(true);
+    const [sortField, setSortField] = useState(groupBy === 'model' ? 'totalTokens' : 'costUSD');
+    const [ascending, setAscending] = useState(false);
+    useEffect(() => {
+        const controller = new AbortController();
+        const params = new URLSearchParams({ groupBy, from: range.from, to: range.to });
+        setLoading(true);
+        setError(undefined);
+        fetch(`${config.routes.api}/usage/report?${params}`, { signal: controller.signal })
+            .then(async (response) => {
+            if (!response.ok)
+                throw new Error(`${response.status} ${response.statusText}`);
+            setReport(await response.json());
+        })
+            .catch((reason) => {
+            if (!controller.signal.aborted)
+                setError(reason instanceof Error ? reason.message : 'Failed to load usage report');
+        })
+            .finally(() => {
+            if (!controller.signal.aborted)
+                setLoading(false);
+        });
+        return () => controller.abort();
+    }, [config.routes.api, groupBy, range]);
+    const rows = [...(report?.rows ?? [])].sort((a, b) => {
+        const left = a[sortField];
+        const right = b[sortField];
+        const result = typeof left === 'string'
+            ? left.localeCompare(String(right))
+            : left - Number(right);
+        return ascending ? result : -result;
+    });
+    const columns = [
+        { field: 'label', label: groupBy === 'model' ? 'Model' : 'User', value: (row) => row.label },
+        { field: 'requestCount', label: 'Requests', value: (row) => row.requestCount.toLocaleString() },
+        { field: 'totalTokens', label: 'Total Tokens', value: (row) => formatTokens(row.totalTokens) },
+        { field: 'inputTokens', label: 'Input', value: (row) => formatTokens(row.inputTokens) },
+        { field: 'outputTokens', label: 'Output', value: (row) => formatTokens(row.outputTokens) },
+        { field: 'cachedInputTokens', label: 'Cached', value: (row) => formatTokens(row.cachedInputTokens) },
+        { field: 'reasoningTokens', label: 'Reasoning', value: (row) => formatTokens(row.reasoningTokens) },
+        { field: 'costUSD', label: 'Cost', value: (row) => `$${row.costUSD.toFixed(2)}` },
+    ];
+    function sort(field) {
+        if (sortField === field)
+            setAscending(!ascending);
+        else {
+            setSortField(field);
+            setAscending(false);
+        }
+    }
+    return (_jsxs("div", { className: "usage-reports", children: [_jsxs("header", { className: "usage-reports__header", children: [_jsxs("div", { children: [_jsx("h1", { children: "Usage Analytics" }), _jsx("p", { children: range.label })] }), _jsxs("div", { className: "usage-reports__ranges", children: [presets.map((preset) => _jsx("button", { type: "button", onClick: () => { setShowCustom(false); setRange(rangeForDays(preset.days, preset.label)); }, children: preset.label }, preset.days)), _jsx("button", { type: "button", onClick: () => setShowCustom(!showCustom), children: "Custom" })] })] }), showCustom && _jsxs("div", { className: "usage-reports__custom", children: [_jsxs("label", { children: ["From", _jsx("input", { type: "date", value: customFrom, onChange: (event) => setCustomFrom(event.target.value) })] }), _jsxs("label", { children: ["To", _jsx("input", { type: "date", value: customTo, onChange: (event) => setCustomTo(event.target.value) })] }), _jsx("button", { type: "button", disabled: !customFrom || !customTo || customFrom > customTo, onClick: () => { setRange(customRange(customFrom, customTo)); setShowCustom(false); }, children: "Apply" })] }), _jsx("nav", { className: "usage-reports__tabs", "aria-label": "Usage report", children: ['model', 'user'].map((group) => _jsx("button", { className: groupBy === group ? 'active' : '', type: "button", onClick: () => { setGroupBy(group); setSortField(group === 'model' ? 'totalTokens' : 'costUSD'); setAscending(false); }, children: group === 'model' ? 'Models' : 'Users' }, group)) }), _jsxs("section", { className: "usage-reports__card", children: [_jsxs("div", { className: "usage-reports__totals", children: [_jsxs("span", { children: [_jsx("strong", { children: report?.totals.requestCount.toLocaleString() ?? '0' }), " requests"] }), _jsxs("span", { children: [_jsx("strong", { children: formatTokens(report?.totals.totalTokens ?? 0) }), " tokens"] }), _jsxs("span", { children: [_jsxs("strong", { children: ["$", (report?.totals.costUSD ?? 0).toFixed(2)] }), " cost"] })] }), loading && _jsx("p", { className: "usage-reports__state", children: "Loading usage..." }), error && _jsxs("p", { className: "usage-reports__state usage-reports__error", children: ["Failed to load: ", error] }), !loading && !error && rows.length === 0 && _jsx("p", { className: "usage-reports__state", children: "No usage in this date range." }), !loading && !error && rows.length > 0 && _jsx("div", { className: "usage-reports__table-wrap", children: _jsxs("table", { children: [_jsx("thead", { children: _jsx("tr", { children: columns.map((column) => _jsx("th", { children: _jsxs("button", { type: "button", onClick: () => sort(column.field), children: [column.label, sortField === column.field ? (ascending ? ' ▲' : ' ▼') : ''] }) }, column.field)) }) }), _jsx("tbody", { children: rows.map((row) => _jsx("tr", { children: columns.map((column) => _jsx("td", { children: column.value(row) }, column.field)) }, row.key)) })] }) })] })] }));
+}
+//# sourceMappingURL=UsageReports.js.map

package/dist/client/UsageReports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UsageReports.js","sourceRoot":"","sources":["../../src/client/UsageReports.tsx"],"names":[],"mappings":"AAAA,YAAY,CAAC;;AAEb,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAG5C,OAAO,cAAc,CAAC;AAKtB,MAAM,OAAO,GAAG;IACd,EAAE,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,EAAE;IACjC,EAAE,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,EAAE,EAAE;IACnC,EAAE,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,EAAE,EAAE;CACpC,CAAC;AAEF,SAAS,YAAY,CAAC,IAAY,EAAE,KAAa;IAC/C,MAAM,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC;IACtB,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,EAAE,CAAC,CAAC;IAC1B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;IAC1C,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,WAAW,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,CAAC;AACnE,CAAC;AAED,SAAS,SAAS,CAAC,KAAa;IAC9B,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AAC5B,CAAC;AAED,SAAS,WAAW,CAAC,IAAY,EAAE,EAAU;IAC3C,OAAO;QACL,IAAI,EAAE,IAAI,IAAI,CAAC,GAAG,IAAI,gBAAgB,CAAC,CAAC,WAAW,EAAE;QACrD,EAAE,EAAE,IAAI,IAAI,CAAC,GAAG,EAAE,gBAAgB,CAAC,CAAC,WAAW,EAAE;QACjD,KAAK,EAAE,GAAG,IAAI,MAAM,EAAE,EAAE;KACzB,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,KAAa;IACjC,IAAI,KAAK,IAAI,aAAa;QAAE,OAAO,GAAG,CAAC,KAAK,GAAG,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC;IAC5E,IAAI,KAAK,IAAI,SAAS;QAAE,OAAO,GAAG,CAAC,KAAK,GAAG,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC;IACpE,IAAI,KAAK,IAAI,KAAK;QAAE,OAAO,GAAG,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC;IAC5D,OAAO,KAAK,CAAC,cAAc,EAAE,CAAC;AAChC,CAAC;AAED,MAAM,UAAU,mBAAmB;IACjC,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,EAAE,CAAC;IAC/B,OAAO,YAAG,SAAS,EAAC,wBAAwB,EAAC,IAAI,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,kBAAkB,gCAAqB,CAAC;AACnH,CAAC;AAED,MAAM,UAAU,YAAY;IAC1B,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,EAAE,CAAC;IAC/B,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,QAAQ,CAA8C,OAAO,CAAC,CAAC;IAC7F,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAY,GAAG,EAAE,CAAC,YAAY,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC,CAAC;IACtF,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IACpD,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,GAAG,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IACpE,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,GAAG,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9D,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,QAAQ,EAAe,CAAC;IACpD,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,EAAU,CAAC;IAC7C,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC7C,MAAM,CAAC,SAAS,EAAE,YAAY,CAAC,GAAG,QAAQ,CAAY,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACvG,MAAM,CAAC,SAAS,EAAE,YAAY,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAElD,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QACzC,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;QAChF,UAAU,CAAC,IAAI,CAAC,CAAC;QACjB,QAAQ,CAAC,SAAS,CAAC,CAAC;QACpB,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,iBAAiB,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,CAAC;aAChF,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;YACvB,IAAI,CAAC,QAAQ,CAAC,EAAE;gBAAE,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;YAC/E,SAAS,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAiB,CAAC,CAAC;QAClD,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,MAAe,EAAE,EAAE;YACzB,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,OAAO;gBAAE,QAAQ,CAAC,MAAM,YAAY,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,6BAA6B,CAAC,CAAC;QACrH,CAAC,CAAC;aACD,OAAO,CAAC,GAAG,EAAE;YACZ,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,OAAO;gBAAE,UAAU,CAAC,KAAK,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QACL,OAAO,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;IAExC,MAAM,IAAI,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACnD,MAAM,IAAI,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC;QAC1B,MAAM,KAAK,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC;QAC3B,MAAM,MAAM,GAAG,OAAO,IAAI,KAAK,QAAQ;YACrC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACnC,CAAC,CAAC,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QACzB,OAAO,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;IACtC,CAAC,CAAC,CAAC;IACH,MAAM,OAAO,GAAuF;QAClG,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE;QAC5F,EAAE,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,cAAc,EAAE,EAAE;QAC/F,EAAE,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE;QAC9F,EAAE,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE;QACvF,EAAE,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE;QAC1F,EAAE,KAAK,EAAE,mBAAmB,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC,iBAAiB,CAAC,EAAE;QACpG,EAAE,KAAK,EAAE,iBAAiB,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE;QACnG,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;KAClF,CAAC;IAEF,SAAS,IAAI,CAAC,KAAgB;QAC5B,IAAI,SAAS,KAAK,KAAK;YAAE,YAAY,CAAC,CAAC,SAAS,CAAC,CAAC;aAC7C,CAAC;YACJ,YAAY,CAAC,KAAK,CAAC,CAAC;YACpB,YAAY,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC;IACH,CAAC;IAED,OAAO,CACL,eAAK,SAAS,EAAC,eAAe,aAC5B,kBAAQ,SAAS,EAAC,uBAAuB,aACvC,0BACE,2CAAwB,EACxB,sBAAI,KAAK,CAAC,KAAK,GAAK,IAChB,EACN,eAAK,SAAS,EAAC,uBAAuB,aACnC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,iBAA0B,IAAI,EAAC,QAAQ,EAAC,OAAO,EAAE,GAAG,EAAE,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,YAAG,MAAM,CAAC,KAAK,IAArI,MAAM,CAAC,IAAI,CAAoI,CAAC,EACtL,iBAAQ,IAAI,EAAC,QAAQ,EAAC,OAAO,EAAE,GAAG,EAAE,CAAC,aAAa,CAAC,CAAC,UAAU,CAAC,uBAAiB,IAC5E,IACC,EACR,UAAU,IAAI,eAAK,SAAS,EAAC,uBAAuB,aACnD,oCAAW,gBAAO,IAAI,EAAC,MAAM,EAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,GAAI,IAAQ,EACnH,kCAAS,gBAAO,IAAI,EAAC,MAAM,EAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,GAAI,IAAQ,EAC7G,iBAAQ,IAAI,EAAC,QAAQ,EAAC,QAAQ,EAAE,CAAC,UAAU,IAAI,CAAC,QAAQ,IAAI,UAAU,GAAG,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,sBAAgB,IACpL,EACN,cAAK,SAAS,EAAC,qBAAqB,gBAAY,cAAc,YAC1D,CAAC,OAAO,EAAE,MAAM,CAAW,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,iBAAQ,SAAS,EAAE,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,EAAc,IAAI,EAAC,QAAQ,EAAC,OAAO,EAAE,GAAG,EAAE,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,KAAK,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,YAAG,KAAK,KAAK,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,IAArL,KAAK,CAA0L,CAAC,GACpS,EACN,mBAAS,SAAS,EAAC,qBAAqB,aACtC,eAAK,SAAS,EAAC,uBAAuB,aACpC,2BAAM,2BAAS,MAAM,EAAE,MAAM,CAAC,YAAY,CAAC,cAAc,EAAE,IAAI,GAAG,GAAU,iBAAgB,EAC5F,2BAAM,2BAAS,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,WAAW,IAAI,CAAC,CAAC,GAAU,eAAc,EACpF,2BAAM,kCAAU,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAU,aAAY,IAC1E,EACL,OAAO,IAAI,YAAG,SAAS,EAAC,sBAAsB,iCAAqB,EACnE,KAAK,IAAI,aAAG,SAAS,EAAC,2CAA2C,iCAAkB,KAAK,IAAK,EAC7F,CAAC,OAAO,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,YAAG,SAAS,EAAC,sBAAsB,6CAAiC,EAC/G,CAAC,OAAO,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,cAAK,SAAS,EAAC,2BAA2B,YAAC,4BACnF,0BAAO,uBAAK,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,uBAAuB,kBAAQ,IAAI,EAAC,QAAQ,EAAC,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,aAAG,MAAM,CAAC,KAAK,EAAE,SAAS,KAAK,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,IAAU,IAA3J,MAAM,CAAC,KAAK,CAAoJ,CAAC,GAAM,GAAQ,EAC5N,0BAAQ,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,uBAAmB,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,uBAAwB,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,IAAhC,MAAM,CAAC,KAAK,CAA0B,CAAC,IAAlF,GAAG,CAAC,GAAG,CAAiF,CAAC,GAAS,IAC/H,GAAM,IACN,IACN,CACP,CAAC;AACJ,CAAC"}

package/dist/client/UsageReports.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=UsageReports.spec.d.ts.map

package/dist/client/UsageReports.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UsageReports.spec.d.ts","sourceRoot":"","sources":["../../src/client/UsageReports.spec.tsx"],"names":[],"mappings":""}

package/dist/client/UsageReports.spec.js

@@ -0,0 +1,35 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { fireEvent, render, screen, waitFor } from '@testing-library/react';
+import { afterEach, describe, expect, it, vi } from 'vitest';
+import { UsageReports } from './UsageReports.js';
+vi.mock('@payloadcms/ui', () => ({
+    useConfig: () => ({ config: { routes: { admin: '/admin', api: '/api' } } }),
+}));
+const modelRows = [
+    { key: 'small', label: 'Small', requestCount: 1, inputTokens: 1, outputTokens: 1, cachedInputTokens: 0, cacheWriteTokens: 0, reasoningTokens: 0, totalTokens: 2, costUSD: 0.1 },
+    { key: 'large', label: 'Large', requestCount: 2, inputTokens: 6, outputTokens: 4, cachedInputTokens: 0, cacheWriteTokens: 0, reasoningTokens: 0, totalTokens: 10, costUSD: 0.5 },
+];
+describe('UsageReports', () => {
+    afterEach(() => vi.unstubAllGlobals());
+    it('loads the Firmware models/users and date range slice', async () => {
+        const fetch = vi.fn().mockResolvedValue(new Response(JSON.stringify({
+            groupBy: 'model',
+            from: '2026-01-01T00:00:00.000Z',
+            to: '2026-02-01T00:00:00.000Z',
+            rows: modelRows,
+            totals: { requestCount: 3, inputTokens: 7, outputTokens: 5, cachedInputTokens: 0, cacheWriteTokens: 0, reasoningTokens: 0, totalTokens: 12, costUSD: 0.6 },
+        }), { status: 200 }));
+        vi.stubGlobal('fetch', fetch);
+        render(_jsx(UsageReports, {}));
+        expect(screen.getByRole('heading', { name: 'Usage Analytics' })).toBeTruthy();
+        expect(screen.getByRole('button', { name: 'Last 7 days' })).toBeTruthy();
+        await waitFor(() => expect(screen.getByText('Large')).toBeTruthy());
+        expect(fetch).toHaveBeenCalledWith(expect.stringContaining('/api/usage/report?groupBy=model'), expect.any(Object));
+        fireEvent.click(screen.getByRole('button', { name: 'Users' }));
+        await waitFor(() => expect(fetch).toHaveBeenCalledWith(expect.stringContaining('groupBy=user'), expect.any(Object)));
+        fireEvent.click(screen.getByRole('button', { name: 'Custom' }));
+        expect(screen.getByLabelText('From')).toBeTruthy();
+        expect(screen.getByLabelText('To')).toBeTruthy();
+    });
+});
+//# sourceMappingURL=UsageReports.spec.js.map

package/dist/client/UsageReports.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UsageReports.spec.js","sourceRoot":"","sources":["../../src/client/UsageReports.spec.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAC5E,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAE7D,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,EAAE,CAAC,IAAI,CAAC,gBAAgB,EAAE,GAAG,EAAE,CAAC,CAAC;IAC/B,SAAS,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;CAC5E,CAAC,CAAC,CAAC;AAEJ,MAAM,SAAS,GAAG;IAChB,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,iBAAiB,EAAE,CAAC,EAAE,gBAAgB,EAAE,CAAC,EAAE,eAAe,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE;IAC/K,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,iBAAiB,EAAE,CAAC,EAAE,gBAAgB,EAAE,CAAC,EAAE,eAAe,EAAE,CAAC,EAAE,WAAW,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE;CACjL,CAAC;AAEF,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,SAAS,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAEvC,EAAE,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;QACpE,MAAM,KAAK,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC;YAClE,OAAO,EAAE,OAAO;YAChB,IAAI,EAAE,0BAA0B;YAChC,EAAE,EAAE,0BAA0B;YAC9B,IAAI,EAAE,SAAS;YACf,MAAM,EAAE,EAAE,YAAY,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,iBAAiB,EAAE,CAAC,EAAE,gBAAgB,EAAE,CAAC,EAAE,eAAe,EAAE,CAAC,EAAE,WAAW,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE;SAC3J,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;QACtB,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC9B,MAAM,CAAC,KAAC,YAAY,KAAG,CAAC,CAAC;QAEzB,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,iBAAiB,EAAE,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;QAC9E,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;QACzE,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC;QACpE,MAAM,CAAC,KAAK,CAAC,CAAC,oBAAoB,CAAC,MAAM,CAAC,gBAAgB,CAAC,iCAAiC,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;QAEnH,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;QAC/D,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,oBAAoB,CAAC,MAAM,CAAC,gBAAgB,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAErH,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;QAChE,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;QACnD,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;IACnD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/client/styles.css

@@ -0,0 +1,148 @@
+.usage-reports {
+  display: grid;
+  gap: 24px;
+  padding: 40px;
+}
+
+.usage-reports__header {
+  align-items: flex-start;
+  display: flex;
+  gap: 24px;
+  justify-content: space-between;
+}
+
+.usage-reports__header h1,
+.usage-reports__header p {
+  margin: 0;
+}
+
+.usage-reports__header p {
+  color: var(--theme-elevation-500);
+  margin-top: 6px;
+}
+
+.usage-reports__ranges,
+.usage-reports__tabs,
+.usage-reports__custom {
+  display: flex;
+  flex-wrap: wrap;
+  gap: 8px;
+}
+
+.usage-reports button,
+.usage-reports-nav-link {
+  background: var(--theme-elevation-100);
+  border: 1px solid var(--theme-elevation-200);
+  border-radius: var(--style-radius-s);
+  color: var(--theme-text);
+  cursor: pointer;
+  padding: 9px 14px;
+}
+
+.usage-reports-nav-link {
+  display: block;
+  margin: 4px 8px;
+  text-decoration: none;
+}
+
+.usage-reports__tabs button.active {
+  background: var(--theme-elevation-800);
+  color: var(--theme-elevation-0);
+}
+
+.usage-reports__custom {
+  align-items: end;
+  background: var(--theme-elevation-50);
+  border: 1px solid var(--theme-elevation-150);
+  border-radius: var(--style-radius-m);
+  padding: 16px;
+}
+
+.usage-reports__custom label {
+  display: grid;
+  gap: 6px;
+}
+
+.usage-reports__custom input {
+  background: var(--theme-input-bg);
+  border: 1px solid var(--theme-elevation-200);
+  border-radius: var(--style-radius-s);
+  color: var(--theme-text);
+  padding: 9px;
+}
+
+.usage-reports__card {
+  background: var(--theme-elevation-50);
+  border: 1px solid var(--theme-elevation-150);
+  border-radius: var(--style-radius-m);
+  overflow: hidden;
+}
+
+.usage-reports__totals {
+  display: flex;
+  flex-wrap: wrap;
+  gap: 32px;
+  padding: 20px;
+}
+
+.usage-reports__totals span {
+  color: var(--theme-elevation-500);
+  display: grid;
+  gap: 4px;
+}
+
+.usage-reports__totals strong {
+  color: var(--theme-text);
+  font-size: 22px;
+}
+
+.usage-reports__table-wrap {
+  overflow-x: auto;
+}
+
+.usage-reports table {
+  border-collapse: collapse;
+  min-width: 900px;
+  width: 100%;
+}
+
+.usage-reports th,
+.usage-reports td {
+  border-top: 1px solid var(--theme-elevation-150);
+  padding: 13px 16px;
+  text-align: right;
+  white-space: nowrap;
+}
+
+.usage-reports th:first-child,
+.usage-reports td:first-child {
+  font-weight: 600;
+  text-align: left;
+}
+
+.usage-reports th button {
+  background: none;
+  border: 0;
+  font-weight: 600;
+  padding: 0;
+}
+
+.usage-reports__state {
+  color: var(--theme-elevation-500);
+  padding: 32px;
+  text-align: center;
+}
+
+.usage-reports__error {
+  color: var(--theme-error-500);
+}
+
+@media (max-width: 768px) {
+  .usage-reports {
+    padding: 20px;
+  }
+
+  .usage-reports__header {
+    flex-direction: column;
+  }
+}

package/dist/client.d.ts

@@ -0,0 +1,3 @@
+export { UsageReports, UsageReportsNavLink } from './client/UsageReports.js';
+export type { UsageReport, UsageReportGroup, UsageReportRow } from './index.js';
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC7E,YAAY,EAAE,WAAW,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC"}

package/dist/client.js

@@ -0,0 +1,2 @@
+export { UsageReports, UsageReportsNavLink } from './client/UsageReports.js';
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,27 @@
+import type { Plugin } from 'frogbot';
+export type UsageReportGroup = 'apiKey' | 'day' | 'model' | 'user';
+export type UsageReportRow = {
+    key: string;
+    label: string;
+    requestCount: number;
+    inputTokens: number;
+    outputTokens: number;
+    cachedInputTokens: number;
+    cacheWriteTokens: number;
+    reasoningTokens: number;
+    totalTokens: number;
+    costUSD: number;
+};
+export type UsageReport = {
+    groupBy: UsageReportGroup;
+    from: string;
+    to: string;
+    rows: UsageReportRow[];
+    totals: Omit<UsageReportRow, 'key' | 'label'>;
+};
+export type UsageReportsPluginOptions = {
+    pageSize?: number;
+    rawExport?: boolean;
+};
+export declare function usageReportsPlugin(options?: UsageReportsPluginOptions): Plugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAA4B,MAAM,EAAE,MAAM,SAAS,CAAC;AAEhE,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG,KAAK,GAAG,OAAO,GAAG,MAAM,CAAC;AAEnE,MAAM,MAAM,cAAc,GAAG;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,gBAAgB,EAAE,MAAM,CAAC;IACzB,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,OAAO,EAAE,gBAAgB,CAAC;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,cAAc,EAAE,CAAC;IACvB,MAAM,EAAE,IAAI,CAAC,cAAc,EAAE,KAAK,GAAG,OAAO,CAAC,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AA+HF,wBAAgB,kBAAkB,CAAC,OAAO,GAAE,yBAA8B,GAAG,MAAM,CAuClF"}

package/dist/index.js

@@ -0,0 +1,171 @@
+import { importExportPlugin } from '@payloadcms/plugin-import-export';
+const groups = new Set(['apiKey', 'day', 'model', 'user']);
+function idAndLabel(value) {
+    if (typeof value === 'string' || typeof value === 'number') {
+        const key = String(value);
+        return { key, label: key };
+    }
+    if (!value || typeof value !== 'object')
+        return;
+    const record = value;
+    if (record.id === undefined)
+        return;
+    const key = String(record.id);
+    const labelValue = record.name ?? record.email ?? record.title ?? record.id;
+    return { key, label: String(labelValue) };
+}
+function groupValue(doc, groupBy) {
+    if (groupBy === 'day') {
+        const date = new Date(String(doc.requestedAt));
+        if (Number.isNaN(date.getTime()))
+            return;
+        const key = date.toISOString().slice(0, 10);
+        return { key, label: key };
+    }
+    if (groupBy === 'model') {
+        const key = typeof doc.model === 'string' && doc.model ? doc.model : 'unknown';
+        return { key, label: key };
+    }
+    return idAndLabel(doc[groupBy]);
+}
+function number(doc, field) {
+    const value = Number(doc[field] ?? 0);
+    return Number.isFinite(value) ? value : 0;
+}
+function emptyRow(key, label) {
+    return {
+        key,
+        label,
+        requestCount: 0,
+        inputTokens: 0,
+        outputTokens: 0,
+        cachedInputTokens: 0,
+        cacheWriteTokens: 0,
+        reasoningTokens: 0,
+        totalTokens: 0,
+        costUSD: 0,
+    };
+}
+function addDoc(row, doc) {
+    row.requestCount += 1;
+    row.inputTokens += number(doc, 'inputTokens');
+    row.outputTokens += number(doc, 'outputTokens');
+    row.cachedInputTokens += number(doc, 'cachedInputTokens');
+    row.cacheWriteTokens += number(doc, 'cacheWriteTokens');
+    row.reasoningTokens += number(doc, 'reasoningTokens');
+    row.totalTokens += number(doc, 'totalTokens');
+    row.costUSD += number(doc, 'costUSD');
+}
+function parseRequest(req) {
+    const search = new URL(req.url ?? '', 'http://localhost').searchParams;
+    const groupBy = search.get('groupBy');
+    const fromDate = new Date(search.get('from') ?? '');
+    const toDate = new Date(search.get('to') ?? '');
+    if (!groupBy || !groups.has(groupBy) || Number.isNaN(fromDate.getTime()) || Number.isNaN(toDate.getTime()) || fromDate > toDate)
+        return;
+    return { groupBy, from: fromDate.toISOString(), to: toDate.toISOString() };
+}
+function buildReportEndpoint(slug, pageSize) {
+    return {
+        method: 'get',
+        path: '/usage/report',
+        handler: async (req) => {
+            if (!req.user)
+                return Response.json({ error: 'Unauthorized' }, { status: 401 });
+            const query = parseRequest(req);
+            if (!query)
+                return Response.json({ error: 'Invalid groupBy or date range' }, { status: 400 });
+            const rows = new Map();
+            let page = 1;
+            while (true) {
+                const result = await req.frogbot.find({
+                    collection: slug,
+                    where: {
+                        and: [
+                            { requestedAt: { greater_than_equal: query.from } },
+                            { requestedAt: { less_than_equal: query.to } },
+                        ],
+                    },
+                    page,
+                    limit: pageSize,
+                    depth: 1,
+                    sort: 'requestedAt',
+                    overrideAccess: true,
+                    req,
+                });
+                for (const value of result.docs) {
+                    const doc = value;
+                    const group = groupValue(doc, query.groupBy);
+                    if (!group)
+                        continue;
+                    const row = rows.get(group.key) ?? emptyRow(group.key, group.label);
+                    if (row.label === row.key && group.label !== group.key)
+                        row.label = group.label;
+                    addDoc(row, doc);
+                    rows.set(group.key, row);
+                }
+                if (!result.hasNextPage)
+                    break;
+                page = result.nextPage ?? page + 1;
+            }
+            const reportRows = [...rows.values()].sort((a, b) => b.costUSD - a.costUSD || b.totalTokens - a.totalTokens || a.label.localeCompare(b.label));
+            const totals = emptyRow('', '');
+            for (const row of reportRows) {
+                totals.requestCount += row.requestCount;
+                totals.inputTokens += row.inputTokens;
+                totals.outputTokens += row.outputTokens;
+                totals.cachedInputTokens += row.cachedInputTokens;
+                totals.cacheWriteTokens += row.cacheWriteTokens;
+                totals.reasoningTokens += row.reasoningTokens;
+                totals.totalTokens += row.totalTokens;
+                totals.costUSD += row.costUSD;
+            }
+            const { key: _key, label: _label, ...reportTotals } = totals;
+            return Response.json({ ...query, rows: reportRows, totals: reportTotals });
+        },
+    };
+}
+export function usageReportsPlugin(options = {}) {
+    const pageSize = options.pageSize ?? 5000;
+    if (!Number.isInteger(pageSize) || pageSize < 1)
+        throw new Error('[plugin-usage-reports] pageSize must be a positive integer.');
+    return async (config) => {
+        if (!config.ai)
+            throw new Error('[plugin-usage-reports] AI configuration is required.');
+        const existing = config.collections.find((collection) => collection.usageLog === true);
+        const usage = existing ?? { slug: 'usage-logs', usageLog: true, fields: [] };
+        const collections = existing
+            ? config.collections.map((collection) => collection === existing
+                ? { ...collection, admin: { ...collection.admin, groupBy: true } }
+                : collection)
+            : [...config.collections, { ...usage, admin: { groupBy: true } }];
+        const next = {
+            ...config,
+            collections,
+            endpoints: [...(config.endpoints ?? []), buildReportEndpoint(usage.slug, pageSize)],
+            admin: {
+                ...config.admin,
+                components: {
+                    ...config.admin?.components,
+                    afterNavLinks: [
+                        ...(config.admin?.components?.afterNavLinks ?? []),
+                        '@frogbotai/plugin-usage-reports/client#UsageReportsNavLink',
+                    ],
+                    views: {
+                        ...(config.admin?.components?.views ?? {}),
+                        usageReports: {
+                            Component: '@frogbotai/plugin-usage-reports/client#UsageReports',
+                            path: '/usage-analytics',
+                        },
+                    },
+                },
+            },
+        };
+        if (options.rawExport === false)
+            return next;
+        return await importExportPlugin({
+            collections: [{ slug: usage.slug, import: false, export: { format: 'csv' } }],
+        })(next);
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AA+BtE,MAAM,MAAM,GAAG,IAAI,GAAG,CAAmB,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;AAE7E,SAAS,UAAU,CAAC,KAAc;IAChC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC3D,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QAC1B,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;IAC7B,CAAC;IACD,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO;IAChD,MAAM,MAAM,GAAG,KAAgC,CAAC;IAChD,IAAI,MAAM,CAAC,EAAE,KAAK,SAAS;QAAE,OAAO;IACpC,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAC9B,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,EAAE,CAAC;IAC5E,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;AAC5C,CAAC;AAED,SAAS,UAAU,CAAC,GAA4B,EAAE,OAAyB;IACzE,IAAI,OAAO,KAAK,KAAK,EAAE,CAAC;QACtB,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;QAC/C,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAAE,OAAO;QACzC,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAC5C,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;IAC7B,CAAC;IACD,IAAI,OAAO,KAAK,OAAO,EAAE,CAAC;QACxB,MAAM,GAAG,GAAG,OAAO,GAAG,CAAC,KAAK,KAAK,QAAQ,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;QAC/E,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;IAC7B,CAAC;IACD,OAAO,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;AAClC,CAAC;AAED,SAAS,MAAM,CAAC,GAA4B,EAAE,KAAa;IACzD,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IACtC,OAAO,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AAC5C,CAAC;AAED,SAAS,QAAQ,CAAC,GAAW,EAAE,KAAa;IAC1C,OAAO;QACL,GAAG;QACH,KAAK;QACL,YAAY,EAAE,CAAC;QACf,WAAW,EAAE,CAAC;QACd,YAAY,EAAE,CAAC;QACf,iBAAiB,EAAE,CAAC;QACpB,gBAAgB,EAAE,CAAC;QACnB,eAAe,EAAE,CAAC;QAClB,WAAW,EAAE,CAAC;QACd,OAAO,EAAE,CAAC;KACX,CAAC;AACJ,CAAC;AAED,SAAS,MAAM,CAAC,GAAmB,EAAE,GAA4B;IAC/D,GAAG,CAAC,YAAY,IAAI,CAAC,CAAC;IACtB,GAAG,CAAC,WAAW,IAAI,MAAM,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;IAC9C,GAAG,CAAC,YAAY,IAAI,MAAM,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;IAChD,GAAG,CAAC,iBAAiB,IAAI,MAAM,CAAC,GAAG,EAAE,mBAAmB,CAAC,CAAC;IAC1D,GAAG,CAAC,gBAAgB,IAAI,MAAM,CAAC,GAAG,EAAE,kBAAkB,CAAC,CAAC;IACxD,GAAG,CAAC,eAAe,IAAI,MAAM,CAAC,GAAG,EAAE,iBAAiB,CAAC,CAAC;IACtD,GAAG,CAAC,WAAW,IAAI,MAAM,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;IAC9C,GAAG,CAAC,OAAO,IAAI,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;AACxC,CAAC;AAED,SAAS,YAAY,CAAC,GAAmB;IACvC,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,EAAE,EAAE,kBAAkB,CAAC,CAAC,YAAY,CAAC;IACvE,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,SAAS,CAA4B,CAAC;IACjE,MAAM,QAAQ,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;IACpD,MAAM,MAAM,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;IAChD,IAAI,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,IAAI,QAAQ,GAAG,MAAM;QAAE,OAAO;IACxI,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,WAAW,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,WAAW,EAAE,EAAE,CAAC;AAC7E,CAAC;AAED,SAAS,mBAAmB,CAAC,IAAY,EAAE,QAAgB;IACzD,OAAO;QACL,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,eAAe;QACrB,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;YACrB,IAAI,CAAC,GAAG,CAAC,IAAI;gBAAE,OAAO,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,cAAc,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;YAChF,MAAM,KAAK,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;YAChC,IAAI,CAAC,KAAK;gBAAE,OAAO,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,+BAA+B,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;YAC9F,MAAM,IAAI,GAAG,IAAI,GAAG,EAA0B,CAAC;YAC/C,IAAI,IAAI,GAAG,CAAC,CAAC;YACb,OAAO,IAAI,EAAE,CAAC;gBACZ,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC;oBACpC,UAAU,EAAE,IAAa;oBACzB,KAAK,EAAE;wBACL,GAAG,EAAE;4BACH,EAAE,WAAW,EAAE,EAAE,kBAAkB,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE;4BACnD,EAAE,WAAW,EAAE,EAAE,eAAe,EAAE,KAAK,CAAC,EAAE,EAAE,EAAE;yBAC/C;qBACF;oBACD,IAAI;oBACJ,KAAK,EAAE,QAAQ;oBACf,KAAK,EAAE,CAAC;oBACR,IAAI,EAAE,aAAa;oBACnB,cAAc,EAAE,IAAI;oBACpB,GAAG;iBACJ,CAAC,CAAC;gBACH,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;oBAChC,MAAM,GAAG,GAAG,KAAgC,CAAC;oBAC7C,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;oBAC7C,IAAI,CAAC,KAAK;wBAAE,SAAS;oBACrB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;oBACpE,IAAI,GAAG,CAAC,KAAK,KAAK,GAAG,CAAC,GAAG,IAAI,KAAK,CAAC,KAAK,KAAK,KAAK,CAAC,GAAG;wBAAE,GAAG,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;oBAChF,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;oBACjB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;gBAC3B,CAAC;gBACD,IAAI,CAAC,MAAM,CAAC,WAAW;oBAAE,MAAM;gBAC/B,IAAI,GAAG,MAAM,CAAC,QAAQ,IAAI,IAAI,GAAG,CAAC,CAAC;YACrC,CAAC;YACD,MAAM,UAAU,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,WAAW,GAAG,CAAC,CAAC,WAAW,IAAI,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;YAC/I,MAAM,MAAM,GAAG,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;YAChC,KAAK,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;gBAC7B,MAAM,CAAC,YAAY,IAAI,GAAG,CAAC,YAAY,CAAC;gBACxC,MAAM,CAAC,WAAW,IAAI,GAAG,CAAC,WAAW,CAAC;gBACtC,MAAM,CAAC,YAAY,IAAI,GAAG,CAAC,YAAY,CAAC;gBACxC,MAAM,CAAC,iBAAiB,IAAI,GAAG,CAAC,iBAAiB,CAAC;gBAClD,MAAM,CAAC,gBAAgB,IAAI,GAAG,CAAC,gBAAgB,CAAC;gBAChD,MAAM,CAAC,eAAe,IAAI,GAAG,CAAC,eAAe,CAAC;gBAC9C,MAAM,CAAC,WAAW,IAAI,GAAG,CAAC,WAAW,CAAC;gBACtC,MAAM,CAAC,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC;YAChC,CAAC;YACD,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,YAAY,EAAE,GAAG,MAAM,CAAC;YAC7D,OAAO,QAAQ,CAAC,IAAI,CAAC,EAAE,GAAG,KAAK,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAwB,CAAC,CAAC;QACnG,CAAC;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,UAAqC,EAAE;IACxE,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC;IAC1C,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,QAAQ,GAAG,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAC;IAChI,OAAO,KAAK,EAAE,MAAM,EAAE,EAAE;QACtB,IAAI,CAAC,MAAM,CAAC,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;QACxF,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,QAAQ,KAAK,IAAI,CAAC,CAAC;QACvF,MAAM,KAAK,GAAG,QAAQ,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,IAAa,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;QACtF,MAAM,WAAW,GAAG,QAAQ;YAC1B,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,KAAK,QAAQ;gBAC9D,CAAC,CAAC,EAAE,GAAG,UAAU,EAAE,KAAK,EAAE,EAAE,GAAG,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;gBAClE,CAAC,CAAC,UAAU,CAAC;YACf,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,WAAW,EAAE,EAAE,GAAG,KAAK,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;QACpE,MAAM,IAAI,GAAG;YACX,GAAG,MAAM;YACT,WAAW;YACX,SAAS,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,IAAI,EAAE,CAAC,EAAE,mBAAmB,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YACnF,KAAK,EAAE;gBACL,GAAG,MAAM,CAAC,KAAK;gBACf,UAAU,EAAE;oBACV,GAAG,MAAM,CAAC,KAAK,EAAE,UAAU;oBAC3B,aAAa,EAAE;wBACb,GAAG,CAAG,MAAM,CAAC,KAAK,EAAE,UAAkD,EAAE,aAAuC,IAAI,EAAE,CAAC;wBACtH,4DAA4D;qBAC7D;oBACD,KAAK,EAAE;wBACL,GAAG,CAAG,MAAM,CAAC,KAAK,EAAE,UAAkD,EAAE,KAA6C,IAAI,EAAE,CAAC;wBAC5H,YAAY,EAAE;4BACZ,SAAS,EAAE,qDAAqD;4BAChE,IAAI,EAAE,kBAAkB;yBACzB;qBACF;iBACF;aACF;SACF,CAAC;QACF,IAAI,OAAO,CAAC,SAAS,KAAK,KAAK;YAAE,OAAO,IAAI,CAAC;QAC7C,OAAO,MAAM,kBAAkB,CAAC;YAC9B,WAAW,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;SAC9E,CAAC,CAAC,IAAa,CAA2B,CAAC;IAC9C,CAAC,CAAC;AACJ,CAAC"}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@frogbotai/plugin-usage-reports",
+  "version": "0.12.0",
+  "description": "Usage analytics reports for FrogBot.",
+  "license": "MIT",
+  "author": "Colby Gilbert",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/frogbotai/frogbot.git",
+    "directory": "packages/plugins/plugin-usage-reports"
+  },
+  "homepage": "https://github.com/frogbotai/frogbot#readme",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./client": {
+      "import": "./dist/client.js",
+      "types": "./dist/client.d.ts",
+      "default": "./dist/client.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": [
+    "*.css"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "peerDependencies": {
+    "@payloadcms/plugin-import-export": "3.85.1",
+    "@payloadcms/ui": "3.85.1",
+    "react": "^19.0.1 || ^19.1.2 || ^19.2.1",
+    "react-dom": "^19.0.1 || ^19.1.2 || ^19.2.1",
+    "frogbot": "0.12.0"
+  },
+  "devDependencies": {
+    "@payloadcms/plugin-import-export": "3.85.1",
+    "@payloadcms/ui": "3.85.1",
+    "@testing-library/react": "^16.3.0",
+    "@types/react": "19.2.14",
+    "react": "19.2.6",
+    "react-dom": "19.2.6",
+    "typescript": "5.6.2",
+    "frogbot": "0.12.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json && cp src/client/styles.css dist/client/styles.css",
+    "clean": "rm -rf dist",
+    "typecheck": "tsc --noEmit"
+  }
+}