mirror of
https://github.com/immich-app/immich.git
synced 2025-07-09 03:04:16 -04:00
987e5ab76c
Job workers are currently started on app init, which means they are started before the DB is initialised. This can be problematic if jobs which need to use the DB start running before it's ready. It also means that swapping out the queue implementation for something which uses the DB won't work.
583 lines
13 KiB
TypeScript
583 lines
13 KiB
TypeScript
export enum AuthType {
|
|
PASSWORD = 'password',
|
|
OAUTH = 'oauth',
|
|
}
|
|
|
|
export enum ImmichCookie {
|
|
ACCESS_TOKEN = 'immich_access_token',
|
|
AUTH_TYPE = 'immich_auth_type',
|
|
IS_AUTHENTICATED = 'immich_is_authenticated',
|
|
SHARED_LINK_TOKEN = 'immich_shared_link_token',
|
|
OAUTH_STATE = 'immich_oauth_state',
|
|
OAUTH_CODE_VERIFIER = 'immich_oauth_code_verifier',
|
|
}
|
|
|
|
export enum ImmichHeader {
|
|
API_KEY = 'x-api-key',
|
|
USER_TOKEN = 'x-immich-user-token',
|
|
SESSION_TOKEN = 'x-immich-session-token',
|
|
SHARED_LINK_KEY = 'x-immich-share-key',
|
|
CHECKSUM = 'x-immich-checksum',
|
|
CID = 'x-immich-cid',
|
|
}
|
|
|
|
export enum ImmichQuery {
|
|
SHARED_LINK_KEY = 'key',
|
|
API_KEY = 'apiKey',
|
|
SESSION_KEY = 'sessionKey',
|
|
}
|
|
|
|
export enum AssetType {
|
|
IMAGE = 'IMAGE',
|
|
VIDEO = 'VIDEO',
|
|
AUDIO = 'AUDIO',
|
|
OTHER = 'OTHER',
|
|
}
|
|
|
|
export enum AssetFileType {
|
|
/**
|
|
* An full/large-size image extracted/converted from RAW photos
|
|
*/
|
|
FULLSIZE = 'fullsize',
|
|
PREVIEW = 'preview',
|
|
THUMBNAIL = 'thumbnail',
|
|
}
|
|
|
|
export enum AlbumUserRole {
|
|
EDITOR = 'editor',
|
|
VIEWER = 'viewer',
|
|
}
|
|
|
|
export enum AssetOrder {
|
|
ASC = 'asc',
|
|
DESC = 'desc',
|
|
}
|
|
|
|
export enum DatabaseAction {
|
|
CREATE = 'CREATE',
|
|
UPDATE = 'UPDATE',
|
|
DELETE = 'DELETE',
|
|
}
|
|
|
|
export enum EntityType {
|
|
ASSET = 'ASSET',
|
|
ALBUM = 'ALBUM',
|
|
}
|
|
|
|
export enum MemoryType {
|
|
/** pictures taken on this day X years ago */
|
|
ON_THIS_DAY = 'on_this_day',
|
|
}
|
|
|
|
export enum Permission {
|
|
ALL = 'all',
|
|
|
|
ACTIVITY_CREATE = 'activity.create',
|
|
ACTIVITY_READ = 'activity.read',
|
|
ACTIVITY_UPDATE = 'activity.update',
|
|
ACTIVITY_DELETE = 'activity.delete',
|
|
ACTIVITY_STATISTICS = 'activity.statistics',
|
|
|
|
API_KEY_CREATE = 'apiKey.create',
|
|
API_KEY_READ = 'apiKey.read',
|
|
API_KEY_UPDATE = 'apiKey.update',
|
|
API_KEY_DELETE = 'apiKey.delete',
|
|
|
|
// ASSET_CREATE = 'asset.create',
|
|
ASSET_READ = 'asset.read',
|
|
ASSET_UPDATE = 'asset.update',
|
|
ASSET_DELETE = 'asset.delete',
|
|
ASSET_SHARE = 'asset.share',
|
|
ASSET_VIEW = 'asset.view',
|
|
ASSET_DOWNLOAD = 'asset.download',
|
|
ASSET_UPLOAD = 'asset.upload',
|
|
|
|
ALBUM_CREATE = 'album.create',
|
|
ALBUM_READ = 'album.read',
|
|
ALBUM_UPDATE = 'album.update',
|
|
ALBUM_DELETE = 'album.delete',
|
|
ALBUM_STATISTICS = 'album.statistics',
|
|
|
|
ALBUM_ADD_ASSET = 'album.addAsset',
|
|
ALBUM_REMOVE_ASSET = 'album.removeAsset',
|
|
ALBUM_SHARE = 'album.share',
|
|
ALBUM_DOWNLOAD = 'album.download',
|
|
|
|
AUTH_DEVICE_DELETE = 'authDevice.delete',
|
|
|
|
ARCHIVE_READ = 'archive.read',
|
|
|
|
FACE_CREATE = 'face.create',
|
|
FACE_READ = 'face.read',
|
|
FACE_UPDATE = 'face.update',
|
|
FACE_DELETE = 'face.delete',
|
|
|
|
LIBRARY_CREATE = 'library.create',
|
|
LIBRARY_READ = 'library.read',
|
|
LIBRARY_UPDATE = 'library.update',
|
|
LIBRARY_DELETE = 'library.delete',
|
|
LIBRARY_STATISTICS = 'library.statistics',
|
|
|
|
TIMELINE_READ = 'timeline.read',
|
|
TIMELINE_DOWNLOAD = 'timeline.download',
|
|
|
|
MEMORY_CREATE = 'memory.create',
|
|
MEMORY_READ = 'memory.read',
|
|
MEMORY_UPDATE = 'memory.update',
|
|
MEMORY_DELETE = 'memory.delete',
|
|
|
|
PARTNER_CREATE = 'partner.create',
|
|
PARTNER_READ = 'partner.read',
|
|
PARTNER_UPDATE = 'partner.update',
|
|
PARTNER_DELETE = 'partner.delete',
|
|
|
|
PERSON_CREATE = 'person.create',
|
|
PERSON_READ = 'person.read',
|
|
PERSON_UPDATE = 'person.update',
|
|
PERSON_DELETE = 'person.delete',
|
|
PERSON_STATISTICS = 'person.statistics',
|
|
PERSON_MERGE = 'person.merge',
|
|
PERSON_REASSIGN = 'person.reassign',
|
|
|
|
SESSION_READ = 'session.read',
|
|
SESSION_UPDATE = 'session.update',
|
|
SESSION_DELETE = 'session.delete',
|
|
|
|
SHARED_LINK_CREATE = 'sharedLink.create',
|
|
SHARED_LINK_READ = 'sharedLink.read',
|
|
SHARED_LINK_UPDATE = 'sharedLink.update',
|
|
SHARED_LINK_DELETE = 'sharedLink.delete',
|
|
|
|
STACK_CREATE = 'stack.create',
|
|
STACK_READ = 'stack.read',
|
|
STACK_UPDATE = 'stack.update',
|
|
STACK_DELETE = 'stack.delete',
|
|
|
|
SYSTEM_CONFIG_READ = 'systemConfig.read',
|
|
SYSTEM_CONFIG_UPDATE = 'systemConfig.update',
|
|
|
|
SYSTEM_METADATA_READ = 'systemMetadata.read',
|
|
SYSTEM_METADATA_UPDATE = 'systemMetadata.update',
|
|
|
|
TAG_CREATE = 'tag.create',
|
|
TAG_READ = 'tag.read',
|
|
TAG_UPDATE = 'tag.update',
|
|
TAG_DELETE = 'tag.delete',
|
|
TAG_ASSET = 'tag.asset',
|
|
|
|
ADMIN_USER_CREATE = 'admin.user.create',
|
|
ADMIN_USER_READ = 'admin.user.read',
|
|
ADMIN_USER_UPDATE = 'admin.user.update',
|
|
ADMIN_USER_DELETE = 'admin.user.delete',
|
|
}
|
|
|
|
export enum SharedLinkType {
|
|
ALBUM = 'ALBUM',
|
|
|
|
/**
|
|
* Individual asset
|
|
* or group of assets that are not in an album
|
|
*/
|
|
INDIVIDUAL = 'INDIVIDUAL',
|
|
}
|
|
|
|
export enum StorageFolder {
|
|
ENCODED_VIDEO = 'encoded-video',
|
|
LIBRARY = 'library',
|
|
UPLOAD = 'upload',
|
|
PROFILE = 'profile',
|
|
THUMBNAILS = 'thumbs',
|
|
BACKUPS = 'backups',
|
|
}
|
|
|
|
export enum SystemMetadataKey {
|
|
REVERSE_GEOCODING_STATE = 'reverse-geocoding-state',
|
|
FACIAL_RECOGNITION_STATE = 'facial-recognition-state',
|
|
MEMORIES_STATE = 'memories-state',
|
|
ADMIN_ONBOARDING = 'admin-onboarding',
|
|
SYSTEM_CONFIG = 'system-config',
|
|
SYSTEM_FLAGS = 'system-flags',
|
|
VERSION_CHECK_STATE = 'version-check-state',
|
|
LICENSE = 'license',
|
|
}
|
|
|
|
export enum UserMetadataKey {
|
|
PREFERENCES = 'preferences',
|
|
LICENSE = 'license',
|
|
}
|
|
|
|
export enum UserAvatarColor {
|
|
PRIMARY = 'primary',
|
|
PINK = 'pink',
|
|
RED = 'red',
|
|
YELLOW = 'yellow',
|
|
BLUE = 'blue',
|
|
GREEN = 'green',
|
|
PURPLE = 'purple',
|
|
ORANGE = 'orange',
|
|
GRAY = 'gray',
|
|
AMBER = 'amber',
|
|
}
|
|
|
|
export enum UserStatus {
|
|
ACTIVE = 'active',
|
|
REMOVING = 'removing',
|
|
DELETED = 'deleted',
|
|
}
|
|
|
|
export enum AssetStatus {
|
|
ACTIVE = 'active',
|
|
TRASHED = 'trashed',
|
|
DELETED = 'deleted',
|
|
}
|
|
|
|
export enum SourceType {
|
|
MACHINE_LEARNING = 'machine-learning',
|
|
EXIF = 'exif',
|
|
MANUAL = 'manual',
|
|
}
|
|
|
|
export enum ManualJobName {
|
|
PERSON_CLEANUP = 'person-cleanup',
|
|
TAG_CLEANUP = 'tag-cleanup',
|
|
USER_CLEANUP = 'user-cleanup',
|
|
MEMORY_CLEANUP = 'memory-cleanup',
|
|
MEMORY_CREATE = 'memory-create',
|
|
BACKUP_DATABASE = 'backup-database',
|
|
}
|
|
|
|
export enum AssetPathType {
|
|
ORIGINAL = 'original',
|
|
FULLSIZE = 'fullsize',
|
|
PREVIEW = 'preview',
|
|
THUMBNAIL = 'thumbnail',
|
|
ENCODED_VIDEO = 'encoded_video',
|
|
SIDECAR = 'sidecar',
|
|
}
|
|
|
|
export enum PersonPathType {
|
|
FACE = 'face',
|
|
}
|
|
|
|
export enum UserPathType {
|
|
PROFILE = 'profile',
|
|
}
|
|
|
|
export type PathType = AssetPathType | PersonPathType | UserPathType;
|
|
|
|
export enum TranscodePolicy {
|
|
ALL = 'all',
|
|
OPTIMAL = 'optimal',
|
|
BITRATE = 'bitrate',
|
|
REQUIRED = 'required',
|
|
DISABLED = 'disabled',
|
|
}
|
|
|
|
export enum TranscodeTarget {
|
|
NONE,
|
|
AUDIO,
|
|
VIDEO,
|
|
ALL,
|
|
}
|
|
|
|
export enum VideoCodec {
|
|
H264 = 'h264',
|
|
HEVC = 'hevc',
|
|
VP9 = 'vp9',
|
|
AV1 = 'av1',
|
|
}
|
|
|
|
export enum AudioCodec {
|
|
MP3 = 'mp3',
|
|
AAC = 'aac',
|
|
LIBOPUS = 'libopus',
|
|
PCMS16LE = 'pcm_s16le',
|
|
}
|
|
|
|
export enum VideoContainer {
|
|
MOV = 'mov',
|
|
MP4 = 'mp4',
|
|
OGG = 'ogg',
|
|
WEBM = 'webm',
|
|
}
|
|
|
|
export enum TranscodeHWAccel {
|
|
NVENC = 'nvenc',
|
|
QSV = 'qsv',
|
|
VAAPI = 'vaapi',
|
|
RKMPP = 'rkmpp',
|
|
DISABLED = 'disabled',
|
|
}
|
|
|
|
export enum ToneMapping {
|
|
HABLE = 'hable',
|
|
MOBIUS = 'mobius',
|
|
REINHARD = 'reinhard',
|
|
DISABLED = 'disabled',
|
|
}
|
|
|
|
export enum CQMode {
|
|
AUTO = 'auto',
|
|
CQP = 'cqp',
|
|
ICQ = 'icq',
|
|
}
|
|
|
|
export enum Colorspace {
|
|
SRGB = 'srgb',
|
|
P3 = 'p3',
|
|
}
|
|
|
|
export enum ImageFormat {
|
|
JPEG = 'jpeg',
|
|
WEBP = 'webp',
|
|
}
|
|
|
|
export enum LogLevel {
|
|
VERBOSE = 'verbose',
|
|
DEBUG = 'debug',
|
|
LOG = 'log',
|
|
WARN = 'warn',
|
|
ERROR = 'error',
|
|
FATAL = 'fatal',
|
|
}
|
|
|
|
export enum MetadataKey {
|
|
AUTH_ROUTE = 'auth_route',
|
|
ADMIN_ROUTE = 'admin_route',
|
|
SHARED_ROUTE = 'shared_route',
|
|
API_KEY_SECURITY = 'api_key',
|
|
EVENT_CONFIG = 'event_config',
|
|
JOB_CONFIG = 'job_config',
|
|
TELEMETRY_ENABLED = 'telemetry_enabled',
|
|
}
|
|
|
|
export enum RouteKey {
|
|
ASSET = 'assets',
|
|
USER = 'users',
|
|
}
|
|
|
|
export enum CacheControl {
|
|
PRIVATE_WITH_CACHE = 'private_with_cache',
|
|
PRIVATE_WITHOUT_CACHE = 'private_without_cache',
|
|
NONE = 'none',
|
|
}
|
|
|
|
export enum PaginationMode {
|
|
LIMIT_OFFSET = 'limit-offset',
|
|
SKIP_TAKE = 'skip-take',
|
|
}
|
|
|
|
export enum ImmichEnvironment {
|
|
DEVELOPMENT = 'development',
|
|
TESTING = 'testing',
|
|
PRODUCTION = 'production',
|
|
}
|
|
|
|
export enum ImmichWorker {
|
|
API = 'api',
|
|
MICROSERVICES = 'microservices',
|
|
}
|
|
|
|
export enum ImmichTelemetry {
|
|
HOST = 'host',
|
|
API = 'api',
|
|
IO = 'io',
|
|
REPO = 'repo',
|
|
JOB = 'job',
|
|
}
|
|
|
|
export enum ExifOrientation {
|
|
Horizontal = 1,
|
|
MirrorHorizontal = 2,
|
|
Rotate180 = 3,
|
|
MirrorVertical = 4,
|
|
MirrorHorizontalRotate270CW = 5,
|
|
Rotate90CW = 6,
|
|
MirrorHorizontalRotate90CW = 7,
|
|
Rotate270CW = 8,
|
|
}
|
|
|
|
export enum DatabaseExtension {
|
|
CUBE = 'cube',
|
|
EARTH_DISTANCE = 'earthdistance',
|
|
VECTOR = 'vector',
|
|
VECTORS = 'vectors',
|
|
}
|
|
|
|
export enum BootstrapEventPriority {
|
|
// Database service should be initialized before anything else, most other services need database access
|
|
DatabaseService = -200,
|
|
// Other services may need to queue jobs on bootstrap.
|
|
JobService = -190,
|
|
// Initialise config after other bootstrap services, stop other services from using config on bootstrap
|
|
SystemConfig = 100,
|
|
}
|
|
|
|
export enum QueueName {
|
|
THUMBNAIL_GENERATION = 'thumbnailGeneration',
|
|
METADATA_EXTRACTION = 'metadataExtraction',
|
|
VIDEO_CONVERSION = 'videoConversion',
|
|
FACE_DETECTION = 'faceDetection',
|
|
FACIAL_RECOGNITION = 'facialRecognition',
|
|
SMART_SEARCH = 'smartSearch',
|
|
DUPLICATE_DETECTION = 'duplicateDetection',
|
|
BACKGROUND_TASK = 'backgroundTask',
|
|
STORAGE_TEMPLATE_MIGRATION = 'storageTemplateMigration',
|
|
MIGRATION = 'migration',
|
|
SEARCH = 'search',
|
|
SIDECAR = 'sidecar',
|
|
LIBRARY = 'library',
|
|
NOTIFICATION = 'notifications',
|
|
BACKUP_DATABASE = 'backupDatabase',
|
|
}
|
|
|
|
export enum JobName {
|
|
//backups
|
|
BACKUP_DATABASE = 'database-backup',
|
|
|
|
// conversion
|
|
QUEUE_VIDEO_CONVERSION = 'queue-video-conversion',
|
|
VIDEO_CONVERSION = 'video-conversion',
|
|
|
|
// thumbnails
|
|
QUEUE_GENERATE_THUMBNAILS = 'queue-generate-thumbnails',
|
|
GENERATE_THUMBNAILS = 'generate-thumbnails',
|
|
GENERATE_PERSON_THUMBNAIL = 'generate-person-thumbnail',
|
|
|
|
// metadata
|
|
QUEUE_METADATA_EXTRACTION = 'queue-metadata-extraction',
|
|
METADATA_EXTRACTION = 'metadata-extraction',
|
|
|
|
// user
|
|
USER_DELETION = 'user-deletion',
|
|
USER_DELETE_CHECK = 'user-delete-check',
|
|
USER_SYNC_USAGE = 'user-sync-usage',
|
|
|
|
// asset
|
|
ASSET_DELETION = 'asset-deletion',
|
|
ASSET_DELETION_CHECK = 'asset-deletion-check',
|
|
|
|
// storage template
|
|
STORAGE_TEMPLATE_MIGRATION = 'storage-template-migration',
|
|
STORAGE_TEMPLATE_MIGRATION_SINGLE = 'storage-template-migration-single',
|
|
|
|
// tags
|
|
TAG_CLEANUP = 'tag-cleanup',
|
|
|
|
// migration
|
|
QUEUE_MIGRATION = 'queue-migration',
|
|
MIGRATE_ASSET = 'migrate-asset',
|
|
MIGRATE_PERSON = 'migrate-person',
|
|
|
|
// facial recognition
|
|
PERSON_CLEANUP = 'person-cleanup',
|
|
QUEUE_FACE_DETECTION = 'queue-face-detection',
|
|
FACE_DETECTION = 'face-detection',
|
|
QUEUE_FACIAL_RECOGNITION = 'queue-facial-recognition',
|
|
FACIAL_RECOGNITION = 'facial-recognition',
|
|
|
|
// library management
|
|
LIBRARY_QUEUE_SYNC_FILES = 'library-queue-sync-files',
|
|
LIBRARY_QUEUE_SYNC_ASSETS = 'library-queue-sync-assets',
|
|
LIBRARY_SYNC_FILES = 'library-sync-files',
|
|
LIBRARY_SYNC_ASSETS = 'library-sync-assets',
|
|
LIBRARY_ASSET_REMOVAL = 'handle-library-file-deletion',
|
|
LIBRARY_DELETE = 'library-delete',
|
|
LIBRARY_QUEUE_SCAN_ALL = 'library-queue-scan-all',
|
|
LIBRARY_QUEUE_CLEANUP = 'library-queue-cleanup',
|
|
|
|
// cleanup
|
|
DELETE_FILES = 'delete-files',
|
|
CLEAN_OLD_AUDIT_LOGS = 'clean-old-audit-logs',
|
|
CLEAN_OLD_SESSION_TOKENS = 'clean-old-session-tokens',
|
|
|
|
// memories
|
|
MEMORIES_CLEANUP = 'memories-cleanup',
|
|
MEMORIES_CREATE = 'memories-create',
|
|
|
|
// smart search
|
|
QUEUE_SMART_SEARCH = 'queue-smart-search',
|
|
SMART_SEARCH = 'smart-search',
|
|
|
|
QUEUE_TRASH_EMPTY = 'queue-trash-empty',
|
|
|
|
// duplicate detection
|
|
QUEUE_DUPLICATE_DETECTION = 'queue-duplicate-detection',
|
|
DUPLICATE_DETECTION = 'duplicate-detection',
|
|
|
|
// XMP sidecars
|
|
QUEUE_SIDECAR = 'queue-sidecar',
|
|
SIDECAR_DISCOVERY = 'sidecar-discovery',
|
|
SIDECAR_SYNC = 'sidecar-sync',
|
|
SIDECAR_WRITE = 'sidecar-write',
|
|
|
|
// Notification
|
|
NOTIFY_SIGNUP = 'notify-signup',
|
|
NOTIFY_ALBUM_INVITE = 'notify-album-invite',
|
|
NOTIFY_ALBUM_UPDATE = 'notify-album-update',
|
|
SEND_EMAIL = 'notification-send-email',
|
|
|
|
// Version check
|
|
VERSION_CHECK = 'version-check',
|
|
}
|
|
|
|
export enum JobCommand {
|
|
START = 'start',
|
|
PAUSE = 'pause',
|
|
RESUME = 'resume',
|
|
EMPTY = 'empty',
|
|
CLEAR_FAILED = 'clear-failed',
|
|
}
|
|
|
|
export enum JobStatus {
|
|
SUCCESS = 'success',
|
|
FAILED = 'failed',
|
|
SKIPPED = 'skipped',
|
|
}
|
|
|
|
export enum QueueCleanType {
|
|
FAILED = 'failed',
|
|
}
|
|
|
|
export enum VectorIndex {
|
|
CLIP = 'clip_index',
|
|
FACE = 'face_index',
|
|
}
|
|
|
|
export enum DatabaseLock {
|
|
GeodataImport = 100,
|
|
Migrations = 200,
|
|
SystemFileMounts = 300,
|
|
StorageTemplateMigration = 420,
|
|
VersionHistory = 500,
|
|
CLIPDimSize = 512,
|
|
Library = 1337,
|
|
GetSystemConfig = 69,
|
|
BackupDatabase = 42,
|
|
}
|
|
|
|
export enum SyncRequestType {
|
|
UsersV1 = 'UsersV1',
|
|
PartnersV1 = 'PartnersV1',
|
|
AssetsV1 = 'AssetsV1',
|
|
AssetExifsV1 = 'AssetExifsV1',
|
|
PartnerAssetsV1 = 'PartnerAssetsV1',
|
|
PartnerAssetExifsV1 = 'PartnerAssetExifsV1',
|
|
}
|
|
|
|
export enum SyncEntityType {
|
|
UserV1 = 'UserV1',
|
|
UserDeleteV1 = 'UserDeleteV1',
|
|
|
|
PartnerV1 = 'PartnerV1',
|
|
PartnerDeleteV1 = 'PartnerDeleteV1',
|
|
|
|
AssetV1 = 'AssetV1',
|
|
AssetDeleteV1 = 'AssetDeleteV1',
|
|
AssetExifV1 = 'AssetExifV1',
|
|
|
|
PartnerAssetV1 = 'PartnerAssetV1',
|
|
PartnerAssetDeleteV1 = 'PartnerAssetDeleteV1',
|
|
PartnerAssetExifV1 = 'PartnerAssetExifV1',
|
|
}
|