@farm.js/core 0.1.0-beta.96 → 0.1.0-beta.97

package/dist/vite.d.mts

@@ -1,10 +1,10 @@
 import 'vite';
-export { t as defineConfig, e8 as farmI18nClientBridgePlugin, s as farmPlugin, ea as rewriteEarlySsrRelativeImports, eb as transformIsolatedClientBoundaryModule, e9 as withFarmRequestTracing } from './client-plugins-BvClItiL.mjs';
+export { e3 as ClientCachePersistenceEntryCode, t as defineConfig, dZ as farmI18nClientBridgePlugin, s as farmPlugin, e1 as generateClientCachePersistenceCode, e2 as resolveFarmClientCacheAdapterEntry, d$ as rewriteEarlySsrRelativeImports, e0 as transformIsolatedClientBoundaryModule, d_ as withFarmRequestTracing } from './client-plugins-B6-07YmP.mjs';
 import './after.mjs';
 import './island-CfGru1MO.mjs';
 export { c as createFarmNodeRequestAbortSignal } from './workflows-ChyK_oTu.mjs';
 import './lifecycle-De0vQG45.mjs';
-import './route-Cq3aObmj.mjs';
+import './route-CvEr4Uc9.mjs';
 import './cache.mjs';
 import './renderer.mjs';
 import 'http';
@@ -12,6 +12,7 @@ import './types-Cc8l9IqS.mjs';
 import 'db0';
 import 'unstorage';
 import 'react';
+import './integration-api-BT024nuJ.mjs';
 import '@farming-labs/orm';
 import './types-CKwggz9n.mjs';
 import '@farming-labs/docs';

package/dist/vite.d.ts

@@ -1,10 +1,10 @@
 import 'vite';
-export { t as defineConfig, e8 as farmI18nClientBridgePlugin, s as farmPlugin, ea as rewriteEarlySsrRelativeImports, eb as transformIsolatedClientBoundaryModule, e9 as withFarmRequestTracing } from './client-plugins-B9Sq-iMg.js';
+export { e3 as ClientCachePersistenceEntryCode, t as defineConfig, dZ as farmI18nClientBridgePlugin, s as farmPlugin, e1 as generateClientCachePersistenceCode, e2 as resolveFarmClientCacheAdapterEntry, d$ as rewriteEarlySsrRelativeImports, e0 as transformIsolatedClientBoundaryModule, d_ as withFarmRequestTracing } from './client-plugins-By6MVUX-.js';
 import './after.js';
 import './island-CfGru1MO.js';
 export { c as createFarmNodeRequestAbortSignal } from './workflows-ChyK_oTu.js';
 import './lifecycle-De0vQG45.js';
-import './route-Y8lfz1wF.js';
+import './route-4pd-EVtw.js';
 import './cache.js';
 import './renderer.js';
 import 'http';
@@ -12,6 +12,7 @@ import './types-Cc8l9IqS.js';
 import 'db0';
 import 'unstorage';
 import 'react';
+import './integration-api-BT024nuJ.js';
 import '@farming-labs/orm';
 import './types-CKwggz9n.js';
 import '@farming-labs/docs';

package/dist/vite.mjs

@@ -2,10 +2,12 @@ import {
   defineConfig,
   farmI18nClientBridgePlugin,
   farmPlugin,
+  generateClientCachePersistenceCode,
+  resolveFarmClientCacheAdapterEntry,
   rewriteEarlySsrRelativeImports,
   transformIsolatedClientBoundaryModule,
   withFarmRequestTracing
-} from "./chunk-GZHKWHCH.mjs";
+} from "./chunk-FP5Q67FO.mjs";
 import "./chunk-YVPFZ2TK.mjs";
 import "./chunk-KDP5ZSWP.mjs";
 import "./chunk-WQDQCTC5.mjs";
@@ -17,7 +19,7 @@ import "./chunk-USWZZUEH.mjs";
 import "./chunk-USLFXFFH.mjs";
 import "./chunk-CG4GPK3Z.mjs";
 import "./chunk-YKAUAZA4.mjs";
