Compare commits
8
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
13f28ef811 | ||
|
|
e49d90f713 | ||
|
|
b327d7370b | ||
|
|
fdcf0de5bf | ||
|
|
c11be43f20 | ||
|
|
980981bc86 | ||
|
|
ce0040e407 | ||
|
|
a33e93d4d4 |
+51
-1
@@ -23,16 +23,66 @@ module.exports = {
|
|||||||
from: { path: "^src/presentation/(?!adapters/query)" },
|
from: { path: "^src/presentation/(?!adapters/query)" },
|
||||||
to: { path: "^(src/(adapters|bootstrap)|@tanstack)" },
|
to: { path: "^(src/(adapters|bootstrap)|@tanstack)" },
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
name: "page-templates-own-layout-only",
|
||||||
|
severity: "error",
|
||||||
|
from: { path: "^src/presentation/templates" },
|
||||||
|
to: {
|
||||||
|
path: "^(src/(application|adapters|bootstrap)|src/presentation/adapters|@tanstack)",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "icon-vendor-is-facade-only",
|
||||||
|
severity: "error",
|
||||||
|
from: {
|
||||||
|
path: "^src",
|
||||||
|
pathNot:
|
||||||
|
"^src/presentation/design-system/icons/vendors/lucide\\.tsx$",
|
||||||
|
},
|
||||||
|
to: { path: "^lucide-react$" },
|
||||||
|
},
|
||||||
{
|
{
|
||||||
name: "adapters-do-not-know-presentation",
|
name: "adapters-do-not-know-presentation",
|
||||||
severity: "error",
|
severity: "error",
|
||||||
from: { path: "^src/adapters" },
|
from: { path: "^src/adapters" },
|
||||||
to: { path: "^src/(presentation|bootstrap)" },
|
to: { path: "^src/(presentation|bootstrap)" },
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
name: "feature-domain-is-framework-neutral",
|
||||||
|
severity: "error",
|
||||||
|
from: { path: "^src/features/[^/]+/domain" },
|
||||||
|
to: {
|
||||||
|
path: "^(src/(application|presentation|adapters|bootstrap)|src/features/[^/]+/(application|adapters|presentation)|react|react-dom|@tanstack)",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "feature-application-does-not-know-runtime",
|
||||||
|
severity: "error",
|
||||||
|
from: { path: "^src/features/[^/]+/application" },
|
||||||
|
to: {
|
||||||
|
path: "^(src/(presentation|adapters|bootstrap)|src/features/[^/]+/(adapters|presentation)|react|react-dom|@tanstack)",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "feature-presentation-does-not-know-outbound-adapters",
|
||||||
|
severity: "error",
|
||||||
|
from: { path: "^src/features/[^/]+/presentation" },
|
||||||
|
to: {
|
||||||
|
path: "^(src/(adapters|bootstrap)|src/features/[^/]+/adapters|@tanstack)",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "feature-adapters-do-not-know-presentation",
|
||||||
|
severity: "error",
|
||||||
|
from: { path: "^src/features/[^/]+/adapters" },
|
||||||
|
to: {
|
||||||
|
path: "^(src/(presentation|bootstrap)|src/features/[^/]+/presentation)",
|
||||||
|
},
|
||||||
|
},
|
||||||
{
|
{
|
||||||
name: "concrete-adapters-compose-only-in-bootstrap",
|
name: "concrete-adapters-compose-only-in-bootstrap",
|
||||||
severity: "error",
|
severity: "error",
|
||||||
from: { path: "^src/(domain|application|presentation|contracts|sample)" },
|
from: { path: "^src/(domain|application|presentation|contracts)" },
|
||||||
to: { path: "^src/adapters" },
|
to: { path: "^src/adapters" },
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -15,4 +15,4 @@ M5 Error association: pending
|
|||||||
M6 Color signal: pending
|
M6 Color signal: pending
|
||||||
M7 Reduced motion: pending
|
M7 Reduced motion: pending
|
||||||
Screen reader: pending
|
Screen reader: pending
|
||||||
Notes: Review the text-field error association and modal focus containment/restoration.
|
Notes: Review form primitives, Menu/Tabs keyboard behavior, Toast announcements, Tooltip supplemental copy, text-field error association and modal focus containment/restoration.
|
||||||
|
|||||||
@@ -0,0 +1,18 @@
|
|||||||
|
# REFERENCE_RESOURCE_DETAIL accessibility review
|
||||||
|
|
||||||
|
Status: pending-manual-review
|
||||||
|
Route ID: REFERENCE_RESOURCE_DETAIL
|
||||||
|
Release ID:
|
||||||
|
Reviewer:
|
||||||
|
Reviewed at:
|
||||||
|
Signature:
|
||||||
|
Attestation: pending
|
||||||
|
M1 Keyboard: pending
|
||||||
|
M2 Visible focus: pending
|
||||||
|
M3 Route focus: pending
|
||||||
|
M4 Modal focus: not-applicable (no modal on this route)
|
||||||
|
M5 Error association: not-applicable (no form error on this route)
|
||||||
|
M6 Color signal: pending
|
||||||
|
M7 Reduced motion: pending
|
||||||
|
Screen reader: pending
|
||||||
|
Notes: Human review pending.
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
# REFERENCE_RESOURCE_FORM accessibility review
|
||||||
|
|
||||||
|
Status: pending-manual-review
|
||||||
|
Route ID: REFERENCE_RESOURCE_FORM
|
||||||
|
Release ID:
|
||||||
|
Reviewer:
|
||||||
|
Reviewed at:
|
||||||
|
Signature:
|
||||||
|
Attestation: pending
|
||||||
|
M1 Keyboard: pending
|
||||||
|
M2 Visible focus: pending
|
||||||
|
M3 Route focus: pending
|
||||||
|
M4 Modal focus: pending
|
||||||
|
M5 Error association: pending
|
||||||
|
M6 Color signal: pending
|
||||||
|
M7 Reduced motion: pending
|
||||||
|
Screen reader: pending
|
||||||
|
Notes: Human review pending.
|
||||||
+2
-2
@@ -1,7 +1,7 @@
|
|||||||
# SAMPLE_RESOURCE_LIST accessibility review
|
# REFERENCE_RESOURCE_LIST accessibility review
|
||||||
|
|
||||||
Status: pending-manual-review
|
Status: pending-manual-review
|
||||||
Route ID: SAMPLE_RESOURCE_LIST
|
Route ID: REFERENCE_RESOURCE_LIST
|
||||||
Release ID:
|
Release ID:
|
||||||
Reviewer:
|
Reviewer:
|
||||||
Reviewed at:
|
Reviewed at:
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
# REFERENCE_RESOURCE_STATUS accessibility review
|
||||||
|
|
||||||
|
Status: pending-manual-review
|
||||||
|
Route ID: REFERENCE_RESOURCE_STATUS
|
||||||
|
Release ID:
|
||||||
|
Reviewer:
|
||||||
|
Reviewed at:
|
||||||
|
Signature:
|
||||||
|
Attestation: pending
|
||||||
|
M1 Keyboard: pending
|
||||||
|
M2 Visible focus: pending
|
||||||
|
M3 Route focus: pending
|
||||||
|
M4 Modal focus: not-applicable (no modal on this route)
|
||||||
|
M5 Error association: not-applicable (no form error on this route)
|
||||||
|
M6 Color signal: pending
|
||||||
|
M7 Reduced motion: pending
|
||||||
|
Screen reader: pending
|
||||||
|
Notes: Human review pending.
|
||||||
+26
-8
@@ -79,7 +79,10 @@
|
|||||||
{ "script": "check:types:fixture:ts-result", "expect": "fail" },
|
{ "script": "check:types:fixture:ts-result", "expect": "fail" },
|
||||||
{ "script": "check:types:fixture:application-output", "expect": "fail" },
|
{ "script": "check:types:fixture:application-output", "expect": "fail" },
|
||||||
{ "script": "check:types:fixture:application-input", "expect": "fail" },
|
{ "script": "check:types:fixture:application-input", "expect": "fail" },
|
||||||
{ "script": "check:types:fixture:async-overlay", "expect": "fail" }
|
{ "script": "check:types:fixture:async-overlay", "expect": "fail" },
|
||||||
|
{ "script": "check:types:fixture:route-runtime", "expect": "fail" },
|
||||||
|
{ "script": "check:types:fixture:page-action", "expect": "fail" },
|
||||||
|
{ "script": "check:types:fixture:icon-button", "expect": "fail" }
|
||||||
],
|
],
|
||||||
"logPath": "artifacts/quality/check-types.txt",
|
"logPath": "artifacts/quality/check-types.txt",
|
||||||
"evidence": ["artifacts/quality/check-types.txt"],
|
"evidence": ["artifacts/quality/check-types.txt"],
|
||||||
@@ -108,9 +111,15 @@
|
|||||||
},
|
},
|
||||||
"FE-GATE-007": {
|
"FE-GATE-007": {
|
||||||
"name": "integration",
|
"name": "integration",
|
||||||
"steps": [{ "script": "test:integration", "expect": "pass" }],
|
"steps": [
|
||||||
|
{ "script": "test:integration", "expect": "pass" },
|
||||||
|
{ "script": "test:reference-feature", "expect": "pass" }
|
||||||
|
],
|
||||||
"logPath": "artifacts/quality/gates/FE-GATE-007.txt",
|
"logPath": "artifacts/quality/gates/FE-GATE-007.txt",
|
||||||
"evidence": ["artifacts/tests/integration.xml"],
|
"evidence": [
|
||||||
|
"artifacts/tests/integration.xml",
|
||||||
|
"artifacts/tests/reference-feature.xml"
|
||||||
|
],
|
||||||
"retentionClass": "merge-cycle"
|
"retentionClass": "merge-cycle"
|
||||||
},
|
},
|
||||||
"FE-GATE-008": {
|
"FE-GATE-008": {
|
||||||
@@ -133,7 +142,7 @@
|
|||||||
"artifacts/tests/a11y-manual/EXAMPLES_UI.md",
|
"artifacts/tests/a11y-manual/EXAMPLES_UI.md",
|
||||||
"artifacts/tests/a11y-manual/EXAMPLES_STATES.md",
|
"artifacts/tests/a11y-manual/EXAMPLES_STATES.md",
|
||||||
"artifacts/tests/a11y-manual/EXAMPLES_AUTH.md",
|
"artifacts/tests/a11y-manual/EXAMPLES_AUTH.md",
|
||||||
"artifacts/tests/a11y-manual/SAMPLE_RESOURCE_LIST.md",
|
"artifacts/tests/a11y-manual/REFERENCE_RESOURCE_LIST.md",
|
||||||
"artifacts/tests/a11y-manual/NOT_FOUND.md",
|
"artifacts/tests/a11y-manual/NOT_FOUND.md",
|
||||||
"artifacts/tests/a11y-manual/report.json"
|
"artifacts/tests/a11y-manual/report.json"
|
||||||
],
|
],
|
||||||
@@ -143,14 +152,20 @@
|
|||||||
"name": "architecture",
|
"name": "architecture",
|
||||||
"steps": [
|
"steps": [
|
||||||
{ "script": "check:architecture", "expect": "pass" },
|
{ "script": "check:architecture", "expect": "pass" },
|
||||||
|
{ "script": "check:design-system", "expect": "pass" },
|
||||||
|
{ "script": "check:design-system:fixture", "expect": "fail" },
|
||||||
{ "script": "check:registries", "expect": "pass" },
|
{ "script": "check:registries", "expect": "pass" },
|
||||||
{ "script": "check:registries:fixture", "expect": "fail" }
|
{ "script": "check:registries:fixture", "expect": "fail" },
|
||||||
|
{ "script": "check:routes:fixture", "expect": "fail" }
|
||||||
],
|
],
|
||||||
"logPath": "artifacts/quality/gates/FE-GATE-010.txt",
|
"logPath": "artifacts/quality/gates/FE-GATE-010.txt",
|
||||||
"evidence": [
|
"evidence": [
|
||||||
"artifacts/quality/dependency-report.json",
|
"artifacts/quality/dependency-report.json",
|
||||||
|
"artifacts/quality/design-system.json",
|
||||||
|
"artifacts/quality/design-system-fixture.json",
|
||||||
"artifacts/quality/registries.json",
|
"artifacts/quality/registries.json",
|
||||||
"artifacts/quality/registry-fixture.json"
|
"artifacts/quality/registry-fixture.json",
|
||||||
|
"artifacts/quality/route-registry-fixture.json"
|
||||||
],
|
],
|
||||||
"retentionClass": "merge-cycle"
|
"retentionClass": "merge-cycle"
|
||||||
},
|
},
|
||||||
@@ -158,7 +173,10 @@
|
|||||||
"name": "build",
|
"name": "build",
|
||||||
"steps": [{ "script": "build", "expect": "pass" }],
|
"steps": [{ "script": "build", "expect": "pass" }],
|
||||||
"logPath": "artifacts/quality/gates/FE-GATE-011.txt",
|
"logPath": "artifacts/quality/gates/FE-GATE-011.txt",
|
||||||
"evidence": ["artifacts/release/build-manifest.json"],
|
"evidence": [
|
||||||
|
"artifacts/release/build-manifest.json",
|
||||||
|
"artifacts/release/runtime-config.schema.json"
|
||||||
|
],
|
||||||
"retentionClass": "release-coherence"
|
"retentionClass": "release-coherence"
|
||||||
},
|
},
|
||||||
"FE-GATE-012": {
|
"FE-GATE-012": {
|
||||||
@@ -250,7 +268,7 @@
|
|||||||
"retentionClass": "release-coherence"
|
"retentionClass": "release-coherence"
|
||||||
},
|
},
|
||||||
"FE-GATE-020": {
|
"FE-GATE-020": {
|
||||||
"name": "sample-removal",
|
"name": "reference-feature-removal",
|
||||||
"steps": [{ "script": "test:sample-removal", "expect": "pass" }],
|
"steps": [{ "script": "test:sample-removal", "expect": "pass" }],
|
||||||
"logPath": "artifacts/quality/gates/FE-GATE-020.txt",
|
"logPath": "artifacts/quality/gates/FE-GATE-020.txt",
|
||||||
"evidence": ["artifacts/tests/sample-removal.xml"],
|
"evidence": ["artifacts/tests/sample-removal.xml"],
|
||||||
|
|||||||
@@ -3,9 +3,46 @@
|
|||||||
"registries": [
|
"registries": [
|
||||||
{
|
{
|
||||||
"registryId": "FE-REG-ROUTE",
|
"registryId": "FE-REG-ROUTE",
|
||||||
"path": "src/contracts/routes.js",
|
"path": "src/features/installed-feature-contracts.js",
|
||||||
"exportName": "ROUTE_REGISTRY",
|
"exportName": "ROUTE_REGISTRY",
|
||||||
"owner": "feature-routing-navigation-guard-contract",
|
"owner": "feature-routing-navigation-guard-contract",
|
||||||
|
"uniqueFields": ["routeId", "path", "chunkId"],
|
||||||
|
"allowedValues": {
|
||||||
|
"paramsSchema": [null, "NotFoundSplat", "ReferenceResourceParams"],
|
||||||
|
"searchSchema": [null, "ReferenceResourceListQuery"],
|
||||||
|
"loadingSurface": [
|
||||||
|
"app-shell",
|
||||||
|
"example-page",
|
||||||
|
"reference-resource-list",
|
||||||
|
"reference-resource-detail",
|
||||||
|
"reference-resource-form",
|
||||||
|
"reference-resource-status",
|
||||||
|
"none"
|
||||||
|
],
|
||||||
|
"errorSurface": [
|
||||||
|
"route-boundary",
|
||||||
|
"feature-boundary",
|
||||||
|
"not-found"
|
||||||
|
],
|
||||||
|
"chunkId": [
|
||||||
|
"route-home",
|
||||||
|
"route-examples-ui",
|
||||||
|
"route-examples-states",
|
||||||
|
"route-examples-auth",
|
||||||
|
"route-reference-resources",
|
||||||
|
"route-reference-resource-detail",
|
||||||
|
"route-reference-resource-form",
|
||||||
|
"route-reference-resource-status",
|
||||||
|
"route-not-found"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"references": [
|
||||||
|
{
|
||||||
|
"field": "routeId",
|
||||||
|
"registryId": "FE-REG-ROUTE-RUNTIME",
|
||||||
|
"targetField": "routeId"
|
||||||
|
}
|
||||||
|
],
|
||||||
"requiredFields": [
|
"requiredFields": [
|
||||||
"routeId",
|
"routeId",
|
||||||
"path",
|
"path",
|
||||||
@@ -17,9 +54,44 @@
|
|||||||
"chunkId"
|
"chunkId"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"registryId": "FE-REG-ROUTE-RUNTIME",
|
||||||
|
"path": "src/features/installed-feature-contracts.js",
|
||||||
|
"exportName": "ROUTE_RUNTIME_CONTRACT",
|
||||||
|
"owner": "feature-frontend-routing-release-recovery-runtime",
|
||||||
|
"requiredFields": [
|
||||||
|
"routeId",
|
||||||
|
"moduleId",
|
||||||
|
"paramsCodec",
|
||||||
|
"searchCodec"
|
||||||
|
],
|
||||||
|
"uniqueFields": ["routeId", "moduleId"],
|
||||||
|
"allowedValues": {
|
||||||
|
"moduleId": [
|
||||||
|
"home-page",
|
||||||
|
"ui-gallery-page",
|
||||||
|
"state-gallery-page",
|
||||||
|
"auth-example-page",
|
||||||
|
"reference-resource-page",
|
||||||
|
"reference-resource-detail-page",
|
||||||
|
"reference-resource-form-page",
|
||||||
|
"reference-resource-status-page",
|
||||||
|
"not-found-page"
|
||||||
|
],
|
||||||
|
"paramsCodec": ["none", "NotFoundSplat", "ReferenceResourceParams"],
|
||||||
|
"searchCodec": ["none", "ReferenceResourceListQuery"]
|
||||||
|
},
|
||||||
|
"references": [
|
||||||
|
{
|
||||||
|
"field": "routeId",
|
||||||
|
"registryId": "FE-REG-ROUTE",
|
||||||
|
"targetField": "routeId"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"registryId": "FE-REG-API",
|
"registryId": "FE-REG-API",
|
||||||
"path": "src/contracts/api-operations.js",
|
"path": "src/features/installed-feature-contracts.js",
|
||||||
"exportName": "API_OPERATIONS",
|
"exportName": "API_OPERATIONS",
|
||||||
"owner": "feature-api-client-response-envelope-contract",
|
"owner": "feature-api-client-response-envelope-contract",
|
||||||
"requiredFields": [
|
"requiredFields": [
|
||||||
@@ -76,7 +148,7 @@
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
"registryId": "FE-REG-QUERY",
|
"registryId": "FE-REG-QUERY",
|
||||||
"path": "src/contracts/query-keys.js",
|
"path": "src/features/installed-feature-contracts.js",
|
||||||
"exportName": "QUERY_REGISTRY",
|
"exportName": "QUERY_REGISTRY",
|
||||||
"owner": "feature-server-state-caching-contract",
|
"owner": "feature-server-state-caching-contract",
|
||||||
"requiredFields": [
|
"requiredFields": [
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ Automated axe checks do not establish WCAG conformance. A human reviewer must
|
|||||||
review all six route records in `artifacts/tests/a11y-manual/` against one
|
review all six route records in `artifacts/tests/a11y-manual/` against one
|
||||||
release candidate and sign them. The required scope is derived from the route
|
release candidate and sign them. The required scope is derived from the route
|
||||||
registry: `APP_HOME`, `EXAMPLES_UI`, `EXAMPLES_STATES`, `EXAMPLES_AUTH`,
|
registry: `APP_HOME`, `EXAMPLES_UI`, `EXAMPLES_STATES`, `EXAMPLES_AUTH`,
|
||||||
`SAMPLE_RESOURCE_LIST`, and `NOT_FOUND`. Copy the template fields exactly; the
|
`REFERENCE_RESOURCE_LIST`, and `NOT_FOUND`. Copy the template fields exactly; the
|
||||||
gate rejects blank identity/timestamp/signature fields, pending verdicts,
|
gate rejects blank identity/timestamp/signature fields, pending verdicts,
|
||||||
mismatched release IDs, or missing routes.
|
mismatched release IDs, or missing routes.
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,58 @@
|
|||||||
|
# VD-03: React Router Data Mode와 서버 상태 소유권
|
||||||
|
|
||||||
|
- 상태: Accepted
|
||||||
|
- 결정일: 2026-07-26
|
||||||
|
- 적용 브랜치: `feature-frontend-routing-release-recovery-runtime`
|
||||||
|
|
||||||
|
## 배경
|
||||||
|
|
||||||
|
기존 라우터는 `BrowserRouter`와 수동 JSX route 목록을 사용했다. 직렬화 가능한
|
||||||
|
route registry에 params/search schema, loading/error surface, access, title,
|
||||||
|
navigation과 chunk ID가 있었지만 실행 route tree와 독립적이어서 선언과 행동이
|
||||||
|
어긋날 수 있었다.
|
||||||
|
|
||||||
|
이 저장소는 client-only SPA이며 서버 상태는 application input과 TanStack Query가
|
||||||
|
소유한다. Framework Mode의 loader/action 중심 데이터 소유권이나 SSR을 도입하지
|
||||||
|
않으면서 route object, 오류 경계와 navigation lifecycle은 중앙에서 조립할
|
||||||
|
필요가 있다.
|
||||||
|
|
||||||
|
## 결정
|
||||||
|
|
||||||
|
1. 고정된 React Router `7.18.1`의 `createBrowserRouter`와 `RouterProvider`를
|
||||||
|
사용하는 Data Mode를 기본값으로 채택한다.
|
||||||
|
2. 직렬화 가능한 route contract와 React component/codec runtime map을 분리한다.
|
||||||
|
3. 모든 executable route object와 navigation은 registry에서 생성한다. JSX에서
|
||||||
|
route 목록을 다시 열거하지 않는다.
|
||||||
|
4. params/search는 route 경계의 Zod codec으로 parse하고 같은 codec으로 canonical
|
||||||
|
URL을 생성한다.
|
||||||
|
5. loader/action은 같은 서버 데이터를 직접 다시 요청하지 않는다. 필요하면
|
||||||
|
application input 또는 query adapter 한 경로를 호출한다.
|
||||||
|
6. 서버 상태, retry, cache와 mutation lifecycle은 application input과 TanStack
|
||||||
|
Query가 계속 소유한다.
|
||||||
|
7. lazy chunk rejection만 release recovery input으로 보내며 일반 render error는
|
||||||
|
route/feature boundary가 소유한다.
|
||||||
|
8. Framework Mode, SSR, static generation과 router version upgrade는 별도
|
||||||
|
dependency/architecture 브랜치에서 결정한다.
|
||||||
|
|
||||||
|
## 검증
|
||||||
|
|
||||||
|
- route contract/runtime map의 누락과 orphan은 TypeScript negative fixture와
|
||||||
|
registry gate가 모두 거절한다.
|
||||||
|
- duplicate ID/path, unknown codec/surface/chunk와 참조 불일치를 negative registry
|
||||||
|
fixture로 검증한다.
|
||||||
|
- params/search parse/build round-trip, canonical redirect, 최대 redirect hop,
|
||||||
|
access rejection, title/focus와 boundary reset을 unit/component test로 검증한다.
|
||||||
|
- Vite dynamic entry와 release route chunk map, runtime config JSON Schema를
|
||||||
|
build/release 검증기가 확인한다.
|
||||||
|
- chunk failure는 no-store manifest refetch 후 build/release 쌍마다 한 번만
|
||||||
|
reload하며 offline, malformed manifest와 storage 실패는 fail-closed한다.
|
||||||
|
|
||||||
|
## 결과와 rollback
|
||||||
|
|
||||||
|
Data Router는 navigation lifecycle의 조립 경계이며 서버 데이터 계층이 아니다.
|
||||||
|
이 구분을 지키면 React Router를 교체해도 application input과 output port는
|
||||||
|
유지된다.
|
||||||
|
|
||||||
|
rollback은 RP-04 merge를 되돌려 이전 수동 router와 generic route failure
|
||||||
|
surface로 복구한다. URL shape와 application API는 유지하고, 이미 배포된 asset
|
||||||
|
cache의 purge는 저장소 rollback 범위에 포함하지 않는다.
|
||||||
@@ -0,0 +1,55 @@
|
|||||||
|
# VD-04: Native form controller와 local facade
|
||||||
|
|
||||||
|
- 상태: Accepted
|
||||||
|
- 결정일: 2026-07-26
|
||||||
|
- 적용 브랜치: `feature-frontend-form-page-platform`
|
||||||
|
|
||||||
|
## 배경
|
||||||
|
|
||||||
|
플랫폼에는 Zod가 이미 설치돼 있지만 form state, field error, dirty navigation과
|
||||||
|
page template 계약은 없었다. React Hook Form과 resolver를 바로 추가하면
|
||||||
|
dependency와 lockfile이 바뀌고, 현재 reference form에 필요하지 않은 복합 비동기
|
||||||
|
field orchestration까지 플랫폼 기본값으로 고정하게 된다.
|
||||||
|
|
||||||
|
## 결정
|
||||||
|
|
||||||
|
1. RP-06은 React native form event와 controlled value를 사용하는 local
|
||||||
|
`useAppForm` facade를 기본 엔진으로 채택한다.
|
||||||
|
2. Zod presentation schema, application command mapper와 domain invariant는 서로
|
||||||
|
다른 소유물로 유지한다.
|
||||||
|
3. page와 feature는 `useAppForm`, `Form`, `FormField`, `ErrorSummary`,
|
||||||
|
`mapValidationFailureToFields`, `useDirtyNavigationGuard`만 사용한다.
|
||||||
|
4. 422 details는 승인된 `path`와 `code`만 HTTP 경계에서 투영한다. backend
|
||||||
|
message와 알 수 없는 field는 field에 전달하지 않고 안전한 form-level
|
||||||
|
error로 이동한다.
|
||||||
|
5. 409 conflict는 validation으로 바꾸지 않으며 입력과 dirty 상태를 보존한다.
|
||||||
|
6. pending submit은 동일 controller에서 한 번만 실행하고 success/reset 이후
|
||||||
|
dirty 상태를 해제한다.
|
||||||
|
7. `StandardPage`, `CollectionPage`, `DetailPage`, `FormPage`, `StatusPage`는
|
||||||
|
layout과 state slot만 소유하며 application/query/HTTP를 import하지 않는다.
|
||||||
|
|
||||||
|
## React Hook Form 도입 조건
|
||||||
|
|
||||||
|
다음 중 하나가 실제 제품 요구로 확인되면 local facade 내부 adapter로
|
||||||
|
React Hook Form과 Zod resolver를 평가한다.
|
||||||
|
|
||||||
|
- 동적 field array와 중첩 object를 함께 다루는 복합 form
|
||||||
|
- field 단위 비동기 validation 취소와 의존 validation
|
||||||
|
- 수백 개 field의 render isolation이 측정 가능한 병목인 경우
|
||||||
|
- uncontrolled input 또는 vendor extension이 필요한 경우
|
||||||
|
|
||||||
|
도입하더라도 이 문서의 public API와 component/application tests를 유지해야
|
||||||
|
한다. vendor package를 feature/page에서 직접 import하는 것은 허용하지 않는다.
|
||||||
|
|
||||||
|
## 검증과 rollback
|
||||||
|
|
||||||
|
- client validation, transform/default, 422 allowlist, conflict, duplicate submit,
|
||||||
|
reset, dirty guard와 focus를 component test로 검증한다.
|
||||||
|
- template 최소/전체 slot과 async/status variation을 component test로 검증한다.
|
||||||
|
- architecture gate가 template의 application/HTTP/query vendor import를
|
||||||
|
거절한다.
|
||||||
|
- secret-like input이 URL, storage, diagnostics에 복제되지 않는지 검증한다.
|
||||||
|
|
||||||
|
rollback 시 reference page는 이전 직접 form/layout으로 돌아갈 수 있다.
|
||||||
|
application input과 outbound gateway 계약은 유지되며, form facade와 template
|
||||||
|
commit은 독립적으로 되돌릴 수 있다.
|
||||||
@@ -0,0 +1,57 @@
|
|||||||
|
# VD-05: Semantic icon facade와 native-first interaction
|
||||||
|
|
||||||
|
- 상태: Accepted
|
||||||
|
- 결정일: 2026-07-26
|
||||||
|
- 적용 브랜치: `feature-frontend-design-system-platform`
|
||||||
|
- 재검토: native 계약으로 충족할 수 없는 widget 요구가 확인될 때
|
||||||
|
|
||||||
|
## 배경
|
||||||
|
|
||||||
|
앱 셸과 공통 UI는 문자 glyph, raw button/select와 페이지별 focus 처리를
|
||||||
|
사용했다. 아이콘 공급자와 복합 interaction을 제품 코드에 직접 노출하면 번들,
|
||||||
|
접근성, vendor type과 교체 비용이 모든 feature로 전파된다. 반대로 실제 요구가
|
||||||
|
없는 두 개의 headless vendor를 기본 설치하면 skeleton 소비자가 제거해야 할
|
||||||
|
의존성과 중복 interaction 모델이 생긴다.
|
||||||
|
|
||||||
|
## 결정
|
||||||
|
|
||||||
|
1. 아이콘 공급자는 lockfile 최소 게시 유예를 통과한 `lucide-react@1.25.0`으로
|
||||||
|
고정한다.
|
||||||
|
2. `lucide-react`의 static named import는
|
||||||
|
`design-system/icons/vendors/lucide.tsx` 한 파일에서만 허용한다.
|
||||||
|
3. public API는 `MenuIcon`, `CloseIcon`, `WarningIcon` 같은 의미 이름만
|
||||||
|
노출한다. vendor component type, icon name, stroke API와 dynamic icon
|
||||||
|
registry는 노출하지 않는다.
|
||||||
|
4. 장식 아이콘은 accessibility tree에서 제외한다. 정보를 단독 전달하는
|
||||||
|
아이콘은 `label`, icon-only action은 필수 `accessibleName`을 사용한다.
|
||||||
|
5. 현재 복합 control은 native `dialog`, form control, `details`와 local
|
||||||
|
TypeScript state model로 구현한다. Menu는 roving focus/typeahead/Escape,
|
||||||
|
Tabs는 manual/automatic activation, Drawer는 modal/background
|
||||||
|
비활성화/focus restore 계약을 가진다.
|
||||||
|
6. React Aria와 Radix는 기본 dependency로 추가하지 않는다. native platform이
|
||||||
|
collision, nested overlay, virtualized collection 또는 복합 select 요구를
|
||||||
|
충족하지 못한다는 재현 가능한 요구가 생길 때 prototype과 ADR로 다시
|
||||||
|
평가한다.
|
||||||
|
7. Storybook과 pinned visual baseline은 VD-08/RP-10에서 도입한다. RP-07의
|
||||||
|
runtime gallery와 browser interaction test는 해당 workshop을 대체한다고
|
||||||
|
주장하지 않는다.
|
||||||
|
|
||||||
|
## 경계와 검증
|
||||||
|
|
||||||
|
- 제품 코드는 `presentation/design-system/index`만 import한다.
|
||||||
|
- design-system 검사기는 direct icon/headless import, deep import, raw palette,
|
||||||
|
undefined token과 tooltip-only required information fixture를 거절한다.
|
||||||
|
- type negative fixture는 accessible name 없는 `IconButton`을 거절한다.
|
||||||
|
- component test는 decorative icon, form control, Menu, Tabs, Drawer와 Toast를
|
||||||
|
검증한다.
|
||||||
|
- Chromium/Firefox E2E는 compact Drawer의 native modal 상태, Escape, focus
|
||||||
|
restore, gallery keyboard interaction과 axe를 검증한다.
|
||||||
|
- 로컬 WebKit 실행은 host `libevent-2.1.so.7` 부재로 환경 검증이 남아 있으며
|
||||||
|
공급자 선택이나 product behavior의 PASS로 숨기지 않는다.
|
||||||
|
|
||||||
|
## Rollback
|
||||||
|
|
||||||
|
기존 `presentation/components/ui/*` 경로는 canonical TypeScript primitive를
|
||||||
|
재수출하므로 소비 코드를 즉시 되돌릴 수 있다. Lucide 제거 시 vendor facade와
|
||||||
|
semantic icon 구현만 교체하고 제품 API는 유지한다. headless vendor를 나중에
|
||||||
|
도입해도 public props와 interaction test를 유지한다.
|
||||||
@@ -12,9 +12,9 @@
|
|||||||
- 기본 번들에 포함할 역량과 필요할 때 설치할 확장 역량을 구분한다.
|
- 기본 번들에 포함할 역량과 필요할 때 설치할 확장 역량을 구분한다.
|
||||||
- 특정 벤더를 채택하더라도 제품 코드가 벤더 API에 직접 결합되지 않는지 확인한다.
|
- 특정 벤더를 채택하더라도 제품 코드가 벤더 API에 직접 결합되지 않는지 확인한다.
|
||||||
|
|
||||||
검토 기준 브랜치는 `develop`, 기준 커밋은 `cb195f8`이다. 이후 구현으로 경로나
|
최초 검토 기준은 `develop`의 `cb195f8`이며, RP-01~RP-04 구현 결과를 이 문서에
|
||||||
세부 내용이 달라질 수 있으므로, 각 항목은 문서의 경로뿐 아니라 해당 테스트와
|
누적 반영했다. 이후 구현으로 경로나 세부 내용이 달라질 수 있으므로, 각 항목은
|
||||||
아키텍처 게이트로 계속 검증해야 한다.
|
문서의 경로뿐 아니라 해당 테스트와 아키텍처 게이트로 계속 검증해야 한다.
|
||||||
|
|
||||||
## 2. 결론
|
## 2. 결론
|
||||||
|
|
||||||
@@ -33,13 +33,13 @@
|
|||||||
|
|
||||||
특히 다음은 선행 해결이 필요하다.
|
특히 다음은 선행 해결이 필요하다.
|
||||||
|
|
||||||
RP-01~RP-03에서 TypeScript 도구 안전망, application runtime 주입,
|
RP-01~RP-05에서 TypeScript 도구 안전망, application runtime 주입,
|
||||||
query/mutation inbound adapter와 HTTP 실행 계약은 구현됐다. 현재 선행 해결
|
query/mutation inbound adapter, HTTP 실행 계약과 executable route/release
|
||||||
|
recovery 계약, 제거 가능한 reference 수직 슬라이스는 구현됐다. 현재 선행 해결
|
||||||
대상은 다음과 같다.
|
대상은 다음과 같다.
|
||||||
|
|
||||||
1. 선언과 실행이 일치하는 typed route 계약
|
1. 폼, 페이지 템플릿, 확장된 디자인 시스템과 컴포넌트 워크벤치
|
||||||
2. 전체를 제거할 수 있는 실제 reference feature
|
2. 국제화, diagnostics, optional adapter recipe와 심화 품질 게이트
|
||||||
3. 폼, 페이지 템플릿, 확장된 디자인 시스템과 컴포넌트 워크벤치
|
|
||||||
|
|
||||||
따라서 현재 상태를 “프론트 공통부가 모두 구현됐다”고 표현하면 범위가 과장된다.
|
따라서 현재 상태를 “프론트 공통부가 모두 구현됐다”고 표현하면 범위가 과장된다.
|
||||||
더 정확한 표현은 다음과 같다.
|
더 정확한 표현은 다음과 같다.
|
||||||
@@ -67,25 +67,25 @@ query/mutation inbound adapter와 HTTP 실행 계약은 구현됐다. 현재 선
|
|||||||
| HTTP client | 준비됨 | path/search/body projection, runtime timeout/retry, abort/cleanup test | feature gateway 뒤에서 사용 |
|
| HTTP client | 준비됨 | path/search/body projection, runtime timeout/retry, abort/cleanup test | feature gateway 뒤에서 사용 |
|
||||||
| retry | 준비됨 | HTTP 단일 소유, runtime max attempts, Query retry off | RP-09에서 telemetry 연결 |
|
| retry | 준비됨 | HTTP 단일 소유, runtime max attempts, Query retry off | RP-09에서 telemetry 연결 |
|
||||||
| 오류 모델 | 부분 준비 | error registry와 normalization 존재 | typed discriminated union과 계층별 mapper |
|
| 오류 모델 | 부분 준비 | error registry와 normalization 존재 | typed discriminated union과 계층별 mapper |
|
||||||
| 검증 | 부분 준비 | runtime/API Zod parse 결과를 실제 request에 사용 | route/form/domain 경계를 추가 |
|
| 검증 | 준비됨 | runtime/API/route/form Zod parse 결과를 실행 경계에서 사용하고 domain invariant와 분리 | feature별 schema 소유권 유지 |
|
||||||
| 인증 연동 | 준비됨/프로젝트 선택 | opaque auth owner와 demo seam 존재 | 인증 방식별 recipe; 기본 token 저장소는 추가하지 않음 |
|
| 인증 연동 | 준비됨/프로젝트 선택 | opaque auth owner와 demo seam 존재 | 인증 방식별 recipe; 기본 token 저장소는 추가하지 않음 |
|
||||||
| 서버 상태 | 부분 준비 | 제한된 query/mutation bridge와 lifecycle test | RP-05 reference route에서 실제 feature 연결 |
|
| 서버 상태 | 준비됨 | reference route의 query/mutation, cancellation, stale, optimistic/conflict/rollback | feature별 query contribution recipe 유지 |
|
||||||
| 클라이언트 상태 | 부분 준비 | local state, theme context, session external store | 상태 소유권 표와 typed external-store 예제 |
|
| 클라이언트 상태 | 부분 준비 | local state, theme context, session external store | 상태 소유권 표와 typed external-store 예제 |
|
||||||
| 범용 global store | 프로젝트 선택 | 별도 라이브러리 없음 | 필요 조건에 따라 Zustand/Redux Toolkit/state machine 선택 |
|
| 범용 global store | 프로젝트 선택 | 별도 라이브러리 없음 | 필요 조건에 따라 Zustand/Redux Toolkit/state machine 선택 |
|
||||||
| 라우팅 | 부분 준비 | lazy route, access hint, registry 존재 | typed runtime map, codec, recovery, metadata 집행 |
|
| 라우팅 | 준비됨 | Data Router, typed runtime map, codec, metadata consumer, bounded chunk recovery | reference feature route와 release E2E로 사용 범위 확장 |
|
||||||
| 앱 셸·반응형 | 부분 준비 | header/sidebar/content/theme 구현 | 접근 가능한 mobile drawer와 focus 복원 |
|
| 앱 셸·반응형 | 준비됨 | native modal Drawer, compact/desktop layout, Escape/link dismiss와 focus restore | RP-08에서 RTL/direction 검증 |
|
||||||
| 페이지 템플릿 | 미제공 | 각 페이지가 직접 레이아웃 조립 | list/detail/form/status 등 슬롯 기반 템플릿 |
|
| 페이지 템플릿 | 준비됨 | Standard/Collection/Detail/Form/Status와 public design-system entry | feature별 slot 조합 유지 |
|
||||||
| 디자인 토큰 | 부분 준비 | semantic color/theme 토큰 존재 | typography, spacing, motion, layer 등 3단계 토큰 |
|
| 디자인 토큰 | 준비됨 | primitive/semantic/component CSS, 48-token 자동 계약, dark/forced-colors/reduced-motion | 제품 brand token은 외부 프로젝트에서 확장 |
|
||||||
| 공통 UI | 부분 준비 | Button, TextField, Card, Alert, Badge, Dialog | form/navigation/overlay/data/layout primitives 확장 |
|
| 공통 UI | 준비됨 | action/form/feedback/overlay/navigation primitive와 pattern, compatibility export | Storybook/visual은 RP-10 |
|
||||||
| 아이콘 | 미제공 | 문자 기호를 직접 사용 | Lucide를 로컬 icon facade 뒤에서 사용 |
|
| 아이콘 | 준비됨 | Lucide static vendor facade와 semantic icon/IconButton 접근성 계약 | 의미 icon 추가 시 bundle/접근성 기준 적용 |
|
||||||
| 폼 | 미제공 | 수동 문자열 검증 예제만 존재 | schema 기반 form facade와 422/dirty/pending 정책 |
|
| 폼 | 준비됨 | Zod 기반 local facade, error summary/focus, 422 allowlist, dirty/pending/conflict 정책 | 복합 form 요구가 생기면 VD-04 조건으로 vendor adapter 평가 |
|
||||||
| 국제화 | 미제공 | 한국어 문자열·locale이 하드코딩 | typed message/formatter/locale/RTL 경계 |
|
| 국제화 | 미제공 | 한국어 문자열·locale이 하드코딩 | typed message/formatter/locale/RTL 경계 |
|
||||||
| logging/diagnostics | 미제공 | telemetry port는 있으나 logger 없음 | redaction이 적용된 diagnostics/logging 경계 |
|
| logging/diagnostics | 미제공 | telemetry port는 있으나 logger 없음 | redaction이 적용된 diagnostics/logging 경계 |
|
||||||
| telemetry | 부분 준비 | registry, queue, redaction 존재 | HTTP·boot·cache·storage·route 사건에 실제 연결 |
|
| telemetry | 부분 준비 | registry, queue, redaction 존재 | HTTP·boot·cache·storage·route 사건에 실제 연결 |
|
||||||
| 비동기 상태 불변식 | 준비됨 | 배타적 typed overlay, stale latch, 실제 retry/conflict action | reference 화면에서 전체 상태 전시 |
|
| 비동기 상태 불변식 | 준비됨 | 배타적 typed overlay, stale latch, 실제 retry/conflict action | reference 화면에서 전체 상태 전시 |
|
||||||
| 단위·통합·E2E | 준비됨 | Vitest, RTL, MSW, Playwright 3엔진 | TS 테스트 검사, 실제 bootstrap 통합, 위험 시나리오 보강 |
|
| 단위·통합·E2E | 준비됨 | Vitest, RTL, MSW, Playwright 3엔진 | TS 테스트 검사, 실제 bootstrap 통합, 위험 시나리오 보강 |
|
||||||
| UI 회귀 검증 | 미제공 | axe/reflow는 있으나 visual baseline 없음 | Storybook 또는 동급 workshop과 시각 회귀 |
|
| UI 회귀 검증 | 미제공 | axe/reflow는 있으나 visual baseline 없음 | Storybook 또는 동급 workshop과 시각 회귀 |
|
||||||
| 샘플 제거 | 부분 준비 | fixture 제거 테스트 존재 | sample domain/registry/runtime 전체 제거 검증 |
|
| 샘플 제거 | 준비됨 | feature/catalog/test 제거 후 type/architecture/registry/test/home/build 8단계 검증 | 새 contribution도 같은 제거 gate에 포함 |
|
||||||
| registry·compatibility 집행 | 부분 준비 | registry와 gate는 있으나 실제 before/after 및 orphan 검사가 제한적 | type/reference/orphan/diff/migration을 자동 검증 |
|
| registry·compatibility 집행 | 부분 준비 | registry와 gate는 있으나 실제 before/after 및 orphan 검사가 제한적 | type/reference/orphan/diff/migration을 자동 검증 |
|
||||||
| 공급망 검사 | 부분 준비 | lockfile·문서·gate는 있으나 실제 transitive 취약점/license/SBOM 깊이가 부족 | pinned scanner와 policy exception/증적 연결 |
|
| 공급망 검사 | 부분 준비 | lockfile·문서·gate는 있으나 실제 transitive 취약점/license/SBOM 깊이가 부족 | pinned scanner와 policy exception/증적 연결 |
|
||||||
| realtime·offline·file 등 | 프로젝트 선택 | 현재 없음 | port/adapter recipe와 선택 기준 제공 |
|
| realtime·offline·file 등 | 프로젝트 선택 | 현재 없음 | port/adapter recipe와 선택 기준 제공 |
|
||||||
@@ -156,14 +156,16 @@ client를 거대한 범용 함수로 계속 확장하지 말고 transport, reque
|
|||||||
timeout, retry, decoder, mapper 책임을 분리해야 한다. application에는 범용 HTTP
|
timeout, retry, decoder, mapper 책임을 분리해야 한다. application에는 범용 HTTP
|
||||||
메서드보다 feature가 요구하는 gateway interface를 노출한다.
|
메서드보다 feature가 요구하는 gateway interface를 노출한다.
|
||||||
|
|
||||||
#### route registry가 실행 계약이 아니다
|
#### RP-04에서 route registry를 실행 계약으로 전환
|
||||||
|
|
||||||
route registry에는 `paramsSchema`, `searchSchema`, `loadingSurface`,
|
platform route 계약과 `src/features/installed-feature-contracts.js`의 직렬화
|
||||||
`errorSurface`, `chunkId`가 있지만 실제 router tree, lazy module, navigation
|
가능한 contribution을 기준으로
|
||||||
목록은 별도로 작성된다. 여러 필드는 선언만 되고 런타임에 사용되지 않는다.
|
`src/presentation/routes/app-router.tsx`가 Data Router route object와
|
||||||
chunk recovery use case와 redirect loop guard도 실제 route flow에 연결되지 않는다.
|
navigation을 생성한다. `route-runtime.tsx`는 lazy component의 실행 map만
|
||||||
|
소유하며 contract/runtime 누락과 orphan은 TypeScript negative fixture와 registry
|
||||||
|
gate가 모두 거절한다.
|
||||||
|
|
||||||
목표 상태:
|
현재 보장:
|
||||||
|
|
||||||
- serializable contract와 executable runtime map을 분리한다.
|
- serializable contract와 executable runtime map을 분리한다.
|
||||||
- `satisfies Record<RouteId, RouteRuntime>`로 양방향 완전성을 검사한다.
|
- `satisfies Record<RouteId, RouteRuntime>`로 양방향 완전성을 검사한다.
|
||||||
@@ -171,19 +173,23 @@ chunk recovery use case와 redirect loop guard도 실제 route flow에 연결되
|
|||||||
사용한다.
|
사용한다.
|
||||||
- loading/error/chunk/access/title/navigation metadata를 실제 route object에
|
- loading/error/chunk/access/title/navigation metadata를 실제 route object에
|
||||||
연결한다.
|
연결한다.
|
||||||
- route change 시 boundary reset, focus, scroll, navigation cancellation을
|
- route change 시 boundary reset, title, focus와 scroll을 검증한다.
|
||||||
검증한다.
|
- Vite manifest의 실제 dynamic entry와 route chunk ID를 release manifest에
|
||||||
|
연결하고, no-store manifest 재조회와 build/release 쌍별 1회 reload를
|
||||||
|
production application input까지 연결한다.
|
||||||
|
|
||||||
#### reference feature가 완전히 제거되지 않는다
|
#### RP-05에서 제거 가능한 reference feature 구현
|
||||||
|
|
||||||
현재 sample removal gate는 `src/sample/contract-fixture`만 삭제한다. sample API
|
`src/features/reference-feature`가 domain, application input, outbound gateway,
|
||||||
operation, schema, mapper, domain model, query key는 다른 production 경로에 남는다.
|
DTO/schema, mapper, route/API/query contract, query/mutation controller와 page를
|
||||||
반면 화면에 노출된 `/sample/resources`는 실제 query 수직 흐름을 실행하지 않는다.
|
한 소유 경계에 둔다. production composition은 generic feature input catalog를
|
||||||
|
통해 이 input을 주입하며 UI는 HTTP나 output port를 직접 보지 않는다.
|
||||||
|
|
||||||
reference feature는 domain, application input/output, schemas, operation,
|
`test:sample-removal`은 임시 복제본에서 feature source/tests를 삭제하고 installed
|
||||||
mapper, query controller, pages, tests를 한 소유 경계 아래 모아야 한다. 해당 모듈과
|
contract/runtime/adapter catalog를 빈 목록으로 재생성한다. 그 뒤 typecheck,
|
||||||
registry contribution을 제거한 뒤 typecheck, architecture, test, build가 모두
|
architecture, registry, unit/integration, home smoke, build와 fixture ID 잔여
|
||||||
통과해야 “제거 가능”으로 판정한다.
|
0개를 검사한다. 설치 모드에서는 MSW를 사용한 bootstrap → router → application
|
||||||
|
→ HTTP → schema → mapper → query cache → page 수직 테스트가 실행된다.
|
||||||
|
|
||||||
#### 비동기·복구 상태의 불변식이 닫혀 있지 않다
|
#### 비동기·복구 상태의 불변식이 닫혀 있지 않다
|
||||||
|
|
||||||
@@ -204,9 +210,11 @@ mutation-pending
|
|||||||
mutation-conflict
|
mutation-conflict
|
||||||
```
|
```
|
||||||
|
|
||||||
chunk recovery와 release coherence도 policy 함수가 존재하는 것으로 완료되지
|
RP-04에서 lazy import failure는 `ChunkRecoveryBoundary` → application recovery
|
||||||
않는다. 실제 lazy import failure가 manifest 재확인, build 비교, 단 한 번의 guarded
|
input → `ReleaseInfoPort.refresh()`의 no-store manifest 조회 → build/release 쌍
|
||||||
reload, 반복 실패 지원 표면까지 이어지고 E2E로 검증되어야 한다.
|
guard → browser navigation adapter의 1회 reload로 연결됐다. 일반 render
|
||||||
|
failure는 이 경로에서 제외되고, 반복 실패·offline·malformed manifest·storage
|
||||||
|
실패는 지원 표면으로 fail-closed된다.
|
||||||
|
|
||||||
#### telemetry, registry, 공급망 gate의 실행 깊이가 부족하다
|
#### telemetry, registry, 공급망 gate의 실행 깊이가 부족하다
|
||||||
|
|
||||||
@@ -228,8 +236,8 @@ known vulnerability, license policy, SBOM/provenance를 pinned tool로 검사해
|
|||||||
|
|
||||||
### 5.2 P1: 공통 플랫폼 기본 제공 항목
|
### 5.2 P1: 공통 플랫폼 기본 제공 항목
|
||||||
|
|
||||||
- schema 기반 form facade와 field/error/pending/dirty/422 정책
|
- RP-06에서 완료한 schema 기반 form facade와 field/error/pending/dirty/422 정책 유지
|
||||||
- standard, collection, detail, form, status page template
|
- RP-06에서 완료한 standard, collection, detail, form, status page template의 public entry 정리
|
||||||
- 접근 가능한 drawer, menu, popover, select 같은 interaction primitive
|
- 접근 가능한 drawer, menu, popover, select 같은 interaction primitive
|
||||||
- token → primitive → pattern → template로 이어지는 디자인 시스템
|
- token → primitive → pattern → template로 이어지는 디자인 시스템
|
||||||
- Lucide를 감싼 local icon registry와 `IconButton`
|
- Lucide를 감싼 local icon registry와 `IconButton`
|
||||||
@@ -378,7 +386,8 @@ tree-shakable SVG icon source로 적절하지만 select, dialog, menu, focus man
|
|||||||
- TS source와 test 전체 typecheck
|
- TS source와 test 전체 typecheck
|
||||||
- 실제 composition root부터 page까지의 통합
|
- 실제 composition root부터 page까지의 통합
|
||||||
- query/mutation controller와 optimistic rollback
|
- query/mutation controller와 optimistic rollback
|
||||||
- route registry/runtime map 정합성
|
- route registry/runtime map 정합성은 RP-04에서 unit, component, negative
|
||||||
|
registry/type fixture와 built artifact 검증으로 구현됨
|
||||||
- runtime timeout/retry와 path/query/parsed body
|
- runtime timeout/retry와 path/query/parsed body
|
||||||
- shared MSW scenario catalog
|
- shared MSW scenario catalog
|
||||||
- isolated component stories와 interaction test
|
- isolated component stories와 interaction test
|
||||||
|
|||||||
@@ -508,6 +508,22 @@ RP-06은 기존 reference controls/layout으로 돌아가도 controller/applicat
|
|||||||
경계가 유지돼야 한다. vendor adapter, form contract와 template commit을 구분해
|
경계가 유지돼야 한다. vendor adapter, form contract와 template commit을 구분해
|
||||||
부분 revert가 가능하게 한다.
|
부분 revert가 가능하게 한다.
|
||||||
|
|
||||||
|
**구현 증거 (2026-07-26)**
|
||||||
|
|
||||||
|
- VD-04에서 dependency 추가 없는 native controller + Zod local facade를
|
||||||
|
채택했고 vendor 도입 조건을 문서화했다.
|
||||||
|
- `src/presentation/forms`가 field registration, parse/error map,
|
||||||
|
dirty/touched/reset/pending/result, 422 allowlist, first-error focus,
|
||||||
|
duplicate submit과 dirty navigation을 제공한다.
|
||||||
|
- `src/presentation/templates`가 다섯 page 유형의 slot/landmark/responsive
|
||||||
|
계약을 제공하며 architecture negative fixture가 application/vendor import를
|
||||||
|
거절한다.
|
||||||
|
- reference list/detail/create/status route가 네 구체 template를 사용하고
|
||||||
|
production composition test가 list → form → command → HTTP → invalidation →
|
||||||
|
list 경로를 실행한다.
|
||||||
|
- component/integration/E2E test가 validation, transform, 422, conflict,
|
||||||
|
secret 비노출, navigation focus와 320px reflow를 검증한다.
|
||||||
|
|
||||||
### 07. `feature-frontend-design-system-platform`
|
### 07. `feature-frontend-design-system-platform`
|
||||||
|
|
||||||
**목표**
|
**목표**
|
||||||
@@ -572,6 +588,22 @@ RP-07은 compatibility export로 기존 primitive import를 복구할 수 있어
|
|||||||
token rename은 alias/migration 기간을 두고, vendor adapter와 local API commit을
|
token rename은 alias/migration 기간을 두고, vendor adapter와 local API commit을
|
||||||
분리한다.
|
분리한다.
|
||||||
|
|
||||||
|
**구현 증거 (2026-07-26)**
|
||||||
|
|
||||||
|
- VD-05에서 `lucide-react@1.25.0` static semantic facade와 native-first
|
||||||
|
interaction을 채택하고 headless vendor 재평가 조건을 닫았다.
|
||||||
|
- `src/presentation/design-system`이 48개 필수 token, public TypeScript barrel,
|
||||||
|
action/form/feedback/overlay/navigation primitive와 공통 pattern을 제공한다.
|
||||||
|
- 기존 `components/ui` 경로는 compatibility export로 유지하고 앱 셸, gallery와
|
||||||
|
reference feature는 public entry를 소비한다.
|
||||||
|
- 모바일 navigation은 native modal Drawer로 전환되어 배경 비활성화, Escape,
|
||||||
|
route dismiss와 trigger focus restore를 제공한다.
|
||||||
|
- source/negative fixture gate가 undefined token, raw palette, direct vendor,
|
||||||
|
deep import, tooltip-only 정보와 accessible name 누락을 거절한다.
|
||||||
|
- component/browser test가 Menu typeahead, Tabs activation, Toast queue,
|
||||||
|
form controls, compact reflow와 open-dialog axe를 실행한다. 로컬 WebKit은 host
|
||||||
|
`libevent-2.1.so.7` 부재로 환경 검증 상태를 유지한다.
|
||||||
|
|
||||||
### 08. `feature-frontend-i18n-message-formatting-contract`
|
### 08. `feature-frontend-i18n-message-formatting-contract`
|
||||||
|
|
||||||
**목표**
|
**목표**
|
||||||
|
|||||||
@@ -116,7 +116,7 @@ bootstrap은 page별 orchestration이나 업무 규칙을 소유하지 않는다
|
|||||||
| `src/adapters` | HTTP, auth, storage, cache, telemetry 구현 | outbound adapter |
|
| `src/adapters` | HTTP, auth, storage, cache, telemetry 구현 | outbound adapter |
|
||||||
| `src/bootstrap` | runtime config와 구현 조립 | 유일한 composition root |
|
| `src/bootstrap` | runtime config와 구현 조립 | 유일한 composition root |
|
||||||
| `src/contracts` | 여러 계층의 registry가 혼재 | 소유 계층으로 분산 |
|
| `src/contracts` | 여러 계층의 registry가 혼재 | 소유 계층으로 분산 |
|
||||||
| `src/sample` | 제거 가능한 예제 일부 | 완전한 removable reference feature |
|
| `src/features/reference-feature` | 완전한 제거 가능 수직 예제 | installed contribution과 8단계 제거 gate 유지 |
|
||||||
|
|
||||||
현재 구조가 잘 제공하는 기반은 다음과 같다.
|
현재 구조가 잘 제공하는 기반은 다음과 같다.
|
||||||
|
|
||||||
@@ -154,13 +154,29 @@ RP-03 구현으로 HTTP와 server-state 경계도 다음처럼 연결됐다.
|
|||||||
- HTTP가 자동 network retry를 소유하고 query/mutation adapter의 vendor retry는
|
- HTTP가 자동 network retry를 소유하고 query/mutation adapter의 vendor retry는
|
||||||
비활성화한다.
|
비활성화한다.
|
||||||
|
|
||||||
후속 브랜치에서 닫아야 할 실행 불일치는 다음과 같다.
|
RP-04에서 route 실행 불일치는 닫혔다. route registry와 runtime map은
|
||||||
|
Data Router tree, codec, surface, title, navigation, chunk/release recovery의
|
||||||
|
단일 조립 입력이며 registry/type/build 검증이 누락과 orphan을 거절한다.
|
||||||
|
|
||||||
1. route registry의 `paramsSchema`, `searchSchema`, `loadingSurface`,
|
RP-05에서 두 번째 불일치도 닫혔다. feature별 domain/application/adapter/
|
||||||
`errorSurface`, `chunkId` 일부는 실행 route와 연결되지 않았다.
|
contract/presentation은 `src/features/reference-feature`가 소유하고, generic
|
||||||
2. 제거 테스트는 `src/sample/contract-fixture`만 제거하며, sample API
|
installed catalog만 bootstrap과 router에 노출된다. 제거 gate는 feature와 test를
|
||||||
operation, Zod schema, mapper, domain model과 query key는 다른 경로에
|
삭제한 복제본에서 전체 P0 경로를 다시 실행한다.
|
||||||
남는다.
|
|
||||||
|
RP-06에서 inbound form/page 경계도 실행됐다. `src/presentation/forms`는 Zod
|
||||||
|
presentation schema, controlled field state, error focus, 422 allowlist,
|
||||||
|
pending/deduplication과 dirty navigation을 local facade로 감싼다.
|
||||||
|
`src/presentation/templates`는 slot과 landmark만 소유하고 application, HTTP,
|
||||||
|
query vendor import는 architecture gate가 거절한다. reference feature의
|
||||||
|
list/detail/create/status route가 각각 Collection/Detail/Form/Status template의
|
||||||
|
실제 consumer다.
|
||||||
|
|
||||||
|
RP-07에서 React inbound adapter 안의 UI 공급자 경계도 닫혔다.
|
||||||
|
`src/presentation/design-system/index.ts`는 token → primitive → pattern →
|
||||||
|
template public API이며 feature와 shell은 이 entry만 소비한다. Lucide는
|
||||||
|
`icons/vendors/lucide.tsx`에 격리된 inbound vendor facade이므로 application
|
||||||
|
port가 아니다. native Dialog/Drawer/Menu/Tabs의 focus·keyboard 상태도
|
||||||
|
presentation이 소유하고 use case나 outbound adapter로 올리지 않는다.
|
||||||
|
|
||||||
이 문서의 목표 구조는 기존 기반을 폐기하는 것이 아니라 이러한
|
이 문서의 목표 구조는 기존 기반을 폐기하는 것이 아니라 이러한
|
||||||
불일치를 제거하는 것이다.
|
불일치를 제거하는 것이다.
|
||||||
@@ -1212,19 +1228,19 @@ contract와 실패 분기를 우선한다.
|
|||||||
|
|
||||||
### 26.4 Routing과 상태
|
### 26.4 Routing과 상태
|
||||||
|
|
||||||
- [ ] route registry와 실행 route tree가 동일 source에서 생성된다.
|
- [x] route registry와 실행 route tree가 동일 source에서 생성된다.
|
||||||
- [ ] params/search schema가 실제 navigation에서 실행된다.
|
- [x] params/search schema가 실제 navigation에서 실행된다.
|
||||||
- [ ] loading/error/chunk/access metadata가 실행 behavior와 연결된다.
|
- [x] loading/error/chunk/access metadata가 실행 behavior와 연결된다.
|
||||||
- [ ] local, URL, server, session, persisted state가 분류 규칙을 따른다.
|
- [ ] local, URL, server, session, persisted state가 분류 규칙을 따른다.
|
||||||
- [ ] server state를 별도 global store에 중복 보관하지 않는다.
|
- [ ] server state를 별도 global store에 중복 보관하지 않는다.
|
||||||
|
|
||||||
### 26.5 Reference feature
|
### 26.5 Reference feature
|
||||||
|
|
||||||
- [ ] route부터 API mapper와 화면까지 완전한 수직 경로가 실행된다.
|
- [x] route부터 API mapper와 화면까지 완전한 수직 경로가 실행된다.
|
||||||
- [ ] list/create 등 최소 query와 mutation 예제가 있다.
|
- [x] list/create 등 최소 query와 mutation 예제가 있다.
|
||||||
- [ ] loading/empty/error/refresh/conflict 상태가 있다.
|
- [x] loading/empty/error/refresh/conflict 상태가 있다.
|
||||||
- [ ] reference feature 전체 삭제 후 typecheck/test/build가 통과한다.
|
- [x] reference feature 전체 삭제 후 typecheck/architecture/registry/test/home/build가 통과한다.
|
||||||
- [ ] built asset에 reference operation, schema, mapper가 남지 않는다.
|
- [x] 제거 모드 built asset에 reference operation, schema, mapper가 남지 않는다.
|
||||||
|
|
||||||
### 26.6 품질
|
### 26.6 품질
|
||||||
|
|
||||||
@@ -1248,8 +1264,8 @@ contract와 실패 분기를 우선한다.
|
|||||||
|
|
||||||
### P1: 기본 플랫폼 완성도
|
### P1: 기본 플랫폼 완성도
|
||||||
|
|
||||||
1. error/result/validation/form kernel
|
1. 완료: error/result/validation/form kernel
|
||||||
2. 배타적인 async 상태와 page template
|
2. 완료: 배타적인 async 상태와 page template
|
||||||
3. Logger와 telemetry 실제 wiring
|
3. Logger와 telemetry 실제 wiring
|
||||||
4. design-system public API, icon wrapper와 headless interaction
|
4. design-system public API, icon wrapper와 headless interaction
|
||||||
5. locale/message/formatter와 pseudo-locale/RTL 경계
|
5. locale/message/formatter와 pseudo-locale/RTL 경계
|
||||||
|
|||||||
@@ -44,12 +44,13 @@ flowchart LR
|
|||||||
The current executable route tree is mounted only after runtime configuration
|
The current executable route tree is mounted only after runtime configuration
|
||||||
and release-manifest coherence pass. It receives the composed query client,
|
and release-manifest coherence pass. It receives the composed query client,
|
||||||
credential-opaque session port, storage port, telemetry port, and immutable
|
credential-opaque session port, storage port, telemetry port, and immutable
|
||||||
build ID. Visible starter pages do not depend on the removable sample fixture.
|
build ID. Generic starter pages do not depend on the removable reference
|
||||||
|
feature.
|
||||||
|
|
||||||
This describes the current starter composition, not the completed target. The
|
This describes the current starter composition, not the completed target. The
|
||||||
capability review found that raw outbound capabilities still reach the React
|
capability review found that raw outbound capabilities still reach the React
|
||||||
tree, the composed application facade is not yet its entry point, and several
|
tree, the composed application facade is not yet its entry point, and several
|
||||||
route, HTTP, recovery, telemetry, and sample-removal contracts are only
|
route, HTTP, recovery, telemetry, and reference-feature removal contracts are only
|
||||||
partially connected. Use the following documents for the evidence and migration
|
partially connected. Use the following documents for the evidence and migration
|
||||||
plan:
|
plan:
|
||||||
|
|
||||||
|
|||||||
@@ -12,30 +12,36 @@
|
|||||||
- page controller와 application input use case의 연결
|
- page controller와 application input use case의 연결
|
||||||
- 프론트엔드에서 반복 사용하는 설계 패턴
|
- 프론트엔드에서 반복 사용하는 설계 패턴
|
||||||
|
|
||||||
## 2. 현재 상태와 문제
|
## 2. 현재 상태와 구현 기준
|
||||||
|
|
||||||
현재 구현에는 다음 장점이 있다.
|
RP-04 이후 route runtime과 RP-06 page/form platform에는 다음 장점이 있다.
|
||||||
|
|
||||||
- route registry가 path와 access policy를 소유한다.
|
- route registry가 path와 access policy를 소유한다.
|
||||||
- route component를 lazy import한다.
|
- contract에서 Data Router route object와 navigation을 생성한다.
|
||||||
|
- runtime map이 route component를 lazy import하고 codec을 연결한다.
|
||||||
- 앱 셸과 보호 route, not-found surface가 있다.
|
- 앱 셸과 보호 route, not-found surface가 있다.
|
||||||
- route heading focus와 비동기/render error boundary가 있다.
|
- route heading focus와 비동기/render error boundary가 있다.
|
||||||
- redirect loop와 chunk recovery에 대한 policy 함수가 일부 존재한다.
|
- redirect loop와 chunk recovery가 bounded production call graph에 연결돼 있다.
|
||||||
|
- `src/presentation/templates`가 standard/collection/detail/form/status slot,
|
||||||
|
landmark와 responsive layout을 제공한다.
|
||||||
|
- `src/presentation/forms`가 첫 오류 focus, error summary, 422 mapping,
|
||||||
|
duplicate submit과 dirty route blocker를 소유한다.
|
||||||
|
- reference feature의 list/detail/create/status route가 네 template variation을
|
||||||
|
production composition에서 실행한다.
|
||||||
|
|
||||||
하지만 `src/contracts/routes.js`의 metadata와
|
platform route 계약, `src/features/installed-feature-contracts.js`,
|
||||||
`src/presentation/routes/app-router.jsx`의 executable route tree가 별도 수동 목록이다.
|
`src/features/installed-feature-runtimes.tsx`의 완전성은 TypeScript와 registry
|
||||||
그 결과 다음 필드는 선언돼도 실제 행동을 보장하지 않는다.
|
negative fixture가 함께 검사한다. params/search codec, loading/error surface,
|
||||||
|
access, title, navigation, chunk ID는
|
||||||
|
`src/presentation/routes/app-router.tsx`에서 모두 소비된다. built Vite
|
||||||
|
manifest의 dynamic entry는 release manifest route chunk map과 검증되며,
|
||||||
|
`ChunkRecoveryBoundary`는 일반 render error와 chunk rejection을 분리한다.
|
||||||
|
|
||||||
- params/search schema
|
template는 데이터를 가져오지 않는다. reference page controller가 route input과
|
||||||
- loading/error surface
|
application input을 query/form facade에 연결하고, template에는 render할 slot과
|
||||||
- chunk ID
|
안전한 callback만 전달한다. 이 분리는
|
||||||
- route title/navigation label
|
`page-templates-own-layout-only` dependency rule과 forbidden import fixture가
|
||||||
- redirect loop guard
|
검증한다.
|
||||||
- chunk recovery policy
|
|
||||||
|
|
||||||
페이지도 공통 `PageHeader` 외에는 각자 section과 class를 직접 조립한다. 목록,
|
|
||||||
상세, 편집, 오류 페이지의 반복되는 접근성·반응형·상태 표면을 기능 팀이 다시
|
|
||||||
구현해야 한다.
|
|
||||||
|
|
||||||
## 3. React Router mode 결정
|
## 3. React Router mode 결정
|
||||||
|
|
||||||
@@ -50,15 +56,14 @@ selector를 `7.18.1`로 맞춰 확인한다.
|
|||||||
|
|
||||||
| mode | 선택 조건 | 이 저장소에서의 판단 |
|
| mode | 선택 조건 | 이 저장소에서의 판단 |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| Declarative | React composition과 외부 data layer가 route data를 소유 | 현재 구현이 사용 중인 기준선 |
|
| Declarative | React composition과 외부 data layer가 route data를 소유 | RP-04 이전 기준선 |
|
||||||
| Data | route object, blocker, scroll restoration, pending/navigation state가 필요 | 목표 skeleton의 navigation lifecycle에 적합 |
|
| Data | route object, blocker, scroll restoration, pending/navigation state가 필요 | VD-03으로 채택하고 RP-04에서 구현 |
|
||||||
| Framework | route module, type-safe href, code splitting, SSR/static 전략을 framework가 소유 | client-only skeleton 기본값으로는 범위가 큼 |
|
| Framework | route module, type-safe href, code splitting, SSR/static 전략을 framework가 소유 | client-only skeleton 기본값으로는 범위가 큼 |
|
||||||
|
|
||||||
목표 결정:
|
채택한 결정:
|
||||||
|
|
||||||
- client-only SPA와 TanStack Query/application use case를 유지한다.
|
- client-only SPA와 TanStack Query/application use case를 유지한다.
|
||||||
- 현재 `BrowserRouter` 기반 Declarative Mode에서 `createBrowserRouter`와
|
- `createBrowserRouter`와 `RouterProvider` 기반 Data Mode를 사용한다.
|
||||||
`RouterProvider` 기반 Data Mode로 이동한다.
|
|
||||||
- Data Mode를 선택하는 이유는 route object, navigation blocker, scroll
|
- Data Mode를 선택하는 이유는 route object, navigation blocker, scroll
|
||||||
restoration, route error 경계를 일관되게 소유하기 위해서다. loader/action으로
|
restoration, route error 경계를 일관되게 소유하기 위해서다. loader/action으로
|
||||||
서버 상태를 다시 소유하기 위해서가 아니다.
|
서버 상태를 다시 소유하기 위해서가 아니다.
|
||||||
@@ -68,8 +73,9 @@ selector를 `7.18.1`로 맞춰 확인한다.
|
|||||||
- SSR/static generation을 선택하기 전에는 Framework Mode를 기본값으로 만들지
|
- SSR/static generation을 선택하기 전에는 Framework Mode를 기본값으로 만들지
|
||||||
않는다.
|
않는다.
|
||||||
|
|
||||||
전환 브랜치 전까지 현재 Declarative router에 새 custom scroll/blocker
|
결정 근거와 rollback 경계는
|
||||||
implementation을 추가하지 않는다. 전환할 수 없는 프로젝트만 별도 ADR과
|
`docs/architecture/decisions/VD-03-react-router-data-mode.md`에 고정한다.
|
||||||
|
Data Mode를 사용할 수 없는 프로젝트만 별도 ADR과
|
||||||
`NavigationLifecycleAdapter`를 구현한다.
|
`NavigationLifecycleAdapter`를 구현한다.
|
||||||
|
|
||||||
## 4. route 계약과 runtime map
|
## 4. route 계약과 runtime map
|
||||||
|
|||||||
@@ -11,7 +11,8 @@ primitives, and state surfaces remain reusable.
|
|||||||
validated config + coherent release manifest
|
validated config + coherent release manifest
|
||||||
-> concrete adapters
|
-> concrete adapters
|
||||||
-> QueryClientProvider
|
-> QueryClientProvider
|
||||||
-> BrowserRouter
|
-> ApplicationProvider
|
||||||
|
-> RouterProvider
|
||||||
-> ThemeProvider
|
-> ThemeProvider
|
||||||
-> SessionProvider
|
-> SessionProvider
|
||||||
-> AppShell
|
-> AppShell
|
||||||
@@ -31,7 +32,7 @@ remain stable in the shell.
|
|||||||
| `EXAMPLES_UI` | `/examples/ui` | public | interactive primitives and tokens |
|
| `EXAMPLES_UI` | `/examples/ui` | public | interactive primitives and tokens |
|
||||||
| `EXAMPLES_STATES` | `/examples/states` | public | async and access state matrix |
|
| `EXAMPLES_STATES` | `/examples/states` | public | async and access state matrix |
|
||||||
| `EXAMPLES_AUTH` | `/examples/auth` | public | session integration controls |
|
| `EXAMPLES_AUTH` | `/examples/auth` | public | session integration controls |
|
||||||
| `SAMPLE_RESOURCE_LIST` | `/sample/resources` | integration-defined | protected integration seam |
|
| `REFERENCE_RESOURCE_LIST` | `/examples/reference-resources` | integration-defined | removable vertical slice |
|
||||||
| `NOT_FOUND` | `*` | public | safe navigation recovery |
|
| `NOT_FOUND` | `*` | public | safe navigation recovery |
|
||||||
|
|
||||||
Navigation labels and order come from `ROUTE_REGISTRY`; the sidebar does not
|
Navigation labels and order come from `ROUTE_REGISTRY`; the sidebar does not
|
||||||
@@ -54,24 +55,25 @@ An external owner implements `readState`, `subscribe`, `beginSignIn`,
|
|||||||
|
|
||||||
## Extending the starter
|
## Extending the starter
|
||||||
|
|
||||||
The steps below describe the current extension path. The platform review found
|
The steps below describe the current extension path. New platform work should follow
|
||||||
that several route metadata fields and the composed application facade are not
|
|
||||||
yet connected end to end. New platform work should follow
|
|
||||||
[routing, page templates, and reusable patterns](./routing-pages-and-patterns.md)
|
[routing, page templates, and reusable patterns](./routing-pages-and-patterns.md)
|
||||||
and the
|
and the
|
||||||
[TypeScript, state, and data-flow target](./typescript-state-and-data-flow.md)
|
[TypeScript, state, and data-flow target](./typescript-state-and-data-flow.md)
|
||||||
rather than adding another independent route or data-loading convention.
|
rather than adding another independent route or data-loading convention.
|
||||||
|
|
||||||
1. Register the route path, access hint, title, chunk, loading surface, error
|
1. Add a serializable contribution under the feature ownership boundary and
|
||||||
surface, and optional navigation metadata in `src/contracts/routes.js`.
|
install it through `src/features/installed-feature-contracts.js`.
|
||||||
2. Add a lazy page in `src/presentation/` and render it through `RouteSurface`.
|
2. Add the lazy component and route codecs through
|
||||||
3. Use application ports or use cases; do not import concrete adapters.
|
`src/features/installed-feature-runtimes.tsx`.
|
||||||
|
3. Compose feature application inputs and outbound gateways only through
|
||||||
|
`src/features/installed-feature-adapters.ts`.
|
||||||
4. Use the semantic tokens, UI primitives, and state surfaces before adding a
|
4. Use the semantic tokens, UI primitives, and state surfaces before adding a
|
||||||
project-specific variant.
|
project-specific variant.
|
||||||
5. Add component behavior, all-engine E2E, automated axe, and signed manual
|
5. Add component behavior, all-engine E2E, automated axe, and signed manual
|
||||||
route evidence.
|
route evidence.
|
||||||
6. Run `test:sample-removal` to prove the visible starter still builds without
|
6. Run `test:sample-removal` to prove the generic starter typechecks, passes
|
||||||
`src/sample/contract-fixture`.
|
architecture/registry/tests/home smoke, and builds without the complete
|
||||||
|
reference feature.
|
||||||
|
|
||||||
Theme preference is the public `COLOR_SCHEME` storage contract. Authentication
|
Theme preference is the public `COLOR_SCHEME` storage contract. Authentication
|
||||||
tokens and other secrets remain forbidden storage keys.
|
tokens and other secrets remain forbidden storage keys.
|
||||||
|
|||||||
@@ -487,8 +487,12 @@ raw response body, stack, token, URL query, PII를 사용자 copy나 일반 log
|
|||||||
|
|
||||||
## 8. 폼 표준
|
## 8. 폼 표준
|
||||||
|
|
||||||
form vendor는 React Hook Form 또는 TanStack Form 등을 평가하되 local facade 뒤에
|
VD-04에 따라 현재 기본 엔진은 React native form event와 controlled value이며
|
||||||
둔다. vendor 선택과 무관하게 다음 API를 제공한다.
|
Zod를 local facade 뒤에서 사용한다. 동적 field array, 비동기 field validation,
|
||||||
|
대규모 render isolation 요구가 실제로 생기면 public API를 유지한 채 React Hook
|
||||||
|
Form 또는 TanStack Form adapter를 평가한다.
|
||||||
|
|
||||||
|
현재 public API는 다음과 같다.
|
||||||
|
|
||||||
- `Form`
|
- `Form`
|
||||||
- `FormField`
|
- `FormField`
|
||||||
@@ -500,6 +504,18 @@ form vendor는 React Hook Form 또는 TanStack Form 등을 평가하되 local fa
|
|||||||
- `mapValidationFailureToFields`
|
- `mapValidationFailureToFields`
|
||||||
- `useDirtyNavigationGuard`
|
- `useDirtyNavigationGuard`
|
||||||
|
|
||||||
|
구현 위치:
|
||||||
|
|
||||||
|
- controller와 mapping: `src/presentation/forms`
|
||||||
|
- layout-only template: `src/presentation/templates`
|
||||||
|
- feature form schema/command mapper:
|
||||||
|
`src/features/reference-feature/presentation/reference-resource-form.ts`
|
||||||
|
- 실제 create page:
|
||||||
|
`src/features/reference-feature/presentation/reference-resource-form-page.tsx`
|
||||||
|
|
||||||
|
`ApiFailure.validationIssues`는 HTTP 경계가 투영한 `path`와 `code`만 담는다.
|
||||||
|
backend message와 알 수 없는 path는 field copy로 사용하지 않는다.
|
||||||
|
|
||||||
필수 동작:
|
필수 동작:
|
||||||
|
|
||||||
1. label, description, error를 stable ID와 `aria-describedby`로 연결
|
1. label, description, error를 stable ID와 `aria-describedby`로 연결
|
||||||
|
|||||||
@@ -34,6 +34,10 @@
|
|||||||
- 초기 로딩, 빈 화면, terminal error, background 상태
|
- 초기 로딩, 빈 화면, terminal error, background 상태
|
||||||
- `src/presentation/components/state-surfaces.jsx`
|
- `src/presentation/components/state-surfaces.jsx`
|
||||||
- 인증 필요, 권한 없음, 찾을 수 없음
|
- 인증 필요, 권한 없음, 찾을 수 없음
|
||||||
|
- `src/presentation/forms`
|
||||||
|
- local form facade, field/error summary, dirty navigation dialog
|
||||||
|
- `src/presentation/templates`
|
||||||
|
- Standard, Collection, Detail, Form, Status page template
|
||||||
- `/examples/ui`, `/examples/states`
|
- `/examples/ui`, `/examples/states`
|
||||||
- 실행 가능한 primitive와 상태 예제
|
- 실행 가능한 primitive와 상태 예제
|
||||||
- component/E2E/axe 테스트
|
- component/E2E/axe 테스트
|
||||||
@@ -43,23 +47,23 @@
|
|||||||
- Chromium, Firefox, WebKit
|
- Chromium, Firefox, WebKit
|
||||||
- 등록 라우트의 자동 접근성 검사
|
- 등록 라우트의 자동 접근성 검사
|
||||||
|
|
||||||
이 기반은 유효하지만 아직 디자인 시스템 플랫폼 전체는 아니다.
|
RP-07 구현 이후 이 기반은 저장소 내부 디자인 시스템 플랫폼 계약을 충족한다.
|
||||||
|
아래 목록은 구현 전 공백과 현재 해결 상태를 함께 보존한다.
|
||||||
|
|
||||||
1. 토큰이 색상 중심이며 typography, elevation, motion, z-layer, control size,
|
1. typography, elevation, motion, z-layer, control size와 breakpoint는
|
||||||
breakpoint가 계약으로 닫혀 있지 않다.
|
`design-system/tokens`의 3계층과 자동 gate로 닫혔다.
|
||||||
2. 공통 입력은 `TextField` 하나뿐이어서 일반적인 폼을 공통 규칙으로 만들 수
|
2. RP-06 form/page foundation은 준비됐지만 TextArea, Select, Checkbox,
|
||||||
없다.
|
RadioGroup 같은 form primitive 확장은 RP-07에 남아 있다.
|
||||||
3. 앱 셸과 예제 화면에서 공용 primitive 대신 raw `button`, `select`, 링크
|
3. 앱 셸, 예제와 reference feature는 public design-system barrel을 소비한다.
|
||||||
class를 다시 작성하는 곳이 있다.
|
4. 문자 glyph는 semantic Lucide facade로 교체됐다.
|
||||||
4. `☰`, `×` 같은 문자 glyph를 직접 사용하며 아이콘 공급자 경계가 없다.
|
5. token은 세 CSS 파일로 분리됐고 `theme.css`는 layout/component styling만
|
||||||
5. `theme.css` 하나가 token, layout, primitive, pattern 스타일을 모두 소유한다.
|
소유한다.
|
||||||
6. runtime gallery는 있지만 격리된 story, interaction story, 시각 회귀 기준선이
|
6. runtime gallery는 있지만 격리된 story, interaction story, 시각 회귀 기준선이
|
||||||
없다.
|
없다.
|
||||||
7. 사용자 문구가 한국어 literal로 고정되어 locale과 RTL 계약이 없다.
|
7. 사용자 문구가 한국어 literal로 고정되어 locale과 RTL 계약이 없다.
|
||||||
8. `StandardPage`, `CollectionPage`, `DetailPage`, `FormPage` 같은 공통 페이지
|
8. page template, form과 pattern은 public barrel에서 제공된다.
|
||||||
템플릿이 없다.
|
9. 모바일 navigation은 native modal Drawer로 focus 이동, 배경 비활성화,
|
||||||
9. 모바일 sidebar는 표시 전환은 되지만 modal drawer 수준의 focus 이동, focus
|
Escape/link dismiss와 trigger focus restore를 제공한다.
|
||||||
복원, 배경 비활성화 계약은 없다.
|
|
||||||
|
|
||||||
따라서 기존 구성요소는 폐기하지 않고 아래 목표 계층으로 이동·확장한다.
|
따라서 기존 구성요소는 폐기하지 않고 아래 목표 계층으로 이동·확장한다.
|
||||||
|
|
||||||
|
|||||||
@@ -37,8 +37,9 @@ Arbitrary-value policy:
|
|||||||
- user-controlled or runtime-composed class strings are forbidden
|
- user-controlled or runtime-composed class strings are forbidden
|
||||||
- class variants must be selected from a closed static map
|
- class variants must be selected from a closed static map
|
||||||
|
|
||||||
The removable sample may demonstrate tokens, but production starter modules do
|
The removable reference feature may demonstrate tokens, but generic production
|
||||||
not import from `src/sample/contract-fixture`.
|
starter modules do not import its domain, application, adapter, or presentation
|
||||||
|
implementation.
|
||||||
|
|
||||||
This file documents the currently implemented token and primitive baseline.
|
This file documents the currently implemented token and primitive baseline.
|
||||||
The [design-system platform contract](./design-system-platform.md) defines the
|
The [design-system platform contract](./design-system-platform.md) defines the
|
||||||
|
|||||||
@@ -370,10 +370,9 @@ QueryClientProvider
|
|||||||
-> AppShell
|
-> AppShell
|
||||||
```
|
```
|
||||||
|
|
||||||
04 routing branch에서 Data Mode로 전환할 때 `BrowserRouter`를
|
RP-04에서 `RouterProvider` 기반 Data Mode로 전환했다. router component test와
|
||||||
`RouterProvider`로 바꾸고 테스트 fixture도 같은 composition factory에서
|
runtime composition test는 production `AppRouter`와 composition 함수를 사용하며,
|
||||||
생성한다. 문서에 적힌 provider 순서를 테스트 전용 shell로 재현하지 말고
|
문서에 적힌 provider 순서를 테스트 전용 shell로 재현하지 않는다.
|
||||||
production composition 함수를 호출한다.
|
|
||||||
|
|
||||||
### 6.3 Boot E2E
|
### 6.3 Boot E2E
|
||||||
|
|
||||||
@@ -447,6 +446,24 @@ tests/support/query/
|
|||||||
helper는 production default를 복사하지 않는다. production factory를 호출하고
|
helper는 production default를 복사하지 않는다. production factory를 호출하고
|
||||||
필요한 시간·retry만 test override로 주입한다.
|
필요한 시간·retry만 test override로 주입한다.
|
||||||
|
|
||||||
|
RP-05의 executable reference matrix는
|
||||||
|
`tests/features/reference-feature`에 모여 있다. 설치 모드에서는 URL codec과
|
||||||
|
query key/HTTP search의 동일성, DTO 차단, loading/success/empty/terminal,
|
||||||
|
refreshing/stale, pending/duplicate/optimistic/conflict/rollback과 MSW production
|
||||||
|
composition을 검증한다. 제거 모드는 feature source/tests와 installed
|
||||||
|
contract/runtime/adapter contribution을 제거한 복제본에서 P0 gate와 built asset
|
||||||
|
잔여 0개를 다시 검증한다.
|
||||||
|
|
||||||
|
RP-06 form/page matrix는 `tests/component/form-foundation.test.tsx`,
|
||||||
|
`tests/component/page-templates.test.tsx`,
|
||||||
|
`tests/features/reference-feature/reference-page.test.tsx`와
|
||||||
|
`tests/e2e/reference-form.spec.js`에 있다. client validation에서 command 0회와
|
||||||
|
첫 오류 focus, Zod transform/default, pending 중 중복 제출, 승인된 422
|
||||||
|
field/unknown field mapping, conflict 입력 보존, reset/dirty, navigation
|
||||||
|
confirmation/focus restore, URL/storage 비노출과 320px reflow를 검증한다.
|
||||||
|
HTTP integration test는 backend copy를 버리고 422 `path`/`code`만 전달하는지
|
||||||
|
별도로 검사한다.
|
||||||
|
|
||||||
## 8. Form 테스트
|
## 8. Form 테스트
|
||||||
|
|
||||||
Form test는 field primitive, form controller, application command mapping을
|
Form test는 field primitive, form controller, application command mapping을
|
||||||
@@ -545,6 +562,13 @@ client route guard는 UX이며 authorization이 아님을 test 이름과 문서
|
|||||||
|
|
||||||
공용 컴포넌트는 한 번의 결함이 모든 페이지로 전파되므로 위험도가 높다.
|
공용 컴포넌트는 한 번의 결함이 모든 페이지로 전파되므로 위험도가 높다.
|
||||||
|
|
||||||
|
RP-07의 실행 경로는 `check:design-system`,
|
||||||
|
`check:design-system:fixture`, `check:types:fixture:icon-button`,
|
||||||
|
`tests/component/design-system-platform.test.tsx`와
|
||||||
|
`tests/e2e/design-system-interactions.spec.js`다. Story interaction/visual
|
||||||
|
baseline은 VD-08/RP-10에서 추가하며 현재 runtime gallery를 isolated workshop
|
||||||
|
완료 증거로 사용하지 않는다.
|
||||||
|
|
||||||
### 10.1 Component behavior
|
### 10.1 Component behavior
|
||||||
|
|
||||||
- native role/name/value
|
- native role/name/value
|
||||||
@@ -1273,7 +1297,8 @@ CI registry에 추가한다.
|
|||||||
3. MSW handlers/scenario/factory를 중앙 catalog로 이동한다.
|
3. MSW handlers/scenario/factory를 중앙 catalog로 이동한다.
|
||||||
4. query/mutation presentation adapter와 integration harness를 만든다.
|
4. query/mutation presentation adapter와 integration harness를 만든다.
|
||||||
5. form foundation과 form/controller test matrix를 만든다.
|
5. form foundation과 form/controller test matrix를 만든다.
|
||||||
6. route registry/runtime map contract와 built-dist E2E를 추가한다.
|
6. route registry/runtime map contract와 built-dist artifact 검증을 유지하고,
|
||||||
|
release server를 사용하는 built-dist E2E까지 확장한다.
|
||||||
7. Storybook build, interaction, a11y gate를 추가한다.
|
7. Storybook build, interaction, a11y gate를 추가한다.
|
||||||
8. pinned Chromium visual baseline을 추가한다.
|
8. pinned Chromium visual baseline을 추가한다.
|
||||||
9. critical flow의 3-engine release profile을 분리한다.
|
9. critical flow의 3-engine release profile을 분리한다.
|
||||||
|
|||||||
@@ -190,12 +190,79 @@ export default [
|
|||||||
]),
|
]),
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
files: [`src/presentation/templates/**/*.${sourceExtensions}`],
|
||||||
|
rules: {
|
||||||
|
"no-restricted-imports": restrictedImports([
|
||||||
|
"**/application/**",
|
||||||
|
"**/adapters/**",
|
||||||
|
"**/bootstrap/**",
|
||||||
|
"@tanstack/**",
|
||||||
|
]),
|
||||||
|
},
|
||||||
|
},
|
||||||
{
|
{
|
||||||
files: [`src/adapters/**/*.${sourceExtensions}`],
|
files: [`src/adapters/**/*.${sourceExtensions}`],
|
||||||
rules: {
|
rules: {
|
||||||
"no-restricted-imports": restrictedImports(layerPatterns.adapters),
|
"no-restricted-imports": restrictedImports(layerPatterns.adapters),
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
files: [`src/features/*/domain/**/*.${sourceExtensions}`],
|
||||||
|
rules: {
|
||||||
|
"no-restricted-imports": restrictedImports(layerPatterns.domain),
|
||||||
|
"no-restricted-globals": [
|
||||||
|
"error",
|
||||||
|
"window",
|
||||||
|
"document",
|
||||||
|
"localStorage",
|
||||||
|
"fetch",
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
files: [`src/features/*/application/**/*.${sourceExtensions}`],
|
||||||
|
rules: {
|
||||||
|
"no-restricted-imports": restrictedImports(layerPatterns.application),
|
||||||
|
"no-restricted-globals": [
|
||||||
|
"error",
|
||||||
|
"window",
|
||||||
|
"document",
|
||||||
|
"localStorage",
|
||||||
|
"fetch",
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
files: [`src/features/*/presentation/**/*.${sourceExtensions}`],
|
||||||
|
rules: {
|
||||||
|
"no-restricted-imports": restrictedImports([
|
||||||
|
"**/features/*/adapters/**",
|
||||||
|
"**/adapters/http/**",
|
||||||
|
"**/adapters/storage/**",
|
||||||
|
"**/adapters/auth/**",
|
||||||
|
"**/bootstrap/**",
|
||||||
|
"**/application/ports/out/**",
|
||||||
|
"@tanstack/**",
|
||||||
|
]),
|
||||||
|
"no-restricted-globals": [
|
||||||
|
"error",
|
||||||
|
"fetch",
|
||||||
|
"localStorage",
|
||||||
|
"sessionStorage",
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
files: [`src/features/*/adapters/**/*.${sourceExtensions}`],
|
||||||
|
rules: {
|
||||||
|
"no-restricted-imports": restrictedImports([
|
||||||
|
"**/presentation/**",
|
||||||
|
"**/bootstrap/**",
|
||||||
|
"@tanstack/**",
|
||||||
|
]),
|
||||||
|
},
|
||||||
|
},
|
||||||
{
|
{
|
||||||
files: [`tests/**/*.${sourceExtensions}`],
|
files: [`tests/**/*.${sourceExtensions}`],
|
||||||
languageOptions: {
|
languageOptions: {
|
||||||
@@ -216,6 +283,7 @@ export default [
|
|||||||
"@tanstack/**",
|
"@tanstack/**",
|
||||||
"react",
|
"react",
|
||||||
"react-dom",
|
"react-dom",
|
||||||
|
"**/application/**",
|
||||||
]),
|
]),
|
||||||
"no-restricted-globals": [
|
"no-restricted-globals": [
|
||||||
"error",
|
"error",
|
||||||
|
|||||||
+9
-1
@@ -15,6 +15,8 @@
|
|||||||
"preview": "vite preview",
|
"preview": "vite preview",
|
||||||
"lint": "eslint src scripts tests vite.config.js vitest.config.js playwright.config.js --max-warnings=0",
|
"lint": "eslint src scripts tests vite.config.js vitest.config.js playwright.config.js --max-warnings=0",
|
||||||
"check:architecture": "node scripts/check-architecture.mjs",
|
"check:architecture": "node scripts/check-architecture.mjs",
|
||||||
|
"check:design-system": "node scripts/check-design-system.mjs",
|
||||||
|
"check:design-system:fixture": "node scripts/check-design-system.mjs --fixture",
|
||||||
"check:types": "corepack pnpm check:types:app && corepack pnpm check:types:node && corepack pnpm check:types:test",
|
"check:types": "corepack pnpm check:types:app && corepack pnpm check:types:node && corepack pnpm check:types:test",
|
||||||
"check:types:app": "tsc --project tsconfig.app.json",
|
"check:types:app": "tsc --project tsconfig.app.json",
|
||||||
"check:types:node": "tsc --project tsconfig.node.json",
|
"check:types:node": "tsc --project tsconfig.node.json",
|
||||||
@@ -25,6 +27,9 @@
|
|||||||
"check:types:fixture:application-output": "tsc --ignoreConfig --allowJs --checkJs --strict --noEmit --skipLibCheck --target ES2022 --module ESNext --moduleResolution Bundler tests/fixtures/typecheck/invalid-application-output.ts",
|
"check:types:fixture:application-output": "tsc --ignoreConfig --allowJs --checkJs --strict --noEmit --skipLibCheck --target ES2022 --module ESNext --moduleResolution Bundler tests/fixtures/typecheck/invalid-application-output.ts",
|
||||||
"check:types:fixture:application-input": "tsc --ignoreConfig --allowJs --checkJs --strict --noEmit --skipLibCheck --target ES2022 --module ESNext --moduleResolution Bundler tests/fixtures/typecheck/invalid-application-input.ts",
|
"check:types:fixture:application-input": "tsc --ignoreConfig --allowJs --checkJs --strict --noEmit --skipLibCheck --target ES2022 --module ESNext --moduleResolution Bundler tests/fixtures/typecheck/invalid-application-input.ts",
|
||||||
"check:types:fixture:async-overlay": "tsc --ignoreConfig --allowJs --checkJs --strict --noEmit --skipLibCheck --target ES2022 --module ESNext --moduleResolution Bundler tests/fixtures/typecheck/invalid-async-overlay.ts",
|
"check:types:fixture:async-overlay": "tsc --ignoreConfig --allowJs --checkJs --strict --noEmit --skipLibCheck --target ES2022 --module ESNext --moduleResolution Bundler tests/fixtures/typecheck/invalid-async-overlay.ts",
|
||||||
|
"check:types:fixture:route-runtime": "tsc --ignoreConfig --allowJs --checkJs --strict --noEmit --skipLibCheck --target ES2022 --module ESNext --moduleResolution Bundler tests/fixtures/typecheck/invalid-route-runtime.ts",
|
||||||
|
"check:types:fixture:page-action": "tsc --ignoreConfig --allowJs --checkJs --strict --noEmit --skipLibCheck --target ES2022 --module ESNext --moduleResolution Bundler --jsx react-jsx tests/fixtures/typecheck/invalid-page-action.tsx",
|
||||||
|
"check:types:fixture:icon-button": "tsc --ignoreConfig --allowJs --checkJs --strict --noEmit --skipLibCheck --target ES2022 --module ESNext --moduleResolution Bundler --jsx react-jsx tests/fixtures/typecheck/invalid-icon-button.tsx",
|
||||||
"test:runtime-schema": "vitest run tests/runtime-schema --reporter=default --reporter=junit --outputFile.junit=artifacts/tests/runtime-schema.xml --passWithNoTests",
|
"test:runtime-schema": "vitest run tests/runtime-schema --reporter=default --reporter=junit --outputFile.junit=artifacts/tests/runtime-schema.xml --passWithNoTests",
|
||||||
"test:unit": "vitest run tests/unit --reporter=default --reporter=junit --outputFile.junit=artifacts/tests/unit.xml",
|
"test:unit": "vitest run tests/unit --reporter=default --reporter=junit --outputFile.junit=artifacts/tests/unit.xml",
|
||||||
"test:component": "vitest run tests/component --reporter=default --reporter=junit --outputFile.junit=artifacts/tests/component.xml",
|
"test:component": "vitest run tests/component --reporter=default --reporter=junit --outputFile.junit=artifacts/tests/component.xml",
|
||||||
@@ -33,13 +38,15 @@
|
|||||||
"test:a11y": "playwright test --grep @a11y && node scripts/write-a11y-report.mjs",
|
"test:a11y": "playwright test --grep @a11y && node scripts/write-a11y-report.mjs",
|
||||||
"review:a11y-manual": "node scripts/verify-a11y-manual.mjs",
|
"review:a11y-manual": "node scripts/verify-a11y-manual.mjs",
|
||||||
"test:sample-removal": "node scripts/test-sample-removal.mjs",
|
"test:sample-removal": "node scripts/test-sample-removal.mjs",
|
||||||
"test:all": "corepack pnpm test:runtime-schema && corepack pnpm test:unit && corepack pnpm test:component && corepack pnpm test:integration",
|
"test:reference-feature": "vitest run tests/features/reference-feature --reporter=default --reporter=junit --outputFile.junit=artifacts/tests/reference-feature.xml --passWithNoTests",
|
||||||
|
"test:all": "corepack pnpm test:runtime-schema && corepack pnpm test:unit && corepack pnpm test:component && corepack pnpm test:integration && corepack pnpm test:reference-feature",
|
||||||
"verify:lockfile": "corepack pnpm install --frozen-lockfile",
|
"verify:lockfile": "corepack pnpm install --frozen-lockfile",
|
||||||
"generate:supply-chain": "node scripts/generate-supply-chain.mjs",
|
"generate:supply-chain": "node scripts/generate-supply-chain.mjs",
|
||||||
"scan:security": "node scripts/security-scan.mjs",
|
"scan:security": "node scripts/security-scan.mjs",
|
||||||
"check:browser-security": "node scripts/check-browser-security.mjs",
|
"check:browser-security": "node scripts/check-browser-security.mjs",
|
||||||
"check:registries": "node scripts/check-registries.mjs",
|
"check:registries": "node scripts/check-registries.mjs",
|
||||||
"check:registries:fixture": "node scripts/check-registries.mjs --governance tests/fixtures/registry/forbidden/governance.json --artifact artifacts/quality/registry-fixture.json",
|
"check:registries:fixture": "node scripts/check-registries.mjs --governance tests/fixtures/registry/forbidden/governance.json --artifact artifacts/quality/registry-fixture.json",
|
||||||
|
"check:routes:fixture": "node scripts/check-registries.mjs --governance tests/fixtures/registry/routes/governance.json --artifact artifacts/quality/route-registry-fixture.json",
|
||||||
"verify:compatibility": "node scripts/check-compatibility.mjs",
|
"verify:compatibility": "node scripts/check-compatibility.mjs",
|
||||||
"verify:release": "node scripts/verify-release.mjs",
|
"verify:release": "node scripts/verify-release.mjs",
|
||||||
"verify:hosting-headers": "node scripts/verify-hosting-headers.mjs",
|
"verify:hosting-headers": "node scripts/verify-hosting-headers.mjs",
|
||||||
@@ -54,6 +61,7 @@
|
|||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@tanstack/react-query": "5.101.4",
|
"@tanstack/react-query": "5.101.4",
|
||||||
|
"lucide-react": "1.25.0",
|
||||||
"react": "19.2.8",
|
"react": "19.2.8",
|
||||||
"react-dom": "19.2.8",
|
"react-dom": "19.2.8",
|
||||||
"react-router-dom": "7.18.1",
|
"react-router-dom": "7.18.1",
|
||||||
|
|||||||
Generated
+12
@@ -11,6 +11,9 @@ importers:
|
|||||||
'@tanstack/react-query':
|
'@tanstack/react-query':
|
||||||
specifier: 5.101.4
|
specifier: 5.101.4
|
||||||
version: 5.101.4(react@19.2.8)
|
version: 5.101.4(react@19.2.8)
|
||||||
|
lucide-react:
|
||||||
|
specifier: 1.25.0
|
||||||
|
version: 1.25.0(react@19.2.8)
|
||||||
react:
|
react:
|
||||||
specifier: 19.2.8
|
specifier: 19.2.8
|
||||||
version: 19.2.8
|
version: 19.2.8
|
||||||
@@ -1536,6 +1539,11 @@ packages:
|
|||||||
lru-cache@5.1.1:
|
lru-cache@5.1.1:
|
||||||
resolution: {integrity: sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==}
|
resolution: {integrity: sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==}
|
||||||
|
|
||||||
|
lucide-react@1.25.0:
|
||||||
|
resolution: {integrity: sha512-/mdJTRbiwcLOQ1NZZK1amZF9rIZyvO18D6r9TngE6TG1NmqHgFuT4eE7Xrkm9UsXMbBJD1NlfwHVltCDWHrOTw==}
|
||||||
|
peerDependencies:
|
||||||
|
react: ^16.5.1 || ^17.0.0 || ^18.0.0 || ^19.0.0
|
||||||
|
|
||||||
lz-string@1.5.0:
|
lz-string@1.5.0:
|
||||||
resolution: {integrity: sha512-h5bgJWpxJNswbU7qCrV0tIKQCaS3blPDrqKWx+QxzuzL1zGUzij9XCWLrSLsJPu5t+eWA/ycetzYAO5IOMcWAQ==}
|
resolution: {integrity: sha512-h5bgJWpxJNswbU7qCrV0tIKQCaS3blPDrqKWx+QxzuzL1zGUzij9XCWLrSLsJPu5t+eWA/ycetzYAO5IOMcWAQ==}
|
||||||
hasBin: true
|
hasBin: true
|
||||||
@@ -3314,6 +3322,10 @@ snapshots:
|
|||||||
dependencies:
|
dependencies:
|
||||||
yallist: 3.1.1
|
yallist: 3.1.1
|
||||||
|
|
||||||
|
lucide-react@1.25.0(react@19.2.8):
|
||||||
|
dependencies:
|
||||||
|
react: 19.2.8
|
||||||
|
|
||||||
lz-string@1.5.0: {}
|
lz-string@1.5.0: {}
|
||||||
|
|
||||||
magic-string@0.30.21:
|
magic-string@0.30.21:
|
||||||
|
|||||||
@@ -7,5 +7,16 @@
|
|||||||
"apiContractVersion": "1",
|
"apiContractVersion": "1",
|
||||||
"assetManifestHash": "generated-during-build",
|
"assetManifestHash": "generated-during-build",
|
||||||
"releaseId": "local-release",
|
"releaseId": "local-release",
|
||||||
"builtAt": "1970-01-01T00:00:00.000Z"
|
"builtAt": "1970-01-01T00:00:00.000Z",
|
||||||
|
"routeChunks": {
|
||||||
|
"route-home": "src/presentation/pages/home-page.jsx",
|
||||||
|
"route-examples-ui": "src/presentation/examples/ui-gallery-page.jsx",
|
||||||
|
"route-examples-states": "src/presentation/examples/state-gallery-page.jsx",
|
||||||
|
"route-examples-auth": "src/presentation/examples/auth-example-page.jsx",
|
||||||
|
"route-reference-resources": "src/features/reference-feature/presentation/reference-resource-page.tsx",
|
||||||
|
"route-reference-resource-detail": "src/features/reference-feature/presentation/reference-resource-detail-page.tsx",
|
||||||
|
"route-reference-resource-form": "src/features/reference-feature/presentation/reference-resource-form-page.tsx",
|
||||||
|
"route-reference-resource-status": "src/features/reference-feature/presentation/reference-resource-status-page.tsx",
|
||||||
|
"route-not-found": "src/presentation/pages/not-found-page.jsx"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,148 @@
|
|||||||
|
import { mkdir, readFile, readdir, writeFile } from "node:fs/promises";
|
||||||
|
import path from "node:path";
|
||||||
|
|
||||||
|
// @ts-expect-error Node 24 executes erasable TypeScript for this build-time gate.
|
||||||
|
import { REQUIRED_COMPONENT_TOKENS, REQUIRED_PRIMITIVE_TOKENS, REQUIRED_SEMANTIC_TOKENS } from "../src/presentation/design-system/tokens/token-contract.ts";
|
||||||
|
|
||||||
|
const fixtureMode = process.argv.includes("--fixture");
|
||||||
|
const failures = [];
|
||||||
|
const tokenFiles = {
|
||||||
|
primitive: "src/presentation/design-system/tokens/primitive.css",
|
||||||
|
semantic: "src/presentation/design-system/tokens/semantic.css",
|
||||||
|
component: "src/presentation/design-system/tokens/component.css",
|
||||||
|
};
|
||||||
|
/** @type {Array<readonly [string, string, readonly string[]]>} */
|
||||||
|
const tokenLayers = [
|
||||||
|
["primitive", tokenFiles.primitive, REQUIRED_PRIMITIVE_TOKENS],
|
||||||
|
["semantic", tokenFiles.semantic, REQUIRED_SEMANTIC_TOKENS],
|
||||||
|
["component", tokenFiles.component, REQUIRED_COMPONENT_TOKENS],
|
||||||
|
];
|
||||||
|
|
||||||
|
for (const [layer, file, tokens] of tokenLayers) {
|
||||||
|
const source = await readFile(file, "utf8");
|
||||||
|
for (const token of tokens) {
|
||||||
|
if (!source.includes(`${token}:`)) {
|
||||||
|
failures.push(`${layer} token is missing: ${token}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const cssSources = await Promise.all(
|
||||||
|
[...Object.values(tokenFiles), "src/presentation/styles/theme.css"].map(
|
||||||
|
async (file) => ({ file, source: await readFile(file, "utf8") }),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
const definitions = new Set(
|
||||||
|
cssSources.flatMap(({ source }) =>
|
||||||
|
[...source.matchAll(/(--[a-z0-9-]+)\s*:/g)].map((match) => match[1]),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
for (const { file, source } of cssSources) {
|
||||||
|
for (const match of source.matchAll(/var\((--[a-z0-9-]+)/g)) {
|
||||||
|
if (!definitions.has(match[1])) {
|
||||||
|
failures.push(`${file} uses undefined token ${match[1]}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const semanticSource = await readFile(tokenFiles.semantic, "utf8");
|
||||||
|
const darkSource =
|
||||||
|
semanticSource.match(/:root\[data-theme="dark"\]\s*\{([\s\S]*?)\n\}/)?.[1] ??
|
||||||
|
"";
|
||||||
|
for (const token of [
|
||||||
|
"--color-surface",
|
||||||
|
"--color-surface-muted",
|
||||||
|
"--color-surface-elevated",
|
||||||
|
"--color-content",
|
||||||
|
"--color-content-muted",
|
||||||
|
"--color-content-inverse",
|
||||||
|
"--color-border",
|
||||||
|
"--color-border-strong",
|
||||||
|
"--color-action",
|
||||||
|
"--color-action-hover",
|
||||||
|
"--color-action-pressed",
|
||||||
|
"--color-danger",
|
||||||
|
"--color-focus",
|
||||||
|
"--color-disabled-content",
|
||||||
|
"--color-disabled-surface",
|
||||||
|
]) {
|
||||||
|
if (!darkSource.includes(`${token}:`)) {
|
||||||
|
failures.push(`dark theme token is missing: ${token}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
const componentSource = await readFile(tokenFiles.component, "utf8");
|
||||||
|
if (!componentSource.includes("@media (forced-colors: active)")) {
|
||||||
|
failures.push("forced-colors token fallback is missing");
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @param {string} directory @returns {Promise<string[]>} */
|
||||||
|
async function listSourceFiles(directory) {
|
||||||
|
const result = [];
|
||||||
|
for (const entry of await readdir(directory, { withFileTypes: true })) {
|
||||||
|
const target = path.join(directory, entry.name);
|
||||||
|
if (entry.isDirectory()) result.push(...(await listSourceFiles(target)));
|
||||||
|
else if (/\.(js|jsx|mjs|ts|tsx|mts)$/.test(entry.name)) result.push(target);
|
||||||
|
}
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
const sources = fixtureMode
|
||||||
|
? await listSourceFiles("tests/fixtures/design-system/forbidden")
|
||||||
|
: await listSourceFiles("src");
|
||||||
|
for (const file of sources) {
|
||||||
|
const source = await readFile(file, "utf8");
|
||||||
|
const vendorFacade =
|
||||||
|
file === "src/presentation/design-system/icons/vendors/lucide.tsx";
|
||||||
|
if (!vendorFacade && /from\s+["']lucide-react["']/.test(source)) {
|
||||||
|
failures.push(`direct icon vendor import in ${file}`);
|
||||||
|
}
|
||||||
|
if (
|
||||||
|
/from\s+["'](?:react-aria-components|@radix-ui\/[^"']+)["']/.test(source)
|
||||||
|
) {
|
||||||
|
failures.push(`direct headless vendor import in ${file}`);
|
||||||
|
}
|
||||||
|
if (
|
||||||
|
!file.includes("src/presentation/design-system/") &&
|
||||||
|
/presentation\/design-system\/(?!index(?:\.js)?["'])/.test(source)
|
||||||
|
) {
|
||||||
|
failures.push(`design-system deep import in ${file}`);
|
||||||
|
}
|
||||||
|
if (
|
||||||
|
!file.includes("src/presentation/design-system/tokens/") &&
|
||||||
|
/(?:#[0-9a-f]{3,8}\b|oklch\(|rgba?\()/i.test(source)
|
||||||
|
) {
|
||||||
|
failures.push(`raw palette value in ${file}`);
|
||||||
|
}
|
||||||
|
if (
|
||||||
|
file.includes("tests/fixtures/design-system/forbidden") &&
|
||||||
|
source.includes("TOOLTIP_ONLY_REQUIRED_INFORMATION")
|
||||||
|
) {
|
||||||
|
failures.push(`tooltip-only required information in ${file}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const report = {
|
||||||
|
schemaVersion: 1,
|
||||||
|
mode: fixtureMode ? "negative-fixture" : "source",
|
||||||
|
checkedTokenCount:
|
||||||
|
REQUIRED_PRIMITIVE_TOKENS.length +
|
||||||
|
REQUIRED_SEMANTIC_TOKENS.length +
|
||||||
|
REQUIRED_COMPONENT_TOKENS.length,
|
||||||
|
failures,
|
||||||
|
passed: failures.length === 0,
|
||||||
|
};
|
||||||
|
await mkdir("artifacts/quality", { recursive: true });
|
||||||
|
await writeFile(
|
||||||
|
fixtureMode
|
||||||
|
? "artifacts/quality/design-system-fixture.json"
|
||||||
|
: "artifacts/quality/design-system.json",
|
||||||
|
`${JSON.stringify(report, null, 2)}\n`,
|
||||||
|
);
|
||||||
|
|
||||||
|
if (failures.length > 0) {
|
||||||
|
process.stderr.write(`Design system contract failed:\n${failures.join("\n")}\n`);
|
||||||
|
process.exit(1);
|
||||||
|
}
|
||||||
|
process.stdout.write(
|
||||||
|
`Design system contract: ${report.checkedTokenCount} tokens and vendor boundaries PASS\n`,
|
||||||
|
);
|
||||||
@@ -103,6 +103,24 @@ for (const specification of governance.registries) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
for (const [field, allowed] of Object.entries(
|
||||||
|
specification.allowedValues ?? {},
|
||||||
|
)) {
|
||||||
|
for (const [rowName, row] of Object.entries(rows)) {
|
||||||
|
if (!row || typeof row !== "object" || Array.isArray(row)) continue;
|
||||||
|
if (
|
||||||
|
!allowed.some(
|
||||||
|
/** @param {unknown} value */
|
||||||
|
(value) => Object.is(value, row[field]),
|
||||||
|
)
|
||||||
|
) {
|
||||||
|
failures.push(
|
||||||
|
`${specification.registryId}.${rowName}.${field} has unknown value ${String(row[field])}`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
snapshots.push({
|
snapshots.push({
|
||||||
registryId: specification.registryId,
|
registryId: specification.registryId,
|
||||||
owner: specification.owner,
|
owner: specification.owner,
|
||||||
@@ -155,6 +173,11 @@ const adHocPatterns = [
|
|||||||
|
|
||||||
/** @param {string} directory */
|
/** @param {string} directory */
|
||||||
async function scanDirectory(directory) {
|
async function scanDirectory(directory) {
|
||||||
|
try {
|
||||||
|
await access(directory);
|
||||||
|
} catch {
|
||||||
|
return;
|
||||||
|
}
|
||||||
const entries = await import("node:fs/promises").then(({ readdir }) =>
|
const entries = await import("node:fs/promises").then(({ readdir }) =>
|
||||||
readdir(directory, { withFileTypes: true }),
|
readdir(directory, { withFileTypes: true }),
|
||||||
);
|
);
|
||||||
|
|||||||
@@ -123,6 +123,8 @@ async function drillChunkMismatch() {
|
|||||||
failureKind: "DEPLOY_MISMATCH",
|
failureKind: "DEPLOY_MISMATCH",
|
||||||
manifestLoaded: true,
|
manifestLoaded: true,
|
||||||
currentBuildId: "build-a",
|
currentBuildId: "build-a",
|
||||||
|
currentReleaseId: "release-a",
|
||||||
|
activeBuildId: "build-b",
|
||||||
activeReleaseId: "release-b",
|
activeReleaseId: "release-b",
|
||||||
storage,
|
storage,
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -1,6 +1,13 @@
|
|||||||
import { createHash } from "node:crypto";
|
import { createHash } from "node:crypto";
|
||||||
import { mkdir, readFile, writeFile } from "node:fs/promises";
|
import { mkdir, readFile, writeFile } from "node:fs/promises";
|
||||||
import process from "node:process";
|
import process from "node:process";
|
||||||
|
import { z } from "zod";
|
||||||
|
|
||||||
|
import {
|
||||||
|
ROUTE_REGISTRY,
|
||||||
|
ROUTE_RUNTIME_CONTRACT,
|
||||||
|
} from "../src/features/installed-feature-contracts.js";
|
||||||
|
import { runtimeConfigSchema } from "../src/bootstrap/runtime-config-schema.js";
|
||||||
|
|
||||||
const packageJson = JSON.parse(await readFile("package.json", "utf8"));
|
const packageJson = JSON.parse(await readFile("package.json", "utf8"));
|
||||||
const packageManagerVersion = packageJson.packageManager.split("@").at(-1);
|
const packageManagerVersion = packageJson.packageManager.split("@").at(-1);
|
||||||
@@ -9,11 +16,31 @@ const commitSha = process.env.VITE_COMMIT_SHA ?? "local";
|
|||||||
const releaseId = process.env.RELEASE_ID ?? "local-release";
|
const releaseId = process.env.RELEASE_ID ?? "local-release";
|
||||||
const runnerImage = process.env.CI_RUNNER_IMAGE ?? `${process.platform}-${process.arch}`;
|
const runnerImage = process.env.CI_RUNNER_IMAGE ?? `${process.platform}-${process.arch}`;
|
||||||
const builtAt = new Date().toISOString();
|
const builtAt = new Date().toISOString();
|
||||||
const viteManifest = await readFile("dist/.vite/manifest.json");
|
const viteManifest = await readFile("dist/.vite/manifest.json", "utf8");
|
||||||
|
const viteManifestObject =
|
||||||
|
/** @type {Record<string, {file: string, name?: string, isDynamicEntry?: boolean}>} */ (
|
||||||
|
JSON.parse(viteManifest)
|
||||||
|
);
|
||||||
const assetManifestHash = createHash("sha256")
|
const assetManifestHash = createHash("sha256")
|
||||||
.update(viteManifest)
|
.update(viteManifest)
|
||||||
.digest("hex");
|
.digest("hex");
|
||||||
const runtimeConfig = JSON.parse(await readFile("dist/config.json", "utf8"));
|
const runtimeConfig = JSON.parse(await readFile("dist/config.json", "utf8"));
|
||||||
|
/** @type {Record<string, string>} */
|
||||||
|
const routeChunks = {};
|
||||||
|
for (const definition of Object.values(ROUTE_REGISTRY)) {
|
||||||
|
const runtime =
|
||||||
|
/** @type {Record<string, {moduleId: string}>} */ (
|
||||||
|
ROUTE_RUNTIME_CONTRACT
|
||||||
|
)[definition.routeId];
|
||||||
|
const asset = Object.values(viteManifestObject).find(
|
||||||
|
(entry) => entry.name === runtime?.moduleId && entry.isDynamicEntry,
|
||||||
|
);
|
||||||
|
if (!runtime || !asset?.file) {
|
||||||
|
throw new Error(`Missing built route chunk: ${definition.routeId}`);
|
||||||
|
}
|
||||||
|
routeChunks[definition.chunkId] = asset.file;
|
||||||
|
}
|
||||||
|
const runtimeConfigJsonSchema = z.toJSONSchema(runtimeConfigSchema);
|
||||||
|
|
||||||
runtimeConfig.BUILD_ID = buildId;
|
runtimeConfig.BUILD_ID = buildId;
|
||||||
runtimeConfig.RELEASE_ID = releaseId;
|
runtimeConfig.RELEASE_ID = releaseId;
|
||||||
@@ -31,6 +58,8 @@ const manifest = {
|
|||||||
outputs: {
|
outputs: {
|
||||||
directory: "dist",
|
directory: "dist",
|
||||||
viteManifest: "dist/.vite/manifest.json",
|
viteManifest: "dist/.vite/manifest.json",
|
||||||
|
routeChunks,
|
||||||
|
runtimeConfigSchema: "dist/runtime-config.schema.json",
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -44,6 +73,7 @@ const releaseManifest = {
|
|||||||
assetManifestHash,
|
assetManifestHash,
|
||||||
releaseId,
|
releaseId,
|
||||||
builtAt,
|
builtAt,
|
||||||
|
routeChunks,
|
||||||
};
|
};
|
||||||
|
|
||||||
await mkdir("artifacts/release", { recursive: true });
|
await mkdir("artifacts/release", { recursive: true });
|
||||||
@@ -52,6 +82,14 @@ await writeFile(
|
|||||||
"dist/release-manifest.json",
|
"dist/release-manifest.json",
|
||||||
`${JSON.stringify(releaseManifest, null, 2)}\n`,
|
`${JSON.stringify(releaseManifest, null, 2)}\n`,
|
||||||
);
|
);
|
||||||
|
await writeFile(
|
||||||
|
"dist/runtime-config.schema.json",
|
||||||
|
`${JSON.stringify(runtimeConfigJsonSchema, null, 2)}\n`,
|
||||||
|
);
|
||||||
|
await writeFile(
|
||||||
|
"artifacts/release/runtime-config.schema.json",
|
||||||
|
`${JSON.stringify(runtimeConfigJsonSchema, null, 2)}\n`,
|
||||||
|
);
|
||||||
await writeFile(
|
await writeFile(
|
||||||
"artifacts/release/build-manifest.json",
|
"artifacts/release/build-manifest.json",
|
||||||
`${JSON.stringify(manifest, null, 2)}\n`,
|
`${JSON.stringify(manifest, null, 2)}\n`,
|
||||||
|
|||||||
@@ -1,11 +1,8 @@
|
|||||||
export const MANUAL_A11Y_ROUTE_IDS = Object.freeze([
|
import { ROUTE_REGISTRY } from "../../src/features/installed-feature-contracts.js";
|
||||||
"APP_HOME",
|
|
||||||
"EXAMPLES_UI",
|
export const MANUAL_A11Y_ROUTE_IDS = Object.freeze(
|
||||||
"EXAMPLES_STATES",
|
Object.values(ROUTE_REGISTRY).map((route) => route.routeId),
|
||||||
"EXAMPLES_AUTH",
|
);
|
||||||
"SAMPLE_RESOURCE_LIST",
|
|
||||||
"NOT_FOUND",
|
|
||||||
]);
|
|
||||||
|
|
||||||
const REVIEW_FIELDS = Object.freeze([
|
const REVIEW_FIELDS = Object.freeze([
|
||||||
"M1 Keyboard",
|
"M1 Keyboard",
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ import process from "node:process";
|
|||||||
import { chromium } from "@playwright/test";
|
import { chromium } from "@playwright/test";
|
||||||
|
|
||||||
import { evaluateLabBudget } from "../src/application/policies/performance-budgets.js";
|
import { evaluateLabBudget } from "../src/application/policies/performance-budgets.js";
|
||||||
import { ROUTE_REGISTRY } from "../src/contracts/routes.js";
|
import { ROUTE_REGISTRY } from "../src/features/installed-feature-contracts.js";
|
||||||
|
|
||||||
const server = spawn(
|
const server = spawn(
|
||||||
"corepack",
|
"corepack",
|
||||||
@@ -67,8 +67,9 @@ try {
|
|||||||
}).observe({ type: "layout-shift", buffered: true });
|
}).observe({ type: "layout-shift", buffered: true });
|
||||||
});
|
});
|
||||||
await page.goto(baseUrl, { waitUntil: "networkidle" });
|
await page.goto(baseUrl, { waitUntil: "networkidle" });
|
||||||
const targetLabel =
|
const targetLabel = Object.values(ROUTE_REGISTRY).find(
|
||||||
ROUTE_REGISTRY.SAMPLE_RESOURCE_LIST.navigationLabel;
|
(definition) => definition.access === "integration-defined",
|
||||||
|
)?.navigationLabel;
|
||||||
if (!targetLabel) {
|
if (!targetLabel) {
|
||||||
throw new Error("Performance route must be present in navigation.");
|
throw new Error("Performance route must be present in navigation.");
|
||||||
}
|
}
|
||||||
|
|||||||
+187
-44
@@ -1,78 +1,221 @@
|
|||||||
import { cp, mkdir, readFile, readdir, rm, writeFile } from "node:fs/promises";
|
|
||||||
import { spawnSync } from "node:child_process";
|
import { spawnSync } from "node:child_process";
|
||||||
|
import {
|
||||||
|
cp,
|
||||||
|
mkdir,
|
||||||
|
readFile,
|
||||||
|
readdir,
|
||||||
|
rm,
|
||||||
|
symlink,
|
||||||
|
writeFile,
|
||||||
|
} from "node:fs/promises";
|
||||||
import path from "node:path";
|
import path from "node:path";
|
||||||
|
|
||||||
const fixtureRoot = path.resolve(".tmp/sample-removal");
|
const fixtureRoot = path.resolve(".tmp/reference-feature-removal");
|
||||||
const sampleRoot = path.resolve("src/sample/contract-fixture");
|
|
||||||
const sourceRoot = path.resolve("src");
|
|
||||||
const pnpmCli = /** @type {string} */ (process.env.npm_execpath);
|
const pnpmCli = /** @type {string} */ (process.env.npm_execpath);
|
||||||
|
const featureSource = "src/features/reference-feature";
|
||||||
|
const featureTests = "tests/features/reference-feature";
|
||||||
|
const featureOwnedPaths = [
|
||||||
|
featureSource,
|
||||||
|
featureTests,
|
||||||
|
"tests/e2e/reference-form.spec.js",
|
||||||
|
];
|
||||||
|
const copyTargets = [
|
||||||
|
"src",
|
||||||
|
"tests",
|
||||||
|
"scripts",
|
||||||
|
"config",
|
||||||
|
"public",
|
||||||
|
"index.html",
|
||||||
|
"package.json",
|
||||||
|
"tsconfig.base.json",
|
||||||
|
"tsconfig.json",
|
||||||
|
"tsconfig.app.json",
|
||||||
|
"tsconfig.node.json",
|
||||||
|
"tsconfig.test.json",
|
||||||
|
"vite.config.js",
|
||||||
|
"vitest.config.js",
|
||||||
|
"playwright.config.js",
|
||||||
|
"eslint.config.js",
|
||||||
|
".dependency-cruiser.cjs",
|
||||||
|
];
|
||||||
|
|
||||||
|
const emptyContracts = `import { PLATFORM_ROUTE_RUNTIME_CONTRACT } from "../contracts/route-runtime-contract.js";
|
||||||
|
import { PLATFORM_ROUTE_REGISTRY } from "../contracts/routes.js";
|
||||||
|
|
||||||
|
export const INSTALLED_FEATURE_CONTRACTS =
|
||||||
|
/** @type {readonly unknown[]} */ (Object.freeze([]));
|
||||||
|
export const ROUTE_REGISTRY = PLATFORM_ROUTE_REGISTRY;
|
||||||
|
export const ROUTE_RUNTIME_CONTRACT = PLATFORM_ROUTE_RUNTIME_CONTRACT;
|
||||||
|
export const API_OPERATIONS = Object.freeze({});
|
||||||
|
export const QUERY_REGISTRY = Object.freeze({});
|
||||||
|
export const NAVIGATION_ROUTES = Object.freeze(
|
||||||
|
Object.values(ROUTE_REGISTRY)
|
||||||
|
.filter((definition) => definition.navigationOrder !== null)
|
||||||
|
.sort(
|
||||||
|
(left, right) =>
|
||||||
|
/** @type {number} */ (left.navigationOrder) -
|
||||||
|
/** @type {number} */ (right.navigationOrder),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
/** @param {string} routeId */
|
||||||
|
export function getRoute(routeId) {
|
||||||
|
const registry =
|
||||||
|
/** @type {Readonly<Record<string, import("../contracts/routes.js").RouteDefinition>>} */ (
|
||||||
|
ROUTE_REGISTRY
|
||||||
|
);
|
||||||
|
const selected = registry[routeId];
|
||||||
|
if (!selected) throw new Error(\`Unregistered route: \${routeId}\`);
|
||||||
|
return selected;
|
||||||
|
}
|
||||||
|
/** @param {string} routeId */
|
||||||
|
export function routePath(routeId) {
|
||||||
|
return getRoute(routeId).path;
|
||||||
|
}
|
||||||
|
`;
|
||||||
|
|
||||||
|
const emptyRuntimes = `import { PLATFORM_ROUTE_CODECS } from "../presentation/routes/platform-route-codecs.js";
|
||||||
|
import { PLATFORM_ROUTE_RUNTIME } from "../presentation/routes/route-runtime.js";
|
||||||
|
|
||||||
|
export const ROUTE_CODECS = PLATFORM_ROUTE_CODECS;
|
||||||
|
export const ROUTE_RUNTIME = PLATFORM_ROUTE_RUNTIME;
|
||||||
|
`;
|
||||||
|
|
||||||
|
const emptyAdapters = `type FeatureContext = Readonly<{
|
||||||
|
createHttpClient(contract: Readonly<Record<string, unknown>>): unknown;
|
||||||
|
}>;
|
||||||
|
export function createInstalledFeatureInputs(_context: FeatureContext) {
|
||||||
|
void _context;
|
||||||
|
return Object.freeze({});
|
||||||
|
}
|
||||||
|
`;
|
||||||
|
|
||||||
/** @param {string} directory @returns {Promise<string[]>} */
|
/** @param {string} directory @returns {Promise<string[]>} */
|
||||||
async function sourceFiles(directory) {
|
async function filesBelow(directory) {
|
||||||
const entries = await readdir(directory, { withFileTypes: true });
|
const entries = await readdir(directory, { withFileTypes: true });
|
||||||
const nested = /** @type {string[][]} */ (await Promise.all(
|
const groups = await Promise.all(
|
||||||
entries.map((entry) => {
|
entries.map((entry) => {
|
||||||
const target = path.join(directory, entry.name);
|
const target = path.join(directory, entry.name);
|
||||||
return entry.isDirectory() ? sourceFiles(target) : [target];
|
return entry.isDirectory() ? filesBelow(target) : [target];
|
||||||
}),
|
}),
|
||||||
));
|
);
|
||||||
return nested.flat();
|
return groups.flat();
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @param {string} script @param {string[]} [extra] */
|
||||||
|
function runPnpm(script, extra = []) {
|
||||||
|
const result = spawnSync(process.execPath, [pnpmCli, script, ...extra], {
|
||||||
|
cwd: fixtureRoot,
|
||||||
|
stdio: "inherit",
|
||||||
|
});
|
||||||
|
return result.status === 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
await rm(fixtureRoot, { recursive: true, force: true });
|
await rm(fixtureRoot, { recursive: true, force: true });
|
||||||
await mkdir(fixtureRoot, { recursive: true });
|
await mkdir(fixtureRoot, { recursive: true });
|
||||||
|
for (const target of copyTargets) {
|
||||||
const incomingImports = [];
|
await cp(target, path.join(fixtureRoot, target), { recursive: true });
|
||||||
for (const sourceFile of await sourceFiles(sourceRoot)) {
|
|
||||||
if (sourceFile.startsWith(sampleRoot)) continue;
|
|
||||||
const content = await readFile(sourceFile, "utf8");
|
|
||||||
if (/from\s+["'][^"']*sample\/contract-fixture/.test(content)) {
|
|
||||||
incomingImports.push(path.relative(".", sourceFile));
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
await symlink(path.resolve("node_modules"), path.join(fixtureRoot, "node_modules"), "dir");
|
||||||
|
|
||||||
let buildStatus = 1;
|
for (const ownedPath of featureOwnedPaths) {
|
||||||
if (incomingImports.length === 0) {
|
await rm(path.join(fixtureRoot, ownedPath), {
|
||||||
await cp("src", path.join(fixtureRoot, "src"), {
|
|
||||||
recursive: true,
|
recursive: true,
|
||||||
filter: (source) => !source.startsWith(sampleRoot),
|
force: true,
|
||||||
});
|
});
|
||||||
await cp("public", path.join(fixtureRoot, "public"), { recursive: true });
|
}
|
||||||
await cp("index.html", path.join(fixtureRoot, "index.html"));
|
await writeFile(
|
||||||
await cp("vite.config.js", path.join(fixtureRoot, "vite.config.js"));
|
path.join(fixtureRoot, "src/features/installed-feature-contracts.js"),
|
||||||
|
emptyContracts,
|
||||||
const result = spawnSync(
|
|
||||||
process.execPath,
|
|
||||||
[
|
|
||||||
pnpmCli,
|
|
||||||
"exec",
|
|
||||||
"vite",
|
|
||||||
"build",
|
|
||||||
fixtureRoot,
|
|
||||||
"--outDir",
|
|
||||||
path.join(fixtureRoot, "dist"),
|
|
||||||
],
|
|
||||||
{ stdio: "inherit" },
|
|
||||||
);
|
);
|
||||||
buildStatus = result.status ?? 1;
|
await writeFile(
|
||||||
|
path.join(fixtureRoot, "src/features/installed-feature-runtimes.tsx"),
|
||||||
|
emptyRuntimes,
|
||||||
|
);
|
||||||
|
await writeFile(
|
||||||
|
path.join(fixtureRoot, "src/features/installed-feature-adapters.ts"),
|
||||||
|
emptyAdapters,
|
||||||
|
);
|
||||||
|
|
||||||
|
/** @type {string[]} */
|
||||||
|
const residue = [];
|
||||||
|
for (const root of ["src", "tests"]) {
|
||||||
|
for (const file of await filesBelow(path.join(fixtureRoot, root))) {
|
||||||
|
const relative = path.relative(fixtureRoot, file);
|
||||||
|
const content = await readFile(file, "utf8");
|
||||||
|
if (
|
||||||
|
/REFERENCE_RESOURCE|reference-feature|reference-resource/i.test(
|
||||||
|
`${relative}\n${content}`,
|
||||||
|
)
|
||||||
|
) {
|
||||||
|
residue.push(relative);
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const checks = [
|
||||||
|
["typecheck", runPnpm("check:types")],
|
||||||
|
["architecture", runPnpm("check:architecture")],
|
||||||
|
["registry", runPnpm("check:registries")],
|
||||||
|
["unit-integration", runPnpm("test:all")],
|
||||||
|
[
|
||||||
|
"home-smoke",
|
||||||
|
runPnpm("exec", [
|
||||||
|
"vitest",
|
||||||
|
"run",
|
||||||
|
"tests/component/router.test.jsx",
|
||||||
|
"--reporter=default",
|
||||||
|
]),
|
||||||
|
],
|
||||||
|
["build", runPnpm("build")],
|
||||||
|
];
|
||||||
|
/** @type {string[]} */
|
||||||
|
const builtResidue = [];
|
||||||
|
for (const file of await filesBelow(path.join(fixtureRoot, "dist"))) {
|
||||||
|
if (!/\.(?:js|css|html|json)$/.test(file)) continue;
|
||||||
|
const content = await readFile(file, "utf8");
|
||||||
|
if (
|
||||||
|
/REFERENCE_RESOURCE|reference-feature|reference-resource/i.test(content)
|
||||||
|
) {
|
||||||
|
builtResidue.push(path.relative(fixtureRoot, file));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
const routeCatalog = await import(
|
||||||
|
`${new URL(
|
||||||
|
"../src/features/installed-feature-contracts.js",
|
||||||
|
`file://${fixtureRoot}/scripts/`,
|
||||||
|
).href}?removed=${Date.now()}`
|
||||||
|
);
|
||||||
|
const routeIds = Object.keys(routeCatalog.ROUTE_REGISTRY);
|
||||||
|
const routeAbsent = routeIds.every((routeId) => !routeId.startsWith("REFERENCE_"));
|
||||||
|
checks.push(["route-absent", routeAbsent]);
|
||||||
|
checks.push(["fixture-id-residue", residue.length === 0]);
|
||||||
|
checks.push(["built-fixture-id-residue", builtResidue.length === 0]);
|
||||||
|
|
||||||
|
const passed = checks.every(([, result]) => result);
|
||||||
await mkdir("artifacts/tests", { recursive: true });
|
await mkdir("artifacts/tests", { recursive: true });
|
||||||
const passed = incomingImports.length === 0 && buildStatus === 0;
|
|
||||||
await writeFile(
|
await writeFile(
|
||||||
"artifacts/tests/sample-removal.xml",
|
"artifacts/tests/sample-removal.xml",
|
||||||
`<?xml version="1.0" encoding="UTF-8"?>\n` +
|
`<?xml version="1.0" encoding="UTF-8"?>\n` +
|
||||||
`<testsuite name="sample-removal" tests="2" failures="${passed ? 0 : 1}">` +
|
`<testsuite name="reference-feature-removal" tests="${checks.length}" failures="${passed ? 0 : 1}">` +
|
||||||
`<testcase name="no-product-import"/>` +
|
checks
|
||||||
`<testcase name="production-build">${passed ? "" : "<failure/>"}</testcase>` +
|
.map(
|
||||||
|
([name, result]) =>
|
||||||
|
`<testcase name="${name}">${result ? "" : `<failure>${[...residue, ...builtResidue].join(", ")}</failure>`}</testcase>`,
|
||||||
|
)
|
||||||
|
.join("") +
|
||||||
`</testsuite>\n`,
|
`</testsuite>\n`,
|
||||||
);
|
);
|
||||||
await rm(fixtureRoot, { recursive: true, force: true });
|
await rm(fixtureRoot, { recursive: true, force: true });
|
||||||
|
|
||||||
if (!passed) {
|
if (!passed) {
|
||||||
|
const failures = checks
|
||||||
|
.filter(([, result]) => !result)
|
||||||
|
.map(([name]) => name);
|
||||||
process.stderr.write(
|
process.stderr.write(
|
||||||
`Sample removal failed. Incoming imports: ${incomingImports.join(", ")}\n`,
|
`Reference feature removal failed: ${failures.join(", ")}; residue: ${[...residue, ...builtResidue].join(", ")}\n`,
|
||||||
);
|
);
|
||||||
process.exit(1);
|
process.exit(1);
|
||||||
}
|
}
|
||||||
process.stdout.write("Sample removal smoke: PASS\n");
|
process.stdout.write(
|
||||||
|
`Reference feature removal: PASS (${checks.length} checks, no fixture IDs)\n`,
|
||||||
|
);
|
||||||
|
|||||||
@@ -6,6 +6,10 @@ import {
|
|||||||
compareReleaseToRuntime,
|
compareReleaseToRuntime,
|
||||||
RELEASE_TOKEN_REGISTRY,
|
RELEASE_TOKEN_REGISTRY,
|
||||||
} from "../src/contracts/release-tokens.js";
|
} from "../src/contracts/release-tokens.js";
|
||||||
|
import {
|
||||||
|
ROUTE_REGISTRY,
|
||||||
|
ROUTE_RUNTIME_CONTRACT,
|
||||||
|
} from "../src/features/installed-feature-contracts.js";
|
||||||
|
|
||||||
const fixturesDocument =
|
const fixturesDocument =
|
||||||
/** @type {{
|
/** @type {{
|
||||||
@@ -34,7 +38,17 @@ const fixturesDocument =
|
|||||||
);
|
);
|
||||||
const release = JSON.parse(await readFile("dist/release-manifest.json", "utf8"));
|
const release = JSON.parse(await readFile("dist/release-manifest.json", "utf8"));
|
||||||
const runtimeConfig = JSON.parse(await readFile("dist/config.json", "utf8"));
|
const runtimeConfig = JSON.parse(await readFile("dist/config.json", "utf8"));
|
||||||
const viteManifest = await readFile("dist/.vite/manifest.json");
|
const buildManifest = JSON.parse(
|
||||||
|
await readFile("artifacts/release/build-manifest.json", "utf8"),
|
||||||
|
);
|
||||||
|
const runtimeConfigJsonSchema = JSON.parse(
|
||||||
|
await readFile("dist/runtime-config.schema.json", "utf8"),
|
||||||
|
);
|
||||||
|
const viteManifest = await readFile("dist/.vite/manifest.json", "utf8");
|
||||||
|
const viteManifestObject =
|
||||||
|
/** @type {Record<string, {file: string, name?: string, isDynamicEntry?: boolean}>} */ (
|
||||||
|
JSON.parse(viteManifest)
|
||||||
|
);
|
||||||
const actualAssetManifestHash = createHash("sha256")
|
const actualAssetManifestHash = createHash("sha256")
|
||||||
.update(viteManifest)
|
.update(viteManifest)
|
||||||
.digest("hex");
|
.digest("hex");
|
||||||
@@ -52,6 +66,58 @@ if (!Number.isFinite(Date.parse(release.builtAt))) {
|
|||||||
if (release.assetManifestHash !== actualAssetManifestHash) {
|
if (release.assetManifestHash !== actualAssetManifestHash) {
|
||||||
artifactMismatches.push("assetManifestContent");
|
artifactMismatches.push("assetManifestContent");
|
||||||
}
|
}
|
||||||
|
if (
|
||||||
|
runtimeConfigJsonSchema.$schema !== "https://json-schema.org/draft/2020-12/schema" ||
|
||||||
|
runtimeConfigJsonSchema.type !== "object" ||
|
||||||
|
!runtimeConfigJsonSchema.properties
|
||||||
|
) {
|
||||||
|
artifactMismatches.push("runtimeConfigSchema");
|
||||||
|
}
|
||||||
|
if (
|
||||||
|
buildManifest.outputs?.runtimeConfigSchema !==
|
||||||
|
"dist/runtime-config.schema.json"
|
||||||
|
) {
|
||||||
|
artifactMismatches.push("buildManifest:runtimeConfigSchema");
|
||||||
|
}
|
||||||
|
|
||||||
|
const expectedChunkIds = new Set(
|
||||||
|
Object.values(ROUTE_REGISTRY).map((definition) => definition.chunkId),
|
||||||
|
);
|
||||||
|
const actualChunkIds = new Set(Object.keys(release.routeChunks ?? {}));
|
||||||
|
for (const chunkId of expectedChunkIds) {
|
||||||
|
if (!actualChunkIds.has(chunkId)) {
|
||||||
|
artifactMismatches.push(`routeChunk:missing:${chunkId}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for (const chunkId of actualChunkIds) {
|
||||||
|
if (!expectedChunkIds.has(chunkId)) {
|
||||||
|
artifactMismatches.push(`routeChunk:orphan:${chunkId}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for (const definition of Object.values(ROUTE_REGISTRY)) {
|
||||||
|
const runtime =
|
||||||
|
/** @type {Record<string, {moduleId: string}>} */ (
|
||||||
|
ROUTE_RUNTIME_CONTRACT
|
||||||
|
)[definition.routeId];
|
||||||
|
const viteEntry = Object.values(viteManifestObject).find(
|
||||||
|
(entry) => entry.name === runtime?.moduleId && entry.isDynamicEntry,
|
||||||
|
);
|
||||||
|
const routeAsset = release.routeChunks?.[definition.chunkId];
|
||||||
|
if (!runtime || !viteEntry || routeAsset !== viteEntry.file) {
|
||||||
|
artifactMismatches.push(`routeChunk:mismatch:${definition.chunkId}`);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if (
|
||||||
|
buildManifest.outputs?.routeChunks?.[definition.chunkId] !== routeAsset
|
||||||
|
) {
|
||||||
|
artifactMismatches.push(`buildManifest:routeChunk:${definition.chunkId}`);
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
await readFile(`dist/${routeAsset}`);
|
||||||
|
} catch {
|
||||||
|
artifactMismatches.push(`routeChunk:file:${definition.chunkId}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
const fixtures = fixturesDocument.fixtures.map((fixture) => {
|
const fixtures = fixturesDocument.fixtures.map((fixture) => {
|
||||||
const result = verifyCompatibilityTuple({
|
const result = verifyCompatibilityTuple({
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ import {
|
|||||||
createFailure as failure,
|
createFailure as failure,
|
||||||
kindForStatus as statusKind,
|
kindForStatus as statusKind,
|
||||||
normalizeUnknownFailure,
|
normalizeUnknownFailure,
|
||||||
|
safeValidationIssues,
|
||||||
} from "../../contracts/errors.js";
|
} from "../../contracts/errors.js";
|
||||||
import { mapOperationPayload } from "./resource-mapper.js";
|
import { mapOperationPayload } from "./resource-mapper.js";
|
||||||
import { retryDelay, shouldRetry } from "./retry-policy.js";
|
import { retryDelay, shouldRetry } from "./retry-policy.js";
|
||||||
@@ -46,6 +47,8 @@ const noAuthSession =
|
|||||||
* random?: () => number,
|
* random?: () => number,
|
||||||
* validatePayload?: (schemaId: string, value: unknown) =>
|
* validatePayload?: (schemaId: string, value: unknown) =>
|
||||||
* { success: true, data: unknown } | { success: false },
|
* { success: true, data: unknown } | { success: false },
|
||||||
|
* validateRequest?: (schemaId: string, value: unknown) =>
|
||||||
|
* { success: true, data: unknown } | { success: false },
|
||||||
* mapPayload?: (operationId: string, payload: unknown) => unknown,
|
* mapPayload?: (operationId: string, payload: unknown) => unknown,
|
||||||
* idempotencyKeyFactory?: () => string,
|
* idempotencyKeyFactory?: () => string,
|
||||||
* timeoutMs?: number,
|
* timeoutMs?: number,
|
||||||
@@ -61,6 +64,8 @@ export function createHttpClient(dependencies) {
|
|||||||
const random = dependencies.random ?? Math.random;
|
const random = dependencies.random ?? Math.random;
|
||||||
const validatePayload =
|
const validatePayload =
|
||||||
dependencies.validatePayload ?? validateOperationPayload;
|
dependencies.validatePayload ?? validateOperationPayload;
|
||||||
|
const validateRequest =
|
||||||
|
dependencies.validateRequest ?? validateOperationRequest;
|
||||||
const mapPayload = dependencies.mapPayload ?? mapOperationPayload;
|
const mapPayload = dependencies.mapPayload ?? mapOperationPayload;
|
||||||
const idempotencyKeyFactory =
|
const idempotencyKeyFactory =
|
||||||
dependencies.idempotencyKeyFactory ?? (() => crypto.randomUUID());
|
dependencies.idempotencyKeyFactory ?? (() => crypto.randomUUID());
|
||||||
@@ -193,7 +198,7 @@ export function createHttpClient(dependencies) {
|
|||||||
? input.body
|
? input.body
|
||||||
: {};
|
: {};
|
||||||
if (operation.requestSource !== "none") {
|
if (operation.requestSource !== "none") {
|
||||||
const requestValidation = validateOperationRequest(
|
const requestValidation = validateRequest(
|
||||||
operation.requestSchema,
|
operation.requestSchema,
|
||||||
requestValue,
|
requestValue,
|
||||||
);
|
);
|
||||||
@@ -411,6 +416,10 @@ async function parseResponse(
|
|||||||
|
|
||||||
const kind = statusKind(response.status);
|
const kind = statusKind(response.status);
|
||||||
const retryAfter = response.headers.get("retry-after");
|
const retryAfter = response.headers.get("retry-after");
|
||||||
|
const backendError =
|
||||||
|
envelopeRecord.error && typeof envelopeRecord.error === "object"
|
||||||
|
? /** @type {Record<string, unknown>} */ (envelopeRecord.error)
|
||||||
|
: {};
|
||||||
return {
|
return {
|
||||||
ok: false,
|
ok: false,
|
||||||
error: failure(kind, operation.operationId, attempt, {
|
error: failure(kind, operation.operationId, attempt, {
|
||||||
@@ -422,6 +431,10 @@ async function parseResponse(
|
|||||||
response.status === 429 && retryAfter
|
response.status === 429 && retryAfter
|
||||||
? parseRetryAfterHeader(retryAfter)
|
? parseRetryAfterHeader(retryAfter)
|
||||||
: undefined,
|
: undefined,
|
||||||
|
validationIssues:
|
||||||
|
response.status === 422
|
||||||
|
? safeValidationIssues(backendError.details)
|
||||||
|
: undefined,
|
||||||
}),
|
}),
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,30 +1,5 @@
|
|||||||
import { createResource } from "../../domain/models/resource.js";
|
|
||||||
|
|
||||||
/** @param {unknown} value */
|
|
||||||
export function mapResourceDto(value) {
|
|
||||||
if (!value || typeof value !== "object") {
|
|
||||||
throw new TypeError("Validated resource DTO is required");
|
|
||||||
}
|
|
||||||
const dto = /** @type {Record<string, unknown>} */ (value);
|
|
||||||
if (typeof dto.id !== "string" || typeof dto.name !== "string") {
|
|
||||||
throw new TypeError("Validated resource DTO invariants were breached");
|
|
||||||
}
|
|
||||||
|
|
||||||
return createResource({
|
|
||||||
id: dto.id,
|
|
||||||
displayName: dto.name,
|
|
||||||
createdAt: typeof dto.createdAt === "string" ? dto.createdAt : null,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/** @param {string} operationId @param {unknown} payload */
|
/** @param {string} operationId @param {unknown} payload */
|
||||||
export function mapOperationPayload(operationId, payload) {
|
export function mapOperationPayload(operationId, payload) {
|
||||||
if (operationId === "LIST_SAMPLE_RESOURCES") {
|
void payload;
|
||||||
if (!Array.isArray(payload)) throw new TypeError("Expected a resource list");
|
|
||||||
return payload.map(mapResourceDto);
|
|
||||||
}
|
|
||||||
if (operationId === "CREATE_SAMPLE_RESOURCE") {
|
|
||||||
return mapResourceDto(payload);
|
|
||||||
}
|
|
||||||
throw new TypeError(`No boundary mapper registered for ${operationId}`);
|
throw new TypeError(`No boundary mapper registered for ${operationId}`);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -37,35 +37,11 @@ export const responseEnvelopeSchema = z.discriminatedUnion("success", [
|
|||||||
failureEnvelopeSchema,
|
failureEnvelopeSchema,
|
||||||
]);
|
]);
|
||||||
|
|
||||||
const sampleResourceSchema = z
|
|
||||||
.object({
|
|
||||||
id: z.string().min(1),
|
|
||||||
name: z.string().min(1),
|
|
||||||
createdAt: z.string().optional(),
|
|
||||||
})
|
|
||||||
.passthrough();
|
|
||||||
|
|
||||||
const payloadSchemas =
|
const payloadSchemas =
|
||||||
/** @type {Readonly<Record<string, z.ZodType>>} */ (Object.freeze({
|
/** @type {Readonly<Record<string, z.ZodType>>} */ (Object.freeze({}));
|
||||||
SampleResourceListPayload: z.array(sampleResourceSchema),
|
|
||||||
SampleResourcePayload: sampleResourceSchema,
|
|
||||||
}));
|
|
||||||
|
|
||||||
const requestSchemas =
|
const requestSchemas =
|
||||||
/** @type {Readonly<Record<string, z.ZodType>>} */ (Object.freeze({
|
/** @type {Readonly<Record<string, z.ZodType>>} */ (Object.freeze({}));
|
||||||
SampleResourceListQuery: z
|
|
||||||
.object({
|
|
||||||
cursor: z.string().optional(),
|
|
||||||
limit: z.int().min(1).max(100).default(20),
|
|
||||||
tags: z.array(z.string().trim().min(1)).optional(),
|
|
||||||
})
|
|
||||||
.strict(),
|
|
||||||
CreateSampleResourceCommand: z
|
|
||||||
.object({
|
|
||||||
name: z.string().trim().min(1).max(120),
|
|
||||||
})
|
|
||||||
.strict(),
|
|
||||||
}));
|
|
||||||
|
|
||||||
/** @param {unknown} value */
|
/** @param {unknown} value */
|
||||||
export function validateEnvelope(value) {
|
export function validateEnvelope(value) {
|
||||||
|
|||||||
@@ -5,6 +5,7 @@ import type {
|
|||||||
RenderFailureReport,
|
RenderFailureReport,
|
||||||
} from "./ports/in/application-api.js";
|
} from "./ports/in/application-api.js";
|
||||||
import type { ApplicationOutputPorts } from "./ports/out/application-output-ports.js";
|
import type { ApplicationOutputPorts } from "./ports/out/application-output-ports.js";
|
||||||
|
import { decideChunkRecovery } from "./use-cases/decide-chunk-recovery.js";
|
||||||
|
|
||||||
export type { ApplicationApi, ApplicationOutputPorts };
|
export type { ApplicationApi, ApplicationOutputPorts };
|
||||||
|
|
||||||
@@ -14,6 +15,7 @@ export type { ApplicationApi, ApplicationOutputPorts };
|
|||||||
*/
|
*/
|
||||||
export function createApplication(
|
export function createApplication(
|
||||||
outputPorts: ApplicationOutputPorts,
|
outputPorts: ApplicationOutputPorts,
|
||||||
|
featureInputs: Readonly<Record<string, unknown>> = {},
|
||||||
): ApplicationApi {
|
): ApplicationApi {
|
||||||
const session = Object.freeze({
|
const session = Object.freeze({
|
||||||
getSnapshot: () => outputPorts.session.getState(),
|
getSnapshot: () => outputPorts.session.getState(),
|
||||||
@@ -64,10 +66,67 @@ export function createApplication(
|
|||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
|
const recovery = Object.freeze({
|
||||||
|
async recoverChunk(input: {
|
||||||
|
chunkId: string;
|
||||||
|
failureKind: "CHUNK_LOAD_FAILURE" | "DEPLOY_MISMATCH";
|
||||||
|
}) {
|
||||||
|
try {
|
||||||
|
const current = await outputPorts.releaseInfo.getCurrent();
|
||||||
|
const active = await outputPorts.releaseInfo.refresh();
|
||||||
|
if (!active.routeChunks[input.chunkId]) {
|
||||||
|
return {
|
||||||
|
action: "support" as const,
|
||||||
|
reason: "active-chunk-unknown",
|
||||||
|
};
|
||||||
|
}
|
||||||
|
const decision = decideChunkRecovery({
|
||||||
|
failureKind: input.failureKind,
|
||||||
|
manifestLoaded: true,
|
||||||
|
currentBuildId: current.buildId,
|
||||||
|
currentReleaseId: current.releaseId,
|
||||||
|
activeBuildId: active.buildId,
|
||||||
|
activeReleaseId: active.releaseId,
|
||||||
|
storage: outputPorts.preferences,
|
||||||
|
});
|
||||||
|
if (decision.action === "reload-once") {
|
||||||
|
try {
|
||||||
|
outputPorts.navigation.reload();
|
||||||
|
} catch {
|
||||||
|
return {
|
||||||
|
action: "support" as const,
|
||||||
|
reason: "reload-failed",
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return decision;
|
||||||
|
} catch {
|
||||||
|
return {
|
||||||
|
action: "support" as const,
|
||||||
|
reason: "manifest-unavailable",
|
||||||
|
};
|
||||||
|
}
|
||||||
|
},
|
||||||
|
});
|
||||||
|
const installedFeatureInputs = Object.freeze({ ...featureInputs });
|
||||||
|
const features = Object.freeze({
|
||||||
|
has(featureId: string) {
|
||||||
|
return Object.hasOwn(installedFeatureInputs, featureId);
|
||||||
|
},
|
||||||
|
get(featureId: string) {
|
||||||
|
if (!Object.hasOwn(installedFeatureInputs, featureId)) {
|
||||||
|
throw new Error(`Application feature is not installed: ${featureId}`);
|
||||||
|
}
|
||||||
|
return installedFeatureInputs[featureId];
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
return Object.freeze({
|
return Object.freeze({
|
||||||
session,
|
session,
|
||||||
preferences,
|
preferences,
|
||||||
diagnostics,
|
diagnostics,
|
||||||
runtime,
|
runtime,
|
||||||
|
recovery,
|
||||||
|
features,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -38,4 +38,17 @@ export type ApplicationApi = Readonly<{
|
|||||||
runtime: Readonly<{
|
runtime: Readonly<{
|
||||||
getReleaseSummary(): Promise<ReleaseSummary>;
|
getReleaseSummary(): Promise<ReleaseSummary>;
|
||||||
}>;
|
}>;
|
||||||
|
recovery: Readonly<{
|
||||||
|
recoverChunk(input: Readonly<{
|
||||||
|
chunkId: string;
|
||||||
|
failureKind: "CHUNK_LOAD_FAILURE" | "DEPLOY_MISMATCH";
|
||||||
|
}>): Promise<
|
||||||
|
| Readonly<{ action: "reload-once"; releasePair: string }>
|
||||||
|
| Readonly<{ action: "support"; reason: string }>
|
||||||
|
>;
|
||||||
|
}>;
|
||||||
|
features: Readonly<{
|
||||||
|
has(featureId: string): boolean;
|
||||||
|
get(featureId: string): unknown;
|
||||||
|
}>;
|
||||||
}>;
|
}>;
|
||||||
|
|||||||
@@ -15,4 +15,5 @@ export type ApplicationOutputPorts = Readonly<{
|
|||||||
preferences: StoragePort;
|
preferences: StoragePort;
|
||||||
diagnostics: TelemetryPort;
|
diagnostics: TelemetryPort;
|
||||||
releaseInfo: ReleaseInfoPort;
|
releaseInfo: ReleaseInfoPort;
|
||||||
|
navigation: Readonly<{ reload(): void }>;
|
||||||
}>;
|
}>;
|
||||||
|
|||||||
@@ -7,11 +7,5 @@ export type {
|
|||||||
export type { ClockPort } from "../clock-port.js";
|
export type { ClockPort } from "../clock-port.js";
|
||||||
export type { QueryCachePort } from "../query-cache-port.js";
|
export type { QueryCachePort } from "../query-cache-port.js";
|
||||||
export type { ReleaseInfoPort } from "../release-info-port.js";
|
export type { ReleaseInfoPort } from "../release-info-port.js";
|
||||||
export type {
|
|
||||||
RequestContext,
|
|
||||||
ResourceCommandPort,
|
|
||||||
ResourceQueryPort,
|
|
||||||
Result,
|
|
||||||
} from "../resource-ports.js";
|
|
||||||
export type { StoragePort } from "../storage-port.js";
|
export type { StoragePort } from "../storage-port.js";
|
||||||
export type { TelemetryPort } from "../telemetry-port.js";
|
export type { TelemetryPort } from "../telemetry-port.js";
|
||||||
|
|||||||
@@ -9,7 +9,16 @@
|
|||||||
* apiContractVersion: string,
|
* apiContractVersion: string,
|
||||||
* assetManifestHash: string,
|
* assetManifestHash: string,
|
||||||
* releaseId: string,
|
* releaseId: string,
|
||||||
* builtAt?: string
|
* builtAt?: string,
|
||||||
|
* routeChunks: Record<string, string>
|
||||||
|
* }>,
|
||||||
|
* refresh(): Promise<{
|
||||||
|
* buildId: string,
|
||||||
|
* configSchemaVersion: string,
|
||||||
|
* apiContractVersion: string,
|
||||||
|
* assetManifestHash: string,
|
||||||
|
* releaseId: string,
|
||||||
|
* routeChunks: Record<string, string>
|
||||||
* }>
|
* }>
|
||||||
* }} ReleaseInfoPort
|
* }} ReleaseInfoPort
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -1,28 +0,0 @@
|
|||||||
/**
|
|
||||||
* @template Query
|
|
||||||
* @template Model
|
|
||||||
* @typedef {{ execute(query: Query, context?: RequestContext): Promise<Result<Model>> }} ResourceQueryPort
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @template Command
|
|
||||||
* @template Model
|
|
||||||
* @typedef {{ execute(command: Command, context?: RequestContext): Promise<Result<Model>> }} ResourceCommandPort
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @typedef {{
|
|
||||||
* operationId: string,
|
|
||||||
* routeId: string,
|
|
||||||
* signal?: AbortSignal,
|
|
||||||
* idempotencyKey?: string
|
|
||||||
* }} RequestContext
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @template Value
|
|
||||||
* @typedef {{ ok: true, value: Value, meta?: Record<string, unknown> } |
|
|
||||||
* { ok: false, error: import("../../contracts/errors.js").ApiFailure }} Result
|
|
||||||
*/
|
|
||||||
|
|
||||||
export {};
|
|
||||||
@@ -1,13 +1,21 @@
|
|||||||
const RECOVERABLE_KINDS = new Set(["CHUNK_LOAD_FAILURE", "DEPLOY_MISMATCH"]);
|
const RECOVERABLE_KINDS = new Set(["CHUNK_LOAD_FAILURE", "DEPLOY_MISMATCH"]);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @typedef {{action: "reload-once", releasePair: string} |
|
||||||
|
* {action: "support", reason: string}} ChunkRecoveryDecision
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {{
|
* @param {{
|
||||||
* failureKind: string,
|
* failureKind: string,
|
||||||
* manifestLoaded: boolean,
|
* manifestLoaded: boolean,
|
||||||
* currentBuildId: string,
|
* currentBuildId: string,
|
||||||
|
* currentReleaseId: string,
|
||||||
|
* activeBuildId: string,
|
||||||
* activeReleaseId: string,
|
* activeReleaseId: string,
|
||||||
* storage: import("../ports/storage-port.js").StoragePort
|
* storage: import("../ports/storage-port.js").StoragePort
|
||||||
* }} input
|
* }} input
|
||||||
|
* @returns {ChunkRecoveryDecision}
|
||||||
*/
|
*/
|
||||||
export function decideChunkRecovery(input) {
|
export function decideChunkRecovery(input) {
|
||||||
if (!RECOVERABLE_KINDS.has(input.failureKind)) {
|
if (!RECOVERABLE_KINDS.has(input.failureKind)) {
|
||||||
@@ -16,13 +24,21 @@ export function decideChunkRecovery(input) {
|
|||||||
if (!input.manifestLoaded) {
|
if (!input.manifestLoaded) {
|
||||||
return { action: "support", reason: "manifest-unavailable" };
|
return { action: "support", reason: "manifest-unavailable" };
|
||||||
}
|
}
|
||||||
if (input.activeReleaseId === input.currentBuildId) {
|
if (
|
||||||
|
input.activeBuildId === input.currentBuildId &&
|
||||||
|
input.activeReleaseId === input.currentReleaseId
|
||||||
|
) {
|
||||||
return { action: "support", reason: "same-release" };
|
return { action: "support", reason: "same-release" };
|
||||||
}
|
}
|
||||||
|
|
||||||
const releasePair = `${input.currentBuildId}->${input.activeReleaseId}`;
|
const releasePair =
|
||||||
|
`${input.currentBuildId}/${input.currentReleaseId}` +
|
||||||
|
`->${input.activeBuildId}/${input.activeReleaseId}`;
|
||||||
const guard = input.storage.read("CHUNK_RELOAD_GUARD");
|
const guard = input.storage.read("CHUNK_RELOAD_GUARD");
|
||||||
if (!guard.ok || guard.value === releasePair) {
|
if (!guard.ok) {
|
||||||
|
return { action: "support", reason: "guard-read-failed" };
|
||||||
|
}
|
||||||
|
if (guard.value === releasePair) {
|
||||||
return { action: "support", reason: "reload-already-attempted" };
|
return { action: "support", reason: "reload-already-attempted" };
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,16 +0,0 @@
|
|||||||
/**
|
|
||||||
* @param {import("../../domain/models/resource.js").Resource} resource
|
|
||||||
* @param {(value: Date) => string} [formatDate]
|
|
||||||
*/
|
|
||||||
export function toResourceViewModel(
|
|
||||||
resource,
|
|
||||||
formatDate = (value) => new Intl.DateTimeFormat("ko-KR").format(value),
|
|
||||||
) {
|
|
||||||
return Object.freeze({
|
|
||||||
resourceId: resource.id,
|
|
||||||
title: resource.displayName,
|
|
||||||
createdAtLabel: resource.createdAt
|
|
||||||
? formatDate(new Date(resource.createdAt))
|
|
||||||
: null,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
@@ -16,7 +16,8 @@ import { createApplication } from "../application/create-application.js";
|
|||||||
* release: Release
|
* release: Release
|
||||||
* }): Promise<{
|
* }): Promise<{
|
||||||
* outputPorts: OutputPorts,
|
* outputPorts: OutputPorts,
|
||||||
* infrastructure: Infrastructure
|
* infrastructure: Infrastructure,
|
||||||
|
* featureInputs?: Readonly<Record<string, unknown>>
|
||||||
* }>
|
* }>
|
||||||
* }} factories
|
* }} factories
|
||||||
* @returns {Promise<Readonly<{
|
* @returns {Promise<Readonly<{
|
||||||
@@ -30,7 +31,10 @@ export async function createCompositionRoot(factories) {
|
|||||||
const config = await factories.loadConfig();
|
const config = await factories.loadConfig();
|
||||||
const release = await factories.loadRelease(config);
|
const release = await factories.loadRelease(config);
|
||||||
const adapters = await factories.createAdapters({ config, release });
|
const adapters = await factories.createAdapters({ config, release });
|
||||||
const application = createApplication(adapters.outputPorts);
|
const application = createApplication(
|
||||||
|
adapters.outputPorts,
|
||||||
|
adapters.featureInputs,
|
||||||
|
);
|
||||||
|
|
||||||
return Object.freeze({
|
return Object.freeze({
|
||||||
config,
|
config,
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
import { z } from "zod";
|
import { z } from "zod";
|
||||||
|
|
||||||
const version = z.string().regex(/^\d+(?:\.\d+){0,2}$/);
|
const version = z.string().regex(/^\d+(?:\.\d+){0,2}$/);
|
||||||
const releaseManifestSchema = z
|
export const releaseManifestSchema = z
|
||||||
.object({
|
.object({
|
||||||
schemaVersion: z.literal(1),
|
schemaVersion: z.literal(1),
|
||||||
appVersion: z.string().min(1),
|
appVersion: z.string().min(1),
|
||||||
@@ -12,6 +12,7 @@ const releaseManifestSchema = z
|
|||||||
assetManifestHash: z.string().min(1),
|
assetManifestHash: z.string().min(1),
|
||||||
releaseId: z.string().min(1),
|
releaseId: z.string().min(1),
|
||||||
builtAt: z.string().min(1),
|
builtAt: z.string().min(1),
|
||||||
|
routeChunks: z.record(z.string().min(1), z.string().min(1)),
|
||||||
})
|
})
|
||||||
.strict();
|
.strict();
|
||||||
|
|
||||||
@@ -20,7 +21,14 @@ export class ReleaseManifestError extends Error {
|
|||||||
constructor(code, safe) {
|
constructor(code, safe) {
|
||||||
super("Release manifest could not be loaded");
|
super("Release manifest could not be loaded");
|
||||||
this.name = "ReleaseManifestError";
|
this.name = "ReleaseManifestError";
|
||||||
this.kind = "RELEASE_MANIFEST_FAILURE";
|
this.kind =
|
||||||
|
{
|
||||||
|
MANIFEST_BUILD_MISMATCH: "BUILD_MISMATCH",
|
||||||
|
MANIFEST_CONFIG_SCHEMA_MISMATCH: "CONFIG_MISMATCH",
|
||||||
|
MANIFEST_API_CONTRACT_MISMATCH: "API_CONTRACT_MISMATCH",
|
||||||
|
MANIFEST_RELEASE_MISMATCH: "RELEASE_MISMATCH",
|
||||||
|
MANIFEST_ASSET_MISMATCH: "ASSET_MISMATCH",
|
||||||
|
}[code] ?? "RELEASE_MANIFEST_FAILURE";
|
||||||
this.code = code;
|
this.code = code;
|
||||||
this.safe = Object.freeze({
|
this.safe = Object.freeze({
|
||||||
kind: this.kind,
|
kind: this.kind,
|
||||||
@@ -33,75 +41,98 @@ export class ReleaseManifestError extends Error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {Awaited<ReturnType<typeof import("./load-runtime-config.js").loadRuntimeConfig>>} runtime
|
* Fetches and validates the active manifest without imposing the current
|
||||||
* @param {{fetcher?: typeof fetch}} [options]
|
* build tuple. Chunk recovery uses this no-store view to detect a new release.
|
||||||
|
*
|
||||||
|
* @param {string} url
|
||||||
|
* @param {{
|
||||||
|
* fetcher?: typeof fetch,
|
||||||
|
* buildId: string,
|
||||||
|
* releaseId?: string
|
||||||
|
* }} options
|
||||||
*/
|
*/
|
||||||
export async function loadReleaseManifest(runtime, options = {}) {
|
export async function fetchReleaseManifest(url, options) {
|
||||||
const fetcher = options.fetcher ?? fetch;
|
const fetcher = options.fetcher ?? fetch;
|
||||||
let response;
|
let response;
|
||||||
try {
|
try {
|
||||||
response = await fetcher(runtime.config.RELEASE_MANIFEST_URL, {
|
response = await fetcher(url, {
|
||||||
cache: "no-store",
|
cache: "no-store",
|
||||||
headers: { Accept: "application/json" },
|
headers: { Accept: "application/json" },
|
||||||
});
|
});
|
||||||
} catch {
|
} catch {
|
||||||
throw new ReleaseManifestError("MANIFEST_FETCH_FAILED", {
|
throw new ReleaseManifestError("MANIFEST_FETCH_FAILED", options);
|
||||||
buildId: runtime.build.buildId,
|
|
||||||
releaseId: runtime.config.RELEASE_ID,
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
if (!response.ok) {
|
if (!response.ok) {
|
||||||
throw new ReleaseManifestError("MANIFEST_HTTP_FAILED", {
|
throw new ReleaseManifestError("MANIFEST_HTTP_FAILED", options);
|
||||||
buildId: runtime.build.buildId,
|
|
||||||
releaseId: runtime.config.RELEASE_ID,
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
|
|
||||||
let raw;
|
let raw;
|
||||||
try {
|
try {
|
||||||
raw = await response.json();
|
raw = await response.json();
|
||||||
} catch {
|
} catch {
|
||||||
throw new ReleaseManifestError("MANIFEST_JSON_INVALID", {
|
throw new ReleaseManifestError("MANIFEST_JSON_INVALID", options);
|
||||||
buildId: runtime.build.buildId,
|
|
||||||
releaseId: runtime.config.RELEASE_ID,
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
const parsed = releaseManifestSchema.safeParse(raw);
|
const parsed = releaseManifestSchema.safeParse(raw);
|
||||||
if (!parsed.success) {
|
if (!parsed.success) {
|
||||||
throw new ReleaseManifestError("MANIFEST_SCHEMA_INVALID", {
|
throw new ReleaseManifestError("MANIFEST_SCHEMA_INVALID", options);
|
||||||
buildId: runtime.build.buildId,
|
}
|
||||||
releaseId: runtime.config.RELEASE_ID,
|
return Object.freeze(structuredClone(parsed.data));
|
||||||
});
|
|
||||||
}
|
}
|
||||||
|
|
||||||
const manifest = parsed.data;
|
/**
|
||||||
const mismatches = [];
|
* @param {Awaited<ReturnType<typeof import("./load-runtime-config.js").loadRuntimeConfig>>} runtime
|
||||||
if (manifest.buildId !== runtime.build.buildId) mismatches.push("buildId");
|
* @param {{fetcher?: typeof fetch, expectedAssetManifestHash?: string}} [options]
|
||||||
|
*/
|
||||||
|
export async function loadReleaseManifest(runtime, options = {}) {
|
||||||
|
const manifest = await fetchReleaseManifest(
|
||||||
|
runtime.config.RELEASE_MANIFEST_URL,
|
||||||
|
{
|
||||||
|
fetcher: options.fetcher,
|
||||||
|
buildId: runtime.build.buildId,
|
||||||
|
releaseId: runtime.config.RELEASE_ID,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
let mismatchCode = null;
|
||||||
|
if (manifest.buildId !== runtime.build.buildId) {
|
||||||
|
mismatchCode = "MANIFEST_BUILD_MISMATCH";
|
||||||
|
}
|
||||||
if (
|
if (
|
||||||
|
!mismatchCode &&
|
||||||
runtime.config.BUILD_ID &&
|
runtime.config.BUILD_ID &&
|
||||||
manifest.buildId !== runtime.config.BUILD_ID
|
manifest.buildId !== runtime.config.BUILD_ID
|
||||||
) {
|
) {
|
||||||
mismatches.push("runtimeBuildId");
|
mismatchCode = "MANIFEST_BUILD_MISMATCH";
|
||||||
}
|
}
|
||||||
if (
|
if (
|
||||||
|
!mismatchCode &&
|
||||||
manifest.configSchemaVersion !== runtime.config.CONFIG_SCHEMA_VERSION
|
manifest.configSchemaVersion !== runtime.config.CONFIG_SCHEMA_VERSION
|
||||||
) {
|
) {
|
||||||
mismatches.push("configSchemaVersion");
|
mismatchCode = "MANIFEST_CONFIG_SCHEMA_MISMATCH";
|
||||||
}
|
|
||||||
if (manifest.apiContractVersion !== runtime.config.API_CONTRACT_VERSION) {
|
|
||||||
mismatches.push("apiContractVersion");
|
|
||||||
}
|
}
|
||||||
if (
|
if (
|
||||||
|
!mismatchCode &&
|
||||||
|
manifest.apiContractVersion !== runtime.config.API_CONTRACT_VERSION
|
||||||
|
) {
|
||||||
|
mismatchCode = "MANIFEST_API_CONTRACT_MISMATCH";
|
||||||
|
}
|
||||||
|
if (
|
||||||
|
!mismatchCode &&
|
||||||
runtime.config.RELEASE_ID &&
|
runtime.config.RELEASE_ID &&
|
||||||
manifest.releaseId !== runtime.config.RELEASE_ID
|
manifest.releaseId !== runtime.config.RELEASE_ID
|
||||||
) {
|
) {
|
||||||
mismatches.push("releaseId");
|
mismatchCode = "MANIFEST_RELEASE_MISMATCH";
|
||||||
}
|
}
|
||||||
if (mismatches.length > 0) {
|
if (
|
||||||
throw new ReleaseManifestError("MANIFEST_RUNTIME_MISMATCH", {
|
!mismatchCode &&
|
||||||
|
options.expectedAssetManifestHash &&
|
||||||
|
manifest.assetManifestHash !== options.expectedAssetManifestHash
|
||||||
|
) {
|
||||||
|
mismatchCode = "MANIFEST_ASSET_MISMATCH";
|
||||||
|
}
|
||||||
|
if (mismatchCode) {
|
||||||
|
throw new ReleaseManifestError(mismatchCode, {
|
||||||
buildId: runtime.build.buildId,
|
buildId: runtime.build.buildId,
|
||||||
releaseId: runtime.config.RELEASE_ID,
|
releaseId: runtime.config.RELEASE_ID,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
return Object.freeze(structuredClone(manifest));
|
return manifest;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -9,6 +9,8 @@ import {
|
|||||||
} from "../adapters/query-cache/tanstack-query-cache.js";
|
} from "../adapters/query-cache/tanstack-query-cache.js";
|
||||||
import { createBrowserStorageAdapter } from "../adapters/storage/browser-storage-adapter.js";
|
import { createBrowserStorageAdapter } from "../adapters/storage/browser-storage-adapter.js";
|
||||||
import { createTelemetryAdapter } from "../adapters/telemetry/best-effort-telemetry.js";
|
import { createTelemetryAdapter } from "../adapters/telemetry/best-effort-telemetry.js";
|
||||||
|
import { fetchReleaseManifest } from "./load-release-manifest.js";
|
||||||
|
import { createInstalledFeatureInputs } from "../features/installed-feature-adapters.js";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {Record<string, unknown>} host
|
* @param {Record<string, unknown>} host
|
||||||
@@ -53,7 +55,7 @@ function storageOrUndefined(value) {
|
|||||||
* scheduler?: Parameters<typeof createHttpClient>[0]["scheduler"]
|
* scheduler?: Parameters<typeof createHttpClient>[0]["scheduler"]
|
||||||
* }} context
|
* }} context
|
||||||
*/
|
*/
|
||||||
export function createRuntimeHttpClient(context) {
|
export function createRuntimeHttpClient(context, contract = {}) {
|
||||||
return createHttpClient({
|
return createHttpClient({
|
||||||
baseUrl: context.runtime.config.API_BASE_URL,
|
baseUrl: context.runtime.config.API_BASE_URL,
|
||||||
timeoutMs: context.runtime.config.REQUEST_TIMEOUT_MS,
|
timeoutMs: context.runtime.config.REQUEST_TIMEOUT_MS,
|
||||||
@@ -62,6 +64,7 @@ export function createRuntimeHttpClient(context) {
|
|||||||
fetcher: context.fetcher,
|
fetcher: context.fetcher,
|
||||||
clock: context.clock,
|
clock: context.clock,
|
||||||
scheduler: context.scheduler,
|
scheduler: context.scheduler,
|
||||||
|
...contract,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -97,6 +100,34 @@ export async function createRuntimeAdapters(context) {
|
|||||||
async getCurrent() {
|
async getCurrent() {
|
||||||
return structuredClone(context.release);
|
return structuredClone(context.release);
|
||||||
},
|
},
|
||||||
|
async refresh() {
|
||||||
|
return fetchReleaseManifest(config.RELEASE_MANIFEST_URL, {
|
||||||
|
fetcher: context.fetcher,
|
||||||
|
buildId: context.release.buildId,
|
||||||
|
releaseId: context.release.releaseId,
|
||||||
|
});
|
||||||
|
},
|
||||||
|
});
|
||||||
|
const navigation = Object.freeze({
|
||||||
|
reload() {
|
||||||
|
const location =
|
||||||
|
/** @type {{reload?: () => void} | undefined} */ (host.location);
|
||||||
|
if (typeof location?.reload !== "function") {
|
||||||
|
throw new Error("Browser reload is unavailable");
|
||||||
|
}
|
||||||
|
location.reload();
|
||||||
|
},
|
||||||
|
});
|
||||||
|
const featureInputs = createInstalledFeatureInputs({
|
||||||
|
createHttpClient: (contract) =>
|
||||||
|
createRuntimeHttpClient(
|
||||||
|
{
|
||||||
|
runtime: context.runtime,
|
||||||
|
authSession,
|
||||||
|
fetcher: context.fetcher,
|
||||||
|
},
|
||||||
|
contract,
|
||||||
|
),
|
||||||
});
|
});
|
||||||
|
|
||||||
return Object.freeze({
|
return Object.freeze({
|
||||||
@@ -105,9 +136,11 @@ export async function createRuntimeAdapters(context) {
|
|||||||
preferences: storage,
|
preferences: storage,
|
||||||
diagnostics: telemetry,
|
diagnostics: telemetry,
|
||||||
releaseInfo,
|
releaseInfo,
|
||||||
|
navigation,
|
||||||
}),
|
}),
|
||||||
infrastructure: Object.freeze({
|
infrastructure: Object.freeze({
|
||||||
queryClient,
|
queryClient,
|
||||||
}),
|
}),
|
||||||
|
featureInputs,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -14,41 +14,11 @@
|
|||||||
* }} ApiOperation
|
* }} ApiOperation
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** @param {ApiOperation} definition */
|
export const API_OPERATIONS = Object.freeze({});
|
||||||
const operation = (definition) => Object.freeze(definition);
|
|
||||||
|
|
||||||
export const API_OPERATIONS = Object.freeze({
|
|
||||||
LIST_SAMPLE_RESOURCES: operation({
|
|
||||||
method: "GET",
|
|
||||||
path: "/api/sample/resources",
|
|
||||||
operationId: "LIST_SAMPLE_RESOURCES",
|
|
||||||
auth: "external-session",
|
|
||||||
timeoutMs: null,
|
|
||||||
idempotency: "safe",
|
|
||||||
retry: "runtime",
|
|
||||||
requestSource: "search",
|
|
||||||
requestSchema: "SampleResourceListQuery",
|
|
||||||
responseSchema: "SampleResourceListPayload",
|
|
||||||
owner: "feature-sample-feature-slice-contract-fixture",
|
|
||||||
}),
|
|
||||||
CREATE_SAMPLE_RESOURCE: operation({
|
|
||||||
method: "POST",
|
|
||||||
path: "/api/sample/resources",
|
|
||||||
operationId: "CREATE_SAMPLE_RESOURCE",
|
|
||||||
auth: "external-session",
|
|
||||||
timeoutMs: null,
|
|
||||||
idempotency: "keyed",
|
|
||||||
retry: "runtime",
|
|
||||||
requestSource: "body",
|
|
||||||
requestSchema: "CreateSampleResourceCommand",
|
|
||||||
responseSchema: "SampleResourcePayload",
|
|
||||||
owner: "feature-sample-feature-slice-contract-fixture",
|
|
||||||
}),
|
|
||||||
});
|
|
||||||
|
|
||||||
/** @param {string} operationId */
|
/** @param {string} operationId */
|
||||||
export function getApiOperation(operationId) {
|
export function getApiOperation(operationId, operations = API_OPERATIONS) {
|
||||||
const registry = /** @type {Record<string, ApiOperation>} */ (API_OPERATIONS);
|
const registry = /** @type {Record<string, ApiOperation>} */ (operations);
|
||||||
const selected = registry[operationId];
|
const selected = registry[operationId];
|
||||||
if (!selected) {
|
if (!selected) {
|
||||||
throw new Error(`Unregistered API operation: ${operationId}`);
|
throw new Error(`Unregistered API operation: ${operationId}`);
|
||||||
|
|||||||
@@ -111,6 +111,41 @@ export const ERROR_REGISTRY = Object.freeze({
|
|||||||
"reload-once",
|
"reload-once",
|
||||||
"release.mismatch.detected",
|
"release.mismatch.detected",
|
||||||
),
|
),
|
||||||
|
BUILD_MISMATCH: row(
|
||||||
|
"BUILD_MISMATCH",
|
||||||
|
false,
|
||||||
|
"error",
|
||||||
|
"reload-once",
|
||||||
|
"release.mismatch.detected",
|
||||||
|
),
|
||||||
|
CONFIG_MISMATCH: row(
|
||||||
|
"CONFIG_MISMATCH",
|
||||||
|
false,
|
||||||
|
"error",
|
||||||
|
"contact-support",
|
||||||
|
"app.boot.failed",
|
||||||
|
),
|
||||||
|
API_CONTRACT_MISMATCH: row(
|
||||||
|
"API_CONTRACT_MISMATCH",
|
||||||
|
false,
|
||||||
|
"error",
|
||||||
|
"contact-support",
|
||||||
|
"app.boot.failed",
|
||||||
|
),
|
||||||
|
RELEASE_MISMATCH: row(
|
||||||
|
"RELEASE_MISMATCH",
|
||||||
|
false,
|
||||||
|
"error",
|
||||||
|
"reload-once",
|
||||||
|
"release.mismatch.detected",
|
||||||
|
),
|
||||||
|
ASSET_MISMATCH: row(
|
||||||
|
"ASSET_MISMATCH",
|
||||||
|
false,
|
||||||
|
"error",
|
||||||
|
"reload-once",
|
||||||
|
"release.mismatch.detected",
|
||||||
|
),
|
||||||
STORAGE_UNAVAILABLE: row(
|
STORAGE_UNAVAILABLE: row(
|
||||||
"STORAGE_UNAVAILABLE",
|
"STORAGE_UNAVAILABLE",
|
||||||
false,
|
false,
|
||||||
@@ -160,6 +195,7 @@ export const ERROR_REGISTRY = Object.freeze({
|
|||||||
* requestId?: string,
|
* requestId?: string,
|
||||||
* traceId?: string,
|
* traceId?: string,
|
||||||
* retryAfterMs?: number,
|
* retryAfterMs?: number,
|
||||||
|
* validationIssues?: readonly Readonly<{path: string, code: string}>[],
|
||||||
* userMessageKey: string,
|
* userMessageKey: string,
|
||||||
* action: ErrorAction,
|
* action: ErrorAction,
|
||||||
* causeClass?: string
|
* causeClass?: string
|
||||||
@@ -176,6 +212,7 @@ export const ERROR_REGISTRY = Object.freeze({
|
|||||||
* requestId?: string,
|
* requestId?: string,
|
||||||
* traceId?: string,
|
* traceId?: string,
|
||||||
* retryAfterMs?: number,
|
* retryAfterMs?: number,
|
||||||
|
* validationIssues?: readonly Readonly<{path: string, code: string}>[],
|
||||||
* causeClass?: string
|
* causeClass?: string
|
||||||
* }} [details]
|
* }} [details]
|
||||||
* @returns {ApiFailure}
|
* @returns {ApiFailure}
|
||||||
@@ -201,6 +238,24 @@ export function createFailure(kind, operationId, attempt, details = {}) {
|
|||||||
...(typeof details.retryAfterMs === "number"
|
...(typeof details.retryAfterMs === "number"
|
||||||
? { retryAfterMs: details.retryAfterMs }
|
? { retryAfterMs: details.retryAfterMs }
|
||||||
: {}),
|
: {}),
|
||||||
|
...(Array.isArray(details.validationIssues)
|
||||||
|
? {
|
||||||
|
validationIssues: Object.freeze(
|
||||||
|
details.validationIssues
|
||||||
|
.filter(
|
||||||
|
(issue) =>
|
||||||
|
issue &&
|
||||||
|
typeof issue === "object" &&
|
||||||
|
typeof issue.path === "string" &&
|
||||||
|
typeof issue.code === "string",
|
||||||
|
)
|
||||||
|
.slice(0, 50)
|
||||||
|
.map((issue) =>
|
||||||
|
Object.freeze({ path: issue.path, code: issue.code }),
|
||||||
|
),
|
||||||
|
),
|
||||||
|
}
|
||||||
|
: {}),
|
||||||
...(typeof details.causeClass === "string"
|
...(typeof details.causeClass === "string"
|
||||||
? { causeClass: details.causeClass }
|
? { causeClass: details.causeClass }
|
||||||
: {}),
|
: {}),
|
||||||
@@ -209,6 +264,44 @@ export function createFailure(kind, operationId, attempt, details = {}) {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Projects an untrusted 422 details payload into the only validation metadata
|
||||||
|
* allowed to cross the HTTP boundary. Backend copy and additional values are
|
||||||
|
* deliberately discarded.
|
||||||
|
*
|
||||||
|
* @param {unknown} value
|
||||||
|
* @returns {readonly Readonly<{path: string, code: string}>[]}
|
||||||
|
*/
|
||||||
|
export function safeValidationIssues(value) {
|
||||||
|
if (!value || typeof value !== "object") return Object.freeze([]);
|
||||||
|
const candidate =
|
||||||
|
/** @type {{issues?: unknown, fieldErrors?: unknown}} */ (value);
|
||||||
|
const issues = Array.isArray(candidate.issues)
|
||||||
|
? candidate.issues
|
||||||
|
: Array.isArray(candidate.fieldErrors)
|
||||||
|
? candidate.fieldErrors
|
||||||
|
: [];
|
||||||
|
return Object.freeze(
|
||||||
|
issues
|
||||||
|
.filter(
|
||||||
|
(issue) =>
|
||||||
|
issue &&
|
||||||
|
typeof issue === "object" &&
|
||||||
|
typeof issue.path === "string" &&
|
||||||
|
typeof issue.code === "string" &&
|
||||||
|
issue.path.length <= 120 &&
|
||||||
|
issue.code.length <= 80,
|
||||||
|
)
|
||||||
|
.slice(0, 50)
|
||||||
|
.map((issue) =>
|
||||||
|
Object.freeze({
|
||||||
|
path: issue.path,
|
||||||
|
code: issue.code,
|
||||||
|
}),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
/** @param {number} status */
|
/** @param {number} status */
|
||||||
export function kindForStatus(status) {
|
export function kindForStatus(status) {
|
||||||
if (status === 401) return "AUTH_REQUIRED";
|
if (status === 401) return "AUTH_REQUIRED";
|
||||||
|
|||||||
@@ -1,26 +1,4 @@
|
|||||||
const RESOURCE_NAMESPACE = Object.freeze(["resource", 1]);
|
export const QUERY_REGISTRY = Object.freeze({});
|
||||||
|
|
||||||
export const queryKeys = Object.freeze({
|
|
||||||
resource: Object.freeze({
|
|
||||||
all: () => RESOURCE_NAMESPACE,
|
|
||||||
list: (filters = {}) =>
|
|
||||||
Object.freeze([...RESOURCE_NAMESPACE, "list", canonicalize(filters)]),
|
|
||||||
/** @param {string} resourceId */
|
|
||||||
detail: (resourceId) =>
|
|
||||||
Object.freeze([...RESOURCE_NAMESPACE, "detail", String(resourceId)]),
|
|
||||||
}),
|
|
||||||
});
|
|
||||||
|
|
||||||
export const QUERY_REGISTRY = Object.freeze({
|
|
||||||
RESOURCE: Object.freeze({
|
|
||||||
namespace: RESOURCE_NAMESPACE,
|
|
||||||
serialization: "canonical-object-order",
|
|
||||||
identity: "no-pii-token-or-raw-url",
|
|
||||||
invalidation: "resource namespace after successful mutation",
|
|
||||||
version: 1,
|
|
||||||
persistence: "disabled",
|
|
||||||
}),
|
|
||||||
});
|
|
||||||
|
|
||||||
/** @param {unknown} value @returns {unknown} */
|
/** @param {unknown} value @returns {unknown} */
|
||||||
export function canonicalize(value) {
|
export function canonicalize(value) {
|
||||||
|
|||||||
@@ -0,0 +1,39 @@
|
|||||||
|
/**
|
||||||
|
* @typedef {"none" | "NotFoundSplat"} RouteCodecId
|
||||||
|
*/
|
||||||
|
|
||||||
|
/** @param {Readonly<{routeId: string, moduleId: string, paramsCodec: RouteCodecId, searchCodec: RouteCodecId}>} value */
|
||||||
|
const runtime = (value) => Object.freeze(value);
|
||||||
|
|
||||||
|
export const PLATFORM_ROUTE_RUNTIME_CONTRACT = Object.freeze({
|
||||||
|
APP_HOME: runtime({
|
||||||
|
routeId: "APP_HOME",
|
||||||
|
moduleId: "home-page",
|
||||||
|
paramsCodec: "none",
|
||||||
|
searchCodec: "none",
|
||||||
|
}),
|
||||||
|
EXAMPLES_UI: runtime({
|
||||||
|
routeId: "EXAMPLES_UI",
|
||||||
|
moduleId: "ui-gallery-page",
|
||||||
|
paramsCodec: "none",
|
||||||
|
searchCodec: "none",
|
||||||
|
}),
|
||||||
|
EXAMPLES_STATES: runtime({
|
||||||
|
routeId: "EXAMPLES_STATES",
|
||||||
|
moduleId: "state-gallery-page",
|
||||||
|
paramsCodec: "none",
|
||||||
|
searchCodec: "none",
|
||||||
|
}),
|
||||||
|
EXAMPLES_AUTH: runtime({
|
||||||
|
routeId: "EXAMPLES_AUTH",
|
||||||
|
moduleId: "auth-example-page",
|
||||||
|
paramsCodec: "none",
|
||||||
|
searchCodec: "none",
|
||||||
|
}),
|
||||||
|
NOT_FOUND: runtime({
|
||||||
|
routeId: "NOT_FOUND",
|
||||||
|
moduleId: "not-found-page",
|
||||||
|
paramsCodec: "NotFoundSplat",
|
||||||
|
searchCodec: "none",
|
||||||
|
}),
|
||||||
|
});
|
||||||
+2
-40
@@ -17,7 +17,7 @@
|
|||||||
/** @param {RouteDefinition} definition */
|
/** @param {RouteDefinition} definition */
|
||||||
const route = (definition) => Object.freeze(definition);
|
const route = (definition) => Object.freeze(definition);
|
||||||
|
|
||||||
export const ROUTE_REGISTRY = Object.freeze({
|
export const PLATFORM_ROUTE_REGISTRY = Object.freeze({
|
||||||
APP_HOME: route({
|
APP_HOME: route({
|
||||||
routeId: "APP_HOME",
|
routeId: "APP_HOME",
|
||||||
path: "/",
|
path: "/",
|
||||||
@@ -70,23 +70,10 @@ export const ROUTE_REGISTRY = Object.freeze({
|
|||||||
navigationLabel: "인증 연동",
|
navigationLabel: "인증 연동",
|
||||||
navigationOrder: 40,
|
navigationOrder: 40,
|
||||||
}),
|
}),
|
||||||
SAMPLE_RESOURCE_LIST: route({
|
|
||||||
routeId: "SAMPLE_RESOURCE_LIST",
|
|
||||||
path: "/sample/resources",
|
|
||||||
paramsSchema: null,
|
|
||||||
searchSchema: "SampleResourceListQuery",
|
|
||||||
access: "integration-defined",
|
|
||||||
loadingSurface: "sample-resource-list",
|
|
||||||
errorSurface: "feature-boundary",
|
|
||||||
chunkId: "route-sample-resources",
|
|
||||||
title: "보호된 연동 지점",
|
|
||||||
navigationLabel: "보호된 연동 지점",
|
|
||||||
navigationOrder: 50,
|
|
||||||
}),
|
|
||||||
NOT_FOUND: route({
|
NOT_FOUND: route({
|
||||||
routeId: "NOT_FOUND",
|
routeId: "NOT_FOUND",
|
||||||
path: "*",
|
path: "*",
|
||||||
paramsSchema: null,
|
paramsSchema: "NotFoundSplat",
|
||||||
searchSchema: null,
|
searchSchema: null,
|
||||||
access: "public",
|
access: "public",
|
||||||
loadingSurface: "none",
|
loadingSurface: "none",
|
||||||
@@ -97,28 +84,3 @@ export const ROUTE_REGISTRY = Object.freeze({
|
|||||||
navigationOrder: null,
|
navigationOrder: null,
|
||||||
}),
|
}),
|
||||||
});
|
});
|
||||||
|
|
||||||
export const NAVIGATION_ROUTES = Object.freeze(
|
|
||||||
Object.values(ROUTE_REGISTRY)
|
|
||||||
.filter((definition) => definition.navigationOrder !== null)
|
|
||||||
.sort(
|
|
||||||
(left, right) =>
|
|
||||||
/** @type {number} */ (left.navigationOrder) -
|
|
||||||
/** @type {number} */ (right.navigationOrder),
|
|
||||||
),
|
|
||||||
);
|
|
||||||
|
|
||||||
/** @param {string} routeId */
|
|
||||||
export function getRoute(routeId) {
|
|
||||||
const registry = /** @type {Record<string, Readonly<RouteDefinition>>} */ (
|
|
||||||
ROUTE_REGISTRY
|
|
||||||
);
|
|
||||||
const selected = registry[routeId];
|
|
||||||
if (!selected) throw new Error(`Unregistered route: ${routeId}`);
|
|
||||||
return selected;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** @param {string} routeId */
|
|
||||||
export function routePath(routeId) {
|
|
||||||
return getRoute(routeId).path;
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -1,19 +0,0 @@
|
|||||||
/**
|
|
||||||
* @typedef {{
|
|
||||||
* id: string,
|
|
||||||
* displayName: string,
|
|
||||||
* createdAt: string | null
|
|
||||||
* }} Resource
|
|
||||||
*/
|
|
||||||
|
|
||||||
/** @param {Resource} values @returns {Readonly<Resource>} */
|
|
||||||
export function createResource(values) {
|
|
||||||
if (!values.id || !values.displayName) {
|
|
||||||
throw new TypeError("Resource invariants require id and displayName");
|
|
||||||
}
|
|
||||||
return Object.freeze({
|
|
||||||
id: values.id,
|
|
||||||
displayName: values.displayName,
|
|
||||||
createdAt: values.createdAt,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,15 @@
|
|||||||
|
import { createReferenceFeatureInstalledInput } from "./reference-feature/adapters/create-reference-feature-input.js";
|
||||||
|
|
||||||
|
export function createInstalledFeatureInputs(
|
||||||
|
context: Parameters<typeof createReferenceFeatureInstalledInput>[0],
|
||||||
|
): Readonly<Record<string, unknown>> {
|
||||||
|
const installed = [createReferenceFeatureInstalledInput(context)];
|
||||||
|
return Object.freeze(
|
||||||
|
Object.fromEntries(
|
||||||
|
installed.map((contribution) => [
|
||||||
|
contribution.featureId,
|
||||||
|
contribution.input,
|
||||||
|
]),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,48 @@
|
|||||||
|
import { PLATFORM_ROUTE_RUNTIME_CONTRACT } from "../contracts/route-runtime-contract.js";
|
||||||
|
import { PLATFORM_ROUTE_REGISTRY } from "../contracts/routes.js";
|
||||||
|
import { REFERENCE_FEATURE_CONTRACT } from "./reference-feature/contracts/reference-feature-contract.js";
|
||||||
|
|
||||||
|
export const INSTALLED_FEATURE_CONTRACTS = Object.freeze([
|
||||||
|
REFERENCE_FEATURE_CONTRACT,
|
||||||
|
]);
|
||||||
|
|
||||||
|
export const ROUTE_REGISTRY = Object.freeze({
|
||||||
|
...PLATFORM_ROUTE_REGISTRY,
|
||||||
|
...REFERENCE_FEATURE_CONTRACT.routes,
|
||||||
|
});
|
||||||
|
export const ROUTE_RUNTIME_CONTRACT = Object.freeze({
|
||||||
|
...PLATFORM_ROUTE_RUNTIME_CONTRACT,
|
||||||
|
...REFERENCE_FEATURE_CONTRACT.routeRuntimeContracts,
|
||||||
|
});
|
||||||
|
export const API_OPERATIONS = Object.freeze({
|
||||||
|
...REFERENCE_FEATURE_CONTRACT.apiOperations,
|
||||||
|
});
|
||||||
|
export const QUERY_REGISTRY = Object.freeze({
|
||||||
|
...REFERENCE_FEATURE_CONTRACT.queryRegistry,
|
||||||
|
});
|
||||||
|
|
||||||
|
export const NAVIGATION_ROUTES = Object.freeze(
|
||||||
|
Object.values(ROUTE_REGISTRY)
|
||||||
|
.filter((definition) => definition.navigationOrder !== null)
|
||||||
|
.sort(
|
||||||
|
(left, right) =>
|
||||||
|
/** @type {number} */ (left.navigationOrder) -
|
||||||
|
/** @type {number} */ (right.navigationOrder),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
|
||||||
|
/** @param {string} routeId */
|
||||||
|
export function getRoute(routeId) {
|
||||||
|
const registry =
|
||||||
|
/** @type {Readonly<Record<string, import("../contracts/routes.js").RouteDefinition>>} */ (
|
||||||
|
ROUTE_REGISTRY
|
||||||
|
);
|
||||||
|
const selected = registry[routeId];
|
||||||
|
if (!selected) throw new Error(`Unregistered route: ${routeId}`);
|
||||||
|
return selected;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @param {string} routeId */
|
||||||
|
export function routePath(routeId) {
|
||||||
|
return getRoute(routeId).path;
|
||||||
|
}
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
import { PLATFORM_ROUTE_CODECS } from "../presentation/routes/platform-route-codecs.js";
|
||||||
|
import { PLATFORM_ROUTE_RUNTIME } from "../presentation/routes/route-runtime.js";
|
||||||
|
import {
|
||||||
|
REFERENCE_FEATURE_ROUTE_CODECS,
|
||||||
|
REFERENCE_FEATURE_ROUTE_RUNTIME,
|
||||||
|
} from "./reference-feature/presentation/reference-feature-runtime.js";
|
||||||
|
|
||||||
|
export const ROUTE_CODECS = Object.freeze({
|
||||||
|
...PLATFORM_ROUTE_CODECS,
|
||||||
|
...REFERENCE_FEATURE_ROUTE_CODECS,
|
||||||
|
});
|
||||||
|
|
||||||
|
export const ROUTE_RUNTIME = Object.freeze({
|
||||||
|
...PLATFORM_ROUTE_RUNTIME,
|
||||||
|
...REFERENCE_FEATURE_ROUTE_RUNTIME,
|
||||||
|
});
|
||||||
@@ -0,0 +1,39 @@
|
|||||||
|
# Reference feature ownership and removal
|
||||||
|
|
||||||
|
이 모듈은 제품 도메인이 아니라 새 기능의 수직 경계를 검증하는 제거 가능한
|
||||||
|
reference implementation이다.
|
||||||
|
|
||||||
|
## 소유 경계
|
||||||
|
|
||||||
|
- `domain`: 외부 DTO와 React를 모르는 불변 model
|
||||||
|
- `application`: UI가 호출하는 list/get/create input과 gateway 계약
|
||||||
|
- `adapters`: HTTP executor를 gateway로 투영하는 outbound adapter
|
||||||
|
- `contracts`: route/API/query contribution, Zod DTO와 request schema, mapper
|
||||||
|
- `presentation`: route input을 query/form controller로 연결하는 inbound
|
||||||
|
adapter, 독립 form schema/command mapper와 list/detail/form/status page
|
||||||
|
|
||||||
|
generic application은 `features.get(featureId)` catalog만 제공한다. feature hook이
|
||||||
|
자신의 input shape를 확인하며 page는 HTTP client, storage, auth owner, output
|
||||||
|
port나 TanStack API를 직접 import하지 않는다.
|
||||||
|
|
||||||
|
## 설치 지점
|
||||||
|
|
||||||
|
- 직렬화 계약: `src/features/installed-feature-contracts.js`
|
||||||
|
- component/codec: `src/features/installed-feature-runtimes.tsx`
|
||||||
|
- bootstrap input 조립: `src/features/installed-feature-adapters.ts`
|
||||||
|
|
||||||
|
새 기능도 이 세 지점에 contribution을 합성하되 feature ID를 generic application,
|
||||||
|
router나 HTTP client에 하드코딩하지 않는다.
|
||||||
|
|
||||||
|
## 검증과 제거
|
||||||
|
|
||||||
|
```sh
|
||||||
|
corepack pnpm test:reference-feature
|
||||||
|
corepack pnpm test:sample-removal
|
||||||
|
```
|
||||||
|
|
||||||
|
첫 명령은 URL filter와 query key/HTTP request의 동일성, schema/mapper, 모든
|
||||||
|
query/mutation/form 상태와 production composition을 검증한다. 두 번째 명령은 임시
|
||||||
|
복제본에서 이 source/test 디렉터리를 제거하고 installed catalog를 빈 목록으로
|
||||||
|
재생성한 뒤 typecheck, architecture, registry, unit/integration, home smoke,
|
||||||
|
production build와 source/built fixture ID 잔여 0개를 검사한다.
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
import { createReferenceFeatureInput } from "../application/reference-feature-api.js";
|
||||||
|
import {
|
||||||
|
REFERENCE_FEATURE_CONTRACT,
|
||||||
|
REFERENCE_FEATURE_ID,
|
||||||
|
} from "../contracts/reference-feature-contract.js";
|
||||||
|
import { mapReferenceOperation } from "../contracts/reference-mapper.js";
|
||||||
|
import {
|
||||||
|
validateReferencePayload,
|
||||||
|
validateReferenceRequest,
|
||||||
|
} from "../contracts/reference-schemas.js";
|
||||||
|
import { createReferenceHttpGateway } from "./reference-http-gateway.js";
|
||||||
|
|
||||||
|
type HttpContract = Readonly<{
|
||||||
|
getOperation(operationId: string): unknown;
|
||||||
|
validatePayload: typeof validateReferencePayload;
|
||||||
|
validateRequest: typeof validateReferenceRequest;
|
||||||
|
mapPayload: typeof mapReferenceOperation;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
type HttpExecutor = Parameters<typeof createReferenceHttpGateway>[0];
|
||||||
|
|
||||||
|
export function createReferenceFeatureInstalledInput(context: Readonly<{
|
||||||
|
createHttpClient(contract: HttpContract): HttpExecutor;
|
||||||
|
}>) {
|
||||||
|
const operations =
|
||||||
|
REFERENCE_FEATURE_CONTRACT.apiOperations as Readonly<Record<string, unknown>>;
|
||||||
|
const http = context.createHttpClient({
|
||||||
|
getOperation(operationId) {
|
||||||
|
const operation = operations[operationId];
|
||||||
|
if (!operation) {
|
||||||
|
throw new Error(`Unknown reference operation: ${operationId}`);
|
||||||
|
}
|
||||||
|
return operation;
|
||||||
|
},
|
||||||
|
validatePayload: validateReferencePayload,
|
||||||
|
validateRequest: validateReferenceRequest,
|
||||||
|
mapPayload: mapReferenceOperation,
|
||||||
|
});
|
||||||
|
return Object.freeze({
|
||||||
|
featureId: REFERENCE_FEATURE_ID,
|
||||||
|
input: createReferenceFeatureInput(createReferenceHttpGateway(http)),
|
||||||
|
});
|
||||||
|
}
|
||||||
@@ -0,0 +1,71 @@
|
|||||||
|
import type { ApiFailure } from "../../../contracts/errors.js";
|
||||||
|
import type {
|
||||||
|
ReferenceGateway,
|
||||||
|
ReferenceListFilters,
|
||||||
|
} from "../application/reference-feature-api.js";
|
||||||
|
import type { ReferenceResource } from "../domain/reference-resource.js";
|
||||||
|
|
||||||
|
type HttpResult =
|
||||||
|
| Readonly<{ ok: true; value: unknown }>
|
||||||
|
| Readonly<{ ok: false; error: ApiFailure }>;
|
||||||
|
|
||||||
|
type HttpExecutor = Readonly<{
|
||||||
|
execute(
|
||||||
|
request: Readonly<{
|
||||||
|
operationId: string;
|
||||||
|
routeId: string;
|
||||||
|
pathParams?: Record<string, string | number>;
|
||||||
|
searchParams?: unknown;
|
||||||
|
body?: unknown;
|
||||||
|
signal?: AbortSignal;
|
||||||
|
}>,
|
||||||
|
): Promise<HttpResult>;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export function createReferenceHttpGateway(
|
||||||
|
http: HttpExecutor,
|
||||||
|
): ReferenceGateway {
|
||||||
|
return Object.freeze({
|
||||||
|
async list(
|
||||||
|
filters: ReferenceListFilters,
|
||||||
|
context?: Readonly<{ signal?: AbortSignal }>,
|
||||||
|
) {
|
||||||
|
const result = await http.execute({
|
||||||
|
operationId: "LIST_REFERENCE_RESOURCES",
|
||||||
|
routeId: "REFERENCE_RESOURCE_LIST",
|
||||||
|
searchParams: filters,
|
||||||
|
signal: context?.signal,
|
||||||
|
});
|
||||||
|
return result.ok
|
||||||
|
? {
|
||||||
|
ok: true as const,
|
||||||
|
value: result.value as readonly ReferenceResource[],
|
||||||
|
}
|
||||||
|
: result;
|
||||||
|
},
|
||||||
|
async create(command: Readonly<{ name: string; note?: string }>) {
|
||||||
|
const result = await http.execute({
|
||||||
|
operationId: "CREATE_REFERENCE_RESOURCE",
|
||||||
|
routeId: "REFERENCE_RESOURCE_LIST",
|
||||||
|
body: command,
|
||||||
|
});
|
||||||
|
return result.ok
|
||||||
|
? { ok: true as const, value: result.value as ReferenceResource }
|
||||||
|
: result;
|
||||||
|
},
|
||||||
|
async get(
|
||||||
|
resourceId: string,
|
||||||
|
context?: Readonly<{ signal?: AbortSignal }>,
|
||||||
|
) {
|
||||||
|
const result = await http.execute({
|
||||||
|
operationId: "GET_REFERENCE_RESOURCE",
|
||||||
|
routeId: "REFERENCE_RESOURCE_DETAIL",
|
||||||
|
pathParams: { resourceId },
|
||||||
|
signal: context?.signal,
|
||||||
|
});
|
||||||
|
return result.ok
|
||||||
|
? { ok: true as const, value: result.value as ReferenceResource }
|
||||||
|
: result;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
}
|
||||||
@@ -0,0 +1,72 @@
|
|||||||
|
import type { ApiFailure } from "../../../contracts/errors.js";
|
||||||
|
import {
|
||||||
|
toReferenceView,
|
||||||
|
type ReferenceResourceView,
|
||||||
|
} from "../contracts/reference-mapper.js";
|
||||||
|
import type { ReferenceResource } from "../domain/reference-resource.js";
|
||||||
|
|
||||||
|
export type ReferenceListFilters = Readonly<{
|
||||||
|
cursor?: string;
|
||||||
|
limit: number;
|
||||||
|
tags?: readonly string[];
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export type ReferenceResult<Value> =
|
||||||
|
| Readonly<{ ok: true; value: Value }>
|
||||||
|
| Readonly<{ ok: false; error: ApiFailure }>;
|
||||||
|
|
||||||
|
export type ReferenceFeatureInput = Readonly<{
|
||||||
|
listResources(
|
||||||
|
filters: ReferenceListFilters,
|
||||||
|
context?: Readonly<{ signal?: AbortSignal }>,
|
||||||
|
): Promise<ReferenceResult<readonly ReferenceResourceView[]>>;
|
||||||
|
createResource(
|
||||||
|
command: Readonly<{ name: string; note?: string }>,
|
||||||
|
): Promise<ReferenceResult<ReferenceResourceView>>;
|
||||||
|
getResource(
|
||||||
|
resourceId: string,
|
||||||
|
context?: Readonly<{ signal?: AbortSignal }>,
|
||||||
|
): Promise<ReferenceResult<ReferenceResourceView>>;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export type ReferenceGateway = Readonly<{
|
||||||
|
list(
|
||||||
|
filters: ReferenceListFilters,
|
||||||
|
context?: Readonly<{ signal?: AbortSignal }>,
|
||||||
|
): Promise<ReferenceResult<readonly ReferenceResource[]>>;
|
||||||
|
create(
|
||||||
|
command: Readonly<{ name: string; note?: string }>,
|
||||||
|
): Promise<ReferenceResult<ReferenceResource>>;
|
||||||
|
get(
|
||||||
|
resourceId: string,
|
||||||
|
context?: Readonly<{ signal?: AbortSignal }>,
|
||||||
|
): Promise<ReferenceResult<ReferenceResource>>;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export function createReferenceFeatureInput(
|
||||||
|
gateway: ReferenceGateway,
|
||||||
|
): ReferenceFeatureInput {
|
||||||
|
return Object.freeze({
|
||||||
|
async listResources(filters, context) {
|
||||||
|
const result = await gateway.list(filters, context);
|
||||||
|
return result.ok
|
||||||
|
? {
|
||||||
|
ok: true as const,
|
||||||
|
value: result.value.map((resource) => toReferenceView(resource)),
|
||||||
|
}
|
||||||
|
: result;
|
||||||
|
},
|
||||||
|
async createResource(command) {
|
||||||
|
const result = await gateway.create(command);
|
||||||
|
return result.ok
|
||||||
|
? { ok: true as const, value: toReferenceView(result.value) }
|
||||||
|
: result;
|
||||||
|
},
|
||||||
|
async getResource(resourceId, context) {
|
||||||
|
const result = await gateway.get(resourceId, context);
|
||||||
|
return result.ok
|
||||||
|
? { ok: true as const, value: toReferenceView(result.value) }
|
||||||
|
: result;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
}
|
||||||
@@ -0,0 +1,148 @@
|
|||||||
|
import { canonicalize } from "../../../contracts/query-keys.js";
|
||||||
|
|
||||||
|
export const REFERENCE_FEATURE_ID = "reference-feature";
|
||||||
|
const REFERENCE_NAMESPACE = Object.freeze(["reference-resource", 1]);
|
||||||
|
|
||||||
|
export const referenceQueryKeys = Object.freeze({
|
||||||
|
all: () => REFERENCE_NAMESPACE,
|
||||||
|
list: (filters = {}) =>
|
||||||
|
Object.freeze([...REFERENCE_NAMESPACE, "list", canonicalize(filters)]),
|
||||||
|
/** @param {string} resourceId */
|
||||||
|
detail: (resourceId) =>
|
||||||
|
Object.freeze([...REFERENCE_NAMESPACE, "detail", String(resourceId)]),
|
||||||
|
});
|
||||||
|
|
||||||
|
export const REFERENCE_FEATURE_CONTRACT = Object.freeze({
|
||||||
|
featureId: REFERENCE_FEATURE_ID,
|
||||||
|
routes: Object.freeze({
|
||||||
|
REFERENCE_RESOURCE_LIST: Object.freeze({
|
||||||
|
routeId: "REFERENCE_RESOURCE_LIST",
|
||||||
|
path: "/examples/reference-resources",
|
||||||
|
paramsSchema: null,
|
||||||
|
searchSchema: "ReferenceResourceListQuery",
|
||||||
|
access: "integration-defined",
|
||||||
|
loadingSurface: "reference-resource-list",
|
||||||
|
errorSurface: "feature-boundary",
|
||||||
|
chunkId: "route-reference-resources",
|
||||||
|
title: "Reference feature",
|
||||||
|
navigationLabel: "Reference feature",
|
||||||
|
navigationOrder: 50,
|
||||||
|
}),
|
||||||
|
REFERENCE_RESOURCE_DETAIL: Object.freeze({
|
||||||
|
routeId: "REFERENCE_RESOURCE_DETAIL",
|
||||||
|
path: "/examples/reference-resources/:resourceId",
|
||||||
|
paramsSchema: "ReferenceResourceParams",
|
||||||
|
searchSchema: null,
|
||||||
|
access: "integration-defined",
|
||||||
|
loadingSurface: "reference-resource-detail",
|
||||||
|
errorSurface: "feature-boundary",
|
||||||
|
chunkId: "route-reference-resource-detail",
|
||||||
|
title: "Reference detail",
|
||||||
|
navigationLabel: null,
|
||||||
|
navigationOrder: null,
|
||||||
|
}),
|
||||||
|
REFERENCE_RESOURCE_FORM: Object.freeze({
|
||||||
|
routeId: "REFERENCE_RESOURCE_FORM",
|
||||||
|
path: "/examples/reference-resources/new",
|
||||||
|
paramsSchema: null,
|
||||||
|
searchSchema: null,
|
||||||
|
access: "integration-defined",
|
||||||
|
loadingSurface: "reference-resource-form",
|
||||||
|
errorSurface: "feature-boundary",
|
||||||
|
chunkId: "route-reference-resource-form",
|
||||||
|
title: "Reference form",
|
||||||
|
navigationLabel: null,
|
||||||
|
navigationOrder: null,
|
||||||
|
}),
|
||||||
|
REFERENCE_RESOURCE_STATUS: Object.freeze({
|
||||||
|
routeId: "REFERENCE_RESOURCE_STATUS",
|
||||||
|
path: "/examples/reference-resources/status",
|
||||||
|
paramsSchema: null,
|
||||||
|
searchSchema: null,
|
||||||
|
access: "integration-defined",
|
||||||
|
loadingSurface: "reference-resource-status",
|
||||||
|
errorSurface: "feature-boundary",
|
||||||
|
chunkId: "route-reference-resource-status",
|
||||||
|
title: "Reference status",
|
||||||
|
navigationLabel: null,
|
||||||
|
navigationOrder: null,
|
||||||
|
}),
|
||||||
|
}),
|
||||||
|
routeRuntimeContracts: Object.freeze({
|
||||||
|
REFERENCE_RESOURCE_LIST: Object.freeze({
|
||||||
|
routeId: "REFERENCE_RESOURCE_LIST",
|
||||||
|
moduleId: "reference-resource-page",
|
||||||
|
paramsCodec: "none",
|
||||||
|
searchCodec: "ReferenceResourceListQuery",
|
||||||
|
}),
|
||||||
|
REFERENCE_RESOURCE_DETAIL: Object.freeze({
|
||||||
|
routeId: "REFERENCE_RESOURCE_DETAIL",
|
||||||
|
moduleId: "reference-resource-detail-page",
|
||||||
|
paramsCodec: "ReferenceResourceParams",
|
||||||
|
searchCodec: "none",
|
||||||
|
}),
|
||||||
|
REFERENCE_RESOURCE_FORM: Object.freeze({
|
||||||
|
routeId: "REFERENCE_RESOURCE_FORM",
|
||||||
|
moduleId: "reference-resource-form-page",
|
||||||
|
paramsCodec: "none",
|
||||||
|
searchCodec: "none",
|
||||||
|
}),
|
||||||
|
REFERENCE_RESOURCE_STATUS: Object.freeze({
|
||||||
|
routeId: "REFERENCE_RESOURCE_STATUS",
|
||||||
|
moduleId: "reference-resource-status-page",
|
||||||
|
paramsCodec: "none",
|
||||||
|
searchCodec: "none",
|
||||||
|
}),
|
||||||
|
}),
|
||||||
|
apiOperations: Object.freeze({
|
||||||
|
LIST_REFERENCE_RESOURCES: Object.freeze({
|
||||||
|
method: "GET",
|
||||||
|
path: "/api/reference-resources",
|
||||||
|
operationId: "LIST_REFERENCE_RESOURCES",
|
||||||
|
auth: "external-session",
|
||||||
|
timeoutMs: null,
|
||||||
|
idempotency: "safe",
|
||||||
|
retry: "runtime",
|
||||||
|
requestSource: "search",
|
||||||
|
requestSchema: "ReferenceResourceListQuery",
|
||||||
|
responseSchema: "ReferenceResourceListPayload",
|
||||||
|
owner: "feature-frontend-reference-feature-vertical-slice",
|
||||||
|
}),
|
||||||
|
CREATE_REFERENCE_RESOURCE: Object.freeze({
|
||||||
|
method: "POST",
|
||||||
|
path: "/api/reference-resources",
|
||||||
|
operationId: "CREATE_REFERENCE_RESOURCE",
|
||||||
|
auth: "external-session",
|
||||||
|
timeoutMs: null,
|
||||||
|
idempotency: "keyed",
|
||||||
|
retry: "runtime",
|
||||||
|
requestSource: "body",
|
||||||
|
requestSchema: "CreateReferenceResourceCommand",
|
||||||
|
responseSchema: "ReferenceResourcePayload",
|
||||||
|
owner: "feature-frontend-reference-feature-vertical-slice",
|
||||||
|
}),
|
||||||
|
GET_REFERENCE_RESOURCE: Object.freeze({
|
||||||
|
method: "GET",
|
||||||
|
path: "/api/reference-resources/{resourceId}",
|
||||||
|
operationId: "GET_REFERENCE_RESOURCE",
|
||||||
|
auth: "external-session",
|
||||||
|
timeoutMs: null,
|
||||||
|
idempotency: "safe",
|
||||||
|
retry: "runtime",
|
||||||
|
requestSource: "none",
|
||||||
|
requestSchema: "NoRequest",
|
||||||
|
responseSchema: "ReferenceResourcePayload",
|
||||||
|
owner: "feature-frontend-form-page-platform",
|
||||||
|
}),
|
||||||
|
}),
|
||||||
|
queryRegistry: Object.freeze({
|
||||||
|
REFERENCE_RESOURCE: Object.freeze({
|
||||||
|
namespace: REFERENCE_NAMESPACE,
|
||||||
|
serialization: "canonical-object-order",
|
||||||
|
identity: "no-pii-token-or-raw-url",
|
||||||
|
invalidation: "reference resource namespace after successful mutation",
|
||||||
|
version: 1,
|
||||||
|
persistence: "disabled",
|
||||||
|
}),
|
||||||
|
}),
|
||||||
|
});
|
||||||
@@ -0,0 +1,57 @@
|
|||||||
|
import {
|
||||||
|
createReferenceResource,
|
||||||
|
type ReferenceResource,
|
||||||
|
} from "../domain/reference-resource.js";
|
||||||
|
|
||||||
|
export type ReferenceResourceView = Readonly<{
|
||||||
|
resourceId: string;
|
||||||
|
title: string;
|
||||||
|
createdAtLabel: string | null;
|
||||||
|
optimistic?: boolean;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
function mapReferenceDto(value: unknown): ReferenceResource {
|
||||||
|
if (!value || typeof value !== "object") {
|
||||||
|
throw new TypeError("Validated reference DTO is required");
|
||||||
|
}
|
||||||
|
const dto = value as Record<string, unknown>;
|
||||||
|
if (typeof dto.id !== "string" || typeof dto.name !== "string") {
|
||||||
|
throw new TypeError("Validated reference DTO invariants were breached");
|
||||||
|
}
|
||||||
|
return createReferenceResource({
|
||||||
|
id: dto.id,
|
||||||
|
displayName: dto.name,
|
||||||
|
createdAt: typeof dto.createdAt === "string" ? dto.createdAt : null,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
export function mapReferenceOperation(
|
||||||
|
operationId: string,
|
||||||
|
payload: unknown,
|
||||||
|
): ReferenceResource | readonly ReferenceResource[] {
|
||||||
|
if (operationId === "LIST_REFERENCE_RESOURCES") {
|
||||||
|
if (!Array.isArray(payload)) throw new TypeError("Expected a reference list");
|
||||||
|
return payload.map(mapReferenceDto);
|
||||||
|
}
|
||||||
|
if (
|
||||||
|
operationId === "CREATE_REFERENCE_RESOURCE" ||
|
||||||
|
operationId === "GET_REFERENCE_RESOURCE"
|
||||||
|
) {
|
||||||
|
return mapReferenceDto(payload);
|
||||||
|
}
|
||||||
|
throw new TypeError(`No reference mapper registered for ${operationId}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function toReferenceView(
|
||||||
|
resource: ReferenceResource,
|
||||||
|
formatDate: (value: Date) => string = (value) =>
|
||||||
|
new Intl.DateTimeFormat("ko-KR").format(value),
|
||||||
|
): ReferenceResourceView {
|
||||||
|
return Object.freeze({
|
||||||
|
resourceId: resource.id,
|
||||||
|
title: resource.displayName,
|
||||||
|
createdAtLabel: resource.createdAt
|
||||||
|
? formatDate(new Date(resource.createdAt))
|
||||||
|
: null,
|
||||||
|
});
|
||||||
|
}
|
||||||
@@ -0,0 +1,74 @@
|
|||||||
|
import { z } from "zod";
|
||||||
|
|
||||||
|
export const referenceResourceListQuerySchema = z
|
||||||
|
.object({
|
||||||
|
cursor: z.string().min(1).optional(),
|
||||||
|
limit: z.coerce.number().int().min(1).max(100).default(20),
|
||||||
|
tags: z
|
||||||
|
.preprocess(
|
||||||
|
(value) =>
|
||||||
|
value === undefined
|
||||||
|
? undefined
|
||||||
|
: Array.isArray(value)
|
||||||
|
? value
|
||||||
|
: [value],
|
||||||
|
z.array(z.string().trim().min(1)),
|
||||||
|
)
|
||||||
|
.optional(),
|
||||||
|
})
|
||||||
|
.strict();
|
||||||
|
|
||||||
|
export const referenceResourceParamsSchema = z
|
||||||
|
.object({
|
||||||
|
resourceId: z.string().trim().min(1).max(120),
|
||||||
|
})
|
||||||
|
.strict();
|
||||||
|
|
||||||
|
const referenceResourceDtoSchema = z
|
||||||
|
.object({
|
||||||
|
id: z.string().min(1),
|
||||||
|
name: z.string().min(1),
|
||||||
|
createdAt: z.string().datetime().optional(),
|
||||||
|
})
|
||||||
|
.strict();
|
||||||
|
|
||||||
|
const payloadSchemas = {
|
||||||
|
ReferenceResourceListPayload: z.array(referenceResourceDtoSchema),
|
||||||
|
ReferenceResourcePayload: referenceResourceDtoSchema,
|
||||||
|
} satisfies Record<string, z.ZodType>;
|
||||||
|
|
||||||
|
const requestSchemas = {
|
||||||
|
ReferenceResourceListQuery: referenceResourceListQuerySchema,
|
||||||
|
CreateReferenceResourceCommand: z
|
||||||
|
.object({
|
||||||
|
name: z.string().trim().min(1).max(120),
|
||||||
|
note: z.string().trim().max(500).optional(),
|
||||||
|
})
|
||||||
|
.strict(),
|
||||||
|
} satisfies Record<string, z.ZodType>;
|
||||||
|
|
||||||
|
function project(result: z.ZodSafeParseResult<unknown>) {
|
||||||
|
return result.success
|
||||||
|
? ({ success: true as const, data: structuredClone(result.data) })
|
||||||
|
: ({
|
||||||
|
success: false as const,
|
||||||
|
issues: result.error.issues.map((issue) => ({
|
||||||
|
path: issue.path.join("."),
|
||||||
|
code: issue.code,
|
||||||
|
})),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
export function validateReferencePayload(schemaId: string, value: unknown) {
|
||||||
|
const schema = payloadSchemas[schemaId as keyof typeof payloadSchemas];
|
||||||
|
return schema
|
||||||
|
? project(schema.safeParse(value))
|
||||||
|
: { success: false as const, issues: [{ path: "", code: "SCHEMA_NOT_REGISTERED" }] };
|
||||||
|
}
|
||||||
|
|
||||||
|
export function validateReferenceRequest(schemaId: string, value: unknown) {
|
||||||
|
const schema = requestSchemas[schemaId as keyof typeof requestSchemas];
|
||||||
|
return schema
|
||||||
|
? project(schema.safeParse(value))
|
||||||
|
: { success: false as const, issues: [{ path: "", code: "SCHEMA_NOT_REGISTERED" }] };
|
||||||
|
}
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
export type ReferenceResource = Readonly<{
|
||||||
|
id: string;
|
||||||
|
displayName: string;
|
||||||
|
createdAt: string | null;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export function createReferenceResource(
|
||||||
|
values: ReferenceResource,
|
||||||
|
): ReferenceResource {
|
||||||
|
if (!values.id || !values.displayName) {
|
||||||
|
throw new TypeError("Reference resource invariants require id and displayName");
|
||||||
|
}
|
||||||
|
return Object.freeze({ ...values });
|
||||||
|
}
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
import { lazy } from "react";
|
||||||
|
|
||||||
|
import {
|
||||||
|
referenceResourceListQuerySchema,
|
||||||
|
referenceResourceParamsSchema,
|
||||||
|
} from "../contracts/reference-schemas.js";
|
||||||
|
|
||||||
|
export const REFERENCE_FEATURE_ROUTE_CODECS = {
|
||||||
|
ReferenceResourceListQuery: referenceResourceListQuerySchema,
|
||||||
|
ReferenceResourceParams: referenceResourceParamsSchema,
|
||||||
|
} as const;
|
||||||
|
|
||||||
|
export const REFERENCE_FEATURE_ROUTE_RUNTIME = {
|
||||||
|
REFERENCE_RESOURCE_LIST: Object.freeze({
|
||||||
|
moduleId: "reference-resource-page",
|
||||||
|
Component: lazy(() => import("./reference-resource-page.js")),
|
||||||
|
}),
|
||||||
|
REFERENCE_RESOURCE_DETAIL: Object.freeze({
|
||||||
|
moduleId: "reference-resource-detail-page",
|
||||||
|
Component: lazy(() => import("./reference-resource-detail-page.js")),
|
||||||
|
}),
|
||||||
|
REFERENCE_RESOURCE_FORM: Object.freeze({
|
||||||
|
moduleId: "reference-resource-form-page",
|
||||||
|
Component: lazy(() => import("./reference-resource-form-page.js")),
|
||||||
|
}),
|
||||||
|
REFERENCE_RESOURCE_STATUS: Object.freeze({
|
||||||
|
moduleId: "reference-resource-status-page",
|
||||||
|
Component: lazy(() => import("./reference-resource-status-page.js")),
|
||||||
|
}),
|
||||||
|
} as const;
|
||||||
@@ -0,0 +1,49 @@
|
|||||||
|
import { Link } from "react-router-dom";
|
||||||
|
|
||||||
|
import {
|
||||||
|
AsyncSurface,
|
||||||
|
DetailPage,
|
||||||
|
} from "../../../presentation/design-system/index.js";
|
||||||
|
import { useRouteInput } from "../../../presentation/routes/app-router.js";
|
||||||
|
import { useReferenceDetail } from "./use-reference-feature.js";
|
||||||
|
|
||||||
|
export default function ReferenceResourceDetailPage() {
|
||||||
|
const route = useRouteInput();
|
||||||
|
const resourceId = String(route.params.resourceId);
|
||||||
|
const { query } = useReferenceDetail(resourceId);
|
||||||
|
const resource = query.data;
|
||||||
|
|
||||||
|
return (
|
||||||
|
<DetailPage
|
||||||
|
key={resourceId}
|
||||||
|
breadcrumb={
|
||||||
|
<Link to="/examples/reference-resources">Reference resources</Link>
|
||||||
|
}
|
||||||
|
heading={{
|
||||||
|
eyebrow: "DetailPage",
|
||||||
|
title: resource?.title ?? "Reference detail",
|
||||||
|
description: "route param과 detail query의 reset 경계를 확인합니다.",
|
||||||
|
}}
|
||||||
|
metadata={
|
||||||
|
resource ? (
|
||||||
|
<dl>
|
||||||
|
<dt>Resource ID</dt>
|
||||||
|
<dd>{resource.resourceId}</dd>
|
||||||
|
<dt>Created</dt>
|
||||||
|
<dd>{resource.createdAtLabel ?? "표시 정보 없음"}</dd>
|
||||||
|
</dl>
|
||||||
|
) : (
|
||||||
|
<p>요약 정보를 준비하고 있습니다.</p>
|
||||||
|
)
|
||||||
|
}
|
||||||
|
feedback={
|
||||||
|
<AsyncSurface state={query.state} onRetry={query.retry}>
|
||||||
|
{resource ? (
|
||||||
|
<p>이 영역에는 제품별 상세 section을 조립할 수 있습니다.</p>
|
||||||
|
) : null}
|
||||||
|
</AsyncSurface>
|
||||||
|
}
|
||||||
|
aside={<p>상세 페이지의 관련 정보 slot입니다.</p>}
|
||||||
|
/>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,131 @@
|
|||||||
|
import { useCallback } from "react";
|
||||||
|
import { useNavigate } from "react-router-dom";
|
||||||
|
|
||||||
|
import {
|
||||||
|
Button,
|
||||||
|
DirtyNavigationDialog,
|
||||||
|
ErrorSummary,
|
||||||
|
Form,
|
||||||
|
FormActions,
|
||||||
|
FormPage,
|
||||||
|
FormField,
|
||||||
|
useAppForm,
|
||||||
|
useDirtyNavigationGuard,
|
||||||
|
} from "../../../presentation/design-system/index.js";
|
||||||
|
import {
|
||||||
|
REFERENCE_FORM_DEFAULTS,
|
||||||
|
referenceResourceFormSchema,
|
||||||
|
toCreateReferenceCommand,
|
||||||
|
type ReferenceResourceFormValues,
|
||||||
|
} from "./reference-resource-form.js";
|
||||||
|
import { useReferenceCreate } from "./use-reference-feature.js";
|
||||||
|
|
||||||
|
const FIELD_LABELS = Object.freeze({
|
||||||
|
name: "새 항목 이름",
|
||||||
|
note: "설명",
|
||||||
|
}) satisfies Record<keyof ReferenceResourceFormValues, string>;
|
||||||
|
|
||||||
|
export default function ReferenceResourceFormPage() {
|
||||||
|
const navigate = useNavigate();
|
||||||
|
const mutation = useReferenceCreate();
|
||||||
|
const submit = useCallback(
|
||||||
|
(command: ReturnType<typeof toCreateReferenceCommand>) =>
|
||||||
|
mutation.submit(command),
|
||||||
|
[mutation],
|
||||||
|
);
|
||||||
|
const form = useAppForm({
|
||||||
|
schema: referenceResourceFormSchema,
|
||||||
|
defaultValues: REFERENCE_FORM_DEFAULTS,
|
||||||
|
allowedServerFields: ["name", "note"],
|
||||||
|
mapToCommand: toCreateReferenceCommand,
|
||||||
|
submit,
|
||||||
|
});
|
||||||
|
const guard = useDirtyNavigationGuard(form.dirty && !form.pending);
|
||||||
|
|
||||||
|
return (
|
||||||
|
<Form
|
||||||
|
id={form.formId}
|
||||||
|
pending={form.pending}
|
||||||
|
onSubmit={(event) => void form.submitForm(event)}
|
||||||
|
>
|
||||||
|
<FormPage
|
||||||
|
breadcrumb={
|
||||||
|
<button
|
||||||
|
className="ui-button ui-button--ghost"
|
||||||
|
type="button"
|
||||||
|
onClick={() => navigate("/examples/reference-resources")}
|
||||||
|
>
|
||||||
|
목록으로 돌아가기
|
||||||
|
</button>
|
||||||
|
}
|
||||||
|
heading={{
|
||||||
|
eyebrow: "FormPage",
|
||||||
|
title: "Reference resource 만들기",
|
||||||
|
description:
|
||||||
|
"presentation schema, command mapper, 422/conflict와 dirty navigation 정책을 실행합니다.",
|
||||||
|
}}
|
||||||
|
errorSummary={
|
||||||
|
<ErrorSummary
|
||||||
|
fieldErrors={form.fieldErrors}
|
||||||
|
formErrors={form.formErrors}
|
||||||
|
fieldLabels={FIELD_LABELS}
|
||||||
|
fieldId={form.fieldId}
|
||||||
|
onFocusField={form.focusField}
|
||||||
|
/>
|
||||||
|
}
|
||||||
|
fields={
|
||||||
|
<>
|
||||||
|
<FormField
|
||||||
|
{...form.field("name")}
|
||||||
|
label={FIELD_LABELS.name}
|
||||||
|
description="앞뒤 공백은 command mapper 전에 제거됩니다."
|
||||||
|
autoComplete="off"
|
||||||
|
required
|
||||||
|
/>
|
||||||
|
<FormField
|
||||||
|
{...form.field("note")}
|
||||||
|
label={FIELD_LABELS.note}
|
||||||
|
description="선택 입력이며 비어 있으면 command에 포함되지 않습니다."
|
||||||
|
autoComplete="off"
|
||||||
|
/>
|
||||||
|
</>
|
||||||
|
}
|
||||||
|
formActions={
|
||||||
|
<FormActions sticky>
|
||||||
|
<Button
|
||||||
|
variant="secondary"
|
||||||
|
onClick={() => navigate("/examples/reference-resources")}
|
||||||
|
disabled={form.pending}
|
||||||
|
>
|
||||||
|
취소
|
||||||
|
</Button>
|
||||||
|
<Button type="submit" disabled={form.pending}>
|
||||||
|
{form.pending ? "저장 중…" : "저장"}
|
||||||
|
</Button>
|
||||||
|
<Button
|
||||||
|
variant="ghost"
|
||||||
|
onClick={() => form.reset()}
|
||||||
|
disabled={!form.dirty || form.pending}
|
||||||
|
>
|
||||||
|
초기화
|
||||||
|
</Button>
|
||||||
|
</FormActions>
|
||||||
|
}
|
||||||
|
feedback={
|
||||||
|
form.result === "success" ? (
|
||||||
|
<p role="status">저장했습니다.</p>
|
||||||
|
) : form.result === "conflict" ? (
|
||||||
|
<p role="status">충돌을 해결한 뒤 다시 제출할 수 있습니다.</p>
|
||||||
|
) : null
|
||||||
|
}
|
||||||
|
aside={
|
||||||
|
<p>
|
||||||
|
form value는 URL, storage, telemetry에 저장되지 않고 submit 시에만
|
||||||
|
application command로 변환됩니다.
|
||||||
|
</p>
|
||||||
|
}
|
||||||
|
guard={<DirtyNavigationDialog guard={guard} />}
|
||||||
|
/>
|
||||||
|
</Form>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,29 @@
|
|||||||
|
import { z } from "zod";
|
||||||
|
|
||||||
|
export const referenceResourceFormSchema = z
|
||||||
|
.object({
|
||||||
|
name: z
|
||||||
|
.string()
|
||||||
|
.trim()
|
||||||
|
.min(2, "이름은 두 글자 이상이어야 합니다.")
|
||||||
|
.max(120),
|
||||||
|
note: z.string().trim().max(500).default(""),
|
||||||
|
})
|
||||||
|
.strict();
|
||||||
|
|
||||||
|
export type ReferenceResourceFormValues = z.infer<
|
||||||
|
typeof referenceResourceFormSchema
|
||||||
|
>;
|
||||||
|
|
||||||
|
export const REFERENCE_FORM_DEFAULTS: ReferenceResourceFormValues =
|
||||||
|
Object.freeze({
|
||||||
|
name: "",
|
||||||
|
note: "",
|
||||||
|
});
|
||||||
|
|
||||||
|
export function toCreateReferenceCommand(values: ReferenceResourceFormValues) {
|
||||||
|
return Object.freeze({
|
||||||
|
name: values.name,
|
||||||
|
...(values.note ? { note: values.note } : {}),
|
||||||
|
});
|
||||||
|
}
|
||||||
@@ -0,0 +1,55 @@
|
|||||||
|
import { Link, useNavigate } from "react-router-dom";
|
||||||
|
|
||||||
|
import {
|
||||||
|
AsyncSurface,
|
||||||
|
Button,
|
||||||
|
CollectionPage,
|
||||||
|
} from "../../../presentation/design-system/index.js";
|
||||||
|
import { useReferenceFeature } from "./use-reference-feature.js";
|
||||||
|
|
||||||
|
export default function ReferenceResourcePage() {
|
||||||
|
const navigate = useNavigate();
|
||||||
|
const { filters, query } = useReferenceFeature();
|
||||||
|
|
||||||
|
return (
|
||||||
|
<CollectionPage
|
||||||
|
heading={{
|
||||||
|
eyebrow: "제거 가능한 수직 슬라이스",
|
||||||
|
title: "Reference feature",
|
||||||
|
description:
|
||||||
|
"URL codec, application input, HTTP/schema/mapper와 query 상태를 한 경로로 검증합니다.",
|
||||||
|
}}
|
||||||
|
actions={[
|
||||||
|
{
|
||||||
|
kind: "button",
|
||||||
|
label: "새 항목 만들기",
|
||||||
|
onAction: () => navigate("/examples/reference-resources/new"),
|
||||||
|
},
|
||||||
|
]}
|
||||||
|
activeFilters={
|
||||||
|
<p data-testid="reference-filter">
|
||||||
|
limit {filters.limit}
|
||||||
|
{filters.tags?.length ? ` · tags ${filters.tags.join(", ")}` : ""}
|
||||||
|
</p>
|
||||||
|
}
|
||||||
|
toolbar={<Button onClick={() => void query.retry()}>새로고침</Button>}
|
||||||
|
resultCount={
|
||||||
|
query.data ? `총 ${query.data.length}개 항목` : "결과 확인 중"
|
||||||
|
}
|
||||||
|
>
|
||||||
|
<AsyncSurface state={query.state} onRetry={query.retry}>
|
||||||
|
<ul aria-label="Reference resources">
|
||||||
|
{(query.data ?? []).map((resource) => (
|
||||||
|
<li key={resource.resourceId}>
|
||||||
|
<Link
|
||||||
|
to={`/examples/reference-resources/${encodeURIComponent(resource.resourceId)}`}
|
||||||
|
>
|
||||||
|
{resource.title}
|
||||||
|
</Link>
|
||||||
|
</li>
|
||||||
|
))}
|
||||||
|
</ul>
|
||||||
|
</AsyncSurface>
|
||||||
|
</CollectionPage>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
import { useNavigate } from "react-router-dom";
|
||||||
|
|
||||||
|
import { StatusPage } from "../../../presentation/design-system/index.js";
|
||||||
|
|
||||||
|
export default function ReferenceResourceStatusPage() {
|
||||||
|
const navigate = useNavigate();
|
||||||
|
|
||||||
|
return (
|
||||||
|
<StatusPage
|
||||||
|
variant="maintenance"
|
||||||
|
heading={{
|
||||||
|
eyebrow: "StatusPage · maintenance",
|
||||||
|
title: "잠시 사용할 수 없습니다.",
|
||||||
|
description:
|
||||||
|
"도메인 데이터나 raw 오류를 노출하지 않는 중립적인 상태 페이지 예시입니다.",
|
||||||
|
}}
|
||||||
|
primaryAction={{
|
||||||
|
kind: "button",
|
||||||
|
label: "목록으로 이동",
|
||||||
|
onAction: () => navigate("/examples/reference-resources"),
|
||||||
|
}}
|
||||||
|
supportReference="REFERENCE-STATUS-DEMO"
|
||||||
|
/>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,81 @@
|
|||||||
|
import { useApplication } from "../../../presentation/providers/application-provider.js";
|
||||||
|
import {
|
||||||
|
useApplicationMutation,
|
||||||
|
useApplicationQuery,
|
||||||
|
} from "../../../presentation/adapters/query/application-query.js";
|
||||||
|
import { useRouteInput } from "../../../presentation/routes/app-router.js";
|
||||||
|
import type { ReferenceResourceView } from "../contracts/reference-mapper.js";
|
||||||
|
import {
|
||||||
|
REFERENCE_FEATURE_ID,
|
||||||
|
referenceQueryKeys,
|
||||||
|
} from "../contracts/reference-feature-contract.js";
|
||||||
|
import type {
|
||||||
|
ReferenceFeatureInput,
|
||||||
|
ReferenceListFilters,
|
||||||
|
} from "../application/reference-feature-api.js";
|
||||||
|
|
||||||
|
export function useReferenceFeatureInput(): ReferenceFeatureInput {
|
||||||
|
const candidate = useApplication().features.get(REFERENCE_FEATURE_ID);
|
||||||
|
if (
|
||||||
|
!candidate ||
|
||||||
|
typeof candidate !== "object" ||
|
||||||
|
typeof (candidate as ReferenceFeatureInput).listResources !== "function" ||
|
||||||
|
typeof (candidate as ReferenceFeatureInput).createResource !== "function" ||
|
||||||
|
typeof (candidate as ReferenceFeatureInput).getResource !== "function"
|
||||||
|
) {
|
||||||
|
throw new Error("Reference feature application input is invalid");
|
||||||
|
}
|
||||||
|
return candidate as ReferenceFeatureInput;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function useReferenceDetail(resourceId: string) {
|
||||||
|
const input = useReferenceFeatureInput();
|
||||||
|
const query = useApplicationQuery({
|
||||||
|
queryKey: referenceQueryKeys.detail(resourceId),
|
||||||
|
execute: ({ signal }) => input.getResource(resourceId, { signal }),
|
||||||
|
});
|
||||||
|
return Object.freeze({ query });
|
||||||
|
}
|
||||||
|
|
||||||
|
export function useReferenceCreate() {
|
||||||
|
const input = useReferenceFeatureInput();
|
||||||
|
return useApplicationMutation({
|
||||||
|
execute: input.createResource,
|
||||||
|
invalidate: [referenceQueryKeys.all()],
|
||||||
|
currentData: true,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
export function useReferenceFeature() {
|
||||||
|
const input = useReferenceFeatureInput();
|
||||||
|
const routeInput = useRouteInput();
|
||||||
|
const filters = routeInput.search as ReferenceListFilters;
|
||||||
|
const queryKey = referenceQueryKeys.list(filters);
|
||||||
|
const query = useApplicationQuery({
|
||||||
|
queryKey,
|
||||||
|
execute: ({ signal }) => input.listResources(filters, { signal }),
|
||||||
|
});
|
||||||
|
const mutation = useApplicationMutation({
|
||||||
|
execute: input.createResource,
|
||||||
|
invalidate: [referenceQueryKeys.all()],
|
||||||
|
currentData: true,
|
||||||
|
optimistic: {
|
||||||
|
queryKey,
|
||||||
|
update(previous, command: Readonly<{ name: string }>) {
|
||||||
|
const current = Array.isArray(previous)
|
||||||
|
? (previous as readonly ReferenceResourceView[])
|
||||||
|
: [];
|
||||||
|
return [
|
||||||
|
...current,
|
||||||
|
{
|
||||||
|
resourceId: `optimistic:${command.name}`,
|
||||||
|
title: command.name,
|
||||||
|
createdAtLabel: null,
|
||||||
|
optimistic: true,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
return Object.freeze({ filters, query, mutation });
|
||||||
|
}
|
||||||
@@ -0,0 +1,97 @@
|
|||||||
|
import {
|
||||||
|
Component,
|
||||||
|
type ErrorInfo,
|
||||||
|
type ReactNode,
|
||||||
|
} from "react";
|
||||||
|
|
||||||
|
type RecoveryResult =
|
||||||
|
| Readonly<{ action: "reload-once"; releasePair: string }>
|
||||||
|
| Readonly<{ action: "support"; reason: string }>;
|
||||||
|
|
||||||
|
type Props = Readonly<{
|
||||||
|
children: ReactNode;
|
||||||
|
chunkId: string;
|
||||||
|
recover(input: Readonly<{
|
||||||
|
chunkId: string;
|
||||||
|
failureKind: "CHUNK_LOAD_FAILURE";
|
||||||
|
}>): Promise<RecoveryResult>;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
type State = Readonly<{
|
||||||
|
error: unknown | null;
|
||||||
|
recovery: "idle" | "checking" | "reload-requested" | "support";
|
||||||
|
reason?: string;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export function isChunkLoadFailure(error: unknown): boolean {
|
||||||
|
if (!(error instanceof Error)) return false;
|
||||||
|
const value = `${error.name} ${error.message}`.toLowerCase();
|
||||||
|
return (
|
||||||
|
value.includes("chunkloaderror") ||
|
||||||
|
value.includes("loading chunk") ||
|
||||||
|
value.includes("dynamically imported module") ||
|
||||||
|
value.includes("failed to fetch module script")
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export class ChunkRecoveryBoundary extends Component<Props, State> {
|
||||||
|
state: State = { error: null, recovery: "idle" };
|
||||||
|
|
||||||
|
static getDerivedStateFromError(error: unknown): State {
|
||||||
|
return { error, recovery: "checking" };
|
||||||
|
}
|
||||||
|
|
||||||
|
componentDidCatch(error: unknown, _info: ErrorInfo) {
|
||||||
|
if (!isChunkLoadFailure(error)) return;
|
||||||
|
void this.props
|
||||||
|
.recover({
|
||||||
|
chunkId: this.props.chunkId,
|
||||||
|
failureKind: "CHUNK_LOAD_FAILURE",
|
||||||
|
})
|
||||||
|
.then((result) => {
|
||||||
|
this.setState({
|
||||||
|
error,
|
||||||
|
recovery:
|
||||||
|
result.action === "reload-once"
|
||||||
|
? "reload-requested"
|
||||||
|
: "support",
|
||||||
|
...(result.action === "support" ? { reason: result.reason } : {}),
|
||||||
|
});
|
||||||
|
})
|
||||||
|
.catch(() => {
|
||||||
|
this.setState({
|
||||||
|
error,
|
||||||
|
recovery: "support",
|
||||||
|
reason: "recovery-controller-failed",
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
render() {
|
||||||
|
const { error, recovery, reason } = this.state;
|
||||||
|
if (error && !isChunkLoadFailure(error)) throw error;
|
||||||
|
if (error && recovery === "checking") {
|
||||||
|
return (
|
||||||
|
<section className="ui-page" aria-live="polite" aria-busy="true">
|
||||||
|
새 릴리스 정보를 확인하고 있습니다.
|
||||||
|
</section>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (error && recovery === "reload-requested") {
|
||||||
|
return (
|
||||||
|
<section className="ui-page" aria-live="polite">
|
||||||
|
새 버전으로 한 번만 전환합니다.
|
||||||
|
</section>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (error && recovery === "support") {
|
||||||
|
return (
|
||||||
|
<section className="ui-page" role="alert" data-recovery-reason={reason}>
|
||||||
|
<h1>화면 자산을 복구하지 못했습니다.</h1>
|
||||||
|
<p>문제가 계속되면 배포 상태와 지원 참조 정보를 확인해 주세요.</p>
|
||||||
|
</section>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return this.props.children;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -6,6 +6,7 @@ import { Component } from "react";
|
|||||||
* boundaryName: string,
|
* boundaryName: string,
|
||||||
* routeId: string,
|
* routeId: string,
|
||||||
* buildId: string,
|
* buildId: string,
|
||||||
|
* resetKey?: string,
|
||||||
* onRenderFailure?: (report: import("../../application/ports/in/application-api.js").RenderFailureReport) => void,
|
* onRenderFailure?: (report: import("../../application/ports/in/application-api.js").RenderFailureReport) => void,
|
||||||
* fallback?: React.ReactNode
|
* fallback?: React.ReactNode
|
||||||
* }} RenderBoundaryProps
|
* }} RenderBoundaryProps
|
||||||
@@ -37,6 +38,16 @@ export class RenderErrorBoundary extends Component {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** @param {RenderBoundaryProps} previous */
|
||||||
|
componentDidUpdate(previous) {
|
||||||
|
if (
|
||||||
|
this.state.hasError &&
|
||||||
|
previous.resetKey !== this.props.resetKey
|
||||||
|
) {
|
||||||
|
this.setState({ hasError: false });
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
reset = () => {
|
reset = () => {
|
||||||
this.setState({ hasError: false });
|
this.setState({ hasError: false });
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -8,6 +8,11 @@ const ERROR_MESSAGES = Object.freeze({
|
|||||||
"error.rate_limited": "요청이 많습니다. 잠시 후 다시 시도해 주세요.",
|
"error.rate_limited": "요청이 많습니다. 잠시 후 다시 시도해 주세요.",
|
||||||
"error.server_failure": "요청을 완료하지 못했습니다.",
|
"error.server_failure": "요청을 완료하지 못했습니다.",
|
||||||
"error.chunk_load_failure": "새 화면 파일을 불러오지 못했습니다.",
|
"error.chunk_load_failure": "새 화면 파일을 불러오지 못했습니다.",
|
||||||
|
"error.build_mismatch": "현재 화면과 활성 빌드가 일치하지 않습니다.",
|
||||||
|
"error.config_mismatch": "런타임 설정 버전이 현재 화면과 일치하지 않습니다.",
|
||||||
|
"error.api_contract_mismatch": "API 계약 버전이 현재 화면과 일치하지 않습니다.",
|
||||||
|
"error.release_mismatch": "현재 화면과 활성 릴리스가 일치하지 않습니다.",
|
||||||
|
"error.asset_mismatch": "화면 자산 구성이 현재 릴리스와 일치하지 않습니다.",
|
||||||
"error.render_failure": "화면을 표시하지 못했습니다.",
|
"error.render_failure": "화면을 표시하지 못했습니다.",
|
||||||
"error.unknown_failure": "예상하지 못한 문제가 발생했습니다.",
|
"error.unknown_failure": "예상하지 못한 문제가 발생했습니다.",
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -11,7 +11,6 @@ export function PageHeader({ title, description, eyebrow }) {
|
|||||||
const headingRef = useRef(/** @type {HTMLHeadingElement | null} */ (null));
|
const headingRef = useRef(/** @type {HTMLHeadingElement | null} */ (null));
|
||||||
|
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
document.title = `${title} · Frontend Skeleton`;
|
|
||||||
headingRef.current?.focus();
|
headingRef.current?.focus();
|
||||||
}, [title]);
|
}, [title]);
|
||||||
|
|
||||||
|
|||||||
@@ -1,36 +1 @@
|
|||||||
/**
|
export { Alert } from "../../design-system/primitives/core.js";
|
||||||
* @param {{
|
|
||||||
* title: string,
|
|
||||||
* children?: React.ReactNode,
|
|
||||||
* variant?: "info" | "success" | "warning" | "danger",
|
|
||||||
* onDismiss?: () => void
|
|
||||||
* }} props
|
|
||||||
*/
|
|
||||||
export function Alert({
|
|
||||||
title,
|
|
||||||
children,
|
|
||||||
variant = "info",
|
|
||||||
onDismiss,
|
|
||||||
}) {
|
|
||||||
return (
|
|
||||||
<section
|
|
||||||
className={`ui-alert ui-alert--${variant}`}
|
|
||||||
role={variant === "danger" ? "alert" : "status"}
|
|
||||||
>
|
|
||||||
<div>
|
|
||||||
<strong>{title}</strong>
|
|
||||||
{children ? <div className="ui-alert__content">{children}</div> : null}
|
|
||||||
</div>
|
|
||||||
{onDismiss ? (
|
|
||||||
<button
|
|
||||||
className="ui-alert__dismiss"
|
|
||||||
type="button"
|
|
||||||
aria-label={`${title} 알림 닫기`}
|
|
||||||
onClick={onDismiss}
|
|
||||||
>
|
|
||||||
×
|
|
||||||
</button>
|
|
||||||
) : null}
|
|
||||||
</section>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -1,9 +1 @@
|
|||||||
/**
|
export { Badge } from "../../design-system/primitives/core.js";
|
||||||
* @param {{
|
|
||||||
* children: React.ReactNode,
|
|
||||||
* variant?: "neutral" | "info" | "success" | "warning" | "danger"
|
|
||||||
* }} props
|
|
||||||
*/
|
|
||||||
export function Badge({ children, variant = "neutral" }) {
|
|
||||||
return <span className={`ui-badge ui-badge--${variant}`}>{children}</span>;
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -1,24 +1 @@
|
|||||||
/**
|
export { Button } from "../../design-system/primitives/core.js";
|
||||||
* @param {React.ButtonHTMLAttributes<HTMLButtonElement> & {
|
|
||||||
* variant?: "primary" | "secondary" | "danger" | "ghost",
|
|
||||||
* size?: "default" | "compact"
|
|
||||||
* }} props
|
|
||||||
*/
|
|
||||||
export function Button({
|
|
||||||
variant = "primary",
|
|
||||||
size = "default",
|
|
||||||
className = "",
|
|
||||||
type = "button",
|
|
||||||
...props
|
|
||||||
}) {
|
|
||||||
const classes = [
|
|
||||||
"ui-button",
|
|
||||||
`ui-button--${variant}`,
|
|
||||||
size === "compact" ? "ui-button--compact" : "",
|
|
||||||
className,
|
|
||||||
]
|
|
||||||
.filter(Boolean)
|
|
||||||
.join(" ");
|
|
||||||
|
|
||||||
return <button {...props} className={classes} type={type} />;
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -1,28 +1 @@
|
|||||||
import { useId } from "react";
|
export { Card } from "../../design-system/primitives/core.js";
|
||||||
|
|
||||||
/**
|
|
||||||
* @param {{
|
|
||||||
* title: string,
|
|
||||||
* description?: string,
|
|
||||||
* children?: React.ReactNode,
|
|
||||||
* footer?: React.ReactNode,
|
|
||||||
* className?: string
|
|
||||||
* }} props
|
|
||||||
*/
|
|
||||||
export function Card({ title, description, children, footer, className = "" }) {
|
|
||||||
const titleId = useId();
|
|
||||||
|
|
||||||
return (
|
|
||||||
<article
|
|
||||||
className={`ui-card ${className}`.trim()}
|
|
||||||
aria-labelledby={titleId}
|
|
||||||
>
|
|
||||||
<div className="ui-card__header">
|
|
||||||
<h3 id={titleId}>{title}</h3>
|
|
||||||
{description ? <p>{description}</p> : null}
|
|
||||||
</div>
|
|
||||||
{children ? <div className="ui-card__content">{children}</div> : null}
|
|
||||||
{footer ? <footer className="ui-card__footer">{footer}</footer> : null}
|
|
||||||
</article>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -1,88 +1 @@
|
|||||||
import { useEffect, useId, useRef } from "react";
|
export { Dialog } from "../../design-system/primitives/core.js";
|
||||||
|
|
||||||
/**
|
|
||||||
* @param {{
|
|
||||||
* open: boolean,
|
|
||||||
* onClose: () => void,
|
|
||||||
* title: string,
|
|
||||||
* description?: string,
|
|
||||||
* children?: React.ReactNode,
|
|
||||||
* actions?: React.ReactNode
|
|
||||||
* }} props
|
|
||||||
*/
|
|
||||||
export function Dialog({
|
|
||||||
open,
|
|
||||||
onClose,
|
|
||||||
title,
|
|
||||||
description,
|
|
||||||
children,
|
|
||||||
actions,
|
|
||||||
}) {
|
|
||||||
const dialogRef = useRef(/** @type {HTMLDialogElement | null} */ (null));
|
|
||||||
const previousFocusRef = useRef(/** @type {HTMLElement | null} */ (null));
|
|
||||||
const titleId = useId();
|
|
||||||
const descriptionId = useId();
|
|
||||||
|
|
||||||
useEffect(() => {
|
|
||||||
const dialog = dialogRef.current;
|
|
||||||
if (!dialog) return;
|
|
||||||
|
|
||||||
if (open) {
|
|
||||||
previousFocusRef.current =
|
|
||||||
document.activeElement instanceof HTMLElement
|
|
||||||
? document.activeElement
|
|
||||||
: null;
|
|
||||||
if (!dialog.open) {
|
|
||||||
if (typeof dialog.showModal === "function") dialog.showModal();
|
|
||||||
else dialog.setAttribute("open", "");
|
|
||||||
}
|
|
||||||
const firstFocusable = dialog.querySelector(
|
|
||||||
"[autofocus], button, [href], input, select, textarea, [tabindex]:not([tabindex='-1'])",
|
|
||||||
);
|
|
||||||
if (firstFocusable instanceof HTMLElement) firstFocusable.focus();
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (dialog.open) {
|
|
||||||
if (typeof dialog.close === "function") dialog.close();
|
|
||||||
else dialog.removeAttribute("open");
|
|
||||||
}
|
|
||||||
previousFocusRef.current?.focus();
|
|
||||||
previousFocusRef.current = null;
|
|
||||||
}, [open]);
|
|
||||||
|
|
||||||
return (
|
|
||||||
<dialog
|
|
||||||
className="ui-dialog"
|
|
||||||
ref={dialogRef}
|
|
||||||
aria-labelledby={titleId}
|
|
||||||
aria-describedby={description ? descriptionId : undefined}
|
|
||||||
onCancel={(event) => {
|
|
||||||
event.preventDefault();
|
|
||||||
onClose();
|
|
||||||
}}
|
|
||||||
onClick={(event) => {
|
|
||||||
if (event.target === event.currentTarget) onClose();
|
|
||||||
}}
|
|
||||||
>
|
|
||||||
<div className="ui-dialog__surface">
|
|
||||||
<header className="ui-dialog__header">
|
|
||||||
<div>
|
|
||||||
<h2 id={titleId}>{title}</h2>
|
|
||||||
{description ? <p id={descriptionId}>{description}</p> : null}
|
|
||||||
</div>
|
|
||||||
<button
|
|
||||||
className="ui-dialog__close"
|
|
||||||
type="button"
|
|
||||||
aria-label={`${title} 닫기`}
|
|
||||||
onClick={onClose}
|
|
||||||
>
|
|
||||||
×
|
|
||||||
</button>
|
|
||||||
</header>
|
|
||||||
{children ? <div className="ui-dialog__content">{children}</div> : null}
|
|
||||||
{actions ? <footer className="ui-dialog__actions">{actions}</footer> : null}
|
|
||||||
</div>
|
|
||||||
</dialog>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -1,52 +1 @@
|
|||||||
import { useId } from "react";
|
export { TextField } from "../../design-system/primitives/core.js";
|
||||||
|
|
||||||
/**
|
|
||||||
* @param {Omit<React.InputHTMLAttributes<HTMLInputElement>, "id"> & {
|
|
||||||
* id?: string,
|
|
||||||
* label: string,
|
|
||||||
* description?: string,
|
|
||||||
* error?: string
|
|
||||||
* }} props
|
|
||||||
*/
|
|
||||||
export function TextField({
|
|
||||||
id,
|
|
||||||
label,
|
|
||||||
description,
|
|
||||||
error,
|
|
||||||
className = "",
|
|
||||||
required,
|
|
||||||
...inputProps
|
|
||||||
}) {
|
|
||||||
const generatedId = useId();
|
|
||||||
const inputId = id ?? `field-${generatedId}`;
|
|
||||||
const descriptionId = description ? `${inputId}-description` : undefined;
|
|
||||||
const errorId = error ? `${inputId}-error` : undefined;
|
|
||||||
const describedBy = [descriptionId, errorId].filter(Boolean).join(" ");
|
|
||||||
|
|
||||||
return (
|
|
||||||
<div className={`ui-field ${className}`.trim()}>
|
|
||||||
<label className="ui-field__label" htmlFor={inputId}>
|
|
||||||
{label}
|
|
||||||
{required ? <span aria-hidden="true"> *</span> : null}
|
|
||||||
</label>
|
|
||||||
{description ? (
|
|
||||||
<p className="ui-field__description" id={descriptionId}>
|
|
||||||
{description}
|
|
||||||
</p>
|
|
||||||
) : null}
|
|
||||||
<input
|
|
||||||
{...inputProps}
|
|
||||||
className="ui-field__input"
|
|
||||||
id={inputId}
|
|
||||||
required={required}
|
|
||||||
aria-describedby={describedBy || undefined}
|
|
||||||
aria-invalid={error ? "true" : undefined}
|
|
||||||
/>
|
|
||||||
{error ? (
|
|
||||||
<p className="ui-field__error" id={errorId}>
|
|
||||||
{error}
|
|
||||||
</p>
|
|
||||||
) : null}
|
|
||||||
</div>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -0,0 +1,47 @@
|
|||||||
|
import type { ComponentType, SVGProps } from "react";
|
||||||
|
|
||||||
|
import {
|
||||||
|
CloseGlyph,
|
||||||
|
ErrorGlyph,
|
||||||
|
InfoGlyph,
|
||||||
|
MenuGlyph,
|
||||||
|
NextGlyph,
|
||||||
|
PreviousGlyph,
|
||||||
|
SearchGlyph,
|
||||||
|
SuccessGlyph,
|
||||||
|
WarningGlyph,
|
||||||
|
} from "./vendors/lucide.js";
|
||||||
|
|
||||||
|
export type SemanticIconProps = Readonly<{
|
||||||
|
label?: string;
|
||||||
|
size?: "small" | "medium" | "large";
|
||||||
|
}>;
|
||||||
|
|
||||||
|
function createSemanticIcon(
|
||||||
|
Glyph: ComponentType<SVGProps<SVGSVGElement>>,
|
||||||
|
) {
|
||||||
|
return function SemanticIcon({
|
||||||
|
label,
|
||||||
|
size = "medium",
|
||||||
|
}: SemanticIconProps) {
|
||||||
|
return (
|
||||||
|
<Glyph
|
||||||
|
aria-hidden={label ? undefined : "true"}
|
||||||
|
aria-label={label}
|
||||||
|
className={`ui-icon ui-icon--${size}`}
|
||||||
|
focusable="false"
|
||||||
|
role={label ? "img" : undefined}
|
||||||
|
/>
|
||||||
|
);
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export const MenuIcon = createSemanticIcon(MenuGlyph);
|
||||||
|
export const CloseIcon = createSemanticIcon(CloseGlyph);
|
||||||
|
export const WarningIcon = createSemanticIcon(WarningGlyph);
|
||||||
|
export const SuccessIcon = createSemanticIcon(SuccessGlyph);
|
||||||
|
export const ErrorIcon = createSemanticIcon(ErrorGlyph);
|
||||||
|
export const InfoIcon = createSemanticIcon(InfoGlyph);
|
||||||
|
export const SearchIcon = createSemanticIcon(SearchGlyph);
|
||||||
|
export const PreviousIcon = createSemanticIcon(PreviousGlyph);
|
||||||
|
export const NextIcon = createSemanticIcon(NextGlyph);
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
import {
|
||||||
|
AlertTriangle,
|
||||||
|
Check,
|
||||||
|
ChevronLeft,
|
||||||
|
ChevronRight,
|
||||||
|
CircleX,
|
||||||
|
Info,
|
||||||
|
Menu,
|
||||||
|
Search,
|
||||||
|
X,
|
||||||
|
} from "lucide-react";
|
||||||
|
|
||||||
|
export const MenuGlyph = Menu;
|
||||||
|
export const CloseGlyph = X;
|
||||||
|
export const WarningGlyph = AlertTriangle;
|
||||||
|
export const SuccessGlyph = Check;
|
||||||
|
export const ErrorGlyph = CircleX;
|
||||||
|
export const InfoGlyph = Info;
|
||||||
|
export const SearchGlyph = Search;
|
||||||
|
export const PreviousGlyph = ChevronLeft;
|
||||||
|
export const NextGlyph = ChevronRight;
|
||||||
@@ -0,0 +1,146 @@
|
|||||||
|
export {
|
||||||
|
Alert,
|
||||||
|
Badge,
|
||||||
|
Button,
|
||||||
|
Card,
|
||||||
|
Dialog,
|
||||||
|
Field,
|
||||||
|
FocusRing,
|
||||||
|
IconButton,
|
||||||
|
LinkButton,
|
||||||
|
Portal,
|
||||||
|
Spinner,
|
||||||
|
TextField,
|
||||||
|
VisuallyHidden,
|
||||||
|
} from "./primitives/core.js";
|
||||||
|
export type {
|
||||||
|
AlertProps,
|
||||||
|
BadgeProps,
|
||||||
|
ButtonProps,
|
||||||
|
ButtonSize,
|
||||||
|
ButtonVariant,
|
||||||
|
CardProps,
|
||||||
|
DialogProps,
|
||||||
|
IconButtonProps,
|
||||||
|
LinkButtonProps,
|
||||||
|
SpinnerProps,
|
||||||
|
TextFieldProps,
|
||||||
|
} from "./primitives/core.js";
|
||||||
|
export {
|
||||||
|
Checkbox,
|
||||||
|
RadioGroup,
|
||||||
|
SearchField,
|
||||||
|
Select,
|
||||||
|
Switch,
|
||||||
|
TextArea,
|
||||||
|
} from "./primitives/forms.js";
|
||||||
|
export type {
|
||||||
|
CheckboxProps,
|
||||||
|
RadioGroupProps,
|
||||||
|
RadioOption,
|
||||||
|
SearchFieldProps,
|
||||||
|
SelectOption,
|
||||||
|
SelectProps,
|
||||||
|
SwitchProps,
|
||||||
|
TextAreaProps,
|
||||||
|
} from "./primitives/forms.js";
|
||||||
|
export {
|
||||||
|
ProgressBar,
|
||||||
|
Separator,
|
||||||
|
Skeleton,
|
||||||
|
} from "./primitives/feedback.js";
|
||||||
|
export type {
|
||||||
|
ProgressBarProps,
|
||||||
|
SkeletonProps,
|
||||||
|
} from "./primitives/feedback.js";
|
||||||
|
export {
|
||||||
|
ConfirmationDialog,
|
||||||
|
Drawer,
|
||||||
|
Menu,
|
||||||
|
Popover,
|
||||||
|
ToastProvider,
|
||||||
|
Tooltip,
|
||||||
|
useToast,
|
||||||
|
} from "./primitives/overlays.js";
|
||||||
|
export type {
|
||||||
|
DrawerProps,
|
||||||
|
MenuItemDefinition,
|
||||||
|
MenuProps,
|
||||||
|
PopoverProps,
|
||||||
|
TooltipProps,
|
||||||
|
} from "./primitives/overlays.js";
|
||||||
|
export {
|
||||||
|
Breadcrumbs,
|
||||||
|
Pagination,
|
||||||
|
Tabs,
|
||||||
|
} from "./primitives/navigation.js";
|
||||||
|
export type {
|
||||||
|
BreadcrumbItem,
|
||||||
|
TabDefinition,
|
||||||
|
} from "./primitives/navigation.js";
|
||||||
|
export {
|
||||||
|
CloseIcon,
|
||||||
|
ErrorIcon,
|
||||||
|
InfoIcon,
|
||||||
|
MenuIcon,
|
||||||
|
NextIcon,
|
||||||
|
PreviousIcon,
|
||||||
|
SearchIcon,
|
||||||
|
SuccessIcon,
|
||||||
|
WarningIcon,
|
||||||
|
} from "./icons/semantic-icons.js";
|
||||||
|
export type {
|
||||||
|
SemanticIconProps,
|
||||||
|
} from "./icons/semantic-icons.js";
|
||||||
|
export {
|
||||||
|
DESIGN_TOKEN_CONTRACT,
|
||||||
|
REQUIRED_COMPONENT_TOKENS,
|
||||||
|
REQUIRED_PRIMITIVE_TOKENS,
|
||||||
|
REQUIRED_SEMANTIC_TOKENS,
|
||||||
|
} from "./tokens/token-contract.js";
|
||||||
|
export {
|
||||||
|
AccessSurface,
|
||||||
|
DataTable,
|
||||||
|
DisclosureGroup,
|
||||||
|
PaginationBar,
|
||||||
|
SearchFilterToolbar,
|
||||||
|
} from "./patterns/common-patterns.js";
|
||||||
|
export type {
|
||||||
|
AccessSurfaceProps,
|
||||||
|
DataTableColumn,
|
||||||
|
DisclosureDefinition,
|
||||||
|
} from "./patterns/common-patterns.js";
|
||||||
|
|
||||||
|
export {
|
||||||
|
AsyncSurface,
|
||||||
|
EmptySurface,
|
||||||
|
LoadingSurface,
|
||||||
|
TerminalErrorSurface,
|
||||||
|
} from "../components/async-surface.jsx";
|
||||||
|
export { PageHeader } from "../components/page-header.jsx";
|
||||||
|
export {
|
||||||
|
AuthRequiredSurface,
|
||||||
|
ForbiddenSurface,
|
||||||
|
NotFoundSurface,
|
||||||
|
} from "../components/state-surfaces.jsx";
|
||||||
|
export {
|
||||||
|
DetailPage,
|
||||||
|
CollectionPage,
|
||||||
|
FormPage,
|
||||||
|
StandardPage,
|
||||||
|
StatusPage,
|
||||||
|
} from "../templates/index.js";
|
||||||
|
export {
|
||||||
|
DirtyNavigationDialog,
|
||||||
|
ErrorSummary,
|
||||||
|
Form,
|
||||||
|
FormActions,
|
||||||
|
FormField,
|
||||||
|
useAppForm,
|
||||||
|
useDirtyNavigationGuard,
|
||||||
|
} from "../forms/index.js";
|
||||||
|
export type {
|
||||||
|
PageActionDefinition,
|
||||||
|
PageHeading,
|
||||||
|
} from "../templates/page-templates.js";
|
||||||
|
export type { FormResult } from "../forms/form-contracts.js";
|
||||||
@@ -0,0 +1,139 @@
|
|||||||
|
import { useId } from "react";
|
||||||
|
|
||||||
|
import {
|
||||||
|
AuthRequiredSurface,
|
||||||
|
ForbiddenSurface,
|
||||||
|
NotFoundSurface,
|
||||||
|
} from "../../components/state-surfaces.jsx";
|
||||||
|
import { Button } from "../primitives/core.js";
|
||||||
|
import { Pagination } from "../primitives/navigation.js";
|
||||||
|
|
||||||
|
export type DataTableColumn<Row> = Readonly<{
|
||||||
|
id: string;
|
||||||
|
header: string;
|
||||||
|
cell(row: Row): React.ReactNode;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export function DataTable<Row>({
|
||||||
|
caption,
|
||||||
|
columns,
|
||||||
|
rows,
|
||||||
|
rowKey,
|
||||||
|
empty,
|
||||||
|
}: Readonly<{
|
||||||
|
caption: string;
|
||||||
|
columns: readonly DataTableColumn<Row>[];
|
||||||
|
rows: readonly Row[];
|
||||||
|
rowKey(row: Row): string;
|
||||||
|
empty: React.ReactNode;
|
||||||
|
}>) {
|
||||||
|
if (rows.length === 0) return <>{empty}</>;
|
||||||
|
return (
|
||||||
|
<div className="ui-data-table__scroll" tabIndex={0}>
|
||||||
|
<table className="ui-data-table">
|
||||||
|
<caption>{caption}</caption>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
{columns.map((column) => (
|
||||||
|
<th key={column.id} scope="col">
|
||||||
|
{column.header}
|
||||||
|
</th>
|
||||||
|
))}
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
{rows.map((row) => (
|
||||||
|
<tr key={rowKey(row)}>
|
||||||
|
{columns.map((column) => (
|
||||||
|
<td key={column.id}>{column.cell(row)}</td>
|
||||||
|
))}
|
||||||
|
</tr>
|
||||||
|
))}
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function SearchFilterToolbar({
|
||||||
|
label,
|
||||||
|
search,
|
||||||
|
filters,
|
||||||
|
resetLabel,
|
||||||
|
onReset,
|
||||||
|
resultCount,
|
||||||
|
}: Readonly<{
|
||||||
|
label: string;
|
||||||
|
search: React.ReactNode;
|
||||||
|
filters?: React.ReactNode;
|
||||||
|
resetLabel: string;
|
||||||
|
onReset(): void;
|
||||||
|
resultCount: React.ReactNode;
|
||||||
|
}>) {
|
||||||
|
return (
|
||||||
|
<section aria-label={label} className="ui-search-filter-toolbar">
|
||||||
|
<div>{search}</div>
|
||||||
|
{filters ? <div>{filters}</div> : null}
|
||||||
|
<Button onClick={onReset} variant="ghost">
|
||||||
|
{resetLabel}
|
||||||
|
</Button>
|
||||||
|
<output>{resultCount}</output>
|
||||||
|
</section>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function PaginationBar({
|
||||||
|
range,
|
||||||
|
...pagination
|
||||||
|
}: React.ComponentProps<typeof Pagination> & Readonly<{ range: string }>) {
|
||||||
|
return (
|
||||||
|
<div className="ui-pagination-bar">
|
||||||
|
<p>{range}</p>
|
||||||
|
<Pagination {...pagination} />
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export type DisclosureDefinition = Readonly<{
|
||||||
|
id: string;
|
||||||
|
title: string;
|
||||||
|
content: React.ReactNode;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export function DisclosureGroup({
|
||||||
|
label,
|
||||||
|
items,
|
||||||
|
}: Readonly<{
|
||||||
|
label: string;
|
||||||
|
items: readonly DisclosureDefinition[];
|
||||||
|
}>) {
|
||||||
|
const groupId = useId();
|
||||||
|
return (
|
||||||
|
<section aria-labelledby={groupId} className="ui-disclosure-group">
|
||||||
|
<h2 className="visually-hidden" id={groupId}>
|
||||||
|
{label}
|
||||||
|
</h2>
|
||||||
|
{items.map((item) => (
|
||||||
|
<details key={item.id}>
|
||||||
|
<summary>{item.title}</summary>
|
||||||
|
<div>{item.content}</div>
|
||||||
|
</details>
|
||||||
|
))}
|
||||||
|
</section>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export type AccessSurfaceProps =
|
||||||
|
| Readonly<{ kind: "auth-required"; onAction(): void }>
|
||||||
|
| Readonly<{ kind: "forbidden"; onAction(): void }>
|
||||||
|
| Readonly<{ kind: "not-found"; onAction(): void }>;
|
||||||
|
|
||||||
|
export function AccessSurface(props: AccessSurfaceProps) {
|
||||||
|
if (props.kind === "auth-required") {
|
||||||
|
return <AuthRequiredSurface onSignIn={props.onAction} />;
|
||||||
|
}
|
||||||
|
if (props.kind === "forbidden") {
|
||||||
|
return <ForbiddenSurface onNavigate={props.onAction} />;
|
||||||
|
}
|
||||||
|
return <NotFoundSurface onNavigate={props.onAction} />;
|
||||||
|
}
|
||||||
@@ -0,0 +1,446 @@
|
|||||||
|
import {
|
||||||
|
forwardRef,
|
||||||
|
useEffect,
|
||||||
|
useId,
|
||||||
|
useImperativeHandle,
|
||||||
|
useRef,
|
||||||
|
} from "react";
|
||||||
|
import { createPortal } from "react-dom";
|
||||||
|
|
||||||
|
import { CloseIcon } from "../icons/semantic-icons.js";
|
||||||
|
|
||||||
|
export type ButtonVariant = "primary" | "secondary" | "danger" | "ghost";
|
||||||
|
export type ButtonSize = "default" | "compact";
|
||||||
|
|
||||||
|
export type ButtonProps = React.ButtonHTMLAttributes<HTMLButtonElement> &
|
||||||
|
Readonly<{
|
||||||
|
variant?: ButtonVariant;
|
||||||
|
size?: ButtonSize;
|
||||||
|
pending?: boolean;
|
||||||
|
pendingLabel?: string;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export const Button = forwardRef<HTMLButtonElement, ButtonProps>(
|
||||||
|
function Button(
|
||||||
|
{
|
||||||
|
variant = "primary",
|
||||||
|
size = "default",
|
||||||
|
pending = false,
|
||||||
|
pendingLabel,
|
||||||
|
className = "",
|
||||||
|
type = "button",
|
||||||
|
children,
|
||||||
|
disabled,
|
||||||
|
...props
|
||||||
|
},
|
||||||
|
ref,
|
||||||
|
) {
|
||||||
|
const classes = [
|
||||||
|
"ui-button",
|
||||||
|
`ui-button--${variant}`,
|
||||||
|
size === "compact" ? "ui-button--compact" : "",
|
||||||
|
pending ? "ui-button--pending" : "",
|
||||||
|
className,
|
||||||
|
]
|
||||||
|
.filter(Boolean)
|
||||||
|
.join(" ");
|
||||||
|
|
||||||
|
return (
|
||||||
|
<button
|
||||||
|
{...props}
|
||||||
|
aria-busy={pending || undefined}
|
||||||
|
className={classes}
|
||||||
|
disabled={disabled}
|
||||||
|
ref={ref}
|
||||||
|
type={type}
|
||||||
|
>
|
||||||
|
{pending ? (
|
||||||
|
<>
|
||||||
|
<Spinner decorative />
|
||||||
|
{pendingLabel ?? children}
|
||||||
|
</>
|
||||||
|
) : (
|
||||||
|
children
|
||||||
|
)}
|
||||||
|
</button>
|
||||||
|
);
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
export type LinkButtonProps = React.AnchorHTMLAttributes<HTMLAnchorElement> &
|
||||||
|
Readonly<{
|
||||||
|
href: string;
|
||||||
|
variant?: ButtonVariant;
|
||||||
|
size?: ButtonSize;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export const LinkButton = forwardRef<HTMLAnchorElement, LinkButtonProps>(
|
||||||
|
function LinkButton(
|
||||||
|
{
|
||||||
|
href,
|
||||||
|
variant = "primary",
|
||||||
|
size = "default",
|
||||||
|
className = "",
|
||||||
|
...props
|
||||||
|
},
|
||||||
|
ref,
|
||||||
|
) {
|
||||||
|
return (
|
||||||
|
<a
|
||||||
|
{...props}
|
||||||
|
className={[
|
||||||
|
"ui-button",
|
||||||
|
`ui-button--${variant}`,
|
||||||
|
size === "compact" ? "ui-button--compact" : "",
|
||||||
|
className,
|
||||||
|
]
|
||||||
|
.filter(Boolean)
|
||||||
|
.join(" ")}
|
||||||
|
href={href}
|
||||||
|
ref={ref}
|
||||||
|
/>
|
||||||
|
);
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
export type IconButtonProps = Omit<ButtonProps, "aria-label" | "children"> &
|
||||||
|
Readonly<{
|
||||||
|
accessibleName: string;
|
||||||
|
children: React.ReactElement;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export const IconButton = forwardRef<HTMLButtonElement, IconButtonProps>(
|
||||||
|
function IconButton({ accessibleName, className = "", ...props }, ref) {
|
||||||
|
return (
|
||||||
|
<Button
|
||||||
|
{...props}
|
||||||
|
aria-label={accessibleName}
|
||||||
|
className={`ui-icon-button ${className}`.trim()}
|
||||||
|
ref={ref}
|
||||||
|
/>
|
||||||
|
);
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
type FieldFrameProps = Readonly<{
|
||||||
|
id?: string;
|
||||||
|
label: string;
|
||||||
|
description?: string;
|
||||||
|
error?: string;
|
||||||
|
required?: boolean;
|
||||||
|
className?: string;
|
||||||
|
children(
|
||||||
|
contract: Readonly<{
|
||||||
|
controlId: string;
|
||||||
|
describedBy: string | undefined;
|
||||||
|
invalid: boolean;
|
||||||
|
}>,
|
||||||
|
): React.ReactNode;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export function Field({
|
||||||
|
id,
|
||||||
|
label,
|
||||||
|
description,
|
||||||
|
error,
|
||||||
|
required,
|
||||||
|
className = "",
|
||||||
|
children,
|
||||||
|
}: FieldFrameProps) {
|
||||||
|
const generatedId = useId();
|
||||||
|
const controlId = id ?? `field-${generatedId}`;
|
||||||
|
const descriptionId = description ? `${controlId}-description` : undefined;
|
||||||
|
const errorId = error ? `${controlId}-error` : undefined;
|
||||||
|
const describedBy = [descriptionId, errorId].filter(Boolean).join(" ");
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div className={`ui-field ${className}`.trim()}>
|
||||||
|
<label className="ui-field__label" htmlFor={controlId}>
|
||||||
|
{label}
|
||||||
|
{required ? <span aria-hidden="true"> *</span> : null}
|
||||||
|
</label>
|
||||||
|
{description ? (
|
||||||
|
<p className="ui-field__description" id={descriptionId}>
|
||||||
|
{description}
|
||||||
|
</p>
|
||||||
|
) : null}
|
||||||
|
{children({
|
||||||
|
controlId,
|
||||||
|
describedBy: describedBy || undefined,
|
||||||
|
invalid: Boolean(error),
|
||||||
|
})}
|
||||||
|
{error ? (
|
||||||
|
<p className="ui-field__error" id={errorId}>
|
||||||
|
{error}
|
||||||
|
</p>
|
||||||
|
) : null}
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export type TextFieldProps = Omit<
|
||||||
|
React.InputHTMLAttributes<HTMLInputElement>,
|
||||||
|
"id"
|
||||||
|
> &
|
||||||
|
Readonly<{
|
||||||
|
id?: string;
|
||||||
|
label: string;
|
||||||
|
description?: string;
|
||||||
|
error?: string;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export const TextField = forwardRef<HTMLInputElement, TextFieldProps>(
|
||||||
|
function TextField(
|
||||||
|
{
|
||||||
|
id,
|
||||||
|
label,
|
||||||
|
description,
|
||||||
|
error,
|
||||||
|
className = "",
|
||||||
|
required,
|
||||||
|
...inputProps
|
||||||
|
},
|
||||||
|
ref,
|
||||||
|
) {
|
||||||
|
return (
|
||||||
|
<Field
|
||||||
|
className={className}
|
||||||
|
description={description}
|
||||||
|
error={error}
|
||||||
|
id={id}
|
||||||
|
label={label}
|
||||||
|
required={required}
|
||||||
|
>
|
||||||
|
{({ controlId, describedBy, invalid }) => (
|
||||||
|
<input
|
||||||
|
{...inputProps}
|
||||||
|
aria-describedby={describedBy}
|
||||||
|
aria-invalid={invalid || undefined}
|
||||||
|
className="ui-field__input"
|
||||||
|
id={controlId}
|
||||||
|
ref={ref}
|
||||||
|
required={required}
|
||||||
|
/>
|
||||||
|
)}
|
||||||
|
</Field>
|
||||||
|
);
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
export type CardProps = Readonly<{
|
||||||
|
title: string;
|
||||||
|
headingLevel?: 2 | 3 | 4;
|
||||||
|
description?: string;
|
||||||
|
children?: React.ReactNode;
|
||||||
|
footer?: React.ReactNode;
|
||||||
|
className?: string;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export function Card({
|
||||||
|
title,
|
||||||
|
headingLevel = 3,
|
||||||
|
description,
|
||||||
|
children,
|
||||||
|
footer,
|
||||||
|
className = "",
|
||||||
|
}: CardProps) {
|
||||||
|
const titleId = useId();
|
||||||
|
const Heading = `h${headingLevel}` as "h2" | "h3" | "h4";
|
||||||
|
|
||||||
|
return (
|
||||||
|
<article
|
||||||
|
aria-labelledby={titleId}
|
||||||
|
className={`ui-card ${className}`.trim()}
|
||||||
|
>
|
||||||
|
<div className="ui-card__header">
|
||||||
|
<Heading id={titleId}>{title}</Heading>
|
||||||
|
{description ? <p>{description}</p> : null}
|
||||||
|
</div>
|
||||||
|
{children ? <div className="ui-card__content">{children}</div> : null}
|
||||||
|
{footer ? <footer className="ui-card__footer">{footer}</footer> : null}
|
||||||
|
</article>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export type AlertProps = Readonly<{
|
||||||
|
title: string;
|
||||||
|
children?: React.ReactNode;
|
||||||
|
variant?: "info" | "success" | "warning" | "danger";
|
||||||
|
dismissLabel?: string;
|
||||||
|
onDismiss?: () => void;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export function Alert({
|
||||||
|
title,
|
||||||
|
children,
|
||||||
|
variant = "info",
|
||||||
|
dismissLabel,
|
||||||
|
onDismiss,
|
||||||
|
}: AlertProps) {
|
||||||
|
return (
|
||||||
|
<section
|
||||||
|
className={`ui-alert ui-alert--${variant}`}
|
||||||
|
role={variant === "danger" ? "alert" : "status"}
|
||||||
|
>
|
||||||
|
<div>
|
||||||
|
<strong>{title}</strong>
|
||||||
|
{children ? <div className="ui-alert__content">{children}</div> : null}
|
||||||
|
</div>
|
||||||
|
{onDismiss ? (
|
||||||
|
<IconButton
|
||||||
|
accessibleName={dismissLabel ?? `${title} 알림 닫기`}
|
||||||
|
className="ui-alert__dismiss"
|
||||||
|
onClick={onDismiss}
|
||||||
|
variant="ghost"
|
||||||
|
>
|
||||||
|
<CloseIcon />
|
||||||
|
</IconButton>
|
||||||
|
) : null}
|
||||||
|
</section>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export type BadgeProps = Readonly<{
|
||||||
|
children: React.ReactNode;
|
||||||
|
variant?: "neutral" | "info" | "success" | "warning" | "danger";
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export function Badge({ children, variant = "neutral" }: BadgeProps) {
|
||||||
|
return <span className={`ui-badge ui-badge--${variant}`}>{children}</span>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type DialogProps = Readonly<{
|
||||||
|
open: boolean;
|
||||||
|
onClose(): void;
|
||||||
|
title: string;
|
||||||
|
description?: string;
|
||||||
|
closeLabel?: string;
|
||||||
|
children?: React.ReactNode;
|
||||||
|
actions?: React.ReactNode;
|
||||||
|
className?: string;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export const Dialog = forwardRef<HTMLDialogElement, DialogProps>(
|
||||||
|
function Dialog(
|
||||||
|
{
|
||||||
|
open,
|
||||||
|
onClose,
|
||||||
|
title,
|
||||||
|
description,
|
||||||
|
closeLabel,
|
||||||
|
children,
|
||||||
|
actions,
|
||||||
|
className = "",
|
||||||
|
},
|
||||||
|
forwardedRef,
|
||||||
|
) {
|
||||||
|
const dialogRef = useRef<HTMLDialogElement | null>(null);
|
||||||
|
const previousFocusRef = useRef<HTMLElement | null>(null);
|
||||||
|
const titleId = useId();
|
||||||
|
const descriptionId = useId();
|
||||||
|
useImperativeHandle(forwardedRef, () => dialogRef.current!, []);
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
const dialog = dialogRef.current;
|
||||||
|
if (!dialog) return;
|
||||||
|
|
||||||
|
if (open) {
|
||||||
|
previousFocusRef.current =
|
||||||
|
document.activeElement instanceof HTMLElement
|
||||||
|
? document.activeElement
|
||||||
|
: null;
|
||||||
|
if (!dialog.open) {
|
||||||
|
if (typeof dialog.showModal === "function") dialog.showModal();
|
||||||
|
else dialog.setAttribute("open", "");
|
||||||
|
}
|
||||||
|
const firstFocusable = dialog.querySelector<HTMLElement>(
|
||||||
|
"[autofocus], button, [href], input, select, textarea, [tabindex]:not([tabindex='-1'])",
|
||||||
|
);
|
||||||
|
firstFocusable?.focus();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (dialog.open) {
|
||||||
|
if (typeof dialog.close === "function") dialog.close();
|
||||||
|
else dialog.removeAttribute("open");
|
||||||
|
}
|
||||||
|
previousFocusRef.current?.focus();
|
||||||
|
previousFocusRef.current = null;
|
||||||
|
}, [open]);
|
||||||
|
|
||||||
|
return (
|
||||||
|
<dialog
|
||||||
|
aria-describedby={description ? descriptionId : undefined}
|
||||||
|
aria-labelledby={titleId}
|
||||||
|
className={`ui-dialog ${className}`.trim()}
|
||||||
|
onCancel={(event) => {
|
||||||
|
event.preventDefault();
|
||||||
|
onClose();
|
||||||
|
}}
|
||||||
|
onClick={(event) => {
|
||||||
|
if (event.target === event.currentTarget) onClose();
|
||||||
|
}}
|
||||||
|
onKeyDown={(event) => {
|
||||||
|
if (event.key === "Escape") {
|
||||||
|
event.preventDefault();
|
||||||
|
onClose();
|
||||||
|
}
|
||||||
|
}}
|
||||||
|
ref={dialogRef}
|
||||||
|
>
|
||||||
|
<div className="ui-dialog__surface">
|
||||||
|
<header className="ui-dialog__header">
|
||||||
|
<div>
|
||||||
|
<h2 id={titleId}>{title}</h2>
|
||||||
|
{description ? <p id={descriptionId}>{description}</p> : null}
|
||||||
|
</div>
|
||||||
|
<IconButton
|
||||||
|
accessibleName={closeLabel ?? `${title} 닫기`}
|
||||||
|
className="ui-dialog__close"
|
||||||
|
onClick={onClose}
|
||||||
|
variant="ghost"
|
||||||
|
>
|
||||||
|
<CloseIcon />
|
||||||
|
</IconButton>
|
||||||
|
</header>
|
||||||
|
{children ? (
|
||||||
|
<div className="ui-dialog__content">{children}</div>
|
||||||
|
) : null}
|
||||||
|
{actions ? (
|
||||||
|
<footer className="ui-dialog__actions">{actions}</footer>
|
||||||
|
) : null}
|
||||||
|
</div>
|
||||||
|
</dialog>
|
||||||
|
);
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
export type SpinnerProps =
|
||||||
|
| Readonly<{ decorative: true; label?: never }>
|
||||||
|
| Readonly<{ decorative?: false; label: string }>;
|
||||||
|
|
||||||
|
export function Spinner(props: SpinnerProps) {
|
||||||
|
const accessibility = props.decorative
|
||||||
|
? { "aria-hidden": true as const }
|
||||||
|
: { "aria-label": props.label, role: "status" };
|
||||||
|
return <span {...accessibility} className="ui-spinner" />;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function VisuallyHidden({
|
||||||
|
children,
|
||||||
|
}: Readonly<{ children: React.ReactNode }>) {
|
||||||
|
return <span className="visually-hidden">{children}</span>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function Portal({
|
||||||
|
children,
|
||||||
|
}: Readonly<{ children: React.ReactNode }>) {
|
||||||
|
if (typeof document === "undefined") return <>{children}</>;
|
||||||
|
return createPortal(children, document.body);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function FocusRing({
|
||||||
|
children,
|
||||||
|
}: Readonly<{ children: React.ReactNode }>) {
|
||||||
|
return <span className="ui-focus-ring">{children}</span>;
|
||||||
|
}
|
||||||
@@ -0,0 +1,55 @@
|
|||||||
|
export type ProgressBarProps = Readonly<{
|
||||||
|
label: string;
|
||||||
|
value?: number;
|
||||||
|
max?: number;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export function ProgressBar({ label, value, max = 100 }: ProgressBarProps) {
|
||||||
|
const determinate = typeof value === "number";
|
||||||
|
return (
|
||||||
|
<div className="ui-progress">
|
||||||
|
<div className="ui-progress__label">
|
||||||
|
<span>{label}</span>
|
||||||
|
{determinate ? <span>{Math.round((value / max) * 100)}%</span> : null}
|
||||||
|
</div>
|
||||||
|
<progress
|
||||||
|
aria-label={label}
|
||||||
|
className="ui-progress__bar"
|
||||||
|
max={max}
|
||||||
|
value={determinate ? Math.min(Math.max(value, 0), max) : undefined}
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export type SkeletonProps = Readonly<{
|
||||||
|
label?: string;
|
||||||
|
height?: "text" | "control" | "surface";
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export function Skeleton({
|
||||||
|
label,
|
||||||
|
height = "surface",
|
||||||
|
}: SkeletonProps) {
|
||||||
|
return (
|
||||||
|
<span
|
||||||
|
aria-label={label}
|
||||||
|
aria-hidden={label ? undefined : true}
|
||||||
|
className={`ui-skeleton ui-skeleton--${height}`}
|
||||||
|
role={label ? "status" : undefined}
|
||||||
|
/>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function Separator({
|
||||||
|
label,
|
||||||
|
decorative = true,
|
||||||
|
}: Readonly<{ label?: string; decorative?: boolean }>) {
|
||||||
|
return (
|
||||||
|
<hr
|
||||||
|
aria-label={decorative ? undefined : label}
|
||||||
|
aria-hidden={decorative || undefined}
|
||||||
|
className="ui-separator"
|
||||||
|
/>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,409 @@
|
|||||||
|
import {
|
||||||
|
forwardRef,
|
||||||
|
useEffect,
|
||||||
|
useId,
|
||||||
|
useRef,
|
||||||
|
useState,
|
||||||
|
} from "react";
|
||||||
|
|
||||||
|
import { CloseIcon, SearchIcon } from "../icons/semantic-icons.js";
|
||||||
|
import { Field, IconButton } from "./core.js";
|
||||||
|
import type { TextFieldProps } from "./core.js";
|
||||||
|
|
||||||
|
type FieldCopy = Readonly<{
|
||||||
|
id?: string;
|
||||||
|
label: string;
|
||||||
|
description?: string;
|
||||||
|
error?: string;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export type TextAreaProps = Omit<
|
||||||
|
React.TextareaHTMLAttributes<HTMLTextAreaElement>,
|
||||||
|
"id"
|
||||||
|
> &
|
||||||
|
FieldCopy &
|
||||||
|
Readonly<{ maxLengthMessage?: (remaining: number) => string }>;
|
||||||
|
|
||||||
|
export const TextArea = forwardRef<HTMLTextAreaElement, TextAreaProps>(
|
||||||
|
function TextArea(
|
||||||
|
{
|
||||||
|
id,
|
||||||
|
label,
|
||||||
|
description,
|
||||||
|
error,
|
||||||
|
required,
|
||||||
|
className = "",
|
||||||
|
maxLength,
|
||||||
|
maxLengthMessage,
|
||||||
|
value,
|
||||||
|
defaultValue,
|
||||||
|
...props
|
||||||
|
},
|
||||||
|
ref,
|
||||||
|
) {
|
||||||
|
const [uncontrolledValue, setUncontrolledValue] = useState(
|
||||||
|
String(defaultValue ?? ""),
|
||||||
|
);
|
||||||
|
const currentValue =
|
||||||
|
value === undefined ? uncontrolledValue : String(value ?? "");
|
||||||
|
const remaining =
|
||||||
|
typeof maxLength === "number" ? maxLength - currentValue.length : null;
|
||||||
|
|
||||||
|
return (
|
||||||
|
<Field
|
||||||
|
className={className}
|
||||||
|
description={description}
|
||||||
|
error={error}
|
||||||
|
id={id}
|
||||||
|
label={label}
|
||||||
|
required={required}
|
||||||
|
>
|
||||||
|
{({ controlId, describedBy, invalid }) => (
|
||||||
|
<>
|
||||||
|
<textarea
|
||||||
|
{...props}
|
||||||
|
aria-describedby={describedBy}
|
||||||
|
aria-invalid={invalid || undefined}
|
||||||
|
className="ui-field__input ui-field__textarea"
|
||||||
|
defaultValue={value === undefined ? defaultValue : undefined}
|
||||||
|
id={controlId}
|
||||||
|
maxLength={maxLength}
|
||||||
|
onChange={(event) => {
|
||||||
|
if (value === undefined) setUncontrolledValue(event.currentTarget.value);
|
||||||
|
props.onChange?.(event);
|
||||||
|
}}
|
||||||
|
ref={ref}
|
||||||
|
required={required}
|
||||||
|
value={value}
|
||||||
|
/>
|
||||||
|
{remaining !== null ? (
|
||||||
|
<output className="ui-field__counter">
|
||||||
|
{maxLengthMessage
|
||||||
|
? maxLengthMessage(remaining)
|
||||||
|
: `${remaining}자 남음`}
|
||||||
|
</output>
|
||||||
|
) : null}
|
||||||
|
</>
|
||||||
|
)}
|
||||||
|
</Field>
|
||||||
|
);
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
export type SelectOption = Readonly<{
|
||||||
|
value: string;
|
||||||
|
label: string;
|
||||||
|
disabled?: boolean;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export type SelectProps = Omit<
|
||||||
|
React.SelectHTMLAttributes<HTMLSelectElement>,
|
||||||
|
"id" | "children"
|
||||||
|
> &
|
||||||
|
FieldCopy &
|
||||||
|
Readonly<{
|
||||||
|
options: readonly SelectOption[];
|
||||||
|
placeholder?: string;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export const Select = forwardRef<HTMLSelectElement, SelectProps>(
|
||||||
|
function Select(
|
||||||
|
{
|
||||||
|
id,
|
||||||
|
label,
|
||||||
|
description,
|
||||||
|
error,
|
||||||
|
options,
|
||||||
|
placeholder,
|
||||||
|
required,
|
||||||
|
className = "",
|
||||||
|
...props
|
||||||
|
},
|
||||||
|
ref,
|
||||||
|
) {
|
||||||
|
return (
|
||||||
|
<Field
|
||||||
|
className={className}
|
||||||
|
description={description}
|
||||||
|
error={error}
|
||||||
|
id={id}
|
||||||
|
label={label}
|
||||||
|
required={required}
|
||||||
|
>
|
||||||
|
{({ controlId, describedBy, invalid }) => (
|
||||||
|
<select
|
||||||
|
{...props}
|
||||||
|
aria-describedby={describedBy}
|
||||||
|
aria-invalid={invalid || undefined}
|
||||||
|
className="ui-field__input ui-field__select"
|
||||||
|
id={controlId}
|
||||||
|
ref={ref}
|
||||||
|
required={required}
|
||||||
|
>
|
||||||
|
{placeholder ? (
|
||||||
|
<option disabled value="">
|
||||||
|
{placeholder}
|
||||||
|
</option>
|
||||||
|
) : null}
|
||||||
|
{options.map((option) => (
|
||||||
|
<option
|
||||||
|
disabled={option.disabled}
|
||||||
|
key={option.value}
|
||||||
|
value={option.value}
|
||||||
|
>
|
||||||
|
{option.label}
|
||||||
|
</option>
|
||||||
|
))}
|
||||||
|
</select>
|
||||||
|
)}
|
||||||
|
</Field>
|
||||||
|
);
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
export type CheckboxProps = Omit<
|
||||||
|
React.InputHTMLAttributes<HTMLInputElement>,
|
||||||
|
"type"
|
||||||
|
> &
|
||||||
|
Readonly<{
|
||||||
|
label: string;
|
||||||
|
description?: string;
|
||||||
|
error?: string;
|
||||||
|
indeterminate?: boolean;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export const Checkbox = forwardRef<HTMLInputElement, CheckboxProps>(
|
||||||
|
function Checkbox(
|
||||||
|
{ label, description, error, indeterminate = false, id, ...props },
|
||||||
|
forwardedRef,
|
||||||
|
) {
|
||||||
|
const generatedId = useId();
|
||||||
|
const controlId = id ?? `checkbox-${generatedId}`;
|
||||||
|
const inputRef = useRef<HTMLInputElement | null>(null);
|
||||||
|
const descriptionId = description ? `${controlId}-description` : undefined;
|
||||||
|
const errorId = error ? `${controlId}-error` : undefined;
|
||||||
|
useEffect(() => {
|
||||||
|
if (inputRef.current) inputRef.current.indeterminate = indeterminate;
|
||||||
|
}, [indeterminate]);
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div className="ui-choice-field">
|
||||||
|
<label className="ui-choice-field__control" htmlFor={controlId}>
|
||||||
|
<input
|
||||||
|
{...props}
|
||||||
|
aria-describedby={
|
||||||
|
[descriptionId, errorId].filter(Boolean).join(" ") || undefined
|
||||||
|
}
|
||||||
|
aria-invalid={error ? true : undefined}
|
||||||
|
id={controlId}
|
||||||
|
ref={(node) => {
|
||||||
|
inputRef.current = node;
|
||||||
|
if (typeof forwardedRef === "function") forwardedRef(node);
|
||||||
|
else if (forwardedRef) forwardedRef.current = node;
|
||||||
|
}}
|
||||||
|
type="checkbox"
|
||||||
|
/>
|
||||||
|
<span>{label}</span>
|
||||||
|
</label>
|
||||||
|
{description ? (
|
||||||
|
<p className="ui-field__description" id={descriptionId}>
|
||||||
|
{description}
|
||||||
|
</p>
|
||||||
|
) : null}
|
||||||
|
{error ? (
|
||||||
|
<p className="ui-field__error" id={errorId}>
|
||||||
|
{error}
|
||||||
|
</p>
|
||||||
|
) : null}
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
export type RadioOption = Readonly<{
|
||||||
|
value: string;
|
||||||
|
label: string;
|
||||||
|
description?: string;
|
||||||
|
disabled?: boolean;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export type RadioGroupProps = Readonly<{
|
||||||
|
name: string;
|
||||||
|
label: string;
|
||||||
|
options: readonly RadioOption[];
|
||||||
|
value?: string;
|
||||||
|
defaultValue?: string;
|
||||||
|
onChange?(value: string): void;
|
||||||
|
disabled?: boolean;
|
||||||
|
error?: string;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export function RadioGroup({
|
||||||
|
name,
|
||||||
|
label,
|
||||||
|
options,
|
||||||
|
value,
|
||||||
|
defaultValue,
|
||||||
|
onChange,
|
||||||
|
disabled,
|
||||||
|
error,
|
||||||
|
}: RadioGroupProps) {
|
||||||
|
const [internalValue, setInternalValue] = useState(defaultValue ?? "");
|
||||||
|
const selected = value ?? internalValue;
|
||||||
|
const errorId = useId();
|
||||||
|
const refs = useRef<Array<HTMLInputElement | null>>([]);
|
||||||
|
|
||||||
|
function choose(nextValue: string) {
|
||||||
|
if (value === undefined) setInternalValue(nextValue);
|
||||||
|
onChange?.(nextValue);
|
||||||
|
}
|
||||||
|
|
||||||
|
return (
|
||||||
|
<fieldset
|
||||||
|
aria-describedby={error ? errorId : undefined}
|
||||||
|
className="ui-radio-group"
|
||||||
|
disabled={disabled}
|
||||||
|
>
|
||||||
|
<legend>{label}</legend>
|
||||||
|
{options.map((option, index) => (
|
||||||
|
<label className="ui-choice-field__control" key={option.value}>
|
||||||
|
<input
|
||||||
|
checked={selected === option.value}
|
||||||
|
disabled={option.disabled}
|
||||||
|
name={name}
|
||||||
|
onChange={() => choose(option.value)}
|
||||||
|
onKeyDown={(event) => {
|
||||||
|
if (!["ArrowDown", "ArrowRight", "ArrowUp", "ArrowLeft"].includes(event.key)) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
event.preventDefault();
|
||||||
|
const direction =
|
||||||
|
event.key === "ArrowDown" || event.key === "ArrowRight" ? 1 : -1;
|
||||||
|
let next = index;
|
||||||
|
do {
|
||||||
|
next = (next + direction + options.length) % options.length;
|
||||||
|
} while (options[next]?.disabled && next !== index);
|
||||||
|
const nextOption = options[next];
|
||||||
|
if (nextOption && !nextOption.disabled) {
|
||||||
|
choose(nextOption.value);
|
||||||
|
refs.current[next]?.focus();
|
||||||
|
}
|
||||||
|
}}
|
||||||
|
ref={(node) => {
|
||||||
|
refs.current[index] = node;
|
||||||
|
}}
|
||||||
|
type="radio"
|
||||||
|
value={option.value}
|
||||||
|
/>
|
||||||
|
<span>
|
||||||
|
{option.label}
|
||||||
|
{option.description ? <small>{option.description}</small> : null}
|
||||||
|
</span>
|
||||||
|
</label>
|
||||||
|
))}
|
||||||
|
{error ? (
|
||||||
|
<p className="ui-field__error" id={errorId}>
|
||||||
|
{error}
|
||||||
|
</p>
|
||||||
|
) : null}
|
||||||
|
</fieldset>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export type SwitchProps = Readonly<{
|
||||||
|
label: string;
|
||||||
|
checked: boolean;
|
||||||
|
onChange(checked: boolean): void;
|
||||||
|
disabled?: boolean;
|
||||||
|
description?: string;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export function Switch({
|
||||||
|
label,
|
||||||
|
checked,
|
||||||
|
onChange,
|
||||||
|
disabled,
|
||||||
|
description,
|
||||||
|
}: SwitchProps) {
|
||||||
|
const descriptionId = useId();
|
||||||
|
return (
|
||||||
|
<div className="ui-switch-field">
|
||||||
|
<button
|
||||||
|
aria-checked={checked}
|
||||||
|
aria-describedby={description ? descriptionId : undefined}
|
||||||
|
className="ui-switch"
|
||||||
|
disabled={disabled}
|
||||||
|
onClick={() => onChange(!checked)}
|
||||||
|
role="switch"
|
||||||
|
type="button"
|
||||||
|
>
|
||||||
|
<span aria-hidden="true" className="ui-switch__thumb" />
|
||||||
|
<span>{label}</span>
|
||||||
|
</button>
|
||||||
|
{description ? (
|
||||||
|
<p className="ui-field__description" id={descriptionId}>
|
||||||
|
{description}
|
||||||
|
</p>
|
||||||
|
) : null}
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export type SearchFieldProps = Omit<TextFieldProps, "type"> &
|
||||||
|
Readonly<{
|
||||||
|
clearLabel: string;
|
||||||
|
onClear(): void;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export const SearchField = forwardRef<HTMLInputElement, SearchFieldProps>(
|
||||||
|
function SearchField(
|
||||||
|
{
|
||||||
|
clearLabel,
|
||||||
|
onClear,
|
||||||
|
value,
|
||||||
|
className = "",
|
||||||
|
id,
|
||||||
|
label,
|
||||||
|
description,
|
||||||
|
error,
|
||||||
|
required,
|
||||||
|
...inputProps
|
||||||
|
},
|
||||||
|
ref,
|
||||||
|
) {
|
||||||
|
return (
|
||||||
|
<div className={`ui-search-field ${className}`.trim()}>
|
||||||
|
<SearchIcon />
|
||||||
|
<Field
|
||||||
|
description={description}
|
||||||
|
error={error}
|
||||||
|
id={id}
|
||||||
|
label={label}
|
||||||
|
required={required}
|
||||||
|
>
|
||||||
|
{({ controlId, describedBy, invalid }) => (
|
||||||
|
<input
|
||||||
|
{...inputProps}
|
||||||
|
aria-describedby={describedBy}
|
||||||
|
aria-invalid={invalid || undefined}
|
||||||
|
className="ui-field__input"
|
||||||
|
id={controlId}
|
||||||
|
ref={ref}
|
||||||
|
type="search"
|
||||||
|
value={value}
|
||||||
|
/>
|
||||||
|
)}
|
||||||
|
</Field>
|
||||||
|
{String(value ?? "").length > 0 ? (
|
||||||
|
<IconButton
|
||||||
|
accessibleName={clearLabel}
|
||||||
|
onClick={onClear}
|
||||||
|
variant="ghost"
|
||||||
|
>
|
||||||
|
<CloseIcon />
|
||||||
|
</IconButton>
|
||||||
|
) : null}
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
},
|
||||||
|
);
|
||||||
@@ -0,0 +1,193 @@
|
|||||||
|
import { useId, useRef, useState } from "react";
|
||||||
|
|
||||||
|
import { NextIcon, PreviousIcon } from "../icons/semantic-icons.js";
|
||||||
|
import { IconButton, LinkButton } from "./core.js";
|
||||||
|
|
||||||
|
export type BreadcrumbItem = Readonly<{
|
||||||
|
label: string;
|
||||||
|
href?: string;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export function Breadcrumbs({
|
||||||
|
label,
|
||||||
|
items,
|
||||||
|
}: Readonly<{ label: string; items: readonly BreadcrumbItem[] }>) {
|
||||||
|
return (
|
||||||
|
<nav aria-label={label} className="ui-breadcrumbs">
|
||||||
|
<ol>
|
||||||
|
{items.map((item, index) => {
|
||||||
|
const current = index === items.length - 1;
|
||||||
|
return (
|
||||||
|
<li key={`${item.label}-${index}`}>
|
||||||
|
{item.href && !current ? (
|
||||||
|
<a href={item.href}>{item.label}</a>
|
||||||
|
) : (
|
||||||
|
<span aria-current={current ? "page" : undefined}>
|
||||||
|
{item.label}
|
||||||
|
</span>
|
||||||
|
)}
|
||||||
|
</li>
|
||||||
|
);
|
||||||
|
})}
|
||||||
|
</ol>
|
||||||
|
</nav>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export type TabDefinition = Readonly<{
|
||||||
|
id: string;
|
||||||
|
label: string;
|
||||||
|
panel: React.ReactNode;
|
||||||
|
disabled?: boolean;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export function Tabs({
|
||||||
|
label,
|
||||||
|
tabs,
|
||||||
|
value,
|
||||||
|
defaultValue,
|
||||||
|
activation = "automatic",
|
||||||
|
onChange,
|
||||||
|
}: Readonly<{
|
||||||
|
label: string;
|
||||||
|
tabs: readonly TabDefinition[];
|
||||||
|
value?: string;
|
||||||
|
defaultValue?: string;
|
||||||
|
activation?: "automatic" | "manual";
|
||||||
|
onChange?(id: string): void;
|
||||||
|
}>) {
|
||||||
|
const fallback = tabs.find((tab) => !tab.disabled)?.id ?? "";
|
||||||
|
const [internalValue, setInternalValue] = useState(defaultValue ?? fallback);
|
||||||
|
const [focusValue, setFocusValue] = useState(value ?? internalValue);
|
||||||
|
const selected = value ?? internalValue;
|
||||||
|
const tabRefs = useRef<Array<HTMLButtonElement | null>>([]);
|
||||||
|
const baseId = useId();
|
||||||
|
|
||||||
|
function select(id: string) {
|
||||||
|
if (value === undefined) setInternalValue(id);
|
||||||
|
onChange?.(id);
|
||||||
|
}
|
||||||
|
|
||||||
|
function move(currentIndex: number, direction: 1 | -1) {
|
||||||
|
let next = currentIndex;
|
||||||
|
do {
|
||||||
|
next = (next + direction + tabs.length) % tabs.length;
|
||||||
|
} while (tabs[next]?.disabled && next !== currentIndex);
|
||||||
|
const nextTab = tabs[next];
|
||||||
|
if (!nextTab || nextTab.disabled) return;
|
||||||
|
setFocusValue(nextTab.id);
|
||||||
|
if (activation === "automatic") select(nextTab.id);
|
||||||
|
tabRefs.current[next]?.focus();
|
||||||
|
}
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div className="ui-tabs">
|
||||||
|
<div aria-label={label} className="ui-tabs__list" role="tablist">
|
||||||
|
{tabs.map((tab, index) => (
|
||||||
|
<button
|
||||||
|
aria-controls={`${baseId}-${tab.id}-panel`}
|
||||||
|
aria-selected={selected === tab.id}
|
||||||
|
className="ui-tabs__tab"
|
||||||
|
disabled={tab.disabled}
|
||||||
|
id={`${baseId}-${tab.id}-tab`}
|
||||||
|
key={tab.id}
|
||||||
|
onClick={() => {
|
||||||
|
setFocusValue(tab.id);
|
||||||
|
select(tab.id);
|
||||||
|
}}
|
||||||
|
onKeyDown={(event) => {
|
||||||
|
if (event.key === "ArrowRight") {
|
||||||
|
event.preventDefault();
|
||||||
|
move(index, 1);
|
||||||
|
} else if (event.key === "ArrowLeft") {
|
||||||
|
event.preventDefault();
|
||||||
|
move(index, -1);
|
||||||
|
} else if (
|
||||||
|
activation === "manual" &&
|
||||||
|
(event.key === "Enter" || event.key === " ")
|
||||||
|
) {
|
||||||
|
event.preventDefault();
|
||||||
|
select(tab.id);
|
||||||
|
}
|
||||||
|
}}
|
||||||
|
ref={(node) => {
|
||||||
|
tabRefs.current[index] = node;
|
||||||
|
}}
|
||||||
|
role="tab"
|
||||||
|
tabIndex={focusValue === tab.id ? 0 : -1}
|
||||||
|
type="button"
|
||||||
|
>
|
||||||
|
{tab.label}
|
||||||
|
</button>
|
||||||
|
))}
|
||||||
|
</div>
|
||||||
|
{tabs.map((tab) => (
|
||||||
|
<div
|
||||||
|
aria-labelledby={`${baseId}-${tab.id}-tab`}
|
||||||
|
className="ui-tabs__panel"
|
||||||
|
hidden={selected !== tab.id}
|
||||||
|
id={`${baseId}-${tab.id}-panel`}
|
||||||
|
key={tab.id}
|
||||||
|
role="tabpanel"
|
||||||
|
tabIndex={0}
|
||||||
|
>
|
||||||
|
{tab.panel}
|
||||||
|
</div>
|
||||||
|
))}
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function Pagination({
|
||||||
|
label,
|
||||||
|
page,
|
||||||
|
pageCount,
|
||||||
|
previousLabel,
|
||||||
|
nextLabel,
|
||||||
|
pageLabel,
|
||||||
|
onChange,
|
||||||
|
}: Readonly<{
|
||||||
|
label: string;
|
||||||
|
page: number;
|
||||||
|
pageCount: number;
|
||||||
|
previousLabel: string;
|
||||||
|
nextLabel: string;
|
||||||
|
pageLabel(page: number): string;
|
||||||
|
onChange(page: number): void;
|
||||||
|
}>) {
|
||||||
|
const pages = Array.from({ length: pageCount }, (_, index) => index + 1);
|
||||||
|
return (
|
||||||
|
<nav aria-label={label} className="ui-pagination">
|
||||||
|
<IconButton
|
||||||
|
accessibleName={previousLabel}
|
||||||
|
disabled={page <= 1}
|
||||||
|
onClick={() => onChange(page - 1)}
|
||||||
|
variant="secondary"
|
||||||
|
>
|
||||||
|
<PreviousIcon />
|
||||||
|
</IconButton>
|
||||||
|
{pages.map((candidate) => (
|
||||||
|
<LinkButton
|
||||||
|
aria-current={candidate === page ? "page" : undefined}
|
||||||
|
href={`?page=${candidate}`}
|
||||||
|
key={candidate}
|
||||||
|
onClick={(event) => {
|
||||||
|
event.preventDefault();
|
||||||
|
onChange(candidate);
|
||||||
|
}}
|
||||||
|
variant={candidate === page ? "primary" : "ghost"}
|
||||||
|
>
|
||||||
|
{pageLabel(candidate)}
|
||||||
|
</LinkButton>
|
||||||
|
))}
|
||||||
|
<IconButton
|
||||||
|
accessibleName={nextLabel}
|
||||||
|
disabled={page >= pageCount}
|
||||||
|
onClick={() => onChange(page + 1)}
|
||||||
|
variant="secondary"
|
||||||
|
>
|
||||||
|
<NextIcon />
|
||||||
|
</IconButton>
|
||||||
|
</nav>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,441 @@
|
|||||||
|
import {
|
||||||
|
createContext,
|
||||||
|
useCallback,
|
||||||
|
useContext,
|
||||||
|
useEffect,
|
||||||
|
useId,
|
||||||
|
useMemo,
|
||||||
|
useRef,
|
||||||
|
useState,
|
||||||
|
} from "react";
|
||||||
|
|
||||||
|
import { CloseIcon } from "../icons/semantic-icons.js";
|
||||||
|
import { Button, Dialog, IconButton } from "./core.js";
|
||||||
|
|
||||||
|
export type DrawerProps = Readonly<{
|
||||||
|
open: boolean;
|
||||||
|
onClose(): void;
|
||||||
|
title: string;
|
||||||
|
closeLabel?: string;
|
||||||
|
placement?: "start" | "end";
|
||||||
|
children: React.ReactNode;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export function Drawer({
|
||||||
|
open,
|
||||||
|
onClose,
|
||||||
|
title,
|
||||||
|
closeLabel,
|
||||||
|
placement = "start",
|
||||||
|
children,
|
||||||
|
}: DrawerProps) {
|
||||||
|
return (
|
||||||
|
<Dialog
|
||||||
|
className={`ui-drawer ui-drawer--${placement}`}
|
||||||
|
closeLabel={closeLabel}
|
||||||
|
onClose={onClose}
|
||||||
|
open={open}
|
||||||
|
title={title}
|
||||||
|
>
|
||||||
|
{children}
|
||||||
|
</Dialog>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export type PopoverProps = Readonly<{
|
||||||
|
triggerLabel: string;
|
||||||
|
children: React.ReactNode;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export function Popover({ triggerLabel, children }: PopoverProps) {
|
||||||
|
const [open, setOpen] = useState(false);
|
||||||
|
const rootRef = useRef<HTMLDivElement | null>(null);
|
||||||
|
const triggerRef = useRef<HTMLButtonElement | null>(null);
|
||||||
|
const contentId = useId();
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
if (!open) return;
|
||||||
|
function closeOutside(event: PointerEvent) {
|
||||||
|
if (
|
||||||
|
event.target instanceof Node &&
|
||||||
|
!rootRef.current?.contains(event.target)
|
||||||
|
) {
|
||||||
|
setOpen(false);
|
||||||
|
triggerRef.current?.focus();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
function closeOnEscape(event: KeyboardEvent) {
|
||||||
|
if (event.key === "Escape") {
|
||||||
|
setOpen(false);
|
||||||
|
triggerRef.current?.focus();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
document.addEventListener("pointerdown", closeOutside);
|
||||||
|
document.addEventListener("keydown", closeOnEscape);
|
||||||
|
return () => {
|
||||||
|
document.removeEventListener("pointerdown", closeOutside);
|
||||||
|
document.removeEventListener("keydown", closeOnEscape);
|
||||||
|
};
|
||||||
|
}, [open]);
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div className="ui-popover" ref={rootRef}>
|
||||||
|
<Button
|
||||||
|
aria-controls={contentId}
|
||||||
|
aria-expanded={open}
|
||||||
|
onClick={() => setOpen((current) => !current)}
|
||||||
|
ref={triggerRef}
|
||||||
|
variant="secondary"
|
||||||
|
>
|
||||||
|
{triggerLabel}
|
||||||
|
</Button>
|
||||||
|
{open ? (
|
||||||
|
<div className="ui-popover__content" id={contentId} role="dialog">
|
||||||
|
{children}
|
||||||
|
</div>
|
||||||
|
) : null}
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export type TooltipProps = Readonly<{
|
||||||
|
content: string;
|
||||||
|
children: React.ReactElement;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export function Tooltip({ content, children }: TooltipProps) {
|
||||||
|
const tooltipId = useId();
|
||||||
|
return (
|
||||||
|
<span className="ui-tooltip">
|
||||||
|
<span aria-describedby={tooltipId} className="ui-tooltip__trigger">
|
||||||
|
{children}
|
||||||
|
</span>
|
||||||
|
<span className="ui-tooltip__content" id={tooltipId} role="tooltip">
|
||||||
|
{content}
|
||||||
|
</span>
|
||||||
|
</span>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export type MenuItemDefinition = Readonly<{
|
||||||
|
id: string;
|
||||||
|
label: string;
|
||||||
|
disabled?: boolean;
|
||||||
|
onSelect(): void;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export type MenuProps = Readonly<{
|
||||||
|
triggerLabel: string;
|
||||||
|
items: readonly MenuItemDefinition[];
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export function Menu({ triggerLabel, items }: MenuProps) {
|
||||||
|
const [open, setOpen] = useState(false);
|
||||||
|
const [activeIndex, setActiveIndex] = useState(0);
|
||||||
|
const triggerRef = useRef<HTMLButtonElement | null>(null);
|
||||||
|
const rootRef = useRef<HTMLDivElement | null>(null);
|
||||||
|
const itemRefs = useRef<Array<HTMLButtonElement | null>>([]);
|
||||||
|
const searchRef = useRef("");
|
||||||
|
const resetSearchRef = useRef<number | undefined>(undefined);
|
||||||
|
|
||||||
|
const enabledIndexes = useMemo(
|
||||||
|
() => items.flatMap((item, index) => (item.disabled ? [] : [index])),
|
||||||
|
[items],
|
||||||
|
);
|
||||||
|
|
||||||
|
const focusIndex = useCallback(
|
||||||
|
(index: number) => {
|
||||||
|
setActiveIndex(index);
|
||||||
|
queueMicrotask(() => itemRefs.current[index]?.focus());
|
||||||
|
},
|
||||||
|
[],
|
||||||
|
);
|
||||||
|
|
||||||
|
function openAt(index: number) {
|
||||||
|
setOpen(true);
|
||||||
|
focusIndex(index);
|
||||||
|
}
|
||||||
|
|
||||||
|
function dismiss() {
|
||||||
|
setOpen(false);
|
||||||
|
queueMicrotask(() => triggerRef.current?.focus());
|
||||||
|
}
|
||||||
|
|
||||||
|
function move(direction: 1 | -1) {
|
||||||
|
const currentPosition = Math.max(enabledIndexes.indexOf(activeIndex), 0);
|
||||||
|
const nextPosition =
|
||||||
|
(currentPosition + direction + enabledIndexes.length) %
|
||||||
|
enabledIndexes.length;
|
||||||
|
const nextIndex = enabledIndexes[nextPosition];
|
||||||
|
if (nextIndex !== undefined) focusIndex(nextIndex);
|
||||||
|
}
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
if (!open) return;
|
||||||
|
function closeOutside(event: PointerEvent) {
|
||||||
|
if (
|
||||||
|
event.target instanceof Node &&
|
||||||
|
!rootRef.current?.contains(event.target)
|
||||||
|
) {
|
||||||
|
setOpen(false);
|
||||||
|
queueMicrotask(() => triggerRef.current?.focus());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
document.addEventListener("pointerdown", closeOutside);
|
||||||
|
return () => document.removeEventListener("pointerdown", closeOutside);
|
||||||
|
}, [open]);
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div className="ui-menu" ref={rootRef}>
|
||||||
|
<Button
|
||||||
|
aria-expanded={open}
|
||||||
|
aria-haspopup="menu"
|
||||||
|
onClick={() => {
|
||||||
|
if (open) dismiss();
|
||||||
|
else openAt(enabledIndexes[0] ?? 0);
|
||||||
|
}}
|
||||||
|
onKeyDown={(event) => {
|
||||||
|
if (event.key === "ArrowDown") {
|
||||||
|
event.preventDefault();
|
||||||
|
openAt(enabledIndexes[0] ?? 0);
|
||||||
|
}
|
||||||
|
if (event.key === "ArrowUp") {
|
||||||
|
event.preventDefault();
|
||||||
|
openAt(enabledIndexes.at(-1) ?? 0);
|
||||||
|
}
|
||||||
|
}}
|
||||||
|
ref={triggerRef}
|
||||||
|
variant="secondary"
|
||||||
|
>
|
||||||
|
{triggerLabel}
|
||||||
|
</Button>
|
||||||
|
{open ? (
|
||||||
|
<div
|
||||||
|
className="ui-menu__content"
|
||||||
|
onKeyDown={(event) => {
|
||||||
|
if (event.key === "Escape") {
|
||||||
|
event.preventDefault();
|
||||||
|
dismiss();
|
||||||
|
} else if (event.key === "ArrowDown") {
|
||||||
|
event.preventDefault();
|
||||||
|
move(1);
|
||||||
|
} else if (event.key === "ArrowUp") {
|
||||||
|
event.preventDefault();
|
||||||
|
move(-1);
|
||||||
|
} else if (event.key === "Home") {
|
||||||
|
event.preventDefault();
|
||||||
|
focusIndex(enabledIndexes[0] ?? 0);
|
||||||
|
} else if (event.key === "End") {
|
||||||
|
event.preventDefault();
|
||||||
|
focusIndex(enabledIndexes.at(-1) ?? 0);
|
||||||
|
} else if (
|
||||||
|
event.key.length === 1 &&
|
||||||
|
!event.ctrlKey &&
|
||||||
|
!event.metaKey &&
|
||||||
|
!event.altKey
|
||||||
|
) {
|
||||||
|
searchRef.current += event.key.toLocaleLowerCase();
|
||||||
|
window.clearTimeout(resetSearchRef.current);
|
||||||
|
resetSearchRef.current = window.setTimeout(() => {
|
||||||
|
searchRef.current = "";
|
||||||
|
}, 500);
|
||||||
|
const match = items.findIndex(
|
||||||
|
(item) =>
|
||||||
|
!item.disabled &&
|
||||||
|
item.label
|
||||||
|
.toLocaleLowerCase()
|
||||||
|
.startsWith(searchRef.current),
|
||||||
|
);
|
||||||
|
if (match >= 0) focusIndex(match);
|
||||||
|
}
|
||||||
|
}}
|
||||||
|
role="menu"
|
||||||
|
>
|
||||||
|
{items.map((item, index) => (
|
||||||
|
<button
|
||||||
|
className="ui-menu__item"
|
||||||
|
disabled={item.disabled}
|
||||||
|
key={item.id}
|
||||||
|
onClick={() => {
|
||||||
|
item.onSelect();
|
||||||
|
dismiss();
|
||||||
|
}}
|
||||||
|
ref={(node) => {
|
||||||
|
itemRefs.current[index] = node;
|
||||||
|
}}
|
||||||
|
role="menuitem"
|
||||||
|
tabIndex={index === activeIndex ? 0 : -1}
|
||||||
|
type="button"
|
||||||
|
>
|
||||||
|
{item.label}
|
||||||
|
</button>
|
||||||
|
))}
|
||||||
|
</div>
|
||||||
|
) : null}
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
type ToastTone = "info" | "success" | "warning" | "danger";
|
||||||
|
type ToastInput = Readonly<{
|
||||||
|
id: string;
|
||||||
|
title: string;
|
||||||
|
description?: string;
|
||||||
|
tone?: ToastTone;
|
||||||
|
durationMs?: number;
|
||||||
|
}>;
|
||||||
|
type ToastEntry = ToastInput & Readonly<{ count: number }>;
|
||||||
|
type ToastContextValue = Readonly<{
|
||||||
|
push(toast: ToastInput): void;
|
||||||
|
dismiss(id: string): void;
|
||||||
|
}>;
|
||||||
|
|
||||||
|
const ToastContext = createContext<ToastContextValue | null>(null);
|
||||||
|
|
||||||
|
export function ToastProvider({
|
||||||
|
children,
|
||||||
|
limit = 3,
|
||||||
|
}: Readonly<{ children: React.ReactNode; limit?: number }>) {
|
||||||
|
const [toasts, setToasts] = useState<readonly ToastEntry[]>([]);
|
||||||
|
|
||||||
|
const dismiss = useCallback((id: string) => {
|
||||||
|
setToasts((current) => current.filter((toast) => toast.id !== id));
|
||||||
|
}, []);
|
||||||
|
|
||||||
|
const push = useCallback(
|
||||||
|
(toast: ToastInput) => {
|
||||||
|
setToasts((current) => {
|
||||||
|
const existing = current.find((entry) => entry.id === toast.id);
|
||||||
|
if (existing) {
|
||||||
|
return current.map((entry) =>
|
||||||
|
entry.id === toast.id
|
||||||
|
? { ...entry, ...toast, count: entry.count + 1 }
|
||||||
|
: entry,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return [...current, { ...toast, count: 1 }].slice(-limit);
|
||||||
|
});
|
||||||
|
},
|
||||||
|
[limit],
|
||||||
|
);
|
||||||
|
|
||||||
|
const value = useMemo(() => ({ push, dismiss }), [dismiss, push]);
|
||||||
|
return (
|
||||||
|
<ToastContext.Provider value={value}>
|
||||||
|
{children}
|
||||||
|
<ToastRegion dismiss={dismiss} toasts={toasts} />
|
||||||
|
</ToastContext.Provider>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function useToast() {
|
||||||
|
const context = useContext(ToastContext);
|
||||||
|
if (!context) {
|
||||||
|
throw new Error("ToastProvider is required.");
|
||||||
|
}
|
||||||
|
return context;
|
||||||
|
}
|
||||||
|
|
||||||
|
function ToastRegion({
|
||||||
|
toasts,
|
||||||
|
dismiss,
|
||||||
|
}: Readonly<{
|
||||||
|
toasts: readonly ToastEntry[];
|
||||||
|
dismiss(id: string): void;
|
||||||
|
}>) {
|
||||||
|
return (
|
||||||
|
<section
|
||||||
|
aria-label="Notifications"
|
||||||
|
aria-live="polite"
|
||||||
|
className="ui-toast-region"
|
||||||
|
>
|
||||||
|
{toasts.map((toast) => (
|
||||||
|
<ToastItem dismiss={dismiss} key={toast.id} toast={toast} />
|
||||||
|
))}
|
||||||
|
</section>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function ToastItem({
|
||||||
|
toast,
|
||||||
|
dismiss,
|
||||||
|
}: Readonly<{
|
||||||
|
toast: ToastEntry;
|
||||||
|
dismiss(id: string): void;
|
||||||
|
}>) {
|
||||||
|
const [paused, setPaused] = useState(false);
|
||||||
|
useEffect(() => {
|
||||||
|
if (paused) return;
|
||||||
|
const timeout = window.setTimeout(
|
||||||
|
() => dismiss(toast.id),
|
||||||
|
toast.durationMs ?? 5000,
|
||||||
|
);
|
||||||
|
return () => window.clearTimeout(timeout);
|
||||||
|
}, [dismiss, paused, toast.durationMs, toast.id, toast.count]);
|
||||||
|
|
||||||
|
return (
|
||||||
|
<article
|
||||||
|
className={`ui-toast ui-toast--${toast.tone ?? "info"}`}
|
||||||
|
onBlur={(event) => {
|
||||||
|
if (!event.currentTarget.contains(event.relatedTarget)) setPaused(false);
|
||||||
|
}}
|
||||||
|
onFocus={() => setPaused(true)}
|
||||||
|
onMouseEnter={() => setPaused(true)}
|
||||||
|
onMouseLeave={() => setPaused(false)}
|
||||||
|
>
|
||||||
|
<div>
|
||||||
|
<strong>{toast.title}</strong>
|
||||||
|
{toast.count > 1 ? (
|
||||||
|
<span className="ui-toast__count"> ×{toast.count}</span>
|
||||||
|
) : null}
|
||||||
|
{toast.description ? <p>{toast.description}</p> : null}
|
||||||
|
</div>
|
||||||
|
<IconButton
|
||||||
|
accessibleName={`${toast.title} 닫기`}
|
||||||
|
onClick={() => dismiss(toast.id)}
|
||||||
|
variant="ghost"
|
||||||
|
>
|
||||||
|
<CloseIcon />
|
||||||
|
</IconButton>
|
||||||
|
</article>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function ConfirmationDialog({
|
||||||
|
open,
|
||||||
|
title,
|
||||||
|
description,
|
||||||
|
confirmLabel,
|
||||||
|
cancelLabel,
|
||||||
|
danger = false,
|
||||||
|
onConfirm,
|
||||||
|
onCancel,
|
||||||
|
}: Readonly<{
|
||||||
|
open: boolean;
|
||||||
|
title: string;
|
||||||
|
description: string;
|
||||||
|
confirmLabel: string;
|
||||||
|
cancelLabel: string;
|
||||||
|
danger?: boolean;
|
||||||
|
onConfirm(): void;
|
||||||
|
onCancel(): void;
|
||||||
|
}>) {
|
||||||
|
return (
|
||||||
|
<Dialog
|
||||||
|
actions={
|
||||||
|
<>
|
||||||
|
<Button onClick={onCancel} variant="secondary">
|
||||||
|
{cancelLabel}
|
||||||
|
</Button>
|
||||||
|
<Button onClick={onConfirm} variant={danger ? "danger" : "primary"}>
|
||||||
|
{confirmLabel}
|
||||||
|
</Button>
|
||||||
|
</>
|
||||||
|
}
|
||||||
|
description={description}
|
||||||
|
onClose={onCancel}
|
||||||
|
open={open}
|
||||||
|
title={title}
|
||||||
|
/>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,26 @@
|
|||||||
|
@theme {
|
||||||
|
--button-primary-background: var(--color-action);
|
||||||
|
--button-primary-content: var(--color-on-action);
|
||||||
|
--button-primary-hover: var(--color-action-hover);
|
||||||
|
--field-border: var(--color-border-strong);
|
||||||
|
--field-border-invalid: var(--color-danger);
|
||||||
|
--dialog-elevation: var(--elevation-dialog);
|
||||||
|
--navigation-active-background: color-mix(
|
||||||
|
in oklch,
|
||||||
|
var(--color-action) 14%,
|
||||||
|
var(--color-panel)
|
||||||
|
);
|
||||||
|
--drawer-width: min(20rem, 88vw);
|
||||||
|
--toast-width: min(24rem, calc(100vw - 2rem));
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (forced-colors: active) {
|
||||||
|
:root {
|
||||||
|
--color-border: CanvasText;
|
||||||
|
--color-border-strong: CanvasText;
|
||||||
|
--color-focus: Highlight;
|
||||||
|
--color-action: LinkText;
|
||||||
|
--color-danger: MarkText;
|
||||||
|
--color-danger-surface: Mark;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,63 @@
|
|||||||
|
@theme {
|
||||||
|
--palette-white: oklch(1 0 0);
|
||||||
|
--palette-slate-50: oklch(0.985 0.003 247);
|
||||||
|
--palette-slate-100: oklch(0.94 0.01 247);
|
||||||
|
--palette-slate-300: oklch(0.87 0.015 247);
|
||||||
|
--palette-slate-500: oklch(0.48 0.025 247);
|
||||||
|
--palette-slate-800: oklch(0.25 0.025 247);
|
||||||
|
--palette-slate-950: oklch(0.16 0.02 255);
|
||||||
|
--palette-blue-500: oklch(0.7 0.14 250);
|
||||||
|
--palette-blue-600: oklch(0.55 0.18 255);
|
||||||
|
--palette-blue-700: oklch(0.48 0.2 255);
|
||||||
|
--palette-red-500: oklch(0.68 0.19 25);
|
||||||
|
--palette-red-600: oklch(0.55 0.2 25);
|
||||||
|
--palette-red-700: oklch(0.47 0.2 25);
|
||||||
|
|
||||||
|
--space-1: 0.25rem;
|
||||||
|
--space-2: 0.5rem;
|
||||||
|
--space-3: 0.75rem;
|
||||||
|
--space-4: 1rem;
|
||||||
|
--space-5: 1.25rem;
|
||||||
|
--space-6: 1.5rem;
|
||||||
|
--space-8: 2rem;
|
||||||
|
--space-12: 3rem;
|
||||||
|
|
||||||
|
--font-size-xs: 0.75rem;
|
||||||
|
--font-size-sm: 0.875rem;
|
||||||
|
--font-size-md: 1rem;
|
||||||
|
--font-size-lg: 1.125rem;
|
||||||
|
--line-height-tight: 1.25;
|
||||||
|
--line-height-normal: 1.5;
|
||||||
|
--line-height-relaxed: 1.7;
|
||||||
|
--font-weight-regular: 400;
|
||||||
|
--font-weight-semibold: 650;
|
||||||
|
--font-weight-bold: 750;
|
||||||
|
|
||||||
|
--radius-xs: 0.25rem;
|
||||||
|
--radius-sm: 0.5rem;
|
||||||
|
--radius-md: 0.75rem;
|
||||||
|
--radius-full: 999px;
|
||||||
|
|
||||||
|
--shadow-panel: 0 8px 28px rgb(15 23 42 / 8%);
|
||||||
|
--shadow-popover: 0 14px 40px rgb(15 23 42 / 16%);
|
||||||
|
--shadow-dialog: 0 24px 70px rgb(15 23 42 / 25%);
|
||||||
|
|
||||||
|
--duration-fast: 100ms;
|
||||||
|
--duration-normal: 180ms;
|
||||||
|
--duration-slow: 300ms;
|
||||||
|
--easing-standard: cubic-bezier(0.2, 0, 0, 1);
|
||||||
|
--easing-emphasized: cubic-bezier(0.2, 0, 0, 1.2);
|
||||||
|
|
||||||
|
--size-control-sm: 2.25rem;
|
||||||
|
--size-control-md: 2.75rem;
|
||||||
|
--size-touch-target: 2.75rem;
|
||||||
|
--size-icon-sm: 1rem;
|
||||||
|
--size-icon-md: 1.25rem;
|
||||||
|
--size-icon-lg: 1.5rem;
|
||||||
|
--icon-stroke-default: 2;
|
||||||
|
|
||||||
|
--breakpoint-compact: 48rem;
|
||||||
|
--breakpoint-medium: 64rem;
|
||||||
|
--breakpoint-wide: 80rem;
|
||||||
|
--container-content: 72rem;
|
||||||
|
}
|
||||||
@@ -0,0 +1,83 @@
|
|||||||
|
@theme {
|
||||||
|
--color-surface: var(--palette-slate-50);
|
||||||
|
--color-surface-muted: var(--palette-slate-100);
|
||||||
|
--color-panel: var(--palette-white);
|
||||||
|
--color-surface-elevated: var(--palette-white);
|
||||||
|
--color-border: var(--palette-slate-300);
|
||||||
|
--color-border-strong: var(--palette-slate-500);
|
||||||
|
--color-content: var(--palette-slate-800);
|
||||||
|
--color-content-muted: var(--palette-slate-500);
|
||||||
|
--color-content-inverse: var(--palette-white);
|
||||||
|
--color-action: var(--palette-blue-600);
|
||||||
|
--color-action-hover: var(--palette-blue-700);
|
||||||
|
--color-action-pressed: var(--palette-blue-700);
|
||||||
|
--color-danger: var(--palette-red-600);
|
||||||
|
--color-danger-hover: var(--palette-red-700);
|
||||||
|
--color-on-action: var(--palette-white);
|
||||||
|
--color-focus: oklch(0.72 0.16 225);
|
||||||
|
--color-disabled-content: color-mix(in oklch, var(--color-content) 55%, transparent);
|
||||||
|
--color-disabled-surface: var(--color-surface-muted);
|
||||||
|
--color-info-content: oklch(0.38 0.16 255);
|
||||||
|
--color-info-surface: oklch(0.95 0.03 255);
|
||||||
|
--color-info-border: oklch(0.75 0.08 250);
|
||||||
|
--color-success-content: oklch(0.35 0.12 155);
|
||||||
|
--color-success-surface: oklch(0.95 0.04 155);
|
||||||
|
--color-success-border: oklch(0.72 0.1 155);
|
||||||
|
--color-warning-content: oklch(0.38 0.12 70);
|
||||||
|
--color-warning-surface: oklch(0.96 0.05 80);
|
||||||
|
--color-warning-border: oklch(0.75 0.12 80);
|
||||||
|
--color-danger-content: oklch(0.42 0.18 25);
|
||||||
|
--color-danger-surface: oklch(0.96 0.035 25);
|
||||||
|
--color-danger-border: oklch(0.72 0.12 25);
|
||||||
|
|
||||||
|
--font-sans: Inter, ui-sans-serif, system-ui, sans-serif;
|
||||||
|
--spacing-page: var(--space-6);
|
||||||
|
--radius-control: var(--radius-sm);
|
||||||
|
--radius-surface: var(--radius-md);
|
||||||
|
--radius-modal: var(--radius-md);
|
||||||
|
--elevation-panel: var(--shadow-panel);
|
||||||
|
--elevation-popover: var(--shadow-popover);
|
||||||
|
--elevation-dialog: var(--shadow-dialog);
|
||||||
|
--layer-base: 0;
|
||||||
|
--layer-sticky: 30;
|
||||||
|
--layer-navigation: 50;
|
||||||
|
--layer-popover: 60;
|
||||||
|
--layer-modal: 70;
|
||||||
|
--layer-toast: 80;
|
||||||
|
--opacity-disabled: 0.55;
|
||||||
|
--opacity-scrim: 0.55;
|
||||||
|
--opacity-skeleton: 0.7;
|
||||||
|
}
|
||||||
|
|
||||||
|
:root[data-theme="dark"] {
|
||||||
|
--color-surface: var(--palette-slate-950);
|
||||||
|
--color-surface-muted: oklch(0.25 0.025 255);
|
||||||
|
--color-panel: oklch(0.205 0.022 255);
|
||||||
|
--color-surface-elevated: oklch(0.235 0.025 255);
|
||||||
|
--color-border: oklch(0.36 0.025 255);
|
||||||
|
--color-border-strong: oklch(0.58 0.025 255);
|
||||||
|
--color-content: oklch(0.94 0.012 255);
|
||||||
|
--color-content-muted: oklch(0.74 0.025 255);
|
||||||
|
--color-content-inverse: var(--palette-slate-950);
|
||||||
|
--color-action: var(--palette-blue-500);
|
||||||
|
--color-action-hover: oklch(0.79 0.12 245);
|
||||||
|
--color-action-pressed: oklch(0.83 0.1 245);
|
||||||
|
--color-danger: var(--palette-red-500);
|
||||||
|
--color-danger-hover: oklch(0.76 0.16 25);
|
||||||
|
--color-on-action: var(--palette-slate-950);
|
||||||
|
--color-focus: oklch(0.82 0.15 220);
|
||||||
|
--color-disabled-content: color-mix(in oklch, var(--color-content) 55%, transparent);
|
||||||
|
--color-disabled-surface: var(--color-surface-muted);
|
||||||
|
--color-info-content: oklch(0.83 0.09 250);
|
||||||
|
--color-info-surface: oklch(0.27 0.045 255);
|
||||||
|
--color-info-border: oklch(0.55 0.09 250);
|
||||||
|
--color-success-content: oklch(0.83 0.1 155);
|
||||||
|
--color-success-surface: oklch(0.27 0.045 155);
|
||||||
|
--color-success-border: oklch(0.53 0.1 155);
|
||||||
|
--color-warning-content: oklch(0.88 0.1 80);
|
||||||
|
--color-warning-surface: oklch(0.29 0.045 80);
|
||||||
|
--color-warning-border: oklch(0.58 0.11 80);
|
||||||
|
--color-danger-content: oklch(0.84 0.11 25);
|
||||||
|
--color-danger-surface: oklch(0.28 0.055 25);
|
||||||
|
--color-danger-border: oklch(0.56 0.13 25);
|
||||||
|
}
|
||||||
@@ -0,0 +1,62 @@
|
|||||||
|
export const REQUIRED_PRIMITIVE_TOKENS = Object.freeze([
|
||||||
|
"--space-1",
|
||||||
|
"--space-2",
|
||||||
|
"--space-4",
|
||||||
|
"--font-size-sm",
|
||||||
|
"--line-height-normal",
|
||||||
|
"--radius-sm",
|
||||||
|
"--shadow-dialog",
|
||||||
|
"--duration-fast",
|
||||||
|
"--easing-standard",
|
||||||
|
"--size-control-md",
|
||||||
|
"--size-touch-target",
|
||||||
|
"--size-icon-md",
|
||||||
|
"--breakpoint-compact",
|
||||||
|
] as const);
|
||||||
|
|
||||||
|
export const REQUIRED_SEMANTIC_TOKENS = Object.freeze([
|
||||||
|
"--color-surface",
|
||||||
|
"--color-surface-muted",
|
||||||
|
"--color-surface-elevated",
|
||||||
|
"--color-content",
|
||||||
|
"--color-content-muted",
|
||||||
|
"--color-content-inverse",
|
||||||
|
"--color-border",
|
||||||
|
"--color-border-strong",
|
||||||
|
"--color-action",
|
||||||
|
"--color-action-hover",
|
||||||
|
"--color-action-pressed",
|
||||||
|
"--color-danger",
|
||||||
|
"--color-warning-content",
|
||||||
|
"--color-success-content",
|
||||||
|
"--color-info-content",
|
||||||
|
"--color-focus",
|
||||||
|
"--color-disabled-content",
|
||||||
|
"--color-disabled-surface",
|
||||||
|
"--elevation-panel",
|
||||||
|
"--layer-navigation",
|
||||||
|
"--layer-popover",
|
||||||
|
"--layer-modal",
|
||||||
|
"--layer-toast",
|
||||||
|
"--opacity-disabled",
|
||||||
|
"--opacity-scrim",
|
||||||
|
"--opacity-skeleton",
|
||||||
|
] as const);
|
||||||
|
|
||||||
|
export const REQUIRED_COMPONENT_TOKENS = Object.freeze([
|
||||||
|
"--button-primary-background",
|
||||||
|
"--button-primary-content",
|
||||||
|
"--button-primary-hover",
|
||||||
|
"--field-border",
|
||||||
|
"--field-border-invalid",
|
||||||
|
"--dialog-elevation",
|
||||||
|
"--navigation-active-background",
|
||||||
|
"--drawer-width",
|
||||||
|
"--toast-width",
|
||||||
|
] as const);
|
||||||
|
|
||||||
|
export const DESIGN_TOKEN_CONTRACT = Object.freeze({
|
||||||
|
primitive: REQUIRED_PRIMITIVE_TOKENS,
|
||||||
|
semantic: REQUIRED_SEMANTIC_TOKENS,
|
||||||
|
component: REQUIRED_COMPONENT_TOKENS,
|
||||||
|
});
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
import { useState } from "react";
|
import { useState } from "react";
|
||||||
import { useLocation } from "react-router-dom";
|
import { useLocation } from "react-router-dom";
|
||||||
|
|
||||||
import { PageHeader } from "../components/page-header.jsx";
|
import { PageHeader } from "../design-system/index.js";
|
||||||
import { useSession } from "../providers/session-provider.jsx";
|
import { useSession } from "../providers/session-provider.jsx";
|
||||||
|
|
||||||
export default function AuthExamplePage() {
|
export default function AuthExamplePage() {
|
||||||
|
|||||||
@@ -7,15 +7,13 @@ import {
|
|||||||
EmptySurface,
|
EmptySurface,
|
||||||
LoadingSurface,
|
LoadingSurface,
|
||||||
TerminalErrorSurface,
|
TerminalErrorSurface,
|
||||||
} from "../components/async-surface.jsx";
|
|
||||||
import { PageHeader } from "../components/page-header.jsx";
|
|
||||||
import {
|
|
||||||
AuthRequiredSurface,
|
AuthRequiredSurface,
|
||||||
ForbiddenSurface,
|
ForbiddenSurface,
|
||||||
NotFoundSurface,
|
NotFoundSurface,
|
||||||
} from "../components/state-surfaces.jsx";
|
Button,
|
||||||
import { Button } from "../components/ui/button.jsx";
|
Card,
|
||||||
import { Card } from "../components/ui/card.jsx";
|
PageHeader,
|
||||||
|
} from "../design-system/index.js";
|
||||||
|
|
||||||
export default function StateGalleryPage() {
|
export default function StateGalleryPage() {
|
||||||
const [lastAction, setLastAction] = useState(
|
const [lastAction, setLastAction] = useState(
|
||||||
|
|||||||
@@ -1,12 +1,25 @@
|
|||||||
import { useState } from "react";
|
import { useState } from "react";
|
||||||
|
|
||||||
import { PageHeader } from "../components/page-header.jsx";
|
import {
|
||||||
import { Alert } from "../components/ui/alert.jsx";
|
Alert,
|
||||||
import { Badge } from "../components/ui/badge.jsx";
|
Badge,
|
||||||
import { Button } from "../components/ui/button.jsx";
|
Button,
|
||||||
import { Card } from "../components/ui/card.jsx";
|
Card,
|
||||||
import { Dialog } from "../components/ui/dialog.jsx";
|
Checkbox,
|
||||||
import { TextField } from "../components/ui/text-field.jsx";
|
Dialog,
|
||||||
|
Menu,
|
||||||
|
PageHeader,
|
||||||
|
ProgressBar,
|
||||||
|
RadioGroup,
|
||||||
|
Select,
|
||||||
|
Switch,
|
||||||
|
Tabs,
|
||||||
|
TextArea,
|
||||||
|
TextField,
|
||||||
|
ToastProvider,
|
||||||
|
Tooltip,
|
||||||
|
useToast,
|
||||||
|
} from "../design-system/index.js";
|
||||||
|
|
||||||
const COLOR_TOKENS = Object.freeze([
|
const COLOR_TOKENS = Object.freeze([
|
||||||
["Surface", "--color-surface"],
|
["Surface", "--color-surface"],
|
||||||
@@ -19,7 +32,21 @@ const COLOR_TOKENS = Object.freeze([
|
|||||||
]);
|
]);
|
||||||
|
|
||||||
export default function UiGalleryPage() {
|
export default function UiGalleryPage() {
|
||||||
|
return (
|
||||||
|
<ToastProvider>
|
||||||
|
<UiGalleryContent />
|
||||||
|
</ToastProvider>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function UiGalleryContent() {
|
||||||
|
const toast = useToast();
|
||||||
const [projectName, setProjectName] = useState("");
|
const [projectName, setProjectName] = useState("");
|
||||||
|
const [description, setDescription] = useState("");
|
||||||
|
const [template, setTemplate] = useState("application");
|
||||||
|
const [reviewed, setReviewed] = useState(false);
|
||||||
|
const [notifications, setNotifications] = useState(true);
|
||||||
|
const [density, setDensity] = useState("comfortable");
|
||||||
const [fieldTouched, setFieldTouched] = useState(false);
|
const [fieldTouched, setFieldTouched] = useState(false);
|
||||||
const [dialogOpen, setDialogOpen] = useState(false);
|
const [dialogOpen, setDialogOpen] = useState(false);
|
||||||
const [notice, setNotice] = useState(
|
const [notice, setNotice] = useState(
|
||||||
@@ -92,6 +119,60 @@ export default function UiGalleryPage() {
|
|||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
<section className="gallery-section" aria-labelledby="form-controls-title">
|
||||||
|
<header className="gallery-section__header">
|
||||||
|
<h2 id="form-controls-title">폼과 선택 컨트롤</h2>
|
||||||
|
<p>native semantics, 설명·오류 연결과 controlled 상태를 제공합니다.</p>
|
||||||
|
</header>
|
||||||
|
<div className="component-grid component-grid--two">
|
||||||
|
<Card title="긴 입력과 선택">
|
||||||
|
<div className="component-stack">
|
||||||
|
<TextArea
|
||||||
|
label="설명"
|
||||||
|
maxLength={120}
|
||||||
|
value={description}
|
||||||
|
onChange={(event) => setDescription(event.currentTarget.value)}
|
||||||
|
/>
|
||||||
|
<Select
|
||||||
|
label="시작 템플릿"
|
||||||
|
options={[
|
||||||
|
{ value: "application", label: "Application" },
|
||||||
|
{ value: "library", label: "Library" },
|
||||||
|
]}
|
||||||
|
value={template}
|
||||||
|
onChange={(event) => setTemplate(event.currentTarget.value)}
|
||||||
|
/>
|
||||||
|
<Checkbox
|
||||||
|
checked={reviewed}
|
||||||
|
label="접근성 계약을 확인했습니다."
|
||||||
|
onChange={(event) => setReviewed(event.currentTarget.checked)}
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
</Card>
|
||||||
|
<Card title="단일 선택과 설정">
|
||||||
|
<div className="component-stack">
|
||||||
|
<RadioGroup
|
||||||
|
label="화면 밀도"
|
||||||
|
name="density"
|
||||||
|
onChange={setDensity}
|
||||||
|
options={[
|
||||||
|
{ value: "comfortable", label: "여유롭게" },
|
||||||
|
{ value: "compact", label: "조밀하게" },
|
||||||
|
]}
|
||||||
|
value={density}
|
||||||
|
/>
|
||||||
|
<Switch
|
||||||
|
checked={notifications}
|
||||||
|
description="boolean 설정에만 switch를 사용합니다."
|
||||||
|
label="알림 사용"
|
||||||
|
onChange={setNotifications}
|
||||||
|
/>
|
||||||
|
<ProgressBar label="설정 준비도" max={4} value={3} />
|
||||||
|
</div>
|
||||||
|
</Card>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
|
||||||
<section className="gallery-section" aria-labelledby="feedback-title">
|
<section className="gallery-section" aria-labelledby="feedback-title">
|
||||||
<header className="gallery-section__header">
|
<header className="gallery-section__header">
|
||||||
<h2 id="feedback-title">피드백과 모달</h2>
|
<h2 id="feedback-title">피드백과 모달</h2>
|
||||||
@@ -126,7 +207,32 @@ export default function UiGalleryPage() {
|
|||||||
</div>
|
</div>
|
||||||
</Card>
|
</Card>
|
||||||
<Card title="모달" description="배경과 키보드 Esc로 닫고 포커스를 복원합니다.">
|
<Card title="모달" description="배경과 키보드 Esc로 닫고 포커스를 복원합니다.">
|
||||||
|
<div className="button-row">
|
||||||
<Button onClick={() => setDialogOpen(true)}>모달 열기</Button>
|
<Button onClick={() => setDialogOpen(true)}>모달 열기</Button>
|
||||||
|
<Menu
|
||||||
|
items={[
|
||||||
|
{
|
||||||
|
id: "inspect",
|
||||||
|
label: "상태 확인",
|
||||||
|
onSelect: () => setNotice("메뉴 작업을 실행했습니다."),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: "notify",
|
||||||
|
label: "Toast 표시",
|
||||||
|
onSelect: () =>
|
||||||
|
toast.push({
|
||||||
|
id: "gallery-saved",
|
||||||
|
title: "예제가 저장되었습니다.",
|
||||||
|
tone: "success",
|
||||||
|
}),
|
||||||
|
},
|
||||||
|
]}
|
||||||
|
triggerLabel="작업 메뉴"
|
||||||
|
/>
|
||||||
|
<Tooltip content="이 설명은 필수 정보가 아닙니다.">
|
||||||
|
<Button variant="ghost">도움말</Button>
|
||||||
|
</Tooltip>
|
||||||
|
</div>
|
||||||
<Dialog
|
<Dialog
|
||||||
open={dialogOpen}
|
open={dialogOpen}
|
||||||
onClose={() => setDialogOpen(false)}
|
onClose={() => setDialogOpen(false)}
|
||||||
@@ -157,6 +263,34 @@ export default function UiGalleryPage() {
|
|||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
<section className="gallery-section" aria-labelledby="navigation-title">
|
||||||
|
<header className="gallery-section__header">
|
||||||
|
<h2 id="navigation-title">탐색 패턴</h2>
|
||||||
|
<p>화살표 키와 명시적인 활성화 정책을 갖는 탭 예제입니다.</p>
|
||||||
|
</header>
|
||||||
|
<Tabs
|
||||||
|
activation="manual"
|
||||||
|
label="디자인 시스템 계층"
|
||||||
|
tabs={[
|
||||||
|
{
|
||||||
|
id: "tokens",
|
||||||
|
label: "토큰",
|
||||||
|
panel: <p>원시 값에서 의미와 컴포넌트 토큰을 파생합니다.</p>,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: "primitives",
|
||||||
|
label: "프리미티브",
|
||||||
|
panel: <p>native semantics와 interaction을 닫습니다.</p>,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: "patterns",
|
||||||
|
label: "패턴",
|
||||||
|
panel: <p>반복되는 사용자 문제를 조합으로 해결합니다.</p>,
|
||||||
|
},
|
||||||
|
]}
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
<section className="gallery-section" aria-labelledby="tokens-title">
|
<section className="gallery-section" aria-labelledby="tokens-title">
|
||||||
<header className="gallery-section__header">
|
<header className="gallery-section__header">
|
||||||
<h2 id="tokens-title">디자인 토큰</h2>
|
<h2 id="tokens-title">디자인 토큰</h2>
|
||||||
|
|||||||
@@ -0,0 +1,90 @@
|
|||||||
|
import { useId, type FormHTMLAttributes, type ReactNode } from "react";
|
||||||
|
|
||||||
|
import { TextField } from "../components/ui/text-field.jsx";
|
||||||
|
import type {
|
||||||
|
FieldErrors,
|
||||||
|
FieldName,
|
||||||
|
FormValues,
|
||||||
|
} from "./form-contracts.js";
|
||||||
|
|
||||||
|
export function Form(
|
||||||
|
props: FormHTMLAttributes<HTMLFormElement> & Readonly<{ pending?: boolean }>,
|
||||||
|
) {
|
||||||
|
const { pending = false, children, ...formProps } = props;
|
||||||
|
return (
|
||||||
|
<form {...formProps} noValidate aria-busy={pending || undefined}>
|
||||||
|
{children}
|
||||||
|
</form>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function FormField(
|
||||||
|
props: React.ComponentProps<typeof TextField>,
|
||||||
|
) {
|
||||||
|
return <TextField {...props} />;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function ErrorSummary<Values extends FormValues>(props: Readonly<{
|
||||||
|
fieldErrors: FieldErrors<Values>;
|
||||||
|
formErrors?: readonly string[];
|
||||||
|
fieldLabels: Readonly<Record<FieldName<Values>, string>>;
|
||||||
|
fieldId(name: FieldName<Values>): string;
|
||||||
|
onFocusField?(name: FieldName<Values>): void;
|
||||||
|
}>) {
|
||||||
|
const {
|
||||||
|
fieldErrors,
|
||||||
|
formErrors = [],
|
||||||
|
fieldLabels,
|
||||||
|
fieldId,
|
||||||
|
onFocusField,
|
||||||
|
} = props;
|
||||||
|
const headingId = useId();
|
||||||
|
const entries = Object.entries(fieldErrors) as [
|
||||||
|
FieldName<Values>,
|
||||||
|
string,
|
||||||
|
][];
|
||||||
|
if (entries.length === 0 && formErrors.length === 0) return null;
|
||||||
|
return (
|
||||||
|
<section
|
||||||
|
className="form-error-summary"
|
||||||
|
role="alert"
|
||||||
|
aria-labelledby={headingId}
|
||||||
|
>
|
||||||
|
<h2 id={headingId}>입력 내용을 확인해 주세요.</h2>
|
||||||
|
{entries.length > 0 ? (
|
||||||
|
<ul>
|
||||||
|
{entries.map(([name, message]) => (
|
||||||
|
<li key={name}>
|
||||||
|
<a
|
||||||
|
href={`#${fieldId(name)}`}
|
||||||
|
onClick={(event) => {
|
||||||
|
if (!onFocusField) return;
|
||||||
|
event.preventDefault();
|
||||||
|
onFocusField(name);
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
{fieldLabels[name]}: {message}
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
))}
|
||||||
|
</ul>
|
||||||
|
) : null}
|
||||||
|
{formErrors.map((message) => (
|
||||||
|
<p key={message}>{message}</p>
|
||||||
|
))}
|
||||||
|
</section>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function FormActions(props: Readonly<{
|
||||||
|
children: ReactNode;
|
||||||
|
sticky?: boolean;
|
||||||
|
}>) {
|
||||||
|
return (
|
||||||
|
<div
|
||||||
|
className={`form-actions${props.sticky ? " form-actions--sticky" : ""}`}
|
||||||
|
>
|
||||||
|
{props.children}
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,69 @@
|
|||||||
|
import type { ApiFailure } from "../../contracts/errors.js";
|
||||||
|
|
||||||
|
export type FormValues = Readonly<Record<string, unknown>>;
|
||||||
|
export type FieldName<Values extends FormValues> = Extract<keyof Values, string>;
|
||||||
|
export type FieldErrors<Values extends FormValues> = Readonly<
|
||||||
|
Partial<Record<FieldName<Values>, string>>
|
||||||
|
>;
|
||||||
|
|
||||||
|
export type FormResult<Value> =
|
||||||
|
| Readonly<{ ok: true; value: Value }>
|
||||||
|
| Readonly<{ ok: false; error: ApiFailure }>;
|
||||||
|
|
||||||
|
export type FormResultState =
|
||||||
|
| "idle"
|
||||||
|
| "success"
|
||||||
|
| "validation-error"
|
||||||
|
| "conflict"
|
||||||
|
| "unavailable";
|
||||||
|
|
||||||
|
export type MappedValidationFailure<Values extends FormValues> = Readonly<{
|
||||||
|
fieldErrors: FieldErrors<Values>;
|
||||||
|
formErrors: readonly string[];
|
||||||
|
}>;
|
||||||
|
|
||||||
|
const VALIDATION_COPY = Object.freeze({
|
||||||
|
REQUIRED: "필수 입력값입니다.",
|
||||||
|
too_small: "입력값이 너무 짧습니다.",
|
||||||
|
too_big: "입력값이 너무 깁니다.",
|
||||||
|
invalid_type: "입력 형식을 확인해 주세요.",
|
||||||
|
invalid_format: "입력 형식을 확인해 주세요.",
|
||||||
|
invalid_value: "허용된 값을 선택해 주세요.",
|
||||||
|
});
|
||||||
|
|
||||||
|
export function validationMessage(code: string): string {
|
||||||
|
return (
|
||||||
|
VALIDATION_COPY[code as keyof typeof VALIDATION_COPY] ??
|
||||||
|
"입력값을 확인해 주세요."
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function mapValidationFailureToFields<Values extends FormValues>(
|
||||||
|
failure: ApiFailure,
|
||||||
|
allowedFields: readonly FieldName<Values>[],
|
||||||
|
): MappedValidationFailure<Values> {
|
||||||
|
if (failure.kind !== "VALIDATION_REJECTED") {
|
||||||
|
return Object.freeze({ fieldErrors: Object.freeze({}), formErrors: [] });
|
||||||
|
}
|
||||||
|
const allowed = new Set<string>(allowedFields);
|
||||||
|
const fieldErrors: Partial<Record<FieldName<Values>, string>> = {};
|
||||||
|
const formErrors: string[] = [];
|
||||||
|
const issues = failure.validationIssues ?? [];
|
||||||
|
|
||||||
|
if (issues.length === 0) {
|
||||||
|
formErrors.push("입력값을 다시 확인해 주세요.");
|
||||||
|
}
|
||||||
|
for (const issue of issues) {
|
||||||
|
const field = issue.path.split(".").at(0) ?? "";
|
||||||
|
if (allowed.has(field)) {
|
||||||
|
const name = field as FieldName<Values>;
|
||||||
|
fieldErrors[name] ??= validationMessage(issue.code);
|
||||||
|
} else {
|
||||||
|
formErrors.push("서버가 확인하지 못한 입력 항목이 있습니다.");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return Object.freeze({
|
||||||
|
fieldErrors: Object.freeze(fieldErrors),
|
||||||
|
formErrors: Object.freeze([...new Set(formErrors)]),
|
||||||
|
});
|
||||||
|
}
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user