@fumadocs/cli 1.4.1 → 1.6.0

package/dist/registry/installer.d.ts

@@ -1,12 +1,11 @@
-import { LoadedConfig } from "../config.js";
-import { ComponentInstaller } from "fuma-cli/registry/installer";
+import { r as LoadedConfig } from "../config-CT2jj39D.js";
+import { ComponentInstaller, IOInterface } from "fuma-cli/registry/installer";
 import { RegistryConnector } from "fuma-cli/registry/connector";
 //#region src/registry/installer.d.ts
-declare class FumadocsComponentInstaller extends ComponentInstaller {
+export declare class FumadocsComponentInstaller extends ComponentInstaller {
   private interactive;
-  constructor(connector: RegistryConnector, config: LoadedConfig, cwd?: string);
+  constructor(connector: RegistryConnector, config: LoadedConfig, cwd?: string, io?: Partial<IOInterface>);
   installInteractive(name: string, subRegistry?: string): Promise<void>;
 }
 //#endregion
-export { FumadocsComponentInstaller };
 //# sourceMappingURL=installer.d.ts.map

package/dist/registry/installer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"installer.d.ts","names":[],"sources":["../../src/registry/installer.ts"],"mappings":";;;;cAQa,mCAAmC;UACtC;cAKI,WAAW,mBAAmB,QAAQ,cAAc;EAuC1D,mBAAmB,cAAc,uBAAuB"}
+{"version":3,"file":"installer.d.ts","names":[],"sources":["../../src/registry/installer.ts"],"mappings":";;;;qBASa,mCAAmC;UACtC;EAKR,YACE,WAAW,mBACX,QAAQ,cACR,cACA,KAAK,QAAQ;EAyCT,mBAAmB,cAAc,uBAAuB"}

package/dist/registry/installer.js

@@ -1,2 +1,2 @@
-import { t as FumadocsComponentInstaller } from "../installer-Chjj_R2z.js";
+import { t as FumadocsComponentInstaller } from "../installer-D0Obb2Md.js";
 export { FumadocsComponentInstaller };

package/dist/schema.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"$schema":{"default":"node_modules/@fumadocs/cli/dist/schema.json","type":"string"},"aliases":{"default":{"uiDir":"./components/ui","componentsDir":"./components","layoutDir":"./layouts","cssDir":"./styles","libDir":"./lib"},"type":"object","properties":{"uiDir":{"default":"./components/ui","type":"string"},"componentsDir":{"default":"./components/ui","type":"string"},"layoutDir":{"default":"./layouts","type":"string"},"cssDir":{"default":"./components","type":"string"},"libDir":{"default":"./lib","type":"string"}}},"baseDir":{"default":"src","type":"string"},"uiLibrary":{"default":"base-ui","type":"string","enum":["radix-ui","base-ui"]},"framework":{"default":"next","type":"string","enum":["next","astro","waku","react-router","tanstack-start"]},"commands":{"default":{},"type":"object","properties":{"format":{"type":"string"}}}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"$schema":{"default":"node_modules/@fumadocs/cli/dist/schema.json","type":"string"},"aliases":{"default":{"uiDir":"./components/ui","componentsDir":"./components","layoutDir":"./layouts","cssDir":"./styles","libDir":"./lib"},"type":"object","properties":{"uiDir":{"default":"./components/ui","type":"string"},"componentsDir":{"default":"./components","type":"string"},"layoutDir":{"default":"./layouts","type":"string"},"cssDir":{"default":"./styles","type":"string"},"libDir":{"default":"./lib","type":"string"}}},"baseDir":{"default":"src","type":"string"},"uiLibrary":{"default":"base-ui","type":"string","enum":["radix-ui","base-ui"]},"framework":{"default":"next","type":"string","enum":["next","astro","waku","react-router","tanstack-start"]},"commands":{"default":{},"type":"object","properties":{"format":{"type":"string"}}}}}

package/dist/search-iphnSVVY.js