-import "./chunk-7MABZJIM.mjs";
+import "./chunk-7PYVLJ4J.mjs";
 import "./chunk-7T2QYWDH.mjs";
 import "./chunk-5EZRXIFH.mjs";
 import "./chunk-7ZVN3YZI.mjs";
@@ -28,19 +30,19 @@ import "./chunk-A5VG2BDG.mjs";
 import "./chunk-EUYRVVXL.mjs";
 import "./chunk-2SKCXYLB.mjs";
 import "./chunk-BZAIS65C.mjs";
-import "./chunk-VV24CC42.mjs";
+import "./chunk-35NPLKQJ.mjs";
 import "./chunk-N2KC75H7.mjs";
 import "./chunk-H53KVQUU.mjs";
 import "./chunk-QKVUNGAH.mjs";
 import "./chunk-AAC66ILR.mjs";
 import "./chunk-ISSFLGJ5.mjs";
-import "./chunk-RWYRFCLG.mjs";
+import "./chunk-4X57GXQA.mjs";
 import "./chunk-IGOLMCE3.mjs";
 import "./chunk-YUE4CJNB.mjs";
-import "./chunk-ZFNK77WN.mjs";
-import "./chunk-WMAYETRD.mjs";
+import "./chunk-6JNGOC37.mjs";
+import "./chunk-TT3E2JOF.mjs";
 import "./chunk-NXV52RNX.mjs";
-import "./chunk-WB75GIX2.mjs";
+import "./chunk-TQTB33JS.mjs";
 import "./chunk-STV7A2LH.mjs";
 import "./chunk-XNWHZQ6A.mjs";
 import "./chunk-SXWF4QRU.mjs";
@@ -49,7 +51,7 @@ import "./chunk-LBRRZEEK.mjs";
 import "./chunk-HAG2HEDU.mjs";
 import "./chunk-VFPFBYG5.mjs";
 import "./chunk-35SSRS5K.mjs";
-import "./chunk-MM46HTX6.mjs";
+import "./chunk-3TWQERDE.mjs";
 import "./chunk-4OAR7CTF.mjs";
 import "./chunk-O2IGROSM.mjs";
 import "./chunk-4N7DAFLY.mjs";
@@ -65,12 +67,12 @@ import "./chunk-6YPPIPKR.mjs";
 import "./chunk-776TTMU3.mjs";
 import "./chunk-3BXGOVKE.mjs";
 import "./chunk-4C3Z34O7.mjs";
-import "./chunk-AXVJCMVF.mjs";
-import "./chunk-RBRLLZL5.mjs";
+import "./chunk-2HDOV47R.mjs";
+import "./chunk-34IAPZBG.mjs";
 import "./chunk-WZ5QFROO.mjs";
-import "./chunk-ZRBCBOEX.mjs";
+import "./chunk-N2FY2QZ7.mjs";
 import "./chunk-FXG2PS27.mjs";
-import "./chunk-74QPONAN.mjs";
+import "./chunk-J3MPQ4MQ.mjs";
 import "./chunk-PHN22XB2.mjs";
 import "./chunk-XYTDSPBD.mjs";
 import "./chunk-OMQWEX4N.mjs";
