immich/server/src/interfaces/user.interface.ts

import { Insertable, Updateable } from 'kysely';
import { Users } from 'src/db';
import { UserMetadata } from 'src/entities/user-metadata.entity';
import { UserEntity } from 'src/entities/user.entity';

export interface UserListFilter {
  withDeleted?: boolean;
}

export interface UserStatsQueryResponse {
  userId: string;
  userName: string;
  photos: number;
  videos: number;
  usage: number;
  usagePhotos: number;
  usageVideos: number;
  quotaSizeInBytes: number | null;
}

export interface UserFindOptions {
  withDeleted?: boolean;
}

export const IUserRepository = 'IUserRepository';

export interface IUserRepository {
  get(id: string, options: UserFindOptions): Promise<UserEntity | undefined>;
  getAdmin(): Promise<UserEntity | undefined>;
  hasAdmin(): Promise<boolean>;
  getByEmail(email: string, withPassword?: boolean): Promise<UserEntity | undefined>;
  getByStorageLabel(storageLabel: string): Promise<UserEntity | undefined>;
  getByOAuthId(oauthId: string): Promise<UserEntity | undefined>;
  getDeletedUsers(): Promise<UserEntity[]>;
  getList(filter?: UserListFilter): Promise<UserEntity[]>;
  getUserStats(): Promise<UserStatsQueryResponse[]>;
  create(user: Insertable<Users>): Promise<UserEntity>;
  update(id: string, user: Updateable<Users>): Promise<UserEntity>;
  restore(id: string): Promise<UserEntity>;
  upsertMetadata<T extends keyof UserMetadata>(id: string, item: { key: T; value: UserMetadata[T] }): Promise<void>;
  deleteMetadata<T extends keyof UserMetadata>(id: string, key: T): Promise<void>;
  delete(user: UserEntity, hard?: boolean): Promise<UserEntity>;
  updateUsage(id: string, delta: number): Promise<void>;
  syncUsage(id?: string): Promise<void>;
}