@farm.js/core 0.1.0-beta.6 → 0.1.0-beta.8

package/dist/server-plugins.d.mts

@@ -0,0 +1,55 @@
+import { aV as RedirectConfig, t as FarmRequest, u as FarmResponse, aj as FarmPluginContext, V as FarmPlugin, aW as HeaderConfig, aX as RewriteConfig } from './client-plugins-BI2R6Eae.mjs';
+export { ak as FarmRequestPluginContext, al as FarmRequestStore } from './client-plugins-BI2R6Eae.mjs';
+import './plugin-BJDf43dc.mjs';
+import 'react';
+import 'http';
+import './types-D1A6-XvH.mjs';
+import 'db0';
+import 'unstorage';
+import './integration-api-CHT2OKAf.mjs';
+import '@farming-labs/orm';
+import './types-C9N-nk5R.mjs';
+import '@farming-labs/docs';
+import './markdown.mjs';
+import './observability.mjs';
+import 'vite';
+import './workflows.mjs';
+import './cron.mjs';
+import './env.mjs';
+import './server-action-security.mjs';
+import './image-config-Duob7wER.mjs';
+import './types-BMxWr97v.mjs';
+import './cache.mjs';
+import './route-runtime-DoOHzCAD.mjs';
+
+declare function createRedirectsPlugin(redirects: RedirectConfig[], { beforeRequest: overrideBeforeRequest, afterResponse: overrideAfterResponse, }?: {
+    beforeRequest?: (req: FarmRequest, res: FarmResponse, context: FarmPluginContext) => void | Promise<void>;
+    afterResponse?: (req: FarmRequest, res: FarmResponse, context: FarmPluginContext) => void | Promise<void>;
+}): FarmPlugin;
+
+declare function createHeadersPlugin(headers: HeaderConfig[], { beforeRequest: overrideBeforeRequest, afterResponse: overrideAfterResponse, }?: {
+    beforeRequest?: (req: FarmRequest, res: FarmResponse, context: FarmPluginContext) => void | Promise<void>;
+    afterResponse?: (req: FarmRequest, res: FarmResponse, context: FarmPluginContext) => void | Promise<void>;
+}): FarmPlugin;
+
+declare function createRewritesPlugin(rewrites: RewriteConfig[], { beforeRequest: overrideBeforeRequest, afterResponse: overrideAfterResponse, }?: {
+    beforeRequest?: (req: FarmRequest, res: FarmResponse, context: FarmPluginContext) => void | Promise<void>;
+    afterResponse?: (req: FarmRequest, res: FarmResponse, context: FarmPluginContext) => void | Promise<void>;
+}): FarmPlugin;
+
+declare function createEnvPlugin(env: Record<string, string>, { beforeRequest: overrideBeforeRequest, afterResponse: overrideAfterResponse, }?: {
+    beforeRequest?: (req: FarmRequest, res: FarmResponse, context: FarmPluginContext) => void | Promise<void>;
+    afterResponse?: (req: FarmRequest, res: FarmResponse, context: FarmPluginContext) => void | Promise<void>;
+}): FarmPlugin;
+
+declare function createCompressionPlugin({ beforeRequest: overrideBeforeRequest, afterResponse: overrideAfterResponse, }?: {
+    beforeRequest?: (req: FarmRequest, res: FarmResponse, context: FarmPluginContext) => void | Promise<void>;
+    afterResponse?: (req: FarmRequest, res: FarmResponse, context: FarmPluginContext) => void | Promise<void>;
+}): FarmPlugin;
+
+declare function createLoggerPlugin({ beforeRequest, afterResponse, }?: {
+    beforeRequest?: (req: FarmRequest, res: FarmResponse, context: FarmPluginContext) => void | Promise<void>;
+    afterResponse?: (req: FarmRequest, res: FarmResponse, context: FarmPluginContext) => void | Promise<void>;
+}): FarmPlugin;
+
+export { FarmPlugin, FarmPluginContext, HeaderConfig, RedirectConfig, RewriteConfig, createCompressionPlugin, createEnvPlugin, createHeadersPlugin, createLoggerPlugin, createRedirectsPlugin, createRewritesPlugin };

package/dist/server-plugins.d.ts