@@ -86,6 +88,8 @@ export {
   defineConfig,
   farmI18nClientBridgePlugin,
   farmPlugin,
+  generateClientCachePersistenceCode,
+  resolveFarmClientCacheAdapterEntry,
   rewriteEarlySsrRelativeImports,
   transformIsolatedClientBoundaryModule,
   withFarmRequestTracing

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farm.js/core",
-  "version": "0.1.0-beta.96",
+  "version": "0.1.0-beta.97",
   "description": "Core Farm.js framework for modern integrated apps",
   "keywords": [
     "@farm.js/core",
@@ -588,6 +588,18 @@
   "publishConfig": {
     "access": "public"
   },
+  "scripts": {
+    "build": "tsup",
+    "build:runtime": "tsup --config tsup.runtime.config.ts",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "test:coverage": "vitest --coverage",
+    "lint": "biome lint .",
+    "lint:fix": "biome lint --write .",
+    "format": "biome format --write .",
+    "type-check": "tsc --noEmit",
+    "clean": "rm -rf dist"
+  },
   "dependencies": {
     "@farming-labs/docs": "^0.2.44",
     "@farming-labs/orm": "0.0.62",
@@ -624,6 +636,8 @@
   },
   "devDependencies": {
     "@clerk/react": "^6.1.0",
+    "@farm.js/otel": "workspace:*",
+    "@farm.js/renderer-tests": "workspace:*",
     "@opentelemetry/sdk-node": "0.221.0",
     "@opentelemetry/sdk-trace-base": "2.10.0",
     "@types/react": "^18.2.45",
@@ -634,9 +648,7 @@
     "react-dom": "19.2.8",
     "tsup": "^8.3.5",
     "typescript": "^5.3.3",
-    "vitest": "^3.2.7",
-    "@farm.js/otel": "0.1.0-beta.25",
-    "@farm.js/renderer-tests": "0.0.0"
+    "vitest": "^3.2.7"
   },
   "peerDependencies": {
     "react": "^18.2.0 || ^19.0.0",
@@ -657,17 +669,5 @@
   },
   "engines": {
     "node": ">=22.13.0"
-  },
-  "scripts": {
-    "build": "tsup",
-    "build:runtime": "tsup --config tsup.runtime.config.ts",
-    "dev": "tsup --watch",
-    "test": "vitest run",
-    "test:coverage": "vitest --coverage",
-    "lint": "biome lint .",
-    "lint:fix": "biome lint --write .",
-    "format": "biome format --write .",
-    "type-check": "tsc --noEmit",
-    "clean": "rm -rf dist"
   }
-}
+}

package/types/client.d.ts

@@ -670,6 +670,8 @@ declare module "@farm.js/core/client" {
     staleTime?: number;
     gcTime?: number;
     dedupeMs?: number;
+    /** Allow the configured client cache persistence adapter to store this read. */
+    persist?: boolean;
   };
 
   export type RetryOptions = {
@@ -696,6 +698,73 @@ declare module "@farm.js/core/client" {
         refetch?: boolean;
       };
 
+  export const FARM_CACHE_INVALIDATION_CHANNEL: "farm:cache-invalidation";
+
+  export type CrossTabCacheInvalidationOptions = {
+    /** Override the BroadcastChannel name, e.g. to isolate multiple apps on one origin. */
+    channelName?: string;
+  };
+
+  export function enableCrossTabCacheInvalidation(
+    options?: CrossTabCacheInvalidationOptions,
+  ): () => void;
+
+  export const FARM_CLIENT_CACHE_PERSIST_VERSION: string;
+
+  export type PersistedEntry = {
+    data: unknown;
+    updatedAt: number;
+    staleAt: number;
+    gcAt?: number;
+    version: string;
+  };
+
+  export type FarmClientCacheAdapter = {
+    keys(): Promise<string[]>;
+    get(key: string): Promise<PersistedEntry | null>;
+    set(key: string, entry: PersistedEntry): Promise<void>;
+    delete(key: string): Promise<void>;
+    clear(): Promise<void>;
+    getMany?(keys: string[]): Promise<Array<PersistedEntry | null>>;
+    setMany?(entries: Array<[string, PersistedEntry]>): Promise<void>;
+  };
+
+  export type FarmClientCacheStorage = {
+    getItem<T = unknown>(key: string): Promise<T | null>;
+    setItem<T = unknown>(key: string, value: T): Promise<unknown>;
+    removeItem(key: string): Promise<unknown>;
+    getKeys?(base?: string): Promise<string[]>;
+    keys?(base?: string): Promise<string[]>;
+    clear?(base?: string): Promise<unknown>;
+  };
+
+  export type ClientCachePersistenceOptions = {
+    version?: string;
+    persistKey?: (key: string) => boolean;
+    flushDelayMs?: number;
+  };
+
+  export function defineClientCacheAdapter(adapter: FarmClientCacheAdapter): FarmClientCacheAdapter;
+
+  export function storageClientCacheAdapter(
+    storage: FarmClientCacheStorage,
+    options?: { base?: string },
+  ): FarmClientCacheAdapter;
+
+  export function clearPersistedCache(): Promise<void>;
+
+  /** @internal Wired by the generated client entry from `cache.client.adapter`. */
+  export function initPersistedClientCache(
+    adapter: FarmClientCacheAdapter,
+    options?: ClientCachePersistenceOptions,
+  ): () => void;
+
+  /** @internal Entry point used by generated client entries. */
+  export function initConfiguredClientCachePersistence(
+    adapterModule: unknown,
+    options?: ClientCachePersistenceOptions,
+  ): void;
+
   export type OptimisticUpdate =
     | [CallableRouteRef<any>, unknown, (prev: any) => any]
     | [CacheKey<any> | DefinedCacheKey<any> | string, (prev: any) => any];
@@ -838,7 +907,10 @@ declare module "@farm.js/core/client" {
       query: infer TQuery;
     };
   }
