feat: constrain filter to exclude where for findById

packages/repository/src/query.ts

@@ -221,6 +221,14 @@ export interface Filter<MT extends object = AnyObject> {
   include?: Inclusion[];
 }
 
+/**
+ * Filter without `where` property
+ */
+export type FilterExcludingWhere<MT extends object = AnyObject> = Omit<
+  Filter<MT>,
+  'where'
+>;
+
 /**
  * TypeGuard for Filter
  * @param candidate

packages/repository/src/repositories/legacy-juggler-bridge.ts

@@ -17,7 +17,7 @@ import {
 } from '../common-types';
 import {EntityNotFoundError} from '../errors';
 import {Entity, Model, PropertyType} from '../model';
-import {Filter, Inclusion, Where} from '../query';
+import {Filter, Inclusion, Where, FilterExcludingWhere} from '../query';
 import {
   BelongsToAccessor,
   BelongsToDefinition,
@@ -396,7 +396,7 @@ export class DefaultCrudRepository<
 
   async findById(
     id: ID,
-    filter?: Filter<T>,
+    filter?: FilterExcludingWhere<T>,
     options?: Options,
   ): Promise<T & Relations> {
     const include = filter?.include;

packages/repository/src/repositories/repository.ts

@@ -16,7 +16,7 @@ import {CrudConnector} from '../connectors';
 import {DataSource} from '../datasource';
 import {EntityNotFoundError} from '../errors';
 import {Entity, Model, ValueObject} from '../model';
-import {Filter, Where} from '../query';
+import {Filter, FilterExcludingWhere, Where} from '../query';
 import {InclusionResolver} from '../relations/relation.types';
 import {IsolationLevel, Transaction} from '../transaction';
 
@@ -172,6 +172,13 @@ export interface EntityCrudRepository<
 
   /**
    * Find an entity by id, return a rejected promise if not found.
+   *
+   * @remarks
+   *
+   * The rationale behind findById is to find an instance by its primary key
+   * (id). No other search criteria than id should be used. If a client wants
+   * to use a `where` clause beyond id, use `find` or `findOne` instead.
+   *
    * @param id - Value for the entity id
    * @param filter - Additional query options. E.g. `filter.include` configures
    * which related models to fetch as part of the database query (or queries).
@@ -180,7 +187,7 @@ export interface EntityCrudRepository<
    */
   findById(
     id: ID,
-    filter?: Filter<T>,
+    filter?: FilterExcludingWhere<T>,
     options?: Options,
   ): Promise<T & Relations>;
 
@@ -303,7 +310,11 @@ export class CrudRepositoryImpl<T extends Entity, ID>
     );
   }
 
-  async findById(id: ID, filter?: Filter<T>, options?: Options): Promise<T> {
+  async findById(
+    id: ID,
+    filter?: FilterExcludingWhere<T>,
+    options?: Options,
+  ): Promise<T> {
     if (typeof this.connector.findById === 'function') {
       return this.toModel(
         this.connector.findById(this.entityClass, id, options),