hekireki 0.2.7 → 0.2.8

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

@@ -0,0 +1,42 @@
+/**
+ * Generates a `z.infer` type for the specified model.
+ *
+ * @param modelName - The name of the model.
+ * @returns The generated TypeScript type definition line using Zod.
+ */
+export declare function infer(modelName: string): string;
+/**
+ * Generates Zod property definitions from model fields.
+ *
+ * Filters out fields without validation, removes documentation lines
+ * that include @relation, @v, or @z, and optionally includes doc comments.
+ *
+ * @param modelFields - The list of model fields with documentation and validation info.
+ * @param comment - Whether to include JSDoc comments for each field.
+ * @returns A string containing formatted Zod property definitions.
+ */
+export declare function properties(modelFields: {
+    documentation: string;
+    modelName: string;
+    fieldName: string;
+    validation: string | null;
+    comment: string[];
+}[], comment: boolean): string;
+/**
+ * Parses documentation and removes Zod validation lines.
+ *
+ * Lines containing "@z." are excluded from the result.
+ *
+ * @param documentation - The documentation string to parse.
+ * @returns An array of non-Zod documentation lines.
+ */
+export declare function isZodDocument(documentation?: string): string[];
+/**
+ * Extracts the Zod validation expression from documentation.
+ *
+ * Searches for a line starting with "@z." and returns the expression part.
+ *
+ * @param documentation - The documentation string to parse.
+ * @returns The Zod validation string without the "@z." prefix, or null if not found.
+ */
+export declare function isZod(documentation?: string): string | null;

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

@@ -0,0 +1,61 @@
+/**
+ * Generates a `z.infer` type for the specified model.
+ *
+ * @param modelName - The name of the model.
+ * @returns The generated TypeScript type definition line using Zod.
+ */
+export function infer(modelName) {
+    return `export type ${modelName} = z.infer<typeof ${modelName}Schema>`;
+}
+/**
+ * Generates Zod property definitions from model fields.
+ *
+ * Filters out fields without validation, removes documentation lines
+ * that include @relation, @v, or @z, and optionally includes doc comments.
+ *
+ * @param modelFields - The list of model fields with documentation and validation info.
+ * @param comment - Whether to include JSDoc comments for each field.
+ * @returns A string containing formatted Zod property definitions.
+ */
+export function properties(modelFields, comment) {
+    const fields = modelFields
+        .filter((field) => field.validation)
+        .map((field) => {
+        const cleanDoc = field.comment
+            .filter((line) => !(line.includes('@relation') || line.includes('@v') || line.includes('@z')))
+            .join('\n')
+            .trim();
+        const docComment = comment && cleanDoc ? `  /**\n   * ${cleanDoc}\n   */\n` : '';
+        return `${docComment}  ${field.fieldName}: z.${field.validation}`;
+    })
+        .join(',\n');
+    return fields;
+}
+/**
+ * Parses documentation and removes Zod validation lines.
+ *
+ * Lines containing "@z." are excluded from the result.
+ *
+ * @param documentation - The documentation string to parse.
+ * @returns An array of non-Zod documentation lines.
+ */
+export function isZodDocument(documentation) {
+    return (documentation
+        ?.split('\n')
+        .map((line) => line.trim())
+        .filter((line) => line && !line.includes('@z.')) ?? []);
+}
+/**
+ * Extracts the Zod validation expression from documentation.
+ *
+ * Searches for a line starting with "@z." and returns the expression part.
+ *
+ * @param documentation - The documentation string to parse.
+ * @returns The Zod validation string without the "@z." prefix, or null if not found.
+ */
+export function isZod(documentation) {
+    if (!documentation)
+        return null;
+    const match = documentation.match(/@z\.(.+?)(?:\n|$)/);
+    return match ? match[1].trim() : null;
+}

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

