@farming-labs/docs 0.1.31 → 0.1.33
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/index.d.mts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { $ as SidebarPageNode, A as DocsSearchResult, B as OGConfig, C as DocsSearchAdapterContext, D as DocsSearchDocument, E as DocsSearchConfig, F as FontStyle, G as PageActionsConfig, H as OpenDocsProvider, I as GithubConfig, J as PageTwitter, K as PageFrontmatter, L as LastUpdatedConfig, M as DocsSearchSourcePage, N as DocsTheme, O as DocsSearchEmbeddingsConfig, P as FeedbackConfig, Q as SidebarNode, R as LlmsTxtConfig, S as DocsSearchAdapter, T as DocsSearchChunkingConfig, U as OpenGraphImage, V as OpenDocsConfig, W as OrderingItem, X as SidebarConfig, Y as SidebarComponentProps, Z as SidebarFolderNode, _ as DocsI18nConfig, a as ApiReferenceRenderer, at as UIConfig, b as DocsMetadata, c as ChangelogFrontmatter, d as CustomDocsSearchConfig, et as SidebarTree, f as DocsAgentFeedbackContext, g as DocsFeedbackValue, h as DocsFeedbackData, i as ApiReferenceConfig, it as TypographyConfig, j as DocsSearchResultType, k as DocsSearchQuery, l as CodeBlockCopyData, m as DocsConfig, n as AgentFeedbackConfig, nt as ThemeToggleConfig, o as BreadcrumbConfig, p as DocsAgentFeedbackData, q as PageOpenGraph, r as AlgoliaDocsSearchConfig, rt as TypesenseDocsSearchConfig, s as ChangelogConfig, t as AIConfig, tt as SimpleDocsSearchConfig, u as CopyMarkdownConfig, v as DocsMcpConfig, w as DocsSearchAdapterFactory, x as DocsNav, y as DocsMcpToolsConfig, z as McpDocsSearchConfig } from "./types-
|
|
2
|
-
import { a as createSimpleSearchAdapter, c as resolveSearchRequestConfig, i as createMcpSearchAdapter, n as createAlgoliaSearchAdapter, o as createTypesenseSearchAdapter, r as createCustomSearchAdapter, s as performDocsSearch, t as buildDocsSearchDocuments } from "./search-
|
|
1
|
+
import { $ as SidebarPageNode, A as DocsSearchResult, B as OGConfig, C as DocsSearchAdapterContext, D as DocsSearchDocument, E as DocsSearchConfig, F as FontStyle, G as PageActionsConfig, H as OpenDocsProvider, I as GithubConfig, J as PageTwitter, K as PageFrontmatter, L as LastUpdatedConfig, M as DocsSearchSourcePage, N as DocsTheme, O as DocsSearchEmbeddingsConfig, P as FeedbackConfig, Q as SidebarNode, R as LlmsTxtConfig, S as DocsSearchAdapter, T as DocsSearchChunkingConfig, U as OpenGraphImage, V as OpenDocsConfig, W as OrderingItem, X as SidebarConfig, Y as SidebarComponentProps, Z as SidebarFolderNode, _ as DocsI18nConfig, a as ApiReferenceRenderer, at as UIConfig, b as DocsMetadata, c as ChangelogFrontmatter, d as CustomDocsSearchConfig, et as SidebarTree, f as DocsAgentFeedbackContext, g as DocsFeedbackValue, h as DocsFeedbackData, i as ApiReferenceConfig, it as TypographyConfig, j as DocsSearchResultType, k as DocsSearchQuery, l as CodeBlockCopyData, m as DocsConfig, n as AgentFeedbackConfig, nt as ThemeToggleConfig, o as BreadcrumbConfig, p as DocsAgentFeedbackData, q as PageOpenGraph, r as AlgoliaDocsSearchConfig, rt as TypesenseDocsSearchConfig, s as ChangelogConfig, t as AIConfig, tt as SimpleDocsSearchConfig, u as CopyMarkdownConfig, v as DocsMcpConfig, w as DocsSearchAdapterFactory, x as DocsNav, y as DocsMcpToolsConfig, z as McpDocsSearchConfig } from "./types-CuWt3Mzv.mjs";
|
|
2
|
+
import { a as createSimpleSearchAdapter, c as resolveSearchRequestConfig, i as createMcpSearchAdapter, n as createAlgoliaSearchAdapter, o as createTypesenseSearchAdapter, r as createCustomSearchAdapter, s as performDocsSearch, t as buildDocsSearchDocuments } from "./search-BCqDEGK4.mjs";
|
|
3
3
|
|
|
4
4
|
//#region src/define-docs.d.ts
|
|
5
5
|
/**
|
package/dist/mcp.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { E as DocsSearchConfig, W as OrderingItem, v as DocsMcpConfig } from "./types-
|
|
1
|
+
import { E as DocsSearchConfig, W as OrderingItem, v as DocsMcpConfig } from "./types-CuWt3Mzv.mjs";
|
|
2
2
|
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
3
3
|
|
|
4
4
|
//#region src/mcp.d.ts
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { A as DocsSearchResult, D as DocsSearchDocument, E as DocsSearchConfig, M as DocsSearchSourcePage, S as DocsSearchAdapter, T as DocsSearchChunkingConfig, d as CustomDocsSearchConfig, r as AlgoliaDocsSearchConfig, rt as TypesenseDocsSearchConfig, w as DocsSearchAdapterFactory, z as McpDocsSearchConfig } from "./types-
|
|
1
|
+
import { A as DocsSearchResult, D as DocsSearchDocument, E as DocsSearchConfig, M as DocsSearchSourcePage, S as DocsSearchAdapter, T as DocsSearchChunkingConfig, d as CustomDocsSearchConfig, r as AlgoliaDocsSearchConfig, rt as TypesenseDocsSearchConfig, w as DocsSearchAdapterFactory, z as McpDocsSearchConfig } from "./types-CuWt3Mzv.mjs";
|
|
2
2
|
|
|
3
3
|
//#region src/search.d.ts
|
|
4
4
|
declare function buildDocsSearchDocuments(pages: DocsSearchSourcePage[], chunking?: DocsSearchChunkingConfig): DocsSearchDocument[];
|
package/dist/server.d.mts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { A as DocsSearchResult, C as DocsSearchAdapterContext, D as DocsSearchDocument, E as DocsSearchConfig, M as DocsSearchSourcePage, S as DocsSearchAdapter, a as ApiReferenceRenderer, k as DocsSearchQuery, m as DocsConfig, w as DocsSearchAdapterFactory, z as McpDocsSearchConfig } from "./types-
|
|
2
|
-
import { a as createSimpleSearchAdapter, c as resolveSearchRequestConfig, i as createMcpSearchAdapter, n as createAlgoliaSearchAdapter, o as createTypesenseSearchAdapter, r as createCustomSearchAdapter, s as performDocsSearch, t as buildDocsSearchDocuments } from "./search-
|
|
1
|
+
import { A as DocsSearchResult, C as DocsSearchAdapterContext, D as DocsSearchDocument, E as DocsSearchConfig, M as DocsSearchSourcePage, S as DocsSearchAdapter, a as ApiReferenceRenderer, k as DocsSearchQuery, m as DocsConfig, w as DocsSearchAdapterFactory, z as McpDocsSearchConfig } from "./types-CuWt3Mzv.mjs";
|
|
2
|
+
import { a as createSimpleSearchAdapter, c as resolveSearchRequestConfig, i as createMcpSearchAdapter, n as createAlgoliaSearchAdapter, o as createTypesenseSearchAdapter, r as createCustomSearchAdapter, s as performDocsSearch, t as buildDocsSearchDocuments } from "./search-BCqDEGK4.mjs";
|
|
3
3
|
import { DocsMcpHttpHandlers, DocsMcpNavigationNode, DocsMcpNavigationTree, DocsMcpPage, DocsMcpResolvedConfig, DocsMcpSource, createDocsMcpHttpHandler, createDocsMcpServer, createFilesystemDocsMcpSource, normalizeDocsMcpRoute, resolveDocsMcpConfig, runDocsMcpStdio } from "./mcp.mjs";
|
|
4
4
|
|
|
5
5
|
//#region src/api-reference.d.ts
|
|
@@ -590,7 +590,7 @@ interface DocsMcpToolsConfig {
|
|
|
590
590
|
* Built-in MCP server configuration.
|
|
591
591
|
*
|
|
592
592
|
* When enabled, adapters can expose a Streamable HTTP endpoint for your docs
|
|
593
|
-
* at `/api/docs/mcp`
|
|
593
|
+
* at `/mcp` in Next.js, backed by the canonical `/api/docs/mcp` route. The same config is also reused by the local
|
|
594
594
|
* `docs mcp` stdio command.
|
|
595
595
|
*/
|
|
596
596
|
interface DocsMcpConfig {
|
|
@@ -598,7 +598,7 @@ interface DocsMcpConfig {
|
|
|
598
598
|
enabled?: boolean;
|
|
599
599
|
/**
|
|
600
600
|
* Streamable HTTP route for the MCP endpoint.
|
|
601
|
-
* Defaults to `/api/docs/mcp`.
|
|
601
|
+
* Defaults to `/api/docs/mcp`; Next.js also exposes it publicly at `/mcp`.
|
|
602
602
|
*/
|
|
603
603
|
route?: string;
|
|
604
604
|
/**
|
|
@@ -729,7 +729,7 @@ interface McpDocsSearchConfig {
|
|
|
729
729
|
provider: "mcp";
|
|
730
730
|
enabled?: boolean;
|
|
731
731
|
/**
|
|
732
|
-
* Streamable HTTP MCP endpoint. Relative paths like `/
|
|
732
|
+
* Streamable HTTP MCP endpoint. Relative paths like `/mcp` are resolved
|
|
733
733
|
* against the current docs API request URL.
|
|
734
734
|
*/
|
|
735
735
|
endpoint: string;
|
|
@@ -1592,8 +1592,8 @@ interface DocsConfig {
|
|
|
1592
1592
|
/**
|
|
1593
1593
|
* Built-in MCP server for agent/assistant access to your docs content.
|
|
1594
1594
|
*
|
|
1595
|
-
* - omitted → enable the default MCP surface at `/api/docs/mcp`
|
|
1596
|
-
* - `true` → enable the default MCP surface at `/api/docs/mcp`
|
|
1595
|
+
* - omitted → enable the default MCP surface at `/mcp` in Next.js, backed by `/api/docs/mcp`
|
|
1596
|
+
* - `true` → enable the default MCP surface at `/mcp` in Next.js, backed by `/api/docs/mcp`
|
|
1597
1597
|
* - `{ route: "/api/docs/mcp" }` → enable with explicit route/config
|
|
1598
1598
|
* - `false` or `{ enabled: false }` → disable MCP explicitly
|
|
1599
1599
|
*/
|