@farming-labs/docs 0.1.59 → 0.1.62

package/dist/{types-bAjvrTGU.d.mts → types-DfiAeeHu.d.mts}

@@ -630,6 +630,50 @@ interface PageActionsConfig {
    */
   alignment?: "left" | "right";
 }
+type DocsAnalyticsSource = "client" | "server" | "mcp";
+type DocsAnalyticsEventType = "page_view" | "search_open" | "search_close" | "search_query" | "search_result_click" | "search_error" | "ai_open" | "ai_close" | "ai_question" | "ai_response" | "ai_error" | "ai_clear" | "page_action_copy_markdown" | "page_action_open_docs_menu" | "page_action_open_docs" | "code_block_copy" | "feedback_select" | "feedback_submit" | "feedback_error" | "agent_read" | "agent_spec_request" | "agent_feedback_schema" | "agent_feedback_submit" | "agent_feedback_error" | "markdown_request" | "llms_request" | "skill_request" | "api_search" | "api_ai_request" | "api_ai_response" | "api_ai_error" | "mcp_request" | "mcp_tool";
+interface DocsAnalyticsInput {
+  query?: string;
+  question?: string;
+  feedbackComment?: string;
+  content?: string;
+}
+interface DocsAnalyticsEvent {
+  type: DocsAnalyticsEventType | (string & {});
+  timestamp: string;
+  source: DocsAnalyticsSource;
+  url?: string;
+  path?: string;
+  referrer?: string;
+  locale?: string;
+  input?: DocsAnalyticsInput;
+  properties?: Record<string, unknown>;
+}
+type DocsAnalyticsEventInput = Omit<DocsAnalyticsEvent, "timestamp" | "source"> & {
+  timestamp?: string;
+  source?: DocsAnalyticsSource;
+};
+interface DocsAnalyticsConfig {
+  /** Enable analytics event emission. Defaults to `true` when this object is provided. */
+  enabled?: boolean;
+  /**
+   * Log analytics events to the console.
+   *
+   * `analytics: true` logs with `console.info`. When `onEvent` is provided,
+   * console logging is disabled unless this is set.
+   */
+  console?: boolean | "log" | "info" | "debug";
+  /**
+   * Include raw search queries, AI questions, feedback comments, and copied
+   * content in emitted events.
+   *
+   * Defaults to `false`; events still include safe metadata such as lengths,
+   * counts, routes, status, and duration.
+   */
+  includeInputs?: boolean;
+  /** Callback fired for every analytics event. */
+  onEvent?: (event: DocsAnalyticsEvent) => void | Promise<void>;
+}
 /**
  * Configuration for the "Last updated" date display.
  *
@@ -1624,6 +1668,17 @@ interface DocsConfig {
   staticExport?: boolean;
   /** Theme configuration - single source of truth for UI */
   theme?: DocsTheme;
