-
Notifications
You must be signed in to change notification settings - Fork 600
/
types.ts
232 lines (191 loc) · 5.58 KB
/
types.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
import { ComponentType } from "preact";
import { ConnInfo, router, ServeInit } from "./deps.ts";
import { InnerRenderFunction, RenderContext } from "./render.tsx";
// --- APPLICATION CONFIGURATION ---
export type StartOptions = ServeInit & FreshOptions;
export interface FreshOptions {
render?: RenderFunction;
}
export type RenderFunction = (
ctx: RenderContext,
render: InnerRenderFunction,
) => void | Promise<void>;
/// --- ROUTES ---
// deno-lint-ignore no-explicit-any
export interface PageProps<T = any> {
/** The URL of the request that resulted in this page being rendered. */
url: URL;
/** The route matcher (e.g. /blog/:id) that the request matched for this page
* to be rendered. */
route: string;
/**
* The parameters that were matched from the route.
*
* For the `/foo/:bar` route with url `/foo/123`, `params` would be
* `{ bar: '123' }`. For a route with no matchers, `params` would be `{}`. For
* a wildcard route, like `/foo/:path*` with url `/foo/bar/baz`, `params` would
* be `{ path: 'bar/baz' }`.
*/
params: Record<string, string>;
/**
* Additional data passed into `HandlerContext.render`. Defaults to
* `undefined`.
*/
data: T;
}
export interface RouteConfig {
/**
* A route override for the page. This is useful for pages where the route
* can not be expressed through the filesystem routing capabilities.
*
* The route override must be a path-to-regexp compatible route matcher.
*/
routeOverride?: string;
/**
* If Content-Security-Policy should be enabled for this page. If 'true', a
* locked down policy will be used that allows only the scripts and styles
* that are generated by fresh. Additional scripts and styles can be added
* using the `useCSP` hook.
*/
csp?: boolean;
}
export interface HandlerContext<Data = unknown, State = Record<string, unknown>>
extends ConnInfo {
params: Record<string, string>;
render: (data?: Data) => Response | Promise<Response>;
state: State;
}
// deno-lint-ignore no-explicit-any
export type Handler<T = any, State = Record<string, unknown>> = (
req: Request,
ctx: HandlerContext<T, State>,
) => Response | Promise<Response>;
// deno-lint-ignore no-explicit-any
export type Handlers<T = any, State = Record<string, unknown>> = {
[K in typeof router.METHODS[number]]?: Handler<T, State>;
};
export interface RouteModule {
default?: ComponentType<PageProps>;
// deno-lint-ignore no-explicit-any
handler?: Handler<any, any> | Handlers<any, any>;
config?: RouteConfig;
}
// deno-lint-ignore no-explicit-any
export interface Route<Data = any> {
pattern: string;
url: string;
name: string;
component?: ComponentType<PageProps<Data>>;
handler: Handler<Data> | Handlers<Data>;
csp: boolean;
}
// --- APP ---
export interface AppProps {
Component: ComponentType<Record<never, never>>;
}
export interface AppModule {
default: ComponentType<AppProps>;
}
// --- UNKNOWN PAGE ---
export interface UnknownPageProps {
/** The URL of the request that resulted in this page being rendered. */
url: URL;
/** The route matcher (e.g. /blog/:id) that the request matched for this page
* to be rendered. */
route: string;
}
export interface UnknownHandlerContext<State = Record<string, unknown>>
extends ConnInfo {
render: () => Response | Promise<Response>;
state: State;
}
export type UnknownHandler = (
req: Request,
ctx: UnknownHandlerContext,
) => Response | Promise<Response>;
export interface UnknownPageModule {
default?: ComponentType<UnknownPageProps>;
handler?: UnknownHandler;
config?: RouteConfig;
}
export interface UnknownPage {
pattern: string;
url: string;
name: string;
component?: ComponentType<UnknownPageProps>;
handler: UnknownHandler;
csp: boolean;
}
// --- ERROR PAGE ---
export interface ErrorPageProps {
/** The URL of the request that resulted in this page being rendered. */
url: URL;
/** The route matcher (e.g. /blog/:id) that the request matched for this page
* to be rendered. */
pattern: string;
/** The error that caused the error page to be loaded. */
error: unknown;
}
export interface ErrorHandlerContext<State = Record<string, unknown>>
extends ConnInfo {
error: unknown;
render: () => Response | Promise<Response>;
state: State;
}
export type ErrorHandler = (
req: Request,
ctx: ErrorHandlerContext,
) => Response | Promise<Response>;
export interface ErrorPageModule {
default?: ComponentType<ErrorPageProps>;
handler?: ErrorHandler;
config?: RouteConfig;
}
export interface ErrorPage {
pattern: string;
url: string;
name: string;
component?: ComponentType<ErrorPageProps>;
handler: ErrorHandler;
csp: boolean;
}
// --- MIDDLEWARES ---
export interface MiddlewareHandlerContext<State = Record<string, unknown>>
extends ConnInfo {
next: () => Promise<Response>;
state: State;
}
export interface MiddlewareRoute extends Middleware {
/**
* path-to-regexp style url path
*/
pattern: string;
/**
* URLPattern of the route
*/
compiledPattern: URLPattern;
}
// deno-lint-ignore no-explicit-any
export interface MiddlewareModule<State = any> {
handler(
req: Request,
ctx: MiddlewareHandlerContext<State>,
): Response | Promise<Response>;
}
export interface Middleware<State = Record<string, unknown>> {
handler(
req: Request,
ctx: MiddlewareHandlerContext<State>,
): Response | Promise<Response>;
}
// --- ISLANDS ---
export interface IslandModule {
// deno-lint-ignore no-explicit-any
default: ComponentType<any>;
}
export interface Island {
id: string;
name: string;
url: string;
component: ComponentType<unknown>;
}