@mintlify/cli 4.0.1422 → 4.0.1423
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/__test__/analytics/client.test.ts +180 -0
- package/__test__/analytics/dates.test.ts +12 -0
- package/__test__/analytics/filters.test.ts +116 -0
- package/__test__/analytics/format.test.ts +137 -0
- package/__test__/telemetry.test.ts +27 -0
- package/__test__/welcome.test.ts +15 -0
- package/bin/analytics/client.js +60 -0
- package/bin/analytics/dates.js +6 -0
- package/bin/analytics/filters.js +27 -0
- package/bin/analytics/format.js +13 -0
- package/bin/analytics/index.js +496 -0
- package/bin/analytics/output.js +75 -0
- package/bin/analytics/types.js +1 -0
- package/bin/cli.js +2 -0
- package/bin/middlewares/telemetryMiddleware.js +16 -0
- package/bin/tsconfig.build.tsbuildinfo +1 -1
- package/bin/welcome.js +4 -1
- package/package.json +2 -2
- package/src/analytics/client.ts +153 -0
- package/src/analytics/dates.ts +6 -0
- package/src/analytics/filters.ts +50 -0
- package/src/analytics/format.ts +13 -0
- package/src/analytics/index.tsx +599 -0
- package/src/analytics/output.ts +99 -0
- package/src/analytics/types.ts +145 -0
- package/src/cli.tsx +2 -0
- package/src/middlewares/telemetryMiddleware.ts +17 -0
- package/src/welcome.ts +4 -1
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
export interface KpiResponse {
|
|
2
|
+
humanVisitors: number;
|
|
3
|
+
humanViews: number;
|
|
4
|
+
humanAssistant: number;
|
|
5
|
+
humanSearches: number;
|
|
6
|
+
humanFeedback: number;
|
|
7
|
+
agentVisitors: number;
|
|
8
|
+
agentViews: number;
|
|
9
|
+
agentMcpSearches: number;
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
export interface BucketSummary {
|
|
13
|
+
id: string;
|
|
14
|
+
questionSummary: string;
|
|
15
|
+
size: number;
|
|
16
|
+
status: string;
|
|
17
|
+
lastAsked: string | null;
|
|
18
|
+
lastOccurredAt: string | null;
|
|
19
|
+
createdAt: string;
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
export interface BucketsResponse {
|
|
23
|
+
data: BucketSummary[];
|
|
24
|
+
pagination: { total: number };
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
export interface BucketThread {
|
|
28
|
+
id: string;
|
|
29
|
+
firstUserMessage: string | null;
|
|
30
|
+
feedback: { up: number; down: number };
|
|
31
|
+
resolutionStatus: string | null;
|
|
32
|
+
length: number;
|
|
33
|
+
createdAt: string;
|
|
34
|
+
lastMessageAt: string | null;
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
export interface BucketThreadsResponse {
|
|
38
|
+
data: BucketThread[];
|
|
39
|
+
pagination: { total: number; hasMore: boolean; nextCursor: string | null };
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
export interface FeedbackItem {
|
|
43
|
+
id: string;
|
|
44
|
+
path: string;
|
|
45
|
+
comment: string | null;
|
|
46
|
+
createdAt: string | null;
|
|
47
|
+
source: string;
|
|
48
|
+
status: string;
|
|
49
|
+
helpful?: boolean;
|
|
50
|
+
contact?: string;
|
|
51
|
+
code?: string;
|
|
52
|
+
filename?: string;
|
|
53
|
+
lang?: string;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
export interface FeedbackResponse {
|
|
57
|
+
feedback: FeedbackItem[];
|
|
58
|
+
nextCursor: string | null;
|
|
59
|
+
hasMore: boolean;
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
export interface FeedbackByPageItem {
|
|
63
|
+
path: string;
|
|
64
|
+
thumbsUp: number;
|
|
65
|
+
thumbsDown: number;
|
|
66
|
+
code: number;
|
|
67
|
+
total: number;
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
export interface FeedbackByPageResponse {
|
|
71
|
+
feedback: FeedbackByPageItem[];
|
|
72
|
+
hasMore: boolean;
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
export interface ConversationSource {
|
|
76
|
+
title: string;
|
|
77
|
+
url: string;
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
export interface Conversation {
|
|
81
|
+
id: string;
|
|
82
|
+
timestamp: string;
|
|
83
|
+
query: string;
|
|
84
|
+
response: string;
|
|
85
|
+
sources: ConversationSource[];
|
|
86
|
+
queryCategory: string | null;
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
export interface ConversationResponse {
|
|
90
|
+
conversations: Conversation[];
|
|
91
|
+
nextCursor: string | null;
|
|
92
|
+
hasMore: boolean;
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
export interface AssistantThreadMessage {
|
|
96
|
+
id: string;
|
|
97
|
+
role: 'user' | 'assistant';
|
|
98
|
+
content: string;
|
|
99
|
+
createdAt: string;
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
export interface AssistantThreadResponse {
|
|
103
|
+
threadId: string;
|
|
104
|
+
createdAt: string;
|
|
105
|
+
messages: AssistantThreadMessage[];
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
export interface SearchRow {
|
|
109
|
+
searchQuery: string;
|
|
110
|
+
hits: number;
|
|
111
|
+
ctr: number;
|
|
112
|
+
topClickedPage: string | null;
|
|
113
|
+
lastSearchedAt: string;
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
export interface SearchResponse {
|
|
117
|
+
searches: SearchRow[];
|
|
118
|
+
totalSearches: number;
|
|
119
|
+
nextCursor: string | null;
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
export interface TrafficTotals {
|
|
123
|
+
human: number;
|
|
124
|
+
ai: number;
|
|
125
|
+
total: number;
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
export interface TrafficRow {
|
|
129
|
+
path: string;
|
|
130
|
+
human: number;
|
|
131
|
+
ai: number;
|
|
132
|
+
total: number;
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
export interface ViewsResponse {
|
|
136
|
+
totals: TrafficTotals;
|
|
137
|
+
views: TrafficRow[];
|
|
138
|
+
hasMore: boolean;
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
export interface VisitorsResponse {
|
|
142
|
+
totals: TrafficTotals;
|
|
143
|
+
visitors: TrafficRow[];
|
|
144
|
+
hasMore: boolean;
|
|
145
|
+
}
|
package/src/cli.tsx
CHANGED
|
@@ -20,6 +20,7 @@ import { hideBin } from 'yargs/helpers';
|
|
|
20
20
|
|
|
21
21
|
import { accessibilityCheck } from './accessibilityCheck.js';
|
|
22
22
|
import { addDomain } from './addDomain.js';
|
|
23
|
+
import { analyticsBuilder } from './analytics/index.js';
|
|
23
24
|
import { comingSoon } from './comingSoon.js';
|
|
24
25
|
import { setTelemetryEnabled } from './config.js';
|
|
25
26
|
import { getConfigValue, setConfigValue, clearConfigValue } from './config.js';
|
|
@@ -721,6 +722,7 @@ export const cli = ({ packageName = 'mint' }: { packageName?: string }) => {
|
|
|
721
722
|
}
|
|
722
723
|
}
|
|
723
724
|
)
|
|
725
|
+
.command('analytics', 'View analytics for your documentation', analyticsBuilder)
|
|
724
726
|
.command(
|
|
725
727
|
['automations', 'workflow', 'workflows'],
|
|
726
728
|
'Create and manage automations',
|
|
@@ -3,13 +3,17 @@ import { getVersions } from '../helpers.js';
|
|
|
3
3
|
import { trackCommand } from '../telemetry/track.js';
|
|
4
4
|
|
|
5
5
|
const SCRAPE_SUBCOMMANDS = new Set(['page', 'site', 'openapi']);
|
|
6
|
+
const ANALYTICS_SUBCOMMANDS = new Set(['stats', 'search', 'feedback', 'conversation']);
|
|
6
7
|
const CONFIG_SUBCOMMANDS = new Set(['set', 'get', 'clear']);
|
|
8
|
+
const CONVERSATION_SUBCOMMANDS = new Set(['list', 'view', 'buckets']);
|
|
9
|
+
const BUCKETS_SUBCOMMANDS = new Set(['list', 'view']);
|
|
7
10
|
|
|
8
11
|
export function getSanitizedCommandForTelemetry(_: (string | number)[]): string {
|
|
9
12
|
const parts = _.filter((p): p is string => typeof p === 'string');
|
|
10
13
|
if (parts.length === 0) return '';
|
|
11
14
|
const first = parts[0]!;
|
|
12
15
|
const second = parts[1];
|
|
16
|
+
const third = parts[2];
|
|
13
17
|
|
|
14
18
|
if (first === 'scrape' && second !== undefined && SCRAPE_SUBCOMMANDS.has(second)) {
|
|
15
19
|
return `scrape ${second}`;
|
|
@@ -19,6 +23,19 @@ export function getSanitizedCommandForTelemetry(_: (string | number)[]): string
|
|
|
19
23
|
return `config ${second}`;
|
|
20
24
|
}
|
|
21
25
|
|
|
26
|
+
if (first === 'analytics' && second !== undefined && ANALYTICS_SUBCOMMANDS.has(second)) {
|
|
27
|
+
if (second === 'conversation' && third !== undefined) {
|
|
28
|
+
if (CONVERSATION_SUBCOMMANDS.has(third)) {
|
|
29
|
+
const fourth = parts[3];
|
|
30
|
+
if (third === 'buckets' && fourth !== undefined && BUCKETS_SUBCOMMANDS.has(fourth)) {
|
|
31
|
+
return `analytics conversation buckets ${fourth}`;
|
|
32
|
+
}
|
|
33
|
+
return `analytics conversation ${third}`;
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
return `analytics ${second}`;
|
|
37
|
+
}
|
|
38
|
+
|
|
22
39
|
return first;
|
|
23
40
|
}
|
|
24
41
|
|
package/src/welcome.ts
CHANGED
|
@@ -36,7 +36,10 @@ const GROUPS: CommandGroup[] = [
|
|
|
36
36
|
},
|
|
37
37
|
{
|
|
38
38
|
title: 'Insights',
|
|
39
|
-
commands: [
|
|
39
|
+
commands: [
|
|
40
|
+
{ name: 'analytics', description: 'View analytics for your site' },
|
|
41
|
+
{ name: 'automations', description: 'Create and manage automations' },
|
|
42
|
+
],
|
|
40
43
|
},
|
|
41
44
|
{
|
|
42
45
|
title: 'Account',
|