@farming-labs/next 0.2.104 → 0.2.106

package/dist/index.d.mts

@@ -0,0 +1,5 @@
+import { buildNextOpenApiDocument, createNextApiReference, createNextApiReferenceLayout, createNextApiReferencePage, getNextApiReferenceMode, getNextApiReferenceSourceState, resolveApiReferenceConfig, withNextApiReferenceBanner } from "./api-reference.mjs";
+import { createDocsAPI, createDocsMCPAPI } from "./api.mjs";
+import { GeneratedChangelogEntry, createNextChangelogEntryMetadata, createNextChangelogEntryPage, createNextChangelogIndexMetadata, createNextChangelogIndexPage, createNextChangelogStaticParams } from "./changelog.mjs";
+import { withDocs } from "./config.mjs";
+export { type GeneratedChangelogEntry, buildNextOpenApiDocument, createDocsAPI, createDocsMCPAPI, createNextApiReference, createNextApiReferenceLayout, createNextApiReferencePage, createNextChangelogEntryMetadata, createNextChangelogEntryPage, createNextChangelogIndexMetadata, createNextChangelogIndexPage, createNextChangelogStaticParams, getNextApiReferenceMode, getNextApiReferenceSourceState, resolveApiReferenceConfig, withDocs, withNextApiReferenceBanner };

package/dist/index.mjs

@@ -0,0 +1,6 @@
+import { withDocs } from "./config.mjs";
+import { createDocsAPI, createDocsMCPAPI } from "./api.mjs";
+import { buildNextOpenApiDocument, createNextApiReference, createNextApiReferenceLayout, createNextApiReferencePage, getNextApiReferenceMode, getNextApiReferenceSourceState, resolveApiReferenceConfig, withNextApiReferenceBanner } from "./api-reference.mjs";
+import { createNextChangelogEntryMetadata, createNextChangelogEntryPage, createNextChangelogIndexMetadata, createNextChangelogIndexPage, createNextChangelogStaticParams } from "./changelog.mjs";
+
+export { buildNextOpenApiDocument, createDocsAPI, createDocsMCPAPI, createNextApiReference, createNextApiReferenceLayout, createNextApiReferencePage, createNextChangelogEntryMetadata, createNextChangelogEntryPage, createNextChangelogIndexMetadata, createNextChangelogIndexPage, createNextChangelogStaticParams, getNextApiReferenceMode, getNextApiReferenceSourceState, resolveApiReferenceConfig, withDocs, withNextApiReferenceBanner };

package/dist/layout.d.mts

@@ -0,0 +1,12 @@
+import { DocsConfig } from "@farming-labs/docs";
+import * as react_jsx_runtime0 from "react/jsx-runtime";
+
+//#region src/layout.d.ts
+declare function createNextDocsMetadata(config: DocsConfig): Record<string, unknown>;
+declare function createNextDocsLayout(config: DocsConfig): ({
+  children
+}: {
+  children: React.ReactNode;
+}) => react_jsx_runtime0.JSX.Element;
+//#endregion
+export { createNextDocsLayout, createNextDocsMetadata };

package/dist/layout.mjs

