@farm.js/core 0.1.0-beta.3 → 0.1.0-beta.4

package/dist/{client-DiViK9yK.d.mts → client-BT1mFQas.d.mts}

@@ -1,6 +1,7 @@
 import { F as FarmIntegrationAPI, a as FarmIntegrationAPIOperation } from './integration-api-CHT2OKAf.mjs';
 import { F as FarmClientCacheKey } from './client-cache-D-EZ7XVW.mjs';
 import { DefinedCacheKey, RouteDataCacheKey, InferCacheKeyData } from './cache.mjs';
+import { F as FarmAPIStream } from './transport-BmbGTXA5.mjs';
 
 /**
  * Small per-call integration metadata. When sent from a browser, values are
@@ -167,6 +168,13 @@ declare function integrationClients<TSources extends Record<string, any>>(source
 }, clientOptions?: IntegrationClientOptions, serverOptions?: Omit<IntegrationServerClientOptions, "isServer">): IntegrationClients<TSources>;
 
 declare const FARM_API_ROUTE_REF_SYMBOL: unique symbol;
+declare const FARM_API_ROUTE_META_SYMBOL: unique symbol;
+type APIRouteRefMetadata = {
+    path: string;
+    method: string;
+    baseURL: string;
+    sameOrigin: boolean;
+};
 type APIClientOptions = {
     baseURL?: string;
     headers?: Record<string, string>;
@@ -336,17 +344,27 @@ type QueryInputProp<TValue> = IsNever<TValue> extends true ? {} : IsAny<TValue>
     query: TValue;
 };
 type HasRequiredKeys<T> = RequiredKeys<T> extends never ? false : true;
-type InferEndpointInput<T> = T extends {
+type InferEndpointBody<T> = T extends {
+    __types: {
+        inputBody: infer TInputBody;
+    };
+} ? TInputBody : T extends {
     __types: {
         body: infer TBody;
+    };
+} ? TBody : never;
+type InferEndpointInput<T> = T extends {
+    __types: {
         query: infer TQuery;
     };
-} ? Simplify<BodyInputProp<TBody> & QueryInputProp<TQuery>> : {};
+} ? Simplify<BodyInputProp<InferEndpointBody<T>> & QueryInputProp<TQuery>> : {};
 type InferEndpointOutput<T> = T extends {
     __types: {
         response: infer R;
     };
-} ? R : any;
+} ? R extends {
+    readonly __farmStreamItem: infer TItem;
+} ? FarmAPIStream<TItem> : R : any;
 type InferEndpointError<T> = T extends {
     __types: {
         errors: infer TErrors;
@@ -406,6 +424,7 @@ type ServerAPIClient<TEndpoints extends Record<string, any>, TIntegrations exten
 declare function createAPIClient<TRouter extends Record<string, any>>(options: APIClientWithoutIntegrationsOptions): RouteAPIClient<TRouter>;
 declare function createAPIClient<TRouter extends Record<string, any>, TIntegrations extends Record<string, any> = {}>(options?: APIClientOptions): APIClient<TRouter, TIntegrations>;
 declare function isAPIRouteRef(value: unknown): value is CallableRouteRef;
+declare function getAPIRouteRefMetadata(value: unknown): APIRouteRefMetadata | null;
 /**
  * Server-side API client that calls endpoints directly as functions
  * No HTTP overhead for app endpoints, and registered integration routes can be exposed at
@@ -425,4 +444,4 @@ declare function createServerAPIClient<TEndpoints extends Record<string, any>>(e
 declare function createServerAPIClient<TEndpoints extends Record<string, any>>(endpoints: TEndpoints, options: ServerAPIClientWithoutIntegrationsOptions): TEndpoints;
 declare function createServerAPIClient<TEndpoints extends Record<string, any>, TIntegrations extends Record<string, any> = {}>(endpoints: TEndpoints, options?: ServerAPIClientOptions): ServerAPIClient<TEndpoints, TIntegrations>;
 
-export { type IntegrationServerClientRoot as $, type APIClientOptions as A, getIntegrationAPIManifest as B, type CacheKey as C, integrationClients as D, integrationsClient as E, FARM_API_ROUTE_REF_SYMBOL as F, integrationsServer as G, type IntegrationClient as H, type InvalidateTarget as I, type IntegrationClientAliases as J, type IntegrationClientRoot as K, type IntegrationClientOptions as L, type IntegrationClientRequestOptions as M, type IntegrationAPI as N, type OptimisticUpdate as O, type IntegrationClients as P, type IntegrationClientData as Q, type RequestEvent as R, type ServerAPIClientOptions as S, type IntegrationOperationResult as T, type InferIntegrationOperationBody as U, type InferIntegrationOperationQuery as V, type InferIntegrationOperationResponse as W, type IntegrationServerClient as X, type IntegrationServerClientAliases as Y, type IntegrationServerClientOptions as Z, type IntegrationServerClientRequestOptions as _, type APIClientWithoutIntegrationsOptions as a, type IntegrationServerRequestLike as a0, type ServerAPIClientWithoutIntegrationsOptions as b, type StatusPhase as c, type StatusEvent as d, type APIResult as e, APIClientError as f, type APIClientSystemError as g, type ResponseEvent as h, type CachePolicy as i, type CacheOptions as j, type RetryOptions as k, type InvalidateOptions as l, type OptimisticOptions as m, type ClientOptions as n, type RouteAPIClient as o, type APIClient as p, type ServerAPIClient as q, createAPIClient as r, isAPIRouteRef as s, createServerAPIClient as t, createIntegrationClient as u, IntegrationClientError as v, createIntegrationApi as w, createIntegrationClients as x, createIntegrations as y, createIntegrationServerClient as z };
+export { type IntegrationServerClientAliases as $, type APIRouteRefMetadata as A, createIntegrationClients as B, type CacheKey as C, createIntegrations as D, createIntegrationServerClient as E, FARM_API_ROUTE_REF_SYMBOL as F, getIntegrationAPIManifest as G, integrationClients as H, type InvalidateTarget as I, integrationsClient as J, integrationsServer as K, type IntegrationClient as L, type IntegrationClientAliases as M, type IntegrationClientRoot as N, type OptimisticUpdate as O, type IntegrationClientOptions as P, type IntegrationClientRequestOptions as Q, type RequestEvent as R, type ServerAPIClientOptions as S, type IntegrationAPI as T, type IntegrationClients as U, type IntegrationClientData as V, type IntegrationOperationResult as W, type InferIntegrationOperationBody as X, type InferIntegrationOperationQuery as Y, type InferIntegrationOperationResponse as Z, type IntegrationServerClient as _, FARM_API_ROUTE_META_SYMBOL as a, type IntegrationServerClientOptions as a0, type IntegrationServerClientRequestOptions as a1, type IntegrationServerClientRoot as a2, type IntegrationServerRequestLike as a3, type APIClientOptions as b, type APIClientWithoutIntegrationsOptions as c, type ServerAPIClientWithoutIntegrationsOptions as d, type StatusPhase as e, type StatusEvent as f, type APIResult as g, APIClientError as h, type APIClientSystemError as i, type ResponseEvent as j, type CachePolicy as k, type CacheOptions as l, type RetryOptions as m, type InvalidateOptions as n, type OptimisticOptions as o, type ClientOptions as p, type RouteAPIClient as q, type APIClient as r, type ServerAPIClient as s, createAPIClient as t, isAPIRouteRef as u, getAPIRouteRefMetadata as v, createServerAPIClient as w, createIntegrationClient as x, IntegrationClientError as y, createIntegrationApi as z };

package/dist/{client-DpEBJbts.d.ts → client-Nn0q4eO4.d.ts}

@@ -1,6 +1,7 @@
 import { F as FarmIntegrationAPI, a as FarmIntegrationAPIOperation } from './integration-api-CHT2OKAf.js';
 import { F as FarmClientCacheKey } from './client-cache-CIlyBlmx.js';
 import { DefinedCacheKey, RouteDataCacheKey, InferCacheKeyData } from './cache.js';
+import { F as FarmAPIStream } from './transport-BmbGTXA5.js';
 
 /**
  * Small per-call integration metadata. When sent from a browser, values are
@@ -167,6 +168,13 @@ declare function integrationClients<TSources extends Record<string, any>>(source
 }, clientOptions?: IntegrationClientOptions, serverOptions?: Omit<IntegrationServerClientOptions, "isServer">): IntegrationClients<TSources>;
 
 declare const FARM_API_ROUTE_REF_SYMBOL: unique symbol;
+declare const FARM_API_ROUTE_META_SYMBOL: unique symbol;
+type APIRouteRefMetadata = {
+    path: string;
+    method: string;
+    baseURL: string;
+    sameOrigin: boolean;
+};
 type APIClientOptions = {
     baseURL?: string;
     headers?: Record<string, string>;
@@ -336,17 +344,27 @@ type QueryInputProp<TValue> = IsNever<TValue> extends true ? {} : IsAny<TValue>
     query: TValue;
 };
 type HasRequiredKeys<T> = RequiredKeys<T> extends never ? false : true;
-type InferEndpointInput<T> = T extends {
+type InferEndpointBody<T> = T extends {
+    __types: {
+        inputBody: infer TInputBody;
+    };
+} ? TInputBody : T extends {
     __types: {
         body: infer TBody;
+    };
+} ? TBody : never;
+type InferEndpointInput<T> = T extends {
+    __types: {
         query: infer TQuery;
     };
-} ? Simplify<BodyInputProp<TBody> & QueryInputProp<TQuery>> : {};
+} ? Simplify<BodyInputProp<InferEndpointBody<T>> & QueryInputProp<TQuery>> : {};
 type InferEndpointOutput<T> = T extends {
     __types: {
         response: infer R;
     };
-} ? R : any;
+} ? R extends {
+    readonly __farmStreamItem: infer TItem;
+} ? FarmAPIStream<TItem> : R : any;
 type InferEndpointError<T> = T extends {
     __types: {
         errors: infer TErrors;
@@ -406,6 +424,7 @@ type ServerAPIClient<TEndpoints extends Record<string, any>, TIntegrations exten
 declare function createAPIClient<TRouter extends Record<string, any>>(options: APIClientWithoutIntegrationsOptions): RouteAPIClient<TRouter>;
 declare function createAPIClient<TRouter extends Record<string, any>, TIntegrations extends Record<string, any> = {}>(options?: APIClientOptions): APIClient<TRouter, TIntegrations>;
 declare function isAPIRouteRef(value: unknown): value is CallableRouteRef;
+declare function getAPIRouteRefMetadata(value: unknown): APIRouteRefMetadata | null;
 /**
  * Server-side API client that calls endpoints directly as functions
  * No HTTP overhead for app endpoints, and registered integration routes can be exposed at
@@ -425,4 +444,4 @@ declare function createServerAPIClient<TEndpoints extends Record<string, any>>(e
 declare function createServerAPIClient<TEndpoints extends Record<string, any>>(endpoints: TEndpoints, options: ServerAPIClientWithoutIntegrationsOptions): TEndpoints;
 declare function createServerAPIClient<TEndpoints extends Record<string, any>, TIntegrations extends Record<string, any> = {}>(endpoints: TEndpoints, options?: ServerAPIClientOptions): ServerAPIClient<TEndpoints, TIntegrations>;
 
-export { type IntegrationServerClientRoot as $, type APIClientOptions as A, getIntegrationAPIManifest as B, type CacheKey as C, integrationClients as D, integrationsClient as E, FARM_API_ROUTE_REF_SYMBOL as F, integrationsServer as G, type IntegrationClient as H, type InvalidateTarget as I, type IntegrationClientAliases as J, type IntegrationClientRoot as K, type IntegrationClientOptions as L, type IntegrationClientRequestOptions as M, type IntegrationAPI as N, type OptimisticUpdate as O, type IntegrationClients as P, type IntegrationClientData as Q, type RequestEvent as R, type ServerAPIClientOptions as S, type IntegrationOperationResult as T, type InferIntegrationOperationBody as U, type InferIntegrationOperationQuery as V, type InferIntegrationOperationResponse as W, type IntegrationServerClient as X, type IntegrationServerClientAliases as Y, type IntegrationServerClientOptions as Z, type IntegrationServerClientRequestOptions as _, type APIClientWithoutIntegrationsOptions as a, type IntegrationServerRequestLike as a0, type ServerAPIClientWithoutIntegrationsOptions as b, type StatusPhase as c, type StatusEvent as d, type APIResult as e, APIClientError as f, type APIClientSystemError as g, type ResponseEvent as h, type CachePolicy as i, type CacheOptions as j, type RetryOptions as k, type InvalidateOptions as l, type OptimisticOptions as m, type ClientOptions as n, type RouteAPIClient as o, type APIClient as p, type ServerAPIClient as q, createAPIClient as r, isAPIRouteRef as s, createServerAPIClient as t, createIntegrationClient as u, IntegrationClientError as v, createIntegrationApi as w, createIntegrationClients as x, createIntegrations as y, createIntegrationServerClient as z };
+export { type IntegrationServerClientAliases as $, type APIRouteRefMetadata as A, createIntegrationClients as B, type CacheKey as C, createIntegrations as D, createIntegrationServerClient as E, FARM_API_ROUTE_REF_SYMBOL as F, getIntegrationAPIManifest as G, integrationClients as H, type InvalidateTarget as I, integrationsClient as J, integrationsServer as K, type IntegrationClient as L, type IntegrationClientAliases as M, type IntegrationClientRoot as N, type OptimisticUpdate as O, type IntegrationClientOptions as P, type IntegrationClientRequestOptions as Q, type RequestEvent as R, type ServerAPIClientOptions as S, type IntegrationAPI as T, type IntegrationClients as U, type IntegrationClientData as V, type IntegrationOperationResult as W, type InferIntegrationOperationBody as X, type InferIntegrationOperationQuery as Y, type InferIntegrationOperationResponse as Z, type IntegrationServerClient as _, FARM_API_ROUTE_META_SYMBOL as a, type IntegrationServerClientOptions as a0, type IntegrationServerClientRequestOptions as a1, type IntegrationServerClientRoot as a2, type IntegrationServerRequestLike as a3, type APIClientOptions as b, type APIClientWithoutIntegrationsOptions as c, type ServerAPIClientWithoutIntegrationsOptions as d, type StatusPhase as e, type StatusEvent as f, type APIResult as g, APIClientError as h, type APIClientSystemError as i, type ResponseEvent as j, type CachePolicy as k, type CacheOptions as l, type RetryOptions as m, type InvalidateOptions as n, type OptimisticOptions as o, type ClientOptions as p, type RouteAPIClient as q, type APIClient as r, type ServerAPIClient as s, createAPIClient as t, isAPIRouteRef as u, getAPIRouteRefMetadata as v, createServerAPIClient as w, createIntegrationClient as x, IntegrationClientError as y, createIntegrationApi as z };

package/dist/{client-plugins-CTnsZz_A.d.ts → client-plugins-Cw4qUGsw.d.ts}

@@ -15,6 +15,7 @@ import { FarmEnvConfig, ResolvedFarmEnv } from './env.js';
 import { FarmServerActionsConfig, ResolvedFarmServerActionsConfig } from './server-action-security.js';
 import { F as FarmImageConfig, R as ResolvedFarmImageConfig } from './image-config-Duob7wER.js';
 import { k as FarmI18nUserConfig, R as ResolvedFarmI18nConfig } from './types-BH1lhg5G.js';
+import { FarmCacheUserConfig } from './cache.js';
 import { F as FarmRouteRuntimeConfig, a as FarmRouteRuntime, b as FarmRouteRegions, c as FarmRouteMaxDuration } from './route-runtime-DoOHzCAD.js';
 
 type RuntimeClientFactory<TClient> = () => TClient | Promise<TClient>;
@@ -486,6 +487,8 @@ interface FarmUserConfig extends Omit<FarmConfig, "vite" | "docs" | "env" | "lay
     extends?: readonly FarmLayerEntry[];
     plugins?: FarmPlugin[];
     integrations?: FarmIntegrationsUserConfig;
+    /** Shared application data, route, ISR, and PPR cache. */
+    cache?: FarmCacheUserConfig;
     migrations?: FarmMigrationsUserConfig;
     /** Map portable cron schedules to ordinary GET API routes. */
     cron?: FarmCronUserConfig | FarmCronResolvedConfig | false;