@@ -0,0 +1,55 @@
+import { aV as RedirectConfig, t as FarmRequest, u as FarmResponse, aj as FarmPluginContext, V as FarmPlugin, aW as HeaderConfig, aX as RewriteConfig } from './client-plugins-DU9oMspX.js';
+export { ak as FarmRequestPluginContext, al as FarmRequestStore } from './client-plugins-DU9oMspX.js';
+import './plugin-BJDf43dc.js';
+import 'react';
+import 'http';
+import './types-D1A6-XvH.js';
+import 'db0';
+import 'unstorage';
+import './integration-api-CHT2OKAf.js';
+import '@farming-labs/orm';
+import './types-C9N-nk5R.js';
+import '@farming-labs/docs';
+import './markdown.js';
+import './observability.js';
+import 'vite';
+import './workflows.js';
+import './cron.js';
+import './env.js';
+import './server-action-security.js';
+import './image-config-Duob7wER.js';
+import './types-BMxWr97v.js';
+import './cache.js';
+import './route-runtime-DoOHzCAD.js';
+
+declare function createRedirectsPlugin(redirects: RedirectConfig[], { beforeRequest: overrideBeforeRequest, afterResponse: overrideAfterResponse, }?: {
+    beforeRequest?: (req: FarmRequest, res: FarmResponse, context: FarmPluginContext) => void | Promise<void>;
+    afterResponse?: (req: FarmRequest, res: FarmResponse, context: FarmPluginContext) => void | Promise<void>;
+}): FarmPlugin;
+
+declare function createHeadersPlugin(headers: HeaderConfig[], { beforeRequest: overrideBeforeRequest, afterResponse: overrideAfterResponse, }?: {
+    beforeRequest?: (req: FarmRequest, res: FarmResponse, context: FarmPluginContext) => void | Promise<void>;
+    afterResponse?: (req: FarmRequest, res: FarmResponse, context: FarmPluginContext) => void | Promise<void>;
+}): FarmPlugin;
+
+declare function createRewritesPlugin(rewrites: RewriteConfig[], { beforeRequest: overrideBeforeRequest, afterResponse: overrideAfterResponse, }?: {
+    beforeRequest?: (req: FarmRequest, res: FarmResponse, context: FarmPluginContext) => void | Promise<void>;
+    afterResponse?: (req: FarmRequest, res: FarmResponse, context: FarmPluginContext) => void | Promise<void>;
+}): FarmPlugin;
+
+declare function createEnvPlugin(env: Record<string, string>, { beforeRequest: overrideBeforeRequest, afterResponse: overrideAfterResponse, }?: {
+    beforeRequest?: (req: FarmRequest, res: FarmResponse, context: FarmPluginContext) => void | Promise<void>;
+    afterResponse?: (req: FarmRequest, res: FarmResponse, context: FarmPluginContext) => void | Promise<void>;
+}): FarmPlugin;
+
+declare function createCompressionPlugin({ beforeRequest: overrideBeforeRequest, afterResponse: overrideAfterResponse, }?: {
+    beforeRequest?: (req: FarmRequest, res: FarmResponse, context: FarmPluginContext) => void | Promise<void>;
+    afterResponse?: (req: FarmRequest, res: FarmResponse, context: FarmPluginContext) => void | Promise<void>;
+}): FarmPlugin;
+
+declare function createLoggerPlugin({ beforeRequest, afterResponse, }?: {
+    beforeRequest?: (req: FarmRequest, res: FarmResponse, context: FarmPluginContext) => void | Promise<void>;
+    afterResponse?: (req: FarmRequest, res: FarmResponse, context: FarmPluginContext) => void | Promise<void>;
+}): FarmPlugin;
+
+export { FarmPlugin, FarmPluginContext, HeaderConfig, RedirectConfig, RewriteConfig, createCompressionPlugin, createEnvPlugin, createHeadersPlugin, createLoggerPlugin, createRedirectsPlugin, createRewritesPlugin };

package/dist/server-query-client.d.mts