@@ -0,0 +1,94 @@
+import DocsClientCallbacks from "./client-callbacks.mjs";
+import { withNextApiReferenceBanner } from "./api-reference.mjs";
+import { emitDocsTelemetryProjectEvent } from "@farming-labs/docs";
+import { Fragment, jsx, jsxs } from "react/jsx-runtime";
+import { createDocsLayout, createDocsMetadata } from "@farming-labs/theme";
+import { DocsCloudAnalytics } from "@farming-labs/docs/client/react";
+
+//#region src/layout.tsx
+const DOCS_CLOUD_PROJECT_ID_ENVS = [
+	"NEXT_PUBLIC_DOCS_CLOUD_PROJECT_ID",
+	"PUBLIC_DOCS_CLOUD_PROJECT_ID",
+	"DOCS_CLOUD_PROJECT_ID"
+];
+const DOCS_CLOUD_ANALYTICS_ENDPOINT_ENVS = [
+	"NEXT_PUBLIC_DOCS_CLOUD_ANALYTICS_ENDPOINT",
+	"PUBLIC_DOCS_CLOUD_ANALYTICS_ENDPOINT",
+	"DOCS_CLOUD_ANALYTICS_ENDPOINT"
+];
+const DOCS_CLOUD_ANALYTICS_ROUTE_ENVS = [
+	"NEXT_PUBLIC_DOCS_CLOUD_ANALYTICS_ROUTE",
+	"PUBLIC_DOCS_CLOUD_ANALYTICS_ROUTE",
+	"DOCS_CLOUD_ANALYTICS_ROUTE"
+];
+const DOCS_CLOUD_ANALYTICS_ENABLED_ENVS = [
+	"NEXT_PUBLIC_DOCS_CLOUD_ANALYTICS_ENABLED",
+	"PUBLIC_DOCS_CLOUD_ANALYTICS_ENABLED",
+	"DOCS_CLOUD_ANALYTICS_ENABLED"
+];
+const DEFAULT_DOCS_CLOUD_ANALYTICS_ROUTE = "/api/docs?action=analytics";
+function normalizeEnvValue(value) {
+	const normalized = value?.trim();
+	return normalized ? normalized : void 0;
+}
+function readFirstEnv(names) {
+	for (const name of names) {
+		const value = normalizeEnvValue(process.env[name]);
+		if (value) return value;
+	}
+}
+function isFalsyEnv(value) {
+	return /^(0|false|no|off)$/i.test(value ?? "");
+}
+function withAnalyticsAction(route) {
+	try {
+		const url = new URL(route, "https://docs.local");
+		if (!url.searchParams.has("action")) url.searchParams.set("action", "analytics");
+		return route.startsWith("http://") || route.startsWith("https://") ? url.toString() : `${url.pathname}${url.search}${url.hash}`;
+	} catch {
+		const hashIndex = route.indexOf("#");
+		const pathAndQuery = hashIndex >= 0 ? route.slice(0, hashIndex) : route;
+		const hash = hashIndex >= 0 ? route.slice(hashIndex + 1) : "";
+		return `${pathAndQuery}${pathAndQuery.includes("?") ? "&" : "?"}action=analytics${hash ? `#${hash}` : ""}`;
+	}
+}
+function normalizeRoute(value) {
+	const normalized = normalizeEnvValue(value);
+	if (!normalized) return void 0;
+	if (normalized.startsWith("http://") || normalized.startsWith("https://")) return withAnalyticsAction(normalized);
+	return withAnalyticsAction(`/${normalized}`.replace(/\/+/g, "/"));
+}
+function resolveNextDocsCloudClientOptions(config) {
+	const analytics = config.analytics;
+	if (analytics === false || analytics && typeof analytics === "object" && (analytics.enabled === false || analytics.cloud === false)) return false;
+	if (isFalsyEnv(readFirstEnv(DOCS_CLOUD_ANALYTICS_ENABLED_ENVS))) return false;
+	const projectId = readFirstEnv(DOCS_CLOUD_PROJECT_ID_ENVS);
+	if (!projectId) return void 0;
+	const endpoint = readFirstEnv(DOCS_CLOUD_ANALYTICS_ENDPOINT_ENVS);
+	const route = normalizeRoute(readFirstEnv(DOCS_CLOUD_ANALYTICS_ROUTE_ENVS)) ?? normalizeRoute(config.cloud?.apiRoute);
+	const includeInputs = typeof analytics === "object" && analytics.includeInputs === true;
+	return {
+		projectId,
+		endpoint: endpoint ?? route ?? DEFAULT_DOCS_CLOUD_ANALYTICS_ROUTE,
+		includeInputs,
+		metadata: { framework: "next" }
+	};
+}
+function createNextDocsMetadata(config) {
+	return createDocsMetadata(config);
+}
+function createNextDocsLayout(config) {
+	emitDocsTelemetryProjectEvent(config, { framework: "next" });
+	const DocsLayout = createDocsLayout(withNextApiReferenceBanner(config));
+	return function NextDocsLayout({ children }) {
+		const docsCloud = resolveNextDocsCloudClientOptions(config);
+		return /* @__PURE__ */ jsxs(Fragment, { children: [
+			docsCloud ? /* @__PURE__ */ jsx(DocsCloudAnalytics, { ...docsCloud }) : null,
+			/* @__PURE__ */ jsx(DocsClientCallbacks, { docsCloudEnabled: Boolean(docsCloud) }),
+			/* @__PURE__ */ jsx(DocsLayout, { children })
+		] });
+	};
+}
+
+//#endregion
+export { createNextDocsLayout, createNextDocsMetadata };

