feat(server, web): smart search filtering and pagination (#6525)

* initial pagination impl

* use limit + offset instead of take + skip

* wip web pagination

* working infinite scroll

* update api

* formatting

* fix rebase

* search refactor

* re-add runtime config for vector search

* fix rebase

* fixes

* useless omitBy

* unnecessary handling

* add sql decorator for `searchAssets`

* fixed search builder

* fixed sql

* remove mock method

* linting

* fixed pagination

* fixed unit tests

* formatting

* fix e2e tests

* re-flatten search builder

* refactor endpoints

* clean up dto

* refinements

* don't break everything just yet

* update openapi spec & sql

* update api

* linting

* update sql

* fixes

* optimize web code

* fix typing

* add page limit

* make limit based on asset count

* increase limit

* simpler import

server/src/domain/repositories/asset.repository.ts

@@ -1,4 +1,4 @@
-import { SearchExploreItem } from '@app/domain';
+import { AssetSearchOptions, SearchExploreItem } from '@app/domain';
 import { AssetEntity, AssetJobStatusEntity, AssetType, ExifEntity } from '@app/infra/entities';
 import { FindOptionsRelations, FindOptionsSelect } from 'typeorm';
 import { Paginated, PaginationOptions } from '../domain.util';
@@ -11,64 +11,6 @@ export interface AssetStatsOptions {
   isTrashed?: boolean;
 }
 
-export interface AssetSearchOptions {
-  id?: string;
-  libraryId?: string;
-  deviceAssetId?: string;
-  deviceId?: string;
-  ownerId?: string;
-  type?: AssetType;
-  checksum?: Buffer;
-
-  isArchived?: boolean;
-  isEncoded?: boolean;
-  isExternal?: boolean;
-  isFavorite?: boolean;
-  isMotion?: boolean;
-  isOffline?: boolean;
-  isReadOnly?: boolean;
-  isVisible?: boolean;
-
-  withDeleted?: boolean;
-  withStacked?: boolean;
-  withExif?: boolean;
-  withPeople?: boolean;
-  withSmartInfo?: boolean;
-  withSmartSearch?: boolean;
-  withFaces?: boolean;
-
-  createdBefore?: Date;
-  createdAfter?: Date;
-  updatedBefore?: Date;
-  updatedAfter?: Date;
-  trashedBefore?: Date;
-  trashedAfter?: Date;
-  takenBefore?: Date;
-  takenAfter?: Date;
-
-  originalFileName?: string;
-  originalPath?: string;
-  resizePath?: string;
-  webpPath?: string;
-  encodedVideoPath?: string;
-
-  city?: string;
-  state?: string;
-  country?: string;
-  make?: string;
-  model?: string;
-  lensModel?: string;
-
-  /** defaults to 'DESC' */
-  order?: 'ASC' | 'DESC';
-
-  /** defaults to 1 */
-  page?: number;
-
-  /** defaults to 250 */
-  size?: number;
-}
-
 export interface LivePhotoSearchOptions {
   ownerId: string;
   livePhotoCID: string;
@@ -204,7 +146,6 @@ export interface IAssetRepository {
   getTimeBucket(timeBucket: string, options: TimeBucketOptions): Promise<AssetEntity[]>;
   upsertExif(exif: Partial<ExifEntity>): Promise<void>;
   upsertJobStatus(jobStatus: Partial<AssetJobStatusEntity>): Promise<void>;
-  search(options: AssetSearchOptions): Promise<AssetEntity[]>;
   getAssetIdByCity(userId: string, options: AssetExploreFieldOptions): Promise<SearchExploreItem<string>>;
   getAssetIdByTag(userId: string, options: AssetExploreFieldOptions): Promise<SearchExploreItem<string>>;
   searchMetadata(query: string, userIds: string[], options: MetadataSearchOptions): Promise<AssetEntity[]>;

server/src/domain/repositories/index.ts

@@ -19,7 +19,6 @@ export * from './person.repository';
 export * from './search.repository';
 export * from './server-info.repository';
 export * from './shared-link.repository';
-export * from './smart-info.repository';
 export * from './storage.repository';
 export * from './system-config.repository';
 export * from './system-metadata.repository';

server/src/domain/repositories/search.repository.ts

@@ -1,4 +1,7 @@
-import { AssetType } from '@app/infra/entities';
+import { AssetEntity, AssetFaceEntity, AssetType, SmartInfoEntity } from '@app/infra/entities';
+import { Paginated } from '../domain.util';
+
+export const ISearchRepository = 'ISearchRepository';
 
 export enum SearchStrategy {
   SMART = 'SMART',
@@ -54,3 +57,122 @@ export interface SearchExploreItem<T> {
   fieldName: string;
   items: SearchExploreItemSet<T>;
 }
+
+export type Embedding = number[];
+
+export interface SearchAssetIDOptions {
+  checksum?: Buffer;
+  deviceAssetId?: string;
+  id?: string;
+}
+
+export interface SearchUserIDOptions {
+  deviceId?: string;
+  libraryId?: string;
+  ownerId?: string;
+}
+
+export type SearchIDOptions = SearchAssetIDOptions & SearchUserIDOptions;
+
+export interface SearchStatusOptions {
+  isArchived?: boolean;
+  isEncoded?: boolean;
+  isExternal?: boolean;
+  isFavorite?: boolean;
+  isMotion?: boolean;
+  isOffline?: boolean;
+  isReadOnly?: boolean;
+  isVisible?: boolean;
+  type?: AssetType;
+  withArchived?: boolean;
+  withDeleted?: boolean;
+}
+
+export interface SearchOneToOneRelationOptions {
+  withExif?: boolean;
+  withSmartInfo?: boolean;
+}
+
+export interface SearchRelationOptions extends SearchOneToOneRelationOptions {
+  withFaces?: boolean;
+  withPeople?: boolean;
+  withStacked?: boolean;
+}
+
+export interface SearchDateOptions {
+  createdBefore?: Date;
+  createdAfter?: Date;
+  takenBefore?: Date;
+  takenAfter?: Date;
+  trashedBefore?: Date;
+  trashedAfter?: Date;
+  updatedBefore?: Date;
+  updatedAfter?: Date;
+}
+
+export interface SearchPathOptions {
+  encodedVideoPath?: string;
+  originalFileName?: string;
+  originalPath?: string;
+  resizePath?: string;
+  webpPath?: string;
+}
+
+export interface SearchExifOptions {
+  city?: string;
+  country?: string;
+  lensModel?: string;
+  make?: string;
+  model?: string;
+  state?: string;
+}
+
+export interface SearchEmbeddingOptions {
+  embedding: Embedding;
+  userIds: string[];
+}
+
+export interface SearchOrderOptions {
+  orderDirection?: 'ASC' | 'DESC';
+}
+
+export interface SearchPaginationOptions {
+  page: number;
+  size: number;
+}
+
+export type AssetSearchOptions = SearchDateOptions &
+  SearchIDOptions &
+  SearchExifOptions &
+  SearchOrderOptions &
+  SearchPathOptions &
+  SearchRelationOptions &
+  SearchStatusOptions;
+
+export type AssetSearchBuilderOptions = Omit<AssetSearchOptions, 'orderDirection'>;
+
+export type SmartSearchOptions = SearchDateOptions &
+  SearchEmbeddingOptions &
+  SearchExifOptions &
+  SearchOneToOneRelationOptions &
+  SearchStatusOptions &
+  SearchUserIDOptions;
+
+export interface FaceEmbeddingSearch extends SearchEmbeddingOptions {
+  hasPerson?: boolean;
+  numResults: number;
+  maxDistance?: number;
+}
+
+export interface FaceSearchResult {
+  distance: number;
+  face: AssetFaceEntity;
+}
+
+export interface ISearchRepository {
+  init(modelName: string): Promise<void>;
+  searchMetadata(pagination: SearchPaginationOptions, options: AssetSearchOptions): Paginated<AssetEntity>;
+  searchSmart(pagination: SearchPaginationOptions, options: SmartSearchOptions): Paginated<AssetEntity>;
+  searchFaces(search: FaceEmbeddingSearch): Promise<FaceSearchResult[]>;
+  upsert(smartInfo: Partial<SmartInfoEntity>, embedding?: Embedding): Promise<void>;
+}

server/src/domain/repositories/smart-info.repository.ts

@@ -1,29 +0,0 @@
-import { AssetEntity, AssetFaceEntity, SmartInfoEntity } from '@app/infra/entities';
-
-export const ISmartInfoRepository = 'ISmartInfoRepository';
-
-export type Embedding = number[];
-
-export interface EmbeddingSearch {
-  userIds: string[];
-  embedding: Embedding;
-  numResults: number;
-  withArchived?: boolean;
-}
-
-export interface FaceEmbeddingSearch extends EmbeddingSearch {
-  maxDistance?: number;
-  hasPerson?: boolean;
-}
-
-export interface FaceSearchResult {
-  face: AssetFaceEntity;
-  distance: number;
-}
-
-export interface ISmartInfoRepository {
-  init(modelName: string): Promise<void>;
-  searchCLIP(search: EmbeddingSearch): Promise<AssetEntity[]>;
-  searchFaces(search: FaceEmbeddingSearch): Promise<FaceSearchResult[]>;
-  upsert(smartInfo: Partial<SmartInfoEntity>, embedding?: Embedding): Promise<void>;
-}