hekireki 0.3.0 → 0.4.0

package/README.md

@@ -1,5 +1,7 @@
 # Hekireki
 
+![img](https://raw.githubusercontent.com/nakita628/hekireki/refs/heads/main/assets/img/hekireki.png)
+
 **[Hekireki](https://www.npmjs.com/package/hekireki)** is a tool that generates validation schemas for Zod and Valibot, as well as ER diagrams, from [Prisma](https://www.prisma.io/) schemas annotated with comments.
 
 ## Features
@@ -38,12 +40,14 @@ generator Hekireki-Zod {
     provider = "hekireki-zod"
     type     = true
     comment  = true
+    relation = true
 }
 
 generator Hekireki-Valibot {
     provider = "hekireki-valibot"
     type     = true
     comment  = true
+    relation = true
 }
 
 generator Hekireki-Ecto {
@@ -128,6 +132,20 @@ export const PostSchema = z.object({
 })
 
 export type Post = z.infer<typeof PostSchema>
+
+export const UserRelationsSchema = z.object({
+  ...UserSchema.shape,
+  posts: z.array(PostSchema),
+})
+
+export type UserRelations = z.infer<typeof UserRelationsSchema>
+
+export const PostRelationsSchema = z.object({
+  ...PostSchema.shape,
+  user: UserSchema,
+})
+
+export type PostRelations = z.infer<typeof PostRelationsSchema>
 ```
 
 ## Valibot
@@ -167,6 +185,14 @@ export const PostSchema = v.object({
 })
 
 export type Post = v.InferInput<typeof PostSchema>
+
+export const UserRelationsSchema = v.object({ ...UserSchema.entries, posts: v.array(PostSchema) })
+
+export type UserRelations = v.InferInput<typeof UserRelationsSchema>
+
+export const PostRelationsSchema = v.object({ ...PostSchema.entries, user: UserSchema })
+
+export type PostRelations = v.InferInput<typeof PostRelationsSchema>
 ```
 
 ## Mermaid
@@ -237,6 +263,7 @@ end
 | `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
 
@@ -246,6 +273,7 @@ end
 | `file`       | `string`  | `index.ts`                          | File Name                                        |
 | `type`       | `boolean` | `false`                             | Generate TypeScript types                        |
 | `comment`    | `boolean` | `false`                             | Include schema documentation                     |
+| `relation`   | `boolean` | `false`                             | Generate relation schemas                        |
 
 ### Mermaid ER Generator Options
 

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

@@ -7,8 +7,12 @@ export async function main(options) {
     const content = erContent(options.dmmf.datamodel.models);
     const output = options.generator.output?.value ?? './mermaid-er';
     const file = options.generator.config?.file ?? 'ER.md';
-    await fsp.mkdir(output, { recursive: true });
-    await fsp.writeFile(`${output}/${file}`, content.join('\n'), { encoding: 'utf-8' });
+    // Handle case where output is a file path (contains extension)
+    const isOutputFile = output.includes('.');
+    const outputDir = isOutputFile ? '.' : output;
+    const outputFile = isOutputFile ? output : `${output}/${file}`;
+    await fsp.mkdir(outputDir, { recursive: true });
+    await fsp.writeFile(outputFile, content.join('\n'), { encoding: 'utf-8' });
 }
 // prisma generator handler
 generatorHandler({

package/dist/generator/valibot/generator/schema.d.ts

@@ -1,3 +1,12 @@
+import type { DMMF } from '@prisma/generator-helper';
+export declare function buildValibotModel(model: DMMF.Model): string;
+export declare function buildValibotRelations(model: DMMF.Model, relProps: readonly {
+    key: string;
+    targetModel: string;
+    isMany: boolean;
+}[], options?: Readonly<{
+    includeType?: boolean;
+}>): string | null;
 /**
  * Generate Valibot schema
  * @param modelName - The name of the model

package/dist/generator/valibot/generator/schema.js

@@ -1,3 +1,45 @@
+import { extractAnno, jsdoc } from '../utils/index.js';
+const vPrim = (f) => {
+    const anno = extractAnno(f.documentation ?? '', '@v.');
+    return wrapV(`v.${anno}`, f);
+};
+const wrapV = (expr, f) => {
+    const card = f.isList ? `v.array(${expr})` : expr;
+    return f.isRequired ? card : `v.optional(${card})`;
+};
+// jsdoc moved to utils
+export function buildValibotModel(model) {
+    const fields = model.fields
+        .filter((f) => f.kind !== 'object')
+        .map((f) => `${jsdoc(f.documentation)}  ${f.name}: ${vPrim(f)},`)
+        .join('\n');
+    const modelAnno = extractAnno(model.documentation ?? '', '@v.');
+    const objectDef = modelAnno === 'strictObject'
+        ? `v.strictObject({\n${fields}\n})`
+        : modelAnno === 'looseObject'
+            ? `v.looseObject({\n${fields}\n})`
+            : `v.object({\n${fields}\n})`;
+    return `export const ${model.name}Schema = ${objectDef}\n\nexport type ${model.name} = v.InferInput<typeof ${model.name}Schema>`;
+}
+export function buildValibotRelations(model, relProps, options) {
+    if (relProps.length === 0)
+        return null;
+    const base = `...${model.name}Schema.entries`;
+    const rels = relProps
+        .map((r) => `${r.key}: ${r.isMany ? `v.array(${r.targetModel}Schema)` : `${r.targetModel}Schema`}`)
+        .join(', ');
+    const modelAnno = extractAnno(model.documentation ?? '', '@v.');
+    const objectDef = modelAnno === 'strictObject'
+        ? `v.strictObject({ ${base}, ${rels} })`
+        : modelAnno === 'looseObject'
+            ? `v.looseObject({ ${base}, ${rels} })`
+            : `v.object({ ${base}, ${rels} })`;
+    const typeLine = options?.includeType
+        ? `\n\nexport type ${model.name}Relations = v.InferInput<typeof ${model.name}RelationsSchema>`
+        : '';
+    return `export const ${model.name}RelationsSchema = ${objectDef}${typeLine}`;
+}
+// extractAnno provided by utils
 /**
  * Generate Valibot schema
  * @param modelName - The name of the model

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

@@ -1,3 +1,3 @@
 #!/usr/bin/env node
 import type { GeneratorOptions } from '@prisma/generator-helper';
-export declare function main(options: GeneratorOptions): Promise<void>;
+export declare const onGenerate: (options: GeneratorOptions) => Promise<void>;

package/dist/generator/valibot/index.js

@@ -1,17 +1,47 @@
 #!/usr/bin/env node
 import fsp from 'node:fs/promises';
+import path from 'node:path';
 import pkg from '@prisma/generator-helper';
 import { fmt } from '../../shared/format/index.js';
+import { collectRelationProps } from '../../shared/helper/relations.js';
+import { buildValibotRelations } from './generator/schema.js';
 import { valibot } from './generator/valibot.js';
 const { generatorHandler } = pkg;
-export async function main(options) {
-    const output = options.generator.output?.value ?? './valibot';
-    const file = options.generator.config?.file ?? 'index.ts';
-    const content = valibot(options.dmmf.datamodel.models, options.generator.config?.type === 'true', options.generator.config?.comment === 'true');
-    const code = await fmt(content);
-    await fsp.mkdir(output, { recursive: true });
-    await fsp.writeFile(`${output}/${file}`, code, { encoding: 'utf-8' });
-}
+const buildRelationsOnly = (dmmf, includeType) => {
+    const models = dmmf.datamodel.models;
+    const relIndex = collectRelationProps(models);
+    const relByModel = relIndex.reduce((acc, r) => {
+        if (!acc[r.model])
+            acc[r.model] = [];
+        acc[r.model].push(r);
+        return acc;
+    }, {});
+    return models
+        .map((model) => buildValibotRelations(model, (relByModel[model.name] ?? []).map(({ key, targetModel, isMany }) => ({
+        key,
+        targetModel,
+        isMany,
+    })), { includeType }))
+        .filter((code) => Boolean(code))
+        .join('\n\n');
+};
+const getString = (v, fallback) => typeof v === 'string' ? v : Array.isArray(v) ? (v[0] ?? fallback) : fallback;
+const getBool = (v, fallback = false) => v === true || v === 'true' || (Array.isArray(v) && v[0] === 'true') ? true : fallback;
+const emit = async (options, enableRelation) => {
+    const outDir = options.generator.output?.value ?? './valibot';
+    const file = getString(options.generator.config?.file, 'index.ts') ?? 'index.ts';
+    const base = valibot(options.dmmf.datamodel.models, getBool(options.generator.config?.type), getBool(options.generator.config?.comment));
+    const relations = enableRelation
+        ? buildRelationsOnly(options.dmmf, getBool(options.generator.config?.type))
+        : '';
+    const full = [base, relations].filter(Boolean).join('\n\n');
+    const code = await fmt(full);
+    await fsp.mkdir(outDir, { recursive: true });
+    await fsp.writeFile(path.join(outDir, file), code, 'utf8');
+};
+export 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 {
@@ -19,5 +49,5 @@ generatorHandler({
             prettyName: 'Hekireki-Valibot',
         };
     },
-    onGenerate: main,
+    onGenerate,
 });

package/dist/generator/valibot/utils/index.d.ts

@@ -40,3 +40,5 @@ export declare function isValibotDocument(documentation?: string): string[];
  * @returns The Valibot expression without "@v." prefix, or null if not found.
  */
 export declare function isValibot(documentation?: string): string | null;
+export declare const extractAnno: (doc: string, tag: "@z." | "@v.") => string | null;
+export declare const jsdoc: (doc?: string) => string;

package/dist/generator/valibot/utils/index.js

@@ -59,3 +59,17 @@ export function isValibot(documentation) {
     const match = documentation.match(/@v\.(.+?)(?:\n|$)/);
     return match ? match[1].trim() : null;
 }
+export const extractAnno = (doc, tag) => {
+    const line = doc
+        .split('\n')
+        .map((s) => s.trim())
+        .find((l) => l.startsWith(tag));
+    return line ? line.slice(tag.length) : null;
+};
+export const jsdoc = (doc) => {
+    const lines = (doc ?? '')
+        .split('\n')
+        .map((s) => s.trim())
+        .filter((l) => l && !l.startsWith('@z.') && !l.startsWith('@v.'));
+    return lines.length ? `/**\n * ${lines.join('\n * ')}\n */\n` : '';
+};

package/dist/generator/zod/generator/schema.d.ts

@@ -1,3 +1,12 @@
+import type { DMMF } from '@prisma/generator-helper';
+export declare function buildZodModel(model: DMMF.Model): Readonly<string>;
+export declare function buildZodRelations(model: DMMF.Model, relProps: readonly {
+    key: string;
+    targetModel: string;
+    isMany: boolean;
+}[], options?: Readonly<{
+    includeType?: boolean;
+}>): string | null;
 /**
  * Generate Zod schema
  * @param modelName - The name of the model

package/dist/generator/zod/generator/schema.js

@@ -1,3 +1,31 @@
+import { buildZodObject, extractAnno, jsdoc, wrapCardinality } from '../utils/index.js';
+const zPrim = (f) => {
+    const anno = extractAnno(f.documentation ?? '', '@z.');
+    return wrapCardinality(`z.${anno}`, f);
+};
+// moved to utils
+export function buildZodModel(model) {
+    const fields = model.fields
+        .filter((f) => f.kind !== 'object')
+        .map((f) => `${jsdoc(f.documentation)}  ${f.name}: ${zPrim(f)},`)
+        .join('\n');
+    const objectDef = buildZodObject(fields, model.documentation);
+    return `export const ${model.name}Schema = ${objectDef}\n\nexport type ${model.name} = z.infer<typeof ${model.name}Schema>`;
+}
+export function buildZodRelations(model, relProps, options) {
+    if (relProps.length === 0)
+        return null;
+    const base = `...${model.name}Schema.shape`;
+    const rels = relProps
+        .map((r) => `${r.key}: ${r.isMany ? `z.array(${r.targetModel}Schema)` : `${r.targetModel}Schema`}`)
+        .join(', ');
+    const objectDef = buildZodObject(`${base}, ${rels}`, model.documentation);
+    const typeLine = options?.includeType
+        ? `\n\nexport type ${model.name}Relations = z.infer<typeof ${model.name}RelationsSchema>`
+        : '';
+    return `export const ${model.name}RelationsSchema = ${objectDef}${typeLine}`;
+}
+// moved to utils
 /**
  * Generate Zod schema
  * @param modelName - The name of the model

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

@@ -1,3 +1,3 @@
 #!/usr/bin/env node
 import type { GeneratorOptions } from '@prisma/generator-helper';
-export declare function main(options: GeneratorOptions): Promise<void>;
+export declare const onGenerate: (options: GeneratorOptions) => Promise<void>;

package/dist/generator/zod/index.js

@@ -1,18 +1,58 @@
 #!/usr/bin/env node
 import fsp from 'node:fs/promises';
+import path from 'node:path';
 import pkg from '@prisma/generator-helper';
 import { fmt } from '../../shared/format/index.js';
+import { collectRelationProps } from '../../shared/helper/relations.js';
+import { buildZodRelations } from './generator/schema.js';
 import { zod } from './generator/zod.js';
 const { generatorHandler } = pkg;
-export async function main(options) {
-    const output = options.generator.output?.value ?? './zod';
-    const file = options.generator.config?.file ?? 'index.ts';
-    const zodVersion = options.generator.config?.zod ?? 'v4';
-    const content = zod(options.dmmf.datamodel.models, options.generator.config?.type === 'true', options.generator.config?.comment === 'true', zodVersion);
-    const code = await fmt(content);
-    await fsp.mkdir(output, { recursive: true });
-    await fsp.writeFile(`${output}/${file}`, code, { encoding: 'utf-8' });
-}
+const buildRelationsOnly = (dmmf, includeType) => {
+    const models = dmmf.datamodel.models;
+    const relIndex = collectRelationProps(models);
+    const relByModel = relIndex.reduce((acc, r) => {
+        if (!acc[r.model])
+            acc[r.model] = [];
+        acc[r.model].push(r);
+        return acc;
+    }, {});
+    const blocks = models
+        .map((model) => {
+        const relProps = (relByModel[model.name] ?? []).map(({ key, targetModel, isMany }) => ({
+            key,
+            targetModel,
+            isMany,
+        }));
+        if (relProps.length === 0)
+            return '';
+        const schema = buildZodRelations(model, relProps);
+        const typeLine = includeType
+            ? `\n\nexport type ${model.name}Relations = z.infer<typeof ${model.name}RelationsSchema>`
+            : '';
+        return `${schema}${typeLine}`;
+    })
+        .filter(Boolean);
+    return blocks.join('\n\n');
+};
+const getString = (v, fallback) => typeof v === 'string' ? v : Array.isArray(v) ? (v[0] ?? fallback) : fallback;
+const getBool = (v, fallback = false) => v === true || v === 'true' || (Array.isArray(v) && v[0] === 'true') ? true : fallback;
+const emit = async (options, enableRelation) => {
+    const outDir = options.generator.output?.value ?? './zod';
+    const file = getString(options.generator.config?.file, 'index.ts') ?? 'index.ts';
+    const zodVersion = getString(options.generator.config?.zod, 'v4');
+    const base = zod(options.dmmf.datamodel.models, getBool(options.generator.config?.type), getBool(options.generator.config?.comment), zodVersion);
+    // Respect the `type` flag when generating relation schemas
+    const relations = enableRelation
+        ? buildRelationsOnly(options.dmmf, getBool(options.generator.config?.type))
+        : '';
+    const full = [base, relations].filter(Boolean).join('\n\n');
+    const code = await fmt(full);
+    await fsp.mkdir(outDir, { recursive: true });
+    await fsp.writeFile(path.join(outDir, file), code, 'utf8');
+};
+export 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 {
@@ -20,5 +60,5 @@ generatorHandler({
             prettyName: 'Hekireki-Zod',
         };
     },
-    onGenerate: main,
+    onGenerate,
 });

package/dist/generator/zod/utils/index.d.ts

@@ -1,3 +1,4 @@
+import type { DMMF } from '@prisma/generator-helper';
 /**
  * Generates a `z.infer` type for the specified model.
  *
@@ -40,3 +41,6 @@ export declare function isZodDocument(documentation?: string): string[];
  * @returns The Zod validation string without the "@z." prefix, or null if not found.
  */
 export declare function isZod(documentation?: string): string | null;
+export { extractAnno, jsdoc } from '../../../shared/utils/index.js';
+export declare const wrapCardinality: (expr: string, field: DMMF.Field) => string;
+export declare const buildZodObject: (inner: string, documentation?: string) => string;

package/dist/generator/zod/utils/index.js

@@ -1,3 +1,4 @@
+import { extractAnno } from '../../../shared/utils/index.js';
 /**
  * Generates a `z.infer` type for the specified model.
  *
@@ -59,3 +60,16 @@ export function isZod(documentation) {
     const match = documentation.match(/@z\.(.+?)(?:\n|$)/);
     return match ? match[1].trim() : null;
 }
+export { extractAnno, jsdoc } from '../../../shared/utils/index.js';
+export const wrapCardinality = (expr, field) => {
+    const withList = field.isList ? `z.array(${expr})` : expr;
+    return field.isRequired ? withList : `${withList}.optional()`;
+};
+export const buildZodObject = (inner, documentation) => {
+    const anno = extractAnno(documentation ?? '', '@z.');
+    return anno === 'strictObject'
+        ? `z.strictObject({\n${inner}\n})`
+        : anno === 'looseObject'
+            ? `z.looseObject({\n${inner}\n})`
+            : `z.object({\n${inner}\n})`;
+};

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

@@ -0,0 +1,11 @@
+import type { DMMF, GeneratorOptions } from '@prisma/generator-helper';
+export declare function schemaGenerator(outDir: Readonly<string>, dmmf: Readonly<GeneratorOptions['dmmf']>, importCode: string, buildSchema: (model: DMMF.Model) => Readonly<string>, buildRelations: (model: DMMF.Model, relProps: readonly {
+    key: string;
+    targetModel: string;
+    isMany: boolean;
+}[]) => Readonly<string>, collectRelationProps: (models: readonly DMMF.Model[]) => Readonly<{
+    model: string;
+    key: string;
+    targetModel: string;
+    isMany: boolean;
+}[]>): Promise<void>;

package/dist/shared/generator/index.js

@@ -0,0 +1,23 @@
+import fsp from 'node:fs/promises';
+import path from 'node:path';
+export async function schemaGenerator(outDir, dmmf, importCode, buildSchema, buildRelations, collectRelationProps) {
+    const models = dmmf.datamodel.models;
+    const relIndex = collectRelationProps(models);
+    const relByModel = Object.groupBy(relIndex, (r) => r.model);
+    const baseSchemas = models.map((m) => buildSchema(m)).join('\n\n');
+    const relationSchemas = models
+        .map((m) => {
+        const relProps = (relByModel[m.name] ?? []).map(({ key, targetModel, isMany }) => ({
+            key,
+            targetModel,
+            isMany,
+        }));
+        return buildRelations(m, relProps);
+    })
+        .filter(Boolean)
+        .join('\n\n');
+    const body = relationSchemas ? `${baseSchemas}\n\n${relationSchemas}` : baseSchemas;
+    const code = `${importCode}\n${body}\n`;
+    await fsp.mkdir(outDir, { recursive: true });
+    await fsp.writeFile(path.join(outDir, 'index.ts'), code, 'utf8');
+}

package/dist/shared/helper/relations.d.ts

@@ -0,0 +1,7 @@
+import type { DMMF } from '@prisma/generator-helper';
+export declare function collectRelationProps(models: readonly DMMF.Model[]): Readonly<{
+    model: string;
+    key: string;
+    targetModel: string;
+    isMany: boolean;
+}[]>;

package/dist/shared/helper/relations.js

@@ -0,0 +1,5 @@
+export function collectRelationProps(models) {
+    return models.flatMap((m) => m.fields
+        .filter((f) => f.kind === 'object')
+        .map((f) => ({ model: m.name, key: f.name, targetModel: f.type, isMany: f.isList })));
+}

package/dist/shared/utils/index.d.ts

@@ -50,3 +50,12 @@ export declare function isFields(modelFields: {
     comment: string[];
     validation: string | null;
 }>[];
+/**
+ * Extracts annotation content from documentation lines.
+ * Returns the substring after the tag (e.g. '@z.' or '@v.').
+ */
+export declare const extractAnno: (doc: string, tag: "@z." | "@v.") => string | null;
+/**
+ * Builds JSDoc from documentation, excluding annotation lines like '@z.' and '@v.'.
+ */
+export declare const jsdoc: (doc?: string) => string;

package/dist/shared/utils/index.js

@@ -40,3 +40,24 @@ export function groupByModel(validFields) {
 export function isFields(modelFields) {
     return modelFields.flat().filter((field) => field.validation !== null);
 }
+/**
+ * Extracts annotation content from documentation lines.
+ * Returns the substring after the tag (e.g. '@z.' or '@v.').
+ */
+export const extractAnno = (doc, tag) => {
+    const line = doc
+        .split('\n')
+        .map((s) => s.trim())
+        .find((l) => l.startsWith(tag));
+    return line ? line.slice(tag.length) : null;
+};
+/**
+ * Builds JSDoc from documentation, excluding annotation lines like '@z.' and '@v.'.
+ */
+export const jsdoc = (doc) => {
+    const lines = (doc ?? '')
+        .split('\n')
+        .map((s) => s.trim())
+        .filter((l) => l && !l.startsWith('@z.') && !l.startsWith('@v.'));
+    return lines.length ? `/**\n * ${lines.join('\n * ')}\n */\n` : '';
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "hekireki",
   "type": "module",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "license": "MIT",
   "description": "Hekireki is a tool that generates validation schemas for Zod and Valibot, as well as ER diagrams, from Prisma schemas annotated with comments.",
   "keywords": [
@@ -48,7 +48,7 @@
   },
   "devDependencies": {
     "@prisma/client": "^6.10.1",
-    "@types/node": "^22.15.34",
+    "@types/node": "^22.18.0",
     "@vitest/coverage-v8": "^3.2.4",
     "prisma": "^6.10.1",
     "tsx": "^4.20.3",