@@ -1,3 +1,52 @@
-export { capitalize } from './capitalize.js';
-export { decapitalize } from './decapitalize.js';
-export { snakeCase } from './snake-case.js';
+/**
+ * Capitalize the first letter of a string.
+ *
+ * @param str - The input string.
+ * @returns A new string with the first letter capitalized.
+ */
+export declare function capitalize(str: string): string;
+/**
+ * Convert a camelCase or PascalCase string to snake_case.
+ *
+ * @param name - The input string in camelCase or PascalCase.
+ * @returns The converted string in snake_case.
+ */
+export declare function snakeCase(name: string): string;
+/**
+ * Group valid fields by their model name.
+ *
+ * @param validFields - An array of field objects with validation metadata.
+ * @returns An object mapping each model name to its corresponding array of fields.
+ */
+export declare function groupByModel(validFields: Required<{
+    documentation: string;
+    modelName: string;
+    fieldName: string;
+    comment: string[];
+    validation: string | null;
+}>[]): Record<string, {
+    documentation: string;
+    modelName: string;
+    fieldName: string;
+    comment: string[];
+    validation: string | null;
+}[]>;
+/**
+ * Extract fields with validation from a nested array of model fields.
+ *
+ * @param modelFields - A nested array of model field definitions.
+ * @returns A flat array of fields that include a non-null `validation` property.
+ */
+export declare function isFields(modelFields: {
+    documentation: string | undefined;
+    modelName: string;
+    fieldName: string;
+    comment: string[];
+    validation: string | null;
+}[][]): Required<{
+    documentation: string;
+    modelName: string;
+    fieldName: string;
+    comment: string[];
+    validation: string | null;
+}>[];

package/dist/shared/utils/index.js

@@ -1,3 +1,42 @@
-export { capitalize } from './capitalize.js';
-export { decapitalize } from './decapitalize.js';
-export { snakeCase } from './snake-case.js';
+/**
+ * Capitalize the first letter of a string.
+ *
+ * @param str - The input string.
+ * @returns A new string with the first letter capitalized.
+ */
+export function capitalize(str) {
+    return `${str.charAt(0).toUpperCase()}${str.slice(1)}`;
+}
+/**
+ * Convert a camelCase or PascalCase string to snake_case.
+ *
+ * @param name - The input string in camelCase or PascalCase.
+ * @returns The converted string in snake_case.
+ */
+export function snakeCase(name) {
+    return `${name.replace(/([a-z0-9])([A-Z])/g, '$1_$2').toLowerCase()}`;
+}
+/**
+ * Group valid fields by their model name.
+ *
+ * @param validFields - An array of field objects with validation metadata.
+ * @returns An object mapping each model name to its corresponding array of fields.
+ */
+export function groupByModel(validFields) {
+    return validFields.reduce((acc, field) => {
+        if (!acc[field.modelName]) {
+            acc[field.modelName] = [];
+        }
+        acc[field.modelName].push(field);
+        return acc;
+    }, {});
+}
+/**
+ * Extract fields with validation from a nested array of model fields.
+ *
+ * @param modelFields - A nested array of model field definitions.
+ * @returns A flat array of fields that include a non-null `validation` property.
+ */
+export function isFields(modelFields) {
+    return modelFields.flat().filter((field) => field.validation !== null);
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "hekireki",
   "type": "module",
-  "version": "0.2.7",
+  "version": "0.2.8",
   "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": [
@@ -42,6 +42,10 @@
     "coverage": "vitest run --coverage",
     "release": "npm pkg fix && pnpm build && npm publish"
   },
+  "dependencies": {
+    "@prisma/generator-helper": "^6.10.1",
+    "prettier": "^3.6.2"
+  },
   "devDependencies": {
     "@prisma/client": "^6.10.1",
     "@types/node": "^22.15.34",
@@ -50,10 +54,6 @@
     "tsx": "^4.20.3",
     "valibot": "1.1.0",
     "vitest": "^3.2.4",
-    "zod": "^3.25.76"
-  },
-  "dependencies": {
-    "@prisma/generator-helper": "^6.10.1",
-    "prettier": "^3.6.2"
+    "zod": "^4.0.5"
   }
 }

package/dist/generator/mermaid-er/relationship/build-relation-line.d.ts

@@ -1,9 +0,0 @@
-declare const RELATIONSHIPS: {
-    readonly 'zero-one': "|o";
-    readonly one: "||";
-    readonly 'zero-many': "}o";
-    readonly many: "}|";
-};
-export type Relationship = keyof typeof RELATIONSHIPS;
-export declare function buildRelationLine(input: string): string;
-export {};

package/dist/generator/mermaid-er/types.d.ts

@@ -1,10 +0,0 @@
-import type { DMMF } from '@prisma/generator-helper';
-export type Relation = {
-    fromModel: string;
-    toModel: string;
-    fromField: string;
-    toField: string;
-    type: string;
-};
-export type Model = Readonly<DMMF.Model>;
-export type ERContent = readonly string[];

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

