@mintlify/cli 4.0.1422 → 4.0.1424

package/bin/welcome.js

@@ -23,7 +23,10 @@ const GROUPS = [
     },
     {
         title: 'Insights',
-        commands: [{ name: 'automations', description: 'Create and manage automations' }],
+        commands: [
+            { name: 'analytics', description: 'View analytics for your site' },
+            { name: 'automations', description: 'Create and manage automations' },
+        ],
     },
     {
         title: 'Account',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mintlify/cli",
-  "version": "4.0.1422",
+  "version": "4.0.1424",
   "description": "The Mintlify CLI",
   "engines": {
     "node": ">=18.0.0"
@@ -45,12 +45,12 @@
   },
   "dependencies": {
     "@inquirer/prompts": "7.9.0",
-    "@mintlify/common": "1.0.1105",
-    "@mintlify/link-rot": "3.0.1306",
+    "@mintlify/common": "1.0.1106",
+    "@mintlify/link-rot": "3.0.1307",
     "@mintlify/models": "0.0.350",
-    "@mintlify/prebuild": "1.0.1258",
-    "@mintlify/previewing": "4.0.1330",
-    "@mintlify/validation": "0.1.838",
+    "@mintlify/prebuild": "1.0.1259",
+    "@mintlify/previewing": "4.0.1331",
+    "@mintlify/validation": "0.1.839",
     "adm-zip": "0.6.0",
     "chalk": "5.2.0",
     "color": "4.2.3",
@@ -82,7 +82,7 @@
     "keytar": "7.9.0"
   },
   "devDependencies": {
-    "@mintlify/editor": "0.0.317",
+    "@mintlify/editor": "0.0.318",
     "@mintlify/ts-config": "2.0.2",
     "@tsconfig/recommended": "1.0.2",
     "@types/detect-port": "1.3.2",
@@ -101,5 +101,5 @@
     "vitest": "2.1.9",
     "vitest-mock-process": "1.0.4"
   },
-  "gitHead": "8631a49a928983c1958ca93c7414d56f68f46d4c"
+  "gitHead": "e8a5ad3c686ea02e33d89fc65ffe7a22a7246dac"
 }

package/src/analytics/client.ts

@@ -0,0 +1,153 @@
+import { authenticatedFetch } from '../authenticatedFetch.js';
+import { API_URL } from '../constants.js';
+import type {
+  AssistantThreadResponse,
+  BucketThreadsResponse,
+  BucketsResponse,
+  ConversationResponse,
+  FeedbackByPageResponse,
+  FeedbackResponse,
+  KpiResponse,
+  SearchResponse,
+  ViewsResponse,
+  VisitorsResponse,
+} from './types.js';
+
+type Params = Record<string, string | number | undefined>;
+
+async function request<T>(path: string, params: Params = {}): Promise<T> {
+  const url = new URL(`${API_URL}/api/cli/analytics${path}`);
+  for (const [key, value] of Object.entries(params)) {
+    if (value !== undefined) url.searchParams.set(key, String(value));
+  }
+
+  const res = await authenticatedFetch(url.toString(), {
+    headers: { Accept: 'application/json' },
+  });
+
+  if (!res.ok) {
+    const body = await res.text().catch(() => '');
+    throw new Error(`API error (${res.status}): ${body || res.statusText}`);
+  }
+
+  return res.json() as Promise<T>;
+}
+
+export function getKpi(
+  opts: {
+    dateFrom: string;
+    dateTo: string;
+    page?: string;
+  },
+  subdomain?: string
+) {
+  return request<KpiResponse>('/kpi', { ...opts, subdomain });
+}
+
+export function getFeedback(
+  opts: {
+    dateFrom: string;
+    dateTo: string;
+    limit?: number;
+    cursor?: string;
+    source?: string;
+    status?: string;
+  },
+  subdomain?: string
+) {
+  return request<FeedbackResponse>('/feedback', { ...opts, subdomain });
+}
+
+export function getFeedbackByPage(
+  opts: {
+    dateFrom: string;
+    dateTo: string;
+    limit?: number;
+    source?: string;
+    status?: string;
+  },
+  subdomain?: string
+) {
+  return request<FeedbackByPageResponse>('/feedback/by-page', { ...opts, subdomain });
+}
+
+export function getConversations(
+  opts: {
+    dateFrom: string;
+    dateTo: string;
+    limit?: number;
+    cursor?: string;
+  },
+  subdomain?: string
+) {
+  return request<ConversationResponse>('/assistant', { ...opts, subdomain });
+}
+
+export function getAssistantThread(threadId: string, subdomain?: string) {
+  return request<AssistantThreadResponse>(`/assistant/threads/${encodeURIComponent(threadId)}`, {
+    subdomain,
+  });
+}
+
+export function getSearches(
+  opts: {
+    dateFrom: string;
+    dateTo: string;
+    limit?: number;
+    cursor?: string;
+  },
+  subdomain?: string
+) {
+  return request<SearchResponse>('/searches', { ...opts, subdomain });
+}
+
+export function getViews(
+  opts: {
+    dateFrom: string;
+    dateTo: string;
+    limit?: number;
+    offset?: number;
+  },
+  subdomain?: string
+) {
+  return request<ViewsResponse>('/views', { ...opts, subdomain });
+}
+
+export function getVisitors(
+  opts: {
+    dateFrom: string;
+    dateTo: string;
+    limit?: number;
+    offset?: number;
+  },
+  subdomain?: string
+) {
+  return request<VisitorsResponse>('/visitors', { ...opts, subdomain });
+}
+
+export function getBuckets(
+  opts: {
+    dateFrom?: string;
+    dateTo?: string;
+    topK?: number;
+  },
+  subdomain?: string
+) {
+  return request<BucketsResponse>('/conversations/buckets', { ...opts, subdomain });
+}
+
+export function getBucketThreads(
+  bucketId: string,
+  opts: {
+    dateFrom?: string;
+    dateTo?: string;
+    limit?: number;
+    cursor?: string;
+  },
+  subdomain?: string
+) {
+  return request<BucketThreadsResponse>(`/conversations/buckets/${encodeURIComponent(bucketId)}`, {
+    ...opts,
+    subdomain,
+  });
+}

