@farm.js/core 0.1.46 → 0.1.48

package/dist/spa-router-CKuS81mi.d.ts

@@ -0,0 +1,239 @@
+import { M as Metadata } from './client-plugins-DqjCsKMN.js';
+import { F as FarmClientPluginManager } from './lifecycle-DK06VuKP.js';
+import { a as FarmI18nClientSnapshot } from './types--Wh02r5_.js';
+import { F as FarmIslandStrategy } from './island-CfGru1MO.js';
+import { F as FarmRouteRenderPlan } from './render-plan-DqWXo3-B.js';
+
+type NavigationMetadata = (Metadata & Record<string, any>) | undefined;
+
+/**
+ * Farm.js SPA Router
+ *
+ * Provides client-side navigation without full page reloads.
+ * Features:
+ * - Prefetch on viewport intersection
+ * - Prefetch on hover
+ * - Page caching
+ * - History API integration
+ * - Scroll restoration
+ */
+interface PageData {
+    props: Record<string, any>;
+    modulePath: string;
+    loadingModulePath?: string | null;
+    canonicalPath?: string;
+    isClientComponent?: boolean;
+    shouldHydrate?: boolean;
+    islandStrategy?: FarmIslandStrategy | null;
+    renderPlan?: FarmRouteRenderPlan;
+    fragment?: {
+        html: string;
+        layoutPatterns: string[];
+    };
+    metadata?: NavigationMetadata;
+    layoutModules?: string[];
+    routeSlots?: RouteSlotPageData[];
+    interception?: {
+        from?: string;
+        slots: string[];
+    };
+    i18n?: FarmI18nClientSnapshot;
+}
+interface RouteSlotPageData {
+    name: string;
+    ownerPattern: string;
+    containerId: string;
+    interception: boolean;
+    fallback: boolean;
+    modulePath: string;
+    isClientComponent: boolean;
+    shouldHydrate: boolean;
+    props: Record<string, any>;
+}
+interface RouterOptions {
+    prefetchTimeout?: number;
+    cacheMaxAge?: number;
+    scrollRestoration?: boolean;
+    shouldUseDocumentNavigation?: (pathname: string) => boolean;
+    deploymentId?: string;
+}
+interface FarmNavigationBlockerContext {
+    from: string;
+    to: string;
+    action: "push" | "replace" | "pop";
+}
+type FarmNavigationBlocker = (context: FarmNavigationBlockerContext) => boolean | void | Promise<boolean | void>;
+type FarmViewTransitionMode = boolean | "auto";
+interface FarmNavigateOptions {
+    replace?: boolean;
+    scroll?: boolean;
+    state?: unknown;
+    viewTransition?: FarmViewTransitionMode;
+    /** Re-fetch the current route even when its URL has not changed. */
+    refresh?: boolean;
+}
+interface FarmNavigationLocation {
+    href: string;
+    pathname: string;
+    search: string;
+    hash: string;
+}
+interface FarmNavigationState {
+    state: "idle" | "loading";
+    pending: boolean;
+    from: string | null;
+    to: FarmNavigationLocation | null;
+    action: FarmNavigationBlockerContext["action"] | null;
+    startedAt: number | null;
+}
+type FarmNavigationListener = (state: FarmNavigationState) => void;
+/** What a navigation handler learns about the navigation besides its data. */
+interface FarmNavigationRenderInfo {
+    /** A refresh of the page on screen (`router.refresh()`, or after a server action). */
+    refresh?: boolean;
+}
+declare class SPARouter {
+    private cache;
+    private prefetchingUrls;
+    private pendingPrefetches;
+    private cacheGeneration;
+    private prefetchObserver?;
+    private observedPrefetchLinks;
+    private prefetchTimers;
+    private viewportPrefetchQueue;
+    private viewportPrefetchTasksByHref;
+    private viewportPrefetchTasksByElement;
+    private activeViewportPrefetches;
+    private destroyed;
+    private blockers;
+    private unloadBlockers;
+    private navigationListeners;
+    private navigationState;
+    private currentHistoryPath;
+    private currentHistoryHash;
+    private currentInterceptFrom;
+    private currentHistoryIndex;
+    private suppressNextPopState;
+    private navigationSequence;
+    private activeNavigation?;
+    private scrollElements;
+    private options;
+    private onNavigate?;
+    private clientPlugins?;
+    private readonly onPopState;
+    private readonly onBeforeUnload;
+    constructor(options?: RouterOptions);
+    /** Remove global listeners. Intended for tests and teardown. */
+    destroy(): void;
+    /**
+     * Set the navigation handler that updates React
+     */
+    setNavigationHandler(handler: (data: PageData, info?: FarmNavigationRenderInfo) => Promise<void>): void;
+    /**
+     * Connect Farm's browser plugin lifecycle to SPA navigation.
+     */
+    setClientPluginManager(manager: FarmClientPluginManager): void;
+    /**
+     * Navigate to a new URL
+     */
+    navigate(href: string, options?: FarmNavigateOptions): Promise<void>;
+    /**
+     * Re-render the active route from the server while preserving the document,
+     * shared layouts, client runtime, and browser history entry.
+     */
+    refresh(options?: Omit<FarmNavigateOptions, "replace" | "refresh">): Promise<void>;
+    /**
+     * Prefetch a URL
+     */
+    prefetch(href: string): Promise<void>;
+    /**
+     * Observe an element for viewport intersection (prefetch when visible)
+     */
+    observeForPrefetch(element: HTMLAnchorElement): void;
+    /**
+     * Stop observing an element
+     */
+    unobserveForPrefetch(element: HTMLAnchorElement): void;
+    private getPrefetchObserver;
+    private enqueueViewportPrefetch;
+    private cancelQueuedViewportPrefetch;
+    private drainViewportPrefetchQueue;
+    addBlocker(blocker: FarmNavigationBlocker, shouldBlockUnload?: () => boolean): () => void;
+    getNavigationState(): FarmNavigationState;
+    subscribeNavigation(listener: FarmNavigationListener): () => void;
+    registerScrollElement(key: string, element: HTMLElement): () => void;
+    pushState(state: unknown, href?: string): void;
+    replaceState(state: unknown, href?: string): void;
+    /** @internal Keep shallow URL-search writes inside the router's history bookkeeping. */
+    writeURLSearch(action: "push" | "replace", href: string): void;
+    private commitNavigation;
+    private runViewTransition;
+    /**
+     * Fetch page data from cache or server
+     */
+    private fetchPageData;
+    private requestPageData;
+    private cachePageData;
+    /**
+     * Put the browser URL back on the rendered page after a blocked pop. When
+     * both entries carry a Farm history index the traversal is reversed
+     * exactly; otherwise the current path is pushed again, which restores the
+     * address bar at the cost of one extra history entry.
+     */
+    private revertBlockedPopState;
+    /**
+     * Handle browser back/forward navigation
+     */
+    private handlePopState;
+    /**
+     * Check if URL is cached
+     */
+    private isCached;
+    /**
+     * Check if URL is external
+     */
+    private isExternalUrl;
+    private shouldBlockNavigation;
+    private evaluateBlockerForUnload;
+    private shouldBlockUnload;
+    private updateDocumentMetadata;
+    private startNavigation;
+    private isCurrentNavigation;
+    private finishNavigation;
+    private cancelActiveNavigation;
+    private setNavigationState;
+    private writePageState;
+    /**
+     * Save scroll position for a path
+     */
+    private saveScrollPosition;
+    /**
+     * Restore the saved window scroll position for a path.
+     */
+    private restoreWindowScroll;
+    /**
+     * Restore saved scroll positions for every registered scroll element. Keys
+     * are hash-stripped (see getScrollElementStorageKey), so this runs regardless
+     * of whether the destination URL carries a fragment.
+     */
+    private restoreScrollElements;
+    private restoreScrollElement;
+    /**
+     * Clear the page cache
+     */
+    clearCache(): void;
+}
+declare function getRouter(): SPARouter;
+/**
+ * Navigate to a URL using the SPA router
+ */
+declare function navigateTo(href: string, options?: FarmNavigateOptions): Promise<void>;
+/**
+ * Prefetch a URL
+ */
+declare function prefetch(href: string): Promise<void>;
+declare function pushState(state: unknown, href?: string): void;
+declare function replaceState(state: unknown, href?: string): void;
+declare function readPageState<TState = unknown>(): TState | null;
+
+export { type FarmNavigationBlockerContext as F, SPARouter as S, type FarmNavigationState as a, type FarmNavigateOptions as b, type FarmNavigationBlocker as c, type FarmNavigationListener as d, type FarmNavigationLocation as e, type FarmViewTransitionMode as f, getRouter as g, pushState as h, replaceState as i, navigateTo as n, prefetch as p, readPageState as r };

