feat(interfaces): add IRepoSearchParamsBuilder

src/interfaces/index.ts

@@ -19,6 +19,7 @@ export type { QSMongoOptions } from './qs-mongo-options.interface'
 export type { QueryOperators } from './query-operators.interface'
 export type { IRepoDBConnection } from './repo-db-connection.interface'
 export type { RepoOptions } from './repo-options.interface'
+export type { IRepoSearchParamsBuilder } from './repo-search-params-builder.interface'
 export type { RepoValidatorOptions } from './repo-validator-options.interface'
 export type { IRepoValidator } from './repo-validator.interface'
 export type { IRepository } from './repository.interface'

src/interfaces/repo-search-params-builder.interface.ts

@@ -0,0 +1,24 @@
+import type { EntityParsedUrlQuery, RepoSearchParams } from '@/types'
+import qsm from 'qs-to-mongo'
+import type { ParsedOptions } from 'qs-to-mongo/lib/query/options-to-mongo'
+import type { IEntity } from './entity.interface'
+import type { QSMongoParsedOptions } from './qs-mongo-options-parsed.interface'
+import type { QSMongoOptions } from './qs-mongo-options.interface'
+
+/**
+ * @file Interface - IRepoSearchParamsBuilder
+ * @module interfaces/RepoSearchParamsBuilder
+ */
+
+/**
+ * `RepoSearchParamsBuilder` interface.
+ *
+ * @template E - Entity
+ */
+export interface IRepoSearchParamsBuilder<E extends IEntity = IEntity> {
+  readonly builder: typeof qsm
+  readonly builder_options: QSMongoOptions
+
+  options(base: ParsedOptions): QSMongoParsedOptions
+  params(query?: EntityParsedUrlQuery<E> | string): RepoSearchParams<E>
+}