feat: update mongoose to v6 and use mongoose-v6 QueryWithHelpers inte…

…rface (#561) Co-authored-by: soy <sylvain.oyer@hygia.fr> BREAKING CHANGE: updates mongoose and related ts types to v6
stalniy · Nov 4, 2021 · a5f1036 · a5f1036
1 parent 825121b
commit a5f1036
Show file tree

Hide file tree

Showing 4 changed files with 93 additions and 110 deletions.
diff --git a/packages/casl-mongoose/package.json b/packages/casl-mongoose/package.json
@@ -40,14 +40,14 @@
   "license": "MIT",
   "peerDependencies": {
     "@casl/ability": "^3.0.0 || ^4.0.0 || ^5.1.0",
-    "mongoose": "^5.12.0"
+    "mongoose": "^6.0.0"
   },
   "devDependencies": {
     "@casl/ability": "^5.1.0",
     "@casl/dx": "workspace:^1.0.0",
     "chai": "^4.1.0",
     "chai-spies": "^1.0.0",
-    "mongoose": "^5.12.0"
+    "mongoose": "^6.0.0"
   },
   "files": [
     "dist",

diff --git a/packages/casl-mongoose/spec/accessible_records.spec.ts b/packages/casl-mongoose/spec/accessible_records.spec.ts
@@ -75,7 +75,7 @@ describe('Accessible Records Plugin', () => {
     })
 
     describe('when ability disallow to perform an action', () => {
-      let query: mongoose.DocumentQuery<Post, Post>
+      let query: mongoose.QueryWithHelpers<Post, Post>
 
       beforeEach(() => {
         query = Post.find().accessibleBy(ability, 'notAllowedAction')

diff --git a/packages/casl-mongoose/src/accessible_records.ts b/packages/casl-mongoose/src/accessible_records.ts
@@ -1,13 +1,13 @@
 import { Normalize, AnyMongoAbility, Generics, ForbiddenError, getDefaultErrorMessage } from '@casl/ability';
-import type { Schema, DocumentQuery, Model, Document } from 'mongoose';
+import type { Schema, QueryWithHelpers, Model, Document } from 'mongoose';
 import mongoose from 'mongoose';
 import { toMongoQuery } from './mongo';
 
 function failedQuery(
   ability: AnyMongoAbility,
   action: string,
   modelName: string,
-  query: DocumentQuery<Document, Document>
+  query: QueryWithHelpers<Document, Document>
 ) {
   query.where({ __forbiddenByCasl__: 1 }); // eslint-disable-line
   const anyQuery: any = query;
@@ -28,13 +28,13 @@ function failedQuery(
 type GetAccessibleRecords<T extends Document> = <U extends AnyMongoAbility>(
   ability: U,
   action?: Normalize<Generics<U>['abilities']>[0]
-) => DocumentQuery<T, T>;
+) => QueryWithHelpers<T, T>;
 
 function accessibleBy<T extends AnyMongoAbility>(
   this: any,
   ability: T,
   action?: Normalize<Generics<T>['abilities']>[0]
-): DocumentQuery<Document, Document> {
+): QueryWithHelpers<Document, Document> {
   let modelName: string | undefined = this.modelName;
 
   if (!modelName) {