mirror of
https://github.com/immich-app/immich.git
synced 2025-12-18 09:13:15 +03:00
feat: queues (#24142)
This commit is contained in:
Jason Rasmussen
@@ -716,32 +716,32 @@ export type QueueStatisticsDto = {
|
||||
paused: number;
|
||||
waiting: number;
|
||||
};
|
||||
export type QueueStatusDto = {
|
||||
export type QueueStatusLegacyDto = {
|
||||
isActive: boolean;
|
||||
isPaused: boolean;
|
||||
};
|
||||
export type QueueResponseDto = {
|
||||
export type QueueResponseLegacyDto = {
|
||||
jobCounts: QueueStatisticsDto;
|
||||
queueStatus: QueueStatusDto;
|
||||
queueStatus: QueueStatusLegacyDto;
|
||||
};
|
||||
export type QueuesResponseDto = {
|
||||
backgroundTask: QueueResponseDto;
|
||||
backupDatabase: QueueResponseDto;
|
||||
duplicateDetection: QueueResponseDto;
|
||||
faceDetection: QueueResponseDto;
|
||||
facialRecognition: QueueResponseDto;
|
||||
library: QueueResponseDto;
|
||||
metadataExtraction: QueueResponseDto;
|
||||
migration: QueueResponseDto;
|
||||
notifications: QueueResponseDto;
|
||||
ocr: QueueResponseDto;
|
||||
search: QueueResponseDto;
|
||||
sidecar: QueueResponseDto;
|
||||
smartSearch: QueueResponseDto;
|
||||
storageTemplateMigration: QueueResponseDto;
|
||||
thumbnailGeneration: QueueResponseDto;
|
||||
videoConversion: QueueResponseDto;
|
||||
workflow: QueueResponseDto;
|
||||
export type QueuesResponseLegacyDto = {
|
||||
backgroundTask: QueueResponseLegacyDto;
|
||||
backupDatabase: QueueResponseLegacyDto;
|
||||
duplicateDetection: QueueResponseLegacyDto;
|
||||
faceDetection: QueueResponseLegacyDto;
|
||||
facialRecognition: QueueResponseLegacyDto;
|
||||
library: QueueResponseLegacyDto;
|
||||
metadataExtraction: QueueResponseLegacyDto;
|
||||
migration: QueueResponseLegacyDto;
|
||||
notifications: QueueResponseLegacyDto;
|
||||
ocr: QueueResponseLegacyDto;
|
||||
search: QueueResponseLegacyDto;
|
||||
sidecar: QueueResponseLegacyDto;
|
||||
smartSearch: QueueResponseLegacyDto;
|
||||
storageTemplateMigration: QueueResponseLegacyDto;
|
||||
thumbnailGeneration: QueueResponseLegacyDto;
|
||||
videoConversion: QueueResponseLegacyDto;
|
||||
workflow: QueueResponseLegacyDto;
|
||||
};
|
||||
export type JobCreateDto = {
|
||||
name: ManualJobName;
|
||||
@@ -966,6 +966,24 @@ export type PluginResponseDto = {
|
||||
updatedAt: string;
|
||||
version: string;
|
||||
};
|
||||
export type QueueResponseDto = {
|
||||
isPaused: boolean;
|
||||
name: QueueName;
|
||||
statistics: QueueStatisticsDto;
|
||||
};
|
||||
export type QueueUpdateDto = {
|
||||
isPaused?: boolean;
|
||||
};
|
||||
export type QueueDeleteDto = {
|
||||
/** If true, will also remove failed jobs from the queue. */
|
||||
failed?: boolean;
|
||||
};
|
||||
export type QueueJobResponseDto = {
|
||||
data: object;
|
||||
id?: string;
|
||||
name: JobName;
|
||||
timestamp: number;
|
||||
};
|
||||
export type SearchExploreItem = {
|
||||
data: AssetResponseDto;
|
||||
value: string;
|
||||
@@ -2925,7 +2943,7 @@ export function reassignFacesById({ id, faceDto }: {
|
||||
export function getQueuesLegacy(opts?: Oazapfts.RequestOpts) {
|
||||
return oazapfts.ok(oazapfts.fetchJson<{
|
||||
status: 200;
|
||||
data: QueuesResponseDto;
|
||||
data: QueuesResponseLegacyDto;
|
||||
}>("/jobs", {
|
||||
...opts
|
||||
}));
|
||||
@@ -2951,7 +2969,7 @@ export function runQueueCommandLegacy({ name, queueCommandDto }: {
|
||||
}, opts?: Oazapfts.RequestOpts) {
|
||||
return oazapfts.ok(oazapfts.fetchJson<{
|
||||
status: 200;
|
||||
data: QueueResponseDto;
|
||||
data: QueueResponseLegacyDto;
|
||||
}>(`/jobs/${encodeURIComponent(name)}`, oazapfts.json({
|
||||
...opts,
|
||||
method: "PUT",
|
||||
@@ -3651,6 +3669,75 @@ export function getPlugin({ id }: {
|
||||
...opts
|
||||
}));
|
||||
}
|
||||
/**
|
||||
* List all queues
|
||||
*/
|
||||
export function getQueues(opts?: Oazapfts.RequestOpts) {
|
||||
return oazapfts.ok(oazapfts.fetchJson<{
|
||||
status: 200;
|
||||
data: QueueResponseDto[];
|
||||
}>("/queues", {
|
||||
...opts
|
||||
}));
|
||||
}
|
||||
/**
|
||||
* Retrieve a queue
|
||||
*/
|
||||
export function getQueue({ name }: {
|
||||
name: QueueName;
|
||||
}, opts?: Oazapfts.RequestOpts) {
|
||||
return oazapfts.ok(oazapfts.fetchJson<{
|
||||
status: 200;
|
||||
data: QueueResponseDto;
|
||||
}>(`/queues/${encodeURIComponent(name)}`, {
|
||||
...opts
|
||||
}));
|
||||
}
|
||||
/**
|
||||
* Update a queue
|
||||
*/
|
||||
export function updateQueue({ name, queueUpdateDto }: {
|
||||
name: QueueName;
|
||||
queueUpdateDto: QueueUpdateDto;
|
||||
}, opts?: Oazapfts.RequestOpts) {
|
||||
return oazapfts.ok(oazapfts.fetchJson<{
|
||||
status: 200;
|
||||
data: QueueResponseDto;
|
||||
}>(`/queues/${encodeURIComponent(name)}`, oazapfts.json({
|
||||
...opts,
|
||||
method: "PUT",
|
||||
body: queueUpdateDto
|
||||
})));
|
||||
}
|
||||
/**
|
||||
* Empty a queue
|
||||
*/
|
||||
export function emptyQueue({ name, queueDeleteDto }: {
|
||||
name: QueueName;
|
||||
queueDeleteDto: QueueDeleteDto;
|
||||
}, opts?: Oazapfts.RequestOpts) {
|
||||
return oazapfts.ok(oazapfts.fetchText(`/queues/${encodeURIComponent(name)}/jobs`, oazapfts.json({
|
||||
...opts,
|
||||
method: "DELETE",
|
||||
body: queueDeleteDto
|
||||
})));
|
||||
}
|
||||
/**
|
||||
* Retrieve queue jobs
|
||||
*/
|
||||
export function getQueueJobs({ name, status }: {
|
||||
name: QueueName;
|
||||
status?: QueueJobStatus[];
|
||||
}, opts?: Oazapfts.RequestOpts) {
|
||||
return oazapfts.ok(oazapfts.fetchJson<{
|
||||
status: 200;
|
||||
data: QueueJobResponseDto[];
|
||||
}>(`/queues/${encodeURIComponent(name)}/jobs${QS.query(QS.explode({
|
||||
status
|
||||
}))}`, {
|
||||
...opts
|
||||
}));
|
||||
}
|
||||
/**
|
||||
* Retrieve assets by city
|
||||
*/
|
||||
@@ -5241,6 +5328,12 @@ export enum Permission {
|
||||
UserProfileImageRead = "userProfileImage.read",
|
||||
UserProfileImageUpdate = "userProfileImage.update",
|
||||
UserProfileImageDelete = "userProfileImage.delete",
|
||||
QueueRead = "queue.read",
|
||||
QueueUpdate = "queue.update",
|
||||
QueueJobCreate = "queueJob.create",
|
||||
QueueJobRead = "queueJob.read",
|
||||
QueueJobUpdate = "queueJob.update",
|
||||
QueueJobDelete = "queueJob.delete",
|
||||
WorkflowCreate = "workflow.create",
|
||||
WorkflowRead = "workflow.read",
|
||||
WorkflowUpdate = "workflow.update",
|
||||
@@ -5330,6 +5423,71 @@ export enum PluginContext {
|
||||
Album = "album",
|
||||
Person = "person"
|
||||
}
|
||||
export enum QueueJobStatus {
|
||||
Active = "active",
|
||||
Failed = "failed",
|
||||
Completed = "completed",
|
||||
Delayed = "delayed",
|
||||
Waiting = "waiting",
|
||||
Paused = "paused"
|
||||
}
|
||||
export enum JobName {
|
||||
AssetDelete = "AssetDelete",
|
||||
AssetDeleteCheck = "AssetDeleteCheck",
|
||||
AssetDetectFacesQueueAll = "AssetDetectFacesQueueAll",
|
||||
AssetDetectFaces = "AssetDetectFaces",
|
||||
AssetDetectDuplicatesQueueAll = "AssetDetectDuplicatesQueueAll",
|
||||
AssetDetectDuplicates = "AssetDetectDuplicates",
|
||||
AssetEncodeVideoQueueAll = "AssetEncodeVideoQueueAll",
|
||||
AssetEncodeVideo = "AssetEncodeVideo",
|
||||
AssetEmptyTrash = "AssetEmptyTrash",
|
||||
AssetExtractMetadataQueueAll = "AssetExtractMetadataQueueAll",
|
||||
AssetExtractMetadata = "AssetExtractMetadata",
|
||||
AssetFileMigration = "AssetFileMigration",
|
||||
AssetGenerateThumbnailsQueueAll = "AssetGenerateThumbnailsQueueAll",
|
||||
AssetGenerateThumbnails = "AssetGenerateThumbnails",
|
||||
AuditLogCleanup = "AuditLogCleanup",
|
||||
AuditTableCleanup = "AuditTableCleanup",
|
||||
DatabaseBackup = "DatabaseBackup",
|
||||
FacialRecognitionQueueAll = "FacialRecognitionQueueAll",
|
||||
FacialRecognition = "FacialRecognition",
|
||||
FileDelete = "FileDelete",
|
||||
FileMigrationQueueAll = "FileMigrationQueueAll",
|
||||
LibraryDeleteCheck = "LibraryDeleteCheck",
|
||||
LibraryDelete = "LibraryDelete",
|
||||
LibraryRemoveAsset = "LibraryRemoveAsset",
|
||||
LibraryScanAssetsQueueAll = "LibraryScanAssetsQueueAll",
|
||||
LibrarySyncAssets = "LibrarySyncAssets",
|
||||
LibrarySyncFilesQueueAll = "LibrarySyncFilesQueueAll",
|
||||
LibrarySyncFiles = "LibrarySyncFiles",
|
||||
LibraryScanQueueAll = "LibraryScanQueueAll",
|
||||
MemoryCleanup = "MemoryCleanup",
|
||||
MemoryGenerate = "MemoryGenerate",
|
||||
NotificationsCleanup = "NotificationsCleanup",
|
||||
NotifyUserSignup = "NotifyUserSignup",
|
||||
NotifyAlbumInvite = "NotifyAlbumInvite",
|
||||
NotifyAlbumUpdate = "NotifyAlbumUpdate",
|
||||
UserDelete = "UserDelete",
|
||||
UserDeleteCheck = "UserDeleteCheck",
|
||||
UserSyncUsage = "UserSyncUsage",
|
||||
PersonCleanup = "PersonCleanup",
|
||||
PersonFileMigration = "PersonFileMigration",
|
||||
PersonGenerateThumbnail = "PersonGenerateThumbnail",
|
||||
SessionCleanup = "SessionCleanup",
|
||||
SendMail = "SendMail",
|
||||
SidecarQueueAll = "SidecarQueueAll",
|
||||
SidecarCheck = "SidecarCheck",
|
||||
SidecarWrite = "SidecarWrite",
|
||||
SmartSearchQueueAll = "SmartSearchQueueAll",
|
||||
SmartSearch = "SmartSearch",
|
||||
StorageTemplateMigration = "StorageTemplateMigration",
|
||||
StorageTemplateMigrationSingle = "StorageTemplateMigrationSingle",
|
||||
TagCleanup = "TagCleanup",
|
||||
VersionCheck = "VersionCheck",
|
||||
OcrQueueAll = "OcrQueueAll",
|
||||
Ocr = "Ocr",
|
||||
WorkflowRun = "WorkflowRun"
|
||||
}
|
||||
export enum SearchSuggestionType {
|
||||
Country = "country",
|
||||
State = "state",
|
||||
|
||||
Reference in New Issue
Block a user