fix(query-typegoose): add new enhanced type

TriPSs · Mar 31, 2023 · ddb3ebc · ddb3ebc
1 parent 9da118a
commit ddb3ebc
Show file tree

Hide file tree

Showing 9 changed files with 30 additions and 10 deletions.
diff --git a/packages/query-typegoose/__tests__/services/typegoose-query-descriminated.service.spec.ts b/packages/query-typegoose/__tests__/services/typegoose-query-descriminated.service.spec.ts
@@ -3,7 +3,7 @@ import { InjectModel, TypegooseModule } from '@m8a/nestjs-typegoose'
 import { Test, TestingModule } from '@nestjs/testing'
 import { FindRelationOptions, SortDirection } from '@ptc-org/nestjs-query-core'
 import { DocumentType, getModelForClass, mongoose } from '@typegoose/typegoose'
-import { ReturnModelType } from '@typegoose/typegoose/lib/types'
+import { ReturnModelType } from 'packages/query-typegoose/src/typegoose-types.helper'
 
 import { NestjsQueryTypegooseModule } from '../../src'
 import { TypegooseQueryService } from '../../src/services'

diff --git a/packages/query-typegoose/__tests__/services/typegoose-query.service.spec.ts b/packages/query-typegoose/__tests__/services/typegoose-query.service.spec.ts
@@ -3,7 +3,7 @@ import { InjectModel, TypegooseModule } from '@m8a/nestjs-typegoose'
 import { Test, TestingModule } from '@nestjs/testing'
 import { FindRelationOptions, SortDirection } from '@ptc-org/nestjs-query-core'
 import { DocumentType, getModelForClass, mongoose } from '@typegoose/typegoose'
-import { ReturnModelType } from '@typegoose/typegoose/lib/types'
+import { ReturnModelType } from 'packages/query-typegoose/src/typegoose-types.helper'
 
 import { NestjsQueryTypegooseModule } from '../../src'
 import { TypegooseQueryService } from '../../src/services'

diff --git a/packages/query-typegoose/src/providers.ts b/packages/query-typegoose/src/providers.ts
@@ -1,12 +1,13 @@
 import { getModelToken } from '@m8a/nestjs-typegoose'
 import { FactoryProvider } from '@nestjs/common'
 import { AssemblerSerializer, getQueryServiceToken } from '@ptc-org/nestjs-query-core'
-import { DocumentType, mongoose, ReturnModelType } from '@typegoose/typegoose'
+import { DocumentType, mongoose } from '@typegoose/typegoose'
 import { Base } from '@typegoose/typegoose/lib/defaultClasses'
 import { isClass } from 'is-class'
 
 import { TypegooseQueryService } from './services'
 import { TypegooseClass, TypegooseClassWithOptions, TypegooseDiscriminator } from './typegoose-interface.helpers'
+import { ReturnModelType } from './typegoose-types.helper'
 
 type ClassOrDiscriminator = TypegooseClassWithOptions | TypegooseDiscriminator
 type TypegooseInput = TypegooseClass | ClassOrDiscriminator

diff --git a/packages/query-typegoose/src/query/comparison.builder.ts b/packages/query-typegoose/src/query/comparison.builder.ts
@@ -1,8 +1,9 @@
 import { BadRequestException } from '@nestjs/common'
 import { CommonFieldComparisonBetweenType, FilterComparisonOperators } from '@ptc-org/nestjs-query-core'
-import { mongoose, ReturnModelType } from '@typegoose/typegoose'
+import { mongoose } from '@typegoose/typegoose'
 import escapeRegExp from 'lodash.escaperegexp'
 
