peta-orm 0.2.2 → 0.2.3

package/README.md

@@ -23,6 +23,7 @@ bun add -d kysely-bun-sqlite
 // db.ts
 import { Database } from "bun:sqlite"
 import { BunSqliteDialect } from "kysely-bun-sqlite"
+import type { ColumnShape } from "peta-orm"
 import { Peta, $t, ArkTypeSchemaConfig, Model, HasMany } from "peta-orm"
 
 const t = $t({ schema: new ArkTypeSchemaConfig() })
@@ -32,8 +33,8 @@ class User extends Model {
   static override columns = {
     id: t.integer().primaryKey(),
     name: t.string(255).min(2),
-    email: t.text().email(),
-  }
+    email: t.text().email().unique(),
+  } satisfies ColumnShape
   static override relations = {
     posts: new HasMany(() => Post),
   }
@@ -43,9 +44,9 @@ class Post extends Model {
   static override table = "posts"
   static override columns = {
     id: t.integer().primaryKey(),
-    userId: t.integer(),
+    userId: t.integer().references(() => User, ["id"]),
     title: t.string(255),
-  }
+  } satisfies ColumnShape
 }
 
 const database = new Database("my-app.db")
@@ -88,18 +89,30 @@ export { peta, User, Post }
 ### Column Types & Validation
 
 ```ts
+import type { ColumnShape } from "peta-orm"
+
 const t = $t({ schema: new ArkTypeSchemaConfig() })
 
 class User extends Model {
   static override columns = {
     id: t.integer().primaryKey(),
     name: t.string(255).min(2),          // min length
-    email: t.text().email(),             // email format
+    email: t.text().email().unique(),    // email format + unique constraint
     age: t.integer().nullable().min(0).max(150).default(0),
     role: t.enum("admin", "user").default("user"),
     score: t.double().nullable(),
     ...t.timestamps(),                   // createdAt, updatedAt
-  }
+  } satisfies ColumnShape
+}
+
+class Post extends Model {
+  static override columns = {
+    id: t.integer().primaryKey(),
+    userId: t.integer().references(() => User, ["id"]),  // foreign key
+    title: t.string(255),
+    slug: t.string().unique(),
+    published: t.boolean().default(false),
+  } satisfies ColumnShape
 }
 ```
 
@@ -132,6 +145,36 @@ const authors = await User.query().has("posts").execute()
 const active = await User.query().whereHas("posts", (q) => q.where("published", true)).execute()
 ```
 
+### ManyToMany
+
+```ts
+class Post extends Model {
+  static override columns = { id: t.integer().primaryKey(), title: t.string(255) } satisfies ColumnShape
+  static override relations = {
+    tags: new ManyToMany(() => Tag, {
+      through: "post_tags",
+      foreignPivotKey: "postId",
+      relatedPivotKey: "tagId",
+    }),
+  }
+}
+
+class Tag extends Model {
+  static override columns = { id: t.integer().primaryKey(), name: t.string(255) } satisfies ColumnShape
+}
+
+// Pivot tables are regular Models — register them so the migration
+// generator includes the pivot table automatically.
+class PostTag extends Model {
+  static override table = "post_tags"
+  static override columns = {
+    id: t.integer().primaryKey(),
+    postId: t.integer().references(() => Post, ["id"]),
+    tagId: t.integer().references(() => Tag, ["id"]),
+  } satisfies ColumnShape
+}
+```
+
 ### CRUD & Pagination
 
 ```ts

package/package.json

@@ -2,7 +2,7 @@
   "name": "peta-orm",
   "type": "module",
   "private": false,
-  "version": "0.2.2",
+  "version": "0.2.3",
   "description": "ORM for Bun, built on Kysely",
   "license": "MIT",
   "module": "src/index.ts",