@farm.js/core 0.1.60 → 0.1.61

package/dist/production-vite.d-BQFAlG7n.d.ts

@@ -1,13 +0,0 @@
-import { build, createServer, loadEnv } from 'vite';
-
-type FarmProductionViteBuilder = "rolldown";
-interface FarmProductionViteRuntime {
-    build: typeof build;
-    createServer: typeof createServer;
-    loadEnv: typeof loadEnv;
-    builder: FarmProductionViteBuilder;
-}
-/** Load the Vite runtime Farm uses for development, route discovery, and production bundles. */
-declare function loadFarmProductionVite(): Promise<FarmProductionViteRuntime>;
-
-export { type FarmProductionViteRuntime as F, loadFarmProductionVite as l };

package/dist/programmatic-routes-client.d-CLG2N1yH.d.ts

@@ -1,192 +0,0 @@
-import { R as RouteRenderingOptions, D as DirectiveRenderingConfig, a as RouteRenderingConfig } from './route-rendering.d-Iss0C7GR.js';
-import { i as RouteModule, b6 as SSGCollectionResult, b7 as SSGPage } from './client-plugins.d-vXrbcfJ1.js';
-
-/**
- * Farm.js SSG (Static Site Generation) Module
- *
- * Handles collection and pre-rendering of SSG pages at build time.
- *
- * SSR is the default - pages render on each request
- * SSG is opt-in via `export const ssg = true`, Next-compatible route
- * config exports, or a top-of-file rendering directive.
- *
- * @example
- * ```tsx
- * // SSG Page
- * export const ssg = true;
- * export default function AboutPage() {
- *   return <h1>About</h1>;
- * }
- *
- * // SSG with ISR
- * export const ssg = true;
- * export const revalidate = 60;
- * export default async function ProductsPage() {
- *   const products = await fetchProducts();
- *   return <ProductList products={products} />;
- * }
- *
- * // Dynamic SSG
- * export const ssg = true;
- * export async function getStaticPaths() {
- *   const posts = await fetchPosts();
- *   return posts.map(post => ({ slug: post.slug }));
- * }
- * export default async function BlogPost({ params }) {
- *   return <article>{params.slug}</article>;
- * }
- *
- * // Next-compatible route config
- * export const dynamic = "force-static";
- * export const revalidate = 60;
- *
- * // PPR/static-shell route
- * export const experimental_ppr = true;
- * export const revalidate = 60;
- *
- * // Directive config
- * "use ssg; 60";
- * export default function DocsPage() {
- *   return <h1>Docs</h1>;
- * }
- * ```
- */
-
-interface RouteEntry {
-    path: string;
-    filePath: string;
-    isDynamic: boolean;
-    pattern: string;
-}
-
-interface StaticRouteCandidateAnalysis {
-    candidate: boolean;
-    blockers: string[];
-}
-/**
- * Resolve the effective rendering mode. Direct request reads make an explicitly
- * static route dynamic so request-specific HTML cannot enter a shared artifact.
- */
-declare function resolveRouteRenderingConfig(mod: RouteModule | null | undefined, source?: string, options?: RouteRenderingOptions): RouteRenderingConfig;
-declare function resolveRouteRenderingConfigFromFile(mod: RouteModule | null | undefined, filePath: string, options?: RouteRenderingOptions): Promise<RouteRenderingConfig>;
-/**
- * Conservatively identify a route that may be safe to pre-render.
- *
- * This intentionally produces a suggestion rather than changing rendering:
- * request-bound work can live in a transitive import, which source inspection
- * of the route module cannot prove safe. Explicit route config always wins.
- */
-declare function analyzeStaticRouteCandidate(mod: RouteModule | null | undefined, source: string | undefined, options?: {
-    isDynamic?: boolean;
-}): StaticRouteCandidateAnalysis;
-declare function findRequestBoundSourceBlockers(source: string): string[];
-declare function parseRouteRenderingDirective(source: string | undefined): DirectiveRenderingConfig | undefined;
-/**
- * A route's rendering directive as the production runtime needs it: the parsed directive plus
- * whether its source reads request state. The runtime only sees module exports, so the build
- * decides `requestBound` here and bakes it into the generated server entry, where
- * `mergeRouteRenderingDirectiveConfig` combines it with the module's exports.
- */
-declare function readRouteRenderingDirectiveFromFile(modulePath: string): DirectiveRenderingConfig | undefined;
-/**
- * Collect SSG pages from route modules
- *
- * Scans all routes and categorizes them into:
- * - SSG pages: Pre-rendered at build time
- * - SSR routes: Rendered on each request
- *
- * @param routes - Array of route entries
- * @param loadModule - Function to load a route module
- * @returns SSG pages and SSR routes
- */
-declare function collectSSGPages(routes: RouteEntry[], loadModule: (filePath: string) => Promise<RouteModule>, options?: {
-    suggestStaticRendering?: boolean;
-    /**
-     * Routes a docs adapter renders, which ignore route config: a static candidate among them
-     * is pointed at `docs.prerender` instead of `force-static`, or not at all once it is set.
-     */
-    docsAdapterRoutes?: {
-        owns: (routePath: string) => boolean;
-        prerender: boolean;
-    };
-}): Promise<SSGCollectionResult>;
-/**
- * Check if a route module is SSG
- */
-declare function isSSGModule(mod: RouteModule | null | undefined): boolean;
-/**
- * Check if a route module has ISR (Incremental Static Regeneration)
- */
-declare function hasISR(mod: RouteModule | null | undefined): boolean;
-/**
- * Get revalidation interval for a module
- */
-declare function getRevalidateInterval(mod: RouteModule | null | undefined): number | undefined;
-/**
- * Check if a route module has PPR/static-shell caching enabled.
- */
-declare function hasPPR(mod: RouteModule | null | undefined, options?: RouteRenderingOptions): boolean;
-/**
- * Generate SSG manifest for production builds
- */
-declare function generateSSGManifest(pages: SSGPage[]): string;
-/**
- * Check if a URL path matches an SSG page
- */
-declare function matchSSGPage(urlPath: string, ssgPages: SSGPage[]): SSGPage | undefined;
-
-/**
- * The browser copy of a programmatic page or layout imports only the module that defines its
- * component, never the routes file. Guards, data hooks, static paths, generated metadata, API
- * handlers, and whatever the routes file imports for them stay out of the client graph because
- * the client graph never reaches the routes file.
- *
- * Farm already evaluates the routes file on the server to build its route table. That
- * evaluation also tells it where each component lives: the server module graph holds every
- * module the routes file reached, with its exports, so the module that exports the very
- * function (or object) a route uses as its `component` is that component's own module. This
- * works for any way the route list is built (helpers, re-exported lists, assignments, aliases)
- * because it reads the evaluated value instead of the routes file's syntax. A component that no
- * other module exports (declared in the routes file, or computed there) has no module to
- * import, so a client build that needs it fails with an actionable error.
- *
- * A module that holds route definitions is never a component's client import, however it holds
- * them: Farm finds definitions in every evaluated module's exports (inside objects, arrays,
- * maps, and sets), and route factories record the module that called them while routes are
- * evaluated, which also finds definitions kept behind a function. A definition written as an
- * object literal and kept out of every export can't be traced, so then a component module is
- * accepted only when neither it nor anything it imports holds route-defining code.
- */
-type ProgrammaticClientRouteKind = "page" | "layout";
-interface ProgrammaticClientModuleExport {
-    /** Absolute path of the module that exports the value. */
-    file: string;
-    /** The export name that holds it. */
-    exportName: string;
-}
-interface ProgrammaticClientRoute {
-    kind: ProgrammaticClientRouteKind;
-    path: string;
-    /** Absolute path of the routes file that defines the route. */
-    routesFile: string;
-    component?: ProgrammaticClientModuleExport;
-    pending?: ProgrammaticClientModuleExport;
-    /**
-     * The route options the server resolves into the page's props (params, search, guard, data).
-     * The browser copy renders only from props the server resolved.
-     */
-    serverProps?: string[];
-    /** Why the browser copy can't be generated, when it can't. */
-    problem?: string;
-}
-interface ProgrammaticClientRoutes {
-    /** Keyed by {@link programmaticClientRouteKey}. */
-    routes: ReadonlyMap<string, ProgrammaticClientRoute>;
-    /**
-     * Routes files and the modules that export route definitions. None of them may enter the
-     * client graph.
-     */
-    routeSourceFiles: ReadonlySet<string>;
-}
-
-export { type ProgrammaticClientRoutes as P, type StaticRouteCandidateAnalysis as S, analyzeStaticRouteCandidate as a, getRevalidateInterval as b, collectSSGPages as c, hasPPR as d, resolveRouteRenderingConfig as e, findRequestBoundSourceBlockers as f, generateSSGManifest as g, hasISR as h, isSSGModule as i, resolveRouteRenderingConfigFromFile as j, matchSSGPage as m, parseRouteRenderingDirective as p, readRouteRenderingDirectiveFromFile as r };

