@foxford/den 1.0.2 → 2.0.0

package/view-adapter-CL0vZ-rv.d.ts

@@ -0,0 +1,110 @@
+import { S as SlotDefinition } from './define-slot-ESU7FR9O.js';
+import { s as LayerDefinition, z as Definition, q as LayerConfig } from './types-Deyolj1-.js';
+import { Token, Container } from '@foxford/ioc';
+
+/**
+ * Дескриптор острова — что ядру нужно, чтобы остров прожил свой цикл.
+ *
+ * `view` типизирован как `unknown` по той же причине, что и в `defineSlot`: остров не
+ * прибит к React. Ядро собирает контейнер, гидрирует VM и ведёт учёт, ни разу не заглянув
+ * во view; красит его view-адаптер (`ViewAdapter.createIsland`), и он же знает, дерево
+ * какого фреймворка перед ним.
+ *
+ * Дескрипторы страниц у хостов (`PageDescriptor` в `@foxford/den-vike` и `@foxford/den-next`)
+ * шире: у каждого своя часть про оркестрацию — `load`, `routes`, `provides`/`requires`,
+ * вклад в документ. Сводить их в один тип нечем, оркестраторы у хостов разные. Общее
+ * ровно это, и структурная типизация делает остальное: дескриптор хоста подходит сюда как есть.
+ */
+interface IslandDescriptor {
+    /**
+     * Имя мини-приложения (`market-app`).
+     *
+     * Работает дважды: корень именованного иерархического логгера (ядро биндит по нему
+     * scope-логгер в контейнер острова, поэтому регистрация единиц логируется под именем
+     * приложения) и пространство имён для адресов его слотов (см. `slotAddress`). Из-за
+     * второго оно обязательное: без него у мест приложения не было бы адреса.
+     */
+    name: string;
+    /** Непрозрачная ссылка на view острова (компонент view-фреймворка). */
+    view: unknown;
+    /**
+     * View-слой — чем остров рисовать: `defineLayer(ViewLayerToken, { adapter: reactAdapter() })`.
+     *
+     * Обязателен, и дефолта нет ни у ядра, ни у хоста: фреймворк за приложение не выбирают.
+     * Слой регистрируется в контейнере острова, поэтому слоты внутри по умолчанию рисуются
+     * им же; слот перекрывает выбор своим `viewLayer`.
+     */
+    viewLayer: LayerDefinition;
+    /**
+     * Data/Business единицы (repository/service). Регистрируются в контейнере острова.
+     * Не должны импортировать VM.
+     */
+    units: ReadonlyArray<Definition<unknown>>;
+    /**
+     * VM-единицы: регистрируются только в острове — оркестратор их не читает, состояние
+     * ездит через denState.
+     */
+    viewModels?: ReadonlyArray<Definition<unknown>>;
+    /**
+     * Места расширения приложения: ключ — локальное имя слота, значение — `defineSlot`.
+     *
+     * Карта, а не массив, потому что имя даёт хозяин места: адрес получается `app:key`
+     * (см. `slotAddress`), занять чужое пространство имён нечем, а руками писать префикс
+     * не нужно. Единицы слотов регистрируются в контейнере острова вместе с его собственными.
+     */
+    slots?: Readonly<Record<string, SlotDefinition>>;
+}
+
+/**
+ * Порт view-адаптера. Реализуется пакетом фреймворка (`@foxford/den-react` и его аналоги),
+ * объявляется приложением через `defineLayer(ViewLayerToken, { adapter })`.
+ */
+interface ViewAdapter {
+    /** Имя фреймворка (`react`, `vue`) — для диагностики и сообщений об ошибках. */
+    readonly type: string;
+    /**
+     * Компонент острова для этого фреймворка: драйвит жизненный цикл ядра своими средствами
+     * (у React — хуки, у Vue — `setup`) и рисует `descriptor.view`.
+     *
+     * @param descriptor - Дескриптор острова
+     * @returns Компонент фреймворка — для ядра непрозрачен
+     */
+    createIsland(descriptor: IslandDescriptor): unknown;
+    /**
+     * Ставит стратегию резолва `define*` во view (`installResolver` из `@foxford/den/adapter`).
+     * У каждого фреймворка она своя: у React — хук поверх контекста контейнера, у Vue —
+     * `inject`. Зовёт хост при инициализации трека.
+     */
+    installResolver(): void;
+}
+/**
+ * Канонический токен view-слоя.
+ *
+ * Живёт в ядре именно потому, что «мы знаем, что зарегистрировано» работает лишь тогда,
+ * когда токен один на всех: заведи его каждое приложение у себя — и движок не найдёт
+ * чужую регистрацию.
+ */
+declare const ViewLayerToken: Token<LayerConfig>;
+/** View-слой приложения — результат `defineLayer(ViewLayerToken, { adapter })`. */
+type ViewLayerDefinition = LayerDefinition;
+/**
+ * Достаёт адаптер из объявленного приложением view-слоя.
+ *
+ * @param layer - View-слой (`defineLayer(ViewLayerToken, { adapter })`)
+ * @returns Адаптер view-фреймворка
+ * @throws Если слой объявлен без адаптера или адаптер не закрывает порт
+ */
+declare function viewAdapterOf(layer: ViewLayerDefinition): ViewAdapter;
+/**
+ * Достаёт адаптер из контейнера — с подъёмом по parent-chain, как это делает резолв во view.
+ *
+ * Нужен там, где на руках только контейнер (например, отрисовка слота внутри острова).
+ * Дефолта нет намеренно: фреймворк за приложение ядро не выбирает.
+ *
+ * @param container - Контейнер острова/страницы
+ * @returns Адаптер view-фреймворка
+ * @throws Если приложение не объявило view-слой
+ */
+declare function resolveViewAdapter(container: Container): ViewAdapter;
+
+export { type IslandDescriptor as I, type ViewAdapter as V, type ViewLayerDefinition as a, ViewLayerToken as b, resolveViewAdapter as r, viewAdapterOf as v };

