model.dictionary.ts

dictionary 파일은 module의 언어 레이어입니다. model field, insight 값, query, sort option, enum, slice, endpoint, error, module 전용 UI 문구에 사용자에게 보이는 이름을 붙입니다.

현재 패턴은 type 기반입니다. dictionary key는 임의의 번역 문자열이 아니라 constant, document filter, slice, endpoint의 shape을 따라가야 합니다.

Model dictionary 패턴

일반 document model에는 modelDictionary를 사용합니다. 보통 model 이름에서 시작해서 field label, insight label, document query/sort label, enum 값, signal label, error, custom UI text를 차례로 추가합니다.

ticket.dictionary.ts

.model

constant model의 field에 label을 붙입니다. id, createdAt, updatedAt, removedAt 같은 base field는 자동으로 추가됩니다.

.insight

reporting field에 label을 붙입니다. base insight인 count는 자동으로 추가됩니다.

.query / .sort

document filter option에 label을 붙입니다. any, latest, oldest 같은 base query/sort label이 포함됩니다.

Dictionary 사용하기

dictionary를 선언한 뒤에는 대부분 generated helper를 통해 사용합니다. client component는 usePage()로 번역 label을 읽고, server code는 error key로 Err를 던지며, client store는 msg로 번역된 toast message를 보여줍니다.

Client UI

Server Error

Client Toast

Generated dictionary 확장

app이 generated 또는 library model을 확장한다면 dictionary도 함께 확장합니다. ...user.dictionaries를 넘기면 base dictionary entry를 유지하면서 app이 custom field, endpoint, phrase만 추가할 수 있습니다.

user.dictionary.ts

Scalar와 service dictionary

module 형태에 따라 dictionary builder를 선택합니다. document model은 modelDictionary, embedded scalar 값은 scalarDictionary, service-only module은 serviceDictionary를 사용합니다.

modelDictionary

model, insight, query, sort, slice, endpoint, error, custom 번역이 필요한 document model에 사용합니다.

scalarDictionary

embedded scalar 값에 사용합니다. 보통 model field, enum 값, error, 작은 custom text 정도만 필요합니다.

serviceDictionary

document model이 없는 service module 또는 app-level dictionary에 사용합니다.

coordinate.dictionary.ts

util.dictionary.ts