package/dist/programmatic-routes-client.d-CPbNqtIi.d.mts

@@ -1,192 +0,0 @@
-import { R as RouteRenderingOptions, D as DirectiveRenderingConfig, a as RouteRenderingConfig } from './route-rendering.d-BrIKA51A.mjs';
-import { i as RouteModule, b6 as SSGCollectionResult, b7 as SSGPage } from './client-plugins.d-CgQQ-EAv.mjs';
-
-/**
- * Farm.js SSG (Static Site Generation) Module
- *
- * Handles collection and pre-rendering of SSG pages at build time.
- *
- * SSR is the default - pages render on each request
- * SSG is opt-in via `export const ssg = true`, Next-compatible route
- * config exports, or a top-of-file rendering directive.
- *
- * @example
- * ```tsx
- * // SSG Page
- * export const ssg = true;
- * export default function AboutPage() {
- *   return <h1>About</h1>;
- * }
- *
- * // SSG with ISR
- * export const ssg = true;
- * export const revalidate = 60;
- * export default async function ProductsPage() {
- *   const products = await fetchProducts();
- *   return <ProductList products={products} />;
- * }
- *
- * // Dynamic SSG
- * export const ssg = true;
- * export async function getStaticPaths() {
- *   const posts = await fetchPosts();
- *   return posts.map(post => ({ slug: post.slug }));
- * }
- * export default async function BlogPost({ params }) {
- *   return <article>{params.slug}</article>;
- * }
- *
- * // Next-compatible route config
- * export const dynamic = "force-static";
- * export const revalidate = 60;
- *
- * // PPR/static-shell route
- * export const experimental_ppr = true;
- * export const revalidate = 60;
- *
- * // Directive config
- * "use ssg; 60";
- * export default function DocsPage() {
- *   return <h1>Docs</h1>;
- * }
- * ```
- */
-
-interface RouteEntry {
-    path: string;
-    filePath: string;
-    isDynamic: boolean;
-    pattern: string;
-}
-
-interface StaticRouteCandidateAnalysis {
-    candidate: boolean;
-    blockers: string[];
-}
-/**
- * Resolve the effective rendering mode. Direct request reads make an explicitly
- * static route dynamic so request-specific HTML cannot enter a shared artifact.
- */
-declare function resolveRouteRenderingConfig(mod: RouteModule | null | undefined, source?: string, options?: RouteRenderingOptions): RouteRenderingConfig;
-declare function resolveRouteRenderingConfigFromFile(mod: RouteModule | null | undefined, filePath: string, options?: RouteRenderingOptions): Promise<RouteRenderingConfig>;
-/**
- * Conservatively identify a route that may be safe to pre-render.
- *
- * This intentionally produces a suggestion rather than changing rendering:
- * request-bound work can live in a transitive import, which source inspection
- * of the route module cannot prove safe. Explicit route config always wins.
- */
-declare function analyzeStaticRouteCandidate(mod: RouteModule | null | undefined, source: string | undefined, options?: {
-    isDynamic?: boolean;
-}): StaticRouteCandidateAnalysis;
-declare function findRequestBoundSourceBlockers(source: string): string[];
-declare function parseRouteRenderingDirective(source: string | undefined): DirectiveRenderingConfig | undefined;
-/**
- * A route's rendering directive as the production runtime needs it: the parsed directive plus
- * whether its source reads request state. The runtime only sees module exports, so the build
- * decides `requestBound` here and bakes it into the generated server entry, where
- * `mergeRouteRenderingDirectiveConfig` combines it with the module's exports.
- */
-declare function readRouteRenderingDirectiveFromFile(modulePath: string): DirectiveRenderingConfig | undefined;
-/**
- * Collect SSG pages from route modules
- *
- * Scans all routes and categorizes them into:
- * - SSG pages: Pre-rendered at build time
- * - SSR routes: Rendered on each request
- *
- * @param routes - Array of route entries
- * @param loadModule - Function to load a route module
- * @returns SSG pages and SSR routes
- */
-declare function collectSSGPages(routes: RouteEntry[], loadModule: (filePath: string) => Promise<RouteModule>, options?: {
-    suggestStaticRendering?: boolean;
-    /**
-     * Routes a docs adapter renders, which ignore route config: a static candidate among them
-     * is pointed at `docs.prerender` instead of `force-static`, or not at all once it is set.
-     */
-    docsAdapterRoutes?: {
-        owns: (routePath: string) => boolean;
-        prerender: boolean;
-    };
-}): Promise<SSGCollectionResult>;
-/**
- * Check if a route module is SSG
- */
-declare function isSSGModule(mod: RouteModule | null | undefined): boolean;
-/**
- * Check if a route module has ISR (Incremental Static Regeneration)
- */
-declare function hasISR(mod: RouteModule | null | undefined): boolean;
-/**
- * Get revalidation interval for a module
- */
-declare function getRevalidateInterval(mod: RouteModule | null | undefined): number | undefined;
-/**
- * Check if a route module has PPR/static-shell caching enabled.
- */
-declare function hasPPR(mod: RouteModule | null | undefined, options?: RouteRenderingOptions): boolean;
-/**
- * Generate SSG manifest for production builds
- */
-declare function generateSSGManifest(pages: SSGPage[]): string;
-/**
- * Check if a URL path matches an SSG page
- */
-declare function matchSSGPage(urlPath: string, ssgPages: SSGPage[]): SSGPage | undefined;
-
-/**
- * The browser copy of a programmatic page or layout imports only the module that defines its
- * component, never the routes file. Guards, data hooks, static paths, generated metadata, API
- * handlers, and whatever the routes file imports for them stay out of the client graph because
- * the client graph never reaches the routes file.
- *
- * Farm already evaluates the routes file on the server to build its route table. That
- * evaluation also tells it where each component lives: the server module graph holds every
- * module the routes file reached, with its exports, so the module that exports the very
- * function (or object) a route uses as its `component` is that component's own module. This
- * works for any way the route list is built (helpers, re-exported lists, assignments, aliases)
- * because it reads the evaluated value instead of the routes file's syntax. A component that no
- * other module exports (declared in the routes file, or computed there) has no module to
- * import, so a client build that needs it fails with an actionable error.
- *
- * A module that holds route definitions is never a component's client import, however it holds
- * them: Farm finds definitions in every evaluated module's exports (inside objects, arrays,
- * maps, and sets), and route factories record the module that called them while routes are
- * evaluated, which also finds definitions kept behind a function. A definition written as an
- * object literal and kept out of every export can't be traced, so then a component module is
- * accepted only when neither it nor anything it imports holds route-defining code.
- */
-type ProgrammaticClientRouteKind = "page" | "layout";
-interface ProgrammaticClientModuleExport {
-    /** Absolute path of the module that exports the value. */
-    file: string;
-    /** The export name that holds it. */
-    exportName: string;
-}
-interface ProgrammaticClientRoute {
-    kind: ProgrammaticClientRouteKind;
-    path: string;
-    /** Absolute path of the routes file that defines the route. */
-    routesFile: string;
-    component?: ProgrammaticClientModuleExport;
-    pending?: ProgrammaticClientModuleExport;
-    /**
-     * The route options the server resolves into the page's props (params, search, guard, data).
-     * The browser copy renders only from props the server resolved.
-     */
-    serverProps?: string[];
-    /** Why the browser copy can't be generated, when it can't. */
-    problem?: string;
-}
-interface ProgrammaticClientRoutes {
-    /** Keyed by {@link programmaticClientRouteKey}. */
-    routes: ReadonlyMap<string, ProgrammaticClientRoute>;
-    /**
-     * Routes files and the modules that export route definitions. None of them may enter the
-     * client graph.
-     */
-    routeSourceFiles: ReadonlySet<string>;
-}
-
-export { type ProgrammaticClientRoutes as P, type StaticRouteCandidateAnalysis as S, analyzeStaticRouteCandidate as a, getRevalidateInterval as b, collectSSGPages as c, hasPPR as d, resolveRouteRenderingConfig as e, findRequestBoundSourceBlockers as f, generateSSGManifest as g, hasISR as h, isSSGModule as i, resolveRouteRenderingConfigFromFile as j, matchSSGPage as m, parseRouteRenderingDirective as p, readRouteRenderingDirectiveFromFile as r };

