@rdbms-erd/core 0.1.2 → 0.1.4

package/dist/index.d.ts

@@ -0,0 +1,237 @@
+type AlignCommand = "left" | "h-center" | "right" | "top" | "v-center" | "bottom" | "h-gap" | "v-gap";
+/**
+ * 멀티 선택된 노드 위치를 bounding box 기준으로 정렬/분배한다.
+ * positions는 id -> 좌표 맵이며, 반환값은 동일 키에 갱신된 좌표만 포함한다.
+ */
+declare function alignNodePositions(selectedIds: string[], positions: Record<string, {
+    x: number;
+    y: number;
+}>, command: AlignCommand): Record<string, {
+    x: number;
+    y: number;
+}>;
+
+type BuiltinRdbmsDialect = "mssql" | "oracle" | "mysql" | "postgres" | "sqlite";
+type RdbmsDialect = BuiltinRdbmsDialect | (string & {});
+
+declare const LOGICAL_DATA_TYPES: readonly ["TEXT", "DATE", "TIME", "DATETIME", "NUMBER", "DECIMAL", "FLOAT", "BOOLEAN", "JSON", "UUID", "BINARY"];
+type LogicalDataType = (typeof LOGICAL_DATA_TYPES)[number];
+interface ColumnModel {
+    id: string;
+    logicalName: string;
+    physicalName: string;
+    /** 컬럼 설명(업무/도메인 메모). */
+    description?: string;
+    logicalType: LogicalDataType;
+    physicalType: string;
+    defaultValue?: string;
+    nullable: boolean;
+    isPrimaryKey?: boolean;
+    isForeignKey?: boolean;
+    referencesPrimaryColumnId?: string;
+    /** 테이블 노드에서 해당 컬럼 행 배경색 */
+    color?: string;
+}
+interface TableModel {
+    id: string;
+    logicalName: string;
+    physicalName: string;
+    /** 테이블 설명(업무/도메인 메모). */
+    description?: string;
+    /** Dialect-dependent schema/catalog qualifier (e.g. `public`, `dbo`). */
+    schemaName?: string;
+    color?: string;
+    columns: ColumnModel[];
+}
+interface RelationshipModel {
+    id: string;
+    /** 참조 원본(PK) 테이블 */
+    sourceTableId: string;
+    /** 참조 대상(FK) 테이블 */
+    targetTableId: string;
+    /** source(PK) 컬럼 id */
+    sourceColumnId?: string;
+    /** target(FK) 컬럼 id */
+    targetColumnId?: string;
+    /** 연결 시 생성된 FK 컬럼인지 여부(삭제 시 컬럼 정리용) */
+    autoCreatedTargetColumn?: boolean;
+    /** FK가 최초로 연결된 PK 컬럼 id(컬럼명 변경과 무관) */
+    originPkColumnId?: string;
+    /** 타깃 cardinality. 기본 1:N */
+    cardinality?: "1:1" | "1:N";
+    /** 출발(소스) 엣지의 테이블 내부 절대 Y 좌표(px). */
+    sourceLineY?: number;
+    /** @deprecated legacy ratio(0~1). sourceLineY가 없을 때만 fallback으로 사용 */
+    sourceLineRatio?: number;
+    /** 관계선의 중간 꺾임 위치 비율(0~1). 두 테이블 앵커 사이의 비율로 저장한다. */
+    linePivotRatio?: number;
+    /** true이면 캔버스에서 해당 관계선을 기본적으로 숨긴다. 툴의「숨긴 관계선 보기」로만 표시 가능. */
+    canvasLineHidden?: boolean;
+}
+/**
+ * 캔버스에 관계선을 그릴지 여부.
+ * - `revealHiddenLines === false`: `canvasLineHidden`인 관계는 제외.
+ * - `revealHiddenLines === true`: 숨김 처리된 관계도 함께 그린다(표시만, 속성은 바꾸지 않음).
+ */
+declare function isRelationshipLineRenderable(rel: RelationshipModel, revealHiddenLines: boolean): boolean;
+/** 구버전 `ColumnModel.showFkRelationLine === false`를 관계의 `canvasLineHidden`으로 옮긴 뒤 컬럼 플래그를 제거한다. */
+declare function migrateLegacyFkLineVisibility(model: DesignModel): void;
+interface IndexModel {
+    id: string;
+    tableId: string;
+    name: string;
+    columns: string[];
+    unique: boolean;
+}
+interface DiagramLayout {
+    nodePositions: Record<string, {
+        x: number;
+        y: number;
+    }>;
+}
+interface DesignModel {
+    dialect: RdbmsDialect;
+    tables: TableModel[];
+    relationships: RelationshipModel[];
+    indexes: IndexModel[];
+}
+interface DesignDocument {
+    schemaVersion: number;
+    model: DesignModel;
+    layout: DiagramLayout;
+    settings?: Record<string, unknown>;
+}
+interface DialectCapability {
+    supportsSchema: boolean;
+}
+type DdlStyleQuote = "double" | "backtick" | "bracket";
+type DdlStyleBooleanLiteral = "trueFalse" | "oneZero";
+interface DdlStyle {
+    quote: DdlStyleQuote;
+    boolLiteral?: DdlStyleBooleanLiteral;
+    nowKeyword?: string;
+}
+interface LogicalTypeMeta {
+    id: LogicalDataType;
+    label?: string;
+    defaultPhysicalType: string;
+}
+interface DialectMetaJson {
+    id: RdbmsDialect;
+    label: string;
+    supportsSchema: boolean;
+    logicalTypes: LogicalTypeMeta[];
+    ddlStyle?: DdlStyle;
+}
+interface DialectMeta {
+    id: RdbmsDialect;
+    label: string;
+    capabilities: DialectCapability;
+    logicalTypes: readonly LogicalDataType[];
+    defaultPhysicalTypeMap: Partial<Record<LogicalDataType, string>>;
+}
+type DdlScope = {
+    kind: "all";
+} | {
+    kind: "selected";
+    tableIds: string[];
+};
+interface DdlGenerateInput {
+    doc: DesignDocument;
+    dialectId: RdbmsDialect;
+    scope: DdlScope;
+}
+interface DdlGenerateOutput {
+    sql: string;
+    diagnostics?: DdlDiagnostic[];
+}
+type DdlGeneratorHook = (input: DdlGenerateInput) => DdlGenerateOutput | Promise<DdlGenerateOutput>;
+interface DdlGeneratorRules {
+    quoteIdentifier?: (dialect: RdbmsDialect, identifier: string) => string;
+    toDefaultExpression?: (dialect: RdbmsDialect, col: ColumnModel) => string | null;
+}
+interface DbMetaAdapter {
+    listDialects: () => DialectMeta[];
+    getDialectMeta: (dialect: RdbmsDialect) => DialectMeta | undefined;
+    getDefaultPhysicalType: (dialect: RdbmsDialect, logicalType: LogicalDataType) => string;
+    getDdlRules: (dialect: RdbmsDialect) => DdlGeneratorRules;
+}
+interface CoreDbMetaOptions {
+    dbMetaAdapter?: DbMetaAdapter;
+    hostMetas?: DialectMetaJson[];
+    hostDdlGenerators?: Record<string, DdlGeneratorHook>;
+    fallbackOnHookError?: boolean;
+}
+declare const BUILTIN_DIALECTS: readonly BuiltinRdbmsDialect[];
+declare const BUILTIN_DIALECT_METAS_JSON: DialectMetaJson[];
+declare function mergeDialectMetas(base: DialectMetaJson[], host?: DialectMetaJson[]): DialectMetaJson[];
+declare function resolveDialectMetas(options?: CoreDbMetaOptions): DialectMetaJson[];
+declare function createDefaultDbMetaAdapter(overrides?: Partial<DbMetaAdapter>): DbMetaAdapter;
+declare const defaultDbMetaAdapter: DbMetaAdapter;
+declare function defaultPhysicalType(dialect: RdbmsDialect, logicalType: LogicalDataType, options?: CoreDbMetaOptions): string;
+/**
+ * 물리 데이터 유형 문자열에서 방언 메타의 기본 매핑(및 흔한 SQL 별칭)으로 논리 유형을 추정한다.
+ */
+declare function inferLogicalTypeFromPhysical(dialect: RdbmsDialect, physicalType: string, options?: CoreDbMetaOptions): LogicalDataType;
+declare function getRdbmsDialectCapability(dialect: RdbmsDialect, options?: CoreDbMetaOptions): DialectCapability;
+declare function dialectSupportsSchema(dialect: RdbmsDialect, options?: CoreDbMetaOptions): boolean;
+declare function convertDesignDialect(doc: DesignDocument, nextDialect: RdbmsDialect, options?: CoreDbMetaOptions): DesignDocument;
+declare function applyLogicalTypeChange(column: ColumnModel, nextLogicalType: LogicalDataType, dialect: RdbmsDialect, options?: CoreDbMetaOptions): ColumnModel;
+declare function createColumn(dialect: RdbmsDialect, params: {
+    id: string;
+    logicalName: string;
+    /** 생략 시 논리 이름과 동일한 물리 이름으로 생성된다. */
+    physicalName?: string;
+    description?: string;
+    logicalType: LogicalDataType;
+    defaultValue?: string;
+    nullable?: boolean;
+    isPrimaryKey?: boolean;
+    isForeignKey?: boolean;
+    referencesPrimaryColumnId?: string;
+    color?: string;
+}, options?: CoreDbMetaOptions): ColumnModel;
+declare function createEmptyDesign(dialect?: RdbmsDialect): DesignDocument;
+declare function serializeDesign(doc: DesignDocument): string;
+declare function parseDesign(json: string, options?: CoreDbMetaOptions): DesignDocument;
+declare function validateDesignDocument(input: unknown, options?: CoreDbMetaOptions): DesignDocument;
+declare function roundTripDesign(doc: DesignDocument): DesignDocument;
+/** DDL/인덱스 분석 공통 심각도 */
+type DdlDiagnosticSeverity = "error" | "warning";
+/** 구조화된 DDL 관련 진단(에러·경고) */
+interface DdlDiagnostic {
+    severity: DdlDiagnosticSeverity;
+    code: string;
+    message: string;
+    /** 예: relationship:rel1, index:ix1, table:t1 */
+    context?: string;
+}
+/**
+ * 통일된 한 줄 텍스트 포맷.
+ * 예: `[WARN][DDL_REL_MISSING_COLUMNS] ... | relationship:rel1`
+ */
+declare function formatDdlDiagnostic(d: DdlDiagnostic): string;
+declare function formatDdlDiagnostics(diagnostics: DdlDiagnostic[]): string;
+/**
+ * 모델 전체에 대한 DDL·인덱스 관련 진단(테이블/관계/인덱스).
+ * 검증 예외(Invalid design document)와는 별도로, 생성 가능 여부와 경고를 나열한다.
+ */
+declare function analyzeDdlDocument(doc: DesignDocument, options?: CoreDbMetaOptions): DdlDiagnostic[];
+declare function generateDdlWithDiagnostics(doc: DesignDocument, options?: CoreDbMetaOptions): {
+    sql: string;
+    diagnostics: DdlDiagnostic[];
+};
+declare function generateIndexDdlWithDiagnostics(doc: DesignDocument, options?: CoreDbMetaOptions): {
+    sql: string;
+    diagnostics: DdlDiagnostic[];
+};
+declare function generateDdl(doc: DesignDocument, options?: CoreDbMetaOptions): string;
+declare function generateDdlForSelection(doc: DesignDocument, tableIds: string[], options?: CoreDbMetaOptions): {
+    sql: string;
+    diagnostics: DdlDiagnostic[];
+};
+declare function generateIndexDdl(doc: DesignDocument, options?: CoreDbMetaOptions): string;
+/** 성능·부하 테스트용: 지정 개수의 빈 테이블과 격자 레이아웃을 생성한다. */
+declare function createLargeDesign(tableCount: number, dialect?: RdbmsDialect): DesignDocument;
+
+export { type AlignCommand, BUILTIN_DIALECTS, BUILTIN_DIALECT_METAS_JSON, type BuiltinRdbmsDialect, type ColumnModel, type CoreDbMetaOptions, type DbMetaAdapter, type DdlDiagnostic, type DdlDiagnosticSeverity, type DdlGenerateInput, type DdlGenerateOutput, type DdlGeneratorHook, type DdlGeneratorRules, type DdlScope, type DdlStyle, type DdlStyleBooleanLiteral, type DdlStyleQuote, type DesignDocument, type DesignModel, type DiagramLayout, type DialectCapability, type DialectMeta, type DialectMetaJson, type IndexModel, LOGICAL_DATA_TYPES, type LogicalDataType, type LogicalTypeMeta, type RdbmsDialect, type RelationshipModel, type TableModel, alignNodePositions, analyzeDdlDocument, applyLogicalTypeChange, convertDesignDialect, createColumn, createDefaultDbMetaAdapter, createEmptyDesign, createLargeDesign, defaultDbMetaAdapter, defaultPhysicalType, dialectSupportsSchema, formatDdlDiagnostic, formatDdlDiagnostics, generateDdl, generateDdlForSelection, generateDdlWithDiagnostics, generateIndexDdl, generateIndexDdlWithDiagnostics, getRdbmsDialectCapability, inferLogicalTypeFromPhysical, isRelationshipLineRenderable, mergeDialectMetas, migrateLegacyFkLineVisibility, parseDesign, resolveDialectMetas, roundTripDesign, serializeDesign, validateDesignDocument };