@schema2sheet/dbml 1.0.0

package/dist/index.d.mts

@@ -0,0 +1,54 @@
+import { OnDeleteAction } from "@schema2sheet/core";
+
+//#region src/converter.d.ts
+type RefTarget = {
+  table: string;
+  field: string;
+  onDelete?: OnDeleteAction;
+};
+type ExportedField = {
+  name: string;
+  type: any;
+  pk: boolean;
+  not_null: boolean;
+  unique: boolean;
+  note: string;
+  dbdefault: any;
+  increment: boolean;
+};
+type ExportedEndpoint = {
+  schemaName: string;
+  tableName: string;
+  fieldNames: string[];
+  relation: string;
+};
+type ExportedRef = {
+  endpoints: ExportedEndpoint[];
+  name: string;
+  onDelete: string | null;
+  onUpdate: string | null;
+};
+type ExportedEnum = {
+  name: string;
+  values: {
+    name: string;
+  }[];
+};
+type ExportedTable = {
+  name: string;
+  fields: ExportedField[];
+};
+type ExportedSchema = {
+  tables: ExportedTable[];
+  enums: ExportedEnum[];
+  refs: ExportedRef[];
+};
+type ExportedDatabase = {
+  schemas: ExportedSchema[];
+};
+declare function buildRefMap(schemas: ExportedSchema[]): Map<string, RefTarget>;
+declare function convertDbmlTableToHeaders(table: ExportedTable, refMap: Map<string, RefTarget>, enumNames: Set<string>): string[];
+declare function collectEnumNames(schemas: ExportedSchema[]): Set<string>;
+//#endregion
+export { type ExportedDatabase, type RefTarget, buildRefMap, collectEnumNames, convertDbmlTableToHeaders };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/converter.ts"],"mappings":";;;KAEY,SAAA;EACX,KAAA;EACA,KAAA;EACA,QAAA,GAAW,cAAA;AAAA;AAAA,KAGP,aAAA;EACJ,IAAA;EACA,IAAA;EACA,EAAA;EACA,QAAA;EACA,MAAA;EACA,IAAA;EACA,SAAA;EACA,SAAA;AAAA;AAAA,KAGI,gBAAA;EACJ,UAAA;EACA,SAAA;EACA,UAAA;EACA,QAAA;AAAA;AAAA,KAGI,WAAA;EACJ,SAAA,EAAW,gBAAA;EACX,IAAA;EACA,QAAA;EACA,QAAA;AAAA;AAAA,KAGI,YAAA;EACJ,IAAA;EACA,MAAA;IAAU,IAAA;EAAA;AAAA;AAAA,KAGN,aAAA;EACJ,IAAA;EACA,MAAA,EAAQ,aAAA;AAAA;AAAA,KAGJ,cAAA;EACJ,MAAA,EAAQ,aAAA;EACR,KAAA,EAAO,YAAA;EACP,IAAA,EAAM,WAAA;AAAA;AAAA,KAGK,gBAAA;EACX,OAAA,EAAS,cAAA;AAAA;AAAA,iBAsDM,WAAA,CAAY,OAAA,EAAS,cAAA,KAAmB,GAAA,SAAY,SAAA;AAAA,iBAwCpD,yBAAA,CACf,KAAA,EAAO,aAAA,EACP,MAAA,EAAQ,GAAA,SAAY,SAAA,GACpB,SAAA,EAAW,GAAA;AAAA,iBA+EI,gBAAA,CAAiB,OAAA,EAAS,cAAA,KAAmB,GAAA"}

package/dist/index.mjs