@@ -0,0 +1,381 @@
+import { b as findJsxElement, m as addJsxAttribute, o as filterReactRouterPrerenderArray, p as addImport, r as addTanstackPrerender, s as filterReactRouterRoute } from "./codemod-auol-p4R.js";
+import { a as routeModule, r as formatRoute, t as docs } from "./docs-DeIEl_Kt.js";
+import { a as reactFramework, d as sourceRef, i as posix, l as scripts, r as findSource, s as registerReactRouterRoutes } from "./utils-DbMe7h6c.js";
+import path from "node:path";
+//#region src/features/search.ts
+const publicEnv = (next) => next ? {
+	prefix: "NEXT_PUBLIC_",
+	read: "process.env.NEXT_PUBLIC_"
+} : {
+	prefix: "VITE_",
+	read: "import.meta.env.VITE_"
+};
+const dialogImports = `import {
+  SearchDialog,
+  SearchDialogClose,
+  SearchDialogContent,
+  SearchDialogFooter,
+  SearchDialogHeader,
+  SearchDialogIcon,
+  SearchDialogInput,
+  SearchDialogList,
+  SearchDialogOverlay,
+  type SharedProps,
+} from 'fumadocs-ui/components/dialog/search';
+import { useI18n } from 'fumadocs-ui/contexts/i18n';`;
+const dialogBody = (footer, url) => `  return (
+    <SearchDialog search={search} onSearchChange={setSearch} isLoading={query.isLoading} {...props}>
+      <SearchDialogOverlay />
+      <SearchDialogContent>
+        <SearchDialogHeader>
+          <SearchDialogIcon />
+          <SearchDialogInput />
+          <SearchDialogClose />
+        </SearchDialogHeader>
+        <SearchDialogList items={query.data !== 'empty' ? query.data : null} />
+        <SearchDialogFooter>
+          <a
+            href="${url}"
+            rel="noreferrer noopener"
+            className="ms-auto text-xs text-fd-muted-foreground"
+          >
+            Search powered by ${footer}
+          </a>
+        </SearchDialogFooter>
+      </SearchDialogContent>
+    </SearchDialog>
+  );
+}
+`;
+/** `structuredData` is a function on async collections (React Router & TanStack Start) */
+const typesenseIndexes = (async, { ref, resolved }) => `import { ${ref} } from '@/lib/source';
+import type { DocumentRecord } from 'typesense-fumadocs-adapter';
+
+export async function exportSearchIndexes() {
+  const results: DocumentRecord[] = [];
+  for (const page of ${resolved}.getPages()) {
+    results.push({
+      _id: page.url,
+      structured: ${async ? "await page.data.structuredData()" : "page.data.structuredData"},
+      url: page.url,
+      title: page.data.title,
+      description: page.data.description,
+      locale: page.locale,
+    });
+  }
+  return results;
+}
+`;
+const syncScript = (imports, body) => `import * as fs from 'node:fs/promises';
+${imports}
+
+async function main(filePath: string) {
+  const content = await fs.readFile(filePath);
+  const records = JSON.parse(content.toString()) as DocumentRecord[];
+${body}
+  console.log(\`search updated: \${records.length} records\`);
+}
+
+// the path of pre-rendered \`static.json\`
+const filePath = process.argv[2];
+if (!filePath) throw new Error('missing the path of static.json');
+void main(filePath);
+`;
+const providers = {
+	"orama-cloud": {
+		label: "Orama Cloud",
+		hint: "signup needed",
+		dependencies: { "@orama/core": null },
+		publicEnv: [
+			"ORAMA_DATASOURCE_ID",
+			"ORAMA_PROJECT_ID",
+			"ORAMA_API_KEY"
+		],
+		privateEnv: ["ORAMA_PRIVATE_API_KEY"],
+		static: true,
+		dialog: (env) => `'use client';
+${dialogImports}
+import { useDocsSearch } from 'fumadocs-core/search/client';
+import { OramaCloud } from '@orama/core';
+
+const client = new OramaCloud({
+  projectId: ${env.read}ORAMA_PROJECT_ID!,
+  apiKey: ${env.read}ORAMA_API_KEY!,
+});
+
+export default function CustomSearchDialog(props: SharedProps) {
+  const { locale } = useI18n();
+  const { search, setSearch, query } = useDocsSearch({
+    type: 'orama-cloud',
+    client,
+    locale,
+  });
+
+${dialogBody("Orama", "https://orama.com")}`,
+		exportIndexes: ({ ref }) => ({
+			imports: `import { ${ref} } from '@/lib/source';
+import { toDocuments } from 'fumadocs-core/search/orama-cloud';`,
+			documents: `toDocuments(${ref})`
+		}),
+		sync: (env) => syncScript(`import { type OramaDocument as DocumentRecord, sync } from 'fumadocs-core/search/orama-cloud';
+import { OramaCloud } from '@orama/core';`, `  const orama = new OramaCloud({
+    projectId: process.env.${env.prefix}ORAMA_PROJECT_ID!,
+    apiKey: process.env.ORAMA_PRIVATE_API_KEY!,
+  });
+
+  await sync(orama, {
+    index: process.env.${env.prefix}ORAMA_DATASOURCE_ID!,
+    documents: records,
+  });
+`)
+	},
+	algolia: {
+		label: "Algolia",
+		hint: "signup needed",
+		dependencies: { algoliasearch: null },
+		publicEnv: ["ALGOLIA_APP_ID", "ALGOLIA_SEARCH_KEY"],
+		privateEnv: ["ALGOLIA_WRITE_KEY"],
+		static: true,
+		dialog: (env) => `'use client';
+${dialogImports}
+import { useDocsSearch } from 'fumadocs-core/search/client';
+import { algoliaClient } from 'fumadocs-core/search/client/algolia';
+import { liteClient } from 'algoliasearch/lite';
+
+const algolia = liteClient(${env.read}ALGOLIA_APP_ID!, ${env.read}ALGOLIA_SEARCH_KEY!);
+
+export default function CustomSearchDialog(props: SharedProps) {
+  const { locale } = useI18n();
+  const { search, setSearch, query } = useDocsSearch({
+    client: algoliaClient({
+      client: algolia,
+      indexName: 'document',
+      locale,
+    }),
+  });
+
+${dialogBody("Algolia", "https://algolia.com")}`,
+		exportIndexes: ({ ref }) => ({
+			imports: `import { ${ref} } from '@/lib/source';
+import { toDocuments } from 'fumadocs-core/search/algolia';`,
+			documents: `toDocuments(${ref})`
+		}),
+		sync: (env) => syncScript(`import { type DocumentRecord, sync } from 'fumadocs-core/search/algolia';
+import { algoliasearch } from 'algoliasearch';`, `  const client = algoliasearch(
+    process.env.${env.prefix}ALGOLIA_APP_ID!,
+    process.env.ALGOLIA_WRITE_KEY!,
+  );
+
+  await sync(client, {
+    indexName: 'document',
+    documents: records,
+  });
+`)
+	},
+	typesense: {
+		label: "Typesense",
+		hint: "self-hosted or cloud, community adapter",
+		dependencies: {
+			typesense: null,
+			"typesense-fumadocs-adapter": null
+		},
+		publicEnv: ["TYPESENSE_URL", "TYPESENSE_SEARCH_KEY"],
+		privateEnv: ["TYPESENSE_API_KEY"],
+		static: true,
+		dialog: (env) => `'use client';
+${dialogImports}
+import { Client } from 'typesense';
+import { useTypesenseSearch } from 'typesense-fumadocs-adapter/client';
+
+const client = new Client({
+  nodes: [{ url: ${env.read}TYPESENSE_URL! }],
+  apiKey: ${env.read}TYPESENSE_SEARCH_KEY!,
+});
+
+export default function CustomSearchDialog(props: SharedProps) {
+  const { locale } = useI18n();
+  const { search, setSearch, query } = useTypesenseSearch({
+    typesenseCollectionName: 'docs',
+    locale,
+    client,
+  });
+
+${dialogBody("Typesense", "https://typesense.org")}`,
+		exportIndexes: (src) => ({
+			imports: "import { exportSearchIndexes } from '@/lib/export-search-indexes';",
+			documents: "exportSearchIndexes()",
+			file: (async) => typesenseIndexes(async, src)
+		}),
+		sync: (env) => syncScript(`import { type DocumentRecord, sync } from 'typesense-fumadocs-adapter';
+import { Client } from 'typesense';`, `  const client = new Client({
+    nodes: [{ url: process.env.${env.prefix}TYPESENSE_URL! }],
+    apiKey: process.env.TYPESENSE_API_KEY!,
+    connectionTimeoutSeconds: 60 * 15,
+  });
+
+  await sync(client, {
+    typesenseCollectionName: 'docs',
+    documents: records,
+  });
+`)
+	},
+	mixedbread: {
+		label: "Mixedbread",
+		hint: "AI search, signup needed",
+		dependencies: { "@mixedbread/sdk": null },
+		publicEnv: [],
+		privateEnv: ["MIXEDBREAD_API_KEY", "MIXEDBREAD_STORE_ID"],
+		static: false,
+		dialog: () => `'use client';
+${dialogImports}
+import { useDocsSearch } from 'fumadocs-core/search/client';
+import { fetchClient } from 'fumadocs-core/search/client/fetch';
+
+export default function CustomSearchDialog(props: SharedProps) {
+  const { locale } = useI18n();
+  const { search, setSearch, query } = useDocsSearch({
+    client: fetchClient({
+      api: '/api/search',
+      locale,
+    }),
+  });
+
+${dialogBody("Mixedbread", "https://mixedbread.com")}`,
+		sync: (_env, dir) => `import { spawnSync } from 'node:child_process';
+
+// sync the content with Mixedbread CLI
+const result = spawnSync(
+  'npx',
+  ['--yes', '@mixedbread/cli', 'vs', 'sync', process.env.MIXEDBREAD_STORE_ID!, '${dir}', '--ci'],
+  { stdio: 'inherit' },
+);
+
+process.exit(result.status ?? 1);
+`,
+		searchRoute: (() => {
+			const server = `import { createMixedbreadSearchAPI } from 'fumadocs-core/search/mixedbread';
+import Mixedbread from '@mixedbread/sdk';
+
+const server = createMixedbreadSearchAPI({
+  client: new Mixedbread({
+    apiKey: process.env.MIXEDBREAD_API_KEY,
+  }),
+  storeIdentifier: process.env.MIXEDBREAD_STORE_ID!,
+});
+`;
+			return {
+				next: `${server}
+export const { GET } = server;
+`,
+				"react-router": `import type { Route } from './+types/search';
+${server}
+export async function loader({ request }: Route.LoaderArgs) {
+  return server.GET(request);
+}
+`,
+				"tanstack-start": `import { createFileRoute } from '@tanstack/react-router';
+${server}
+export const Route = createFileRoute('/api/search')({
+  server: {
+    handlers: {
+      GET: async ({ request }) => server.GET(request),
+    },
+  },
+});
+`,
+				waku: `${server}
+export const { GET } = server;
+`
+			};
+		})()
+	}
+};
+const staticRoute = (framework, route, imports, documents) => routeModule(framework, route, {
+	imports,
+	body: `Response.json(await ${documents})`,
+	revalidate: true,
+	static: true
+});
+const search = {
+	id: "search",
+	title: "Search",
+	description: "replace the default search with a 3rd party search solution",
+	requires: [docs],
+	supports: (project) => project.source.loader || project.source.dynamic || "`lib/source.ts` must export a `source` loader",
+	options: { provider: {
+		message: "Choose a search provider",
+		choices: Object.entries(providers).map(([value, { label, hint }]) => ({
+			value,
+			label,
+			hint
+		}))
+	} },
+	async apply(ctx, { provider: name }) {
+		const { project } = ctx;
+		const { baseDir } = project;
+		const framework = reactFramework(project);
+		const provider = providers[name];
+		if (project.static && !provider.static) throw new Error(`${provider.label} requires a server at runtime`);
+		const env = publicEnv(framework === "next");
+		ctx.addDependencies(provider.dependencies);
+		await ctx.write(path.join(baseDir, "components/search.tsx"), provider.dialog(env));
+		const searchRoute = await findSource(project.cwd, path.join(baseDir, project.info.routesDir), "createFromSource(", (file) => /(^|[\\/])search(\.ts|[\\/]route\.ts)$/.test(file));
+		if (provider.searchRoute) {
+			if (searchRoute) await ctx.write(searchRoute, provider.searchRoute[framework]);
+			else ctx.note("Create the search route with `createMixedbreadSearchAPI`, see https://fumadocs.dev/docs/headless/search/mixedbread.");
+		} else if (searchRoute) await removeDefaultSearch(ctx, searchRoute);
+		if (provider.exportIndexes) {
+			const { imports, documents, file } = provider.exportIndexes(sourceRef(project.source.dynamic));
+			if (file) await ctx.write(path.join(baseDir, "lib/export-search-indexes.ts"), file(project.source.async));
+			const route = formatRoute({ segments: ["static.json"] }, framework, null);
+			await ctx.write(path.join(baseDir, route.file), staticRoute(framework, route, imports, documents));
+			if (framework === "react-router") await registerReactRouterRoutes(ctx, [route]);
+			else if (framework === "tanstack-start" && project.configFile) await ctx.source(project.configFile, (file) => addTanstackPrerender(file, [route.path]));
+		}
+		const rootProvider = await findSource(project.cwd, baseDir, "<RootProvider");
+		if (!(rootProvider !== void 0 && await ctx.source(rootProvider, (file) => {
+			const element = findJsxElement(file, "RootProvider")?.openingElement;
+			if (!element || file.code.slice(element.start, element.end).includes("search=")) return;
+			addJsxAttribute(file, element, "search={{ SearchDialog }}");
+			addImport(file, {
+				from: "@/components/search",
+				default: "SearchDialog"
+			});
+		}))) ctx.note("Pass `search={{ SearchDialog }}` from `@/components/search` to `<RootProvider />`.");
+		if (provider.sync) {
+			const output = {
+				next: ".next/server/app/static.json.body",
+				"react-router": "build/client/static.json",
+				"tanstack-start": project.static ? "dist/client/static.json" : ".output/public/static.json",
+				waku: "dist/public/static.json"
+			}[framework];
+			await ctx.write("scripts/sync-content.ts", provider.sync(env, project.source.dir));
+			await ctx.packageJson((data) => {
+				const build = data.scripts?.build ?? "";
+				if (build.includes("sync-content")) return;
+				const sync = `node --env-file-if-exists=.env.local scripts/sync-content.ts${provider.exportIndexes ? ` ${output}` : ""}`;
+				scripts(data, { build: build ? `${build} && ${sync}` : sync });
+			});
+		}
+		for (const key of provider.publicEnv) ctx.env(env.prefix + key, "");
+		for (const key of provider.privateEnv) ctx.env(key, "");
+		ctx.note(`Fill the ${provider.label} keys in \`.env.local\`, the search index is synced after each build.\nSee https://fumadocs.dev/docs/headless/search/${name}.`);
+	}
+};
+/** remove the default search route, which conflicts with the search provider */
+async function removeDefaultSearch(ctx, file) {
+	const { baseDir, framework } = ctx.project;
+	await ctx.remove(file);
+	if (framework !== "react-router") return;
+	const entry = posix(path.relative(baseDir, file));
+	await ctx.source(path.join(baseDir, "routes.ts"), (source) => {
+		filterReactRouterRoute(source, (item) => item.entry !== entry);
+	});
+	await ctx.source("react-router.config.ts", (source) => {
+		filterReactRouterPrerenderArray(source, "excluded", (item) => item !== "/api/search");
+	});
+}
+//#endregion
+export { search as t };
+
+//# sourceMappingURL=search-iphnSVVY.js.map