package/dist/mdx-plugins/rehype-code.d.mts

@@ -0,0 +1,2 @@
+import { rehypeCode as rehype_code_default } from "fumadocs-core/mdx-plugins/rehype-code";
+export { rehype_code_default as default };

package/dist/mdx-plugins/rehype-code.mjs

@@ -0,0 +1,3 @@
+import { rehypeCode as rehype_code_default } from "fumadocs-core/mdx-plugins/rehype-code";
+
+export { rehype_code_default as default };

package/dist/mdx-plugins/rehype-toc.d.mts

@@ -0,0 +1,2 @@
+import { rehypeToc as rehype_toc_default } from "fumadocs-core/mdx-plugins/rehype-toc";
+export { rehype_toc_default as default };

package/dist/mdx-plugins/rehype-toc.mjs

@@ -0,0 +1,3 @@
+import { rehypeToc as rehype_toc_default } from "fumadocs-core/mdx-plugins/rehype-toc";
+
+export { rehype_toc_default as default };

package/dist/mdx-plugins/remark-code-group.d.mts

@@ -0,0 +1,2 @@
+import { remarkCodeGroup as server_default } from "@farming-labs/docs/server";
+export { server_default as default };

package/dist/mdx-plugins/remark-code-group.mjs

@@ -0,0 +1,3 @@
+import { remarkCodeGroup as server_default } from "@farming-labs/docs/server";
+
+export { server_default as default };

package/dist/mdx-plugins/remark-heading.d.mts

@@ -0,0 +1,6 @@
+import { remarkHeading as remarkHeading$1 } from "fumadocs-core/mdx-plugins/remark-heading";
+
+//#region src/mdx-plugins/remark-heading.d.ts
+declare function remarkHeading(options?: Parameters<typeof remarkHeading$1>[0]): ReturnType<typeof remarkHeading$1>;
+//#endregion
+export { remarkHeading as default };

package/dist/mdx-plugins/remark-heading.mjs

@@ -0,0 +1,28 @@
+import { applyDocsMarkdownHeadingAnchors, encodeDocsHeadingTocUrls, isolateDocsMarkdownPromptReferences, withDocsMarkdownRenderableHeadings } from "@farming-labs/docs";
+import { remarkHeading as remarkHeading$1 } from "fumadocs-core/mdx-plugins/remark-heading";
+
+//#region src/mdx-plugins/remark-heading.ts
+function remarkHeading(options = {}) {
+	if (options.slug) {
+		const customRemarkHeading = remarkHeading$1(options);
+		return (root, file) => {
+			isolateDocsMarkdownPromptReferences(root, file.value);
+			const result = withDocsMarkdownRenderableHeadings(root, () => customRemarkHeading(root, file, () => void 0));
+			encodeDocsHeadingTocUrls(file.data.toc);
+			return result;
+		};
+	}
+	return (root, file) => {
+		isolateDocsMarkdownPromptReferences(root, file.value);
+		applyDocsMarkdownHeadingAnchors(root, { customId: options.customId });
+		withDocsMarkdownRenderableHeadings(root, () => remarkHeading$1({
+			...options,
+			customId: false
+		})(root, file, () => void 0));
+		encodeDocsHeadingTocUrls(file.data.toc);
+		return root;
+	};
+}
+
+//#endregion
+export { remarkHeading as default };