@@ -1 +0,0 @@
-export {};

package/dist/generator/mermaid-er/validator/exclude-many-to-one-relations.d.ts

@@ -1,7 +0,0 @@
-/**
- * exclude many-to-one relations
- * @function excludeManyToOneRelations
- * @param relations
- * @returns
- */
-export declare function excludeManyToOneRelations(relations: readonly string[]): readonly string[];

package/dist/generator/mermaid-er/validator/exclude-many-to-one-relations.js

@@ -1,9 +0,0 @@
-/**
- * exclude many-to-one relations
- * @function excludeManyToOneRelations
- * @param relations
- * @returns
- */
-export function excludeManyToOneRelations(relations) {
-    return [...new Set(relations)].filter((r) => !r.includes('many-to-one'));
-}

package/dist/generator/mermaid-er/validator/extract-relations.d.ts

@@ -1,7 +0,0 @@
-import type { Model } from '../types.js';
-/**
- * extract relations from model
- * @param { Model } model
- * @returns { readonly string[] }
- */
-export declare function extractRelations(model: Model): readonly string[];

package/dist/generator/mermaid-er/validator/index.d.ts

@@ -1,5 +0,0 @@
-export { excludeManyToOneRelations } from './exclude-many-to-one-relations.js';
-export { extractRelations } from './extract-relations.js';
-export { isRelationship } from './is-relationship.js';
-export { parseRelation } from './parse-relation.js';
-export { removeDuplicateRelations } from './remove-duplicate-relations.js';

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

@@ -1,5 +0,0 @@
-export { excludeManyToOneRelations } from './exclude-many-to-one-relations.js';
-export { extractRelations } from './extract-relations.js';
-export { isRelationship } from './is-relationship.js';
-export { parseRelation } from './parse-relation.js';
-export { removeDuplicateRelations } from './remove-duplicate-relations.js';

package/dist/generator/mermaid-er/validator/is-relationship.d.ts

@@ -1,7 +0,0 @@
-import type { Relationship } from '../relationship/build-relation-line.js';
-/**
- * isRelationship
- * @param { string } key
- * @returns { key is Relationship }
- */
-export declare function isRelationship(key: string): key is Relationship;

package/dist/generator/mermaid-er/validator/is-relationship.js

@@ -1,8 +0,0 @@
-/**
- * isRelationship
- * @param { string } key
- * @returns { key is Relationship }
- */
-export function isRelationship(key) {
-    return ['zero-one', 'one', 'zero-many', 'many'].includes(key);
-}

package/dist/generator/mermaid-er/validator/parse-relation.d.ts

@@ -1,8 +0,0 @@
-import type { Relation } from '../types.js';
-/**
- * parse relation
- * @function parseRelation
- * @param line
- * @returns
- */
-export declare function parseRelation(line: string): Relation | null;

package/dist/generator/mermaid-er/validator/parse-relation.js

@@ -1,21 +0,0 @@
-/**
- * parse relation
- * @function parseRelation
- * @param line
- * @returns
- */
-export function parseRelation(line) {
-    const relationRegex = /^@relation\s+(\w+)\.(\w+)\s+(\w+)\.(\w+)\s+(\w+-to-\w+)$/;
-    const match = line.trim().match(relationRegex);
-    if (!match) {
-        return null;
-    }
-    const [, fromModel, fromField, toModel, toField, relationType] = match;
-    return {
-        fromModel,
-        fromField,
-        toModel,
-        toField,
-        type: relationType,
-    };
-}

package/dist/generator/mermaid-er/validator/remove-duplicate-relations.d.ts

@@ -1,6 +0,0 @@
-/**
- * remove duplicate relations
- * @param { readonly string[] } relations
- * @returns { readonly string[] }
- */
-export declare function removeDuplicateRelations(relations: readonly string[]): readonly string[];

package/dist/generator/mermaid-er/validator/remove-duplicate-relations.js

@@ -1,8 +0,0 @@
-/**
- * remove duplicate relations
- * @param { readonly string[] } relations
- * @returns { readonly string[] }
- */
-export function removeDuplicateRelations(relations) {
-    return [...new Set(relations)];
-}

package/dist/generator/valibot/generator/infer-input.d.ts

@@ -1,7 +0,0 @@
-/**
- * Generate the infer input type for the model
- * @param modelName - The name of the model
- * @param config - The configuration for the generator
- * @returns The generated infer input type
- */
-export declare function inferInput(modelName: string): string;