@@ -1409,6 +1412,7 @@ interface FarmAppContext {
 }
 interface FarmConfig {
     root?: string;
+    /** App source directory. @default "src" */
     srcDir?: string;
     extends?: readonly FarmLayerEntry[];
     /** Resolved layer graph. Populated by config resolution. */
@@ -1438,6 +1442,8 @@ interface FarmConfig {
         };
     };
     storage?: FarmStorageUserConfig;
+    /** Shared application data, route, ISR, and PPR cache. */
+    cache?: FarmCacheUserConfig;
     integrations?: FarmIntegrationsUserConfig;
     plugins?: FarmPlugin[];
     migrations?: FarmMigrationsUserConfig;

package/dist/{client-plugins-Cnr0D3kk.d.mts → client-plugins-DQQ1adXM.d.mts}

@@ -15,6 +15,7 @@ import { FarmEnvConfig, ResolvedFarmEnv } from './env.mjs';
 import { FarmServerActionsConfig, ResolvedFarmServerActionsConfig } from './server-action-security.mjs';
 import { F as FarmImageConfig, R as ResolvedFarmImageConfig } from './image-config-Duob7wER.mjs';
 import { k as FarmI18nUserConfig, R as ResolvedFarmI18nConfig } from './types-BH1lhg5G.mjs';
