hekireki 0.0.1 → 0.0.3

package/README.md

@@ -1,6 +1,6 @@
 # Hekireki
 
-[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.
+**[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
 

package/dist/common/format/index.js

@@ -3,10 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.formatCode = formatCode;
 const prettier_1 = require("prettier");
 async function formatCode(code) {
-    return await (0, prettier_1.format)(code, {
-        parser: "typescript",
-        printWidth: 100,
-        singleQuote: true,
-        semi: false,
-    });
+	return await (0, prettier_1.format)(code, {
+		parser: "typescript",
+		printWidth: 100,
+		singleQuote: true,
+		semi: false,
+	});
 }

package/dist/common/helper/get-camel-case-schema-name-helper.d.ts

@@ -4,4 +4,6 @@
  * @param schemaName - The original schema name.
  * @returns The camelCase schema name.
  */
-export declare function getCamelCaseSchemaNameHelper(schemaName: string): string;
+export declare function getCamelCaseSchemaNameHelper(
+	schemaName: string,
+): string;

package/dist/common/helper/get-camel-case-schema-name-helper.js

@@ -9,6 +9,6 @@ const decapitalize_1 = require("../text/decapitalize");
  * @returns The camelCase schema name.
  */
 function getCamelCaseSchemaNameHelper(schemaName) {
-    const decapitalizedSchemaName = (0, decapitalize_1.decapitalize)(schemaName);
-    return `${decapitalizedSchemaName}Schema`;
+	const decapitalizedSchemaName = (0, decapitalize_1.decapitalize)(schemaName);
+	return `${decapitalizedSchemaName}Schema`;
 }

package/dist/common/helper/get-pascal-case-schema-name-helper.d.ts

@@ -5,4 +5,6 @@
  * @param schemaName - The original schema name.
  * @returns The PascalCase schema name.
  */
-export declare function getPascalCaseSchemaNameHelper(schemaName: string): string;
+export declare function getPascalCaseSchemaNameHelper(
+	schemaName: string,
+): string;

package/dist/common/helper/get-pascal-case-schema-name-helper.js

@@ -10,6 +10,6 @@ const capitalize_1 = require("../text/capitalize");
  * @returns The PascalCase schema name.
  */
 function getPascalCaseSchemaNameHelper(schemaName) {
-    const capitalizedSchemaName = (0, capitalize_1.capitalize)(schemaName);
-    return `${capitalizedSchemaName}Schema`;
+	const capitalizedSchemaName = (0, capitalize_1.capitalize)(schemaName);
+	return `${capitalizedSchemaName}Schema`;
 }

package/dist/common/helper/get-variable-name-helper.d.ts

@@ -6,4 +6,7 @@ import type { Config } from "../../generator/zod";
  * @param config - The configuration.
  * @returns The variable name.
  */
-export declare function getVariableNameHelper(name: string, config: Config): string;
+export declare function getVariableNameHelper(
+	name: string,
+	config: Config,
+): string;

package/dist/common/helper/get-variable-name-helper.js

@@ -11,7 +11,7 @@ const decapitalize_1 = require("../text/decapitalize");
  * @returns The variable name.
  */
 function getVariableNameHelper(name, config) {
-    return config.typeName === "camelCase"
-        ? (0, decapitalize_1.decapitalize)(name)
-        : (0, capitalize_1.capitalize)(name);
+	return config.typeName === "camelCase"
+		? (0, decapitalize_1.decapitalize)(name)
+		: (0, capitalize_1.capitalize)(name);
 }

package/dist/common/helper/get-variable-schema-name-helper.d.ts

@@ -6,4 +6,7 @@ import type { Config } from "../../generator/zod";
  * @param config - The configuration.
  * @returns The variable schema name.
  */
-export declare function getVariableSchemaNameHelper(name: string, config: Config): string;
+export declare function getVariableSchemaNameHelper(
+	name: string,
+	config: Config,
+): string;

package/dist/common/helper/get-variable-schema-name-helper.js

@@ -11,7 +11,11 @@ const get_pascal_case_schema_name_helper_1 = require("./get-pascal-case-schema-n
  * @returns The variable schema name.
  */
 function getVariableSchemaNameHelper(name, config) {
-    return config.schemaName === "camelCase"
-        ? (0, get_camel_case_schema_name_helper_1.getCamelCaseSchemaNameHelper)(name)
-        : (0, get_pascal_case_schema_name_helper_1.getPascalCaseSchemaNameHelper)(name);
+	return config.schemaName === "camelCase"
+		? (0, get_camel_case_schema_name_helper_1.getCamelCaseSchemaNameHelper)(
+				name,
+			)
+		: (0, get_pascal_case_schema_name_helper_1.getPascalCaseSchemaNameHelper)(
+				name,
+			);
 }

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

@@ -5,4 +5,6 @@ import type { GroupedFields, ValidField } from "../type";
  * @param validFields - The array of valid fields.
  * @returns The grouped fields.
  */
-export declare function groupByModelHelper(validFields: ValidField[]): GroupedFields;
+export declare function groupByModelHelper(
+	validFields: ValidField[],
+): GroupedFields;

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

@@ -8,11 +8,11 @@ exports.groupByModelHelper = groupByModelHelper;
  * @returns The grouped fields.
  */
 function groupByModelHelper(validFields) {
-    return validFields.reduce((acc, field) => {
-        if (!acc[field.modelName]) {
-            acc[field.modelName] = [];
-        }
-        acc[field.modelName].push(field);
-        return acc;
-    }, {});
+	return validFields.reduce((acc, field) => {
+		if (!acc[field.modelName]) {
+			acc[field.modelName] = [];
+		}
+		acc[field.modelName].push(field);
+		return acc;
+	}, {});
 }

package/dist/common/text/capitalize.js

@@ -19,5 +19,5 @@ exports.capitalize = capitalize;
  * - Commonly used for generating type names and class names
  */
 function capitalize(str) {
-    return `${str.charAt(0).toUpperCase()}${str.slice(1)}`;
+	return `${str.charAt(0).toUpperCase()}${str.slice(1)}`;
 }

package/dist/common/text/decapitalize.js

@@ -18,5 +18,5 @@ exports.decapitalize = decapitalize;
  * - Returns an empty string if the input is empty
  */
 function decapitalize(str) {
-    return `${str.charAt(0).toLowerCase()}${str.slice(1)}`;
+	return `${str.charAt(0).toLowerCase()}${str.slice(1)}`;
 }

package/dist/common/type/index.d.ts

@@ -1,16 +1,16 @@
 import type { DMMF } from "@prisma/generator-helper";
 export type Field = {
-    documentation: string;
-    modelName: string;
-    fieldName: string;
-    comment: string[];
-    validation: string | null;
+	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"];
+	documentation: string;
+	name: string;
+	fields: Model["fields"];
 };

package/dist/common/validator/is-fields-validation.d.ts

@@ -4,10 +4,12 @@ import type { ReadonlyDeep } from "@prisma/generator-helper";
  * @param modelFields - The model fields
  * @returns The fields validation
  */
-export declare function isFieldsValidation(modelFields: {
-    documentation: ReadonlyDeep<string | undefined>;
-    modelName: string;
-    fieldName: string;
-    comment: string[];
-    validation: string | null;
-}[][]): Required<import("../type").Field>[];
+export declare function isFieldsValidation(
+	modelFields: {
+		documentation: ReadonlyDeep<string | undefined>;
+		modelName: string;
+		fieldName: string;
+		comment: string[];
+		validation: string | null;
+	}[][],
+): Required<import("../type").Field>[];

package/dist/common/validator/is-fields-validation.js

@@ -7,7 +7,5 @@ exports.isFieldsValidation = isFieldsValidation;
  * @returns The fields validation
  */
 function isFieldsValidation(modelFields) {
-    return modelFields
-        .flat()
-        .filter((field) => field.validation !== null);
+	return modelFields.flat().filter((field) => field.validation !== null);
 }

package/dist/generator/mermaid/generator/generate-er-content.js

@@ -12,12 +12,18 @@ const remove_duplicate_relations_1 = require("../validator/remove-duplicate-rela
  * @returns ER content
  */
 function generateERContent(models) {
-    // extract all relations
-    const allRelations = models.flatMap(extract_relations_1.extractRelations);
-    // remove duplicate relations
-    const uniqueRelations = (0, remove_duplicate_relations_1.removeDuplicateRelations)(allRelations);
-    // collect all model info
-    const modelInfos = models.flatMap(generate_model_info_1.generateModelInfo);
-    // build ER diagram
-    return [...__1.ER_HEADER, ...uniqueRelations, ...modelInfos, ...__1.ER_FOOTER];
+	// extract all relations
+	const allRelations = models.flatMap(extract_relations_1.extractRelations);
+	// remove duplicate relations
+	const uniqueRelations = (0,
+	remove_duplicate_relations_1.removeDuplicateRelations)(allRelations);
+	// collect all model info
+	const modelInfos = models.flatMap(generate_model_info_1.generateModelInfo);
+	// build ER diagram
+	return [
+		...__1.ER_HEADER,
+		...uniqueRelations,
+		...modelInfos,
+		...__1.ER_FOOTER,
+	];
 }

package/dist/generator/mermaid/generator/generate-model-fields.js

@@ -10,20 +10,25 @@ const VALIBOT_ANNOTATION = "@v.";
  * @returns
  */
 function generateModelFields(model) {
-    return model.fields
-        .map((field) => {
-        if (field.relationName) {
-            return null;
-        }
-        const commentPart = field.documentation
-            ? field.documentation
-                .split("\n")
-                .filter((line) => !(line.includes(ZOD_ANNOTATION) ||
-                line.includes(VALIBOT_ANNOTATION)))
-                .join("\n")
-                .trim()
-            : "";
-        return `        ${field.type} ${field.name} ${commentPart ? `"${commentPart}"` : ""}`;
-    })
-        .filter((field) => field !== null);
+	return model.fields
+		.map((field) => {
+			if (field.relationName) {
+				return null;
+			}
+			const commentPart = field.documentation
+				? field.documentation
+						.split("\n")
+						.filter(
+							(line) =>
+								!(
+									line.includes(ZOD_ANNOTATION) ||
+									line.includes(VALIBOT_ANNOTATION)
+								),
+						)
+						.join("\n")
+						.trim()
+				: "";
+			return `        ${field.type} ${field.name} ${commentPart ? `"${commentPart}"` : ""}`;
+		})
+		.filter((field) => field !== null);
 }

package/dist/generator/mermaid/generator/generate-model-info.js

@@ -9,9 +9,9 @@ const generate_model_fields_1 = require("./generate-model-fields");
  * @returns
  */
 function generateModelInfo(model) {
-    return [
-        `    ${model.name} {`,
-        ...(0, generate_model_fields_1.generateModelFields)(model),
-        "    }",
-    ];
+	return [
+		`    ${model.name} {`,
+		...(0, generate_model_fields_1.generateModelFields)(model),
+		"    }",
+	];
 }

package/dist/generator/mermaid/generator/generate-relation-line.js

@@ -9,9 +9,9 @@ const __1 = require("..");
  * @returns string
  */
 function generateRelationLine(relation) {
-    const cardinality = __1.CARDINALITY_MAP[relation.type];
-    if (!cardinality) {
-        throw new Error(`Unknown relation type: ${relation.type}`);
-    }
-    return `    ${relation.fromModel} ${cardinality} ${relation.toModel} : "(${relation.fromField}) - (${relation.toField})"`;
+	const cardinality = __1.CARDINALITY_MAP[relation.type];
+	if (!cardinality) {
+		throw new Error(`Unknown relation type: ${relation.type}`);
+	}
+	return `    ${relation.fromModel} ${cardinality} ${relation.toModel} : "(${relation.fromField}) - (${relation.toField})"`;
 }

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

@@ -1,8 +1,8 @@
 import type { GeneratorOptions } from "@prisma/generator-helper";
 import type { RelationType } from "./type";
 export type Config = {
-    output?: string;
-    file?: string | string[];
+	output?: string;
+	file?: string | string[];
 };
 export declare const CARDINALITY_MAP: Record<RelationType, string>;
 export declare const ER_HEADER: readonly ["```mermaid", "erDiagram"];

package/dist/generator/mermaid/index.js

@@ -6,43 +6,43 @@ const output_1 = require("./output");
 const generator_helper_1 = require("@prisma/generator-helper");
 const generate_er_content_1 = require("./generator/generate-er-content");
 const DEFAULT_CONFIG = {
-    output: "./mermaid-er",
-    file: "ER.md",
+	output: "./mermaid-er",
+	file: "ER.md",
 };
 exports.CARDINALITY_MAP = {
-    // Required Relationships
-    // Both sides required (one-to-one)
-    "one-to-one": "||--||", // 1 --- 1
-    // One side singular, the other multiple
-    "one-to-many": "||--o{", // 1 --- * (also known as one-to-zero-many)
-    "many-to-one": "}o--||", // * --- 1
-    // Both sides multiple (many-to-many)
-    "many-to-many": "}o--o{", // * --- *
-    // One side required, one side optional (0..1)
-    "one-to-zero-one": "||--o|", // 1 --- 0..1
-    "zero-one-to-one": "o|--||", // 0..1 --- 1
-    // Both sides optional singular (0..1 on both sides)
-    "zero-to-one": "o|--o|", // 0..1 --- 0..1
-    "zero-to-zero-one": "o|--o|", // Alias for zero-to-one
-    // One side optional singular, the other multiple
-    "zero-to-many": "o|--o{", // 0 --- *
-    "zero-one-to-many": "o|--o{", // 0..1 --- *
-    "many-to-zero-one": "}o--o|", // * --- 0..1
-    // Optional Relationships (using dotted lines)
-    "one-to-one-optional": "||..||", // 1..1
-    "one-to-many-optional": "||..o{", // 1..*
-    "many-to-one-optional": "}o..||", // *..1
-    "many-to-many-optional": "}o..o{", // *..*
-    "one-to-zero-one-optional": "||..o|", // 1..0..1
-    "zero-one-to-one-optional": "o|..||", // 0..1..1
-    "zero-to-one-optional": "o|..o|", // 0..1 (both sides optional singular)
-    "zero-to-many-optional": "o|..o{", // 0..* (optional multiple)
-    "zero-one-to-many-optional": "o|..o{", // 0..1 --- * (optional)
-    "many-to-zero-one-optional": "}o..o|", // *..0..1
-    // Nuanced Patterns (Aliases)
-    "many-to-zero-many": "}o..o{", // * --- 0..* (equivalent to many-to-many-optional)
-    "zero-many-to-many": "o{..}o", // 0..* --- * (left side optional multiple, right side required multiple)
-    "zero-many-to-zero-many": "o{..o{", // both sides optional multiple
+	// Required Relationships
+	// Both sides required (one-to-one)
+	"one-to-one": "||--||", // 1 --- 1
+	// One side singular, the other multiple
+	"one-to-many": "||--o{", // 1 --- * (also known as one-to-zero-many)
+	"many-to-one": "}o--||", // * --- 1
+	// Both sides multiple (many-to-many)
+	"many-to-many": "}o--o{", // * --- *
+	// One side required, one side optional (0..1)
+	"one-to-zero-one": "||--o|", // 1 --- 0..1
+	"zero-one-to-one": "o|--||", // 0..1 --- 1
+	// Both sides optional singular (0..1 on both sides)
+	"zero-to-one": "o|--o|", // 0..1 --- 0..1
+	"zero-to-zero-one": "o|--o|", // Alias for zero-to-one
+	// One side optional singular, the other multiple
+	"zero-to-many": "o|--o{", // 0 --- *
+	"zero-one-to-many": "o|--o{", // 0..1 --- *
+	"many-to-zero-one": "}o--o|", // * --- 0..1
+	// Optional Relationships (using dotted lines)
+	"one-to-one-optional": "||..||", // 1..1
+	"one-to-many-optional": "||..o{", // 1..*
+	"many-to-one-optional": "}o..||", // *..1
+	"many-to-many-optional": "}o..o{", // *..*
+	"one-to-zero-one-optional": "||..o|", // 1..0..1
+	"zero-one-to-one-optional": "o|..||", // 0..1..1
+	"zero-to-one-optional": "o|..o|", // 0..1 (both sides optional singular)
+	"zero-to-many-optional": "o|..o{", // 0..* (optional multiple)
+	"zero-one-to-many-optional": "o|..o{", // 0..1 --- * (optional)
+	"many-to-zero-one-optional": "}o..o|", // *..0..1
+	// Nuanced Patterns (Aliases)
+	"many-to-zero-many": "}o..o{", // * --- 0..* (equivalent to many-to-many-optional)
+	"zero-many-to-many": "o{..}o", // 0..* --- * (left side optional multiple, right side required multiple)
+	"zero-many-to-zero-many": "o{..o{", // both sides optional multiple
 };
 // ER diagram header
 exports.ER_HEADER = ["```mermaid", "erDiagram"];
@@ -50,24 +50,24 @@ exports.ER_HEADER = ["```mermaid", "erDiagram"];
 exports.ER_FOOTER = ["```"];
 // main function
 async function main(options) {
-    const config = {
-        output: options.generator.output?.value ?? DEFAULT_CONFIG.output,
-        file: options.generator.config?.file ?? DEFAULT_CONFIG.file,
-    };
-    const models = options.dmmf.datamodel.models;
-    const content = (0, generate_er_content_1.generateERContent)(models);
-    if (!config.output) {
-        throw new Error("output is required");
-    }
-    (0, output_1.OutputFile)(content, config);
+	const config = {
+		output: options.generator.output?.value ?? DEFAULT_CONFIG.output,
+		file: options.generator.config?.file ?? DEFAULT_CONFIG.file,
+	};
+	const models = options.dmmf.datamodel.models;
+	const content = (0, generate_er_content_1.generateERContent)(models);
+	if (!config.output) {
+		throw new Error("output is required");
+	}
+	(0, output_1.OutputFile)(content, config);
 }
 // prisma generator handler
 (0, generator_helper_1.generatorHandler)({
-    onManifest() {
-        return {
-            defaultOutput: "./mermaid-er",
-            prettyName: "ekireki-ER",
-        };
-    },
-    onGenerate: main,
+	onManifest() {
+		return {
+			defaultOutput: "./mermaid-er",
+			prettyName: "ekireki-ER",
+		};
+	},
+	onGenerate: main,
 });

package/dist/generator/mermaid/output/index.js

@@ -1,7 +1,9 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
+var __importDefault =
+	(this && this.__importDefault) ||
+	function (mod) {
+		return mod && mod.__esModule ? mod : { default: mod };
+	};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OutputFile = OutputFile;
 const node_fs_1 = __importDefault(require("node:fs"));
@@ -11,14 +13,16 @@ const node_fs_1 = __importDefault(require("node:fs"));
  * @param config - The configuration
  */
 function OutputFile(content, config) {
-    const outputDir = config.output;
-    if (!outputDir) {
-        throw new Error("output is required");
-    }
-    if (!node_fs_1.default.existsSync(outputDir)) {
-        node_fs_1.default.mkdirSync(outputDir, { recursive: true });
-    }
-    const file = config.file ?? "ER.md";
-    const filePath = `${outputDir}/${file}`;
-    node_fs_1.default.writeFileSync(filePath, content.join("\n"), { encoding: "utf-8" });
+	const outputDir = config.output;
+	if (!outputDir) {
+		throw new Error("output is required");
+	}
+	if (!node_fs_1.default.existsSync(outputDir)) {
+		node_fs_1.default.mkdirSync(outputDir, { recursive: true });
+	}
+	const file = config.file ?? "ER.md";
+	const filePath = `${outputDir}/${file}`;
+	node_fs_1.default.writeFileSync(filePath, content.join("\n"), {
+		encoding: "utf-8",
+	});
 }

package/dist/generator/mermaid/type/index.d.ts

@@ -1,11 +1,35 @@
 import type { DMMF } from "@prisma/generator-helper";
-export type RelationType = "one-to-one" | "one-to-many" | "many-to-one" | "many-to-many" | "one-to-zero-one" | "zero-one-to-one" | "zero-to-one" | "zero-to-zero-one" | "zero-to-many" | "zero-one-to-many" | "many-to-zero-one" | "one-to-one-optional" | "one-to-many-optional" | "many-to-one-optional" | "many-to-many-optional" | "one-to-zero-one-optional" | "zero-one-to-one-optional" | "zero-to-one-optional" | "zero-to-many-optional" | "zero-one-to-many-optional" | "many-to-zero-one-optional" | "many-to-zero-many" | "zero-many-to-many" | "zero-many-to-zero-many";
+export type RelationType =
+	| "one-to-one"
+	| "one-to-many"
+	| "many-to-one"
+	| "many-to-many"
+	| "one-to-zero-one"
+	| "zero-one-to-one"
+	| "zero-to-one"
+	| "zero-to-zero-one"
+	| "zero-to-many"
+	| "zero-one-to-many"
+	| "many-to-zero-one"
+	| "one-to-one-optional"
+	| "one-to-many-optional"
+	| "many-to-one-optional"
+	| "many-to-many-optional"
+	| "one-to-zero-one-optional"
+	| "zero-one-to-one-optional"
+	| "zero-to-one-optional"
+	| "zero-to-many-optional"
+	| "zero-one-to-many-optional"
+	| "many-to-zero-one-optional"
+	| "many-to-zero-many"
+	| "zero-many-to-many"
+	| "zero-many-to-zero-many";
 export type Relation = {
-    fromModel: string;
-    toModel: string;
-    fromField: string;
-    toField: string;
-    type: RelationType;
+	fromModel: string;
+	toModel: string;
+	fromField: string;
+	toField: string;
+	type: RelationType;
 };
 export type Model = Readonly<DMMF.Model>;
 export type ERContent = readonly string[];

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

@@ -4,4 +4,6 @@
  * @param relations
  * @returns
  */
-export declare function excludeManyToOneRelations(relations: readonly string[]): readonly string[];
+export declare function excludeManyToOneRelations(
+	relations: readonly string[],
+): readonly string[];

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

@@ -8,5 +8,5 @@ exports.excludeManyToOneRelations = excludeManyToOneRelations;
  * @returns
  */
 function excludeManyToOneRelations(relations) {
-    return [...new Set(relations)].filter((r) => !r.includes("many-to-one"));
+	return [...new Set(relations)].filter((r) => !r.includes("many-to-one"));
 }

package/dist/generator/mermaid/validator/extract-relations.js

@@ -10,17 +10,19 @@ const parse_relation_1 = require("./parse-relation");
  * @returns
  */
 function extractRelations(model) {
-    const relations = [];
-    // @r annotation
-    if (model.documentation) {
-        const annotationRelations = model.documentation
-            .split("\n")
-            .map((line) => {
-            const relation = (0, parse_relation_1.parseRelation)(line);
-            return relation ? (0, generate_relation_line_1.generateRelationLine)(relation) : null;
-        })
-            .filter((line) => line !== null);
-        relations.push(...annotationRelations);
-    }
-    return relations;
+	const relations = [];
+	// @r annotation
+	if (model.documentation) {
+		const annotationRelations = model.documentation
+			.split("\n")
+			.map((line) => {
+				const relation = (0, parse_relation_1.parseRelation)(line);
+				return relation
+					? (0, generate_relation_line_1.generateRelationLine)(relation)
+					: null;
+			})
+			.filter((line) => line !== null);
+		relations.push(...annotationRelations);
+	}
+	return relations;
 }