package/dist/mdx-plugins/remark-markdown-alternate.d.mts

@@ -0,0 +1,21 @@
+//#region src/mdx-plugins/remark-markdown-alternate.d.ts
+interface RemarkMarkdownAlternateOptions {
+  entry?: string;
+  appDir?: string;
+  contentDir?: string;
+  docsPath?: string;
+  enabled?: boolean;
+}
+interface MarkdownNode {
+  type: string;
+  value?: string;
+}
+interface VFileLike {
+  path?: string;
+  history?: string[];
+}
+declare function remarkMarkdownAlternate(options?: RemarkMarkdownAlternateOptions): (tree: {
+  children: MarkdownNode[];
+}, file?: VFileLike) => void;
+//#endregion
+export { remarkMarkdownAlternate as default };

package/dist/mdx-plugins/remark-markdown-alternate.mjs

@@ -0,0 +1,78 @@
+import { toDocsMarkdownUrl } from "@farming-labs/docs";
+
+//#region src/mdx-plugins/remark-markdown-alternate.ts
+function normalizePath(value) {
+	return value.replace(/\\/g, "/").replace(/\/+/g, "/");
+}
+function normalizeSegment(value, fallback) {
+	return (value ?? fallback).replace(/^\/+|\/+$/g, "") || fallback;
+}
+function normalizeDocsPath(value, entry) {
+	if (typeof value !== "string") return `/${entry}`;
+	const cleaned = value.trim().replace(/^\/+|\/+$/g, "").replace(/\/+/g, "/");
+	if (cleaned === "") return "";
+	return `/${cleaned}`;
+}
+function joinDocsPath(docsPath, slug) {
+	if (!slug) return docsPath || "/";
+	return docsPath ? `${docsPath}/${slug}` : `/${slug}`;
+}
+function escapeYamlString(value) {
+	return value.replace(/\\/g, "\\\\").replace(/"/g, "\\\"");
+}
+function routeFromSourcePath(filePath, options) {
+	const normalized = `/${normalizePath(filePath).replace(/^\/+/, "")}`;
+	if (!/\/page\.mdx?$/.test(normalized)) return null;
+	const entry = normalizeSegment(options.entry, "docs");
+	const candidates = [
+		options.contentDir,
+		options.appDir ? `${options.appDir}/${entry}` : void 0,
+		`src/app/${entry}`,
+		`app/${entry}`
+	].filter((candidate) => typeof candidate === "string" && candidate.length > 0).map((candidate) => normalizePath(candidate).replace(/^\/+|\/+$/g, ""));
+	for (const candidate of candidates) {
+		const marker = `/${candidate}/`;
+		const markerIndex = normalized.lastIndexOf(marker);
+		if (markerIndex === -1) continue;
+		const relativePath = normalized.slice(markerIndex + marker.length);
+		if (!relativePath.endsWith("page.mdx") && !relativePath.endsWith("page.md")) continue;
+		const slug = relativePath.replace(/\/?page\.mdx?$/, "").replace(/^\/+|\/+$/g, "");
+		return joinDocsPath(normalizeDocsPath(options.docsPath, entry), slug);
+	}
+	return null;
+}
+function getFilePath(file) {
+	return file?.path ?? file?.history?.[0];
+}
+function hasAlternates(yaml) {
+	return /^\s*alternates\s*:/m.test(yaml);
+}
+function alternateYaml(url) {
+	return [
+		"alternates:",
+		"  types:",
+		`    text/markdown: "${escapeYamlString(url === "/" ? "/docs.md" : toDocsMarkdownUrl(url))}"`
+	].join("\n");
+}
+function remarkMarkdownAlternate(options = {}) {
+	return (tree, file) => {
+		if (options.enabled === false) return;
+		const filePath = getFilePath(file);
+		if (!filePath) return;
+		const route = routeFromSourcePath(filePath, options);
+		if (!route) return;
+		const yamlNode = tree.children.find((node) => node.type === "yaml");
+		if (yamlNode?.value) {
+			if (hasAlternates(yamlNode.value)) return;
+			yamlNode.value += `\n${alternateYaml(route)}`;
+			return;
+		}
+		tree.children.unshift({
+			type: "yaml",
+			value: alternateYaml(route)
+		});
+	};
+}
+
+//#endregion
+export { remarkMarkdownAlternate as default };

