@farm.js/core 0.1.61 → 0.1.63

package/dist/route.d-BaVH3V0w.d.mts

@@ -0,0 +1,224 @@
+import { c as EndpointMiddlewareResult, R as RouteSchema, d as RouteSchemaOutput, a as EndpointMCPOptions, A as AnyEndpointMiddleware, I as InferEndpointMiddlewareContext, T as TypedEndpoint, e as RouteSchemaInput } from './endpoint.d-BkMSCRf6.mjs';
+
+type FarmIntegrationAPIMethod = "GET" | "QUERY" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD";
+type FarmIntegrationAPIBodyFormat = "json" | "form" | "none";
+type FarmIntegrationAPIResponseFormat = "json" | "text" | "response";
+interface FarmIntegrationAPIOperation<TBody = never, TQuery = never, TResponse = unknown, TServer extends boolean = false, TMethod extends FarmIntegrationAPIMethod = FarmIntegrationAPIMethod> {
+    readonly kind: "farm-integration-api-operation";
+    path: string;
+    method: TMethod;
+    bodyFormat?: FarmIntegrationAPIBodyFormat;
+    responseFormat?: FarmIntegrationAPIResponseFormat;
+    headers?: Record<string, string>;
+    credentials?: RequestCredentials;
+    isServer?: TServer;
+    __pathless?: boolean;
+    __types?: {
+        body: TBody;
+        query: TQuery;
+        response: TResponse;
+    };
+}
+type FarmIntegrationAPI = {
+    [key: string]: FarmIntegrationAPI | FarmIntegrationAPIOperation<any, any, any, any, any>;
+};
+type FarmIntegrationRouteOperationCarrier<TPath extends string = string, TOperation extends FarmIntegrationAPIOperation<any, any, any, any, any> = FarmIntegrationAPIOperation<any, any, any, any, any>> = {
+    path: TPath;
+    __operation: TOperation;
+};
+type IntegrationAPIBuilderOptions<TServer extends boolean = false> = Omit<FarmIntegrationAPIOperation<any, any, any, TServer>, "kind" | "method" | "path" | "__pathless" | "__types">;
+declare function defineIntegrationAPIOperation<TBody = never, TQuery = never, TResponse = unknown, TServer extends boolean = false, TMethod extends FarmIntegrationAPIMethod = FarmIntegrationAPIMethod>(operation: Omit<FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, TMethod>, "kind" | "__types">): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, TMethod>;
+declare function defineIntegrationAPI<TAPI extends FarmIntegrationAPI>(api: TAPI): TAPI;
+declare function get<TResponse = unknown, TServer extends boolean = false>(path: string, options?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<never, never, TResponse, TServer, "GET">;
+declare function get<TQuery = never, TResponse = unknown, TServer extends boolean = false>(path: string, options?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<never, TQuery, TResponse, TServer, "GET">;
+declare function get<TResponse = unknown, TServer extends boolean = false>(options?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<never, never, TResponse, TServer, "GET">;
+declare function get<TQuery = never, TResponse = unknown, TServer extends boolean = false>(options?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<never, TQuery, TResponse, TServer, "GET">;
+type RouteOperationsToAPI<TOperations extends readonly FarmIntegrationAPIOperation<any, any, any, any, any>[]> = {
+    [TMethod in Lowercase<TOperations[number]["method"] & string>]: Extract<TOperations[number], {
+        method: Uppercase<TMethod>;
+    }>;
+};
+type StripRouteClientPrefix<TPath extends string> = TPath extends `/api/${string}/${infer TRest}` ? TRest : TPath extends `/${string}/${infer TRest}` ? TRest : TPath extends `/${infer TRest}` ? TRest : TPath;
+type NormalizeRouteSegment<TSegment extends string> = TSegment extends `[...${infer TName}]` ? TName : TSegment extends `[${infer TName}]` ? TName : TSegment extends `${infer TName}(${string}` ? TName : CamelCaseRouteSegment<TSegment>;
+type CamelCaseRouteSegment<TSegment extends string> = TSegment extends `${infer THead}-${infer TTail}` ? `${THead}${Capitalize<CamelCaseRouteSegment<TTail>>}` : TSegment;
+type RouteNamespaceFromPath<TPath extends string, TOperation extends FarmIntegrationAPIOperation<any, any, any, any, any>> = TPath extends `${infer THead}/${infer TTail}` ? {
+    [TKey in NormalizeRouteSegment<THead>]: RouteNamespaceFromPath<TTail, TOperation>;
+} : {
+    [TKey in NormalizeRouteSegment<TPath>]: {
+        [TMethod in Lowercase<TOperation["method"] & string>]: TOperation;
+    };
+};
+type UnionToIntersection$1<TUnion> = (TUnion extends unknown ? (value: TUnion) => void : never) extends (value: infer TIntersection) => void ? TIntersection : never;
+type ExpandRecursively<TValue> = TValue extends (...args: any[]) => any ? TValue : TValue extends object ? {
+    [TKey in keyof TValue]: ExpandRecursively<TValue[TKey]>;
+} : TValue;
+type RoutesToAPI<TRoutes extends readonly FarmIntegrationRouteOperationCarrier<string, any>[]> = ExpandRecursively<UnionToIntersection$1<TRoutes[number] extends FarmIntegrationRouteOperationCarrier<infer TPath, infer TOperation> ? RouteNamespaceFromPath<StripRouteClientPrefix<TPath>, TOperation> : never>>;
+type InferIntegrationAPIFromRoutes<TRoutes extends readonly FarmIntegrationRouteOperationCarrier<string, any>[]> = RoutesToAPI<TRoutes>;
+declare function route<TAPI extends FarmIntegrationAPI>(path: string, definition: TAPI): TAPI;
+declare function route<TOperations extends readonly FarmIntegrationAPIOperation<any, any, any, any, any>[]>(path: string, ...operations: TOperations): RouteOperationsToAPI<TOperations>;
+declare function fromRoutes<TRoutes extends readonly FarmIntegrationRouteOperationCarrier<string, any>[]>(routes: TRoutes): RoutesToAPI<TRoutes>;
+declare const api: {
+    get: typeof get;
+    route: typeof route;
+    fromRoutes: typeof fromRoutes;
+    query<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "QUERY">;
+    post<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "POST">;
+    put<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "PUT">;
+    patch<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "PATCH">;
+    delete<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "DELETE">;
+    options<TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<never, TQuery, TResponse, TServer, "OPTIONS">;
+    head<TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<never, TQuery, TResponse, TServer, "HEAD">;
+    form: {
+        query<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "QUERY">;
+        post<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "POST">;
+        put<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "PUT">;
+        patch<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "PATCH">;
+        delete<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "DELETE">;
+    };
+};
+declare const endpoint: {
+    get: typeof get;
+    route: typeof route;
+    fromRoutes: typeof fromRoutes;
+    query<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "QUERY">;
+    post<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "POST">;
+    put<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "PUT">;
+    patch<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "PATCH">;
+    delete<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "DELETE">;
+    options<TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<never, TQuery, TResponse, TServer, "OPTIONS">;
+    head<TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<never, TQuery, TResponse, TServer, "HEAD">;
+    form: {
+        query<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "QUERY">;
+        post<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "POST">;
+        put<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "PUT">;
+        patch<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "PATCH">;
+        delete<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "DELETE">;
+    };
+};
+
+type RouteMethod = "GET" | "HEAD" | "QUERY" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS";
+type RoutePathParams<Path extends string> = Path extends `${infer Head}/${infer Tail}` ? RoutePathParams<Head> & RoutePathParams<Tail> : Path extends `[[...${infer Name}]]` ? {
+    [K in Name]?: string[];
+} : Path extends `[...${infer Name}]` ? {
+    [K in Name]: string[];
+} : Path extends `[${infer Name}]` ? {
+    [K in Name]: string;
+} : {};
+interface RouteInputSchemas {
+    body?: RouteSchema;
+    query?: RouteSchema;
+    params?: RouteSchema;
+    headers?: RouteSchema;
+}
+type Input<I, K extends PropertyKey> = K extends keyof I ? RouteSchemaInput<I[K]> : never;
+type Output<I, K extends PropertyKey, Fallback = unknown> = K extends keyof I ? RouteSchemaOutput<I[K]> : Fallback;
+/** JSON responses have wire types, not server-side instances such as Date. */
+type RouteJSON<T> = T extends Response ? unknown : T extends {
+    toJSON(): infer J;
+} ? RouteJSON<J> : T extends bigint | symbol | ((...args: any[]) => any) ? never : T extends readonly (infer V)[] ? RouteJSON<V>[] : T extends object ? {
+    [K in keyof T]: RouteJSON<T[K]>;
+} : T;
+type RouteDefinition<P extends string = string, M extends RouteMethod = RouteMethod, E = any> = {
+    readonly path: P;
+    readonly method: M;
+    readonly endpoint: E;
+};
+type RouteEndpoint<P extends string, I extends RouteInputSchemas, R> = TypedEndpoint<Output<I, "body">, Input<I, "query">, RouteJSON<R>, Input<I, "headers">, never, Input<I, "body">> & {
+    __types: {
+        params: RoutePathParams<P>;
+        inputHeaders: Input<I, "headers">;
+    };
+};
+type TrimStart<P extends string> = P extends `/${infer Rest}` ? TrimStart<Rest> : P;
+type Join<P extends string, C extends string> = C extends "" ? P : `${P}/${TrimStart<C>}`;
+type ParamsCheck<P extends string, I extends RouteInputSchemas> = I extends {
+    params: infer S;
+} ? Exclude<keyof RoutePathParams<P>, keyof RouteSchemaOutput<S>> extends never ? Exclude<keyof RouteSchemaOutput<S>, keyof RoutePathParams<P>> extends never ? unknown : {
+    __error_unknown_route_params: never;
+} : {
+    __error_missing_route_params: never;
+} : unknown;
+type RouteMiddlewareResults = readonly (EndpointMiddlewareResult | Promise<EndpointMiddlewareResult>)[];
+type RouteMiddlewares<Results extends readonly unknown[]> = {
+    readonly [K in keyof Results]: (context: Parameters<AnyEndpointMiddleware>[0]) => Results[K];
+};
+type RouteOptions<P extends string, I extends RouteInputSchemas, O extends RouteSchema | undefined, R, MiddlewareResults extends RouteMiddlewareResults = RouteMiddlewareResults> = {
+    input?: I & ParamsCheck<P, I>;
+    /** Validate plain JSON handler results. Raw Response/stream results are never buffered. */
+    output?: O;
+    /** Opt this app-owned endpoint into an installed MCP transport. */
+    mcp?: EndpointMCPOptions;
+    middleware?: RouteMiddlewares<MiddlewareResults>;
+    handler(request: Request, context: {
+        input: {
+            body: Output<I, "body">;
+            query: Output<I, "query", Record<string, string | string[]>>;
+            headers: Output<I, "headers", Record<string, string>>;
+            params: Output<I, "params", RoutePathParams<P>>;
+        };
+        params: Output<I, "params", RoutePathParams<P>>;
+        context: Readonly<InferEndpointMiddlewareContext<RouteMiddlewares<MiddlewareResults>>>;
+    }): R | Promise<R>;
+};
+type RouteBuilder<P extends string, M extends RouteMethod> = <const C extends string, const MiddlewareResults extends RouteMiddlewareResults, const I extends RouteInputSchemas = {}, O extends RouteSchema | undefined = undefined, R = unknown>(path: C, options: RouteOptions<Join<P, C>, I, O, R, MiddlewareResults>) => RouteDefinition<Join<P, C>, M, RouteEndpoint<Join<P, C>, I, Extract<Awaited<R>, Response> extends never ? O extends RouteSchema ? RouteSchemaOutput<O> : Awaited<R> : unknown>>;
+type RouteFactory<P extends string = ""> = {
+    [M in Lowercase<RouteMethod>]: RouteBuilder<P, Uppercase<M> & RouteMethod>;
+} & {
+    /** Return a new builder; never mutate the parent scope. */
+    scope<const C extends string>(path: C): RouteFactory<Join<P, C>>;
+};
+type PluginRoutes = readonly RouteDefinition[];
+interface PluginLocalAPIEndpoint {
+    readonly path: string;
+    readonly method: RouteMethod;
+    readonly input: Readonly<RouteInputSchemas>;
+    readonly output?: RouteSchema;
+    readonly mcp?: EndpointMCPOptions;
+    invoke(request: Request, params?: Readonly<Record<string, string | string[]>>): Promise<Response>;
+}
+/**
+ * Read-only access to app-owned API endpoints while plugin routes are mounted.
+ * Plugin routes are intentionally excluded so a plugin cannot recurse through
+ * itself or depend on plugin registration order.
+ */
+interface PluginLocalAPI {
+    /** False during type-only route discovery, where app endpoint modules are unavailable. */
+    readonly available: boolean;
+    get(method: RouteMethod, path: string): PluginLocalAPIEndpoint | undefined;
+    /** Enumerate app-owned endpoints. Plugin routes are excluded. */
+    list(): readonly PluginLocalAPIEndpoint[];
+}
+type PluginRoutesFactory<R extends PluginRoutes = PluginRoutes> = (context: {
+    route: RouteFactory;
+    api: PluginLocalAPI;
+}) => R;
+declare function createRouteFactory(): RouteFactory;
+type UnionToIntersection<U> = (U extends unknown ? (v: U) => void : never) extends (v: infer I) => void ? I : never;
+type RouteTree<P extends string, M extends string, E> = P extends `${infer Head}/${infer Tail}` ? {
+    [K in Head]: RouteTree<Tail, M, E>;
+} : P extends "" ? {
+    [K in Lowercase<M>]: E;
+} : {
+    [K in P]: {
+        [Method in Lowercase<M>]: E;
+    };
+};
+type HasMethodSegment<P extends string> = P extends `${infer H}/${infer T}` ? H extends Lowercase<RouteMethod> ? true : HasMethodSegment<T> : P extends Lowercase<RouteMethod> ? true : false;
+type DefinitionTree<D> = D extends RouteDefinition<infer P, infer M, infer E> ? string extends P ? {} : (P extends `/api/integrations${string}` ? true : HasMethodSegment<P>) extends true ? {
+    [K in P extends `/api/${infer C}` ? `/${C}` : "/"]: {
+        [Method in Lowercase<M>]: E;
+    };
+} : RouteTree<P extends `/api/${infer C}` ? C : "", M, E> : {};
+type PluginAPIRouter<C> = C extends {
+    plugins: readonly (infer P)[];
+} ? UnionToIntersection<P extends {
+    routes?: PluginRoutesFactory<infer R>;
+} ? DefinitionTree<R[number]> : {}> : {};
+declare function resolvePluginRoutes(plugins?: readonly {
+    name: string;
+    routes?: PluginRoutesFactory;
+}[], context?: {
+    api?: PluginLocalAPI;
+}): PluginRoutes;
+
+export { type FarmIntegrationAPI as F, type InferIntegrationAPIFromRoutes as I, type PluginLocalAPI as P, type RouteDefinition as R, type PluginLocalAPIEndpoint as a, type PluginRoutes as b, type PluginRoutesFactory as c, type RouteMethod as d, type FarmIntegrationAPIBodyFormat as e, type FarmIntegrationAPIMethod as f, type FarmIntegrationAPIOperation as g, type FarmIntegrationAPIResponseFormat as h, type FarmIntegrationRouteOperationCarrier as i, type PluginAPIRouter as j, type RouteFactory as k, type RouteInputSchemas as l, type RouteJSON as m, type RouteOptions as n, type RoutePathParams as o, api as p, createRouteFactory as q, defineIntegrationAPI as r, defineIntegrationAPIOperation as s, endpoint as t, resolvePluginRoutes as u };

package/dist/route.d-DBTEqifW.d.ts

@@ -0,0 +1,224 @@
+import { c as EndpointMiddlewareResult, R as RouteSchema, d as RouteSchemaOutput, a as EndpointMCPOptions, A as AnyEndpointMiddleware, I as InferEndpointMiddlewareContext, T as TypedEndpoint, e as RouteSchemaInput } from './endpoint.d-BgHn0lhl.js';
+
+type FarmIntegrationAPIMethod = "GET" | "QUERY" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD";
+type FarmIntegrationAPIBodyFormat = "json" | "form" | "none";
+type FarmIntegrationAPIResponseFormat = "json" | "text" | "response";
+interface FarmIntegrationAPIOperation<TBody = never, TQuery = never, TResponse = unknown, TServer extends boolean = false, TMethod extends FarmIntegrationAPIMethod = FarmIntegrationAPIMethod> {
+    readonly kind: "farm-integration-api-operation";
+    path: string;
+    method: TMethod;
+    bodyFormat?: FarmIntegrationAPIBodyFormat;
+    responseFormat?: FarmIntegrationAPIResponseFormat;
+    headers?: Record<string, string>;
+    credentials?: RequestCredentials;
+    isServer?: TServer;
+    __pathless?: boolean;
+    __types?: {
+        body: TBody;
+        query: TQuery;
+        response: TResponse;
+    };
+}
+type FarmIntegrationAPI = {
+    [key: string]: FarmIntegrationAPI | FarmIntegrationAPIOperation<any, any, any, any, any>;
+};
+type FarmIntegrationRouteOperationCarrier<TPath extends string = string, TOperation extends FarmIntegrationAPIOperation<any, any, any, any, any> = FarmIntegrationAPIOperation<any, any, any, any, any>> = {
+    path: TPath;
+    __operation: TOperation;
+};
+type IntegrationAPIBuilderOptions<TServer extends boolean = false> = Omit<FarmIntegrationAPIOperation<any, any, any, TServer>, "kind" | "method" | "path" | "__pathless" | "__types">;
+declare function defineIntegrationAPIOperation<TBody = never, TQuery = never, TResponse = unknown, TServer extends boolean = false, TMethod extends FarmIntegrationAPIMethod = FarmIntegrationAPIMethod>(operation: Omit<FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, TMethod>, "kind" | "__types">): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, TMethod>;
+declare function defineIntegrationAPI<TAPI extends FarmIntegrationAPI>(api: TAPI): TAPI;
+declare function get<TResponse = unknown, TServer extends boolean = false>(path: string, options?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<never, never, TResponse, TServer, "GET">;
+declare function get<TQuery = never, TResponse = unknown, TServer extends boolean = false>(path: string, options?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<never, TQuery, TResponse, TServer, "GET">;
+declare function get<TResponse = unknown, TServer extends boolean = false>(options?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<never, never, TResponse, TServer, "GET">;
+declare function get<TQuery = never, TResponse = unknown, TServer extends boolean = false>(options?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<never, TQuery, TResponse, TServer, "GET">;
+type RouteOperationsToAPI<TOperations extends readonly FarmIntegrationAPIOperation<any, any, any, any, any>[]> = {
+    [TMethod in Lowercase<TOperations[number]["method"] & string>]: Extract<TOperations[number], {
+        method: Uppercase<TMethod>;
+    }>;
+};
+type StripRouteClientPrefix<TPath extends string> = TPath extends `/api/${string}/${infer TRest}` ? TRest : TPath extends `/${string}/${infer TRest}` ? TRest : TPath extends `/${infer TRest}` ? TRest : TPath;
+type NormalizeRouteSegment<TSegment extends string> = TSegment extends `[...${infer TName}]` ? TName : TSegment extends `[${infer TName}]` ? TName : TSegment extends `${infer TName}(${string}` ? TName : CamelCaseRouteSegment<TSegment>;
+type CamelCaseRouteSegment<TSegment extends string> = TSegment extends `${infer THead}-${infer TTail}` ? `${THead}${Capitalize<CamelCaseRouteSegment<TTail>>}` : TSegment;
+type RouteNamespaceFromPath<TPath extends string, TOperation extends FarmIntegrationAPIOperation<any, any, any, any, any>> = TPath extends `${infer THead}/${infer TTail}` ? {
+    [TKey in NormalizeRouteSegment<THead>]: RouteNamespaceFromPath<TTail, TOperation>;
+} : {
+    [TKey in NormalizeRouteSegment<TPath>]: {
+        [TMethod in Lowercase<TOperation["method"] & string>]: TOperation;
+    };
+};
+type UnionToIntersection$1<TUnion> = (TUnion extends unknown ? (value: TUnion) => void : never) extends (value: infer TIntersection) => void ? TIntersection : never;
+type ExpandRecursively<TValue> = TValue extends (...args: any[]) => any ? TValue : TValue extends object ? {
+    [TKey in keyof TValue]: ExpandRecursively<TValue[TKey]>;
+} : TValue;
+type RoutesToAPI<TRoutes extends readonly FarmIntegrationRouteOperationCarrier<string, any>[]> = ExpandRecursively<UnionToIntersection$1<TRoutes[number] extends FarmIntegrationRouteOperationCarrier<infer TPath, infer TOperation> ? RouteNamespaceFromPath<StripRouteClientPrefix<TPath>, TOperation> : never>>;
+type InferIntegrationAPIFromRoutes<TRoutes extends readonly FarmIntegrationRouteOperationCarrier<string, any>[]> = RoutesToAPI<TRoutes>;
+declare function route<TAPI extends FarmIntegrationAPI>(path: string, definition: TAPI): TAPI;
+declare function route<TOperations extends readonly FarmIntegrationAPIOperation<any, any, any, any, any>[]>(path: string, ...operations: TOperations): RouteOperationsToAPI<TOperations>;
+declare function fromRoutes<TRoutes extends readonly FarmIntegrationRouteOperationCarrier<string, any>[]>(routes: TRoutes): RoutesToAPI<TRoutes>;
+declare const api: {
+    get: typeof get;
+    route: typeof route;
+    fromRoutes: typeof fromRoutes;
+    query<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "QUERY">;
+    post<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "POST">;
+    put<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "PUT">;
+    patch<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "PATCH">;
+    delete<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "DELETE">;
+    options<TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<never, TQuery, TResponse, TServer, "OPTIONS">;
+    head<TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<never, TQuery, TResponse, TServer, "HEAD">;
+    form: {
+        query<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "QUERY">;
+        post<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "POST">;
+        put<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "PUT">;
+        patch<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "PATCH">;
+        delete<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "DELETE">;
+    };
+};
+declare const endpoint: {
+    get: typeof get;
+    route: typeof route;
+    fromRoutes: typeof fromRoutes;
+    query<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "QUERY">;
+    post<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "POST">;
+    put<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "PUT">;
+    patch<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "PATCH">;
+    delete<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "DELETE">;
+    options<TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<never, TQuery, TResponse, TServer, "OPTIONS">;
+    head<TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<never, TQuery, TResponse, TServer, "HEAD">;
+    form: {
+        query<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "QUERY">;
+        post<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "POST">;
+        put<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "PUT">;
+        patch<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "PATCH">;
+        delete<TBody = never, TResponse = unknown, TQuery = never, TServer extends boolean = false>(pathOrOptions?: string | IntegrationAPIBuilderOptions<TServer>, maybeOptions?: IntegrationAPIBuilderOptions<TServer>): FarmIntegrationAPIOperation<TBody, TQuery, TResponse, TServer, "DELETE">;
+    };
+};
+
+type RouteMethod = "GET" | "HEAD" | "QUERY" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS";
+type RoutePathParams<Path extends string> = Path extends `${infer Head}/${infer Tail}` ? RoutePathParams<Head> & RoutePathParams<Tail> : Path extends `[[...${infer Name}]]` ? {
+    [K in Name]?: string[];
+} : Path extends `[...${infer Name}]` ? {
+    [K in Name]: string[];
+} : Path extends `[${infer Name}]` ? {
+    [K in Name]: string;
+} : {};
+interface RouteInputSchemas {
+    body?: RouteSchema;
+    query?: RouteSchema;
+    params?: RouteSchema;
+    headers?: RouteSchema;
+}
+type Input<I, K extends PropertyKey> = K extends keyof I ? RouteSchemaInput<I[K]> : never;
+type Output<I, K extends PropertyKey, Fallback = unknown> = K extends keyof I ? RouteSchemaOutput<I[K]> : Fallback;
+/** JSON responses have wire types, not server-side instances such as Date. */
+type RouteJSON<T> = T extends Response ? unknown : T extends {
+    toJSON(): infer J;
+} ? RouteJSON<J> : T extends bigint | symbol | ((...args: any[]) => any) ? never : T extends readonly (infer V)[] ? RouteJSON<V>[] : T extends object ? {
+    [K in keyof T]: RouteJSON<T[K]>;
+} : T;
+type RouteDefinition<P extends string = string, M extends RouteMethod = RouteMethod, E = any> = {
+    readonly path: P;
+    readonly method: M;
+    readonly endpoint: E;
+};
+type RouteEndpoint<P extends string, I extends RouteInputSchemas, R> = TypedEndpoint<Output<I, "body">, Input<I, "query">, RouteJSON<R>, Input<I, "headers">, never, Input<I, "body">> & {
+    __types: {
+        params: RoutePathParams<P>;
+        inputHeaders: Input<I, "headers">;
+    };
+};
+type TrimStart<P extends string> = P extends `/${infer Rest}` ? TrimStart<Rest> : P;
+type Join<P extends string, C extends string> = C extends "" ? P : `${P}/${TrimStart<C>}`;
+type ParamsCheck<P extends string, I extends RouteInputSchemas> = I extends {
+    params: infer S;
+} ? Exclude<keyof RoutePathParams<P>, keyof RouteSchemaOutput<S>> extends never ? Exclude<keyof RouteSchemaOutput<S>, keyof RoutePathParams<P>> extends never ? unknown : {
+    __error_unknown_route_params: never;
+} : {
+    __error_missing_route_params: never;
+} : unknown;
+type RouteMiddlewareResults = readonly (EndpointMiddlewareResult | Promise<EndpointMiddlewareResult>)[];
+type RouteMiddlewares<Results extends readonly unknown[]> = {
+    readonly [K in keyof Results]: (context: Parameters<AnyEndpointMiddleware>[0]) => Results[K];
+};
+type RouteOptions<P extends string, I extends RouteInputSchemas, O extends RouteSchema | undefined, R, MiddlewareResults extends RouteMiddlewareResults = RouteMiddlewareResults> = {
+    input?: I & ParamsCheck<P, I>;
+    /** Validate plain JSON handler results. Raw Response/stream results are never buffered. */
+    output?: O;
+    /** Opt this app-owned endpoint into an installed MCP transport. */
+    mcp?: EndpointMCPOptions;
+    middleware?: RouteMiddlewares<MiddlewareResults>;
+    handler(request: Request, context: {
+        input: {
+            body: Output<I, "body">;
+            query: Output<I, "query", Record<string, string | string[]>>;
+            headers: Output<I, "headers", Record<string, string>>;
+            params: Output<I, "params", RoutePathParams<P>>;
+        };
+        params: Output<I, "params", RoutePathParams<P>>;
+        context: Readonly<InferEndpointMiddlewareContext<RouteMiddlewares<MiddlewareResults>>>;
+    }): R | Promise<R>;
+};
+type RouteBuilder<P extends string, M extends RouteMethod> = <const C extends string, const MiddlewareResults extends RouteMiddlewareResults, const I extends RouteInputSchemas = {}, O extends RouteSchema | undefined = undefined, R = unknown>(path: C, options: RouteOptions<Join<P, C>, I, O, R, MiddlewareResults>) => RouteDefinition<Join<P, C>, M, RouteEndpoint<Join<P, C>, I, Extract<Awaited<R>, Response> extends never ? O extends RouteSchema ? RouteSchemaOutput<O> : Awaited<R> : unknown>>;
+type RouteFactory<P extends string = ""> = {
+    [M in Lowercase<RouteMethod>]: RouteBuilder<P, Uppercase<M> & RouteMethod>;
+} & {
+    /** Return a new builder; never mutate the parent scope. */
+    scope<const C extends string>(path: C): RouteFactory<Join<P, C>>;
+};
+type PluginRoutes = readonly RouteDefinition[];
+interface PluginLocalAPIEndpoint {
+    readonly path: string;
+    readonly method: RouteMethod;
+    readonly input: Readonly<RouteInputSchemas>;
+    readonly output?: RouteSchema;
+    readonly mcp?: EndpointMCPOptions;
+    invoke(request: Request, params?: Readonly<Record<string, string | string[]>>): Promise<Response>;
+}
+/**
+ * Read-only access to app-owned API endpoints while plugin routes are mounted.
+ * Plugin routes are intentionally excluded so a plugin cannot recurse through
+ * itself or depend on plugin registration order.
+ */
+interface PluginLocalAPI {
+    /** False during type-only route discovery, where app endpoint modules are unavailable. */
+    readonly available: boolean;
+    get(method: RouteMethod, path: string): PluginLocalAPIEndpoint | undefined;
+    /** Enumerate app-owned endpoints. Plugin routes are excluded. */
+    list(): readonly PluginLocalAPIEndpoint[];
+}
+type PluginRoutesFactory<R extends PluginRoutes = PluginRoutes> = (context: {
+    route: RouteFactory;
+    api: PluginLocalAPI;
+}) => R;
+declare function createRouteFactory(): RouteFactory;
+type UnionToIntersection<U> = (U extends unknown ? (v: U) => void : never) extends (v: infer I) => void ? I : never;
+type RouteTree<P extends string, M extends string, E> = P extends `${infer Head}/${infer Tail}` ? {
+    [K in Head]: RouteTree<Tail, M, E>;
+} : P extends "" ? {
+    [K in Lowercase<M>]: E;
+} : {
+    [K in P]: {
+        [Method in Lowercase<M>]: E;
+    };
+};
+type HasMethodSegment<P extends string> = P extends `${infer H}/${infer T}` ? H extends Lowercase<RouteMethod> ? true : HasMethodSegment<T> : P extends Lowercase<RouteMethod> ? true : false;
+type DefinitionTree<D> = D extends RouteDefinition<infer P, infer M, infer E> ? string extends P ? {} : (P extends `/api/integrations${string}` ? true : HasMethodSegment<P>) extends true ? {
+    [K in P extends `/api/${infer C}` ? `/${C}` : "/"]: {
+        [Method in Lowercase<M>]: E;
+    };
+} : RouteTree<P extends `/api/${infer C}` ? C : "", M, E> : {};
+type PluginAPIRouter<C> = C extends {
+    plugins: readonly (infer P)[];
+} ? UnionToIntersection<P extends {
+    routes?: PluginRoutesFactory<infer R>;
+} ? DefinitionTree<R[number]> : {}> : {};
+declare function resolvePluginRoutes(plugins?: readonly {
+    name: string;
+    routes?: PluginRoutesFactory;
+}[], context?: {
+    api?: PluginLocalAPI;
+}): PluginRoutes;
+
+export { type FarmIntegrationAPI as F, type InferIntegrationAPIFromRoutes as I, type PluginLocalAPI as P, type RouteDefinition as R, type PluginLocalAPIEndpoint as a, type PluginRoutes as b, type PluginRoutesFactory as c, type RouteMethod as d, type FarmIntegrationAPIBodyFormat as e, type FarmIntegrationAPIMethod as f, type FarmIntegrationAPIOperation as g, type FarmIntegrationAPIResponseFormat as h, type FarmIntegrationRouteOperationCarrier as i, type PluginAPIRouter as j, type RouteFactory as k, type RouteInputSchemas as l, type RouteJSON as m, type RouteOptions as n, type RoutePathParams as o, api as p, createRouteFactory as q, defineIntegrationAPI as r, defineIntegrationAPIOperation as s, endpoint as t, resolvePluginRoutes as u };

package/dist/router.cjs

@@ -3,13 +3,13 @@
 
 
 
-var _chunkSU7MH53Pcjs = require('./chunk-SU7MH53P.cjs');
-require('./chunk-PCOTGFSM.cjs');
-require('./chunk-NO3WWW3N.cjs');
-require('./chunk-S3JO3N4H.cjs');
+var _chunk53EHWHT2cjs = require('./chunk-53EHWHT2.cjs');
+require('./chunk-D4XGKF67.cjs');
+require('./chunk-YTVSWXEZ.cjs');
+require('./chunk-BTZ5O6VM.cjs');
 
 
 
 
 
-exports.buildFarmRoutePath = _chunkSU7MH53Pcjs.buildFarmRoutePath; exports.createFarmRouter = _chunkSU7MH53Pcjs.createFarmRouter; exports.isFarmRouteActive = _chunkSU7MH53Pcjs.isFarmRouteActive; exports.matchFarmRoute = _chunkSU7MH53Pcjs.matchFarmRoute;
+exports.buildFarmRoutePath = _chunk53EHWHT2cjs.buildFarmRoutePath; exports.createFarmRouter = _chunk53EHWHT2cjs.createFarmRouter; exports.isFarmRouteActive = _chunk53EHWHT2cjs.isFarmRouteActive; exports.matchFarmRoute = _chunk53EHWHT2cjs.matchFarmRoute;

package/dist/router.d-CZQmbpHx.d.mts

@@ -0,0 +1,50 @@
+import { RefObject } from 'react';
+import { FarmRouterRouteInput } from './router.mjs';
+import { F as FarmNavigationBlockerContext, a as FarmNavigationState } from './spa-router.d-CtSHzXlC.mjs';
+
+interface UseRouterOptions {
+    basePath?: string;
+    routes?: FarmRouterRouteInput[];
+}
+interface UseBlockerOptions {
+    when: boolean | ((context: FarmNavigationBlockerContext) => boolean);
+    message?: string;
+    shouldBlock?: (context: FarmNavigationBlockerContext) => boolean | Promise<boolean>;
+}
+interface UseBlockerReturn {
+    active: boolean;
+}
+/**
+ * Hook for accessing router state and navigation
+ */
+/**
+ * Imperative navigation for useRouter. Delegates to the installed SPA router
+ * so blockers run before the URL changes, history state is written by the
+ * router, and the action is labelled push/replace rather than pop. Without a
+ * Farm router (embedded usage) the URL is written directly and announced on
+ * the shared history channel, whose no-router fallback is the nuqs-style
+ * synthetic popstate this code previously hand-rolled.
+ */
+/** The options Next.js's router accepts on `push` and `replace`. */
+interface FarmRouterNavigateOptions {
+    /** Scroll to the top, or to the URL's hash, after navigating. Defaults to true. */
+    scroll?: boolean;
+}
+declare function useRouter(options?: UseRouterOptions): {
+    push: (href: string, navigateOptions?: FarmRouterNavigateOptions) => void;
+    replace: (href: string, navigateOptions?: FarmRouterNavigateOptions) => void;
+    pushState: <TState>(pageState: TState, href?: string) => void;
+    replaceState: <TState>(pageState: TState, href?: string) => void;
+    back: () => void;
+    forward: () => void;
+    pathname: string;
+    searchParams: URLSearchParams;
+    params: Record<string, string>;
+    pageState: unknown;
+};
+declare function usePageState<TState = unknown>(): TState | null;
+declare function useNavigation(): FarmNavigationState;
+declare function useBlocker(options: UseBlockerOptions): UseBlockerReturn;
+declare function useScrollRestoration<TElement extends HTMLElement = HTMLElement>(key: string): RefObject<TElement | null>;
+
+export { type FarmRouterNavigateOptions as F, type UseBlockerOptions as U, type UseBlockerReturn as a, type UseRouterOptions as b, useNavigation as c, usePageState as d, useRouter as e, useScrollRestoration as f, useBlocker as u };

package/dist/router.d-crorSRiW.d.ts

@@ -0,0 +1,50 @@
+import { RefObject } from 'react';
+import { FarmRouterRouteInput } from './router.js';
+import { F as FarmNavigationBlockerContext, a as FarmNavigationState } from './spa-router.d-CCADbSqJ.js';
+
+interface UseRouterOptions {
+    basePath?: string;
+    routes?: FarmRouterRouteInput[];
+}
+interface UseBlockerOptions {
+    when: boolean | ((context: FarmNavigationBlockerContext) => boolean);
+    message?: string;
+    shouldBlock?: (context: FarmNavigationBlockerContext) => boolean | Promise<boolean>;
+}
+interface UseBlockerReturn {
+    active: boolean;
+}
+/**
+ * Hook for accessing router state and navigation
+ */
+/**
+ * Imperative navigation for useRouter. Delegates to the installed SPA router
+ * so blockers run before the URL changes, history state is written by the
+ * router, and the action is labelled push/replace rather than pop. Without a
+ * Farm router (embedded usage) the URL is written directly and announced on
+ * the shared history channel, whose no-router fallback is the nuqs-style
+ * synthetic popstate this code previously hand-rolled.
+ */
+/** The options Next.js's router accepts on `push` and `replace`. */
+interface FarmRouterNavigateOptions {
+    /** Scroll to the top, or to the URL's hash, after navigating. Defaults to true. */
+    scroll?: boolean;
+}
+declare function useRouter(options?: UseRouterOptions): {
+    push: (href: string, navigateOptions?: FarmRouterNavigateOptions) => void;
+    replace: (href: string, navigateOptions?: FarmRouterNavigateOptions) => void;
+    pushState: <TState>(pageState: TState, href?: string) => void;
+    replaceState: <TState>(pageState: TState, href?: string) => void;
+    back: () => void;
+    forward: () => void;
+    pathname: string;
+    searchParams: URLSearchParams;
+    params: Record<string, string>;
+    pageState: unknown;
+};
+declare function usePageState<TState = unknown>(): TState | null;
+declare function useNavigation(): FarmNavigationState;
+declare function useBlocker(options: UseBlockerOptions): UseBlockerReturn;
+declare function useScrollRestoration<TElement extends HTMLElement = HTMLElement>(key: string): RefObject<TElement | null>;
+
+export { type FarmRouterNavigateOptions as F, type UseBlockerOptions as U, type UseBlockerReturn as a, type UseRouterOptions as b, useNavigation as c, usePageState as d, useRouter as e, useScrollRestoration as f, useBlocker as u };

package/dist/router.d.mts

@@ -0,0 +1,36 @@
+type FarmRouterPrimitiveParam = string | number | boolean;
+type FarmRouterPathParam = FarmRouterPrimitiveParam | readonly FarmRouterPrimitiveParam[] | null | undefined;
+type FarmRouterPathParams = Record<string, FarmRouterPathParam>;
+type FarmRouterParams = Record<string, string>;
+interface FarmRouterRoute<TMeta = unknown> {
+    path: string;
+    name?: string;
+    meta?: TMeta;
+}
+type FarmRouterRouteInput<TMeta = unknown> = string | FarmRouterRoute<TMeta>;
+interface FarmRouterMatch<TMeta = unknown> {
+    route: FarmRouterRoute<TMeta>;
+    pathname: string;
+    params: FarmRouterParams;
+}
+type FarmRouterQueryValue = FarmRouterPrimitiveParam | readonly FarmRouterPrimitiveParam[] | null | undefined;
+interface FarmRouterBuildOptions {
+    query?: URLSearchParams | Record<string, FarmRouterQueryValue>;
+    hash?: string;
+    trailingSlash?: boolean;
+}
+interface FarmRouterActiveOptions {
+    exact?: boolean;
+}
+interface FarmRouter<TMeta = unknown> {
+    routes: FarmRouterRoute<TMeta>[];
+    match(pathname: string): FarmRouterMatch<TMeta> | null;
+    build(pattern: string, params?: FarmRouterPathParams, options?: FarmRouterBuildOptions): string;
+    isActive(pattern: string, pathname: string, options?: FarmRouterActiveOptions): boolean;
+}
+declare function createFarmRouter<TMeta = unknown>(routes: FarmRouterRouteInput<TMeta>[]): FarmRouter<TMeta>;
+declare function matchFarmRoute(pattern: string, pathname: string): FarmRouterParams | null;
+declare function buildFarmRoutePath(pattern: string, params?: FarmRouterPathParams, options?: FarmRouterBuildOptions): string;
+declare function isFarmRouteActive(pattern: string, pathname: string, options?: FarmRouterActiveOptions): boolean;
+
+export { type FarmRouter, type FarmRouterActiveOptions, type FarmRouterBuildOptions, type FarmRouterMatch, type FarmRouterParams, type FarmRouterPathParam, type FarmRouterPathParams, type FarmRouterPrimitiveParam, type FarmRouterQueryValue, type FarmRouterRoute, type FarmRouterRouteInput, buildFarmRoutePath, createFarmRouter, isFarmRouteActive, matchFarmRoute };