+import { FarmCacheUserConfig } from './cache.mjs';
 import { F as FarmRouteRuntimeConfig, a as FarmRouteRuntime, b as FarmRouteRegions, c as FarmRouteMaxDuration } from './route-runtime-DoOHzCAD.mjs';
 
 type RuntimeClientFactory<TClient> = () => TClient | Promise<TClient>;
@@ -486,6 +487,8 @@ interface FarmUserConfig extends Omit<FarmConfig, "vite" | "docs" | "env" | "lay
     extends?: readonly FarmLayerEntry[];
     plugins?: FarmPlugin[];
     integrations?: FarmIntegrationsUserConfig;
+    /** Shared application data, route, ISR, and PPR cache. */
+    cache?: FarmCacheUserConfig;
     migrations?: FarmMigrationsUserConfig;
     /** Map portable cron schedules to ordinary GET API routes. */
     cron?: FarmCronUserConfig | FarmCronResolvedConfig | false;
@@ -1409,6 +1412,7 @@ interface FarmAppContext {
 }
 interface FarmConfig {
     root?: string;
+    /** App source directory. @default "src" */
     srcDir?: string;
     extends?: readonly FarmLayerEntry[];
     /** Resolved layer graph. Populated by config resolution. */
@@ -1438,6 +1442,8 @@ interface FarmConfig {
         };
     };
     storage?: FarmStorageUserConfig;
