@farm.js/core 0.1.51-beta.3 → 0.1.61

package/dist/docs.d.mts

@@ -1,169 +0,0 @@
-import { FarmLayoutFonts } from './font.mjs';
-import { bH as FarmDocsResolvedConfig, bq as FarmMCPServerRegistration, cy as FarmDocsUserConfig } from './client-plugins.d-DllmH8eM.mjs';
-export { cr as FarmDocsConfigInput, cs as FarmDocsNavigationConfig, ct as FarmDocsResolvedRoot, cu as FarmDocsRootInput, cv as FarmDocsSidebarItem, cw as FarmDocsSocialImageConfig, cx as FarmDocsSocialImageFonts } from './client-plugins.d-DllmH8eM.mjs';
-import { DocsConfig } from '@farming-labs/docs';
-import './lifecycle.d-C2aLBOwu.mjs';
-import './route.d-BaVH3V0w.mjs';
-import './endpoint.d-BkMSCRf6.mjs';
-import './cache.mjs';
-import './renderer.mjs';
-import './deployment.mjs';
-import 'http';
-import './server-fn.mjs';
-import './server-fn-error.d-DrcH9cc1.mjs';
-import './server-query.mjs';
-import './types.d-BnIqOn9w.mjs';
-import 'db0';
-import 'unstorage';
-import './schema.mjs';
-import 'react';
-import '@farming-labs/orm';
-import './observability.d-B2363jB6.mjs';
-import '@opentelemetry/api';
-import 'vite';
-import './workflows.d-CRMzQZ3k.mjs';
-import './cron.mjs';
-import './env.mjs';
-import './server-action-security.mjs';
-import './layers.d-CcS42OGR.mjs';
-import 'rolldown/utils';
-import 'rolldown';
-import './image-config.d-CeDgNyX4.mjs';
-import './types.d-C41ePjvP.mjs';
-import './config.d-DqKaCr1r.mjs';
-import './types.d-DQnyD3VD.mjs';
-
-interface FarmDocsPublicFontAsset {
-    family: "Geist Sans" | "Geist Mono";
-    url: string;
-}
-
-interface FarmDocsHandlerOptions {
-    root: string;
-    srcDir?: string;
-    clientEntry?: string;
-    fontAssets?: readonly FarmDocsPublicFontAsset[];
-    /** Resolve semantic fonts from the layouts that apply to the requested docs route. */
-    resolveLayoutFonts?: (pathname: string) => FarmLayoutFonts | undefined | Promise<FarmLayoutFonts | undefined>;
-    /** Stylesheet containing the `@font-face` rules generated by Farm's font compiler. */
-    fontStylesheetHref?: string;
-    /** Application-owned global stylesheet, including the selected docs theme CSS import. */
-    globalStylesheetHref?: string;
-    /**
-     * @internal Whether a path-specific guard (non-root middleware.ts, a config or
-     * integration middleware matcher) covers a docs URL such as `/docs/secret`. Such pages
-     * stay out of llms.txt, llms-full.txt, and the sitemaps, and their `.md` URL answers
-     * only when the guard covers it too.
-     */
-    isPathGuarded?: (pathname: string) => boolean;
-}
-interface FarmDocsPage {
-    slug: string;
-    title: string;
-    description?: string;
-    section?: string;
-    href: string;
-    sourcePath: string;
-    lastModified?: string;
-}
-interface LoadedFarmDocsPage extends FarmDocsPage {
-    body: string;
-    frontmatter: Record<string, string>;
-}
-declare function isFarmDocsRequest(docs: FarmDocsResolvedConfig | undefined, request: Request): boolean;
-declare function resolveFarmDocsContentDir(docs: FarmDocsResolvedConfig, options: FarmDocsHandlerOptions): string;
-declare function getFarmDocsRouteTypeEntries(docs: FarmDocsResolvedConfig | undefined): string[];
-declare function getFarmDocsDocumentNavigationMatchers(docs: FarmDocsResolvedConfig | undefined): string[];
-declare function loadFarmDocsPage(contentDir: string, docs: FarmDocsResolvedConfig, slug: string): LoadedFarmDocsPage | null;
-declare function discoverFarmDocsPages(contentDir: string, docs: FarmDocsResolvedConfig): FarmDocsPage[];
-declare function createFarmDocsHandler(docs: FarmDocsResolvedConfig | undefined, options: FarmDocsHandlerOptions): (request: Request) => Promise<Response | null>;
-
-interface FarmDocsAdapterHandlerOptions {
-    root: string;
-    srcDir?: string;
-    clientEntry: string;
-    fontStylesheetHref?: string;
-    globalStylesheetHref?: string;
-    resolveLayoutFonts?: (pathname: string) => FarmLayoutFonts | undefined | Promise<FarmLayoutFonts | undefined>;
-    loadModule: (specifier: string) => Promise<any>;
-    /**
-     * Lists the adapter's MCP endpoint in the app's AI catalog. The adapter knows its
-     * route, name, and version; older adapters ignore it and older hosts do not pass it.
-     */
-    registerMCPServer?: (server: FarmMCPServerRegistration) => () => void;
-    /** The app's path guards; a guarded docs page refuses the adapter. */
-    isPathGuarded?: (pathname: string) => boolean;
-}
-declare function hasFarmDocsRuntimeAdapter(docs: FarmDocsResolvedConfig | undefined): docs is FarmDocsResolvedConfig & {
-    adapter: NonNullable<FarmDocsResolvedConfig["adapter"]>;
-};
-/**
- * The docs config module's config for the docs root at `entry`: the module's own fields, with
- * the root of that entry from its `roots` over them. The development and production servers
- * both read the module through it.
- *
- * @internal
- */
-declare function getFarmDocsConfigModuleRoot(moduleConfig: object, entry: string): Record<string, unknown>;
-/**
- * Load a documentation runtime through the versioned adapter descriptor.
- *
- * Core deliberately knows nothing about the adapter's DOM or theme. It only
- * supplies host assets, Vite's module loader, and a way to list the adapter's MCP
- * endpoint in the AI catalog; the adapter returns the final Web Request handler.
- */
-declare function createFarmDocsAdapterHandler(docs: FarmDocsResolvedConfig, options: FarmDocsAdapterHandlerOptions): Promise<(request: Request) => Promise<Response | null>>;
-
-interface FarmDocsAPIOptions {
-    rootDir?: string;
-    root?: string;
-    srcDir?: string;
-    docs?: FarmDocsUserConfig | FarmDocsResolvedConfig;
-    config?: Partial<DocsConfig>;
-    configPath?: string;
-    entry?: string;
-    docsPath?: string;
-    contentDir?: string;
-    /**
-     * Serve `format=diagnostics`, which reports absolute filesystem paths. Farm enables
-     * it on the development server only; production handlers answer 404.
-     */
-    diagnostics?: boolean;
-    /**
-     * @internal Whether a path-specific guard (non-root middleware.ts, a config or
-     * integration middleware matcher) covers a docs URL such as `/docs/secret`. The API
-     * answers anyone, so such a page is left out of search, llms, the sitemaps, and the
-     * agent spec, and reading its Markdown here is a 404. Farm's server sets this.
-     */
-    isPathGuarded?: (pathname: string) => boolean;
-}
-interface FarmDocsCloudRouteOptions {
-    locale?: string;
-    publicBaseUrl?: string;
-}
-interface FarmDocsCloudServer {
-    handleRequest(request: Request, options?: FarmDocsCloudRouteOptions): Promise<Response>;
-}
-type FarmDocsCloudIntegration = FarmDocsCloudServer | (FarmDocsCloudRouteOptions & {
-    docsCloud?: FarmDocsCloudServer;
-});
-interface FarmDocsAPIRouteHandlers {
-    GET(request: Request): Promise<Response>;
-    POST(request: Request): Promise<Response>;
-}
-type FarmDocsAPIHandler = (request: Request) => Promise<Response | null>;
-type FarmDocsRuntimeConfig = {
-    root?: string;
-    srcDir?: string;
-    docs?: FarmDocsResolvedConfig;
-    /** Docs URLs a path-specific guard covers, decided when the app was built. */
-    guardedPaths?: readonly string[];
-};
-declare global {
-    var __FARM_DOCS_RUNTIME_CONFIG__: FarmDocsRuntimeConfig | undefined;
-}
-declare function isFarmDocsAPIRequest(requestOrPathname: Request | string): boolean;
-declare function createDocsAPI(options?: FarmDocsAPIOptions, cloudIntegration?: FarmDocsCloudIntegration): FarmDocsAPIRouteHandlers;
-declare function createFarmDocsAPIHandler(options?: FarmDocsAPIOptions, cloudIntegration?: FarmDocsCloudIntegration): FarmDocsAPIHandler;
-
-export { type FarmDocsAPIHandler, type FarmDocsAPIOptions, type FarmDocsAPIRouteHandlers, type FarmDocsAdapterHandlerOptions, type FarmDocsCloudIntegration, type FarmDocsCloudRouteOptions, type FarmDocsCloudServer, type FarmDocsHandlerOptions, type FarmDocsPage, FarmDocsResolvedConfig, FarmDocsUserConfig, type LoadedFarmDocsPage, createDocsAPI, createFarmDocsAPIHandler, createFarmDocsAdapterHandler, createFarmDocsHandler, discoverFarmDocsPages, getFarmDocsConfigModuleRoot, getFarmDocsDocumentNavigationMatchers, getFarmDocsRouteTypeEntries, hasFarmDocsRuntimeAdapter, isFarmDocsAPIRequest, isFarmDocsRequest, loadFarmDocsPage, resolveFarmDocsContentDir };

