@farming-labs/docs 0.1.19 → 0.1.21

package/dist/index.d.mts

@@ -1,5 +1,5 @@
-import { $ as ThemeToggleConfig, A as DocsTheme, B as OpenGraphImage, C as DocsSearchConfig, D as DocsSearchResult, E as DocsSearchQuery, F as LlmsTxtConfig, G as PageTwitter, H as PageActionsConfig, I as McpDocsSearchConfig, J as SidebarFolderNode, K as SidebarComponentProps, L as OGConfig, M as FontStyle, N as GithubConfig, O as DocsSearchResultType, P as LastUpdatedConfig, Q as SimpleDocsSearchConfig, R as OpenDocsConfig, S as DocsSearchChunkingConfig, T as DocsSearchEmbeddingsConfig, U as PageFrontmatter, V as OrderingItem, W as PageOpenGraph, X as SidebarPageNode, Y as SidebarNode, Z as SidebarTree, _ as DocsMetadata, a as BreadcrumbConfig, b as DocsSearchAdapterContext, c as CodeBlockCopyData, d as DocsConfig, et as TypesenseDocsSearchConfig, f as DocsFeedbackData, g as DocsMcpToolsConfig, h as DocsMcpConfig, i as ApiReferenceRenderer, j as FeedbackConfig, k as DocsSearchSourcePage, l as CopyMarkdownConfig, m as DocsI18nConfig, n as AlgoliaDocsSearchConfig, nt as UIConfig, o as ChangelogConfig, p as DocsFeedbackValue, q as SidebarConfig, r as ApiReferenceConfig, s as ChangelogFrontmatter, t as AIConfig, tt as TypographyConfig, u as CustomDocsSearchConfig, v as DocsNav, w as DocsSearchDocument, x as DocsSearchAdapterFactory, y as DocsSearchAdapter, z as OpenDocsProvider } from "./types-Du01bck0.mjs";
-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-CzTO1EMx.mjs";
+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-PtqFsv4_.mjs";
+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-BHH5dMjh.mjs";
 
 //#region src/define-docs.d.ts
 /**
@@ -115,4 +115,4 @@ declare function buildPageOpenGraph(page: Pick<PageFrontmatter, "title" | "descr
  */
 declare function buildPageTwitter(page: Pick<PageFrontmatter, "title" | "description" | "ogImage" | "openGraph" | "twitter">, ogConfig?: OGConfig, baseUrl?: string): PageTwitter | undefined;
 //#endregion
