sizuku 0.3.1 → 0.4.0

package/README.md

@@ -1,3 +1,5 @@
+![img](https://github.com/nakita628/sizuku/blob/main/assets/img/sizuku.png)
+
 # Sizuku
 
 **[Sizuku](https://www.npmjs.com/package/sizuku)** is a tool that generates validation schemas for Zod and Valibot, as well as ER diagrams, from [Drizzle](https://orm.drizzle.team/) schemas annotated with comments.
@@ -6,7 +8,11 @@
 
 - 💎 Automatically generates [Zod](https://zod.dev/) schemas from your Drizzle schema
 - 🤖 Automatically generates [Valibot](https://valibot.dev/) schemas from your Drizzle schema
+- 🏹 Automatically generates [ArkType](https://arktype.io/) schemas from your Drizzle schema
+- ⚡ Automatically generates [Effect Schema](https://effect.website/docs/schema/introduction/) from your Drizzle schema
 - 📊 Creates [Mermaid](https://mermaid.js.org/) ER diagrams
+- 📝 Generates [DBML](https://dbml.dbdiagram.io/) (Database Markup Language) files
+- 🖼️ Outputs ER diagrams as **PNG/SVG** images using [dbml-renderer](https://github.com/softwaretechnik-berlin/dbml-renderer)
 
 
 ## Getting Started
@@ -73,7 +79,7 @@ export const postRelations = relations(post, ({ one }) => ({
 Prepare sizuku.config.ts:
 
 ```ts
-import defineConfig from 'sizuku/config'
+import { defineConfig } from 'sizuku/config'
 
 export default defineConfig({
   input: 'db/schema.ts',
@@ -90,9 +96,26 @@ export default defineConfig({
     type: true,
     relation: true,
   },
+  arktype: {
+    output: 'arktype/index.ts',
+    comment: true,
+    type: true,
+  },
+  effect: {
+    output: 'effect/index.ts',
+    comment: true,
+    type: true,
+  },
   mermaid: {
     output: 'mermaid-er/ER.md',
   },
+  dbml: {
+    output: 'dbml/schema.dbml',
+  },
+  svg: {
+    output: 'docs/er-diagram.png',
+    format: 'png',
+  },
 })
 ```
 
@@ -215,6 +238,86 @@ erDiagram
     }
 ```
 
+### DBML
+
+```dbml
+Table user {
+  id varchar [pk, note: 'Primary key']
+  name varchar [note: 'Display name']
+}
+
+Table post {
+  id varchar [pk, note: 'Primary key']
+  title varchar [note: 'Article title']
+  content varchar [note: 'Body content (no length limit)']
+  userId varchar [note: 'Foreign key referencing User.id']
+}
+
+Ref post_userId_user_id_fk: post.userId > user.id
+```
+
+### PNG/SVG
+
+The `svg` generator outputs ER diagrams as PNG or SVG images using [dbml-renderer](https://github.com/softwaretechnik-berlin/dbml-renderer).
+
+Output: `docs/er-diagram.png`
+
+## Configuration
+
+### Zod Options
+
+| Option     | Type      | Default        | Description                                                      |
+|------------|-----------|----------------|------------------------------------------------------------------|
+| `output`   | `string`  | `zod/index.ts` | Output file path                                                 |
+| `type`     | `boolean` | `false`        | Generate TypeScript types                                        |
+| `comment`  | `boolean` | `false`        | Include schema documentation                                     |
+| `zod`      | `string`  | `'v4'`         | Zod import version (`'mini'`, `'@hono/zod-openapi'`, or `'v4'`)  |
+| `relation` | `boolean` | `false`        | Generate relation schemas                                        |
+
+### Valibot Options
+
+| Option     | Type      | Default            | Description                  |
+|------------|-----------|--------------------|------------------------------|
+| `output`   | `string`  | `valibot/index.ts` | Output file path             |
+| `type`     | `boolean` | `false`            | Generate TypeScript types    |
+| `comment`  | `boolean` | `false`            | Include schema documentation |
+| `relation` | `boolean` | `false`            | Generate relation schemas    |
+
+### ArkType Options
+
+| Option    | Type      | Default            | Description                  |
+|-----------|-----------|--------------------|------------------------------|
+| `output`  | `string`  | `arktype/index.ts` | Output file path             |
+| `type`    | `boolean` | `false`            | Generate TypeScript types    |
+| `comment` | `boolean` | `false`            | Include schema documentation |
+
+### Effect Options
+
+| Option    | Type      | Default           | Description                  |
+|-----------|-----------|-------------------|------------------------------|
+| `output`  | `string`  | `effect/index.ts` | Output file path             |
+| `type`    | `boolean` | `false`           | Generate TypeScript types    |
+| `comment` | `boolean` | `false`           | Include schema documentation |
+
+### Mermaid Options
+
+| Option   | Type     | Default          | Description      |
+|----------|----------|------------------|------------------|
+| `output` | `string` | `mermaid-er/ER.md` | Output file path |
+
+### DBML Options
+
+| Option   | Type     | Default            | Description      |
+|----------|----------|--------------------|------------------|
+| `output` | `string` | `dbml/schema.dbml` | Output file path |
+
+### SVG Options
+
+| Option   | Type     | Default               | Description                              |
+|----------|----------|-----------------------|------------------------------------------|
+| `output` | `string` | `docs/er-diagram.png` | Output file path                         |
+| `format` | `string` | `png`                 | Output format (`png`, `svg`, or `dot`)   |
+
 ### ⚠️ WARNING: Potential Breaking Changes Without Notice
 
 This package is in active development and may introduce breaking changes without prior notice.

package/dist/config/index.d.mts

@@ -0,0 +1,58 @@
+import { z } from "zod";
+
+//#region src/config/index.d.ts
+declare const configSchema: z.ZodObject<{
+  input: z.ZodType<`${string}.ts`, unknown, z.core.$ZodTypeInternals<`${string}.ts`, unknown>>;
+  zod: z.ZodOptional<z.ZodObject<{
+    output: z.ZodType<`${string}.ts`, unknown, z.core.$ZodTypeInternals<`${string}.ts`, unknown>>;
+    comment: z.ZodOptional<z.ZodBoolean>;
+    type: z.ZodOptional<z.ZodBoolean>;
+    zod: z.ZodOptional<z.ZodEnum<{
+      v4: "v4";
+      mini: "mini";
+      "@hono/zod-openapi": "@hono/zod-openapi";
+    }>>;
+    relation: z.ZodOptional<z.ZodBoolean>;
+  }, z.core.$strip>>;
+  valibot: z.ZodOptional<z.ZodObject<{
+    output: z.ZodType<`${string}.ts`, unknown, z.core.$ZodTypeInternals<`${string}.ts`, unknown>>;
+    comment: z.ZodOptional<z.ZodBoolean>;
+    type: z.ZodOptional<z.ZodBoolean>;
+    relation: z.ZodOptional<z.ZodBoolean>;
+  }, z.core.$strip>>;
+  arktype: z.ZodOptional<z.ZodObject<{
+    output: z.ZodType<`${string}.ts`, unknown, z.core.$ZodTypeInternals<`${string}.ts`, unknown>>;
+    comment: z.ZodOptional<z.ZodBoolean>;
+    type: z.ZodOptional<z.ZodBoolean>;
+  }, z.core.$strip>>;
+  effect: z.ZodOptional<z.ZodObject<{
+    output: z.ZodType<`${string}.ts`, unknown, z.core.$ZodTypeInternals<`${string}.ts`, unknown>>;
+    comment: z.ZodOptional<z.ZodBoolean>;
+    type: z.ZodOptional<z.ZodBoolean>;
+  }, z.core.$strip>>;
+  mermaid: z.ZodOptional<z.ZodObject<{
+    output: z.ZodString;
+  }, z.core.$strip>>;
+  dbml: z.ZodOptional<z.ZodObject<{
+    output: z.ZodType<`${string}.dbml`, unknown, z.core.$ZodTypeInternals<`${string}.dbml`, unknown>>;
+  }, z.core.$strip>>;
+  svg: z.ZodOptional<z.ZodObject<{
+    output: z.ZodString;
+    format: z.ZodOptional<z.ZodEnum<{
+      svg: "svg";
+      png: "png";
+      dot: "dot";
+    }>>;
+  }, z.core.$strip>>;
+}, z.core.$strip>;
+type Config = z.infer<typeof configSchema>;
+declare function config(): Promise<{
+  readonly ok: true;
+  readonly value: Config;
+} | {
+  readonly ok: false;
+  readonly error: string;
+}>;
+declare function defineConfig(config: Config): Config;
+//#endregion
+export { Config, config, defineConfig };

package/dist/config/index.mjs

@@ -0,0 +1,95 @@
+import { existsSync } from "node:fs";
+import { resolve } from "node:path";
+import { pathToFileURL } from "node:url";
+import { register } from "tsx/esm/api";
+import { z } from "zod";
+
+//#region src/config/index.ts
+const tsFileSchema = z.string().endsWith(".ts");
+const dbmlFileSchema = z.string().endsWith(".dbml");
+const zodConfigSchema = z.object({
+	output: tsFileSchema,
+	comment: z.boolean().optional(),
+	type: z.boolean().optional(),
+	zod: z.enum([
+		"v4",
+		"mini",
+		"@hono/zod-openapi"
+	]).optional(),
+	relation: z.boolean().optional()
+}).optional();
+const valibotConfigSchema = z.object({
+	output: tsFileSchema,
+	comment: z.boolean().optional(),
+	type: z.boolean().optional(),
+	relation: z.boolean().optional()
+}).optional();
+const arktypeConfigSchema = z.object({
+	output: tsFileSchema,
+	comment: z.boolean().optional(),
+	type: z.boolean().optional()
+}).optional();
+const effectConfigSchema = z.object({
+	output: tsFileSchema,
+	comment: z.boolean().optional(),
+	type: z.boolean().optional()
+}).optional();
+const mermaidConfigSchema = z.object({ output: z.string() }).optional();
+const dbmlConfigSchema = z.object({ output: dbmlFileSchema }).optional();
+const svgConfigSchema = z.object({
+	output: z.string(),
+	format: z.enum([
+		"svg",
+		"png",
+		"dot"
+	]).optional()
+}).optional();
+const configSchema = z.object({
+	input: tsFileSchema,
+	zod: zodConfigSchema,
+	valibot: valibotConfigSchema,
+	arktype: arktypeConfigSchema,
+	effect: effectConfigSchema,
+	mermaid: mermaidConfigSchema,
+	dbml: dbmlConfigSchema,
+	svg: svgConfigSchema
+});
+async function config() {
+	const abs = resolve(process.cwd(), "sizuku.config.ts");
+	if (!existsSync(abs)) return {
+		ok: false,
+		error: `Config not found: ${abs}`
+	};
+	try {
+		register();
+		const mod = await import(pathToFileURL(abs).href);
+		if (!("default" in mod)) return {
+			ok: false,
+			error: "Config must export default object"
+		};
+		if (mod.default === void 0) return {
+			ok: false,
+			error: "Config default is undefined"
+		};
+		const result = configSchema.safeParse(mod.default);
+		if (!result.success) return {
+			ok: false,
+			error: result.error.issues.map((e) => `${e.path.map(String).join(".")}: ${e.message}`).join(", ")
+		};
+		return {
+			ok: true,
+			value: result.data
+		};
+	} catch (e) {
+		return {
+			ok: false,
+			error: e instanceof Error ? e.message : String(e)
+		};
+	}
+}
+function defineConfig(config) {
+	return config;
+}
+
+//#endregion
+export { config, defineConfig };

package/dist/index.d.mts

@@ -0,0 +1,10 @@
+//#region src/index.d.ts
+declare function main(): Promise<{
+  readonly ok: true;
+  readonly value: string;
+} | {
+  readonly ok: false;
+  readonly error: string;
+}>;
+//#endregion
+export { main };