hekireki 0.5.0 → 0.5.1

package/README.md

@@ -373,84 +373,77 @@ Output: `docs/er-diagram.png`
 
 ## Configuration
 
-### Zod Generator Options
-
-| Option       | Type      | Default                             | Description                                      |
-|--------------|-----------|-------------------------------------|--------------------------------------------------|
-| `output`     | `string`  | `./zod`                             | Output directory                                 |
-| `file`       | `string`  | `index.ts`                          | File Name                                        |
-| `type`       | `boolean` | `false`                             | Generate TypeScript types                        |
-| `comment`    | `boolean` | `false`                             | Include schema documentation                     |
-| `zod`        | `string`  | `'v4'`                              | Zod import version (`'mini'`, `'@hono/zod-openapi'`, or default `'v4'`) |
-| `relation`   | `boolean` | `false`                             | Generate relation schemas                        |
-
-### Valibot Generator Options
-
-| Option       | Type      | Default                             | Description                                      |
-|--------------|-----------|-------------------------------------|--------------------------------------------------|
-| `output`     | `string`  | `./valibot`                         | Output directory                                 |
-| `file`       | `string`  | `index.ts`                          | File Name                                        |
-| `type`       | `boolean` | `false`                             | Generate TypeScript types                        |
-| `comment`    | `boolean` | `false`                             | Include schema documentation                     |
-| `relation`   | `boolean` | `false`                             | Generate relation schemas                        |
-
-### ArkType Generator Options
-
-| Option       | Type      | Default                             | Description                                      |
-|--------------|-----------|-------------------------------------|--------------------------------------------------|
-| `output`     | `string`  | `./arktype`                         | Output directory                                 |
-| `file`       | `string`  | `index.ts`                          | File Name                                        |
-| `type`       | `boolean` | `false`                             | Generate TypeScript types                        |
-| `comment`    | `boolean` | `false`                             | Include schema documentation                     |
-
-### Effect Schema Generator Options
-
-| Option       | Type      | Default                             | Description                                      |
-|--------------|-----------|-------------------------------------|--------------------------------------------------|
-| `output`     | `string`  | `./effect`                          | Output directory                                 |
-| `file`       | `string`  | `index.ts`                          | File Name                                        |
-| `type`       | `boolean` | `false`                             | Generate TypeScript types                        |
-| `comment`    | `boolean` | `false`                             | Include schema documentation                     |
-
-### Mermaid ER Generator Options
-
-| Option       | Type      | Default                             | Description                                      |
-|--------------|-----------|-------------------------------------|--------------------------------------------------|
-| `output`     | `string`  | `./mermaid-er`                      | Output directory                                 |
-| `file`       | `string`  | `ER.md`                             | File Name                                        |
-
-### Ecto Generator Options
-
-| Option       | Type      | Default                             | Description                                      |
-|--------------|-----------|-------------------------------------|--------------------------------------------------|
-| `output`     | `string`  | `./ecto`                            | Output directory                                 |
-| `app`        | `string`  | `MyApp`                             | App Name                                         |
-
-### DBML Generator Options
-
-| Option       | Type      | Default                             | Description                                      |
-|--------------|-----------|-------------------------------------|--------------------------------------------------|
-| `output`     | `string`  | `./dbml`                            | Output directory                                 |
-| `file`       | `string`  | `schema.dbml`                       | File Name                                        |
-
-### SVG Generator Options
-
-| Option       | Type      | Default                             | Description                                      |
-|--------------|-----------|-------------------------------------|--------------------------------------------------|
-| `output`     | `string`  | `./docs`                            | Output directory                                 |
-| `file`       | `string`  | `er-diagram`                        | File Name (without extension)                    |
-| `format`     | `string`  | `png`                               | Output format (`png`, `svg`, or `dot`)           |
-
-## Annotation Prefixes
-
-Each generator uses a specific annotation prefix in Prisma schema comments:
-
-| Generator      | Prefix | Example                                                    |
-|----------------|--------|------------------------------------------------------------|
-| Zod            | `@z.`  | `/// @z.uuid()`                                            |
-| Valibot        | `@v.`  | `/// @v.pipe(v.string(), v.uuid())`                        |
-| ArkType        | `@a.`  | `/// @a."string.uuid"`                                     |
-| Effect Schema  | `@e.`  | `/// @e.Schema.UUID`                                       |
+Configure each generator directly in your `schema.prisma` file:
+
+```prisma
+// Zod Generator
+generator Hekireki-Zod {
+    provider = "hekireki-zod"
+    output   = "./zod"       // Output directory (default: ./zod)
+    file     = "index.ts"    // File name (default: index.ts)
+    type     = true          // Generate TypeScript types (default: false)
+    comment  = true          // Include schema documentation (default: false)
+    zod      = "v4"          // Zod import: "v4", "mini", or "@hono/zod-openapi" (default: v4)
+    relation = true          // Generate relation schemas (default: false)
+}
+
+// Valibot Generator
+generator Hekireki-Valibot {
+    provider = "hekireki-valibot"
+    output   = "./valibot"   // Output directory (default: ./valibot)
+    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)
+}
+
+// ArkType Generator
+generator Hekireki-ArkType {
+    provider = "hekireki-arktype"
+    output   = "./arktype"   // Output directory (default: ./arktype)
+    file     = "index.ts"    // File name (default: index.ts)
+    type     = true          // Generate TypeScript types (default: false)
+    comment  = true          // Include schema documentation (default: false)
+}
+
+// Effect Schema Generator
+generator Hekireki-Effect {
+    provider = "hekireki-effect"
+    output   = "./effect"    // Output directory (default: ./effect)
+    file     = "index.ts"    // File name (default: index.ts)
+    type     = true          // Generate TypeScript types (default: false)
+    comment  = true          // Include schema documentation (default: false)
+}
+
+// Mermaid ER Generator
+generator Hekireki-ER {
+    provider = "hekireki-mermaid-er"
+    output   = "./mermaid-er" // Output directory (default: ./mermaid-er)
+    file     = "ER.md"        // File name (default: ER.md)
+}
+
+// Ecto Generator
+generator Hekireki-Ecto {
+    provider = "hekireki-ecto"
+    output   = "./ecto"      // Output directory (default: ./ecto)
+    app      = "MyApp"       // App name (default: MyApp)
+}
+
+// DBML Generator
+generator Hekireki-DBML {
+    provider = "hekireki-dbml"
+    output   = "./dbml"      // Output directory (default: ./dbml)
+    file     = "schema.dbml" // File name (default: schema.dbml)
+}
+
+// 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)
+}
+```
 
 ## License
 