package/dist/query/client.d.mts

@@ -1,61 +0,0 @@
-export { R as RouteParamsInput, l as loadRouteParams, p as parseRouteParams } from '../params.d-ry-lxqmy.mjs';
-import { Parser } from './parsers.mjs';
-export { ArrayParserOptions, asArrayOf, asBoolean, asFloat, asInteger, asIsoDate, asIsoDateTime, asJson, asString, createParser, inferParserType } from './parsers.mjs';
-
-/**
- * Farm.js Client-Side Query State Management
- *
- * Type-safe URL search parameter state management - Like useState, but stored in the URL query string.
- * Client-only hooks for managing query parameters in the browser.
- * Inspired by nuqs implementation patterns.
- */
-
-type UrlUpdateType = "push" | "replace";
-type HistoryMethod = "pushState" | "replaceState";
-interface Options {
-    history?: HistoryMethod;
-    shallow?: boolean;
-    scroll?: boolean;
-    throttleMs?: number;
-}
-declare function useQueryState<TParser extends Parser<any>>(key: string, parser: TParser, options?: Options): [
-    NonNullable<ReturnType<TParser["parse"]>> | null,
-    (value: NonNullable<ReturnType<TParser["parse"]>> | null) => void
-];
-declare function useQueryState<T>(key: string, parser: Parser<T>, options?: Options): [T | null, (value: T | null) => void];
-declare function useQueryStates<T extends Record<string, Parser<any>>>(parsers: T, options?: Options): [
-    {
-        [K in keyof T]: ReturnType<T[K]["parse"]>;
-    },
-    (updates: Partial<{
-        [K in keyof T]: ReturnType<T[K]["parse"]> | null;
-    }>) => void
-];
-declare function usePagination(options?: {
-    defaultPage?: number;
-    defaultLimit?: number;
-    pageKey?: string;
-    limitKey?: string;
-}): {
-    page: number;
-    setPage: (value: number | null) => void;
-    limit: number;
-    setLimit: (value: number | null) => void;
-    offset: number;
-    resetPagination: () => void;
-};
-declare function useSearchFilters<T extends Record<string, any>>(options?: {
-    searchKey?: string;
-    defaultFilters?: T;
-    filterKeys?: (keyof T)[];
-}): {
-    search: string | null;
-    setSearch: (value: string | null) => void;
-    filters: T;
-    setFilters: (updates: Partial<{
-        [x: string]: string | null;
-    }>) => void;
-    clearFilters: () => void;
-};
-
-export { type HistoryMethod, type Options, Parser, type UrlUpdateType, usePagination, useQueryState, useQueryStates, useSearchFilters };

