solid-router/src/types.ts at 0cc6e4cee8572c28de3ba70ac9c031f1ff4562b1 · solidjs/solid-router · GitHub

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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
import type { Component, JSX, Signal } from "solid-js";

declare module "solid-js/web" {
  interface RequestEvent {
    response: {
      status?: number;
      statusText?: string;
      headers: Headers;
    };
    router?: {
      matches?: OutputMatch[];
      cache?: Map<string, CacheEntry>;
      submission?: {
        input: any;
        result: any;
        url: string;
      };
      dataOnly?: boolean | string[];
      data?: Record<string, any>;
      previousUrl?: string;
    };
    serverOnly?: boolean;
  }
}

export type Params = Record<string, string | undefined>;
export type SearchParams = Record<string, string | string[] | undefined>;

export type SetParams = Record<
  string,
  string | number | boolean | null | undefined
>;
export type SetSearchParams = Record<
  string,
  string | string[] | number | number[] | boolean | boolean[] | null | undefined
>;

export interface Path {
  pathname: string;
  search: string;
  hash: string;
}

export interface Location<S = unknown> extends Path {
  query: SearchParams;
  state: Readonly<Partial<S>> | null;
  key: string;
}

export interface NavigateOptions<S = unknown> {
  resolve: boolean;
  replace: boolean;
  scroll: boolean;
  state: S;
}

export interface Navigator {
  (to: string, options?: Partial<NavigateOptions>): void;
  (delta: number): void;
}

export type NavigatorFactory = (route?: RouteContext) => Navigator;

export interface LocationChange<S = unknown> {
  value: string;
  replace?: boolean;
  scroll?: boolean;
  state?: S;
  rawPath?: string;
}
export interface RouterIntegration {
  signal: Signal<LocationChange>;
  create?: (router: RouterContext) => void;
  utils?: Partial<RouterUtils>;
}

export type Intent = "initial" | "native" | "navigate" | "preload";
export interface RoutePreloadFuncArgs {
  params: Params;
  location: Location;
  intent: Intent;
}

export type RoutePreloadFunc<T = unknown> = (args: RoutePreloadFuncArgs) => T;

/**
 * Arguments passed to a route guard function.
 */
export interface RouteGuardFuncArgs {
  params: Params;
  location: Location;
  intent: Intent;
}

/**
 * Return type for route guard functions.
 * - `true`: Allow access to the route
 * - `false`: Deny access (show nothing or stay on current route)
 * - `string`: Redirect to the specified path
 */
export type RouteGuardResult = boolean | string | { allowed: boolean; redirect?: string };

/**
 * Route guard function that determines if a route can be accessed.
 * Can return a boolean, redirect path, or a RouteGuardResult object.
 * Supports both synchronous and asynchronous guards.
 */
export type RouteGuardFunc = (
  args: RouteGuardFuncArgs
) => RouteGuardResult | Promise<RouteGuardResult>;

export interface RouteSectionProps<T = unknown> {
  params: Params;
  location: Location;
  data: T;
  children?: JSX.Element;
}

export type RouteDefinition<S extends string | string[] = any, T = unknown> = {
  path?: S;
  matchFilters?: MatchFilters<S>;
  preload?: RoutePreloadFunc<T>;
  guard?: RouteGuardFunc | boolean;
  children?: RouteDefinition | RouteDefinition[];
  component?: Component<RouteSectionProps<T>>;
  info?: Record<string, any>;
  /** @deprecated use preload */
  load?: RoutePreloadFunc;
};

export type MatchFilter = readonly string[] | RegExp | ((s: string) => boolean);

export type PathParams<P extends string | readonly string[]> =
  P extends `${infer Head}/${infer Tail}`
    ? [...PathParams<Head>, ...PathParams<Tail>]
    : P extends `:${infer S}?`
    ? [S]
    : P extends `:${infer S}`
    ? [S]
    : P extends `*${infer S}`
    ? [S]
    : [];