+  /**
+   * Built-in analytics event stream for docs interactions.
+   *
+   * - `false` or omitted -> analytics disabled (default)
+   * - `true` -> log all framework events to the console
+   * - `{ onEvent(event) { ... } }` -> send events to your analytics sink
+   *
+   * Raw queries, AI questions, feedback comments, and copied content are not
+   * included unless `includeInputs: true` is set.
+   */
+  analytics?: boolean | DocsAnalyticsConfig;
   /**
    * GitHub repository URL or config. Enables "Edit on GitHub" links
    * on each docs page footer, pointing to the source `.mdx` file.
@@ -1989,4 +2044,4 @@ interface DocsConfig {
   og?: OGConfig;
 }
 //#endregion
-export { SidebarComponentProps as $, DocsSearchQuery as A, McpDocsSearchConfig as B, DocsSearchAdapter as C, DocsSearchConfig as D, DocsSearchChunkingConfig as E, FeedbackConfig as F, OrderingItem as G, OpenDocsConfig as H, FontStyle as I, PageOpenGraph as J, PageActionsConfig as K, GithubConfig as L, DocsSearchResultType as M, DocsSearchSourcePage as N, DocsSearchDocument as O, DocsTheme as P, ResolvedDocsRelatedLink as Q, LastUpdatedConfig as R, DocsRelatedItem as S, DocsSearchAdapterFactory as T, OpenDocsProvider as U, OGConfig as V, OpenGraphImage as W, PageTwitter as X, PageSidebarFrontmatter as Y, ReadingTimeConfig as Z, DocsI18nConfig as _, ApiReferenceRenderer as a, SidebarTree as at, DocsMetadata as b, ChangelogFrontmatter as c, TypesenseDocsSearchConfig as ct, CustomDocsSearchConfig as d, SidebarConfig as et, DocsAgentFeedbackContext as f, DocsFeedbackValue as g, DocsFeedbackData as h, ApiReferenceConfig as i, SidebarPageNode as it, DocsSearchResult as j, DocsSearchEmbeddingsConfig as k, CodeBlockCopyData as l, TypographyConfig as lt, DocsConfig as m, AgentFeedbackConfig as n, SidebarFolderNode as nt, BreadcrumbConfig as o, SimpleDocsSearchConfig as ot, DocsAgentFeedbackData as p, PageFrontmatter as q, AlgoliaDocsSearchConfig as r, SidebarNode as rt, ChangelogConfig as s, ThemeToggleConfig as st, AIConfig as t, SidebarFolderIndexBehavior as tt, CopyMarkdownConfig as u, UIConfig as ut, DocsMcpConfig as v, DocsSearchAdapterContext as w, DocsNav as x, DocsMcpToolsConfig as y, LlmsTxtConfig as z };
+export { PageFrontmatter as $, DocsSearchAdapterContext as A, DocsTheme as B, DocsI18nConfig as C, DocsNav as D, DocsMetadata as E, DocsSearchEmbeddingsConfig as F, LlmsTxtConfig as G, FontStyle as H, DocsSearchQuery as I, OpenDocsConfig as J, McpDocsSearchConfig as K, DocsSearchResult as L, DocsSearchChunkingConfig as M, DocsSearchConfig as N, DocsRelatedItem as O, DocsSearchDocument as P, PageActionsConfig as Q, DocsSearchResultType as R, DocsFeedbackValue as S, DocsMcpToolsConfig as T, GithubConfig as U, FeedbackConfig as V, LastUpdatedConfig as W, OpenGraphImage as X, OpenDocsProvider as Y, OrderingItem as Z, DocsAnalyticsEventType as _, ApiReferenceRenderer as a, SidebarComponentProps as at, DocsConfig as b, ChangelogFrontmatter as c, SidebarFolderNode as ct, CustomDocsSearchConfig as d, SidebarTree as dt, PageOpenGraph as et, DocsAgentFeedbackContext as f, SimpleDocsSearchConfig as ft, DocsAnalyticsEventInput as g, UIConfig as gt, DocsAnalyticsEvent as h, TypographyConfig as ht, ApiReferenceConfig as i, ResolvedDocsRelatedLink as it, DocsSearchAdapterFactory as j, DocsSearchAdapter as k, CodeBlockCopyData as l, SidebarNode as lt, DocsAnalyticsConfig as m, TypesenseDocsSearchConfig as mt, AgentFeedbackConfig as n, PageTwitter as nt, BreadcrumbConfig as o, SidebarConfig as ot, DocsAgentFeedbackData as p, ThemeToggleConfig as pt, OGConfig as q, AlgoliaDocsSearchConfig as r, ReadingTimeConfig as rt, ChangelogConfig as s, SidebarFolderIndexBehavior as st, AIConfig as t, PageSidebarFrontmatter as tt, CopyMarkdownConfig as u, SidebarPageNode as ut, DocsAnalyticsInput as v, DocsMcpConfig as w, DocsFeedbackData as x, DocsAnalyticsSource as y, DocsSearchSourcePage as z };

package/dist/{upgrade-a185_G5A.mjs → upgrade-CA_OE7wL.mjs}

@@ -1,4 +1,4 @@
-import { c as installCommand, i as detectPackageManagerFromLockfile, o as exec, s as fileExists, t as detectFramework } from "./utils-CpTFbAiS.mjs";
+import { c as installCommand, i as detectPackageManagerFromLockfile, o as exec, s as fileExists, t as detectFramework } from "./utils-DSMXVnEu.mjs";
 import path from "node:path";
 import pc from "picocolors";
 import * as p from "@clack/prompts";

package/package.json

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

package/dist/search-DWkWwsU5.d.mts

@@ -1,21 +0,0 @@
-import { B as McpDocsSearchConfig, C as DocsSearchAdapter, D as DocsSearchConfig, E as DocsSearchChunkingConfig, N as DocsSearchSourcePage, O as DocsSearchDocument, T as DocsSearchAdapterFactory, ct as TypesenseDocsSearchConfig, d as CustomDocsSearchConfig, j as DocsSearchResult, r as AlgoliaDocsSearchConfig } from "./types-bAjvrTGU.mjs";
-
-//#region src/search.d.ts
-declare function buildDocsSearchDocuments(pages: DocsSearchSourcePage[], chunking?: DocsSearchChunkingConfig): DocsSearchDocument[];
-declare function createSimpleSearchAdapter(): DocsSearchAdapter;
-declare function createTypesenseSearchAdapter(config: TypesenseDocsSearchConfig): DocsSearchAdapter;
-declare function resolveSearchRequestConfig(search: boolean | DocsSearchConfig | undefined, requestUrl?: string): boolean | DocsSearchConfig | undefined;
-declare function createMcpSearchAdapter(config: McpDocsSearchConfig): DocsSearchAdapter;
-declare function createAlgoliaSearchAdapter(config: AlgoliaDocsSearchConfig): DocsSearchAdapter;
-declare function performDocsSearch(options: {
-  pages: DocsSearchSourcePage[];
-  query: string;
-  search?: boolean | DocsSearchConfig;
-  locale?: string;
-  pathname?: string;
-  siteTitle?: string;
-  limit?: number;
-}): Promise<DocsSearchResult[]>;
-declare function createCustomSearchAdapter(adapter: DocsSearchAdapter | DocsSearchAdapterFactory): CustomDocsSearchConfig;
-//#endregion
-export { createSimpleSearchAdapter as a, resolveSearchRequestConfig as c, createMcpSearchAdapter as i, createAlgoliaSearchAdapter as n, createTypesenseSearchAdapter as o, createCustomSearchAdapter as r, performDocsSearch as s, buildDocsSearchDocuments as t };