setti 0.0.0-stage → 0.1.0-alpha.0
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/LICENSE +21 -0
- package/README.md +1406 -2
- package/bin/nixo.mjs +8 -0
- package/dist/cli.d.ts +1 -0
- package/dist/cli.js +3060 -0
- package/dist/client/index.d.ts +180 -0
- package/dist/client/index.js +958 -0
- package/dist/index.d.ts +5 -0
- package/dist/index.js +816 -0
- package/dist/not-found-fz-2RDV6.d.ts +340 -0
- package/dist/prefetch-Bp9dMSTK.d.ts +766 -0
- package/dist/server.d.ts +635 -0
- package/dist/server.js +2813 -0
- package/package.json +85 -3
|
@@ -0,0 +1,766 @@
|
|
|
1
|
+
import { FastifyServerOptions } from 'fastify';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Базовый реактивный store слайса.
|
|
5
|
+
*
|
|
6
|
+
* TState — тип состояния слайса.
|
|
7
|
+
*
|
|
8
|
+
* Жизненный цикл:
|
|
9
|
+
* 1. Создаётся (например, Loader'ом) — `_state === undefined`.
|
|
10
|
+
* 2. `hydrate(result)` — единожды, `_state = _initState(result)`.
|
|
11
|
+
* 3. Подписчики через `subscribe`, чтение через `getState`.
|
|
12
|
+
* 4. `setState` — обновление + notify.
|
|
13
|
+
* 5. `reset` — возврат к `_initialState`.
|
|
14
|
+
* 6. `dispose` — очистка подписчиков (при навигации).
|
|
15
|
+
*/
|
|
16
|
+
/** Слушатель изменений. */
|
|
17
|
+
type SliceListener = () => void;
|
|
18
|
+
/** Функциональный апдейтер — как в React setState. */
|
|
19
|
+
type SliceUpdater<TState> = (prev: TState) => TState;
|
|
20
|
+
declare abstract class AbstractSlice<TState> {
|
|
21
|
+
/** Текущее состояние. `undefined` до первого hydrate/setState. */
|
|
22
|
+
protected _state: TState | undefined;
|
|
23
|
+
/** База для reset(): первое значение hydrate/setState. */
|
|
24
|
+
protected _initialState: TState | undefined;
|
|
25
|
+
/** Флаг: hydrate уже вызывался. */
|
|
26
|
+
protected _hydrated: boolean;
|
|
27
|
+
/** Подписчики. */
|
|
28
|
+
protected listeners: Set<SliceListener>;
|
|
29
|
+
/**
|
|
30
|
+
* Преобразование результата `loadData` в state.
|
|
31
|
+
*
|
|
32
|
+
* Абстрактный — наследник решает, что достать из result. В `Slice` —
|
|
33
|
+
* identity. Прикладной слайс может обогатить state (computed, методы).
|
|
34
|
+
*
|
|
35
|
+
* @param result результат `loadData`.
|
|
36
|
+
* @returns состояние слайса.
|
|
37
|
+
*/
|
|
38
|
+
protected abstract _initState(result: unknown): TState;
|
|
39
|
+
/**
|
|
40
|
+
* Инициализация state результатом `loadData`.
|
|
41
|
+
*
|
|
42
|
+
* Вызывается Loader'ом один раз на экземпляр. Повторный вызов — ошибка.
|
|
43
|
+
*
|
|
44
|
+
* @param result результат `loadData`.
|
|
45
|
+
* @throws {Error} если hydrate уже вызывался.
|
|
46
|
+
*/
|
|
47
|
+
hydrate(result: unknown): void;
|
|
48
|
+
/**
|
|
49
|
+
* Текущее состояние.
|
|
50
|
+
*
|
|
51
|
+
* @returns состояние слайса.
|
|
52
|
+
*/
|
|
53
|
+
getState(): TState;
|
|
54
|
+
/**
|
|
55
|
+
* Snapshot для SSR/гидратации (=== getState).
|
|
56
|
+
*
|
|
57
|
+
* @returns состояние слайса.
|
|
58
|
+
*/
|
|
59
|
+
getServerSnapshot(): TState;
|
|
60
|
+
/**
|
|
61
|
+
* Обновляет state и уведомляет подписчиков.
|
|
62
|
+
*
|
|
63
|
+
* Если `value === prev` (Object.is) — нотификации нет.
|
|
64
|
+
*
|
|
65
|
+
* @param next новое значение или функция-апдейтер.
|
|
66
|
+
*/
|
|
67
|
+
setState(next: TState | SliceUpdater<TState>): void;
|
|
68
|
+
/**
|
|
69
|
+
* Подписка на изменения.
|
|
70
|
+
*
|
|
71
|
+
* @param listener колбэк.
|
|
72
|
+
* @returns функция отписки.
|
|
73
|
+
*/
|
|
74
|
+
subscribe(listener: SliceListener): () => void;
|
|
75
|
+
/** Сброс к состоянию первого hydrate/setState. */
|
|
76
|
+
reset(): void;
|
|
77
|
+
/** Уничтожение: очистка подписчиков. */
|
|
78
|
+
dispose(): void;
|
|
79
|
+
/** Оповещает подписчиков. */
|
|
80
|
+
protected notify(): void;
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
/**
|
|
84
|
+
* Конкретная реализация `AbstractSlice`.
|
|
85
|
+
*
|
|
86
|
+
* Отличается только `_initState` — identity (result как есть). Прикладной
|
|
87
|
+
* слайс наследуется от `Slice<TState>` и переопределяет `_initState`, если
|
|
88
|
+
* нужно обогатить state.
|
|
89
|
+
*
|
|
90
|
+
* @example
|
|
91
|
+
* ```ts
|
|
92
|
+
* class UserListSlice extends Slice<UserPublic[]> {
|
|
93
|
+
* setUsers(users: UserPublic[]) {
|
|
94
|
+
* this.setState(users)
|
|
95
|
+
* }
|
|
96
|
+
* }
|
|
97
|
+
* ```
|
|
98
|
+
*/
|
|
99
|
+
declare class Slice<TState = unknown> extends AbstractSlice<TState> {
|
|
100
|
+
/**
|
|
101
|
+
* Identity: state = result как есть.
|
|
102
|
+
*
|
|
103
|
+
* @param result результат `loadData`.
|
|
104
|
+
* @returns тот же результат.
|
|
105
|
+
*/
|
|
106
|
+
protected _initState(result: unknown): TState;
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
/** HTTP-метод API-роута. */
|
|
110
|
+
type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS';
|
|
111
|
+
/**
|
|
112
|
+
* Объявление middleware.
|
|
113
|
+
*
|
|
114
|
+
* Используется в `NixoRoute.middleware` (страницы), `ServerRoute.middleware`
|
|
115
|
+
* (API) и глобально в `NixoConfig.middleware`.
|
|
116
|
+
*/
|
|
117
|
+
interface MiddlewareDef {
|
|
118
|
+
/** Уникальный ключ (отладка, порядок, логи). */
|
|
119
|
+
id: string;
|
|
120
|
+
/** Путь до async-функции от `projectDir`. */
|
|
121
|
+
handler: string;
|
|
122
|
+
/** Первый аргумент handler'а. */
|
|
123
|
+
params?: Record<string, unknown>;
|
|
124
|
+
/** Только для глобальных в `nixo.config.ts`. */
|
|
125
|
+
side?: 'client' | 'server' | 'both';
|
|
126
|
+
}
|
|
127
|
+
/** API-роут (Phase 2.1). */
|
|
128
|
+
interface ServerRoute {
|
|
129
|
+
/** HTTP-метод. */
|
|
130
|
+
method: HttpMethod;
|
|
131
|
+
/** URL-путь (Fastify `url`). */
|
|
132
|
+
path: string;
|
|
133
|
+
/** Путь до async-функции-handler'а. */
|
|
134
|
+
handler: string;
|
|
135
|
+
/** Статические параметры (первый аргумент handler'а). */
|
|
136
|
+
params?: Record<string, unknown>;
|
|
137
|
+
/** API-middleware-цепочка. */
|
|
138
|
+
middleware?: MiddlewareDef[];
|
|
139
|
+
}
|
|
140
|
+
/** Fastify-плагин из `server/plugins/`. */
|
|
141
|
+
interface ServerPluginDef {
|
|
142
|
+
/** Имя (из имени файла). */
|
|
143
|
+
name: string;
|
|
144
|
+
/** Абсолютный путь. */
|
|
145
|
+
path: string;
|
|
146
|
+
}
|
|
147
|
+
/** Опции `defineServerPlugins`. */
|
|
148
|
+
interface ServerPluginsOptions {
|
|
149
|
+
/** Явный порядок регистрации (по именам). Остальные — в конце, алфавитно. */
|
|
150
|
+
order?: string[];
|
|
151
|
+
}
|
|
152
|
+
/**
|
|
153
|
+
* Публичные типы nixo.
|
|
154
|
+
*
|
|
155
|
+
* Здесь собраны контракты конфигурации, маршрутов, фабрик, манифеста
|
|
156
|
+
* и других сущностей, которые используются сканнером и runtime-ом.
|
|
157
|
+
*/
|
|
158
|
+
/**
|
|
159
|
+
* Конфигурация фреймворка, задаваемая в `nixo.config.ts`
|
|
160
|
+
* через `defineNixoConfig`.
|
|
161
|
+
*/
|
|
162
|
+
interface NixoConfig {
|
|
163
|
+
/** Включён ли SSR. Если `false` — приложение работает как SPA. */
|
|
164
|
+
ssr?: boolean;
|
|
165
|
+
/** Каталог клиентского кода. По умолчанию `client`. */
|
|
166
|
+
clientDir?: string;
|
|
167
|
+
/** Каталог серверного кода. По умолчанию `server`. */
|
|
168
|
+
serverDir?: string;
|
|
169
|
+
/**
|
|
170
|
+
* Реестр layout'ов. Ключ — идентификатор, используемый в `route.type`.
|
|
171
|
+
* Значение — путь до компонента layout'а относительно `clientDir`.
|
|
172
|
+
*/
|
|
173
|
+
layouts?: Record<string, string>;
|
|
174
|
+
/** Настройки HTTP-сервера (Fastify). */
|
|
175
|
+
server?: {
|
|
176
|
+
port?: number;
|
|
177
|
+
host?: string;
|
|
178
|
+
/** Путь до файла с `defineServerRoutes([...])`. */
|
|
179
|
+
routes?: string;
|
|
180
|
+
/** Путь до каталога с Fastify-плагинами. */
|
|
181
|
+
plugins?: string;
|
|
182
|
+
};
|
|
183
|
+
/** Мерж в пользовательскую Vite-конфигурацию (для Phase 1b). */
|
|
184
|
+
vite?: Record<string, unknown>;
|
|
185
|
+
/** Настройки сборки. */
|
|
186
|
+
build?: {
|
|
187
|
+
outDir?: string;
|
|
188
|
+
};
|
|
189
|
+
/** Публичные и приватные переменные окружения (Phase 2). */
|
|
190
|
+
runtimeConfig?: {
|
|
191
|
+
public?: Record<string, unknown>;
|
|
192
|
+
};
|
|
193
|
+
css?: {
|
|
194
|
+
/**
|
|
195
|
+
* Путь до основного CSS-файла относительно `clientDir`.
|
|
196
|
+
* Обычно содержит Tailwind-директивы и глобальные стили.
|
|
197
|
+
*/
|
|
198
|
+
main?: string;
|
|
199
|
+
};
|
|
200
|
+
/** Глобальные middleware (client / server / both). */
|
|
201
|
+
middleware?: MiddlewareDef[];
|
|
202
|
+
/**
|
|
203
|
+
* Прямой проброс в `Fastify(opts)`.
|
|
204
|
+
*
|
|
205
|
+
* Примеры:
|
|
206
|
+
* - `logger: false` — отключить Fastify-логи;
|
|
207
|
+
* - `trustProxy: true` — за прокси;
|
|
208
|
+
* - `bodyLimit: 1048576` — размер тела запроса;
|
|
209
|
+
* - `disableRequestLogging: true` — тише.
|
|
210
|
+
*
|
|
211
|
+
* Дефолт: `{ logger: { level: 'info' } }`.
|
|
212
|
+
*/
|
|
213
|
+
fastify?: FastifyServerOptions;
|
|
214
|
+
/** Настройки JSON-RPC 2.0. `false` — отключить. */
|
|
215
|
+
rpc?: false | RpcOptions;
|
|
216
|
+
/**
|
|
217
|
+
* Компоненты-обёртки. Пути от `clientDir` в формате `<file>:<export>`
|
|
218
|
+
* (или `<file>` для default).
|
|
219
|
+
*/
|
|
220
|
+
components?: {
|
|
221
|
+
/** Fallback для ErrorBoundary. */
|
|
222
|
+
error?: string;
|
|
223
|
+
/** Показывается во время первого SPA-prefetch (`?noSSR` / `ssr: false`). */
|
|
224
|
+
loading?: string;
|
|
225
|
+
/** Рендерится при 404 (SSR). */
|
|
226
|
+
notFound?: string;
|
|
227
|
+
};
|
|
228
|
+
}
|
|
229
|
+
/**
|
|
230
|
+
* Роутер-контекст для клиента (state в `NixoProvider`).
|
|
231
|
+
*
|
|
232
|
+
* Используется хуками `useRouter`, `useParams`, `useQuery`, `usePathname`.
|
|
233
|
+
*/
|
|
234
|
+
interface NixoClientRouter {
|
|
235
|
+
/** Текущий путь. */
|
|
236
|
+
path: string;
|
|
237
|
+
/** Динамические сегменты (Phase 2.5, сейчас пусто). */
|
|
238
|
+
params: Record<string, string>;
|
|
239
|
+
/** Query-параметры. */
|
|
240
|
+
query: Record<string, string>;
|
|
241
|
+
/** id текущего маршрута. */
|
|
242
|
+
routeId: string;
|
|
243
|
+
}
|
|
244
|
+
/**
|
|
245
|
+
* Конфиг после нормализации: все обязательные поля заполнены дефолтами.
|
|
246
|
+
*
|
|
247
|
+
* Используется внутри фреймворка (сканер, дерево маршрутов, манифест,
|
|
248
|
+
* серверный рантайм) — там, где хочется видеть конкретные значения,
|
|
249
|
+
* а не `undefined`.
|
|
250
|
+
*/
|
|
251
|
+
interface ResolvedNixoConfig {
|
|
252
|
+
ssr: boolean;
|
|
253
|
+
clientDir: string;
|
|
254
|
+
serverDir: string;
|
|
255
|
+
layouts: Record<string, string>;
|
|
256
|
+
middleware: MiddlewareDef[];
|
|
257
|
+
server: {
|
|
258
|
+
port: number;
|
|
259
|
+
host: string;
|
|
260
|
+
routes: string | null;
|
|
261
|
+
plugins: string | null;
|
|
262
|
+
};
|
|
263
|
+
vite: Record<string, unknown>;
|
|
264
|
+
build: {
|
|
265
|
+
outDir: string;
|
|
266
|
+
};
|
|
267
|
+
css: {
|
|
268
|
+
main: string;
|
|
269
|
+
};
|
|
270
|
+
runtimeConfig: {
|
|
271
|
+
public: Record<string, unknown>;
|
|
272
|
+
};
|
|
273
|
+
fastify?: FastifyServerOptions;
|
|
274
|
+
rpc: ResolvedRpcOptions;
|
|
275
|
+
components: {
|
|
276
|
+
error: string | null;
|
|
277
|
+
loading: string | null;
|
|
278
|
+
notFound: string | null;
|
|
279
|
+
};
|
|
280
|
+
}
|
|
281
|
+
/**
|
|
282
|
+
* Конфигурация фабрики данных.
|
|
283
|
+
*
|
|
284
|
+
* Возвращается из `getConfig` (см. `configLoader`) и из `defineGlobalLoader`.
|
|
285
|
+
*/
|
|
286
|
+
interface FactoryDef {
|
|
287
|
+
/** Путь до модуля-фабрики (`<file>:<export>` или `<file>` для default). */
|
|
288
|
+
dataFactoryName: string;
|
|
289
|
+
/** Статические аргументы, передаваемые в `loadData`. */
|
|
290
|
+
dataFactoryArguments?: Record<string, unknown>;
|
|
291
|
+
/**
|
|
292
|
+
* Зависимости: имена других фабрик текущей страницы
|
|
293
|
+
* или глобальных loaders. Коллизии запрещены (A3).
|
|
294
|
+
*/
|
|
295
|
+
dependencies?: string[];
|
|
296
|
+
/** Fastify-опции (пробрасываются как есть). */
|
|
297
|
+
fastify?: FastifyServerOptions;
|
|
298
|
+
}
|
|
299
|
+
/**
|
|
300
|
+
* Карта фабрик: имя → описание.
|
|
301
|
+
*
|
|
302
|
+
* Используется как возвращаемое значение `getConfig` и как содержимое
|
|
303
|
+
* `defineGlobalLoader`.
|
|
304
|
+
*/
|
|
305
|
+
type FactoryMap = Record<string, FactoryDef>;
|
|
306
|
+
/**
|
|
307
|
+
* Реализация фабрики (то, что экспортируется по `dataFactoryName`).
|
|
308
|
+
*
|
|
309
|
+
* Имя слайса в реестре = ключ фабрики в `getConfig` / `defineGlobalLoader`.
|
|
310
|
+
* Поле `slice` — конструктор класса, наследника `Slice<TState>`.
|
|
311
|
+
*/
|
|
312
|
+
interface FactoryImplementation<TState = unknown> {
|
|
313
|
+
/**
|
|
314
|
+
* Загружает данные фабрики.
|
|
315
|
+
*
|
|
316
|
+
* @param args смерженные аргументы.
|
|
317
|
+
* @param deps уже загруженные зависимости.
|
|
318
|
+
* @param ctx контекст (`router`, служебные поля).
|
|
319
|
+
* @returns объект, который попадёт в `slice` через `hydrate`.
|
|
320
|
+
*/
|
|
321
|
+
loadData: (args: Record<string, unknown>, deps: Record<string, unknown>, ctx: Record<string, unknown>) => Promise<unknown>;
|
|
322
|
+
/** Класс слайса. */
|
|
323
|
+
slice: new () => Slice<TState>;
|
|
324
|
+
/** Динамическое обогащение `args` (мержится поверх `dataFactoryArguments`). */
|
|
325
|
+
getDataFactoryArguments?: () => Promise<Record<string, unknown>>;
|
|
326
|
+
}
|
|
327
|
+
/**
|
|
328
|
+
* Один маршрут, возвращаемый из `router.ts` через `defineRoute([...])`.
|
|
329
|
+
*/
|
|
330
|
+
interface NixoRoute {
|
|
331
|
+
/** URL-сегмент и глобальный уникальный идентификатор. */
|
|
332
|
+
id: string;
|
|
333
|
+
/** Идентификатор родителя (для иерархии URL). */
|
|
334
|
+
parentId?: string;
|
|
335
|
+
/** Заголовок страницы. */
|
|
336
|
+
title: string;
|
|
337
|
+
/** Необязательное описание. */
|
|
338
|
+
description?: string;
|
|
339
|
+
/** Ключ layout'а из `config.layouts`. */
|
|
340
|
+
type: string;
|
|
341
|
+
/**
|
|
342
|
+
* Если `true` — собственный `id` не попадает в URL.
|
|
343
|
+
* Глобально допустим только один такой маршрут.
|
|
344
|
+
*/
|
|
345
|
+
index?: boolean;
|
|
346
|
+
/** Конфигурация контента: шаблон и prefetch-пайплайн. */
|
|
347
|
+
contentConfig: {
|
|
348
|
+
workspaceConfig: {
|
|
349
|
+
/** Путь до компонента (`<file>:<export>` или `<file>`). */
|
|
350
|
+
template: string;
|
|
351
|
+
/** Статические props, передаваемые в компонент. */
|
|
352
|
+
templateProps?: Record<string, unknown>;
|
|
353
|
+
};
|
|
354
|
+
prefetchConfig: {
|
|
355
|
+
/** Путь до модуля с `export default function getConfig(configParams, router)`. */
|
|
356
|
+
configLoader: string;
|
|
357
|
+
/** Аргументы, передаваемые в `getConfig`. */
|
|
358
|
+
configParams?: Record<string, unknown>;
|
|
359
|
+
/** Имена глобальных loaders, от которых зависит страница. */
|
|
360
|
+
dependencies?: string[];
|
|
361
|
+
};
|
|
362
|
+
};
|
|
363
|
+
/** Свободные пользовательские данные (расширяемость). */
|
|
364
|
+
meta?: Record<string, unknown>;
|
|
365
|
+
/**
|
|
366
|
+
* Middleware для страницы. Client — `client/middleware/*.ts`,
|
|
367
|
+
* server — `server/middleware/*.ts`. Наследуется по `parentId`.
|
|
368
|
+
*/
|
|
369
|
+
middleware?: MiddlewareDef[];
|
|
370
|
+
/**
|
|
371
|
+
* URL-паттерн. Если задан — используется как есть (абсолютный, `/...`),
|
|
372
|
+
* игнорируя цепочку `parentId → id`. `:param` — динамические сегменты.
|
|
373
|
+
*/
|
|
374
|
+
path?: string;
|
|
375
|
+
/**
|
|
376
|
+
* Сегменты, добавляемые к цепочке `parentId → id`. Взаимоисключающий с `path`.
|
|
377
|
+
*
|
|
378
|
+
* - `':param'` — именованный параметр, `params.param = value`.
|
|
379
|
+
* - `'/regex:body'` — regex (nixo сам оборачивает в `^(body)$`,
|
|
380
|
+
* захватывающая группа получает имя `slug` или `slug1`, `slug2`...).
|
|
381
|
+
* - `'literal'` — статический сегмент, без параметров.
|
|
382
|
+
*/
|
|
383
|
+
slug?: string[];
|
|
384
|
+
/**
|
|
385
|
+
* Переопределяет `config.ssr` для этого маршрута.
|
|
386
|
+
*
|
|
387
|
+
* - `false` — SPA: без SSR-рендера, без server middleware, без prefetch
|
|
388
|
+
* на сервере. Клиент сам делает `clientPrefetch` + `createRoot`.
|
|
389
|
+
* - `undefined` / `true` — наследует `config.ssr`.
|
|
390
|
+
*
|
|
391
|
+
* `index: true` + `ssr: false` — ошибка (индексная страница должна быть SSR).
|
|
392
|
+
* При `config.ssr: false` игнорируется (весь проект — SPA).
|
|
393
|
+
*/
|
|
394
|
+
ssr?: boolean;
|
|
395
|
+
}
|
|
396
|
+
/**
|
|
397
|
+
* Объект `router`, передаваемый в `getConfig` и `loadData` через `ctx`.
|
|
398
|
+
*/
|
|
399
|
+
interface NixoRouter {
|
|
400
|
+
/** Идентификатор текущего маршрута. */
|
|
401
|
+
id: string;
|
|
402
|
+
/** Полный URL-путь. */
|
|
403
|
+
path: string;
|
|
404
|
+
/** Динамические сегменты URL (Phase 3). */
|
|
405
|
+
params: Record<string, string>;
|
|
406
|
+
/** Query-параметры. */
|
|
407
|
+
query: Record<string, string>;
|
|
408
|
+
/** Сырой request (FastifyRequest на сервере, обёртка на клиенте). */
|
|
409
|
+
request: unknown;
|
|
410
|
+
}
|
|
411
|
+
/**
|
|
412
|
+
* Построенное дерево маршрутов: карта `id → путь` и индексный маршрут.
|
|
413
|
+
*/
|
|
414
|
+
interface RouteTree {
|
|
415
|
+
/** Все маршруты по `id`. */
|
|
416
|
+
byId: Map<string, NixoRoute>;
|
|
417
|
+
/** URL-путь для каждого `id`. */
|
|
418
|
+
paths: Map<string, string>;
|
|
419
|
+
/** `id` индексного маршрута (единственного глобально), если он есть. */
|
|
420
|
+
indexRouteId: string | null;
|
|
421
|
+
/** Скомпилированные паттерны (для `matchRoute`). */
|
|
422
|
+
compiled: CompiledRoute[];
|
|
423
|
+
/** Цепочка layouts (type'ы от root к leaf) для каждого маршрута. */
|
|
424
|
+
layoutChains: Map<string, string[]>;
|
|
425
|
+
}
|
|
426
|
+
/** Скомпилированный паттерн маршрута. */
|
|
427
|
+
interface CompiledRoute {
|
|
428
|
+
/** id маршрута. */
|
|
429
|
+
id: string;
|
|
430
|
+
/** Оригинальный паттерн (`/blog/:slug`). */
|
|
431
|
+
path: string;
|
|
432
|
+
/** Источник regex без флагов (`^/blog/([^/]+)$`). */
|
|
433
|
+
regexSource: string;
|
|
434
|
+
/** Имена параметров в порядке появления. */
|
|
435
|
+
paramNames: string[];
|
|
436
|
+
}
|
|
437
|
+
/**
|
|
438
|
+
* Вид модуля в манифесте — определяет, как его резолвить и подключать.
|
|
439
|
+
*/
|
|
440
|
+
type ModuleKind = 'component' | 'routes' | 'config' | 'factory' | 'layout' | 'globalLoader';
|
|
441
|
+
/**
|
|
442
|
+
* Запись манифеста для одного модуля.
|
|
443
|
+
*/
|
|
444
|
+
interface ManifestEntry {
|
|
445
|
+
/** Вид модуля. */
|
|
446
|
+
kind: ModuleKind;
|
|
447
|
+
/** Путь до JS/TS-модуля (для загрузки). */
|
|
448
|
+
js: string;
|
|
449
|
+
/** CSS-файлы, ассоциированные с модулем (Phase 1b). */
|
|
450
|
+
css?: string[];
|
|
451
|
+
}
|
|
452
|
+
/**
|
|
453
|
+
* Манифест всех модулей, сгенерированный на этапе сканирования.
|
|
454
|
+
*/
|
|
455
|
+
interface Manifest {
|
|
456
|
+
/** Версия манифеста (хеш от содержимого). */
|
|
457
|
+
version: string;
|
|
458
|
+
/** Записи модулей по их именам. */
|
|
459
|
+
modules: Record<string, ManifestEntry>;
|
|
460
|
+
}
|
|
461
|
+
/**
|
|
462
|
+
* Результат сканирования клиентского каталога.
|
|
463
|
+
*/
|
|
464
|
+
interface ScanResult {
|
|
465
|
+
/** Найденные модули `router.ts` и их содержимое (вызовы `defineRoute`). */
|
|
466
|
+
routeModules: Array<{
|
|
467
|
+
file: string;
|
|
468
|
+
routes: NixoRoute[];
|
|
469
|
+
}>;
|
|
470
|
+
/** Найденные `*.loader.ts` и их карты глобальных загрузчиков. */
|
|
471
|
+
loaderModules: Array<{
|
|
472
|
+
file: string;
|
|
473
|
+
map: FactoryMap;
|
|
474
|
+
}>;
|
|
475
|
+
}
|
|
476
|
+
/** Ошибка валидации Standard Schema. */
|
|
477
|
+
interface StandardSchemaV1Issue {
|
|
478
|
+
readonly message: string;
|
|
479
|
+
readonly path?: ReadonlyArray<PropertyKey | {
|
|
480
|
+
readonly key: PropertyKey;
|
|
481
|
+
}>;
|
|
482
|
+
}
|
|
483
|
+
/** Успешный результат валидации. */
|
|
484
|
+
interface StandardSchemaV1Success<Output> {
|
|
485
|
+
readonly value: Output;
|
|
486
|
+
readonly issues?: undefined;
|
|
487
|
+
}
|
|
488
|
+
/** Неуспешный результат валидации. */
|
|
489
|
+
interface StandardSchemaV1Failure {
|
|
490
|
+
readonly issues: ReadonlyArray<StandardSchemaV1Issue>;
|
|
491
|
+
}
|
|
492
|
+
/** Результат валидации. */
|
|
493
|
+
type StandardSchemaV1Result<Output> = StandardSchemaV1Success<Output> | StandardSchemaV1Failure;
|
|
494
|
+
/**
|
|
495
|
+
* Standard Schema интерфейс (valibot, zod, arktype, effect-schema).
|
|
496
|
+
*
|
|
497
|
+
* Nixo не зависит от конкретной библиотеки валидации — принимает любую,
|
|
498
|
+
* реализующую `~standard`. Стандарт: https://standardschema.dev
|
|
499
|
+
*/
|
|
500
|
+
interface StandardSchemaV1<Input = unknown, Output = Input> {
|
|
501
|
+
readonly '~standard': {
|
|
502
|
+
readonly version: 1;
|
|
503
|
+
readonly vendor: string;
|
|
504
|
+
readonly validate: (value: unknown) => StandardSchemaV1Result<Output> | Promise<StandardSchemaV1Result<Output>>;
|
|
505
|
+
};
|
|
506
|
+
/** Фантомные поля для вывода типа (не используются в рантайме). */
|
|
507
|
+
readonly '~nixo-input'?: Input;
|
|
508
|
+
readonly '~nixo-output'?: Output;
|
|
509
|
+
}
|
|
510
|
+
/** Схема параметров RPC-метода. */
|
|
511
|
+
type RpcParamsSchema<P> = StandardSchemaV1<unknown, P>;
|
|
512
|
+
/** Требование авторизации для метода. */
|
|
513
|
+
type AuthRequirement = false | undefined | true | {
|
|
514
|
+
/** Требуется одна из ролей (массив = OR). */
|
|
515
|
+
roles: string[];
|
|
516
|
+
};
|
|
517
|
+
/**
|
|
518
|
+
* Описание одного RPC-метода.
|
|
519
|
+
*
|
|
520
|
+
* @template P тип параметров (после валидации).
|
|
521
|
+
* @template R тип результата.
|
|
522
|
+
*/
|
|
523
|
+
interface RpcMethodDefinition<P = unknown, R = unknown> {
|
|
524
|
+
/** Комментарий для админки. */
|
|
525
|
+
description?: string;
|
|
526
|
+
/** Схема параметров (Standard Schema). */
|
|
527
|
+
params?: RpcParamsSchema<P>;
|
|
528
|
+
/** `false`/`undefined` — публичный; `true` — нужен пользователь; `{ roles }` — роли. */
|
|
529
|
+
auth?: AuthRequirement;
|
|
530
|
+
/**
|
|
531
|
+
* Обработчик бизнес-логики.
|
|
532
|
+
*
|
|
533
|
+
* @param params валидированные параметры.
|
|
534
|
+
* @param ctx контекст (requestId, call, расширения из `config.rpc.extendContext`).
|
|
535
|
+
* @returns результат (сериализуется как `result` в JSON-RPC).
|
|
536
|
+
*/
|
|
537
|
+
handler: (params: P, ctx: RpcContext) => R | Promise<R>;
|
|
538
|
+
/** Произвольные метаданные (UI, аудит); не участвуют в обработке. */
|
|
539
|
+
meta?: Record<string, unknown>;
|
|
540
|
+
/**
|
|
541
|
+
* Внутренний метод: доступен только через `ctx.call`.
|
|
542
|
+
* Снаружи (HTTP → `/service`) вернёт `-32601 Method not found`.
|
|
543
|
+
*/
|
|
544
|
+
internal?: boolean;
|
|
545
|
+
}
|
|
546
|
+
/**
|
|
547
|
+
* Описание объекта бизнес-логики (Users, Staff, Employees...).
|
|
548
|
+
*
|
|
549
|
+
* Имя уникально; методы объекта задаются в `methods`.
|
|
550
|
+
* Полное имя метода: `${name}.${methodKey}`, например `Users.List`.
|
|
551
|
+
*/
|
|
552
|
+
interface RpcObjectDefinition {
|
|
553
|
+
/** Имя объекта: `[A-Za-z][A-Za-z0-9_]*`. */
|
|
554
|
+
name: string;
|
|
555
|
+
/** Комментарий для админки. */
|
|
556
|
+
description?: string;
|
|
557
|
+
/** Методы объекта (ключи — `List`, `Read`, `Create`, ...). */
|
|
558
|
+
methods: Record<string, RpcMethodDefinition<unknown, unknown>>;
|
|
559
|
+
/** Произвольные метаданные. */
|
|
560
|
+
meta?: Record<string, unknown>;
|
|
561
|
+
}
|
|
562
|
+
/**
|
|
563
|
+
* Контекст, передаваемый в `RpcMethodDefinition.handler`.
|
|
564
|
+
*
|
|
565
|
+
* Расширяется прикладником через `config.rpc.extendContext` +
|
|
566
|
+
* module augmentation (`declare module 'nixo/server' { interface RpcContext {...} }`).
|
|
567
|
+
*/
|
|
568
|
+
interface RpcContext {
|
|
569
|
+
/** ID запроса (из `X-Request-Id` или сгенерирован nixo). */
|
|
570
|
+
requestId: string;
|
|
571
|
+
/**
|
|
572
|
+
* JSON-RPC вызов через `Service` (изоморфный).
|
|
573
|
+
*
|
|
574
|
+
* На сервере — прямой вызов из реестра объектов (без HTTP).
|
|
575
|
+
* На клиенте — `fetch('/service')`.
|
|
576
|
+
* Для `internal: true` — единственный способ вызвать.
|
|
577
|
+
*/
|
|
578
|
+
call: <R = unknown>(method: string, params?: unknown) => Promise<R>;
|
|
579
|
+
/** Расширения из `config.rpc.extendContext`. */
|
|
580
|
+
[key: string]: unknown;
|
|
581
|
+
}
|
|
582
|
+
/** Опции RPC-слоя. */
|
|
583
|
+
interface RpcOptions {
|
|
584
|
+
/** Включён ли RPC. По умолчанию `true`. */
|
|
585
|
+
enabled?: boolean;
|
|
586
|
+
/** URL endpoint. По умолчанию `/service`. */
|
|
587
|
+
url?: string;
|
|
588
|
+
/** Включить `System.Describe` (по умолчанию `true`). */
|
|
589
|
+
describe?: boolean;
|
|
590
|
+
/**
|
|
591
|
+
* Расширение контекста. Вызывается на каждый `/service` запрос и на каждый
|
|
592
|
+
* `ctx.call` при SSR (чтобы контекст был изолирован).
|
|
593
|
+
*
|
|
594
|
+
* @param req Fastify-запрос (только на сервере).
|
|
595
|
+
* @returns объект для мержа в `RpcContext`.
|
|
596
|
+
*/
|
|
597
|
+
extendContext?: (req: unknown) => Promise<Record<string, unknown>> | Record<string, unknown>;
|
|
598
|
+
}
|
|
599
|
+
/** Резолвнутые опции RPC. */
|
|
600
|
+
interface ResolvedRpcOptions {
|
|
601
|
+
enabled: boolean;
|
|
602
|
+
url: string;
|
|
603
|
+
describe: boolean;
|
|
604
|
+
extendContext?: (req: unknown) => Promise<Record<string, unknown>> | Record<string, unknown>;
|
|
605
|
+
}
|
|
606
|
+
/** Изоморфный исполнитель JSON-RPC (регистрируется сервером в ALS). */
|
|
607
|
+
type RpcExecutor = (payload: string, headers: Record<string, string>) => Promise<Response>;
|
|
608
|
+
/** CRUD-операции для `IBinding`. */
|
|
609
|
+
type CrudOp = 'read' | 'query' | 'create' | 'update' | 'destroy';
|
|
610
|
+
/**
|
|
611
|
+
* Соответствие CRUD-методов `Service` именам методов объекта БЛ.
|
|
612
|
+
*
|
|
613
|
+
* Если не задано — дефолты: `read → Read`, `query → List`,
|
|
614
|
+
* `create → Create`, `update → Update`, `destroy → Delete`.
|
|
615
|
+
*/
|
|
616
|
+
type IBinding = Partial<Record<CrudOp, string>>;
|
|
617
|
+
/** Опции `Service`. */
|
|
618
|
+
interface ServiceOptions {
|
|
619
|
+
/** URL endpoint. По умолчанию `/service`. */
|
|
620
|
+
url?: string;
|
|
621
|
+
/** Имя объекта БЛ (`Users`, `Staff`, ...). */
|
|
622
|
+
endpoint?: string;
|
|
623
|
+
/** Конкретный метод (`List`) — для `call`-style без binding. */
|
|
624
|
+
method?: string;
|
|
625
|
+
/** Маппинг CRUD → метод. */
|
|
626
|
+
binding?: IBinding;
|
|
627
|
+
/** Таймаут запроса в миллисекундах. */
|
|
628
|
+
timeout?: number;
|
|
629
|
+
/**
|
|
630
|
+
* TTL кэша по умолчанию (ms). Не задан / `0` — кэш выключен.
|
|
631
|
+
* Per-call override — `call(method, params, { cache })`.
|
|
632
|
+
*/
|
|
633
|
+
cache?: number;
|
|
634
|
+
}
|
|
635
|
+
/** Запись в кэше `NixoService`. */
|
|
636
|
+
interface ServiceCacheEntry {
|
|
637
|
+
/** Результат вызова. */
|
|
638
|
+
value: unknown;
|
|
639
|
+
/** Timestamp истечения (ms, `Date.now()`). */
|
|
640
|
+
expiresAt: number;
|
|
641
|
+
}
|
|
642
|
+
/** Опции per-call (`service.call(method, params, opts)`). */
|
|
643
|
+
interface CallOptions {
|
|
644
|
+
/** TTL кэша для этого вызова (ms). `false` — не кэшировать. */
|
|
645
|
+
cache?: number | false;
|
|
646
|
+
}
|
|
647
|
+
|
|
648
|
+
/**
|
|
649
|
+
* Реестр слайсов.
|
|
650
|
+
*
|
|
651
|
+
* Две карты:
|
|
652
|
+
* - `page` — фабрики текущей страницы (dispose на навигации);
|
|
653
|
+
* - `global` — глобальные loaders (`defineGlobalLoader`), живут до
|
|
654
|
+
* перезагрузки клиента / конца серверного запроса.
|
|
655
|
+
*
|
|
656
|
+
* `get(key)` ищет сначала в `page`, потом в `global`.
|
|
657
|
+
*/
|
|
658
|
+
declare class SliceRegistry {
|
|
659
|
+
/** Page-scoped слайсы. */
|
|
660
|
+
private page;
|
|
661
|
+
/** Global-scoped слайсы. */
|
|
662
|
+
private global;
|
|
663
|
+
/** Подписчики на изменение конкретного ключа (для useSyncExternalStore). */
|
|
664
|
+
private keyListeners;
|
|
665
|
+
/**
|
|
666
|
+
* Ищет слайс по ключу: сначала page, потом global.
|
|
667
|
+
*
|
|
668
|
+
* @param key имя слайса.
|
|
669
|
+
* @returns слайс или undefined.
|
|
670
|
+
*/
|
|
671
|
+
get(key: string): AbstractSlice<unknown> | undefined;
|
|
672
|
+
/**
|
|
673
|
+
* Строгий поиск слайса.
|
|
674
|
+
*
|
|
675
|
+
* @param key имя слайса.
|
|
676
|
+
* @returns слайс.
|
|
677
|
+
* @throws {NixoError} если слайса нет.
|
|
678
|
+
*/
|
|
679
|
+
require(key: string): AbstractSlice<unknown>;
|
|
680
|
+
/**
|
|
681
|
+
* Подписка на изменение присутствия/инстанса слайса по ключу.
|
|
682
|
+
*
|
|
683
|
+
* @param key имя слайса.
|
|
684
|
+
* @param cb колбэк.
|
|
685
|
+
* @returns функция отписки.
|
|
686
|
+
*/
|
|
687
|
+
subscribeKey(key: string, cb: () => void): () => void;
|
|
688
|
+
/**
|
|
689
|
+
* Регистрирует page-scoped слайс.
|
|
690
|
+
*
|
|
691
|
+
* @param key имя слайса.
|
|
692
|
+
* @param slice экземпляр.
|
|
693
|
+
*/
|
|
694
|
+
setPage(key: string, slice: AbstractSlice<unknown>): void;
|
|
695
|
+
/**
|
|
696
|
+
* Регистрирует global-scoped слайс.
|
|
697
|
+
*
|
|
698
|
+
* @param key имя слайса.
|
|
699
|
+
* @param slice экземпляр.
|
|
700
|
+
*/
|
|
701
|
+
setGlobal(key: string, slice: AbstractSlice<unknown>): void;
|
|
702
|
+
/** Dispose всех page-слайсов и очистка карты (навигация). */
|
|
703
|
+
disposePage(): void;
|
|
704
|
+
/** Dispose всех слайсов (конец запроса / размонтирование). */
|
|
705
|
+
disposeAll(): void;
|
|
706
|
+
/**
|
|
707
|
+
* Уведомляет подписчиков на конкретный ключ.
|
|
708
|
+
*
|
|
709
|
+
* @param key имя слайса.
|
|
710
|
+
*/
|
|
711
|
+
private notifyKey;
|
|
712
|
+
}
|
|
713
|
+
|
|
714
|
+
/** Минимальный контракт реестра слайсов. */
|
|
715
|
+
interface PrefetchRegistry {
|
|
716
|
+
setPage(key: string, slice: unknown): void;
|
|
717
|
+
setGlobal(key: string, slice: unknown): void;
|
|
718
|
+
get(key: string): unknown;
|
|
719
|
+
}
|
|
720
|
+
/** Контекст prefetch (изоморфный). */
|
|
721
|
+
interface PrefetchContext {
|
|
722
|
+
route: NixoRoute;
|
|
723
|
+
globalRegistry: FactoryMap;
|
|
724
|
+
loadModule: (spec: string) => Promise<unknown>;
|
|
725
|
+
registry: PrefetchRegistry;
|
|
726
|
+
router: NixoRouter;
|
|
727
|
+
}
|
|
728
|
+
/** Информация о слайсе для сериализации. */
|
|
729
|
+
interface PrefetchSliceInfo {
|
|
730
|
+
dataFactoryName: string;
|
|
731
|
+
state: unknown;
|
|
732
|
+
scope: 'page' | 'global';
|
|
733
|
+
}
|
|
734
|
+
/** Результат prefetch. */
|
|
735
|
+
interface PrefetchResult {
|
|
736
|
+
states: Map<string, unknown>;
|
|
737
|
+
slices: Map<string, PrefetchSliceInfo>;
|
|
738
|
+
}
|
|
739
|
+
/**
|
|
740
|
+
* Загружает глобальные зависимости (`prefetchConfig.dependencies`).
|
|
741
|
+
*
|
|
742
|
+
* @param ctx контекст.
|
|
743
|
+
* @param opts опции.
|
|
744
|
+
* @param opts.skipExisting пропустить уже загруженные в реестре.
|
|
745
|
+
* @returns `Map<name, state>`.
|
|
746
|
+
*/
|
|
747
|
+
declare function runGlobalPrefetch(ctx: PrefetchContext, opts?: {
|
|
748
|
+
skipExisting?: boolean;
|
|
749
|
+
}): Promise<Map<string, unknown>>;
|
|
750
|
+
/**
|
|
751
|
+
* Загружает page-scoped фабрики (`getConfig`).
|
|
752
|
+
*
|
|
753
|
+
* @param ctx контекст.
|
|
754
|
+
* @param globalStates результат `runGlobalPrefetch`.
|
|
755
|
+
* @returns полный `PrefetchResult`.
|
|
756
|
+
*/
|
|
757
|
+
declare function runPagePrefetch(ctx: PrefetchContext, globalStates: Map<string, unknown>): Promise<PrefetchResult>;
|
|
758
|
+
/**
|
|
759
|
+
* Загружает глобальные зависимости (`prefetchConfig.dependencies`).
|
|
760
|
+
*
|
|
761
|
+
* @param ctx контекст.
|
|
762
|
+
* @returns `Map<name, state>`.
|
|
763
|
+
*/
|
|
764
|
+
declare function runPrefetch(ctx: PrefetchContext): Promise<PrefetchResult>;
|
|
765
|
+
|
|
766
|
+
export { AbstractSlice as A, type SliceListener as B, type CrudOp as C, type SliceUpdater as D, type StandardSchemaV1 as E, type FactoryDef as F, runGlobalPrefetch as G, type HttpMethod as H, type IBinding as I, runPagePrefetch as J, runPrefetch as K, type ServiceCacheEntry as L, type Manifest as M, type NixoClientRouter as N, type StandardSchemaV1Failure as O, type PrefetchContext as P, type StandardSchemaV1Issue as Q, type ResolvedNixoConfig as R, SliceRegistry as S, type StandardSchemaV1Result as T, type StandardSchemaV1Success as U, type CallOptions as V, type AuthRequirement as a, type FactoryImplementation as b, type FactoryMap as c, type ManifestEntry as d, type MiddlewareDef as e, type ModuleKind as f, type NixoConfig as g, type NixoRoute as h, type NixoRouter as i, type PrefetchRegistry as j, type PrefetchResult as k, type PrefetchSliceInfo as l, type ResolvedRpcOptions as m, type RouteTree as n, type RpcContext as o, type RpcExecutor as p, type RpcMethodDefinition as q, type RpcObjectDefinition as r, type RpcOptions as s, type RpcParamsSchema as t, type ScanResult as u, type ServerPluginDef as v, type ServerPluginsOptions as w, type ServerRoute as x, type ServiceOptions as y, Slice as z };
|