@mintlify/previewing 4.0.1357 → 4.0.1359

package/dist/local-preview/listener/generate.js

@@ -1,4 +1,5 @@
 import { categorizeFilePaths, createPage, generateDecoratedDocsNavigationFromPages, getMintIgnore, } from '@mintlify/prebuild';
+import { collectOpenApiOverlayConfig, } from '@mintlify/validation';
 import { promises as _promises } from 'fs';
 import { join } from 'path';
 import { CMD_EXEC_PATH } from '../../constants.js';
@@ -21,7 +22,7 @@ const createFilenamePageMetadataMap = async ({ contentDirectoryPath, contentFile
 };
 export const generateNav = async (pagesAcc, docsConfig) => {
     const mintIgnore = await getMintIgnore(CMD_EXEC_PATH);
-    const { contentFilenames, openApiFiles, asyncApiFiles } = await categorizeFilePaths(CMD_EXEC_PATH, mintIgnore);
+    const { contentFilenames, openApiFiles, asyncApiFiles } = await categorizeFilePaths(CMD_EXEC_PATH, mintIgnore, undefined, undefined, { explicitOverlays: collectOpenApiOverlayConfig(docsConfig) });
     const filenamePageMetadataMap = await createFilenamePageMetadataMap({
         contentDirectoryPath: CMD_EXEC_PATH,
         contentFilenames,

package/dist/local-preview/listener/getDocsState.js

@@ -1,11 +1,17 @@
-import { generateOpenApiAnchorsOrTabs, categorizeFilePaths, generateOpenApiDivisions, generateAsyncApiDivisions, generateGraphqlDivisionsFromDocsConfig, getMintIgnore, MintConfigUpdater, DocsConfigUpdater, warnInvalidSpecFiles, loadGraphqlSdlSource, writeGraphqlArtifacts, } from '@mintlify/prebuild';
+import { generateOpenApiAnchorsOrTabs, categorizeFilePaths, generateOpenApiDivisions, generateAsyncApiDivisions, generateGraphqlDivisionsFromDocsConfig, getMintIgnore, MintConfigUpdater, DocsConfigUpdater, readExplicitOverlayConfig, warnInvalidSpecFiles, loadGraphqlSdlSource, writeGraphqlArtifacts, } from '@mintlify/prebuild';
 import { upgradeToDocsConfig } from '@mintlify/validation';
 import fse from 'fs-extra';
 import { join } from 'path';
 import { CMD_EXEC_PATH, CLIENT_PATH } from '../../constants.js';
 export const getDocsState = async (onError, { contentDirectory = CMD_EXEC_PATH, clientDirectory = CLIENT_PATH, } = {}) => {
     const mintIgnore = await getMintIgnore(contentDirectory);
-    const { openApiFiles, asyncApiFiles, invalidSpecFiles } = await categorizeFilePaths(contentDirectory, mintIgnore);
+    const docsJsonConfigPath = join(contentDirectory, 'docs.json');
+    const explicitOverlays = await readExplicitOverlayConfig((await fse.pathExists(docsJsonConfigPath))
+        ? docsJsonConfigPath
+        : join(contentDirectory, 'mint.json'));
+    const { openApiFiles, asyncApiFiles, invalidSpecFiles, overlayRegistry } = await categorizeFilePaths(contentDirectory, mintIgnore, undefined, undefined, {
+        explicitOverlays,
+    });
     let mintConfig;
     let docsConfig;
     let loadedMintConfig;
@@ -29,7 +35,7 @@ export const getDocsState = async (onError, { contentDirectory = CMD_EXEC_PATH,
         throw new Error('No config found');
     const graphqlResult = await generateGraphqlDivisionsFromDocsConfig(docsConfig, (source) => loadGraphqlSdlSource(source, contentDirectory));
     const { newDocsConfig: docsConfigWithGraphqlPages, pagesAcc: pagesAccWithGraphqlPages } = graphqlResult;
-    const { newDocsConfig, pagesAcc: pagesAccWithOpenApiPages, openApiFiles: newOpenApiFiles, flushWrites: flushOpenApiWrites, } = await generateOpenApiDivisions(docsConfigWithGraphqlPages, openApiFiles, clientDirectory, undefined, invalidSpecFiles, pagesAccWithGraphqlPages, true);
+    const { newDocsConfig, pagesAcc: pagesAccWithOpenApiPages, openApiFiles: newOpenApiFiles, flushWrites: flushOpenApiWrites, } = await generateOpenApiDivisions(docsConfigWithGraphqlPages, openApiFiles, clientDirectory, undefined, invalidSpecFiles, pagesAccWithGraphqlPages, true, overlayRegistry);
     const { flushWrites: flushAsyncApiWrites } = await generateAsyncApiDivisions(newDocsConfig, asyncApiFiles, clientDirectory, undefined, pagesAccWithGraphqlPages, false, true);
     await Promise.all([flushOpenApiWrites(), flushAsyncApiWrites()]);
     await writeGraphqlArtifacts(graphqlResult, clientDirectory);

package/dist/local-preview/listener/index.js

@@ -1,6 +1,7 @@
 import { jsx as _jsx } from "react/jsx-runtime";
-import { findAndRemoveImports, hasImports, getFileCategory, validate, stringifyTree, isMintIgnored, replaceVariables, } from '@mintlify/common';
-import { createPage, getFileListSync, MintConfigUpdater, DocsConfigUpdater, preparseMdxTree, prebuild, } from '@mintlify/prebuild';
+import { findAndRemoveImports, hasImports, getFileCategory, normalizeOverlayKey, toPosixPath, validate, stringifyTree, isMintIgnored, replaceVariables, } from '@mintlify/common';
+import { createPage, discoverOverlayFiles, getFileListSync, getMintIgnore, MintConfigUpdater, DocsConfigUpdater, preparseMdxTree, prebuild, } from '@mintlify/prebuild';
+import { isOverlayDocument } from '@mintlify/validation';
 import Chalk from 'chalk';
 import chokidar from 'chokidar';
 import { promises as _promises } from 'fs';
@@ -27,6 +28,29 @@ import { getCurrentVariables, getMintIgnoreGlobs, handleParseError, isFileSizeVa
 const { readFile } = _promises;
 const frontmatterHashes = new Map();
 const SLOW_UPDATE_LOG_THRESHOLD_MS = 1000;
+/**
+ * Overlay files seen by the watcher, so an edit that makes an overlay unparsable (or
+ * removes its `overlay` field) still triggers a rebuild instead of leaving its previous
+ * effects in the preview.
+ */
+let knownOverlayFiles;
+const getKnownOverlayFiles = async () => {
+    if (knownOverlayFiles == undefined) {
+        const files = new Set();
+        try {
+            const mintIgnore = await getMintIgnore(CMD_EXEC_PATH);
+            const discovered = await discoverOverlayFiles(CMD_EXEC_PATH, mintIgnore);
+            for (const overlay of discovered) {
+                files.add(overlay.location);
+            }
+        }
+        catch {
+            // Best effort; the set self-corrects as overlay files change.
+        }
+        knownOverlayFiles = files;
+    }
+    return knownOverlayFiles;
+};
 const getCurrentDocsConfig = async () => {
     const propsDocsJsonPath = pathUtil.join(NEXT_PROPS_PATH, 'docs.json');
     try {
@@ -215,6 +239,28 @@ const onUnlinkEvent = async (filename, triggerRefresh, options) => {
                 console.error('docs.json has been deleted.');
                 await validateConfigFiles();
                 break;
+            case 'potentialYamlOpenApiSpec':
+            case 'potentialJsonOpenApiSpec': {
+                // A deleted spec or overlay changes the effective OpenAPI documents and any
+                // navigation generated from them.
+                knownOverlayFiles?.delete(normalizeOverlayKey(toPosixPath(filename)));
+                try {
+                    const { mintConfig, openApiFiles, docsConfig } = await getDocsState(handleParseError);
+                    if (mintConfig) {
+                        await MintConfigUpdater.writeConfigFile(mintConfig, CLIENT_PATH);
+                    }
+                    await DocsConfigUpdater.writeConfigFile(docsConfig, CLIENT_PATH);
+                    await updateOpenApiFiles(openApiFiles, suppressParseError);
+                    await updateGeneratedNav(suppressParseError);
+                    triggerRefresh();
+                }
+                catch (err) {
+                    if (getCurrentErrorLogs().length === 0) {
+                        console.error(err);
+                    }
+                }
+                break;
+            }
             case 'mintIgnore':
                 addChangeLog(_jsx(WarningLog, { message: ".mintignore has been deleted. Rebuilding..." }));
                 try {
@@ -543,21 +589,50 @@ const onUpdateEvent = async (filename, triggerRefresh, options = {}) => {
         }
         case 'potentialYamlOpenApiSpec':
         case 'potentialJsonOpenApiSpec': {
+            let raw;
+            try {
+                raw = yaml.load(await fs.readFile(filePath, 'utf-8'));
+            }
+            catch {
+                raw = undefined;
+            }
+            const knownOverlays = await getKnownOverlayFiles();
+            // chokidar reports platform-native separators; discovery locations are posix.
+            const overlayKey = normalizeOverlayKey(toPosixPath(filename));
+            if (isOverlayDocument(raw)) {
+                // Rebuild all specs so the overlay's targets pick up the change.
+                knownOverlays.add(overlayKey);
+                await updateOpenApiFiles();
+                regenerateNav = true;
+                category = 'openApi';
+                break;
+            }
+            if (knownOverlays.has(overlayKey)) {
+                // A previously valid overlay is now malformed or no longer an overlay, so its
+                // earlier effects must not linger in the generated documents.
+                knownOverlays.delete(overlayKey);
+                await updateOpenApiFiles();
+                regenerateNav = true;
+                category = 'openApi';
+                break;
+            }
+            const isOpenApiCandidate = typeof raw === 'object' && raw !== null && 'openapi' in raw;
             let doc;
             try {
-                const file = await fs.readFile(filePath, 'utf-8');
-                const { schema } = await validate(yaml.load(file));
+                const { schema } = await validate(raw);
                 doc = schema;
             }
             catch {
                 doc = undefined;
             }
-            if (doc) {
-                await upsertOpenApiFile({
-                    filename: pathUtil.parse(filename).name,
-                    originalFileLocation: '/' + filename,
-                    spec: doc,
-                });
+            if (doc || isOpenApiCandidate) {
+                if (doc) {
+                    await upsertOpenApiFile({
+                        filename: pathUtil.parse(filename).name,
+                        originalFileLocation: '/' + filename,
+                        spec: doc,
+                    });
+                }
                 await updateOpenApiFiles();
                 regenerateNav = true;
                 category = 'openApi';