-export { type AIConfig, type AlgoliaDocsSearchConfig, type ApiReferenceConfig, type ApiReferenceRenderer, type BreadcrumbConfig, type ChangelogConfig, type ChangelogEntrySummary, type ChangelogFrontmatter, type CodeBlockCopyData, type CopyMarkdownConfig, type CustomDocsSearchConfig, type DocsConfig, type DocsFeedbackData, type DocsFeedbackValue, type DocsI18nConfig, type DocsMcpConfig, type DocsMcpToolsConfig, type DocsMetadata, type DocsNav, type DocsPathMatch, type DocsSearchAdapter, type DocsSearchAdapterContext, type DocsSearchAdapterFactory, type DocsSearchChunkingConfig, type DocsSearchConfig, type DocsSearchDocument, type DocsSearchEmbeddingsConfig, type DocsSearchQuery, type DocsSearchResult, type DocsSearchResultType, type DocsSearchSourcePage, type DocsTheme, type FeedbackConfig, type FontStyle, type GithubConfig, type LastUpdatedConfig, type LlmsTxtConfig, type McpDocsSearchConfig, type OGConfig, type OpenDocsConfig, type OpenDocsProvider, type OpenGraphImage, type OrderingItem, type PageActionsConfig, type PageFrontmatter, type PageOpenGraph, type PageTwitter, type ResolvedChangelogConfig, type ResolvedDocsI18n, type SidebarComponentProps, type SidebarConfig, type SidebarFolderNode, type SidebarNode, type SidebarPageNode, type SidebarTree, type SimpleDocsSearchConfig, type ThemeToggleConfig, type TypesenseDocsSearchConfig, type TypographyConfig, type UIConfig, buildDocsSearchDocuments, buildPageOpenGraph, buildPageTwitter, createAlgoliaSearchAdapter, createCustomSearchAdapter, createMcpSearchAdapter, createSimpleSearchAdapter, createTheme, createTypesenseSearchAdapter, deepMerge, defineDocs, extendTheme, performDocsSearch, resolveChangelogConfig, resolveDocsI18n, resolveDocsLocale, resolveDocsPath, resolveOGImage, resolveSearchRequestConfig, resolveTitle };
+export { type AIConfig, type AgentFeedbackConfig, type AlgoliaDocsSearchConfig, type ApiReferenceConfig, type ApiReferenceRenderer, type BreadcrumbConfig, type ChangelogConfig, type ChangelogEntrySummary, type ChangelogFrontmatter, type CodeBlockCopyData, type CopyMarkdownConfig, type CustomDocsSearchConfig, type DocsAgentFeedbackContext, type DocsAgentFeedbackData, type DocsConfig, type DocsFeedbackData, type DocsFeedbackValue, type DocsI18nConfig, type DocsMcpConfig, type DocsMcpToolsConfig, type DocsMetadata, type DocsNav, type DocsPathMatch, type DocsSearchAdapter, type DocsSearchAdapterContext, type DocsSearchAdapterFactory, type DocsSearchChunkingConfig, type DocsSearchConfig, type DocsSearchDocument, type DocsSearchEmbeddingsConfig, type DocsSearchQuery, type DocsSearchResult, type DocsSearchResultType, type DocsSearchSourcePage, type DocsTheme, type FeedbackConfig, type FontStyle, type GithubConfig, type LastUpdatedConfig, type LlmsTxtConfig, type McpDocsSearchConfig, type OGConfig, type OpenDocsConfig, type OpenDocsProvider, type OpenGraphImage, type OrderingItem, type PageActionsConfig, type PageFrontmatter, type PageOpenGraph, type PageTwitter, type ResolvedChangelogConfig, type ResolvedDocsI18n, type SidebarComponentProps, type SidebarConfig, type SidebarFolderNode, type SidebarNode, type SidebarPageNode, type SidebarTree, type SimpleDocsSearchConfig, type ThemeToggleConfig, type TypesenseDocsSearchConfig, type TypographyConfig, type UIConfig, buildDocsSearchDocuments, buildPageOpenGraph, buildPageTwitter, createAlgoliaSearchAdapter, createCustomSearchAdapter, createMcpSearchAdapter, createSimpleSearchAdapter, createTheme, createTypesenseSearchAdapter, deepMerge, defineDocs, extendTheme, performDocsSearch, resolveChangelogConfig, resolveDocsI18n, resolveDocsLocale, resolveDocsPath, resolveOGImage, resolveSearchRequestConfig, resolveTitle };

package/dist/mcp.d.mts

@@ -1,4 +1,4 @@
-import { C as DocsSearchConfig, V as OrderingItem, h as DocsMcpConfig } from "./types-Du01bck0.mjs";
+import { E as DocsSearchConfig, W as OrderingItem, v as DocsMcpConfig } from "./types-PtqFsv4_.mjs";
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 
 //#region src/mcp.d.ts

package/dist/{search-CzTO1EMx.d.mts → search-BHH5dMjh.d.mts}

@@ -1,4 +1,4 @@
-import { C as DocsSearchConfig, D as DocsSearchResult, I as McpDocsSearchConfig, S as DocsSearchChunkingConfig, et as TypesenseDocsSearchConfig, k as DocsSearchSourcePage, n as AlgoliaDocsSearchConfig, u as CustomDocsSearchConfig, w as DocsSearchDocument, x as DocsSearchAdapterFactory, y as DocsSearchAdapter } from "./types-Du01bck0.mjs";
+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-PtqFsv4_.mjs";
 
 //#region src/search.d.ts
 declare function buildDocsSearchDocuments(pages: DocsSearchSourcePage[], chunking?: DocsSearchChunkingConfig): DocsSearchDocument[];

package/dist/server.d.mts

