mizzleORM

A lightweight, type-safe ODM for MongoDB in TypeScript — inspired by Drizzle ORM and built for developers who value simplicity, transparency, and strong typings.

Note: MizzleORM requires MongoDB 4.2 or newer and works best with the latest stable MongoDB server (6.x or newer) and the official mongodb Node.js driver (v6+).

✨ Features

• Schema-first: Define and validate collections using Zod.
• Type-safe operations: Auto-complete and strict typings for insert, find, update, and delete.
• Minimal & modular: No decorators or magic. Just clean, composable APIs.
• Developer-friendly DX: Great TypeScript support and IDE integration.
• Built on MongoDB native driver: Zero overhead with full control.

---

📦 Installation

npm install mizzleorm mongodb zod
# or
yarn add mizzleorm mongodb zod

If you need to upgrade your local MongoDB server, see: https://www.mongodb.com/docs/manual/administration/install-community/

---

🚀 Quick Start

1. Define a schema

// src/schemas/user.ts
import { z } from 'zod';
import { defineModel } from 'mizzleorm';

export const userSchema = defineModel(z.object({
  name: z.string(),
  email: z.string().email(),
  age: z.number().int().positive().optional(),
  createdAt: z.date().default(() => new Date()),
}));

export type User = z.infer<typeof userSchema>;

---

2. Initialize connection and model

// src/index.ts
import { connect, disconnect, MongoModel, InferModel, InsertType } from 'mizzleorm';
import { userSchema } from './schemas/user';
import { ObjectId } from 'mongodb'; // v6+ driver recommended

type User = InferModel<typeof userSchema>;
type UserInsert = InsertType<typeof userSchema>;

async function main() {
  // Use the latest connection string format and options
  await connect('mongodb://localhost:27017', 'your_database_name');
  const UserModel = new MongoModel('users', userSchema);

  // Your operations go here

  await disconnect();
}

main().catch(console.error);

---

3. Perform operations

// Insert one
const newUser: UserInsert = {
  name: 'John Doe',
  email: 'john.doe@example.com',
  age: 30,
};
const insertResult = await UserModel.insertOne(newUser);

// Find many
const users = await UserModel.find({ name: 'John Doe' });

// Find one
const found = await UserModel.findOne({ _id: new ObjectId(insertResult.insertedId) }); // ObjectId from mongodb v6+

// Update
await UserModel.update({ name: 'John Doe' }, { age: 31 });

// Delete
await UserModel.delete({ name: 'John Doe' });

// Insert many
await UserModel.insertMany([
  { name: 'Alice', email: 'alice@example.com', age: 25 },
  { name: 'Bob', email: 'bob@example.com' },
]);

// Find by ID
await UserModel.findById(insertResult.insertedId);

// Update one
await UserModel.updateOne({ name: 'Alice' }, { age: 26 });

// Replace one
await UserModel.replaceOne({ name: 'Bob' }, {
  name: 'Bob',
  email: 'bob@newmail.com',
  age: 22,
});

// Delete one
await UserModel.deleteOne({ name: 'Alice' });

// Count
const count = await UserModel.count({ age: { $gte: 18 } });

// Aggregation
const aggregation = await UserModel.aggregate([
  { $match: { age: { $gte: 18 } } },
  { $group: { _id: null, avgAge: { $avg: '$age' } } },
]);

// Paginated query
const paginated = await UserModel.findPaginated(
  { age: { $gte: 18 } },
  { skip: 0, limit: 10, sort: { age: -1 } }
);

---

🧠 Project Structure

mizzleorm/
├── src/
│   ├── schema.ts         # Schema definition utility
│   ├── model.ts          # MongoModel wrapper
│   ├── client.ts         # MongoDB client connection
│   └── index.ts          # Public API exports
├── examples/             # Example usage files
│   └── user.ts
├── tests/                # Unit and integration tests
├── package.json
├── tsconfig.json
└── README.md

---

🛠 Development

Build the library:

npm run build

Run the example:

npm run example

---

📄 License

MIT — use it freely and contribute back if you'd like!

---