@ivlev-dev/silent-router 0.10.1 → 0.11.1
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.
- package/README.md +207 -114
- package/dist/index.d.ts +3 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -1
- package/dist/index.js.map +1 -1
- package/dist/link.d.ts +2 -2
- package/dist/link.d.ts.map +1 -1
- package/dist/link.js +9 -2
- package/dist/link.js.map +1 -1
- package/dist/match.d.ts +23 -3
- package/dist/match.d.ts.map +1 -1
- package/dist/match.js +249 -11
- package/dist/match.js.map +1 -1
- package/dist/route.d.ts +71 -0
- package/dist/route.d.ts.map +1 -0
- package/dist/route.js +60 -0
- package/dist/route.js.map +1 -0
- package/dist/router-view.d.ts +5 -10
- package/dist/router-view.d.ts.map +1 -1
- package/dist/router-view.js +28 -8
- package/dist/router-view.js.map +1 -1
- package/dist/router.d.ts +26 -3
- package/dist/router.d.ts.map +1 -1
- package/dist/router.js +24 -2
- package/dist/router.js.map +1 -1
- package/package.json +5 -3
package/README.md
CHANGED
|
@@ -1,20 +1,20 @@
|
|
|
1
1
|
# @ivlev-dev/silent-router
|
|
2
2
|
|
|
3
|
-
Роутер Silent Framework:
|
|
3
|
+
Роутер Silent Framework: интерфейс `IRouter`, route-классы с типизированными параметрами, вложенные маршруты, guards, ленивые компоненты, DI-доставка, восстановление скролла и SSR через `MemoryHistory`.
|
|
4
4
|
|
|
5
5
|
[](https://www.npmjs.com/package/@ivlev-dev/silent-router) [](https://github.com/ivlev-dev/silent-framework/blob/main/LICENSE) [](https://www.npmjs.com/package/@ivlev-dev/silent-router)
|
|
6
6
|
|
|
7
7
|
## Возможности
|
|
8
8
|
|
|
9
|
-
- `
|
|
10
|
-
-
|
|
11
|
-
- `
|
|
12
|
-
-
|
|
13
|
-
- `
|
|
14
|
-
- `
|
|
9
|
+
- `IRouter` и `Router implements IRouter`; ViewModel получает роутер через `constructor(private readonly router: IRouter)`.
|
|
10
|
+
- Route-классы с типизированными `PathParams<"/edit/{id}">` и generic-query, включая mixed-сегменты `edit-{id}-{tab}` и `v{version}.{ext}`.
|
|
11
|
+
- Синтаксис `/edit/{id}` и совместимый `:id`, вложенные маршруты, `*`, index-маршруты.
|
|
12
|
+
- Runtime-схема query (`QuerySchema`) приводит `number`, `boolean` и массивы; `RouteViewProps.query` и `router.query` содержат уже распарсенные значения.
|
|
13
|
+
- `redirect`, синхронные и асинхронные `beforeEnter`, ленивый `load(context)` с кешированием.
|
|
14
|
+
- `Link` и `RouterView` получают роутер из DI-контекста синхронно, с fallback на prop и `Router.current()`.
|
|
15
|
+
- `RouterView` монтирует route-компоненты через core `component(...)`, поэтому ViewModel/DI работают.
|
|
15
16
|
- `BrowserHistory` (`pushState`, `popstate`, `hashchange`) и `MemoryHistory` для тестов и SSR.
|
|
16
17
|
- Восстановление скролла: `scrollBehavior(to, from, savedPosition)`.
|
|
17
|
-
- Несколько приложений на странице: `Router.current()` и явный проп `router` у компонентов.
|
|
18
18
|
|
|
19
19
|
## Установка
|
|
20
20
|
|
|
@@ -30,33 +30,50 @@ npm install @ivlev-dev/silent-router
|
|
|
30
30
|
yarn add @ivlev-dev/silent-router
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
`@ivlev-dev/silent-core` и `@ivlev-dev/silent-reactivity` устанавливаются как зависимости пакета. Пакет поставляется только как ESM. Требуется Node.js 22 или новее.
|
|
33
|
+
`@ivlev-dev/silent-core`, `@ivlev-dev/silent-di` и `@ivlev-dev/silent-reactivity` устанавливаются как зависимости пакета. Пакет поставляется только как ESM. Требуется Node.js 22 или новее.
|
|
34
34
|
|
|
35
35
|
## Быстрый старт
|
|
36
36
|
|
|
37
37
|
```tsx
|
|
38
|
-
import {
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
38
|
+
import {
|
|
39
|
+
Route,
|
|
40
|
+
Router,
|
|
41
|
+
RouterView,
|
|
42
|
+
Link,
|
|
43
|
+
type RouteViewProps,
|
|
44
|
+
} from "@ivlev-dev/silent-router";
|
|
45
|
+
|
|
46
|
+
class HomeRoute extends Route {
|
|
47
|
+
readonly path = "/";
|
|
48
|
+
readonly name = "home";
|
|
49
|
+
readonly component = Home;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
class UsersRoute extends Route {
|
|
53
|
+
readonly path = "/users";
|
|
54
|
+
readonly name = "users";
|
|
55
|
+
readonly component = UsersLayout;
|
|
56
|
+
readonly children = [UsersIndexRoute, UserRoute];
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
class UserRoute extends Route<"{id}", { tab?: "info" | "profile" }> {
|
|
60
|
+
readonly path = "{id}";
|
|
61
|
+
readonly name = "user";
|
|
62
|
+
readonly component = UserView;
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
function UserView(props: RouteViewProps<"{id}", { tab?: "info" | "profile" }>) {
|
|
66
|
+
return (
|
|
67
|
+
<section>
|
|
68
|
+
<h1>{props.params.id}</h1>
|
|
69
|
+
<p>{props.query.tab ?? "info"}</p>
|
|
70
|
+
</section>
|
|
71
|
+
);
|
|
72
|
+
}
|
|
42
73
|
|
|
43
74
|
export const router = new Router({
|
|
44
75
|
base: "/app",
|
|
45
|
-
routes: [
|
|
46
|
-
{ path: "/", name: "home", component: Home },
|
|
47
|
-
{
|
|
48
|
-
path: "/users",
|
|
49
|
-
name: "users",
|
|
50
|
-
component: Users,
|
|
51
|
-
children: [
|
|
52
|
-
{ path: "", name: "users-index", component: UsersIndex },
|
|
53
|
-
{ path: ":id", name: "user", component: User },
|
|
54
|
-
{ path: ":id/posts/:postId", name: "post", component: Post },
|
|
55
|
-
],
|
|
56
|
-
},
|
|
57
|
-
{ path: "/files/*", name: "files", component: Files },
|
|
58
|
-
{ path: "/old", redirect: "/" },
|
|
59
|
-
],
|
|
76
|
+
routes: [HomeRoute, UsersRoute],
|
|
60
77
|
});
|
|
61
78
|
|
|
62
79
|
await router.start();
|
|
@@ -66,7 +83,6 @@ export function App() {
|
|
|
66
83
|
<nav>
|
|
67
84
|
<Link to="/" activeClass="active" exactActiveClass="exact">Главная</Link>
|
|
68
85
|
<Link to={{ name: "users" }} activeClass="active">Пользователи</Link>
|
|
69
|
-
<Link to="/files/docs/readme.md">Файлы</Link>
|
|
70
86
|
</nav>
|
|
71
87
|
<main>
|
|
72
88
|
<RouterView fallback={<p>Загрузка…</p>} />
|
|
@@ -75,52 +91,129 @@ export function App() {
|
|
|
75
91
|
}
|
|
76
92
|
```
|
|
77
93
|
|
|
78
|
-
`
|
|
94
|
+
## `IRouter` и DI
|
|
79
95
|
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
|
|
96
|
+
```ts
|
|
97
|
+
import type { IRouter } from "@ivlev-dev/silent-router";
|
|
98
|
+
|
|
99
|
+
export class PageVM {
|
|
100
|
+
constructor(private readonly router: IRouter) {}
|
|
101
|
+
|
|
102
|
+
open(): Promise<void> {
|
|
103
|
+
return this.router.push({ name: "user", params: { id: 42 } });
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
`IRouter` содержит `base`, `state()`, `route`, `params`, `query`, `hash`, `matched`, `resolve`, `href`, `push`, `replace`, `back`, `forward`, `start`, `stop`, `dispose`. В рантайме `IRouter` — value-токен, совпадающий с `Router`, поэтому компилятор DI подставляет его как единственную реализацию.
|
|
109
|
+
|
|
110
|
+
Зарегистрируйте роутер в контейнере:
|
|
111
|
+
|
|
112
|
+
```ts
|
|
113
|
+
import { container } from "@ivlev-dev/silent-di";
|
|
114
|
+
|
|
115
|
+
const router = new Router({ routes, container });
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
Или явно:
|
|
119
|
+
|
|
120
|
+
```ts
|
|
121
|
+
const router = new Router({ routes });
|
|
122
|
+
router.provide(container);
|
|
83
123
|
```
|
|
84
124
|
|
|
85
|
-
|
|
125
|
+
`provide` вызывает `container.bindValue(Router, router)`, поэтому `container.peek(Router)` работает синхронно сразу после регистрации. `container.bind(Router, router)` с готовым экземпляром тоже виден синхронно через `peek`/`peekValue`: non-function значение сразу попадает в resolved-кеш, а function-factory сохраняет прежнее ленивое поведение.
|
|
126
|
+
|
|
127
|
+
Порядок поиска роутера в `Link` и `RouterView`:
|
|
86
128
|
|
|
87
|
-
|
|
129
|
+
1. явный `router` prop;
|
|
130
|
+
2. `getRuntimeOptions().container.peek(Router)`;
|
|
131
|
+
3. `Router.current()`.
|
|
132
|
+
|
|
133
|
+
`Link` не использует асинхронный `resolve`.
|
|
134
|
+
|
|
135
|
+
## Route-классы
|
|
136
|
+
|
|
137
|
+
```ts
|
|
138
|
+
import { Route, type RouteLoadContext } from "@ivlev-dev/silent-router";
|
|
139
|
+
|
|
140
|
+
class AdminRoute extends Route {
|
|
141
|
+
readonly path = "/admin";
|
|
142
|
+
readonly name = "admin";
|
|
143
|
+
readonly component = AdminLayout;
|
|
144
|
+
readonly children = [AdminIndexRoute, AdminUserRoute];
|
|
145
|
+
readonly meta = { requiresAuth: true };
|
|
146
|
+
readonly beforeEnter = async (to: RouteLocation, from: RouteLocation | null, signal: AbortSignal) => {
|
|
147
|
+
if (signal.aborted) return false;
|
|
148
|
+
return (await checkSession()) ? true : "/login";
|
|
149
|
+
};
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
class AdminUserRoute extends Route<"users/{id}"> {
|
|
153
|
+
readonly path = "users/{id}";
|
|
154
|
+
readonly name = "admin-user";
|
|
155
|
+
async load(context: RouteLoadContext<"users/{id}">) {
|
|
156
|
+
const module = await import("./admin-user");
|
|
157
|
+
return module.AdminUser;
|
|
158
|
+
}
|
|
159
|
+
}
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
`RouterOptions.routes` принимает route-классы, их экземпляры и старые object-routes. Классы инстанцируются роутером.
|
|
163
|
+
|
|
164
|
+
`Route` поддерживает `path`, `name`, `component`, `children`, `redirect`, `meta`, `beforeEnter`, `load`.
|
|
165
|
+
|
|
166
|
+
- `{id}` и `:id` — параметрические сегменты. `PathParams<"/users/{id}">` даёт `{ readonly id: string }`.
|
|
167
|
+
- Параметры можно смешивать с литералами внутри одного сегмента: `prefix-{id}`, `edit-{id}-{tab}`, `v{version}.{ext}`. Mixed-сегмент специфичнее чистого параметра и уступает чистому статическому сегменту.
|
|
168
|
+
- `Query` — generic-форма query для `RouteViewProps` и `RouteLoadContext`. `query` задаёт runtime-схему (`QueryParser`/`QuerySchema`): `"string"`, `"number"`, `"boolean"`, `"string[]"`, `"number[]"`, `"boolean[]"` или функция `(raw) => value | undefined`.
|
|
169
|
+
- `load(context)` получает `route`, `params`, `query`, `hash`, `router`, `signal`; можно вернуть компонент или модуль с `default`. Компонент кешируется.
|
|
170
|
+
- `beforeEnter` возвращает `true`, `false`, путь/объект маршрута или `Promise` с этим значением.
|
|
171
|
+
- `redirect` — строка, объект маршрута или функция `(to) => target`.
|
|
172
|
+
- `meta` не интерпретируется роутером и доступен через `matched[i].record.meta`.
|
|
173
|
+
|
|
174
|
+
```ts
|
|
175
|
+
import { Route, type QuerySchema, type RouteViewProps } from "@ivlev-dev/silent-router";
|
|
176
|
+
|
|
177
|
+
type EditQuery = { page: number; active: boolean; tags: string[] };
|
|
178
|
+
|
|
179
|
+
const editQuery: QuerySchema<EditQuery> = {
|
|
180
|
+
page: "number",
|
|
181
|
+
active: "boolean",
|
|
182
|
+
tags: "string[]",
|
|
183
|
+
};
|
|
184
|
+
|
|
185
|
+
class EditRoute extends Route<"/edit-{id}", EditQuery> {
|
|
186
|
+
readonly path = "/edit-{id}";
|
|
187
|
+
readonly name = "edit";
|
|
188
|
+
readonly component = EditView;
|
|
189
|
+
readonly query = editQuery;
|
|
190
|
+
}
|
|
191
|
+
|
|
192
|
+
function EditView(props: RouteViewProps<"/edit-{id}", EditQuery>) {
|
|
193
|
+
return (
|
|
194
|
+
<section>
|
|
195
|
+
<h1>{props.params.id}</h1>
|
|
196
|
+
<p>{props.query.page}</p>
|
|
197
|
+
<p>{String(props.query.active)}</p>
|
|
198
|
+
<p>{props.query.tags.join(", ")}</p>
|
|
199
|
+
</section>
|
|
200
|
+
);
|
|
201
|
+
}
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
Для `/edit-7?page=2&active=true&tags=a&tags=b` в `props.query` и `router.query` будут `{ page: 2, active: true, tags: ["a", "b"] }`. Невалидные `number`/`boolean` и отсутствующие ключи дают `undefined` (ключ не попадает в объект). Function-parser получает сырое значение `string | string[] | undefined`. Схемы вложенных маршрутов объединяются от корня к листу.
|
|
205
|
+
|
|
206
|
+
Object-routes остаются для совместимости:
|
|
88
207
|
|
|
89
208
|
```ts
|
|
90
209
|
import type { RouteRecord } from "@ivlev-dev/silent-router";
|
|
91
210
|
|
|
92
211
|
const routes: RouteRecord[] = [
|
|
93
|
-
{
|
|
94
|
-
|
|
95
|
-
name: "admin",
|
|
96
|
-
component: AdminLayout,
|
|
97
|
-
meta: { requiresAuth: true },
|
|
98
|
-
beforeEnter: async (to, from, signal) => {
|
|
99
|
-
const allowed = await checkSession(signal);
|
|
100
|
-
return allowed ? true : "/login";
|
|
101
|
-
},
|
|
102
|
-
children: [
|
|
103
|
-
{ path: "", name: "admin-index", component: AdminIndex },
|
|
104
|
-
{
|
|
105
|
-
path: "users/:id",
|
|
106
|
-
name: "admin-user",
|
|
107
|
-
load: async () => {
|
|
108
|
-
const module = await import("./admin-user");
|
|
109
|
-
return module.AdminUser;
|
|
110
|
-
},
|
|
111
|
-
},
|
|
112
|
-
],
|
|
113
|
-
},
|
|
212
|
+
{ path: "/", name: "home", component: Home },
|
|
213
|
+
{ path: "/users/:id", name: "user", component: User },
|
|
114
214
|
];
|
|
115
215
|
```
|
|
116
216
|
|
|
117
|
-
- `path` поддерживает `:param`, `*` (хвост попадает в `params["*"]`) и `""` для index-маршрута.
|
|
118
|
-
- При совпадении нескольких записей побеждает более специфичная: статический сегмент важнее `:param`, `:param` важнее `*`, вложенная цепочка важнее одиночного маршрута.
|
|
119
|
-
- `load` возвращает компонент или модуль с `default`; загруженный компонент кешируется.
|
|
120
|
-
- `beforeEnter` может вернуть `true`, `false`, путь/объект маршрута или `Promise` с этим значением.
|
|
121
|
-
- `redirect` может быть строкой, объектом маршрута или функцией `(to) => target`.
|
|
122
|
-
- `meta` не интерпретируется роутером и доступен через `matched[i].record.meta`.
|
|
123
|
-
|
|
124
217
|
## Навигация и состояние
|
|
125
218
|
|
|
126
219
|
```ts
|
|
@@ -129,59 +222,54 @@ await router.replace({ name: "users" });
|
|
|
129
222
|
router.back();
|
|
130
223
|
router.forward();
|
|
131
224
|
|
|
132
|
-
router.route;
|
|
133
|
-
router.params;
|
|
134
|
-
router.query;
|
|
135
|
-
router.hash;
|
|
136
|
-
router.matched;
|
|
137
|
-
|
|
138
|
-
router.state(); // Accessor<RouterState> — читайте в JSX/эффекте для реактивности
|
|
225
|
+
router.route;
|
|
226
|
+
router.params;
|
|
227
|
+
router.query;
|
|
228
|
+
router.hash;
|
|
229
|
+
router.matched;
|
|
230
|
+
router.state();
|
|
139
231
|
```
|
|
140
232
|
|
|
141
233
|
`RouterState` содержит `route`, `params`, `query`, `hash`, `matched`, `pending` и `error`. Во время навигации `pending` равен `true`; ошибка сохраняется в `error`, а промис `push`/`replace` отклоняется.
|
|
142
234
|
|
|
143
|
-
`resolve(to)` возвращает `RouteLocation` без навигации:
|
|
144
|
-
|
|
145
235
|
```ts
|
|
146
|
-
const location = router.resolve({
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
236
|
+
const location = router.resolve({
|
|
237
|
+
name: "user",
|
|
238
|
+
params: { id: 42 },
|
|
239
|
+
query: { tab: "info" },
|
|
240
|
+
});
|
|
150
241
|
|
|
151
|
-
|
|
242
|
+
location.fullPath;
|
|
243
|
+
location.matched;
|
|
152
244
|
|
|
153
|
-
|
|
154
|
-
router.href("/users/42"); // "/app/users/42"
|
|
245
|
+
router.href("/users/42");
|
|
155
246
|
```
|
|
156
247
|
|
|
157
248
|
## Guards, загрузчики и отмена
|
|
158
249
|
|
|
159
250
|
```ts
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
},
|
|
178
|
-
],
|
|
179
|
-
});
|
|
251
|
+
class PrivateRoute extends Route {
|
|
252
|
+
readonly path = "/private";
|
|
253
|
+
readonly component = Private;
|
|
254
|
+
readonly beforeEnter = async (to: RouteLocation, from: RouteLocation | null, signal: AbortSignal) => {
|
|
255
|
+
if (signal.aborted) return false;
|
|
256
|
+
return (await isAuthorized()) ? true : { name: "login" };
|
|
257
|
+
};
|
|
258
|
+
}
|
|
259
|
+
|
|
260
|
+
class ReportRoute extends Route {
|
|
261
|
+
readonly path = "/report";
|
|
262
|
+
async load(context: RouteLoadContext<"/report">) {
|
|
263
|
+
if (context.signal.aborted) throw new Error("aborted");
|
|
264
|
+
const module = await import("./report");
|
|
265
|
+
return module.Report;
|
|
266
|
+
}
|
|
267
|
+
}
|
|
180
268
|
```
|
|
181
269
|
|
|
182
270
|
Новая навигация вызывает `AbortController.abort()` у предыдущей. Устаревшая навигация завершается без обновления состояния и без отклонения промиса. Если guard вернул `false`, навигация отменяется, а текущий маршрут остаётся прежним.
|
|
183
271
|
|
|
184
|
-
Ошибки guard и загрузчика оборачиваются в `RouterNavigationError` с `code: "guard" | "load"`. Отсутствие
|
|
272
|
+
Ошибки guard и загрузчика оборачиваются в `RouterNavigationError` с `code: "guard" | "load"`. Отсутствие роутера у компонента даёт `RouterMissingError`. Прерванная навигация использует `RouterAbortError`.
|
|
185
273
|
|
|
186
274
|
```ts
|
|
187
275
|
import { RouterNavigationError } from "@ivlev-dev/silent-router";
|
|
@@ -200,8 +288,7 @@ try {
|
|
|
200
288
|
`RouterView` рендерит компонент из `matched[depth]`:
|
|
201
289
|
|
|
202
290
|
```tsx
|
|
203
|
-
|
|
204
|
-
export function AdminLayout(props: RouterViewComponentProps) {
|
|
291
|
+
export function AdminLayout(props: RouteViewProps) {
|
|
205
292
|
return (
|
|
206
293
|
<section>
|
|
207
294
|
<h1>Админка</h1>
|
|
@@ -211,7 +298,7 @@ export function AdminLayout(props: RouterViewComponentProps) {
|
|
|
211
298
|
}
|
|
212
299
|
```
|
|
213
300
|
|
|
214
|
-
|
|
301
|
+
Route-компонент получает `RouteViewProps`: `route`, `params`, `query`, `hash`, `router`. `RouterView` монтирует его через core `component(...)`, поэтому ViewModel с DI работает и на клиенте, и на сервере.
|
|
215
302
|
|
|
216
303
|
## История и SSR
|
|
217
304
|
|
|
@@ -222,22 +309,28 @@ import { Router, createMemoryHistory } from "@ivlev-dev/silent-router";
|
|
|
222
309
|
|
|
223
310
|
export function createServerRouter() {
|
|
224
311
|
return new Router({
|
|
225
|
-
routes,
|
|
312
|
+
routes: [HomeRoute, UsersRoute, UserRoute],
|
|
226
313
|
history: createMemoryHistory("/users/42?tab=info"),
|
|
314
|
+
container: appScope,
|
|
227
315
|
});
|
|
228
316
|
}
|
|
229
317
|
|
|
230
318
|
const router = createServerRouter();
|
|
231
|
-
await router.start();
|
|
232
|
-
const html = await renderToString(
|
|
319
|
+
await router.start();
|
|
320
|
+
const { html } = await renderToString(App, { container: appScope });
|
|
233
321
|
```
|
|
234
322
|
|
|
235
|
-
На клиенте используйте `BrowserHistory` и тот же набор
|
|
323
|
+
На клиенте используйте `BrowserHistory` и тот же набор route-классов:
|
|
236
324
|
|
|
237
325
|
```ts
|
|
238
326
|
import { Router, createBrowserHistory } from "@ivlev-dev/silent-router";
|
|
239
327
|
|
|
240
|
-
const router = new Router({
|
|
328
|
+
const router = new Router({
|
|
329
|
+
routes: [HomeRoute, UsersRoute, UserRoute],
|
|
330
|
+
history: createBrowserHistory(window),
|
|
331
|
+
container,
|
|
332
|
+
});
|
|
333
|
+
|
|
241
334
|
await router.start();
|
|
242
335
|
```
|
|
243
336
|
|
|
@@ -262,18 +355,18 @@ const router = new Router({
|
|
|
262
355
|
|
|
263
356
|
```ts
|
|
264
357
|
const router = new Router({ routes });
|
|
265
|
-
router.start();
|
|
266
|
-
router.stop();
|
|
267
|
-
router.dispose();
|
|
358
|
+
router.start();
|
|
359
|
+
router.stop();
|
|
360
|
+
router.dispose();
|
|
268
361
|
```
|
|
269
362
|
|
|
270
363
|
`stop()` можно вызывать и вызывать `start()` повторно. `dispose()` не освобождает историю, переданную пользователем: её нужно закрыть самостоятельно.
|
|
271
364
|
|
|
272
365
|
## Публичный API
|
|
273
366
|
|
|
274
|
-
- Классы: `Router`, `BrowserHistory`, `MemoryHistory`, `RouterMissingError`, `RouterNavigationError`, `RouterAbortError`.
|
|
367
|
+
- Классы: `Router`, `Route`, `BrowserHistory`, `MemoryHistory`, `RouterMissingError`, `RouterNavigationError`, `RouterAbortError`.
|
|
368
|
+
- Интерфейсы и типы: `IRouter`, `RouterOptions`, `RouterState`, `RouteClass`, `RouteDefinition`, `RouteInput`, `RouteViewProps`, `RouteLoadContext`, `RouteClassGuard`, `RouteClassLoad`, `RouteComponent`, `PathParams`, `TypedRouteLocation`, `RouteQueryShape`, `QueryParser`, `QuerySchema`, `RouteRecord`, `RouteLocation`, `MatchedRoute`, `RouteParams`, `RouteQuery`, `RouteQueryValue`, `RouteTarget`, `RouteGuard`, `RouteLoader`, `RouteRedirect`, `ScrollBehavior`, `ScrollPosition`, `RouterHistory`, `HistoryLocation`, `LinkProps`, `RouterViewProps`, `RouterViewComponentProps`.
|
|
275
369
|
- Компоненты: `Link`, `RouterView`.
|
|
276
370
|
- Функции создания истории: `createBrowserHistory`, `createMemoryHistory`.
|
|
277
|
-
- Типы: `RouterOptions`, `RouterState`, `RouteRecord`, `RouteLocation`, `MatchedRoute`, `RouteParams`, `RouteQuery`, `RouteTarget`, `RouteGuard`, `RouteLoader`, `RouteRedirect`, `ScrollBehavior`, `ScrollPosition`, `RouterHistory`, `HistoryLocation`, `LinkProps`, `RouterViewProps`, `RouterViewComponentProps` и связанные результаты guard/loader.
|
|
278
371
|
|
|
279
|
-
Публичных hooks (`useRouter`, `useRoute`, `useParams`) нет: состояние доступно через
|
|
372
|
+
Публичных hooks (`useRouter`, `useRoute`, `useParams`) нет: состояние доступно через `IRouter` и `RouteViewProps`.
|
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
|
-
export { Router, type RouterOptions, type RouterState } from "./router.js";
|
|
1
|
+
export { Router, IRouter, type RouterOptions, type RouterState } from "./router.js";
|
|
2
|
+
export { Route, type AnyRouteGuard, type AnyRouteLoader, type PathParams, type RouteClass, type RouteClassGuard, type RouteClassLoad, type RouteComponent, type RouteDefinition, type RouteInput, type RouteLoadContext, type RouteQueryShape, type RouteViewProps, type TypedRouteLocation, } from "./route.js";
|
|
2
3
|
export { BrowserHistory, MemoryHistory, createBrowserHistory, createMemoryHistory, type HistoryListener, type HistoryLocation, type RouterHistory, } from "./history.js";
|
|
3
|
-
export { RouterAbortError, RouterMissingError, RouterNavigationError, type MatchedRoute, type QueryInput, type RouteGuard, type RouteGuardResult, type RouteLoader, type RouteLoaderResult, type RouteLocation, type RouteLocationTargetObject, type RouteMeta, type RouteParams, type RouteQuery, type RouteQueryValue, type RouteRecord, type RouteRedirect, type RouteTarget, type RouterErrorCode, type ScrollBehavior, type ScrollBehaviorResult, type ScrollPosition, } from "./match.js";
|
|
4
|
+
export { RouterAbortError, RouterMissingError, RouterNavigationError, type MatchedRoute, type QueryInput, type QueryParser, type QuerySchema, type RouteGuard, type RouteGuardResult, type RouteLoader, type RouteLoaderResult, type RouteLocation, type RouteLocationTargetObject, type RouteMeta, type RouteParams, type RouteQuery, type RouteQueryValue, type RouteRecord, type RouteRedirect, type RouteTarget, type RouterErrorCode, type ScrollBehavior, type ScrollBehaviorResult, type ScrollPosition, } from "./match.js";
|
|
4
5
|
export { Link, type LinkProps } from "./link.js";
|
|
5
6
|
export { RouterView, type RouterViewComponentProps, type RouterViewProps, } from "./router-view.js";
|
|
6
7
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,KAAK,aAAa,EAAE,KAAK,WAAW,EAAE,MAAM,aAAa,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,aAAa,EAAE,KAAK,WAAW,EAAE,MAAM,aAAa,CAAC;AACpF,OAAO,EACL,KAAK,EACL,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,UAAU,EACf,KAAK,UAAU,EACf,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,KAAK,UAAU,EACf,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,kBAAkB,GACxB,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,cAAc,EACd,aAAa,EACb,oBAAoB,EACpB,mBAAmB,EACnB,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,aAAa,GACnB,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,qBAAqB,EACrB,KAAK,YAAY,EACjB,KAAK,UAAU,EACf,KAAK,WAAW,EAChB,KAAK,WAAW,EAChB,KAAK,UAAU,EACf,KAAK,gBAAgB,EACrB,KAAK,WAAW,EAChB,KAAK,iBAAiB,EACtB,KAAK,aAAa,EAClB,KAAK,yBAAyB,EAC9B,KAAK,SAAS,EACd,KAAK,WAAW,EAChB,KAAK,UAAU,EACf,KAAK,eAAe,EACpB,KAAK,WAAW,EAChB,KAAK,aAAa,EAClB,KAAK,WAAW,EAChB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,oBAAoB,EACzB,KAAK,cAAc,GACpB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,IAAI,EAAE,KAAK,SAAS,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EACL,UAAU,EACV,KAAK,wBAAwB,EAC7B,KAAK,eAAe,GACrB,MAAM,kBAAkB,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
export { Router } from "./router.js";
|
|
1
|
+
export { Router, IRouter } from "./router.js";
|
|
2
|
+
export { Route, } from "./route.js";
|
|
2
3
|
export { BrowserHistory, MemoryHistory, createBrowserHistory, createMemoryHistory, } from "./history.js";
|
|
3
4
|
export { RouterAbortError, RouterMissingError, RouterNavigationError, } from "./match.js";
|
|
4
5
|
export { Link } from "./link.js";
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAwC,MAAM,aAAa,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,OAAO,EAAwC,MAAM,aAAa,CAAC;AACpF,OAAO,EACL,KAAK,GAcN,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,cAAc,EACd,aAAa,EACb,oBAAoB,EACpB,mBAAmB,GAIpB,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,qBAAqB,GAsBtB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,IAAI,EAAkB,MAAM,WAAW,CAAC;AACjD,OAAO,EACL,UAAU,GAGX,MAAM,kBAAkB,CAAC"}
|
package/dist/link.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { type Children, type ClassNameValue } from "@ivlev-dev/silent-core";
|
|
2
2
|
import { type RouteTarget } from "./match.js";
|
|
3
|
-
import {
|
|
3
|
+
import { type IRouter } from "./router.js";
|
|
4
4
|
export interface LinkProps {
|
|
5
5
|
readonly to: RouteTarget | (() => RouteTarget);
|
|
6
6
|
readonly replace?: boolean;
|
|
@@ -8,7 +8,7 @@ export interface LinkProps {
|
|
|
8
8
|
readonly exactActiveClass?: string;
|
|
9
9
|
readonly class?: ClassNameValue;
|
|
10
10
|
readonly children?: Children;
|
|
11
|
-
readonly router?:
|
|
11
|
+
readonly router?: IRouter;
|
|
12
12
|
}
|
|
13
13
|
export declare function Link(props: LinkProps): Node;
|
|
14
14
|
//# sourceMappingURL=link.d.ts.map
|
package/dist/link.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"link.d.ts","sourceRoot":"","sources":["../src/link.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"link.d.ts","sourceRoot":"","sources":["../src/link.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,KAAK,QAAQ,EACb,KAAK,cAAc,EACpB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAoC,KAAK,WAAW,EAAE,MAAM,YAAY,CAAC;AAChF,OAAO,EAAU,KAAK,OAAO,EAAE,MAAM,aAAa,CAAC;AAEnD,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,EAAE,EAAE,WAAW,GAAG,CAAC,MAAM,WAAW,CAAC,CAAC;IAC/C,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,KAAK,CAAC,EAAE,cAAc,CAAC;IAChC,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAC7B,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;CAC3B;AAiCD,wBAAgB,IAAI,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI,CAiE3C"}
|
package/dist/link.js
CHANGED
|
@@ -1,9 +1,16 @@
|
|
|
1
|
-
import { attr, createElement, createMountPoint, normalizeClass, on, } from "@ivlev-dev/silent-core";
|
|
1
|
+
import { attr, createElement, createMountPoint, getRuntimeOptions, normalizeClass, on, } from "@ivlev-dev/silent-core";
|
|
2
2
|
import { createRenderEffect, onCleanup } from "@ivlev-dev/silent-reactivity";
|
|
3
3
|
import { RouterMissingError, isPathActive } from "./match.js";
|
|
4
4
|
import { Router } from "./router.js";
|
|
5
5
|
function resolveRouter(router) {
|
|
6
|
-
|
|
6
|
+
if (router !== undefined) {
|
|
7
|
+
return router;
|
|
8
|
+
}
|
|
9
|
+
const injected = getRuntimeOptions().container?.peek(Router);
|
|
10
|
+
if (injected !== undefined) {
|
|
11
|
+
return injected;
|
|
12
|
+
}
|
|
13
|
+
const resolved = Router.current();
|
|
7
14
|
if (resolved === null) {
|
|
8
15
|
throw new RouterMissingError("Link требует Router: передайте router или создайте экземпляр");
|
|
9
16
|
}
|
package/dist/link.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"link.js","sourceRoot":"","sources":["../src/link.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,IAAI,EACJ,aAAa,EACb,gBAAgB,EAChB,cAAc,EACd,EAAE,GAGH,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAC7E,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAoB,MAAM,YAAY,CAAC;AAChF,OAAO,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"link.js","sourceRoot":"","sources":["../src/link.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,IAAI,EACJ,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EACjB,cAAc,EACd,EAAE,GAGH,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAC7E,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAoB,MAAM,YAAY,CAAC;AAChF,OAAO,EAAE,MAAM,EAAgB,MAAM,aAAa,CAAC;AAYnD,SAAS,aAAa,CAAC,MAA2B;IAChD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,MAAM,QAAQ,GAAG,iBAAiB,EAAE,CAAC,SAAS,EAAE,IAAI,CAAU,MAAM,CAAC,CAAC;IACtE,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;IAClC,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;QACtB,MAAM,IAAI,kBAAkB,CAAC,8DAA8D,CAAC,CAAC;IAC/F,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,aAAa,CAAC,EAAqC;IAC1D,OAAO,OAAO,EAAE,KAAK,UAAU,CAAC,CAAC,CAAE,EAAwB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;AACrE,CAAC;AAED,SAAS,aAAa,CACpB,OAAyC,EACzC,MAAwC;IAExC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACtC,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;YACjC,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,UAAU,IAAI,CAAC,KAAgB;IACnC,MAAM,MAAM,GAAG,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC3C,MAAM,OAAO,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;IACnC,MAAM,MAAM,GAAG,GAAgB,EAAE,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAE1D,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAEnD,IACE,KAAK,CAAC,KAAK,KAAK,SAAS;WACtB,KAAK,CAAC,WAAW,KAAK,SAAS;WAC/B,KAAK,CAAC,gBAAgB,KAAK,SAAS,EACvC,CAAC;QACD,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE;YAC1B,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC;YACrC,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;YAC1C,IAAI,MAAM,GAAG,KAAK,CAAC;YACnB,IAAI,KAAK,GAAG,KAAK,CAAC;YAClB,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;gBACrB,IAAI,QAAQ,CAAC,IAAI,KAAK,IAAI,IAAI,OAAO,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,EAAE,CAAC;oBAC7D,KAAK,GAAG,aAAa,CAAC,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;oBACvD,MAAM,GAAG,KAAK,CAAC;gBACjB,CAAC;qBAAM,CAAC;oBACN,KAAK,GAAG,OAAO,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,CAAC;oBACvC,MAAM,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBAC5D,CAAC;YACH,CAAC;YACD,MAAM,OAAO,GAAa,EAAE,CAAC;YAC7B,MAAM,MAAM,GAAG,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC3C,IAAI,MAAM,KAAK,EAAE,EAAE,CAAC;gBAClB,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACvB,CAAC;YACD,IAAI,MAAM,IAAI,KAAK,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;gBAC9C,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;YAClC,CAAC;YACD,IAAI,KAAK,IAAI,KAAK,CAAC,gBAAgB,KAAK,SAAS,EAAE,CAAC;gBAClD,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;YACvC,CAAC;YACD,OAAO,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,KAAK,GAAG,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC9C,kBAAkB,CAAC,GAAG,EAAE;QACtB,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;IACH,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAEvB,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,KAAiB,EAAQ,EAAE;QACrD,IAAI,KAAK,CAAC,gBAAgB,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACjD,OAAO;QACT,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;YACrE,OAAO;QACT,CAAC;QACD,IAAI,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE,CAAC;YACrC,OAAO;QACT,CAAC;QACD,KAAK,CAAC,cAAc,EAAE,CAAC;QACvB,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,KAAK,IAAI;YACvC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YAC1B,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QAC1B,KAAK,UAAU,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC;AACjB,CAAC"}
|
package/dist/match.d.ts
CHANGED
|
@@ -1,8 +1,13 @@
|
|
|
1
1
|
import type { AnyComponent } from "@ivlev-dev/silent-core";
|
|
2
2
|
export type RouteParams = Readonly<Record<string, string>>;
|
|
3
|
-
export type
|
|
3
|
+
export type RouteQueryScalar = string | number | boolean;
|
|
4
|
+
export type RouteQueryValue = string | number | boolean | readonly (string | number | boolean)[];
|
|
4
5
|
export type RouteQuery = Readonly<Record<string, RouteQueryValue>>;
|
|
5
6
|
export type RouteMeta = Readonly<Record<string, unknown>>;
|
|
7
|
+
export type QueryParser<T = unknown> = "string" | "number" | "boolean" | "string[]" | "number[]" | "boolean[]" | ((raw: string | string[] | undefined) => T | undefined);
|
|
8
|
+
export type QuerySchema<Q> = {
|
|
9
|
+
readonly [K in keyof Q]: QueryParser<Q[K]>;
|
|
10
|
+
};
|
|
6
11
|
export type RouterErrorCode = "abort" | "guard" | "load" | "no-match" | "redirect" | "resolve";
|
|
7
12
|
export declare class RouterMissingError extends Error {
|
|
8
13
|
constructor(message?: string);
|
|
@@ -15,7 +20,7 @@ export declare class RouterNavigationError extends Error {
|
|
|
15
20
|
export declare class RouterAbortError extends RouterNavigationError {
|
|
16
21
|
constructor(to?: string, message?: string);
|
|
17
22
|
}
|
|
18
|
-
export type QueryInput = string | number | boolean | null | undefined | readonly (string | number)[];
|
|
23
|
+
export type QueryInput = string | number | boolean | null | undefined | readonly (string | number | boolean)[];
|
|
19
24
|
export interface RouteLocationTargetObject {
|
|
20
25
|
readonly path?: string;
|
|
21
26
|
readonly name?: string;
|
|
@@ -47,7 +52,7 @@ export type RouteLoaderResult = AnyComponent | {
|
|
|
47
52
|
readonly default: AnyComponent;
|
|
48
53
|
};
|
|
49
54
|
export type RouteLoader = (to: RouteLocation, signal: AbortSignal) => RouteLoaderResult | Promise<RouteLoaderResult>;
|
|
50
|
-
export interface RouteRecord {
|
|
55
|
+
export interface RouteRecord<Q = Readonly<Record<string, unknown>>> {
|
|
51
56
|
readonly path: string;
|
|
52
57
|
readonly name?: string;
|
|
53
58
|
readonly component?: AnyComponent;
|
|
@@ -56,6 +61,7 @@ export interface RouteRecord {
|
|
|
56
61
|
readonly beforeEnter?: RouteGuard;
|
|
57
62
|
readonly load?: RouteLoader;
|
|
58
63
|
readonly meta?: RouteMeta;
|
|
64
|
+
readonly query?: QuerySchema<Q>;
|
|
59
65
|
}
|
|
60
66
|
export interface ScrollPosition {
|
|
61
67
|
readonly left: number;
|
|
@@ -63,12 +69,26 @@ export interface ScrollPosition {
|
|
|
63
69
|
}
|
|
64
70
|
export type ScrollBehaviorResult = ScrollPosition | null | void | false;
|
|
65
71
|
export type ScrollBehavior = (to: RouteLocation, from: RouteLocation | null, savedPosition: ScrollPosition | null) => ScrollBehaviorResult | Promise<ScrollBehaviorResult>;
|
|
72
|
+
interface PatternLiteralPart {
|
|
73
|
+
readonly kind: "literal";
|
|
74
|
+
readonly value: string;
|
|
75
|
+
}
|
|
76
|
+
interface PatternParamPart {
|
|
77
|
+
readonly kind: "param";
|
|
78
|
+
readonly name: string;
|
|
79
|
+
}
|
|
80
|
+
type PatternPart = PatternLiteralPart | PatternParamPart;
|
|
66
81
|
type PatternSegment = {
|
|
67
82
|
readonly kind: "static";
|
|
68
83
|
readonly value: string;
|
|
69
84
|
} | {
|
|
70
85
|
readonly kind: "param";
|
|
71
86
|
readonly name: string;
|
|
87
|
+
} | {
|
|
88
|
+
readonly kind: "mixed";
|
|
89
|
+
readonly parts: readonly PatternPart[];
|
|
90
|
+
readonly names: readonly string[];
|
|
91
|
+
readonly regex: RegExp;
|
|
72
92
|
} | {
|
|
73
93
|
readonly kind: "wildcard";
|
|
74
94
|
readonly name: string;
|
package/dist/match.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"match.d.ts","sourceRoot":"","sources":["../src/match.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAE3D,MAAM,MAAM,WAAW,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAC3D,MAAM,MAAM,
|
|
1
|
+
{"version":3,"file":"match.d.ts","sourceRoot":"","sources":["../src/match.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAE3D,MAAM,MAAM,WAAW,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAC3D,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AACzD,MAAM,MAAM,eAAe,GACvB,MAAM,GACN,MAAM,GACN,OAAO,GACP,SAAS,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,EAAE,CAAC;AAC3C,MAAM,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC;AACnE,MAAM,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;AAE1D,MAAM,MAAM,WAAW,CAAC,CAAC,GAAG,OAAO,IAC/B,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,UAAU,GACV,UAAU,GACV,WAAW,GACX,CAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,KAAK,CAAC,GAAG,SAAS,CAAC,CAAC;AAE5D,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI;IAC3B,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC3C,CAAC;AACF,MAAM,MAAM,eAAe,GACvB,OAAO,GACP,OAAO,GACP,MAAM,GACN,UAAU,GACV,UAAU,GACV,SAAS,CAAC;AAEd,qBAAa,kBAAmB,SAAQ,KAAK;IAC3C,YAAY,OAAO,SAAqE,EAGvF;CACF;AAED,qBAAa,qBAAsB,SAAQ,KAAK;IAC9C,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAC;IAC/B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,YAAY,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,EAAE,SAAK,EAAE,KAAK,CAAC,EAAE,OAAO,EAK3E;CACF;AAED,qBAAa,gBAAiB,SAAQ,qBAAqB;IACzD,YAAY,EAAE,SAAK,EAAE,OAAO,SAAuB,EAGlD;CACF;AAED,MAAM,MAAM,UAAU,GAClB,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,SAAS,GACT,SAAS,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,EAAE,CAAC;AAE3C,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC;IAC5D,QAAQ,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC;IACtD,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,yBAAyB,CAAC;AAE7D,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;IAC7B,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,SAAS,YAAY,EAAE,CAAC;CAC3C;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;IAC7B,QAAQ,CAAC,SAAS,CAAC,EAAE,YAAY,CAAC;CACnC;AAED,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAAG,IAAI,GAAG,MAAM,GAAG,yBAAyB,CAAC;AAEnF,MAAM,MAAM,UAAU,GAAG,CACvB,EAAE,EAAE,aAAa,EACjB,IAAI,EAAE,aAAa,GAAG,IAAI,EAC1B,MAAM,EAAE,WAAW,KAChB,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;AAElD,MAAM,MAAM,aAAa,GACrB,MAAM,GACN,yBAAyB,GACzB,CAAC,CAAC,EAAE,EAAE,aAAa,KAAK,MAAM,GAAG,yBAAyB,CAAC,CAAC;AAEhE,MAAM,MAAM,iBAAiB,GAAG,YAAY,GAAG;IAAE,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAA;CAAE,CAAC;AAElF,MAAM,MAAM,WAAW,GAAG,CACxB,EAAE,EAAE,aAAa,EACjB,MAAM,EAAE,WAAW,KAChB,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;AAEpD,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,SAAS,CAAC,EAAE,YAAY,CAAC;IAClC,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,WAAW,EAAE,CAAC;IAC3C,QAAQ,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC;IAClC,QAAQ,CAAC,WAAW,CAAC,EAAE,UAAU,CAAC;IAClC,QAAQ,CAAC,IAAI,CAAC,EAAE,WAAW,CAAC;IAC5B,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC;IAC1B,QAAQ,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;CACjC;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,MAAM,oBAAoB,GAAG,cAAc,GAAG,IAAI,GAAG,IAAI,GAAG,KAAK,CAAC;AAExE,MAAM,MAAM,cAAc,GAAG,CAC3B,EAAE,EAAE,aAAa,EACjB,IAAI,EAAE,aAAa,GAAG,IAAI,EAC1B,aAAa,EAAE,cAAc,GAAG,IAAI,KACjC,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAE1D,UAAU,kBAAkB;IAC1B,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED,UAAU,gBAAgB;IACxB,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,KAAK,WAAW,GAAG,kBAAkB,GAAG,gBAAgB,CAAC;AAEzD,KAAK,cAAc,GACf;IAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GACnD;IAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GACjD;IACA,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,KAAK,EAAE,SAAS,WAAW,EAAE,CAAC;IACvC,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB,GACC;IAAE,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAEzD,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;IAC7B,QAAQ,CAAC,KAAK,EAAE,SAAS,WAAW,EAAE,CAAC;IACvC,QAAQ,CAAC,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC;IACvC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,QAAQ,EAAE,SAAS,cAAc,EAAE,CAAC;IAC7C,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAKD,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAKlD;AAED,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAalD;AAgJD,wBAAgB,aAAa,CAC3B,MAAM,EAAE,SAAS,WAAW,EAAE,EAC9B,UAAU,SAAM,EAChB,WAAW,GAAE,SAAS,WAAW,EAAO,EACxC,WAAW,GAAE,SAAS,MAAM,EAAO,GAClC,aAAa,EAAE,CAyBjB;AAwED,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;CAC9B;AAED,wBAAgB,WAAW,CACzB,QAAQ,EAAE,SAAS,aAAa,EAAE,EAClC,QAAQ,EAAE,MAAM,GACf,UAAU,GAAG,IAAI,CASnB;AAED,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,CAsBrD;AAMD,wBAAgB,UAAU,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAgBpD;AAmOD,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,SAAS,aAAa,EAAE,EAClC,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,UAAU,CAAC,EAAE,WAAW,CAAC,WAAW,EAAE,YAAY,CAAC,GAClD,aAAa,CA+Bf;AAyFD,wBAAgB,eAAe,CAC7B,QAAQ,EAAE,SAAS,aAAa,EAAE,EAClC,MAAM,EAAE,WAAW,EACnB,OAAO,GAAE,aAAa,GAAG,IAAW,EACpC,UAAU,CAAC,EAAE,WAAW,CAAC,WAAW,EAAE,YAAY,CAAC,GAClD,aAAa,CA0Bf;AAED,wBAAgB,YAAY,CAC1B,WAAW,EAAE,MAAM,EACnB,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,OAAO,GACb,OAAO,CAWT;AAED,eAAO,MAAM,yBAAyB,KAAqB,CAAC"}
|