package/dist/docs.d.ts

@@ -1,169 +0,0 @@
-import { FarmLayoutFonts } from './font.js';
-import { bH as FarmDocsResolvedConfig, bq as FarmMCPServerRegistration, cy as FarmDocsUserConfig } from './client-plugins.d-n3iWY1EJ.js';
-export { cr as FarmDocsConfigInput, cs as FarmDocsNavigationConfig, ct as FarmDocsResolvedRoot, cu as FarmDocsRootInput, cv as FarmDocsSidebarItem, cw as FarmDocsSocialImageConfig, cx as FarmDocsSocialImageFonts } from './client-plugins.d-n3iWY1EJ.js';
-import { DocsConfig } from '@farming-labs/docs';
-import './lifecycle.d-C2aLBOwu.js';
-import './route.d-DBTEqifW.js';
-import './endpoint.d-BgHn0lhl.js';
-import './cache.js';
-import './renderer.js';
-import './deployment.js';
-import 'http';
-import './server-fn.js';
-import './server-fn-error.d-DrcH9cc1.js';
-import './server-query.js';
-import './types.d-BnIqOn9w.js';
-import 'db0';
-import 'unstorage';
-import './schema.js';
-import 'react';
-import '@farming-labs/orm';
-import './observability.d-B2363jB6.js';
-import '@opentelemetry/api';
-import 'vite';
-import './workflows.d-CRMzQZ3k.js';
-import './cron.js';
-import './env.js';
-import './server-action-security.js';
-import './layers.d-CcS42OGR.js';
-import 'rolldown/utils';
-import 'rolldown';
-import './image-config.d-CeDgNyX4.js';
-import './types.d-C41ePjvP.js';
-import './config.d-DqKaCr1r.js';
-import './types.d-DQnyD3VD.js';
-
-interface FarmDocsPublicFontAsset {
-    family: "Geist Sans" | "Geist Mono";
-    url: string;
-}
-
-interface FarmDocsHandlerOptions {
-    root: string;
-    srcDir?: string;
-    clientEntry?: string;
-    fontAssets?: readonly FarmDocsPublicFontAsset[];
-    /** Resolve semantic fonts from the layouts that apply to the requested docs route. */
-    resolveLayoutFonts?: (pathname: string) => FarmLayoutFonts | undefined | Promise<FarmLayoutFonts | undefined>;
-    /** Stylesheet containing the `@font-face` rules generated by Farm's font compiler. */
-    fontStylesheetHref?: string;
-    /** Application-owned global stylesheet, including the selected docs theme CSS import. */
-    globalStylesheetHref?: string;
-    /**
-     * @internal Whether a path-specific guard (non-root middleware.ts, a config or
-     * integration middleware matcher) covers a docs URL such as `/docs/secret`. Such pages
-     * stay out of llms.txt, llms-full.txt, and the sitemaps, and their `.md` URL answers
-     * only when the guard covers it too.
-     */
-    isPathGuarded?: (pathname: string) => boolean;
-}
-interface FarmDocsPage {
-    slug: string;
-    title: string;
-    description?: string;
-    section?: string;
-    href: string;
-    sourcePath: string;
-    lastModified?: string;
-}
-interface LoadedFarmDocsPage extends FarmDocsPage {
-    body: string;
-    frontmatter: Record<string, string>;
-}
-declare function isFarmDocsRequest(docs: FarmDocsResolvedConfig | undefined, request: Request): boolean;
-declare function resolveFarmDocsContentDir(docs: FarmDocsResolvedConfig, options: FarmDocsHandlerOptions): string;
-declare function getFarmDocsRouteTypeEntries(docs: FarmDocsResolvedConfig | undefined): string[];
-declare function getFarmDocsDocumentNavigationMatchers(docs: FarmDocsResolvedConfig | undefined): string[];
-declare function loadFarmDocsPage(contentDir: string, docs: FarmDocsResolvedConfig, slug: string): LoadedFarmDocsPage | null;
-declare function discoverFarmDocsPages(contentDir: string, docs: FarmDocsResolvedConfig): FarmDocsPage[];
-declare function createFarmDocsHandler(docs: FarmDocsResolvedConfig | undefined, options: FarmDocsHandlerOptions): (request: Request) => Promise<Response | null>;
-
-interface FarmDocsAdapterHandlerOptions {
-    root: string;
-    srcDir?: string;
-    clientEntry: string;
-    fontStylesheetHref?: string;
-    globalStylesheetHref?: string;
-    resolveLayoutFonts?: (pathname: string) => FarmLayoutFonts | undefined | Promise<FarmLayoutFonts | undefined>;
-    loadModule: (specifier: string) => Promise<any>;
-    /**
-     * Lists the adapter's MCP endpoint in the app's AI catalog. The adapter knows its
-     * route, name, and version; older adapters ignore it and older hosts do not pass it.
-     */
-    registerMCPServer?: (server: FarmMCPServerRegistration) => () => void;
-    /** The app's path guards; a guarded docs page refuses the adapter. */
-    isPathGuarded?: (pathname: string) => boolean;
-}
-declare function hasFarmDocsRuntimeAdapter(docs: FarmDocsResolvedConfig | undefined): docs is FarmDocsResolvedConfig & {
-    adapter: NonNullable<FarmDocsResolvedConfig["adapter"]>;
-};
-/**
- * The docs config module's config for the docs root at `entry`: the module's own fields, with
- * the root of that entry from its `roots` over them. The development and production servers
- * both read the module through it.
- *
- * @internal
- */
-declare function getFarmDocsConfigModuleRoot(moduleConfig: object, entry: string): Record<string, unknown>;
-/**
- * Load a documentation runtime through the versioned adapter descriptor.
- *
- * Core deliberately knows nothing about the adapter's DOM or theme. It only
- * supplies host assets, Vite's module loader, and a way to list the adapter's MCP
- * endpoint in the AI catalog; the adapter returns the final Web Request handler.
- */
-declare function createFarmDocsAdapterHandler(docs: FarmDocsResolvedConfig, options: FarmDocsAdapterHandlerOptions): Promise<(request: Request) => Promise<Response | null>>;
-
-interface FarmDocsAPIOptions {
-    rootDir?: string;
-    root?: string;
-    srcDir?: string;
-    docs?: FarmDocsUserConfig | FarmDocsResolvedConfig;
-    config?: Partial<DocsConfig>;
-    configPath?: string;
-    entry?: string;
-    docsPath?: string;
-    contentDir?: string;
-    /**
-     * Serve `format=diagnostics`, which reports absolute filesystem paths. Farm enables
-     * it on the development server only; production handlers answer 404.
-     */
-    diagnostics?: boolean;
-    /**
-     * @internal Whether a path-specific guard (non-root middleware.ts, a config or
-     * integration middleware matcher) covers a docs URL such as `/docs/secret`. The API
-     * answers anyone, so such a page is left out of search, llms, the sitemaps, and the
-     * agent spec, and reading its Markdown here is a 404. Farm's server sets this.
-     */
-    isPathGuarded?: (pathname: string) => boolean;
-}
-interface FarmDocsCloudRouteOptions {
-    locale?: string;
-    publicBaseUrl?: string;
-}
-interface FarmDocsCloudServer {
-    handleRequest(request: Request, options?: FarmDocsCloudRouteOptions): Promise<Response>;
-}
-type FarmDocsCloudIntegration = FarmDocsCloudServer | (FarmDocsCloudRouteOptions & {
-    docsCloud?: FarmDocsCloudServer;
-});
-interface FarmDocsAPIRouteHandlers {
-    GET(request: Request): Promise<Response>;
-    POST(request: Request): Promise<Response>;
-}
-type FarmDocsAPIHandler = (request: Request) => Promise<Response | null>;
-type FarmDocsRuntimeConfig = {
-    root?: string;
-    srcDir?: string;
-    docs?: FarmDocsResolvedConfig;
-    /** Docs URLs a path-specific guard covers, decided when the app was built. */
-    guardedPaths?: readonly string[];
-};
-declare global {
-    var __FARM_DOCS_RUNTIME_CONFIG__: FarmDocsRuntimeConfig | undefined;
-}
-declare function isFarmDocsAPIRequest(requestOrPathname: Request | string): boolean;
-declare function createDocsAPI(options?: FarmDocsAPIOptions, cloudIntegration?: FarmDocsCloudIntegration): FarmDocsAPIRouteHandlers;
-declare function createFarmDocsAPIHandler(options?: FarmDocsAPIOptions, cloudIntegration?: FarmDocsCloudIntegration): FarmDocsAPIHandler;
-
-export { type FarmDocsAPIHandler, type FarmDocsAPIOptions, type FarmDocsAPIRouteHandlers, type FarmDocsAdapterHandlerOptions, type FarmDocsCloudIntegration, type FarmDocsCloudRouteOptions, type FarmDocsCloudServer, type FarmDocsHandlerOptions, type FarmDocsPage, FarmDocsResolvedConfig, FarmDocsUserConfig, type LoadedFarmDocsPage, createDocsAPI, createFarmDocsAPIHandler, createFarmDocsAdapterHandler, createFarmDocsHandler, discoverFarmDocsPages, getFarmDocsConfigModuleRoot, getFarmDocsDocumentNavigationMatchers, getFarmDocsRouteTypeEntries, hasFarmDocsRuntimeAdapter, isFarmDocsAPIRequest, isFarmDocsRequest, loadFarmDocsPage, resolveFarmDocsContentDir };