hekireki 0.0.5 → 0.0.6

package/README.md

@@ -129,7 +129,7 @@ model Like {
 
 ## Generate
 
-### Zod
+## Zod
 
 ```ts
 import { z } from 'zod'
@@ -294,9 +294,9 @@ export type Like = v.InferInput<typeof LikeSchema>
 
 ```mermaid
 erDiagram
-    User ||--o{ Post : "(id) - (userId)"
-    Post ||--o{ Like : "(id) - (postId)"
-    User ||--o{ Like : "(id) - (userId)"
+    User ||--|{ Post : "(id) - (userId)"
+    Post ||--|{ Like : "(id) - (postId)"
+    User ||--|{ Like : "(id) - (userId)"
     User {
         String id "Unique identifier for the user."
         String username "Username of the user."

package/dist/generator/mermaid/generator/generate-relation-line.d.ts

@@ -1,8 +1,7 @@
 import type { Relation } from "../type";
 /**
  * generate relation line
- * @function generateRelationLine
- * @param relation
- * @returns string
+ * @param { Relation } relation
+ * @returns { string } relation line
  */
 export declare function generateRelationLine(relation: Relation): string;

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

@@ -4,9 +4,8 @@ exports.generateRelationLine = generateRelationLine;
 const __1 = require("..");
 /**
  * generate relation line
- * @function generateRelationLine
- * @param relation
- * @returns string
+ * @param { Relation } relation
+ * @returns { string } relation line
  */
 function generateRelationLine(relation) {
     const cardinality = __1.CARDINALITY_MAP[relation.type];

package/dist/generator/mermaid/index.js

@@ -12,38 +12,32 @@ const DEFAULT_CONFIG = {
 };
 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-many": "||--|{", // 1 --- 0..*
+    "many-to-one": "}|--||", // * --- 1
+    "many-to-many": "}|--|{", // * --- *
     "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-to-many": "o|--o{", // 0..1 --- 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
+    "many-to-zero-one": "}|--o|", // * --- 0..1
+    // Optional Relationships (dotted lines)
+    "one-to-one-optional": "||..||", // 1 --- 1 optional
+    "one-to-many-optional": "||..o{", // 1 --- 0..* optional
+    "many-to-one-optional": "}|..||", // * --- 1 optional
+    "many-to-many-optional": "}|..o{", // * --- 0..* optional
+    "one-to-zero-one-optional": "||..o|", // 1 --- 0..1 optional
+    "zero-one-to-one-optional": "o|..||", // 0..1 --- 1 optional
+    "zero-to-one-optional": "o|..o|", // 0..1 --- 0..1 optional
+    "zero-to-many-optional": "o|..o{", // 0..1 --- 0..* optional
+    "zero-one-to-many-optional": "o|..o{", // 0..1 --- * optional
+    "many-to-zero-one-optional": "}|..o|", // * --- 0..1 optional
     // 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
+    "many-to-zero-many": "}|..o{", // * --- 0..*
+    "zero-many-to-many": "o{--|{", // 0..* --- *
+    "zero-many-to-zero-many": "o{--o{", // 0..* --- 0..*
 };
 // ER diagram header
 exports.ER_HEADER = ["```mermaid", "erDiagram"];

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

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

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

@@ -5,13 +5,12 @@ const generate_relation_line_1 = require("../generator/generate-relation-line");
 const parse_relation_1 = require("./parse-relation");
 /**
  * extract relations from model
- * @function extractRelations
- * @param model
- * @returns
+ * @param { Model } model
+ * @returns { readonly string[] }
  */
 function extractRelations(model) {
     const relations = [];
-    // @r annotation
+    // @relation annotation
     if (model.documentation) {
         const annotationRelations = model.documentation
             .split("\n")

package/dist/generator/mermaid/validator/is-relation.d.ts

@@ -1,2 +1,7 @@
 import type { RelationType } from "../type";
+/**
+ * check if the value is a valid relation
+ * @param { unknown } value
+ * @returns { boolean }
+ */
 export declare function isRelation(value: unknown): value is RelationType;

package/dist/generator/mermaid/validator/is-relation.js

@@ -27,6 +27,11 @@ const VALID_RELATIONS = new Set([
     "zero-many-to-many",
     "zero-many-to-zero-many",
 ]);
+/**
+ * check if the value is a valid relation
+ * @param { unknown } value
+ * @returns { boolean }
+ */
 function isRelation(value) {
     return typeof value === "string" && VALID_RELATIONS.has(value);
 }

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

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

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

@@ -3,9 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.removeDuplicateRelations = removeDuplicateRelations;
 /**
  * remove duplicate relations
- * @function removeDuplicateRelations
- * @param relations
- * @returns
+ * @param { readonly string[] } relations
+ * @returns { readonly string[] }
  */
 function removeDuplicateRelations(relations) {
     return [...new Set(relations)];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "hekireki",
-	"version": "0.0.5",
+	"version": "0.0.6",
 	"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": [