@@ -0,0 +1,50 @@
+import { a as FarmClientCacheStatus } from './client-cache-D-EZ7XVW.mjs';
+import { ServerQuery } from './server-query.mjs';
+import './cache.mjs';
+import './server-fn.mjs';
+
+declare const FARM_SERVER_QUERY_RESULT_VERSION: 1;
+type FarmServerQueryResult<TData> = {
+    __farmServerQuery: {
+        version: typeof FARM_SERVER_QUERY_RESULT_VERSION;
+        key: string;
+        staleTime: number | false;
+        updatedAt: number;
+    };
+    data: TData;
+};
+
+type ServerQueryFetchOptions = {
+    /** Used only when a non-Farm transport returns plain data. Farm transports use the declaration. */
+    staleTime?: number | false;
+    /** Return stale data immediately while refreshing it in the background. Default true. */
+    swr?: boolean;
+    /** Always wait for a new result. */
+    force?: boolean;
+};
+type UseServerQueryOptions = ServerQueryFetchOptions & {
+    enabled?: boolean;
+    refetchOnWindowFocus?: boolean;
+    refetchOnReconnect?: boolean;
+};
+type UseServerQueryResult<TData> = {
+    data: TData | undefined;
+    error: Error | null;
+    status: FarmClientCacheStatus;
+    pending: boolean;
+    fetching: boolean;
+    stale: boolean;
+    refetch: () => Promise<TData>;
+};
+type FarmServerQueryActionInvocation = {
+    actionId: string;
+    args: readonly unknown[];
+    provisionalKey?: string;
+};
+declare function beginFarmServerQueryAction(actionId: string, args: readonly unknown[]): FarmServerQueryActionInvocation;
+declare function completeFarmServerQueryAction<TData>(invocation: FarmServerQueryActionInvocation, value: TData | FarmServerQueryResult<TData>): TData;
+declare function fetchServerQuery<TInput, TData>(query: ServerQuery<TInput, TData>, input: TInput, options?: ServerQueryFetchOptions): Promise<TData>;
+declare function prefetchServerQuery<TInput, TData>(query: ServerQuery<TInput, TData>, input: TInput, options?: Omit<ServerQueryFetchOptions, "force">): Promise<TData>;
+declare function useServerQuery<TInput, TData>(query: ServerQuery<TInput, TData>, input: TInput, options?: UseServerQueryOptions): UseServerQueryResult<TData>;
+
+export { type FarmServerQueryActionInvocation, type ServerQueryFetchOptions, type UseServerQueryOptions, type UseServerQueryResult, beginFarmServerQueryAction, completeFarmServerQueryAction, fetchServerQuery, prefetchServerQuery, useServerQuery };

package/dist/server-query-client.d.ts

@@ -0,0 +1,50 @@
+import { a as FarmClientCacheStatus } from './client-cache-CIlyBlmx.js';
+import { ServerQuery } from './server-query.js';
+import './cache.js';
+import './server-fn.js';
+
+declare const FARM_SERVER_QUERY_RESULT_VERSION: 1;
+type FarmServerQueryResult<TData> = {
+    __farmServerQuery: {
+        version: typeof FARM_SERVER_QUERY_RESULT_VERSION;
+        key: string;
+        staleTime: number | false;
+        updatedAt: number;
+    };
+    data: TData;
+};
+
+type ServerQueryFetchOptions = {
+    /** Used only when a non-Farm transport returns plain data. Farm transports use the declaration. */
+    staleTime?: number | false;
+    /** Return stale data immediately while refreshing it in the background. Default true. */
+    swr?: boolean;
+    /** Always wait for a new result. */
+    force?: boolean;
+};
+type UseServerQueryOptions = ServerQueryFetchOptions & {
+    enabled?: boolean;
+    refetchOnWindowFocus?: boolean;
+    refetchOnReconnect?: boolean;
+};
+type UseServerQueryResult<TData> = {
+    data: TData | undefined;
+    error: Error | null;
+    status: FarmClientCacheStatus;
+    pending: boolean;
+    fetching: boolean;
+    stale: boolean;
+    refetch: () => Promise<TData>;
+};
+type FarmServerQueryActionInvocation = {
+    actionId: string;
+    args: readonly unknown[];
+    provisionalKey?: string;
+};
+declare function beginFarmServerQueryAction(actionId: string, args: readonly unknown[]): FarmServerQueryActionInvocation;
+declare function completeFarmServerQueryAction<TData>(invocation: FarmServerQueryActionInvocation, value: TData | FarmServerQueryResult<TData>): TData;
+declare function fetchServerQuery<TInput, TData>(query: ServerQuery<TInput, TData>, input: TInput, options?: ServerQueryFetchOptions): Promise<TData>;
+declare function prefetchServerQuery<TInput, TData>(query: ServerQuery<TInput, TData>, input: TInput, options?: Omit<ServerQueryFetchOptions, "force">): Promise<TData>;
+declare function useServerQuery<TInput, TData>(query: ServerQuery<TInput, TData>, input: TInput, options?: UseServerQueryOptions): UseServerQueryResult<TData>;
+
+export { type FarmServerQueryActionInvocation, type ServerQueryFetchOptions, type UseServerQueryOptions, type UseServerQueryResult, beginFarmServerQueryAction, completeFarmServerQueryAction, fetchServerQuery, prefetchServerQuery, useServerQuery };