package/dist/query/client.d.ts

@@ -1,61 +0,0 @@
-export { R as RouteParamsInput, l as loadRouteParams, p as parseRouteParams } from '../params.d-BALtrRim.js';
-import { Parser } from './parsers.js';
-export { ArrayParserOptions, asArrayOf, asBoolean, asFloat, asInteger, asIsoDate, asIsoDateTime, asJson, asString, createParser, inferParserType } from './parsers.js';
-
-/**
- * Farm.js Client-Side Query State Management
- *
- * Type-safe URL search parameter state management - Like useState, but stored in the URL query string.
- * Client-only hooks for managing query parameters in the browser.
- * Inspired by nuqs implementation patterns.
- */
-
-type UrlUpdateType = "push" | "replace";
-type HistoryMethod = "pushState" | "replaceState";
-interface Options {
-    history?: HistoryMethod;
-    shallow?: boolean;
-    scroll?: boolean;
-    throttleMs?: number;
-}
-declare function useQueryState<TParser extends Parser<any>>(key: string, parser: TParser, options?: Options): [
-    NonNullable<ReturnType<TParser["parse"]>> | null,
-    (value: NonNullable<ReturnType<TParser["parse"]>> | null) => void
-];
-declare function useQueryState<T>(key: string, parser: Parser<T>, options?: Options): [T | null, (value: T | null) => void];
-declare function useQueryStates<T extends Record<string, Parser<any>>>(parsers: T, options?: Options): [
-    {
-        [K in keyof T]: ReturnType<T[K]["parse"]>;
-    },
-    (updates: Partial<{
-        [K in keyof T]: ReturnType<T[K]["parse"]> | null;
-    }>) => void
-];
-declare function usePagination(options?: {
-    defaultPage?: number;
-    defaultLimit?: number;
-    pageKey?: string;
-    limitKey?: string;
-}): {
-    page: number;
-    setPage: (value: number | null) => void;
-    limit: number;
-    setLimit: (value: number | null) => void;
-    offset: number;
-    resetPagination: () => void;
-};
-declare function useSearchFilters<T extends Record<string, any>>(options?: {
-    searchKey?: string;
-    defaultFilters?: T;
-    filterKeys?: (keyof T)[];
-}): {
-    search: string | null;
-    setSearch: (value: string | null) => void;
-    filters: T;
-    setFilters: (updates: Partial<{
-        [x: string]: string | null;
-    }>) => void;
-    clearFilters: () => void;
-};
-
-export { type HistoryMethod, type Options, Parser, type UrlUpdateType, usePagination, useQueryState, useQueryStates, useSearchFilters };

