@wipco/sdui 0.1.0

package/dist/meta.d.ts

@@ -0,0 +1,343 @@
+import { a as SduiPropValue, h as SduiNode } from './types-D5Tkrynd.js';
+
+/**
+ * 시각 빌더용 컴포넌트 메타데이터 스키마.
+ *
+ * 레지스트리(`registry.tsx`)는 `{이름: 컴포넌트}` 맵일 뿐이라, 팔레트에 무엇을 띄울지·
+ * 속성 패널에 어떤 입력을 그릴지·이 노드에 저 노드를 떨어뜨려도 되는지를 알 방법이 없다.
+ * 그 빠진 정보를 채우는 것이 이 모듈이다.
+ *
+ * **런타임 번들에 실리면 안 된다.** 렌더러는 스펙을 해석해 컴포넌트에 넘길 뿐이라
+ * 이 데이터가 전혀 필요 없다. 그래서 `@wipco/sdui/meta` 별도 진입점으로 나가 있고,
+ * 이 디렉터리의 어떤 파일도 컴포넌트 구현이나 렌더러를 **값으로** import하지 않는다
+ * (타입만 가져온다 — `import type`은 컴파일 후 완전히 사라진다).
+ * 반대로 렌더러 쪽에서 이 모듈을 import해서도 안 된다.
+ */
+
+/** 팔레트 그룹. 값은 `SDUI_CATEGORIES`에서 한국어 라벨로 풀린다. */
+type SduiCategory = 'layout' | 'input' | 'display' | 'data' | 'feedback' | 'logic';
+/**
+ * 속성 패널이 그릴 입력의 종류.
+ *
+ * `object`/`array`는 과제에 명시된 아홉 종류 밖이지만 뺄 수 없었다 —
+ * `Table.columns`, `Select.options`, `Form.rules`처럼 **실제 스펙이 쓰는 프롭의
+ * 상당수가 구조체**라서, 이 둘이 없으면 빌더가 그 값을 편집도 보존도 못 한다.
+ * 대신 구조를 눈감고 넘기지 않도록 `item`/`fields`로 내부 형태까지 기술한다.
+ */
+type SduiPropKind = 'string' | 'number' | 'boolean'
+/** 정해진 후보 중 하나 — `options` 참조 */
+ | 'enum'
+/** CSS 색상 문자열 */
+ | 'color'
+/** `ICON_PATHS`에 등록된 아이콘 이름 */
+ | 'icon'
+/** ReactNode 자리 — 문자열이거나 `slots.<name>`으로 넘긴 노드 트리 */
+ | 'node'
+/** `on*` 핸들러 자리 — {@link SduiAction} 또는 액션 배열 */
+ | 'action'
+/**
+ * 리터럴이 거의 의미 없는 자리 — 편집기는 리터럴 입력 대신
+ * 바인딩 선택기($state/$item/$calc)를 기본으로 띄운다. (예: `Show.when`)
+ */
+ | 'binding'
+/** 키-값 구조체 — `fields`가 있으면 그 필드들로, 없으면 JSON 편집기로 */
+ | 'object'
+/** 동형 항목의 배열 — `item`의 필드로 행 편집기를 그린다 */
+ | 'array';
+interface SduiEnumOption {
+    /** 스펙에 들어가는 값. Grid.columns처럼 숫자 어휘도 있어 number를 허용한다. */
+    value: string | number;
+    /** 한국어 표시 라벨 */
+    label: string;
+    description?: string;
+    /** 구현에는 없는데 실제 스펙이 쓰고 있는 값 — 지우지 말고 경고만 한다 */
+    legacy?: boolean;
+}
+/** 속성 패널의 섹션 구분. */
+type SduiPropGroup = 'content' | 'appearance' | 'behavior' | 'layout' | 'data' | 'validation';
+interface SduiPropMeta {
+    name: string;
+    kind: SduiPropKind;
+    /** 한국어 표시명 */
+    label: string;
+    /** 한국어 설명 — 속성 패널의 도움말 */
+    description?: string;
+    required?: boolean;
+    /** 컴포넌트 구현의 기본값. 편집기는 이 값과 같으면 스펙에서 프롭을 지워도 된다. */
+    default?: SduiPropValue;
+    /** kind가 'enum'일 때의 후보 */
+    options?: readonly SduiEnumOption[];
+    /**
+     * `$state`/`$item`/`$calc` 참조를 받아도 되는가.
+     *
+     * 렌더러의 `resolveValue`는 프롭 값 어디에 참조가 있든 풀어 주므로 기술적으로는
+     * 전부 바인딩 가능하다. 이 플래그는 "편집기가 바인딩 선택기를 **권해야 하는가**"를
+     * 뜻한다 — 값이 데이터에서 오는 자리는 true, 순수 표현 프롭은 생략한다.
+     */
+    bindable?: boolean;
+    /** kind가 'node'이고 `slots.<name>`으로도 줄 수 있는 프롭 */
+    slot?: boolean;
+    /** kind가 'action'일 때 핸들러에 들어오는 이벤트 값 설명 */
+    eventArg?: string;
+    /** kind가 'array'일 때 원소의 필드 정의 */
+    item?: readonly SduiPropMeta[];
+    /** kind가 'object'일 때 필드 정의. 없으면 자유 형식(JSON 편집기) */
+    fields?: readonly SduiPropMeta[];
+    group?: SduiPropGroup;
+    /** 기본 패널에서 접어 두는 고급 프롭 */
+    advanced?: boolean;
+    /**
+     * 이 라이브러리의 구현에는 없지만 **실제 ERP 스펙이 쓰고 있는** 프롭.
+     *
+     * 빌더가 모르는 프롭을 만나면 지워 버리는 것이 가장 위험한 실패라서, 구현과
+     * 어긋나더라도 메타데이터에는 남긴다. `description`에 어긋난 이유를 적어 둔다.
+     */
+    legacy?: boolean;
+}
+interface SduiChildrenMeta {
+    /** 기본 슬롯(children)을 받는가 */
+    accepts: boolean;
+    /** 문자열 자식(텍스트)을 받는가 */
+    text?: boolean;
+    /** 한국어 설명 — 캔버스의 드롭 존 안내 */
+    label?: string;
+    /** 허용 컴포넌트 화이트리스트. 생략하면 제한 없음 */
+    allow?: readonly string[];
+    /** 금지 컴포넌트 블랙리스트 */
+    deny?: readonly string[];
+}
+interface SduiSlotMeta {
+    name: string;
+    /** 한국어 표시명 */
+    label: string;
+    description?: string;
+    text?: boolean;
+    allow?: readonly string[];
+}
+/** 캔버스의 크기 조정 핸들이 무엇을 건드릴지. */
+interface SduiResizeMeta {
+    /**
+     * - `none`   크기 조정 불가 (핸들을 그리지 않는다)
+     * - `enum`   단계형 `size` 프롭 — 핸들을 끌면 후보 사이를 스냅한다
+     * - `numeric` 숫자 프롭 직접 조정 (`height`, `rows` 등)
+     * - `style`  `style.width` / `style.height`를 직접 쓴다
+     */
+    kind: 'none' | 'enum' | 'numeric' | 'style';
+    /** kind가 'enum'일 때 조정할 프롭 이름 */
+    prop?: string;
+    /** kind가 'enum'일 때 작은 값 → 큰 값 순서의 후보 */
+    values?: readonly string[];
+    /** kind가 'numeric'일 때 가로/세로에 대응하는 프롭 */
+    widthProp?: string;
+    heightProp?: string;
+    /** kind가 'numeric'일 때의 단위 — 'row'는 Textarea처럼 줄 수로 세는 경우 */
+    unit?: 'px' | 'row';
+    axis?: 'x' | 'y' | 'both';
+}
+interface SduiComponentMeta {
+    /** 스펙의 `component` 값 — 레지스트리 키와 정확히 같아야 한다 */
+    name: string;
+    /** 팔레트에 보일 한국어 표시명 */
+    label: string;
+    category: SduiCategory;
+    /** `ICON_PATHS`에 등록된 이름 (없는 이름이면 Icon이 점으로 대체한다) */
+    icon: string;
+    /** 한국어 한 줄 설명 */
+    description: string;
+    props: readonly SduiPropMeta[];
+    /**
+     * 노드 트리를 받는 이름 붙은 슬롯 중, **텍스트로는 채울 수 없는** 것들.
+     * `title`처럼 문자열로도 노드로도 줄 수 있는 자리는 props 쪽에 `slot: true`로 있다
+     * (한 프롭을 두 곳에 중복해 적지 않으려는 것 — `slotNamesOf`가 둘을 합쳐 준다).
+     */
+    slots?: readonly SduiSlotMeta[];
+    children: SduiChildrenMeta;
+    /** 팔레트에서 끌어다 놓을 때 삽입할 조각. 그 자체로 렌더 가능해야 한다. */
+    preset: SduiNode;
+    resize: SduiResizeMeta;
+    /** 특정 부모의 슬롯 안에서만 의미가 있는 컴포넌트 (예: Actions) */
+    slotOnly?: boolean;
+    /** 팔레트에서 숨긴다 — 어휘에는 있지만 직접 배치할 물건이 아닌 경우 */
+    hidden?: boolean;
+}
+
+/**
+ * 기본 어휘(`defaultRegistry`) 39종의 빌더 메타데이터.
+ *
+ * 프롭 목록은 `components.tsx`·`primitives.tsx`·`SduiForm.tsx`·`Can.tsx`·
+ * `DatePicker.tsx`·`search/SduiSearchResults.tsx`의 **실제 프롭 인터페이스**와,
+ * ERP 스펙 85개를 훑어 뽑은 **실사용 프롭 집합**을 합집합으로 덮는다.
+ * 구현에 없는데 스펙이 쓰고 있는 프롭은 지우지 않고 `legacy: true`로 남긴다 —
+ * 빌더가 모르는 프롭을 지워 버리는 것이 이 작업에서 가장 위험한 실패라서다.
+ * 처음 표시해 둔 6건(Alert.bar · Input.trailing · IconButton.variant ·
+ * ProgressBar.showValue · ProgressBar.tone="info" · Spacer.size)은 스펙을 고치는 대신
+ * 라이브러리 쪽에 구현해서 표시를 뗐다. 지금 남은 `legacy`는 없다.
+ *
+ * 값 import는 하나도 없다(전부 `import type`). 이 파일이 컴포넌트를 값으로
+ * 끌어오는 순간 메타데이터 진입점이 런타임 번들을 통째로 데려온다.
+ */
+
+declare const ActionsMeta: SduiComponentMeta;
+declare const CardMeta: SduiComponentMeta;
+declare const ColMeta: SduiComponentMeta;
+declare const DividerMeta: SduiComponentMeta;
+declare const GridMeta: SduiComponentMeta;
+declare const PageHeadMeta: SduiComponentMeta;
+declare const RowMeta: SduiComponentMeta;
+declare const SectionMeta: SduiComponentMeta;
+declare const SpacerMeta: SduiComponentMeta;
+declare const TabsMeta: SduiComponentMeta;
+declare const ButtonMeta: SduiComponentMeta;
+declare const CheckboxMeta: SduiComponentMeta;
+declare const DatePickerMeta: SduiComponentMeta;
+declare const DateRangePickerMeta: SduiComponentMeta;
+declare const FieldMeta: SduiComponentMeta;
+declare const FormMeta: SduiComponentMeta;
+declare const IconButtonMeta: SduiComponentMeta;
+declare const InputMeta: SduiComponentMeta;
+declare const SelectMeta: SduiComponentMeta;
+declare const SwitchMeta: SduiComponentMeta;
+declare const TextareaMeta: SduiComponentMeta;
+declare const BadgeMeta: SduiComponentMeta;
+declare const IconMeta: SduiComponentMeta;
+declare const KeyValueListMeta: SduiComponentMeta;
+declare const StatCardMeta: SduiComponentMeta;
+declare const TagMeta: SduiComponentMeta;
+declare const TextMeta: SduiComponentMeta;
+declare const PaginationMeta: SduiComponentMeta;
+declare const TableMeta: SduiComponentMeta;
+declare const SearchResultsMeta: SduiComponentMeta;
+declare const RemoteSearchResultsMeta: SduiComponentMeta;
+declare const AlertMeta: SduiComponentMeta;
+declare const DialogMeta: SduiComponentMeta;
+declare const EmptyStateMeta: SduiComponentMeta;
+declare const ProgressBarMeta: SduiComponentMeta;
+declare const SpinnerMeta: SduiComponentMeta;
+declare const ToastMeta: SduiComponentMeta;
+declare const CanMeta: SduiComponentMeta;
+declare const ShowMeta: SduiComponentMeta;
+/**
+ * 기본 어휘의 메타데이터.
+ *
+ * 타입이 `Record<SduiComponentName, ...>`이라, 레지스트리에 컴포넌트를 넣고 여기를
+ * 빠뜨리면 "속성 없음" 에러가, 여기에만 있고 레지스트리에 없으면 초과 프로퍼티 에러가
+ * 컴파일 시점에 난다 — 둘이 어긋난 채로는 빌드가 통과하지 않는다.
+ *
+ * 팔레트처럼 전체가 필요한 곳이 아니면 개별 export(`ButtonMeta` 등)를 쓰는 편이
+ * 번들에 유리하다 — 이 객체를 참조하는 순간 39종이 전부 따라온다.
+ */
+declare const coreComponentMeta: {
+    Actions: SduiComponentMeta;
+    Alert: SduiComponentMeta;
+    Badge: SduiComponentMeta;
+    Button: SduiComponentMeta;
+    Can: SduiComponentMeta;
+    Card: SduiComponentMeta;
+    Checkbox: SduiComponentMeta;
+    Col: SduiComponentMeta;
+    DatePicker: SduiComponentMeta;
+    DateRangePicker: SduiComponentMeta;
+    Dialog: SduiComponentMeta;
+    Divider: SduiComponentMeta;
+    EmptyState: SduiComponentMeta;
+    Field: SduiComponentMeta;
+    Form: SduiComponentMeta;
+    Grid: SduiComponentMeta;
+    Icon: SduiComponentMeta;
+    IconButton: SduiComponentMeta;
+    Input: SduiComponentMeta;
+    KeyValueList: SduiComponentMeta;
+    PageHead: SduiComponentMeta;
+    Pagination: SduiComponentMeta;
+    ProgressBar: SduiComponentMeta;
+    RemoteSearchResults: SduiComponentMeta;
+    Row: SduiComponentMeta;
+    SearchResults: SduiComponentMeta;
+    Section: SduiComponentMeta;
+    Select: SduiComponentMeta;
+    Show: SduiComponentMeta;
+    Spacer: SduiComponentMeta;
+    Spinner: SduiComponentMeta;
+    StatCard: SduiComponentMeta;
+    Switch: SduiComponentMeta;
+    Table: SduiComponentMeta;
+    Tabs: SduiComponentMeta;
+    Tag: SduiComponentMeta;
+    Text: SduiComponentMeta;
+    Textarea: SduiComponentMeta;
+    Toast: SduiComponentMeta;
+};
+
+/**
+ * `@wipco/sdui/rich` 어휘(Chart·MapPreview)의 빌더 메타데이터.
+ *
+ * core 메타데이터와 파일을 나눈 이유는 rich 컴포넌트를 얹지 않은 소비자가
+ * 이 데이터를 받지 않게 하려는 것이다 — `rich.ts`가 core에서 분리된 것과 같은 이유.
+ * 여기도 값 import는 없다(`import type`만).
+ */
+
+declare const ChartMeta: SduiComponentMeta;
+declare const MapPreviewMeta: SduiComponentMeta;
+/**
+ * rich 어휘의 메타데이터. core와 같은 방식으로 `richComponents`와 키가 어긋나면
+ * 컴파일 에러가 난다.
+ */
+declare const richComponentMeta: {
+    Chart: SduiComponentMeta;
+    MapPreview: SduiComponentMeta;
+};
+
+/**
+ * 렌더러 내장 어휘의 메타데이터.
+ *
+ * ForEach는 레지스트리에 없다 — `SduiRenderer`가 노드를 보고 직접 반복 스코프를
+ * 만든다. 그래서 core/rich처럼 레지스트리 키와 타입으로 대조할 대상이 없고,
+ * 대신 여기 한 곳에 모아 둔다. 렌더러에 내장 어휘가 늘면 여기도 늘려야 한다
+ * (`scripts/check-meta.mts`가 `SduiRenderer.tsx`를 훑어 누락을 잡는다).
+ */
+
+declare const ForEachMeta: SduiComponentMeta;
+/** 렌더러 내장 어휘의 메타데이터 묶음. */
+declare const builtinComponentMeta: {
+    ForEach: SduiComponentMeta;
+};
+
+/**
+ * `@wipco/sdui/meta` — 시각 페이지 빌더가 쓰는 컴포넌트 메타데이터.
+ *
+ * **런타임(`@wipco/sdui`)과 완전히 분리된 진입점이다.** 렌더러는 이 데이터를
+ * 전혀 참조하지 않으므로, 스펙만 렌더하는 소비자의 번들에는 한 바이트도 실리지 않는다.
+ * 반대로 이 디렉터리는 컴포넌트를 값으로 import하지 않아서, 빌더가 메타데이터만
+ * 가져다 팔레트를 그릴 때 컴포넌트 구현을 끌고 오지도 않는다.
+ *
+ * 팔레트 전체가 필요하지 않다면 개별 export(`ButtonMeta` 등)를 직접 import하는 편이
+ * 낫다 — 아래 `allComponentMeta` 같은 묶음은 참조하는 순간 어휘 전체를 데려온다.
+ */
+
+/** 팔레트 그룹의 표시 순서와 한국어 라벨. */
+declare const SDUI_CATEGORIES: ReadonlyArray<{
+    id: SduiCategory;
+    label: string;
+}>;
+/**
+ * 기본 어휘 + rich 어휘 + 렌더러 내장 어휘 전체.
+ * 편집기처럼 어휘 전부를 다뤄야 하는 쪽에서 쓴다.
+ */
+declare const allComponentMeta: Record<string, SduiComponentMeta>;
+/** 스펙의 `component` 이름으로 메타데이터를 찾는다. 없으면 undefined. */
+declare function getComponentMeta(name: string, catalog?: Record<string, SduiComponentMeta>): SduiComponentMeta | undefined;
+/**
+ * 이 컴포넌트가 받는 슬롯 이름 전부.
+ *
+ * `slots`(컴포넌트만 넣을 수 있는 자리)와 `props` 중 `slot: true`인 것(문자열로도
+ * 노드로도 줄 수 있는 자리)이 나뉘어 있어서, 드롭 대상 목록을 만들 때는 둘을 합쳐야 한다.
+ */
+declare function slotNamesOf(meta: SduiComponentMeta): string[];
+/** 팔레트에 실제로 노출할 항목만 분류별로 묶는다(hidden 제외). */
+declare function paletteGroups(catalog?: Record<string, SduiComponentMeta>): Array<{
+    id: SduiCategory;
+    label: string;
+    items: SduiComponentMeta[];
+}>;
+
+export { ActionsMeta, AlertMeta, BadgeMeta, ButtonMeta, CanMeta, CardMeta, ChartMeta, CheckboxMeta, ColMeta, DatePickerMeta, DateRangePickerMeta, DialogMeta, DividerMeta, EmptyStateMeta, FieldMeta, ForEachMeta, FormMeta, GridMeta, IconButtonMeta, IconMeta, InputMeta, KeyValueListMeta, MapPreviewMeta, PageHeadMeta, PaginationMeta, ProgressBarMeta, RemoteSearchResultsMeta, RowMeta, SDUI_CATEGORIES, type SduiCategory, type SduiChildrenMeta, type SduiComponentMeta, type SduiEnumOption, type SduiPropGroup, type SduiPropKind, type SduiPropMeta, type SduiResizeMeta, type SduiSlotMeta, SearchResultsMeta, SectionMeta, SelectMeta, ShowMeta, SpacerMeta, SpinnerMeta, StatCardMeta, SwitchMeta, TableMeta, TabsMeta, TagMeta, TextMeta, TextareaMeta, ToastMeta, allComponentMeta, builtinComponentMeta, coreComponentMeta, getComponentMeta, paletteGroups, richComponentMeta, slotNamesOf };