hekireki 0.0.1

package/README.md

@@ -0,0 +1,361 @@
+# 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.
+
+## Features
+
+- 💎 Automatically generates [Zod](https://zod.dev/) schemas from your Prisma schema
+- 🤖 Automatically generates [Valibot](https://valibot.dev/) schemas from your Prisma schema
+- 📊 Creates [Mermaid](https://mermaid.js.org/) ER diagrams
+
+## Installation
+
+```bash
+npm install -D hekireki
+```
+
+## Usage
+
+Prepare `schema.prisma`:
+
+```prisma
+generator client {
+  provider = "prisma-client-js"
+}
+
+datasource db {
+  provider = "sqlite"
+  url      = env("DATABASE_URL")
+}
+
+generator Hekireki-ER {
+  provider = "hekireki-mermaid-er"
+}
+
+generator Hekireki-Zod {
+  provider = "hekireki-zod"
+  type     = true
+  comment  = true
+}
+
+generator Hekireki-Valibot {
+  provider = "hekireki-valibot"
+  type     = true
+  comment  = true
+}
+
+model User {
+  /// Unique identifier for the user.
+  /// @z.string().uuid()
+  /// @v.pipe(v.string(), v.uuid())
+  id String @id @default(uuid())
+  /// Username of the user.
+  /// @z.string().min(3)
+  /// @v.pipe(v.string(), v.minLength(3))
+  username String
+  /// Email address of the user.
+  /// @z.string().email()
+  /// @v.pipe(v.string(), v.email())
+  email String
+  /// Password for the user.
+  /// @z.string().min(8).max(100)
+  /// @v.pipe(v.string(), v.minLength(8), v.maxLength(100))
+  password String
+  /// Timestamp when the user was created.
+  /// @z.date()
+  /// @v.date()
+  createdAt DateTime
+  /// Timestamp when the user was last updated.
+  /// @z.date()
+  /// @v.date()
+  updatedAt DateTime
+  posts Post[]
+  likes Like[]
+}
+
+/// @relation User.id Post.userId one-to-many
+model Post {
+  /// Unique identifier for the post.
+  /// @z.string().uuid()
+  /// @v.pipe(v.string(), v.uuid())
+  id String @id @default(uuid())
+  /// ID of the user who created the post.
+  /// @z.string().uuid()
+  /// @v.pipe(v.string(), v.uuid())
+  userId String
+  /// Content of the post.
+  /// @z.string().max(500)
+  /// @v.pipe(v.string(), v.maxLength(500))
+  content String
+  /// Timestamp when the post was created.
+  /// @z.date()
+  /// @v.date()
+  createdAt DateTime @default(now())
+  /// Timestamp when the post was last updated.
+  /// @z.date()
+  /// @v.date()
+  updatedAt DateTime @default(now()) @updatedAt
+  /// Relation with the User model.
+  user User @relation(fields: [userId], references: [id], onDelete: Cascade)
+  likes Like[]
+}
+
+/// @relation Post.id Like.postId one-to-many
+/// @relation User.id Like.userId one-to-many
+model Like {
+  /// Unique identifier for the like.
+  /// @z.string().uuid()
+  /// @v.pipe(v.string(), v.uuid())
+  id String
+  /// ID of the post that is liked.
+  /// @z.string().uuid()
+  /// @v.pipe(v.string(), v.uuid())
+  postId String
+  /// ID of the user who liked the post.
+  /// @z.string().uuid()
+  /// @v.pipe(v.string(), v.uuid())
+  userId String
+  /// Timestamp when the like was created.
+  /// @z.date()
+  /// @v.date()
+  createdAt DateTime @default(now())
+  /// Relation with the Post model.
+  post Post @relation(fields: [postId], references: [id], onDelete: Cascade)
+  /// Relation with the User model.
+  user User @relation(fields: [userId], references: [id], onDelete: Cascade)
+  @@unique([userId, postId])
+}
+```
+
+## Generate
+
+### Zod
+
+```ts
+import { z } from 'zod'
+
+export const UserSchema = z.object({
+  /**
+   * Unique identifier for the user.
+   */
+  id: z.string().uuid(),
+  /**
+   * Username of the user.
+   */
+  username: z.string().min(3),
+  /**
+   * Email address of the user.
+   */
+  email: z.string().email(),
+  /**
+   * Password for the user.
+   */
+  password: z.string().min(8).max(100),
+  /**
+   * Timestamp when the user was created.
+   */
+  createdAt: z.date(),
+  /**
+   * Timestamp when the user was last updated.
+   */
+  updatedAt: z.date(),
+})
+
+export type User = z.infer<typeof UserSchema>
+
+export const PostSchema = z.object({
+  /**
+   * Unique identifier for the post.
+   */
+  id: z.string().uuid(),
+  /**
+   * ID of the user who created the post.
+   */
+  userId: z.string().uuid(),
+  /**
+   * Content of the post.
+   */
+  content: z.string().max(500),
+  /**
+   * Timestamp when the post was created.
+   */
+  createdAt: z.date(),
+  /**
+   * Timestamp when the post was last updated.
+   */
+  updatedAt: z.date(),
+})
+
+export type Post = z.infer<typeof PostSchema>
+
+export const LikeSchema = z.object({
+  /**
+   * Unique identifier for the like.
+   */
+  id: z.string().uuid(),
+  /**
+   * ID of the post that is liked.
+   */
+  postId: z.string().uuid(),
+  /**
+   * ID of the user who liked the post.
+   */
+  userId: z.string().uuid(),
+  /**
+   * Timestamp when the like was created.
+   */
+  createdAt: z.date(),
+})
+
+export type Like = z.infer<typeof LikeSchema>
+```
+
+## Valibot
+```ts
+import * as v from 'valibot'
+
+export const UserSchema = v.object({
+  /**
+   * Unique identifier for the user.
+   */
+  id: v.pipe(v.string(), v.uuid()),
+  /**
+   * Username of the user.
+   */
+  username: v.pipe(v.string(), v.minLength(3)),
+  /**
+   * Email address of the user.
+   */
+  email: v.pipe(v.string(), v.email()),
+  /**
+   * Password for the user.
+   */
+  password: v.pipe(v.string(), v.minLength(8), v.maxLength(100)),
+  /**
+   * Timestamp when the user was created.
+   */
+  createdAt: v.date(),
+  /**
+   * Timestamp when the user was last updated.
+   */
+  updatedAt: v.date(),
+})
+
+export type User = v.InferInput<typeof UserSchema>
+
+export const PostSchema = v.object({
+  /**
+   * Unique identifier for the post.
+   */
+  id: v.pipe(v.string(), v.uuid()),
+  /**
+   * ID of the user who created the post.
+   */
+  userId: v.pipe(v.string(), v.uuid()),
+  /**
+   * Content of the post.
+   */
+  content: v.pipe(v.string(), v.maxLength(500)),
+  /**
+   * Timestamp when the post was created.
+   */
+  createdAt: v.date(),
+  /**
+   * Timestamp when the post was last updated.
+   */
+  updatedAt: v.date(),
+})
+
+export type Post = v.InferInput<typeof PostSchema>
+
+export const LikeSchema = v.object({
+  /**
+   * Unique identifier for the like.
+   */
+  id: v.pipe(v.string(), v.uuid()),
+  /**
+   * ID of the post that is liked.
+   */
+  postId: v.pipe(v.string(), v.uuid()),
+  /**
+   * ID of the user who liked the post.
+   */
+  userId: v.pipe(v.string(), v.uuid()),
+  /**
+   * Timestamp when the like was created.
+   */
+  createdAt: v.date(),
+})
+
+export type Like = v.InferInput<typeof LikeSchema>
+```
+
+## Mermaid
+
+```mermaid
+erDiagram
+    User ||--o{ Post : "(id) - (userId)"
+    Post ||--o{ Like : "(id) - (postId)"
+    User ||--o{ Like : "(id) - (userId)"
+    User {
+        String id "Unique identifier for the user."
+        String username "Username of the user."
+        String email "Email address of the user."
+        String password "Password for the user."
+        DateTime createdAt "Timestamp when the user was created."
+        DateTime updatedAt "Timestamp when the user was last updated."
+    }
+    Post {
+        String id "Unique identifier for the post."
+        String userId "ID of the user who created the post."
+        String content "Content of the post."
+        DateTime createdAt "Timestamp when the post was created."
+        DateTime updatedAt "Timestamp when the post was last updated."
+    }
+    Like {
+        String id "Unique identifier for the like."
+        String postId "ID of the post that is liked."
+        String userId "ID of the user who liked the post."
+        DateTime createdAt "Timestamp when the like was created."
+    }
+```
+
+## Configuration
+
+### Zod Generator Options
+
+| Option       | Type      | Default                             | Description                                      |
+|--------------|-----------|-------------------------------------|--------------------------------------------------|
+| `output`     | `string`  | `./zod`                             | Output directory                                 |
+| `file`       | `string`  | `index.ts`                          | File Name                                        |
+| `schemaName` | `"PascalCase"` \| `"camelCase"` | `"PascalCase"`| Naming convention for generated schema variables |
+| `typeName`   | `"PascalCase"` \| `"camelCase"` | `"PascalCase"`| Naming convention for generated type definitions |
+| `type`       | `boolean` | `false`                             | Generate TypeScript types                        |
+| `comment`    | `boolean` | `false`                             | Include schema documentation                     |
+
+### Valibot Generator Options
+
+| Option       | Type      | Default                             | Description                                      |
+|--------------|-----------|-------------------------------------|--------------------------------------------------|
+| `output`     | `string`  | `./valibot`                          | Output directory                                 |
+| `file`       | `string`  | `index.ts`                          | File Name                                        |
+| `schemaName` | `"PascalCase"` \| `"camelCase"` | `"PascalCase"`| Naming convention for generated schema variables |
+| `typeName`   | `"PascalCase"` \| `"camelCase"` | `"PascalCase"`| Naming convention for generated type definitions |
+| `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                                        |
+
+⚠️ WARNING: Potential Breaking Changes Without Notice
+
+This project is in **early development** and being maintained by a developer with about 2 years of experience. While I'm doing my best to create a useful tool:
+
+
+## License
+
+Distributed under the MIT License. See [LICENSE](https://github.com/nakita628/hekireki?tab=MIT-1-ov-file) for more information.

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

@@ -0,0 +1 @@
+export declare function formatCode(code: string): Promise<string>;

package/dist/common/format/index.js

@@ -0,0 +1,12 @@
+"use strict";
+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,
+    });
+}

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

@@ -0,0 +1,7 @@
+/**
+ * Generates a camelCase schema name from a given schema name.
+ *
+ * @param schemaName - The original schema name.
+ * @returns The camelCase schema name.
+ */
+export declare function getCamelCaseSchemaNameHelper(schemaName: string): string;

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

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCamelCaseSchemaNameHelper = getCamelCaseSchemaNameHelper;
+const decapitalize_1 = require("../text/decapitalize");
+/**
+ * Generates a camelCase schema name from a given schema name.
+ *
+ * @param schemaName - The original schema name.
+ * @returns The camelCase schema name.
+ */
+function getCamelCaseSchemaNameHelper(schemaName) {
+    const decapitalizedSchemaName = (0, decapitalize_1.decapitalize)(schemaName);
+    return `${decapitalizedSchemaName}Schema`;
+}

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

@@ -0,0 +1,8 @@
+/**
+ * Generates a PascalCase schema name from a given schema name.
+ *
+ * @function getPascalCaseSchemaName
+ * @param schemaName - The original schema name.
+ * @returns The PascalCase schema name.
+ */
+export declare function getPascalCaseSchemaNameHelper(schemaName: string): string;

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

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPascalCaseSchemaNameHelper = getPascalCaseSchemaNameHelper;
+const capitalize_1 = require("../text/capitalize");
+/**
+ * Generates a PascalCase schema name from a given schema name.
+ *
+ * @function getPascalCaseSchemaName
+ * @param schemaName - The original schema name.
+ * @returns The PascalCase schema name.
+ */
+function getPascalCaseSchemaNameHelper(schemaName) {
+    const capitalizedSchemaName = (0, capitalize_1.capitalize)(schemaName);
+    return `${capitalizedSchemaName}Schema`;
+}

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

@@ -0,0 +1,9 @@
+import type { Config } from "../../generator/zod";
+/**
+ * Generates a variable name based on the given name and configuration.
+ *
+ * @param name - The original name.
+ * @param config - The configuration.
+ * @returns The variable name.
+ */
+export declare function getVariableNameHelper(name: string, config: Config): string;

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

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getVariableNameHelper = getVariableNameHelper;
+const capitalize_1 = require("../text/capitalize");
+const decapitalize_1 = require("../text/decapitalize");
+/**
+ * Generates a variable name based on the given name and configuration.
+ *
+ * @param name - The original name.
+ * @param config - The configuration.
+ * @returns The variable name.
+ */
+function getVariableNameHelper(name, config) {
+    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

@@ -0,0 +1,9 @@
+import type { Config } from "../../generator/zod";
+/**
+ * Generates a variable schema name based on the given name and configuration.
+ *
+ * @param name - The original name.
+ * @param config - The configuration.
+ * @returns The variable schema name.
+ */
+export declare function getVariableSchemaNameHelper(name: string, config: Config): string;

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

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getVariableSchemaNameHelper = getVariableSchemaNameHelper;
+const get_camel_case_schema_name_helper_1 = require("./get-camel-case-schema-name-helper");
+const get_pascal_case_schema_name_helper_1 = require("./get-pascal-case-schema-name-helper");
+/**
+ * Generates a variable schema name based on the given name and configuration.
+ *
+ * @param name - The original name.
+ * @param config - The configuration.
+ * @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);
+}

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

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

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

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.groupByModelHelper = groupByModelHelper;
+/**
+ * Groups valid fields by model name.
+ *
+ * @param validFields - The array of valid fields.
+ * @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;
+    }, {});
+}

package/dist/common/text/capitalize.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Capitalizes the first letter of a string
+ *
+ * @function capitalize
+ * @param str - String to capitalize
+ * @returns 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;

package/dist/common/text/capitalize.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.capitalize = capitalize;
+/**
+ * Capitalizes the first letter of a string
+ *
+ * @function capitalize
+ * @param str - String to capitalize
+ * @returns 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
+ */
+function capitalize(str) {
+    return `${str.charAt(0).toUpperCase()}${str.slice(1)}`;
+}

package/dist/common/text/decapitalize.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Decapitalizes the first letter of a string
+ *
+ * @function decapitalize
+ * @param str - String to decapitalize
+ * @returns String with the first letter in lowercase
+ *
+ * @example
+ * decapitalize('Posts')    // Returns: 'posts'
+ * decapitalize('User')     // Returns: 'user'
+ * decapitalize('Api')      // Returns: 'api'
+ *
+ * @remarks
+ * - Leaves the rest of the string unchanged
+ * - Returns an empty string if the input is empty
+ */
+export declare function decapitalize(str: string): string;

package/dist/common/text/decapitalize.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decapitalize = decapitalize;
+/**
+ * Decapitalizes the first letter of a string
+ *
+ * @function decapitalize
+ * @param str - String to decapitalize
+ * @returns String with the first letter in lowercase
+ *
+ * @example
+ * decapitalize('Posts')    // Returns: 'posts'
+ * decapitalize('User')     // Returns: 'user'
+ * decapitalize('Api')      // Returns: 'api'
+ *
+ * @remarks
+ * - Leaves the rest of the string unchanged
+ * - Returns an empty string if the input is empty
+ */
+function decapitalize(str) {
+    return `${str.charAt(0).toLowerCase()}${str.slice(1)}`;
+}

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

@@ -0,0 +1,16 @@
+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/common/type/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,13 @@
+import type { ReadonlyDeep } from "@prisma/generator-helper";
+/**
+ * Is fields validation
+ * @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>[];

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

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isFieldsValidation = isFieldsValidation;
+/**
+ * Is fields validation
+ * @param modelFields - The model fields
+ * @returns The fields validation
+ */
+function isFieldsValidation(modelFields) {
+    return modelFields
+        .flat()
+        .filter((field) => field.validation !== null);
+}

package/dist/generator/mermaid/generator/generate-er-content.d.ts

@@ -0,0 +1,8 @@
+import type { ERContent, Model } from "../type";
+/**
+ * generate ER content
+ * @function generateERContent
+ * @param models
+ * @returns ER content
+ */
+export declare function generateERContent(models: readonly Model[]): ERContent;