@farming-labs/theme 0.2.121 → 0.2.123
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/docs-api.mjs +270 -373
- package/dist/docs-layout.mjs +10 -12
- package/dist/docs-page-client.d.mts +4 -0
- package/dist/docs-page-client.mjs +8 -6
- package/dist/page-metadata.d.mts +10 -0
- package/dist/page-metadata.mjs +81 -0
- package/package.json +2 -2
package/dist/docs-api.mjs
CHANGED
|
@@ -3,7 +3,7 @@ import { getNextAppDir } from "./get-app-dir.mjs";
|
|
|
3
3
|
import { BoundedRouteCache } from "./bounded-route-cache.mjs";
|
|
4
4
|
import fs from "node:fs";
|
|
5
5
|
import path from "node:path";
|
|
6
|
-
import { DEFAULT_A2A_AGENT_CARD_ROUTE, DEFAULT_AGENT_SKILLS_ARCHIVE_ROUTE_PATTERN, DEFAULT_AGENT_SKILLS_INDEX_ROUTE, DEFAULT_AGENT_SKILLS_ROUTE_PREFIX, DEFAULT_API_CATALOG_ROUTE, DEFAULT_LEGACY_SKILLS_INDEX_ROUTE, DEFAULT_SITEMAP_MD_DOCS_ROUTE, DOCS_AGENT_MANIFEST_FORMAT, DOCS_AGENT_MANIFEST_SCHEMA_URI, DOCS_AGENT_MANIFEST_VERSION, DOCS_CONTENT_CHANGES_FORMAT, DOCS_CONTENT_CHANGES_RESPONSE_VALUE, DOCS_MARKDOWN_SECTION_INDEX_FORMAT, acceptsDocsMarkdown, buildDocsAskAIContext, buildDocsConfigMap, buildDocsDiagnostics, buildDocsSearchFacets, compactDocsAgentDiscoverySpec, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsCacheableResponse, createDocsContentChangeFeed, createDocsContentChangesHttpResponse, createDocsMarkdownResponse, createDocsRobotsResponse, createDocsSitemapResponse, createDocsStandardsDiscoveryResponse, detectDocsMarkdownAgentRequest, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsTelemetryAgentSurfaceEvent, emitDocsTelemetryProjectEvent, formatDocsAskAIPackageHints, getDocsAgentManifestLinkHeader, getDocsDiscoveryLinkHeader, getDocsLlmsTxtMaxCharsIssue, getDocsMcpProtectedResourceMetadataRoutes, hasDocsMarkdownSignatureAgent, inferDocsTelemetryAgentSurface, isDocsConfigRequest, isDocsContentChangesRequest, isDocsDiagnosticsRequest, normalizeDocsOkfTrustMetadataInput, normalizeDocsRelated, normalizePageAgentFrontmatter, parseDocsAgentFeedbackData, performDocsSearch, performDocsSearchWithMetadata, readDocsJsonBody, renderDocsLlmsTxt, renderDocsMarkdownDocument, resolveAskAISearchRequestConfig, resolveChangelogConfig, resolveDocsAgentContractMcpTools, resolveDocsAudienceMdxContent, resolveDocsContentChangesConfig, resolveDocsI18n, resolveDocsLlmsTxtRequest, resolveDocsLlmsTxtSections, resolveDocsLocale, resolveDocsMetadataBaseUrl, resolveDocsPublishedAgentSkill, resolveDocsRequestApiRoute, resolveDocsRetrievalLastModified, resolveDocsSearchAudience, resolveDocsSearchError, resolveDocsSearchRequest, resolveDocsSitemapConfig,
|
|
6
|
+
import { DEFAULT_A2A_AGENT_CARD_ROUTE, DEFAULT_AGENT_SKILLS_ARCHIVE_ROUTE_PATTERN, DEFAULT_AGENT_SKILLS_INDEX_ROUTE, DEFAULT_AGENT_SKILLS_ROUTE_PREFIX, DEFAULT_API_CATALOG_ROUTE, DEFAULT_LEGACY_SKILLS_INDEX_ROUTE, DEFAULT_SITEMAP_MD_DOCS_ROUTE, DOCS_AGENT_MANIFEST_FORMAT, DOCS_AGENT_MANIFEST_SCHEMA_URI, DOCS_AGENT_MANIFEST_VERSION, DOCS_CONTENT_CHANGES_FORMAT, DOCS_CONTENT_CHANGES_RESPONSE_VALUE, DOCS_MARKDOWN_SECTION_INDEX_FORMAT, acceptsDocsMarkdown, buildDocsAskAIContext, buildDocsConfigMap, buildDocsDiagnostics, buildDocsSearchFacets, compactDocsAgentDiscoverySpec, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsCacheableResponse, createDocsContentChangeFeed, createDocsContentChangesHttpResponse, createDocsMarkdownResponse, createDocsRobotsResponse, createDocsSitemapLastmodResolver, createDocsSitemapResponse, createDocsStandardsDiscoveryResponse, detectDocsMarkdownAgentRequest, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsTelemetryAgentSurfaceEvent, emitDocsTelemetryProjectEvent, formatDocsAskAIPackageHints, getDocsAgentManifestLinkHeader, getDocsDiscoveryLinkHeader, getDocsLlmsTxtMaxCharsIssue, getDocsMcpProtectedResourceMetadataRoutes, hasDocsMarkdownSignatureAgent, inferDocsTelemetryAgentSurface, isDocsConfigRequest, isDocsContentChangesRequest, isDocsDiagnosticsRequest, normalizeDocsOkfTrustMetadataInput, normalizeDocsRelated, normalizePageAgentFrontmatter, parseDocsAgentFeedbackData, performDocsSearch, performDocsSearchWithMetadata, readDocsJsonBody, renderDocsLlmsTxt, renderDocsMarkdownDocument, resolveAskAISearchRequestConfig, resolveChangelogConfig, resolveDocsAgentContractMcpTools, resolveDocsAudienceMdxContent, resolveDocsContentChangesConfig, resolveDocsI18n, resolveDocsLlmsTxtRequest, resolveDocsLlmsTxtSections, resolveDocsLocale, resolveDocsMetadataBaseUrl, resolveDocsPublishedAgentSkill, resolveDocsRequestApiRoute, resolveDocsRetrievalLastModified, resolveDocsSearchAudience, resolveDocsSearchError, resolveDocsSearchRequest, resolveDocsSitemapConfig, resolveDocsStandardsDiscoveryRequest, resolvePageSidebarFolderIndexBehavior, resolveSearchRequestConfig, selectDocsLlmsTxtContent, stripGeneratedAgentProvenance, withDocsOpenApiOperationCounts } from "@farming-labs/docs";
|
|
7
7
|
import { buildApiReferenceOpenApiDocumentAsync, buildApiReferenceOperationPagesAsync, createApiReferenceOperationMarkdownResponse, createDocsMcpHttpHandler, createFilesystemDocsMcpSource, readDocsSitemapManifest, resolveApiReferenceConfig, resolveApiReferenceOpenApiDiscovery, resolveConfiguredAgentSkills, resolveDocsMcpConfig } from "@farming-labs/docs/runtime";
|
|
8
8
|
import matter from "gray-matter";
|
|
9
9
|
|
|
@@ -35,6 +35,35 @@ const FILE_EXTS = [
|
|
|
35
35
|
"jsx",
|
|
36
36
|
"js"
|
|
37
37
|
];
|
|
38
|
+
/** One lazy filesystem snapshot per handler factory, including missing/unreadable files. */
|
|
39
|
+
function createDocsConfigReader(root) {
|
|
40
|
+
const files = /* @__PURE__ */ new Map();
|
|
41
|
+
return (extension) => {
|
|
42
|
+
let result = files.get(extension);
|
|
43
|
+
if (!result) {
|
|
44
|
+
const configPath = path.join(
|
|
45
|
+
/* turbopackIgnore: true */
|
|
46
|
+
root,
|
|
47
|
+
`docs.config.${extension}`
|
|
48
|
+
);
|
|
49
|
+
try {
|
|
50
|
+
result = { content: fs.existsSync(
|
|
51
|
+
/* turbopackIgnore: true */
|
|
52
|
+
configPath
|
|
53
|
+
) ? fs.readFileSync(
|
|
54
|
+
/* turbopackIgnore: true */
|
|
55
|
+
configPath,
|
|
56
|
+
"utf-8"
|
|
57
|
+
) : void 0 };
|
|
58
|
+
} catch (error) {
|
|
59
|
+
result = { error };
|
|
60
|
+
}
|
|
61
|
+
files.set(extension, result);
|
|
62
|
+
}
|
|
63
|
+
if ("error" in result) throw result.error;
|
|
64
|
+
return result.content;
|
|
65
|
+
};
|
|
66
|
+
}
|
|
38
67
|
const DEFAULT_DOCS_API_ROUTE = "/api/docs";
|
|
39
68
|
const MAX_LLMS_CACHE_ROUTES_PER_LOCALE = 8;
|
|
40
69
|
const DEFAULT_DOCS_CLOUD_API_BASE_URL = "https://api.farming-labs.dev";
|
|
@@ -46,8 +75,8 @@ const DEFAULT_MCP_PUBLIC_ROUTE = "/mcp";
|
|
|
46
75
|
const DEFAULT_MCP_WELL_KNOWN_ROUTE = "/.well-known/mcp";
|
|
47
76
|
const DEFAULT_LLMS_TXT_ROUTE = "/llms.txt";
|
|
48
77
|
const DEFAULT_LLMS_FULL_TXT_ROUTE = "/llms-full.txt";
|
|
49
|
-
function withSitemapLastModified(page,
|
|
50
|
-
const lastmod =
|
|
78
|
+
function withSitemapLastModified(page, resolveLastmod) {
|
|
79
|
+
const lastmod = resolveLastmod(page.url);
|
|
51
80
|
if (!lastmod) return page;
|
|
52
81
|
const lastModified = `${lastmod}T00:00:00.000Z`;
|
|
53
82
|
const hasExplicitAgentSource = page.agentRawContent !== void 0 || page.agentContent !== void 0;
|
|
@@ -629,195 +658,128 @@ function validateAgentFeedbackPayload(value, schema, valuePath = "payload") {
|
|
|
629
658
|
return;
|
|
630
659
|
}
|
|
631
660
|
}
|
|
632
|
-
function readEntry(
|
|
633
|
-
for (const ext of FILE_EXTS) {
|
|
634
|
-
const
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
if (fs.existsSync(
|
|
640
|
-
/* turbopackIgnore: true */
|
|
641
|
-
configPath
|
|
642
|
-
)) try {
|
|
643
|
-
const match = fs.readFileSync(
|
|
644
|
-
/* turbopackIgnore: true */
|
|
645
|
-
configPath,
|
|
646
|
-
"utf-8"
|
|
647
|
-
).match(/entry\s*:\s*["']([^"']+)["']/);
|
|
648
|
-
if (match) return match[1];
|
|
649
|
-
} catch {}
|
|
650
|
-
}
|
|
661
|
+
function readEntry(readConfig) {
|
|
662
|
+
for (const ext of FILE_EXTS) try {
|
|
663
|
+
const content = readConfig(ext);
|
|
664
|
+
if (content === void 0) continue;
|
|
665
|
+
const match = content.match(/entry\s*:\s*["']([^"']+)["']/);
|
|
666
|
+
if (match) return match[1];
|
|
667
|
+
} catch {}
|
|
651
668
|
return "docs";
|
|
652
669
|
}
|
|
653
|
-
function readI18nConfig(
|
|
654
|
-
for (const ext of FILE_EXTS) {
|
|
655
|
-
const
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
);
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
configPath,
|
|
668
|
-
"utf-8"
|
|
669
|
-
);
|
|
670
|
-
if (!content.includes("i18n")) continue;
|
|
671
|
-
const localesMatch = content.match(/i18n\s*:\s*\{[\s\S]*?locales\s*:\s*\[([^\]]+)\]/);
|
|
672
|
-
if (!localesMatch) continue;
|
|
673
|
-
const locales = localesMatch[1].split(",").map((l) => l.trim().replace(/^['"`]|['"`]$/g, "")).filter(Boolean);
|
|
674
|
-
if (locales.length === 0) continue;
|
|
675
|
-
return {
|
|
676
|
-
locales,
|
|
677
|
-
defaultLocale: content.match(/i18n\s*:\s*\{[\s\S]*?defaultLocale\s*:\s*["']([^"']+)["']/)?.[1]
|
|
678
|
-
};
|
|
679
|
-
} catch {}
|
|
680
|
-
}
|
|
670
|
+
function readI18nConfig(readConfig) {
|
|
671
|
+
for (const ext of FILE_EXTS) try {
|
|
672
|
+
const content = readConfig(ext);
|
|
673
|
+
if (content === void 0) continue;
|
|
674
|
+
if (!content.includes("i18n")) continue;
|
|
675
|
+
const localesMatch = content.match(/i18n\s*:\s*\{[\s\S]*?locales\s*:\s*\[([^\]]+)\]/);
|
|
676
|
+
if (!localesMatch) continue;
|
|
677
|
+
const locales = localesMatch[1].split(",").map((l) => l.trim().replace(/^['"`]|['"`]$/g, "")).filter(Boolean);
|
|
678
|
+
if (locales.length === 0) continue;
|
|
679
|
+
return {
|
|
680
|
+
locales,
|
|
681
|
+
defaultLocale: content.match(/i18n\s*:\s*\{[\s\S]*?defaultLocale\s*:\s*["']([^"']+)["']/)?.[1]
|
|
682
|
+
};
|
|
683
|
+
} catch {}
|
|
681
684
|
return null;
|
|
682
685
|
}
|
|
683
686
|
/**
|
|
684
687
|
* Read AI config from docs.config by parsing the file for the `ai` block.
|
|
685
688
|
* This avoids importing the config (which may use JSX/React).
|
|
686
689
|
*/
|
|
687
|
-
function readAIConfig(
|
|
688
|
-
for (const ext of FILE_EXTS) {
|
|
689
|
-
const
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
);
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
provider: providerMatch?.[1],
|
|
719
|
-
model: modelMatch?.[1],
|
|
720
|
-
baseUrl: baseUrlMatch?.[1],
|
|
721
|
-
apiKey: apiKeyMatch?.[1] ? process.env[apiKeyMatch[1]] : void 0,
|
|
722
|
-
maxResults: maxResultsMatch ? parseInt(maxResultsMatch[1], 10) : void 0,
|
|
723
|
-
useMcp: useMcpMatch ? useMcpMatch[1] === "true" : void 0,
|
|
724
|
-
stream: streamMatch ? streamMatch[1] === "true" : void 0,
|
|
725
|
-
systemPrompt: systemPromptMatch?.[1],
|
|
726
|
-
packageName: packageNameMatch?.[1],
|
|
727
|
-
docsUrl: docsUrlMatch?.[1]
|
|
728
|
-
};
|
|
729
|
-
} catch {}
|
|
730
|
-
}
|
|
690
|
+
function readAIConfig(readConfig) {
|
|
691
|
+
for (const ext of FILE_EXTS) try {
|
|
692
|
+
const content = readConfig(ext);
|
|
693
|
+
if (content === void 0) continue;
|
|
694
|
+
if (!content.includes("ai:") && !content.includes("ai :")) return {};
|
|
695
|
+
const enabledMatch = content.match(/ai\s*:\s*\{[^}]*enabled\s*:\s*(true|false)/s);
|
|
696
|
+
if (enabledMatch && enabledMatch[1] === "false") return {};
|
|
697
|
+
const providerMatch = content.match(/ai\s*:\s*\{[^}]*provider\s*:\s*["']([^"']+)["']/s);
|
|
698
|
+
const modelMatch = content.match(/ai\s*:\s*\{[^}]*model\s*:\s*["']([^"']+)["']/s);
|
|
699
|
+
const baseUrlMatch = content.match(/ai\s*:\s*\{[^}]*baseUrl\s*:\s*["']([^"']+)["']/s);
|
|
700
|
+
const apiKeyMatch = content.match(/ai\s*:\s*\{[^}]*apiKey\s*:\s*process\.env\.(\w+)/s);
|
|
701
|
+
const maxResultsMatch = content.match(/ai\s*:\s*\{[^}]*maxResults\s*:\s*(\d+)/s);
|
|
702
|
+
const useMcpMatch = content.match(/ai\s*:\s*\{[^}]*useMcp\s*:\s*(true|false)/s);
|
|
703
|
+
const streamMatch = content.match(/ai\s*:\s*\{[^}]*stream\s*:\s*(true|false)/s);
|
|
704
|
+
const systemPromptMatch = content.match(/ai\s*:\s*\{[^}]*systemPrompt\s*:\s*["'`]([^"'`]+)["'`]/s);
|
|
705
|
+
const packageNameMatch = content.match(/ai\s*:\s*\{[^}]*packageName\s*:\s*["'`]([^"'`]+)["'`]/s);
|
|
706
|
+
const docsUrlMatch = content.match(/ai\s*:\s*\{[^}]*docsUrl\s*:\s*["'`]([^"'`]+)["'`]/s);
|
|
707
|
+
return {
|
|
708
|
+
enabled: true,
|
|
709
|
+
provider: providerMatch?.[1],
|
|
710
|
+
model: modelMatch?.[1],
|
|
711
|
+
baseUrl: baseUrlMatch?.[1],
|
|
712
|
+
apiKey: apiKeyMatch?.[1] ? process.env[apiKeyMatch[1]] : void 0,
|
|
713
|
+
maxResults: maxResultsMatch ? parseInt(maxResultsMatch[1], 10) : void 0,
|
|
714
|
+
useMcp: useMcpMatch ? useMcpMatch[1] === "true" : void 0,
|
|
715
|
+
stream: streamMatch ? streamMatch[1] === "true" : void 0,
|
|
716
|
+
systemPrompt: systemPromptMatch?.[1],
|
|
717
|
+
packageName: packageNameMatch?.[1],
|
|
718
|
+
docsUrl: docsUrlMatch?.[1]
|
|
719
|
+
};
|
|
720
|
+
} catch {}
|
|
731
721
|
return {};
|
|
732
722
|
}
|
|
733
|
-
function readCloudConfig(
|
|
734
|
-
for (const ext of FILE_EXTS) {
|
|
735
|
-
const
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
);
|
|
740
|
-
if (!
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
)
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
const sanitized = stripCommentsAndStrings(content);
|
|
751
|
-
const configObject = extractRootConfigObject(content, sanitized);
|
|
752
|
-
const cloudBlock = extractObjectLiteral(configObject?.content ?? content, configObject?.sanitized ?? sanitized, "cloud");
|
|
753
|
-
if (!cloudBlock) continue;
|
|
754
|
-
const cloudBlockSanitized = stripCommentsAndStrings(cloudBlock);
|
|
755
|
-
const apiKeyBlock = extractObjectLiteral(cloudBlock, cloudBlockSanitized, "apiKey");
|
|
756
|
-
const apiKeyEnv = apiKeyBlock ? readStringFromBlock(apiKeyBlock, "env") : void 0;
|
|
757
|
-
const apiRoute = readTopLevelString(cloudBlock, cloudBlockSanitized, "apiRoute");
|
|
758
|
-
return {
|
|
759
|
-
...apiKeyEnv ? { apiKey: { env: apiKeyEnv } } : {},
|
|
760
|
-
...apiRoute ? { apiRoute } : {}
|
|
761
|
-
};
|
|
762
|
-
} catch {}
|
|
763
|
-
}
|
|
723
|
+
function readCloudConfig(readConfig) {
|
|
724
|
+
for (const ext of FILE_EXTS) try {
|
|
725
|
+
const content = readConfig(ext);
|
|
726
|
+
if (content === void 0) continue;
|
|
727
|
+
const sanitized = stripCommentsAndStrings(content);
|
|
728
|
+
const configObject = extractRootConfigObject(content, sanitized);
|
|
729
|
+
const cloudBlock = extractObjectLiteral(configObject?.content ?? content, configObject?.sanitized ?? sanitized, "cloud");
|
|
730
|
+
if (!cloudBlock) continue;
|
|
731
|
+
const cloudBlockSanitized = stripCommentsAndStrings(cloudBlock);
|
|
732
|
+
const apiKeyBlock = extractObjectLiteral(cloudBlock, cloudBlockSanitized, "apiKey");
|
|
733
|
+
const apiKeyEnv = apiKeyBlock ? readStringFromBlock(apiKeyBlock, "env") : void 0;
|
|
734
|
+
const apiRoute = readTopLevelString(cloudBlock, cloudBlockSanitized, "apiRoute");
|
|
735
|
+
return {
|
|
736
|
+
...apiKeyEnv ? { apiKey: { env: apiKeyEnv } } : {},
|
|
737
|
+
...apiRoute ? { apiRoute } : {}
|
|
738
|
+
};
|
|
739
|
+
} catch {}
|
|
764
740
|
}
|
|
765
741
|
const MCP_RUNTIME_SECURITY_CONFIG_ERROR = "MCP security is configured in docs.config, but createDocsMCPAPI cannot load executable security callbacks from source text. Import the live config and call createDocsMCPAPI(docsConfig), or pass an explicit mcp.security.authenticate callback. Refusing to create a public MCP endpoint.";
|
|
766
742
|
var McpRuntimeSecurityConfigError = class extends Error {};
|
|
767
|
-
function readMcpConfig(
|
|
768
|
-
for (const ext of FILE_EXTS) {
|
|
769
|
-
const
|
|
770
|
-
|
|
771
|
-
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
)
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
);
|
|
784
|
-
const sanitized = stripCommentsAndStrings(content);
|
|
785
|
-
const configObject = extractRootConfigObject(content, sanitized);
|
|
786
|
-
const scopedContent = configObject?.content ?? content;
|
|
787
|
-
const scopedSanitized = configObject?.sanitized ?? sanitized;
|
|
788
|
-
const booleanValue = readTopLevelBoolean(scopedSanitized, "mcp");
|
|
789
|
-
if (booleanValue !== void 0) return booleanValue;
|
|
790
|
-
const block = extractObjectLiteral(scopedContent, scopedSanitized, "mcp");
|
|
791
|
-
if (!block) continue;
|
|
792
|
-
if (options.rejectRuntimeSecurity) {
|
|
793
|
-
const blockSanitized = stripCommentsAndStrings(block);
|
|
794
|
-
const hasSecurity = findTopLevelPropertyIndex(blockSanitized, "security") !== -1;
|
|
795
|
-
const hasAuthenticate = findTopLevelPropertyIndex(blockSanitized, "authenticate") !== -1;
|
|
796
|
-
if (hasSecurity || hasAuthenticate) throw new McpRuntimeSecurityConfigError(MCP_RUNTIME_SECURITY_CONFIG_ERROR);
|
|
797
|
-
}
|
|
798
|
-
return {
|
|
799
|
-
enabled: readBooleanFromBlock(block, "enabled"),
|
|
800
|
-
route: readStringFromBlock(block, "route"),
|
|
801
|
-
name: readStringFromBlock(block, "name"),
|
|
802
|
-
version: readStringFromBlock(block, "version"),
|
|
803
|
-
prompts: readBooleanFromBlock(block, "prompts"),
|
|
804
|
-
tools: {
|
|
805
|
-
listDocs: readBooleanFromBlock(block, "listDocs"),
|
|
806
|
-
listPages: readBooleanFromBlock(block, "listPages"),
|
|
807
|
-
listPageSections: readBooleanFromBlock(block, "listPageSections"),
|
|
808
|
-
listTasks: readBooleanFromBlock(block, "listTasks"),
|
|
809
|
-
readTask: readBooleanFromBlock(block, "readTask"),
|
|
810
|
-
readPage: readBooleanFromBlock(block, "readPage"),
|
|
811
|
-
searchDocs: readBooleanFromBlock(block, "searchDocs"),
|
|
812
|
-
getNavigation: readBooleanFromBlock(block, "getNavigation"),
|
|
813
|
-
getCodeExamples: readBooleanFromBlock(block, "getCodeExamples"),
|
|
814
|
-
getConfigSchema: readBooleanFromBlock(block, "getConfigSchema"),
|
|
815
|
-
getContext: readBooleanFromBlock(block, "getContext")
|
|
816
|
-
}
|
|
817
|
-
};
|
|
818
|
-
} catch (error) {
|
|
819
|
-
if (error instanceof McpRuntimeSecurityConfigError) throw error;
|
|
743
|
+
function readMcpConfig(readConfig, options = {}) {
|
|
744
|
+
for (const ext of FILE_EXTS) try {
|
|
745
|
+
const content = readConfig(ext);
|
|
746
|
+
if (content === void 0) continue;
|
|
747
|
+
const sanitized = stripCommentsAndStrings(content);
|
|
748
|
+
const configObject = extractRootConfigObject(content, sanitized);
|
|
749
|
+
const scopedContent = configObject?.content ?? content;
|
|
750
|
+
const scopedSanitized = configObject?.sanitized ?? sanitized;
|
|
751
|
+
const booleanValue = readTopLevelBoolean(scopedSanitized, "mcp");
|
|
752
|
+
if (booleanValue !== void 0) return booleanValue;
|
|
753
|
+
const block = extractObjectLiteral(scopedContent, scopedSanitized, "mcp");
|
|
754
|
+
if (!block) continue;
|
|
755
|
+
if (options.rejectRuntimeSecurity) {
|
|
756
|
+
const blockSanitized = stripCommentsAndStrings(block);
|
|
757
|
+
const hasSecurity = findTopLevelPropertyIndex(blockSanitized, "security") !== -1;
|
|
758
|
+
const hasAuthenticate = findTopLevelPropertyIndex(blockSanitized, "authenticate") !== -1;
|
|
759
|
+
if (hasSecurity || hasAuthenticate) throw new McpRuntimeSecurityConfigError(MCP_RUNTIME_SECURITY_CONFIG_ERROR);
|
|
820
760
|
}
|
|
761
|
+
return {
|
|
762
|
+
enabled: readBooleanFromBlock(block, "enabled"),
|
|
763
|
+
route: readStringFromBlock(block, "route"),
|
|
764
|
+
name: readStringFromBlock(block, "name"),
|
|
765
|
+
version: readStringFromBlock(block, "version"),
|
|
766
|
+
prompts: readBooleanFromBlock(block, "prompts"),
|
|
767
|
+
tools: {
|
|
768
|
+
listDocs: readBooleanFromBlock(block, "listDocs"),
|
|
769
|
+
listPages: readBooleanFromBlock(block, "listPages"),
|
|
770
|
+
listPageSections: readBooleanFromBlock(block, "listPageSections"),
|
|
771
|
+
listTasks: readBooleanFromBlock(block, "listTasks"),
|
|
772
|
+
readTask: readBooleanFromBlock(block, "readTask"),
|
|
773
|
+
readPage: readBooleanFromBlock(block, "readPage"),
|
|
774
|
+
searchDocs: readBooleanFromBlock(block, "searchDocs"),
|
|
775
|
+
getNavigation: readBooleanFromBlock(block, "getNavigation"),
|
|
776
|
+
getCodeExamples: readBooleanFromBlock(block, "getCodeExamples"),
|
|
777
|
+
getConfigSchema: readBooleanFromBlock(block, "getConfigSchema"),
|
|
778
|
+
getContext: readBooleanFromBlock(block, "getContext")
|
|
779
|
+
}
|
|
780
|
+
};
|
|
781
|
+
} catch (error) {
|
|
782
|
+
if (error instanceof McpRuntimeSecurityConfigError) throw error;
|
|
821
783
|
}
|
|
822
784
|
}
|
|
823
785
|
function readStringFromBlock(block, key) {
|
|
@@ -1396,26 +1358,13 @@ function withPublicDocsUrl(page, ctx) {
|
|
|
1396
1358
|
url
|
|
1397
1359
|
};
|
|
1398
1360
|
}
|
|
1399
|
-
function readDocsPath(
|
|
1400
|
-
for (const ext of FILE_EXTS) {
|
|
1401
|
-
const
|
|
1402
|
-
|
|
1403
|
-
|
|
1404
|
-
|
|
1405
|
-
|
|
1406
|
-
if (!fs.existsSync(
|
|
1407
|
-
/* turbopackIgnore: true */
|
|
1408
|
-
configPath
|
|
1409
|
-
)) continue;
|
|
1410
|
-
try {
|
|
1411
|
-
const match = fs.readFileSync(
|
|
1412
|
-
/* turbopackIgnore: true */
|
|
1413
|
-
configPath,
|
|
1414
|
-
"utf-8"
|
|
1415
|
-
).match(/docsPath\s*:\s*["']([^"']*)["']/);
|
|
1416
|
-
if (match) return match[1];
|
|
1417
|
-
} catch {}
|
|
1418
|
-
}
|
|
1361
|
+
function readDocsPath(readConfig) {
|
|
1362
|
+
for (const ext of FILE_EXTS) try {
|
|
1363
|
+
const content = readConfig(ext);
|
|
1364
|
+
if (content === void 0) continue;
|
|
1365
|
+
const match = content.match(/docsPath\s*:\s*["']([^"']*)["']/);
|
|
1366
|
+
if (match) return match[1];
|
|
1367
|
+
} catch {}
|
|
1419
1368
|
}
|
|
1420
1369
|
function resolvePublicMarkdownRequest(entry, docsPath, url, request) {
|
|
1421
1370
|
if (docsPath === `/${normalizePathSegment(entry)}`) return null;
|
|
@@ -2549,54 +2498,41 @@ async function handleAskAI(request, indexes, aiConfig, cloudConfig, search, anal
|
|
|
2549
2498
|
Connection: "keep-alive"
|
|
2550
2499
|
} });
|
|
2551
2500
|
}
|
|
2552
|
-
function readLlmsTxtConfig(
|
|
2553
|
-
for (const ext of FILE_EXTS) {
|
|
2554
|
-
const
|
|
2555
|
-
|
|
2556
|
-
|
|
2557
|
-
|
|
2558
|
-
|
|
2559
|
-
|
|
2560
|
-
|
|
2561
|
-
|
|
2562
|
-
|
|
2563
|
-
|
|
2564
|
-
|
|
2565
|
-
|
|
2566
|
-
|
|
2567
|
-
|
|
2568
|
-
|
|
2569
|
-
|
|
2570
|
-
|
|
2571
|
-
|
|
2572
|
-
|
|
2573
|
-
|
|
2574
|
-
|
|
2575
|
-
|
|
2576
|
-
|
|
2577
|
-
|
|
2578
|
-
|
|
2579
|
-
|
|
2580
|
-
|
|
2581
|
-
|
|
2582
|
-
|
|
2583
|
-
|
|
2584
|
-
|
|
2585
|
-
|
|
2586
|
-
|
|
2587
|
-
const apiCatalog = readTopLevelBoolean(llmsTxtSanitized, "apiCatalog");
|
|
2588
|
-
const baseUrl = readTopLevelString(llmsTxtBlock, llmsTxtSanitized, "baseUrl");
|
|
2589
|
-
const siteTitle = readTopLevelString(llmsTxtBlock, llmsTxtSanitized, "siteTitle");
|
|
2590
|
-
const siteDescription = readTopLevelString(llmsTxtBlock, llmsTxtSanitized, "siteDescription");
|
|
2591
|
-
return {
|
|
2592
|
-
enabled: true,
|
|
2593
|
-
apiCatalog,
|
|
2594
|
-
baseUrl,
|
|
2595
|
-
siteTitle: siteTitle ?? navTitle,
|
|
2596
|
-
siteDescription
|
|
2597
|
-
};
|
|
2598
|
-
} catch {}
|
|
2599
|
-
}
|
|
2501
|
+
function readLlmsTxtConfig(readConfig) {
|
|
2502
|
+
for (const ext of FILE_EXTS) try {
|
|
2503
|
+
const content = readConfig(ext);
|
|
2504
|
+
if (content === void 0) continue;
|
|
2505
|
+
const sanitized = stripCommentsAndStrings(content);
|
|
2506
|
+
const configObject = extractRootConfigObject(content, sanitized);
|
|
2507
|
+
const scopedContent = configObject?.content ?? content;
|
|
2508
|
+
const scopedSanitized = configObject?.sanitized ?? sanitized;
|
|
2509
|
+
const navBlock = extractObjectLiteral(scopedContent, scopedSanitized, "nav");
|
|
2510
|
+
const navTitle = navBlock ? readTopLevelString(navBlock, stripCommentsAndStrings(navBlock), "title") : void 0;
|
|
2511
|
+
const llmsTxtBoolean = readTopLevelBoolean(scopedSanitized, "llmsTxt");
|
|
2512
|
+
if (llmsTxtBoolean === true) return {
|
|
2513
|
+
enabled: true,
|
|
2514
|
+
siteTitle: navTitle
|
|
2515
|
+
};
|
|
2516
|
+
if (llmsTxtBoolean === false) return { enabled: false };
|
|
2517
|
+
const llmsTxtBlock = extractObjectLiteral(scopedContent, scopedSanitized, "llmsTxt");
|
|
2518
|
+
if (!llmsTxtBlock) return {
|
|
2519
|
+
enabled: true,
|
|
2520
|
+
siteTitle: navTitle
|
|
2521
|
+
};
|
|
2522
|
+
const llmsTxtSanitized = stripCommentsAndStrings(llmsTxtBlock);
|
|
2523
|
+
if (readTopLevelBoolean(llmsTxtSanitized, "enabled") === false) return { enabled: false };
|
|
2524
|
+
const apiCatalog = readTopLevelBoolean(llmsTxtSanitized, "apiCatalog");
|
|
2525
|
+
const baseUrl = readTopLevelString(llmsTxtBlock, llmsTxtSanitized, "baseUrl");
|
|
2526
|
+
const siteTitle = readTopLevelString(llmsTxtBlock, llmsTxtSanitized, "siteTitle");
|
|
2527
|
+
const siteDescription = readTopLevelString(llmsTxtBlock, llmsTxtSanitized, "siteDescription");
|
|
2528
|
+
return {
|
|
2529
|
+
enabled: true,
|
|
2530
|
+
apiCatalog,
|
|
2531
|
+
baseUrl,
|
|
2532
|
+
siteTitle: siteTitle ?? navTitle,
|
|
2533
|
+
siteDescription
|
|
2534
|
+
};
|
|
2535
|
+
} catch {}
|
|
2600
2536
|
return { enabled: true };
|
|
2601
2537
|
}
|
|
2602
2538
|
function resolveLlmsTxtConfig(input, fallback) {
|
|
@@ -2611,121 +2547,79 @@ function resolveLlmsTxtConfig(input, fallback) {
|
|
|
2611
2547
|
enabled: input.enabled ?? true
|
|
2612
2548
|
};
|
|
2613
2549
|
}
|
|
2614
|
-
function readSitemapConfig(
|
|
2615
|
-
for (const ext of FILE_EXTS) {
|
|
2616
|
-
const
|
|
2617
|
-
|
|
2618
|
-
|
|
2619
|
-
|
|
2620
|
-
);
|
|
2621
|
-
|
|
2622
|
-
|
|
2623
|
-
|
|
2624
|
-
))
|
|
2625
|
-
|
|
2626
|
-
|
|
2627
|
-
|
|
2628
|
-
|
|
2629
|
-
|
|
2630
|
-
|
|
2631
|
-
|
|
2632
|
-
|
|
2633
|
-
|
|
2634
|
-
const sitemapBlock = content.match(/sitemap\s*:\s*\{([\s\S]*?)\n\s*\}/)?.[1] ?? "";
|
|
2635
|
-
const routePrefix = sitemapBlock.match(/routePrefix\s*:\s*["']([^"']+)["']/)?.[1];
|
|
2636
|
-
const baseUrl = sitemapBlock.match(/baseUrl\s*:\s*["']([^"']+)["']/)?.[1];
|
|
2637
|
-
const manifestPath = sitemapBlock.match(/manifestPath\s*:\s*["']([^"']+)["']/)?.[1];
|
|
2638
|
-
const enabledMatch = sitemapBlock.match(/enabled\s*:\s*(true|false)/);
|
|
2639
|
-
return {
|
|
2640
|
-
enabled: enabledMatch ? enabledMatch[1] === "true" : true,
|
|
2641
|
-
routePrefix,
|
|
2642
|
-
baseUrl,
|
|
2643
|
-
manifestPath
|
|
2644
|
-
};
|
|
2645
|
-
} catch {
|
|
2646
|
-
return;
|
|
2647
|
-
}
|
|
2550
|
+
function readSitemapConfig(readConfig) {
|
|
2551
|
+
for (const ext of FILE_EXTS) try {
|
|
2552
|
+
const content = readConfig(ext);
|
|
2553
|
+
if (content === void 0) continue;
|
|
2554
|
+
if (!content.includes("sitemap")) return void 0;
|
|
2555
|
+
if (/sitemap\s*:\s*false/.test(content)) return false;
|
|
2556
|
+
if (/sitemap\s*:\s*true/.test(content)) return true;
|
|
2557
|
+
const sitemapBlock = content.match(/sitemap\s*:\s*\{([\s\S]*?)\n\s*\}/)?.[1] ?? "";
|
|
2558
|
+
const routePrefix = sitemapBlock.match(/routePrefix\s*:\s*["']([^"']+)["']/)?.[1];
|
|
2559
|
+
const baseUrl = sitemapBlock.match(/baseUrl\s*:\s*["']([^"']+)["']/)?.[1];
|
|
2560
|
+
const manifestPath = sitemapBlock.match(/manifestPath\s*:\s*["']([^"']+)["']/)?.[1];
|
|
2561
|
+
const enabledMatch = sitemapBlock.match(/enabled\s*:\s*(true|false)/);
|
|
2562
|
+
return {
|
|
2563
|
+
enabled: enabledMatch ? enabledMatch[1] === "true" : true,
|
|
2564
|
+
routePrefix,
|
|
2565
|
+
baseUrl,
|
|
2566
|
+
manifestPath
|
|
2567
|
+
};
|
|
2568
|
+
} catch {
|
|
2569
|
+
return;
|
|
2648
2570
|
}
|
|
2649
2571
|
}
|
|
2650
|
-
function readRobotsConfig(
|
|
2651
|
-
for (const ext of FILE_EXTS) {
|
|
2652
|
-
const
|
|
2653
|
-
|
|
2654
|
-
|
|
2655
|
-
|
|
2656
|
-
);
|
|
2657
|
-
|
|
2658
|
-
|
|
2659
|
-
|
|
2660
|
-
))
|
|
2661
|
-
|
|
2662
|
-
|
|
2663
|
-
|
|
2664
|
-
|
|
2665
|
-
|
|
2666
|
-
|
|
2667
|
-
|
|
2668
|
-
|
|
2669
|
-
|
|
2670
|
-
const robotsBlock = content.match(/robots\s*:\s*\{([\s\S]*?)\n\s*\}/)?.[1] ?? "";
|
|
2671
|
-
const enabledMatch = robotsBlock.match(/enabled\s*:\s*(true|false)/);
|
|
2672
|
-
const pathMatch = robotsBlock.match(/path\s*:\s*["']([^"']+)["']/);
|
|
2673
|
-
const baseUrlMatch = robotsBlock.match(/baseUrl\s*:\s*["']([^"']+)["']/);
|
|
2674
|
-
const aiMatch = robotsBlock.match(/ai\s*:\s*["'](allow|disallow)["']/);
|
|
2675
|
-
return {
|
|
2676
|
-
enabled: enabledMatch ? enabledMatch[1] === "true" : true,
|
|
2677
|
-
path: pathMatch?.[1],
|
|
2678
|
-
baseUrl: baseUrlMatch?.[1],
|
|
2679
|
-
ai: aiMatch?.[1]
|
|
2680
|
-
};
|
|
2681
|
-
} catch {
|
|
2682
|
-
return;
|
|
2683
|
-
}
|
|
2572
|
+
function readRobotsConfig(readConfig) {
|
|
2573
|
+
for (const ext of FILE_EXTS) try {
|
|
2574
|
+
const content = readConfig(ext);
|
|
2575
|
+
if (content === void 0) continue;
|
|
2576
|
+
if (!content.includes("robots")) return void 0;
|
|
2577
|
+
if (/robots\s*:\s*false/.test(content)) return false;
|
|
2578
|
+
if (/robots\s*:\s*true/.test(content)) return true;
|
|
2579
|
+
const robotsBlock = content.match(/robots\s*:\s*\{([\s\S]*?)\n\s*\}/)?.[1] ?? "";
|
|
2580
|
+
const enabledMatch = robotsBlock.match(/enabled\s*:\s*(true|false)/);
|
|
2581
|
+
const pathMatch = robotsBlock.match(/path\s*:\s*["']([^"']+)["']/);
|
|
2582
|
+
const baseUrlMatch = robotsBlock.match(/baseUrl\s*:\s*["']([^"']+)["']/);
|
|
2583
|
+
const aiMatch = robotsBlock.match(/ai\s*:\s*["'](allow|disallow)["']/);
|
|
2584
|
+
return {
|
|
2585
|
+
enabled: enabledMatch ? enabledMatch[1] === "true" : true,
|
|
2586
|
+
path: pathMatch?.[1],
|
|
2587
|
+
baseUrl: baseUrlMatch?.[1],
|
|
2588
|
+
ai: aiMatch?.[1]
|
|
2589
|
+
};
|
|
2590
|
+
} catch {
|
|
2591
|
+
return;
|
|
2684
2592
|
}
|
|
2685
2593
|
}
|
|
2686
|
-
function readApiReferenceConfig(
|
|
2687
|
-
for (const ext of FILE_EXTS) {
|
|
2688
|
-
const
|
|
2689
|
-
|
|
2690
|
-
|
|
2691
|
-
|
|
2692
|
-
);
|
|
2693
|
-
|
|
2694
|
-
|
|
2695
|
-
|
|
2696
|
-
))
|
|
2697
|
-
|
|
2698
|
-
|
|
2699
|
-
|
|
2700
|
-
|
|
2701
|
-
|
|
2702
|
-
|
|
2703
|
-
|
|
2704
|
-
|
|
2705
|
-
|
|
2706
|
-
|
|
2707
|
-
|
|
2708
|
-
|
|
2709
|
-
|
|
2710
|
-
|
|
2711
|
-
|
|
2712
|
-
|
|
2713
|
-
|
|
2714
|
-
|
|
2715
|
-
const exclude = excludeMatch?.[1] === void 0 ? void 0 : Array.from(excludeMatch[1].matchAll(/["']([^"']+)["']/g)).map((match) => match[1]).filter(Boolean);
|
|
2716
|
-
const renderer = rendererMatch?.[1] === "farming-labs" || rendererMatch?.[1] === "fumadocs" || rendererMatch?.[1] === "scalar" ? rendererMatch[1] : void 0;
|
|
2717
|
-
return {
|
|
2718
|
-
enabled: enabledMatch ? enabledMatch[1] === "true" : true,
|
|
2719
|
-
path: pathMatch?.[1],
|
|
2720
|
-
routeRoot: routeRootMatch?.[1],
|
|
2721
|
-
specUrl: specUrlMatch?.[1],
|
|
2722
|
-
catalogTargets,
|
|
2723
|
-
renderer,
|
|
2724
|
-
exclude
|
|
2725
|
-
};
|
|
2726
|
-
} catch {
|
|
2727
|
-
return;
|
|
2728
|
-
}
|
|
2594
|
+
function readApiReferenceConfig(readConfig) {
|
|
2595
|
+
for (const ext of FILE_EXTS) try {
|
|
2596
|
+
const content = readConfig(ext);
|
|
2597
|
+
if (content === void 0) continue;
|
|
2598
|
+
if (!content.includes("apiReference")) return void 0;
|
|
2599
|
+
if (/apiReference\s*:\s*false/.test(content)) return false;
|
|
2600
|
+
if (/apiReference\s*:\s*true/.test(content)) return true;
|
|
2601
|
+
const block = content.match(/apiReference\s*:\s*\{([\s\S]*?)\n\s*\}/)?.[1] ?? "";
|
|
2602
|
+
const enabledMatch = block.match(/enabled\s*:\s*(true|false)/);
|
|
2603
|
+
const pathMatch = block.match(/path\s*:\s*["']([^"']+)["']/);
|
|
2604
|
+
const routeRootMatch = block.match(/routeRoot\s*:\s*["']([^"']+)["']/);
|
|
2605
|
+
const specUrlMatch = block.match(/specUrl\s*:\s*["']([^"']+)["']/);
|
|
2606
|
+
const catalogTargetsMatch = block.match(/catalogTargets\s*:\s*\[([\s\S]*?)\]/);
|
|
2607
|
+
const rendererMatch = block.match(/renderer\s*:\s*["'](farming-labs|fumadocs|scalar)["']/);
|
|
2608
|
+
const excludeMatch = block.match(/exclude\s*:\s*\[([\s\S]*?)\]/);
|
|
2609
|
+
const catalogTargets = catalogTargetsMatch?.[1] === void 0 ? void 0 : Array.from(catalogTargetsMatch[1].matchAll(/["']([^"']+)["']/g)).map((match) => match[1]).filter(Boolean);
|
|
2610
|
+
const exclude = excludeMatch?.[1] === void 0 ? void 0 : Array.from(excludeMatch[1].matchAll(/["']([^"']+)["']/g)).map((match) => match[1]).filter(Boolean);
|
|
2611
|
+
const renderer = rendererMatch?.[1] === "farming-labs" || rendererMatch?.[1] === "fumadocs" || rendererMatch?.[1] === "scalar" ? rendererMatch[1] : void 0;
|
|
2612
|
+
return {
|
|
2613
|
+
enabled: enabledMatch ? enabledMatch[1] === "true" : true,
|
|
2614
|
+
path: pathMatch?.[1],
|
|
2615
|
+
routeRoot: routeRootMatch?.[1],
|
|
2616
|
+
specUrl: specUrlMatch?.[1],
|
|
2617
|
+
catalogTargets,
|
|
2618
|
+
renderer,
|
|
2619
|
+
exclude
|
|
2620
|
+
};
|
|
2621
|
+
} catch {
|
|
2622
|
+
return;
|
|
2729
2623
|
}
|
|
2730
2624
|
}
|
|
2731
2625
|
function generateLlmsTxt(indexes, options) {
|
|
@@ -2757,6 +2651,7 @@ function generateLlmsTxt(indexes, options) {
|
|
|
2757
2651
|
*/
|
|
2758
2652
|
function createDocsAPI(options) {
|
|
2759
2653
|
const root = options?.rootDir ?? process.cwd();
|
|
2654
|
+
const readConfig = createDocsConfigReader(root);
|
|
2760
2655
|
const readRootSkillDocument = createRootDocumentReader(root, ["skill.md"], options?._preloadedRootDocuments);
|
|
2761
2656
|
const readRootAgentsDocument = createRootDocumentReader(root, ["AGENTS.md", "AGENT.md"], options?._preloadedRootDocuments);
|
|
2762
2657
|
let publishedAgentSkills;
|
|
@@ -2764,8 +2659,8 @@ function createDocsAPI(options) {
|
|
|
2764
2659
|
if (!publishedAgentSkills) publishedAgentSkills = Array.isArray(options?._preloadedAgentSkills) ? Promise.resolve([...options._preloadedAgentSkills]) : resolveConfiguredAgentSkills(options?.agent?.skills, { rootDir: root });
|
|
2765
2660
|
return publishedAgentSkills;
|
|
2766
2661
|
}
|
|
2767
|
-
const entry = options?.entry ?? readEntry(
|
|
2768
|
-
const docsPath = normalizeDocsPublicPath(options?.docsPath ?? readDocsPath(
|
|
2662
|
+
const entry = options?.entry ?? readEntry(readConfig);
|
|
2663
|
+
const docsPath = normalizeDocsPublicPath(options?.docsPath ?? readDocsPath(readConfig), entry);
|
|
2769
2664
|
const analytics = options?.analytics;
|
|
2770
2665
|
const observability = options?.observability;
|
|
2771
2666
|
const appDir = getNextAppDir(root);
|
|
@@ -2776,10 +2671,10 @@ function createDocsAPI(options) {
|
|
|
2776
2671
|
);
|
|
2777
2672
|
const changelogConfig = resolveChangelogConfig(options?.changelog);
|
|
2778
2673
|
const agentFeedbackConfig = resolveAgentFeedbackConfig(options?.feedback);
|
|
2779
|
-
const i18nConfig = options?.i18n ?? readI18nConfig(
|
|
2674
|
+
const i18nConfig = options?.i18n ?? readI18nConfig(readConfig);
|
|
2780
2675
|
const i18n = resolveDocsI18n(i18nConfig);
|
|
2781
|
-
const aiConfig = options?.ai ?? readAIConfig(
|
|
2782
|
-
const cloudConfig = options?.cloud ?? readCloudConfig(
|
|
2676
|
+
const aiConfig = options?.ai ?? readAIConfig(readConfig);
|
|
2677
|
+
const cloudConfig = options?.cloud ?? readCloudConfig(readConfig);
|
|
2783
2678
|
const configuredApiRouteInput = options?.apiRoute ?? cloudConfig?.apiRoute;
|
|
2784
2679
|
const configuredApiRoute = normalizeDocsApiRoute(configuredApiRouteInput);
|
|
2785
2680
|
const effectiveCloudConfig = options?.apiRoute !== void 0 || cloudConfig?.apiRoute !== void 0 ? {
|
|
@@ -2789,11 +2684,12 @@ function createDocsAPI(options) {
|
|
|
2789
2684
|
const searchConfig = options?.search;
|
|
2790
2685
|
const contentChangesConfig = resolveDocsContentChangesConfig(options?.agent?.contentChanges, { staticExport: options?.staticExport === true });
|
|
2791
2686
|
const contentChangeFeed = createDocsContentChangeFeed(options?.agent?.contentChanges);
|
|
2792
|
-
const llmsConfig = resolveLlmsTxtConfig(options?.llmsTxt, readLlmsTxtConfig(
|
|
2687
|
+
const llmsConfig = resolveLlmsTxtConfig(options?.llmsTxt, options?.llmsTxt === false ? { enabled: false } : readLlmsTxtConfig(readConfig));
|
|
2793
2688
|
const apiCatalogEnabled = options?.apiCatalog ?? llmsConfig.apiCatalog ?? true;
|
|
2794
|
-
const sitemapConfig = options?.sitemap ?? readSitemapConfig(
|
|
2689
|
+
const sitemapConfig = options?.sitemap ?? readSitemapConfig(readConfig);
|
|
2795
2690
|
const sitemapManifest = readDocsSitemapManifest(root, sitemapConfig);
|
|
2796
|
-
const
|
|
2691
|
+
const resolveLastmod = createDocsSitemapLastmodResolver(sitemapManifest);
|
|
2692
|
+
const robotsConfig = options?.robots ?? readRobotsConfig(readConfig);
|
|
2797
2693
|
const markdownMetadataBaseUrl = resolveDocsMetadataBaseUrl({
|
|
2798
2694
|
...options,
|
|
2799
2695
|
entry,
|
|
@@ -2802,14 +2698,14 @@ function createDocsAPI(options) {
|
|
|
2802
2698
|
sitemap: sitemapConfig,
|
|
2803
2699
|
robots: robotsConfig
|
|
2804
2700
|
});
|
|
2805
|
-
const apiReferenceConfig = options?.apiReference ?? readApiReferenceConfig(
|
|
2701
|
+
const apiReferenceConfig = options?.apiReference ?? readApiReferenceConfig(readConfig);
|
|
2806
2702
|
const apiReferenceDocsConfig = {
|
|
2807
2703
|
...options,
|
|
2808
2704
|
entry,
|
|
2809
2705
|
apiReference: apiReferenceConfig
|
|
2810
2706
|
};
|
|
2811
2707
|
const openapiDiscovery = resolveApiReferenceOpenApiDiscovery(apiReferenceConfig);
|
|
2812
|
-
const rawMcpConfig = options?.mcp ?? readMcpConfig(
|
|
2708
|
+
const rawMcpConfig = options?.mcp ?? readMcpConfig(readConfig);
|
|
2813
2709
|
const mcpConfig = resolveDocsMcpConfig(rawMcpConfig, { defaultName: llmsConfig.siteTitle ?? "Documentation" });
|
|
2814
2710
|
const discoveryLinkHeader = getDocsDiscoveryLinkHeader({
|
|
2815
2711
|
includeApiCatalog: apiCatalogEnabled,
|
|
@@ -3001,7 +2897,7 @@ function createDocsAPI(options) {
|
|
|
3001
2897
|
const changelogPages = ctx.changelogDirs.flatMap((dir) => scanChangelogDir(dir, ctx.entryPath, changelogConfig.path, ctx.locale, ctx.publicPath));
|
|
3002
2898
|
next = [...next, ...changelogPages];
|
|
3003
2899
|
}
|
|
3004
|
-
const timestamped = next.map((page) => withSitemapLastModified(page,
|
|
2900
|
+
const timestamped = next.map((page) => withSitemapLastModified(page, resolveLastmod));
|
|
3005
2901
|
indexesByLocale.set(key, timestamped);
|
|
3006
2902
|
return timestamped;
|
|
3007
2903
|
}
|
|
@@ -3042,7 +2938,7 @@ function createDocsAPI(options) {
|
|
|
3042
2938
|
) : docsDir)) return null;
|
|
3043
2939
|
for (const source of getMarkdownSources(ctx)) {
|
|
3044
2940
|
const resolvedPage = findDocsMcpPage(ctx.entryPath, await source.getPages(), requestedPath);
|
|
3045
|
-
const page = resolvedPage ? withSitemapLastModified(resolvedPage,
|
|
2941
|
+
const page = resolvedPage ? withSitemapLastModified(resolvedPage, resolveLastmod) : void 0;
|
|
3046
2942
|
if (page) return {
|
|
3047
2943
|
document: renderMarkdownDocument(withPublicDocsUrl(page, ctx), {
|
|
3048
2944
|
llmsEnabled: llmsConfig.enabled,
|
|
@@ -3724,16 +3620,17 @@ function createDocsAPI(options) {
|
|
|
3724
3620
|
*/
|
|
3725
3621
|
function createDocsMCPAPI(options = {}) {
|
|
3726
3622
|
const rootDir = options.rootDir ?? process.cwd();
|
|
3623
|
+
const readConfig = createDocsConfigReader(rootDir);
|
|
3727
3624
|
const readRootSkillDocument = createRootDocumentReader(rootDir, ["skill.md"], options._preloadedRootDocuments);
|
|
3728
|
-
const entry = options.entry ?? readEntry(
|
|
3625
|
+
const entry = options.entry ?? readEntry(readConfig);
|
|
3729
3626
|
const appDir = getNextAppDir(rootDir);
|
|
3730
3627
|
const contentDir = options.contentDir ?? path.join(
|
|
3731
3628
|
/* turbopackIgnore: true */
|
|
3732
3629
|
appDir,
|
|
3733
3630
|
entry
|
|
3734
3631
|
);
|
|
3735
|
-
const mcpConfig = options.mcp ?? readMcpConfig(
|
|
3736
|
-
const
|
|
3632
|
+
const mcpConfig = options.mcp ?? readMcpConfig(readConfig, { rejectRuntimeSecurity: true });
|
|
3633
|
+
const resolveLastmod = createDocsSitemapLastmodResolver(readDocsSitemapManifest(rootDir, options.sitemap ?? readSitemapConfig(readConfig)));
|
|
3737
3634
|
const contentChangeFeed = createDocsContentChangeFeed(options.agent?.contentChanges);
|
|
3738
3635
|
const navTitle = typeof options.nav?.title === "string" && options.nav.title.trim().length > 0 ? options.nav.title : "Documentation";
|
|
3739
3636
|
let configuredAgentSkills;
|
|
@@ -3752,7 +3649,7 @@ function createDocsMCPAPI(options = {}) {
|
|
|
3752
3649
|
const source = {
|
|
3753
3650
|
...filesystemSource,
|
|
3754
3651
|
async getPages() {
|
|
3755
|
-
return (await filesystemSource.getPages()).map((page) => withSitemapLastModified(page,
|
|
3652
|
+
return (await filesystemSource.getPages()).map((page) => withSitemapLastModified(page, resolveLastmod));
|
|
3756
3653
|
},
|
|
3757
3654
|
async getSkills() {
|
|
3758
3655
|
const configured = await getConfiguredAgentSkills();
|
package/dist/docs-layout.mjs
CHANGED
|
@@ -2,6 +2,7 @@ import { serializeIcon } from "./serialize-icon.mjs";
|
|
|
2
2
|
import { resolveOpenDocsProviders } from "./open-docs-providers.mjs";
|
|
3
3
|
import { withLangInUrl } from "./i18n.mjs";
|
|
4
4
|
import { compactPageStructuredData } from "./page-structured-data.mjs";
|
|
5
|
+
import { serializePageMetadata } from "./page-metadata.mjs";
|
|
5
6
|
import { DocsPageClient } from "./docs-page-client.mjs";
|
|
6
7
|
import { DocsAIFeatures } from "./docs-ai-features-lazy.mjs";
|
|
7
8
|
import { resolveDocsCloudAIClientRequest } from "./docs-cloud-ai-client.mjs";
|
|
@@ -15,7 +16,7 @@ import fs from "node:fs";
|
|
|
15
16
|
import path from "node:path";
|
|
16
17
|
import { DocsLayout } from "fumadocs-ui/layouts/docs";
|
|
17
18
|
import { Suspense, cloneElement, isValidElement } from "react";
|
|
18
|
-
import { applySidebarFolderIndexBehavior, buildPageOpenGraph, buildPageTwitter, normalizePageAgentFrontmatter, resolveChangelogConfig, resolveDocsAnalyticsConfig, resolveDocsAudienceMdxContent, resolveDocsMetadataBaseUrl,
|
|
19
|
+
import { applySidebarFolderIndexBehavior, buildPageOpenGraph, buildPageTwitter, createDocsSitemapLastmodResolver, normalizePageAgentFrontmatter, resolveChangelogConfig, resolveDocsAnalyticsConfig, resolveDocsAudienceMdxContent, resolveDocsMetadataBaseUrl, resolvePageSidebarFolderIndexBehavior, toDocsMarkdownUrl } from "@farming-labs/docs";
|
|
19
20
|
import { readDocsSitemapManifest } from "@farming-labs/docs/runtime";
|
|
20
21
|
import { jsx, jsxs } from "react/jsx-runtime";
|
|
21
22
|
|
|
@@ -440,11 +441,12 @@ function cloneTree(tree) {
|
|
|
440
441
|
children: tree.children.map(cloneNode)
|
|
441
442
|
};
|
|
442
443
|
}
|
|
443
|
-
function resolveManifestLastmod(
|
|
444
|
-
return (ctx.locale ?
|
|
444
|
+
function resolveManifestLastmod(resolveLastmod, ctx, url) {
|
|
445
|
+
return (ctx.locale ? resolveLastmod(`${url}?lang=${encodeURIComponent(ctx.locale)}`) : void 0) ?? resolveLastmod(url);
|
|
445
446
|
}
|
|
446
447
|
/** Read each page once for all metadata, sharing the reader with navigation. */
|
|
447
448
|
function buildPageMaps(config, ctx, reader, manifest, options) {
|
|
449
|
+
const resolveLastmod = createDocsSitemapLastmodResolver(manifest);
|
|
448
450
|
const lastModifiedMap = {};
|
|
449
451
|
const descriptionMap = {};
|
|
450
452
|
const generatedTitleMap = {};
|
|
@@ -473,7 +475,7 @@ function buildPageMaps(config, ctx, reader, manifest, options) {
|
|
|
473
475
|
const route = publicDocsRoute(ctx, slugParts);
|
|
474
476
|
const title = typeof data.title === "string" ? data.title : slugParts.at(-1)?.replace(/-/g, " ") || "Documentation";
|
|
475
477
|
const description = typeof data.description === "string" ? data.description : void 0;
|
|
476
|
-
const manifestLastmod = resolveManifestLastmod(
|
|
478
|
+
const manifestLastmod = resolveManifestLastmod(resolveLastmod, ctx, route);
|
|
477
479
|
if (config.theme?.name === "shadcn" && typeof data.title === "string" && !hasAuthoredPageTitle(content)) generatedTitleMap[route] = data.title;
|
|
478
480
|
if (fileName === "page.mdx") {
|
|
479
481
|
if (dateFormatter) lastModifiedMap[route] = dateFormatter.format(manifestLastmod ? /* @__PURE__ */ new Date(`${manifestLastmod}T00:00:00`) : modifiedAt);
|
|
@@ -780,15 +782,15 @@ function createDocsLayout(config, options) {
|
|
|
780
782
|
defaultBehavior: config.theme?.name === "shadcn" ? "hidden" : "link"
|
|
781
783
|
});
|
|
782
784
|
return {
|
|
783
|
-
|
|
785
|
+
pageMetadata: serializePageMetadata(maps),
|
|
786
|
+
readingTimeEnabled: readingTimeEnabledByDefault || Object.keys(maps.readingTimeMap).length > 0,
|
|
784
787
|
localizedTree: i18n ? localizeTreeUrls(tree, activeLocale) : tree
|
|
785
788
|
};
|
|
786
789
|
}
|
|
787
790
|
let productionContent;
|
|
788
791
|
return function DocsLayoutWrapper({ children }) {
|
|
789
|
-
const {
|
|
792
|
+
const { pageMetadata, readingTimeEnabled, localizedTree: preparedTree } = process.env.NODE_ENV === "production" ? productionContent ??= prepareContent() : prepareContent();
|
|
790
793
|
const localizedTree = cloneTree(preparedTree);
|
|
791
|
-
const readingTimeEnabled = readingTimeEnabledByDefault || Object.keys(readingTimeMap).length > 0;
|
|
792
794
|
const finalSidebarProps = { ...sidebarProps };
|
|
793
795
|
const sidebarFooter = withStableReactKey(sidebarProps.footer, "docs-sidebar-footer");
|
|
794
796
|
finalSidebarProps.banner = withStableReactKey(sidebarProps.banner, "docs-sidebar-banner");
|
|
@@ -889,17 +891,13 @@ function createDocsLayout(config, options) {
|
|
|
889
891
|
contentDir,
|
|
890
892
|
githubBranch,
|
|
891
893
|
githubDirectory,
|
|
892
|
-
|
|
894
|
+
pageMetadata,
|
|
893
895
|
lastUpdatedEnabled,
|
|
894
896
|
lastUpdatedLabel,
|
|
895
897
|
lastUpdatedPosition,
|
|
896
898
|
readingTimeEnabled,
|
|
897
899
|
readingTimeFormat,
|
|
898
|
-
readingTimeMap,
|
|
899
|
-
structuredDataPages,
|
|
900
900
|
llmsTxtEnabled,
|
|
901
|
-
generatedTitleMap,
|
|
902
|
-
descriptionMap,
|
|
903
901
|
feedbackEnabled: feedbackConfig.enabled,
|
|
904
902
|
feedbackQuestion: feedbackConfig.question,
|
|
905
903
|
feedbackPlaceholder: feedbackConfig.placeholder,
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { DocsStructuredDataPages } from "./page-structured-data.mjs";
|
|
2
|
+
import { DocsPageMetadata } from "./page-metadata.mjs";
|
|
2
3
|
import { ReactNode } from "react";
|
|
3
4
|
import { CopyMarkdownFormat, DocsFeedbackData, DocsTelemetryConfig, DocsTelemetryFramework, PageActionConnectMcpConfig, PageActionInstallSkillsConfig, ReadingTimeFormat } from "@farming-labs/docs";
|
|
4
5
|
import * as react_jsx_runtime0 from "react/jsx-runtime";
|
|
@@ -17,6 +18,8 @@ interface SerializedProvider {
|
|
|
17
18
|
prompt?: string;
|
|
18
19
|
}
|
|
19
20
|
interface DocsPageClientProps {
|
|
21
|
+
/** Internal packed layout metadata. Direct values and legacy maps retain precedence. */
|
|
22
|
+
pageMetadata?: DocsPageMetadata;
|
|
20
23
|
tocEnabled: boolean;
|
|
21
24
|
/** Expose the llms.txt action in a runtime-owned header slot. */
|
|
22
25
|
showLlmsInHeader?: boolean;
|
|
@@ -110,6 +113,7 @@ interface DocsPageClientProps {
|
|
|
110
113
|
children: ReactNode;
|
|
111
114
|
}
|
|
112
115
|
declare function DocsPageClient({
|
|
116
|
+
pageMetadata,
|
|
113
117
|
tocEnabled,
|
|
114
118
|
showLlmsInHeader,
|
|
115
119
|
tocStyle,
|
|
@@ -7,6 +7,7 @@ import { DocsFeedback } from "./docs-feedback.mjs";
|
|
|
7
7
|
import { resolveClientLocale, withLangInUrl } from "./i18n.mjs";
|
|
8
8
|
import { escapeJsonLdForScript } from "./json-ld.mjs";
|
|
9
9
|
import { renderPageStructuredData } from "./page-structured-data.mjs";
|
|
10
|
+
import { resolvePageMetadata } from "./page-metadata.mjs";
|
|
10
11
|
import { Children, Fragment, useEffect, useLayoutEffect, useState } from "react";
|
|
11
12
|
import { DocsBody, DocsPage, EditOnGitHub } from "fumadocs-ui/layouts/docs/page";
|
|
12
13
|
import { createPortal } from "react-dom";
|
|
@@ -265,7 +266,7 @@ function findThreadlineTocActionsContainer() {
|
|
|
265
266
|
}
|
|
266
267
|
return toc.parentElement ?? toc;
|
|
267
268
|
}
|
|
268
|
-
function DocsPageClient({ tocEnabled, showLlmsInHeader = false, tocStyle = "default", breadcrumbEnabled = true, changelogBasePath, entry = "docs", publicPath, locale, copyMarkdown = false, copyMarkdownFormat, copyMarkdownIncludeTitle, copyMarkdownLabel, copyMarkdownCopiedLabel, openDocs = false, openDocsProviders, openDocsTarget, openDocsPrompt, connectMcp, installSkills, pageActionsPosition = "below-title", pageActionsAlignment = "left", githubUrl, contentDir, githubBranch = "main", githubDirectory, editOnGithubUrl, lastModifiedMap, lastModified: lastModifiedProp, readingTimeMap, readingTime: readingTimeProp, readingTimeFormat = "long", previousPage, nextPage, structuredDataMap, structuredDataPages, structuredData: structuredDataProp, readingTimeEnabled = false, lastUpdatedEnabled = true, lastUpdatedLabel = "Last updated", lastUpdatedPosition = "footer", llmsTxtEnabled = false, generatedTitleMap, descriptionMap, description, descriptionInBody = false, feedbackEnabled = false, feedbackQuestion, feedbackPlaceholder, feedbackRequireComment, feedbackPositiveLabel, feedbackNegativeLabel, feedbackSubmitLabel, feedbackSuccessMessage, feedbackErrorMessage, feedbackOnFeedback, analytics = false, telemetry, telemetryFramework, children }) {
|
|
269
|
+
function DocsPageClient({ pageMetadata, tocEnabled, showLlmsInHeader = false, tocStyle = "default", breadcrumbEnabled = true, changelogBasePath, entry = "docs", publicPath, locale, copyMarkdown = false, copyMarkdownFormat, copyMarkdownIncludeTitle, copyMarkdownLabel, copyMarkdownCopiedLabel, openDocs = false, openDocsProviders, openDocsTarget, openDocsPrompt, connectMcp, installSkills, pageActionsPosition = "below-title", pageActionsAlignment = "left", githubUrl, contentDir, githubBranch = "main", githubDirectory, editOnGithubUrl, lastModifiedMap, lastModified: lastModifiedProp, readingTimeMap, readingTime: readingTimeProp, readingTimeFormat = "long", previousPage, nextPage, structuredDataMap, structuredDataPages, structuredData: structuredDataProp, readingTimeEnabled = false, lastUpdatedEnabled = true, lastUpdatedLabel = "Last updated", lastUpdatedPosition = "footer", llmsTxtEnabled = false, generatedTitleMap, descriptionMap, description, descriptionInBody = false, feedbackEnabled = false, feedbackQuestion, feedbackPlaceholder, feedbackRequireComment, feedbackPositiveLabel, feedbackNegativeLabel, feedbackSubmitLabel, feedbackSuccessMessage, feedbackErrorMessage, feedbackOnFeedback, analytics = false, telemetry, telemetryFramework, children }) {
|
|
269
270
|
const router = useRouter();
|
|
270
271
|
const fdTocStyle = tocStyle === "directional" ? "clerk" : void 0;
|
|
271
272
|
const [toc, setToc] = useState([]);
|
|
@@ -281,11 +282,12 @@ function DocsPageClient({ tocEnabled, showLlmsInHeader = false, tocStyle = "defa
|
|
|
281
282
|
const llmsLangQuery = activeLocale ? `?lang=${encodeURIComponent(activeLocale)}` : "";
|
|
282
283
|
const shouldShowLlmsInHeader = llmsTxtEnabled && showLlmsInHeader;
|
|
283
284
|
const normalizedPath = (browserPathname || pathname).replace(/\/$/, "") || "/";
|
|
284
|
-
const
|
|
285
|
-
const
|
|
285
|
+
const page = resolvePageMetadata(pageMetadata, normalizedPath);
|
|
286
|
+
const pageTitle = generatedTitleMap?.[normalizedPath] ?? page?.generatedTitle;
|
|
287
|
+
const pageDescription = description ?? descriptionMap?.[normalizedPath] ?? page?.description;
|
|
286
288
|
const isChangelogRoute = !!(changelogBasePath && (normalizedPath === changelogBasePath || normalizedPath.startsWith(`${changelogBasePath}/`)));
|
|
287
|
-
const matchedReadingTime = readingTimeMap?.[normalizedPath];
|
|
288
|
-
const structuredDataJson = !isChangelogRoute ? structuredDataProp ?? structuredDataMap?.[normalizedPath] ?? renderPageStructuredData(structuredDataPages, normalizedPath) : void 0;
|
|
289
|
+
const matchedReadingTime = readingTimeMap?.[normalizedPath] ?? page?.readingTime;
|
|
290
|
+
const structuredDataJson = !isChangelogRoute ? structuredDataProp ?? structuredDataMap?.[normalizedPath] ?? renderPageStructuredData(structuredDataPages, normalizedPath) ?? renderPageStructuredData(page?.structuredDataPages, normalizedPath) : void 0;
|
|
289
291
|
useEffect(() => {
|
|
290
292
|
if (!analytics) return;
|
|
291
293
|
emitClientAnalyticsEvent({
|
|
@@ -462,7 +464,7 @@ function DocsPageClient({ tocEnabled, showLlmsInHeader = false, tocStyle = "defa
|
|
|
462
464
|
setTitleControlsPortalHost(null);
|
|
463
465
|
};
|
|
464
466
|
}, [pathname, showActionsInToc]);
|
|
465
|
-
const lastModified = !isChangelogRoute && lastUpdatedEnabled ? lastModifiedProp ?? lastModifiedMap?.[normalizedPath] : void 0;
|
|
467
|
+
const lastModified = !isChangelogRoute && lastUpdatedEnabled ? lastModifiedProp ?? lastModifiedMap?.[normalizedPath] ?? page?.lastModified : void 0;
|
|
466
468
|
const showLastUpdatedBelowTitle = !!lastModified && lastUpdatedPosition === "below-title";
|
|
467
469
|
const showLastUpdatedInFooter = !!lastModified && lastUpdatedPosition === "footer";
|
|
468
470
|
const lastUpdatedLabelText = lastUpdatedLabel.trim();
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import "./page-structured-data.mjs";
|
|
2
|
+
import "@farming-labs/docs";
|
|
3
|
+
|
|
4
|
+
//#region src/page-metadata.d.ts
|
|
5
|
+
/** Internal transport shared by the layout and its client component. */
|
|
6
|
+
interface DocsPageMetadata {
|
|
7
|
+
json: string;
|
|
8
|
+
}
|
|
9
|
+
//#endregion
|
|
10
|
+
export { DocsPageMetadata };
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
//#region src/page-metadata.ts
|
|
2
|
+
/**
|
|
3
|
+
* Pack once per content snapshot. RSC can send one string instead of traversing
|
|
4
|
+
* several overlapping maps for every prerendered page. Keep all routes so a
|
|
5
|
+
* persistent layout still has metadata after client navigation.
|
|
6
|
+
*/
|
|
7
|
+
function serializePageMetadata(maps) {
|
|
8
|
+
const dates = [];
|
|
9
|
+
const dateIndexes = /* @__PURE__ */ new Map();
|
|
10
|
+
const dateIndex = (value) => {
|
|
11
|
+
if (value === void 0) return null;
|
|
12
|
+
const cached = dateIndexes.get(value);
|
|
13
|
+
if (cached !== void 0) return cached;
|
|
14
|
+
const index = dates.push(value) - 1;
|
|
15
|
+
dateIndexes.set(value, index);
|
|
16
|
+
return index;
|
|
17
|
+
};
|
|
18
|
+
const pages = {};
|
|
19
|
+
for (const [route, page] of Object.entries(maps.structuredDataPages.pages)) {
|
|
20
|
+
const generatedTitle = maps.generatedTitleMap[route];
|
|
21
|
+
const description = maps.descriptionMap[route];
|
|
22
|
+
const row = [
|
|
23
|
+
page.title,
|
|
24
|
+
page.description ?? null,
|
|
25
|
+
dateIndex(page.dateModified),
|
|
26
|
+
dateIndex(maps.lastModifiedMap[route]),
|
|
27
|
+
generatedTitle === void 0 ? null : generatedTitle === page.title ? 1 : generatedTitle,
|
|
28
|
+
maps.readingTimeMap[route] ?? null,
|
|
29
|
+
description === void 0 ? null : description === page.description ? 1 : description
|
|
30
|
+
];
|
|
31
|
+
if (page.url !== route || page.breadcrumbs !== void 0 || page.mainEntity !== void 0) row.push({
|
|
32
|
+
url: page.url !== route ? page.url : void 0,
|
|
33
|
+
breadcrumbs: page.breadcrumbs,
|
|
34
|
+
mainEntity: page.mainEntity
|
|
35
|
+
});
|
|
36
|
+
pages[route] = row;
|
|
37
|
+
}
|
|
38
|
+
return { json: JSON.stringify({
|
|
39
|
+
baseUrl: maps.structuredDataPages.baseUrl,
|
|
40
|
+
entry: maps.structuredDataPages.entry,
|
|
41
|
+
dates,
|
|
42
|
+
pages
|
|
43
|
+
}) };
|
|
44
|
+
}
|
|
45
|
+
const decoded = /* @__PURE__ */ new WeakMap();
|
|
46
|
+
function resolvePageMetadata(data, route) {
|
|
47
|
+
if (!data) return void 0;
|
|
48
|
+
let cached = decoded.get(data);
|
|
49
|
+
if (!cached || cached.json !== data.json) {
|
|
50
|
+
cached = {
|
|
51
|
+
json: data.json,
|
|
52
|
+
pages: JSON.parse(data.json)
|
|
53
|
+
};
|
|
54
|
+
decoded.set(data, cached);
|
|
55
|
+
}
|
|
56
|
+
const packed = cached.pages;
|
|
57
|
+
const row = Object.hasOwn(packed.pages, route) ? packed.pages[route] : void 0;
|
|
58
|
+
if (!row) return void 0;
|
|
59
|
+
const [title, description, modified, lastModified, generatedTitle, readingTime, visible, extra] = row;
|
|
60
|
+
return {
|
|
61
|
+
generatedTitle: generatedTitle === 1 ? title : generatedTitle ?? void 0,
|
|
62
|
+
description: visible === 1 ? description ?? void 0 : visible ?? void 0,
|
|
63
|
+
lastModified: lastModified === null ? void 0 : packed.dates[lastModified],
|
|
64
|
+
readingTime: readingTime ?? void 0,
|
|
65
|
+
structuredDataPages: {
|
|
66
|
+
baseUrl: packed.baseUrl,
|
|
67
|
+
entry: packed.entry,
|
|
68
|
+
pages: { [route]: {
|
|
69
|
+
title,
|
|
70
|
+
description: description ?? void 0,
|
|
71
|
+
dateModified: modified === null ? void 0 : packed.dates[modified],
|
|
72
|
+
url: extra?.url ?? route,
|
|
73
|
+
breadcrumbs: extra?.breadcrumbs,
|
|
74
|
+
mainEntity: extra?.mainEntity
|
|
75
|
+
} }
|
|
76
|
+
}
|
|
77
|
+
};
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
//#endregion
|
|
81
|
+
export { resolvePageMetadata, serializePageMetadata };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@farming-labs/theme",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.123",
|
|
4
4
|
"description": "Theme package for @farming-labs/docs — layout, provider, MDX components, and styles",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"docs",
|
|
@@ -161,7 +161,7 @@
|
|
|
161
161
|
"tsdown": "^0.20.3",
|
|
162
162
|
"typescript": "^5.9.3",
|
|
163
163
|
"vitest": "^4.1.8",
|
|
164
|
-
"@farming-labs/docs": "0.2.
|
|
164
|
+
"@farming-labs/docs": "0.2.123"
|
|
165
165
|
},
|
|
166
166
|
"peerDependencies": {
|
|
167
167
|
"@farming-labs/docs": ">=0.0.1",
|