Skip to content

Commit 3d9f7bb

Browse files
chore: rename package to @mizzle-dev/orm (#16)
1 parent fd2527b commit 3d9f7bb

10 files changed

Lines changed: 47 additions & 48 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Mizzle ORM
22

3-
> MongoDB ORM with Drizzle-inspired DX and Convex-like ergonomics
3+
> A MongoDB ORM with exceptional developer experience, built for TypeScript.
44
5-
[![npm version](https://img.shields.io/npm/v/mizzle-orm.svg)](https://www.npmjs.com/package/mizzle-orm)
5+
[![npm version](https://img.shields.io/npm/v/@mizzle-dev/orm.svg)](https://www.npmjs.com/package/@mizzle-dev/orm)
66
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
77

88
Mizzle brings modern TypeScript DX to MongoDB with a clean, type-safe API inspired by Drizzle ORM, Convex and oRPC.
@@ -21,13 +21,13 @@ Mizzle brings modern TypeScript DX to MongoDB with a clean, type-safe API inspir
2121
## Quick Start
2222

2323
```bash
24-
npm install mizzle-orm mongodb
24+
npm install @mizzle-dev/orm mongodb
2525
# or
26-
pnpm add mizzle-orm mongodb
26+
pnpm add @mizzle-dev/orm mongodb
2727
```
2828

2929
```typescript
30-
import { mizzle, defineSchema, mongoCollection, objectId, publicId, string, date } from 'mizzle-orm';
30+
import { mizzle, defineSchema, mongoCollection, objectId, publicId, string, date } from '@mizzle-dev/orm';
3131

3232
// Define your schema
3333
const users = mongoCollection(
@@ -88,7 +88,7 @@ await db().users.deleteById(alice.id);
8888
### Type-Safe Schema Definition
8989

9090
```typescript
91-
import { objectId, publicId, string, date, array } from 'mizzle-orm';
91+
import { objectId, publicId, string, date, array } from '@mizzle-dev/orm';
9292

9393
const users = mongoCollection('users', {
9494
_id: objectId().internalId(),

packages/mizzle-orm/README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
A MongoDB ORM with exceptional developer experience, built for TypeScript.
44

5-
[![npm version](https://img.shields.io/npm/v/mizzle-orm.svg)](https://www.npmjs.com/package/mizzle-orm)
5+
[![npm version](https://img.shields.io/npm/v/@mizzle-dev/orm.svg)](https://www.npmjs.com/package/@mizzle-dev/orm)
66
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
77

88
## Features
@@ -18,21 +18,21 @@ A MongoDB ORM with exceptional developer experience, built for TypeScript.
1818
## Installation
1919

2020
```bash
21-
npm install mizzle-orm mongodb
21+
npm install @mizzle-dev/orm mongodb
2222
# or
23-
pnpm add mizzle-orm mongodb
23+
pnpm add @mizzle-dev/orm mongodb
2424
# or
25-
yarn add mizzle-orm mongodb
25+
yarn add @mizzle-dev/orm mongodb
2626
```
2727

2828
**Requirements:** Node.js 18+ and MongoDB 5.0+
2929

3030
## Quick Start
3131

3232
```typescript
33-
import { mizzle, defineSchema, mongoCollection } from 'mizzle-orm';
34-
import { string, objectId, date } from 'mizzle-orm';
35-
import { lookup } from 'mizzle-orm';
33+
import { mizzle, defineSchema, mongoCollection } from '@mizzle-dev/orm';
34+
import { string, objectId, date } from '@mizzle-dev/orm';
35+
import { lookup } from '@mizzle-dev/orm';
3636

3737
// Define collections
3838
const users = mongoCollection('users', {
@@ -107,7 +107,7 @@ Mizzle supports three relation strategies:
107107
Denormalize data for lightning-fast reads with optional auto-updates:
108108

109109
```typescript
110-
import { embed } from 'mizzle-orm';
110+
import { embed } from '@mizzle-dev/orm';
111111

112112
const posts = mongoCollection('posts', {
113113
title: string(),
@@ -144,7 +144,7 @@ console.log(post.author.name); // Direct access, no join needed
144144
Query-time joins using MongoDB `$lookup`:
145145

146146
```typescript
147-
import { lookup } from 'mizzle-orm';
147+
import { lookup } from '@mizzle-dev/orm';
148148

149149
author: lookup(users, {
150150
localField: 'authorId',
@@ -163,7 +163,7 @@ author: lookup(users, {
163163
Validate referential integrity:
164164

165165
```typescript
166-
import { reference } from 'mizzle-orm';
166+
import { reference } from '@mizzle-dev/orm';
167167

168168
author: reference(users, {
169169
localField: 'authorId',
@@ -361,7 +361,7 @@ MIT © [Mizzle Dev](https://github.com/mizzle-dev)
361361
- [Documentation](https://orm.mizzle.dev)
362362
- [GitHub Repository](https://github.com/mizzle-dev/mizzle-orm)
363363
- [Issue Tracker](https://github.com/mizzle-dev/mizzle-orm/issues)
364-
- [NPM Package](https://www.npmjs.com/package/mizzle-orm)
364+
- [NPM Package](https://www.npmjs.com/package/@mizzle-dev/orm)
365365

366366
---
367367

packages/mizzle-orm/docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ Welcome to the Mizzle ORM documentation! This guide will help you understand and
2828
### Basic Embed Example
2929

3030
```typescript
31-
import { mizzle, defineSchema, mongoCollection, embed } from 'mizzle-orm';
32-
import { string, objectId } from 'mizzle-orm';
31+
import { mizzle, defineSchema, mongoCollection, embed } from '@mizzle-dev/orm';
32+
import { string, objectId } from '@mizzle-dev/orm';
3333

3434
const users = mongoCollection('users', {
3535
_id: objectId().internalId(),

packages/mizzle-orm/docs/embeds-guide.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,8 @@ const workflows = mongoCollection('workflows', {
102102
### Basic Forward Embed
103103

104104
```typescript
105-
import { mongoCollection, embed } from 'mizzle-orm';
106-
import { string, objectId } from 'mizzle-orm/fields';
105+
import { mongoCollection, embed } from '@mizzle-dev/orm';
106+
import { string, objectId } from '@mizzle-dev/orm/fields';
107107

108108
// Source collection
109109
const authors = mongoCollection('authors', {
@@ -741,4 +741,3 @@ Use embeds with `keepFresh: true` for fast reads with automatic updates!
741741
**Next Steps:**
742742
- Check out [examples/](../examples/) for real-world use cases
743743
- Read the [API Reference](./api-reference.md)
744-
- Join our [Discord](https://discord.gg/mizzle) for help

packages/mizzle-orm/docs/embeds.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Embeds are ideal when:
3939
### Simple Embed Example
4040

4141
```typescript
42-
import { mizzle, defineSchema, mongoCollection, string, objectId, embed } from 'mizzle-orm';
42+
import { mizzle, defineSchema, mongoCollection, string, objectId, embed } from '@mizzle-dev/orm';
4343

4444
// Source collection
4545
const users = mongoCollection('users', {
@@ -167,7 +167,7 @@ const posts = mongoCollection(
167167
Embeds multiple documents from an array of IDs.
168168

169169
```typescript
170-
import { array } from 'mizzle-orm/schema';
170+
import { array } from '@mizzle-dev/orm/schema';
171171

172172
const tags = mongoCollection('tags', {
173173
_id: objectId().internalId(),
@@ -229,7 +229,7 @@ console.log(post.tags);
229229
Merges embedded data into an existing object (no separate field).
230230

231231
```typescript
232-
import { object } from 'mizzle-orm/schema';
232+
import { object } from '@mizzle-dev/orm/schema';
233233

234234
const directories = mongoCollection('directories', {
235235
_id: objectId().internalId(),
@@ -301,7 +301,7 @@ Use `embedIdField` to embed non-`_id` fields like public IDs.
301301
### Example: Public ID Embeds
302302

303303
```typescript
304-
import { publicId } from 'mizzle-orm/schema';
304+
import { publicId } from '@mizzle-dev/orm/schema';
305305

306306
const users = mongoCollection('users', {
307307
id: publicId('usr'), // Public ID like "usr_abc123"

packages/mizzle-orm/docs/lookup-to-embed-migration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ const posts = mongoCollection('posts', {
7171
Use the Refresh API to populate embeds in all existing documents.
7272

7373
```typescript
74-
import { mizzle, defineSchema } from 'mizzle-orm';
74+
import { mizzle, defineSchema } from '@mizzle-dev/orm';
7575

7676
const schema = defineSchema({ users, posts });
7777
const db = await mizzle({

packages/mizzle-orm/docs/middleware.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Mizzle ORM's middleware system allows you to intercept and modify database opera
1818
Apply middleware to all collections:
1919

2020
```typescript
21-
import { mizzle, loggingMiddleware, performanceMiddleware } from 'mizzle-orm';
21+
import { mizzle, loggingMiddleware, performanceMiddleware } from '@mizzle-dev/orm';
2222

2323
const db = await mizzle({
2424
uri: process.env.MONGO_URI!,
@@ -36,7 +36,7 @@ const db = await mizzle({
3636
Apply middleware to specific collections:
3737

3838
```typescript
39-
import { mongoCollection, auditMiddleware } from 'mizzle-orm';
39+
import { mongoCollection, auditMiddleware } from '@mizzle-dev/orm';
4040

4141
const users = mongoCollection(
4242
'users',
@@ -62,7 +62,7 @@ A middleware is a function that receives:
6262
2. **Next** (`() => Promise<TResult>`) - Function to call the next middleware or operation
6363

6464
```typescript
65-
import type { Middleware } from 'mizzle-orm';
65+
import type { Middleware } from '@mizzle-dev/orm';
6666

6767
const myMiddleware: Middleware = async (ctx, next) => {
6868
// Before operation
@@ -142,7 +142,7 @@ await db().users.create({...});
142142
Log all database operations:
143143

144144
```typescript
145-
import { loggingMiddleware } from 'mizzle-orm';
145+
import { loggingMiddleware } from '@mizzle-dev/orm';
146146

147147
loggingMiddleware({
148148
level: 'info', // 'debug' | 'info' | 'warn' | 'error'
@@ -163,7 +163,7 @@ loggingMiddleware({
163163
Track query execution times and detect slow queries:
164164

165165
```typescript
166-
import { performanceMiddleware } from 'mizzle-orm';
166+
import { performanceMiddleware } from '@mizzle-dev/orm';
167167

168168
performanceMiddleware({
169169
slowQueryThreshold: 1000, // Warn if query takes > 1000ms
@@ -183,7 +183,7 @@ performanceMiddleware({
183183
Cache read operations to reduce database load:
184184

185185
```typescript
186-
import { cachingMiddleware, MemoryCacheStore } from 'mizzle-orm';
186+
import { cachingMiddleware, MemoryCacheStore } from '@mizzle-dev/orm';
187187
import Redis from 'ioredis';
188188

189189
// Option 1: In-memory cache
@@ -219,7 +219,7 @@ cachingMiddleware({
219219
Log all write operations for compliance:
220220

221221
```typescript
222-
import { auditMiddleware } from 'mizzle-orm';
222+
import { auditMiddleware } from '@mizzle-dev/orm';
223223

224224
auditMiddleware({
225225
store: {
@@ -250,7 +250,7 @@ auditMiddleware({
250250
Automatically retry failed operations:
251251

252252
```typescript
253-
import { retryMiddleware } from 'mizzle-orm';
253+
import { retryMiddleware } from '@mizzle-dev/orm';
254254

255255
retryMiddleware({
256256
maxRetries: 3,
@@ -273,7 +273,7 @@ retryMiddleware({
273273
Validate data before write operations:
274274

275275
```typescript
276-
import { validationMiddleware, ValidationError } from 'mizzle-orm';
276+
import { validationMiddleware, ValidationError } from '@mizzle-dev/orm';
277277
import { z } from 'zod';
278278

279279
const userSchema = z.object({
@@ -313,7 +313,7 @@ try {
313313
Combine multiple middlewares into one:
314314

315315
```typescript
316-
import { compose, loggingMiddleware, performanceMiddleware } from 'mizzle-orm';
316+
import { compose, loggingMiddleware, performanceMiddleware } from '@mizzle-dev/orm';
317317

318318
const observability = compose(
319319
loggingMiddleware({ level: 'info' }),
@@ -331,7 +331,7 @@ const db = await mizzle({
331331
Conditionally apply middleware:
332332

333333
```typescript
334-
import { when } from 'mizzle-orm';
334+
import { when } from '@mizzle-dev/orm';
335335

336336
const cacheInProduction = when(
337337
(ctx) => process.env.NODE_ENV === 'production',
@@ -344,7 +344,7 @@ const cacheInProduction = when(
344344
Apply middleware to specific operations:
345345

346346
```typescript
347-
import { onOperations, auditMiddleware } from 'mizzle-orm';
347+
import { onOperations, auditMiddleware } from '@mizzle-dev/orm';
348348

349349
const auditWrites = onOperations(
350350
['create', 'update', 'updateById', 'delete', 'deleteById'],
@@ -357,7 +357,7 @@ const auditWrites = onOperations(
357357
Apply middleware to read or write operations:
358358

359359
```typescript
360-
import { onReads, onWrites, cachingMiddleware, auditMiddleware } from 'mizzle-orm';
360+
import { onReads, onWrites, cachingMiddleware, auditMiddleware } from '@mizzle-dev/orm';
361361

362362
const db = await mizzle({
363363
middlewares: [
@@ -373,7 +373,7 @@ const db = await mizzle({
373373
Apply middleware to specific collections:
374374

375375
```typescript
376-
import { onCollections, auditMiddleware } from 'mizzle-orm';
376+
import { onCollections, auditMiddleware } from '@mizzle-dev/orm';
377377

378378
const auditSensitiveCollections = onCollections(
379379
['users', 'payments', 'auth_tokens'],
@@ -386,7 +386,7 @@ const auditSensitiveCollections = onCollections(
386386
### Basic Custom Middleware
387387

388388
```typescript
389-
import type { Middleware } from 'mizzle-orm';
389+
import type { Middleware } from '@mizzle-dev/orm';
390390

391391
const requestIdMiddleware: Middleware = async (ctx, next) => {
392392
// Add request ID to context if not present
@@ -543,7 +543,7 @@ const queryRewritingMiddleware: Middleware = async (ctx, next) => {
543543
import { trace, context } from '@opentelemetry/api';
544544

545545
const tracingMiddleware: Middleware = async (ctx, next) => {
546-
const tracer = trace.getTracer('mizzle-orm');
546+
const tracer = trace.getTracer('@mizzle-dev/orm');
547547

548548
return tracer.startActiveSpan(
549549
`${ctx.collection}.${ctx.operation}`,
@@ -668,7 +668,7 @@ const myMiddleware: Middleware = async (ctx, next) => {
668668

669669
```typescript
670670
import { describe, it, expect } from 'vitest';
671-
import type { Middleware, MiddlewareContext } from 'mizzle-orm';
671+
import type { Middleware, MiddlewareContext } from '@mizzle-dev/orm';
672672

673673
describe('myMiddleware', () => {
674674
it('should execute correctly', async () => {

packages/mizzle-orm/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"name": "mizzle-orm",
3-
"version": "0.0.0",
2+
"name": "@mizzle-dev/orm",
3+
"version": "0.0.1",
44
"description": "Mizzle ORM - MongoDB ORM with exceptional DX",
55
"type": "module",
66
"main": "./dist/index.js",

packages/mizzle-orm/src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* Mizzle ORM - MongoDB ORM with exceptional DX
3-
* @module mizzle-orm
3+
* @module @mizzle-dev/orm
44
*/
55

66
// Core exports

packages/mizzle-orm/src/types/collection.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -376,7 +376,7 @@ export interface CollectionOptions<
376376
> {
377377
indexes?: IndexDefinitionFn<TSchema>;
378378
searchIndexes?: any; // TODO: Atlas Search index definitions
379-
relations?: TRels; // Now accepts relation object directly (import { lookup, reference, embed } from 'mizzle-orm')
379+
relations?: TRels;
380380
policies?: PolicyConfig<TSchema>;
381381
audit?: CollectionAuditConfig;
382382
hooks?: Hooks<TSchema>;

0 commit comments

Comments
 (0)