prisma-effect-kysely 5.4.0 → 5.5.0

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## 5.5.0
+
+### Minor Changes
+
+- 52ccb28: Update all dependencies to latest versions and condense README/CLAUDE docs.
+
+  Major bumps:
+  - `typescript`: 5.9.3 → 6.0.3
+  - `eslint`, `@eslint/js`: 9.x → 10.x
+  - `@effect/vitest`: 0.27.0 → 0.29.0
+  - `@changesets/changelog-github`: 0.5.x → 0.6.0
+
+  Minor/patch bumps:
+  - `@prisma/generator-helper`, `@prisma/internals`, `prisma`: 7.2.0 → 7.8.0
+  - `prettier`: 3.7.4 → 3.8.3
+  - `@changesets/cli`: 2.29.8 → 2.31.0
+  - `@types/node`: 25.0.3 → 25.6.0
+  - `@typescript-eslint/*`, `typescript-eslint`: 8.50.0 → 8.59.1
+  - `@vitest/coverage-v8`, `vitest`: 4.0.16 → 4.1.5
+  - `@vitest/eslint-plugin`: 1.5.4 → 1.6.16
+  - `effect`: 3.19.14 → 3.21.2
+  - `kysely`: 0.28.9 → 0.28.16
+  - `lint-staged`: 16.2.7 → 16.4.0
+
 ## 5.4.0
 
 ### Minor Changes

package/README.md

@@ -1,26 +1,14 @@
-# Prisma Effect Generator
+# prisma-effect-kysely
 
-A Prisma generator that creates Effect Schema types from Prisma schema definitions with exact type safety and intelligent UUID detection.
+Prisma generator producing Effect Schema types with Kysely-compatible column metadata, branded IDs, and intelligent UUID detection.
 
-## Features
-
-- ✅ **Type-Safe Generation**: Zero type coercion, complete type safety
-- ✅ **Intelligent UUID Detection**: Via `@db.Uuid`, `nativeType`, or field name patterns
-- ✅ **Enum Support**: Effect Schema enums with `@map` annotation support
-- ✅ **Deterministic Output**: Alphabetically sorted for consistent results
-- ✅ **Complete Type Mappings**: All Prisma types mapped to Effect Schema equivalents
-
-## Installation
+## Install
 
 ```bash
 bun add prisma-effect-kysely
-# or
-npm install prisma-effect-kysely
 ```
 
-## Usage
-
-### 1. Add to schema.prisma
+## Setup
 
 ```prisma
 generator effect_schemas {
@@ -29,37 +17,23 @@ generator effect_schemas {
 }
 ```
 
-### 2. Generate Effect Schemas
-
 ```bash
 npx prisma generate
 ```
 
 ## Output
 
-Generates three files in the configured output directory:
-
-### enums.ts
-
-Effect Schema enums from Prisma enums with exact literal types:
-
-```typescript
-export const UserRoleSchema = Schema.Literal('admin', 'user', 'guest');
-```
-
-### types.ts
-
-Effect Schema structs from Prisma models with Kysely integration (v5.0 direct exports):
+Three files: `enums.ts`, `types.ts`, `index.ts`.
 
 ```typescript
 import { Schema } from "effect";
 import { columnType, generated, Selectable } from "prisma-effect-kysely";
 
-// EXPORTED - Branded ID schema
+// Branded ID
 export const UserId = Schema.UUID.pipe(Schema.brand("UserId"));
 export type UserId = typeof UserId.Type;
 
-// EXPORTED - Model schema (direct export)
+// Model schema
 export const User = Schema.Struct({
   id: columnType(Schema.UUID, Schema.Never, Schema.Never),
   email: Schema.String,
@@ -67,263 +41,122 @@ export const User = Schema.Struct({
 });
 export type User = typeof User;
 
-// EXPORTED - Kysely DB interface with Selectable<Model>
+// Kysely DB interface
 export interface DB {
   User: Selectable<User>;
 }
 ```
 
