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
2024-02-12 20:50:47 -05:00
parent f1e4fdf175
commit e334443919
54 changed files with 3993 additions and 790 deletions
@@ -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>;
+}