@iconicompany/idossier-panel 0.0.0-stage → 0.2.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/README.md +84 -2
- package/package.json +38 -4
- package/src/DossierPanel.tsx +384 -0
- package/src/http-transport.ts +58 -0
- package/src/index.ts +21 -0
- package/src/labels.ts +49 -0
- package/src/testids.ts +19 -0
- package/src/types.ts +146 -0
package/README.md
CHANGED
|
@@ -1,3 +1,85 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @iconicompany/idossier-panel
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Панель досье idossier на странице любого продукта платформы: разделы и слоты схемы, статусы проверки,
|
|
4
|
+
недостающее поимённо, заведение досье и прикрепление файла в слот. Контракт — `docs/usecases/dossier-panel/panel.md`
|
|
5
|
+
(`AC-PNL-*`) в репозитории idossier.
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
bun add @iconicompany/idossier-panel
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
```tsx
|
|
12
|
+
import { DossierPanel } from "@iconicompany/idossier-panel";
|
|
13
|
+
|
|
14
|
+
<DossierPanel
|
|
15
|
+
owner={{ product: "acme", kind: "deal", key: deal.id }}
|
|
16
|
+
schema="application"
|
|
17
|
+
title={`Сделка ${deal.number}`}
|
|
18
|
+
canCreate
|
|
19
|
+
canEdit
|
|
20
|
+
/>;
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Настройка — у встраивающего
|
|
24
|
+
|
|
25
|
+
Панель не знает ни одного продукта. Всё, что зависит от потребителя, передаёт он сам:
|
|
26
|
+
|
|
27
|
+
| Свойство | Что это |
|
|
28
|
+
|---|---|
|
|
29
|
+
| `owner` | `{product, kind, key}` — запись продукта, к которой привязано досье. В досье уходит парой `ownerType = <product>:<kind>`, `ownerKey = key`. `product` и `kind` — `[a-z][a-z0-9-]{0,31}` |
|
|
30
|
+
| `schema` | код схемы досье в реестре idossier (`application`, `customer`, …): какие разделы и типы документов |
|
|
31
|
+
| `title` | подпись досье при заведении из панели |
|
|
32
|
+
| `labels` | подписи интерфейса (`attach`, `create`, `slot.verified`, …); непереданные — по умолчанию |
|
|
33
|
+
| `canCreate`, `canEdit` | показать «Завести досье» и «Прикрепить». Сервер idossier проверяет права сам, флаги только прячут кнопки |
|
|
34
|
+
| `code` | код досье, если продукт хранит его сам — тогда поиск по владельцу не нужен |
|
|
35
|
+
| `loginUrl` | куда вести, если нет сессии idossier (по умолчанию `/idossier/`) |
|
|
36
|
+
| `onChange` | вызывается после загрузки файла с кодом досье |
|
|
37
|
+
|
|
38
|
+
Новой схемы (своих типов документов) в idossier заводит сессия idossier — по заявке потребителя.
|
|
39
|
+
|
|
40
|
+
## Учётных данных пакет не держит
|
|
41
|
+
|
|
42
|
+
Транспорт по умолчанию ходит в `/idossier/api` того же домена с `credentials: "include"` — с кукой сессии
|
|
43
|
+
модуля, как `@iconicompany/iagent-chat`. Токена и абсолютного адреса в бандле нет. Человеку нужна роль проекта
|
|
44
|
+
idossier в ZITADEL с правами `dossier:read`, для заведения — `dossier:create`, для загрузки — `dossier:write`.
|
|
45
|
+
|
|
46
|
+
Свой транспорт (`transport`) — для особых случаев, например через сервер продукта:
|
|
47
|
+
|
|
48
|
+
```ts
|
|
49
|
+
interface DossierTransport {
|
|
50
|
+
composite(code: string): Promise<PanelDossier>;
|
|
51
|
+
find?(q: { ownerType: string; ownerKey: string; type: string }): Promise<string | null>;
|
|
52
|
+
create?(input: { type: string; ownerType: string; ownerKey: string; title?: string }): Promise<string>;
|
|
53
|
+
upload?(target: { dossierCode: string; sectionCode: string; typeCode: string }, file: File): Promise<void>;
|
|
54
|
+
}
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Отказ — `TransportError(status, message)`: 401 панель показывает входом, 403 — нехваткой прав, прочее — «недоступно».
|
|
58
|
+
|
|
59
|
+
## Исходы различимы
|
|
60
|
+
|
|
61
|
+
| Исход | Когда | Что видит оператор |
|
|
62
|
+
|---|---|---|
|
|
63
|
+
| `missing` | досье владельца нет | «Досье не создано» и «Завести досье» |
|
|
64
|
+
| `ready` | досье получено | разделы, слоты, статусы, недостающее, «Прикрепить» |
|
|
65
|
+
| `login` | 401 | «войдите» со ссылкой |
|
|
66
|
+
| `forbidden` | 403 | «нет прав» с причиной |
|
|
67
|
+
| `unavailable` | иной отказ | «Данные недоступны» с причиной |
|
|
68
|
+
|
|
69
|
+
Пустой список вместо `unavailable` читался бы как «документов не требуется», поэтому его нет.
|
|
70
|
+
|
|
71
|
+
## Оформление
|
|
72
|
+
|
|
73
|
+
Классы — токены кита Iconicompany (`bg-success/10`, `text-muted-foreground`): панель берёт тему страницы.
|
|
74
|
+
Подключите исходники в Tailwind:
|
|
75
|
+
|
|
76
|
+
```css
|
|
77
|
+
@source "../node_modules/@iconicompany/idossier-panel/src";
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
Пакет — исходники TypeScript без сборки, единственный peer — `react`. Позже переедет в `@icomponents`.
|
|
81
|
+
|
|
82
|
+
## Почему типы повторены, а не импортированы
|
|
83
|
+
|
|
84
|
+
Сервер досье тянет `drizzle-orm`, `elysia` и `pdf-lib` — в чужое приложение их не отдают. Расхождение двух описаний
|
|
85
|
+
ловит `packages/dossier/src/contract/panel-contract.test.ts` в репозитории idossier.
|
package/package.json
CHANGED
|
@@ -1,6 +1,40 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@iconicompany/idossier-panel",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"
|
|
5
|
-
"
|
|
6
|
-
|
|
3
|
+
"version": "0.2.0",
|
|
4
|
+
"description": "Панель досье idossier на странице продукта: документы записи, статусы проверки, прикрепление файла",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"repository": {
|
|
7
|
+
"type": "git",
|
|
8
|
+
"url": "git+https://github.com/iconicompany/idossier.git",
|
|
9
|
+
"directory": "packages/dossier-panel"
|
|
10
|
+
},
|
|
11
|
+
"type": "module",
|
|
12
|
+
"exports": {
|
|
13
|
+
".": "./src/index.ts"
|
|
14
|
+
},
|
|
15
|
+
"files": [
|
|
16
|
+
"src",
|
|
17
|
+
"!src/**/*.test.*",
|
|
18
|
+
"README.md"
|
|
19
|
+
],
|
|
20
|
+
"publishConfig": {
|
|
21
|
+
"access": "public"
|
|
22
|
+
},
|
|
23
|
+
"scripts": {
|
|
24
|
+
"type-check": "bunx tsc --noEmit",
|
|
25
|
+
"test": "bun test"
|
|
26
|
+
},
|
|
27
|
+
"peerDependencies": {
|
|
28
|
+
"react": "^19"
|
|
29
|
+
},
|
|
30
|
+
"devDependencies": {
|
|
31
|
+
"@happy-dom/global-registrator": "^21.0.4",
|
|
32
|
+
"@stack/typescript-config": "workspace:*",
|
|
33
|
+
"@testing-library/dom": "^10.4.2",
|
|
34
|
+
"@testing-library/react": "^16.3.3",
|
|
35
|
+
"@types/bun": "1.4.0",
|
|
36
|
+
"@types/react": "19.3.0",
|
|
37
|
+
"happy-dom": "^21.0.4",
|
|
38
|
+
"typescript": "7.0.2"
|
|
39
|
+
}
|
|
40
|
+
}
|
|
@@ -0,0 +1,384 @@
|
|
|
1
|
+
import { useCallback, useEffect, useMemo, useRef, useState, type ReactNode } from "react";
|
|
2
|
+
|
|
3
|
+
import { createHttpTransport } from "./http-transport";
|
|
4
|
+
import { DEFAULT_LABELS, type PanelLabels } from "./labels";
|
|
5
|
+
import { PANEL_TESTID as T } from "./testids";
|
|
6
|
+
import {
|
|
7
|
+
ownerTypeOf,
|
|
8
|
+
TransportError,
|
|
9
|
+
type DossierTransport,
|
|
10
|
+
type PanelOwner,
|
|
11
|
+
type PanelSection,
|
|
12
|
+
type PanelSlot,
|
|
13
|
+
type PanelState,
|
|
14
|
+
type SlotState,
|
|
15
|
+
} from "./types";
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* ПАНЕЛЬ ДОСЬЕ НА ЭКРАНЕ ПРОДУКТА ПЛАТФОРМЫ: разделы, слоты, статусы проверки и недостающее, а при
|
|
19
|
+
* `canEdit` — прикрепление файла в слот. О потребителях панель не знает: владелец — непрозрачный
|
|
20
|
+
* `{product, kind, key}`, схема и подписи — настройка встраивающего.
|
|
21
|
+
*/
|
|
22
|
+
|
|
23
|
+
type Tone = "success" | "info" | "neutral" | "warning" | "danger" | "muted";
|
|
24
|
+
|
|
25
|
+
/** Тона — токены темы кита (`bg-success/10 text-success`), без литералов цвета: панель в теме страницы. */
|
|
26
|
+
const TONE_CLASS: Record<Tone, string> = {
|
|
27
|
+
success: "bg-success/10 text-success",
|
|
28
|
+
info: "bg-primary/10 text-primary",
|
|
29
|
+
neutral: "bg-secondary-foreground/10 text-secondary-foreground",
|
|
30
|
+
warning: "bg-warning/10 text-warning",
|
|
31
|
+
danger: "bg-destructive/10 text-destructive",
|
|
32
|
+
muted: "bg-muted-foreground/10 text-muted-foreground",
|
|
33
|
+
};
|
|
34
|
+
|
|
35
|
+
/** Один тон на состояние. Список закрыт: новое состояние обязано получить тон, а не молча стать серым. */
|
|
36
|
+
const SLOT_TONE: Record<SlotState, Tone> = {
|
|
37
|
+
empty: "muted",
|
|
38
|
+
pending: "warning",
|
|
39
|
+
verified: "success",
|
|
40
|
+
rejected: "danger",
|
|
41
|
+
};
|
|
42
|
+
|
|
43
|
+
export interface DossierPanelProps {
|
|
44
|
+
/** Код досье, если он известен хозяину экрана. `null` — досье не привязано. */
|
|
45
|
+
code?: string | null;
|
|
46
|
+
/** Владелец досье — запись встраивающего продукта. Вместе с `schema` панель находит досье сама. */
|
|
47
|
+
owner?: PanelOwner;
|
|
48
|
+
/** Код схемы (тип) досье в реестре idossier. Нужен вместе с `owner`. */
|
|
49
|
+
schema?: string;
|
|
50
|
+
/** Подпись досье при заведении из панели. */
|
|
51
|
+
title?: string;
|
|
52
|
+
/** Транспорт. По умолчанию — `/idossier/api` того же домена с кукой сессии модуля. */
|
|
53
|
+
transport?: DossierTransport;
|
|
54
|
+
/** Показать «Завести досье», когда досье владельца нет. */
|
|
55
|
+
canCreate?: boolean;
|
|
56
|
+
/** Показать «Прикрепить» у слотов, которые можно править. */
|
|
57
|
+
canEdit?: boolean;
|
|
58
|
+
/** Подписи интерфейса; непереданные — по умолчанию. */
|
|
59
|
+
labels?: Partial<PanelLabels>;
|
|
60
|
+
/** Куда вести на вход, если сессии модуля нет. */
|
|
61
|
+
loginUrl?: string;
|
|
62
|
+
/** После загрузки файла: код досье, в которое он лёг. */
|
|
63
|
+
onChange?: (code: string) => void;
|
|
64
|
+
className?: string;
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
let defaultTransport: DossierTransport | null = null;
|
|
68
|
+
const fallbackTransport = () => (defaultTransport ??= createHttpTransport());
|
|
69
|
+
|
|
70
|
+
export function DossierPanel({
|
|
71
|
+
code,
|
|
72
|
+
owner,
|
|
73
|
+
schema,
|
|
74
|
+
title,
|
|
75
|
+
transport: given,
|
|
76
|
+
canCreate = false,
|
|
77
|
+
canEdit = false,
|
|
78
|
+
labels: overrides,
|
|
79
|
+
loginUrl = "/idossier/",
|
|
80
|
+
onChange,
|
|
81
|
+
className = "",
|
|
82
|
+
}: DossierPanelProps) {
|
|
83
|
+
// Транспорт держится в ref: новый объект на каждый рендер (`transport={createHttpTransport()}`)
|
|
84
|
+
// не перезапускает загрузку, иначе запросы шли бы по кругу.
|
|
85
|
+
const transportRef = useRef(given ?? fallbackTransport());
|
|
86
|
+
transportRef.current = given ?? fallbackTransport();
|
|
87
|
+
const transport = transportRef.current;
|
|
88
|
+
const labels = useMemo(() => ({ ...DEFAULT_LABELS, ...overrides }), [overrides]);
|
|
89
|
+
const ownerType = owner && schema ? ownerTypeOf(owner) : null;
|
|
90
|
+
const ownerKey = owner && schema ? owner.key : null;
|
|
91
|
+
|
|
92
|
+
const [state, setState] = useState<PanelState>({ kind: "loading" });
|
|
93
|
+
const [reload, setReload] = useState(0);
|
|
94
|
+
const [creating, setCreating] = useState(false);
|
|
95
|
+
/** Код, полученный заведением: досье может не находиться поиском (вне охвата), но оно уже есть. */
|
|
96
|
+
const [createdCode, setCreatedCode] = useState<string | null>(null);
|
|
97
|
+
const target = `${code ?? ""}|${ownerType ?? ""}|${ownerKey ?? ""}|${schema ?? ""}`;
|
|
98
|
+
|
|
99
|
+
// Сменилось досье — прежнее больше не показывается: «Прикрепить» у него положил бы файл не туда.
|
|
100
|
+
useEffect(() => {
|
|
101
|
+
setState({ kind: "loading" });
|
|
102
|
+
setCreatedCode(null);
|
|
103
|
+
}, [target]);
|
|
104
|
+
|
|
105
|
+
useEffect(() => {
|
|
106
|
+
// Отменяется по размонтированию и по смене досье: ответ на прошлое досье не должен перерисовать
|
|
107
|
+
// панель, уже показывающую другое.
|
|
108
|
+
let live = true;
|
|
109
|
+
const settle = (next: PanelState) => {
|
|
110
|
+
if (live) setState(next);
|
|
111
|
+
};
|
|
112
|
+
const transport = transportRef.current;
|
|
113
|
+
void (async () => {
|
|
114
|
+
try {
|
|
115
|
+
let target = code ?? createdCode;
|
|
116
|
+
if (target === null && ownerType !== null && ownerKey !== null && schema) {
|
|
117
|
+
if (!transport.find) throw new Error("транспорт не умеет искать досье по владельцу");
|
|
118
|
+
target = await transport.find({ ownerType, ownerKey, type: schema });
|
|
119
|
+
if (target === null) return settle({ kind: "missing" });
|
|
120
|
+
}
|
|
121
|
+
if (target === null) return settle({ kind: "unlinked" });
|
|
122
|
+
settle({ kind: "ready", dossier: await transport.composite(target) });
|
|
123
|
+
} catch (err) {
|
|
124
|
+
settle(failureOf(err));
|
|
125
|
+
}
|
|
126
|
+
})();
|
|
127
|
+
return () => {
|
|
128
|
+
live = false;
|
|
129
|
+
};
|
|
130
|
+
}, [code, ownerType, ownerKey, schema, createdCode, reload]);
|
|
131
|
+
|
|
132
|
+
const refresh = useCallback(() => setReload((n) => n + 1), []);
|
|
133
|
+
|
|
134
|
+
const create = async () => {
|
|
135
|
+
if (!transport.create || ownerType === null || ownerKey === null || !schema) return;
|
|
136
|
+
setCreating(true);
|
|
137
|
+
try {
|
|
138
|
+
setCreatedCode(
|
|
139
|
+
await transport.create({ type: schema, ownerType, ownerKey, ...(title ? { title } : {}) })
|
|
140
|
+
);
|
|
141
|
+
} catch (err) {
|
|
142
|
+
setState(failureOf(err));
|
|
143
|
+
} finally {
|
|
144
|
+
setCreating(false);
|
|
145
|
+
}
|
|
146
|
+
};
|
|
147
|
+
|
|
148
|
+
const wrap = (node: ReactNode) => <div className={className}>{node}</div>;
|
|
149
|
+
|
|
150
|
+
switch (state.kind) {
|
|
151
|
+
case "unlinked":
|
|
152
|
+
return wrap(<Note testid={T.unlinked}>{labels.unlinked}</Note>);
|
|
153
|
+
case "loading":
|
|
154
|
+
return wrap(<Note testid={T.loading}>{labels.loading}</Note>);
|
|
155
|
+
case "unavailable":
|
|
156
|
+
return wrap(
|
|
157
|
+
<Note testid={T.unavailable} tone="danger">
|
|
158
|
+
{labels.unavailable(state.reason)}
|
|
159
|
+
</Note>
|
|
160
|
+
);
|
|
161
|
+
case "forbidden":
|
|
162
|
+
return wrap(
|
|
163
|
+
<Note testid={T.forbidden} tone="warning">
|
|
164
|
+
{labels.forbidden(state.reason)}
|
|
165
|
+
</Note>
|
|
166
|
+
);
|
|
167
|
+
case "login":
|
|
168
|
+
return wrap(
|
|
169
|
+
<p data-testid={T.login} className="flex items-center gap-2 text-sm">
|
|
170
|
+
<Badge tone="warning">{labels.login}</Badge>
|
|
171
|
+
<a href={loginUrl} className="text-primary underline" data-testid={T.loginLink}>
|
|
172
|
+
{labels.loginAction}
|
|
173
|
+
</a>
|
|
174
|
+
</p>
|
|
175
|
+
);
|
|
176
|
+
case "missing":
|
|
177
|
+
return wrap(
|
|
178
|
+
<div data-testid={T.missing} className="flex items-center gap-2 text-sm">
|
|
179
|
+
<Badge tone="muted">{labels.notCreated}</Badge>
|
|
180
|
+
{canCreate && transport.create && (
|
|
181
|
+
<button
|
|
182
|
+
type="button"
|
|
183
|
+
data-testid={T.create}
|
|
184
|
+
disabled={creating}
|
|
185
|
+
onClick={() => void create()}
|
|
186
|
+
className="rounded-md bg-primary px-3 py-1 text-sm text-primary-foreground disabled:opacity-50"
|
|
187
|
+
>
|
|
188
|
+
{creating ? labels.creating : labels.create}
|
|
189
|
+
</button>
|
|
190
|
+
)}
|
|
191
|
+
</div>
|
|
192
|
+
);
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
const { dossier } = state;
|
|
196
|
+
const upload = transport.upload;
|
|
197
|
+
const uploader: Upload =
|
|
198
|
+
canEdit && upload
|
|
199
|
+
? async (slot, dossierCode, file) => {
|
|
200
|
+
await upload(
|
|
201
|
+
{ dossierCode, sectionCode: slot.sectionCode, typeCode: slot.typeCode },
|
|
202
|
+
file
|
|
203
|
+
);
|
|
204
|
+
refresh();
|
|
205
|
+
onChange?.(dossierCode);
|
|
206
|
+
}
|
|
207
|
+
: null;
|
|
208
|
+
|
|
209
|
+
return wrap(
|
|
210
|
+
<section data-testid={T.panel} className="flex flex-col gap-4">
|
|
211
|
+
<header className="flex items-center gap-2">
|
|
212
|
+
<span className="text-sm font-medium">
|
|
213
|
+
{labels.dossier} {dossier.code}
|
|
214
|
+
</span>
|
|
215
|
+
<Badge tone={dossier.complete ? "success" : "warning"}>
|
|
216
|
+
{dossier.complete ? labels.complete : labels.missing(dossier.missingCount)}
|
|
217
|
+
</Badge>
|
|
218
|
+
</header>
|
|
219
|
+
{dossier.sections.map((section) => (
|
|
220
|
+
<Section
|
|
221
|
+
key={`${section.sourceDossierCode}:${section.code}`}
|
|
222
|
+
section={section}
|
|
223
|
+
labels={labels}
|
|
224
|
+
upload={uploader}
|
|
225
|
+
/>
|
|
226
|
+
))}
|
|
227
|
+
</section>
|
|
228
|
+
);
|
|
229
|
+
}
|
|
230
|
+
|
|
231
|
+
type Upload = ((slot: PanelSlot, dossierCode: string, file: File) => Promise<void>) | null;
|
|
232
|
+
|
|
233
|
+
function Section({
|
|
234
|
+
section,
|
|
235
|
+
labels,
|
|
236
|
+
upload,
|
|
237
|
+
}: {
|
|
238
|
+
section: PanelSection;
|
|
239
|
+
labels: PanelLabels;
|
|
240
|
+
upload: Upload;
|
|
241
|
+
}) {
|
|
242
|
+
return (
|
|
243
|
+
<div data-testid={T.section(section.code)} className="flex flex-col gap-2">
|
|
244
|
+
<div className="flex items-center gap-2">
|
|
245
|
+
<h3 className="text-sm font-medium">{section.title}</h3>
|
|
246
|
+
{section.sourceDossierTitle !== null && (
|
|
247
|
+
// Двух ДОЧЕРНИХ одного типа различает только подпись источника.
|
|
248
|
+
<span className="text-muted-foreground text-xs">{section.sourceDossierTitle}</span>
|
|
249
|
+
)}
|
|
250
|
+
{!section.countsToCompleteness && <Badge tone="neutral">{labels.notCounted}</Badge>}
|
|
251
|
+
</div>
|
|
252
|
+
|
|
253
|
+
{section.hidden ? (
|
|
254
|
+
<Note testid={T.sectionHidden(section.code)}>
|
|
255
|
+
{labels.sectionHidden(section.hiddenReason)}
|
|
256
|
+
</Note>
|
|
257
|
+
) : section.absent ? (
|
|
258
|
+
<Note testid={T.sectionAbsent(section.code)}>{labels.sectionAbsent}</Note>
|
|
259
|
+
) : (
|
|
260
|
+
<ul className="flex flex-col gap-1">
|
|
261
|
+
{section.slots
|
|
262
|
+
.filter((slot) => slot.visible)
|
|
263
|
+
.map((slot) => (
|
|
264
|
+
<Slot
|
|
265
|
+
key={slot.typeCode}
|
|
266
|
+
slot={slot}
|
|
267
|
+
labels={labels}
|
|
268
|
+
// Файл ложится в досье-источник раздела: раздел дочернего — в дочернее.
|
|
269
|
+
upload={
|
|
270
|
+
upload && section.writable
|
|
271
|
+
? (file) => upload(slot, section.sourceDossierCode, file)
|
|
272
|
+
: null
|
|
273
|
+
}
|
|
274
|
+
/>
|
|
275
|
+
))}
|
|
276
|
+
</ul>
|
|
277
|
+
)}
|
|
278
|
+
</div>
|
|
279
|
+
);
|
|
280
|
+
}
|
|
281
|
+
|
|
282
|
+
function Slot({
|
|
283
|
+
slot,
|
|
284
|
+
labels,
|
|
285
|
+
upload,
|
|
286
|
+
}: {
|
|
287
|
+
slot: PanelSlot;
|
|
288
|
+
labels: PanelLabels;
|
|
289
|
+
upload: ((file: File) => Promise<void>) | null;
|
|
290
|
+
}) {
|
|
291
|
+
const input = useRef<HTMLInputElement>(null);
|
|
292
|
+
const [busy, setBusy] = useState(false);
|
|
293
|
+
const [error, setError] = useState<string | null>(null);
|
|
294
|
+
|
|
295
|
+
const send = async (file: File | undefined) => {
|
|
296
|
+
if (!file || !upload) return;
|
|
297
|
+
setBusy(true);
|
|
298
|
+
setError(null);
|
|
299
|
+
try {
|
|
300
|
+
await upload(file);
|
|
301
|
+
} catch (err) {
|
|
302
|
+
// Отказ остаётся у слота: статус прежний, оператор видит, почему файл не принят.
|
|
303
|
+
setError(messageOf(err));
|
|
304
|
+
} finally {
|
|
305
|
+
setBusy(false);
|
|
306
|
+
if (input.current) input.current.value = "";
|
|
307
|
+
}
|
|
308
|
+
};
|
|
309
|
+
|
|
310
|
+
return (
|
|
311
|
+
<li data-testid={T.slot(slot.typeCode)} className="flex flex-wrap items-center gap-2 text-sm">
|
|
312
|
+
<span>{slot.typeName}</span>
|
|
313
|
+
{slot.required && slot.state === "empty" && <Badge tone="danger">{labels.required}</Badge>}
|
|
314
|
+
<Badge tone={SLOT_TONE[slot.state]}>{labels.slot[slot.state]}</Badge>
|
|
315
|
+
{/* Отказ обязан назвать причину: без неё оператор не знает, что нести заново. */}
|
|
316
|
+
{slot.state === "rejected" && slot.reviewReason !== null && (
|
|
317
|
+
<span className="text-muted-foreground text-xs">{slot.reviewReason}</span>
|
|
318
|
+
)}
|
|
319
|
+
{slot.retired && <Badge tone="neutral">{labels.retired}</Badge>}
|
|
320
|
+
{upload &&
|
|
321
|
+
(slot.editable ? (
|
|
322
|
+
<label className="cursor-pointer text-primary text-xs underline">
|
|
323
|
+
{busy ? labels.uploading : labels.attach}
|
|
324
|
+
<input
|
|
325
|
+
ref={input}
|
|
326
|
+
type="file"
|
|
327
|
+
className="sr-only"
|
|
328
|
+
data-testid={T.attach(slot.typeCode)}
|
|
329
|
+
disabled={busy}
|
|
330
|
+
accept={slot.accept.map((ext) => `.${ext}`).join(",")}
|
|
331
|
+
onChange={(e) => void send(e.currentTarget.files?.[0])}
|
|
332
|
+
/>
|
|
333
|
+
</label>
|
|
334
|
+
) : (
|
|
335
|
+
slot.editableReason !== null && (
|
|
336
|
+
<span className="text-muted-foreground text-xs" data-testid={T.locked(slot.typeCode)}>
|
|
337
|
+
{slot.editableReason}
|
|
338
|
+
</span>
|
|
339
|
+
)
|
|
340
|
+
))}
|
|
341
|
+
{error !== null && (
|
|
342
|
+
<span className="text-destructive text-xs" data-testid={T.uploadError(slot.typeCode)}>
|
|
343
|
+
{error}
|
|
344
|
+
</span>
|
|
345
|
+
)}
|
|
346
|
+
</li>
|
|
347
|
+
);
|
|
348
|
+
}
|
|
349
|
+
|
|
350
|
+
function Badge({ tone, children }: { tone: Tone; children: ReactNode }) {
|
|
351
|
+
return (
|
|
352
|
+
<span
|
|
353
|
+
className={`inline-flex w-fit items-center gap-1.5 rounded-md px-2 py-0.5 text-xs font-medium ${TONE_CLASS[tone]}`}
|
|
354
|
+
>
|
|
355
|
+
{children}
|
|
356
|
+
</span>
|
|
357
|
+
);
|
|
358
|
+
}
|
|
359
|
+
|
|
360
|
+
function Note({
|
|
361
|
+
children,
|
|
362
|
+
testid,
|
|
363
|
+
tone = "muted",
|
|
364
|
+
}: {
|
|
365
|
+
children: ReactNode;
|
|
366
|
+
testid: string;
|
|
367
|
+
tone?: Tone;
|
|
368
|
+
}) {
|
|
369
|
+
return (
|
|
370
|
+
<p data-testid={testid} className="text-sm">
|
|
371
|
+
<Badge tone={tone}>{children}</Badge>
|
|
372
|
+
</p>
|
|
373
|
+
);
|
|
374
|
+
}
|
|
375
|
+
|
|
376
|
+
function failureOf(err: unknown): PanelState {
|
|
377
|
+
if (err instanceof TransportError && err.status === 401) return { kind: "login" };
|
|
378
|
+
if (err instanceof TransportError && err.status === 403)
|
|
379
|
+
return { kind: "forbidden", reason: err.message };
|
|
380
|
+
return { kind: "unavailable", reason: messageOf(err) };
|
|
381
|
+
}
|
|
382
|
+
|
|
383
|
+
const messageOf = (err: unknown): string =>
|
|
384
|
+
err instanceof Error && err.message !== "" ? err.message : "связь с досье не установлена";
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
import { TransportError, type DossierTransport, type PanelDossier, type SlotTarget } from "./types";
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Транспорт по умолчанию: ручки модуля досье на ТОМ ЖЕ домене (`/idossier/api`) с кукой его сессии.
|
|
5
|
+
* Токена и абсолютного адреса здесь нет: кто вызывает, сервер досье берёт из своей сессии.
|
|
6
|
+
*/
|
|
7
|
+
export interface HttpTransportOptions {
|
|
8
|
+
/** Префикс API модуля досье. По умолчанию `/idossier/api`. */
|
|
9
|
+
api?: string;
|
|
10
|
+
/** Подмена `fetch` — для тестов и особых окружений. */
|
|
11
|
+
fetch?: typeof fetch;
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
export function createHttpTransport(options: HttpTransportOptions = {}): DossierTransport {
|
|
15
|
+
const api = (options.api ?? "/idossier/api").replace(/\/+$/, "");
|
|
16
|
+
const call = async <T>(path: string, init: RequestInit = {}): Promise<T> => {
|
|
17
|
+
const doFetch = options.fetch ?? globalThis.fetch;
|
|
18
|
+
const res = await doFetch(`${api}${path}`, { ...init, credentials: "include" });
|
|
19
|
+
if (!res.ok) throw new TransportError(res.status, await reasonOf(res));
|
|
20
|
+
return (await res.json()) as T;
|
|
21
|
+
};
|
|
22
|
+
const enc = encodeURIComponent;
|
|
23
|
+
|
|
24
|
+
return {
|
|
25
|
+
composite: (code) => call<PanelDossier>(`/dossiers/${enc(code)}/composite`),
|
|
26
|
+
async find({ ownerType, ownerKey, type }) {
|
|
27
|
+
const q = new URLSearchParams({ ownerType, ownerKey, type, limit: "1" });
|
|
28
|
+
const page = await call<{ items: { code: string }[] }>(`/dossiers?${q}`);
|
|
29
|
+
return page.items[0]?.code ?? null;
|
|
30
|
+
},
|
|
31
|
+
async create(input) {
|
|
32
|
+
const created = await call<{ code: string }>("/dossiers", {
|
|
33
|
+
method: "POST",
|
|
34
|
+
headers: { "content-type": "application/json" },
|
|
35
|
+
body: JSON.stringify(input),
|
|
36
|
+
});
|
|
37
|
+
return created.code;
|
|
38
|
+
},
|
|
39
|
+
async upload(target: SlotTarget, file: File) {
|
|
40
|
+
const form = new FormData();
|
|
41
|
+
form.set("sectionCode", target.sectionCode);
|
|
42
|
+
form.set("typeCode", target.typeCode);
|
|
43
|
+
form.set("file", file);
|
|
44
|
+
await call(`/dossiers/${enc(target.dossierCode)}/documents`, { method: "POST", body: form });
|
|
45
|
+
},
|
|
46
|
+
};
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
/** Причина отказа для человека: `message` ответа модуля, иначе статус. */
|
|
50
|
+
async function reasonOf(res: Response): Promise<string> {
|
|
51
|
+
try {
|
|
52
|
+
const body = (await res.json()) as { message?: unknown };
|
|
53
|
+
if (typeof body.message === "string" && body.message !== "") return body.message;
|
|
54
|
+
} catch {
|
|
55
|
+
// Тело не JSON — причина остаётся статусом.
|
|
56
|
+
}
|
|
57
|
+
return `ответ ${res.status}`;
|
|
58
|
+
}
|
package/src/index.ts
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
export { DossierPanel, type DossierPanelProps } from "./DossierPanel";
|
|
2
|
+
export { createHttpTransport, type HttpTransportOptions } from "./http-transport";
|
|
3
|
+
export { DEFAULT_LABELS, type PanelLabels } from "./labels";
|
|
4
|
+
export { PANEL_TESTID } from "./testids";
|
|
5
|
+
export {
|
|
6
|
+
DOSSIER_LINK_KINDS,
|
|
7
|
+
ownerTypeOf,
|
|
8
|
+
SECTION_ORIGINS,
|
|
9
|
+
SLOT_STATES,
|
|
10
|
+
TransportError,
|
|
11
|
+
type DossierLinkKind,
|
|
12
|
+
type DossierTransport,
|
|
13
|
+
type PanelDossier,
|
|
14
|
+
type PanelOwner,
|
|
15
|
+
type PanelSection,
|
|
16
|
+
type PanelSlot,
|
|
17
|
+
type PanelState,
|
|
18
|
+
type SectionOrigin,
|
|
19
|
+
type SlotState,
|
|
20
|
+
type SlotTarget,
|
|
21
|
+
} from "./types";
|
package/src/labels.ts
ADDED
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
import type { SlotState } from "./types";
|
|
2
|
+
|
|
3
|
+
/** Подписи панели. Встраивающий переопределяет любые (`labels`), остальные — эти. */
|
|
4
|
+
export interface PanelLabels {
|
|
5
|
+
dossier: string;
|
|
6
|
+
complete: string;
|
|
7
|
+
missing: (count: number) => string;
|
|
8
|
+
unlinked: string;
|
|
9
|
+
notCreated: string;
|
|
10
|
+
create: string;
|
|
11
|
+
creating: string;
|
|
12
|
+
loading: string;
|
|
13
|
+
unavailable: (reason: string) => string;
|
|
14
|
+
login: string;
|
|
15
|
+
loginAction: string;
|
|
16
|
+
forbidden: (reason: string) => string;
|
|
17
|
+
attach: string;
|
|
18
|
+
uploading: string;
|
|
19
|
+
required: string;
|
|
20
|
+
retired: string;
|
|
21
|
+
notCounted: string;
|
|
22
|
+
sectionHidden: (reason: string | null) => string;
|
|
23
|
+
sectionAbsent: string;
|
|
24
|
+
slot: Record<SlotState, string>;
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
export const DEFAULT_LABELS: PanelLabels = {
|
|
28
|
+
dossier: "Досье",
|
|
29
|
+
complete: "Полное",
|
|
30
|
+
missing: (count) => `Недостаёт: ${count}`,
|
|
31
|
+
unlinked: "Досье не создано. Документы появятся здесь после привязки.",
|
|
32
|
+
notCreated: "Досье не создано.",
|
|
33
|
+
create: "Завести досье",
|
|
34
|
+
creating: "Заводим…",
|
|
35
|
+
loading: "Загрузка досье…",
|
|
36
|
+
unavailable: (reason) =>
|
|
37
|
+
`Данные досье сейчас недоступны: ${reason}. Список документов не показан — это не значит, что документов нет.`,
|
|
38
|
+
login: "Чтобы видеть документы, войдите в модуль досье.",
|
|
39
|
+
loginAction: "Войти",
|
|
40
|
+
forbidden: (reason) => `Нет прав на досье: ${reason}.`,
|
|
41
|
+
attach: "Прикрепить",
|
|
42
|
+
uploading: "Загрузка…",
|
|
43
|
+
required: "обязателен",
|
|
44
|
+
retired: "тип снят",
|
|
45
|
+
notCounted: "не влияет на полноту",
|
|
46
|
+
sectionHidden: (reason) => `Раздел скрыт: ${reason ?? "нет прав на связанное досье"}.`,
|
|
47
|
+
sectionAbsent: "Связанное досье не привязано.",
|
|
48
|
+
slot: { empty: "Нет", pending: "На проверке", verified: "Проверено", rejected: "Отклонён" },
|
|
49
|
+
};
|
package/src/testids.ts
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/** `data-testid` панели — контракт для тестов встраивающего: подписи меняются, эти — нет. */
|
|
2
|
+
export const PANEL_TESTID = {
|
|
3
|
+
panel: "dossier-panel",
|
|
4
|
+
unlinked: "dossier-panel-unlinked",
|
|
5
|
+
loading: "dossier-panel-loading",
|
|
6
|
+
unavailable: "dossier-panel-unavailable",
|
|
7
|
+
forbidden: "dossier-panel-forbidden",
|
|
8
|
+
login: "dossier-panel-login",
|
|
9
|
+
loginLink: "dossier-panel-login-link",
|
|
10
|
+
missing: "dossier-panel-missing",
|
|
11
|
+
create: "dossier-panel-create",
|
|
12
|
+
section: (code: string) => `dossier-section-${code}`,
|
|
13
|
+
sectionHidden: (code: string) => `dossier-section-hidden-${code}`,
|
|
14
|
+
sectionAbsent: (code: string) => `dossier-section-absent-${code}`,
|
|
15
|
+
slot: (typeCode: string) => `dossier-slot-${typeCode}`,
|
|
16
|
+
attach: (typeCode: string) => `dossier-attach-${typeCode}`,
|
|
17
|
+
locked: (typeCode: string) => `dossier-locked-${typeCode}`,
|
|
18
|
+
uploadError: (typeCode: string) => `dossier-upload-error-${typeCode}`,
|
|
19
|
+
} as const;
|
package/src/types.ts
ADDED
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* ГРАНИЦА ПАКЕТА, отдаваемого другому продукту.
|
|
3
|
+
*
|
|
4
|
+
* Формы здесь ПОВТОРЯЮТ `@app/dossier/contract`, а не импортируют его: тот пакет тянет
|
|
5
|
+
* `drizzle-orm`, `elysia` и `pdf-lib`, и `file:`-установка притащила бы их в чужое приложение
|
|
6
|
+
* вместе с сервером и базой. Пакет обязан ставиться, имея только React и кит.
|
|
7
|
+
*
|
|
8
|
+
* Расхождение двух описаний ловится компилятором, а не случаем: `@app/dossier` держит
|
|
9
|
+
* `panel-contract.test.ts`, который проверяет, что контракт всё ещё удовлетворяет этим типам.
|
|
10
|
+
* Поле, добавленное на сервере и забытое здесь, роняет проверку типов в ЭТОЙ репе — до того, как
|
|
11
|
+
* пакет уедет к соседу.
|
|
12
|
+
*/
|
|
13
|
+
|
|
14
|
+
/** Состояние слота — оно же статус проверки, который владелец требует показывать одинаково. */
|
|
15
|
+
export const SLOT_STATES = ["empty", "pending", "verified", "rejected"] as const;
|
|
16
|
+
export type SlotState = (typeof SLOT_STATES)[number];
|
|
17
|
+
|
|
18
|
+
/** Откуда раздел: свой, из дочернего досье, из связанного. */
|
|
19
|
+
export const SECTION_ORIGINS = ["own", "child", "linked"] as const;
|
|
20
|
+
export type SectionOrigin = (typeof SECTION_ORIGINS)[number];
|
|
21
|
+
|
|
22
|
+
export const DOSSIER_LINK_KINDS = ["child", "linked"] as const;
|
|
23
|
+
export type DossierLinkKind = (typeof DOSSIER_LINK_KINDS)[number];
|
|
24
|
+
|
|
25
|
+
export interface PanelSlot {
|
|
26
|
+
sectionCode: string;
|
|
27
|
+
typeCode: string;
|
|
28
|
+
typeName: string;
|
|
29
|
+
state: SlotState;
|
|
30
|
+
required: boolean;
|
|
31
|
+
visible: boolean;
|
|
32
|
+
editable: boolean;
|
|
33
|
+
editableReason: string | null;
|
|
34
|
+
accept: string[];
|
|
35
|
+
retired: boolean;
|
|
36
|
+
documentId: number | null;
|
|
37
|
+
currentVersionNumber: number | null;
|
|
38
|
+
nextVersion: number;
|
|
39
|
+
pageCount: number | null;
|
|
40
|
+
updatedAt: Date | string | null;
|
|
41
|
+
reviewReason: string | null;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
export interface PanelSection {
|
|
45
|
+
origin: SectionOrigin;
|
|
46
|
+
sourceDossierCode: string;
|
|
47
|
+
sourceDossierTitle: string | null;
|
|
48
|
+
linkKind: DossierLinkKind | null;
|
|
49
|
+
code: string;
|
|
50
|
+
title: string;
|
|
51
|
+
writable: boolean;
|
|
52
|
+
countsToCompleteness: boolean;
|
|
53
|
+
complete: boolean;
|
|
54
|
+
missingTypeCodes: string[];
|
|
55
|
+
slots: PanelSlot[];
|
|
56
|
+
/** Связанного досье нет: раздел показывается пустым и помеченным, а не прячется. */
|
|
57
|
+
absent: boolean;
|
|
58
|
+
/** Права на связанное нет: слоты не отданы, но факт сокрытия назван. */
|
|
59
|
+
hidden: boolean;
|
|
60
|
+
hiddenReason: string | null;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
export interface PanelDossier {
|
|
64
|
+
code: string;
|
|
65
|
+
type: string;
|
|
66
|
+
schemaCode: string;
|
|
67
|
+
ownerType: string | null;
|
|
68
|
+
ownerKey: string | null;
|
|
69
|
+
complete: boolean;
|
|
70
|
+
missingCount: number;
|
|
71
|
+
sectionCount: number;
|
|
72
|
+
dossierCount: number;
|
|
73
|
+
sections: PanelSection[];
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
/**
|
|
77
|
+
* Владелец досье — запись встраивающего продукта, непрозрачная для панели. В досье уходит парой
|
|
78
|
+
* `ownerType = <product>:<kind>`, `ownerKey = key`; что это за запись, панель не знает и не должна.
|
|
79
|
+
*/
|
|
80
|
+
export interface PanelOwner {
|
|
81
|
+
product: string;
|
|
82
|
+
kind: string;
|
|
83
|
+
key: string;
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
export const ownerTypeOf = (owner: PanelOwner): string => `${owner.product}:${owner.kind}`;
|
|
87
|
+
|
|
88
|
+
/** Слот, в который кладётся файл: досье-источник раздела и коды слота. */
|
|
89
|
+
export interface SlotTarget {
|
|
90
|
+
dossierCode: string;
|
|
91
|
+
sectionCode: string;
|
|
92
|
+
typeCode: string;
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
/**
|
|
96
|
+
* Отказ транспорта с HTTP-статусом: 401 панель показывает входом, 403 — нехваткой прав, остальное —
|
|
97
|
+
* недоступностью. Свой транспорт бросает его же, чтобы панель различала эти исходы.
|
|
98
|
+
*/
|
|
99
|
+
export class TransportError extends Error {
|
|
100
|
+
constructor(
|
|
101
|
+
readonly status: number,
|
|
102
|
+
message: string
|
|
103
|
+
) {
|
|
104
|
+
super(message);
|
|
105
|
+
this.name = "TransportError";
|
|
106
|
+
}
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
/**
|
|
110
|
+
* ТРАНСПОРТ — единственный вход данных панели. Учётных данных панель не держит: транспорт по
|
|
111
|
+
* умолчанию (`createHttpTransport`) ходит на тот же домен с кукой сессии модуля, свой транспорт
|
|
112
|
+
* хозяина экрана может ходить через его сервер. Токена в браузерном бандле нет ни в одном случае.
|
|
113
|
+
*
|
|
114
|
+
* Методы правки необязательны: транспорт только для чтения даёт панель только для чтения.
|
|
115
|
+
*/
|
|
116
|
+
export interface DossierTransport {
|
|
117
|
+
/** Составной вид досье. Отказ — исключение: панель покажет «недоступно», а не пустоту. */
|
|
118
|
+
composite(code: string): Promise<PanelDossier>;
|
|
119
|
+
/** Код досье владельца по схеме или `null`, если досье нет. */
|
|
120
|
+
find?(query: { ownerType: string; ownerKey: string; type: string }): Promise<string | null>;
|
|
121
|
+
/** Завести досье (повтор возвращает то же). Ответ — код досье. */
|
|
122
|
+
create?(input: {
|
|
123
|
+
type: string;
|
|
124
|
+
ownerType: string;
|
|
125
|
+
ownerKey: string;
|
|
126
|
+
title?: string;
|
|
127
|
+
}): Promise<string>;
|
|
128
|
+
/** Положить файл в слот. */
|
|
129
|
+
upload?(target: SlotTarget, file: File): Promise<void>;
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
/**
|
|
133
|
+
* ЧТО ПАНЕЛЬ ПОКАЗЫВАЕТ. Исходы различимы, и путать их нельзя — для оператора они означают разное.
|
|
134
|
+
*
|
|
135
|
+
* `unlinked`/`missing` это НЕ ошибка: запись заводится и без досье. `unavailable` тем более: пустой
|
|
136
|
+
* список читается как «документов не требуется», и запись примут вслепую. `login` — нет сессии
|
|
137
|
+
* модуля: это действие человека, а не сбой.
|
|
138
|
+
*/
|
|
139
|
+
export type PanelState =
|
|
140
|
+
| { kind: "unlinked" }
|
|
141
|
+
| { kind: "loading" }
|
|
142
|
+
| { kind: "missing" }
|
|
143
|
+
| { kind: "ready"; dossier: PanelDossier }
|
|
144
|
+
| { kind: "login" }
|
|
145
|
+
| { kind: "forbidden"; reason: string }
|
|
146
|
+
| { kind: "unavailable"; reason: string };
|