@mintlify/link-rot/dist/static-checking/getOpenApiPagePaths.js

Static checking for broken internal links

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 { categorizeFilePaths } from '@mintlify/prebuild';
import { generateOpenApiPagesForDocsConfig } from '@mintlify/scraping';
import { validateDocsConfig } from '@mintlify/validation';
import fs from 'fs-extra';
import path from 'path';
const DEFAULT_OUTPUT_DIR = 'api-reference';
const getOpenApiDirectory = (baseDir) => __awaiter(void 0, void 0, void 0, function* () {
    var _a;
    const docsJsonPath = path.join(baseDir, 'docs.json');
    if (!fs.existsSync(docsJsonPath))
        return DEFAULT_OUTPUT_DIR;
    try {
        const docsJson = yield fs.readJSON(docsJsonPath);
        const result = validateDocsConfig(docsJson);
        if (!result.success)
            return DEFAULT_OUTPUT_DIR;
        const openapi = (_a = result.data.api) === null || _a === void 0 ? void 0 : _a.openapi;
        if (typeof openapi === 'object' && 'directory' in openapi && openapi.directory) {
            return openapi.directory;
        }
    }
    catch (_b) {
        throw new Error('Unable to parse OpenAPI directory from docs.json');
    }
    return DEFAULT_OUTPUT_DIR;
});
/**
 * Extract virtual page paths that would be generated from OpenAPI specs.
 * These pages don't exist as files but are valid link targets.
 *
 * Note: Uses api.openapi.directory from docs.json, or falls back to 'api-reference'.
 * Per-navigation directory configs are not currently supported.
 */
export const getOpenApiPagePaths = (baseDir) => __awaiter(void 0, void 0, void 0, function* () {
    const pagePaths = [];
    try {
        const [{ openApiFiles }, outDir] = yield Promise.all([
            categorizeFilePaths(baseDir),
            getOpenApiDirectory(baseDir),
        ]);
        for (const openApiFile of openApiFiles) {
            try {
                const { pagesAcc } = yield generateOpenApiPagesForDocsConfig(openApiFile.spec, {
                    openApiFilePath: openApiFile.originalFileLocation,
                    writeFiles: false,
                    outDir,
                });
                pagePaths.push(...Object.keys(pagesAcc));
            }
            catch (err) {
                console.warn(`Warning: Failed to extract pages from OpenAPI spec ${openApiFile.originalFileLocation}: ${err}`);
            }
        }
    }
    catch (err) {
        console.warn(`Warning: Failed to categorize files for OpenAPI extraction: ${err}`);
    }
    return [...new Set(pagePaths)];
});