package/dist/spa-router-CkTPnA4L.d.mts

@@ -0,0 +1,239 @@
+import { M as Metadata } from './client-plugins-BlEzV5FO.mjs';
+import { F as FarmClientPluginManager } from './lifecycle-DK06VuKP.mjs';
+import { a as FarmI18nClientSnapshot } from './types--Wh02r5_.mjs';
+import { F as FarmIslandStrategy } from './island-CfGru1MO.mjs';
+import { F as FarmRouteRenderPlan } from './render-plan-CS8l0zaK.mjs';
+
+type NavigationMetadata = (Metadata & Record<string, any>) | undefined;
+
+/**
+ * Farm.js SPA Router
+ *
+ * Provides client-side navigation without full page reloads.
+ * Features:
+ * - Prefetch on viewport intersection
+ * - Prefetch on hover
+ * - Page caching
+ * - History API integration
+ * - Scroll restoration
+ */
+interface PageData {
+    props: Record<string, any>;
+    modulePath: string;
+    loadingModulePath?: string | null;
+    canonicalPath?: string;
+    isClientComponent?: boolean;
+    shouldHydrate?: boolean;
+    islandStrategy?: FarmIslandStrategy | null;
+    renderPlan?: FarmRouteRenderPlan;
+    fragment?: {
+        html: string;
+        layoutPatterns: string[];
+    };
+    metadata?: NavigationMetadata;
+    layoutModules?: string[];
+    routeSlots?: RouteSlotPageData[];
+    interception?: {
+        from?: string;
+        slots: string[];
+    };
+    i18n?: FarmI18nClientSnapshot;
+}
+interface RouteSlotPageData {
+    name: string;
+    ownerPattern: string;
+    containerId: string;
+    interception: boolean;
+    fallback: boolean;
+    modulePath: string;
+    isClientComponent: boolean;
+    shouldHydrate: boolean;
+    props: Record<string, any>;
+}
+interface RouterOptions {
+    prefetchTimeout?: number;
+    cacheMaxAge?: number;
+    scrollRestoration?: boolean;
+    shouldUseDocumentNavigation?: (pathname: string) => boolean;
+    deploymentId?: string;
+}
+interface FarmNavigationBlockerContext {
+    from: string;
+    to: string;
+    action: "push" | "replace" | "pop";
+}
+type FarmNavigationBlocker = (context: FarmNavigationBlockerContext) => boolean | void | Promise<boolean | void>;
+type FarmViewTransitionMode = boolean | "auto";
+interface FarmNavigateOptions {
+    replace?: boolean;
+    scroll?: boolean;
+    state?: unknown;
+    viewTransition?: FarmViewTransitionMode;
+    /** Re-fetch the current route even when its URL has not changed. */
+    refresh?: boolean;
+}
+interface FarmNavigationLocation {
+    href: string;
+    pathname: string;
+    search: string;
+    hash: string;
+}
+interface FarmNavigationState {
+    state: "idle" | "loading";
+    pending: boolean;
+    from: string | null;
+    to: FarmNavigationLocation | null;
+    action: FarmNavigationBlockerContext["action"] | null;
+    startedAt: number | null;
+}
+type FarmNavigationListener = (state: FarmNavigationState) => void;
+/** What a navigation handler learns about the navigation besides its data. */
+interface FarmNavigationRenderInfo {
+    /** A refresh of the page on screen (`router.refresh()`, or after a server action). */
+    refresh?: boolean;
+}
+declare class SPARouter {
+    private cache;
+    private prefetchingUrls;
+    private pendingPrefetches;
+    private cacheGeneration;
+    private prefetchObserver?;
+    private observedPrefetchLinks;
+    private prefetchTimers;
+    private viewportPrefetchQueue;
+    private viewportPrefetchTasksByHref;
+    private viewportPrefetchTasksByElement;
+    private activeViewportPrefetches;
+    private destroyed;
+    private blockers;
+    private unloadBlockers;
+    private navigationListeners;
+    private navigationState;
+    private currentHistoryPath;
+    private currentHistoryHash;
+    private currentInterceptFrom;
+    private currentHistoryIndex;
+    private suppressNextPopState;
+    private navigationSequence;
+    private activeNavigation?;
+    private scrollElements;
+    private options;
+    private onNavigate?;
+    private clientPlugins?;
+    private readonly onPopState;
+    private readonly onBeforeUnload;
+    constructor(options?: RouterOptions);
+    /** Remove global listeners. Intended for tests and teardown. */
+    destroy(): void;
+    /**
+     * Set the navigation handler that updates React
+     */
+    setNavigationHandler(handler: (data: PageData, info?: FarmNavigationRenderInfo) => Promise<void>): void;
+    /**
+     * Connect Farm's browser plugin lifecycle to SPA navigation.
+     */
+    setClientPluginManager(manager: FarmClientPluginManager): void;
+    /**
+     * Navigate to a new URL
+     */
+    navigate(href: string, options?: FarmNavigateOptions): Promise<void>;
+    /**
+     * Re-render the active route from the server while preserving the document,
+     * shared layouts, client runtime, and browser history entry.
+     */
+    refresh(options?: Omit<FarmNavigateOptions, "replace" | "refresh">): Promise<void>;
+    /**
+     * Prefetch a URL
+     */
+    prefetch(href: string): Promise<void>;
+    /**
+     * Observe an element for viewport intersection (prefetch when visible)
+     */
+    observeForPrefetch(element: HTMLAnchorElement): void;
+    /**
+     * Stop observing an element
+     */
+    unobserveForPrefetch(element: HTMLAnchorElement): void;
+    private getPrefetchObserver;
+    private enqueueViewportPrefetch;
+    private cancelQueuedViewportPrefetch;
+    private drainViewportPrefetchQueue;
+    addBlocker(blocker: FarmNavigationBlocker, shouldBlockUnload?: () => boolean): () => void;
+    getNavigationState(): FarmNavigationState;
+    subscribeNavigation(listener: FarmNavigationListener): () => void;
+    registerScrollElement(key: string, element: HTMLElement): () => void;
+    pushState(state: unknown, href?: string): void;
+    replaceState(state: unknown, href?: string): void;
+    /** @internal Keep shallow URL-search writes inside the router's history bookkeeping. */
+    writeURLSearch(action: "push" | "replace", href: string): void;
+    private commitNavigation;
+    private runViewTransition;
+    /**
+     * Fetch page data from cache or server
+     */
+    private fetchPageData;
+    private requestPageData;
+    private cachePageData;
+    /**
+     * Put the browser URL back on the rendered page after a blocked pop. When
+     * both entries carry a Farm history index the traversal is reversed
+     * exactly; otherwise the current path is pushed again, which restores the
+     * address bar at the cost of one extra history entry.
+     */
+    private revertBlockedPopState;
+    /**
+     * Handle browser back/forward navigation
+     */
+    private handlePopState;
+    /**
+     * Check if URL is cached
+     */
+    private isCached;
+    /**
+     * Check if URL is external
+     */
+    private isExternalUrl;
+    private shouldBlockNavigation;
+    private evaluateBlockerForUnload;
+    private shouldBlockUnload;
+    private updateDocumentMetadata;
+    private startNavigation;
+    private isCurrentNavigation;
+    private finishNavigation;
+    private cancelActiveNavigation;
+    private setNavigationState;
+    private writePageState;
+    /**
+     * Save scroll position for a path
+     */
+    private saveScrollPosition;
+    /**
+     * Restore the saved window scroll position for a path.
+     */
+    private restoreWindowScroll;
+    /**
+     * Restore saved scroll positions for every registered scroll element. Keys
+     * are hash-stripped (see getScrollElementStorageKey), so this runs regardless
+     * of whether the destination URL carries a fragment.
+     */
+    private restoreScrollElements;
+    private restoreScrollElement;
+    /**
+     * Clear the page cache
+     */
+    clearCache(): void;
+}
+declare function getRouter(): SPARouter;
+/**
+ * Navigate to a URL using the SPA router
+ */
+declare function navigateTo(href: string, options?: FarmNavigateOptions): Promise<void>;
+/**
+ * Prefetch a URL
+ */
+declare function prefetch(href: string): Promise<void>;
+declare function pushState(state: unknown, href?: string): void;
+declare function replaceState(state: unknown, href?: string): void;
+declare function readPageState<TState = unknown>(): TState | null;
+
+export { type FarmNavigationBlockerContext as F, SPARouter as S, type FarmNavigationState as a, type FarmNavigateOptions as b, type FarmNavigationBlocker as c, type FarmNavigationListener as d, type FarmNavigationLocation as e, type FarmViewTransitionMode as f, getRouter as g, pushState as h, replaceState as i, navigateTo as n, prefetch as p, readPageState as r };