package/dist/search-iphnSVVY.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search-iphnSVVY.js","names":[],"sources":["../src/features/search.ts"],"sourcesContent":["import path from 'node:path';\nimport type { Feature, FeatureContext } from '@/features';\nimport type { ReactFramework } from '@/project';\nimport { type FormattedRoute, formatRoute, routeModule } from '@/project/route';\nimport {\n  addImport,\n  addJsxAttribute,\n  addTanstackPrerender,\n  filterReactRouterPrerenderArray,\n  filterReactRouterRoute,\n  findJsxElement,\n} from '@/codemod';\nimport { docs } from './docs';\nimport {\n  findSource,\n  posix,\n  reactFramework,\n  registerReactRouterRoutes,\n  scripts,\n  type SourceRef,\n  sourceRef,\n} from './utils';\n\n/** how client code reads public env variables */\ninterface Env {\n  prefix: string;\n  read: string;\n}\n\nconst publicEnv = (next: boolean): Env =>\n  next\n    ? { prefix: 'NEXT_PUBLIC_', read: 'process.env.NEXT_PUBLIC_' }\n    : { prefix: 'VITE_', read: 'import.meta.env.VITE_' };\n\nconst dialogImports = `import {\n  SearchDialog,\n  SearchDialogClose,\n  SearchDialogContent,\n  SearchDialogFooter,\n  SearchDialogHeader,\n  SearchDialogIcon,\n  SearchDialogInput,\n  SearchDialogList,\n  SearchDialogOverlay,\n  type SharedProps,\n} from 'fumadocs-ui/components/dialog/search';\nimport { useI18n } from 'fumadocs-ui/contexts/i18n';`;\n\nconst dialogBody = (footer: string, url: string) => `  return (\n    <SearchDialog search={search} onSearchChange={setSearch} isLoading={query.isLoading} {...props}>\n      <SearchDialogOverlay />\n      <SearchDialogContent>\n        <SearchDialogHeader>\n          <SearchDialogIcon />\n          <SearchDialogInput />\n          <SearchDialogClose />\n        </SearchDialogHeader>\n        <SearchDialogList items={query.data !== 'empty' ? query.data : null} />\n        <SearchDialogFooter>\n          <a\n            href=\"${url}\"\n            rel=\"noreferrer noopener\"\n            className=\"ms-auto text-xs text-fd-muted-foreground\"\n          >\n            Search powered by ${footer}\n          </a>\n        </SearchDialogFooter>\n      </SearchDialogContent>\n    </SearchDialog>\n  );\n}\n`;\n\n/** `structuredData` is a function on async collections (React Router & TanStack Start) */\nconst typesenseIndexes = (\n  async: boolean,\n  { ref, resolved }: SourceRef,\n) => `import { ${ref} } from '@/lib/source';\nimport type { DocumentRecord } from 'typesense-fumadocs-adapter';\n\nexport async function exportSearchIndexes() {\n  const results: DocumentRecord[] = [];\n  for (const page of ${resolved}.getPages()) {\n    results.push({\n      _id: page.url,\n      structured: ${async ? 'await page.data.structuredData()' : 'page.data.structuredData'},\n      url: page.url,\n      title: page.data.title,\n      description: page.data.description,\n      locale: page.locale,\n    });\n  }\n  return results;\n}\n`;\n\nconst syncScript = (imports: string, body: string) => `import * as fs from 'node:fs/promises';\n${imports}\n\nasync function main(filePath: string) {\n  const content = await fs.readFile(filePath);\n  const records = JSON.parse(content.toString()) as DocumentRecord[];\n${body}\n  console.log(\\`search updated: \\${records.length} records\\`);\n}\n\n// the path of pre-rendered \\`static.json\\`\nconst filePath = process.argv[2];\nif (!filePath) throw new Error('missing the path of static.json');\nvoid main(filePath);\n`;\n\ninterface Provider {\n  label: string;\n  hint: string;\n  dependencies: Record<string, string | null>;\n  /** keys exposed to the client, prefixed per framework */\n  publicEnv: string[];\n  privateEnv: string[];\n  /** works without a server at runtime */\n  static: boolean;\n  dialog: (env: Env) => string;\n  /** exports search indexes to a pre-rendered `static.json`, synced by `sync` after build */\n  exportIndexes?: (src: SourceRef) => {\n    imports: string;\n    /** expression producing the documents */\n    documents: string;\n    /** generated `lib/export-search-indexes.ts`, for providers without a `toDocuments()` */\n    file?: (async: boolean) => string;\n  };\n  sync?: (env: Env, dir: string) => string;\n  /** server-side search, replaces the default search route */\n  searchRoute?: Record<ReactFramework, string>;\n}\n\nconst providers = {\n  'orama-cloud': {\n    label: 'Orama Cloud',\n    hint: 'signup needed',\n    dependencies: { '@orama/core': null },\n    publicEnv: ['ORAMA_DATASOURCE_ID', 'ORAMA_PROJECT_ID', 'ORAMA_API_KEY'],\n    privateEnv: ['ORAMA_PRIVATE_API_KEY'],\n    static: true,\n    dialog: (env) => `'use client';\n${dialogImports}\nimport { useDocsSearch } from 'fumadocs-core/search/client';\nimport { OramaCloud } from '@orama/core';\n\nconst client = new OramaCloud({\n  projectId: ${env.read}ORAMA_PROJECT_ID!,\n  apiKey: ${env.read}ORAMA_API_KEY!,\n});\n\nexport default function CustomSearchDialog(props: SharedProps) {\n  const { locale } = useI18n();\n  const { search, setSearch, query } = useDocsSearch({\n    type: 'orama-cloud',\n    client,\n    locale,\n  });\n\n${dialogBody('Orama', 'https://orama.com')}`,\n    exportIndexes: ({ ref }) => ({\n      imports: `import { ${ref} } from '@/lib/source';\nimport { toDocuments } from 'fumadocs-core/search/orama-cloud';`,\n      documents: `toDocuments(${ref})`,\n    }),\n    sync: (env) =>\n      syncScript(\n        `import { type OramaDocument as DocumentRecord, sync } from 'fumadocs-core/search/orama-cloud';\nimport { OramaCloud } from '@orama/core';`,\n        `  const orama = new OramaCloud({\n    projectId: process.env.${env.prefix}ORAMA_PROJECT_ID!,\n    apiKey: process.env.ORAMA_PRIVATE_API_KEY!,\n  });\n\n  await sync(orama, {\n    index: process.env.${env.prefix}ORAMA_DATASOURCE_ID!,\n    documents: records,\n  });\n`,\n      ),\n  },\n  algolia: {\n    label: 'Algolia',\n    hint: 'signup needed',\n    dependencies: { algoliasearch: null },\n    publicEnv: ['ALGOLIA_APP_ID', 'ALGOLIA_SEARCH_KEY'],\n    privateEnv: ['ALGOLIA_WRITE_KEY'],\n    static: true,\n    dialog: (env) => `'use client';\n${dialogImports}\nimport { useDocsSearch } from 'fumadocs-core/search/client';\nimport { algoliaClient } from 'fumadocs-core/search/client/algolia';\nimport { liteClient } from 'algoliasearch/lite';\n\nconst algolia = liteClient(${env.read}ALGOLIA_APP_ID!, ${env.read}ALGOLIA_SEARCH_KEY!);\n\nexport default function CustomSearchDialog(props: SharedProps) {\n  const { locale } = useI18n();\n  const { search, setSearch, query } = useDocsSearch({\n    client: algoliaClient({\n      client: algolia,\n      indexName: 'document',\n      locale,\n    }),\n  });\n\n${dialogBody('Algolia', 'https://algolia.com')}`,\n    exportIndexes: ({ ref }) => ({\n      imports: `import { ${ref} } from '@/lib/source';\nimport { toDocuments } from 'fumadocs-core/search/algolia';`,\n      documents: `toDocuments(${ref})`,\n    }),\n    sync: (env) =>\n      syncScript(\n        `import { type DocumentRecord, sync } from 'fumadocs-core/search/algolia';\nimport { algoliasearch } from 'algoliasearch';`,\n        `  const client = algoliasearch(\n    process.env.${env.prefix}ALGOLIA_APP_ID!,\n    process.env.ALGOLIA_WRITE_KEY!,\n  );\n\n  await sync(client, {\n    indexName: 'document',\n    documents: records,\n  });\n`,\n      ),\n  },\n  typesense: {\n    label: 'Typesense',\n    hint: 'self-hosted or cloud, community adapter',\n    dependencies: { typesense: null, 'typesense-fumadocs-adapter': null },\n    publicEnv: ['TYPESENSE_URL', 'TYPESENSE_SEARCH_KEY'],\n    privateEnv: ['TYPESENSE_API_KEY'],\n    static: true,\n    dialog: (env) => `'use client';\n${dialogImports}\nimport { Client } from 'typesense';\nimport { useTypesenseSearch } from 'typesense-fumadocs-adapter/client';\n\nconst client = new Client({\n  nodes: [{ url: ${env.read}TYPESENSE_URL! }],\n  apiKey: ${env.read}TYPESENSE_SEARCH_KEY!,\n});\n\nexport default function CustomSearchDialog(props: SharedProps) {\n  const { locale } = useI18n();\n  const { search, setSearch, query } = useTypesenseSearch({\n    typesenseCollectionName: 'docs',\n    locale,\n    client,\n  });\n\n${dialogBody('Typesense', 'https://typesense.org')}`,\n    exportIndexes: (src) => ({\n      imports: \"import { exportSearchIndexes } from '@/lib/export-search-indexes';\",\n      documents: 'exportSearchIndexes()',\n      file: (async) => typesenseIndexes(async, src),\n    }),\n    sync: (env) =>\n      syncScript(\n        `import { type DocumentRecord, sync } from 'typesense-fumadocs-adapter';\nimport { Client } from 'typesense';`,\n        `  const client = new Client({\n    nodes: [{ url: process.env.${env.prefix}TYPESENSE_URL! }],\n    apiKey: process.env.TYPESENSE_API_KEY!,\n    connectionTimeoutSeconds: 60 * 15,\n  });\n\n  await sync(client, {\n    typesenseCollectionName: 'docs',\n    documents: records,\n  });\n`,\n      ),\n  },\n  mixedbread: {\n    label: 'Mixedbread',\n    hint: 'AI search, signup needed',\n    dependencies: { '@mixedbread/sdk': null },\n    publicEnv: [],\n    privateEnv: ['MIXEDBREAD_API_KEY', 'MIXEDBREAD_STORE_ID'],\n    static: false,\n    dialog: () => `'use client';\n${dialogImports}\nimport { useDocsSearch } from 'fumadocs-core/search/client';\nimport { fetchClient } from 'fumadocs-core/search/client/fetch';\n\nexport default function CustomSearchDialog(props: SharedProps) {\n  const { locale } = useI18n();\n  const { search, setSearch, query } = useDocsSearch({\n    client: fetchClient({\n      api: '/api/search',\n      locale,\n    }),\n  });\n\n${dialogBody('Mixedbread', 'https://mixedbread.com')}`,\n    sync: (_env, dir) => `import { spawnSync } from 'node:child_process';\n\n// sync the content with Mixedbread CLI\nconst result = spawnSync(\n  'npx',\n  ['--yes', '@mixedbread/cli', 'vs', 'sync', process.env.MIXEDBREAD_STORE_ID!, '${dir}', '--ci'],\n  { stdio: 'inherit' },\n);\n\nprocess.exit(result.status ?? 1);\n`,\n    searchRoute: (() => {\n      const server = `import { createMixedbreadSearchAPI } from 'fumadocs-core/search/mixedbread';\nimport Mixedbread from '@mixedbread/sdk';\n\nconst server = createMixedbreadSearchAPI({\n  client: new Mixedbread({\n    apiKey: process.env.MIXEDBREAD_API_KEY,\n  }),\n  storeIdentifier: process.env.MIXEDBREAD_STORE_ID!,\n});\n`;\n      return {\n        next: `${server}\nexport const { GET } = server;\n`,\n        'react-router': `import type { Route } from './+types/search';\n${server}\nexport async function loader({ request }: Route.LoaderArgs) {\n  return server.GET(request);\n}\n`,\n        'tanstack-start': `import { createFileRoute } from '@tanstack/react-router';\n${server}\nexport const Route = createFileRoute('/api/search')({\n  server: {\n    handlers: {\n      GET: async ({ request }) => server.GET(request),\n    },\n  },\n});\n`,\n        waku: `${server}\nexport const { GET } = server;\n`,\n      };\n    })(),\n  },\n} satisfies Record<string, Provider>;\n\nexport type SearchProvider = keyof typeof providers;\n\nconst staticRoute = (\n  framework: ReactFramework,\n  route: FormattedRoute,\n  imports: string,\n  documents: string,\n) =>\n  routeModule(framework, route, {\n    imports,\n    body: `Response.json(await ${documents})`,\n    revalidate: true,\n    static: true,\n  });\n\nexport const search: Feature<{ provider: SearchProvider }> = {\n  id: 'search',\n  title: 'Search',\n  description: 'replace the default search with a 3rd party search solution',\n  requires: [docs],\n  supports: (project) =>\n    project.source.loader ||\n    project.source.dynamic ||\n    '`lib/source.ts` must export a `source` loader',\n  options: {\n    provider: {\n      message: 'Choose a search provider',\n      choices: Object.entries(providers).map(([value, { label, hint }]) => ({\n        value: value as SearchProvider,\n        label,\n        hint,\n      })),\n    },\n  },\n  async apply(ctx, { provider: name }) {\n    const { project } = ctx;\n    const { baseDir } = project;\n    const framework = reactFramework(project);\n    const provider: Provider = providers[name];\n    if (project.static && !provider.static)\n      throw new Error(`${provider.label} requires a server at runtime`);\n    const env = publicEnv(framework === 'next');\n\n    ctx.addDependencies(provider.dependencies);\n    await ctx.write(path.join(baseDir, 'components/search.tsx'), provider.dialog(env));\n\n    // other routes (e.g. MCP) also create a search server, only match the search route itself\n    const searchRoute = await findSource(\n      project.cwd,\n      path.join(baseDir, project.info.routesDir),\n      'createFromSource(',\n      (file) => /(^|[\\\\/])search(\\.ts|[\\\\/]route\\.ts)$/.test(file),\n    );\n    if (provider.searchRoute) {\n      if (searchRoute) await ctx.write(searchRoute, provider.searchRoute[framework]);\n      else\n        ctx.note(\n          'Create the search route with `createMixedbreadSearchAPI`, see https://fumadocs.dev/docs/headless/search/mixedbread.',\n        );\n    } else if (searchRoute) {\n      await removeDefaultSearch(ctx, searchRoute);\n    }\n\n    if (provider.exportIndexes) {\n      const { imports, documents, file } = provider.exportIndexes(\n        sourceRef(project.source.dynamic),\n      );\n      if (file)\n        await ctx.write(\n          path.join(baseDir, 'lib/export-search-indexes.ts'),\n          file(project.source.async),\n        );\n\n      const route = formatRoute({ segments: ['static.json'] }, framework, null);\n      await ctx.write(\n        path.join(baseDir, route.file),\n        staticRoute(framework, route, imports, documents),\n      );\n\n      if (framework === 'react-router') {\n        await registerReactRouterRoutes(ctx, [route]);\n      } else if (framework === 'tanstack-start' && project.configFile) {\n        await ctx.source(project.configFile, (file) => addTanstackPrerender(file, [route.path]));\n      }\n    }\n\n    const rootProvider = await findSource(project.cwd, baseDir, '<RootProvider');\n    const edited =\n      rootProvider !== undefined &&\n      (await ctx.source(rootProvider, (file) => {\n        const element = findJsxElement(file, 'RootProvider')?.openingElement;\n        if (!element || file.code.slice(element.start, element.end).includes('search=')) return;\n        addJsxAttribute(file, element, 'search={{ SearchDialog }}');\n        addImport(file, { from: '@/components/search', default: 'SearchDialog' });\n      }));\n    if (!edited)\n      ctx.note(\n        'Pass `search={{ SearchDialog }}` from `@/components/search` to `<RootProvider />`.',\n      );\n\n    if (provider.sync) {\n      // path of the pre-rendered `static.json`, passed to the sync script\n      const output = {\n        next: '.next/server/app/static.json.body',\n        'react-router': 'build/client/static.json',\n        'tanstack-start': project.static ? 'dist/client/static.json' : '.output/public/static.json',\n        waku: 'dist/public/static.json',\n      }[framework];\n      await ctx.write('scripts/sync-content.ts', provider.sync(env, project.source.dir));\n      await ctx.packageJson((data) => {\n        const build = data.scripts?.build ?? '';\n        if (build.includes('sync-content')) return;\n        const sync = `node --env-file-if-exists=.env.local scripts/sync-content.ts${provider.exportIndexes ? ` ${output}` : ''}`;\n        scripts(data, { build: build ? `${build} && ${sync}` : sync });\n      });\n    }\n\n    for (const key of provider.publicEnv) ctx.env(env.prefix + key, '');\n    for (const key of provider.privateEnv) ctx.env(key, '');\n    ctx.note(\n      `Fill the ${provider.label} keys in \\`.env.local\\`, the search index is synced after each build.\\nSee https://fumadocs.dev/docs/headless/search/${name}.`,\n    );\n  },\n};\n\n/** remove the default search route, which conflicts with the search provider */\nasync function removeDefaultSearch(ctx: FeatureContext, file: string) {\n  const { baseDir, framework } = ctx.project;\n  await ctx.remove(file);\n  if (framework !== 'react-router') return;\n\n  const entry = posix(path.relative(baseDir, file));\n  await ctx.source(path.join(baseDir, 'routes.ts'), (source) => {\n    filterReactRouterRoute(source, (item) => item.entry !== entry);\n  });\n  await ctx.source('react-router.config.ts', (source) => {\n    filterReactRouterPrerenderArray(source, 'excluded', (item) => item !== '/api/search');\n  });\n}\n"],"mappings":";;;;;AA6BA,MAAM,aAAa,SACjB,OACI;CAAE,QAAQ;CAAgB,MAAM;AAA2B,IAC3D;CAAE,QAAQ;CAAS,MAAM;AAAwB;AAEvD,MAAM,gBAAgB;;;;;;;;;;;;;AActB,MAAM,cAAc,QAAgB,QAAgB;;;;;;;;;;;;oBAYhC,IAAI;;;;gCAIQ,OAAO;;;;;;;;;AAUvC,MAAM,oBACJ,OACA,EAAE,KAAK,eACJ,YAAY,IAAI;;;;;uBAKE,SAAS;;;oBAGZ,QAAQ,qCAAqC,2BAA2B;;;;;;;;;;AAW5F,MAAM,cAAc,SAAiB,SAAiB;EACpD,QAAQ;;;;;EAKR,KAAK;;;;;;;;;AAiCP,MAAM,YAAY;CAChB,eAAe;EACb,OAAO;EACP,MAAM;EACN,cAAc,EAAE,eAAe,KAAK;EACpC,WAAW;GAAC;GAAuB;GAAoB;EAAe;EACtE,YAAY,CAAC,uBAAuB;EACpC,QAAQ;EACR,SAAS,QAAQ;EACnB,cAAc;;;;;eAKD,IAAI,KAAK;YACZ,IAAI,KAAK;;;;;;;;;;;EAWnB,WAAW,SAAS,mBAAmB;EACrC,gBAAgB,EAAE,WAAW;GAC3B,SAAS,YAAY,IAAI;;GAEzB,WAAW,eAAe,IAAI;EAChC;EACA,OAAO,QACL,WACE;4CAEA;6BACqB,IAAI,OAAO;;;;;yBAKf,IAAI,OAAO;;;CAI9B;CACJ;CACA,SAAS;EACP,OAAO;EACP,MAAM;EACN,cAAc,EAAE,eAAe,KAAK;EACpC,WAAW,CAAC,kBAAkB,oBAAoB;EAClD,YAAY,CAAC,mBAAmB;EAChC,QAAQ;EACR,SAAS,QAAQ;EACnB,cAAc;;;;;6BAKa,IAAI,KAAK,mBAAmB,IAAI,KAAK;;;;;;;;;;;;EAYhE,WAAW,WAAW,qBAAqB;EACzC,gBAAgB,EAAE,WAAW;GAC3B,SAAS,YAAY,IAAI;;GAEzB,WAAW,eAAe,IAAI;EAChC;EACA,OAAO,QACL,WACE;iDAEA;kBACU,IAAI,OAAO;;;;;;;;CASvB;CACJ;CACA,WAAW;EACT,OAAO;EACP,MAAM;EACN,cAAc;GAAE,WAAW;GAAM,8BAA8B;EAAK;EACpE,WAAW,CAAC,iBAAiB,sBAAsB;EACnD,YAAY,CAAC,mBAAmB;EAChC,QAAQ;EACR,SAAS,QAAQ;EACnB,cAAc;;;;;mBAKG,IAAI,KAAK;YAChB,IAAI,KAAK;;;;;;;;;;;EAWnB,WAAW,aAAa,uBAAuB;EAC7C,gBAAgB,SAAS;GACvB,SAAS;GACT,WAAW;GACX,OAAO,UAAU,iBAAiB,OAAO,GAAG;EAC9C;EACA,OAAO,QACL,WACE;sCAEA;iCACyB,IAAI,OAAO;;;;;;;;;CAUtC;CACJ;CACA,YAAY;EACV,OAAO;EACP,MAAM;EACN,cAAc,EAAE,mBAAmB,KAAK;EACxC,WAAW,CAAC;EACZ,YAAY,CAAC,sBAAsB,qBAAqB;EACxD,QAAQ;EACR,cAAc;EAChB,cAAc;;;;;;;;;;;;;EAad,WAAW,cAAc,wBAAwB;EAC/C,OAAO,MAAM,QAAQ;;;;;kFAKyD,IAAI;;;;;;EAMlF,oBAAoB;GAClB,MAAM,SAAS;;;;;;;;;;GAUf,OAAO;IACL,MAAM,GAAG,OAAO;;;IAGhB,gBAAgB;EACtB,OAAO;;;;;IAKD,kBAAkB;EACxB,OAAO;;;;;;;;;IASD,MAAM,GAAG,OAAO;;;GAGlB;EACF,EAAA,CAAG;CACL;AACF;AAIA,MAAM,eACJ,WACA,OACA,SACA,cAEA,YAAY,WAAW,OAAO;CAC5B;CACA,MAAM,uBAAuB,UAAU;CACvC,YAAY;CACZ,QAAQ;AACV,CAAC;AAEH,MAAa,SAAgD;CAC3D,IAAI;CACJ,OAAO;CACP,aAAa;CACb,UAAU,CAAC,IAAI;CACf,WAAW,YACT,QAAQ,OAAO,UACf,QAAQ,OAAO,WACf;CACF,SAAS,EACP,UAAU;EACR,SAAS;EACT,SAAS,OAAO,QAAQ,SAAS,CAAC,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,aAAa;GAC7D;GACP;GACA;EACF,EAAE;CACJ,EACF;CACA,MAAM,MAAM,KAAK,EAAE,UAAU,QAAQ;EACnC,MAAM,EAAE,YAAY;EACpB,MAAM,EAAE,YAAY;EACpB,MAAM,YAAY,eAAe,OAAO;EACxC,MAAM,WAAqB,UAAU;EACrC,IAAI,QAAQ,UAAU,CAAC,SAAS,QAC9B,MAAM,IAAI,MAAM,GAAG,SAAS,MAAM,8BAA8B;EAClE,MAAM,MAAM,UAAU,cAAc,MAAM;EAE1C,IAAI,gBAAgB,SAAS,YAAY;EACzC,MAAM,IAAI,MAAM,KAAK,KAAK,SAAS,uBAAuB,GAAG,SAAS,OAAO,GAAG,CAAC;EAGjF,MAAM,cAAc,MAAM,WACxB,QAAQ,KACR,KAAK,KAAK,SAAS,QAAQ,KAAK,SAAS,GACzC,sBACC,SAAS,wCAAwC,KAAK,IAAI,CAC7D;EACA,IAAI,SAAS,aAAa;GACxB,IAAI,aAAa,MAAM,IAAI,MAAM,aAAa,SAAS,YAAY,UAAU;QAE3E,IAAI,KACF,qHACF;EACJ,OAAO,IAAI,aACT,MAAM,oBAAoB,KAAK,WAAW;EAG5C,IAAI,SAAS,eAAe;GAC1B,MAAM,EAAE,SAAS,WAAW,SAAS,SAAS,cAC5C,UAAU,QAAQ,OAAO,OAAO,CAClC;GACA,IAAI,MACF,MAAM,IAAI,MACR,KAAK,KAAK,SAAS,8BAA8B,GACjD,KAAK,QAAQ,OAAO,KAAK,CAC3B;GAEF,MAAM,QAAQ,YAAY,EAAE,UAAU,CAAC,aAAa,EAAE,GAAG,WAAW,IAAI;GACxE,MAAM,IAAI,MACR,KAAK,KAAK,SAAS,MAAM,IAAI,GAC7B,YAAY,WAAW,OAAO,SAAS,SAAS,CAClD;GAEA,IAAI,cAAc,gBAChB,MAAM,0BAA0B,KAAK,CAAC,KAAK,CAAC;QACvC,IAAI,cAAc,oBAAoB,QAAQ,YACnD,MAAM,IAAI,OAAO,QAAQ,aAAa,SAAS,qBAAqB,MAAM,CAAC,MAAM,IAAI,CAAC,CAAC;EAE3F;EAEA,MAAM,eAAe,MAAM,WAAW,QAAQ,KAAK,SAAS,eAAe;EAS3E,IAAI,EAPF,iBAAiB,KAAA,KAChB,MAAM,IAAI,OAAO,eAAe,SAAS;GACxC,MAAM,UAAU,eAAe,MAAM,cAAc,CAAC,EAAE;GACtD,IAAI,CAAC,WAAW,KAAK,KAAK,MAAM,QAAQ,OAAO,QAAQ,GAAG,CAAC,CAAC,SAAS,SAAS,GAAG;GACjF,gBAAgB,MAAM,SAAS,2BAA2B;GAC1D,UAAU,MAAM;IAAE,MAAM;IAAuB,SAAS;GAAe,CAAC;EAC1E,CAAC,IAED,IAAI,KACF,oFACF;EAEF,IAAI,SAAS,MAAM;GAEjB,MAAM,SAAS;IACb,MAAM;IACN,gBAAgB;IAChB,kBAAkB,QAAQ,SAAS,4BAA4B;IAC/D,MAAM;GACR,EAAE;GACF,MAAM,IAAI,MAAM,2BAA2B,SAAS,KAAK,KAAK,QAAQ,OAAO,GAAG,CAAC;GACjF,MAAM,IAAI,aAAa,SAAS;IAC9B,MAAM,QAAQ,KAAK,SAAS,SAAS;IACrC,IAAI,MAAM,SAAS,cAAc,GAAG;IACpC,MAAM,OAAO,+DAA+D,SAAS,gBAAgB,IAAI,WAAW;IACpH,QAAQ,MAAM,EAAE,OAAO,QAAQ,GAAG,MAAM,MAAM,SAAS,KAAK,CAAC;GAC/D,CAAC;EACH;EAEA,KAAK,MAAM,OAAO,SAAS,WAAW,IAAI,IAAI,IAAI,SAAS,KAAK,EAAE;EAClE,KAAK,MAAM,OAAO,SAAS,YAAY,IAAI,IAAI,KAAK,EAAE;EACtD,IAAI,KACF,YAAY,SAAS,MAAM,uHAAuH,KAAK,EACzJ;CACF;AACF;;AAGA,eAAe,oBAAoB,KAAqB,MAAc;CACpE,MAAM,EAAE,SAAS,cAAc,IAAI;CACnC,MAAM,IAAI,OAAO,IAAI;CACrB,IAAI,cAAc,gBAAgB;CAElC,MAAM,QAAQ,MAAM,KAAK,SAAS,SAAS,IAAI,CAAC;CAChD,MAAM,IAAI,OAAO,KAAK,KAAK,SAAS,WAAW,IAAI,WAAW;EAC5D,uBAAuB,SAAS,SAAS,KAAK,UAAU,KAAK;CAC/D,CAAC;CACD,MAAM,IAAI,OAAO,2BAA2B,WAAW;EACrD,gCAAgC,QAAQ,aAAa,SAAS,SAAS,aAAa;CACtF,CAAC;AACH"}

package/dist/utils-B1Xy4l_a.d.ts

@@ -0,0 +1,43 @@
+import { a as Project, o as ReactFramework } from "./index-BCVGQxn9.js";
+import { i as FeatureContext, s as PackageJson } from "./index-CR9T40ox.js";
+//#region src/project/route.d.ts
+interface FormattedRoute {
+  /** route file, relative to the base dir */
+  file: string;
+  /** route string of the framework, e.g. for `RouteContext<'...'>`, `createFileRoute('...')`, `route('...')` or `ApiContext<'...'>` */
+  path: string;
+  /** path-to-regexp pattern, for the Next.js proxy matcher and rewrites */
+  pattern: string;
+}
+//#endregion
+//#region src/features/utils.d.ts
+/** the shallowest `.ts`/`.tsx` file under `dir` whose content includes `needle`, relative to `cwd` */
+declare function findSource(cwd: string, dir: string, needle: string, match?: (file: string) => boolean): Promise<string | undefined>;
+declare function scripts(json: PackageJson, scripts: Record<string, string>): void;
+declare const reactOnly: (project: Project) => "Astro is not supported by this feature" | true;
+declare function reactFramework(project: Project): ReactFramework;
+/** POSIX path for generated code and route configs */
+declare const posix: (file: string) => string;
+/** add an export to a source file, unless a declaration with the same name exists */
+declare function addExport(ctx: FeatureContext, file: string, name: string, code: string): Promise<boolean>;
+/** add a page URL helper to `lib/shared.ts`, where the route constants live */
+declare function addPageUrl(ctx: FeatureContext, name: string, code: string): Promise<boolean>;
+/** the value of a route constant in `lib/shared.ts`, defined with `value` when missing */
+declare function sharedRoute(ctx: FeatureContext, name: string, value: string): Promise<string>;
+/** add routes to `routes.ts`, or tell the user when the config isn't an array (e.g. file-based routes) */
+declare function registerReactRouterRoutes(ctx: FeatureContext, routes: (FormattedRoute | string)[]): Promise<boolean>;
+/** features reading page Markdown need Fumadocs MDX collections, or a runtime source exposing `page.data.content` */
+declare const requiresMarkdown: (project: Project) => "Astro is not supported by this feature" | "requires Fumadocs MDX or a runtime content source" | true;
+/** how generated code refers to the loader of `lib/source.ts` */
+interface SourceRef {
+  /** resolved on demand, `lib/source.ts` exports `getSource()` instead of `source` */
+  dynamic: boolean;
+  /** passed to Fumadocs APIs, which accept a loader or a function resolving one */
+  ref: string;
+  /** reads the loader inside an async function */
+  resolved: string;
+}
+declare function sourceRef(dynamic: boolean): SourceRef;
+//#endregion
+export { posix as a, registerReactRouterRoutes as c, sharedRoute as d, sourceRef as f, findSource as i, requiresMarkdown as l, addExport as n, reactFramework as o, FormattedRoute as p, addPageUrl as r, reactOnly as s, SourceRef as t, scripts as u };
+//# sourceMappingURL=utils-B1Xy4l_a.d.ts.map

package/dist/utils-B1Xy4l_a.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils-B1Xy4l_a.d.ts","names":[],"sources":["../src/project/route.ts","../src/features/utils.ts"],"mappings":";;;UAoBiB;;EAEf;;EAEA;;EAEA;;;;;iBClBoB,WACpB,aACA,aACA,gBACA,SAAQ,2BAAqC;iBAiB/B,QAAQ,MAAM,aAAa,SAAS;cAIvC,YAAS,SAAa;iBAGnB,eAAe,SAAS,UAAU;;cAMrC,QAAK;;iBAGI,UAAU,KAAK,gBAAgB,cAAc,cAAc,eAAY;;iBAQvE,WAAW,KAAK,gBAAgB,cAAc,eAAY;;iBAe1D,YAAY,KAAK,gBAAgB,cAAc,gBAAa;;iBAY5D,0BACpB,KAAK,gBACL,SAAS,6BACR;;cAyBU,mBAAgB,SAAa;;UAQzB;;EAEf;;EAEA;;EAEA;;iBAGc,UAAU,mBAAmB"}

package/dist/utils-DbMe7h6c.js

@@ -0,0 +1,98 @@
+import { a as addReactRouterRoute, p as addImport } from "./codemod-auol-p4R.js";
+import fs from "node:fs/promises";
+import path from "node:path";
+//#region src/features/utils.ts
+/** the shallowest `.ts`/`.tsx` file under `dir` whose content includes `needle`, relative to `cwd` */
+async function findSource(cwd, dir, needle, match = () => true) {
+	const entries = await fs.readdir(path.join(cwd, dir), {
+		recursive: true,
+		withFileTypes: true
+	}).catch(() => []);
+	const depth = (dir) => dir.split(path.sep).length;
+	entries.sort((a, b) => depth(a.parentPath) - depth(b.parentPath));
+	for (const entry of entries) {
+		if (!entry.isFile() || !/\.tsx?$/.test(entry.name) || entry.parentPath.includes("node_modules")) continue;
+		const file = path.join(entry.parentPath, entry.name);
+		if (!match(file)) continue;
+		if ((await fs.readFile(file, "utf-8")).includes(needle)) return path.relative(cwd, file);
+	}
+}
+function scripts(json, scripts) {
+	Object.assign(json.scripts ??= {}, scripts);
+}
+const reactOnly = (project) => project.framework !== "astro" || "Astro is not supported by this feature";
+function reactFramework(project) {
+	if (project.framework === "astro") throw new Error("Astro is not supported by this feature");
+	return project.framework;
+}
+/** POSIX path for generated code and route configs */
+const posix = (file) => file.split(path.sep).join("/");
+/** add an export to a source file, unless a declaration with the same name exists */
+async function addExport(ctx, file, name, code) {
+	const current = await fs.readFile(path.join(ctx.project.cwd, file), "utf-8").catch(() => "");
+	if (new RegExp(`export (async )?(const|function) ${name}\\b`).test(current)) return false;
+	await ctx.append(file, [code]);
+	return true;
+}
+/** add a page URL helper to `lib/shared.ts`, where the route constants live */
+async function addPageUrl(ctx, name, code) {
+	const file = path.join(ctx.project.baseDir, "lib/shared.ts");
+	if (!await addExport(ctx, file, name, code)) return false;
+	await ctx.source(file, (source) => addImport(source, {
+		from: "fumadocs-core/source",
+		named: ["createGetUrl"]
+	}));
+	if (ctx.project.i18n) await ctx.source(file, (source) => addImport(source, {
+		from: "./i18n",
+		named: ["i18n"]
+	}));
+	return true;
+}
+/** the value of a route constant in `lib/shared.ts`, defined with `value` when missing */
+async function sharedRoute(ctx, name, value) {
+	const file = path.join(ctx.project.baseDir, "lib/shared.ts");
+	const current = await fs.readFile(path.join(ctx.project.cwd, file), "utf-8").catch(() => "");
+	const existing = new RegExp(`export const ${name}\\s*=\\s*['"]([^'"]*)['"]`).exec(current)?.[1];
+	if (existing !== void 0) return existing;
+	const separator = current.trimEnd().endsWith(";") || current.length === 0 ? "" : "\n";
+	await ctx.append(file, [`${separator}export const ${name} = '${value}';`]);
+	return value;
+}
+/** add routes to `routes.ts`, or tell the user when the config isn't an array (e.g. file-based routes) */
+async function registerReactRouterRoutes(ctx, routes) {
+	const { baseDir } = ctx.project;
+	const entries = routes.map((item) => typeof item === "string" ? item : {
+		path: item.path,
+		entry: item.file
+	});
+	let added = false;
+	if (!await ctx.source(path.join(baseDir, "routes.ts"), (file) => {
+		const first = entries[0];
+		if (file.code.includes(typeof first === "string" ? first : first.entry)) {
+			added = true;
+			return;
+		}
+		added = addReactRouterRoute(file, entries);
+	}) || !added) {
+		const list = entries.map((item) => typeof item === "string" ? item : `route('${item.path}', '${item.entry}')`);
+		ctx.note(`Register the routes in your route config:\n  ${list.join("\n  ")}`);
+	}
+	return added;
+}
+/** features reading page Markdown need Fumadocs MDX collections, or a runtime source exposing `page.data.content` */
+const requiresMarkdown = (project) => project.framework === "astro" ? "Astro is not supported by this feature" : project.source.collections !== null || project.source.dynamic || "requires Fumadocs MDX or a runtime content source";
+function sourceRef(dynamic) {
+	return dynamic ? {
+		dynamic: true,
+		ref: "getSource",
+		resolved: "(await getSource())"
+	} : {
+		dynamic: false,
+		ref: "source",
+		resolved: "source"
+	};
+}
+//#endregion
+export { reactFramework as a, requiresMarkdown as c, sourceRef as d, posix as i, scripts as l, addPageUrl as n, reactOnly as o, findSource as r, registerReactRouterRoutes as s, addExport as t, sharedRoute as u };
+
+//# sourceMappingURL=utils-DbMe7h6c.js.map

package/dist/utils-DbMe7h6c.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils-DbMe7h6c.js","names":[],"sources":["../src/features/utils.ts"],"sourcesContent":["import fs from 'node:fs/promises';\nimport path from 'node:path';\nimport type { Project, ReactFramework } from '@/project';\nimport type { FormattedRoute } from '@/project/route';\nimport type { FeatureContext, PackageJson } from '@/features';\nimport { addImport, addReactRouterRoute } from '@/codemod';\n\n/** the shallowest `.ts`/`.tsx` file under `dir` whose content includes `needle`, relative to `cwd` */\nexport async function findSource(\n  cwd: string,\n  dir: string,\n  needle: string,\n  match: (file: string) => boolean = () => true,\n) {\n  const entries = await fs\n    .readdir(path.join(cwd, dir), { recursive: true, withFileTypes: true })\n    .catch(() => []);\n  const depth = (dir: string) => dir.split(path.sep).length;\n  entries.sort((a, b) => depth(a.parentPath) - depth(b.parentPath));\n\n  for (const entry of entries) {\n    if (!entry.isFile() || !/\\.tsx?$/.test(entry.name) || entry.parentPath.includes('node_modules'))\n      continue;\n    const file = path.join(entry.parentPath, entry.name);\n    if (!match(file)) continue;\n    if ((await fs.readFile(file, 'utf-8')).includes(needle)) return path.relative(cwd, file);\n  }\n}\n\nexport function scripts(json: PackageJson, scripts: Record<string, string>) {\n  Object.assign((json.scripts ??= {}), scripts);\n}\n\nexport const reactOnly = (project: Project) =>\n  project.framework !== 'astro' || 'Astro is not supported by this feature';\n\nexport function reactFramework(project: Project): ReactFramework {\n  if (project.framework === 'astro') throw new Error('Astro is not supported by this feature');\n  return project.framework;\n}\n\n/** POSIX path for generated code and route configs */\nexport const posix = (file: string) => file.split(path.sep).join('/');\n\n/** add an export to a source file, unless a declaration with the same name exists */\nexport async function addExport(ctx: FeatureContext, file: string, name: string, code: string) {\n  const current = await fs.readFile(path.join(ctx.project.cwd, file), 'utf-8').catch(() => '');\n  if (new RegExp(`export (async )?(const|function) ${name}\\\\b`).test(current)) return false;\n  await ctx.append(file, [code]);\n  return true;\n}\n\n/** add a page URL helper to `lib/shared.ts`, where the route constants live */\nexport async function addPageUrl(ctx: FeatureContext, name: string, code: string) {\n  const file = path.join(ctx.project.baseDir, 'lib/shared.ts');\n  if (!(await addExport(ctx, file, name, code))) return false;\n\n  await ctx.source(file, (source) =>\n    addImport(source, { from: 'fumadocs-core/source', named: ['createGetUrl'] }),\n  );\n  // a second pass, so the import lands after the one above instead of before it\n  if (ctx.project.i18n) {\n    await ctx.source(file, (source) => addImport(source, { from: './i18n', named: ['i18n'] }));\n  }\n  return true;\n}\n\n/** the value of a route constant in `lib/shared.ts`, defined with `value` when missing */\nexport async function sharedRoute(ctx: FeatureContext, name: string, value: string) {\n  const file = path.join(ctx.project.baseDir, 'lib/shared.ts');\n  const current = await fs.readFile(path.join(ctx.project.cwd, file), 'utf-8').catch(() => '');\n  const existing = new RegExp(`export const ${name}\\\\s*=\\\\s*['\"]([^'\"]*)['\"]`).exec(current)?.[1];\n  if (existing !== undefined) return existing;\n  // keep a blank line after the declarations already in the file\n  const separator = current.trimEnd().endsWith(';') || current.length === 0 ? '' : '\\n';\n  await ctx.append(file, [`${separator}export const ${name} = '${value}';`]);\n  return value;\n}\n\n/** add routes to `routes.ts`, or tell the user when the config isn't an array (e.g. file-based routes) */\nexport async function registerReactRouterRoutes(\n  ctx: FeatureContext,\n  routes: (FormattedRoute | string)[],\n): Promise<boolean> {\n  const { baseDir } = ctx.project;\n  const entries = routes.map((item) =>\n    typeof item === 'string' ? item : { path: item.path, entry: item.file },\n  );\n  let added = false;\n  const edited = await ctx.source(path.join(baseDir, 'routes.ts'), (file) => {\n    const first = entries[0];\n    if (file.code.includes(typeof first === 'string' ? first : first.entry)) {\n      added = true;\n      return;\n    }\n    added = addReactRouterRoute(file, entries);\n  });\n\n  if (!edited || !added) {\n    const list = entries.map((item) =>\n      typeof item === 'string' ? item : `route('${item.path}', '${item.entry}')`,\n    );\n    ctx.note(`Register the routes in your route config:\\n  ${list.join('\\n  ')}`);\n  }\n  return added;\n}\n\n/** features reading page Markdown need Fumadocs MDX collections, or a runtime source exposing `page.data.content` */\nexport const requiresMarkdown = (project: Project) =>\n  project.framework === 'astro'\n    ? 'Astro is not supported by this feature'\n    : project.source.collections !== null ||\n      project.source.dynamic ||\n      'requires Fumadocs MDX or a runtime content source';\n\n/** how generated code refers to the loader of `lib/source.ts` */\nexport interface SourceRef {\n  /** resolved on demand, `lib/source.ts` exports `getSource()` instead of `source` */\n  dynamic: boolean;\n  /** passed to Fumadocs APIs, which accept a loader or a function resolving one */\n  ref: string;\n  /** reads the loader inside an async function */\n  resolved: string;\n}\n\nexport function sourceRef(dynamic: boolean): SourceRef {\n  return dynamic\n    ? { dynamic: true, ref: 'getSource', resolved: '(await getSource())' }\n    : { dynamic: false, ref: 'source', resolved: 'source' };\n}\n"],"mappings":";;;;;AAQA,eAAsB,WACpB,KACA,KACA,QACA,cAAyC,MACzC;CACA,MAAM,UAAU,MAAM,GACnB,QAAQ,KAAK,KAAK,KAAK,GAAG,GAAG;EAAE,WAAW;EAAM,eAAe;CAAK,CAAC,CAAC,CACtE,YAAY,CAAC,CAAC;CACjB,MAAM,SAAS,QAAgB,IAAI,MAAM,KAAK,GAAG,CAAC,CAAC;CACnD,QAAQ,MAAM,GAAG,MAAM,MAAM,EAAE,UAAU,IAAI,MAAM,EAAE,UAAU,CAAC;CAEhE,KAAK,MAAM,SAAS,SAAS;EAC3B,IAAI,CAAC,MAAM,OAAO,KAAK,CAAC,UAAU,KAAK,MAAM,IAAI,KAAK,MAAM,WAAW,SAAS,cAAc,GAC5F;EACF,MAAM,OAAO,KAAK,KAAK,MAAM,YAAY,MAAM,IAAI;EACnD,IAAI,CAAC,MAAM,IAAI,GAAG;EAClB,KAAK,MAAM,GAAG,SAAS,MAAM,OAAO,EAAA,CAAG,SAAS,MAAM,GAAG,OAAO,KAAK,SAAS,KAAK,IAAI;CACzF;AACF;AAEA,SAAgB,QAAQ,MAAmB,SAAiC;CAC1E,OAAO,OAAQ,KAAK,YAAY,CAAC,GAAI,OAAO;AAC9C;AAEA,MAAa,aAAa,YACxB,QAAQ,cAAc,WAAW;AAEnC,SAAgB,eAAe,SAAkC;CAC/D,IAAI,QAAQ,cAAc,SAAS,MAAM,IAAI,MAAM,wCAAwC;CAC3F,OAAO,QAAQ;AACjB;;AAGA,MAAa,SAAS,SAAiB,KAAK,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,GAAG;;AAGpE,eAAsB,UAAU,KAAqB,MAAc,MAAc,MAAc;CAC7F,MAAM,UAAU,MAAM,GAAG,SAAS,KAAK,KAAK,IAAI,QAAQ,KAAK,IAAI,GAAG,OAAO,CAAC,CAAC,YAAY,EAAE;CAC3F,IAAI,IAAI,OAAO,oCAAoC,KAAK,IAAI,CAAC,CAAC,KAAK,OAAO,GAAG,OAAO;CACpF,MAAM,IAAI,OAAO,MAAM,CAAC,IAAI,CAAC;CAC7B,OAAO;AACT;;AAGA,eAAsB,WAAW,KAAqB,MAAc,MAAc;CAChF,MAAM,OAAO,KAAK,KAAK,IAAI,QAAQ,SAAS,eAAe;CAC3D,IAAI,CAAE,MAAM,UAAU,KAAK,MAAM,MAAM,IAAI,GAAI,OAAO;CAEtD,MAAM,IAAI,OAAO,OAAO,WACtB,UAAU,QAAQ;EAAE,MAAM;EAAwB,OAAO,CAAC,cAAc;CAAE,CAAC,CAC7E;CAEA,IAAI,IAAI,QAAQ,MACd,MAAM,IAAI,OAAO,OAAO,WAAW,UAAU,QAAQ;EAAE,MAAM;EAAU,OAAO,CAAC,MAAM;CAAE,CAAC,CAAC;CAE3F,OAAO;AACT;;AAGA,eAAsB,YAAY,KAAqB,MAAc,OAAe;CAClF,MAAM,OAAO,KAAK,KAAK,IAAI,QAAQ,SAAS,eAAe;CAC3D,MAAM,UAAU,MAAM,GAAG,SAAS,KAAK,KAAK,IAAI,QAAQ,KAAK,IAAI,GAAG,OAAO,CAAC,CAAC,YAAY,EAAE;CAC3F,MAAM,WAAW,IAAI,OAAO,gBAAgB,KAAK,0BAA0B,CAAC,CAAC,KAAK,OAAO,CAAC,GAAG;CAC7F,IAAI,aAAa,KAAA,GAAW,OAAO;CAEnC,MAAM,YAAY,QAAQ,QAAQ,CAAC,CAAC,SAAS,GAAG,KAAK,QAAQ,WAAW,IAAI,KAAK;CACjF,MAAM,IAAI,OAAO,MAAM,CAAC,GAAG,UAAU,eAAe,KAAK,MAAM,MAAM,GAAG,CAAC;CACzE,OAAO;AACT;;AAGA,eAAsB,0BACpB,KACA,QACkB;CAClB,MAAM,EAAE,YAAY,IAAI;CACxB,MAAM,UAAU,OAAO,KAAK,SAC1B,OAAO,SAAS,WAAW,OAAO;EAAE,MAAM,KAAK;EAAM,OAAO,KAAK;CAAK,CACxE;CACA,IAAI,QAAQ;CAUZ,IAAI,CAAC,MATgB,IAAI,OAAO,KAAK,KAAK,SAAS,WAAW,IAAI,SAAS;EACzE,MAAM,QAAQ,QAAQ;EACtB,IAAI,KAAK,KAAK,SAAS,OAAO,UAAU,WAAW,QAAQ,MAAM,KAAK,GAAG;GACvE,QAAQ;GACR;EACF;EACA,QAAQ,oBAAoB,MAAM,OAAO;CAC3C,CAAC,KAEc,CAAC,OAAO;EACrB,MAAM,OAAO,QAAQ,KAAK,SACxB,OAAO,SAAS,WAAW,OAAO,UAAU,KAAK,KAAK,MAAM,KAAK,MAAM,GACzE;EACA,IAAI,KAAK,gDAAgD,KAAK,KAAK,MAAM,GAAG;CAC9E;CACA,OAAO;AACT;;AAGA,MAAa,oBAAoB,YAC/B,QAAQ,cAAc,UAClB,2CACA,QAAQ,OAAO,gBAAgB,QAC/B,QAAQ,OAAO,WACf;AAYN,SAAgB,UAAU,SAA6B;CACrD,OAAO,UACH;EAAE,SAAS;EAAM,KAAK;EAAa,UAAU;CAAsB,IACnE;EAAE,SAAS;EAAO,KAAK;EAAU,UAAU;CAAS;AAC1D"}