@farm.js/core 0.1.0-beta.11 → 0.1.0-beta.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (238) hide show
  1. package/dist/chunk-53MVSX3R.mjs +168 -0
  2. package/dist/chunk-53MVSX3R.mjs.map +1 -0
  3. package/dist/{chunk-AW6I64AP.mjs → chunk-6ZXIQSXE.mjs} +16 -1
  4. package/dist/chunk-6ZXIQSXE.mjs.map +1 -0
  5. package/dist/chunk-7ZVN3YZI.mjs +333 -0
  6. package/dist/chunk-7ZVN3YZI.mjs.map +1 -0
  7. package/dist/{chunk-5EVQFRL2.mjs → chunk-ARCGE2VT.mjs} +2 -2
  8. package/dist/chunk-ARCGE2VT.mjs.map +1 -0
  9. package/dist/{chunk-7N62DNSO.mjs → chunk-H3TE3LOV.mjs} +2 -2
  10. package/dist/{chunk-QTZZ2ISQ.mjs → chunk-KLA67WKG.mjs} +1 -1
  11. package/dist/chunk-KLA67WKG.mjs.map +1 -0
  12. package/dist/{chunk-K5ZTUF22.mjs → chunk-L2PE36GQ.mjs} +7 -3
  13. package/dist/chunk-L2PE36GQ.mjs.map +1 -0
  14. package/dist/{chunk-4LND3PXF.mjs → chunk-OPHK6OJN.mjs} +513 -48
  15. package/dist/chunk-OPHK6OJN.mjs.map +1 -0
  16. package/dist/{chunk-77BOAQHI.mjs → chunk-PNFQQSRA.mjs} +754 -156
  17. package/dist/chunk-PNFQQSRA.mjs.map +1 -0
  18. package/dist/chunk-USLFXFFH.mjs +46 -0
  19. package/dist/chunk-USLFXFFH.mjs.map +1 -0
  20. package/dist/{chunk-4677KXB7.mjs → chunk-VUL55IAX.mjs} +368 -103
  21. package/dist/chunk-VUL55IAX.mjs.map +1 -0
  22. package/dist/client.cjs.map +1 -1
  23. package/dist/client.mjs +1 -1
  24. package/dist/{devtools-A22KUJZT.mjs → devtools-GAZ7F3KL.mjs} +4 -3
  25. package/dist/{devtools-A22KUJZT.mjs.map → devtools-GAZ7F3KL.mjs.map} +1 -1
  26. package/dist/docs.cjs +622 -124
  27. package/dist/docs.cjs.map +1 -1
  28. package/dist/docs.mjs +5 -3
  29. package/dist/font.cjs +19 -2
  30. package/dist/font.cjs.map +1 -1
  31. package/dist/font.mjs +7 -3
  32. package/dist/index.cjs +2235 -689
  33. package/dist/index.cjs.map +1 -1
  34. package/dist/index.mjs +27 -19
  35. package/dist/index.mjs.map +1 -1
  36. package/dist/internal/build-runtime.cjs +2062 -525
  37. package/dist/internal/build-runtime.cjs.map +1 -1
  38. package/dist/internal/build-runtime.mjs +13 -10
  39. package/dist/internal/client-runtime.cjs +169 -2
  40. package/dist/internal/client-runtime.cjs.map +1 -1
  41. package/dist/internal/client-runtime.mjs +170 -2
  42. package/dist/internal/client-runtime.mjs.map +1 -1
  43. package/dist/internal/config-runtime.cjs +22 -0
  44. package/dist/internal/config-runtime.cjs.map +1 -1
  45. package/dist/internal/config-runtime.mjs +3 -2
  46. package/dist/internal/metadata-image-runtime.cjs +199 -0
  47. package/dist/internal/metadata-image-runtime.cjs.map +1 -0
  48. package/dist/internal/metadata-image-runtime.mjs +8 -0
  49. package/dist/internal/metadata-image-runtime.mjs.map +1 -0
  50. package/dist/internal/production-runtime.cjs +310 -0
  51. package/dist/internal/production-runtime.cjs.map +1 -1
  52. package/dist/internal/production-runtime.mjs +10 -0
  53. package/dist/internal/production-runtime.mjs.map +1 -1
  54. package/dist/navigation.cjs.map +1 -1
  55. package/dist/navigation.mjs +2 -2
  56. package/dist/plugin.cjs +1550 -348
  57. package/dist/plugin.cjs.map +1 -1
  58. package/dist/plugin.mjs +9 -5
  59. package/dist/server.cjs +1663 -419
  60. package/dist/server.cjs.map +1 -1
  61. package/dist/server.mjs +17 -19
  62. package/dist/server.mjs.map +1 -1
  63. package/dist/version.cjs +1 -1
  64. package/dist/version.cjs.map +1 -1
  65. package/dist/version.mjs +1 -1
  66. package/dist/vite.cjs +1604 -358
  67. package/dist/vite.cjs.map +1 -1
  68. package/dist/vite.mjs +9 -5
  69. package/package.json +10 -1
  70. package/types/client.d.ts +115 -4
  71. package/dist/after.d.mts +0 -25
  72. package/dist/after.d.ts +0 -25
  73. package/dist/agent-runtime.d.mts +0 -94
  74. package/dist/agent-runtime.d.ts +0 -94
  75. package/dist/api/route-manager.d.mts +0 -66
  76. package/dist/api/route-manager.d.ts +0 -66
  77. package/dist/api/runtime.d.mts +0 -3
  78. package/dist/api/runtime.d.ts +0 -3
  79. package/dist/api.d.mts +0 -48
  80. package/dist/api.d.ts +0 -48
  81. package/dist/app-BNE2FoZ4.d.mts +0 -302
  82. package/dist/app-DRGUmJ3s.d.ts +0 -302
  83. package/dist/app-markdown.d.mts +0 -22
  84. package/dist/app-markdown.d.ts +0 -22
  85. package/dist/cache.d.mts +0 -192
  86. package/dist/cache.d.ts +0 -192
  87. package/dist/chunk-4677KXB7.mjs.map +0 -1
  88. package/dist/chunk-4LND3PXF.mjs.map +0 -1
  89. package/dist/chunk-5EVQFRL2.mjs.map +0 -1
  90. package/dist/chunk-77BOAQHI.mjs.map +0 -1
  91. package/dist/chunk-AW6I64AP.mjs.map +0 -1
  92. package/dist/chunk-K5ZTUF22.mjs.map +0 -1
  93. package/dist/chunk-QM746KUO.mjs +0 -56
  94. package/dist/chunk-QM746KUO.mjs.map +0 -1
  95. package/dist/chunk-QTZZ2ISQ.mjs.map +0 -1
  96. package/dist/client-BT1mFQas.d.mts +0 -447
  97. package/dist/client-Nn0q4eO4.d.ts +0 -447
  98. package/dist/client-cache-CIlyBlmx.d.ts +0 -6
  99. package/dist/client-cache-D-EZ7XVW.d.mts +0 -6
  100. package/dist/client-plugins-Bc5jHcNr.d.ts +0 -1927
  101. package/dist/client-plugins-jsk-ZLzJ.d.mts +0 -1927
  102. package/dist/client-plugins.d.mts +0 -22
  103. package/dist/client-plugins.d.ts +0 -22
  104. package/dist/client.d.mts +0 -447
  105. package/dist/client.d.ts +0 -447
  106. package/dist/config.d.mts +0 -29
  107. package/dist/config.d.ts +0 -29
  108. package/dist/cron.d.mts +0 -78
  109. package/dist/cron.d.ts +0 -78
  110. package/dist/deferred.d.mts +0 -42
  111. package/dist/deferred.d.ts +0 -42
  112. package/dist/deployment.d.mts +0 -34
  113. package/dist/deployment.d.ts +0 -34
  114. package/dist/docs.d.mts +0 -69
  115. package/dist/docs.d.ts +0 -69
  116. package/dist/env-types.d.mts +0 -12
  117. package/dist/env-types.d.ts +0 -12
  118. package/dist/env.d.mts +0 -45
  119. package/dist/env.d.ts +0 -45
  120. package/dist/environment/vite.d.mts +0 -22
  121. package/dist/environment/vite.d.ts +0 -22
  122. package/dist/environment.d.mts +0 -18
  123. package/dist/environment.d.ts +0 -18
  124. package/dist/font.d.mts +0 -70
  125. package/dist/font.d.ts +0 -70
  126. package/dist/headers.d.mts +0 -22
  127. package/dist/headers.d.ts +0 -22
  128. package/dist/i18n/client.d.mts +0 -32
  129. package/dist/i18n/client.d.ts +0 -32
  130. package/dist/i18n/index.d.mts +0 -20
  131. package/dist/i18n/index.d.ts +0 -20
  132. package/dist/i18n/server.d.mts +0 -30
  133. package/dist/i18n/server.d.ts +0 -30
  134. package/dist/image/server.d.mts +0 -37
  135. package/dist/image/server.d.ts +0 -37
  136. package/dist/image/sharp.d.mts +0 -7
  137. package/dist/image/sharp.d.ts +0 -7
  138. package/dist/image-config-Duob7wER.d.mts +0 -50
  139. package/dist/image-config-Duob7wER.d.ts +0 -50
  140. package/dist/image.d.mts +0 -39
  141. package/dist/image.d.ts +0 -39
  142. package/dist/index.d.mts +0 -455
  143. package/dist/index.d.ts +0 -455
  144. package/dist/integration-api-CHT2OKAf.d.mts +0 -93
  145. package/dist/integration-api-CHT2OKAf.d.ts +0 -93
  146. package/dist/integrations.d.mts +0 -22
  147. package/dist/integrations.d.ts +0 -22
  148. package/dist/internal/build-runtime.d.mts +0 -39
  149. package/dist/internal/build-runtime.d.ts +0 -39
  150. package/dist/internal/client-runtime.d.mts +0 -2
  151. package/dist/internal/client-runtime.d.ts +0 -2
  152. package/dist/internal/config-runtime.d.mts +0 -39
  153. package/dist/internal/config-runtime.d.ts +0 -39
  154. package/dist/internal/production-node-env.d.mts +0 -12
  155. package/dist/internal/production-node-env.d.ts +0 -12
  156. package/dist/internal/production-runtime.d.mts +0 -41
  157. package/dist/internal/production-runtime.d.ts +0 -41
  158. package/dist/markdown.d.mts +0 -60
  159. package/dist/markdown.d.ts +0 -60
  160. package/dist/metadata-7ffpT3jr.d.mts +0 -22
  161. package/dist/metadata-JHn-8eht.d.ts +0 -22
  162. package/dist/middleware.d.mts +0 -164
  163. package/dist/middleware.d.ts +0 -164
  164. package/dist/navigation-errors-Dvwpzaer.d.mts +0 -13
  165. package/dist/navigation-errors-Dvwpzaer.d.ts +0 -13
  166. package/dist/navigation.d.mts +0 -14
  167. package/dist/navigation.d.ts +0 -14
  168. package/dist/observability.d.mts +0 -335
  169. package/dist/observability.d.ts +0 -335
  170. package/dist/params-BALtrRim.d.ts +0 -15
  171. package/dist/params-ry-lxqmy.d.mts +0 -15
  172. package/dist/plugin-BJDf43dc.d.mts +0 -165
  173. package/dist/plugin-BJDf43dc.d.ts +0 -165
  174. package/dist/plugin.d.mts +0 -22
  175. package/dist/plugin.d.ts +0 -22
  176. package/dist/production-runtime-9KG7GuvW.d.ts +0 -79
  177. package/dist/production-runtime-B-fweKts.d.mts +0 -79
  178. package/dist/production-runtime-C_B79w2P.d.mts +0 -28
  179. package/dist/production-runtime-DDEM1D2q.d.ts +0 -28
  180. package/dist/query/client.d.mts +0 -61
  181. package/dist/query/client.d.ts +0 -61
  182. package/dist/query/index.d.mts +0 -90
  183. package/dist/query/index.d.ts +0 -90
  184. package/dist/query/parsers.d.mts +0 -25
  185. package/dist/query/parsers.d.ts +0 -25
  186. package/dist/query/server.d.mts +0 -55
  187. package/dist/query/server.d.ts +0 -55
  188. package/dist/request-Dsq4kGW0.d.mts +0 -6
  189. package/dist/request-udtobOLv.d.ts +0 -6
  190. package/dist/request.d.mts +0 -2
  191. package/dist/request.d.ts +0 -2
  192. package/dist/resolver-DJqjLMg_.d.mts +0 -14
  193. package/dist/resolver-IH4RmPEl.d.ts +0 -14
  194. package/dist/route-runtime-DoOHzCAD.d.mts +0 -38
  195. package/dist/route-runtime-DoOHzCAD.d.ts +0 -38
  196. package/dist/router.d.mts +0 -36
  197. package/dist/router.d.ts +0 -36
  198. package/dist/routes.d.mts +0 -224
  199. package/dist/routes.d.ts +0 -224
  200. package/dist/runtime-9nQjVM7X.d.mts +0 -206
  201. package/dist/runtime-Cxpq6xZN.d.mts +0 -27
  202. package/dist/runtime-DgeS2skB.d.ts +0 -206
  203. package/dist/runtime-bv63eUiO.d.ts +0 -27
  204. package/dist/server-action-security.d.mts +0 -43
  205. package/dist/server-action-security.d.ts +0 -43
  206. package/dist/server-fn-client.d.mts +0 -32
  207. package/dist/server-fn-client.d.ts +0 -32
  208. package/dist/server-fn.d.mts +0 -93
  209. package/dist/server-fn.d.ts +0 -93
  210. package/dist/server-plugins.d.mts +0 -55
  211. package/dist/server-plugins.d.ts +0 -55
  212. package/dist/server-query-client.d.mts +0 -50
  213. package/dist/server-query-client.d.ts +0 -50
  214. package/dist/server-query.d.mts +0 -36
  215. package/dist/server-query.d.ts +0 -36
  216. package/dist/server.d.mts +0 -48
  217. package/dist/server.d.ts +0 -48
  218. package/dist/storage.d.mts +0 -52
  219. package/dist/storage.d.ts +0 -52
  220. package/dist/testing.d.mts +0 -101
  221. package/dist/testing.d.ts +0 -101
  222. package/dist/transport-BmbGTXA5.d.mts +0 -49
  223. package/dist/transport-BmbGTXA5.d.ts +0 -49
  224. package/dist/types-BMxWr97v.d.mts +0 -81
  225. package/dist/types-BMxWr97v.d.ts +0 -81
  226. package/dist/types-C9N-nk5R.d.mts +0 -53
  227. package/dist/types-C9N-nk5R.d.ts +0 -53
  228. package/dist/types-D1A6-XvH.d.mts +0 -73
  229. package/dist/types-D1A6-XvH.d.ts +0 -73
  230. package/dist/utils-CA0z0c-2.d.ts +0 -23
  231. package/dist/utils-mYVkSOt2.d.mts +0 -23
  232. package/dist/version.d.mts +0 -3
  233. package/dist/version.d.ts +0 -3
  234. package/dist/vite.d.mts +0 -22
  235. package/dist/vite.d.ts +0 -22
  236. package/dist/workflows.d.mts +0 -110
  237. package/dist/workflows.d.ts +0 -110
  238. /package/dist/{chunk-7N62DNSO.mjs.map → chunk-H3TE3LOV.mjs.map} +0 -0
