refactor(ids): generate content id unions from the structure documents

scripts/generate-content-types.ts writes the gitignored src/types/content-ids.ts (id unions + project category values) from the four structure documents; wired as generate:ids / predev / prebuild / prepare. src/types/index.ts re-exports them type-only and keeps only the code-owned unions.

Edit mode now writes JSON only: the v4 union leg is deleted (saveIdUnions, diffIdsWithUnions, applyUnionChanges, readUnionBlock, the EditBar union card, edit.union.* labels). Validator rule 7 requires a label for every category a project uses, in both ui/projects.json documents.

Tests: smoke-draft.ts 11/11 (rename re-sluging + category-label rule replace checks 9-12); new scripts/smoke-generated-ids.ts 7/7. Verified: pnpm build (chunk names unchanged, no runtime reference to the generated module), lint with no new warnings, validate:content, resume HTML byte-identical before/after with identical documents.

Docs: spec-v5-generated-content-ids.md added; spec-v4-live-edit.md §3.1 marked superseded + §12 row 23; AGENTS.md and README.md updated.
This commit is contained in:
dong.nguyen committed 2026-10-24 13:16:18 +07:00
1 parent 1a1fc14d0e
commit a3662a9521
18 files changed
+732 -357

No files matched your search

+3 -5
View File
@@ -24,7 +24,7 @@ type EditBarProps = {
saving: boolean;
saveStopped: boolean;
saveResults: DocSaveResult[];
unionNote: 'ok' | 'failed' | null;
labelsUnavailable: boolean;
draftRestored: boolean;
branch: string;
getConflictFields: (id: DraftDocId) => ConflictField[];
@@ -56,7 +56,7 @@ export function EditBar({
saving,
saveStopped,
saveResults,
unionNote,
labelsUnavailable,
draftRestored,
branch,
getConflictFields,
@@ -248,9 +248,7 @@ export function EditBar({
</ul>
)}
{unionNote && (
<p className="edit-bar-note">{unionNote === 'ok' ? s.unionNote : s.unionFailed}</p>
)}
{labelsUnavailable && <p className="edit-bar-note">{s.labelsUnavailable}</p>}
{allWritten && !dirty && (
<p className="edit-bar-note">
{branch === DEFAULT_BRANCH ? s.deployQueued : s.mergeHint}
+34 -31
View File
@@ -3,7 +3,7 @@
// master documents, holds the draft, and re-wraps the tree in an
// I18nProvider override — the seven routes ARE the preview. Visitors never
// mount this component; its code is never in the entry chunk (§7 P3.4).
import { useCallback, useEffect, useMemo, useRef, useState } from 'react';
import { useCallback, useEffect, useMemo, useState } from 'react';
import type { ReactNode } from 'react';
import { useLocation, useNavigate } from 'react-router';
import { useLanguage } from '@/hooks/useLanguage';
@@ -13,12 +13,9 @@ import type { ResolvedContent } from '@/i18n';
import {
DRAFT_DOCS,
DraftStore,
TYPES_FILE,
bundledBase,
fetchDoc,
fetchTextFile,
saveDraft,
saveIdUnions,
recordForTitlePath,
} from '@/i18n/draft';
import type { DocBase, DocSaveResult, DraftDocId } from '@/i18n/draft';
@@ -34,11 +31,26 @@ import {
} from '@/i18n/edit-mode';
import { EditContext } from '@/hooks/useEdit';
import type { EditApi } from '@/hooks/useEdit';
import type { ContentIssue } from '@/i18n/validate';
import type { CategoryLabels, ContentIssue } from '@/i18n/validate';
import { EditBar } from './EditBar';
type Phase = 'authenticating' | 'loading' | 'ready' | 'offline';
// The category labels are read-only UI documents (spec-v4-data-organization §4);
// rule 7 compares a project's category against them on the branch being edited
// (spec-v5 §5.4), so they are fetched beside the draft documents instead of
// taken from this bundle.
const LABEL_FILES: Record<'vi' | 'en', string> = {
vi: 'src/i18n/locales/vi/ui/projects.json',
en: 'src/i18n/locales/en/ui/projects.json',
};
const categoryMap = (data: unknown): Record<string, unknown> => {
if (!data || typeof data !== 'object' || !('categories' in data)) return {};
const categories = data.categories;
if (typeof categories !== 'object' || categories === null || Array.isArray(categories)) return {};
return Object.fromEntries(Object.entries(categories));
};
export default function EditModeShell({ children }: { children: ReactNode }) {
const navigate = useNavigate();
const location = useLocation();
@@ -48,7 +60,6 @@ export default function EditModeShell({ children }: { children: ReactNode }) {
// render reads it legally, and `revision` is the invalidation counter that
// re-derives everything the draft feeds to the UI.
const [store, setStore] = useState<DraftStore | null>(null);
const typesRef = useRef<{ source: string; sha: string } | null>(null);
const [phase, setPhase] = useState<Phase>('authenticating');
const [branch, setBranch] = useState<string>(DEFAULT_BRANCH);
const [resolved, setResolved] = useState<Record<'vi' | 'en', ResolvedContent> | null>(null);
@@ -60,7 +71,7 @@ export default function EditModeShell({ children }: { children: ReactNode }) {
const [saveResults, setSaveResults] = useState<DocSaveResult[]>([]);
const [saving, setSaving] = useState(false);
const [saveStopped, setSaveStopped] = useState(false);
const [unionNote, setUnionNote] = useState<'ok' | 'failed' | null>(null);
const [labelsUnavailable, setLabelsUnavailable] = useState(false);
const stripEditQuery = useCallback(() => {
const params = new URLSearchParams(location.search);
@@ -123,7 +134,21 @@ export default function EditModeShell({ children }: { children: ReactNode }) {
}
if (!bases) bases = bundledBase();
const created = new DraftStore(bases);
// Rule 7's inputs. A failed read leaves the labels null: the save bar
// says the label check could not run, and the rule is skipped rather
// than guessed at from a bundle that may predate the branch.
let labels: CategoryLabels | null = null;
try {
const [viLabels, enLabels] = await Promise.all([
fetchDoc(LABEL_FILES.vi, branch),
fetchDoc(LABEL_FILES.en, branch),
]);
labels = { vi: categoryMap(viLabels.data), en: categoryMap(enLabels.data) };
} catch {
setLabelsUnavailable(true);
}
const created = new DraftStore(bases, labels);
const stored = sessionStorage.getItem(DRAFT_STORAGE);
if (stored) {
@@ -136,13 +161,6 @@ export default function EditModeShell({ children }: { children: ReactNode }) {
}
}
try {
const file = await fetchTextFile(TYPES_FILE, branch);
typesRef.current = { source: file.text, sha: file.sha };
} catch {
typesRef.current = null;
}
if (cancelled) return;
setStore(created);
setPhase(offline ? 'offline' : 'ready');
@@ -271,7 +289,6 @@ export default function EditModeShell({ children }: { children: ReactNode }) {
}
setSaving(true);
setSaveStopped(false);
setUnionNote(null);
setSaveResults([]);
const { results, stoppedEarly } = await saveDraft(store, (result) => {
setSaveResults((prev) => [...prev, result]);
@@ -280,20 +297,6 @@ export default function EditModeShell({ children }: { children: ReactNode }) {
const written = new Set(results.filter((r) => r.status === 'written').map((r) => r.id));
const conflicted = results.filter((r) => r.status === 'conflict').map((r) => r.id);
setConflicts((prev) => [...new Set([...prev.filter((id) => !written.has(id)), ...conflicted])]);
// The third leg of §3.1: bring the unions to the ids whose documents
// landed — appended when a record was added, dropped when one was deleted.
const types = typesRef.current;
if (types) {
const union = await saveIdUnions(store, types, branch);
if (union) {
if (union.failed !== undefined) setUnionNote('failed');
else {
typesRef.current = { source: union.source!, sha: union.sha! };
setUnionNote('ok');
}
}
}
setSaving(false);
refresh(store);
}, [store, phase, refresh, branch]);
@@ -394,7 +397,7 @@ export default function EditModeShell({ children }: { children: ReactNode }) {
saving={saving}
saveStopped={saveStopped}
saveResults={saveResults}
unionNote={unionNote}
labelsUnavailable={labelsUnavailable}
draftRestored={draftRestored}
branch={branch}
getConflictFields={(id) => store.conflictFields(id)}