d1-kyt 0.9.3 → 0.9.5

package/README.md

@@ -3,28 +3,44 @@
 Type-safe [Cloudflare D1](https://developers.cloudflare.com/d1/) toolkit built on [Kysely](https://kysely.dev/) and [Valibot](https://valibot.dev/). Define your schema once in Valibot — get SQL migrations and fully-typed queries with no code generation.
 
 ```typescript
-import { defineTable, InferDB, createQueryBuilder } from 'd1-kyt';
-import { queryAll, queryFirst, queryRun } from 'd1-kyt';
+import { defineTable, defineIndex, InferDB, createQueryBuilder, queryAll, queryFirst } from 'd1-kyt';
 import * as v from 'valibot';
 
+export const users = defineTable('users', {
+  email:    v.string(),
+  verified: v.boolean(),                          // stored 0/1 → returned as boolean
+  prefs:    v.object({ theme: v.string() }),      // stored as JSON → returned as object
+});
+
 export const posts = defineTable('posts', {
-  title:      v.string(),
-  published:  v.boolean(),
-  views:      v.pipe(v.number(), v.integer()),
-  categoryId: v.optional(v.pipe(v.number(), v.integer())),
-  meta:       v.object({ og: v.string() }),        // stored as JSON
+  title:    v.string(),
+  views:    v.pipe(v.number(), v.integer()),
+  authorId: v.pipe(v.number(), v.integer()),
 }, {
-  foreignKeys: [{ columns: ['categoryId'], references: categories, onDelete: 'CASCADE' }],
-  indexes: [{ columns: ['title'], unique: true }],
+  foreignKeys: [{ columns: ['authorId'], references: users }],
 });
 
-export type DB = InferDB<{ posts: typeof posts }>;
+export const postsTitleIdx = defineIndex(posts, ['title'], { unique: true });
+
+export type DB = InferDB<{ users: typeof users; posts: typeof posts }>;
 export const db = createQueryBuilder<DB>();
 
-// Type-safe queries — JSON and boolean columns deserialize automatically
-const all  = await queryAll(env.DB, db.selectFrom('posts').selectAll().compile());
-const one  = await queryFirst(env.DB, db.selectFrom('posts').where('id', '=', 1).selectAll().compile());
-const done = await queryRun(env.DB, db.deleteFrom('posts').where('id', '=', 1).compile());
+// prefs is { theme: string }, verified is boolean — deserialized automatically
+const verified = await queryAll(
+  env.DB,
+  db.selectFrom('users').selectAll().where('verified', '=', true).compile(),
+);
+
+// full Kysely — joins, subqueries, window functions, all type-checked
+const popular = await queryFirst(
+  env.DB,
+  db.selectFrom('posts')
+    .innerJoin('users', 'users.id', 'posts.authorId')
+    .select(['posts.title', 'posts.views', 'users.email'])
+    .where('posts.views', '>', 1000)
+    .orderBy('posts.views', 'desc')
+    .compile(),
+);
 ```
 
 ## Install
@@ -112,7 +128,13 @@ export const posts = defineTable('posts', {
   title:      v.string(),
   categoryId: v.pipe(v.number(), v.integer()),
 }, {
-  foreignKeys: [{ columns: ['categoryId'], references: categories, onDelete: 'CASCADE' }],
+  foreignKeys: [{
+    columns:    ['categoryId'],
+    references: categories,
+    refColumns: ['id'],           // optional — defaults to the referenced table's PK
+    onDelete:   'CASCADE',        // CASCADE | SET NULL | RESTRICT | NO ACTION
+    onUpdate:   'NO ACTION',
+  }],
 });
 ```
 
@@ -126,6 +148,30 @@ deptId: v.optional(v.pipe(v.number(), v.integer()))  // ✓ nullable allows inli
 
 ---
 
+## Indexes
+
+```typescript
+// Basic unique index
+export const postsSlugIdx = defineIndex(posts, ['slug'], { unique: true });
+
+// Composite index
+export const postsAuthorViewsIdx = defineIndex(posts, ['authorId', 'views']);
+
+// Partial index — only indexes rows matching the WHERE clause
+export const postsPublishedIdx = defineIndex(posts, ['createdAt'], {
+  where: 'published = 1',
+});
+
+// Custom index name
+export const postsSearchIdx = defineIndex(posts, ['title'], {
+  name: 'posts_title_fts_idx',
+});
+```
+
+Columns are type-checked against the table definition at compile time.
+
+---
+
 ## CLI
 
 ```bash
@@ -182,7 +228,7 @@ await queryAll(env.DB, query, undefined, []);  // disable all checks
 | Export | Description |
 |--------|-------------|
 | `defineTable(name, columns, opts?)` | Define a table; returns `SchemaTable` with `$inferSelect` / `$inferInsert` |
-| `defineIndex(table, columns, opts?)` | Define an index (columns are type-checked) |
+| `defineIndex(table, columns, opts?)` | Define an index; columns are type-checked. `opts`: `unique`, `name`, `where` (partial index) |
 | `defineTrigger(name, opts)` | Define a custom trigger |
 | `InferDB<Tables>` | Infer a Kysely-compatible `DB` type |
 

package/dist/cli.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import { existsSync, mkdirSync, readdirSync, readFileSync, writeFileSync } from 'node:fs';
 import { dirname, join, resolve } from 'node:path';
-const VERSION = '0.9.3';
+const VERSION = '0.9.5';
 const HELP = `
 d1-kyt v${VERSION} - Opinionated Cloudflare D1 + Kysely toolkit
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "d1-kyt",
-  "version": "0.9.3",
+  "version": "0.9.5",
   "description": "Opinionated Cloudflare D1 + Kysely toolkit",
   "type": "module",
   "main": "dist/index.js",

package/skills/use-d1-kyt/SKILL.md

@@ -16,7 +16,7 @@ schema.ts  →  schema:diff  →  .sql migration  →  wrangler apply  →  type
 ## 1. Define Schema
 
 ```typescript
-import { defineTable } from 'd1-kyt';
+import { defineTable, defineIndex } from 'd1-kyt';
 import * as v from 'valibot';
 
 export const posts = defineTable(
@@ -33,10 +33,20 @@ export const posts = defineTable(
     categoryId: v.pipe(v.number(), v.integer()),
   },
   {
-    foreignKeys: [{ columns: ['categoryId'], references: categories, onDelete: 'CASCADE' }],
-    indexes: [{ columns: ['slug'], unique: true }],
+    foreignKeys: [{
+      columns:    ['categoryId'],
+      references: categories,
+      refColumns: ['id'],       // optional, defaults to referenced table's PK
+      onDelete:   'CASCADE',    // CASCADE | SET NULL | RESTRICT | NO ACTION
+      onUpdate:   'NO ACTION',  // same options
+    }],
   }
 );
+
+// Indexes are defined separately with defineIndex (NOT inside defineTable options)
+export const postsSlugIdx = defineIndex(posts, ['slug'], { unique: true });
+export const postsPublishedIdx = defineIndex(posts, ['views'], { where: 'published = 1' }); // partial index
+export const postsCustomIdx = defineIndex(posts, ['title'], { name: 'posts_title_search_idx' });
 ```
 
 **Column type mapping:**