refactor: last repository (#16042)

server/src/types.ts

@@ -1,5 +1,14 @@
 import { UserEntity } from 'src/entities/user.entity';
-import { ExifOrientation, ImageFormat, Permission, TranscodeTarget, VideoCodec } from 'src/enum';
+import {
+  DatabaseExtension,
+  ExifOrientation,
+  ImageFormat,
+  JobName,
+  Permission,
+  QueueName,
+  TranscodeTarget,
+  VideoCodec,
+} from 'src/enum';
 import { ActivityRepository } from 'src/repositories/activity.repository';
 import { ApiKeyRepository } from 'src/repositories/api-key.repository';
 import { MemoryRepository } from 'src/repositories/memory.repository';
@@ -167,3 +176,245 @@ export interface VideoInterfaces {
   dri: string[];
   mali: boolean;
 }
+
+export type ConcurrentQueueName = Exclude<
+  QueueName,
+  | QueueName.STORAGE_TEMPLATE_MIGRATION
+  | QueueName.FACIAL_RECOGNITION
+  | QueueName.DUPLICATE_DETECTION
+  | QueueName.BACKUP_DATABASE
+>;
+
+export type Jobs = { [K in JobItem['name']]: (JobItem & { name: K })['data'] };
+export type JobOf<T extends JobName> = Jobs[T];
+
+export interface IBaseJob {
+  force?: boolean;
+}
+
+export interface IDelayedJob extends IBaseJob {
+  /** The minimum time to wait to execute this job, in milliseconds. */
+  delay?: number;
+}
+
+export interface IEntityJob extends IBaseJob {
+  id: string;
+  source?: 'upload' | 'sidecar-write' | 'copy';
+  notify?: boolean;
+}
+
+export interface IAssetDeleteJob extends IEntityJob {
+  deleteOnDisk: boolean;
+}
+
+export interface ILibraryFileJob extends IEntityJob {
+  ownerId: string;
+  assetPath: string;
+}
+
+export interface ILibraryAssetJob extends IEntityJob {
+  importPaths: string[];
+  exclusionPatterns: string[];
+}
+
+export interface IBulkEntityJob extends IBaseJob {
+  ids: string[];
+}
+
+export interface IDeleteFilesJob extends IBaseJob {
+  files: Array<string | null | undefined>;
+}
+
+export interface ISidecarWriteJob extends IEntityJob {
+  description?: string;
+  dateTimeOriginal?: string;
+  latitude?: number;
+  longitude?: number;
+  rating?: number;
+  tags?: true;
+}
+
+export interface IDeferrableJob extends IEntityJob {
+  deferred?: boolean;
+}
+
+export interface INightlyJob extends IBaseJob {
+  nightly?: boolean;
+}
+
+export type EmailImageAttachment = {
+  filename: string;
+  path: string;
+  cid: string;
+};
+
+export interface IEmailJob {
+  to: string;
+  subject: string;
+  html: string;
+  text: string;
+  imageAttachments?: EmailImageAttachment[];
+}
+
+export interface INotifySignupJob extends IEntityJob {
+  tempPassword?: string;
+}
+
+export interface INotifyAlbumInviteJob extends IEntityJob {
+  recipientId: string;
+}
+
+export interface INotifyAlbumUpdateJob extends IEntityJob, IDelayedJob {
+  recipientIds: string[];
+}
+
+export interface JobCounts {
+  active: number;
+  completed: number;
+  failed: number;
+  delayed: number;
+  waiting: number;
+  paused: number;
+}
+
+export interface QueueStatus {
+  isActive: boolean;
+  isPaused: boolean;
+}
+
+export type JobItem =
+  // Backups
+  | { name: JobName.BACKUP_DATABASE; data?: IBaseJob }
+
+  // Transcoding
+  | { name: JobName.QUEUE_VIDEO_CONVERSION; data: IBaseJob }
+  | { name: JobName.VIDEO_CONVERSION; data: IEntityJob }
+
+  // Thumbnails
+  | { name: JobName.QUEUE_GENERATE_THUMBNAILS; data: IBaseJob }
+  | { name: JobName.GENERATE_THUMBNAILS; data: IEntityJob }
+
+  // User
+  | { name: JobName.USER_DELETE_CHECK; data?: IBaseJob }
+  | { name: JobName.USER_DELETION; data: IEntityJob }
+  | { name: JobName.USER_SYNC_USAGE; data?: IBaseJob }
+
+  // Storage Template
+  | { name: JobName.STORAGE_TEMPLATE_MIGRATION; data?: IBaseJob }
+  | { name: JobName.STORAGE_TEMPLATE_MIGRATION_SINGLE; data: IEntityJob }
+
+  // Migration
+  | { name: JobName.QUEUE_MIGRATION; data?: IBaseJob }
+  | { name: JobName.MIGRATE_ASSET; data: IEntityJob }
+  | { name: JobName.MIGRATE_PERSON; data: IEntityJob }
+
+  // Metadata Extraction
+  | { name: JobName.QUEUE_METADATA_EXTRACTION; data: IBaseJob }
+  | { name: JobName.METADATA_EXTRACTION; data: IEntityJob }
+  | { name: JobName.LINK_LIVE_PHOTOS; data: IEntityJob }
+  // Sidecar Scanning
+  | { name: JobName.QUEUE_SIDECAR; data: IBaseJob }
+  | { name: JobName.SIDECAR_DISCOVERY; data: IEntityJob }
+  | { name: JobName.SIDECAR_SYNC; data: IEntityJob }
+  | { name: JobName.SIDECAR_WRITE; data: ISidecarWriteJob }
+
+  // Facial Recognition
+  | { name: JobName.QUEUE_FACE_DETECTION; data: IBaseJob }
+  | { name: JobName.FACE_DETECTION; data: IEntityJob }
+  | { name: JobName.QUEUE_FACIAL_RECOGNITION; data: INightlyJob }
+  | { name: JobName.FACIAL_RECOGNITION; data: IDeferrableJob }
+  | { name: JobName.GENERATE_PERSON_THUMBNAIL; data: IEntityJob }
+
+  // Smart Search
+  | { name: JobName.QUEUE_SMART_SEARCH; data: IBaseJob }
+  | { name: JobName.SMART_SEARCH; data: IEntityJob }
+  | { name: JobName.QUEUE_TRASH_EMPTY; data?: IBaseJob }
+
+  // Duplicate Detection
+  | { name: JobName.QUEUE_DUPLICATE_DETECTION; data: IBaseJob }
+  | { name: JobName.DUPLICATE_DETECTION; data: IEntityJob }
+
+  // Filesystem
+  | { name: JobName.DELETE_FILES; data: IDeleteFilesJob }
+
+  // Cleanup
+  | { name: JobName.CLEAN_OLD_AUDIT_LOGS; data?: IBaseJob }
+  | { name: JobName.CLEAN_OLD_SESSION_TOKENS; data?: IBaseJob }
+
+  // Tags
+  | { name: JobName.TAG_CLEANUP; data?: IBaseJob }
+
+  // Asset Deletion
+  | { name: JobName.PERSON_CLEANUP; data?: IBaseJob }
+  | { name: JobName.ASSET_DELETION; data: IAssetDeleteJob }
+  | { name: JobName.ASSET_DELETION_CHECK; data?: IBaseJob }
+
+  // Library Management
+  | { name: JobName.LIBRARY_SYNC_FILE; data: ILibraryFileJob }
+  | { name: JobName.LIBRARY_QUEUE_SYNC_FILES; data: IEntityJob }
+  | { name: JobName.LIBRARY_QUEUE_SYNC_ASSETS; data: IEntityJob }
+  | { name: JobName.LIBRARY_SYNC_ASSET; data: ILibraryAssetJob }
+  | { name: JobName.LIBRARY_DELETE; data: IEntityJob }
+  | { name: JobName.LIBRARY_QUEUE_SYNC_ALL; data?: IBaseJob }
+  | { name: JobName.LIBRARY_QUEUE_CLEANUP; data: IBaseJob }
+
+  // Notification
+  | { name: JobName.SEND_EMAIL; data: IEmailJob }
+  | { name: JobName.NOTIFY_ALBUM_INVITE; data: INotifyAlbumInviteJob }
+  | { name: JobName.NOTIFY_ALBUM_UPDATE; data: INotifyAlbumUpdateJob }
+  | { name: JobName.NOTIFY_SIGNUP; data: INotifySignupJob }
+
+  // Version check
+  | { name: JobName.VERSION_CHECK; data: IBaseJob };
+
+export type VectorExtension = DatabaseExtension.VECTOR | DatabaseExtension.VECTORS;
+
+export type DatabaseConnectionURL = {
+  connectionType: 'url';
+  url: string;
+};
+
+export type DatabaseConnectionParts = {
+  connectionType: 'parts';
+  host: string;
+  port: number;
+  username: string;
+  password: string;
+  database: string;
+};
+
+export type DatabaseConnectionParams = DatabaseConnectionURL | DatabaseConnectionParts;
+
+export interface ExtensionVersion {
+  availableVersion: string | null;
+  installedVersion: string | null;
+}
+
+export interface VectorUpdateResult {
+  restartRequired: boolean;
+}
+
+export interface ImmichFile extends Express.Multer.File {
+  /** sha1 hash of file */
+  uuid: string;
+  checksum: Buffer;
+}
+
+export interface UploadFile {
+  uuid: string;
+  checksum: Buffer;
+  originalPath: string;
+  originalName: string;
+  size: number;
+}
+
+export interface UploadFiles {
+  assetData: ImmichFile[];
+  sidecarData: ImmichFile[];
+}
+
+export interface IBulkAsset {
+  getAssetIds: (id: string, assetIds: string[]) => Promise<Set<string>>;
+  addAssetIds: (id: string, assetIds: string[]) => Promise<void>;
+  removeAssetIds: (id: string, assetIds: string[]) => Promise<void>;
+}