package/dist/server-query.d.mts

@@ -0,0 +1,36 @@
+import { RouteDataCacheKey } from './cache.mjs';
+import { ServerFnContext, ServerFnSchema, AnyServerFnMiddleware, InferServerFnSchemaOutput, ServerFnMiddlewareContext, ServerFnHandler, InferServerFnSchemaInput } from './server-fn.mjs';
+
+type MaybePromise<T> = T | Promise<T>;
+type ServerQueryStaleTime = number | false | `${number}${"ms" | "s" | "m" | "h"}`;
+type ServerQueryKey<TInput, TContext extends object = {}> = (context: ServerFnContext<TInput, TContext>) => MaybePromise<RouteDataCacheKey>;
+type ServerQueryOptions<TSchema extends ServerFnSchema | undefined, TResult, TMiddlewares extends readonly AnyServerFnMiddleware[] = readonly []> = {
+    input?: TSchema;
+    output?: undefined;
+    middleware?: TMiddlewares;
+    key: ServerQueryKey<TSchema extends ServerFnSchema ? InferServerFnSchemaOutput<TSchema> : unknown, ServerFnMiddlewareContext<TMiddlewares>>;
+    /** Milliseconds, a duration string such as "30s", or false for no expiry. */
+    staleTime?: ServerQueryStaleTime;
+    handler: ServerFnHandler<TSchema extends ServerFnSchema ? InferServerFnSchemaOutput<TSchema> : unknown, TResult, ServerFnMiddlewareContext<TMiddlewares>>;
+};
+type ServerQueryOutputOptions<TInputSchema extends ServerFnSchema | undefined, TOutputSchema extends ServerFnSchema, TMiddlewares extends readonly AnyServerFnMiddleware[] = readonly []> = {
+    input?: TInputSchema;
+    output: TOutputSchema;
+    middleware?: TMiddlewares;
+    key: ServerQueryKey<TInputSchema extends ServerFnSchema ? InferServerFnSchemaOutput<TInputSchema> : unknown, ServerFnMiddlewareContext<TMiddlewares>>;
+    /** Milliseconds, a duration string such as "30s", or false for no expiry. */
+    staleTime?: ServerQueryStaleTime;
+    handler: ServerFnHandler<TInputSchema extends ServerFnSchema ? InferServerFnSchemaOutput<TInputSchema> : unknown, unknown, ServerFnMiddlewareContext<TMiddlewares>>;
+};
+type ServerQuery<TInput, TResult> = ([unknown] extends [TInput] ? (input?: TInput) => Promise<TResult> : (input: TInput) => Promise<TResult>) & {
+    readonly __farmServerQuery: true;
+    readonly __farmServerQueryInput?: unknown;
+    readonly __farmServerQueryOutput?: unknown;
+};
+declare const FARM_SERVER_QUERY_SYMBOL: unique symbol;
+declare function createServerQuery<TInputSchema extends ServerFnSchema, TOutputSchema extends ServerFnSchema, const TMiddlewares extends readonly AnyServerFnMiddleware[] = readonly []>(options: ServerQueryOutputOptions<TInputSchema, TOutputSchema, TMiddlewares>): ServerQuery<InferServerFnSchemaInput<TInputSchema>, Awaited<InferServerFnSchemaOutput<TOutputSchema>>>;
+declare function createServerQuery<TOutputSchema extends ServerFnSchema, const TMiddlewares extends readonly AnyServerFnMiddleware[] = readonly []>(options: ServerQueryOutputOptions<undefined, TOutputSchema, TMiddlewares>): ServerQuery<unknown, Awaited<InferServerFnSchemaOutput<TOutputSchema>>>;
+declare function createServerQuery<TSchema extends ServerFnSchema, TResult, const TMiddlewares extends readonly AnyServerFnMiddleware[] = readonly []>(options: ServerQueryOptions<TSchema, TResult, TMiddlewares>): ServerQuery<InferServerFnSchemaInput<TSchema>, Awaited<TResult>>;
+declare function createServerQuery<TResult, const TMiddlewares extends readonly AnyServerFnMiddleware[] = readonly []>(options: ServerQueryOptions<undefined, TResult, TMiddlewares>): ServerQuery<unknown, Awaited<TResult>>;
+
+export { FARM_SERVER_QUERY_SYMBOL, type ServerQuery, type ServerQueryKey, type ServerQueryOptions, type ServerQueryOutputOptions, type ServerQueryStaleTime, createServerQuery };