package/dist/cli/index.d.ts

@@ -0,0 +1,14 @@
+//#region src/cli/index.d.ts
+type Result<T> = {
+  readonly ok: true;
+  readonly value: T;
+} | {
+  readonly ok: false;
+  readonly error: string;
+};
+/**
+ * Main CLI entry point for hekireki.
+ */
+declare const hekireki: () => Result<string>;
+//#endregion
+export { hekireki };

package/dist/cli/index.js

@@ -0,0 +1,164 @@
+#!/usr/bin/env node
+import fs from "node:fs";
+import path from "node:path";
+import { serve } from "@hono/node-server";
+import { serveStatic } from "@hono/node-server/serve-static";
+import { Hono } from "hono";
+
+//#region src/cli/index.ts
+/**
+* CLI module for hekireki.
+*
+* Provides the main entry point for the hekireki CLI tool.
+*
+* @module cli
+*/
+const HELP_TEXT = `⚡️ hekireki - Prisma schema tools
+
+Usage:
+  hekireki <command> [options]
+
+Commands:
+  docs serve    Start a local server to view the documentation
+
+Options:
+  -p, --port <port>    Specify the port (default: 5858)
+  -h, --help           Show help
+
+Examples:
+  hekireki docs serve
+  hekireki docs serve -p 3000`;
+const DOCS_HELP_TEXT = `⚡️ hekireki docs - Documentation tools
+
+Usage:
+  hekireki docs serve [options]
+
+Commands:
+  serve    Start a local server to view the documentation
+
+Options:
+  -p, --port <port>    Specify the port (default: 5858)
+  -h, --help           Show help
+
+Examples:
+  hekireki docs serve
+  hekireki docs serve -p 3000`;
+/**
+* Parse port from CLI arguments.
+*/
+const parsePort = (args) => {
+	const portIndex = args.findIndex((arg) => arg === "-p" || arg === "--port");
+	if (portIndex === -1) return {
+		ok: true,
+		value: 5858
+	};
+	const portStr = args[portIndex + 1];
+	if (!portStr || portStr.startsWith("-")) return {
+		ok: false,
+		error: "❌ Error: --port requires a number"
+	};
+	const port = parseInt(portStr, 10);
+	if (isNaN(port)) return {
+		ok: false,
+		error: `❌ Error: Invalid port number: ${portStr}`
+	};
+	return {
+		ok: true,
+		value: port
+	};
+};
+/**
+* Parse CLI arguments for docs serve command.
+*/
+const parseDocsServeArgs = (args) => {
+	const portResult = parsePort(args);
+	if (!portResult.ok) return portResult;
+	return {
+		ok: true,
+		value: { port: portResult.value }
+	};
+};
+/**
+* Start the documentation server.
+*/
+const startDocsServer = (options) => {
+	const absolutePath = path.resolve("./docs");
+	if (!fs.existsSync(absolutePath)) return {
+		ok: false,
+		error: `❌ Error: Directory not found: ${absolutePath}\n   Run "prisma generate" first to generate the documentation.`
+	};
+	const indexPath = path.join(absolutePath, "index.html");
+	if (!fs.existsSync(indexPath)) return {
+		ok: false,
+		error: `❌ Error: index.html not found in ${absolutePath}\n   Run "prisma generate" first to generate the documentation.`
+	};
+	const app = new Hono();
+	app.get("/", (c) => {
+		const html = fs.readFileSync(indexPath, "utf-8");
+		return c.html(html);
+	});
+	app.use("/*", serveStatic({ root: absolutePath }));
+	const server = serve({
+		fetch: app.fetch,
+		port: options.port
+	});
+	process.on("SIGTERM", () => {
+		server.close();
+		process.exit(0);
+	});
+	process.on("SIGINT", () => {
+		server.close();
+		process.exit(0);
+	});
+	return {
+		ok: true,
+		value: `⚡️ Hekireki Docs Server started at http://localhost:${options.port}\n📂 Serving documentation from: ${absolutePath}`
+	};
+};
+/**
+* Handle docs subcommand.
+*/
+const handleDocs = (args) => {
+	const subcommand = args[0];
+	if (!subcommand || subcommand === "-h" || subcommand === "--help") return {
+		ok: true,
+		value: DOCS_HELP_TEXT
+	};
+	if (subcommand !== "serve") return {
+		ok: false,
+		error: `❌ Unknown command: docs ${subcommand}\n\n${DOCS_HELP_TEXT}`
+	};
+	const parseResult = parseDocsServeArgs(args.slice(1));
+	if (!parseResult.ok) return parseResult;
+	return startDocsServer(parseResult.value);
+};
+/**
+* Command handlers map.
+*/
+const commands = { docs: handleDocs };
+/**
+* Main CLI entry point for hekireki.
+*/
+const hekireki = () => {
+	const args = process.argv.slice(2);
+	const command = args[0];
+	if (!command || command === "-h" || command === "--help") return {
+		ok: true,
+		value: HELP_TEXT
+	};
+	const handler = commands[command];
+	if (!handler) return {
+		ok: false,
+		error: `❌ Unknown command: ${command}\n\n${HELP_TEXT}`
+	};
+	return handler(args.slice(1));
+};
+const result = hekireki();
+if (result.ok) console.log(result.value);
+else {
+	console.error(result.error);
+	process.exit(1);
+}
+
+//#endregion
+export { hekireki };