-### index.ts
-
-Re-exports all generated types for easy importing
-
-## Consumer Usage (v5.0)
-
-Branded ID types are exported directly. Use type utilities from `prisma-effect-kysely` for other types:
+## Consumer Usage
 
 ```typescript
 import { Selectable, Insertable, Updateable } from "prisma-effect-kysely";
 import { User, UserId, DB } from "./generated";
 
-// Branded ID type - direct import (no utility needed)
 function getUser(id: UserId): Promise<User> { ... }
 
-// Extract types using utilities (Kysely-native pattern)
 type UserSelect = Selectable<typeof User>;
 type UserInsert = Insertable<typeof User>;
 type UserUpdate = Updateable<typeof User>;
 
-// Use with Kysely
-import { Kysely } from 'kysely';
-
 const db = new Kysely<DB>({ ... });
-
-// Type-safe queries
-const user = await db.selectFrom('User').selectAll().executeTakeFirst();
 ```
 
-**Naming Convention**: All exported schemas use PascalCase, regardless of the Prisma model naming convention:
+Schema names are PascalCase regardless of Prisma model name (`session_preference` → `SessionPreference`).
+
+## Field Behavior
 
-- Model `User` → `export const User`
-- Model `session_preference` → `export const SessionPreference`
+- `@default` / `@updatedAt` → `generated()` (omitted from insert, optional in update)
+- `@id` with `@default` → `columnType(type, Never, Never)` (read-only)
+- Optional fields → `Schema.NullOr(type)`
+- Foreign keys → branded ID type from target model
 
 ## Type Mappings
 
-| Prisma Type | Effect Schema Type  | Notes                            |
-| ----------- | ------------------- | -------------------------------- |
-| String      | `Schema.String`     | `Schema.UUID` for id fields      |
-| Int / Float | `Schema.Number`     | With `Schema.int()` for integers |
-| BigInt      | `Schema.BigInt`     | Exact bigint type                |
-| Decimal     | `Schema.String`     | String for precision             |
-| Boolean     | `Schema.Boolean`    | -                                |
-| DateTime    | `Schema.DateFromSelf` | Native Date for Kysely           |
-| Json        | `Schema.Unknown`    | Safe unknown type                |
-| Bytes       | `Schema.Uint8Array` | -                                |
-| Enum        | Enum Schema         | With `Schema.Literal` values     |
+| Prisma      | Effect Schema         |
+| ----------- | --------------------- |
+| String      | `Schema.String`       |
+| Int / Float | `Schema.Number`       |
+| BigInt      | `Schema.BigInt`       |
+| Decimal     | `Schema.String`       |
+| Boolean     | `Schema.Boolean`      |
+| DateTime    | `Schema.DateFromSelf` |
+| Json        | `Schema.Unknown`      |
+| Bytes       | `Schema.Uint8Array`   |
+| Enum        | `Schema.Literal(...)` |
+| UUID        | `Schema.UUID`         |
+
+Arrays → `Schema.Array(t)`. Nullable → `Schema.NullOr(t)`.
 
 ## UUID Detection
 
