@mintlify/previewing 4.0.1495 → 4.0.1496

package/dist/__tests__/packages-collect.test.js

@@ -70,10 +70,6 @@ const BAR_SNIPPET = `import { BarChart, Bar } from "recharts";
   <Bar dataKey="v" name="{{brand}} revenue" />
 </BarChart>
 `;
-const LINE_SNIPPET = `<LineChart width={400} height={200} data={[{ v: 2 }]}>
-  <Line dataKey="v" isAnimationActive={false} />
-</LineChart>
-`;
 const writeDocs = async (root) => {
     await fse.outputJson(join(root, 'docs.json'), {
         name: 'Docs',
@@ -235,106 +231,20 @@ describe('collectPackageIslands', () => {
         expect(compiled.mdxExtracts.packageBaseUrl).toBe('/_mintlify/pkg/abc');
         expect(compiled.mdxSource.compiledSource).not.toMatch(/LineChart|RevenueChart/);
     });
-    it('extracts the package components that <Snippet file> injects with the ids mint dev compiles', async () => {
+    it('reports a <Snippet file> that uses package components instead of extracting it', async () => {
         await fse.outputFile(join(testPaths.cmd, '_snippets/bar.mdx'), BAR_SNIPPET);
-        await fse.outputFile(join(testPaths.cmd, '_snippets/line.mdx'), LINE_SNIPPET);
         await fse.outputFile(join(testPaths.cmd, 'revenue.mdx'), '# Revenue\n\n<Snippet file="bar.mdx" />\n');
-        await fse.outputFile(join(testPaths.cmd, 'trend.mdx'), 'import { LineChart, Line } from "recharts";\n\n<Snippet file="line.mdx" />\n');
-        const setup = await readPackagesSetup(testPaths.cmd);
-        const collector = new PackageIslandCollector({
-            docsRoot: testPaths.cmd,
-            packageNames: setup?.packageNames ?? new Set(),
-            variables: setup?.variables,
-        });
-        const collected = await collector.collectAll();
-        setPackageImportOptions({
-            packageNames: setup?.packageNames ?? new Set(),
-            packageSnippets: collected.packageSnippets,
-        });
-        const islands = Object.fromEntries(collected.islands.map((island) => [
-            island.id,
-            { prefix: `mi-${island.id}-`, html: '<svg></svg>' },
-        ]));
-        const packageBuild = {
-            buildId: 'abc',
-            islands,
-            packageNames: [...(setup?.packageNames ?? [])],
-            packageSnippets: [...collected.packageSnippets],
-        };
-        expect(collected.pages['revenue.mdx']).toEqual({ ids: [expect.any(String)], errors: [] });
-        expect(collected.pages['trend.mdx']).toEqual({ ids: [expect.any(String)], errors: [] });
-        const [barId] = collected.pages['revenue.mdx']?.ids ?? [];
-        expect(collected.islands.find((island) => island.id === barId)?.module).toContain('Acme revenue');
-        for (const page of ['revenue.mdx', 'trend.mdx']) {
-            const compiled = await compileLikeMintDev(page, packageBuild);
-            expect(compiled.parseFailed).toBeUndefined();
-            expect(Object.keys(compiled.mdxExtracts.islands ?? {})).toEqual(collected.pages[page]?.ids);
-            expect(compiled.mdxSource.compiledSource).not.toMatch(/BarChart|LineChart/);
-        }
-        expect((await collector.updatePage('revenue.mdx')).pages['revenue.mdx']?.ids).toEqual([barId]);
-    });
-    it('resolves <Snippet file> imports against the snippet file with the ids mint dev compiles', async () => {
-        const component = (name) => `import { BarChart, Bar } from "recharts";\n\nexport const ${name} = () => (\n  <BarChart width={300} height={150} data={[{ v: 1 }]}>\n    <Bar dataKey="v" name="${name}" />\n  </BarChart>\n);\n`;
-        await fse.outputFile(join(testPaths.cmd, 'snippets/chart.jsx'), component('Chart'));
-        await fse.outputFile(join(testPaths.cmd, 'snippets/inner.jsx'), component('Inner'));
-        await fse.outputFile(join(testPaths.cmd, 'snippets/wrong.jsx'), component('Wrong'));
-        await fse.outputFile(join(testPaths.cmd, '_snippets/charts/x.mdx'), 'import { Chart } from "../../snippets/chart.jsx";\n\n<Chart />\n\n<Snippet file="charts/inner/y.mdx" />\n');
-        await fse.outputFile(join(testPaths.cmd, '_snippets/charts/inner/y.mdx'), 'import { Inner } from "../../../snippets/inner.jsx";\n\n<Inner />\n');
-        await fse.outputFile(join(testPaths.cmd, '_snippets/charts/w.mdx'), 'import { Wrong } from "../snippets/wrong.jsx";\n\n<Wrong />\n');
-        await fse.outputFile(join(testPaths.cmd, 'guides/deep/nested/page.mdx'), '# Nested\n\n<Snippet file="charts/x.mdx" />\n');
-        await fse.outputFile(join(testPaths.cmd, 'guides/wrong.mdx'), '# Wrong\n\n<Snippet file="charts/w.mdx" />\n');
-        const setup = await readPackagesSetup(testPaths.cmd);
-        const collected = await collectPackageIslands({
-            docsRoot: testPaths.cmd,
-            packageNames: setup?.packageNames ?? new Set(),
-            variables: setup?.variables,
-        });
-        setPackageImportOptions({
-            packageNames: setup?.packageNames ?? new Set(),
-            packageSnippets: collected.packageSnippets,
-        });
-        const packageBuild = {
-            buildId: 'abc',
-            islands: Object.fromEntries(collected.islands.map((island) => [
-                island.id,
-                { prefix: `mi-${island.id}-`, html: '<svg></svg>' },
-            ])),
-            packageNames: [...(setup?.packageNames ?? [])],
-            packageSnippets: [...collected.packageSnippets],
-        };
-        const modules = (page) => (collected.pages[page]?.ids ?? []).map((id) => collected.islands.find((island) => island.id === id)?.module);
-        expect(modules('guides/deep/nested/page.mdx')).toEqual([
-            expect.stringContaining('/snippets/chart.jsx'),
-            expect.stringContaining('/snippets/inner.jsx'),
-        ]);
-        expect(collected.pages['guides/wrong.mdx']).toEqual({ ids: [], errors: [] });
-        for (const page of ['guides/deep/nested/page.mdx', 'guides/wrong.mdx']) {
-            const compiled = await compileLikeMintDev(page, packageBuild);
-            expect(compiled.parseFailed).toBeUndefined();
-            expect(Object.keys(compiled.mdxExtracts.islands ?? {})).toEqual(collected.pages[page]?.ids);
-        }
-    });
-    it('reports a <Snippet file> cycle on the page instead of expanding it forever', async () => {
-        await fse.outputFile(join(testPaths.cmd, '_snippets/note.mdx'), 'Note\n');
-        await fse.outputFile(join(testPaths.cmd, '_snippets/a.mdx'), 'A\n\n<Snippet file="b.mdx" />\n');
-        await fse.outputFile(join(testPaths.cmd, '_snippets/b.mdx'), 'B\n\n<Snippet file="a.mdx" />\n');
-        await fse.outputFile(join(testPaths.cmd, 'loop.mdx'), '# Loop\n\n<Snippet file="a.mdx" />\n');
         const setup = await readPackagesSetup(testPaths.cmd);
         const collected = await collectPackageIslands({
             docsRoot: testPaths.cmd,
             packageNames: setup?.packageNames ?? new Set(),
             variables: setup?.variables,
         });
-        expect(collected.pages['loop.mdx']).toEqual({
-            ids: [],
-            errors: [
-                {
-                    file: 'loop.mdx',
-                    message: '<Snippet file="a.mdx"> includes itself (a.mdx -> b.mdx -> a.mdx).',
-                },
-            ],
+        expect(collected.pages['revenue.mdx']).toEqual({ ids: [], errors: [] });
+        expect(collected.errors).toContainEqual({
+            file: '_snippets/bar.mdx',
+            message: expect.stringContaining('<Snippet>'),
         });
-        expect(collected.pages['charts.mdx']?.errors).toEqual([]);
     });
     it('falls back to the snippet trees of a collector for the same docs root only', async () => {
         const setup = await readPackagesSetup(testPaths.cmd);

package/dist/__tests__/packages-dev-snippets.test.js

@@ -1,6 +1,6 @@
 import { findAndRemoveImports, getFileCategory, parseFrontmatter } from '@mintlify/common';
 import { getMdx } from '@mintlify/common/server-mdx';
-import { createPage, preparseMdxTree } from '@mintlify/prebuild';
+import { preparseMdxTree } from '@mintlify/prebuild';
 import fse from 'fs-extra';
 import { mkdtemp, readdir, rm } from 'fs/promises';
 import { tmpdir } from 'os';
@@ -152,10 +152,6 @@ describe('package snippet membership in the mint dev watcher', () => {
         await saveSnippet(file, content);
         await untilBuilt(settled);
     };
-    const compilePage = async (file) => {
-        const { pageContent } = await createPage(file, await fse.readFile(docs(file), 'utf8'), testPaths.cmd, [], []);
-        await fse.outputFile(join(testPaths.props, file), pageContent);
-    };
     const legacySnippets = async () => {
         const dir = join(testPaths.public, '_snippets');
         const names = (await fse.pathExists(dir)) ? await readdir(dir) : [];
@@ -389,48 +385,17 @@ describe('package snippet membership in the mint dev watcher', () => {
             expect(island.html).toBe(`<svg data-id="${id}"></svg>`);
         }
     });
-    it('renders placeholders for the islands a <Snippet file> edit adds until the rebuild finishes', async () => {
-        await fse.outputFile(docs('_snippets/badge.mdx'), 'Plain badge\n');
-        await fse.outputFile(docs('badge-page.mdx'), '# Badge\n\n<Snippet file="badge.mdx" />\n');
-        await start({ toggle: PLAIN_TOGGLE, wrapper: PLAIN_WRAPPER });
-        await compilePage('badge-page.mdx');
-        await fse.copy(docs('_snippets/badge.mdx'), join(testPaths.public, '_snippets/badge.mdx'));
-        expect(await render('badge-page.mdx')).toEqual({});
-        holdBuilds();
-        const settled = builds + 1;
-        await fse.outputFile(docs('_snippets/badge.mdx'), 'import { Switch } from "@acme/ui";\n\n<Switch />\n');
-        await dev.onFileChange('_snippets/badge.mdx', 'snippet');
-        await fse.copy(docs('_snippets/badge.mdx'), join(testPaths.public, '_snippets/badge.mdx'));
-        const pending = await render('badge-page.mdx');
-        const [id] = Object.keys(pending);
-        expect(pending).toEqual({ [id ?? '']: { prefix: `mi-${id}-` } });
-        releaseBuild();
-        await untilBuilt(settled);
-        expect(await render('badge-page.mdx')).toEqual({
-            [id ?? '']: { prefix: `mi-${id}-`, html: `<svg data-id="${id}"></svg>` },
-        });
-    });
     it('keeps rendering the islands a snippet edit removes until the watcher recompiles the pages', async () => {
         await fse.outputFile(docs('snippets/switches.mdx'), 'import { Switch } from "@acme/ui";\n\n<Switch />\n');
         await fse.outputFile(docs('switch-page.mdx'), 'import Switches from "/snippets/switches.mdx";\n\n<Switches />\n');
-        await fse.outputFile(docs('_snippets/badge.mdx'), 'import { Switch } from "@acme/ui";\n\n<Switch size="sm" />\n');
-        await fse.outputFile(docs('badge-page.mdx'), '<Snippet file="badge.mdx" />\n');
         await start({ toggle: PLAIN_TOGGLE, wrapper: PLAIN_WRAPPER });
-        await compilePage('badge-page.mdx');
-        await fse.copy(docs('_snippets/badge.mdx'), join(testPaths.public, '_snippets/badge.mdx'));
         const switches = await render('switch-page.mdx');
-        const badge = await render('badge-page.mdx');
-        expect(Object.keys({ ...switches, ...badge })).toHaveLength(2);
+        expect(Object.keys(switches)).toHaveLength(1);
         holdBuilds();
         await changeSnippet('snippets/switches.mdx', 'No switch\n');
         expect(await render('switch-page.mdx')).toEqual(switches);
         await regenerate('snippets/switches.mdx');
         expect(await render('switch-page.mdx')).toEqual({});
-        await fse.outputFile(docs('_snippets/badge.mdx'), 'Plain badge\n');
-        await dev.onFileChange('_snippets/badge.mdx', 'snippet');
-        expect(await render('badge-page.mdx')).toEqual(badge);
-        await fse.copy(docs('_snippets/badge.mdx'), join(testPaths.public, '_snippets/badge.mdx'));
-        expect(await render('badge-page.mdx')).toEqual({});
     });
     it('recompiles pages on request after a package snippet change, and keeps serving ones that failed to compile', async () => {
         markOnDemandPagesReady();

package/dist/__tests__/packages-dev.test.js

@@ -283,20 +283,6 @@ describe('PackagesDev', () => {
         await until(() => rebuilt === 2);
         expect((await props()).islands).toEqual(before);
     });
-    it('re-extracts the islands of a <Snippet file> when the snippet changes', async () => {
-        await fse.outputFile(join(docsRoot, 'charts.mdx'), '<Snippet file="chart.mdx" />\n');
-        await fse.outputFile(join(docsRoot, '_snippets/chart.mdx'), page(2));
-        await dev.init();
-        rebuilt = 0;
-        const before = Object.keys((await props()).islands);
-        expect(before).toHaveLength(1);
-        await fse.outputFile(join(docsRoot, '_snippets/chart.mdx'), page(3));
-        await dev.onFileChange('_snippets/chart.mdx', 'snippet');
-        await until(() => rebuilt === 1);
-        const after = Object.keys((await props()).islands);
-        expect(after).toHaveLength(1);
-        expect(after).not.toEqual(before);
-    });
     it('retries replacing the props file while another process has it open', async () => {
         const rename = fse.rename.bind(fse);
         let thrown = 0;

package/dist/packages/collect.d.ts

@@ -35,7 +35,6 @@ export declare class PackageIslandCollector {
     private readonly input;
     private snippetSources;
     private snippets;
-    private snippetTreeMap;
     private packageSnippets;
     private packageSnippetTrees;
     private pageEntries;

package/dist/packages/collect.js

@@ -24,12 +24,6 @@ const readSources = async (docsRoot, mintIgnore) => {
     }));
     return sources.flat();
 };
-const createLegacySnippetTreeMap = async (snippets, variables) => {
-    if (snippets.length === 0)
-        return {};
-    const { createPackageSnippetTreeMap } = await import('@mintlify/common/server-mdx');
-    return createPackageSnippetTreeMap(snippets, variables);
-};
 const resolveSnippets = async (snippets, variables, packages, onWarning) => {
     const parsed = [];
     for (const { filename, content } of snippets) {
@@ -64,7 +58,6 @@ export class PackageIslandCollector {
         this.input = input;
         this.snippetSources = [];
         this.snippets = [];
-        this.snippetTreeMap = {};
         this.packageSnippets = new Set();
         this.packageSnippetTrees = new Map();
         this.pageEntries = new Map();
@@ -117,7 +110,6 @@ export class PackageIslandCollector {
         this.snippetSources = files
             .filter(({ path }) => snippetPaths.has(path))
             .map(({ path, content }) => ({ filename: withSlash(path), content }));
-        this.snippetTreeMap = await createLegacySnippetTreeMap(classified.legacySnippets, variables);
         const previousTrees = this.packageSnippetTrees;
         const parsedTrees = new Map(classified.snippets.map(({ path, tree }) => [path, tree]));
         this.packageSnippetTrees = new Map();
@@ -207,7 +199,7 @@ export class PackageIslandCollector {
         const { path } = page;
         const content = replaceVariables(page.content, this.input.variables);
         const noIslands = { ids: [], islands: [], errors: sourceErrors };
-        if (!mayImport(content) && !content.includes('<Snippet')) {
+        if (!mayImport(content)) {
             this.pageEntries.set(path, noIslands);
             return;
         }
@@ -228,7 +220,6 @@ export class PackageIslandCollector {
             packageNames: this.input.packageNames,
             packageSnippets: this.packageSnippets,
             variables: this.input.variables,
-            snippetTreeMap: this.snippetTreeMap,
         });
         this.pageEntries.set(path, {
             ids: extraction.ids,