export type MatchFilters<P extends string | readonly string[] = any> = P extends string
  ? { [K in PathParams<P>[number]]?: MatchFilter }
  : Record<string, MatchFilter>;

export interface PathMatch {
  params: Params;
  path: string;
}

export interface RouteMatch extends PathMatch {
  route: RouteDescription;
}

export interface OutputMatch {
  path: string;
  pattern: string;
  match: string;
  params: Params;
  info?: Record<string, any>;
}

export interface RouteDescription {
  key: unknown;
  originalPath: string;
  pattern: string;
  component?: Component<RouteSectionProps>;
  preload?: RoutePreloadFunc;
  guard?: RouteGuardFunc | boolean;
  matcher: (location: string) => PathMatch | null;
  matchFilters?: MatchFilters;
  info?: Record<string, any>;
}

export interface Branch {
  routes: RouteDescription[];
  score: number;
  matcher: (location: string) => RouteMatch[] | null;
}

export interface RouteContext {
  parent?: RouteContext;
  child?: RouteContext;
  pattern: string;
  path: () => string;
  outlet: () => JSX.Element;
  resolvePath(to: string): string | undefined;
}

export interface RouterUtils {
  renderPath(path: string): string;
  parsePath(str: string): string;
  go(delta: number): void;
  beforeLeave: BeforeLeaveLifecycle;
  paramsWrapper: (getParams: () => Params, branches: () => Branch[]) => Params;
  queryWrapper: (getQuery: () => SearchParams) => SearchParams;
}

export interface RouterContext {
  base: RouteContext;
  location: Location;
  params: Params;
  navigatorFactory: NavigatorFactory;
  isRouting: () => boolean;
  matches: () => RouteMatch[];
  renderPath(path: string): string;
  parsePath(str: string): string;
  beforeLeave: BeforeLeaveLifecycle;
  preloadRoute: (url: URL, preloadData?: boolean) => void;
  checkRouteGuard: (matches: RouteMatch[]) => Promise<{ allowed: boolean; redirect?: string }>;
  singleFlight: boolean;
  submissions: Signal<Submission<any, any>[]>;
}

export interface BeforeLeaveEventArgs {
  from: Location;
  to: string | number;
  options?: Partial<NavigateOptions>;
  readonly defaultPrevented: boolean;
  preventDefault(): void;
  retry(force?: boolean): void;
}

export interface BeforeLeaveListener {
  listener(e: BeforeLeaveEventArgs): void;
  location: Location;
  navigate: Navigator;
}

export interface BeforeLeaveLifecycle {
  subscribe(listener: BeforeLeaveListener): () => void;
  confirm(to: string | number, options?: Partial<NavigateOptions>): boolean;
}

export type Submission<T, U> = {
  readonly input: T;
  readonly result?: U;
  readonly error: any;
  readonly pending: boolean;
  readonly url: string;
  clear: () => void;
  retry: () => void;
};

export type SubmissionStub = {
  readonly input: undefined;
  readonly result: undefined;
  readonly error: undefined;
  readonly pending: undefined;
  readonly url: undefined;
  clear: () => void;
  retry: () => void;
};

export interface MaybePreloadableComponent extends Component {
  preload?: () => void;
}

export type CacheEntry = [number, Promise<any>, any, Intent | undefined, Signal<number> & { count: number }];

export type NarrowResponse<T> = T extends CustomResponse<infer U> ? U : Exclude<T, Response>;
export type RouterResponseInit = Omit<ResponseInit, "body"> & { revalidate?: string | string[] };
// export type CustomResponse<T> = Response & { customBody: () => T };
// hack to avoid it thinking it inherited from Response
export type CustomResponse<T> = Omit<Response, "clone"> & {
  customBody: () => T;
  clone(...args: readonly unknown[]): CustomResponse<T>;
};

/** @deprecated */
export type RouteLoadFunc = RoutePreloadFunc;
/** @deprecated */
export type RouteLoadFuncArgs = RoutePreloadFuncArgs;