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

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

@@ -1,5 +1,6 @@
 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';
 
 /**
  * Small per-call integration metadata. When sent from a browser, values are
@@ -165,6 +166,7 @@ declare function integrationClients<TSources extends Record<string, any>>(source
     integrations: TSources;
 }, clientOptions?: IntegrationClientOptions, serverOptions?: Omit<IntegrationServerClientOptions, "isServer">): IntegrationClients<TSources>;
 
+declare const FARM_API_ROUTE_REF_SYMBOL: unique symbol;
 type APIClientOptions = {
     baseURL?: string;
     headers?: Record<string, string>;
@@ -201,6 +203,18 @@ type APIResult<TData = unknown, TError = Error> = {
     error: TError | null;
     key: CacheKey<TData>;
 };
+declare class APIClientError<TCode extends string = string, TData = unknown, TStatus extends number = number> extends Error {
+    readonly code: TCode;
+    readonly data: TData;
+    readonly status: TStatus;
+    readonly response?: Response;
+    constructor(code: TCode, data: TData, options: {
+        status: TStatus;
+        message: string;
+        response?: Response;
+    });
+}
+type APIClientSystemError = APIClientError<"http_error", unknown, number> | APIClientError<"network_error", unknown, 0>;
 type RequestEvent = {
     requestId: string;
     method: StatusEvent["method"];
@@ -236,7 +250,7 @@ type RetryOptions = {
     count?: number;
     delay?: number | ((attempt: number) => number);
 };
-type InvalidateTarget = string | {
+type InvalidateTarget = FarmClientCacheKey | {
     key: FarmClientCacheKey;
 } | {
     path: string;
@@ -247,7 +261,7 @@ type InvalidateOptions = InvalidateTarget[] | {
     targets: InvalidateTarget[];
     refetch?: boolean;
 };
-type OptimisticUpdate = [CallableRouteRef<any>, unknown, (prev: any) => any] | [CacheKey<any> | string, (prev: any) => any];
+type OptimisticUpdate = [CallableRouteRef<any>, unknown, (prev: any) => any] | [CacheKey<any> | DefinedCacheKey<any> | string, (prev: any) => any];
 type OptimisticOptions<TUpdates extends readonly unknown[] = readonly OptimisticUpdate[]> = {
     update: TUpdates & NormalizeOptimisticUpdates<TUpdates>;
     rollbackOnError?: boolean;
@@ -285,7 +299,7 @@ type NormalizeOptimisticUpdate<TUpdate> = TUpdate extends readonly [
     TRoute,
     InferRouteInput<TRoute> | undefined,
     (prev: InferRouteData<TRoute> | undefined) => InferRouteData<TRoute>
-] : never : TUpdate extends readonly [infer TKey, (prev: any) => any] ? TKey extends CacheKey<infer TData> ? [TKey, (prev: TData | undefined) => TData] : TKey extends string ? [TKey, (prev: unknown) => unknown] : never : never;
+] : never : TUpdate extends readonly [infer TKey, (prev: any) => any] ? TKey extends DefinedCacheKey<any, RouteDataCacheKey> ? [TKey, (prev: InferCacheKeyData<TKey> | undefined) => InferCacheKeyData<TKey>] : TKey extends CacheKey<infer TData> ? [TKey, (prev: TData | undefined) => TData] : TKey extends string ? [TKey, (prev: unknown) => unknown] : never : never;
 type NormalizeOptimisticUpdates<TUpdates extends readonly unknown[]> = {
     [K in keyof TUpdates]: NormalizeOptimisticUpdate<TUpdates[K]>;
 };
@@ -294,6 +308,7 @@ type TypedEndpointLike = {
         body: any;
         query: any;
         response: any;
+        errors?: any;
     };
 };
 type Simplify<T> = {
@@ -332,13 +347,23 @@ type InferEndpointOutput<T> = T extends {
         response: infer R;
     };
 } ? R : any;
+type InferEndpointError<T> = T extends {
+    __types: {
+        errors: infer TErrors;
+    };
+} ? keyof TErrors extends never ? Error : {
+    [TCode in keyof TErrors]: TErrors[TCode] extends {
+        data: infer TData;
+        status: infer TStatus extends number;
+    } ? APIClientError<TCode & string, TData, TStatus> : never;
+}[keyof TErrors] | APIClientSystemError : Error;
 type EndpointMethod<T = any> = (<TUpdates extends readonly unknown[] = readonly OptimisticUpdate[]>(...args: HasRequiredKeys<InferEndpointInput<T>> extends true ? [
     options: InferEndpointInput<T>,
-    clientOptions?: ClientOptions<InferEndpointOutput<T>, Error, TUpdates>
+    clientOptions?: ClientOptions<InferEndpointOutput<T>, InferEndpointError<T>, TUpdates>
 ] : [
     options?: InferEndpointInput<T>,
-    clientOptions?: ClientOptions<InferEndpointOutput<T>, Error, TUpdates>
-]) => Promise<APIResult<InferEndpointOutput<T>, Error>>) & RouteRef<InferEndpointOutput<T>, InferEndpointInput<T>>;
+    clientOptions?: ClientOptions<InferEndpointOutput<T>, InferEndpointError<T>, TUpdates>
+]) => Promise<APIResult<InferEndpointOutput<T>, InferEndpointError<T>>>) & RouteRef<InferEndpointOutput<T>, InferEndpointInput<T>>;
 type RouterToClient<T> = {
     [K in keyof T]: T[K] extends TypedEndpointLike ? EndpointMethod<T[K]> : T[K] extends Record<string, any> ? RouterToClient<T[K]> : EndpointMethod<T[K]>;
 };
@@ -380,6 +405,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;
 /**
  * Server-side API client that calls endpoints directly as functions
  * No HTTP overhead for app endpoints, and registered integration routes can be exposed at
@@ -399,4 +425,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 APIClientOptions as A, integrationsServer as B, type CacheKey as C, type IntegrationClient as D, type IntegrationClientAliases as E, type IntegrationClientRoot as F, type IntegrationClientOptions as G, type IntegrationClientRequestOptions as H, type InvalidateTarget as I, type IntegrationAPI as J, type IntegrationClients as K, type IntegrationClientData as L, type IntegrationOperationResult as M, type InferIntegrationOperationBody as N, type OptimisticUpdate as O, type InferIntegrationOperationQuery as P, type InferIntegrationOperationResponse as Q, type RequestEvent as R, type ServerAPIClientOptions as S, type IntegrationServerClient as T, type IntegrationServerClientAliases as U, type IntegrationServerClientOptions as V, type IntegrationServerClientRequestOptions as W, type IntegrationServerClientRoot as X, type IntegrationServerRequestLike as Y, type APIClientWithoutIntegrationsOptions as a, type ServerAPIClientWithoutIntegrationsOptions as b, type StatusPhase as c, type StatusEvent as d, type APIResult as e, type ResponseEvent as f, type CachePolicy as g, type CacheOptions as h, type RetryOptions as i, type InvalidateOptions as j, type OptimisticOptions as k, type ClientOptions as l, type RouteAPIClient as m, type APIClient as n, type ServerAPIClient as o, createAPIClient as p, createServerAPIClient as q, createIntegrationClient as r, IntegrationClientError as s, createIntegrationApi as t, createIntegrationClients as u, createIntegrations as v, createIntegrationServerClient as w, getIntegrationAPIManifest as x, integrationClients as y, integrationsClient as z };
+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 };

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

@@ -548,6 +548,7 @@ interface ResolvedFarmConfig extends Required<Omit<FarmUserConfig, "extends" | "
     devtools: ResolvedFarmDevtoolsConfig;
     images: ResolvedFarmImageConfig;
     i18n: ResolvedFarmI18nConfig;
+    routeRules: FarmRouteRules;
 }
 type FarmLayerConfig = Omit<FarmUserConfig, "root" | "outDir" | "distDir" | "deploy" | "output" | "preset" | "publicDir" | "generateBuildId" | "deploymentId">;
 

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

@@ -548,6 +548,7 @@ interface ResolvedFarmConfig extends Required<Omit<FarmUserConfig, "extends" | "
     devtools: ResolvedFarmDevtoolsConfig;
     images: ResolvedFarmImageConfig;
     i18n: ResolvedFarmI18nConfig;
+    routeRules: FarmRouteRules;
 }
 type FarmLayerConfig = Omit<FarmUserConfig, "root" | "outDir" | "distDir" | "deploy" | "output" | "preset" | "publicDir" | "generateBuildId" | "deploymentId">;
 

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-g4bzuCmo.mjs';
+export { V as FarmPlugin, ad as FarmPluginContext, ae as FarmRequestPluginContext, af as FarmRequestStore } from './client-plugins-Cnr0D3kk.mjs';
 import 'react';
 import 'http';
 import './types-D1A6-XvH.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-BZnpeTGA.js';
+export { V as FarmPlugin, ad as FarmPluginContext, ae as FarmRequestPluginContext, af as FarmRequestStore } from './client-plugins-CTnsZz_A.js';
 import 'react';
 import 'http';
 import './types-D1A6-XvH.js';