nestjs-drizzle-crud 2.1.0 → 2.1.2

package/README.md

@@ -34,6 +34,7 @@ DrizzleCrudModule.forFeature([{ service: UsersService, table: users }]);
 - [Relations](#relations)
 - [Primary keys (serial / uuid)](#primary-keys-serial--uuid)
 - [Soft delete](#soft-delete)
+- [Timestamps](#timestamps)
 - [Bulk operations](#bulk-operations)
 - [Transactions](#transactions)
 - [Full-text search (PostgreSQL)](#full-text-search-postgresql)
@@ -63,22 +64,32 @@ DrizzleCrudModule.forFeature([{ service: UsersService, table: users }]);
 ## Installation
 
 ```bash
+pnpm add nestjs-drizzle-crud
+# or
 npm install nestjs-drizzle-crud
+# or
+yarn add nestjs-drizzle-crud
 ```
 
 Peer dependencies (install the ones you use):
 
 ```bash
 # always
-npm install @nestjs/common @nestjs/core drizzle-orm reflect-metadata
+pnpm add @nestjs/common @nestjs/core drizzle-orm reflect-metadata
 
 # PostgreSQL (also required if you use `connectionString` with dialect 'postgresql')
-npm install postgres
+pnpm add postgres
 
 # MySQL
-npm install mysql2
+pnpm add mysql2
 ```
 
+> Using npm or yarn? Swap `pnpm add` for `npm install` / `yarn add`.
+
+> **pnpm note:** `postgres`/`mysql2` are optional peer dependencies. pnpm enforces
+> peer deps strictly, so if you build the connection from a `connectionString`
+> make sure the matching driver is installed in your app.
+
 > `postgres` is an **optional** peer dependency. It's only needed when you let the
 > module build the connection from a `connectionString` for the `postgresql` dialect.
 > If you pass a pre-built `db` instead, you don't need it.
@@ -137,13 +148,13 @@ import type { User } from '../db/schema';
 
 export interface CreateUserDto { name: string; email: string }
 export interface UpdateUserDto { name?: string; email?: string }
-export interface UserFilters { name?: string; email?: string }
+export interface UserFilterDto { name?: string; email?: string }
 
 export class UsersService extends SqlBaseCrudService<
   User,
   CreateUserDto,
   UpdateUserDto,
-  UserFilters
+  UserFilterDto
 > {}
 ```
 
@@ -289,7 +300,7 @@ Add custom behaviour by overriding hooks (see [Lifecycle hooks](#lifecycle-hooks
 or add your own methods:
 
 ```typescript
-export class UsersService extends SqlBaseCrudService<User, CreateUserDto, UpdateUserDto, UserFilters> {
+export class UsersService extends SqlBaseCrudService<User, CreateUserDto, UpdateUserDto, UserFilterDto> {
   findByEmail(email: string) {
     return this.findOne({ email } as Partial<User>);
   }
@@ -510,6 +521,50 @@ Enable per-project via `defaults.softDelete` or per-entity via `forFeature` conf
 
 ---
 
+## Timestamps
+
+There are two ways to manage `created_at` / `updated_at`.
+
+### Package-managed (convenient)
+
+Enable `defaults.timestamps` (or per-entity `timestamps`). On `create()` the
+service stamps both columns; on `update()`/`softDelete()` it stamps `updated_at`:
+
+```typescript
+DrizzleCrudModule.forRoot({
+  dialect: 'postgresql',
+  connectionString: process.env.DATABASE_URL,
+  schema,
+  defaults: { timestamps: true }, // uses columns created_at / updated_at
+});
+```
+
+> Caveat: this uses the **application** clock and only applies to writes that go
+> **through the package** — raw SQL, migrations or other code paths won't set
+> the values.
+
+### Schema/DB-managed (recommended)
+
+For authoritative timestamps (database time, every write path), define them in
+your Drizzle schema and **leave the package's `timestamps` disabled**:
+
+```typescript
+import { timestamp } from 'drizzle-orm/pg-core';
+
+created_at: timestamp('created_at', { withTimezone: true }).defaultNow().notNull(),
+updated_at: timestamp('updated_at', { withTimezone: true })
+  .defaultNow()
+  .notNull()
+  .$onUpdate(() => new Date()),
+```
+
+`defaultNow()` lets the database set `created_at` on insert; `$onUpdate()` makes
+Drizzle bump `updated_at` on every update (including the package's own
+`update()`). For `updated_at` that's authoritative even for raw SQL, add a
+Postgres trigger / MySQL `ON UPDATE CURRENT_TIMESTAMP`.
+
+---
+
 ## Bulk operations
 
 ```typescript
@@ -608,7 +663,7 @@ Concise, accurate facts for code generation. Prefer these over guessing.
 
 **A service is an empty subclass — do NOT inject the db or pass `dialect`/`db`:**
 ```typescript
-export class XService extends SqlBaseCrudService<X, CreateXDto, UpdateXDto, XFilters> {}
+export class XService extends SqlBaseCrudService<X, CreateXDto, UpdateXDto, XFilterDto> {}
 ```
 
 **Rules / gotchas:**

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "nestjs-drizzle-crud",
-	"version": "2.1.0",
+	"version": "2.1.2",
 	"description": "A complete CRUD abstraction layer for Drizzle ORM in NestJS applications",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",