kysely-repo-kit 0.2.3 → 0.2.5

package/README.md

@@ -0,0 +1,286 @@
+# Kysely Repo Kit 🛡️🚀
+
+A fully typed repository, relation population, and hook layer for [Kysely](https://github.com/kysely-org/kysely). 
+
+`kysely-repo-kit` provides a declarative, type-safe API to construct repositories with native soft-delete support, life-cycle hooks, complex filtering (`AND`, `OR`, `NOT`, `jsonb`, and raw expressions), and nested relation populating using high-performance JSON helpers.
+
+---
+
+## Features
+
+- **🛡️ 100% Type-Safe**: Complete autocomplete and compile-time type safety for inserts, updates, filters, selects, and nested population.
+- **🔄 Auto-Population**: Effortlessly load relations (1-to-1 or 1-to-many) using native, highly optimized Postgres JSON helper functions (`jsonArrayFrom`, `jsonObjectFrom`).
+- **🪝 Lifecycle Hooks**: Intercept database actions using `beforeCreate`, `afterCreate`, `beforeUpdate`, `afterUpdate`, `beforeDelete`, and `afterDelete`.
+- **🗑️ Native Soft Delete**: Easily set up table-wide soft deletes. Safely filter out deleted records automatically across queries and populations.
+- **🧩 Power Queries**: Multi-faceted filter system supporting nested `AND` / `OR` / `NOT`, Case-insensitive text searches, Jsonb paths filtering, and raw SQL escapes.
+- **🤝 Transaction Session Propagation**: Easily pass Kysely transactions down using `.withSession(tx)`.
+
+---
+
+## Installation
+
+```bash
+# With pnpm (recommended)
+pnpm add kysely-repo-kit
+
+# With npm
+npm install kysely-repo-kit
+
+# With yarn
+yarn add kysely-repo-kit
+
+# With bun
+bun add kysely-repo-kit
+```
+
+*Note: `kysely` is a peer dependency of this library and must be installed in your project.*
+
+---
+
+## Quick Start
+
+### 1. Define your Database Schema & Types
+
+Let's assume you have a typical Kysely database definition:
+
+```typescript
+import { Kysely } from 'kysely';
+
+export interface UserTable {
+  id: string;
+  email: string;
+  name: string;
+  created_at: Date;
+  deleted_at: Date | null;
+}
+
+export interface PostTable {
+  id: string;
+  title: string;
+  content: string;
+  author_id: string;
+  created_at: Date;
+}
+
+export interface Database {
+  users: UserTable;
+  posts: PostTable;
+}
+
+export const db = new Kysely<Database>({ ... });
+```
+
+### 2. Create the Repository Builder
+
+Create a single instance of your repository builder associated with your `Database` type:
+
+```typescript
+import { createRepoBuilder } from 'kysely-repo-kit';
+import { Database } from './db';
+
+export const repoBuilder = createRepoBuilder<Database>();
+```
+
+### 3. Build & Define Your Repositories
+
+Using the builder, we declare relations, soft delete rules, hooks, and compile them into executable repository classes.
+
+```typescript
+import { repoBuilder } from './builder';
+
+// Define PostRepository
+export const PostRepository = repoBuilder
+  .table('posts')
+  .init;
+
+// Define UserRepository with soft delete, hooks, and relationships
+export const UserRepository = repoBuilder
+  .table('users')
+  .softDelete('deleted_at') // Automatically filters out soft-deleted users
+  .hooks({
+    beforeCreate: (data) => {
+      // Intercept and mutate data before inserting
+      return { ...data, name: data.name.trim() };
+    },
+    afterCreate: (user) => {
+      console.log(`User created: ${user.email}`);
+    }
+  })
+  .populate({
+    as: 'posts',
+    ref: 'posts',
+    foreignKey: 'author_id', // links posts.author_id to users.id
+  })
+  .init;
+```
+
+### 4. Perform Queries
+
+Instantiate the repository classes with your Kysely database instance.
+
+```typescript
+import { db } from './db';
+import { UserRepository } from './repositories';
+
+const userRepo = new UserRepository(db);
+
+// 1. Create a user
+const newUser = await userRepo.create({
+  data: {
+    id: 'user-1',
+    email: 'alice@example.com',
+    name: ' Alice ',
+  }
+}); // Hooks trim name automatically! -> 'Alice'
+
+// 2. Query with type-safe nested relations population
+const userWithPosts = await userRepo.findFirst({
+  where: { id: 'user-1' },
+  populate: {
+    posts: true // Auto-loaded via Postgres JSON serialization
+  }
+});
+
+console.log(userWithPosts?.posts); // Type-safe Array of Post records!
+```
+
+---
+
+## Detailed Usage Guide
+
+### CRUD Interface
+
+Every generated repository inherits from `BaseRepository` and exposes the following API:
+
+#### Retrieve Queries
+* **`findMany({ where, select, populate, skip, take, orderBy, lock, includeDeleted })`**
+* **`findFirst({ where, select, populate, lock, includeDeleted })`**
+* **`findUnique({ where: { id }, select, populate, includeDeleted })`**
+* **`count({ where, includeDeleted })`**
+* **`exists({ where, includeDeleted })`**
+
+#### Mutation Queries
+* **`create({ data, select })`**
+* **`createMany({ data })`**
+* **`update({ where, data, select })`**
+* **`updateUnique({ where: { id }, data, select })`**
+* **`updateMany({ where, data })`**
+* **`upsert({ where, create, update })`**
+* **`delete({ where })`** (performs soft-delete if enabled, otherwise hard-delete)
+* **`softDelete({ where, deletedAt })`** (explicitly soft-delete records)
+* **`hardDelete({ where })`** (explicitly hard-delete records)
+* **`deleteUnique({ where: { id } })`**
+* **`deleteMany({ where })`**
+
+---
+
+### Rich Filtering (`WhereFilter`)
+
+`kysely-repo-kit` provides a powerful, type-safe filtering engine. 
+
+```typescript
+const activePremiumUsers = await userRepo.findMany({
+  where: {
+    // 1. Column filters with specific matching options
+    name: {
+      contains: 'John',
+      mode: 'insensitive', // case-insensitive LIKE
+    },
+    // 2. OR / AND / NOT operators
+    OR: [
+      { email: { endsWith: '@gmail.com' } },
+      { email: { endsWith: '@outlook.com' } }
+    ],
+    // 3. Raw Kysely expression fallback
+    _raw: (eb) => eb('created_at', '>', sql`NOW() - INTERVAL '30 days'`)
+  }
+});
+```
+
+#### JSONB Filtering
+Filter records by deeply nested keys within Postgres `JSONB` columns using type-safe path matching:
+
+```typescript
+const users = await userRepo.findMany({
+  where: {
+    jsonb: {
+      'metadata.profile.theme': 'dark', // Type-safe leaf path matching!
+      'metadata.loginCount': { gte: 10 }
+    }
+  }
+});
+```
+
+---
+
+### Relation Populations
+
+To populate complex, deeply nested relational schemas, declare relationship rules on the builder:
+
+```typescript
+export const OrganisationRepository = repoBuilder
+  .table('organisations')
+  .init;
+
+export const UserRepository = repoBuilder
+  .table('users')
+  .populate({
+    as: 'org',
+    ref: 'organisations',
+    foreignKey: 'id',
+    localKey: 'org_id',
+    justOne: true, // Populates as single object instead of an array
+  })
+  .populate({
+    as: 'posts',
+    ref: 'posts',
+    foreignKey: 'author_id',
+    nestedPopulations: () => ({
+      // Recursively nest population options!
+      comments: definePopulation({
+        table: 'comments',
+        foreignKey: 'post_id',
+      })
+    })
+  })
+  .init;
+```
+
+Query with populated relations dynamically:
+```typescript
+const result = await userRepo.findMany({
+  populate: {
+    org: {
+      select: { id: true, name: true } // Limit columns returned by relation
+    },
+    posts: {
+      populate: {
+        comments: true // Nested population loaded automatically!
+      }
+    }
+  }
+});
+```
+
+---
+
+### Transactions & Session Propagation
+
+To run operations safely within a database transaction, leverage the `.withSession()` method:
+
+```typescript
+await db.transaction().execute(async (tx) => {
+  // Spawn repository instances bound to the transaction session
+  const userRepoTx = userRepo.withSession(tx);
+  const postRepoTx = new PostRepository(db).withSession(tx);
+
+  const user = await userRepoTx.create({ data: { ... } });
+  await postRepoTx.create({ data: { author_id: user.id, ... } });
+});
+```
+
+---
+
+## License
+
+MIT © [jesulonimii](https://github.com/jesulonimii)

package/dist/builder.d.ts

@@ -1,6 +1,14 @@
-import type { Kysely, Selectable, Transaction } from "kysely";
+import type { Insertable, Kysely, Selectable, Transaction, Updateable } from "kysely";
 import BaseRepository, { type InferTable, type PopulateInput, type PopulationMap, type SelectInput, type SoftDeleteRegistry, type WhereFilter } from "./base";
 type EmptyPopulations = Record<never, never>;
+type HooksConfig<DB, TableName extends keyof DB & string, Table extends object> = {
+    beforeCreate?: (data: Insertable<DB[TableName]>) => Promise<Insertable<DB[TableName]>> | Insertable<DB[TableName]>;
+    beforeUpdate?: (data: Updateable<DB[TableName]>, where: WhereFilter<DB, TableName, Table>) => Promise<Updateable<DB[TableName]>> | Updateable<DB[TableName]>;
+    beforeDelete?: (where: WhereFilter<DB, TableName, Table>) => Promise<void> | void;
+    afterCreate?: (row: Selectable<Table>) => Promise<void> | void;
+    afterUpdate?: (row: Selectable<Table> | null) => Promise<void> | void;
+    afterDelete?: (row: Selectable<Table> | null) => Promise<void> | void;
+};
 type InferSelectableRow<DB, TableName extends keyof DB & string> = DB[TableName] extends object ? Selectable<DB[TableName]> : never;
 type InferRow<DB, TableName extends keyof DB & string> = DB[TableName] extends object ? Selectable<DB[TableName]> : never;
 export type RepoInstance<DB, TableName extends keyof DB & string, Populations extends PopulationMap<DB>> = BaseRepository<DB, TableName, Populations> & {
@@ -32,8 +40,10 @@ declare class RepoBuilder<DB, TableName extends keyof DB & string, Populations e
     private readonly currentPopulations;
     private readonly currentSoftDeleteColumn?;
     private readonly softDeleteRegistry?;
-    constructor(currentTableName: TableName, currentPopulations?: Populations, currentSoftDeleteColumn?: (keyof Selectable<Table> & string) | undefined, softDeleteRegistry?: SoftDeleteRegistry<DB> | undefined);
+    private readonly currentHooks?;
+    constructor(currentTableName: TableName, currentPopulations?: Populations, currentSoftDeleteColumn?: (keyof Selectable<Table> & string) | undefined, softDeleteRegistry?: SoftDeleteRegistry<DB> | undefined, currentHooks?: HooksConfig<DB, TableName, Table> | undefined);
     softDelete<Column extends keyof Selectable<Table> & string>(column: Column | false): RepoBuilder<DB, TableName, Populations, Table>;
+    hooks(config: HooksConfig<DB, TableName, Table>): RepoBuilder<DB, TableName, Populations, Table>;
     populate<Name extends string, Ref extends keyof DB & string, NestedPopulations extends PopulationMap<DB> = Record<never, never>>(def: PopulateConfig<DB, Name, Ref, NestedPopulations>): RepoBuilder<DB, TableName, Populations & Record<Name, import("./base").PopulationDefinition<DB, InferRow<DB, Ref> extends infer T ? T extends InferRow<DB, Ref> ? T extends any[] ? T : import("kysely").DrainOuterGeneric<{ [K_1 in { [K in keyof T]: import("kysely").SelectType<T[K]> extends infer T_1 ? T_1 extends import("kysely").SelectType<T[K]> ? T_1 extends never ? never : K : never : never; }[keyof T]]: import("kysely").SelectType<T[K_1]>; }> : never : never, NestedPopulations> & {
         justOne: true;
     }>, Table>;

package/dist/builder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"builder.d.ts","sourceRoot":"","sources":["../src/builder.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAA;AAC7D,OAAO,cAAc,EAAE,EAEnB,KAAK,UAAU,EACf,KAAK,aAAa,EAClB,KAAK,aAAa,EAClB,KAAK,WAAW,EAChB,KAAK,kBAAkB,EACvB,KAAK,WAAW,EACnB,MAAM,QAAQ,CAAA;AAEf,KAAK,gBAAgB,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;AAG5C,KAAK,kBAAkB,CAAC,EAAE,EAAE,SAAS,SAAS,MAAM,EAAE,GAAG,MAAM,IAC3D,EAAE,CAAC,SAAS,CAAC,SAAS,MAAM,GACtB,UAAU,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,GACzB,KAAK,CAAA;AAEf,KAAK,QAAQ,CAAC,EAAE,EAAE,SAAS,SAAS,MAAM,EAAE,GAAG,MAAM,IACjD,EAAE,CAAC,SAAS,CAAC,SAAS,MAAM,GACtB,UAAU,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,GACzB,KAAK,CAAA;AAEf,MAAM,MAAM,YAAY,CACpB,EAAE,EACF,SAAS,SAAS,MAAM,EAAE,GAAG,MAAM,EACnC,WAAW,SAAS,aAAa,CAAC,EAAE,CAAC,IACrC,cAAc,CAAC,EAAE,EAAE,SAAS,EAAE,WAAW,CAAC,GAAG;IAC7C,IAAI,CAAC,CAAC,SAAS,aAAa,CAAC,EAAE,EAAE,WAAW,CAAC,GAAG,gBAAgB,KAAK;QACjE,QAAQ,CAAC,EAAE,CAAC,CAAA;KACf,CAAA;CACJ,CAAA;AAED,MAAM,MAAM,eAAe,CACvB,EAAE,EACF,SAAS,SAAS,MAAM,EAAE,GAAG,MAAM,EACnC,WAAW,SAAS,aAAa,CAAC,EAAE,CAAC,IACrC;IACA,KACI,EAAE,EAAE,MAAM,CAAC,EAAE,CAAC,EACd,WAAW,CAAC,EAAE,WAAW,CAAC,EAAE,CAAC,GAC9B,YAAY,CAAC,EAAE,EAAE,SAAS,EAAE,WAAW,CAAC,CAAA;IAE3C,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAA;CACpC,CAAA;AAED,KAAK,cAAc,CACf,EAAE,EACF,IAAI,SAAS,MAAM,EACnB,GAAG,SAAS,MAAM,EAAE,GAAG,MAAM,EAC7B,iBAAiB,SAAS,aAAa,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAClE;IACA,EAAE,EAAE,IAAI,CAAA;IACR,GAAG,EAAE,GAAG,CAAA;IACR,UAAU,CAAC,EAAE,MAAM,kBAAkB,CAAC,EAAE,EAAE,GAAG,CAAC,GAAG,MAAM,CAAA;IACvD,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,OAAO,CAAC,EAAE,IAAI,CAAA;IACd,UAAU,CAAC,EAAE,CAAC,MAAM,kBAAkB,CAAC,EAAE,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,KAAK,CAAA;IACjE,iBAAiB,CAAC,EAAE,MAAM,iBAAiB,CAAA;IAC3C,MAAM,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,CAAA;IACjD,KAAK,CAAC,EAAE,WAAW,CAAC,EAAE,EAAE,GAAG,CAAC,CAAA;CAC/B,CAAA;AAED,KAAK,kBAAkB,CACnB,EAAE,EACF,SAAS,SAAS,MAAM,EAAE,GAAG,MAAM,IACnC;IACA,UAAU,CAAC,EAAE,CAAC,MAAM,kBAAkB,CAAC,EAAE,EAAE,SAAS,CAAC,GAAG,MAAM,CAAC,GAAG,KAAK,CAAA;CAC1E,CAAA;AAED,cAAM,WAAW,CACb,EAAE,EACF,SAAS,SAAS,MAAM,EAAE,GAAG,MAAM,EACnC,WAAW,SAAS,aAAa,CAAC,EAAE,CAAC,GAAG,gBAAgB,EACxD,KAAK,SAAS,MAAM,GAAG,UAAU,CAAC,EAAE,EAAE,SAAS,CAAC;IAG5C,OAAO,CAAC,QAAQ,CAAC,gBAAgB;IACjC,OAAO,CAAC,QAAQ,CAAC,kBAAkB;IACnC,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAC;IACzC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC;gBAHnB,gBAAgB,EAAE,SAAS,EAC3B,kBAAkB,GAAE,WAA+B,EACnD,uBAAuB,CAAC,GAAE,MAAM,UAAU,CAAC,KAAK,CAAC,GAAG,MAAM,aAAA,EAC1D,kBAAkB,CAAC,EAAE,kBAAkB,CAAC,EAAE,CAAC,YAAA;IAGhE,UAAU,CAAC,MAAM,SAAS,MAAM,UAAU,CAAC,KAAK,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,KAAK;IAWlF,QAAQ,CACJ,IAAI,SAAS,MAAM,EACnB,GAAG,SAAS,MAAM,EAAE,GAAG,MAAM,EAC7B,iBAAiB,SAAS,aAAa,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,EACpE,GAAG,EAAE,cAAc,CAAC,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,iBAAiB,CAAC;;;IA+BvD,IAAI,IAAI,IAAI,eAAe,CAAC,EAAE,EAAE,SAAS,EAAE,WAAW,CAAC,CA+BtD;CACJ;AAED,wBAAgB,iBAAiB,CAAC,EAAE;UAItB,SAAS,SAAS,MAAM,EAAE,GAAG,MAAM,aAC1B,SAAS,gBACP,kBAAkB,CAAC,EAAE,EAAE,SAAS,CAAC;EAsBzD"}
+{"version":3,"file":"builder.d.ts","sourceRoot":"","sources":["../src/builder.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAA;AACrF,OAAO,cAAc,EAAE,EAEnB,KAAK,UAAU,EACf,KAAK,aAAa,EAClB,KAAK,aAAa,EAClB,KAAK,WAAW,EAChB,KAAK,kBAAkB,EACvB,KAAK,WAAW,EACnB,MAAM,QAAQ,CAAA;AAEf,KAAK,gBAAgB,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;AAE5C,KAAK,WAAW,CAAC,EAAE,EAAE,SAAS,SAAS,MAAM,EAAE,GAAG,MAAM,EAAE,KAAK,SAAS,MAAM,IAAI;IAC9E,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,UAAU,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,KAAK,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAA;IAClH,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,UAAU,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,EAAE,EAAE,SAAS,EAAE,KAAK,CAAC,KAAK,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAA;IAC5J,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,WAAW,CAAC,EAAE,EAAE,SAAS,EAAE,KAAK,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;IACjF,WAAW,CAAC,EAAE,CAAC,GAAG,EAAE,UAAU,CAAC,KAAK,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;IAC9D,WAAW,CAAC,EAAE,CAAC,GAAG,EAAE,UAAU,CAAC,KAAK,CAAC,GAAG,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;IACrE,WAAW,CAAC,EAAE,CAAC,GAAG,EAAE,UAAU,CAAC,KAAK,CAAC,GAAG,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;CACxE,CAAA;AAGD,KAAK,kBAAkB,CAAC,EAAE,EAAE,SAAS,SAAS,MAAM,EAAE,GAAG,MAAM,IAC3D,EAAE,CAAC,SAAS,CAAC,SAAS,MAAM,GACtB,UAAU,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,GACzB,KAAK,CAAA;AAEf,KAAK,QAAQ,CAAC,EAAE,EAAE,SAAS,SAAS,MAAM,EAAE,GAAG,MAAM,IACjD,EAAE,CAAC,SAAS,CAAC,SAAS,MAAM,GACtB,UAAU,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,GACzB,KAAK,CAAA;AAEf,MAAM,MAAM,YAAY,CACpB,EAAE,EACF,SAAS,SAAS,MAAM,EAAE,GAAG,MAAM,EACnC,WAAW,SAAS,aAAa,CAAC,EAAE,CAAC,IACrC,cAAc,CAAC,EAAE,EAAE,SAAS,EAAE,WAAW,CAAC,GAAG;IAC7C,IAAI,CAAC,CAAC,SAAS,aAAa,CAAC,EAAE,EAAE,WAAW,CAAC,GAAG,gBAAgB,KAAK;QACjE,QAAQ,CAAC,EAAE,CAAC,CAAA;KACf,CAAA;CACJ,CAAA;AAED,MAAM,MAAM,eAAe,CACvB,EAAE,EACF,SAAS,SAAS,MAAM,EAAE,GAAG,MAAM,EACnC,WAAW,SAAS,aAAa,CAAC,EAAE,CAAC,IACrC;IACA,KACI,EAAE,EAAE,MAAM,CAAC,EAAE,CAAC,EACd,WAAW,CAAC,EAAE,WAAW,CAAC,EAAE,CAAC,GAC9B,YAAY,CAAC,EAAE,EAAE,SAAS,EAAE,WAAW,CAAC,CAAA;IAE3C,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAA;CACpC,CAAA;AAED,KAAK,cAAc,CACf,EAAE,EACF,IAAI,SAAS,MAAM,EACnB,GAAG,SAAS,MAAM,EAAE,GAAG,MAAM,EAC7B,iBAAiB,SAAS,aAAa,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAClE;IACA,EAAE,EAAE,IAAI,CAAA;IACR,GAAG,EAAE,GAAG,CAAA;IACR,UAAU,CAAC,EAAE,MAAM,kBAAkB,CAAC,EAAE,EAAE,GAAG,CAAC,GAAG,MAAM,CAAA;IACvD,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,OAAO,CAAC,EAAE,IAAI,CAAA;IACd,UAAU,CAAC,EAAE,CAAC,MAAM,kBAAkB,CAAC,EAAE,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,KAAK,CAAA;IACjE,iBAAiB,CAAC,EAAE,MAAM,iBAAiB,CAAA;IAC3C,MAAM,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,CAAA;IACjD,KAAK,CAAC,EAAE,WAAW,CAAC,EAAE,EAAE,GAAG,CAAC,CAAA;CAC/B,CAAA;AAED,KAAK,kBAAkB,CACnB,EAAE,EACF,SAAS,SAAS,MAAM,EAAE,GAAG,MAAM,IACnC;IACA,UAAU,CAAC,EAAE,CAAC,MAAM,kBAAkB,CAAC,EAAE,EAAE,SAAS,CAAC,GAAG,MAAM,CAAC,GAAG,KAAK,CAAA;CAC1E,CAAA;AAED,cAAM,WAAW,CACb,EAAE,EACF,SAAS,SAAS,MAAM,EAAE,GAAG,MAAM,EACnC,WAAW,SAAS,aAAa,CAAC,EAAE,CAAC,GAAG,gBAAgB,EACxD,KAAK,SAAS,MAAM,GAAG,UAAU,CAAC,EAAE,EAAE,SAAS,CAAC;IAG5C,OAAO,CAAC,QAAQ,CAAC,gBAAgB;IACjC,OAAO,CAAC,QAAQ,CAAC,kBAAkB;IACnC,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAC;IACzC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC;IACpC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC;gBAJb,gBAAgB,EAAE,SAAS,EAC3B,kBAAkB,GAAE,WAA+B,EACnD,uBAAuB,CAAC,GAAE,MAAM,UAAU,CAAC,KAAK,CAAC,GAAG,MAAM,aAAA,EAC1D,kBAAkB,CAAC,EAAE,kBAAkB,CAAC,EAAE,CAAC,YAAA,EAC3C,YAAY,CAAC,EAAE,WAAW,CAAC,EAAE,EAAE,SAAS,EAAE,KAAK,CAAC,YAAA;IAGrE,UAAU,CAAC,MAAM,SAAS,MAAM,UAAU,CAAC,KAAK,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,KAAK;IAYlF,KAAK,CAAC,MAAM,EAAE,WAAW,CAAC,EAAE,EAAE,SAAS,EAAE,KAAK,CAAC;IAU/C,QAAQ,CACJ,IAAI,SAAS,MAAM,EACnB,GAAG,SAAS,MAAM,EAAE,GAAG,MAAM,EAC7B,iBAAiB,SAAS,aAAa,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,EACpE,GAAG,EAAE,cAAc,CAAC,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,iBAAiB,CAAC;;;IAgCvD,IAAI,IAAI,IAAI,eAAe,CAAC,EAAE,EAAE,SAAS,EAAE,WAAW,CAAC,CA2DtD;CACJ;AAED,wBAAgB,iBAAiB,CAAC,EAAE;UAItB,SAAS,SAAS,MAAM,EAAE,GAAG,MAAM,aAC1B,SAAS,gBACP,kBAAkB,CAAC,EAAE,EAAE,SAAS,CAAC;EAsBzD"}

package/dist/builder.js

@@ -4,15 +4,20 @@ class RepoBuilder {
     currentPopulations;
     currentSoftDeleteColumn;
     softDeleteRegistry;
-    constructor(currentTableName, currentPopulations = {}, currentSoftDeleteColumn, softDeleteRegistry) {
+    currentHooks;
+    constructor(currentTableName, currentPopulations = {}, currentSoftDeleteColumn, softDeleteRegistry, currentHooks) {
         this.currentTableName = currentTableName;
         this.currentPopulations = currentPopulations;
         this.currentSoftDeleteColumn = currentSoftDeleteColumn;
         this.softDeleteRegistry = softDeleteRegistry;
+        this.currentHooks = currentHooks;
     }
     softDelete(column) {
         this.softDeleteRegistry?.set(this.currentTableName, column === false ? false : column);
-        return new RepoBuilder(this.currentTableName, this.currentPopulations, (column === false ? undefined : column), this.softDeleteRegistry);
+        return new RepoBuilder(this.currentTableName, this.currentPopulations, (column === false ? undefined : column), this.softDeleteRegistry, this.currentHooks);
+    }
+    hooks(config) {
+        return new RepoBuilder(this.currentTableName, this.currentPopulations, this.currentSoftDeleteColumn, this.softDeleteRegistry, config);
     }
     populate(def) {
         const isSingle = Boolean(def.localKey || def.justOne);
@@ -31,13 +36,14 @@ class RepoBuilder {
         return new RepoBuilder(this.currentTableName, {
             ...this.currentPopulations,
             [def.as]: population,
-        }, this.currentSoftDeleteColumn, this.softDeleteRegistry);
+        }, this.currentSoftDeleteColumn, this.softDeleteRegistry, this.currentHooks);
     }
     get init() {
         const tableName = this.currentTableName;
         const populations = this.currentPopulations;
         const softDeleteColumn = this.currentSoftDeleteColumn;
         const softDeleteRegistry = this.softDeleteRegistry;
+        const hooksConfig = this.currentHooks;
         class GeneratedRepository extends BaseRepository {
             static tableName = tableName;
             static populations = populations;
@@ -54,6 +60,27 @@ class RepoBuilder {
             opts() {
                 return {};
             }
+            async beforeCreate(data) {
+                return hooksConfig?.beforeCreate ? hooksConfig.beforeCreate(data) : data;
+            }
+            async beforeUpdate(data, where) {
+                return hooksConfig?.beforeUpdate ? hooksConfig.beforeUpdate(data, where) : data;
+            }
+            async beforeDelete(where) {
+                await hooksConfig?.beforeDelete?.(where);
+            }
+            async afterCreate(row) {
+                await hooksConfig?.afterCreate?.(row);
+                return row;
+            }
+            async afterUpdate(row) {
+                await hooksConfig?.afterUpdate?.(row);
+                return row;
+            }
+            async afterDelete(row) {
+                await hooksConfig?.afterDelete?.(row);
+                return row;
+            }
         }
         return GeneratedRepository;
     }

package/dist/builder.js.map

@@ -1 +1 @@
-{"version":3,"file":"builder.js","sourceRoot":"","sources":["../src/builder.ts"],"names":[],"mappings":"AAEA,OAAO,cAAc,EAAE,EACnB,gBAAgB,GAOnB,MAAM,QAAQ,CAAA;AA+Df,MAAM,WAAW;IAOQ;IACA;IACA;IACA;IAJrB,YACqB,gBAA2B,EAC3B,qBAAkC,EAAiB,EACnD,uBAA0D,EAC1D,kBAA2C;QAH3C,qBAAgB,GAAhB,gBAAgB,CAAW;QAC3B,uBAAkB,GAAlB,kBAAkB,CAAiC;QACnD,4BAAuB,GAAvB,uBAAuB,CAAmC;QAC1D,uBAAkB,GAAlB,kBAAkB,CAAyB;IAC7D,CAAC;IAEJ,UAAU,CAAkD,MAAsB;QAC9E,IAAI,CAAC,kBAAkB,EAAE,GAAG,CAAC,IAAI,CAAC,gBAAgB,EAAE,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;QAEtF,OAAO,IAAI,WAAW,CAClB,IAAI,CAAC,gBAAgB,EACrB,IAAI,CAAC,kBAAkB,EACvB,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,EACvC,IAAI,CAAC,kBAAkB,CAC1B,CAAA;IACL,CAAC;IAED,QAAQ,CAIN,GAAqD;QACnD,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,GAAG,CAAC,OAAO,CAAC,CAAA;QACrD,MAAM,UAAU,GAAG,gBAAgB,CAA2C;YAC1E,KAAK,EAAE,GAAG,CAAC,GAAG;YACd,UAAU,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI;YAClC,QAAQ,EAAE,GAAG,CAAC,QAAQ;YACtB,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACtC,GAAG,CAAC,GAAG,CAAC,UAAU,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,gBAAgB,EAAE,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;gBACxF,0BAA0B,EAAE,IAAI;aACnC,CAAC;YACF,GAAG,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,GAAG,CAAC,iBAAiB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC9E,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACpD,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAC7C,CAAC,CAAA;QAET,OAAO,IAAI,WAAW,CAMlB,IAAI,CAAC,gBAAgB,EACrB;YACI,GAAG,IAAI,CAAC,kBAAkB;YAC1B,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,UAAU;SAC0B,EAClD,IAAI,CAAC,uBAAuB,EAC5B,IAAI,CAAC,kBAAkB,CAC1B,CAAA;IACL,CAAC;IAED,IAAI,IAAI;QACJ,MAAM,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAA;QACvC,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAA;QAC3C,MAAM,gBAAgB,GAAG,IAAI,CAAC,uBAAuB,CAAA;QACrD,MAAM,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,CAAA;QAElD,MAAM,mBAAoB,SAAQ,cAIjC;YACG,MAAM,CAAU,SAAS,GAAG,SAAS,CAAA;YACrC,MAAM,CAAU,WAAW,GAAG,WAAW,CAAA;YAEzC,YAAY,EAAc,EAAE,WAA6B;gBACrD,KAAK,CAAC;oBACF,EAAE;oBACF,WAAW;oBACX,SAAS;oBACT,WAAW;oBACX,gBAAgB,EAAE,gBAAuB;oBACzC,kBAAkB;iBACrB,CAAC,CAAA;YACN,CAAC;YAED,IAAI;gBACA,OAAO,EAAsB,CAAA;YACjC,CAAC;;QAGL,OAAO,mBAAkE,CAAA;IAC7E,CAAC;CACJ;AAED,MAAM,UAAU,iBAAiB;IAC7B,MAAM,kBAAkB,GAA2B,IAAI,GAAG,EAAE,CAAA;IAE5D,OAAO;QACH,KAAK,CACD,SAAoB,EACpB,cAAiD,EAAE;YAEnD,MAAM,mBAAmB,GAAG,kBAAkB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;YAC7D,MAAM,gBAAgB,GAClB,WAAW,CAAC,UAAU,KAAK,KAAK;gBAC5B,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,WAAW,CAAC,UAAU,IAAI,CAAC,OAAO,mBAAmB,KAAK,QAAQ,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;YAE/G,IAAI,WAAW,CAAC,UAAU,KAAK,KAAK,EAAE,CAAC;gBACnC,kBAAkB,CAAC,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;YAC5C,CAAC;iBAAM,IAAI,gBAAgB,EAAE,CAAC;gBAC1B,kBAAkB,CAAC,GAAG,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAA;YACvD,CAAC;YAED,OAAO,IAAI,WAAW,CAClB,SAAS,EACT,EAAsB,EACtB,gBAAuB,EACvB,kBAAkB,CACrB,CAAA;QACL,CAAC;KACJ,CAAA;AACL,CAAC"}
+{"version":3,"file":"builder.js","sourceRoot":"","sources":["../src/builder.ts"],"names":[],"mappings":"AAEA,OAAO,cAAc,EAAE,EACnB,gBAAgB,GAOnB,MAAM,QAAQ,CAAA;AAwEf,MAAM,WAAW;IAOQ;IACA;IACA;IACA;IACA;IALrB,YACqB,gBAA2B,EAC3B,qBAAkC,EAAiB,EACnD,uBAA0D,EAC1D,kBAA2C,EAC3C,YAAgD;QAJhD,qBAAgB,GAAhB,gBAAgB,CAAW;QAC3B,uBAAkB,GAAlB,kBAAkB,CAAiC;QACnD,4BAAuB,GAAvB,uBAAuB,CAAmC;QAC1D,uBAAkB,GAAlB,kBAAkB,CAAyB;QAC3C,iBAAY,GAAZ,YAAY,CAAoC;IAClE,CAAC;IAEJ,UAAU,CAAkD,MAAsB;QAC9E,IAAI,CAAC,kBAAkB,EAAE,GAAG,CAAC,IAAI,CAAC,gBAAgB,EAAE,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;QAEtF,OAAO,IAAI,WAAW,CAClB,IAAI,CAAC,gBAAgB,EACrB,IAAI,CAAC,kBAAkB,EACvB,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,EACvC,IAAI,CAAC,kBAAkB,EACvB,IAAI,CAAC,YAAY,CACpB,CAAA;IACL,CAAC;IAED,KAAK,CAAC,MAAyC;QAC3C,OAAO,IAAI,WAAW,CAClB,IAAI,CAAC,gBAAgB,EACrB,IAAI,CAAC,kBAAkB,EACvB,IAAI,CAAC,uBAAuB,EAC5B,IAAI,CAAC,kBAAkB,EACvB,MAAM,CACT,CAAA;IACL,CAAC;IAED,QAAQ,CAIN,GAAqD;QACnD,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,GAAG,CAAC,OAAO,CAAC,CAAA;QACrD,MAAM,UAAU,GAAG,gBAAgB,CAA2C;YAC1E,KAAK,EAAE,GAAG,CAAC,GAAG;YACd,UAAU,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI;YAClC,QAAQ,EAAE,GAAG,CAAC,QAAQ;YACtB,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACtC,GAAG,CAAC,GAAG,CAAC,UAAU,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,gBAAgB,EAAE,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;gBACxF,0BAA0B,EAAE,IAAI;aACnC,CAAC;YACF,GAAG,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,GAAG,CAAC,iBAAiB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC9E,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACpD,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAC7C,CAAC,CAAA;QAET,OAAO,IAAI,WAAW,CAMlB,IAAI,CAAC,gBAAgB,EACrB;YACI,GAAG,IAAI,CAAC,kBAAkB;YAC1B,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,UAAU;SAC0B,EAClD,IAAI,CAAC,uBAAuB,EAC5B,IAAI,CAAC,kBAAkB,EACvB,IAAI,CAAC,YAAmB,CAC3B,CAAA;IACL,CAAC;IAED,IAAI,IAAI;QACJ,MAAM,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAA;QACvC,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAA;QAC3C,MAAM,gBAAgB,GAAG,IAAI,CAAC,uBAAuB,CAAA;QACrD,MAAM,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,CAAA;QAClD,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,CAAA;QAErC,MAAM,mBAAoB,SAAQ,cAIjC;YACG,MAAM,CAAU,SAAS,GAAG,SAAS,CAAA;YACrC,MAAM,CAAU,WAAW,GAAG,WAAW,CAAA;YAEzC,YAAY,EAAc,EAAE,WAA6B;gBACrD,KAAK,CAAC;oBACF,EAAE;oBACF,WAAW;oBACX,SAAS;oBACT,WAAW;oBACX,gBAAgB,EAAE,gBAAuB;oBACzC,kBAAkB;iBACrB,CAAC,CAAA;YACN,CAAC;YAED,IAAI;gBACA,OAAO,EAAsB,CAAA;YACjC,CAAC;YAES,KAAK,CAAC,YAAY,CAAC,IAAS;gBAClC,OAAO,WAAW,EAAE,YAAY,CAAC,CAAC,CAAC,WAAW,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;YAC5E,CAAC;YAES,KAAK,CAAC,YAAY,CAAC,IAAS,EAAE,KAAU;gBAC9C,OAAO,WAAW,EAAE,YAAY,CAAC,CAAC,CAAC,WAAW,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;YACnF,CAAC;YAES,KAAK,CAAC,YAAY,CAAC,KAAU;gBACnC,MAAM,WAAW,EAAE,YAAY,EAAE,CAAC,KAAK,CAAC,CAAA;YAC5C,CAAC;YAES,KAAK,CAAC,WAAW,CAAC,GAAQ;gBAChC,MAAM,WAAW,EAAE,WAAW,EAAE,CAAC,GAAG,CAAC,CAAA;gBACrC,OAAO,GAAG,CAAA;YACd,CAAC;YAES,KAAK,CAAC,WAAW,CAAC,GAAQ;gBAChC,MAAM,WAAW,EAAE,WAAW,EAAE,CAAC,GAAG,CAAC,CAAA;gBACrC,OAAO,GAAG,CAAA;YACd,CAAC;YAES,KAAK,CAAC,WAAW,CAAC,GAAQ;gBAChC,MAAM,WAAW,EAAE,WAAW,EAAE,CAAC,GAAG,CAAC,CAAA;gBACrC,OAAO,GAAG,CAAA;YACd,CAAC;;QAGL,OAAO,mBAAkE,CAAA;IAC7E,CAAC;CACJ;AAED,MAAM,UAAU,iBAAiB;IAC7B,MAAM,kBAAkB,GAA2B,IAAI,GAAG,EAAE,CAAA;IAE5D,OAAO;QACH,KAAK,CACD,SAAoB,EACpB,cAAiD,EAAE;YAEnD,MAAM,mBAAmB,GAAG,kBAAkB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;YAC7D,MAAM,gBAAgB,GAClB,WAAW,CAAC,UAAU,KAAK,KAAK;gBAC5B,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,WAAW,CAAC,UAAU,IAAI,CAAC,OAAO,mBAAmB,KAAK,QAAQ,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;YAE/G,IAAI,WAAW,CAAC,UAAU,KAAK,KAAK,EAAE,CAAC;gBACnC,kBAAkB,CAAC,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;YAC5C,CAAC;iBAAM,IAAI,gBAAgB,EAAE,CAAC;gBAC1B,kBAAkB,CAAC,GAAG,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAA;YACvD,CAAC;YAED,OAAO,IAAI,WAAW,CAClB,SAAS,EACT,EAAsB,EACtB,gBAAuB,EACvB,kBAAkB,CACrB,CAAA;QACL,CAAC;KACJ,CAAA;AACL,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kysely-repo-kit",
-  "version": "0.2.3",
+  "version": "0.2.5",
   "description": "Typed repository and populate layer for Kysely",
   "type": "module",
   "author": "jesulonimii",