@mintlify/cli 4.0.1731 → 4.0.1733

package/__test__/agent-claim.test.ts

@@ -2,11 +2,13 @@ import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
 
 import { claimDeployment } from '../src/agent-claim.js';
 import { loadAgentCredentials, saveAgentCredentials } from '../src/agent-credentials.js';
+import { trackEvent } from '../src/telemetry/track.js';
 
 vi.mock('../src/agent-credentials.js', () => ({
   loadAgentCredentials: vi.fn(),
   saveAgentCredentials: vi.fn(),
 }));
+vi.mock('../src/telemetry/track.js', () => ({ trackEvent: vi.fn() }));
 const issuer = 'https://auth.example.com';
 const apiUrl = 'https://api.example.com';
 const options = { apiUrl, directory: '/docs', code: 'ABCDEFGH' };
@@ -72,6 +74,9 @@ describe('claim command', () => {
     expect(vi.mocked(saveAgentCredentials).mock.invocationCallOrder[0]).toBeLessThan(
       fetchMock.mock.invocationCallOrder[3]!
     );
+    expect(vi.mocked(trackEvent).mock.calls).toEqual([
+      ['agent_signup.claim_completed', { registration_id: 'reg' }],
+    ]);
   });
   it('resumes after signup fails without consuming the code again', async () => {
     const implementation = fetchMock.getMockImplementation()!;
@@ -94,6 +99,7 @@ describe('claim command', () => {
     );
     await expect(claimDeployment(options, vi.fn())).rejects.toThrow('invalid_user_code');
     expect(saveAgentCredentials).not.toHaveBeenCalled();
+    expect(trackEvent).not.toHaveBeenCalled();
     expect(fetchMock.mock.calls.some(([url]) => url.endsWith('/signup'))).toBe(false);
   });
   it('warns on storage failure and continues signup without exposing secrets', async () => {
@@ -110,7 +116,12 @@ describe('claim command', () => {
       { apiUrl, directory: '/docs', email: 'person@example.com' },
       vi.fn()
     );
-    expect(output).toContain('mint claim --code');
+    expect(new URL(output.match(/https?:\/\/\S+/)![0]).searchParams.get('registration')).toBe(
+      'reg'
+    );
+    expect(vi.mocked(trackEvent).mock.calls).toEqual([
+      ['agent_signup.claim_started', { registration_id: 'reg' }],
+    ]);
     expect(
       fetchMock.mock.calls.some(([url]) => url.endsWith('/signup') || url.endsWith('/complete'))
     ).toBe(false);

package/__test__/deploy-instructions.test.ts

@@ -3,6 +3,7 @@ import { afterEach, describe, expect, it, vi } from 'vitest';
 import { createAgentClaimLink } from '../src/agent-claim.js';
 import { DASHBOARD_URL } from '../src/constants.js';
 import { deploymentInstructions, DEPLOY_HELP } from '../src/deploy-instructions.js';
+import { trackEvent } from '../src/telemetry/track.js';
 import { renderWelcome } from '../src/welcome.js';
 
 vi.mock('../src/agent-auth.js', async (importOriginal) => ({
@@ -12,6 +13,7 @@ vi.mock('../src/agent-auth.js', async (importOriginal) => ({
     agent_auth: { claim_endpoint: 'https://auth.example.com/agent/identity/claim' },
   }),
 }));
+vi.mock('../src/telemetry/track.js', () => ({ trackEvent: vi.fn() }));
 afterEach(() => vi.unstubAllGlobals());
 const credentials = {
   registrationId: 'reg',
@@ -43,7 +45,10 @@ describe('deploy help and claim handoff', () => {
     vi.stubGlobal('fetch', request);
     expect(
       await createAgentClaimLink('https://api.example.com', credentials, 'user@example.com')
-    ).toBe(`${DASHBOARD_URL}/agent-claim?token=attempt%2Btoken%26value`);
+    ).toBe(`${DASHBOARD_URL}/agent-claim?token=attempt%2Btoken%26value&registration=reg`);
+    expect(trackEvent).toHaveBeenCalledWith('agent_signup.claim_started', {
+      registration_id: 'reg',
+    });
     expect(JSON.parse(request.mock.calls[0]?.[1].body)).toEqual({
       type: 'service_auth',
       claim_token: 'claim-secret',

package/__test__/deploy.test.ts

@@ -6,11 +6,13 @@ import * as storage from '../src/agent-credentials.js';
 import * as deployment from '../src/agent-deployment.js';
 import * as config from '../src/config.js';
 import { prepareAgentDeployment, formatDeployment } from '../src/deploy.js';
+import { trackEvent } from '../src/telemetry/track.js';
 
 vi.mock('../src/agent-auth.js');
 vi.mock('../src/agent-credentials.js');
 vi.mock('../src/agent-deployment.js');
 vi.mock('../src/config.js');
+vi.mock('../src/telemetry/track.js');
 
 const credentials = {
   registrationId: 'reg_1',
@@ -59,6 +61,20 @@ beforeEach(() => {
 });
 
 describe('mint deploy', () => {
+  it('tracks discovery and registration for a new agent', async () => {
+    await prepareAgentDeployment(options, warn);
+    expect(vi.mocked(trackEvent).mock.calls).toEqual([
+      ['agent_signup.discovered', { registration_id: 'reg_1' }],
+      ['agent_signup.registered', { registration_id: 'reg_1' }],
+    ]);
+  });
+  it('tracks only discovery for a saved registration', async () => {
+    vi.mocked(storage.loadAgentCredentials).mockResolvedValue(credentials);
+    await prepareAgentDeployment(options, warn);
+    expect(vi.mocked(trackEvent).mock.calls).toEqual([
+      ['agent_signup.discovered', { registration_id: 'reg_1' }],
+    ]);
+  });
   it.each([
     ['https://leaves.mintlify.com', 'https://allocated.mintlify.site/'],
     ['https://leaves-dev.mintlify.com', 'https://allocated.mint-dev.mintlify.me/'],

package/bin/agent-claim.js

@@ -12,6 +12,7 @@ import { agentIdentityAssertionSchema, discoverAgentAuth, exchangeAgentToken, }
 import { loadAgentCredentials, saveAgentCredentials, } from './agent-credentials.js';
 import { agentRequest, agentResponse } from './agent-http.js';
 import { DASHBOARD_URL } from './constants.js';
+import { trackEvent } from './telemetry/track.js';
 const claimAttemptSchema = z.object({ attempt: z.object({ verification_uri: z.url() }) });
 export function createAgentClaimLink(apiUrl, credentials, email) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -35,6 +36,8 @@ export function createAgentClaimLink(apiUrl, credentials, email) {
             .parse(new URL(claim.attempt.verification_uri).searchParams.get('token'));
         const claimUrl = new URL('/agent-claim', DASHBOARD_URL);
         claimUrl.searchParams.set('token', token);
+        claimUrl.searchParams.set('registration', credentials.registrationId);
+        void trackEvent('agent_signup.claim_started', { registration_id: credentials.registrationId });
         return claimUrl.toString();
     });
 }
@@ -78,6 +81,9 @@ export function claimDeployment(options_1, warn_1) {
                 headers: { 'Content-Type': 'application/json' },
                 body: JSON.stringify({ claim_token: credentials.claimToken, user_code: code }),
             }), completedClaimSchema);
+            void trackEvent('agent_signup.claim_completed', {
+                registration_id: credentials.registrationId,
+            });
             credentials = Object.assign(Object.assign({}, credentials), { assertion: completed.identity.assertion, claimVerified: true, accessToken: undefined, accessTokenExpiresAt: undefined });
             yield save(credentials);
         }

package/bin/deploy.js

@@ -12,6 +12,7 @@ import { discoverAgentAuth, exchangeAgentToken, getAgentIdentity, registerAgent,
 import { loadAgentCredentials, saveAgentCredentials, } from './agent-credentials.js';
 import { getAgentWriteToken, provisionAgentSite, } from './agent-deployment.js';
 import { getAgentSiteMetadata, setAgentSiteMetadata } from './config.js';
+import { trackEvent } from './telemetry/track.js';
 export function prepareAgentDeployment(options_1, warn_1) {
     return __awaiter(this, arguments, void 0, function* (options, warn, progress = () => { }) {
         var _a;
@@ -42,6 +43,9 @@ export function prepareAgentDeployment(options_1, warn_1) {
         });
         for (let attempt = 0; attempt < 2; attempt++) {
             const credentials = saved !== null && saved !== void 0 ? saved : (yield registerAgent(discovery));
+            void trackEvent('agent_signup.discovered', { registration_id: credentials.registrationId });
+            if (!saved)
+                void trackEvent('agent_signup.registered', { registration_id: credentials.registrationId });
             yield save(credentials);
             const authenticated = yield exchangeAgentToken(discovery, credentials);
             yield save(authenticated);

package/bin/telemetry/track.js

@@ -114,11 +114,15 @@ export function trackEvent(event, properties) {
     return __awaiter(this, void 0, void 0, function* () {
         if (!isTelemetryEnabled())
             return;
-        try {
-            const { cli: cliVersion } = getVersions();
-            yield captureWithTimeout(event, Object.assign(Object.assign(Object.assign({}, properties), { cli_version: cliVersion }), getEnvironmentProperties()));
-        }
-        catch (_a) { }
+        const work = (() => __awaiter(this, void 0, void 0, function* () {
+            try {
+                const { cli: cliVersion } = getVersions();
+                yield captureWithTimeout(event, Object.assign(Object.assign(Object.assign({}, properties), { cli_version: cliVersion }), getEnvironmentProperties()));
+            }
+            catch (_a) { }
+        }))();
+        deferShutdownUntil(work);
+        yield work;
     });
 }
 export function trackTelemetryPreferenceChange(options) {