+    /** Shared application data, route, ISR, and PPR cache. */
+    cache?: FarmCacheUserConfig;
     integrations?: FarmIntegrationsUserConfig;
     plugins?: FarmPlugin[];
     migrations?: FarmMigrationsUserConfig;

package/dist/client-plugins.d.mts

@@ -1,5 +1,5 @@
 export { a as FarmClientHydrationCompleteEvent, b as FarmClientHydrationEvent, d as FarmClientHydrationMode, e as FarmClientHydrationSession, f as FarmClientLocation, g as FarmClientNavigationAction, h as FarmClientNavigationErrorEvent, i as FarmClientNavigationEvent, j as FarmClientNavigationLoadedEvent, k as FarmClientNavigationResolvedEvent, l as FarmClientNavigationSession, m as FarmClientPerformanceEvent, n as FarmClientPlugin, o as FarmClientPluginCloseEvent, p as FarmClientPluginEnforce, q as FarmClientPluginErrorEvent, r as FarmClientPluginErrorPhase, F as FarmClientPluginManager, s as FarmClientPluginManagerOptions, t as FarmClientPluginMetadata, u as FarmClientPluginRegistration, v as FarmClientPluginRouter, w as FarmClientPluginSetupEvent, x as FarmClientPluginStateEvent, c as createClientPluginManager } from './plugin-BJDf43dc.mjs';