package/dist/generator/valibot/generator/infer-input.js

@@ -1,9 +0,0 @@
-/**
- * Generate the infer input type for the model
- * @param modelName - The name of the model
- * @param config - The configuration for the generator
- * @returns The generated infer input type
- */
-export function inferInput(modelName) {
-    return `export type ${modelName} = v.InferInput<typeof ${modelName}Schema>`;
-}

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

@@ -1,7 +0,0 @@
-export declare function properties(modelFields: {
-    documentation: string;
-    modelName: string;
-    fieldName: string;
-    validation: string | null;
-    comment: string[];
-}[], comment: boolean): string;

package/dist/generator/valibot/generator/properties.js

@@ -1,15 +0,0 @@
-export function properties(modelFields, comment) {
-    const fields = modelFields
-        .filter((field) => field.validation)
-        .map((field) => {
-        // @relation, @v, @z exclude
-        const cleanDoc = field.comment
-            .filter((line) => !(line.includes('@relation') || line.includes('@v') || line.includes('@z')))
-            .join('\n')
-            .trim();
-        const docComment = comment && cleanDoc ? `  /**\n   * ${cleanDoc}\n   */\n` : '';
-        return `${docComment}  ${field.fieldName}: v.${field.validation}`;
-    })
-        .join(',\n');
-    return fields;
-}

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

@@ -1,2 +0,0 @@
-export { isValibotDocument } from './is-valibot-document.js';
-export { isValibot } from './is-valibot.js';

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

@@ -1,2 +0,0 @@
-export { isValibotDocument } from './is-valibot-document.js';
-export { isValibot } from './is-valibot.js';

package/dist/generator/valibot/validator/is-valibot-document.d.ts

@@ -1 +0,0 @@
-export declare function isValibotDocument(documentation?: string): string[];

package/dist/generator/valibot/validator/is-valibot-document.js

@@ -1,10 +0,0 @@
-const VALIDATION_PATTERNS = ['@v.'];
-export function isValibotDocument(documentation) {
-    if (!documentation)
-        return [];
-    return documentation
-        .split('\n')
-        .filter((line) => !VALIDATION_PATTERNS.some((pattern) => line.includes(pattern)))
-        .map((line) => line.trim())
-        .filter(Boolean);
-}

package/dist/generator/valibot/validator/is-valibot.d.ts

@@ -1,6 +0,0 @@
-/**
- * Check if the documentation is a Valibot validation
- * @param documentation
- * @returns string | null
- */
-export declare function isValibot(documentation?: string): string | null;

package/dist/generator/valibot/validator/is-valibot.js

@@ -1,11 +0,0 @@
-/**
- * Check if the documentation is a Valibot validation
- * @param documentation
- * @returns string | null
- */
-export function isValibot(documentation) {
-    if (!documentation)
-        return null;
-    const match = documentation.match(/@v\.(.+?)(?:\n|$)/);
-    return match ? match[1].trim() : null;
-}

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

@@ -1,7 +0,0 @@
-/**
- * Generate Zod infer
- * @param modelName - The name of the model
- * @param config - The configuration for the generator
- * @returns The generated Zod infer
- */
-export declare function infer(modelName: string): string;

package/dist/generator/zod/generator/infer.js

@@ -1,9 +0,0 @@
-/**
- * Generate Zod infer
- * @param modelName - The name of the model
- * @param config - The configuration for the generator
- * @returns The generated Zod infer
- */
-export function infer(modelName) {
-    return `export type ${modelName} = z.infer<typeof ${modelName}Schema>`;
-}

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

@@ -1,13 +0,0 @@
-/**
- * Generate Zod properties
- * @param modelFields - The fields of the model
- * @param config - The configuration for the generator
- * @returns The generated Zod properties
- */
-export declare function properties(modelFields: {
-    documentation: string;
-    modelName: string;
-    fieldName: string;
-    validation: string | null;
-    comment: string[];
-}[], comment: boolean): string;

package/dist/generator/zod/generator/properties.js

