@mintlify/cli 4.0.1792 → 4.0.1794

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mintlify/cli",
-  "version": "4.0.1792",
+  "version": "4.0.1794",
   "description": "The Mintlify CLI",
   "engines": {
     "node": ">=18.0.0"
@@ -45,13 +45,13 @@
   },
   "dependencies": {
     "@inquirer/prompts": "7.9.0",
-    "@mintlify/common": "1.0.1337",
-    "@mintlify/link-rot": "3.0.1577",
+    "@mintlify/common": "1.0.1338",
+    "@mintlify/link-rot": "3.0.1578",
     "@mintlify/models": "0.0.385",
-    "@mintlify/og": "0.0.136",
-    "@mintlify/prebuild": "1.0.1510",
-    "@mintlify/previewing": "4.0.1595",
-    "@mintlify/validation": "0.1.957",
+    "@mintlify/og": "0.0.137",
+    "@mintlify/prebuild": "1.0.1511",
+    "@mintlify/previewing": "4.0.1596",
+    "@mintlify/validation": "0.1.958",
     "adm-zip": "0.6.0",
     "chalk": "5.2.0",
     "color": "4.2.3",
@@ -87,7 +87,7 @@
     "keytar": "7.9.0"
   },
   "devDependencies": {
-    "@mintlify/editor": "0.0.614",
+    "@mintlify/editor": "0.0.615",
     "@mintlify/ts-config": "2.0.2",
     "@tsconfig/recommended": "1.0.2",
     "@types/detect-port": "1.3.2",
@@ -106,5 +106,5 @@
     "vitest": "2.1.9",
     "vitest-mock-process": "1.0.4"
   },
-  "gitHead": "7a2db4b1b95b33d9aee9631696c6635427f7e440"
+  "gitHead": "bfddb32ecc50b5b165004784b730ee2e7c12b78b"
 }

package/src/cli.tsx

@@ -26,6 +26,7 @@ import { deployFromGithubActions, isGithubActions } from './deploy-github-action
 import { formatGithubSetup, setupGithubDeployment } from './deploy-github-setup.js';
 import { DEPLOY_HELP, deploymentInstructions } from './deploy-instructions.js';
 import { formatDeployment, prepareAgentDeployment } from './deploy.js';
+import { FEEDBACK_CATEGORIES, feedback } from './feedback.js';
 import { formatHandler } from './format.js';
 import {
   checkPort,
@@ -707,6 +708,42 @@ export const cli = ({ packageName = 'mint' }: { packageName?: string }) => {
           await terminate(0);
         }
       )
+      .command(
+        'feedback <message>',
+        'Send feedback to the Mintlify team',
+        (yargs: Argv) =>
+          yargs
+            .positional('message', {
+              type: 'string',
+              demandOption: true,
+              description: 'Feedback to send. Leave out API keys, tokens, and other secrets',
+            })
+            .option('client-id', {
+              type: 'string',
+              demandOption: true,
+              description: 'ID for this report, so the team can tell retries apart',
+            })
+            .option('category', {
+              choices: FEEDBACK_CATEGORIES,
+              demandOption: true,
+              description: 'Feedback category',
+            })
+            .example(
+              '$0 feedback "mint dev crashes on a missing image" --client-id 7f3a --category bug',
+              'Report a bug'
+            )
+            .epilog(
+              'Requires mint login. Never include API keys, tokens, passwords, or other secrets in the message.'
+            ),
+        async (argv) => {
+          const sent = await feedback({
+            message: argv.message,
+            clientId: argv.clientId,
+            category: argv.category,
+          });
+          await terminate(sent ? 0 : 1);
+        }
+      )
       .command('config', 'Manage CLI configuration', (yargs) =>
         yargs
           .command(

package/src/feedback.tsx

@@ -0,0 +1,36 @@
+import { addLog, ErrorLog, SuccessLog } from '@mintlify/previewing';
+
+import { authenticatedFetch } from './authenticatedFetch.js';
+import { API_URL } from './constants.js';
+
+export const FEEDBACK_CATEGORIES = ['bug', 'docs', 'idea'] as const;
+
+export type FeedbackInput = {
+  message: string;
+  clientId: string;
+  category: (typeof FEEDBACK_CATEGORIES)[number];
+};
+
+const LOGIN_REQUIRED = 'not logged in. Run `mint login` first, then retry.';
+
+export async function sendFeedback(input: FeedbackInput): Promise<string | undefined> {
+  let res: Response;
+  try {
+    res = await authenticatedFetch(`${API_URL}/api/cli/feedback`, {
+      method: 'POST',
+      headers: { 'Content-Type': 'application/json' },
+      body: JSON.stringify({ ...input, source: 'cli' }),
+    });
+  } catch (error) {
+    const notLoggedIn = error instanceof Error && /not authenticated/i.test(error.message);
+    return notLoggedIn ? LOGIN_REQUIRED : 'could not reach the server';
+  }
+  if (res.status === 401) return LOGIN_REQUIRED;
+  return res.ok ? undefined : `could not send feedback (HTTP ${res.status})`;
+}
+
+export async function feedback(input: FeedbackInput): Promise<boolean> {
+  const error = await sendFeedback(input);
+  addLog(error ? <ErrorLog message={error} /> : <SuccessLog message="feedback sent" />);
+  return !error;
+}