package/dist/routes.d.mts DELETED
@@ -1,224 +0,0 @@
1
- import { F as FarmRouteRuntimeConfig, a as FarmRouteRuntime, b as FarmRouteRegions, c as FarmRouteMaxDuration } from './route-runtime-DoOHzCAD.mjs';
2
- import { ComponentType } from 'react';
3
- import { RouteDataCacheKey } from './cache.mjs';
4
- import { k as LayoutProps, s as Metadata, h as FarmAppContext, i as PageProps, P as PluginContextProps, p as RouteModule, x as ParsedRoute } from './client-plugins-jsk-ZLzJ.mjs';
5
- import './plugin-BJDf43dc.mjs';
6
- import 'http';
7
- import './types-D1A6-XvH.mjs';
8
- import 'db0';
9
- import 'unstorage';
10
- import './integration-api-CHT2OKAf.mjs';
11
- import '@farming-labs/orm';
12
- import './types-C9N-nk5R.mjs';
13
- import '@farming-labs/docs';
14
- import './markdown.mjs';
15
- import './observability.mjs';
16
- import 'vite';
17
- import './workflows.mjs';
18
- import './cron.mjs';
19
- import './env.mjs';
20
- import './server-action-security.mjs';
21
- import './image-config-Duob7wER.mjs';
22
- import './types-BMxWr97v.mjs';
23
-
24
- type ProgrammaticRouteRenderMode = "static" | "dynamic";
25
- type ProgrammaticRouteMethod = "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "PATCH" | "OPTIONS";
26
- type ProgrammaticRoutePrimitive = string | number | boolean;
27
- type ProgrammaticStaticPathParams = Record<string, ProgrammaticRoutePrimitive | readonly ProgrammaticRoutePrimitive[]>;
28
- type ProgrammaticStaticPath = string | readonly ProgrammaticRoutePrimitive[] | ProgrammaticStaticPathParams;
29
- type ProgrammaticStaticPaths = () => readonly ProgrammaticStaticPath[] | Promise<readonly ProgrammaticStaticPath[]>;
30
- interface ProgrammaticRouteSchema<TOutput = unknown> {
31
- parse(value: unknown): TOutput;
32
- }
33
- interface ProgrammaticRouteSearchOptions<TOutput = ProgrammaticRouteSearchFallback> {
34
- schema?: ProgrammaticRouteSchema<TOutput>;
35
- stripDefaults?: boolean | readonly string[];
36
- preserve?: readonly string[];
37
- temporary?: readonly string[];
38
- }
39
- type ProgrammaticRouteSearchConfig<TOutput = ProgrammaticRouteSearchFallback> = ProgrammaticRouteSchema<TOutput> | ProgrammaticRouteSearchOptions<TOutput>;
40
- type InferProgrammaticRouteSchema<TSchema, TFallback> = TSchema extends ProgrammaticRouteSchema<infer TOutput> ? TOutput : TFallback;
41
- type InferProgrammaticRouteSearch<TSearch, TFallback> = TSearch extends ProgrammaticRouteSearchOptions<infer TOutput> ? TOutput : TSearch extends ProgrammaticRouteSchema<infer TOutput> ? TOutput : TFallback;
42
- type ProgrammaticRouteParamsFallback = Record<string, string>;
43
- type ProgrammaticRouteSearchFallback = Record<string, string | string[] | undefined>;
44
- type ProgrammaticRouteMaybePromise<T> = T | Promise<T>;
45
- type ProgrammaticRouteDataStaleTime = number | false | `${number}ms` | `${number}s` | `${number}m` | `${number}h`;
46
- type ProgrammaticRouteContext = keyof FarmAppContext extends never ? unknown : FarmAppContext;
47
- type ProgrammaticRouteComponentProps<TParams = ProgrammaticRouteParamsFallback, TSearch = ProgrammaticRouteSearchFallback, TData = undefined> = Omit<PageProps, "params" | "searchParams"> & {
48
- params: TParams;
49
- search: TSearch;
50
- searchParams: Promise<TSearch>;
51
- } & ([TData] extends [undefined] ? {
52
- data?: undefined;
53
- } : {
54
- data: TData;
55
- });
56
- type ProgrammaticRouteDataContext<TParams = ProgrammaticRouteParamsFallback, TSearch = ProgrammaticRouteSearchFallback, TContext = ProgrammaticRouteContext> = Omit<ProgrammaticRouteComponentProps<TParams, TSearch>, "context" | "data"> & {
57
- context: TContext;
58
- pluginContext?: PluginContextProps;
59
- };
60
- type ProgrammaticRouteDataCacheContext<TParams = ProgrammaticRouteParamsFallback, TSearch = ProgrammaticRouteSearchFallback, TBefore = unknown, TContext = ProgrammaticRouteContext> = ProgrammaticRouteDataContext<TParams, TSearch, TContext> & {
61
- before: TBefore;
62
- };
63
- type ProgrammaticRouteGuardContext<TParams = ProgrammaticRouteParamsFallback, TSearch = ProgrammaticRouteSearchFallback, TContext = ProgrammaticRouteContext> = ProgrammaticRouteDataContext<TParams, TSearch, TContext>;
64
- type ProgrammaticRouteGuard<TParams = ProgrammaticRouteParamsFallback, TSearch = ProgrammaticRouteSearchFallback, TContext = ProgrammaticRouteContext> = (context: ProgrammaticRouteGuardContext<TParams, TSearch, TContext>) => ProgrammaticRouteMaybePromise<void>;
65
- type ProgrammaticRouteErrorComponentProps<TParams = ProgrammaticRouteParamsFallback, TSearch = ProgrammaticRouteSearchFallback> = Partial<ProgrammaticRouteComponentProps<TParams, TSearch>> & {
66
- error: unknown;
67
- };
68
- type ProgrammaticRoutePendingComponentProps<TParams = ProgrammaticRouteParamsFallback, TSearch = ProgrammaticRouteSearchFallback> = Partial<ProgrammaticRouteComponentProps<TParams, TSearch>>;
69
- type ProgrammaticRouteDataCacheKeys<TParams = ProgrammaticRouteParamsFallback, TSearch = ProgrammaticRouteSearchFallback, TBefore = unknown, TContext = ProgrammaticRouteContext> = readonly string[] | ((context: ProgrammaticRouteDataCacheContext<TParams, TSearch, TBefore, TContext>) => ProgrammaticRouteMaybePromise<readonly string[]>);
70
- interface ProgrammaticRouteDataHooks<TParams = ProgrammaticRouteParamsFallback, TSearch = ProgrammaticRouteSearchFallback, TBefore = unknown, TData = unknown, TContext = ProgrammaticRouteContext> {
71
- key?: (context: ProgrammaticRouteDataCacheContext<TParams, TSearch, NoInfer<TBefore>, TContext>) => ProgrammaticRouteMaybePromise<RouteDataCacheKey | null | undefined>;
72
- staleTime?: ProgrammaticRouteDataStaleTime;
73
- tags?: ProgrammaticRouteDataCacheKeys<TParams, TSearch, NoInfer<TBefore>, TContext>;
74
- paths?: ProgrammaticRouteDataCacheKeys<TParams, TSearch, NoInfer<TBefore>, TContext>;
75
- before?: (context: ProgrammaticRouteDataContext<TParams, TSearch, TContext>) => ProgrammaticRouteMaybePromise<TBefore>;
76
- main: (context: ProgrammaticRouteDataContext<TParams, TSearch, TContext> & {
77
- before: NoInfer<TBefore>;
78
- }) => ProgrammaticRouteMaybePromise<TData>;
79
- after?: (context: ProgrammaticRouteDataContext<TParams, TSearch, TContext> & {
80
- before: NoInfer<TBefore>;
81
- data: NoInfer<TData>;
82
- }) => ProgrammaticRouteMaybePromise<void>;
83
- }
84
- type InferProgrammaticRouteData<TDataHooks> = TDataHooks extends {
85
- main: (...args: any[]) => infer TResult;
86
- } ? Awaited<TResult> : undefined;
87
- interface ProgrammaticPageRoute<TParams = ProgrammaticRouteParamsFallback, TSearch = ProgrammaticRouteSearchFallback, TDataHooks extends ProgrammaticRouteDataHooks<TParams, TSearch, any, any, any> | undefined = ProgrammaticRouteDataHooks<TParams, TSearch, any, any, any> | undefined, TContext = ProgrammaticRouteContext> extends FarmRouteRuntimeConfig {
88
- kind: "page";
89
- path: string;
90
- component: ComponentType<any>;
91
- params?: ProgrammaticRouteSchema<TParams>;
92
- search?: ProgrammaticRouteSearchConfig<TSearch>;
93
- guard?: ProgrammaticRouteGuard<TParams, TSearch, TContext>;
94
- data?: TDataHooks;
95
- pending?: ComponentType<ProgrammaticRoutePendingComponentProps<TParams, TSearch>>;
96
- error?: ComponentType<ProgrammaticRouteErrorComponentProps<TParams, TSearch>>;
97
- notFound?: ComponentType<ProgrammaticRouteErrorComponentProps<TParams, TSearch>>;
98
- render?: ProgrammaticRouteRenderMode;
99
- staticPaths?: ProgrammaticStaticPaths;
100
- revalidate?: number | false;
101
- ppr?: boolean;
102
- metadata?: Metadata & Record<string, any>;
103
- generateMetadata?: RouteModule["generateMetadata"];
104
- }
105
- interface ProgrammaticLayoutRoute extends FarmRouteRuntimeConfig {
106
- kind: "layout";
107
- path: string;
108
- component: ComponentType<LayoutProps>;
109
- metadata?: Metadata & Record<string, any>;
110
- generateMetadata?: (props: {
111
- params: Record<string, string>;
112
- }) => Promise<Metadata> | Metadata;
113
- }
114
- type ProgrammaticApiRouteOptions = Partial<Record<ProgrammaticRouteMethod, any>> & {
115
- render?: ProgrammaticRouteRenderMode;
116
- } & FarmRouteRuntimeConfig;
117
- interface ProgrammaticApiRoute extends FarmRouteRuntimeConfig {
118
- kind: "api";
119
- path: string;
120
- methods: Partial<Record<ProgrammaticRouteMethod, any>>;
121
- render?: ProgrammaticRouteRenderMode;
122
- }
123
- interface ProgrammaticRedirectRoute {
124
- kind: "redirect";
125
- source: string;
126
- destination: string;
127
- permanent?: boolean;
128
- statusCode?: number;
129
- }
130
- type ProgrammaticRouteDefinition = ProgrammaticPageRoute<any, any> | ProgrammaticLayoutRoute | ProgrammaticApiRoute | ProgrammaticRedirectRoute;
131
- interface ProgrammaticRouteManifest {
132
- readonly __farmRoutes: true;
133
- routes: ProgrammaticRouteDefinition[];
134
- }
135
- interface ProgrammaticRouteBuilder {
136
- page(path: string, options: Omit<ProgrammaticPageRoute<any, any>, "kind" | "path">): ProgrammaticPageRoute;
137
- layout(path: string, options: Omit<ProgrammaticLayoutRoute, "kind" | "path">): ProgrammaticLayoutRoute;
138
- api(path: string, options: ProgrammaticApiRouteOptions): ProgrammaticApiRoute;
139
- redirect(source: string, destination: string, options?: Omit<ProgrammaticRedirectRoute, "kind" | "source" | "destination">): ProgrammaticRedirectRoute;
140
- }
141
- type ProgrammaticRouteFactory = (builder: ProgrammaticRouteBuilder) => readonly ProgrammaticRouteDefinition[];
142
- type CreateRouteParams<TParamsSchema> = InferProgrammaticRouteSchema<TParamsSchema, ProgrammaticRouteParamsFallback>;
143
- type CreateRouteSearch<TSearchConfig> = InferProgrammaticRouteSearch<TSearchConfig, ProgrammaticRouteSearchFallback>;
144
- type CreateRouteSharedOptions<TParamsSchema extends ProgrammaticRouteSchema<any> | undefined, TSearchConfig extends ProgrammaticRouteSearchConfig<any> | undefined> = Omit<ProgrammaticPageRoute<CreateRouteParams<TParamsSchema>, CreateRouteSearch<TSearchConfig>>, "kind" | "path" | "component" | "params" | "search" | "data" | "guard"> & {
145
- params?: TParamsSchema;
146
- search?: TSearchConfig;
147
- guard?: ProgrammaticRouteGuard<CreateRouteParams<TParamsSchema>, CreateRouteSearch<TSearchConfig>>;
148
- };
149
- type CreateRouteDataHooksWithBefore<TParams, TSearch, TBeforeResult, TMainResult, TContext = ProgrammaticRouteContext> = Omit<ProgrammaticRouteDataHooks<TParams, TSearch, NoInfer<Awaited<TBeforeResult>>, NoInfer<Awaited<TMainResult>>, TContext>, "before" | "main"> & {
150
- before: (context: ProgrammaticRouteDataContext<TParams, TSearch, TContext>) => TBeforeResult;
151
- main: (context: ProgrammaticRouteDataContext<TParams, TSearch, TContext> & {
152
- before: NoInfer<Awaited<TBeforeResult>>;
153
- }) => TMainResult;
154
- };
155
- type CreateRouteDataHooksWithoutBefore<TParams, TSearch, TMainResult, TContext = ProgrammaticRouteContext> = Omit<ProgrammaticRouteDataHooks<TParams, TSearch, undefined, NoInfer<Awaited<TMainResult>>, TContext>, "before" | "main"> & {
156
- before?: undefined;
157
- main: (context: ProgrammaticRouteDataContext<TParams, TSearch, TContext> & {
158
- before: undefined;
159
- }) => TMainResult;
160
- };
161
- type CreateRouteOptionsWithBefore<TParamsSchema extends ProgrammaticRouteSchema<any> | undefined, TSearchConfig extends ProgrammaticRouteSearchConfig<any> | undefined, TBefore, TData> = CreateRouteSharedOptions<TParamsSchema, TSearchConfig> & {
162
- data: CreateRouteDataHooksWithBefore<CreateRouteParams<TParamsSchema>, CreateRouteSearch<TSearchConfig>, TBefore, TData>;
163
- component: ComponentType<ProgrammaticRouteComponentProps<CreateRouteParams<TParamsSchema>, CreateRouteSearch<TSearchConfig>, NoInfer<Awaited<TData>>>>;
164
- };
165
- type CreateRouteOptionsWithoutBefore<TParamsSchema extends ProgrammaticRouteSchema<any> | undefined, TSearchConfig extends ProgrammaticRouteSearchConfig<any> | undefined, TData> = CreateRouteSharedOptions<TParamsSchema, TSearchConfig> & {
166
- data: CreateRouteDataHooksWithoutBefore<CreateRouteParams<TParamsSchema>, CreateRouteSearch<TSearchConfig>, TData>;
167
- component: ComponentType<ProgrammaticRouteComponentProps<CreateRouteParams<TParamsSchema>, CreateRouteSearch<TSearchConfig>, NoInfer<Awaited<TData>>>>;
168
- };
169
- type CreateRouteOptionsWithoutData<TParamsSchema extends ProgrammaticRouteSchema<any> | undefined, TSearchConfig extends ProgrammaticRouteSearchConfig<any> | undefined> = CreateRouteSharedOptions<TParamsSchema, TSearchConfig> & {
170
- data?: undefined;
171
- component: ComponentType<ProgrammaticRouteComponentProps<CreateRouteParams<TParamsSchema>, CreateRouteSearch<TSearchConfig>, undefined>>;
172
- };
173
- type CreateRouteComponentOption<TComponent extends ComponentType<any>, TProps> = {
174
- component: TComponent;
175
- } & (TComponent extends ComponentType<TProps> ? unknown : {
176
- component: ComponentType<TProps>;
177
- });
178
- type CreateRouteOptions<TParamsSchema extends ProgrammaticRouteSchema<any> | undefined = undefined, TSearchConfig extends ProgrammaticRouteSearchConfig<any> | undefined = undefined, TBefore = unknown, TData = unknown> = CreateRouteOptionsWithBefore<TParamsSchema, TSearchConfig, TBefore, TData> | CreateRouteOptionsWithoutBefore<TParamsSchema, TSearchConfig, TData> | CreateRouteOptionsWithoutData<TParamsSchema, TSearchConfig>;
179
- declare const PROGRAMMATIC_ROUTE_FILE_NAMES: string[];
180
- declare function defineRoutes(input: readonly ProgrammaticRouteDefinition[] | ProgrammaticRouteFactory): ProgrammaticRouteManifest;
181
- declare const routesBuilder: ProgrammaticRouteBuilder;
182
- declare const page: (path: string, options: Omit<ProgrammaticPageRoute<any, any>, "kind" | "path">) => ProgrammaticPageRoute;
183
- declare const layout: (path: string, options: Omit<ProgrammaticLayoutRoute, "kind" | "path">) => ProgrammaticLayoutRoute;
184
- declare const api: (path: string, options: ProgrammaticApiRouteOptions) => ProgrammaticApiRoute;
185
- declare const redirect: (source: string, destination: string, options?: Omit<ProgrammaticRedirectRoute, "kind" | "source" | "destination">) => ProgrammaticRedirectRoute;
186
- interface ProgrammaticRouteSearchClientOptions {
187
- stripDefaults?: boolean | readonly string[];
188
- preserve?: readonly string[];
189
- temporary?: readonly string[];
190
- }
191
- interface ProgrammaticRouteSearchResolution<TSearch = unknown> {
192
- search: TSearch;
193
- canonicalPath?: string;
194
- }
195
- declare function getProgrammaticRouteSearchSchema<TSearch = unknown>(search: ProgrammaticRouteSearchConfig<TSearch> | undefined): ProgrammaticRouteSchema<TSearch> | undefined;
196
- declare function getProgrammaticRouteSearchClientOptions(search: ProgrammaticRouteSearchConfig<any> | undefined): ProgrammaticRouteSearchClientOptions | undefined;
197
- declare function createRoute<TParamsSchema extends ProgrammaticRouteSchema<any> | undefined = undefined, TSearchConfig extends ProgrammaticRouteSearchConfig<any> | undefined = undefined, TBeforeResult = unknown, TMainResult = unknown, TComponent extends ComponentType<any> = ComponentType<any>>(path: string, options: Omit<CreateRouteOptionsWithBefore<TParamsSchema, TSearchConfig, TBeforeResult, TMainResult>, "component"> & CreateRouteComponentOption<TComponent, ProgrammaticRouteComponentProps<CreateRouteParams<TParamsSchema>, CreateRouteSearch<TSearchConfig>, Awaited<TMainResult>>>): ProgrammaticPageRoute<CreateRouteParams<TParamsSchema>, CreateRouteSearch<TSearchConfig>, CreateRouteDataHooksWithBefore<CreateRouteParams<TParamsSchema>, CreateRouteSearch<TSearchConfig>, TBeforeResult, TMainResult>>;
198
- declare function createRoute<TParamsSchema extends ProgrammaticRouteSchema<any> | undefined = undefined, TSearchConfig extends ProgrammaticRouteSearchConfig<any> | undefined = undefined, TMainResult = unknown, TComponent extends ComponentType<any> = ComponentType<any>>(path: string, options: Omit<CreateRouteOptionsWithoutBefore<TParamsSchema, TSearchConfig, TMainResult>, "component"> & CreateRouteComponentOption<TComponent, ProgrammaticRouteComponentProps<CreateRouteParams<TParamsSchema>, CreateRouteSearch<TSearchConfig>, Awaited<TMainResult>>>): ProgrammaticPageRoute<CreateRouteParams<TParamsSchema>, CreateRouteSearch<TSearchConfig>, CreateRouteDataHooksWithoutBefore<CreateRouteParams<TParamsSchema>, CreateRouteSearch<TSearchConfig>, TMainResult>>;
199
- declare function createRoute<TParamsSchema extends ProgrammaticRouteSchema<any> | undefined = undefined, TSearchConfig extends ProgrammaticRouteSearchConfig<any> | undefined = undefined>(path: string, options: CreateRouteOptionsWithoutData<TParamsSchema, TSearchConfig>): ProgrammaticPageRoute<CreateRouteParams<TParamsSchema>, CreateRouteSearch<TSearchConfig>, undefined>;
200
- declare function isProgrammaticRoutesFileName(fileName: string): boolean;
201
- declare function getProgrammaticRouteManifest(mod: Record<string, any> | null | undefined): ProgrammaticRouteManifest | null;
202
- declare function isProgrammaticRouteManifest(value: unknown): value is ProgrammaticRouteManifest;
203
- declare function isProgrammaticRouteDefinition(value: unknown): value is ProgrammaticRouteDefinition;
204
- declare function createProgrammaticRouteModuleId(filePath: string, kind: "page" | "layout" | "api", routePath: string): string;
205
- declare function parseProgrammaticRouteModuleId(moduleId: string): {
206
- filePath: string;
207
- kind: "page" | "layout" | "api";
208
- routePath: string;
209
- } | null;
210
- declare function parseProgrammaticRoutePath(routePath: string, type?: ParsedRoute["type"]): ParsedRoute;
211
- declare function createRouteModuleFromProgrammaticPage(route: ProgrammaticPageRoute): RouteModule;
212
- declare function createLayoutModuleFromProgrammaticLayout(route: ProgrammaticLayoutRoute): {
213
- metadata: (Metadata & Record<string, any>) | undefined;
214
- generateMetadata: ((props: {
215
- params: Record<string, string>;
216
- }) => Promise<Metadata> | Metadata) | undefined;
217
- runtime?: FarmRouteRuntime;
218
- regions?: FarmRouteRegions;
219
- maxDuration?: FarmRouteMaxDuration;
220
- default: ComponentType<LayoutProps>;
221
- };
222
- declare function scanProgrammaticPagePaths(source: string): string[];
223
-
224
- export { type CreateRouteOptions, type InferProgrammaticRouteData, type InferProgrammaticRouteSchema, type InferProgrammaticRouteSearch, PROGRAMMATIC_ROUTE_FILE_NAMES, type ProgrammaticApiRoute, type ProgrammaticApiRouteOptions, type ProgrammaticLayoutRoute, type ProgrammaticPageRoute, type ProgrammaticRedirectRoute, type ProgrammaticRouteBuilder, type ProgrammaticRouteComponentProps, type ProgrammaticRouteContext, type ProgrammaticRouteDataCacheContext, type ProgrammaticRouteDataCacheKeys, type ProgrammaticRouteDataContext, type ProgrammaticRouteDataHooks, type ProgrammaticRouteDataStaleTime, type ProgrammaticRouteDefinition, type ProgrammaticRouteErrorComponentProps, type ProgrammaticRouteFactory, type ProgrammaticRouteGuard, type ProgrammaticRouteGuardContext, type ProgrammaticRouteManifest, type ProgrammaticRouteMaybePromise, type ProgrammaticRouteMethod, type ProgrammaticRouteParamsFallback, type ProgrammaticRoutePendingComponentProps, type ProgrammaticRoutePrimitive, type ProgrammaticRouteRenderMode, type ProgrammaticRouteSchema, type ProgrammaticRouteSearchClientOptions, type ProgrammaticRouteSearchConfig, type ProgrammaticRouteSearchFallback, type ProgrammaticRouteSearchOptions, type ProgrammaticRouteSearchResolution, type ProgrammaticStaticPath, type ProgrammaticStaticPathParams, type ProgrammaticStaticPaths, api, createLayoutModuleFromProgrammaticLayout, createProgrammaticRouteModuleId, createRoute, createRouteModuleFromProgrammaticPage, defineRoutes, getProgrammaticRouteManifest, getProgrammaticRouteSearchClientOptions, getProgrammaticRouteSearchSchema, isProgrammaticRouteDefinition, isProgrammaticRouteManifest, isProgrammaticRoutesFileName, layout, page, parseProgrammaticRouteModuleId, parseProgrammaticRoutePath, redirect, routesBuilder, scanProgrammaticPagePaths };
package/dist/routes.d.ts DELETED
@@ -1,224 +0,0 @@
1
- import { F as FarmRouteRuntimeConfig, a as FarmRouteRuntime, b as FarmRouteRegions, c as FarmRouteMaxDuration } from './route-runtime-DoOHzCAD.js';
2
- import { ComponentType } from 'react';
3
- import { RouteDataCacheKey } from './cache.js';
4
- import { k as LayoutProps, s as Metadata, h as FarmAppContext, i as PageProps, P as PluginContextProps, p as RouteModule, x as ParsedRoute } from './client-plugins-Bc5jHcNr.js';
5
- import './plugin-BJDf43dc.js';
6
- import 'http';
7
- import './types-D1A6-XvH.js';
8
- import 'db0';
9
- import 'unstorage';
10
- import './integration-api-CHT2OKAf.js';
11
- import '@farming-labs/orm';
12
- import './types-C9N-nk5R.js';
13
- import '@farming-labs/docs';
14
- import './markdown.js';
15
- import './observability.js';
16
- import 'vite';
17
- import './workflows.js';
18
- import './cron.js';
19
- import './env.js';
20
- import './server-action-security.js';
21
- import './image-config-Duob7wER.js';
22
- import './types-BMxWr97v.js';
23
-
24
- type ProgrammaticRouteRenderMode = "static" | "dynamic";
25
- type ProgrammaticRouteMethod = "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "PATCH" | "OPTIONS";
26
- type ProgrammaticRoutePrimitive = string | number | boolean;
27
- type ProgrammaticStaticPathParams = Record<string, ProgrammaticRoutePrimitive | readonly ProgrammaticRoutePrimitive[]>;
28
- type ProgrammaticStaticPath = string | readonly ProgrammaticRoutePrimitive[] | ProgrammaticStaticPathParams;
29
- type ProgrammaticStaticPaths = () => readonly ProgrammaticStaticPath[] | Promise<readonly ProgrammaticStaticPath[]>;
30
- interface ProgrammaticRouteSchema<TOutput = unknown> {
31
- parse(value: unknown): TOutput;
32
- }
33
- interface ProgrammaticRouteSearchOptions<TOutput = ProgrammaticRouteSearchFallback> {
34
- schema?: ProgrammaticRouteSchema<TOutput>;
35
- stripDefaults?: boolean | readonly string[];
36
- preserve?: readonly string[];
37
- temporary?: readonly string[];
38
- }
39
- type ProgrammaticRouteSearchConfig<TOutput = ProgrammaticRouteSearchFallback> = ProgrammaticRouteSchema<TOutput> | ProgrammaticRouteSearchOptions<TOutput>;
40
- type InferProgrammaticRouteSchema<TSchema, TFallback> = TSchema extends ProgrammaticRouteSchema<infer TOutput> ? TOutput : TFallback;
41
- type InferProgrammaticRouteSearch<TSearch, TFallback> = TSearch extends ProgrammaticRouteSearchOptions<infer TOutput> ? TOutput : TSearch extends ProgrammaticRouteSchema<infer TOutput> ? TOutput : TFallback;
42
- type ProgrammaticRouteParamsFallback = Record<string, string>;
43
- type ProgrammaticRouteSearchFallback = Record<string, string | string[] | undefined>;
44
- type ProgrammaticRouteMaybePromise<T> = T | Promise<T>;
45
- type ProgrammaticRouteDataStaleTime = number | false | `${number}ms` | `${number}s` | `${number}m` | `${number}h`;
46
- type ProgrammaticRouteContext = keyof FarmAppContext extends never ? unknown : FarmAppContext;
47
- type ProgrammaticRouteComponentProps<TParams = ProgrammaticRouteParamsFallback, TSearch = ProgrammaticRouteSearchFallback, TData = undefined> = Omit<PageProps, "params" | "searchParams"> & {
48
- params: TParams;
49
- search: TSearch;
50
- searchParams: Promise<TSearch>;
51
- } & ([TData] extends [undefined] ? {
52
- data?: undefined;
53
- } : {
54
- data: TData;
55
- });
56
- type ProgrammaticRouteDataContext<TParams = ProgrammaticRouteParamsFallback, TSearch = ProgrammaticRouteSearchFallback, TContext = ProgrammaticRouteContext> = Omit<ProgrammaticRouteComponentProps<TParams, TSearch>, "context" | "data"> & {
57
- context: TContext;
58
- pluginContext?: PluginContextProps;
59
- };
60
- type ProgrammaticRouteDataCacheContext<TParams = ProgrammaticRouteParamsFallback, TSearch = ProgrammaticRouteSearchFallback, TBefore = unknown, TContext = ProgrammaticRouteContext> = ProgrammaticRouteDataContext<TParams, TSearch, TContext> & {
61
- before: TBefore;
62
- };
63
- type ProgrammaticRouteGuardContext<TParams = ProgrammaticRouteParamsFallback, TSearch = ProgrammaticRouteSearchFallback, TContext = ProgrammaticRouteContext> = ProgrammaticRouteDataContext<TParams, TSearch, TContext>;
64
- type ProgrammaticRouteGuard<TParams = ProgrammaticRouteParamsFallback, TSearch = ProgrammaticRouteSearchFallback, TContext = ProgrammaticRouteContext> = (context: ProgrammaticRouteGuardContext<TParams, TSearch, TContext>) => ProgrammaticRouteMaybePromise<void>;
65
- type ProgrammaticRouteErrorComponentProps<TParams = ProgrammaticRouteParamsFallback, TSearch = ProgrammaticRouteSearchFallback> = Partial<ProgrammaticRouteComponentProps<TParams, TSearch>> & {
66
- error: unknown;
67
- };
68
- type ProgrammaticRoutePendingComponentProps<TParams = ProgrammaticRouteParamsFallback, TSearch = ProgrammaticRouteSearchFallback> = Partial<ProgrammaticRouteComponentProps<TParams, TSearch>>;
69
- type ProgrammaticRouteDataCacheKeys<TParams = ProgrammaticRouteParamsFallback, TSearch = ProgrammaticRouteSearchFallback, TBefore = unknown, TContext = ProgrammaticRouteContext> = readonly string[] | ((context: ProgrammaticRouteDataCacheContext<TParams, TSearch, TBefore, TContext>) => ProgrammaticRouteMaybePromise<readonly string[]>);
70
- interface ProgrammaticRouteDataHooks<TParams = ProgrammaticRouteParamsFallback, TSearch = ProgrammaticRouteSearchFallback, TBefore = unknown, TData = unknown, TContext = ProgrammaticRouteContext> {
71
- key?: (context: ProgrammaticRouteDataCacheContext<TParams, TSearch, NoInfer<TBefore>, TContext>) => ProgrammaticRouteMaybePromise<RouteDataCacheKey | null | undefined>;
72
- staleTime?: ProgrammaticRouteDataStaleTime;
73
- tags?: ProgrammaticRouteDataCacheKeys<TParams, TSearch, NoInfer<TBefore>, TContext>;
74
- paths?: ProgrammaticRouteDataCacheKeys<TParams, TSearch, NoInfer<TBefore>, TContext>;
75
- before?: (context: ProgrammaticRouteDataContext<TParams, TSearch, TContext>) => ProgrammaticRouteMaybePromise<TBefore>;
76
- main: (context: ProgrammaticRouteDataContext<TParams, TSearch, TContext> & {
77
- before: NoInfer<TBefore>;
78
- }) => ProgrammaticRouteMaybePromise<TData>;
79
- after?: (context: ProgrammaticRouteDataContext<TParams, TSearch, TContext> & {
80
- before: NoInfer<TBefore>;
81
- data: NoInfer<TData>;
82
- }) => ProgrammaticRouteMaybePromise<void>;
83
- }
84
- type InferProgrammaticRouteData<TDataHooks> = TDataHooks extends {
85
- main: (...args: any[]) => infer TResult;
86
- } ? Awaited<TResult> : undefined;
87
- interface ProgrammaticPageRoute<TParams = ProgrammaticRouteParamsFallback, TSearch = ProgrammaticRouteSearchFallback, TDataHooks extends ProgrammaticRouteDataHooks<TParams, TSearch, any, any, any> | undefined = ProgrammaticRouteDataHooks<TParams, TSearch, any, any, any> | undefined, TContext = ProgrammaticRouteContext> extends FarmRouteRuntimeConfig {
88
- kind: "page";
89
- path: string;
90
- component: ComponentType<any>;
91
- params?: ProgrammaticRouteSchema<TParams>;
92
- search?: ProgrammaticRouteSearchConfig<TSearch>;
93
- guard?: ProgrammaticRouteGuard<TParams, TSearch, TContext>;
94
- data?: TDataHooks;
95
- pending?: ComponentType<ProgrammaticRoutePendingComponentProps<TParams, TSearch>>;
96
- error?: ComponentType<ProgrammaticRouteErrorComponentProps<TParams, TSearch>>;
97
- notFound?: ComponentType<ProgrammaticRouteErrorComponentProps<TParams, TSearch>>;
98
- render?: ProgrammaticRouteRenderMode;
99
- staticPaths?: ProgrammaticStaticPaths;
100
- revalidate?: number | false;
101
- ppr?: boolean;
102
- metadata?: Metadata & Record<string, any>;
103
- generateMetadata?: RouteModule["generateMetadata"];
104
- }
105
- interface ProgrammaticLayoutRoute extends FarmRouteRuntimeConfig {
106
- kind: "layout";
107
- path: string;
108
- component: ComponentType<LayoutProps>;
109
- metadata?: Metadata & Record<string, any>;
110
- generateMetadata?: (props: {
111
- params: Record<string, string>;
112
- }) => Promise<Metadata> | Metadata;
113
- }
114
- type ProgrammaticApiRouteOptions = Partial<Record<ProgrammaticRouteMethod, any>> & {
115
- render?: ProgrammaticRouteRenderMode;
116
- } & FarmRouteRuntimeConfig;
117
- interface ProgrammaticApiRoute extends FarmRouteRuntimeConfig {
118
- kind: "api";
119
- path: string;
120
- methods: Partial<Record<ProgrammaticRouteMethod, any>>;
121
- render?: ProgrammaticRouteRenderMode;
122
- }
123
- interface ProgrammaticRedirectRoute {
124
- kind: "redirect";
125
- source: string;
126
- destination: string;
127
- permanent?: boolean;
128
- statusCode?: number;
129
- }
130
- type ProgrammaticRouteDefinition = ProgrammaticPageRoute<any, any> | ProgrammaticLayoutRoute | ProgrammaticApiRoute | ProgrammaticRedirectRoute;
131
- interface ProgrammaticRouteManifest {
132
- readonly __farmRoutes: true;
133
- routes: ProgrammaticRouteDefinition[];
134
- }
135
- interface ProgrammaticRouteBuilder {
136
- page(path: string, options: Omit<ProgrammaticPageRoute<any, any>, "kind" | "path">): ProgrammaticPageRoute;
137
- layout(path: string, options: Omit<ProgrammaticLayoutRoute, "kind" | "path">): ProgrammaticLayoutRoute;
138
- api(path: string, options: ProgrammaticApiRouteOptions): ProgrammaticApiRoute;
139
- redirect(source: string, destination: string, options?: Omit<ProgrammaticRedirectRoute, "kind" | "source" | "destination">): ProgrammaticRedirectRoute;
140
- }
141
- type ProgrammaticRouteFactory = (builder: ProgrammaticRouteBuilder) => readonly ProgrammaticRouteDefinition[];
142
- type CreateRouteParams<TParamsSchema> = InferProgrammaticRouteSchema<TParamsSchema, ProgrammaticRouteParamsFallback>;
143
- type CreateRouteSearch<TSearchConfig> = InferProgrammaticRouteSearch<TSearchConfig, ProgrammaticRouteSearchFallback>;
144
- type CreateRouteSharedOptions<TParamsSchema extends ProgrammaticRouteSchema<any> | undefined, TSearchConfig extends ProgrammaticRouteSearchConfig<any> | undefined> = Omit<ProgrammaticPageRoute<CreateRouteParams<TParamsSchema>, CreateRouteSearch<TSearchConfig>>, "kind" | "path" | "component" | "params" | "search" | "data" | "guard"> & {
145
- params?: TParamsSchema;
146
- search?: TSearchConfig;
147
- guard?: ProgrammaticRouteGuard<CreateRouteParams<TParamsSchema>, CreateRouteSearch<TSearchConfig>>;
148
- };
149
- type CreateRouteDataHooksWithBefore<TParams, TSearch, TBeforeResult, TMainResult, TContext = ProgrammaticRouteContext> = Omit<ProgrammaticRouteDataHooks<TParams, TSearch, NoInfer<Awaited<TBeforeResult>>, NoInfer<Awaited<TMainResult>>, TContext>, "before" | "main"> & {
150
- before: (context: ProgrammaticRouteDataContext<TParams, TSearch, TContext>) => TBeforeResult;
151
- main: (context: ProgrammaticRouteDataContext<TParams, TSearch, TContext> & {
152
- before: NoInfer<Awaited<TBeforeResult>>;
153
- }) => TMainResult;
154
- };
155
- type CreateRouteDataHooksWithoutBefore<TParams, TSearch, TMainResult, TContext = ProgrammaticRouteContext> = Omit<ProgrammaticRouteDataHooks<TParams, TSearch, undefined, NoInfer<Awaited<TMainResult>>, TContext>, "before" | "main"> & {
156
- before?: undefined;
157
- main: (context: ProgrammaticRouteDataContext<TParams, TSearch, TContext> & {
158
- before: undefined;
159
- }) => TMainResult;
160
- };
161
- type CreateRouteOptionsWithBefore<TParamsSchema extends ProgrammaticRouteSchema<any> | undefined, TSearchConfig extends ProgrammaticRouteSearchConfig<any> | undefined, TBefore, TData> = CreateRouteSharedOptions<TParamsSchema, TSearchConfig> & {
162
- data: CreateRouteDataHooksWithBefore<CreateRouteParams<TParamsSchema>, CreateRouteSearch<TSearchConfig>, TBefore, TData>;
163
- component: ComponentType<ProgrammaticRouteComponentProps<CreateRouteParams<TParamsSchema>, CreateRouteSearch<TSearchConfig>, NoInfer<Awaited<TData>>>>;
164
- };
165
- type CreateRouteOptionsWithoutBefore<TParamsSchema extends ProgrammaticRouteSchema<any> | undefined, TSearchConfig extends ProgrammaticRouteSearchConfig<any> | undefined, TData> = CreateRouteSharedOptions<TParamsSchema, TSearchConfig> & {
166
- data: CreateRouteDataHooksWithoutBefore<CreateRouteParams<TParamsSchema>, CreateRouteSearch<TSearchConfig>, TData>;
167
- component: ComponentType<ProgrammaticRouteComponentProps<CreateRouteParams<TParamsSchema>, CreateRouteSearch<TSearchConfig>, NoInfer<Awaited<TData>>>>;
168
- };
169
- type CreateRouteOptionsWithoutData<TParamsSchema extends ProgrammaticRouteSchema<any> | undefined, TSearchConfig extends ProgrammaticRouteSearchConfig<any> | undefined> = CreateRouteSharedOptions<TParamsSchema, TSearchConfig> & {
170
- data?: undefined;
171
- component: ComponentType<ProgrammaticRouteComponentProps<CreateRouteParams<TParamsSchema>, CreateRouteSearch<TSearchConfig>, undefined>>;
172
- };
173
- type CreateRouteComponentOption<TComponent extends ComponentType<any>, TProps> = {
174
- component: TComponent;
175
- } & (TComponent extends ComponentType<TProps> ? unknown : {
176
- component: ComponentType<TProps>;
177
- });
178
- type CreateRouteOptions<TParamsSchema extends ProgrammaticRouteSchema<any> | undefined = undefined, TSearchConfig extends ProgrammaticRouteSearchConfig<any> | undefined = undefined, TBefore = unknown, TData = unknown> = CreateRouteOptionsWithBefore<TParamsSchema, TSearchConfig, TBefore, TData> | CreateRouteOptionsWithoutBefore<TParamsSchema, TSearchConfig, TData> | CreateRouteOptionsWithoutData<TParamsSchema, TSearchConfig>;
179
- declare const PROGRAMMATIC_ROUTE_FILE_NAMES: string[];
180
- declare function defineRoutes(input: readonly ProgrammaticRouteDefinition[] | ProgrammaticRouteFactory): ProgrammaticRouteManifest;
181
- declare const routesBuilder: ProgrammaticRouteBuilder;
182
- declare const page: (path: string, options: Omit<ProgrammaticPageRoute<any, any>, "kind" | "path">) => ProgrammaticPageRoute;
183
- declare const layout: (path: string, options: Omit<ProgrammaticLayoutRoute, "kind" | "path">) => ProgrammaticLayoutRoute;
184
- declare const api: (path: string, options: ProgrammaticApiRouteOptions) => ProgrammaticApiRoute;
185
- declare const redirect: (source: string, destination: string, options?: Omit<ProgrammaticRedirectRoute, "kind" | "source" | "destination">) => ProgrammaticRedirectRoute;
186
- interface ProgrammaticRouteSearchClientOptions {
187
- stripDefaults?: boolean | readonly string[];
188
- preserve?: readonly string[];
189
- temporary?: readonly string[];
190
- }
191
- interface ProgrammaticRouteSearchResolution<TSearch = unknown> {
192
- search: TSearch;
193
- canonicalPath?: string;
194
- }
195
- declare function getProgrammaticRouteSearchSchema<TSearch = unknown>(search: ProgrammaticRouteSearchConfig<TSearch> | undefined): ProgrammaticRouteSchema<TSearch> | undefined;
196
- declare function getProgrammaticRouteSearchClientOptions(search: ProgrammaticRouteSearchConfig<any> | undefined): ProgrammaticRouteSearchClientOptions | undefined;
197
- declare function createRoute<TParamsSchema extends ProgrammaticRouteSchema<any> | undefined = undefined, TSearchConfig extends ProgrammaticRouteSearchConfig<any> | undefined = undefined, TBeforeResult = unknown, TMainResult = unknown, TComponent extends ComponentType<any> = ComponentType<any>>(path: string, options: Omit<CreateRouteOptionsWithBefore<TParamsSchema, TSearchConfig, TBeforeResult, TMainResult>, "component"> & CreateRouteComponentOption<TComponent, ProgrammaticRouteComponentProps<CreateRouteParams<TParamsSchema>, CreateRouteSearch<TSearchConfig>, Awaited<TMainResult>>>): ProgrammaticPageRoute<CreateRouteParams<TParamsSchema>, CreateRouteSearch<TSearchConfig>, CreateRouteDataHooksWithBefore<CreateRouteParams<TParamsSchema>, CreateRouteSearch<TSearchConfig>, TBeforeResult, TMainResult>>;
198
- declare function createRoute<TParamsSchema extends ProgrammaticRouteSchema<any> | undefined = undefined, TSearchConfig extends ProgrammaticRouteSearchConfig<any> | undefined = undefined, TMainResult = unknown, TComponent extends ComponentType<any> = ComponentType<any>>(path: string, options: Omit<CreateRouteOptionsWithoutBefore<TParamsSchema, TSearchConfig, TMainResult>, "component"> & CreateRouteComponentOption<TComponent, ProgrammaticRouteComponentProps<CreateRouteParams<TParamsSchema>, CreateRouteSearch<TSearchConfig>, Awaited<TMainResult>>>): ProgrammaticPageRoute<CreateRouteParams<TParamsSchema>, CreateRouteSearch<TSearchConfig>, CreateRouteDataHooksWithoutBefore<CreateRouteParams<TParamsSchema>, CreateRouteSearch<TSearchConfig>, TMainResult>>;
199
- declare function createRoute<TParamsSchema extends ProgrammaticRouteSchema<any> | undefined = undefined, TSearchConfig extends ProgrammaticRouteSearchConfig<any> | undefined = undefined>(path: string, options: CreateRouteOptionsWithoutData<TParamsSchema, TSearchConfig>): ProgrammaticPageRoute<CreateRouteParams<TParamsSchema>, CreateRouteSearch<TSearchConfig>, undefined>;
200
- declare function isProgrammaticRoutesFileName(fileName: string): boolean;
201
- declare function getProgrammaticRouteManifest(mod: Record<string, any> | null | undefined): ProgrammaticRouteManifest | null;
202
- declare function isProgrammaticRouteManifest(value: unknown): value is ProgrammaticRouteManifest;
203
- declare function isProgrammaticRouteDefinition(value: unknown): value is ProgrammaticRouteDefinition;
204
- declare function createProgrammaticRouteModuleId(filePath: string, kind: "page" | "layout" | "api", routePath: string): string;
205
- declare function parseProgrammaticRouteModuleId(moduleId: string): {
206
- filePath: string;
207
- kind: "page" | "layout" | "api";
208
- routePath: string;
209
- } | null;
210
- declare function parseProgrammaticRoutePath(routePath: string, type?: ParsedRoute["type"]): ParsedRoute;
211
- declare function createRouteModuleFromProgrammaticPage(route: ProgrammaticPageRoute): RouteModule;
212
- declare function createLayoutModuleFromProgrammaticLayout(route: ProgrammaticLayoutRoute): {
213
- metadata: (Metadata & Record<string, any>) | undefined;
214
- generateMetadata: ((props: {
215
- params: Record<string, string>;
216
- }) => Promise<Metadata> | Metadata) | undefined;
217
- runtime?: FarmRouteRuntime;
218
- regions?: FarmRouteRegions;
219
- maxDuration?: FarmRouteMaxDuration;
220
- default: ComponentType<LayoutProps>;
221
- };
222
- declare function scanProgrammaticPagePaths(source: string): string[];
223
-
224
- export { type CreateRouteOptions, type InferProgrammaticRouteData, type InferProgrammaticRouteSchema, type InferProgrammaticRouteSearch, PROGRAMMATIC_ROUTE_FILE_NAMES, type ProgrammaticApiRoute, type ProgrammaticApiRouteOptions, type ProgrammaticLayoutRoute, type ProgrammaticPageRoute, type ProgrammaticRedirectRoute, type ProgrammaticRouteBuilder, type ProgrammaticRouteComponentProps, type ProgrammaticRouteContext, type ProgrammaticRouteDataCacheContext, type ProgrammaticRouteDataCacheKeys, type ProgrammaticRouteDataContext, type ProgrammaticRouteDataHooks, type ProgrammaticRouteDataStaleTime, type ProgrammaticRouteDefinition, type ProgrammaticRouteErrorComponentProps, type ProgrammaticRouteFactory, type ProgrammaticRouteGuard, type ProgrammaticRouteGuardContext, type ProgrammaticRouteManifest, type ProgrammaticRouteMaybePromise, type ProgrammaticRouteMethod, type ProgrammaticRouteParamsFallback, type ProgrammaticRoutePendingComponentProps, type ProgrammaticRoutePrimitive, type ProgrammaticRouteRenderMode, type ProgrammaticRouteSchema, type ProgrammaticRouteSearchClientOptions, type ProgrammaticRouteSearchConfig, type ProgrammaticRouteSearchFallback, type ProgrammaticRouteSearchOptions, type ProgrammaticRouteSearchResolution, type ProgrammaticStaticPath, type ProgrammaticStaticPathParams, type ProgrammaticStaticPaths, api, createLayoutModuleFromProgrammaticLayout, createProgrammaticRouteModuleId, createRoute, createRouteModuleFromProgrammaticPage, defineRoutes, getProgrammaticRouteManifest, getProgrammaticRouteSearchClientOptions, getProgrammaticRouteSearchSchema, isProgrammaticRouteDefinition, isProgrammaticRouteManifest, isProgrammaticRoutesFileName, layout, page, parseProgrammaticRouteModuleId, parseProgrammaticRoutePath, redirect, routesBuilder, scanProgrammaticPagePaths };