package/dist/server-query.d.ts

@@ -0,0 +1,36 @@
+import { RouteDataCacheKey } from './cache.js';
+import { ServerFnContext, ServerFnSchema, AnyServerFnMiddleware, InferServerFnSchemaOutput, ServerFnMiddlewareContext, ServerFnHandler, InferServerFnSchemaInput } from './server-fn.js';
+
+type MaybePromise<T> = T | Promise<T>;
+type ServerQueryStaleTime = number | false | `${number}${"ms" | "s" | "m" | "h"}`;
+type ServerQueryKey<TInput, TContext extends object = {}> = (context: ServerFnContext<TInput, TContext>) => MaybePromise<RouteDataCacheKey>;
+type ServerQueryOptions<TSchema extends ServerFnSchema | undefined, TResult, TMiddlewares extends readonly AnyServerFnMiddleware[] = readonly []> = {
+    input?: TSchema;
+    output?: undefined;
+    middleware?: TMiddlewares;
+    key: ServerQueryKey<TSchema extends ServerFnSchema ? InferServerFnSchemaOutput<TSchema> : unknown, ServerFnMiddlewareContext<TMiddlewares>>;
+    /** Milliseconds, a duration string such as "30s", or false for no expiry. */
+    staleTime?: ServerQueryStaleTime;
+    handler: ServerFnHandler<TSchema extends ServerFnSchema ? InferServerFnSchemaOutput<TSchema> : unknown, TResult, ServerFnMiddlewareContext<TMiddlewares>>;
+};
+type ServerQueryOutputOptions<TInputSchema extends ServerFnSchema | undefined, TOutputSchema extends ServerFnSchema, TMiddlewares extends readonly AnyServerFnMiddleware[] = readonly []> = {
+    input?: TInputSchema;
+    output: TOutputSchema;
+    middleware?: TMiddlewares;
+    key: ServerQueryKey<TInputSchema extends ServerFnSchema ? InferServerFnSchemaOutput<TInputSchema> : unknown, ServerFnMiddlewareContext<TMiddlewares>>;
+    /** Milliseconds, a duration string such as "30s", or false for no expiry. */
+    staleTime?: ServerQueryStaleTime;
+    handler: ServerFnHandler<TInputSchema extends ServerFnSchema ? InferServerFnSchemaOutput<TInputSchema> : unknown, unknown, ServerFnMiddlewareContext<TMiddlewares>>;
+};
+type ServerQuery<TInput, TResult> = ([unknown] extends [TInput] ? (input?: TInput) => Promise<TResult> : (input: TInput) => Promise<TResult>) & {
+    readonly __farmServerQuery: true;
+    readonly __farmServerQueryInput?: unknown;
+    readonly __farmServerQueryOutput?: unknown;
+};
+declare const FARM_SERVER_QUERY_SYMBOL: unique symbol;
+declare function createServerQuery<TInputSchema extends ServerFnSchema, TOutputSchema extends ServerFnSchema, const TMiddlewares extends readonly AnyServerFnMiddleware[] = readonly []>(options: ServerQueryOutputOptions<TInputSchema, TOutputSchema, TMiddlewares>): ServerQuery<InferServerFnSchemaInput<TInputSchema>, Awaited<InferServerFnSchemaOutput<TOutputSchema>>>;
+declare function createServerQuery<TOutputSchema extends ServerFnSchema, const TMiddlewares extends readonly AnyServerFnMiddleware[] = readonly []>(options: ServerQueryOutputOptions<undefined, TOutputSchema, TMiddlewares>): ServerQuery<unknown, Awaited<InferServerFnSchemaOutput<TOutputSchema>>>;
+declare function createServerQuery<TSchema extends ServerFnSchema, TResult, const TMiddlewares extends readonly AnyServerFnMiddleware[] = readonly []>(options: ServerQueryOptions<TSchema, TResult, TMiddlewares>): ServerQuery<InferServerFnSchemaInput<TSchema>, Awaited<TResult>>;
+declare function createServerQuery<TResult, const TMiddlewares extends readonly AnyServerFnMiddleware[] = readonly []>(options: ServerQueryOptions<undefined, TResult, TMiddlewares>): ServerQuery<unknown, Awaited<TResult>>;
+
+export { FARM_SERVER_QUERY_SYMBOL, type ServerQuery, type ServerQueryKey, type ServerQueryOptions, type ServerQueryOutputOptions, type ServerQueryStaleTime, createServerQuery };