-The generator intelligently detects UUID fields through multiple strategies (in order):
-
-1. **Native Type**: `@db.Uuid` attribute (most reliable)
-2. **Documentation**: `@db.Uuid` in field comments
-3. **Default Value**: `dbgenerated("gen_random_uuid()")` or similar
-4. **Field Name Patterns**: `id`, `*_id`, `*_uuid`, `uuid`
-
-Example:
-
-```prisma
-model User {
-  id        String @id @db.Uuid @default(dbgenerated("gen_random_uuid()"))
-  userId    String @db.Uuid  // Detected via native type
-  productId String           // Detected via field name pattern
-}
-```
-
-## Development
-
-This project uses **Bun** as the sole package manager.
-
-```bash
-# Install dependencies
-bun install
-
-# Run tests
-bun run test
-
-# Run tests in watch mode
-bun run test:watch
-
-# Run tests with coverage
-bun run test:coverage
-
-# Type check
-bun run typecheck
-
-# Build
-bun run build
-```
-
-## Release Process
-
-This project uses [Changesets](https://github.com/changesets/changesets) for automated versioning and publishing:
-
-### Creating a Release
-
-1. **Add a changeset** for your changes:
-
-   ```bash
-   bun changeset
-   ```
-
-   Follow the prompts to describe your changes (patch/minor/major).
-
-2. **Commit the changeset**:
+Priority order:
 
-   ```bash
-   git add .changeset/
-   git commit -m "docs: add changeset for [feature/fix]"
-   git push
-   ```
-
-3. **Automated Release PR**: The CI will automatically:
-   - Create or update a "Version Packages" PR
-   - Update `package.json` version
-   - Update `CHANGELOG.md`
-
-4. **Publish**: When you merge the "Version Packages" PR:
-   - CI automatically publishes to npm using Bun
-   - Creates a git tag (e.g., `v1.15.0`)
-   - Creates a GitHub release with auto-generated notes
-
-### Manual Publishing (if needed)
-
-```bash
-# Build and run all checks
-bun run prepublishOnly
-
-# Publish
-bun publish --access public
-```
-
-## Releasing (CI/CD)
-
-This repo uses **Changesets** to automate versioning, changelog updates, npm publishing, git tags, and GitHub Releases.
-
-### For PR authors
-
-Add a changeset for any user-facing change:
-
-```bash
-bun changeset
-```
-
-Commit the generated file in `.changeset/`.
-
-### What happens on `main`
-
-- When changesets land on `main`, CI opens/updates a **Version Packages** PR.
-- When the **Version Packages** PR is merged, CI:
-  - updates `package.json` + `CHANGELOG.md`
-  - publishes to npm (with provenance)
-  - creates/pushes `vX.Y.Z` tag
-  - creates a GitHub Release
-
-### Required GitHub repo secrets
-
-- `NPM_TOKEN`: npm access token with permission to publish `prisma-effect-kysely`
-
-## Architecture
-
-### Type Safety
-
-This generator uses **EXACT DMMF types** from Prisma and implements **zero type coercion**:
-
-- Uses `FieldDefault` type matching Prisma's exact structure
-- Type-safe validation with structural typing
-- No `as` assertions or unsafe casts
-- Complete TypeScript strict mode compliance
-
-### Generated Code Quality
-
-- **Alphabetically sorted** fields and models for consistency
-- **Branded types** for UUIDs via `Schema.UUID`
-- **Exact type inference** - no widening to `any` or `unknown`
-- **Auto-generated headers** with timestamps and edit warnings
+1. Native type: `@db.Uuid`
+2. Documentation: `@db.Uuid` in field comment
+3. Field name pattern: `id`, `*_id`, `*_uuid`, `uuid`
 
 ## Custom Type Overrides
 
-Use `@customType` annotations to override Effect Schema types for **Prisma-supported fields**:
+Use `@customType` in field docs to override Effect Schema:
 
 ```prisma
 model User {
   /// @customType(Schema.String.pipe(Schema.email()))
   email String @unique
-
   /// @customType(Schema.Number.pipe(Schema.positive()))
   age Int
-
-  /// @customType(Schema.String.pipe(Schema.brand('UserId')))
-  userId String
 }
 ```
 
-**Supported for**: All Prisma scalar types (String, Int, Float, Boolean, DateTime, BigInt, Decimal, Json, Bytes)
-
-**Use cases**:
+Supported on all Prisma scalar types.
 
-- Email/URL validation
-- Number constraints (positive, range, etc.)
-- Custom branded types
-- Refined string patterns
+## Implicit M2M Join Tables
 
-**Examples**:
+Prisma columns `A`/`B` map to semantic snake_case fields via `Schema.fromKey`:
 
 ```typescript
-// Generated from Prisma schema with @customType annotations
-export const _User = Schema.Struct({
-  email: Schema.String.pipe(Schema.email()),
-  age: Schema.Number.pipe(Schema.positive()),
-  userId: Schema.String.pipe(Schema.brand('UserId')),
+export const ProductToProductTag = Schema.Struct({
+  product_id: Schema.propertySignature(
+    columnType(Schema.UUID, Schema.Never, Schema.Never)
+  ).pipe(Schema.fromKey("A")),
+  product_tag_id: Schema.propertySignature(
+    columnType(Schema.UUID, Schema.Never, Schema.Never)
+  ).pipe(Schema.fromKey("B")),
 });
 ```
 
-## Troubleshooting
+## Package Exports
 
-### Generator Not Found
+| Entry                            | Contents                                              |
+| -------------------------------- | ----------------------------------------------------- |
+| `prisma-effect-kysely`           | Type utilities + runtime helpers (default import)     |
+| `prisma-effect-kysely/generator` | Prisma generator binary entry                         |
+| `prisma-effect-kysely/kysely`    | `getSchemas`, `columnType`, `generated`, type utils   |
+| `prisma-effect-kysely/error`     | `NotFoundError`, `QueryError`, `QueryParseError`, ... |
+| `prisma-effect-kysely/runtime`   | All runtime utilities                                 |
 
-If you're developing the generator locally, make sure to build it first:
+## Development
 
 ```bash
-npm run build
-```
-
-Then reference it in your schema.prisma:
-
-```prisma
-generator effect_schemas {
-  provider = "node ./path/to/dist/generator.js"
-  output   = "./generated/effect"
-}
+bun install
+bun run test
+bun run typecheck
+bun run build
+bun run prepublishOnly  # lint + typecheck + test + build
 ```
 
-### Wrong Types Generated
+## Releasing
 
-Check the generator output in console:
+Uses [Changesets](https://github.com/changesets/changesets).
 
+```bash
+bun changeset           # add changeset
+git add .changeset/ && git commit -m "docs: changeset"
+git push
 ```
-[Effect Generator] Starting generation...
-[Effect Generator] Processing 15 models, 3 enums
-[Effect Generator] ✓ Generated to ../../libs/types/storage/src/lib/effect
-```
-
-### UUID Not Detected
-
-Add explicit `@db.Uuid` attribute:
 
-```prisma
-userId String @db.Uuid
-```
+CI opens a "Version Packages" PR. Merging it publishes to npm, tags, and creates a GitHub release. Requires `NPM_TOKEN` repo secret.
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prisma-effect-kysely",
-  "version": "5.4.0",
+  "version": "5.5.0",
   "description": "Prisma generator that creates Effect Schema types from Prisma schema compatible with Kysely",
   "license": "MIT",
   "author": "Samuel Ho",
@@ -84,7 +84,7 @@
     ]
   },
   "dependencies": {
-    "prettier": "^3.7.4"
+    "prettier": "^3.8.3"
   },
   "peerDependencies": {
     "effect": "^3.19.14",
@@ -96,28 +96,28 @@
     }
   },
   "devDependencies": {
-    "@prisma/generator-helper": "^7.2.0",
-    "@changesets/changelog-github": "^0.5.1",
-    "@changesets/cli": "^2.29.8",
-    "@effect/vitest": "^0.27.0",
-    "@eslint/js": "^9.39.2",
-    "@prisma/internals": "^7.2.0",
-    "@types/node": "^25.0.3",
-    "@typescript-eslint/eslint-plugin": "^8.50.0",
-    "@typescript-eslint/parser": "^8.50.0",
-    "@vitest/coverage-v8": "^4.0.16",
-    "@vitest/eslint-plugin": "^1.5.4",
-    "effect": "^3.19.14",
-    "eslint": "^9.39.2",
+    "@changesets/changelog-github": "^0.6.0",
+    "@changesets/cli": "^2.31.0",
+    "@effect/vitest": "^0.29.0",
+    "@eslint/js": "^10.0.0",
+    "@prisma/generator-helper": "^7.8.0",
+    "@prisma/internals": "^7.8.0",
+    "@types/node": "^25.6.0",
+    "@typescript-eslint/eslint-plugin": "^8.59.1",
+    "@typescript-eslint/parser": "^8.59.1",
+    "@vitest/coverage-v8": "^4.1.5",
+    "@vitest/eslint-plugin": "^1.6.16",
+    "effect": "^3.21.2",
+    "eslint": "^10.0.0",
     "eslint-import-resolver-typescript": "^4.4.4",
     "eslint-plugin-import": "^2.32.0",
     "husky": "^9.1.7",
-    "kysely": "^0.28.9",
-    "lint-staged": "^16.2.7",
-    "prisma": "^7.2.0",
+    "kysely": "^0.28.16",
+    "lint-staged": "^16.4.0",
+    "prisma": "^7.8.0",
     "ts-node": "^10.9.2",
-    "typescript": "^5.9.3",
-    "typescript-eslint": "^8.50.0",
-    "vitest": "^4.0.16"
+    "typescript": "^6.0.0",
+    "typescript-eslint": "^8.59.1",
+    "vitest": "^4.1.5"
   }
 }