package/view-adapter-vwO-7b1t.d.cts

@@ -0,0 +1,110 @@
+import { S as SlotDefinition } from './define-slot-RfgqKa6n.cjs';
+import { s as LayerDefinition, z as Definition, q as LayerConfig } from './types-Deyolj1-.cjs';
+import { Token, Container } from '@foxford/ioc';
+
+/**
+ * Дескриптор острова — что ядру нужно, чтобы остров прожил свой цикл.
+ *
+ * `view` типизирован как `unknown` по той же причине, что и в `defineSlot`: остров не
+ * прибит к React. Ядро собирает контейнер, гидрирует VM и ведёт учёт, ни разу не заглянув
+ * во view; красит его view-адаптер (`ViewAdapter.createIsland`), и он же знает, дерево
+ * какого фреймворка перед ним.
+ *
+ * Дескрипторы страниц у хостов (`PageDescriptor` в `@foxford/den-vike` и `@foxford/den-next`)
+ * шире: у каждого своя часть про оркестрацию — `load`, `routes`, `provides`/`requires`,
+ * вклад в документ. Сводить их в один тип нечем, оркестраторы у хостов разные. Общее
+ * ровно это, и структурная типизация делает остальное: дескриптор хоста подходит сюда как есть.
+ */
+interface IslandDescriptor {
+    /**
+     * Имя мини-приложения (`market-app`).
+     *
+     * Работает дважды: корень именованного иерархического логгера (ядро биндит по нему
+     * scope-логгер в контейнер острова, поэтому регистрация единиц логируется под именем
+     * приложения) и пространство имён для адресов его слотов (см. `slotAddress`). Из-за
+     * второго оно обязательное: без него у мест приложения не было бы адреса.
+     */
+    name: string;
+    /** Непрозрачная ссылка на view острова (компонент view-фреймворка). */
+    view: unknown;
+    /**
+     * View-слой — чем остров рисовать: `defineLayer(ViewLayerToken, { adapter: reactAdapter() })`.
+     *
+     * Обязателен, и дефолта нет ни у ядра, ни у хоста: фреймворк за приложение не выбирают.
+     * Слой регистрируется в контейнере острова, поэтому слоты внутри по умолчанию рисуются
+     * им же; слот перекрывает выбор своим `viewLayer`.
+     */
+    viewLayer: LayerDefinition;
+    /**
+     * Data/Business единицы (repository/service). Регистрируются в контейнере острова.
+     * Не должны импортировать VM.
+     */
+    units: ReadonlyArray<Definition<unknown>>;
+    /**
+     * VM-единицы: регистрируются только в острове — оркестратор их не читает, состояние
+     * ездит через denState.
+     */
+    viewModels?: ReadonlyArray<Definition<unknown>>;
+    /**
+     * Места расширения приложения: ключ — локальное имя слота, значение — `defineSlot`.
+     *
+     * Карта, а не массив, потому что имя даёт хозяин места: адрес получается `app:key`
+     * (см. `slotAddress`), занять чужое пространство имён нечем, а руками писать префикс
+     * не нужно. Единицы слотов регистрируются в контейнере острова вместе с его собственными.
+     */
+    slots?: Readonly<Record<string, SlotDefinition>>;
+}
+
+/**
+ * Порт view-адаптера. Реализуется пакетом фреймворка (`@foxford/den-react` и его аналоги),
+ * объявляется приложением через `defineLayer(ViewLayerToken, { adapter })`.
+ */
+interface ViewAdapter {
+    /** Имя фреймворка (`react`, `vue`) — для диагностики и сообщений об ошибках. */
+    readonly type: string;
+    /**
+     * Компонент острова для этого фреймворка: драйвит жизненный цикл ядра своими средствами
+     * (у React — хуки, у Vue — `setup`) и рисует `descriptor.view`.
+     *
+     * @param descriptor - Дескриптор острова
+     * @returns Компонент фреймворка — для ядра непрозрачен
+     */
+    createIsland(descriptor: IslandDescriptor): unknown;
+    /**
+     * Ставит стратегию резолва `define*` во view (`installResolver` из `@foxford/den/adapter`).
+     * У каждого фреймворка она своя: у React — хук поверх контекста контейнера, у Vue —
+     * `inject`. Зовёт хост при инициализации трека.
+     */
+    installResolver(): void;
+}
+/**
+ * Канонический токен view-слоя.
+ *
+ * Живёт в ядре именно потому, что «мы знаем, что зарегистрировано» работает лишь тогда,
+ * когда токен один на всех: заведи его каждое приложение у себя — и движок не найдёт
+ * чужую регистрацию.
+ */
+declare const ViewLayerToken: Token<LayerConfig>;
+/** View-слой приложения — результат `defineLayer(ViewLayerToken, { adapter })`. */
+type ViewLayerDefinition = LayerDefinition;
+/**
+ * Достаёт адаптер из объявленного приложением view-слоя.
+ *
+ * @param layer - View-слой (`defineLayer(ViewLayerToken, { adapter })`)
+ * @returns Адаптер view-фреймворка
+ * @throws Если слой объявлен без адаптера или адаптер не закрывает порт
+ */
+declare function viewAdapterOf(layer: ViewLayerDefinition): ViewAdapter;
+/**
+ * Достаёт адаптер из контейнера — с подъёмом по parent-chain, как это делает резолв во view.
+ *
+ * Нужен там, где на руках только контейнер (например, отрисовка слота внутри острова).
+ * Дефолта нет намеренно: фреймворк за приложение ядро не выбирает.
+ *
+ * @param container - Контейнер острова/страницы
+ * @returns Адаптер view-фреймворка
+ * @throws Если приложение не объявило view-слой
+ */
+declare function resolveViewAdapter(container: Container): ViewAdapter;
+
+export { type IslandDescriptor as I, type ViewAdapter as V, type ViewLayerDefinition as a, ViewLayerToken as b, resolveViewAdapter as r, viewAdapterOf as v };

