@farming-labs/docs 0.0.51 → 0.0.52

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { A as ThemeToggleConfig, C as PageTwitter, D as SidebarNode, E as SidebarFolderNode, M as UIConfig, O as SidebarPageNode, S as PageOpenGraph, T as SidebarConfig, _ as OpenDocsProvider, a as CopyMarkdownConfig, b as PageActionsConfig, c as DocsMetadata, d as FontStyle, f as GithubConfig, g as OpenDocsConfig, h as OGConfig, i as CodeBlockCopyData, j as TypographyConfig, k as SidebarTree, l as DocsNav, m as LlmsTxtConfig, n as ApiReferenceConfig, o as DocsConfig, p as LastUpdatedConfig, r as BreadcrumbConfig, s as DocsI18nConfig, t as AIConfig, u as DocsTheme, v as OpenGraphImage, w as SidebarComponentProps, x as PageFrontmatter, y as OrderingItem } from "./types-BUk4OKUT.mjs";
+import { A as SidebarNode, C as PageActionsConfig, D as SidebarComponentProps, E as PageTwitter, F as UIConfig, M as SidebarTree, N as ThemeToggleConfig, O as SidebarConfig, P as TypographyConfig, S as OrderingItem, T as PageOpenGraph, _ as LlmsTxtConfig, a as CopyMarkdownConfig, b as OpenDocsProvider, c as DocsFeedbackValue, d as DocsNav, f as DocsTheme, g as LastUpdatedConfig, h as GithubConfig, i as CodeBlockCopyData, j as SidebarPageNode, k as SidebarFolderNode, l as DocsI18nConfig, m as FontStyle, n as ApiReferenceConfig, o as DocsConfig, p as FeedbackConfig, r as BreadcrumbConfig, s as DocsFeedbackData, t as AIConfig, u as DocsMetadata, v as OGConfig, w as PageFrontmatter, x as OpenGraphImage, y as OpenDocsConfig } from "./types-CjzUmIVM.mjs";
 
 //#region src/define-docs.d.ts
 /**
@@ -97,4 +97,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 ApiReferenceConfig, type BreadcrumbConfig, type CodeBlockCopyData, type CopyMarkdownConfig, type DocsConfig, type DocsI18nConfig, type DocsMetadata, type DocsNav, type DocsPathMatch, type DocsTheme, type FontStyle, type GithubConfig, type LastUpdatedConfig, type LlmsTxtConfig, type OGConfig, type OpenDocsConfig, type OpenDocsProvider, type OpenGraphImage, type OrderingItem, type PageActionsConfig, type PageFrontmatter, type PageOpenGraph, type PageTwitter, type ResolvedDocsI18n, type SidebarComponentProps, type SidebarConfig, type SidebarFolderNode, type SidebarNode, type SidebarPageNode, type SidebarTree, type ThemeToggleConfig, type TypographyConfig, type UIConfig, buildPageOpenGraph, buildPageTwitter, createTheme, deepMerge, defineDocs, extendTheme, resolveDocsI18n, resolveDocsLocale, resolveDocsPath, resolveOGImage, resolveTitle };
+export { type AIConfig, type ApiReferenceConfig, type BreadcrumbConfig, type CodeBlockCopyData, type CopyMarkdownConfig, type DocsConfig, type DocsFeedbackData, type DocsFeedbackValue, type DocsI18nConfig, type DocsMetadata, type DocsNav, type DocsPathMatch, type DocsTheme, type FeedbackConfig, type FontStyle, type GithubConfig, type LastUpdatedConfig, type LlmsTxtConfig, type OGConfig, type OpenDocsConfig, type OpenDocsProvider, type OpenGraphImage, type OrderingItem, type PageActionsConfig, type PageFrontmatter, type PageOpenGraph, type PageTwitter, type ResolvedDocsI18n, type SidebarComponentProps, type SidebarConfig, type SidebarFolderNode, type SidebarNode, type SidebarPageNode, type SidebarTree, type ThemeToggleConfig, type TypographyConfig, type UIConfig, buildPageOpenGraph, buildPageTwitter, createTheme, deepMerge, defineDocs, extendTheme, resolveDocsI18n, resolveDocsLocale, resolveDocsPath, resolveOGImage, resolveTitle };

package/dist/index.mjs

@@ -14,6 +14,8 @@ function defineDocs(config) {
 		breadcrumb: config.breadcrumb,
 		sidebar: config.sidebar,
 		components: config.components,
+		onCopyClick: config.onCopyClick,
+		feedback: config.feedback,
 		icons: config.icons,
 		pageActions: config.pageActions,
 		lastUpdated: config.lastUpdated,

package/dist/server.d.mts

@@ -1,4 +1,4 @@
-import { n as ApiReferenceConfig, o as DocsConfig } from "./types-BUk4OKUT.mjs";
+import { n as ApiReferenceConfig, o as DocsConfig } from "./types-CjzUmIVM.mjs";
 
 //#region src/api-reference.d.ts
 type HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD";

package/dist/{types-BUk4OKUT.d.mts → types-CjzUmIVM.d.mts}

@@ -999,6 +999,64 @@ interface CodeBlockCopyData {
   /** Language / syntax hint (e.g. "tsx", "bash"), if present */
   language?: string;
 }