package/src/analytics/dates.ts

@@ -0,0 +1,6 @@
+export function formatLocalDate(date: Date): string {
+  const year = date.getFullYear();
+  const month = String(date.getMonth() + 1).padStart(2, '0');
+  const day = String(date.getDate()).padStart(2, '0');
+  return `${year}-${month}-${day}`;
+}

package/src/analytics/filters.ts

@@ -0,0 +1,50 @@
+import type {
+  ConversationResponse,
+  FeedbackByPageResponse,
+  FeedbackResponse,
+  SearchResponse,
+} from './types.js';
+
+export function filterSearchResponse(
+  data: SearchResponse,
+  filters: { query?: string; page?: string }
+): SearchResponse {
+  let searches = data.searches;
+
+  if (filters.query) {
+    const query = filters.query.toLowerCase();
+    searches = searches.filter((row) => row.searchQuery.toLowerCase().includes(query));
+  }
+  const page = filters.page;
+  if (page) {
+    searches = searches.filter((row) => row.topClickedPage?.includes(page));
+  }
+
+  return { ...data, searches };
+}
+
+export function filterFeedbackByPageResponse(
+  data: FeedbackByPageResponse,
+  page?: string
+): FeedbackByPageResponse {
+  if (!page) return data;
+  return { ...data, feedback: data.feedback.filter((row) => row.path.includes(page)) };
+}
+
+export function filterFeedbackResponse(data: FeedbackResponse, page?: string): FeedbackResponse {
+  if (!page) return data;
+  return { ...data, feedback: data.feedback.filter((row) => row.path.includes(page)) };
+}
+
+export function filterConversationResponse(
+  data: ConversationResponse,
+  page?: string
+): ConversationResponse {
+  if (!page) return data;
+  return {
+    ...data,
+    conversations: data.conversations.filter((conversation) =>
+      conversation.sources.some((source) => source.url.includes(page))
+    ),
+  };
+}

package/src/analytics/format.ts

@@ -0,0 +1,13 @@
+export function num(n: number): string {
+  return n.toLocaleString('en-US');
+}
+
+export function pct(n: number, total: number): string {
+  if (total === 0) return '\u2014';
+  return ((n / total) * 100).toFixed(1) + '%';
+}
+
+export function truncate(s: string, max: number): string {
+  if (s.length <= max) return s;
+  return s.slice(0, max - 1) + '\u2026';
+}