package/chunk-NRE6DV6O.cjs

@@ -1,40 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var __async = (__this, __arguments, generator) => {
-  return new Promise((resolve, reject) => {
-    var fulfilled = (value) => {
-      try {
-        step(generator.next(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var rejected = (value) => {
-      try {
-        step(generator.throw(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
-    step((generator = generator.apply(__this, __arguments)).next());
-  });
-};
-
-// src/adapter.ts
-var activeResolver = null;
-function installResolver(resolver) {
-  activeResolver = resolver;
-}
-function resolveDefinition(token) {
-  if (activeResolver === null) {
-    throw new Error(
-      `den/adapter: \u0440\u0435\u0437\u043E\u043B\u0432\u0435\u0440 \u043D\u0435 \u0443\u0441\u0442\u0430\u043D\u043E\u0432\u043B\u0435\u043D \u0434\u043B\u044F \xAB${token.description}\xBB \u2014 \u043D\u0438 \u043E\u0434\u0438\u043D host-\u0430\u0434\u0430\u043F\u0442\u0435\u0440 \u043D\u0435 \u0432\u044B\u0437\u0432\u0430\u043B installResolver()`
-    );
-  }
-  return activeResolver(token);
-}
-
-
-
-
-
-exports.__async = __async; exports.installResolver = installResolver; exports.resolveDefinition = resolveDefinition;