package/dist/storage.cjs

@@ -27,8 +27,8 @@
 
 
 
-var _chunkOILHPMFXcjs = require('./chunk-OILHPMFX.cjs');
-require('./chunk-S3JO3N4H.cjs');
+var _chunkJMYXO572cjs = require('./chunk-JMYXO572.cjs');
+require('./chunk-BTZ5O6VM.cjs');
 
 
 
@@ -58,4 +58,4 @@ require('./chunk-S3JO3N4H.cjs');
 
 
 
-exports._collectFarmStorageModules = _chunkOILHPMFXcjs._collectFarmStorageModules; exports._registerFarmStorageModules = _chunkOILHPMFXcjs._registerFarmStorageModules; exports.createFarmStorage = _chunkOILHPMFXcjs.createFarmStorage; exports.createStorageClient = _chunkOILHPMFXcjs.createStorageClient; exports.databaseStorage = _chunkOILHPMFXcjs.databaseStorage; exports.defineStorageClient = _chunkOILHPMFXcjs.defineStorageClient; exports.disposeStorage = _chunkOILHPMFXcjs.disposeStorage; exports.driverStorage = _chunkOILHPMFXcjs.driverStorage; exports.getStorage = _chunkOILHPMFXcjs.getStorage; exports.initStorage = _chunkOILHPMFXcjs.initStorage; exports.libsqlStorage = _chunkOILHPMFXcjs.libsqlStorage; exports.localStorage = _chunkOILHPMFXcjs.localStorage; exports.memoryStorage = _chunkOILHPMFXcjs.memoryStorage; exports.mongodbStorage = _chunkOILHPMFXcjs.mongodbStorage; exports.mysql2Storage = _chunkOILHPMFXcjs.mysql2Storage; exports.mysqlStorage = _chunkOILHPMFXcjs.mysqlStorage; exports.netlifyBlobsStorage = _chunkOILHPMFXcjs.netlifyBlobsStorage; exports.pgStorage = _chunkOILHPMFXcjs.pgStorage; exports.pgliteStorage = _chunkOILHPMFXcjs.pgliteStorage; exports.planetscaleStorage = _chunkOILHPMFXcjs.planetscaleStorage; exports.postgresStorage = _chunkOILHPMFXcjs.postgresStorage; exports.redisStorage = _chunkOILHPMFXcjs.redisStorage; exports.resolveStorageRuntimeClient = _chunkOILHPMFXcjs.resolveStorageRuntimeClient; exports.s3Storage = _chunkOILHPMFXcjs.s3Storage; exports.sqliteStorage = _chunkOILHPMFXcjs.sqliteStorage; exports.upstashStorage = _chunkOILHPMFXcjs.upstashStorage; exports.vercelBlobStorage = _chunkOILHPMFXcjs.vercelBlobStorage; exports.vercelKVStorage = _chunkOILHPMFXcjs.vercelKVStorage;
+exports._collectFarmStorageModules = _chunkJMYXO572cjs._collectFarmStorageModules; exports._registerFarmStorageModules = _chunkJMYXO572cjs._registerFarmStorageModules; exports.createFarmStorage = _chunkJMYXO572cjs.createFarmStorage; exports.createStorageClient = _chunkJMYXO572cjs.createStorageClient; exports.databaseStorage = _chunkJMYXO572cjs.databaseStorage; exports.defineStorageClient = _chunkJMYXO572cjs.defineStorageClient; exports.disposeStorage = _chunkJMYXO572cjs.disposeStorage; exports.driverStorage = _chunkJMYXO572cjs.driverStorage; exports.getStorage = _chunkJMYXO572cjs.getStorage; exports.initStorage = _chunkJMYXO572cjs.initStorage; exports.libsqlStorage = _chunkJMYXO572cjs.libsqlStorage; exports.localStorage = _chunkJMYXO572cjs.localStorage; exports.memoryStorage = _chunkJMYXO572cjs.memoryStorage; exports.mongodbStorage = _chunkJMYXO572cjs.mongodbStorage; exports.mysql2Storage = _chunkJMYXO572cjs.mysql2Storage; exports.mysqlStorage = _chunkJMYXO572cjs.mysqlStorage; exports.netlifyBlobsStorage = _chunkJMYXO572cjs.netlifyBlobsStorage; exports.pgStorage = _chunkJMYXO572cjs.pgStorage; exports.pgliteStorage = _chunkJMYXO572cjs.pgliteStorage; exports.planetscaleStorage = _chunkJMYXO572cjs.planetscaleStorage; exports.postgresStorage = _chunkJMYXO572cjs.postgresStorage; exports.redisStorage = _chunkJMYXO572cjs.redisStorage; exports.resolveStorageRuntimeClient = _chunkJMYXO572cjs.resolveStorageRuntimeClient; exports.s3Storage = _chunkJMYXO572cjs.s3Storage; exports.sqliteStorage = _chunkJMYXO572cjs.sqliteStorage; exports.upstashStorage = _chunkJMYXO572cjs.upstashStorage; exports.vercelBlobStorage = _chunkJMYXO572cjs.vercelBlobStorage; exports.vercelKVStorage = _chunkJMYXO572cjs.vercelKVStorage;

package/dist/storage.mjs

@@ -27,8 +27,8 @@ import {
   upstashStorage,
   vercelBlobStorage,
   vercelKVStorage
-} from "./chunk-JGHCKIRI.mjs";
-import "./chunk-LPEX4YW6.mjs";
+} from "./chunk-TJVUTGED.mjs";
+import "./chunk-Y6FXYEAI.mjs";
 export {
   _collectFarmStorageModules,
   _registerFarmStorageModules,