@@ -0,0 +1,118 @@
+//#region src/converter.ts
+const DBML_TYPE_MAP = {
+	uuid: "uuid",
+	varchar: "string",
+	text: "string",
+	string: "string",
+	char: "string",
+	nvarchar: "string",
+	ntext: "string",
+	nchar: "string",
+	int: "integer",
+	integer: "integer",
+	bigint: "integer",
+	smallint: "integer",
+	tinyint: "integer",
+	serial: "integer",
+	bigserial: "integer",
+	float: "float",
+	double: "double",
+	decimal: "number",
+	real: "float",
+	numeric: "number",
+	money: "currency",
+	boolean: "boolean",
+	bool: "boolean",
+	timestamp: "date-time",
+	timestamptz: "date-time",
+	datetime: "date-time",
+	date: "date",
+	time: "time",
+	timetz: "time",
+	json: "json",
+	jsonb: "json"
+};
+const ON_DELETE_MAP = {
+	cascade: "cascade",
+	restrict: "restrict",
+	set_null: "set_null",
+	"set null": "set_null",
+	set_default: void 0,
+	"set default": void 0,
+	no_action: void 0,
+	"no action": void 0
+};
+function buildRefMap(schemas) {
+	const refMap = /* @__PURE__ */ new Map();
+	for (const schema of schemas) for (const ref of schema.refs) {
+		if (ref.endpoints.length !== 2) continue;
+		const [ep0, ep1] = ref.endpoints;
+		let source;
+		let target;
+		if (ep0.relation === "*" || ep0.relation === ">") {
+			source = ep0;
+			target = ep1;
+		} else if (ep1.relation === "*" || ep1.relation === ">") {
+			source = ep1;
+			target = ep0;
+		} else {
+			source = ep0;
+			target = ep1;
+		}
+		const onDelete = ref.onDelete ? ON_DELETE_MAP[ref.onDelete.toLowerCase()] : void 0;
+		for (const fieldName of source.fieldNames) {
+			const key = `${source.tableName}.${fieldName}`;
+			refMap.set(key, {
+				table: target.tableName,
+				field: target.fieldNames[0] || "id",
+				onDelete
+			});
+		}
+	}
+	return refMap;
+}
+function convertDbmlTableToHeaders(table, refMap, enumNames) {
+	return table.fields.map((field) => convertDbmlFieldToHeader(field, refMap, table.name, enumNames));
+}
+function convertDbmlFieldToHeader(field, refMap, tableName, enumNames) {
+	const name = field.name;
+	const requiredMark = field.pk || field.not_null ? "*" : "";
+	const refKey = `${tableName}.${name}`;
+	const ref = refMap.get(refKey);
+	if (ref) {
+		const parts = [ref.table];
+		const expandKey = extractExpandKey(name);
+		if (expandKey) parts.push(expandKey);
+		if (ref.onDelete && ref.onDelete !== "restrict") parts.push(ref.onDelete);
+		return `${name}${requiredMark}:ref(${parts.join(",")})`;
+	}
+	const rawType = resolveFieldTypeName(field.type);
+	if (enumNames.has(rawType)) return `${name}${requiredMark}:enum`;
+	if (field.pk && name === "id") return `${name}${requiredMark}:uuid`;
+	const mappedType = DBML_TYPE_MAP[rawType.toLowerCase().replace(/\(.*\)/, "").trim()];
+	if (!mappedType) {
+		console.warn(`Unknown DBML type "${rawType}" for ${tableName}.${name}, defaulting to string`);
+		return `${name}${requiredMark}`;
+	}
+	if (mappedType === "string") return `${name}${requiredMark}`;
+	return `${name}${requiredMark}:${mappedType}`;
+}
+function resolveFieldTypeName(type) {
+	if (typeof type === "string") return type;
+	if (type?.type_name) return String(type.type_name);
+	if (type?.schemaName && type?.type_name) return `${type.schemaName}.${type.type_name}`;
+	return String(type || "string");
+}
+function extractExpandKey(fieldName) {
+	if (fieldName.endsWith("_id")) return fieldName.slice(0, -3);
+	if (fieldName.endsWith("Id") && fieldName.length > 2) return fieldName.slice(0, -2);
+}
+function collectEnumNames(schemas) {
+	const names = /* @__PURE__ */ new Set();
+	for (const schema of schemas) for (const enumDef of schema.enums) names.add(enumDef.name);
+	return names;
+}
+
+//#endregion
+export { buildRefMap, collectEnumNames, convertDbmlTableToHeaders };
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/converter.ts"],"sourcesContent":["import type { OnDeleteAction } from \"@schema2sheet/core\";\n\nexport type RefTarget = {\n\ttable: string;\n\tfield: string;\n\tonDelete?: OnDeleteAction;\n};\n\ntype ExportedField = {\n\tname: string;\n\ttype: any;\n\tpk: boolean;\n\tnot_null: boolean;\n\tunique: boolean;\n\tnote: string;\n\tdbdefault: any;\n\tincrement: boolean;\n};\n\ntype ExportedEndpoint = {\n\tschemaName: string;\n\ttableName: string;\n\tfieldNames: string[];\n\trelation: string;\n};\n\ntype ExportedRef = {\n\tendpoints: ExportedEndpoint[];\n\tname: string;\n\tonDelete: string | null;\n\tonUpdate: string | null;\n};\n\ntype ExportedEnum = {\n\tname: string;\n\tvalues: { name: string }[];\n};\n\ntype ExportedTable = {\n\tname: string;\n\tfields: ExportedField[];\n};\n\ntype ExportedSchema = {\n\ttables: ExportedTable[];\n\tenums: ExportedEnum[];\n\trefs: ExportedRef[];\n};\n\nexport type ExportedDatabase = {\n\tschemas: ExportedSchema[];\n};\n\nconst DBML_TYPE_MAP: Record<string, string> = {\n\tuuid: \"uuid\",\n\n\tvarchar: \"string\",\n\ttext: \"string\",\n\tstring: \"string\",\n\tchar: \"string\",\n\tnvarchar: \"string\",\n\tntext: \"string\",\n\tnchar: \"string\",\n\n\tint: \"integer\",\n\tinteger: \"integer\",\n\tbigint: \"integer\",\n\tsmallint: \"integer\",\n\ttinyint: \"integer\",\n\tserial: \"integer\",\n\tbigserial: \"integer\",\n\n\tfloat: \"float\",\n\tdouble: \"double\",\n\tdecimal: \"number\",\n\treal: \"float\",\n\tnumeric: \"number\",\n\tmoney: \"currency\",\n\n\tboolean: \"boolean\",\n\tbool: \"boolean\",\n\n\ttimestamp: \"date-time\",\n\ttimestamptz: \"date-time\",\n\tdatetime: \"date-time\",\n\tdate: \"date\",\n\ttime: \"time\",\n\ttimetz: \"time\",\n\n\tjson: \"json\",\n\tjsonb: \"json\",\n};\n\nconst ON_DELETE_MAP: Record<string, OnDeleteAction | undefined> = {\n\tcascade: \"cascade\",\n\trestrict: \"restrict\",\n\tset_null: \"set_null\",\n\t\"set null\": \"set_null\",\n\tset_default: undefined,\n\t\"set default\": undefined,\n\tno_action: undefined,\n\t\"no action\": undefined,\n};\n\nexport function buildRefMap(schemas: ExportedSchema[]): Map<string, RefTarget> {\n\tconst refMap = new Map<string, RefTarget>();\n\n\tfor (const schema of schemas) {\n\t\tfor (const ref of schema.refs) {\n\t\t\tif (ref.endpoints.length !== 2) continue;\n\n\t\t\tconst [ep0, ep1] = ref.endpoints;\n\t\t\tlet source: ExportedEndpoint;\n\t\t\tlet target: ExportedEndpoint;\n\n\t\t\tif (ep0.relation === \"*\" || ep0.relation === \">\") {\n\t\t\t\tsource = ep0;\n\t\t\t\ttarget = ep1;\n\t\t\t} else if (ep1.relation === \"*\" || ep1.relation === \">\") {\n\t\t\t\tsource = ep1;\n\t\t\t\ttarget = ep0;\n\t\t\t} else {\n\t\t\t\tsource = ep0;\n\t\t\t\ttarget = ep1;\n\t\t\t}\n\n\t\t\tconst onDelete = ref.onDelete\n\t\t\t\t? ON_DELETE_MAP[ref.onDelete.toLowerCase()]\n\t\t\t\t: undefined;\n\n\t\t\tfor (const fieldName of source.fieldNames) {\n\t\t\t\tconst key = `${source.tableName}.${fieldName}`;\n\t\t\t\trefMap.set(key, {\n\t\t\t\t\ttable: target.tableName,\n\t\t\t\t\tfield: target.fieldNames[0] || \"id\",\n\t\t\t\t\tonDelete,\n\t\t\t\t});\n\t\t\t}\n\t\t}\n\t}\n\n\treturn refMap;\n}\n\nexport function convertDbmlTableToHeaders(\n\ttable: ExportedTable,\n\trefMap: Map<string, RefTarget>,\n\tenumNames: Set<string>,\n): string[] {\n\treturn table.fields.map((field) =>\n\t\tconvertDbmlFieldToHeader(field, refMap, table.name, enumNames),\n\t);\n}\n\nfunction convertDbmlFieldToHeader(\n\tfield: ExportedField,\n\trefMap: Map<string, RefTarget>,\n\ttableName: string,\n\tenumNames: Set<string>,\n): string {\n\tconst name = field.name;\n\tconst isRequired = field.pk || field.not_null;\n\tconst requiredMark = isRequired ? \"*\" : \"\";\n\n\tconst refKey = `${tableName}.${name}`;\n\tconst ref = refMap.get(refKey);\n\n\tif (ref) {\n\t\tconst parts: string[] = [ref.table];\n\t\tconst expandKey = extractExpandKey(name);\n\t\tif (expandKey) parts.push(expandKey);\n\t\tif (ref.onDelete && ref.onDelete !== \"restrict\") {\n\t\t\tparts.push(ref.onDelete);\n\t\t}\n\t\treturn `${name}${requiredMark}:ref(${parts.join(\",\")})`;\n\t}\n\n\tconst rawType = resolveFieldTypeName(field.type);\n\n\tif (enumNames.has(rawType)) {\n\t\treturn `${name}${requiredMark}:enum`;\n\t}\n\n\tif (field.pk && name === \"id\") {\n\t\treturn `${name}${requiredMark}:uuid`;\n\t}\n\n\tconst baseType = rawType\n\t\t.toLowerCase()\n\t\t.replace(/\\(.*\\)/, \"\")\n\t\t.trim();\n\tconst mappedType = DBML_TYPE_MAP[baseType];\n\n\tif (!mappedType) {\n\t\tconsole.warn(\n\t\t\t`Unknown DBML type \"${rawType}\" for ${tableName}.${name}, defaulting to string`,\n\t\t);\n\t\treturn `${name}${requiredMark}`;\n\t}\n\n\tif (mappedType === \"string\") {\n\t\treturn `${name}${requiredMark}`;\n\t}\n\n\treturn `${name}${requiredMark}:${mappedType}`;\n}\n\nfunction resolveFieldTypeName(type: any): string {\n\tif (typeof type === \"string\") return type;\n\tif (type?.type_name) return String(type.type_name);\n\tif (type?.schemaName && type?.type_name) {\n\t\treturn `${type.schemaName}.${type.type_name}`;\n\t}\n\treturn String(type || \"string\");\n}\n\nfunction extractExpandKey(fieldName: string): string | undefined {\n\tif (fieldName.endsWith(\"_id\")) {\n\t\treturn fieldName.slice(0, -3);\n\t}\n\tif (fieldName.endsWith(\"Id\") && fieldName.length > 2) {\n\t\treturn fieldName.slice(0, -2);\n\t}\n\treturn undefined;\n}\n\nexport function collectEnumNames(schemas: ExportedSchema[]): Set<string> {\n\tconst names = new Set<string>();\n\tfor (const schema of schemas) {\n\t\tfor (const enumDef of schema.enums) {\n\t\t\tnames.add(enumDef.name);\n\t\t}\n\t}\n\treturn names;\n}\n"],"mappings":";AAqDA,MAAM,gBAAwC;CAC7C,MAAM;CAEN,SAAS;CACT,MAAM;CACN,QAAQ;CACR,MAAM;CACN,UAAU;CACV,OAAO;CACP,OAAO;CAEP,KAAK;CACL,SAAS;CACT,QAAQ;CACR,UAAU;CACV,SAAS;CACT,QAAQ;CACR,WAAW;CAEX,OAAO;CACP,QAAQ;CACR,SAAS;CACT,MAAM;CACN,SAAS;CACT,OAAO;CAEP,SAAS;CACT,MAAM;CAEN,WAAW;CACX,aAAa;CACb,UAAU;CACV,MAAM;CACN,MAAM;CACN,QAAQ;CAER,MAAM;CACN,OAAO;CACP;AAED,MAAM,gBAA4D;CACjE,SAAS;CACT,UAAU;CACV,UAAU;CACV,YAAY;CACZ,aAAa;CACb,eAAe;CACf,WAAW;CACX,aAAa;CACb;AAED,SAAgB,YAAY,SAAmD;CAC9E,MAAM,yBAAS,IAAI,KAAwB;AAE3C,MAAK,MAAM,UAAU,QACpB,MAAK,MAAM,OAAO,OAAO,MAAM;AAC9B,MAAI,IAAI,UAAU,WAAW,EAAG;EAEhC,MAAM,CAAC,KAAK,OAAO,IAAI;EACvB,IAAI;EACJ,IAAI;AAEJ,MAAI,IAAI,aAAa,OAAO,IAAI,aAAa,KAAK;AACjD,YAAS;AACT,YAAS;aACC,IAAI,aAAa,OAAO,IAAI,aAAa,KAAK;AACxD,YAAS;AACT,YAAS;SACH;AACN,YAAS;AACT,YAAS;;EAGV,MAAM,WAAW,IAAI,WAClB,cAAc,IAAI,SAAS,aAAa,IACxC;AAEH,OAAK,MAAM,aAAa,OAAO,YAAY;GAC1C,MAAM,MAAM,GAAG,OAAO,UAAU,GAAG;AACnC,UAAO,IAAI,KAAK;IACf,OAAO,OAAO;IACd,OAAO,OAAO,WAAW,MAAM;IAC/B;IACA,CAAC;;;AAKL,QAAO;;AAGR,SAAgB,0BACf,OACA,QACA,WACW;AACX,QAAO,MAAM,OAAO,KAAK,UACxB,yBAAyB,OAAO,QAAQ,MAAM,MAAM,UAAU,CAC9D;;AAGF,SAAS,yBACR,OACA,QACA,WACA,WACS;CACT,MAAM,OAAO,MAAM;CAEnB,MAAM,eADa,MAAM,MAAM,MAAM,WACH,MAAM;CAExC,MAAM,SAAS,GAAG,UAAU,GAAG;CAC/B,MAAM,MAAM,OAAO,IAAI,OAAO;AAE9B,KAAI,KAAK;EACR,MAAM,QAAkB,CAAC,IAAI,MAAM;EACnC,MAAM,YAAY,iBAAiB,KAAK;AACxC,MAAI,UAAW,OAAM,KAAK,UAAU;AACpC,MAAI,IAAI,YAAY,IAAI,aAAa,WACpC,OAAM,KAAK,IAAI,SAAS;AAEzB,SAAO,GAAG,OAAO,aAAa,OAAO,MAAM,KAAK,IAAI,CAAC;;CAGtD,MAAM,UAAU,qBAAqB,MAAM,KAAK;AAEhD,KAAI,UAAU,IAAI,QAAQ,CACzB,QAAO,GAAG,OAAO,aAAa;AAG/B,KAAI,MAAM,MAAM,SAAS,KACxB,QAAO,GAAG,OAAO,aAAa;CAO/B,MAAM,aAAa,cAJF,QACf,aAAa,CACb,QAAQ,UAAU,GAAG,CACrB,MAAM;AAGR,KAAI,CAAC,YAAY;AAChB,UAAQ,KACP,sBAAsB,QAAQ,QAAQ,UAAU,GAAG,KAAK,wBACxD;AACD,SAAO,GAAG,OAAO;;AAGlB,KAAI,eAAe,SAClB,QAAO,GAAG,OAAO;AAGlB,QAAO,GAAG,OAAO,aAAa,GAAG;;AAGlC,SAAS,qBAAqB,MAAmB;AAChD,KAAI,OAAO,SAAS,SAAU,QAAO;AACrC,KAAI,MAAM,UAAW,QAAO,OAAO,KAAK,UAAU;AAClD,KAAI,MAAM,cAAc,MAAM,UAC7B,QAAO,GAAG,KAAK,WAAW,GAAG,KAAK;AAEnC,QAAO,OAAO,QAAQ,SAAS;;AAGhC,SAAS,iBAAiB,WAAuC;AAChE,KAAI,UAAU,SAAS,MAAM,CAC5B,QAAO,UAAU,MAAM,GAAG,GAAG;AAE9B,KAAI,UAAU,SAAS,KAAK,IAAI,UAAU,SAAS,EAClD,QAAO,UAAU,MAAM,GAAG,GAAG;;AAK/B,SAAgB,iBAAiB,SAAwC;CACxE,MAAM,wBAAQ,IAAI,KAAa;AAC/B,MAAK,MAAM,UAAU,QACpB,MAAK,MAAM,WAAW,OAAO,MAC5B,OAAM,IAAI,QAAQ,KAAK;AAGzB,QAAO"}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@schema2sheet/dbml",
+  "version": "1.0.0",
+  "description": "DBML to schema converter for schema2sheet",
+  "type": "module",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "dbml",
+    "schema",
+    "converter"
+  ],
+  "license": "MIT",
+  "dependencies": {
+    "@dbml/core": "^3.14.1",
+    "@schema2sheet/core": "1.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.2",
+    "typescript": "^5.7.2"
+  },
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./package.json": "./package.json"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/froggy1014/schema2sheet.git"
+  },
+  "homepage": "https://github.com/froggy1014/schema2sheet#readme",
+  "bugs": {
+    "url": "https://github.com/froggy1014/schema2sheet/issues"
+  },
+  "author": "froggy1014",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "lint": "biome check --write .",
+    "clean": "rm -rf dist .turbo node_modules",
+    "typecheck": "tsc --noEmit"
+  }
+}