package/dist/{fsp-DYtOxLN_.js → fsp-FOfmtPYd.js}

@@ -1,4 +1,4 @@
-import fsp from "node:fs/promises";
+import fs from "node:fs/promises";
 
 //#region src/shared/fsp/index.ts
 /**
@@ -9,7 +9,7 @@ import fsp from "node:fs/promises";
 */
 async function mkdir(dir) {
 	try {
-		await fsp.mkdir(dir, { recursive: true });
+		await fs.mkdir(dir, { recursive: true });
 		return {
 			ok: true,
 			value: void 0
@@ -30,7 +30,7 @@ async function mkdir(dir) {
 */
 async function writeFile(path, data) {
 	try {
-		await fsp.writeFile(path, data, "utf-8");
+		await fs.writeFile(path, data, "utf-8");
 		return {
 			ok: true,
 			value: void 0
@@ -51,7 +51,7 @@ async function writeFile(path, data) {
 */
 async function writeFileBinary(path, data) {
 	try {
-		await fsp.writeFile(path, data);
+		await fs.writeFile(path, data);
 		return {
 			ok: true,
 			value: void 0

package/dist/generator/arktype/index.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
-import { a as getString, i as getBool, n as validationSchemas, o as fmt, r as parseDocumentWithoutAnnotations, t as schemaFromFields } from "../../utils-CXBzdZih.js";
-import { n as writeFile, t as mkdir } from "../../fsp-DYtOxLN_.js";
+import { a as getBool, i as collectRelationProps, n as validationSchemas, o as getString, r as parseDocumentWithoutAnnotations, s as fmt, t as schemaFromFields } from "../../utils-BHGDO4qk.js";
+import { n as writeFile, t as mkdir } from "../../fsp-FOfmtPYd.js";
 import path from "node:path";
 import pkg from "@prisma/generator-helper";
 import { makeValidationExtractor } from "utils-lab";
@@ -15,6 +15,19 @@ import { makeValidationExtractor } from "utils-lab";
 function schema(modelName, fields) {
 	return `export const ${modelName}Schema = type({\n${fields}\n})`;
 }
+/**
+* Make ArkType relations schema for a model.
+* @param model - The DMMF model
+* @param relProps - The relation properties
+* @param options - Options for the relation generation
+* @returns The generated ArkType relations schema or null if no relations
+*/
+function makeArktypeRelations(model, relProps, options) {
+	if (relProps.length === 0) return null;
+	const fields = `${`...${model.name}Schema.t,`}${relProps.map((r) => `${r.key}:${r.isMany ? `${r.targetModel}Schema.array()` : `${r.targetModel}Schema`},`).join("")}`;
+	const typeLine = options?.includeType ? `\n\nexport type ${model.name}Relations = typeof ${model.name}RelationsSchema.infer` : "";
+	return `export const ${model.name}RelationsSchema = type({${fields}})${typeLine}`;
+}
 
 //#endregion
 //#region src/generator/arktype/generator/schemas.ts
@@ -69,17 +82,31 @@ function arktype(models, type, comment) {
 //#endregion
 //#region src/generator/arktype/index.ts
 const { generatorHandler } = pkg;
-const emit = async (options) => {
+const buildRelationsOnly = (dmmf, includeType) => {
+	const models = dmmf.datamodel.models;
+	const relIndex = collectRelationProps(models);
+	const relByModel = {};
+	for (const r of relIndex) {
+		const existing = relByModel[r.model] ?? [];
+		relByModel[r.model] = [...existing, r];
+	}
+	return models.map((model) => makeArktypeRelations(model, (relByModel[model.name] ?? []).map(({ key, targetModel, isMany }) => ({
+		key,
+		targetModel,
+		isMany
+	})), { includeType })).filter((code) => Boolean(code)).join("\n\n");
+};
+const emit = async (options, enableRelation) => {
 	const outDir = options.generator.output?.value ?? "./arktype";
 	const file = getString(options.generator.config?.file, "index.ts") ?? "index.ts";
-	const fmtResult = await fmt(arktype(options.dmmf.datamodel.models, getBool(options.generator.config?.type), getBool(options.generator.config?.comment)));
+	const fmtResult = await fmt([arktype(options.dmmf.datamodel.models, getBool(options.generator.config?.type), getBool(options.generator.config?.comment)), enableRelation ? buildRelationsOnly(options.dmmf, getBool(options.generator.config?.type)) : ""].filter(Boolean).join("\n\n"));
 	if (!fmtResult.ok) throw new Error(`Format error: ${fmtResult.error}`);
 	const mkdirResult = await mkdir(outDir);
 	if (!mkdirResult.ok) throw new Error(`Failed to create directory: ${mkdirResult.error}`);
 	const writeResult = await writeFile(path.join(outDir, file), fmtResult.value);
 	if (!writeResult.ok) throw new Error(`Failed to write file: ${writeResult.error}`);
 };
-const onGenerate = (options) => emit(options);
+const onGenerate = (options) => emit(options, options.generator.config?.relation === "true" || Array.isArray(options.generator.config?.relation) && options.generator.config?.relation[0] === "true");
 generatorHandler({
 	onManifest() {
 		return {

package/dist/generator/dbml/index.d.ts

@@ -1,6 +1,9 @@
 import { GeneratorOptions } from "@prisma/generator-helper";
 
 //#region src/generator/dbml/index.d.ts
-declare function main(options: GeneratorOptions): Promise<void>;
+/**
+ * Main generator function
+ */
+declare const main: (options: GeneratorOptions) => Promise<void>;
 //#endregion
 export { main };