package/dist/mdx-plugins/remark-og.d.mts

@@ -0,0 +1,22 @@
+//#region src/mdx-plugins/remark-og.d.ts
+/**
+ * Remark plugin that augments frontmatter with Open Graph metadata.
+ *
+ * Runs between remark-frontmatter and remark-mdx-frontmatter.
+ * Reads title/description from the YAML node and appends openGraph + twitter
+ * fields so that remark-mdx-frontmatter exports them as part of `metadata`.
+ *
+ * Skips injection when frontmatter already has `openGraph:` or `ogImage:`, so
+ * pages can use static OG images from frontmatter instead of the dynamic endpoint.
+ */
+interface RemarkOgOptions {
+  endpoint?: string;
+}
+declare function remarkOg(options?: RemarkOgOptions): (tree: {
+  children: Array<{
+    type: string;
+    value: string;
+  }>;
+}) => void;
+//#endregion
+export { remarkOg as default };

package/dist/mdx-plugins/remark-og.mjs

@@ -0,0 +1,30 @@
+//#region src/mdx-plugins/remark-og.ts
+function extractField(yaml, key) {
+	const re = new RegExp(`^${key}:\\s*(?:"([^"]*?)"|'([^']*?)'|(.+?))\\s*$`, "m");
+	const m = yaml.match(re);
+	return m?.[1] ?? m?.[2] ?? m?.[3];
+}
+/** True if the YAML already defines openGraph or ogImage (static OG). */
+function hasStaticOg(yaml) {
+	return /^\s*openGraph\s*:/m.test(yaml) || /^\s*ogImage\s*:/m.test(yaml);
+}
+function remarkOg(options = {}) {
+	const { endpoint = "/api/og" } = options;
+	return (tree) => {
+		const yamlNode = tree.children.find((n) => n.type === "yaml");
+		if (!yamlNode) return;
+		if (hasStaticOg(yamlNode.value)) return;
+		const title = extractField(yamlNode.value, "title");
+		if (!title) return;
+		const description = extractField(yamlNode.value, "description");
+		const params = new URLSearchParams({ title });
+		if (description) params.set("description", description);
+		const ogUrl = `${endpoint}?${params.toString()}`;
+		yamlNode.value += `
+openGraph:
+  images:\n    - url: "${ogUrl}"\n      width: 1200\n      height: 630\ntwitter:\n  card: "summary_large_image"\n  images:\n    - "${ogUrl}"`;
+	};
+}
+
+//#endregion
+export { remarkOg as default };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farming-labs/next",
-  "version": "0.2.104",
+  "version": "0.2.106",
   "description": "Next.js adapter for @farming-labs/docs — MDX config wrapper",
   "keywords": [
     "docs",
@@ -109,8 +109,8 @@
     "tsdown": "^0.20.3",
     "typescript": "^5.9.3",
     "vitest": "^4.1.8",
-    "@farming-labs/docs": "0.2.104",
-    "@farming-labs/theme": "0.2.104"
+    "@farming-labs/docs": "0.2.106",
+    "@farming-labs/theme": "0.2.106"
   },
   "peerDependencies": {
     "@farming-labs/docs": ">=0.2.73",