+/** Feedback value emitted by the built-in docs page feedback buttons. */
+type DocsFeedbackValue = "positive" | "negative";
+/**
+ * Data passed to the `feedback.onFeedback` callback when the user submits
+ * page feedback from the built-in docs feedback UI.
+ */
+interface DocsFeedbackData {
+  /** Whether the user gave positive or negative feedback. */
+  value: DocsFeedbackValue;
+  /** Optional free-form feedback left by the reader. */
+  comment?: string;
+  /** Current page title, when available. */
+  title?: string;
+  /** Current page description, when available. */
+  description?: string;
+  /** Full current page URL at the time of feedback. */
+  url: string;
+  /** Current URL pathname (without origin). */
+  pathname: string;
+  /** Alias of `pathname` for analytics tools that prefer `path`. */
+  path: string;
+  /** Docs entry root, e.g. `"docs"`. */
+  entry: string;
+  /** Page slug relative to the docs entry, e.g. `"installation"` or `"guides/setup"`. */
+  slug: string;
+  /** Active locale, when docs i18n is enabled. */
+  locale?: string;
+}
+/**
+ * Built-in page feedback configuration.
+ *
+ * When enabled, docs pages render a small feedback prompt at the end of the
+ * content. Clicking a button emits a callback/event with the current page
+ * metadata and the selected sentiment.
+ */
+interface FeedbackConfig {
+  /** Show the feedback UI. Defaults to `true` when this object is provided. */
+  enabled?: boolean;
+  /** Prompt shown above the feedback buttons. @default "How is this guide?" */
+  question?: string;
+  /** Placeholder shown in the optional free-form feedback field. @default "Leave your feedback..." */
+  placeholder?: string;
+  /** Label for the positive button. @default "Good" */
+  positiveLabel?: string;
+  /** Label for the negative button. @default "Bad" */
+  negativeLabel?: string;
+  /** Label for the submit button. @default "Submit" */
+  submitLabel?: string;
+  /**
+   * Callback fired when the user submits the feedback form.
+   *
+   * For client-only frameworks this runs directly in the browser. In
+   * environments where the config cannot be serialized to the client, the same
+   * payload is also emitted through `window.__fdOnFeedback__` and the
+   * `fd:feedback` custom event.
+   */
+  onFeedback?: (data: DocsFeedbackData) => void | Promise<void>;
+}
 interface DocsI18nConfig {
   /** Supported locale identifiers (e.g. ["en", "fr"]). */
   locales: string[];
@@ -1157,6 +1215,29 @@ interface DocsConfig {
    * ```
    */
   onCopyClick?: (data: CodeBlockCopyData) => void;
+  /**
+   * Built-in page feedback prompt shown at the end of a docs page.
+   *
+   * - `false` or `undefined` → hidden (default)
+   * - `true` → shown with default labels
+   * - `{ enabled: true, onFeedback(data) { ... } }` → shown with callback
+   *
+   * @example
+   * ```ts
+   * import type { DocsFeedbackData } from "@farming-labs/docs";
+   *
+   * export default defineDocs({
+   *   entry: "docs",
+   *   feedback: {
+   *     enabled: true,
+   *     onFeedback(data: DocsFeedbackData) {
+   *       console.log("Docs feedback", data.value, data.slug, data.url);
+   *     },
+   *   },
+   * });
+   * ```
+   */
+  feedback?: boolean | FeedbackConfig;
   /**
    * Icon registry for sidebar items.
    *
@@ -1327,4 +1408,4 @@ interface DocsConfig {
   og?: OGConfig;
 }
 //#endregion
-export { ThemeToggleConfig as A, PageTwitter as C, SidebarNode as D, SidebarFolderNode as E, UIConfig as M, SidebarPageNode as O, PageOpenGraph as S, SidebarConfig as T, OpenDocsProvider as _, CopyMarkdownConfig as a, PageActionsConfig as b, DocsMetadata as c, FontStyle as d, GithubConfig as f, OpenDocsConfig as g, OGConfig as h, CodeBlockCopyData as i, TypographyConfig as j, SidebarTree as k, DocsNav as l, LlmsTxtConfig as m, ApiReferenceConfig as n, DocsConfig as o, LastUpdatedConfig as p, BreadcrumbConfig as r, DocsI18nConfig as s, AIConfig as t, DocsTheme as u, OpenGraphImage as v, SidebarComponentProps as w, PageFrontmatter as x, OrderingItem as y };
+export { SidebarNode as A, PageActionsConfig as C, SidebarComponentProps as D, PageTwitter as E, UIConfig as F, SidebarTree as M, ThemeToggleConfig as N, SidebarConfig as O, TypographyConfig as P, OrderingItem as S, PageOpenGraph as T, LlmsTxtConfig as _, CopyMarkdownConfig as a, OpenDocsProvider as b, DocsFeedbackValue as c, DocsNav as d, DocsTheme as f, LastUpdatedConfig as g, GithubConfig as h, CodeBlockCopyData as i, SidebarPageNode as j, SidebarFolderNode as k, DocsI18nConfig as l, FontStyle as m, ApiReferenceConfig as n, DocsConfig as o, FeedbackConfig as p, BreadcrumbConfig as r, DocsFeedbackData as s, AIConfig as t, DocsMetadata as u, OGConfig as v, PageFrontmatter as w, OpenGraphImage as x, OpenDocsConfig as y };

package/package.json

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