@@ -1,21 +0,0 @@
-/**
- * Generate Zod properties
- * @param modelFields - The fields of the model
- * @param config - The configuration for the generator
- * @returns The generated Zod properties
- */
-export function properties(modelFields, comment) {
-    const fields = modelFields
-        .filter((field) => field.validation)
-        .map((field) => {
-        // @relation, @v, @z exclude
-        const cleanDoc = field.comment
-            .filter((line) => !(line.includes('@relation') || line.includes('@v') || line.includes('@z')))
-            .join('\n')
-            .trim();
-        const docComment = comment && cleanDoc ? `  /**\n   * ${cleanDoc}\n   */\n` : '';
-        return `${docComment}  ${field.fieldName}: z.${field.validation}`;
-    })
-        .join(',\n');
-    return fields;
-}

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

@@ -1,2 +0,0 @@
-export { isZod } from './is-zod.js';
-export { isZodDocument } from './is-zod-document.js';

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

@@ -1,2 +0,0 @@
-export { isZod } from './is-zod.js';
-export { isZodDocument } from './is-zod-document.js';

package/dist/generator/zod/validator/is-zod-document.d.ts

@@ -1,6 +0,0 @@
-/**
- * Is Zod documentation
- * @param documentation - The documentation of the field
- * @returns The Zod documentation
- */
-export declare function isZodDocument(documentation?: string): string[];

package/dist/generator/zod/validator/is-zod-document.js

@@ -1,15 +0,0 @@
-const VALIDATION_PATTERNS = ['@z.'];
-/**
- * Is Zod documentation
- * @param documentation - The documentation of the field
- * @returns The Zod documentation
- */
-export function isZodDocument(documentation) {
-    if (!documentation)
-        return [];
-    return documentation
-        .split('\n')
-        .filter((line) => !VALIDATION_PATTERNS.some((pattern) => line.includes(pattern)))
-        .map((line) => line.trim())
-        .filter(Boolean);
-}

package/dist/generator/zod/validator/is-zod.d.ts

@@ -1,6 +0,0 @@
-/**
- * Is Zod validation
- * @param documentation - The documentation of the field
- * @returns The Zod validation
- */
-export declare function isZod(documentation?: string): string | null;

package/dist/generator/zod/validator/is-zod.js

@@ -1,11 +0,0 @@
-/**
- * Is Zod validation
- * @param documentation - The documentation of the field
- * @returns The Zod validation
- */
-export function isZod(documentation) {
-    if (!documentation)
-        return null;
-    const match = documentation.match(/@z\.(.+?)(?:\n|$)/);
-    return match ? match[1].trim() : null;
-}

package/dist/shared/helper/group-by-model.d.ts

@@ -1,8 +0,0 @@
-import type { GroupedFields, ValidField } from '../types.js';
-/**
- * Groups valid fields by model name.
- *
- * @param validFields - The array of valid fields.
- * @returns The grouped fields.
- */
-export declare function groupByModel(validFields: ValidField[]): GroupedFields;

package/dist/shared/helper/group-by-model.js

@@ -1,15 +0,0 @@
-/**
- * Groups valid fields by model name.
- *
- * @param validFields - The array of valid fields.
- * @returns The grouped fields.
- */
-export function groupByModel(validFields) {
-    return validFields.reduce((acc, field) => {
-        if (!acc[field.modelName]) {
-            acc[field.modelName] = [];
-        }
-        acc[field.modelName].push(field);
-        return acc;
-    }, {});
-}

package/dist/shared/types.d.ts

@@ -1,16 +0,0 @@
-import type { DMMF } from '@prisma/generator-helper';
-export type Field = {
-    documentation: string;
-    modelName: string;
-    fieldName: string;
-    comment: string[];
-    validation: string | null;
-};
-export type ValidField = Required<Field>;
-export type GroupedFields = Record<string, Field[]>;
-export type Model = Readonly<DMMF.Model>;
-export type ModelInfo = {
-    documentation: string;
-    name: string;
-    fields: Model['fields'];
-};

package/dist/shared/types.js

@@ -1 +0,0 @@
-export {};

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

@@ -1,16 +0,0 @@
-/**
- * Capitalize the first letter of a string
- * @param { string } str - String to capitalize
- * @returns { string } String with first letter capitalized
- *
- * @example
- * capitalize('posts')    // Returns: 'Posts'
- * capitalize('user')     // Returns: 'User'
- * capitalize('api')      // Returns: 'Api'
- *
- * @remarks
- * - Leaves rest of the string unchanged
- * - Returns empty string if input is empty
- * - Commonly used for generating type names and class names
- */
-export declare function capitalize(str: string): string;