@foxford/den 2.0.0 → 3.0.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/adapter.d.cts +1 -1
- package/adapter.d.ts +1 -1
- package/{chunk-TCYGDT2A.js → chunk-E23E2VUC.js} +2 -2
- package/{chunk-LJE7K7VD.cjs → chunk-XOJ2VWX4.cjs} +2 -2
- package/{define-repository-DZg34Tb3.d.ts → define-repository-Ca62_YCy.d.ts} +1 -1
- package/{define-repository-OpMj-Q9O.d.cts → define-repository-MDEWHqM7.d.cts} +1 -1
- package/{define-slot-RfgqKa6n.d.cts → define-slot-BKvArA02.d.cts} +1 -1
- package/{define-slot-ESU7FR9O.d.ts → define-slot-Dil8Kr1A.d.ts} +1 -1
- package/define.d.cts +3 -3
- package/define.d.ts +3 -3
- package/index.cjs +2 -25
- package/index.d.cts +6 -27
- package/index.d.ts +6 -27
- package/index.js +1 -24
- package/island/index.cjs +104 -5
- package/island/index.d.cts +160 -49
- package/island/index.d.ts +160 -49
- package/island/index.js +103 -4
- package/package.json +12 -12
- package/{types-Deyolj1-.d.cts → types-COwVwgzE.d.cts} +18 -43
- package/{types-Deyolj1-.d.ts → types-COwVwgzE.d.ts} +18 -43
- package/{view-adapter-vwO-7b1t.d.cts → view-adapter-BvDC5O4y.d.cts} +81 -3
- package/{view-adapter-CL0vZ-rv.d.ts → view-adapter-DtNgyjIf.d.ts} +81 -3
package/island/index.d.cts
CHANGED
|
@@ -1,9 +1,62 @@
|
|
|
1
|
-
import { I as IslandDescriptor } from '../view-adapter-
|
|
2
|
-
export { V as ViewAdapter, a as ViewLayerDefinition, b as ViewLayerToken, r as resolveViewAdapter, v as viewAdapterOf } from '../view-adapter-
|
|
1
|
+
import { I as IslandDescriptor } from '../view-adapter-BvDC5O4y.cjs';
|
|
2
|
+
export { R as RenderIslandOptions, c as RenderTree, S as ServerRender, d as ServerRenderResult, V as ViewAdapter, a as ViewLayerDefinition, b as ViewLayerToken, r as resolveViewAdapter, v as viewAdapterOf } from '../view-adapter-BvDC5O4y.cjs';
|
|
3
3
|
import { Container } from '@foxford/ioc';
|
|
4
|
-
import '../
|
|
5
|
-
import '../
|
|
4
|
+
import { g as GuardDefinition } from '../types-COwVwgzE.cjs';
|
|
5
|
+
import '../define-slot-BKvArA02.cjs';
|
|
6
6
|
|
|
7
|
+
/** Вклад приложения в `<head>` документа. */
|
|
8
|
+
interface DocumentHead {
|
|
9
|
+
title?: string;
|
|
10
|
+
description?: string;
|
|
11
|
+
keywords?: string;
|
|
12
|
+
/** При отсутствии хост берёт `title`. */
|
|
13
|
+
ogTitle?: string;
|
|
14
|
+
/** При отсутствии хост берёт `description`. */
|
|
15
|
+
ogDescription?: string;
|
|
16
|
+
}
|
|
17
|
+
/** Что приложение сообщает хосту про страницу, которую оно нарисовало. */
|
|
18
|
+
interface DocumentContribution {
|
|
19
|
+
head?: DocumentHead;
|
|
20
|
+
/**
|
|
21
|
+
* Исход запроса статусом HTTP; не объявлен — `200`.
|
|
22
|
+
*
|
|
23
|
+
* Статусом, а не набором признаков вроде «страницы нет»: исход у запроса один, а признаки
|
|
24
|
+
* позволяют объявить сразу два взаимоисключающих. Тем же статусом исход едет по сети,
|
|
25
|
+
* поэтому у обоих транспортов дискриминатор общий.
|
|
26
|
+
*
|
|
27
|
+
* Нужен отдельно от исключения: `throw` означает, что приложение упало, и хост рисует
|
|
28
|
+
* плашку вместо него. Приложение, занявшее путь по префиксу (`/legal/*`), обязано уметь
|
|
29
|
+
* сказать `404` про несуществующий адрес внутри своего пространства.
|
|
30
|
+
*/
|
|
31
|
+
status?: number;
|
|
32
|
+
/** Адрес для 3xx. Объявлен без статуса — исход `302`. */
|
|
33
|
+
redirect?: string;
|
|
34
|
+
}
|
|
35
|
+
/** VM, которой есть что сказать про документ. */
|
|
36
|
+
interface DocumentSource {
|
|
37
|
+
describeDocument(): DocumentContribution;
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* Реализует ли объект {@link DocumentSource}.
|
|
41
|
+
*
|
|
42
|
+
* @param value - Проверяемое значение
|
|
43
|
+
*/
|
|
44
|
+
declare function isDocumentSource(value: unknown): value is DocumentSource;
|
|
45
|
+
|
|
46
|
+
/**
|
|
47
|
+
* Адрес, по которому рендерится остров.
|
|
48
|
+
*
|
|
49
|
+
* Приходит АРГУМЕНТОМ активации, а не через контейнер: контейнер живёт и на клиенте, где
|
|
50
|
+
* адреса в нём нет, и юнит, потребовавший его через `requires`, упал бы при резолве.
|
|
51
|
+
*/
|
|
52
|
+
interface IslandRoute {
|
|
53
|
+
/** Путь без search, с ведущим слэшем: `/legal/general`. */
|
|
54
|
+
pathname: string;
|
|
55
|
+
/** Строка запроса без `?`; пустая, если её нет. */
|
|
56
|
+
search: string;
|
|
57
|
+
/** Параметры, выделенные маршрутом хоста. */
|
|
58
|
+
params: Record<string, string>;
|
|
59
|
+
}
|
|
7
60
|
/** Опции сборки контейнера острова. */
|
|
8
61
|
interface CreateIslandContainerOptions {
|
|
9
62
|
/**
|
|
@@ -42,14 +95,95 @@ declare function createIslandContainer(descriptor: IslandDescriptor, options?: C
|
|
|
42
95
|
*/
|
|
43
96
|
declare function hydrateIslandState(container: Container, descriptor: IslandDescriptor, denState: Record<string, unknown>): void;
|
|
44
97
|
/**
|
|
45
|
-
* Активирует VM
|
|
46
|
-
*
|
|
47
|
-
*
|
|
98
|
+
* Активирует VM острова: каждая считает своё состояние по адресу.
|
|
99
|
+
*
|
|
100
|
+
* Параллельно, потому что VM одного острова друг о друге не знают; ждём все — состояние
|
|
101
|
+
* нужно целиком, а не по частям.
|
|
102
|
+
*
|
|
103
|
+
* @param container - Контейнер острова
|
|
104
|
+
* @param descriptor - Дескриптор острова
|
|
105
|
+
* @param route - Адрес, по которому рендерится остров
|
|
106
|
+
*/
|
|
107
|
+
declare function activateIslandViewModels(container: Container, descriptor: IslandDescriptor, route?: IslandRoute): Promise<void>;
|
|
108
|
+
/**
|
|
109
|
+
* Снимает состояние VM острова — операция, обратная {@link hydrateIslandState}.
|
|
110
|
+
*
|
|
111
|
+
* @param container - Контейнер острова
|
|
112
|
+
* @param descriptor - Дескриптор острова
|
|
113
|
+
* @returns Состояние по ключам `token.description`
|
|
114
|
+
*/
|
|
115
|
+
declare function collectIslandState(container: Container, descriptor: IslandDescriptor): Record<string, unknown>;
|
|
116
|
+
/**
|
|
117
|
+
* Собирает вклад острова в документ по всем его VM.
|
|
118
|
+
*
|
|
119
|
+
* Правила слияния два, и они следуют из смысла полей. `head` — набор полей, поэтому
|
|
120
|
+
* объявленное позже уточняет объявленное раньше. Исход (`status` вместе с `redirect`) —
|
|
121
|
+
* ОДНО решение, а не набор: побеждает первое объявленное, и берётся оно целиком, иначе
|
|
122
|
+
* статус одной VM склеился бы с адресом другой.
|
|
123
|
+
*
|
|
124
|
+
* @param container - Контейнер острова
|
|
125
|
+
* @param descriptor - Дескриптор острова
|
|
126
|
+
*/
|
|
127
|
+
declare function collectDocumentContribution(container: Container, descriptor: IslandDescriptor): DocumentContribution;
|
|
128
|
+
/**
|
|
129
|
+
* Поднимает единицы, объявленные `eager`, — те, что обязаны жить с загрузки, а не с первого
|
|
130
|
+
* резолва.
|
|
131
|
+
*
|
|
132
|
+
* Отдельным шагом, а не внутри сборки контейнера: контейнер строится и на сервере (в vike —
|
|
133
|
+
* прямо в `renderToString`), а сервер живёт один рендер, и поднимать там WS-подписку или
|
|
134
|
+
* прогрев кэша незачем — открытый сокет на каждый рендер это не «eager», это утечка. Зовёт
|
|
135
|
+
* адаптер в точке монтирования, которой на сервере просто нет; серверное состояние приложения
|
|
136
|
+
* считает активация VM.
|
|
48
137
|
*
|
|
49
138
|
* @param container - Контейнер острова
|
|
50
139
|
* @param descriptor - Дескриптор острова
|
|
51
140
|
*/
|
|
52
|
-
declare function
|
|
141
|
+
declare function resolveEagerUnits(container: Container, descriptor: IslandDescriptor): void;
|
|
142
|
+
|
|
143
|
+
/** Запрос на рендер приложения. */
|
|
144
|
+
interface RenderAppRequest {
|
|
145
|
+
/** Путь без search, с ведущим слэшем: `/legal/general`. */
|
|
146
|
+
pathname: string;
|
|
147
|
+
/** Строка запроса без `?`. */
|
|
148
|
+
search?: string;
|
|
149
|
+
/** Параметры, выделенные маршрутом хоста. */
|
|
150
|
+
params?: Record<string, string>;
|
|
151
|
+
/**
|
|
152
|
+
* Родитель контейнера приложения: через него приезжает всё, что настроил исполнитель, —
|
|
153
|
+
* логгер, конфиг HTTP, выданные возможности. По умолчанию — app-scope контейнер.
|
|
154
|
+
*/
|
|
155
|
+
parent?: Container;
|
|
156
|
+
/** Внешние заполнители слотов; для ядра непрозрачны. */
|
|
157
|
+
slots?: Record<string, unknown>;
|
|
158
|
+
}
|
|
159
|
+
/** Ответ приложения: всё, что хосту нужно, чтобы собрать документ и ответить. */
|
|
160
|
+
interface RenderAppResult {
|
|
161
|
+
/**
|
|
162
|
+
* Исход запроса статусом HTTP. `200` — вот страница; всё остальное значит, что страницы
|
|
163
|
+
* по этому адресу нет, и тело такого ответа выбирает хост: страница ошибки у портала одна
|
|
164
|
+
* на все приложения.
|
|
165
|
+
*/
|
|
166
|
+
status: number;
|
|
167
|
+
/** Разметка приложения; пустая при любом исходе, кроме `200`. */
|
|
168
|
+
html: string;
|
|
169
|
+
/** Состояние VM по ключам `token.description` — им гидрируется остров в браузере. */
|
|
170
|
+
state: Record<string, unknown>;
|
|
171
|
+
/** Вклад в `<head>` данными. */
|
|
172
|
+
head?: DocumentHead;
|
|
173
|
+
/** Вклад в `<head>` готовой разметкой — стили, собранные во время рендера. */
|
|
174
|
+
headHtml?: string;
|
|
175
|
+
/** Адрес для 3xx. */
|
|
176
|
+
redirect?: string;
|
|
177
|
+
}
|
|
178
|
+
/**
|
|
179
|
+
* Рисует приложение по адресу и отдаёт разметку вместе с состоянием.
|
|
180
|
+
*
|
|
181
|
+
* @param descriptor - Дескриптор приложения
|
|
182
|
+
* @param request - Адрес, родительский контейнер и заполнители слотов
|
|
183
|
+
* @returns Разметка, состояние и вклад в документ
|
|
184
|
+
* @throws Если контейнер приложения не собрался — исполнитель решает, чем это показать
|
|
185
|
+
*/
|
|
186
|
+
declare function renderApp(descriptor: IslandDescriptor, request: RenderAppRequest): Promise<RenderAppResult>;
|
|
53
187
|
|
|
54
188
|
/** Запись живого острова: имя + фактический состав его контейнера. */
|
|
55
189
|
interface IslandRecord {
|
|
@@ -108,51 +242,28 @@ declare function getAppContainer(): Container;
|
|
|
108
242
|
*/
|
|
109
243
|
declare function slotAddress(app: string, slot: string): string;
|
|
110
244
|
|
|
111
|
-
/**
|
|
112
|
-
interface
|
|
113
|
-
/**
|
|
114
|
-
|
|
245
|
+
/** Маршрут с политикой доступа. */
|
|
246
|
+
interface RouteDeclaration {
|
|
247
|
+
/** Regex-источник адреса (`'^/cabinet/billing'`, `'.*'`). */
|
|
248
|
+
source: string;
|
|
115
249
|
/**
|
|
116
|
-
*
|
|
117
|
-
*
|
|
118
|
-
*
|
|
119
|
-
* Таковы стили CSS-in-JS: стороннее представление у них одно — тег со служебными
|
|
120
|
-
* атрибутами, по которым клиентский рантайм узнаёт свои правила. Разобрав его на поля,
|
|
121
|
-
* потеряешь регидратацию, и стили впрыснутся вторым экземпляром. Поэтому вклад в документ
|
|
122
|
-
* ДАННЫМИ (`DocumentHead` у хостов) остаётся отдельным каналом, а это — разметка.
|
|
123
|
-
*
|
|
124
|
-
* Разметка приезжает в документ хоста ДОСЛОВНО, без экранирования — иначе служебные
|
|
125
|
-
* атрибуты не пережили бы вставку. Отвечает за содержимое приложение: у сетевого
|
|
126
|
-
* транспорта строка приходит из чужого процесса, и хост её не разбирает.
|
|
250
|
+
* Guard-ы этого маршрута — поверх guard-ов приложения и хоста. Пусто — маршрут открыт
|
|
251
|
+
* настолько, насколько открыто само приложение.
|
|
127
252
|
*/
|
|
128
|
-
|
|
253
|
+
guards?: ReadonlyArray<GuardDefinition>;
|
|
129
254
|
}
|
|
130
|
-
/** Рендер дерева в разметку. Его даёт тот, кто серверный рендер исполняет. */
|
|
131
|
-
type RenderTree<Tree = unknown> = (tree: Tree) => string;
|
|
132
255
|
/**
|
|
133
|
-
*
|
|
134
|
-
*
|
|
135
|
-
*
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
*
|
|
140
|
-
*
|
|
141
|
-
* Подпись одна на оба транспорта, и в этом смысл: у приложения в процессе хоста рендер
|
|
142
|
-
* передаёт хост, у сетевого — его собственный сервер, а `html` и `head` едут ответом.
|
|
143
|
-
* Перевод приложения между транспортами эту часть не задевает.
|
|
144
|
-
*
|
|
145
|
-
* `Tree` — дерево view-фреймворка, для ядра непрозрачное. View-адаптер сужает параметр
|
|
146
|
-
* до своего типа (`ReactServerRender` в `@foxford/den-react`), и приложение пишет проход
|
|
147
|
-
* в терминах СВОЕГО фреймворка.
|
|
148
|
-
*
|
|
149
|
-
* @example
|
|
150
|
-
* serverRender: (tree, render) => {
|
|
151
|
-
* const sheet = new ServerStyleSheet()
|
|
256
|
+
* Заявка на адрес: голая строка — публичный маршрут, объект — маршрут со своей политикой.
|
|
257
|
+
* Обе формы лежат в одном массиве, и порядок значим так же, как раньше: хост раздаёт путь
|
|
258
|
+
* первому заявившему, поэтому частные записи ставятся выше общих.
|
|
259
|
+
*/
|
|
260
|
+
type AppRoute = string | RouteDeclaration;
|
|
261
|
+
/**
|
|
262
|
+
* Приводит заявки к одной форме — чтобы хост и dev-инструменты не разбирали union каждый сам.
|
|
152
263
|
*
|
|
153
|
-
*
|
|
154
|
-
*
|
|
264
|
+
* @param routes - Заявки приложения (строки и/или записи)
|
|
265
|
+
* @returns Записи маршрутов в порядке объявления
|
|
155
266
|
*/
|
|
156
|
-
|
|
267
|
+
declare function normalizeRoutes(routes?: ReadonlyArray<AppRoute>): RouteDeclaration[];
|
|
157
268
|
|
|
158
|
-
export { type CreateIslandContainerOptions, IslandDescriptor, type IslandRecord, type
|
|
269
|
+
export { type AppRoute, type CreateIslandContainerOptions, type DocumentContribution, type DocumentHead, type DocumentSource, IslandDescriptor, type IslandRecord, type IslandRoute, type RenderAppRequest, type RenderAppResult, type RouteDeclaration, activateIslandViewModels, collectDocumentContribution, collectIslandState, createIslandContainer, describeIsland, getAppContainer, getIslandsSnapshot, hydrateIslandState, isDocumentSource, normalizeRoutes, registerIsland, renderApp, resolveEagerUnits, slotAddress, subscribeIslands };
|
package/island/index.d.ts
CHANGED
|
@@ -1,9 +1,62 @@
|
|
|
1
|
-
import { I as IslandDescriptor } from '../view-adapter-
|
|
2
|
-
export { V as ViewAdapter, a as ViewLayerDefinition, b as ViewLayerToken, r as resolveViewAdapter, v as viewAdapterOf } from '../view-adapter-
|
|
1
|
+
import { I as IslandDescriptor } from '../view-adapter-DtNgyjIf.js';
|
|
2
|
+
export { R as RenderIslandOptions, c as RenderTree, S as ServerRender, d as ServerRenderResult, V as ViewAdapter, a as ViewLayerDefinition, b as ViewLayerToken, r as resolveViewAdapter, v as viewAdapterOf } from '../view-adapter-DtNgyjIf.js';
|
|
3
3
|
import { Container } from '@foxford/ioc';
|
|
4
|
-
import '../
|
|
5
|
-
import '../
|
|
4
|
+
import { g as GuardDefinition } from '../types-COwVwgzE.js';
|
|
5
|
+
import '../define-slot-Dil8Kr1A.js';
|
|
6
6
|
|
|
7
|
+
/** Вклад приложения в `<head>` документа. */
|
|
8
|
+
interface DocumentHead {
|
|
9
|
+
title?: string;
|
|
10
|
+
description?: string;
|
|
11
|
+
keywords?: string;
|
|
12
|
+
/** При отсутствии хост берёт `title`. */
|
|
13
|
+
ogTitle?: string;
|
|
14
|
+
/** При отсутствии хост берёт `description`. */
|
|
15
|
+
ogDescription?: string;
|
|
16
|
+
}
|
|
17
|
+
/** Что приложение сообщает хосту про страницу, которую оно нарисовало. */
|
|
18
|
+
interface DocumentContribution {
|
|
19
|
+
head?: DocumentHead;
|
|
20
|
+
/**
|
|
21
|
+
* Исход запроса статусом HTTP; не объявлен — `200`.
|
|
22
|
+
*
|
|
23
|
+
* Статусом, а не набором признаков вроде «страницы нет»: исход у запроса один, а признаки
|
|
24
|
+
* позволяют объявить сразу два взаимоисключающих. Тем же статусом исход едет по сети,
|
|
25
|
+
* поэтому у обоих транспортов дискриминатор общий.
|
|
26
|
+
*
|
|
27
|
+
* Нужен отдельно от исключения: `throw` означает, что приложение упало, и хост рисует
|
|
28
|
+
* плашку вместо него. Приложение, занявшее путь по префиксу (`/legal/*`), обязано уметь
|
|
29
|
+
* сказать `404` про несуществующий адрес внутри своего пространства.
|
|
30
|
+
*/
|
|
31
|
+
status?: number;
|
|
32
|
+
/** Адрес для 3xx. Объявлен без статуса — исход `302`. */
|
|
33
|
+
redirect?: string;
|
|
34
|
+
}
|
|
35
|
+
/** VM, которой есть что сказать про документ. */
|
|
36
|
+
interface DocumentSource {
|
|
37
|
+
describeDocument(): DocumentContribution;
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* Реализует ли объект {@link DocumentSource}.
|
|
41
|
+
*
|
|
42
|
+
* @param value - Проверяемое значение
|
|
43
|
+
*/
|
|
44
|
+
declare function isDocumentSource(value: unknown): value is DocumentSource;
|
|
45
|
+
|
|
46
|
+
/**
|
|
47
|
+
* Адрес, по которому рендерится остров.
|
|
48
|
+
*
|
|
49
|
+
* Приходит АРГУМЕНТОМ активации, а не через контейнер: контейнер живёт и на клиенте, где
|
|
50
|
+
* адреса в нём нет, и юнит, потребовавший его через `requires`, упал бы при резолве.
|
|
51
|
+
*/
|
|
52
|
+
interface IslandRoute {
|
|
53
|
+
/** Путь без search, с ведущим слэшем: `/legal/general`. */
|
|
54
|
+
pathname: string;
|
|
55
|
+
/** Строка запроса без `?`; пустая, если её нет. */
|
|
56
|
+
search: string;
|
|
57
|
+
/** Параметры, выделенные маршрутом хоста. */
|
|
58
|
+
params: Record<string, string>;
|
|
59
|
+
}
|
|
7
60
|
/** Опции сборки контейнера острова. */
|
|
8
61
|
interface CreateIslandContainerOptions {
|
|
9
62
|
/**
|
|
@@ -42,14 +95,95 @@ declare function createIslandContainer(descriptor: IslandDescriptor, options?: C
|
|
|
42
95
|
*/
|
|
43
96
|
declare function hydrateIslandState(container: Container, descriptor: IslandDescriptor, denState: Record<string, unknown>): void;
|
|
44
97
|
/**
|
|
45
|
-
* Активирует VM
|
|
46
|
-
*
|
|
47
|
-
*
|
|
98
|
+
* Активирует VM острова: каждая считает своё состояние по адресу.
|
|
99
|
+
*
|
|
100
|
+
* Параллельно, потому что VM одного острова друг о друге не знают; ждём все — состояние
|
|
101
|
+
* нужно целиком, а не по частям.
|
|
102
|
+
*
|
|
103
|
+
* @param container - Контейнер острова
|
|
104
|
+
* @param descriptor - Дескриптор острова
|
|
105
|
+
* @param route - Адрес, по которому рендерится остров
|
|
106
|
+
*/
|
|
107
|
+
declare function activateIslandViewModels(container: Container, descriptor: IslandDescriptor, route?: IslandRoute): Promise<void>;
|
|
108
|
+
/**
|
|
109
|
+
* Снимает состояние VM острова — операция, обратная {@link hydrateIslandState}.
|
|
110
|
+
*
|
|
111
|
+
* @param container - Контейнер острова
|
|
112
|
+
* @param descriptor - Дескриптор острова
|
|
113
|
+
* @returns Состояние по ключам `token.description`
|
|
114
|
+
*/
|
|
115
|
+
declare function collectIslandState(container: Container, descriptor: IslandDescriptor): Record<string, unknown>;
|
|
116
|
+
/**
|
|
117
|
+
* Собирает вклад острова в документ по всем его VM.
|
|
118
|
+
*
|
|
119
|
+
* Правила слияния два, и они следуют из смысла полей. `head` — набор полей, поэтому
|
|
120
|
+
* объявленное позже уточняет объявленное раньше. Исход (`status` вместе с `redirect`) —
|
|
121
|
+
* ОДНО решение, а не набор: побеждает первое объявленное, и берётся оно целиком, иначе
|
|
122
|
+
* статус одной VM склеился бы с адресом другой.
|
|
123
|
+
*
|
|
124
|
+
* @param container - Контейнер острова
|
|
125
|
+
* @param descriptor - Дескриптор острова
|
|
126
|
+
*/
|
|
127
|
+
declare function collectDocumentContribution(container: Container, descriptor: IslandDescriptor): DocumentContribution;
|
|
128
|
+
/**
|
|
129
|
+
* Поднимает единицы, объявленные `eager`, — те, что обязаны жить с загрузки, а не с первого
|
|
130
|
+
* резолва.
|
|
131
|
+
*
|
|
132
|
+
* Отдельным шагом, а не внутри сборки контейнера: контейнер строится и на сервере (в vike —
|
|
133
|
+
* прямо в `renderToString`), а сервер живёт один рендер, и поднимать там WS-подписку или
|
|
134
|
+
* прогрев кэша незачем — открытый сокет на каждый рендер это не «eager», это утечка. Зовёт
|
|
135
|
+
* адаптер в точке монтирования, которой на сервере просто нет; серверное состояние приложения
|
|
136
|
+
* считает активация VM.
|
|
48
137
|
*
|
|
49
138
|
* @param container - Контейнер острова
|
|
50
139
|
* @param descriptor - Дескриптор острова
|
|
51
140
|
*/
|
|
52
|
-
declare function
|
|
141
|
+
declare function resolveEagerUnits(container: Container, descriptor: IslandDescriptor): void;
|
|
142
|
+
|
|
143
|
+
/** Запрос на рендер приложения. */
|
|
144
|
+
interface RenderAppRequest {
|
|
145
|
+
/** Путь без search, с ведущим слэшем: `/legal/general`. */
|
|
146
|
+
pathname: string;
|
|
147
|
+
/** Строка запроса без `?`. */
|
|
148
|
+
search?: string;
|
|
149
|
+
/** Параметры, выделенные маршрутом хоста. */
|
|
150
|
+
params?: Record<string, string>;
|
|
151
|
+
/**
|
|
152
|
+
* Родитель контейнера приложения: через него приезжает всё, что настроил исполнитель, —
|
|
153
|
+
* логгер, конфиг HTTP, выданные возможности. По умолчанию — app-scope контейнер.
|
|
154
|
+
*/
|
|
155
|
+
parent?: Container;
|
|
156
|
+
/** Внешние заполнители слотов; для ядра непрозрачны. */
|
|
157
|
+
slots?: Record<string, unknown>;
|
|
158
|
+
}
|
|
159
|
+
/** Ответ приложения: всё, что хосту нужно, чтобы собрать документ и ответить. */
|
|
160
|
+
interface RenderAppResult {
|
|
161
|
+
/**
|
|
162
|
+
* Исход запроса статусом HTTP. `200` — вот страница; всё остальное значит, что страницы
|
|
163
|
+
* по этому адресу нет, и тело такого ответа выбирает хост: страница ошибки у портала одна
|
|
164
|
+
* на все приложения.
|
|
165
|
+
*/
|
|
166
|
+
status: number;
|
|
167
|
+
/** Разметка приложения; пустая при любом исходе, кроме `200`. */
|
|
168
|
+
html: string;
|
|
169
|
+
/** Состояние VM по ключам `token.description` — им гидрируется остров в браузере. */
|
|
170
|
+
state: Record<string, unknown>;
|
|
171
|
+
/** Вклад в `<head>` данными. */
|
|
172
|
+
head?: DocumentHead;
|
|
173
|
+
/** Вклад в `<head>` готовой разметкой — стили, собранные во время рендера. */
|
|
174
|
+
headHtml?: string;
|
|
175
|
+
/** Адрес для 3xx. */
|
|
176
|
+
redirect?: string;
|
|
177
|
+
}
|
|
178
|
+
/**
|
|
179
|
+
* Рисует приложение по адресу и отдаёт разметку вместе с состоянием.
|
|
180
|
+
*
|
|
181
|
+
* @param descriptor - Дескриптор приложения
|
|
182
|
+
* @param request - Адрес, родительский контейнер и заполнители слотов
|
|
183
|
+
* @returns Разметка, состояние и вклад в документ
|
|
184
|
+
* @throws Если контейнер приложения не собрался — исполнитель решает, чем это показать
|
|
185
|
+
*/
|
|
186
|
+
declare function renderApp(descriptor: IslandDescriptor, request: RenderAppRequest): Promise<RenderAppResult>;
|
|
53
187
|
|
|
54
188
|
/** Запись живого острова: имя + фактический состав его контейнера. */
|
|
55
189
|
interface IslandRecord {
|
|
@@ -108,51 +242,28 @@ declare function getAppContainer(): Container;
|
|
|
108
242
|
*/
|
|
109
243
|
declare function slotAddress(app: string, slot: string): string;
|
|
110
244
|
|
|
111
|
-
/**
|
|
112
|
-
interface
|
|
113
|
-
/**
|
|
114
|
-
|
|
245
|
+
/** Маршрут с политикой доступа. */
|
|
246
|
+
interface RouteDeclaration {
|
|
247
|
+
/** Regex-источник адреса (`'^/cabinet/billing'`, `'.*'`). */
|
|
248
|
+
source: string;
|
|
115
249
|
/**
|
|
116
|
-
*
|
|
117
|
-
*
|
|
118
|
-
*
|
|
119
|
-
* Таковы стили CSS-in-JS: стороннее представление у них одно — тег со служебными
|
|
120
|
-
* атрибутами, по которым клиентский рантайм узнаёт свои правила. Разобрав его на поля,
|
|
121
|
-
* потеряешь регидратацию, и стили впрыснутся вторым экземпляром. Поэтому вклад в документ
|
|
122
|
-
* ДАННЫМИ (`DocumentHead` у хостов) остаётся отдельным каналом, а это — разметка.
|
|
123
|
-
*
|
|
124
|
-
* Разметка приезжает в документ хоста ДОСЛОВНО, без экранирования — иначе служебные
|
|
125
|
-
* атрибуты не пережили бы вставку. Отвечает за содержимое приложение: у сетевого
|
|
126
|
-
* транспорта строка приходит из чужого процесса, и хост её не разбирает.
|
|
250
|
+
* Guard-ы этого маршрута — поверх guard-ов приложения и хоста. Пусто — маршрут открыт
|
|
251
|
+
* настолько, насколько открыто само приложение.
|
|
127
252
|
*/
|
|
128
|
-
|
|
253
|
+
guards?: ReadonlyArray<GuardDefinition>;
|
|
129
254
|
}
|
|
130
|
-
/** Рендер дерева в разметку. Его даёт тот, кто серверный рендер исполняет. */
|
|
131
|
-
type RenderTree<Tree = unknown> = (tree: Tree) => string;
|
|
132
255
|
/**
|
|
133
|
-
*
|
|
134
|
-
*
|
|
135
|
-
*
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
*
|
|
140
|
-
*
|
|
141
|
-
* Подпись одна на оба транспорта, и в этом смысл: у приложения в процессе хоста рендер
|
|
142
|
-
* передаёт хост, у сетевого — его собственный сервер, а `html` и `head` едут ответом.
|
|
143
|
-
* Перевод приложения между транспортами эту часть не задевает.
|
|
144
|
-
*
|
|
145
|
-
* `Tree` — дерево view-фреймворка, для ядра непрозрачное. View-адаптер сужает параметр
|
|
146
|
-
* до своего типа (`ReactServerRender` в `@foxford/den-react`), и приложение пишет проход
|
|
147
|
-
* в терминах СВОЕГО фреймворка.
|
|
148
|
-
*
|
|
149
|
-
* @example
|
|
150
|
-
* serverRender: (tree, render) => {
|
|
151
|
-
* const sheet = new ServerStyleSheet()
|
|
256
|
+
* Заявка на адрес: голая строка — публичный маршрут, объект — маршрут со своей политикой.
|
|
257
|
+
* Обе формы лежат в одном массиве, и порядок значим так же, как раньше: хост раздаёт путь
|
|
258
|
+
* первому заявившему, поэтому частные записи ставятся выше общих.
|
|
259
|
+
*/
|
|
260
|
+
type AppRoute = string | RouteDeclaration;
|
|
261
|
+
/**
|
|
262
|
+
* Приводит заявки к одной форме — чтобы хост и dev-инструменты не разбирали union каждый сам.
|
|
152
263
|
*
|
|
153
|
-
*
|
|
154
|
-
*
|
|
264
|
+
* @param routes - Заявки приложения (строки и/или записи)
|
|
265
|
+
* @returns Записи маршрутов в порядке объявления
|
|
155
266
|
*/
|
|
156
|
-
|
|
267
|
+
declare function normalizeRoutes(routes?: ReadonlyArray<AppRoute>): RouteDeclaration[];
|
|
157
268
|
|
|
158
|
-
export { type CreateIslandContainerOptions, IslandDescriptor, type IslandRecord, type
|
|
269
|
+
export { type AppRoute, type CreateIslandContainerOptions, type DocumentContribution, type DocumentHead, type DocumentSource, IslandDescriptor, type IslandRecord, type IslandRoute, type RenderAppRequest, type RenderAppResult, type RouteDeclaration, activateIslandViewModels, collectDocumentContribution, collectIslandState, createIslandContainer, describeIsland, getAppContainer, getIslandsSnapshot, hydrateIslandState, isDocumentSource, normalizeRoutes, registerIsland, renderApp, resolveEagerUnits, slotAddress, subscribeIslands };
|
package/island/index.js
CHANGED
|
@@ -2,16 +2,22 @@ import {
|
|
|
2
2
|
ViewLayerToken,
|
|
3
3
|
resolveViewAdapter,
|
|
4
4
|
viewAdapterOf
|
|
5
|
-
} from "../chunk-
|
|
5
|
+
} from "../chunk-E23E2VUC.js";
|
|
6
6
|
import {
|
|
7
7
|
LoggerToken,
|
|
8
8
|
logger,
|
|
9
9
|
unitLogger
|
|
10
10
|
} from "../chunk-TPBI6TOU.js";
|
|
11
11
|
import {
|
|
12
|
+
__async,
|
|
12
13
|
__spreadValues
|
|
13
14
|
} from "../chunk-HJO26HIQ.js";
|
|
14
15
|
|
|
16
|
+
// src/island/document.ts
|
|
17
|
+
function isDocumentSource(value) {
|
|
18
|
+
return typeof value === "object" && value !== null && typeof value.describeDocument === "function";
|
|
19
|
+
}
|
|
20
|
+
|
|
15
21
|
// src/island/lifecycle.ts
|
|
16
22
|
import { log } from "@foxford/logger";
|
|
17
23
|
|
|
@@ -28,6 +34,8 @@ function getAppContainer() {
|
|
|
28
34
|
}
|
|
29
35
|
|
|
30
36
|
// src/island/lifecycle.ts
|
|
37
|
+
var EMPTY_ROUTE = { params: {}, pathname: "", search: "" };
|
|
38
|
+
var REDIRECT_FOUND = 302;
|
|
31
39
|
function createIslandContainer(descriptor, options = {}) {
|
|
32
40
|
var _a, _b, _c, _d, _e;
|
|
33
41
|
const { parent = getAppContainer() } = options;
|
|
@@ -68,15 +76,95 @@ function hydrateIslandState(container, descriptor, denState) {
|
|
|
68
76
|
}
|
|
69
77
|
}
|
|
70
78
|
}
|
|
71
|
-
function activateIslandViewModels(
|
|
79
|
+
function activateIslandViewModels(_0, _1) {
|
|
80
|
+
return __async(this, arguments, function* (container, descriptor, route = EMPTY_ROUTE) {
|
|
81
|
+
var _a;
|
|
82
|
+
yield Promise.all(
|
|
83
|
+
((_a = descriptor.viewModels) != null ? _a : []).map((vm) => __async(null, null, function* () {
|
|
84
|
+
var _a2;
|
|
85
|
+
const instance = container.resolve(vm.token);
|
|
86
|
+
unitLogger(container, vm.token.description).debug(`\u0430\u043A\u0442\u0438\u0432\u0430\u0446\u0438\u044F VM (${route.pathname || "\u2014"})`);
|
|
87
|
+
yield (_a2 = instance.activate) == null ? void 0 : _a2.call(instance, route);
|
|
88
|
+
}))
|
|
89
|
+
);
|
|
90
|
+
});
|
|
91
|
+
}
|
|
92
|
+
function collectIslandState(container, descriptor) {
|
|
72
93
|
var _a, _b;
|
|
94
|
+
const state = {};
|
|
73
95
|
for (const vm of (_a = descriptor.viewModels) != null ? _a : []) {
|
|
74
96
|
const instance = container.resolve(vm.token);
|
|
75
|
-
|
|
76
|
-
|
|
97
|
+
if (typeof ((_b = instance.state) == null ? void 0 : _b.get) === "function") {
|
|
98
|
+
state[vm.token.description] = instance.state.get();
|
|
99
|
+
}
|
|
100
|
+
}
|
|
101
|
+
return state;
|
|
102
|
+
}
|
|
103
|
+
function collectDocumentContribution(container, descriptor) {
|
|
104
|
+
var _a, _b;
|
|
105
|
+
const contribution = {};
|
|
106
|
+
for (const vm of (_a = descriptor.viewModels) != null ? _a : []) {
|
|
107
|
+
const instance = container.resolve(vm.token);
|
|
108
|
+
if (!isDocumentSource(instance)) {
|
|
109
|
+
continue;
|
|
110
|
+
}
|
|
111
|
+
const part = instance.describeDocument();
|
|
112
|
+
if (part.head) {
|
|
113
|
+
contribution.head = __spreadValues(__spreadValues({}, contribution.head), part.head);
|
|
114
|
+
}
|
|
115
|
+
const declared = part.status !== void 0 || part.redirect !== void 0;
|
|
116
|
+
if (declared && contribution.status === void 0) {
|
|
117
|
+
contribution.status = (_b = part.status) != null ? _b : REDIRECT_FOUND;
|
|
118
|
+
contribution.redirect = part.redirect;
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
return contribution;
|
|
122
|
+
}
|
|
123
|
+
function resolveEagerUnits(container, descriptor) {
|
|
124
|
+
var _a;
|
|
125
|
+
for (const token of (_a = descriptor.eager) != null ? _a : []) {
|
|
126
|
+
const instance = container.resolve(token);
|
|
127
|
+
unitLogger(container, token.description).debug("eager: \u0435\u0434\u0438\u043D\u0438\u0446\u0430 \u043F\u043E\u0434\u043D\u044F\u0442\u0430 \u043F\u0440\u0438 \u043C\u043E\u043D\u0442\u0438\u0440\u043E\u0432\u0430\u043D\u0438\u0438");
|
|
128
|
+
if (instance instanceof Promise) {
|
|
129
|
+
instance.catch(
|
|
130
|
+
(error) => unitLogger(container, token.description).error("eager: \u0435\u0434\u0438\u043D\u0438\u0446\u0430 \u043D\u0435 \u043F\u043E\u0434\u043D\u044F\u043B\u0430\u0441\u044C", error)
|
|
131
|
+
);
|
|
132
|
+
}
|
|
77
133
|
}
|
|
78
134
|
}
|
|
79
135
|
|
|
136
|
+
// src/island/render.ts
|
|
137
|
+
var STATUS_OK = 200;
|
|
138
|
+
function renderApp(descriptor, request) {
|
|
139
|
+
return __async(this, null, function* () {
|
|
140
|
+
var _a, _b;
|
|
141
|
+
const route = {
|
|
142
|
+
params: (_a = request.params) != null ? _a : {},
|
|
143
|
+
pathname: request.pathname,
|
|
144
|
+
search: (_b = request.search) != null ? _b : ""
|
|
145
|
+
};
|
|
146
|
+
const container = createIslandContainer(descriptor, { parent: request.parent });
|
|
147
|
+
if (container === null) {
|
|
148
|
+
throw new Error(`den/island: \u043F\u0440\u0438\u043B\u043E\u0436\u0435\u043D\u0438\u0435 \xAB${descriptor.name}\xBB \u043D\u0435 \u0441\u043E\u0431\u0440\u0430\u043B\u043E\u0441\u044C \u2014 \u0440\u0435\u043D\u0434\u0435\u0440 \u043D\u0435\u0432\u043E\u0437\u043C\u043E\u0436\u0435\u043D`);
|
|
149
|
+
}
|
|
150
|
+
try {
|
|
151
|
+
yield activateIslandViewModels(container, descriptor, route);
|
|
152
|
+
const { head, redirect, status = STATUS_OK } = collectDocumentContribution(container, descriptor);
|
|
153
|
+
if (status !== STATUS_OK) {
|
|
154
|
+
return { head, html: "", redirect, state: {}, status };
|
|
155
|
+
}
|
|
156
|
+
const state = collectIslandState(container, descriptor);
|
|
157
|
+
const rendered = resolveViewAdapter(container).renderIsland(descriptor, {
|
|
158
|
+
container,
|
|
159
|
+
slots: request.slots
|
|
160
|
+
});
|
|
161
|
+
return { head, headHtml: rendered.head, html: rendered.html, state, status };
|
|
162
|
+
} finally {
|
|
163
|
+
yield container.dispose();
|
|
164
|
+
}
|
|
165
|
+
});
|
|
166
|
+
}
|
|
167
|
+
|
|
80
168
|
// src/island/slot-address.ts
|
|
81
169
|
function slotAddress(app, slot) {
|
|
82
170
|
return `${app}:${slot}`;
|
|
@@ -121,15 +209,26 @@ function describeIsland(descriptor, denState) {
|
|
|
121
209
|
viewModels: ((_b = descriptor.viewModels) != null ? _b : []).map((vm) => vm.token.description)
|
|
122
210
|
};
|
|
123
211
|
}
|
|
212
|
+
|
|
213
|
+
// src/island/routes.ts
|
|
214
|
+
function normalizeRoutes(routes = []) {
|
|
215
|
+
return routes.map((route) => typeof route === "string" ? { source: route } : route);
|
|
216
|
+
}
|
|
124
217
|
export {
|
|
125
218
|
ViewLayerToken,
|
|
126
219
|
activateIslandViewModels,
|
|
220
|
+
collectDocumentContribution,
|
|
221
|
+
collectIslandState,
|
|
127
222
|
createIslandContainer,
|
|
128
223
|
describeIsland,
|
|
129
224
|
getAppContainer,
|
|
130
225
|
getIslandsSnapshot,
|
|
131
226
|
hydrateIslandState,
|
|
227
|
+
isDocumentSource,
|
|
228
|
+
normalizeRoutes,
|
|
132
229
|
registerIsland,
|
|
230
|
+
renderApp,
|
|
231
|
+
resolveEagerUnits,
|
|
133
232
|
resolveViewAdapter,
|
|
134
233
|
slotAddress,
|
|
135
234
|
subscribeIslands,
|