@classytic/mongokit 1.0.0 → 1.0.2

package/README.md

@@ -19,13 +19,17 @@
 ## 📦 Installation
 
 ```bash
-npm install @classytic/mongokit mongoose
+npm install @classytic/mongokit mongoose mongoose-paginate-v2 mongoose-aggregate-paginate-v2
 ```
 
-> **Peer Dependency:** Requires `mongoose ^8.0.0`
+> **Peer Dependencies:**
+> - `mongoose ^8.0.0 || ^9.0.0` (supports both Mongoose 8 and 9)
+> - `mongoose-paginate-v2 ^1.9.0` (for pagination support)
+> - `mongoose-aggregate-paginate-v2 ^1.1.0` (for aggregation pagination)
 
 ---
 
+
 ## 🚀 Quick Start
 
 ### Basic Usage

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@classytic/mongokit",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Event-driven MongoDB repositories for any Node.js framework",
   "type": "module",
   "main": "./src/index.js",
@@ -52,7 +52,9 @@
   },
   "homepage": "https://github.com/classytic/mongokit#readme",
   "peerDependencies": {
-    "mongoose": "^8.0.0"
+    "mongoose": "^8.0.0 || ^9.0.0",
+    "mongoose-paginate-v2": "^1.9.0",
+    "mongoose-aggregate-paginate-v2": "^1.1.0"
   },
   "dependencies": {
     "http-errors": "^2.0.0"
@@ -62,10 +64,12 @@
   },
   "scripts": {
     "test": "node --test test/*.test.js",
-    "test:watch": "node --test --watch test/*.test.js"
+    "test:watch": "node --test --watch test/*.test.js",
+    "publish:npm": "npm publish --access public"
   },
   "devDependencies": {
-    "mongoose-paginate-v2": "^1.9.0"
+    "mongoose": "^9.0.0-rc1",
+    "mongoose-paginate-v2": "^1.9.0",
+    "mongoose-aggregate-paginate-v2": "^1.1.0"
   }
 }
-

package/src/actions/create.js

@@ -44,15 +44,16 @@ export async function createDefault(Model, overrides = {}, options = {}) {
  * Upsert (create or update)
  */
 export async function upsert(Model, query, data, options = {}) {
-  return Model.findOneAndUpdate(
-    query,
-    { $setOnInsert: data },
-    {
-      upsert: true,
-      new: true,
-      runValidators: true,
-      session: options.session,
-    }
-  );
-}
+  return Model.findOneAndUpdate(
+    query,
+    { $setOnInsert: data },
+    {
+      upsert: true,
+      new: true,
+      runValidators: true,
+      session: options.session,
+      ...(options.updatePipeline !== undefined ? { updatePipeline: options.updatePipeline } : {}),
+    }
+  );
+}
 

package/src/actions/read.js

@@ -81,17 +81,18 @@ export async function getAll(Model, queryParams, options = {}) {
  * Get or create
  */
 export async function getOrCreate(Model, query, createData, options = {}) {
-  return Model.findOneAndUpdate(
-    query,
-    { $setOnInsert: createData },
-    {
-      upsert: true,
-      new: true,
-      runValidators: true,
-      session: options.session,
-    }
-  );
-}
+  return Model.findOneAndUpdate(
+    query,
+    { $setOnInsert: createData },
+    {
+      upsert: true,
+      new: true,
+      runValidators: true,
+      session: options.session,
+      ...(options.updatePipeline !== undefined ? { updatePipeline: options.updatePipeline } : {}),
+    }
+  );
+}
 
 /**
  * Count documents

package/src/actions/update.js

@@ -8,15 +8,16 @@ import createError from 'http-errors';
 /**
  * Update by ID
  */