-    ? SimplifyEndpointInput<BodyInputProp<InferEndpointBody<T>> & QueryInputProp<TQuery>>
+    ? SimplifyEndpointInput<
+        BodyInputProp<InferEndpointBody<T>> &
+          QueryInputProp<T extends { __types: { inputQuery: infer I } } ? I : TQuery>
+      >
     : {};
 
   type InferEndpointOutput<T> = T extends {
@@ -907,6 +979,8 @@ declare module "@farm.js/core/client" {
       context: ServerFnOptimisticContext<TInput, TResult>,
     ) => TResult | null | undefined;
     rollbackOnError?: boolean;
+    /** Retry failed submissions with the API client's retry shape. Defaults to no retries. */
+    retry?: RetryOptions;
     onSuccess?: (result: TResult) => void;
     onError?: (error: TError) => void;
     onSettled?: (result: TResult | null, error: TError | null) => void;
@@ -969,6 +1043,12 @@ declare module "@farm.js/core/client" {
   export type UseMutationOptions<TVariables, TData, TError = Error> = {
     initialData?: TData | null;
     resetOnMutate?: boolean;
+    /**
+     * `"always"` (default) dispatches regardless of connectivity. `"online"`
+     * pauses a submission while the browser is offline and resumes it on the
+     * `online` event instead of failing it.
+     */
+    networkMode?: MutationNetworkMode;
     optimistic?: (
       context: MutationOptimisticContext<TVariables, TData>,
     ) => TData | null | undefined;
@@ -993,12 +1073,16 @@ declare module "@farm.js/core/client" {
       ? (variables?: InferMutationVariables<TTarget>) => void
       : (variables: InferMutationVariables<TTarget>) => void;
 
+  export type MutationNetworkMode = "always" | "online";
+
   export type UseMutationReturn<
     TTarget extends AnyMutationTarget,
     TData = InferMutationData<TTarget>,
     TError = InferMutationError<TTarget>,
   > = {
     pending: boolean;
+    /** True while a submission is waiting for the browser to come back online. */
+    paused: boolean;
     status: MutationStatus;
     data: TData | null;
     error: TError | null;
@@ -1076,6 +1160,8 @@ declare module "@farm.js/core/client" {
     state: FetcherState;
     status: MutationStatus;
     pending: boolean;
+    /** True while a submission is waiting for the browser to come back online. */
+    paused: boolean;
     data: InferMutationData<TTarget> | null;
     error: InferMutationError<TTarget> | FetcherInputError | null;
     variables: InferMutationVariables<TTarget> | undefined;