Files
cv/src/i18n/dict-types.ts
T

109 lines
3.1 KiB
TypeScript
Raw Normal View History

// Document types for the content and UI JSON (spec-v4 §3.2–§3.3).
// Structure documents are language-neutral; text documents are per language.
// Authoring invariants that JSON cannot carry as comments live here and in the
// loaders.
import type {
ExperienceId,
PhilosophyId,
ProjectCategory,
ProjectId,
SkillGroupId,
} from '../types/index';
import uiViJson from './locales/vi/ui.json';
// --- structure (src/data/*.json) ---
export type ProjectSectionStructure = {
id: string;
type: 'text' | 'diagram' | 'metrics' | 'code';
};
export type ProjectStructure = {
id: ProjectId;
category: ProjectCategory;
role: string;
technologies: string[];
metrics?: string[];
featured: boolean;
sections: ProjectSectionStructure[];
};
export type ExperienceStructure = {
id: ExperienceId;
company: string;
duration: string;
location?: string;
variant?: 'current' | 'gap';
logo?: string;
};
export type SkillGroupStructure = { id: SkillGroupId; skills: string[] };
export type ProfileStructure = {
firstName: string;
lastName: string;
email: string;
githubUrl: string;
linkedinUrl: string;
githubHandle: string;
linkedinHandle: string;
telegramUrl: string;
telegramHandle: string;
currentInterests: string[];
roles: string[];
// The display name is localized (D6) and therefore lives in the text
// documents, never here; only the language-neutral name parts stay.
philosophy: Array<{ id: PhilosophyId; keywords: string[] }>;
};
// --- text (src/i18n/locales/{vi,en}/content.json) ---
// Plain-text segments; markup is a rendering concern (D9), never content.
export type TaglineSegment = { text: string; emphasis?: boolean };
export type SectionText = { title: string; content: string };
// Section keys are validated against each project's structure array by the
// validator (§3.6) — section ids collide across projects, so there is no
// global SectionId union (§3.1).
export type ProjectText = {
title: string;
summary: string;
sections: Record<string, SectionText>;
};
export type ExperienceText = { title: string; responsibilities: string[] };
export type SkillGroupText = { title: string };
export type ProfileText = {
name: string;
title: string;
bio: string;
tagline: TaglineSegment[];
philosophy: Record<PhilosophyId, { title: string; description: string }>;
};
export type ContentVi = {
profile: ProfileText;
skills: Record<SkillGroupId, SkillGroupText>;
experience: Record<ExperienceId, ExperienceText>;
projects: Record<ProjectId, ProjectText>;
};
// Defined here — PartialDeep is NOT a TypeScript builtin.
// Objects: every key optional + recursed. Arrays: atomic (whole-array
// fallback, never per-item).
type PartialDeep<T> = T extends readonly unknown[]
? T
: T extends object
? { [K in keyof T]?: PartialDeep<T[K]> }
: T;
export type ContentEn = { [K in keyof ContentVi]?: PartialDeep<ContentVi[K]> };
// --- UI (src/i18n/locales/{vi,en}/ui.json) ---
// Derived from the complete Vietnamese tree; the en import is checked against
// this type in index.ts — both files are complete by construction (§3.3).
export type UIDict = typeof uiViJson;