package/dist/query/index.d.mts

@@ -1,90 +0,0 @@
-export { ArrayParserOptions, Parser, asArrayOf, asBoolean, asFloat, asInteger, asIsoDate, asIsoDateTime, asJson, asString, createParser, inferParserType } from './parsers.mjs';
-export { R as RouteParamsInput, l as loadRouteParams, p as parseRouteParams } from '../params.d-ry-lxqmy.mjs';
-import { ReactNode, ComponentType } from 'react';
-
-/**
- * Farm.js Query State Types
- */
-
-/**
- * Props for Farm.js page components with search params
- */
-/**
- * Props for Farm.js layout components
- */
-interface LayoutPropsSafe {
-    children: ReactNode;
-    params: Record<string, string>;
-}
-interface PagePropsSafe {
-    params: Record<string, string>;
-    searchParams: Promise<URLSearchParams | Record<string, string | string[] | undefined>>;
-}
-/**
- * Query state configuration for Farm.js
- */
-interface QueryStateConfig {
-    /**
-     * Default history method for URL updates
-     * @default 'push'
-     */
-    defaultHistoryMethod?: "push" | "replace";
-    /**
-     * Default shallow routing behavior
-     * @default true
-     */
-    shallow?: boolean;
-    /**
-     * Default scroll behavior
-     * @default true
-     */
-    scroll?: boolean;
-    /**
-     * Custom serialization options
-     */
-    serialization?: {
-        /**
-         * Custom URL key mappings
-         */
-        urlKeys?: Record<string, string>;
-        /**
-         * Custom base URL for serialization
-         */
-        baseUrl?: string;
-    };
-}
-/**
- * Farm.js specific query state context
- */
-interface FarmQueryStateContext {
-    /**
-     * Current search parameters
-     */
-    searchParams: URLSearchParams;
-    /**
-     * Current pathname
-     */
-    pathname: string;
-    /**
-     * Update URL with new search parameters
-     */
-    updateUrl: (params: Record<string, any>, options?: {
-        method?: "push" | "replace";
-        shallow?: boolean;
-        scroll?: boolean;
-    }) => void;
-    /**
-     * Clear all search parameters
-     */
-    clearParams: () => void;
-}
-/**
- * Higher-order component for providing query state context
- */
-type QueryStateProvider = ComponentType<{
-    children: ReactNode;
-    searchParams?: URLSearchParams;
-    pathname?: string;
-}>;
-
-export type { FarmQueryStateContext, LayoutPropsSafe, PagePropsSafe, QueryStateConfig, QueryStateProvider };