hekireki 0.6.0 → 0.6.1

package/README.md

@@ -1,3 +1,5 @@
+![img](https://raw.githubusercontent.com/nakita628/hekireki/refs/heads/main/assets/img/hekireki.png)
+
 # Hekireki
 
 **[Hekireki](https://www.npmjs.com/package/hekireki)** is a tool that generates validation schemas for Zod, Valibot, ArkType, and Effect Schema, as well as ER diagrams, from [Prisma](https://www.prisma.io/) schemas annotated with comments.
@@ -9,8 +11,7 @@
 - 🏹 Automatically generates [ArkType](https://arktype.io/) schemas from your Prisma schema
 - ⚡ Automatically generates [Effect Schema](https://effect.website/docs/schema/introduction/) from your Prisma schema
 - 📊 Creates [Mermaid](https://mermaid.js.org/) ER diagrams with PK/FK markers
-- 📝 Generates [DBML](https://dbml.dbdiagram.io/) (Database Markup Language) files
-- 🖼️ Outputs ER diagrams as **PNG/SVG** images using [dbml-renderer](https://github.com/softwaretechnik-berlin/dbml-renderer)
+- 📝 Generates [DBML](https://dbml.dbdiagram.io/) (Database Markup Language) files and **PNG** ER diagrams via [dbml-renderer](https://github.com/softwaretechnik-berlin/dbml-renderer) — output format is determined by the file extension (`.dbml` or `.png`)
 - 🧪 Generates [Ecto](https://hexdocs.pm/ecto/Ecto.Schema.html) schemas for Elixir projects
   ⚠️ Foreign key constraints are **not** included — manage relationships in your application logic
 
@@ -51,28 +52,30 @@ generator Hekireki-ArkType {
     provider = "hekireki-arktype"
     type     = true
     comment  = true
+    relation = true
 }
 
 generator Hekireki-Effect {
     provider = "hekireki-effect"
     type     = true
     comment  = true
+    relation = true
 }
 
 generator Hekireki-Ecto {
     provider = "hekireki-ecto"
-    output = "schema"
+    output = "./ecto"
     app = "DBSchema"
 }
 
 generator Hekireki-DBML {
     provider = "hekireki-dbml"
+    output   = "docs/schema.dbml"
 }
 
-generator Hekireki-SVG {
-    provider = "hekireki-svg"
-    output   = "docs"
-    format   = "png"
+generator Hekireki-Docs {
+    provider = "hekireki-docs"
+    output   = "./docs"
 }
 
 model User {
@@ -122,9 +125,9 @@ model Post {
 }
 ```
 
-## Generate
+## Generated Output
 
-## Zod
+### Zod
 
 ```ts
 import * as z from 'zod'
@@ -178,7 +181,7 @@ export const PostRelationsSchema = z.object({
 export type PostRelations = z.infer<typeof PostRelationsSchema>
 ```
 
-## Valibot
+### Valibot
 
 ```ts
 import * as v from 'valibot'
@@ -232,7 +235,7 @@ export const PostRelationsSchema = v.object({
 export type PostRelations = v.InferInput<typeof PostRelationsSchema>
 ```
 
-## ArkType
+### ArkType
 
 ```ts
 import { type } from 'arktype'
@@ -260,7 +263,7 @@ export const PostSchema = type({
 export type Post = typeof PostSchema.infer
 ```
 
-## Effect Schema
+### Effect Schema
 
 ```ts
 import { Schema } from 'effect'
@@ -288,7 +291,7 @@ export const PostSchema = Schema.Struct({
 export type Post = Schema.Schema.Type<typeof PostSchema>
 ```
 
-## Mermaid
+### Mermaid
 
 ```mermaid
 erDiagram
@@ -305,7 +308,7 @@ erDiagram
     }
 ```
 
-## Ecto
+### Ecto
 
 ```elixir
 defmodule DBSchema.User do
@@ -345,7 +348,7 @@ defmodule DBSchema.Post do
 end
 ```
 
-## DBML
+### DBML
 
 ```dbml
 Table User {
@@ -365,11 +368,27 @@ Table Post {
 Ref Post_userId_fk: Post.userId > User.id
 ```
 
-## PNG/SVG
+### PNG
 
-The `hekireki-svg` generator outputs ER diagrams as PNG or SVG images using [dbml-renderer](https://github.com/softwaretechnik-berlin/dbml-renderer).
+The `hekireki-dbml` generator also outputs ER diagrams as PNG images when the `output` path ends with `.png`:
 
-Output: `docs/er-diagram.png`
+```prisma
+generator Hekireki-PNG {
+    provider = "hekireki-dbml"
+    output   = "docs/er-diagram.png"
+}
+```
+
+### Docs
+
+The `hekireki-docs` generator creates an HTML documentation page from your Prisma schema. Serve it locally with `hekireki docs serve`:
+
+```prisma
+generator Hekireki-Docs {
+    provider = "hekireki-docs"
+    output   = "./docs"
+}
+```
 
 ## Configuration
 
@@ -404,6 +423,7 @@ generator Hekireki-ArkType {
     file     = "index.ts"    // File name (default: index.ts)
     type     = true          // Generate TypeScript types (default: false)
     comment  = true          // Include schema documentation (default: false)
+    relation = true          // Generate relation schemas (default: false)
 }
 
 // Effect Schema Generator
@@ -413,6 +433,7 @@ generator Hekireki-Effect {
     file     = "index.ts"    // File name (default: index.ts)
     type     = true          // Generate TypeScript types (default: false)
     comment  = true          // Include schema documentation (default: false)
+    relation = true          // Generate relation schemas (default: false)
 }
 
 // Mermaid ER Generator
@@ -425,26 +446,45 @@ generator Hekireki-ER {
 // Ecto Generator
 generator Hekireki-Ecto {
     provider = "hekireki-ecto"
-    output   = "./ecto"      // Output directory (default: ./ecto)
+    output   = "./ecto"      // Output directory (default: ./ecto/)
     app      = "MyApp"       // App name (default: MyApp)
 }
 
-// DBML Generator
+// DBML Generator (output extension determines format: .dbml or .png)
 generator Hekireki-DBML {
     provider = "hekireki-dbml"
-    output   = "./dbml"      // Output directory (default: ./dbml)
-    file     = "schema.dbml" // File name (default: schema.dbml)
+    output   = "docs/schema.dbml"    // File path ending in .dbml or .png
+    mapToDbSchema = true             // Map to DB schema names (default: true)
+}
+
+// PNG output (same provider, different extension)
+generator Hekireki-PNG {
+    provider = "hekireki-dbml"
+    output   = "docs/er-diagram.png" // .png extension → PNG output
+    mapToDbSchema = true             // Map to DB schema names (default: true)
 }
 
-// SVG/PNG Generator
-generator Hekireki-SVG {
-    provider = "hekireki-svg"
-    output   = "./docs"      // Output directory (default: ./docs)
-    file     = "er-diagram"  // File name without extension (default: er-diagram)
-    format   = "png"         // Output format: "png", "svg", or "dot" (default: png)
+// Docs Generator
+generator Hekireki-Docs {
+    provider = "hekireki-docs"
+    output   = "./docs"              // Output directory (default: ./docs)
 }
 ```
 
+## Docs Server
+
+Hekireki includes a built-in documentation server powered by [Hono](https://hono.dev/). After generating docs with `prisma generate`, you can preview them locally:
+
+```bash
+# Start the docs server (default: http://localhost:5858)
+hekireki docs serve
+
+# Specify a custom port
+hekireki docs serve -p 3000
+```
+
+> **Note:** Run `prisma generate` first to generate the `docs/` directory with `index.html`.
+
 ## License
 
 Distributed under the MIT License. See [LICENSE](https://github.com/nakita628/hekireki?tab=MIT-1-ov-file) for more information.

package/dist/cli/index.js

@@ -58,7 +58,7 @@ const parsePort = (args) => {
 		error: "❌ Error: --port requires a number"
 	};
 	const port = parseInt(portStr, 10);
-	if (isNaN(port)) return {
+	if (Number.isNaN(port)) return {
 		ok: false,
 		error: `❌ Error: Invalid port number: ${portStr}`
 	};

package/dist/generator/dbml/index.js

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
 import { A as writeFileBinary, D as stripAnnotations, O as mkdir, T as quote, a as generateEnum, c as generateRef, k as writeFile, o as generateIndex, r as escapeNote, s as generatePrismaColumn, t as combineKeys, u as getString } from "../../utils-0nIzqFtt.js";
+import { dirname } from "node:path";
 import pkg from "@prisma/generator-helper";
 import { Resvg } from "@resvg/resvg-js";
 import { run } from "@softwaretechnik/dbml-renderer";
@@ -37,10 +38,10 @@ function generateTableIndexes(model) {
 		isUnique: true
 	}))];
 }
-function generateTables(models, mapToDbSchema = false, includeRelationFields = true) {
+function generateTables(models, mapToDbSchema = false) {
 	return models.map((model) => {
 		const modelName = mapToDbSchema && model.dbName ? model.dbName : model.name;
-		const columnLines = (includeRelationFields ? model.fields : model.fields.filter((field) => !field.relationName)).map((field) => toDBMLColumn(field, models, mapToDbSchema)).map(generatePrismaColumn).join("\n");
+		const columnLines = model.fields.map((field) => toDBMLColumn(field, models, mapToDbSchema)).map(generatePrismaColumn).join("\n");
 		const indexes = generateTableIndexes(model);
 		const indexBlock = indexes.length > 0 ? `\n\n  indexes {\n${indexes.map(generateIndex).join("\n")}\n  }` : "";
 		const strippedNote = stripAnnotations(model.documentation);
@@ -79,8 +80,8 @@ function generateRelations(models, mapToDbSchema = false) {
 		});
 	}));
 }
-function dbmlContent(datamodel, mapToDbSchema = false, includeRelationFields = true) {
-	const tables = generateTables(datamodel.models, mapToDbSchema, includeRelationFields);
+function dbmlContent(datamodel, mapToDbSchema = false) {
+	const tables = generateTables(datamodel.models, mapToDbSchema);
 	const enums = generateEnums(datamodel.enums);
 	const refs = generateRelations(datamodel.models, mapToDbSchema);
 	return [
@@ -98,8 +99,10 @@ const generateDbmlFile = async (outputDir, content, fileName) => {
 	return { ok: true };
 };
 const generatePng = async (outputDir, dbml, fileName) => {
-	const pngBuffer = new Resvg(run(dbml, "svg"), { font: { loadSystemFonts: true } }).render().asPng();
-	const writeResult = await writeFileBinary(`${outputDir}/${fileName}`, pngBuffer);
+	return generatePngFile(`${outputDir}/${fileName}`, dbml);
+};
+const generatePngFile = async (outputPath, dbml) => {
+	const writeResult = await writeFileBinary(outputPath, new Resvg(run(dbml, "svg"), { font: { loadSystemFonts: true } }).render().asPng());
 	if (!writeResult.ok) return {
 		ok: false,
 		error: `Failed to write PNG: ${writeResult.error}`
@@ -113,17 +116,30 @@ const { generatorHandler } = pkg;
 async function main(options) {
 	const { config } = options.generator;
 	const mapToDbSchema = getString(config?.mapToDbSchema) !== "false";
-	const includeRelationFields = getString(config?.includeRelationFields) !== "false";
-	const content = dbmlContent(options.dmmf.datamodel, mapToDbSchema, includeRelationFields);
+	const content = dbmlContent(options.dmmf.datamodel, mapToDbSchema);
 	const output = options.generator.output?.value ?? "./dbml";
-	const dbmlFile = getString(config?.file, "schema.dbml") ?? "schema.dbml";
-	const pngFile = getString(config?.pngFile, "er-diagram.png") ?? "er-diagram.png";
-	const mkdirResult = await mkdir(output);
-	if (!mkdirResult.ok) throw new Error(`Failed to create directory: ${mkdirResult.error}`);
-	const dbmlResult = await generateDbmlFile(output, content, dbmlFile);
-	if (!dbmlResult.ok) throw new Error(dbmlResult.error);
-	const pngResult = await generatePng(output, content, pngFile);
-	if (!pngResult.ok) throw new Error(pngResult.error);
+	if (output.endsWith(".png") || output.endsWith(".dbml")) {
+		const mkdirResult = await mkdir(dirname(output));
+		if (!mkdirResult.ok) throw new Error(`Failed to create directory: ${mkdirResult.error}`);
+		if (output.endsWith(".png")) {
+			const pngResult = await generatePngFile(output, content);
+			if (!pngResult.ok) throw new Error(pngResult.error);
+		} else {
+			const dbmlResult = await writeFile(output, content);
+			if (!dbmlResult.ok) throw new Error(`Failed to write DBML: ${dbmlResult.error}`);
+		}
+	} else {
+		const file = getString(config?.file, "schema.dbml") ?? "schema.dbml";
+		const mkdirResult = await mkdir(output);
+		if (!mkdirResult.ok) throw new Error(`Failed to create directory: ${mkdirResult.error}`);
+		if (file.endsWith(".png")) {
+			const pngResult = await generatePng(output, content, file);
+			if (!pngResult.ok) throw new Error(pngResult.error);
+		} else {
+			const dbmlResult = await generateDbmlFile(output, content, file);
+			if (!dbmlResult.ok) throw new Error(dbmlResult.error);
+		}
+	}
 }
 generatorHandler({
 	onManifest() {

package/dist/generator/docs/index.js

@@ -25,19 +25,11 @@ const getMappings = (mappings, datamodel) => {
 		upsert: mapping.upsertOne || mapping.upsertSingle || mapping.upsert
 	}));
 };
-const transformDMMF = (dmmf, { includeRelationFields }) => {
-	let datamodel = dmmf.datamodel;
-	if (!includeRelationFields) datamodel = {
-		...dmmf.datamodel,
-		models: dmmf.datamodel.models.map((model) => ({
-			...model,
-			fields: model.fields.filter((field) => !field.relationName)
-		}))
-	};
+const transformDMMF = (dmmf) => {
 	return {
 		...dmmf,
-		datamodel,
-		mappings: getMappings(dmmf.mappings, datamodel)
+		datamodel: dmmf.datamodel,
+		mappings: getMappings(dmmf.mappings, dmmf.datamodel)
 	};
 };
 
@@ -138,7 +130,6 @@ const darkModeToggleLabelClass = css`
 `;
 const iconClass = css`
   color: var(--icon-color);
-  cursor: pointer;
 `;
 const h1Class = css`
   font-size: 1.875rem;
@@ -167,9 +158,6 @@ const h4Class = css`
 const textClass = css`
   color: var(--text-primary);
 `;
-const textMutedClass = css`
-  color: var(--text-muted);
-`;
 const tableClass = css`
   border-collapse: collapse;
   table-layout: auto;
@@ -263,26 +251,12 @@ const hrSmallClass = css`
   border: none;
   border-top: 1px solid var(--border-color);
 `;
-const listClass = css`
-  margin: 0;
-  padding: 0;
-  list-style: none;
-`;
 const listItemClass = css`
   margin-bottom: 1rem;
 `;
 const mb2Class = css`
   margin-bottom: 0.5rem;
 `;
-const mb4Class = css`
-  margin-bottom: 1rem;
-`;
-const mt2Class = css`
-  margin-top: 0.5rem;
-`;
-const mt4Class = css`
-  margin-top: 1rem;
-`;
 const ml4Class = css`
   margin-left: 1rem;
 `;
@@ -373,8 +347,7 @@ const getOutputTypes = (dmmfOutputTypes) => dmmfOutputTypes.map((outputType) =>
 		nullable: !op.isNullable,
 		type: [{
 			isList: op.outputType.isList,
-			type: op.outputType.type,
-			location: op.outputType.location
+			type: op.outputType.type
 		}]
 	}))
 }));
@@ -401,6 +374,9 @@ const ModelAction = {
 	updateMany: "updateMany",
 	upsert: "upsert"
 };
+function isFieldDefault(v) {
+	return typeof v === "object" && v !== null && "name" in v && "args" in v;
+}
 const fieldDirectiveMap = new Map([
 	["isUnique", "@unique"],
 	["isId", "@id"],
@@ -593,7 +569,7 @@ const getFieldDirectives = (field) => {
 		if (mappedDirectiveValue) if (k === "hasDefaultValue" && field.default !== void 0) {
 			if (typeof field.default === "string" || typeof field.default === "number" || typeof field.default === "boolean") directives.push(`${mappedDirectiveValue}(${field.default})`);
 			else if (Array.isArray(field.default)) directives.push(`${mappedDirectiveValue}([${field.default.toString()}])`);
-			else if (typeof field.default === "object") directives.push(`${mappedDirectiveValue}(${field.default.name}(${field.default.args.join(",")}))`);
+			else if (isFieldDefault(field.default)) directives.push(`${mappedDirectiveValue}(${field.default.name}(${field.default.args.join(",")}))`);
 		} else directives.push(mappedDirectiveValue);
 	});
 	return directives;
@@ -883,7 +859,7 @@ const createTOC = (d) => {
 
 //#endregion
 //#region src/generator/docs/printer/index.tsx
-const HekirekiSvg = () => /* @__PURE__ */ jsxs("svg", {
+const HekirekiLogo = () => /* @__PURE__ */ jsxs("svg", {
 	width: "40",
 	height: "40",
 	viewBox: "0 0 40 40",
@@ -953,7 +929,7 @@ const Sidebar = ({ toc }) => /* @__PURE__ */ jsxs("div", {
 		class: headerClass,
 		children: [/* @__PURE__ */ jsxs("div", {
 			class: logoContainerClass,
-			children: [/* @__PURE__ */ jsx(HekirekiSvg, {}), /* @__PURE__ */ jsx("span", {
+			children: [/* @__PURE__ */ jsx(HekirekiLogo, {}), /* @__PURE__ */ jsx("span", {
 				class: logoTextClass,
 				children: "Hekireki Docs"
 			})]
@@ -985,9 +961,7 @@ generatorHandler({
 		};
 	},
 	async onGenerate(options) {
-		const { config } = options.generator;
-		const includeRelationFields = config.includeRelationFields !== "false";
-		const html = await generateHTML(transformDMMF(options.dmmf, { includeRelationFields }));
+		const html = await generateHTML(transformDMMF(options.dmmf));
 		const output = options.generator.output?.value;
 		if (!output) throw new Error("No output was specified for Hekireki Docs Generator");
 		await fs.mkdir(output, { recursive: true });

package/dist/generator/mermaid-er/index.js

@@ -36,7 +36,7 @@ function extractRelationsFromDmmf(models) {
 	return models.flatMap((model) => model.fields.filter((field) => field.kind === "object" && field.relationFromFields && field.relationFromFields.length > 0).map((field) => {
 		const toModel = model.name;
 		const fromModel = field.type;
-		const toField = field.relationFromFields[0];
+		const toField = field.relationFromFields?.[0];
 		const fromField = field.relationToFields?.[0] ?? "id";
 		const fromCardinality = "one";
 		const toCardinality = (models.find((m) => m.name === fromModel)?.fields.find((f) => f.relationName === field.relationName && f.name !== field.name))?.isList ? field.isRequired ? "many" : "zero-many" : field.isRequired ? "one" : "zero-one";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "hekireki",
   "type": "module",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "license": "MIT",
   "description": "Hekireki is a tool that generates validation schemas for Zod, Valibot, ArkType, and Effect Schema, as well as ER diagrams and DBML, from Prisma schemas annotated with comments.",
   "keywords": [
@@ -51,25 +51,26 @@
     "release": "npm pkg fix && pnpm build && npm publish"
   },
   "dependencies": {
-    "@hono/node-server": "^1.14.1",
-    "@prisma/generator-helper": "^7.0.1",
+    "@hono/node-server": "^1.19.9",
+    "@prisma/generator-helper": "^7.4.0",
     "@resvg/resvg-js": "^2.6.2",
     "@softwaretechnik/dbml-renderer": "^1.0.31",
-    "hono": "^4.7.4",
-    "oxfmt": "^0.27.0"
+    "hono": "^4.11.9",
+    "oxfmt": "^0.32.0"
   },
   "devDependencies": {
-    "@prisma/client": "^7.0.1",
-    "@types/node": "^24.10.1",
-    "@typescript/native-preview": "7.0.0-dev.20260130.1",
-    "@vitest/coverage-v8": "^4.0.14",
+    "@prisma/client": "^7.4.0",
+    "@types/node": "^25.2.3",
+    "@typescript/native-preview": "7.0.0-dev.20260214.1",
+    "@vitest/coverage-v8": "^4.0.18",
     "arktype": "^2.1.29",
-    "effect": "^3.19.15",
-    "prisma": "^7.0.1",
-    "tsdown": "^0.20.1",
-    "tsx": "^4.20.6",
+    "effect": "^3.19.17",
+    "prisma": "^7.4.0",
+    "tsdown": "^0.20.3",
+    "tsx": "^4.21.0",
+    "typescript": "^5.9.3",
     "valibot": "1.2.0",
-    "vitest": "^4.0.14",
-    "zod": "^4.1.13"
+    "vitest": "^4.0.18",
+    "zod": "^4.3.6"
   }
 }