@mintlify/previewing 4.0.1492 → 4.0.1493

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

@@ -226,7 +226,7 @@ describe('collectPackageIslands', () => {
             { prefix: `mi-${island.id}-`, html: '<svg></svg>' },
         ]));
         const compiled = await compileLikeMintDev('charts.mdx', {
-            baseUrl: '/_mintlify/pkg/abc',
+            buildId: 'abc',
             islands,
             packageNames: [...(setup?.packageNames ?? [])],
             packageSnippets: [...collected.packageSnippets],
@@ -256,7 +256,7 @@ describe('collectPackageIslands', () => {
             { prefix: `mi-${island.id}-`, html: '<svg></svg>' },
         ]));
         const packageBuild = {
-            baseUrl: '/_mintlify/pkg/abc',
+            buildId: 'abc',
             islands,
             packageNames: [...(setup?.packageNames ?? [])],
             packageSnippets: [...collected.packageSnippets],
@@ -294,7 +294,7 @@ describe('collectPackageIslands', () => {
             packageSnippets: collected.packageSnippets,
         });
         const packageBuild = {
-            baseUrl: '/_mintlify/pkg/abc',
+            buildId: 'abc',
             islands: Object.fromEntries(collected.islands.map((island) => [
                 island.id,
                 { prefix: `mi-${island.id}-`, html: '<svg></svg>' },

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

@@ -165,7 +165,7 @@ describe('package snippet membership in the mint dev watcher', () => {
         })));
     };
     const render = async (page) => {
-        const { baseUrl, islands, packageNames, packageSnippets } = await fse.readJson(join(testPaths.props, PACKAGE_BUILD_PROPS_FILE));
+        const { buildId, islands, packageNames, packageSnippets } = await fse.readJson(join(testPaths.props, PACKAGE_BUILD_PROPS_FILE));
         const compiled = await getMdx({
             path: page.replace(/\.mdx$/, ''),
             content: parseFrontmatter(await output(page)).body,
@@ -174,7 +174,7 @@ describe('package snippet membership in the mint dev watcher', () => {
             subdomain: 'local',
             codeStyling: undefined,
             tailwindSelectors: [],
-            packageBuild: { baseUrl, islands, packageNames, packageSnippets },
+            packageBuild: { buildId, islands, packageNames, packageSnippets },
         });
         expect(compiled.parseFailed).toBeUndefined();
         return compiled.mdxExtracts.islands ?? {};

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

@@ -200,7 +200,7 @@ describe('PackagesDev', () => {
         expect(await fse.pathExists(join(propsPath, 'charts.mdx'))).toBe(true);
         const written = await props();
         const [id] = Object.keys(written.islands);
-        expect(written.baseUrl).toMatch(/^\/_mintlify\/pkg\/bi[0-9a-f]+-1$/);
+        expect(written.buildId).toMatch(/^bi[0-9a-f]+-1$/);
         expect(written.islands[id ?? '']).toEqual({
             prefix: `mi-${id}-`,
             html: `<svg data-id="${id}"></svg>`,
@@ -209,7 +209,7 @@ describe('PackagesDev', () => {
         expect(written.css.map((css) => css.path)).toEqual(['client/styles.css']);
         expect(dev.getStatus()).toEqual({ state: 'ready' });
         expect(getPackageImportOptions()?.packageNames).toEqual(new Set(['recharts']));
-        expect(await fse.readdir(buildsDir)).toEqual([written.baseUrl.split('/').pop()]);
+        expect(await fse.readdir(buildsDir)).toEqual([written.buildId]);
         expect(dev.routeState().enabled).toBe(true);
     });
     it('preserves global and island CSS references in local compile props', async () => {
@@ -221,7 +221,7 @@ describe('PackagesDev', () => {
         expect(written.islands[id ?? '']?.css).toEqual([
             { path: `client/islands/${id}.css`, integrity: 'sha384-css', bytes: 3 },
         ]);
-        expect(written.baseUrl).not.toContain('/pages/');
+        expect(written.buildId).not.toContain('/');
     });
     it('adds a changed island right away and swaps in the rebuild', async () => {
         await dev.init();
@@ -233,14 +233,14 @@ describe('PackagesDev', () => {
         const pending = await props();
         const [newId] = Object.keys(pending.islands);
         expect(Object.keys(before.islands)).not.toContain(newId);
-        expect(pending.baseUrl).toBe(before.baseUrl);
+        expect(pending.buildId).toBe(before.buildId);
         expect(pending.islands[newId ?? '']?.html).toBeUndefined();
         expect(dev.getStatus()).toEqual({ state: 'building' });
-        await until(async () => (await props()).baseUrl !== before.baseUrl);
+        await until(async () => (await props()).buildId !== before.buildId);
         const after = await props();
         expect(after.islands[newId ?? '']?.html).toContain(newId);
         expect(rebuilt).toBe(1);
-        expect((await fse.readdir(buildsDir)).sort()).toEqual([before.baseUrl, after.baseUrl].map((url) => url.split('/').pop()).sort());
+        expect((await fse.readdir(buildsDir)).sort()).toEqual([before.buildId, after.buildId].sort());
     });
     it('keeps listing the islands edits drop until the next build finishes', async () => {
         await dev.init();
@@ -342,7 +342,7 @@ describe('PackagesDev', () => {
             await Promise.all([slow, dev.onFileChange('charts.mdx', 'page')]);
             await until(() => rebuilt === 1);
             const after = await props();
-            expect(after.baseUrl).not.toBe(before.baseUrl);
+            expect(after.buildId).not.toBe(before.buildId);
             expect(Object.keys(after.islands)).not.toEqual(Object.keys(before.islands));
             expect(Object.values(after.islands).every((island) => island.html !== undefined)).toBe(true);
         }
@@ -464,13 +464,13 @@ describe('PackagesDev', () => {
         mode.missingNodeModules = true;
         await dev.init();
         const written = await props();
-        expect(written.baseUrl).toBe('/_mintlify/pkg/pending');
+        expect(written.buildId).toBe('pending');
         expect(Object.values(written.islands).every((island) => island.html === undefined)).toBe(true);
         expect(dev.getStatus()).toEqual({ state: 'missing-node-modules' });
         expect(report.calls).toContain('missing');
         mode.missingNodeModules = false;
         await fse.outputFile(join(docsRoot, 'node_modules/.package-lock.json'), '{}');
-        await until(async () => (await props()).baseUrl !== '/_mintlify/pkg/pending');
+        await until(async () => (await props()).buildId !== 'pending');
         expect(dev.getStatus()).toEqual({ state: 'ready' });
     });
     it('rebuilds once an install without a known marker settles node_modules', async () => {
@@ -486,7 +486,7 @@ describe('PackagesDev', () => {
             version: '2.15.4',
         });
         await until(() => dev.getStatus().state === 'ready');
-        expect((await props()).baseUrl).not.toBe('/_mintlify/pkg/pending');
+        expect((await props()).buildId).not.toBe('pending');
     });
     it('waits for the installer marker instead of a half-written node_modules when a lockfile exists', async () => {
         await fse.outputJson(join(docsRoot, 'package-lock.json'), { lockfileVersion: 3, packages: {} });
@@ -693,12 +693,12 @@ describe('PackagesDev', () => {
                 'writing package-build.json',
                 'ENOSPC: no space left on device',
                 'outputFile',
-                (target, data, before) => target.includes(PACKAGE_BUILD_PROPS_FILE) && !String(data).includes(before.baseUrl),
+                (target, data, before) => target.includes(PACKAGE_BUILD_PROPS_FILE) && !String(data).includes(before.buildId),
             ],
         ])('keeps the last build when %s fails, cleans up and retries on the next save', async (_, message, name, fails) => {
             await dev.init();
             const before = await props();
-            const builtId = before.baseUrl.split('/').pop();
+            const builtId = before.buildId;
             await fse.ensureDir(join(buildsDir, 'stale'));
             const spy = failOnce(name, fails, message, before);
             try {
@@ -721,8 +721,8 @@ describe('PackagesDev', () => {
             await dev.onFileChange('charts.mdx', 'page');
             await until(() => dev.getStatus().state === 'ready');
             const after = await props();
-            expect(after.baseUrl).not.toBe(before.baseUrl);
-            expect((await fse.readdir(buildsDir)).sort()).toEqual([builtId, after.baseUrl.split('/').pop()].sort());
+            expect(after.buildId).not.toBe(before.buildId);
+            expect((await fse.readdir(buildsDir)).sort()).toEqual([builtId, after.buildId].sort());
         });
     });
     it('stays off without a packages key and turns on when docs.json adds one', async () => {
@@ -744,7 +744,7 @@ describe('PackagesDev', () => {
         expect(await mtime('generated.mdx')).toBeGreaterThan(0);
         await until(() => rebuilt === 1);
         expect(dev.enabled).toBe(true);
-        expect((await props()).baseUrl).toMatch(/^\/_mintlify\/pkg\/b/);
+        expect((await props()).buildId).toMatch(/^b/);
         await fse.outputFile(join(propsPath, 'charts.mdx'), 'stale compile');
         await fse.outputJson(join(docsRoot, 'package.json'), {
             dependencies: { recharts: '2.15.4', '@acme/ui': '1.0.0' },
@@ -758,7 +758,7 @@ describe('PackagesDev', () => {
         const settle = () => new Promise((resolve) => setTimeout(resolve, 50));
         it('starts with packages off, shows the schema errors and turns on once it is valid', async () => {
             await fse.outputJson(join(docsRoot, 'docs.json'), { name: 'Docs', packages: 'nope' });
-            await fse.outputJson(join(propsPath, PACKAGE_BUILD_PROPS_FILE), { baseUrl: '/stale' });
+            await fse.outputJson(join(propsPath, PACKAGE_BUILD_PROPS_FILE), { buildId: 'stale' });
             await dev.init();
             expect(dev.enabled).toBe(false);
             expect(dev.getStatus()).toEqual({ state: 'disabled' });
@@ -788,7 +788,7 @@ describe('PackagesDev', () => {
             await until(() => rebuilt === 1);
             expect(dev.enabled).toBe(true);
             expect(dev.getStatus()).toEqual({ state: 'ready' });
-            expect((await props()).baseUrl).toMatch(/^\/_mintlify\/pkg\/b/);
+            expect((await props()).buildId).toMatch(/^b/);
             expect(report.calls).toEqual(['building', 'built']);
         });
         it('keeps the last packages setup and shows the schema errors until it is valid again', async () => {
@@ -982,7 +982,7 @@ describe('PackagesDev', () => {
         });
         it('starts with packages off and turns them on once it parses', async () => {
             await fse.outputFile(join(docsRoot, 'docs.json'), INVALID);
-            await fse.outputJson(join(propsPath, PACKAGE_BUILD_PROPS_FILE), { baseUrl: '/stale' });
+            await fse.outputJson(join(propsPath, PACKAGE_BUILD_PROPS_FILE), { buildId: 'stale' });
             await dev.init();
             expect(dev.enabled).toBe(false);
             expect(dev.getStatus()).toEqual({ state: 'disabled' });
@@ -995,7 +995,7 @@ describe('PackagesDev', () => {
             await until(() => rebuilt === 1);
             expect(dev.enabled).toBe(true);
             expect(dev.getStatus()).toEqual({ state: 'ready' });
-            expect((await props()).baseUrl).toMatch(/^\/_mintlify\/pkg\/b/);
+            expect((await props()).buildId).toMatch(/^b/);
         });
     });
     it('keeps the packages setup while package.json does not parse, and drops the names once it is deleted', async () => {

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

@@ -42,7 +42,7 @@ describe('package setup config references', () => {
             tailwindSelectors: [],
             variables,
             packageBuild: {
-                baseUrl: '/_mintlify/pkg/synthetic',
+                buildId: 'synthetic',
                 islands: Object.fromEntries(collected.islands.map(({ id }) => [id, { prefix: `mi-${id}-`, html: '<button />' }])),
                 packageNames: [...packageNames],
                 packageSnippets: [...collected.packageSnippets],

package/dist/local-preview/packages/dev.d.ts

@@ -1,5 +1,5 @@
 import type { BuildResult } from '@mintlify/package-builder';
-import { type PackageRouteState } from './serve.js';
+import type { PackageRouteState } from './serve.js';
 export declare const PACKAGE_BUILD_PROPS_FILE = "package-build.json";
 export type PackagesDevStatus = {
     state: 'disabled';

package/dist/local-preview/packages/dev.js

@@ -7,7 +7,6 @@ import { formatDiagnostic, loadPackageBuilder } from '../../packages/builder.js'
 import { formatProblem, PackageIslandCollector, } from '../../packages/collect.js';
 import { errnoCode } from '../../packages/errno.js';
 import { DocsJsonError, InvalidPackagesError, readPackagesSetup, } from '../../packages/setup.js';
-import { PACKAGE_ROUTE_PREFIX } from './serve.js';
 import { setPackageImportOptions } from './state.js';
 export const PACKAGE_BUILD_PROPS_FILE = 'package-build.json';
 const PENDING_BUILD_ID = 'pending';
@@ -153,7 +152,6 @@ export class PackagesDev {
             return;
         }
         const buildId = this.adopted?.buildId ?? PENDING_BUILD_ID;
-        const baseUrl = `${PACKAGE_ROUTE_PREFIX}/${buildId}`;
         const built = this.adopted?.manifest.islands ?? {};
         const collectedIds = this.collected.islands.map((island) => island.id);
         const islands = {};
@@ -172,7 +170,7 @@ export class PackagesDev {
             this.listedIds.add(id);
         const tmp = `${target}.${process.pid}.tmp`;
         const props = {
-            baseUrl,
+            buildId,
             islands,
             packageNames: [...this.setup.packageNames].sort(),
             packageSnippets: [...this.collected.packageSnippets].sort(),