@@ -1,5 +1,5 @@
-import { C as DocsSearchConfig, D as DocsSearchResult, E as DocsSearchQuery, I as McpDocsSearchConfig, b as DocsSearchAdapterContext, d as DocsConfig, i as ApiReferenceRenderer, k as DocsSearchSourcePage, w as DocsSearchDocument, x as DocsSearchAdapterFactory, y as DocsSearchAdapter } from "./types-Du01bck0.mjs";
-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-CzTO1EMx.mjs";
+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-PtqFsv4_.mjs";
+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-BHH5dMjh.mjs";
 import { DocsMcpHttpHandlers, DocsMcpNavigationNode, DocsMcpNavigationTree, DocsMcpPage, DocsMcpResolvedConfig, DocsMcpSource, createDocsMcpHttpHandler, createDocsMcpServer, createFilesystemDocsMcpSource, normalizeDocsMcpRoute, resolveDocsMcpConfig, runDocsMcpStdio } from "./mcp.mjs";
 
 //#region src/api-reference.d.ts

package/dist/{types-Du01bck0.d.mts → types-PtqFsv4_.d.mts}

@@ -1212,6 +1212,69 @@ interface DocsFeedbackData {
   /** Active locale, when docs i18n is enabled. */
   locale?: string;
 }
+/**
+ * Page and transport context supplied alongside agent feedback payloads.
+ *
+ * The `payload` itself is customizable through `feedback.agent.schema`; this
+ * context object keeps a small stable envelope for route-aware metadata.
+ */
+interface DocsAgentFeedbackContext {
+  /** Docs page path, e.g. `"/docs/installation"`. */
+  page?: string;
+  /** Full docs URL, when the caller has one available. */
+  url?: string;
+  /** Docs slug relative to the entry root, e.g. `"installation"`. */
+  slug?: string;
+  /** Active locale when docs i18n is enabled. */
+  locale?: string;
+  /** Arbitrary source label such as `"md-route"`, `"mcp"`, or `"api"`. */
+  source?: string;
+}
+/**
+ * Data passed to `feedback.agent.onFeedback`.
+ *
+ * The request body always follows the stable `{ context?, payload }` envelope
+ * while `payload` stays schema-driven so projects can add or remove agent
+ * fields without changing the callback contract.
+ */
+interface DocsAgentFeedbackData {
+  /** Optional docs/page context associated with the agent feedback. */
+  context?: DocsAgentFeedbackContext;
+  /** Arbitrary payload validated by the configured agent feedback schema. */
+  payload: Record<string, unknown>;
+}
+/**
+ * Agent feedback endpoint configuration served through the shared `/api/docs`
+ * route wrapper.
+ */
+interface AgentFeedbackConfig {
+  /** Enable the agent feedback endpoints. Defaults to `true` when provided. */
+  enabled?: boolean;
+  /**
+   * Public HTTP route for posting agent feedback.
+   * @default "/api/docs/agent/feedback"
+   */
+  route?: string;
+  /**
+   * Public HTTP route for the machine-readable schema describing the agent
+   * feedback payload.
+   *
+   * Defaults to `${route}/schema`.
+   */
+  schemaRoute?: string;
+  /**
+   * JSON Schema object describing the `payload` field of the request body.
+   *
+   * The shared docs API wraps this under a stable top-level envelope:
+   * `{ context?: DocsAgentFeedbackContext, payload: <schema> }`.
+   */
+  schema?: Record<string, unknown>;
+  /**
+   * Async callback fired when the agent feedback endpoint receives a valid
+   * `{ context?, payload }` body.
+   */
+  onFeedback?: (data: DocsAgentFeedbackData) => void | Promise<void>;
+}
 /**
  * Built-in page feedback configuration.
  *
@@ -1241,6 +1304,14 @@ interface FeedbackConfig {
    * `fd:feedback` custom event.
    */
   onFeedback?: (data: DocsFeedbackData) => void | Promise<void>;
