setti 0.0.0-stage → 0.1.0-alpha.0

package/dist/not-found-fz-2RDV6.d.ts

@@ -0,0 +1,340 @@
+import { g as NixoConfig, h as NixoRoute, c as FactoryMap, y as ServiceOptions, C as CrudOp, V as CallOptions } from './prefetch-Bp9dMSTK.js';
+import { Component, ReactNode, ComponentType } from 'react';
+import 'devalue';
+
+/**
+ * JSDoc-обёртка для `nixo.config.ts` — даёт типобезопасность.
+ *
+ * Pure-функция (без jiti/fastify) — можно импортировать из любого окружения.
+ *
+ * @param config объект конфигурации.
+ * @returns тот же объект.
+ */
+declare function defineNixoConfig(config: NixoConfig): NixoConfig;
+
+/**
+ * Обёртка над массивом маршрутов.
+ *
+ * Возвращает тот же массив, но даёт типизацию и точку расширения:
+ * позже здесь можно добавлять валидацию во время выполнения
+ * (например, проверку обязательных полей в dev-режиме).
+ *
+ * @param routes массив маршрутов, объявленных в `router.ts`.
+ * @returns тот же массив, типобезопасно.
+ *
+ * @example
+ * ```ts
+ * export default defineRoute([
+ *   {
+ *     id: 'home',
+ *     index: true,
+ *     title: 'Главная',
+ *     type: 'main',
+ *     contentConfig: {
+ *       workspaceConfig: { template: 'HomePage/view:View' },
+ *       prefetchConfig: { configLoader: 'HomePage/Factories/Root' },
+ *     },
+ *   },
+ * ])
+ * ```
+ */
+declare function defineRoute(routes: NixoRoute[]): NixoRoute[];
+
+/**
+ * Обёртка над картой глобальных загрузчиков.
+ *
+ * Формат совпадает с возвращаемым значением `getConfig` в `configLoader`.
+ * Файл должен называться `*.loader.ts` и лежать в любом месте `clientDir` —
+ * сканнер найдёт его автоматически.
+ *
+ * @param map карта фабрик `имя → описание`.
+ * @returns та же карта.
+ *
+ * @example
+ * ```ts
+ * // client/User.loader.ts
+ * export default defineGlobalLoader({
+ *   userInfo: {
+ *     dataFactoryName: 'User/loaders/userInfo:UserInfoLoader',
+ *   },
+ * })
+ * ```
+ */
+declare function defineGlobalLoader(map: FactoryMap): FactoryMap;
+
+/**
+ * Строит человекочитаемый URL-паттерн маршрута.
+ *
+ * - `path` — как есть.
+ * - Иначе: `/<id-chain>[/<slug-сегменты>]`.
+ *
+ * Для regex-сегментов возвращает `:slug`, `:slug1`, ... (для отображения).
+ *
+ * @param route маршрут.
+ * @param byId карта.
+ * @returns паттерн.
+ */
+declare function computePath(route: NixoRoute, byId: Map<string, NixoRoute>): string;
+
+/**
+ * Базовый класс ошибок фреймворка nixo.
+ *
+ * Все ошибки, которые может бросить сканнер, валидатор или сам фреймворк,
+ * наследуются от `NixoError` — это позволяет вызывающему коду отличать
+ * ошибки фреймворка от случайных исключений.
+ */
+declare class NixoError extends Error {
+    constructor(message: string);
+}
+/** JSON-RPC ошибка. */
+interface JsonRpcErrorPayload {
+    code: number;
+    message: string;
+    detail?: string;
+    data?: unknown;
+}
+/**
+ * Ошибка JSON-RPC. Бросается `Service.call` при `error` в ответе.
+ */
+declare class NixoRpcError extends NixoError {
+    /** Оригинальный JSON-RPC error. */
+    readonly rpcError: JsonRpcErrorPayload;
+    /**
+     * @param rpcError JSON-RPC error payload.
+     */
+    constructor(rpcError: JsonRpcErrorPayload);
+    /**
+     * Код ошибки.
+     *
+     * @returns код JSON-RPC.
+     */
+    get code(): number;
+    /**
+     * Дополнительное описание.
+     *
+     * @returns detail или `undefined`.
+     */
+    get detail(): string | undefined;
+    /**
+     * Дополнительные данные.
+     *
+     * @returns data или `undefined`.
+     */
+    get data(): unknown;
+}
+
+/**
+ * Базовый класс для CRUD-обёрток над JSON-RPC.
+ *
+ * Не знает про URL/headers — это делает `Service`.
+ * Пока — минимальный каркас; полная реализация (list/read/create/update/delete) — R5.
+ */
+declare abstract class Remote<T extends Record<string, unknown> = Record<string, unknown>> {
+    protected _remoteOpts: ServiceOptions;
+    /**
+     * @param opts опции сервиса.
+     */
+    constructor(opts: ServiceOptions);
+    /**
+     * Получить имя метода объекта для CRUD-операции.
+     *
+     * @param op CRUD-операция.
+     * @returns имя метода (`Read`, `List`, ...).
+     */
+    protected resolveMethod(op: CrudOp): string;
+    /**
+     * Заглушка; полная реализация в R5.
+     *
+     * @param _method имя метода объекта.
+     * @param _params параметры вызова.
+     * @returns `Response`.
+     */
+    protected _call(_method: string, _params?: unknown): Promise<Response>;
+    protected _phantom?: T;
+}
+
+/**
+ * Изоморфный JSON-RPC 2.0 клиент с кэшем.
+ *
+ * - Клиент: `fetch(url, { method: 'POST', body })` + кэш в модульном `Map`.
+ * - Сервер (SSR): executor из ALS + кэш в ALS (per-request).
+ *
+ * Кэш:
+ *   - Включается через `new NixoService({ ..., cache: 30000 })`.
+ *   - Per-call override: `service.call(method, params, { cache: 60000 })`.
+ *   - `cache: false` в опциях вызова — не кэшировать.
+ *   - Инвалидация: `service.invalidate()` / `invalidate(method)` / `invalidate(method, params)` / `NixoService.invalidateAll()`.
+ */
+declare class Service<T extends Record<string, unknown> = Record<string, unknown>> extends Remote<T> {
+    private _serviceOpts;
+    /**
+     * @param opts опции.
+     */
+    constructor(opts?: ServiceOptions);
+    /**
+     * Ключ кэша: `endpoint.method:devalueStringify(params)`.
+     *
+     * @param method метод.
+     * @param params параметры.
+     * @returns ключ.
+     */
+    private getCacheKey;
+    /**
+     * Хранилище кэша: ALS (SSR) или модульный `Map` (клиент).
+     *
+     * @returns `Map` или `null`.
+     */
+    private getCacheStore;
+    /**
+     * Низкоуровневый JSON-RPC вызов (без кэша).
+     *
+     * @param method имя метода.
+     * @param params параметры.
+     * @returns `Response`.
+     */
+    callRaw(method: string, params?: unknown): Promise<Response>;
+    /**
+     * JSON-RPC вызов с кэшем.
+     *
+     * @param method имя метода.
+     * @param params параметры.
+     * @param opts per-call опции (`{ cache }`).
+     * @returns `result`.
+     * @throws {NixoRpcError} при `error` в ответе.
+     */
+    call<R = unknown>(method: string, params?: unknown, opts?: CallOptions): Promise<R>;
+    /**
+     * Инвалидирует кэш.
+     *
+     * - `invalidate()` — всё для текущего `endpoint`.
+     * - `invalidate(method)` — все ключи метода.
+     * - `invalidate(method, params)` — точечно.
+     *
+     * @param method метод.
+     * @param params параметры.
+     */
+    invalidate(method?: string, params?: unknown): void;
+    /**
+     * Очищает **всё** клиентский кэш (кросс-инстанс).
+     *
+     * На сервере — no-op (per-request кэш в ALS всё равно уничтожится).
+     */
+    static invalidateAll(): void;
+    /**
+     * CRUD: query (`List` по дефолту).
+     *
+     * @param params параметры.
+     * @param opts per-call опции.
+     * @returns `result`.
+     */
+    query<P = unknown, R = unknown>(params?: P, opts?: CallOptions): Promise<R>;
+    /**
+     * CRUD: read (`Read` по дефолту).
+     *
+     * @param params параметры.
+     * @param opts per-call опции.
+     * @returns `result`.
+     */
+    read<P = unknown, R = unknown>(params?: P, opts?: CallOptions): Promise<R>;
+    /**
+     * CRUD: create (`Create` по дефолту).
+     *
+     * @param params параметры.
+     * @param opts per-call опции.
+     * @returns `result`.
+     */
+    create<P = unknown, R = unknown>(params?: P, opts?: CallOptions): Promise<R>;
+    /**
+     * CRUD: update (`Update` по дефолту).
+     *
+     * @param params параметры.
+     * @param opts per-call опции.
+     * @returns `result`.
+     */
+    update<P = unknown, R = unknown>(params?: P, opts?: CallOptions): Promise<R>;
+    /**
+     * CRUD: destroy (`Delete` по дефолту).
+     *
+     * @param params параметры.
+     * @param opts per-call опции.
+     * @returns `result`.
+     */
+    destroy<P = unknown, R = unknown>(params?: P, opts?: CallOptions): Promise<R>;
+    /**
+     * URL endpoint.
+     *
+     * @returns URL.
+     */
+    protected getUrl(): string;
+    /**
+     * Заголовки (на сервере — из ALS).
+     *
+     * @returns headers.
+     */
+    protected prepareHeaders(): Record<string, string>;
+    /**
+     * Изоморфный execute:
+     *   - SSR + executor → прямой вызов (без HTTP);
+     *   - иначе → fetch.
+     *
+     * @param payload JSON-RPC payload.
+     * @returns `Response`.
+     */
+    protected executeRequest(payload: string): Promise<Response>;
+}
+
+/** Пропсы `NixoErrorBoundary`. */
+interface NixoErrorBoundaryProps {
+    children?: ReactNode;
+    /** Fallback-компонент, получает `{ error }`. */
+    fallback?: ComponentType<{
+        error: Error;
+    }>;
+}
+/** Состояние. */
+interface NixoErrorBoundaryState {
+    error: Error | null;
+}
+/**
+ * Error Boundary фреймворка. Оборачивает дерево страницы.
+ *
+ * Работает в SSR (`renderToPipeableStream` ловит ошибки через boundary)
+ * и на клиенте. Если `fallback` не задан — минимальная заглушка.
+ */
+declare class NixoErrorBoundary extends Component<NixoErrorBoundaryProps, NixoErrorBoundaryState> {
+    state: NixoErrorBoundaryState;
+    /**
+     * @param error ошибка из дочернего дерева.
+     * @returns новое состояние.
+     */
+    static getDerivedStateFromError(error: Error): NixoErrorBoundaryState;
+    /**
+     * Логирует ошибку.
+     *
+     * @param error ошибка.
+     * @param info React error info.
+     */
+    componentDidCatch(error: Error, info: unknown): void;
+    /**
+     * Рендер: fallback при ошибке, иначе `children`.
+     *
+     * @returns ReactNode.
+     */
+    render(): ReactNode;
+}
+
+/**
+ * Дефолтный индикатор загрузки (показывается во время первого SPA-prefetch).
+ *
+ * @returns ReactNode.
+ */
+declare function NixoLoading(): ReactNode;
+
+/**
+ * Дефолтная 404-страница (если `config.components.notFound` не задан).
+ *
+ * @returns ReactNode.
+ */
+declare function NixoNotFound(): ReactNode;
+
+export { type JsonRpcErrorPayload as J, NixoError as N, Remote as R, Service as S, NixoErrorBoundary as a, type NixoErrorBoundaryProps as b, NixoLoading as c, NixoNotFound as d, NixoRpcError as e, computePath as f, defineGlobalLoader as g, defineNixoConfig as h, defineRoute as i };