-export { V as FarmPlugin, ad as FarmPluginContext, ae as FarmRequestPluginContext, af as FarmRequestStore } from './client-plugins-Cnr0D3kk.mjs';
+export { V as FarmPlugin, ad as FarmPluginContext, ae as FarmRequestPluginContext, af as FarmRequestStore } from './client-plugins-DQQ1adXM.mjs';
 import 'react';
 import 'http';
 import './types-D1A6-XvH.mjs';
@@ -18,4 +18,5 @@ import './env.mjs';
 import './server-action-security.mjs';
 import './image-config-Duob7wER.mjs';
 import './types-BH1lhg5G.mjs';
+import './cache.mjs';
 import './route-runtime-DoOHzCAD.mjs';

package/dist/client-plugins.d.ts

@@ -1,5 +1,5 @@
 export { a as FarmClientHydrationCompleteEvent, b as FarmClientHydrationEvent, d as FarmClientHydrationMode, e as FarmClientHydrationSession, f as FarmClientLocation, g as FarmClientNavigationAction, h as FarmClientNavigationErrorEvent, i as FarmClientNavigationEvent, j as FarmClientNavigationLoadedEvent, k as FarmClientNavigationResolvedEvent, l as FarmClientNavigationSession, m as FarmClientPerformanceEvent, n as FarmClientPlugin, o as FarmClientPluginCloseEvent, p as FarmClientPluginEnforce, q as FarmClientPluginErrorEvent, r as FarmClientPluginErrorPhase, F as FarmClientPluginManager, s as FarmClientPluginManagerOptions, t as FarmClientPluginMetadata, u as FarmClientPluginRegistration, v as FarmClientPluginRouter, w as FarmClientPluginSetupEvent, x as FarmClientPluginStateEvent, c as createClientPluginManager } from './plugin-BJDf43dc.js';
-export { V as FarmPlugin, ad as FarmPluginContext, ae as FarmRequestPluginContext, af as FarmRequestStore } from './client-plugins-CTnsZz_A.js';
+export { V as FarmPlugin, ad as FarmPluginContext, ae as FarmRequestPluginContext, af as FarmRequestStore } from './client-plugins-Cw4qUGsw.js';
 import 'react';
 import 'http';
 import './types-D1A6-XvH.js';
@@ -18,4 +18,5 @@ import './env.js';
 import './server-action-security.js';
 import './image-config-Duob7wER.js';
 import './types-BH1lhg5G.js';
+import './cache.js';
 import './route-runtime-DoOHzCAD.js';