+import { ReturnModelType } from '../typegoose-types.helper'
 import { getSchemaKey } from './helpers'
 
 /**

diff --git a/packages/query-typegoose/src/query/filter-query.builder.ts b/packages/query-typegoose/src/query/filter-query.builder.ts
@@ -1,6 +1,7 @@
 import { AggregateQuery, Filter, Query, SortDirection, SortField } from '@ptc-org/nestjs-query-core'
-import { DocumentType, mongoose, ReturnModelType } from '@typegoose/typegoose'
+import { DocumentType, mongoose } from '@typegoose/typegoose'
 
+import { ReturnModelType } from '../typegoose-types.helper'
 import { AggregateBuilder, TypegooseGroupAndAggregate } from './aggregate.builder'
 import { getSchemaKey } from './helpers'
 import { WhereBuilder } from './where.builder'

diff --git a/packages/query-typegoose/src/query/where.builder.ts b/packages/query-typegoose/src/query/where.builder.ts
@@ -1,6 +1,7 @@
 import { Filter, FilterComparisons, FilterFieldComparison } from '@ptc-org/nestjs-query-core'
-import { mongoose, ReturnModelType } from '@typegoose/typegoose'
+import { mongoose } from '@typegoose/typegoose'
 
+import { ReturnModelType } from '../typegoose-types.helper'
 import { ComparisonBuilder, EntityComparisonField } from './comparison.builder'
 
 /**

diff --git a/packages/query-typegoose/src/services/reference-query.service.ts b/packages/query-typegoose/src/services/reference-query.service.ts
@@ -12,7 +12,7 @@ import {
   ModifyRelationOptions,
   Query
 } from '@ptc-org/nestjs-query-core'
-import { DocumentType, getClass, getModelWithString, mongoose, ReturnModelType } from '@typegoose/typegoose'
+import { DocumentType, getClass, getModelWithString, mongoose } from '@typegoose/typegoose'
 import { Base } from '@typegoose/typegoose/lib/defaultClasses'
 import { PipelineStage } from 'mongoose'
 
@@ -21,6 +21,7 @@ import {
   isEmbeddedSchemaTypeOptions,
   isSchemaTypeWithReferenceOptions,
   isVirtualTypeWithReferenceOptions,
+  ReturnModelType,
   VirtualTypeWithOptions
 } from '../typegoose-types.helper'
 

diff --git a/packages/query-typegoose/src/services/typegoose-query-service.ts b/packages/query-typegoose/src/services/typegoose-query-service.ts
@@ -13,12 +13,12 @@ import {
   UpdateManyResponse,
   UpdateOneOptions
 } from '@ptc-org/nestjs-query-core'
-import { DocumentType, mongoose, ReturnModelType } from '@typegoose/typegoose'
+import { DocumentType, mongoose } from '@typegoose/typegoose'
 import { Base } from '@typegoose/typegoose/lib/defaultClasses'
 import { PipelineStage } from 'mongoose'
 
 import { AggregateBuilder, FilterQueryBuilder } from '../query'
-import { UpdateArrayQuery } from '../typegoose-types.helper'
+import { ReturnModelType, UpdateArrayQuery } from '../typegoose-types.helper'
 import { ReferenceQueryService } from './reference-query.service'
 
 export interface TypegooseQueryServiceOpts {

diff --git a/packages/query-typegoose/src/typegoose-types.helper.ts b/packages/query-typegoose/src/typegoose-types.helper.ts
@@ -1,4 +1,5 @@
-import { mongoose } from '@typegoose/typegoose'
+import { DocumentType, mongoose } from '@typegoose/typegoose'
+import { AnyParamConstructor, BeAnObject, BeAnyObject, IObjectWithTypegooseFunction } from '@typegoose/typegoose/lib/types'
 
 export type ReferenceOptions = {
   type: mongoose.SchemaType
@@ -78,3 +79,17 @@ export function isVirtualTypeWithReferenceOptions(virtualType: unknown): virtual
   }
   return false
 }
+
+type CustomModelType<T, QueryHelpers = BeAnObject> = mongoose.Model<
+  T, // raw doc type
+  QueryHelpers, // query helpers
+  IObjectWithTypegooseFunction, // instance methods
+  BeAnyObject,
+  DocumentType<T>
+>
+
+export type ReturnModelType<U extends AnyParamConstructor<any>, QueryHelpers = BeAnObject> = CustomModelType<
+  InstanceType<U>,
+  QueryHelpers
+> &
+  U