@mintlify/cli 4.0.1077 → 4.0.1079

package/__test__/openApiCheck.test.ts

@@ -3,6 +3,7 @@ import * as previewing from '@mintlify/previewing';
 import { mockProcessExit } from 'vitest-mock-process';
 
 import { readLocalOpenApiFile } from '../src/helpers.js';
+import { getOpenApiFilenamesFromDocsConfig } from '../src/openApiCheck.js';
 import { mockValidOpenApiDocument, runCommand } from './utils.js';
 
 vi.mock('@mintlify/common', () => ({
@@ -11,8 +12,8 @@ vi.mock('@mintlify/common', () => ({
   validate: vi.fn(),
 }));
 
-vi.mock('../src/helpers.js', async () => {
-  const originalModule = await import('../src/helpers.js');
+vi.mock('../src/helpers.js', async (importOriginal) => {
+  const originalModule = await importOriginal<typeof import('../src/helpers.js')>();
   return {
     ...originalModule,
     readLocalOpenApiFile: vi.fn(),
@@ -22,6 +23,34 @@ vi.mock('../src/helpers.js', async () => {
 const addLogSpy = vi.spyOn(previewing, 'addLog');
 const processExitMock = mockProcessExit();
 
+describe('getOpenApiFilenamesFromDocsConfig', () => {
+  it('reads api.openapi string', () => {
+    expect(
+      getOpenApiFilenamesFromDocsConfig({
+        api: { openapi: 'https://example.com/openapi.yaml' },
+      })
+    ).toEqual(['https://example.com/openapi.yaml']);
+  });
+
+  it('reads api.openapi array and object source form', () => {
+    expect(
+      getOpenApiFilenamesFromDocsConfig({
+        api: { openapi: ['https://a.com/o.yaml', 'https://b.com/o.yaml'] },
+      })
+    ).toEqual(['https://a.com/o.yaml', 'https://b.com/o.yaml']);
+    expect(
+      getOpenApiFilenamesFromDocsConfig({
+        api: { openapi: { source: 'https://c.com/o.yaml' } },
+      })
+    ).toEqual(['https://c.com/o.yaml']);
+  });
+
+  it('returns empty when api or openapi is missing', () => {
+    expect(getOpenApiFilenamesFromDocsConfig({})).toEqual([]);
+    expect(getOpenApiFilenamesFromDocsConfig({ api: {} })).toEqual([]);
+  });
+});
+
 describe('openApiCheck', () => {
   beforeEach(() => {
     vi.clearAllMocks();
@@ -31,12 +60,22 @@ describe('openApiCheck', () => {
     vi.clearAllMocks();
   });
 
+  const expectDeprecationWarning = () => {
+    expect(addLogSpy).toHaveBeenNthCalledWith(
+      1,
+      expect.objectContaining({
+        props: { message: 'openapi-check is deprecated, use `mintlify validate` instead' },
+      })
+    );
+  };
+
   it('valid openApi file from url', async () => {
     vi.mocked(isAllowedLocalSchemaUrl).mockReturnValueOnce(true);
     vi.mocked(getOpenApiDocumentFromUrl).mockResolvedValueOnce(mockValidOpenApiDocument);
 
     await runCommand('openapi-check', 'https://petstore3.swagger.io/api/v3/openapi.json');
 
+    expectDeprecationWarning();
     expect(addLogSpy).toHaveBeenCalledWith(
       expect.objectContaining({
         props: { message: 'OpenAPI definition is valid.' },
@@ -53,6 +92,7 @@ describe('openApiCheck', () => {
 
     await runCommand('openapi-check', 'https://petstore3.swagger.io/api/v3/openapi.json');
 
+    expectDeprecationWarning();
     expect(addLogSpy).toHaveBeenCalledWith(
       expect.objectContaining({
         props: { message: 'Could not parse OpenAPI document.' },
@@ -67,6 +107,7 @@ describe('openApiCheck', () => {
 
     await runCommand('openapi-check', 'http://localhost:3000/openapi.json');
 
+    expectDeprecationWarning();
     expect(addLogSpy).toHaveBeenCalledWith(
       expect.objectContaining({
         props: { message: 'OpenAPI definition is valid.' },
@@ -77,19 +118,16 @@ describe('openApiCheck', () => {
 
   it('invalid openApi file from localhost', async () => {
     vi.mocked(isAllowedLocalSchemaUrl).mockReturnValueOnce(false);
-    vi.mocked(readLocalOpenApiFile).mockResolvedValueOnce(undefined);
 
     await runCommand('openapi-check', 'http://localhost:3000/openapi.json');
 
+    expectDeprecationWarning();
     expect(addLogSpy).toHaveBeenCalledWith(
       expect.objectContaining({
-        props: {
-          message:
-            'failed to parse OpenAPI spec: could not parse file correctly, please check for any syntax errors.',
-        },
+        props: { message: 'include the --local-schema flag to check locally hosted OpenAPI files' },
       })
     );
-    expect(processExitMock).toHaveBeenCalledWith(1);
+    expect(processExitMock).toHaveBeenCalledWith(0);
   });
 
   it('valid openApi file from local file', async () => {
@@ -102,6 +140,7 @@ describe('openApiCheck', () => {
 
     await runCommand('openapi-check', 'test/openapi.yaml');
 
+    expectDeprecationWarning();
     expect(addLogSpy).toHaveBeenCalledWith(
       expect.objectContaining({
         props: { message: 'OpenAPI definition is valid.' },
@@ -117,6 +156,7 @@ describe('openApiCheck', () => {
 
     await runCommand('openapi-check', 'test/openapi.yaml');
 
+    expectDeprecationWarning();
     expect(addLogSpy).toHaveBeenCalledWith(
       expect.objectContaining({
         props: { message: 'some schema parsing error' },

package/bin/cli.js

@@ -8,22 +8,24 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
-import { validate, getOpenApiDocumentFromUrl, isAllowedLocalSchemaUrl } from '@mintlify/common';
 import { buildGraph, getBrokenExternalLinks, renameFilesAndUpdateLinksInContent, } from '@mintlify/link-rot';
 import { addLog, dev, exportSite, validateBuild, ErrorLog, SpinnerLog, SuccessLog, Logs, clearLogs, BrokenLinksLog, WarningLog, } from '@mintlify/previewing';
 import { checkUrl } from '@mintlify/scraping';
 import { render, Text } from 'ink';
+import fs from 'node:fs/promises';
 import path from 'path';
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 import { accessibilityCheck } from './accessibilityCheck.js';
 import { setTelemetryEnabled } from './config.js';
-import { checkPort, checkNodeVersion, autoUpgradeIfNeeded, getVersions, suppressConsoleWarnings, terminate, readLocalOpenApiFile, } from './helpers.js';
+import { CMD_EXEC_PATH } from './constants.js';
+import { checkPort, checkNodeVersion, autoUpgradeIfNeeded, getVersions, suppressConsoleWarnings, terminate, } from './helpers.js';
 import { init } from './init.js';
 import { login } from './login.js';
 import { logout } from './logout.js';
 import { mdxLinter } from './mdxLinter.js';
 import { migrateMdx } from './migrateMdx.js';
+import { checkOpenApiFile, getOpenApiFilenamesFromDocsConfig } from './openApiCheck.js';
 import { scrapeSite, scrapePage, scrapeOpenApi } from './scrape.js';
 import { status } from './status.js';
 import { createTelemetryMiddleware } from './telemetry/middleware.js';
@@ -122,6 +124,19 @@ export const cli = ({ packageName = 'mint' }) => {
     })
         .usage('usage: mintlify validate [options]')
         .example('mintlify validate', 'validate the build'), (argv) => __awaiter(void 0, void 0, void 0, function* () {
+        if (!argv['disable-openapi']) {
+            let openApiFilenames = [];
+            try {
+                const docsJson = yield fs.readFile(path.join(CMD_EXEC_PATH, 'docs.json'), 'utf-8');
+                openApiFilenames = getOpenApiFilenamesFromDocsConfig(JSON.parse(docsJson));
+            }
+            catch (_a) { }
+            const results = yield Promise.all(openApiFilenames.map((file) => checkOpenApiFile(file, argv['local-schema'])));
+            if (results.some((valid) => !valid)) {
+                yield terminate(1);
+                return;
+            }
+        }
         const { cli: cliVersion } = getVersions();
         yield validateBuild(Object.assign(Object.assign({}, argv), { packageName,
             cliVersion }));
@@ -153,7 +168,7 @@ export const cli = ({ packageName = 'mint' }) => {
             cliVersion }));
         yield terminate(0);
     }))
-        .command('openapi-check <filename>', 'check if an openapi spec is valid', (yargs) => yargs
+        .command('openapi-check <filename>', false, (yargs) => yargs
         .positional('filename', {
         describe: 'the filename of the OpenAPI spec (e.g. ./openapi.yaml) or the URL to the OpenAPI spec (e.g. https://petstore3.swagger.io/api/v3/openapi.json)',
         type: 'string',
@@ -164,34 +179,9 @@ export const cli = ({ packageName = 'mint' }) => {
         default: false,
         description: 'use a locally hosted schema file (note: only https protocol is supported in production)',
     }), (_a) => __awaiter(void 0, [_a], void 0, function* ({ filename, 'local-schema': localSchema }) {
-        try {
-            if (isAllowedLocalSchemaUrl(filename, localSchema)) {
-                yield getOpenApiDocumentFromUrl(filename);
-                addLog(_jsx(SuccessLog, { message: "OpenAPI definition is valid." }));
-                yield terminate(0);
-            }
-            if (filename.startsWith('http://') && !localSchema) {
-                addLog(_jsx(WarningLog, { message: "include the --local-schema flag to check locally hosted OpenAPI files" }));
-                addLog(_jsx(WarningLog, { message: "only https protocol is supported in production" }));
-                yield terminate(0);
-            }
-            const document = yield readLocalOpenApiFile(filename);
-            if (!document) {
-                throw new Error('failed to parse OpenAPI spec: could not parse file correctly, please check for any syntax errors.');
-            }
-            yield validate(document);
-            addLog(_jsx(SuccessLog, { message: "OpenAPI definition is valid." }));
-        }
-        catch (err) {
-            if (err && typeof err === 'object' && 'code' in err && err.code === 'ENOENT') {
-                addLog(_jsx(ErrorLog, { message: `file not found, please check the path provided: ${filename}` }));
-            }
-            else {
-                addLog(_jsx(ErrorLog, { message: err instanceof Error ? err.message : 'unknown error' }));
-            }
-            yield terminate(1);
-        }
-        yield terminate(0);
+        addLog(_jsx(WarningLog, { message: "openapi-check is deprecated, use `mintlify validate` instead" }));
+        const valid = yield checkOpenApiFile(filename, localSchema);
+        yield terminate(valid ? 0 : 1);
     }))
         .command('broken-links', 'check for broken links', (yargs) => yargs
         .option('check-anchors', {

package/bin/openApiCheck.js

@@ -0,0 +1,54 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { jsx as _jsx } from "react/jsx-runtime";
+import { validate, getOpenApiDocumentFromUrl, isAllowedLocalSchemaUrl } from '@mintlify/common';
+import { addLog, ErrorLog, SuccessLog, WarningLog } from '@mintlify/previewing';
+import { readLocalOpenApiFile } from './helpers.js';
+export const getOpenApiFilenamesFromDocsConfig = (config) => {
+    var _a;
+    const openapi = (_a = config.api) === null || _a === void 0 ? void 0 : _a.openapi;
+    if (openapi === undefined)
+        return [];
+    if (typeof openapi === 'string')
+        return [openapi];
+    if (Array.isArray(openapi))
+        return openapi;
+    return [openapi.source];
+};
+export const checkOpenApiFile = (filename, localSchema) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        if (isAllowedLocalSchemaUrl(filename, localSchema)) {
+            yield getOpenApiDocumentFromUrl(filename);
+            addLog(_jsx(SuccessLog, { message: "OpenAPI definition is valid." }));
+            return true;
+        }
+        if (filename.startsWith('http://') && !localSchema) {
+            addLog(_jsx(WarningLog, { message: "include the --local-schema flag to check locally hosted OpenAPI files" }));
+            addLog(_jsx(WarningLog, { message: "only https protocol is supported in production" }));
+            return true;
+        }
+        const document = yield readLocalOpenApiFile(filename);
+        if (!document) {
+            throw new Error('failed to parse OpenAPI spec: could not parse file correctly, please check for any syntax errors.');
+        }
+        yield validate(document);
+        addLog(_jsx(SuccessLog, { message: "OpenAPI definition is valid." }));
+        return true;
+    }
+    catch (err) {
+        if (err && typeof err === 'object' && 'code' in err && err.code === 'ENOENT') {
+            addLog(_jsx(ErrorLog, { message: `file not found, please check the path provided: ${filename}` }));
+        }
+        else {
+            addLog(_jsx(ErrorLog, { message: err instanceof Error ? err.message : 'unknown error' }));
+        }
+        return false;
+    }
+});