+  /**
+   * Machine-oriented feedback endpoints exposed through the shared `/api/docs`
+   * route when configured.
+   *
+   * This does not enable the human page feedback UI by itself. To show the
+   * built-in footer prompt, keep using `feedback: true` or `feedback.enabled`.
+   */
+  agent?: boolean | AgentFeedbackConfig;
 }
 interface DocsI18nConfig {
   /** Supported locale identifiers (e.g. ["en", "fr"]). */
@@ -1740,4 +1811,4 @@ interface DocsConfig {
   og?: OGConfig;
 }
 //#endregion
-export { ThemeToggleConfig as $, DocsTheme as A, OpenGraphImage as B, DocsSearchConfig as C, DocsSearchResult as D, DocsSearchQuery as E, LlmsTxtConfig as F, PageTwitter as G, PageActionsConfig as H, McpDocsSearchConfig as I, SidebarFolderNode as J, SidebarComponentProps as K, OGConfig as L, FontStyle as M, GithubConfig as N, DocsSearchResultType as O, LastUpdatedConfig as P, SimpleDocsSearchConfig as Q, OpenDocsConfig as R, DocsSearchChunkingConfig as S, DocsSearchEmbeddingsConfig as T, PageFrontmatter as U, OrderingItem as V, PageOpenGraph as W, SidebarPageNode as X, SidebarNode as Y, SidebarTree as Z, DocsMetadata as _, BreadcrumbConfig as a, DocsSearchAdapterContext as b, CodeBlockCopyData as c, DocsConfig as d, TypesenseDocsSearchConfig as et, DocsFeedbackData as f, DocsMcpToolsConfig as g, DocsMcpConfig as h, ApiReferenceRenderer as i, FeedbackConfig as j, DocsSearchSourcePage as k, CopyMarkdownConfig as l, DocsI18nConfig as m, AlgoliaDocsSearchConfig as n, UIConfig as nt, ChangelogConfig as o, DocsFeedbackValue as p, SidebarConfig as q, ApiReferenceConfig as r, ChangelogFrontmatter as s, AIConfig as t, TypographyConfig as tt, CustomDocsSearchConfig as u, DocsNav as v, DocsSearchDocument as w, DocsSearchAdapterFactory as x, DocsSearchAdapter as y, OpenDocsProvider as z };
+export { SidebarPageNode as $, DocsSearchResult as A, OGConfig as B, DocsSearchAdapterContext as C, DocsSearchDocument as D, DocsSearchConfig as E, FontStyle as F, PageActionsConfig as G, OpenDocsProvider as H, GithubConfig as I, PageTwitter as J, PageFrontmatter as K, LastUpdatedConfig as L, DocsSearchSourcePage as M, DocsTheme as N, DocsSearchEmbeddingsConfig as O, FeedbackConfig as P, SidebarNode as Q, LlmsTxtConfig as R, DocsSearchAdapter as S, DocsSearchChunkingConfig as T, OpenGraphImage as U, OpenDocsConfig as V, OrderingItem as W, SidebarConfig as X, SidebarComponentProps as Y, SidebarFolderNode as Z, DocsI18nConfig as _, ApiReferenceRenderer as a, UIConfig as at, DocsMetadata as b, ChangelogFrontmatter as c, CustomDocsSearchConfig as d, SidebarTree as et, DocsAgentFeedbackContext as f, DocsFeedbackValue as g, DocsFeedbackData as h, ApiReferenceConfig as i, TypographyConfig as it, DocsSearchResultType as j, DocsSearchQuery as k, CodeBlockCopyData as l, DocsConfig as m, AgentFeedbackConfig as n, ThemeToggleConfig as nt, BreadcrumbConfig as o, DocsAgentFeedbackData as p, PageOpenGraph as q, AlgoliaDocsSearchConfig as r, TypesenseDocsSearchConfig as rt, ChangelogConfig as s, AIConfig as t, SimpleDocsSearchConfig as tt, CopyMarkdownConfig as u, DocsMcpConfig as v, DocsSearchAdapterFactory as w, DocsNav as x, DocsMcpToolsConfig as y, McpDocsSearchConfig as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farming-labs/docs",
-  "version": "0.1.19",
+  "version": "0.1.21",
   "description": "Modern, flexible MDX-based docs framework — core types, config, and CLI",
   "keywords": [
     "docs",