-export async function update(Model, id, data, options = {}) {
-  const document = await Model.findByIdAndUpdate(id, data, {
-    new: true,
-    runValidators: true,
-    session: options.session,
-  })
-    .select(options.select)
-    .populate(parsePopulate(options.populate))
-    .lean(options.lean);
+export async function update(Model, id, data, options = {}) {
+  const document = await Model.findByIdAndUpdate(id, data, {
+    new: true,
+    runValidators: true,
+    session: options.session,
+    ...(options.updatePipeline !== undefined ? { updatePipeline: options.updatePipeline } : {}),
+  })
+    .select(options.select)
+    .populate(parsePopulate(options.populate))
+    .lean(options.lean);
 
   if (!document) {
     throw createError(404, 'Document not found');
@@ -32,14 +33,15 @@ export async function update(Model, id, data, options = {}) {
 export async function updateWithConstraints(Model, id, data, constraints = {}, options = {}) {
   const query = { _id: id, ...constraints };
 
-  const document = await Model.findOneAndUpdate(query, data, {
-    new: true,
-    runValidators: true,
-    session: options.session,
-  })
-    .select(options.select)
-    .populate(parsePopulate(options.populate))
-    .lean(options.lean);
+  const document = await Model.findOneAndUpdate(query, data, {
+    new: true,
+    runValidators: true,
+    session: options.session,
+    ...(options.updatePipeline !== undefined ? { updatePipeline: options.updatePipeline } : {}),
+  })
+    .select(options.select)
+    .populate(parsePopulate(options.populate))
+    .lean(options.lean);
 
   return document;
 }
@@ -106,10 +108,11 @@ export async function updateWithValidation(
  * Update many documents
  */
 export async function updateMany(Model, query, data, options = {}) {
-  const result = await Model.updateMany(query, data, {
-    runValidators: true,
-    session: options.session,
-  });
+  const result = await Model.updateMany(query, data, {
+    runValidators: true,
+    session: options.session,
+    ...(options.updatePipeline !== undefined ? { updatePipeline: options.updatePipeline } : {}),
+  });
 
   return {
     matchedCount: result.matchedCount,
@@ -121,13 +124,14 @@ export async function updateMany(Model, query, data, options = {}) {
  * Update by query
  */
 export async function updateByQuery(Model, query, data, options = {}) {
-  const document = await Model.findOneAndUpdate(query, data, {
-    new: true,
-    runValidators: true,
-    session: options.session,
-  })
-    .select(options.select)
-    .populate(parsePopulate(options.populate))
+  const document = await Model.findOneAndUpdate(query, data, {
+    new: true,
+    runValidators: true,
+    session: options.session,
+    ...(options.updatePipeline !== undefined ? { updatePipeline: options.updatePipeline } : {}),
+  })
+    .select(options.select)
+    .populate(parsePopulate(options.populate))
     .lean(options.lean);
 
   if (!document && options.throwOnNotFound !== false) {

package/types/actions/index.d.ts

@@ -1,9 +1,17 @@
-import { Model, Document, FilterQuery, UpdateQuery, ClientSession } from 'mongoose';
-
-export interface ActionOptions {
-  session?: ClientSession;
-  [key: string]: any;
-}
+import { Model, Document, UpdateQuery, ClientSession } from 'mongoose';
+
+// Compatibility alias: QueryFilter was introduced in Mongoose 9 and replaces FilterQuery.
+// @ts-ignore - QueryFilter only exists in mongoose >= 9
+type QueryFilterV9<T> = import('mongoose').QueryFilter<T>;
+// @ts-ignore - FilterQuery was removed in mongoose >= 9
+type QueryFilterV8<T> = import('mongoose').FilterQuery<T>;
+type CompatibleQueryFilter<T> = QueryFilterV9<T> | QueryFilterV8<T>;
+
+export interface ActionOptions {
+  session?: ClientSession;
+  updatePipeline?: boolean;
+  [key: string]: any;
+}
 
 // Create actions
 export function create<T extends Document>(
@@ -24,12 +32,12 @@ export function createDefault<T extends Document>(
   options?: ActionOptions
 ): Promise<T>;
 
-export function upsert<T extends Document>(
-  Model: Model<T>,
-  query: FilterQuery<T>,
-  data: Partial<T>,
-  options?: ActionOptions
-): Promise<T>;
+export function upsert<T extends Document>(
+  Model: Model<T>,
+  query: CompatibleQueryFilter<T>,
+  data: Partial<T>,
+  options?: ActionOptions
+): Promise<T>;
 
 // Read actions
 export function getById<T extends Document>(
@@ -38,30 +46,30 @@ export function getById<T extends Document>(
   options?: ActionOptions
 ): Promise<T | null>;
 
-export function getByQuery<T extends Document>(
-  Model: Model<T>,
-  query: FilterQuery<T>,
-  options?: ActionOptions
-): Promise<T | null>;
-
-export function getOrCreate<T extends Document>(
-  Model: Model<T>,
-  query: FilterQuery<T>,
-  createData: Partial<T>,
-  options?: ActionOptions
-): Promise<T>;
-
-export function count<T extends Document>(
-  Model: Model<T>,
-  query?: FilterQuery<T>,
-  options?: ActionOptions
-): Promise<number>;
-
-export function exists<T extends Document>(
-  Model: Model<T>,
-  query: FilterQuery<T>,
-  options?: ActionOptions
-): Promise<boolean>;
+export function getByQuery<T extends Document>(
+  Model: Model<T>,
+  query: CompatibleQueryFilter<T>,
+  options?: ActionOptions
+): Promise<T | null>;
+
+export function getOrCreate<T extends Document>(
+  Model: Model<T>,
+  query: CompatibleQueryFilter<T>,
+  createData: Partial<T>,
+  options?: ActionOptions
+): Promise<T>;
+
+export function count<T extends Document>(
+  Model: Model<T>,
+  query?: CompatibleQueryFilter<T>,
+  options?: ActionOptions
+): Promise<number>;
+
+export function exists<T extends Document>(
+  Model: Model<T>,
+  query: CompatibleQueryFilter<T>,
+  options?: ActionOptions
+): Promise<boolean>;
 
 // Update actions
 export function update<T extends Document>(
@@ -71,12 +79,12 @@ export function update<T extends Document>(
   options?: ActionOptions
 ): Promise<T | null>;
 
-export function updateMany<T extends Document>(
-  Model: Model<T>,
-  query: FilterQuery<T>,
-  data: UpdateQuery<T>,
-  options?: ActionOptions
-): Promise<any>;
+export function updateMany<T extends Document>(
+  Model: Model<T>,
+  query: CompatibleQueryFilter<T>,
+  data: UpdateQuery<T>,
+  options?: ActionOptions
+): Promise<any>;
 
 // Delete actions
 export function deleteById<T extends Document>(
@@ -85,11 +93,11 @@ export function deleteById<T extends Document>(
   options?: ActionOptions
 ): Promise<T | null>;
 
-export function deleteMany<T extends Document>(
-  Model: Model<T>,
-  query: FilterQuery<T>,
-  options?: ActionOptions
-): Promise<any>;
+export function deleteMany<T extends Document>(
+  Model: Model<T>,
+  query: CompatibleQueryFilter<T>,
+  options?: ActionOptions
+): Promise<any>;
 
 // Aggregate actions
 export function aggregate<T extends Document>(
@@ -104,10 +112,10 @@ export function aggregatePaginate<T extends Document>(
   options?: ActionOptions
 ): Promise<any>;
 
-export function distinct<T extends Document>(
-  Model: Model<T>,
-  field: string,
-  query?: FilterQuery<T>,
-  options?: ActionOptions
-): Promise<any[]>;
+export function distinct<T extends Document>(
+  Model: Model<T>,
+  field: string,
+  query?: CompatibleQueryFilter<T>,
+  options?: ActionOptions
+): Promise<any[]>;
 

package/types/index.d.ts

@@ -1,12 +1,20 @@
-import { Model, Document, ClientSession, PaginateOptions, PaginateResult, FilterQuery, UpdateQuery, AggregateOptions } from 'mongoose';
-
-export interface RepositoryOptions {
-  session?: ClientSession;
-  populate?: string | string[] | any;
-  select?: string | any;
-  lean?: boolean;
-  throwOnNotFound?: boolean;
-}
+import { Model, Document, ClientSession, PaginateOptions, PaginateResult, UpdateQuery, AggregateOptions } from 'mongoose';
+
+// Compatibility alias: QueryFilter was introduced in Mongoose 9 and replaces FilterQuery.
+// @ts-ignore - QueryFilter only exists in mongoose >= 9
+type QueryFilterV9<T> = import('mongoose').QueryFilter<T>;
+// @ts-ignore - FilterQuery was removed in mongoose >= 9
+type QueryFilterV8<T> = import('mongoose').FilterQuery<T>;
+type CompatibleQueryFilter<T> = QueryFilterV9<T> | QueryFilterV8<T>;
+
+export interface RepositoryOptions {
+  session?: ClientSession;
+  populate?: string | string[] | any;
+  select?: string | any;
+  lean?: boolean;
+  throwOnNotFound?: boolean;
+  updatePipeline?: boolean;
+}
 
 export interface QueryParams {
   pagination?: {
@@ -55,23 +63,23 @@ export class Repository<T extends Document> {
 
   // CRUD operations
   create(data: Partial<T>, options?: RepositoryOptions): Promise<T>;
-  createMany(dataArray: Partial<T>[], options?: RepositoryOptions): Promise<T[]>;
-  
-  getById(id: string, options?: RepositoryOptions): Promise<T | null>;
-  getByQuery(query: FilterQuery<T>, options?: RepositoryOptions): Promise<T | null>;
-  getAll(queryParams?: QueryParams, options?: RepositoryOptions): Promise<PaginateResult<T>>;
-  getOrCreate(query: FilterQuery<T>, createData: Partial<T>, options?: RepositoryOptions): Promise<T>;
-  
-  count(query?: FilterQuery<T>, options?: RepositoryOptions): Promise<number>;
-  exists(query: FilterQuery<T>, options?: RepositoryOptions): Promise<boolean>;
-  
-  update(id: string, data: UpdateQuery<T>, options?: RepositoryOptions): Promise<T | null>;
+  createMany(dataArray: Partial<T>[], options?: RepositoryOptions): Promise<T[]>;
+  
+  getById(id: string, options?: RepositoryOptions): Promise<T | null>;
+  getByQuery(query: CompatibleQueryFilter<T>, options?: RepositoryOptions): Promise<T | null>;
+  getAll(queryParams?: QueryParams, options?: RepositoryOptions): Promise<PaginateResult<T>>;
+  getOrCreate(query: CompatibleQueryFilter<T>, createData: Partial<T>, options?: RepositoryOptions): Promise<T>;
+  
+  count(query?: CompatibleQueryFilter<T>, options?: RepositoryOptions): Promise<number>;
+  exists(query: CompatibleQueryFilter<T>, options?: RepositoryOptions): Promise<boolean>;
+  
+  update(id: string, data: UpdateQuery<T>, options?: RepositoryOptions): Promise<T | null>;
   delete(id: string, options?: RepositoryOptions): Promise<T | null>;
 
-  // Aggregation
-  aggregate(pipeline: any[], options?: AggregateOptions): Promise<any[]>;
-  aggregatePaginate(pipeline: any[], options?: PaginateOptions): Promise<any>;
-  distinct(field: string, query?: FilterQuery<T>, options?: RepositoryOptions): Promise<any[]>;
+  // Aggregation
+  aggregate(pipeline: any[], options?: AggregateOptions): Promise<any[]>;
+  aggregatePaginate(pipeline: any[], options?: PaginateOptions): Promise<any>;
+  distinct(field: string, query?: CompatibleQueryFilter<T>, options?: RepositoryOptions): Promise<any[]>;
 
   // Transaction support
   withTransaction<R>(callback: (session: ClientSession) => Promise<R>): Promise<R>;